mirror of
https://github.com/mozilla/gecko-dev.git
synced 2025-11-03 09:48:38 +02:00
18923e93aa
`orientation.unlock()` has to process the common safety checks [*1], then it throws an exception by common safety checks. But since old spec doesn't throw an exception, we don't throw it by `unlock()` now. So we should throw it even if calling unlock(). `lock-sandboxed-iframe.html` has a bug that it doesn't consider whether unlock throws an exception. So we have to fix it to implement the common safety check for unlock(). On macOS's native fullscreen implementation, fullscreen transition is asynchronous, so even if the promise of `requestFullscreen` is resolved, the window isn't still activated yet, visibility state may be still hidden. (This will be visible state soon). So I would like to disable native fullscreen on screen-orientation tests for this situation. *1 https://w3c.github.io/screen-orientation/#unlock-method Differential Revision: https://phabricator.services.mozilla.com/D241820
122 lines
4.5 KiB
C++
122 lines
4.5 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"
|
|
#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);
|
|
|
|
// Dispatch change event then resolve the promise.
|
|
// aBrowsingContext must be top level in process.
|
|
static void DispatchChangeEventToChildren(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();
|
|
|
|
// The common safety checks
|
|
static bool CommonSafetyChecks(nsPIDOMWindowInner* aOwner,
|
|
Document* aDocument, ErrorResult& aRv);
|
|
|
|
static LockPermission GetLockOrientationPermission(nsPIDOMWindowInner* aOwner,
|
|
Document* aDocument);
|
|
|
|
// 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
|