Add GOption.

2004-08-02 Anders Carlsson <andersca@gnome.org> * glib/Makefile.am: * glib/glib.h: * glib/goption.c: * glib/goption.h: * tests/.cvsignore: * tests/Makefile.am: * tests/option-test.c: Add GOption.
2025-08-30 04:44:16 +02:00 · 2004-08-02 21:40:40 +00:00
parent f1024215a4
commit deee47edfd
12 changed files with 1838 additions and 0 deletions
--- a/glib/goption.h
+++ b/glib/goption.h
@@ -0,0 +1,144 @@
+/* goption.h - Option parser
+ *
+ *  Copyright (C) 2004  Anders Carlsson <andersca@gnome.org>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
+ * 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.
+ */
+
+#ifndef __G_OPTION_H__
+#define __G_OPTION_H__
+
+#include <glib/gerror.h>
+#include <glib/gquark.h>
+
+G_BEGIN_DECLS
+
+/* Should go into gtypes.h */
+typedef const gchar * (*GTranslateFunc) (const gchar *str,
+					 gpointer     data);
+
+typedef struct _GOptionContext GOptionContext;
+typedef struct _GOptionGroup   GOptionGroup;
+typedef struct _GOptionEntry   GOptionEntry;
+
+typedef enum
+{
+  G_OPTION_FLAG_HIDDEN       = 1 << 0,
+  G_OPTION_FLAG_IN_MAIN      = 1 << 1,
+} GOptionFlags;
+
+typedef enum
+{
+  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,
+} GOptionArg;
+
+typedef gboolean (*GOptionArgFunc) (const gchar    *option_name,
+				    const gchar    *value,
+				    gpointer        data,
+				    GError        **error);
+
+typedef gboolean (*GOptionParseFunc) (GOptionContext *context,
+				      GOptionGroup   *group,
+				      gpointer	      data,
+				      GError        **error);
+
+typedef void (*GOptionErrorFunc) (GOptionContext *context,
+				  GOptionGroup   *group,
+				  gpointer        data,
+				  GError        **error);
+
+#define G_OPTION_ERROR (g_option_context_error_quark ())
+
+typedef enum
+{
+  G_OPTION_ERROR_UNKNOWN_OPTION,
+  G_OPTION_ERROR_BAD_VALUE,
+  G_OPTION_ERROR_FAILED
+} GOptionError;
+
+GQuark g_option_context_error_quark (void) G_GNUC_CONST;
+
+
+struct _GOptionEntry
+{
+  const char *long_name;
+  char        short_name;
+  int         flags;
+
+  GOptionArg  arg;
+  gpointer    arg_data;
+  
+  const char *description;
+  const char *arg_description;
+};
+
+GOptionContext *g_option_context_new              (const gchar         *parameter_string);
+void            g_option_context_free             (GOptionContext      *context);
+void		g_option_context_set_help_enabled (GOptionContext      *context,
+						   gboolean		help_enabled);
+gboolean	g_option_context_get_help_enabled (GOptionContext      *context);
+void		g_option_context_set_ignore_unknown_options (GOptionContext *context,
+							     gboolean	     ignore_unknown);
+gboolean        g_option_context_get_ignore_unknown_options (GOptionContext *context);
+
+void            g_option_context_add_main_entries (GOptionContext      *context,
+						   const GOptionEntry  *entries,
+						   const gchar         *translation_domain);
+gboolean        g_option_context_parse            (GOptionContext      *context,
+						   gint                *argc,
+						   gchar             ***argv,
+						   GError             **error);
+
+void          g_option_context_add_group      (GOptionContext *context,
+					       GOptionGroup   *group);
+void          g_option_context_set_main_group (GOptionContext *context,
+					       GOptionGroup   *group);
+GOptionGroup *g_option_context_get_main_group (GOptionContext *context);
+
+
+GOptionGroup *g_option_group_new                    (const gchar        *name,
+						     const gchar        *description,
+						     const char         *help_description,
+						     gpointer            user_data,
+						     GDestroyNotify      destroy);
+void	      g_option_group_set_parse_hooks	    (GOptionGroup       *group,
+						     GOptionParseFunc    pre_parse_func,
+						     GOptionParseFunc	 post_parse_func);
+void	      g_option_group_set_error_hook	    (GOptionGroup       *group,
+						     GOptionErrorFunc	 error_func);
+void          g_option_group_free                   (GOptionGroup       *group);
+void          g_option_group_add_entries            (GOptionGroup       *group,
+						     const GOptionEntry *entries);
+void          g_option_group_set_translate_func     (GOptionGroup       *group,
+						     GTranslateFunc      func,
+						     gpointer            data,
+						     GDestroyNotify      destroy_notify);
+void          g_option_group_set_translation_domain (GOptionGroup       *group,
+						     const gchar        *domain);
+
+
+
+
+
+G_END_DECLS
+
+#endif /* __G_OPTION_H__ */