forked from mirrors/gecko-dev
3493d2727e
From https://w3c.github.io/screen-orientation/#apply-an-orientation-lock > 7.2. Apply an orientation lock > > The steps to apply an orientation lock to a Document using orientation are as > follows: > > 1. If the user agent does not support locking the screen orientation, return > a promise rejected with a "NotSupportedError" DOMException and abort > these steps. So if orientation controller delegate isn't set, we should throw `NotSupportedError`. But, actually, we throws `AbortError`, so this isn't correct. To return any DOM error from platform implementation of `screen.orientation.lock`, I would like to change return value to `GenericPromise`'s. Differential Revision: https://phabricator.services.mozilla.com/D137970
117 lines
4.2 KiB
C++
117 lines
4.2 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 {
|
|
namespace 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();
|
|
|
|
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;
|
|
// 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 dom
|
|
} // namespace mozilla
|
|
|
|
#endif // mozilla_dom_ScreenOrientation_h
|