]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - avr/cli_readline.c
cli_readline.c: code cleanup (history search)
[z180-stamp.git] / avr / cli_readline.c
index 8795a97f82ceda74bf30444c0a90ccf05cf269bc..c2e2326a61560f6d3de2e22290f2b9aa201469bf 100644 (file)
@@ -1,4 +1,6 @@
 /*
+ * (C) Copyright 2014-2016 Leo C. <erbl259-lmu@yahoo.de>
+ *
  * (C) Copyright 2000
  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  *
@@ -6,20 +8,21 @@
  * (C) Copyright 2005
  * JinHua Luo, GuangDong Linux Center, <luo.jinhua@gd-linux.com>
  *
- * SPDX-License-Identifier:    GPL-2.0+
+ * SPDX-License-Identifier:    GPL-2.0
  */
 
+#include "cli_readline.h"
 #include "common.h"
-
 #include <string.h>
 #include <stdio.h>
+#include <stdlib.h>
+#include <stdbool.h>
 #include <ctype.h>
 
 #include "config.h"
 #include "con-utils.h"
 #include "print-utils.h"
 #include "command.h"
-#include "cli_readline.h"
 
 
 
@@ -64,14 +67,14 @@ struct fkey_tbl_s {
 static const FLASH struct fkey_tbl_s fkey_table[] = {
 
 FKEY_TBL_ITEM(B,   KEY_DOWN),                  // Down arrow key
-FKEY_TBL_ITEM(A,   KEY_UP),                    // Up arrow key
+FKEY_TBL_ITEM(A,   KEY_UP),                            // Up arrow key
 FKEY_TBL_ITEM(D,   KEY_LEFT),                  // Left arrow key
-FKEY_TBL_ITEM(C,   KEY_RIGHT),         // Right arrow key
+FKEY_TBL_ITEM(C,   KEY_RIGHT),                 // Right arrow key
 FKEY_TBL_ITEM(1~,  KEY_HOME),                  // Home key
-FKEY_TBL_ITEM(3~,  KEY_DC),                    // Delete character key
-FKEY_TBL_ITEM(2~,  KEY_IC),                    // Ins char/toggle ins mode key
-FKEY_TBL_ITEM(6~,  KEY_NPAGE),         // Next-page key
-FKEY_TBL_ITEM(5~,  KEY_PPAGE),         // Previous-page key
+FKEY_TBL_ITEM(3~,  KEY_DC),                            // Delete character key
+FKEY_TBL_ITEM(2~,  KEY_IC),                            // Ins char/toggle ins mode key
+FKEY_TBL_ITEM(6~,  KEY_NPAGE),                 // Next-page key
+FKEY_TBL_ITEM(5~,  KEY_PPAGE),                 // Previous-page key
 FKEY_TBL_ITEM(4~,  KEY_END),                   // End key
 FKEY_TBL_ITEM(Z,   KEY_BTAB),                  // Back tab key
 /* VT400: */
@@ -91,9 +94,9 @@ FKEY_TBL_ITEM(17~, KEY_F(6)),                 // Function key F6
 FKEY_TBL_ITEM(18~, KEY_F(7)),                  // Function key F7
 FKEY_TBL_ITEM(19~, KEY_F(8)),                  // Function key F8
 FKEY_TBL_ITEM(20~, KEY_F(9)),                  // Function key F9
-FKEY_TBL_ITEM(21~, KEY_F(10)),         // Function key F10
-FKEY_TBL_ITEM(23~, KEY_F(11)),         // Function key F11
-FKEY_TBL_ITEM(24~, KEY_F(12)),         // Function key F12
+FKEY_TBL_ITEM(21~, KEY_F(10)),                 // Function key F10
+FKEY_TBL_ITEM(23~, KEY_F(11)),                 // Function key F11
+FKEY_TBL_ITEM(24~, KEY_F(12)),                 // Function key F12
 { NULL }       /* Mark end of table */
 };
 
@@ -186,49 +189,8 @@ int vt_parse (void)
 /************************************************************************************************/
 
 
-
-
-
 char console_buffer[CONFIG_SYS_CBSIZE + 1];    /* console I/O buffer   */
 
-#ifndef CONFIG_CMDLINE_EDITING
-static const FLASH char erase_seq[] = "\b \b";   /* erase sequence */
-static const FLASH char   tab_seq[] = "        "; /* used to expand TABs */
-
-static char *delete_char (char *buffer, char *p, int *colp, int *np, int plen)
-{
-       char *s;
-
-       if (*np == 0)
-               return p;
-
-       if (*(--p) == '\t') {           /* will retype the whole line */
-               while (*colp > plen) {
-                       my_puts_P(erase_seq);
-                       (*colp)--;
-               }
-               for (s = buffer; s < p; ++s) {
-                       if (*s == '\t') {
-                               my_puts_P(tab_seq + ((*colp) & 07));
-                               *colp += 8 - ((*colp) & 07);
-                       } else {
-                               ++(*colp);
-                               putchar(*s);
-                       }
-               }
-       } else {
-               my_puts_P(erase_seq);
-               (*colp)--;
-       }
-       (*np)--;
-
-       return p;
-}
-#endif /* CONFIG_CMDLINE_EDITING */
-
-
-#ifdef CONFIG_CMDLINE_EDITING
-
 /*
  * cmdline-editing related codes from vivi.
  * Author: Janghoon Lyu <nandy@mizi.com>
@@ -246,94 +208,151 @@ static void putnstr(char *str, int n)
 #define CTL_BACKSPACE          ('\b')
 #define DEL                                    ((char)255)
 #define DEL7                           ((char)127)
-#define CREAD_HIST_CHAR                ('!')
 
 #define getcmd_putch(ch)       putchar(ch)
 #define getcmd_getch()         vt_parse()
 #define getcmd_cbeep()         getcmd_putch('\a')
 
-#define HIST_MAX                       5
-#define HIST_SIZE                      CONFIG_SYS_CBSIZE
 
-static int hist_max;
-static int hist_add_idx;
-static int hist_cur = -1;
-static unsigned hist_num;
+struct hist_node_s {
+       struct hist_node_s *next;
+       char line[];
+};
+typedef struct hist_node_s hist_node;
 
-static char *hist_list[HIST_MAX];
-static char hist_lines[HIST_MAX][HIST_SIZE + 1];       /* Save room for NULL */
 
-#define add_idx_minus_one() ((hist_add_idx == 0) ? hist_max : hist_add_idx-1)
+static hist_node *hist_head;
+static hist_node *hist_cur;
 
-static void hist_init(void)
+static hist_node *hist_search_node(char *line)
 {
-       int i;
+       hist_node *p = hist_head;
 
-       hist_max = 0;
-       hist_add_idx = 0;
-       hist_cur = -1;
-       hist_num = 0;
+       while (p && strcmp(p->line, line))
+               p = p->next;
+       return p;
+}
 
-       for (i = 0; i < HIST_MAX; i++) {
-               hist_list[i] = hist_lines[i];
-               hist_list[i][0] = '\0';
+#if 0
+static hist_node *hist_insert(char *line)
+{
+       hist_node *p = (hist_node *) malloc(sizeof (hist_node) + strlen(line) + 1);
+
+       if (p) {
+               strcpy(p->line, line);
+               p->next = hist_head;
+               hist_head = p;
        }
+       return p;
 }
+#endif
 
-static void cread_add_to_hist(char *line)
+static hist_node *hist_new(char *line)
 {
-       strcpy(hist_list[hist_add_idx], line);
+       hist_node *p = (hist_node *) malloc(sizeof (hist_node) + strlen(line) + 1);
 
-       if (++hist_add_idx >= HIST_MAX)
-               hist_add_idx = 0;
+       if (p) {
+               strcpy(p->line, line);
+               p->next = NULL;
+       }
+       return p;
+}
 
-       if (hist_add_idx > hist_max)
-               hist_max = hist_add_idx;
+static hist_node *hist_delete(void)
+{
+       hist_node *p = NULL;
+       hist_node *q = hist_head;
 
-       hist_num++;
+       if (q) {
+               while(q->next) {
+                       p = q;
+                       q = q->next;
+               }
+               free(q);
+               if (p)
+                       p->next = NULL;
+       }
+       return p;
 }
 
-static char *hist_prev(void)
+static hist_node *hist_unlink(hist_node *pos)
 {
-       char *ret;
-       int old_cur;
+       hist_node *p = NULL;
+       hist_node *q = hist_head;
 
-       if (hist_cur < 0)
-               return NULL;
+       while(q && q != pos) {
+               p = q;
+               q = q->next;
+       }
+       if (q) {
+               if (p)
+                       p->next = q->next;
+               else
+                       hist_head = q->next;
+               q->next = NULL;
+       }
+       return q;
+}
+
+static uint_fast8_t hist_count(void)
+{
+       hist_node *p = hist_head;
+       uint_fast8_t n = 0;
 
-       old_cur = hist_cur;
-       if (--hist_cur < 0)
-               hist_cur = hist_max;
+       while (p) {
+               ++n;
+               p = p->next;
+       }
+       return n;
+}
 
-       if (hist_cur == hist_add_idx) {
-               hist_cur = old_cur;
-               ret = NULL;
-       } else {
-               ret = hist_list[hist_cur];
+static hist_node *cread_add_to_hist(char *line)
+{
+       hist_node * p;
+
+       p = hist_search_node(line);
+       if (p)
+               hist_unlink(p);
+       else
+               p = hist_new(line);
+
+       if (p) {
+               p->next = hist_head;
+               hist_head = p;
        }
 
-       return ret;
+       if (hist_count() > CONFIG_SYS_HIST_MAX)
+               hist_delete();
+       return p;
 }
 
-static char *hist_next(void)
+static char *hist_prev(void)
 {
-       char *ret;
+       hist_node *p = hist_cur;
 
-       if (hist_cur < 0)
+       if (p == NULL)
                return NULL;
 
-       if (hist_cur == hist_add_idx)
-               return NULL;
+       hist_cur = hist_cur->next;
 
-       if (++hist_cur > hist_max)
-               hist_cur = 0;
+       return  p->line;
+}
 
-       if (hist_cur == hist_add_idx)
-               ret = "";
-       else
-               ret = hist_list[hist_cur];
+static char *hist_next(void)
+{
+       hist_node *p = NULL;
+       hist_node *q = hist_head;
+
+       if(q == hist_cur)
+               return NULL;
 
-       return ret;
+       while(q->next != hist_cur) {
+               p = q;
+               q = q->next;
+       }
+       hist_cur = q;
+
+       return p ? p->line : "";
 }
 
 
@@ -356,16 +375,16 @@ static char *hist_next(void)
 
 #define REFRESH_TO_EOL() {                                                     \
        if (num < eol_num) {                                                       \
-               wlen = eol_num - num;                                                  \
+               uint_fast8_t wlen = eol_num - num;                                     \
                putnstr(buf + num, wlen);                                              \
                num = eol_num;                                                         \
        }                                                                          \
 }
 
-static void cread_add_char(char ichar, int insert, unsigned int *num,
-              unsigned int *eol_num, char *buf, unsigned int len)
+static void cread_add_char(char ichar, bool insert, uint_fast8_t *num,
+              uint_fast8_t *eol_num, char *buf, uint_fast8_t len)
 {
-       unsigned int wlen;
+       uint_fast8_t wlen;
 
        /* room ??? */
        if (insert || *num == *eol_num) {
@@ -395,9 +414,9 @@ static void cread_add_char(char ichar, int insert, unsigned int *num,
        }
 }
 
-static void cread_add_str(char *str, int strsize, int insert,
-                         unsigned int *num, unsigned int *eol_num,
-                         char *buf, unsigned int len)
+static void cread_add_str(char *str, uint_fast8_t strsize, bool insert,
+                         uint_fast8_t *num, uint_fast8_t *eol_num,
+                         char *buf, uint_fast8_t len)
 {
        while (strsize--) {
                cread_add_char(*str, insert, num, eol_num, buf, len);
@@ -405,22 +424,21 @@ static void cread_add_str(char *str, int strsize, int insert,
        }
 }
 
-static int cread_line(const FLASH char *const prompt, char *buf, unsigned int *len)
+static int cread_line(const FLASH char *const prompt, char *buf,
+                       uint_fast8_t *len, bool enable_history)
 {
-       unsigned int num = 0;
-       unsigned int eol_num = 0;
-       unsigned int wlen;
-       int ichar;
-       int insert = 1;
-       int init_len = strlen(buf);
+       uint_fast8_t num = 0;
+       uint_fast8_t eol_num = 0;
+       bool insert = 1;
 
        (void) prompt;
 
+       uint_fast8_t init_len = strlen(buf);
        if (init_len)
                cread_add_str(buf, init_len, 1, &num, &eol_num, buf, *len);
 
        while (1) {
-               ichar = getcmd_getch();
+               int ichar = getcmd_getch();
 
                if ((ichar == '\n') || (ichar == '\r')) {
                        putchar('\n');
@@ -434,27 +452,27 @@ static int cread_line(const FLASH char *const prompt, char *buf, unsigned int *l
                case CTL_CH('a'):
                        BEGINNING_OF_LINE();
                        break;
-               case CTL_CH('c'):       /* ^C - break */
-                       *buf = '\0';    /* discard input */
+               case CTL_CH('c'):                       /* ^C - break */
+                       *buf = '\0';                    /* discard input */
                        return -1;
                case KEY_RIGHT:
-               case CTL_CH('f'):
+               case CTL_CH('f'):                       /* forward-char */
                        if (num < eol_num) {
                                getcmd_putch(buf[num]);
                                num++;
                        }
                        break;
                case KEY_LEFT:
-               case CTL_CH('b'):
+               case CTL_CH('b'):                       /* backward-char */
                        if (num) {
                                getcmd_putch(CTL_BACKSPACE);
                                num--;
                        }
                        break;
                case KEY_DC:
-               case CTL_CH('d'):
+               case CTL_CH('d'):                       /* delete-char */
                        if (num < eol_num) {
-                               wlen = eol_num - num - 1;
+                               uint_fast8_t wlen = eol_num - num - 1;
                                if (wlen) {
                                        memmove(&buf[num], &buf[num+1], wlen);
                                        putnstr(buf + num, wlen);
@@ -467,9 +485,10 @@ static int cread_line(const FLASH char *const prompt, char *buf, unsigned int *l
                                eol_num--;
                        }
                        break;
-               case CTL_CH('k'):
+               case CTL_CH('k'):                       /* kill-line */
                        ERASE_TO_EOL();
                        break;
+               case KEY_END:
                case CTL_CH('e'):
                        REFRESH_TO_EOL();
                        break;
@@ -478,15 +497,15 @@ static int cread_line(const FLASH char *const prompt, char *buf, unsigned int *l
                        insert = !insert;
                        break;
                case CTL_CH('x'):
-               case CTL_CH('u'):
+               case CTL_CH('u'):                       /* kill-whole-line */
                        BEGINNING_OF_LINE();
                        ERASE_TO_EOL();
                        break;
                case DEL:
                case DEL7:
-               case 8:
+               case 8:                                         /* backward-delete-char */
                        if (num) {
-                               wlen = eol_num - num;
+                               uint_fast8_t wlen = eol_num - num;
                                num--;
                                memmove(&buf[num], &buf[num+1], wlen);
                                getcmd_putch(CTL_BACKSPACE);
@@ -499,35 +518,67 @@ static int cread_line(const FLASH char *const prompt, char *buf, unsigned int *l
                        }
                        break;
                case KEY_UP:
-               case CTL_CH('p'):
+               case CTL_CH('p'):                       /* previous-history */
                case KEY_DOWN:
-               case CTL_CH('n'):
-               {
-                       char *hline;
-
-                       if (ichar == CTL_CH('p') || ichar == KEY_UP)
-                               hline = hist_prev();
-                       else
-                               hline = hist_next();
-
-                       if (!hline) {
+               case CTL_CH('n'):                       /* next-history */
+                       if (enable_history) {
+                               char *hline;
+
+                               if (ichar == CTL_CH('p') || ichar == KEY_UP)
+                                       hline = hist_prev();
+                               else
+                                       hline = hist_next();
+
+                               if (hline) {
+                                       /* nuke the current line */
+                                       /* first, go home */
+                                       BEGINNING_OF_LINE();
+
+                                       /* erase to end of line */
+                                       ERASE_TO_EOL();
+
+                                       /* copy new line into place and display */
+                                       strcpy(buf, hline);
+                                       eol_num = strlen(buf);
+                                       REFRESH_TO_EOL();
+                               } else {
+                                       getcmd_cbeep();
+                               }
+                       } else {
                                getcmd_cbeep();
-                               continue;
                        }
-
-                       /* nuke the current line */
-                       /* first, go home */
-                       BEGINNING_OF_LINE();
-
-                       /* erase to end of line */
-                       ERASE_TO_EOL();
-
-                       /* copy new line into place and display */
-                       strcpy(buf, hline);
-                       eol_num = strlen(buf);
-                       REFRESH_TO_EOL();
-                       continue;
-               }
+                       break;
+#if 0
+               case KEY_PPAGE:                 /* history-search-backward */
+               case KEY_NPAGE:                 /* history-search-forward */
+                       if (enable_history) {
+                               char *hline;
+
+                               if (ichar == KEY_PPAGE)
+                                       hline = hist_search_backward();
+                               else
+                                       hline = hist_search_forward();
+
+                               if (hline) {
+                                       /* nuke the current line */
+                                       /* first, go home */
+                                       BEGINNING_OF_LINE();
+
+                                       /* erase to end of line */
+                                       ERASE_TO_EOL();
+
+                                       /* copy new line into place and display */
+                                       strcpy(buf, hline);
+                                       eol_num = strlen(buf);
+                                       REFRESH_TO_EOL();
+                               } else {
+                                       getcmd_cbeep();
+                               }
+                       } else {
+                               getcmd_cbeep();
+                       }
+                       break;
+#endif
 #ifdef CONFIG_AUTO_COMPLETE
                case '\t': {
                        int num2, col;
@@ -559,135 +610,30 @@ static int cread_line(const FLASH char *const prompt, char *buf, unsigned int *l
        *len = eol_num;
        buf[eol_num] = '\0';    /* lose the newline */
 
-       if (buf[0] /* && buf[0] != CREAD_HIST_CHAR */)
-               cread_add_to_hist(buf);
-       hist_cur = hist_add_idx;
-
+       if (enable_history) {
+               if (buf[0])
+               hist_cur = cread_add_to_hist(buf);
+       }
        return 0;
 }
 
-#endif /* CONFIG_CMDLINE_EDITING */
-
 /****************************************************************************/
 
-static int cli_readline_into_buffer(const FLASH char *const prompt, char *buffer)
+static int cli_readline_into_buffer(const FLASH char *const prompt,
+                       char *buffer, bool enable_history)
 {
        char *p = buffer;
-#ifdef CONFIG_CMDLINE_EDITING
-       unsigned int len = CONFIG_SYS_CBSIZE;
+       uint_fast8_t len = CONFIG_SYS_CBSIZE;
        int rc;
-       static int initted;
-
-       if (!initted) {
-               hist_init();
-               initted = 1;
-       }
 
        if (prompt)
                my_puts_P(prompt);
 
-       rc = cread_line(prompt, p, &len);
+       rc = cread_line(prompt, p, &len, enable_history);
        return rc < 0 ? rc : (int) len;
-
-#else  /* CONFIG_CMDLINE_EDITING */
-       char *p_buf = p;
-       int     n = 0;                          /* buffer index         */
-       int     plen = 0;                       /* prompt length        */
-       int     col;                            /* output column cnt    */
-       char    c;
-
-       /* print prompt */
-       if (prompt) {
-               plen = strlen_P(prompt);
-               my_puts_P(prompt);
-       }
-       col = plen;
-
-       for (;;) {
-
-               c = my_getchar(1);
-
-               /*
-                * Special character handling
-                */
-               switch (c) {
-               case '\r':                      /* Enter                */
-               case '\n':
-                       *p = '\0';
-                       my_puts_P(PSTR("\r\n"));
-                       return p - p_buf;
-
-               case '\0':                      /* nul                  */
-                       continue;
-
-               case 0x03:                      /* ^C - break           */
-                       p_buf[0] = '\0';        /* discard input */
-                       return -1;
-
-               case 0x15:                      /* ^U - erase line      */
-                       while (col > plen) {
-                               my_puts_P(erase_seq);
-                               --col;
-                       }
-                       p = p_buf;
-                       n = 0;
-                       continue;
-
-               case 0x17:                      /* ^W - erase word      */
-                       p = delete_char(p_buf, p, &col, &n, plen);
-                       while ((n > 0) && (*p != ' '))
-                               p = delete_char(p_buf, p, &col, &n, plen);
-                       continue;
-
-               case 0x08:                      /* ^H  - backspace      */
-               case 0x7F:                      /* DEL - backspace      */
-                       p = delete_char(p_buf, p, &col, &n, plen);
-                       continue;
-
-               default:
-                       /*
-                        * Must be a normal character then
-                        */
-                       if (n < CONFIG_SYS_CBSIZE-2) {
-                               if (c == '\t') {        /* expand TABs */
-#ifdef CONFIG_AUTO_COMPLETE
-                                       /*
-                                        * if auto completion triggered just
-                                        * continue
-                                        */
-                                       *p = '\0';
-                                       if (cmd_auto_complete(prompt,
-                                                             console_buffer,
-                                                             &n, &col)) {
-                                               p = p_buf + n;  /* reset */
-                                               continue;
-                                       }
-#endif
-                                       my_puts_P(tab_seq + (col & 07));
-                                       col += 8 - (col & 07);
-                               } else {
-                                       char buf[2];
-
-                                       /*
-                                        * Echo input using puts() to force an
-                                        * LCD flush if we are using an LCD
-                                        */
-                                       ++col;
-                                       buf[0] = c;
-                                       buf[1] = '\0';
-                                       my_puts(buf);
-                               }
-                               *p++ = c;
-                               ++n;
-                       } else {                        /* Buffer full */
-                               putchar('\a');
-                       }
-               }
-       }
-#endif /* CONFIG_CMDLINE_EDITING */
 }
 
-int cli_readline(const FLASH char *const prompt)
+int cli_readline(const FLASH char *const prompt, bool enable_history)
 {
        /*
         * If console_buffer isn't 0-length the user will be prompted to modify
@@ -695,5 +641,5 @@ int cli_readline(const FLASH char *const prompt)
         */
        console_buffer[0] = '\0';
 
-       return cli_readline_into_buffer(prompt, console_buffer);
+       return cli_readline_into_buffer(prompt, console_buffer, enable_history);
 }