]> cloudbase.mooo.com Git - z180-stamp.git/blob - avr/cli_readline.c
projects / z180-stamp.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Add END key to cread_line()
[z180-stamp.git] / avr / cli_readline.c
1 /*
2 * (C) Copyright 2014 Leo C. <erbl259-lmu@yahoo.de>
3 *
4 * (C) Copyright 2000
5 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
6 *
7 * Add to readline cmdline-editing by
8 * (C) Copyright 2005
9 * JinHua Luo, GuangDong Linux Center, <luo.jinhua@gd-linux.com>
10 *
11 * SPDX-License-Identifier: GPL-2.0+
12 */
13
14 #include "common.h"
15 #include <string.h>
16 #include <stdio.h>
17 #include <stdlib.h>
18 #include <stdbool.h>
19 #include <ctype.h>
20
21 #include "config.h"
22 #include "con-utils.h"
23 #include "print-utils.h"
24 #include "command.h"
25 #include "cli_readline.h"
26
27
28
29 /************************************************************************************************/
30 /* TODO:
31 *
32 */
33
34 #define ESC 0x1b
35
36 #define KEY_TAB '\t' // TAB key
37 #define KEY_CR '\r' // RETURN key
38 #define KEY_BACKSPACE '\b' // Backspace key
39 #define KEY_ESCAPE 0x1B // ESCAPE (pressed twice)
40
41 #define KEY_DOWN 0x80 // Down arrow key
42 #define KEY_UP 0x81 // Up arrow key
43 #define KEY_LEFT 0x82 // Left arrow key
44 #define KEY_RIGHT 0x83 // Right arrow key
45 #define KEY_HOME 0x84 // Home key
46 #define KEY_DC 0x85 // Delete character key
47 #define KEY_IC 0x86 // Ins char/toggle ins mode key
48 #define KEY_NPAGE 0x87 // Next-page key
49 #define KEY_PPAGE 0x88 // Previous-page key
50 #define KEY_END 0x89 // End key
51 #define KEY_BTAB 0x8A // Back tab key
52 #define KEY_F1 0x8B // Function key F1
53 #define KEY_F(n) (KEY_F1+(n)-1) // Space for additional 12 function keys
54
55
56 struct fkey_tbl_s {
57 const FLASH char *sequence; /* ESC Sequence */
58 int code; /* Keycode */
59 };
60
61 //typedef const FLASH struct fkey_tbl_s fkey_tbl_t;
62
63 #define FKEY_TBL_ITEM(_seq, _code) { FSTR(#_seq), _code }
64
65
66
67 static const FLASH struct fkey_tbl_s fkey_table[] = {
68
69 FKEY_TBL_ITEM(B, KEY_DOWN), // Down arrow key
70 FKEY_TBL_ITEM(A, KEY_UP), // Up arrow key
71 FKEY_TBL_ITEM(D, KEY_LEFT), // Left arrow key
72 FKEY_TBL_ITEM(C, KEY_RIGHT), // Right arrow key
73 FKEY_TBL_ITEM(1~, KEY_HOME), // Home key
74 FKEY_TBL_ITEM(3~, KEY_DC), // Delete character key
75 FKEY_TBL_ITEM(2~, KEY_IC), // Ins char/toggle ins mode key
76 FKEY_TBL_ITEM(6~, KEY_NPAGE), // Next-page key
77 FKEY_TBL_ITEM(5~, KEY_PPAGE), // Previous-page key
78 FKEY_TBL_ITEM(4~, KEY_END), // End key
79 FKEY_TBL_ITEM(Z, KEY_BTAB), // Back tab key
80 /* VT400: */
81 FKEY_TBL_ITEM(11~, KEY_F(1)), // Function key F1
82 FKEY_TBL_ITEM(12~, KEY_F(2)), // Function key F2
83 FKEY_TBL_ITEM(13~, KEY_F(3)), // Function key F3
84 FKEY_TBL_ITEM(14~, KEY_F(4)), // Function key F4
85 FKEY_TBL_ITEM(15~, KEY_F(5)), // Function key F5
86 /* Linux consoe */
87 FKEY_TBL_ITEM([A, KEY_F(1)), // Function key F1
88 FKEY_TBL_ITEM([B, KEY_F(2)), // Function key F2
89 FKEY_TBL_ITEM([C, KEY_F(3)), // Function key F3
90 FKEY_TBL_ITEM([D, KEY_F(4)), // Function key F4
91 FKEY_TBL_ITEM([E, KEY_F(5)), // Function key F5
92
93 FKEY_TBL_ITEM(17~, KEY_F(6)), // Function key F6
94 FKEY_TBL_ITEM(18~, KEY_F(7)), // Function key F7
95 FKEY_TBL_ITEM(19~, KEY_F(8)), // Function key F8
96 FKEY_TBL_ITEM(20~, KEY_F(9)), // Function key F9
97 FKEY_TBL_ITEM(21~, KEY_F(10)), // Function key F10
98 FKEY_TBL_ITEM(23~, KEY_F(11)), // Function key F11
99 FKEY_TBL_ITEM(24~, KEY_F(12)), // Function key F12
100 { NULL } /* Mark end of table */
101 };
102
103
104
105 typedef enum {
106 STATE_GROUND,
107 STATE_ESCAPE,
108 STATE_CSI_ENTRY
109 } vtparse_state_t;
110
111 #define CHB_SIZE 15
112
113 static
114 int vt_parse (void)
115 {
116 static vtparse_state_t state = STATE_GROUND;
117 char buf[CHB_SIZE+1];
118 uint8_t param[2];
119 uint8_t i_buf;
120 uint8_t i_param;
121 int ch;
122
123
124 while (1) {
125 ch = my_getchar(1);
126 // debug_getch(state, ch);
127
128 switch (state) {
129 case STATE_GROUND:
130 if (ch == ESC) {
131 state = STATE_ESCAPE;
132 continue;
133 }
134 if (ch == 0x7F) // BACKSPACE on VT200 sends DEL char
135 ch = KEY_BACKSPACE; // map it to '\b'
136 break;
137 case STATE_ESCAPE:
138 if (ch < 0)
139 continue;
140
141 if (ch == '[') {
142 state = STATE_CSI_ENTRY;
143 param[0] = param[1] = 0;
144 i_buf = 0;
145 i_param = 0;
146 continue;
147 }
148 state = STATE_GROUND;
149 break;
150 case STATE_CSI_ENTRY:
151 if (ch < 0)
152 continue;
153
154 buf[i_buf] = ch;
155 if (i_buf < CHB_SIZE)
156 i_buf++;
157 if (ch == ';') {
158 i_param++;
159 continue;
160 }
161 if (isdigit(ch)) {
162 if (i_param < 2)
163 param[i_param] = param[i_param] * 10 + ch - '0';
164 continue;
165 }
166 if (ch >= '@' && ch <= '~' && ch != '[') {
167 buf[i_buf] = '\0';
168 int_fast8_t i = 0;
169 while (fkey_table[i].sequence) {
170 if (! strcmp_P (buf, fkey_table[i].sequence)) {
171 ch = fkey_table[i].code;
172 break;
173 }
174 i++;
175 }
176 if (fkey_table[i].sequence == NULL) {
177 ch = '$'; /* KEY_ESCAPE; */
178 }
179 }
180 state = STATE_GROUND;
181 break;
182 }
183 break; /* while */
184 }
185
186 return ch;
187 }
188
189 /************************************************************************************************/
190
191
192 char console_buffer[CONFIG_SYS_CBSIZE + 1]; /* console I/O buffer */
193
194 #ifndef CONFIG_CMDLINE_EDITING
195 static const FLASH char erase_seq[] = "\b \b"; /* erase sequence */
196 static const FLASH char tab_seq[] = " "; /* used to expand TABs */
197
198 static char *delete_char (char *buffer, char *p, int *colp, int *np, int plen)
199 {
200 char *s;
201
202 if (*np == 0)
203 return p;
204
205 if (*(--p) == '\t') { /* will retype the whole line */
206 while (*colp > plen) {
207 my_puts_P(erase_seq);
208 (*colp)--;
209 }
210 for (s = buffer; s < p; ++s) {
211 if (*s == '\t') {
212 my_puts_P(tab_seq + ((*colp) & 07));
213 *colp += 8 - ((*colp) & 07);
214 } else {
215 ++(*colp);
216 putchar(*s);
217 }
218 }
219 } else {
220 my_puts_P(erase_seq);
221 (*colp)--;
222 }
223 (*np)--;
224
225 return p;
226 }
227 #endif /* CONFIG_CMDLINE_EDITING */
228
229
230 #ifdef CONFIG_CMDLINE_EDITING
231
232 /*
233 * cmdline-editing related codes from vivi.
234 * Author: Janghoon Lyu <nandy@mizi.com>
235 */
236
237 static void putnstr(char *str, int n)
238 {
239 /* printf_P(PSTR("%.*s"), (int)n, str) */
240 while (n-- && *str)
241 putchar(*str++);
242 }
243
244
245 #define CTL_CH(c) ((c) - 'a' + 1)
246 #define CTL_BACKSPACE ('\b')
247 #define DEL ((char)255)
248 #define DEL7 ((char)127)
249
250 #define getcmd_putch(ch) putchar(ch)
251 #define getcmd_getch() vt_parse()
252 #define getcmd_cbeep() getcmd_putch('\a')
253
254 #define HIST_MAX 20
255
256 static int_fast8_t hist_max;
257 static int_fast8_t hist_add_idx;
258 static int_fast8_t hist_cur = -1;
259
260 static char *hist_list[HIST_MAX];
261
262 static void hist_init(void)
263 {
264 int_fast8_t i;
265
266 hist_max = 0;
267 hist_add_idx = 0;
268 hist_cur = -1;
269
270 for (i = 0; i < HIST_MAX; i++) {
271 hist_list[i] = NULL;
272 }
273 }
274
275 static void cread_add_to_hist(char *line)
276 {
277 if (hist_max) {
278 int_fast8_t last = hist_add_idx;
279 if (--last < 0)
280 last = hist_max;
281
282 if (!strcmp(line, hist_list[last]))
283 return;
284 }
285
286 char *p = strdup(line);
287 if (p) {
288 free(hist_list[hist_add_idx]);
289 hist_list[hist_add_idx] = p;
290
291 if (++hist_add_idx >= HIST_MAX)
292 hist_add_idx = 0;
293
294 if (hist_add_idx > hist_max)
295 hist_max = hist_add_idx;
296 }
297 }
298
299 static char *hist_prev(void)
300 {
301 char *ret;
302 int_fast8_t old_cur;
303
304 if (hist_cur < 0)
305 return NULL;
306
307 old_cur = hist_cur;
308 if (--hist_cur < 0)
309 hist_cur = hist_max;
310
311 if (hist_cur == hist_add_idx) {
312 hist_cur = old_cur;
313 ret = NULL;
314 } else {
315 ret = hist_list[hist_cur];
316 }
317
318 return ret;
319 }
320
321 static char *hist_next(void)
322 {
323 char *ret;
324
325 if (hist_cur < 0)
326 return NULL;
327
328 if (hist_cur == hist_add_idx)
329 return NULL;
330
331 if (++hist_cur > hist_max)
332 hist_cur = 0;
333
334 if (hist_cur == hist_add_idx)
335 ret = "";
336 else
337 ret = hist_list[hist_cur];
338
339 return ret;
340 }
341
342
343 #define BEGINNING_OF_LINE() { \
344 while (num) { \
345 getcmd_putch(CTL_BACKSPACE); \
346 num--; \
347 } \
348 }
349
350 #define ERASE_TO_EOL() { \
351 if (num < eol_num) { \
352 /* printf_P(PSTR("%*S"), (int)(eol_num - num), PSTR("")); */ \
353 print_blanks(eol_num - num); \
354 do { \
355 getcmd_putch(CTL_BACKSPACE); \
356 } while (--eol_num > num); \
357 } \
358 }
359
360 #define REFRESH_TO_EOL() { \
361 if (num < eol_num) { \
362 wlen = eol_num - num; \
363 putnstr(buf + num, wlen); \
364 num = eol_num; \
365 } \
366 }
367
368 static void cread_add_char(char ichar, bool insert, uint_fast8_t *num,
369 uint_fast8_t *eol_num, char *buf, uint_fast8_t len)
370 {
371 uint_fast8_t wlen;
372
373 /* room ??? */
374 if (insert || *num == *eol_num) {
375 if (*eol_num > len - 1) {
376 getcmd_cbeep();
377 return;
378 }
379 (*eol_num)++;
380 }
381
382 if (insert) {
383 wlen = *eol_num - *num;
384 if (wlen > 1)
385 memmove(&buf[*num+1], &buf[*num], wlen-1);
386
387 buf[*num] = ichar;
388 putnstr(buf + *num, wlen);
389 (*num)++;
390 while (--wlen)
391 getcmd_putch(CTL_BACKSPACE);
392 } else {
393 /* echo the character */
394 wlen = 1;
395 buf[*num] = ichar;
396 putnstr(buf + *num, wlen);
397 (*num)++;
398 }
399 }
400
401 static void cread_add_str(char *str, int strsize, bool insert,
402 uint_fast8_t *num, uint_fast8_t *eol_num,
403 char *buf, uint_fast8_t len)
404 {
405 while (strsize--) {
406 cread_add_char(*str, insert, num, eol_num, buf, len);
407 str++;
408 }
409 }
410
411 static int cread_line(const FLASH char *const prompt, char *buf, uint_fast8_t *len)
412 {
413 uint_fast8_t num = 0;
414 uint_fast8_t eol_num = 0;
415 uint_fast8_t wlen;
416 int ichar;
417 bool insert = 1;
418 int init_len = strlen(buf);
419
420 (void) prompt;
421
422 if (init_len)
423 cread_add_str(buf, init_len, 1, &num, &eol_num, buf, *len);
424
425 while (1) {
426 ichar = getcmd_getch();
427
428 if ((ichar == '\n') || (ichar == '\r')) {
429 putchar('\n');
430 break;
431 }
432
433
434 switch (ichar) {
435
436 case KEY_HOME:
437 case CTL_CH('a'):
438 BEGINNING_OF_LINE();
439 break;
440 case CTL_CH('c'): /* ^C - break */
441 *buf = '\0'; /* discard input */
442 return -1;
443 case KEY_RIGHT:
444 case CTL_CH('f'): /* forward-char */
445 if (num < eol_num) {
446 getcmd_putch(buf[num]);
447 num++;
448 }
449 break;
450 case KEY_LEFT:
451 case CTL_CH('b'): /* backward-char */
452 if (num) {
453 getcmd_putch(CTL_BACKSPACE);
454 num--;
455 }
456 break;
457 case KEY_DC:
458 case CTL_CH('d'): /* delete-char */
459 if (num < eol_num) {
460 wlen = eol_num - num - 1;
461 if (wlen) {
462 memmove(&buf[num], &buf[num+1], wlen);
463 putnstr(buf + num, wlen);
464 }
465
466 getcmd_putch(' ');
467 do {
468 getcmd_putch(CTL_BACKSPACE);
469 } while (wlen--);
470 eol_num--;
471 }
472 break;
473 case CTL_CH('k'): /* kill-line */
474 ERASE_TO_EOL();
475 break;
476 case KEY_END:
477 case CTL_CH('e'):
478 REFRESH_TO_EOL();
479 break;
480 case KEY_IC:
481 case CTL_CH('o'):
482 insert = !insert;
483 break;
484 case CTL_CH('x'):
485 case CTL_CH('u'): /* kill-whole-line */
486 BEGINNING_OF_LINE();
487 ERASE_TO_EOL();
488 break;
489 case DEL:
490 case DEL7:
491 case 8: /* backward-delete-char */
492 if (num) {
493 wlen = eol_num - num;
494 num--;
495 memmove(&buf[num], &buf[num+1], wlen);
496 getcmd_putch(CTL_BACKSPACE);
497 putnstr(buf + num, wlen);
498 getcmd_putch(' ');
499 do {
500 getcmd_putch(CTL_BACKSPACE);
501 } while (wlen--);
502 eol_num--;
503 }
504 break;
505 case KEY_UP:
506 case CTL_CH('p'): /* previous-history */
507 case KEY_DOWN:
508 case CTL_CH('n'): /* next-history */
509 {
510 char *hline;
511
512 if (ichar == CTL_CH('p') || ichar == KEY_UP)
513 hline = hist_prev();
514 else
515 hline = hist_next();
516
517 if (!hline) {
518 getcmd_cbeep();
519 continue;
520 }
521
522 /* nuke the current line */
523 /* first, go home */
524 BEGINNING_OF_LINE();
525
526 /* erase to end of line */
527 ERASE_TO_EOL();
528
529 /* copy new line into place and display */
530 strcpy(buf, hline);
531 eol_num = strlen(buf);
532 REFRESH_TO_EOL();
533 continue;
534 }
535 #ifdef CONFIG_AUTO_COMPLETE
536 case '\t': {
537 int num2, col;
538
539 /* do not autocomplete when in the middle */
540 if (num < eol_num) {
541 getcmd_cbeep();
542 break;
543 }
544
545 buf[num] = '\0';
546 col = strlen_P(prompt) + eol_num;
547 num2 = num;
548 if (cmd_auto_complete(prompt, buf, &num2, &col)) {
549 col = num2 - num;
550 num += col;
551 eol_num += col;
552 }
553 break;
554 }
555 #endif
556 default:
557 if (isprint(ichar))
558 cread_add_char(ichar, insert, &num, &eol_num, buf,
559 *len);
560 break;
561 }
562 }
563 *len = eol_num;
564 buf[eol_num] = '\0'; /* lose the newline */
565
566 if (buf[0] /* && buf[0] != CREAD_HIST_CHAR */)
567 cread_add_to_hist(buf);
568 hist_cur = hist_add_idx;
569
570 return 0;
571 }
572
573 #endif /* CONFIG_CMDLINE_EDITING */
574
575 /****************************************************************************/
576
577 static int cli_readline_into_buffer(const FLASH char *const prompt, char *buffer)
578 {
579 char *p = buffer;
580 #ifdef CONFIG_CMDLINE_EDITING
581 uint_fast8_t len = CONFIG_SYS_CBSIZE;
582 int rc;
583 static bool initted;
584
585 if (!initted) {
586 hist_init();
587 initted = 1;
588 }
589
590 if (prompt)
591 my_puts_P(prompt);
592
593 rc = cread_line(prompt, p, &len);
594 return rc < 0 ? rc : (int) len;
595
596 #else /* CONFIG_CMDLINE_EDITING */
597 char *p_buf = p;
598 int n = 0; /* buffer index */
599 int plen = 0; /* prompt length */
600 int col; /* output column cnt */
601 char c;
602
603 /* print prompt */
604 if (prompt) {
605 plen = strlen_P(prompt);
606 my_puts_P(prompt);
607 }
608 col = plen;
609
610 for (;;) {
611
612 c = my_getchar(1);
613
614 /*
615 * Special character handling
616 */
617 switch (c) {
618 case '\r': /* Enter */
619 case '\n':
620 *p = '\0';
621 my_puts_P(PSTR("\r\n"));
622 return p - p_buf;
623
624 case '\0': /* nul */
625 continue;
626
627 case 0x03: /* ^C - break */
628 p_buf[0] = '\0'; /* discard input */
629 return -1;
630
631 case 0x15: /* ^U - erase line */
632 while (col > plen) {
633 my_puts_P(erase_seq);
634 --col;
635 }
636 p = p_buf;
637 n = 0;
638 continue;
639
640 case 0x17: /* ^W - erase word */
641 p = delete_char(p_buf, p, &col, &n, plen);
642 while ((n > 0) && (*p != ' '))
643 p = delete_char(p_buf, p, &col, &n, plen);
644 continue;
645
646 case 0x08: /* ^H - backspace */
647 case 0x7F: /* DEL - backspace */
648 p = delete_char(p_buf, p, &col, &n, plen);
649 continue;
650
651 default:
652 /*
653 * Must be a normal character then
654 */
655 if (n < CONFIG_SYS_CBSIZE-2) {
656 if (c == '\t') { /* expand TABs */
657 #ifdef CONFIG_AUTO_COMPLETE
658 /*
659 * if auto completion triggered just
660 * continue
661 */
662 *p = '\0';
663 if (cmd_auto_complete(prompt,
664 console_buffer,
665 &n, &col)) {
666 p = p_buf + n; /* reset */
667 continue;
668 }
669 #endif
670 my_puts_P(tab_seq + (col & 07));
671 col += 8 - (col & 07);
672 } else {
673 ++col;
674 putchar(c);
675 }
676 *p++ = c;
677 ++n;
678 } else { /* Buffer full */
679 putchar('\a');
680 }
681 }
682 }
683 #endif /* CONFIG_CMDLINE_EDITING */
684 }
685
686 int cli_readline(const FLASH char *const prompt)
687 {
688 /*
689 * If console_buffer isn't 0-length the user will be prompted to modify
690 * it instead of entering it from scratch as desired.
691 */
692 console_buffer[0] = '\0';
693
694 return cli_readline_into_buffer(prompt, console_buffer);
695 }
Z180 Stamp Monitor