genconf: enhance short and long display of confnodes
[libcmdline.git] / src / genconf / confnode_intconfig.c
1 /*
2  * Copyright (c) 2010, 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 <string.h>
30 #include <stdlib.h>
31 #include <ctype.h>
32 #include <unistd.h>
33 #include <sys/queue.h>
34
35 #include "expression.h"
36 #include "conf_parser.h"
37 #include "conf_htable.h"
38 #include "parser_common.h"
39 #include "dotconfig.h"
40 #include "confnode.h"
41
42 static int confnode_intconfig_new(struct confnode *n, const struct line *line);
43 static int confnode_intconfig_strvalue_to_boolvalue(const struct confnode *n,
44                                                     const char *strvalue);
45 static int confnode_intconfig_set_user_strvalue(struct confnode *n,
46                                               const char *strvalue);
47 static int confnode_intconfig_get_user_strvalue(const struct confnode *n, char *buf,
48                                               unsigned buflen);
49 static int confnode_intconfig_set_default_strvalue(struct confnode *n,
50                                               const char *strvalue);
51 static int confnode_intconfig_get_default_strvalue(const struct confnode *n, char *buf,
52                                               unsigned buflen);
53 static const char *confnode_intconfig_get_type_str(const struct confnode *n);
54 static void confnode_intconfig_display_short(const struct confnode *n);
55
56 static struct confnode_type confnode_intconfig = {
57         .ops = {
58                 .new = confnode_intconfig_new,
59                 .free = NULL,
60                 .add_attr = NULL, /* XXX range, displayhex */
61                 .close_dir = NULL,
62                 .dotconfig_write = NULL,
63                 .strvalue_to_boolvalue = confnode_intconfig_strvalue_to_boolvalue,
64                 .set_user_strvalue = confnode_intconfig_set_user_strvalue,
65                 .get_user_strvalue = confnode_intconfig_get_user_strvalue,
66                 .set_default_strvalue = confnode_intconfig_set_default_strvalue,
67                 .get_default_strvalue = confnode_intconfig_get_default_strvalue,
68                 .get_type_str = confnode_intconfig_get_type_str,
69                 .display_short = confnode_intconfig_display_short,
70                 .display_long = NULL,
71         }
72 };
73
74 /* Create a new node */
75 static int confnode_intconfig_new(struct confnode *n, const struct line *line)
76 {
77         struct token *tok;
78         tok = TAILQ_FIRST(&line->token_list);
79
80         if (strcmp(tok->str, "intconfig") || line->n_token != 2)
81                 return -1;
82
83         tok = TAILQ_NEXT(tok, next);
84         snprintf(n->name, sizeof(n->name), "%s", tok->str);
85         snprintf(n->default_value, sizeof(n->default_value), "0");
86
87         n->ops = &confnode_intconfig.ops;
88         n->flags = CONFNODE_F_INT;
89         snprintf(n->default_value, sizeof(n->default_value), "0");
90         return 0;
91 }
92
93 /* Convert string value into a boolean value (mainly used for
94  * dependancies). Return -1 on error, else return the boolean value (0
95  * or 1). */
96 static int confnode_intconfig_strvalue_to_boolvalue(const struct confnode *n,
97                                                     const char *strvalue)
98 {
99         char *end = NULL;
100         int val;
101
102         /* XXX support hex and bin */
103         val = strtoul(strvalue, &end, 0);
104         if ((strvalue[0] == '\0') || (end == NULL) || (*end != '\0'))
105                 return -1;
106         return val;
107 }
108
109 /* Set the string value of the node n. Return 0 on success, or -1 if
110  * the value cannot be set. */
111 static int confnode_intconfig_set_user_strvalue(struct confnode *n,
112                                                 const char *strvalue)
113 {
114         char *end = NULL;
115         int val;
116         /* XXX support hex and bin */
117         val = strtoul(strvalue, &end, 0);
118         if ((strvalue[0] == '\0') || (end == NULL) || (*end != '\0'))
119                 return -1;
120         snprintf(n->value, sizeof(n->value), "%s", strvalue);
121         return 0;
122 }
123
124 /* Get the string value that the user asked to set for this node
125  * 'n'. This function does not check if dependancies are met. Return 0
126  * on success, in this case the string is copied in buffer 'buf' of
127  * len 'buflen'. Return -1 if the value cannot be read. */
128 static int confnode_intconfig_get_user_strvalue(const struct confnode *n, char *buf,
129                                                 unsigned buflen)
130 {
131         if (strcmp(n->value, "") == 0)
132                 return -1;
133         snprintf(buf, buflen, "%s", n->value);
134         return 0;
135 }
136
137 /* Set the default string value of the node n. Return 0 on success, or
138  * -1 if the value cannot be set. */
139 static int confnode_intconfig_set_default_strvalue(struct confnode *n,
140                                               const char *strvalue)
141 {
142         char *end = NULL;
143         int val;
144         /* XXX support hex and bin */
145         val = strtoul(strvalue, &end, 0);
146         if ((strvalue[0] == '\0') || (end == NULL) || (*end != '\0'))
147                 return -1;
148         snprintf(n->default_value, sizeof(n->default_value), "%s", strvalue);
149         return 0;
150 }
151
152 /* Get the default string value for this node 'n'. This function does
153  * not check if dependancies are met. Return 0 on success, in this
154  * case the string is copied in buffer 'buf' of len 'buflen'. Return
155  * -1 if the value cannot be read. */
156 static int confnode_intconfig_get_default_strvalue(const struct confnode *n, char *buf,
157                                               unsigned buflen)
158 {
159         if (strcmp(n->default_value, "") == 0)
160                 return -1;
161         snprintf(buf, buflen, "%s", n->default_value);
162         return 0;
163 }
164
165 /* Return a string identifying the node type ("config", "menuconfig",
166  * "choice", ...) */
167 static const char *confnode_intconfig_get_type_str(const struct confnode *n)
168 {
169         return "intconfig";
170 }
171
172 /* Print a one-line summary of the node. Used in case of 'ls'. */
173 static void confnode_intconfig_display_short(const struct confnode *n)
174 {
175 #define INTBUFLEN 10
176         char buf[INTBUFLEN];
177
178         memset(buf, 0, sizeof(buf));
179
180         buf[0] = '[';
181         confnode_get_value(n, buf, 0);
182         confnode_get_value(n, &buf[1], INTBUFLEN-1);
183         if (strlen(buf) == INTBUFLEN-1) { /* buffer full */
184                 buf[INTBUFLEN-4] = '.';
185                 buf[INTBUFLEN-3] = '.';
186                 buf[INTBUFLEN-2] = '\0';
187         }
188         strcat(buf, "]");
189
190         while (strlen(buf) < sizeof(buf) - 1)
191                 strcat(buf, " ");
192
193         printf("%s %s: %s\n", buf, n->name, n->prompt);
194 }
195
196 /* register the node type */
197 void confnode_intconfig_register(void)
198 {
199         TAILQ_INSERT_TAIL(&confnode_type_list, &confnode_intconfig, next);
200 }