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_GETPGRP (arg) returns the process group of the process.  */
  90
  91 #if defined (GETPGRP_VOID)
  92 #  define EMACS_GETPGRP(x) getpgrp()
  93 #else /* !GETPGRP_VOID */
  94 #  define EMACS_GETPGRP(x) getpgrp(x)
  95 #endif /* !GETPGRP_VOID */
  96 \f
  97 /* Manipulate a TTY's input/output processing parameters.  */
  98
  99 /* struct emacs_tty is a structure used to hold the current tty
 100    parameters.  If the terminal has several structures describing its
 101    state, for example a struct tchars, a struct sgttyb, a struct
 102    tchars, a struct ltchars, and a struct pagechars, struct
 103    emacs_tty should contain an element for each parameter struct
 104    that Emacs may change.  */
 105
 106
 107 /* For each tty parameter structure that Emacs might want to save and restore,
 108    - include an element for it in this structure, and
 109    - extend the emacs_{get,set}_tty functions in sysdep.c to deal with the
 110      new members.  */
 111
 112 struct emacs_tty {
 113
 114 /* There is always one of the following elements, so there is no need
 115    for dummy get and set definitions.  */
 116 #ifndef DOS_NT
 117   struct termios main;
 118 #else /* DOS_NT */
 119   int main;
 120 #endif /* DOS_NT */
 121 };
 122 \f
 123 extern int emacs_get_tty (int, struct emacs_tty *);
 124 extern int emacs_set_tty (int, struct emacs_tty *, int);
 125