Pointer Lock: Implement pointer interface
https://bugs.webkit.org/show_bug.cgi?id=75762
Source/WebCore:
Reviewed by Julien Chaffraix.
Implement the navigator.pointer interface via a new
PointerLockController class, as per
http://dvcs.w3.org/hg/webevents/raw-file/default/mouse-lock.html.
The implementation is being made in steps, the feature is still behind
compile-time and run-time flags, 'webkit' prefixed, and not yet enabled
in any browser. (Chromium has a developer flag required.) Follow-up
work will include handling DOM elements being removed, making all
callbacks asynchronous, iframe permissions (similar to Full Screen),
etc.
PointerLockController maintains state of which Element is the current
lock target and the success and failure callbacks. ChromeClient has
methods added to expose the required state change requests.
Tests: pointer-lock/lock-already-locked.html
pointer-lock/lock-fail-responses.html
pointer-lock/mouse-event-delivery.html
pointer-lock/pointerlocklost-event.html
* WebCore.gypi:
* dom/EventNames.h:
* page/ChromeClient.h:
(WebCore::ChromeClient::requestPointerLock):
(WebCore::ChromeClient::requestPointerUnlock):
(WebCore::ChromeClient::isPointerLocked):
* page/Navigator.cpp:
(WebCore::Navigator::webkitPointer):
* page/Page.cpp:
(WebCore::Page::Page):
* page/Page.h:
(WebCore::Page::pointerLockController):
* page/PointerLock.cpp:
(WebCore::PointerLock::PointerLock):
(WebCore::PointerLock::create):
(WebCore::PointerLock::lock):
(WebCore::PointerLock::unlock):
(WebCore::PointerLock::isLocked):
* page/PointerLock.h:
(WebCore::PointerLock::create):
* page/PointerLockController.cpp: Added.
(WebCore::PointerLockController::PointerLockController):
(WebCore::PointerLockController::requestPointerLock):
(WebCore::PointerLockController::requestPointerUnlock):
(WebCore::PointerLockController::isLocked):
(WebCore::PointerLockController::didAcquirePointerLock):
(WebCore::PointerLockController::didNotAcquirePointerLock):
(WebCore::PointerLockController::didLosePointerLock):
(WebCore::PointerLockController::dispatchLockedMouseEvent):
* page/PointerLockController.h: Copied from Source/WebCore/page/PointerLock.h.
Source/WebKit/chromium:
Add calls to the PointerLockController added in this patch to WebCore.
* src/WebViewImpl.cpp:
(WebKit::WebViewImpl::close):
(WebKit::WebViewImpl::didAcquirePointerLock):
(WebKit::WebViewImpl::didNotAcquirePointerLock):
(WebKit::WebViewImpl::didLosePointerLock):
(WebKit::WebViewImpl::pointerLockMouseEvent):
LayoutTests:
Reviewed by Julien Chaffraix.
* pointer-lock/lock-already-locked-expected.txt: Added.
* pointer-lock/lock-already-locked.html: Added.
* pointer-lock/lock-fail-responses-expected.txt: Added.
* pointer-lock/lock-fail-responses.html: Added.
* pointer-lock/mouse-event-delivery-expected.txt: Added.
* pointer-lock/mouse-event-delivery.html: Added.
* pointer-lock/pointerlocklost-event-expected.txt: Added.
* pointer-lock/pointerlocklost-event.html: Added.
git-svn-id: http://svn.webkit.org/repository/webkit/trunk@106134 268f45cc-cd09-0410-ab3c-d52691b4dbfc
diff --git a/Source/WebCore/page/PointerLockController.cpp b/Source/WebCore/page/PointerLockController.cpp
new file mode 100644
index 0000000..b8ad968
--- /dev/null
+++ b/Source/WebCore/page/PointerLockController.cpp
@@ -0,0 +1,126 @@
+/*
+ * Copyright (C) 2012 Google Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "config.h"
+#include "PointerLockController.h"
+
+#include "Chrome.h"
+#include "ChromeClient.h"
+#include "Element.h"
+#include "Page.h"
+#include "PlatformMouseEvent.h"
+#include "VoidCallback.h"
+
+#if ENABLE(POINTER_LOCK)
+
+namespace WebCore {
+
+PointerLockController::PointerLockController(Page* page)
+ : m_page(page)
+{
+}
+
+PassOwnPtr<PointerLockController> PointerLockController::create(Page* page)
+{
+ return adoptPtr(new PointerLockController(page));
+}
+
+void PointerLockController::requestPointerLock(Element* target, PassRefPtr<VoidCallback> successCallback, PassRefPtr<VoidCallback> failureCallback)
+{
+ if (isLocked()) {
+ if (m_element == target) {
+ if (successCallback)
+ successCallback->handleEvent();
+ } else {
+ didLosePointerLock();
+ m_element = target;
+ if (successCallback)
+ successCallback->handleEvent();
+ }
+ } else if (m_page->chrome()->client()->requestPointerLock()) {
+ m_element = target;
+ m_successCallback = successCallback;
+ m_failureCallback = failureCallback;
+ } else if (failureCallback)
+ failureCallback->handleEvent();
+}
+
+void PointerLockController::requestPointerUnlock()
+{
+ return m_page->chrome()->client()->requestPointerUnlock();
+}
+
+bool PointerLockController::isLocked()
+{
+ return m_page->chrome()->client()->isPointerLocked();
+}
+
+void PointerLockController::didAcquirePointerLock()
+{
+ RefPtr<Element> elementToNotify(m_element);
+ RefPtr<VoidCallback> callbackToIssue(m_successCallback);
+ m_successCallback = 0;
+ m_failureCallback = 0;
+
+ if (callbackToIssue && elementToNotify && elementToNotify->document()->frame())
+ callbackToIssue->handleEvent();
+}
+
+void PointerLockController::didNotAcquirePointerLock()
+{
+ RefPtr<Element> elementToNotify(m_element);
+ RefPtr<VoidCallback> callbackToIssue(m_failureCallback);
+ m_element = 0;
+ m_successCallback = 0;
+ m_failureCallback = 0;
+
+ if (callbackToIssue && elementToNotify && elementToNotify->document()->frame())
+ callbackToIssue->handleEvent();
+}
+
+void PointerLockController::didLosePointerLock()
+{
+ RefPtr<Element> elementToNotify(m_element);
+ m_element = 0;
+ m_successCallback = 0;
+ m_failureCallback = 0;
+ if (elementToNotify && elementToNotify->document()->frame())
+ elementToNotify->dispatchEvent(Event::create(eventNames().webkitpointerlocklostEvent, true, false));
+}
+
+void PointerLockController::dispatchLockedMouseEvent(const PlatformMouseEvent& event, const AtomicString& eventType)
+{
+ if (!m_element || !m_element->document()->frame())
+ return;
+
+ m_element->dispatchMouseEvent(event, eventType, event.clickCount());
+
+ // Create click events
+ if (eventType == eventNames().mouseupEvent)
+ m_element->dispatchMouseEvent(event, eventNames().clickEvent, event.clickCount());
+}
+
+} // namespace WebCore
+
+#endif // ENABLE(POINTER_LOCK)
