src/termchar.h

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