/* argmatch.h -- definitions and prototypes for argmatch.c
- Copyright (C) 1990, 1998 Free Software Foundation, Inc.
+
+ Copyright (C) 1990, 1998, 1999, 2001, 2002, 2004 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
/* 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
+
+# include <stddef.h>
+
+# define ARRAY_CARDINALITY(Array) (sizeof (Array) / sizeof *(Array))
+
+# define ARGMATCH_CONSTRAINT(Arglist, Vallist) \
+ (ARRAY_CARDINALITY (Arglist) == ARRAY_CARDINALITY (Vallist) + 1)
-# if HAVE_CONFIG_H
-# include <config.h>
-# endif
+/* Assert there are as many real arguments as there are values
+ (argument list ends with a NULL guard). ARGMATCH_VERIFY is
+ preferred, since it is guaranteed to be checked at compile-time.
+ ARGMATCH_ASSERT is for backward compatibility only. */
-# include <sys/types.h>
+# define ARGMATCH_VERIFY(Arglist, Vallist) \
+ struct argmatch_verify \
+ { \
+ char argmatch_verify[ARGMATCH_CONSTRAINT(Arglist, Vallist) ? 1 : -1]; \
+ }
-# ifndef PARAMS
-# if PROTOTYPES || (defined (__STDC__) && __STDC__)
-# define PARAMS(args) args
-# else
-# define PARAMS(args) ()
-# endif /* GCC. */
-# endif /* Not PARAMS. */
+# define ARGMATCH_ASSERT(Arglist, Vallist) \
+ assert (ARGMATCH_CONSTRAINT (Arglist, Vallist))
/* 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
to the same values in VALLIST). */
-int argmatch
- PARAMS ((const char *arg, const char *const *arglist,
- const char *vallist, size_t valsize));
-int argcasematch
- PARAMS ((const char *arg, const char *const *arglist,
- const char *vallist, size_t valsize));
-
-# define ARGMATCH(Arg, ARGLIST, Vallist) \
- argmatch (Arg, Arglist, (const char *) Vallist, sizeof (*Vallist))
-
-# define ARGCASEMATCH(Arg, Arglist, Vallist) \
- argcasematch (Arg, Arglist, (const char *) Vallist, sizeof (*Vallist))
+int argmatch (char const *arg, char const *const *arglist,
+ char const *vallist, size_t valsize);
+# define ARGMATCH(Arg, Arglist, Vallist) \
+ argmatch (Arg, Arglist, (char const *) (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) (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));
+void argmatch_invalid (char const *context, char const *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)
/* Report on stderr the list of possible arguments. */
-void argmatch_valid
- PARAMS ((const char *const *arglist,
- const char *vallist, size_t valsize));
+void argmatch_valid (char const *const *arglist,
+ char const *vallist, size_t valsize);
# define ARGMATCH_VALID(Arglist, Vallist) \
- valid_args (Arglist, (const char *) Vallist, sizeof (*Vallist))
-
+ argmatch_valid (Arglist, (char const *) (Vallist), sizeof *(Vallist))
-/* Returns matches, or, upon error, report explanatory message and
- exit. */
-int __xargmatch_internal
- PARAMS ((const char *kind,
- 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)]
+/* Same as argmatch, but upon failure, reports a explanation on the
+ failure, and exits using the function EXIT_FN. */
-# define XARGCASEMATCH(Kind, Arg, Arglist, Vallist) \
- Vallist [__xargmatch_internal (Kind, Arg, Arglist, \
- (const char *) Vallist, sizeof (*Vallist), 0)]
+int __xargmatch_internal (char const *context,
+ char const *arg, char const *const *arglist,
+ char const *vallist, size_t valsize,
+ argmatch_exit_fn exit_fn);
+/* Programmer friendly interface to __xargmatch_internal. */
+# define XARGMATCH(Context, Arg, Arglist, Vallist) \
+ ((Vallist) [__xargmatch_internal (Context, Arg, Arglist, \
+ (char const *) (Vallist), \
+ sizeof *(Vallist), \
+ argmatch_die)])
/* Convert a value into a corresponding argument. */
-const char *argmatch_to_argument
- PARAMS ((char *value, const char *const *arglist,
- const char *vallist, size_t valsize));
+char const *argmatch_to_argument (char const *value,
+ char const *const *arglist,
+ char const *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, \
+ (char const *) (Vallist), sizeof *(Vallist))
-#endif /* _ARGMATCH_H_ */
+#endif /* ARGMATCH_H_ */