*** empty log message ***
[emacs.git] / src / systty.h
blob6aeb2f65a4e1b1465de321f96415aea2d5fab8a2
1 /* systty.h - System-dependent definitions for terminals.
2 Copyright (C) 1993, 1994 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 2, or (at your option)
9 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; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 #ifdef HAVE_TERMIOS
22 #define HAVE_TCATTR
23 #endif
25 /* If we defined these before and we are about to redefine them,
26 prevent alarming warnings. */
27 #ifdef BSD_TERMIOS
28 #undef NL0
29 #undef NL1
30 #undef CR0
31 #undef CR1
32 #undef CR2
33 #undef CR3
34 #undef TAB0
35 #undef TAB1
36 #undef TAB2
37 #undef XTABS
38 #undef BS0
39 #undef BS1
40 #undef FF0
41 #undef FF1
42 #undef ECHO
43 #undef NOFLSH
44 #undef TOSTOP
45 #undef FLUSHO
46 #undef PENDIN
47 #endif
49 /* Include the proper files. */
50 #ifdef HAVE_TERMIO
51 #ifdef __DGUX
52 #include <sys/ioctl.h>
53 #endif
54 #ifndef NO_TERMIO
55 #include <termio.h>
56 #endif /* not NO_TERMIO */
57 #ifndef INCLUDED_FCNTL
58 #define INCLUDED_FCNTL
59 #include <fcntl.h>
60 #endif
61 #else /* not HAVE_TERMIO */
62 #ifdef HAVE_TERMIOS
63 #if defined(_AIX) && defined(_I386)
64 #include <termios.h> /* termios.h needs to be before termio.h */
65 #include <termio.h>
66 #else /* not (_AIX && _I386) */
67 #ifndef NO_TERMIO
68 #include <termio.h>
69 #endif
70 #include <termios.h>
71 #endif /* not (_AIX && _I386) */
72 #define INCLUDED_FCNTL
73 #include <fcntl.h>
74 #else /* neither HAVE_TERMIO nor HAVE_TERMIOS */
75 #ifndef VMS
76 #ifndef DOS_NT
77 #include <sgtty.h>
78 #endif /* not DOS_NT */
79 #else /* VMS */
80 #include <descrip.h>
81 static struct iosb
83 short status;
84 short offset;
85 short termlen;
86 short term;
87 } input_iosb;
89 extern int waiting_for_ast;
90 extern int stop_input;
91 extern int input_ef;
92 extern int timer_ef;
93 extern int process_ef;
94 extern int input_eflist;
95 extern int timer_eflist;
97 static $DESCRIPTOR (input_dsc, "TT");
98 static int terminator_mask[2] = { 0, 0 };
100 static struct sensemode {
101 short status;
102 unsigned char xmit_baud;
103 unsigned char rcv_baud;
104 unsigned char crfill;
105 unsigned char lffill;
106 unsigned char parity;
107 unsigned char unused;
108 char class;
109 char type;
110 short scr_wid;
111 unsigned long tt_char : 24, scr_len : 8;
112 unsigned long tt2_char;
113 } sensemode_iosb;
114 #endif /* VMS */
115 #endif /* not HAVE_TERMIOS */
116 #endif /* not HAVE_TERMIO */
118 #ifdef __GNU_LIBRARY__
119 #include <sys/ioctl.h>
120 #include <termios.h>
121 #endif
123 #ifdef AIXHFT
124 /* Get files for keyboard remapping */
125 #define HFNKEYS 2
126 #include <sys/hft.h>
127 #include <sys/devinfo.h>
128 #endif
130 /* Get rid of LLITOUT in 4.1, since it is said to stimulate kernel bugs. */
131 #ifdef BSD4_1
132 #undef LLITOUT
133 #define LLITOUT 0
134 #endif /* 4.1 */
136 #ifdef NEED_BSDTTY
137 #include <sys/bsdtty.h>
138 #endif
140 #if defined (HPUX) && defined (HAVE_PTYS)
141 #include <sys/ptyio.h>
142 #endif
144 #ifdef AIX
145 #include <sys/pty.h>
146 #endif /* AIX */
148 #if (defined (POSIX) || defined (NEED_UNISTD_H)) && defined (HAVE_UNISTD_H)
149 #include <unistd.h>
150 #endif
152 #ifdef SYSV_PTYS
153 #include <sys/types.h>
154 #include <sys/tty.h>
155 #ifdef titan
156 #include <sys/ttyhw.h>
157 #include <sys/stream.h>
158 #endif
159 #ifndef NO_PTY_H
160 #include <sys/pty.h>
161 #endif
162 #endif
164 /* saka@pfu.fujitsu.co.JP writes:
165 FASYNC defined in this file. But, FASYNC don't working.
166 so no problem, because unrequest_sigio only need. */
167 #if defined (pfa)
168 #include <sys/file.h>
169 #endif
172 /* Special cases - inhibiting the use of certain features. */
174 #ifdef APOLLO
175 #undef TIOCSTART
176 #endif
178 #ifdef XENIX
179 #undef TIOCGETC /* Avoid confusing some conditionals that test this. */
180 #endif
182 #ifdef BROKEN_TIOCGETC
183 #undef TIOCGETC /* Avoid confusing some conditionals that test this. */
184 #endif
186 /* UNIPLUS systems may have FIONREAD. */
187 #ifdef UNIPLUS
188 #include <sys.ioctl.h>
189 #endif
191 /* Allow m- file to inhibit use of FIONREAD. */
192 #ifdef BROKEN_FIONREAD
193 #undef FIONREAD
194 #undef ASYNC
195 #endif
197 /* Interrupt input is not used if there is no FIONREAD. */
198 #ifndef FIONREAD
199 #undef SIGIO
200 #endif
202 /* On TERMIOS systems, the tcmumbleattr calls take care of these
203 parameters, and it's a bad idea to use them (on AIX, it makes the
204 tty hang for a long time). */
205 #if defined (TIOCGLTC) && !defined (HAVE_TERMIOS)
206 #define HAVE_LTCHARS
207 #endif
209 #if defined (TIOCGETC) && !defined (HAVE_TERMIOS)
210 #define HAVE_TCHARS
211 #endif
214 /* Try to establish the correct character to disable terminal functions
215 in a system-independent manner. Note that USG (at least) define
216 _POSIX_VDISABLE as 0! */
218 #ifdef _POSIX_VDISABLE
219 #define CDISABLE _POSIX_VDISABLE
220 #else /* not _POSIX_VDISABLE */
221 #ifdef CDEL
222 #undef CDISABLE
223 #define CDISABLE CDEL
224 #else /* not CDEL */
225 #define CDISABLE 255
226 #endif /* not CDEL */
227 #endif /* not _POSIX_VDISABLE */
229 /* Get the number of characters queued for output. */
231 /* EMACS_OUTQSIZE(FD, int *SIZE) stores the number of characters
232 queued for output to the terminal FD in *SIZE, if FD is a tty.
233 Returns -1 if there was an error (i.e. FD is not a tty), 0
234 otherwise. */
235 #ifdef TIOCOUTQ
236 #define EMACS_OUTQSIZE(fd, size) (ioctl ((fd), TIOCOUTQ, (size)))
237 #endif
239 #ifdef HAVE_TERMIO
240 #ifdef TCOUTQ
241 #undef EMACS_OUTQSIZE
242 #define EMACS_OUTQSIZE(fd, size) (ioctl ((fd), TCOUTQ, (size)))
243 #endif
244 #endif
247 /* Manipulate a terminal's current process group. */
249 /* EMACS_HAVE_TTY_PGRP is true if we can get and set the tty's current
250 controlling process group.
252 EMACS_GET_TTY_PGRP(int FD, int *PGID) sets *PGID the terminal FD's
253 current process group. Return -1 if there is an error.
255 EMACS_SET_TTY_PGRP(int FD, int *PGID) sets the terminal FD's
256 current process group to *PGID. Return -1 if there is an error. */
258 #ifdef HPUX
259 /* HPUX tty process group stuff doesn't work, says the anonymous voice
260 from the past. */
261 #else
262 #ifdef TIOCGPGRP
263 #define EMACS_HAVE_TTY_PGRP
264 #else
265 #ifdef HAVE_TERMIOS
266 #define EMACS_HAVE_TTY_PGRP
267 #endif
268 #endif
269 #endif
271 #ifdef EMACS_HAVE_TTY_PGRP
273 #if defined (HAVE_TERMIOS) && ! defined (BSD_TERMIOS)
275 #define EMACS_GET_TTY_PGRP(fd, pgid) (*(pgid) = tcgetpgrp ((fd)))
276 #define EMACS_SET_TTY_PGRP(fd, pgid) (tcsetpgrp ((fd), *(pgid)))
278 #else
279 #ifdef TIOCSPGRP
281 #define EMACS_GET_TTY_PGRP(fd, pgid) (ioctl ((fd), TIOCGPGRP, (pgid)))
282 #define EMACS_SET_TTY_PGRP(fd, pgid) (ioctl ((fd), TIOCSPGRP, (pgid)))
284 #endif
285 #endif
287 #else
289 /* Just ignore this for now and hope for the best */
290 #define EMACS_GET_TTY_PGRP(fd, pgid) 0
291 #define EMACS_SET_TTY_PGRP(fd, pgif) 0
293 #endif
295 /* EMACS_GETPGRP (arg) returns the process group of the process. */
297 #ifdef __GNU_LIBRARY__
298 /* GNU libc by default defines getpgrp with no args on all systems. */
299 #if __GLIBC__ >= 2
300 /* glibc-2.1 adds the BSD compatibility getpgrp function
301 if you use _BSD_SOURCE, which Emacs does on GNU/Linux systems. */
302 #if __GLIBC_MINOR__ < 1 || ! defined (__FAVOR_BSD)
303 #define GETPGRP_NO_ARG
304 #endif
305 #else /* __GLIBC__ < 2 */
306 #define GETPGRP_NO_ARG
307 #endif /* __GLIBC__ < 2 */
308 #else /* not __GNU_LIBRARY__ */
309 #if defined (USG) && !defined (GETPGRP_NEEDS_ARG)
310 # if !defined (GETPGRP_NO_ARG)
311 # define GETPGRP_NO_ARG
312 # endif
313 #endif
314 #endif /* not __GNU_LIBRARY__ */
316 #if defined (GETPGRP_NO_ARG)
317 # define EMACS_GETPGRP(x) getpgrp()
318 #else
319 # define EMACS_GETPGRP(x) getpgrp(x)
320 #endif /* !GETPGRP_NO_ARG */
322 /* Manipulate a TTY's input/output processing parameters. */
324 /* struct emacs_tty is a structure used to hold the current tty
325 parameters. If the terminal has several structures describing its
326 state, for example a struct tchars, a struct sgttyb, a struct
327 tchars, a struct ltchars, and a struct pagechars, struct
328 emacs_tty should contain an element for each parameter struct
329 that Emacs may change.
331 EMACS_GET_TTY (int FD, struct emacs_tty *P) stores the parameters
332 of the tty on FD in *P. Return zero if all's well, or -1 if we ran
333 into an error we couldn't deal with.
335 EMACS_SET_TTY (int FD, struct emacs_tty *P, int flushp)
336 sets the parameters of the tty on FD according to the contents of
337 *P. If flushp is non-zero, we discard queued input to be
338 written before making the change.
339 Return 0 if all went well, and -1 if anything failed.
341 EMACS_TTY_TABS_OK (struct emacs_tty *P) is false iff the kernel
342 expands tabs to spaces upon output; in that case, there is no
343 advantage to using tabs over spaces. */
346 /* For each tty parameter structure that Emacs might want to save and restore,
347 - include an element for it in this structure, and
348 - extend the emacs_{get,set}_tty functions in sysdep.c to deal with the
349 new members. */
351 struct emacs_tty {
353 /* There is always one of the following elements, so there is no need
354 for dummy get and set definitions. */
355 #ifdef HAVE_TCATTR
356 struct termios main;
357 #else
358 #ifdef HAVE_TERMIO
359 struct termio main;
360 #else
361 #ifdef VMS
362 struct sensemode main;
363 #else
364 #ifdef DOS_NT
365 int main;
366 #else /* not DOS_NT */
367 struct sgttyb main;
368 #endif /* not DOS_NT */
369 #endif
370 #endif
371 #endif
373 /* If we have TERMIOS, we don't need to do this - they're taken care of
374 by the tc*attr calls. */
375 #ifndef HAVE_TERMIOS
376 #ifdef HAVE_LTCHARS
377 struct ltchars ltchars;
378 #endif
380 #ifdef HAVE_TCHARS
381 struct tchars tchars;
382 int lmode;
383 #endif
384 #endif
387 /* Define EMACS_GET_TTY and EMACS_SET_TTY,
388 the macros for reading and setting parts of `struct emacs_tty'.
390 These got pretty unmanageable (huge macros are hard to debug), and
391 finally needed some code which couldn't be done as part of an
392 expression, so we moved them out to their own functions in sysdep.c. */
393 #define EMACS_GET_TTY(fd, p) (emacs_get_tty ((fd), (p)))
394 #define EMACS_SET_TTY(fd, p, waitp) (emacs_set_tty ((fd), (p), (waitp)))
395 #ifdef P_ /* Unfortunately this file is sometimes included before lisp.h */
396 extern int emacs_get_tty P_ ((int, struct emacs_tty *));
397 extern int emacs_set_tty P_ ((int, struct emacs_tty *, int));
398 #endif
401 /* Define EMACS_TTY_TABS_OK. */
403 #ifdef HAVE_TERMIOS
405 #ifdef TABDLY
406 #define EMACS_TTY_TABS_OK(p) (((p)->main.c_oflag & TABDLY) != TAB3)
407 #else
408 #define EMACS_TTY_TABS_OK(p) 1
409 #endif
411 #else /* not def HAVE_TERMIOS */
412 #ifdef HAVE_TERMIO
414 #define EMACS_TTY_TABS_OK(p) (((p)->main.c_oflag & TABDLY) != TAB3)
416 #else /* neither HAVE_TERMIO nor HAVE_TERMIOS */
417 #ifdef VMS
419 #define EMACS_TTY_TABS_OK(p) (((p)->main.tt_char & TT$M_MECHTAB) != 0)
421 #else
423 #ifdef DOS_NT
424 #define EMACS_TTY_TABS_OK(p) 0
425 #else /* not DOS_NT */
426 #define EMACS_TTY_TABS_OK(p) (((p)->main.sg_flags & XTABS) != XTABS)
427 #endif /* not DOS_NT */
429 #endif /* not def VMS */
430 #endif /* not def HAVE_TERMIO */
431 #endif /* not def HAVE_TERMIOS */