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 /* Include the proper files.  */
  21 #ifndef DOS_NT
  22 #ifndef NO_TERMIO
  23 #include <termio.h>
  24 #endif /* not NO_TERMIO */
  25 #include <termios.h>
  26 #include <fcntl.h>
  27 #endif /* not DOS_NT */
  28
  29 #ifdef HAVE_SYS_IOCTL_H
  30 #include <sys/ioctl.h>
  31 #endif
  32
  33 #ifdef HPUX
  34 #include <sys/bsdtty.h>
  35 #include <sys/ptyio.h>
  36 #endif
  37
  38 #ifdef AIX
  39 #include <sys/pty.h>
  40 #endif /* AIX */
  41
  42 #ifdef HAVE_UNISTD_H
  43 #include <unistd.h>
  44 #endif
  45
  46 \f
  47 /* Special cases - inhibiting the use of certain features.  */
  48
  49 /* Allow m- file to inhibit use of FIONREAD.  */
  50 #ifdef BROKEN_FIONREAD
  51 #undef FIONREAD
  52 #undef ASYNC
  53 #endif
  54
  55 /* Interrupt input is not used if there is no FIONREAD.  */
  56 #ifndef FIONREAD
  57 #undef SIGIO
  58 #endif
  59
  60 \f
  61 /* Try to establish the correct character to disable terminal functions
  62    in a system-independent manner.  Note that USG (at least) define
  63    _POSIX_VDISABLE as 0!  */
  64
  65 #ifdef _POSIX_VDISABLE
  66 #define CDISABLE _POSIX_VDISABLE
  67 #else /* not _POSIX_VDISABLE */
  68 #ifdef CDEL
  69 #undef CDISABLE
  70 #define CDISABLE CDEL
  71 #else /* not CDEL */
  72 #define CDISABLE 255
  73 #endif /* not CDEL */
  74 #endif /* not _POSIX_VDISABLE */
  75 \f
  76 /* Get the number of characters queued for output.  */
  77
  78 /* EMACS_OUTQSIZE(FD, int *SIZE) stores the number of characters
  79    queued for output to the terminal FD in *SIZE, if FD is a tty.
  80    Returns -1 if there was an error (i.e. FD is not a tty), 0
  81    otherwise.  */
  82 #ifdef TIOCOUTQ
  83 #define EMACS_OUTQSIZE(fd, size) (ioctl ((fd), TIOCOUTQ, (size)))
  84 #endif
  85
  86 \f
  87 /* Manipulate a terminal's current process group.  */
  88
  89 /* EMACS_GET_TTY_PGRP(int FD, int *PGID) sets *PGID the terminal FD's
  90    current process group.  Return -1 if there is an error.
  91
  92    EMACS_SET_TTY_PGRP(int FD, int *PGID) sets the terminal FD's
  93    current process group to *PGID.  Return -1 if there is an error.  */
  94
  95 #ifndef DOS_NT
  96 #define EMACS_GET_TTY_PGRP(fd, pgid) (*(pgid) = tcgetpgrp ((fd)))
  97 #define EMACS_SET_TTY_PGRP(fd, pgid) (tcsetpgrp ((fd), *(pgid)))
  98 #endif /* not DOS_NT */
  99
 100 /* EMACS_GETPGRP (arg) returns the process group of the process.  */
 101
 102 #if defined (GETPGRP_VOID)
 103 #  define EMACS_GETPGRP(x) getpgrp()
 104 #else /* !GETPGRP_VOID */
 105 #  define EMACS_GETPGRP(x) getpgrp(x)
 106 #endif /* !GETPGRP_VOID */
 107 \f
 108 /* Manipulate a TTY's input/output processing parameters.  */
 109
 110 /* struct emacs_tty is a structure used to hold the current tty
 111    parameters.  If the terminal has several structures describing its
 112    state, for example a struct tchars, a struct sgttyb, a struct
 113    tchars, a struct ltchars, and a struct pagechars, struct
 114    emacs_tty should contain an element for each parameter struct
 115    that Emacs may change.
 116
 117    EMACS_GET_TTY (int FD, struct emacs_tty *P) stores the parameters
 118    of the tty on FD in *P.  Return zero if all's well, or -1 if we ran
 119    into an error we couldn't deal with.
 120
 121    EMACS_SET_TTY (int FD, struct emacs_tty *P, int flushp)
 122    sets the parameters of the tty on FD according to the contents of
 123    *P.  If flushp is non-zero, we discard queued input to be
 124    written before making the change.
 125    Return 0 if all went well, and -1 if anything failed.
 126
 127    EMACS_TTY_TABS_OK (struct emacs_tty *P) is false if the kernel
 128    expands tabs to spaces upon output; in that case, there is no
 129    advantage to using tabs over spaces.  */
 130
 131
 132 /* For each tty parameter structure that Emacs might want to save and restore,
 133    - include an element for it in this structure, and
 134    - extend the emacs_{get,set}_tty functions in sysdep.c to deal with the
 135      new members.  */
 136
 137 struct emacs_tty {
 138
 139 /* There is always one of the following elements, so there is no need
 140    for dummy get and set definitions.  */
 141 #ifndef DOS_NT
 142   struct termios main;
 143 #else /* DOS_NT */
 144   int main;
 145 #endif /* DOS_NT */
 146 };
 147 \f
 148 /* Define EMACS_GET_TTY and EMACS_SET_TTY,
 149    the macros for reading and setting parts of `struct emacs_tty'.
 150
 151    These got pretty unmanageable (huge macros are hard to debug), and
 152    finally needed some code which couldn't be done as part of an
 153    expression, so we moved them out to their own functions in sysdep.c.  */
 154 #define EMACS_GET_TTY(fd, p)        (emacs_get_tty ((fd), (p)))
 155 #define EMACS_SET_TTY(fd, p, waitp) (emacs_set_tty ((fd), (p), (waitp)))
 156 extern int emacs_get_tty (int, struct emacs_tty *);
 157 extern int emacs_set_tty (int, struct emacs_tty *, int);
 158
 159 \f
 160 /* Define EMACS_TTY_TABS_OK.  */
 161
 162 #ifndef DOS_NT
 163
 164 #ifdef TABDLY
 165 #define EMACS_TTY_TABS_OK(p) (((p)->main.c_oflag & TABDLY) != TAB3)
 166 #else /* not TABDLY */
 167 #define EMACS_TTY_TABS_OK(p) 1
 168 #endif /* not TABDLY */
 169
 170 #else /* DOS_NT */
 171 #define EMACS_TTY_TABS_OK(p) 0
 172 #endif /* DOS_NT */
 173
 174 /* arch-tag: cf4b90bc-be41-401c-be98-40619178a712
 175    (do not change this comment) */