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