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