MagickCore  6.9.11-60
Convert, Edit, Or Compose Bitmap Images
log.h
Go to the documentation of this file.
1 /*
2  Copyright 1999-2021 ImageMagick Studio LLC, a non-profit organization
3  dedicated to making software imaging solutions freely available.
4 
5  You may not use this file except in compliance with the License. You may
6  obtain a copy of the License at
7 
8  https://imagemagick.org/script/license.php
9 
10  Unless required by applicable law or agreed to in writing, software
11  distributed under the License is distributed on an "AS IS" BASIS,
12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  See the License for the specific language governing permissions and
14  limitations under the License.
15 
16  MagickCore log methods.
17 */
18 #ifndef MAGICKCORE_LOG_H
19 #define MAGICKCORE_LOG_H
20 
21 #include <stdarg.h>
22 #include "magick/exception.h"
23 
24 #if defined(__cplusplus) || defined(c_plusplus)
25 extern "C" {
26 #endif
27 
28 #if !defined(GetMagickModule)
29 # define GetMagickModule() __FILE__,__func__,(unsigned long) __LINE__
30 #endif
31 
32 #define MagickLogFilename "log.xml"
33 
34 typedef enum
35 {
37  NoEvents = 0x00000,
38  TraceEvent = 0x00001,
39  AnnotateEvent = 0x00002,
40  BlobEvent = 0x00004,
41  CacheEvent = 0x00008,
42  CoderEvent = 0x00010,
43  ConfigureEvent = 0x00020,
44  DeprecateEvent = 0x00040,
45  DrawEvent = 0x00080,
46  ExceptionEvent = 0x00100,
47  ImageEvent = 0x00200,
48  LocaleEvent = 0x00400,
49  ModuleEvent = 0x00800,
50  PolicyEvent = 0x01000,
51  ResourceEvent = 0x02000,
52  TransformEvent = 0x04000,
53  UserEvent = 0x09000,
54  WandEvent = 0x10000,
55  X11Event = 0x20000,
56  AccelerateEvent = 0x40000,
57  AllEvents = 0x7fffffff
59 
60 typedef struct _LogInfo
61  LogInfo;
62 
63 typedef void
64  (*MagickLogMethod)(const LogEventType,const char *);
65 
66 extern MagickExport char
67  **GetLogList(const char *,size_t *,ExceptionInfo *);
68 
69 extern MagickExport const char
70  *GetLogName(void),
71  *SetLogName(const char *);
72 
73 extern MagickExport const LogInfo
74  **GetLogInfoList(const char *,size_t *,ExceptionInfo *);
75 
77  SetLogEventMask(const char *);
78 
80  IsEventLogging(void) magick_attribute((__pure__)),
83  LogMagickEvent(const LogEventType,const char *,const char *,const size_t,
84  const char *,...) magick_attribute((__format__ (__printf__,5,6))),
85  LogMagickEventList(const LogEventType,const char *,const char *,const size_t,
86  const char *,va_list) magick_attribute((__format__ (__printf__,5,0)));
87 
88 extern MagickExport void
91  SetLogFormat(const char *),
93 
94 #if defined(__cplusplus) || defined(c_plusplus)
95 }
96 #endif
97 
98 #endif
MagickExport MagickBooleanType magick_attribute((deprecated))
MagickExport MagickBooleanType MagickExport void LogComponentTerminus(void)
MagickExport MagickBooleanType MagickExport void SetLogFormat(const char *)
MagickExport LogEventType SetLogEventMask(const char *)
Definition: log.c:1766
MagickExport MagickBooleanType MagickExport void CloseMagickLog(void)
MagickExport const char * SetLogName(const char *)
Definition: log.c:1897
MagickExport char ** GetLogList(const char *, size_t *, ExceptionInfo *)
Definition: log.c:577
LogEventType
Definition: log.h:35
@ NoEvents
Definition: log.h:37
@ AnnotateEvent
Definition: log.h:39
@ UserEvent
Definition: log.h:53
@ LocaleEvent
Definition: log.h:48
@ DrawEvent
Definition: log.h:45
@ ImageEvent
Definition: log.h:47
@ AccelerateEvent
Definition: log.h:56
@ DeprecateEvent
Definition: log.h:44
@ ModuleEvent
Definition: log.h:49
@ AllEvents
Definition: log.h:57
@ WandEvent
Definition: log.h:54
@ TraceEvent
Definition: log.h:38
@ CacheEvent
Definition: log.h:41
@ UndefinedEvents
Definition: log.h:36
@ CoderEvent
Definition: log.h:42
@ PolicyEvent
Definition: log.h:50
@ ExceptionEvent
Definition: log.h:46
@ ConfigureEvent
Definition: log.h:43
@ BlobEvent
Definition: log.h:40
@ X11Event
Definition: log.h:55
@ TransformEvent
Definition: log.h:52
@ ResourceEvent
Definition: log.h:51
MagickExport MagickBooleanType LogComponentGenesis(void)
MagickExport const char * GetLogName(void)
MagickExport const LogInfo ** GetLogInfoList(const char *, size_t *, ExceptionInfo *)
Definition: log.c:484
MagickExport MagickBooleanType ListLogInfo(FILE *, ExceptionInfo *)
MagickExport MagickBooleanType IsEventLogging(void) magick_attribute((__pure__))
MagickExport MagickBooleanType LogMagickEventList(const LogEventType, const char *, const char *, const size_t, const char *, va_list) magick_attribute((__format__(__printf__
void(* MagickLogMethod)(const LogEventType, const char *)
Definition: log.h:64
MagickExport MagickBooleanType MagickExport void SetLogMethod(MagickLogMethod)
Definition: log.c:1854
MagickExport MagickBooleanType LogMagickEvent(const LogEventType, const char *, const char *, const size_t, const char *,...) magick_attribute((__format__(__printf__
MagickBooleanType
Definition: magick-type.h:203
#define MagickExport
Definition: method-attribute.h:80
Definition: exception.h:103
Definition: log.c:107