src/termchar.h

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