/* gkeyfile.c - key file parser

*

* Copyright 2004 Red Hat, Inc.

* Copyright 2009-2010 Collabora Ltd.

* Copyright 2009 Nokia Corporation

*

* Written by Ray Strode <rstrode@redhat.com>

* Matthias Clasen <mclasen@redhat.com>

*

* SPDX-License-Identifier: LGPL-2.1-or-later

*

* This library is free software; you can redistribute it and/or

* modify it under the terms of the GNU Lesser General Public

* License as published by the Free Software Foundation; either

* version 2.1 of the License, or (at your option) any later version.

*

* This library is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

* Lesser General Public License for more details.

*

* You should have received a copy of the GNU Lesser General Public License

* along with this library; if not, see <http://www.gnu.org/licenses/>.

*/

#include "config.h"

#include "gkeyfile.h"

#include "gutils.h"

#include <errno.h>

#include <fcntl.h>

#include <locale.h>

#include <string.h>

#include <stdio.h>

#include <stdlib.h>

#include <sys/types.h>

#include <sys/stat.h>

#ifdef G_OS_UNIX

#include <unistd.h>

#endif

#ifdef G_OS_WIN32

#include <io.h>

#undef fstat

#define fstat(a,b) _fstati64(a,b)

#undef stat

#define stat _stati64

#ifndef S_ISREG

#define S_ISREG(mode) ((mode)&_S_IFREG)

#endif

#endif /* G_OS_WIN23 */

#ifndef O_CLOEXEC

#define O_CLOEXEC 0

#endif

#include "gconvert.h"

#include "gdataset.h"

#include "gerror.h"

#include "gfileutils.h"

#include "ghash.h"

#include "glibintl.h"

#include "glist.h"

#include "gslist.h"

#include "gmem.h"

#include "gmessages.h"

#include "gstdio.h"

#include "gstring.h"

#include "gstrfuncs.h"

#include "gutils.h"

/**

* GKeyFile:

*

* `GKeyFile` parses .ini-like config files.

*

* `GKeyFile` lets you parse, edit or create files containing groups of

* key-value pairs, which we call ‘key files’ for lack of a better name.

* Several freedesktop.org specifications use key files. For example, the

* [Desktop Entry Specification](https://specifications.freedesktop.org/desktop-entry-spec/latest/)

* and the [Icon Theme Specification](https://specifications.freedesktop.org/icon-theme-spec/latest/).

*

* The syntax of key files is described in detail in the

* [Desktop Entry Specification](https://specifications.freedesktop.org/desktop-entry-spec/latest/),

* here is a quick summary: Key files consists of groups of key-value pairs, interspersed

* with comments.

*

* ```txt

* # this is just an example

* # there can be comments before the first group

*

* [First Group]

*

* Name=Key File Example\tthis value shows\nescaping

*

* # localized strings are stored in multiple key-value pairs

* Welcome=Hello

* Welcome[de]=Hallo

* Welcome[fr_FR]=Bonjour

* Welcome[it]=Ciao

*

* [Another Group]

*

* Numbers=2;20;-200;0

*

* Booleans=true;false;true;true

* ```

*

* Lines beginning with a `#` and blank lines are considered comments.

*

* Groups are started by a header line containing the group name enclosed

* in `[` and `]`, and ended implicitly by the start of the next group or

* the end of the file. Each key-value pair must be contained in a group.

*

* Key-value pairs generally have the form `key=value`, with the exception

* of localized strings, which have the form `key[locale]=value`, with a

* locale identifier of the form `lang_COUNTRY@MODIFIER` where `COUNTRY`

* and `MODIFIER` are optional. As a special case, the locale `C` is associated

* with the untranslated pair `key=value` (since GLib 2.84). Space before and

* after the `=` character is ignored. Newline, tab, carriage return and

* backslash characters in value are escaped as `\n`, `\t`, `\r`, and `\\\\`,

* respectively. To preserve leading spaces in values, these can also be escaped

* as `\s`.

*

* Key files can store strings (possibly with localized variants), integers,

* booleans and lists of these. Lists are separated by a separator character,

* typically `;` or `,`. To use the list separator character in a value in

* a list, it has to be escaped by prefixing it with a backslash.

*

* This syntax is obviously inspired by the .ini files commonly met

* on Windows, but there are some important differences:

*

* - .ini files use the `;` character to begin comments,

* key files use the `#` character.

*

* - Key files do not allow for ungrouped keys meaning only

* comments can precede the first group.

*

* - Key files are always encoded in UTF-8.

*

* - Key and Group names are case-sensitive. For example, a group called

* `[GROUP]` is a different from `[group]`.

*

* - .ini files don’t have a strongly typed boolean entry type,

* they only have `GetProfileInt()`. In key files, only

* `true` and `false` (in lower case) are allowed.

*

* Note that in contrast to the

* [Desktop Entry Specification](https://specifications.freedesktop.org/desktop-entry-spec/latest/),

* groups in key files may contain the same key multiple times; the last entry wins.

* Key files may also contain multiple groups with the same name; they are merged

* together. Another difference is that keys and group names in key files are not

* restricted to ASCII characters.

*

* Here is an example of loading a key file and reading a value:

*

* ```c

* g_autoptr(GError) error = NULL;

* g_autoptr(GKeyFile) key_file = g_key_file_new ();

*

* if (!g_key_file_load_from_file (key_file, "key-file.ini", flags, &error))

* {

* if (!g_error_matches (error, G_FILE_ERROR, G_FILE_ERROR_NOENT))

* g_warning ("Error loading key file: %s", error->message);

* return;

* }

*

* g_autofree gchar *val = g_key_file_get_string (key_file, "Group Name", "SomeKey", &error);

* if (val == NULL &&

* !g_error_matches (error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_KEY_NOT_FOUND))

* {

* g_warning ("Error finding key in key file: %s", error->message);

* return;

* }

* else if (val == NULL)

* {

* // Fall back to a default value.

* val = g_strdup ("default-value");

* }

* ```

*

* Here is an example of creating and saving a key file:

*

* ```c

* g_autoptr(GKeyFile) key_file = g_key_file_new ();

* const gchar *val = …;

* g_autoptr(GError) error = NULL;

*

* g_key_file_set_string (key_file, "Group Name", "SomeKey", val);

*

* // Save as a file.

* if (!g_key_file_save_to_file (key_file, "key-file.ini", &error))

* {

* g_warning ("Error saving key file: %s", error->message);

* return;

* }

*

* // Or store to a GBytes for use elsewhere.

* gsize data_len;

* g_autofree guint8 *data = (guint8 *) g_key_file_to_data (key_file, &data_len, &error);

* if (data == NULL)

* {

* g_warning ("Error saving key file: %s", error->message);

* return;

* }

* g_autoptr(GBytes) bytes = g_bytes_new_take (g_steal_pointer (&data), data_len);

* ```

*/

/**

* G_KEY_FILE_ERROR:

*

* Error domain for key file parsing.

*

* Errors in this domain will be from the [enum@GLib.KeyFileError] enumeration.

*

* See [struct@GLib.Error] for information on error domains.

*/

/**

* GKeyFileError:

* @G_KEY_FILE_ERROR_UNKNOWN_ENCODING: the text being parsed was in

* an unknown encoding

* @G_KEY_FILE_ERROR_PARSE: document was ill-formed

* @G_KEY_FILE_ERROR_NOT_FOUND: the file was not found

* @G_KEY_FILE_ERROR_KEY_NOT_FOUND: a requested key was not found

* @G_KEY_FILE_ERROR_GROUP_NOT_FOUND: a requested group was not found

* @G_KEY_FILE_ERROR_INVALID_VALUE: a value could not be parsed

*

* Error codes returned by key file parsing.

*/

/**

* GKeyFileFlags:

* @G_KEY_FILE_NONE: No flags, default behaviour

* @G_KEY_FILE_KEEP_COMMENTS: Use this flag if you plan to write the

* (possibly modified) contents of the key file back to a file;

* otherwise all comments will be lost when the key file is

* written back.

* @G_KEY_FILE_KEEP_TRANSLATIONS: Use this flag if you plan to write the

* (possibly modified) contents of the key file back to a file;

* otherwise only the translations for the current language will be

* written back.

*

* Flags which influence the parsing.

*/

/**

* G_KEY_FILE_DESKTOP_GROUP:

*

* The name of the main group of a desktop entry file, as defined in the

* [Desktop Entry Specification](https://specifications.freedesktop.org/desktop-entry-spec/latest/).

*

* Consult the specification for more

* details about the meanings of the keys below.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_TYPE:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a string

* giving the type of the desktop entry.

*

* Usually [const@GLib.KEY_FILE_DESKTOP_TYPE_APPLICATION],

* [const@GLib.KEY_FILE_DESKTOP_TYPE_LINK], or

* [const@GLib.KEY_FILE_DESKTOP_TYPE_DIRECTORY].

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_VERSION:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a string

* giving the version of the Desktop Entry Specification used for

* the desktop entry file.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_NAME:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a localized

* string giving the specific name of the desktop entry.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a localized

* string giving the generic name of the desktop entry.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a boolean

* stating whether the desktop entry should be shown in menus.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_COMMENT:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a localized

* string giving the tooltip for the desktop entry.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_ICON:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a localized

* string giving the name of the icon to be displayed for the desktop

* entry.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_HIDDEN:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a boolean

* stating whether the desktop entry has been deleted by the user.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a list of

* strings identifying the environments that should display the

* desktop entry.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a list of

* strings identifying the environments that should not display the

* desktop entry.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_TRY_EXEC:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a string

* giving the file name of a binary on disk used to determine if the

* program is actually installed.

*

* It is only valid for desktop entries with the `Application` type.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_EXEC:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a string

* giving the command line to execute.

*

* It is only valid for desktop entries with the `Application` type.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_PATH:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a string

* containing the working directory to run the program in.

*

* It is only valid for desktop entries with the `Application` type.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_TERMINAL:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a boolean

* stating whether the program should be run in a terminal window.

*

* It is only valid for desktop entries with the `Application` type.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_MIME_TYPE:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a list

* of strings giving the MIME types supported by this desktop entry.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_CATEGORIES:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a list

* of strings giving the categories in which the desktop entry

* should be shown in a menu.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a boolean

* stating whether the application supports the

* [Startup Notification Protocol Specification](https://specifications.freedesktop.org/startup-notification-spec/latest/).

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is string

* identifying the WM class or name hint of a window that the application

* will create, which can be used to emulate

* [Startup Notification](https://specifications.freedesktop.org/startup-notification-spec/latest/)

* with older applications.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_URL:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a string

* giving the URL to access.

*

* It is only valid for desktop entries with the `Link` type.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_KEY_DBUS_ACTIVATABLE:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a boolean

* set to true if the application is D-Bus activatable.

*

* Since: 2.38

*/

/**

* G_KEY_FILE_DESKTOP_KEY_ACTIONS:

*

* A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a string list

* giving the available application actions.

*

* Since: 2.38

*/

/**

* G_KEY_FILE_DESKTOP_TYPE_APPLICATION:

*

* The value of the [const@GLib.KEY_FILE_DESKTOP_KEY_TYPE], key for desktop

* entries representing applications.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_TYPE_LINK:

*

* The value of the [const@GLib.KEY_FILE_DESKTOP_KEY_TYPE], key for desktop

* entries representing links to documents.

*

* Since: 2.14

*/

/**

* G_KEY_FILE_DESKTOP_TYPE_DIRECTORY:

*

* The value of the [const@GLib.KEY_FILE_DESKTOP_KEY_TYPE], key for desktop

* entries representing directories.

*

* Since: 2.14

*/

typedef struct _GKeyFileGroup GKeyFileGroup;

struct _GKeyFile

{

GList *groups;

GHashTable *group_hash;

GKeyFileGroup *start_group;

GKeyFileGroup *current_group;

GString *parse_buffer; /* Holds up to one line of not-yet-parsed data */

gchar list_separator;

GKeyFileFlags flags;

gboolean checked_locales; /* TRUE if @locales has been initialised */

gchar **locales; /* (nullable) */

gint ref_count; /* (atomic) */

};

typedef struct _GKeyFileKeyValuePair GKeyFileKeyValuePair;

struct _GKeyFileGroup

{

const gchar *name; /* NULL for above first group (which will be comments) */

GList *key_value_pairs;

/* Used in parallel with key_value_pairs for

* increased lookup performance

*/

GHashTable *lookup_map;

};

struct _GKeyFileKeyValuePair

{

gchar *key; /* NULL for comments */

gchar *value;

};

static gint find_file_in_data_dirs (const gchar *file,

const gchar **data_dirs,

gchar **output_file,

GError **error);

static gboolean g_key_file_load_from_fd (GKeyFile *key_file,

gint fd,

GKeyFileFlags flags,

GError **error);

static GList *g_key_file_lookup_group_node (GKeyFile *key_file,

const gchar *group_name);

static GKeyFileGroup *g_key_file_lookup_group (GKeyFile *key_file,

const gchar *group_name);

static GList *g_key_file_lookup_key_value_pair_node (GKeyFile *key_file,

GKeyFileGroup *group,

const gchar *key);

static GKeyFileKeyValuePair *g_key_file_lookup_key_value_pair (GKeyFile *key_file,

GKeyFileGroup *group,

const gchar *key);

static void g_key_file_remove_group_node (GKeyFile *key_file,

GList *group_node);

static void g_key_file_remove_key_value_pair_node (GKeyFile *key_file,

GKeyFileGroup *group,

GList *pair_node);

static void g_key_file_add_key_value_pair (GKeyFile *key_file,

GKeyFileGroup *group,

GKeyFileKeyValuePair *pair,

GList *sibling);

static void g_key_file_add_key (GKeyFile *key_file,

GKeyFileGroup *group,

const gchar *key,

const gchar *value);

static void g_key_file_add_group (GKeyFile *key_file,

const gchar *group_name,

gboolean created);

static gboolean g_key_file_is_group_name (const gchar *name);

static gboolean g_key_file_is_key_name (const gchar *name,

gsize len);

static void g_key_file_key_value_pair_free (GKeyFileKeyValuePair *pair);

static gboolean g_key_file_line_is_comment (const gchar *line);

static gboolean g_key_file_line_is_group (const gchar *line);

static gboolean g_key_file_line_is_key_value_pair (const gchar *line);

static gchar *g_key_file_parse_value_as_string (GKeyFile *key_file,

const gchar *value,

GSList **separators,

GError **error);

static gchar *g_key_file_parse_string_as_value (GKeyFile *key_file,

const gchar *string,

gboolean escape_separator);

static gint g_key_file_parse_value_as_integer (GKeyFile *key_file,

const gchar *value,

GError **error);

static gchar *g_key_file_parse_integer_as_value (GKeyFile *key_file,

gint value);

static gdouble g_key_file_parse_value_as_double (GKeyFile *key_file,

const gchar *value,

GError **error);

static gboolean g_key_file_parse_value_as_boolean (GKeyFile *key_file,

const gchar *value,

GError **error);

static const gchar *g_key_file_parse_boolean_as_value (GKeyFile *key_file,

gboolean value);

static gchar *g_key_file_parse_value_as_comment (GKeyFile *key_file,

const gchar *value,

gboolean is_final_line);

static gchar *g_key_file_parse_comment_as_value (GKeyFile *key_file,

const gchar *comment);

static void g_key_file_parse_key_value_pair (GKeyFile *key_file,

const gchar *line,

gsize length,

GError **error);

static void g_key_file_parse_comment (GKeyFile *key_file,

const gchar *line,

gsize length,

GError **error);

static void g_key_file_parse_group (GKeyFile *key_file,

const gchar *line,

gsize length,

GError **error);

static const gchar *key_get_locale (const gchar *key,

gsize *len_out);

static void g_key_file_parse_data (GKeyFile *key_file,

const gchar *data,

gsize length,

GError **error);

static void g_key_file_flush_parse_buffer (GKeyFile *key_file,

GError **error);

G_DEFINE_QUARK (g-key-file-error-quark, g_key_file_error)

static void

g_key_file_init (GKeyFile *key_file)

{

key_file->current_group = g_new0 (GKeyFileGroup, 1);

key_file->groups = g_list_prepend (NULL, key_file->current_group);

key_file->group_hash = NULL;

key_file->start_group = NULL;

key_file->parse_buffer = NULL;

key_file->list_separator = ';';

key_file->flags = 0;

}

static void

g_key_file_clear (GKeyFile *key_file)

{

GList *tmp, *group_node;

if (key_file->locales)

{

g_strfreev (key_file->locales);

key_file->locales = NULL;

}

key_file->checked_locales = FALSE;

if (key_file->parse_buffer)

{

g_string_free (key_file->parse_buffer, TRUE);

key_file->parse_buffer = NULL;

}

tmp = key_file->groups;

while (tmp != NULL)

{

group_node = tmp;

tmp = tmp->next;

g_key_file_remove_group_node (key_file, group_node);

}

if (key_file->group_hash != NULL)

{

g_hash_table_destroy (key_file->group_hash);

key_file->group_hash = NULL;

}

g_warn_if_fail (key_file->groups == NULL);

}

/**

* g_key_file_new:

*

* Creates a new empty [struct@GLib.KeyFile] object.

*

* Use [method@GLib.KeyFile.load_from_file],

* [method@GLib.KeyFile.load_from_data], [method@GLib.KeyFile.load_from_dirs] or

* [method@GLib.KeyFile.load_from_data_dirs] to

* read an existing key file.

*

* Returns: (transfer full): an empty [struct@GLib.KeyFile].

*

* Since: 2.6

**/

GKeyFile *

g_key_file_new (void)

{

GKeyFile *key_file;

key_file = g_new0 (GKeyFile, 1);

key_file->ref_count = 1;

g_key_file_init (key_file);

return key_file;

}

/**

* g_key_file_set_list_separator:

* @key_file: a key file

* @separator: the separator

*

* Sets the character which is used to separate values in lists.

*

* Typically `;` or `,` are used as separators. The default list separator

* is `;`.

*

* Since: 2.6

*/

void

g_key_file_set_list_separator (GKeyFile *key_file,

gchar separator)

{

g_return_if_fail (key_file != NULL);

key_file->list_separator = separator;

}

/* Iterates through all the directories in *dirs trying to

* open file. When it successfully locates and opens a file it

* returns the file descriptor to the open file. It also

* outputs the absolute path of the file in output_file.

*/

static gint

find_file_in_data_dirs (const gchar *file,

const gchar **dirs,

gchar **output_file,

GError **error)

{

const gchar **data_dirs, *data_dir;

gchar *path;

gint fd;

path = NULL;

fd = -1;

if (dirs == NULL)

return fd;

data_dirs = dirs;

while (data_dirs && (data_dir = *data_dirs) && fd == -1)

{

const gchar *candidate_file;

gchar *sub_dir;

candidate_file = file;

sub_dir = g_strdup ("");

while (candidate_file != NULL && fd == -1)

{

gchar *p;

path = g_build_filename (data_dir, sub_dir,

candidate_file, NULL);

fd = g_open (path, O_RDONLY | O_CLOEXEC, 0);

if (fd == -1)

{

g_free (path);

path = NULL;

}

candidate_file = strchr (candidate_file, '-');

if (candidate_file == NULL)

break;

candidate_file++;

g_free (sub_dir);

sub_dir = g_strndup (file, candidate_file - file - 1);

for (p = sub_dir; *p != '\0'; p++)

{

if (*p == '-')

*p = G_DIR_SEPARATOR;

}

}

g_free (sub_dir);

data_dirs++;

}

if (fd == -1)

{

g_set_error_literal (error, G_KEY_FILE_ERROR,

G_KEY_FILE_ERROR_NOT_FOUND,

_("Valid key file could not be "

"found in search dirs"));

}

if (output_file != NULL && fd != -1)

*output_file = g_strdup (path);

g_free (path);

return fd;

}

static gboolean

g_key_file_load_from_fd (GKeyFile *key_file,

gint fd,

GKeyFileFlags flags,

GError **error)

{

GError *key_file_error = NULL;

gssize bytes_read;

struct stat stat_buf;

gchar read_buf[4096];

gchar list_separator;

if (fstat (fd, &stat_buf) < 0)

{

int errsv = errno;

g_set_error_literal (error, G_FILE_ERROR,

g_file_error_from_errno (errsv),

g_strerror (errsv));

return FALSE;

}

if (!S_ISREG (stat_buf.st_mode))

{

g_set_error_literal (error, G_KEY_FILE_ERROR,

G_KEY_FILE_ERROR_PARSE,

_("Not a regular file"));

return FALSE;

}

list_separator = key_file->list_separator;

g_key_file_clear (key_file);

g_key_file_init (key_file);

key_file->list_separator = list_separator;

key_file->flags = flags;

do

{

int errsv;

bytes_read = read (fd, read_buf, 4096);

errsv = errno;

if (bytes_read == 0) /* End of File */

break;

if (bytes_read < 0)

{

if (errsv == EINTR || errsv == EAGAIN)

continue;

g_set_error_literal (error, G_FILE_ERROR,

g_file_error_from_errno (errsv),

g_strerror (errsv));

return FALSE;

}

g_key_file_parse_data (key_file,

read_buf, bytes_read,

&key_file_error);

}

while (!key_file_error);

if (key_file_error)

{

g_propagate_error (error, key_file_error);

return FALSE;

}

g_key_file_flush_parse_buffer (key_file, &key_file_error);

if (key_file_error)

{

g_propagate_error (error, key_file_error);

return FALSE;

}

return TRUE;

}

/**

* g_key_file_load_from_file:

* @key_file: an empty key file

* @file: (type filename): the path of a filename to load, in the GLib filename encoding

* @flags: flags from [flags@GLib.KeyFileFlags]

* @error: return location for a [struct@GLib.Error]

*

* Loads a key file into an empty [struct@GLib.KeyFile] structure.

*

* If the OS returns an error when opening or reading the file, a

* [error@GLib.FileError] is returned. If there is a problem parsing the file,

* a [error@GLib.KeyFileError] is returned.

*

* This function will never return a [error@GLib.KeyFileError.NOT_FOUND]

* error. If the @file is not found, [error@GLib.FileError.NOENT] is returned.

*

* Returns: true if a key file could be loaded, false otherwise

*

* Since: 2.6

**/

gboolean

g_key_file_load_from_file (GKeyFile *key_file,

const gchar *file,

GKeyFileFlags flags,

GError **error)

{

GError *key_file_error = NULL;

gint fd;

int errsv;

g_return_val_if_fail (key_file != NULL, FALSE);

g_return_val_if_fail (file != NULL, FALSE);

fd = g_open (file, O_RDONLY | O_CLOEXEC, 0);

errsv = errno;

if (fd == -1)

{

g_set_error_literal (error, G_FILE_ERROR,

g_file_error_from_errno (errsv),

g_strerror (errsv));

return FALSE;

}

g_key_file_load_from_fd (key_file, fd, flags, &key_file_error);

close (fd);

if (key_file_error)

{

g_propagate_error (error, key_file_error);

return FALSE;

}

return TRUE;

}

/**

* g_key_file_load_from_data:

* @key_file: an empty key file

* @data: key file loaded in memory

* @length: the length of @data in bytes (or `(gsize)-1` if data is nul-terminated)

* @flags: flags from [flags@GLib.KeyFileFlags]

* @error: return location for a [struct@GLib.Error]

*

* Loads a key file from memory into an empty [struct@GLib.KeyFile] structure.

*

* If the object cannot be created then a [error@GLib.KeyFileError is returned.

*

* Returns: true if a key file could be loaded, false otherwise

*

* Since: 2.6

**/

gboolean

g_key_file_load_from_data (GKeyFile *key_file,

const gchar *data,

gsize length,

GKeyFileFlags flags,

GError **error)

{

GError *key_file_error = NULL;

gchar list_separator;

g_return_val_if_fail (key_file != NULL, FALSE);

g_return_val_if_fail (data != NULL || length == 0, FALSE);

if (length == (gsize)-1)

length = strlen (data);

list_separator = key_file->list_separator;

g_key_file_clear (key_file);

g_key_file_init (key_file);

key_file->list_separator = list_separator;

key_file->flags = flags;

g_key_file_parse_data (key_file, data, length, &key_file_error);

if (key_file_error)

{

g_propagate_error (error, key_file_error);

return FALSE;

}

g_key_file_flush_parse_buffer (key_file, &key_file_error);

if (key_file_error)

{

g_propagate_error (error, key_file_error);