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#ifndef PointerLockController_h
26#define PointerLockController_h
27
28#include "platform/heap/Handle.h"
29#include "wtf/RefPtr.h"
30#include "wtf/text/AtomicString.h"
31
32namespace blink {
33
34class Element;
35class Document;
36class Page;
37class PlatformMouseEvent;
38
39class PointerLockController FINAL : public NoBaseWillBeGarbageCollected<PointerLockController> {
40    WTF_MAKE_NONCOPYABLE(PointerLockController);
41    WTF_MAKE_FAST_ALLOCATED_WILL_BE_REMOVED;
42public:
43    static PassOwnPtrWillBeRawPtr<PointerLockController> create(Page*);
44
45    void requestPointerLock(Element* target);
46    void requestPointerUnlock();
47    void elementRemoved(Element*);
48    void documentDetached(Document*);
49    bool lockPending() const;
50    Element* element() const;
51
52    void didAcquirePointerLock();
53    void didNotAcquirePointerLock();
54    void didLosePointerLock();
55    void dispatchLockedMouseEvent(const PlatformMouseEvent&, const AtomicString& eventType);
56
57    void trace(Visitor*);
58
59private:
60    explicit PointerLockController(Page*);
61    void clearElement();
62    void enqueueEvent(const AtomicString& type, Element*);
63    void enqueueEvent(const AtomicString& type, Document*);
64
65    RawPtrWillBeMember<Page> m_page;
66    bool m_lockPending;
67    RefPtrWillBeMember<Element> m_element;
68    RefPtrWillBeMember<Document> m_documentOfRemovedElementWhileWaitingForUnlock;
69};
70
71} // namespace blink
72
73#endif // PointerLockController_h
74