]> cloudbase.mooo.com Git - z180-stamp.git/blob - avr/cli_readline.c
projects / z180-stamp.git / blob
? search:


6aef92e301084cd38fc3a5d88947969b7c182822
[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 cread_add_to_hist(char *line)
263 {
264 if (hist_max) {
265 int_fast8_t last = hist_add_idx;
266 if (--last < 0)
267 last = hist_max;
268
269 if (!strcmp(line, hist_list[last]))
270 return;
271 }
272
273 char *p = strdup(line);
274 if (p) {
275 free(hist_list[hist_add_idx]);
276 hist_list[hist_add_idx] = p;
277
278 if (++hist_add_idx >= HIST_MAX)
279 hist_add_idx = 0;
280
281 if (hist_add_idx > hist_max)
282 hist_max = hist_add_idx;
283 }
284 }
285
286 static char *hist_prev(void)
287 {
288 char *ret;
289 int_fast8_t old_cur;
290
291 if (hist_cur < 0)
292 return NULL;
293
294 old_cur = hist_cur;
295 if (--hist_cur < 0)
296 hist_cur = hist_max;
297
298 if (hist_cur == hist_add_idx) {
299 hist_cur = old_cur;
300 ret = NULL;
301 } else {
302 ret = hist_list[hist_cur];
303 }
304
305 return ret;
306 }
307
308 static char *hist_next(void)
309 {
310 char *ret;
311
312 if (hist_cur < 0)
313 return NULL;
314
315 if (hist_cur == hist_add_idx)
316 return NULL;
317
318 if (++hist_cur > hist_max)
319 hist_cur = 0;
320
321 if (hist_cur == hist_add_idx)
322 ret = "";
323 else
324 ret = hist_list[hist_cur];
325
326 return ret;
327 }
328
329
330 #define BEGINNING_OF_LINE() { \
331 while (num) { \
332 getcmd_putch(CTL_BACKSPACE); \
333 num--; \
334 } \
335 }
336
337 #define ERASE_TO_EOL() { \
338 if (num < eol_num) { \
339 /* printf_P(PSTR("%*S"), (int)(eol_num - num), PSTR("")); */ \
340 print_blanks(eol_num - num); \
341 do { \
342 getcmd_putch(CTL_BACKSPACE); \
343 } while (--eol_num > num); \
344 } \
345 }
346
347 #define REFRESH_TO_EOL() { \
348 if (num < eol_num) { \
349 wlen = eol_num - num; \
350 putnstr(buf + num, wlen); \
351 num = eol_num; \
352 } \
353 }
354
355 static void cread_add_char(char ichar, bool insert, uint_fast8_t *num,
356 uint_fast8_t *eol_num, char *buf, uint_fast8_t len)
357 {
358 uint_fast8_t wlen;
359
360 /* room ??? */
361 if (insert || *num == *eol_num) {
362 if (*eol_num > len - 1) {
363 getcmd_cbeep();
364 return;
365 }
366 (*eol_num)++;
367 }
368
369 if (insert) {
370 wlen = *eol_num - *num;
371 if (wlen > 1)
372 memmove(&buf[*num+1], &buf[*num], wlen-1);
373
374 buf[*num] = ichar;
375 putnstr(buf + *num, wlen);
376 (*num)++;
377 while (--wlen)
378 getcmd_putch(CTL_BACKSPACE);
379 } else {
380 /* echo the character */
381 wlen = 1;
382 buf[*num] = ichar;
383 putnstr(buf + *num, wlen);
384 (*num)++;
385 }
386 }
387
388 static void cread_add_str(char *str, int strsize, bool insert,
389 uint_fast8_t *num, uint_fast8_t *eol_num,
390 char *buf, uint_fast8_t len)
391 {
392 while (strsize--) {
393 cread_add_char(*str, insert, num, eol_num, buf, len);
394 str++;
395 }
396 }
397
398 static int cread_line(const FLASH char *const prompt, char *buf, uint_fast8_t *len)
399 {
400 uint_fast8_t num = 0;
401 uint_fast8_t eol_num = 0;
402 uint_fast8_t wlen;
403 int ichar;
404 bool insert = 1;
405 int init_len = strlen(buf);
406
407 (void) prompt;
408
409 if (init_len)
410 cread_add_str(buf, init_len, 1, &num, &eol_num, buf, *len);
411
412 while (1) {
413 ichar = getcmd_getch();
414
415 if ((ichar == '\n') || (ichar == '\r')) {
416 putchar('\n');
417 break;
418 }
419
420
421 switch (ichar) {
422
423 case KEY_HOME:
424 case CTL_CH('a'):
425 BEGINNING_OF_LINE();
426 break;
427 case CTL_CH('c'): /* ^C - break */
428 *buf = '\0'; /* discard input */
429 return -1;
430 case KEY_RIGHT:
431 case CTL_CH('f'): /* forward-char */
432 if (num < eol_num) {
433 getcmd_putch(buf[num]);
434 num++;
435 }
436 break;
437 case KEY_LEFT:
438 case CTL_CH('b'): /* backward-char */
439 if (num) {
440 getcmd_putch(CTL_BACKSPACE);
441 num--;
442 }
443 break;
444 case KEY_DC:
445 case CTL_CH('d'): /* delete-char */
446 if (num < eol_num) {
447 wlen = eol_num - num - 1;
448 if (wlen) {
449 memmove(&buf[num], &buf[num+1], wlen);
450 putnstr(buf + num, wlen);
451 }
452
453 getcmd_putch(' ');
454 do {
455 getcmd_putch(CTL_BACKSPACE);
456 } while (wlen--);
457 eol_num--;
458 }
459 break;
460 case CTL_CH('k'): /* kill-line */
461 ERASE_TO_EOL();
462 break;
463 case KEY_END:
464 case CTL_CH('e'):
465 REFRESH_TO_EOL();
466 break;
467 case KEY_IC:
468 case CTL_CH('o'):
469 insert = !insert;
470 break;
471 case CTL_CH('x'):
472 case CTL_CH('u'): /* kill-whole-line */
473 BEGINNING_OF_LINE();
474 ERASE_TO_EOL();
475 break;
476 case DEL:
477 case DEL7:
478 case 8: /* backward-delete-char */
479 if (num) {
480 wlen = eol_num - num;
481 num--;
482 memmove(&buf[num], &buf[num+1], wlen);
483 getcmd_putch(CTL_BACKSPACE);
484 putnstr(buf + num, wlen);
485 getcmd_putch(' ');
486 do {
487 getcmd_putch(CTL_BACKSPACE);
488 } while (wlen--);
489 eol_num--;
490 }
491 break;
492 case KEY_UP:
493 case CTL_CH('p'): /* previous-history */
494 case KEY_DOWN:
495 case CTL_CH('n'): /* next-history */
496 {
497 char *hline;
498
499 if (ichar == CTL_CH('p') || ichar == KEY_UP)
500 hline = hist_prev();
501 else
502 hline = hist_next();
503
504 if (!hline) {
505 getcmd_cbeep();
506 continue;
507 }
508
509 /* nuke the current line */
510 /* first, go home */
511 BEGINNING_OF_LINE();
512
513 /* erase to end of line */
514 ERASE_TO_EOL();
515
516 /* copy new line into place and display */
517 strcpy(buf, hline);
518 eol_num = strlen(buf);
519 REFRESH_TO_EOL();
520 continue;
521 }
522 #ifdef CONFIG_AUTO_COMPLETE
523 case '\t': {
524 int num2, col;
525
526 /* do not autocomplete when in the middle */
527 if (num < eol_num) {
528 getcmd_cbeep();
529 break;
530 }
531
532 buf[num] = '\0';
533 col = strlen_P(prompt) + eol_num;
534 num2 = num;
535 if (cmd_auto_complete(prompt, buf, &num2, &col)) {
536 col = num2 - num;
537 num += col;
538 eol_num += col;
539 }
540 break;
541 }
542 #endif
543 default:
544 if (isprint(ichar))
545 cread_add_char(ichar, insert, &num, &eol_num, buf,
546 *len);
547 break;
548 }
549 }
550 *len = eol_num;
551 buf[eol_num] = '\0'; /* lose the newline */
552
553 if (buf[0] /* && buf[0] != CREAD_HIST_CHAR */)
554 cread_add_to_hist(buf);
555 hist_cur = hist_add_idx;
556
557 return 0;
558 }
559
560 #endif /* CONFIG_CMDLINE_EDITING */
561
562 /****************************************************************************/
563
564 static int cli_readline_into_buffer(const FLASH char *const prompt, char *buffer)
565 {
566 char *p = buffer;
567 #ifdef CONFIG_CMDLINE_EDITING
568 uint_fast8_t len = CONFIG_SYS_CBSIZE;
569 int rc;
570
571 if (prompt)
572 my_puts_P(prompt);
573
574 rc = cread_line(prompt, p, &len);
575 return rc < 0 ? rc : (int) len;
576
577 #else /* CONFIG_CMDLINE_EDITING */
578 char *p_buf = p;
579 int n = 0; /* buffer index */
580 int plen = 0; /* prompt length */
581 int col; /* output column cnt */
582 char c;
583
584 /* print prompt */
585 if (prompt) {
586 plen = strlen_P(prompt);
587 my_puts_P(prompt);
588 }
589 col = plen;
590
591 for (;;) {
592
593 c = my_getchar(1);
594
595 /*
596 * Special character handling
597 */
598 switch (c) {
599 case '\r': /* Enter */
600 case '\n':
601 *p = '\0';
602 my_puts_P(PSTR("\r\n"));
603 return p - p_buf;
604
605 case '\0': /* nul */
606 continue;
607
608 case 0x03: /* ^C - break */
609 p_buf[0] = '\0'; /* discard input */
610 return -1;
611
612 case 0x15: /* ^U - erase line */
613 while (col > plen) {
614 my_puts_P(erase_seq);
615 --col;
616 }
617 p = p_buf;
618 n = 0;
619 continue;
620
621 case 0x17: /* ^W - erase word */
622 p = delete_char(p_buf, p, &col, &n, plen);
623 while ((n > 0) && (*p != ' '))
624 p = delete_char(p_buf, p, &col, &n, plen);
625 continue;
626
627 case 0x08: /* ^H - backspace */
628 case 0x7F: /* DEL - backspace */
629 p = delete_char(p_buf, p, &col, &n, plen);
630 continue;
631
632 default:
633 /*
634 * Must be a normal character then
635 */
636 if (n < CONFIG_SYS_CBSIZE-2) {
637 if (c == '\t') { /* expand TABs */
638 #ifdef CONFIG_AUTO_COMPLETE
639 /*
640 * if auto completion triggered just
641 * continue
642 */
643 *p = '\0';
644 if (cmd_auto_complete(prompt,
645 console_buffer,
646 &n, &col)) {
647 p = p_buf + n; /* reset */
648 continue;
649 }
650 #endif
651 my_puts_P(tab_seq + (col & 07));
652 col += 8 - (col & 07);
653 } else {
654 ++col;
655 putchar(c);
656 }
657 *p++ = c;
658 ++n;
659 } else { /* Buffer full */
660 putchar('\a');
661 }
662 }
663 }
664 #endif /* CONFIG_CMDLINE_EDITING */
665 }
666
667 int cli_readline(const FLASH char *const prompt)
668 {
669 /*
670 * If console_buffer isn't 0-length the user will be prompted to modify
671 * it instead of entering it from scratch as desired.
672 */
673 console_buffer[0] = '\0';
674
675 return cli_readline_into_buffer(prompt, console_buffer);
676 }
Z180 Stamp Monitor