glib/gkeyfile.c

   1 /* gkeyfile.c - key file parser
   2  *
   3  *  Copyright 2004  Red Hat, Inc.
   4  *  Copyright 2009-2010  Collabora Ltd.
   5  *  Copyright 2009  Nokia Corporation
   6  *
   7  * Written by Ray Strode <rstrode@redhat.com>
   8  *            Matthias Clasen <mclasen@redhat.com>
   9  *
  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.
  14  *
  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.
  19  *
  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.
  24  */
  25
  26 #include "config.h"
  27
  28 #include "gkeyfile.h"
  29 #include "gutils.h"
  30
  31 #include <errno.h>
  32 #include <fcntl.h>
  33 #include <locale.h>
  34 #include <string.h>
  35 #include <stdio.h>
  36 #include <stdlib.h>
  37 #include <sys/types.h>
  38 #include <sys/stat.h>
  39 #ifdef HAVE_UNISTD_H
  40 #include <unistd.h>
  41 #endif
  42 #ifdef G_OS_WIN32
  43 #include <io.h>
  44
  45 #define fstat(a,b) _fstati64(a,b)
  46 #define stat _stati64
  47
  48 #ifndef S_ISREG
  49 #define S_ISREG(mode) ((mode)&_S_IFREG)
  50 #endif
  51
  52 #endif  /* G_OS_WIN23 */
  53
  54 #include "gconvert.h"
  55 #include "gdataset.h"
  56 #include "gerror.h"
  57 #include "gfileutils.h"
  58 #include "ghash.h"
  59 #include "glibintl.h"
  60 #include "glist.h"
  61 #include "gslist.h"
  62 #include "gmem.h"
  63 #include "gmessages.h"
  64 #include "gstdio.h"
  65 #include "gstring.h"
  66 #include "gstrfuncs.h"
  67 #include "gutils.h"
  68
  69
  70 typedef struct _GKeyFileGroup GKeyFileGroup;
  71
  72 struct _GKeyFile
  73 {
  74   GList *groups;
  75   GHashTable *group_hash;
  76
  77   GKeyFileGroup *start_group;
  78   GKeyFileGroup *current_group;
  79
  80   GString *parse_buffer; /* Holds up to one line of not-yet-parsed data */
  81
  82   /* Used for sizing the output buffer during serialization
  83    */
  84   gsize approximate_size;
  85
  86   gchar list_separator;
  87
  88   GKeyFileFlags flags;
  89
  90   gchar **locales;
  91 };
  92
  93 typedef struct _GKeyFileKeyValuePair GKeyFileKeyValuePair;
  94
  95 struct _GKeyFileGroup
  96 {
  97   const gchar *name;  /* NULL for above first group (which will be comments) */
  98
  99   GKeyFileKeyValuePair *comment; /* Special comment that is stuck to the top of a group */
 100   gboolean has_trailing_blank_line;
 101
 102   GList *key_value_pairs;
 103
 104   /* Used in parallel with key_value_pairs for
 105    * increased lookup performance
 106    */
 107   GHashTable *lookup_map;
 108 };
 109
 110 struct _GKeyFileKeyValuePair
 111 {
 112   gchar *key;  /* NULL for comments */
 113   gchar *value;
 114 };
 115
 116 static gint                  find_file_in_data_dirs            (const gchar            *file,
 117                                                                 const gchar           **data_dirs,
 118                                                                 gchar                 **output_file,
 119                                                                 GError                **error);
 120 static gboolean              g_key_file_load_from_fd           (GKeyFile               *key_file,
 121                                                                 gint                    fd,
 122                                                                 GKeyFileFlags           flags,
 123                                                                 GError                **error);
 124 static GList                *g_key_file_lookup_group_node      (GKeyFile               *key_file,
 125                                                                 const gchar            *group_name);
 126 static GKeyFileGroup        *g_key_file_lookup_group           (GKeyFile               *key_file,
 127                                                                 const gchar            *group_name);
 128
 129 static GList                *g_key_file_lookup_key_value_pair_node  (GKeyFile       *key_file,
 130                                                                      GKeyFileGroup  *group,
 131                                                                      const gchar    *key);
 132 static GKeyFileKeyValuePair *g_key_file_lookup_key_value_pair       (GKeyFile       *key_file,
 133                                                                      GKeyFileGroup  *group,
 134                                                                      const gchar    *key);
 135
 136 static void                  g_key_file_remove_group_node          (GKeyFile      *key_file,
 137                                                                     GList         *group_node);
 138 static void                  g_key_file_remove_key_value_pair_node (GKeyFile      *key_file,
 139                                                                     GKeyFileGroup *group,
 140                                                                     GList         *pair_node);
 141
 142 static void                  g_key_file_add_key                (GKeyFile               *key_file,
 143                                                                 GKeyFileGroup          *group,
 144                                                                 const gchar            *key,
 145                                                                 const gchar            *value);
 146 static void                  g_key_file_add_group              (GKeyFile               *key_file,
 147                                                                 const gchar            *group_name);
 148 static gboolean              g_key_file_is_group_name          (const gchar *name);
 149 static gboolean              g_key_file_is_key_name            (const gchar *name);
 150 static void                  g_key_file_key_value_pair_free    (GKeyFileKeyValuePair   *pair);
 151 static gboolean              g_key_file_line_is_comment        (const gchar            *line);
 152 static gboolean              g_key_file_line_is_group          (const gchar            *line);
 153 static gboolean              g_key_file_line_is_key_value_pair (const gchar            *line);
 154 static gchar                *g_key_file_parse_value_as_string  (GKeyFile               *key_file,
 155                                                                 const gchar            *value,
 156                                                                 GSList                **separators,
 157                                                                 GError                **error);
 158 static gchar                *g_key_file_parse_string_as_value  (GKeyFile               *key_file,
 159                                                                 const gchar            *string,
 160                                                                 gboolean                escape_separator);
 161 static gint                  g_key_file_parse_value_as_integer (GKeyFile               *key_file,
 162                                                                 const gchar            *value,
 163                                                                 GError                **error);
 164 static gchar                *g_key_file_parse_integer_as_value (GKeyFile               *key_file,
 165                                                                 gint                    value);
 166 static gdouble               g_key_file_parse_value_as_double  (GKeyFile               *key_file,
 167                                                                 const gchar            *value,
 168                                                                 GError                **error);
 169 static gboolean              g_key_file_parse_value_as_boolean (GKeyFile               *key_file,
 170                                                                 const gchar            *value,
 171                                                                 GError                **error);
 172 static gchar                *g_key_file_parse_boolean_as_value (GKeyFile               *key_file,
 173                                                                 gboolean                value);
 174 static gchar                *g_key_file_parse_value_as_comment (GKeyFile               *key_file,
 175                                                                 const gchar            *value);
 176 static gchar                *g_key_file_parse_comment_as_value (GKeyFile               *key_file,
 177                                                                 const gchar            *comment);
 178 static void                  g_key_file_parse_key_value_pair   (GKeyFile               *key_file,
 179                                                                 const gchar            *line,
 180                                                                 gsize                   length,
 181                                                                 GError                **error);
 182 static void                  g_key_file_parse_comment          (GKeyFile               *key_file,
 183                                                                 const gchar            *line,
 184                                                                 gsize                   length,
 185                                                                 GError                **error);
 186 static void                  g_key_file_parse_group            (GKeyFile               *key_file,
 187                                                                 const gchar            *line,
 188                                                                 gsize                   length,
 189                                                                 GError                **error);
 190 static gchar                *key_get_locale                    (const gchar            *key);
 191 static void                  g_key_file_parse_data             (GKeyFile               *key_file,
 192                                                                 const gchar            *data,
 193                                                                 gsize                   length,
 194                                                                 GError                **error);
 195 static void                  g_key_file_flush_parse_buffer     (GKeyFile               *key_file,
 196                                                                 GError                **error);
 197
 198
 199 GQuark
 200 g_key_file_error_quark (void)
 201 {
 202   return g_quark_from_static_string ("g-key-file-error-quark");
 203 }
 204
 205 static void
 206 g_key_file_init (GKeyFile *key_file)
 207 {
 208   key_file->current_group = g_slice_new0 (GKeyFileGroup);
 209   key_file->groups = g_list_prepend (NULL, key_file->current_group);
 210   key_file->group_hash = g_hash_table_new (g_str_hash, g_str_equal);
 211   key_file->start_group = NULL;
 212   key_file->parse_buffer = g_string_sized_new (128);
 213   key_file->approximate_size = 0;
 214   key_file->list_separator = ';';
 215   key_file->flags = 0;
 216   key_file->locales = g_strdupv ((gchar **)g_get_language_names ());
 217 }
 218
 219 static void
 220 g_key_file_clear (GKeyFile *key_file)
 221 {
 222   GList *tmp, *group_node;
 223
 224   if (key_file->locales)
 225     {
 226       g_strfreev (key_file->locales);
 227       key_file->locales = NULL;
 228     }
 229
 230   if (key_file->parse_buffer)
 231     {
 232       g_string_free (key_file->parse_buffer, TRUE);
 233       key_file->parse_buffer = NULL;
 234     }
 235
 236   tmp = key_file->groups;
 237   while (tmp != NULL)
 238     {
 239       group_node = tmp;
 240       tmp = tmp->next;
 241       g_key_file_remove_group_node (key_file, group_node);
 242     }
 243
 244   g_hash_table_destroy (key_file->group_hash);
 245   key_file->group_hash = NULL;
 246
 247   g_warn_if_fail (key_file->groups == NULL);
 248 }
 249
 250
 251 /**
 252  * g_key_file_new:
 253  *
 254  * Creates a new empty #GKeyFile object. Use
 255  * g_key_file_load_from_file(), g_key_file_load_from_data(),
 256  * g_key_file_load_from_dirs() or g_key_file_load_from_data_dirs() to
 257  * read an existing key file.
 258  *
 259  * Return value: an empty #GKeyFile.
 260  *
 261  * Since: 2.6
 262  **/
 263 GKeyFile *
 264 g_key_file_new (void)
 265 {
 266   GKeyFile *key_file;
 267
 268   key_file = g_slice_new0 (GKeyFile);
 269   g_key_file_init (key_file);
 270
 271   return key_file;
 272 }
 273
 274 /**
 275  * g_key_file_set_list_separator:
 276  * @key_file: a #GKeyFile
 277  * @separator: the separator
 278  *
 279  * Sets the character which is used to separate
 280  * values in lists. Typically ';' or ',' are used
 281  * as separators. The default list separator is ';'.
 282  *
 283  * Since: 2.6
 284  */
 285 void
 286 g_key_file_set_list_separator (GKeyFile *key_file,
 287                                gchar     separator)
 288 {
 289   g_return_if_fail (key_file != NULL);
 290
 291   key_file->list_separator = separator;
 292 }
 293
 294
 295 /* Iterates through all the directories in *dirs trying to
 296  * open file.  When it successfully locates and opens a file it
 297  * returns the file descriptor to the open file.  It also
 298  * outputs the absolute path of the file in output_file.
 299  */
 300 static gint
 301 find_file_in_data_dirs (const gchar   *file,
 302                         const gchar  **dirs,
 303                         gchar        **output_file,
 304                         GError       **error)
 305 {
 306   const gchar **data_dirs, *data_dir;
 307   gchar *path;
 308   gint fd;
 309
 310   path = NULL;
 311   fd = -1;
 312
 313   if (dirs == NULL)
 314     return fd;
 315
 316   data_dirs = dirs;
 317
 318   while (data_dirs && (data_dir = *data_dirs) && fd < 0)
 319     {
 320       gchar *candidate_file, *sub_dir;
 321
 322       candidate_file = (gchar *) file;
 323       sub_dir = g_strdup ("");
 324       while (candidate_file != NULL && fd < 0)
 325         {
 326           gchar *p;
 327
 328           path = g_build_filename (data_dir, sub_dir,
 329                                    candidate_file, NULL);
 330
 331           fd = g_open (path, O_RDONLY, 0);
 332
 333           if (fd < 0)
 334             {
 335               g_free (path);
 336               path = NULL;
 337             }
 338
 339           candidate_file = strchr (candidate_file, '-');
 340
 341           if (candidate_file == NULL)
 342             break;
 343
 344           candidate_file++;
 345
 346           g_free (sub_dir);
 347           sub_dir = g_strndup (file, candidate_file - file - 1);
 348
 349           for (p = sub_dir; *p != '\0'; p++)
 350             {
 351               if (*p == '-')
 352                 *p = G_DIR_SEPARATOR;
 353             }
 354         }
 355       g_free (sub_dir);
 356       data_dirs++;
 357     }
 358
 359   if (fd < 0)
 360     {
 361       g_set_error_literal (error, G_KEY_FILE_ERROR,
 362                            G_KEY_FILE_ERROR_NOT_FOUND,
 363                            _("Valid key file could not be "
 364                              "found in search dirs"));
 365     }
 366
 367   if (output_file != NULL && fd > 0)
 368     *output_file = g_strdup (path);
 369
 370   g_free (path);
 371
 372   return fd;
 373 }
 374
 375 static gboolean
 376 g_key_file_load_from_fd (GKeyFile       *key_file,
 377                          gint            fd,
 378                          GKeyFileFlags   flags,
 379                          GError        **error)
 380 {
 381   GError *key_file_error = NULL;
 382   gssize bytes_read;
 383   struct stat stat_buf;
 384   gchar read_buf[4096];
 385
 386   if (fstat (fd, &stat_buf) < 0)
 387     {
 388       g_set_error_literal (error, G_FILE_ERROR,
 389                            g_file_error_from_errno (errno),
 390                            g_strerror (errno));
 391       return FALSE;
 392     }
 393
 394   if (!S_ISREG (stat_buf.st_mode))
 395     {
 396       g_set_error_literal (error, G_KEY_FILE_ERROR,
 397                            G_KEY_FILE_ERROR_PARSE,
 398                            _("Not a regular file"));
 399       return FALSE;
 400     }
 401
 402   if (stat_buf.st_size == 0)
 403     {
 404       g_set_error_literal (error, G_KEY_FILE_ERROR,
 405                            G_KEY_FILE_ERROR_PARSE,
 406                            _("File is empty"));
 407       return FALSE;
 408     }
 409
 410   if (key_file->approximate_size > 0)
 411     {
 412       g_key_file_clear (key_file);
 413       g_key_file_init (key_file);
 414     }
 415   key_file->flags = flags;
 416
 417   do
 418     {
 419       bytes_read = read (fd, read_buf, 4096);
 420
 421       if (bytes_read == 0)  /* End of File */
 422         break;
 423
 424       if (bytes_read < 0)
 425         {
 426           if (errno == EINTR || errno == EAGAIN)
 427             continue;
 428
 429           g_set_error_literal (error, G_FILE_ERROR,
 430                                g_file_error_from_errno (errno),
 431                                g_strerror (errno));
 432           return FALSE;
 433         }
 434
 435       g_key_file_parse_data (key_file,
 436                              read_buf, bytes_read,
 437                              &key_file_error);
 438     }
 439   while (!key_file_error);
 440
 441   if (key_file_error)
 442     {
 443       g_propagate_error (error, key_file_error);
 444       return FALSE;
 445     }
 446
 447   g_key_file_flush_parse_buffer (key_file, &key_file_error);
 448
 449   if (key_file_error)
 450     {
 451       g_propagate_error (error, key_file_error);
 452       return FALSE;
 453     }
 454
 455   return TRUE;
 456 }
 457
 458 /**
 459  * g_key_file_load_from_file:
 460  * @key_file: an empty #GKeyFile struct
 461  * @file: the path of a filename to load, in the GLib filename encoding
 462  * @flags: flags from #GKeyFileFlags
 463  * @error: return location for a #GError, or %NULL
 464  *
 465  * Loads a key file into an empty #GKeyFile structure.
 466  * If the file could not be loaded then %error is set to
 467  * either a #GFileError or #GKeyFileError.
 468  *
 469  * Return value: %TRUE if a key file could be loaded, %FALSE otherwise
 470  *
 471  * Since: 2.6
 472  **/
 473 gboolean
 474 g_key_file_load_from_file (GKeyFile       *key_file,
 475                            const gchar    *file,
 476                            GKeyFileFlags   flags,
 477                            GError        **error)
 478 {
 479   GError *key_file_error = NULL;
 480   gint fd;
 481
 482   g_return_val_if_fail (key_file != NULL, FALSE);
 483   g_return_val_if_fail (file != NULL, FALSE);
 484
 485   fd = g_open (file, O_RDONLY, 0);
 486
 487   if (fd < 0)
 488     {
 489       g_set_error_literal (error, G_FILE_ERROR,
 490                            g_file_error_from_errno (errno),
 491                            g_strerror (errno));
 492       return FALSE;
 493     }
 494
 495   g_key_file_load_from_fd (key_file, fd, flags, &key_file_error);
 496   close (fd);
 497
 498   if (key_file_error)
 499     {
 500       g_propagate_error (error, key_file_error);
 501       return FALSE;
 502     }
 503
 504   return TRUE;
 505 }
 506
 507 /**
 508  * g_key_file_load_from_data:
 509  * @key_file: an empty #GKeyFile struct
 510  * @data: key file loaded in memory
 511  * @length: the length of @data in bytes
 512  * @flags: flags from #GKeyFileFlags
 513  * @error: return location for a #GError, or %NULL
 514  *
 515  * Loads a key file from memory into an empty #GKeyFile structure.
 516  * If the object cannot be created then %error is set to a #GKeyFileError.
 517  *
 518  * Return value: %TRUE if a key file could be loaded, %FALSE otherwise
 519  *
 520  * Since: 2.6
 521  **/
 522 gboolean
 523 g_key_file_load_from_data (GKeyFile       *key_file,
 524                            const gchar    *data,
 525                            gsize           length,
 526                            GKeyFileFlags   flags,
 527                            GError        **error)
 528 {
 529   GError *key_file_error = NULL;
 530
 531   g_return_val_if_fail (key_file != NULL, FALSE);
 532   g_return_val_if_fail (data != NULL, FALSE);
 533   g_return_val_if_fail (length != 0, FALSE);
 534
 535   if (length == (gsize)-1)
 536     length = strlen (data);
 537
 538   if (key_file->approximate_size > 0)
 539     {
 540       g_key_file_clear (key_file);
 541       g_key_file_init (key_file);
 542     }
 543   key_file->flags = flags;
 544
 545   g_key_file_parse_data (key_file, data, length, &key_file_error);
 546
 547   if (key_file_error)
 548     {
 549       g_propagate_error (error, key_file_error);
 550       return FALSE;
 551     }
 552
 553   g_key_file_flush_parse_buffer (key_file, &key_file_error);
 554
 555   if (key_file_error)
 556     {
 557       g_propagate_error (error, key_file_error);
 558       return FALSE;
 559     }
 560
 561   return TRUE;
 562 }
 563
 564 /**
 565  * g_key_file_load_from_dirs:
 566  * @key_file: an empty #GKeyFile struct
 567  * @file: a relative path to a filename to open and parse
 568  * @search_dirs: %NULL-terminated array of directories to search
 569  * @full_path: return location for a string containing the full path
 570  *   of the file, or %NULL
 571  * @flags: flags from #GKeyFileFlags
 572  * @error: return location for a #GError, or %NULL
 573  *
 574  * This function looks for a key file named @file in the paths
 575  * specified in @search_dirs, loads the file into @key_file and
 576  * returns the file's full path in @full_path.  If the file could not
 577  * be loaded then an %error is set to either a #GFileError or
 578  * #GKeyFileError.
 579  *
 580  * Return value: %TRUE if a key file could be loaded, %FALSE otherwise
 581  *
 582  * Since: 2.14
 583  **/
 584 gboolean
 585 g_key_file_load_from_dirs (GKeyFile       *key_file,
 586                            const gchar    *file,
 587                            const gchar   **search_dirs,
 588                            gchar         **full_path,
 589                            GKeyFileFlags   flags,
 590                            GError        **error)
 591 {
 592   GError *key_file_error = NULL;
 593   const gchar **data_dirs;
 594   gchar *output_path;
 595   gint fd;
 596   gboolean found_file;
 597
 598   g_return_val_if_fail (key_file != NULL, FALSE);
 599   g_return_val_if_fail (!g_path_is_absolute (file), FALSE);
 600   g_return_val_if_fail (search_dirs != NULL, FALSE);
 601
 602   found_file = FALSE;
 603   data_dirs = search_dirs;
 604   output_path = NULL;
 605   while (*data_dirs != NULL && !found_file)
 606     {
 607       g_free (output_path);
 608
 609       fd = find_file_in_data_dirs (file, data_dirs, &output_path,
 610                                    &key_file_error);
 611
 612       if (fd < 0)
 613         {
 614           if (key_file_error)
 615             g_propagate_error (error, key_file_error);
 616           break;
 617         }
 618
 619       found_file = g_key_file_load_from_fd (key_file, fd, flags,
 620                                             &key_file_error);
 621       close (fd);
 622
 623       if (key_file_error)
 624         {
 625           g_propagate_error (error, key_file_error);
 626           break;
 627         }
 628     }
 629
 630   if (found_file && full_path)
 631     *full_path = output_path;
 632   else
 633     g_free (output_path);
 634
 635   return found_file;
 636 }
 637
 638 /**
 639  * g_key_file_load_from_data_dirs:
 640  * @key_file: an empty #GKeyFile struct
 641  * @file: a relative path to a filename to open and parse
 642  * @full_path: return location for a string containing the full path
 643  *   of the file, or %NULL
 644  * @flags: flags from #GKeyFileFlags
 645  * @error: return location for a #GError, or %NULL
 646  *
 647  * This function looks for a key file named @file in the paths
 648  * returned from g_get_user_data_dir() and g_get_system_data_dirs(),
 649  * loads the file into @key_file and returns the file's full path in
 650  * @full_path.  If the file could not be loaded then an %error is
 651  * set to either a #GFileError or #GKeyFileError.
 652  *
 653  * Return value: %TRUE if a key file could be loaded, %FALSE othewise
 654  * Since: 2.6
 655  **/
 656 gboolean
 657 g_key_file_load_from_data_dirs (GKeyFile       *key_file,
 658                                 const gchar    *file,
 659                                 gchar         **full_path,
 660                                 GKeyFileFlags   flags,
 661                                 GError        **error)
 662 {
 663   gchar **all_data_dirs;
 664   const gchar * user_data_dir;
 665   const gchar * const * system_data_dirs;
 666   gsize i, j;
 667   gboolean found_file;
 668
 669   g_return_val_if_fail (key_file != NULL, FALSE);
 670   g_return_val_if_fail (!g_path_is_absolute (file), FALSE);
 671
 672   user_data_dir = g_get_user_data_dir ();
 673   system_data_dirs = g_get_system_data_dirs ();
 674   all_data_dirs = g_new (gchar *, g_strv_length ((gchar **)system_data_dirs) + 2);
 675
 676   i = 0;
 677   all_data_dirs[i++] = g_strdup (user_data_dir);
 678
 679   j = 0;
 680   while (system_data_dirs[j] != NULL)
 681     all_data_dirs[i++] = g_strdup (system_data_dirs[j++]);
 682   all_data_dirs[i] = NULL;
 683
 684   found_file = g_key_file_load_from_dirs (key_file,
 685                                           file,
 686                                           (const gchar **)all_data_dirs,
 687                                           full_path,
 688                                           flags,
 689                                           error);
 690
 691   g_strfreev (all_data_dirs);
 692
 693   return found_file;
 694 }
 695
 696 /**
 697  * g_key_file_free:
 698  * @key_file: a #GKeyFile
 699  *
 700  * Frees a #GKeyFile.
 701  *
 702  * Since: 2.6
 703  **/
 704 void
 705 g_key_file_free (GKeyFile *key_file)
 706 {
 707   g_return_if_fail (key_file != NULL);
 708
 709   g_key_file_clear (key_file);
 710   g_slice_free (GKeyFile, key_file);
 711 }
 712
 713 /* If G_KEY_FILE_KEEP_TRANSLATIONS is not set, only returns
 714  * true for locales that match those in g_get_language_names().
 715  */
 716 static gboolean
 717 g_key_file_locale_is_interesting (GKeyFile    *key_file,
 718                                   const gchar *locale)
 719 {
 720   gsize i;
 721
 722   if (key_file->flags & G_KEY_FILE_KEEP_TRANSLATIONS)
 723     return TRUE;
 724
 725   for (i = 0; key_file->locales[i] != NULL; i++)
 726     {
 727       if (g_ascii_strcasecmp (key_file->locales[i], locale) == 0)
 728         return TRUE;
 729     }
 730
 731   return FALSE;
 732 }
 733
 734 static void
 735 g_key_file_parse_line (GKeyFile     *key_file,
 736                        const gchar  *line,
 737                        gsize         length,
 738                        GError      **error)
 739 {
 740   GError *parse_error = NULL;
 741   gchar *line_start;
 742
 743   g_return_if_fail (key_file != NULL);
 744   g_return_if_fail (line != NULL);
 745
 746   line_start = (gchar *) line;
 747   while (g_ascii_isspace (*line_start))
 748     line_start++;
 749
 750   if (g_key_file_line_is_comment (line_start))
 751     g_key_file_parse_comment (key_file, line, length, &parse_error);
 752   else if (g_key_file_line_is_group (line_start))
 753     g_key_file_parse_group (key_file, line_start,
 754                             length - (line_start - line),
 755                             &parse_error);
 756   else if (g_key_file_line_is_key_value_pair (line_start))
 757     g_key_file_parse_key_value_pair (key_file, line_start,
 758                                      length - (line_start - line),
 759                                      &parse_error);
 760   else
 761     {
 762       gchar *line_utf8 = _g_utf8_make_valid (line);
 763       g_set_error (error, G_KEY_FILE_ERROR,
 764                    G_KEY_FILE_ERROR_PARSE,
 765                    _("Key file contains line '%s' which is not "
 766                      "a key-value pair, group, or comment"),
 767                    line_utf8);
 768       g_free (line_utf8);
 769
 770       return;
 771     }
 772
 773   if (parse_error)
 774     g_propagate_error (error, parse_error);
 775 }
 776
 777 static void
 778 g_key_file_parse_comment (GKeyFile     *key_file,
 779                           const gchar  *line,
 780                           gsize         length,
 781                           GError      **error)
 782 {
 783   GKeyFileKeyValuePair *pair;
 784
 785   if (!(key_file->flags & G_KEY_FILE_KEEP_COMMENTS))
 786     return;
 787
 788   g_warn_if_fail (key_file->current_group != NULL);
 789
 790   pair = g_slice_new (GKeyFileKeyValuePair);
 791   pair->key = NULL;
 792   pair->value = g_strndup (line, length);
 793
 794   key_file->current_group->key_value_pairs =
 795     g_list_prepend (key_file->current_group->key_value_pairs, pair);
 796
 797   if (length == 0 || line[0] != '#')
 798     key_file->current_group->has_trailing_blank_line = TRUE;
 799 }
 800
 801 static void
 802 g_key_file_parse_group (GKeyFile     *key_file,
 803                         const gchar  *line,
 804                         gsize         length,
 805                         GError      **error)
 806 {
 807   gchar *group_name;
 808   const gchar *group_name_start, *group_name_end;
 809
 810   /* advance past opening '['
 811    */
 812   group_name_start = line + 1;
 813   group_name_end = line + length - 1;
 814
 815   while (*group_name_end != ']')
 816     group_name_end--;
 817
 818   group_name = g_strndup (group_name_start,
 819                           group_name_end - group_name_start);
 820
 821   if (!g_key_file_is_group_name (group_name))
 822     {
 823       g_set_error (error, G_KEY_FILE_ERROR,
 824                    G_KEY_FILE_ERROR_PARSE,
 825                    _("Invalid group name: %s"), group_name);
 826       g_free (group_name);
 827       return;
 828     }
 829
 830   g_key_file_add_group (key_file, group_name);
 831   g_free (group_name);
 832 }
 833
 834 static void
 835 g_key_file_parse_key_value_pair (GKeyFile     *key_file,
 836                                  const gchar  *line,
 837                                  gsize         length,
 838                                  GError      **error)
 839 {
 840   gchar *key, *value, *key_end, *value_start, *locale;
 841   gsize key_len, value_len;
 842
 843   if (key_file->current_group == NULL || key_file->current_group->name == NULL)
 844     {
 845       g_set_error_literal (error, G_KEY_FILE_ERROR,
 846                            G_KEY_FILE_ERROR_GROUP_NOT_FOUND,
 847                            _("Key file does not start with a group"));
 848       return;
 849     }
 850
 851   key_end = value_start = strchr (line, '=');
 852
 853   g_warn_if_fail (key_end != NULL);
 854
 855   key_end--;
 856   value_start++;
 857
 858   /* Pull the key name from the line (chomping trailing whitespace)
 859    */
 860   while (g_ascii_isspace (*key_end))
 861     key_end--;
 862
 863   key_len = key_end - line + 2;
 864
 865   g_warn_if_fail (key_len <= length);
 866
 867   key = g_strndup (line, key_len - 1);
 868
 869   if (!g_key_file_is_key_name (key))
 870     {
 871       g_set_error (error, G_KEY_FILE_ERROR,
 872                    G_KEY_FILE_ERROR_PARSE,
 873                    _("Invalid key name: %s"), key);
 874       g_free (key);
 875       return;
 876     }
 877
 878   /* Pull the value from the line (chugging leading whitespace)
 879    */
 880   while (g_ascii_isspace (*value_start))
 881     value_start++;
 882
 883   value_len = line + length - value_start + 1;
 884
 885   value = g_strndup (value_start, value_len);
 886
 887   g_warn_if_fail (key_file->start_group != NULL);
 888
 889   if (key_file->current_group
 890       && key_file->current_group->name
 891       && strcmp (key_file->start_group->name,
 892                  key_file->current_group->name) == 0
 893       && strcmp (key, "Encoding") == 0)
 894     {
 895       if (g_ascii_strcasecmp (value, "UTF-8") != 0)
 896         {
 897           gchar *value_utf8 = _g_utf8_make_valid (value);
 898           g_set_error (error, G_KEY_FILE_ERROR,
 899                        G_KEY_FILE_ERROR_UNKNOWN_ENCODING,
 900                        _("Key file contains unsupported "
 901                          "encoding '%s'"), value_utf8);
 902           g_free (value_utf8);
 903
 904           g_free (key);
 905           g_free (value);
 906           return;
 907         }
 908     }
 909
 910   /* Is this key a translation? If so, is it one that we care about?
 911    */
 912   locale = key_get_locale (key);
 913
 914   if (locale == NULL || g_key_file_locale_is_interesting (key_file, locale))
 915     g_key_file_add_key (key_file, key_file->current_group, key, value);
 916
 917   g_free (locale);
 918   g_free (key);
 919   g_free (value);
 920 }
 921
 922 static gchar *
 923 key_get_locale (const gchar *key)
 924 {
 925   gchar *locale;
 926
 927   locale = g_strrstr (key, "[");
 928
 929   if (locale && strlen (locale) <= 2)
 930     locale = NULL;
 931
 932   if (locale)
 933     locale = g_strndup (locale + 1, strlen (locale) - 2);
 934
 935   return locale;
 936 }
 937
 938 static void
 939 g_key_file_parse_data (GKeyFile     *key_file,
 940                        const gchar  *data,
 941                        gsize         length,
 942                        GError      **error)
 943 {
 944   GError *parse_error;
 945   gsize i;
 946
 947   g_return_if_fail (key_file != NULL);
 948   g_return_if_fail (data != NULL);
 949
 950   parse_error = NULL;
 951
 952   for (i = 0; i < length; i++)
 953     {
 954       if (data[i] == '\n')
 955         {
 956           if (key_file->parse_buffer->len > 0
 957               && (key_file->parse_buffer->str[key_file->parse_buffer->len - 1]
 958                   == '\r'))
 959             g_string_erase (key_file->parse_buffer,
 960                             key_file->parse_buffer->len - 1,
 961                             1);
 962
 963           /* When a newline is encountered flush the parse buffer so that the
 964            * line can be parsed.  Note that completely blank lines won't show
 965            * up in the parse buffer, so they get parsed directly.
 966            */
 967           if (key_file->parse_buffer->len > 0)
 968             g_key_file_flush_parse_buffer (key_file, &parse_error);
 969           else
 970             g_key_file_parse_comment (key_file, "", 1, &parse_error);
 971
 972           if (parse_error)
 973             {
 974               g_propagate_error (error, parse_error);
 975               return;
 976             }
 977         }
 978       else
 979         g_string_append_c (key_file->parse_buffer, data[i]);
 980     }
 981
 982   key_file->approximate_size += length;
 983 }
 984
 985 static void
 986 g_key_file_flush_parse_buffer (GKeyFile  *key_file,
 987                                GError   **error)
 988 {
 989   GError *file_error = NULL;
 990
 991   g_return_if_fail (key_file != NULL);
 992
 993   file_error = NULL;
 994
 995   if (key_file->parse_buffer->len > 0)
 996     {
 997       g_key_file_parse_line (key_file, key_file->parse_buffer->str,
 998                              key_file->parse_buffer->len,
 999                              &file_error);
1000       g_string_erase (key_file->parse_buffer, 0, -1);
1001
1002       if (file_error)
1003         {
1004           g_propagate_error (error, file_error);
1005           return;
1006         }
1007     }
1008 }
1009
1010 /**
1011  * g_key_file_to_data:
1012  * @key_file: a #GKeyFile
1013  * @length: return location for the length of the
1014  *   returned string, or %NULL
1015  * @error: return location for a #GError, or %NULL
1016  *
1017  * This function outputs @key_file as a string.
1018  *
1019  * Note that this function never reports an error,
1020  * so it is safe to pass %NULL as @error.
1021  *
1022  * Return value: a newly allocated string holding
1023  *   the contents of the #GKeyFile
1024  *
1025  * Since: 2.6
1026  **/
1027 gchar *
1028 g_key_file_to_data (GKeyFile  *key_file,
1029                     gsize     *length,
1030                     GError   **error)
1031 {
1032   GString *data_string;
1033   GList *group_node, *key_file_node;
1034   gboolean has_blank_line = TRUE;
1035
1036   g_return_val_if_fail (key_file != NULL, NULL);
1037
1038   data_string = g_string_sized_new (2 * key_file->approximate_size);
1039
1040   for (group_node = g_list_last (key_file->groups);
1041        group_node != NULL;
1042        group_node = group_node->prev)
1043     {
1044       GKeyFileGroup *group;
1045
1046       group = (GKeyFileGroup *) group_node->data;
1047
1048       /* separate groups by at least an empty line */
1049       if (!has_blank_line)
1050         g_string_append_c (data_string, '\n');
1051       has_blank_line = group->has_trailing_blank_line;
1052
1053       if (group->comment != NULL)
1054         g_string_append_printf (data_string, "%s\n", group->comment->value);
1055
1056       if (group->name != NULL)
1057         g_string_append_printf (data_string, "[%s]\n", group->name);
1058
1059       for (key_file_node = g_list_last (group->key_value_pairs);
1060            key_file_node != NULL;
1061            key_file_node = key_file_node->prev)
1062         {
1063           GKeyFileKeyValuePair *pair;
1064
1065           pair = (GKeyFileKeyValuePair *) key_file_node->data;
1066
1067           if (pair->key != NULL)
1068             g_string_append_printf (data_string, "%s=%s\n", pair->key, pair->value);
1069           else
1070             g_string_append_printf (data_string, "%s\n", pair->value);
1071         }
1072     }
1073
1074   if (length)
1075     *length = data_string->len;
1076
1077   return g_string_free (data_string, FALSE);
1078 }
1079
1080 /**
1081  * g_key_file_get_keys:
1082  * @key_file: a #GKeyFile
1083  * @group_name: a group name
1084  * @length: return location for the number of keys returned, or %NULL
1085  * @error: return location for a #GError, or %NULL
1086  *
1087  * Returns all keys for the group name @group_name.  The array of
1088  * returned keys will be %NULL-terminated, so @length may
1089  * optionally be %NULL. In the event that the @group_name cannot
1090  * be found, %NULL is returned and @error is set to
1091  * #G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
1092  *
1093  * Return value: a newly-allocated %NULL-terminated array of strings.
1094  *     Use g_strfreev() to free it.
1095  *
1096  * Since: 2.6
1097  **/
1098 gchar **
1099 g_key_file_get_keys (GKeyFile     *key_file,
1100                      const gchar  *group_name,
1101                      gsize        *length,
1102                      GError      **error)
1103 {
1104   GKeyFileGroup *group;
1105   GList *tmp;
1106   gchar **keys;
1107   gsize i, num_keys;
1108
1109   g_return_val_if_fail (key_file != NULL, NULL);
1110   g_return_val_if_fail (group_name != NULL, NULL);
1111
1112   group = g_key_file_lookup_group (key_file, group_name);
1113
1114   if (!group)
1115     {
1116       g_set_error (error, G_KEY_FILE_ERROR,
1117                    G_KEY_FILE_ERROR_GROUP_NOT_FOUND,
1118                    _("Key file does not have group '%s'"),
1119                    group_name ? group_name : "(null)");
1120       return NULL;
1121     }
1122
1123   num_keys = 0;
1124   for (tmp = group->key_value_pairs; tmp; tmp = tmp->next)
1125     {
1126       GKeyFileKeyValuePair *pair;
1127
1128       pair = (GKeyFileKeyValuePair *) tmp->data;
1129
1130       if (pair->key)
1131         num_keys++;
1132     }
1133
1134   keys = g_new (gchar *, num_keys + 1);
1135
1136   i = num_keys - 1;
1137   for (tmp = group->key_value_pairs; tmp; tmp = tmp->next)
1138     {
1139       GKeyFileKeyValuePair *pair;
1140
1141       pair = (GKeyFileKeyValuePair *) tmp->data;
1142
1143       if (pair->key)
1144         {
1145           keys[i] = g_strdup (pair->key);
1146           i--;
1147         }
1148     }
1149
1150   keys[num_keys] = NULL;
1151
1152   if (length)
1153     *length = num_keys;
1154
1155   return keys;
1156 }
1157
1158 /**
1159  * g_key_file_get_start_group:
1160  * @key_file: a #GKeyFile
1161  *
1162  * Returns the name of the start group of the file.
1163  *
1164  * Return value: The start group of the key file.
1165  *
1166  * Since: 2.6
1167  **/
1168 gchar *
1169 g_key_file_get_start_group (GKeyFile *key_file)
1170 {
1171   g_return_val_if_fail (key_file != NULL, NULL);
1172
1173   if (key_file->start_group)
1174     return g_strdup (key_file->start_group->name);
1175
1176   return NULL;
1177 }
1178
1179 /**
1180  * g_key_file_get_groups:
1181  * @key_file: a #GKeyFile
1182  * @length: return location for the number of returned groups, or %NULL
1183  *
1184  * Returns all groups in the key file loaded with @key_file.
1185  * The array of returned groups will be %NULL-terminated, so
1186  * @length may optionally be %NULL.
1187  *
1188  * Return value: a newly-allocated %NULL-terminated array of strings.
1189  *   Use g_strfreev() to free it.
1190  * Since: 2.6
1191  **/
1192 gchar **
1193 g_key_file_get_groups (GKeyFile *key_file,
1194                        gsize    *length)
1195 {
1196   GList *group_node;
1197   gchar **groups;
1198   gsize i, num_groups;
1199
1200   g_return_val_if_fail (key_file != NULL, NULL);
1201
1202   num_groups = g_list_length (key_file->groups);
1203
1204   g_return_val_if_fail (num_groups > 0, NULL);
1205
1206   group_node = g_list_last (key_file->groups);
1207
1208   g_return_val_if_fail (((GKeyFileGroup *) group_node->data)->name == NULL, NULL);
1209
1210   /* Only need num_groups instead of num_groups + 1
1211    * because the first group of the file (last in the
1212    * list) is always the comment group at the top,
1213    * which we skip
1214    */
1215   groups = g_new (gchar *, num_groups);
1216
1217
1218   i = 0;
1219   for (group_node = group_node->prev;
1220        group_node != NULL;
1221        group_node = group_node->prev)
1222     {
1223       GKeyFileGroup *group;
1224
1225       group = (GKeyFileGroup *) group_node->data;
1226
1227       g_warn_if_fail (group->name != NULL);
1228
1229       groups[i++] = g_strdup (group->name);
1230     }
1231   groups[i] = NULL;
1232
1233   if (length)
1234     *length = i;
1235
1236   return groups;
1237 }
1238
1239 /**
1240  * g_key_file_get_value:
1241  * @key_file: a #GKeyFile
1242  * @group_name: a group name
1243  * @key: a key
1244  * @error: return location for a #GError, or %NULL
1245  *
1246  * Returns the raw value associated with @key under @group_name.
1247  * Use g_key_file_get_string() to retrieve an unescaped UTF-8 string.
1248  *
1249  * In the event the key cannot be found, %NULL is returned and
1250  * @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND.  In the
1251  * event that the @group_name cannot be found, %NULL is returned
1252  * and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
1253  *
1254  *
1255  * Return value: a newly allocated string or %NULL if the specified
1256  *  key cannot be found.
1257  *
1258  * Since: 2.6
1259  **/
1260 gchar *
1261 g_key_file_get_value (GKeyFile     *key_file,
1262                       const gchar  *group_name,
1263                       const gchar  *key,
1264                       GError      **error)
1265 {
1266   GKeyFileGroup *group;
1267   GKeyFileKeyValuePair *pair;
1268   gchar *value = NULL;
1269
1270   g_return_val_if_fail (key_file != NULL, NULL);
1271   g_return_val_if_fail (group_name != NULL, NULL);
1272   g_return_val_if_fail (key != NULL, NULL);
1273
1274   group = g_key_file_lookup_group (key_file, group_name);
1275
1276   if (!group)
1277     {
1278       g_set_error (error, G_KEY_FILE_ERROR,
1279                    G_KEY_FILE_ERROR_GROUP_NOT_FOUND,
1280                    _("Key file does not have group '%s'"),
1281                    group_name ? group_name : "(null)");
1282       return NULL;
1283     }
1284
1285   pair = g_key_file_lookup_key_value_pair (key_file, group, key);
1286
1287   if (pair)
1288     value = g_strdup (pair->value);
1289   else
1290     g_set_error (error, G_KEY_FILE_ERROR,
1291                  G_KEY_FILE_ERROR_KEY_NOT_FOUND,
1292                  _("Key file does not have key '%s'"), key);
1293
1294   return value;
1295 }
1296
1297 /**
1298  * g_key_file_set_value:
1299  * @key_file: a #GKeyFile
1300  * @group_name: a group name
1301  * @key: a key
1302  * @value: a string
1303  *
1304  * Associates a new value with @key under @group_name.
1305  *
1306  * If @key cannot be found then it is created. If @group_name cannot
1307  * be found then it is created. To set an UTF-8 string which may contain
1308  * characters that need escaping (such as newlines or spaces), use
1309  * g_key_file_set_string().
1310  *
1311  * Since: 2.6
1312  **/
1313 void
1314 g_key_file_set_value (GKeyFile    *key_file,
1315                       const gchar *group_name,
1316                       const gchar *key,
1317                       const gchar *value)
1318 {
1319   GKeyFileGroup *group;
1320   GKeyFileKeyValuePair *pair;
1321
1322   g_return_if_fail (key_file != NULL);
1323   g_return_if_fail (g_key_file_is_group_name (group_name));
1324   g_return_if_fail (g_key_file_is_key_name (key));
1325   g_return_if_fail (value != NULL);
1326
1327   group = g_key_file_lookup_group (key_file, group_name);
1328
1329   if (!group)
1330     {
1331       g_key_file_add_group (key_file, group_name);
1332       group = (GKeyFileGroup *) key_file->groups->data;
1333
1334       g_key_file_add_key (key_file, group, key, value);
1335     }
1336   else
1337     {
1338       pair = g_key_file_lookup_key_value_pair (key_file, group, key);
1339
1340       if (!pair)
1341         g_key_file_add_key (key_file, group, key, value);
1342       else
1343         {
1344           g_free (pair->value);
1345           pair->value = g_strdup (value);
1346         }
1347     }
1348 }
1349
1350 /**
1351  * g_key_file_get_string:
1352  * @key_file: a #GKeyFile
1353  * @group_name: a group name
1354  * @key: a key
1355  * @error: return location for a #GError, or %NULL
1356  *
1357  * Returns the string value associated with @key under @group_name.
1358  * Unlike g_key_file_get_value(), this function handles escape sequences
1359  * like \s.
1360  *
1361  * In the event the key cannot be found, %NULL is returned and
1362  * @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND.  In the
1363  * event that the @group_name cannot be found, %NULL is returned
1364  * and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
1365  *
1366  * Return value: a newly allocated string or %NULL if the specified
1367  *   key cannot be found.
1368  *
1369  * Since: 2.6
1370  **/
1371 gchar *
1372 g_key_file_get_string (GKeyFile     *key_file,
1373                        const gchar  *group_name,
1374                        const gchar  *key,
1375                        GError      **error)
1376 {
1377   gchar *value, *string_value;
1378   GError *key_file_error;
1379
1380   g_return_val_if_fail (key_file != NULL, NULL);
1381   g_return_val_if_fail (group_name != NULL, NULL);
1382   g_return_val_if_fail (key != NULL, NULL);
1383
1384   key_file_error = NULL;
1385
1386   value = g_key_file_get_value (key_file, group_name, key, &key_file_error);
1387
1388   if (key_file_error)
1389     {
1390       g_propagate_error (error, key_file_error);
1391       return NULL;
1392     }
1393
1394   if (!g_utf8_validate (value, -1, NULL))
1395     {
1396       gchar *value_utf8 = _g_utf8_make_valid (value);
1397       g_set_error (error, G_KEY_FILE_ERROR,
1398                    G_KEY_FILE_ERROR_UNKNOWN_ENCODING,
1399                    _("Key file contains key '%s' with value '%s' "
1400                      "which is not UTF-8"), key, value_utf8);
1401       g_free (value_utf8);
1402       g_free (value);
1403
1404       return NULL;
1405     }
1406
1407   string_value = g_key_file_parse_value_as_string (key_file, value, NULL,
1408                                                    &key_file_error);
1409   g_free (value);
1410
1411   if (key_file_error)
1412     {
1413       if (g_error_matches (key_file_error,
1414                            G_KEY_FILE_ERROR,
1415                            G_KEY_FILE_ERROR_INVALID_VALUE))
1416         {
1417           g_set_error (error, G_KEY_FILE_ERROR,
1418                        G_KEY_FILE_ERROR_INVALID_VALUE,
1419                        _("Key file contains key '%s' "
1420                          "which has value that cannot be interpreted."),
1421                        key);
1422           g_error_free (key_file_error);
1423         }
1424       else
1425         g_propagate_error (error, key_file_error);
1426     }
1427
1428   return string_value;
1429 }
1430
1431 /**
1432  * g_key_file_set_string:
1433  * @key_file: a #GKeyFile
1434  * @group_name: a group name
1435  * @key: a key
1436  * @string: a string
1437  *
1438  * Associates a new string value with @key under @group_name.
1439  * If @key cannot be found then it is created.
1440  * If @group_name cannot be found then it is created.
1441  * Unlike g_key_file_set_value(), this function handles characters
1442  * that need escaping, such as newlines.
1443  *
1444  * Since: 2.6
1445  **/
1446 void
1447 g_key_file_set_string (GKeyFile    *key_file,
1448                        const gchar *group_name,
1449                        const gchar *key,
1450                        const gchar *string)
1451 {
1452   gchar *value;
1453
1454   g_return_if_fail (key_file != NULL);
1455   g_return_if_fail (string != NULL);
1456
1457   value = g_key_file_parse_string_as_value (key_file, string, FALSE);
1458   g_key_file_set_value (key_file, group_name, key, value);
1459   g_free (value);
1460 }
1461
1462 /**
1463  * g_key_file_get_string_list:
1464  * @key_file: a #GKeyFile
1465  * @group_name: a group name
1466  * @key: a key
1467  * @length: return location for the number of returned strings, or %NULL
1468  * @error: return location for a #GError, or %NULL
1469  *
1470  * Returns the values associated with @key under @group_name.
1471  *
1472  * In the event the key cannot be found, %NULL is returned and
1473  * @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND.  In the
1474  * event that the @group_name cannot be found, %NULL is returned
1475  * and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
1476  *
1477  * Return value: a %NULL-terminated string array or %NULL if the specified
1478  *   key cannot be found. The array should be freed with g_strfreev().
1479  *
1480  * Since: 2.6
1481  **/
1482 gchar **
1483 g_key_file_get_string_list (GKeyFile     *key_file,
1484                             const gchar  *group_name,
1485                             const gchar  *key,
1486                             gsize        *length,
1487                             GError      **error)
1488 {
1489   GError *key_file_error = NULL;
1490   gchar *value, *string_value, **values;
1491   gint i, len;
1492   GSList *p, *pieces = NULL;
1493
1494   g_return_val_if_fail (key_file != NULL, NULL);
1495   g_return_val_if_fail (group_name != NULL, NULL);
1496   g_return_val_if_fail (key != NULL, NULL);
1497
1498   if (length)
1499     *length = 0;
1500
1501   value = g_key_file_get_value (key_file, group_name, key, &key_file_error);
1502
1503   if (key_file_error)
1504     {
1505       g_propagate_error (error, key_file_error);
1506       return NULL;
1507     }
1508
1509   if (!g_utf8_validate (value, -1, NULL))
1510     {
1511       gchar *value_utf8 = _g_utf8_make_valid (value);
1512       g_set_error (error, G_KEY_FILE_ERROR,
1513                    G_KEY_FILE_ERROR_UNKNOWN_ENCODING,
1514                    _("Key file contains key '%s' with value '%s' "
1515                      "which is not UTF-8"), key, value_utf8);
1516       g_free (value_utf8);
1517       g_free (value);
1518
1519       return NULL;
1520     }
1521
1522   string_value = g_key_file_parse_value_as_string (key_file, value, &pieces, &key_file_error);
1523   g_free (value);
1524   g_free (string_value);
1525
1526   if (key_file_error)
1527     {
1528       if (g_error_matches (key_file_error,
1529                            G_KEY_FILE_ERROR,
1530                            G_KEY_FILE_ERROR_INVALID_VALUE))
1531         {
1532           g_set_error (error, G_KEY_FILE_ERROR,
1533                        G_KEY_FILE_ERROR_INVALID_VALUE,
1534                        _("Key file contains key '%s' "
1535                          "which has a value that cannot be interpreted."),
1536                        key);
1537           g_error_free (key_file_error);
1538         }
1539       else
1540         g_propagate_error (error, key_file_error);
1541
1542       return NULL;
1543     }
1544
1545   len = g_slist_length (pieces);
1546   values = g_new (gchar *, len + 1);
1547   for (p = pieces, i = 0; p; p = p->next)
1548     values[i++] = p->data;
1549   values[len] = NULL;
1550
1551   g_slist_free (pieces);
1552
1553   if (length)
1554     *length = len;
1555
1556   return values;
1557 }
1558
1559 /**
1560  * g_key_file_set_string_list:
1561  * @key_file: a #GKeyFile
1562  * @group_name: a group name
1563  * @key: a key
1564  * @list: an array of string values
1565  * @length: number of string values in @list
1566  *
1567  * Associates a list of string values for @key under @group_name.
1568  * If @key cannot be found then it is created.
1569  * If @group_name cannot be found then it is created.
1570  *
1571  * Since: 2.6
1572  **/
1573 void
1574 g_key_file_set_string_list (GKeyFile            *key_file,
1575                             const gchar         *group_name,
1576                             const gchar         *key,
1577                             const gchar * const  list[],
1578                             gsize                length)
1579 {
1580   GString *value_list;
1581   gsize i;
1582
1583   g_return_if_fail (key_file != NULL);
1584   g_return_if_fail (list != NULL || length == 0);
1585
1586   value_list = g_string_sized_new (length * 128);
1587   for (i = 0; i < length && list[i] != NULL; i++)
1588     {
1589       gchar *value;
1590
1591       value = g_key_file_parse_string_as_value (key_file, list[i], TRUE);
1592       g_string_append (value_list, value);
1593       g_string_append_c (value_list, key_file->list_separator);
1594
1595       g_free (value);
1596     }
1597
1598   g_key_file_set_value (key_file, group_name, key, value_list->str);
1599   g_string_free (value_list, TRUE);
1600 }
1601
1602 /**
1603  * g_key_file_set_locale_string:
1604  * @key_file: a #GKeyFile
1605  * @group_name: a group name
1606  * @key: a key
1607  * @locale: a locale identifier
1608  * @string: a string
1609  *
1610  * Associates a string value for @key and @locale under @group_name.
1611  * If the translation for @key cannot be found then it is created.
1612  *
1613  * Since: 2.6
1614  **/
1615 void
1616 g_key_file_set_locale_string (GKeyFile     *key_file,
1617                               const gchar  *group_name,
1618                               const gchar  *key,
1619                               const gchar  *locale,
1620                               const gchar  *string)
1621 {
1622   gchar *full_key, *value;
1623
1624   g_return_if_fail (key_file != NULL);
1625   g_return_if_fail (key != NULL);
1626   g_return_if_fail (locale != NULL);
1627   g_return_if_fail (string != NULL);
1628
1629   value = g_key_file_parse_string_as_value (key_file, string, FALSE);
1630   full_key = g_strdup_printf ("%s[%s]", key, locale);
1631   g_key_file_set_value (key_file, group_name, full_key, value);
1632   g_free (full_key);
1633   g_free (value);
1634 }
1635
1636 /**
1637  * g_key_file_get_locale_string:
1638  * @key_file: a #GKeyFile
1639  * @group_name: a group name
1640  * @key: a key
1641  * @locale: a locale identifier or %NULL
1642  * @error: return location for a #GError, or %NULL
1643  *
1644  * Returns the value associated with @key under @group_name
1645  * translated in the given @locale if available.  If @locale is
1646  * %NULL then the current locale is assumed.
1647  *
1648  * If @key cannot be found then %NULL is returned and @error is set
1649  * to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the value associated
1650  * with @key cannot be interpreted or no suitable translation can
1651  * be found then the untranslated value is returned.
1652  *
1653  * Return value: a newly allocated string or %NULL if the specified
1654  *   key cannot be found.
1655  *
1656  * Since: 2.6
1657  **/
1658 gchar *
1659 g_key_file_get_locale_string (GKeyFile     *key_file,
1660                               const gchar  *group_name,
1661                               const gchar  *key,
1662                               const gchar  *locale,
1663                               GError      **error)
1664 {
1665   gchar *candidate_key, *translated_value;
1666   GError *key_file_error;
1667   gchar **languages;
1668   gboolean free_languages = FALSE;
1669   gint i;
1670
1671   g_return_val_if_fail (key_file != NULL, NULL);
1672   g_return_val_if_fail (group_name != NULL, NULL);
1673   g_return_val_if_fail (key != NULL, NULL);
1674
1675   candidate_key = NULL;
1676   translated_value = NULL;
1677   key_file_error = NULL;
1678
1679   if (locale)
1680     {
1681       languages = g_get_locale_variants (locale);
1682       free_languages = TRUE;
1683     }
1684   else
1685     {
1686       languages = (gchar **) g_get_language_names ();
1687       free_languages = FALSE;
1688     }
1689
1690   for (i = 0; languages[i]; i++)
1691     {
1692       candidate_key = g_strdup_printf ("%s[%s]", key, languages[i]);
1693
1694       translated_value = g_key_file_get_string (key_file,
1695                                                 group_name,
1696                                                 candidate_key, NULL);
1697       g_free (candidate_key);
1698
1699       if (translated_value)
1700         break;
1701
1702       g_free (translated_value);
1703       translated_value = NULL;
1704    }
1705
1706   /* Fallback to untranslated key
1707    */
1708   if (!translated_value)
1709     {
1710       translated_value = g_key_file_get_string (key_file, group_name, key,
1711                                                 &key_file_error);
1712
1713       if (!translated_value)
1714         g_propagate_error (error, key_file_error);
1715     }
1716
1717   if (free_languages)
1718     g_strfreev (languages);
1719
1720   return translated_value;
1721 }
1722
1723 /**
1724  * g_key_file_get_locale_string_list:
1725  * @key_file: a #GKeyFile
1726  * @group_name: a group name
1727  * @key: a key
1728  * @locale: a locale identifier or %NULL
1729  * @length: return location for the number of returned strings or %NULL
1730  * @error: return location for a #GError or %NULL
1731  *
1732  * Returns the values associated with @key under @group_name
1733  * translated in the given @locale if available.  If @locale is
1734  * %NULL then the current locale is assumed.
1735
1736  * If @key cannot be found then %NULL is returned and @error is set
1737  * to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the values associated
1738  * with @key cannot be interpreted or no suitable translations
1739  * can be found then the untranslated values are returned. The
1740  * returned array is %NULL-terminated, so @length may optionally
1741  * be %NULL.
1742  *
1743  * Return value: a newly allocated %NULL-terminated string array
1744  *   or %NULL if the key isn't found. The string array should be freed
1745  *   with g_strfreev().
1746  *
1747  * Since: 2.6
1748  **/
1749 gchar **
1750 g_key_file_get_locale_string_list (GKeyFile     *key_file,
1751                                    const gchar  *group_name,
1752                                    const gchar  *key,
1753                                    const gchar  *locale,
1754                                    gsize        *length,
1755                                    GError      **error)
1756 {
1757   GError *key_file_error;
1758   gchar **values, *value;
1759   char list_separator[2];
1760   gsize len;
1761
1762   g_return_val_if_fail (key_file != NULL, NULL);
1763   g_return_val_if_fail (group_name != NULL, NULL);
1764   g_return_val_if_fail (key != NULL, NULL);
1765
1766   key_file_error = NULL;
1767
1768   value = g_key_file_get_locale_string (key_file, group_name,
1769                                         key, locale,
1770                                         &key_file_error);
1771
1772   if (key_file_error)
1773     g_propagate_error (error, key_file_error);
1774
1775   if (!value)
1776     {
1777       if (length)
1778         *length = 0;
1779       return NULL;
1780     }
1781
1782   len = strlen (value);
1783   if (value[len - 1] == key_file->list_separator)
1784     value[len - 1] = '\0';
1785
1786   list_separator[0] = key_file->list_separator;
1787   list_separator[1] = '\0';
1788   values = g_strsplit (value, list_separator, 0);
1789
1790   g_free (value);
1791
1792   if (length)
1793     *length = g_strv_length (values);
1794
1795   return values;
1796 }
1797
1798 /**
1799  * g_key_file_set_locale_string_list:
1800  * @key_file: a #GKeyFile
1801  * @group_name: a group name
1802  * @key: a key
1803  * @locale: a locale identifier
1804  * @list: a %NULL-terminated array of locale string values
1805  * @length: the length of @list
1806  *
1807  * Associates a list of string values for @key and @locale under
1808  * @group_name.  If the translation for @key cannot be found then
1809  * it is created.
1810  *
1811  * Since: 2.6
1812  **/
1813 void
1814 g_key_file_set_locale_string_list (GKeyFile            *key_file,
1815                                    const gchar         *group_name,
1816                                    const gchar         *key,
1817                                    const gchar         *locale,
1818                                    const gchar * const  list[],
1819                                    gsize                length)
1820 {
1821   GString *value_list;
1822   gchar *full_key;
1823   gsize i;
1824
1825   g_return_if_fail (key_file != NULL);
1826   g_return_if_fail (key != NULL);
1827   g_return_if_fail (locale != NULL);
1828   g_return_if_fail (length != 0);
1829
1830   value_list = g_string_sized_new (length * 128);
1831   for (i = 0; i < length && list[i] != NULL; i++)
1832     {
1833       gchar *value;
1834
1835       value = g_key_file_parse_string_as_value (key_file, list[i], TRUE);
1836       g_string_append (value_list, value);
1837       g_string_append_c (value_list, key_file->list_separator);
1838
1839       g_free (value);
1840     }
1841
1842   full_key = g_strdup_printf ("%s[%s]", key, locale);
1843   g_key_file_set_value (key_file, group_name, full_key, value_list->str);
1844   g_free (full_key);
1845   g_string_free (value_list, TRUE);
1846 }
1847
1848 /**
1849  * g_key_file_get_boolean:
1850  * @key_file: a #GKeyFile
1851  * @group_name: a group name
1852  * @key: a key
1853  * @error: return location for a #GError
1854  *
1855  * Returns the value associated with @key under @group_name as a
1856  * boolean.
1857  *
1858  * If @key cannot be found then %FALSE is returned and @error is set
1859  * to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value
1860  * associated with @key cannot be interpreted as a boolean then %FALSE
1861  * is returned and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
1862  *
1863  * Return value: the value associated with the key as a boolean,
1864  *    or %FALSE if the key was not found or could not be parsed.
1865  *
1866  * Since: 2.6
1867  **/
1868 gboolean
1869 g_key_file_get_boolean (GKeyFile     *key_file,
1870                         const gchar  *group_name,
1871                         const gchar  *key,
1872                         GError      **error)
1873 {
1874   GError *key_file_error = NULL;
1875   gchar *value;
1876   gboolean bool_value;
1877
1878   g_return_val_if_fail (key_file != NULL, FALSE);
1879   g_return_val_if_fail (group_name != NULL, FALSE);
1880   g_return_val_if_fail (key != NULL, FALSE);
1881
1882   value = g_key_file_get_value (key_file, group_name, key, &key_file_error);
1883
1884   if (!value)
1885     {
1886       g_propagate_error (error, key_file_error);
1887       return FALSE;
1888     }
1889
1890   bool_value = g_key_file_parse_value_as_boolean (key_file, value,
1891                                                   &key_file_error);
1892   g_free (value);
1893
1894   if (key_file_error)
1895     {
1896       if (g_error_matches (key_file_error,
1897                            G_KEY_FILE_ERROR,
1898                            G_KEY_FILE_ERROR_INVALID_VALUE))
1899         {
1900           g_set_error (error, G_KEY_FILE_ERROR,
1901                        G_KEY_FILE_ERROR_INVALID_VALUE,
1902                        _("Key file contains key '%s' "
1903                          "which has value that cannot be interpreted."),
1904                        key);
1905           g_error_free (key_file_error);
1906         }
1907       else
1908         g_propagate_error (error, key_file_error);
1909     }
1910
1911   return bool_value;
1912 }
1913
1914 /**
1915  * g_key_file_set_boolean:
1916  * @key_file: a #GKeyFile
1917  * @group_name: a group name
1918  * @key: a key
1919  * @value: %TRUE or %FALSE
1920  *
1921  * Associates a new boolean value with @key under @group_name.
1922  * If @key cannot be found then it is created.
1923  *
1924  * Since: 2.6
1925  **/
1926 void
1927 g_key_file_set_boolean (GKeyFile    *key_file,
1928                         const gchar *group_name,
1929                         const gchar *key,
1930                         gboolean     value)
1931 {
1932   gchar *result;
1933
1934   g_return_if_fail (key_file != NULL);
1935
1936   result = g_key_file_parse_boolean_as_value (key_file, value);
1937   g_key_file_set_value (key_file, group_name, key, result);
1938   g_free (result);
1939 }
1940
1941 /**
1942  * g_key_file_get_boolean_list:
1943  * @key_file: a #GKeyFile
1944  * @group_name: a group name
1945  * @key: a key
1946  * @length: the number of booleans returned
1947  * @error: return location for a #GError
1948  *
1949  * Returns the values associated with @key under @group_name as
1950  * booleans.
1951  *
1952  * If @key cannot be found then %NULL is returned and @error is set to
1953  * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated
1954  * with @key cannot be interpreted as booleans then %NULL is returned
1955  * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
1956  *
1957  * Return value: the values associated with the key as a list of
1958  *    booleans, or %NULL if the key was not found or could not be parsed.
1959  *
1960  * Since: 2.6
1961  **/
1962 gboolean *
1963 g_key_file_get_boolean_list (GKeyFile     *key_file,
1964                              const gchar  *group_name,
1965                              const gchar  *key,
1966                              gsize        *length,
1967                              GError      **error)
1968 {
1969   GError *key_file_error;
1970   gchar **values;
1971   gboolean *bool_values;
1972   gsize i, num_bools;
1973
1974   g_return_val_if_fail (key_file != NULL, NULL);
1975   g_return_val_if_fail (group_name != NULL, NULL);
1976   g_return_val_if_fail (key != NULL, NULL);
1977
1978   if (length)
1979     *length = 0;
1980
1981   key_file_error = NULL;
1982
1983   values = g_key_file_get_string_list (key_file, group_name, key,
1984                                        &num_bools, &key_file_error);
1985
1986   if (key_file_error)
1987     g_propagate_error (error, key_file_error);
1988
1989   if (!values)
1990     return NULL;
1991
1992   bool_values = g_new (gboolean, num_bools);
1993
1994   for (i = 0; i < num_bools; i++)
1995     {
1996       bool_values[i] = g_key_file_parse_value_as_boolean (key_file,
1997                                                           values[i],
1998                                                           &key_file_error);
1999
2000       if (key_file_error)
2001         {
2002           g_propagate_error (error, key_file_error);
2003           g_strfreev (values);
2004           g_free (bool_values);
2005
2006           return NULL;
2007         }
2008     }
2009   g_strfreev (values);
2010
2011   if (length)
2012     *length = num_bools;
2013
2014   return bool_values;
2015 }
2016
2017 /**
2018  * g_key_file_set_boolean_list:
2019  * @key_file: a #GKeyFile
2020  * @group_name: a group name
2021  * @key: a key
2022  * @list: an array of boolean values
2023  * @length: length of @list
2024  *
2025  * Associates a list of boolean values with @key under @group_name.
2026  * If @key cannot be found then it is created.
2027  * If @group_name is %NULL, the start_group is used.
2028  *
2029  * Since: 2.6
2030  **/
2031 void
2032 g_key_file_set_boolean_list (GKeyFile    *key_file,
2033                              const gchar *group_name,
2034                              const gchar *key,
2035                              gboolean     list[],
2036                              gsize        length)
2037 {
2038   GString *value_list;
2039   gsize i;
2040
2041   g_return_if_fail (key_file != NULL);
2042   g_return_if_fail (list != NULL);
2043
2044   value_list = g_string_sized_new (length * 8);
2045   for (i = 0; i < length; i++)
2046     {
2047       gchar *value;
2048
2049       value = g_key_file_parse_boolean_as_value (key_file, list[i]);
2050
2051       g_string_append (value_list, value);
2052       g_string_append_c (value_list, key_file->list_separator);
2053
2054       g_free (value);
2055     }
2056
2057   g_key_file_set_value (key_file, group_name, key, value_list->str);
2058   g_string_free (value_list, TRUE);
2059 }
2060
2061 /**
2062  * g_key_file_get_integer:
2063  * @key_file: a #GKeyFile
2064  * @group_name: a group name
2065  * @key: a key
2066  * @error: return location for a #GError
2067  *
2068  * Returns the value associated with @key under @group_name as an
2069  * integer.
2070  *
2071  * If @key cannot be found then 0 is returned and @error is set to
2072  * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value associated
2073  * with @key cannot be interpreted as an integer then 0 is returned
2074  * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
2075  *
2076  * Return value: the value associated with the key as an integer, or
2077  *     0 if the key was not found or could not be parsed.
2078  *
2079  * Since: 2.6
2080  **/
2081 gint
2082 g_key_file_get_integer (GKeyFile     *key_file,
2083                         const gchar  *group_name,
2084                         const gchar  *key,
2085                         GError      **error)
2086 {
2087   GError *key_file_error;
2088   gchar *value;
2089   gint int_value;
2090
2091   g_return_val_if_fail (key_file != NULL, -1);
2092   g_return_val_if_fail (group_name != NULL, -1);
2093   g_return_val_if_fail (key != NULL, -1);
2094
2095   key_file_error = NULL;
2096
2097   value = g_key_file_get_value (key_file, group_name, key, &key_file_error);
2098
2099   if (key_file_error)
2100     {
2101       g_propagate_error (error, key_file_error);
2102       return 0;
2103     }
2104
2105   int_value = g_key_file_parse_value_as_integer (key_file, value,
2106                                                  &key_file_error);
2107   g_free (value);
2108
2109   if (key_file_error)
2110     {
2111       if (g_error_matches (key_file_error,
2112                            G_KEY_FILE_ERROR,
2113                            G_KEY_FILE_ERROR_INVALID_VALUE))
2114         {
2115           g_set_error (error, G_KEY_FILE_ERROR,
2116                        G_KEY_FILE_ERROR_INVALID_VALUE,
2117                        _("Key file contains key '%s' in group '%s' "
2118                          "which has value that cannot be interpreted."), key,
2119                        group_name);
2120           g_error_free (key_file_error);
2121         }
2122       else
2123         g_propagate_error (error, key_file_error);
2124     }
2125
2126   return int_value;
2127 }
2128
2129 /**
2130  * g_key_file_set_integer:
2131  * @key_file: a #GKeyFile
2132  * @group_name: a group name
2133  * @key: a key
2134  * @value: an integer value
2135  *
2136  * Associates a new integer value with @key under @group_name.
2137  * If @key cannot be found then it is created.
2138  *
2139  * Since: 2.6
2140  **/
2141 void
2142 g_key_file_set_integer (GKeyFile    *key_file,
2143                         const gchar *group_name,
2144                         const gchar *key,
2145                         gint         value)
2146 {
2147   gchar *result;
2148
2149   g_return_if_fail (key_file != NULL);
2150
2151   result = g_key_file_parse_integer_as_value (key_file, value);
2152   g_key_file_set_value (key_file, group_name, key, result);
2153   g_free (result);
2154 }
2155
2156 /**
2157  * g_key_file_get_int64:
2158  * @key_file: a non-%NULL #GKeyFile
2159  * @group_name: a non-%NULL group name
2160  * @key: a non-%NULL key
2161  * @error: return location for a #GError
2162  *
2163  * Returns the value associated with @key under @group_name as a signed
2164  * 64-bit integer. This is similar to g_key_file_get_integer() but can return
2165  * 64-bit results without truncation.
2166  *
2167  * Returns: the value associated with the key as a signed 64-bit integer, or
2168  * 0 if the key was not found or could not be parsed.
2169  *
2170  * Since: 2.26
2171  */
2172 gint64
2173 g_key_file_get_int64 (GKeyFile     *key_file,
2174                       const gchar  *group_name,
2175                       const gchar  *key,
2176                       GError      **error)
2177 {
2178   gchar *s, *end;
2179   gint64 v;
2180
2181   g_return_val_if_fail (key_file != NULL, -1);
2182   g_return_val_if_fail (group_name != NULL, -1);
2183   g_return_val_if_fail (key != NULL, -1);
2184
2185   s = g_key_file_get_value (key_file, group_name, key, error);
2186
2187   if (s == NULL)
2188     return 0;
2189
2190   v = g_ascii_strtoll (s, &end, 10);
2191
2192   if (*s == '\0' || *end != '\0')
2193     {
2194       g_set_error (error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_INVALID_VALUE,
2195           "Key '%s' in group '%s' has value '%s' where int64 was expected",
2196           key, group_name, s);
2197       return 0;
2198     }
2199
2200   g_free (s);
2201   return v;
2202 }
2203
2204 /**
2205  * g_key_file_set_int64:
2206  * @key_file: a #GKeyFile
2207  * @group_name: a group name
2208  * @key: a key
2209  * @value: an integer value
2210  *
2211  * Associates a new integer value with @key under @group_name.
2212  * If @key cannot be found then it is created.
2213  *
2214  * Since: 2.26
2215  **/
2216 void
2217 g_key_file_set_int64 (GKeyFile    *key_file,
2218                       const gchar *group_name,
2219                       const gchar *key,
2220                       gint64       value)
2221 {
2222   gchar *result;
2223
2224   g_return_if_fail (key_file != NULL);
2225
2226   result = g_strdup_printf ("%" G_GINT64_FORMAT, value);
2227   g_key_file_set_value (key_file, group_name, key, result);
2228   g_free (result);
2229 }
2230
2231 /**
2232  * g_key_file_get_uint64:
2233  * @key_file: a non-%NULL #GKeyFile
2234  * @group_name: a non-%NULL group name
2235  * @key: a non-%NULL key
2236  * @error: return location for a #GError
2237  *
2238  * Returns the value associated with @key under @group_name as an unsigned
2239  * 64-bit integer. This is similar to g_key_file_get_integer() but can return
2240  * large positive results without truncation.
2241  *
2242  * Returns: the value associated with the key as an unsigned 64-bit integer,
2243  * or 0 if the key was not found or could not be parsed.
2244  *
2245  * Since: 2.26
2246  */
2247 guint64
2248 g_key_file_get_uint64 (GKeyFile     *key_file,
2249                        const gchar  *group_name,
2250                        const gchar  *key,
2251                        GError      **error)
2252 {
2253   gchar *s, *end;
2254   guint64 v;
2255
2256   g_return_val_if_fail (key_file != NULL, -1);
2257   g_return_val_if_fail (group_name != NULL, -1);
2258   g_return_val_if_fail (key != NULL, -1);
2259
2260   s = g_key_file_get_value (key_file, group_name, key, error);
2261
2262   if (s == NULL)
2263     return 0;
2264
2265   v = g_ascii_strtoull (s, &end, 10);
2266
2267   if (*s == '\0' || *end != '\0')
2268     {
2269       g_set_error (error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_INVALID_VALUE,
2270           "Key '%s' in group '%s' has value '%s' where uint64 was expected",
2271           key, group_name, s);
2272       return 0;
2273     }
2274
2275   g_free (s);
2276   return v;
2277 }
2278
2279 /**
2280  * g_key_file_set_uint64:
2281  * @key_file: a #GKeyFile
2282  * @group_name: a group name
2283  * @key: a key
2284  * @value: an integer value
2285  *
2286  * Associates a new integer value with @key under @group_name.
2287  * If @key cannot be found then it is created.
2288  *
2289  * Since: 2.26
2290  **/
2291 void
2292 g_key_file_set_uint64 (GKeyFile    *key_file,
2293                        const gchar *group_name,
2294                        const gchar *key,
2295                        guint64      value)
2296 {
2297   gchar *result;
2298
2299   g_return_if_fail (key_file != NULL);
2300
2301   result = g_strdup_printf ("%" G_GUINT64_FORMAT, value);
2302   g_key_file_set_value (key_file, group_name, key, result);
2303   g_free (result);
2304 }
2305
2306 /**
2307  * g_key_file_get_integer_list:
2308  * @key_file: a #GKeyFile
2309  * @group_name: a group name
2310  * @key: a key
2311  * @length: the number of integers returned
2312  * @error: return location for a #GError
2313  *
2314  * Returns the values associated with @key under @group_name as
2315  * integers.
2316  *
2317  * If @key cannot be found then %NULL is returned and @error is set to
2318  * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated
2319  * with @key cannot be interpreted as integers then %NULL is returned
2320  * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
2321  *
2322  * Return value: the values associated with the key as a list of
2323  *     integers, or %NULL if the key was not found or could not be parsed.
2324  *
2325  * Since: 2.6
2326  **/
2327 gint *
2328 g_key_file_get_integer_list (GKeyFile     *key_file,
2329                              const gchar  *group_name,
2330                              const gchar  *key,
2331                              gsize        *length,
2332                              GError      **error)
2333 {
2334   GError *key_file_error = NULL;
2335   gchar **values;
2336   gint *int_values;
2337   gsize i, num_ints;
2338
2339   g_return_val_if_fail (key_file != NULL, NULL);
2340   g_return_val_if_fail (group_name != NULL, NULL);
2341   g_return_val_if_fail (key != NULL, NULL);
2342
2343   if (length)
2344     *length = 0;
2345
2346   values = g_key_file_get_string_list (key_file, group_name, key,
2347                                        &num_ints, &key_file_error);
2348
2349   if (key_file_error)
2350     g_propagate_error (error, key_file_error);
2351
2352   if (!values)
2353     return NULL;
2354
2355   int_values = g_new (gint, num_ints);
2356
2357   for (i = 0; i < num_ints; i++)
2358     {
2359       int_values[i] = g_key_file_parse_value_as_integer (key_file,
2360                                                          values[i],
2361                                                          &key_file_error);
2362
2363       if (key_file_error)
2364         {
2365           g_propagate_error (error, key_file_error);
2366           g_strfreev (values);
2367           g_free (int_values);
2368
2369           return NULL;
2370         }
2371     }
2372   g_strfreev (values);
2373
2374   if (length)
2375     *length = num_ints;
2376
2377   return int_values;
2378 }
2379
2380 /**
2381  * g_key_file_set_integer_list:
2382  * @key_file: a #GKeyFile
2383  * @group_name: a group name
2384  * @key: a key
2385  * @list: an array of integer values
2386  * @length: number of integer values in @list
2387  *
2388  * Associates a list of integer values with @key under @group_name.
2389  * If @key cannot be found then it is created.
2390  *
2391  * Since: 2.6
2392  **/
2393 void
2394 g_key_file_set_integer_list (GKeyFile    *key_file,
2395                              const gchar *group_name,
2396                              const gchar *key,
2397                              gint         list[],
2398                              gsize        length)
2399 {
2400   GString *values;
2401   gsize i;
2402
2403   g_return_if_fail (key_file != NULL);
2404   g_return_if_fail (list != NULL);
2405
2406   values = g_string_sized_new (length * 16);
2407   for (i = 0; i < length; i++)
2408     {
2409       gchar *value;
2410
2411       value = g_key_file_parse_integer_as_value (key_file, list[i]);
2412
2413       g_string_append (values, value);
2414       g_string_append_c (values, key_file->list_separator);
2415
2416       g_free (value);
2417     }
2418
2419   g_key_file_set_value (key_file, group_name, key, values->str);
2420   g_string_free (values, TRUE);
2421 }
2422
2423 /**
2424  * g_key_file_get_double:
2425  * @key_file: a #GKeyFile
2426  * @group_name: a group name
2427  * @key: a key
2428  * @error: return location for a #GError
2429  *
2430  * Returns the value associated with @key under @group_name as a
2431  * double. If @group_name is %NULL, the start_group is used.
2432  *
2433  * If @key cannot be found then 0.0 is returned and @error is set to
2434  * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value associated
2435  * with @key cannot be interpreted as a double then 0.0 is returned
2436  * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
2437  *
2438  * Return value: the value associated with the key as a double, or
2439  *     0.0 if the key was not found or could not be parsed.
2440  *
2441  * Since: 2.12
2442  **/
2443 gdouble
2444 g_key_file_get_double  (GKeyFile     *key_file,
2445                         const gchar  *group_name,
2446                         const gchar  *key,
2447                         GError      **error)
2448 {
2449   GError *key_file_error;
2450   gchar *value;
2451   gdouble double_value;
2452
2453   g_return_val_if_fail (key_file != NULL, -1);
2454   g_return_val_if_fail (group_name != NULL, -1);
2455   g_return_val_if_fail (key != NULL, -1);
2456
2457   key_file_error = NULL;
2458
2459   value = g_key_file_get_value (key_file, group_name, key, &key_file_error);
2460
2461   if (key_file_error)
2462     {
2463       g_propagate_error (error, key_file_error);
2464       return 0;
2465     }
2466
2467   double_value = g_key_file_parse_value_as_double (key_file, value,
2468                                                   &key_file_error);
2469   g_free (value);
2470
2471   if (key_file_error)
2472     {
2473       if (g_error_matches (key_file_error,
2474                            G_KEY_FILE_ERROR,
2475                            G_KEY_FILE_ERROR_INVALID_VALUE))
2476         {
2477           g_set_error (error, G_KEY_FILE_ERROR,
2478                        G_KEY_FILE_ERROR_INVALID_VALUE,
2479                        _("Key file contains key '%s' in group '%s' "
2480                          "which has value that cannot be interpreted."), key,
2481                        group_name);
2482           g_error_free (key_file_error);
2483         }
2484       else
2485         g_propagate_error (error, key_file_error);
2486     }
2487
2488   return double_value;
2489 }
2490
2491 /**
2492  * g_key_file_set_double:
2493  * @key_file: a #GKeyFile
2494  * @group_name: a group name
2495  * @key: a key
2496  * @value: an double value
2497  *
2498  * Associates a new double value with @key under @group_name.
2499  * If @key cannot be found then it is created.
2500  *
2501  * Since: 2.12
2502  **/
2503 void
2504 g_key_file_set_double  (GKeyFile    *key_file,
2505                         const gchar *group_name,
2506                         const gchar *key,
2507                         gdouble      value)
2508 {
2509   gchar result[G_ASCII_DTOSTR_BUF_SIZE];
2510
2511   g_return_if_fail (key_file != NULL);
2512
2513   g_ascii_dtostr (result, sizeof (result), value);
2514   g_key_file_set_value (key_file, group_name, key, result);
2515 }
2516
2517 /**
2518  * g_key_file_get_double_list:
2519  * @key_file: a #GKeyFile
2520  * @group_name: a group name
2521  * @key: a key
2522  * @length: the number of doubles returned
2523  * @error: return location for a #GError
2524  *
2525  * Returns the values associated with @key under @group_name as
2526  * doubles.
2527  *
2528  * If @key cannot be found then %NULL is returned and @error is set to
2529  * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated
2530  * with @key cannot be interpreted as doubles then %NULL is returned
2531  * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
2532  *
2533  * Return value: the values associated with the key as a list of
2534  *     doubles, or %NULL if the key was not found or could not be parsed.
2535  *
2536  * Since: 2.12
2537  **/
2538 gdouble *
2539 g_key_file_get_double_list  (GKeyFile     *key_file,
2540                              const gchar  *group_name,
2541                              const gchar  *key,
2542                              gsize        *length,
2543                              GError      **error)
2544 {
2545   GError *key_file_error = NULL;
2546   gchar **values;
2547   gdouble *double_values;
2548   gsize i, num_doubles;
2549
2550   g_return_val_if_fail (key_file != NULL, NULL);
2551   g_return_val_if_fail (group_name != NULL, NULL);
2552   g_return_val_if_fail (key != NULL, NULL);
2553
2554   if (length)
2555     *length = 0;
2556
2557   values = g_key_file_get_string_list (key_file, group_name, key,
2558                                        &num_doubles, &key_file_error);
2559
2560   if (key_file_error)
2561     g_propagate_error (error, key_file_error);
2562
2563   if (!values)
2564     return NULL;
2565
2566   double_values = g_new (gdouble, num_doubles);
2567
2568   for (i = 0; i < num_doubles; i++)
2569     {
2570       double_values[i] = g_key_file_parse_value_as_double (key_file,
2571                                                            values[i],
2572                                                            &key_file_error);
2573
2574       if (key_file_error)
2575         {
2576           g_propagate_error (error, key_file_error);
2577           g_strfreev (values);
2578           g_free (double_values);
2579
2580           return NULL;
2581         }
2582     }
2583   g_strfreev (values);
2584
2585   if (length)
2586     *length = num_doubles;
2587
2588   return double_values;
2589 }
2590
2591 /**
2592  * g_key_file_set_double_list:
2593  * @key_file: a #GKeyFile
2594  * @group_name: a group name
2595  * @key: a key
2596  * @list: an array of double values
2597  * @length: number of double values in @list
2598  *
2599  * Associates a list of double values with @key under
2600  * @group_name.  If @key cannot be found then it is created.
2601  *
2602  * Since: 2.12
2603  **/
2604 void
2605 g_key_file_set_double_list (GKeyFile    *key_file,
2606                             const gchar *group_name,
2607                             const gchar *key,
2608                             gdouble      list[],
2609                             gsize        length)
2610 {
2611   GString *values;
2612   gsize i;
2613
2614   g_return_if_fail (key_file != NULL);
2615   g_return_if_fail (list != NULL);
2616
2617   values = g_string_sized_new (length * 16);
2618   for (i = 0; i < length; i++)
2619     {
2620       gchar result[G_ASCII_DTOSTR_BUF_SIZE];
2621
2622       g_ascii_dtostr( result, sizeof (result), list[i] );
2623
2624       g_string_append (values, result);
2625       g_string_append_c (values, key_file->list_separator);
2626     }
2627
2628   g_key_file_set_value (key_file, group_name, key, values->str);
2629   g_string_free (values, TRUE);
2630 }
2631
2632 static gboolean
2633 g_key_file_set_key_comment (GKeyFile     *key_file,
2634                             const gchar  *group_name,
2635                             const gchar  *key,
2636                             const gchar  *comment,
2637                             GError      **error)
2638 {
2639   GKeyFileGroup *group;
2640   GKeyFileKeyValuePair *pair;
2641   GList *key_node, *comment_node, *tmp;
2642
2643   group = g_key_file_lookup_group (key_file, group_name);
2644   if (!group)
2645     {
2646       g_set_error (error, G_KEY_FILE_ERROR,
2647                    G_KEY_FILE_ERROR_GROUP_NOT_FOUND,
2648                    _("Key file does not have group '%s'"),
2649                    group_name ? group_name : "(null)");
2650
2651       return FALSE;
2652     }
2653
2654   /* First find the key the comments are supposed to be
2655    * associated with
2656    */
2657   key_node = g_key_file_lookup_key_value_pair_node (key_file, group, key);
2658
2659   if (key_node == NULL)
2660     {
2661       g_set_error (error, G_KEY_FILE_ERROR,
2662                    G_KEY_FILE_ERROR_KEY_NOT_FOUND,
2663                    _("Key file does not have key '%s' in group '%s'"),
2664                    key, group->name);
2665       return FALSE;
2666     }
2667
2668   /* Then find all the comments already associated with the
2669    * key and free them
2670    */
2671   tmp = key_node->next;
2672   while (tmp != NULL)
2673     {
2674       pair = (GKeyFileKeyValuePair *) tmp->data;
2675
2676       if (pair->key != NULL)
2677         break;
2678
2679       comment_node = tmp;
2680       tmp = tmp->next;
2681       g_key_file_remove_key_value_pair_node (key_file, group,
2682                                              comment_node);
2683     }
2684
2685   if (comment == NULL)
2686     return TRUE;
2687
2688   /* Now we can add our new comment
2689    */
2690   pair = g_slice_new (GKeyFileKeyValuePair);
2691   pair->key = NULL;
2692   pair->value = g_key_file_parse_comment_as_value (key_file, comment);
2693
2694   key_node = g_list_insert (key_node, pair, 1);
2695
2696   return TRUE;
2697 }
2698
2699 static gboolean
2700 g_key_file_set_group_comment (GKeyFile     *key_file,
2701                               const gchar  *group_name,
2702                               const gchar  *comment,
2703                               GError      **error)
2704 {
2705   GKeyFileGroup *group;
2706
2707   g_return_val_if_fail (g_key_file_is_group_name (group_name), FALSE);
2708
2709   group = g_key_file_lookup_group (key_file, group_name);
2710   if (!group)
2711     {
2712       g_set_error (error, G_KEY_FILE_ERROR,
2713                    G_KEY_FILE_ERROR_GROUP_NOT_FOUND,
2714                    _("Key file does not have group '%s'"),
2715                    group_name ? group_name : "(null)");
2716
2717       return FALSE;
2718     }
2719
2720   /* First remove any existing comment
2721    */
2722   if (group->comment)
2723     {
2724       g_key_file_key_value_pair_free (group->comment);
2725       group->comment = NULL;
2726     }
2727
2728   if (comment == NULL)
2729     return TRUE;
2730
2731   /* Now we can add our new comment
2732    */
2733   group->comment = g_slice_new (GKeyFileKeyValuePair);
2734   group->comment->key = NULL;
2735   group->comment->value = g_key_file_parse_comment_as_value (key_file, comment);
2736
2737   return TRUE;
2738 }
2739
2740 static gboolean
2741 g_key_file_set_top_comment (GKeyFile     *key_file,
2742                             const gchar  *comment,
2743                             GError      **error)
2744 {
2745   GList *group_node;
2746   GKeyFileGroup *group;
2747   GKeyFileKeyValuePair *pair;
2748
2749   /* The last group in the list should be the top (comments only)
2750    * group in the file
2751    */
2752   g_warn_if_fail (key_file->groups != NULL);
2753   group_node = g_list_last (key_file->groups);
2754   group = (GKeyFileGroup *) group_node->data;
2755   g_warn_if_fail (group->name == NULL);
2756
2757   /* Note all keys must be comments at the top of
2758    * the file, so we can just free it all.
2759    */
2760   if (group->key_value_pairs != NULL)
2761     {
2762       g_list_foreach (group->key_value_pairs,
2763                       (GFunc) g_key_file_key_value_pair_free,
2764                       NULL);
2765       g_list_free (group->key_value_pairs);
2766       group->key_value_pairs = NULL;
2767     }
2768
2769   if (comment == NULL)
2770      return TRUE;
2771
2772   pair = g_slice_new (GKeyFileKeyValuePair);
2773   pair->key = NULL;
2774   pair->value = g_key_file_parse_comment_as_value (key_file, comment);
2775
2776   group->key_value_pairs =
2777     g_list_prepend (group->key_value_pairs, pair);
2778
2779   return TRUE;
2780 }
2781
2782 /**
2783  * g_key_file_set_comment:
2784  * @key_file: a #GKeyFile
2785  * @group_name: a group name, or %NULL
2786  * @key: a key
2787  * @comment: a comment
2788  * @error: return location for a #GError
2789  *
2790  * Places a comment above @key from @group_name.
2791  * If @key is %NULL then @comment will be written above @group_name.
2792  * If both @key and @group_name  are %NULL, then @comment will be
2793  * written above the first group in the file.
2794  *
2795  * Returns: %TRUE if the comment was written, %FALSE otherwise
2796  *
2797  * Since: 2.6
2798  **/
2799 gboolean
2800 g_key_file_set_comment (GKeyFile     *key_file,
2801                         const gchar  *group_name,
2802                         const gchar  *key,
2803                         const gchar  *comment,
2804                         GError      **error)
2805 {
2806   g_return_val_if_fail (key_file != NULL, FALSE);
2807
2808   if (group_name != NULL && key != NULL)
2809     {
2810       if (!g_key_file_set_key_comment (key_file, group_name, key, comment, error))
2811         return FALSE;
2812     }
2813   else if (group_name != NULL)
2814     {
2815       if (!g_key_file_set_group_comment (key_file, group_name, comment, error))
2816         return FALSE;
2817     }
2818   else
2819     {
2820       if (!g_key_file_set_top_comment (key_file, comment, error))
2821         return FALSE;
2822     }
2823
2824   if (comment != NULL)
2825     key_file->approximate_size += strlen (comment);
2826
2827   return TRUE;
2828 }
2829
2830 static gchar *
2831 g_key_file_get_key_comment (GKeyFile     *key_file,
2832                             const gchar  *group_name,
2833                             const gchar  *key,
2834                             GError      **error)
2835 {
2836   GKeyFileGroup *group;
2837   GKeyFileKeyValuePair *pair;
2838   GList *key_node, *tmp;
2839   GString *string;
2840   gchar *comment;
2841
2842   g_return_val_if_fail (g_key_file_is_group_name (group_name), NULL);
2843
2844   group = g_key_file_lookup_group (key_file, group_name);
2845   if (!group)
2846     {
2847       g_set_error (error, G_KEY_FILE_ERROR,
2848                    G_KEY_FILE_ERROR_GROUP_NOT_FOUND,
2849                    _("Key file does not have group '%s'"),
2850                    group_name ? group_name : "(null)");
2851
2852       return NULL;
2853     }
2854
2855   /* First find the key the comments are supposed to be
2856    * associated with
2857    */
2858   key_node = g_key_file_lookup_key_value_pair_node (key_file, group, key);
2859
2860   if (key_node == NULL)
2861     {
2862       g_set_error (error, G_KEY_FILE_ERROR,
2863                    G_KEY_FILE_ERROR_KEY_NOT_FOUND,
2864                    _("Key file does not have key '%s' in group '%s'"),
2865                    key, group->name);
2866       return NULL;
2867     }
2868
2869   string = NULL;
2870
2871   /* Then find all the comments already associated with the
2872    * key and concatentate them.
2873    */
2874   tmp = key_node->next;
2875   if (!key_node->next)
2876     return NULL;
2877
2878   pair = (GKeyFileKeyValuePair *) tmp->data;
2879   if (pair->key != NULL)
2880     return NULL;
2881
2882   while (tmp->next)
2883     {
2884       pair = (GKeyFileKeyValuePair *) tmp->next->data;
2885
2886       if (pair->key != NULL)
2887         break;
2888
2889       tmp = tmp->next;
2890     }
2891
2892   while (tmp != key_node)
2893     {
2894       pair = (GKeyFileKeyValuePair *) tmp->data;
2895
2896       if (string == NULL)
2897         string = g_string_sized_new (512);
2898
2899       comment = g_key_file_parse_value_as_comment (key_file, pair->value);
2900       g_string_append (string, comment);
2901       g_free (comment);
2902
2903       tmp = tmp->prev;
2904     }
2905
2906   if (string != NULL)
2907     {
2908       comment = string->str;
2909       g_string_free (string, FALSE);
2910     }
2911   else
2912     comment = NULL;
2913
2914   return comment;
2915 }
2916
2917 static gchar *
2918 get_group_comment (GKeyFile       *key_file,
2919                    GKeyFileGroup  *group,
2920                    GError        **error)
2921 {
2922   GString *string;
2923   GList *tmp;
2924   gchar *comment;
2925
2926   string = NULL;
2927
2928   tmp = group->key_value_pairs;
2929   while (tmp)
2930     {
2931       GKeyFileKeyValuePair *pair;
2932
2933       pair = (GKeyFileKeyValuePair *) tmp->data;
2934
2935       if (pair->key != NULL)
2936         {
2937           tmp = tmp->prev;
2938           break;
2939         }
2940
2941       if (tmp->next == NULL)
2942         break;
2943
2944       tmp = tmp->next;
2945     }
2946
2947   while (tmp != NULL)
2948     {
2949       GKeyFileKeyValuePair *pair;
2950
2951       pair = (GKeyFileKeyValuePair *) tmp->data;
2952
2953       if (string == NULL)
2954         string = g_string_sized_new (512);
2955
2956       comment = g_key_file_parse_value_as_comment (key_file, pair->value);
2957       g_string_append (string, comment);
2958       g_free (comment);
2959
2960       tmp = tmp->prev;
2961     }
2962
2963   if (string != NULL)
2964     return g_string_free (string, FALSE);
2965
2966   return NULL;
2967 }
2968
2969 static gchar *
2970 g_key_file_get_group_comment (GKeyFile     *key_file,
2971                               const gchar  *group_name,
2972                               GError      **error)
2973 {
2974   GList *group_node;
2975   GKeyFileGroup *group;
2976
2977   group = g_key_file_lookup_group (key_file, group_name);
2978   if (!group)
2979     {
2980       g_set_error (error, G_KEY_FILE_ERROR,
2981                    G_KEY_FILE_ERROR_GROUP_NOT_FOUND,
2982                    _("Key file does not have group '%s'"),
2983                    group_name ? group_name : "(null)");
2984
2985       return NULL;
2986     }
2987
2988   if (group->comment)
2989     return g_strdup (group->comment->value);
2990
2991   group_node = g_key_file_lookup_group_node (key_file, group_name);
2992   group_node = group_node->next;
2993   group = (GKeyFileGroup *)group_node->data;
2994   return get_group_comment (key_file, group, error);
2995 }
2996
2997 static gchar *
2998 g_key_file_get_top_comment (GKeyFile  *key_file,
2999                             GError   **error)
3000 {
3001   GList *group_node;
3002   GKeyFileGroup *group;
3003
3004   /* The last group in the list should be the top (comments only)
3005    * group in the file
3006    */
3007   g_warn_if_fail (key_file->groups != NULL);
3008   group_node = g_list_last (key_file->groups);
3009   group = (GKeyFileGroup *) group_node->data;
3010   g_warn_if_fail (group->name == NULL);
3011
3012   return get_group_comment (key_file, group, error);
3013 }
3014
3015 /**
3016  * g_key_file_get_comment:
3017  * @key_file: a #GKeyFile
3018  * @group_name: a group name, or %NULL
3019  * @key: a key
3020  * @error: return location for a #GError
3021  *
3022  * Retrieves a comment above @key from @group_name.
3023  * If @key is %NULL then @comment will be read from above
3024  * @group_name. If both @key and @group_name are %NULL, then
3025  * @comment will be read from above the first group in the file.
3026  *
3027  * Returns: a comment that should be freed with g_free()
3028  *
3029  * Since: 2.6
3030  **/
3031 gchar *
3032 g_key_file_get_comment (GKeyFile     *key_file,
3033                         const gchar  *group_name,
3034                         const gchar  *key,
3035                         GError      **error)
3036 {
3037   g_return_val_if_fail (key_file != NULL, NULL);
3038
3039   if (group_name != NULL && key != NULL)
3040     return g_key_file_get_key_comment (key_file, group_name, key, error);
3041   else if (group_name != NULL)
3042     return g_key_file_get_group_comment (key_file, group_name, error);
3043   else
3044     return g_key_file_get_top_comment (key_file, error);
3045 }
3046
3047 /**
3048  * g_key_file_remove_comment:
3049  * @key_file: a #GKeyFile
3050  * @group_name: a group name, or %NULL
3051  * @key: a key
3052  * @error: return location for a #GError
3053  *
3054  * Removes a comment above @key from @group_name.
3055  * If @key is %NULL then @comment will be removed above @group_name.
3056  * If both @key and @group_name are %NULL, then @comment will
3057  * be removed above the first group in the file.
3058  *
3059  * Returns: %TRUE if the comment was removed, %FALSE otherwise
3060  *
3061  * Since: 2.6
3062  **/
3063
3064 gboolean
3065 g_key_file_remove_comment (GKeyFile     *key_file,
3066                            const gchar  *group_name,
3067                            const gchar  *key,
3068                            GError      **error)
3069 {
3070   g_return_val_if_fail (key_file != NULL, FALSE);
3071
3072   if (group_name != NULL && key != NULL)
3073     return g_key_file_set_key_comment (key_file, group_name, key, NULL, error);
3074   else if (group_name != NULL)
3075     return g_key_file_set_group_comment (key_file, group_name, NULL, error);
3076   else
3077     return g_key_file_set_top_comment (key_file, NULL, error);
3078 }
3079
3080 /**
3081  * g_key_file_has_group:
3082  * @key_file: a #GKeyFile
3083  * @group_name: a group name
3084  *
3085  * Looks whether the key file has the group @group_name.
3086  *
3087  * Return value: %TRUE if @group_name is a part of @key_file, %FALSE
3088  * otherwise.
3089  * Since: 2.6
3090  **/
3091 gboolean
3092 g_key_file_has_group (GKeyFile    *key_file,
3093                       const gchar *group_name)
3094 {
3095   g_return_val_if_fail (key_file != NULL, FALSE);
3096   g_return_val_if_fail (group_name != NULL, FALSE);
3097
3098   return g_key_file_lookup_group (key_file, group_name) != NULL;
3099 }
3100
3101 /**
3102  * g_key_file_has_key:
3103  * @key_file: a #GKeyFile
3104  * @group_name: a group name
3105  * @key: a key name
3106  * @error: return location for a #GError
3107  *
3108  * Looks whether the key file has the key @key in the group
3109  * @group_name.
3110  *
3111  * Return value: %TRUE if @key is a part of @group_name, %FALSE
3112  * otherwise.
3113  *
3114  * Since: 2.6
3115  **/
3116 gboolean
3117 g_key_file_has_key (GKeyFile     *key_file,
3118                     const gchar  *group_name,
3119                     const gchar  *key,
3120                     GError      **error)
3121 {
3122   GKeyFileKeyValuePair *pair;
3123   GKeyFileGroup *group;
3124
3125   g_return_val_if_fail (key_file != NULL, FALSE);
3126   g_return_val_if_fail (group_name != NULL, FALSE);
3127   g_return_val_if_fail (key != NULL, FALSE);
3128
3129   group = g_key_file_lookup_group (key_file, group_name);
3130
3131   if (!group)
3132     {
3133       g_set_error (error, G_KEY_FILE_ERROR,
3134                    G_KEY_FILE_ERROR_GROUP_NOT_FOUND,
3135                    _("Key file does not have group '%s'"),
3136                    group_name ? group_name : "(null)");
3137
3138       return FALSE;
3139     }
3140
3141   pair = g_key_file_lookup_key_value_pair (key_file, group, key);
3142
3143   return pair != NULL;
3144 }
3145
3146 static void
3147 g_key_file_add_group (GKeyFile    *key_file,
3148                       const gchar *group_name)
3149 {
3150   GKeyFileGroup *group;
3151
3152   g_return_if_fail (key_file != NULL);
3153   g_return_if_fail (g_key_file_is_group_name (group_name));
3154
3155   group = g_key_file_lookup_group (key_file, group_name);
3156   if (group != NULL)
3157     {
3158       key_file->current_group = group;
3159       return;
3160     }
3161
3162   group = g_slice_new0 (GKeyFileGroup);
3163   group->name = g_strdup (group_name);
3164   group->lookup_map = g_hash_table_new (g_str_hash, g_str_equal);
3165   key_file->groups = g_list_prepend (key_file->groups, group);
3166   key_file->approximate_size += strlen (group_name) + 3;
3167   key_file->current_group = group;
3168
3169   if (key_file->start_group == NULL)
3170     key_file->start_group = group;
3171
3172   g_hash_table_insert (key_file->group_hash, (gpointer)group->name, group);
3173 }
3174
3175 static void
3176 g_key_file_key_value_pair_free (GKeyFileKeyValuePair *pair)
3177 {
3178   if (pair != NULL)
3179     {
3180       g_free (pair->key);
3181       g_free (pair->value);
3182       g_slice_free (GKeyFileKeyValuePair, pair);
3183     }
3184 }
3185
3186 /* Be careful not to call this function on a node with data in the
3187  * lookup map without removing it from the lookup map, first.
3188  *
3189  * Some current cases where this warning is not a concern are
3190  * when:
3191  *   - the node being removed is a comment node
3192  *   - the entire lookup map is getting destroyed soon after
3193  *     anyway.
3194  */
3195 static void
3196 g_key_file_remove_key_value_pair_node (GKeyFile      *key_file,
3197                                        GKeyFileGroup *group,
3198                                        GList         *pair_node)
3199 {
3200
3201   GKeyFileKeyValuePair *pair;
3202
3203   pair = (GKeyFileKeyValuePair *) pair_node->data;
3204
3205   group->key_value_pairs = g_list_remove_link (group->key_value_pairs, pair_node);
3206
3207   if (pair->key != NULL)
3208     key_file->approximate_size -= strlen (pair->key) + 1;
3209
3210   g_warn_if_fail (pair->value != NULL);
3211   key_file->approximate_size -= strlen (pair->value);
3212
3213   g_key_file_key_value_pair_free (pair);
3214
3215   g_list_free_1 (pair_node);
3216 }
3217
3218 static void
3219 g_key_file_remove_group_node (GKeyFile *key_file,
3220                               GList    *group_node)
3221 {
3222   GKeyFileGroup *group;
3223   GList *tmp;
3224
3225   group = (GKeyFileGroup *) group_node->data;
3226
3227   if (group->name)
3228     g_hash_table_remove (key_file->group_hash, group->name);
3229
3230   /* If the current group gets deleted make the current group the last
3231    * added group.
3232    */
3233   if (key_file->current_group == group)
3234     {
3235       /* groups should always contain at least the top comment group,
3236        * unless g_key_file_clear has been called
3237        */
3238       if (key_file->groups)
3239         key_file->current_group = (GKeyFileGroup *) key_file->groups->data;
3240       else
3241         key_file->current_group = NULL;
3242     }
3243
3244   /* If the start group gets deleted make the start group the first
3245    * added group.
3246    */
3247   if (key_file->start_group == group)
3248     {
3249       tmp = g_list_last (key_file->groups);
3250       while (tmp != NULL)
3251         {
3252           if (tmp != group_node &&
3253               ((GKeyFileGroup *) tmp->data)->name != NULL)
3254             break;
3255
3256           tmp = tmp->prev;
3257         }
3258
3259       if (tmp)
3260         key_file->start_group = (GKeyFileGroup *) tmp->data;
3261       else
3262         key_file->start_group = NULL;
3263     }
3264
3265   key_file->groups = g_list_remove_link (key_file->groups, group_node);
3266
3267   if (group->name != NULL)
3268     key_file->approximate_size -= strlen (group->name) + 3;
3269
3270   tmp = group->key_value_pairs;
3271   while (tmp != NULL)
3272     {
3273       GList *pair_node;
3274
3275       pair_node = tmp;
3276       tmp = tmp->next;
3277       g_key_file_remove_key_value_pair_node (key_file, group, pair_node);
3278     }
3279
3280   g_warn_if_fail (group->key_value_pairs == NULL);
3281
3282   if (group->lookup_map)
3283     {
3284       g_hash_table_destroy (group->lookup_map);
3285       group->lookup_map = NULL;
3286     }
3287
3288   g_free ((gchar *) group->name);
3289   g_slice_free (GKeyFileGroup, group);
3290   g_list_free_1 (group_node);
3291 }
3292
3293 /**
3294  * g_key_file_remove_group:
3295  * @key_file: a #GKeyFile
3296  * @group_name: a group name
3297  * @error: return location for a #GError or %NULL
3298  *
3299  * Removes the specified group, @group_name,
3300  * from the key file.
3301  *
3302  * Returns: %TRUE if the group was removed, %FALSE otherwise
3303  *
3304  * Since: 2.6
3305  **/
3306 gboolean
3307 g_key_file_remove_group (GKeyFile     *key_file,
3308                          const gchar  *group_name,
3309                          GError      **error)
3310 {
3311   GList *group_node;
3312
3313   g_return_val_if_fail (key_file != NULL, FALSE);
3314   g_return_val_if_fail (group_name != NULL, FALSE);
3315
3316   group_node = g_key_file_lookup_group_node (key_file, group_name);
3317
3318   if (!group_node)
3319     {
3320       g_set_error (error, G_KEY_FILE_ERROR,
3321                    G_KEY_FILE_ERROR_GROUP_NOT_FOUND,
3322                    _("Key file does not have group '%s'"),
3323                    group_name);
3324       return FALSE;
3325     }
3326
3327   g_key_file_remove_group_node (key_file, group_node);
3328
3329   return TRUE;
3330 }
3331
3332 static void
3333 g_key_file_add_key (GKeyFile      *key_file,
3334                     GKeyFileGroup *group,
3335                     const gchar   *key,
3336                     const gchar   *value)
3337 {
3338   GKeyFileKeyValuePair *pair;
3339
3340   pair = g_slice_new (GKeyFileKeyValuePair);
3341   pair->key = g_strdup (key);
3342   pair->value = g_strdup (value);
3343
3344   g_hash_table_replace (group->lookup_map, pair->key, pair);
3345   group->key_value_pairs = g_list_prepend (group->key_value_pairs, pair);
3346   group->has_trailing_blank_line = FALSE;
3347   key_file->approximate_size += strlen (key) + strlen (value) + 2;
3348 }
3349
3350 /**
3351  * g_key_file_remove_key:
3352  * @key_file: a #GKeyFile
3353  * @group_name: a group name
3354  * @key: a key name to remove
3355  * @error: return location for a #GError or %NULL
3356  *
3357  * Removes @key in @group_name from the key file.
3358  *
3359  * Returns: %TRUE if the key was removed, %FALSE otherwise
3360  *
3361  * Since: 2.6
3362  **/
3363 gboolean
3364 g_key_file_remove_key (GKeyFile     *key_file,
3365                        const gchar  *group_name,
3366                        const gchar  *key,
3367                        GError      **error)
3368 {
3369   GKeyFileGroup *group;
3370   GKeyFileKeyValuePair *pair;
3371
3372   g_return_val_if_fail (key_file != NULL, FALSE);
3373   g_return_val_if_fail (group_name != NULL, FALSE);
3374   g_return_val_if_fail (key != NULL, FALSE);
3375
3376   pair = NULL;
3377
3378   group = g_key_file_lookup_group (key_file, group_name);
3379   if (!group)
3380     {
3381       g_set_error (error, G_KEY_FILE_ERROR,
3382                    G_KEY_FILE_ERROR_GROUP_NOT_FOUND,
3383                    _("Key file does not have group '%s'"),
3384                    group_name ? group_name : "(null)");
3385       return FALSE;
3386     }
3387
3388   pair = g_key_file_lookup_key_value_pair (key_file, group, key);
3389
3390   if (!pair)
3391     {
3392       g_set_error (error, G_KEY_FILE_ERROR,
3393                    G_KEY_FILE_ERROR_KEY_NOT_FOUND,
3394                    _("Key file does not have key '%s' in group '%s'"),
3395                    key, group->name);
3396       return FALSE;
3397     }
3398
3399   key_file->approximate_size -= strlen (pair->key) + strlen (pair->value) + 2;
3400
3401   group->key_value_pairs = g_list_remove (group->key_value_pairs, pair);
3402   g_hash_table_remove (group->lookup_map, pair->key);
3403   g_key_file_key_value_pair_free (pair);
3404
3405   return TRUE;
3406 }
3407
3408 static GList *
3409 g_key_file_lookup_group_node (GKeyFile    *key_file,
3410                               const gchar *group_name)
3411 {
3412   GKeyFileGroup *group;
3413   GList *tmp;
3414
3415   for (tmp = key_file->groups; tmp != NULL; tmp = tmp->next)
3416     {
3417       group = (GKeyFileGroup *) tmp->data;
3418
3419       if (group && group->name && strcmp (group->name, group_name) == 0)
3420         break;
3421     }
3422
3423   return tmp;
3424 }
3425
3426 static GKeyFileGroup *
3427 g_key_file_lookup_group (GKeyFile    *key_file,
3428                          const gchar *group_name)
3429 {
3430   return (GKeyFileGroup *)g_hash_table_lookup (key_file->group_hash, group_name);
3431 }
3432
3433 static GList *
3434 g_key_file_lookup_key_value_pair_node (GKeyFile       *key_file,
3435                                        GKeyFileGroup  *group,
3436                                        const gchar    *key)
3437 {
3438   GList *key_node;
3439
3440   for (key_node = group->key_value_pairs;
3441        key_node != NULL;
3442        key_node = key_node->next)
3443     {
3444       GKeyFileKeyValuePair *pair;
3445
3446       pair = (GKeyFileKeyValuePair *) key_node->data;
3447
3448       if (pair->key && strcmp (pair->key, key) == 0)
3449         break;
3450     }
3451
3452   return key_node;
3453 }
3454
3455 static GKeyFileKeyValuePair *
3456 g_key_file_lookup_key_value_pair (GKeyFile      *key_file,
3457                                   GKeyFileGroup *group,
3458                                   const gchar   *key)
3459 {
3460   return (GKeyFileKeyValuePair *) g_hash_table_lookup (group->lookup_map, key);
3461 }
3462
3463 /* Lines starting with # or consisting entirely of whitespace are merely
3464  * recorded, not parsed. This function assumes all leading whitespace
3465  * has been stripped.
3466  */
3467 static gboolean
3468 g_key_file_line_is_comment (const gchar *line)
3469 {
3470   return (*line == '#' || *line == '\0' || *line == '\n');
3471 }
3472
3473 static gboolean
3474 g_key_file_is_group_name (const gchar *name)
3475 {
3476   gchar *p, *q;
3477
3478   if (name == NULL)
3479     return FALSE;
3480
3481   p = q = (gchar *) name;
3482   while (*q && *q != ']' && *q != '[' && !g_ascii_iscntrl (*q))
3483     q = g_utf8_find_next_char (q, NULL);
3484
3485   if (*q != '\0' || q == p)
3486     return FALSE;
3487
3488   return TRUE;
3489 }
3490
3491 static gboolean
3492 g_key_file_is_key_name (const gchar *name)
3493 {
3494   gchar *p, *q;
3495
3496   if (name == NULL)
3497     return FALSE;
3498
3499   p = q = (gchar *) name;
3500   /* We accept a little more than the desktop entry spec says,
3501    * since gnome-vfs uses mime-types as keys in its cache.
3502    */
3503   while (*q && *q != '=' && *q != '[' && *q != ']')
3504     q = g_utf8_find_next_char (q, NULL);
3505
3506   /* No empty keys, please */
3507   if (q == p)
3508     return FALSE;
3509
3510   /* We accept spaces in the middle of keys to not break
3511    * existing apps, but we don't tolerate initial or final
3512    * spaces, which would lead to silent corruption when
3513    * rereading the file.
3514    */
3515   if (*p == ' ' || q[-1] == ' ')
3516     return FALSE;
3517
3518   if (*q == '[')
3519     {
3520       q++;
3521       while (*q && (g_unichar_isalnum (g_utf8_get_char_validated (q, -1)) || *q == '-' || *q == '_' || *q == '.' || *q == '@'))
3522         q = g_utf8_find_next_char (q, NULL);
3523
3524       if (*q != ']')
3525         return FALSE;
3526
3527       q++;
3528     }
3529
3530   if (*q != '\0')
3531     return FALSE;
3532
3533   return TRUE;
3534 }
3535
3536 /* A group in a key file is made up of a starting '[' followed by one
3537  * or more letters making up the group name followed by ']'.
3538  */
3539 static gboolean
3540 g_key_file_line_is_group (const gchar *line)
3541 {
3542   gchar *p;
3543
3544   p = (gchar *) line;
3545   if (*p != '[')
3546     return FALSE;
3547
3548   p++;
3549
3550   while (*p && *p != ']')
3551     p = g_utf8_find_next_char (p, NULL);
3552
3553   if (*p != ']')
3554     return FALSE;
3555
3556   /* silently accept whitespace after the ] */
3557   p = g_utf8_find_next_char (p, NULL);
3558   while (*p == ' ' || *p == '\t')
3559     p = g_utf8_find_next_char (p, NULL);
3560
3561   if (*p)
3562     return FALSE;
3563
3564   return TRUE;
3565 }
3566
3567 static gboolean
3568 g_key_file_line_is_key_value_pair (const gchar *line)
3569 {
3570   gchar *p;
3571
3572   p = (gchar *) g_utf8_strchr (line, -1, '=');
3573
3574   if (!p)
3575     return FALSE;
3576
3577   /* Key must be non-empty
3578    */
3579   if (*p == line[0])
3580     return FALSE;
3581
3582   return TRUE;
3583 }
3584
3585 static gchar *
3586 g_key_file_parse_value_as_string (GKeyFile     *key_file,
3587                                   const gchar  *value,
3588                                   GSList      **pieces,
3589                                   GError      **error)
3590 {
3591   gchar *string_value, *p, *q0, *q;
3592
3593   string_value = g_new (gchar, strlen (value) + 1);
3594
3595   p = (gchar *) value;
3596   q0 = q = string_value;
3597   while (*p)
3598     {
3599       if (*p == '\\')
3600         {
3601           p++;
3602
3603           switch (*p)
3604             {
3605             case 's':
3606               *q = ' ';
3607               break;
3608
3609             case 'n':
3610               *q = '\n';
3611               break;
3612
3613             case 't':
3614               *q = '\t';
3615               break;
3616
3617             case 'r':
3618               *q = '\r';
3619               break;
3620
3621             case '\\':
3622               *q = '\\';
3623               break;
3624
3625             case '\0':
3626               g_set_error_literal (error, G_KEY_FILE_ERROR,
3627                                    G_KEY_FILE_ERROR_INVALID_VALUE,
3628                                    _("Key file contains escape character "
3629                                      "at end of line"));
3630               break;
3631
3632             default:
3633               if (pieces && *p == key_file->list_separator)
3634                 *q = key_file->list_separator;
3635               else
3636                 {
3637                   *q++ = '\\';
3638                   *q = *p;
3639
3640                   if (*error == NULL)
3641                     {
3642                       gchar sequence[3];
3643
3644                       sequence[0] = '\\';
3645                       sequence[1] = *p;
3646                       sequence[2] = '\0';
3647
3648                       g_set_error (error, G_KEY_FILE_ERROR,
3649                                    G_KEY_FILE_ERROR_INVALID_VALUE,
3650                                    _("Key file contains invalid escape "
3651                                      "sequence '%s'"), sequence);
3652                     }
3653                 }
3654               break;
3655             }
3656         }
3657       else
3658         {
3659           *q = *p;
3660           if (pieces && (*p == key_file->list_separator))
3661             {
3662               *pieces = g_slist_prepend (*pieces, g_strndup (q0, q - q0));
3663               q0 = q + 1;
3664             }
3665         }
3666
3667       if (*p == '\0')
3668         break;
3669
3670       q++;
3671       p++;
3672     }
3673
3674   *q = '\0';
3675   if (pieces)
3676   {
3677     if (q0 < q)
3678       *pieces = g_slist_prepend (*pieces, g_strndup (q0, q - q0));
3679     *pieces = g_slist_reverse (*pieces);
3680   }
3681
3682   return string_value;
3683 }
3684
3685 static gchar *
3686 g_key_file_parse_string_as_value (GKeyFile    *key_file,
3687                                   const gchar *string,
3688                                   gboolean     escape_separator)
3689 {
3690   gchar *value, *p, *q;
3691   gsize length;
3692   gboolean parsing_leading_space;
3693
3694   length = strlen (string) + 1;
3695
3696   /* Worst case would be that every character needs to be escaped.
3697    * In other words every character turns to two characters
3698    */
3699   value = g_new (gchar, 2 * length);
3700
3701   p = (gchar *) string;
3702   q = value;
3703   parsing_leading_space = TRUE;
3704   while (p < (string + length - 1))
3705     {
3706       gchar escaped_character[3] = { '\\', 0, 0 };
3707
3708       switch (*p)
3709         {
3710         case ' ':
3711           if (parsing_leading_space)
3712             {
3713               escaped_character[1] = 's';
3714               strcpy (q, escaped_character);
3715               q += 2;
3716             }
3717           else
3718             {
3719               *q = *p;
3720               q++;
3721             }
3722           break;
3723         case '\t':
3724           if (parsing_leading_space)
3725             {
3726               escaped_character[1] = 't';
3727               strcpy (q, escaped_character);
3728               q += 2;
3729             }
3730           else
3731             {
3732               *q = *p;
3733               q++;
3734             }
3735           break;
3736         case '\n':
3737           escaped_character[1] = 'n';
3738           strcpy (q, escaped_character);
3739           q += 2;
3740           break;
3741         case '\r':
3742           escaped_character[1] = 'r';
3743           strcpy (q, escaped_character);
3744           q += 2;
3745           break;
3746         case '\\':
3747           escaped_character[1] = '\\';
3748           strcpy (q, escaped_character);
3749           q += 2;
3750           parsing_leading_space = FALSE;
3751           break;
3752         default:
3753           if (escape_separator && *p == key_file->list_separator)
3754             {
3755               escaped_character[1] = key_file->list_separator;
3756               strcpy (q, escaped_character);
3757               q += 2;
3758               parsing_leading_space = TRUE;
3759             }
3760           else
3761             {
3762               *q = *p;
3763               q++;
3764               parsing_leading_space = FALSE;
3765             }
3766           break;
3767         }
3768       p++;
3769     }
3770   *q = '\0';
3771
3772   return value;
3773 }
3774
3775 static gint
3776 g_key_file_parse_value_as_integer (GKeyFile     *key_file,
3777                                    const gchar  *value,
3778                                    GError      **error)
3779 {
3780   gchar *end_of_valid_int;
3781  glong long_value;
3782   gint int_value;
3783
3784   errno = 0;
3785   long_value = strtol (value, &end_of_valid_int, 10);
3786
3787   if (*value == '\0' || *end_of_valid_int != '\0')
3788     {
3789       gchar *value_utf8 = _g_utf8_make_valid (value);
3790       g_set_error (error, G_KEY_FILE_ERROR,
3791                    G_KEY_FILE_ERROR_INVALID_VALUE,
3792                    _("Value '%s' cannot be interpreted "
3793                      "as a number."), value_utf8);
3794       g_free (value_utf8);
3795
3796       return 0;
3797     }
3798
3799   int_value = long_value;
3800   if (int_value != long_value || errno == ERANGE)
3801     {
3802       gchar *value_utf8 = _g_utf8_make_valid (value);
3803       g_set_error (error,
3804                    G_KEY_FILE_ERROR,
3805                    G_KEY_FILE_ERROR_INVALID_VALUE,
3806                    _("Integer value '%s' out of range"),
3807                    value_utf8);
3808       g_free (value_utf8);
3809
3810       return 0;
3811     }
3812
3813   return int_value;
3814 }
3815
3816 static gchar *
3817 g_key_file_parse_integer_as_value (GKeyFile *key_file,
3818                                    gint      value)
3819
3820 {
3821   return g_strdup_printf ("%d", value);
3822 }
3823
3824 static gdouble
3825 g_key_file_parse_value_as_double  (GKeyFile     *key_file,
3826                                    const gchar  *value,
3827                                    GError      **error)
3828 {
3829   gchar *end_of_valid_d;
3830   gdouble double_value = 0;
3831
3832   double_value = g_ascii_strtod (value, &end_of_valid_d);
3833
3834   if (*end_of_valid_d != '\0' || end_of_valid_d == value)
3835     {
3836       gchar *value_utf8 = _g_utf8_make_valid (value);
3837       g_set_error (error, G_KEY_FILE_ERROR,
3838                    G_KEY_FILE_ERROR_INVALID_VALUE,
3839                    _("Value '%s' cannot be interpreted "
3840                      "as a float number."),
3841                    value_utf8);
3842       g_free (value_utf8);
3843     }
3844
3845   return double_value;
3846 }
3847
3848 static gboolean
3849 g_key_file_parse_value_as_boolean (GKeyFile     *key_file,
3850                                    const gchar  *value,
3851                                    GError      **error)
3852 {
3853   gchar *value_utf8;
3854
3855   if (strcmp (value, "true") == 0 || strcmp (value, "1") == 0)
3856     return TRUE;
3857   else if (strcmp (value, "false") == 0 || strcmp (value, "0") == 0)
3858     return FALSE;
3859
3860   value_utf8 = _g_utf8_make_valid (value);
3861   g_set_error (error, G_KEY_FILE_ERROR,
3862                G_KEY_FILE_ERROR_INVALID_VALUE,
3863                _("Value '%s' cannot be interpreted "
3864                  "as a boolean."), value_utf8);
3865   g_free (value_utf8);
3866
3867   return FALSE;
3868 }
3869
3870 static gchar *
3871 g_key_file_parse_boolean_as_value (GKeyFile *key_file,
3872                                    gboolean  value)
3873 {
3874   if (value)
3875     return g_strdup ("true");
3876   else
3877     return g_strdup ("false");
3878 }
3879
3880 static gchar *
3881 g_key_file_parse_value_as_comment (GKeyFile    *key_file,
3882                                    const gchar *value)
3883 {
3884   GString *string;
3885   gchar **lines;
3886   gsize i;
3887
3888   string = g_string_sized_new (512);
3889
3890   lines = g_strsplit (value, "\n", 0);
3891
3892   for (i = 0; lines[i] != NULL; i++)
3893     {
3894         if (lines[i][0] != '#')
3895            g_string_append_printf (string, "%s\n", lines[i]);
3896         else
3897            g_string_append_printf (string, "%s\n", lines[i] + 1);
3898     }
3899   g_strfreev (lines);
3900
3901   return g_string_free (string, FALSE);
3902 }
3903
3904 static gchar *
3905 g_key_file_parse_comment_as_value (GKeyFile      *key_file,
3906                                    const gchar   *comment)
3907 {
3908   GString *string;
3909   gchar **lines;
3910   gsize i;
3911
3912   string = g_string_sized_new (512);
3913
3914   lines = g_strsplit (comment, "\n", 0);
3915
3916   for (i = 0; lines[i] != NULL; i++)
3917     g_string_append_printf (string, "#%s%s", lines[i],
3918                             lines[i + 1] == NULL? "" : "\n");
3919   g_strfreev (lines);
3920
3921   return g_string_free (string, FALSE);
3922 }