cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 1 | /* |
cristy | b56bb24 | 2014-11-25 17:12:48 +0000 | [diff] [blame] | 2 | Copyright 1999-2015 ImageMagick Studio LLC, a non-profit organization |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 3 | dedicated to making software imaging solutions freely available. |
| 4 | |
| 5 | You may not use this file except in compliance with the License. |
| 6 | obtain a copy of the License at |
| 7 | |
| 8 | http://www.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) |
| 22 | extern "C" { |
| 23 | #endif |
| 24 | |
| 25 | typedef enum |
| 26 | { |
| 27 | MagickUndefinedOptions = -1, |
| 28 | MagickAlignOptions = 0, |
cristy | 288a353 | 2012-08-28 00:19:44 +0000 | [diff] [blame] | 29 | MagickAlphaChannelOptions, |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 30 | MagickBooleanOptions, |
cristy | 947cef2 | 2013-01-17 14:16:40 +0000 | [diff] [blame] | 31 | MagickCacheOptions, |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 32 | MagickChannelOptions, |
| 33 | MagickClassOptions, |
| 34 | MagickClipPathOptions, |
| 35 | MagickCoderOptions, |
| 36 | MagickColorOptions, |
| 37 | MagickColorspaceOptions, |
| 38 | MagickCommandOptions, |
cristy | 790190d | 2013-10-04 00:51:51 +0000 | [diff] [blame] | 39 | MagickComplexOptions, |
Cristy | 1401044 | 2015-08-15 11:05:42 -0400 | [diff] [blame^] | 40 | MagickComplianceOptions, |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 41 | MagickComposeOptions, |
| 42 | MagickCompressOptions, |
| 43 | MagickConfigureOptions, |
| 44 | MagickDataTypeOptions, |
| 45 | MagickDebugOptions, |
| 46 | MagickDecorateOptions, |
| 47 | MagickDelegateOptions, |
cristy | c9b1295 | 2010-03-28 01:12:28 +0000 | [diff] [blame] | 48 | MagickDirectionOptions, |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 49 | MagickDisposeOptions, |
| 50 | MagickDistortOptions, |
| 51 | MagickDitherOptions, |
| 52 | MagickEndianOptions, |
| 53 | MagickEvaluateOptions, |
| 54 | MagickFillRuleOptions, |
| 55 | MagickFilterOptions, |
| 56 | MagickFontOptions, |
| 57 | MagickFontsOptions, |
| 58 | MagickFormatOptions, |
| 59 | MagickFunctionOptions, |
dirk | 84c7c04 | 2015-07-12 13:01:35 +0000 | [diff] [blame] | 60 | MagickGradientOptions, |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 61 | MagickGravityOptions, |
cristy | 13609b4 | 2013-10-30 21:36:37 +0000 | [diff] [blame] | 62 | MagickIntensityOptions, |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 63 | MagickIntentOptions, |
| 64 | MagickInterlaceOptions, |
| 65 | MagickInterpolateOptions, |
anthony | 29188a8 | 2010-01-22 10:12:34 +0000 | [diff] [blame] | 66 | MagickKernelOptions, |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 67 | MagickLayerOptions, |
| 68 | MagickLineCapOptions, |
| 69 | MagickLineJoinOptions, |
| 70 | MagickListOptions, |
| 71 | MagickLocaleOptions, |
| 72 | MagickLogEventOptions, |
| 73 | MagickLogOptions, |
| 74 | MagickMagicOptions, |
| 75 | MagickMethodOptions, |
| 76 | MagickMetricOptions, |
| 77 | MagickMimeOptions, |
| 78 | MagickModeOptions, |
| 79 | MagickModuleOptions, |
anthony | 29188a8 | 2010-01-22 10:12:34 +0000 | [diff] [blame] | 80 | MagickMorphologyOptions, |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 81 | MagickNoiseOptions, |
| 82 | MagickOrientationOptions, |
cristy | 6dcb9b8 | 2011-10-23 23:21:25 +0000 | [diff] [blame] | 83 | MagickPixelChannelOptions, |
cristy | ac73d1f | 2013-03-12 00:51:09 +0000 | [diff] [blame] | 84 | MagickPixelIntensityOptions, |
cristy | 18fd443 | 2013-03-22 01:26:09 +0000 | [diff] [blame] | 85 | MagickPixelMaskOptions, |
cristy | 6dcb9b8 | 2011-10-23 23:21:25 +0000 | [diff] [blame] | 86 | MagickPixelTraitOptions, |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 87 | MagickPolicyOptions, |
| 88 | MagickPolicyDomainOptions, |
| 89 | MagickPolicyRightsOptions, |
| 90 | MagickPreviewOptions, |
| 91 | MagickPrimitiveOptions, |
| 92 | MagickQuantumFormatOptions, |
| 93 | MagickResolutionOptions, |
| 94 | MagickResourceOptions, |
| 95 | MagickSparseColorOptions, |
cristy | 0834d64 | 2011-03-18 18:26:08 +0000 | [diff] [blame] | 96 | MagickStatisticOptions, |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 97 | MagickStorageOptions, |
| 98 | MagickStretchOptions, |
| 99 | MagickStyleOptions, |
| 100 | MagickThresholdOptions, |
| 101 | MagickTypeOptions, |
| 102 | MagickValidateOptions, |
dirk | 5acf702 | 2015-07-30 18:37:03 +0000 | [diff] [blame] | 103 | MagickVirtualPixelOptions, |
| 104 | MagickWeightOptions |
cristy | 042ee78 | 2011-04-22 18:48:30 +0000 | [diff] [blame] | 105 | } CommandOption; |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 106 | |
| 107 | typedef enum |
| 108 | { |
| 109 | UndefinedValidate, |
| 110 | NoValidate = 0x00000, |
cristy | 80e870e | 2013-05-07 12:23:02 +0000 | [diff] [blame] | 111 | ColorspaceValidate = 0x00001, |
| 112 | CompareValidate = 0x00002, |
| 113 | CompositeValidate = 0x00004, |
| 114 | ConvertValidate = 0x00008, |
cristy | 247eebde | 2013-06-13 01:01:43 +0000 | [diff] [blame] | 115 | FormatsDiskValidate = 0x00010, |
| 116 | FormatsMapValidate = 0x00020, |
| 117 | FormatsMemoryValidate = 0x00040, |
| 118 | IdentifyValidate = 0x00080, |
| 119 | ImportExportValidate = 0x00100, |
| 120 | MontageValidate = 0x00200, |
| 121 | StreamValidate = 0x00400, |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 122 | AllValidate = 0x7fffffff |
| 123 | } ValidateType; |
| 124 | |
cristy | 042ee78 | 2011-04-22 18:48:30 +0000 | [diff] [blame] | 125 | /* |
| 126 | Flags to describe classes of image processing options. |
anthony | fd706f9 | 2012-01-19 04:22:02 +0000 | [diff] [blame] | 127 | These are used to determine how a option should be processed, and |
anthony | a322a83 | 2013-04-27 06:28:03 +0000 | [diff] [blame] | 128 | avoid attempting to process all options in every way posible. |
cristy | 042ee78 | 2011-04-22 18:48:30 +0000 | [diff] [blame] | 129 | */ |
anthony | ce2716b | 2011-04-22 09:51:34 +0000 | [diff] [blame] | 130 | typedef enum |
| 131 | { |
anthony | fd706f9 | 2012-01-19 04:22:02 +0000 | [diff] [blame] | 132 | UndefinedOptionFlag = 0x0000, /* option flag is not in use */ |
| 133 | |
anthony | 3ae4293 | 2012-04-16 13:59:49 +0000 | [diff] [blame] | 134 | ImageInfoOptionFlag = 0x0001, /* Setting stored in ImageInfo */ |
| 135 | DrawInfoOptionFlag = 0x0002, /* Setting stored in DrawInfo */ |
| 136 | QuantizeInfoOptionFlag = 0x0004, /* Setting stored in QuantizeInfo */ |
anthony | 22de272 | 2012-04-19 14:43:00 +0000 | [diff] [blame] | 137 | GlobalOptionFlag = 0x0008, /* Global Setting or Control */ |
anthony | 964d28e | 2012-05-17 23:39:46 +0000 | [diff] [blame] | 138 | SettingOptionFlags = 0x000F, /* mask any setting option */ |
anthony | fd706f9 | 2012-01-19 04:22:02 +0000 | [diff] [blame] | 139 | |
anthony | 464f1c4 | 2012-04-22 08:51:01 +0000 | [diff] [blame] | 140 | NoImageOperatorFlag = 0x0010, /* Images not required operator */ |
| 141 | SimpleOperatorFlag = 0x0020, /* Simple Image processing operator */ |
| 142 | ListOperatorFlag = 0x0040, /* Multi-Image processing operator */ |
anthony | bcdb020 | 2012-04-12 11:54:26 +0000 | [diff] [blame] | 143 | GenesisOptionFlag = 0x0080, /* MagickCommandGenesis() Only Option */ |
anthony | fd706f9 | 2012-01-19 04:22:02 +0000 | [diff] [blame] | 144 | |
anthony | 464f1c4 | 2012-04-22 08:51:01 +0000 | [diff] [blame] | 145 | SpecialOptionFlag = 0x0100, /* Operator with Special Requirements */ |
| 146 | /* EG: for specific CLI commands */ |
anthony | 8226e72 | 2012-04-05 14:25:46 +0000 | [diff] [blame] | 147 | |
anthony | 964d28e | 2012-05-17 23:39:46 +0000 | [diff] [blame] | 148 | AlwaysInterpretArgsFlag = 0x0400, /* Always Interpret escapes in Args */ |
anthony | 4837ac2 | 2012-05-18 23:39:48 +0000 | [diff] [blame] | 149 | /* CF: "convert" compatibility mode */ |
anthony | 964d28e | 2012-05-17 23:39:46 +0000 | [diff] [blame] | 150 | NeverInterpretArgsFlag = 0x0800, /* Never Interpret escapes in Args */ |
anthony | a322a83 | 2013-04-27 06:28:03 +0000 | [diff] [blame] | 151 | /* EG: filename, or delayed escapes */ |
anthony | 964d28e | 2012-05-17 23:39:46 +0000 | [diff] [blame] | 152 | |
anthony | 668f43a | 2012-02-20 14:55:32 +0000 | [diff] [blame] | 153 | NonMagickOptionFlag = 0x1000, /* Option not used by Magick Command */ |
anthony | 975a8d7 | 2012-04-12 13:54:36 +0000 | [diff] [blame] | 154 | FireOptionFlag = 0x2000, /* Convert operation seq firing point */ |
| 155 | DeprecateOptionFlag = 0x4000, /* Deprecate option (no code) */ |
anthony | 4837ac2 | 2012-05-18 23:39:48 +0000 | [diff] [blame] | 156 | ReplacedOptionFlag = 0x8800 /* Replaced Option (but still works) */ |
anthony | af2746d | 2012-01-16 00:16:10 +0000 | [diff] [blame] | 157 | |
anthony | ce2716b | 2011-04-22 09:51:34 +0000 | [diff] [blame] | 158 | } CommandOptionFlags; |
| 159 | |
anthony | 464f1c4 | 2012-04-22 08:51:01 +0000 | [diff] [blame] | 160 | typedef struct _OptionInfo |
| 161 | { |
| 162 | const char |
| 163 | *mnemonic; |
| 164 | |
| 165 | ssize_t |
| 166 | type, |
| 167 | flags; |
| 168 | |
| 169 | MagickBooleanType |
| 170 | stealth; |
| 171 | } OptionInfo; |
| 172 | |
anthony | fd706f9 | 2012-01-19 04:22:02 +0000 | [diff] [blame] | 173 | |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 174 | extern MagickExport char |
cristy | 042ee78 | 2011-04-22 18:48:30 +0000 | [diff] [blame] | 175 | **GetCommandOptions(const CommandOption), |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 176 | *GetNextImageOption(const ImageInfo *), |
| 177 | *RemoveImageOption(ImageInfo *,const char *); |
| 178 | |
| 179 | extern MagickExport const char |
cristy | 042ee78 | 2011-04-22 18:48:30 +0000 | [diff] [blame] | 180 | *CommandOptionToMnemonic(const CommandOption,const ssize_t), |
| 181 | *GetImageOption(const ImageInfo *,const char *); |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 182 | |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 183 | extern MagickExport MagickBooleanType |
| 184 | CloneImageOptions(ImageInfo *,const ImageInfo *), |
| 185 | DefineImageOption(ImageInfo *,const char *), |
| 186 | DeleteImageOption(ImageInfo *,const char *), |
cristy | 042ee78 | 2011-04-22 18:48:30 +0000 | [diff] [blame] | 187 | IsCommandOption(const char *), |
cristy | 0f975d1 | 2014-06-25 18:44:04 +0000 | [diff] [blame] | 188 | IsOptionMember(const char *,const char *), |
cristy | 042ee78 | 2011-04-22 18:48:30 +0000 | [diff] [blame] | 189 | ListCommandOptions(FILE *,const CommandOption,ExceptionInfo *), |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 190 | SetImageOption(ImageInfo *,const char *,const char *); |
| 191 | |
cristy | 5ed838e | 2010-05-31 00:05:35 +0000 | [diff] [blame] | 192 | extern MagickExport ssize_t |
cristy | 042ee78 | 2011-04-22 18:48:30 +0000 | [diff] [blame] | 193 | GetCommandOptionFlags(const CommandOption,const MagickBooleanType, |
| 194 | const char *), |
cristy | 5ed838e | 2010-05-31 00:05:35 +0000 | [diff] [blame] | 195 | ParseChannelOption(const char *), |
cristy | 953c4bd | 2012-02-24 01:04:04 +0000 | [diff] [blame] | 196 | ParsePixelChannelOption(const char *), |
cristy | 042ee78 | 2011-04-22 18:48:30 +0000 | [diff] [blame] | 197 | ParseCommandOption(const CommandOption,const MagickBooleanType,const char *); |
cristy | 5ed838e | 2010-05-31 00:05:35 +0000 | [diff] [blame] | 198 | |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 199 | extern MagickExport void |
| 200 | DestroyImageOptions(ImageInfo *), |
| 201 | ResetImageOptions(const ImageInfo *), |
| 202 | ResetImageOptionIterator(const ImageInfo *); |
| 203 | |
anthony | 32d85bf | 2012-02-15 14:54:59 +0000 | [diff] [blame] | 204 | extern MagickExport const OptionInfo |
| 205 | *GetCommandOptionInfo(const char *value); |
| 206 | |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 207 | #if defined(__cplusplus) || defined(c_plusplus) |
| 208 | } |
| 209 | #endif |
| 210 | |
| 211 | #endif |