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

Update Event.timeStamp type to DOMHighResTimeStamp. #420

Merged
merged 7 commits into from
Jul 13, 2017
Merged

Update Event.timeStamp type to DOMHighResTimeStamp. #420

Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
388b856
Use DOMHighResTimeStamp for Event.timeStamp.
majido Mar 8, 2017
c53e8c7
Address @domenic's feedback
majido Mar 8, 2017
4b47704
Address @annevk feedback
majido Jun 22, 2017
198fe36
Address annevk@ feedback
majido Jul 10, 2017
0ae7247
Minor corrections
majido Jul 11, 2017
f7f84d7
Add Majid Valipour to credits
majido Jul 12, 2017
3f9f333
Fix inadvertant mistake
majido Jul 12, 2017
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
45 changes: 34 additions & 11 deletions dom.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,11 @@ urlPrefix: https://w3c.github.io/ServiceWorker/#; spec: SERVICE-WORKERS
urlPrefix: https://tc39.github.io/ecma262/#; spec: ECMASCRIPT
text: Construct; url: sec-construct; type: abstract-op
text: Realm; url: realm; type: dfn
urlPrefix: https://w3c.github.io/hr-time/#; spec: HR-TIME
type:typedef; urlPrefix: dom-; text: DOMHighResTimeStamp
type:dfn; text: time origin
type:dfn; text: clock resolution

</pre>

<pre class='link-defaults'>
Expand Down Expand Up @@ -522,7 +527,7 @@ interface Event {
readonly attribute boolean composed;

[Unforgeable] readonly attribute boolean isTrusted;
readonly attribute DOMTimeStamp timeStamp;
readonly attribute DOMHighResTimeStamp timeStamp;

void initEvent(DOMString type, optional boolean bubbles = false, optional boolean cancelable = false); // historical
};
Expand Down Expand Up @@ -628,8 +633,8 @@ algorithm below.
false otherwise.

<dt><code><var>event</var> . {{Event/timeStamp}}</code>
<dd>Returns the creation time of <var>event</var> as the number of milliseconds that
passed since 00:00:00 UTC on 1 January 1970.
<dd>Returns the <var>event</var>'s timestamp as the number of milliseconds measured relative to
the <a>time origin</a>.
</dl>

The <dfn attribute for=Event><code>type</code></dfn> attribute must
Expand Down Expand Up @@ -761,15 +766,12 @@ initialized to false.
the user agent to dispatch an <a>event</a> whose {{Event/isTrusted}} attribute is initialized to
false.

The <dfn attribute for=Event><code>timeStamp</code></dfn> attribute
must return the value it was initialized to. When an
<a>event</a> is created the attribute must be
initialized to the number of milliseconds that have passed since
00:00:00 UTC on 1 January 1970, ignoring leap seconds.
<!-- leap seconds are ignored by JavaScript too -->
The <dfn attribute for=Event><code>timeStamp</code></dfn> attribute must return the value it was
initialized to.

<p class=XXX>This is highly likely to change and already does not reflect implementations well.
Please see <a href=https://github.com/whatwg/dom/issues/23>dom #23</a> for more details.
<p class=warning> User agents are strongly encouraged to set minimum resolution of the
{{Event/timeStamp}} attribute to 5 microseconds following the existing <a>clock resolution</a>
recommendation. [[!HR-TIME]]

<hr>

Expand Down Expand Up @@ -875,6 +877,10 @@ must be run, given the arguments <var>type</var> and <var>eventInitDict</var>:

<li><p>Initialize <var>event</var>'s {{Event/type}} attribute to <var>type</var>.

<li><p>Initialize <var>event</var>'s {{Event/timeStamp}} attribute to a {{DOMHighResTimeStamp}}
representing the high resolution time from the <a>time origin</a> to the occurrence of the call
to the <var>event</var>'s <a>constructor</a>.

<li><p>For each <a>dictionary member</a> present in <var>eventInitDict</var>, find the attribute on
<var>event</var> whose <a spec=webidl>identifier</a> matches the key of the
<a>dictionary member</a> and then set the attribute to the value of that <a>dictionary member</a>.
Expand Down Expand Up @@ -907,6 +913,16 @@ it, and optionally given a <a>Realm</a> <var>realm</var>, run these steps:</p>
<a>dictionary member</a> and then set the attribute to the default value of that
<a>dictionary member</a>.

<li><p>Set <var>event</var>'s {{Event/timeStamp}} attribute to a {{DOMHighResTimeStamp}}
representing the high resolution time from the <a>time origin</a> to the occurrence that the
event is signaling.

<p class=note>For example, in macOs the occurrence time for input actions are available via the
Copy link
Member

Choose a reason for hiding this comment

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

macOS*

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.

Copy link
Member

Choose a reason for hiding this comment

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

macOS

timestamp property of corresponding <code>NSEvent</code> objects. So in this case, the
{{Event/timeStamp}} value should be equivalent to the <code>NSEvent</code>'s timestamp offset by
<a>time origin</a>, translated in milliseconds, and with its precision adjusted to meet the
recommended minimum <a>clock resolution</a>.

<li><p>Initialize <var>event</var>'s {{Event/isTrusted}} attribute to true.

<li><p>Return <var>event</var>.
Expand Down Expand Up @@ -5154,6 +5170,10 @@ invoked, must run these steps:

<li><p>Initialize <var>event</var>'s {{Event/type}} attribute to the empty string.

<li><p>Initialize <var>event</var>'s {{Event/timeStamp}} attribute to a {{DOMHighResTimeStamp}}
which is the high resolution time from the <a>time origin</a> to the occurrence of the call to
{{Document/createEvent()}}.
Copy link
Member

Choose a reason for hiding this comment

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

This was what I was talking about with respect to duplication, but I guess that's also following the isTrusted precedent. Probably okay. Can this become "from the time origin to now"? It's a little weird for the algorithm to refer to itself this way.

Copy link
Member Author

Choose a reason for hiding this comment

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

Replaced self-reference with "now".


<li><p>Initialize <var>event</var>'s {{Event/isTrusted}} attribute to false.

<li><p>Unset <var>event</var>'s <a>initialized flag</a>.
Expand Down Expand Up @@ -9569,6 +9589,9 @@ other chapters are defined by the <cite>UI Events</cite> specification.
<li>The propagation and canceled flags are unset when invoking
{{Event/initEvent()}} rather than after
dispatch.
<li>{{Event/timeStamp}} is no longer a {{DOMTimeStamp}} representing creation time of event as
the number of milliseconds that passed since 00:00:00 UTC on 1 January 1970, but instead a
{{DOMHighResTimeStamp}}.
</ul>


Expand Down