misc/error.c

   1 /*
   2 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
   3 SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
   4 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
   5 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
   6 IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
   7 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
   8 FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
   9 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
  10 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
  11 COPYRIGHT 1993-1998 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
  12 */
  13 /*
  14  * $Source: /cvs/cvsroot/d2x/misc/error.c,v $
  15  * $Revision: 1.1.1.1 $
  16  * $Author: bradleyb $
  17  * $Date: 2001-01-19 03:30:14 $
  18  *
  19  * Error handling/printing/exiting code
  20  *
  21  * $Log: not supported by cvs2svn $
  22  * Revision 1.1.1.1  1999/06/14 22:13:48  donut
  23  * Import of d1x 1.37 source.
  24  *
  25  * Revision 1.12  1994/12/07  18:49:39  matt
  26  * error_init() can now take NULL as parm
  27  *
  28  * Revision 1.11  1994/11/29  15:42:07  matt
  29  * Added newline before error message
  30  *
  31  * Revision 1.10  1994/11/27  23:20:39  matt
  32  * Made changes for new mprintf calling convention
  33  *
  34  * Revision 1.9  1994/06/20  21:20:56  matt
  35  * Allow NULL for warn func, to kill warnings
  36  *
  37  * Revision 1.8  1994/05/20  15:11:35  mike
  38  * mprintf Warning message so you can actually see it.
  39  *
  40  * Revision 1.7  1994/02/10  18:02:38  matt
  41  * Changed 'if DEBUG_ON' to 'ifndef NDEBUG'
  42  *
  43  * Revision 1.6  1993/10/17  18:19:10  matt
  44  * If error_init() not called, Error() now prints the error message before
  45  * calling exit()
  46  *
  47  * Revision 1.5  1993/10/14  15:29:11  matt
  48  * Added new function clear_warn_func()
  49  *
  50  * Revision 1.4  1993/10/08  16:17:19  matt
  51  * Made Assert() call function _Assert(), rather to do 'if...' inline.
  52  *
  53  * Revision 1.3  1993/09/28  12:45:25  matt
  54  * Fixed wrong print call, and made Warning() not append a CR to string
  55  *
  56  * Revision 1.2  1993/09/27  11:46:35  matt
  57  * Added function set_warn_func()
  58  *
  59  * Revision 1.1  1993/09/23  20:17:33  matt
  60  * Initial revision
  61  *
  62  *
  63  */
  64
  65 #ifdef RCS
  66 static char rcsid[] = "$Id: error.c,v 1.1.1.1 2001-01-19 03:30:14 bradleyb Exp $";
  67 #endif
  68
  69 #include <conf.h>
  70 #include <stdio.h>
  71 #include <stdlib.h>
  72 #include <stdarg.h>
  73 #include <string.h>
  74
  75 #include "pstypes.h"
  76 #include "console.h"
  77 #include "error.h"
  78
  79 #define MAX_MSG_LEN 256
  80
  81 //edited 05/17/99 Matt Mueller added err_ prefix to prevent conflicts with statically linking SDL
  82 int err_initialized=0;
  83 //end edit -MM
  84
  85 char exit_message[MAX_MSG_LEN]="";
  86 char warn_message[MAX_MSG_LEN];
  87
  88 //takes string in register, calls printf with string on stack
  89 void warn_printf(char *s)
  90 {
  91         printf("%s\n",s);
  92 }
  93
  94 void (*warn_func)(char *s)=warn_printf;
  95
  96 //provides a function to call with warning messages
  97 void set_warn_func(void (*f)(char *s))
  98 {
  99         warn_func = f;
 100 }
 101
 102 //uninstall warning function - install default printf
 103 void clear_warn_func(void (*f)(char *s))
 104 {
 105         warn_func = warn_printf;
 106 }
 107
 108 void set_exit_message(char *fmt,...)
 109 {
 110         va_list arglist;
 111         int len;
 112
 113         va_start(arglist,fmt);
 114         len = vsprintf(exit_message,fmt,arglist);
 115         va_end(arglist);
 116
 117         if (len==-1 || len>MAX_MSG_LEN) Error("Message too long in set_exit_message (len=%d, max=%d)",len,MAX_MSG_LEN);
 118
 119 }
 120
 121 void _Assert(int expr,char *expr_text,char *filename,int linenum)
 122 {
 123         if (!(expr)) Error("Assertion failed: %s, file %s, line %d",expr_text,filename,linenum);
 124
 125 }
 126
 127 void print_exit_message(void)
 128 {
 129         if (*exit_message)
 130                 con_printf(CON_CRITICAL, "%s\n",exit_message);
 131 }
 132
 133 //terminates with error code 1, printing message
 134 void Error(char *fmt,...)
 135 {
 136         va_list arglist;
 137
 138         strcpy(exit_message,"\nError: ");
 139
 140         va_start(arglist,fmt);
 141         vsprintf(exit_message+strlen(exit_message),fmt,arglist);
 142         va_end(arglist);
 143
 144         con_printf(CON_CRITICAL, exit_message);
 145
 146         exit(1);
 147 }
 148
 149 //print out warning message to user
 150 void Warning(char *fmt,...)
 151 {
 152         va_list arglist;
 153
 154         if (warn_func == NULL)
 155                 return;
 156
 157         strcpy(warn_message,"Warning: ");
 158
 159         va_start(arglist,fmt);
 160         vsprintf(warn_message+strlen(warn_message),fmt,arglist);
 161         va_end(arglist);
 162
 163         con_printf(CON_URGENT, warn_message);
 164
 165 }
 166
 167 //initialize error handling system, and set default message. returns 0=ok
 168 int error_init(char *fmt,...)
 169 {
 170         va_list arglist;
 171         int len;
 172
 173         atexit(print_exit_message);             //last thing at exit is print message
 174
 175         if (fmt != NULL) {
 176                 va_start(arglist,fmt);
 177                 len = vsprintf(exit_message,fmt,arglist);
 178                 va_end(arglist);
 179                 if (len==-1 || len>MAX_MSG_LEN) Error("Message too long in error_init (len=%d, max=%d)",len,MAX_MSG_LEN);
 180         }
 181
 182         err_initialized=1;
 183
 184         return 0;
 185 }