diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 19:33:14 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 19:33:14 +0000 |
commit | 36d22d82aa202bb199967e9512281e9a53db42c9 (patch) | |
tree | 105e8c98ddea1c1e4784a60a5a6410fa416be2de /dom/base/ScreenOrientation.h | |
parent | Initial commit. (diff) | |
download | firefox-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/ScreenOrientation.h | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/dom/base/ScreenOrientation.h b/dom/base/ScreenOrientation.h new file mode 100644 index 0000000000..0d52ae4907 --- /dev/null +++ b/dom/base/ScreenOrientation.h @@ -0,0 +1,113 @@ +/* -*- 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_dom_ScreenOrientation_h +#define mozilla_dom_ScreenOrientation_h + +#include "mozilla/DOMEventTargetHelper.h" +#include "mozilla/dom/BindingDeclarations.h" +#include "mozilla/dom/ScreenOrientationBinding.h" +#include "mozilla/HalScreenConfiguration.h" +#include "mozilla/MozPromise.h" + +class nsScreen; + +namespace mozilla::dom { + +class Promise; + +class ScreenOrientation final : public DOMEventTargetHelper { + // nsScreen has deprecated API that shares implementation. + friend class ::nsScreen; + + public: + NS_DECL_ISUPPORTS_INHERITED + NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(ScreenOrientation, + mozilla::DOMEventTargetHelper) + + IMPL_EVENT_HANDLER(change) + + // Called when the orientation may have changed. + void MaybeChanged(); + + ScreenOrientation(nsPIDOMWindowInner* aWindow, nsScreen* aScreen); + + already_AddRefed<Promise> Lock(OrientationLockType aOrientation, + ErrorResult& aRv); + + void Unlock(ErrorResult& aRv); + + // DeviceType and DeviceAngle gets the current type and angle of the device. + OrientationType DeviceType(CallerType aCallerType) const; + uint16_t DeviceAngle(CallerType aCallerType) const; + + // GetType and GetAngle gets the type and angle of the responsible document + // (as defined in specification). + OrientationType GetType(CallerType aCallerType, ErrorResult& aRv) const; + uint16_t GetAngle(CallerType aCallerType, ErrorResult& aRv) const; + + JSObject* WrapObject(JSContext* aCx, + JS::Handle<JSObject*> aGivenProto) override; + + static void UpdateActiveOrientationLock(hal::ScreenOrientation aOrientation); + static void AbortInProcessOrientationPromises( + BrowsingContext* aBrowsingContext); + + private: + virtual ~ScreenOrientation(); + + // Listener to unlock orientation if we leave fullscreen. + class FullscreenEventListener; + + // Listener to update document's orienation lock when document becomes + // visible. + class VisibleEventListener; + + // Task to run step to lock orientation as defined in specification. + class LockOrientationTask; + + enum LockPermission { LOCK_DENIED, FULLSCREEN_LOCK_ALLOWED, LOCK_ALLOWED }; + + // This method calls into the HAL to lock the device and sets + // up listeners for full screen change. + RefPtr<GenericNonExclusivePromise> LockDeviceOrientation( + hal::ScreenOrientation aOrientation, bool aIsFullscreen); + + // This method calls in to the HAL to unlock the device and removes + // full screen change listener. + void UnlockDeviceOrientation(); + void CleanupFullscreenListener(); + + // This method performs the same function as |Lock| except it takes + // a hal::ScreenOrientation argument instead of an OrientationType. + // This method exists in order to share implementation with nsScreen that + // uses ScreenOrientation. + already_AddRefed<Promise> LockInternal(hal::ScreenOrientation aOrientation, + ErrorResult& aRv); + + nsCOMPtr<nsIRunnable> DispatchChangeEventAndResolvePromise(); + + LockPermission GetLockOrientationPermission(bool aCheckSandbox) const; + + // Gets the responsible document as defined in the spec. + Document* GetResponsibleDocument() const; + + RefPtr<nsScreen> mScreen; + RefPtr<FullscreenEventListener> mFullscreenListener; + RefPtr<VisibleEventListener> mVisibleListener; + OrientationType mType; + uint16_t mAngle; + // Whether we've tried to call into hal to lock the device orientation. This + // is needed because you don't want calling UnlockDeviceOrientation() during + // shutdown to initialize PHal if it hasn't been initialized earlier. Also, + // makes sense (there's no reason destroying a ScreenOrientation object from a + // different window should remove the orientation lock). + bool mTriedToLockDeviceOrientation = false; +}; + +} // namespace mozilla::dom + +#endif // mozilla_dom_ScreenOrientation_h |