summaryrefslogtreecommitdiff
path: root/lib/utils/mu-readline.hh
blob: ca0455fccf570035321ee15edc40356534a295e8 (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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/*
** Copyright (C) 2020 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
**
** This program is free software; you can redistribute it and/or modify it
** under the terms of the GNU General Public License as published by the
** Free Software Foundation; either version 3, or (at your option) any
** later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software Foundation,
** Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**
*/
#include <string>

namespace Mu {

/**
 * Setup readline when available and on tty.
 *
 * @param histpath path to the history file
 * @param max_lines maximum number of history to save
 */
void setup_readline(const std::string& histpath, size_t max_lines);

/**
 * Shutdown readline
 *
 */
void shutdown_readline();

/**
 * Read a command line
 *
 * @param do_quit recceives whether we should quit.
 *
 * @return the string read or empty
 */
std::string read_line(bool& do_quit);

/**
 * Save a line to history (or do nothing when readline is not active)
 *
 * @param line a line.
 */
void save_line(const std::string& line);


/**
 * Do we have the non-shim readline?
 *
 * @return true or failse
 */
bool have_readline();

} // namespace Mu