src/common/config/ini.h

   1 /*
   2  * inih -- simple .INI file parser
   3  *
   4  * The "inih" library is distributed under the New BSD license:
   5  *
   6  * Copyright (c) 2009, Brush Technology - All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright notice,
  12  *     this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *     notice, this list of conditions and the following disclaimer in the
  15  *     documentation and/or other materials provided with the distribution.
  16  *     * Neither the name of Brush Technology nor the names of its contributors
  17  *     may be used to endorse or promote products derived from this software
  18  *     without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY BRUSH TECHNOLOGY ''AS IS'' AND ANY EXPRESS OR
  21  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  22  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
  23  * EVENT SHALL BRUSH TECHNOLOGY BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  26  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  27  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  28  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  29  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  *
  31  * http://code.google.com/p/inih/
  32  */
  33
  34 #ifndef __INI_H__
  35 #define __INI_H__
  36
  37 /* Make this header file easier to include in C++ code */
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 #include <stdio.h>
  43
  44 typedef int (*ini_entry_handler)(void *, const char *, const char *,
  45                 const char *);
  46
  47 /*
  48  * Parse given INI-style file. May have [section]s, name=value pairs
  49  * (whitespace stripped), and comments starting with ';' (semicolon). Section
  50  * is "" if name=value pair parsed before any section heading. name:value
  51  * pairs are also supported as a concession to Python's ConfigParser.
  52  *
  53  * For each name=value pair parsed, call handler function with given user
  54  * pointer as well as section, name, and value (data only valid for duration
  55  * of handler call). Handler should return zero on success, < 0 on error.
  56  *
  57  * Returns 0 on success, line number of first error on parse error (doesn't
  58  * stop on first error), -1 on file open error, or -2 on memory allocation
  59  * error (only when INI_USE_STACK is zero).
  60  */
  61 int ini_parse(const char *filename, ini_entry_handler handler, void *user);
  62
  63 /*
  64  * Same as ini_parse(), but takes a FILE* instead of filename. This doesn't
  65  * close the file when it's finished -- the caller must do that.
  66  */
  67 int ini_parse_file(FILE *file, ini_entry_handler handler, void *user);
  68
  69 /*
  70  * Nonzero to allow multi-line value parsing, in the style of Python's
  71  * ConfigParser. If allowed, ini_parse() will call the handler with the same
  72  * name for each subsequent line parsed.
  73  */
  74 #ifndef INI_ALLOW_MULTILINE
  75 #define INI_ALLOW_MULTILINE 1
  76 #endif
  77
  78 /*
  79  * Nonzero to allow a UTF-8 BOM sequence (0xEF 0xBB 0xBF) at the start of
  80  * the file. See http://code.google.com/p/inih/issues/detail?id=21
  81  */
  82 #ifndef INI_ALLOW_BOM
  83 #define INI_ALLOW_BOM 1
  84 #endif
  85
  86 /* Nonzero to use stack, zero to use heap (malloc/free). */
  87 #ifndef INI_USE_STACK
  88 #define INI_USE_STACK 1
  89 #endif
  90
  91 /* Maximum line length for any line in INI file. */
  92 #ifndef INI_MAX_LINE
  93 #define INI_MAX_LINE 200
  94 #endif
  95
  96 #ifdef __cplusplus
  97 }
  98 #endif
  99
 100 #endif /* __INI_H__ */