1 /* $NetBSD: terminal.c,v 1.46 2023/02/04 14:34:28 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[] = "@(#)term.c 8.2 (Berkeley) 4/30/95";
40 __RCSID("$NetBSD: terminal.c,v 1.46 2023/02/04 14:34:28 christos Exp $");
42 #endif /* not lint && not SCCSID */
45 * terminal.c: Editor/termcap-curses interface
46 * We have to declare a static variable here, since the
47 * termcap putchar routine does not take an argument!
49 #include <sys/types.h>
50 #include <sys/ioctl.h>
66 /* Solaris's term.h does horrid things. */
67 #if defined(HAVE_TERM_H) && !defined(__sun) && !defined(HAVE_TERMCAP_H)
72 extern int tgetent(char *, const char *);
73 extern int tgetflag(char *);
74 extern int tgetnum(char *);
75 extern int tputs(const char *, int, int (*)(int));
76 extern char* tgoto(const char*, int, int);
77 extern char* tgetstr(char*, char**);
88 * IMPORTANT NOTE: these routines are allowed to look at the current screen
89 * and the current position assuming that it is correct. If this is not
90 * true, then the update will be WRONG! This is (should be) a valid
94 #define TC_BUFSIZE ((size_t)2048)
96 #define GoodStr(a) (el->el_terminal.t_str[a] != NULL && \
97 el->el_terminal.t_str[a][0] != '\0')
98 #define Str(a) el->el_terminal.t_str[a]
99 #define Val(a) el->el_terminal.t_val[a]
101 static const struct termcapstr {
103 const char *long_name;
106 { "al", "add new blank line" },
108 { "bl", "audible bell" },
110 { "cd", "clear to bottom" },
112 { "ce", "clear to end of line" },
114 { "ch", "cursor to horiz pos" },
116 { "cl", "clear screen" },
118 { "dc", "delete a character" },
120 { "dl", "delete a line" },
122 { "dm", "start delete mode" },
124 { "ed", "end delete mode" },
126 { "ei", "end insert mode" },
128 { "fs", "cursor from status line" },
130 { "ho", "home cursor" },
132 { "ic", "insert character" },
134 { "im", "start insert mode" },
136 { "ip", "insert padding" },
138 { "kd", "sends cursor down" },
140 { "kl", "sends cursor left" },
142 { "kr", "sends cursor right" },
144 { "ku", "sends cursor up" },
146 { "md", "begin bold" },
148 { "me", "end attributes" },
150 { "nd", "non destructive space" },
152 { "se", "end standout" },
154 { "so", "begin standout" },
156 { "ts", "cursor to status line" },
158 { "up", "cursor up one" },
160 { "us", "begin underline" },
162 { "ue", "end underline" },
164 { "vb", "visible bell" },
166 { "DC", "delete multiple chars" },
168 { "DO", "cursor down multiple" },
170 { "IC", "insert multiple chars" },
172 { "LE", "cursor left multiple" },
174 { "RI", "cursor right multiple" },
176 { "UP", "cursor up multiple" },
178 { "kh", "send cursor home" },
180 { "@7", "send cursor end" },
182 { "kD", "send cursor delete" },
187 static const struct termcapval {
189 const char *long_name;
192 { "am", "has automatic margins" },
194 { "pt", "has physical tabs" },
196 { "li", "Number of lines" },
198 { "co", "Number of columns" },
200 { "km", "Has meta key" },
202 { "xt", "Tab chars destructive" },
204 { "xn", "newline ignored at right margin" },
206 { "MT", "Has meta key" }, /* XXX? */
210 /* do two or more of the attributes use me */
212 static void terminal_setflags(EditLine *);
213 static int terminal_rebuffer_display(EditLine *);
214 static void terminal_free_display(EditLine *);
215 static int terminal_alloc_display(EditLine *);
216 static void terminal_alloc(EditLine *, const struct termcapstr *,
218 static void terminal_init_arrow(EditLine *);
219 static void terminal_reset_arrow(EditLine *);
220 static int terminal_putc(int);
221 static void terminal_tputs(EditLine *, const char *, int);
224 static pthread_mutex_t terminal_mutex = PTHREAD_MUTEX_INITIALIZER;
226 static FILE *terminal_outfile = NULL;
229 /* terminal_setflags():
230 * Set the terminal capability flags
233 terminal_setflags(EditLine *el)
236 if (el->el_tty.t_tabs)
237 EL_FLAGS |= (Val(T_pt) && !Val(T_xt)) ? TERM_CAN_TAB : 0;
239 EL_FLAGS |= (Val(T_km) || Val(T_MT)) ? TERM_HAS_META : 0;
240 EL_FLAGS |= GoodStr(T_ce) ? TERM_CAN_CEOL : 0;
241 EL_FLAGS |= (GoodStr(T_dc) || GoodStr(T_DC)) ? TERM_CAN_DELETE : 0;
242 EL_FLAGS |= (GoodStr(T_im) || GoodStr(T_ic) || GoodStr(T_IC)) ?
244 EL_FLAGS |= (GoodStr(T_up) || GoodStr(T_UP)) ? TERM_CAN_UP : 0;
245 EL_FLAGS |= Val(T_am) ? TERM_HAS_AUTO_MARGINS : 0;
246 EL_FLAGS |= Val(T_xn) ? TERM_HAS_MAGIC_MARGINS : 0;
248 if (GoodStr(T_me) && GoodStr(T_ue))
249 EL_FLAGS |= (strcmp(Str(T_me), Str(T_ue)) == 0) ?
252 EL_FLAGS &= ~TERM_CAN_ME;
253 if (GoodStr(T_me) && GoodStr(T_se))
254 EL_FLAGS |= (strcmp(Str(T_me), Str(T_se)) == 0) ?
260 (void) fprintf(el->el_errfile,
261 "WARNING: Your terminal cannot move up.\n");
262 (void) fprintf(el->el_errfile,
263 "Editing may be odd for long lines.\n");
266 (void) fprintf(el->el_errfile, "no clear EOL capability.\n");
268 (void) fprintf(el->el_errfile, "no delete char capability.\n");
270 (void) fprintf(el->el_errfile, "no insert char capability.\n");
271 #endif /* DEBUG_SCREEN */
275 * Initialize the terminal stuff
278 terminal_init(EditLine *el)
281 el->el_terminal.t_buf = el_calloc(TC_BUFSIZE,
282 sizeof(*el->el_terminal.t_buf));
283 if (el->el_terminal.t_buf == NULL)
285 el->el_terminal.t_cap = el_calloc(TC_BUFSIZE,
286 sizeof(*el->el_terminal.t_cap));
287 if (el->el_terminal.t_cap == NULL)
289 el->el_terminal.t_fkey = el_calloc(A_K_NKEYS,
290 sizeof(*el->el_terminal.t_fkey));
291 if (el->el_terminal.t_fkey == NULL)
293 el->el_terminal.t_loc = 0;
294 el->el_terminal.t_str = el_calloc(T_str,
295 sizeof(*el->el_terminal.t_str));
296 if (el->el_terminal.t_str == NULL)
298 el->el_terminal.t_val = el_calloc(T_val,
299 sizeof(*el->el_terminal.t_val));
300 if (el->el_terminal.t_val == NULL)
302 (void) terminal_set(el, NULL);
303 terminal_init_arrow(el);
311 * Clean up the terminal stuff
314 terminal_end(EditLine *el)
317 el_free(el->el_terminal.t_buf);
318 el->el_terminal.t_buf = NULL;
319 el_free(el->el_terminal.t_cap);
320 el->el_terminal.t_cap = NULL;
321 el->el_terminal.t_loc = 0;
322 el_free(el->el_terminal.t_str);
323 el->el_terminal.t_str = NULL;
324 el_free(el->el_terminal.t_val);
325 el->el_terminal.t_val = NULL;
326 el_free(el->el_terminal.t_fkey);
327 el->el_terminal.t_fkey = NULL;
328 terminal_free_display(el);
333 * Maintain a string pool for termcap strings
336 terminal_alloc(EditLine *el, const struct termcapstr *t, const char *cap)
338 char termbuf[TC_BUFSIZE];
340 char **tlist = el->el_terminal.t_str;
341 char **tmp, **str = &tlist[t - tstr];
343 (void) memset(termbuf, 0, sizeof(termbuf));
344 if (cap == NULL || *cap == '\0') {
350 tlen = *str == NULL ? 0 : strlen(*str);
353 * New string is shorter; no need to allocate space
357 (void) strcpy(*str, cap); /* XXX strcpy is safe */
361 * New string is longer; see if we have enough space to append
363 if (el->el_terminal.t_loc + 3 < TC_BUFSIZE) {
364 /* XXX strcpy is safe */
365 (void) strcpy(*str = &el->el_terminal.t_buf[
366 el->el_terminal.t_loc], cap);
367 el->el_terminal.t_loc += clen + 1; /* one for \0 */
371 * Compact our buffer; no need to check compaction, cause we know it
375 for (tmp = tlist; tmp < &tlist[T_str]; tmp++)
376 if (*tmp != NULL && **tmp != '\0' && *tmp != *str) {
379 for (ptr = *tmp; *ptr != '\0'; termbuf[tlen++] = *ptr++)
381 termbuf[tlen++] = '\0';
383 memcpy(el->el_terminal.t_buf, termbuf, TC_BUFSIZE);
384 el->el_terminal.t_loc = tlen;
385 if (el->el_terminal.t_loc + 3 >= TC_BUFSIZE) {
386 (void) fprintf(el->el_errfile,
387 "Out of termcap string space.\n");
390 /* XXX strcpy is safe */
391 (void) strcpy(*str = &el->el_terminal.t_buf[el->el_terminal.t_loc],
393 el->el_terminal.t_loc += (size_t)clen + 1; /* one for \0 */
398 /* terminal_rebuffer_display():
399 * Rebuffer the display after the screen changed size
402 terminal_rebuffer_display(EditLine *el)
404 coord_t *c = &el->el_terminal.t_size;
406 terminal_free_display(el);
411 if (terminal_alloc_display(el) == -1)
417 terminal_alloc_buffer(EditLine *el)
420 coord_t *c = &el->el_terminal.t_size;
423 b = el_calloc((size_t)(c->v + 1), sizeof(*b));
426 for (i = 0; i < c->v; i++) {
427 b[i] = el_calloc((size_t)(c->h + 1), sizeof(**b));
440 terminal_free_buffer(wint_t ***bp)
451 for (bufp = b; *bufp != NULL; bufp++)
456 /* terminal_alloc_display():
457 * Allocate a new display.
460 terminal_alloc_display(EditLine *el)
462 el->el_display = terminal_alloc_buffer(el);
463 if (el->el_display == NULL)
465 el->el_vdisplay = terminal_alloc_buffer(el);
466 if (el->el_vdisplay == NULL)
470 terminal_free_display(el);
475 /* terminal_free_display():
476 * Free the display buffers
479 terminal_free_display(EditLine *el)
481 terminal_free_buffer(&el->el_display);
482 terminal_free_buffer(&el->el_vdisplay);
486 /* terminal_move_to_line():
487 * move to line <where> (first line == 0)
488 * as efficiently as possible
491 terminal_move_to_line(EditLine *el, int where)
495 if (where == el->el_cursor.v)
498 if (where >= el->el_terminal.t_size.v) {
500 (void) fprintf(el->el_errfile,
501 "%s: where is ridiculous: %d\r\n", __func__, where);
502 #endif /* DEBUG_SCREEN */
505 if ((del = where - el->el_cursor.v) > 0) {
507 * We don't use DO here because some terminals are buggy
508 * if the destination is beyond bottom of the screen.
510 for (; del > 0; del--)
511 terminal__putc(el, '\n');
512 /* because the \n will become \r\n */
514 } else { /* del < 0 */
515 if (GoodStr(T_UP) && (-del > 1 || !GoodStr(T_up)))
516 terminal_tputs(el, tgoto(Str(T_UP), -del, -del), -del);
519 for (; del < 0; del++)
520 terminal_tputs(el, Str(T_up), 1);
523 el->el_cursor.v = where;/* now where is here */
527 /* terminal_move_to_char():
528 * Move to the character position specified
531 terminal_move_to_char(EditLine *el, int where)
536 if (where == el->el_cursor.h)
539 if (where > el->el_terminal.t_size.h) {
541 (void) fprintf(el->el_errfile,
542 "%s: where is ridiculous: %d\r\n", __func__, where);
543 #endif /* DEBUG_SCREEN */
546 if (!where) { /* if where is first column */
547 terminal__putc(el, '\r'); /* do a CR */
551 del = where - el->el_cursor.h;
553 if ((del < -4 || del > 4) && GoodStr(T_ch))
554 /* go there directly */
555 terminal_tputs(el, tgoto(Str(T_ch), where, where), where);
557 if (del > 0) { /* moving forward */
558 if ((del > 4) && GoodStr(T_RI))
559 terminal_tputs(el, tgoto(Str(T_RI), del, del),
562 /* if I can do tabs, use them */
564 if ((el->el_cursor.h & 0370) !=
567 el->el_cursor.v][where & 0370] !=
570 /* if not within tab stop */
572 (el->el_cursor.h & 0370);
578 el->el_cursor.h = where & ~0x7;
582 * it's usually cheaper to just write the
586 * NOTE THAT terminal_overwrite() WILL CHANGE
589 terminal_overwrite(el,
590 (wchar_t *)&el->el_display[
591 el->el_cursor.v][el->el_cursor.h],
592 (size_t)(where - el->el_cursor.h));
595 } else { /* del < 0 := moving backward */
596 if ((-del > 4) && GoodStr(T_LE))
597 terminal_tputs(el, tgoto(Str(T_LE), -del, -del),
599 else { /* can't go directly there */
601 * if the "cost" is greater than the "cost"
605 ((unsigned int)-del >
606 (((unsigned int) where >> 3) +
609 terminal__putc(el, '\r');/* do a CR */
611 goto mc_again; /* and try again */
613 for (i = 0; i < -del; i++)
614 terminal__putc(el, '\b');
618 el->el_cursor.h = where; /* now where is here */
622 /* terminal_overwrite():
623 * Overstrike num characters
624 * Assumes MB_FILL_CHARs are present to keep the column count correct
627 terminal_overwrite(EditLine *el, const wchar_t *cp, size_t n)
632 if (n > (size_t)el->el_terminal.t_size.h) {
634 (void) fprintf(el->el_errfile,
635 "%s: n is ridiculous: %zu\r\n", __func__, n);
636 #endif /* DEBUG_SCREEN */
641 /* terminal__putc() ignores any MB_FILL_CHARs */
642 terminal__putc(el, *cp++);
646 if (el->el_cursor.h >= el->el_terminal.t_size.h) { /* wrap? */
647 if (EL_HAS_AUTO_MARGINS) { /* yes */
649 if (el->el_cursor.v + 1 < el->el_terminal.t_size.v)
651 if (EL_HAS_MAGIC_MARGINS) {
652 /* force the wrap to avoid the "magic"
655 if ((c = el->el_display[el->el_cursor.v]
656 [el->el_cursor.h]) != '\0') {
657 terminal_overwrite(el, &c, (size_t)1);
658 while (el->el_display[el->el_cursor.v]
659 [el->el_cursor.h] == MB_FILL_CHAR)
662 terminal__putc(el, ' ');
666 } else /* no wrap, but cursor stays on screen */
667 el->el_cursor.h = el->el_terminal.t_size.h - 1;
672 /* terminal_deletechars():
673 * Delete num characters
676 terminal_deletechars(EditLine *el, int num)
681 if (!EL_CAN_DELETE) {
683 (void) fprintf(el->el_errfile, " ERROR: cannot delete \n");
684 #endif /* DEBUG_EDIT */
687 if (num > el->el_terminal.t_size.h) {
689 (void) fprintf(el->el_errfile,
690 "%s: num is ridiculous: %d\r\n", __func__, num);
691 #endif /* DEBUG_SCREEN */
694 if (GoodStr(T_DC)) /* if I have multiple delete */
695 if ((num > 1) || !GoodStr(T_dc)) { /* if dc would be more
697 terminal_tputs(el, tgoto(Str(T_DC), num, num), num);
700 if (GoodStr(T_dm)) /* if I have delete mode */
701 terminal_tputs(el, Str(T_dm), 1);
703 if (GoodStr(T_dc)) /* else do one at a time */
705 terminal_tputs(el, Str(T_dc), 1);
707 if (GoodStr(T_ed)) /* if I have delete mode */
708 terminal_tputs(el, Str(T_ed), 1);
712 /* terminal_insertwrite():
713 * Puts terminal in insert character mode or inserts num
714 * characters in the line
715 * Assumes MB_FILL_CHARs are present to keep column count correct
718 terminal_insertwrite(EditLine *el, wchar_t *cp, int num)
722 if (!EL_CAN_INSERT) {
724 (void) fprintf(el->el_errfile, " ERROR: cannot insert \n");
725 #endif /* DEBUG_EDIT */
728 if (num > el->el_terminal.t_size.h) {
730 (void) fprintf(el->el_errfile,
731 "%s: num is ridiculous: %d\r\n", __func__, num);
732 #endif /* DEBUG_SCREEN */
735 if (GoodStr(T_IC)) /* if I have multiple insert */
736 if ((num > 1) || !GoodStr(T_ic)) {
737 /* if ic would be more expensive */
738 terminal_tputs(el, tgoto(Str(T_IC), num, num), num);
739 terminal_overwrite(el, cp, (size_t)num);
740 /* this updates el_cursor.h */
743 if (GoodStr(T_im) && GoodStr(T_ei)) { /* if I have insert mode */
744 terminal_tputs(el, Str(T_im), 1);
746 el->el_cursor.h += num;
748 terminal__putc(el, *cp++);
751 if (GoodStr(T_ip)) /* have to make num chars insert */
752 terminal_tputs(el, Str(T_ip), 1);
754 terminal_tputs(el, Str(T_ei), 1);
758 if (GoodStr(T_ic)) /* have to make num chars insert */
759 terminal_tputs(el, Str(T_ic), 1);
761 terminal__putc(el, *cp++);
765 if (GoodStr(T_ip)) /* have to make num chars insert */
766 terminal_tputs(el, Str(T_ip), 1);
767 /* pad the inserted char */
773 /* terminal_clear_EOL():
774 * clear to end of line. There are num characters to clear
777 terminal_clear_EOL(EditLine *el, int num)
781 if (EL_CAN_CEOL && GoodStr(T_ce))
782 terminal_tputs(el, Str(T_ce), 1);
784 for (i = 0; i < num; i++)
785 terminal__putc(el, ' ');
786 el->el_cursor.h += num; /* have written num spaces */
791 /* terminal_clear_screen():
795 terminal_clear_screen(EditLine *el)
796 { /* clear the whole screen and home */
799 /* send the clear screen code */
800 terminal_tputs(el, Str(T_cl), Val(T_li));
801 else if (GoodStr(T_ho) && GoodStr(T_cd)) {
802 terminal_tputs(el, Str(T_ho), Val(T_li)); /* home */
803 /* clear to bottom of screen */
804 terminal_tputs(el, Str(T_cd), Val(T_li));
806 terminal__putc(el, '\r');
807 terminal__putc(el, '\n');
813 * Beep the way the terminal wants us
816 terminal_beep(EditLine *el)
819 /* what termcap says we should use */
820 terminal_tputs(el, Str(T_bl), 1);
822 terminal__putc(el, '\007'); /* an ASCII bell; ^G */
827 terminal_get(EditLine *el, const char **term)
829 *term = el->el_terminal.t_name;
834 * Read in the terminal capabilities from the requested terminal
837 terminal_set(EditLine *el, const char *term)
840 char buf[TC_BUFSIZE];
842 const struct termcapstr *t;
846 (void) sigemptyset(&nset);
847 (void) sigaddset(&nset, SIGWINCH);
848 (void) sigprocmask(SIG_BLOCK, &nset, &oset);
854 term = getenv("TERM");
856 if (!term || !term[0])
859 if (strcmp(term, "emacs") == 0)
860 el->el_flags |= EDIT_DISABLED;
862 (void) memset(el->el_terminal.t_cap, 0, TC_BUFSIZE);
864 i = tgetent(el->el_terminal.t_cap, term);
868 (void) fprintf(el->el_errfile,
869 "Cannot read termcap database;\n");
871 (void) fprintf(el->el_errfile,
872 "No entry for terminal type \"%s\";\n", term);
873 (void) fprintf(el->el_errfile,
874 "using dumb terminal settings.\n");
875 Val(T_co) = 80; /* do a dumb terminal */
876 Val(T_pt) = Val(T_km) = Val(T_li) = 0;
877 Val(T_xt) = Val(T_MT);
878 for (t = tstr; t->name != NULL; t++)
879 terminal_alloc(el, t, NULL);
881 /* auto/magic margins */
882 Val(T_am) = tgetflag("am");
883 Val(T_xn) = tgetflag("xn");
885 Val(T_pt) = tgetflag("pt");
886 Val(T_xt) = tgetflag("xt");
887 /* do we have a meta? */
888 Val(T_km) = tgetflag("km");
889 Val(T_MT) = tgetflag("MT");
891 Val(T_co) = tgetnum("co");
892 Val(T_li) = tgetnum("li");
893 for (t = tstr; t->name != NULL; t++) {
894 /* XXX: some systems' tgetstr needs non const */
895 terminal_alloc(el, t, tgetstr(strchr(t->name, *t->name),
901 Val(T_co) = 80; /* just in case */
905 el->el_terminal.t_size.v = Val(T_co);
906 el->el_terminal.t_size.h = Val(T_li);
908 terminal_setflags(el);
910 /* get the correct window size */
911 (void) terminal_get_size(el, &lins, &cols);
912 if (terminal_change_size(el, lins, cols) == -1)
914 (void) sigprocmask(SIG_SETMASK, &oset, NULL);
915 terminal_bind_arrow(el);
916 el->el_terminal.t_name = term;
917 return i <= 0 ? -1 : 0;
921 /* terminal_get_size():
922 * Return the new window size in lines and cols, and
923 * true if the size was changed.
926 terminal_get_size(EditLine *el, int *lins, int *cols)
935 if (ioctl(el->el_infd, TIOCGWINSZ, &ws) != -1) {
946 if (ioctl(el->el_infd, TIOCGSIZE, &ts) != -1) {
954 return Val(T_co) != *cols || Val(T_li) != *lins;
958 /* terminal_change_size():
959 * Change the size of the terminal
962 terminal_change_size(EditLine *el, int lins, int cols)
964 coord_t cur = el->el_cursor;
968 Val(T_co) = (cols < 2) ? 80 : cols;
969 Val(T_li) = (lins < 1) ? 24 : lins;
971 /* re-make display buffers */
972 if (terminal_rebuffer_display(el) == -1)
974 re_clear_display(el);
980 /* terminal_init_arrow():
981 * Initialize the arrow key bindings from termcap
984 terminal_init_arrow(EditLine *el)
986 funckey_t *arrow = el->el_terminal.t_fkey;
988 arrow[A_K_DN].name = L"down";
989 arrow[A_K_DN].key = T_kd;
990 arrow[A_K_DN].fun.cmd = ED_NEXT_HISTORY;
991 arrow[A_K_DN].type = XK_CMD;
993 arrow[A_K_UP].name = L"up";
994 arrow[A_K_UP].key = T_ku;
995 arrow[A_K_UP].fun.cmd = ED_PREV_HISTORY;
996 arrow[A_K_UP].type = XK_CMD;
998 arrow[A_K_LT].name = L"left";
999 arrow[A_K_LT].key = T_kl;
1000 arrow[A_K_LT].fun.cmd = ED_PREV_CHAR;
1001 arrow[A_K_LT].type = XK_CMD;
1003 arrow[A_K_RT].name = L"right";
1004 arrow[A_K_RT].key = T_kr;
1005 arrow[A_K_RT].fun.cmd = ED_NEXT_CHAR;
1006 arrow[A_K_RT].type = XK_CMD;
1008 arrow[A_K_HO].name = L"home";
1009 arrow[A_K_HO].key = T_kh;
1010 arrow[A_K_HO].fun.cmd = ED_MOVE_TO_BEG;
1011 arrow[A_K_HO].type = XK_CMD;
1013 arrow[A_K_EN].name = L"end";
1014 arrow[A_K_EN].key = T_at7;
1015 arrow[A_K_EN].fun.cmd = ED_MOVE_TO_END;
1016 arrow[A_K_EN].type = XK_CMD;
1018 arrow[A_K_DE].name = L"delete";
1019 arrow[A_K_DE].key = T_kD;
1020 arrow[A_K_DE].fun.cmd = ED_DELETE_NEXT_CHAR;
1021 arrow[A_K_DE].type = XK_CMD;
1025 /* terminal_reset_arrow():
1026 * Reset arrow key bindings
1029 terminal_reset_arrow(EditLine *el)
1031 funckey_t *arrow = el->el_terminal.t_fkey;
1032 static const wchar_t strA[] = L"\033[A";
1033 static const wchar_t strB[] = L"\033[B";
1034 static const wchar_t strC[] = L"\033[C";
1035 static const wchar_t strD[] = L"\033[D";
1036 static const wchar_t strH[] = L"\033[H";
1037 static const wchar_t strF[] = L"\033[F";
1038 static const wchar_t stOA[] = L"\033OA";
1039 static const wchar_t stOB[] = L"\033OB";
1040 static const wchar_t stOC[] = L"\033OC";
1041 static const wchar_t stOD[] = L"\033OD";
1042 static const wchar_t stOH[] = L"\033OH";
1043 static const wchar_t stOF[] = L"\033OF";
1045 keymacro_add(el, strA, &arrow[A_K_UP].fun, arrow[A_K_UP].type);
1046 keymacro_add(el, strB, &arrow[A_K_DN].fun, arrow[A_K_DN].type);
1047 keymacro_add(el, strC, &arrow[A_K_RT].fun, arrow[A_K_RT].type);
1048 keymacro_add(el, strD, &arrow[A_K_LT].fun, arrow[A_K_LT].type);
1049 keymacro_add(el, strH, &arrow[A_K_HO].fun, arrow[A_K_HO].type);
1050 keymacro_add(el, strF, &arrow[A_K_EN].fun, arrow[A_K_EN].type);
1051 keymacro_add(el, stOA, &arrow[A_K_UP].fun, arrow[A_K_UP].type);
1052 keymacro_add(el, stOB, &arrow[A_K_DN].fun, arrow[A_K_DN].type);
1053 keymacro_add(el, stOC, &arrow[A_K_RT].fun, arrow[A_K_RT].type);
1054 keymacro_add(el, stOD, &arrow[A_K_LT].fun, arrow[A_K_LT].type);
1055 keymacro_add(el, stOH, &arrow[A_K_HO].fun, arrow[A_K_HO].type);
1056 keymacro_add(el, stOF, &arrow[A_K_EN].fun, arrow[A_K_EN].type);
1058 if (el->el_map.type != MAP_VI)
1060 keymacro_add(el, &strA[1], &arrow[A_K_UP].fun, arrow[A_K_UP].type);
1061 keymacro_add(el, &strB[1], &arrow[A_K_DN].fun, arrow[A_K_DN].type);
1062 keymacro_add(el, &strC[1], &arrow[A_K_RT].fun, arrow[A_K_RT].type);
1063 keymacro_add(el, &strD[1], &arrow[A_K_LT].fun, arrow[A_K_LT].type);
1064 keymacro_add(el, &strH[1], &arrow[A_K_HO].fun, arrow[A_K_HO].type);
1065 keymacro_add(el, &strF[1], &arrow[A_K_EN].fun, arrow[A_K_EN].type);
1066 keymacro_add(el, &stOA[1], &arrow[A_K_UP].fun, arrow[A_K_UP].type);
1067 keymacro_add(el, &stOB[1], &arrow[A_K_DN].fun, arrow[A_K_DN].type);
1068 keymacro_add(el, &stOC[1], &arrow[A_K_RT].fun, arrow[A_K_RT].type);
1069 keymacro_add(el, &stOD[1], &arrow[A_K_LT].fun, arrow[A_K_LT].type);
1070 keymacro_add(el, &stOH[1], &arrow[A_K_HO].fun, arrow[A_K_HO].type);
1071 keymacro_add(el, &stOF[1], &arrow[A_K_EN].fun, arrow[A_K_EN].type);
1075 /* terminal_set_arrow():
1076 * Set an arrow key binding
1079 terminal_set_arrow(EditLine *el, const wchar_t *name, keymacro_value_t *fun,
1082 funckey_t *arrow = el->el_terminal.t_fkey;
1085 for (i = 0; i < A_K_NKEYS; i++)
1086 if (wcscmp(name, arrow[i].name) == 0) {
1087 arrow[i].fun = *fun;
1088 arrow[i].type = type;
1095 /* terminal_clear_arrow():
1096 * Clear an arrow key binding
1099 terminal_clear_arrow(EditLine *el, const wchar_t *name)
1101 funckey_t *arrow = el->el_terminal.t_fkey;
1104 for (i = 0; i < A_K_NKEYS; i++)
1105 if (wcscmp(name, arrow[i].name) == 0) {
1106 arrow[i].type = XK_NOD;
1113 /* terminal_print_arrow():
1114 * Print the arrow key bindings
1116 libedit_private void
1117 terminal_print_arrow(EditLine *el, const wchar_t *name)
1120 funckey_t *arrow = el->el_terminal.t_fkey;
1122 for (i = 0; i < A_K_NKEYS; i++)
1123 if (*name == '\0' || wcscmp(name, arrow[i].name) == 0)
1124 if (arrow[i].type != XK_NOD)
1125 keymacro_kprint(el, arrow[i].name,
1126 &arrow[i].fun, arrow[i].type);
1130 /* terminal_bind_arrow():
1131 * Bind the arrow keys
1133 libedit_private void
1134 terminal_bind_arrow(EditLine *el)
1137 const el_action_t *dmap;
1140 funckey_t *arrow = el->el_terminal.t_fkey;
1142 /* Check if the components needed are initialized */
1143 if (el->el_terminal.t_buf == NULL || el->el_map.key == NULL)
1146 map = el->el_map.type == MAP_VI ? el->el_map.alt : el->el_map.key;
1147 dmap = el->el_map.type == MAP_VI ? el->el_map.vic : el->el_map.emacs;
1149 terminal_reset_arrow(el);
1151 for (i = 0; i < A_K_NKEYS; i++) {
1152 wchar_t wt_str[VISUAL_WIDTH_MAX];
1156 p = el->el_terminal.t_str[arrow[i].key];
1159 for (n = 0; n < VISUAL_WIDTH_MAX && p[n]; ++n)
1161 while (n < VISUAL_WIDTH_MAX)
1164 j = (unsigned char) *p;
1166 * Assign the arrow keys only if:
1168 * 1. They are multi-character arrow keys and the user
1169 * has not re-assigned the leading character, or
1170 * has re-assigned the leading character to be
1171 * ED_SEQUENCE_LEAD_IN
1172 * 2. They are single arrow keys pointing to an
1175 if (arrow[i].type == XK_NOD)
1176 keymacro_clear(el, map, px);
1178 if (p[1] && (dmap[j] == map[j] ||
1179 map[j] == ED_SEQUENCE_LEAD_IN)) {
1180 keymacro_add(el, px, &arrow[i].fun,
1182 map[j] = ED_SEQUENCE_LEAD_IN;
1183 } else if (map[j] == ED_UNASSIGNED) {
1184 keymacro_clear(el, map, px);
1185 if (arrow[i].type == XK_CMD)
1186 map[j] = arrow[i].fun.cmd;
1188 keymacro_add(el, px, &arrow[i].fun,
1199 terminal_putc(int c)
1201 if (terminal_outfile == NULL)
1203 return fputc(c, terminal_outfile);
1207 terminal_tputs(EditLine *el, const char *cap, int affcnt)
1210 pthread_mutex_lock(&terminal_mutex);
1212 terminal_outfile = el->el_outfile;
1213 (void)tputs(cap, affcnt, terminal_putc);
1215 pthread_mutex_unlock(&terminal_mutex);
1219 /* terminal__putc():
1223 terminal__putc(EditLine *el, wint_t c)
1225 char buf[MB_LEN_MAX +1];
1227 if (c == MB_FILL_CHAR)
1230 return fputs(literal_get(el, c), el->el_outfile);
1231 i = ct_encode_char(buf, (size_t)MB_LEN_MAX, c);
1235 return fputs(buf, el->el_outfile);
1238 /* terminal__flush():
1241 libedit_private void
1242 terminal__flush(EditLine *el)
1245 (void) fflush(el->el_outfile);
1248 /* terminal_writec():
1249 * Write the given character out, in a human readable form
1251 libedit_private void
1252 terminal_writec(EditLine *el, wint_t c)
1254 wchar_t visbuf[VISUAL_WIDTH_MAX +1];
1255 ssize_t vcnt = ct_visual_char(visbuf, VISUAL_WIDTH_MAX, c);
1258 visbuf[vcnt] = '\0';
1259 terminal_overwrite(el, visbuf, (size_t)vcnt);
1260 terminal__flush(el);
1264 /* terminal_telltc():
1265 * Print the current termcap characteristics
1269 terminal_telltc(EditLine *el, int argc __attribute__((__unused__)),
1270 const wchar_t **argv __attribute__((__unused__)))
1272 const struct termcapstr *t;
1275 (void) fprintf(el->el_outfile, "\n\tYour terminal has the\n");
1276 (void) fprintf(el->el_outfile, "\tfollowing characteristics:\n\n");
1277 (void) fprintf(el->el_outfile, "\tIt has %d columns and %d lines\n",
1278 Val(T_co), Val(T_li));
1279 (void) fprintf(el->el_outfile,
1280 "\tIt has %s meta key\n", EL_HAS_META ? "a" : "no");
1281 (void) fprintf(el->el_outfile,
1282 "\tIt can%suse tabs\n", EL_CAN_TAB ? " " : "not ");
1283 (void) fprintf(el->el_outfile, "\tIt %s automatic margins\n",
1284 EL_HAS_AUTO_MARGINS ? "has" : "does not have");
1285 if (EL_HAS_AUTO_MARGINS)
1286 (void) fprintf(el->el_outfile, "\tIt %s magic margins\n",
1287 EL_HAS_MAGIC_MARGINS ? "has" : "does not have");
1289 for (t = tstr, ts = el->el_terminal.t_str; t->name != NULL; t++, ts++) {
1292 ub = ct_encode_string(ct_visual_string(
1293 ct_decode_string(*ts, &el->el_scratch),
1294 &el->el_visual), &el->el_scratch);
1298 (void) fprintf(el->el_outfile, "\t%25s (%s) == %s\n",
1299 t->long_name, t->name, ub);
1301 (void) fputc('\n', el->el_outfile);
1306 /* terminal_settc():
1307 * Change the current terminal characteristics
1311 terminal_settc(EditLine *el, int argc __attribute__((__unused__)),
1312 const wchar_t **argv)
1314 const struct termcapstr *ts;
1315 const struct termcapval *tv;
1316 char what[8], how[8];
1320 if (argv == NULL || argv[1] == NULL || argv[2] == NULL)
1323 strlcpy(what, ct_encode_string(argv[1], &el->el_scratch), sizeof(what));
1324 strlcpy(how, ct_encode_string(argv[2], &el->el_scratch), sizeof(how));
1327 * Do the strings first
1329 for (ts = tstr; ts->name != NULL; ts++)
1330 if (strcmp(ts->name, what) == 0)
1333 if (ts->name != NULL) {
1334 terminal_alloc(el, ts, how);
1335 terminal_setflags(el);
1339 * Do the numeric ones second
1341 for (tv = tval; tv->name != NULL; tv++)
1342 if (strcmp(tv->name, what) == 0)
1345 if (tv->name == NULL) {
1346 (void) fprintf(el->el_errfile,
1347 "%ls: Bad capability `%s'.\n", argv[0], what);
1351 if (tv == &tval[T_pt] || tv == &tval[T_km] ||
1352 tv == &tval[T_am] || tv == &tval[T_xn]) {
1356 if (strcmp(how, "yes") == 0)
1357 el->el_terminal.t_val[tv - tval] = 1;
1358 else if (strcmp(how, "no") == 0)
1359 el->el_terminal.t_val[tv - tval] = 0;
1361 (void) fprintf(el->el_errfile,
1362 "%ls: Bad value `%s'.\n", argv[0], how);
1365 terminal_setflags(el);
1372 i = strtol(how, &ep, 10);
1374 (void) fprintf(el->el_errfile,
1375 "%ls: Bad value `%s'.\n", argv[0], how);
1378 el->el_terminal.t_val[tv - tval] = (int) i;
1380 if (tv == &tval[T_co]) {
1381 el->el_terminal.t_size.v = Val(T_co);
1383 } else if (tv == &tval[T_li]) {
1384 el->el_terminal.t_size.h = Val(T_li);
1387 if (i && terminal_change_size(el, Val(T_li), Val(T_co)) == -1)
1393 /* terminal_gettc():
1394 * Get the current terminal characteristics
1398 terminal_gettc(EditLine *el, int argc __attribute__((__unused__)), char **argv)
1400 const struct termcapstr *ts;
1401 const struct termcapval *tv;
1405 if (argv == NULL || argv[1] == NULL || argv[2] == NULL)
1412 * Do the strings first
1414 for (ts = tstr; ts->name != NULL; ts++)
1415 if (strcmp(ts->name, what) == 0)
1418 if (ts->name != NULL) {
1419 *(char **)how = el->el_terminal.t_str[ts - tstr];
1423 * Do the numeric ones second
1425 for (tv = tval; tv->name != NULL; tv++)
1426 if (strcmp(tv->name, what) == 0)
1429 if (tv->name == NULL)
1432 if (tv == &tval[T_pt] || tv == &tval[T_km] ||
1433 tv == &tval[T_am] || tv == &tval[T_xn]) {
1434 static char yes[] = "yes";
1435 static char no[] = "no";
1436 if (el->el_terminal.t_val[tv - tval])
1437 *(char **)how = yes;
1442 *(int *)how = el->el_terminal.t_val[tv - tval];
1447 /* terminal_echotc():
1448 * Print the termcap string out with variable substitution
1452 terminal_echotc(EditLine *el, int argc __attribute__((__unused__)),
1453 const wchar_t **argv)
1457 int arg_need, arg_cols, arg_rows;
1458 int verbose = 0, silent = 0;
1460 static const char fmts[] = "%s\n", fmtd[] = "%d\n";
1461 const struct termcapstr *t;
1462 char buf[TC_BUFSIZE];
1467 if (argv == NULL || argv[1] == NULL)
1471 if (argv[0][0] == '-') {
1472 switch (argv[0][1]) {
1480 /* stderror(ERR_NAME | ERR_TCUSAGE); */
1485 if (!*argv || *argv[0] == '\0')
1487 if (wcscmp(*argv, L"tabs") == 0) {
1488 (void) fprintf(el->el_outfile, fmts, EL_CAN_TAB ? "yes" : "no");
1490 } else if (wcscmp(*argv, L"meta") == 0) {
1491 (void) fprintf(el->el_outfile, fmts, Val(T_km) ? "yes" : "no");
1493 } else if (wcscmp(*argv, L"xn") == 0) {
1494 (void) fprintf(el->el_outfile, fmts, EL_HAS_MAGIC_MARGINS ?
1497 } else if (wcscmp(*argv, L"am") == 0) {
1498 (void) fprintf(el->el_outfile, fmts, EL_HAS_AUTO_MARGINS ?
1501 } else if (wcscmp(*argv, L"baud") == 0) {
1502 (void) fprintf(el->el_outfile, fmtd, (int)el->el_tty.t_speed);
1504 } else if (wcscmp(*argv, L"rows") == 0 ||
1505 wcscmp(*argv, L"lines") == 0) {
1506 (void) fprintf(el->el_outfile, fmtd, Val(T_li));
1508 } else if (wcscmp(*argv, L"cols") == 0) {
1509 (void) fprintf(el->el_outfile, fmtd, Val(T_co));
1513 * Try to use our local definition first
1516 for (t = tstr; t->name != NULL; t++)
1518 ct_encode_string(*argv, &el->el_scratch)) == 0) {
1519 scap = el->el_terminal.t_str[t - tstr];
1522 if (t->name == NULL) {
1523 /* XXX: some systems' tgetstr needs non const */
1524 scap = tgetstr(ct_encode_string(*argv, &el->el_scratch), &area);
1526 if (!scap || scap[0] == '\0') {
1528 (void) fprintf(el->el_errfile,
1529 "echotc: Termcap parameter `%ls' not found.\n",
1534 * Count home many values we need for this capability.
1536 for (cap = scap, arg_need = 0; *cap; cap++)
1556 * hpux has lot's of them...
1559 (void) fprintf(el->el_errfile,
1560 "echotc: Warning: unknown termcap %% `%c'.\n",
1562 /* This is bad, but I won't complain */
1569 if (*argv && *argv[0]) {
1571 (void) fprintf(el->el_errfile,
1572 "echotc: Warning: Extra argument `%ls'.\n",
1576 terminal_tputs(el, scap, 1);
1580 if (!*argv || *argv[0] == '\0') {
1582 (void) fprintf(el->el_errfile,
1583 "echotc: Warning: Missing argument.\n");
1587 i = wcstol(*argv, &ep, 10);
1588 if (*ep != '\0' || i < 0) {
1590 (void) fprintf(el->el_errfile,
1591 "echotc: Bad value `%ls' for rows.\n",
1597 if (*argv && *argv[0]) {
1599 (void) fprintf(el->el_errfile,
1600 "echotc: Warning: Extra argument `%ls"
1604 terminal_tputs(el, tgoto(scap, arg_cols, arg_rows), 1);
1607 /* This is wrong, but I will ignore it... */
1609 (void) fprintf(el->el_errfile,
1610 "echotc: Warning: Too many required arguments (%d).\n",
1615 if (!*argv || *argv[0] == '\0') {
1617 (void) fprintf(el->el_errfile,
1618 "echotc: Warning: Missing argument.\n");
1621 i = wcstol(*argv, &ep, 10);
1622 if (*ep != '\0' || i < 0) {
1624 (void) fprintf(el->el_errfile,
1625 "echotc: Bad value `%ls' for cols.\n",
1631 if (!*argv || *argv[0] == '\0') {
1633 (void) fprintf(el->el_errfile,
1634 "echotc: Warning: Missing argument.\n");
1637 i = wcstol(*argv, &ep, 10);
1638 if (*ep != '\0' || i < 0) {
1640 (void) fprintf(el->el_errfile,
1641 "echotc: Bad value `%ls' for rows.\n",
1648 (void) fprintf(el->el_errfile,
1649 "echotc: Bad value `%ls'.\n", *argv);
1653 if (*argv && *argv[0]) {
1655 (void) fprintf(el->el_errfile,
1656 "echotc: Warning: Extra argument `%ls"
1660 terminal_tputs(el, tgoto(scap, arg_cols, arg_rows), arg_rows);