tools/cfzy/libconfizery/cfzy_dotconfig.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 dotconfig parsing/generation
  31  *
  32  * This modules provides an API to parse or generate a .config file
  33  * from a configuration tree.
  34  */
  35
  36 #ifndef _CFZY_DOTCONFIG_H_
  37 #define _CFZY_DOTCONFIG_H_
  38
  39 /**
  40  * Write configuration in a .config file
  41  *
  42  * Write the configuration values (.config like) in a file. This file
  43  * is designed to be sourced in a shell script or in a makefile.
  44  *
  45  * If the file already exists and has the same content, nothing is
  46  * written in it.
  47  *
  48  * @param conftree
  49  *   the configuration tree
  50  * @param filename
  51  *   name of the output file
  52  * @return
  53  *   0 on success, negative on error
  54  */
  55 int cfzy_dotconfig_write(const struct cfzy_conftree *conftree,
  56                          const char *filename);
  57
  58 /**
  59  * Read and parse a dotconfig configuration file
  60  *
  61  * Read the configuration values (.config like) from a file, and set
  62  * the values in the configuration tree.
  63  *
  64  * @param conftree
  65  *   the configuration tree
  66  * @param filename
  67  *   name of the output file
  68  * @return
  69  *   0 on success, negative on error
  70  */
  71 int cfzy_dotconfig_read(struct cfzy_conftree *conftree, const char *filename);
  72
  73 #endif