1 /* linenoise.h -- guerrilla line editing library against the idea that a
2  * line editing lib needs to be 20,000 lines of C code.
3  *
4  * See linenoise.c for more information.
5  *
6  * ------------------------------------------------------------------------
7  *
8  * Copyright (c) 2010-2014, Salvatore Sanfilippo <antirez at gmail dot com>
9  * Copyright (c) 2010-2013, Pieter Noordhuis <pcnoordhuis at gmail dot com>
10  *
11  * All rights reserved.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions are
15  * met:
16  *
17  *  *  Redistributions of source code must retain the above copyright
18  *     notice, this list of conditions and the following disclaimer.
19  *
20  *  *  Redistributions in binary form must reproduce the above copyright
21  *     notice, this list of conditions and the following disclaimer in the
22  *     documentation and/or other materials provided with the distribution.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35  */
36 
37 #ifndef __LINENOISE_H
38 #define __LINENOISE_H
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 typedef struct linenoiseCompletions {
45   size_t len;
46   char **cvec;
47 } linenoiseCompletions;
48 
49 typedef void(linenoiseCompletionCallback)(const char *, linenoiseCompletions *);
50 void linenoiseSetCompletionCallback(linenoiseCompletionCallback *);
51 void linenoiseAddCompletion(linenoiseCompletions *, const char *);
52 
53 char *linenoise(const char *prompt);
54 int linenoiseHistoryAdd(const char *line);
55 int linenoiseHistorySetMaxLen(int len);
56 int linenoiseHistorySave(const char *filename);
57 int linenoiseHistoryLoad(const char *filename);
58 void linenoiseClearScreen(void);
59 void linenoiseSetMultiLine(int ml);
60 void linenoisePrintKeyCodes(void);
61 
62 #ifdef __cplusplus
63 }
64 #endif
65 
66 #endif /* __LINENOISE_H */
67