2 * Copyright (c) <2010>, Intel Corporation
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
17 * - Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
27 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
30 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
32 * OF THE POSSIBILITY OF SUCH DAMAGE.
36 * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
37 * All rights reserved.
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions are met:
41 * * Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * * Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in the
45 * documentation and/or other materials provided with the distribution.
46 * * Neither the name of the University of California, Berkeley nor the
47 * names of its contributors may be used to endorse or promote products
48 * derived from this software without specific prior written permission.
50 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
51 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
52 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
53 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
54 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
55 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
56 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
57 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
58 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
59 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
69 #include "cmdline_cirbuf.h"
70 #include "cmdline_rdline.h"
72 static void rdline_puts(struct rdline *rdl, const char *buf);
73 static void rdline_miniprintf(struct rdline *rdl,
74 const char *buf, unsigned int val);
76 #ifndef NO_RDLINE_HISTORY
77 static void rdline_remove_old_history_item(struct rdline *rdl);
78 static void rdline_remove_first_history_item(struct rdline *rdl);
79 static unsigned int rdline_get_history_size(struct rdline *rdl);
80 #endif /* !NO_RDLINE_HISTORY */
83 /* isblank() needs _XOPEN_SOURCE >= 600 || _ISOC99_SOURCE, so use our
95 rdline_init(struct rdline *rdl,
96 rdline_write_char_t *write_char,
97 rdline_validate_t *validate,
98 rdline_complete_t *complete)
100 memset(rdl, 0, sizeof(*rdl));
101 rdl->validate = validate;
102 rdl->complete = complete;
103 rdl->write_char = write_char;
104 rdl->status = RDLINE_INIT;
105 #ifndef NO_RDLINE_HISTORY
106 cirbuf_init(&rdl->history, rdl->history_buf, 0, RDLINE_HISTORY_BUF_SIZE);
107 #endif /* !NO_RDLINE_HISTORY */
111 rdline_newline(struct rdline *rdl, const char *prompt)
115 vt100_init(&rdl->vt100);
116 cirbuf_init(&rdl->left, rdl->left_buf, 0, RDLINE_BUF_SIZE);
117 cirbuf_init(&rdl->right, rdl->right_buf, 0, RDLINE_BUF_SIZE);
119 if (prompt != rdl->prompt)
120 memcpy(rdl->prompt, prompt, sizeof(rdl->prompt)-1);
121 rdl->prompt_size = strlen(prompt);
123 for (i=0 ; i<rdl->prompt_size ; i++)
124 rdl->write_char(rdl, rdl->prompt[i]);
125 rdl->status = RDLINE_RUNNING;
127 #ifndef NO_RDLINE_HISTORY
128 rdl->history_cur_line = -1;
129 #endif /* !NO_RDLINE_HISTORY */
133 rdline_stop(struct rdline *rdl)
135 rdl->status = RDLINE_INIT;
139 rdline_restart(struct rdline *rdl)
141 rdl->status = RDLINE_RUNNING;
145 rdline_get_buffer(struct rdline *rdl)
147 unsigned int len_l, len_r;
148 cirbuf_align_left(&rdl->left);
149 cirbuf_align_left(&rdl->right);
151 len_l = CIRBUF_GET_LEN(&rdl->left);
152 len_r = CIRBUF_GET_LEN(&rdl->right);
153 memcpy(rdl->left_buf+len_l, rdl->right_buf, len_r);
155 rdl->left_buf[len_l + len_r] = '\n';
156 rdl->left_buf[len_l + len_r + 1] = '\0';
157 return rdl->left_buf;
161 display_right_buffer(struct rdline *rdl)
166 rdline_puts(rdl, vt100_clear_right);
167 if (!CIRBUF_IS_EMPTY(&rdl->right)) {
168 CIRBUF_FOREACH(&rdl->right, i, tmp) {
169 rdl->write_char(rdl, tmp);
171 rdline_miniprintf(rdl, vt100_multi_left,
172 CIRBUF_GET_LEN(&rdl->right));
177 rdline_redisplay(struct rdline *rdl)
182 rdline_puts(rdl, vt100_home);
183 for (i=0 ; i<rdl->prompt_size ; i++)
184 rdl->write_char(rdl, rdl->prompt[i]);
185 CIRBUF_FOREACH(&rdl->left, i, tmp) {
186 rdl->write_char(rdl, tmp);
188 display_right_buffer(rdl);
192 rdline_char_in(struct rdline *rdl, char c)
197 #ifndef NO_RDLINE_HISTORY
201 if (rdl->status != RDLINE_RUNNING)
202 return RDLINE_RES_NOT_RUNNING;
204 cmd = vt100_parser(&rdl->vt100, c);
206 return RDLINE_RES_SUCCESS;
210 case CMDLINE_KEY_CTRL_B:
211 case CMDLINE_KEY_LEFT_ARR:
212 if (CIRBUF_IS_EMPTY(&rdl->left))
214 tmp = cirbuf_get_tail(&rdl->left);
215 cirbuf_del_tail(&rdl->left);
216 cirbuf_add_head(&rdl->right, tmp);
217 rdline_puts(rdl, vt100_left_arr);
220 case CMDLINE_KEY_CTRL_F:
221 case CMDLINE_KEY_RIGHT_ARR:
222 if (CIRBUF_IS_EMPTY(&rdl->right))
224 tmp = cirbuf_get_head(&rdl->right);
225 cirbuf_del_head(&rdl->right);
226 cirbuf_add_tail(&rdl->left, tmp);
227 rdline_puts(rdl, vt100_right_arr);
230 case CMDLINE_KEY_WLEFT:
231 while (! CIRBUF_IS_EMPTY(&rdl->left) &&
232 (tmp = cirbuf_get_tail(&rdl->left)) &&
234 rdline_puts(rdl, vt100_left_arr);
235 cirbuf_del_tail(&rdl->left);
236 cirbuf_add_head(&rdl->right, tmp);
238 while (! CIRBUF_IS_EMPTY(&rdl->left) &&
239 (tmp = cirbuf_get_tail(&rdl->left)) &&
241 rdline_puts(rdl, vt100_left_arr);
242 cirbuf_del_tail(&rdl->left);
243 cirbuf_add_head(&rdl->right, tmp);
247 case CMDLINE_KEY_WRIGHT:
248 while (! CIRBUF_IS_EMPTY(&rdl->right) &&
249 (tmp = cirbuf_get_head(&rdl->right)) &&
251 rdline_puts(rdl, vt100_right_arr);
252 cirbuf_del_head(&rdl->right);
253 cirbuf_add_tail(&rdl->left, tmp);
255 while (! CIRBUF_IS_EMPTY(&rdl->right) &&
256 (tmp = cirbuf_get_head(&rdl->right)) &&
258 rdline_puts(rdl, vt100_right_arr);
259 cirbuf_del_head(&rdl->right);
260 cirbuf_add_tail(&rdl->left, tmp);
264 case CMDLINE_KEY_BKSPACE:
265 if(!cirbuf_del_tail_safe(&rdl->left)) {
266 rdline_puts(rdl, vt100_bs);
267 display_right_buffer(rdl);
271 case CMDLINE_KEY_META_BKSPACE:
272 while (! CIRBUF_IS_EMPTY(&rdl->left) && isblank2(cirbuf_get_tail(&rdl->left))) {
273 rdline_puts(rdl, vt100_bs);
274 cirbuf_del_tail(&rdl->left);
276 while (! CIRBUF_IS_EMPTY(&rdl->left) && !isblank2(cirbuf_get_tail(&rdl->left))) {
277 rdline_puts(rdl, vt100_bs);
278 cirbuf_del_tail(&rdl->left);
280 display_right_buffer(rdl);
283 case CMDLINE_KEY_SUPPR:
284 case CMDLINE_KEY_CTRL_D:
285 if (cmd == CMDLINE_KEY_CTRL_D &&
286 CIRBUF_IS_EMPTY(&rdl->left) &&
287 CIRBUF_IS_EMPTY(&rdl->right)) {
288 return RDLINE_RES_EOF;
290 if (!cirbuf_del_head_safe(&rdl->right)) {
291 display_right_buffer(rdl);
295 case CMDLINE_KEY_CTRL_A:
296 if (CIRBUF_IS_EMPTY(&rdl->left))
298 rdline_miniprintf(rdl, vt100_multi_left,
299 CIRBUF_GET_LEN(&rdl->left));
300 while (! CIRBUF_IS_EMPTY(&rdl->left)) {
301 tmp = cirbuf_get_tail(&rdl->left);
302 cirbuf_del_tail(&rdl->left);
303 cirbuf_add_head(&rdl->right, tmp);
307 case CMDLINE_KEY_CTRL_E:
308 if (CIRBUF_IS_EMPTY(&rdl->right))
310 rdline_miniprintf(rdl, vt100_multi_right,
311 CIRBUF_GET_LEN(&rdl->right));
312 while (! CIRBUF_IS_EMPTY(&rdl->right)) {
313 tmp = cirbuf_get_head(&rdl->right);
314 cirbuf_del_head(&rdl->right);
315 cirbuf_add_tail(&rdl->left, tmp);
319 #ifndef NO_RDLINE_KILL_BUF
320 case CMDLINE_KEY_CTRL_K:
321 cirbuf_get_buf_head(&rdl->right, rdl->kill_buf, RDLINE_BUF_SIZE);
322 rdl->kill_size = CIRBUF_GET_LEN(&rdl->right);
323 cirbuf_del_buf_head(&rdl->right, rdl->kill_size);
324 rdline_puts(rdl, vt100_clear_right);
327 case CMDLINE_KEY_CTRL_Y:
329 while(CIRBUF_GET_LEN(&rdl->right) + CIRBUF_GET_LEN(&rdl->left) <
331 i < rdl->kill_size) {
332 cirbuf_add_tail(&rdl->left, rdl->kill_buf[i]);
333 rdl->write_char(rdl, rdl->kill_buf[i]);
336 display_right_buffer(rdl);
338 #endif /* !NO_RDLINE_KILL_BUF */
340 case CMDLINE_KEY_CTRL_C:
341 rdline_puts(rdl, "\r\n");
342 rdline_newline(rdl, rdl->prompt);
345 case CMDLINE_KEY_CTRL_L:
346 rdline_redisplay(rdl);
349 case CMDLINE_KEY_TAB:
350 case CMDLINE_KEY_HELP:
351 cirbuf_align_left(&rdl->left);
352 rdl->left_buf[CIRBUF_GET_LEN(&rdl->left)] = '\0';
354 char tmp_buf[BUFSIZ];
357 unsigned int tmp_size;
359 if (cmd == CMDLINE_KEY_TAB)
364 /* see in parse.h for help on complete() */
365 ret = rdl->complete(rdl, rdl->left_buf,
366 tmp_buf, sizeof(tmp_buf),
368 /* no completion or error */
370 return RDLINE_RES_COMPLETE;
373 tmp_size = strlen(tmp_buf);
375 if (ret == RDLINE_RES_COMPLETE) {
377 while(CIRBUF_GET_LEN(&rdl->right) + CIRBUF_GET_LEN(&rdl->left) <
380 cirbuf_add_tail(&rdl->left, tmp_buf[i]);
381 rdl->write_char(rdl, tmp_buf[i]);
384 display_right_buffer(rdl);
385 return RDLINE_RES_COMPLETE; /* ?? */
389 rdline_puts(rdl, "\r\n");
391 rdl->write_char(rdl, ' ');
392 for (i=0 ; tmp_buf[i] ; i++)
393 rdl->write_char(rdl, tmp_buf[i]);
394 rdline_puts(rdl, "\r\n");
395 ret = rdl->complete(rdl, rdl->left_buf,
396 tmp_buf, sizeof(tmp_buf),
400 rdline_redisplay(rdl);
402 return RDLINE_RES_COMPLETE;
404 case CMDLINE_KEY_RETURN:
405 case CMDLINE_KEY_RETURN2:
406 rdline_get_buffer(rdl);
407 rdl->status = RDLINE_INIT;
408 rdline_puts(rdl, "\r\n");
409 #ifndef NO_RDLINE_HISTORY
410 if (rdl->history_cur_line != -1)
411 rdline_remove_first_history_item(rdl);
415 rdl->validate(rdl, rdl->left_buf, CIRBUF_GET_LEN(&rdl->left)+2);
416 return RDLINE_RES_VALIDATED;
418 #ifndef NO_RDLINE_HISTORY
419 case CMDLINE_KEY_UP_ARR:
420 if (rdl->history_cur_line == 0) {
421 rdline_remove_first_history_item(rdl);
423 if (rdl->history_cur_line <= 0) {
424 rdline_add_history(rdl, rdline_get_buffer(rdl));
425 rdl->history_cur_line = 0;
428 buf = rdline_get_history_item(rdl, rdl->history_cur_line + 1);
432 rdl->history_cur_line ++;
433 vt100_init(&rdl->vt100);
434 cirbuf_init(&rdl->left, rdl->left_buf, 0, RDLINE_BUF_SIZE);
435 cirbuf_init(&rdl->right, rdl->right_buf, 0, RDLINE_BUF_SIZE);
436 cirbuf_add_buf_tail(&rdl->left, buf, strlen(buf));
437 rdline_redisplay(rdl);
440 case CMDLINE_KEY_DOWN_ARR:
441 if (rdl->history_cur_line - 1 < 0)
444 rdl->history_cur_line --;
445 buf = rdline_get_history_item(rdl, rdl->history_cur_line);
448 vt100_init(&rdl->vt100);
449 cirbuf_init(&rdl->left, rdl->left_buf, 0, RDLINE_BUF_SIZE);
450 cirbuf_init(&rdl->right, rdl->right_buf, 0, RDLINE_BUF_SIZE);
451 cirbuf_add_buf_tail(&rdl->left, buf, strlen(buf));
452 rdline_redisplay(rdl);
455 #endif /* !NO_RDLINE_HISTORY */
462 return RDLINE_RES_SUCCESS;
465 if (!isprint((int)c))
466 return RDLINE_RES_SUCCESS;
469 if (CIRBUF_GET_LEN(&rdl->left) + CIRBUF_GET_LEN(&rdl->right) >= RDLINE_BUF_SIZE)
470 return RDLINE_RES_SUCCESS;
472 if (cirbuf_add_tail_safe(&rdl->left, c))
473 return RDLINE_RES_SUCCESS;
475 rdl->write_char(rdl, c);
476 display_right_buffer(rdl);
478 return RDLINE_RES_SUCCESS;
484 #ifndef NO_RDLINE_HISTORY
486 rdline_remove_old_history_item(struct rdline * rdl)
490 while (! CIRBUF_IS_EMPTY(&rdl->history) ) {
491 tmp = cirbuf_get_head(&rdl->history);
492 cirbuf_del_head(&rdl->history);
499 rdline_remove_first_history_item(struct rdline * rdl)
503 if ( CIRBUF_IS_EMPTY(&rdl->history) ) {
507 cirbuf_del_tail(&rdl->history);
510 while (! CIRBUF_IS_EMPTY(&rdl->history) ) {
511 tmp = cirbuf_get_tail(&rdl->history);
514 cirbuf_del_tail(&rdl->history);
519 rdline_get_history_size(struct rdline * rdl)
521 unsigned int i, tmp, ret=0;
523 CIRBUF_FOREACH(&rdl->history, i, tmp) {
532 rdline_get_history_item(struct rdline * rdl, unsigned int idx)
534 unsigned int len, i, tmp;
536 len = rdline_get_history_size(rdl);
541 cirbuf_align_left(&rdl->history);
543 CIRBUF_FOREACH(&rdl->history, i, tmp) {
544 if ( idx == len - 1) {
545 return rdl->history_buf + i;
555 rdline_add_history(struct rdline * rdl, const char * buf)
560 for (i=0; i<len ; i++) {
561 if (buf[i] == '\n') {
567 if ( len >= RDLINE_HISTORY_BUF_SIZE )
570 while ( len >= CIRBUF_GET_FREELEN(&rdl->history) ) {
571 rdline_remove_old_history_item(rdl);
574 cirbuf_add_buf_tail(&rdl->history, buf, len);
575 cirbuf_add_tail(&rdl->history, 0);
581 rdline_clear_history(struct rdline * rdl)
583 cirbuf_init(&rdl->history, rdl->history_buf, 0, RDLINE_HISTORY_BUF_SIZE);
586 #else /* !NO_RDLINE_HISTORY */
588 int rdline_add_history(struct rdline * rdl, const char * buf) {return -1;}
589 void rdline_clear_history(struct rdline * rdl) {}
590 char * rdline_get_history_item(struct rdline * rdl, unsigned int i) {return NULL;}
593 #endif /* !NO_RDLINE_HISTORY */
596 /* STATIC USEFUL FUNCS */
599 rdline_puts(struct rdline * rdl, const char * buf)
602 while ( (c = *(buf++)) != '\0' ) {
603 rdl->write_char(rdl, c);
607 /* a very very basic printf with one arg and one format 'u' */
609 rdline_miniprintf(struct rdline *rdl, const char * buf, unsigned int val)
611 char c, started=0, div=100;
613 while ( (c=*(buf++)) ) {
615 rdl->write_char(rdl, c);
620 rdl->write_char(rdl, '%');
621 rdl->write_char(rdl, c);
624 /* val is never more than 255 */
626 c = (char)(val / div);
628 rdl->write_char(rdl, (char)(c+'0'));