]> Git Repo - qemu.git/blame - util/readline.c
util/qemu-sockets.c: Support specifying IPv4 or IPv6 in socket_dgram()
[qemu.git] / util / readline.c
CommitLineData
7e2515e8
FB
1/*
2 * QEMU readline utility
5fafdf24 3 *
7e2515e8 4 * Copyright (c) 2003-2004 Fabrice Bellard
5fafdf24 5 *
7e2515e8
FB
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
c60bf339
SH
24
25#include "qemu-common.h"
0150cd81 26#include "qemu/readline.h"
7e2515e8 27
7e2515e8
FB
28#define IS_NORM 0
29#define IS_ESC 1
30#define IS_CSI 2
d34dc45d 31#define IS_SS3 3
7e2515e8 32
4c36ba32 33void readline_show_prompt(ReadLineState *rs)
7e2515e8 34{
c60bf339
SH
35 rs->printf_func(rs->opaque, "%s", rs->prompt);
36 rs->flush_func(rs->opaque);
4c36ba32
AL
37 rs->last_cmd_buf_index = 0;
38 rs->last_cmd_buf_size = 0;
39 rs->esc_state = IS_NORM;
7e2515e8
FB
40}
41
7e2515e8 42/* update the displayed command line */
4c36ba32 43static void readline_update(ReadLineState *rs)
7e2515e8
FB
44{
45 int i, delta, len;
46
4c36ba32
AL
47 if (rs->cmd_buf_size != rs->last_cmd_buf_size ||
48 memcmp(rs->cmd_buf, rs->last_cmd_buf, rs->cmd_buf_size) != 0) {
49 for(i = 0; i < rs->last_cmd_buf_index; i++) {
c60bf339 50 rs->printf_func(rs->opaque, "\033[D");
7e2515e8 51 }
4c36ba32
AL
52 rs->cmd_buf[rs->cmd_buf_size] = '\0';
53 if (rs->read_password) {
54 len = strlen(rs->cmd_buf);
7e2515e8 55 for(i = 0; i < len; i++)
c60bf339 56 rs->printf_func(rs->opaque, "*");
7e2515e8 57 } else {
c60bf339 58 rs->printf_func(rs->opaque, "%s", rs->cmd_buf);
7e2515e8 59 }
c60bf339 60 rs->printf_func(rs->opaque, "\033[K");
4c36ba32
AL
61 memcpy(rs->last_cmd_buf, rs->cmd_buf, rs->cmd_buf_size);
62 rs->last_cmd_buf_size = rs->cmd_buf_size;
63 rs->last_cmd_buf_index = rs->cmd_buf_size;
7e2515e8 64 }
4c36ba32
AL
65 if (rs->cmd_buf_index != rs->last_cmd_buf_index) {
66 delta = rs->cmd_buf_index - rs->last_cmd_buf_index;
7e2515e8
FB
67 if (delta > 0) {
68 for(i = 0;i < delta; i++) {
c60bf339 69 rs->printf_func(rs->opaque, "\033[C");
7e2515e8
FB
70 }
71 } else {
72 delta = -delta;
73 for(i = 0;i < delta; i++) {
c60bf339 74 rs->printf_func(rs->opaque, "\033[D");
7e2515e8
FB
75 }
76 }
4c36ba32 77 rs->last_cmd_buf_index = rs->cmd_buf_index;
7e2515e8 78 }
c60bf339 79 rs->flush_func(rs->opaque);
7e2515e8
FB
80}
81
4c36ba32 82static void readline_insert_char(ReadLineState *rs, int ch)
7e2515e8 83{
4c36ba32
AL
84 if (rs->cmd_buf_index < READLINE_CMD_BUF_SIZE) {
85 memmove(rs->cmd_buf + rs->cmd_buf_index + 1,
86 rs->cmd_buf + rs->cmd_buf_index,
87 rs->cmd_buf_size - rs->cmd_buf_index);
88 rs->cmd_buf[rs->cmd_buf_index] = ch;
89 rs->cmd_buf_size++;
90 rs->cmd_buf_index++;
7e2515e8
FB
91 }
92}
93
4c36ba32 94static void readline_backward_char(ReadLineState *rs)
7e2515e8 95{
4c36ba32
AL
96 if (rs->cmd_buf_index > 0) {
97 rs->cmd_buf_index--;
7e2515e8
FB
98 }
99}
100
4c36ba32 101static void readline_forward_char(ReadLineState *rs)
7e2515e8 102{
4c36ba32
AL
103 if (rs->cmd_buf_index < rs->cmd_buf_size) {
104 rs->cmd_buf_index++;
7e2515e8
FB
105 }
106}
107
4c36ba32 108static void readline_delete_char(ReadLineState *rs)
7e2515e8 109{
4c36ba32
AL
110 if (rs->cmd_buf_index < rs->cmd_buf_size) {
111 memmove(rs->cmd_buf + rs->cmd_buf_index,
112 rs->cmd_buf + rs->cmd_buf_index + 1,
113 rs->cmd_buf_size - rs->cmd_buf_index - 1);
114 rs->cmd_buf_size--;
7e2515e8
FB
115 }
116}
117
4c36ba32 118static void readline_backspace(ReadLineState *rs)
7e2515e8 119{
4c36ba32
AL
120 if (rs->cmd_buf_index > 0) {
121 readline_backward_char(rs);
122 readline_delete_char(rs);
7e2515e8
FB
123 }
124}
125
4c36ba32 126static void readline_backword(ReadLineState *rs)
33fa11d4
TS
127{
128 int start;
129
4c36ba32 130 if (rs->cmd_buf_index == 0 || rs->cmd_buf_index > rs->cmd_buf_size) {
33fa11d4
TS
131 return;
132 }
133
4c36ba32 134 start = rs->cmd_buf_index - 1;
33fa11d4
TS
135
136 /* find first word (backwards) */
137 while (start > 0) {
4c36ba32 138 if (!qemu_isspace(rs->cmd_buf[start])) {
33fa11d4
TS
139 break;
140 }
141
142 --start;
143 }
144
145 /* find first space (backwards) */
146 while (start > 0) {
4c36ba32 147 if (qemu_isspace(rs->cmd_buf[start])) {
33fa11d4
TS
148 ++start;
149 break;
150 }
151
152 --start;
153 }
154
155 /* remove word */
4c36ba32
AL
156 if (start < rs->cmd_buf_index) {
157 memmove(rs->cmd_buf + start,
158 rs->cmd_buf + rs->cmd_buf_index,
159 rs->cmd_buf_size - rs->cmd_buf_index);
160 rs->cmd_buf_size -= rs->cmd_buf_index - start;
161 rs->cmd_buf_index = start;
33fa11d4
TS
162 }
163}
164
4c36ba32 165static void readline_bol(ReadLineState *rs)
7e2515e8 166{
4c36ba32 167 rs->cmd_buf_index = 0;
7e2515e8
FB
168}
169
4c36ba32 170static void readline_eol(ReadLineState *rs)
7e2515e8 171{
4c36ba32 172 rs->cmd_buf_index = rs->cmd_buf_size;
7e2515e8
FB
173}
174
4c36ba32 175static void readline_up_char(ReadLineState *rs)
7e2515e8
FB
176{
177 int idx;
178
4c36ba32 179 if (rs->hist_entry == 0)
7e2515e8 180 return;
4c36ba32 181 if (rs->hist_entry == -1) {
7e2515e8 182 /* Find latest entry */
4c36ba32
AL
183 for (idx = 0; idx < READLINE_MAX_CMDS; idx++) {
184 if (rs->history[idx] == NULL)
7e2515e8
FB
185 break;
186 }
4c36ba32 187 rs->hist_entry = idx;
7e2515e8 188 }
4c36ba32
AL
189 rs->hist_entry--;
190 if (rs->hist_entry >= 0) {
191 pstrcpy(rs->cmd_buf, sizeof(rs->cmd_buf),
192 rs->history[rs->hist_entry]);
193 rs->cmd_buf_index = rs->cmd_buf_size = strlen(rs->cmd_buf);
7e2515e8
FB
194 }
195}
196
4c36ba32 197static void readline_down_char(ReadLineState *rs)
7e2515e8 198{
5b0d2727
AL
199 if (rs->hist_entry == -1)
200 return;
201 if (rs->hist_entry < READLINE_MAX_CMDS - 1 &&
202 rs->history[++rs->hist_entry] != NULL) {
4c36ba32
AL
203 pstrcpy(rs->cmd_buf, sizeof(rs->cmd_buf),
204 rs->history[rs->hist_entry]);
7e2515e8 205 } else {
5b0d2727 206 rs->cmd_buf[0] = 0;
4c36ba32 207 rs->hist_entry = -1;
7e2515e8 208 }
4c36ba32 209 rs->cmd_buf_index = rs->cmd_buf_size = strlen(rs->cmd_buf);
7e2515e8
FB
210}
211
4c36ba32 212static void readline_hist_add(ReadLineState *rs, const char *cmdline)
7e2515e8
FB
213{
214 char *hist_entry, *new_entry;
215 int idx;
216
217 if (cmdline[0] == '\0')
218 return;
219 new_entry = NULL;
4c36ba32 220 if (rs->hist_entry != -1) {
7e2515e8 221 /* We were editing an existing history entry: replace it */
4c36ba32
AL
222 hist_entry = rs->history[rs->hist_entry];
223 idx = rs->hist_entry;
7e2515e8
FB
224 if (strcmp(hist_entry, cmdline) == 0) {
225 goto same_entry;
226 }
227 }
228 /* Search cmdline in history buffers */
4c36ba32
AL
229 for (idx = 0; idx < READLINE_MAX_CMDS; idx++) {
230 hist_entry = rs->history[idx];
7e2515e8
FB
231 if (hist_entry == NULL)
232 break;
233 if (strcmp(hist_entry, cmdline) == 0) {
234 same_entry:
235 new_entry = hist_entry;
236 /* Put this entry at the end of history */
4c36ba32 237 memmove(&rs->history[idx], &rs->history[idx + 1],
8af42882 238 (READLINE_MAX_CMDS - (idx + 1)) * sizeof(char *));
4c36ba32
AL
239 rs->history[READLINE_MAX_CMDS - 1] = NULL;
240 for (; idx < READLINE_MAX_CMDS; idx++) {
241 if (rs->history[idx] == NULL)
7e2515e8
FB
242 break;
243 }
244 break;
245 }
246 }
4c36ba32 247 if (idx == READLINE_MAX_CMDS) {
7e2515e8 248 /* Need to get one free slot */
c3baa5f9 249 g_free(rs->history[0]);
7682e858
NZ
250 memmove(rs->history, &rs->history[1],
251 (READLINE_MAX_CMDS - 1) * sizeof(char *));
4c36ba32
AL
252 rs->history[READLINE_MAX_CMDS - 1] = NULL;
253 idx = READLINE_MAX_CMDS - 1;
7e2515e8
FB
254 }
255 if (new_entry == NULL)
c3baa5f9 256 new_entry = g_strdup(cmdline);
4c36ba32
AL
257 rs->history[idx] = new_entry;
258 rs->hist_entry = -1;
7e2515e8
FB
259}
260
261/* completion support */
262
4c36ba32 263void readline_add_completion(ReadLineState *rs, const char *str)
7e2515e8 264{
4c36ba32 265 if (rs->nb_completions < READLINE_MAX_COMPLETIONS) {
e70871d8
HB
266 int i;
267 for (i = 0; i < rs->nb_completions; i++) {
268 if (!strcmp(rs->completions[i], str)) {
269 return;
270 }
271 }
7267c094 272 rs->completions[rs->nb_completions++] = g_strdup(str);
7e2515e8
FB
273 }
274}
275
4c36ba32 276void readline_set_completion_index(ReadLineState *rs, int index)
376253ec 277{
4c36ba32 278 rs->completion_index = index;
376253ec
AL
279}
280
307b2f01
HB
281static int completion_comp(const void *a, const void *b)
282{
283 return strcmp(*(const char **) a, *(const char **) b);
284}
285
4c36ba32 286static void readline_completion(ReadLineState *rs)
7e2515e8 287{
b427c726 288 int len, i, j, max_width, nb_cols, max_prefix;
7e2515e8
FB
289 char *cmdline;
290
4c36ba32 291 rs->nb_completions = 0;
3b46e624 292
6ad7c326 293 cmdline = g_strndup(rs->cmd_buf, rs->cmd_buf_index);
c60bf339 294 rs->completion_finder(rs->opaque, cmdline);
7267c094 295 g_free(cmdline);
7e2515e8
FB
296
297 /* no completion found */
4c36ba32 298 if (rs->nb_completions <= 0)
7e2515e8 299 return;
4c36ba32
AL
300 if (rs->nb_completions == 1) {
301 len = strlen(rs->completions[0]);
302 for(i = rs->completion_index; i < len; i++) {
303 readline_insert_char(rs, rs->completions[0][i]);
7e2515e8
FB
304 }
305 /* extra space for next argument. XXX: make it more generic */
4c36ba32
AL
306 if (len > 0 && rs->completions[0][len - 1] != '/')
307 readline_insert_char(rs, ' ');
7e2515e8 308 } else {
307b2f01
HB
309 qsort(rs->completions, rs->nb_completions, sizeof(char *),
310 completion_comp);
c60bf339 311 rs->printf_func(rs->opaque, "\n");
7e2515e8 312 max_width = 0;
b427c726 313 max_prefix = 0;
4c36ba32
AL
314 for(i = 0; i < rs->nb_completions; i++) {
315 len = strlen(rs->completions[i]);
b427c726
TS
316 if (i==0) {
317 max_prefix = len;
318 } else {
319 if (len < max_prefix)
320 max_prefix = len;
321 for(j=0; j<max_prefix; j++) {
4c36ba32 322 if (rs->completions[i][j] != rs->completions[0][j])
b427c726
TS
323 max_prefix = j;
324 }
325 }
7e2515e8
FB
326 if (len > max_width)
327 max_width = len;
328 }
b427c726 329 if (max_prefix > 0)
4c36ba32
AL
330 for(i = rs->completion_index; i < max_prefix; i++) {
331 readline_insert_char(rs, rs->completions[0][i]);
b427c726 332 }
7e2515e8
FB
333 max_width += 2;
334 if (max_width < 10)
335 max_width = 10;
336 else if (max_width > 80)
337 max_width = 80;
338 nb_cols = 80 / max_width;
339 j = 0;
4c36ba32 340 for(i = 0; i < rs->nb_completions; i++) {
c60bf339 341 rs->printf_func(rs->opaque, "%-*s", max_width, rs->completions[i]);
4c36ba32 342 if (++j == nb_cols || i == (rs->nb_completions - 1)) {
c60bf339 343 rs->printf_func(rs->opaque, "\n");
7e2515e8
FB
344 j = 0;
345 }
346 }
4c36ba32 347 readline_show_prompt(rs);
7e2515e8 348 }
fc9fa4bd
SW
349 for (i = 0; i < rs->nb_completions; i++) {
350 g_free(rs->completions[i]);
351 }
7e2515e8
FB
352}
353
075ccb6c
HB
354static void readline_clear_screen(ReadLineState *rs)
355{
356 rs->printf_func(rs->opaque, "\033[2J\033[1;1H");
357 readline_show_prompt(rs);
358}
359
7e2515e8 360/* return true if command handled */
4c36ba32 361void readline_handle_byte(ReadLineState *rs, int ch)
7e2515e8 362{
4c36ba32 363 switch(rs->esc_state) {
7e2515e8
FB
364 case IS_NORM:
365 switch(ch) {
366 case 1:
4c36ba32 367 readline_bol(rs);
7e2515e8
FB
368 break;
369 case 4:
4c36ba32 370 readline_delete_char(rs);
7e2515e8
FB
371 break;
372 case 5:
4c36ba32 373 readline_eol(rs);
7e2515e8
FB
374 break;
375 case 9:
4c36ba32 376 readline_completion(rs);
7e2515e8 377 break;
075ccb6c
HB
378 case 12:
379 readline_clear_screen(rs);
380 break;
7e2515e8
FB
381 case 10:
382 case 13:
4c36ba32
AL
383 rs->cmd_buf[rs->cmd_buf_size] = '\0';
384 if (!rs->read_password)
385 readline_hist_add(rs, rs->cmd_buf);
c60bf339 386 rs->printf_func(rs->opaque, "\n");
4c36ba32
AL
387 rs->cmd_buf_index = 0;
388 rs->cmd_buf_size = 0;
389 rs->last_cmd_buf_index = 0;
390 rs->last_cmd_buf_size = 0;
c60bf339 391 rs->readline_func(rs->opaque, rs->cmd_buf, rs->readline_opaque);
7e2515e8 392 break;
33fa11d4
TS
393 case 23:
394 /* ^W */
4c36ba32 395 readline_backword(rs);
33fa11d4 396 break;
7e2515e8 397 case 27:
4c36ba32 398 rs->esc_state = IS_ESC;
7e2515e8
FB
399 break;
400 case 127:
401 case 8:
4c36ba32 402 readline_backspace(rs);
7e2515e8
FB
403 break;
404 case 155:
4c36ba32 405 rs->esc_state = IS_CSI;
7e2515e8
FB
406 break;
407 default:
408 if (ch >= 32) {
4c36ba32 409 readline_insert_char(rs, ch);
7e2515e8
FB
410 }
411 break;
412 }
413 break;
414 case IS_ESC:
415 if (ch == '[') {
4c36ba32
AL
416 rs->esc_state = IS_CSI;
417 rs->esc_param = 0;
d34dc45d
KW
418 } else if (ch == 'O') {
419 rs->esc_state = IS_SS3;
420 rs->esc_param = 0;
7e2515e8 421 } else {
4c36ba32 422 rs->esc_state = IS_NORM;
7e2515e8
FB
423 }
424 break;
425 case IS_CSI:
426 switch(ch) {
427 case 'A':
428 case 'F':
4c36ba32 429 readline_up_char(rs);
7e2515e8
FB
430 break;
431 case 'B':
432 case 'E':
4c36ba32 433 readline_down_char(rs);
7e2515e8
FB
434 break;
435 case 'D':
4c36ba32 436 readline_backward_char(rs);
7e2515e8
FB
437 break;
438 case 'C':
4c36ba32 439 readline_forward_char(rs);
7e2515e8
FB
440 break;
441 case '0' ... '9':
4c36ba32 442 rs->esc_param = rs->esc_param * 10 + (ch - '0');
7e2515e8
FB
443 goto the_end;
444 case '~':
4c36ba32 445 switch(rs->esc_param) {
7e2515e8 446 case 1:
4c36ba32 447 readline_bol(rs);
7e2515e8
FB
448 break;
449 case 3:
4c36ba32 450 readline_delete_char(rs);
7e2515e8
FB
451 break;
452 case 4:
4c36ba32 453 readline_eol(rs);
7e2515e8
FB
454 break;
455 }
456 break;
457 default:
458 break;
459 }
4c36ba32 460 rs->esc_state = IS_NORM;
7e2515e8
FB
461 the_end:
462 break;
d34dc45d
KW
463 case IS_SS3:
464 switch(ch) {
465 case 'F':
466 readline_eol(rs);
467 break;
468 case 'H':
469 readline_bol(rs);
470 break;
471 }
472 rs->esc_state = IS_NORM;
473 break;
7e2515e8 474 }
4c36ba32 475 readline_update(rs);
7e2515e8
FB
476}
477
4c36ba32 478void readline_start(ReadLineState *rs, const char *prompt, int read_password,
7e2515e8
FB
479 ReadLineFunc *readline_func, void *opaque)
480{
4c36ba32
AL
481 pstrcpy(rs->prompt, sizeof(rs->prompt), prompt);
482 rs->readline_func = readline_func;
483 rs->readline_opaque = opaque;
484 rs->read_password = read_password;
2724b180
AL
485 readline_restart(rs);
486}
487
488void readline_restart(ReadLineState *rs)
489{
4c36ba32
AL
490 rs->cmd_buf_index = 0;
491 rs->cmd_buf_size = 0;
7e2515e8
FB
492}
493
4c36ba32 494const char *readline_get_history(ReadLineState *rs, unsigned int index)
7e2515e8 495{
4c36ba32 496 if (index >= READLINE_MAX_CMDS)
7e2515e8 497 return NULL;
4c36ba32
AL
498 return rs->history[index];
499}
500
c60bf339
SH
501ReadLineState *readline_init(ReadLinePrintfFunc *printf_func,
502 ReadLineFlushFunc *flush_func,
503 void *opaque,
4c36ba32
AL
504 ReadLineCompletionFunc *completion_finder)
505{
7267c094 506 ReadLineState *rs = g_malloc0(sizeof(*rs));
4c36ba32 507
4c36ba32 508 rs->hist_entry = -1;
c60bf339
SH
509 rs->opaque = opaque;
510 rs->printf_func = printf_func;
511 rs->flush_func = flush_func;
4c36ba32
AL
512 rs->completion_finder = completion_finder;
513
514 return rs;
7e2515e8 515}
This page took 0.797932 seconds and 4 git commands to generate.