1 /* $NetBSD: read.c,v 1.69 2012/09/11 12:31:08 christos Exp $ */
4 * Copyright (c) 1992, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * Christos Zoulas of Cornell University.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 #if !defined(lint) && !defined(SCCSID)
38 static char sccsid[] = "@(#)read.c 8.1 (Berkeley) 6/4/93";
40 __RCSID("$NetBSD: read.c,v 1.69 2012/09/11 12:31:08 christos Exp $");
42 #endif /* not lint && not SCCSID */
45 * read.c: Clean this junk up! This is horrible code.
46 * Terminal read functions
55 #define OKCMD -1 /* must be -1! */
57 private int read__fixio(int, int);
58 private int read_preread(EditLine *);
59 private int read_char(EditLine *, Char *);
60 private int read_getcmd(EditLine *, el_action_t *, Char *);
61 private void read_pop(c_macro_t *);
64 * Initialize the read stuff
67 read_init(EditLine *el)
69 /* builtin read_char */
70 el->el_read.read_char = read_char;
76 * Set the read char function to the one provided.
77 * If it is set to EL_BUILTIN_GETCFN, then reset to the builtin one.
80 el_read_setfn(EditLine *el, el_rfunc_t rc)
82 el->el_read.read_char = (rc == EL_BUILTIN_GETCFN) ? read_char : rc;
88 * return the current read char function, or EL_BUILTIN_GETCFN
89 * if it is the default one
92 el_read_getfn(EditLine *el)
94 return el->el_read.read_char == read_char ?
95 EL_BUILTIN_GETCFN : el->el_read.read_char;
100 #define MIN(A,B) ((A) < (B) ? (A) : (B))
105 read_debug(EditLine *el)
108 if (el->el_line.cursor > el->el_line.lastchar)
109 (void) fprintf(el->el_errfile, "cursor > lastchar\r\n");
110 if (el->el_line.cursor < el->el_line.buffer)
111 (void) fprintf(el->el_errfile, "cursor < buffer\r\n");
112 if (el->el_line.cursor > el->el_line.limit)
113 (void) fprintf(el->el_errfile, "cursor > limit\r\n");
114 if (el->el_line.lastchar > el->el_line.limit)
115 (void) fprintf(el->el_errfile, "lastchar > limit\r\n");
116 if (el->el_line.limit != &el->el_line.buffer[EL_BUFSIZ - 2])
117 (void) fprintf(el->el_errfile, "limit != &buffer[EL_BUFSIZ-2]\r\n");
119 #endif /* DEBUG_EDIT */
123 * Try to recover from a read error
127 read__fixio(int fd __attribute__((__unused__)), int e)
131 case -1: /* Make sure that the code is reachable */
138 #endif /* EWOULDBLOCK */
140 #if defined(POSIX) && defined(EAGAIN)
141 #if defined(EWOULDBLOCK) && EWOULDBLOCK != EAGAIN
146 #endif /* EWOULDBLOCK && EWOULDBLOCK != EAGAIN */
147 #endif /* POSIX && EAGAIN */
151 #if defined(F_SETFL) && defined(O_NDELAY)
152 if ((e = fcntl(fd, F_GETFL, 0)) == -1)
155 if (fcntl(fd, F_SETFL, e & ~O_NDELAY) == -1)
159 #endif /* F_SETFL && O_NDELAY */
165 if (ioctl(fd, FIONBIO, &zero) == -1)
172 #endif /* TRY_AGAIN */
185 * Try to read the stuff in the input queue;
188 read_preread(EditLine *el)
192 if (el->el_tty.t_mode == ED_IO)
196 /* FIONREAD attempts to buffer up multiple bytes, and to make that work
197 * properly with partial wide/UTF-8 characters would need some careful work. */
199 (void) ioctl(el->el_infd, FIONREAD, &chrs);
203 chrs = read(el->el_infd, buf,
204 (size_t) MIN(chrs, EL_BUFSIZ - 1));
210 #endif /* FIONREAD */
220 FUN(el,push)(EditLine *el, const Char *str)
222 c_macro_t *ma = &el->el_chared.c_macro;
224 if (str != NULL && ma->level + 1 < EL_MAXMACRO) {
226 if ((ma->macro[ma->level] = Strdup(str)) != NULL)
236 * Get next command from the input stream, return OKCMD on success.
237 * Character values > 255 are not looked up in the map, but inserted.
240 read_getcmd(EditLine *el, el_action_t *cmdnum, Char *ch)
247 if ((num = FUN(el,getc)(el, ch)) != 1) {/* if EOF or error */
248 el->el_errno = num == 0 ? 0 : errno;
249 return 0; /* not OKCMD */
254 el->el_state.metanext = 0;
260 if (el->el_state.metanext) {
261 el->el_state.metanext = 0;
269 cmd = el->el_map.current[(unsigned char) *ch];
270 if (cmd == ED_SEQUENCE_LEAD_IN) {
271 keymacro_value_t val;
272 switch (keymacro_get(el, ch, &val)) {
277 FUN(el,push)(el, val.str);
281 /* XXX: In the future to run a user function */
286 EL_ABORT((el->el_errfile, "Bad XK_ type \n"));
290 if (el->el_map.alt == NULL)
291 el->el_map.current = el->el_map.key;
292 } while (cmd == ED_SEQUENCE_LEAD_IN);
299 * Test whether a byte is a leading byte of a UTF-8 sequence.
304 return c < 0x80 || /* single byte char */
305 (c >= 0xc2 && c <= 0xf4); /* start of multibyte sequence */
310 * Read a character from the tty.
313 read_char(EditLine *el, Char *cp)
317 char cbuf[MB_LEN_MAX];
322 el->el_signal->sig_no = 0;
323 while ((num_read = read(el->el_infd, cbuf + cbp, (size_t)1)) == -1) {
325 switch (el->el_signal->sig_no) {
327 FUN(el,set)(el, EL_REFRESH);
335 if (!tried && read__fixio(el->el_infd, e) == 0)
345 if (el->el_flags & CHARSET_IS_UTF8) {
346 if (!utf8_islead((unsigned char)cbuf[0]))
347 goto again; /* discard the byte we read and try again */
349 if ((bytes = ct_mbtowc(cp, cbuf, cbp)) == -1) {
351 if (cbp >= MB_LEN_MAX) { /* "shouldn't happen" */
358 } else if (isascii((unsigned char)cbuf[0]) ||
359 /* we don't support other multibyte charsets */
361 /* Try non-ASCII characters in a 8-bit character set */
362 (bytes = ct_mbtowc(cp, cbuf, cbp)) != 1)
364 *cp = (unsigned char)cbuf[0];
366 if ((el->el_flags & IGNORE_EXTCHARS) && bytes > 1) {
367 cbp = 0; /* skip this character */
371 return (int)num_read;
375 * Pop a macro from the stack
378 read_pop(c_macro_t *ma)
382 el_free(ma->macro[0]);
383 for (i = 0; i < ma->level; i++)
384 ma->macro[i] = ma->macro[i + 1];
393 FUN(el,getc)(EditLine *el, Char *cp)
396 c_macro_t *ma = &el->el_chared.c_macro;
401 if (!read_preread(el))
408 if (ma->macro[0][ma->offset] == '\0') {
413 *cp = ma->macro[0][ma->offset++];
415 if (ma->macro[0][ma->offset] == '\0') {
416 /* Needed for QuoteMode On */
424 (void) fprintf(el->el_errfile, "Turning raw mode on\n");
425 #endif /* DEBUG_READ */
426 if (tty_rawmode(el) < 0)/* make sure the tty is set up correctly */
430 (void) fprintf(el->el_errfile, "Reading a character\n");
431 #endif /* DEBUG_READ */
432 num_read = (*el->el_read.read_char)(el, cp);
434 el->el_errno = errno;
436 if (el->el_flags & NARROW_READ)
437 *cp = *(char *)(void *)cp;
440 (void) fprintf(el->el_errfile, "Got it %c\n", *cp);
441 #endif /* DEBUG_READ */
446 read_prepare(EditLine *el)
448 if (el->el_flags & HANDLE_SIGNALS)
450 if (el->el_flags & NO_TTY)
452 if ((el->el_flags & (UNBUFFERED|EDIT_DISABLED)) == UNBUFFERED)
455 /* This is relatively cheap, and things go terribly wrong if
456 we have the wrong size. */
458 re_clear_display(el); /* reset the display stuff */
460 re_refresh(el); /* print the prompt */
462 if (el->el_flags & UNBUFFERED)
467 read_finish(EditLine *el)
469 if ((el->el_flags & UNBUFFERED) == 0)
470 (void) tty_cookedmode(el);
471 if (el->el_flags & HANDLE_SIGNALS)
476 FUN(el,gets)(EditLine *el, int *nread)
479 el_action_t cmdnum = 0;
480 int num; /* how many chars we have read at NL */
485 c_macro_t *ma = &el->el_chared.c_macro;
486 #endif /* FIONREAD */
492 if (el->el_flags & NO_TTY) {
495 cp = el->el_line.buffer;
496 while ((num = (*el->el_read.read_char)(el, cp)) == 1) {
497 /* make sure there is space for next character */
498 if (cp + 1 >= el->el_line.limit) {
499 idx = (size_t)(cp - el->el_line.buffer);
500 if (!ch_enlargebufs(el, (size_t)2))
502 cp = &el->el_line.buffer[idx];
505 if (el->el_flags & UNBUFFERED)
507 if (cp[-1] == '\r' || cp[-1] == '\n')
512 cp = el->el_line.buffer;
513 el->el_errno = errno;
521 if (el->el_tty.t_mode == EX_IO && ma->level < 0) {
524 (void) ioctl(el->el_infd, FIONREAD, &chrs);
526 if (tty_rawmode(el) < 0) {
533 #endif /* FIONREAD */
535 if ((el->el_flags & UNBUFFERED) == 0)
538 if (el->el_flags & EDIT_DISABLED) {
541 if ((el->el_flags & UNBUFFERED) == 0)
542 cp = el->el_line.buffer;
544 cp = el->el_line.lastchar;
548 while ((num = (*el->el_read.read_char)(el, cp)) == 1) {
549 /* make sure there is space next character */
550 if (cp + 1 >= el->el_line.limit) {
551 idx = (size_t)(cp - el->el_line.buffer);
552 if (!ch_enlargebufs(el, (size_t)2))
554 cp = &el->el_line.buffer[idx];
557 crlf = cp[-1] == '\r' || cp[-1] == '\n';
558 if (el->el_flags & UNBUFFERED)
566 cp = el->el_line.buffer;
567 el->el_errno = errno;
573 for (num = OKCMD; num == OKCMD;) { /* while still editing this
577 #endif /* DEBUG_EDIT */
578 /* if EOF or error */
579 if ((num = read_getcmd(el, &cmdnum, &ch)) != OKCMD) {
582 (void) fprintf(el->el_errfile,
583 "Returning from el_gets %d\n", num);
584 #endif /* DEBUG_READ */
587 if (el->el_errno == EINTR) {
588 el->el_line.buffer[0] = '\0';
589 el->el_line.lastchar =
590 el->el_line.cursor = el->el_line.buffer;
593 if ((unsigned int)cmdnum >= (unsigned int)el->el_map.nfunc) { /* BUG CHECK command */
595 (void) fprintf(el->el_errfile,
596 "ERROR: illegal command from key 0%o\r\n", ch);
597 #endif /* DEBUG_EDIT */
598 continue; /* try again */
600 /* now do the real command */
604 for (b = el->el_map.help; b->name; b++)
605 if (b->func == cmdnum)
608 (void) fprintf(el->el_errfile,
609 "Executing %s\n", b->name);
611 (void) fprintf(el->el_errfile,
612 "Error command = %d\n", cmdnum);
614 #endif /* DEBUG_READ */
615 /* vi redo needs these way down the levels... */
616 el->el_state.thiscmd = cmdnum;
617 el->el_state.thisch = ch;
618 if (el->el_map.type == MAP_VI &&
619 el->el_map.current == el->el_map.key &&
620 el->el_chared.c_redo.pos < el->el_chared.c_redo.lim) {
621 if (cmdnum == VI_DELETE_PREV_CHAR &&
622 el->el_chared.c_redo.pos != el->el_chared.c_redo.buf
623 && Isprint(el->el_chared.c_redo.pos[-1]))
624 el->el_chared.c_redo.pos--;
626 *el->el_chared.c_redo.pos++ = ch;
628 retval = (*el->el_map.func[cmdnum]) (el, ch);
630 (void) fprintf(el->el_errfile,
631 "Returned state %d\n", retval );
632 #endif /* DEBUG_READ */
634 /* save the last command here */
635 el->el_state.lastcmd = cmdnum;
637 /* use any return value */
640 re_refresh_cursor(el);
645 re_clear_display(el);
652 case CC_REFRESH_BEEP:
657 case CC_NORM: /* normal char */
660 case CC_ARGHACK: /* Suggested by Rich Salz */
661 /* <rsalz@pineapple.bbn.com> */
662 continue; /* keep going... */
664 case CC_EOF: /* end of file typed */
665 if ((el->el_flags & UNBUFFERED) == 0)
667 else if (num == -1) {
668 *el->el_line.lastchar++ = CONTROL('d');
669 el->el_line.cursor = el->el_line.lastchar;
674 case CC_NEWLINE: /* normal end of line */
675 num = (int)(el->el_line.lastchar - el->el_line.buffer);
678 case CC_FATAL: /* fatal error, reset to known state */
680 (void) fprintf(el->el_errfile,
681 "*** editor fatal ERROR ***\r\n\n");
682 #endif /* DEBUG_READ */
683 /* put (real) cursor in a known place */
684 re_clear_display(el); /* reset the display stuff */
685 ch_reset(el, 1); /* reset the input pointers */
686 re_refresh(el); /* print the prompt again */
690 default: /* functions we don't know about */
692 (void) fprintf(el->el_errfile,
693 "*** editor ERROR ***\r\n\n");
694 #endif /* DEBUG_READ */
699 el->el_state.argument = 1;
700 el->el_state.doingarg = 0;
701 el->el_chared.c_vcmd.action = NOP;
702 if (el->el_flags & UNBUFFERED)
706 terminal__flush(el); /* flush any buffered output */
707 /* make sure the tty is set up correctly */
708 if ((el->el_flags & UNBUFFERED) == 0) {
710 *nread = num != -1 ? num : 0;
712 *nread = (int)(el->el_line.lastchar - el->el_line.buffer);
716 el->el_line.cursor = el->el_line.lastchar = cp;
718 *nread = (int)(el->el_line.cursor - el->el_line.buffer);
723 errno = el->el_errno;
727 return el->el_line.buffer;