* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
*/
-#if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
-#error "Only <glib.h> can be included directly."
-#endif
-
#ifndef __G_OPTION_H__
#define __G_OPTION_H__
+#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
+#error "Only <glib.h> can be included directly."
+#endif
+
#include <glib/gerror.h>
#include <glib/gquark.h>
/**
* GOptionContext:
*
- * A <structname>GOptionContext</structname> struct defines which options
+ * A `GOptionContext` struct defines which options
* are accepted by the commandline option parser. The struct has only private
* fields and should not be directly accessed.
*/
/**
* GOptionGroup:
*
- * A <structname>GOptionGroup</structname> struct defines the options in a single
+ * A `GOptionGroup` struct defines the options in a single
* group. The struct has only private fields and should not be directly accessed.
*
* All options in a group share the same translation function. Libraries which
* need to parse commandline options are expected to provide a function for
- * getting a <structname>GOptionGroup</structname> holding their options, which
+ * getting a `GOptionGroup` holding their options, which
* the application can then add to its #GOptionContext.
*/
typedef struct _GOptionGroup GOptionGroup;
/**
* GOptionFlags:
- * @G_OPTION_FLAG_HIDDEN: The option doesn't appear in <option>--help</option>
- * output.
+ * @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
- * <option>--help</option> 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.
+ * `--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.
* @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
+ * 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
+ * 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 <literal>groupname-</literal> 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.
- *
+ * 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.
*/
typedef enum
{
+ G_OPTION_FLAG_NONE = 0,
G_OPTION_FLAG_HIDDEN = 1 << 0,
G_OPTION_FLAG_IN_MAIN = 1 << 1,
G_OPTION_FLAG_REVERSE = 1 << 2,
* @G_OPTION_ARG_STRING: The option takes a string argument.
* @G_OPTION_ARG_INT: The option takes an integer argument.
* @G_OPTION_ARG_CALLBACK: The option provides a callback to parse the
- * extra argument.
+ * extra argument.
* @G_OPTION_ARG_FILENAME: The option takes a filename as argument.
* @G_OPTION_ARG_STRING_ARRAY: The option takes a string argument, multiple
- * uses of the option are collected into an array of strings.
+ * 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.
+ * 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 <literal>0x</literal>, for example, <literal>0xffffffff</literal>).
- * Since 2.12
+ * 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:
- * <option>-x arg</option>, with a long option: <option>--name arg</option>
- * or combined in a single argument: <option>--name=arg</option>.
+ * 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`.
*/
typedef enum
{
G_OPTION_ERROR_FAILED
} GOptionError;
+GLIB_AVAILABLE_IN_ALL
GQuark g_option_error_quark (void);
/**
* GOptionEntry:
* @long_name: The long name of an option can be used to specify it
- * in a commandline as --<replaceable>long_name</replaceable>. Every
- * option must have a long name. To resolve conflicts if multiple
- * option groups contain the same long name, it is also possible to
- * specify the option as
- * --<replaceable>groupname</replaceable>-<replaceable>long_name</replaceable>.
+ * in a commandline as `--long_name`. Every option must have a
+ * long name. To resolve conflicts if multiple option groups contain
+ * the same long name, it is also possible to specify the option as
+ * `--groupname-long_name`.
* @short_name: If an option has a short name, it can be specified
- * -<replaceable>short_name</replaceable> in a commandline. @short_name must be
- * a printable ASCII character different from '-', or zero if the option has no
- * short name.
- * @flags: Flags from #GOptionFlags.
- * @arg: The type of the option, as a #GOptionArg.
- * @arg_data: If the @arg type is %G_OPTION_ARG_CALLBACK, then @arg_data must
- * point to a #GOptionArgFunc callback function, which will be called to handle
- * the extra argument. Otherwise, @arg_data is a pointer to a location to store
- * the value, the required type of the location depends on the @arg type:
- * <variablelist>
- * <varlistentry>
- * <term>%G_OPTION_ARG_NONE</term>
- * <listitem><para>%gboolean</para></listitem>
- * </varlistentry>
- * <varlistentry>
- * <term>%G_OPTION_ARG_STRING</term>
- * <listitem><para>%gchar*</para></listitem>
- * </varlistentry>
- * <varlistentry>
- * <term>%G_OPTION_ARG_INT</term>
- * <listitem><para>%gint</para></listitem>
- * </varlistentry>
- * <varlistentry>
- * <term>%G_OPTION_ARG_FILENAME</term>
- * <listitem><para>%gchar*</para></listitem>
- * </varlistentry>
- * <varlistentry>
- * <term>%G_OPTION_ARG_STRING_ARRAY</term>
- * <listitem><para>%gchar**</para></listitem>
- * </varlistentry>
- * <varlistentry>
- * <term>%G_OPTION_ARG_FILENAME_ARRAY</term>
- * <listitem><para>%gchar**</para></listitem>
- * </varlistentry>
- * <varlistentry>
- * <term>%G_OPTION_ARG_DOUBLE</term>
- * <listitem><para>%gdouble</para></listitem>
- * </varlistentry>
- * </variablelist>
- * If @arg type is %G_OPTION_ARG_STRING or %G_OPTION_ARG_FILENAME the location
- * will contain a newly allocated string if the option was given. That string
- * needs to be freed by the callee using g_free(). Likewise if @arg type is
- * %G_OPTION_ARG_STRING_ARRAY or %G_OPTION_ARG_FILENAME_ARRAY, the data should
- * be freed using g_strfreev().
- * @description: the description for the option in <option>--help</option>
- * output. The @description is translated using the @translate_func of the
- * group, see g_option_group_set_translation_domain().
+ * `-short_name` in a commandline. @short_name must be a printable
+ * ASCII character different from '-', or zero if the option has no
+ * short name.
+ * @flags: Flags from #GOptionFlags
+ * @arg: The type of the option, as a #GOptionArg
+ * @arg_data: If the @arg type is %G_OPTION_ARG_CALLBACK, then @arg_data
+ * must point to a #GOptionArgFunc callback function, which will be
+ * called to handle the extra argument. Otherwise, @arg_data is a
+ * pointer to a location to store the value, the required type of
+ * the location depends on the @arg type:
+ * - %G_OPTION_ARG_NONE: %gboolean
+ * - %G_OPTION_ARG_STRING: %gchar*
+ * - %G_OPTION_ARG_INT: %gint
+ * - %G_OPTION_ARG_FILENAME: %gchar*
+ * - %G_OPTION_ARG_STRING_ARRAY: %gchar**
+ * - %G_OPTION_ARG_FILENAME_ARRAY: %gchar**
+ * - %G_OPTION_ARG_DOUBLE: %gdouble
+ * If @arg type is %G_OPTION_ARG_STRING or %G_OPTION_ARG_FILENAME,
+ * the location will contain a newly allocated string if the option
+ * was given. That string needs to be freed by the callee using g_free().
+ * Likewise if @arg type is %G_OPTION_ARG_STRING_ARRAY or
+ * %G_OPTION_ARG_FILENAME_ARRAY, the data should be freed using g_strfreev().
+ * @description: the description for the option in `--help`
+ * output. The @description is translated using the @translate_func
+ * of the group, see g_option_group_set_translation_domain().
* @arg_description: The placeholder to use for the extra argument parsed
- * by the option in <option>--help</option>
- * output. The @arg_description is translated using the @translate_func of the
- * group, see g_option_group_set_translation_domain().
+ * by the option in `--help` output. The @arg_description is translated
+ * using the @translate_func of the group, see
+ * g_option_group_set_translation_domain().
*
- * A <structname>GOptionEntry</structname> defines a single option.
- * To have an effect, they must be added to a #GOptionGroup with
- * g_option_context_add_main_entries() or g_option_group_add_entries().
+ * A GOptionEntry struct defines a single option. To have an effect, they
+ * must be added to a #GOptionGroup with g_option_context_add_main_entries()
+ * or g_option_group_add_entries().
*/
struct _GOptionEntry
{
*
* 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 <literal>argv</literal>. The option must be of type
+ * 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 <literal>argv</literal>
+ * 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.
*
*/
#define G_OPTION_REMAINING ""
+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);
-G_CONST_RETURN gchar *g_option_context_get_summary (GOptionContext *context);
+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);
-G_CONST_RETURN gchar *g_option_context_get_description (GOptionContext *context);
+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_AVAILABLE_IN_ALL
void g_option_group_free (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);
projects / platform / upstream / glib.git / blobdiff