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