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