Improve code generator scripts to support converting ScriptString.
[WebKit-https.git] / WebCore / bindings / scripts / test / TestObj.idl
1 /*
2  * Copyright (C) 2009 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary formstrArg, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
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  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIEstrArg, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 // This IDL file is for testing the bindings code generator and for tracking
30 // changes in its ouput.
31 module test {
32     interface TestObj {
33         // Attributes
34         readonly attribute long            readOnlyIntAttr;
35         readonly attribute DOMString       readOnlyStringAttr;
36         readonly attribute TestObj         readOnlyTestObjAttr;
37         attribute long                     intAttr;
38         attribute long long                longLongAttr;
39         attribute unsigned long long       unsignedLongLongAttr;
40         attribute DOMString                stringAttr;
41         attribute TestObj                  testObjAttr;
42
43         // Methods
44         void    voidMethod();
45         void    voidMethodWithArgs(in long intArg, in DOMString strArg, in TestObj objArg);
46         long    intMethod();
47         long    intMethodWithArgs(in long intArg, in DOMString strArg, in TestObj objArg);
48         TestObj objMethod();
49         TestObj objMethodWithArgs(in long intArg, in DOMString strArg, in TestObj objArg);
50
51         void serializedValue(in SerializedScriptValue serializedArg);
52
53         // Exceptions
54         void    methodWithException() raises(DOMException);
55         attribute long attrWithException raises(DOMException);
56         attribute long attrWithSetterException getraises(DOMException);
57         attribute long attrWithGetterException setraises(DOMException);
58
59         // 'Custom' extended attribute
60         attribute [Custom] long            customAttr;
61         [Custom] void customMethod();
62         [Custom] void customMethodWithArgs(in long intArg, in DOMString strArg, in TestObj objArg);
63
64         [CustomArgumentHandling] void customArgsAndException(in log intArg)
65             raises(DOMException);
66
67         void addEventListener(in DOMString type, 
68                               in EventListener listener, 
69                               in boolean useCapture);
70         void removeEventListener(in DOMString type, 
71                                  in EventListener listener, 
72                                  in boolean useCapture);
73
74         // 'CallWith' extended attribute
75         [CallWith=DynamicFrame] void withDynamicFrame();
76         [CallWith=DynamicFrame] void withDynamicFrameAndArg(in long intArg);
77         [CallWith=DynamicFrame] void withDynamicFrameAndOptionalArg(in long intArg, in [Optional] long optionalArg);
78         [NeedsUserGestureCheck, CallWith=DynamicFrame] void withDynamicFrameAndUserGesture(in long intArg);
79         [NeedsUserGestureCheck, CallWith=DynamicFrame] void withDynamicFrameAndUserGestureASAD(in long intArg, in [Optional] long optionalArg);
80         [CallWith=ScriptState] void withScriptStateVoid();
81         [CallWith=ScriptState] TestObj withScriptStateObj();
82         [CallWith=ScriptState] void withScriptStateVoidException()
83             raises(DOMException);
84         [CallWith=ScriptState] TestObj withScriptStateObjException()
85             raises(DOMException);
86
87         // 'Optional' extended attribute
88         void    methodWithOptionalArg(in [Optional] long opt);
89         void    methodWithNonOptionalArgAndOptionalArg(in long nonOpt, in [Optional] long opt);
90         void    methodWithNonOptionalArgAndTwoOptionalArgs(in long nonOpt, in [Optional] long opt1, in long opt2);
91
92         // 'ConvertScriptString' extended attribute
93         readonly attribute [ConvertScriptString] DOMString scriptStringAttr;
94
95 #ifdef TESTING_V8
96         // Overloads
97         void    overloadedMethod(in TestObj objArg, in DOMString strArg);
98         void    overloadedMethod(in TestObj objArg, in [Optional] long intArg);
99         void    overloadedMethod(in DOMString strArg);
100         void    overloadedMethod(in long intArg);
101 #endif
102     };
103 }