summaryrefslogtreecommitdiffstats
path: root/dom/base/PointerLockManager.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /dom/base/PointerLockManager.h
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--dom/base/PointerLockManager.h82
1 files changed, 82 insertions, 0 deletions
diff --git a/dom/base/PointerLockManager.h b/dom/base/PointerLockManager.h
new file mode 100644
index 0000000000..0b229bd429
--- /dev/null
+++ b/dom/base/PointerLockManager.h
@@ -0,0 +1,82 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef mozilla_PointerLockManager_h
+#define mozilla_PointerLockManager_h
+
+#include "mozilla/AlreadyAddRefed.h"
+#include "nsIWeakReferenceUtils.h"
+#include "nsThreadUtils.h"
+
+namespace mozilla {
+enum class StyleCursorKind : uint8_t;
+
+namespace dom {
+class BrowsingContext;
+class BrowserParent;
+enum class CallerType : uint32_t;
+class Document;
+class Element;
+} // namespace dom
+
+class PointerLockManager final {
+ public:
+ static void RequestLock(dom::Element* aElement, dom::CallerType aCallerType);
+
+ MOZ_CAN_RUN_SCRIPT_BOUNDARY
+ static void Unlock(dom::Document* aDoc = nullptr);
+
+ static bool IsLocked() { return sIsLocked; }
+
+ static already_AddRefed<dom::Element> GetLockedElement();
+
+ static already_AddRefed<dom::Document> GetLockedDocument();
+
+ static dom::BrowserParent* GetLockedRemoteTarget();
+
+ /**
+ * Returns true if aContext and the current pointer locked document
+ * have common top BrowsingContext.
+ * Note that this method returns true only if caller is in the same process
+ * as pointer locked document.
+ */
+ static bool IsInLockContext(mozilla::dom::BrowsingContext* aContext);
+
+ // Set/release pointer lock remote target. Should only be called in parent
+ // process.
+ static bool SetLockedRemoteTarget(dom::BrowserParent* aBrowserParent);
+ static void ReleaseLockedRemoteTarget(dom::BrowserParent* aBrowserParent);
+
+ private:
+ class PointerLockRequest final : public Runnable {
+ public:
+ PointerLockRequest(dom::Element* aElement, bool aUserInputOrChromeCaller);
+ MOZ_CAN_RUN_SCRIPT_BOUNDARY NS_IMETHOD Run() final;
+
+ private:
+ nsWeakPtr mElement;
+ nsWeakPtr mDocument;
+ bool mUserInputOrChromeCaller;
+ };
+
+ static void ChangePointerLockedElement(dom::Element* aElement,
+ dom::Document* aDocument,
+ dom::Element* aPointerLockedElement);
+
+ MOZ_CAN_RUN_SCRIPT_BOUNDARY
+ static bool StartSetPointerLock(dom::Element* aElement,
+ dom::Document* aDocument);
+
+ MOZ_CAN_RUN_SCRIPT
+ static bool SetPointerLock(dom::Element* aElement, dom::Document* aDocument,
+ StyleCursorKind);
+
+ static bool sIsLocked;
+};
+
+} // namespace mozilla
+
+#endif // mozilla_PointerLockManager_h