tools/cfzy/libconfizery/cfzy_c_hdr.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 C header generation
  31  *
  32  * This module provides the public API to generate the C header files
  33  * from the configuration tree.
  34  */
  35
  36 #ifndef _CFZY_C_HDR_H_
  37 #define _CFZY_C_HDR_H_
  38
  39 /**
  40  * Write configuration in a C header file
  41  *
  42  * Write a C header (autoconf.h like) in a file. This single file will
  43  * contain a list of #define (one per option) and is desgined to be
  44  * included by a C application using this config.
  45  *
  46  * If the file already exists and has the same content, nothing is
  47  * written in it.
  48  *
  49  * @param conftree
  50  *   the configuration tree
  51  * @param filename
  52  *   name of the output file
  53  * @return
  54  *   0 on success, negative on error
  55  */
  56 int cfzy_c_hdr_write(const struct cfzy_conftree *conftree,
  57                      const char *filename);
  58
  59 /**
  60  * Write the configuration in multiple header files
  61  *
  62  * Write a C header (autoconf.h like) in a file. Each option is
  63  * written in one single file. If one file already exists and has the
  64  * same content, nothing is written in it.
  65  *
  66  * These files are not desgined to be
  67  * included by a C application as each option is just included as a C
  68  * comment. The goal of these files is to handle the dependencies
  69  * properly in the build system.
  70  *
  71  * @param conftree
  72  *   the configuration tree
  73  * @param filename
  74  *   name of the output file
  75  * @return
  76  *   0 on success, negative on error
  77  */
  78 int cfzy_multi_c_hdr_write(const struct cfzy_conftree *conftree,
  79                            const char *basedir);
  80
  81 #endif