system/readline: correct the readline(3) prototype

Reference:
https://man.openbsd.org/readline.3

Signed-off-by: chao an <anchao@xiaomi.com>

examples/ftpc/ftpc_main.c

@@ -560,7 +560,8 @@ do_connect:
           return 1;
         }
 #else
-      ret = readline(g_line, CONFIG_FTPC_LINELEN, stdin, stdout);
+      ret = readline_stream(g_line, CONFIG_FTPC_LINELEN,
+                            stdin, stdout);
 
       /* Readline normally returns the number of characters read,
        * but will return EOF on end of file or if an error occurs.

examples/lp503x/lp503x_main.c

@@ -647,7 +647,8 @@ int main(int argc, FAR char *argv[])
 
       /* read a line from the terminal */
 
-      len = readline(buffer, sizeof(buffer), stdin, stdout);
+      len = readline_stream(buffer, sizeof(buffer),
+                            stdin, stdout);
       buffer[len] = '\0';
       if (len > 0)
         {

examples/nrf24l01_term/nrf24l01_term.c

@@ -320,7 +320,8 @@ int main(int argc, FAR char *argv[])
                   goto out;
                 }
 #else
-              ret = readline(&buff[1], sizeof(buff) - 1, stdin, stdout);
+              ret = readline_stream(&buff[1], sizeof(buff) - 1,
+                                    stdin, stdout);
 
               /* Readline normally returns the number of characters read,
                * but will return EOF on end of file or if an error occurs.

include/system/readline.h

@@ -174,17 +174,31 @@ FAR const struct extmatch_vtable_s *
 ssize_t readline_fd(FAR char *buf, int buflen, int infd, int outfd);
 
 /****************************************************************************
- * Name: readline
+ * Name: readline_stream
  *
- *   readline() is same to readline_fd() but accept a file stream instead
- *   of a file handle.
+ *   readline_stream() is same to readline_fd() but accept a file stream
+ *   instead of a file handle.
  *
  ****************************************************************************/
 
 #ifdef CONFIG_FILE_STREAM
-ssize_t readline(FAR char *buf, int buflen, FILE *instream, FILE *outstream);
+ssize_t readline_stream(FAR char *buf, int buflen,
+                        FAR FILE *instream, FAR FILE *outstream);
 #endif
 
+/****************************************************************************
+ * Name: readline
+ *
+ *   readline will read a line from the terminal and return it, using
+ *   prompt as a prompt.  If prompt is NULL or the empty string, no prompt
+ *   is issued.  The line returned is allocated with malloc(3);
+ *   the caller must free it when finished.  The line re‐turned has the
+ *   final newline removed, so only the text of the line remains.
+ *
+ ****************************************************************************/
+
+FAR char *readline(FAR const char *prompt);
+
 /****************************************************************************
  * Name: std_readline
  *
@@ -212,7 +226,7 @@ ssize_t readline(FAR char *buf, int buflen, FILE *instream, FILE *outstream);
  *
  ****************************************************************************/
 
-#define std_readline(b,s) readline(b,s,stdin,stdout)
+#define std_readline(b,s) readline_stream(b,s,stdin,stdout)
 
 #undef EXTERN
 #ifdef __cplusplus

interpreters/lua/Makefile

@@ -60,7 +60,7 @@ endif
 ifeq ($(CONFIG_SYSTEM_READLINE),y)
 CFLAGS += -include "system/readline.h"
 CFLAGS += -D'lua_initreadline(L)=((void)L)'
-CFLAGS += -D'lua_readline(L,b,p)=((void)L,fputs(p,stdout),fflush(stdout),readline(b,LUA_MAXINPUT,stdin,stdout))'
+CFLAGS += -D'lua_readline(L,b,p)=((void)L,fputs(p,stdout),fflush(stdout),readline_stream(b,LUA_MAXINPUT,stdin,stdout))'
 CFLAGS += -D'lua_saveline(L,line)={(void)L;(void)line;}'
 CFLAGS += -D'lua_freeline(L,line)={(void)L;(void)b;}'
 endif

system/nxcamera/nxcamera_main.c

@@ -431,7 +431,8 @@ int main(int argc, FAR char *argv[])
 
       /* Read a line from the terminal */
 
-      len = readline(buffer, sizeof(buffer), stdin, stdout);
+      len = readline_stream(buffer, sizeof(buffer),
+                            stdin, stdout);
       if (len > 0)
         {
           buffer[len] = '\0';

system/nxlooper/nxlooper_main.c

@@ -533,7 +533,8 @@ int main(int argc, FAR char *argv[])
 
       /* Read a line from the terminal */
 
-      len = readline(buffer, sizeof(buffer), stdin, stdout);
+      len = readline_stream(buffer, sizeof(buffer),
+                            stdin, stdout);
       if (len > 0)
         {
           buffer[len] = '\0';

system/nxplayer/nxplayer_main.c

@@ -770,7 +770,8 @@ int main(int argc, FAR char *argv[])
 
       /* Read a line from the terminal */
 
-      len = readline(buffer, sizeof(buffer), stdin, stdout);
+      len = readline_stream(buffer, sizeof(buffer),
+                            stdin, stdout);
       if (len > 0)
         {
           buffer[len] = '\0';

system/nxrecorder/nxrecorder_main.c

@@ -562,7 +562,8 @@ int main(int argc, FAR char *argv[])
 
       /* Read a line from the terminal */
 
-      len = readline(buffer, sizeof(buffer), stdin, stdout);
+      len = readline_stream(buffer, sizeof(buffer),
+                            stdin, stdout);
       if (len > 0)
         {
           buffer[len] = '\0';

system/readline/CMakeLists.txt

@@ -20,6 +20,7 @@
 
 if(CONFIG_SYSTEM_READLINE)
 
-  target_sources(apps PRIVATE readline.c readline_fd.c readline_common.c)
+  target_sources(apps PRIVATE readline.c readline_fd.c readline_stream.c
+                              readline_common.c)
 
 endif()

system/readline/Makefile

@@ -22,6 +22,6 @@ include $(APPDIR)/Make.defs
 
 # The Readline Library
 
-CSRCS = readline.c readline_fd.c readline_common.c
+CSRCS = readline.c readline_fd.c readline_stream.c readline_common.c
 
 include $(APPDIR)/Application.mk

system/readline/readline.c

@@ -25,10 +25,20 @@
 #include <nuttx/config.h>
 
 #include <stdio.h>
-#include <assert.h>
+#include <stdlib.h>
 
 #include "system/readline.h"
 
+/****************************************************************************
+ * Pre-processor Definitions
+ ****************************************************************************/
+
+/* Maximum size of one command line (telnet or serial) */
+
+#ifndef CONFIG_NSH_LINELEN
+#  define CONFIG_NSH_LINELEN 80
+#endif
+
 /****************************************************************************
  * Public Functions
  ****************************************************************************/
@@ -36,26 +46,34 @@
 /****************************************************************************
  * Name: readline
  *
- *   readline() is same to readline_fd() but accept a file stream instead
- *   of a file handle.
+ *   readline will read a line from the terminal and return it, using
+ *   prompt as a prompt.  If prompt is NULL or the empty string, no prompt
+ *   is issued.  The line returned is allocated with malloc(3);
+ *   the caller must free it when finished.  The line re‐turned has the
+ *   final newline removed, so only the text of the line remains.
  *
  ****************************************************************************/
 
-#ifdef CONFIG_FILE_STREAM
-ssize_t readline(FAR char *buf, int buflen, FILE *instream, FILE *outstream)
+FAR char *readline(FAR const char *prompt)
 {
-  int instream_fd;
-  int outstream_fd;
+  FAR char *line = malloc(CONFIG_NSH_LINELEN);
 
-  /* Sanity checks */
-
-  DEBUGASSERT(instream && outstream);
-
-  /* Let readline_fd do the work */
-
-  instream_fd  = fileno(instream);
-  outstream_fd = fileno(outstream);
-
-  return readline_fd(buf, buflen, instream_fd, outstream_fd);
-}
+  if (line != NULL)
+    {
+#ifdef CONFIG_READLINE_TABCOMPLETION
+      FAR const char *orig = readline_prompt(prompt);
 #endif
+      if (readline_fd(line, CONFIG_NSH_LINELEN,
+                      STDIN_FILENO, STDOUT_FILENO) == 0)
+        {
+          free(line);
+          line = NULL;
+        }
+
+#ifdef CONFIG_READLINE_TABCOMPLETION
+      readline_prompt(orig);
+#endif
+    }
+
+  return line;
+}

system/readline/readline_stream.c

@@ -0,0 +1,62 @@
+/****************************************************************************
+ * apps/system/readline/readline_stream.c
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.  The
+ * ASF licenses this file to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the
+ * License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ ****************************************************************************/
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/config.h>
+
+#include <stdio.h>
+#include <assert.h>
+
+#include "system/readline.h"
+
+/****************************************************************************
+ * Public Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: readline_stream
+ *
+ *   readline_stream() is same to readline_fd() but accept a file stream
+ *   instead of a file handle.
+ *
+ ****************************************************************************/
+
+#ifdef CONFIG_FILE_STREAM
+ssize_t readline_stream(FAR char *buf, int buflen,
+                        FAR FILE *instream, FAR FILE *outstream)
+{
+  int instream_fd;
+  int outstream_fd;
+
+  /* Sanity checks */
+
+  DEBUGASSERT(instream && outstream);
+
+  /* Let readline_fd do the work */
+
+  instream_fd  = fileno(instream);
+  outstream_fd = fileno(outstream);
+
+  return readline_fd(buf, buflen, instream_fd, outstream_fd);
+}
+#endif

testing/irtest/main.cxx

@@ -35,7 +35,7 @@ static ssize_t prompt(const char *p, char *buf, size_t len)
 {
   fputs(p, stdout);
   fflush(stdout);
-  return readline(buf, len, stdin, stdout);
+  return readline_stream(buf, len, stdin, stdout);
 }
 
 /****************************************************************************