glib/gkeyfile.c

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