[Web IDL] interfaces should inherit EventTarget instead of duplicatin…

…g the EventTarget API

https://bugs.webkit.org/show_bug.cgi?id=154121
<rdar://problem/24613234>

Reviewed by Gavin Barraclough.

LayoutTests/imported/w3c:

Rebaseline several W3C tests now that more checks are passing.

* web-platform-tests/dom/interfaces-expected.txt:
* web-platform-tests/html/dom/interfaces-expected.txt:

Source/WebCore:

Interfaces should inherit EventTarget instead of duplicating the
EventTarget API in their IDL. Not only the duplication is ugly and
error-prone, but this also does not match the specifications and
have subtle web-exposed differences.

This patch takes care of all interfaces except for DOMWindow and
WorkerGlobalScope. Those will be updated in the follow-up patch
as they will require a little bit more work and testing.

We should also be able to get rid of the [EventTarget] WebKit IDL
attribute in a follow-up.

No new tests, already covered by existing tests.

* Modules/battery/BatteryManager.idl:
* Modules/encryptedmedia/MediaKeySession.idl:
* Modules/indexeddb/IDBDatabase.h:
* Modules/indexeddb/IDBDatabase.idl:
* Modules/indexeddb/IDBRequest.h:
* Modules/indexeddb/IDBRequest.idl:
* Modules/indexeddb/IDBTransaction.h:
* Modules/indexeddb/IDBTransaction.idl:
* Modules/mediasession/MediaRemoteControls.idl:
* Modules/mediasource/MediaSource.h:
* Modules/mediasource/MediaSource.idl:
* Modules/mediasource/SourceBuffer.h:
* Modules/mediasource/SourceBuffer.idl:
* Modules/mediasource/SourceBufferList.h:
* Modules/mediasource/SourceBufferList.idl:
* Modules/mediastream/MediaStream.h:
* Modules/mediastream/MediaStream.idl:
* Modules/mediastream/MediaStreamTrack.h:
* Modules/mediastream/MediaStreamTrack.idl:
* Modules/mediastream/RTCDTMFSender.h:
* Modules/mediastream/RTCDTMFSender.idl:
* Modules/mediastream/RTCDataChannel.h:
* Modules/mediastream/RTCDataChannel.idl:
* Modules/mediastream/RTCPeerConnection.h:
* Modules/mediastream/RTCPeerConnection.idl:
* Modules/notifications/Notification.idl:
* Modules/speech/SpeechSynthesisUtterance.idl:
* Modules/webaudio/AudioContext.idl:
* Modules/webaudio/AudioNode.idl:
* Modules/websockets/WebSocket.idl:
* css/FontLoader.idl:
* dom/EventTarget.h:
* dom/MessagePort.idl:
* dom/Node.h:
* dom/Node.idl:
* dom/WebKitNamedFlow.idl:
* fileapi/FileReader.idl:
* html/MediaController.idl:
* html/track/AudioTrackList.idl:
* html/track/TextTrack.idl:
* html/track/TextTrackCue.idl:
* html/track/TextTrackList.idl:
* html/track/VideoTrackList.idl:
* loader/appcache/DOMApplicationCache.h:
* loader/appcache/DOMApplicationCache.idl:
* page/EventSource.idl:
* page/Performance.h:
* page/Performance.idl:
* workers/Worker.idl:
* xml/XMLHttpRequest.h:
* xml/XMLHttpRequest.idl:
* xml/XMLHttpRequestUpload.idl:
- Drop hardcoded EventTarget operations and inherit EventTarget instead.
- Drop JSGenerateToNativeObject / JSGenerateToJSObject IDL extended
  attributes for interfaces inheriting the EventTarget interface as
  the bindings generator now does this automatically for us.
- On native side, have EventTarget subclass ScriptWrappable instead of
  each of its subclasses doing so. The issue was that
  EventTargetOwner::finalize() was calling uncacheWrapper() with an
  EventTarget*, which would not clear inlined cached wrapped (see
  clearInlineCachedWrapper()) because EventTarget did not subclass
  ScriptWrappable. However, cacheWrapper() is called is a specific
  subtype pointer (e.g. Node*) and we would decide to create an
  inline cached wrapper because Node subclassed ScriptWrappable
  (as well as EventTarget).

* WebCore.xcodeproj/project.pbxproj:
Export JSEventTarget.h as private header to fix the build.

* bindings/js/JSDOMBinding.h:
(WebCore::wrapperKey):
(WebCore::getCachedWrapper):
(WebCore::cacheWrapper):
(WebCore::uncacheWrapper):
Use new wrapperKey() function that is generated for each bindings
class that also has wrapperOwner(). This is used instead of the
C cast to void* in order to cast to the base wrapped type to fix
issues with multiple inheritance. The issue was that cacheWrapper()
was getting called with a DOM object subtype pointer (e.g.
AudioContext*) but uncacheWrapper() was getting called with a base
wrapped type pointer (e.g. EventTarget*). Most of our DOM classes
use multiple inheritance and thus the pointer values (used as keys
in the weak map) may differ.

* bindings/js/JSTrackCustom.cpp:
(WebCore::toJS):
Call CREATE_DOM_WRAPPER() with an actual wrapped type (e.g. AudioTrack)
instead of TrackBase type. TrackBase does not have corresponding
generated bindings and therefore does not have a wrapperKey()
function.

* bindings/scripts/CodeGeneratorJS.pm:
(ShouldGenerateToWrapped):
(ShouldGenerateToJSDeclaration):
(GenerateHeader):
- Generate a wrapperKey() utility function along-side wrapperOwner()
  to help cast to the base wrapped type.
- Generate toWrapped() / toJS() utility functions for interfaces
  that inherit EventTarget as those are required by our
  implementation and this avoids having to explicitly have them in
  the IDL.

* bindings/scripts/test/*:
Rebaseline bindings tests.

LayoutTests:

Rebaseline a couple of layout tests now that interfaces inherit EventTarget
instead of duplicating the EventTarget API in their IDL.

* fast/dom/Window/window-properties-performance-expected.txt:
* fast/dom/prototype-chain-expected.txt:


Canonical link: https://commits.webkit.org/172255@main
git-svn-id: https://svn.webkit.org/repository/webkit/trunk@196466 268f45cc-cd09-0410-ab3c-d52691b4dbfc

LayoutTests/ChangeLog

@@ -1,3 +1,17 @@
+2016-02-11  Chris Dumez  <cdumez@apple.com>
+
+        [Web IDL] interfaces should inherit EventTarget instead of duplicating the EventTarget API
+        https://bugs.webkit.org/show_bug.cgi?id=154121
+        <rdar://problem/24613234>
+
+        Reviewed by Gavin Barraclough.
+
+        Rebaseline a couple of layout tests now that interfaces inherit EventTarget
+        instead of duplicating the EventTarget API in their IDL.
+
+        * fast/dom/Window/window-properties-performance-expected.txt:
+        * fast/dom/prototype-chain-expected.txt:
+
 2016-02-11  Zalan Bujtas  <zalan@apple.com>
 
         Subpixel rendering: Make focusring painting subpixel aware.

LayoutTests/fast/dom/Window/window-properties-performance-expected.txt

@@ -1,6 +1,8 @@
 This test dumps all of the properties that are reachable from the window.performance object, along with their types.
 
 window.performance [object Performance]
+window.performance.addEventListener [function]
+window.performance.dispatchEvent [function]
 window.performance.navigation [object PerformanceNavigation]
 window.performance.navigation.TYPE_BACK_FORWARD [number]
 window.performance.navigation.TYPE_NAVIGATE [number]
@@ -9,6 +11,7 @@ window.performance.navigation.TYPE_RESERVED [number]
 window.performance.navigation.redirectCount [number]
 window.performance.navigation.type [number]
 window.performance.now [function]
+window.performance.removeEventListener [function]
 window.performance.timing [object PerformanceTiming]
 window.performance.timing.connectEnd [number]
 window.performance.timing.connectStart [number]

LayoutTests/fast/dom/prototype-chain-expected.txt

@@ -2,20 +2,24 @@ This page prints out the prototype chains of select DOM objects. Older versions
 
 NOTE: This test will start failing if you change the layout of a related prototype chain in WebCore. That does not necessarily mean that you have done something wrong; you may just need to check in new results.
 
------ [object HTMLDocument] (4 prototypes) -----
+----- [object HTMLDocument] (5 prototypes) -----
 
 [object Object]
 
+[object EventTargetPrototype]
+
 [object NodePrototype]
 
 [object DocumentPrototype]
 
 [object HTMLDocumentPrototype]
 
------ [object HTMLDivElement] (5 prototypes) -----
+----- [object HTMLDivElement] (6 prototypes) -----
 
 [object Object]
 
+[object EventTargetPrototype]
+
 [object NodePrototype]
 
 [object ElementPrototype]
@@ -24,10 +28,12 @@ NOTE: This test will start failing if you change the layout of a related prototy
 
 [object HTMLDivElementPrototype]
 
------ [object HTMLFormElement] (5 prototypes) -----
+----- [object HTMLFormElement] (6 prototypes) -----
 
 [object Object]
 
+[object EventTargetPrototype]
+
 [object NodePrototype]
 
 [object ElementPrototype]

LayoutTests/imported/w3c/ChangeLog

@@ -1,3 +1,16 @@
+2016-02-11  Chris Dumez  <cdumez@apple.com>
+
+        [Web IDL] interfaces should inherit EventTarget instead of duplicating the EventTarget API
+        https://bugs.webkit.org/show_bug.cgi?id=154121
+        <rdar://problem/24613234>
+
+        Reviewed by Gavin Barraclough.
+
+        Rebaseline several W3C tests now that more checks are passing.
+
+        * web-platform-tests/dom/interfaces-expected.txt:
+        * web-platform-tests/html/dom/interfaces-expected.txt:
+
 2016-02-11  Chris Dumez  <cdumez@apple.com>
 
         Move 'length' property to the prototype

LayoutTests/imported/w3c/web-platform-tests/dom/interfaces-expected.txt

@@ -170,14 +170,10 @@ PASS MutationRecord interface: attribute nextSibling
 PASS MutationRecord interface: attribute attributeName 
 PASS MutationRecord interface: attribute attributeNamespace 
 PASS MutationRecord interface: attribute oldValue 
-FAIL Node interface: existence and properties of interface object assert_equals: prototype of Node is not EventTarget expected function "function EventTarget() {
-    [native code]
-}" but got function "function () {
-    [native code]
-}"
+PASS Node interface: existence and properties of interface object 
 PASS Node interface object length 
 PASS Node interface object name 
-FAIL Node interface: existence and properties of interface prototype object assert_equals: prototype of Node.prototype is not EventTarget.prototype expected object "[object EventTargetPrototype]" but got object "[object Object]"
+PASS Node interface: existence and properties of interface prototype object 
 PASS Node interface: existence and properties of interface prototype object's "constructor" property 
 PASS Node interface: constant ELEMENT_NODE on interface object 
 PASS Node interface: constant ELEMENT_NODE on interface prototype object 

LayoutTests/imported/w3c/web-platform-tests/html/dom/interfaces-expected.txt

@@ -2233,14 +2233,10 @@ FAIL VideoTrack interface: attribute kind assert_own_property: self does not hav
 FAIL VideoTrack interface: attribute label assert_own_property: self does not have own property "VideoTrack" expected property "VideoTrack" missing
 FAIL VideoTrack interface: attribute language assert_own_property: self does not have own property "VideoTrack" expected property "VideoTrack" missing
 FAIL VideoTrack interface: attribute selected assert_own_property: self does not have own property "VideoTrack" expected property "VideoTrack" missing
-FAIL MediaController interface: existence and properties of interface object assert_equals: prototype of MediaController is not EventTarget expected function "function EventTarget() {
-    [native code]
-}" but got function "function () {
-    [native code]
-}"
+PASS MediaController interface: existence and properties of interface object 
 PASS MediaController interface object length 
 PASS MediaController interface object name 
-FAIL MediaController interface: existence and properties of interface prototype object assert_equals: prototype of MediaController.prototype is not EventTarget.prototype expected object "[object EventTargetPrototype]" but got object "[object Object]"
+PASS MediaController interface: existence and properties of interface prototype object 
 PASS MediaController interface: existence and properties of interface prototype object's "constructor" property 
 FAIL MediaController interface: attribute readyState assert_true: The prototype object must have a property "readyState" expected true got false
 PASS MediaController interface: attribute buffered 
@@ -2312,14 +2308,10 @@ FAIL EventTarget interface: calling removeEventListener(DOMString,EventListener,
 }" did not throw
 PASS EventTarget interface: new MediaController() must inherit property "dispatchEvent" with the proper type (2) 
 PASS EventTarget interface: calling dispatchEvent(Event) on new MediaController() with too few arguments must throw TypeError 
-FAIL TextTrackList interface: existence and properties of interface object assert_equals: prototype of TextTrackList is not EventTarget expected function "function EventTarget() {
-    [native code]
-}" but got function "function () {
-    [native code]
-}"
+PASS TextTrackList interface: existence and properties of interface object 
 PASS TextTrackList interface object length 
 PASS TextTrackList interface object name 
-FAIL TextTrackList interface: existence and properties of interface prototype object assert_equals: prototype of TextTrackList.prototype is not EventTarget.prototype expected object "[object EventTargetPrototype]" but got object "[object Object]"
+PASS TextTrackList interface: existence and properties of interface prototype object 
 PASS TextTrackList interface: existence and properties of interface prototype object's "constructor" property 
 PASS TextTrackList interface: attribute length 
 PASS TextTrackList interface: operation getTrackById(DOMString) 
@@ -2344,14 +2336,10 @@ FAIL EventTarget interface: calling removeEventListener(DOMString,EventListener,
 }" did not throw
 PASS EventTarget interface: document.createElement("video").textTracks must inherit property "dispatchEvent" with the proper type (2) 
 PASS EventTarget interface: calling dispatchEvent(Event) on document.createElement("video").textTracks with too few arguments must throw TypeError 
-FAIL TextTrack interface: existence and properties of interface object assert_equals: prototype of TextTrack is not EventTarget expected function "function EventTarget() {
-    [native code]
-}" but got function "function () {
-    [native code]
-}"
+PASS TextTrack interface: existence and properties of interface object 
 PASS TextTrack interface object length 
 PASS TextTrack interface object name 
-FAIL TextTrack interface: existence and properties of interface prototype object assert_equals: prototype of TextTrack.prototype is not EventTarget.prototype expected object "[object EventTargetPrototype]" but got object "[object Object]"
+PASS TextTrack interface: existence and properties of interface prototype object 
 PASS TextTrack interface: existence and properties of interface prototype object's "constructor" property 
 FAIL TextTrack interface: attribute kind assert_equals: setter must be undefined for readonly attributes expected (undefined) undefined but got (function) function "function kind() {
     [native code]
@@ -2405,14 +2393,10 @@ PASS Stringification of document.createElement("video").addTextTrack("subtitles"
 PASS TextTrackCueList interface: document.createElement("video").addTextTrack("subtitles").cues must inherit property "length" with the proper type (0) 
 PASS TextTrackCueList interface: document.createElement("video").addTextTrack("subtitles").cues must inherit property "getCueById" with the proper type (2) 
 PASS TextTrackCueList interface: calling getCueById(DOMString) on document.createElement("video").addTextTrack("subtitles").cues with too few arguments must throw TypeError 
-FAIL TextTrackCue interface: existence and properties of interface object assert_equals: prototype of TextTrackCue is not EventTarget expected function "function EventTarget() {
-    [native code]
-}" but got function "function () {
-    [native code]
-}"
+PASS TextTrackCue interface: existence and properties of interface object 
 FAIL TextTrackCue interface object length assert_equals: wrong value for TextTrackCue.length expected 0 but got 3
 PASS TextTrackCue interface object name 
-FAIL TextTrackCue interface: existence and properties of interface prototype object assert_equals: prototype of TextTrackCue.prototype is not EventTarget.prototype expected object "[object EventTargetPrototype]" but got object "[object Object]"
+PASS TextTrackCue interface: existence and properties of interface prototype object 
 PASS TextTrackCue interface: existence and properties of interface prototype object's "constructor" property 
 PASS TextTrackCue interface: attribute track 
 PASS TextTrackCue interface: attribute id 
@@ -4208,14 +4192,10 @@ PASS BeforeUnloadEvent interface object name
 PASS BeforeUnloadEvent interface: existence and properties of interface prototype object 
 PASS BeforeUnloadEvent interface: existence and properties of interface prototype object's "constructor" property 
 PASS BeforeUnloadEvent interface: attribute returnValue 
-FAIL ApplicationCache interface: existence and properties of interface object assert_equals: prototype of ApplicationCache is not EventTarget expected function "function EventTarget() {
-    [native code]
-}" but got function "function () {
-    [native code]
-}"
+PASS ApplicationCache interface: existence and properties of interface object 
 PASS ApplicationCache interface object length 
 PASS ApplicationCache interface object name 
-FAIL ApplicationCache interface: existence and properties of interface prototype object assert_equals: prototype of ApplicationCache.prototype is not EventTarget.prototype expected object "[object EventTargetPrototype]" but got object "[object Object]"
+PASS ApplicationCache interface: existence and properties of interface prototype object 
 PASS ApplicationCache interface: existence and properties of interface prototype object's "constructor" property 
 PASS ApplicationCache interface: constant UNCACHED on interface object 
 PASS ApplicationCache interface: constant UNCACHED on interface prototype object 
@@ -4406,14 +4386,10 @@ PASS MessageEvent interface: attribute lastEventId
 PASS MessageEvent interface: attribute source 
 PASS MessageEvent interface: attribute ports 
 FAIL MessageEvent interface: operation initMessageEvent(DOMString,boolean,boolean,any,DOMString,DOMString,[object Object],[object Object],MessagePort) assert_equals: property has wrong .length expected 8 but got 0
-FAIL EventSource interface: existence and properties of interface object assert_equals: prototype of EventSource is not EventTarget expected function "function EventTarget() {
-    [native code]
-}" but got function "function () {
-    [native code]
-}"
+PASS EventSource interface: existence and properties of interface object 
 PASS EventSource interface object length 
 PASS EventSource interface object name 
-FAIL EventSource interface: existence and properties of interface prototype object assert_equals: prototype of EventSource.prototype is not EventTarget.prototype expected object "[object EventTargetPrototype]" but got object "[object Object]"
+PASS EventSource interface: existence and properties of interface prototype object 
 PASS EventSource interface: existence and properties of interface prototype object's "constructor" property 
 PASS EventSource interface: attribute url 
 PASS EventSource interface: attribute withCredentials 
@@ -4428,14 +4404,10 @@ PASS EventSource interface: attribute onopen
 PASS EventSource interface: attribute onmessage 
 PASS EventSource interface: attribute onerror 
 PASS EventSource interface: operation close() 
-FAIL WebSocket interface: existence and properties of interface object assert_equals: prototype of WebSocket is not EventTarget expected function "function EventTarget() {
-    [native code]
-}" but got function "function () {
-    [native code]
-}"
+PASS WebSocket interface: existence and properties of interface object 
 PASS WebSocket interface object length 
 PASS WebSocket interface object name 
-FAIL WebSocket interface: existence and properties of interface prototype object assert_equals: prototype of WebSocket.prototype is not EventTarget.prototype expected object "[object EventTargetPrototype]" but got object "[object Object]"
+PASS WebSocket interface: existence and properties of interface prototype object 
 PASS WebSocket interface: existence and properties of interface prototype object's "constructor" property 
 PASS WebSocket interface: attribute url 
 PASS WebSocket interface: constant CONNECTING on interface object 
@@ -4536,14 +4508,10 @@ PASS MessageChannel interface: existence and properties of interface prototype o
 PASS MessageChannel interface: existence and properties of interface prototype object's "constructor" property 
 PASS MessageChannel interface: attribute port1 
 PASS MessageChannel interface: attribute port2 
-FAIL MessagePort interface: existence and properties of interface object assert_equals: prototype of MessagePort is not EventTarget expected function "function EventTarget() {
-    [native code]
-}" but got function "function () {
-    [native code]
-}"
+PASS MessagePort interface: existence and properties of interface object 
 PASS MessagePort interface object length 
 PASS MessagePort interface object name 
-FAIL MessagePort interface: existence and properties of interface prototype object assert_equals: prototype of MessagePort.prototype is not EventTarget.prototype expected object "[object EventTargetPrototype]" but got object "[object Object]"
+PASS MessagePort interface: existence and properties of interface prototype object 
 PASS MessagePort interface: existence and properties of interface prototype object's "constructor" property 
 PASS MessagePort interface: operation postMessage(any,[object Object]) 
 PASS MessagePort interface: operation start()