forked from jupyterlab/jupyterlab
-
Notifications
You must be signed in to change notification settings - Fork 0
/
panel.ts
309 lines (261 loc) · 6.45 KB
/
panel.ts
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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
import {
ClientSession, IClientSession
} from '@jupyterlab/apputils';
import {
IEditorMimeTypeService
} from '@jupyterlab/codeeditor';
import {
PathExt, Time, uuid
} from '@jupyterlab/coreutils';
import {
RenderMimeRegistry
} from '@jupyterlab/rendermime';
import {
ServiceManager
} from '@jupyterlab/services';
import {
Token
} from '@phosphor/coreutils';
import {
Message
} from '@phosphor/messaging';
import {
Panel
} from '@phosphor/widgets';
import {
CodeConsole
} from './widget';
/**
* The class name added to console panels.
*/
const PANEL_CLASS = 'jp-ConsolePanel';
const CONSOLE_ICON_CLASS = 'jp-CodeConsoleIcon';
/**
* A panel which contains a console and the ability to add other children.
*/
export
class ConsolePanel extends Panel {
/**
* Construct a console panel.
*/
constructor(options: ConsolePanel.IOptions) {
super();
this.addClass(PANEL_CLASS);
let {
rendermime, mimeTypeService, path, basePath, name, manager, modelFactory
} = options;
let contentFactory = this.contentFactory = (
options.contentFactory || ConsolePanel.defaultContentFactory
);
let count = Private.count++;
if (!path) {
path = `${basePath || ''}/console-${count}-${uuid()}`;
}
let session = this._session = new ClientSession({
manager: manager.sessions,
path,
name: name || `Console ${count}`,
type: 'console',
kernelPreference: options.kernelPreference
});
let resolver = new RenderMimeRegistry.UrlResolver({
session,
contents: manager.contents
});
rendermime = rendermime.clone({ resolver });
this.console = contentFactory.createConsole({
rendermime, session, mimeTypeService, contentFactory, modelFactory
});
this.addWidget(this.console);
session.initialize().then(() => {
this._connected = new Date();
this._updateTitle();
});
this.console.executed.connect(this._onExecuted, this);
this._updateTitle();
session.kernelChanged.connect(this._updateTitle, this);
session.propertyChanged.connect(this._updateTitle, this);
this.title.icon = CONSOLE_ICON_CLASS;
this.title.closable = true;
this.id = `console-${count}`;
}
/**
* The content factory used by the console panel.
*/
readonly contentFactory: ConsolePanel.IContentFactory;
/**
* The console widget used by the panel.
*/
readonly console: CodeConsole;
/**
* The session used by the panel.
*/
get session(): IClientSession {
return this._session;
}
/**
* Dispose of the resources held by the widget.
*/
dispose(): void {
this.session.dispose();
this.console.dispose();
super.dispose();
}
/**
* Handle `'activate-request'` messages.
*/
protected onActivateRequest(msg: Message): void {
let prompt = this.console.promptCell;
if (prompt) {
prompt.editor.focus();
}
}
/**
* Handle `'close-request'` messages.
*/
protected onCloseRequest(msg: Message): void {
super.onCloseRequest(msg);
this.dispose();
}
/**
* Handle a console execution.
*/
private _onExecuted(sender: CodeConsole, args: Date) {
this._executed = args;
this._updateTitle();
}
/**
* Update the console panel title.
*/
private _updateTitle(): void {
Private.updateTitle(this, this._connected, this._executed);
}
private _executed: Date | null = null;
private _connected: Date | null = null;
private _session: ClientSession;
}
/**
* A namespace for ConsolePanel statics.
*/
export
namespace ConsolePanel {
/**
* The initialization options for a console panel.
*/
export
interface IOptions {
/**
* The rendermime instance used by the panel.
*/
rendermime: RenderMimeRegistry;
/**
* The content factory for the panel.
*/
contentFactory: IContentFactory;
/**
* The service manager used by the panel.
*/
manager: ServiceManager.IManager;
/**
* The path of an existing console.
*/
path?: string;
/**
* The base path for a new console.
*/
basePath?: string;
/**
* The name of the console.
*/
name?: string;
/**
* A kernel preference.
*/
kernelPreference?: IClientSession.IKernelPreference;
/**
* The model factory for the console widget.
*/
modelFactory?: CodeConsole.IModelFactory;
/**
* The service used to look up mime types.
*/
mimeTypeService: IEditorMimeTypeService;
}
/**
* The console panel renderer.
*/
export
interface IContentFactory extends CodeConsole.IContentFactory {
/**
* Create a new console panel.
*/
createConsole(options: CodeConsole.IOptions): CodeConsole;
}
/**
* Default implementation of `IContentFactory`.
*/
export
class ContentFactory extends CodeConsole.ContentFactory implements IContentFactory {
/**
* Create a new console panel.
*/
createConsole(options: CodeConsole.IOptions): CodeConsole {
return new CodeConsole(options);
}
}
/**
* A namespace for the console panel content factory.
*/
export
namespace ContentFactory {
/**
* Options for the code console content factory.
*/
export
interface IOptions extends CodeConsole.ContentFactory.IOptions { }
}
/**
* A default code console content factory.
*/
export
const defaultContentFactory: IContentFactory = new ContentFactory();
/* tslint:disable */
/**
* The console renderer token.
*/
export
const IContentFactory = new Token<IContentFactory>('@jupyterlab/console:IContentFactory');
/* tslint:enable */
}
/**
* A namespace for private data.
*/
namespace Private {
/**
* The counter for new consoles.
*/
export
let count = 1;
/**
* Update the title of a console panel.
*/
export
function updateTitle(panel: ConsolePanel, connected: Date | null, executed: Date | null) {
let session = panel.console.session;
let caption = (
`Name: ${session.name}\n` +
`Directory: ${PathExt.dirname(session.path)}\n` +
`Kernel: ${session.kernelDisplayName}`
);
if (connected) {
caption += `\nConnected: ${Time.format(connected.toISOString())}`;
}
if (executed) {
caption += `\nLast Execution: ${Time.format(executed.toISOString())}`;
}
panel.title.label = session.name || 'Console';
panel.title.caption = caption;
}
}