/
model.ts
489 lines (426 loc) · 12.5 KB
/
model.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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
import {
IIterator,
IterableOrArrayLike,
iter,
map,
toArray
} from '@lumino/algorithm';
import { JSONExt } from '@lumino/coreutils';
import { StringExt } from '@lumino/algorithm';
import { ISignal, Signal } from '@lumino/signaling';
import { Completer } from './widget';
/**
* An implementation of a completer model.
*/
export class CompleterModel implements Completer.IModel {
/**
* A signal emitted when state of the completer menu changes.
*/
get stateChanged(): ISignal<this, void> {
return this._stateChanged;
}
/**
* The original completion request details.
*/
get original(): Completer.ITextState | null {
return this._original;
}
set original(newValue: Completer.ITextState | null) {
let unchanged =
this._original === newValue ||
(this._original &&
newValue &&
JSONExt.deepEqual(newValue, this._original));
if (unchanged) {
return;
}
this._reset();
// Set both the current and original to the same value when original is set.
this._current = this._original = newValue;
this._stateChanged.emit(undefined);
}
/**
* The current text change details.
*/
get current(): Completer.ITextState | null {
return this._current;
}
set current(newValue: Completer.ITextState | null) {
const unchanged =
this._current === newValue ||
(this._current && newValue && JSONExt.deepEqual(newValue, this._current));
if (unchanged) {
return;
}
const original = this._original;
// Original request must always be set before a text change. If it isn't
// the model fails silently.
if (!original) {
return;
}
const cursor = this._cursor;
// Cursor must always be set before a text change. This happens
// automatically in the completer handler, but since `current` is a public
// attribute, this defensive check is necessary.
if (!cursor) {
return;
}
const current = (this._current = newValue);
if (!current) {
this._stateChanged.emit(undefined);
return;
}
const originalLine = original.text.split('\n')[original.line];
const currentLine = current.text.split('\n')[current.line];
// If the text change means that the original start point has been preceded,
// then the completion is no longer valid and should be reset.
if (!this._subsetMatch && currentLine.length < originalLine.length) {
this.reset(true);
return;
}
const { start, end } = this._cursor;
// Clip the front of the current line.
let query = current.text.substring(start);
// Clip the back of the current line by calculating the end of the original.
const ending = original.text.substring(end);
query = query.substring(0, query.lastIndexOf(ending));
this._query = query;
this._stateChanged.emit(undefined);
}
/**
* The cursor details that the API has used to return matching options.
*/
get cursor(): Completer.ICursorSpan | null {
return this._cursor;
}
set cursor(newValue: Completer.ICursorSpan | null) {
// Original request must always be set before a cursor change. If it isn't
// the model fails silently.
if (!this.original) {
return;
}
this._cursor = newValue;
}
/**
* The query against which items are filtered.
*/
get query(): string {
return this._query;
}
set query(newValue: string) {
this._query = newValue;
}
/**
* A flag that is true when the model value was modified by a subset match.
*/
get subsetMatch(): boolean {
return this._subsetMatch;
}
set subsetMatch(newValue: boolean) {
this._subsetMatch = newValue;
}
/**
* Get whether the model is disposed.
*/
get isDisposed(): boolean {
return this._isDisposed;
}
/**
* Dispose of the resources held by the model.
*/
dispose(): void {
// Do nothing if already disposed.
if (this._isDisposed) {
return;
}
this._isDisposed = true;
Signal.clearData(this);
}
/**
* The list of visible items in the completer menu.
*
* #### Notes
* This is a read-only property.
*/
items(): IIterator<Completer.IItem> {
return this._filter();
}
/**
* The unfiltered list of all available options in a completer menu.
*/
options(): IIterator<string> {
return iter(this._options);
}
/**
* The map from identifiers (a.b) to types (function, module, class, instance,
* etc.).
*
* #### Notes
* A type map is currently only provided by the latest IPython kernel using
* the completer reply metadata field `_jupyter_types_experimental`. The
* values are completely up to the kernel.
*
*/
typeMap(): Completer.TypeMap {
return this._typeMap;
}
/**
* An ordered list of all the known types in the typeMap.
*
* #### Notes
* To visually encode the types of the completer matches, we assemble an
* ordered list. This list begins with:
* ```
* ['function', 'instance', 'class', 'module', 'keyword']
* ```
* and then has any remaining types listed alphebetically. This will give
* reliable visual encoding for these known types, but allow kernels to
* provide new types.
*/
orderedTypes(): string[] {
return this._orderedTypes;
}
/**
* Set the available options in the completer menu.
*/
setOptions(
newValue: IterableOrArrayLike<string>,
typeMap?: Completer.TypeMap
) {
const values = toArray(newValue || []);
const types = typeMap || {};
if (
JSONExt.deepEqual(values, this._options) &&
JSONExt.deepEqual(types, this._typeMap)
) {
return;
}
if (values.length) {
this._options = values;
this._typeMap = types;
this._orderedTypes = Private.findOrderedTypes(types);
} else {
this._options = [];
this._typeMap = {};
this._orderedTypes = [];
}
this._stateChanged.emit(undefined);
}
/**
* Handle a cursor change.
*/
handleCursorChange(change: Completer.ITextState): void {
// If there is no active completion, return.
if (!this._original) {
return;
}
const { column, line } = change;
const { current, original } = this;
if (!original) {
return;
}
// If a cursor change results in a the cursor being on a different line
// than the original request, cancel.
if (line !== original.line) {
this.reset(true);
return;
}
// If a cursor change results in the cursor being set to a position that
// precedes the original column, cancel.
if (column < original.column) {
this.reset(true);
return;
}
const { cursor } = this;
if (!cursor || !current) {
return;
}
// If a cursor change results in the cursor being set to a position beyond
// the end of the area that would be affected by completion, cancel.
const cursorDelta = cursor.end - cursor.start;
const originalLine = original.text.split('\n')[original.line];
const currentLine = current.text.split('\n')[current.line];
const inputDelta = currentLine.length - originalLine.length;
if (column > original.column + cursorDelta + inputDelta) {
this.reset(true);
return;
}
}
/**
* Handle a text change.
*/
handleTextChange(change: Completer.ITextState): void {
const original = this._original;
// If there is no active completion, return.
if (!original) {
return;
}
const { text, column, line } = change;
const last = text.split('\n')[line][column - 1];
// If last character entered is not whitespace or if the change column is
// greater than or equal to the original column, update completion.
if ((last && last.match(/\S/)) || change.column >= original.column) {
this.current = change;
return;
}
// If final character is whitespace, reset completion.
this.reset(false);
}
/**
* Create a resolved patch between the original state and a patch string.
*
* @param patch - The patch string to apply to the original value.
*
* @returns A patched text change or undefined if original value did not exist.
*/
createPatch(patch: string): Completer.IPatch | undefined {
const original = this._original;
const cursor = this._cursor;
if (!original || !cursor) {
return undefined;
}
let { start, end } = cursor;
// Also include any filtering/additional-typing that has occurred
// since the completion request in the patched length.
end = end + (this.current.text.length - this.original.text.length);
return { start, end, value: patch };
}
/**
* Reset the state of the model and emit a state change signal.
*
* @param hard - Reset even if a subset match is in progress.
*/
reset(hard = false) {
// When the completer detects a common subset prefix for all options,
// it updates the model and sets the model source to that value, triggering
// a reset. Unless explicitly a hard reset, this should be ignored.
if (!hard && this._subsetMatch) {
return;
}
this._reset();
this._stateChanged.emit(undefined);
}
/**
* Apply the query to the complete options list to return the matching subset.
*/
private _filter(): IIterator<Completer.IItem> {
let options = this._options || [];
let query = this._query;
if (!query) {
return map(options, option => ({ raw: option, text: option }));
}
let results: Private.IMatch[] = [];
for (let option of options) {
let match = StringExt.matchSumOfSquares(option, query);
if (match) {
let marked = StringExt.highlight(option, match.indices, Private.mark);
results.push({
raw: option,
score: match.score,
text: marked.join('')
});
}
}
return map(results.sort(Private.scoreCmp), result => ({
text: result.text,
raw: result.raw
}));
}
/**
* Reset the state of the model.
*/
private _reset(): void {
this._current = null;
this._cursor = null;
this._options = [];
this._original = null;
this._query = '';
this._subsetMatch = false;
this._typeMap = {};
this._orderedTypes = [];
}
private _current: Completer.ITextState | null = null;
private _cursor: Completer.ICursorSpan | null = null;
private _isDisposed = false;
private _options: string[] = [];
private _original: Completer.ITextState | null = null;
private _query = '';
private _subsetMatch = false;
private _typeMap: Completer.TypeMap = {};
private _orderedTypes: string[] = [];
private _stateChanged = new Signal<this, void>(this);
}
/**
* A namespace for completer model private data.
*/
namespace Private {
/**
* The list of known type annotations of completer matches.
*/
const KNOWN_TYPES = ['function', 'instance', 'class', 'module', 'keyword'];
/**
* The map of known type annotations of completer matches.
*/
const KNOWN_MAP = KNOWN_TYPES.reduce((acc, type) => {
acc[type] = null;
return acc;
}, {} as Completer.TypeMap);
/**
* A filtered completion menu matching result.
*/
export interface IMatch {
/**
* The raw text of a completion match.
*/
raw: string;
/**
* A score which indicates the strength of the match.
*
* A lower score is better. Zero is the best possible score.
*/
score: number;
/**
* The highlighted text of a completion match.
*/
text: string;
}
/**
* Mark a highlighted chunk of text.
*/
export function mark(value: string): string {
return `<mark>${value}</mark>`;
}
/**
* A sort comparison function for item match scores.
*
* #### Notes
* This orders the items first based on score (lower is better), then
* by locale order of the item text.
*/
export function scoreCmp(a: IMatch, b: IMatch): number {
let delta = a.score - b.score;
if (delta !== 0) {
return delta;
}
return a.raw.localeCompare(b.raw);
}
/**
* Compute a reliably ordered list of types.
*
* #### Notes
* The resulting list always begins with the known types:
* ```
* ['function', 'instance', 'class', 'module', 'keyword']
* ```
* followed by other types in alphabetical order.
*/
export function findOrderedTypes(typeMap: Completer.TypeMap): string[] {
const filtered = Object.keys(typeMap)
.map(key => typeMap[key])
.filter(value => value && !(value in KNOWN_MAP))
.sort((a, b) => a.localeCompare(b));
return KNOWN_TYPES.concat(filtered);
}
}