Changeset 127606 in webkit

Timestamp:

Sep 5, 2012 10:31:32 AM (12 years ago)

Author:

scheib@chromium.org

Message:

webkitPointerLockElement returns null when pointer lock request is pending.
​https://bugs.webkit.org/show_bug.cgi?id=91186

Reviewed by Dimitri Glazkov.

Source/WebCore:

Script should wait for a pointerlockchange event before detecting
if it has acquired lock. However, if a script attempted to poll
pointerLockElement it could be confused when lock was still pending.
This change ensures that if lock is not yet acquired then
pointerLockElement will return null.

Test: pointer-lock/pointerlockelement-null-when-pending.html

• dom/Document.cpp:

(WebCore::Document::webkitPointerLockElement):

• page/PointerLockController.cpp:

(WebCore::PointerLockController::requestPointerLock):
(WebCore::PointerLockController::elementRemoved):
(WebCore::PointerLockController::documentDetached):
(WebCore::PointerLockController::lockPending):
(WebCore):
(WebCore::PointerLockController::didAcquirePointerLock):
(WebCore::PointerLockController::didNotAcquirePointerLock):
(WebCore::PointerLockController::didLosePointerLock):
(WebCore::PointerLockController::clearElement):

• page/PointerLockController.h:

(PointerLockController):

LayoutTests:

• pointer-lock/locked-element-iframe-removed-from-dom-expected.txt:
• pointer-lock/locked-element-iframe-removed-from-dom.html:

Updated to reflect new behavior of null returned when lock is pending.

• pointer-lock/pointerlockelement-null-when-pending-expected.txt: Added.
• pointer-lock/pointerlockelement-null-when-pending.html: Added.

New test specifically for testing null return when lock is pending.

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/pointer-lock/locked-element-iframe-removed-from-dom-expected.txt (modified) (1 diff)
• LayoutTests/pointer-lock/locked-element-iframe-removed-from-dom.html (modified) (1 diff)
• LayoutTests/pointer-lock/pointerlockelement-null-when-pending-expected.txt (added)
• LayoutTests/pointer-lock/pointerlockelement-null-when-pending.html (added)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/dom/Document.cpp (modified) (1 diff)
• Source/WebCore/page/PointerLockController.cpp (modified) (7 diffs)
• Source/WebCore/page/PointerLockController.h (modified) (2 diffs)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2012-09-05  Vincent Scheib  <scheib@chromium.org>
+
+        webkitPointerLockElement returns null when pointer lock request is pending.
+        https://bugs.webkit.org/show_bug.cgi?id=91186
+
+        Reviewed by Dimitri Glazkov.
+
+        * pointer-lock/locked-element-iframe-removed-from-dom-expected.txt:
+        * pointer-lock/locked-element-iframe-removed-from-dom.html:
+             Updated to reflect new behavior of null returned when lock is pending.
+        * pointer-lock/pointerlockelement-null-when-pending-expected.txt: Added.
+        * pointer-lock/pointerlockelement-null-when-pending.html: Added.
+             New test specifically for testing null return when lock is pending.
+
 2012-09-05  Christophe Dumez  <christophe.dumez@intel.com>
 

trunk/LayoutTests/pointer-lock/locked-element-iframe-removed-from-dom-expected.txt

@@ -11 +11 @@
      Remove iframe & immediately lock target2. (main document handler)
      Remove iframe & immediately lock target2. (iframe handler)
-PASS document.webkitPointerLockElement is targetDiv2
+PASS document.webkitPointerLockElement is null
 PASS onwebkitpointerlockchange received after: Remove iframe & immediately lock target2. (main document handler)
 PASS successfullyParsed is true

trunk/LayoutTests/pointer-lock/locked-element-iframe-removed-from-dom.html

@@ -39 +39 @@
             targetIframe1.parentElement.removeChild(targetIframe1);
             targetDiv2.webkitRequestPointerLock();
-            shouldBe("document.webkitPointerLockElement", "targetDiv2");
+            shouldBe("document.webkitPointerLockElement", "null");
             // doNextStep called by event handler.
         },

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2012-09-05  Vincent Scheib  <scheib@chromium.org>
+
+        webkitPointerLockElement returns null when pointer lock request is pending.
+        https://bugs.webkit.org/show_bug.cgi?id=91186
+
+        Reviewed by Dimitri Glazkov.
+
+        Script should wait for a pointerlockchange event before detecting
+        if it has acquired lock. However, if a script attempted to poll
+        pointerLockElement it could be confused when lock was still pending.
+        This change ensures that if lock is not yet acquired then
+        pointerLockElement will return null.
+
+        Test: pointer-lock/pointerlockelement-null-when-pending.html
+
+        * dom/Document.cpp:
+        (WebCore::Document::webkitPointerLockElement):
+        * page/PointerLockController.cpp:
+        (WebCore::PointerLockController::requestPointerLock):
+        (WebCore::PointerLockController::elementRemoved):
+        (WebCore::PointerLockController::documentDetached):
+        (WebCore::PointerLockController::lockPending):
+        (WebCore):
+        (WebCore::PointerLockController::didAcquirePointerLock):
+        (WebCore::PointerLockController::didNotAcquirePointerLock):
+        (WebCore::PointerLockController::didLosePointerLock):
+        (WebCore::PointerLockController::clearElement):
+        * page/PointerLockController.h:
+        (PointerLockController):
+
 2012-09-05  Sami Kyostila  <skyostil@chromium.org>
 

trunk/Source/WebCore/dom/Document.cpp

@@ -5873 +5873 @@
 Element* Document::webkitPointerLockElement() const
 {
-    if (!page())
+    if (!page() || page()->pointerLockController()->lockPending())
         return 0;
     if (Element* element = page()->pointerLockController()->element()) {

trunk/Source/WebCore/page/PointerLockController.cpp

@@ -63 +63 @@
         m_element = target;
     } else if (m_page->chrome()->client()->requestPointerLock()) {
+        m_lockPending = true;
         m_element = target;
     } else {
@@ -80 +81 @@
         // Set element null immediately to block any future interaction with it
         // including mouse events received before the unlock completes.
-        m_element = 0;
+        clearElement();
         requestPointerUnlock();
     }
@@ -88 +89 @@
 {
     if (m_element && m_element->document() == document) {
-        m_element = 0;
+        clearElement();
         requestPointerUnlock();
     }
+}
+
+bool PointerLockController::lockPending() const
+{
+    return m_lockPending;
 }
 
@@ -101 +107 @@
 {
     enqueueEvent(eventNames().webkitpointerlockchangeEvent, m_element.get());
+    m_lockPending = false;
 }
 
@@ -106 +113 @@
 {
     enqueueEvent(eventNames().webkitpointerlockerrorEvent, m_element.get());
-    m_element = 0;
+    clearElement();
 }
 
@@ -112 +119 @@
 {
     enqueueEvent(eventNames().webkitpointerlockchangeEvent, m_element ? m_element->document() : m_documentOfRemovedElementWhileWaitingForUnlock.get());
-    m_element = 0;
+    clearElement();
     m_documentOfRemovedElementWhileWaitingForUnlock = 0;
 }
@@ -126 +133 @@
     if (eventType == eventNames().mouseupEvent)
         m_element->dispatchMouseEvent(event, eventNames().clickEvent, event.clickCount());
+}
+
+void PointerLockController::clearElement()
+{
+    m_lockPending = false;
+    m_element = 0;
 }
 

trunk/Source/WebCore/page/PointerLockController.h

@@ -49 +49 @@
     void elementRemoved(Element*);
     void documentDetached(Document*);
+    bool lockPending() const;
     Element* element() const;
 
@@ -58 +59 @@
 private:
     explicit PointerLockController(Page*);
+    void clearElement();
     void enqueueEvent(const AtomicString& type, Element*);
     void enqueueEvent(const AtomicString& type, Document*);
     Page* m_page;
+    bool m_lockPending;
     RefPtr<Element> m_element;
     RefPtr<Document> m_documentOfRemovedElementWhileWaitingForUnlock;