tools/cfzy/libconfizery/cfzy_conftree_parser.h

   1 /*
   2  * Copyright (c) 2013, 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 /**
  29  * @file
  30  * Confizery configuration tree parser
  31  *
  32  * This modules provides an API to parse the configuration tree file
  33  * (equivalent to Kconfig file in linux terminology) which describes
  34  * the structure of the tree, the option list, the dependencies, the
  35  * default values...
  36  */
  37
  38
  39 #ifndef _CFZY_CONFTREE_PARSER_H_
  40 #define _CFZY_CONFTREE_PARSER_H_
  41
  42 #include <sys/queue.h>
  43
  44 struct cfzy_conftree;
  45
  46 /**
  47  * Return value for some parsing functions.
  48  */
  49 enum cfzy_parse_return {
  50         SUCCESS,
  51         NO_MATCH,
  52         ERROR,
  53 };
  54
  55 /**
  56  * This is the structure defining a token. It is used by the
  57  * configuration tree parser. A token is either a word or a string
  58  * surrounded by double quotes.
  59  */
  60 struct cfzy_token {
  61         TAILQ_ENTRY(cfzy_token) next; /**< pointer to next token */
  62         char *str;               /**< string */
  63         unsigned offset;         /**< offset in line */
  64 };
  65
  66 /**
  67  * A list of token, and a pointer to the initial line buffer
  68  */
  69 struct cfzy_token_list {
  70         TAILQ_HEAD(, cfzy_token) list; /**< list of tokens */
  71         unsigned n_token;        /**< number of tokens */
  72         const char *linebuf;     /**< the line buffer */
  73 };
  74
  75 /**
  76  * Parse configuration tree file and fill the conftree
  77  *
  78  * This function is called by cfzy_conftree_new() to fill the newly
  79  * allocated tree.
  80  *
  81  * @param filename
  82  *   path to configuration tree file
  83  * @param conftree
  84  *   an empty configuration tree
  85  * @return
  86  *   0 on success, or negative on error
  87  */
  88 int cfzy_conftree_parse(const char *filename, struct cfzy_conftree *conftree);
  89
  90 #endif /* _CFZY_CONFTREE_PARSER_H_ */