Bug 171145 – Rename callerDOMWindow()/CallerDocument to incumbentDOMWindow()/IncumbentDocument

• Status: RESOLVED
• Resolution: FIXED
• Component: WebCore Misc.

[Daniel Bates]

We should use the HTML standard's terminology "incumbent" instead of "caller" to describe the "most-recently-entered author function or script on the stack, or the author function or script that originally scheduled the currently-running callback." (<https://html.spec.whatwg.org/multipage/webappapis.html#realms-settings-objects-global-objects>, 21 April 2017).

[Daniel Bates]

Created attachment 307816 [details]
Patch

[Saam Barati]

Comment on attachment 307816 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=307816&action=review

r=me

> Source/WebCore/bindings/js/JSDOMWindowBase.cpp:291
> +DOMWindow& incumbentDOMWindow(ExecState* exec)

IMO, I think it could be helpful to have a comment here either linking to the spec, or describing the heart of what this function does.
Just by reading its name, it wouldn't be obvious to me. I understand what it's called incumbent, since this isn't always
the caller (setTimeout, etc), but I think it's "caller" in spirit.

[Build Bot]

Comment on attachment 307816 [details]
Patch

Attachment 307816 [details] did not pass mac-debug-ews (mac):
Output: http://webkit-queues.webkit.org/results/3579366

New failing tests:
media/modern-media-controls/macos-fullscreen-media-controls/macos-fullscreen-media-controls-buttons-styles.html

[Build Bot]

Created attachment 307842 [details]
Archive of layout-test-results from ews112 for mac-elcapitan

The attached test failures were seen while running run-webkit-tests on the mac-debug-ews.
Bot: ews112  Port: mac-elcapitan  Platform: Mac OS X 10.11.6

[Daniel Bates]

(In reply to Saam Barati from comment #2)
> Comment on attachment 307816 [details]
> Patch
> 
> View in context:
> https://bugs.webkit.org/attachment.cgi?id=307816&action=review
> 
> r=me
> 
> > Source/WebCore/bindings/js/JSDOMWindowBase.cpp:291
> > +DOMWindow& incumbentDOMWindow(ExecState* exec)
> 
> IMO, I think it could be helpful to have a comment here either linking to
> the spec, or describing the heart of what this function does.
> Just by reading its name, it wouldn't be obvious to me. I understand what
> it's called incumbent, since this isn't always
> the caller (setTimeout, etc), but I think it's "caller" in spirit.

Will add the follow comment above this function before landing:

// DOMWindow associated with global object of the "most-recently-entered author function or script
// on the stack, or the author function or script that originally scheduled the currently-running callback."
// (<https://html.spec.whatwg.org/multipage/webappapis.html#concept-incumbent-everything>, 27 April 2017)
// FIXME: Make this work for an "author function or script that originally scheduled the currently-running callback."
// See <https://bugs.webkit.org/show_bug.cgi?id=163412>.

[Daniel Bates]

(In reply to Daniel Bates from comment #5)
> [...]
> Will add the follow comment above this function before landing:
> 
Actually, I will add this comment above the declaration of incumbentDOMWindow() in JSDOMWindowBase.h.

[Daniel Bates]

Committed r215904: <http://trac.webkit.org/changeset/215904>