nuclear@14: /*
nuclear@14:  * jerror.c
nuclear@14:  *
nuclear@14:  * Copyright (C) 1991-1998, Thomas G. Lane.
nuclear@14:  * This file is part of the Independent JPEG Group's software.
nuclear@14:  * For conditions of distribution and use, see the accompanying README file.
nuclear@14:  *
nuclear@14:  * This file contains simple error-reporting and trace-message routines.
nuclear@14:  * These are suitable for Unix-like systems and others where writing to
nuclear@14:  * stderr is the right thing to do.  Many applications will want to replace
nuclear@14:  * some or all of these routines.
nuclear@14:  *
nuclear@14:  * If you define USE_WINDOWS_MESSAGEBOX in jconfig.h or in the makefile,
nuclear@14:  * you get a Windows-specific hack to display error messages in a dialog box.
nuclear@14:  * It ain't much, but it beats dropping error messages into the bit bucket,
nuclear@14:  * which is what happens to output to stderr under most Windows C compilers.
nuclear@14:  *
nuclear@14:  * These routines are used by both the compression and decompression code.
nuclear@14:  */
nuclear@14: 
nuclear@14: /* this is not a core library module, so it doesn't define JPEG_INTERNALS */
nuclear@14: #include "jinclude.h"
nuclear@14: #include "jpeglib.h"
nuclear@14: #include "jversion.h"
nuclear@14: #include "jerror.h"
nuclear@14: 
nuclear@14: #ifdef USE_WINDOWS_MESSAGEBOX
nuclear@14: #include <windows.h>
nuclear@14: #endif
nuclear@14: 
nuclear@14: #ifndef EXIT_FAILURE		/* define exit() codes if not provided */
nuclear@14: #define EXIT_FAILURE  1
nuclear@14: #endif
nuclear@14: 
nuclear@14: 
nuclear@14: /*
nuclear@14:  * Create the message string table.
nuclear@14:  * We do this from the master message list in jerror.h by re-reading
nuclear@14:  * jerror.h with a suitable definition for macro JMESSAGE.
nuclear@14:  * The message table is made an external symbol just in case any applications
nuclear@14:  * want to refer to it directly.
nuclear@14:  */
nuclear@14: 
nuclear@14: #ifdef NEED_SHORT_EXTERNAL_NAMES
nuclear@14: #define jpeg_std_message_table	jMsgTable
nuclear@14: #endif
nuclear@14: 
nuclear@14: #define JMESSAGE(code,string)	string ,
nuclear@14: 
nuclear@14: const char * const jpeg_std_message_table[] = {
nuclear@14: #include "jerror.h"
nuclear@14:   NULL
nuclear@14: };
nuclear@14: 
nuclear@14: 
nuclear@14: /*
nuclear@14:  * Error exit handler: must not return to caller.
nuclear@14:  *
nuclear@14:  * Applications may override this if they want to get control back after
nuclear@14:  * an error.  Typically one would longjmp somewhere instead of exiting.
nuclear@14:  * The setjmp buffer can be made a private field within an expanded error
nuclear@14:  * handler object.  Note that the info needed to generate an error message
nuclear@14:  * is stored in the error object, so you can generate the message now or
nuclear@14:  * later, at your convenience.
nuclear@14:  * You should make sure that the JPEG object is cleaned up (with jpeg_abort
nuclear@14:  * or jpeg_destroy) at some point.
nuclear@14:  */
nuclear@14: 
nuclear@14: METHODDEF(void)
nuclear@14: error_exit (j_common_ptr cinfo)
nuclear@14: {
nuclear@14:   /* Always display the message */
nuclear@14:   (*cinfo->err->output_message) (cinfo);
nuclear@14: 
nuclear@14:   /* Let the memory manager delete any temp files before we die */
nuclear@14:   jpeg_destroy(cinfo);
nuclear@14: 
nuclear@14:   exit(EXIT_FAILURE);
nuclear@14: }
nuclear@14: 
nuclear@14: 
nuclear@14: /*
nuclear@14:  * Actual output of an error or trace message.
nuclear@14:  * Applications may override this method to send JPEG messages somewhere
nuclear@14:  * other than stderr.
nuclear@14:  *
nuclear@14:  * On Windows, printing to stderr is generally completely useless,
nuclear@14:  * so we provide optional code to produce an error-dialog popup.
nuclear@14:  * Most Windows applications will still prefer to override this routine,
nuclear@14:  * but if they don't, it'll do something at least marginally useful.
nuclear@14:  *
nuclear@14:  * NOTE: to use the library in an environment that doesn't support the
nuclear@14:  * C stdio library, you may have to delete the call to fprintf() entirely,
nuclear@14:  * not just not use this routine.
nuclear@14:  */
nuclear@14: 
nuclear@14: METHODDEF(void)
nuclear@14: output_message (j_common_ptr cinfo)
nuclear@14: {
nuclear@14:   char buffer[JMSG_LENGTH_MAX];
nuclear@14: 
nuclear@14:   /* Create the message */
nuclear@14:   (*cinfo->err->format_message) (cinfo, buffer);
nuclear@14: 
nuclear@14: #ifdef USE_WINDOWS_MESSAGEBOX
nuclear@14:   /* Display it in a message dialog box */
nuclear@14:   MessageBox(GetActiveWindow(), buffer, "JPEG Library Error",
nuclear@14: 	     MB_OK | MB_ICONERROR);
nuclear@14: #else
nuclear@14:   /* Send it to stderr, adding a newline */
nuclear@14:   fprintf(stderr, "%s\n", buffer);
nuclear@14: #endif
nuclear@14: }
nuclear@14: 
nuclear@14: 
nuclear@14: /*
nuclear@14:  * Decide whether to emit a trace or warning message.
nuclear@14:  * msg_level is one of:
nuclear@14:  *   -1: recoverable corrupt-data warning, may want to abort.
nuclear@14:  *    0: important advisory messages (always display to user).
nuclear@14:  *    1: first level of tracing detail.
nuclear@14:  *    2,3,...: successively more detailed tracing messages.
nuclear@14:  * An application might override this method if it wanted to abort on warnings
nuclear@14:  * or change the policy about which messages to display.
nuclear@14:  */
nuclear@14: 
nuclear@14: METHODDEF(void)
nuclear@14: emit_message (j_common_ptr cinfo, int msg_level)
nuclear@14: {
nuclear@14:   struct jpeg_error_mgr * err = cinfo->err;
nuclear@14: 
nuclear@14:   if (msg_level < 0) {
nuclear@14:     /* It's a warning message.  Since corrupt files may generate many warnings,
nuclear@14:      * the policy implemented here is to show only the first warning,
nuclear@14:      * unless trace_level >= 3.
nuclear@14:      */
nuclear@14:     if (err->num_warnings == 0 || err->trace_level >= 3)
nuclear@14:       (*err->output_message) (cinfo);
nuclear@14:     /* Always count warnings in num_warnings. */
nuclear@14:     err->num_warnings++;
nuclear@14:   } else {
nuclear@14:     /* It's a trace message.  Show it if trace_level >= msg_level. */
nuclear@14:     if (err->trace_level >= msg_level)
nuclear@14:       (*err->output_message) (cinfo);
nuclear@14:   }
nuclear@14: }
nuclear@14: 
nuclear@14: 
nuclear@14: /*
nuclear@14:  * Format a message string for the most recent JPEG error or message.
nuclear@14:  * The message is stored into buffer, which should be at least JMSG_LENGTH_MAX
nuclear@14:  * characters.  Note that no '\n' character is added to the string.
nuclear@14:  * Few applications should need to override this method.
nuclear@14:  */
nuclear@14: 
nuclear@14: METHODDEF(void)
nuclear@14: format_message (j_common_ptr cinfo, char * buffer)
nuclear@14: {
nuclear@14:   struct jpeg_error_mgr * err = cinfo->err;
nuclear@14:   int msg_code = err->msg_code;
nuclear@14:   const char * msgtext = NULL;
nuclear@14:   const char * msgptr;
nuclear@14:   char ch;
nuclear@14:   boolean isstring;
nuclear@14: 
nuclear@14:   /* Look up message string in proper table */
nuclear@14:   if (msg_code > 0 && msg_code <= err->last_jpeg_message) {
nuclear@14:     msgtext = err->jpeg_message_table[msg_code];
nuclear@14:   } else if (err->addon_message_table != NULL &&
nuclear@14: 	     msg_code >= err->first_addon_message &&
nuclear@14: 	     msg_code <= err->last_addon_message) {
nuclear@14:     msgtext = err->addon_message_table[msg_code - err->first_addon_message];
nuclear@14:   }
nuclear@14: 
nuclear@14:   /* Defend against bogus message number */
nuclear@14:   if (msgtext == NULL) {
nuclear@14:     err->msg_parm.i[0] = msg_code;
nuclear@14:     msgtext = err->jpeg_message_table[0];
nuclear@14:   }
nuclear@14: 
nuclear@14:   /* Check for string parameter, as indicated by %s in the message text */
nuclear@14:   isstring = FALSE;
nuclear@14:   msgptr = msgtext;
nuclear@14:   while ((ch = *msgptr++) != '\0') {
nuclear@14:     if (ch == '%') {
nuclear@14:       if (*msgptr == 's') isstring = TRUE;
nuclear@14:       break;
nuclear@14:     }
nuclear@14:   }
nuclear@14: 
nuclear@14:   /* Format the message into the passed buffer */
nuclear@14:   if (isstring)
nuclear@14:     sprintf(buffer, msgtext, err->msg_parm.s);
nuclear@14:   else
nuclear@14:     sprintf(buffer, msgtext,
nuclear@14: 	    err->msg_parm.i[0], err->msg_parm.i[1],
nuclear@14: 	    err->msg_parm.i[2], err->msg_parm.i[3],
nuclear@14: 	    err->msg_parm.i[4], err->msg_parm.i[5],
nuclear@14: 	    err->msg_parm.i[6], err->msg_parm.i[7]);
nuclear@14: }
nuclear@14: 
nuclear@14: 
nuclear@14: /*
nuclear@14:  * Reset error state variables at start of a new image.
nuclear@14:  * This is called during compression startup to reset trace/error
nuclear@14:  * processing to default state, without losing any application-specific
nuclear@14:  * method pointers.  An application might possibly want to override
nuclear@14:  * this method if it has additional error processing state.
nuclear@14:  */
nuclear@14: 
nuclear@14: METHODDEF(void)
nuclear@14: reset_error_mgr (j_common_ptr cinfo)
nuclear@14: {
nuclear@14:   cinfo->err->num_warnings = 0;
nuclear@14:   /* trace_level is not reset since it is an application-supplied parameter */
nuclear@14:   cinfo->err->msg_code = 0;	/* may be useful as a flag for "no error" */
nuclear@14: }
nuclear@14: 
nuclear@14: 
nuclear@14: /*
nuclear@14:  * Fill in the standard error-handling methods in a jpeg_error_mgr object.
nuclear@14:  * Typical call is:
nuclear@14:  *	struct jpeg_compress_struct cinfo;
nuclear@14:  *	struct jpeg_error_mgr err;
nuclear@14:  *
nuclear@14:  *	cinfo.err = jpeg_std_error(&err);
nuclear@14:  * after which the application may override some of the methods.
nuclear@14:  */
nuclear@14: 
nuclear@14: GLOBAL(struct jpeg_error_mgr *)
nuclear@14: jpeg_std_error (struct jpeg_error_mgr * err)
nuclear@14: {
nuclear@14:   err->error_exit = error_exit;
nuclear@14:   err->emit_message = emit_message;
nuclear@14:   err->output_message = output_message;
nuclear@14:   err->format_message = format_message;
nuclear@14:   err->reset_error_mgr = reset_error_mgr;
nuclear@14: 
nuclear@14:   err->trace_level = 0;		/* default = no tracing */
nuclear@14:   err->num_warnings = 0;	/* no warnings emitted yet */
nuclear@14:   err->msg_code = 0;		/* may be useful as a flag for "no error" */
nuclear@14: 
nuclear@14:   /* Initialize message table pointers */
nuclear@14:   err->jpeg_message_table = jpeg_std_message_table;
nuclear@14:   err->last_jpeg_message = (int) JMSG_LASTMSGCODE - 1;
nuclear@14: 
nuclear@14:   err->addon_message_table = NULL;
nuclear@14:   err->first_addon_message = 0;	/* for safety */
nuclear@14:   err->last_addon_message = 0;
nuclear@14: 
nuclear@14:   return err;
nuclear@14: }