nuttx-apps/system/readline/readline.c
chao an 929f1009c7 system/readline: correct the readline(3) prototype
Reference:
https://man.openbsd.org/readline.3

Signed-off-by: chao an <anchao@xiaomi.com>
2023-10-16 22:04:18 +08:00

80 lines
2.7 KiB
C
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/****************************************************************************
* apps/system/readline/readline.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 <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
****************************************************************************/
/****************************************************************************
* 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 returned has the
* final newline removed, so only the text of the line remains.
*
****************************************************************************/
FAR char *readline(FAR const char *prompt)
{
FAR char *line = malloc(CONFIG_NSH_LINELEN);
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;
}