Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for OSC 4 ; color ; color spec #3163

Merged
merged 20 commits into from
Jan 11, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions src/browser/Terminal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ import { Linkifier2 } from 'browser/Linkifier2';
import { CoreBrowserService } from 'browser/services/CoreBrowserService';
import { CoreTerminal } from 'common/CoreTerminal';
import { ITerminalOptions as IInitializedTerminalOptions } from 'common/services/Services';
import { css } from 'browser/Color';

// Let it work inside Node.js for automated testing purposes.
const document: Document = (typeof window !== 'undefined') ? window.document : null as any;
Expand Down Expand Up @@ -150,13 +151,29 @@ export class Terminal extends CoreTerminal implements ITerminal {
this.register(this._inputHandler.onRequestWindowsOptionsReport(type => this._reportWindowsOptions(type)));
this.register(forwardEvent(this._inputHandler.onCursorMove, this._onCursorMove));
this.register(forwardEvent(this._inputHandler.onTitleChange, this._onTitleChange));
this.register(this._inputHandler.onAnsiColorChange((index, color) => this.changeAnsiColor(index, color)));
this.register(forwardEvent(this._inputHandler.onA11yChar, this._onA11yCharEmitter));
this.register(forwardEvent(this._inputHandler.onA11yTab, this._onA11yTabEmitter));

// Setup listeners
this.register(this._bufferService.onResize(e => this._afterResize(e.cols, e.rows)));
}

private changeAnsiColor(colorIndex: number, colorValue: string): void {
slawekzachcial marked this conversation as resolved.
Show resolved Hide resolved
// colorValue = rgb:xx/yy/zz
slawekzachcial marked this conversation as resolved.
Show resolved Hide resolved
const r = colorValue.substring(4, 6);
const g = colorValue.substring(7, 9);
const b = colorValue.substring(10, 12);
const color = `#${r}${g}${b}`;

//TODO: remove debug
console.log(`Change ANSI color[${colorIndex}]=${colorValue} (${color})`);

this._colorManager!.colors.ansi[colorIndex] = css.toColor(color);
slawekzachcial marked this conversation as resolved.
Show resolved Hide resolved
this._renderService?.setColors(this._colorManager!.colors);
this.viewport?.onThemeChange(this._colorManager!.colors);
}

public dispose(): void {
if (this._isDisposed) {
return;
Expand Down
17 changes: 17 additions & 0 deletions src/common/InputHandler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,8 @@ export class InputHandler extends Disposable implements IInputHandler {
public get onScroll(): IEvent<number> { return this._onScroll.event; }
private _onTitleChange = new EventEmitter<string>();
public get onTitleChange(): IEvent<string> { return this._onTitleChange.event; }
private _onAnsiColorChange = new EventEmitter<number, string>();
public get onAnsiColorChange(): IEvent<number, string> { return this._onAnsiColorChange.event; }

constructor(
private readonly _bufferService: IBufferService,
Expand Down Expand Up @@ -372,6 +374,12 @@ export class InputHandler extends Disposable implements IInputHandler {
this._parser.setOscHandler(2, new OscHandler((data: string) => this.setTitle(data)));
// 3 - set property X in the form "prop=value"
// 4 - Change Color Number
this._parser.setOscHandler(4, new OscHandler((data: string) => {
const ansiColor = data.split(';');
const colorIndex = parseInt(ansiColor[0]);
const colorValue = ansiColor[1];
this.setAnsiColor(colorIndex, colorValue);
}));
slawekzachcial marked this conversation as resolved.
Show resolved Hide resolved
// 5 - Change Special Color Number
// 6 - Enable/disable Special Color Number c
// 7 - current directory? (not in xterm spec, see https://gitlab.com/gnachman/iterm2/issues/3939)
Expand Down Expand Up @@ -2711,6 +2719,15 @@ export class InputHandler extends Disposable implements IInputHandler {
this._iconName = data;
}

/**
* OSC 4; <num> ; <text> ST (set ANSI color <num> to <text>)
*/
public setAnsiColor(colorIndex: number, colorData: string): void {
//TODO: remove debug
console.log(`Setting ANSI color ${colorIndex} to value ${colorData}`);
this._onAnsiColorChange.fire(colorIndex, colorData);
}

/**
* ESC E
* C1.NEL
Expand Down
1 change: 1 addition & 0 deletions src/common/Types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,7 @@ export interface IInputHandler {
/** CSI ' ~ */ deleteColumns(params: IParams): void;
/** OSC 0
OSC 2 */ setTitle(data: string): void;
/** OSC 4 */ setAnsiColor(colorIndex: number, colorData: string): void;
/** ESC E */ nextLine(): void;
/** ESC = */ keypadApplicationMode(): void;
/** ESC > */ keypadNumericMode(): void;
Expand Down