Add code from the inih library under libconfig
[lttng-tools.git] / 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 #define _GNU_SOURCE
43 #include <stdio.h>
44
45 typedef int (*ini_entry_handler)(void *, const char *, const char *,
46 const char *);
47
48 /*
49 * Parse given INI-style file. May have [section]s, name=value pairs
50 * (whitespace stripped), and comments starting with ';' (semicolon). Section
51 * is "" if name=value pair parsed before any section heading. name:value
52 * pairs are also supported as a concession to Python's ConfigParser.
53 *
54 * For each name=value pair parsed, call handler function with given user
55 * pointer as well as section, name, and value (data only valid for duration
56 * of handler call). Handler should return zero on success, < 0 on error.
57 *
58 * Returns 0 on success, line number of first error on parse error (doesn't
59 * stop on first error), -1 on file open error, or -2 on memory allocation
60 * error (only when INI_USE_STACK is zero).
61 */
62 int ini_parse(const char *filename, ini_entry_handler handler, void *user);
63
64 /*
65 * Same as ini_parse(), but takes a FILE* instead of filename. This doesn't
66 * close the file when it's finished -- the caller must do that.
67 */
68 int ini_parse_file(FILE *file, ini_entry_handler handler, void *user);
69
70 /*
71 * Nonzero to allow multi-line value parsing, in the style of Python's
72 * ConfigParser. If allowed, ini_parse() will call the handler with the same
73 * name for each subsequent line parsed.
74 */
75 #ifndef INI_ALLOW_MULTILINE
76 #define INI_ALLOW_MULTILINE 1
77 #endif
78
79 /*
80 * Nonzero to allow a UTF-8 BOM sequence (0xEF 0xBB 0xBF) at the start of
81 * the file. See http://code.google.com/p/inih/issues/detail?id=21
82 */
83 #ifndef INI_ALLOW_BOM
84 #define INI_ALLOW_BOM 1
85 #endif
86
87 /* Nonzero to use stack, zero to use heap (malloc/free). */
88 #ifndef INI_USE_STACK
89 #define INI_USE_STACK 1
90 #endif
91
92 /* Maximum line length for any line in INI file. */
93 #ifndef INI_MAX_LINE
94 #define INI_MAX_LINE 200
95 #endif
96
97 #ifdef __cplusplus
98 }
99 #endif
100
101 #endif /* __INI_H__ */
This page took 0.044043 seconds and 4 git commands to generate.