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