bertos/mware/ini_reader.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  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.
  28  *
  29  * Copyright 2009 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \defgroup ini_reader Ini file reader
  34  * \ingroup mware
  35  * \{
  36  *
  37  * \brief Ini file reader module.
  38  *
  39  * The format accepted is:
  40  * - Sections must begin at beginning of line. [ Long name ] will be found only if " Long name " is specified as section name.
  41  * - key can contain any spaces at the beginning and before '=' but not in the middle. Eg. "long key name" is not valid.
  42  * - 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".
  43  * - no nested sections are allowed.
  44  * - no comments are allowed inside a line with key=value pair.
  45  * - every line that doesn't contain a '=' or doesn't start with '[' will be ignored.
  46  *
  47  * \author Luca Ottaviano <lottaviano@develer.com>
  48  *
  49  * $WIZ$ module_name = "ini_reader"
  50  * $WIZ$ module_configuration = "bertos/cfg/cfg_ini_reader.h"
  51  * $WIZ$ module_depends = "kfile"
  52  */
  53
  54 #ifndef INI_READER_H
  55 #define INI_READER_H
  56
  57 #include <io/kfile.h>
  58
  59 /**
  60  * \brief Returns the value for the given string in char* format.
  61  * Reads the whole input file looking for section and key and fills the provided buffer with
  62  * the corresponding value.
  63  * On errors, the function fills the provided buffer with the default value and returns EOF.
  64  * \param fd An initialized KFile structure.
  65  * \param section The section to be looked for.
  66  * \param key The key to search for.
  67  * \param default_value The default value.
  68  * \param buf The buffer to be filled.
  69  * \param size The size of the provided buffer.
  70  * \return 0 if section and key were found, EOF on errors.
  71  */
  72 int ini_getString(KFile *fd, const char *section, const char *key, const char *default_value, char *buf, size_t size);
  73
  74
  75 int ini_getInteger(KFile *fd, const char *section, const char *key, long default_value, long *val, int base);
  76 int ini_setString(KFile *in, KFile *out, const char *section, const char *key, const char *value);
  77
  78 int ini_reader_testSetup(void);
  79 int ini_reader_testRun(void);
  80 int ini_reader_testTearDown(void);
  81
  82 /** \} */ // defgroup ini_reader
  83 #endif /* INI_READER_H */