mirror of
https://github.com/binaricat/Netcatty.git
synced 2026-11-16 20:11:08 +00:00
* feat(terminal): Add configurable terminal bar cursor width Adds a configurable bar-cursor width for the terminal so thin vertical cursors are easier to find, particularly when vi/vim switches to insert mode. * Add terminal bar cursor width setting This adds the terminal bar cursor width control to the settings UI with an aria-label for accessibility and a matching test. It also adds localized labels/descriptions and search catalog entries so the setting is discoverable in both English and Chinese. * Fix terminal cursor width override bug Prevent width-only cursor updates from clearing DEC/vi cursor overrides by tracking the last applied shape/blink snapshot. The runtime now resets the snapshot on teardown, skips full cursor reapplication for width-only changes, and preserves remote bar/underline cursor styles. Added regression tests covering boot-time and later width updates. * Fix terminal cursor preference lifecycle Preserve DEC/vi cursor overrides during the first width-only terminal update after runtime creation. The runtime now records the user cursor preference snapshot when a term is published and applies width-only updates without clearing active cursor style or blink overrides. This prevents regressions when terminal settings change before the panel has fully booted. --------- Co-authored-by: bincxz <16399091+binaricat@users.noreply.github.com>
151 lines
4.6 KiB
TypeScript
151 lines
4.6 KiB
TypeScript
import type { IDisposable, Terminal as XTerm } from "@xterm/xterm";
|
|
import type { RefObject } from "react";
|
|
|
|
import type { TerminalSettings } from "../../../types";
|
|
import { normalizeCursorBarWidth } from "../../../domain/models/terminal";
|
|
|
|
type CursorPreferenceSettings = Pick<TerminalSettings, "cursorShape" | "cursorBlink" | "cursorBarWidth">;
|
|
|
|
export type CursorPreferenceSnapshot = Pick<
|
|
Required<CursorPreferenceSettings>,
|
|
"cursorShape" | "cursorBlink"
|
|
>;
|
|
|
|
type MutableCursorOptions = {
|
|
cursorStyle?: "block" | "bar" | "underline";
|
|
cursorBlink?: boolean;
|
|
cursorWidth?: number;
|
|
};
|
|
|
|
type TerminalLike = {
|
|
options: MutableCursorOptions;
|
|
parser?: {
|
|
registerCsiHandler?: (
|
|
id: { prefix?: string; intermediates?: string; final: string },
|
|
callback: (params: readonly (number | number[])[]) => boolean,
|
|
) => IDisposable;
|
|
};
|
|
_core?: {
|
|
coreService?: {
|
|
decPrivateModes?: {
|
|
cursorStyle?: "block" | "bar" | "underline";
|
|
cursorBlink?: boolean;
|
|
};
|
|
};
|
|
};
|
|
};
|
|
|
|
const scheduleAfterDefaultHandler = (callback: () => void): void => {
|
|
if (typeof queueMicrotask === "function") {
|
|
queueMicrotask(callback);
|
|
return;
|
|
}
|
|
|
|
setTimeout(callback, 0);
|
|
};
|
|
|
|
const hasCursorBlinkPrivateModeParam = (params: readonly (number | number[])[]): boolean => (
|
|
params.some((param) => (
|
|
Array.isArray(param)
|
|
? param.includes(12)
|
|
: param === 12
|
|
))
|
|
);
|
|
|
|
export const resolveUserCursorPreference = (
|
|
settings: Partial<CursorPreferenceSettings> | undefined,
|
|
): Required<CursorPreferenceSettings> => ({
|
|
cursorShape: settings?.cursorShape ?? "block",
|
|
cursorBlink: settings?.cursorBlink ?? true,
|
|
cursorBarWidth: normalizeCursorBarWidth(settings?.cursorBarWidth),
|
|
});
|
|
|
|
export const snapshotUserCursorPreference = (
|
|
settings: Partial<CursorPreferenceSettings> | undefined,
|
|
): CursorPreferenceSnapshot => {
|
|
const { cursorShape, cursorBlink } = resolveUserCursorPreference(settings);
|
|
return { cursorShape, cursorBlink };
|
|
};
|
|
|
|
export const shouldApplyUserCursorPreference = (
|
|
previous: CursorPreferenceSnapshot | null,
|
|
current: CursorPreferenceSnapshot,
|
|
): boolean => (
|
|
previous === null ||
|
|
previous.cursorShape !== current.cursorShape ||
|
|
previous.cursorBlink !== current.cursorBlink
|
|
);
|
|
|
|
export const applyUserCursorPreference = (
|
|
term: TerminalLike,
|
|
settings: Partial<CursorPreferenceSettings> | undefined,
|
|
): void => {
|
|
const preference = resolveUserCursorPreference(settings);
|
|
const privateModes = term._core?.coreService?.decPrivateModes;
|
|
if (privateModes) {
|
|
privateModes.cursorStyle = undefined;
|
|
privateModes.cursorBlink = undefined;
|
|
}
|
|
term.options.cursorStyle = preference.cursorShape;
|
|
term.options.cursorBlink = preference.cursorBlink;
|
|
term.options.cursorWidth = preference.cursorBarWidth;
|
|
};
|
|
|
|
export const applyUserCursorWidthPreference = (
|
|
term: TerminalLike,
|
|
settings: Partial<CursorPreferenceSettings> | undefined,
|
|
): void => {
|
|
term.options.cursorWidth = resolveUserCursorPreference(settings).cursorBarWidth;
|
|
};
|
|
|
|
export const applyUserCursorBlinkPreference = (
|
|
term: TerminalLike,
|
|
settings: Partial<CursorPreferenceSettings> | undefined,
|
|
): void => {
|
|
const preference = resolveUserCursorPreference(settings);
|
|
const privateModes = term._core?.coreService?.decPrivateModes;
|
|
if (privateModes) {
|
|
privateModes.cursorBlink = undefined;
|
|
}
|
|
term.options.cursorBlink = preference.cursorBlink;
|
|
};
|
|
|
|
export const installUserCursorPreferenceGuard = (
|
|
term: XTerm | TerminalLike,
|
|
terminalSettingsRef: RefObject<TerminalSettings | undefined>,
|
|
): IDisposable | null => {
|
|
const terminal = term as TerminalLike;
|
|
const parser = terminal.parser;
|
|
if (!parser?.registerCsiHandler) return null;
|
|
const registerCsiHandler = parser.registerCsiHandler.bind(parser);
|
|
|
|
const applyBlinkPreference = () => applyUserCursorBlinkPreference(terminal, terminalSettingsRef.current);
|
|
|
|
const cursorStyleDisposable = registerCsiHandler({ intermediates: " ", final: "q" }, () => {
|
|
scheduleAfterDefaultHandler(applyBlinkPreference);
|
|
return false;
|
|
});
|
|
|
|
const cursorBlinkSetDisposable = registerCsiHandler({ prefix: "?", final: "h" }, (params) => {
|
|
if (hasCursorBlinkPrivateModeParam(params)) {
|
|
scheduleAfterDefaultHandler(applyBlinkPreference);
|
|
}
|
|
return false;
|
|
});
|
|
|
|
const cursorBlinkResetDisposable = registerCsiHandler({ prefix: "?", final: "l" }, (params) => {
|
|
if (hasCursorBlinkPrivateModeParam(params)) {
|
|
scheduleAfterDefaultHandler(applyBlinkPreference);
|
|
}
|
|
return false;
|
|
});
|
|
|
|
return {
|
|
dispose: () => {
|
|
cursorStyleDisposable.dispose();
|
|
cursorBlinkSetDisposable.dispose();
|
|
cursorBlinkResetDisposable.dispose();
|
|
},
|
|
};
|
|
};
|