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