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.
int	init_settings_iterator_from_file (settings_iterator_t *, const gchar *, const gchar *)
	Initialise a settings iterator from a file.
void	cleanup_settings_iterator (settings_iterator_t *)
	Cleanup a settings iterator.
int	settings_iterator_next (settings_iterator_t *)
	Increment an iterator.
const gchar *	settings_iterator_name (settings_iterator_t *)
	Get the name from a settings iterator.
gchar *	settings_iterator_value (settings_iterator_t *)
	Get the value from a settings iterator.

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]

iterator

Settings iterator.

Definition at line 136 of file settings.c.

{
  g_strfreev (iterator->keys);
  settings_cleanup (&iterator->settings);
}

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

Referenced by Ensure(), Ensure(), Ensure(), and 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]	iterator	Settings iterator.
[in]	filename	Complete name of the configuration file.
[in]	group	Name of the group in the file.

Returns

0 success, -1 error.

Definition at line 98 of file settings.c.

{
  int ret;
  gsize keys_length;
  GError *error = NULL;
 
  ret = settings_init_from_file (&iterator->settings, filename, group);
  if (ret)
    return ret;
 
  iterator->keys = g_key_file_get_keys (iterator->settings.key_file, group,
                                        &keys_length, &error);
 
  if (iterator->keys == NULL)
    {
      if (error)
        {
          g_warning ("Failed to retrieve keys of group %s from %s: %s", group,
                     filename, error->message);
          g_error_free (error);
        }
      g_key_file_free (iterator->settings.key_file);
      return -1;
    }
 
  iterator->current_key = iterator->keys - 1;
  iterator->last_key = iterator->keys + keys_length - 1;
 
  return 0;
}

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 Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), and 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]

settings

Settings structure.

Definition at line 81 of file settings.c.

{
  g_free (settings->group_name);
  g_free (settings->file_name);
  g_key_file_free (settings->key_file);
}

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

Referenced by cleanup_settings_iterator(), and Ensure().

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]

iterator

Settings iterator.

Returns

Name of current key.

Definition at line 166 of file settings.c.

{
  return *iterator->current_key;
}

References settings_iterator_t::current_key.

Referenced by Ensure(), Ensure(), and 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]

iterator

Settings iterator.

Returns

TRUE if there was a next item, else FALSE.

Definition at line 150 of file settings.c.

{
  if (iterator->current_key == iterator->last_key)
    return FALSE;
  iterator->current_key++;
  return TRUE;
}

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

Referenced by Ensure(), Ensure(), and prefs_config().

Here is the caller graph for this function:

settings_iterator_value()

gchar * settings_iterator_value

(

settings_iterator_t *

iterator

)

Get the value from a settings iterator.

Parameters

[in]

iterator

Settings iterator.

Returns

Value of current key. Caller must g_free.

Definition at line 179 of file settings.c.

{
  return g_key_file_get_value (iterator->settings.key_file,
                               iterator->settings.group_name,
                               *iterator->current_key, NULL);
}

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

Referenced by Ensure(), Ensure(), and prefs_config().

Here is the caller graph for this function: