Get rid of outdated getter / setter raises from Web IDL
[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 Computer, 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 [
36     Constructor(TestCallback testCallback),
37     InterfaceName=TestObject
38 ] interface TestObj {
39     // Attributes
40     readonly attribute long            readOnlyLongAttr;
41     readonly attribute DOMString       readOnlyStringAttr;
42     readonly attribute TestObj         readOnlyTestObjAttr;
43     static readonly attribute long     staticReadOnlyLongAttr;
44     static attribute DOMString         staticStringAttr;
45     static readonly attribute TestSubObjConstructor TestSubObj;
46     attribute TestEnumType             enumAttr;
47     attribute short                    shortAttr;
48     attribute unsigned short           unsignedShortAttr;
49     attribute long                     longAttr;
50     attribute long long                longLongAttr;
51     attribute unsigned long long       unsignedLongLongAttr;
52     attribute DOMString                stringAttr;
53     attribute TestObj testObjAttr;
54
55     // WK_ucfirst, WK_lcfirst exceptional cases.
56     attribute TestObj                  XMLObjAttr;
57     attribute boolean                  create;
58
59     // Reflected DOM attributes
60     [Reflect] attribute DOMString reflectedStringAttr;
61     [Reflect] attribute long reflectedIntegralAttr;
62     [Reflect] attribute unsigned long reflectedUnsignedIntegralAttr;
63     [Reflect] attribute boolean reflectedBooleanAttr;
64     [Reflect, URL] attribute DOMString reflectedURLAttr;
65     [Reflect=customContentStringAttr] attribute DOMString reflectedStringAttr;
66     [Reflect=customContentIntegralAttr] attribute long reflectedCustomIntegralAttr;
67     [Reflect=customContentBooleanAttr] attribute boolean reflectedCustomBooleanAttr;
68     [Reflect=customContentURLAttr, URL] attribute DOMString reflectedCustomURLAttr;
69
70     // TypedArray attribute
71     attribute Float32Array typedArrayAttr;
72
73     // Methods
74     void    voidMethod();
75     void    voidMethodWithArgs(long longArg, DOMString strArg, TestObj objArg);
76     long    longMethod();
77     long    longMethodWithArgs(long longArg, DOMString strArg, TestObj objArg);
78     TestObj objMethod();
79     TestObj objMethodWithArgs(long longArg, DOMString strArg, TestObj objArg);
80
81     void methodWithSequenceArg(sequence<ScriptProfile> sequenceArg);
82     sequence<ScriptProfile> methodReturningSequence(long longArg);
83
84     void methodWithEnumArg(TestEnumType enumArg);
85     TestObj methodThatRequiresAllArgsAndThrows(DOMString strArg, TestObj objArg)
86         raises(DOMException);
87
88     void serializedValue(SerializedScriptValue serializedArg);
89     void optionsObject(Dictionary oo, optional Dictionary ooo);
90
91     // Exceptions
92     void methodWithException() raises(DOMException);
93     [GetterRaisesException] attribute long attrWithGetterException;
94     [SetterRaisesException] attribute long attrWithSetterException;
95     [GetterRaisesException] attribute DOMString stringAttrWithGetterException;
96     [SetterRaisesException] attribute DOMString stringAttrWithSetterException;
97
98     // 'Custom' extended attribute
99     [Custom] attribute long            customAttr;
100     [Custom] void customMethod();
101     [Custom] void customMethodWithArgs(long longArg, DOMString strArg, TestObj objArg);
102
103     void addEventListener(DOMString type, 
104                           EventListener listener, 
105                           optional boolean useCapture);
106     void removeEventListener(DOMString type, 
107                              EventListener listener, 
108                              optional boolean useCapture);
109
110     // 'CallWith' extended attribute
111     [CallWith=ScriptState] void withScriptStateVoid();
112     [CallWith=ScriptState] TestObj withScriptStateObj();
113     [CallWith=ScriptState] void withScriptStateVoidException()
114         raises(DOMException);
115     [CallWith=ScriptState] TestObj withScriptStateObjException()
116         raises(DOMException);
117     [CallWith=ScriptExecutionContext] void withScriptExecutionContext();
118     [CallWith=ScriptExecutionContext|ScriptState] void withScriptExecutionContextAndScriptState();
119     [CallWith=ScriptExecutionContext|ScriptState] TestObj withScriptExecutionContextAndScriptStateObjException()
120         raises(DOMException);
121     [CallWith=  ScriptExecutionContext  |  ScriptState  ] TestObj withScriptExecutionContextAndScriptStateWithSpaces();
122     [CallWith=ScriptArguments|CallStack] void withScriptArgumentsAndCallStack();
123
124     [CallWith=ScriptState] attribute long withScriptStateAttribute;
125     [CallWith=ScriptExecutionContext] attribute TestObj withScriptExecutionContextAttribute;
126     [CallWith=ScriptState, GetterRaisesException] attribute TestObj withScriptStateAttributeRaises;
127     [CallWith=ScriptExecutionContext, GetterRaisesException] attribute TestObj withScriptExecutionContextAttributeRaises;
128     [CallWith=ScriptExecutionContext|ScriptState] attribute TestObj withScriptExecutionContextAndScriptStateAttribute;
129     [CallWith=ScriptExecutionContext|ScriptState,GetterRaisesException] attribute TestObj withScriptExecutionContextAndScriptStateAttributeRaises;
130     [CallWith=  ScriptExecutionContext  |  ScriptState  ] attribute TestObj withScriptExecutionContextAndScriptStateWithSpacesAttribute;
131     [CallWith=ScriptArguments|CallStack] attribute TestObj withScriptArgumentsAndCallStackAttribute;
132
133     // 'Optional' extended attribute
134     void    methodWithOptionalArg(optional long opt);
135     void    methodWithNonOptionalArgAndOptionalArg(long nonOpt, optional long opt);
136     void    methodWithNonOptionalArgAndTwoOptionalArgs(long nonOpt, optional long opt1, optional long opt2);
137     void    methodWithOptionalString(optional DOMString str);
138     void    methodWithOptionalStringIsUndefined([Default=Undefined] optional DOMString str);
139     void    methodWithOptionalStringIsNullString([Default=NullString] optional DOMString str);
140
141 #if defined(TESTING_JS)
142     // 'Callback' extended attribute
143     void    methodWithCallbackArg(TestCallback callback);
144     void    methodWithNonCallbackArgAndCallbackArg(long nonCallback, TestCallback callback);
145     void    methodWithCallbackAndOptionalArg(optional TestCallback callback);
146     // static methods with 'Callback' extended attribute
147     static void    staticMethodWithCallbackAndOptionalArg(optional TestCallback callback);
148     static void    staticMethodWithCallbackArg(TestCallback callback);
149 #endif
150
151     // 'Conditional' extended attribute
152     [Conditional=Condition1] attribute long conditionalAttr1;
153     [Conditional=Condition1&Condition2] attribute long conditionalAttr2;
154     [Conditional=Condition1|Condition2] attribute long conditionalAttr3;
155
156     // 'Conditional' extended method
157     [Conditional=Condition1] DOMString conditionalMethod1();
158     [Conditional=Condition1&Condition2] void conditionalMethod2();
159     [Conditional=Condition1|Condition2] void conditionalMethod3();
160
161     [Conditional=Condition1] attribute TestObjectAConstructor conditionalAttr4;
162     [Conditional=Condition1&Condition2] attribute TestObjectBConstructor conditionalAttr5;
163     [Conditional=Condition1|Condition2] attribute TestObjectCConstructor conditionalAttr6;
164
165     [Conditional=Condition1] const unsigned short CONDITIONAL_CONST = 0;
166
167 #if defined(TESTING_JS)
168     [CachedAttribute] readonly attribute any cachedAttribute1;
169     [CachedAttribute] readonly attribute any cachedAttribute2;
170 #endif
171     
172     attribute any anyAttribute;
173
174 #if defined(TESTING_JS)
175     // Overloads
176     void    overloadedMethod(TestObj? objArg, [StrictTypeChecking] DOMString strArg);
177     void    overloadedMethod(TestObj? objArg, optional long longArg);
178     void    overloadedMethod([StrictTypeChecking] DOMString strArg);
179     void    overloadedMethod(long longArg);
180     void    overloadedMethod(TestCallback callback);
181     void    overloadedMethod(DOMStringList? listArg);
182     void    overloadedMethod(DOMString[]? arrayArg);
183     void    overloadedMethod(TestObj objArg);
184     void    overloadedMethod(DOMString[] arrayArg);
185     void    overloadedMethod(sequence<unsigned long> arrayArg);
186     void    overloadedMethod(DOMString strArg);
187 #endif
188
189     // Class methods within JavaScript (like what's used for IDBKeyRange).
190     static void classMethod();
191     static long classMethodWithOptional(optional long arg);
192     [Custom] static void classMethod2(long arg);
193
194     // Static method with conditional on overloaded methods
195     [Conditional=Condition1] static void overloadedMethod1(long arg);
196     [Conditional=Condition1] static void overloadedMethod1([StrictTypeChecking] DOMString type);
197
198     void classMethodWithClamp([Clamp] unsigned short objArgsShort, [Clamp] unsigned long objArgsLong);
199
200 #if defined(TESTING_JS)
201     void methodWithUnsignedLongSequence(sequence<unsigned long> unsignedLongSequence);
202     DOMString[] stringArrayFunction(DOMString[] values) raises(DOMException);
203     DOMStringList domStringListFunction(DOMStringList values) raises(DOMException);
204 #endif
205
206     [CheckSecurityForNode] readonly attribute Document contentDocument;
207     [CheckSecurityForNode] SVGDocument getSVGDocument()
208         raises(DOMException);
209
210     void convert1([TreatReturnedNullStringAs=Null] TestNode value);
211     void convert2([TreatReturnedNullStringAs=Undefined] TestNode value);
212     void convert4([TreatNullAs=NullString] TestNode value);
213     void convert5([TreatNullAs=NullString, TreatUndefinedAs=NullString] TestNode value);
214
215     attribute SVGPoint mutablePoint;
216     [Immutable] attribute SVGPoint immutablePoint;
217     SVGPoint mutablePointFunction();
218     [Immutable] SVGPoint immutablePointFunction();
219
220     [ImplementedAs=banana] void orange();
221     [ImplementedAs=blueberry] attribute long strawberry;
222
223     [StrictTypeChecking] attribute float strictFloat;
224     [StrictTypeChecking] bool strictFunction(DOMString str, float a, long b)
225         raises(DOMException);
226
227     // ObjectiveC reserved words.
228     readonly attribute long      description;
229     attribute long               id;
230     readonly attribute DOMString hash;
231
232     // Check constants and enums.
233     const unsigned short CONST_VALUE_0 = 0;
234     const unsigned short CONST_VALUE_1 = 1;
235     const unsigned short CONST_VALUE_2 = 2;
236     const unsigned short CONST_VALUE_4 = 4;
237     const unsigned short CONST_VALUE_8 = 8;
238     const short CONST_VALUE_9 = -1;
239     const DOMString CONST_VALUE_10 = "my constant string";
240     const unsigned short CONST_VALUE_11 = 0xffffffff;
241     const unsigned short CONST_VALUE_12 = 0x01;
242     const unsigned short CONST_VALUE_13 = 0X20;
243     const unsigned short CONST_VALUE_14 = 0x1abc;
244     [Reflect=CONST_IMPL] const unsigned short CONST_JAVASCRIPT = 15;
245
246     [Replaceable] readonly attribute long replaceableAttribute;
247
248     void variadicStringMethod(DOMString head, DOMString... tail);
249     void variadicDoubleMethod(double head, double... tail);
250     void variadicNodeMethod(Node head, Node... tail);
251
252     // Nullable attributes.
253     readonly attribute double? nullableDoubleAttribute;
254     readonly attribute long? nullableLongAttribute;
255     readonly attribute boolean? nullableBooleanAttribute;
256     readonly attribute DOMString? nullableStringAttribute;
257
258     attribute long? nullableLongSettableAttribute;
259
260     [GetterRaisesException] attribute long? nullableStringValue;
261 };