common: split ini-config in its own convenience library

[lttng-tools.git] / src / common / ini-config / ini.h

diff --git a/src/common/ini-config/ini.h b/src/common/ini-config/ini.h
new file mode 100644 (file)
index 0000000..34b3654
--- /dev/null
+++ b/src/common/ini-config/ini.h
@@ -0,0 +1,94 @@
+/*
+ * inih -- simple .INI file parser
+ *
+ * The "inih" library is distributed under the New BSD license:
+ *
+ * Copyright (C) 2009 Brush Technology - All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *     * Redistributions of source code must retain the above copyright notice,
+ *     this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in the
+ *     documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Brush Technology nor the names of its contributors
+ *     may be used to endorse or promote products derived from this software
+ *     without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY BRUSH TECHNOLOGY ''AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+ * EVENT SHALL BRUSH TECHNOLOGY BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+ * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+ * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://code.google.com/p/inih/
+ */
+
+#ifndef __INI_H__
+#define __INI_H__
+
+/* Make this header file easier to include in C++ code */
+#include <stdio.h>
+
+typedef int (*ini_entry_handler)(void *, const char *, const char *,
+               const char *);
+
+/*
+ * Parse given INI-style file. May have [section]s, name=value pairs
+ * (whitespace stripped), and comments starting with ';' (semicolon). Section
+ * is "" if name=value pair parsed before any section heading. name:value
+ * pairs are also supported as a concession to Python's ConfigParser.
+ *
+ * For each name=value pair parsed, call handler function with given user
+ * pointer as well as section, name, and value (data only valid for duration
+ * of handler call). Handler should return zero on success, < 0 on error.
+ *
+ * Returns 0 on success, line number of first error on parse error (doesn't
+ * stop on first error), -1 on file open error, or -2 on memory allocation
+ * error (only when INI_USE_STACK is zero).
+ */
+int ini_parse(const char *filename, ini_entry_handler handler, void *user);
+
+/*
+ * Same as ini_parse(), but takes a FILE* instead of filename. This doesn't
+ * close the file when it's finished -- the caller must do that.
+ */
+int ini_parse_file(FILE *file, ini_entry_handler handler, void *user);
+
+/*
+ * Nonzero to allow multi-line value parsing, in the style of Python's
+ * ConfigParser. If allowed, ini_parse() will call the handler with the same
+ * name for each subsequent line parsed.
+ */
+#ifndef INI_ALLOW_MULTILINE
+#define INI_ALLOW_MULTILINE 1
+#endif
+
+/*
+ * Nonzero to allow a UTF-8 BOM sequence (0xEF 0xBB 0xBF) at the start of
+ * the file. See http://code.google.com/p/inih/issues/detail?id=21
+ */
+#ifndef INI_ALLOW_BOM
+#define INI_ALLOW_BOM 1
+#endif
+
+/* Nonzero to use stack, zero to use heap (malloc/free). */
+#ifndef INI_USE_STACK
+#define INI_USE_STACK 1
+#endif
+
+/* Maximum line length for any line in INI file. */
+#ifndef INI_MAX_LINE
+#define INI_MAX_LINE 200
+#endif
+
+#endif /* __INI_H__ */