4 * This file is part of BeRTOS.
6 * Bertos is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * As a special exception, you may use this file as part of a free software
21 * library without restriction. Specifically, if other files instantiate
22 * templates or use macros or inline functions from this file, or you compile
23 * this file and link it with other files to produce an executable, this
24 * file does not by itself cause the resulting executable to be covered by
25 * the GNU General Public License. This exception does not however
26 * invalidate any other reasons why the executable file might be covered by
27 * the GNU General Public License.
29 * Copyright 2009 Develer S.r.l. (http://www.develer.com/)
33 * \brief Ini file reader module.
35 * The format accepted is:
36 * - Sections must begin at beginning of line. [ Long name ] will be found only if " Long name " is specified as section name.
37 * - key can contain any spaces at the beginning and before '=' but not in the middle. Eg. "long key name" is not valid.
38 * - values will be stripped of spaces at the beginning and will run until end-of-line. Eg. "= long value" will be treated as "long value".
39 * - no nested sections are allowed.
40 * - no comments are allowed inside a line with key=value pair.
41 * - every line that doesn't contain a '=' or doesn't start with '[' will be ignored.
43 * \author Luca Ottaviano <lottaviano@develer.com>
45 * $WIZ$ module_name = "ini_reader"
46 * $WIZ$ module_configuration = "bertos/cfg/cfg_ini_reader.h"
47 * $WIZ$ module_depends = "kfile"
53 #include <kern/kfile.h>
56 * \brief Returns the value for the given string in char* format.
57 * Reads the whole input file looking for section and key and fills the provided buffer with
58 * the corresponding value.
59 * On errors, the function fills the provided buffer with the default value and returns EOF.
60 * \param fd An initialized KFile structure.
61 * \param section The section to be looked for.
62 * \param key The key to search for.
63 * \param default_value The default value.
64 * \param buf The buffer to be filled.
65 * \param size The size of the provided buffer.
66 * \return 0 if section and key were found, EOF on errors.
68 int ini_getString(KFile *fd, const char *section, const char *key, const char *default_value, char *buf, size_t size);
70 int ini_reader_testSetup(void);
71 int ini_reader_testRun(void);
72 int ini_reader_testTearDown(void);
73 #endif /* INI_READER_H */