src/systty.h

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