pngerror.c 11.0 KB
Newer Older
G
Guy Schalnat 已提交
1 2

/* pngerror.c - stub functions for i/o and memory allocation
3
 *
4
 * Last changed in libpng 1.4.0 [July 25, 2009]
5
 * Copyright (c) 1998-2009 Glenn Randers-Pehrson
6 7
 * (Version 0.96 Copyright (c) 1996, 1997 Andreas Dilger)
 * (Version 0.88 Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
8
 *
9
 * This code is released under the libpng license.
10
 * For conditions of distribution and use, see the disclaimer
11
 * and license in png.h
12
 *
13
 * This file provides a location for all error handling.  Users who
14 15 16 17
 * need special error handling are expected to write replacement functions
 * and use png_set_error_fn() to use those functions.  See the instructions
 * at each function.
 */
G
Guy Schalnat 已提交
18 19

#include "png.h"
20
#if defined(PNG_READ_SUPPORTED) || defined(PNG_WRITE_SUPPORTED)
21
#include "pngpriv.h"
G
Guy Schalnat 已提交
22

23 24
static void /* PRIVATE */
png_default_error PNGARG((png_structp png_ptr,
25
  png_const_charp error_message));
26
#ifndef PNG_NO_WARNINGS
27 28
static void /* PRIVATE */
png_default_warning PNGARG((png_structp png_ptr,
29
  png_const_charp warning_message));
30
#endif /* PNG_NO_WARNINGS */
G
Guy Schalnat 已提交
31

G
Guy Schalnat 已提交
32
/* This function is called whenever there is a fatal error.  This function
33 34 35 36
 * should not be changed.  If there is a need to handle errors differently,
 * you should supply a replacement error function and use png_set_error_fn()
 * to replace the error function at run-time.
 */
37
#ifndef PNG_NO_ERROR_TEXT
38
void PNGAPI
39
png_error(png_structp png_ptr, png_const_charp error_message)
G
Guy Schalnat 已提交
40
{
41 42
#ifdef PNG_ERROR_NUMBERS_SUPPORTED
   char msg[16];
43
   if (png_ptr != NULL)
44
   {
45 46 47
     if (png_ptr->flags&
       (PNG_FLAG_STRIP_ERROR_NUMBERS|PNG_FLAG_STRIP_ERROR_TEXT))
     {
48
       if (*error_message == PNG_LITERAL_SHARP)
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
       {
           /* Strip "#nnnn " from beginning of error message. */
           int offset;
           for (offset = 1; offset<15; offset++)
              if (error_message[offset] == ' ')
                  break;
           if (png_ptr->flags&PNG_FLAG_STRIP_ERROR_TEXT)
           {
              int i;
              for (i = 0; i < offset - 1; i++)
                 msg[i] = error_message[i + 1];
              msg[i - 1] = '\0';
              error_message = msg;
           }
           else
              error_message += offset;
       }
       else
       {
           if (png_ptr->flags&PNG_FLAG_STRIP_ERROR_TEXT)
           {
              msg[0] = '0';
              msg[1] = '\0';
              error_message = msg;
           }
       }
     }
76 77
   }
#endif
78
   if (png_ptr != NULL && png_ptr->error_fn != NULL)
79
      (*(png_ptr->error_fn))(png_ptr, error_message);
G
Guy Schalnat 已提交
80

81 82
   /* If the custom handler doesn't exist, or if it returns,
      use the default handler, which will not return. */
83
   png_default_error(png_ptr, error_message);
G
Guy Schalnat 已提交
84
}
85 86 87 88 89 90 91 92 93 94 95 96
#else
void PNGAPI
png_err(png_structp png_ptr)
{
   if (png_ptr != NULL && png_ptr->error_fn != NULL)
      (*(png_ptr->error_fn))(png_ptr, '\0');

   /* If the custom handler doesn't exist, or if it returns,
      use the default handler, which will not return. */
   png_default_error(png_ptr, '\0');
}
#endif /* PNG_NO_ERROR_TEXT */
G
Guy Schalnat 已提交
97

98
#ifndef PNG_NO_WARNINGS
G
Guy Schalnat 已提交
99
/* This function is called whenever there is a non-fatal error.  This function
100 101 102 103
 * should not be changed.  If there is a need to handle warnings differently,
 * you should supply a replacement warning function and use
 * png_set_error_fn() to replace the warning function at run-time.
 */
104
void PNGAPI
105
png_warning(png_structp png_ptr, png_const_charp warning_message)
G
Guy Schalnat 已提交
106
{
107
   int offset = 0;
108 109
   if (png_ptr != NULL)
   {
110
#ifdef PNG_ERROR_NUMBERS_SUPPORTED
111 112
   if (png_ptr->flags&
     (PNG_FLAG_STRIP_ERROR_NUMBERS|PNG_FLAG_STRIP_ERROR_TEXT))
113
#endif
114 115 116 117 118 119 120 121
     {
       if (*warning_message == PNG_LITERAL_SHARP)
       {
           for (offset = 1; offset < 15; offset++)
              if (warning_message[offset] == ' ')
                  break;
       }
     }
122
   }
123 124
   if (png_ptr != NULL && png_ptr->warning_fn != NULL)
      (*(png_ptr->warning_fn))(png_ptr, warning_message + offset);
G
Guy Schalnat 已提交
125
   else
126
      png_default_warning(png_ptr, warning_message + offset);
G
Guy Schalnat 已提交
127
}
128
#endif /* PNG_NO_WARNINGS */
G
Guy Schalnat 已提交
129

130 131 132 133
#ifdef PNG_BENIGN_ERRORS_SUPPORTED
void PNGAPI
png_benign_error(png_structp png_ptr, png_const_charp error_message)
{
134 135 136 137
  if (png_ptr->flags & PNG_FLAG_BENIGN_ERRORS_WARN)
    png_warning(png_ptr, error_message);
  else
    png_error(png_ptr, error_message);
138 139 140
}
#endif

141
/* These utilities are used internally to build an error message that relates
142 143 144 145 146
 * to the current chunk.  The chunk name comes from png_ptr->chunk_name,
 * this is used to prefix the message.  The message is limited in length
 * to 63 bytes, the name characters are output as hex digits wrapped in []
 * if the character is invalid.
 */
147
#define isnonalpha(c) ((c) < 65 || (c) > 122 || ((c) > 90 && (c) < 97))
148
static PNG_CONST char png_digit[16] = {
149 150 151
   '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
   'A', 'B', 'C', 'D', 'E', 'F'
};
152

153 154 155
#define PNG_MAX_ERROR_TEXT 64

#if !defined(PNG_NO_WARNINGS) || !defined(PNG_NO_ERROR_TEXT)
156
static void /* PRIVATE */
157
png_format_buffer(png_structp png_ptr, png_charp buffer, png_const_charp
158
   error_message)
159 160 161
{
   int iout = 0, iin = 0;

162 163
   while (iin < 4)
   {
164
      int c = png_ptr->chunk_name[iin++];
165 166
      if (isnonalpha(c))
      {
167
         buffer[iout++] = PNG_LITERAL_LEFT_SQUARE_BRACKET;
168
         buffer[iout++] = png_digit[(c & 0xf0) >> 4];
169
         buffer[iout++] = png_digit[c & 0x0f];
170
         buffer[iout++] = PNG_LITERAL_RIGHT_SQUARE_BRACKET;
171 172 173
      }
      else
      {
174
         buffer[iout++] = (png_byte)c;
175 176 177
      }
   }

178
   if (error_message == NULL)
179
      buffer[iout] = '\0';
180 181
   else
   {
182 183
      buffer[iout++] = ':';
      buffer[iout++] = ' ';
184 185
      png_memcpy(buffer + iout, error_message, PNG_MAX_ERROR_TEXT);
      buffer[iout + PNG_MAX_ERROR_TEXT - 1] = '\0';
186 187 188
   }
}

189
#ifdef PNG_READ_SUPPORTED
190
void PNGAPI
191
png_chunk_error(png_structp png_ptr, png_const_charp error_message)
192
{
193
   char msg[18+PNG_MAX_ERROR_TEXT];
194
   if (png_ptr == NULL)
195
     png_error(png_ptr, error_message);
196 197
   else
   {
198 199
     png_format_buffer(png_ptr, msg, error_message);
     png_error(png_ptr, msg);
200
   }
201
}
202 203
#endif /* PNG_READ_SUPPORTED */
#endif /* !defined(PNG_NO_WARNINGS) || !defined(PNG_NO_ERROR_TEXT) */
204

205
#ifndef PNG_NO_WARNINGS
206
void PNGAPI
207
png_chunk_warning(png_structp png_ptr, png_const_charp warning_message)
208
{
209
   char msg[18+PNG_MAX_ERROR_TEXT];
210
   if (png_ptr == NULL)
211
     png_warning(png_ptr, warning_message);
212 213
   else
   {
214 215
     png_format_buffer(png_ptr, msg, warning_message);
     png_warning(png_ptr, msg);
216
   }
217
}
218
#endif /* PNG_NO_WARNINGS */
219

220
#ifdef PNG_READ_SUPPORTED
221 222 223 224
#ifdef PNG_BENIGN_ERRORS_SUPPORTED
void PNGAPI
png_chunk_benign_error(png_structp png_ptr, png_const_charp error_message)
{
225 226 227 228
  if (png_ptr->flags & PNG_FLAG_BENIGN_ERRORS_WARN)
    png_chunk_warning(png_ptr, error_message);
  else
    png_chunk_error(png_ptr, error_message);
229 230
}
#endif
231
#endif /* PNG_READ_SUPPORTED */
232

G
Guy Schalnat 已提交
233
/* This is the default error handling function.  Note that replacements for
234 235 236 237
 * this function MUST NOT RETURN, or the program will likely crash.  This
 * function is used by default, or if the program supplies NULL for the
 * error function pointer in png_set_error_fn().
 */
238
static void /* PRIVATE */
239
png_default_error(png_structp png_ptr, png_const_charp error_message)
G
Guy Schalnat 已提交
240
{
241
#ifndef PNG_NO_CONSOLE_IO
242
#ifdef PNG_ERROR_NUMBERS_SUPPORTED
243
   if (*error_message == PNG_LITERAL_SHARP)
244
   {
245 246 247 248 249
     /* Strip "#nnnn " from beginning of error message. */
     int offset;
     char error_number[16];
     for (offset = 0; offset<15; offset++)
     {
250 251
         error_number[offset] = error_message[offset + 1];
         if (error_message[offset] == ' ')
252
             break;
253 254 255 256 257 258 259 260 261 262 263 264 265 266
     }
     if ((offset > 1) && (offset < 15))
     {
       error_number[offset - 1] = '\0';
       fprintf(stderr, "libpng error no. %s: %s",
          error_number, error_message + offset + 1);
       fprintf(stderr, PNG_STRING_NEWLINE);
     }
     else
     {
       fprintf(stderr, "libpng error: %s, offset=%d",
          error_message, offset);
       fprintf(stderr, PNG_STRING_NEWLINE);
     }
267 268 269
   }
   else
#endif
270 271 272 273
   {
      fprintf(stderr, "libpng error: %s", error_message);
      fprintf(stderr, PNG_STRING_NEWLINE);
   }
G
Guy Schalnat 已提交
274 275
#endif

276
#ifdef PNG_SETJMP_SUPPORTED
277 278
   if (png_ptr)
   {
279
#  ifdef USE_FAR_KEYWORD
G
Guy Schalnat 已提交
280 281
   {
      jmp_buf jmpbuf;
282
      png_memcpy(jmpbuf, png_ptr->jmpbuf, png_sizeof(jmp_buf));
G
Guy Schalnat 已提交
283 284
      longjmp(jmpbuf, 1);
   }
285
#  else
G
Guy Schalnat 已提交
286
   longjmp(png_ptr->jmpbuf, 1);
287 288
#  endif
   }
289 290
#else
   PNG_ABORT();
G
Guy Schalnat 已提交
291
#endif
292
#ifdef PNG_NO_CONSOLE_IO
293
   error_message = error_message; /* Make compiler happy */
294
#endif
G
Guy Schalnat 已提交
295 296
}

297
#ifndef PNG_NO_WARNINGS
G
Guy Schalnat 已提交
298
/* This function is called when there is a warning, but the library thinks
299
 * it can continue anyway.  Replacement functions don't have to do anything
300
 * here if you don't want them to.  In the default configuration, png_ptr is
301 302
 * not used, but it is passed in case it may be useful.
 */
303
static void /* PRIVATE */
304
png_default_warning(png_structp png_ptr, png_const_charp warning_message)
G
Guy Schalnat 已提交
305
{
306
#ifndef PNG_NO_CONSOLE_IO
307
#  ifdef PNG_ERROR_NUMBERS_SUPPORTED
308
   if (*warning_message == PNG_LITERAL_SHARP)
309
   {
310 311 312 313 314 315
     int offset;
     char warning_number[16];
     for (offset = 0; offset < 15; offset++)
     {
        warning_number[offset] = warning_message[offset + 1];
        if (warning_message[offset] == ' ')
316
            break;
317 318 319 320 321 322 323 324 325 326 327 328 329 330
     }
     if ((offset > 1) && (offset < 15))
     {
       warning_number[offset + 1] = '\0';
       fprintf(stderr, "libpng warning no. %s: %s",
          warning_number, warning_message + offset);
       fprintf(stderr, PNG_STRING_NEWLINE);
     }
     else
     {
       fprintf(stderr, "libpng warning: %s",
          warning_message);
       fprintf(stderr, PNG_STRING_NEWLINE);
     }
331 332 333
   }
   else
#  endif
334
   {
335 336
     fprintf(stderr, "libpng warning: %s", warning_message);
     fprintf(stderr, PNG_STRING_NEWLINE);
337
   }
338
#else
339
   warning_message = warning_message; /* Make compiler happy */
G
Guy Schalnat 已提交
340
#endif
341
   png_ptr = png_ptr; /* Make compiler happy */
G
Guy Schalnat 已提交
342
}
343
#endif /* PNG_NO_WARNINGS */
G
Guy Schalnat 已提交
344

G
Guy Schalnat 已提交
345
/* This function is called when the application wants to use another method
346 347 348 349
 * of handling errors and warnings.  Note that the error function MUST NOT
 * return to the calling routine or serious problems will occur.  The return
 * method used in the default routine calls longjmp(png_ptr->jmpbuf, 1)
 */
350
void PNGAPI
G
Guy Schalnat 已提交
351 352
png_set_error_fn(png_structp png_ptr, png_voidp error_ptr,
   png_error_ptr error_fn, png_error_ptr warning_fn)
G
Guy Schalnat 已提交
353
{
354 355
   if (png_ptr == NULL)
      return;
G
Guy Schalnat 已提交
356
   png_ptr->error_ptr = error_ptr;
G
Guy Schalnat 已提交
357 358
   png_ptr->error_fn = error_fn;
   png_ptr->warning_fn = warning_fn;
G
Guy Schalnat 已提交
359 360 361
}


G
Guy Schalnat 已提交
362
/* This function returns a pointer to the error_ptr associated with the user
363 364 365
 * functions.  The application should free any memory associated with this
 * pointer before png_write_destroy and png_read_destroy are called.
 */
366
png_voidp PNGAPI
G
Guy Schalnat 已提交
367
png_get_error_ptr(png_structp png_ptr)
G
Guy Schalnat 已提交
368
{
369 370
   if (png_ptr == NULL)
      return NULL;
371
   return ((png_voidp)png_ptr->error_ptr);
G
Guy Schalnat 已提交
372 373 374
}


375
#ifdef PNG_ERROR_NUMBERS_SUPPORTED
376
void PNGAPI
377 378
png_set_strip_error_numbers(png_structp png_ptr, png_uint_32 strip_mode)
{
379
   if (png_ptr != NULL)
380
   {
381
     png_ptr->flags &=
382 383 384 385
       ((~(PNG_FLAG_STRIP_ERROR_NUMBERS|PNG_FLAG_STRIP_ERROR_TEXT))&strip_mode);
   }
}
#endif
386
#endif /* PNG_READ_SUPPORTED || PNG_WRITE_SUPPORTED */