-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
/
menufactory.ts
201 lines (187 loc) · 5.2 KB
/
menufactory.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
/*
* Copyright (c) Jupyter Development Team.
* Distributed under the terms of the Modified BSD License.
*/
import { Text } from '@jupyterlab/coreutils';
import { ISettingRegistry } from '@jupyterlab/settingregistry';
import { LabIcon } from '@jupyterlab/ui-components';
import { JSONExt } from '@lumino/coreutils';
import { ContextMenu, Menu } from '@lumino/widgets';
/**
* Helper functions to build a menu from the settings
*/
export namespace MenuFactory {
/**
* Menu constructor options
*/
export interface IMenuOptions {
/**
* The unique menu identifier.
*/
id: string;
/**
* The menu label.
*/
label?: string;
/**
* The menu rank.
*/
rank?: number;
}
/**
* Create menus from their description
*
* @param data Menubar description
* @param menuFactory Factory for empty menu
*/
export function createMenus(
data: ISettingRegistry.IMenu[],
menuFactory: (options: IMenuOptions) => Menu
): Menu[] {
return data
.filter(item => !item.disabled)
.sort((a, b) => (a.rank ?? Infinity) - (b.rank ?? Infinity))
.map(menuItem => {
return dataToMenu(menuItem, menuFactory);
});
}
/**
* Convert a menu description in a JupyterLabMenu object
*
* @param item Menu description
* @param menuFactory Empty menu factory
* @returns The menu widget
*/
function dataToMenu(
item: ISettingRegistry.IMenu,
menuFactory: (options: IMenuOptions) => Menu
): Menu {
const menu = menuFactory(item);
menu.id = item.id;
// Set the label in case the menu factory did not.
if (!menu.title.label) {
menu.title.label = item.label ?? Text.titleCase(menu.id.trim());
}
if (item.icon) {
menu.title.icon = LabIcon.resolve({ icon: item.icon });
}
if (item.mnemonic !== undefined) {
menu.title.mnemonic = item.mnemonic;
}
item.items
?.filter(item => !item.disabled)
.sort((a, b) => (a.rank ?? Infinity) - (b.rank ?? Infinity))
.map(item => {
addItem(item, menu, menuFactory);
});
return menu;
}
/**
* Convert an item description in a context menu item object
*
* @param item Context menu item
* @param menu Context menu to populate
* @param menuFactory Empty menu factory
*/
export function addContextItem(
item: ISettingRegistry.IContextMenuItem,
menu: ContextMenu,
menuFactory: (options: IMenuOptions) => Menu
): void {
const { submenu, ...newItem } = item;
// Commands may not have been registered yet; so we don't force it to exist
menu.addItem({
...newItem,
submenu: submenu ? dataToMenu(submenu, menuFactory) : null
} as any);
}
/**
* Convert an item description in a menu item object
*
* @param item Menu item
* @param menu Menu to populate
* @param menuFactory Empty menu factory
*/
function addItem(
item: ISettingRegistry.IMenuItem,
menu: Menu,
menuFactory: (options: IMenuOptions) => Menu
): void {
const { submenu, ...newItem } = item;
// Commands may not have been registered yet; so we don't force it to exist
menu.addItem({
...newItem,
submenu: submenu ? dataToMenu(submenu, menuFactory) : null
} as any);
}
/**
* Update an existing list of menu and returns
* the new elements.
*
* #### Note
* New elements are added to the current menu list.
*
* @param menus Current menus
* @param data New description to take into account
* @param menuFactory Empty menu factory
* @returns Newly created menus
*/
export function updateMenus(
menus: Menu[],
data: ISettingRegistry.IMenu[],
menuFactory: (options: IMenuOptions) => Menu
): Menu[] {
const newMenus: Menu[] = [];
data.forEach(item => {
const menu = menus.find(menu => menu.id === item.id);
if (menu) {
mergeMenus(item, menu, menuFactory);
} else {
if (!item.disabled) {
newMenus.push(dataToMenu(item, menuFactory));
}
}
});
menus.push(...newMenus);
return newMenus;
}
function mergeMenus(
item: ISettingRegistry.IMenu,
menu: Menu,
menuFactory: (options: IMenuOptions) => Menu
) {
if (item.disabled) {
menu.dispose();
} else {
item.items?.forEach(entry => {
const existingItem = menu?.items.find(
(i, idx) =>
i.type === entry.type &&
i.command === (entry.command ?? '') &&
i.submenu?.id === entry.submenu?.id
);
if (existingItem && entry.type !== 'separator') {
if (entry.disabled) {
menu.removeItem(existingItem);
} else {
switch (entry.type ?? 'command') {
case 'command':
if (entry.command) {
if (!JSONExt.deepEqual(existingItem.args, entry.args ?? {})) {
addItem(entry, menu, menuFactory);
}
}
break;
case 'submenu':
if (entry.submenu) {
mergeMenus(entry.submenu, existingItem.submenu!, menuFactory);
}
}
}
} else {
addItem(entry, menu, menuFactory);
}
});
}
}
}