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
  34 #ifndef __LINENOISE_H
  35 #define __LINENOISE_H
  36
  37 typedef struct linenoiseCompletions {
  38   size_t len;
  39   char **cvec;
  40 } linenoiseCompletions;
  41
  42 typedef void(linenoiseCompletionCallback)(const char *, linenoiseCompletions *);
  43 void linenoiseSetCompletionCallback(linenoiseCompletionCallback *);
  44 void linenoiseAddCompletion(linenoiseCompletions *, char *);
  45
  46 char *linenoise(const char *prompt);
  47 int linenoiseHistoryAdd(const char *line);
  48 int linenoiseHistorySetMaxLen(int len);
  49 int linenoiseHistorySave(char *filename);
  50 int linenoiseHistoryLoad(char *filename);
  51
  52 #endif /* __LINENOISE_H */