src/genconf/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 "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_comment_new(struct confnode *n, const struct line *line);
  43 static int confnode_comment_dotconfig_write(const struct confnode *n, FILE *f);
  44 static const char *confnode_comment_get_type_str(const struct confnode *n);
  45 static void confnode_comment_display_long(const struct confnode *n);
  46
  47 static struct confnode_type confnode_comment = {
  48         .ops = {
  49                 .new = confnode_comment_new,
  50                 .free = NULL,
  51                 .add_attr = NULL,
  52                 .close_dir = NULL,
  53                 .dotconfig_write = confnode_comment_dotconfig_write,
  54                 .strvalue_to_boolvalue = NULL,
  55                 .set_user_strvalue = NULL,
  56                 .get_user_strvalue = NULL,
  57                 .set_default_strvalue = NULL,
  58                 .get_default_strvalue = NULL,
  59                 .get_type_str = confnode_comment_get_type_str,
  60                 .display_short = NULL,
  61                 .display_long = confnode_comment_display_long,
  62         }
  63 };
  64
  65 /* Create a new node */
  66 static int confnode_comment_new(struct confnode *n, const struct line *line)
  67 {
  68         struct token *tok;
  69         tok = TAILQ_FIRST(&line->token_list);
  70
  71         if (strcmp(tok->str, "comment") || line->n_token != 2)
  72                 return -1;
  73
  74         tok = TAILQ_NEXT(tok, next);
  75         /* comment string is stored in prompt field, not in name */
  76         snprintf(n->prompt, sizeof(n->prompt), "%s", tok->str);
  77         n->ops = &confnode_comment.ops;
  78         n->flags = CONFNODE_F_NO_SET_DEFAULT |
  79                 CONFNODE_F_NO_SET_PROMPT |
  80                 CONFNODE_F_NO_NAME;
  81         return 0;
  82 }
  83
  84 /* write config value in file f in a dotconfig-like manner. Return 0
  85  * on success. */
  86 static int confnode_comment_dotconfig_write(const struct confnode *n, FILE *f)
  87 {
  88         if (fprintf(f, "# %s\n", n->prompt) < 0)
  89                 return -1;
  90
  91         /* this node has no children, no need to dump them */
  92         return 0;
  93 }
  94
  95 /* Return a string identifying the node type ("config", "menuconfig",
  96  * "choice", ...) */
  97 static const char *confnode_comment_get_type_str(const struct confnode *n)
  98 {
  99         return "comment";
 100 }
 101
 102 /* Print a detailed view of the node. */
 103 static void confnode_comment_display_long(const struct confnode *n)
 104 {
 105         /* nothing */
 106 }
 107
 108 /* register the node type */
 109 void confnode_comment_register(void)
 110 {
 111         TAILQ_INSERT_TAIL(&confnode_type_list, &confnode_comment, next);
 112 }