src/termchar.h

   1 /* Flags and parameters describing terminal's characteristics.
   2    Copyright (C) 1985, 1986, 2001, 2002, 2003, 2004,
   3                  2005, 2006, 2007, 2008, 2009, 2010  Free Software Foundation, Inc.
   4
   5 This file is part of GNU Emacs.
   6
   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 of the License, or
  10 (at your option) any later version.
  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
  18 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  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. */
  23
  24 struct tty_output
  25 {
  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
  34 struct tty_display_info
  35 {
  36   struct tty_display_info *next; /* Chain of all tty devices. */
  37
  38   char *name;                   /* The name of the device file or 0 if
  39                                    stdin/stdout. */
  40   char *type;                   /* The type of the tty. */
  41
  42   /* Input/output */
  43
  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. */
  48
  49   FILE *termscript;             /* If nonzero, send all terminal output
  50                                    characters to this stream also.  */
  51
  52   struct emacs_tty *old_tty;    /* The initial tty mode bits */
  53
  54   int term_initted;             /* 1 if we have been through init_sys_modes. */
  55
  56
  57   int reference_count;          /* Number of frames that are on this display. */
  58
  59   struct terminal *terminal;    /* Points back to the generic terminal
  60                                    structure.  This is sometimes handy. */
  61
  62   /* Info on cursor positioning.  */
  63   struct cm *Wcm;
  64
  65   /* Redisplay. */
  66
  67   Lisp_Object top_frame;        /* The topmost frame on this tty. */
  68
  69   /* The previous frame we displayed on this tty.  */
  70   struct frame *previous_frame;
  71   int previous_color_mode;
  72
  73   /* Information about the range of text currently shown in
  74      mouse-face.  */
  75   Mouse_HLInfo mouse_highlight;
  76
  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
  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 */
 169
 170   int se_is_so;                 /* 1 if same string both enters and leaves
 171                                    standout mode */
 172
 173   int costs_set;                /* Nonzero if costs have been calculated. */
 174
 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;
 193
 194   /* Flag used in tty_show/hide_cursor.  */
 195
 196   int cursor_hidden;
 197
 198   /* Nonzero means use ^S/^Q for flow control.  */
 199   int flow_control;
 200
 201 };
 202
 203 /* A chain of structures for all tty devices currently in use. */
 204 extern struct tty_display_info *tty_list;
 205
 206
 207 #define FRAME_TTY(f)                            \
 208   (((f)->output_method == output_termcap        \
 209     || (f)->output_method == output_msdos_raw)  \
 210    ? (f)->terminal->display_info.tty            \
 211    : (abort(), (struct tty_display_info *) 0))
 212
 213 #define CURTTY() FRAME_TTY (SELECTED_FRAME())
 214
 215 /* arch-tag: bf9f0d49-842b-42fb-9348-ec8759b27193
 216    (do not change this comment) */