-/*
- * Copyright (c) 1995-2000, Index Data.
- *
- * Permission to use, copy, modify, distribute, and sell this software and
- * its documentation, in whole or in part, for any purpose, is hereby granted,
- * provided that:
- *
- * 1. This copyright and permission notice appear in all copies of the
- * software and its documentation. Notices of copyright or attribution
- * which appear at the beginning of any file must remain unchanged.
- *
- * 2. The name of Index Data or the individual authors may not be used to
- * endorse or promote products derived from this software without specific
- * prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
- * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
- * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
- * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
- * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
- * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
- * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
- * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
- * OF THIS SOFTWARE.
- *
- * $Log: options.h,v $
- * Revision 1.2 2000-02-28 11:20:06 adam
- * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL.
- *
- * Revision 1.1 1999/11/30 13:47:11 adam
- * Improved installation. Moved header files to include/yaz.
- *
- * Revision 1.6 1997/09/01 08:49:50 adam
- * New windows NT/95 port using MSV5.0. To export DLL functions the
- * YAZ_EXPORT modifier was added. Defined in yconfig.h.
- *
- * Revision 1.5 1997/05/14 06:53:43 adam
- * C++ support.
- *
- * Revision 1.4 1995/09/29 17:12:05 quinn
- * Smallish
- *
- * Revision 1.3 1995/09/27 15:02:48 quinn
- * Modified function heads & prototypes.
- *
- * Revision 1.2 1995/05/16 08:50:36 quinn
- * License, documentation, and memory fixes
- *
- * Revision 1.1 1995/03/30 09:39:42 quinn
- * Moved .h files to include directory
- *
- * Revision 1.1 1995/03/27 08:35:19 quinn
- * Created util library
- * Added memory debugging module. Imported options-manager
- *
- * Revision 1.2 1994/08/16 16:16:03 adam
- * bfile header created.
- *
- * Revision 1.1 1994/08/16 16:04:35 adam
- * Added header file options.h
- *
+/* This file is part of the YAZ toolkit.
+ * Copyright (C) 1995-2010 Index Data.
+ * All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of Index Data nor the names of its contributors
+ * may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/**
+ * \file options.h
+ * \brief Header for command line options parsing utilities
*/
-#ifndef OPTIONS_H
-#define OPTIONS_H
+#ifndef YAZ_OPTIONS_H
+#define TAZ_OPTIONS_H
#include <yaz/yconfig.h>
YAZ_BEGIN_CDECL
+
+/** \brief command-line options parsing for main
+ \arg desc command argument description (allowed options)
+ \arg argv main argv
+ \arg argc main argc
+ \arg arg returned argument (for options that take an argument).
+ \retval 0 non-option arg (e.g. filename).
+ \retval -1 unknown option (error). arg is name of unknown option
+ \retval -2 no more options (end of options)
+ \retval c option char
+
+ This function is called repeatedly for each option. Both single
+ char options (-x) as well as GNU long options are supported (--long).
+ The description is a sequence specs where each spec is if the form:
+ [a-zA-Z0-9]({[a-zA-Z0-9]*})+:? . For example: h{help}f{filename}{fname}:
+
+ The first char is what is returned when met (single char option char).
+ The second is zero ore more long option values (synonum for single char)
+ If colon is appended, it means the option takes an argument.
+*/
YAZ_EXPORT int options (const char *desc, char **argv, int argc, char **arg);
+#define YAZ_OPTIONS_ERROR (-1)
+#define YAZ_OPTIONS_EOF (-2)
+
YAZ_END_CDECL
#endif
-
+
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+