Merge pull request #19717 from joaomoreno/modal-message-api

Implement modal message API
This commit is contained in:
João Moreno
2017-02-03 11:19:55 +01:00
committed by GitHub
6 changed files with 228 additions and 28 deletions

View File

@@ -291,14 +291,14 @@ export function createApiFactory(initData: IInitData, threadService: IThreadServ
onDidCloseTerminal(listener, thisArg?, disposables?) {
return extHostTerminalService.onDidCloseTerminal(listener, thisArg, disposables);
},
showInformationMessage(message, ...items) {
return extHostMessageService.showMessage(Severity.Info, message, items);
showInformationMessage(message, first, ...rest) {
return extHostMessageService.showMessage(Severity.Info, message, first, rest);
},
showWarningMessage(message, ...items) {
return extHostMessageService.showMessage(Severity.Warning, message, items);
showWarningMessage(message, first, ...rest) {
return extHostMessageService.showMessage(Severity.Warning, message, first, rest);
},
showErrorMessage(message, ...items) {
return extHostMessageService.showMessage(Severity.Error, message, items);
showErrorMessage(message, first, ...rest) {
return extHostMessageService.showMessage(Severity.Error, message, first, rest);
},
showQuickPick(items: any, options: vscode.QuickPickOptions, token?: vscode.CancellationToken) {
return extHostQuickOpen.showQuickPick(items, options, token);
@@ -329,7 +329,7 @@ export function createApiFactory(initData: IInitData, threadService: IThreadServ
},
// proposed API
sampleFunction: proposedApiFunction(extension, () => {
return extHostMessageService.showMessage(Severity.Info, 'Hello Proposed Api!', []);
return extHostMessageService.showMessage(Severity.Info, 'Hello Proposed Api!', {}, []);
}),
registerTreeExplorerNodeProvider: proposedApiFunction(extension, (providerId: string, provider: vscode.TreeExplorerNodeProvider<any>) => {
return extHostExplorers.registerTreeExplorerNodeProvider(providerId, provider);

View File

@@ -177,7 +177,7 @@ export abstract class MainThreadLanguagesShape {
}
export abstract class MainThreadMessageServiceShape {
$showMessage(severity: Severity, message: string, commands: { title: string; isCloseAffordance: boolean; handle: number; }[]): Thenable<number> { throw ni(); }
$showMessage(severity: Severity, message: string, options: vscode.MessageOptions, commands: { title: string; isCloseAffordance: boolean; handle: number; }[]): Thenable<number> { throw ni(); }
}
export abstract class MainThreadOutputServiceShape {

View File

@@ -9,6 +9,20 @@ import Severity from 'vs/base/common/severity';
import vscode = require('vscode');
import { MainContext, MainThreadMessageServiceShape } from './extHost.protocol';
const emptyMessageOptions: vscode.MessageOptions = Object.create(null);
function isMessageItem<T>(item: any): item is vscode.MessageItem {
return item && item.title;
}
function parseMessageArguments(first: vscode.MessageOptions | string | vscode.MessageItem, rest: (string | vscode.MessageItem)[]): { options: vscode.MessageOptions; items: (string | vscode.MessageItem)[]; } {
if (typeof first === 'string' || isMessageItem(first)) {
return { options: emptyMessageOptions, items: [first, ...rest] };
} else {
return { options: first || emptyMessageOptions, items: rest };
}
}
export class ExtHostMessageService {
private _proxy: MainThreadMessageServiceShape;
@@ -17,25 +31,25 @@ export class ExtHostMessageService {
this._proxy = threadService.get(MainContext.MainThreadMessageService);
}
showMessage(severity: Severity, message: string, commands: (string | vscode.MessageItem)[]): Thenable<string | vscode.MessageItem> {
showMessage(severity: Severity, message: string, optionsOrFirstItem: vscode.MessageOptions | string | vscode.MessageItem, rest: (string | vscode.MessageItem)[]): Thenable<string | vscode.MessageItem> {
const { options, items } = parseMessageArguments(optionsOrFirstItem, rest);
const commands: { title: string; isCloseAffordance: boolean; handle: number; }[] = [];
const items: { title: string; isCloseAffordance: boolean; handle: number; }[] = [];
for (let handle = 0; handle < commands.length; handle++) {
let command = commands[handle];
for (let handle = 0; handle < items.length; handle++) {
let command = items[handle];
if (typeof command === 'string') {
items.push({ title: command, handle, isCloseAffordance: false });
commands.push({ title: command, handle, isCloseAffordance: false });
} else if (typeof command === 'object') {
let {title, isCloseAffordance} = command;
items.push({ title, isCloseAffordance, handle });
commands.push({ title, isCloseAffordance, handle });
} else {
console.warn('Invalid message item:', command);
}
}
return this._proxy.$showMessage(severity, message, items).then(handle => {
return this._proxy.$showMessage(severity, message, options, commands).then(handle => {
if (typeof handle === 'number') {
return commands[handle];
return items[handle];
}
return undefined;
});

View File

@@ -5,22 +5,31 @@
'use strict';
import nls = require('vs/nls');
import { IMessageService } from 'vs/platform/message/common/message';
import { IMessageService, IChoiceService } from 'vs/platform/message/common/message';
import Severity from 'vs/base/common/severity';
import { Action } from 'vs/base/common/actions';
import { TPromise as Promise } from 'vs/base/common/winjs.base';
import { MainThreadMessageServiceShape } from './extHost.protocol';
import * as vscode from 'vscode';
export class MainThreadMessageService extends MainThreadMessageServiceShape {
private _messageService: IMessageService;
constructor( @IMessageService messageService: IMessageService) {
constructor(
@IMessageService private _messageService: IMessageService,
@IChoiceService private _choiceService: IChoiceService
) {
super();
this._messageService = messageService;
}
$showMessage(severity: Severity, message: string, commands: { title: string; isCloseAffordance: boolean; handle: number; }[]): Thenable<number> {
$showMessage(severity: Severity, message: string, options: vscode.MessageOptions, commands: { title: string; isCloseAffordance: boolean; handle: number; }[]): Thenable<number> {
if (options.modal) {
return this.showModalMessage(severity, message, commands);
} else {
return this.showMessage(severity, message, commands);
}
}
private showMessage(severity: Severity, message: string, commands: { title: string; isCloseAffordance: boolean; handle: number; }[]): Thenable<number> {
return new Promise<number>(resolve => {
@@ -58,4 +67,27 @@ export class MainThreadMessageService extends MainThreadMessageServiceShape {
});
});
}
private showModalMessage(severity: Severity, message: string, commands: { title: string; isCloseAffordance: boolean; handle: number; }[]): Thenable<number> {
let hasCloseAffordance = false;
const options = commands.map((command, index) => {
if (command.isCloseAffordance === true) {
hasCloseAffordance = true;
}
return command.title;
});
if (!hasCloseAffordance) {
if (options.length > 0) {
options.push(nls.localize('cancel', "Cancel"));
} else {
options.push(nls.localize('ok', "OK"));
}
}
return this._choiceService.choose(severity, message, options, true)
.then(result => result === commands.length ? undefined : commands[result].handle);
}
}