Update ChangeLog and bump version for v1.17.0

Signed-off-by: Joachim Nilsson <troglobit@gmail.com>

.travis.yml

@@ -23,7 +23,7 @@ addons:
       description: "A small line editing library"
     notification_email: troglobit@gmail.com
     build_command_prepend: "./autogen.sh && ./configure --enable-sigstop --enable-terminal-bell"
-    build_command:   "make -j5"
+    build_command:   "make clean all"
     branch_pattern: dev
 
 # We don't store generated files (configure and Makefile) in GIT,
@@ -31,4 +31,4 @@ addons:
 script:
   - ./autogen.sh
   - ./configure --enable-sigstop --enable-terminal-bell 
-  - make -j5
+  - make clean all

ChangeLog.md

@@ -4,8 +4,23 @@ Change Log
 All notable changes to the project are documented in this file.
 
 
-[1.16.1] - 2019-06-07
----------------------
+[1.17.0][] - 2020-01-05
+-----------------------
+
+### Changes
+- Simple multi-line support by Dima Volynets, @dvolynets
+
+### Fixes
+- Fix return value from `read_history()` and `write_history()`, could
+  return `errno` instead of `EOF` to indicate error.  Now both functions
+  have uniform return values on error
+- Handle internal `realloc()` errors better.  Now memory is not leaked
+  if `realloc()` fails
+- Fix possible NULL pointer dereference in key binding lookup function
+
+
+[1.16.1][] - 2019-06-07
+-----------------------
 
 ### Changes
 - Major updates to the `editline.3` man page
@@ -222,7 +237,8 @@ Adaptations to Debian editline package.
 - First version, forked from Minix current 2008-06-06
 
 
-[UNRELEASED]:    https://github.com/troglobit/finit/compare/1.16.0...HEAD
+[UNRELEASED]:    https://github.com/troglobit/finit/compare/1.17.0...HEAD
+[1.17.0]:        https://github.com/troglobit/finit/compare/1.16.1...1.17.0
 [1.16.1]:        https://github.com/troglobit/finit/compare/1.16.0...1.16.1
 [1.16.0]:        https://github.com/troglobit/finit/compare/1.15.3...1.16.0
 [1.15.3]:        https://github.com/troglobit/finit/compare/1.15.2...1.15.3
@@ -240,9 +256,3 @@ Adaptations to Debian editline package.
 [Travis-CI]:     https://travis-ci.org/troglobit/uftpd
 [Coverity Scan]: https://scan.coverity.com/projects/2947
 [README.md]:     https://github.com/troglobit/editline/blob/master/README.md
-
-<!--
-  -- Local Variables:
-  -- mode: markdown
-  -- End:
-  -->

configure.ac

@@ -1,4 +1,4 @@
-AC_INIT(editline, 1.16.1, https://github.com/troglobit/editline/issues)
+AC_INIT(editline, 1.17.0, https://github.com/troglobit/editline/issues)
 AM_INIT_AUTOMAKE([1.11 foreign no-dist-gzip dist-xz])
 AM_SILENT_RULES([yes])
 

debian/changelog

@@ -1,3 +1,12 @@
+editline (1.17.0) unstable; urgency=medium
+
+  * Simple multi-line support
+  * Handle internal realloc() errors better
+  * Fix return value from read_history() and write_history()
+  * Fix potential NULL pointer dereference in key binging lookup
+
+ -- Joachim Nilsson <troglobit@gmail.com>  Sun, 05 Jan 2020 09:47:34 +0100
+
 editline (1.16.1) unstable; urgency=medium
 
   * Minor bug fix and documentation update release.

examples/cli.c

@@ -64,7 +64,10 @@ static int my_rl_list_possib(char *token, char ***av)
     for (num = 0; list[num]; num++)
 	;
 
-    copy = (char **) malloc (num * sizeof(char *));
+    if (!num)
+	return 0;
+
+    copy = malloc(num * sizeof(char *));
     for (i = 0; i < num; i++) {
 	if (!strncmp(list[i], token, strlen (token))) {
 	    copy[total] = strdup(list[i]);
@@ -106,14 +109,41 @@ el_status_t do_suspend(void)
 
 static void breakit(int signo)
 {
+    (void)signo;
     puts("Got SIGINT");
 }
 
+/* Use el_no_echo when reading passwords and similar */
+static int unlock(const char *passwd)
+{
+    char *prompt = "Enter password: ";
+    char *line;
+    int rc = 1;
+
+    el_no_echo = 1;
+
+    while ((line = readline(prompt))) {
+	rc = strncmp(line, passwd, strlen(passwd));
+	free(line);
+
+	if (rc) {
+	    printf("\nWrong password, please try again, it's secret.\n");
+	    continue;
+	}
+
+	printf("\nAchievement unlocked!\n");
+	break;
+    }
+
+    el_no_echo = 0;
+
+    return rc;
+}
+
 int main(void)
 {
     char *line;
     char *prompt = "cli> ";
-    char *passwd = "Enter password: ";
 
     signal(SIGINT, breakit);
 
@@ -126,29 +156,11 @@ int main(void)
     read_history(HISTORY);
 
     while ((line = readline(prompt))) {
-	int next = 0;
-
-	/* Use el_no_echo when reading passwords and similar */
-	if (!strncmp(line, "unlock", 6)) {
-	    el_no_echo = 1;
-	    while ((line = readline(passwd))) {
-		if (strncmp(line, "secret", 6)) {
-		    printf("\nWrong password, please try again, it's secret.\n");
+	if (!strncmp(line, "unlock", 6) && unlock("secret")) {
 	    free(line);
-		    continue;
-		}
-
-		el_no_echo = 0;
-
-		printf("\nAchievement unlocked!\n");
-		free(line);
-		next = 1;
+	    fprintf(stderr, "\nSecurity breach, user logged out!\n");
 	    break;
 	}
-	}
-
-	if (next)
-	    continue;
 
 	if (*line != '\0')
 	    printf("\t\t\t|%s|\n", line);

src/Makefile.am

@@ -3,4 +3,4 @@ libeditline_la_SOURCES  = editline.c editline.h complete.c sysunix.c unix.h
 libeditline_la_CFLAGS   = -std=gnu99
 libeditline_la_CFLAGS  += -W -Wall -Wextra -Wundef -Wunused -Wstrict-prototypes
 libeditline_la_CFLAGS  += -Werror-implicit-function-declaration -Wshadow -Wcast-qual
-libeditline_la_LDFLAGS  = $(AM_LDFLAGS) -version-info 1:1:0
+libeditline_la_LDFLAGS  = $(AM_LDFLAGS) -version-info 1:2:0

src/editline.c

@@ -113,6 +113,9 @@ static int        Searching = 0;
 static const char *(*search_move)(void);
 static const char *old_prompt = NULL;
 static rl_vcpfunc_t *line_handler = NULL;
+static char       *line_up = "\x1b[A";
+static char       *line_down = "\x1b[B";
+int prompt_len = 0;
 
 int               el_no_echo = 0; /* e.g., under Emacs */
 int               el_no_hist = 0;
@@ -134,7 +137,6 @@ extern char     *tgetstr(const char *, char **);
 extern int      tgetent(char *, const char *);
 extern int      tgetnum(const char *);
 #endif
-
 
 /*
 **  Misc. local helper functions.
@@ -176,8 +178,12 @@ static void tty_put(const char c)
 
     Screen[ScreenCount] = c;
     if (++ScreenCount >= ScreenSize) {
+	char *ptr;
+
         ScreenSize += SCREEN_INC;
-        Screen = realloc(Screen, sizeof(char) * ScreenSize);
+        ptr = realloc(Screen, sizeof(char) * ScreenSize);
+	if (ptr)
+	    Screen = ptr;
     }
 }
 
@@ -206,8 +212,13 @@ static void tty_show(unsigned char c)
 
 static void tty_string(char *p)
 {
-    while (*p)
+    int i = rl_point + prompt_len + 1;
+
+    while (*p) {
         tty_show(*p++);
+        if ((i++) % tty_cols == 0)
+            tty_put('\n');
+    }
 }
 
 static void tty_push(int c)
@@ -251,11 +262,18 @@ static void tty_backn(int n)
         tty_back();
 }
 
+static void tty_forwardn(int n)
+{
+    char buf[12];
+
+    snprintf(buf, sizeof(buf), "\x1b[%dC", n);
+    tty_puts(buf);
+}
+
 static void tty_info(void)
 {
     rl_reset_terminal(NULL);
 }
-
 
 /*
 **  Glue routines to rl_ttyset()
@@ -291,8 +309,10 @@ void el_print_columns(int ac, char **av)
         if ((j = strlen((char *)av[i])) > longest)
             longest = j;
     }
+
     colwidth = longest + 3;
-    if (colwidth > tty_cols) colwidth = tty_cols;
+    if (colwidth > tty_cols)
+        colwidth = tty_cols;
     cols = tty_cols / colwidth;
 
     tty_puts(NEWLINE);
@@ -311,20 +331,64 @@ void el_print_columns(int ac, char **av)
     }
 }
 
-static void reposition(void)
+static void reposition(int key)
 {
-    int i;
+    int len_with_prompt = prompt_len + rl_end;
+    int n =  len_with_prompt / tty_cols;                  /* determine the number of lines */
+    int i = 0;
 
     tty_put('\r');
+
+    if (n > 0) {
+        int line;
+
+	/* determine num of current line */
+        if (key == CTL('A') || key == CTL('E') || key == rl_kill)
+            line = (prompt_len + old_point) / tty_cols;
+        else
+            line = len_with_prompt / tty_cols;
+
+	/* move to end of line(s) */
+        if (key == CTL('E')) {
+	    int k;
+
+            for (k = line; k < n; k++)
+                tty_puts(line_down);
+
+	    /* determine reminder of last line and redraw only it */
+            i = rl_point - (len_with_prompt % tty_cols);
+        } else {
+	    int k;
+
+	    /* CTRL-A, CTRL-U, insert (end, middle), remove (end, middle) */
+            for (k = line; k > 0; k--)
+                tty_puts(line_up); /* redraw characters until changed data */
+
             tty_puts(rl_prompt);
-    for (i = 0; i < rl_point; i++)
+        }
+    } else if (n == 0) {
+        tty_puts(rl_prompt);
+    }
+
+    for (; i < rl_point; i++) {
         tty_show(rl_line_buffer[i]);
+
+	/* move to the next line */
+        if ((i + prompt_len + 1) % tty_cols == 0)
+            tty_put('\n');
+    }
 }
 
 static void left(el_status_t Change)
 {
     if (rl_point) {
+        if ((rl_point + prompt_len) % tty_cols == 0) {
+            tty_puts(line_up);
+            tty_forwardn(tty_cols);
+        } else {
             tty_back();
+        }
+
         if (ISMETA(rl_line_buffer[rl_point - 1])) {
             if (rl_meta_chars) {
                 tty_back();
@@ -341,6 +405,9 @@ static void left(el_status_t Change)
 
 static void right(el_status_t Change)
 {
+    if ((rl_point + prompt_len + 1) % tty_cols == 0)
+        tty_put('\n');
+    else
         tty_show(rl_line_buffer[rl_point]);
 
     if (Change == CSmove)
@@ -461,10 +528,14 @@ static void ceol(void)
     while (rl_point < 0) {
         tty_put(' ');
         rl_point++;
-	extras++;
     }
 
     for (i = rl_point, p = &rl_line_buffer[i]; i <= rl_end; i++, p++) {
+        if ((i + prompt_len + 1) % tty_cols == 0){
+            tty_put(' ');
+            tty_put('\n');
+        }
+        else
             tty_put(' ');
         if (ISMETA(*p)) {
             if (rl_meta_chars) {
@@ -478,15 +549,32 @@ static void ceol(void)
         }
     }
 
-    for (i += extras; i > rl_point; i--)
+    for (i += extras; i > rl_point; i--) {
+        if ((i + prompt_len) % tty_cols == 0) {
+            tty_puts(line_up);
+            tty_forwardn(tty_cols);
+        } else {
             tty_back();
         }
+    }
+}
 
 static void clear_line(void)
 {
+    int n = (rl_point + prompt_len) / tty_cols;
     rl_point = -(int)strlen(rl_prompt);
+
+    if (n > 0) {
+        for(int k = 0; k < n; k++)
+            tty_puts(line_up);
         tty_put('\r');
+    }
+    else {
+        tty_put('\r');
+    }
+
     ceol();
+
     rl_point = 0;
     rl_end = 0;
     rl_line_buffer[0] = '\0';
@@ -538,14 +626,15 @@ int rl_insert_text(const char *text)
 
 static el_status_t redisplay(int cls)
 {
-    if (cls && rl_point == 0 && rl_end == 0)
+    if (cls)
         tty_puts(CLEAR);
     else
         tty_puts("\r\e[K");
 
     tty_puts(rl_prompt);
+    rl_point = 0;
     tty_string(rl_line_buffer);
-
+    rl_point = rl_end;
     return CSmove;
 }
 
@@ -565,7 +654,6 @@ static el_status_t toggle_meta_mode(void)
     rl_meta_chars = ! rl_meta_chars;
     return redisplay(0);
 }
-
 
 const char *el_next_hist(void)
 {
@@ -585,7 +673,7 @@ static el_status_t do_insert_hist(const char *p)
     clear_line();
 
     rl_point = 0;
-    reposition();
+    reposition(EOF);
     rl_end = 0;
 
     return insert_string(p);
@@ -792,6 +880,7 @@ static el_status_t delete_string(int count)
     for (p = &rl_line_buffer[rl_point], i = rl_end - (rl_point + count) + 1; --i >= 0; p++)
         p[0] = p[count];
     ceol();
+
     rl_end -= count;
     tty_string(&rl_line_buffer[rl_point]);
 
@@ -832,7 +921,7 @@ static el_status_t kill_line(void)
         if (Repeat < rl_point) {
             i = rl_point;
             rl_point = Repeat;
-            reposition();
+            reposition(EOF);
             delete_string(i - rl_point);
         } else if (Repeat > rl_point) {
             right(CSmove);
@@ -1059,8 +1148,9 @@ static el_status_t tty_special(int c)
 
     if (c == rl_kill) {
         if (rl_point != 0) {
+            old_point = rl_point;
             rl_point = 0;
-            reposition();
+            reposition(c);
         }
         Repeat = NO_ARG;
 
@@ -1095,7 +1185,7 @@ static char *editinput(int complete)
             return (char *)"";
 
         case CSmove:
-	    reposition();
+            reposition(c);
             break;
 
         case CSdispatch:
@@ -1110,7 +1200,7 @@ static char *editinput(int complete)
                 return (char *)"";
 
             case CSmove:
-		reposition();
+                reposition(c);
                 break;
 
             case CSdispatch:
@@ -1175,9 +1265,12 @@ static char *read_redirected(void)
             int oldpos = end - line;
 
             size += MEM_INC;
-            p = line = realloc(line, sizeof(char) * size);
-	    if (!p)
+            p = realloc(line, sizeof(char) * size);
+            if (!p) {
+		free(line);
                 return NULL;
+	    }
+	    line = p;
             end = p + size;
 
             p += oldpos;        /* Continue where we left off... */
@@ -1334,6 +1427,8 @@ static int el_prep(const char *prompt)
         return -1;
 
     rl_prompt = prompt ? prompt : NILSTR;
+    prompt_len = strlen(rl_prompt);
+
     if (el_no_echo) {
         int old = el_no_echo;
 
@@ -1495,8 +1590,11 @@ int read_history(const char *filename)
     char buf[SCREEN_INC];
 
     hist_alloc();
+
     fp = fopen(filename, "r");
-    if (fp) {
+    if (!fp)
+	return EOF;
+
     H.Size = 0;
     while (H.Size < el_hist_size) {
 	if (!fgets(buf, SCREEN_INC, fp))
@@ -1509,17 +1607,16 @@ int read_history(const char *filename)
     return fclose(fp);
 }
 
-    return errno;
-}
-
 int write_history(const char *filename)
 {
     FILE *fp;
+    int i = 0;
 
     hist_alloc();
+
     fp = fopen(filename, "w");
-    if (fp) {
-	int i = 0;
+    if (!fp)
+	return EOF;
 
     while (i < H.Size)
 	fprintf(fp, "%s\n", H.Lines[i++]);
@@ -1527,10 +1624,6 @@ int write_history(const char *filename)
     return fclose(fp);
 }
 
-    return errno;
-}
-
-
 /*
 **  Move back to the beginning of the current word and return an
 **  allocated copy of it.
@@ -1906,7 +1999,7 @@ static size_t find_key_in_map(int key, el_keymap_t map[], size_t mapsz)
 {
     size_t i;
 
-    for (i = 0; map[i].Function && i < mapsz; i++) {
+    for (i = 0; i < mapsz && map[i].Function; i++) {
         if (map[i].Key == key)
             return i;
     }