|
GLIB_AVAILABLE_IN_ALL GQuark | g_option_error_quark (void) |
|
GLIB_AVAILABLE_IN_ALL GOptionContext * | g_option_context_new (const gchar *parameter_string) |
|
GLIB_AVAILABLE_IN_ALL void | g_option_context_set_summary (GOptionContext *context, const gchar *summary) |
|
GLIB_AVAILABLE_IN_ALL const gchar * | g_option_context_get_summary (GOptionContext *context) |
|
GLIB_AVAILABLE_IN_ALL void | g_option_context_set_description (GOptionContext *context, const gchar *description) |
|
GLIB_AVAILABLE_IN_ALL const gchar * | g_option_context_get_description (GOptionContext *context) |
|
GLIB_AVAILABLE_IN_ALL void | g_option_context_free (GOptionContext *context) |
|
GLIB_AVAILABLE_IN_ALL void | g_option_context_set_help_enabled (GOptionContext *context, gboolean help_enabled) |
|
GLIB_AVAILABLE_IN_ALL gboolean | g_option_context_get_help_enabled (GOptionContext *context) |
|
GLIB_AVAILABLE_IN_ALL void | g_option_context_set_ignore_unknown_options (GOptionContext *context, gboolean ignore_unknown) |
|
GLIB_AVAILABLE_IN_ALL gboolean | g_option_context_get_ignore_unknown_options (GOptionContext *context) |
|
GLIB_AVAILABLE_IN_2_44 void | g_option_context_set_strict_posix (GOptionContext *context, gboolean strict_posix) |
|
GLIB_AVAILABLE_IN_2_44 gboolean | g_option_context_get_strict_posix (GOptionContext *context) |
|
GLIB_AVAILABLE_IN_ALL void | g_option_context_add_main_entries (GOptionContext *context, const GOptionEntry *entries, const gchar *translation_domain) |
|
GLIB_AVAILABLE_IN_ALL gboolean | g_option_context_parse (GOptionContext *context, gint *argc, gchar ***argv, GError **error) |
|
GLIB_AVAILABLE_IN_2_40 gboolean | g_option_context_parse_strv (GOptionContext *context, gchar ***arguments, GError **error) |
|
GLIB_AVAILABLE_IN_ALL void | g_option_context_set_translate_func (GOptionContext *context, GTranslateFunc func, gpointer data, GDestroyNotify destroy_notify) |
|
GLIB_AVAILABLE_IN_ALL void | g_option_context_set_translation_domain (GOptionContext *context, const gchar *domain) |
|
GLIB_AVAILABLE_IN_ALL void | g_option_context_add_group (GOptionContext *context, GOptionGroup *group) |
|
GLIB_AVAILABLE_IN_ALL void | g_option_context_set_main_group (GOptionContext *context, GOptionGroup *group) |
|
GLIB_AVAILABLE_IN_ALL GOptionGroup * | g_option_context_get_main_group (GOptionContext *context) |
|
GLIB_AVAILABLE_IN_ALL gchar * | g_option_context_get_help (GOptionContext *context, gboolean main_help, GOptionGroup *group) |
|
GLIB_AVAILABLE_IN_ALL GOptionGroup * | g_option_group_new (const gchar *name, const gchar *description, const gchar *help_description, gpointer user_data, GDestroyNotify destroy) |
|
GLIB_AVAILABLE_IN_ALL void | g_option_group_set_parse_hooks (GOptionGroup *group, GOptionParseFunc pre_parse_func, GOptionParseFunc post_parse_func) |
|
GLIB_AVAILABLE_IN_ALL void | g_option_group_set_error_hook (GOptionGroup *group, GOptionErrorFunc error_func) |
|
GLIB_DEPRECATED_IN_2_44 void | g_option_group_free (GOptionGroup *group) |
|
GLIB_AVAILABLE_IN_2_44 GOptionGroup * | g_option_group_ref (GOptionGroup *group) |
|
GLIB_AVAILABLE_IN_2_44 void | g_option_group_unref (GOptionGroup *group) |
|
GLIB_AVAILABLE_IN_ALL void | g_option_group_add_entries (GOptionGroup *group, const GOptionEntry *entries) |
|
GLIB_AVAILABLE_IN_ALL void | g_option_group_set_translate_func (GOptionGroup *group, GTranslateFunc func, gpointer data, GDestroyNotify destroy_notify) |
|
GLIB_AVAILABLE_IN_ALL void | g_option_group_set_translation_domain (GOptionGroup *group, const gchar *domain) |
|
#define G_OPTION_REMAINING "" |
G_OPTION_REMAINING:
If a long option in the main group has this name, it is not treated as a regular option. Instead it collects all non-option arguments which would otherwise be left in argv
. The option must be of type G_OPTION_ARG_CALLBACK, G_OPTION_ARG_STRING_ARRAY or G_OPTION_ARG_FILENAME_ARRAY.
Using G_OPTION_REMAINING instead of simply scanning argv
for leftover arguments has the advantage that GOption takes care of necessary encoding conversions for strings or filenames.
Since: 2.6
Definition at line 290 of file goption.h.
GOptionArgFunc: @option_name: The name of the option being parsed. This will be either a single dash followed by a single letter (for a short name) or two dashes followed by a long option name. @value: The value to be parsed. @data: User data added to the GOptionGroup containing the option when it was created with g_option_group_new() @error: A return location for errors. The error code G_OPTION_ERROR_FAILED is intended to be used for errors in GOptionArgFunc callbacks.
The type of function to be passed as callback for G_OPTION_ARG_CALLBACK options.
Returns: TRUE if the option was successfully parsed, FALSE if an error occurred, in which case @error should be set with g_set_error()
Definition at line 152 of file goption.h.
GOptionParseFunc: @context: The active GOptionContext @group: The group to which the function belongs @data: User data added to the GOptionGroup containing the option when it was created with g_option_group_new() @error: A return location for error details
The type of function that can be called before and after parsing.
Returns: TRUE if the function completed successfully, FALSE if an error occurred, in which case @error should be set with g_set_error()
Definition at line 170 of file goption.h.
GOptionArg: @G_OPTION_ARG_NONE: No extra argument. This is useful for simple flags or booleans. @G_OPTION_ARG_STRING: The option takes a UTF-8 string argument. @G_OPTION_ARG_INT: The option takes an integer argument. @G_OPTION_ARG_CALLBACK: The option provides a callback (of type GOptionArgFunc) to parse the extra argument. @G_OPTION_ARG_FILENAME: The option takes a filename as argument, which will be in the GLib filename encoding rather than UTF-8. @G_OPTION_ARG_STRING_ARRAY: The option takes a string argument, multiple uses of the option are collected into an array of strings. @G_OPTION_ARG_FILENAME_ARRAY: The option takes a filename as argument, multiple uses of the option are collected into an array of strings. @G_OPTION_ARG_DOUBLE: The option takes a double argument. The argument can be formatted either for the user's locale or for the "C" locale. Since 2.12 @G_OPTION_ARG_INT64: The option takes a 64-bit integer. Like G_OPTION_ARG_INT but for larger numbers. The number can be in decimal base, or in hexadecimal (when prefixed with 0x
, for example, 0xffffffff
). Since 2.12
The GOptionArg enum values determine which type of extra argument the options expect to find. If an option expects an extra argument, it can be specified in several ways; with a short option: -x arg
, with a long option: --name arg
or combined in a single argument: --name=arg
.
Enumerator |
---|
G_OPTION_ARG_NONE | |
G_OPTION_ARG_STRING | |
G_OPTION_ARG_INT | |
G_OPTION_ARG_CALLBACK | |
G_OPTION_ARG_FILENAME | |
G_OPTION_ARG_STRING_ARRAY | |
G_OPTION_ARG_FILENAME_ARRAY | |
G_OPTION_ARG_DOUBLE | |
G_OPTION_ARG_INT64 | |
Definition at line 122 of file goption.h.
123{
@ G_OPTION_ARG_FILENAME_ARRAY
@ G_OPTION_ARG_STRING_ARRAY
GOptionFlags: @G_OPTION_FLAG_NONE: No flags. Since: 2.42. @G_OPTION_FLAG_HIDDEN: The option doesn't appear in --help
output. @G_OPTION_FLAG_IN_MAIN: The option appears in the main section of the --help
output, even if it is defined in a group. @G_OPTION_FLAG_REVERSE: For options of the G_OPTION_ARG_NONE kind, this flag indicates that the sense of the option is reversed. i.e. FALSE will be stored into the argument rather than TRUE. @G_OPTION_FLAG_NO_ARG: For options of the G_OPTION_ARG_CALLBACK kind, this flag indicates that the callback does not take any argument (like a G_OPTION_ARG_NONE option). Since 2.8 @G_OPTION_FLAG_FILENAME: For options of the G_OPTION_ARG_CALLBACK kind, this flag indicates that the argument should be passed to the callback in the GLib filename encoding rather than UTF-8. Since 2.8 @G_OPTION_FLAG_OPTIONAL_ARG: For options of the G_OPTION_ARG_CALLBACK kind, this flag indicates that the argument supply is optional. If no argument is given then data of GOptionParseFunc will be set to NULL. Since 2.8 @G_OPTION_FLAG_NOALIAS: This flag turns off the automatic conflict resolution which prefixes long option names with groupname-
if there is a conflict. This option should only be used in situations where aliasing is necessary to model some legacy commandline interface. It is not safe to use this option, unless all option groups are under your direct control. Since 2.8.
Flags which modify individual options.
Enumerator |
---|
G_OPTION_FLAG_NONE | |
G_OPTION_FLAG_HIDDEN | |
G_OPTION_FLAG_IN_MAIN | |
G_OPTION_FLAG_REVERSE | |
G_OPTION_FLAG_NO_ARG | |
G_OPTION_FLAG_FILENAME | |
G_OPTION_FLAG_OPTIONAL_ARG | |
G_OPTION_FLAG_NOALIAS | |
Definition at line 84 of file goption.h.
85{
@ G_OPTION_FLAG_OPTIONAL_ARG