结构

GLibKeyFile

说明 [源代码]

struct GKeyFile {
  /* No available fields */
}

GKeyFile 会解析类似 .ini 的配置文件。

GKeyFile 可以让您解析、编辑或创建包含成组键值对的文件，我们称之为“密钥文件”，因没有更好的名称。现在，多个 freedesktop.org 规范都在使用密钥文件，例如 Desktop Entry 规范和 Icon Theme 规范。

密钥文件的语法在 Desktop Entry 规范中有详细描述，这里快速总结一下：密钥文件由成组的键值对组成，并穿插有注释。

# 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

以 ‘#’ 开头的行以及空白行被视为注释。

组由包含在 ‘[‘ 和 ‘]’ 中的组名称开头的标题行开始，并由下一组的开始或文件结尾隐式结束。每个键值对都必须包含在一个组中。

键值对通常采用 key=value 的形式，本地化字符串除外，本地化字符串采用 key[locale]=value 的形式，语言环境标识符为 lang_COUNTRY@MODIFIER，其中 COUNTRY 和 MODIFIER 是可选的。'=' 字符前后的空格将被忽略。值中的换行符、制表符、回车符和反斜杠字符将分别转义为 \n、\t、\r 和 \\\\。为保留值中的前导空格，这些空格也可转义为 \s。

键文件可以存储字符串（可能包含本地化变量）、整数、布尔值和这些值的列表。列表由分隔符字符分隔，通常是 ';' 或 ','。为在列表中的值中使用列表分隔符字符，必须使用反斜杠对其进行转义。

此语法明显受到 Windows 上常见的 .ini 文件的启发，但存在一些重要差异

.ini 文件使用 ';' 字符开始注释，键文件使用 '#' 字符。
键文件不允许非分组键，即只有注释才能位于第一个组之前。
键文件始终按 UTF-8 编码。
键和组名区分大小写。例如，名为 [GROUP] 的组与 [group] 不同。
.ini 文件没有严格类型的布尔条目类型，它们仅有 GetProfileInt()。在键文件中，只允许 true 和 false（小写）。

请注意，与桌面条目规范相反，键文件中的组可以多次包含同一键；最后一个条目将获胜。键文件还可以包含名称相同的多个组，这些组将合并在一起。另一个不同之处在于，键文件中的键和组名不受 ASCII 字符的限制。

以下是一个加载键文件并读取值的示例

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");
  }

以下是一个创建并保存键文件的示例

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_new

创建一个新的空 GKeyFile 对象。使用 g_key_file_load_from_file()、g_key_file_load_from_data()、g_key_file_load_from_dirs() 或 g_key_file_load_from_data_dirs() 读取现有的键文件。

自：2.6

函数

g_key_file_error_quark

没有可用的描述。

说明 [源代码]

构造函数

函数

实例方法