WebSVN – tendra.SVN – Diff – /trunk/src/utilities/sid/error.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.
 */
  ** Repr:	<private>
+ *
  * This is the named string type.
+ *
  ** Type:	ErrorProcP
- ** Repr:	void (*) PROTO_S ((OStreamP, ETagP, GenericP))
+ ** Repr:	void (*) (OStreamP, ETagP, GenericP)
+ *
  * This is the type of a procedure that is used to display the contents of a
  * tag when reporting an error.
+ *
  ** Type:	ErrorInitProcP
- ** Repr:	void (*) PROTO_S ((void))
+ ** Repr:	void (*) (void)
+ *
  * This is the type of the procedure that will be called to define all of the
  * error messages for the current program.
+ *
  ** Type:	ETagDataT
  * This is the return type of the ``error_redefine_error'' function.
+ *
  ***=== FUNCTIONS ============================================================
+ *
  ** Function:	void			error_init
- *			PROTO_S ((CStringP program, ErrorInitProcP proc))
+ *			(CStringP program, ErrorInitProcP proc)
  ** Exceptions:	XX_dalloc_no_memory
+ *
  * This function initialises the error reporting mechanism.  It should only be
  * called once, at the start of the program.  The basename of the program
  * string is used as the program name, for the "${program name}" tag. The
  * function once.  Note that the error initialisation procedure is not
  * expected to be used to initialise named strings: these should be explicitly
  * initialised before they are used.
+ *
  ** Function:	void			error_call_init_proc
- *			PROTO_S ((void))
+ *			(void)
  ** Exceptions:
+ *
  * This calls the error initialisation procedure if it has not already been
  * called.  This function should be called before ``error_report'' (actually,
  * it should be called before the error value that will be passed to that
  * function is accessed).
+ *
  ** Function:	ETagP			error_define_tag
- *			PROTO_S ((CStringP name))
+ *			(CStringP name)
  ** Exceptions:	XX_dalloc_no_memory
+ *
  * This function defines a tag with the specified name, and returns it.  The
  * name should not be modified or deallocated.  It is possible to define the
  * same tag more than once (but the same value will be returned each time).
+ *
  ** Function:	ErrorP			error_define_error
- *			PROTO_S ((CStringP name, ESeverityT severity,
+ *			(CStringP name, ESeverityT severity,
- *				  CStringP message, GenericP data))
+ *				  CStringP message, GenericP data)
  ** Exceptions:	XX_dalloc_no_memory
+ *
  * This function defines an error with the specified name, and returns it.
  * The name should not be modified or deallocated.  The severity level is used
  * to decide whether or not an error should be shown and whether or not the
  * when the error is reported (the sequence "${tag name}" will be replaced by
  * the value of the tag when the error is reported).  The data is for use by
  * the program.
+ *
  ** Function:	void			error_intern_tags
- *			PROTO_S ((ETagDataP vector))
+ *			(ETagDataP vector)
  ** Exceptions:	XX_dalloc_no_memory
+ *
  * This function changes the name entries in the specified vector into error
  * tags.  The vector should be terminated by the macro ``ERROR_END_TAG_LIST''.
  * This function should only be called once on any vector.
+ *
  ** Function:	void			error_intern_errors
- *			PROTO_S ((ErrorDataP vector))
+ *			(ErrorDataP vector)
  ** Exceptions:	XX_dalloc_no_memory
+ *
  * This function changes the name entries in the specified vector into errors.
  * The vector should be terminated by the macro ``ERROR_END_ERROR_LIST''.
  * This function should only be called once on any vector.
+ *
  ** Function:	ErrorStatusT		error_redefine_error
- *			PROTO_S ((CStringP name, CStringP message))
+ *			(CStringP name, CStringP message)
  ** Exceptions:	XX_dalloc_no_memory
+ *
  * This function changes the error message for the error with the specified
  * name.  If necessary, the error initialisation procedure will be called to
  * initialise the errors before they are redefined.  If the error does not
  * message contains an unterminated tag, the function will return
  * ``ERROR_STATUS_BAD_MESSAGE''.  If the function succeeds, it will return
  * ``ERROR_STATUS_SUCCESS''.
+ *
  ** Function:	ErrorP			error_lookup_error
- *			PROTO_S ((CStringP name))
+ *			(CStringP name)
  ** Exceptions:
+ *
  * This function returns the error with the specified name.  If the error does
  * not exist, it returns the null pointer.  If necessary, the error
  * initialisation procedure will be called to initialise the error messages
  * before they are looked up.
+ *
  ** Function:	GenericP		error_data
- *			PROTO_S ((ErrorP error))
+ *			(ErrorP error)
  ** Exceptions:
+ *
  * This function returns the data associated with the specified error.
+ *
  ** Function:	void			error_report
- *			PROTO_S ((ErrorP error, ErrorProcP proc,
+ *			(ErrorP error, ErrorProcP proc,
- *				  GenericP closure))
+ *				  GenericP closure)
  ** Exceptions:	XX_dalloc_no_memory, XX_ostream_write_error
+ *
  * This function reports the specified error.  The procedure is used to print
  * out information for tags.  It is called with the output stream, the tag and
  * the specified closure.  If the procedure doesn't know about the tag, it
  * the ``error_set_min_severity'' function.  The function will cause the
  * program to exit if the error's severity level is ``ERROR_SEVERITY_FATAL''
  * or higher.
+ *
  ** Function:	void			error_set_min_report_severity
- *			PROTO_S ((ESeverityT severity))
+ *			(ESeverityT severity)
  ** Exceptions:
+ *
  * This function sets the minimum severity of error that should be reported.
+ *
  ** Function:	ESeverityT		error_get_min_report_severity
- *			PROTO_S ((void))
+ *			(void)
  ** Exceptions:
+ *
  * This function returns the minimum severity of error that will be reported.
+ *
  ** Function:	ESeverityT		error_max_reported_severity
- *			PROTO_S ((void))
+ *			(void)
  ** Exceptions:
+ *
  * This function returns the severity of the error with the highest severity
  * that has been passed to ``error_report''.
+ *
  ** Function:	void			error_set_severity_message
- *			PROTO_S ((ESeverityT severity, CStringP message))
+ *			(ESeverityT severity, CStringP message)
  ** Exceptions:
+ *
  * This function sets the message to be displayed when the "${severity}" tag
  * is encountered for the specified severity.  Tags are not expanded in the
  * message. The message should not be modified or deallocated.
+ *
  ** Function:	BoolT			error_set_prefix_message
- *			PROTO_S ((CStringP message))
+ *			(CStringP message)
  ** Exceptions:	XX_dalloc_no_memory
+ *
  * This function sets the error message prefix string.  This string is output
  * by ``error_display'' before outputting any actual error message.  Tags are
  * expanded, but only for the standard tags: "${program name}", "${severity}",
  * "${dollar}", "${this error name}", "${open brace}", and "${close brace}".
  * All other tags will be ignored.  The function returns true if the message
  * was valid, and false if there was an unterminated tag in the message.
+ *
  ** Function:	EStringP		error_define_string
- *			PROTO_S ((CStringP name, CStringP contents))
+ *			(CStringP name, CStringP contents)
  ** Exceptions:	XX_dalloc_no_memory
+ *
  * This function defines a named string with the specified name, and assigns
  * it the specified contents.  Neither the name nor the contents should be
  * modified or deallocated.  No tag splitting is performed on the contents.
+ *
  ** Function:	void			error_intern_strings
- *			PROTO_S ((EStringDataP vector))
+ *			(EStringDataP vector)
  ** Exceptions:	XX_dalloc_no_memory
+ *
  * This function changes the name and contents entries in the specified vector
  * into named strings.  The vector should be terminated by the macro
  * ``ERROR_END_STRING_LIST''.  This function should only be called once on any
  * vector.
+ *
  ** Function:	BoolT			error_redefine_string
- *			PROTO_S ((CStringP name, CStringP contents))
+ *			(CStringP name, CStringP contents)
  ** Exceptions:	XX_dalloc_no_memory
+ *
  * This function changes the contents of the named string with the specified
  * name.  If the name does not exist, the function returns false, otherwise it
  * returns true.
+ *
  ** Function:	EStringP		error_lookup_string
- *			PROTO_S ((CStringP name))
+ *			(CStringP name)
  ** Exceptions:
+ *
  * This function returns the named string with the specified name.  If the
  * named string does not exist, the function returns the null pointer.
+ *
  ** Function:	CStringP		error_string_contents
- *			PROTO_S ((EStringP estring))
+ *			(EStringP estring)
  ** Exceptions:
+ *
  * This function returns the contents of the specified named string.  The
  * returned string should not be modified or deallocated.
+ *
  ** Function:	void			write_error_file
- *			PROTO_S ((OStreamP ostream))
+ *			(OStreamP ostream)
  ** Exceptions:	XX_dalloc_no_memory, XX_ostream_write_error
+ *
  * This function writes out an error file (in the same format as parsed by the
  * functions in "error-file.[ch]") to the specified ostream.
+ *
     ERROR_SEVERITY_INFORMATION,
     ERROR_SEVERITY_WARNING,
     ERROR_SEVERITY_ERROR,
     ERROR_SEVERITY_FATAL,
     ERROR_SEVERITY_INTERNAL
 } ESeverityT, *ESeverityP;
 #endif /* defined (FS_NO_ENUM) */
 typedef struct ETagT {
     struct ETagT	       *next;
     CStringP			name;
     struct EStringT	       *next;
     CStringP			name;
     CStringP			contents;
 } EStringT, *EStringP;
-typedef void (*ErrorProcP) PROTO_S ((OStreamP, ETagP, GenericP));
+typedef void(*ErrorProcP)(OStreamP, ETagP, GenericP);
-typedef void (*ErrorInitProcP) PROTO_S ((void));
+typedef void(*ErrorInitProcP)(void);
 typedef UNION ETagDataT {
     CStringP			name;
     ETagP			tag;
 } ETagDataT, *ETagDataP;
 typedef UNION ErrorDataT {
 } ErrorStatusT, *ErrorStatusP;
 #endif /* defined (FS_NO_ENUM) */
 /*--------------------------------------------------------------------------*/
-extern void			error_init
-	PROTO_S ((CStringP, ErrorInitProcP));
+extern void		error_init(CStringP, ErrorInitProcP);
-extern void			error_call_init_proc
+extern void		error_call_init_proc(void);
-	PROTO_S ((void));
-extern ETagP			error_define_tag
+extern ETagP		error_define_tag(CStringP);
-	PROTO_S ((CStringP));
-extern ErrorP			error_define_error
+extern ErrorP		error_define_error(CStringP, ESeverityT, CStringP,
-	PROTO_S ((CStringP, ESeverityT, CStringP, GenericP));
+					   GenericP);
-extern void			error_intern_tags
+extern void		error_intern_tags(ETagDataP);
-	PROTO_S ((ETagDataP));
-extern void			error_intern_errors
+extern void		error_intern_errors(ErrorDataP);
-	PROTO_S ((ErrorDataP));
-extern ErrorStatusT		error_redefine_error
+extern ErrorStatusT	error_redefine_error(CStringP, CStringP);
-	PROTO_S ((CStringP, CStringP));
-extern ErrorP			error_lookup_error
+extern ErrorP		error_lookup_error(CStringP);
-	PROTO_S ((CStringP));
-extern GenericP			error_data
+extern GenericP		error_data(ErrorP);
-	PROTO_S ((ErrorP));
-extern void			error_report
-	PROTO_S ((ErrorP, ErrorProcP, GenericP));
+extern void		error_report(ErrorP, ErrorProcP, GenericP);
-extern void			error_set_min_report_severity
+extern void		error_set_min_report_severity(ESeverityT);
-	PROTO_S ((ESeverityT));
-extern ESeverityT		error_get_min_report_severity
+extern ESeverityT	error_get_min_report_severity(void);
-	PROTO_S ((void));
-extern ESeverityT		error_max_reported_severity
+extern ESeverityT	error_max_reported_severity(void);
-	PROTO_S ((void));
-extern void			error_set_severity_message
+extern void		error_set_severity_message(ESeverityT, CStringP);
-	PROTO_S ((ESeverityT, CStringP));
-extern BoolT			error_set_prefix_message
+extern BoolT		error_set_prefix_message(CStringP);
-	PROTO_S ((CStringP));
-extern EStringP			error_define_string
+extern EStringP		error_define_string(CStringP, CStringP);
-	PROTO_S ((CStringP, CStringP));
-extern void			error_intern_strings
+extern void		error_intern_strings(EStringDataP);
-	PROTO_S ((EStringDataP));
-extern BoolT			error_redefine_string
+extern BoolT		error_redefine_string(CStringP, CStringP);
-	PROTO_S ((CStringP, CStringP));
-extern EStringP			error_lookup_string
+extern EStringP		error_lookup_string(CStringP);
-	PROTO_S ((CStringP));
-extern CStringP			error_string_contents
+extern CStringP		error_string_contents(EStringP);
-	PROTO_S ((EStringP));
-extern void			write_error_file
+extern void		write_error_file(OStreamP);
-	PROTO_S ((OStreamP));
 /*--------------------------------------------------------------------------*/
-#define ERROR_END_TAG_LIST UB NIL (CStringP) UE
+#define ERROR_END_TAG_LIST UB NIL(CStringP)UE
 #define ERROR_END_ERROR_LIST \
-UB {NIL (CStringP), (ESeverityT) 0, NIL (CStringP), NIL (GenericP)} UE
+UB {NIL(CStringP), (ESeverityT)0, NIL(CStringP), NIL(GenericP)} UE
-#define ERROR_END_STRING_LIST UB {NIL (CStringP), NIL (CStringP)} UE
+#define ERROR_END_STRING_LIST UB {NIL(CStringP), NIL(CStringP)} UE
 #endif /* !defined (H_ERROR) */
 /*
  * Local variables(smf):

Subversion Repositories tendra.SVN

(root)/trunk/src/utilities/sid/error.h – Rev 2 → 7