MagickCore  6.9.11
Convert, Edit, Or Compose Bitmap Images
module.h
Go to the documentation of this file.
1 /*
2  Copyright 1999-2020 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 module methods.
17 */
18 #ifndef MAGICKCORE_MODULE_H
19 #define MAGICKCORE_MODULE_H
20 
21 #include <time.h>
22 #include "magick/version.h"
23 
24 #if defined(__cplusplus) || defined(c_plusplus)
25 extern "C" {
26 #endif
27 
28 #define MagickImageCoderSignature ((size_t) \
29  (((MagickLibInterface) << 8) | MAGICKCORE_QUANTUM_DEPTH))
30 #define MagickImageFilterSignature ((size_t) \
31  (((MagickLibInterface) << 8) | MAGICKCORE_QUANTUM_DEPTH))
32 
33 typedef enum
34 {
38 
39 typedef struct _ModuleInfo
40 {
41  char
42  *path,
43  *tag;
44 
45  void
47  (*unregister_module)(void);
48 
49  size_t
50  (*register_module)(void);
51 
52  time_t
54 
57 
58  struct _ModuleInfo
60  *next; /* deprecated, use GetModuleInfoList() */
61 
62  size_t
65 
66 typedef size_t
67  ImageFilterHandler(Image **,const int,const char **,ExceptionInfo *);
68 
69 extern MagickExport char
70  **GetModuleList(const char *,const MagickModuleType,size_t *,ExceptionInfo *);
71 
72 extern MagickExport const ModuleInfo
73  **GetModuleInfoList(const char *,size_t *,ExceptionInfo *);
74 
76  InvokeDynamicImageFilter(const char *,Image **,const int,const char **,
77  ExceptionInfo *),
80  OpenModule(const char *,ExceptionInfo *),
82 
84  *GetModuleInfo(const char *,ExceptionInfo *);
85 
86 extern MagickExport void
89 
90 #if defined(__cplusplus) || defined(c_plusplus)
91 }
92 #endif
93 
94 #endif
DirectorySeparator
#define DirectorySeparator
Definition: studio.h:266
_ModuleInfo::handle
void * handle
Definition: module.h:46
LockSemaphoreInfo
MagickExport void LockSemaphoreInfo(SemaphoreInfo *semaphore_info)
Definition: semaphore.c:293
MagickExport
#define MagickExport
Definition: method-attribute.h:80
PATH_MAX
#define PATH_MAX
Definition: studio.h:358
policy.h
ThrowFileException
#define ThrowFileException(exception, severity, tag, context)
Definition: exception-private.h:60
GetModuleList
MagickExport char ** GetModuleList(const char *, const MagickModuleType, size_t *, ExceptionInfo *)
magick_unused
#define magick_unused(x)
Definition: method-attribute.h:105
CoderEvent
@ CoderEvent
Definition: log.h:42
magick.h
_ModuleInfo::unregister_module
void(* unregister_module)(void)
Definition: module.h:47
NewSplayTree
MagickExport SplayTreeInfo * NewSplayTree(int(*compare)(const void *, const void *), void *(*relinquish_key)(void *), void *(*relinquish_value)(void *))
Definition: splay-tree.c:1140
magick_unreferenced
#define magick_unreferenced(x)
Definition: method-attribute.h:106
GetModuleInfo
MagickExport ModuleInfo * GetModuleInfo(const char *, ExceptionInfo *)
PolicyError
@ PolicyError
Definition: exception.h:76
HeadPath
@ HeadPath
Definition: utility.h:30
_DIR
Definition: mac.h:42
GetMagickModule
#define GetMagickModule()
Definition: log.h:29
nt-base-private.h
_SplayTreeInfo
Definition: splay-tree.c:83
ModulePolicyDomain
@ ModulePolicyDomain
Definition: policy.h:38
MagickCoreSignature
#define MagickCoreSignature
Definition: method-attribute.h:86
FormatLocaleString
MagickExport ssize_t FormatLocaleString(char *magick_restrict string, const size_t length, const char *magick_restrict format,...)
Definition: locale.c:497
GetClientPath
MagickExport const char * GetClientPath(void)
Definition: client.c:88
MagickReadDirectory
static int MagickReadDirectory(DIR *directory, struct dirent *entry, struct dirent **result)
Definition: utility-private.h:32
ResizeQuantumMemory
MagickExport void * ResizeQuantumMemory(void *memory, const size_t count, const size_t quantum)
Definition: memory.c:1408
ListModuleInfo
MagickExport MagickBooleanType ListModuleInfo(FILE *magick_unused(file), ExceptionInfo *magick_unused(exception))
Definition: module.c:1659
MagickModuleType
MagickModuleType
Definition: module.h:34
ModuleFatalError
@ ModuleFatalError
Definition: exception.h:90
DirectoryListSeparator
#define DirectoryListSeparator
Definition: studio.h:267
MagickImageCoderSignature
#define MagickImageCoderSignature
Definition: module.h:28
IsRightsAuthorized
MagickExport MagickBooleanType IsRightsAuthorized(const PolicyDomain domain, const PolicyRights rights, const char *pattern)
Definition: policy.c:590
module.h
DestroyModuleList
MagickExport void DestroyModuleList(void)
PolicyRights
PolicyRights
Definition: policy.h:42
DestroySplayTree
MagickExport SplayTreeInfo * DestroySplayTree(SplayTreeInfo *splay_tree)
Definition: splay-tree.c:681
ResourceLimitError
@ ResourceLimitError
Definition: exception.h:55
utility.h
version.h
_ModuleInfo
Definition: module.h:40
string_.h
DestroyString
MagickExport char * DestroyString(char *string)
Definition: string.c:810
magic.h
ReadPolicyRights
@ ReadPolicyRights
Definition: policy.h:45
GetPathComponent
MagickExport void GetPathComponent(const char *path, PathType type, char *component)
Definition: utility.c:1218
MagickTrue
@ MagickTrue
Definition: magick-type.h:201
blob.h
semaphore.h
_ModuleInfo::tag
char * tag
Definition: module.h:43
hashmap.h
TraceEvent
@ TraceEvent
Definition: log.h:38
AcquireMagickMemory
MagickExport void * AcquireMagickMemory(const size_t size)
Definition: memory.c:521
_CoderInfo::name
char * name
Definition: coder.h:30
FormatLocaleFile
MagickExport ssize_t FormatLocaleFile(FILE *file, const char *magick_restrict format,...)
Definition: locale.c:402
SemaphoreInfo
Definition: semaphore.c:61
ConcatenateMagickString
MagickExport size_t ConcatenateMagickString(char *magick_restrict destination, const char *magick_restrict source, const size_t length)
Definition: string.c:426
_ModuleInfo::signature
size_t signature
Definition: module.h:63
LocaleNCompare
MagickExport int LocaleNCompare(const char *p, const char *q, const size_t length)
Definition: locale.c:1570
_Image
Definition: image.h:153
_ModuleInfo::previous
struct _ModuleInfo * previous
Definition: module.h:58
_ExceptionInfo::severity
ExceptionType severity
Definition: exception.h:105
GetCoderInfo
MagickExport const CoderInfo * GetCoderInfo(const char *name, ExceptionInfo *exception)
Definition: coder.c:477
CompareSplayTreeString
MagickExport int CompareSplayTreeString(const void *target, const void *source)
Definition: splay-tree.c:411
_ModuleInfo::path
char * path
Definition: module.h:42
ErrorException
@ ErrorException
Definition: exception.h:54
deprecate.h
_ModuleInfo::next
struct _ModuleInfo * next
Definition: module.h:60
GetMagickInfo
MagickExport const MagickInfo * GetMagickInfo(const char *name, ExceptionInfo *exception)
Definition: magick.c:415
ModuleError
@ ModuleError
Definition: exception.h:67
OpenModule
MagickExport MagickBooleanType OpenModule(const char *, ExceptionInfo *)
dirent
Definition: mac.h:54
LocaleCompare
MagickExport int LocaleCompare(const char *p, const char *q)
Definition: locale.c:1435
DestroyExceptionInfo
MagickExport ExceptionInfo * DestroyExceptionInfo(ExceptionInfo *exception)
Definition: exception.c:448
GetModuleInfoList
MagickExport const ModuleInfo ** GetModuleInfoList(const char *, size_t *, ExceptionInfo *)
ConfigureWarning
@ ConfigureWarning
Definition: exception.h:52
splay-tree.h
ImageFilterHandler
size_t ImageFilterHandler(Image **, const int, const char **, ExceptionInfo *)
Definition: module.h:67
MagickFalse
@ MagickFalse
Definition: magick-type.h:200
MagickImageCoderModule
@ MagickImageCoderModule
Definition: module.h:35
GetValueFromSplayTree
MagickExport const void * GetValueFromSplayTree(SplayTreeInfo *splay_tree, const void *key)
Definition: splay-tree.c:920
InvokeDynamicImageFilter
MagickExport MagickBooleanType InvokeDynamicImageFilter(const char *tag, Image **image, const int argc, const char **argv, ExceptionInfo *exception)
Definition: module.c:1667
_CoderInfo
Definition: coder.h:26
InvokeDynamicImageFilter
MagickExport MagickBooleanType InvokeDynamicImageFilter(const char *, Image **, const int, const char **, ExceptionInfo *)
AllocateSemaphoreInfo
MagickExport SemaphoreInfo * AllocateSemaphoreInfo(void)
Definition: semaphore.c:192
GetNumberOfNodesInSplayTree
MagickExport size_t GetNumberOfNodesInSplayTree(const SplayTreeInfo *splay_tree)
Definition: splay-tree.c:975
LocaleLower
MagickExport void LocaleLower(char *string)
Definition: locale.c:1490
ActivateSemaphoreInfo
MagickExport void ActivateSemaphoreInfo(SemaphoreInfo **semaphore_info)
Definition: semaphore.c:98
AddValueToSplayTree
MagickExport MagickBooleanType AddValueToSplayTree(SplayTreeInfo *splay_tree, const void *key, const void *value)
Definition: splay-tree.c:153
ResetSplayTreeIterator
MagickExport void ResetSplayTreeIterator(SplayTreeInfo *splay_tree)
Definition: splay-tree.c:1473
DestroySemaphoreInfo
MagickExport void DestroySemaphoreInfo(SemaphoreInfo **semaphore_info)
Definition: semaphore.c:351
ListModuleInfo
MagickExport MagickBooleanType ListModuleInfo(FILE *, ExceptionInfo *)
log.h
ConstantString
MagickExport char * ConstantString(const char *source)
Definition: string.c:699
MagickBooleanType
MagickBooleanType
Definition: magick-type.h:199
ModuleEvent
@ ModuleEvent
Definition: log.h:49
RelinquishMagickMemory
MagickExport void * RelinquishMagickMemory(void *memory)
Definition: memory.c:1123
_ModuleInfo::stealth
MagickBooleanType stealth
Definition: module.h:56
_ExceptionInfo
Definition: exception.h:103
utility-private.h
ModuleComponentGenesis
MagickExport MagickBooleanType ModuleComponentGenesis(void)
IsPathAccessible
MagickExport MagickBooleanType IsPathAccessible(const char *path)
Definition: utility.c:1472
studio.h
_MimeInfo::type
char * type
Definition: mime.c:72
closedir
MagickExport void closedir(DIR *)
_MimeInfo::pattern
char * pattern
Definition: mime.c:74
ClearMagickException
MagickExport void ClearMagickException(ExceptionInfo *exception)
Definition: exception.c:164
BasePath
@ BasePath
Definition: utility.h:32
InvokeStaticImageFilter
MagickExport MagickBooleanType InvokeStaticImageFilter(const char *, Image **, const int, const char **, ExceptionInfo *)
memory_.h
LocaleUpper
MagickExport void LocaleUpper(char *string)
Definition: locale.c:1630
MagickImageFilterModule
@ MagickImageFilterModule
Definition: module.h:36
GetNextValueInSplayTree
MagickExport const void * GetNextValueInSplayTree(SplayTreeInfo *splay_tree)
Definition: splay-tree.c:822
ModuleInfo
struct _ModuleInfo ModuleInfo
GetEnvironmentValue
MagickExport char * GetEnvironmentValue(const char *name)
Definition: string.c:1152
exception-private.h
OpenModules
MagickExport MagickBooleanType OpenModules(ExceptionInfo *)
ThrowMagickException
MagickExport MagickBooleanType ThrowMagickException(ExceptionInfo *exception, const char *module, const char *function, const size_t line, const ExceptionType severity, const char *tag, const char *format,...)
Definition: exception.c:1149
ThrowFatalException
#define ThrowFatalException(severity, tag)
Definition: exception-private.h:42
InitializeModuleList
MagickExport MagickBooleanType InitializeModuleList(ExceptionInfo *) magick_attribute((deprecated))
UnlockSemaphoreInfo
MagickExport void UnlockSemaphoreInfo(SemaphoreInfo *semaphore_info)
Definition: semaphore.c:449
exception.h
GlobExpression
MagickExport MagickBooleanType GlobExpression(const char *magick_restrict expression, const char *magick_restrict pattern, const MagickBooleanType case_insensitive)
Definition: token.c:355
FilterPolicyDomain
@ FilterPolicyDomain
Definition: policy.h:33
ModuleComponentTerminus
MagickExport void ModuleComponentTerminus(void)
ModuleWarning
@ ModuleWarning
Definition: exception.h:44
CopyMagickString
MagickExport size_t CopyMagickString(char *magick_restrict destination, const char *magick_restrict source, const size_t length)
Definition: string.c:753
LogMagickEvent
MagickExport MagickBooleanType LogMagickEvent(const LogEventType type, const char *module, const char *function, const size_t line, const char *format,...)
Definition: log.c:1420
AcquireExceptionInfo
MagickExport ExceptionInfo * AcquireExceptionInfo(void)
Definition: exception.c:113
MaxTextExtent
#define MaxTextExtent
Definition: method-attribute.h:89
static.h
CatchException
MagickExport void CatchException(ExceptionInfo *exception)
Definition: exception.c:203
MagickImageFilterSignature
#define MagickImageFilterSignature
Definition: module.h:30
token.h
module
const char * module
Definition: static.c:70
ResourceLimitFatalError
@ ResourceLimitFatalError
Definition: exception.h:78
AcquireString
MagickExport char * AcquireString(const char *source)
Definition: string.c:125
_ModuleInfo::timestamp
time_t timestamp
Definition: module.h:53
ConfigureError
@ ConfigureError
Definition: exception.h:75
_ModuleInfo::register_module
size_t(* register_module)(void)
Definition: module.h:50
client.h
coder.h
analyzeImage
size_t analyzeImage(Image **, const int, const char **, ExceptionInfo *)
dirent::d_name
char d_name[255]
Definition: mac.h:56
opendir
MagickExport DIR * opendir(const char *)
ChopPathComponents
MagickExport void ChopPathComponents(char *path, const size_t components)
Definition: utility.c:581
_MimeInfo::path
char * path
Definition: mime.c:71
AcquireQuantumMemory
MagickExport void * AcquireQuantumMemory(const size_t count, const size_t quantum)
Definition: memory.c:634
configure.h