MagickCore  7.1.2-29
Convert, Edit, Or Compose Bitmap Images
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 % Cristy %
17 % July 1993 %
18 % %
19 % %
20 % Copyright @ 1999 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 % https://imagemagick.org/license/ %
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 ␌
40 /*
41  Include declarations.
42 */
43 #include "MagickCore/studio.h"
44 #include "MagickCore/client.h"
45 #include "MagickCore/exception.h"
46 #include "MagickCore/exception-private.h"
47 #include "MagickCore/linked-list.h"
48 #include "MagickCore/locale_.h"
49 #include "MagickCore/log.h"
50 #include "MagickCore/magick.h"
51 #include "MagickCore/memory_.h"
52 #include "MagickCore/memory-private.h"
53 #include "MagickCore/semaphore.h"
54 #include "MagickCore/string_.h"
55 #include "MagickCore/utility.h"
56 #include "MagickCore/utility-private.h"
57 ␌
58 /*
59  Define declarations.
60 */
61 #define MaxExceptionList 64
62 ␌
63 /*
64  Forward declarations.
65 */
66 #if defined(__cplusplus) || defined(c_plusplus)
67 extern "C" {
68 #endif
69 
70 static void
71  DefaultErrorHandler(const ExceptionType,const char *,const char *),
72  DefaultFatalErrorHandler(const ExceptionType,const char *,const char *)
73  magick_attribute((__noreturn__)),
74  DefaultWarningHandler(const ExceptionType,const char *,const char *);
75 
76 #if defined(__cplusplus) || defined(c_plusplus)
77 }
78 #endif
79 ␌
80 /*
81  Global declarations.
82 */
83 static ErrorHandler
84  error_handler = DefaultErrorHandler;
85 
86 static FatalErrorHandler
87  fatal_error_handler = DefaultFatalErrorHandler;
88 
89 static WarningHandler
90  warning_handler = DefaultWarningHandler;
91 ␌
92 /*
93  Static declarations.
94 */
95 static SemaphoreInfo
96  *exception_semaphore = (SemaphoreInfo *) NULL;
97 ␌
98 /*
99 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
100 % %
101 % %
102 % %
103 % A c q u i r e E x c e p t i o n I n f o %
104 % %
105 % %
106 % %
107 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
108 %
109 % AcquireExceptionInfo() allocates the ExceptionInfo structure.
110 %
111 % The format of the AcquireExceptionInfo method is:
112 %
113 % ExceptionInfo *AcquireExceptionInfo(void)
114 %
115 */
116 MagickExport ExceptionInfo *AcquireExceptionInfo(void)
117 {
118  ExceptionInfo
119  *exception;
120 
121  exception=(ExceptionInfo *) AcquireCriticalMemory(sizeof(*exception));
122  InitializeExceptionInfo(exception);
123  exception->relinquish=MagickTrue;
124  return(exception);
125 }
126 ␌
127 /*
128 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
129 % %
130 % %
131 % %
132 % C l e a r M a g i c k E x c e p t i o n %
133 % %
134 % %
135 % %
136 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
137 %
138 % ClearMagickException() clears any exception that may not have been caught
139 % yet.
140 %
141 % The format of the ClearMagickException method is:
142 %
143 % void ClearMagickException(ExceptionInfo *exception)
144 %
145 % A description of each parameter follows:
146 %
147 % o exception: the exception info.
148 %
149 */
150 
151 static void *DestroyExceptionElement(void *exception)
152 {
153  ExceptionInfo
154  *p;
155 
156  p=(ExceptionInfo *) exception;
157  if (p->reason != (char *) NULL)
158  p->reason=DestroyString(p->reason);
159  if (p->description != (char *) NULL)
160  p->description=DestroyString(p->description);
161  p=(ExceptionInfo *) RelinquishMagickMemory(p);
162  return((void *) NULL);
163 }
164 
165 MagickExport void ClearMagickException(ExceptionInfo *exception)
166 {
167  assert(exception != (ExceptionInfo *) NULL);
168  assert(exception->signature == MagickCoreSignature);
169  if (exception->exceptions == (void *) NULL)
170  return;
171  LockSemaphoreInfo(exception->semaphore);
172  ClearLinkedList((LinkedListInfo *) exception->exceptions,
173  DestroyExceptionElement);
174  exception->severity=UndefinedException;
175  exception->reason=(char *) NULL;
176  exception->description=(char *) NULL;
177  UnlockSemaphoreInfo(exception->semaphore);
178  errno=0;
179 }
180 ␌
181 /*
182 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
183 % %
184 % %
185 % %
186 % C a t c h E x c e p t i o n %
187 % %
188 % %
189 % %
190 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
191 %
192 % CatchException() returns if no exceptions is found otherwise it reports
193 % the exception as a warning, error, or fatal depending on the severity.
194 %
195 % The format of the CatchException method is:
196 %
197 % void CatchException(ExceptionInfo *exception)
198 %
199 % A description of each parameter follows:
200 %
201 % o exception: the exception info.
202 %
203 */
204 MagickExport void CatchException(ExceptionInfo *exception)
205 {
206  LinkedListInfo
207  *exceptions;
208 
209  const ExceptionInfo
210  *p;
211 
212  assert(exception != (ExceptionInfo *) NULL);
213  assert(exception->signature == MagickCoreSignature);
214  if (exception->exceptions == (void *) NULL)
215  return;
216  LockSemaphoreInfo(exception->semaphore);
217  exceptions=(LinkedListInfo *) exception->exceptions;
218  ResetLinkedListIterator(exceptions);
219  p=(const ExceptionInfo *) GetNextValueInLinkedList(exceptions);
220  while (p != (const ExceptionInfo *) NULL)
221  {
222  if ((p->severity >= WarningException) && (p->severity < ErrorException))
223  MagickWarning(p->severity,p->reason,p->description);
224  if ((p->severity >= ErrorException) && (p->severity < FatalErrorException))
225  MagickError(p->severity,p->reason,p->description);
226  if (p->severity >= FatalErrorException)
227  MagickFatalError(p->severity,p->reason,p->description);
228  p=(const ExceptionInfo *) GetNextValueInLinkedList(exceptions);
229  }
230  UnlockSemaphoreInfo(exception->semaphore);
231  ClearMagickException(exception);
232 }
233 ␌
234 /*
235 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
236 % %
237 % %
238 % %
239 % C l o n e E x c e p t i o n I n f o %
240 % %
241 % %
242 % %
243 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
244 %
245 % CloneExceptionInfo() clones the ExceptionInfo structure.
246 %
247 % The format of the CloneExceptionInfo method is:
248 %
249 % ExceptionInfo *CloneException(ExceptionInfo *exception)
250 %
251 % A description of each parameter follows:
252 %
253 % o exception: the exception info.
254 %
255 */
256 MagickExport ExceptionInfo *CloneExceptionInfo(ExceptionInfo *exception)
257 {
258  ExceptionInfo
259  *clone_exception;
260 
261  clone_exception=(ExceptionInfo *) AcquireCriticalMemory(sizeof(*exception));
262  InitializeExceptionInfo(clone_exception);
263  InheritException(clone_exception,exception);
264  clone_exception->relinquish=MagickTrue;
265  return(clone_exception);
266 }
267 ␌
268 /*
269 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
270 % %
271 % %
272 % %
273 + D e f a u l t E r r o r H a n d l e r %
274 % %
275 % %
276 % %
277 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
278 %
279 % DefaultErrorHandler() displays an error reason.
280 %
281 % The format of the DefaultErrorHandler method is:
282 %
283 % void MagickError(const ExceptionType severity,const char *reason,
284 % const char *description)
285 %
286 % A description of each parameter follows:
287 %
288 % o severity: Specifies the numeric error category.
289 %
290 % o reason: Specifies the reason to display before terminating the
291 % program.
292 %
293 % o description: Specifies any description to the reason.
294 %
295 */
296 static void DefaultErrorHandler(const ExceptionType magick_unused(severity),
297  const char *reason,const char *description)
298 {
299  magick_unreferenced(severity);
300 
301  if (reason == (char *) NULL)
302  return;
303  (void) FormatLocaleFile(stderr,"%s: %s",GetClientName(),reason);
304  if (description != (char *) NULL)
305  (void) FormatLocaleFile(stderr," (%s)",description);
306  (void) FormatLocaleFile(stderr,".\n");
307  (void) fflush(stderr);
308 }
309 ␌
310 /*
311 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
312 % %
313 % %
314 % %
315 + D e f a u l t F a t a l E r r o r H a n d l e r %
316 % %
317 % %
318 % %
319 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
320 %
321 % DefaultFatalErrorHandler() displays an error reason and then terminates the
322 % program.
323 %
324 % The format of the DefaultFatalErrorHandler method is:
325 %
326 % void MagickFatalError(const ExceptionType severity,const char *reason,
327 % const char *description)
328 %
329 % A description of each parameter follows:
330 %
331 % o severity: Specifies the numeric error category.
332 %
333 % o reason: Specifies the reason to display before terminating the program.
334 %
335 % o description: Specifies any description to the reason.
336 %
337 */
338 static void DefaultFatalErrorHandler(const ExceptionType severity,
339  const char *reason,const char *description)
340 {
341  (void) FormatLocaleFile(stderr,"%s:",GetClientName());
342  if (reason != (char *) NULL)
343  (void) FormatLocaleFile(stderr," %s",reason);
344  if (description != (char *) NULL)
345  (void) FormatLocaleFile(stderr," (%s)",description);
346  (void) FormatLocaleFile(stderr,".\n");
347  (void) fflush(stderr);
348  MagickCoreTerminus();
349  exit((int) (severity-FatalErrorException)+1);
350 }
351 ␌
352 /*
353 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
354 % %
355 % %
356 % %
357 + D e f a u l t W a r n i n g H a n d l e r %
358 % %
359 % %
360 % %
361 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
362 %
363 % DefaultWarningHandler() displays a warning reason.
364 %
365 % The format of the DefaultWarningHandler method is:
366 %
367 % void DefaultWarningHandler(const ExceptionType severity,
368 % const char *reason,const char *description)
369 %
370 % A description of each parameter follows:
371 %
372 % o severity: Specifies the numeric warning category.
373 %
374 % o reason: Specifies the reason to display before terminating the
375 % program.
376 %
377 % o description: Specifies any description to the reason.
378 %
379 */
380 static void DefaultWarningHandler(const ExceptionType magick_unused(severity),
381  const char *reason,const char *description)
382 {
383  magick_unreferenced(severity);
384 
385  if (reason == (char *) NULL)
386  return;
387  (void) FormatLocaleFile(stderr,"%s: %s",GetClientName(),reason);
388  if (description != (char *) NULL)
389  (void) FormatLocaleFile(stderr," (%s)",description);
390  (void) FormatLocaleFile(stderr,".\n");
391  (void) fflush(stderr);
392 }
393 ␌
394 /*
395 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
396 % %
397 % %
398 % %
399 % D e s t r o y E x c e p t i o n I n f o %
400 % %
401 % %
402 % %
403 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
404 %
405 % DestroyExceptionInfo() deallocates memory associated with an exception.
406 %
407 % The format of the DestroyExceptionInfo method is:
408 %
409 % ExceptionInfo *DestroyExceptionInfo(ExceptionInfo *exception)
410 %
411 % A description of each parameter follows:
412 %
413 % o exception: the exception info.
414 %
415 */
416 MagickExport ExceptionInfo *DestroyExceptionInfo(ExceptionInfo *exception)
417 {
418  MagickBooleanType
419  relinquish;
420 
421  assert(exception != (ExceptionInfo *) NULL);
422  assert(exception->signature == MagickCoreSignature);
423  if (exception->semaphore == (SemaphoreInfo *) NULL)
424  ActivateSemaphoreInfo(&exception->semaphore);
425  LockSemaphoreInfo(exception->semaphore);
426  exception->severity=UndefinedException;
427  if (exception->relinquish != MagickFalse)
428  {
429  exception->signature=(~MagickCoreSignature);
430  if (exception->exceptions != (void *) NULL)
431  exception->exceptions=(void *) DestroyLinkedList((LinkedListInfo *)
432  exception->exceptions,DestroyExceptionElement);
433  }
434  else
435  if (exception->exceptions != (void *) NULL)
436  ClearLinkedList((LinkedListInfo *) exception->exceptions,
437  DestroyExceptionElement);
438  relinquish=exception->relinquish;
439  UnlockSemaphoreInfo(exception->semaphore);
440  if (relinquish != MagickFalse)
441  {
442  RelinquishSemaphoreInfo(&exception->semaphore);
443  exception=(ExceptionInfo *) RelinquishMagickMemory(exception);
444  }
445  return(exception);
446 }
447 ␌
448 /*
449 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
450 % %
451 % %
452 % %
453 + E x e c e p t i o n C o m p o n e n t G e n e s i s %
454 % %
455 % %
456 % %
457 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
458 %
459 % ExceptionComponentGenesis() instantiates the exception component.
460 %
461 % The format of the ExceptionComponentGenesis method is:
462 %
463 % MagickBooleanType ExceptionComponentGenesis(void)
464 %
465 */
466 MagickPrivate MagickBooleanType ExceptionComponentGenesis(void)
467 {
468  if (exception_semaphore == (SemaphoreInfo *) NULL)
469  exception_semaphore=AcquireSemaphoreInfo();
470  return(MagickTrue);
471 }
472 ␌
473 /*
474 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
475 % %
476 % %
477 % %
478 + E x c e p t i o n C o m p o n e n t T e r m i n u s %
479 % %
480 % %
481 % %
482 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
483 %
484 % ExceptionComponentTerminus() destroys the exception component.
485 %
486 % The format of the ExceptionComponentTerminus method is:
487 %
488 % void ExceptionComponentTerminus(void)
489 %
490 */
491 MagickPrivate void ExceptionComponentTerminus(void)
492 {
493  if (exception_semaphore == (SemaphoreInfo *) NULL)
494  ActivateSemaphoreInfo(&exception_semaphore);
495  LockSemaphoreInfo(exception_semaphore);
496  UnlockSemaphoreInfo(exception_semaphore);
497  RelinquishSemaphoreInfo(&exception_semaphore);
498 }
499 ␌
500 /*
501 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
502 % %
503 % %
504 % %
505 % G e t E x c e p t i o n M e s s a g e %
506 % %
507 % %
508 % %
509 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
510 %
511 % GetExceptionMessage() returns the error message defined by the specified
512 % error code.
513 %
514 % The format of the GetExceptionMessage method is:
515 %
516 % char *GetExceptionMessage(const int error)
517 %
518 % A description of each parameter follows:
519 %
520 % o error: the error code.
521 %
522 */
523 MagickExport char *GetExceptionMessage(const int error)
524 {
525  char
526  exception[MagickPathExtent];
527 
528  *exception='\0';
529 #if defined(MAGICKCORE_HAVE_STRERROR_R)
530 #if !defined(MAGICKCORE_STRERROR_R_CHAR_P)
531  (void) strerror_r(error,exception,sizeof(exception));
532 #else
533  (void) CopyMagickString(exception,strerror_r(error,exception,
534  sizeof(exception)),sizeof(exception));
535 #endif
536 #elif defined(MAGICKCORE_WINDOWS_SUPPORT)
537  strerror_s(exception,sizeof(exception),error);
538 #else
539  (void) CopyMagickString(exception,strerror(error),sizeof(exception));
540 #endif
541  return(ConstantString(exception));
542 }
543 ␌
544 /*
545 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
546 % %
547 % %
548 % %
549 % 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 %
550 % %
551 % %
552 % %
553 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
554 %
555 % GetLocaleExceptionMessage() converts a enumerated exception severity and tag
556 % to a message in the current locale.
557 %
558 % The format of the GetLocaleExceptionMessage method is:
559 %
560 % const char *GetLocaleExceptionMessage(const ExceptionType severity,
561 % const char *tag)
562 %
563 % A description of each parameter follows:
564 %
565 % o severity: the severity of the exception.
566 %
567 % o tag: the message tag.
568 %
569 */
570 
571 static const char *ExceptionSeverityToTag(const ExceptionType severity)
572 {
573  switch (severity)
574  {
575  case ResourceLimitWarning: return("Resource/Limit/Warning/");
576  case TypeWarning: return("Type/Warning/");
577  case OptionWarning: return("Option/Warning/");
578  case DelegateWarning: return("Delegate/Warning/");
579  case MissingDelegateWarning: return("Missing/Delegate/Warning/");
580  case CorruptImageWarning: return("Corrupt/Image/Warning/");
581  case FileOpenWarning: return("File/Open/Warning/");
582  case BlobWarning: return("Blob/Warning/");
583  case StreamWarning: return("Stream/Warning/");
584  case CacheWarning: return("Cache/Warning/");
585  case CoderWarning: return("Coder/Warning/");
586  case FilterWarning: return("Filter/Warning/");
587  case ModuleWarning: return("Module/Warning/");
588  case DrawWarning: return("Draw/Warning/");
589  case ImageWarning: return("Image/Warning/");
590  case WandWarning: return("Wand/Warning/");
591  case XServerWarning: return("XServer/Warning/");
592  case MonitorWarning: return("Monitor/Warning/");
593  case RegistryWarning: return("Registry/Warning/");
594  case ConfigureWarning: return("Configure/Warning/");
595  case PolicyWarning: return("Policy/Warning/");
596  case ResourceLimitError: return("Resource/Limit/Error/");
597  case TypeError: return("Type/Error/");
598  case OptionError: return("Option/Error/");
599  case DelegateError: return("Delegate/Error/");
600  case MissingDelegateError: return("Missing/Delegate/Error/");
601  case CorruptImageError: return("Corrupt/Image/Error/");
602  case FileOpenError: return("File/Open/Error/");
603  case BlobError: return("Blob/Error/");
604  case StreamError: return("Stream/Error/");
605  case CacheError: return("Cache/Error/");
606  case CoderError: return("Coder/Error/");
607  case FilterError: return("Filter/Error/");
608  case ModuleError: return("Module/Error/");
609  case DrawError: return("Draw/Error/");
610  case ImageError: return("Image/Error/");
611  case WandError: return("Wand/Error/");
612  case XServerError: return("XServer/Error/");
613  case MonitorError: return("Monitor/Error/");
614  case RegistryError: return("Registry/Error/");
615  case ConfigureError: return("Configure/Error/");
616  case PolicyError: return("Policy/Error/");
617  case ResourceLimitFatalError: return("Resource/Limit/FatalError/");
618  case TypeFatalError: return("Type/FatalError/");
619  case OptionFatalError: return("Option/FatalError/");
620  case DelegateFatalError: return("Delegate/FatalError/");
621  case MissingDelegateFatalError: return("Missing/Delegate/FatalError/");
622  case CorruptImageFatalError: return("Corrupt/Image/FatalError/");
623  case FileOpenFatalError: return("File/Open/FatalError/");
624  case BlobFatalError: return("Blob/FatalError/");
625  case StreamFatalError: return("Stream/FatalError/");
626  case CacheFatalError: return("Cache/FatalError/");
627  case CoderFatalError: return("Coder/FatalError/");
628  case FilterFatalError: return("Filter/FatalError/");
629  case ModuleFatalError: return("Module/FatalError/");
630  case DrawFatalError: return("Draw/FatalError/");
631  case ImageFatalError: return("Image/FatalError/");
632  case WandFatalError: return("Wand/FatalError/");
633  case XServerFatalError: return("XServer/FatalError/");
634  case MonitorFatalError: return("Monitor/FatalError/");
635  case RegistryFatalError: return("Registry/FatalError/");
636  case ConfigureFatalError: return("Configure/FatalError/");
637  case PolicyFatalError: return("Policy/FatalError/");
638  default: break;
639  }
640  return("");
641 }
642 
643 MagickExport const char *GetLocaleExceptionMessage(const ExceptionType severity,
644  const char *tag)
645 {
646  char
647  message[MagickPathExtent];
648 
649  const char
650  *locale_message;
651 
652  assert(tag != (const char *) NULL);
653  (void) FormatLocaleString(message,MagickPathExtent,"Exception/%s%s",
654  ExceptionSeverityToTag(severity),tag);
655  locale_message=GetLocaleMessage(message);
656  if (locale_message == (const char *) NULL)
657  return(tag);
658  if (locale_message == message)
659  return(tag);
660  return(locale_message);
661 }
662 ␌
663 /*
664 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
665 % %
666 % %
667 % %
668 % I n h e r i t E x c e p t i o n %
669 % %
670 % %
671 % %
672 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
673 %
674 % InheritException() inherits an exception from a related exception.
675 %
676 % The format of the InheritException method is:
677 %
678 % void InheritException(ExceptionInfo *exception,const ExceptionInfo *relative)
679 %
680 % A description of each parameter follows:
681 %
682 % o exception: the exception info.
683 %
684 % o relative: the related exception info.
685 %
686 */
687 MagickExport void InheritException(ExceptionInfo *exception,
688  const ExceptionInfo *relative)
689 {
690  const ExceptionInfo
691  *p;
692 
693  assert(exception != (ExceptionInfo *) NULL);
694  assert(exception->signature == MagickCoreSignature);
695  assert(relative != (ExceptionInfo *) NULL);
696  assert(relative->signature == MagickCoreSignature);
697  assert(exception != relative);
698  if (relative->exceptions == (void *) NULL)
699  return;
700  LockSemaphoreInfo(relative->semaphore);
701  ResetLinkedListIterator((LinkedListInfo *) relative->exceptions);
702  p=(const ExceptionInfo *) GetNextValueInLinkedList((LinkedListInfo *)
703  relative->exceptions);
704  while (p != (const ExceptionInfo *) NULL)
705  {
706  (void) ThrowException(exception,p->severity,p->reason,p->description);
707  p=(const ExceptionInfo *) GetNextValueInLinkedList((LinkedListInfo *)
708  relative->exceptions);
709  }
710  UnlockSemaphoreInfo(relative->semaphore);
711 }
712 ␌
713 /*
714 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
715 % %
716 % %
717 % %
718 % I n i t i a l i z e t E x c e p t i o n I n f o %
719 % %
720 % %
721 % %
722 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
723 %
724 % InitializeExceptionInfo() initializes an exception to default values.
725 %
726 % The format of the InitializeExceptionInfo method is:
727 %
728 % void InitializeExceptionInfo(ExceptionInfo *exception)
729 %
730 % A description of each parameter follows:
731 %
732 % o exception: the exception info.
733 %
734 */
735 MagickPrivate void InitializeExceptionInfo(ExceptionInfo *exception)
736 {
737  assert(exception != (ExceptionInfo *) NULL);
738  (void) memset(exception,0,sizeof(*exception));
739  exception->severity=UndefinedException;
740  exception->exceptions=(void *) NewLinkedList(0);
741  exception->semaphore=AcquireSemaphoreInfo();
742  exception->signature=MagickCoreSignature;
743 }
744 ␌
745 /*
746 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
747 % %
748 % %
749 % %
750 % M a g i c k E r r o r %
751 % %
752 % %
753 % %
754 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
755 %
756 % MagickError() calls the exception handler methods with an error reason.
757 %
758 % The format of the MagickError method is:
759 %
760 % void MagickError(const ExceptionType error,const char *reason,
761 % const char *description)
762 %
763 % A description of each parameter follows:
764 %
765 % o exception: Specifies the numeric error category.
766 %
767 % o reason: Specifies the reason to display before terminating the
768 % program.
769 %
770 % o description: Specifies any description to the reason.
771 %
772 */
773 MagickExport void MagickError(const ExceptionType error,const char *reason,
774  const char *description)
775 {
776  if (error_handler != (ErrorHandler) NULL)
777  (*error_handler)(error,reason,description);
778 }
779 ␌
780 /*
781 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
782 % %
783 % %
784 % %
785 % M a g i c k F a t al E r r o r %
786 % %
787 % %
788 % %
789 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
790 %
791 % MagickFatalError() calls the fatal exception handler methods with an error
792 % reason.
793 %
794 % The format of the MagickError method is:
795 %
796 % void MagickFatalError(const ExceptionType error,const char *reason,
797 % const char *description)
798 %
799 % A description of each parameter follows:
800 %
801 % o exception: Specifies the numeric error category.
802 %
803 % o reason: Specifies the reason to display before terminating the
804 % program.
805 %
806 % o description: Specifies any description to the reason.
807 %
808 */
809 MagickExport void MagickFatalError(const ExceptionType error,const char *reason,
810  const char *description)
811 {
812  if (fatal_error_handler != (FatalErrorHandler) NULL)
813  (*fatal_error_handler)(error,reason,description);
814  MagickCoreTerminus();
815  exit(1);
816 }
817 ␌
818 /*
819 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
820 % %
821 % %
822 % %
823 % M a g i c k W a r n i n g %
824 % %
825 % %
826 % %
827 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
828 %
829 % MagickWarning() calls the warning handler methods with a warning reason.
830 %
831 % The format of the MagickWarning method is:
832 %
833 % void MagickWarning(const ExceptionType warning,const char *reason,
834 % const char *description)
835 %
836 % A description of each parameter follows:
837 %
838 % o warning: the warning severity.
839 %
840 % o reason: Define the reason for the warning.
841 %
842 % o description: Describe the warning.
843 %
844 */
845 MagickExport void MagickWarning(const ExceptionType warning,const char *reason,
846  const char *description)
847 {
848  if (warning_handler != (WarningHandler) NULL)
849  (*warning_handler)(warning,reason,description);
850 }
851 ␌
852 /*
853 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
854 % %
855 % %
856 % %
857 % S e t E r r o r H a n d l e r %
858 % %
859 % %
860 % %
861 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
862 %
863 % SetErrorHandler() sets the exception handler to the specified method
864 % and returns the previous exception handler.
865 %
866 % The format of the SetErrorHandler method is:
867 %
868 % ErrorHandler SetErrorHandler(ErrorHandler handler)
869 %
870 % A description of each parameter follows:
871 %
872 % o handler: the method to handle errors.
873 %
874 */
875 MagickExport ErrorHandler SetErrorHandler(ErrorHandler handler)
876 {
877  ErrorHandler
878  previous_handler;
879 
880  if (exception_semaphore == (SemaphoreInfo *) NULL)
881  ActivateSemaphoreInfo(&exception_semaphore);
882  LockSemaphoreInfo(exception_semaphore);
883  previous_handler=error_handler;
884  error_handler=handler;
885  UnlockSemaphoreInfo(exception_semaphore);
886  return(previous_handler);
887 }
888 ␌
889 /*
890 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
891 % %
892 % %
893 % %
894 % S e t F a t a l E r r o r H a n d l e r %
895 % %
896 % %
897 % %
898 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
899 %
900 % SetFatalErrorHandler() sets the fatal exception handler to the specified
901 % method and returns the previous fatal exception handler.
902 %
903 % The format of the SetErrorHandler method is:
904 %
905 % ErrorHandler SetErrorHandler(ErrorHandler handler)
906 %
907 % A description of each parameter follows:
908 %
909 % o handler: the method to handle errors.
910 %
911 */
912 MagickExport FatalErrorHandler SetFatalErrorHandler(FatalErrorHandler handler)
913 {
914  FatalErrorHandler
915  previous_handler;
916 
917  if (exception_semaphore == (SemaphoreInfo *) NULL)
918  ActivateSemaphoreInfo(&exception_semaphore);
919  LockSemaphoreInfo(exception_semaphore);
920  previous_handler=fatal_error_handler;
921  fatal_error_handler=handler;
922  UnlockSemaphoreInfo(exception_semaphore);
923  return(previous_handler);
924 }
925 ␌
926 /*
927 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
928 % %
929 % %
930 % %
931 % S e t W a r n i n g H a n d l e r %
932 % %
933 % %
934 % %
935 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
936 %
937 % SetWarningHandler() sets the warning handler to the specified method
938 % and returns the previous warning handler.
939 %
940 % The format of the SetWarningHandler method is:
941 %
942 % ErrorHandler SetWarningHandler(ErrorHandler handler)
943 %
944 % A description of each parameter follows:
945 %
946 % o handler: the method to handle warnings.
947 %
948 */
949 MagickExport WarningHandler SetWarningHandler(WarningHandler handler)
950 {
951  WarningHandler
952  previous_handler;
953 
954  if (exception_semaphore == (SemaphoreInfo *) NULL)
955  ActivateSemaphoreInfo(&exception_semaphore);
956  LockSemaphoreInfo(exception_semaphore);
957  previous_handler=warning_handler;
958  warning_handler=handler;
959  UnlockSemaphoreInfo(exception_semaphore);
960  return(previous_handler);
961 }
962 ␌
963 /*
964 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
965 % %
966 % %
967 % %
968 % T h r o w E x c e p t i o n %
969 % %
970 % %
971 % %
972 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
973 %
974 % ThrowException() throws an exception with the specified severity code,
975 % reason, and optional description.
976 %
977 % The format of the ThrowException method is:
978 %
979 % MagickBooleanType ThrowException(ExceptionInfo *exception,
980 % const ExceptionType severity,const char *reason,
981 % const char *description)
982 %
983 % A description of each parameter follows:
984 %
985 % o exception: the exception info.
986 %
987 % o severity: the severity of the exception.
988 %
989 % o reason: the reason for the exception.
990 %
991 % o description: the exception description.
992 %
993 */
994 MagickExport MagickBooleanType ThrowException(ExceptionInfo *exception,
995  const ExceptionType severity,const char *reason,const char *description)
996 {
997  LinkedListInfo
998  *exceptions;
999 
1000  ExceptionInfo
1001  *p;
1002 
1003  assert(exception != (ExceptionInfo *) NULL);
1004  assert(exception->signature == MagickCoreSignature);
1005  LockSemaphoreInfo(exception->semaphore);
1006  exceptions=(LinkedListInfo *) exception->exceptions;
1007  if (GetNumberOfElementsInLinkedList(exceptions) > MaxExceptionList)
1008  {
1009  if (severity < ErrorException)
1010  {
1011  UnlockSemaphoreInfo(exception->semaphore);
1012  return(MagickTrue);
1013  }
1014  p=(ExceptionInfo *) GetLastValueInLinkedList(exceptions);
1015  if (p->severity >= ErrorException)
1016  {
1017  UnlockSemaphoreInfo(exception->semaphore);
1018  return(MagickTrue);
1019  }
1020  }
1021  p=(ExceptionInfo *) GetLastValueInLinkedList(exceptions);
1022  if ((p != (ExceptionInfo *) NULL) && (p->severity == severity) &&
1023  (LocaleCompare(exception->reason,reason) == 0) &&
1024  (LocaleCompare(exception->description,description) == 0))
1025  {
1026  UnlockSemaphoreInfo(exception->semaphore);
1027  return(MagickTrue);
1028  }
1029  p=(ExceptionInfo *) AcquireMagickMemory(sizeof(*p));
1030  if (p == (ExceptionInfo *) NULL)
1031  {
1032  UnlockSemaphoreInfo(exception->semaphore);
1033  ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
1034  }
1035  (void) memset(p,0,sizeof(*p));
1036  p->severity=severity;
1037  if (reason != (const char *) NULL)
1038  p->reason=ConstantString(reason);
1039  if (description != (const char *) NULL)
1040  p->description=ConstantString(description);
1041  p->signature=MagickCoreSignature;
1042  (void) AppendValueToLinkedList(exceptions,p);
1043  if (p->severity > exception->severity)
1044  {
1045  exception->severity=p->severity;
1046  exception->reason=p->reason;
1047  exception->description=p->description;
1048  }
1049  UnlockSemaphoreInfo(exception->semaphore);
1050  if (GetNumberOfElementsInLinkedList(exceptions) == MaxExceptionList)
1051  (void) ThrowMagickException(exception,GetMagickModule(),
1052  ResourceLimitWarning,"TooManyExceptions",
1053  "(exception processing is suspended)");
1054  return(MagickTrue);
1055 }
1056 ␌
1057 /*
1058 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1059 % %
1060 % %
1061 % %
1062 % T h r o w M a g i c k E x c e p t i o n %
1063 % %
1064 % %
1065 % %
1066 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1067 %
1068 % ThrowMagickException logs an exception as determined by the log
1069 % configuration file. If an error occurs, MagickFalse is returned
1070 % otherwise MagickTrue.
1071 %
1072 % The format of the ThrowMagickException method is:
1073 %
1074 % MagickBooleanType ThrowFileException(ExceptionInfo *exception,
1075 % const char *module,const char *function,const size_t line,
1076 % const ExceptionType severity,const char *tag,const char *format,...)
1077 %
1078 % A description of each parameter follows:
1079 %
1080 % o exception: the exception info.
1081 %
1082 % o filename: the source module filename.
1083 %
1084 % o function: the function name.
1085 %
1086 % o line: the line number of the source module.
1087 %
1088 % o severity: Specifies the numeric error category.
1089 %
1090 % o tag: the locale tag.
1091 %
1092 % o format: the output format.
1093 %
1094 */
1095 
1096 MagickExport MagickBooleanType ThrowMagickExceptionList(
1097  ExceptionInfo *exception,const char *module,const char *function,
1098  const size_t line,const ExceptionType severity,const char *tag,
1099  const char *format,va_list operands)
1100 {
1101  char
1102  message[MagickPathExtent],
1103  path[MagickPathExtent],
1104  reason[MagickPathExtent];
1105 
1106  const char
1107  *locale,
1108  *type;
1109 
1110  int
1111  n;
1112 
1113  MagickBooleanType
1114  status;
1115 
1116  size_t
1117  length;
1118 
1119  assert(exception != (ExceptionInfo *) NULL);
1120  assert(exception->signature == MagickCoreSignature);
1121  locale=GetLocaleExceptionMessage(severity,tag);
1122  (void) CopyMagickString(reason,locale,MagickPathExtent);
1123  (void) ConcatenateMagickString(reason," ",MagickPathExtent);
1124  length=strlen(reason);
1125  n=vsnprintf(reason+length,MagickPathExtent-length,format,operands);
1126  if (n < 0)
1127  reason[MagickPathExtent-1]='\0';
1128  status=LogMagickEvent(ExceptionEvent,module,function,line,"%s",reason);
1129  GetPathComponent(module,TailPath,path);
1130  type="undefined";
1131  if ((severity >= WarningException) && (severity < ErrorException))
1132  type="warning";
1133  if ((severity >= ErrorException) && (severity < FatalErrorException))
1134  type="error";
1135  if (severity >= FatalErrorException)
1136  type="fatal";
1137  (void) FormatLocaleString(message,MagickPathExtent,"%s @ %s/%s/%s/%.17g",
1138  reason,type,path,function,(double) line);
1139  (void) ThrowException(exception,severity,message,(char *) NULL);
1140  return(status);
1141 }
1142 
1143 MagickExport MagickBooleanType ThrowMagickException(ExceptionInfo *exception,
1144  const char *module,const char *function,const size_t line,
1145  const ExceptionType severity,const char *tag,const char *format,...)
1146 {
1147  MagickBooleanType
1148  status;
1149 
1150  va_list
1151  operands;
1152 
1153  va_start(operands,format);
1154  status=ThrowMagickExceptionList(exception,module,function,line,severity,tag,
1155  format,operands);
1156  va_end(operands);
1157  return(status);
1158 }
_ExceptionInfo
Definition: exception.h:102
_LinkedListInfo
Definition: linked-list.c:61