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