misc/error.c

   1 /* $Id: error.c,v 1.6 2003-04-08 00:59:17 btb Exp $ */
   2 /*
   3 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
   4 SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
   5 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
   6 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
   7 IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
   8 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
   9 FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
  10 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
  11 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
  12 COPYRIGHT 1993-1998 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
  13 */
  14 /*
  15  *
  16  * Error handling/printing/exiting code
  17  *
  18  * Old Log:
  19  * Revision 1.12  1994/12/07  18:49:39  matt
  20  * error_init() can now take NULL as parm
  21  *
  22  * Revision 1.11  1994/11/29  15:42:07  matt
  23  * Added newline before error message
  24  *
  25  * Revision 1.10  1994/11/27  23:20:39  matt
  26  * Made changes for new mprintf calling convention
  27  *
  28  * Revision 1.9  1994/06/20  21:20:56  matt
  29  * Allow NULL for warn func, to kill warnings
  30  *
  31  * Revision 1.8  1994/05/20  15:11:35  mike
  32  * mprintf Warning message so you can actually see it.
  33  *
  34  * Revision 1.7  1994/02/10  18:02:38  matt
  35  * Changed 'if DEBUG_ON' to 'ifndef NDEBUG'
  36  *
  37  * Revision 1.6  1993/10/17  18:19:10  matt
  38  * If error_init() not called, Error() now prints the error message before
  39  * calling exit()
  40  *
  41  * Revision 1.5  1993/10/14  15:29:11  matt
  42  * Added new function clear_warn_func()
  43  *
  44  * Revision 1.4  1993/10/08  16:17:19  matt
  45  * Made Assert() call function _Assert(), rather to do 'if...' inline.
  46  *
  47  * Revision 1.3  1993/09/28  12:45:25  matt
  48  * Fixed wrong print call, and made Warning() not append a CR to string
  49  *
  50  * Revision 1.2  1993/09/27  11:46:35  matt
  51  * Added function set_warn_func()
  52  *
  53  * Revision 1.1  1993/09/23  20:17:33  matt
  54  * Initial revision
  55  *
  56  *
  57  */
  58
  59 #ifdef HAVE_CONFIG_H
  60 #include <conf.h>
  61 #endif
  62
  63 #ifdef RCS
  64 static char rcsid[] = "$Id: error.c,v 1.6 2003-04-08 00:59:17 btb Exp $";
  65 #endif
  66
  67 #include <stdio.h>
  68 #include <stdlib.h>
  69 #include <stdarg.h>
  70 #include <string.h>
  71
  72 #include "pstypes.h"
  73 #include "console.h"
  74 #include "mono.h"
  75 #include "error.h"
  76
  77 #define MAX_MSG_LEN 256
  78
  79 //edited 05/17/99 Matt Mueller added err_ prefix to prevent conflicts with statically linking SDL
  80 int err_initialized=0;
  81 //end edit -MM
  82
  83 static void (*ErrorPrintFunc)(char *);
  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         con_printf(CON_URGENT, "%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         Int3();
 124         if (!(expr)) Error("Assertion failed: %s, file %s, line %d",expr_text,filename,linenum);
 125 }
 126
 127 void print_exit_message(void)
 128 {
 129         if (*exit_message)
 130         {
 131                 if (ErrorPrintFunc)
 132                 {
 133                         (*ErrorPrintFunc)(exit_message);
 134                 }
 135                 else
 136                 {
 137 #if (defined(MACINTOSH) && defined(NDEBUG) && defined(RELEASE))
 138                         c2pstr(exit_message);
 139                         ShowCursor();
 140                         ParamText(exit_message, "\p", "\p", "\p");
 141                         StopAlert(ERROR_ALERT, nil);
 142 #else
 143                         con_printf(CON_CRITICAL, "%s\n",exit_message);
 144 #endif
 145                 }
 146         }
 147 }
 148
 149 //terminates with error code 1, printing message
 150 void Error(char *fmt,...)
 151 {
 152         va_list arglist;
 153
 154 #if (defined(MACINTOSH) && defined(NDEBUG) && defined(RELEASE))
 155         strcpy(exit_message,"Error: "); // don't put the new line in for dialog output
 156 #else
 157         strcpy(exit_message,"\nError: ");
 158 #endif
 159         va_start(arglist,fmt);
 160         vsprintf(exit_message+strlen(exit_message),fmt,arglist);
 161         va_end(arglist);
 162
 163         Int3();
 164
 165         if (!err_initialized) print_exit_message();
 166
 167         exit(1);
 168 }
 169
 170 //print out warning message to user
 171 void Warning(char *fmt,...)
 172 {
 173         va_list arglist;
 174
 175         if (warn_func == NULL)
 176                 return;
 177
 178         strcpy(warn_message,"Warning: ");
 179
 180         va_start(arglist,fmt);
 181         vsprintf(warn_message+strlen(warn_message),fmt,arglist);
 182         va_end(arglist);
 183
 184         mprintf((0, "%s\n", warn_message));
 185         (*warn_func)(warn_message);
 186
 187 }
 188
 189 //initialize error handling system, and set default message. returns 0=ok
 190 int error_init(void (*func)(char *), char *fmt, ...)
 191 {
 192         va_list arglist;
 193         int len;
 194
 195         atexit(print_exit_message);             //last thing at exit is print message
 196
 197         ErrorPrintFunc = func;          // Set Error Print Functions
 198
 199         if (fmt != NULL) {
 200                 va_start(arglist,fmt);
 201                 len = vsprintf(exit_message,fmt,arglist);
 202                 va_end(arglist);
 203                 if (len==-1 || len>MAX_MSG_LEN) Error("Message too long in error_init (len=%d, max=%d)",len,MAX_MSG_LEN);
 204         }
 205
 206         err_initialized=1;
 207
 208         return 0;
 209 }