1cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project/* argmatch.h -- definitions and prototypes for argmatch.c 2cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 305436638acc7c010349a69c3395f1a57c642dc62Ying Wang Copyright (C) 1990, 1998-1999, 2001-2002, 2004-2005, 2009-2012 Free Software 4cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project Foundation, Inc. 5cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 605436638acc7c010349a69c3395f1a57c642dc62Ying Wang This program is free software: you can redistribute it and/or modify 7cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project it under the terms of the GNU General Public License as published by 805436638acc7c010349a69c3395f1a57c642dc62Ying Wang the Free Software Foundation; either version 3 of the License, or 905436638acc7c010349a69c3395f1a57c642dc62Ying Wang (at your option) any later version. 10cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 11cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project This program is distributed in the hope that it will be useful, 12cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project but WITHOUT ANY WARRANTY; without even the implied warranty of 13cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project GNU General Public License for more details. 15cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 16cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project You should have received a copy of the GNU General Public License 1705436638acc7c010349a69c3395f1a57c642dc62Ying Wang along with this program. If not, see <http://www.gnu.org/licenses/>. */ 18cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 19cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project/* Written by David MacKenzie <djm@ai.mit.edu> 20cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project Modified by Akim Demaille <demaille@inf.enst.fr> */ 21cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 22cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project#ifndef ARGMATCH_H_ 23cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project# define ARGMATCH_H_ 1 24cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 25cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project# include <stddef.h> 26cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 27cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project# include "verify.h" 28cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 29cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project# define ARRAY_CARDINALITY(Array) (sizeof (Array) / sizeof *(Array)) 30cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 31cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project/* Assert there are as many real arguments as there are values 32cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project (argument list ends with a NULL guard). */ 33cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 34cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project# define ARGMATCH_VERIFY(Arglist, Vallist) \ 35cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project verify (ARRAY_CARDINALITY (Arglist) == ARRAY_CARDINALITY (Vallist) + 1) 36cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 37cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project/* Return the index of the element of ARGLIST (NULL terminated) that 38cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project matches with ARG. If VALLIST is not NULL, then use it to resolve 39cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project false ambiguities (i.e., different matches of ARG but corresponding 40cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project to the same values in VALLIST). */ 41cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 42cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Projectptrdiff_t argmatch (char const *arg, char const *const *arglist, 4305436638acc7c010349a69c3395f1a57c642dc62Ying Wang char const *vallist, size_t valsize) _GL_ATTRIBUTE_PURE; 44cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 45cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project# define ARGMATCH(Arg, Arglist, Vallist) \ 46cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project argmatch (Arg, Arglist, (char const *) (Vallist), sizeof *(Vallist)) 47cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 48cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project/* xargmatch calls this function when it fails. This function should not 49cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project return. By default, this is a function that calls ARGMATCH_DIE which 5005436638acc7c010349a69c3395f1a57c642dc62Ying Wang in turn defaults to 'exit (exit_failure)'. */ 51cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Projecttypedef void (*argmatch_exit_fn) (void); 52cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Projectextern argmatch_exit_fn argmatch_die; 53cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 54cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project/* Report on stderr why argmatch failed. Report correct values. */ 55cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 56cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Projectvoid argmatch_invalid (char const *context, char const *value, 5705436638acc7c010349a69c3395f1a57c642dc62Ying Wang ptrdiff_t problem); 58cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 59cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project/* Left for compatibility with the old name invalid_arg */ 60cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 61cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project# define invalid_arg(Context, Value, Problem) \ 62cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project argmatch_invalid (Context, Value, Problem) 63cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 64cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 65cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 66cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project/* Report on stderr the list of possible arguments. */ 67cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 68cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Projectvoid argmatch_valid (char const *const *arglist, 6905436638acc7c010349a69c3395f1a57c642dc62Ying Wang char const *vallist, size_t valsize); 70cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 71cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project# define ARGMATCH_VALID(Arglist, Vallist) \ 72cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project argmatch_valid (Arglist, (char const *) (Vallist), sizeof *(Vallist)) 73cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 74cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 75cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 7605436638acc7c010349a69c3395f1a57c642dc62Ying Wang/* Same as argmatch, but upon failure, report an explanation of the 7705436638acc7c010349a69c3395f1a57c642dc62Ying Wang failure, and exit using the function EXIT_FN. */ 78cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 79cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Projectptrdiff_t __xargmatch_internal (char const *context, 8005436638acc7c010349a69c3395f1a57c642dc62Ying Wang char const *arg, char const *const *arglist, 8105436638acc7c010349a69c3395f1a57c642dc62Ying Wang char const *vallist, size_t valsize, 8205436638acc7c010349a69c3395f1a57c642dc62Ying Wang argmatch_exit_fn exit_fn); 83cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 84cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project/* Programmer friendly interface to __xargmatch_internal. */ 85cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 8605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# define XARGMATCH(Context, Arg, Arglist, Vallist) \ 8705436638acc7c010349a69c3395f1a57c642dc62Ying Wang ((Vallist) [__xargmatch_internal (Context, Arg, Arglist, \ 8805436638acc7c010349a69c3395f1a57c642dc62Ying Wang (char const *) (Vallist), \ 8905436638acc7c010349a69c3395f1a57c642dc62Ying Wang sizeof *(Vallist), \ 9005436638acc7c010349a69c3395f1a57c642dc62Ying Wang argmatch_die)]) 91cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 92cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project/* Convert a value into a corresponding argument. */ 93cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 94cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Projectchar const *argmatch_to_argument (char const *value, 9505436638acc7c010349a69c3395f1a57c642dc62Ying Wang char const *const *arglist, 9605436638acc7c010349a69c3395f1a57c642dc62Ying Wang char const *vallist, size_t valsize) 9705436638acc7c010349a69c3395f1a57c642dc62Ying Wang _GL_ATTRIBUTE_PURE; 98cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 9905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# define ARGMATCH_TO_ARGUMENT(Value, Arglist, Vallist) \ 10005436638acc7c010349a69c3395f1a57c642dc62Ying Wang argmatch_to_argument (Value, Arglist, \ 10105436638acc7c010349a69c3395f1a57c642dc62Ying Wang (char const *) (Vallist), sizeof *(Vallist)) 102cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project 103cea198a11f15a2eb071d98491ca9a8bc8cebfbc4The Android Open Source Project#endif /* ARGMATCH_H_ */ 104