| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321 |
- /*---------------------------------------------------------------------------------------------
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
- var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
- var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
- if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
- else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
- return c > 3 && r && Object.defineProperty(target, key, r), r;
- };
- var __param = (this && this.__param) || function (paramIndex, decorator) {
- return function (target, key) { decorator(target, key, paramIndex); }
- };
- import { RunOnceScheduler } from '../../../base/common/async.js';
- import { Emitter } from '../../../base/common/event.js';
- import { DisposableStore } from '../../../base/common/lifecycle.js';
- import { IMenuService, isIMenuItem, MenuItemAction, MenuRegistry, SubmenuItemAction } from './actions.js';
- import { ICommandService } from '../../commands/common/commands.js';
- import { IContextKeyService } from '../../contextkey/common/contextkey.js';
- import { toAction } from '../../../base/common/actions.js';
- import { IStorageService } from '../../storage/common/storage.js';
- import { removeFastWithoutKeepingOrder } from '../../../base/common/arrays.js';
- import { localize } from '../../../nls.js';
- let MenuService = class MenuService {
- constructor(_commandService, storageService) {
- this._commandService = _commandService;
- this._hiddenStates = new PersistedMenuHideState(storageService);
- }
- createMenu(id, contextKeyService, options) {
- return new Menu(id, this._hiddenStates, Object.assign({ emitEventsForSubmenuChanges: false, eventDebounceDelay: 50 }, options), this._commandService, contextKeyService, this);
- }
- };
- MenuService = __decorate([
- __param(0, ICommandService),
- __param(1, IStorageService)
- ], MenuService);
- export { MenuService };
- let PersistedMenuHideState = class PersistedMenuHideState {
- constructor(_storageService) {
- this._storageService = _storageService;
- this._disposables = new DisposableStore();
- this._onDidChange = new Emitter();
- this.onDidChange = this._onDidChange.event;
- this._ignoreChangeEvent = false;
- try {
- const raw = _storageService.get(PersistedMenuHideState._key, 0 /* StorageScope.PROFILE */, '{}');
- this._data = JSON.parse(raw);
- }
- catch (err) {
- this._data = Object.create(null);
- }
- this._disposables.add(_storageService.onDidChangeValue(e => {
- if (e.key !== PersistedMenuHideState._key) {
- return;
- }
- if (!this._ignoreChangeEvent) {
- try {
- const raw = _storageService.get(PersistedMenuHideState._key, 0 /* StorageScope.PROFILE */, '{}');
- this._data = JSON.parse(raw);
- }
- catch (err) {
- console.log('FAILED to read storage after UPDATE', err);
- }
- }
- this._onDidChange.fire();
- }));
- }
- dispose() {
- this._onDidChange.dispose();
- this._disposables.dispose();
- }
- isHidden(menu, commandId) {
- var _a, _b;
- return (_b = (_a = this._data[menu.id]) === null || _a === void 0 ? void 0 : _a.includes(commandId)) !== null && _b !== void 0 ? _b : false;
- }
- updateHidden(menu, commandId, hidden) {
- const entries = this._data[menu.id];
- if (!hidden) {
- // remove and cleanup
- if (entries) {
- const idx = entries.indexOf(commandId);
- if (idx >= 0) {
- removeFastWithoutKeepingOrder(entries, idx);
- }
- if (entries.length === 0) {
- delete this._data[menu.id];
- }
- }
- }
- else {
- // add unless already added
- if (!entries) {
- this._data[menu.id] = [commandId];
- }
- else {
- const idx = entries.indexOf(commandId);
- if (idx < 0) {
- entries.push(commandId);
- }
- }
- }
- this._persist();
- }
- _persist() {
- try {
- this._ignoreChangeEvent = true;
- const raw = JSON.stringify(this._data);
- this._storageService.store(PersistedMenuHideState._key, raw, 0 /* StorageScope.PROFILE */, 0 /* StorageTarget.USER */);
- }
- finally {
- this._ignoreChangeEvent = false;
- }
- }
- };
- PersistedMenuHideState._key = 'menu.hiddenCommands';
- PersistedMenuHideState = __decorate([
- __param(0, IStorageService)
- ], PersistedMenuHideState);
- let Menu = class Menu {
- constructor(_id, _hiddenStates, _options, _commandService, _contextKeyService, _menuService) {
- this._id = _id;
- this._hiddenStates = _hiddenStates;
- this._options = _options;
- this._commandService = _commandService;
- this._contextKeyService = _contextKeyService;
- this._menuService = _menuService;
- this._disposables = new DisposableStore();
- this._menuGroups = [];
- this._contextKeys = new Set();
- this._build();
- // Rebuild this menu whenever the menu registry reports an event for this MenuId.
- // This usually happen while code and extensions are loaded and affects the over
- // structure of the menu
- const rebuildMenuSoon = new RunOnceScheduler(() => {
- this._build();
- this._onDidChange.fire(this);
- }, _options.eventDebounceDelay);
- this._disposables.add(rebuildMenuSoon);
- this._disposables.add(MenuRegistry.onDidChangeMenu(e => {
- if (e.has(_id)) {
- rebuildMenuSoon.schedule();
- }
- }));
- // When context keys or storage state changes we need to check if the menu also has changed. However,
- // we only do that when someone listens on this menu because (1) these events are
- // firing often and (2) menu are often leaked
- const lazyListener = this._disposables.add(new DisposableStore());
- const startLazyListener = () => {
- const fireChangeSoon = new RunOnceScheduler(() => this._onDidChange.fire(this), _options.eventDebounceDelay);
- lazyListener.add(fireChangeSoon);
- lazyListener.add(_contextKeyService.onDidChangeContext(e => {
- if (e.affectsSome(this._contextKeys)) {
- fireChangeSoon.schedule();
- }
- }));
- lazyListener.add(_hiddenStates.onDidChange(() => {
- fireChangeSoon.schedule();
- }));
- };
- this._onDidChange = new Emitter({
- // start/stop context key listener
- onFirstListenerAdd: startLazyListener,
- onLastListenerRemove: lazyListener.clear.bind(lazyListener)
- });
- this.onDidChange = this._onDidChange.event;
- }
- dispose() {
- this._disposables.dispose();
- this._onDidChange.dispose();
- }
- _build() {
- // reset
- this._menuGroups.length = 0;
- this._contextKeys.clear();
- const menuItems = MenuRegistry.getMenuItems(this._id);
- let group;
- menuItems.sort(Menu._compareMenuItems);
- for (const item of menuItems) {
- // group by groupId
- const groupName = item.group || '';
- if (!group || group[0] !== groupName) {
- group = [groupName, []];
- this._menuGroups.push(group);
- }
- group[1].push(item);
- // keep keys for eventing
- this._collectContextKeys(item);
- }
- }
- _collectContextKeys(item) {
- Menu._fillInKbExprKeys(item.when, this._contextKeys);
- if (isIMenuItem(item)) {
- // keep precondition keys for event if applicable
- if (item.command.precondition) {
- Menu._fillInKbExprKeys(item.command.precondition, this._contextKeys);
- }
- // keep toggled keys for event if applicable
- if (item.command.toggled) {
- const toggledExpression = item.command.toggled.condition || item.command.toggled;
- Menu._fillInKbExprKeys(toggledExpression, this._contextKeys);
- }
- }
- else if (this._options.emitEventsForSubmenuChanges) {
- // recursively collect context keys from submenus so that this
- // menu fires events when context key changes affect submenus
- MenuRegistry.getMenuItems(item.submenu).forEach(this._collectContextKeys, this);
- }
- }
- getActions(options) {
- const result = [];
- const allToggleActions = [];
- for (const group of this._menuGroups) {
- const [id, items] = group;
- const toggleActions = [];
- const activeActions = [];
- for (const item of items) {
- if (this._contextKeyService.contextMatchesRules(item.when)) {
- let action;
- const isMenuItem = isIMenuItem(item);
- if (isMenuItem) {
- const menuHide = createMenuHide(this._id, item.command, this._hiddenStates);
- action = new MenuItemAction(item.command, item.alt, options, menuHide, this._contextKeyService, this._commandService);
- }
- else {
- action = new SubmenuItemAction(item, this._menuService, this._contextKeyService, options);
- if (action.actions.length === 0) {
- action.dispose();
- action = undefined;
- }
- }
- if (action) {
- activeActions.push(action);
- }
- }
- }
- if (activeActions.length > 0) {
- result.push([id, activeActions]);
- }
- if (toggleActions.length > 0) {
- allToggleActions.push(toggleActions);
- }
- }
- return result;
- }
- static _fillInKbExprKeys(exp, set) {
- if (exp) {
- for (const key of exp.keys()) {
- set.add(key);
- }
- }
- }
- static _compareMenuItems(a, b) {
- const aGroup = a.group;
- const bGroup = b.group;
- if (aGroup !== bGroup) {
- // Falsy groups come last
- if (!aGroup) {
- return 1;
- }
- else if (!bGroup) {
- return -1;
- }
- // 'navigation' group comes first
- if (aGroup === 'navigation') {
- return -1;
- }
- else if (bGroup === 'navigation') {
- return 1;
- }
- // lexical sort for groups
- const value = aGroup.localeCompare(bGroup);
- if (value !== 0) {
- return value;
- }
- }
- // sort on priority - default is 0
- const aPrio = a.order || 0;
- const bPrio = b.order || 0;
- if (aPrio < bPrio) {
- return -1;
- }
- else if (aPrio > bPrio) {
- return 1;
- }
- // sort on titles
- return Menu._compareTitles(isIMenuItem(a) ? a.command.title : a.title, isIMenuItem(b) ? b.command.title : b.title);
- }
- static _compareTitles(a, b) {
- const aStr = typeof a === 'string' ? a : a.original;
- const bStr = typeof b === 'string' ? b : b.original;
- return aStr.localeCompare(bStr);
- }
- };
- Menu = __decorate([
- __param(3, ICommandService),
- __param(4, IContextKeyService),
- __param(5, IMenuService)
- ], Menu);
- function createMenuHide(menu, command, states) {
- const id = `${menu.id}/${command.id}`;
- const title = typeof command.title === 'string' ? command.title : command.title.value;
- const hide = toAction({
- id,
- label: localize('hide.label', 'Hide \'{0}\'', title),
- run() { states.updateHidden(menu, command.id, true); }
- });
- const toggle = toAction({
- id,
- label: title,
- get checked() { return !states.isHidden(menu, command.id); },
- run() {
- const newValue = !states.isHidden(menu, command.id);
- states.updateHidden(menu, command.id, newValue);
- }
- });
- return {
- hide,
- toggle,
- get isHidden() { return !toggle.checked; },
- };
- }
|