linenoise.h 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  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. #ifndef __LINENOISE_H
  39. #define __LINENOISE_H
  40. #ifdef __cplusplus
  41. extern "C" {
  42. #endif
  43. typedef struct linenoiseCompletions {
  44. size_t len;
  45. char **cvec;
  46. } linenoiseCompletions;
  47. typedef enum linenoiseStatus {
  48. linenoiseStatus_ctrl_unknown,
  49. linenoiseStatus_ctrl_C,
  50. linenoiseStatus_ctrl_D
  51. } linenoiseStatus;
  52. typedef struct linenoiseData {
  53. linenoiseStatus status;
  54. } linenoiseData;
  55. typedef void(linenoiseCompletionCallback)(const char *, linenoiseCompletions *);
  56. typedef char*(linenoiseHintsCallback)(const char *, int *color, int *bold);
  57. typedef void(linenoiseFreeHintsCallback)(void *);
  58. void linenoiseSetCompletionCallback(linenoiseCompletionCallback *);
  59. void linenoiseSetHintsCallback(linenoiseHintsCallback *);
  60. void linenoiseSetFreeHintsCallback(linenoiseFreeHintsCallback *);
  61. void linenoiseAddCompletion(linenoiseCompletions *, const char *);
  62. char *linenoise(const char *prompt);
  63. char *linenoiseExtra(const char *prompt, linenoiseData* data);
  64. void linenoiseFree(void *ptr);
  65. int linenoiseHistoryAdd(const char *line);
  66. int linenoiseHistorySetMaxLen(int len);
  67. int linenoiseHistorySave(const char *filename);
  68. int linenoiseHistoryLoad(const char *filename);
  69. void linenoiseClearScreen(void);
  70. void linenoiseSetMultiLine(int ml);
  71. void linenoisePrintKeyCodes(void);
  72. #ifdef __cplusplus
  73. }
  74. #endif
  75. #endif /* __LINENOISE_H */