2 Copyright 1999-2012 ImageMagick Studio LLC, a non-profit organization
3 dedicated to making software imaging solutions freely available.
5 You may not use this file except in compliance with the License.
6 obtain a copy of the License at
8 http://www.imagemagick.org/script/license.php
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.
16 MagickCore option methods.
18 #ifndef _MAGICKCORE_OPTION_H
19 #define _MAGICKCORE_OPTION_H
21 #if defined(__cplusplus) || defined(c_plusplus)
27 MagickUndefinedOptions = -1,
28 MagickAlignOptions = 0,
33 MagickClipPathOptions,
36 MagickColorspaceOptions,
39 MagickCompressOptions,
40 MagickConfigureOptions,
41 MagickDataTypeOptions,
43 MagickDecorateOptions,
44 MagickDelegateOptions,
45 MagickDirectionOptions,
50 MagickEvaluateOptions,
51 MagickFillRuleOptions,
56 MagickFunctionOptions,
59 MagickInterlaceOptions,
60 MagickInterpolateOptions,
64 MagickLineJoinOptions,
67 MagickLogEventOptions,
75 MagickMorphologyOptions,
77 MagickOrientationOptions,
78 MagickPixelChannelOptions,
79 MagickPixelTraitOptions,
81 MagickPolicyDomainOptions,
82 MagickPolicyRightsOptions,
84 MagickPrimitiveOptions,
85 MagickQuantumFormatOptions,
86 MagickResolutionOptions,
87 MagickResourceOptions,
88 MagickSparseColorOptions,
89 MagickStatisticOptions,
93 MagickThresholdOptions,
95 MagickValidateOptions,
96 MagickVirtualPixelOptions
102 NoValidate = 0x00000,
103 CompareValidate = 0x00001,
104 CompositeValidate = 0x00002,
105 ConvertValidate = 0x00004,
106 FormatsInMemoryValidate = 0x00008,
107 FormatsOnDiskValidate = 0x00010,
108 IdentifyValidate = 0x00020,
109 ImportExportValidate = 0x00040,
110 MontageValidate = 0x00080,
111 StreamValidate = 0x00100,
112 AllValidate = 0x7fffffff
115 typedef struct _OptionInfo
129 Flags to describe classes of image processing options.
130 These are used to determine how a option should be processed, and
131 allow use to avoid attempting to process each option in every way posible.
135 UndefinedOptionFlag = 0x0000, /* option flag is not in use */
137 ImageInfoOptionFlag = 0x0001, /* Setting for ImageInfo */
138 DrawInfoOptionFlag = 0x0002, /* Setting for DrawInfo */
139 QuantizeInfoOptionFlag = 0x0004, /* Setting for QuantizeInfo */
140 GlobalOptionFlag = 0x0008, /* Setting for Global Option */
141 SettingOptionFlags = 0x000F, /* mask for all setting options */
143 SimpleOperatorOptionFlag = 0x0010, /* Simple Image processing operator */
144 ListOperatorOptionFlag = 0x0020, /* Multi-Image processing operator */
145 SpecialOptionFlag = 0x0040, /* Special handled Option */
146 GenesisOptionFlag = 0x0080, /* Genesis Command Wrapper Option */
148 ImageRequiredFlags = 0x0030, /* Flags also means Images Required */
150 NonMagickOptionFlag = 0x1000, /* Option not used by Magick Command */
151 FireOptionFlag = 0x4000, /* Convert operation seq firing point */
152 DeprecateOptionFlag = 0x8000 /* Deprecate option, give warning */
154 } CommandOptionFlags;
157 extern MagickExport char
158 **GetCommandOptions(const CommandOption),
159 *GetNextImageOption(const ImageInfo *),
160 *RemoveImageOption(ImageInfo *,const char *);
162 extern MagickExport const char
163 *CommandOptionToMnemonic(const CommandOption,const ssize_t),
164 *GetImageOption(const ImageInfo *,const char *);
166 extern MagickExport MagickBooleanType
167 CloneImageOptions(ImageInfo *,const ImageInfo *),
168 DefineImageOption(ImageInfo *,const char *),
169 DeleteImageOption(ImageInfo *,const char *),
170 IsCommandOption(const char *),
171 ListCommandOptions(FILE *,const CommandOption,ExceptionInfo *),
172 SetImageOption(ImageInfo *,const char *,const char *);
174 extern MagickExport ssize_t
175 GetCommandOptionFlags(const CommandOption,const MagickBooleanType,
177 ParseChannelOption(const char *),
178 ParsePixelChannelOption(const char *),
179 ParseCommandOption(const CommandOption,const MagickBooleanType,const char *);
181 extern MagickExport void
182 DestroyImageOptions(ImageInfo *),
183 ResetImageOptions(const ImageInfo *),
184 ResetImageOptionIterator(const ImageInfo *);
186 extern MagickExport const OptionInfo
187 *GetCommandOptionInfo(const char *value);
189 #if defined(__cplusplus) || defined(c_plusplus)