code.delx.au - gnu-emacs/blob - src/systty.h

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