util/linenoise.h

   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  * Copyright (c) 2010, Salvatore Sanfilippo <antirez at gmail dot com>
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright notice,
  13  *     this list of conditions and the following disclaimer.
  14  *   * Redistributions in binary form must reproduce the above copyright
  15  *     notice, this list of conditions and the following disclaimer in the
  16  *     documentation and/or other materials provided with the distribution.
  17  *   * Neither the name of Redis nor the names of its contributors may be used
  18  *     to endorse or promote products derived from this software without
  19  *     specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  */
  33 #ifndef _LINENOISE_H_
  34 #define _LINENOISE_H_
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40
  41 /* do not overflow buf in autocompletion; remember that buffer is ASCIIZ string */
  42 #define LINENOISE_MAX_LINE_LEN  (4096)
  43
  44
  45 /* DO NOT free result; DO NOT call it recursive or in multithread app w/o locking */
  46 extern char *linenoise (const char *prompt, const char *defval);
  47 extern int linenoiseHistoryAdd (const char *line); // !0: error
  48 extern int linenoiseHistorySetMaxLen (int len); // !0: error
  49 extern void linenoiseClearHistory (void);
  50
  51 extern int linenoiseHistorySave (FILE *fl); // !0: error
  52 extern int linenoiseHistoryLoad (FILE *fl); // !0: error
  53
  54 extern int linenoiseHistorySaveFile (const char *fname); // !0: error
  55 extern int linenoiseHistoryLoadFile (const char *fname); // !0: error
  56
  57 /* autocompletion hook */
  58 /* cols: # of columns in console */
  59 typedef void (*linenoiseACHookFn) (char *buf, int *posp, int len, size_t cols);
  60 extern linenoiseACHookFn linenoiseACHook;
  61
  62 extern int linenoiseOptHilightBrackets;
  63 extern const char *linenoiseBrcHiStr;
  64
  65
  66 #ifdef __cplusplus
  67 }
  68 #endif
  69 #endif