[bpt/emacs.git] / src / termchar.h

/* Flags and parameters describing terminal's characteristics.
   Copyright (C) 1985, 1986, 2001, 2002, 2003, 2004,
                 2005, 2006, 2007, 2008, 2009, 2010  Free Software Foundation, Inc.

This file is part of GNU Emacs.

GNU Emacs is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */

/* Each termcap frame points to its own struct tty_output object in
   the output_data.tty field.  The tty_output structure contains the
   information that is specific to termcap frames. */

struct tty_output
{
  /* The Emacs structure for the tty device this frame is on. */
  struct tty_display_info *display_info;

  /* There is nothing else here at the moment... */
};

/* Parameters that are shared between frames on the same tty device. */

struct tty_display_info
{
  struct tty_display_info *next; /* Chain of all tty devices. */

  char *name;                   /* The name of the device file or 0 if
                                   stdin/stdout. */
  char *type;                   /* The type of the tty. */

  /* Input/output */

  FILE *input;                  /* The stream to be used for terminal input.
                                   NULL if the terminal is suspended. */
  FILE *output;                 /* The stream to be used for terminal output.
                                   NULL if the terminal is suspended. */

  FILE *termscript;             /* If nonzero, send all terminal output
                                   characters to this stream also.  */

  struct emacs_tty *old_tty;    /* The initial tty mode bits */

  int term_initted;             /* 1 if we have been through init_sys_modes. */


  int reference_count;          /* Number of frames that are on this display. */

  struct terminal *terminal;    /* Points back to the generic terminal
                                   structure.  This is sometimes handy. */

  /* Info on cursor positioning.  */
  struct cm *Wcm;

  /* Redisplay. */

  Lisp_Object top_frame;        /* The topmost frame on this tty. */

  /* The previous frame we displayed on this tty.  */
  struct frame *previous_frame;
  int previous_color_mode;

  /* Information about the range of text currently shown in
     mouse-face.  */
  Mouse_HLInfo mouse_highlight;

  /* Buffer used internally by termcap (see tgetent in the Termcap
     manual).  Only init_tty and delete_tty should change this.  */
  char *termcap_term_buffer;

  /* Buffer storing terminal description strings (see tgetstr in the
     Termcap manual).  Only init_tty and delete_tty should change
     this.  */
  char *termcap_strings_buffer;

  /* Strings, numbers and flags taken from the termcap entry.  */

  char *TS_ins_line;		/* "al" */
  char *TS_ins_multi_lines;	/* "AL" (one parameter, # lines to insert) */
  char *TS_bell;                /* "bl" */
  char *TS_clr_to_bottom;       /* "cd" */
  char *TS_clr_line;		/* "ce", clear to end of line */
  char *TS_clr_frame;		/* "cl" */
  char *TS_set_scroll_region;	/* "cs" (2 params, first line and last line) */
  char *TS_set_scroll_region_1; /* "cS" (4 params: total lines,
                                   lines above scroll region, lines below it,
                                   total lines again) */
  char *TS_del_char;		/* "dc" */
  char *TS_del_multi_chars;	/* "DC" (one parameter, # chars to delete) */
  char *TS_del_line;		/* "dl" */
  char *TS_del_multi_lines;	/* "DL" (one parameter, # lines to delete) */
  char *TS_delete_mode;		/* "dm", enter character-delete mode */
  char *TS_end_delete_mode;	/* "ed", leave character-delete mode */
  char *TS_end_insert_mode;	/* "ei", leave character-insert mode */
  char *TS_ins_char;		/* "ic" */
  char *TS_ins_multi_chars;	/* "IC" (one parameter, # chars to insert) */
  char *TS_insert_mode;		/* "im", enter character-insert mode */
  char *TS_pad_inserted_char;	/* "ip".  Just padding, no commands.  */
  char *TS_end_keypad_mode;	/* "ke" */
  char *TS_keypad_mode;		/* "ks" */
  char *TS_pad_char;		/* "pc", char to use as padding */
  char *TS_repeat;		/* "rp" (2 params, # times to repeat
				   and character to be repeated) */
  char *TS_end_standout_mode;	/* "se" */
  char *TS_fwd_scroll;		/* "sf" */
  char *TS_standout_mode;       /* "so" */
  char *TS_rev_scroll;          /* "sr" */
  char *TS_end_termcap_modes;   /* "te" */
  char *TS_termcap_modes;       /* "ti" */
  char *TS_visible_bell;        /* "vb" */
  char *TS_cursor_normal;       /* "ve" */
  char *TS_cursor_visible;      /* "vs" */
  char *TS_cursor_invisible;    /* "vi" */
  char *TS_set_window;          /* "wi" (4 params, start and end of window,
                                   each as vpos and hpos) */

  char *TS_enter_bold_mode;     /* "md" -- turn on bold (extra bright mode).  */
  char *TS_enter_dim_mode;      /* "mh" -- turn on half-bright mode.  */
  char *TS_enter_blink_mode;    /* "mb" -- enter blinking mode.  */
  char *TS_enter_reverse_mode;  /* "mr" -- enter reverse video mode.  */
  char *TS_exit_underline_mode; /* "us" -- start underlining.  */
  char *TS_enter_underline_mode; /* "ue" -- end underlining.  */

  /* "as"/"ae" -- start/end alternate character set.  Not really
     supported, yet.  */
  char *TS_enter_alt_charset_mode;
  char *TS_exit_alt_charset_mode;

  char *TS_exit_attribute_mode; /* "me" -- switch appearances off.  */

  /* Value of the "NC" (no_color_video) capability, or 0 if not present.  */
  int TN_no_color_video;

  int TN_max_colors;            /* "Co" -- number of colors.  */

  /* "pa" -- max. number of color pairs on screen.  Not handled yet.
     Could be a problem if not equal to TN_max_colors * TN_max_colors.  */
  int TN_max_pairs;

  /* "op" -- SVr4 set default pair to its original value.  */
  char *TS_orig_pair;

  /* "AF"/"AB" or "Sf"/"Sb"-- set ANSI or SVr4 foreground/background color.
     1 param, the color index.  */
  char *TS_set_foreground;
  char *TS_set_background;

  int TF_hazeltine;             /* termcap hz flag. */
  int TF_insmode_motion;        /* termcap mi flag: can move while in insert mode. */
  int TF_standout_motion;       /* termcap mi flag: can move while in standout mode. */
  int TF_underscore;            /* termcap ul flag: _ underlines if over-struck on
                                   non-blank position.  Must clear before writing _.  */
  int TF_teleray;               /* termcap xt flag: many weird consequences.
                                   For t1061. */

  int RPov;                     /* # chars to start a TS_repeat */

  int delete_in_insert_mode;    /* delete mode == insert mode */

  int se_is_so;                 /* 1 if same string both enters and leaves
                                   standout mode */

  int costs_set;                /* Nonzero if costs have been calculated. */

  int insert_mode;              /* Nonzero when in insert mode.  */
  int standout_mode;            /* Nonzero when in standout mode.  */


  /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
     keep 0200 bit in input chars.  0 to ignore the 0200 bit.  */

  int meta_key;

  /* Size of window specified by higher levels.
   This is the number of lines, from the top of frame downwards,
   which can participate in insert-line/delete-line operations.

   Effectively it excludes the bottom frame_lines - specified_window_size
   lines from those operations.  */

  int specified_window;

  /* Flag used in tty_show/hide_cursor.  */

  int cursor_hidden;

  /* Nonzero means use ^S/^Q for flow control.  */
  int flow_control;

};

/* A chain of structures for all tty devices currently in use. */
extern struct tty_display_info *tty_list;


#define FRAME_TTY(f)                            \
  (((f)->output_method == output_termcap	\
    || (f)->output_method == output_msdos_raw)	\
   ? (f)->terminal->display_info.tty            \
   : (abort(), (struct tty_display_info *) 0))

#define CURTTY() FRAME_TTY (SELECTED_FRAME())

/* arch-tag: bf9f0d49-842b-42fb-9348-ec8759b27193
   (do not change this comment) */
Commit	Line	Data
9889c728	1	/* Flags and parameters describing terminal's characteristics.
429ab54e	2	Copyright (C) 1985, 1986, 2001, 2002, 2003, 2004,
114f9c96	3	2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
9889c728 JB	4
	5	This file is part of GNU Emacs.
	6
b9b1cc14	7	GNU Emacs is free software: you can redistribute it and/or modify
9889c728	8	it under the terms of the GNU General Public License as published by
b9b1cc14 GM	9	the Free Software Foundation, either version 3 of the License, or
b9b1cc14 GM	10	(at your option) any later version.
9889c728 JB	11
	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.
	16
	17	You should have received a copy of the GNU General Public License
b9b1cc14	18	along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
9889c728	19
28d7d09f KL	20	/* Each termcap frame points to its own struct tty_output object in
	21	the output_data.tty field. The tty_output structure contains the
	22	information that is specific to termcap frames. */
da8e1115	23
28d440ab	24	struct tty_output
8a56675d	25	{
28d7d09f KL	26	/* The Emacs structure for the tty device this frame is on. */
	27	struct tty_display_info *display_info;
	28
	29	/* There is nothing else here at the moment... */
	30	};
	31
	32	/* Parameters that are shared between frames on the same tty device. */
da8e1115	33
28d7d09f KL	34	struct tty_display_info
	35	{
	36	struct tty_display_info next; / Chain of all tty devices. */
d009ae66	37
28d440ab KL	38	char name; / The name of the device file or 0 if
	39	stdin/stdout. */
	40	char type; / The type of the tty. */
d009ae66	41
28d440ab	42	/* Input/output */
d009ae66	43
0b0d3e0b KL	44	FILE input; / The stream to be used for terminal input.
	45	NULL if the terminal is suspended. */
	46	FILE output; / The stream to be used for terminal output.
	47	NULL if the terminal is suspended. */
d009ae66	48
28d440ab KL	49	FILE termscript; / If nonzero, send all terminal output
	50	characters to this stream also. */
	51
fca177d4	52	struct emacs_tty old_tty; / The initial tty mode bits */
28d440ab KL	53
28d440ab KL	54	int term_initted; /* 1 if we have been through init_sys_modes. */
9628b887 KL	55
9628b887 KL	56
28d7d09f	57	int reference_count; /* Number of frames that are on this display. */
3224dac1	58
6ed8eeff	59	struct terminal terminal; / Points back to the generic terminal
3224dac1	60	structure. This is sometimes handy. */
6ed8eeff	61
28d7d09f	62	/* Info on cursor positioning. */
6548cf00 KL	63	struct cm *Wcm;
6548cf00 KL	64
9628b887 KL	65	/* Redisplay. */
9628b887 KL	66
9628b887	67	Lisp_Object top_frame; /* The topmost frame on this tty. */
d009ae66	68
b3e6f69c KL	69	/* The previous frame we displayed on this tty. */
b3e6f69c KL	70	struct frame *previous_frame;
9b2cd403	71	int previous_color_mode;
9628b887	72
7ea692f6 EZ	73	/* Information about the range of text currently shown in
	74	mouse-face. */
	75	Mouse_HLInfo mouse_highlight;
ce4bd1b0	76
d93264c6 CY	77	/* Buffer used internally by termcap (see tgetent in the Termcap
	78	manual). Only init_tty and delete_tty should change this. */
	79	char *termcap_term_buffer;
	80
	81	/* Buffer storing terminal description strings (see tgetstr in the
	82	Termcap manual). Only init_tty and delete_tty should change
	83	this. */
	84	char *termcap_strings_buffer;
	85
fca177d4 KL	86	/* Strings, numbers and flags taken from the termcap entry. */
	87
	88	char TS_ins_line; / "al" */
	89	char TS_ins_multi_lines; / "AL" (one parameter, # lines to insert) */
	90	char TS_bell; / "bl" */
	91	char TS_clr_to_bottom; / "cd" */
	92	char TS_clr_line; / "ce", clear to end of line */
	93	char TS_clr_frame; / "cl" */
	94	char TS_set_scroll_region; / "cs" (2 params, first line and last line) */
	95	char TS_set_scroll_region_1; / "cS" (4 params: total lines,
	96	lines above scroll region, lines below it,
	97	total lines again) */
	98	char TS_del_char; / "dc" */
	99	char TS_del_multi_chars; / "DC" (one parameter, # chars to delete) */
	100	char TS_del_line; / "dl" */
	101	char TS_del_multi_lines; / "DL" (one parameter, # lines to delete) */
	102	char TS_delete_mode; / "dm", enter character-delete mode */
	103	char TS_end_delete_mode; / "ed", leave character-delete mode */
	104	char TS_end_insert_mode; / "ei", leave character-insert mode */
	105	char TS_ins_char; / "ic" */
	106	char TS_ins_multi_chars; / "IC" (one parameter, # chars to insert) */
	107	char TS_insert_mode; / "im", enter character-insert mode */
	108	char TS_pad_inserted_char; / "ip". Just padding, no commands. */
	109	char TS_end_keypad_mode; / "ke" */
	110	char TS_keypad_mode; / "ks" */
	111	char TS_pad_char; / "pc", char to use as padding */
	112	char TS_repeat; / "rp" (2 params, # times to repeat
	113	and character to be repeated) */
	114	char TS_end_standout_mode; / "se" */
	115	char TS_fwd_scroll; / "sf" */
	116	char TS_standout_mode; / "so" */
	117	char TS_rev_scroll; / "sr" */
	118	char TS_end_termcap_modes; / "te" */
	119	char TS_termcap_modes; / "ti" */
	120	char TS_visible_bell; / "vb" */
	121	char TS_cursor_normal; / "ve" */
	122	char TS_cursor_visible; / "vs" */
	123	char TS_cursor_invisible; / "vi" */
	124	char TS_set_window; / "wi" (4 params, start and end of window,
	125	each as vpos and hpos) */
	126
	127	char TS_enter_bold_mode; / "md" -- turn on bold (extra bright mode). */
	128	char TS_enter_dim_mode; / "mh" -- turn on half-bright mode. */
	129	char TS_enter_blink_mode; / "mb" -- enter blinking mode. */
	130	char TS_enter_reverse_mode; / "mr" -- enter reverse video mode. */
	131	char TS_exit_underline_mode; / "us" -- start underlining. */
	132	char TS_enter_underline_mode; / "ue" -- end underlining. */
	133
	134	/* "as"/"ae" -- start/end alternate character set. Not really
	135	supported, yet. */
	136	char *TS_enter_alt_charset_mode;
	137	char *TS_exit_alt_charset_mode;
	138
	139	char TS_exit_attribute_mode; / "me" -- switch appearances off. */
	140
	141	/* Value of the "NC" (no_color_video) capability, or 0 if not present. */
	142	int TN_no_color_video;
	143
	144	int TN_max_colors; /* "Co" -- number of colors. */
	145
	146	/* "pa" -- max. number of color pairs on screen. Not handled yet.
	147	Could be a problem if not equal to TN_max_colors * TN_max_colors. */
	148	int TN_max_pairs;
	149
150	/* "op" -- SVr4 set default pair to its original value. */
151	char *TS_orig_pair;
152
153	/* "AF"/"AB" or "Sf"/"Sb"-- set ANSI or SVr4 foreground/background color.
154	1 param, the color index. */
155	char *TS_set_foreground;
156	char *TS_set_background;
157
158	int TF_hazeltine; /* termcap hz flag. */
159	int TF_insmode_motion; /* termcap mi flag: can move while in insert mode. */
160	int TF_standout_motion; /* termcap mi flag: can move while in standout mode. */
161	int TF_underscore; /* termcap ul flag: _ underlines if over-struck on
162	non-blank position. Must clear before writing _. */
163	int TF_teleray; /* termcap xt flag: many weird consequences.
164	For t1061. */
165
166	int RPov; /* # chars to start a TS_repeat */
167
168	int delete_in_insert_mode; /* delete mode == insert mode */
d009ae66	169
fca177d4 KL	170	int se_is_so; /* 1 if same string both enters and leaves
fca177d4 KL	171	standout mode */
d009ae66	172
fca177d4	173	int costs_set; /* Nonzero if costs have been calculated. */
d009ae66	174
fca177d4 KL	175	int insert_mode; /* Nonzero when in insert mode. */
	176	int standout_mode; /* Nonzero when in standout mode. */
	177
	178
	179
	180	/* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
	181	keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
	182
	183	int meta_key;
	184
	185	/* Size of window specified by higher levels.
	186	This is the number of lines, from the top of frame downwards,
	187	which can participate in insert-line/delete-line operations.
	188
	189	Effectively it excludes the bottom frame_lines - specified_window_size
	190	lines from those operations. */
	191
	192	int specified_window;
d009ae66	193
fca177d4 KL	194	/* Flag used in tty_show/hide_cursor. */
	195
	196	int cursor_hidden;
daf01701 KL	197
	198	/* Nonzero means use ^S/^Q for flow control. */
	199	int flow_control;
	200
8a56675d KL	201	};
8a56675d KL	202
28d7d09f KL	203	/* A chain of structures for all tty devices currently in use. */
28d7d09f KL	204	extern struct tty_display_info *tty_list;
28d440ab KL	205
28d440ab KL	206
28d7d09f	207	#define FRAME_TTY(f) \
ce4bd1b0 EZ	208	(((f)->output_method == output_termcap \
ce4bd1b0 EZ	209	\|\| (f)->output_method == output_msdos_raw) \
6ed8eeff	210	? (f)->terminal->display_info.tty \
28d7d09f	211	: (abort(), (struct tty_display_info *) 0))
8a56675d	212
28d7d09f	213	#define CURTTY() FRAME_TTY (SELECTED_FRAME())
8a56675d	214
ab5796a9 MB	215	/* arch-tag: bf9f0d49-842b-42fb-9348-ec8759b27193
ab5796a9 MB	216	(do not change this comment) */