1 /* goption.h - Option parser
3 * Copyright (C) 2004 Anders Carlsson <andersca@gnome.org>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
21 #ifndef __G_OPTION_H__
22 #define __G_OPTION_H__
24 #include <glib/gerror.h>
25 #include <glib/gquark.h>
29 typedef struct _GOptionContext GOptionContext;
30 typedef struct _GOptionGroup GOptionGroup;
31 typedef struct _GOptionEntry GOptionEntry;
35 G_OPTION_FLAG_HIDDEN = 1 << 0,
36 G_OPTION_FLAG_IN_MAIN = 1 << 1,
37 G_OPTION_FLAG_REVERSE = 1 << 2
45 G_OPTION_ARG_CALLBACK,
46 G_OPTION_ARG_FILENAME,
47 G_OPTION_ARG_STRING_ARRAY,
48 G_OPTION_ARG_FILENAME_ARRAY
51 typedef gboolean (*GOptionArgFunc) (const gchar *option_name,
56 typedef gboolean (*GOptionParseFunc) (GOptionContext *context,
61 typedef void (*GOptionErrorFunc) (GOptionContext *context,
66 #define G_OPTION_ERROR (g_option_error_quark ())
70 G_OPTION_ERROR_UNKNOWN_OPTION,
71 G_OPTION_ERROR_BAD_VALUE,
75 GQuark g_option_error_quark (void) G_GNUC_CONST;
80 const gchar *long_name;
87 const gchar *description;
88 const gchar *arg_description;
91 #define G_OPTION_REMAINING ""
93 GOptionContext *g_option_context_new (const gchar *parameter_string);
94 void g_option_context_free (GOptionContext *context);
95 void g_option_context_set_help_enabled (GOptionContext *context,
96 gboolean help_enabled);
97 gboolean g_option_context_get_help_enabled (GOptionContext *context);
98 void g_option_context_set_ignore_unknown_options (GOptionContext *context,
99 gboolean ignore_unknown);
100 gboolean g_option_context_get_ignore_unknown_options (GOptionContext *context);
102 void g_option_context_add_main_entries (GOptionContext *context,
103 const GOptionEntry *entries,
104 const gchar *translation_domain);
105 gboolean g_option_context_parse (GOptionContext *context,
110 void g_option_context_add_group (GOptionContext *context,
111 GOptionGroup *group);
112 void g_option_context_set_main_group (GOptionContext *context,
113 GOptionGroup *group);
114 GOptionGroup *g_option_context_get_main_group (GOptionContext *context);
117 GOptionGroup *g_option_group_new (const gchar *name,
118 const gchar *description,
119 const gchar *help_description,
121 GDestroyNotify destroy);
122 void g_option_group_set_parse_hooks (GOptionGroup *group,
123 GOptionParseFunc pre_parse_func,
124 GOptionParseFunc post_parse_func);
125 void g_option_group_set_error_hook (GOptionGroup *group,
126 GOptionErrorFunc error_func);
127 void g_option_group_free (GOptionGroup *group);
128 void g_option_group_add_entries (GOptionGroup *group,
129 const GOptionEntry *entries);
130 void g_option_group_set_translate_func (GOptionGroup *group,
133 GDestroyNotify destroy_notify);
134 void g_option_group_set_translation_domain (GOptionGroup *group,
135 const gchar *domain);
140 #endif /* __G_OPTION_H__ */