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 43 extern "C" { 44 #endif 45 46 #include <stdbool.h> 47 48 typedef struct linenoiseCompletions { 49 size_t len; 50 char **cvec; 51 } linenoiseCompletions; 52 53 typedef void(linenoiseCompletionCallback)(const char *, linenoiseCompletions *); 54 typedef char*(linenoiseHintsCallback)(const char *, int *color, int *bold); 55 typedef void(linenoiseFreeHintsCallback)(void *); 56 void linenoiseSetCompletionCallback(linenoiseCompletionCallback *); 57 void linenoiseSetHintsCallback(linenoiseHintsCallback *); 58 void linenoiseSetFreeHintsCallback(linenoiseFreeHintsCallback *); 59 void linenoiseAddCompletion(linenoiseCompletions *, const char *); 60 61 int linenoiseProbe(void); 62 char *linenoise(const char *prompt); 63 void linenoiseFree(void *ptr); 64 int linenoiseHistoryAdd(const char *line); 65 int linenoiseHistorySetMaxLen(int len); 66 int linenoiseHistorySave(const char *filename); 67 int linenoiseHistoryLoad(const char *filename); 68 void linenoiseHistoryFree(void); 69 void linenoiseClearScreen(void); 70 void linenoiseSetMultiLine(int ml); 71 void linenoiseSetDumbMode(int set); 72 bool linenoiseIsDumbMode(void); 73 void linenoisePrintKeyCodes(void); 74 void linenoiseAllowEmpty(bool); 75 int linenoiseSetMaxLineLen(size_t len); 76 77 #ifdef __cplusplus 78 } 79 #endif 80 81 #endif /* __LINENOISE_H */ 82