@visulima/ansi 4.0.0-alpha.12 → 4.0.0-alpha.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +27 -0
- package/LICENSE.md +0 -3
- package/README.md +3 -0
- package/dist/alternative-screen.d.ts +71 -70
- package/dist/alternative-screen.js +1 -8
- package/dist/clear.d.ts +74 -73
- package/dist/clear.js +1 -10
- package/dist/cursor.d.ts +421 -406
- package/dist/cursor.js +1 -3
- package/dist/erase.d.ts +193 -192
- package/dist/erase.js +1 -47
- package/dist/hyperlink.d.ts +25 -25
- package/dist/hyperlink.js +1 -5
- package/dist/image.d.ts +71 -70
- package/dist/image.js +1 -40
- package/dist/index.d.ts +65 -35
- package/dist/index.js +1 -26
- package/dist/iterm2.d.ts +285 -58
- package/dist/iterm2.js +1 -12
- package/dist/mode.d.ts +585 -584
- package/dist/mode.js +1 -245
- package/dist/mouse.d.ts +227 -226
- package/dist/mouse.js +1 -106
- package/dist/packem_shared/IT2_AUTO-OiB8EaxU.js +1 -0
- package/dist/packem_shared/ITerm2File-XoC8RMzs.js +1 -0
- package/dist/packem_shared/constants-D12jy2Zh.js +1 -0
- package/dist/packem_shared/cursor-BAcJR4p_.js +1 -0
- package/dist/packem_shared/resetProgressBar-H_gzPKNE.js +1 -0
- package/dist/packem_shared/restoreCursor-CHy0jZuu.js +2 -0
- package/dist/passthrough.d.ts +74 -73
- package/dist/passthrough.js +1 -29
- package/dist/reset.d.ts +25 -24
- package/dist/reset.js +1 -4
- package/dist/screen.d.ts +226 -225
- package/dist/screen.js +1 -27
- package/dist/scroll.d.ts +64 -63
- package/dist/scroll.js +1 -18
- package/dist/status.d.ts +521 -520
- package/dist/status.js +1 -95
- package/dist/strip.d.ts +1 -1
- package/dist/strip.js +1 -13
- package/dist/termcap.d.ts +36 -35
- package/dist/termcap.js +1 -25
- package/dist/title.d.ts +176 -175
- package/dist/title.js +1 -19
- package/dist/window-ops.d.ts +399 -398
- package/dist/window-ops.js +1 -61
- package/dist/xterm.d.ts +85 -84
- package/dist/xterm.js +1 -33
- package/package.json +2 -5
- package/dist/constants.d.ts +0 -20
- package/dist/helpers.d.ts +0 -14
- package/dist/iterm2/iterm2-properties.d.ts +0 -135
- package/dist/iterm2/iterm2-sequences.d.ts +0 -96
- package/dist/packem_shared/IT2_AUTO-DyYWsxno.js +0 -6
- package/dist/packem_shared/ITerm2File-CUZDBk99.js +0 -137
- package/dist/packem_shared/constants-CE7WkXh_.js +0 -9
- package/dist/packem_shared/cursor-ChpV7cgs.js +0 -72
- package/dist/packem_shared/resetProgressBar-D9r2s7eV.js +0 -18
- package/dist/packem_shared/restoreCursor-GfYEeJqN.js +0 -323
- package/dist/progress.d.ts +0 -41
package/dist/mode.d.ts
CHANGED
|
@@ -1,726 +1,727 @@
|
|
|
1
1
|
/**
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
2
|
+
* Represents the reported setting of a terminal mode, typically received in response to a DECRQM (Request Mode) query.
|
|
3
|
+
* The terminal responds with a DECRPM (Report Mode) sequence containing one of these values.
|
|
4
|
+
* @see {@link requestMode} (DECRQM) for how to query a mode's state.
|
|
5
|
+
* @see {@link reportMode} (DECRPM) for how a terminal might report these states.
|
|
6
|
+
* @see {@link https://vt100.net/docs/vt510-rm/DECRPM.html} VT510 DECRPM Documentation.
|
|
7
|
+
* @enum {number}
|
|
8
|
+
*/
|
|
9
|
+
declare enum ModeSetting {
|
|
10
|
+
/**
|
|
11
|
+
* Mode is not recognized by the terminal.
|
|
12
|
+
* This indicates that the terminal does not support or understand the queried mode number.
|
|
13
|
+
* (Parameter `Ps = 0` in DECRPM)
|
|
14
|
+
*/
|
|
15
|
+
NotRecognized = 0,
|
|
16
|
+
/**
|
|
17
|
+
* Mode is currently set.
|
|
18
|
+
* (Parameter `Ps = 1` in DECRPM)
|
|
19
|
+
*/
|
|
20
|
+
Set = 1,
|
|
21
|
+
/**
|
|
22
|
+
* Mode is currently reset (not set).
|
|
23
|
+
* (Parameter `Ps = 2` in DECRPM)
|
|
24
|
+
*/
|
|
25
|
+
Reset = 2,
|
|
26
|
+
/**
|
|
27
|
+
* Mode is permanently set and cannot be changed (e.g., by RM or SM sequences).
|
|
28
|
+
* (Parameter `Ps = 3` in DECRPM)
|
|
29
|
+
*/
|
|
30
|
+
PermanentlySet = 3,
|
|
31
|
+
/**
|
|
32
|
+
* Mode is permanently reset and cannot be changed (e.g., by RM or SM sequences).
|
|
33
|
+
* (Parameter `Ps = 4` in DECRPM)
|
|
34
|
+
*/
|
|
35
|
+
PermanentlyReset = 4,
|
|
36
36
|
}
|
|
37
37
|
/**
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
/**
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
/**
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
/**
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
/**
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
/**
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
/**
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
/**
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
38
|
+
* Checks if the reported mode setting indicates that the mode is not recognized by the terminal.
|
|
39
|
+
* @param m The `ModeSetting` value reported by the terminal.
|
|
40
|
+
* @returns `true` if the mode is {@link ModeSetting.NotRecognized}, `false` otherwise.
|
|
41
|
+
*/
|
|
42
|
+
declare const isModeNotRecognized: (m: ModeSetting) => boolean;
|
|
43
|
+
/**
|
|
44
|
+
* Checks if the reported mode setting indicates that the mode is currently set or permanently set.
|
|
45
|
+
* @param m The `ModeSetting` value reported by the terminal.
|
|
46
|
+
* @returns `true` if the mode is {@link ModeSetting.Set} or {@link ModeSetting.PermanentlySet}, `false` otherwise.
|
|
47
|
+
*/
|
|
48
|
+
declare const isModeSet: (m: ModeSetting) => boolean;
|
|
49
|
+
/**
|
|
50
|
+
* Checks if the reported mode setting indicates that the mode is currently reset or permanently reset.
|
|
51
|
+
* @param m The `ModeSetting` value reported by the terminal.
|
|
52
|
+
* @returns `true` if the mode is {@link ModeSetting.Reset} or {@link ModeSetting.PermanentlyReset}, `false` otherwise.
|
|
53
|
+
*/
|
|
54
|
+
declare const isModeReset: (m: ModeSetting) => boolean;
|
|
55
|
+
/**
|
|
56
|
+
* Checks if the reported mode setting indicates that the mode is permanently set and cannot be changed.
|
|
57
|
+
* @param m The `ModeSetting` value reported by the terminal.
|
|
58
|
+
* @returns `true` if the mode is {@link ModeSetting.PermanentlySet}, `false` otherwise.
|
|
59
|
+
*/
|
|
60
|
+
declare const isModePermanentlySet: (m: ModeSetting) => boolean;
|
|
61
|
+
/**
|
|
62
|
+
* Checks if the reported mode setting indicates that the mode is permanently reset and cannot be changed.
|
|
63
|
+
* @param m The `ModeSetting` value reported by the terminal.
|
|
64
|
+
* @returns `true` if the mode is {@link ModeSetting.PermanentlyReset}, `false` otherwise.
|
|
65
|
+
*/
|
|
66
|
+
declare const isModePermanentlyReset: (m: ModeSetting) => boolean;
|
|
67
|
+
/**
|
|
68
|
+
* Represents a standard ANSI terminal mode (e.g., IRM, KAM). These modes are controlled by
|
|
69
|
+
* sequences like `CSI Pn h` (Set) and `CSI Pn l` (Reset), without a `?` prefix.
|
|
70
|
+
* This is a type alias for the base {@link Mode} interface, specialized for ANSI modes.
|
|
71
|
+
* @see {@link Mode}
|
|
72
|
+
* @see {@link createAnsiMode} to create instances.
|
|
73
|
+
*/
|
|
74
|
+
type AnsiMode = Mode;
|
|
75
|
+
/**
|
|
76
|
+
* Represents a private DEC terminal mode (e.g., DECTCEM, DECAWM). These modes are controlled by
|
|
77
|
+
* sequences like `CSI ? Pn h` (Set) and `CSI ? Pn l` (Reset), identified by the `?` prefix.
|
|
78
|
+
* This is a type alias for the base {@link Mode} interface, specialized for DEC modes.
|
|
79
|
+
* @see {@link Mode}
|
|
80
|
+
* @see {@link createDecMode} to create instances.
|
|
81
|
+
*/
|
|
82
|
+
type DecMode = Mode;
|
|
83
|
+
/**
|
|
84
|
+
* Interface representing a terminal mode, characterized by its numeric code
|
|
85
|
+
* and whether it's a standard ANSI mode or a private DEC mode.
|
|
86
|
+
*
|
|
87
|
+
* - Standard ANSI modes are controlled by `CSI Pn h` (Set Mode - SM) and `CSI Pn l` (Reset Mode - RM).
|
|
88
|
+
* - Private DEC modes are controlled by `CSI ? Pn h` (DECSET) and `CSI ? Pn l` (DECRST).
|
|
89
|
+
*/
|
|
90
|
+
interface Mode {
|
|
91
|
+
/** The numeric code of the terminal mode (e.g., `4` for Insert/Replace Mode, `25` for Text Cursor Enable Mode). */
|
|
92
|
+
readonly code: number;
|
|
93
|
+
/**
|
|
94
|
+
* Indicates if this is a private DEC mode.
|
|
95
|
+
* - `true`: It's a DEC mode (sequence uses `?`, e.g., `CSI ?25h`).
|
|
96
|
+
* - `false`: It's a standard ANSI mode (sequence does not use `?`, e.g., `CSI 4h`).
|
|
97
|
+
*/
|
|
98
|
+
readonly isDecMode: boolean;
|
|
99
99
|
}
|
|
100
100
|
/**
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
/**
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
/**
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
101
|
+
* Factory function to create a standard ANSI mode object.
|
|
102
|
+
* @param code The numeric code for the ANSI mode (e.g., `4` for Insert/Replace Mode).
|
|
103
|
+
* @returns An `AnsiMode` object representing the specified ANSI mode.
|
|
104
|
+
* @example
|
|
105
|
+
* ```typescript
|
|
106
|
+
* import { createAnsiMode, setMode, resetMode } from '@visulima/ansi';
|
|
107
|
+
*
|
|
108
|
+
* const insertReplaceMode = createAnsiMode(4); // ANSI Mode 4: IRM
|
|
109
|
+
* const srmMode = createAnsiMode(12); // ANSI Mode 12: SRM
|
|
110
|
+
*
|
|
111
|
+
* process.stdout.write(setMode(insertReplaceMode)); // CSI 4h
|
|
112
|
+
* process.stdout.write(resetMode(srmMode)); // CSI 12l
|
|
113
|
+
* ```
|
|
114
|
+
*/
|
|
115
|
+
declare const createAnsiMode: (code: number) => AnsiMode;
|
|
116
|
+
/**
|
|
117
|
+
* Factory function to create a private DEC mode object.
|
|
118
|
+
* @param code The numeric code for the DEC mode (e.g., `25` for Text Cursor Enable Mode DECTCEM).
|
|
119
|
+
* @returns A `DecMode` object representing the specified DEC private mode.
|
|
120
|
+
* @example
|
|
121
|
+
* ```typescript
|
|
122
|
+
* import { createDecMode, setMode, resetMode } from '@visulima/ansi';
|
|
123
|
+
*
|
|
124
|
+
* const cursorVisibleMode = createDecMode(25); // DEC Mode 25: DECTCEM (Text Cursor Enable)
|
|
125
|
+
* const originMode = createDecMode(6); // DEC Mode 6: DECOM (Origin Mode)
|
|
126
|
+
*
|
|
127
|
+
* process.stdout.write(setMode(cursorVisibleMode)); // CSI ?25h
|
|
128
|
+
* process.stdout.write(resetMode(originMode)); // CSI ?6l
|
|
129
|
+
* ```
|
|
130
|
+
*/
|
|
131
|
+
declare const createDecMode: (code: number) => DecMode;
|
|
132
|
+
/**
|
|
133
|
+
* Generates the ANSI/DEC sequence to set one or more terminal modes.
|
|
134
|
+
* (SM - Set Mode)
|
|
135
|
+
*
|
|
136
|
+
* - For standard ANSI modes, the format is `CSI Pn ; ... ; Pn h`.
|
|
137
|
+
* - For private DEC modes, the format is `CSI ? Pn ; ... ; Pn h`.
|
|
138
|
+
*
|
|
139
|
+
* If a mix of ANSI and DEC modes are provided (e.g., `setMode(ansiMode1, decMode1, ansiMode2)`),
|
|
140
|
+
* it produces two separate sequences concatenated (e.g., `CSI Pn(A1);Pn(A2)hCSI ?Pn(D1)h`).
|
|
141
|
+
* The order of ANSI vs. DEC sequences in the output depends on the current implementation (ANSI first).
|
|
142
|
+
* @param modes A list of {@link Mode} objects (either `AnsiMode` or `DecMode`) to set.
|
|
143
|
+
* @returns The ANSI escape sequence(s) to set the specified modes. Returns an empty string if no modes are provided.
|
|
144
|
+
* @see {@link https://vt100.net/docs/vt510-rm/SM.html Set Mode (SM) documentation}
|
|
145
|
+
* @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Functions-using-CSI-Ps-space-letter} (DECSET related section)
|
|
146
|
+
* @example
|
|
147
|
+
* ```typescript
|
|
148
|
+
* import { createAnsiMode, createDecMode, setMode, TextCursorEnableMode, OriginMode, InsertReplaceMode, LineFeedNewLineMode } from '@visulima/ansi';
|
|
149
|
+
*
|
|
150
|
+
* // Set a single DEC mode
|
|
151
|
+
* console.log(setMode(TextCursorEnableMode)); // CSI ?25h (assuming TextCursorEnableMode is DEC mode 25)
|
|
152
|
+
*
|
|
153
|
+
* // Set multiple ANSI modes
|
|
154
|
+
* console.log(setMode(InsertReplaceMode, LineFeedNewLineMode)); // CSI 4;20h (assuming IRM is 4, LNM is 20)
|
|
155
|
+
*
|
|
156
|
+
* // Set a mix of modes
|
|
157
|
+
* console.log(setMode(OriginMode, InsertReplaceMode)); // e.g., CSI 4hCSI ?6h (order of groups may vary)
|
|
158
|
+
* ```
|
|
159
|
+
*/
|
|
160
|
+
declare const setMode: (...modes: Mode[]) => string;
|
|
161
161
|
/** Alias for {@link setMode}. Generates the SM (Set Mode) sequence. */
|
|
162
|
-
|
|
163
|
-
/**
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
162
|
+
declare const SM: (...modes: Mode[]) => string;
|
|
163
|
+
/**
|
|
164
|
+
* Generates the ANSI/DEC sequence to reset one or more terminal modes.
|
|
165
|
+
* (RM - Reset Mode)
|
|
166
|
+
*
|
|
167
|
+
* - For standard ANSI modes, the format is `CSI Pn ; ... ; Pn l`.
|
|
168
|
+
* - For private DEC modes, the format is `CSI ? Pn ; ... ; Pn l`.
|
|
169
|
+
*
|
|
170
|
+
* If a mix of ANSI and DEC modes are provided (e.g., `resetMode(ansiMode1, decMode1, ansiMode2)`),
|
|
171
|
+
* it produces two separate sequences concatenated (e.g., `CSI Pn(A1);Pn(A2)lCSI ?Pn(D1)l`).
|
|
172
|
+
* The order of ANSI vs. DEC sequences in the output depends on the current implementation (ANSI first).
|
|
173
|
+
* @param modes A list of {@link Mode} objects (either `AnsiMode` or `DecMode`) to reset.
|
|
174
|
+
* @returns The ANSI escape sequence(s) to reset the specified modes. Returns an empty string if no modes are provided.
|
|
175
|
+
* @see {@link https://vt100.net/docs/vt510-rm/RM.html Reset Mode (RM) documentation}
|
|
176
|
+
* @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Functions-using-CSI-Ps-space-letter} (DECRST related section)
|
|
177
|
+
* @example
|
|
178
|
+
* ```typescript
|
|
179
|
+
* import { createAnsiMode, createDecMode, resetMode, TextCursorEnableMode, OriginMode, InsertReplaceMode, LineFeedNewLineMode } from '@visulima/ansi';
|
|
180
|
+
*
|
|
181
|
+
* // Reset a single DEC mode
|
|
182
|
+
* console.log(resetMode(TextCursorEnableMode)); // CSI ?25l (assuming TextCursorEnableMode is DEC mode 25)
|
|
183
|
+
*
|
|
184
|
+
* // Reset multiple ANSI modes
|
|
185
|
+
* console.log(resetMode(InsertReplaceMode, LineFeedNewLineMode)); // CSI 4;20l (assuming IRM is 4, LNM is 20)
|
|
186
|
+
*
|
|
187
|
+
* // Reset a mix of modes
|
|
188
|
+
* console.log(resetMode(OriginMode, InsertReplaceMode)); // e.g., CSI 4lCSI ?6l (order of groups may vary)
|
|
189
|
+
* ```
|
|
190
|
+
*/
|
|
191
|
+
declare const resetMode: (...modes: Mode[]) => string;
|
|
192
192
|
/** Alias for {@link resetMode}. Generates the RM (Reset Mode) sequence. */
|
|
193
|
-
|
|
194
|
-
/**
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
193
|
+
declare const RM: (...modes: Mode[]) => string;
|
|
194
|
+
/**
|
|
195
|
+
* Generates the DECRQM (Request Mode) sequence to query the state of a specific terminal mode.
|
|
196
|
+
*
|
|
197
|
+
* The terminal is expected to respond with a DECRPM (Report Mode) sequence indicating the mode's current setting.
|
|
198
|
+
*
|
|
199
|
+
* - For a standard ANSI mode, the format is `CSI Pn $ p`.
|
|
200
|
+
* - For a private DEC mode, the format is `CSI ? Pn $ p`.
|
|
201
|
+
* @param mode The {@link Mode} object (either `AnsiMode` or `DecMode`) to query.
|
|
202
|
+
* @returns The DECRQM escape sequence to request the mode state.
|
|
203
|
+
* @see {@link https://vt100.net/docs/vt510-rm/DECRQM.html DECRQM documentation}
|
|
204
|
+
* @see {@link reportMode} for the corresponding response sequence (DECRPM).
|
|
205
|
+
* @see {@link ModeSetting} for possible reported states.
|
|
206
|
+
* @example
|
|
207
|
+
* ```typescript
|
|
208
|
+
* import { requestMode, TextCursorEnableMode, InsertReplaceMode } from '@visulima/ansi';
|
|
209
|
+
*
|
|
210
|
+
* // Request state of DEC Mode 25 (Text Cursor Enable)
|
|
211
|
+
* process.stdout.write(requestMode(TextCursorEnableMode)); // Outputs: CSI ?25$p
|
|
212
|
+
*
|
|
213
|
+
* // Request state of ANSI Mode 4 (Insert/Replace Mode)
|
|
214
|
+
* process.stdout.write(requestMode(InsertReplaceMode)); // Outputs: CSI 4$p
|
|
215
|
+
* ```
|
|
216
|
+
*/
|
|
217
|
+
declare const requestMode: (mode: Mode) => string;
|
|
218
218
|
/** Alias for {@link requestMode}. Generates the DECRQM (Request Mode) sequence. */
|
|
219
|
-
|
|
220
|
-
/**
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
219
|
+
declare const DECRQM: (mode: Mode) => string;
|
|
220
|
+
/**
|
|
221
|
+
* Generates the DECRPM (Report Mode) sequence, which is the terminal's response to a DECRQM request.
|
|
222
|
+
* This sequence indicates the current setting of a queried mode.
|
|
223
|
+
*
|
|
224
|
+
* - For a standard ANSI mode, the format is `CSI Pn ; Ps $ y`.
|
|
225
|
+
* - For a private DEC mode, the format is `CSI ? Pn ; Ps $ y`.
|
|
226
|
+
*
|
|
227
|
+
* Where `Pn` is the mode number and `Ps` is a value from {@link ModeSetting} (0-4).
|
|
228
|
+
*
|
|
229
|
+
* This function is typically used for testing or simulating terminal behavior,
|
|
230
|
+
* as applications usually receive this sequence from the terminal, not generate it.
|
|
231
|
+
* @param mode The {@link Mode} object (either `AnsiMode` or `DecMode`) whose state is being reported.
|
|
232
|
+
* @param value The {@link ModeSetting} value indicating the current state of the mode.
|
|
233
|
+
* @returns The DECRPM escape sequence reporting the mode state.
|
|
234
|
+
* @see {@link https://vt100.net/docs/vt510-rm/DECRPM.html DECRPM documentation}
|
|
235
|
+
* @see {@link requestMode} for the corresponding request sequence (DECRQM).
|
|
236
|
+
* @example
|
|
237
|
+
* ```typescript
|
|
238
|
+
* import { reportMode, TextCursorEnableMode, InsertReplaceMode, ModeSetting, createDecMode } from '@visulima/ansi';
|
|
239
|
+
*
|
|
240
|
+
* // Report that DEC Mode 25 (Text Cursor Enable) is Set
|
|
241
|
+
* console.log(reportMode(TextCursorEnableMode, ModeSetting.Set)); // Outputs: CSI ?25;1$y
|
|
242
|
+
*
|
|
243
|
+
* // Report that ANSI Mode 4 (Insert/Replace Mode) is Reset
|
|
244
|
+
* console.log(reportMode(InsertReplaceMode, ModeSetting.Reset)); // Outputs: CSI 4;2$y
|
|
245
|
+
*
|
|
246
|
+
* // Report that a hypothetical DEC mode 1049 is NotRecognized
|
|
247
|
+
* const customDecMode = createDecMode(1049);
|
|
248
|
+
* console.log(reportMode(customDecMode, ModeSetting.NotRecognized)); // Outputs: CSI ?1049;0$y
|
|
249
|
+
* ```
|
|
250
|
+
*/
|
|
251
|
+
declare const reportMode: (mode: Mode, value: ModeSetting) => string;
|
|
252
252
|
/** Alias for {@link reportMode}. Generates the DECRPM (Report Mode) sequence. */
|
|
253
|
-
|
|
253
|
+
declare const DECRPM: (mode: Mode, value: ModeSetting) => string;
|
|
254
254
|
/**
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
255
|
+
* ANSI Mode 2: Keyboard Action Mode (KAM).
|
|
256
|
+
* Controls locking of the keyboard. When locked, the keyboard cannot send data.
|
|
257
|
+
* @see {@link https://vt100.net/docs/vt510-rm/KAM.html}
|
|
258
|
+
*/
|
|
259
|
+
declare const KeyboardActionMode: AnsiMode;
|
|
260
260
|
/** Alias for {@link KeyboardActionMode}. */
|
|
261
|
-
|
|
261
|
+
declare const KAM: AnsiMode;
|
|
262
262
|
/** Sequence to set Keyboard Action Mode: `CSI 2 h` */
|
|
263
|
-
|
|
263
|
+
declare const SetKeyboardActionMode: string;
|
|
264
264
|
/** Sequence to reset Keyboard Action Mode: `CSI 2 l` */
|
|
265
|
-
|
|
265
|
+
declare const ResetKeyboardActionMode: string;
|
|
266
266
|
/** Sequence to request Keyboard Action Mode state: `CSI 2 $ p` */
|
|
267
|
-
|
|
267
|
+
declare const RequestKeyboardActionMode: string;
|
|
268
268
|
/**
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
269
|
+
* ANSI Mode 4: Insert/Replace Mode (IRM).
|
|
270
|
+
* Determines if new characters insert or replace existing ones.
|
|
271
|
+
* @see {@link https://vt100.net/docs/vt510-rm/IRM.html}
|
|
272
|
+
*/
|
|
273
|
+
declare const InsertReplaceMode: Mode;
|
|
274
274
|
/** Alias for {@link InsertReplaceMode}. */
|
|
275
|
-
|
|
275
|
+
declare const IRM: Mode;
|
|
276
276
|
/** Sequence to set Insert/Replace Mode: `CSI 4 h` */
|
|
277
|
-
|
|
277
|
+
declare const SetInsertReplaceMode: string;
|
|
278
278
|
/** Sequence to reset Insert/Replace Mode: `CSI 4 l` */
|
|
279
|
-
|
|
279
|
+
declare const ResetInsertReplaceMode: string;
|
|
280
280
|
/** Sequence to request Insert/Replace Mode state: `CSI 4 $ p` */
|
|
281
|
-
|
|
281
|
+
declare const RequestInsertReplaceMode: string;
|
|
282
282
|
/**
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
283
|
+
* ANSI Mode 8: BiDirectional Support Mode (BDSM).
|
|
284
|
+
* Determines if the terminal supports bidirectional text (implicit mode).
|
|
285
|
+
* @see ECMA-48 7.2.1.
|
|
286
|
+
*/
|
|
287
|
+
declare const BiDirectionalSupportMode: AnsiMode;
|
|
288
288
|
/** Alias for {@link BiDirectionalSupportMode}. */
|
|
289
|
-
|
|
289
|
+
declare const BDSM: AnsiMode;
|
|
290
290
|
/** Sequence to set BiDirectional Support Mode: `CSI 8 h` */
|
|
291
|
-
|
|
291
|
+
declare const SetBiDirectionalSupportMode: string;
|
|
292
292
|
/** Sequence to reset BiDirectional Support Mode: `CSI 8 l` */
|
|
293
|
-
|
|
293
|
+
declare const ResetBiDirectionalSupportMode: string;
|
|
294
294
|
/** Sequence to request BiDirectional Support Mode state: `CSI 8 $ p` */
|
|
295
|
-
|
|
295
|
+
declare const RequestBiDirectionalSupportMode: string;
|
|
296
296
|
/**
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
297
|
+
* ANSI Mode 12: Send/Receive Mode (SRM) or Local Echo Mode.
|
|
298
|
+
* Determines if the terminal echoes typed characters locally.
|
|
299
|
+
* @see {@link https://vt100.net/docs/vt510-rm/SRM.html}
|
|
300
|
+
*/
|
|
301
|
+
declare const SendReceiveMode: AnsiMode;
|
|
302
302
|
/** Alias for {@link SendReceiveMode}. */
|
|
303
|
-
|
|
303
|
+
declare const LocalEchoMode: AnsiMode;
|
|
304
304
|
/** Alias for {@link SendReceiveMode}. */
|
|
305
|
-
|
|
305
|
+
declare const SRM: AnsiMode;
|
|
306
306
|
/** Sequence to set Send/Receive Mode: `CSI 12 h` */
|
|
307
|
-
|
|
307
|
+
declare const SetSendReceiveMode: string;
|
|
308
308
|
/** Sequence to reset Send/Receive Mode: `CSI 12 l` */
|
|
309
|
-
|
|
309
|
+
declare const ResetSendReceiveMode: string;
|
|
310
310
|
/** Sequence to request Send/Receive Mode state: `CSI 12 $ p` */
|
|
311
|
-
|
|
311
|
+
declare const RequestSendReceiveMode: string;
|
|
312
312
|
/** Alias for {@link SetSendReceiveMode}. */
|
|
313
|
-
|
|
313
|
+
declare const SetLocalEchoMode: string;
|
|
314
314
|
/** Alias for {@link ResetSendReceiveMode}. */
|
|
315
|
-
|
|
315
|
+
declare const ResetLocalEchoMode: string;
|
|
316
316
|
/** Alias for {@link RequestSendReceiveMode}. */
|
|
317
|
-
|
|
318
|
-
/**
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
317
|
+
declare const RequestLocalEchoMode: string;
|
|
318
|
+
/**
|
|
319
|
+
* ANSI Mode 20: Line Feed/New Line Mode (LNM).
|
|
320
|
+
* Determines how the terminal interprets line feed (LF), form feed (FF), and vertical tab (VT) characters.
|
|
321
|
+
* - Set (New Line): LF, FF, VT cause CR+LF effect.
|
|
322
|
+
* - Reset (Line Feed): LF, FF, VT move to next line, same column.
|
|
323
|
+
* @see {@link https://vt100.net/docs/vt510-rm/LNM.html}
|
|
324
|
+
*/
|
|
325
|
+
declare const LineFeedNewLineMode: AnsiMode;
|
|
326
326
|
/** Alias for {@link LineFeedNewLineMode}. */
|
|
327
|
-
|
|
327
|
+
declare const LNM: AnsiMode;
|
|
328
328
|
/** Sequence to set Line Feed/New Line Mode: `CSI 20 h` */
|
|
329
|
-
|
|
329
|
+
declare const SetLineFeedNewLineMode: string;
|
|
330
330
|
/** Sequence to reset Line Feed/New Line Mode: `CSI 20 l` */
|
|
331
|
-
|
|
331
|
+
declare const ResetLineFeedNewLineMode: string;
|
|
332
332
|
/** Sequence to request Line Feed/New Line Mode state: `CSI 20 $ p` */
|
|
333
|
-
|
|
334
|
-
/**
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
333
|
+
declare const RequestLineFeedNewLineMode: string;
|
|
334
|
+
/**
|
|
335
|
+
* DEC Private Mode 1: Cursor Keys Mode (DECCKM).
|
|
336
|
+
* Determines if cursor keys send ANSI cursor sequences or application-specific sequences.
|
|
337
|
+
* - Set: Application sequences (e.g., `ESC O A` for Up Arrow).
|
|
338
|
+
* - Reset: ANSI sequences (e.g., `CSI A` for Up Arrow) (default).
|
|
339
|
+
* @see {@link https://vt100.net/docs/vt510-rm/DECCKM.html}
|
|
340
|
+
*/
|
|
341
|
+
declare const CursorKeysMode: AnsiMode;
|
|
342
342
|
/** Alias for {@link CursorKeysMode}. */
|
|
343
|
-
|
|
343
|
+
declare const DECCKM: AnsiMode;
|
|
344
344
|
/** Sequence to set Cursor Keys Mode: `CSI ? 1 h` */
|
|
345
|
-
|
|
345
|
+
declare const SetCursorKeysMode: string;
|
|
346
346
|
/** Sequence to reset Cursor Keys Mode: `CSI ? 1 l` */
|
|
347
|
-
|
|
347
|
+
declare const ResetCursorKeysMode: string;
|
|
348
348
|
/** Sequence to request Cursor Keys Mode state: `CSI ? 1 $ p` */
|
|
349
|
-
|
|
350
|
-
/**
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
349
|
+
declare const RequestCursorKeysMode: string;
|
|
350
|
+
/**
|
|
351
|
+
* DEC Private Mode 6: Origin Mode (DECOM).
|
|
352
|
+
* Controls cursor addressing relative to home position or scrolling region top-left.
|
|
353
|
+
* - Set: Relative to scrolling region.
|
|
354
|
+
* - Reset: Relative to home position (default).
|
|
355
|
+
* @see {@link https://vt100.net/docs/vt510-rm/DECOM.html}
|
|
356
|
+
*/
|
|
357
|
+
declare const OriginMode: AnsiMode;
|
|
358
358
|
/** Alias for {@link OriginMode}. */
|
|
359
|
-
|
|
359
|
+
declare const DECOM: AnsiMode;
|
|
360
360
|
/** Sequence to set Origin Mode: `CSI ? 6 h` */
|
|
361
|
-
|
|
361
|
+
declare const SetOriginMode: string;
|
|
362
362
|
/** Sequence to reset Origin Mode: `CSI ? 6 l` */
|
|
363
|
-
|
|
363
|
+
declare const ResetOriginMode: string;
|
|
364
364
|
/** Sequence to request Origin Mode state: `CSI ? 6 $ p` */
|
|
365
|
-
|
|
366
|
-
/**
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
365
|
+
declare const RequestOriginMode: string;
|
|
366
|
+
/**
|
|
367
|
+
* DEC Private Mode 7: Auto Wrap Mode (DECAWM).
|
|
368
|
+
* Determines if cursor wraps to next line upon reaching the right margin.
|
|
369
|
+
* - Set: Auto-wrap enabled (default).
|
|
370
|
+
* - Reset: Auto-wrap disabled (characters overwrite at right margin).
|
|
371
|
+
* @see {@link https://vt100.net/docs/vt510-rm/DECAWM.html}
|
|
372
|
+
*/
|
|
373
|
+
declare const AutoWrapMode: AnsiMode;
|
|
374
374
|
/** Alias for {@link AutoWrapMode}. */
|
|
375
|
-
|
|
375
|
+
declare const DECAWM: AnsiMode;
|
|
376
376
|
/** Sequence to set Auto Wrap Mode: `CSI ? 7 h` */
|
|
377
|
-
|
|
377
|
+
declare const SetAutoWrapMode: string;
|
|
378
378
|
/** Sequence to reset Auto Wrap Mode: `CSI ? 7 l` */
|
|
379
|
-
|
|
379
|
+
declare const ResetAutoWrapMode: string;
|
|
380
380
|
/** Sequence to request Auto Wrap Mode state: `CSI ? 7 $ p` */
|
|
381
|
-
|
|
382
|
-
/**
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
381
|
+
declare const RequestAutoWrapMode: string;
|
|
382
|
+
/**
|
|
383
|
+
* DEC Private Mode 9: X10 Mouse Reporting Mode.
|
|
384
|
+
* Reports mouse button presses. Coordinates are single characters (limited range).
|
|
385
|
+
* Format: `CSI M Cb Cx Cy` (Cb=button-1, Cx=X, Cy=Y).
|
|
386
|
+
* @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Mouse-Tracking}
|
|
387
|
+
*/
|
|
388
|
+
declare const X10MouseMode: AnsiMode;
|
|
389
389
|
/** Sequence to set X10 Mouse Mode: `CSI ? 9 h` */
|
|
390
|
-
|
|
390
|
+
declare const SetX10MouseMode: string;
|
|
391
391
|
/** Sequence to reset X10 Mouse Mode: `CSI ? 9 l` */
|
|
392
|
-
|
|
392
|
+
declare const ResetX10MouseMode: string;
|
|
393
393
|
/** Sequence to request X10 Mouse Mode state: `CSI ? 9 $ p` */
|
|
394
|
-
|
|
395
|
-
/**
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
394
|
+
declare const RequestX10MouseMode: string;
|
|
395
|
+
/**
|
|
396
|
+
* DEC Private Mode 25: Text Cursor Enable Mode (DECTCEM).
|
|
397
|
+
* Controls visibility of the text cursor.
|
|
398
|
+
* - Set: Cursor visible (default).
|
|
399
|
+
* - Reset: Cursor invisible.
|
|
400
|
+
* @see {@link https://vt100.net/docs/vt510-rm/DECTCEM.html}
|
|
401
|
+
*/
|
|
402
|
+
declare const TextCursorEnableMode: AnsiMode;
|
|
403
403
|
/** Alias for {@link TextCursorEnableMode}. */
|
|
404
|
-
|
|
404
|
+
declare const DECTCEM: AnsiMode;
|
|
405
405
|
/** Sequence to set Text Cursor Enable Mode (show cursor): `CSI ? 25 h` */
|
|
406
|
-
|
|
406
|
+
declare const SetTextCursorEnableMode: string;
|
|
407
407
|
/** Sequence to reset Text Cursor Enable Mode (hide cursor): `CSI ? 25 l` */
|
|
408
|
-
|
|
408
|
+
declare const ResetTextCursorEnableMode: string;
|
|
409
409
|
/** Sequence to request Text Cursor Enable Mode state: `CSI ? 25 $ p` */
|
|
410
|
-
|
|
410
|
+
declare const RequestTextCursorEnableMode: string;
|
|
411
411
|
/** Alias for {@link SetTextCursorEnableMode} (shows cursor). */
|
|
412
|
-
|
|
412
|
+
declare const ShowCursor: string;
|
|
413
413
|
/** Alias for {@link ResetTextCursorEnableMode} (hides cursor). */
|
|
414
|
-
|
|
414
|
+
declare const HideCursor: string;
|
|
415
415
|
/**
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
416
|
+
* DEC Private Mode 66: Numeric Keypad Mode (DECNKM).
|
|
417
|
+
* Determines if keypad sends application or numeric sequences.
|
|
418
|
+
* @see {@link https://vt100.net/docs/vt510-rm/DECNKM.html}
|
|
419
|
+
*/
|
|
420
|
+
declare const NumericKeypadMode: AnsiMode;
|
|
421
421
|
/** Alias for {@link NumericKeypadMode}. */
|
|
422
|
-
|
|
422
|
+
declare const DECNKM: AnsiMode;
|
|
423
423
|
/** Sequence to set Numeric Keypad Mode: `CSI ? 66 h` */
|
|
424
|
-
|
|
424
|
+
declare const SetNumericKeypadMode: string;
|
|
425
425
|
/** Sequence to reset Numeric Keypad Mode: `CSI ? 66 l` */
|
|
426
|
-
|
|
426
|
+
declare const ResetNumericKeypadMode: string;
|
|
427
427
|
/** Sequence to request Numeric Keypad Mode state: `CSI ? 66 $ p` */
|
|
428
|
-
|
|
429
|
-
/**
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
428
|
+
declare const RequestNumericKeypadMode: string;
|
|
429
|
+
/**
|
|
430
|
+
* DEC Private Mode 67: Backarrow Key Mode (DECBKM).
|
|
431
|
+
* Determines if backspace key sends backspace (ASCII 8) or delete (ASCII 127).
|
|
432
|
+
* - Set: Sends delete character.
|
|
433
|
+
* - Reset: Sends backspace character (default).
|
|
434
|
+
* @see {@link https://vt100.net/docs/vt510-rm/DECBKM.html}
|
|
435
|
+
*/
|
|
436
|
+
declare const BackarrowKeyMode: AnsiMode;
|
|
437
437
|
/** Alias for {@link BackarrowKeyMode}. */
|
|
438
|
-
|
|
438
|
+
declare const DECBKM: AnsiMode;
|
|
439
439
|
/** Sequence to set Backarrow Key Mode: `CSI ? 67 h` */
|
|
440
|
-
|
|
440
|
+
declare const SetBackarrowKeyMode: string;
|
|
441
441
|
/** Sequence to reset Backarrow Key Mode: `CSI ? 67 l` */
|
|
442
|
-
|
|
442
|
+
declare const ResetBackarrowKeyMode: string;
|
|
443
443
|
/** Sequence to request Backarrow Key Mode state: `CSI ? 67 $ p` */
|
|
444
|
-
|
|
444
|
+
declare const RequestBackarrowKeyMode: string;
|
|
445
445
|
/**
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
446
|
+
* DEC Private Mode 69: Left/Right Margin Mode (DECLRMM).
|
|
447
|
+
* Controls whether left and right margins can be set with DECSLRM.
|
|
448
|
+
* @see {@link https://vt100.net/docs/vt510-rm/DECLRMM.html}
|
|
449
|
+
*/
|
|
450
|
+
declare const LeftRightMarginMode: AnsiMode;
|
|
451
451
|
/** Alias for {@link LeftRightMarginMode}. */
|
|
452
|
-
|
|
452
|
+
declare const DECLRMM: AnsiMode;
|
|
453
453
|
/** Sequence to set Left/Right Margin Mode: `CSI ? 69 h` */
|
|
454
|
-
|
|
454
|
+
declare const SetLeftRightMarginMode: string;
|
|
455
455
|
/** Sequence to reset Left/Right Margin Mode: `CSI ? 69 l` */
|
|
456
|
-
|
|
456
|
+
declare const ResetLeftRightMarginMode: string;
|
|
457
457
|
/** Sequence to request Left/Right Margin Mode state: `CSI ? 69 $ p` */
|
|
458
|
-
|
|
459
|
-
/**
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
458
|
+
declare const RequestLeftRightMarginMode: string;
|
|
459
|
+
/**
|
|
460
|
+
* DEC Private Mode 1000: Normal Mouse Mode.
|
|
461
|
+
* Reports mouse button presses and releases, including modifiers, wheel events, and extra buttons.
|
|
462
|
+
* Uses X10-like encoding with extensions.
|
|
463
|
+
* @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Mouse-Tracking}
|
|
464
|
+
*/
|
|
465
|
+
declare const NormalMouseMode: AnsiMode;
|
|
466
466
|
/** Sequence to set Normal Mouse Mode: `CSI ? 1000 h` */
|
|
467
|
-
|
|
467
|
+
declare const SetNormalMouseMode: string;
|
|
468
468
|
/** Sequence to reset Normal Mouse Mode: `CSI ? 1000 l` */
|
|
469
|
-
|
|
469
|
+
declare const ResetNormalMouseMode: string;
|
|
470
470
|
/** Sequence to request Normal Mouse Mode state: `CSI ? 1000 $ p` */
|
|
471
|
-
|
|
471
|
+
declare const RequestNormalMouseMode: string;
|
|
472
472
|
/**
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
473
|
+
* DEC Private Mode 1001: Highlight Mouse Tracking.
|
|
474
|
+
* Reports button presses, releases, and highlighted cells.
|
|
475
|
+
* @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Mouse-Tracking}
|
|
476
|
+
*/
|
|
477
|
+
declare const HighlightMouseMode: AnsiMode;
|
|
478
478
|
/** Sequence to set Highlight Mouse Tracking: `CSI ? 1001 h` */
|
|
479
|
-
|
|
479
|
+
declare const SetHighlightMouseMode: string;
|
|
480
480
|
/** Sequence to reset Highlight Mouse Tracking: `CSI ? 1001 l` */
|
|
481
|
-
|
|
481
|
+
declare const ResetHighlightMouseMode: string;
|
|
482
482
|
/** Sequence to request Highlight Mouse Tracking state: `CSI ? 1001 $ p` */
|
|
483
|
-
|
|
483
|
+
declare const RequestHighlightMouseMode: string;
|
|
484
484
|
/**
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
485
|
+
* DEC Private Mode 1002: Button Event Mouse Tracking (Cell Motion Mouse Tracking).
|
|
486
|
+
* Reports button-down events and mouse motion while a button is pressed.
|
|
487
|
+
* @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Mouse-Tracking}
|
|
488
|
+
*/
|
|
489
|
+
declare const ButtonEventMouseMode: AnsiMode;
|
|
490
490
|
/** Sequence to set Button Event Mouse Tracking: `CSI ? 1002 h` */
|
|
491
|
-
|
|
491
|
+
declare const SetButtonEventMouseMode: string;
|
|
492
492
|
/** Sequence to reset Button Event Mouse Tracking: `CSI ? 1002 l` */
|
|
493
|
-
|
|
493
|
+
declare const ResetButtonEventMouseMode: string;
|
|
494
494
|
/** Sequence to request Button Event Mouse Tracking state: `CSI ? 1002 $ p` */
|
|
495
|
-
|
|
495
|
+
declare const RequestButtonEventMouseMode: string;
|
|
496
496
|
/**
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
497
|
+
* DEC Private Mode 1003: Any Event Mouse Tracking (All Motion Mouse Tracking).
|
|
498
|
+
* Reports all mouse movements, regardless of button state (includes hover).
|
|
499
|
+
* @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Mouse-Tracking}
|
|
500
|
+
*/
|
|
501
|
+
declare const AnyEventMouseMode: AnsiMode;
|
|
502
502
|
/** Sequence to set Any Event Mouse Tracking: `CSI ? 1003 h` */
|
|
503
|
-
|
|
503
|
+
declare const SetAnyEventMouseMode: string;
|
|
504
504
|
/** Sequence to reset Any Event Mouse Tracking: `CSI ? 1003 l` */
|
|
505
|
-
|
|
505
|
+
declare const ResetAnyEventMouseMode: string;
|
|
506
506
|
/** Sequence to request Any Event Mouse Tracking state: `CSI ? 1003 $ p` */
|
|
507
|
-
|
|
507
|
+
declare const RequestAnyEventMouseMode: string;
|
|
508
508
|
/**
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
509
|
+
* DEC Private Mode 1004: Focus Event Mode.
|
|
510
|
+
* Reports terminal focus (FocusIn `CSI I`) and blur (FocusOut `CSI O`) events.
|
|
511
|
+
* @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Focus-Tracking}
|
|
512
|
+
*/
|
|
513
|
+
declare const FocusEventMode: AnsiMode;
|
|
514
514
|
/** Sequence to set Focus Event Mode: `CSI ? 1004 h` */
|
|
515
|
-
|
|
515
|
+
declare const SetFocusEventMode: string;
|
|
516
516
|
/** Sequence to reset Focus Event Mode: `CSI ? 1004 l` */
|
|
517
|
-
|
|
517
|
+
declare const ResetFocusEventMode: string;
|
|
518
518
|
/** Sequence to request Focus Event Mode state: `CSI ? 1004 $ p` */
|
|
519
|
-
|
|
519
|
+
declare const RequestFocusEventMode: string;
|
|
520
520
|
/**
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
521
|
+
* DEC Private Mode 1005: UTF-8 Extended Mouse Mode.
|
|
522
|
+
* Mouse coordinates are UTF-8 encoded if they exceed 95.
|
|
523
|
+
* @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Mouse-Tracking}
|
|
524
|
+
*/
|
|
525
|
+
declare const Utf8ExtMouseMode: AnsiMode;
|
|
526
526
|
/** Sequence to set UTF-8 Extended Mouse Mode: `CSI ? 1005 h` */
|
|
527
|
-
|
|
527
|
+
declare const SetUtf8ExtMouseMode: string;
|
|
528
528
|
/** Sequence to reset UTF-8 Extended Mouse Mode: `CSI ? 1005 l` */
|
|
529
|
-
|
|
529
|
+
declare const ResetUtf8ExtMouseMode: string;
|
|
530
530
|
/** Sequence to request UTF-8 Extended Mouse Mode state: `CSI ? 1005 $ p` */
|
|
531
|
-
|
|
532
|
-
/**
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
531
|
+
declare const RequestUtf8ExtMouseMode: string;
|
|
532
|
+
/**
|
|
533
|
+
* DEC Private Mode 1006: SGR Extended Mouse Mode.
|
|
534
|
+
* Mouse events reported with SGR parameters: `CSI < Cb ; Cx ; Py M` (press) / `m` (release).
|
|
535
|
+
* Robust and recommended for modern applications.
|
|
536
|
+
* @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Mouse-Tracking}
|
|
537
|
+
*/
|
|
538
|
+
declare const SgrExtMouseMode: AnsiMode;
|
|
539
539
|
/** Sequence to set SGR Extended Mouse Mode: `CSI ? 1006 h` */
|
|
540
|
-
|
|
540
|
+
declare const SetSgrExtMouseMode: string;
|
|
541
541
|
/** Sequence to reset SGR Extended Mouse Mode: `CSI ? 1006 l` */
|
|
542
|
-
|
|
542
|
+
declare const ResetSgrExtMouseMode: string;
|
|
543
543
|
/** Sequence to request SGR Extended Mouse Mode state: `CSI ? 1006 $ p` */
|
|
544
|
-
|
|
544
|
+
declare const RequestSgrExtMouseMode: string;
|
|
545
545
|
/**
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
546
|
+
* DEC Private Mode 1015: URXVT Extended Mouse Mode.
|
|
547
|
+
* Uses an alternate encoding for mouse tracking.
|
|
548
|
+
* @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Mouse-Tracking}
|
|
549
|
+
*/
|
|
550
|
+
declare const UrxvtExtMouseMode: AnsiMode;
|
|
551
551
|
/** Sequence to set URXVT Extended Mouse Mode: `CSI ? 1015 h` */
|
|
552
|
-
|
|
552
|
+
declare const SetUrxvtExtMouseMode: string;
|
|
553
553
|
/** Sequence to reset URXVT Extended Mouse Mode: `CSI ? 1015 l` */
|
|
554
|
-
|
|
554
|
+
declare const ResetUrxvtExtMouseMode: string;
|
|
555
555
|
/** Sequence to request URXVT Extended Mouse Mode state: `CSI ? 1015 $ p` */
|
|
556
|
-
|
|
556
|
+
declare const RequestUrxvtExtMouseMode: string;
|
|
557
557
|
/**
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
558
|
+
* DEC Private Mode 1016: SGR Pixel Extended Mouse Mode.
|
|
559
|
+
* Similar to SGR Extended Mode, but reports pixel coordinates.
|
|
560
|
+
* @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Mouse-Tracking}
|
|
561
|
+
*/
|
|
562
|
+
declare const SgrPixelExtMouseMode: AnsiMode;
|
|
563
563
|
/** Sequence to set SGR Pixel Extended Mouse Mode: `CSI ? 1016 h` */
|
|
564
|
-
|
|
564
|
+
declare const SetSgrPixelExtMouseMode: string;
|
|
565
565
|
/** Sequence to reset SGR Pixel Extended Mouse Mode: `CSI ? 1016 l` */
|
|
566
|
-
|
|
566
|
+
declare const ResetSgrPixelExtMouseMode: string;
|
|
567
567
|
/** Sequence to request SGR Pixel Extended Mouse Mode state: `CSI ? 1016 $ p` */
|
|
568
|
-
|
|
569
|
-
/**
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
/**
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
/**
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
568
|
+
declare const RequestSgrPixelExtMouseMode: string;
|
|
569
|
+
/**
|
|
570
|
+
* DEC Private Mode 1006: SGR Extended Mouse Mode (alias for SgrExtMouseMode).
|
|
571
|
+
* Mouse events reported with SGR parameters: `CSI < Cb ; Cx ; Py M` (press) / `m` (release).
|
|
572
|
+
* Robust and recommended for modern applications.
|
|
573
|
+
* @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Mouse-Tracking}
|
|
574
|
+
*/
|
|
575
|
+
declare const SGRMouseMode: AnsiMode;
|
|
576
|
+
/**
|
|
577
|
+
* DEC Private Mode 1004: Send Focus Events Mode (alias for FocusEventMode).
|
|
578
|
+
* Reports terminal focus (FocusIn `CSI I`) and blur (FocusOut `CSI O`) events.
|
|
579
|
+
* @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Focus-Tracking}
|
|
580
|
+
*/
|
|
581
|
+
declare const SendFocusEventsMode: AnsiMode;
|
|
582
|
+
/**
|
|
583
|
+
* DEC Private Mode 1035: Disable Modifiers Mode.
|
|
584
|
+
* Disables modifier key reporting in mouse events.
|
|
585
|
+
* @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Mouse-Tracking}
|
|
586
|
+
*/
|
|
587
|
+
declare const DisableModifiersMode: AnsiMode;
|
|
588
588
|
/** Sequence to set Disable Modifiers Mode: `CSI ? 1035 h` */
|
|
589
|
-
|
|
589
|
+
declare const SetDisableModifiersMode: string;
|
|
590
590
|
/** Sequence to reset Disable Modifiers Mode: `CSI ? 1035 l` */
|
|
591
|
-
|
|
591
|
+
declare const ResetDisableModifiersMode: string;
|
|
592
592
|
/** Sequence to request Disable Modifiers Mode state: `CSI ? 1035 $ p` */
|
|
593
|
-
|
|
593
|
+
declare const RequestDisableModifiersMode: string;
|
|
594
594
|
/**
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
595
|
+
* DEC Private Mode 1047: Alternate Screen Mode.
|
|
596
|
+
* Switches to alternate screen buffer and clears it.
|
|
597
|
+
* @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-The-Alternate-Screen-Buffer}
|
|
598
|
+
*/
|
|
599
|
+
declare const AltScreenMode: AnsiMode;
|
|
600
600
|
/** Sequence to set Alternate Screen Mode: `CSI ? 1047 h` */
|
|
601
|
-
|
|
601
|
+
declare const SetAltScreenMode: string;
|
|
602
602
|
/** Sequence to reset Alternate Screen Mode: `CSI ? 1047 l` */
|
|
603
|
-
|
|
603
|
+
declare const ResetAltScreenMode: string;
|
|
604
604
|
/** Sequence to request Alternate Screen Mode state: `CSI ? 1047 $ p` */
|
|
605
|
-
|
|
605
|
+
declare const RequestAltScreenMode: string;
|
|
606
606
|
/**
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
607
|
+
* DEC Private Mode 1048: Save Cursor Mode.
|
|
608
|
+
* Saves current cursor position (like DECSC).
|
|
609
|
+
* @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-The-Alternate-Screen-Buffer}
|
|
610
|
+
*/
|
|
611
|
+
declare const SaveCursorMode: AnsiMode;
|
|
612
612
|
/** Sequence to set Save Cursor Mode: `CSI ? 1048 h` */
|
|
613
|
-
|
|
613
|
+
declare const SetSaveCursorMode: string;
|
|
614
614
|
/** Sequence to reset Save Cursor Mode: `CSI ? 1048 l` */
|
|
615
|
-
|
|
615
|
+
declare const ResetSaveCursorMode: string;
|
|
616
616
|
/** Sequence to request Save Cursor Mode state: `CSI ? 1048 $ p` */
|
|
617
|
-
|
|
618
|
-
/**
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
617
|
+
declare const RequestSaveCursorMode: string;
|
|
618
|
+
/**
|
|
619
|
+
* DEC Private Mode 1049: Alternate Screen Save Cursor Mode.
|
|
620
|
+
* Saves cursor, switches to alternate screen buffer, and clears screen.
|
|
621
|
+
* Widely used by full-screen applications.
|
|
622
|
+
* @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-The-Alternate-Screen-Buffer}
|
|
623
|
+
*/
|
|
624
|
+
declare const AltScreenSaveCursorMode: AnsiMode;
|
|
625
625
|
/** Sequence to set Alternate Screen Save Cursor Mode: `CSI ? 1049 h` */
|
|
626
|
-
|
|
626
|
+
declare const SetAltScreenSaveCursorMode: string;
|
|
627
627
|
/** Sequence to reset Alternate Screen Save Cursor Mode: `CSI ? 1049 l` */
|
|
628
|
-
|
|
628
|
+
declare const ResetAltScreenSaveCursorMode: string;
|
|
629
629
|
/** Sequence to request Alternate Screen Save Cursor Mode state: `CSI ? 1049 $ p` */
|
|
630
|
-
|
|
631
|
-
/**
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
630
|
+
declare const RequestAltScreenSaveCursorMode: string;
|
|
631
|
+
/**
|
|
632
|
+
* DEC Private Mode 2004: Bracketed Paste Mode.
|
|
633
|
+
* Encloses pasted text with `ESC [ 200 ~` and `ESC [ 201 ~`.
|
|
634
|
+
* Allows applications to distinguish pasted text from typed text.
|
|
635
|
+
* @see {@link https://cirw.in/blog/bracketed-paste}
|
|
636
|
+
* @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Bracketed-Paste-Mode}
|
|
637
|
+
*/
|
|
638
|
+
declare const BracketedPasteMode: AnsiMode;
|
|
639
639
|
/** Sequence to set Bracketed Paste Mode: `CSI ? 2004 h` */
|
|
640
|
-
|
|
640
|
+
declare const SetBracketedPasteMode: string;
|
|
641
641
|
/** Sequence to reset Bracketed Paste Mode: `CSI ? 2004 l` */
|
|
642
|
-
|
|
642
|
+
declare const ResetBracketedPasteMode: string;
|
|
643
643
|
/** Sequence to request Bracketed Paste Mode state: `CSI ? 2004 $ p` */
|
|
644
|
-
|
|
645
|
-
/**
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
644
|
+
declare const RequestBracketedPasteMode: string;
|
|
645
|
+
/**
|
|
646
|
+
* DEC Private Mode 2026: Synchronized Output Mode.
|
|
647
|
+
* Helps synchronize output with the terminal, preventing issues like screen tearing or garbled output
|
|
648
|
+
* when rapid updates occur. The exact mechanism can vary (e.g., batching updates, waiting for vsync).
|
|
649
|
+
* @see {@link https://gist.github.com/christianparpart/d8a62cc1ab659194337d73e399004036}
|
|
650
|
+
*/
|
|
651
|
+
declare const SynchronizedOutputMode: AnsiMode;
|
|
652
652
|
/** Sequence to set Synchronized Output Mode: `CSI ? 2026 h` */
|
|
653
|
-
|
|
653
|
+
declare const SetSynchronizedOutputMode: string;
|
|
654
654
|
/** Sequence to reset Synchronized Output Mode: `CSI ? 2026 l` */
|
|
655
|
-
|
|
655
|
+
declare const ResetSynchronizedOutputMode: string;
|
|
656
656
|
/** Sequence to request Synchronized Output Mode state: `CSI ? 2026 $ p` */
|
|
657
|
-
|
|
658
|
-
/**
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
657
|
+
declare const RequestSynchronizedOutputMode: string;
|
|
658
|
+
/**
|
|
659
|
+
* DEC Private Mode 2027: Unicode Core Mode.
|
|
660
|
+
* Determines whether the terminal should use Unicode grapheme clustering to calculate
|
|
661
|
+
* the width of glyphs for each terminal cell.
|
|
662
|
+
* @see {@link https://github.com/contour-terminal/terminal-unicode-core}
|
|
663
|
+
*/
|
|
664
|
+
declare const UnicodeCoreMode: AnsiMode;
|
|
665
665
|
/** Sequence to set Unicode Core Mode: `CSI ? 2027 h` */
|
|
666
|
-
|
|
666
|
+
declare const SetUnicodeCoreMode: string;
|
|
667
667
|
/** Sequence to reset Unicode Core Mode: `CSI ? 2027 l` */
|
|
668
|
-
|
|
668
|
+
declare const ResetUnicodeCoreMode: string;
|
|
669
669
|
/** Sequence to request Unicode Core Mode state: `CSI ? 2027 $ p` */
|
|
670
|
-
|
|
671
|
-
/**
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
670
|
+
declare const RequestUnicodeCoreMode: string;
|
|
671
|
+
/**
|
|
672
|
+
* DEC Private Mode 2027: Grapheme Clustering Mode.
|
|
673
|
+
* Instructs the terminal to treat grapheme clusters as single units for rendering and cursor movement.
|
|
674
|
+
* Important for correct display of complex scripts and emojis.
|
|
675
|
+
* @deprecated Use {@link UnicodeCoreMode} instead.
|
|
676
|
+
* @see {@link https://github.com/contour-terminal/terminal-unicode-core}
|
|
677
|
+
*/
|
|
678
|
+
declare const GraphemeClusteringMode: AnsiMode;
|
|
679
679
|
/** @deprecated Use {@link SetUnicodeCoreMode} instead. */
|
|
680
|
-
|
|
680
|
+
declare const SetGraphemeClusteringMode: string;
|
|
681
681
|
/** @deprecated Use {@link ResetUnicodeCoreMode} instead. */
|
|
682
|
-
|
|
682
|
+
declare const ResetGraphemeClusteringMode: string;
|
|
683
683
|
/** @deprecated Use {@link RequestUnicodeCoreMode} instead. */
|
|
684
|
-
|
|
684
|
+
declare const RequestGraphemeClusteringMode: string;
|
|
685
685
|
/**
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
686
|
+
* DEC Private Mode 9001: Win32 Input Mode.
|
|
687
|
+
* Relevant for Windows conPTY, influencing how keyboard input is processed and translated.
|
|
688
|
+
* @see {@link https://github.com/microsoft/terminal/blob/main/doc/specs/%234999%20-%20Improved%20keyboard%20handling%20in%20Conpty.md}
|
|
689
|
+
*/
|
|
690
|
+
declare const Win32InputMode: AnsiMode;
|
|
691
691
|
/** Sequence to set Win32 Input Mode: `CSI ? 9001 h` */
|
|
692
|
-
|
|
692
|
+
declare const SetWin32InputMode: string;
|
|
693
693
|
/** Sequence to reset Win32 Input Mode: `CSI ? 9001 l` */
|
|
694
|
-
|
|
694
|
+
declare const ResetWin32InputMode: string;
|
|
695
695
|
/** Sequence to request Win32 Input Mode state: `CSI ? 9001 $ p` */
|
|
696
|
-
|
|
697
|
-
/**
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
696
|
+
declare const RequestWin32InputMode: string;
|
|
697
|
+
/**
|
|
698
|
+
* DEC Private Mode 2031: Light/Dark Mode.
|
|
699
|
+
* Enables reporting the operating system's color scheme (light or dark) preference.
|
|
700
|
+
* Reports the color scheme as DSR sequences encoded as follows:
|
|
701
|
+
* - `CSI ? 997 ; 1 n` for dark mode
|
|
702
|
+
* - `CSI ? 997 ; 2 n` for light mode
|
|
703
|
+
* The color preference can also be requested via `CSI ? 996 n`.
|
|
704
|
+
* @see {@link https://contour-terminal.org/vt-extensions/color-palette-update-notifications/}
|
|
705
|
+
*/
|
|
706
|
+
declare const LightDarkMode: AnsiMode;
|
|
707
707
|
/** Sequence to set Light/Dark Mode: `CSI ? 2031 h` */
|
|
708
|
-
|
|
708
|
+
declare const SetLightDarkMode: string;
|
|
709
709
|
/** Sequence to reset Light/Dark Mode: `CSI ? 2031 l` */
|
|
710
|
-
|
|
710
|
+
declare const ResetLightDarkMode: string;
|
|
711
711
|
/** Sequence to request Light/Dark Mode state: `CSI ? 2031 $ p` */
|
|
712
|
-
|
|
713
|
-
/**
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
712
|
+
declare const RequestLightDarkMode: string;
|
|
713
|
+
/**
|
|
714
|
+
* DEC Private Mode 2048: In-Band Resize Mode.
|
|
715
|
+
* Reports terminal resize events as escape sequences.
|
|
716
|
+
* This is useful for systems that do not support SIGWINCH like Windows.
|
|
717
|
+
* The terminal sends: `CSI 48 ; cellsHeight ; cellsWidth ; pixelHeight ; pixelWidth t`
|
|
718
|
+
* @see {@link https://gist.github.com/rockorager/e695fb2924d36b2bcf1fff4a3704bd83}
|
|
719
|
+
*/
|
|
720
|
+
declare const InBandResizeMode: AnsiMode;
|
|
721
721
|
/** Sequence to set In-Band Resize Mode: `CSI ? 2048 h` */
|
|
722
|
-
|
|
722
|
+
declare const SetInBandResizeMode: string;
|
|
723
723
|
/** Sequence to reset In-Band Resize Mode: `CSI ? 2048 l` */
|
|
724
|
-
|
|
724
|
+
declare const ResetInBandResizeMode: string;
|
|
725
725
|
/** Sequence to request In-Band Resize Mode state: `CSI ? 2048 $ p` */
|
|
726
|
-
|
|
726
|
+
declare const RequestInBandResizeMode: string;
|
|
727
|
+
export { AltScreenMode, AltScreenSaveCursorMode, AnsiMode, AnyEventMouseMode, AutoWrapMode, BDSM, BackarrowKeyMode, BiDirectionalSupportMode, BracketedPasteMode, ButtonEventMouseMode, CursorKeysMode, DECAWM, DECBKM, DECCKM, DECLRMM, DECNKM, DECOM, DECRPM, DECRQM, DECTCEM, DecMode, DisableModifiersMode, FocusEventMode, GraphemeClusteringMode, HideCursor, HighlightMouseMode, IRM, InBandResizeMode, InsertReplaceMode, KAM, KeyboardActionMode, LNM, LeftRightMarginMode, LightDarkMode, LineFeedNewLineMode, LocalEchoMode, Mode, ModeSetting, NormalMouseMode, NumericKeypadMode, OriginMode, RM, RequestAltScreenMode, RequestAltScreenSaveCursorMode, RequestAnyEventMouseMode, RequestAutoWrapMode, RequestBackarrowKeyMode, RequestBiDirectionalSupportMode, RequestBracketedPasteMode, RequestButtonEventMouseMode, RequestCursorKeysMode, RequestDisableModifiersMode, RequestFocusEventMode, RequestGraphemeClusteringMode, RequestHighlightMouseMode, RequestInBandResizeMode, RequestInsertReplaceMode, RequestKeyboardActionMode, RequestLeftRightMarginMode, RequestLightDarkMode, RequestLineFeedNewLineMode, RequestLocalEchoMode, RequestNormalMouseMode, RequestNumericKeypadMode, RequestOriginMode, RequestSaveCursorMode, RequestSendReceiveMode, RequestSgrExtMouseMode, RequestSgrPixelExtMouseMode, RequestSynchronizedOutputMode, RequestTextCursorEnableMode, RequestUnicodeCoreMode, RequestUrxvtExtMouseMode, RequestUtf8ExtMouseMode, RequestWin32InputMode, RequestX10MouseMode, ResetAltScreenMode, ResetAltScreenSaveCursorMode, ResetAnyEventMouseMode, ResetAutoWrapMode, ResetBackarrowKeyMode, ResetBiDirectionalSupportMode, ResetBracketedPasteMode, ResetButtonEventMouseMode, ResetCursorKeysMode, ResetDisableModifiersMode, ResetFocusEventMode, ResetGraphemeClusteringMode, ResetHighlightMouseMode, ResetInBandResizeMode, ResetInsertReplaceMode, ResetKeyboardActionMode, ResetLeftRightMarginMode, ResetLightDarkMode, ResetLineFeedNewLineMode, ResetLocalEchoMode, ResetNormalMouseMode, ResetNumericKeypadMode, ResetOriginMode, ResetSaveCursorMode, ResetSendReceiveMode, ResetSgrExtMouseMode, ResetSgrPixelExtMouseMode, ResetSynchronizedOutputMode, ResetTextCursorEnableMode, ResetUnicodeCoreMode, ResetUrxvtExtMouseMode, ResetUtf8ExtMouseMode, ResetWin32InputMode, ResetX10MouseMode, SGRMouseMode, SM, SRM, SaveCursorMode, SendFocusEventsMode, SendReceiveMode, SetAltScreenMode, SetAltScreenSaveCursorMode, SetAnyEventMouseMode, SetAutoWrapMode, SetBackarrowKeyMode, SetBiDirectionalSupportMode, SetBracketedPasteMode, SetButtonEventMouseMode, SetCursorKeysMode, SetDisableModifiersMode, SetFocusEventMode, SetGraphemeClusteringMode, SetHighlightMouseMode, SetInBandResizeMode, SetInsertReplaceMode, SetKeyboardActionMode, SetLeftRightMarginMode, SetLightDarkMode, SetLineFeedNewLineMode, SetLocalEchoMode, SetNormalMouseMode, SetNumericKeypadMode, SetOriginMode, SetSaveCursorMode, SetSendReceiveMode, SetSgrExtMouseMode, SetSgrPixelExtMouseMode, SetSynchronizedOutputMode, SetTextCursorEnableMode, SetUnicodeCoreMode, SetUrxvtExtMouseMode, SetUtf8ExtMouseMode, SetWin32InputMode, SetX10MouseMode, SgrExtMouseMode, SgrPixelExtMouseMode, ShowCursor, SynchronizedOutputMode, TextCursorEnableMode, UnicodeCoreMode, UrxvtExtMouseMode, Utf8ExtMouseMode, Win32InputMode, X10MouseMode, createAnsiMode, createDecMode, isModeNotRecognized, isModePermanentlyReset, isModePermanentlySet, isModeReset, isModeSet, reportMode, requestMode, resetMode, setMode };
|