WebSVN – tendra.SVN – Diff – /branches/tendra5/src/utilities/sid/arg-parse.h

+/*
+ * Copyright (c) 2002-2005 The TenDRA Project <http://www.tendra.org/>.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. 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.
+ * 3. Neither the name of The TenDRA Project 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 COPYRIGHT HOLDERS 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 COPYRIGHT HOLDERS OR
+ * 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.
+ *
+ * $Id$
+ */
 /*
     		 Crown Copyright (c) 1997
     This TenDRA(r) Computer Program is subject to Copyright
     owned by the United Kingdom Secretary of State for Defence
     acting through the Defence Evaluation and Research Agency
     (DERA).  It is made available to Recipients with a
     royalty-free licence for its use, reproduction, transfer
     to other parties and amendment for any purpose not excluding
     product development provided that any such use et cetera
     shall be deemed to be acceptance of the following conditions:-
         (1) Its Recipients shall ensure that this Notice is
         reproduced upon any copies or amended versions of it;
         (2) Any amended version of it shall be clearly marked to
         show both the nature of and the organisation responsible
         for the relevant amendment or amendments;
         (3) Its onward transfer from a recipient to another
         party shall be deemed to be that party's acceptance of
         these conditions;
         (4) DERA gives no warranty or assurance as to its
         quality or suitability for any purpose and DERA accepts
         no liability whatsoever in relation to any use to which
         it may be put.
 */
  *	AT_FOLLOWING
+ *
  * This is the type of an option with one following argument.  The procedure
  * will be called with the option that was selected, the error closure, the
  * option closure, and the argument to the option.
  *
  *	AT_EMPTY
+ *
  * This is the type of an option with no argument.  The procedure will be
  * called with the option that was selected, the error closure, and the option
  * closure.
  * This is the type of an option with two following arguments.  The procedure
  * will be called with the option that was selected, the error closure, the
  * option closure, and the arguments to the option.
+ *
  *	AT_FOLLOWING3
  *
  * This is the type of an option with three following arguments.  The
  * procedure will be called with the option that was selected, the error
  * closure, the option closure, and the arguments to the option.
  *
  * Note that if a matched option is a short option, then the current position
  * is passed to the option handling procedure as the option name.  For long
  * options, the entire option string is passed.  If the handler is interested
  * in the option name, it should check the start of this string: if it is '-'
  * or '+' it should be a long option; otherwise it should be a short option.
+ *
  ** Type:	ArgProcP
  ** Repr:	void (*) (CStringP, ArgUsageP, GenericP, ...)
  *
  * This is the type of a procedure to be called to parse a complex option.
  * Because of union initialisation problems, the latter arguments of this
  * function are untyped.
+ *
  ** Type:	ArgListT
  ** Type:	ArgListP
  ** Repr:	<private>
  *
  * This is the type of an entry in an option list.  A vector of such entries
  * should be passed to the ``arg_parse_arguments'' function, with the last
  * entry being the ``ARG_PARSE_END_LIST'' macro.  Each entry has the following
  * fields: a name field (the name of the option without the leading '--' or
  * '++'), a short name field (a character), a type field (the type of the
  *	};
+ *
  * If an option has only a short form, then the name should be NIL (CStringP);
  * if it has only a long form, then the character should be '\0'.  It is
  * illegal for an option to have neither a long form or a short form.
  *
  ** Type:	ArgUsageT
  ** Type:	ArgUsageP
  ** Repr:	struct {CStringP usage; ArgListP arg_list;}
  *
  * This is the type of argument to be passed to ``write_arg_usage''.
+ *
  ***=== FUNCTIONS ============================================================
  *
  ** Function:	void			arg_parse_intern_descriptions
- *			PROTO_S ((ArgListP arg_list))
+ *			(ArgListP arg_list)
  ** Exceptions:	XX_dalloc_no_memory, XX_error_redefined_string
+ *
  * This function should be called on all option lists that the program uses,
  * before they are passed to ``arg_parse_arguments''.  It replaces the
  * descrption name with the named string it represents.  It should only be
  * called once on each list.  The named strings used should be interned before
  * this function is called.
+ *
  ** Function:	int			arg_parse_arguments
- *			PROTO_S ((ArgListP arg_list, EStringP usage, int argc,
+ *			(ArgListP arg_list, EStringP usage, int argc,
- *				  char **argv))
+ *				  char **argv)
  ** Exceptions:	XX_dalloc_no_memory, XX_ostream_write_error
+ *
  * This function does the argument parsing.  The arg_list argument should
  * specify the valid options for the program.  The usage estring should be a
  * named string, whose content is a summary of the program's usage.  The argc
  * of the program's argument list (the program name) should not be passed to
  * this function.  The function returns the number of elements of the list
  * that it parsed.
+ *
  ** Function:	void			write_arg_usage
- *			PROTO_S ((OStreamP ostream, ArgUsageP closure))
+ *			(OStreamP ostream, ArgUsageP closure)
  ** Exceptions:	XX_dalloc_no_memory, XX_ostream_write_error
+ *
  * This function can be used to write out a usage message based upon the usage
  * information supplied.
+ *
 typedef struct ArgUsageT {
     CStringP			usage;
     struct ArgListT	       *arg_list;
 } ArgUsageT, *ArgUsageP;
-typedef void (*ArgProcP) PROTO_S ((CStringP, ArgUsageP, GenericP, ...));
+typedef void(*ArgProcP)(CStringP, ArgUsageP, GenericP, ...);
 typedef struct ArgListT {
     CStringP			name;
     char			short_name;
     ArgTypeT			type;
     } u;
 } ArgListT, *ArgListP;
 /*--------------------------------------------------------------------------*/
-extern void			arg_parse_intern_descriptions
+extern void		arg_parse_intern_descriptions(ArgListP);
-	PROTO_S ((ArgListP));
-extern int			arg_parse_arguments
-	PROTO_S ((ArgListP, EStringP, int, char **));
+extern int		arg_parse_arguments(ArgListP, EStringP, int, char **);
-extern void			write_arg_usage
+extern void		write_arg_usage(OStreamP, ArgUsageP);
-	PROTO_S ((OStreamP, ArgUsageP));
 /*--------------------------------------------------------------------------*/
 #define ARG_PARSE_END_LIST \
-{NIL (CStringP), '\0', (ArgTypeT) 0, NIL (ArgProcP), NIL (GenericP), \
+{NIL(CStringP), '\0', (ArgTypeT)0, NIL(ArgProcP), NIL(GenericP), \
- UB NIL (CStringP) UE}
+ UB NIL(CStringP)UE}
 #endif /* !defined (H_ARG_PARSE) */
 /*
  * Local variables(smf):

Subversion Repositories tendra.SVN

(root)/branches/tendra5/src/utilities/sid/arg-parse.h – Rev 5 → 6