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, Inc., 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21 #ifdef HAVE_TERMIOS
  22 #define HAVE_TCATTR
  23 #endif
  24
  25 /* If we defined these before and we are about to redefine them,
  26    prevent alarming warnings.  */
  27 #ifdef BSD_TERMIOS
  28 #undef NL0
  29 #undef NL1
  30 #undef CR0
  31 #undef CR1
  32 #undef CR2
  33 #undef CR3
  34 #undef TAB0
  35 #undef TAB1
  36 #undef TAB2
  37 #undef XTABS
  38 #undef BS0
  39 #undef BS1
  40 #undef FF0
  41 #undef FF1
  42 #undef ECHO
  43 #undef NOFLSH
  44 #undef TOSTOP
  45 #undef FLUSHO
  46 #undef PENDIN
  47 #endif
  48 \f
  49 /* Include the proper files.  */
  50 #ifdef HAVE_TERMIO
  51 #ifdef __DGUX
  52 #include <sys/ioctl.h>
  53 #endif
  54 #ifndef NO_TERMIO
  55 #include <termio.h>
  56 #endif /* not NO_TERMIO */
  57 #ifndef INCLUDED_FCNTL
  58 #define INCLUDED_FCNTL
  59 #include <fcntl.h>
  60 #endif
  61 #else /* not HAVE_TERMIO */
  62 #ifdef HAVE_TERMIOS
  63 #if defined(_AIX) && defined(_I386)
  64 #include <termios.h>            /* termios.h needs to be before termio.h */
  65 #include <termio.h>
  66 #else /* not HAVE_TERMIOS */
  67 #ifndef NO_TERMIO
  68 #include <termio.h>
  69 #endif
  70 #include <termios.h>
  71 #endif /* _AIX && _I386 */
  72 #define INCLUDED_FCNTL
  73 #include <fcntl.h>
  74 #else /* neither HAVE_TERMIO nor HAVE_TERMIOS */
  75 #ifndef VMS
  76 #ifndef DOS_NT
  77 #include <sgtty.h>
  78 #endif /* not DOS_NT */
  79 #else /* VMS */
  80 #include <descrip.h>
  81 static struct iosb
  82 {
  83   short status;
  84   short offset;
  85   short termlen;
  86   short term;
  87 } input_iosb;
  88
  89 extern int waiting_for_ast;
  90 extern int stop_input;
  91 extern int input_ef;
  92 extern int timer_ef;
  93 extern int process_ef;
  94 extern int input_eflist;
  95 extern int timer_eflist;
  96
  97 static $DESCRIPTOR (input_dsc, "TT");
  98 static int terminator_mask[2] = { 0, 0 };
  99
 100 static struct sensemode {
 101   short status;
 102   unsigned char xmit_baud;
 103   unsigned char rcv_baud;
 104   unsigned char crfill;
 105   unsigned char lffill;
 106   unsigned char parity;
 107   unsigned char unused;
 108   char class;
 109   char type;
 110   short scr_wid;
 111   unsigned long tt_char : 24, scr_len : 8;
 112   unsigned long tt2_char;
 113 } sensemode_iosb;
 114 #endif /* VMS */
 115 #endif /* not HAVE_TERMIOS */
 116 #endif /* not HAVE_TERMIO */
 117
 118 #ifdef __GNU_LIBRARY__
 119 #include <termios.h>
 120 #endif
 121
 122 #ifdef AIXHFT
 123 /* Get files for keyboard remapping */
 124 #define HFNKEYS 2
 125 #include <sys/hft.h>
 126 #include <sys/devinfo.h>
 127 #endif
 128
 129 /* Get rid of LLITOUT in 4.1, since it is said to stimulate kernel bugs.  */
 130 #ifdef BSD4_1
 131 #undef LLITOUT
 132 #define LLITOUT 0
 133 #endif /* 4.1 */
 134
 135 #ifdef NEED_BSDTTY
 136 #include <sys/bsdtty.h>
 137 #endif
 138
 139 #if defined (HPUX) && defined (HAVE_PTYS)
 140 #include <sys/ptyio.h>
 141 #endif
 142
 143 #ifdef AIX
 144 #include <sys/pty.h>
 145 #endif /* AIX */
 146
 147 #if (defined (POSIX) || defined (NEED_UNISTD_H)) && defined (HAVE_UNISTD_H)
 148 #include <unistd.h>
 149 #endif
 150
 151 #ifdef SYSV_PTYS
 152 #include <sys/types.h>
 153 #include <sys/tty.h>
 154 #ifdef titan
 155 #include <sys/ttyhw.h>
 156 #include <sys/stream.h>
 157 #endif
 158 #ifndef NO_PTY_H
 159 #include <sys/pty.h>
 160 #endif
 161 #endif
 162
 163 /* saka@pfu.fujitsu.co.JP writes:
 164    FASYNC defined in this file. But, FASYNC don't working.
 165    so no problem, because unrequest_sigio only need. */
 166 #if defined (pfa)
 167 #include <sys/file.h>
 168 #endif
 169
 170 \f
 171 /* Special cases - inhibiting the use of certain features.  */
 172
 173 #ifdef APOLLO
 174 #undef TIOCSTART
 175 #endif
 176
 177 #ifdef XENIX
 178 #undef TIOCGETC  /* Avoid confusing some conditionals that test this.  */
 179 #endif
 180
 181 #ifdef BROKEN_TIOCGETC
 182 #undef TIOCGETC  /* Avoid confusing some conditionals that test this.  */
 183 #endif
 184
 185 /* UNIPLUS systems may have FIONREAD.  */
 186 #ifdef UNIPLUS
 187 #include <sys.ioctl.h>
 188 #endif
 189
 190 /* Allow m- file to inhibit use of FIONREAD.  */
 191 #ifdef BROKEN_FIONREAD
 192 #undef FIONREAD
 193 #undef ASYNC
 194 #endif
 195
 196 /* Interrupt input is not used if there is no FIONREAD.  */
 197 #ifndef FIONREAD
 198 #undef SIGIO
 199 #endif
 200
 201 /* On TERMIOS systems, the tcmumbleattr calls take care of these
 202    parameters, and it's a bad idea to use them (on AIX, it makes the
 203    tty hang for a long time).  */
 204 #if defined (TIOCGLTC) && !defined (HAVE_TERMIOS)
 205 #define HAVE_LTCHARS
 206 #endif
 207
 208 #if defined (TIOCGETC) && !defined (HAVE_TERMIOS)
 209 #define HAVE_TCHARS
 210 #endif
 211
 212 \f
 213 /* Try to establish the correct character to disable terminal functions
 214    in a system-independent manner.  Note that USG (at least) define
 215    _POSIX_VDISABLE as 0!  */
 216
 217 #ifdef _POSIX_VDISABLE
 218 #define CDISABLE _POSIX_VDISABLE
 219 #else /* not _POSIX_VDISABLE */
 220 #ifdef CDEL
 221 #undef CDISABLE
 222 #define CDISABLE CDEL
 223 #else /* not CDEL */
 224 #define CDISABLE 255
 225 #endif /* not CDEL */
 226 #endif /* not _POSIX_VDISABLE */
 227 \f
 228 /* Get the number of characters queued for output.  */
 229
 230 /* EMACS_OUTQSIZE(FD, int *SIZE) stores the number of characters
 231    queued for output to the terminal FD in *SIZE, if FD is a tty.
 232    Returns -1 if there was an error (i.e. FD is not a tty), 0
 233    otherwise.  */
 234 #ifdef TIOCOUTQ
 235 #define EMACS_OUTQSIZE(fd, size) (ioctl ((fd), TIOCOUTQ, (size)))
 236 #endif
 237
 238 #ifdef HAVE_TERMIO
 239 #ifdef TCOUTQ
 240 #undef EMACS_OUTQSIZE
 241 #define EMACS_OUTQSIZE(fd, size) (ioctl ((fd), TCOUTQ, (size)))
 242 #endif
 243 #endif
 244
 245 \f
 246 /* Manipulate a terminal's current process group.  */
 247
 248 /* EMACS_HAVE_TTY_PGRP is true if we can get and set the tty's current
 249    controlling process group.
 250
 251    EMACS_GET_TTY_PGRP(int FD, int *PGID) sets *PGID the terminal FD's
 252    current process group.  Return -1 if there is an error.
 253
 254    EMACS_SET_TTY_PGRP(int FD, int *PGID) sets the terminal FD's
 255    current process group to *PGID.  Return -1 if there is an error.  */
 256
 257 #ifdef HPUX
 258 /* HPUX tty process group stuff doesn't work, says the anonymous voice
 259    from the past.  */
 260 #else
 261 #ifdef TIOCGPGRP
 262 #define EMACS_HAVE_TTY_PGRP
 263 #else
 264 #ifdef HAVE_TERMIOS
 265 #define EMACS_HAVE_TTY_PGRP
 266 #endif
 267 #endif
 268 #endif
 269
 270 #ifdef EMACS_HAVE_TTY_PGRP
 271
 272 #if defined (HAVE_TERMIOS) && ! defined (BSD_TERMIOS)
 273
 274 #define EMACS_GET_TTY_PGRP(fd, pgid) (*(pgid) = tcgetpgrp ((fd)))
 275 #define EMACS_SET_TTY_PGRP(fd, pgid) (tcsetpgrp ((fd), *(pgid)))
 276
 277 #else
 278 #ifdef TIOCSPGRP
 279
 280 #define EMACS_GET_TTY_PGRP(fd, pgid) (ioctl ((fd), TIOCGPGRP, (pgid)))
 281 #define EMACS_SET_TTY_PGRP(fd, pgid) (ioctl ((fd), TIOCSPGRP, (pgid)))
 282
 283 #endif
 284 #endif
 285
 286 #else
 287
 288 /* Just ignore this for now and hope for the best */
 289 #define EMACS_GET_TTY_PGRP(fd, pgid) 0
 290 #define EMACS_SET_TTY_PGRP(fd, pgif) 0
 291
 292 #endif
 293
 294 /* EMACS_GETPGRP (arg) returns the process group of the terminal.  */
 295
 296 #if defined (USG) && !defined (GETPGRP_NEEDS_ARG)
 297 #  if !defined (GETPGRP_NO_ARG)
 298 #    define GETPGRP_NO_ARG
 299 #  endif
 300 #endif
 301
 302 #if defined (GETPGRP_NO_ARG)
 303 #  define EMACS_GETPGRP(x) getpgrp()
 304 #else
 305 #  define EMACS_GETPGRP(x) getpgrp(x)
 306 #endif /* !GETPGRP_NO_ARG */
 307 \f
 308 /* Manipulate a TTY's input/output processing parameters.  */
 309
 310 /* struct emacs_tty is a structure used to hold the current tty
 311    parameters.  If the terminal has several structures describing its
 312    state, for example a struct tchars, a struct sgttyb, a struct
 313    tchars, a struct ltchars, and a struct pagechars, struct
 314    emacs_tty should contain an element for each parameter struct
 315    that Emacs may change.
 316
 317    EMACS_GET_TTY (int FD, struct emacs_tty *P) stores the parameters
 318    of the tty on FD in *P.  Return zero if all's well, or -1 if we ran
 319    into an error we couldn't deal with.
 320
 321    EMACS_SET_TTY (int FD, struct emacs_tty *P, int flushp)
 322    sets the parameters of the tty on FD according to the contents of
 323    *P.  If flushp is non-zero, we discard queued input to be
 324    written before making the change.
 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 */