Make options available in terminal
This commit is contained in:
@@ -152,7 +152,7 @@ export class Terminal extends CoreTerminal implements ITerminal {
|
|||||||
* @alias module:xterm/src/xterm
|
* @alias module:xterm/src/xterm
|
||||||
*/
|
*/
|
||||||
constructor(
|
constructor(
|
||||||
options: ITerminalOptions = {}
|
options: Partial<ITerminalOptions> = {}
|
||||||
) {
|
) {
|
||||||
super(options);
|
super(options);
|
||||||
|
|
||||||
|
|||||||
@@ -89,6 +89,9 @@ export class Terminal implements ITerminalApi {
|
|||||||
wraparoundMode: m.wraparound
|
wraparoundMode: m.wraparound
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
public get options(): ITerminalOptions {
|
||||||
|
return this._core.options;
|
||||||
|
}
|
||||||
public blur(): void {
|
public blur(): void {
|
||||||
this._core.blur();
|
this._core.blur();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -86,9 +86,10 @@ export abstract class CoreTerminal extends Disposable implements ICoreTerminal {
|
|||||||
public get cols(): number { return this._bufferService.cols; }
|
public get cols(): number { return this._bufferService.cols; }
|
||||||
public get rows(): number { return this._bufferService.rows; }
|
public get rows(): number { return this._bufferService.rows; }
|
||||||
public get buffers(): IBufferSet { return this._bufferService.buffers; }
|
public get buffers(): IBufferSet { return this._bufferService.buffers; }
|
||||||
|
public get options(): ITerminalOptions { return this.optionsService.options; }
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
options: ITerminalOptions
|
options: Partial<ITerminalOptions>
|
||||||
) {
|
) {
|
||||||
super();
|
super();
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
* @license MIT
|
* @license MIT
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { IBufferService, ICoreService, ILogService, IOptionsService, ITerminalOptions, IPartialTerminalOptions, IDirtyRowService, ICoreMouseService, ICharsetService, IUnicodeService, IUnicodeVersionProvider, LogLevelEnum } from 'common/services/Services';
|
import { IBufferService, ICoreService, ILogService, IOptionsService, ITerminalOptions, IDirtyRowService, ICoreMouseService, ICharsetService, IUnicodeService, IUnicodeVersionProvider, LogLevelEnum } from 'common/services/Services';
|
||||||
import { IEvent, EventEmitter } from 'common/EventEmitter';
|
import { IEvent, EventEmitter } from 'common/EventEmitter';
|
||||||
import { clone } from 'common/Clone';
|
import { clone } from 'common/Clone';
|
||||||
import { DEFAULT_OPTIONS } from 'common/services/OptionsService';
|
import { DEFAULT_OPTIONS } from 'common/services/OptionsService';
|
||||||
@@ -122,10 +122,10 @@ export class MockOptionsService implements IOptionsService {
|
|||||||
public serviceBrand: any;
|
public serviceBrand: any;
|
||||||
public options: ITerminalOptions = clone(DEFAULT_OPTIONS);
|
public options: ITerminalOptions = clone(DEFAULT_OPTIONS);
|
||||||
public onOptionChange: IEvent<string> = new EventEmitter<string>().event;
|
public onOptionChange: IEvent<string> = new EventEmitter<string>().event;
|
||||||
constructor(testOptions?: IPartialTerminalOptions) {
|
constructor(testOptions?: Partial<ITerminalOptions>) {
|
||||||
if (testOptions) {
|
if (testOptions) {
|
||||||
for (const key of Object.keys(testOptions)) {
|
for (const key of Object.keys(testOptions)) {
|
||||||
this.options[key] = (testOptions as any)[key];
|
this.options[key] = testOptions[key];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Vendored
+1
@@ -16,6 +16,7 @@ export interface ICoreTerminal {
|
|||||||
optionsService: IOptionsService;
|
optionsService: IOptionsService;
|
||||||
unicodeService: IUnicodeService;
|
unicodeService: IUnicodeService;
|
||||||
buffers: IBufferSet;
|
buffers: IBufferSet;
|
||||||
|
options: ITerminalOptions;
|
||||||
registerCsiHandler(id: IFunctionIdentifier, callback: (params: IParams) => boolean | Promise<boolean>): IDisposable;
|
registerCsiHandler(id: IFunctionIdentifier, callback: (params: IParams) => boolean | Promise<boolean>): IDisposable;
|
||||||
registerDcsHandler(id: IFunctionIdentifier, callback: (data: string, param: IParams) => boolean | Promise<boolean>): IDisposable;
|
registerDcsHandler(id: IFunctionIdentifier, callback: (data: string, param: IParams) => boolean | Promise<boolean>): IDisposable;
|
||||||
registerEscHandler(id: IFunctionIdentifier, callback: () => boolean | Promise<boolean>): IDisposable;
|
registerEscHandler(id: IFunctionIdentifier, callback: () => boolean | Promise<boolean>): IDisposable;
|
||||||
|
|||||||
@@ -3,10 +3,9 @@
|
|||||||
* @license MIT
|
* @license MIT
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { IOptionsService, ITerminalOptions, IPartialTerminalOptions, FontWeight } from 'common/services/Services';
|
import { IOptionsService, ITerminalOptions, FontWeight } from 'common/services/Services';
|
||||||
import { EventEmitter, IEvent } from 'common/EventEmitter';
|
import { EventEmitter, IEvent } from 'common/EventEmitter';
|
||||||
import { isMac } from 'common/Platform';
|
import { isMac } from 'common/Platform';
|
||||||
import { clone } from 'common/Clone';
|
|
||||||
|
|
||||||
// Source: https://freesound.org/people/altemark/sounds/45759/
|
// Source: https://freesound.org/people/altemark/sounds/45759/
|
||||||
// This sound is released under the Creative Commons Attribution 3.0 Unported
|
// This sound is released under the Creative Commons Attribution 3.0 Unported
|
||||||
@@ -14,15 +13,14 @@ import { clone } from 'common/Clone';
|
|||||||
// made, apart from the conversion to base64.
|
// made, apart from the conversion to base64.
|
||||||
export const DEFAULT_BELL_SOUND = 'data:audio/mp3;base64,SUQzBAAAAAAAI1RTU0UAAAAPAAADTGF2ZjU4LjMyLjEwNAAAAAAAAAAAAAAA//tQxAADB8AhSmxhIIEVCSiJrDCQBTcu3UrAIwUdkRgQbFAZC1CQEwTJ9mjRvBA4UOLD8nKVOWfh+UlK3z/177OXrfOdKl7pyn3Xf//WreyTRUoAWgBgkOAGbZHBgG1OF6zM82DWbZaUmMBptgQhGjsyYqc9ae9XFz280948NMBWInljyzsNRFLPWdnZGWrddDsjK1unuSrVN9jJsK8KuQtQCtMBjCEtImISdNKJOopIpBFpNSMbIHCSRpRR5iakjTiyzLhchUUBwCgyKiweBv/7UsQbg8isVNoMPMjAAAA0gAAABEVFGmgqK////9bP/6XCykxBTUUzLjEwMKqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq';
|
export const DEFAULT_BELL_SOUND = 'data:audio/mp3;base64,SUQzBAAAAAAAI1RTU0UAAAAPAAADTGF2ZjU4LjMyLjEwNAAAAAAAAAAAAAAA//tQxAADB8AhSmxhIIEVCSiJrDCQBTcu3UrAIwUdkRgQbFAZC1CQEwTJ9mjRvBA4UOLD8nKVOWfh+UlK3z/177OXrfOdKl7pyn3Xf//WreyTRUoAWgBgkOAGbZHBgG1OF6zM82DWbZaUmMBptgQhGjsyYqc9ae9XFz280948NMBWInljyzsNRFLPWdnZGWrddDsjK1unuSrVN9jJsK8KuQtQCtMBjCEtImISdNKJOopIpBFpNSMbIHCSRpRR5iakjTiyzLhchUUBwCgyKiweBv/7UsQbg8isVNoMPMjAAAA0gAAABEVFGmgqK////9bP/6XCykxBTUUzLjEwMKqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq';
|
||||||
|
|
||||||
// TODO: Freeze?
|
export const DEFAULT_OPTIONS: Readonly<ITerminalOptions> = {
|
||||||
export const DEFAULT_OPTIONS: ITerminalOptions = Object.freeze({
|
|
||||||
cols: 80,
|
cols: 80,
|
||||||
rows: 24,
|
rows: 24,
|
||||||
cursorBlink: false,
|
cursorBlink: false,
|
||||||
cursorStyle: 'block',
|
cursorStyle: 'block',
|
||||||
cursorWidth: 1,
|
cursorWidth: 1,
|
||||||
customGlyphs: true,
|
customGlyphs: true,
|
||||||
bellSound: DEFAULT_BELL_SOUND,
|
bellSound: DEFAULT_BELL_SOUND,
|
||||||
bellStyle: 'none',
|
bellStyle: 'none',
|
||||||
drawBoldTextInBrightColors: true,
|
drawBoldTextInBrightColors: true,
|
||||||
fastScrollModifier: 'alt',
|
fastScrollModifier: 'alt',
|
||||||
@@ -55,7 +53,7 @@ export const DEFAULT_OPTIONS: ITerminalOptions = Object.freeze({
|
|||||||
convertEol: false,
|
convertEol: false,
|
||||||
termName: 'xterm',
|
termName: 'xterm',
|
||||||
cancelEvents: false
|
cancelEvents: false
|
||||||
});
|
};
|
||||||
|
|
||||||
const FONT_WEIGHT_OPTIONS: Extract<FontWeight, string>[] = ['normal', 'bold', '100', '200', '300', '400', '500', '600', '700', '800', '900'];
|
const FONT_WEIGHT_OPTIONS: Extract<FontWeight, string>[] = ['normal', 'bold', '100', '200', '300', '400', '500', '600', '700', '800', '900'];
|
||||||
|
|
||||||
@@ -67,45 +65,57 @@ const CONSTRUCTOR_ONLY_OPTIONS = ['cols', 'rows'];
|
|||||||
export class OptionsService implements IOptionsService {
|
export class OptionsService implements IOptionsService {
|
||||||
public serviceBrand: any;
|
public serviceBrand: any;
|
||||||
|
|
||||||
|
private _options: any;
|
||||||
public options: ITerminalOptions;
|
public options: ITerminalOptions;
|
||||||
|
|
||||||
private _onOptionChange = new EventEmitter<string>();
|
private _onOptionChange = new EventEmitter<string>();
|
||||||
public get onOptionChange(): IEvent<string> { return this._onOptionChange.event; }
|
public get onOptionChange(): IEvent<string> { return this._onOptionChange.event; }
|
||||||
|
|
||||||
constructor(options: IPartialTerminalOptions) {
|
constructor(options: Partial<ITerminalOptions>) {
|
||||||
this.options = clone(DEFAULT_OPTIONS);
|
this.options = { ... DEFAULT_OPTIONS };
|
||||||
for (const k of Object.keys(options)) {
|
for (const key in options) {
|
||||||
if (k in this.options) {
|
if (key in this.options) {
|
||||||
try {
|
try {
|
||||||
const newValue = options[k as keyof IPartialTerminalOptions] as any;
|
const newValue = options[key];
|
||||||
this.options[k] = this._sanitizeAndValidateOption(k, newValue);
|
this.options[key] = this._sanitizeAndValidateOption(key, newValue);
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
console.error(e);
|
console.error(e);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
this._options = {};
|
||||||
|
for (const propName in this.options) {
|
||||||
|
const privatePropName = `_${propName}`;
|
||||||
|
this._options[privatePropName] = this.options[propName];
|
||||||
|
Object.defineProperty(this.options, propName, {
|
||||||
|
get: () => {
|
||||||
|
if (!(propName in DEFAULT_OPTIONS)) {
|
||||||
|
throw new Error(`No option with key "${propName}"`);
|
||||||
|
}
|
||||||
|
return this._options[privatePropName];
|
||||||
|
},
|
||||||
|
set: (value: any) => {
|
||||||
|
if (!(propName in DEFAULT_OPTIONS)) {
|
||||||
|
throw new Error('No option with key "' + propName + '"');
|
||||||
|
}
|
||||||
|
if (CONSTRUCTOR_ONLY_OPTIONS.includes(propName)) {
|
||||||
|
throw new Error(`Option "${propName}" can only be set in the constructor`);
|
||||||
|
}
|
||||||
|
|
||||||
|
value = this._sanitizeAndValidateOption(propName, value);
|
||||||
|
// Don't fire an option change event if they didn't change
|
||||||
|
if (this._options[privatePropName] !== value) {
|
||||||
|
this._options[privatePropName] = value;
|
||||||
|
this._onOptionChange.fire(propName);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public setOption(key: string, value: any): void {
|
public setOption(key: string, value: any): void {
|
||||||
if (!(key in DEFAULT_OPTIONS)) {
|
|
||||||
throw new Error('No option with key "' + key + '"');
|
|
||||||
}
|
|
||||||
if (CONSTRUCTOR_ONLY_OPTIONS.includes(key)) {
|
|
||||||
throw new Error(`Option "${key}" can only be set in the constructor`);
|
|
||||||
}
|
|
||||||
if (this.options[key] === value) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
value = this._sanitizeAndValidateOption(key, value);
|
|
||||||
|
|
||||||
// Don't fire an option change event if they didn't change
|
|
||||||
if (this.options[key] === value) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
this.options[key] = value;
|
this.options[key] = value;
|
||||||
this._onOptionChange.fire(key);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
private _sanitizeAndValidateOption(key: string, value: any): any {
|
private _sanitizeAndValidateOption(key: string, value: any): any {
|
||||||
@@ -128,7 +138,7 @@ export class OptionsService implements IOptionsService {
|
|||||||
break;
|
break;
|
||||||
case 'cursorWidth':
|
case 'cursorWidth':
|
||||||
value = Math.floor(value);
|
value = Math.floor(value);
|
||||||
// Fall through for bounds check
|
// Fall through for bounds check
|
||||||
case 'lineHeight':
|
case 'lineHeight':
|
||||||
case 'tabStopWidth':
|
case 'tabStopWidth':
|
||||||
if (value < 1) {
|
if (value < 1) {
|
||||||
@@ -155,9 +165,6 @@ export class OptionsService implements IOptionsService {
|
|||||||
}
|
}
|
||||||
|
|
||||||
public getOption(key: string): any {
|
public getOption(key: string): any {
|
||||||
if (!(key in DEFAULT_OPTIONS)) {
|
|
||||||
throw new Error(`No option with key "${key}"`);
|
|
||||||
}
|
|
||||||
return this.options[key];
|
return this.options[key];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -198,56 +198,27 @@ export enum LogLevelEnum {
|
|||||||
OFF = 4
|
OFF = 4
|
||||||
}
|
}
|
||||||
export type RendererType = 'dom' | 'canvas';
|
export type RendererType = 'dom' | 'canvas';
|
||||||
|
export type BellStyle = 'none' | 'sound' /* | 'visual' | 'both' */;
|
||||||
|
export type CursorStyle = 'block' | 'underline' | 'bar';
|
||||||
|
export type FastScrollModifier = 'alt' | 'ctrl' | 'shift';
|
||||||
|
|
||||||
export interface IPartialTerminalOptions {
|
|
||||||
altClickMovesCursor?: boolean;
|
|
||||||
allowTransparency?: boolean;
|
|
||||||
bellSound?: string;
|
|
||||||
bellStyle?: 'none' | 'sound' /* | 'visual' | 'both' */;
|
|
||||||
cols?: number;
|
|
||||||
cursorBlink?: boolean;
|
|
||||||
cursorStyle?: 'block' | 'underline' | 'bar';
|
|
||||||
cursorWidth?: number;
|
|
||||||
disableStdin?: boolean;
|
|
||||||
drawBoldTextInBrightColors?: boolean;
|
|
||||||
fastScrollModifier?: 'alt' | 'ctrl' | 'shift';
|
|
||||||
fastScrollSensitivity?: number;
|
|
||||||
fontSize?: number;
|
|
||||||
fontFamily?: string;
|
|
||||||
fontWeight?: FontWeight;
|
|
||||||
fontWeightBold?: FontWeight;
|
|
||||||
letterSpacing?: number;
|
|
||||||
lineHeight?: number;
|
|
||||||
logLevel?: LogLevel;
|
|
||||||
macOptionIsMeta?: boolean;
|
|
||||||
macOptionClickForcesSelection?: boolean;
|
|
||||||
rendererType?: RendererType;
|
|
||||||
rightClickSelectsWord?: boolean;
|
|
||||||
rows?: number;
|
|
||||||
screenReaderMode?: boolean;
|
|
||||||
scrollback?: number;
|
|
||||||
scrollSensitivity?: number;
|
|
||||||
tabStopWidth?: number;
|
|
||||||
theme?: ITheme;
|
|
||||||
windowsMode?: boolean;
|
|
||||||
wordSeparator?: string;
|
|
||||||
windowOptions?: IWindowOptions;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface ITerminalOptions {
|
export interface ITerminalOptions {
|
||||||
allowProposedApi: boolean;
|
allowProposedApi: boolean;
|
||||||
allowTransparency: boolean;
|
allowTransparency: boolean;
|
||||||
altClickMovesCursor: boolean;
|
altClickMovesCursor: boolean;
|
||||||
bellSound: string;
|
bellSound: string;
|
||||||
bellStyle: 'none' | 'sound' /* | 'visual' | 'both' */;
|
bellStyle: BellStyle;
|
||||||
|
cancelEvents: boolean;
|
||||||
cols: number;
|
cols: number;
|
||||||
|
convertEol: boolean;
|
||||||
cursorBlink: boolean;
|
cursorBlink: boolean;
|
||||||
cursorStyle: 'block' | 'underline' | 'bar';
|
cursorStyle: CursorStyle;
|
||||||
cursorWidth: number;
|
cursorWidth: number;
|
||||||
customGlyphs: boolean;
|
customGlyphs: boolean;
|
||||||
disableStdin: boolean;
|
disableStdin: boolean;
|
||||||
drawBoldTextInBrightColors: boolean;
|
drawBoldTextInBrightColors: boolean;
|
||||||
fastScrollModifier: 'alt' | 'ctrl' | 'shift' | undefined;
|
fastScrollModifier: FastScrollModifier | undefined;
|
||||||
fastScrollSensitivity: number;
|
fastScrollSensitivity: number;
|
||||||
fontSize: number;
|
fontSize: number;
|
||||||
fontFamily: string;
|
fontFamily: string;
|
||||||
@@ -267,15 +238,13 @@ export interface ITerminalOptions {
|
|||||||
scrollback: number;
|
scrollback: number;
|
||||||
scrollSensitivity: number;
|
scrollSensitivity: number;
|
||||||
tabStopWidth: number;
|
tabStopWidth: number;
|
||||||
|
termName: string;
|
||||||
theme: ITheme;
|
theme: ITheme;
|
||||||
windowsMode: boolean;
|
windowsMode: boolean;
|
||||||
windowOptions: IWindowOptions;
|
windowOptions: IWindowOptions;
|
||||||
wordSeparator: string;
|
wordSeparator: string;
|
||||||
|
|
||||||
[key: string]: any;
|
[key: string]: any;
|
||||||
cancelEvents: boolean;
|
|
||||||
convertEol: boolean;
|
|
||||||
termName: string;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ITheme {
|
export interface ITheme {
|
||||||
|
|||||||
Vendored
+5
@@ -635,6 +635,11 @@ declare module 'xterm' {
|
|||||||
*/
|
*/
|
||||||
readonly modes: IModes;
|
readonly modes: IModes;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the terminal options
|
||||||
|
*/
|
||||||
|
readonly options: ITerminalOptions;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Natural language strings that can be localized.
|
* Natural language strings that can be localized.
|
||||||
*/
|
*/
|
||||||
|
|||||||
Reference in New Issue
Block a user