]> git.proxmox.com Git - qemu.git/blame - readline.c
Merge remote-tracking branch 'mdroth/qga-pull-2013-9-9' into staging
[qemu.git] / 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 */
83c9089e
PB
24#include "monitor/readline.h"
25#include "monitor/monitor.h"
7e2515e8 26
7e2515e8
FB
27#define IS_NORM 0
28#define IS_ESC 1
29#define IS_CSI 2
d34dc45d 30#define IS_SS3 3
7e2515e8 31
30bf5f46 32#undef printf
7e2515e8
FB
33#define printf do_not_use_printf
34
4c36ba32 35void readline_show_prompt(ReadLineState *rs)
7e2515e8 36{
4c36ba32
AL
37 monitor_printf(rs->mon, "%s", rs->prompt);
38 monitor_flush(rs->mon);
39 rs->last_cmd_buf_index = 0;
40 rs->last_cmd_buf_size = 0;
41 rs->esc_state = IS_NORM;
7e2515e8
FB
42}
43
7e2515e8 44/* update the displayed command line */
4c36ba32 45static void readline_update(ReadLineState *rs)
7e2515e8
FB
46{
47 int i, delta, len;
48
4c36ba32
AL
49 if (rs->cmd_buf_size != rs->last_cmd_buf_size ||
50 memcmp(rs->cmd_buf, rs->last_cmd_buf, rs->cmd_buf_size) != 0) {
51 for(i = 0; i < rs->last_cmd_buf_index; i++) {
52 monitor_printf(rs->mon, "\033[D");
7e2515e8 53 }
4c36ba32
AL
54 rs->cmd_buf[rs->cmd_buf_size] = '\0';
55 if (rs->read_password) {
56 len = strlen(rs->cmd_buf);
7e2515e8 57 for(i = 0; i < len; i++)
4c36ba32 58 monitor_printf(rs->mon, "*");
7e2515e8 59 } else {
4c36ba32 60 monitor_printf(rs->mon, "%s", rs->cmd_buf);
7e2515e8 61 }
4c36ba32
AL
62 monitor_printf(rs->mon, "\033[K");
63 memcpy(rs->last_cmd_buf, rs->cmd_buf, rs->cmd_buf_size);
64 rs->last_cmd_buf_size = rs->cmd_buf_size;
65 rs->last_cmd_buf_index = rs->cmd_buf_size;
7e2515e8 66 }
4c36ba32
AL
67 if (rs->cmd_buf_index != rs->last_cmd_buf_index) {
68 delta = rs->cmd_buf_index - rs->last_cmd_buf_index;
7e2515e8
FB
69 if (delta > 0) {
70 for(i = 0;i < delta; i++) {
4c36ba32 71 monitor_printf(rs->mon, "\033[C");
7e2515e8
FB
72 }
73 } else {
74 delta = -delta;
75 for(i = 0;i < delta; i++) {
4c36ba32 76 monitor_printf(rs->mon, "\033[D");
7e2515e8
FB
77 }
78 }
4c36ba32 79 rs->last_cmd_buf_index = rs->cmd_buf_index;
7e2515e8 80 }
4c36ba32 81 monitor_flush(rs->mon);
7e2515e8
FB
82}
83
4c36ba32 84static void readline_insert_char(ReadLineState *rs, int ch)
7e2515e8 85{
4c36ba32
AL
86 if (rs->cmd_buf_index < READLINE_CMD_BUF_SIZE) {
87 memmove(rs->cmd_buf + rs->cmd_buf_index + 1,
88 rs->cmd_buf + rs->cmd_buf_index,
89 rs->cmd_buf_size - rs->cmd_buf_index);
90 rs->cmd_buf[rs->cmd_buf_index] = ch;
91 rs->cmd_buf_size++;
92 rs->cmd_buf_index++;
7e2515e8
FB
93 }
94}
95
4c36ba32 96static void readline_backward_char(ReadLineState *rs)
7e2515e8 97{
4c36ba32
AL
98 if (rs->cmd_buf_index > 0) {
99 rs->cmd_buf_index--;
7e2515e8
FB
100 }
101}
102
4c36ba32 103static void readline_forward_char(ReadLineState *rs)
7e2515e8 104{
4c36ba32
AL
105 if (rs->cmd_buf_index < rs->cmd_buf_size) {
106 rs->cmd_buf_index++;
7e2515e8
FB
107 }
108}
109
4c36ba32 110static void readline_delete_char(ReadLineState *rs)
7e2515e8 111{
4c36ba32
AL
112 if (rs->cmd_buf_index < rs->cmd_buf_size) {
113 memmove(rs->cmd_buf + rs->cmd_buf_index,
114 rs->cmd_buf + rs->cmd_buf_index + 1,
115 rs->cmd_buf_size - rs->cmd_buf_index - 1);
116 rs->cmd_buf_size--;
7e2515e8
FB
117 }
118}
119
4c36ba32 120static void readline_backspace(ReadLineState *rs)
7e2515e8 121{
4c36ba32
AL
122 if (rs->cmd_buf_index > 0) {
123 readline_backward_char(rs);
124 readline_delete_char(rs);
7e2515e8
FB
125 }
126}
127
4c36ba32 128static void readline_backword(ReadLineState *rs)
33fa11d4
TS
129{
130 int start;
131
4c36ba32 132 if (rs->cmd_buf_index == 0 || rs->cmd_buf_index > rs->cmd_buf_size) {
33fa11d4
TS
133 return;
134 }
135
4c36ba32 136 start = rs->cmd_buf_index - 1;
33fa11d4
TS
137
138 /* find first word (backwards) */
139 while (start > 0) {
4c36ba32 140 if (!qemu_isspace(rs->cmd_buf[start])) {
33fa11d4
TS
141 break;
142 }
143
144 --start;
145 }
146
147 /* find first space (backwards) */
148 while (start > 0) {
4c36ba32 149 if (qemu_isspace(rs->cmd_buf[start])) {
33fa11d4
TS
150 ++start;
151 break;
152 }
153
154 --start;
155 }
156
157 /* remove word */
4c36ba32
AL
158 if (start < rs->cmd_buf_index) {
159 memmove(rs->cmd_buf + start,
160 rs->cmd_buf + rs->cmd_buf_index,
161 rs->cmd_buf_size - rs->cmd_buf_index);
162 rs->cmd_buf_size -= rs->cmd_buf_index - start;
163 rs->cmd_buf_index = start;
33fa11d4
TS
164 }
165}
166
4c36ba32 167static void readline_bol(ReadLineState *rs)
7e2515e8 168{
4c36ba32 169 rs->cmd_buf_index = 0;
7e2515e8
FB
170}
171
4c36ba32 172static void readline_eol(ReadLineState *rs)
7e2515e8 173{
4c36ba32 174 rs->cmd_buf_index = rs->cmd_buf_size;
7e2515e8
FB
175}
176
4c36ba32 177static void readline_up_char(ReadLineState *rs)
7e2515e8
FB
178{
179 int idx;
180
4c36ba32 181 if (rs->hist_entry == 0)
7e2515e8 182 return;
4c36ba32 183 if (rs->hist_entry == -1) {
7e2515e8 184 /* Find latest entry */
4c36ba32
AL
185 for (idx = 0; idx < READLINE_MAX_CMDS; idx++) {
186 if (rs->history[idx] == NULL)
7e2515e8
FB
187 break;
188 }
4c36ba32 189 rs->hist_entry = idx;
7e2515e8 190 }
4c36ba32
AL
191 rs->hist_entry--;
192 if (rs->hist_entry >= 0) {
193 pstrcpy(rs->cmd_buf, sizeof(rs->cmd_buf),
194 rs->history[rs->hist_entry]);
195 rs->cmd_buf_index = rs->cmd_buf_size = strlen(rs->cmd_buf);
7e2515e8
FB
196 }
197}
198
4c36ba32 199static void readline_down_char(ReadLineState *rs)
7e2515e8 200{
5b0d2727
AL
201 if (rs->hist_entry == -1)
202 return;
203 if (rs->hist_entry < READLINE_MAX_CMDS - 1 &&
204 rs->history[++rs->hist_entry] != NULL) {
4c36ba32
AL
205 pstrcpy(rs->cmd_buf, sizeof(rs->cmd_buf),
206 rs->history[rs->hist_entry]);
7e2515e8 207 } else {
5b0d2727 208 rs->cmd_buf[0] = 0;
4c36ba32 209 rs->hist_entry = -1;
7e2515e8 210 }
4c36ba32 211 rs->cmd_buf_index = rs->cmd_buf_size = strlen(rs->cmd_buf);
7e2515e8
FB
212}
213
4c36ba32 214static void readline_hist_add(ReadLineState *rs, const char *cmdline)
7e2515e8
FB
215{
216 char *hist_entry, *new_entry;
217 int idx;
218
219 if (cmdline[0] == '\0')
220 return;
221 new_entry = NULL;
4c36ba32 222 if (rs->hist_entry != -1) {
7e2515e8 223 /* We were editing an existing history entry: replace it */
4c36ba32
AL
224 hist_entry = rs->history[rs->hist_entry];
225 idx = rs->hist_entry;
7e2515e8
FB
226 if (strcmp(hist_entry, cmdline) == 0) {
227 goto same_entry;
228 }
229 }
230 /* Search cmdline in history buffers */
4c36ba32
AL
231 for (idx = 0; idx < READLINE_MAX_CMDS; idx++) {
232 hist_entry = rs->history[idx];
7e2515e8
FB
233 if (hist_entry == NULL)
234 break;
235 if (strcmp(hist_entry, cmdline) == 0) {
236 same_entry:
237 new_entry = hist_entry;
238 /* Put this entry at the end of history */
4c36ba32 239 memmove(&rs->history[idx], &rs->history[idx + 1],
8af42882 240 (READLINE_MAX_CMDS - (idx + 1)) * sizeof(char *));
4c36ba32
AL
241 rs->history[READLINE_MAX_CMDS - 1] = NULL;
242 for (; idx < READLINE_MAX_CMDS; idx++) {
243 if (rs->history[idx] == NULL)
7e2515e8
FB
244 break;
245 }
246 break;
247 }
248 }
4c36ba32 249 if (idx == READLINE_MAX_CMDS) {
7e2515e8 250 /* Need to get one free slot */
c3baa5f9 251 g_free(rs->history[0]);
7682e858
NZ
252 memmove(rs->history, &rs->history[1],
253 (READLINE_MAX_CMDS - 1) * sizeof(char *));
4c36ba32
AL
254 rs->history[READLINE_MAX_CMDS - 1] = NULL;
255 idx = READLINE_MAX_CMDS - 1;
7e2515e8
FB
256 }
257 if (new_entry == NULL)
c3baa5f9 258 new_entry = g_strdup(cmdline);
4c36ba32
AL
259 rs->history[idx] = new_entry;
260 rs->hist_entry = -1;
7e2515e8
FB
261}
262
263/* completion support */
264
4c36ba32 265void readline_add_completion(ReadLineState *rs, const char *str)
7e2515e8 266{
4c36ba32 267 if (rs->nb_completions < READLINE_MAX_COMPLETIONS) {
7267c094 268 rs->completions[rs->nb_completions++] = g_strdup(str);
7e2515e8
FB
269 }
270}
271
4c36ba32 272void readline_set_completion_index(ReadLineState *rs, int index)
376253ec 273{
4c36ba32 274 rs->completion_index = index;
376253ec
AL
275}
276
4c36ba32 277static void readline_completion(ReadLineState *rs)
7e2515e8 278{
b427c726 279 int len, i, j, max_width, nb_cols, max_prefix;
7e2515e8
FB
280 char *cmdline;
281
4c36ba32 282 rs->nb_completions = 0;
3b46e624 283
7267c094 284 cmdline = g_malloc(rs->cmd_buf_index + 1);
4c36ba32
AL
285 memcpy(cmdline, rs->cmd_buf, rs->cmd_buf_index);
286 cmdline[rs->cmd_buf_index] = '\0';
d2674b2c 287 rs->completion_finder(rs->mon, cmdline);
7267c094 288 g_free(cmdline);
7e2515e8
FB
289
290 /* no completion found */
4c36ba32 291 if (rs->nb_completions <= 0)
7e2515e8 292 return;
4c36ba32
AL
293 if (rs->nb_completions == 1) {
294 len = strlen(rs->completions[0]);
295 for(i = rs->completion_index; i < len; i++) {
296 readline_insert_char(rs, rs->completions[0][i]);
7e2515e8
FB
297 }
298 /* extra space for next argument. XXX: make it more generic */
4c36ba32
AL
299 if (len > 0 && rs->completions[0][len - 1] != '/')
300 readline_insert_char(rs, ' ');
7e2515e8 301 } else {
d1a9756a 302 monitor_printf(rs->mon, "\n");
7e2515e8 303 max_width = 0;
b427c726 304 max_prefix = 0;
4c36ba32
AL
305 for(i = 0; i < rs->nb_completions; i++) {
306 len = strlen(rs->completions[i]);
b427c726
TS
307 if (i==0) {
308 max_prefix = len;
309 } else {
310 if (len < max_prefix)
311 max_prefix = len;
312 for(j=0; j<max_prefix; j++) {
4c36ba32 313 if (rs->completions[i][j] != rs->completions[0][j])
b427c726
TS
314 max_prefix = j;
315 }
316 }
7e2515e8
FB
317 if (len > max_width)
318 max_width = len;
319 }
b427c726 320 if (max_prefix > 0)
4c36ba32
AL
321 for(i = rs->completion_index; i < max_prefix; i++) {
322 readline_insert_char(rs, rs->completions[0][i]);
b427c726 323 }
7e2515e8
FB
324 max_width += 2;
325 if (max_width < 10)
326 max_width = 10;
327 else if (max_width > 80)
328 max_width = 80;
329 nb_cols = 80 / max_width;
330 j = 0;
4c36ba32
AL
331 for(i = 0; i < rs->nb_completions; i++) {
332 monitor_printf(rs->mon, "%-*s", max_width, rs->completions[i]);
333 if (++j == nb_cols || i == (rs->nb_completions - 1)) {
334 monitor_printf(rs->mon, "\n");
7e2515e8
FB
335 j = 0;
336 }
337 }
4c36ba32 338 readline_show_prompt(rs);
7e2515e8 339 }
fc9fa4bd
SW
340 for (i = 0; i < rs->nb_completions; i++) {
341 g_free(rs->completions[i]);
342 }
7e2515e8
FB
343}
344
345/* return true if command handled */
4c36ba32 346void readline_handle_byte(ReadLineState *rs, int ch)
7e2515e8 347{
4c36ba32 348 switch(rs->esc_state) {
7e2515e8
FB
349 case IS_NORM:
350 switch(ch) {
351 case 1:
4c36ba32 352 readline_bol(rs);
7e2515e8
FB
353 break;
354 case 4:
4c36ba32 355 readline_delete_char(rs);
7e2515e8
FB
356 break;
357 case 5:
4c36ba32 358 readline_eol(rs);
7e2515e8
FB
359 break;
360 case 9:
4c36ba32 361 readline_completion(rs);
7e2515e8
FB
362 break;
363 case 10:
364 case 13:
4c36ba32
AL
365 rs->cmd_buf[rs->cmd_buf_size] = '\0';
366 if (!rs->read_password)
367 readline_hist_add(rs, rs->cmd_buf);
368 monitor_printf(rs->mon, "\n");
369 rs->cmd_buf_index = 0;
370 rs->cmd_buf_size = 0;
371 rs->last_cmd_buf_index = 0;
372 rs->last_cmd_buf_size = 0;
373 rs->readline_func(rs->mon, rs->cmd_buf, rs->readline_opaque);
7e2515e8 374 break;
33fa11d4
TS
375 case 23:
376 /* ^W */
4c36ba32 377 readline_backword(rs);
33fa11d4 378 break;
7e2515e8 379 case 27:
4c36ba32 380 rs->esc_state = IS_ESC;
7e2515e8
FB
381 break;
382 case 127:
383 case 8:
4c36ba32 384 readline_backspace(rs);
7e2515e8
FB
385 break;
386 case 155:
4c36ba32 387 rs->esc_state = IS_CSI;
7e2515e8
FB
388 break;
389 default:
390 if (ch >= 32) {
4c36ba32 391 readline_insert_char(rs, ch);
7e2515e8
FB
392 }
393 break;
394 }
395 break;
396 case IS_ESC:
397 if (ch == '[') {
4c36ba32
AL
398 rs->esc_state = IS_CSI;
399 rs->esc_param = 0;
d34dc45d
KW
400 } else if (ch == 'O') {
401 rs->esc_state = IS_SS3;
402 rs->esc_param = 0;
7e2515e8 403 } else {
4c36ba32 404 rs->esc_state = IS_NORM;
7e2515e8
FB
405 }
406 break;
407 case IS_CSI:
408 switch(ch) {
409 case 'A':
410 case 'F':
4c36ba32 411 readline_up_char(rs);
7e2515e8
FB
412 break;
413 case 'B':
414 case 'E':
4c36ba32 415 readline_down_char(rs);
7e2515e8
FB
416 break;
417 case 'D':
4c36ba32 418 readline_backward_char(rs);
7e2515e8
FB
419 break;
420 case 'C':
4c36ba32 421 readline_forward_char(rs);
7e2515e8
FB
422 break;
423 case '0' ... '9':
4c36ba32 424 rs->esc_param = rs->esc_param * 10 + (ch - '0');
7e2515e8
FB
425 goto the_end;
426 case '~':
4c36ba32 427 switch(rs->esc_param) {
7e2515e8 428 case 1:
4c36ba32 429 readline_bol(rs);
7e2515e8
FB
430 break;
431 case 3:
4c36ba32 432 readline_delete_char(rs);
7e2515e8
FB
433 break;
434 case 4:
4c36ba32 435 readline_eol(rs);
7e2515e8
FB
436 break;
437 }
438 break;
439 default:
440 break;
441 }
4c36ba32 442 rs->esc_state = IS_NORM;
7e2515e8
FB
443 the_end:
444 break;
d34dc45d
KW
445 case IS_SS3:
446 switch(ch) {
447 case 'F':
448 readline_eol(rs);
449 break;
450 case 'H':
451 readline_bol(rs);
452 break;
453 }
454 rs->esc_state = IS_NORM;
455 break;
7e2515e8 456 }
4c36ba32 457 readline_update(rs);
7e2515e8
FB
458}
459
4c36ba32 460void readline_start(ReadLineState *rs, const char *prompt, int read_password,
7e2515e8
FB
461 ReadLineFunc *readline_func, void *opaque)
462{
4c36ba32
AL
463 pstrcpy(rs->prompt, sizeof(rs->prompt), prompt);
464 rs->readline_func = readline_func;
465 rs->readline_opaque = opaque;
466 rs->read_password = read_password;
2724b180
AL
467 readline_restart(rs);
468}
469
470void readline_restart(ReadLineState *rs)
471{
4c36ba32
AL
472 rs->cmd_buf_index = 0;
473 rs->cmd_buf_size = 0;
7e2515e8
FB
474}
475
4c36ba32 476const char *readline_get_history(ReadLineState *rs, unsigned int index)
7e2515e8 477{
4c36ba32 478 if (index >= READLINE_MAX_CMDS)
7e2515e8 479 return NULL;
4c36ba32
AL
480 return rs->history[index];
481}
482
483ReadLineState *readline_init(Monitor *mon,
484 ReadLineCompletionFunc *completion_finder)
485{
7267c094 486 ReadLineState *rs = g_malloc0(sizeof(*rs));
4c36ba32 487
4c36ba32
AL
488 rs->hist_entry = -1;
489 rs->mon = mon;
490 rs->completion_finder = completion_finder;
491
492 return rs;
7e2515e8 493}