src/systty.h

   1 /* systty.h - System-dependent definitions for terminals.
   2    Copyright (C) 1993, 1994, 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, or (at your option)
  10 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; see the file COPYING.  If not, write to
  19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20 Boston, MA 02110-1301, USA.  */
  21
  22 #ifdef HAVE_TERMIOS
  23 #define HAVE_TCATTR
  24 #endif
  25
  26 \f
  27 /* Include the proper files.  */
  28 #ifdef HAVE_TERMIO
  29 #ifndef NO_TERMIO
  30 #include <termio.h>
  31 #endif /* not NO_TERMIO */
  32 #ifndef INCLUDED_FCNTL
  33 #define INCLUDED_FCNTL
  34 #include <fcntl.h>
  35 #endif
  36 #else /* not HAVE_TERMIO */
  37 #ifdef HAVE_TERMIOS
  38 #if defined(_AIX) && defined(_I386)
  39 #include <termios.h>            /* termios.h needs to be before termio.h */
  40 #include <termio.h>
  41 #else /* not (_AIX && _I386) */
  42 #ifndef NO_TERMIO
  43 #include <termio.h>
  44 #endif
  45 #include <termios.h>
  46 #endif /* not (_AIX && _I386) */
  47 #define INCLUDED_FCNTL
  48 #include <fcntl.h>
  49 #else /* neither HAVE_TERMIO nor HAVE_TERMIOS */
  50 #ifndef VMS
  51 #ifndef DOS_NT
  52 #include <sgtty.h>
  53 #endif /* not DOS_NT */
  54 #else /* VMS */
  55 #include <descrip.h>
  56 static struct iosb
  57 {
  58   short status;
  59   short offset;
  60   short termlen;
  61   short term;
  62 } input_iosb;
  63
  64 extern int waiting_for_ast;
  65 extern int stop_input;
  66 extern int input_ef;
  67 extern int timer_ef;
  68 extern int process_ef;
  69 extern int input_eflist;
  70 extern int timer_eflist;
  71
  72 static $DESCRIPTOR (input_dsc, "TT");
  73 static int terminator_mask[2] = { 0, 0 };
  74
  75 static struct sensemode {
  76   short status;
  77   unsigned char xmit_baud;
  78   unsigned char rcv_baud;
  79   unsigned char crfill;
  80   unsigned char lffill;
  81   unsigned char parity;
  82   unsigned char unused;
  83   char class;
  84   char type;
  85   short scr_wid;
  86   unsigned long tt_char : 24, scr_len : 8;
  87   unsigned long tt2_char;
  88 } sensemode_iosb;
  89 #endif /* VMS */
  90 #endif /* not HAVE_TERMIOS */
  91 #endif /* not HAVE_TERMIO */
  92
  93 #ifdef __GNU_LIBRARY__
  94 #include <sys/ioctl.h>
  95 #include <termios.h>
  96 #endif
  97
  98 #ifdef AIXHFT
  99 /* Get files for keyboard remapping */
 100 #define HFNKEYS 2
 101 #include <sys/hft.h>
 102 #include <sys/devinfo.h>
 103 #endif
 104
 105 /* Get rid of LLITOUT in 4.1, since it is said to stimulate kernel bugs.  */
 106 #ifdef BSD4_1
 107 #undef LLITOUT
 108 #define LLITOUT 0
 109 #endif /* 4.1 */
 110
 111 #ifdef NEED_BSDTTY
 112 #include <sys/bsdtty.h>
 113 #endif
 114
 115 #if defined (HPUX) && defined (HAVE_PTYS)
 116 #include <sys/ptyio.h>
 117 #endif
 118
 119 #ifdef AIX
 120 #include <sys/pty.h>
 121 #endif /* AIX */
 122
 123 #if (defined (POSIX) || defined (NEED_UNISTD_H)) && defined (HAVE_UNISTD_H)
 124 #include <unistd.h>
 125 #endif
 126
 127 #ifdef SYSV_PTYS
 128 #include <sys/types.h>
 129 #include <sys/tty.h>
 130 #include <sys/pty.h>
 131 #endif
 132
 133 \f
 134 /* Special cases - inhibiting the use of certain features.  */
 135
 136 #ifdef BROKEN_TIOCGETC
 137 #undef TIOCGETC  /* Avoid confusing some conditionals that test this.  */
 138 #endif
 139
 140 /* Allow m- file to inhibit use of FIONREAD.  */
 141 #ifdef BROKEN_FIONREAD
 142 #undef FIONREAD
 143 #undef ASYNC
 144 #endif
 145
 146 /* Interrupt input is not used if there is no FIONREAD.  */
 147 #ifndef FIONREAD
 148 #undef SIGIO
 149 #endif
 150
 151 /* On TERMIOS systems, the tcmumbleattr calls take care of these
 152    parameters, and it's a bad idea to use them (on AIX, it makes the
 153    tty hang for a long time).  */
 154 #if defined (TIOCGLTC) && !defined (HAVE_TERMIOS)
 155 #define HAVE_LTCHARS
 156 #endif
 157
 158 #if defined (TIOCGETC) && !defined (HAVE_TERMIOS)
 159 #define HAVE_TCHARS
 160 #endif
 161
 162 \f
 163 /* Try to establish the correct character to disable terminal functions
 164    in a system-independent manner.  Note that USG (at least) define
 165    _POSIX_VDISABLE as 0!  */
 166
 167 #ifdef _POSIX_VDISABLE
 168 #define CDISABLE _POSIX_VDISABLE
 169 #else /* not _POSIX_VDISABLE */
 170 #ifdef CDEL
 171 #undef CDISABLE
 172 #define CDISABLE CDEL
 173 #else /* not CDEL */
 174 #define CDISABLE 255
 175 #endif /* not CDEL */
 176 #endif /* not _POSIX_VDISABLE */
 177 \f
 178 /* Get the number of characters queued for output.  */
 179
 180 /* EMACS_OUTQSIZE(FD, int *SIZE) stores the number of characters
 181    queued for output to the terminal FD in *SIZE, if FD is a tty.
 182    Returns -1 if there was an error (i.e. FD is not a tty), 0
 183    otherwise.  */
 184 #ifdef TIOCOUTQ
 185 #define EMACS_OUTQSIZE(fd, size) (ioctl ((fd), TIOCOUTQ, (size)))
 186 #endif
 187
 188 #ifdef HAVE_TERMIO
 189 #ifdef TCOUTQ
 190 #undef EMACS_OUTQSIZE
 191 #define EMACS_OUTQSIZE(fd, size) (ioctl ((fd), TCOUTQ, (size)))
 192 #endif
 193 #endif
 194
 195 \f
 196 /* Manipulate a terminal's current process group.  */
 197
 198 /* EMACS_HAVE_TTY_PGRP is true if we can get and set the tty's current
 199    controlling process group.
 200
 201    EMACS_GET_TTY_PGRP(int FD, int *PGID) sets *PGID the terminal FD's
 202    current process group.  Return -1 if there is an error.
 203
 204    EMACS_SET_TTY_PGRP(int FD, int *PGID) sets the terminal FD's
 205    current process group to *PGID.  Return -1 if there is an error.  */
 206
 207 #ifdef HPUX
 208 /* HPUX tty process group stuff doesn't work, says the anonymous voice
 209    from the past.  */
 210 #else
 211 #ifdef TIOCGPGRP
 212 #define EMACS_HAVE_TTY_PGRP
 213 #else
 214 #ifdef HAVE_TERMIOS
 215 #define EMACS_HAVE_TTY_PGRP
 216 #endif
 217 #endif
 218 #endif
 219
 220 #ifdef EMACS_HAVE_TTY_PGRP
 221
 222 #if defined (HAVE_TERMIOS) && ! defined (BSD_TERMIOS)
 223
 224 #define EMACS_GET_TTY_PGRP(fd, pgid) (*(pgid) = tcgetpgrp ((fd)))
 225 #define EMACS_SET_TTY_PGRP(fd, pgid) (tcsetpgrp ((fd), *(pgid)))
 226
 227 #else
 228 #ifdef TIOCSPGRP
 229
 230 #define EMACS_GET_TTY_PGRP(fd, pgid) (ioctl ((fd), TIOCGPGRP, (pgid)))
 231 #define EMACS_SET_TTY_PGRP(fd, pgid) (ioctl ((fd), TIOCSPGRP, (pgid)))
 232
 233 #endif
 234 #endif
 235
 236 #else
 237
 238 /* Just ignore this for now and hope for the best */
 239 #define EMACS_GET_TTY_PGRP(fd, pgid) 0
 240 #define EMACS_SET_TTY_PGRP(fd, pgif) 0
 241
 242 #endif
 243
 244 /* EMACS_GETPGRP (arg) returns the process group of the process.  */
 245
 246 #if defined (GETPGRP_VOID)
 247 #  define EMACS_GETPGRP(x) getpgrp()
 248 #else
 249 #  define EMACS_GETPGRP(x) getpgrp(x)
 250 #endif /* !GETPGRP_VOID */
 251 \f
 252 /* Manipulate a TTY's input/output processing parameters.  */
 253
 254 /* struct emacs_tty is a structure used to hold the current tty
 255    parameters.  If the terminal has several structures describing its
 256    state, for example a struct tchars, a struct sgttyb, a struct
 257    tchars, a struct ltchars, and a struct pagechars, struct
 258    emacs_tty should contain an element for each parameter struct
 259    that Emacs may change.
 260
 261    EMACS_GET_TTY (int FD, struct emacs_tty *P) stores the parameters
 262    of the tty on FD in *P.  Return zero if all's well, or -1 if we ran
 263    into an error we couldn't deal with.
 264
 265    EMACS_SET_TTY (int FD, struct emacs_tty *P, int flushp)
 266    sets the parameters of the tty on FD according to the contents of
 267    *P.  If flushp is non-zero, we discard queued input to be
 268    written before making the change.
 269    Return 0 if all went well, and -1 if anything failed.
 270
 271    EMACS_TTY_TABS_OK (struct emacs_tty *P) is false if the kernel
 272    expands tabs to spaces upon output; in that case, there is no
 273    advantage to using tabs over spaces.  */
 274
 275
 276 /* For each tty parameter structure that Emacs might want to save and restore,
 277    - include an element for it in this structure, and
 278    - extend the emacs_{get,set}_tty functions in sysdep.c to deal with the
 279      new members.  */
 280
 281 struct emacs_tty {
 282
 283 /* There is always one of the following elements, so there is no need
 284    for dummy get and set definitions.  */
 285 #ifdef HAVE_TCATTR
 286   struct termios main;
 287 #else
 288 #ifdef HAVE_TERMIO
 289   struct termio main;
 290 #else
 291 #ifdef VMS
 292   struct sensemode main;
 293 #else
 294 #ifdef DOS_NT
 295   int main;
 296 #else  /* not DOS_NT */
 297   struct sgttyb main;
 298 #endif /* not DOS_NT */
 299 #endif
 300 #endif
 301 #endif
 302
 303 /* If we have TERMIOS, we don't need to do this - they're taken care of
 304    by the tc*attr calls.  */
 305 #ifndef HAVE_TERMIOS
 306 #ifdef HAVE_LTCHARS
 307   struct ltchars ltchars;
 308 #endif
 309
 310 #ifdef HAVE_TCHARS
 311   struct tchars tchars;
 312   int lmode;
 313 #endif
 314 #endif
 315 };
 316 \f
 317 /* Define EMACS_GET_TTY and EMACS_SET_TTY,
 318    the macros for reading and setting parts of `struct emacs_tty'.
 319
 320    These got pretty unmanageable (huge macros are hard to debug), and
 321    finally needed some code which couldn't be done as part of an
 322    expression, so we moved them out to their own functions in sysdep.c.  */
 323 #define EMACS_GET_TTY(fd, p)        (emacs_get_tty ((fd), (p)))
 324 #define EMACS_SET_TTY(fd, p, waitp) (emacs_set_tty ((fd), (p), (waitp)))
 325 #ifdef P_  /* Unfortunately this file is sometimes included before lisp.h */
 326 extern int emacs_get_tty P_ ((int, struct emacs_tty *));
 327 extern int emacs_set_tty P_ ((int, struct emacs_tty *, int));
 328 #endif
 329
 330 \f
 331 /* Define EMACS_TTY_TABS_OK.  */
 332
 333 #ifdef HAVE_TERMIOS
 334
 335 #ifdef TABDLY
 336 #define EMACS_TTY_TABS_OK(p) (((p)->main.c_oflag & TABDLY) != TAB3)
 337 #else
 338 #define EMACS_TTY_TABS_OK(p) 1
 339 #endif
 340
 341 #else /* not def HAVE_TERMIOS */
 342 #ifdef HAVE_TERMIO
 343
 344 #define EMACS_TTY_TABS_OK(p) (((p)->main.c_oflag & TABDLY) != TAB3)
 345
 346 #else /* neither HAVE_TERMIO nor HAVE_TERMIOS */
 347 #ifdef VMS
 348
 349 #define EMACS_TTY_TABS_OK(p) (((p)->main.tt_char & TT$M_MECHTAB) != 0)
 350
 351 #else
 352
 353 #ifdef DOS_NT
 354 #define EMACS_TTY_TABS_OK(p) 0
 355 #else /* not DOS_NT */
 356 #define EMACS_TTY_TABS_OK(p) (((p)->main.sg_flags & XTABS) != XTABS)
 357 #endif /* not DOS_NT */
 358
 359 #endif /* not def VMS */
 360 #endif /* not def HAVE_TERMIO */
 361 #endif /* not def HAVE_TERMIOS */
 362
 363 /* arch-tag: cf4b90bc-be41-401c-be98-40619178a712
 364    (do not change this comment) */