2 Generalized console input/output handler
3 Kern Sibbald, December MMIII
22 /* Global functions imported */
25 extern char *getenv(char *);
27 static void add_smap(char *str, int func);
29 /* From termios library */
33 /* Global variables */
35 static char *t_up = "\n"; /* scroll up character */
36 static char *t_honk = "\007"; /* sound beep */
37 static char *t_il; /* insert line */
38 static char *t_dl; /* delete line */
39 static char *t_cs; /* clear screen */
40 static char *t_cl; /* clear line */
41 static int t_width = 79; /* terminal width */
42 static int t_height = 24; /* terminal height */
43 static int linsdel_ok = 0; /* set if term has line insert & delete fncs */
45 static char *t_cm; /* cursor positioning */
46 static char *t_ti; /* init sequence */
47 static char *t_te; /* end sequence */
48 static char *t_do; /* down one line */
49 static char *t_sf; /* scroll screen one line up */
51 /* Keypad and Function Keys */
52 static char *kl; /* left key */
53 static char *kr; /* right */
54 static char *ku; /* up */
55 static char *kd; /* down */
56 static char *kh; /* home */
57 static char *kb; /* backspace */
58 static char *kD; /* delete key */
59 static char *kI; /* insert */
60 static char *kN; /* next page */
61 static char *kP; /* previous page */
62 static char *kH; /* home */
63 static char *kE; /* end */
66 #define EOS '\0' /* end of string terminator */
72 * Stab entry. Input chars (str), the length, and the desired
75 typedef struct s_stab {
84 static stab_t **stab = NULL; /* array of stabs by length */
85 static int num_stab; /* size of stab array */
89 static bool old_term_params_set = false;
90 static struct termios old_term_params;
92 /* Maintain lines in a doubly linked circular pool of lines. Each line is
93 preceded by a header defined by the lstr structure */
96 struct lstr { /* line pool structure */
97 struct lstr *prevl; /* link to previous line */
98 struct lstr *nextl; /* link to next line */
99 long len; /* length of line+header */
100 char used; /* set if line valid */
101 char line; /* line is actually varying length */
105 #define POOLEN 128000 /* bytes in line pool */
107 #define POOLEN 500 /* bytes in line pool */
109 char pool[POOLEN]; /* line pool */
110 #define PHDRL ((int)sizeof(struct lstr)) /* length of line header */
112 static struct lstr *lptr; /* current line pointer */
113 static struct lstr *slptr; /* store line pointer */
115 static char *getnext(), *getprev();
116 static int first = 1;
117 static int mode_insert = 0;
118 static int mode_wspace = 1; /* words separated by spaces */
120 /* Forward referenced functions */
121 static void sigintcatcher(int);
123 /* Global variables Exported */
125 static short char_map[600]= {
126 0, F_SOL, /* ^a Line start */
127 F_PRVWRD, /* ^b Previous word */ F_BREAK, /* ^C break */
128 F_DELCHR, /* ^D Delete character */ F_EOL, /* ^e End of line */
129 F_CSRRGT, /* ^f Right */ F_TABBAK, /* ^G Back tab */
130 F_CSRLFT, /* ^H Left */ F_TAB, /* ^I Tab */
131 F_CSRDWN, /* ^J Down */ F_DELEOL, /* ^K kill to eol */
132 F_CLRSCRN,/* ^L clear screen */ F_RETURN, /* ^M Carriage return */
133 F_RETURN, /* ^N enter line */ F_CONCAT, /* ^O Concatenate lines */
134 F_CSRUP, /* ^P cursor up */ F_TINS, /* ^Q Insert character mode */
135 F_PAGUP, /* ^R Page up */ F_CENTER, /* ^S Center text */
136 F_PAGDWN, /* ^T Page down */ F_DELSOL, /* ^U delete to start of line */
137 F_DELWRD, /* ^V Delete word */ F_PRVWRD, /* ^W Previous word */
138 F_NXTMCH, /* ^X Next match */ F_DELEOL, /* ^Y Delete to end of line */
139 F_BACKGND,/* ^Z Background */ 0x1B, /* ^[=ESC escape */
140 F_TENTRY, /* ^\ Entry mode */ F_PASTECB,/* ^]=paste clipboard */
141 F_HOME, /* ^^ Home */ F_ERSLIN, /* ^_ Erase line */
143 ' ','!','"','#','$','%','&','\047',
144 '(',')','*','+','\054','-','.','/',
145 '0','1','2','3','4','5','6','7',
146 '8','9',':',';','<','=','>','?',
147 '@','A','B','C','D','E','F','G',
148 'H','I','J','K','L','M','N','O',
149 'P','Q','R','S','T','U','V','W',
150 'X','Y','Z','[','\\',']','^','_',
151 '\140','a','b','c','d','e','f','g',
152 'h','i','j','k','l','m','n','o',
153 'p','q','r','s','t','u','v','w',
154 'x','y','z','{','|','}','\176',F_ERSCHR /* erase character */
159 #define NVID 0x1E /* normal video -- blue */
160 #define RVID 0x4F /* reverse video -- red */
161 #define MNVID 0x07 /* normal video (monochrome tube) */
162 #define MRVID 0x70 /* reverse video (monochrome tube) */
165 /* Local variables */
167 #define CR '\r' /* carriage return */
170 /* Function Prototypes */
172 static int input_char(void);
173 static int t_gnc(void);
174 static void insert_space(char *curline, int line_len);
175 static void forward(int i, char *str, int str_len);
176 static void backup(int i);
177 static void delchr(int cnt, char *curline, int line_len);
178 static int iswordc(char c);
179 static int next_word(char *ldb_buf);
180 static int prev_word(char *ldb_buf);
181 static void prtcur(char *str);
182 static void poolinit(void);
183 static char * getnext(void);
184 static char * getprev(void);
185 static void putline(char *newl, int newlen);
186 static void t_honk_horn(void);
187 static void t_insert_line(void);
188 static void t_delete_line(void);
189 static void t_clrline(int pos, int width);
190 void t_sendl(char *msg, int len);
191 void t_send(char *msg);
193 static void asclrs();
194 static void ascurs(int y, int x);
196 static void rawmode(FILE *input);
197 static void normode(void);
198 static int t_getch();
199 static void trapctlc();
200 static void asclrl(int pos, int width);
201 static void asinsl();
202 static void asdell();
204 int input_line(char *string, int length);
206 void con_init(FILE *input)
215 void con_set_zed_keys(void)
217 char_map[1] = F_NXTWRD; /* ^A Next Word */
218 char_map[2] = F_SPLIT; /* ^B Split line */
219 char_map[3] = F_EOI; /* ^C Quit */
220 char_map[4] = F_DELCHR; /* ^D Delete character */
221 char_map[5] = F_EOF; /* ^E End of file */
222 char_map[6] = F_INSCHR; /* ^F Insert character */
223 char_map[7] = F_TABBAK; /* ^G Back tab */
224 char_map[8] = F_CSRLFT; /* ^H Left */
225 char_map[9] = F_TAB; /* ^I Tab */
226 char_map[10] = F_CSRDWN; /* ^J Down */
227 char_map[11] = F_CSRUP; /* ^K Up */
228 char_map[12] = F_CSRRGT; /* ^L Right */
229 char_map[13] = F_RETURN; /* ^M Carriage return */
230 char_map[14] = F_EOL; /* ^N End of line */
231 char_map[15] = F_CONCAT; /* ^O Concatenate lines */
232 char_map[16] = F_MARK; /* ^P Set marker */
233 char_map[17] = F_TINS; /* ^Q Insert character mode */
234 char_map[18] = F_PAGUP; /* ^R Page up */
235 char_map[19] = F_CENTER; /* ^S Center text */
236 char_map[20] = F_PAGDWN; /* ^T Page down */
237 char_map[21] = F_SOL; /* ^U Line start */
238 char_map[22] = F_DELWRD; /* ^V Delete word */
239 char_map[23] = F_PRVWRD; /* ^W Previous word */
240 char_map[24] = F_NXTMCH; /* ^X Next match */
241 char_map[25] = F_DELEOL; /* ^Y Delete to end of line */
242 char_map[26] = F_DELLIN; /* ^Z Delete line */
244 char_map[28] = F_TENTRY; /* ^\ Entry mode */
245 char_map[29] = F_PASTECB;/* ^]=paste clipboard */
246 char_map[30] = F_HOME; /* ^^ Home */
247 char_map[31] = F_ERSLIN; /* ^_ Erase line */
258 * Guarantee that the string is properly terminated */
259 static char *bstrncpy(char *dest, const char *src, int maxlen)
261 strncpy(dest, src, maxlen-1);
269 * New style string mapping to function code
271 static int do_smap(int c)
290 for (i=len-1; i<MAX_STAB; i++) {
291 for (tstab=stab[i]; tstab; tstab=tstab->next) {
292 if (strncmp(str, tstab->str, len) == 0) {
293 if (len == tstab->len) {
297 break; /* found possibility continue searching */
304 /* found partial match, so get next character and retry */
305 str[len++] = t_gnc();
311 static void dump_stab()
317 for (i=0; i<MAX_STAB; i++) {
318 for (tstab=stab[i]; tstab; tstab=tstab->next) {
319 for (j=0; j<tstab->len; j++) {
321 if (c < 0x20 || c > 0x7F) {
322 sprintf(buf, " 0x%x ", c);
330 sprintf(buf, " func=%d len=%d\n\r", tstab->func, tstab->len);
338 * New routine. Add string to string->func mapping table.
340 static void add_smap(char *str, int func)
350 /* errmsg("String for func %d is zero length\n", func); */
353 tstab = (stab_t *)malloc(sizeof(stab_t));
354 memset(tstab, 0, sizeof(stab_t));
356 tstab->str = (char *)malloc(tstab->len + 1);
357 bstrncpy(tstab->str, str, tstab->len + 1);
359 if (tstab->len > num_stab) {
360 printf("stab string too long %d. Max is %d\n", tstab->len, num_stab);
363 tstab->next = stab[tstab->len-1];
364 stab[tstab->len-1] = tstab;
365 /* printf("Add_smap tstab=%x len=%d func=%d tstab->next=%x\n\r", tstab, len,
366 func, tstab->next); */
371 /* Get the next character from the terminal - performs table lookup on
372 the character to do the desired translation */
378 if ((c=t_gnc()) <= 599) { /* IBM generates codes up to 260 */
380 } else if (c > 1000) { /* stuffed function */
381 c -= 1000; /* convert back to function code */
386 /* if we got a screen size escape sequence, read height, width */
389 y = t_gnc() - 0x20; /* y */
390 x = t_gnc() - 0x20; /* x */
397 /* Get a complete input line */
400 /*FCN*/input_line(char *string, int length)
402 char curline[200]; /* edit buffer */
407 poolinit(); /* build line pool */
410 noline = 1; /* no line fetched yet */
411 for (cl=cp=0; cl<length && cl<(int)sizeof(curline); ) {
412 switch (c=(int)input_char()) {
413 case F_RETURN: /* CR */
414 t_sendl("\r\n", 2); /* yes, print it and */
415 goto done; /* get out */
416 case F_CLRSCRN: /* clear screen */
418 t_sendl(curline, cl);
422 if (noline) { /* no line fetched yet */
423 getnext(); /* getnext so getprev gets current */
424 noline = 0; /* we now have line */
426 bstrncpy(curline, getprev(), sizeof(curline));
430 noline = 0; /* mark line fetched */
431 bstrncpy(curline, getnext(), sizeof(curline));
435 insert_space(curline, sizeof(curline));
438 delchr(1, curline, sizeof(curline)); /* delete one character */
440 case F_CSRLFT: /* Backspace */
444 forward(1,curline, sizeof(curline));
446 case F_ERSCHR: /* Rubout */
448 delchr(1, curline, sizeof(curline));
451 t_clrline(0, t_width);
456 forward(next_word(curline),curline, sizeof(curline));
459 backup(prev_word(curline));
462 delchr(next_word(curline), curline, sizeof(curline)); /* delete word */
464 case F_NXTMCH: /* Ctl-X */
466 *string = EOS; /* terminate string */
467 return(c); /* give it to him */
469 /* Note fall through */
472 backup(cp); /* backup to beginning of line */
473 t_clrline(0,t_width); /* erase line */
475 cl = 0; /* reset cursor counter */
482 forward(1,curline, sizeof(curline));
488 case F_TINS: /* toggle insert mode */
489 mode_insert = !mode_insert; /* flip bit */
492 if (c > 255) { /* function key hit */
493 if (cl==0) { /* if first character then */
494 *string = EOS; /* terminate string */
495 return c; /* return it */
497 t_honk_horn(); /* complain */
500 insert_space(curline, sizeof(curline));
502 curline[cp++] = c; /* store character in line being built */
503 t_char((char)c); /* echo character to terminal */
505 cl = cp; /* keep current length */
511 /* If we fall through here rather than goto done, the line is too long
512 simply return what we have now. */
514 curline[cl++] = EOS; /* terminate */
515 bstrncpy(string,curline,length); /* return line to caller */
516 /* Note, put line zaps curline */
517 putline(curline,cl); /* save line for posterity */
518 return 0; /* give it to him/her */
521 /* Insert a space at the current cursor position */
523 /*FCN*/insert_space(char *curline, int curline_len)
527 if (cp > cl || cl+1 > curline_len) return;
528 /* Note! source and destination overlap */
529 memmove(&curline[cp+1],&curline[cp],i=cl-cp);
533 forward(i,curline, curline_len);
538 /* Move cursor forward keeping characters under it */
540 /*FCN*/forward(int i,char *str, int str_len)
556 /* Backup cursor keeping characters under it */
560 for ( ;i && cp; i--,cp--)
564 /* Delete the character under the cursor */
566 /*FCN*/delchr(int cnt, char *curline, int line_len)
572 if ((i=cl-cp-cnt+1) > 0) {
573 memcpy(&curline[cp],&curline[cp+cnt],i);
575 curline[cl -= cnt] = EOS;
576 t_clrline(0,t_width);
578 forward(i=cl-cp,curline, line_len);
583 /* Determine if character is part of a word */
585 /*FCN*/iswordc(char c)
589 if (c >= '0' && c <= '9')
591 if (c == '$' || c == '%')
596 /* Return number of characters to get to next word */
598 /*FCN*/next_word(char *ldb_buf)
605 for ( ; ncp<cl && iswordc(*(ldb_buf+ncp)); ncp++) ;
606 for ( ; ncp<cl && !iswordc(*(ldb_buf+ncp)); ncp++) ;
610 /* Return number of characters to get to previous word */
612 /*FCN*/prev_word(char *ldb_buf)
616 if (cp == 0) /* if at begin of line stop now */
618 if (cp > cl) /* if past eol start at eol */
622 /* backup to end of previous word - i.e. skip special chars */
623 for (i=ncp-1; i && !iswordc(*(ldb_buf+i)); i--) ;
624 if (i == 0) { /* at beginning of line? */
625 return cp; /* backup to beginning */
627 /* now move back through word to beginning of word */
628 for ( ; i && iswordc(*(ldb_buf+i)); i--) ;
629 ncp = i+1; /* position to first char of word */
630 if (i==0 && iswordc(*ldb_buf)) /* check for beginning of line */
632 return cp-ncp; /* return count */
635 /* Display new current line */
637 /*FCN*/prtcur(char *str)
640 t_clrline(0,t_width);
641 cp = cl = strlen(str);
646 /* Initialize line pool. Split pool into two pieces. */
650 slptr = lptr = (struct lstr *)pool;
659 /* Return pointer to next line in the pool and advance current line pointer */
663 do { /* find next used line */
665 } while (!lptr->used);
666 return (char *)&lptr->line;
669 /* Return pointer to previous line in the pool */
673 do { /* find previous used line */
675 } while (!lptr->used);
676 return (char *)&lptr->line;
680 /*FCN*/putline(char *newl, int newlen)
682 struct lstr *nptr; /* points to next line */
685 lptr = slptr; /* get ptr to last line stored */
686 lptr = lptr->nextl; /* advance pointer */
687 if ((char *)lptr-pool+newlen+PHDRL > POOLEN) { /* not enough room */
688 lptr->used = 0; /* delete line */
689 lptr = (struct lstr *)pool; /* start at beginning of buffer */
691 while (lptr->len < newlen+PHDRL) { /* concatenate buffers */
692 nptr = lptr->nextl; /* point to next line */
693 lptr->nextl = nptr->nextl; /* unlink it from list */
694 nptr->nextl->prevl = lptr;
695 lptr->len += nptr->len;
697 if (lptr->len > newlen + 2 * PHDRL) { /* split buffer */
698 nptr = (struct lstr *)((char *)lptr + newlen + PHDRL);
699 /* Appropriate byte alignment - normally 2 byte, but on
700 sparc we need 4 byte alignment, so we always do 4 */
701 if (((unsigned)nptr & 3) != 0) { /* test four byte alignment */
703 nptr = (struct lstr *)((((unsigned) p) & ~3) + 4);
705 nptr->len = lptr->len - ((char *)nptr - (char *)lptr);
706 lptr->len -= nptr->len;
707 nptr->nextl = lptr->nextl; /* link in new buffer */
708 lptr->nextl->prevl = nptr;
713 memcpy(&lptr->line,newl,newlen);
714 lptr->used = 1; /* mark line used */
715 slptr = lptr; /* save as stored line */
720 /*FCN*/dump(struct lstr *ptr, char *msg)
722 printf("%s buf=%x nextl=%x prevl=%x len=%d used=%d\n",
723 msg,ptr,ptr->nextl,ptr->prevl,ptr->len,ptr->used);
725 printf("line=%s\n",&ptr->line);
727 #endif /* DEBUGOUT */
730 /* Honk horn on terminal */
737 /* Insert line on terminal */
739 /*FCN*/t_insert_line()
744 /* Delete line from terminal */
746 /*FCN*/t_delete_line()
751 /* clear line from pos to width */
753 /*FCN*/t_clrline(int pos, int width)
755 asclrl(pos, width); /* clear to end of line */
758 /* Helper function to add string preceded by
759 * ESC to smap table */
760 static void add_esc_smap(char *str, int func)
763 buf[0] = 0x1B; /* esc */
764 bstrncpy(buf+1, str, sizeof(buf)-1);
768 /* Set raw mode on terminal file. Basically, get the terminal into a
769 mode in which all characters can be read as they are entered. CBREAK
770 mode is not sufficient.
772 /*FCN*/static void rawmode(FILE *input)
775 static char term_buf[2048];
776 static char *term_buffer = term_buf;
777 char *termtype = (char *)getenv("TERM");
779 /* Make sure we are dealing with a terminal */
780 if (!isatty(fileno(input))) {
783 if (tcgetattr(0, &old_term_params) != 0) {
784 printf("conio: Cannot tcgetattr()\n");
787 old_term_params_set = true;
789 t.c_cc[VMIN] = 1; /* satisfy read after 1 char */
791 t.c_iflag &= ~(BRKINT | IGNPAR | PARMRK | INPCK |
792 ISTRIP | ICRNL | IXON | IXOFF | INLCR | IGNCR);
795 t.c_lflag &= ~(ECHO | ECHOE | ECHOK | ECHONL | ICANON |
797 tcflush(0, TCIFLUSH);
798 if (tcsetattr(0, TCSANOW, &t) == -1) {
799 printf("Cannot tcsetattr()\n");
802 signal(SIGQUIT, SIG_IGN);
803 signal(SIGHUP, SIG_IGN);
804 // signal(SIGSTOP, SIG_IGN);
805 signal(SIGINT, sigintcatcher);
806 signal(SIGWINCH, SIG_IGN);
807 signal(SIGQUIT, SIG_IGN);
808 signal(SIGCHLD, SIG_IGN);
809 // signal(SIGTSTP, SIG_IGN);
812 printf("Cannot get terminal type.\n");
815 if (tgetent(term_buffer, termtype) < 0) {
816 printf("Cannot get terminal termcap entry.\n");
819 t_width = t_height = -1;
820 t_width = tgetnum("co") - 1;
821 t_height = tgetnum("li");
824 t_cm = (char *)tgetstr("cm", &term_buffer);
825 t_cs = (char *)tgetstr("cl", &term_buffer); /* clear screen */
826 t_cl = (char *)tgetstr("ce", &term_buffer); /* clear line */
827 t_dl = (char *)tgetstr("dl", &term_buffer); /* delete line */
828 t_il = (char *)tgetstr("al", &term_buffer); /* insert line */
829 t_honk = (char *)tgetstr("bl", &term_buffer); /* beep */
830 t_ti = (char *)tgetstr("ti", &term_buffer);
831 t_te = (char *)tgetstr("te", &term_buffer);
832 t_up = (char *)tgetstr("up", &term_buffer);
833 t_do = (char *)tgetstr("do", &term_buffer);
834 t_sf = (char *)tgetstr("sf", &term_buffer);
836 num_stab = MAX_STAB; /* get default stab size */
837 stab = (stab_t **)malloc(sizeof(stab_t *) * num_stab);
838 memset(stab, 0, sizeof(stab_t *) * num_stab);
841 kl = (char *)tgetstr("kl", &term_buffer);
842 kr = (char *)tgetstr("kr", &term_buffer);
843 ku = (char *)tgetstr("ku", &term_buffer);
844 kd = (char *)tgetstr("kd", &term_buffer);
845 kh = (char *)tgetstr("kh", &term_buffer);
846 kb = (char *)tgetstr("kb", &term_buffer);
847 kD = (char *)tgetstr("kD", &term_buffer);
848 kI = (char *)tgetstr("kI", &term_buffer);
849 kN = (char *)tgetstr("kN", &term_buffer);
850 kP = (char *)tgetstr("kP", &term_buffer);
851 kH = (char *)tgetstr("kH", &term_buffer);
852 kE = (char *)tgetstr("kE", &term_buffer);
854 add_smap(kl, F_CSRLFT);
855 add_smap(kr, F_CSRRGT);
856 add_smap(ku, F_CSRUP);
857 add_smap(kd, F_CSRDWN);
858 add_smap(kI, F_TINS);
859 add_smap(kN, F_PAGDWN);
860 add_smap(kP, F_PAGUP);
861 add_smap(kH, F_HOME);
865 add_esc_smap("[A", F_CSRUP);
866 add_esc_smap("[B", F_CSRDWN);
867 add_esc_smap("[C", F_CSRRGT);
868 add_esc_smap("[D", F_CSRLFT);
869 add_esc_smap("[1~", F_HOME);
870 add_esc_smap("[2~", F_TINS);
871 add_esc_smap("[3~", F_DELCHR);
872 add_esc_smap("[4~", F_EOF);
873 add_esc_smap("f", F_NXTWRD);
874 add_esc_smap("b", F_PRVWRD);
878 for (i=301; i<600; i++) {
879 char_map[i] = i; /* setup IBM function codes */
885 /* Restore tty mode */
886 /*FCN*/static void normode()
888 if (old_term_params_set) {
889 tcsetattr(0, TCSANOW, &old_term_params);
893 /* Get next character from terminal/script file/unget buffer */
901 /* Get next character from OS */
902 static int t_getch(void)
906 if (read(0, &c, 1) != 1) {
914 /* window_size -- Return window height and width to caller. */
915 static int window_size(int *height, int *width) /* /window_size/ */
917 *width = tgetnum("co") - 1;
918 *height = tgetnum("li");
923 /* Send message to terminal - primitive routine */
925 /*FCN*/t_sendl(char *msg,int len)
931 /*FCN*/t_send(char *msg)
936 t_sendl(msg, strlen(msg)); /* faster than one char at time */
939 /* Send single character to terminal - primitive routine - */
941 /*FCN*/t_char(char c)
947 static int brkflg = 0; /* set on user break */
949 /* Routine to return true if user types break */
955 /* Clear break flag */
962 /* Interrupt caught here */
963 static void sigintcatcher(int sig)
966 signal(SIGINT, sigintcatcher);
971 /*FCN*/void trapctlc()
973 signal(SIGINT, sigintcatcher);
977 /* ASCLRL() -- Clear to end of line from current position */
978 static void asclrl(int pos, int width)
983 t_send(t_cl); /* use clear to eol function */
986 if (pos==1 && linsdel_ok) {
987 t_delete_line(); /* delete line */
988 t_insert_line(); /* reinsert it */
991 for (i=1; i<=width-pos+1; i++)
992 t_char(' '); /* last resort, blank it out */
993 for (i=1; i<=width-pos+1; i++) /* backspace to original position */
1000 /* ASCURS -- Set cursor position */
1001 static void ascurs(int y, int x)
1003 t_send((char *)tgoto(t_cm, x, y));
1007 /* ASCLRS -- Clear whole screen */
1008 static void asclrs()
1016 /* ASINSL -- insert new line after cursor */
1017 static void asinsl()
1019 t_clrline(0, t_width);
1020 t_send(t_il); /* insert before */
1023 /* ASDELL -- Delete line at cursor */
1024 static void asdell()