1 /* Flags and parameters describing terminal's characteristics.
2 Copyright (C) 1985-1986, 2001-2023 Free Software Foundation, Inc.
3
4 This file is part of GNU Emacs.
5
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or (at
9 your option) any later version.
10
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. */
18
19 #ifndef EMACS_TERMCHAR_H
20 #define EMACS_TERMCHAR_H
21
22 #include <stdio.h>
23 #include "dispextern.h"
24
25 /* Each termcap frame points to its own struct tty_output object in
26 the output_data.tty field. The tty_output structure contains the
27 information that is specific to termcap frames. */
28
29 struct tty_output
30 {
31 /* The Emacs structure for the tty device this frame is on. */
32 struct tty_display_info *display_info;
33
34 /* There is nothing else here at the moment... */
35 };
36
37 enum { TERMCAP_BUFFER_SIZE = 4096 };
38
39 /* Parameters that are shared between frames on the same tty device. */
40
41 struct tty_display_info
42 {
43 struct tty_display_info *next; /* Chain of all tty devices. */
44
45 char *name; /* The name of the device file or 0 if
46 stdin/stdout. */
47 char *type; /* The type of the tty. */
48
49 /* Input/output */
50
51 FILE *input; /* The stream to be used for terminal input.
52 NULL if the terminal is suspended. */
53 FILE *output; /* The stream to be used for terminal output.
54 NULL if the terminal is suspended. */
55
56 /* Size of output buffer. A value of zero means use the default of
57 BUFIZE. If non-zero, also minimize writes to the tty by avoiding
58 calls to flush. */
59 size_t output_buffer_size;
60
61 FILE *termscript; /* If nonzero, send all terminal output
62 characters to this stream also. */
63
64 struct emacs_tty *old_tty; /* The initial tty mode bits */
65
66 bool_bf term_initted : 1; /* True if we have been through
67 init_sys_modes. */
68
69 int reference_count; /* Number of frames that are on this display. */
70
71 struct terminal *terminal; /* Points back to the generic terminal
72 structure. This is sometimes handy. */
73
74 /* Info on cursor positioning. */
75 struct cm *Wcm;
76
77 /* Redisplay. */
78
79 Lisp_Object top_frame; /* The topmost frame on this tty. */
80
81 /* The previous frame we displayed on this tty. */
82 struct frame *previous_frame;
83 int previous_color_mode;
84
85 /* Information about the range of text currently shown in
86 mouse-face. */
87 Mouse_HLInfo mouse_highlight;
88
89 /* Buffer used internally by termcap (see tgetent in the Termcap
90 manual). Only init_tty should use this. */
91 char termcap_term_buffer[TERMCAP_BUFFER_SIZE];
92
93 /* Buffer storing terminal description strings (see tgetstr in the
94 Termcap manual). Only init_tty should use this. */
95 char termcap_strings_buffer[TERMCAP_BUFFER_SIZE];
96
97 /* Strings, numbers and flags taken from the termcap entry. */
98
99 const char *TS_ins_line; /* "al" */
100 const char *TS_ins_multi_lines; /* "AL" (one parameter, # lines to insert) */
101 const char *TS_bell; /* "bl" */
102 const char *TS_clr_to_bottom; /* "cd" */
103 const char *TS_clr_line; /* "ce", clear to end of line */
104 const char *TS_clr_frame; /* "cl" */
105 const char *TS_set_scroll_region; /* "cs" (2 params, first line and last line) */
106 const char *TS_set_scroll_region_1; /* "cS" (4 params: total lines,
107 lines above scroll region, lines below it,
108 total lines again) */
109 const char *TS_del_char; /* "dc" */
110 const char *TS_del_multi_chars; /* "DC" (one parameter, # chars to delete) */
111 const char *TS_del_line; /* "dl" */
112 const char *TS_del_multi_lines; /* "DL" (one parameter, # lines to delete) */
113 const char *TS_delete_mode; /* "dm", enter character-delete mode */
114 const char *TS_end_delete_mode; /* "ed", leave character-delete mode */
115 const char *TS_end_insert_mode; /* "ei", leave character-insert mode */
116 const char *TS_ins_char; /* "ic" */
117 const char *TS_ins_multi_chars; /* "IC" (one parameter, # chars to insert) */
118 const char *TS_insert_mode; /* "im", enter character-insert mode */
119 const char *TS_pad_inserted_char; /* "ip". Just padding, no commands. */
120 const char *TS_end_keypad_mode; /* "ke" */
121 const char *TS_keypad_mode; /* "ks" */
122 const char *TS_pad_char; /* "pc", char to use as padding */
123 const char *TS_repeat; /* "rp" (2 params, # times to repeat
124 and character to be repeated) */
125 const char *TS_end_standout_mode; /* "se" */
126 const char *TS_fwd_scroll; /* "sf" */
127 const char *TS_standout_mode; /* "so" */
128 const char *TS_rev_scroll; /* "sr" */
129 const char *TS_end_termcap_modes; /* "te" */
130 const char *TS_termcap_modes; /* "ti" */
131 const char *TS_visible_bell; /* "vb" */
132 const char *TS_cursor_normal; /* "ve" */
133 const char *TS_cursor_visible; /* "vs" */
134 const char *TS_cursor_invisible; /* "vi" */
135 const char *TS_set_window; /* "wi" (4 params, start and end of window,
136 each as vpos and hpos) */
137
138 const char *TS_enter_bold_mode; /* "md" -- turn on bold (extra bright mode). */
139 const char *TS_enter_italic_mode; /* "ZH" -- turn on italics mode. */
140 const char *TS_enter_dim_mode; /* "mh" -- turn on half-bright mode. */
141 const char *TS_enter_reverse_mode; /* "mr" -- enter reverse video mode. */
142 const char *TS_exit_underline_mode; /* "us" -- start underlining. */
143 const char *TS_enter_underline_mode; /* "ue" -- end underlining. */
144 const char *TS_enter_strike_through_mode; /* "smxx" -- turn on strike-through
145 mode. */
146
147 /* "as"/"ae" -- start/end alternate character set. Not really
148 supported, yet. */
149 const char *TS_enter_alt_charset_mode;
150 const char *TS_exit_alt_charset_mode;
151
152 const char *TS_exit_attribute_mode; /* "me" -- switch appearances off. */
153
154 /* Value of the "NC" (no_color_video) capability, or 0 if not present. */
155 int TN_no_color_video;
156
157 int TN_max_colors; /* "Co" -- number of colors. */
158
159 /* "op" -- SVr4 set default pair to its original value. */
160 const char *TS_orig_pair;
161
162 /* "AF"/"AB" or "Sf"/"Sb"-- set ANSI or SVr4 foreground/background color.
163 1 param, the color index. */
164 const char *TS_set_foreground;
165 const char *TS_set_background;
166
167 int TF_hazeltine; /* termcap hz flag. */
168 int TF_insmode_motion; /* termcap mi flag: can move while in insert mode. */
169 int TF_standout_motion; /* termcap mi flag: can move while in standout mode. */
170 int TF_underscore; /* termcap ul flag: _ underlines if over-struck on
171 non-blank position. Must clear before writing _. */
172 int TF_teleray; /* termcap xt flag: many weird consequences.
173 For t1061. */
174
175 int RPov; /* # chars to start a TS_repeat */
176
177 bool_bf delete_in_insert_mode : 1; /* delete mode == insert mode */
178
179 bool_bf costs_set : 1; /* True if costs have been calculated. */
180
181 bool_bf insert_mode : 1; /* True when in insert mode. */
182 bool_bf standout_mode : 1; /* True when in standout mode. */
183
184 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
185 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
186
187 int meta_key;
188
189 /* Size of window specified by higher levels.
190 This is the number of lines, from the top of frame downwards,
191 which can participate in insert-line/delete-line operations.
192
193 Effectively it excludes the bottom frame_lines - specified_window_size
194 lines from those operations. */
195
196 int specified_window;
197
198 /* Flag used in tty_show/hide_cursor. */
199
200 bool_bf cursor_hidden : 1;
201
202 /* True means use ^S/^Q for flow control. */
203
204 bool_bf flow_control : 1;
205
206 /* True means we are displaying a TTY menu on this tty. */
207 bool_bf showing_menu : 1;
208
209 /* True means spaces in the text must actually be output;
210 can't just skip over some columns to leave them blank. */
211 bool_bf must_write_spaces : 1;
212
213 /* True if TTY can insert and delete lines. */
214 bool_bf line_ins_del_ok : 1;
215
216 /* True if TTY can insert and delete chars. */
217 bool_bf char_ins_del_ok : 1;
218
219 /* True if TTY supports setting the scroll window. */
220 bool_bf scroll_region_ok : 1;
221
222 /* True if TTY remembers lines scrolled off bottom. */
223 bool_bf memory_below_frame : 1;
224
225 /* Cost of setting the scroll window, measured in characters. */
226 int scroll_region_cost;
227 };
228
229 /* A chain of structures for all tty devices currently in use. */
230 extern struct tty_display_info *tty_list;
231
232
233 #define FRAME_TTY(f) \
234 (((f)->output_method == output_termcap \
235 || (f)->output_method == output_msdos_raw) \
236 ? (f)->terminal->display_info.tty \
237 : (emacs_abort (), (struct tty_display_info *) 0))
238
239 #define CURTTY() FRAME_TTY (SELECTED_FRAME())
240
241 struct input_event;
242 extern Lisp_Object tty_handle_tab_bar_click (struct frame *, int, int, bool,
243 struct input_event *);
244
245 #endif /* EMACS_TERMCHAR_H */