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, 2009, 2010  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 #include <fcntl.h>
  31 #else /* not HAVE_TERMIO */
  32 #ifdef HAVE_TERMIOS
  33 #ifndef NO_TERMIO
  34 #include <termio.h>
  35 #endif
  36 #include <termios.h>
  37 #include <fcntl.h>
  38 #else /* neither HAVE_TERMIO nor HAVE_TERMIOS */
  39 #ifndef DOS_NT
  40 #include <sgtty.h>
  41 #endif /* not DOS_NT */
  42 #endif /* not HAVE_TERMIOS */
  43 #endif /* not HAVE_TERMIO */
  44
  45 #ifdef __GNU_LIBRARY__
  46 #include <sys/ioctl.h>
  47 #include <termios.h>
  48 #endif
  49
  50 #ifdef HPUX
  51 #include <sys/bsdtty.h>
  52 #include <sys/ptyio.h>
  53 #endif
  54
  55 #ifdef AIX
  56 #include <sys/pty.h>
  57 #endif /* AIX */
  58
  59 #ifdef HAVE_UNISTD_H
  60 #include <unistd.h>
  61 #endif
  62
  63 \f
  64 /* Special cases - inhibiting the use of certain features.  */
  65
  66 /* Allow m- file to inhibit use of FIONREAD.  */
  67 #ifdef BROKEN_FIONREAD
  68 #undef FIONREAD
  69 #undef ASYNC
  70 #endif
  71
  72 /* Interrupt input is not used if there is no FIONREAD.  */
  73 #ifndef FIONREAD
  74 #undef SIGIO
  75 #endif
  76
  77 /* On TERMIOS systems, the tcmumbleattr calls take care of these
  78    parameters, and it's a bad idea to use them (on AIX, it makes the
  79    tty hang for a long time).  */
  80 #if defined (TIOCGLTC) && !defined (HAVE_TERMIOS)
  81 #define HAVE_LTCHARS
  82 #endif
  83
  84 #if defined (TIOCGETC) && !defined (HAVE_TERMIOS)
  85 #define HAVE_TCHARS
  86 #endif
  87
  88 \f
  89 /* Try to establish the correct character to disable terminal functions
  90    in a system-independent manner.  Note that USG (at least) define
  91    _POSIX_VDISABLE as 0!  */
  92
  93 #ifdef _POSIX_VDISABLE
  94 #define CDISABLE _POSIX_VDISABLE
  95 #else /* not _POSIX_VDISABLE */
  96 #ifdef CDEL
  97 #undef CDISABLE
  98 #define CDISABLE CDEL
  99 #else /* not CDEL */
 100 #define CDISABLE 255
 101 #endif /* not CDEL */
 102 #endif /* not _POSIX_VDISABLE */
 103 \f
 104 /* Get the number of characters queued for output.  */
 105
 106 /* EMACS_OUTQSIZE(FD, int *SIZE) stores the number of characters
 107    queued for output to the terminal FD in *SIZE, if FD is a tty.
 108    Returns -1 if there was an error (i.e. FD is not a tty), 0
 109    otherwise.  */
 110 #ifdef TIOCOUTQ
 111 #define EMACS_OUTQSIZE(fd, size) (ioctl ((fd), TIOCOUTQ, (size)))
 112 #endif
 113
 114 #ifdef HAVE_TERMIO
 115 #ifdef TCOUTQ
 116 #undef EMACS_OUTQSIZE
 117 #define EMACS_OUTQSIZE(fd, size) (ioctl ((fd), TCOUTQ, (size)))
 118 #endif
 119 #endif
 120
 121 \f
 122 /* Manipulate a terminal's current process group.  */
 123
 124 /* EMACS_HAVE_TTY_PGRP is true if we can get and set the tty's current
 125    controlling process group.
 126
 127    EMACS_GET_TTY_PGRP(int FD, int *PGID) sets *PGID the terminal FD's
 128    current process group.  Return -1 if there is an error.
 129
 130    EMACS_SET_TTY_PGRP(int FD, int *PGID) sets the terminal FD's
 131    current process group to *PGID.  Return -1 if there is an error.  */
 132
 133 /* HPUX tty process group stuff doesn't work, says the anonymous voice
 134    from the past.  */
 135 #ifndef HPUX
 136 #ifdef TIOCGPGRP
 137 #define EMACS_HAVE_TTY_PGRP
 138 #else
 139 #ifdef HAVE_TERMIOS
 140 #define EMACS_HAVE_TTY_PGRP
 141 #endif /* HAVE_TERMIOS */
 142 #endif /* TIOCGPGRP */
 143 #endif /* not HPUX */
 144
 145 #ifdef EMACS_HAVE_TTY_PGRP
 146
 147 #if defined (HAVE_TERMIOS)
 148
 149 #define EMACS_GET_TTY_PGRP(fd, pgid) (*(pgid) = tcgetpgrp ((fd)))
 150 #define EMACS_SET_TTY_PGRP(fd, pgid) (tcsetpgrp ((fd), *(pgid)))
 151
 152 #else /* not HAVE_TERMIOS */
 153 #ifdef TIOCSPGRP
 154
 155 #define EMACS_GET_TTY_PGRP(fd, pgid) (ioctl ((fd), TIOCGPGRP, (pgid)))
 156 #define EMACS_SET_TTY_PGRP(fd, pgid) (ioctl ((fd), TIOCSPGRP, (pgid)))
 157
 158 #endif /* TIOCSPGRP */
 159 #endif /* HAVE_TERMIOS */
 160
 161 #else /* not EMACS_SET_TTY_PGRP */
 162
 163 /* Just ignore this for now and hope for the best */
 164 #define EMACS_GET_TTY_PGRP(fd, pgid) 0
 165 #define EMACS_SET_TTY_PGRP(fd, pgif) 0
 166
 167 #endif /* not EMACS_SET_TTY_PGRP */
 168
 169 /* EMACS_GETPGRP (arg) returns the process group of the process.  */
 170
 171 #if defined (GETPGRP_VOID)
 172 #  define EMACS_GETPGRP(x) getpgrp()
 173 #else /* !GETPGRP_VOID */
 174 #  define EMACS_GETPGRP(x) getpgrp(x)
 175 #endif /* !GETPGRP_VOID */
 176 \f
 177 /* Manipulate a TTY's input/output processing parameters.  */
 178
 179 /* struct emacs_tty is a structure used to hold the current tty
 180    parameters.  If the terminal has several structures describing its
 181    state, for example a struct tchars, a struct sgttyb, a struct
 182    tchars, a struct ltchars, and a struct pagechars, struct
 183    emacs_tty should contain an element for each parameter struct
 184    that Emacs may change.
 185
 186    EMACS_GET_TTY (int FD, struct emacs_tty *P) stores the parameters
 187    of the tty on FD in *P.  Return zero if all's well, or -1 if we ran
 188    into an error we couldn't deal with.
 189
 190    EMACS_SET_TTY (int FD, struct emacs_tty *P, int flushp)
 191    sets the parameters of the tty on FD according to the contents of
 192    *P.  If flushp is non-zero, we discard queued input to be
 193    written before making the change.
 194    Return 0 if all went well, and -1 if anything failed.
 195
 196    EMACS_TTY_TABS_OK (struct emacs_tty *P) is false if the kernel
 197    expands tabs to spaces upon output; in that case, there is no
 198    advantage to using tabs over spaces.  */
 199
 200
 201 /* For each tty parameter structure that Emacs might want to save and restore,
 202    - include an element for it in this structure, and
 203    - extend the emacs_{get,set}_tty functions in sysdep.c to deal with the
 204      new members.  */
 205
 206 struct emacs_tty {
 207
 208 /* There is always one of the following elements, so there is no need
 209    for dummy get and set definitions.  */
 210 #ifdef HAVE_TCATTR
 211   struct termios main;
 212 #else /* not HAVE_TCATTR */
 213 #ifdef HAVE_TERMIO
 214   struct termio main;
 215 #else /* not HAVE_TERMIO */
 216 #ifdef DOS_NT
 217   int main;
 218 #else  /* not DOS_NT */
 219   struct sgttyb main;
 220 #endif /* not DOS_NT */
 221 #endif /* not HAVE_TERMIO */
 222 #endif /* not HAVE_TCATTR */
 223
 224 /* If we have TERMIOS, we don't need to do this - they're taken care of
 225    by the tc*attr calls.  */
 226 #ifndef HAVE_TERMIOS
 227 #ifdef HAVE_LTCHARS
 228   struct ltchars ltchars;
 229 #endif /* HAVE_LTCHARS */
 230
 231 #ifdef HAVE_TCHARS
 232   struct tchars tchars;
 233   int lmode;
 234 #endif /* HAVE_TCHARS */
 235 #endif /* not defined HAVE_TERMIOS */
 236 };
 237 \f
 238 /* Define EMACS_GET_TTY and EMACS_SET_TTY,
 239    the macros for reading and setting parts of `struct emacs_tty'.
 240
 241    These got pretty unmanageable (huge macros are hard to debug), and
 242    finally needed some code which couldn't be done as part of an
 243    expression, so we moved them out to their own functions in sysdep.c.  */
 244 #define EMACS_GET_TTY(fd, p)        (emacs_get_tty ((fd), (p)))
 245 #define EMACS_SET_TTY(fd, p, waitp) (emacs_set_tty ((fd), (p), (waitp)))
 246 extern int emacs_get_tty (int, struct emacs_tty *);
 247 extern int emacs_set_tty (int, struct emacs_tty *, int);
 248
 249 \f
 250 /* Define EMACS_TTY_TABS_OK.  */
 251
 252 #ifdef HAVE_TERMIOS
 253
 254 #ifdef TABDLY
 255 #define EMACS_TTY_TABS_OK(p) (((p)->main.c_oflag & TABDLY) != TAB3)
 256 #else /* not TABDLY */
 257 #define EMACS_TTY_TABS_OK(p) 1
 258 #endif /* not TABDLY */
 259
 260 #else /* not def HAVE_TERMIOS */
 261 #ifdef HAVE_TERMIO
 262
 263 #define EMACS_TTY_TABS_OK(p) (((p)->main.c_oflag & TABDLY) != TAB3)
 264
 265 #else /* neither HAVE_TERMIO nor HAVE_TERMIOS */
 266
 267 #ifdef DOS_NT
 268 #define EMACS_TTY_TABS_OK(p) 0
 269 #else /* not DOS_NT */
 270 #define EMACS_TTY_TABS_OK(p) (((p)->main.sg_flags & XTABS) != XTABS)
 271 #endif /* not DOS_NT */
 272
 273 #endif /* not def HAVE_TERMIO */
 274 #endif /* not def HAVE_TERMIOS */
 275
 276 /* arch-tag: cf4b90bc-be41-401c-be98-40619178a712
 277    (do not change this comment) */