Merge pull request #74 from tgree/macos_prototypes_fix

Fix function prototypes

.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,6 +4,52 @@ Change Log
 All notable changes to the project are documented in this file.
 
 
+[1.17.1][] - 2020-02-23
+-----------------------
+
+### Fixes
+- Fix #38: Fix for multiline representing as one line
+- Fix packaging, missing files in libeditline1, regression from 1.16.0
+- Fix packaging, update to latest std version
+- Fix formatting of function names in man page
+- Restore tar.gz distribution, for usability on systems that do not
+  have xz in their default install
+
+
+[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
+- Cleanup of examples `cli.c` and `fileman.c`
+- Add example of hidden input prompt to `cli.c`
+
+### Fixes
+- Fix #20: `configure --disable-eof` does not bite
+- Fix #23: Make Ctrl-L clear the screan instead of starting a new line  
+  Like Ctrl-D, which exits, Ctrl-L only clears the screen when the line
+  is empty and the cursor is at the start of the line, otherwise Ctrl-L
+  will redraw/refresh the current line.
+- Fix #24: Fix behavior when TTY is narrower than column width, by Will Dietz
+- Fix #25: Avoid continuously duplicate commands in history
+- Fix #31: Aborting i-search with Ctrl-C should not generate signal
+
+
 [1.16.0][] - 2018-09-16
 -----------------------
 
@@ -203,7 +249,10 @@ 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.1...HEAD
+[1.17.1]:        https://github.com/troglobit/finit/compare/1.17.0...1.17.1
+[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
 [1.15.2]:        https://github.com/troglobit/finit/compare/1.15.1...1.15.2
@@ -220,9 +269,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:
-  -->

Makefile.am

@@ -2,11 +2,11 @@ pkgconfigdir    = $(libdir)/pkgconfig
 pkgconfig_DATA  = libeditline.pc
 doc_DATA        = README.md LICENSE
 EXTRA_DIST      = README.md LICENSE ChangeLog.md INSTALL.md
-SUBDIRS         = src include man examples
+SUBDIRS         = src include man
 
-## Generate .deb package
-package build-deb:
-	@dpkg-buildpackage -uc -us
+if ENABLE_EXAMPLES
+SUBDIRS            += examples
+endif
 
 ## Generate MD5 checksum file
 MD5 = md5sum
@@ -39,7 +39,7 @@ package:
 	dpkg-buildpackage -uc -us -B
 
 ## Target to run when building a release
-release: distcheck release-hook md5-dist package
+release: release-hook distcheck md5-dist package
 	@echo
 	@echo "Resulting release files:"
 	@echo "========================================================================="

README.md

@@ -33,13 +33,17 @@ to use the library is available in the `examples/` directory.
 
 Editline is maintained collaboratively at [GitHub][].
 
+> **Note:** Windows is not a supported target for editline.
+
 
 Example
 -------
 
-Here is a very brief example to illustrate how one can use Editline to
-create a simple CLI, use Ctrl-D to exit the program.  More examples are
-availble in the source tree.
+Below is a very brief example to illustrate how one can use Editline to
+create a simple CLI, Ctrl-D exits the program.  A slightly more advanced
+example is Jush, <https://github.com/troglobit/jush/>, a small and very
+simplistic UNIX shell.  The Editline sources also include an `examples/`
+sub-directory.
 
 1. Build and install the library, preferably using a [release tarball][]
    The configure script defaults to a `/usr/local` prefix.
@@ -54,6 +58,7 @@ availble in the source tree.
    e.g. `~/src/example.c`
 
 ```C
+    #include <stdio.h>
     #include <stdlib.h>
     #include <editline.h>
 
@@ -193,6 +198,7 @@ current maintainer works exclusively on GNU/Linux systems, so it may use
 GCC and  GNU Make specific  extensions here and  there.  This is  not on
 purpose and patches or pull requests to correct this are most welcome!
 
+0. Call <kbd>./autogen.sh</kbd> if you build from git
 1. Configure editline with default features: <kbd>./configure</kbd>
 2. Build the library and examples: <kbd>make all</kbd>
 3. Install using <kbd>make install</kbd>
@@ -221,7 +227,7 @@ similar to the [BSD license][].  Rich's current version is however under
 the Apache license.  For details on  the licensing terms of this version
 of the software, see [License][].
 
-This version  of the editline  library was  forked from the  [Minix 3][]
+This version  of the editline  library was  forked from the  [Minix 2][]
 source tree and is *not* related  to the similarily named NetBSD version
 that [Jess Thrysøe][jess]  disitributes to the world  outside *BSD.  The
 libraries have much in common, but  the latter is heavily refactored and
@@ -255,7 +261,7 @@ Outstanding issues are listed in the [TODO.md][] file.
 [FSF readline]:    http://www.gnu.org/software/readline/
 [Rich Salz]:       https://github.com/richsalz/editline/
 [comp.sources.unix]: http://ftp.cs.toronto.edu/pub/white/pub/rc/editline.shar
-[Minix 3]:         http://www.cise.ufl.edu/~cop4600/cgi-bin/lxr/http/source.cgi/lib/editline/
+[Minix 2]:         http://www.cise.ufl.edu/~cop4600/cgi-bin/lxr/http/source.cgi/lib/editline/
 [jess]:            http://thrysoee.dk/editline/
 [BSD license]:     http://en.wikipedia.org/wiki/BSD_licenses
 [libeditline]:     http://packages.qa.debian.org/e/editline.html

configure.ac

@@ -1,5 +1,6 @@
-AC_INIT(editline, 1.16.0, https://github.com/troglobit/editline/issues)
-AM_INIT_AUTOMAKE([1.11 foreign no-dist-gzip dist-xz])
+AC_INIT(editline, 1.17.1, https://github.com/troglobit/editline/issues)
+AC_CONFIG_AUX_DIR(aux)
+AM_INIT_AUTOMAKE([1.11 foreign dist-xz])
 AM_SILENT_RULES([yes])
 
 AC_CONFIG_MACRO_DIR([m4])
@@ -60,29 +61,35 @@ AC_ARG_ENABLE(terminal-bell,
 AC_ARG_ENABLE(termcap,
    AS_HELP_STRING([--enable-termcap], [Use termcap library to query terminal size.]))
 
+AC_ARG_ENABLE([examples],
+	[AC_HELP_STRING([--enable-examples], [Build examples/ directory])],
+	[], [enable_examples=no])
+
 #
 # Check what features have been enabled
 #
-AS_IF([test "x$enable_unique_history" != "xno"],
-   AC_DEFINE(CONFIG_UNIQUE_HISTORY, 1, [Define to skip duplicate lines in the scrollback history.]))
+AS_IF([test "x$enable_unique_history" != "xno"], [
+   AC_DEFINE(CONFIG_UNIQUE_HISTORY, 1, [Define to skip duplicate lines in the scrollback history.])])
 
-AS_IF([test "x$enable_terminal_bell" != "xno"],
-   AC_DEFINE(CONFIG_ANSI_ARROWS, 1, [Define to include ANSI arrow keys support.]))
+AS_IF([test "x$enable_terminal_bell" != "xno"], [
+   AC_DEFINE(CONFIG_ANSI_ARROWS, 1, [Define to include ANSI arrow keys support.])])
 
-AS_IF([test "x$enable_terminal_bell" != "xno"],
-   AC_DEFINE(CONFIG_EOF, 1, [Define to enable EOF (Ctrl-C) key.]))
+AS_IF([test "x$enable_eof" != "xno"], [
+   AC_DEFINE(CONFIG_EOF, 1, [Define to enable EOF (Ctrl-D) key.])])
 
-AS_IF([test "x$enable_sigint" != "xno"],
-   AC_DEFINE(CONFIG_SIGINT, 1, [Define to enable SIGINT (Ctrl-C) key.]))
+AS_IF([test "x$enable_sigint" != "xno"], [
+   AC_DEFINE(CONFIG_SIGINT, 1, [Define to enable SIGINT (Ctrl-C) key.])])
 
-AS_IF([test "x$enable_sigstop" = "xyes"],
-   AC_DEFINE(CONFIG_SIGSTOP, 1, [Define to enable SIGSTOP (Ctrl-Z) key.]))
+AS_IF([test "x$enable_sigstop" = "xyes"], [
+   AC_DEFINE(CONFIG_SIGSTOP, 1, [Define to enable SIGSTOP (Ctrl-Z) key.])])
 
-AS_IF([test "x$enable_terminal_bell" = "xyes"],
-   AC_DEFINE(CONFIG_TERMINAL_BELL, 1, [Define to enable terminal bell on completion.]))
+AS_IF([test "x$enable_terminal_bell" = "xyes"], [
+   AC_DEFINE(CONFIG_TERMINAL_BELL, 1, [Define to enable terminal bell on completion.])])
+
+AM_CONDITIONAL([ENABLE_EXAMPLES], [test "$enable_examples" = yes])
 
 # Check for a termcap compatible library if enabled
-AS_IF([test "x$enable_termcap" = "xyes"],
+AS_IF([test "x$enable_termcap" = "xyes"], [
    AC_DEFINE(CONFIG_USE_TERMCAP, 1, [Define to use the termcap library for terminal size.])
    AC_CHECK_LIB(terminfo, tgetent, , [
       AC_CHECK_LIB(termcap, tgetent, , [
@@ -93,7 +100,7 @@ AS_IF([test "x$enable_termcap" = "xyes"],
                ])
             ])
          ])
-      ]))
+      ])])
 
 # Generate all files
 AC_OUTPUT

debian/changelog

@@ -1,3 +1,27 @@
+editline (1.17.1) stable; urgency=medium
+
+  * Fix multiline representing as one line
+  * Fix missing content in libedtline1, introduced in 1.16.0
+  * Update packaging to latest std version
+
+ -- Joachim Nilsson <troglobit@gmail.com>  Sun, 23 Feb 2020 18:46:41 +0100
+
+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.
+  * Add missing pkg-config .pc file to -dev package
+
+ -- Joachim Nilsson <troglobit@gmail.com>  Fri, 07 Jun 2019 11:45:50 +0200
+
 editline (1.16.0) unstable; urgency=medium
 
   * New upstream release, v1.60.0

debian/compat

@@ -1 +1 @@
-9
+10

debian/control

@@ -1,9 +1,9 @@
 Source: editline
 Section: devel
 Priority: optional
-Build-Depends: debhelper (>= 5.0), libtool
-Maintainer: Joachim Nilsson <troglobit@gmail.com>
-Standards-Version: 3.8.3
+Build-Depends: debhelper (>= 10), libtool
+Maintainer: Joachim Wiberg <troglobit@gmail.com>
+Standards-Version: 4.3.0
 
 Package: libeditline-dev
 Architecture: any

debian/copyright

@@ -1,17 +1,23 @@
-This package was debianized by Jim Studt <jim@federated.com> on
-Fri,  5 May 2000 13:25:51 -0500.
+Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: editline
+Upstream-Contact: Joachim Wiberg <troglobit@gmail.com>
+Source: http://github.com/troglobit/editline
+Comment: This package was originally debianized by Jim Studt <jim@federated.com>
+	 on Fri,  5 May 2000 13:25:51 -0500.  It was received from, then upstream
+	 author, Rich Salz <rsalz@shore.net>
 
-It was received from Rich Salz rsalz@shore.net
+Files: *
+Copyright: 1992,1993 Simmule Turner and Rich Salz.
+License: C-News
 
-Upstream Author: Rich Salz rsalz@shore.net
-
-Copyright:
-
- Copyright 1992,1993 Simmule Turner and Rich Salz.  All rights reserved.
+Files: debian/*
+Copyright: 2010-2020 Joachim Wiberg <troglobit@gmail.com>
+License: BSD-2-clause
 
+License: C-News
  This software is not subject to any license of the American Telephone
  and Telegraph Company or of the Regents of the University of California.
-
+ .
  Permission is granted to anyone to use this software for any purpose on
  any computer system, and to alter it and redistribute it freely, subject
  to the following restrictions:
@@ -24,4 +30,3 @@ Copyright:
     misrepresented as being the original software.  Since few users
     ever read sources, credits must appear in the documentation.
  4. This notice may not be removed or altered.
-

debian/libeditline-dev.install

@@ -1,3 +1,5 @@
 usr/include/*.h
 usr/lib/*/libeditline*.*a
+usr/lib/*/libeditline.so
+usr/lib/*/pkgconfig/*
 usr/share/man/man3/*

debian/libeditline0.install

@@ -1 +0,0 @@
-usr/lib/*/libeditline*.so*

debian/libeditline1.install

@@ -0,0 +1 @@
+usr/lib/*/libeditline.so.*

debian/libeditline1.symbols

@@ -0,0 +1,67 @@
+libeditline.so.1 libeditline1 #MINVER#
+* Build-Depends-Package: libeditline-dev
+ add_history@Base 1.17.1
+ el_bind_key@Base 1.17.1
+ el_bind_key_in_metamap@Base 1.17.1
+ el_del_char@Base 1.17.1
+ el_filename_complete@Base 1.17.1
+ el_filename_list_possib@Base 1.17.1
+ el_find_word@Base 1.17.1
+ el_hist_size@Base 1.17.1
+ el_next_hist@Base 1.17.1
+ el_no_echo@Base 1.17.1
+ el_no_hist@Base 1.17.1
+ el_prev_hist@Base 1.17.1
+ el_print_columns@Base 1.17.1
+ el_ring_bell@Base 1.17.1
+ prompt_len@Base 1.17.1
+ read_history@Base 1.17.1
+ readline@Base 1.17.1
+ rl_add_slash@Base 1.17.1
+ rl_attempted_completion_function@Base 1.17.1
+ rl_attempted_completion_over@Base 1.17.1
+ rl_callback_handler_install@Base 1.17.1
+ rl_callback_handler_remove@Base 1.17.1
+ rl_callback_read_char@Base 1.17.1
+ rl_clear_message@Base 1.17.1
+ rl_complete@Base 1.17.1
+ rl_completion_entry_function@Base 1.17.1
+ rl_completion_matches@Base 1.17.1
+ rl_deprep_term_function@Base 1.17.1
+ rl_deprep_terminal@Base 1.17.1
+ rl_end@Base 1.17.1
+ rl_eof@Base 1.17.1
+ rl_erase@Base 1.17.1
+ rl_event_hook@Base 1.17.1
+ rl_filename_completion_function@Base 1.17.1
+ rl_forced_update_display@Base 1.17.1
+ rl_getc@Base 1.17.1
+ rl_getc_function@Base 1.17.1
+ rl_inhibit_complete@Base 1.17.1
+ rl_initialize@Base 1.17.1
+ rl_insert_text@Base 1.17.1
+ rl_instream@Base 1.17.1
+ rl_intr@Base 1.17.1
+ rl_kill@Base 1.17.1
+ rl_line_buffer@Base 1.17.1
+ rl_list_possib@Base 1.17.1
+ rl_mark@Base 1.17.1
+ rl_meta_chars@Base 1.17.1
+ rl_outstream@Base 1.17.1
+ rl_point@Base 1.17.1
+ rl_prep_term_function@Base 1.17.1
+ rl_prep_terminal@Base 1.17.1
+ rl_prompt@Base 1.17.1
+ rl_quit@Base 1.17.1
+ rl_readline_name@Base 1.17.1
+ rl_refresh_line@Base 1.17.1
+ rl_reset_terminal@Base 1.17.1
+ rl_restore_prompt@Base 1.17.1
+ rl_save_prompt@Base 1.17.1
+ rl_set_complete_func@Base 1.17.1
+ rl_set_getc_func@Base 1.17.1
+ rl_set_list_possib_func@Base 1.17.1
+ rl_set_prompt@Base 1.17.1
+ rl_ttyset@Base 1.17.1
+ rl_uninitialize@Base 1.17.1
+ write_history@Base 1.17.1

debian/rules

@@ -1,8 +1,16 @@
 #!/usr/bin/make -f           
+# export DH_VERBOSE=1
+export DEB_BUILD_MAINT_OPTIONS  = hardening=+all
+export DEB_CFLAGS_MAINT_APPEND  = -W -Wall -Wextra -O3
+export DEB_LDFLAGS_MAINT_APPEND = -Wl,--as-needed
 
-# Uncomment this to turn on verbose mode.
-#export DH_VERBOSE=1
+NUMJOBS = $(patsubst parallel=%,%,$(filter parallel=%,$(DEB_BUILD_OPTIONS)))
+
+include /usr/share/dpkg/default.mk  # provides DEB_VERSION
 
 %:
 	dh $@ --with autoreconf
 
+override_dh_installchangelogs:
+	dh_installchangelogs ChangeLog.md
+

examples/cli.c

@@ -38,9 +38,9 @@ static char *my_rl_complete(char *token, int *match)
     int count = 0;
 
     for (i = 0; list[i]; i++) {
-	int partlen = strlen (token); /* Part of token */
+	int partlen = strlen(token); /* Part of token */
 
-	if (!strncmp (list[i], token, partlen)) {
+	if (!strncmp(list[i], token, partlen)) {
 	    index = i;
 	    matchlen = partlen;
 	    count ++;
@@ -49,7 +49,7 @@ static char *my_rl_complete(char *token, int *match)
 
     if (count == 1) {
 	*match = 1;
-	return strdup (list[index] + matchlen);
+	return strdup(list[index] + matchlen);
     }
 
     return NULL;
@@ -60,15 +60,18 @@ static int my_rl_list_possib(char *token, char ***av)
 {
     int i, num, total = 0;
     char **copy;
-   
+
     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]);
-	    total ++;
+	if (!strncmp(list[i], token, strlen (token))) {
+	    copy[total] = strdup(list[i]);
+	    total++;
 	}
     }
     *av = copy;
@@ -98,41 +101,70 @@ el_status_t list_possible(void)
     return el_ring_bell();
 }
 
-el_status_t do_break(void)
-{
-    puts("Breakout!");
-    return CSeof;
-}
-
-el_status_t do_exit(void)
-{
-    puts("Bye bye!");
-    return CSeof;
-}
-
 el_status_t do_suspend(void)
 {
     puts("Abort!");
     return CSstay;
 }
 
+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 *prompt = "cli> ";
+
+    signal(SIGINT, breakit);
 
     /* Setup callbacks */
     rl_set_complete_func(&my_rl_complete);
     rl_set_list_possib_func(&my_rl_list_possib);
+
     el_bind_key('?', list_possible);
-    el_bind_key(CTL('C'), do_break);
-    el_bind_key(CTL('D'), do_exit);
     el_bind_key(CTL('Z'), do_suspend);
     read_history(HISTORY);
 
-    while ((line = readline(prompt)) != NULL) {
-	printf("\t\t\t|%s|\n", line);
-	free(line);
+    while ((line = readline(prompt))) {
+	if (!strncmp(line, "unlock", 6) && unlock("secret")) {
+	    free(line);
+	    fprintf(stderr, "\nSecurity breach, user logged out!\n");
+	    break;
+	}
+
+	if (*line != '\0')
+	    printf("\t\t\t|%s|\n", line);
+ 	free(line);
     }
 
     write_history(HISTORY);

examples/excallback.c

@@ -39,6 +39,7 @@ Jeff
 
 #include <stdio.h>
 #include <sys/types.h>
+#include <sys/select.h>
 
 #ifdef HAVE_STDLIB_H
 #include <stdlib.h>

examples/fileman.c

@@ -5,8 +5,9 @@
    NOTE: this was taken from the GNU Readline documentation and ported
    to libedit. A command to output the history list was added.
    
-   */
+*/
 
+#include <assert.h>
 #include <stdio.h>
 #include <sys/types.h>
 #include <sys/file.h>
@@ -21,18 +22,15 @@
 
 #include "editline.h"
 
-void * xmalloc (size_t size);
-void too_dangerous (char *caller);
-void initialize_readline ();
-int execute_line (char *line);
-int valid_argument (char *caller, char *arg);
-
-typedef int rl_icpfunc_t (char *);
+void too_dangerous(char *caller);
+void initialize_readline(const char *prompt);
+int execute_line(char *line);
+int valid_argument(char *caller, char *arg);
 
 /* The names of functions that actually do the manipulation. */
-int com_list (char *);
-int com_view (char *);
-int com_history (char *);
+int com_list(char *);
+int com_view(char *);
+int com_history(char *);
 int com_rename(char *);
 int com_stat(char *);
 int com_pwd(char *);
@@ -41,170 +39,156 @@ int com_help(char *);
 int com_cd(char *);
 int com_quit(char *);
 
-/* A structure which contains information on the commands this program
-   can understand. */
+struct cmd {
+    char *name;		      /* User printable name of the function. */
+    int  (*func)(char *);     /* Function to call to do the job. */
+    char *doc;		      /* Documentation for this function.  */
+};
 
-typedef struct {
-   char *name;                   /* User printable name of the function. */
-   rl_icpfunc_t *func;           /* Function to call to do the job. */
-   char *doc;                    /* Documentation for this function.  */
-} COMMAND;
-
-COMMAND commands[] = {
-   { "cd", com_cd, "Change to directory DIR" },
-   { "delete", com_delete, "Delete FILE" },
-   { "help", com_help, "Display this text" },
-   { "?", com_help, "Synonym for `help'" },
-   { "list", com_list, "List files in DIR" },
-   { "ls", com_list, "Synonym for `list'" },
-   { "pwd", com_pwd, "Print the current working directory" },
-   { "quit", com_quit, "Quit using Fileman" },
-   { "rename", com_rename, "Rename FILE to NEWNAME" },
-   { "stat", com_stat, "Print out statistics on FILE" },
-   { "view", com_view, "View the contents of FILE" },
-   { "history", com_history, "List editline history" },
-   { (char *)NULL, (rl_icpfunc_t *)NULL, (char *)NULL }
+struct cmd commands[] = {
+    { "cd",      com_cd,      "Change to directory DIR"},
+    { "delete",  com_delete,  "Delete FILE"},
+    { "help",    com_help,    "Display this text"},
+    { "?",       com_help,    "Synonym for `help'"},
+    { "list",    com_list,    "List files in DIR"},
+    { "ls",      com_list,    "Synonym for `list'"},
+    { "pwd",     com_pwd,     "Print the current working directory"},
+    { "quit",    com_quit,    "Quit using Fileman"},
+    { "rename",  com_rename,  "Rename FILE to NEWNAME"},
+    { "stat",    com_stat,    "Print out statistics on FILE"},
+    { "view",    com_view,    "View the contents of FILE"},
+    { "history", com_history, "List editline history"},
+    { NULL, NULL, NULL },
 };
 
 /* Forward declarations. */
-char *stripwhite ();
-COMMAND *find_command ();
+char *stripwhite(char *string);
+struct cmd *find_command(char *name);
 
-/* The name of this program, as taken from argv[0]. */
-char *progname;
+/* ~/.fileman_history */
+char *fileman_history;
+
+/* Prompt base and current */
+const char *prompt_init;
+char *prompt_curr;
 
 /* When non-zero, this means the user is done using this program. */
 int done;
 
-char *
-dupstr (char* s)
+int main(int argc, char **argv)
 {
-   char *r;
+    char *line, *s;
 
-   r = xmalloc (strlen (s) + 1);
-   strcpy (r, s);
-   return (r);
-}
+    setlocale(LC_CTYPE, "");
+    initialize_readline("(FileMan)");
 
-int
-main (int argc __attribute__((__unused__)), char **argv)
-{
-   char *line, *s;
+    /* Loop reading and executing lines until the user quits. */
+    for (; done == 0;) {
+	line = readline(NULL);
 
-   progname = argv[0];
+	if (!line)
+	    break;
 
-   setlocale(LC_CTYPE, "");
-
-   initialize_readline();       /* Bind our completer. */
-
-   /* Loop reading and executing lines until the user quits. */
-   for ( ; done == 0; )
-   {
-      line = readline ("FileMan: ");
-
-      if (!line)
-         break;
-
-      /* Remove leading and trailing whitespace from the line.
-         Then, if there is anything left, add it to the history list
-         and execute it. */
-      s = stripwhite(line);
+	/* Remove leading and trailing whitespace from the line.
+	   Then, if there is anything left, add it to the history list
+	   and execute it. */
+	s = stripwhite(line);
 #if 0
-      if (*s) {
+	if (*s) {
 
-         char* expansion;
-         int result;
+	    char *expansion;
+	    int result;
 
-         result = history_expand(s, &expansion);
-         if (result < 0 || result == 2) {
-            fprintf(stderr, "%s\n", expansion);
-         } else {
-            add_history(expansion);
-            execute_line(expansion);
-         }
-         free(expansion);
-      }
+	    result = history_expand(s, &expansion);
+	    if (result < 0 || result == 2) {
+		fprintf(stderr, "%s\n", expansion);
+	    } else {
+		add_history(expansion);
+		execute_line(expansion);
+	    }
+	    free(expansion);
+	}
 #else
-      execute_line(s);
+	execute_line(s);
 #endif
-      free(line);
-   }
-   exit (0);
+	free(line);
+    }
 
-   return 0;
+    puts("");
+    write_history(fileman_history);
+    free(fileman_history);
+
+    return 0;
 }
 
 /* Execute a command line. */
-int
-execute_line (char *line)
+int execute_line(char *line)
 {
-   register int i;
-   COMMAND *command;
-   char *word;
+    int i;
+    struct cmd *command;
+    char *word;
 
-   /* Isolate the command word. */
-   i = 0;
-   while (line[i] && isspace (line[i]))
-      i++;
-   word = line + i;
+    /* Isolate the command word. */
+    i = 0;
+    while (line[i] && isspace(line[i]))
+	i++;
+    word = line + i;
 
-   while (line[i] && !isspace (line[i]))
-      i++;
+    while (line[i] && !isspace(line[i]))
+	i++;
 
-   if (line[i])
-      line[i++] = '\0';
+    if (line[i])
+	line[i++] = '\0';
 
-   command = find_command (word);
+    command = find_command(word);
 
-   if (!command)
-   {
-      fprintf (stderr, "%s: No such command for FileMan.\n", word);
-      return (-1);
-   }
+    if (!command) {
+	fprintf(stderr, "%s: No such command for FileMan.\n", word);
+	return -1;
+    }
 
-   /* Get argument to command, if any. */
-   while (isspace (line[i]))
-      i++;
+    /* Get argument to command, if any. */
+    while (isspace(line[i]))
+	i++;
 
-   word = line + i;
+    word = line + i;
 
-   /* Call the function. */
-   return ((*(command->func)) (word));
+    /* Call the function. */
+    return command->func(word);
 }
 
 /* Look up NAME as the name of a command, and return a pointer to that
    command.  Return a NULL pointer if NAME isn't a command name. */
-COMMAND *
-find_command (char *name)
+struct cmd *find_command(char *name)
 {
-   register int i;
+    int i;
 
-   for (i = 0; commands[i].name; i++)
-      if (strcmp (name, commands[i].name) == 0)
-         return (&commands[i]);
+    for (i = 0; commands[i].name; i++)
+	if (strcmp(name, commands[i].name) == 0)
+	    return &commands[i];
 
-   return ((COMMAND *)NULL);
+    return NULL;
 }
 
-/* Strip whitespace from the start and end of STRING.  Return a pointer
-   into STRING. */
-char *
-stripwhite (char *string)
+/*
+ * Strip whitespace from the start and end of STRING.  Return a pointer
+ * into STRING.
+ */
+char *stripwhite(char *string)
 {
-   register char *s, *t;
+    char *s, *t;
 
-   for (s = string; isspace (*s); s++)
-      ;
+    for (s = string; isspace(*s); s++) ;
 
-   if (*s == 0)
-      return (s);
+    if (*s == 0)
+	return s;
 
-   t = s + strlen (s) - 1;
-   while (t > s && isspace (*t))
-      t--;
-   *++t = '\0';
+    t = s + strlen(s) - 1;
+    while (t > s && isspace(*t))
+	t--;
+    *++t = '\0';
 
-   return s;
+    return s;
 }
 
 /* **************************************************************** */
@@ -215,73 +199,107 @@ stripwhite (char *string)
 
 char *command_generator(const char *, int);
 char **fileman_completion(const char *, int, int);
+void fileman_prompt(void);
 
-/* Tell the GNU Readline library how to complete.  We want to try to
-   complete on command names if this is the first word in the line, or
-   on filenames if not. */
-void
-initialize_readline ()
+/*
+ * Tell the GNU Readline library how to complete.  We want to try to
+ * complete on command names if this is the first word in the line, or
+ * on filenames if not.
+ */
+void initialize_readline(const char *prompt)
 {
-   /* Allow conditional parsing of the ~/.inputrc file. */
-   rl_readline_name = "FileMan";
+    const char *home;
+    size_t len;
 
-   /* Tell the completer that we want a crack first. */
-   rl_attempted_completion_function = fileman_completion;
+    /* Allow conditional parsing of the ~/.inputrc file. */
+    rl_readline_name = "FileMan";
+
+    /* Tell the completer that we want a crack first. */
+    rl_attempted_completion_function = fileman_completion;
+
+    /* Restore command history */
+    home = getenv("HOME");
+    len = (home ? strlen(home) : 0) + 14;
+    fileman_history = malloc(len);
+    assert(fileman_history);
+    snprintf(fileman_history, len, "%s/.fileman_history", home ? home : ".");
+
+    read_history(fileman_history);
+
+    /* Prompt is updated when moving around in the tree */
+    prompt_init = prompt;
+    fileman_prompt();
 }
 
-/* Attempt to complete on the contents of TEXT.  START and END
-   bound the region of rl_line_buffer that contains the word to
-   complete.  TEXT is the word to complete.  We can use the entire
-   contents of rl_line_buffer in case we want to do some simple
-   parsing.  Returnthe array of matches, or NULL if there aren't any. */
-char **
-fileman_completion (const char* text, int start, int end __attribute__((__unused__)))
+/*
+ * Update prompt when changing directory.  Use an allocated string to
+ * show off the rl_set_prompt() API for issue #51.
+ */
+void fileman_prompt(void)
 {
-   char **matches;
+    char cwd[1024];
+    size_t len;
 
-   matches = (char **)NULL;
+    if (prompt_curr)
+	free(prompt_curr);
 
-   /* If this word is at the start of the line, then it is a command
-      to complete.  Otherwise it is the name of a file in the current
-      directory. */
-   if (start == 0)
-      matches = rl_completion_matches (text, command_generator);
+    assert(getcwd(cwd, sizeof(cwd)));
+    len = strlen(prompt_init) + strlen(cwd) + 10;
+    prompt_curr = malloc(len);
+    assert(prompt_curr);
 
-   return (matches);
+    snprintf(prompt_curr, len, "%s %s/> ", prompt_init, cwd);
+
+    rl_set_prompt(prompt_curr);
+}
+
+/*
+ * Attempt to complete on the contents of TEXT.  START and END
+ * bound the region of rl_line_buffer that contains the word to
+ * complete.  TEXT is the word to complete.  We can use the entire
+ * contents of rl_line_buffer in case we want to do some simple
+ * parsing.  Returnthe array of matches, or NULL if there aren't any.
+ */
+char **fileman_completion(const char *text, int start, int end)
+{
+    char **matches = NULL;
+
+    /* If this word is at the start of the line, then it is a command
+       to complete.  Otherwise it is the name of a file in the current
+       directory. */
+    if (start == 0)
+	matches = rl_completion_matches(text, command_generator);
+
+    return matches;
 }
 
 /* Generator function for command completion.  STATE lets us
    know whether to start from scratch; without any state
    (i.e. STATE == 0), then we start at the top of the list. */
-char *
-command_generator (text, state)
-   const char *text;
-   int state;
+char *command_generator(const char *text, int state)
 {
-   static int list_index, len;
-   char *name;
+    static int list_index, len;
+    char *name;
 
-   /* If this is a new word to complete, initialize now.  This
-      includes saving the length of TEXT for efficiency, and
-      initializing the index variable to 0. */
-   if (!state)
-   {
-      list_index = 0;
-      len = strlen (text);
-   }
+    /* If this is a new word to complete, initialize now.  This
+       includes saving the length of TEXT for efficiency, and
+       initializing the index variable to 0. */
+    if (!state) {
+	list_index = 0;
+	len = strlen(text);
+    }
 
-   /* Return the next name which partially matches from the
-      command list. */
-   while ((name = commands[list_index].name))
-   {
-      list_index++;
+    /* Return the next name which partially matches from the
+       command list. */
+    while ((name = commands[list_index].name)) {
+	list_index++;
 
-      if (strncmp (name, text, len) == 0)
-         return (dupstr(name));
-   }
+	if (strncmp(name, text, len) == 0)
+	    return strdup(name);
+    }
 
-   /* If no names matched, then return NULL. */
-   return ((char *)NULL);
+    /* If no names matched, then return NULL. */
+    return NULL;
 }
 
 /* **************************************************************** */
@@ -295,193 +313,170 @@ command_generator (text, state)
 static char syscom[1024];
 
 /* List the file(s) named in arg. */
-int
-com_list (char *arg)
+int com_list(char *arg)
 {
-   if (!arg)
-      arg = "";
+    if (!arg)
+	arg = "";
 
-   sprintf (syscom, "ls -FClg %s", arg);
-   return (system (syscom));
+    sprintf(syscom, "ls -FClg %s", arg);
+
+    return system(syscom);
 }
 
-int
-com_view (char *arg)
+int com_view(char *arg)
 {
-   if (!valid_argument ("view", arg))
-      return 1;
+    if (!valid_argument("view", arg))
+	return 1;
 
-   sprintf (syscom, "more %s", arg);
-   return (system (syscom));
+    sprintf(syscom, "more %s", arg);
+
+    return system(syscom);
 }
 
-int
-com_history(char* arg __attribute__((__unused__)))
+int com_history(char *arg)
 {
-   const char *he;
+    const char *he;
 
-   /* rewind history */
-   while (el_prev_hist())
-      ;
+    /* rewind history */
+    while (el_prev_hist()) ;
 
-   for (he = el_next_hist(); he != NULL; he = el_next_hist())
-      printf("%s\n", he);
+    for (he = el_next_hist(); he != NULL; he = el_next_hist())
+	printf("%s\n", he);
 
-   return 0;
+    return 0;
 }
 
-int
-com_rename (char *arg __attribute__((__unused__)))
+int com_rename(char *arg)
 {
-   too_dangerous ("rename");
-   return (1);
+    too_dangerous("rename");
+    return 1;
 }
 
-int
-com_stat (char *arg)
+int com_stat(char *arg)
 {
-   struct stat finfo;
+    struct stat finfo;
 
-   if (!valid_argument ("stat", arg))
-      return (1);
+    if (!valid_argument("stat", arg))
+	return 1;
 
-   if (stat (arg, &finfo) == -1)
-   {
-      perror (arg);
-      return (1);
-   }
+    if (stat(arg, &finfo) == -1) {
+	perror(arg);
+	return 1;
+    }
 
-   printf ("Statistics for `%s':\n", arg);
+    printf("Statistics for `%s':\n", arg);
 
-   printf ("%s has %ld link%s, and is %lld byte%s in length.\n", arg,
-         (long) finfo.st_nlink,
-         (finfo.st_nlink == 1) ? "" : "s",
-         (long long) finfo.st_size,
-         (finfo.st_size == 1) ? "" : "s");
-   printf ("Inode Last Change at: %s", ctime (&finfo.st_ctime));
-   printf ("      Last access at: %s", ctime (&finfo.st_atime));
-   printf ("    Last modified at: %s", ctime (&finfo.st_mtime));
-   return (0);
+    printf("%s has %ld link%s, and is %lld byte%s in length.\n", arg,
+	   (long)finfo.st_nlink,
+	   (finfo.st_nlink == 1) ? "" : "s",
+	   (long long)finfo.st_size, (finfo.st_size == 1) ? "" : "s");
+    printf("Inode Last Change at: %s", ctime(&finfo.st_ctime));
+    printf("      Last access at: %s", ctime(&finfo.st_atime));
+    printf("    Last modified at: %s", ctime(&finfo.st_mtime));
+
+    return 0;
 }
 
-int
-com_delete (char *arg __attribute__((__unused__)))
+int com_delete(char *arg)
 {
-   too_dangerous ("delete");
-   return (1);
+    too_dangerous("delete");
+    return 1;
 }
 
 /* Print out help for ARG, or for all of the commands if ARG is
    not present. */
-int
-com_help (char *arg)
+int com_help(char *arg)
 {
-   register int i;
-   int printed = 0;
+    int i;
+    int printed = 0;
 
-   for (i = 0; commands[i].name; i++)
-   {
-      if (!*arg || (strcmp (arg, commands[i].name) == 0))
-      {
-         printf ("%s\t\t%s.\n", commands[i].name, commands[i].doc);
-         printed++;
-      }
-   }
+    for (i = 0; commands[i].name; i++) {
+	if (!*arg || (strcmp(arg, commands[i].name) == 0)) {
+	    printf("%s\t\t%s.\n", commands[i].name,
+		   commands[i].doc);
+	    printed++;
+	}
+    }
 
-   if (!printed)
-   {
-      printf ("No commands match `%s'.  Possibilties are:\n", arg);
+    if (!printed) {
+	printf("No commands match `%s'.  Possibilties are:\n", arg);
 
-      for (i = 0; commands[i].name; i++)
-      {
-         /* Print in six columns. */
-         if (printed == 6)
-         {
-            printed = 0;
-            printf ("\n");
-         }
+	for (i = 0; commands[i].name; i++) {
+	    /* Print in six columns. */
+	    if (printed == 6) {
+		printed = 0;
+		printf("\n");
+	    }
 
-         printf ("%s\t", commands[i].name);
-         printed++;
-      }
+	    printf("%s\t", commands[i].name);
+	    printed++;
+	}
 
-      if (printed)
-         printf ("\n");
-   }
-   return (0);
+	if (printed)
+	    printf("\n");
+    }
+
+    return 0;
 }
 
 /* Change to the directory ARG. */
-int
-com_cd (char *arg)
+int com_cd(char *arg)
 {
-   if (chdir (arg) == -1)
-   {
-      perror (arg);
-      return 1;
-   }
+    if (chdir(arg) == -1) {
+	perror(arg);
+	return 1;
+    }
 
-   com_pwd ("");
-   return (0);
+    //com_pwd("");
+    fileman_prompt();
+    return 0;
 }
 
 /* Print out the current working directory. */
-int
-com_pwd (char* ignore __attribute__((__unused__)))
+int com_pwd(char *ignore)
 {
-   char dir[1024], *s;
+    char dir[1024], *s;
 
-   s = (char*)getcwd(dir, sizeof(dir) - 1);
-   if (s == 0)
-   {
-      printf ("Error getting pwd: %s\n", dir);
-      return 1;
-   }
+    s = getcwd(dir, sizeof(dir) - 1);
+    if (!s) {
+	printf("Error getting pwd: %s\n", dir);
+	return 1;
+    }
 
-   printf ("Current directory is %s\n", dir);
-   return 0;
+    printf("Current directory is %s\n", dir);
+    return 0;
 }
 
 /* The user wishes to quit using this program.  Just set DONE
    non-zero. */
-int 
-com_quit (char *arg __attribute__((__unused__)))
+int com_quit(char *arg)
 {
-   done = 1;
-   return (0);
+    done = 1;
+    return 0;
 }
 
 /* Function which tells you that you can't do this. */
-void
-too_dangerous (char *caller)
+void too_dangerous(char *caller)
 {
-   fprintf (stderr,
-         "%s: Too dangerous for me to distribute.\n",
-         caller);
-   fprintf (stderr, "Write it yourself.\n");
+    fprintf(stderr, "%s: Too dangerous for me to distribute.\n", caller);
+    fprintf(stderr, "Write it yourself.\n");
 }
 
 /* Return non-zero if ARG is a valid argument for CALLER,
    else print an error message and return zero. */
-int
-valid_argument (char *caller, char *arg)
+int valid_argument(char *caller, char *arg)
 {
-   if (!arg || !*arg)
-   {
-      fprintf (stderr, "%s: Argument required.\n", caller);
-      return (0);
-   }
+    if (!arg || !*arg) {
+	fprintf(stderr, "%s: Argument required.\n", caller);
+	return 0;
+    }
 
-   return (1);
+    return 1;
 }
 
-void *
-xmalloc (size_t size)
-{
-   register void *value = (void*)malloc(size);
-   if (value == 0)
-      fprintf(stderr, "virtual memory exhausted");
-   return value;
-}
-
-
+/**
+ * Local Variables:
+ *  c-file-style: "k&r"
+ *  c-basic-offset: 4
+ * End:
+ */

include/editline.h

@@ -21,6 +21,8 @@
 #ifndef EDITLINE_H_
 #define EDITLINE_H_
 
+#include <stdio.h>
+
 /* Handy macros when binding keys. */
 #define CTL(x)          ((x) & 0x1F)
 #define ISCTL(x)        ((x) && (x) < ' ')
@@ -82,6 +84,7 @@ extern int         rl_point;
 extern int         rl_mark;
 extern int         rl_end;
 extern int         rl_inhibit_complete;
+extern int         rl_attempted_completion_over;
 extern char       *rl_line_buffer;
 extern const char *rl_readline_name;
 extern FILE       *rl_instream;  /* The stdio stream from which input is read. Defaults to stdin if NULL - Not supported yet! */
@@ -114,6 +117,8 @@ extern void  add_history        (const char *line);
 extern int   read_history       (const char *filename);
 extern int   write_history      (const char *filename);
 
+extern rl_getc_func_t *rl_set_getc_func(rl_getc_func_t *func);
+
 extern rl_completion_func_t  *rl_attempted_completion_function;
 extern rl_complete_func_t    *rl_set_complete_func    (rl_complete_func_t *func);
 extern rl_list_possib_func_t *rl_set_list_possib_func (rl_list_possib_func_t *func);

man/editline.3

@@ -1,200 +1,287 @@
-.TH EDITLINE 3
-.SH NAME
-editline \- command-line editing library with history
-.SH SYNOPSIS
-.nf
-.B "char *readline(char *prompt);"
-.fi
-.SH DESCRIPTION
-.I Editline
-is a library that provides an line-editing interface with history.
-It is intended to be functionally equivalent with the
-.I readline
-library provided by the Free Software Foundation, but much smaller.
-The bulk of this manual page describes the user interface.
-.PP
+.Dd February 23, 2020
+.Dt EDITLINE 3
+.Os
+.Sh NAME
+.Nm editline
+.Nd command-line editing library with history
+.Sh LIBRARY
+.Lb libeditline
+.Sh SYNOPSIS
+.In editline.h
+.Ft char *
+.Fo readline
+.Fa const char *prompt
+.Fc
+.Ft void
+.Fo add_history
+.Fa const char *line
+.Fc
+.Ft int
+.Fo read_history
+.Fa const char *filename
+.Fc
+.Ft int
+.Fo write_history
+.Fa const char *filename
+.Fc
+.Sh DESCRIPTION
+.Nm
+is a library that provides n line-editing interface with history.  It
+is intended to be functionally equivalent with the
+.Nm readline
+library provided by the Free Software Foundation, but much smaller.  The
+bulk of this manual page describes the basic user interface.  More APIs,
+both native and for
+.Nm readline
+compatibility ,
+are also available.  See the
+.Cm editline.h
+header file for details.
+.Pp
 The
-.I readline()
+.Fn readline
 function displays the given
-.I prompt
-on stdout, waits for user input on stdin and then
-returns a line of text with the trailing newline removed.  The data is returned in a
-buffer allocated with
-.IR malloc (3),
+.Fa prompt
+on stdout, waits for user input on stdin and then returns a line of text
+with the trailing newline removed.  The data is returned in a buffer
+allocated with
+.Xr malloc 3 ,
 so the space should be released with
-.IR free (3)
+.Xr free 3
 when the calling program is done with it.
-.PP
-Each line returned is copied to the internal history list, unless it happens
-to be equal to the previous line.  This is configurable if you are building editline
-from source.
-.SS User Interface
-A program that uses this library provides a simple emacs-like editing interface to
-its users.  A line may be edited before it is sent to the calling program by typing
-either control characters or escape sequences.  A control character, shown as a caret
-followed by a letter, is typed by holding down the ``control'' key while the letter
-is typed.  For example, ``^A'' is a control-A.  An escape sequence is entered by
-typing the ``escape'' key followed by one or more characters.  The escape key is
-abbreviated as ``ESC''.  Note that unlike control keys, case matters in escape
-sequences; ``ESC\ F'' is not the same as ``ESC\ f''.
-.PP
-An editing command may be typed anywhere on the line, not just at the beginning.  In
-addition, a return may also be typed anywhere on the line, not just at the end.
-.PP
+.Pp
+Each line returned is automatically saved in the internal history list,
+unless it happens to be equal to the previous line.  This is
+configurable if you are building editline from source, i.e. if you would
+rather like to call
+.Fn add_history
+manually.
+.Pp
+The
+.Fn read_history
+and
+.Fn write_history
+functions can be used to load and store the history of your application.
+.Em Note:
+these APIs do not do any tilde or environment variable expansion of the
+given filename.
+.Ss User Interface
+A program that uses this library provides a simple emacs-like editing
+interface to its users.  A line may be edited before it is sent to the
+calling program by typing either control characters or escape sequences.
+A control character, shown as a caret followed by a letter, is typed by
+holding down the control key while the letter is typed.  For example,
+.Cm ^A
+is a control-A.  An escape sequence is entered by typing the escape key
+followed by one or more characters.  The escape key is abbreviated as
+.Cm ESC .
+Note that unlike control keys, case matters in escape sequences;
+.Cm ESC F
+is not the same as
+.Cm ESC f .
+.Pp
+An editing command may be typed anywhere on the line, not just at the
+beginning.  In addition, a return may also be typed anywhere on the
+line, not just at the end.
+.Pp
 Most editing commands may be given a repeat count,
-.IR n ,
+.Ar n ,
 where
-.I n
-is a number.
-To enter a repeat count, type the escape key, the number, and then
-the command to execute.
-For example, ``ESC\ 4\ ^f'' moves forward four characters.
-If a command may be given a repeat count then the text ``[n]'' is given at the
-end of its description.
-.PP
+.Ar n
+is a number.  To enter a repeat count, type the escape key, the number,
+and then the command to execute.  For example,
+.Cm ESC 4 ^f
+moves forward four characters.  If a command may be given a repeat count
+then the text
+.Cm [n]
+is given at the end of its description.
+.Pp
 The following control characters are accepted:
-.RS
-.nf
-.ta \w'ESC DEL  'u
-^A	Move to the beginning of the line
-^B	Move left (backwards) [n]
-^D	Delete character [n]
-^E	Move to end of line
-^F	Move right (forwards) [n]
-^G	Ring the bell
-^H	Delete character before cursor (backspace key) [n]
-^I	Complete filename (tab key); see below
-^J	Done with line (return key)
-^K	Kill to end of line (or column [n])
-^L	Redisplay line
-^M	Done with line (alternate return key)
-^N	Get next line from history [n]
-^P	Get previous line from history [n]
-^R	Search backward (forward if [n]) through history for
-\&	text; must start line if text begins with an uparrow
-^T	Transpose characters
-^V	Insert next character, even if it is an edit command
-^W	Wipe to the mark
-^X^X	Exchange current location and mark
-^Y	Yank back last killed text
-^[	Start an escape sequence (escape key)
-^]c	Move forward to next character ``c''
-^?	Delete character before cursor (delete key) [n]
-.fi
-.RE
-.PP
-The following escape sequences are provided.
-.RS
-.nf
-.ta \w'ESC DEL  'u
-ESC\ ^H	Delete previous word (backspace key) [n]
-ESC\ DEL	Delete previous word (delete key) [n]
-ESC\ SP	Set the mark (space key); see ^X^X and ^Y above
-ESC\ \.	Get the last (or [n]'th) word from previous line
-ESC\ ?	Show possible completions; see below
-ESC\ <	Move to start of history
-ESC\ >	Move to end of history
-ESC\ b	Move backward a word [n]
-ESC\ d	Delete word under cursor [n]
-ESC\ f	Move forward a word [n]
-ESC\ l	Make word lowercase [n]
-ESC\ m	Toggle if 8bit chars display normally or with an
-\&	``M\-'' prefix
-ESC\ u	Make word uppercase [n]
-ESC\ y	Yank back last killed text
-ESC\ v	Show library version
-ESC\ w	Make area up to mark yankable
-ESC\ nn	Set repeat count to the number nn
-ESC\ C	Read from environment variable ``_C_'', where C is
-\&	an uppercase letter
-.fi
-.RE
-.PP
+.Pp
+.Bl -tag -width "ESC DEL " -compact
+.It ^A
+Move to the beginning of the line
+.It ^B
+Move left (backwards) [n]
+.It ^D
+Delete character [n]
+.It ^E
+Move to end of line
+.It ^F
+Move right (forwards) [n]
+.It ^G
+Ring the bell
+.It ^H
+Delete character before cursor (backspace key) [n]
+.It ^I
+Complete filename (tab key); see below
+.It ^J
+Done with line (return key)
+.It ^K
+Kill to end of line (or column [n])
+.It ^L
+Redisplay line
+.It ^M
+Done with line (alternate return key)
+.It ^N
+Get next line from history [n]
+.It ^P
+Get previous line from history [n]
+.It ^R
+Search backward (forward if [n]) through history for text; prefixing the
+string with a caret (^) forces it to match only at the beginning of a
+history line
+.It ^T
+Transpose characters
+.It ^V
+Insert next character, even if it is an edit command
+.It ^W
+Wipe to the mark
+.It ^X^X
+Exchange current location and mark
+.It ^Y
+Yank back last killed text
+.It ^[
+Start an escape sequence (escape key)
+.It ^]c
+Move forward to next character
+.Cm c
+.It ^?
+Delete character before cursor (delete key) [n]
+.El
+.Pp
+The following escape sequences are provided:
+.Pp
+.Bl -tag -width "ESC DEL " -compact
+.It ESC ^H
+Delete previous word (backspace key) [n]
+.It ESC DEL
+Delete previous word (delete key) [n]
+.It ESC SP
+Set the mark (space key); see ^X^X and ^Y above
+.It ESC\ .
+Get the last (or [n]'th) word from previous line
+.It ESC\ ?
+Show possible completions; see below
+.It ESC <
+Move to start of history
+.It ESC >
+Move to end of history
+.It ESC b
+Move backward a word [n]
+.It ESC d
+Delete word under cursor [n]
+.It ESC f
+Move forward a word [n]
+.It ESC l
+Make word lowercase [n]
+.It ESC m
+Toggle if 8bit chars display normally or with an
+.Ar M-
+prefix
+.It ESC u
+Make word uppercase [n]
+.It ESC y
+Yank back last killed text
+.It ESC v
+Show library version
+.It ESC w
+Make area up to mark yankable
+.It ESC nn
+Set repeat count to the number nn
+.It ESC C
+Read from environment variable
+.Ar $C ,
+where
+.Ar C
+is an uppercase letter
+.El
+.Pp
 The
-.I editline
-library has a small macro facility.
-If you type the escape key followed by an uppercase letter,
-.IR C ,
+.Nm
+library has a small macro facility.  If you type the escape key followed
+by an uppercase letter,
+.Ar C ,
 then the contents of the environment variable
-.I _C_
-are read in as if you had typed them at the keyboard.
-For example, if the variable
-.I _L_
+.Ar $C
+are read in as if you had typed them at the keyboard.  For example, if
+the variable
+.Ar $L
 contains the following:
-.PP
-.RS
-^A^Kecho '^V^[[H^V^[[2J'^M
-.RE
-.PP
-Then typing ``ESC L'' will move to the beginning of the line, kill the
-entire line, enter the echo command needed to clear the terminal (if your
-terminal is like a VT-100), and send the line back to the shell.
-.PP
+.Pp
+.Dl ^A^Kecho '^V^[[H^V^[[2J'^M
+.Pp
+Then typing
+.Cm ESC L
+will move to the beginning of the line, kill the entire line, enter the
+echo command needed to clear the terminal (if your terminal is like a
+VT-100), and send the line back to the shell.
+.Pp
 The
-.I editline
-library also does filename completion.
-Suppose the root directory has the following files in it:
-.PP
-.RS
-.nf
-.ta \w'core   'u
-bin	vmunix
-core	vmunix.old
-.fi
-.RE
-.PP
-If you type ``rm\ /v'' and then the tab key.
-.I Editline
-will then finish off as much of the name as possible by adding ``munix''.
-Because the name is not unique, it will then beep.
-If you type the escape key and a question mark, it will display the
-two choices.
-If you then type a period and a tab, the library will finish off the filename
+.Nm
+library also does filename completion.  Suppose the root directory has
+the following files in it:
+.Pp
+.Dl bin	vmunix
+.Dl core	vmunix.old
+.Pp
+If you type
+.Cm rm /v
+and then the tab key,
+.Nm
+will then finish off as much of the name as possible by adding
+.Ar munix .
+Because the name is not unique, it will then beep.  If you type the
+escape key and a question mark, it will display the two choices.  If you
+then type a period and a tab, the library will finish off the filename
 for you:
-.PP
-.RS
-.nf
-.RI "rm /v[TAB]" munix ".[TAB]" old
-.fi
-.RE
-.PP
-The tab key is shown by ``[TAB]'' and the automatically-entered text
-is shown in italics.
-.SH USAGE
+.Pp
+.Bd -ragged -offset indent
+rm /v[TAB]
+.Em munix
+\&.[TAB]
+.Em old
+.Ed
+.Pp
+The tab key is shown by [TAB] and the automatically-entered text
+is shown in italics, or underline.
+.Sh USAGE
 To include
-.I readline()
-in your program, simply call it as you do any other function. Just make sure to link
-your program with libeditline.
-.SS Example
+.Nm
+in your program, call it as you do any other function and link your
+program with
+.Ar -leditline .
+.Ss Example
 The following brief example lets you enter a line and edit it, then displays it.
-.nf
-.B ""
-.B #include <stdlib.h>
-.B ""
-.B extern char *readline(char *prompt);
-.B ""
-.B int main(void)
-.B {
-.RS
-.B     char *p;
-.B ""
-.B     while ((p = readline("CLI>"))) {
-.RS
-.B         puts(p);
-.B         free(p);
-.RE
-.B     }
-.B ""
-.B     return 0;
-.RE
-.B }
-.fi
-.SH AUTHORS
-The original editline library was created by Simmule R. Turner and Rich
-Salz.  It now exists in several forks: Heimdal, Festival speech tools,
-Mozilla, Google Gadgets for Linux, and many other places.  The original
-manual page was made by David W. Sanderson.  This version is maintained
-by Joachim Nilsson at GitHub,
-.Aq http://github.com/troglobit/editline
-.SH BUGS
+.Pp
+.Bd -literal -offset indent
+#include <stdio.h>
+#include <stdlib.h>
+#include <editline.h>
+
+int main(void)
+{
+	char *p;
+
+	while ((p = readline("CLI> "))) {
+	        puts(p);
+	        free(p);
+	}
+
+	return 0;
+}
+.El
+.Sh AUTHORS
+The original editline library was posted to comp.sources.unix newsgroup
+by created by Simmule R. Turner and Rich Salz in 1992.  It now exists in
+several forks: Debian, Minix, Heimdal, Festival speech tools, Mozilla,
+Google Gadgets for Linux, and many others.  The original manual page was
+made by David W. Sanderson.
+.Pp
+This version stems from the Minix 2 sources, but has since evolved to
+include patches from all relevant forks.  It is currently maintained by
+.An Joachim Wiberg
+at
+.Lk https://github.com/troglobit/editline "GitHub" .
+.Sh BUGS
 Does not handle multiple lines or unicode characters well.

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:0:0
+libeditline_la_LDFLAGS  = $(AM_LDFLAGS) -version-info 1:2:0

src/complete.c

@@ -40,7 +40,7 @@ static int compare(const void *p1, const void *p2)
 
 /* Fill in *avp with an array of names that match file, up to its length.
  * Ignore . and .. . */
-static int FindMatches(char *dir, char *file, char ***avp)
+static int FindMatches(const char *dir, const char *file, char ***avp)
 {
     char        **av;
     char        **word;
@@ -128,7 +128,7 @@ static int FindMatches(char *dir, char *file, char ***avp)
 /* Split a pathname into allocated directory and trailing filename parts. */
 static int SplitPath(const char *path, char **dirpart, char **filepart)
 {
-    static char DOT[] = ".";
+    static const char DOT[] = ".";
     char        *dpart;
     char        *fpart;
 
@@ -197,14 +197,14 @@ char *el_filename_complete(char *pathname, int *match)
     if (ac == 1) {
         /* Exactly one match -- finish it off. */
         *match = 1;
-        j = strlen(av[0]) - len + 2;
-	p = malloc(sizeof(char) * (j + 1));
+        j = strlen(av[0]) - len + 1;
+        p = malloc(sizeof(char) * (j + 1));
         if (p) {
             memcpy(p, av[0] + len, j);
-	    len = strlen(dir) + strlen(av[0]) + 2;
-	    path = malloc(sizeof(char) * len);
+            len = strlen(dir) + strlen(av[0]) + 2;
+            path = malloc(sizeof(char) * len);
             if (path) {
-		snprintf(path, len, "%s/%s", dir, av[0]);
+                snprintf(path, len, "%s/%s", dir, av[0]);
                 rl_add_slash(path, p);
                 free(path);
             }
@@ -243,9 +243,7 @@ char *el_filename_complete(char *pathname, int *match)
 
 char *rl_filename_completion_function(const char *text, int state)
 {
-    char        *dir;
-    char        *file;
-    static char   **av;
+    static char   **av, *dir, *file;
     static size_t i, ac;
 
     if (!state) {
@@ -253,32 +251,47 @@ char *rl_filename_completion_function(const char *text, int state)
 	    return NULL;
 
 	ac = FindMatches(dir, file, &av);
-	free(dir);
-	free(file);
-	if (!ac)
+	if (!ac) {
+	    free(dir);
+	    free(file);
 	    return NULL;
+	}
 
 	i = 0;
     }
 
-    if (i < ac)
-	return av[i++];
+    if (i < ac) {
+	size_t len = (dir ? strlen(dir) : 0) + strlen(av[i]) + 3;
+	char *ptr = malloc(len);
+
+	if (ptr) {
+	    snprintf(ptr, len, "%s%s", dir, av[i++]);
+	    if (ac == 1)
+		rl_add_slash(ptr, ptr);
+
+	    return ptr;
+	}
+    }
 
     do {
 	free(av[--i]);
     } while (i > 0);
 
+    free(av);
+    free(dir);
+    free(file);
+
     return NULL;
 }
 
 /* Similar to el_find_word(), but used by GNU Readline API */
 static char *rl_find_token(size_t *len)
 {
-    char *ptr;
+    const char *ptr;
     int pos;
 
     for (pos = rl_point; pos < rl_end; pos++) {
-	if (isspace(rl_line_buffer[pos])) {
+	if (isspace((unsigned char) rl_line_buffer[pos])) {
 	    if (pos > 0)
 		pos--;
 	    break;
@@ -286,7 +299,7 @@ static char *rl_find_token(size_t *len)
     }
 
     ptr = &rl_line_buffer[pos];
-    while (pos >= 0 && !isspace(rl_line_buffer[pos])) {
+    while (pos >= 0 && !isspace((unsigned char) rl_line_buffer[pos])) {
 	if (pos == 0)
 	    break;
 
@@ -367,8 +380,12 @@ static char *complete(char *token, int *match)
 
 	free(word);
 	word = NULL;
-	if (words[0])
+
+        /* Exactly one match -- finish it off. */
+	if (words[0] && !words[1]) {
+	    *match = 1;
 	    word = strdup(words[0] + len);
+	}
 
 	while (words[i])
 	    free(words[i++]);
@@ -378,6 +395,9 @@ static char *complete(char *token, int *match)
 	    return word;
     }
 
+    if (word)
+	free(word);
+
 fallback:
     return el_filename_complete(token, match);
 }

src/editline.h

@@ -57,8 +57,10 @@
 #define MEM_INC         64
 #define SCREEN_INC      256
 
-/* http://stackoverflow.com/questions/1598773/is-there-a-standard-function-in-c-that-would-return-the-length-of-an-array/1598827#1598827 */
-#define ARRAY_ELEMENTS(arr) ((sizeof(arr)/sizeof(0[arr])) / ((size_t)(!(sizeof(arr) % sizeof(0[arr])))))
+/* From The Practice of Programming, by Kernighan and Pike */
+#ifndef NELEMS
+#define NELEMS(array) (sizeof(array) / sizeof(array[0]))
+#endif
 
 /*
 **  Variables and routines internal to this package.