glib/gkeyfile.c

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