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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
/* -*- 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_timeout_handler_h
#define mozilla_dom_timeout_handler_h
#include "js/Promise.h" // JS::Dispatchable
#include "mozilla/Attributes.h"
#include "mozilla/HoldDropJSObjects.h"
#include "mozilla/SourceLocation.h"
#include "mozilla/dom/FunctionBinding.h"
#include "nsCOMPtr.h"
#include "nsCycleCollectionParticipant.h"
#include "nsIGlobalObject.h"
#include "nsISupports.h"
#include "nsString.h"
namespace mozilla::dom {
/**
* Utility class for implementing nsITimeoutHandlers, designed to be subclassed.
*/
class TimeoutHandler : public nsISupports, public JSHolderBase {
public:
MOZ_CAN_RUN_SCRIPT virtual bool Call(const char* /* unused */);
// Append a UTF-8 string to aOutString that describes the callback function,
// for use in logging or profiler markers.
// The string contains the function name and its source location, if
// available, in the following format:
// "<functionName> (<sourceURL>:<lineNumber>:<columnNumber>)"
virtual void GetDescription(nsACString& aOutString);
virtual void MarkForCC() {}
protected:
TimeoutHandler() = default;
explicit TimeoutHandler(JSContext* aCx)
: mCaller(JSCallingLocation::Get(aCx)) {}
virtual ~TimeoutHandler() = default;
// filename, line number and JS language version string of the
// caller of setTimeout()
const JSCallingLocation mCaller = {};
private:
TimeoutHandler(const TimeoutHandler&) = delete;
TimeoutHandler& operator=(const TimeoutHandler&) = delete;
TimeoutHandler& operator=(const TimeoutHandler&&) = delete;
};
class ScriptTimeoutHandler : public TimeoutHandler {
public:
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_CLASS(ScriptTimeoutHandler)
ScriptTimeoutHandler(JSContext* aCx, nsIGlobalObject* aGlobal,
const nsAString& aExpression);
MOZ_CAN_RUN_SCRIPT virtual bool Call(const char* /* unused */) override {
return false;
};
virtual void GetDescription(nsACString& aOutString) override;
protected:
virtual ~ScriptTimeoutHandler() = default;
nsCOMPtr<nsIGlobalObject> mGlobal;
// The expression to evaluate or function to call. If mFunction is non-null
// it should be used, else use mExpr.
nsString mExpr;
};
class CallbackTimeoutHandler final : public TimeoutHandler {
public:
NS_DECL_CYCLE_COLLECTING_ISUPPORTS_FINAL
NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(CallbackTimeoutHandler)
CallbackTimeoutHandler(JSContext* aCx, nsIGlobalObject* aGlobal,
Function* aFunction,
nsTArray<JS::Heap<JS::Value>>&& aArguments);
MOZ_CAN_RUN_SCRIPT virtual bool Call(const char* aExecutionReason) override;
virtual void MarkForCC() override;
virtual void GetDescription(nsACString& aOutString) override;
void ReleaseJSObjects();
private:
virtual ~CallbackTimeoutHandler() { ReleaseJSObjects(); }
nsCOMPtr<nsIGlobalObject> mGlobal;
RefPtr<Function> mFunction;
nsTArray<JS::Heap<JS::Value>> mArgs;
};
class DelayedJSDispatchableHandler final : public TimeoutHandler {
public:
DelayedJSDispatchableHandler(JSContext* aCx,
js::UniquePtr<JS::Dispatchable>&& aDispatchable)
: TimeoutHandler(aCx), mDispatchable(std::move(aDispatchable)) {}
NS_DECL_ISUPPORTS
MOZ_CAN_RUN_SCRIPT bool Call(const char* /* unused */) override;
private:
~DelayedJSDispatchableHandler() override;
js::UniquePtr<JS::Dispatchable> mDispatchable;
};
} // namespace mozilla::dom
#endif // mozilla_dom_timeout_handler_h
|
