Explain vc-BACKEND-root in Commentary; nfc.
[emacs.git] / src / termchar.h
blob390b6490b6346e6a0d7546496438c4d2d1fa99b1
1 /* Flags and parameters describing terminal's characteristics.
2 Copyright (C) 1985, 1986, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
22 /* Each termcap frame points to its own struct tty_output object in
23 the output_data.tty field. The tty_output structure contains the
24 information that is specific to termcap frames. */
26 struct tty_output
28 /* The Emacs structure for the tty device this frame is on. */
29 struct tty_display_info *display_info;
31 /* There is nothing else here at the moment... */
34 /* Parameters that are shared between frames on the same tty device. */
36 struct tty_display_info
38 struct tty_display_info *next; /* Chain of all tty devices. */
40 char *name; /* The name of the device file or 0 if
41 stdin/stdout. */
42 char *type; /* The type of the tty. */
44 /* Input/output */
46 FILE *input; /* The stream to be used for terminal input.
47 NULL if the terminal is suspended. */
48 FILE *output; /* The stream to be used for terminal output.
49 NULL if the terminal is suspended. */
51 FILE *termscript; /* If nonzero, send all terminal output
52 characters to this stream also. */
54 struct emacs_tty *old_tty; /* The initial tty mode bits */
56 int term_initted; /* 1 if we have been through init_sys_modes. */
59 int reference_count; /* Number of frames that are on this display. */
61 struct terminal *terminal; /* Points back to the generic terminal
62 structure. This is sometimes handy. */
64 /* Info on cursor positioning. */
65 struct cm *Wcm;
67 /* Redisplay. */
69 Lisp_Object top_frame; /* The topmost frame on this tty. */
71 /* The previous frame we displayed on this tty. */
72 struct frame *previous_frame;
74 /* Strings, numbers and flags taken from the termcap entry. */
76 char *TS_ins_line; /* "al" */
77 char *TS_ins_multi_lines; /* "AL" (one parameter, # lines to insert) */
78 char *TS_bell; /* "bl" */
79 char *TS_clr_to_bottom; /* "cd" */
80 char *TS_clr_line; /* "ce", clear to end of line */
81 char *TS_clr_frame; /* "cl" */
82 char *TS_set_scroll_region; /* "cs" (2 params, first line and last line) */
83 char *TS_set_scroll_region_1; /* "cS" (4 params: total lines,
84 lines above scroll region, lines below it,
85 total lines again) */
86 char *TS_del_char; /* "dc" */
87 char *TS_del_multi_chars; /* "DC" (one parameter, # chars to delete) */
88 char *TS_del_line; /* "dl" */
89 char *TS_del_multi_lines; /* "DL" (one parameter, # lines to delete) */
90 char *TS_delete_mode; /* "dm", enter character-delete mode */
91 char *TS_end_delete_mode; /* "ed", leave character-delete mode */
92 char *TS_end_insert_mode; /* "ei", leave character-insert mode */
93 char *TS_ins_char; /* "ic" */
94 char *TS_ins_multi_chars; /* "IC" (one parameter, # chars to insert) */
95 char *TS_insert_mode; /* "im", enter character-insert mode */
96 char *TS_pad_inserted_char; /* "ip". Just padding, no commands. */
97 char *TS_end_keypad_mode; /* "ke" */
98 char *TS_keypad_mode; /* "ks" */
99 char *TS_pad_char; /* "pc", char to use as padding */
100 char *TS_repeat; /* "rp" (2 params, # times to repeat
101 and character to be repeated) */
102 char *TS_end_standout_mode; /* "se" */
103 char *TS_fwd_scroll; /* "sf" */
104 char *TS_standout_mode; /* "so" */
105 char *TS_rev_scroll; /* "sr" */
106 char *TS_end_termcap_modes; /* "te" */
107 char *TS_termcap_modes; /* "ti" */
108 char *TS_visible_bell; /* "vb" */
109 char *TS_cursor_normal; /* "ve" */
110 char *TS_cursor_visible; /* "vs" */
111 char *TS_cursor_invisible; /* "vi" */
112 char *TS_set_window; /* "wi" (4 params, start and end of window,
113 each as vpos and hpos) */
115 char *TS_enter_bold_mode; /* "md" -- turn on bold (extra bright mode). */
116 char *TS_enter_dim_mode; /* "mh" -- turn on half-bright mode. */
117 char *TS_enter_blink_mode; /* "mb" -- enter blinking mode. */
118 char *TS_enter_reverse_mode; /* "mr" -- enter reverse video mode. */
119 char *TS_exit_underline_mode; /* "us" -- start underlining. */
120 char *TS_enter_underline_mode; /* "ue" -- end underlining. */
122 /* "as"/"ae" -- start/end alternate character set. Not really
123 supported, yet. */
124 char *TS_enter_alt_charset_mode;
125 char *TS_exit_alt_charset_mode;
127 char *TS_exit_attribute_mode; /* "me" -- switch appearances off. */
129 /* Value of the "NC" (no_color_video) capability, or 0 if not present. */
130 int TN_no_color_video;
132 int TN_max_colors; /* "Co" -- number of colors. */
134 /* "pa" -- max. number of color pairs on screen. Not handled yet.
135 Could be a problem if not equal to TN_max_colors * TN_max_colors. */
136 int TN_max_pairs;
138 /* "op" -- SVr4 set default pair to its original value. */
139 char *TS_orig_pair;
141 /* "AF"/"AB" or "Sf"/"Sb"-- set ANSI or SVr4 foreground/background color.
142 1 param, the color index. */
143 char *TS_set_foreground;
144 char *TS_set_background;
146 int TF_hazeltine; /* termcap hz flag. */
147 int TF_insmode_motion; /* termcap mi flag: can move while in insert mode. */
148 int TF_standout_motion; /* termcap mi flag: can move while in standout mode. */
149 int TF_underscore; /* termcap ul flag: _ underlines if over-struck on
150 non-blank position. Must clear before writing _. */
151 int TF_teleray; /* termcap xt flag: many weird consequences.
152 For t1061. */
154 int RPov; /* # chars to start a TS_repeat */
156 int delete_in_insert_mode; /* delete mode == insert mode */
158 int se_is_so; /* 1 if same string both enters and leaves
159 standout mode */
161 int costs_set; /* Nonzero if costs have been calculated. */
163 int insert_mode; /* Nonzero when in insert mode. */
164 int standout_mode; /* Nonzero when in standout mode. */
168 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
169 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
171 int meta_key;
173 /* Size of window specified by higher levels.
174 This is the number of lines, from the top of frame downwards,
175 which can participate in insert-line/delete-line operations.
177 Effectively it excludes the bottom frame_lines - specified_window_size
178 lines from those operations. */
180 int specified_window;
182 /* Flag used in tty_show/hide_cursor. */
184 int cursor_hidden;
186 /* Nonzero means use ^S/^Q for flow control. */
187 int flow_control;
191 /* A chain of structures for all tty devices currently in use. */
192 extern struct tty_display_info *tty_list;
195 #define FRAME_TTY(f) \
196 ((f)->output_method == output_termcap \
197 ? (f)->terminal->display_info.tty \
198 : (abort(), (struct tty_display_info *) 0))
200 #define CURTTY() FRAME_TTY (SELECTED_FRAME())
202 /* arch-tag: bf9f0d49-842b-42fb-9348-ec8759b27193
203 (do not change this comment) */