src/systty.h

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