Changes between Version 3 and Version 4 of WebKitIDL

Timestamp:

Jan 27, 2012 5:59:16 PM (12 years ago)

Author:

haraken@chromium.org

Comment:

--

WebKitIDL

@@ -23 +23 @@
 == ''[Supplemental]'' ==
 
+[http://dev.w3.org/2006/webapi/WebIDL/#dfn-supplemental-interface The spec].
+[http://old.nabble.com/Things-missing-from-Web-IDL-for-HTML5-td24873773.html Easy explanation]
+
+The [Supplemental] IDL helps WebKit modularization. The [Supplemental] IDL makes it possible to add XXX's APIs (e.g. XXX=WebAudio, WebSocket, Blob, GamePad, ...etc) without modifying code outside of WebCore/Modules/XXX/. This helps make XXX a "self-contained module".
+
+Here is an example. Without the [Supplemental] IDL, if we want to add attributes or methods of XXX to DOMWindow,
+
+- we need to modify WebCore/page/DOMWindow.idl to add the IDLs of the attributes or methods
+- we might need to modify WebCore/page/DOMWindow.{h,cpp} to add the C++ implementation of attribute getters and setters or method callbacks.
+
+On the other hand, in the modularized world with the [Supplemental] IDL, we just need to modify the code under WebCore/Modules/XXX/, like this:
+
+WebCore/Modules/XXX/DOMWindowXXX.idl
+{{{
+   interface [
+       Conditional=XXX,
+       Supplemental=DOMWindow
+   ] DOMWindowXXX {
+       attribute foo;
+       void bar();
+   };
+}}}
+
+WebCore/Modules/XXX/DOMWindowXXX.h
+{{{
+   DOMWindowXXX::foo(...) { ... }   // the C++ implementation of the foo attribute getter
+   DOMWindowXXX::setFoo(...) { ... }   // the C++ implementation of the foo attribute setter
+   DOMWindowXXX::bar(...) { ... }   // the C++ implementation of the bar method callback
+}}}
+
+As shown above, [Supplemental=DOMWindow] indicates that all the attributes and methods in DOMWindowXXX should be exposed on DOMWindow but should be implemented in DOMWindowXXX. In this way, we can implement the attributes and methods without modifying code of DOMWindow.{h,cpp,idl}. If you want to add APIs whose implementations are likely to be independent from WebCore, it is strongly recommended to put the APIs in WebCore/Modules/XXX/ using the [Supplemental] IDL.
+
 == ''[...]'' ==
 
@@ -28 +60 @@
 
 == ''[...]'' ==
-