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 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 NEED_BSDTTY
  55 #include <sys/bsdtty.h>
  56 #endif
  57
  58 #if defined (HPUX) && defined (HAVE_PTYS)
  59 #include <sys/ptyio.h>
  60 #endif
  61
  62 #ifdef AIX
  63 #include <sys/pty.h>
  64 #endif /* AIX */
  65
  66 #if (defined (POSIX) || defined (NEED_UNISTD_H)) && defined (HAVE_UNISTD_H)
  67 #include <unistd.h>
  68 #endif
  69
  70 \f
  71 /* Special cases - inhibiting the use of certain features.  */
  72
  73 /* Allow m- file to inhibit use of FIONREAD.  */
  74 #ifdef BROKEN_FIONREAD
  75 #undef FIONREAD
  76 #undef ASYNC
  77 #endif
  78
  79 /* Interrupt input is not used if there is no FIONREAD.  */
  80 #ifndef FIONREAD
  81 #undef SIGIO
  82 #endif
  83
  84 /* On TERMIOS systems, the tcmumbleattr calls take care of these
  85    parameters, and it's a bad idea to use them (on AIX, it makes the
  86    tty hang for a long time).  */
  87 #if defined (TIOCGLTC) && !defined (HAVE_TERMIOS)
  88 #define HAVE_LTCHARS
  89 #endif
  90
  91 #if defined (TIOCGETC) && !defined (HAVE_TERMIOS)
  92 #define HAVE_TCHARS
  93 #endif
  94
  95 \f
  96 /* Try to establish the correct character to disable terminal functions
  97    in a system-independent manner.  Note that USG (at least) define
  98    _POSIX_VDISABLE as 0!  */
  99
 100 #ifdef _POSIX_VDISABLE
 101 #define CDISABLE _POSIX_VDISABLE
 102 #else /* not _POSIX_VDISABLE */
 103 #ifdef CDEL
 104 #undef CDISABLE
 105 #define CDISABLE CDEL
 106 #else /* not CDEL */
 107 #define CDISABLE 255
 108 #endif /* not CDEL */
 109 #endif /* not _POSIX_VDISABLE */
 110 \f
 111 /* Get the number of characters queued for output.  */
 112
 113 /* EMACS_OUTQSIZE(FD, int *SIZE) stores the number of characters
 114    queued for output to the terminal FD in *SIZE, if FD is a tty.
 115    Returns -1 if there was an error (i.e. FD is not a tty), 0
 116    otherwise.  */
 117 #ifdef TIOCOUTQ
 118 #define EMACS_OUTQSIZE(fd, size) (ioctl ((fd), TIOCOUTQ, (size)))
 119 #endif
 120
 121 #ifdef HAVE_TERMIO
 122 #ifdef TCOUTQ
 123 #undef EMACS_OUTQSIZE
 124 #define EMACS_OUTQSIZE(fd, size) (ioctl ((fd), TCOUTQ, (size)))
 125 #endif
 126 #endif
 127
 128 \f
 129 /* Manipulate a terminal's current process group.  */
 130
 131 /* EMACS_HAVE_TTY_PGRP is true if we can get and set the tty's current
 132    controlling process group.
 133
 134    EMACS_GET_TTY_PGRP(int FD, int *PGID) sets *PGID the terminal FD's
 135    current process group.  Return -1 if there is an error.
 136
 137    EMACS_SET_TTY_PGRP(int FD, int *PGID) sets the terminal FD's
 138    current process group to *PGID.  Return -1 if there is an error.  */
 139
 140 /* HPUX tty process group stuff doesn't work, says the anonymous voice
 141    from the past.  */
 142 #ifndef HPUX
 143 #ifdef TIOCGPGRP
 144 #define EMACS_HAVE_TTY_PGRP
 145 #else
 146 #ifdef HAVE_TERMIOS
 147 #define EMACS_HAVE_TTY_PGRP
 148 #endif /* HAVE_TERMIOS */
 149 #endif /* TIOCGPGRP */
 150 #endif /* not HPUX */
 151
 152 #ifdef EMACS_HAVE_TTY_PGRP
 153
 154 #ifdef TIOCSPGRP
 155
 156 #define EMACS_GET_TTY_PGRP(fd, pgid) (ioctl ((fd), TIOCGPGRP, (pgid)))
 157 #define EMACS_SET_TTY_PGRP(fd, pgid) (ioctl ((fd), TIOCSPGRP, (pgid)))
 158
 159 #endif /* TIOCSPGRP */
 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
 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
 213 #ifdef HAVE_TERMIO
 214   struct termio main;
 215 #else
 216 #ifdef DOS_NT
 217   int main;
 218 #else  /* not DOS_NT */
 219   struct sgttyb main;
 220 #endif /* not DOS_NT */
 221 #endif
 222 #endif
 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
 230
 231 #ifdef HAVE_TCHARS
 232   struct tchars tchars;
 233   int lmode;
 234 #endif
 235 #endif
 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 #ifdef P_  /* Unfortunately this file is sometimes included before lisp.h */
 247 extern int emacs_get_tty P_ ((int, struct emacs_tty *));
 248 extern int emacs_set_tty P_ ((int, struct emacs_tty *, int));
 249 #endif
 250
 251 \f
 252 /* Define EMACS_TTY_TABS_OK.  */
 253
 254 #ifdef HAVE_TERMIOS
 255
 256 #ifdef TABDLY
 257 #define EMACS_TTY_TABS_OK(p) (((p)->main.c_oflag & TABDLY) != TAB3)
 258 #else
 259 #define EMACS_TTY_TABS_OK(p) 1
 260 #endif
 261
 262 #else /* not def HAVE_TERMIOS */
 263 #ifdef HAVE_TERMIO
 264
 265 #define EMACS_TTY_TABS_OK(p) (((p)->main.c_oflag & TABDLY) != TAB3)
 266
 267 #else /* neither HAVE_TERMIO nor HAVE_TERMIOS */
 268
 269 #ifdef DOS_NT
 270 #define EMACS_TTY_TABS_OK(p) 0
 271 #else /* not DOS_NT */
 272 #define EMACS_TTY_TABS_OK(p) (((p)->main.sg_flags & XTABS) != XTABS)
 273 #endif /* not DOS_NT */
 274
 275 #endif /* not def HAVE_TERMIO */
 276 #endif /* not def HAVE_TERMIOS */
 277
 278 /* arch-tag: cf4b90bc-be41-401c-be98-40619178a712
 279    (do not change this comment) */