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