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 #ifndef NO_PTY_H
 131 #include <sys/pty.h>
 132 #endif
 133 #endif
 134
 135 \f
 136 /* Special cases - inhibiting the use of certain features.  */
 137
 138 #ifdef BROKEN_TIOCGETC
 139 #undef TIOCGETC  /* Avoid confusing some conditionals that test this.  */
 140 #endif
 141
 142 /* Allow m- file to inhibit use of FIONREAD.  */
 143 #ifdef BROKEN_FIONREAD
 144 #undef FIONREAD
 145 #undef ASYNC
 146 #endif
 147
 148 /* Interrupt input is not used if there is no FIONREAD.  */
 149 #ifndef FIONREAD
 150 #undef SIGIO
 151 #endif
 152
 153 /* On TERMIOS systems, the tcmumbleattr calls take care of these
 154    parameters, and it's a bad idea to use them (on AIX, it makes the
 155    tty hang for a long time).  */
 156 #if defined (TIOCGLTC) && !defined (HAVE_TERMIOS)
 157 #define HAVE_LTCHARS
 158 #endif
 159
 160 #if defined (TIOCGETC) && !defined (HAVE_TERMIOS)
 161 #define HAVE_TCHARS
 162 #endif
 163
 164 \f
 165 /* Try to establish the correct character to disable terminal functions
 166    in a system-independent manner.  Note that USG (at least) define
 167    _POSIX_VDISABLE as 0!  */
 168
 169 #ifdef _POSIX_VDISABLE
 170 #define CDISABLE _POSIX_VDISABLE
 171 #else /* not _POSIX_VDISABLE */
 172 #ifdef CDEL
 173 #undef CDISABLE
 174 #define CDISABLE CDEL
 175 #else /* not CDEL */
 176 #define CDISABLE 255
 177 #endif /* not CDEL */
 178 #endif /* not _POSIX_VDISABLE */
 179 \f
 180 /* Get the number of characters queued for output.  */
 181
 182 /* EMACS_OUTQSIZE(FD, int *SIZE) stores the number of characters
 183    queued for output to the terminal FD in *SIZE, if FD is a tty.
 184    Returns -1 if there was an error (i.e. FD is not a tty), 0
 185    otherwise.  */
 186 #ifdef TIOCOUTQ
 187 #define EMACS_OUTQSIZE(fd, size) (ioctl ((fd), TIOCOUTQ, (size)))
 188 #endif
 189
 190 #ifdef HAVE_TERMIO
 191 #ifdef TCOUTQ
 192 #undef EMACS_OUTQSIZE
 193 #define EMACS_OUTQSIZE(fd, size) (ioctl ((fd), TCOUTQ, (size)))
 194 #endif
 195 #endif
 196
 197 \f
 198 /* Manipulate a terminal's current process group.  */
 199
 200 /* EMACS_HAVE_TTY_PGRP is true if we can get and set the tty's current
 201    controlling process group.
 202
 203    EMACS_GET_TTY_PGRP(int FD, int *PGID) sets *PGID the terminal FD's
 204    current process group.  Return -1 if there is an error.
 205
 206    EMACS_SET_TTY_PGRP(int FD, int *PGID) sets the terminal FD's
 207    current process group to *PGID.  Return -1 if there is an error.  */
 208
 209 #ifdef HPUX
 210 /* HPUX tty process group stuff doesn't work, says the anonymous voice
 211    from the past.  */
 212 #else
 213 #ifdef TIOCGPGRP
 214 #define EMACS_HAVE_TTY_PGRP
 215 #else
 216 #ifdef HAVE_TERMIOS
 217 #define EMACS_HAVE_TTY_PGRP
 218 #endif
 219 #endif
 220 #endif
 221
 222 #ifdef EMACS_HAVE_TTY_PGRP
 223
 224 #if defined (HAVE_TERMIOS) && ! defined (BSD_TERMIOS)
 225
 226 #define EMACS_GET_TTY_PGRP(fd, pgid) (*(pgid) = tcgetpgrp ((fd)))
 227 #define EMACS_SET_TTY_PGRP(fd, pgid) (tcsetpgrp ((fd), *(pgid)))
 228
 229 #else
 230 #ifdef TIOCSPGRP
 231
 232 #define EMACS_GET_TTY_PGRP(fd, pgid) (ioctl ((fd), TIOCGPGRP, (pgid)))
 233 #define EMACS_SET_TTY_PGRP(fd, pgid) (ioctl ((fd), TIOCSPGRP, (pgid)))
 234
 235 #endif
 236 #endif
 237
 238 #else
 239
 240 /* Just ignore this for now and hope for the best */
 241 #define EMACS_GET_TTY_PGRP(fd, pgid) 0
 242 #define EMACS_SET_TTY_PGRP(fd, pgif) 0
 243
 244 #endif
 245
 246 /* EMACS_GETPGRP (arg) returns the process group of the process.  */
 247
 248 #if defined (GETPGRP_VOID)
 249 #  define EMACS_GETPGRP(x) getpgrp()
 250 #else
 251 #  define EMACS_GETPGRP(x) getpgrp(x)
 252 #endif /* !GETPGRP_VOID */
 253 \f
 254 /* Manipulate a TTY's input/output processing parameters.  */
 255
 256 /* struct emacs_tty is a structure used to hold the current tty
 257    parameters.  If the terminal has several structures describing its
 258    state, for example a struct tchars, a struct sgttyb, a struct
 259    tchars, a struct ltchars, and a struct pagechars, struct
 260    emacs_tty should contain an element for each parameter struct
 261    that Emacs may change.
 262
 263    EMACS_GET_TTY (int FD, struct emacs_tty *P) stores the parameters
 264    of the tty on FD in *P.  Return zero if all's well, or -1 if we ran
 265    into an error we couldn't deal with.
 266
 267    EMACS_SET_TTY (int FD, struct emacs_tty *P, int flushp)
 268    sets the parameters of the tty on FD according to the contents of
 269    *P.  If flushp is non-zero, we discard queued input to be
 270    written before making the change.
 271    Return 0 if all went well, and -1 if anything failed.
 272
 273    EMACS_TTY_TABS_OK (struct emacs_tty *P) is false if the kernel
 274    expands tabs to spaces upon output; in that case, there is no
 275    advantage to using tabs over spaces.  */
 276
 277
 278 /* For each tty parameter structure that Emacs might want to save and restore,
 279    - include an element for it in this structure, and
 280    - extend the emacs_{get,set}_tty functions in sysdep.c to deal with the
 281      new members.  */
 282
 283 struct emacs_tty {
 284
 285 /* There is always one of the following elements, so there is no need
 286    for dummy get and set definitions.  */
 287 #ifdef HAVE_TCATTR
 288   struct termios main;
 289 #else
 290 #ifdef HAVE_TERMIO
 291   struct termio main;
 292 #else
 293 #ifdef VMS
 294   struct sensemode main;
 295 #else
 296 #ifdef DOS_NT
 297   int main;
 298 #else  /* not DOS_NT */
 299   struct sgttyb main;
 300 #endif /* not DOS_NT */
 301 #endif
 302 #endif
 303 #endif
 304
 305 /* If we have TERMIOS, we don't need to do this - they're taken care of
 306    by the tc*attr calls.  */
 307 #ifndef HAVE_TERMIOS
 308 #ifdef HAVE_LTCHARS
 309   struct ltchars ltchars;
 310 #endif
 311
 312 #ifdef HAVE_TCHARS
 313   struct tchars tchars;
 314   int lmode;
 315 #endif
 316 #endif
 317 };
 318 \f
 319 /* Define EMACS_GET_TTY and EMACS_SET_TTY,
 320    the macros for reading and setting parts of `struct emacs_tty'.
 321
 322    These got pretty unmanageable (huge macros are hard to debug), and
 323    finally needed some code which couldn't be done as part of an
 324    expression, so we moved them out to their own functions in sysdep.c.  */
 325 #define EMACS_GET_TTY(fd, p)        (emacs_get_tty ((fd), (p)))
 326 #define EMACS_SET_TTY(fd, p, waitp) (emacs_set_tty ((fd), (p), (waitp)))
 327 #ifdef P_  /* Unfortunately this file is sometimes included before lisp.h */
 328 extern int emacs_get_tty P_ ((int, struct emacs_tty *));
 329 extern int emacs_set_tty P_ ((int, struct emacs_tty *, int));
 330 #endif
 331
 332 \f
 333 /* Define EMACS_TTY_TABS_OK.  */
 334
 335 #ifdef HAVE_TERMIOS
 336
 337 #ifdef TABDLY
 338 #define EMACS_TTY_TABS_OK(p) (((p)->main.c_oflag & TABDLY) != TAB3)
 339 #else
 340 #define EMACS_TTY_TABS_OK(p) 1
 341 #endif
 342
 343 #else /* not def HAVE_TERMIOS */
 344 #ifdef HAVE_TERMIO
 345
 346 #define EMACS_TTY_TABS_OK(p) (((p)->main.c_oflag & TABDLY) != TAB3)
 347
 348 #else /* neither HAVE_TERMIO nor HAVE_TERMIOS */
 349 #ifdef VMS
 350
 351 #define EMACS_TTY_TABS_OK(p) (((p)->main.tt_char & TT$M_MECHTAB) != 0)
 352
 353 #else
 354
 355 #ifdef DOS_NT
 356 #define EMACS_TTY_TABS_OK(p) 0
 357 #else /* not DOS_NT */
 358 #define EMACS_TTY_TABS_OK(p) (((p)->main.sg_flags & XTABS) != XTABS)
 359 #endif /* not DOS_NT */
 360
 361 #endif /* not def VMS */
 362 #endif /* not def HAVE_TERMIO */
 363 #endif /* not def HAVE_TERMIOS */
 364
 365 /* arch-tag: cf4b90bc-be41-401c-be98-40619178a712
 366    (do not change this comment) */