API to retrieve a dimensions from a given Terminal instance

[alpaix]

VS Live Share extension needs to know current dimensions of a terminal and also to get notified when they're getting changed.

Consider adding a new API to get read-only access to a terminal renderer associated with given terminal instance.

[Tyriar]

Would exposing this would also solve the issue?

export interface TerminalRenderer {
		dimensions: TerminalDimensions | undefined;

		readonly onDidChangeDimensions: Event<TerminalDimensions>;
}

[alpaix]

@Tyriar Yes. That'd solve it. In addition to that we need a method to get a renderer instance:

    vscode.window.onDidOpenTerminal(async terminal => {
        // HOW to get a renderer instance out of the terminal?
        const render = terminal.renderer;
        renderer.onDidChangeDimensions(d => { … });
        await this.terminalProvider.shareTerminal(terminal, this.trace);
    });

[Tyriar]

Opps, copy and paste mistake above, I mean adding those properties on Terminal, not TerminalRenderer:

export interface Terminal {
		dimensions: TerminalDimensions;

		readonly onDidChangeDimensions: Event<TerminalDimensions>;
}

[alpaix]

Sure. That'd be sufficient to meet our needs!

[alexr00]

This API is still in proposed.

[Tyriar]

I didn't actually want this verified, it will be looked at with #58660

[Tyriar]

Related: #79246

[Tyriar]

AFAIK this API isn't being used yet as #79246 is needed.

vscode/src/vs/vscode.proposed.d.ts

Lines 808 to 840 in 94c6893

	//#region Terminal dimensions property and change event https://github.com/microsoft/vscode/issues/55718
	/**
	* An [event](#Event) which fires when a [Terminal](#Terminal)'s dimensions change.
	*/
	export interface TerminalDimensionsChangeEvent {
	/**
	* The [terminal](#Terminal) for which the dimensions have changed.
	*/
	readonly terminal: Terminal;
	/**
	* The new value for the [terminal's dimensions](#Terminal.dimensions).
	*/
	readonly dimensions: TerminalDimensions;
	}
	namespace window {
	/**
	* An event which fires when the [dimensions](#Terminal.dimensions) of the terminal change.
	*/
	export const onDidChangeTerminalDimensions: Event<TerminalDimensionsChangeEvent>;
	}
	export interface Terminal {
	/**
	* The current dimensions of the terminal. This will be `undefined` immediately after the
	* terminal is created as the dimensions are not known until shortly after the terminal is
	* created.
	*/
	readonly dimensions: TerminalDimensions | undefined;
	}
	//#endregion

cc @IlyaBiryukov