结构

GLibOptionContext

描述 [src]

struct GOptionContext {
  /* No available fields */
}

GOptionContext 结构定义命令行选项解析器接受哪些选项。该结构只有私有字段,不应直接访问。

函数

g_option_context_new

创建一个新的选项上下文。

从:2.6

实例方法

g_option_context_add_group

context 添加一个 GOptionGroup,使得使用 context 进行解析时,能够识别组中的选项。请注意,这将占用 group 的所有权,因此不应释放 group

从:2.6

g_option_context_add_main_entries

如果主组不存在,则这是一个便利函数,它将创建主组并向其中添加 entries,然后设置翻译域。

从:2.6

g_option_context_free

释放已添加到其中的上下文和所有组。

从:2.6

g_option_context_get_description

返回描述。参见 g_option_context_set_description()。

从:2.12

g_option_context_get_help

返回给定上下文的格式化、翻译后的帮助文本。要获取 --help 生成的文本,请调用 g_option_context_get_help (context, TRUE, NULL)。要获取 --help-all 生成的文本,请调用 g_option_context_get_help (context, FALSE, NULL)。要获取选项组的帮助文本,请调用 g_option_context_get_help (context, FALSE, group)

从:2.14

g_option_context_get_help_enabled

返回 context 的自动 --help 生成是否已打开。参见 g_option_context_set_help_enabled()。

从:2.6

g_option_context_get_ignore_unknown_options

返回忽略未知选项还是不忽略。参见 g_option_context_set_ignore_unknown_options()。

从:2.6

g_option_context_get_main_group

返回指向 context 的主组的指针。

从:2.6

g_option_context_get_strict_posix

返回是否启用严格 POSIX 代码。

从:2.44

g_option_context_get_summary

返回摘要。参见 g_option_context_set_summary()。

从:2.12

g_option_context_parse

解析命令行参数,识别已添加到 context 中的选项。调用此函数的副作用之一是将调用 g_set_prgname()

从:2.6

g_option_context_parse_strv

解析命令行参数。

从:2.40

g_option_context_set_description

添加一个字符串,在 --help 输出中显示在选项列表后面。此文本通常包括一个举报问题地址。

从:2.12

g_option_context_set_help_enabled

启用或禁用 --help 输出的自动生成。默认情况下,g_option_context_parse() 识别 --help-h-?--help-all--help-groupname,并创建适当的输出到 stdout。

从:2.6

g_option_context_set_ignore_unknown_options

设置是否忽略未知选项。如果一个参数被忽略,它在解析后会保留在 argv 数组中。默认情况下,g_option_context_parse() 将未知选项视为 error(错误)。

从:2.6

g_option_context_set_main_group

GOptionGroup 设置为 context 的主组。这相当于调用 g_option_context_add_group() 的效果,唯一区别是当生成 --help 输出时,会以不同的方式处理主组中的选项。

从:2.6

g_option_context_set_strict_posix

设置严格的 POSIX 模式。

从:2.44

g_option_context_set_summary

添加要在 --help 输出中选项列表之前显示的字符串。这通常是程序 功能的摘要。

从:2.12

g_option_context_set_translate_func

设置用于翻译上下文用户可见字符串(以用于 --help 输出)的函数。如果 funcNULL,则不会翻译字符串。

从:2.12

g_option_context_set_translation_domain

一个使用 gettext() 来翻译用户可见 字符串的便捷函数。

从:2.12