Some event handler fixes
[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 WARRANTIEstrArg, 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),
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     [RaisesException] TestObj methodThatRequiresAllArgsAndThrows(DOMString strArg, TestObj objArg);
96
97     void serializedValue(SerializedScriptValue serializedArg);
98     void optionsObject(Dictionary oo, optional Dictionary ooo);
99
100     // Exceptions
101     [RaisesException] void methodWithException();
102     [GetterRaisesException] attribute long attrWithGetterException;
103     [SetterRaisesException] attribute long attrWithSetterException;
104     [GetterRaisesException] attribute DOMString stringAttrWithGetterException;
105     [SetterRaisesException] attribute DOMString stringAttrWithSetterException;
106
107     // 'Custom' extended attribute
108     [Custom] attribute long            customAttr;
109     [Custom] void customMethod();
110     [Custom] void customMethodWithArgs(long longArg, DOMString strArg, TestObj objArg);
111
112     void addEventListener(DOMString type, EventListener listener, optional boolean useCapture);
113     void removeEventListener(DOMString type, EventListener listener, optional boolean useCapture);
114     attribute EventListener onfoo;
115
116     // 'CallWith' extended attribute
117     [CallWith=ScriptState] void withScriptStateVoid();
118     [CallWith=ScriptState] TestObj withScriptStateObj();
119     [CallWith=ScriptState, RaisesException] void withScriptStateVoidException();
120     [CallWith=ScriptState, RaisesException] TestObj withScriptStateObjException();
121     [CallWith=ScriptExecutionContext] void withScriptExecutionContext();
122     [CallWith=ScriptExecutionContext&ScriptState] void withScriptExecutionContextAndScriptState();
123     [CallWith=ScriptExecutionContext&ScriptState, RaisesException] TestObj withScriptExecutionContextAndScriptStateObjException();
124     [CallWith=  ScriptExecutionContext  &  ScriptState  ] TestObj withScriptExecutionContextAndScriptStateWithSpaces();
125     [CallWith=ScriptArguments&CallStack] void withScriptArgumentsAndCallStack();
126
127     [CallWith=ScriptState] attribute long withScriptStateAttribute;
128     [CallWith=ScriptExecutionContext] attribute TestObj withScriptExecutionContextAttribute;
129     [CallWith=ScriptState, GetterRaisesException] attribute TestObj withScriptStateAttributeRaises;
130     [CallWith=ScriptExecutionContext, GetterRaisesException] attribute TestObj withScriptExecutionContextAttributeRaises;
131     [CallWith=ScriptExecutionContext&ScriptState] attribute TestObj withScriptExecutionContextAndScriptStateAttribute;
132     [CallWith=ScriptExecutionContext&ScriptState,GetterRaisesException] attribute TestObj withScriptExecutionContextAndScriptStateAttributeRaises;
133     [CallWith=  ScriptExecutionContext  &  ScriptState  ] attribute TestObj withScriptExecutionContextAndScriptStateWithSpacesAttribute;
134     [CallWith=ScriptArguments&CallStack] attribute TestObj withScriptArgumentsAndCallStackAttribute;
135
136     // 'Optional' extended attribute
137     void    methodWithOptionalArg(optional long opt);
138     void    methodWithNonOptionalArgAndOptionalArg(long nonOpt, optional long opt);
139     void    methodWithNonOptionalArgAndTwoOptionalArgs(long nonOpt, optional long opt1, optional long opt2);
140     void    methodWithOptionalString(optional DOMString str);
141     void    methodWithOptionalStringIsUndefined([Default=Undefined] optional DOMString str);
142     void    methodWithOptionalStringIsNullString([Default=NullString] optional DOMString str);
143
144 #if defined(TESTING_JS)
145     // 'Callback' extended attribute
146     void    methodWithCallbackArg(TestCallback callback);
147     void    methodWithNonCallbackArgAndCallbackArg(long nonCallback, TestCallback callback);
148     void    methodWithCallbackAndOptionalArg(optional TestCallback callback);
149     // static methods with 'Callback' extended attribute
150     static void    staticMethodWithCallbackAndOptionalArg(optional TestCallback callback);
151     static void    staticMethodWithCallbackArg(TestCallback callback);
152 #endif
153
154     // 'Conditional' extended attribute
155     [Conditional=Condition1] attribute long conditionalAttr1;
156     [Conditional=Condition1&Condition2] attribute long conditionalAttr2;
157     [Conditional=Condition1|Condition2] attribute long conditionalAttr3;
158
159     // 'Conditional' extended method
160     [Conditional=Condition1] DOMString conditionalMethod1();
161     [Conditional=Condition1&Condition2] void conditionalMethod2();
162     [Conditional=Condition1|Condition2] void conditionalMethod3();
163
164     [Conditional=Condition1] attribute TestObjectAConstructor conditionalAttr4;
165     [Conditional=Condition1&Condition2] attribute TestObjectBConstructor conditionalAttr5;
166     [Conditional=Condition1|Condition2] attribute TestObjectCConstructor conditionalAttr6;
167
168     [Conditional=Condition1] const unsigned short CONDITIONAL_CONST = 0;
169
170 #if defined(TESTING_JS)
171     [CachedAttribute] readonly attribute any cachedAttribute1;
172     [CachedAttribute] readonly attribute any cachedAttribute2;
173 #endif
174     
175     attribute any anyAttribute;
176
177 #if defined(TESTING_JS)
178     // Overloads
179     void    overloadedMethod(TestObj? objArg, [StrictTypeChecking] DOMString strArg);
180     void    overloadedMethod(TestObj? objArg, optional long longArg);
181     void    overloadedMethod([StrictTypeChecking] DOMString strArg);
182     void    overloadedMethod(long longArg);
183     void    overloadedMethod(TestCallback callback);
184     void    overloadedMethod(DOMStringList? listArg);
185     void    overloadedMethod(DOMString[]? arrayArg);
186     void    overloadedMethod(TestObj objArg);
187     void    overloadedMethod(DOMString[] arrayArg);
188     void    overloadedMethod(sequence<unsigned long> arrayArg);
189     void    overloadedMethod(DOMString strArg);
190 #endif
191
192     // Class methods within JavaScript (like what's used for IDBKeyRange).
193     static void classMethod();
194     static long classMethodWithOptional(optional long arg);
195     [Custom] static void classMethod2(long arg);
196
197     // Static method with conditional on overloaded methods
198     [Conditional=Condition1] static void overloadedMethod1(long arg);
199     [Conditional=Condition1] static void overloadedMethod1([StrictTypeChecking] DOMString type);
200
201     void classMethodWithClamp([Clamp] unsigned short objArgsShort, [Clamp] unsigned long objArgsLong);
202
203 #if defined(TESTING_JS)
204     void methodWithUnsignedLongSequence(sequence<unsigned long> unsignedLongSequence);
205     [RaisesException] DOMString[] stringArrayFunction(DOMString[] values);
206     [RaisesException] DOMStringList domStringListFunction(DOMStringList values);
207
208     void methodWithAndWithoutNullableSequence(sequence<unsigned long> arrayArg, sequence<unsigned long>? nullableArrayArg);
209     void methodWithAndWithoutNullableSequence2(unsigned long[] arrayArg, unsigned long[]? nullableArrayArg);
210 #endif
211
212     [CheckSecurityForNode] readonly attribute Document contentDocument;
213     [CheckSecurityForNode, RaisesException] SVGDocument getSVGDocument();
214
215     void convert1([TreatReturnedNullStringAs=Null] TestNode value);
216     void convert2([TreatReturnedNullStringAs=Undefined] TestNode value);
217     void convert4([TreatNullAs=NullString] TestNode value);
218     void convert5([TreatNullAs=NullString, TreatUndefinedAs=NullString] TestNode value);
219
220     attribute SVGPoint mutablePoint;
221     [Immutable] attribute SVGPoint immutablePoint;
222     SVGPoint mutablePointFunction();
223     [Immutable] SVGPoint immutablePointFunction();
224
225     [ImplementedAs=banana] void orange();
226     [ImplementedAs=blueberry] attribute long strawberry;
227
228     [StrictTypeChecking] attribute unrestricted float strictFloat;
229     [StrictTypeChecking, RaisesException] bool strictFunction(DOMString str, unrestricted float a, long b);
230
231     [StrictTypeChecking, RaisesException] bool strictFunctionWithSequence(TestObj objArg, sequence<unsigned long> a);
232     [StrictTypeChecking, RaisesException] bool strictFunctionWithArray(TestObj objArg, long[] array);
233
234     // ObjectiveC reserved words.
235     readonly attribute long      description;
236     attribute long               id;
237     readonly attribute DOMString hash;
238
239     // Check constants and enums.
240     const unsigned short CONST_VALUE_0 = 0;
241     const unsigned short CONST_VALUE_1 = 1;
242     const unsigned short CONST_VALUE_2 = 2;
243     const unsigned short CONST_VALUE_4 = 4;
244     const unsigned short CONST_VALUE_8 = 8;
245     const short CONST_VALUE_9 = -1;
246     const unsigned short CONST_VALUE_11 = 0xffffffff;
247     const unsigned short CONST_VALUE_12 = 0x01;
248     const unsigned short CONST_VALUE_13 = 0X20;
249     const unsigned short CONST_VALUE_14 = 0x1abc;
250     [Reflect=CONST_IMPL] const unsigned short CONST_JAVASCRIPT = 15;
251
252     [Replaceable] readonly attribute long replaceableAttribute;
253
254     void variadicStringMethod(DOMString head, DOMString... tail);
255     void variadicDoubleMethod(unrestricted double head, unrestricted double... tail);
256     void variadicNodeMethod(Node head, Node... tail);
257
258     // Nullable attributes.
259     readonly attribute unrestricted double? nullableDoubleAttribute;
260     readonly attribute long? nullableLongAttribute;
261     readonly attribute boolean? nullableBooleanAttribute;
262     readonly attribute DOMString? nullableStringAttribute;
263
264     attribute long? nullableLongSettableAttribute;
265
266     [GetterRaisesException] attribute long? nullableStringValue;
267
268     // Identifiers with a leading underscore, which should be removed.
269     const unsigned short               _readonly = 0;
270     readonly attribute DOMString       _attribute;
271     attribute _optional                attributeWithReservedEnumType;
272     void _any(unrestricted float a, long b);
273 };
274
275 // The following comment should not generate any code.
276 // TestObj implements TestImplements;
277