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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
|
/* -*- Mode: IDL; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=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/.
*
* For more information on this interface, please see
* https://console.spec.whatwg.org/#console-namespace
*/
[Exposed=(Window,Worker,WorkerDebugger,Worklet),
ClassString="Console",
ProtoObjectHack]
namespace console {
// NOTE: if you touch this namespace, remember to update the ConsoleInstance
// interface as well!
// Logging
[UseCounter]
undefined assert(optional boolean condition = false, any... data);
[UseCounter]
undefined clear();
[UseCounter]
undefined count(optional DOMString label = "default");
[UseCounter]
undefined countReset(optional DOMString label = "default");
[UseCounter]
undefined debug(any... data);
[UseCounter]
undefined error(any... data);
[UseCounter]
undefined info(any... data);
[UseCounter]
undefined log(any... data);
[UseCounter]
undefined table(any... data); // FIXME: The spec is still unclear about this.
[UseCounter]
undefined trace(any... data);
[UseCounter]
undefined warn(any... data);
[UseCounter]
undefined dir(any... data); // FIXME: This doesn't follow the spec yet.
[UseCounter]
undefined dirxml(any... data);
// Grouping
[UseCounter]
undefined group(any... data);
[UseCounter]
undefined groupCollapsed(any... data);
[UseCounter]
undefined groupEnd();
// Timing
[UseCounter]
undefined time(optional DOMString label = "default");
[UseCounter]
undefined timeLog(optional DOMString label = "default", any... data);
[UseCounter]
undefined timeEnd(optional DOMString label = "default");
// Mozilla only or Webcompat methods
[UseCounter]
undefined _exception(any... data);
[UseCounter]
undefined timeStamp(optional any data);
[UseCounter]
undefined profile(any... data);
[UseCounter]
undefined profileEnd(any... data);
[ChromeOnly]
const boolean IS_NATIVE_CONSOLE = true;
[ChromeOnly, NewObject]
ConsoleInstance createInstance(optional ConsoleInstanceOptions options = {});
};
// This is used to propagate console events to the observers.
[GenerateConversionToJS]
dictionary ConsoleEvent {
(unsigned long long or DOMString) ID;
(unsigned long long or DOMString) innerID;
DOMString consoleID = "";
DOMString addonId = "";
DOMString level = "";
DOMString filename = "";
// Unique identifier within the process for the script source this event is
// associated with, or zero.
unsigned long sourceId = 0;
unsigned long lineNumber = 0;
unsigned long columnNumber = 0;
DOMString functionName = "";
double timeStamp = 0;
double microSecondTimeStamp = 0;
sequence<any> arguments;
sequence<DOMString?> styles;
boolean private = false;
// stacktrace is handled via a getter in some cases so we can construct it
// lazily. Note that we're not making this whole thing an interface because
// consumers expect to see own properties on it, which would mean making the
// props unforgeable, which means lots of JSFunction allocations. Maybe we
// should fix those consumers, of course....
// sequence<ConsoleStackEntry> stacktrace;
DOMString groupName = "";
any timer = null;
any counter = null;
DOMString prefix = "";
boolean chromeContext = false;
};
// Event for profile operations
[GenerateConversionToJS]
dictionary ConsoleProfileEvent {
DOMString action = "";
sequence<any> arguments;
boolean chromeContext = false;
};
// This dictionary is used to manage stack trace data.
[GenerateConversionToJS]
dictionary ConsoleStackEntry {
DOMString filename = "";
// Unique identifier within the process for the script source this entry is
// associated with, or zero.
unsigned long sourceId = 0;
unsigned long lineNumber = 0;
unsigned long columnNumber = 0;
DOMString functionName = "";
DOMString? asyncCause;
};
[GenerateConversionToJS]
dictionary ConsoleTimerStart {
DOMString name = "";
};
[GenerateConversionToJS]
dictionary ConsoleTimerLogOrEnd {
DOMString name = "";
double duration = 0;
};
[GenerateConversionToJS]
dictionary ConsoleTimerError {
DOMString error = "";
DOMString name = "";
};
[GenerateConversionToJS]
dictionary ConsoleCounter {
DOMString label = "";
unsigned long count = 0;
};
[GenerateConversionToJS]
dictionary ConsoleCounterError {
DOMString label = "";
DOMString error = "";
};
[ChromeOnly,
Exposed=(Window,Worker,WorkerDebugger,Worklet)]
// This is basically a copy of the console namespace.
interface ConsoleInstance {
// Logging
undefined assert(optional boolean condition = false, any... data);
undefined clear();
undefined count(optional DOMString label = "default");
undefined countReset(optional DOMString label = "default");
undefined debug(any... data);
undefined error(any... data);
undefined info(any... data);
undefined log(any... data);
undefined table(any... data); // FIXME: The spec is still unclear about this.
undefined trace(any... data);
undefined warn(any... data);
undefined dir(any... data); // FIXME: This doesn't follow the spec yet.
undefined dirxml(any... data);
// Grouping
undefined group(any... data);
undefined groupCollapsed(any... data);
undefined groupEnd();
// Timing
undefined time(optional DOMString label = "default");
undefined timeLog(optional DOMString label = "default", any... data);
undefined timeEnd(optional DOMString label = "default");
// Mozilla only or Webcompat methods
undefined _exception(any... data);
undefined timeStamp(optional any data);
undefined profile(any... data);
undefined profileEnd(any... data);
// Returns true if the given level would log a message. Used for avoiding
// long/significant processing when logging messages.
boolean shouldLog(ConsoleLogLevel level);
};
callback ConsoleInstanceDumpCallback = undefined (DOMString message);
enum ConsoleLogLevel {
"All", "Debug", "Log", "Info", "Clear", "Trace", "TimeLog", "TimeEnd", "Time",
"Group", "GroupEnd", "Profile", "ProfileEnd", "Dir", "Dirxml", "Warn", "Error",
"Off"
};
dictionary ConsoleInstanceOptions {
// An optional function to intercept all strings written to stdout.
ConsoleInstanceDumpCallback dump;
// An optional prefix string to be printed before the actual logged message.
DOMString prefix = "";
// An ID representing the source of the message. Normally the inner ID of a
// DOM window.
DOMString innerID = "";
// String identified for the console, this will be passed through the console
// notifications.
DOMString consoleID = "";
// Identifier that allows to filter which messages are logged based on their
// log level.
ConsoleLogLevel maxLogLevel;
// String pref name which contains the level to use for maxLogLevel. If the
// pref doesn't exist, gets removed or it is used in workers, the maxLogLevel
// will default to the value passed to this constructor (or "all" if it wasn't
// specified).
DOMString maxLogLevelPref = "";
};
enum ConsoleLevel { "log", "warning", "error" };
// this interface is just for testing
partial interface ConsoleInstance {
[ChromeOnly]
undefined reportForServiceWorkerScope(DOMString scope, DOMString message,
DOMString filename, unsigned long lineNumber,
unsigned long columnNumber,
ConsoleLevel level);
};
|
