@theia/core
Version:
Theia is a cloud & desktop IDE framework implemented in TypeScript.
636 lines (563 loc) • 26.6 kB
text/typescript
// *****************************************************************************
// Copyright (C) 2017 TypeFox 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-only WITH Classpath-exception-2.0
// *****************************************************************************
import { injectable, inject } from 'inversify';
import { Menu, MenuBar, Menu as MenuWidget, Widget } from '@lumino/widgets';
import { CommandRegistry as LuminoCommandRegistry } from '@lumino/commands';
import {
environment, Disposable, DisposableCollection,
AcceleratorSource,
ArrayUtils,
PreferenceService
} from '../../common/index.js';
import { KeybindingRegistry } from '../keybinding.js';
import { FrontendApplication } from '../frontend-application.js';
import { FrontendApplicationContribution } from '../frontend-application-contribution.js';
import { ContextKeyService, ContextMatcher } from '../context-key-service.js';
import { ContextMenuContext } from './context-menu-context.js';
import { Message, waitForRevealed } from '../widgets/index.js';
import { ApplicationShell } from '../shell/index.js';
import { CorePreferences } from '../../common/core-preferences.js';
import { ElementExt } from '@lumino/domutils';
import { CommandMenu, CompoundMenuNode, MAIN_MENU_BAR, MenuNode, MenuPath, RenderedMenuNode, Submenu } from '../../common/menu/menu-types.js';
import { MenuModelRegistry } from '../../common/menu/menu-model-registry.js';
export abstract class MenuBarWidget extends MenuBar {
abstract activateMenu(label: string, ...labels: string[]): Promise<MenuWidget>;
abstract triggerMenuItem(label: string, ...labels: string[]): Promise<MenuWidget.IItem>;
}
export interface BrowserMenuOptions extends MenuWidget.IOptions {
context?: HTMLElement,
};
export class BrowserMainMenuFactory implements MenuWidgetFactory {
protected readonly contextKeyService: ContextKeyService;
protected readonly context: ContextMenuContext;
protected readonly corePreferences: CorePreferences;
protected readonly keybindingRegistry: KeybindingRegistry;
protected readonly menuProvider: MenuModelRegistry;
createMenuBar(): MenuBarWidget {
const menuBar = new DynamicMenuBarWidget();
menuBar.id = 'theia:menubar';
this.corePreferences.ready.then(() => {
this.showMenuBar(menuBar);
});
const disposable = new DisposableCollection(
this.corePreferences.onPreferenceChanged(change => {
if (change.preferenceName === 'window.menuBarVisibility') {
this.showMenuBar(menuBar, this.corePreferences['window.menuBarVisibility']);
}
}),
this.keybindingRegistry.onKeybindingsChanged(() => {
this.showMenuBar(menuBar);
}),
this.menuProvider.onDidChange(evt => {
if (ArrayUtils.startsWith(evt.path, MAIN_MENU_BAR)) {
this.showMenuBar(menuBar);
}
})
);
menuBar.disposed.connect(() => disposable.dispose());
return menuBar;
}
protected getMenuBarVisibility(): string {
return this.corePreferences.get('window.menuBarVisibility', 'classic');
}
protected showMenuBar(menuBar: DynamicMenuBarWidget, preference = this.getMenuBarVisibility()): void {
if (preference && ['classic', 'visible', 'toggle'].includes(preference)) {
menuBar.clearMenus();
this.fillMenuBar(menuBar);
} else {
menuBar.clearMenus();
}
}
protected fillMenuBar(menuBar: MenuBarWidget): void {
const menuModel = this.menuProvider.getMenuNode(MAIN_MENU_BAR) as Submenu;
const menuCommandRegistry = new LuminoCommandRegistry();
for (const menu of menuModel.children) {
if (CompoundMenuNode.is(menu) && RenderedMenuNode.is(menu)) {
const menuWidget = this.createMenuWidget(MAIN_MENU_BAR, menu, this.contextKeyService, { commands: menuCommandRegistry });
menuBar.addMenu(menuWidget);
}
}
}
createContextMenu(effectiveMenuPath: MenuPath, menuModel: CompoundMenuNode, contextMatcher: ContextMatcher, args?: unknown[], context?: HTMLElement): MenuWidget {
const menuCommandRegistry = new LuminoCommandRegistry();
const contextMenu = this.createMenuWidget(effectiveMenuPath, menuModel, contextMatcher, { commands: menuCommandRegistry, context }, args);
return contextMenu;
}
createMenuWidget(parentPath: MenuPath, menu: CompoundMenuNode, contextMatcher: ContextMatcher, options: BrowserMenuOptions, args?: unknown[]): DynamicMenuWidget {
return new DynamicMenuWidget(parentPath, menu, options, contextMatcher, this.services, args);
}
protected get services(): MenuServices {
return {
contextKeyService: this.contextKeyService,
context: this.context,
menuWidgetFactory: this,
};
}
}
export function isMenuElement(element: HTMLElement | null): boolean {
return !!element && element.className.includes('lm-Menu');
}
export class DynamicMenuBarWidget extends MenuBarWidget {
/**
* We want to restore the focus after the menu closes.
*/
protected previousFocusedElement: HTMLElement | undefined;
constructor() {
// Disable Lumino's overflow menu feature. The feature has a bug where
// `onUpdateRequest` consumes a stale `_overflowIndex` (only recomputed at the
// end of the method), which causes a RangeError when the menu bar is rendered
// at zero width. Additionally, Theia's CSS does not constrain the menu bar's
// offsetWidth to the available space, so the overflow detection never triggers.
// See https://github.com/eclipse-theia/theia/issues/17352
// See https://github.com/jupyterlab/lumino/issues/811
super({ overflowMenuOptions: { isVisible: false } });
// HACK we need to hook in on private method _openChildMenu. Don't do this at home!
DynamicMenuBarWidget.prototype['_openChildMenu'] = () => {
if (this.activeMenu instanceof DynamicMenuWidget) {
// `childMenu` is `null` if we open the menu. For example, menu is not shown and you click on `Edit`.
// However, the `childMenu` is set, when `Edit` was already open and you move the mouse over `Select`.
// We want to save the focus object for the former case only.
if (!this.childMenu) {
const { activeElement } = document;
// we do not want to restore focus to menus
if (activeElement instanceof HTMLElement && !isMenuElement(activeElement)) {
this.previousFocusedElement = activeElement;
}
}
this.activeMenu.aboutToShow({ previousFocusedElement: this.previousFocusedElement });
}
super['_openChildMenu']();
};
}
async activateMenu(label: string, ...labels: string[]): Promise<MenuWidget> {
const menu = this.menus.find(m => m.title.label === label);
if (!menu) {
throw new Error(`could not find '${label}' menu`);
}
this.activeMenu = menu;
this.openActiveMenu();
await waitForRevealed(menu);
const menuPath = [label, ...labels];
let current = menu;
for (const itemLabel of labels) {
const item = current.items.find(i => i.label === itemLabel);
if (!item || !item.submenu) {
throw new Error(`could not find '${itemLabel}' submenu in ${menuPath.map(l => "'" + l + "'").join(' -> ')} menu`);
}
current.activeItem = item;
current.triggerActiveItem();
current = item.submenu;
await waitForRevealed(current);
}
return current;
}
async triggerMenuItem(label: string, ...labels: string[]): Promise<MenuWidget.IItem> {
if (!labels.length) {
throw new Error('menu item label is not specified');
}
const menuPath = [label, ...labels.slice(0, labels.length - 1)];
const menu = await this.activateMenu(menuPath[0], ...menuPath.slice(1));
const item = menu.items.find(i => i.label === labels[labels.length - 1]);
if (!item) {
throw new Error(`could not find '${labels[labels.length - 1]}' item in ${menuPath.map(l => "'" + l + "'").join(' -> ')} menu`);
}
menu.activeItem = item;
menu.triggerActiveItem();
return item;
}
}
export class MenuServices {
readonly contextKeyService: ContextKeyService;
readonly context: ContextMenuContext;
readonly menuWidgetFactory: MenuWidgetFactory;
}
export interface MenuWidgetFactory {
createMenuWidget(effectiveMenuPath: MenuPath, menu: Submenu, contextMatcher: ContextMatcher, options: BrowserMenuOptions, args?: unknown[]): MenuWidget;
}
/**
* A menu widget that would recompute its items on update.
*/
export class DynamicMenuWidget extends MenuWidget {
private static nextCommmandId = 0;
/**
* We want to restore the focus after the menu closes.
*/
protected previousFocusedElement: HTMLElement | undefined;
constructor(
protected readonly effectiveMenuPath: MenuPath,
protected menu: CompoundMenuNode,
protected options: BrowserMenuOptions,
protected contextMatcher: ContextMatcher,
protected services: MenuServices,
protected args?: unknown[]
) {
super(options);
if (RenderedMenuNode.is(this.menu)) {
if (this.menu.label) {
this.title.label = this.menu.label;
}
if (this.menu.icon) {
this.title.iconClass = this.menu.icon;
}
}
this.updateSubMenus(this.effectiveMenuPath, this, this.menu, this.options.commands, this.contextMatcher, this.options.context);
}
protected override onAfterAttach(msg: Message): void {
super.onAfterAttach(msg);
this.node.ownerDocument.addEventListener('pointerdown', this, true);
}
protected override onBeforeDetach(msg: Message): void {
this.node.ownerDocument.removeEventListener('pointerdown', this, true);
super.onBeforeDetach(msg);
}
override handleEvent(event: Event): void {
if (event.type === 'pointerdown') {
this.handlePointerDown(event as PointerEvent);
}
super.handleEvent(event);
}
handlePointerDown(event: PointerEvent): void {
// this code is copied from the superclass because we cannot use the hit
// test from the "Private" implementation namespace
if (this['_parentMenu']) {
return;
}
// The mouse button which is pressed is irrelevant. If the press
// is not on a menu, the entire hierarchy is closed and the event
// is allowed to propagate. This allows other code to act on the
// event, such as focusing the clicked element.
if (!this.hitTestMenus(this, event.clientX, event.clientY)) {
this.close();
}
}
private hitTestMenus(menu: Menu, x: number, y: number): boolean {
for (let temp: Menu | null = menu; temp; temp = temp.childMenu) {
if (ElementExt.hitTest(temp.node, x, y)) {
return true;
}
}
return false;
}
public aboutToShow({ previousFocusedElement }: { previousFocusedElement: HTMLElement | undefined }): void {
this.preserveFocusedElement(previousFocusedElement);
this.clearItems();
this.runWithPreservedFocusContext(() => {
this.updateSubMenus(this.effectiveMenuPath, this, this.menu, this.options.commands, this.contextMatcher, this.options.context);
});
}
public override open(x: number, y: number, options?: MenuWidget.IOpenOptions): void {
const cb = () => {
this.restoreFocusedElement();
this.aboutToClose.disconnect(cb);
};
this.aboutToClose.connect(cb);
this.preserveFocusedElement();
super.open(x, y, options);
}
protected updateSubMenus(parentPath: MenuPath, parent: MenuWidget, menu: CompoundMenuNode, commands: LuminoCommandRegistry,
contextMatcher: ContextMatcher, context?: HTMLElement | undefined): void {
const items = this.createItems(parentPath, menu.children, commands, contextMatcher, context);
while (items[items.length - 1]?.type === 'separator') {
items.pop();
}
for (const item of items) {
parent.addItem(item);
}
}
protected createItems(parentPath: MenuPath, nodes: MenuNode[], phCommandRegistry: LuminoCommandRegistry,
contextMatcher: ContextMatcher, context?: HTMLElement): MenuWidget.IItemOptions[] {
const result: MenuWidget.IItemOptions[] = [];
for (const node of nodes) {
const nodePath = node.effectiveMenuPath || [...parentPath, node.id];
if (node.isVisible(nodePath, contextMatcher, context, ...(this.args || []))) {
if (CompoundMenuNode.is(node)) {
if (RenderedMenuNode.is(node)) {
const submenu = this.services.menuWidgetFactory.createMenuWidget(nodePath, node, this.contextMatcher, this.options, this.args);
if (submenu.items.length > 0) {
result.push({ type: 'submenu', submenu });
}
} else if (node.id !== 'inline') {
const items = this.createItems(nodePath, node.children, phCommandRegistry, contextMatcher, context);
if (items.length > 0) {
if (result[result.length - 1]?.type !== 'separator') {
result.push({ type: 'separator' });
}
result.push(...items);
result.push({ type: 'separator' });
}
}
} else if (CommandMenu.is(node)) {
const id = !phCommandRegistry.hasCommand(node.id) ? node.id : `${node.id}:${DynamicMenuWidget.nextCommmandId++}`;
const enabled = node.isEnabled(nodePath, ...(this.args || []));
const toggled = node.isToggled ? !!node.isToggled(nodePath, ...(this.args || [])) : false;
phCommandRegistry.addCommand(id, {
execute: () => {
// Restore focus to the previously focused element before executing
// the command so that focus-dependent commands like clipboard
// operations target the correct element instead of the menu.
if (this.previousFocusedElement) {
this.previousFocusedElement.focus({ preventScroll: true });
}
node.run(nodePath, ...(this.args || []));
},
isEnabled: () => enabled,
isToggled: () => toggled,
isVisible: () => true,
label: node.label,
iconClass: node.icon,
});
const accelerator = (AcceleratorSource.is(node) ? node.getAccelerator(this.options.context, 'logical') : []);
if (accelerator.length > 0) {
phCommandRegistry.addKeyBinding({
command: id,
keys: accelerator,
selector: '.p-Widget' // We have the PhosphorJS dependency anyway.
});
}
result.push({
command: id,
type: 'command'
});
}
}
}
return result;
}
protected preserveFocusedElement(previousFocusedElement: Element | null = document.activeElement): boolean {
if (!this.previousFocusedElement && previousFocusedElement instanceof HTMLElement && !isMenuElement(previousFocusedElement)) {
this.previousFocusedElement = previousFocusedElement;
return true;
}
return false;
}
protected restoreFocusedElement(): boolean {
if (this.previousFocusedElement) {
this.previousFocusedElement.focus({ preventScroll: true });
this.previousFocusedElement = undefined;
return true;
}
return false;
}
protected runWithPreservedFocusContext(what: () => void): void {
let focusToRestore: HTMLElement | undefined = undefined;
const { activeElement } = document;
if (this.previousFocusedElement &&
activeElement instanceof HTMLElement &&
this.previousFocusedElement !== activeElement) {
focusToRestore = activeElement;
this.previousFocusedElement.focus({ preventScroll: true });
}
try {
what();
} finally {
if (focusToRestore && !isMenuElement(focusToRestore)) {
focusToRestore.focus({ preventScroll: true });
}
}
}
}
export class BrowserMenuBarContribution implements FrontendApplicationContribution {
protected readonly shell: ApplicationShell;
protected readonly preferenceService: PreferenceService;
protected toggleModeListeners = new DisposableCollection();
protected menuWidget?: MenuBarWidget;
protected logoWidget?: Widget;
constructor(
protected readonly factory: BrowserMainMenuFactory
) { }
onStart(app: FrontendApplication): void {
this.appendMenu(app.shell);
}
get menuBar(): MenuBarWidget | undefined {
return this.shell.topPanel.widgets.find(w => w instanceof MenuBarWidget) as MenuBarWidget | undefined;
}
protected appendMenu(shell: ApplicationShell): void {
const logo = this.createLogo();
shell.addWidget(logo, { area: 'top' });
const menu = this.factory.createMenuBar();
shell.addWidget(menu, { area: 'top' });
this.menuWidget = menu;
this.logoWidget = logo;
if (environment.electron.is()) {
this.preferenceService.ready.then(() => {
this.updateElectronMenuToggleMode(menu, logo);
});
this.preferenceService.onPreferenceChanged(change => {
if (change.preferenceName === 'window.menuBarVisibility') {
this.updateElectronMenuToggleMode(menu, logo);
}
});
} else {
// In the browser, the whole top panel is hidden for compact/hidden/toggle
// (handled by ApplicationShell). For toggle mode, this installs an Alt-key
// listener that temporarily shows the top panel.
this.preferenceService.ready.then(() => {
this.updateBrowserMenuToggleMode(menu);
});
this.preferenceService.onPreferenceChanged(change => {
if (change.preferenceName === 'window.menuBarVisibility') {
this.updateBrowserMenuToggleMode(menu);
}
});
}
}
/**
* Manages Lumino menu bar visibility and Alt-key toggling in Electron.
*
* With native title bar, the native Electron menu bar handles toggle via
* `autoHideMenuBar`, so the Lumino menu bar is simply hidden.
*
* With custom title bar, the Lumino menu bar is the only menu bar visible
* to the user. For 'toggle' mode, an Alt-key listener is installed to
* show/hide the menu bar widget.
*/
protected updateElectronMenuToggleMode(menu: MenuBarWidget, logo: Widget): void {
this.toggleModeListeners.dispose();
const pref = this.preferenceService.get<string>('window.menuBarVisibility', 'classic');
this.applyElectronMenuBarVisibility(menu, logo, pref);
if (pref === 'toggle') {
this.toggleModeListeners = this.installAltKeyToggle(menu, () => this.getElectronToggleTargets(menu, logo));
}
}
/**
* Establishes the resting visibility of the menu bar widgets in Electron, i.e. the state
* a clean Alt press toggles away from in 'toggle' mode.
*/
protected applyElectronMenuBarVisibility(menu: MenuBarWidget, logo: Widget, pref: string): void {
const shouldHide = ['compact', 'hidden', 'toggle'].includes(pref);
menu.setHidden(shouldHide);
logo.setHidden(shouldHide);
}
/**
* The widgets a clean Alt press shows and hides in 'toggle' mode in Electron.
*/
protected getElectronToggleTargets(menu: MenuBarWidget, logo: Widget): Widget[] {
return [menu, logo];
}
/**
* Manages Alt-key toggle behavior for 'toggle' mode in the browser.
* The top panel's initial visibility is handled by {@link ApplicationShell.setTopPanelVisibility};
* this method only installs or removes the Alt-key listener.
*/
protected updateBrowserMenuToggleMode(menu: MenuBarWidget): void {
this.toggleModeListeners.dispose();
const pref = this.preferenceService.get<string>('window.menuBarVisibility', 'classic');
if (pref === 'toggle') {
this.toggleModeListeners = this.installAltKeyToggle(menu, () => [this.shell.topPanel]);
}
}
/**
* Installs Alt-key listeners to toggle menu bar visibility.
* A clean Alt press (press and release without other keys) shows the
* given toggle targets and focuses the first menu. Pressing Alt again
* or clicking outside hides them.
*
* @param menu the menu bar widget to focus when shown
* @param toggleTargets supplies the widgets to show/hide on Alt toggle. It is consulted on
* each gesture, because the targets can depend on state that changes while the listener is
* installed, e.g. whether the window is in full screen.
*/
protected installAltKeyToggle(menu: MenuBarWidget, toggleTargets: () => Widget[]): DisposableCollection {
const disposables = new DisposableCollection();
let altKeyPressed = false;
let lastKeyWasAlt = false;
const isHidden = (): boolean => toggleTargets().some(w => w.isHidden);
const hide = (): void => {
for (const w of toggleTargets()) {
w.setHidden(true);
}
};
const show = (): void => {
for (const w of toggleTargets()) {
w.setHidden(false);
}
};
const onKeyDown = (e: KeyboardEvent): void => {
if (e.key === 'Alt') {
if (!e.repeat) {
altKeyPressed = true;
lastKeyWasAlt = true;
}
} else {
// Any other key invalidates the Alt-only gesture
lastKeyWasAlt = false;
}
};
// Mouse interaction while Alt is held is a modifier gesture of its own, e.g. Alt+click to add a
// cursor or Alt+scroll to scroll faster, so it invalidates the Alt-only gesture as any other key does.
const onPointerInteraction = (): void => {
lastKeyWasAlt = false;
};
const onKeyUp = (e: KeyboardEvent): void => {
if (e.key !== 'Alt') {
return;
}
const wasCleanAltPress = altKeyPressed && lastKeyWasAlt;
altKeyPressed = false;
lastKeyWasAlt = false;
if (!wasCleanAltPress) {
return;
}
// Keep the browser from acting on the solitary Alt press itself: Firefox, for
// instance, focuses its own menu bar, which would then toggle along with ours.
e.preventDefault();
if (isHidden()) {
show();
menu.activeIndex = 0;
menu.node.focus();
} else {
hide();
}
};
// When a menu closes and focus leaves the menu bar, hide it again
const onFocusOut = (): void => {
// Use setTimeout to allow focus to settle (e.g. focus moving between menu items)
setTimeout(() => {
if (!isHidden() && !menu.node.contains(document.activeElement)) {
hide();
}
}, 100);
};
document.addEventListener('keydown', onKeyDown, true);
document.addEventListener('keyup', onKeyUp, true);
document.addEventListener('mousedown', onPointerInteraction, true);
document.addEventListener('wheel', onPointerInteraction, { capture: true, passive: true });
menu.node.addEventListener('focusout', onFocusOut);
disposables.push(Disposable.create(() => {
document.removeEventListener('keydown', onKeyDown, true);
document.removeEventListener('keyup', onKeyUp, true);
document.removeEventListener('mousedown', onPointerInteraction, true);
document.removeEventListener('wheel', onPointerInteraction, true);
menu.node.removeEventListener('focusout', onFocusOut);
}));
return disposables;
}
protected createLogo(): Widget {
const logo = new Widget();
logo.id = 'theia:icon';
logo.addClass('theia-icon');
return logo;
}
}