X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=glib%2Fgkeyfile.c;h=cc51eda690eaf9afea04a3475e4bb10e7cc9f580;hb=30ed5f53e205e6bfc35126a9d3c62dac8a9c5dad;hp=a219c78651d3d6cd2402791fc58d688a98806c6f;hpb=b021642caffc72147a31f039114e949825d440be;p=platform%2Fupstream%2Fglib.git diff --git a/glib/gkeyfile.c b/glib/gkeyfile.c index a219c78..cc51eda 100644 --- a/glib/gkeyfile.c +++ b/glib/gkeyfile.c @@ -1,6 +1,8 @@ /* gkeyfile.c - key file parser * * Copyright 2004 Red Hat, Inc. + * Copyright 2009-2010 Collabora Ltd. + * Copyright 2009 Nokia Corporation * * Written by Ray Strode * Matthias Clasen @@ -17,13 +19,13 @@ * * You should have received a copy of the GNU Lesser General Public * License along with GLib; see the file COPYING.LIB. If not, - * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, - * Boston, MA 02111-1307, USA. + * see . */ #include "config.h" #include "gkeyfile.h" +#include "gutils.h" #include #include @@ -33,12 +35,17 @@ #include #include #include -#ifdef HAVE_UNISTD_H +#ifdef G_OS_UNIX #include #endif #ifdef G_OS_WIN32 #include +#undef fstat +#define fstat(a,b) _fstati64(a,b) +#undef stat +#define stat _stati64 + #ifndef S_ISREG #define S_ISREG(mode) ((mode)&_S_IFREG) #endif @@ -60,26 +67,383 @@ #include "gstrfuncs.h" #include "gutils.h" -#include "galias.h" + +/** + * SECTION:keyfile + * @title: Key-value file parser + * @short_description: parses .ini-like config files + * + * #GKeyFile lets you parse, edit or create files containing groups of + * key-value pairs, which we call "key files" for lack of a better name. + * Several freedesktop.org specifications use key files now, e.g the + * [Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec) + * and the + * [Icon Theme Specification](http://freedesktop.org/Standards/icon-theme-spec). + * + * The syntax of key files is described in detail in the + * [Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec), + * here is a quick summary: Key files + * consists of groups of key-value pairs, interspersed with comments. + * + * |[ + * # this is just an example + * # there can be comments before the first group + * + * [First Group] + * + * Name=Key File Example\tthis value shows\nescaping + * + * # localized strings are stored in multiple key-value pairs + * Welcome=Hello + * Welcome[de]=Hallo + * Welcome[fr_FR]=Bonjour + * Welcome[it]=Ciao + * Welcome[be@latin]=Hello + * + * [Another Group] + * + * Numbers=2;20;-200;0 + * + * Booleans=true;false;true;true + * ]| + * + * Lines beginning with a '#' and blank lines are considered comments. + * + * Groups are started by a header line containing the group name enclosed + * in '[' and ']', and ended implicitly by the start of the next group or + * the end of the file. Each key-value pair must be contained in a group. + * + * Key-value pairs generally have the form `key=value`, with the + * exception of localized strings, which have the form + * `key[locale]=value`, with a locale identifier of the + * form `lang_COUNTRY@MODIFIER` where `COUNTRY` and `MODIFIER` + * are optional. + * Space before and after the '=' character are ignored. Newline, tab, + * carriage return and backslash characters in value are escaped as \n, + * \t, \r, and \\, respectively. To preserve leading spaces in values, + * these can also be escaped as \s. + * + * Key files can store strings (possibly with localized variants), integers, + * booleans and lists of these. Lists are separated by a separator character, + * typically ';' or ','. To use the list separator character in a value in + * a list, it has to be escaped by prefixing it with a backslash. + * + * This syntax is obviously inspired by the .ini files commonly met + * on Windows, but there are some important differences: + * + * - .ini files use the ';' character to begin comments, + * key files use the '#' character. + * + * - Key files do not allow for ungrouped keys meaning only + * comments can precede the first group. + * + * - Key files are always encoded in UTF-8. + * + * - Key and Group names are case-sensitive. For example, a group called + * [GROUP] is a different from [group]. + * + * - .ini files don't have a strongly typed boolean entry type, + * they only have GetProfileInt(). In key files, only + * true and false (in lower case) are allowed. + * + * Note that in contrast to the + * [Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec), + * groups in key files may contain the same + * key multiple times; the last entry wins. Key files may also contain + * multiple groups with the same name; they are merged together. + * Another difference is that keys and group names in key files are not + * restricted to ASCII characters. + */ + +/** + * G_KEY_FILE_ERROR: + * + * Error domain for key file parsing. Errors in this domain will + * be from the #GKeyFileError enumeration. + * + * See #GError for information on error domains. + */ + +/** + * GKeyFileError: + * @G_KEY_FILE_ERROR_UNKNOWN_ENCODING: the text being parsed was in + * an unknown encoding + * @G_KEY_FILE_ERROR_PARSE: document was ill-formed + * @G_KEY_FILE_ERROR_NOT_FOUND: the file was not found + * @G_KEY_FILE_ERROR_KEY_NOT_FOUND: a requested key was not found + * @G_KEY_FILE_ERROR_GROUP_NOT_FOUND: a requested group was not found + * @G_KEY_FILE_ERROR_INVALID_VALUE: a value could not be parsed + * + * Error codes returned by key file parsing. + */ + +/** + * GKeyFileFlags: + * @G_KEY_FILE_NONE: No flags, default behaviour + * @G_KEY_FILE_KEEP_COMMENTS: Use this flag if you plan to write the + * (possibly modified) contents of the key file back to a file; + * otherwise all comments will be lost when the key file is + * written back. + * @G_KEY_FILE_KEEP_TRANSLATIONS: Use this flag if you plan to write the + * (possibly modified) contents of the key file back to a file; + * otherwise only the translations for the current language will be + * written back. + * + * Flags which influence the parsing. + */ + +/** + * G_KEY_FILE_DESKTOP_GROUP: + * + * The name of the main group of a desktop entry file, as defined in the + * [Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec). + * Consult the specification for more + * details about the meanings of the keys below. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_KEY_TYPE: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string + * giving the type of the desktop entry. Usually + * #G_KEY_FILE_DESKTOP_TYPE_APPLICATION, + * #G_KEY_FILE_DESKTOP_TYPE_LINK, or + * #G_KEY_FILE_DESKTOP_TYPE_DIRECTORY. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_KEY_VERSION: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string + * giving the version of the Desktop Entry Specification used for + * the desktop entry file. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_KEY_NAME: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized + * string giving the specific name of the desktop entry. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized + * string giving the generic name of the desktop entry. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean + * stating whether the desktop entry should be shown in menus. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_KEY_COMMENT: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized + * string giving the tooltip for the desktop entry. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_KEY_ICON: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized + * string giving the name of the icon to be displayed for the desktop + * entry. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_KEY_HIDDEN: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean + * stating whether the desktop entry has been deleted by the user. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list of + * strings identifying the environments that should display the + * desktop entry. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list of + * strings identifying the environments that should not display the + * desktop entry. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_KEY_TRY_EXEC: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string + * giving the file name of a binary on disk used to determine if the + * program is actually installed. It is only valid for desktop entries + * with the `Application` type. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_KEY_EXEC: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string + * giving the command line to execute. It is only valid for desktop + * entries with the `Application` type. + * + * Since: 2.14 + */ + + /** + * G_KEY_FILE_DESKTOP_KEY_PATH: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string + * containing the working directory to run the program in. It is only + * valid for desktop entries with the `Application` type. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_KEY_TERMINAL: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean + * stating whether the program should be run in a terminal window. + * It is only valid for desktop entries with the + * `Application` type. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_KEY_MIME_TYPE: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list + * of strings giving the MIME types supported by this desktop entry. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_KEY_CATEGORIES: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list + * of strings giving the categories in which the desktop entry + * should be shown in a menu. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean + * stating whether the application supports the + * [Startup Notification Protocol Specification](http://www.freedesktop.org/Standards/startup-notification-spec). + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is string + * identifying the WM class or name hint of a window that the application + * will create, which can be used to emulate Startup Notification with + * older applications. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_KEY_URL : + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string + * giving the URL to access. It is only valid for desktop entries + * with the `Link` type. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_TYPE_APPLICATION: + * + * The value of the #G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop + * entries representing applications. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_TYPE_LINK: + * + * The value of the #G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop + * entries representing links to documents. + * + * Since: 2.14 + */ + +/** + * G_KEY_FILE_DESKTOP_TYPE_DIRECTORY: + * + * The value of the #G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop + * entries representing directories. + * + * Since: 2.14 + */ typedef struct _GKeyFileGroup GKeyFileGroup; +/** + * GKeyFile: + * + * The GKeyFile struct contains only private data + * and should not be accessed directly. + */ struct _GKeyFile { GList *groups; + GHashTable *group_hash; GKeyFileGroup *start_group; GKeyFileGroup *current_group; GString *parse_buffer; /* Holds up to one line of not-yet-parsed data */ - /* Used for sizing the output buffer during serialization - */ - gsize approximate_size; - gchar list_separator; GKeyFileFlags flags; + + gchar **locales; + + volatile gint ref_count; }; typedef struct _GKeyFileKeyValuePair GKeyFileKeyValuePair; @@ -90,7 +454,7 @@ struct _GKeyFileGroup GKeyFileKeyValuePair *comment; /* Special comment that is stuck to the top of a group */ - GList *key_value_pairs; + GList *key_value_pairs; /* Used in parallel with key_value_pairs for * increased lookup performance @@ -105,8 +469,8 @@ struct _GKeyFileKeyValuePair }; static gint find_file_in_data_dirs (const gchar *file, + const gchar **data_dirs, gchar **output_file, - gchar ***data_dirs, GError **error); static gboolean g_key_file_load_from_fd (GKeyFile *key_file, gint fd, @@ -130,6 +494,9 @@ static void g_key_file_remove_key_value_pair_node (GKeyFile GKeyFileGroup *group, GList *pair_node); +static void g_key_file_add_key_value_pair (GKeyFile *key_file, + GKeyFileGroup *group, + GKeyFileKeyValuePair *pair); static void g_key_file_add_key (GKeyFile *key_file, GKeyFileGroup *group, const gchar *key, @@ -186,23 +553,19 @@ static void g_key_file_parse_data (GKeyFile static void g_key_file_flush_parse_buffer (GKeyFile *key_file, GError **error); - -GQuark -g_key_file_error_quark (void) -{ - return g_quark_from_static_string ("g-key-file-error-quark"); -} +G_DEFINE_QUARK (g-key-file-error-quark, g_key_file_error) static void g_key_file_init (GKeyFile *key_file) { - key_file->current_group = g_new0 (GKeyFileGroup, 1); + key_file->current_group = g_slice_new0 (GKeyFileGroup); key_file->groups = g_list_prepend (NULL, key_file->current_group); + key_file->group_hash = g_hash_table_new (g_str_hash, g_str_equal); key_file->start_group = NULL; key_file->parse_buffer = g_string_sized_new (128); - key_file->approximate_size = 0; key_file->list_separator = ';'; key_file->flags = 0; + key_file->locales = g_strdupv ((gchar **)g_get_language_names ()); } static void @@ -210,8 +573,17 @@ g_key_file_clear (GKeyFile *key_file) { GList *tmp, *group_node; + if (key_file->locales) + { + g_strfreev (key_file->locales); + key_file->locales = NULL; + } + if (key_file->parse_buffer) - g_string_free (key_file->parse_buffer, TRUE); + { + g_string_free (key_file->parse_buffer, TRUE); + key_file->parse_buffer = NULL; + } tmp = key_file->groups; while (tmp != NULL) @@ -221,18 +593,25 @@ g_key_file_clear (GKeyFile *key_file) g_key_file_remove_group_node (key_file, group_node); } - g_assert (key_file->groups == NULL); + if (key_file->group_hash != NULL) + { + g_hash_table_destroy (key_file->group_hash); + key_file->group_hash = NULL; + } + + g_warn_if_fail (key_file->groups == NULL); } /** * g_key_file_new: * - * Creates a new empty #GKeyFile object. Use g_key_file_load_from_file(), - * g_key_file_load_from_data() or g_key_file_load_from_data_dirs() to + * Creates a new empty #GKeyFile object. Use + * g_key_file_load_from_file(), g_key_file_load_from_data(), + * g_key_file_load_from_dirs() or g_key_file_load_from_data_dirs() to * read an existing key file. * - * Return value: an empty #GKeyFile. + * Returns: (transfer full): an empty #GKeyFile. * * Since: 2.6 **/ @@ -241,7 +620,8 @@ g_key_file_new (void) { GKeyFile *key_file; - key_file = g_new0 (GKeyFile, 1); + key_file = g_slice_new0 (GKeyFile); + key_file->ref_count = 1; g_key_file_init (key_file); return key_file; @@ -271,16 +651,16 @@ g_key_file_set_list_separator (GKeyFile *key_file, /* Iterates through all the directories in *dirs trying to * open file. When it successfully locates and opens a file it * returns the file descriptor to the open file. It also - * outputs the absolute path of the file in output_file and - * leaves the unchecked directories in *dirs. + * outputs the absolute path of the file in output_file. */ static gint find_file_in_data_dirs (const gchar *file, + const gchar **dirs, gchar **output_file, - gchar ***dirs, GError **error) { - gchar **data_dirs, *data_dir, *path; + const gchar **data_dirs, *data_dir; + gchar *path; gint fd; path = NULL; @@ -289,15 +669,15 @@ find_file_in_data_dirs (const gchar *file, if (dirs == NULL) return fd; - data_dirs = *dirs; + data_dirs = dirs; - while (data_dirs && (data_dir = *data_dirs) && fd < 0) + while (data_dirs && (data_dir = *data_dirs) && fd == -1) { gchar *candidate_file, *sub_dir; candidate_file = (gchar *) file; sub_dir = g_strdup (""); - while (candidate_file != NULL && fd < 0) + while (candidate_file != NULL && fd == -1) { gchar *p; @@ -306,7 +686,7 @@ find_file_in_data_dirs (const gchar *file, fd = g_open (path, O_RDONLY, 0); - if (fd < 0) + if (fd == -1) { g_free (path); path = NULL; @@ -332,14 +712,12 @@ find_file_in_data_dirs (const gchar *file, data_dirs++; } - *dirs = data_dirs; - - if (fd < 0) + if (fd == -1) { - g_set_error (error, G_KEY_FILE_ERROR, - G_KEY_FILE_ERROR_NOT_FOUND, - _("Valid key file could not be " - "found in data dirs")); + g_set_error_literal (error, G_KEY_FILE_ERROR, + G_KEY_FILE_ERROR_NOT_FOUND, + _("Valid key file could not be " + "found in search dirs")); } if (output_file != NULL && fd > 0) @@ -360,39 +738,30 @@ g_key_file_load_from_fd (GKeyFile *key_file, gssize bytes_read; struct stat stat_buf; gchar read_buf[4096]; - + gchar list_separator; + if (fstat (fd, &stat_buf) < 0) { - g_set_error (error, G_FILE_ERROR, - g_file_error_from_errno (errno), - "%s", g_strerror (errno)); + g_set_error_literal (error, G_FILE_ERROR, + g_file_error_from_errno (errno), + g_strerror (errno)); return FALSE; } if (!S_ISREG (stat_buf.st_mode)) { - g_set_error (error, G_KEY_FILE_ERROR, - G_KEY_FILE_ERROR_PARSE, - _("Not a regular file")); - return FALSE; - } - - if (stat_buf.st_size == 0) - { - g_set_error (error, G_KEY_FILE_ERROR, - G_KEY_FILE_ERROR_PARSE, - _("File is empty")); + g_set_error_literal (error, G_KEY_FILE_ERROR, + G_KEY_FILE_ERROR_PARSE, + _("Not a regular file")); return FALSE; } - if (key_file->approximate_size > 0) - { - g_key_file_clear (key_file); - g_key_file_init (key_file); - } + list_separator = key_file->list_separator; + g_key_file_clear (key_file); + g_key_file_init (key_file); + key_file->list_separator = list_separator; key_file->flags = flags; - bytes_read = 0; do { bytes_read = read (fd, read_buf, 4096); @@ -405,13 +774,13 @@ g_key_file_load_from_fd (GKeyFile *key_file, if (errno == EINTR || errno == EAGAIN) continue; - g_set_error (error, G_FILE_ERROR, - g_file_error_from_errno (errno), - "%s", g_strerror (errno)); + g_set_error_literal (error, G_FILE_ERROR, + g_file_error_from_errno (errno), + g_strerror (errno)); return FALSE; } - g_key_file_parse_data (key_file, + g_key_file_parse_data (key_file, read_buf, bytes_read, &key_file_error); } @@ -437,15 +806,16 @@ g_key_file_load_from_fd (GKeyFile *key_file, /** * g_key_file_load_from_file: * @key_file: an empty #GKeyFile struct - * @file: the path of a filename to load, in the GLib file name encoding + * @file: (type filename): the path of a filename to load, in the GLib filename encoding * @flags: flags from #GKeyFileFlags * @error: return location for a #GError, or %NULL * * Loads a key file into an empty #GKeyFile structure. - * If the file could not be loaded then %error is set to + * If the file could not be loaded then @error is set to * either a #GFileError or #GKeyFileError. * - * Return value: %TRUE if a key file could be loaded, %FALSE othewise + * Returns: %TRUE if a key file could be loaded, %FALSE otherwise + * * Since: 2.6 **/ gboolean @@ -462,11 +832,11 @@ g_key_file_load_from_file (GKeyFile *key_file, fd = g_open (file, O_RDONLY, 0); - if (fd < 0) + if (fd == -1) { - g_set_error (error, G_FILE_ERROR, - g_file_error_from_errno (errno), - "%s", g_strerror (errno)); + g_set_error_literal (error, G_FILE_ERROR, + g_file_error_from_errno (errno), + g_strerror (errno)); return FALSE; } @@ -485,16 +855,16 @@ g_key_file_load_from_file (GKeyFile *key_file, /** * g_key_file_load_from_data: * @key_file: an empty #GKeyFile struct - * @data: key file loaded in memory. - * @length: the length of @data in bytes + * @data: key file loaded in memory + * @length: the length of @data in bytes (or (gsize)-1 if data is nul-terminated) * @flags: flags from #GKeyFileFlags * @error: return location for a #GError, or %NULL * - * Loads a key file from memory into an empty #GKeyFile structure. If - * the object cannot be created then %error is set to a - * #GKeyFileError. + * Loads a key file from memory into an empty #GKeyFile structure. + * If the object cannot be created then %error is set to a #GKeyFileError. + * + * Returns: %TRUE if a key file could be loaded, %FALSE otherwise * - * Return value: %TRUE if a key file could be loaded, %FALSE othewise * Since: 2.6 **/ gboolean @@ -505,19 +875,18 @@ g_key_file_load_from_data (GKeyFile *key_file, GError **error) { GError *key_file_error = NULL; + gchar list_separator; g_return_val_if_fail (key_file != NULL, FALSE); - g_return_val_if_fail (data != NULL, FALSE); - g_return_val_if_fail (length != 0, FALSE); + g_return_val_if_fail (data != NULL || length == 0, FALSE); if (length == (gsize)-1) length = strlen (data); - if (key_file->approximate_size > 0) - { - g_key_file_clear (key_file); - g_key_file_init (key_file); - } + list_separator = key_file->list_separator; + g_key_file_clear (key_file); + g_key_file_init (key_file); + key_file->list_separator = list_separator; key_file->flags = flags; g_key_file_parse_data (key_file, data, length, &key_file_error); @@ -540,64 +909,54 @@ g_key_file_load_from_data (GKeyFile *key_file, } /** - * g_key_file_load_from_data_dirs: + * g_key_file_load_from_dirs: * @key_file: an empty #GKeyFile struct - * @file: a relative path to a filename to open and parse - * @full_path: return location for a string containing the full path + * @file: (type filename): a relative path to a filename to open and parse + * @search_dirs: (array zero-terminated=1) (element-type filename): %NULL-terminated array of directories to search + * @full_path: (out) (type filename) (allow-none): return location for a string containing the full path * of the file, or %NULL - * @flags: flags from #GKeyFileFlags + * @flags: flags from #GKeyFileFlags * @error: return location for a #GError, or %NULL * - * This function looks for a key file named @file in the paths - * returned from g_get_user_data_dir() and g_get_system_data_dirs(), - * loads the file into @key_file and returns the file's full path in - * @full_path. If the file could not be loaded then an %error is - * set to either a #GFileError or #GKeyFileError. + * This function looks for a key file named @file in the paths + * specified in @search_dirs, loads the file into @key_file and + * returns the file's full path in @full_path. If the file could not + * be loaded then an %error is set to either a #GFileError or + * #GKeyFileError. * - * Return value: %TRUE if a key file could be loaded, %FALSE othewise - * Since: 2.6 + * Returns: %TRUE if a key file could be loaded, %FALSE otherwise + * + * Since: 2.14 **/ gboolean -g_key_file_load_from_data_dirs (GKeyFile *key_file, - const gchar *file, - gchar **full_path, - GKeyFileFlags flags, - GError **error) +g_key_file_load_from_dirs (GKeyFile *key_file, + const gchar *file, + const gchar **search_dirs, + gchar **full_path, + GKeyFileFlags flags, + GError **error) { GError *key_file_error = NULL; - gchar **all_data_dirs, **data_dirs; - const gchar * user_data_dir; - const gchar * const * system_data_dirs; - gsize i, j; + const gchar **data_dirs; gchar *output_path; gint fd; gboolean found_file; - + g_return_val_if_fail (key_file != NULL, FALSE); g_return_val_if_fail (!g_path_is_absolute (file), FALSE); - - user_data_dir = g_get_user_data_dir (); - system_data_dirs = g_get_system_data_dirs (); - all_data_dirs = g_new0 (gchar *, g_strv_length ((gchar **)system_data_dirs) + 2); - - i = 0; - all_data_dirs[i++] = g_strdup (user_data_dir); - - j = 0; - while (system_data_dirs[j] != NULL) - all_data_dirs[i++] = g_strdup (system_data_dirs[j++]); + g_return_val_if_fail (search_dirs != NULL, FALSE); found_file = FALSE; - data_dirs = all_data_dirs; + data_dirs = search_dirs; output_path = NULL; while (*data_dirs != NULL && !found_file) { g_free (output_path); - fd = find_file_in_data_dirs (file, &output_path, &data_dirs, + fd = find_file_in_data_dirs (file, data_dirs, &output_path, &key_file_error); - - if (fd < 0) + + if (fd == -1) { if (key_file_error) g_propagate_error (error, key_file_error); @@ -607,7 +966,7 @@ g_key_file_load_from_data_dirs (GKeyFile *key_file, found_file = g_key_file_load_from_fd (key_file, fd, flags, &key_file_error); close (fd); - + if (key_file_error) { g_propagate_error (error, key_file_error); @@ -617,19 +976,97 @@ g_key_file_load_from_data_dirs (GKeyFile *key_file, if (found_file && full_path) *full_path = output_path; - else + else g_free (output_path); + return found_file; +} + +/** + * g_key_file_load_from_data_dirs: + * @key_file: an empty #GKeyFile struct + * @file: (type filename): a relative path to a filename to open and parse + * @full_path: (out) (type filename) (allow-none): return location for a string containing the full path + * of the file, or %NULL + * @flags: flags from #GKeyFileFlags + * @error: return location for a #GError, or %NULL + * + * This function looks for a key file named @file in the paths + * returned from g_get_user_data_dir() and g_get_system_data_dirs(), + * loads the file into @key_file and returns the file's full path in + * @full_path. If the file could not be loaded then an %error is + * set to either a #GFileError or #GKeyFileError. + * + * Returns: %TRUE if a key file could be loaded, %FALSE othewise + * Since: 2.6 + **/ +gboolean +g_key_file_load_from_data_dirs (GKeyFile *key_file, + const gchar *file, + gchar **full_path, + GKeyFileFlags flags, + GError **error) +{ + gchar **all_data_dirs; + const gchar * user_data_dir; + const gchar * const * system_data_dirs; + gsize i, j; + gboolean found_file; + + g_return_val_if_fail (key_file != NULL, FALSE); + g_return_val_if_fail (!g_path_is_absolute (file), FALSE); + + user_data_dir = g_get_user_data_dir (); + system_data_dirs = g_get_system_data_dirs (); + all_data_dirs = g_new (gchar *, g_strv_length ((gchar **)system_data_dirs) + 2); + + i = 0; + all_data_dirs[i++] = g_strdup (user_data_dir); + + j = 0; + while (system_data_dirs[j] != NULL) + all_data_dirs[i++] = g_strdup (system_data_dirs[j++]); + all_data_dirs[i] = NULL; + + found_file = g_key_file_load_from_dirs (key_file, + file, + (const gchar **)all_data_dirs, + full_path, + flags, + error); + g_strfreev (all_data_dirs); return found_file; } /** - * g_key_file_free: + * g_key_file_ref: (skip) * @key_file: a #GKeyFile * - * Frees a #GKeyFile. + * Increases the reference count of @key_file. + * + * Returns: the same @key_file. + * + * Since: 2.32 + **/ +GKeyFile * +g_key_file_ref (GKeyFile *key_file) +{ + g_return_val_if_fail (key_file != NULL, NULL); + + g_atomic_int_inc (&key_file->ref_count); + + return key_file; +} + +/** + * g_key_file_free: (skip) + * @key_file: a #GKeyFile + * + * Clears all keys and groups from @key_file, and decreases the + * reference count by 1. If the reference count reaches zero, + * frees the key file and all its allocated memory. * * Since: 2.6 **/ @@ -637,9 +1074,30 @@ void g_key_file_free (GKeyFile *key_file) { g_return_if_fail (key_file != NULL); - + g_key_file_clear (key_file); - g_free (key_file); + g_key_file_unref (key_file); +} + +/** + * g_key_file_unref: + * @key_file: a #GKeyFile + * + * Decreases the reference count of @key_file by 1. If the reference count + * reaches zero, frees the key file and all its allocated memory. + * + * Since: 2.32 + **/ +void +g_key_file_unref (GKeyFile *key_file) +{ + g_return_if_fail (key_file != NULL); + + if (g_atomic_int_dec_and_test (&key_file->ref_count)) + { + g_key_file_clear (key_file); + g_slice_free (GKeyFile, key_file); + } } /* If G_KEY_FILE_KEEP_TRANSLATIONS is not set, only returns @@ -649,17 +1107,14 @@ static gboolean g_key_file_locale_is_interesting (GKeyFile *key_file, const gchar *locale) { - const gchar * const * current_locales; gsize i; if (key_file->flags & G_KEY_FILE_KEEP_TRANSLATIONS) return TRUE; - current_locales = g_get_language_names (); - - for (i = 0; current_locales[i] != NULL; i++) + for (i = 0; key_file->locales[i] != NULL; i++) { - if (g_ascii_strcasecmp (current_locales[i], locale) == 0) + if (g_ascii_strcasecmp (key_file->locales[i], locale) == 0) return TRUE; } @@ -698,8 +1153,8 @@ g_key_file_parse_line (GKeyFile *key_file, g_set_error (error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_PARSE, _("Key file contains line '%s' which is not " - "a key-value pair, group, or comment"), - line_utf8); + "a key-value pair, group, or comment"), + line_utf8); g_free (line_utf8); return; @@ -720,10 +1175,9 @@ g_key_file_parse_comment (GKeyFile *key_file, if (!(key_file->flags & G_KEY_FILE_KEEP_COMMENTS)) return; - g_assert (key_file->current_group != NULL); + g_warn_if_fail (key_file->current_group != NULL); - pair = g_new0 (GKeyFileKeyValuePair, 1); - + pair = g_slice_new (GKeyFileKeyValuePair); pair->key = NULL; pair->value = g_strndup (line, length); @@ -775,15 +1229,15 @@ g_key_file_parse_key_value_pair (GKeyFile *key_file, if (key_file->current_group == NULL || key_file->current_group->name == NULL) { - g_set_error (error, G_KEY_FILE_ERROR, - G_KEY_FILE_ERROR_GROUP_NOT_FOUND, - _("Key file does not start with a group")); + g_set_error_literal (error, G_KEY_FILE_ERROR, + G_KEY_FILE_ERROR_GROUP_NOT_FOUND, + _("Key file does not start with a group")); return; } key_end = value_start = strchr (line, '='); - g_assert (key_end != NULL); + g_warn_if_fail (key_end != NULL); key_end--; value_start++; @@ -795,7 +1249,7 @@ g_key_file_parse_key_value_pair (GKeyFile *key_file, key_len = key_end - line + 2; - g_assert (key_len <= length); + g_warn_if_fail (key_len <= length); key = g_strndup (line, key_len - 1); @@ -817,7 +1271,7 @@ g_key_file_parse_key_value_pair (GKeyFile *key_file, value = g_strndup (value_start, value_len); - g_assert (key_file->start_group != NULL); + g_warn_if_fail (key_file->start_group != NULL); if (key_file->current_group && key_file->current_group->name @@ -845,11 +1299,22 @@ g_key_file_parse_key_value_pair (GKeyFile *key_file, locale = key_get_locale (key); if (locale == NULL || g_key_file_locale_is_interesting (key_file, locale)) - g_key_file_add_key (key_file, key_file->current_group, key, value); + { + GKeyFileKeyValuePair *pair; + + pair = g_slice_new (GKeyFileKeyValuePair); + pair->key = key; + pair->value = value; + + g_key_file_add_key_value_pair (key_file, key_file->current_group, pair); + } + else + { + g_free (key); + g_free (value); + } g_free (locale); - g_free (key); - g_free (value); } static gchar * @@ -878,15 +1343,18 @@ g_key_file_parse_data (GKeyFile *key_file, gsize i; g_return_if_fail (key_file != NULL); - g_return_if_fail (data != NULL); + g_return_if_fail (data != NULL || length == 0); parse_error = NULL; - for (i = 0; i < length; i++) + i = 0; + while (i < length) { if (data[i] == '\n') { - if (i > 0 && data[i - 1] == '\r') + if (key_file->parse_buffer->len > 0 + && (key_file->parse_buffer->str[key_file->parse_buffer->len - 1] + == '\r')) g_string_erase (key_file->parse_buffer, key_file->parse_buffer->len - 1, 1); @@ -905,12 +1373,26 @@ g_key_file_parse_data (GKeyFile *key_file, g_propagate_error (error, parse_error); return; } + i++; } else - g_string_append_c (key_file->parse_buffer, data[i]); - } + { + const gchar *start_of_line; + const gchar *end_of_line; + gsize line_length; + + start_of_line = data + i; + end_of_line = memchr (start_of_line, '\n', length - i); - key_file->approximate_size += length; + if (end_of_line == NULL) + end_of_line = data + length; + + line_length = end_of_line - start_of_line; + + g_string_append_len (key_file->parse_buffer, start_of_line, line_length); + i += line_length; + } + } } static void @@ -941,13 +1423,16 @@ g_key_file_flush_parse_buffer (GKeyFile *key_file, /** * g_key_file_to_data: * @key_file: a #GKeyFile - * @length: return location for the length of the + * @length: (out) (allow-none): return location for the length of the * returned string, or %NULL * @error: return location for a #GError, or %NULL * * This function outputs @key_file as a string. * - * Return value: a newly allocated string holding + * Note that this function never reports an error, + * so it is safe to pass %NULL as @error. + * + * Returns: a newly allocated string holding * the contents of the #GKeyFile * * Since: 2.6 @@ -962,8 +1447,8 @@ g_key_file_to_data (GKeyFile *key_file, g_return_val_if_fail (key_file != NULL, NULL); - data_string = g_string_sized_new (2 * key_file->approximate_size); - + data_string = g_string_new (NULL); + for (group_node = g_list_last (key_file->groups); group_node != NULL; group_node = group_node->prev) @@ -972,10 +1457,13 @@ g_key_file_to_data (GKeyFile *key_file, group = (GKeyFileGroup *) group_node->data; + /* separate groups by at least an empty line */ + if (data_string->len >= 2 && + data_string->str[data_string->len - 2] != '\n') + g_string_append_c (data_string, '\n'); + if (group->comment != NULL) g_string_append_printf (data_string, "%s\n", group->comment->value); - else if (group_node->next) /* separate groups by at least an empty line */ - g_string_append_c (data_string, '\n'); if (group->name != NULL) g_string_append_printf (data_string, "[%s]\n", group->name); @@ -1005,7 +1493,7 @@ g_key_file_to_data (GKeyFile *key_file, * g_key_file_get_keys: * @key_file: a #GKeyFile * @group_name: a group name - * @length: return location for the number of keys returned, or %NULL + * @length: (out) (allow-none): return location for the number of keys returned, or %NULL * @error: return location for a #GError, or %NULL * * Returns all keys for the group name @group_name. The array of @@ -1014,8 +1502,8 @@ g_key_file_to_data (GKeyFile *key_file, * be found, %NULL is returned and @error is set to * #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. * - * Return value: a newly-allocated %NULL-terminated array of - * strings. Use g_strfreev() to free it. + * Returns: (array zero-terminated=1) (transfer full): a newly-allocated %NULL-terminated array of strings. + * Use g_strfreev() to free it. * * Since: 2.6 **/ @@ -1055,7 +1543,7 @@ g_key_file_get_keys (GKeyFile *key_file, num_keys++; } - keys = g_new0 (gchar *, num_keys + 1); + keys = g_new (gchar *, num_keys + 1); i = num_keys - 1; for (tmp = group->key_value_pairs; tmp; tmp = tmp->next) @@ -1085,7 +1573,7 @@ g_key_file_get_keys (GKeyFile *key_file, * * Returns the name of the start group of the file. * - * Return value: The start group of the key file. + * Returns: The start group of the key file. * * Since: 2.6 **/ @@ -1103,13 +1591,13 @@ g_key_file_get_start_group (GKeyFile *key_file) /** * g_key_file_get_groups: * @key_file: a #GKeyFile - * @length: return location for the number of returned groups, or %NULL + * @length: (out) (allow-none): return location for the number of returned groups, or %NULL * - * Returns all groups in the key file loaded with @key_file. The - * array of returned groups will be %NULL-terminated, so @length may - * optionally be %NULL. + * Returns all groups in the key file loaded with @key_file. + * The array of returned groups will be %NULL-terminated, so + * @length may optionally be %NULL. * - * Return value: a newly-allocated %NULL-terminated array of strings. + * Returns: (array zero-terminated=1) (transfer full): a newly-allocated %NULL-terminated array of strings. * Use g_strfreev() to free it. * Since: 2.6 **/ @@ -1125,18 +1613,19 @@ g_key_file_get_groups (GKeyFile *key_file, num_groups = g_list_length (key_file->groups); - g_assert (num_groups > 0); + g_return_val_if_fail (num_groups > 0, NULL); + + group_node = g_list_last (key_file->groups); + + g_return_val_if_fail (((GKeyFileGroup *) group_node->data)->name == NULL, NULL); /* Only need num_groups instead of num_groups + 1 * because the first group of the file (last in the * list) is always the comment group at the top, * which we skip */ - groups = g_new0 (gchar *, num_groups); + groups = g_new (gchar *, num_groups); - group_node = g_list_last (key_file->groups); - - g_assert (((GKeyFileGroup *) group_node->data)->name == NULL); i = 0; for (group_node = group_node->prev; @@ -1147,7 +1636,7 @@ g_key_file_get_groups (GKeyFile *key_file, group = (GKeyFileGroup *) group_node->data; - g_assert (group->name != NULL); + g_warn_if_fail (group->name != NULL); groups[i++] = g_strdup (group->name); } @@ -1166,14 +1655,16 @@ g_key_file_get_groups (GKeyFile *key_file, * @key: a key * @error: return location for a #GError, or %NULL * - * Returns the value associated with @key under @group_name. + * Returns the raw value associated with @key under @group_name. + * Use g_key_file_get_string() to retrieve an unescaped UTF-8 string. * * In the event the key cannot be found, %NULL is returned and * @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the * event that the @group_name cannot be found, %NULL is returned * and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. * - * Return value: a newly allocated string or %NULL if the specified + * + * Returns: a newly allocated string or %NULL if the specified * key cannot be found. * * Since: 2.6 @@ -1222,9 +1713,12 @@ g_key_file_get_value (GKeyFile *key_file, * @key: a key * @value: a string * - * Associates a new value with @key under @group_name. If @key - * cannot be found then it is created. If @group_name cannot be - * found then it is created. + * Associates a new value with @key under @group_name. + * + * If @key cannot be found then it is created. If @group_name cannot + * be found then it is created. To set an UTF-8 string which may contain + * characters that need escaping (such as newlines or spaces), use + * g_key_file_set_string(). * * Since: 2.6 **/ @@ -1272,14 +1766,16 @@ g_key_file_set_value (GKeyFile *key_file, * @key: a key * @error: return location for a #GError, or %NULL * - * Returns the value associated with @key under @group_name. + * Returns the string value associated with @key under @group_name. + * Unlike g_key_file_get_value(), this function handles escape sequences + * like \s. * * In the event the key cannot be found, %NULL is returned and * @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the * event that the @group_name cannot be found, %NULL is returned * and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. * - * Return value: a newly allocated string or %NULL if the specified + * Returns: a newly allocated string or %NULL if the specified * key cannot be found. * * Since: 2.6 @@ -1333,7 +1829,7 @@ g_key_file_get_string (GKeyFile *key_file, g_set_error (error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_INVALID_VALUE, _("Key file contains key '%s' " - "which has value that cannot be interpreted."), + "which has a value that cannot be interpreted."), key); g_error_free (key_file_error); } @@ -1351,9 +1847,11 @@ g_key_file_get_string (GKeyFile *key_file, * @key: a key * @string: a string * - * Associates a new string value with @key under @group_name. If - * @key cannot be found then it is created. If @group_name - * cannot be found then it is created. + * Associates a new string value with @key under @group_name. + * If @key cannot be found then it is created. + * If @group_name cannot be found then it is created. + * Unlike g_key_file_set_value(), this function handles characters + * that need escaping, such as newlines. * * Since: 2.6 **/ @@ -1378,7 +1876,7 @@ g_key_file_set_string (GKeyFile *key_file, * @key_file: a #GKeyFile * @group_name: a group name * @key: a key - * @length: return location for the number of returned strings, or %NULL + * @length: (out) (allow-none): return location for the number of returned strings, or %NULL * @error: return location for a #GError, or %NULL * * Returns the values associated with @key under @group_name. @@ -1388,8 +1886,9 @@ g_key_file_set_string (GKeyFile *key_file, * event that the @group_name cannot be found, %NULL is returned * and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. * - * Return value: a %NULL-terminated string array or %NULL if the specified - * key cannot be found. The array should be freed with g_strfreev(). + * Returns: (array zero-terminated=1 length=length) (element-type utf8) (transfer full): + * a %NULL-terminated string array or %NULL if the specified + * key cannot be found. The array should be freed with g_strfreev(). * * Since: 2.6 **/ @@ -1409,6 +1908,9 @@ g_key_file_get_string_list (GKeyFile *key_file, g_return_val_if_fail (group_name != NULL, NULL); g_return_val_if_fail (key != NULL, NULL); + if (length) + *length = 0; + value = g_key_file_get_value (key_file, group_name, key, &key_file_error); if (key_file_error) @@ -1443,16 +1945,19 @@ g_key_file_get_string_list (GKeyFile *key_file, g_set_error (error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_INVALID_VALUE, _("Key file contains key '%s' " - "which has value that cannot be interpreted."), + "which has a value that cannot be interpreted."), key); g_error_free (key_file_error); } else g_propagate_error (error, key_file_error); + + g_slist_free_full (pieces, g_free); + return NULL; } len = g_slist_length (pieces); - values = g_new0 (gchar *, len + 1); + values = g_new (gchar *, len + 1); for (p = pieces, i = 0; p; p = p->next) values[i++] = p->data; values[len] = NULL; @@ -1470,12 +1975,12 @@ g_key_file_get_string_list (GKeyFile *key_file, * @key_file: a #GKeyFile * @group_name: a group name * @key: a key - * @list: an array of locale string values - * @length: number of locale string values in @list + * @list: (array zero-terminated=1 length=length) (element-type utf8): an array of string values + * @length: number of string values in @list * * Associates a list of string values for @key under @group_name. - * If @key cannot be found then it is created. If @group_name - * cannot be found then it is created. + * If @key cannot be found then it is created. + * If @group_name cannot be found then it is created. * * Since: 2.6 **/ @@ -1490,7 +1995,7 @@ g_key_file_set_string_list (GKeyFile *key_file, gsize i; g_return_if_fail (key_file != NULL); - g_return_if_fail (list != NULL); + g_return_if_fail (list != NULL || length == 0); value_list = g_string_sized_new (length * 128); for (i = 0; i < length && list[i] != NULL; i++) @@ -1513,12 +2018,11 @@ g_key_file_set_string_list (GKeyFile *key_file, * @key_file: a #GKeyFile * @group_name: a group name * @key: a key - * @locale: a locale + * @locale: a locale identifier * @string: a string * - * Associates a string value for @key and @locale under - * @group_name. If the translation for @key cannot be found - * then it is created. + * Associates a string value for @key and @locale under @group_name. + * If the translation for @key cannot be found then it is created. * * Since: 2.6 **/ @@ -1543,26 +2047,24 @@ g_key_file_set_locale_string (GKeyFile *key_file, g_free (value); } -extern GSList *_g_compute_locale_variants (const gchar *locale); - /** * g_key_file_get_locale_string: * @key_file: a #GKeyFile * @group_name: a group name * @key: a key - * @locale: a locale or %NULL + * @locale: (allow-none): a locale identifier or %NULL * @error: return location for a #GError, or %NULL * * Returns the value associated with @key under @group_name * translated in the given @locale if available. If @locale is * %NULL then the current locale is assumed. * - * If @key cannot be found then %NULL is returned and @error is set to - * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the value associated + * If @key cannot be found then %NULL is returned and @error is set + * to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the value associated * with @key cannot be interpreted or no suitable translation can * be found then the untranslated value is returned. * - * Return value: a newly allocated string or %NULL if the specified + * Returns: a newly allocated string or %NULL if the specified * key cannot be found. * * Since: 2.6 @@ -1590,16 +2092,7 @@ g_key_file_get_locale_string (GKeyFile *key_file, if (locale) { - GSList *l, *list; - - list = _g_compute_locale_variants (locale); - - languages = g_new0 (gchar *, g_slist_length (list) + 1); - for (l = list, i = 0; l; l = l->next, i++) - languages[i] = l->data; - languages[i] = NULL; - - g_slist_free (list); + languages = g_get_locale_variants (locale); free_languages = TRUE; } else @@ -1641,26 +2134,27 @@ g_key_file_get_locale_string (GKeyFile *key_file, return translated_value; } -/** - * g_key_file_get_locale_string_list: +/** + * g_key_file_get_locale_string_list: * @key_file: a #GKeyFile * @group_name: a group name * @key: a key - * @locale: a locale - * @length: return location for the number of returned strings or %NULL + * @locale: (allow-none): a locale identifier or %NULL + * @length: (out) (allow-none): return location for the number of returned strings or %NULL * @error: return location for a #GError or %NULL * * Returns the values associated with @key under @group_name * translated in the given @locale if available. If @locale is * %NULL then the current locale is assumed. - * If @key cannot be found then %NULL is returned and @error is set to - * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the values associated + * If @key cannot be found then %NULL is returned and @error is set + * to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the values associated * with @key cannot be interpreted or no suitable translations - * can be found then the untranslated values are returned. - * The returned array is %NULL-terminated, so @length may optionally be %NULL. + * can be found then the untranslated values are returned. The + * returned array is %NULL-terminated, so @length may optionally + * be %NULL. * - * Return value: a newly allocated %NULL-terminated string array + * Returns: (array zero-terminated=1 length=length) (element-type utf8) (transfer full): a newly allocated %NULL-terminated string array * or %NULL if the key isn't found. The string array should be freed * with g_strfreev(). * @@ -1676,6 +2170,8 @@ g_key_file_get_locale_string_list (GKeyFile *key_file, { GError *key_file_error; gchar **values, *value; + char list_separator[2]; + gsize len; g_return_val_if_fail (key_file != NULL, NULL); g_return_val_if_fail (group_name != NULL, NULL); @@ -1691,12 +2187,19 @@ g_key_file_get_locale_string_list (GKeyFile *key_file, g_propagate_error (error, key_file_error); if (!value) - return NULL; + { + if (length) + *length = 0; + return NULL; + } - if (value[strlen (value) - 1] == ';') - value[strlen (value) - 1] = '\0'; + len = strlen (value); + if (value[len - 1] == key_file->list_separator) + value[len - 1] = '\0'; - values = g_strsplit (value, ";", 0); + list_separator[0] = key_file->list_separator; + list_separator[1] = '\0'; + values = g_strsplit (value, list_separator, 0); g_free (value); @@ -1711,8 +2214,8 @@ g_key_file_get_locale_string_list (GKeyFile *key_file, * @key_file: a #GKeyFile * @group_name: a group name * @key: a key - * @locale: a locale - * @list: a %NULL-terminated array of locale string values + * @locale: a locale identifier + * @list: (array zero-terminated=1 length=length): a %NULL-terminated array of locale string values * @length: the length of @list * * Associates a list of string values for @key and @locale under @@ -1744,9 +2247,8 @@ g_key_file_set_locale_string_list (GKeyFile *key_file, gchar *value; value = g_key_file_parse_string_as_value (key_file, list[i], TRUE); - g_string_append (value_list, value); - g_string_append_c (value_list, ';'); + g_string_append_c (value_list, key_file->list_separator); g_free (value); } @@ -1767,13 +2269,14 @@ g_key_file_set_locale_string_list (GKeyFile *key_file, * Returns the value associated with @key under @group_name as a * boolean. * - * If @key cannot be found then the return value is undefined and - * @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if - * the value associated with @key cannot be interpreted as a boolean - * then the return value is also undefined and @error is set to - * #G_KEY_FILE_ERROR_INVALID_VALUE. + * If @key cannot be found then %FALSE is returned and @error is set + * to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value + * associated with @key cannot be interpreted as a boolean then %FALSE + * is returned and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. + * + * Returns: the value associated with the key as a boolean, + * or %FALSE if the key was not found or could not be parsed. * - * Return value: the value associated with the key as a boolean * Since: 2.6 **/ gboolean @@ -1811,7 +2314,7 @@ g_key_file_get_boolean (GKeyFile *key_file, g_set_error (error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_INVALID_VALUE, _("Key file contains key '%s' " - "which has value that cannot be interpreted."), + "which has a value that cannot be interpreted."), key); g_error_free (key_file_error); } @@ -1854,19 +2357,21 @@ g_key_file_set_boolean (GKeyFile *key_file, * @key_file: a #GKeyFile * @group_name: a group name * @key: a key - * @length: the number of booleans returned + * @length: (out): the number of booleans returned * @error: return location for a #GError * * Returns the values associated with @key under @group_name as - * booleans. If @group_name is %NULL, the start_group is used. + * booleans. * - * If @key cannot be found then the return value is undefined and - * @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if - * the values associated with @key cannot be interpreted as booleans - * then the return value is also undefined and @error is set to - * #G_KEY_FILE_ERROR_INVALID_VALUE. + * If @key cannot be found then %NULL is returned and @error is set to + * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated + * with @key cannot be interpreted as booleans then %NULL is returned + * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. * - * Return value: the values associated with the key as a boolean + * Returns: (array length=length) (element-type gboolean) (transfer container): + * the values associated with the key as a list of booleans, or %NULL if the + * key was not found or could not be parsed. The returned list of booleans + * should be freed with g_free() when no longer needed. * * Since: 2.6 **/ @@ -1886,6 +2391,9 @@ g_key_file_get_boolean_list (GKeyFile *key_file, g_return_val_if_fail (group_name != NULL, NULL); g_return_val_if_fail (key != NULL, NULL); + if (length) + *length = 0; + key_file_error = NULL; values = g_key_file_get_string_list (key_file, group_name, key, @@ -1897,7 +2405,7 @@ g_key_file_get_boolean_list (GKeyFile *key_file, if (!values) return NULL; - bool_values = g_new0 (gboolean, num_bools); + bool_values = g_new (gboolean, num_bools); for (i = 0; i < num_bools; i++) { @@ -1927,11 +2435,11 @@ g_key_file_get_boolean_list (GKeyFile *key_file, * @key_file: a #GKeyFile * @group_name: a group name * @key: a key - * @list: an array of boolean values + * @list: (array length=length): an array of boolean values * @length: length of @list * - * Associates a list of boolean values with @key under - * @group_name. If @key cannot be found then it is created. + * Associates a list of boolean values with @key under @group_name. + * If @key cannot be found then it is created. * If @group_name is %NULL, the start_group is used. * * Since: 2.6 @@ -1974,15 +2482,15 @@ g_key_file_set_boolean_list (GKeyFile *key_file, * @error: return location for a #GError * * Returns the value associated with @key under @group_name as an - * integer. If @group_name is %NULL, the start_group is used. + * integer. * - * If @key cannot be found then the return value is undefined and - * @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if - * the value associated with @key cannot be interpreted as an integer - * then the return value is also undefined and @error is set to - * #G_KEY_FILE_ERROR_INVALID_VALUE. + * If @key cannot be found then 0 is returned and @error is set to + * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value associated + * with @key cannot be interpreted as an integer then 0 is returned + * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. * - * Return value: the value associated with the key as an integer. + * Returns: the value associated with the key as an integer, or + * 0 if the key was not found or could not be parsed. * * Since: 2.6 **/ @@ -1992,50 +2500,204 @@ g_key_file_get_integer (GKeyFile *key_file, const gchar *key, GError **error) { - GError *key_file_error; - gchar *value; - gint int_value; + GError *key_file_error; + gchar *value; + gint int_value; + + g_return_val_if_fail (key_file != NULL, -1); + g_return_val_if_fail (group_name != NULL, -1); + g_return_val_if_fail (key != NULL, -1); + + key_file_error = NULL; + + value = g_key_file_get_value (key_file, group_name, key, &key_file_error); + + if (key_file_error) + { + g_propagate_error (error, key_file_error); + return 0; + } + + int_value = g_key_file_parse_value_as_integer (key_file, value, + &key_file_error); + g_free (value); + + if (key_file_error) + { + if (g_error_matches (key_file_error, + G_KEY_FILE_ERROR, + G_KEY_FILE_ERROR_INVALID_VALUE)) + { + g_set_error (error, G_KEY_FILE_ERROR, + G_KEY_FILE_ERROR_INVALID_VALUE, + _("Key file contains key '%s' in group '%s' " + "which has a value that cannot be interpreted."), + key, group_name); + g_error_free (key_file_error); + } + else + g_propagate_error (error, key_file_error); + } + + return int_value; +} + +/** + * g_key_file_set_integer: + * @key_file: a #GKeyFile + * @group_name: a group name + * @key: a key + * @value: an integer value + * + * Associates a new integer value with @key under @group_name. + * If @key cannot be found then it is created. + * + * Since: 2.6 + **/ +void +g_key_file_set_integer (GKeyFile *key_file, + const gchar *group_name, + const gchar *key, + gint value) +{ + gchar *result; + + g_return_if_fail (key_file != NULL); + + result = g_key_file_parse_integer_as_value (key_file, value); + g_key_file_set_value (key_file, group_name, key, result); + g_free (result); +} + +/** + * g_key_file_get_int64: + * @key_file: a non-%NULL #GKeyFile + * @group_name: a non-%NULL group name + * @key: a non-%NULL key + * @error: return location for a #GError + * + * Returns the value associated with @key under @group_name as a signed + * 64-bit integer. This is similar to g_key_file_get_integer() but can return + * 64-bit results without truncation. + * + * Returns: the value associated with the key as a signed 64-bit integer, or + * 0 if the key was not found or could not be parsed. + * + * Since: 2.26 + */ +gint64 +g_key_file_get_int64 (GKeyFile *key_file, + const gchar *group_name, + const gchar *key, + GError **error) +{ + gchar *s, *end; + gint64 v; + + g_return_val_if_fail (key_file != NULL, -1); + g_return_val_if_fail (group_name != NULL, -1); + g_return_val_if_fail (key != NULL, -1); + + s = g_key_file_get_value (key_file, group_name, key, error); + + if (s == NULL) + return 0; + + v = g_ascii_strtoll (s, &end, 10); + + if (*s == '\0' || *end != '\0') + { + g_set_error (error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_INVALID_VALUE, + _("Key '%s' in group '%s' has value '%s' " + "where %s was expected"), + key, group_name, s, "int64"); + g_free (s); + return 0; + } + + g_free (s); + return v; +} + +/** + * g_key_file_set_int64: + * @key_file: a #GKeyFile + * @group_name: a group name + * @key: a key + * @value: an integer value + * + * Associates a new integer value with @key under @group_name. + * If @key cannot be found then it is created. + * + * Since: 2.26 + **/ +void +g_key_file_set_int64 (GKeyFile *key_file, + const gchar *group_name, + const gchar *key, + gint64 value) +{ + gchar *result; + + g_return_if_fail (key_file != NULL); + + result = g_strdup_printf ("%" G_GINT64_FORMAT, value); + g_key_file_set_value (key_file, group_name, key, result); + g_free (result); +} + +/** + * g_key_file_get_uint64: + * @key_file: a non-%NULL #GKeyFile + * @group_name: a non-%NULL group name + * @key: a non-%NULL key + * @error: return location for a #GError + * + * Returns the value associated with @key under @group_name as an unsigned + * 64-bit integer. This is similar to g_key_file_get_integer() but can return + * large positive results without truncation. + * + * Returns: the value associated with the key as an unsigned 64-bit integer, + * or 0 if the key was not found or could not be parsed. + * + * Since: 2.26 + */ +guint64 +g_key_file_get_uint64 (GKeyFile *key_file, + const gchar *group_name, + const gchar *key, + GError **error) +{ + gchar *s, *end; + guint64 v; g_return_val_if_fail (key_file != NULL, -1); g_return_val_if_fail (group_name != NULL, -1); g_return_val_if_fail (key != NULL, -1); - key_file_error = NULL; - - value = g_key_file_get_value (key_file, group_name, key, &key_file_error); + s = g_key_file_get_value (key_file, group_name, key, error); - if (key_file_error) - { - g_propagate_error (error, key_file_error); - return 0; - } + if (s == NULL) + return 0; - int_value = g_key_file_parse_value_as_integer (key_file, value, - &key_file_error); - g_free (value); + v = g_ascii_strtoull (s, &end, 10); - if (key_file_error) + if (*s == '\0' || *end != '\0') { - if (g_error_matches (key_file_error, - G_KEY_FILE_ERROR, - G_KEY_FILE_ERROR_INVALID_VALUE)) - { - g_set_error (error, G_KEY_FILE_ERROR, - G_KEY_FILE_ERROR_INVALID_VALUE, - _("Key file contains key '%s' in group '%s' " - "which has value that cannot be interpreted."), key, - group_name); - g_error_free (key_file_error); - } - else - g_propagate_error (error, key_file_error); + g_set_error (error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_INVALID_VALUE, + _("Key '%s' in group '%s' has value '%s' " + "where %s was expected"), + key, group_name, s, "uint64"); + g_free (s); + return 0; } - return int_value; + g_free (s); + return v; } /** - * g_key_file_set_integer: + * g_key_file_set_uint64: * @key_file: a #GKeyFile * @group_name: a group name * @key: a key @@ -2044,19 +2706,19 @@ g_key_file_get_integer (GKeyFile *key_file, * Associates a new integer value with @key under @group_name. * If @key cannot be found then it is created. * - * Since: 2.6 + * Since: 2.26 **/ void -g_key_file_set_integer (GKeyFile *key_file, - const gchar *group_name, - const gchar *key, - gint value) +g_key_file_set_uint64 (GKeyFile *key_file, + const gchar *group_name, + const gchar *key, + guint64 value) { gchar *result; g_return_if_fail (key_file != NULL); - result = g_key_file_parse_integer_as_value (key_file, value); + result = g_strdup_printf ("%" G_GUINT64_FORMAT, value); g_key_file_set_value (key_file, group_name, key, result); g_free (result); } @@ -2066,19 +2728,21 @@ g_key_file_set_integer (GKeyFile *key_file, * @key_file: a #GKeyFile * @group_name: a group name * @key: a key - * @length: the number of integers returned + * @length: (out): the number of integers returned * @error: return location for a #GError * * Returns the values associated with @key under @group_name as * integers. * - * If @key cannot be found then the return value is undefined and - * @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if - * the values associated with @key cannot be interpreted as integers - * then the return value is also undefined and @error is set to - * #G_KEY_FILE_ERROR_INVALID_VALUE. + * If @key cannot be found then %NULL is returned and @error is set to + * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated + * with @key cannot be interpreted as integers then %NULL is returned + * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. * - * Return value: the values associated with the key as a integer + * Returns: (array length=length) (element-type gint) (transfer container): + * the values associated with the key as a list of integers, or %NULL if + * the key was not found or could not be parsed. The returned list of + * integers should be freed with g_free() when no longer needed. * * Since: 2.6 **/ @@ -2098,6 +2762,9 @@ g_key_file_get_integer_list (GKeyFile *key_file, g_return_val_if_fail (group_name != NULL, NULL); g_return_val_if_fail (key != NULL, NULL); + if (length) + *length = 0; + values = g_key_file_get_string_list (key_file, group_name, key, &num_ints, &key_file_error); @@ -2107,7 +2774,7 @@ g_key_file_get_integer_list (GKeyFile *key_file, if (!values) return NULL; - int_values = g_new0 (gint, num_ints); + int_values = g_new (gint, num_ints); for (i = 0; i < num_ints; i++) { @@ -2137,20 +2804,20 @@ g_key_file_get_integer_list (GKeyFile *key_file, * @key_file: a #GKeyFile * @group_name: a group name * @key: a key - * @list: an array of integer values + * @list: (array length=length): an array of integer values * @length: number of integer values in @list * - * Associates a list of integer values with @key under - * @group_name. If @key cannot be found then it is created. + * Associates a list of integer values with @key under @group_name. + * If @key cannot be found then it is created. * * Since: 2.6 **/ void -g_key_file_set_integer_list (GKeyFile *key_file, - const gchar *group_name, - const gchar *key, - gint list[], - gsize length) +g_key_file_set_integer_list (GKeyFile *key_file, + const gchar *group_name, + const gchar *key, + gint list[], + gsize length) { GString *values; gsize i; @@ -2166,7 +2833,7 @@ g_key_file_set_integer_list (GKeyFile *key_file, value = g_key_file_parse_integer_as_value (key_file, list[i]); g_string_append (values, value); - g_string_append_c (values, ';'); + g_string_append_c (values, key_file->list_separator); g_free (value); } @@ -2182,16 +2849,16 @@ g_key_file_set_integer_list (GKeyFile *key_file, * @key: a key * @error: return location for a #GError * - * Returns the value associated with @key under @group_name as an - * integer. If @group_name is %NULL, the start_group is used. + * Returns the value associated with @key under @group_name as a + * double. If @group_name is %NULL, the start_group is used. * - * If @key cannot be found then the return value is undefined and - * @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if - * the value associated with @key cannot be interpreted as a double - * then the return value is also undefined and @error is set to - * #G_KEY_FILE_ERROR_INVALID_VALUE. + * If @key cannot be found then 0.0 is returned and @error is set to + * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value associated + * with @key cannot be interpreted as a double then 0.0 is returned + * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. * - * Return value: the value associated with the key as a double. + * Returns: the value associated with the key as a double, or + * 0.0 if the key was not found or could not be parsed. * * Since: 2.12 **/ @@ -2232,8 +2899,8 @@ g_key_file_get_double (GKeyFile *key_file, g_set_error (error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_INVALID_VALUE, _("Key file contains key '%s' in group '%s' " - "which has value that cannot be interpreted."), key, - group_name); + "which has a value that cannot be interpreted."), + key, group_name); g_error_free (key_file_error); } else @@ -2251,8 +2918,7 @@ g_key_file_get_double (GKeyFile *key_file, * @value: an double value * * Associates a new double value with @key under @group_name. - * If @key cannot be found then it is created. If @group_name - * is %NULL, the start group is used. + * If @key cannot be found then it is created. * * Since: 2.12 **/ @@ -2275,19 +2941,21 @@ g_key_file_set_double (GKeyFile *key_file, * @key_file: a #GKeyFile * @group_name: a group name * @key: a key - * @length: the number of doubles returned + * @length: (out): the number of doubles returned * @error: return location for a #GError * * Returns the values associated with @key under @group_name as - * doubles. If @group_name is %NULL, the start group is used. + * doubles. * - * If @key cannot be found then the return value is undefined and - * @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if - * the values associated with @key cannot be interpreted as doubles - * then the return value is also undefined and @error is set to - * #G_KEY_FILE_ERROR_INVALID_VALUE. + * If @key cannot be found then %NULL is returned and @error is set to + * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated + * with @key cannot be interpreted as doubles then %NULL is returned + * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. * - * Return value: the values associated with the key as a double + * Returns: (array length=length) (element-type gdouble) (transfer container): + * the values associated with the key as a list of doubles, or %NULL if the + * key was not found or could not be parsed. The returned list of doubles + * should be freed with g_free() when no longer needed. * * Since: 2.12 **/ @@ -2307,6 +2975,9 @@ g_key_file_get_double_list (GKeyFile *key_file, g_return_val_if_fail (group_name != NULL, NULL); g_return_val_if_fail (key != NULL, NULL); + if (length) + *length = 0; + values = g_key_file_get_string_list (key_file, group_name, key, &num_doubles, &key_file_error); @@ -2316,7 +2987,7 @@ g_key_file_get_double_list (GKeyFile *key_file, if (!values) return NULL; - double_values = g_new0 (gdouble, num_doubles); + double_values = g_new (gdouble, num_doubles); for (i = 0; i < num_doubles; i++) { @@ -2346,21 +3017,20 @@ g_key_file_get_double_list (GKeyFile *key_file, * @key_file: a #GKeyFile * @group_name: a group name * @key: a key - * @list: an array of double values + * @list: (array length=length): an array of double values * @length: number of double values in @list * * Associates a list of double values with @key under * @group_name. If @key cannot be found then it is created. - * If @group_name is %NULL the start group is used. * * Since: 2.12 **/ void -g_key_file_set_double_list (GKeyFile *key_file, - const gchar *group_name, - const gchar *key, - gdouble list[], - gsize length) +g_key_file_set_double_list (GKeyFile *key_file, + const gchar *group_name, + const gchar *key, + gdouble list[], + gsize length) { GString *values; gsize i; @@ -2376,19 +3046,19 @@ g_key_file_set_double_list (GKeyFile *key_file, g_ascii_dtostr( result, sizeof (result), list[i] ); g_string_append (values, result); - g_string_append_c (values, ';'); + g_string_append_c (values, key_file->list_separator); } g_key_file_set_value (key_file, group_name, key, values->str); g_string_free (values, TRUE); } -static void -g_key_file_set_key_comment (GKeyFile *key_file, - const gchar *group_name, - const gchar *key, - const gchar *comment, - GError **error) +static gboolean +g_key_file_set_key_comment (GKeyFile *key_file, + const gchar *group_name, + const gchar *key, + const gchar *comment, + GError **error) { GKeyFileGroup *group; GKeyFileKeyValuePair *pair; @@ -2402,7 +3072,7 @@ g_key_file_set_key_comment (GKeyFile *key_file, _("Key file does not have group '%s'"), group_name ? group_name : "(null)"); - return; + return FALSE; } /* First find the key the comments are supposed to be @@ -2416,7 +3086,7 @@ g_key_file_set_key_comment (GKeyFile *key_file, G_KEY_FILE_ERROR_KEY_NOT_FOUND, _("Key file does not have key '%s' in group '%s'"), key, group->name); - return; + return FALSE; } /* Then find all the comments already associated with the @@ -2425,8 +3095,6 @@ g_key_file_set_key_comment (GKeyFile *key_file, tmp = key_node->next; while (tmp != NULL) { - GKeyFileKeyValuePair *pair; - pair = (GKeyFileKeyValuePair *) tmp->data; if (pair->key != NULL) @@ -2439,27 +3107,28 @@ g_key_file_set_key_comment (GKeyFile *key_file, } if (comment == NULL) - return; + return TRUE; /* Now we can add our new comment */ - pair = g_new0 (GKeyFileKeyValuePair, 1); - + pair = g_slice_new (GKeyFileKeyValuePair); pair->key = NULL; pair->value = g_key_file_parse_comment_as_value (key_file, comment); key_node = g_list_insert (key_node, pair, 1); + + return TRUE; } -static void -g_key_file_set_group_comment (GKeyFile *key_file, - const gchar *group_name, - const gchar *comment, - GError **error) +static gboolean +g_key_file_set_group_comment (GKeyFile *key_file, + const gchar *group_name, + const gchar *comment, + GError **error) { GKeyFileGroup *group; - g_return_if_fail (g_key_file_is_group_name (group_name)); + g_return_val_if_fail (g_key_file_is_group_name (group_name), FALSE); group = g_key_file_lookup_group (key_file, group_name); if (!group) @@ -2469,7 +3138,7 @@ g_key_file_set_group_comment (GKeyFile *key_file, _("Key file does not have group '%s'"), group_name ? group_name : "(null)"); - return; + return FALSE; } /* First remove any existing comment @@ -2481,20 +3150,21 @@ g_key_file_set_group_comment (GKeyFile *key_file, } if (comment == NULL) - return; + return TRUE; /* Now we can add our new comment */ - group->comment = g_new0 (GKeyFileKeyValuePair, 1); - + group->comment = g_slice_new (GKeyFileKeyValuePair); group->comment->key = NULL; group->comment->value = g_key_file_parse_comment_as_value (key_file, comment); + + return TRUE; } -static void -g_key_file_set_top_comment (GKeyFile *key_file, - const gchar *comment, - GError **error) +static gboolean +g_key_file_set_top_comment (GKeyFile *key_file, + const gchar *comment, + GError **error) { GList *group_node; GKeyFileGroup *group; @@ -2503,76 +3173,80 @@ g_key_file_set_top_comment (GKeyFile *key_file, /* The last group in the list should be the top (comments only) * group in the file */ - g_assert (key_file->groups != NULL); + g_warn_if_fail (key_file->groups != NULL); group_node = g_list_last (key_file->groups); group = (GKeyFileGroup *) group_node->data; - g_assert (group->name == NULL); + g_warn_if_fail (group->name == NULL); /* Note all keys must be comments at the top of * the file, so we can just free it all. */ - if (group->key_value_pairs != NULL) - { - g_list_foreach (group->key_value_pairs, - (GFunc) g_key_file_key_value_pair_free, - NULL); - g_list_free (group->key_value_pairs); - group->key_value_pairs = NULL; - } + g_list_free_full (group->key_value_pairs, (GDestroyNotify) g_key_file_key_value_pair_free); + group->key_value_pairs = NULL; if (comment == NULL) - return; + return TRUE; - pair = g_new0 (GKeyFileKeyValuePair, 1); - + pair = g_slice_new (GKeyFileKeyValuePair); pair->key = NULL; pair->value = g_key_file_parse_comment_as_value (key_file, comment); group->key_value_pairs = g_list_prepend (group->key_value_pairs, pair); + + return TRUE; } /** * g_key_file_set_comment: * @key_file: a #GKeyFile - * @group_name: a group name, or %NULL - * @key: a key + * @group_name: (allow-none): a group name, or %NULL + * @key: (allow-none): a key * @comment: a comment * @error: return location for a #GError * * Places a comment above @key from @group_name. - * @group_name. If @key is %NULL then @comment will - * be written above @group_name. If both @key - * and @group_name are NULL, then @comment will - * be written above the first group in the file. + * If @key is %NULL then @comment will be written above @group_name. + * If both @key and @group_name are %NULL, then @comment will be + * written above the first group in the file. + * + * Returns: %TRUE if the comment was written, %FALSE otherwise * * Since: 2.6 **/ -void -g_key_file_set_comment (GKeyFile *key_file, - const gchar *group_name, - const gchar *key, - const gchar *comment, - GError **error) +gboolean +g_key_file_set_comment (GKeyFile *key_file, + const gchar *group_name, + const gchar *key, + const gchar *comment, + GError **error) { - g_return_if_fail (key_file != NULL); + g_return_val_if_fail (key_file != NULL, FALSE); - if (group_name != NULL && key != NULL) - g_key_file_set_key_comment (key_file, group_name, key, comment, error); - else if (group_name != NULL) - g_key_file_set_group_comment (key_file, group_name, comment, error); - else - g_key_file_set_top_comment (key_file, comment, error); + if (group_name != NULL && key != NULL) + { + if (!g_key_file_set_key_comment (key_file, group_name, key, comment, error)) + return FALSE; + } + else if (group_name != NULL) + { + if (!g_key_file_set_group_comment (key_file, group_name, comment, error)) + return FALSE; + } + else + { + if (!g_key_file_set_top_comment (key_file, comment, error)) + return FALSE; + } - if (comment != NULL) - key_file->approximate_size += strlen (comment); + return TRUE; } static gchar * -g_key_file_get_key_comment (GKeyFile *key_file, - const gchar *group_name, - const gchar *key, - GError **error) +g_key_file_get_key_comment (GKeyFile *key_file, + const gchar *group_name, + const gchar *key, + GError **error) { GKeyFileGroup *group; GKeyFileKeyValuePair *pair; @@ -2632,8 +3306,6 @@ g_key_file_get_key_comment (GKeyFile *key_file, while (tmp != key_node) { - GKeyFileKeyValuePair *pair; - pair = (GKeyFileKeyValuePair *) tmp->data; if (string == NULL) @@ -2710,15 +3382,15 @@ get_group_comment (GKeyFile *key_file, } static gchar * -g_key_file_get_group_comment (GKeyFile *key_file, - const gchar *group_name, - GError **error) +g_key_file_get_group_comment (GKeyFile *key_file, + const gchar *group_name, + GError **error) { GList *group_node; GKeyFileGroup *group; - group_node = g_key_file_lookup_group_node (key_file, group_name); - if (!group_node) + group = g_key_file_lookup_group (key_file, group_name); + if (!group) { g_set_error (error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_GROUP_NOT_FOUND, @@ -2728,18 +3400,18 @@ g_key_file_get_group_comment (GKeyFile *key_file, return NULL; } - group = (GKeyFileGroup *)group_node->data; if (group->comment) return g_strdup (group->comment->value); + group_node = g_key_file_lookup_group_node (key_file, group_name); group_node = group_node->next; group = (GKeyFileGroup *)group_node->data; return get_group_comment (key_file, group, error); } static gchar * -g_key_file_get_top_comment (GKeyFile *key_file, - GError **error) +g_key_file_get_top_comment (GKeyFile *key_file, + GError **error) { GList *group_node; GKeyFileGroup *group; @@ -2747,10 +3419,10 @@ g_key_file_get_top_comment (GKeyFile *key_file, /* The last group in the list should be the top (comments only) * group in the file */ - g_assert (key_file->groups != NULL); + g_warn_if_fail (key_file->groups != NULL); group_node = g_list_last (key_file->groups); group = (GKeyFileGroup *) group_node->data; - g_assert (group->name == NULL); + g_warn_if_fail (group->name == NULL); return get_group_comment (key_file, group, error); } @@ -2758,25 +3430,24 @@ g_key_file_get_top_comment (GKeyFile *key_file, /** * g_key_file_get_comment: * @key_file: a #GKeyFile - * @group_name: a group name, or %NULL + * @group_name: (allow-none): a group name, or %NULL * @key: a key * @error: return location for a #GError * * Retrieves a comment above @key from @group_name. - * @group_name. If @key is %NULL then @comment will - * be read from above @group_name. If both @key - * and @group_name are NULL, then @comment will - * be read from above the first group in the file. + * If @key is %NULL then @comment will be read from above + * @group_name. If both @key and @group_name are %NULL, then + * @comment will be read from above the first group in the file. * * Returns: a comment that should be freed with g_free() * * Since: 2.6 **/ gchar * -g_key_file_get_comment (GKeyFile *key_file, - const gchar *group_name, - const gchar *key, - GError **error) +g_key_file_get_comment (GKeyFile *key_file, + const gchar *group_name, + const gchar *key, + GError **error) { g_return_val_if_fail (key_file != NULL, NULL); @@ -2791,33 +3462,34 @@ g_key_file_get_comment (GKeyFile *key_file, /** * g_key_file_remove_comment: * @key_file: a #GKeyFile - * @group_name: a group name, or %NULL - * @key: a key + * @group_name: (allow-none): a group name, or %NULL + * @key: (allow-none): a key * @error: return location for a #GError * * Removes a comment above @key from @group_name. - * @group_name. If @key is %NULL then @comment will - * be written above @group_name. If both @key - * and @group_name are NULL, then @comment will - * be written above the first group in the file. + * If @key is %NULL then @comment will be removed above @group_name. + * If both @key and @group_name are %NULL, then @comment will + * be removed above the first group in the file. + * + * Returns: %TRUE if the comment was removed, %FALSE otherwise * * Since: 2.6 **/ -void -g_key_file_remove_comment (GKeyFile *key_file, - const gchar *group_name, - const gchar *key, - GError **error) +gboolean +g_key_file_remove_comment (GKeyFile *key_file, + const gchar *group_name, + const gchar *key, + GError **error) { - g_return_if_fail (key_file != NULL); + g_return_val_if_fail (key_file != NULL, FALSE); if (group_name != NULL && key != NULL) - g_key_file_set_key_comment (key_file, group_name, key, NULL, error); + return g_key_file_set_key_comment (key_file, group_name, key, NULL, error); else if (group_name != NULL) - g_key_file_set_group_comment (key_file, group_name, NULL, error); + return g_key_file_set_group_comment (key_file, group_name, NULL, error); else - g_key_file_set_top_comment (key_file, NULL, error); + return g_key_file_set_top_comment (key_file, NULL, error); } /** @@ -2827,7 +3499,7 @@ g_key_file_remove_comment (GKeyFile *key_file, * * Looks whether the key file has the group @group_name. * - * Return value: %TRUE if @group_name is a part of @key_file, %FALSE + * Returns: %TRUE if @group_name is a part of @key_file, %FALSE * otherwise. * Since: 2.6 **/ @@ -2838,29 +3510,18 @@ g_key_file_has_group (GKeyFile *key_file, g_return_val_if_fail (key_file != NULL, FALSE); g_return_val_if_fail (group_name != NULL, FALSE); - return g_key_file_lookup_group_node (key_file, group_name) != NULL; + return g_key_file_lookup_group (key_file, group_name) != NULL; } -/** - * g_key_file_has_key: - * @key_file: a #GKeyFile - * @group_name: a group name - * @key: a key name - * @error: return location for a #GError - * - * Looks whether the key file has the key @key in the group - * @group_name. - * - * Return value: %TRUE if @key is a part of @group_name, %FALSE - * otherwise. - * - * Since: 2.6 - **/ -gboolean -g_key_file_has_key (GKeyFile *key_file, - const gchar *group_name, - const gchar *key, - GError **error) +/* This code remains from a historical attempt to add a new public API + * which respects the GError rules. + */ +static gboolean +g_key_file_has_key_full (GKeyFile *key_file, + const gchar *group_name, + const gchar *key, + gboolean *has_key, + GError **error) { GKeyFileKeyValuePair *pair; GKeyFileGroup *group; @@ -2883,7 +3544,51 @@ g_key_file_has_key (GKeyFile *key_file, pair = g_key_file_lookup_key_value_pair (key_file, group, key); - return pair != NULL; + if (has_key) + *has_key = pair != NULL; + return TRUE; +} + +/** + * g_key_file_has_key: (skip) + * @key_file: a #GKeyFile + * @group_name: a group name + * @key: a key name + * @error: return location for a #GError + * + * Looks whether the key file has the key @key in the group + * @group_name. + * + * Note that this function does not follow the rules for #GError strictly; + * the return value both carries meaning and signals an error. To use + * this function, you must pass a #GError pointer in @error, and check + * whether it is not %NULL to see if an error occurred. + * + * Language bindings should use g_key_file_get_value() to test whether + * or not a key exists. + * + * Returns: %TRUE if @key is a part of @group_name, %FALSE otherwise + * + * Since: 2.6 + **/ +gboolean +g_key_file_has_key (GKeyFile *key_file, + const gchar *group_name, + const gchar *key, + GError **error) +{ + GError *temp_error = NULL; + gboolean has_key; + + if (g_key_file_has_key_full (key_file, group_name, key, &has_key, &temp_error)) + { + return has_key; + } + else + { + g_propagate_error (error, temp_error); + return FALSE; + } } static void @@ -2902,15 +3607,16 @@ g_key_file_add_group (GKeyFile *key_file, return; } - group = g_new0 (GKeyFileGroup, 1); + group = g_slice_new0 (GKeyFileGroup); group->name = g_strdup (group_name); group->lookup_map = g_hash_table_new (g_str_hash, g_str_equal); key_file->groups = g_list_prepend (key_file->groups, group); - key_file->approximate_size += strlen (group_name) + 3; key_file->current_group = group; if (key_file->start_group == NULL) key_file->start_group = group; + + g_hash_table_insert (key_file->group_hash, (gpointer)group->name, group); } static void @@ -2920,7 +3626,7 @@ g_key_file_key_value_pair_free (GKeyFileKeyValuePair *pair) { g_free (pair->key); g_free (pair->value); - g_free (pair); + g_slice_free (GKeyFileKeyValuePair, pair); } } @@ -2945,11 +3651,7 @@ g_key_file_remove_key_value_pair_node (GKeyFile *key_file, group->key_value_pairs = g_list_remove_link (group->key_value_pairs, pair_node); - if (pair->key != NULL) - key_file->approximate_size -= strlen (pair->key) + 1; - - g_assert (pair->value != NULL); - key_file->approximate_size -= strlen (pair->value); + g_warn_if_fail (pair->value != NULL); g_key_file_key_value_pair_free (pair); @@ -2965,6 +3667,9 @@ g_key_file_remove_group_node (GKeyFile *key_file, group = (GKeyFileGroup *) group_node->data; + if (group->name) + g_hash_table_remove (key_file->group_hash, group->name); + /* If the current group gets deleted make the current group the last * added group. */ @@ -3002,9 +3707,6 @@ g_key_file_remove_group_node (GKeyFile *key_file, key_file->groups = g_list_remove_link (key_file->groups, group_node); - if (group->name != NULL) - key_file->approximate_size -= strlen (group->name) + 3; - tmp = group->key_value_pairs; while (tmp != NULL) { @@ -3015,7 +3717,13 @@ g_key_file_remove_group_node (GKeyFile *key_file, g_key_file_remove_key_value_pair_node (key_file, group, pair_node); } - g_assert (group->key_value_pairs == NULL); + g_warn_if_fail (group->key_value_pairs == NULL); + + if (group->comment) + { + g_key_file_key_value_pair_free (group->comment); + group->comment = NULL; + } if (group->lookup_map) { @@ -3024,7 +3732,7 @@ g_key_file_remove_group_node (GKeyFile *key_file, } g_free ((gchar *) group->name); - g_free (group); + g_slice_free (GKeyFileGroup, group); g_list_free_1 (group_node); } @@ -3037,17 +3745,19 @@ g_key_file_remove_group_node (GKeyFile *key_file, * Removes the specified group, @group_name, * from the key file. * + * Returns: %TRUE if the group was removed, %FALSE otherwise + * * Since: 2.6 **/ -void +gboolean g_key_file_remove_group (GKeyFile *key_file, const gchar *group_name, GError **error) { GList *group_node; - g_return_if_fail (key_file != NULL); - g_return_if_fail (group_name != NULL); + g_return_val_if_fail (key_file != NULL, FALSE); + g_return_val_if_fail (group_name != NULL, FALSE); group_node = g_key_file_lookup_group_node (key_file, group_name); @@ -3057,10 +3767,21 @@ g_key_file_remove_group (GKeyFile *key_file, G_KEY_FILE_ERROR_GROUP_NOT_FOUND, _("Key file does not have group '%s'"), group_name); - return; + return FALSE; } - g_key_file_remove_group_node (key_file, group_node); + g_key_file_remove_group_node (key_file, group_node); + + return TRUE; +} + +static void +g_key_file_add_key_value_pair (GKeyFile *key_file, + GKeyFileGroup *group, + GKeyFileKeyValuePair *pair) +{ + g_hash_table_replace (group->lookup_map, pair->key, pair); + group->key_value_pairs = g_list_prepend (group->key_value_pairs, pair); } static void @@ -3071,14 +3792,11 @@ g_key_file_add_key (GKeyFile *key_file, { GKeyFileKeyValuePair *pair; - pair = g_new0 (GKeyFileKeyValuePair, 1); - + pair = g_slice_new (GKeyFileKeyValuePair); pair->key = g_strdup (key); pair->value = g_strdup (value); - g_hash_table_replace (group->lookup_map, pair->key, pair); - group->key_value_pairs = g_list_prepend (group->key_value_pairs, pair); - key_file->approximate_size += strlen (key) + strlen (value) + 2; + g_key_file_add_key_value_pair (key_file, group, pair); } /** @@ -3090,9 +3808,11 @@ g_key_file_add_key (GKeyFile *key_file, * * Removes @key in @group_name from the key file. * + * Returns: %TRUE if the key was removed, %FALSE otherwise + * * Since: 2.6 **/ -void +gboolean g_key_file_remove_key (GKeyFile *key_file, const gchar *group_name, const gchar *key, @@ -3101,9 +3821,9 @@ g_key_file_remove_key (GKeyFile *key_file, GKeyFileGroup *group; GKeyFileKeyValuePair *pair; - g_return_if_fail (key_file != NULL); - g_return_if_fail (group_name != NULL); - g_return_if_fail (key != NULL); + g_return_val_if_fail (key_file != NULL, FALSE); + g_return_val_if_fail (group_name != NULL, FALSE); + g_return_val_if_fail (key != NULL, FALSE); pair = NULL; @@ -3114,7 +3834,7 @@ g_key_file_remove_key (GKeyFile *key_file, G_KEY_FILE_ERROR_GROUP_NOT_FOUND, _("Key file does not have group '%s'"), group_name ? group_name : "(null)"); - return; + return FALSE; } pair = g_key_file_lookup_key_value_pair (key_file, group, key); @@ -3125,14 +3845,14 @@ g_key_file_remove_key (GKeyFile *key_file, G_KEY_FILE_ERROR_KEY_NOT_FOUND, _("Key file does not have key '%s' in group '%s'"), key, group->name); - return; + return FALSE; } - key_file->approximate_size -= strlen (pair->key) + strlen (pair->value) + 2; - group->key_value_pairs = g_list_remove (group->key_value_pairs, pair); - g_hash_table_remove (group->lookup_map, pair->key); + g_hash_table_remove (group->lookup_map, pair->key); g_key_file_key_value_pair_free (pair); + + return TRUE; } static GList * @@ -3157,14 +3877,7 @@ static GKeyFileGroup * g_key_file_lookup_group (GKeyFile *key_file, const gchar *group_name) { - GList *group_node; - - group_node = g_key_file_lookup_group_node (key_file, group_name); - - if (group_node != NULL) - return (GKeyFileGroup *) group_node->data; - - return NULL; + return (GKeyFileGroup *)g_hash_table_lookup (key_file->group_hash, group_name); } static GList * @@ -3217,7 +3930,7 @@ g_key_file_is_group_name (const gchar *name) p = q = (gchar *) name; while (*q && *q != ']' && *q != '[' && !g_ascii_iscntrl (*q)) - q = g_utf8_next_char (q); + q = g_utf8_find_next_char (q, NULL); if (*q != '\0' || q == p) return FALSE; @@ -3237,15 +3950,26 @@ g_key_file_is_key_name (const gchar *name) /* We accept a little more than the desktop entry spec says, * since gnome-vfs uses mime-types as keys in its cache. */ - while (*q && (g_unichar_isalnum (g_utf8_get_char (q)) || - *q == '-' || *q == '_' || *q == '/' || *q == '+' || *q == '.' || *q == '*')) - q = g_utf8_next_char (q); + while (*q && *q != '=' && *q != '[' && *q != ']') + q = g_utf8_find_next_char (q, NULL); + /* No empty keys, please */ + if (q == p) + return FALSE; + + /* We accept spaces in the middle of keys to not break + * existing apps, but we don't tolerate initial or final + * spaces, which would lead to silent corruption when + * rereading the file. + */ + if (*p == ' ' || q[-1] == ' ') + return FALSE; + if (*q == '[') { q++; - while (*q && (g_unichar_isalnum (g_utf8_get_char (q)) || *q == '-' || *q == '_' || *q == '.' || *q == '@')) - q = g_utf8_next_char (q); + while (*q && (g_unichar_isalnum (g_utf8_get_char_validated (q, -1)) || *q == '-' || *q == '_' || *q == '.' || *q == '@')) + q = g_utf8_find_next_char (q, NULL); if (*q != ']') return FALSE; @@ -3253,7 +3977,7 @@ g_key_file_is_key_name (const gchar *name) q++; } - if (*q != '\0' || q == p) + if (*q != '\0') return FALSE; return TRUE; @@ -3274,9 +3998,17 @@ g_key_file_line_is_group (const gchar *line) p++; while (*p && *p != ']') - p = g_utf8_next_char (p); + p = g_utf8_find_next_char (p, NULL); - if (!*p) + if (*p != ']') + return FALSE; + + /* silently accept whitespace after the ] */ + p = g_utf8_find_next_char (p, NULL); + while (*p == ' ' || *p == '\t') + p = g_utf8_find_next_char (p, NULL); + + if (*p) return FALSE; return TRUE; @@ -3308,7 +4040,7 @@ g_key_file_parse_value_as_string (GKeyFile *key_file, { gchar *string_value, *p, *q0, *q; - string_value = g_new0 (gchar, strlen (value) + 1); + string_value = g_new (gchar, strlen (value) + 1); p = (gchar *) value; q0 = q = string_value; @@ -3341,10 +4073,10 @@ g_key_file_parse_value_as_string (GKeyFile *key_file, break; case '\0': - g_set_error (error, G_KEY_FILE_ERROR, - G_KEY_FILE_ERROR_INVALID_VALUE, - _("Key file contains escape character " - "at end of line")); + g_set_error_literal (error, G_KEY_FILE_ERROR, + G_KEY_FILE_ERROR_INVALID_VALUE, + _("Key file contains escape character " + "at end of line")); break; default: @@ -3414,7 +4146,7 @@ g_key_file_parse_string_as_value (GKeyFile *key_file, /* Worst case would be that every character needs to be escaped. * In other words every character turns to two characters */ - value = g_new0 (gchar, 2 * length); + value = g_new (gchar, 2 * length); p = (gchar *) string; q = value; @@ -3495,14 +4227,14 @@ g_key_file_parse_value_as_integer (GKeyFile *key_file, const gchar *value, GError **error) { - gchar *end_of_valid_int; + gchar *eof_int; glong long_value; gint int_value; errno = 0; - long_value = strtol (value, &end_of_valid_int, 10); + long_value = strtol (value, &eof_int, 10); - if (*value == '\0' || *end_of_valid_int != '\0') + if (*value == '\0' || (*eof_int != '\0' && !g_ascii_isspace(*eof_int))) { gchar *value_utf8 = _g_utf8_make_valid (value); g_set_error (error, G_KEY_FILE_ERROR, @@ -3570,13 +4302,10 @@ g_key_file_parse_value_as_boolean (GKeyFile *key_file, { gchar *value_utf8; - if (value) - { - if (strcmp (value, "true") == 0 || strcmp (value, "1") == 0) - return TRUE; - else if (strcmp (value, "false") == 0 || strcmp (value, "0") == 0) - return FALSE; - } + if (strcmp (value, "true") == 0 || strcmp (value, "1") == 0) + return TRUE; + else if (strcmp (value, "false") == 0 || strcmp (value, "0") == 0) + return FALSE; value_utf8 = _g_utf8_make_valid (value); g_set_error (error, G_KEY_FILE_ERROR, @@ -3642,5 +4371,40 @@ g_key_file_parse_comment_as_value (GKeyFile *key_file, return g_string_free (string, FALSE); } -#define __G_KEY_FILE_C__ -#include "galiasdef.c" +/** + * g_key_file_save_to_file: + * @key_file: a #GKeyFile + * @filename: the name of the file to write to + * @error: a pointer to a %NULL #GError, or %NULL + * + * Writes the contents of @key_file to @filename using + * g_file_set_contents(). + * + * This function can fail for any of the reasons that + * g_file_set_contents() may fail. + * + * Returns: %TRUE if successful, else %FALSE with @error set + * + * Since: 2.40 + */ +gboolean +g_key_file_save_to_file (GKeyFile *key_file, + const gchar *filename, + GError **error) +{ + gchar *contents; + gboolean success; + gsize length; + + g_return_val_if_fail (key_file != NULL, FALSE); + g_return_val_if_fail (filename != NULL, FALSE); + g_return_val_if_fail (error == NULL || *error == NULL, FALSE); + + contents = g_key_file_to_data (key_file, &length, NULL); + g_assert (contents != NULL); + + success = g_file_set_contents (filename, contents, length, error); + g_free (contents); + + return success; +}