<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[209394] trunk/Source/WebCore</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/209394">209394</a></dd>
<dt>Author</dt> <dd>jer.noble@apple.com</dd>
<dt>Date</dt> <dd>2016-12-06 08:40:56 -0800 (Tue, 06 Dec 2016)</dd>
</dl>
<h3>Log Message</h3>
<pre>[pointer-lock] Cursor should become visible when exiting pointer-lock via ESC key.
https://bugs.webkit.org/show_bug.cgi?id=165377
Reviewed by Darin Adler.
Introduce the concept of "force cursor to become visible" when requesting the pointer be
unlocked. ESC events will cause the pointer to become visible, while normal key events
will not.
* page/EventHandler.cpp:
(WebCore::EventHandler::keyEvent):
* page/PointerLockController.cpp:
(WebCore::PointerLockController::requestPointerUnlock):
(WebCore::PointerLockController::requestPointerUnlockAndForceCursorVisible):
(WebCore::PointerLockController::documentDetached):
(WebCore::PointerLockController::didLosePointerLock):
* page/PointerLockController.h:
Drive-by fix: apply Darin's feedback to existing functions:
* dom/Document.cpp:
(WebCore::Document::prepareForDestruction):
* dom/Element.cpp:
(WebCore::Element::removedFrom):
* page/PointerLockController.cpp:
(WebCore::PointerLockController::elementRemoved):
(WebCore::PointerLockController::documentDetached):</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebCoreChangeLog">trunk/Source/WebCore/ChangeLog</a></li>
<li><a href="#trunkSourceWebCoredomDocumentcpp">trunk/Source/WebCore/dom/Document.cpp</a></li>
<li><a href="#trunkSourceWebCoredomElementcpp">trunk/Source/WebCore/dom/Element.cpp</a></li>
<li><a href="#trunkSourceWebCorepageEventHandlercpp">trunk/Source/WebCore/page/EventHandler.cpp</a></li>
<li><a href="#trunkSourceWebCorepagePointerLockControllercpp">trunk/Source/WebCore/page/PointerLockController.cpp</a></li>
<li><a href="#trunkSourceWebCorepagePointerLockControllerh">trunk/Source/WebCore/page/PointerLockController.h</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebCoreChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/ChangeLog (209393 => 209394)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/ChangeLog 2016-12-06 15:55:07 UTC (rev 209393)
+++ trunk/Source/WebCore/ChangeLog 2016-12-06 16:40:56 UTC (rev 209394)
</span><span class="lines">@@ -1,3 +1,34 @@
</span><ins>+2016-12-05 Jer Noble <jer.noble@apple.com>
+
+ [pointer-lock] Cursor should become visible when exiting pointer-lock via ESC key.
+ https://bugs.webkit.org/show_bug.cgi?id=165377
+
+ Reviewed by Darin Adler.
+
+ Introduce the concept of "force cursor to become visible" when requesting the pointer be
+ unlocked. ESC events will cause the pointer to become visible, while normal key events
+ will not.
+
+ * page/EventHandler.cpp:
+ (WebCore::EventHandler::keyEvent):
+ * page/PointerLockController.cpp:
+ (WebCore::PointerLockController::requestPointerUnlock):
+ (WebCore::PointerLockController::requestPointerUnlockAndForceCursorVisible):
+ (WebCore::PointerLockController::documentDetached):
+ (WebCore::PointerLockController::didLosePointerLock):
+ * page/PointerLockController.h:
+
+ Drive-by fix: apply Darin's feedback to existing functions:
+
+ * dom/Document.cpp:
+ (WebCore::Document::prepareForDestruction):
+ * dom/Element.cpp:
+ (WebCore::Element::removedFrom):
+ * page/PointerLockController.cpp:
+ (WebCore::PointerLockController::elementRemoved):
+ (WebCore::PointerLockController::documentDetached):
+
+
</ins><span class="cx"> 2016-12-06 Sam Weinig <sam@webkit.org>
</span><span class="cx">
</span><span class="cx"> [WebIDL] Add support for converting dictionaries to JS
</span></span></pre></div>
<a id="trunkSourceWebCoredomDocumentcpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/dom/Document.cpp (209393 => 209394)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/dom/Document.cpp 2016-12-06 15:55:07 UTC (rev 209393)
+++ trunk/Source/WebCore/dom/Document.cpp 2016-12-06 16:40:56 UTC (rev 209394)
</span><span class="lines">@@ -2284,7 +2284,7 @@
</span><span class="cx">
</span><span class="cx"> #if ENABLE(POINTER_LOCK)
</span><span class="cx"> if (page())
</span><del>- page()->pointerLockController().documentDetached(this);
</del><ins>+ page()->pointerLockController().documentDetached(*this);
</ins><span class="cx"> #endif
</span><span class="cx">
</span><span class="cx"> InspectorInstrumentation::documentDetached(*this);
</span></span></pre></div>
<a id="trunkSourceWebCoredomElementcpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/dom/Element.cpp (209393 => 209394)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/dom/Element.cpp 2016-12-06 15:55:07 UTC (rev 209393)
+++ trunk/Source/WebCore/dom/Element.cpp 2016-12-06 16:40:56 UTC (rev 209394)
</span><span class="lines">@@ -1670,7 +1670,7 @@
</span><span class="cx"> #endif
</span><span class="cx"> #if ENABLE(POINTER_LOCK)
</span><span class="cx"> if (document().page())
</span><del>- document().page()->pointerLockController().elementRemoved(this);
</del><ins>+ document().page()->pointerLockController().elementRemoved(*this);
</ins><span class="cx"> #endif
</span><span class="cx">
</span><span class="cx"> setSavedLayerScrollPosition(ScrollPosition());
</span></span></pre></div>
<a id="trunkSourceWebCorepageEventHandlercpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/page/EventHandler.cpp (209393 => 209394)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/page/EventHandler.cpp 2016-12-06 15:55:07 UTC (rev 209393)
+++ trunk/Source/WebCore/page/EventHandler.cpp 2016-12-06 16:40:56 UTC (rev 209394)
</span><span class="lines">@@ -3064,7 +3064,7 @@
</span><span class="cx">
</span><span class="cx"> #if ENABLE(POINTER_LOCK)
</span><span class="cx"> if (initialKeyEvent.type() == PlatformEvent::KeyDown && initialKeyEvent.windowsVirtualKeyCode() == VK_ESCAPE && m_frame.page()->pointerLockController().element()) {
</span><del>- m_frame.page()->pointerLockController().requestPointerUnlock();
</del><ins>+ m_frame.page()->pointerLockController().requestPointerUnlockAndForceCursorVisible();
</ins><span class="cx"> return true;
</span><span class="cx"> }
</span><span class="cx"> #endif
</span></span></pre></div>
<a id="trunkSourceWebCorepagePointerLockControllercpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/page/PointerLockController.cpp (209393 => 209394)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/page/PointerLockController.cpp 2016-12-06 15:55:07 UTC (rev 209393)
+++ trunk/Source/WebCore/page/PointerLockController.cpp 2016-12-06 16:40:56 UTC (rev 209394)
</span><span class="lines">@@ -99,9 +99,18 @@
</span><span class="cx"> m_page.chrome().client().requestPointerUnlock();
</span><span class="cx"> }
</span><span class="cx">
</span><del>-void PointerLockController::elementRemoved(Element* element)
</del><ins>+void PointerLockController::requestPointerUnlockAndForceCursorVisible()
</ins><span class="cx"> {
</span><del>- if (m_element == element) {
</del><ins>+ if (!m_element || !RuntimeEnabledFeatures::sharedFeatures().pointerLockEnabled())
+ return;
+
+ m_page.chrome().client().requestPointerUnlock();
+ m_forceCursorVisibleUponUnlock = true;
+}
+
+void PointerLockController::elementRemoved(Element& element)
+{
+ if (m_element == &element) {
</ins><span class="cx"> m_documentOfRemovedElementWhileWaitingForUnlock = &m_element->document();
</span><span class="cx"> // Set element null immediately to block any future interaction with it
</span><span class="cx"> // including mouse events received before the unlock completes.
</span><span class="lines">@@ -110,11 +119,11 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><del>-void PointerLockController::documentDetached(Document* document)
</del><ins>+void PointerLockController::documentDetached(Document& document)
</ins><span class="cx"> {
</span><del>- if (m_element && &m_element->document() == document) {
</del><ins>+ if (m_element && &m_element->document() == &document) {
</ins><span class="cx"> clearElement();
</span><del>- requestPointerUnlock();
</del><ins>+ requestPointerUnlockAndForceCursorVisible();
</ins><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -145,6 +154,8 @@
</span><span class="cx"> enqueueEvent(eventNames().pointerlockchangeEvent, m_element ? &m_element->document() : m_documentOfRemovedElementWhileWaitingForUnlock.get());
</span><span class="cx"> clearElement();
</span><span class="cx"> m_documentOfRemovedElementWhileWaitingForUnlock = nullptr;
</span><ins>+ if (m_forceCursorVisibleUponUnlock)
+ m_page.chrome().client().setCursorHiddenUntilMouseMoves(false);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> void PointerLockController::dispatchLockedMouseEvent(const PlatformMouseEvent& event, const AtomicString& eventType)
</span></span></pre></div>
<a id="trunkSourceWebCorepagePointerLockControllerh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/page/PointerLockController.h (209393 => 209394)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/page/PointerLockController.h 2016-12-06 15:55:07 UTC (rev 209393)
+++ trunk/Source/WebCore/page/PointerLockController.h 2016-12-06 16:40:56 UTC (rev 209394)
</span><span class="lines">@@ -43,9 +43,11 @@
</span><span class="cx"> public:
</span><span class="cx"> explicit PointerLockController(Page&);
</span><span class="cx"> void requestPointerLock(Element* target);
</span><ins>+
</ins><span class="cx"> void requestPointerUnlock();
</span><del>- void elementRemoved(Element*);
- void documentDetached(Document*);
</del><ins>+ void requestPointerUnlockAndForceCursorVisible();
+ void elementRemoved(Element&);
+ void documentDetached(Document&);
</ins><span class="cx"> bool lockPending() const;
</span><span class="cx"> Element* element() const;
</span><span class="cx">
</span><span class="lines">@@ -60,6 +62,7 @@
</span><span class="cx"> void enqueueEvent(const AtomicString& type, Document*);
</span><span class="cx"> Page& m_page;
</span><span class="cx"> bool m_lockPending;
</span><ins>+ bool m_forceCursorVisibleUponUnlock { false };
</ins><span class="cx"> RefPtr<Element> m_element;
</span><span class="cx"> RefPtr<Document> m_documentOfRemovedElementWhileWaitingForUnlock;
</span><span class="cx"> };
</span></span></pre>
</div>
</div>
</body>
</html>