Gtuber Config: Gtuber Reference Manual

Gtuber Config

Gtuber Config — functions for reading local user config

Functions

gchar *	gtuber_config_obtain_config_dir_path ()
gchar *	gtuber_config_obtain_config_file_path ()
GFile *	gtuber_config_obtain_config_dir ()
GFile *	gtuber_config_obtain_config_dir_file ()
gchar **	gtuber_config_read_plugin_hosts_file ()
gchar **	gtuber_config_read_plugin_hosts_file_with_prepend ()

Description

Functions

gtuber_config_obtain_config_dir_path ()

gchar *
gtuber_config_obtain_config_dir_path (void);

Obtains a complete filename leading to gtuber config folder within user config directory.

Returns

filename of config directory.

[transfer full]

gtuber_config_obtain_config_file_path ()

gchar *
gtuber_config_obtain_config_file_path (const gchar *file_name);

Obtains a complete filename leading to a file within gtuber config directory.

Parameters

file_name

name of the config file

Returns

filename of config file.

[transfer full]

gtuber_config_obtain_config_dir ()

GFile *
gtuber_config_obtain_config_dir (void);

Obtains a GFile from path leading to gtuber config directory.

Returns

a GFile from gtuber config directory.

[transfer full]

gtuber_config_obtain_config_dir_file ()

GFile *
gtuber_config_obtain_config_dir_file (const gchar *file_name);

Obtains a GFile from file within gtuber config directory.

Parameters

file_name

name of the config file

Returns

a GFile from file within gtuber config directory.

[transfer full]

gtuber_config_read_plugin_hosts_file ()

gchar **
gtuber_config_read_plugin_hosts_file (const gchar *file_name);

Obtains a list of hosts read from file within gtuber config directory.

Parameters

file_name

name of the config file

Returns

a list of hosts from config file.

[transfer full]

gtuber_config_read_plugin_hosts_file_with_prepend ()

gchar **
gtuber_config_read_plugin_hosts_file_with_prepend
                               (const gchar *file_name,
                                ...);

Obtains a list of hosts read from file within gtuber config directory. Additional hosts are prepended to the list without modifying file contents.

Parameters

file_name	name of the config file
...	`NULL` terminated list of additional hosts to prepend

Returns

a combined list of hosts.

[transfer full]