Use the version from diffutils-2.8.2.

[gnulib.git] / lib / argmatch.h

diff --git a/lib/argmatch.h b/lib/argmatch.h
index 67cbd02..b719300 100644 (file)
--- a/lib/argmatch.h
+++ b/lib/argmatch.h
@@ -1,5 +1,5 @@
 /* argmatch.h -- definitions and prototypes for argmatch.c
-   Copyright (C) 1990, 1998 Free Software Foundation, Inc.
+   Copyright (C) 1990, 1998, 1999, 2001 Free Software Foundation, Inc.
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -18,8 +18,8 @@
 /* Written by David MacKenzie <djm@ai.mit.edu>
    Modified by Akim Demaille <demaille@inf.enst.fr> */
 
-#ifndef _ARGMATCH_H_
-# define _ARGMATCH_H_ 1
+#ifndef ARGMATCH_H_
+# define ARGMATCH_H_ 1
 
 # if HAVE_CONFIG_H
 #  include <config.h>
@@ -35,6 +35,17 @@
 #  endif  /* GCC.  */
 # endif  /* Not PARAMS.  */
 
+/* Assert there are as many real arguments as there are values
+   (argument list ends with a NULL guard).  There is no execution
+   cost, since it will be statically evalauted to `assert (0)' or
+   `assert (1)'.  Unfortunately there is no -Wassert-0. */
+
+# undef ARRAY_CARDINALITY
+# define ARRAY_CARDINALITY(Array) (sizeof ((Array)) / sizeof (*(Array)))
+
+# define ARGMATCH_ASSERT(Arglist, Vallist)      \
+  assert (ARRAY_CARDINALITY ((Arglist)) == ARRAY_CARDINALITY ((Vallist)) + 1)
+
 /* Return the index of the element of ARGLIST (NULL terminated) that
    matches with ARG.  If VALLIST is not NULL, then use it to resolve
    false ambiguities (i.e., different matches of ARG but corresponding
@@ -48,22 +59,26 @@ int argcasematch
           const char *vallist, size_t valsize));
 
 # define ARGMATCH(Arg, Arglist, Vallist) \
-  argmatch (Arg, Arglist, (const char *) Vallist, sizeof (*Vallist))
+  argmatch ((Arg), (Arglist), (const char *) (Vallist), sizeof (*(Vallist)))
 
 # define ARGCASEMATCH(Arg, Arglist, Vallist) \
-  argcasematch (Arg, Arglist, (const char *) Vallist, sizeof (*Vallist))
-
+  argcasematch ((Arg), (Arglist), (const char *) (Vallist), sizeof (*(Vallist)))
 
+/* xargmatch calls this function when it fails.  This function should not
+   return.  By default, this is a function that calls ARGMATCH_DIE which
+   in turn defaults to `exit (EXIT_FAILURE)'.  */
+typedef void (*argmatch_exit_fn) PARAMS ((void));
+extern argmatch_exit_fn argmatch_die;
 
 /* Report on stderr why argmatch failed.  Report correct values. */
 
 void argmatch_invalid
-  PARAMS ((const char *kind, const char *value, int problem));
+  PARAMS ((const char *context, const char *value, int problem));
 
 /* Left for compatibility with the old name invalid_arg */
 
-# define invalid_arg(Kind, Value, Problem) \
-       argmatch_invalid (Kind, Value, Problem)
+# define invalid_arg(Context, Value, Problem) \
+  argmatch_invalid ((Context), (Value), (Problem))
 
 
 
@@ -74,36 +89,41 @@ void argmatch_valid
           const char *vallist, size_t valsize));
 
 # define ARGMATCH_VALID(Arglist, Vallist) \
-  valid_args (Arglist, (const char *) Vallist, sizeof (*Vallist))
+  argmatch_valid (Arglist, (const char *) Vallist, sizeof (*(Vallist)))
+
 
 
-/* Returns matches, or, upon error, report explanatory message and
-   exit.  */
+/* Same as argmatch, but upon failure, reports a explanation on the
+   failure, and exits using the function EXIT_FN. */
 
 int __xargmatch_internal
-  PARAMS ((const char *kind,
+  PARAMS ((const char *context,
           const char *arg, const char *const *arglist,
           const char *vallist, size_t valsize,
-          int sensitive));
-
-# define XARGMATCH(Kind, Arg, Arglist, Vallist) \
-  Vallist [__xargmatch_internal (Kind, Arg, Arglist, \
-                        (const char *) Vallist, sizeof (*Vallist), 1)]
+          int case_sensitive, argmatch_exit_fn exit_fn));
 
-# define XARGCASEMATCH(Kind, Arg, Arglist, Vallist) \
-  Vallist [__xargmatch_internal (Kind, Arg, Arglist, \
-                        (const char *) Vallist, sizeof (*Vallist), 0)]
+/* Programmer friendly interface to __xargmatch_internal. */
 
+# define XARGMATCH(Context, Arg, Arglist, Vallist)                     \
+  (Vallist [__xargmatch_internal ((Context), (Arg), (Arglist), \
+                                  (const char *) (Vallist),    \
+                                 sizeof (*(Vallist)),          \
+                                 1, argmatch_die)])
 
+# define XARGCASEMATCH(Context, Arg, Arglist, Vallist)         \
+  (Vallist [__xargmatch_internal ((Context), (Arg), (Arglist), \
+                                  (const char *) (Vallist),    \
+                                 sizeof (*(Vallist)),          \
+                                 0, argmatch_die)])
 
 /* Convert a value into a corresponding argument. */
 
 const char *argmatch_to_argument
-  PARAMS ((char *value, const char *const *arglist,
+  PARAMS ((char const *value, const char *const *arglist,
           const char *vallist, size_t valsize));
 
-# define ARGMATCH_TO_ARGUMENT(Value, Arglist, Vallist)         \
-   argmatch_to_argument ((char *) &Value, Arglist,     \
-                        (const char *) Vallist, sizeof (*Vallist))
+# define ARGMATCH_TO_ARGUMENT(Value, Arglist, Vallist)                 \
+  argmatch_to_argument ((Value), (Arglist),            \
+                       (const char *) (Vallist), sizeof (*(Vallist)))
 
-#endif /* _ARGMATCH_H_ */
+#endif /* ARGMATCH_H_ */