src/systty.h

   1 /* systty.h - System-dependent definitions for terminals.
   2    Copyright (C) 1993, 1994, 2001, 2002, 2003, 2004,
   3                  2005, 2006, 2007, 2008  Free Software Foundation, Inc.
   4
   5 This file is part of GNU Emacs.
   6
   7 GNU Emacs is free software: you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation, either version 3 of the License, or
  10 (at your option) any later version.
  11
  12 GNU Emacs is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifdef HAVE_TERMIOS
  21 #define HAVE_TCATTR
  22 #endif
  23
  24 \f
  25 /* Include the proper files.  */
  26 #ifdef HAVE_TERMIO
  27 #ifndef NO_TERMIO
  28 #include <termio.h>
  29 #endif /* not NO_TERMIO */
  30 #ifndef INCLUDED_FCNTL
  31 #define INCLUDED_FCNTL
  32 #include <fcntl.h>
  33 #endif
  34 #else /* not HAVE_TERMIO */
  35 #ifdef HAVE_TERMIOS
  36 #ifndef NO_TERMIO
  37 #include <termio.h>
  38 #endif
  39 #include <termios.h>
  40 #define INCLUDED_FCNTL
  41 #include <fcntl.h>
  42 #else /* neither HAVE_TERMIO nor HAVE_TERMIOS */
  43 #ifndef VMS
  44 #ifndef DOS_NT
  45 #include <sgtty.h>
  46 #endif /* not DOS_NT */
  47 #else /* VMS */
  48 #include <descrip.h>
  49 static struct iosb
  50 {
  51   short status;
  52   short offset;
  53   short termlen;
  54   short term;
  55 } input_iosb;
  56
  57 extern int waiting_for_ast;
  58 extern int stop_input;
  59 extern int input_ef;
  60 extern int timer_ef;
  61 extern int process_ef;
  62 extern int input_eflist;
  63 extern int timer_eflist;
  64
  65 static $DESCRIPTOR (input_dsc, "TT");
  66 static int terminator_mask[2] = { 0, 0 };
  67
  68 static struct sensemode {
  69   short status;
  70   unsigned char xmit_baud;
  71   unsigned char rcv_baud;
  72   unsigned char crfill;
  73   unsigned char lffill;
  74   unsigned char parity;
  75   unsigned char unused;
  76   char class;
  77   char type;
  78   short scr_wid;
  79   unsigned long tt_char : 24, scr_len : 8;
  80   unsigned long tt2_char;
  81 } sensemode_iosb;
  82 #endif /* VMS */
  83 #endif /* not HAVE_TERMIOS */
  84 #endif /* not HAVE_TERMIO */
  85
  86 #ifdef __GNU_LIBRARY__
  87 #include <sys/ioctl.h>
  88 #include <termios.h>
  89 #endif
  90
  91 #ifdef NEED_BSDTTY
  92 #include <sys/bsdtty.h>
  93 #endif
  94
  95 #if defined (HPUX) && defined (HAVE_PTYS)
  96 #include <sys/ptyio.h>
  97 #endif
  98
  99 #ifdef AIX
 100 #include <sys/pty.h>
 101 #endif /* AIX */
 102
 103 #if (defined (POSIX) || defined (NEED_UNISTD_H)) && defined (HAVE_UNISTD_H)
 104 #include <unistd.h>
 105 #endif
 106
 107 \f
 108 /* Special cases - inhibiting the use of certain features.  */
 109
 110 /* Allow m- file to inhibit use of FIONREAD.  */
 111 #ifdef BROKEN_FIONREAD
 112 #undef FIONREAD
 113 #undef ASYNC
 114 #endif
 115
 116 /* Interrupt input is not used if there is no FIONREAD.  */
 117 #ifndef FIONREAD
 118 #undef SIGIO
 119 #endif
 120
 121 /* On TERMIOS systems, the tcmumbleattr calls take care of these
 122    parameters, and it's a bad idea to use them (on AIX, it makes the
 123    tty hang for a long time).  */
 124 #if defined (TIOCGLTC) && !defined (HAVE_TERMIOS)
 125 #define HAVE_LTCHARS
 126 #endif
 127
 128 #if defined (TIOCGETC) && !defined (HAVE_TERMIOS)
 129 #define HAVE_TCHARS
 130 #endif
 131
 132 \f
 133 /* Try to establish the correct character to disable terminal functions
 134    in a system-independent manner.  Note that USG (at least) define
 135    _POSIX_VDISABLE as 0!  */
 136
 137 #ifdef _POSIX_VDISABLE
 138 #define CDISABLE _POSIX_VDISABLE
 139 #else /* not _POSIX_VDISABLE */
 140 #ifdef CDEL
 141 #undef CDISABLE
 142 #define CDISABLE CDEL
 143 #else /* not CDEL */
 144 #define CDISABLE 255
 145 #endif /* not CDEL */
 146 #endif /* not _POSIX_VDISABLE */
 147 \f
 148 /* Get the number of characters queued for output.  */
 149
 150 /* EMACS_OUTQSIZE(FD, int *SIZE) stores the number of characters
 151    queued for output to the terminal FD in *SIZE, if FD is a tty.
 152    Returns -1 if there was an error (i.e. FD is not a tty), 0
 153    otherwise.  */
 154 #ifdef TIOCOUTQ
 155 #define EMACS_OUTQSIZE(fd, size) (ioctl ((fd), TIOCOUTQ, (size)))
 156 #endif
 157
 158 #ifdef HAVE_TERMIO
 159 #ifdef TCOUTQ
 160 #undef EMACS_OUTQSIZE
 161 #define EMACS_OUTQSIZE(fd, size) (ioctl ((fd), TCOUTQ, (size)))
 162 #endif
 163 #endif
 164
 165 \f
 166 /* Manipulate a terminal's current process group.  */
 167
 168 /* EMACS_HAVE_TTY_PGRP is true if we can get and set the tty's current
 169    controlling process group.
 170
 171    EMACS_GET_TTY_PGRP(int FD, int *PGID) sets *PGID the terminal FD's
 172    current process group.  Return -1 if there is an error.
 173
 174    EMACS_SET_TTY_PGRP(int FD, int *PGID) sets the terminal FD's
 175    current process group to *PGID.  Return -1 if there is an error.  */
 176
 177 #ifdef HPUX
 178 /* HPUX tty process group stuff doesn't work, says the anonymous voice
 179    from the past.  */
 180 #else
 181 #ifdef TIOCGPGRP
 182 #define EMACS_HAVE_TTY_PGRP
 183 #else
 184 #ifdef HAVE_TERMIOS
 185 #define EMACS_HAVE_TTY_PGRP
 186 #endif
 187 #endif
 188 #endif
 189
 190 #ifdef EMACS_HAVE_TTY_PGRP
 191
 192 #if defined (HAVE_TERMIOS) && ! defined (BSD_TERMIOS)
 193
 194 #define EMACS_GET_TTY_PGRP(fd, pgid) (*(pgid) = tcgetpgrp ((fd)))
 195 #define EMACS_SET_TTY_PGRP(fd, pgid) (tcsetpgrp ((fd), *(pgid)))
 196
 197 #else
 198 #ifdef TIOCSPGRP
 199
 200 #define EMACS_GET_TTY_PGRP(fd, pgid) (ioctl ((fd), TIOCGPGRP, (pgid)))
 201 #define EMACS_SET_TTY_PGRP(fd, pgid) (ioctl ((fd), TIOCSPGRP, (pgid)))
 202
 203 #endif
 204 #endif
 205
 206 #else
 207
 208 /* Just ignore this for now and hope for the best */
 209 #define EMACS_GET_TTY_PGRP(fd, pgid) 0
 210 #define EMACS_SET_TTY_PGRP(fd, pgif) 0
 211
 212 #endif
 213
 214 /* EMACS_GETPGRP (arg) returns the process group of the process.  */
 215
 216 #if defined (GETPGRP_VOID)
 217 #  define EMACS_GETPGRP(x) getpgrp()
 218 #else
 219 #  define EMACS_GETPGRP(x) getpgrp(x)
 220 #endif /* !GETPGRP_VOID */
 221 \f
 222 /* Manipulate a TTY's input/output processing parameters.  */
 223
 224 /* struct emacs_tty is a structure used to hold the current tty
 225    parameters.  If the terminal has several structures describing its
 226    state, for example a struct tchars, a struct sgttyb, a struct
 227    tchars, a struct ltchars, and a struct pagechars, struct
 228    emacs_tty should contain an element for each parameter struct
 229    that Emacs may change.
 230
 231    EMACS_GET_TTY (int FD, struct emacs_tty *P) stores the parameters
 232    of the tty on FD in *P.  Return zero if all's well, or -1 if we ran
 233    into an error we couldn't deal with.
 234
 235    EMACS_SET_TTY (int FD, struct emacs_tty *P, int flushp)
 236    sets the parameters of the tty on FD according to the contents of
 237    *P.  If flushp is non-zero, we discard queued input to be
 238    written before making the change.
 239    Return 0 if all went well, and -1 if anything failed.
 240
 241    EMACS_TTY_TABS_OK (struct emacs_tty *P) is false if the kernel
 242    expands tabs to spaces upon output; in that case, there is no
 243    advantage to using tabs over spaces.  */
 244
 245
 246 /* For each tty parameter structure that Emacs might want to save and restore,
 247    - include an element for it in this structure, and
 248    - extend the emacs_{get,set}_tty functions in sysdep.c to deal with the
 249      new members.  */
 250
 251 struct emacs_tty {
 252
 253 /* There is always one of the following elements, so there is no need
 254    for dummy get and set definitions.  */
 255 #ifdef HAVE_TCATTR
 256   struct termios main;
 257 #else
 258 #ifdef HAVE_TERMIO
 259   struct termio main;
 260 #else
 261 #ifdef VMS
 262   struct sensemode main;
 263 #else
 264 #ifdef DOS_NT
 265   int main;
 266 #else  /* not DOS_NT */
 267   struct sgttyb main;
 268 #endif /* not DOS_NT */
 269 #endif
 270 #endif
 271 #endif
 272
 273 /* If we have TERMIOS, we don't need to do this - they're taken care of
 274    by the tc*attr calls.  */
 275 #ifndef HAVE_TERMIOS
 276 #ifdef HAVE_LTCHARS
 277   struct ltchars ltchars;
 278 #endif
 279
 280 #ifdef HAVE_TCHARS
 281   struct tchars tchars;
 282   int lmode;
 283 #endif
 284 #endif
 285 };
 286 \f
 287 /* Define EMACS_GET_TTY and EMACS_SET_TTY,
 288    the macros for reading and setting parts of `struct emacs_tty'.
 289
 290    These got pretty unmanageable (huge macros are hard to debug), and
 291    finally needed some code which couldn't be done as part of an
 292    expression, so we moved them out to their own functions in sysdep.c.  */
 293 #define EMACS_GET_TTY(fd, p)        (emacs_get_tty ((fd), (p)))
 294 #define EMACS_SET_TTY(fd, p, waitp) (emacs_set_tty ((fd), (p), (waitp)))
 295 #ifdef P_  /* Unfortunately this file is sometimes included before lisp.h */
 296 extern int emacs_get_tty P_ ((int, struct emacs_tty *));
 297 extern int emacs_set_tty P_ ((int, struct emacs_tty *, int));
 298 #endif
 299
 300 \f
 301 /* Define EMACS_TTY_TABS_OK.  */
 302
 303 #ifdef HAVE_TERMIOS
 304
 305 #ifdef TABDLY
 306 #define EMACS_TTY_TABS_OK(p) (((p)->main.c_oflag & TABDLY) != TAB3)
 307 #else
 308 #define EMACS_TTY_TABS_OK(p) 1
 309 #endif
 310
 311 #else /* not def HAVE_TERMIOS */
 312 #ifdef HAVE_TERMIO
 313
 314 #define EMACS_TTY_TABS_OK(p) (((p)->main.c_oflag & TABDLY) != TAB3)
 315
 316 #else /* neither HAVE_TERMIO nor HAVE_TERMIOS */
 317 #ifdef VMS
 318
 319 #define EMACS_TTY_TABS_OK(p) (((p)->main.tt_char & TT$M_MECHTAB) != 0)
 320
 321 #else
 322
 323 #ifdef DOS_NT
 324 #define EMACS_TTY_TABS_OK(p) 0
 325 #else /* not DOS_NT */
 326 #define EMACS_TTY_TABS_OK(p) (((p)->main.sg_flags & XTABS) != XTABS)
 327 #endif /* not DOS_NT */
 328
 329 #endif /* not def VMS */
 330 #endif /* not def HAVE_TERMIO */
 331 #endif /* not def HAVE_TERMIOS */
 332
 333 /* arch-tag: cf4b90bc-be41-401c-be98-40619178a712
 334    (do not change this comment) */