Greenbone Vulnerability Management Libraries  10.0.0
settings.h File Reference

Protos and data structures for configuration file management. More...

#include <glib.h>
Include dependency graph for settings.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  settings_t
 Struct holding options for settings taken from a key-value config file. More...
 
struct  settings_iterator_t
 Struct holding options to iterate over a GKeyFile. More...
 

Functions

void settings_cleanup (settings_t *)
 Cleanup a settings structure. More...
 
int init_settings_iterator_from_file (settings_iterator_t *, const gchar *, const gchar *)
 Initialise a settings iterator from a file. More...
 
void cleanup_settings_iterator (settings_iterator_t *)
 Cleanup a settings iterator. More...
 
int settings_iterator_next (settings_iterator_t *)
 Increment an iterator. More...
 
const gchar * settings_iterator_name (settings_iterator_t *)
 Get the name from a settings iterator. More...
 
const gchar * settings_iterator_value (settings_iterator_t *)
 Get the value from a settings iterator. More...
 

Detailed Description

Protos and data structures for configuration file management.

This file contains the protos for settings.c

Definition in file settings.h.

Function Documentation

◆ cleanup_settings_iterator()

void cleanup_settings_iterator ( settings_iterator_t iterator)

Cleanup a settings iterator.

Parameters
[in]iteratorSettings iterator.

Definition at line 144 of file settings.c.

145 {
146  g_strfreev (iterator->keys);
147  settings_cleanup (&iterator->settings);
148 }
void settings_cleanup(settings_t *settings)
Cleanup a settings structure.
Definition: settings.c:89
settings_t settings
Definition: settings.h:52

References settings_iterator_t::keys, settings_iterator_t::settings, and settings_cleanup().

Referenced by prefs_config().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ init_settings_iterator_from_file()

int init_settings_iterator_from_file ( settings_iterator_t iterator,
const gchar *  filename,
const gchar *  group 
)

Initialise a settings iterator from a file.

Parameters
[in]iteratorSettings iterator.
[in]filenameComplete name of the configuration file.
[in]groupName of the group in the file.
Returns
0 success, -1 error.

Definition at line 106 of file settings.c.

108 {
109  int ret;
110  gsize keys_length;
111  GError *error = NULL;
112 
113  ret = settings_init_from_file (&iterator->settings, filename, group);
114  if (ret)
115  return ret;
116 
117  iterator->keys = g_key_file_get_keys (iterator->settings.key_file, group,
118  &keys_length, &error);
119 
120  if (iterator->keys == NULL)
121  {
122  if (error)
123  {
124  g_warning ("Failed to retrieve keys of group %s from %s: %s", group,
125  filename, error->message);
126  g_error_free (error);
127  }
128  g_key_file_free (iterator->settings.key_file);
129  return -1;
130  }
131 
132  iterator->current_key = iterator->keys - 1;
133  iterator->last_key = iterator->keys + keys_length - 1;
134 
135  return 0;
136 }
GKeyFile * key_file
Definition: settings.h:40
gchar ** current_key
Definition: settings.h:53
gchar ** last_key
Definition: settings.h:54
int settings_init_from_file(settings_t *settings, const gchar *filename, const gchar *group)
Initialise a settings struct from a file.
Definition: settings.c:40
settings_t settings
Definition: settings.h:52

References settings_iterator_t::current_key, settings_t::key_file, settings_iterator_t::keys, settings_iterator_t::last_key, settings_iterator_t::settings, and settings_init_from_file().

Referenced by prefs_config().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ settings_cleanup()

void settings_cleanup ( settings_t settings)

Cleanup a settings structure.

Parameters
[in]settingsSettings structure.

Definition at line 89 of file settings.c.

90 {
91  g_free (settings->group_name);
92  g_free (settings->file_name);
93  g_key_file_free (settings->key_file);
94 }
GKeyFile * key_file
Definition: settings.h:40
gchar * file_name
Definition: settings.h:38
gchar * group_name
Definition: settings.h:39

References settings_t::file_name, settings_t::group_name, and settings_t::key_file.

Referenced by cleanup_settings_iterator().

Here is the caller graph for this function:

◆ settings_iterator_name()

const gchar* settings_iterator_name ( settings_iterator_t iterator)

Get the name from a settings iterator.

Parameters
[in]iteratorSettings iterator.
Returns
Name of current key.

Definition at line 174 of file settings.c.

175 {
176  return *iterator->current_key;
177 }
gchar ** current_key
Definition: settings.h:53

References settings_iterator_t::current_key.

Referenced by prefs_config().

Here is the caller graph for this function:

◆ settings_iterator_next()

int settings_iterator_next ( settings_iterator_t iterator)

Increment an iterator.

Parameters
[in]iteratorSettings iterator.
Returns
TRUE if there was a next item, else FALSE.

Definition at line 158 of file settings.c.

159 {
160  if (iterator->current_key == iterator->last_key)
161  return FALSE;
162  iterator->current_key++;
163  return TRUE;
164 }
gchar ** current_key
Definition: settings.h:53
gchar ** last_key
Definition: settings.h:54

References settings_iterator_t::current_key, and settings_iterator_t::last_key.

Referenced by prefs_config().

Here is the caller graph for this function:

◆ settings_iterator_value()

const gchar* settings_iterator_value ( settings_iterator_t iterator)

Get the value from a settings iterator.

Parameters
[in]iteratorSettings iterator.
Returns
Value of current key.

Definition at line 187 of file settings.c.

188 {
189  return g_key_file_get_value (iterator->settings.key_file,
190  iterator->settings.group_name,
191  *iterator->current_key, NULL);
192 }
GKeyFile * key_file
Definition: settings.h:40
gchar ** current_key
Definition: settings.h:53
gchar * group_name
Definition: settings.h:39
settings_t settings
Definition: settings.h:52

References settings_iterator_t::current_key, settings_t::group_name, settings_t::key_file, and settings_iterator_t::settings.

Referenced by prefs_config().

Here is the caller graph for this function: