1/*
2 * Copyright (C) 2012 Google Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16 * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
17 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 */
24
25#pragma once
26
27#if ENABLE(POINTER_LOCK)
28
29#include <wtf/RefPtr.h>
30#include <wtf/WeakPtr.h>
31#include <wtf/text/AtomicString.h>
32
33namespace WebCore {
34
35class Element;
36class Document;
37class Page;
38class PlatformMouseEvent;
39class PlatformWheelEvent;
40class VoidCallback;
41
42class PointerLockController {
43 WTF_MAKE_NONCOPYABLE(PointerLockController);
44 WTF_MAKE_FAST_ALLOCATED;
45public:
46 explicit PointerLockController(Page&);
47 void requestPointerLock(Element* target);
48
49 void requestPointerUnlock();
50 void requestPointerUnlockAndForceCursorVisible();
51 void elementRemoved(Element&);
52 void documentDetached(Document&);
53 bool isLocked() const;
54 WEBCORE_EXPORT bool lockPending() const;
55 WEBCORE_EXPORT Element* element() const;
56
57 WEBCORE_EXPORT void didAcquirePointerLock();
58 WEBCORE_EXPORT void didNotAcquirePointerLock();
59 WEBCORE_EXPORT void didLosePointerLock();
60 void dispatchLockedMouseEvent(const PlatformMouseEvent&, const AtomicString& eventType);
61 void dispatchLockedWheelEvent(const PlatformWheelEvent&);
62
63private:
64 void clearElement();
65 void enqueueEvent(const AtomicString& type, Element*);
66 void enqueueEvent(const AtomicString& type, Document*);
67 Page& m_page;
68 bool m_lockPending { false };
69 bool m_unlockPending { false };
70 bool m_forceCursorVisibleUponUnlock { false };
71 RefPtr<Element> m_element;
72 WeakPtr<Document> m_documentOfRemovedElementWhileWaitingForUnlock;
73 WeakPtr<Document> m_documentAllowedToRelockWithoutUserGesture;
74};
75
76} // namespace WebCore
77
78#endif // ENABLE(POINTER_LOCK)
79