Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct setting of target and relatedTargets post-dispatch #585

Merged
merged 14 commits into from
Mar 28, 2018
Merged

Correct setting of target and relatedTargets post-dispatch #585

Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
fcad019
Turn relatedTarget into relatedTargets
annevk Mar 8, 2018
6755fb2
Correct setting of target and relatedTargets post-dispatch
annevk Mar 8, 2018
967e8de
Make event dispatch care about non-nodes again
annevk Mar 8, 2018
6b2f164
address some feedback from smaug and hayato
annevk Mar 13, 2018
ed8c98e
separate relatedTarget and touch target list
annevk Mar 14, 2018
f9d5e64
nit
annevk Mar 14, 2018
ea4690c
forgot to change append to an event path
annevk Mar 14, 2018
011d0d2
clear an event consistently
annevk Mar 15, 2018
4206f1f
reword to avoid early return
annevk Mar 15, 2018
9777fb8
fixup
annevk Mar 15, 2018
28946f9
address clearTargets and stop propagation issues
annevk Mar 27, 2018
67e64b4
remove callback comment as that's added by #614
annevk Mar 27, 2018
9dfab83
retarget touch targets against correct object
annevk Mar 27, 2018
f01c585
don't assume it's a node
annevk Mar 27, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
282 changes: 161 additions & 121 deletions dom.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,24 +466,30 @@ dictionary EventInit {
<p>An {{Event}} object is simply named an <dfn export id=concept-event>event</dfn>. It allows for
signaling that something has occurred, e.g., that an image has completed downloading.</p>

<p>An <a>event</a> has an associated <dfn export for=Event>relatedTarget</dfn> (null or an
{{EventTarget}} object). Unless stated otherwise it is null.</p>
<p>A <dfn export>potential event target</dfn> is null or an {{EventTarget}} object.

<p class="note">Other specifications use <a for=Event>relatedTarget</a> to define a
<p>An <a>event</a> has an associated <dfn export for=Event>relatedTarget</dfn> (a
<a>potential event target</a>). Unless stated otherwise it is null.

<p class=note>Other specifications use <a for=Event>relatedTarget</a> to define a
<code>relatedTarget</code> attribute. [[UIEVENTS]]

<p>An <a>event</a> has an associated <dfn export for=Event>touch target list</dfn> (a
<a for=/>list</a> of zero or more <a>potential event targets</a>). Unless stated otherwise it is the
empty list.

<p class=note>The <a for=Event>touch target list</a> is for the exclusive use of defining the
{{TouchEvent}} interface and related interfaces. [[TOUCH-EVENTS]]

<p>An <a>event</a> has an associated <dfn export for=Event>path</dfn>. A <a for=Event>path</a> is a
<a for=/>list</a> of <a for=/>structs</a>. Each <a for=/>struct</a> consists of an
<dfn for=Event/path>item</dfn> (an {{EventTarget}} object), <dfn for=Event/path>target</dfn> (null
or an {{EventTarget}} object), a <dfn for=Event/path>relatedTarget</dfn> (null or an
{{EventTarget}} object), <dfn for=Event/path>root-of-closed-tree</dfn> (a boolean), and a
<dfn for=Event/path>slot-in-closed-tree</dfn> (a boolean). A <a for=Event>path</a> is initially the
empty list.</p>

<p><a lt="Other applicable specifications">Specifications</a> may define
<dfn export for=Event>retargeting steps</dfn> for all or some <a>events</a>.
The algorithm is passed <var>event</var>, as indicated in the <a>dispatch</a>
algorithm below.
<dfn for=Event/path>item</dfn> (an {{EventTarget}} object), <dfn for=Event/path>target</dfn> (a
<a>potential event target</a>), a
<dfn id=event-path-relatedtarget for=Event/path>relatedTarget</dfn> (a
<a>potential event target</a>), a <dfn for=Event/path>touch target list</dfn> (a <a for=/>list</a>
of <a>potential event targets</a>), a <dfn for=Event/path>root-of-closed-tree</dfn> (a boolean), and
a <dfn for=Event/path>slot-in-closed-tree</dfn> (a boolean). A <a for=Event>path</a> is initially
the empty list.</p>

<dl class=domintro>
<dt><code><var>event</var> = new <a constructor lt="Event()">Event</a>(<var>type</var> [, <var>eventInitDict</var>])</code>
Expand Down Expand Up @@ -1154,149 +1160,164 @@ for discussion).
<p class="note"><var>legacy target override flag</var> is only used by HTML and only when
<var>target</var> is a {{Window}} object.

<li>Let <var>relatedTarget</var> be the result of <a>retargeting</a> <var>event</var>'s
<a for=Event>relatedTarget</a> against <var>target</var> if <var>event</var>'s
<a for=Event>relatedTarget</a> is non-null, and null otherwise.
<li><p>Let <var>activationTarget</var> be null.

<li><p>Let <var>relatedTarget</var> be the result of <a>retargeting</a> <var>event</var>'s
<a for=Event>relatedTarget</a> against <var>target</var>.

<li>
<p>If <var>target</var> is not <var>relatedTarget</var> or <var>target</var> is <var>event</var>'s
<a for=Event>relatedTarget</a>, then:

<li><p>If <var>target</var> is <var>relatedTarget</var> and <var>target</var> is not
<var>event</var>'s <a for=Event>relatedTarget</a>, then return true.
<ol>
<li><p>Let <var>touchTargets</var> be a new <a for=/>list</a>.

<li><p><a>Append to an event path</a> with <var>event</var>, <var>target</var>,
<var>targetOverride</var>, <var>relatedTarget</var>, and false.
<li><p><a for=list>For each</a> <var>touchTarget</var> of <var>event</var>'s
<a for=Event>touch target list</a>, <a for=list>append</a> the result of <a>retargeting</a>
<var>touchTarget</var> against <var>target</var> to <var>touchTargets</var>.

<li><p>Let <var>isActivationEvent</var> be true, if <var>event</var> is a {{MouseEvent}} object and
<var>event</var>'s {{Event/type}} attribute is "<code>click</code>", and false otherwise.
<li><p><a>Append to an event path</a> with <var>event</var>, <var>target</var>,
<var>targetOverride</var>, <var>relatedTarget</var>, <var>touchTargets</var>, and false.

<li><p>Let <var>activationTarget</var> be <var>target</var>, if <var>isActivationEvent</var> is
true and <var>target</var> has <a for=EventTarget>activation behavior</a>, and null otherwise.
<li><p>Let <var>isActivationEvent</var> be true, if <var>event</var> is a {{MouseEvent}} object
and <var>event</var>'s {{Event/type}} attribute is "<code>click</code>", and false otherwise.

<li><p>Let <var>slotable</var> be <var>target</var>, if <var>target</var> is
<a for=slotable>assigned</a>, and null otherwise.
<li><p>If <var>isActivationEvent</var> is true and <var>target</var> has
<a for=EventTarget>activation behavior</a>, then set <var>activationTarget</var> to
<var>target</var>.

<li><p>Let <var>slot-in-closed-tree</var> be false.
<li><p>Let <var>slotable</var> be <var>target</var>, if <var>target</var> is a <a>slotable</a>
and is <a for=slotable>assigned</a>, and null otherwise.

<li><p>Let <var>parent</var> be the result of invoking <var>target</var>'s <a>get the parent</a>
with <var>event</var>.
<li><p>Let <var>slot-in-closed-tree</var> be false.

<li>
<p>While <var>parent</var> is non-null:</p>
<li><p>Let <var>parent</var> be the result of invoking <var>target</var>'s <a>get the parent</a>
with <var>event</var>.

<ol>
<li>
<p>If <var>slotable</var> is non-null:
<p>While <var>parent</var> is non-null:</p>

<ol>
<li><p>Assert: <var>parent</var> is a <a for=/>slot</a>.

<li><p>Set <var>slotable</var> to null.
<li>
<p>If <var>slotable</var> is non-null:

<li><p>If <var>parent</var>'s <a for=tree>root</a> is a <a for=/>shadow root</a> whose
<a for=ShadowRoot>mode</a> is "<code>closed</code>", then set <var>slot-in-closed-tree</var> to
true.
</ol>
<ol>
<li><p>Assert: <var>parent</var> is a <a for=/>slot</a>.

<li><p>If <var>parent</var> is <a for=slotable>assigned</a>, then set <var>slotable</var> to
<var>parent</var>.
<li><p>Set <var>slotable</var> to null.

<li><p>Let <var>relatedTarget</var> be the result of <a>retargeting</a> <var>event</var>'s
<a for=Event>relatedTarget</a> against <var>parent</var> if <var>event</var>'s
<a for=Event>relatedTarget</a> is non-null, and null otherwise.
<li><p>If <var>parent</var>'s <a for=tree>root</a> is a <a for=/>shadow root</a> whose
<a for=ShadowRoot>mode</a> is "<code>closed</code>", then set <var>slot-in-closed-tree</var>
to true.
</ol>

<li>
<p>If <var>target</var>'s <a for=tree>root</a> is a
<a>shadow-including inclusive ancestor</a> of <var>parent</var>, then:
<li><p>If <var>parent</var> is a <a>slotable</a> and is <a for=slotable>assigned</a>, then set
<var>slotable</var> to <var>parent</var>.

<ol>
<li><p>If <var>isActivationEvent</var> is true, <var>event</var>'s {{Event/bubbles}} attribute
is true, <var>activationTarget</var> is null, and <var>parent</var> has
<a for=EventTarget>activation behavior</a>, then set <var>activationTarget</var> to
<var>parent</var>.
<li><p>Let <var>relatedTarget</var> be the result of <a>retargeting</a> <var>event</var>'s
<a for=Event>relatedTarget</a> against <var>parent</var>.

<li><p><a>Append to an event path</a> with <var>event</var>, <var>parent</var>, null,
<var>relatedTarget</var>, and <var>slot-in-closed-tree</var>.
</ol>
<li><p>Let <var>touchTargets</var> be a new <a for=/>list</a>.

<li><p>Otherwise, if <var>parent</var> and <var>relatedTarget</var> are identical, then set
<var>parent</var> to null.
<li><p><a for=list>For each</a> <var>touchTarget</var> of <var>event</var>'s
<a for=Event>touch target list</a>, <a for=list>append</a> the result of <a>retargeting</a>
<var>touchTarget</var> against <var>parent</var> to <var>touchTargets</var>.

<li>
<p>Otherwise, set <var>target</var> to <var>parent</var> and then:
<li>
<p>If <var>parent</var> is a <a>node</a> and <var>target</var>'s <a for=tree>root</a> is a
<a>shadow-including inclusive ancestor</a> of <var>parent</var>, then:

<ol>
<li><p>If <var>isActivationEvent</var> is true, <var>activationTarget</var> is null, and
<var>target</var> has <a for=EventTarget>activation behavior</a>, then set
<var>activationTarget</var> to <var>target</var>.
<ol>
<li><p>If <var>isActivationEvent</var> is true, <var>event</var>'s {{Event/bubbles}}
attribute is true, <var>activationTarget</var> is null, and <var>parent</var> has
<a for=EventTarget>activation behavior</a>, then set <var>activationTarget</var> to
<var>parent</var>.

<li><p><a>Append to an event path</a> with <var>event</var>, <var>parent</var>,
<var>target</var>, <var>relatedTarget</var>, and <var>slot-in-closed-tree</var>.
</ol>
<li><p><a>Append to an event path</a> with <var>event</var>, <var>parent</var>, null,
<var>relatedTarget</var>, <var>touchTargets</var>, and <var>slot-in-closed-tree</var>.
</ol>

<li><p>If <var>parent</var> is non-null, then set <var>parent</var> to the result of invoking
<var>parent</var>'s <a>get the parent</a> with <var>event</var>.
<li><p>Otherwise, if <var>parent</var> is <var>relatedTarget</var>, then set <var>parent</var>
to null.

<li><p>Set <var>slot-in-closed-tree</var> to false.
</ol>
<li>
<p>Otherwise, set <var>target</var> to <var>parent</var> and then:

<li><p>Set <var>event</var>'s {{Event/eventPhase}} attribute to {{Event/CAPTURING_PHASE}}.
<ol>
<li><p>If <var>isActivationEvent</var> is true, <var>activationTarget</var> is null, and
<var>target</var> has <a for=EventTarget>activation behavior</a>, then set
<var>activationTarget</var> to <var>target</var>.

<li><p>If <var>activationTarget</var> is non-null and <var>activationTarget</var> has
<a for=EventTarget>legacy-pre-activation behavior</a>, then run <var>activationTarget</var>'s
<a for=EventTarget>legacy-pre-activation behavior</a>.
<li><p><a>Append to an event path</a> with <var>event</var>, <var>parent</var>,
<var>target</var>, <var>relatedTarget</var>, <var>touchTargets</var>, and
<var>slot-in-closed-tree</var>.
</ol>

<li>
<p>For each <var>tuple</var> in <var>event</var>'s <a for=Event>path</a>, in reverse order:
<li><p>If <var>parent</var> is non-null, then set <var>parent</var> to the result of invoking
<var>parent</var>'s <a>get the parent</a> with <var>event</var>.

<ol>
<li><p>Set <var>event</var>'s {{Event/target}} attribute to the <b>target</b> of the last tuple
in <var>event</var>'s <a for=Event>path</a>, that is either <var>tuple</var> or preceding
<var>tuple</var>, whose <b>target</b> is non-null.
<li><p>Set <var>slot-in-closed-tree</var> to false.
</ol>

<li><p>Set <var>event</var>'s <a for=Event>relatedTarget</a> to <var>tuple</var>'s
<b>relatedTarget</b>.
<li><p>Let <var>clearTargetsTuple</var> be the last tuple in <var>event</var>'s
<a for=Event>path</a> whose <a for=Event/path>target</a> is non-null.

<li><p>Run the <a>retargeting steps</a> with <var>event</var>.
<li><p>Let <var>clearTargets</var> be true if <var>clearTargetsTuple</var>'s
<a for=Event/path>target</a>, <var>clearTargetsTuple</var>'s <a for=Event/path>relatedTarget</a>,
or an {{EventTarget}} object in <var>clearTargetsTuple</var>'s
<a for=Event/path>touch target list</a> is a <a for=/>node</a> and its <a for=tree>root</a> is a
<a for=/>shadow root</a>, and false otherwise.

<li><p>If <var>tuple</var>'s <b>target</b> is null, then <a>invoke</a> <var>tuple</var>'s
<b>item</b> with <var>event</var> and <var>legacyOutputDidListenersThrowFlag</var> if given.
</ol>
<li><p>Set <var>event</var>'s {{Event/eventPhase}} attribute to {{Event/CAPTURING_PHASE}}.

<li>
<p>For each <var>tuple</var> in <var>event</var>'s <a for=Event>path</a>, in order:
<li><p>If <var>activationTarget</var> is non-null and <var>activationTarget</var> has
<a for=EventTarget>legacy-pre-activation behavior</a>, then run <var>activationTarget</var>'s
<a for=EventTarget>legacy-pre-activation behavior</a>.

<ol>
<li><p>Set <var>event</var>'s {{Event/target}} attribute to the <b>target</b> of the last tuple
in <var>event</var>'s <a for=Event>path</a>, that is either <var>tuple</var> or preceding
<var>tuple</var>, whose <b>target</b> is non-null.
<li>
<p>For each <var>tuple</var> in <var>event</var>'s <a for=Event>path</a>, in reverse order:

<li><p>Set <var>event</var>'s <a for=Event>relatedTarget</a> to <var>tuple</var>'s
<b>relatedTarget</b>.
<ol>
<li><p>If <var>tuple</var>'s <a for=Event/path>target</a> is null, then <a>invoke</a> with
<var>tuple</var>, <var>event</var>, and <var>legacyOutputDidListenersThrowFlag</var> if given.
</ol>

<li><p>Run the <a>retargeting steps</a> with <var>event</var>.
<li>
<p>For each <var>tuple</var> in <var>event</var>'s <a for=Event>path</a>, in order:

<li><p>If <var>tuple</var>'s <b>target</b> is non-null, then set <var>event</var>'s
{{Event/eventPhase}} attribute to {{Event/AT_TARGET}}.
<ol>
<li><p>If <var>tuple</var>'s <a for=Event/path>target</a> is non-null, then set
<var>event</var>'s {{Event/eventPhase}} attribute to {{Event/AT_TARGET}}.

<li><p>Otherwise, set <var>event</var>'s {{Event/eventPhase}} attribute to
{{Event/BUBBLING_PHASE}}.
<li><p>Otherwise, set <var>event</var>'s {{Event/eventPhase}} attribute to
{{Event/BUBBLING_PHASE}}.

<li><p>If either <var>event</var>'s {{Event/eventPhase}} attribute is {{Event/BUBBLING_PHASE}}
and <var>event</var>'s {{Event/bubbles}} attribute is true or <var>event</var>'s
{{Event/eventPhase}} attribute is {{Event/AT_TARGET}}, then <a>invoke</a> <var>tuple</var>'s
<b>item</b> with <var>event</var> and <var>legacyOutputDidListenersThrowFlag</var> if given.
<li><p>If either <var>event</var>'s {{Event/eventPhase}} attribute is {{Event/BUBBLING_PHASE}}
and <var>event</var>'s {{Event/bubbles}} attribute is true or <var>event</var>'s
{{Event/eventPhase}} attribute is {{Event/AT_TARGET}}, then <a>invoke</a> with
<var>tuple</var>, <var>event</var>, and <var>legacyOutputDidListenersThrowFlag</var> if given.
</ol>
</ol>

<li><p>Set <var>event</var>'s {{Event/eventPhase}} attribute to {{Event/NONE}}.

<li><p>Set <var>event</var>'s {{Event/currentTarget}} attribute to null.

<li><p>Set <var>event</var>'s <a for=Event>path</a> to the empty list.

<li><p>Unset <var>event</var>'s <a>dispatch flag</a>, <a>stop propagation flag</a>, and
<a>stop immediate propagation flag</a>.

<li><p>Set <var>event</var>'s {{Event/eventPhase}} attribute to {{Event/NONE}}.
<li>
<p>If <var>clearTargets</var>, then:

<li><p>If {{Event/target}}'s <a for=tree>root</a> is a <a for=/>shadow root</a>, then set
<var>event</var>'s {{Event/target}} attribute and <var>event</var>'s <a for=Event>relatedTarget</a>
to null.
<ol>
<li><p>Set <var>event</var>'s {{Event/target}} attribute to null.

<li><p>Set <var>event</var>'s {{Event/currentTarget}} attribute to null.
<li><p>Set <var>event</var>'s <a for=Event>relatedTarget</a> to null.

<li><p>Set <var>event</var>'s <a for=Event>path</a> to the empty list.
<li><p>Set <var>event</var>'s <a for=Event>touch target list</a> to the empty list.
</ol>

<li>
<p>If <var>activationTarget</var> is non-null, then:
Expand All @@ -1314,8 +1335,8 @@ for discussion).
</ol>

<p>To <dfn noexport id=concept-event-path-append>append to an event path</dfn>, given an
<var>event</var>, <var>target</var>, <var>targetOverride</var>, <var>relatedTarget</var>, and a
<var>slot-in-closed-tree</var>, run these steps:</p>
<var>event</var>, <var>target</var>, <var>targetOverride</var>, <var>relatedTarget</var>,
<var>touchTargets</var>, and a <var>slot-in-closed-tree</var>, run these steps:</p>

<ol>
<li><p>Let <var>root-of-closed-tree</var> be false.
Expand All @@ -1326,22 +1347,32 @@ for discussion).
<li><p><a for=list>Append</a> a new <a for=/>struct</a> to <var>event</var>'s <a for=Event>path</a>
whose <a for=Event/path>item</a> is <var>target</var>, <a for=Event/path>target</a> is
<var>targetOverride</var>, <a for=Event/path>relatedTarget</a> is <var>relatedTarget</var>,
<a for=Event/path>touch target list</a> is <var>touchTargets</var>,
<a for=Event/path>root-of-closed-tree</a> is <var>root-of-closed-tree</var>, and
<a for=Event/path>slot-in-closed-tree</a> is <var>slot-in-closed-tree</var>.
</ol>

<p>To <dfn noexport id=concept-event-listener-invoke>invoke</dfn> an <var>object</var> with
<var>event</var> and an optional <var>legacyOutputDidListenersThrowFlag</var>, run these steps:
<p>To <dfn noexport id=concept-event-listener-invoke>invoke</dfn>, given a <var>tuple</var>,
<var>event</var>, and an optional <var>legacyOutputDidListenersThrowFlag</var>, run these steps:

<ol>
<li><p>Set <var>event</var>'s {{Event/target}} attribute to the <a for=Event/path>target</a> of the
last tuple in <var>event</var>'s <a for=Event>path</a>, that is either <var>tuple</var> or
preceding <var>tuple</var>, whose <a for=Event/path>target</a> is non-null.

<li><p>Set <var>event</var>'s <a for=Event>relatedTarget</a> to <var>tuple</var>'s
<a for=Event/path>relatedTarget</a>.

<li><p>Set <var>event</var>'s <a for=Event>touch target list</a> to <var>tuple</var>'s
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm, perhaps a bit confusing, but I guess should be enough for touch objects. They just need to have a pointer to the event, so that they can update their target form there (basically map their original target to retargeted target or so)

<a for=Event/path>touch target list</a>.

<li><p>If <var>event</var>'s <a>stop propagation flag</a> is set, then return.

<li><p>Let <var>listeners</var> be a new <a for=/>list</a>.
<li><p>Let <var>object</var> be <var>tuple</var>'s <a for=Event/path>item</a>.

<li>
<p><a for=list>For each</a> <var>listener</var> of <var>object</var>'s
<a for=EventTarget>event listener list</a>, <a for=list>append</a> <var>listener</var> to
<var>listeners</var>.
<p>Let <var>listeners</var> be a <a for=list>clone</a> of <var>object</var>'s
<a for=EventTarget>event listener list</a>.

<p class="note no-backref">This avoids <a>event listeners</a> added after this point from being
run. Note that removal still has an effect due to the <a for="event listener">removed</a> field.
Expand Down Expand Up @@ -5621,9 +5652,17 @@ is an object or one of its <a>shadow-including ancestors</a>.
<var>B</var>, repeat these steps until they return an object:</p>

<ol>
<li><p>If <var>A</var>'s <a for=tree>root</a> is not a <a for=/>shadow root</a>, or <var>A</var>'s
<a for=tree>root</a> is a <a>shadow-including inclusive ancestor</a> of <var>B</var>, then return
<var>A</var>.
<li>
<p>If one of the following is true

<ul class=brief>
<li><var>A</var> is not a <a>node</a>
<li><var>A</var>'s <a for=tree>root</a> is not a <a for=/>shadow root</a>
<li><var>B</var> is a <a>node</a> and <var>A</var>'s <a for=tree>root</a> is a
<a>shadow-including inclusive ancestor</a> of <var>B</var>
</ul>

<p>then return <var>A</var>.

<li><p>Set <var>A</var> to <var>A</var>'s <a for=tree>root</a>'s <a for=DocumentFragment>host</a>.
</ol>
Expand Down Expand Up @@ -9820,6 +9859,7 @@ Tab Atkins,
Takashi Sakamoto,
Takayoshi Kochi,
Theresa O'Connor,
Theodore Dubois,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this related to this pr?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes: #392.

<i>timeless</i>,
Timo Tijhof,
Tobie Langel,
Expand Down