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

/* Flags and parameters describing terminal's characteristics.
   Copyright (C) 1985, 1986, 2003 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 2, 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; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */

/* 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. */
  FILE *output;                 /* The stream to be used for terminal output. */
  
  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. */
  
  /* Info on cursor positioning.  */
  struct cm *Wcm;

  /* Redisplay. */

  /* XXX GC does not know about this; is this a problem? */
  Lisp_Object top_frame;        /* The topmost frame on this tty. */
  
  /* The previous terminal frame we displayed on this tty.  */
  struct frame *previous_terminal_frame;

  /* 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;

  /* This is a copy of struct frame's display_method value; needed for
     freeing up memory when deleting the tty. */
  struct display_method *display_method;

#ifdef MULTI_KBOARD
  /* The terminal's keyboard object. */
  struct kboard *kboard;
#endif  
};

/* 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_data.tty->display_info         \
   : (abort(), (struct tty_display_info *) 0))

#define CURTTY() FRAME_TTY (SELECTED_FRAME())

#define TTY_INPUT(t) ((t)->input)
#define TTY_OUTPUT(t) ((t)->output)
#define TTY_TERMSCRIPT(t) ((t)->termscript)

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