src/termchar.h

   1 /* Flags and parameters describing terminal's characteristics.
   2    Copyright (C) 1985, 1986, 2003 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 2, or (at your option)
   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
  18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  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 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 struct tty_display_info
  34 {
  35   struct tty_display_info *next; /* Chain of all tty devices. */
  36
  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
  49   struct emacs_tty *old_tty;    /* The initial tty mode bits */
  50
  51   int term_initted;             /* 1 if we have been through init_sys_modes. */
  52
  53
  54   int reference_count;          /* Number of frames that are on this display. */
  55
  56   /* Info on cursor positioning.  */
  57   struct cm *Wcm;
  58
  59   /* Redisplay. */
  60
  61   /* XXX GC does not know about this; is this a problem? */
  62   Lisp_Object top_frame;        /* The topmost frame on this tty. */
  63
  64   /* The previous terminal frame we displayed on this tty.  */
  65   struct frame *previous_terminal_frame;
  66
  67   /* Terminal characteristics. */
  68
  69   int must_write_spaces;        /* Nonzero means spaces in the text must
  70                                    actually be output; can't just skip over
  71                                    some columns to leave them blank.  */
  72   int fast_clear_end_of_line;   /* Nonzero means terminal has a `ce' string */
  73
  74   int line_ins_del_ok;          /* Terminal can insert and delete lines */
  75   int char_ins_del_ok;          /* Terminal can insert and delete chars */
  76   int scroll_region_ok;         /* Terminal supports setting the scroll
  77                                    window */
  78   int scroll_region_cost;       /* Cost of setting the scroll window,
  79                                    measured in characters. */
  80   int memory_below_frame;       /* Terminal remembers lines scrolled
  81                                    off bottom */
  82
  83 #if 0  /* These are not used anywhere. */
  84   /* EMACS_INT baud_rate; */    /* Output speed in baud */
  85   int min_padding_speed;        /* Speed below which no padding necessary. */
  86   int dont_calculate_costs;     /* Nonzero means don't bother computing
  87                                    various cost tables; we won't use them. */
  88 #endif
  89
  90   /* Strings, numbers and flags taken from the termcap entry.  */
  91
  92   char *TS_ins_line;            /* "al" */
  93   char *TS_ins_multi_lines;     /* "AL" (one parameter, # lines to insert) */
  94   char *TS_bell;                /* "bl" */
  95   char *TS_clr_to_bottom;       /* "cd" */
  96   char *TS_clr_line;            /* "ce", clear to end of line */
  97   char *TS_clr_frame;           /* "cl" */
  98   char *TS_set_scroll_region;   /* "cs" (2 params, first line and last line) */
  99   char *TS_set_scroll_region_1; /* "cS" (4 params: total lines,
 100                                    lines above scroll region, lines below it,
 101                                    total lines again) */
 102   char *TS_del_char;            /* "dc" */
 103   char *TS_del_multi_chars;     /* "DC" (one parameter, # chars to delete) */
 104   char *TS_del_line;            /* "dl" */
 105   char *TS_del_multi_lines;     /* "DL" (one parameter, # lines to delete) */
 106   char *TS_delete_mode;         /* "dm", enter character-delete mode */
 107   char *TS_end_delete_mode;     /* "ed", leave character-delete mode */
 108   char *TS_end_insert_mode;     /* "ei", leave character-insert mode */
 109   char *TS_ins_char;            /* "ic" */
 110   char *TS_ins_multi_chars;     /* "IC" (one parameter, # chars to insert) */
 111   char *TS_insert_mode;         /* "im", enter character-insert mode */
 112   char *TS_pad_inserted_char;   /* "ip".  Just padding, no commands.  */
 113   char *TS_end_keypad_mode;     /* "ke" */
 114   char *TS_keypad_mode;         /* "ks" */
 115   char *TS_pad_char;            /* "pc", char to use as padding */
 116   char *TS_repeat;              /* "rp" (2 params, # times to repeat
 117                                    and character to be repeated) */
 118   char *TS_end_standout_mode;   /* "se" */
 119   char *TS_fwd_scroll;          /* "sf" */
 120   char *TS_standout_mode;       /* "so" */
 121   char *TS_rev_scroll;          /* "sr" */
 122   char *TS_end_termcap_modes;   /* "te" */
 123   char *TS_termcap_modes;       /* "ti" */
 124   char *TS_visible_bell;        /* "vb" */
 125   char *TS_cursor_normal;       /* "ve" */
 126   char *TS_cursor_visible;      /* "vs" */
 127   char *TS_cursor_invisible;    /* "vi" */
 128   char *TS_set_window;          /* "wi" (4 params, start and end of window,
 129                                    each as vpos and hpos) */
 130
 131   char *TS_enter_bold_mode;     /* "md" -- turn on bold (extra bright mode).  */
 132   char *TS_enter_dim_mode;      /* "mh" -- turn on half-bright mode.  */
 133   char *TS_enter_blink_mode;    /* "mb" -- enter blinking mode.  */
 134   char *TS_enter_reverse_mode;  /* "mr" -- enter reverse video mode.  */
 135   char *TS_exit_underline_mode; /* "us" -- start underlining.  */
 136   char *TS_enter_underline_mode; /* "ue" -- end underlining.  */
 137
 138   /* "as"/"ae" -- start/end alternate character set.  Not really
 139      supported, yet.  */
 140   char *TS_enter_alt_charset_mode;
 141   char *TS_exit_alt_charset_mode;
 142
 143   char *TS_exit_attribute_mode; /* "me" -- switch appearances off.  */
 144
 145   /* Value of the "NC" (no_color_video) capability, or 0 if not present.  */
 146   int TN_no_color_video;
 147
 148   int TN_max_colors;            /* "Co" -- number of colors.  */
 149
 150   /* "pa" -- max. number of color pairs on screen.  Not handled yet.
 151      Could be a problem if not equal to TN_max_colors * TN_max_colors.  */
 152   int TN_max_pairs;
 153
 154   /* "op" -- SVr4 set default pair to its original value.  */
 155   char *TS_orig_pair;
 156
 157   /* "AF"/"AB" or "Sf"/"Sb"-- set ANSI or SVr4 foreground/background color.
 158      1 param, the color index.  */
 159   char *TS_set_foreground;
 160   char *TS_set_background;
 161
 162   int TF_hazeltine;             /* termcap hz flag. */
 163   int TF_insmode_motion;        /* termcap mi flag: can move while in insert mode. */
 164   int TF_standout_motion;       /* termcap mi flag: can move while in standout mode. */
 165   int TF_underscore;            /* termcap ul flag: _ underlines if over-struck on
 166                                    non-blank position.  Must clear before writing _.  */
 167   int TF_teleray;               /* termcap xt flag: many weird consequences.
 168                                    For t1061. */
 169
 170   int RPov;                     /* # chars to start a TS_repeat */
 171
 172   int delete_in_insert_mode;    /* delete mode == insert mode */
 173
 174   int se_is_so;                 /* 1 if same string both enters and leaves
 175                                    standout mode */
 176
 177   int costs_set;                /* Nonzero if costs have been calculated. */
 178
 179   int insert_mode;              /* Nonzero when in insert mode.  */
 180   int standout_mode;            /* Nonzero when in standout mode.  */
 181
 182
 183
 184   /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
 185      keep 0200 bit in input chars.  0 to ignore the 0200 bit.  */
 186
 187   int meta_key;
 188
 189   /* Size of window specified by higher levels.
 190    This is the number of lines, from the top of frame downwards,
 191    which can participate in insert-line/delete-line operations.
 192
 193    Effectively it excludes the bottom frame_lines - specified_window_size
 194    lines from those operations.  */
 195
 196   int specified_window;
 197
 198   /* Flag used in tty_show/hide_cursor.  */
 199
 200   int cursor_hidden;
 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_data.tty->display_info         \
 210    : (abort(), (struct tty_display_info *) 0))
 211
 212 #define CURTTY() FRAME_TTY (SELECTED_FRAME())
 213
 214 #define TTY_INPUT(t) ((t)->input)
 215 #define TTY_OUTPUT(t) ((t)->output)
 216 #define TTY_TERMSCRIPT(t) ((t)->termscript)
 217
 218 #define TTY_MUST_WRITE_SPACES(t) ((t)->must_write_spaces)
 219 #define TTY_FAST_CLEAR_END_OF_LINE(t) ((t)->fast_clear_end_of_line)
 220 #define TTY_LINE_INS_DEL_OK(t) ((t)->line_ins_del_ok)
 221 #define TTY_CHAR_INS_DEL_OK(t) ((t)->char_ins_del_ok)
 222 #define TTY_SCROLL_REGION_OK(t) ((t)->scroll_region_ok)
 223 #define TTY_SCROLL_REGION_COST(t) ((t)->scroll_region_cost)
 224 #define TTY_MEMORY_BELOW_FRAME(t) ((t)->memory_below_frame)
 225
 226 /* arch-tag: bf9f0d49-842b-42fb-9348-ec8759b27193
 227    (do not change this comment) */