1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et cindent: */
/* 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 DOM_WAKELOCKJS_H_
#define DOM_WAKELOCKJS_H_
#include "js/TypeDecls.h"
#include "mozilla/Attributes.h"
#include "mozilla/HalBatteryInformation.h"
#include "mozilla/dom/WakeLockBinding.h"
#include "nsIDOMEventListener.h"
#include "nsIDocumentActivity.h"
#include "nsIObserver.h"
#include "nsCycleCollectionParticipant.h"
#include "nsWeakReference.h"
#include "nsWrapperCache.h"
class nsPIDOMWindowInner;
namespace mozilla::dom {
class Promise;
class Document;
class WakeLockSentinel;
} // namespace mozilla::dom
namespace mozilla::dom {
/**
* Management class for wake locks held from client scripts.
* Instances of this class have two purposes:
* - Implement navigator.wakeLock.request which creates a WakeLockSentinel
* - Listen for state changes that require all WakeLockSentinel to be released
* The WakeLockSentinel objects are held in document.mActiveLocks.
*
* https://www.w3.org/TR/screen-wake-lock/#the-wakelock-interface
*/
class WakeLockJS final : public nsIObserver,
public nsWrapperCache,
public hal::BatteryObserver,
public nsSupportsWeakReference {
public:
NS_DECL_NSIOBSERVER
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS_AMBIGUOUS(WakeLockJS, nsIObserver)
public:
explicit WakeLockJS(nsPIDOMWindowInner* aWindow);
protected:
~WakeLockJS();
public:
nsISupports* GetParentObject() const;
JSObject* WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) override;
void Notify(const hal::BatteryInformation& aBatteryInfo) override;
already_AddRefed<Promise> Request(WakeLockType aType, ErrorResult& aRv);
private:
enum class RequestError {
Success,
DocInactive,
DocHidden,
PolicyDisallowed,
PrefDisabled,
InternalFailure,
PermissionDenied
};
static nsLiteralCString GetRequestErrorMessage(RequestError aRv);
static RequestError WakeLockAllowedForDocument(Document* aDoc);
void AttachListeners();
void DetachListeners();
Result<already_AddRefed<WakeLockSentinel>, RequestError> Obtain(
WakeLockType aType, Document* aDoc);
RefPtr<nsPIDOMWindowInner> mWindow;
};
MOZ_CAN_RUN_SCRIPT
void ReleaseWakeLock(Document* aDoc, WakeLockSentinel* aLock,
WakeLockType aType);
} // namespace mozilla::dom
#endif // DOM_WAKELOCKJS_H_
|
