initial revision
[ucgine.git] / tools / cfzy / libconfizery / cfzy_confnode_comment.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 "cfzy_log.h"
36 #include "cfzy_confnode.h"
37
38 #define LOG(level, fmt, args...)                                \
39         CFZY_LOG("comment", level, fmt, ##args)
40
41 /* write config value in file f in a dotconfig-like manner. Return 0
42  * on success. */
43 static int comment_dotconfig_write(const struct cfzy_confnode *n, FILE *f)
44 {
45         if (fprintf(f, "# %s\n", n->prompt) < 0)
46                 return -1;
47
48         /* this node has no children, no need to dump them */
49         return 0;
50 }
51
52 /* Return a string identifying the node type ("config", "menuconfig",
53  * "choice", ...) */
54 static const char *comment_get_type_str(const struct cfzy_confnode *n)
55 {
56         (void)n;
57         return "comment";
58 }
59
60 static struct cfzy_confnode_ops comment_ops = {
61         .free = NULL,
62         .add_attr = NULL,
63         .close = NULL,
64         .str2bool = NULL,
65         .dotconfig_write = comment_dotconfig_write,
66         .c_hdr_write = NULL,
67         .get_type_str = comment_get_type_str,
68         .set_uservalue = NULL,
69 };
70
71 /* Create a new node */
72 enum cfzy_parse_return cfzy_confnode_comment_new(struct cfzy_confnode *n,
73                                                  const struct cfzy_token_list *tklist)
74 {
75         struct cfzy_token *tok;
76         tok = TAILQ_FIRST(&tklist->list);
77
78         if (strcmp(tok->str, "comment") || tklist->n_token != 2)
79                 return NO_MATCH;
80
81         tok = TAILQ_NEXT(tok, next);
82         /* comment string is stored in prompt field, not in name */
83         if (n->prompt != NULL) {
84                 free(n->prompt);
85                 n->prompt = NULL;
86         }
87         n->prompt = strdup(tok->str);
88         if (n->prompt == NULL) {
89                 LOG(ERR, "cannot allocate prompt");
90                 return ERROR;
91         }
92         n->ops = &comment_ops;
93         n->flags = CFZY_F_NO_SET_DEFAULT |
94                 CFZY_F_NO_SET_PROMPT |
95                 CFZY_F_NO_NAME |
96                 CFZY_F_NO_SET_VALUE;
97
98         return SUCCESS;
99 }