src/systty.h

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