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  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 #ifdef MSDOS
  74   /* These variables describe the range of text currently shown in its
  75      mouse-face, together with the window they apply to.  As long as
  76      the mouse stays within this range, we need not redraw anything on
  77      its account.  Rows and columns are glyph matrix positions in
  78      MOUSE_FACE_WINDOW.  */
  79   int mouse_face_beg_row, mouse_face_beg_col;
  80   int mouse_face_end_row, mouse_face_end_col;
  81   int mouse_face_past_end;
  82   Lisp_Object mouse_face_window;
  83   int mouse_face_face_id;
  84
  85   /* 1 if a mouse motion event came and we didn't handle it right away because
  86      gc was in progress.  */
  87   int mouse_face_deferred_gc;
  88
  89   /* FRAME and X, Y position of mouse when last checked for
  90      highlighting.  X and Y can be negative or out of range for the frame.  */
  91   struct frame *mouse_face_mouse_frame;
  92   int mouse_face_mouse_x, mouse_face_mouse_y;
  93
  94   /* Nonzero means defer mouse-motion highlighting.  */
  95   int mouse_face_defer;
  96
  97   /* Nonzero means that the mouse highlight should not be shown.  */
  98   int mouse_face_hidden;
  99 #endif  /* !MSDOS */
 100
 101   /* Strings, numbers and flags taken from the termcap entry.  */
 102
 103   char *TS_ins_line;            /* "al" */
 104   char *TS_ins_multi_lines;     /* "AL" (one parameter, # lines to insert) */
 105   char *TS_bell;                /* "bl" */
 106   char *TS_clr_to_bottom;       /* "cd" */
 107   char *TS_clr_line;            /* "ce", clear to end of line */
 108   char *TS_clr_frame;           /* "cl" */
 109   char *TS_set_scroll_region;   /* "cs" (2 params, first line and last line) */
 110   char *TS_set_scroll_region_1; /* "cS" (4 params: total lines,
 111                                    lines above scroll region, lines below it,
 112                                    total lines again) */
 113   char *TS_del_char;            /* "dc" */
 114   char *TS_del_multi_chars;     /* "DC" (one parameter, # chars to delete) */
 115   char *TS_del_line;            /* "dl" */
 116   char *TS_del_multi_lines;     /* "DL" (one parameter, # lines to delete) */
 117   char *TS_delete_mode;         /* "dm", enter character-delete mode */
 118   char *TS_end_delete_mode;     /* "ed", leave character-delete mode */
 119   char *TS_end_insert_mode;     /* "ei", leave character-insert mode */
 120   char *TS_ins_char;            /* "ic" */
 121   char *TS_ins_multi_chars;     /* "IC" (one parameter, # chars to insert) */
 122   char *TS_insert_mode;         /* "im", enter character-insert mode */
 123   char *TS_pad_inserted_char;   /* "ip".  Just padding, no commands.  */
 124   char *TS_end_keypad_mode;     /* "ke" */
 125   char *TS_keypad_mode;         /* "ks" */
 126   char *TS_pad_char;            /* "pc", char to use as padding */
 127   char *TS_repeat;              /* "rp" (2 params, # times to repeat
 128                                    and character to be repeated) */
 129   char *TS_end_standout_mode;   /* "se" */
 130   char *TS_fwd_scroll;          /* "sf" */
 131   char *TS_standout_mode;       /* "so" */
 132   char *TS_rev_scroll;          /* "sr" */
 133   char *TS_end_termcap_modes;   /* "te" */
 134   char *TS_termcap_modes;       /* "ti" */
 135   char *TS_visible_bell;        /* "vb" */
 136   char *TS_cursor_normal;       /* "ve" */
 137   char *TS_cursor_visible;      /* "vs" */
 138   char *TS_cursor_invisible;    /* "vi" */
 139   char *TS_set_window;          /* "wi" (4 params, start and end of window,
 140                                    each as vpos and hpos) */
 141
 142   char *TS_enter_bold_mode;     /* "md" -- turn on bold (extra bright mode).  */
 143   char *TS_enter_dim_mode;      /* "mh" -- turn on half-bright mode.  */
 144   char *TS_enter_blink_mode;    /* "mb" -- enter blinking mode.  */
 145   char *TS_enter_reverse_mode;  /* "mr" -- enter reverse video mode.  */
 146   char *TS_exit_underline_mode; /* "us" -- start underlining.  */
 147   char *TS_enter_underline_mode; /* "ue" -- end underlining.  */
 148
 149   /* "as"/"ae" -- start/end alternate character set.  Not really
 150      supported, yet.  */
 151   char *TS_enter_alt_charset_mode;
 152   char *TS_exit_alt_charset_mode;
 153
 154   char *TS_exit_attribute_mode; /* "me" -- switch appearances off.  */
 155
 156   /* Value of the "NC" (no_color_video) capability, or 0 if not present.  */
 157   int TN_no_color_video;
 158
 159   int TN_max_colors;            /* "Co" -- number of colors.  */
 160
 161   /* "pa" -- max. number of color pairs on screen.  Not handled yet.
 162      Could be a problem if not equal to TN_max_colors * TN_max_colors.  */
 163   int TN_max_pairs;
 164
 165   /* "op" -- SVr4 set default pair to its original value.  */
 166   char *TS_orig_pair;
 167
 168   /* "AF"/"AB" or "Sf"/"Sb"-- set ANSI or SVr4 foreground/background color.
 169      1 param, the color index.  */
 170   char *TS_set_foreground;
 171   char *TS_set_background;
 172
 173   int TF_hazeltine;             /* termcap hz flag. */
 174   int TF_insmode_motion;        /* termcap mi flag: can move while in insert mode. */
 175   int TF_standout_motion;       /* termcap mi flag: can move while in standout mode. */
 176   int TF_underscore;            /* termcap ul flag: _ underlines if over-struck on
 177                                    non-blank position.  Must clear before writing _.  */
 178   int TF_teleray;               /* termcap xt flag: many weird consequences.
 179                                    For t1061. */
 180
 181   int RPov;                     /* # chars to start a TS_repeat */
 182
 183   int delete_in_insert_mode;    /* delete mode == insert mode */
 184
 185   int se_is_so;                 /* 1 if same string both enters and leaves
 186                                    standout mode */
 187
 188   int costs_set;                /* Nonzero if costs have been calculated. */
 189
 190   int insert_mode;              /* Nonzero when in insert mode.  */
 191   int standout_mode;            /* Nonzero when in standout mode.  */
 192
 193
 194
 195   /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
 196      keep 0200 bit in input chars.  0 to ignore the 0200 bit.  */
 197
 198   int meta_key;
 199
 200   /* Size of window specified by higher levels.
 201    This is the number of lines, from the top of frame downwards,
 202    which can participate in insert-line/delete-line operations.
 203
 204    Effectively it excludes the bottom frame_lines - specified_window_size
 205    lines from those operations.  */
 206
 207   int specified_window;
 208
 209   /* Flag used in tty_show/hide_cursor.  */
 210
 211   int cursor_hidden;
 212
 213   /* Nonzero means use ^S/^Q for flow control.  */
 214   int flow_control;
 215
 216 };
 217
 218 /* A chain of structures for all tty devices currently in use. */
 219 extern struct tty_display_info *tty_list;
 220
 221
 222 #define FRAME_TTY(f)                            \
 223   (((f)->output_method == output_termcap        \
 224     || (f)->output_method == output_msdos_raw)  \
 225    ? (f)->terminal->display_info.tty            \
 226    : (abort(), (struct tty_display_info *) 0))
 227
 228 #define CURTTY() FRAME_TTY (SELECTED_FRAME())
 229
 230 /* arch-tag: bf9f0d49-842b-42fb-9348-ec8759b27193
 231    (do not change this comment) */