Repository navigation
Expand file tree
/
Copy pathlinenoise.h
More file actions
164 lines (149 loc) · 7.18 KB
/
Copy pathlinenoise.h
File metadata and controls
164 lines (149 loc) · 7.18 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/* linenoise.h -- VERSION 1.0
*
* Guerrilla line editing library against the idea that a line editing lib
* needs to be 20,000 lines of C code.
*
* See linenoise.c for more information.
*
* ------------------------------------------------------------------------
*
* Copyright (c) 2010-2023, Salvatore Sanfilippo <antirez at gmail dot com>
* Copyright (c) 2010-2013, Pieter Noordhuis <pcnoordhuis at gmail dot com>
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef __LINENOISE_H
#define __LINENOISE_H
#ifdef __cplusplus
extern "C" {
#endif
#include <stddef.h> /* For size_t. */
#include <stdint.h>
extern char *linenoiseEditMore;
#define LINENOISE_MAX_FOLDS 16
struct linenoiseState;
typedef int(linenoiseLayoutCallback)(struct linenoiseState *l,
size_t prompt_rows,
size_t status_rows,
void *privdata);
/* The linenoiseState structure represents the state during line editing.
* We pass this state to functions implementing specific editing
* functionalities. */
struct linenoiseState {
int in_completion; /* The user pressed TAB and we are now in completion
* mode, so input is handled by completeLine(). */
size_t completion_idx; /* Index of next completion to propose. */
int ifd; /* Terminal stdin file descriptor. */
int ofd; /* Terminal stdout file descriptor. */
char *buf; /* Edited line buffer. */
size_t buflen; /* Edited line buffer size. */
size_t buflen_max; /* Max buffer size, or 0 if fixed. */
const char *prompt; /* Prompt to display. */
size_t plen; /* Prompt length. */
size_t pos; /* Current cursor position. */
size_t oldpos; /* Previous refresh cursor position. */
size_t len; /* Current edited line length. */
size_t cols; /* Number of columns in terminal. */
size_t oldrows; /* Rows used by last refreshed line (multiline mode) */
size_t oldstatusrows; /* Extra status rows used by last refresh. */
int oldrpos; /* Cursor row from last refresh (for multiline clearing). */
int history_index; /* The history index we are currently editing. */
int fold_count; /* Number of folded ranges. */
size_t fold_start[LINENOISE_MAX_FOLDS]; /* Folded range start offsets. */
size_t fold_end[LINENOISE_MAX_FOLDS]; /* Folded range end offsets. */
char *status; /* Optional status/footer rendered below the prompt. */
char *status_start; /* Optional escape sequence emitted before status. */
char *status_end; /* Optional escape sequence emitted after status. */
linenoiseLayoutCallback *layout_callback; /* Called before refresh writes. */
void *layout_privdata;
int screen_cursor_row; /* Absolute terminal cursor row after last refresh. */
int screen_cursor_col; /* Absolute terminal cursor col after last refresh. */
char *queued_input; /* Bytes already read by an outer event loop. */
size_t queued_input_len;
size_t queued_input_pos;
size_t queued_input_cap;
char pending_key[32]; /* Incomplete UTF-8 or escape sequence. */
size_t pending_key_len;
char *paste_buf;
size_t paste_len, paste_cap, paste_match;
int paste_active, paste_overflowed;
};
typedef struct linenoiseCompletions {
size_t len;
char **cvec;
} linenoiseCompletions;
/* Non blocking API. */
int linenoiseEditStart(struct linenoiseState *l, int stdin_fd, int stdout_fd, char *buf, size_t buflen, const char *prompt);
char *linenoiseEditFeed(struct linenoiseState *l);
char *linenoiseEditFeedByte(struct linenoiseState *l, char c);
int linenoiseEditQueueInput(struct linenoiseState *l, const char *buf, size_t len);
size_t linenoiseEditQueuedInput(struct linenoiseState *l);
void linenoiseEditClear(struct linenoiseState *l);
int linenoiseEditSetStatus(struct linenoiseState *l, const char *status,
const char *start_escape, const char *end_escape);
void linenoiseEditSetLayoutCallback(struct linenoiseState *l,
linenoiseLayoutCallback *fn,
void *privdata);
void linenoiseEditStop(struct linenoiseState *l);
void linenoiseHide(struct linenoiseState *l);
void linenoiseShow(struct linenoiseState *l);
/* UI-thread-only buffered updates; nested updates share one terminal frame. */
void linenoiseBeginUpdate(int fd);
void linenoiseEndUpdate(void);
int linenoiseWrite(int fd, const char *text, size_t len);
/* Repaint only the footer if its geometry and absolute cursor are known. */
int linenoiseRefreshStatus(struct linenoiseState *l);
size_t linenoiseUtf8Decode(const char *text, size_t len, uint32_t *cp);
int linenoiseCharacterWidth(uint32_t cp);
size_t linenoiseNextGrapheme(const char *text, size_t len, int *width);
/* Blocking API. */
char *linenoise(const char *prompt);
void linenoiseFree(void *ptr);
/* Completion API. */
typedef void(linenoiseCompletionCallback)(const char *, linenoiseCompletions *);
typedef char*(linenoiseHintsCallback)(const char *, int *color, int *bold);
typedef void(linenoiseFreeHintsCallback)(void *);
void linenoiseSetCompletionCallback(linenoiseCompletionCallback *);
void linenoiseSetHintsCallback(linenoiseHintsCallback *);
void linenoiseSetFreeHintsCallback(linenoiseFreeHintsCallback *);
void linenoiseAddCompletion(linenoiseCompletions *, const char *);
/* History API. */
int linenoiseHistoryAdd(const char *line);
int linenoiseHistorySetMaxLen(int len);
int linenoiseHistorySave(const char *filename);
int linenoiseHistoryLoad(const char *filename);
/* Other utilities. */
void linenoiseClearScreen(void);
void linenoiseSetMultiLine(int ml);
void linenoisePrintKeyCodes(void);
void linenoiseMaskModeEnable(void);
void linenoiseMaskModeDisable(void);
/* Re-enable raw mode if a child process changed the terminal state. */
void linenoiseRestoreRawMode(void);
#ifdef __cplusplus
}
#endif
#endif /* __LINENOISE_H */