Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / f84a193d5f435588cd78d521fff3f1f852e227f8 / . / magick / exception.c
blob: d801f540647c8074fcfc7c6283f859c4fe786e99 [file] [log] [blame]
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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% %
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]20% Copyright 1999-2010 ImageMagick Studio LLC, a non-profit organization %
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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
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
55/*
56 Forward declarations.
57*/
58#if defined(__cplusplus) || defined(c_plusplus)
59extern "C" {
60#endif
61
62static 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
71/*
72 Global declarations.
73*/
74static ErrorHandler
75 error_handler = DefaultErrorHandler;
76
77static FatalErrorHandler
78 fatal_error_handler = DefaultFatalErrorHandler;
79
80static WarningHandler
81 warning_handler = DefaultWarningHandler;
82
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*/
101MagickExport ExceptionInfo *AcquireExceptionInfo(void)
102{
103 ExceptionInfo
104 *exception;
105
cristy90823212009-12-12 20:48:33 +0000[diff] [blame]106 exception=(ExceptionInfo *) AcquireAlignedMemory(1,sizeof(*exception));
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107 if (exception == (ExceptionInfo *) NULL)
108 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
109 GetExceptionInfo(exception);
110 exception->relinquish=MagickTrue;
111 return(exception);
112}
113
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
138static 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
152MagickExport 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;
cristyf84a1932010-01-03 18:00:18 +0000[diff] [blame^]161 LockSemaphoreInfo(exception->semaphore);
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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;
cristyf84a1932010-01-03 18:00:18 +0000[diff] [blame^]173 UnlockSemaphoreInfo(exception->semaphore);
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]174 errno=0;
175}
176
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*/
200MagickExport 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;
cristyf84a1932010-01-03 18:00:18 +0000[diff] [blame^]209 LockSemaphoreInfo(exception->semaphore);
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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 }
cristyf84a1932010-01-03 18:00:18 +0000[diff] [blame^]224 UnlockSemaphoreInfo(exception->semaphore);
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]225 ClearMagickException(exception);
226}
227
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*/
256static 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
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*/
297static 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
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%
cristy3b743bb2009-09-14 16:07:59 +0000[diff] [blame]327% void DefaultWarningHandler(const ExceptionType severity,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]328% const char *reason,const char *description)
329%
330% A description of each parameter follows:
331%
cristy3b743bb2009-09-14 16:07:59 +0000[diff] [blame]332% o severity: Specifies the numeric warning category.
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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*/
340static 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
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*/
374MagickExport ExceptionInfo *DestroyExceptionInfo(ExceptionInfo *exception)
375{
376 MagickBooleanType
377 relinquish;
378
379 assert(exception != (ExceptionInfo *) NULL);
380 assert(exception->signature == MagickSignature);
cristyf84a1932010-01-03 18:00:18 +0000[diff] [blame^]381 LockSemaphoreInfo(exception->semaphore);
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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);
cristyf84a1932010-01-03 18:00:18 +0000[diff] [blame^]389 UnlockSemaphoreInfo(exception->semaphore);
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]390 DestroySemaphoreInfo(&exception->semaphore);
391 if (relinquish != MagickFalse)
392 exception=(ExceptionInfo *) RelinquishMagickMemory(exception);
393 return(exception);
394}
395
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*/
418MagickExport 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);
cristy18b17442009-10-25 18:36:48 +0000[diff] [blame]424 exception->semaphore=AllocateSemaphoreInfo();
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]425 exception->signature=MagickSignature;
426}
427
428/*
429%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
430% %
431% %
432% %
433% G e t E x c e p t i o n M e s s a g e %
434% %
435% %
436% %
437%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
438%
439% GetExceptionMessage() returns the error message defined by the specified
440% error code.
441%
442% The format of the GetExceptionMessage method is:
443%
444% char *GetExceptionMessage(const int error)
445%
446% A description of each parameter follows:
447%
448% o error: the error code.
449%
450*/
451MagickExport char *GetExceptionMessage(const int error)
452{
453 char
454 exception[MaxTextExtent];
455
456#if defined(MAGICKCORE_HAVE_STRERROR_R)
457 (void) strerror_r(error,exception,sizeof(exception));
458#else
459 (void) CopyMagickString(exception,strerror(error),sizeof(exception));
460#endif
461 return(ConstantString(exception));
462}
463
464/*
465%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
466% %
467% %
468% %
469% 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 %
470% %
471% %
472% %
473%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
474%
475% GetLocaleExceptionMessage() converts a enumerated exception severity and tag
476% to a message in the current locale.
477%
478% The format of the GetLocaleExceptionMessage method is:
479%
480% const char *GetLocaleExceptionMessage(const ExceptionType severity,
481% const char *tag)
482%
483% A description of each parameter follows:
484%
485% o severity: the severity of the exception.
486%
487% o tag: the message tag.
488%
489*/
490
491static const char *ExceptionSeverityToTag(const ExceptionType severity)
492{
493 switch (severity)
494 {
495 case ResourceLimitWarning: return("Resource/Limit/Warning/");
496 case TypeWarning: return("Type/Warning/");
497 case OptionWarning: return("Option/Warning/");
498 case DelegateWarning: return("Delegate/Warning/");
499 case MissingDelegateWarning: return("Missing/Delegate/Warning/");
500 case CorruptImageWarning: return("Corrupt/Image/Warning/");
501 case FileOpenWarning: return("File/Open/Warning/");
502 case BlobWarning: return("Blob/Warning/");
503 case StreamWarning: return("Stream/Warning/");
504 case CacheWarning: return("Cache/Warning/");
505 case CoderWarning: return("Coder/Warning/");
cristy992729d2010-01-01 15:45:06 +0000[diff] [blame]506 case FilterWarning: return("Filter/Warning/");
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]507 case ModuleWarning: return("Module/Warning/");
508 case DrawWarning: return("Draw/Warning/");
509 case ImageWarning: return("Image/Warning/");
510 case WandWarning: return("Wand/Warning/");
511 case XServerWarning: return("XServer/Warning/");
512 case MonitorWarning: return("Monitor/Warning/");
513 case RegistryWarning: return("Registry/Warning/");
514 case ConfigureWarning: return("Configure/Warning/");
515 case PolicyWarning: return("Policy/Warning/");
516 case ResourceLimitError: return("Resource/Limit/Error/");
517 case TypeError: return("Type/Error/");
518 case OptionError: return("Option/Error/");
519 case DelegateError: return("Delegate/Error/");
520 case MissingDelegateError: return("Missing/Delegate/Error/");
521 case CorruptImageError: return("Corrupt/Image/Error/");
522 case FileOpenError: return("File/Open/Error/");
523 case BlobError: return("Blob/Error/");
524 case StreamError: return("Stream/Error/");
525 case CacheError: return("Cache/Error/");
526 case CoderError: return("Coder/Error/");
cristy992729d2010-01-01 15:45:06 +0000[diff] [blame]527 case FilterError: return("Filter/Error/");
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]528 case ModuleError: return("Module/Error/");
529 case DrawError: return("Draw/Error/");
530 case ImageError: return("Image/Error/");
531 case WandError: return("Wand/Error/");
532 case XServerError: return("XServer/Error/");
533 case MonitorError: return("Monitor/Error/");
534 case RegistryError: return("Registry/Error/");
535 case ConfigureError: return("Configure/Error/");
536 case PolicyError: return("Policy/Error/");
537 case ResourceLimitFatalError: return("Resource/Limit/FatalError/");
538 case TypeFatalError: return("Type/FatalError/");
539 case OptionFatalError: return("Option/FatalError/");
540 case DelegateFatalError: return("Delegate/FatalError/");
541 case MissingDelegateFatalError: return("Missing/Delegate/FatalError/");
542 case CorruptImageFatalError: return("Corrupt/Image/FatalError/");
543 case FileOpenFatalError: return("File/Open/FatalError/");
544 case BlobFatalError: return("Blob/FatalError/");
545 case StreamFatalError: return("Stream/FatalError/");
546 case CacheFatalError: return("Cache/FatalError/");
547 case CoderFatalError: return("Coder/FatalError/");
cristy992729d2010-01-01 15:45:06 +0000[diff] [blame]548 case FilterFatalError: return("Filter/FatalError/");
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]549 case ModuleFatalError: return("Module/FatalError/");
550 case DrawFatalError: return("Draw/FatalError/");
551 case ImageFatalError: return("Image/FatalError/");
552 case WandFatalError: return("Wand/FatalError/");
553 case XServerFatalError: return("XServer/FatalError/");
554 case MonitorFatalError: return("Monitor/FatalError/");
555 case RegistryFatalError: return("Registry/FatalError/");
556 case ConfigureFatalError: return("Configure/FatalError/");
557 case PolicyFatalError: return("Policy/FatalError/");
558 default: break;
559 }
560 return("");
561}
562
563MagickExport const char *GetLocaleExceptionMessage(const ExceptionType severity,
564 const char *tag)
565{
566 char
567 message[MaxTextExtent];
568
569 const char
570 *locale_message;
571
572 assert(tag != (const char *) NULL);
573 (void) FormatMagickString(message,MaxTextExtent,"Exception/%s%s",
574 ExceptionSeverityToTag(severity),tag);
575 locale_message=GetLocaleMessage(message);
576 if (locale_message == (const char *) NULL)
577 return(tag);
578 if (locale_message == message)
579 return(tag);
580 return(locale_message);
581}
582
583/*
584%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
585% %
586% %
587% %
588% I n h e r i t E x c e p t i o n %
589% %
590% %
591% %
592%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
593%
594% InheritException() inherits an exception from a related exception.
595%
596% The format of the InheritException method is:
597%
598% InheritException(ExceptionInfo *exception,const ExceptionInfo *relative)
599%
600% A description of each parameter follows:
601%
602% o exception: the exception info.
603%
604% o relative: the related exception info.
605%
606*/
607MagickExport void InheritException(ExceptionInfo *exception,
608 const ExceptionInfo *relative)
609{
610 register const ExceptionInfo
611 *p;
612
613 assert(exception != (ExceptionInfo *) NULL);
614 assert(exception->signature == MagickSignature);
615 assert(relative != (ExceptionInfo *) NULL);
616 assert(relative->signature == MagickSignature);
617 if (relative->exceptions == (void *) NULL)
618 return;
cristyf84a1932010-01-03 18:00:18 +0000[diff] [blame^]619 LockSemaphoreInfo(exception->semaphore);
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]620 ResetLinkedListIterator((LinkedListInfo *) relative->exceptions);
621 p=(const ExceptionInfo *) GetNextValueInLinkedList((LinkedListInfo *)
622 relative->exceptions);
623 while (p != (const ExceptionInfo *) NULL)
624 {
625 (void) ThrowException(exception,p->severity,p->reason,p->description);
626 p=(const ExceptionInfo *) GetNextValueInLinkedList((LinkedListInfo *)
627 relative->exceptions);
628 }
cristyf84a1932010-01-03 18:00:18 +0000[diff] [blame^]629 UnlockSemaphoreInfo(exception->semaphore);
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]630}
631
632/*
633%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
634% %
635% %
636% %
637% M a g i c k E r r o r %
638% %
639% %
640% %
641%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
642%
643% MagickError() calls the exception handler methods with an error reason.
644%
645% The format of the MagickError method is:
646%
647% void MagickError(const ExceptionType error,const char *reason,
648% const char *description)
649%
650% A description of each parameter follows:
651%
652% o exception: Specifies the numeric error category.
653%
654% o reason: Specifies the reason to display before terminating the
655% program.
656%
657% o description: Specifies any description to the reason.
658%
659*/
660MagickExport void MagickError(const ExceptionType error,const char *reason,
661 const char *description)
662{
663 if (error_handler != (ErrorHandler) NULL)
664 (*error_handler)(error,reason,description);
665}
666
667/*
668%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
669% %
670% %
671% %
672% M a g i c k F a t al E r r o r %
673% %
674% %
675% %
676%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
677%
678% MagickFatalError() calls the fatal exception handler methods with an error
679% reason.
680%
681% The format of the MagickError method is:
682%
683% void MagickFatalError(const ExceptionType error,const char *reason,
684% const char *description)
685%
686% A description of each parameter follows:
687%
688% o exception: Specifies the numeric error category.
689%
690% o reason: Specifies the reason to display before terminating the
691% program.
692%
693% o description: Specifies any description to the reason.
694%
695*/
696MagickExport void MagickFatalError(const ExceptionType error,const char *reason,
697 const char *description)
698{
699 if (fatal_error_handler != (ErrorHandler) NULL)
700 (*fatal_error_handler)(error,reason,description);
701}
702
703/*
704%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
705% %
706% %
707% %
708% M a g i c k W a r n i n g %
709% %
710% %
711% %
712%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
713%
714% MagickWarning() calls the warning handler methods with a warning reason.
715%
716% The format of the MagickWarning method is:
717%
718% void MagickWarning(const ExceptionType warning,const char *reason,
719% const char *description)
720%
721% A description of each parameter follows:
722%
723% o warning: the warning severity.
724%
725% o reason: Define the reason for the warning.
726%
727% o description: Describe the warning.
728%
729*/
730MagickExport void MagickWarning(const ExceptionType warning,const char *reason,
731 const char *description)
732{
733 if (warning_handler != (WarningHandler) NULL)
734 (*warning_handler)(warning,reason,description);
735}
736
737/*
738%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
739% %
740% %
741% %
742% S e t E r r o r H a n d l e r %
743% %
744% %
745% %
746%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
747%
748% SetErrorHandler() sets the exception handler to the specified method
749% and returns the previous exception handler.
750%
751% The format of the SetErrorHandler method is:
752%
753% ErrorHandler SetErrorHandler(ErrorHandler handler)
754%
755% A description of each parameter follows:
756%
757% o handler: the method to handle errors.
758%
759*/
760MagickExport ErrorHandler SetErrorHandler(ErrorHandler handler)
761{
762 ErrorHandler
763 previous_handler;
764
765 previous_handler=error_handler;
766 error_handler=handler;
767 return(previous_handler);
768}
769
770/*
771%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
772% %
773% %
774% %
775% S e t F a t a l E r r o r H a n d l e r %
776% %
777% %
778% %
779%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
780%
781% SetFatalErrorHandler() sets the fatal exception handler to the specified
782% method and returns the previous fatal exception handler.
783%
784% The format of the SetErrorHandler method is:
785%
786% ErrorHandler SetErrorHandler(ErrorHandler handler)
787%
788% A description of each parameter follows:
789%
790% o handler: the method to handle errors.
791%
792*/
793MagickExport FatalErrorHandler SetFatalErrorHandler(FatalErrorHandler handler)
794{
795 FatalErrorHandler
796 previous_handler;
797
798 previous_handler=fatal_error_handler;
799 fatal_error_handler=handler;
800 return(previous_handler);
801}
802
803/*
804%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
805% %
806% %
807% %
808% S e t W a r n i n g H a n d l e r %
809% %
810% %
811% %
812%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
813%
814% SetWarningHandler() sets the warning handler to the specified method
815% and returns the previous warning handler.
816%
817% The format of the SetWarningHandler method is:
818%
819% ErrorHandler SetWarningHandler(ErrorHandler handler)
820%
821% A description of each parameter follows:
822%
823% o handler: the method to handle warnings.
824%
825*/
826MagickExport WarningHandler SetWarningHandler(WarningHandler handler)
827{
828 WarningHandler
829 previous_handler;
830
831 previous_handler=warning_handler;
832 warning_handler=handler;
833 return(previous_handler);
834}
835
836/*
837%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
838% %
839% %
840% %
841% T h r o w E x c e p t i o n %
842% %
843% %
844% %
845%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
846%
847% ThrowException() throws an exception with the specified severity code,
848% reason, and optional description.
849%
850% The format of the ThrowException method is:
851%
852% MagickBooleanType ThrowException(ExceptionInfo *exception,
853% const ExceptionType severity,const char *reason,
854% const char *description)
855%
856% A description of each parameter follows:
857%
858% o exception: the exception info.
859%
860% o severity: the severity of the exception.
861%
862% o reason: the reason for the exception.
863%
864% o description: the exception description.
865%
866*/
867MagickExport MagickBooleanType ThrowException(ExceptionInfo *exception,
868 const ExceptionType severity,const char *reason,const char *description)
869{
870 register ExceptionInfo
871 *p;
872
873 assert(exception != (ExceptionInfo *) NULL);
874 assert(exception->signature == MagickSignature);
875 p=(ExceptionInfo *) GetLastValueInLinkedList((LinkedListInfo *)
876 exception->exceptions);
877 if ((p != (ExceptionInfo *) NULL) && (p->severity == severity) &&
878 (LocaleCompare(exception->reason,reason) == 0) &&
879 (LocaleCompare(exception->description,description) == 0))
880 return(MagickTrue);
cristy90823212009-12-12 20:48:33 +0000[diff] [blame]881 p=(ExceptionInfo *) AcquireAlignedMemory(1,sizeof(*p));
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]882 if (p == (ExceptionInfo *) NULL)
883 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
884 (void) ResetMagickMemory(p,0,sizeof(*p));
885 p->severity=severity;
886 if (reason != (const char *) NULL)
887 p->reason=ConstantString(reason);
888 if (description != (const char *) NULL)
889 p->description=ConstantString(description);
890 p->signature=MagickSignature;
891 (void) AppendValueToLinkedList((LinkedListInfo *) exception->exceptions,p);
892 exception->severity=p->severity;
893 exception->reason=p->reason;
894 exception->description=p->description;
895 return(MagickTrue);
896}
897
898/*
899%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
900% %
901% %
902% %
903% T h r o w M a g i c k E x c e p t i o n %
904% %
905% %
906% %
907%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
908%
909% ThrowMagickException logs an exception as determined by the log configuration
910% file. If an error occurs, MagickFalse is returned otherwise MagickTrue.
911%
912% The format of the ThrowMagickException method is:
913%
914% MagickBooleanType ThrowFileException(ExceptionInfo *exception,
915% const char *module,const char *function,const unsigned long line,
916% const ExceptionType severity,const char *tag,const char *format,...)
917%
918% A description of each parameter follows:
919%
920% o exception: the exception info.
921%
922% o filename: the source module filename.
923%
924% o function: the function name.
925%
926% o line: the line number of the source module.
927%
928% o severity: Specifies the numeric error category.
929%
930% o tag: the locale tag.
931%
932% o format: the output format.
933%
934*/
935
936MagickExport MagickBooleanType ThrowMagickExceptionList(
937 ExceptionInfo *exception,const char *module,const char *function,
938 const unsigned long line,const ExceptionType severity,const char *tag,
939 const char *format,va_list operands)
940{
941 char
942 message[MaxTextExtent],
943 path[MaxTextExtent],
944 reason[MaxTextExtent];
945
946 const char
947 *locale;
948
949 int
950 n;
951
952 MagickBooleanType
953 status;
954
955 size_t
956 length;
957
958 assert(exception != (ExceptionInfo *) NULL);
959 assert(exception->signature == MagickSignature);
960 locale=GetLocaleExceptionMessage(severity,tag);
961 (void) CopyMagickString(reason,locale,MaxTextExtent);
962 (void) ConcatenateMagickString(reason," ",MaxTextExtent);
963 length=strlen(reason);
964#if defined(MAGICKCORE_HAVE_VSNPRINTF)
965 n=vsnprintf(reason+length,MaxTextExtent-length,format,operands);
966#else
967 n=vsprintf(reason+length,format,operands);
968#endif
969 if (n < 0)
970 reason[MaxTextExtent-1]='\0';
971 status=LogMagickEvent(ExceptionEvent,module,function,line,"%s",reason);
972 GetPathComponent(module,TailPath,path);
973 (void) FormatMagickString(message,MaxTextExtent,"%s @ %s/%s/%ld",reason,path,
974 function,line);
975 (void) ThrowException(exception,severity,message,(char *) NULL);
976 return(status);
977}
978
979MagickExport MagickBooleanType ThrowMagickException(ExceptionInfo *exception,
980 const char *module,const char *function,const unsigned long line,
981 const ExceptionType severity,const char *tag,const char *format,...)
982{
983 MagickBooleanType
984 status;
985
986 va_list
987 operands;
988
989 va_start(operands,format);
990 status=ThrowMagickExceptionList(exception,module,function,line,severity,tag,
991 format,operands);
992 va_end(operands);
993 return(status);
994}