1 /* gkeyfile.c - key file parser
3 * Copyright 2004 Red Hat, Inc.
4 * Copyright 2009-2010 Collabora Ltd.
5 * Copyright 2009 Nokia Corporation
7 * Written by Ray Strode <rstrode@redhat.com>
8 * Matthias Clasen <mclasen@redhat.com>
10 * GLib is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU Lesser General Public License as
12 * published by the Free Software Foundation; either version 2 of the
13 * License, or (at your option) any later version.
15 * GLib is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with GLib; see the file COPYING.LIB. If not,
22 * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 * Boston, MA 02111-1307, USA.
37 #include <sys/types.h>
45 #define fstat(a,b) _fstati64(a,b)
49 #define S_ISREG(mode) ((mode)&_S_IFREG)
52 #endif /* G_OS_WIN23 */
57 #include "gfileutils.h"
63 #include "gmessages.h"
66 #include "gstrfuncs.h"
72 * @title: Key-value file parser
73 * @short_description: parses .ini-like config files
75 * #GKeyFile lets you parse, edit or create files containing groups of
76 * key-value pairs, which we call <firstterm>key files</firstterm> for
77 * lack of a better name. Several freedesktop.org specifications use
78 * key files now, e.g the
79 * <ulink url="http://freedesktop.org/Standards/desktop-entry-spec">Desktop
80 * Entry Specification</ulink> and the
81 * <ulink url="http://freedesktop.org/Standards/icon-theme-spec">Icon
82 * Theme Specification</ulink>.
84 * The syntax of key files is described in detail in the
85 * <ulink url="http://freedesktop.org/Standards/desktop-entry-spec">Desktop
86 * Entry Specification</ulink>, here is a quick summary: Key files
87 * consists of groups of key-value pairs, interspersed with comments.
90 * # this is just an example
91 * # there can be comments before the first group
95 * Name=Key File Example\tthis value shows\nescaping
97 * # localized strings are stored in multiple key-value pairs
100 * Welcome[fr_FR]=Bonjour
102 * Welcome[be@latin]=Hello
106 * Numbers=2;20;-200;0
108 * Booleans=true;false;true;true
111 * Lines beginning with a '#' and blank lines are considered comments.
113 * Groups are started by a header line containing the group name enclosed
114 * in '[' and ']', and ended implicitly by the start of the next group or
115 * the end of the file. Each key-value pair must be contained in a group.
117 * Key-value pairs generally have the form <literal>key=value</literal>,
118 * with the exception of localized strings, which have the form
119 * <literal>key[locale]=value</literal>, with a locale identifier of the
120 * form <literal>lang_COUNTRY@MODIFIER</literal> where
121 * <literal>COUNTRY</literal> and <literal>MODIFIER</literal> are optional.
122 * Space before and after the '=' character are ignored. Newline, tab,
123 * carriage return and backslash characters in value are escaped as \n,
124 * \t, \r, and \\, respectively. To preserve leading spaces in values,
125 * these can also be escaped as \s.
127 * Key files can store strings (possibly with localized variants), integers,
128 * booleans and lists of these. Lists are separated by a separator character,
129 * typically ';' or ','. To use the list separator character in a value in
130 * a list, it has to be escaped by prefixing it with a backslash.
132 * This syntax is obviously inspired by the .ini files commonly met
133 * on Windows, but there are some important differences:
135 * <listitem>.ini files use the ';' character to begin comments,
136 * key files use the '#' character.</listitem>
137 * <listitem>Key files do not allow for ungrouped keys meaning only
138 * comments can precede the first group.</listitem>
139 * <listitem>Key files are always encoded in UTF-8.</listitem>
140 * <listitem>Key and Group names are case-sensitive. For example, a
141 * group called <literal>[GROUP]</literal> is a different from
142 * <literal>[group]</literal>.</listitem>
143 * <listitem>.ini files don't have a strongly typed boolean entry type,
144 * they only have GetProfileInt(). In key files, only
145 * <literal>true</literal> and <literal>false</literal> (in lower case)
146 * are allowed.</listitem>
149 * Note that in contrast to the
150 * <ulink url="http://freedesktop.org/Standards/desktop-entry-spec">Desktop
151 * Entry Specification</ulink>, groups in key files may contain the same
152 * key multiple times; the last entry wins. Key files may also contain
153 * multiple groups with the same name; they are merged together.
154 * Another difference is that keys and group names in key files are not
155 * restricted to ASCII characters.
161 * Error domain for key file parsing. Errors in this domain will
162 * be from the #GKeyFileError enumeration.
164 * See #GError for information on error domains.
169 * @G_KEY_FILE_ERROR_UNKNOWN_ENCODING: the text being parsed was in
170 * an unknown encoding
171 * @G_KEY_FILE_ERROR_PARSE: document was ill-formed
172 * @G_KEY_FILE_ERROR_NOT_FOUND: the file was not found
173 * @G_KEY_FILE_ERROR_KEY_NOT_FOUND: a requested key was not found
174 * @G_KEY_FILE_ERROR_GROUP_NOT_FOUND: a requested group was not found
175 * @G_KEY_FILE_ERROR_INVALID_VALUE: a value could not be parsed
177 * Error codes returned by key file parsing.
182 * @G_KEY_FILE_NONE: No flags, default behaviour
183 * @G_KEY_FILE_KEEP_COMMENTS: Use this flag if you plan to write the
184 * (possibly modified) contents of the key file back to a file;
185 * otherwise all comments will be lost when the key file is
187 * @G_KEY_FILE_KEEP_TRANSLATIONS: Use this flag if you plan to write the
188 * (possibly modified) contents of the key file back to a file;
189 * otherwise only the translations for the current language will be
192 * Flags which influence the parsing.
196 * G_KEY_FILE_DESKTOP_GROUP:
198 * The name of the main group of a desktop entry file, as defined in the
199 * <ulink url="http://freedesktop.org/Standards/desktop-entry-spec">Desktop
200 * Entry Specification</ulink>. Consult the specification for more
201 * details about the meanings of the keys below.
207 * G_KEY_FILE_DESKTOP_KEY_TYPE:
209 * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string
210 * giving the type of the desktop entry. Usually
211 * #G_KEY_FILE_DESKTOP_TYPE_APPLICATION,
212 * #G_KEY_FILE_DESKTOP_TYPE_LINK, or
213 * #G_KEY_FILE_DESKTOP_TYPE_DIRECTORY.
219 * G_KEY_FILE_DESKTOP_KEY_VERSION:
221 * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string
222 * giving the version of the Desktop Entry Specification used for
223 * the desktop entry file.
229 * G_KEY_FILE_DESKTOP_KEY_NAME:
231 * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized
232 * string giving the specific name of the desktop entry.
238 * G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME:
240 * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized
241 * string giving the generic name of the desktop entry.
247 * G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY:
249 * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean
250 * stating whether the desktop entry should be shown in menus.
256 * G_KEY_FILE_DESKTOP_KEY_COMMENT:
258 * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized
259 * string giving the tooltip for the desktop entry.
265 * G_KEY_FILE_DESKTOP_KEY_ICON:
267 * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized
268 * string giving the name of the icon to be displayed for the desktop
275 * G_KEY_FILE_DESKTOP_KEY_HIDDEN:
277 * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean
278 * stating whether the desktop entry has been deleted by the user.
284 * G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN:
286 * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list of
287 * strings identifying the environments that should display the
294 * G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN:
296 * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list of
297 * strings identifying the environments that should not display the
304 * G_KEY_FILE_DESKTOP_KEY_TRY_EXEC:
306 * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string
307 * giving the file name of a binary on disk used to determine if the
308 * program is actually installed. It is only valid for desktop entries
309 * with the <literal>Application</literal> type.
315 * G_KEY_FILE_DESKTOP_KEY_EXEC:
317 * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string
318 * giving the command line to execute. It is only valid for desktop
319 * entries with the <literal>Application</literal> type.
325 * G_KEY_FILE_DESKTOP_KEY_PATH:
327 * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string
328 * containing the working directory to run the program in. It is only
329 * valid for desktop entries with the <literal>Application</literal> type.
335 * G_KEY_FILE_DESKTOP_KEY_TERMINAL:
337 * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean
338 * stating whether the program should be run in a terminal window.
339 * It is only valid for desktop entries with the
340 * <literal>Application</literal> type.
346 * G_KEY_FILE_DESKTOP_KEY_MIME_TYPE:
348 * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list
349 * of strings giving the MIME types supported by this desktop entry.
355 * G_KEY_FILE_DESKTOP_KEY_CATEGORIES:
357 * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list
358 * of strings giving the categories in which the desktop entry
359 * should be shown in a menu.
365 * G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY:
367 * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean
368 * stating whether the application supports the <ulink
369 * url="http://www.freedesktop.org/Standards/startup-notification-spec">Startup
370 * Notification Protocol Specification</ulink>.
376 * G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS:
378 * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is string
379 * identifying the WM class or name hint of a window that the application
380 * will create, which can be used to emulate Startup Notification with
381 * older applications.
387 * G_KEY_FILE_DESKTOP_KEY_URL :
389 * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string
390 * giving the URL to access. It is only valid for desktop entries
391 * with the <literal>Link</literal> type.
397 * G_KEY_FILE_DESKTOP_TYPE_APPLICATION:
399 * The value of the #G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop
400 * entries representing applications.
406 * G_KEY_FILE_DESKTOP_TYPE_LINK:
408 * The value of the #G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop
409 * entries representing links to documents.
415 * G_KEY_FILE_DESKTOP_TYPE_DIRECTORY:
417 * The value of the #G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop
418 * entries representing directories.
423 typedef struct _GKeyFileGroup GKeyFileGroup
;
428 * The GKeyFile struct contains only private data
429 * and should not be accessed directly.
434 GHashTable
*group_hash
;
436 GKeyFileGroup
*start_group
;
437 GKeyFileGroup
*current_group
;
439 GString
*parse_buffer
; /* Holds up to one line of not-yet-parsed data */
441 gchar list_separator
;
447 volatile gint ref_count
;
450 typedef struct _GKeyFileKeyValuePair GKeyFileKeyValuePair
;
452 struct _GKeyFileGroup
454 const gchar
*name
; /* NULL for above first group (which will be comments) */
456 GKeyFileKeyValuePair
*comment
; /* Special comment that is stuck to the top of a group */
457 gboolean has_trailing_blank_line
;
459 GList
*key_value_pairs
;
461 /* Used in parallel with key_value_pairs for
462 * increased lookup performance
464 GHashTable
*lookup_map
;
467 struct _GKeyFileKeyValuePair
469 gchar
*key
; /* NULL for comments */
473 static gint
find_file_in_data_dirs (const gchar
*file
,
474 const gchar
**data_dirs
,
477 static gboolean
g_key_file_load_from_fd (GKeyFile
*key_file
,
481 static GList
*g_key_file_lookup_group_node (GKeyFile
*key_file
,
482 const gchar
*group_name
);
483 static GKeyFileGroup
*g_key_file_lookup_group (GKeyFile
*key_file
,
484 const gchar
*group_name
);
486 static GList
*g_key_file_lookup_key_value_pair_node (GKeyFile
*key_file
,
487 GKeyFileGroup
*group
,
489 static GKeyFileKeyValuePair
*g_key_file_lookup_key_value_pair (GKeyFile
*key_file
,
490 GKeyFileGroup
*group
,
493 static void g_key_file_remove_group_node (GKeyFile
*key_file
,
495 static void g_key_file_remove_key_value_pair_node (GKeyFile
*key_file
,
496 GKeyFileGroup
*group
,
499 static void g_key_file_add_key_value_pair (GKeyFile
*key_file
,
500 GKeyFileGroup
*group
,
501 GKeyFileKeyValuePair
*pair
);
502 static void g_key_file_add_key (GKeyFile
*key_file
,
503 GKeyFileGroup
*group
,
506 static void g_key_file_add_group (GKeyFile
*key_file
,
507 const gchar
*group_name
);
508 static gboolean
g_key_file_is_group_name (const gchar
*name
);
509 static gboolean
g_key_file_is_key_name (const gchar
*name
);
510 static void g_key_file_key_value_pair_free (GKeyFileKeyValuePair
*pair
);
511 static gboolean
g_key_file_line_is_comment (const gchar
*line
);
512 static gboolean
g_key_file_line_is_group (const gchar
*line
);
513 static gboolean
g_key_file_line_is_key_value_pair (const gchar
*line
);
514 static gchar
*g_key_file_parse_value_as_string (GKeyFile
*key_file
,
518 static gchar
*g_key_file_parse_string_as_value (GKeyFile
*key_file
,
520 gboolean escape_separator
);
521 static gint
g_key_file_parse_value_as_integer (GKeyFile
*key_file
,
524 static gchar
*g_key_file_parse_integer_as_value (GKeyFile
*key_file
,
526 static gdouble
g_key_file_parse_value_as_double (GKeyFile
*key_file
,
529 static gboolean
g_key_file_parse_value_as_boolean (GKeyFile
*key_file
,
532 static gchar
*g_key_file_parse_boolean_as_value (GKeyFile
*key_file
,
534 static gchar
*g_key_file_parse_value_as_comment (GKeyFile
*key_file
,
536 static gchar
*g_key_file_parse_comment_as_value (GKeyFile
*key_file
,
537 const gchar
*comment
);
538 static void g_key_file_parse_key_value_pair (GKeyFile
*key_file
,
542 static void g_key_file_parse_comment (GKeyFile
*key_file
,
546 static void g_key_file_parse_group (GKeyFile
*key_file
,
550 static gchar
*key_get_locale (const gchar
*key
);
551 static void g_key_file_parse_data (GKeyFile
*key_file
,
555 static void g_key_file_flush_parse_buffer (GKeyFile
*key_file
,
560 g_key_file_error_quark (void)
562 return g_quark_from_static_string ("g-key-file-error-quark");
566 g_key_file_init (GKeyFile
*key_file
)
568 key_file
->current_group
= g_slice_new0 (GKeyFileGroup
);
569 key_file
->groups
= g_list_prepend (NULL
, key_file
->current_group
);
570 key_file
->group_hash
= g_hash_table_new (g_str_hash
, g_str_equal
);
571 key_file
->start_group
= NULL
;
572 key_file
->parse_buffer
= g_string_sized_new (128);
573 key_file
->list_separator
= ';';
575 key_file
->locales
= g_strdupv ((gchar
**)g_get_language_names ());
579 g_key_file_clear (GKeyFile
*key_file
)
581 GList
*tmp
, *group_node
;
583 if (key_file
->locales
)
585 g_strfreev (key_file
->locales
);
586 key_file
->locales
= NULL
;
589 if (key_file
->parse_buffer
)
591 g_string_free (key_file
->parse_buffer
, TRUE
);
592 key_file
->parse_buffer
= NULL
;
595 tmp
= key_file
->groups
;
600 g_key_file_remove_group_node (key_file
, group_node
);
603 if (key_file
->group_hash
!= NULL
)
605 g_hash_table_destroy (key_file
->group_hash
);
606 key_file
->group_hash
= NULL
;
609 g_warn_if_fail (key_file
->groups
== NULL
);
616 * Creates a new empty #GKeyFile object. Use
617 * g_key_file_load_from_file(), g_key_file_load_from_data(),
618 * g_key_file_load_from_dirs() or g_key_file_load_from_data_dirs() to
619 * read an existing key file.
621 * Return value: (transfer full): an empty #GKeyFile.
626 g_key_file_new (void)
630 key_file
= g_slice_new0 (GKeyFile
);
631 key_file
->ref_count
= 1;
632 g_key_file_init (key_file
);
638 * g_key_file_set_list_separator:
639 * @key_file: a #GKeyFile
640 * @separator: the separator
642 * Sets the character which is used to separate
643 * values in lists. Typically ';' or ',' are used
644 * as separators. The default list separator is ';'.
649 g_key_file_set_list_separator (GKeyFile
*key_file
,
652 g_return_if_fail (key_file
!= NULL
);
654 key_file
->list_separator
= separator
;
658 /* Iterates through all the directories in *dirs trying to
659 * open file. When it successfully locates and opens a file it
660 * returns the file descriptor to the open file. It also
661 * outputs the absolute path of the file in output_file.
664 find_file_in_data_dirs (const gchar
*file
,
669 const gchar
**data_dirs
, *data_dir
;
681 while (data_dirs
&& (data_dir
= *data_dirs
) && fd
== -1)
683 gchar
*candidate_file
, *sub_dir
;
685 candidate_file
= (gchar
*) file
;
686 sub_dir
= g_strdup ("");
687 while (candidate_file
!= NULL
&& fd
== -1)
691 path
= g_build_filename (data_dir
, sub_dir
,
692 candidate_file
, NULL
);
694 fd
= g_open (path
, O_RDONLY
, 0);
702 candidate_file
= strchr (candidate_file
, '-');
704 if (candidate_file
== NULL
)
710 sub_dir
= g_strndup (file
, candidate_file
- file
- 1);
712 for (p
= sub_dir
; *p
!= '\0'; p
++)
715 *p
= G_DIR_SEPARATOR
;
724 g_set_error_literal (error
, G_KEY_FILE_ERROR
,
725 G_KEY_FILE_ERROR_NOT_FOUND
,
726 _("Valid key file could not be "
727 "found in search dirs"));
730 if (output_file
!= NULL
&& fd
> 0)
731 *output_file
= g_strdup (path
);
739 g_key_file_load_from_fd (GKeyFile
*key_file
,
744 GError
*key_file_error
= NULL
;
746 struct stat stat_buf
;
747 gchar read_buf
[4096];
748 gchar list_separator
;
750 if (fstat (fd
, &stat_buf
) < 0)
752 g_set_error_literal (error
, G_FILE_ERROR
,
753 g_file_error_from_errno (errno
),
758 if (!S_ISREG (stat_buf
.st_mode
))
760 g_set_error_literal (error
, G_KEY_FILE_ERROR
,
761 G_KEY_FILE_ERROR_PARSE
,
762 _("Not a regular file"));
766 list_separator
= key_file
->list_separator
;
767 g_key_file_clear (key_file
);
768 g_key_file_init (key_file
);
769 key_file
->list_separator
= list_separator
;
770 key_file
->flags
= flags
;
774 bytes_read
= read (fd
, read_buf
, 4096);
776 if (bytes_read
== 0) /* End of File */
781 if (errno
== EINTR
|| errno
== EAGAIN
)
784 g_set_error_literal (error
, G_FILE_ERROR
,
785 g_file_error_from_errno (errno
),
790 g_key_file_parse_data (key_file
,
791 read_buf
, bytes_read
,
794 while (!key_file_error
);
798 g_propagate_error (error
, key_file_error
);
802 g_key_file_flush_parse_buffer (key_file
, &key_file_error
);
806 g_propagate_error (error
, key_file_error
);
814 * g_key_file_load_from_file:
815 * @key_file: an empty #GKeyFile struct
816 * @file: (type filename): the path of a filename to load, in the GLib filename encoding
817 * @flags: flags from #GKeyFileFlags
818 * @error: return location for a #GError, or %NULL
820 * Loads a key file into an empty #GKeyFile structure.
821 * If the file could not be loaded then %error is set to
822 * either a #GFileError or #GKeyFileError.
824 * Return value: %TRUE if a key file could be loaded, %FALSE otherwise
829 g_key_file_load_from_file (GKeyFile
*key_file
,
834 GError
*key_file_error
= NULL
;
837 g_return_val_if_fail (key_file
!= NULL
, FALSE
);
838 g_return_val_if_fail (file
!= NULL
, FALSE
);
840 fd
= g_open (file
, O_RDONLY
, 0);
844 g_set_error_literal (error
, G_FILE_ERROR
,
845 g_file_error_from_errno (errno
),
850 g_key_file_load_from_fd (key_file
, fd
, flags
, &key_file_error
);
855 g_propagate_error (error
, key_file_error
);
863 * g_key_file_load_from_data:
864 * @key_file: an empty #GKeyFile struct
865 * @data: (array length=length): key file loaded in memory
866 * @length: the length of @data in bytes
867 * @flags: flags from #GKeyFileFlags
868 * @error: return location for a #GError, or %NULL
870 * Loads a key file from memory into an empty #GKeyFile structure.
871 * If the object cannot be created then %error is set to a #GKeyFileError.
873 * Return value: %TRUE if a key file could be loaded, %FALSE otherwise
878 g_key_file_load_from_data (GKeyFile
*key_file
,
884 GError
*key_file_error
= NULL
;
885 gchar list_separator
;
887 g_return_val_if_fail (key_file
!= NULL
, FALSE
);
888 g_return_val_if_fail (data
!= NULL
, FALSE
);
889 g_return_val_if_fail (length
!= 0, FALSE
);
891 if (length
== (gsize
)-1)
892 length
= strlen (data
);
894 list_separator
= key_file
->list_separator
;
895 g_key_file_clear (key_file
);
896 g_key_file_init (key_file
);
897 key_file
->list_separator
= list_separator
;
898 key_file
->flags
= flags
;
900 g_key_file_parse_data (key_file
, data
, length
, &key_file_error
);
904 g_propagate_error (error
, key_file_error
);
908 g_key_file_flush_parse_buffer (key_file
, &key_file_error
);
912 g_propagate_error (error
, key_file_error
);
920 * g_key_file_load_from_dirs:
921 * @key_file: an empty #GKeyFile struct
922 * @file: (type filename): a relative path to a filename to open and parse
923 * @search_dirs: (array zero-terminated=1) (element-type filename): %NULL-terminated array of directories to search
924 * @full_path: (out) (type filename): return location for a string containing the full path
925 * of the file, or %NULL
926 * @flags: flags from #GKeyFileFlags
927 * @error: return location for a #GError, or %NULL
929 * This function looks for a key file named @file in the paths
930 * specified in @search_dirs, loads the file into @key_file and
931 * returns the file's full path in @full_path. If the file could not
932 * be loaded then an %error is set to either a #GFileError or
935 * Return value: %TRUE if a key file could be loaded, %FALSE otherwise
940 g_key_file_load_from_dirs (GKeyFile
*key_file
,
942 const gchar
**search_dirs
,
947 GError
*key_file_error
= NULL
;
948 const gchar
**data_dirs
;
953 g_return_val_if_fail (key_file
!= NULL
, FALSE
);
954 g_return_val_if_fail (!g_path_is_absolute (file
), FALSE
);
955 g_return_val_if_fail (search_dirs
!= NULL
, FALSE
);
958 data_dirs
= search_dirs
;
960 while (*data_dirs
!= NULL
&& !found_file
)
962 g_free (output_path
);
964 fd
= find_file_in_data_dirs (file
, data_dirs
, &output_path
,
970 g_propagate_error (error
, key_file_error
);
974 found_file
= g_key_file_load_from_fd (key_file
, fd
, flags
,
980 g_propagate_error (error
, key_file_error
);
985 if (found_file
&& full_path
)
986 *full_path
= output_path
;
988 g_free (output_path
);
994 * g_key_file_load_from_data_dirs:
995 * @key_file: an empty #GKeyFile struct
996 * @file: (type filename): a relative path to a filename to open and parse
997 * @full_path: (out) (type filename): return location for a string containing the full path
998 * of the file, or %NULL
999 * @flags: flags from #GKeyFileFlags
1000 * @error: return location for a #GError, or %NULL
1002 * This function looks for a key file named @file in the paths
1003 * returned from g_get_user_data_dir() and g_get_system_data_dirs(),
1004 * loads the file into @key_file and returns the file's full path in
1005 * @full_path. If the file could not be loaded then an %error is
1006 * set to either a #GFileError or #GKeyFileError.
1008 * Return value: %TRUE if a key file could be loaded, %FALSE othewise
1012 g_key_file_load_from_data_dirs (GKeyFile
*key_file
,
1015 GKeyFileFlags flags
,
1018 gchar
**all_data_dirs
;
1019 const gchar
* user_data_dir
;
1020 const gchar
* const * system_data_dirs
;
1022 gboolean found_file
;
1024 g_return_val_if_fail (key_file
!= NULL
, FALSE
);
1025 g_return_val_if_fail (!g_path_is_absolute (file
), FALSE
);
1027 user_data_dir
= g_get_user_data_dir ();
1028 system_data_dirs
= g_get_system_data_dirs ();
1029 all_data_dirs
= g_new (gchar
*, g_strv_length ((gchar
**)system_data_dirs
) + 2);
1032 all_data_dirs
[i
++] = g_strdup (user_data_dir
);
1035 while (system_data_dirs
[j
] != NULL
)
1036 all_data_dirs
[i
++] = g_strdup (system_data_dirs
[j
++]);
1037 all_data_dirs
[i
] = NULL
;
1039 found_file
= g_key_file_load_from_dirs (key_file
,
1041 (const gchar
**)all_data_dirs
,
1046 g_strfreev (all_data_dirs
);
1052 * g_key_file_ref: (skip)
1053 * @key_file: a #GKeyFile
1055 * Increases the reference count of @key_file.
1057 * Returns: the same @key_file.
1062 g_key_file_ref (GKeyFile
*key_file
)
1064 g_return_val_if_fail (key_file
!= NULL
, NULL
);
1066 g_atomic_int_inc (&key_file
->ref_count
);
1072 * g_key_file_free: (skip)
1073 * @key_file: a #GKeyFile
1075 * Clears all keys and groups from @key_file, and decreases the
1076 * reference count by 1. If the reference count reaches zero,
1077 * frees the key file and all its allocated memory.
1082 g_key_file_free (GKeyFile
*key_file
)
1084 g_return_if_fail (key_file
!= NULL
);
1086 g_key_file_clear (key_file
);
1087 g_key_file_unref (key_file
);
1092 * @key_file: a #GKeyFile
1094 * Decreases the reference count of @key_file by 1. If the reference count
1095 * reaches zero, frees the key file and all its allocated memory.
1100 g_key_file_unref (GKeyFile
*key_file
)
1102 g_return_if_fail (key_file
!= NULL
);
1104 if (g_atomic_int_dec_and_test (&key_file
->ref_count
))
1106 g_key_file_clear (key_file
);
1107 g_slice_free (GKeyFile
, key_file
);
1111 /* If G_KEY_FILE_KEEP_TRANSLATIONS is not set, only returns
1112 * true for locales that match those in g_get_language_names().
1115 g_key_file_locale_is_interesting (GKeyFile
*key_file
,
1116 const gchar
*locale
)
1120 if (key_file
->flags
& G_KEY_FILE_KEEP_TRANSLATIONS
)
1123 for (i
= 0; key_file
->locales
[i
] != NULL
; i
++)
1125 if (g_ascii_strcasecmp (key_file
->locales
[i
], locale
) == 0)
1133 g_key_file_parse_line (GKeyFile
*key_file
,
1138 GError
*parse_error
= NULL
;
1141 g_return_if_fail (key_file
!= NULL
);
1142 g_return_if_fail (line
!= NULL
);
1144 line_start
= (gchar
*) line
;
1145 while (g_ascii_isspace (*line_start
))
1148 if (g_key_file_line_is_comment (line_start
))
1149 g_key_file_parse_comment (key_file
, line
, length
, &parse_error
);
1150 else if (g_key_file_line_is_group (line_start
))
1151 g_key_file_parse_group (key_file
, line_start
,
1152 length
- (line_start
- line
),
1154 else if (g_key_file_line_is_key_value_pair (line_start
))
1155 g_key_file_parse_key_value_pair (key_file
, line_start
,
1156 length
- (line_start
- line
),
1160 gchar
*line_utf8
= _g_utf8_make_valid (line
);
1161 g_set_error (error
, G_KEY_FILE_ERROR
,
1162 G_KEY_FILE_ERROR_PARSE
,
1163 _("Key file contains line '%s' which is not "
1164 "a key-value pair, group, or comment"),
1172 g_propagate_error (error
, parse_error
);
1176 g_key_file_parse_comment (GKeyFile
*key_file
,
1181 GKeyFileKeyValuePair
*pair
;
1183 if (!(key_file
->flags
& G_KEY_FILE_KEEP_COMMENTS
))
1186 g_warn_if_fail (key_file
->current_group
!= NULL
);
1188 pair
= g_slice_new (GKeyFileKeyValuePair
);
1190 pair
->value
= g_strndup (line
, length
);
1192 key_file
->current_group
->key_value_pairs
=
1193 g_list_prepend (key_file
->current_group
->key_value_pairs
, pair
);
1195 if (length
== 0 || line
[0] != '#')
1196 key_file
->current_group
->has_trailing_blank_line
= TRUE
;
1200 g_key_file_parse_group (GKeyFile
*key_file
,
1206 const gchar
*group_name_start
, *group_name_end
;
1208 /* advance past opening '['
1210 group_name_start
= line
+ 1;
1211 group_name_end
= line
+ length
- 1;
1213 while (*group_name_end
!= ']')
1216 group_name
= g_strndup (group_name_start
,
1217 group_name_end
- group_name_start
);
1219 if (!g_key_file_is_group_name (group_name
))
1221 g_set_error (error
, G_KEY_FILE_ERROR
,
1222 G_KEY_FILE_ERROR_PARSE
,
1223 _("Invalid group name: %s"), group_name
);
1224 g_free (group_name
);
1228 g_key_file_add_group (key_file
, group_name
);
1229 g_free (group_name
);
1233 g_key_file_parse_key_value_pair (GKeyFile
*key_file
,
1238 gchar
*key
, *value
, *key_end
, *value_start
, *locale
;
1239 gsize key_len
, value_len
;
1241 if (key_file
->current_group
== NULL
|| key_file
->current_group
->name
== NULL
)
1243 g_set_error_literal (error
, G_KEY_FILE_ERROR
,
1244 G_KEY_FILE_ERROR_GROUP_NOT_FOUND
,
1245 _("Key file does not start with a group"));
1249 key_end
= value_start
= strchr (line
, '=');
1251 g_warn_if_fail (key_end
!= NULL
);
1256 /* Pull the key name from the line (chomping trailing whitespace)
1258 while (g_ascii_isspace (*key_end
))
1261 key_len
= key_end
- line
+ 2;
1263 g_warn_if_fail (key_len
<= length
);
1265 key
= g_strndup (line
, key_len
- 1);
1267 if (!g_key_file_is_key_name (key
))
1269 g_set_error (error
, G_KEY_FILE_ERROR
,
1270 G_KEY_FILE_ERROR_PARSE
,
1271 _("Invalid key name: %s"), key
);
1276 /* Pull the value from the line (chugging leading whitespace)
1278 while (g_ascii_isspace (*value_start
))
1281 value_len
= line
+ length
- value_start
+ 1;
1283 value
= g_strndup (value_start
, value_len
);
1285 g_warn_if_fail (key_file
->start_group
!= NULL
);
1287 if (key_file
->current_group
1288 && key_file
->current_group
->name
1289 && strcmp (key_file
->start_group
->name
,
1290 key_file
->current_group
->name
) == 0
1291 && strcmp (key
, "Encoding") == 0)
1293 if (g_ascii_strcasecmp (value
, "UTF-8") != 0)
1295 gchar
*value_utf8
= _g_utf8_make_valid (value
);
1296 g_set_error (error
, G_KEY_FILE_ERROR
,
1297 G_KEY_FILE_ERROR_UNKNOWN_ENCODING
,
1298 _("Key file contains unsupported "
1299 "encoding '%s'"), value_utf8
);
1300 g_free (value_utf8
);
1308 /* Is this key a translation? If so, is it one that we care about?
1310 locale
= key_get_locale (key
);
1312 if (locale
== NULL
|| g_key_file_locale_is_interesting (key_file
, locale
))
1314 GKeyFileKeyValuePair
*pair
;
1316 pair
= g_slice_new (GKeyFileKeyValuePair
);
1318 pair
->value
= value
;
1320 g_key_file_add_key_value_pair (key_file
, key_file
->current_group
, pair
);
1332 key_get_locale (const gchar
*key
)
1336 locale
= g_strrstr (key
, "[");
1338 if (locale
&& strlen (locale
) <= 2)
1342 locale
= g_strndup (locale
+ 1, strlen (locale
) - 2);
1348 g_key_file_parse_data (GKeyFile
*key_file
,
1353 GError
*parse_error
;
1356 g_return_if_fail (key_file
!= NULL
);
1357 g_return_if_fail (data
!= NULL
);
1364 if (data
[i
] == '\n')
1366 if (key_file
->parse_buffer
->len
> 0
1367 && (key_file
->parse_buffer
->str
[key_file
->parse_buffer
->len
- 1]
1369 g_string_erase (key_file
->parse_buffer
,
1370 key_file
->parse_buffer
->len
- 1,
1373 /* When a newline is encountered flush the parse buffer so that the
1374 * line can be parsed. Note that completely blank lines won't show
1375 * up in the parse buffer, so they get parsed directly.
1377 if (key_file
->parse_buffer
->len
> 0)
1378 g_key_file_flush_parse_buffer (key_file
, &parse_error
);
1380 g_key_file_parse_comment (key_file
, "", 1, &parse_error
);
1384 g_propagate_error (error
, parse_error
);
1391 const gchar
*start_of_line
;
1392 const gchar
*end_of_line
;
1395 start_of_line
= data
+ i
;
1396 end_of_line
= memchr (start_of_line
, '\n', length
- i
);
1398 if (end_of_line
== NULL
)
1399 end_of_line
= data
+ length
;
1401 line_length
= end_of_line
- start_of_line
;
1403 g_string_append_len (key_file
->parse_buffer
, start_of_line
, line_length
);
1410 g_key_file_flush_parse_buffer (GKeyFile
*key_file
,
1413 GError
*file_error
= NULL
;
1415 g_return_if_fail (key_file
!= NULL
);
1419 if (key_file
->parse_buffer
->len
> 0)
1421 g_key_file_parse_line (key_file
, key_file
->parse_buffer
->str
,
1422 key_file
->parse_buffer
->len
,
1424 g_string_erase (key_file
->parse_buffer
, 0, -1);
1428 g_propagate_error (error
, file_error
);
1435 * g_key_file_to_data:
1436 * @key_file: a #GKeyFile
1437 * @length: (out) (allow-none): return location for the length of the
1438 * returned string, or %NULL
1439 * @error: return location for a #GError, or %NULL
1441 * This function outputs @key_file as a string.
1443 * Note that this function never reports an error,
1444 * so it is safe to pass %NULL as @error.
1446 * Return value: a newly allocated string holding
1447 * the contents of the #GKeyFile
1452 g_key_file_to_data (GKeyFile
*key_file
,
1456 GString
*data_string
;
1457 GList
*group_node
, *key_file_node
;
1458 gboolean has_blank_line
= TRUE
;
1460 g_return_val_if_fail (key_file
!= NULL
, NULL
);
1462 data_string
= g_string_new (NULL
);
1464 for (group_node
= g_list_last (key_file
->groups
);
1466 group_node
= group_node
->prev
)
1468 GKeyFileGroup
*group
;
1470 group
= (GKeyFileGroup
*) group_node
->data
;
1472 /* separate groups by at least an empty line */
1473 if (!has_blank_line
)
1474 g_string_append_c (data_string
, '\n');
1475 has_blank_line
= group
->has_trailing_blank_line
;
1477 if (group
->comment
!= NULL
)
1478 g_string_append_printf (data_string
, "%s\n", group
->comment
->value
);
1480 if (group
->name
!= NULL
)
1481 g_string_append_printf (data_string
, "[%s]\n", group
->name
);
1483 for (key_file_node
= g_list_last (group
->key_value_pairs
);
1484 key_file_node
!= NULL
;
1485 key_file_node
= key_file_node
->prev
)
1487 GKeyFileKeyValuePair
*pair
;
1489 pair
= (GKeyFileKeyValuePair
*) key_file_node
->data
;
1491 if (pair
->key
!= NULL
)
1492 g_string_append_printf (data_string
, "%s=%s\n", pair
->key
, pair
->value
);
1494 g_string_append_printf (data_string
, "%s\n", pair
->value
);
1499 *length
= data_string
->len
;
1501 return g_string_free (data_string
, FALSE
);
1505 * g_key_file_get_keys:
1506 * @key_file: a #GKeyFile
1507 * @group_name: a group name
1508 * @length: (out): return location for the number of keys returned, or %NULL
1509 * @error: return location for a #GError, or %NULL
1511 * Returns all keys for the group name @group_name. The array of
1512 * returned keys will be %NULL-terminated, so @length may
1513 * optionally be %NULL. In the event that the @group_name cannot
1514 * be found, %NULL is returned and @error is set to
1515 * #G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
1517 * Return value: (array zero-terminated=1) (transfer full): a newly-allocated %NULL-terminated array of strings.
1518 * Use g_strfreev() to free it.
1523 g_key_file_get_keys (GKeyFile
*key_file
,
1524 const gchar
*group_name
,
1528 GKeyFileGroup
*group
;
1533 g_return_val_if_fail (key_file
!= NULL
, NULL
);
1534 g_return_val_if_fail (group_name
!= NULL
, NULL
);
1536 group
= g_key_file_lookup_group (key_file
, group_name
);
1540 g_set_error (error
, G_KEY_FILE_ERROR
,
1541 G_KEY_FILE_ERROR_GROUP_NOT_FOUND
,
1542 _("Key file does not have group '%s'"),
1543 group_name
? group_name
: "(null)");
1548 for (tmp
= group
->key_value_pairs
; tmp
; tmp
= tmp
->next
)
1550 GKeyFileKeyValuePair
*pair
;
1552 pair
= (GKeyFileKeyValuePair
*) tmp
->data
;
1558 keys
= g_new (gchar
*, num_keys
+ 1);
1561 for (tmp
= group
->key_value_pairs
; tmp
; tmp
= tmp
->next
)
1563 GKeyFileKeyValuePair
*pair
;
1565 pair
= (GKeyFileKeyValuePair
*) tmp
->data
;
1569 keys
[i
] = g_strdup (pair
->key
);
1574 keys
[num_keys
] = NULL
;
1583 * g_key_file_get_start_group:
1584 * @key_file: a #GKeyFile
1586 * Returns the name of the start group of the file.
1588 * Return value: The start group of the key file.
1593 g_key_file_get_start_group (GKeyFile
*key_file
)
1595 g_return_val_if_fail (key_file
!= NULL
, NULL
);
1597 if (key_file
->start_group
)
1598 return g_strdup (key_file
->start_group
->name
);
1604 * g_key_file_get_groups:
1605 * @key_file: a #GKeyFile
1606 * @length: (out) (allow-none): return location for the number of returned groups, or %NULL
1608 * Returns all groups in the key file loaded with @key_file.
1609 * The array of returned groups will be %NULL-terminated, so
1610 * @length may optionally be %NULL.
1612 * Return value: (array zero-terminated=1) (transfer full): a newly-allocated %NULL-terminated array of strings.
1613 * Use g_strfreev() to free it.
1617 g_key_file_get_groups (GKeyFile
*key_file
,
1622 gsize i
, num_groups
;
1624 g_return_val_if_fail (key_file
!= NULL
, NULL
);
1626 num_groups
= g_list_length (key_file
->groups
);
1628 g_return_val_if_fail (num_groups
> 0, NULL
);
1630 group_node
= g_list_last (key_file
->groups
);
1632 g_return_val_if_fail (((GKeyFileGroup
*) group_node
->data
)->name
== NULL
, NULL
);
1634 /* Only need num_groups instead of num_groups + 1
1635 * because the first group of the file (last in the
1636 * list) is always the comment group at the top,
1639 groups
= g_new (gchar
*, num_groups
);
1643 for (group_node
= group_node
->prev
;
1645 group_node
= group_node
->prev
)
1647 GKeyFileGroup
*group
;
1649 group
= (GKeyFileGroup
*) group_node
->data
;
1651 g_warn_if_fail (group
->name
!= NULL
);
1653 groups
[i
++] = g_strdup (group
->name
);
1664 * g_key_file_get_value:
1665 * @key_file: a #GKeyFile
1666 * @group_name: a group name
1668 * @error: return location for a #GError, or %NULL
1670 * Returns the raw value associated with @key under @group_name.
1671 * Use g_key_file_get_string() to retrieve an unescaped UTF-8 string.
1673 * In the event the key cannot be found, %NULL is returned and
1674 * @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the
1675 * event that the @group_name cannot be found, %NULL is returned
1676 * and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
1679 * Return value: a newly allocated string or %NULL if the specified
1680 * key cannot be found.
1685 g_key_file_get_value (GKeyFile
*key_file
,
1686 const gchar
*group_name
,
1690 GKeyFileGroup
*group
;
1691 GKeyFileKeyValuePair
*pair
;
1692 gchar
*value
= NULL
;
1694 g_return_val_if_fail (key_file
!= NULL
, NULL
);
1695 g_return_val_if_fail (group_name
!= NULL
, NULL
);
1696 g_return_val_if_fail (key
!= NULL
, NULL
);
1698 group
= g_key_file_lookup_group (key_file
, group_name
);
1702 g_set_error (error
, G_KEY_FILE_ERROR
,
1703 G_KEY_FILE_ERROR_GROUP_NOT_FOUND
,
1704 _("Key file does not have group '%s'"),
1705 group_name
? group_name
: "(null)");
1709 pair
= g_key_file_lookup_key_value_pair (key_file
, group
, key
);
1712 value
= g_strdup (pair
->value
);
1714 g_set_error (error
, G_KEY_FILE_ERROR
,
1715 G_KEY_FILE_ERROR_KEY_NOT_FOUND
,
1716 _("Key file does not have key '%s'"), key
);
1722 * g_key_file_set_value:
1723 * @key_file: a #GKeyFile
1724 * @group_name: a group name
1728 * Associates a new value with @key under @group_name.
1730 * If @key cannot be found then it is created. If @group_name cannot
1731 * be found then it is created. To set an UTF-8 string which may contain
1732 * characters that need escaping (such as newlines or spaces), use
1733 * g_key_file_set_string().
1738 g_key_file_set_value (GKeyFile
*key_file
,
1739 const gchar
*group_name
,
1743 GKeyFileGroup
*group
;
1744 GKeyFileKeyValuePair
*pair
;
1746 g_return_if_fail (key_file
!= NULL
);
1747 g_return_if_fail (g_key_file_is_group_name (group_name
));
1748 g_return_if_fail (g_key_file_is_key_name (key
));
1749 g_return_if_fail (value
!= NULL
);
1751 group
= g_key_file_lookup_group (key_file
, group_name
);
1755 g_key_file_add_group (key_file
, group_name
);
1756 group
= (GKeyFileGroup
*) key_file
->groups
->data
;
1758 g_key_file_add_key (key_file
, group
, key
, value
);
1762 pair
= g_key_file_lookup_key_value_pair (key_file
, group
, key
);
1765 g_key_file_add_key (key_file
, group
, key
, value
);
1768 g_free (pair
->value
);
1769 pair
->value
= g_strdup (value
);
1775 * g_key_file_get_string:
1776 * @key_file: a #GKeyFile
1777 * @group_name: a group name
1779 * @error: return location for a #GError, or %NULL
1781 * Returns the string value associated with @key under @group_name.
1782 * Unlike g_key_file_get_value(), this function handles escape sequences
1785 * In the event the key cannot be found, %NULL is returned and
1786 * @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the
1787 * event that the @group_name cannot be found, %NULL is returned
1788 * and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
1790 * Return value: a newly allocated string or %NULL if the specified
1791 * key cannot be found.
1796 g_key_file_get_string (GKeyFile
*key_file
,
1797 const gchar
*group_name
,
1801 gchar
*value
, *string_value
;
1802 GError
*key_file_error
;
1804 g_return_val_if_fail (key_file
!= NULL
, NULL
);
1805 g_return_val_if_fail (group_name
!= NULL
, NULL
);
1806 g_return_val_if_fail (key
!= NULL
, NULL
);
1808 key_file_error
= NULL
;
1810 value
= g_key_file_get_value (key_file
, group_name
, key
, &key_file_error
);
1814 g_propagate_error (error
, key_file_error
);
1818 if (!g_utf8_validate (value
, -1, NULL
))
1820 gchar
*value_utf8
= _g_utf8_make_valid (value
);
1821 g_set_error (error
, G_KEY_FILE_ERROR
,
1822 G_KEY_FILE_ERROR_UNKNOWN_ENCODING
,
1823 _("Key file contains key '%s' with value '%s' "
1824 "which is not UTF-8"), key
, value_utf8
);
1825 g_free (value_utf8
);
1831 string_value
= g_key_file_parse_value_as_string (key_file
, value
, NULL
,
1837 if (g_error_matches (key_file_error
,
1839 G_KEY_FILE_ERROR_INVALID_VALUE
))
1841 g_set_error (error
, G_KEY_FILE_ERROR
,
1842 G_KEY_FILE_ERROR_INVALID_VALUE
,
1843 _("Key file contains key '%s' "
1844 "which has a value that cannot be interpreted."),
1846 g_error_free (key_file_error
);
1849 g_propagate_error (error
, key_file_error
);
1852 return string_value
;
1856 * g_key_file_set_string:
1857 * @key_file: a #GKeyFile
1858 * @group_name: a group name
1862 * Associates a new string value with @key under @group_name.
1863 * If @key cannot be found then it is created.
1864 * If @group_name cannot be found then it is created.
1865 * Unlike g_key_file_set_value(), this function handles characters
1866 * that need escaping, such as newlines.
1871 g_key_file_set_string (GKeyFile
*key_file
,
1872 const gchar
*group_name
,
1874 const gchar
*string
)
1878 g_return_if_fail (key_file
!= NULL
);
1879 g_return_if_fail (string
!= NULL
);
1881 value
= g_key_file_parse_string_as_value (key_file
, string
, FALSE
);
1882 g_key_file_set_value (key_file
, group_name
, key
, value
);
1887 * g_key_file_get_string_list:
1888 * @key_file: a #GKeyFile
1889 * @group_name: a group name
1891 * @length: (out) (allow-none): return location for the number of returned strings, or %NULL
1892 * @error: return location for a #GError, or %NULL
1894 * Returns the values associated with @key under @group_name.
1896 * In the event the key cannot be found, %NULL is returned and
1897 * @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the
1898 * event that the @group_name cannot be found, %NULL is returned
1899 * and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
1901 * Return value: (array zero-terminated=1 length=length) (element-type utf8) (transfer full):
1902 * a %NULL-terminated string array or %NULL if the specified
1903 * key cannot be found. The array should be freed with g_strfreev().
1908 g_key_file_get_string_list (GKeyFile
*key_file
,
1909 const gchar
*group_name
,
1914 GError
*key_file_error
= NULL
;
1915 gchar
*value
, *string_value
, **values
;
1917 GSList
*p
, *pieces
= NULL
;
1919 g_return_val_if_fail (key_file
!= NULL
, NULL
);
1920 g_return_val_if_fail (group_name
!= NULL
, NULL
);
1921 g_return_val_if_fail (key
!= NULL
, NULL
);
1926 value
= g_key_file_get_value (key_file
, group_name
, key
, &key_file_error
);
1930 g_propagate_error (error
, key_file_error
);
1934 if (!g_utf8_validate (value
, -1, NULL
))
1936 gchar
*value_utf8
= _g_utf8_make_valid (value
);
1937 g_set_error (error
, G_KEY_FILE_ERROR
,
1938 G_KEY_FILE_ERROR_UNKNOWN_ENCODING
,
1939 _("Key file contains key '%s' with value '%s' "
1940 "which is not UTF-8"), key
, value_utf8
);
1941 g_free (value_utf8
);
1947 string_value
= g_key_file_parse_value_as_string (key_file
, value
, &pieces
, &key_file_error
);
1949 g_free (string_value
);
1953 if (g_error_matches (key_file_error
,
1955 G_KEY_FILE_ERROR_INVALID_VALUE
))
1957 g_set_error (error
, G_KEY_FILE_ERROR
,
1958 G_KEY_FILE_ERROR_INVALID_VALUE
,
1959 _("Key file contains key '%s' "
1960 "which has a value that cannot be interpreted."),
1962 g_error_free (key_file_error
);
1965 g_propagate_error (error
, key_file_error
);
1967 g_slist_free_full (pieces
, g_free
);
1971 len
= g_slist_length (pieces
);
1972 values
= g_new (gchar
*, len
+ 1);
1973 for (p
= pieces
, i
= 0; p
; p
= p
->next
)
1974 values
[i
++] = p
->data
;
1977 g_slist_free (pieces
);
1986 * g_key_file_set_string_list:
1987 * @key_file: a #GKeyFile
1988 * @group_name: a group name
1990 * @list: (array zero-terminated=1 length=length) (element-type utf8): an array of string values
1991 * @length: number of string values in @list
1993 * Associates a list of string values for @key under @group_name.
1994 * If @key cannot be found then it is created.
1995 * If @group_name cannot be found then it is created.
2000 g_key_file_set_string_list (GKeyFile
*key_file
,
2001 const gchar
*group_name
,
2003 const gchar
* const list
[],
2006 GString
*value_list
;
2009 g_return_if_fail (key_file
!= NULL
);
2010 g_return_if_fail (list
!= NULL
|| length
== 0);
2012 value_list
= g_string_sized_new (length
* 128);
2013 for (i
= 0; i
< length
&& list
[i
] != NULL
; i
++)
2017 value
= g_key_file_parse_string_as_value (key_file
, list
[i
], TRUE
);
2018 g_string_append (value_list
, value
);
2019 g_string_append_c (value_list
, key_file
->list_separator
);
2024 g_key_file_set_value (key_file
, group_name
, key
, value_list
->str
);
2025 g_string_free (value_list
, TRUE
);
2029 * g_key_file_set_locale_string:
2030 * @key_file: a #GKeyFile
2031 * @group_name: a group name
2033 * @locale: a locale identifier
2036 * Associates a string value for @key and @locale under @group_name.
2037 * If the translation for @key cannot be found then it is created.
2042 g_key_file_set_locale_string (GKeyFile
*key_file
,
2043 const gchar
*group_name
,
2045 const gchar
*locale
,
2046 const gchar
*string
)
2048 gchar
*full_key
, *value
;
2050 g_return_if_fail (key_file
!= NULL
);
2051 g_return_if_fail (key
!= NULL
);
2052 g_return_if_fail (locale
!= NULL
);
2053 g_return_if_fail (string
!= NULL
);
2055 value
= g_key_file_parse_string_as_value (key_file
, string
, FALSE
);
2056 full_key
= g_strdup_printf ("%s[%s]", key
, locale
);
2057 g_key_file_set_value (key_file
, group_name
, full_key
, value
);
2063 * g_key_file_get_locale_string:
2064 * @key_file: a #GKeyFile
2065 * @group_name: a group name
2067 * @locale: (allow-none): a locale identifier or %NULL
2068 * @error: return location for a #GError, or %NULL
2070 * Returns the value associated with @key under @group_name
2071 * translated in the given @locale if available. If @locale is
2072 * %NULL then the current locale is assumed.
2074 * If @key cannot be found then %NULL is returned and @error is set
2075 * to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the value associated
2076 * with @key cannot be interpreted or no suitable translation can
2077 * be found then the untranslated value is returned.
2079 * Return value: a newly allocated string or %NULL if the specified
2080 * key cannot be found.
2085 g_key_file_get_locale_string (GKeyFile
*key_file
,
2086 const gchar
*group_name
,
2088 const gchar
*locale
,
2091 gchar
*candidate_key
, *translated_value
;
2092 GError
*key_file_error
;
2094 gboolean free_languages
= FALSE
;
2097 g_return_val_if_fail (key_file
!= NULL
, NULL
);
2098 g_return_val_if_fail (group_name
!= NULL
, NULL
);
2099 g_return_val_if_fail (key
!= NULL
, NULL
);
2101 candidate_key
= NULL
;
2102 translated_value
= NULL
;
2103 key_file_error
= NULL
;
2107 languages
= g_get_locale_variants (locale
);
2108 free_languages
= TRUE
;
2112 languages
= (gchar
**) g_get_language_names ();
2113 free_languages
= FALSE
;
2116 for (i
= 0; languages
[i
]; i
++)
2118 candidate_key
= g_strdup_printf ("%s[%s]", key
, languages
[i
]);
2120 translated_value
= g_key_file_get_string (key_file
,
2122 candidate_key
, NULL
);
2123 g_free (candidate_key
);
2125 if (translated_value
)
2128 g_free (translated_value
);
2129 translated_value
= NULL
;
2132 /* Fallback to untranslated key
2134 if (!translated_value
)
2136 translated_value
= g_key_file_get_string (key_file
, group_name
, key
,
2139 if (!translated_value
)
2140 g_propagate_error (error
, key_file_error
);
2144 g_strfreev (languages
);
2146 return translated_value
;
2150 * g_key_file_get_locale_string_list:
2151 * @key_file: a #GKeyFile
2152 * @group_name: a group name
2154 * @locale: (allow-none): a locale identifier or %NULL
2155 * @length: (out) (allow-none): return location for the number of returned strings or %NULL
2156 * @error: return location for a #GError or %NULL
2158 * Returns the values associated with @key under @group_name
2159 * translated in the given @locale if available. If @locale is
2160 * %NULL then the current locale is assumed.
2162 * If @key cannot be found then %NULL is returned and @error is set
2163 * to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the values associated
2164 * with @key cannot be interpreted or no suitable translations
2165 * can be found then the untranslated values are returned. The
2166 * returned array is %NULL-terminated, so @length may optionally
2169 * Return value: (array zero-terminated=1 length=length) (element-type utf8) (transfer full): a newly allocated %NULL-terminated string array
2170 * or %NULL if the key isn't found. The string array should be freed
2171 * with g_strfreev().
2176 g_key_file_get_locale_string_list (GKeyFile
*key_file
,
2177 const gchar
*group_name
,
2179 const gchar
*locale
,
2183 GError
*key_file_error
;
2184 gchar
**values
, *value
;
2185 char list_separator
[2];
2188 g_return_val_if_fail (key_file
!= NULL
, NULL
);
2189 g_return_val_if_fail (group_name
!= NULL
, NULL
);
2190 g_return_val_if_fail (key
!= NULL
, NULL
);
2192 key_file_error
= NULL
;
2194 value
= g_key_file_get_locale_string (key_file
, group_name
,
2199 g_propagate_error (error
, key_file_error
);
2208 len
= strlen (value
);
2209 if (value
[len
- 1] == key_file
->list_separator
)
2210 value
[len
- 1] = '\0';
2212 list_separator
[0] = key_file
->list_separator
;
2213 list_separator
[1] = '\0';
2214 values
= g_strsplit (value
, list_separator
, 0);
2219 *length
= g_strv_length (values
);
2225 * g_key_file_set_locale_string_list:
2226 * @key_file: a #GKeyFile
2227 * @group_name: a group name
2229 * @locale: a locale identifier
2230 * @list: (array zero-terminated=1 length=length): a %NULL-terminated array of locale string values
2231 * @length: the length of @list
2233 * Associates a list of string values for @key and @locale under
2234 * @group_name. If the translation for @key cannot be found then
2240 g_key_file_set_locale_string_list (GKeyFile
*key_file
,
2241 const gchar
*group_name
,
2243 const gchar
*locale
,
2244 const gchar
* const list
[],
2247 GString
*value_list
;
2251 g_return_if_fail (key_file
!= NULL
);
2252 g_return_if_fail (key
!= NULL
);
2253 g_return_if_fail (locale
!= NULL
);
2254 g_return_if_fail (length
!= 0);
2256 value_list
= g_string_sized_new (length
* 128);
2257 for (i
= 0; i
< length
&& list
[i
] != NULL
; i
++)
2261 value
= g_key_file_parse_string_as_value (key_file
, list
[i
], TRUE
);
2262 g_string_append (value_list
, value
);
2263 g_string_append_c (value_list
, key_file
->list_separator
);
2268 full_key
= g_strdup_printf ("%s[%s]", key
, locale
);
2269 g_key_file_set_value (key_file
, group_name
, full_key
, value_list
->str
);
2271 g_string_free (value_list
, TRUE
);
2275 * g_key_file_get_boolean:
2276 * @key_file: a #GKeyFile
2277 * @group_name: a group name
2279 * @error: return location for a #GError
2281 * Returns the value associated with @key under @group_name as a
2284 * If @key cannot be found then %FALSE is returned and @error is set
2285 * to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value
2286 * associated with @key cannot be interpreted as a boolean then %FALSE
2287 * is returned and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
2289 * Return value: the value associated with the key as a boolean,
2290 * or %FALSE if the key was not found or could not be parsed.
2295 g_key_file_get_boolean (GKeyFile
*key_file
,
2296 const gchar
*group_name
,
2300 GError
*key_file_error
= NULL
;
2302 gboolean bool_value
;
2304 g_return_val_if_fail (key_file
!= NULL
, FALSE
);
2305 g_return_val_if_fail (group_name
!= NULL
, FALSE
);
2306 g_return_val_if_fail (key
!= NULL
, FALSE
);
2308 value
= g_key_file_get_value (key_file
, group_name
, key
, &key_file_error
);
2312 g_propagate_error (error
, key_file_error
);
2316 bool_value
= g_key_file_parse_value_as_boolean (key_file
, value
,
2322 if (g_error_matches (key_file_error
,
2324 G_KEY_FILE_ERROR_INVALID_VALUE
))
2326 g_set_error (error
, G_KEY_FILE_ERROR
,
2327 G_KEY_FILE_ERROR_INVALID_VALUE
,
2328 _("Key file contains key '%s' "
2329 "which has a value that cannot be interpreted."),
2331 g_error_free (key_file_error
);
2334 g_propagate_error (error
, key_file_error
);
2341 * g_key_file_set_boolean:
2342 * @key_file: a #GKeyFile
2343 * @group_name: a group name
2345 * @value: %TRUE or %FALSE
2347 * Associates a new boolean value with @key under @group_name.
2348 * If @key cannot be found then it is created.
2353 g_key_file_set_boolean (GKeyFile
*key_file
,
2354 const gchar
*group_name
,
2360 g_return_if_fail (key_file
!= NULL
);
2362 result
= g_key_file_parse_boolean_as_value (key_file
, value
);
2363 g_key_file_set_value (key_file
, group_name
, key
, result
);
2368 * g_key_file_get_boolean_list:
2369 * @key_file: a #GKeyFile
2370 * @group_name: a group name
2372 * @length: (out): the number of booleans returned
2373 * @error: return location for a #GError
2375 * Returns the values associated with @key under @group_name as
2378 * If @key cannot be found then %NULL is returned and @error is set to
2379 * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated
2380 * with @key cannot be interpreted as booleans then %NULL is returned
2381 * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
2383 * Return value: (array length=length) (element-type gboolean) (transfer container):
2384 * the values associated with the key as a list of booleans, or %NULL if the
2385 * key was not found or could not be parsed. The returned list of booleans
2386 * should be freed with g_free() when no longer needed.
2391 g_key_file_get_boolean_list (GKeyFile
*key_file
,
2392 const gchar
*group_name
,
2397 GError
*key_file_error
;
2399 gboolean
*bool_values
;
2402 g_return_val_if_fail (key_file
!= NULL
, NULL
);
2403 g_return_val_if_fail (group_name
!= NULL
, NULL
);
2404 g_return_val_if_fail (key
!= NULL
, NULL
);
2409 key_file_error
= NULL
;
2411 values
= g_key_file_get_string_list (key_file
, group_name
, key
,
2412 &num_bools
, &key_file_error
);
2415 g_propagate_error (error
, key_file_error
);
2420 bool_values
= g_new (gboolean
, num_bools
);
2422 for (i
= 0; i
< num_bools
; i
++)
2424 bool_values
[i
] = g_key_file_parse_value_as_boolean (key_file
,
2430 g_propagate_error (error
, key_file_error
);
2431 g_strfreev (values
);
2432 g_free (bool_values
);
2437 g_strfreev (values
);
2440 *length
= num_bools
;
2446 * g_key_file_set_boolean_list:
2447 * @key_file: a #GKeyFile
2448 * @group_name: a group name
2450 * @list: (array length=length): an array of boolean values
2451 * @length: length of @list
2453 * Associates a list of boolean values with @key under @group_name.
2454 * If @key cannot be found then it is created.
2455 * If @group_name is %NULL, the start_group is used.
2460 g_key_file_set_boolean_list (GKeyFile
*key_file
,
2461 const gchar
*group_name
,
2466 GString
*value_list
;
2469 g_return_if_fail (key_file
!= NULL
);
2470 g_return_if_fail (list
!= NULL
);
2472 value_list
= g_string_sized_new (length
* 8);
2473 for (i
= 0; i
< length
; i
++)
2477 value
= g_key_file_parse_boolean_as_value (key_file
, list
[i
]);
2479 g_string_append (value_list
, value
);
2480 g_string_append_c (value_list
, key_file
->list_separator
);
2485 g_key_file_set_value (key_file
, group_name
, key
, value_list
->str
);
2486 g_string_free (value_list
, TRUE
);
2490 * g_key_file_get_integer:
2491 * @key_file: a #GKeyFile
2492 * @group_name: a group name
2494 * @error: return location for a #GError
2496 * Returns the value associated with @key under @group_name as an
2499 * If @key cannot be found then 0 is returned and @error is set to
2500 * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value associated
2501 * with @key cannot be interpreted as an integer then 0 is returned
2502 * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
2504 * Return value: the value associated with the key as an integer, or
2505 * 0 if the key was not found or could not be parsed.
2510 g_key_file_get_integer (GKeyFile
*key_file
,
2511 const gchar
*group_name
,
2515 GError
*key_file_error
;
2519 g_return_val_if_fail (key_file
!= NULL
, -1);
2520 g_return_val_if_fail (group_name
!= NULL
, -1);
2521 g_return_val_if_fail (key
!= NULL
, -1);
2523 key_file_error
= NULL
;
2525 value
= g_key_file_get_value (key_file
, group_name
, key
, &key_file_error
);
2529 g_propagate_error (error
, key_file_error
);
2533 int_value
= g_key_file_parse_value_as_integer (key_file
, value
,
2539 if (g_error_matches (key_file_error
,
2541 G_KEY_FILE_ERROR_INVALID_VALUE
))
2543 g_set_error (error
, G_KEY_FILE_ERROR
,
2544 G_KEY_FILE_ERROR_INVALID_VALUE
,
2545 _("Key file contains key '%s' in group '%s' "
2546 "which has a value that cannot be interpreted."),
2548 g_error_free (key_file_error
);
2551 g_propagate_error (error
, key_file_error
);
2558 * g_key_file_set_integer:
2559 * @key_file: a #GKeyFile
2560 * @group_name: a group name
2562 * @value: an integer value
2564 * Associates a new integer value with @key under @group_name.
2565 * If @key cannot be found then it is created.
2570 g_key_file_set_integer (GKeyFile
*key_file
,
2571 const gchar
*group_name
,
2577 g_return_if_fail (key_file
!= NULL
);
2579 result
= g_key_file_parse_integer_as_value (key_file
, value
);
2580 g_key_file_set_value (key_file
, group_name
, key
, result
);
2585 * g_key_file_get_int64:
2586 * @key_file: a non-%NULL #GKeyFile
2587 * @group_name: a non-%NULL group name
2588 * @key: a non-%NULL key
2589 * @error: return location for a #GError
2591 * Returns the value associated with @key under @group_name as a signed
2592 * 64-bit integer. This is similar to g_key_file_get_integer() but can return
2593 * 64-bit results without truncation.
2595 * Returns: the value associated with the key as a signed 64-bit integer, or
2596 * 0 if the key was not found or could not be parsed.
2601 g_key_file_get_int64 (GKeyFile
*key_file
,
2602 const gchar
*group_name
,
2609 g_return_val_if_fail (key_file
!= NULL
, -1);
2610 g_return_val_if_fail (group_name
!= NULL
, -1);
2611 g_return_val_if_fail (key
!= NULL
, -1);
2613 s
= g_key_file_get_value (key_file
, group_name
, key
, error
);
2618 v
= g_ascii_strtoll (s
, &end
, 10);
2620 if (*s
== '\0' || *end
!= '\0')
2622 g_set_error (error
, G_KEY_FILE_ERROR
, G_KEY_FILE_ERROR_INVALID_VALUE
,
2623 _("Key '%s' in group '%s' has value '%s' "
2624 "where %s was expected"),
2625 key
, group_name
, s
, "int64");
2634 * g_key_file_set_int64:
2635 * @key_file: a #GKeyFile
2636 * @group_name: a group name
2638 * @value: an integer value
2640 * Associates a new integer value with @key under @group_name.
2641 * If @key cannot be found then it is created.
2646 g_key_file_set_int64 (GKeyFile
*key_file
,
2647 const gchar
*group_name
,
2653 g_return_if_fail (key_file
!= NULL
);
2655 result
= g_strdup_printf ("%" G_GINT64_FORMAT
, value
);
2656 g_key_file_set_value (key_file
, group_name
, key
, result
);
2661 * g_key_file_get_uint64:
2662 * @key_file: a non-%NULL #GKeyFile
2663 * @group_name: a non-%NULL group name
2664 * @key: a non-%NULL key
2665 * @error: return location for a #GError
2667 * Returns the value associated with @key under @group_name as an unsigned
2668 * 64-bit integer. This is similar to g_key_file_get_integer() but can return
2669 * large positive results without truncation.
2671 * Returns: the value associated with the key as an unsigned 64-bit integer,
2672 * or 0 if the key was not found or could not be parsed.
2677 g_key_file_get_uint64 (GKeyFile
*key_file
,
2678 const gchar
*group_name
,
2685 g_return_val_if_fail (key_file
!= NULL
, -1);
2686 g_return_val_if_fail (group_name
!= NULL
, -1);
2687 g_return_val_if_fail (key
!= NULL
, -1);
2689 s
= g_key_file_get_value (key_file
, group_name
, key
, error
);
2694 v
= g_ascii_strtoull (s
, &end
, 10);
2696 if (*s
== '\0' || *end
!= '\0')
2698 g_set_error (error
, G_KEY_FILE_ERROR
, G_KEY_FILE_ERROR_INVALID_VALUE
,
2699 _("Key '%s' in group '%s' has value '%s' "
2700 "where %s was expected"),
2701 key
, group_name
, s
, "uint64");
2710 * g_key_file_set_uint64:
2711 * @key_file: a #GKeyFile
2712 * @group_name: a group name
2714 * @value: an integer value
2716 * Associates a new integer value with @key under @group_name.
2717 * If @key cannot be found then it is created.
2722 g_key_file_set_uint64 (GKeyFile
*key_file
,
2723 const gchar
*group_name
,
2729 g_return_if_fail (key_file
!= NULL
);
2731 result
= g_strdup_printf ("%" G_GUINT64_FORMAT
, value
);
2732 g_key_file_set_value (key_file
, group_name
, key
, result
);
2737 * g_key_file_get_integer_list:
2738 * @key_file: a #GKeyFile
2739 * @group_name: a group name
2741 * @length: (out): the number of integers returned
2742 * @error: return location for a #GError
2744 * Returns the values associated with @key under @group_name as
2747 * If @key cannot be found then %NULL is returned and @error is set to
2748 * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated
2749 * with @key cannot be interpreted as integers then %NULL is returned
2750 * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
2752 * Return value: (array length=length) (element-type gint) (transfer container):
2753 * the values associated with the key as a list of integers, or %NULL if
2754 * the key was not found or could not be parsed. The returned list of
2755 * integers should be freed with g_free() when no longer needed.
2760 g_key_file_get_integer_list (GKeyFile
*key_file
,
2761 const gchar
*group_name
,
2766 GError
*key_file_error
= NULL
;
2771 g_return_val_if_fail (key_file
!= NULL
, NULL
);
2772 g_return_val_if_fail (group_name
!= NULL
, NULL
);
2773 g_return_val_if_fail (key
!= NULL
, NULL
);
2778 values
= g_key_file_get_string_list (key_file
, group_name
, key
,
2779 &num_ints
, &key_file_error
);
2782 g_propagate_error (error
, key_file_error
);
2787 int_values
= g_new (gint
, num_ints
);
2789 for (i
= 0; i
< num_ints
; i
++)
2791 int_values
[i
] = g_key_file_parse_value_as_integer (key_file
,
2797 g_propagate_error (error
, key_file_error
);
2798 g_strfreev (values
);
2799 g_free (int_values
);
2804 g_strfreev (values
);
2813 * g_key_file_set_integer_list:
2814 * @key_file: a #GKeyFile
2815 * @group_name: a group name
2817 * @list: (array length=length): an array of integer values
2818 * @length: number of integer values in @list
2820 * Associates a list of integer values with @key under @group_name.
2821 * If @key cannot be found then it is created.
2826 g_key_file_set_integer_list (GKeyFile
*key_file
,
2827 const gchar
*group_name
,
2835 g_return_if_fail (key_file
!= NULL
);
2836 g_return_if_fail (list
!= NULL
);
2838 values
= g_string_sized_new (length
* 16);
2839 for (i
= 0; i
< length
; i
++)
2843 value
= g_key_file_parse_integer_as_value (key_file
, list
[i
]);
2845 g_string_append (values
, value
);
2846 g_string_append_c (values
, key_file
->list_separator
);
2851 g_key_file_set_value (key_file
, group_name
, key
, values
->str
);
2852 g_string_free (values
, TRUE
);
2856 * g_key_file_get_double:
2857 * @key_file: a #GKeyFile
2858 * @group_name: a group name
2860 * @error: return location for a #GError
2862 * Returns the value associated with @key under @group_name as a
2863 * double. If @group_name is %NULL, the start_group is used.
2865 * If @key cannot be found then 0.0 is returned and @error is set to
2866 * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value associated
2867 * with @key cannot be interpreted as a double then 0.0 is returned
2868 * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
2870 * Return value: the value associated with the key as a double, or
2871 * 0.0 if the key was not found or could not be parsed.
2876 g_key_file_get_double (GKeyFile
*key_file
,
2877 const gchar
*group_name
,
2881 GError
*key_file_error
;
2883 gdouble double_value
;
2885 g_return_val_if_fail (key_file
!= NULL
, -1);
2886 g_return_val_if_fail (group_name
!= NULL
, -1);
2887 g_return_val_if_fail (key
!= NULL
, -1);
2889 key_file_error
= NULL
;
2891 value
= g_key_file_get_value (key_file
, group_name
, key
, &key_file_error
);
2895 g_propagate_error (error
, key_file_error
);
2899 double_value
= g_key_file_parse_value_as_double (key_file
, value
,
2905 if (g_error_matches (key_file_error
,
2907 G_KEY_FILE_ERROR_INVALID_VALUE
))
2909 g_set_error (error
, G_KEY_FILE_ERROR
,
2910 G_KEY_FILE_ERROR_INVALID_VALUE
,
2911 _("Key file contains key '%s' in group '%s' "
2912 "which has a value that cannot be interpreted."),
2914 g_error_free (key_file_error
);
2917 g_propagate_error (error
, key_file_error
);
2920 return double_value
;
2924 * g_key_file_set_double:
2925 * @key_file: a #GKeyFile
2926 * @group_name: a group name
2928 * @value: an double value
2930 * Associates a new double value with @key under @group_name.
2931 * If @key cannot be found then it is created.
2936 g_key_file_set_double (GKeyFile
*key_file
,
2937 const gchar
*group_name
,
2941 gchar result
[G_ASCII_DTOSTR_BUF_SIZE
];
2943 g_return_if_fail (key_file
!= NULL
);
2945 g_ascii_dtostr (result
, sizeof (result
), value
);
2946 g_key_file_set_value (key_file
, group_name
, key
, result
);
2950 * g_key_file_get_double_list:
2951 * @key_file: a #GKeyFile
2952 * @group_name: a group name
2954 * @length: (out): the number of doubles returned
2955 * @error: return location for a #GError
2957 * Returns the values associated with @key under @group_name as
2960 * If @key cannot be found then %NULL is returned and @error is set to
2961 * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated
2962 * with @key cannot be interpreted as doubles then %NULL is returned
2963 * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
2965 * Return value: (array length=length) (element-type gdouble) (transfer container):
2966 * the values associated with the key as a list of doubles, or %NULL if the
2967 * key was not found or could not be parsed. The returned list of doubles
2968 * should be freed with g_free() when no longer needed.
2973 g_key_file_get_double_list (GKeyFile
*key_file
,
2974 const gchar
*group_name
,
2979 GError
*key_file_error
= NULL
;
2981 gdouble
*double_values
;
2982 gsize i
, num_doubles
;
2984 g_return_val_if_fail (key_file
!= NULL
, NULL
);
2985 g_return_val_if_fail (group_name
!= NULL
, NULL
);
2986 g_return_val_if_fail (key
!= NULL
, NULL
);
2991 values
= g_key_file_get_string_list (key_file
, group_name
, key
,
2992 &num_doubles
, &key_file_error
);
2995 g_propagate_error (error
, key_file_error
);
3000 double_values
= g_new (gdouble
, num_doubles
);
3002 for (i
= 0; i
< num_doubles
; i
++)
3004 double_values
[i
] = g_key_file_parse_value_as_double (key_file
,
3010 g_propagate_error (error
, key_file_error
);
3011 g_strfreev (values
);
3012 g_free (double_values
);
3017 g_strfreev (values
);
3020 *length
= num_doubles
;
3022 return double_values
;
3026 * g_key_file_set_double_list:
3027 * @key_file: a #GKeyFile
3028 * @group_name: a group name
3030 * @list: (array length=length): an array of double values
3031 * @length: number of double values in @list
3033 * Associates a list of double values with @key under
3034 * @group_name. If @key cannot be found then it is created.
3039 g_key_file_set_double_list (GKeyFile
*key_file
,
3040 const gchar
*group_name
,
3048 g_return_if_fail (key_file
!= NULL
);
3049 g_return_if_fail (list
!= NULL
);
3051 values
= g_string_sized_new (length
* 16);
3052 for (i
= 0; i
< length
; i
++)
3054 gchar result
[G_ASCII_DTOSTR_BUF_SIZE
];
3056 g_ascii_dtostr( result
, sizeof (result
), list
[i
] );
3058 g_string_append (values
, result
);
3059 g_string_append_c (values
, key_file
->list_separator
);
3062 g_key_file_set_value (key_file
, group_name
, key
, values
->str
);
3063 g_string_free (values
, TRUE
);
3067 g_key_file_set_key_comment (GKeyFile
*key_file
,
3068 const gchar
*group_name
,
3070 const gchar
*comment
,
3073 GKeyFileGroup
*group
;
3074 GKeyFileKeyValuePair
*pair
;
3075 GList
*key_node
, *comment_node
, *tmp
;
3077 group
= g_key_file_lookup_group (key_file
, group_name
);
3080 g_set_error (error
, G_KEY_FILE_ERROR
,
3081 G_KEY_FILE_ERROR_GROUP_NOT_FOUND
,
3082 _("Key file does not have group '%s'"),
3083 group_name
? group_name
: "(null)");
3088 /* First find the key the comments are supposed to be
3091 key_node
= g_key_file_lookup_key_value_pair_node (key_file
, group
, key
);
3093 if (key_node
== NULL
)
3095 g_set_error (error
, G_KEY_FILE_ERROR
,
3096 G_KEY_FILE_ERROR_KEY_NOT_FOUND
,
3097 _("Key file does not have key '%s' in group '%s'"),
3102 /* Then find all the comments already associated with the
3105 tmp
= key_node
->next
;
3108 pair
= (GKeyFileKeyValuePair
*) tmp
->data
;
3110 if (pair
->key
!= NULL
)
3115 g_key_file_remove_key_value_pair_node (key_file
, group
,
3119 if (comment
== NULL
)
3122 /* Now we can add our new comment
3124 pair
= g_slice_new (GKeyFileKeyValuePair
);
3126 pair
->value
= g_key_file_parse_comment_as_value (key_file
, comment
);
3128 key_node
= g_list_insert (key_node
, pair
, 1);
3134 g_key_file_set_group_comment (GKeyFile
*key_file
,
3135 const gchar
*group_name
,
3136 const gchar
*comment
,
3139 GKeyFileGroup
*group
;
3141 g_return_val_if_fail (g_key_file_is_group_name (group_name
), FALSE
);
3143 group
= g_key_file_lookup_group (key_file
, group_name
);
3146 g_set_error (error
, G_KEY_FILE_ERROR
,
3147 G_KEY_FILE_ERROR_GROUP_NOT_FOUND
,
3148 _("Key file does not have group '%s'"),
3149 group_name
? group_name
: "(null)");
3154 /* First remove any existing comment
3158 g_key_file_key_value_pair_free (group
->comment
);
3159 group
->comment
= NULL
;
3162 if (comment
== NULL
)
3165 /* Now we can add our new comment
3167 group
->comment
= g_slice_new (GKeyFileKeyValuePair
);
3168 group
->comment
->key
= NULL
;
3169 group
->comment
->value
= g_key_file_parse_comment_as_value (key_file
, comment
);
3175 g_key_file_set_top_comment (GKeyFile
*key_file
,
3176 const gchar
*comment
,
3180 GKeyFileGroup
*group
;
3181 GKeyFileKeyValuePair
*pair
;
3183 /* The last group in the list should be the top (comments only)
3186 g_warn_if_fail (key_file
->groups
!= NULL
);
3187 group_node
= g_list_last (key_file
->groups
);
3188 group
= (GKeyFileGroup
*) group_node
->data
;
3189 g_warn_if_fail (group
->name
== NULL
);
3191 /* Note all keys must be comments at the top of
3192 * the file, so we can just free it all.
3194 g_list_free_full (group
->key_value_pairs
, (GDestroyNotify
) g_key_file_key_value_pair_free
);
3195 group
->key_value_pairs
= NULL
;
3197 if (comment
== NULL
)
3200 pair
= g_slice_new (GKeyFileKeyValuePair
);
3202 pair
->value
= g_key_file_parse_comment_as_value (key_file
, comment
);
3204 group
->key_value_pairs
=
3205 g_list_prepend (group
->key_value_pairs
, pair
);
3211 * g_key_file_set_comment:
3212 * @key_file: a #GKeyFile
3213 * @group_name: (allow-none): a group name, or %NULL
3214 * @key: (allow-none): a key
3215 * @comment: a comment
3216 * @error: return location for a #GError
3218 * Places a comment above @key from @group_name.
3219 * If @key is %NULL then @comment will be written above @group_name.
3220 * If both @key and @group_name are %NULL, then @comment will be
3221 * written above the first group in the file.
3223 * Returns: %TRUE if the comment was written, %FALSE otherwise
3228 g_key_file_set_comment (GKeyFile
*key_file
,
3229 const gchar
*group_name
,
3231 const gchar
*comment
,
3234 g_return_val_if_fail (key_file
!= NULL
, FALSE
);
3236 if (group_name
!= NULL
&& key
!= NULL
)
3238 if (!g_key_file_set_key_comment (key_file
, group_name
, key
, comment
, error
))
3241 else if (group_name
!= NULL
)
3243 if (!g_key_file_set_group_comment (key_file
, group_name
, comment
, error
))
3248 if (!g_key_file_set_top_comment (key_file
, comment
, error
))
3256 g_key_file_get_key_comment (GKeyFile
*key_file
,
3257 const gchar
*group_name
,
3261 GKeyFileGroup
*group
;
3262 GKeyFileKeyValuePair
*pair
;
3263 GList
*key_node
, *tmp
;
3267 g_return_val_if_fail (g_key_file_is_group_name (group_name
), NULL
);
3269 group
= g_key_file_lookup_group (key_file
, group_name
);
3272 g_set_error (error
, G_KEY_FILE_ERROR
,
3273 G_KEY_FILE_ERROR_GROUP_NOT_FOUND
,
3274 _("Key file does not have group '%s'"),
3275 group_name
? group_name
: "(null)");
3280 /* First find the key the comments are supposed to be
3283 key_node
= g_key_file_lookup_key_value_pair_node (key_file
, group
, key
);
3285 if (key_node
== NULL
)
3287 g_set_error (error
, G_KEY_FILE_ERROR
,
3288 G_KEY_FILE_ERROR_KEY_NOT_FOUND
,
3289 _("Key file does not have key '%s' in group '%s'"),
3296 /* Then find all the comments already associated with the
3297 * key and concatentate them.
3299 tmp
= key_node
->next
;
3300 if (!key_node
->next
)
3303 pair
= (GKeyFileKeyValuePair
*) tmp
->data
;
3304 if (pair
->key
!= NULL
)
3309 pair
= (GKeyFileKeyValuePair
*) tmp
->next
->data
;
3311 if (pair
->key
!= NULL
)
3317 while (tmp
!= key_node
)
3319 pair
= (GKeyFileKeyValuePair
*) tmp
->data
;
3322 string
= g_string_sized_new (512);
3324 comment
= g_key_file_parse_value_as_comment (key_file
, pair
->value
);
3325 g_string_append (string
, comment
);
3333 comment
= string
->str
;
3334 g_string_free (string
, FALSE
);
3343 get_group_comment (GKeyFile
*key_file
,
3344 GKeyFileGroup
*group
,
3353 tmp
= group
->key_value_pairs
;
3356 GKeyFileKeyValuePair
*pair
;
3358 pair
= (GKeyFileKeyValuePair
*) tmp
->data
;
3360 if (pair
->key
!= NULL
)
3366 if (tmp
->next
== NULL
)
3374 GKeyFileKeyValuePair
*pair
;
3376 pair
= (GKeyFileKeyValuePair
*) tmp
->data
;
3379 string
= g_string_sized_new (512);
3381 comment
= g_key_file_parse_value_as_comment (key_file
, pair
->value
);
3382 g_string_append (string
, comment
);
3389 return g_string_free (string
, FALSE
);
3395 g_key_file_get_group_comment (GKeyFile
*key_file
,
3396 const gchar
*group_name
,
3400 GKeyFileGroup
*group
;
3402 group
= g_key_file_lookup_group (key_file
, group_name
);
3405 g_set_error (error
, G_KEY_FILE_ERROR
,
3406 G_KEY_FILE_ERROR_GROUP_NOT_FOUND
,
3407 _("Key file does not have group '%s'"),
3408 group_name
? group_name
: "(null)");
3414 return g_strdup (group
->comment
->value
);
3416 group_node
= g_key_file_lookup_group_node (key_file
, group_name
);
3417 group_node
= group_node
->next
;
3418 group
= (GKeyFileGroup
*)group_node
->data
;
3419 return get_group_comment (key_file
, group
, error
);
3423 g_key_file_get_top_comment (GKeyFile
*key_file
,
3427 GKeyFileGroup
*group
;
3429 /* The last group in the list should be the top (comments only)
3432 g_warn_if_fail (key_file
->groups
!= NULL
);
3433 group_node
= g_list_last (key_file
->groups
);
3434 group
= (GKeyFileGroup
*) group_node
->data
;
3435 g_warn_if_fail (group
->name
== NULL
);
3437 return get_group_comment (key_file
, group
, error
);
3441 * g_key_file_get_comment:
3442 * @key_file: a #GKeyFile
3443 * @group_name: a group name, or %NULL
3445 * @error: return location for a #GError
3447 * Retrieves a comment above @key from @group_name.
3448 * If @key is %NULL then @comment will be read from above
3449 * @group_name. If both @key and @group_name are %NULL, then
3450 * @comment will be read from above the first group in the file.
3452 * Returns: a comment that should be freed with g_free()
3457 g_key_file_get_comment (GKeyFile
*key_file
,
3458 const gchar
*group_name
,
3462 g_return_val_if_fail (key_file
!= NULL
, NULL
);
3464 if (group_name
!= NULL
&& key
!= NULL
)
3465 return g_key_file_get_key_comment (key_file
, group_name
, key
, error
);
3466 else if (group_name
!= NULL
)
3467 return g_key_file_get_group_comment (key_file
, group_name
, error
);
3469 return g_key_file_get_top_comment (key_file
, error
);
3473 * g_key_file_remove_comment:
3474 * @key_file: a #GKeyFile
3475 * @group_name: (allow-none): a group name, or %NULL
3476 * @key: (allow-none): a key
3477 * @error: return location for a #GError
3479 * Removes a comment above @key from @group_name.
3480 * If @key is %NULL then @comment will be removed above @group_name.
3481 * If both @key and @group_name are %NULL, then @comment will
3482 * be removed above the first group in the file.
3484 * Returns: %TRUE if the comment was removed, %FALSE otherwise
3490 g_key_file_remove_comment (GKeyFile
*key_file
,
3491 const gchar
*group_name
,
3495 g_return_val_if_fail (key_file
!= NULL
, FALSE
);
3497 if (group_name
!= NULL
&& key
!= NULL
)
3498 return g_key_file_set_key_comment (key_file
, group_name
, key
, NULL
, error
);
3499 else if (group_name
!= NULL
)
3500 return g_key_file_set_group_comment (key_file
, group_name
, NULL
, error
);
3502 return g_key_file_set_top_comment (key_file
, NULL
, error
);
3506 * g_key_file_has_group:
3507 * @key_file: a #GKeyFile
3508 * @group_name: a group name
3510 * Looks whether the key file has the group @group_name.
3512 * Return value: %TRUE if @group_name is a part of @key_file, %FALSE
3517 g_key_file_has_group (GKeyFile
*key_file
,
3518 const gchar
*group_name
)
3520 g_return_val_if_fail (key_file
!= NULL
, FALSE
);
3521 g_return_val_if_fail (group_name
!= NULL
, FALSE
);
3523 return g_key_file_lookup_group (key_file
, group_name
) != NULL
;
3526 /* This code remains from a historical attempt to add a new public API
3527 * which respects the GError rules.
3530 g_key_file_has_key_full (GKeyFile
*key_file
,
3531 const gchar
*group_name
,
3536 GKeyFileKeyValuePair
*pair
;
3537 GKeyFileGroup
*group
;
3539 g_return_val_if_fail (key_file
!= NULL
, FALSE
);
3540 g_return_val_if_fail (group_name
!= NULL
, FALSE
);
3541 g_return_val_if_fail (key
!= NULL
, FALSE
);
3543 group
= g_key_file_lookup_group (key_file
, group_name
);
3547 g_set_error (error
, G_KEY_FILE_ERROR
,
3548 G_KEY_FILE_ERROR_GROUP_NOT_FOUND
,
3549 _("Key file does not have group '%s'"),
3550 group_name
? group_name
: "(null)");
3555 pair
= g_key_file_lookup_key_value_pair (key_file
, group
, key
);
3558 *has_key
= pair
!= NULL
;
3563 * g_key_file_has_key: (skip)
3564 * @key_file: a #GKeyFile
3565 * @group_name: a group name
3567 * @error: return location for a #GError
3569 * Looks whether the key file has the key @key in the group
3572 * <note>This function does not follow the rules for #GError strictly;
3573 * the return value both carries meaning and signals an error. To use
3574 * this function, you must pass a #GError pointer in @error, and check
3575 * whether it is not %NULL to see if an error occurred.</note>
3577 * Language bindings should use g_key_file_get_value() to test whether
3578 * or not a key exists.
3580 * Return value: %TRUE if @key is a part of @group_name, %FALSE
3586 g_key_file_has_key (GKeyFile
*key_file
,
3587 const gchar
*group_name
,
3591 GError
*temp_error
= NULL
;
3594 if (g_key_file_has_key_full (key_file
, group_name
, key
, &has_key
, &temp_error
))
3600 g_propagate_error (error
, temp_error
);
3606 g_key_file_add_group (GKeyFile
*key_file
,
3607 const gchar
*group_name
)
3609 GKeyFileGroup
*group
;
3611 g_return_if_fail (key_file
!= NULL
);
3612 g_return_if_fail (g_key_file_is_group_name (group_name
));
3614 group
= g_key_file_lookup_group (key_file
, group_name
);
3617 key_file
->current_group
= group
;
3621 group
= g_slice_new0 (GKeyFileGroup
);
3622 group
->name
= g_strdup (group_name
);
3623 group
->lookup_map
= g_hash_table_new (g_str_hash
, g_str_equal
);
3624 key_file
->groups
= g_list_prepend (key_file
->groups
, group
);
3625 key_file
->current_group
= group
;
3627 if (key_file
->start_group
== NULL
)
3628 key_file
->start_group
= group
;
3630 g_hash_table_insert (key_file
->group_hash
, (gpointer
)group
->name
, group
);
3634 g_key_file_key_value_pair_free (GKeyFileKeyValuePair
*pair
)
3639 g_free (pair
->value
);
3640 g_slice_free (GKeyFileKeyValuePair
, pair
);
3644 /* Be careful not to call this function on a node with data in the
3645 * lookup map without removing it from the lookup map, first.
3647 * Some current cases where this warning is not a concern are
3649 * - the node being removed is a comment node
3650 * - the entire lookup map is getting destroyed soon after
3654 g_key_file_remove_key_value_pair_node (GKeyFile
*key_file
,
3655 GKeyFileGroup
*group
,
3659 GKeyFileKeyValuePair
*pair
;
3661 pair
= (GKeyFileKeyValuePair
*) pair_node
->data
;
3663 group
->key_value_pairs
= g_list_remove_link (group
->key_value_pairs
, pair_node
);
3665 g_warn_if_fail (pair
->value
!= NULL
);
3667 g_key_file_key_value_pair_free (pair
);
3669 g_list_free_1 (pair_node
);
3673 g_key_file_remove_group_node (GKeyFile
*key_file
,
3676 GKeyFileGroup
*group
;
3679 group
= (GKeyFileGroup
*) group_node
->data
;
3682 g_hash_table_remove (key_file
->group_hash
, group
->name
);
3684 /* If the current group gets deleted make the current group the last
3687 if (key_file
->current_group
== group
)
3689 /* groups should always contain at least the top comment group,
3690 * unless g_key_file_clear has been called
3692 if (key_file
->groups
)
3693 key_file
->current_group
= (GKeyFileGroup
*) key_file
->groups
->data
;
3695 key_file
->current_group
= NULL
;
3698 /* If the start group gets deleted make the start group the first
3701 if (key_file
->start_group
== group
)
3703 tmp
= g_list_last (key_file
->groups
);
3706 if (tmp
!= group_node
&&
3707 ((GKeyFileGroup
*) tmp
->data
)->name
!= NULL
)
3714 key_file
->start_group
= (GKeyFileGroup
*) tmp
->data
;
3716 key_file
->start_group
= NULL
;
3719 key_file
->groups
= g_list_remove_link (key_file
->groups
, group_node
);
3721 tmp
= group
->key_value_pairs
;
3728 g_key_file_remove_key_value_pair_node (key_file
, group
, pair_node
);
3731 g_warn_if_fail (group
->key_value_pairs
== NULL
);
3735 g_key_file_key_value_pair_free (group
->comment
);
3736 group
->comment
= NULL
;
3739 if (group
->lookup_map
)
3741 g_hash_table_destroy (group
->lookup_map
);
3742 group
->lookup_map
= NULL
;
3745 g_free ((gchar
*) group
->name
);
3746 g_slice_free (GKeyFileGroup
, group
);
3747 g_list_free_1 (group_node
);
3751 * g_key_file_remove_group:
3752 * @key_file: a #GKeyFile
3753 * @group_name: a group name
3754 * @error: return location for a #GError or %NULL
3756 * Removes the specified group, @group_name,
3757 * from the key file.
3759 * Returns: %TRUE if the group was removed, %FALSE otherwise
3764 g_key_file_remove_group (GKeyFile
*key_file
,
3765 const gchar
*group_name
,
3770 g_return_val_if_fail (key_file
!= NULL
, FALSE
);
3771 g_return_val_if_fail (group_name
!= NULL
, FALSE
);
3773 group_node
= g_key_file_lookup_group_node (key_file
, group_name
);
3777 g_set_error (error
, G_KEY_FILE_ERROR
,
3778 G_KEY_FILE_ERROR_GROUP_NOT_FOUND
,
3779 _("Key file does not have group '%s'"),
3784 g_key_file_remove_group_node (key_file
, group_node
);
3790 g_key_file_add_key_value_pair (GKeyFile
*key_file
,
3791 GKeyFileGroup
*group
,
3792 GKeyFileKeyValuePair
*pair
)
3794 g_hash_table_replace (group
->lookup_map
, pair
->key
, pair
);
3795 group
->key_value_pairs
= g_list_prepend (group
->key_value_pairs
, pair
);
3796 group
->has_trailing_blank_line
= FALSE
;
3800 g_key_file_add_key (GKeyFile
*key_file
,
3801 GKeyFileGroup
*group
,
3805 GKeyFileKeyValuePair
*pair
;
3807 pair
= g_slice_new (GKeyFileKeyValuePair
);
3808 pair
->key
= g_strdup (key
);
3809 pair
->value
= g_strdup (value
);
3811 g_key_file_add_key_value_pair (key_file
, group
, pair
);
3815 * g_key_file_remove_key:
3816 * @key_file: a #GKeyFile
3817 * @group_name: a group name
3818 * @key: a key name to remove
3819 * @error: return location for a #GError or %NULL
3821 * Removes @key in @group_name from the key file.
3823 * Returns: %TRUE if the key was removed, %FALSE otherwise
3828 g_key_file_remove_key (GKeyFile
*key_file
,
3829 const gchar
*group_name
,
3833 GKeyFileGroup
*group
;
3834 GKeyFileKeyValuePair
*pair
;
3836 g_return_val_if_fail (key_file
!= NULL
, FALSE
);
3837 g_return_val_if_fail (group_name
!= NULL
, FALSE
);
3838 g_return_val_if_fail (key
!= NULL
, FALSE
);
3842 group
= g_key_file_lookup_group (key_file
, group_name
);
3845 g_set_error (error
, G_KEY_FILE_ERROR
,
3846 G_KEY_FILE_ERROR_GROUP_NOT_FOUND
,
3847 _("Key file does not have group '%s'"),
3848 group_name
? group_name
: "(null)");
3852 pair
= g_key_file_lookup_key_value_pair (key_file
, group
, key
);
3856 g_set_error (error
, G_KEY_FILE_ERROR
,
3857 G_KEY_FILE_ERROR_KEY_NOT_FOUND
,
3858 _("Key file does not have key '%s' in group '%s'"),
3863 group
->key_value_pairs
= g_list_remove (group
->key_value_pairs
, pair
);
3864 g_hash_table_remove (group
->lookup_map
, pair
->key
);
3865 g_key_file_key_value_pair_free (pair
);
3871 g_key_file_lookup_group_node (GKeyFile
*key_file
,
3872 const gchar
*group_name
)
3874 GKeyFileGroup
*group
;
3877 for (tmp
= key_file
->groups
; tmp
!= NULL
; tmp
= tmp
->next
)
3879 group
= (GKeyFileGroup
*) tmp
->data
;
3881 if (group
&& group
->name
&& strcmp (group
->name
, group_name
) == 0)
3888 static GKeyFileGroup
*
3889 g_key_file_lookup_group (GKeyFile
*key_file
,
3890 const gchar
*group_name
)
3892 return (GKeyFileGroup
*)g_hash_table_lookup (key_file
->group_hash
, group_name
);
3896 g_key_file_lookup_key_value_pair_node (GKeyFile
*key_file
,
3897 GKeyFileGroup
*group
,
3902 for (key_node
= group
->key_value_pairs
;
3904 key_node
= key_node
->next
)
3906 GKeyFileKeyValuePair
*pair
;
3908 pair
= (GKeyFileKeyValuePair
*) key_node
->data
;
3910 if (pair
->key
&& strcmp (pair
->key
, key
) == 0)
3917 static GKeyFileKeyValuePair
*
3918 g_key_file_lookup_key_value_pair (GKeyFile
*key_file
,
3919 GKeyFileGroup
*group
,
3922 return (GKeyFileKeyValuePair
*) g_hash_table_lookup (group
->lookup_map
, key
);
3925 /* Lines starting with # or consisting entirely of whitespace are merely
3926 * recorded, not parsed. This function assumes all leading whitespace
3927 * has been stripped.
3930 g_key_file_line_is_comment (const gchar
*line
)
3932 return (*line
== '#' || *line
== '\0' || *line
== '\n');
3936 g_key_file_is_group_name (const gchar
*name
)
3943 p
= q
= (gchar
*) name
;
3944 while (*q
&& *q
!= ']' && *q
!= '[' && !g_ascii_iscntrl (*q
))
3945 q
= g_utf8_find_next_char (q
, NULL
);
3947 if (*q
!= '\0' || q
== p
)
3954 g_key_file_is_key_name (const gchar
*name
)
3961 p
= q
= (gchar
*) name
;
3962 /* We accept a little more than the desktop entry spec says,
3963 * since gnome-vfs uses mime-types as keys in its cache.
3965 while (*q
&& *q
!= '=' && *q
!= '[' && *q
!= ']')
3966 q
= g_utf8_find_next_char (q
, NULL
);
3968 /* No empty keys, please */
3972 /* We accept spaces in the middle of keys to not break
3973 * existing apps, but we don't tolerate initial or final
3974 * spaces, which would lead to silent corruption when
3975 * rereading the file.
3977 if (*p
== ' ' || q
[-1] == ' ')
3983 while (*q
&& (g_unichar_isalnum (g_utf8_get_char_validated (q
, -1)) || *q
== '-' || *q
== '_' || *q
== '.' || *q
== '@'))
3984 q
= g_utf8_find_next_char (q
, NULL
);
3998 /* A group in a key file is made up of a starting '[' followed by one
3999 * or more letters making up the group name followed by ']'.
4002 g_key_file_line_is_group (const gchar
*line
)
4012 while (*p
&& *p
!= ']')
4013 p
= g_utf8_find_next_char (p
, NULL
);
4018 /* silently accept whitespace after the ] */
4019 p
= g_utf8_find_next_char (p
, NULL
);
4020 while (*p
== ' ' || *p
== '\t')
4021 p
= g_utf8_find_next_char (p
, NULL
);
4030 g_key_file_line_is_key_value_pair (const gchar
*line
)
4034 p
= (gchar
*) g_utf8_strchr (line
, -1, '=');
4039 /* Key must be non-empty
4048 g_key_file_parse_value_as_string (GKeyFile
*key_file
,
4053 gchar
*string_value
, *p
, *q0
, *q
;
4055 string_value
= g_new (gchar
, strlen (value
) + 1);
4057 p
= (gchar
*) value
;
4058 q0
= q
= string_value
;
4088 g_set_error_literal (error
, G_KEY_FILE_ERROR
,
4089 G_KEY_FILE_ERROR_INVALID_VALUE
,
4090 _("Key file contains escape character "
4095 if (pieces
&& *p
== key_file
->list_separator
)
4096 *q
= key_file
->list_separator
;
4110 g_set_error (error
, G_KEY_FILE_ERROR
,
4111 G_KEY_FILE_ERROR_INVALID_VALUE
,
4112 _("Key file contains invalid escape "
4113 "sequence '%s'"), sequence
);
4122 if (pieces
&& (*p
== key_file
->list_separator
))
4124 *pieces
= g_slist_prepend (*pieces
, g_strndup (q0
, q
- q0
));
4140 *pieces
= g_slist_prepend (*pieces
, g_strndup (q0
, q
- q0
));
4141 *pieces
= g_slist_reverse (*pieces
);
4144 return string_value
;
4148 g_key_file_parse_string_as_value (GKeyFile
*key_file
,
4149 const gchar
*string
,
4150 gboolean escape_separator
)
4152 gchar
*value
, *p
, *q
;
4154 gboolean parsing_leading_space
;
4156 length
= strlen (string
) + 1;
4158 /* Worst case would be that every character needs to be escaped.
4159 * In other words every character turns to two characters
4161 value
= g_new (gchar
, 2 * length
);
4163 p
= (gchar
*) string
;
4165 parsing_leading_space
= TRUE
;
4166 while (p
< (string
+ length
- 1))
4168 gchar escaped_character
[3] = { '\\', 0, 0 };
4173 if (parsing_leading_space
)
4175 escaped_character
[1] = 's';
4176 strcpy (q
, escaped_character
);
4186 if (parsing_leading_space
)
4188 escaped_character
[1] = 't';
4189 strcpy (q
, escaped_character
);
4199 escaped_character
[1] = 'n';
4200 strcpy (q
, escaped_character
);
4204 escaped_character
[1] = 'r';
4205 strcpy (q
, escaped_character
);
4209 escaped_character
[1] = '\\';
4210 strcpy (q
, escaped_character
);
4212 parsing_leading_space
= FALSE
;
4215 if (escape_separator
&& *p
== key_file
->list_separator
)
4217 escaped_character
[1] = key_file
->list_separator
;
4218 strcpy (q
, escaped_character
);
4220 parsing_leading_space
= TRUE
;
4226 parsing_leading_space
= FALSE
;
4238 g_key_file_parse_value_as_integer (GKeyFile
*key_file
,
4247 long_value
= strtol (value
, &eof_int
, 10);
4249 if (*value
== '\0' || (*eof_int
!= '\0' && !g_ascii_isspace(*eof_int
)))
4251 gchar
*value_utf8
= _g_utf8_make_valid (value
);
4252 g_set_error (error
, G_KEY_FILE_ERROR
,
4253 G_KEY_FILE_ERROR_INVALID_VALUE
,
4254 _("Value '%s' cannot be interpreted "
4255 "as a number."), value_utf8
);
4256 g_free (value_utf8
);
4261 int_value
= long_value
;
4262 if (int_value
!= long_value
|| errno
== ERANGE
)
4264 gchar
*value_utf8
= _g_utf8_make_valid (value
);
4267 G_KEY_FILE_ERROR_INVALID_VALUE
,
4268 _("Integer value '%s' out of range"),
4270 g_free (value_utf8
);
4279 g_key_file_parse_integer_as_value (GKeyFile
*key_file
,
4283 return g_strdup_printf ("%d", value
);
4287 g_key_file_parse_value_as_double (GKeyFile
*key_file
,
4291 gchar
*end_of_valid_d
;
4292 gdouble double_value
= 0;
4294 double_value
= g_ascii_strtod (value
, &end_of_valid_d
);
4296 if (*end_of_valid_d
!= '\0' || end_of_valid_d
== value
)
4298 gchar
*value_utf8
= _g_utf8_make_valid (value
);
4299 g_set_error (error
, G_KEY_FILE_ERROR
,
4300 G_KEY_FILE_ERROR_INVALID_VALUE
,
4301 _("Value '%s' cannot be interpreted "
4302 "as a float number."),
4304 g_free (value_utf8
);
4307 return double_value
;
4311 g_key_file_parse_value_as_boolean (GKeyFile
*key_file
,
4317 if (strcmp (value
, "true") == 0 || strcmp (value
, "1") == 0)
4319 else if (strcmp (value
, "false") == 0 || strcmp (value
, "0") == 0)
4322 value_utf8
= _g_utf8_make_valid (value
);
4323 g_set_error (error
, G_KEY_FILE_ERROR
,
4324 G_KEY_FILE_ERROR_INVALID_VALUE
,
4325 _("Value '%s' cannot be interpreted "
4326 "as a boolean."), value_utf8
);
4327 g_free (value_utf8
);
4333 g_key_file_parse_boolean_as_value (GKeyFile
*key_file
,
4337 return g_strdup ("true");
4339 return g_strdup ("false");
4343 g_key_file_parse_value_as_comment (GKeyFile
*key_file
,
4350 string
= g_string_sized_new (512);
4352 lines
= g_strsplit (value
, "\n", 0);
4354 for (i
= 0; lines
[i
] != NULL
; i
++)
4356 if (lines
[i
][0] != '#')
4357 g_string_append_printf (string
, "%s\n", lines
[i
]);
4359 g_string_append_printf (string
, "%s\n", lines
[i
] + 1);
4363 return g_string_free (string
, FALSE
);
4367 g_key_file_parse_comment_as_value (GKeyFile
*key_file
,
4368 const gchar
*comment
)
4374 string
= g_string_sized_new (512);
4376 lines
= g_strsplit (comment
, "\n", 0);
4378 for (i
= 0; lines
[i
] != NULL
; i
++)
4379 g_string_append_printf (string
, "#%s%s", lines
[i
],
4380 lines
[i
+ 1] == NULL
? "" : "\n");
4383 return g_string_free (string
, FALSE
);