granicus.if.org Git - imagemagick/blob - magick/exception.c

   1 /*
   2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   3 %                                                                             %
   4 %                                                                             %
   5 %                                                                             %
   6 %        EEEEE  X   X   CCCC  EEEEE  PPPP  TTTTT  IIIII   OOO   N   N         %
   7 %        E       X X   C      E      P   P   T      I    O   O  NN  N         %
   8 %        EEE      X    C      EEE    PPPP    T      I    O   O  N N N         %
   9 %        E       X X   C      E      P       T      I    O   O  N  NN         %
  10 %        EEEEE   X  X   CCCC  EEEEE  P       T    IIIII   OOO   N   N         %
  11 %                                                                             %
  12 %                                                                             %
  13 %                        MagickCore Exception Methods                         %
  14 %                                                                             %
  15 %                             Software Design                                 %
  16 %                               John Cristy                                   %
  17 %                                July 1993                                    %
  18 %                                                                             %
  19 %                                                                             %
  20 %  Copyright 1999-2009 ImageMagick Studio LLC, a non-profit organization      %
  21 %  dedicated to making software imaging solutions freely available.           %
  22 %                                                                             %
  23 %  You may not use this file except in compliance with the License.  You may  %
  24 %  obtain a copy of the License at                                            %
  25 %                                                                             %
  26 %    http://www.imagemagick.org/script/license.php                            %
  27 %                                                                             %
  28 %  Unless required by applicable law or agreed to in writing, software        %
  29 %  distributed under the License is distributed on an "AS IS" BASIS,          %
  30 %  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   %
  31 %  See the License for the specific language governing permissions and        %
  32 %  limitations under the License.                                             %
  33 %                                                                             %
  34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  35 %
  36 %
  37 %
  38 */
  39 \f
  40 /*
  41   Include declarations.
  42 */
  43 #include "magick/studio.h"
  44 #include "magick/client.h"
  45 #include "magick/exception.h"
  46 #include "magick/exception-private.h"
  47 #include "magick/hashmap.h"
  48 #include "magick/locale_.h"
  49 #include "magick/log.h"
  50 #include "magick/magick.h"
  51 #include "magick/memory_.h"
  52 #include "magick/string_.h"
  53 #include "magick/utility.h"
  54 \f
  55 /*
  56   Forward declarations.
  57 */
  58 #if defined(__cplusplus) || defined(c_plusplus)
  59 extern "C" {
  60 #endif
  61
  62 static void
  63   DefaultErrorHandler(const ExceptionType,const char *,const char *),
  64   DefaultFatalErrorHandler(const ExceptionType,const char *,const char *),
  65   DefaultWarningHandler(const ExceptionType,const char *,const char *);
  66
  67 #if defined(__cplusplus) || defined(c_plusplus)
  68 }
  69 #endif
  70 \f
  71 /*
  72   Global declarations.
  73 */
  74 static ErrorHandler
  75   error_handler = DefaultErrorHandler;
  76
  77 static FatalErrorHandler
  78   fatal_error_handler = DefaultFatalErrorHandler;
  79
  80 static WarningHandler
  81   warning_handler = DefaultWarningHandler;
  82 \f
  83 /*
  84 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  85 %                                                                             %
  86 %                                                                             %
  87 %                                                                             %
  88 %   A c q u i r e E x c e p t i o n I n f o                                   %
  89 %                                                                             %
  90 %                                                                             %
  91 %                                                                             %
  92 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  93 %
  94 %  AcquireExceptionInfo() allocates the ExceptionInfo structure.
  95 %
  96 %  The format of the AcquireExceptionInfo method is:
  97 %
  98 %      ExceptionInfo *AcquireExceptionInfo(void)
  99 %
 100 */
 101 MagickExport ExceptionInfo *AcquireExceptionInfo(void)
 102 {
 103   ExceptionInfo
 104     *exception;
 105
 106   exception=(ExceptionInfo *) AcquireMagickMemory(sizeof(*exception));
 107   if (exception == (ExceptionInfo *) NULL)
 108     ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
 109   GetExceptionInfo(exception);
 110   exception->relinquish=MagickTrue;
 111   return(exception);
 112 }
 113 \f
 114 /*
 115 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 116 %                                                                             %
 117 %                                                                             %
 118 %                                                                             %
 119 %   C l e a r M a g i c k E x c e p t i o n                                   %
 120 %                                                                             %
 121 %                                                                             %
 122 %                                                                             %
 123 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 124 %
 125 %  ClearMagickException() clears any exception that may not have been caught
 126 %  yet.
 127 %
 128 %  The format of the ClearMagickException method is:
 129 %
 130 %      ClearMagickException(ExceptionInfo *exception)
 131 %
 132 %  A description of each parameter follows:
 133 %
 134 %    o exception: the exception info.
 135 %
 136 */
 137
 138 static void *DestroyExceptionElement(void *exception)
 139 {
 140   register ExceptionInfo
 141     *p;
 142
 143   p=(ExceptionInfo *) exception;
 144   if (p->reason != (char *) NULL)
 145     p->reason=DestroyString(p->reason);
 146   if (p->description != (char *) NULL)
 147     p->description=DestroyString(p->description);
 148   p=(ExceptionInfo *) RelinquishMagickMemory(p);
 149   return((void *) NULL);
 150 }
 151
 152 MagickExport void ClearMagickException(ExceptionInfo *exception)
 153 {
 154   register ExceptionInfo
 155     *p;
 156
 157   assert(exception != (ExceptionInfo *) NULL);
 158   assert(exception->signature == MagickSignature);
 159   if (exception->exceptions  == (void *) NULL)
 160     return;
 161   AcquireSemaphoreInfo(&exception->semaphore);
 162   p=(ExceptionInfo *) RemoveLastElementFromLinkedList((LinkedListInfo *)
 163     exception->exceptions);
 164   while (p != (ExceptionInfo *) NULL)
 165   {
 166     (void) DestroyExceptionElement(p);
 167     p=(ExceptionInfo *) RemoveLastElementFromLinkedList((LinkedListInfo *)
 168       exception->exceptions);
 169   }
 170   exception->severity=UndefinedException;
 171   exception->reason=(char *) NULL;
 172   exception->description=(char *) NULL;
 173   RelinquishSemaphoreInfo(exception->semaphore);
 174   errno=0;
 175 }
 176 \f
 177 /*
 178 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 179 %                                                                             %
 180 %                                                                             %
 181 %                                                                             %
 182 %   C a t c h E x c e p t i o n                                               %
 183 %                                                                             %
 184 %                                                                             %
 185 %                                                                             %
 186 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 187 %
 188 %  CatchException() returns if no exceptions is found otherwise it reports
 189 %  the exception as a warning, error, or fatal depending on the severity.
 190 %
 191 %  The format of the CatchException method is:
 192 %
 193 %      CatchException(ExceptionInfo *exception)
 194 %
 195 %  A description of each parameter follows:
 196 %
 197 %    o exception: the exception info.
 198 %
 199 */
 200 MagickExport void CatchException(ExceptionInfo *exception)
 201 {
 202   register const ExceptionInfo
 203     *p;
 204
 205   assert(exception != (ExceptionInfo *) NULL);
 206   assert(exception->signature == MagickSignature);
 207   if (exception->exceptions  == (void *) NULL)
 208     return;
 209   AcquireSemaphoreInfo(&exception->semaphore);
 210   ResetLinkedListIterator((LinkedListInfo *) exception->exceptions);
 211   p=(const ExceptionInfo *) GetNextValueInLinkedList((LinkedListInfo *)
 212     exception->exceptions);
 213   while (p != (const ExceptionInfo *) NULL)
 214   {
 215     if ((p->severity >= WarningException) && (p->severity < ErrorException))
 216       MagickWarning(p->severity,p->reason,p->description);
 217     if ((p->severity >= ErrorException) && (p->severity < FatalErrorException))
 218       MagickError(p->severity,p->reason,p->description);
 219     if (exception->severity >= FatalErrorException)
 220       MagickFatalError(p->severity,p->reason,p->description);
 221     p=(const ExceptionInfo *) GetNextValueInLinkedList((LinkedListInfo *)
 222       exception->exceptions);
 223   }
 224   RelinquishSemaphoreInfo(exception->semaphore);
 225   ClearMagickException(exception);
 226 }
 227 \f
 228 /*
 229 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 230 %                                                                             %
 231 %                                                                             %
 232 %                                                                             %
 233 +   D e f a u l t E r r o r H a n d l e r                                     %
 234 %                                                                             %
 235 %                                                                             %
 236 %                                                                             %
 237 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 238 %
 239 %  DefaultErrorHandler() displays an error reason.
 240 %
 241 %  The format of the DefaultErrorHandler method is:
 242 %
 243 %      void MagickError(const ExceptionType severity,const char *reason,
 244 %        const char *description)
 245 %
 246 %  A description of each parameter follows:
 247 %
 248 %    o severity: Specifies the numeric error category.
 249 %
 250 %    o reason: Specifies the reason to display before terminating the
 251 %      program.
 252 %
 253 %    o description: Specifies any description to the reason.
 254 %
 255 */
 256 static void DefaultErrorHandler(const ExceptionType magick_unused(severity),
 257   const char *reason,const char *description)
 258 {
 259   if (reason == (char *) NULL)
 260     return;
 261   (void) fprintf(stderr,"%s: %s",GetClientName(),reason);
 262   if (description != (char *) NULL)
 263     (void) fprintf(stderr," (%s)",description);
 264   (void) fprintf(stderr,".\n");
 265   (void) fflush(stderr);
 266 }
 267 \f
 268 /*
 269 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 270 %                                                                             %
 271 %                                                                             %
 272 %                                                                             %
 273 +   D e f a u l t F a t a l E r r o r H a n d l e r                           %
 274 %                                                                             %
 275 %                                                                             %
 276 %                                                                             %
 277 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 278 %
 279 %  DefaultFatalErrorHandler() displays an error reason and then terminates the
 280 %  program.
 281 %
 282 %  The format of the DefaultFatalErrorHandler method is:
 283 %
 284 %      void MagickFatalError(const ExceptionType severity,const char *reason,
 285 %        const char *description)
 286 %
 287 %  A description of each parameter follows:
 288 %
 289 %    o severity: Specifies the numeric error category.
 290 %
 291 %    o reason: Specifies the reason to display before terminating the
 292 %      program.
 293 %
 294 %    o description: Specifies any description to the reason.
 295 %
 296 */
 297 static void DefaultFatalErrorHandler(
 298   const ExceptionType magick_unused(severity),
 299   const char *reason,const char *description)
 300 {
 301   if (reason == (char *) NULL)
 302     return;
 303   (void) fprintf(stderr,"%s: %s",GetClientName(),reason);
 304   if (description != (char *) NULL)
 305     (void) fprintf(stderr," (%s)",description);
 306   (void) fprintf(stderr,".\n");
 307   (void) fflush(stderr);
 308   MagickCoreTerminus();
 309   exit(1);
 310 }
 311 \f
 312 /*
 313 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 314 %                                                                             %
 315 %                                                                             %
 316 %                                                                             %
 317 +   D e f a u l t W a r n i n g H a n d l e r                                 %
 318 %                                                                             %
 319 %                                                                             %
 320 %                                                                             %
 321 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 322 %
 323 %  DefaultWarningHandler() displays a warning reason.
 324 %
 325 %  The format of the DefaultWarningHandler method is:
 326 %
 327 %      void DefaultWarningHandler(const ExceptionType warning,
 328 %        const char *reason,const char *description)
 329 %
 330 %  A description of each parameter follows:
 331 %
 332 %    o warning: Specifies the numeric warning category.
 333 %
 334 %    o reason: Specifies the reason to display before terminating the
 335 %      program.
 336 %
 337 %    o description: Specifies any description to the reason.
 338 %
 339 */
 340 static void DefaultWarningHandler(const ExceptionType magick_unused(severity),
 341   const char *reason,const char *description)
 342 {
 343   if (reason == (char *) NULL)
 344     return;
 345   (void) fprintf(stderr,"%s: %s",GetClientName(),reason);
 346   if (description != (char *) NULL)
 347     (void) fprintf(stderr," (%s)",description);
 348   (void) fprintf(stderr,".\n");
 349   (void) fflush(stderr);
 350 }
 351 \f
 352 /*
 353 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 354 %                                                                             %
 355 %                                                                             %
 356 %                                                                             %
 357 %   D e s t r o y E x c e p t i o n I n f o                                   %
 358 %                                                                             %
 359 %                                                                             %
 360 %                                                                             %
 361 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 362 %
 363 %  DestroyExceptionInfo() deallocates memory associated with an exception.
 364 %
 365 %  The format of the DestroyExceptionInfo method is:
 366 %
 367 %      ExceptionInfo *DestroyExceptionInfo(ExceptionInfo *exception)
 368 %
 369 %  A description of each parameter follows:
 370 %
 371 %    o exception: the exception info.
 372 %
 373 */
 374 MagickExport ExceptionInfo *DestroyExceptionInfo(ExceptionInfo *exception)
 375 {
 376   MagickBooleanType
 377     relinquish;
 378
 379   assert(exception != (ExceptionInfo *) NULL);
 380   assert(exception->signature == MagickSignature);
 381   AcquireSemaphoreInfo(&exception->semaphore);
 382   exception->severity=UndefinedException;
 383   if (exception->exceptions != (void *) NULL)
 384     exception->exceptions=(void *) DestroyLinkedList((LinkedListInfo *)
 385       exception->exceptions,DestroyExceptionElement);
 386   relinquish=exception->relinquish;
 387   if (exception->relinquish != MagickFalse)
 388     exception->signature=(~MagickSignature);
 389   RelinquishSemaphoreInfo(exception->semaphore);
 390   DestroySemaphoreInfo(&exception->semaphore);
 391   if (relinquish != MagickFalse)
 392     exception=(ExceptionInfo *) RelinquishMagickMemory(exception);
 393   return(exception);
 394 }
 395 \f
 396 /*
 397 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 398 %                                                                             %
 399 %                                                                             %
 400 %                                                                             %
 401 %   G e t E x c e p t i o n I n f o                                           %
 402 %                                                                             %
 403 %                                                                             %
 404 %                                                                             %
 405 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 406 %
 407 %  GetExceptionInfo() initializes an exception to default values.
 408 %
 409 %  The format of the GetExceptionInfo method is:
 410 %
 411 %      GetExceptionInfo(ExceptionInfo *exception)
 412 %
 413 %  A description of each parameter follows:
 414 %
 415 %    o exception: the exception info.
 416 %
 417 */
 418 MagickExport void GetExceptionInfo(ExceptionInfo *exception)
 419 {
 420   assert(exception != (ExceptionInfo *) NULL);
 421   (void) ResetMagickMemory(exception,0,sizeof(*exception));
 422   exception->severity=UndefinedException;
 423   exception->exceptions=(void *) NewLinkedList(0);
 424   exception->signature=MagickSignature;
 425 }
 426 \f
 427 /*
 428 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 429 %                                                                             %
 430 %                                                                             %
 431 %                                                                             %
 432 %   G e t E x c e p t i o n M e s s a g e                                     %
 433 %                                                                             %
 434 %                                                                             %
 435 %                                                                             %
 436 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 437 %
 438 %  GetExceptionMessage() returns the error message defined by the specified
 439 %  error code.
 440 %
 441 %  The format of the GetExceptionMessage method is:
 442 %
 443 %      char *GetExceptionMessage(const int error)
 444 %
 445 %  A description of each parameter follows:
 446 %
 447 %    o error: the error code.
 448 %
 449 */
 450 MagickExport char *GetExceptionMessage(const int error)
 451 {
 452   char
 453     exception[MaxTextExtent];
 454
 455 #if defined(MAGICKCORE_HAVE_STRERROR_R)
 456   (void) strerror_r(error,exception,sizeof(exception));
 457 #else
 458   (void) CopyMagickString(exception,strerror(error),sizeof(exception));
 459 #endif
 460   return(ConstantString(exception));
 461 }
 462 \f
 463 /*
 464 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 465 %                                                                             %
 466 %                                                                             %
 467 %                                                                             %
 468 %   G e t L o c a l e E x c e p t i o n M e s s a g e                         %
 469 %                                                                             %
 470 %                                                                             %
 471 %                                                                             %
 472 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 473 %
 474 %  GetLocaleExceptionMessage() converts a enumerated exception severity and tag
 475 %  to a message in the current locale.
 476 %
 477 %  The format of the GetLocaleExceptionMessage method is:
 478 %
 479 %      const char *GetLocaleExceptionMessage(const ExceptionType severity,
 480 %        const char *tag)
 481 %
 482 %  A description of each parameter follows:
 483 %
 484 %    o severity: the severity of the exception.
 485 %
 486 %    o tag: the message tag.
 487 %
 488 */
 489
 490 static const char *ExceptionSeverityToTag(const ExceptionType severity)
 491 {
 492   switch (severity)
 493   {
 494     case ResourceLimitWarning: return("Resource/Limit/Warning/");
 495     case TypeWarning: return("Type/Warning/");
 496     case OptionWarning: return("Option/Warning/");
 497     case DelegateWarning: return("Delegate/Warning/");
 498     case MissingDelegateWarning: return("Missing/Delegate/Warning/");
 499     case CorruptImageWarning: return("Corrupt/Image/Warning/");
 500     case FileOpenWarning: return("File/Open/Warning/");
 501     case BlobWarning: return("Blob/Warning/");
 502     case StreamWarning: return("Stream/Warning/");
 503     case CacheWarning: return("Cache/Warning/");
 504     case CoderWarning: return("Coder/Warning/");
 505     case ModuleWarning: return("Module/Warning/");
 506     case DrawWarning: return("Draw/Warning/");
 507     case ImageWarning: return("Image/Warning/");
 508     case WandWarning: return("Wand/Warning/");
 509     case XServerWarning: return("XServer/Warning/");
 510     case MonitorWarning: return("Monitor/Warning/");
 511     case RegistryWarning: return("Registry/Warning/");
 512     case ConfigureWarning: return("Configure/Warning/");
 513     case PolicyWarning: return("Policy/Warning/");
 514     case ResourceLimitError: return("Resource/Limit/Error/");
 515     case TypeError: return("Type/Error/");
 516     case OptionError: return("Option/Error/");
 517     case DelegateError: return("Delegate/Error/");
 518     case MissingDelegateError: return("Missing/Delegate/Error/");
 519     case CorruptImageError: return("Corrupt/Image/Error/");
 520     case FileOpenError: return("File/Open/Error/");
 521     case BlobError: return("Blob/Error/");
 522     case StreamError: return("Stream/Error/");
 523     case CacheError: return("Cache/Error/");
 524     case CoderError: return("Coder/Error/");
 525     case ModuleError: return("Module/Error/");
 526     case DrawError: return("Draw/Error/");
 527     case ImageError: return("Image/Error/");
 528     case WandError: return("Wand/Error/");
 529     case XServerError: return("XServer/Error/");
 530     case MonitorError: return("Monitor/Error/");
 531     case RegistryError: return("Registry/Error/");
 532     case ConfigureError: return("Configure/Error/");
 533     case PolicyError: return("Policy/Error/");
 534     case ResourceLimitFatalError: return("Resource/Limit/FatalError/");
 535     case TypeFatalError: return("Type/FatalError/");
 536     case OptionFatalError: return("Option/FatalError/");
 537     case DelegateFatalError: return("Delegate/FatalError/");
 538     case MissingDelegateFatalError: return("Missing/Delegate/FatalError/");
 539     case CorruptImageFatalError: return("Corrupt/Image/FatalError/");
 540     case FileOpenFatalError: return("File/Open/FatalError/");
 541     case BlobFatalError: return("Blob/FatalError/");
 542     case StreamFatalError: return("Stream/FatalError/");
 543     case CacheFatalError: return("Cache/FatalError/");
 544     case CoderFatalError: return("Coder/FatalError/");
 545     case ModuleFatalError: return("Module/FatalError/");
 546     case DrawFatalError: return("Draw/FatalError/");
 547     case ImageFatalError: return("Image/FatalError/");
 548     case WandFatalError: return("Wand/FatalError/");
 549     case XServerFatalError: return("XServer/FatalError/");
 550     case MonitorFatalError: return("Monitor/FatalError/");
 551     case RegistryFatalError: return("Registry/FatalError/");
 552     case ConfigureFatalError: return("Configure/FatalError/");
 553     case PolicyFatalError: return("Policy/FatalError/");
 554     default: break;
 555   }
 556   return("");
 557 }
 558
 559 MagickExport const char *GetLocaleExceptionMessage(const ExceptionType severity,
 560   const char *tag)
 561 {
 562   char
 563     message[MaxTextExtent];
 564
 565   const char
 566     *locale_message;
 567
 568   assert(tag != (const char *) NULL);
 569   (void) FormatMagickString(message,MaxTextExtent,"Exception/%s%s",
 570     ExceptionSeverityToTag(severity),tag);
 571   locale_message=GetLocaleMessage(message);
 572   if (locale_message == (const char *) NULL)
 573     return(tag);
 574   if (locale_message == message)
 575     return(tag);
 576   return(locale_message);
 577 }
 578 \f
 579 /*
 580 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 581 %                                                                             %
 582 %                                                                             %
 583 %                                                                             %
 584 %   I n h e r i t E x c e p t i o n                                           %
 585 %                                                                             %
 586 %                                                                             %
 587 %                                                                             %
 588 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 589 %
 590 %  InheritException() inherits an exception from a related exception.
 591 %
 592 %  The format of the InheritException method is:
 593 %
 594 %      InheritException(ExceptionInfo *exception,const ExceptionInfo *relative)
 595 %
 596 %  A description of each parameter follows:
 597 %
 598 %    o exception: the exception info.
 599 %
 600 %    o relative: the related exception info.
 601 %
 602 */
 603 MagickExport void InheritException(ExceptionInfo *exception,
 604   const ExceptionInfo *relative)
 605 {
 606   register const ExceptionInfo
 607     *p;
 608
 609   assert(exception != (ExceptionInfo *) NULL);
 610   assert(exception->signature == MagickSignature);
 611   assert(relative != (ExceptionInfo *) NULL);
 612   assert(relative->signature == MagickSignature);
 613   if (relative->exceptions == (void *) NULL)
 614     return;
 615   AcquireSemaphoreInfo(&exception->semaphore);
 616   ResetLinkedListIterator((LinkedListInfo *) relative->exceptions);
 617   p=(const ExceptionInfo *) GetNextValueInLinkedList((LinkedListInfo *)
 618     relative->exceptions);
 619   while (p != (const ExceptionInfo *) NULL)
 620   {
 621     (void) ThrowException(exception,p->severity,p->reason,p->description);
 622     p=(const ExceptionInfo *) GetNextValueInLinkedList((LinkedListInfo *)
 623       relative->exceptions);
 624   }
 625   RelinquishSemaphoreInfo(exception->semaphore);
 626 }
 627 \f
 628 /*
 629 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 630 %                                                                             %
 631 %                                                                             %
 632 %                                                                             %
 633 %   M a g i c k E r r o r                                                     %
 634 %                                                                             %
 635 %                                                                             %
 636 %                                                                             %
 637 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 638 %
 639 %  MagickError() calls the exception handler methods with an error reason.
 640 %
 641 %  The format of the MagickError method is:
 642 %
 643 %      void MagickError(const ExceptionType error,const char *reason,
 644 %        const char *description)
 645 %
 646 %  A description of each parameter follows:
 647 %
 648 %    o exception: Specifies the numeric error category.
 649 %
 650 %    o reason: Specifies the reason to display before terminating the
 651 %      program.
 652 %
 653 %    o description: Specifies any description to the reason.
 654 %
 655 */
 656 MagickExport void MagickError(const ExceptionType error,const char *reason,
 657   const char *description)
 658 {
 659   if (error_handler != (ErrorHandler) NULL)
 660     (*error_handler)(error,reason,description);
 661 }
 662 \f
 663 /*
 664 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 665 %                                                                             %
 666 %                                                                             %
 667 %                                                                             %
 668 %   M a g i c k F a t al E r r o r                                            %
 669 %                                                                             %
 670 %                                                                             %
 671 %                                                                             %
 672 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 673 %
 674 %  MagickFatalError() calls the fatal exception handler methods with an error
 675 %  reason.
 676 %
 677 %  The format of the MagickError method is:
 678 %
 679 %      void MagickFatalError(const ExceptionType error,const char *reason,
 680 %        const char *description)
 681 %
 682 %  A description of each parameter follows:
 683 %
 684 %    o exception: Specifies the numeric error category.
 685 %
 686 %    o reason: Specifies the reason to display before terminating the
 687 %      program.
 688 %
 689 %    o description: Specifies any description to the reason.
 690 %
 691 */
 692 MagickExport void MagickFatalError(const ExceptionType error,const char *reason,
 693   const char *description)
 694 {
 695   if (fatal_error_handler != (ErrorHandler) NULL)
 696     (*fatal_error_handler)(error,reason,description);
 697 }
 698 \f
 699 /*
 700 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 701 %                                                                             %
 702 %                                                                             %
 703 %                                                                             %
 704 %   M a g i c k W a r n i n g                                                 %
 705 %                                                                             %
 706 %                                                                             %
 707 %                                                                             %
 708 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 709 %
 710 %  MagickWarning() calls the warning handler methods with a warning reason.
 711 %
 712 %  The format of the MagickWarning method is:
 713 %
 714 %      void MagickWarning(const ExceptionType warning,const char *reason,
 715 %        const char *description)
 716 %
 717 %  A description of each parameter follows:
 718 %
 719 %    o warning: the warning severity.
 720 %
 721 %    o reason: Define the reason for the warning.
 722 %
 723 %    o description: Describe the warning.
 724 %
 725 */
 726 MagickExport void MagickWarning(const ExceptionType warning,const char *reason,
 727   const char *description)
 728 {
 729   if (warning_handler != (WarningHandler) NULL)
 730     (*warning_handler)(warning,reason,description);
 731 }
 732 \f
 733 /*
 734 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 735 %                                                                             %
 736 %                                                                             %
 737 %                                                                             %
 738 %   S e t E r r o r H a n d l e r                                             %
 739 %                                                                             %
 740 %                                                                             %
 741 %                                                                             %
 742 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 743 %
 744 %  SetErrorHandler() sets the exception handler to the specified method
 745 %  and returns the previous exception handler.
 746 %
 747 %  The format of the SetErrorHandler method is:
 748 %
 749 %      ErrorHandler SetErrorHandler(ErrorHandler handler)
 750 %
 751 %  A description of each parameter follows:
 752 %
 753 %    o handler: the method to handle errors.
 754 %
 755 */
 756 MagickExport ErrorHandler SetErrorHandler(ErrorHandler handler)
 757 {
 758   ErrorHandler
 759     previous_handler;
 760
 761   previous_handler=error_handler;
 762   error_handler=handler;
 763   return(previous_handler);
 764 }
 765 \f
 766 /*
 767 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 768 %                                                                             %
 769 %                                                                             %
 770 %                                                                             %
 771 %   S e t F a t a l E r r o r H a n d l e r                                   %
 772 %                                                                             %
 773 %                                                                             %
 774 %                                                                             %
 775 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 776 %
 777 %  SetFatalErrorHandler() sets the fatal exception handler to the specified
 778 %  method and returns the previous fatal exception handler.
 779 %
 780 %  The format of the SetErrorHandler method is:
 781 %
 782 %      ErrorHandler SetErrorHandler(ErrorHandler handler)
 783 %
 784 %  A description of each parameter follows:
 785 %
 786 %    o handler: the method to handle errors.
 787 %
 788 */
 789 MagickExport FatalErrorHandler SetFatalErrorHandler(FatalErrorHandler handler)
 790 {
 791   FatalErrorHandler
 792     previous_handler;
 793
 794   previous_handler=fatal_error_handler;
 795   fatal_error_handler=handler;
 796   return(previous_handler);
 797 }
 798 \f
 799 /*
 800 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 801 %                                                                             %
 802 %                                                                             %
 803 %                                                                             %
 804 %   S e t W a r n i n g H a n d l e r                                         %
 805 %                                                                             %
 806 %                                                                             %
 807 %                                                                             %
 808 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 809 %
 810 %  SetWarningHandler() sets the warning handler to the specified method
 811 %  and returns the previous warning handler.
 812 %
 813 %  The format of the SetWarningHandler method is:
 814 %
 815 %      ErrorHandler SetWarningHandler(ErrorHandler handler)
 816 %
 817 %  A description of each parameter follows:
 818 %
 819 %    o handler: the method to handle warnings.
 820 %
 821 */
 822 MagickExport WarningHandler SetWarningHandler(WarningHandler handler)
 823 {
 824   WarningHandler
 825     previous_handler;
 826
 827   previous_handler=warning_handler;
 828   warning_handler=handler;
 829   return(previous_handler);
 830 }
 831 \f
 832 /*
 833 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 834 %                                                                             %
 835 %                                                                             %
 836 %                                                                             %
 837 %   T h r o w E x c e p t i o n                                               %
 838 %                                                                             %
 839 %                                                                             %
 840 %                                                                             %
 841 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 842 %
 843 %  ThrowException() throws an exception with the specified severity code,
 844 %  reason, and optional description.
 845 %
 846 %  The format of the ThrowException method is:
 847 %
 848 %      MagickBooleanType ThrowException(ExceptionInfo *exception,
 849 %        const ExceptionType severity,const char *reason,
 850 %        const char *description)
 851 %
 852 %  A description of each parameter follows:
 853 %
 854 %    o exception: the exception info.
 855 %
 856 %    o severity: the severity of the exception.
 857 %
 858 %    o reason: the reason for the exception.
 859 %
 860 %    o description: the exception description.
 861 %
 862 */
 863 MagickExport MagickBooleanType ThrowException(ExceptionInfo *exception,
 864   const ExceptionType severity,const char *reason,const char *description)
 865 {
 866   register ExceptionInfo
 867     *p;
 868
 869   assert(exception != (ExceptionInfo *) NULL);
 870   assert(exception->signature == MagickSignature);
 871   p=(ExceptionInfo *) GetLastValueInLinkedList((LinkedListInfo *)
 872     exception->exceptions);
 873   if ((p != (ExceptionInfo *) NULL) && (p->severity == severity) &&
 874       (LocaleCompare(exception->reason,reason) == 0) &&
 875       (LocaleCompare(exception->description,description) == 0))
 876     return(MagickTrue);
 877   p=(ExceptionInfo *) AcquireMagickMemory(sizeof(*p));
 878   if (p == (ExceptionInfo *) NULL)
 879     ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
 880   (void) ResetMagickMemory(p,0,sizeof(*p));
 881   p->severity=severity;
 882   if (reason != (const char *) NULL)
 883     p->reason=ConstantString(reason);
 884   if (description != (const char *) NULL)
 885     p->description=ConstantString(description);
 886   p->signature=MagickSignature;
 887   (void) AppendValueToLinkedList((LinkedListInfo *) exception->exceptions,p);
 888   exception->severity=p->severity;
 889   exception->reason=p->reason;
 890   exception->description=p->description;
 891   return(MagickTrue);
 892 }
 893 \f
 894 /*
 895 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 896 %                                                                             %
 897 %                                                                             %
 898 %                                                                             %
 899 %   T h r o w M a g i c k E x c e p t i o n                                   %
 900 %                                                                             %
 901 %                                                                             %
 902 %                                                                             %
 903 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 904 %
 905 %  ThrowMagickException logs an exception as determined by the log configuration
 906 %  file.  If an error occurs, MagickFalse is returned otherwise MagickTrue.
 907 %
 908 %  The format of the ThrowMagickException method is:
 909 %
 910 %      MagickBooleanType ThrowFileException(ExceptionInfo *exception,
 911 %        const char *module,const char *function,const unsigned long line,
 912 %        const ExceptionType severity,const char *tag,const char *format,...)
 913 %
 914 %  A description of each parameter follows:
 915 %
 916 %    o exception: the exception info.
 917 %
 918 %    o filename: the source module filename.
 919 %
 920 %    o function: the function name.
 921 %
 922 %    o line: the line number of the source module.
 923 %
 924 %    o severity: Specifies the numeric error category.
 925 %
 926 %    o tag: the locale tag.
 927 %
 928 %    o format: the output format.
 929 %
 930 */
 931
 932 MagickExport MagickBooleanType ThrowMagickExceptionList(
 933   ExceptionInfo *exception,const char *module,const char *function,
 934   const unsigned long line,const ExceptionType severity,const char *tag,
 935   const char *format,va_list operands)
 936 {
 937   char
 938     message[MaxTextExtent],
 939     path[MaxTextExtent],
 940     reason[MaxTextExtent];
 941
 942   const char
 943     *locale;
 944
 945   int
 946     n;
 947
 948   MagickBooleanType
 949     status;
 950
 951   size_t
 952     length;
 953
 954   assert(exception != (ExceptionInfo *) NULL);
 955   assert(exception->signature == MagickSignature);
 956   locale=GetLocaleExceptionMessage(severity,tag);
 957   (void) CopyMagickString(reason,locale,MaxTextExtent);
 958   (void) ConcatenateMagickString(reason," ",MaxTextExtent);
 959   length=strlen(reason);
 960 #if defined(MAGICKCORE_HAVE_VSNPRINTF)
 961   n=vsnprintf(reason+length,MaxTextExtent-length,format,operands);
 962 #else
 963   n=vsprintf(reason+length,format,operands);
 964 #endif
 965   if (n < 0)
 966     reason[MaxTextExtent-1]='\0';
 967   status=LogMagickEvent(ExceptionEvent,module,function,line,"%s",reason);
 968   GetPathComponent(module,TailPath,path);
 969   (void) FormatMagickString(message,MaxTextExtent,"%s @ %s/%s/%ld",reason,path,
 970     function,line);
 971   (void) ThrowException(exception,severity,message,(char *) NULL);
 972   return(status);
 973 }
 974
 975 MagickExport MagickBooleanType ThrowMagickException(ExceptionInfo *exception,
 976   const char *module,const char *function,const unsigned long line,
 977   const ExceptionType severity,const char *tag,const char *format,...)
 978 {
 979   MagickBooleanType
 980     status;
 981
 982   va_list
 983     operands;
 984
 985   va_start(operands,format);
 986   status=ThrowMagickExceptionList(exception,module,function,line,severity,tag,
 987     format,operands);
 988   va_end(operands);
 989   return(status);
 990 }