src/extension_example/parse_obj_list.h

   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 #ifndef _PARSE_OBJ_LIST_H_
  29 #define _PARSE_OBJ_LIST_H_
  30
  31 /* This file is an example of extension of libcmdline. It provides an
  32  * example of objects stored in a list. */
  33
  34 #include <sys/queue.h>
  35 #include <cmdline_parse.h>
  36
  37 struct object {
  38         SLIST_ENTRY(object) next;
  39         char name[64];
  40         cmdline_ipaddr_t ip;
  41 };
  42
  43 /* define struct object_list */
  44 SLIST_HEAD(object_list, object);
  45
  46 /* data is a pointer to a list */
  47 struct token_obj_list_data {
  48         struct object_list *list;
  49 };
  50
  51 struct token_obj_list {
  52         struct cmdline_token_hdr hdr;
  53         struct token_obj_list_data obj_list_data;
  54 };
  55 typedef struct token_obj_list parse_token_obj_list_t;
  56
  57 extern struct cmdline_token_ops token_obj_list_ops;
  58
  59 int parse_obj_list(cmdline_parse_token_hdr_t *tk, const char *srcbuf, void *res);
  60 int complete_get_nb_obj_list(cmdline_parse_token_hdr_t *tk);
  61 int complete_get_elt_obj_list(cmdline_parse_token_hdr_t *tk, int idx,
  62                               char *dstbuf, unsigned int size);
  63 int get_help_obj_list(cmdline_parse_token_hdr_t *tk, char *dstbuf, unsigned int size);
  64
  65 #define TOKEN_OBJ_LIST_INITIALIZER(structure, field, obj_list_ptr)  \
  66 {                                                                   \
  67         .hdr = {                                                    \
  68                 .ops = &token_obj_list_ops,                         \
  69                 .offset = offsetof(structure, field),               \
  70         },                                                          \
  71                 .obj_list_data = {                                  \
  72                 .list = obj_list_ptr,                               \
  73         },                                                          \
  74 }
  75
  76 #endif /* _PARSE_OBJ_LIST_H_ */