summaryrefslogtreecommitdiff
path: root/include/cli_readline.h
blob: f326106d4c5e035d61c27501aaad6fd6c02d00aa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
/*
 * (C) Copyright 2014-2016 Leo C. <erbl259-lmu@yahoo.de>
 *
 * (C) Copyright 2014 Google, Inc
 * Simon Glass <sjg@chromium.org>
 *
 * SPDX-License-Identifier:	GPL-2.0
 */

#ifndef CLI_READLINE_H
#define CLI_READLINE_H

#include "common.h"
#include <stdbool.h>

extern char console_buffer[];	/* console I/O buffer	*/

/**
 * cli_readline() - read a line into the console_buffer
 *
 * Display the prompt, then read a command line into console_buffer. The
 * maximum line length is CONFIG_SYS_CBSIZE including a \0 terminator, which
 * will always be added.
 *
 * The command is echoed as it is typed. Command editing is supported.
 * Tab auto-complete is supported if CONFIG_AUTO_COMPLETE is defined.
 *
 * @prompt: Prompt to display
 * @enable_history: Use history buffer if true
 * @return command line length excluding terminator, or -ve on error
 */
int cli_readline(const FLASH char *const prompt, bool enable_history);

#endif /* CLI_READLINE_H */