-
Notifications
You must be signed in to change notification settings - Fork 2.5k
/
navigatable-types.ts
82 lines (77 loc) · 3.06 KB
/
navigatable-types.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
// *****************************************************************************
// Copyright (C) 2021 Ericsson and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// http://www.eclipse.org/legal/epl-2.0.
//
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License v. 2.0 are satisfied: GNU General Public License, version 2
// with the GNU Classpath Exception which is available at
// https://www.gnu.org/software/classpath/license.html.
//
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
// *****************************************************************************
import URI from '../common/uri';
import { MaybeArray } from '../common/types';
import { Widget, BaseWidget } from './widgets';
/**
* `Navigatable` provides an access to an URI of an underlying instance of `Resource`.
*/
export interface Navigatable {
/**
* Return an underlying resource URI.
*/
getResourceUri(): URI | undefined;
/**
* Creates a new URI to which this navigatable should moved based on the given target resource URI.
*/
createMoveToUri(resourceUri: URI): URI | undefined;
}
export namespace Navigatable {
export function is(arg: unknown): arg is Navigatable {
return !!arg && typeof arg === 'object' && 'getResourceUri' in arg && 'createMoveToUri' in arg;
}
}
export type NavigatableWidget = BaseWidget & Navigatable;
export namespace NavigatableWidget {
export function is(arg: unknown): arg is NavigatableWidget {
return arg instanceof BaseWidget && Navigatable.is(arg);
}
export function* getAffected<T extends Widget>(
widgets: Iterable<T>,
context: MaybeArray<URI>
): IterableIterator<[URI, T & NavigatableWidget]> {
const uris = Array.isArray(context) ? context : [context];
return get(widgets, resourceUri => uris.some(uri => uri.isEqualOrParent(resourceUri)));
}
export function* get<T extends Widget>(
widgets: Iterable<T>,
filter: (resourceUri: URI) => boolean = () => true
): IterableIterator<[URI, T & NavigatableWidget]> {
for (const widget of widgets) {
if (NavigatableWidget.is(widget)) {
const resourceUri = widget.getResourceUri();
if (resourceUri && filter(resourceUri)) {
yield [resourceUri, widget];
}
}
}
}
export function getUri(widget?: Widget): URI | undefined {
if (is(widget)) {
return widget.getResourceUri();
}
}
}
export interface NavigatableWidgetOptions {
kind: 'navigatable',
uri: string,
counter?: number,
}
export namespace NavigatableWidgetOptions {
export function is(arg: unknown): arg is NavigatableWidgetOptions {
return !!arg && typeof arg === 'object' && 'kind' in arg && (arg as NavigatableWidgetOptions).kind === 'navigatable';
}
}