src/extension_example/parse_obj_list.c

   1 /*
   2  * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of the University of California, Berkeley nor the
  13  *       names of its contributors may be used to endorse or promote products
  14  *       derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #include <stdio.h>
  29 #include <inttypes.h>
  30 #include <ctype.h>
  31 #include <string.h>
  32 #include <netinet/in.h>
  33
  34 #include <cmdline_parse_ipaddr.h>
  35 #include <cmdline_parse.h>
  36
  37 #include "parse_obj_list.h"
  38
  39 /* This file is an example of extension of libcmdline. It provides an
  40  * example of named objects stored in a list, supporting the
  41  * completion on objects name */
  42
  43 static int
  44 parse_obj_list(cmdline_parse_token_hdr_t *tk, const char *buf, void *res,
  45                unsigned ressize)
  46 {
  47         struct token_obj_list *tk2 = (struct token_obj_list *)tk;
  48         struct token_obj_list_data *tkd = &tk2->obj_list_data;
  49         struct object *o;
  50         unsigned int token_len = 0;
  51
  52         if (res && ressize < sizeof(struct object *))
  53                 return -1;
  54
  55         token_len = strlen(buf);
  56
  57         SLIST_FOREACH(o, tkd->list, next) {
  58                 if (strcmp(buf, o->name))
  59                         continue;
  60                 break;
  61         }
  62         if (o == NULL) /* not found */
  63                 return -1;
  64
  65         /* store the address of object in structure */
  66         if (res)
  67                 *(struct object **)res = o;
  68
  69         return token_len;
  70 }
  71
  72 static int
  73 complete_obj_list_start(cmdline_parse_token_hdr_t *tk,
  74                         __attribute__((unused)) const char *tokstr,
  75                         void **opaque)
  76 {
  77         struct token_obj_list *tk2 = (struct token_obj_list *)tk;
  78         struct token_obj_list_data *tkd = &tk2->obj_list_data;
  79         struct object *o;
  80
  81         o = SLIST_FIRST(tkd->list);
  82         *opaque = (void *)o;
  83         if (o == NULL)
  84                 return -1; /* no completion */
  85         return 0;
  86 }
  87
  88 static int
  89 complete_obj_list_iterate(cmdline_parse_token_hdr_t *tk, void **opaque,
  90                           char *dstbuf, unsigned int size)
  91 {
  92         struct object *o;
  93         int len;
  94
  95         o = *opaque;
  96         if (o == NULL)
  97                 return -1;
  98
  99         len = snprintf(dstbuf, size, "%s", o->name);
 100         if (len < 0 || len >= size)
 101                 return -1;
 102
 103         strcpy(dstbuf, o->name);
 104         o = SLIST_NEXT(o, next);
 105         *opaque = o;
 106         return 0;
 107 }
 108
 109
 110 static int
 111 cmdline_help_obj_list(cmdline_parse_token_hdr_t *tk, char *dstbuf,
 112                       unsigned int size)
 113 {
 114         snprintf(dstbuf, size, "Obj-List");
 115         return 0;
 116 }
 117
 118 struct cmdline_token_ops token_obj_list_ops = {
 119         .parse = parse_obj_list,
 120         .complete_start = complete_obj_list_start,
 121         .complete_iterate = complete_obj_list_iterate,
 122         .complete_end = NULL,
 123         .help = cmdline_help_obj_list,
 124 };