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