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