mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-12-01 08:42:13 +00:00
e34761f02e
Both the deprecated `Screen.lockOrientation` and replacement `ScreenOrientation.lock` APIs have been updated to make use of a new `OrientationLock` field on the `BrowsingContext`. This replaces the storage and use of APIs for this on the root docshell. In the non fission case things should behave the same, as pending promises for previous calls to `Screen.lockOrientation` will still be cancelled in process. If there are `BrowsingContext`s in other processes though, IPC will be sent to the parent, and then each other child to cancel them. This should be spec compliant as the spec is already racy with regards to multiple `lockOrientation` calls. This new implementation has a little extra IPC than the optimal implementation would since the root `BrowsingContext`s `OrientationLock` is set using the normal `SyncedContext` machinery, rather than combining the `AbortOtherOrientationPendingPromises` message for a single message. This commit fixes both Bug 1597413 and Bug 1597443. Differential Revision: https://phabricator.services.mozilla.com/D70416
111 lines
3.8 KiB
C++
111 lines
3.8 KiB
C++
/* -*- 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"
|
|
|
|
class nsScreen;
|
|
|
|
namespace mozilla {
|
|
namespace dom {
|
|
|
|
class Promise;
|
|
|
|
class ScreenOrientation final
|
|
: public DOMEventTargetHelper,
|
|
public mozilla::hal::ScreenConfigurationObserver {
|
|
// 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)
|
|
|
|
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;
|
|
|
|
virtual JSObject* WrapObject(JSContext* aCx,
|
|
JS::Handle<JSObject*> aGivenProto) override;
|
|
|
|
void Notify(const mozilla::hal::ScreenConfiguration& aConfiguration) 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.
|
|
bool LockDeviceOrientation(hal::ScreenOrientation aOrientation,
|
|
bool aIsFullscreen, ErrorResult& aRv);
|
|
|
|
// This method calls in to the HAL to unlock the device and removes
|
|
// full screen change listener.
|
|
void UnlockDeviceOrientation();
|
|
|
|
// 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();
|
|
|
|
bool ShouldResistFingerprinting() const;
|
|
|
|
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;
|
|
};
|
|
|
|
} // namespace dom
|
|
} // namespace mozilla
|
|
|
|
#endif // mozilla_dom_ScreenOrientation_h
|