|
| 1 | +/** |
| 2 | + * Copyright (c) 2024 The xterm.js authors. All rights reserved. |
| 3 | + * @license MIT |
| 4 | + */ |
| 5 | + |
| 6 | +import type { Terminal, ITerminalAddon, IDisposable } from '@xterm/xterm'; |
| 7 | +import type { ProgressAddon as IProgressApi, IProgressState } from '@xterm/addon-progress'; |
| 8 | +import type { Emitter, Event } from 'vs/base/common/event'; |
| 9 | + |
| 10 | + |
| 11 | +const enum ProgressType { |
| 12 | + REMOVE = 0, |
| 13 | + SET = 1, |
| 14 | + ERROR = 2, |
| 15 | + INDETERMINATE = 3, |
| 16 | + PAUSE = 4 |
| 17 | +} |
| 18 | + |
| 19 | + |
| 20 | +/** |
| 21 | + * Strict integer parsing, only decimal digits allowed. |
| 22 | + */ |
| 23 | +function toInt(s: string): number { |
| 24 | + let v = 0; |
| 25 | + for (let i = 0; i < s.length; ++i) { |
| 26 | + const c = s.charCodeAt(i); |
| 27 | + if (c < 0x30 || 0x39 < c) { |
| 28 | + return -1; |
| 29 | + } |
| 30 | + v = v * 10 + c - 48; |
| 31 | + } |
| 32 | + return v; |
| 33 | +} |
| 34 | + |
| 35 | + |
| 36 | +export class ProgressAddon implements ITerminalAddon, IProgressApi { |
| 37 | + private _seqHandler: IDisposable | undefined; |
| 38 | + private _st: ProgressType = ProgressType.REMOVE; |
| 39 | + private _pr = 0; |
| 40 | + private _onChange: Emitter<IProgressState> | undefined; |
| 41 | + public onChange: Event<IProgressState> | undefined; |
| 42 | + |
| 43 | + public dispose(): void { |
| 44 | + this._seqHandler?.dispose(); |
| 45 | + this._onChange?.dispose(); |
| 46 | + } |
| 47 | + |
| 48 | + public activate(terminal: Terminal): void { |
| 49 | + this._seqHandler = terminal.parser.registerOscHandler(9, data => { |
| 50 | + if (!data.startsWith('4;')) { |
| 51 | + return false; |
| 52 | + } |
| 53 | + const parts = data.split(';'); |
| 54 | + |
| 55 | + if (parts.length > 3) { |
| 56 | + return true; // faulty sequence, just exit |
| 57 | + } |
| 58 | + if (parts.length === 2) { |
| 59 | + parts.push(''); |
| 60 | + } |
| 61 | + const st = toInt(parts[1]); |
| 62 | + const pr = toInt(parts[2]); |
| 63 | + |
| 64 | + switch (st) { |
| 65 | + case ProgressType.REMOVE: |
| 66 | + this.progress = { state: st, value: 0 }; |
| 67 | + break; |
| 68 | + case ProgressType.SET: |
| 69 | + if (pr < 0) return true; // faulty sequence, just exit |
| 70 | + this.progress = { state: st, value: pr }; |
| 71 | + break; |
| 72 | + case ProgressType.ERROR: |
| 73 | + case ProgressType.PAUSE: |
| 74 | + if (pr < 0) return true; // faulty sequence, just exit |
| 75 | + this.progress = { state: st, value: pr || this._pr }; |
| 76 | + break; |
| 77 | + case ProgressType.INDETERMINATE: |
| 78 | + this.progress = { state: st, value: this._pr }; |
| 79 | + break; |
| 80 | + } |
| 81 | + return true; |
| 82 | + }); |
| 83 | + // FIXME: borrow emitter ctor from xterm, to be changed once #5283 is resolved |
| 84 | + this._onChange = new (terminal as any)._core._onData.constructor(); |
| 85 | + this.onChange = this._onChange!.event; |
| 86 | + } |
| 87 | + |
| 88 | + public get progress(): IProgressState { |
| 89 | + return { state: this._st, value: this._pr }; |
| 90 | + } |
| 91 | + |
| 92 | + public set progress(progress: IProgressState) { |
| 93 | + if (progress.state < 0 || progress.state > 4) { |
| 94 | + console.warn(`progress state out of bounds, not applied`); |
| 95 | + return; |
| 96 | + } |
| 97 | + this._st = progress.state; |
| 98 | + this._pr = Math.min(Math.max(progress.value, 0), 100); |
| 99 | + this._onChange?.fire({ state: this._st, value: this._pr }); |
| 100 | + } |
| 101 | +} |
0 commit comments