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