@theia/terminal 1.45.1 → 1.46.0-next.72

package/src/common/base-terminal-protocol.ts

@@ -1,125 +1,125 @@
-// *****************************************************************************
-// Copyright (C) 2017 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-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { RpcServer } from '@theia/core/lib/common/messaging/proxy-factory';
-import { Disposable } from '@theia/core';
-
-export interface TerminalProcessInfo {
-    executable: string
-    arguments: string[]
-}
-
-export interface IBaseTerminalServerOptions { }
-
-export interface IBaseTerminalServer extends RpcServer<IBaseTerminalClient> {
-    create(IBaseTerminalServerOptions: object): Promise<number>;
-    getProcessId(id: number): Promise<number>;
-    getProcessInfo(id: number): Promise<TerminalProcessInfo>;
-    getCwdURI(id: number): Promise<string>;
-    resize(id: number, cols: number, rows: number): Promise<void>;
-    attach(id: number): Promise<number>;
-    onAttachAttempted(id: number): Promise<void>;
-    close(id: number): Promise<void>;
-    getDefaultShell(): Promise<string>;
-}
-export namespace IBaseTerminalServer {
-    export function validateId(id?: number): boolean {
-        return typeof id === 'number' && id !== -1;
-    }
-}
-
-export interface IBaseTerminalExitEvent {
-    terminalId: number;
-
-    // Either code and reason will be set or signal.
-    code?: number;
-    reason?: TerminalExitReason;
-    signal?: string;
-
-    attached?: boolean;
-}
-
-export enum TerminalExitReason {
-    Unknown = 0,
-    Shutdown = 1,
-    Process = 2,
-    User = 3,
-    Extension = 4,
-}
-
-export interface IBaseTerminalErrorEvent {
-    terminalId: number;
-    error: Error;
-    attached?: boolean;
-}
-
-export interface IBaseTerminalClient {
-    onTerminalExitChanged(event: IBaseTerminalExitEvent): void;
-    onTerminalError(event: IBaseTerminalErrorEvent): void;
-    updateTerminalEnvVariables(): void;
-    storeTerminalEnvVariables(data: string): void;
-}
-
-export class DispatchingBaseTerminalClient {
-
-    protected readonly clients = new Set<IBaseTerminalClient>();
-
-    push(client: IBaseTerminalClient): Disposable {
-        this.clients.add(client);
-        return Disposable.create(() => this.clients.delete(client));
-    }
-
-    onTerminalExitChanged(event: IBaseTerminalExitEvent): void {
-        this.clients.forEach(c => {
-            try {
-                c.onTerminalExitChanged(event);
-            } catch (e) {
-                console.error(e);
-            }
-        });
-    }
-
-    onTerminalError(event: IBaseTerminalErrorEvent): void {
-
-        this.clients.forEach(c => {
-            try {
-                c.onTerminalError(event);
-            } catch (e) {
-                console.error(e);
-            }
-        });
-    }
-
-    updateTerminalEnvVariables(): void {
-        this.clients.forEach(c => {
-            try {
-                c.updateTerminalEnvVariables();
-            } catch (e) {
-                console.error(e);
-            }
-        });
-    }
-
-    storeTerminalEnvVariables(data: string): void {
-        this.clients.forEach(c => {
-            try {
-                c.storeTerminalEnvVariables(data);
-            } catch (e) {
-                console.error(e);
-            }
-        });
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2017 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-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { RpcServer } from '@theia/core/lib/common/messaging/proxy-factory';
+import { Disposable } from '@theia/core';
+
+export interface TerminalProcessInfo {
+    executable: string
+    arguments: string[]
+}
+
+export interface IBaseTerminalServerOptions { }
+
+export interface IBaseTerminalServer extends RpcServer<IBaseTerminalClient> {
+    create(IBaseTerminalServerOptions: object): Promise<number>;
+    getProcessId(id: number): Promise<number>;
+    getProcessInfo(id: number): Promise<TerminalProcessInfo>;
+    getCwdURI(id: number): Promise<string>;
+    resize(id: number, cols: number, rows: number): Promise<void>;
+    attach(id: number): Promise<number>;
+    onAttachAttempted(id: number): Promise<void>;
+    close(id: number): Promise<void>;
+    getDefaultShell(): Promise<string>;
+}
+export namespace IBaseTerminalServer {
+    export function validateId(id?: number): boolean {
+        return typeof id === 'number' && id !== -1;
+    }
+}
+
+export interface IBaseTerminalExitEvent {
+    terminalId: number;
+
+    // Either code and reason will be set or signal.
+    code?: number;
+    reason?: TerminalExitReason;
+    signal?: string;
+
+    attached?: boolean;
+}
+
+export enum TerminalExitReason {
+    Unknown = 0,
+    Shutdown = 1,
+    Process = 2,
+    User = 3,
+    Extension = 4,
+}
+
+export interface IBaseTerminalErrorEvent {
+    terminalId: number;
+    error: Error;
+    attached?: boolean;
+}
+
+export interface IBaseTerminalClient {
+    onTerminalExitChanged(event: IBaseTerminalExitEvent): void;
+    onTerminalError(event: IBaseTerminalErrorEvent): void;
+    updateTerminalEnvVariables(): void;
+    storeTerminalEnvVariables(data: string): void;
+}
+
+export class DispatchingBaseTerminalClient {
+
+    protected readonly clients = new Set<IBaseTerminalClient>();
+
+    push(client: IBaseTerminalClient): Disposable {
+        this.clients.add(client);
+        return Disposable.create(() => this.clients.delete(client));
+    }
+
+    onTerminalExitChanged(event: IBaseTerminalExitEvent): void {
+        this.clients.forEach(c => {
+            try {
+                c.onTerminalExitChanged(event);
+            } catch (e) {
+                console.error(e);
+            }
+        });
+    }
+
+    onTerminalError(event: IBaseTerminalErrorEvent): void {
+
+        this.clients.forEach(c => {
+            try {
+                c.onTerminalError(event);
+            } catch (e) {
+                console.error(e);
+            }
+        });
+    }
+
+    updateTerminalEnvVariables(): void {
+        this.clients.forEach(c => {
+            try {
+                c.updateTerminalEnvVariables();
+            } catch (e) {
+                console.error(e);
+            }
+        });
+    }
+
+    storeTerminalEnvVariables(data: string): void {
+        this.clients.forEach(c => {
+            try {
+                c.storeTerminalEnvVariables(data);
+            } catch (e) {
+                console.error(e);
+            }
+        });
+    }
+}

package/src/common/shell-terminal-protocol.ts

@@ -1,103 +1,103 @@
-// *****************************************************************************
-// Copyright (C) 2017 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-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { RpcProxy } from '@theia/core';
-import { IBaseTerminalServer, IBaseTerminalServerOptions } from './base-terminal-protocol';
-import { OS } from '@theia/core/lib/common/os';
-import { MarkdownString } from '@theia/core/lib/common/markdown-rendering/markdown-string';
-
-export const IShellTerminalServer = Symbol('IShellTerminalServer');
-
-export interface IShellTerminalServer extends IBaseTerminalServer {
-    hasChildProcesses(processId: number | undefined): Promise<boolean>;
-    getEnvVarCollectionDescriptionsByExtension(id: number): Promise<Map<string, (string | MarkdownString | undefined)[]>>;
-    getEnvVarCollections(): Promise<[string, string, boolean, SerializableEnvironmentVariableCollection][]>;
-
-    restorePersisted(jsonValue: string): void;
-    /**
-     * Sets an extension's environment variable collection.
-     */
-    setCollection(extensionIdentifier: string, rootUri: string, persistent: boolean,
-        collection: SerializableEnvironmentVariableCollection, description: string | MarkdownString | undefined): void;
-    /**
-     * Deletes an extension's environment variable collection.
-     */
-    deleteCollection(extensionIdentifier: string): void;
-}
-
-export const shellTerminalPath = '/services/shell-terminal';
-
-export type ShellTerminalOSPreferences<T> = {
-    [key in OS.Type]: T
-};
-
-export interface IShellTerminalPreferences {
-    shell: ShellTerminalOSPreferences<string | undefined>,
-    shellArgs: ShellTerminalOSPreferences<string[]>
-};
-
-export interface IShellTerminalServerOptions extends IBaseTerminalServerOptions {
-    shell?: string,
-    args?: string[] | string,
-    rootURI?: string,
-    cols?: number,
-    rows?: number,
-    env?: { [key: string]: string | null },
-    strictEnv?: boolean,
-    isPseudo?: boolean,
-}
-
-export const ShellTerminalServerProxy = Symbol('ShellTerminalServerProxy');
-export type ShellTerminalServerProxy = RpcProxy<IShellTerminalServer>;
-
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-// some code copied and modified from https://github.com/microsoft/vscode/blob/1.49.0/src/vs/workbench/contrib/terminal/common/environmentVariable.ts
-
-export const NO_ROOT_URI = '<none>';
-
-export interface EnvironmentVariableCollection {
-    readonly variableMutators: ReadonlyMap<string, EnvironmentVariableMutator>;
-    readonly description: string | MarkdownString | undefined;
-}
-
-export interface EnvironmentVariableCollectionWithPersistence extends EnvironmentVariableCollection {
-    readonly persistent: boolean;
-}
-
-export enum EnvironmentVariableMutatorType {
-    Replace = 1,
-    Append = 2,
-    Prepend = 3
-}
-
-export interface EnvironmentVariableMutatorOptions {
-    applyAtProcessCreation?: boolean;
-}
-
-export interface EnvironmentVariableMutator {
-    readonly value: string;
-    readonly type: EnvironmentVariableMutatorType;
-    readonly options: EnvironmentVariableMutatorOptions;
-}
-
-export interface SerializableEnvironmentVariableCollection {
-    readonly description: string | MarkdownString | undefined;
-    readonly mutators: [string, EnvironmentVariableMutator][]
-};
-
+// *****************************************************************************
+// Copyright (C) 2017 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-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { RpcProxy } from '@theia/core';
+import { IBaseTerminalServer, IBaseTerminalServerOptions } from './base-terminal-protocol';
+import { OS } from '@theia/core/lib/common/os';
+import { MarkdownString } from '@theia/core/lib/common/markdown-rendering/markdown-string';
+
+export const IShellTerminalServer = Symbol('IShellTerminalServer');
+
+export interface IShellTerminalServer extends IBaseTerminalServer {
+    hasChildProcesses(processId: number | undefined): Promise<boolean>;
+    getEnvVarCollectionDescriptionsByExtension(id: number): Promise<Map<string, (string | MarkdownString | undefined)[]>>;
+    getEnvVarCollections(): Promise<[string, string, boolean, SerializableEnvironmentVariableCollection][]>;
+
+    restorePersisted(jsonValue: string): void;
+    /**
+     * Sets an extension's environment variable collection.
+     */
+    setCollection(extensionIdentifier: string, rootUri: string, persistent: boolean,
+        collection: SerializableEnvironmentVariableCollection, description: string | MarkdownString | undefined): void;
+    /**
+     * Deletes an extension's environment variable collection.
+     */
+    deleteCollection(extensionIdentifier: string): void;
+}
+
+export const shellTerminalPath = '/services/shell-terminal';
+
+export type ShellTerminalOSPreferences<T> = {
+    [key in OS.Type]: T
+};
+
+export interface IShellTerminalPreferences {
+    shell: ShellTerminalOSPreferences<string | undefined>,
+    shellArgs: ShellTerminalOSPreferences<string[]>
+};
+
+export interface IShellTerminalServerOptions extends IBaseTerminalServerOptions {
+    shell?: string,
+    args?: string[] | string,
+    rootURI?: string,
+    cols?: number,
+    rows?: number,
+    env?: { [key: string]: string | null },
+    strictEnv?: boolean,
+    isPseudo?: boolean,
+}
+
+export const ShellTerminalServerProxy = Symbol('ShellTerminalServerProxy');
+export type ShellTerminalServerProxy = RpcProxy<IShellTerminalServer>;
+
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+// some code copied and modified from https://github.com/microsoft/vscode/blob/1.49.0/src/vs/workbench/contrib/terminal/common/environmentVariable.ts
+
+export const NO_ROOT_URI = '<none>';
+
+export interface EnvironmentVariableCollection {
+    readonly variableMutators: ReadonlyMap<string, EnvironmentVariableMutator>;
+    readonly description: string | MarkdownString | undefined;
+}
+
+export interface EnvironmentVariableCollectionWithPersistence extends EnvironmentVariableCollection {
+    readonly persistent: boolean;
+}
+
+export enum EnvironmentVariableMutatorType {
+    Replace = 1,
+    Append = 2,
+    Prepend = 3
+}
+
+export interface EnvironmentVariableMutatorOptions {
+    applyAtProcessCreation?: boolean;
+}
+
+export interface EnvironmentVariableMutator {
+    readonly value: string;
+    readonly type: EnvironmentVariableMutatorType;
+    readonly options: EnvironmentVariableMutatorOptions;
+}
+
+export interface SerializableEnvironmentVariableCollection {
+    readonly description: string | MarkdownString | undefined;
+    readonly mutators: [string, EnvironmentVariableMutator][]
+};
+

package/src/common/terminal-common-module.ts

@@ -1,30 +1,30 @@
-// *****************************************************************************
-// Copyright (C) 2018 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-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { interfaces } from '@theia/core/shared/inversify';
-import { ILogger } from '@theia/core';
-
-/**
- * Create the bindings common to node and browser.
- *
- * @param bind The bind function from inversify.
- */
-export function createCommonBindings(bind: interfaces.Bind): void {
-    bind(ILogger).toDynamicValue(ctx => {
-        const logger = ctx.container.get<ILogger>(ILogger);
-        return logger.child('terminal');
-    }).inSingletonScope().whenTargetNamed('terminal');
-}
+// *****************************************************************************
+// Copyright (C) 2018 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-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { interfaces } from '@theia/core/shared/inversify';
+import { ILogger } from '@theia/core';
+
+/**
+ * Create the bindings common to node and browser.
+ *
+ * @param bind The bind function from inversify.
+ */
+export function createCommonBindings(bind: interfaces.Bind): void {
+    bind(ILogger).toDynamicValue(ctx => {
+        const logger = ctx.container.get<ILogger>(ILogger);
+        return logger.child('terminal');
+    }).inSingletonScope().whenTargetNamed('terminal');
+}

package/src/common/terminal-protocol.ts

@@ -1,32 +1,32 @@
-// *****************************************************************************
-// Copyright (C) 2017 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-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { IBaseTerminalServer, IBaseTerminalServerOptions } from './base-terminal-protocol';
-
-export const ITerminalServer = Symbol('ITerminalServer');
-
-export const terminalPath = '/services/terminal';
-export const terminalsPath = '/services/terminals';
-
-export interface ITerminalServer extends IBaseTerminalServer {
-    create(ITerminalServerOptions: object): Promise<number>;
-}
-
-export interface ITerminalServerOptions extends IBaseTerminalServerOptions {
-    command: string,
-    args?: string[],
-    options?: object
-}
+// *****************************************************************************
+// Copyright (C) 2017 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-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { IBaseTerminalServer, IBaseTerminalServerOptions } from './base-terminal-protocol';
+
+export const ITerminalServer = Symbol('ITerminalServer');
+
+export const terminalPath = '/services/terminal';
+export const terminalsPath = '/services/terminals';
+
+export interface ITerminalServer extends IBaseTerminalServer {
+    create(ITerminalServerOptions: object): Promise<number>;
+}
+
+export interface ITerminalServerOptions extends IBaseTerminalServerOptions {
+    command: string,
+    args?: string[],
+    options?: object
+}