MagickCore 6.9.11-60
Convert, Edit, Or Compose Bitmap Images
option.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 option methods.
17*/
18#ifndef MAGICKCORE_OPTION_H
19#define MAGICKCORE_OPTION_H
20
21#if defined(__cplusplus) || defined(c_plusplus)
22extern "C" {
23#endif
24
25typedef enum
26{
104
105typedef enum
106{
108 NoValidate = 0x00000,
119 StreamValidate = 0x00400,
120 AllValidate = 0x7fffffff
122
123typedef struct _OptionInfo
124{
125 const char
127
128 ssize_t
131
135
136/*
137 Flags to describe classes of image processing options.
138*/
139typedef enum
140{
142 FireOptionFlag = 0x0001, /* Option sequence firing point */
143 ImageInfoOptionFlag = 0x0002, /* Sets ImageInfo, no image needed */
144 DrawInfoOptionFlag = 0x0004, /* Sets DrawInfo, no image needed */
145 QuantizeInfoOptionFlag = 0x0008, /* Sets QuantizeInfo, no image needed */
146 GlobalOptionFlag = 0x0010, /* Sets Global Option, no image needed */
147 SimpleOperatorOptionFlag = 0x0100, /* Simple Image processing operator */
148 ListOperatorOptionFlag = 0x0200, /* Multi-Image List processing operator */
149 SpecialOperatorOptionFlag = 0x0400, /* Specially handled Operator Option */
150 GenesisOptionFlag = 0x0400, /* Genesis Command Wrapper Option */
151 NonConvertOptionFlag = 0x4000, /* Option not used by Convert */
152 DeprecateOptionFlag = 0x8000 /* Deprecate option, give warning */
154
155extern MagickExport char
158 *RemoveImageOption(ImageInfo *,const char *);
159
160extern MagickExport const char
162 *GetImageOption(const ImageInfo *,const char *);
163
168 IsCommandOption(const char *),
169 IsOptionMember(const char *,const char *),
171 SetImageOption(ImageInfo *,const char *,const char *);
172
173extern MagickExport ssize_t
175 const char *),
176 ParseChannelOption(const char *),
177 ParseCommandOption(const CommandOption,const MagickBooleanType,const char *);
178
179extern MagickExport void
183
184#if defined(__cplusplus) || defined(c_plusplus)
185}
186#endif
187
188#endif
MagickBooleanType
Definition magick-type.h:203
#define MagickExport
Definition method-attribute.h:80
struct _OptionInfo OptionInfo
MagickExport char ** GetCommandOptions(const CommandOption)
MagickExport MagickBooleanType ListCommandOptions(FILE *, const CommandOption, ExceptionInfo *)
MagickExport MagickBooleanType IsOptionMember(const char *, const char *)
MagickExport void ResetImageOptions(const ImageInfo *)
MagickExport ssize_t GetCommandOptionFlags(const CommandOption, const MagickBooleanType, const char *)
ValidateType
Definition option.h:106
@ FormatsMapValidate
Definition option.h:114
@ FormatsDiskValidate
Definition option.h:113
@ MontageValidate
Definition option.h:118
@ ImportExportValidate
Definition option.h:117
@ ConvertValidate
Definition option.h:112
@ CompareValidate
Definition option.h:110
@ CompositeValidate
Definition option.h:111
@ FormatsMemoryValidate
Definition option.h:115
@ NoValidate
Definition option.h:108
@ ColorspaceValidate
Definition option.h:109
@ IdentifyValidate
Definition option.h:116
@ UndefinedValidate
Definition option.h:107
@ StreamValidate
Definition option.h:119
@ AllValidate
Definition option.h:120
MagickExport MagickBooleanType DeleteImageOption(ImageInfo *, const char *)
MagickExport ssize_t ParseCommandOption(const CommandOption, const MagickBooleanType, const char *)
Definition option.c:2586
MagickExport void DestroyImageOptions(ImageInfo *)
CommandOptionFlags
Definition option.h:140
@ DrawInfoOptionFlag
Definition option.h:144
@ QuantizeInfoOptionFlag
Definition option.h:145
@ SimpleOperatorOptionFlag
Definition option.h:147
@ FireOptionFlag
Definition option.h:142
@ NonConvertOptionFlag
Definition option.h:151
@ DeprecateOptionFlag
Definition option.h:152
@ UndefinedOptionFlag
Definition option.h:141
@ ListOperatorOptionFlag
Definition option.h:148
@ GenesisOptionFlag
Definition option.h:150
@ GlobalOptionFlag
Definition option.h:146
@ ImageInfoOptionFlag
Definition option.h:143
@ SpecialOperatorOptionFlag
Definition option.h:149
MagickExport const char * CommandOptionToMnemonic(const CommandOption, const ssize_t)
MagickExport MagickBooleanType SetImageOption(ImageInfo *, const char *, const char *)
Definition option.c:2808
MagickExport MagickBooleanType DefineImageOption(ImageInfo *, const char *)
MagickExport char * RemoveImageOption(ImageInfo *, const char *)
Definition option.c:2693
MagickExport const char * GetImageOption(const ImageInfo *, const char *)
Definition option.c:1949
MagickExport MagickBooleanType IsCommandOption(const char *)
MagickExport MagickBooleanType CloneImageOptions(ImageInfo *, const ImageInfo *)
MagickExport char * GetNextImageOption(const ImageInfo *)
MagickExport void ResetImageOptionIterator(const ImageInfo *)
Definition option.c:2769
CommandOption
Definition option.h:26
@ MagickDirectionOptions
Definition option.h:46
@ MagickComplianceOptions
Definition option.h:101
@ MagickLineJoinOptions
Definition option.h:65
@ MagickIntensityOptions
Definition option.h:98
@ MagickMetricOptions
Definition option.h:72
@ MagickGravityOptions
Definition option.h:58
@ MagickFilterOptions
Definition option.h:53
@ MagickMimeOptions
Definition option.h:73
@ MagickResolutionOptions
Definition option.h:86
@ MagickFunctionOptions
Definition option.h:57
@ MagickMagicOptions
Definition option.h:70
@ MagickCacheOptions
Definition option.h:31
@ MagickNoiseOptions
Definition option.h:77
@ MagickModuleOptions
Definition option.h:75
@ MagickColorspaceOptions
Definition option.h:37
@ MagickAutoThresholdOptions
Definition option.h:102
@ MagickListOptions
Definition option.h:66
@ MagickKernelOptions
Definition option.h:62
@ MagickCoderOptions
Definition option.h:35
@ MagickFontOptions
Definition option.h:54
@ MagickConfigureOptions
Definition option.h:41
@ MagickLineCapOptions
Definition option.h:64
@ MagickDitherOptions
Definition option.h:49
@ MagickStatisticOptions
Definition option.h:89
@ MagickClipPathOptions
Definition option.h:34
@ MagickOrientationOptions
Definition option.h:78
@ MagickInterpolateOptions
Definition option.h:61
@ MagickAlphaOptions
Definition option.h:29
@ MagickEndianOptions
Definition option.h:50
@ MagickIntentOptions
Definition option.h:59
@ MagickLocaleOptions
Definition option.h:67
@ MagickComposeOptions
Definition option.h:39
@ MagickDelegateOptions
Definition option.h:45
@ MagickModeOptions
Definition option.h:74
@ MagickLogEventOptions
Definition option.h:68
@ MagickMethodOptions
Definition option.h:71
@ MagickDecorateOptions
Definition option.h:44
@ MagickAlignOptions
Definition option.h:28
@ MagickPolicyOptions
Definition option.h:80
@ MagickResourceOptions
Definition option.h:87
@ MagickStretchOptions
Definition option.h:91
@ MagickWeightOptions
Definition option.h:100
@ MagickPrimitiveOptions
Definition option.h:84
@ MagickBooleanOptions
Definition option.h:30
@ MagickDataTypeOptions
Definition option.h:42
@ MagickValidateOptions
Definition option.h:95
@ MagickDisposeOptions
Definition option.h:47
@ MagickComplexOptions
Definition option.h:97
@ MagickPolicyDomainOptions
Definition option.h:81
@ MagickPixelIntensityOptions
Definition option.h:79
@ MagickDebugOptions
Definition option.h:43
@ MagickInterlaceOptions
Definition option.h:60
@ MagickColorOptions
Definition option.h:36
@ MagickStyleOptions
Definition option.h:92
@ MagickCommandOptions
Definition option.h:38
@ MagickFillRuleOptions
Definition option.h:52
@ MagickFormatOptions
Definition option.h:56
@ MagickDistortOptions
Definition option.h:48
@ MagickVirtualPixelOptions
Definition option.h:96
@ MagickClassOptions
Definition option.h:33
@ MagickTypeOptions
Definition option.h:94
@ MagickChannelOptions
Definition option.h:32
@ MagickSparseColorOptions
Definition option.h:88
@ MagickLayerOptions
Definition option.h:63
@ MagickCompressOptions
Definition option.h:40
@ MagickLogOptions
Definition option.h:69
@ MagickThresholdOptions
Definition option.h:93
@ MagickUndefinedOptions
Definition option.h:27
@ MagickFontsOptions
Definition option.h:55
@ MagickGradientOptions
Definition option.h:99
@ MagickQuantumFormatOptions
Definition option.h:85
@ MagickStorageOptions
Definition option.h:90
@ MagickEvaluateOptions
Definition option.h:51
@ MagickPreviewOptions
Definition option.h:83
@ MagickPolicyRightsOptions
Definition option.h:82
@ MagickMorphologyOptions
Definition option.h:76
MagickExport ssize_t ParseChannelOption(const char *)
Definition exception.h:103
Definition image.h:362
Definition option.h:124
ssize_t flags
Definition option.h:130
MagickBooleanType stealth
Definition option.h:133
ssize_t type
Definition option.h:129
const char * mnemonic
Definition option.h:126