xref: /dpdk/examples/cmdline/parse_obj_list.h (revision dada9ef6edc59015b6674b5a95258787c71401b0)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
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.
20  *
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 FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  */
34 
35 /*
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:
40  *
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.
49  *
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.
60  */
61 
62 #ifndef _PARSE_OBJ_LIST_H_
63 #define _PARSE_OBJ_LIST_H_
64 
65 /* This file is an example of extension of libcmdline. It provides an
66  * example of objects stored in a list. */
67 
68 #include <sys/queue.h>
69 #include <cmdline_parse.h>
70 
71 #define OBJ_NAME_LEN_MAX 64
72 
73 struct object {
74 	SLIST_ENTRY(object) next;
75 	char name[OBJ_NAME_LEN_MAX];
76 	cmdline_ipaddr_t ip;
77 };
78 
79 /* define struct object_list */
80 SLIST_HEAD(object_list, object);
81 
82 /* data is a pointer to a list */
83 struct token_obj_list_data {
84 	struct object_list *list;
85 };
86 
87 struct token_obj_list {
88 	struct cmdline_token_hdr hdr;
89 	struct token_obj_list_data obj_list_data;
90 };
91 typedef struct token_obj_list parse_token_obj_list_t;
92 
93 extern struct cmdline_token_ops token_obj_list_ops;
94 
95 int parse_obj_list(cmdline_parse_token_hdr_t *tk, const char *srcbuf, void *res);
96 int complete_get_nb_obj_list(cmdline_parse_token_hdr_t *tk);
97 int complete_get_elt_obj_list(cmdline_parse_token_hdr_t *tk, int idx,
98 			      char *dstbuf, unsigned int size);
99 int get_help_obj_list(cmdline_parse_token_hdr_t *tk, char *dstbuf, unsigned int size);
100 
101 #define TOKEN_OBJ_LIST_INITIALIZER(structure, field, obj_list_ptr)  \
102 {								    \
103 	.hdr = {						    \
104 		.ops = &token_obj_list_ops,			    \
105 		.offset = offsetof(structure, field),		    \
106 	},							    \
107 		.obj_list_data = {				    \
108 		.list = obj_list_ptr,				    \
109 	},							    \
110 }
111 
112 #endif /* _PARSE_OBJ_LIST_H_ */
113