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 <netinet/in.h>
71 #include "cmdline_parse.h"
74 //#define CMDLINE_DEBUG
75 //#define debug_printf printf
76 #define debug_printf(args...) do {} while(0)
78 /* isblank() needs _XOPEN_SOURCE >= 600 || _ISOC99_SOURCE, so use our
107 cmdline_isendoftoken(char c)
109 if (!c || iscomment(c) || isblank2(c) || isendofline(c))
115 nb_common_chars(const char * s1, const char * s2)
119 while (*s1==*s2 && *s1 && *s2) {
127 /* quote a string and escape original quotes */
128 int cmdline_quote_token(char *dst, unsigned dstlen, const char *src)
130 unsigned s = 0, d = 0;
132 /* the 2 quotes + '\0' */
137 while (src[s] != '\0') {
143 if (src[s] == '\\' && src[s+1] == '"')
156 /* remove quote and stop when we reach the end of token */
157 // XXX ret val comment
158 int cmdline_unquote_token(char *dst, unsigned dstlen,
161 unsigned s = 0, d = 0;
164 while (src[s] != '\0') {
168 if (cmdline_isendoftoken(src[s]) && quoted == 0)
171 if (src[s] == '\\' && src[s+1] == '"') {
176 if (src[s] == '\\' && src[s+1] == '\\') {
199 * try to match the buffer with an instruction (only the first
200 * nb_match_token tokens if != 0). Return 0 if we match all the
201 * tokens, else the number of matched tokens, else -1.
204 match_inst(cmdline_parse_inst_t *inst, const char *buf,
205 unsigned int nb_match_token, void * result_buf)
207 unsigned int token_num=0;
208 cmdline_parse_token_hdr_t * token_p;
211 struct cmdline_token_hdr token_hdr;
214 token_p = inst->tokens[token_num];
216 memcpy(&token_hdr, token_p, sizeof(token_hdr));
218 /* check if we match all tokens of inst */
219 while (token_p && (!nb_match_token || i<nb_match_token)) {
220 debug_printf("TK\n");
222 while (isblank2(*buf)) {
227 if ( isendofline(*buf) || iscomment(*buf) )
230 n = cmdline_unquote_token(token_str, sizeof(token_str), buf);
235 res = token_hdr.ops->parse(token_p, token_str,
239 res = token_hdr.ops->parse(token_p, token_str, NULL);
243 debug_printf("TK parsed (len=%d)\n", n);
248 token_p = inst->tokens[token_num];
250 memcpy(&token_hdr, token_p, sizeof(token_hdr));
257 /* in case we want to match a specific num of token */
258 if (nb_match_token) {
259 if (i == nb_match_token) {
265 /* we don't match all the tokens */
270 /* are there are some tokens more */
271 while (isblank2(*buf)) {
276 if ( isendofline(*buf) || iscomment(*buf) )
279 /* garbage after inst */
285 cmdline_parse(struct cmdline *cl, const char * buf)
287 unsigned int inst_num=0;
288 cmdline_parse_inst_t *inst;
290 char result_buf[BUFSIZ];
291 void (*f)(void *, struct cmdline *, void *) = NULL;
296 int err = CMDLINE_PARSE_NOMATCH;
298 cmdline_parse_ctx_t *ctx = cl->ctx;
300 char debug_buf[BUFSIZ];
304 * - look if the buffer contains at least one line
305 * - look if line contains only spaces or comments
306 * - count line length
309 while (! isendofline(*curbuf)) {
310 if ( *curbuf == '\0' ) {
311 debug_printf("Incomplete buf (len=%d)\n", linelen);
314 if ( iscomment(*curbuf) ) {
317 if ( ! isblank2(*curbuf) && ! comment) {
324 /* skip all endofline chars */
325 while (isendofline(buf[linelen])) {
330 if ( parse_it == 0 ) {
331 debug_printf("Empty line (len=%d)\n", linelen);
336 snprintf(debug_buf, (linelen>64 ? 64 : linelen), "%s", buf);
337 debug_printf("Parse line : len=%d, <%s>\n", linelen, debug_buf);
341 inst = ctx[inst_num];
343 debug_printf("INST %d\n", inst_num);
346 tok = match_inst(inst, buf, 0, result_buf);
348 if (tok > 0) /* we matched at least one token */
349 err = CMDLINE_PARSE_BAD_ARGS;
352 debug_printf("INST fully parsed\n");
354 while (isblank2(*curbuf)) {
358 /* if end of buf -> there is no garbage after inst */
359 if (isendofline(*curbuf) || iscomment(*curbuf)) {
361 memcpy(&f, &inst->f, sizeof(f));
362 memcpy(&data, &inst->data, sizeof(data));
365 /* more than 1 inst matches */
366 err = CMDLINE_PARSE_AMBIGUOUS;
368 debug_printf("Ambiguous cmd\n");
373 else if (tok == -EINVAL) {
374 err = CMDLINE_PARSE_UNTERMINATED_QUOTE;
376 debug_printf("Unterminated quote\n");
381 inst = ctx[inst_num];
386 f(result_buf, cl, data);
391 debug_printf("No match err=%d\n", err);
399 cmdline_complete(struct cmdline *cl, const char *buf, int *state,
400 char *dst, unsigned int size)
402 const char *partial_tok = buf;
403 unsigned int inst_num = 0;
404 cmdline_parse_inst_t *inst;
405 cmdline_parse_token_hdr_t *token_p;
406 struct cmdline_token_hdr token_hdr;
407 char tmpbuf[64], comp_buf[64];
408 unsigned int partial_tok_len;
413 unsigned int nb_completable;
414 unsigned int nb_non_completable;
417 cmdline_parse_ctx_t *ctx = cl->ctx;
419 debug_printf("%s called\n", __FUNCTION__);
420 memset(&token_hdr, 0, sizeof(token_hdr));
422 /* count the number of complete token to parse */
423 for (i=0 ; buf[i] ; i++) {
424 if (!isblank2(buf[i]) && isblank2(buf[i+1]))
426 if (isblank2(buf[i]) && !isblank2(buf[i+1]))
427 partial_tok = buf+i+1;
429 partial_tok_len = strlen(partial_tok);
431 /* first call -> do a first pass */
433 debug_printf("try complete <%s>\n", buf);
434 debug_printf("there is %d complete tokens, <%s> is incomplete\n",
435 nb_token, partial_tok);
438 nb_non_completable = 0;
440 inst = ctx[inst_num];
442 /* parse the first tokens of the inst */
443 if (nb_token && match_inst(inst, buf, nb_token, NULL))
446 debug_printf("instruction match \n");
447 token_p = inst->tokens[nb_token];
449 memcpy(&token_hdr, token_p, sizeof(token_hdr));
451 /* non completable */
453 !token_hdr.ops->complete_get_nb ||
454 !token_hdr.ops->complete_get_elt ||
455 (n = token_hdr.ops->complete_get_nb(token_p)) == 0) {
456 nb_non_completable++;
460 debug_printf("%d choices for this token\n", n);
461 for (i=0 ; i<n ; i++) {
462 if (token_hdr.ops->complete_get_elt(token_p, i,
467 /* we have at least room for one char */
470 debug_printf(" choice <%s>\n", tmpbuf);
472 /* does the completion match the
473 * beginning of the word ? */
474 if (!strncmp(partial_tok, tmpbuf,
476 if (comp_len == -1) {
478 tmpbuf + partial_tok_len);
486 nb_common_chars(comp_buf,
487 tmpbuf+partial_tok_len);
488 comp_buf[comp_len] = 0;
495 inst = ctx[inst_num];
498 debug_printf("total choices %d for this completion\n",
501 /* no possible completion */
502 if (nb_completable == 0 && nb_non_completable == 0)
505 /* if multichoice is not required */
506 if (*state == 0 && partial_tok_len > 0) {
507 /* one or several choices starting with the
510 if ((unsigned)(comp_len + 1) > size)
513 strcpy(dst, comp_buf);
519 /* init state correctly */
523 debug_printf("Multiple choice STATE=%d\n", *state);
526 inst = ctx[inst_num];
528 /* we need to redo it */
529 inst = ctx[inst_num];
531 if (nb_token && match_inst(inst, buf, nb_token, NULL))
534 token_p = inst->tokens[nb_token];
536 memcpy(&token_hdr, token_p, sizeof(token_hdr));
538 /* one choice for this token */
540 !token_hdr.ops->complete_get_nb ||
541 !token_hdr.ops->complete_get_elt ||
542 (n = token_hdr.ops->complete_get_nb(token_p)) == 0) {
543 if (local_state < *state) {
548 if (token_p && token_hdr.ops->get_help) {
549 token_hdr.ops->get_help(token_p, tmpbuf,
551 help_str = inst->help_str;
553 snprintf(dst, size, "[%s]: %s", tmpbuf,
556 snprintf(dst, size, "[%s]: No help",
560 snprintf(dst, size, "[RETURN]");
565 /* several choices */
566 for (i=0 ; i<n ; i++) {
567 if (token_hdr.ops->complete_get_elt(token_p, i, tmpbuf,
570 /* we have at least room for one char */
573 debug_printf(" choice <%s>\n", tmpbuf);
575 /* does the completion match the beginning of
577 if (!strncmp(partial_tok, tmpbuf,
579 if (local_state < *state) {
584 l=snprintf(dst, size, "%s", tmpbuf);
585 if (l>=0 && token_hdr.ops->get_help) {
586 token_hdr.ops->get_help(token_p, tmpbuf,
588 help_str = inst->help_str;
590 snprintf(dst+l, size-l, "[%s]: %s",
593 snprintf(dst+l, size-l,
594 "[%s]: No help", tmpbuf);
602 inst = ctx[inst_num];