"Fossies" - the Fresh Open Source Software Archive

Member "gvm-libs-11.0.1/base/settings.h" (12 May 2020, 2124 Bytes) of package /linux/misc/openvas/gvm-libs-11.0.1.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) C and C++ source code syntax highlighting (style: standard) with prefixed line numbers and code folding option. Alternatively you can here view or download the uninterpreted source code file. For more information about "settings.h" see the Fossies "Dox" file reference documentation and the last Fossies "Diffs" side-by-side code changes report: 1.0-beta2_vs_1.0.0.

    1 /* Copyright (C) 2010-2019 Greenbone Networks GmbH
    2  *
    3  * SPDX-License-Identifier: GPL-2.0-or-later
    4  *
    5  * This program is free software; you can redistribute it and/or
    6  * modify it under the terms of the GNU General Public License
    7  * as published by the Free Software Foundation; either version 2
    8  * of the License, or (at your option) any later version.
    9  *
   10  * This program is distributed in the hope that it will be useful,
   11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
   12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   13  * GNU General Public License for more details.
   14  *
   15  * You should have received a copy of the GNU General Public License
   16  * along with this program; if not, write to the Free Software
   17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   18  */
   19 
   20 /**
   21  * @file
   22  * @brief Protos and data structures for configuration file management
   23  *
   24  * This file contains the protos for \ref settings.c
   25  */
   26 
   27 #ifndef _GVM_SETTINGS_H
   28 #define _GVM_SETTINGS_H
   29 
   30 #include <glib.h>
   31 
   32 /**
   33  * @brief Struct holding options for settings taken from a key-value
   34  *        config file.
   35  */
   36 typedef struct
   37 {
   38   gchar *file_name;   /**< Filename containing key-value pairs. */
   39   gchar *group_name;  /**< Name of the group containing key-value pairs. */
   40   GKeyFile *key_file; /**< GKeyFile object where the file is load. */
   41 } settings_t;
   42 
   43 void
   44 settings_cleanup (settings_t *);
   45 
   46 /**
   47  * @brief Struct holding options to iterate over a GKeyFile.
   48  */
   49 typedef struct
   50 {
   51   gchar **keys;        /**< Keys. */
   52   settings_t settings; /**< Settings structure. */
   53   gchar **current_key; /**< Pointer to the current key. */
   54   gchar **last_key;    /**< Pointer to the last keys. */
   55 } settings_iterator_t;
   56 
   57 int
   58 init_settings_iterator_from_file (settings_iterator_t *, const gchar *,
   59                                   const gchar *);
   60 void
   61 cleanup_settings_iterator (settings_iterator_t *);
   62 int
   63 settings_iterator_next (settings_iterator_t *);
   64 const gchar *
   65 settings_iterator_name (settings_iterator_t *);
   66 const gchar *
   67 settings_iterator_value (settings_iterator_t *);
   68 
   69 #endif /* not _GVM_SETTINGS_H */