Document display-buffer-alist and related variables in Lisp manual.
[emacs.git] / src / systty.h
blob647cfa23cee72c48667d7bc950f44ef2e72c75c3
1 /* systty.h - System-dependent definitions for terminals.
2 Copyright (C) 1993-1994, 2001-2011 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
19 /* Include the proper files. */
20 #ifndef DOS_NT
21 #ifndef NO_TERMIO
22 #include <termio.h>
23 #endif /* not NO_TERMIO */
24 #include <termios.h>
25 #include <fcntl.h>
26 #endif /* not DOS_NT */
28 #include <sys/ioctl.h>
30 #ifdef HPUX
31 #include <sys/bsdtty.h>
32 #include <sys/ptyio.h>
33 #endif
35 #ifdef AIX
36 #include <sys/pty.h>
37 #endif /* AIX */
39 #include <unistd.h>
42 /* Special cases - inhibiting the use of certain features. */
44 /* Allow m- file to inhibit use of FIONREAD. */
45 #ifdef BROKEN_FIONREAD
46 #undef FIONREAD
47 #undef ASYNC
48 #endif
50 /* Interrupt input is not used if there is no FIONREAD. */
51 #ifndef FIONREAD
52 #undef SIGIO
53 #endif
56 /* Try to establish the correct character to disable terminal functions
57 in a system-independent manner. Note that USG (at least) define
58 _POSIX_VDISABLE as 0! */
60 #ifdef _POSIX_VDISABLE
61 #define CDISABLE _POSIX_VDISABLE
62 #else /* not _POSIX_VDISABLE */
63 #ifdef CDEL
64 #undef CDISABLE
65 #define CDISABLE CDEL
66 #else /* not CDEL */
67 #define CDISABLE 255
68 #endif /* not CDEL */
69 #endif /* not _POSIX_VDISABLE */
71 /* Get the number of characters queued for output. */
73 /* EMACS_OUTQSIZE(FD, int *SIZE) stores the number of characters
74 queued for output to the terminal FD in *SIZE, if FD is a tty.
75 Returns -1 if there was an error (i.e. FD is not a tty), 0
76 otherwise. */
77 #ifdef TIOCOUTQ
78 #define EMACS_OUTQSIZE(fd, size) (ioctl ((fd), TIOCOUTQ, (size)))
79 #endif
82 /* Manipulate a terminal's current process group. */
84 /* EMACS_GETPGRP (arg) returns the process group of the process. */
86 #if defined (GETPGRP_VOID)
87 # define EMACS_GETPGRP(x) getpgrp()
88 #else /* !GETPGRP_VOID */
89 # define EMACS_GETPGRP(x) getpgrp(x)
90 #endif /* !GETPGRP_VOID */
92 /* Manipulate a TTY's input/output processing parameters. */
94 /* struct emacs_tty is a structure used to hold the current tty
95 parameters. If the terminal has several structures describing its
96 state, for example a struct tchars, a struct sgttyb, a struct
97 tchars, a struct ltchars, and a struct pagechars, struct
98 emacs_tty should contain an element for each parameter struct
99 that Emacs may change. */
102 /* For each tty parameter structure that Emacs might want to save and restore,
103 - include an element for it in this structure, and
104 - extend the emacs_{get,set}_tty functions in sysdep.c to deal with the
105 new members. */
107 struct emacs_tty {
109 /* There is always one of the following elements, so there is no need
110 for dummy get and set definitions. */
111 #ifndef DOS_NT
112 struct termios main;
113 #else /* DOS_NT */
114 int main;
115 #endif /* DOS_NT */
118 /* From sysdep.c or w32.c */
119 extern int serial_open (char *);
120 extern void serial_configure (struct Lisp_Process *, Lisp_Object);