include/yaz/options.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /**
  29  * \file options.h
  30  * \brief Header for command line options parsing utilities
  31  */
  32
  33 #ifndef YAZ_OPTIONS_H
  34 #define YAZ_OPTIONS_H
  35 #include <yaz/yconfig.h>
  36
  37 YAZ_BEGIN_CDECL
  38
  39
  40 /** \brief command-line options parsing for main
  41     \arg desc command argument description (allowed options)
  42     \arg argv main argv
  43     \arg argc main argc
  44     \arg arg returned argument (for options that take an argument).
  45     \retval 0 non-option arg (e.g. filename).
  46     \retval -1 unknown option (error). arg is name of unknown option
  47     \retval -2 no more options (end of options)
  48     \retval c option char
  49
  50     This function is called repeatedly for each option. Both single
  51     char options (-x) as well as GNU long options are supported (--long).
  52     The description is a sequence specs where each spec is if the form:
  53     [a-zA-Z0-9]({[a-zA-Z0-9]*})+:? . For example: h{help}f{filename}{fname}:
  54
  55     The first char is what is returned when met (single char option char).
  56     The second is zero ore more long option values (synonum for single char)
  57     If colon is appended, it means the option takes an argument.
  58     If argv includes empty long option (--) that means "end of options" :
  59     all argv data following that is considered non-options .. (0 returned
  60     for each).
  61 */
  62 YAZ_EXPORT int options(const char *desc, char **argv, int argc, char **arg);
  63
  64 #define YAZ_OPTIONS_ERROR (-1)
  65 #define YAZ_OPTIONS_EOF (-2)
  66
  67 YAZ_END_CDECL
  68
  69 #endif
  70
  71 /*
  72  * Local variables:
  73  * c-basic-offset: 4
  74  * c-file-style: "Stroustrup"
  75  * indent-tabs-mode: nil
  76  * End:
  77  * vim: shiftwidth=4 tabstop=8 expandtab
  78  */
  79