MagickCore  6.9.10
Convert, Edit, Or Compose Bitmap Images
option.h
Go to the documentation of this file.
1 /*
2  Copyright 1999-2018 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.
6  obtain a copy of the License at
7 
8  https://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 {
103 } CommandOption;
104 
105 typedef enum
106 {
108  NoValidate = 0x00000,
110  CompareValidate = 0x00002,
111  CompositeValidate = 0x00004,
112  ConvertValidate = 0x00008,
116  IdentifyValidate = 0x00080,
118  MontageValidate = 0x00200,
119  StreamValidate = 0x00400,
120  AllValidate = 0x7fffffff
121 } ValidateType;
122 
123 typedef struct _OptionInfo
124 {
125  const char
127 
128  ssize_t
130  flags;
131 
134 } OptionInfo;
135 
136 /*
137  Flags to describe classes of image processing options.
138 */
139 typedef 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 
155 extern MagickExport char
156  **GetCommandOptions(const CommandOption),
157  *GetNextImageOption(const ImageInfo *),
158  *RemoveImageOption(ImageInfo *,const char *);
159 
160 extern MagickExport const char
161  *CommandOptionToMnemonic(const CommandOption,const ssize_t),
162  *GetImageOption(const ImageInfo *,const char *);
163 
166  DefineImageOption(ImageInfo *,const char *),
167  DeleteImageOption(ImageInfo *,const char *),
168  IsCommandOption(const char *),
169  IsOptionMember(const char *,const char *),
170  ListCommandOptions(FILE *,const CommandOption,ExceptionInfo *),
171  SetImageOption(ImageInfo *,const char *,const char *);
172 
173 extern MagickExport ssize_t
174  GetCommandOptionFlags(const CommandOption,const MagickBooleanType,
175  const char *),
176  ParseChannelOption(const char *),
177  ParseCommandOption(const CommandOption,const MagickBooleanType,const char *);
178 
179 extern MagickExport void
181  ResetImageOptions(const ImageInfo *),
183 
184 #if defined(__cplusplus) || defined(c_plusplus)
185 }
186 #endif
187 
188 #endif
Definition: option.h:93
Definition: option.h:95
Definition: option.h:69
Definition: option.h:148
Definition: option.h:147
Definition: option.h:41
Definition: option.h:83
Definition: option.h:30
Definition: option.h:82
MagickExport char * RemoveImageOption(ImageInfo *, const char *)
Definition: option.c:2688
Definition: option.h:29
Definition: option.h:37
Definition: option.h:86
Definition: option.h:75
Definition: option.h:100
Definition: option.h:48
Definition: option.h:112
Definition: option.h:118
CommandOptionFlags
Definition: option.h:139
MagickBooleanType stealth
Definition: option.h:133
Definition: option.h:27
Definition: option.h:110
Definition: exception.h:102
Definition: image.h:361
Definition: option.h:73
Definition: option.h:84
Definition: option.h:56
Definition: option.h:111
Definition: option.h:67
Definition: option.h:36
Definition: option.h:107
Definition: option.h:119
Definition: option.h:70
Definition: option.h:49
Definition: option.h:38
Definition: option.h:81
MagickExport void ResetImageOptionIterator(const ImageInfo *)
Definition: option.c:2764
Definition: option.h:117
Definition: option.h:61
MagickExport ssize_t ParseChannelOption(const char *)
Definition: option.h:59
Definition: option.h:77
Definition: option.h:53
Definition: option.h:149
Definition: option.h:85
Definition: option.h:89
Definition: option.h:34
MagickBooleanType
Definition: magick-type.h:189
Definition: option.h:79
MagickExport void ResetImageOptions(const ImageInfo *)
Definition: option.h:43
Definition: option.h:91
Definition: option.h:39
Definition: option.h:108
Definition: option.h:88
struct _OptionInfo OptionInfo
Definition: option.h:145
Definition: option.h:63
Definition: option.h:58
Definition: option.h:72
const char * mnemonic
Definition: option.h:126
Definition: option.h:62
Definition: option.h:152
Definition: option.h:123
Definition: option.h:94
Definition: option.h:76
Definition: option.h:51
Definition: option.h:142
Definition: option.h:71
Definition: option.h:151
Definition: option.h:42
Definition: option.h:99
MagickExport MagickBooleanType IsOptionMember(const char *, const char *)
Definition: option.h:44
Definition: option.h:143
Definition: option.h:141
Definition: option.h:66
Definition: option.h:45
ssize_t type
Definition: option.h:129
Definition: option.h:54
MagickExport const char * CommandOptionToMnemonic(const CommandOption, const ssize_t)
Definition: option.h:109
Definition: option.h:64
MagickExport ssize_t GetCommandOptionFlags(const CommandOption, const MagickBooleanType, const char *)
Definition: option.h:114
Definition: option.h:116
ssize_t flags
Definition: option.h:129
Definition: option.h:96
MagickExport MagickBooleanType DeleteImageOption(ImageInfo *, const char *)
Definition: option.h:47
Definition: option.h:46
Definition: option.h:50
MagickExport void DestroyImageOptions(ImageInfo *)
MagickExport const char * GetImageOption(const ImageInfo *, const char *)
Definition: option.c:1946
MagickExport MagickBooleanType IsCommandOption(const char *)
MagickExport MagickBooleanType ListCommandOptions(FILE *, const CommandOption, ExceptionInfo *)
Definition: option.h:52
MagickExport MagickBooleanType SetImageOption(ImageInfo *, const char *, const char *)
Definition: option.c:2803
MagickExport MagickBooleanType DefineImageOption(ImageInfo *, const char *)
Definition: option.h:92
Definition: option.h:28
Definition: option.h:113
MagickExport char ** GetCommandOptions(const CommandOption)
Definition: option.h:60
ValidateType
Definition: option.h:105
Definition: option.h:97
MagickExport char * GetNextImageOption(const ImageInfo *)
Definition: option.h:80
Definition: option.h:120
MagickExport ssize_t ParseCommandOption(const CommandOption, const MagickBooleanType, const char *)
Definition: option.c:2581
Definition: option.h:146
Definition: option.h:102
Definition: option.h:144
Definition: option.h:32
Definition: option.h:31
#define MagickExport
Definition: method-attribute.h:98
Definition: option.h:40
CommandOption
Definition: option.h:25
Definition: option.h:90
Definition: option.h:98
Definition: option.h:115
Definition: option.h:57
Definition: option.h:78
Definition: option.h:150
Definition: option.h:101
Definition: option.h:35
Definition: option.h:55
Definition: option.h:65
Definition: option.h:33
Definition: option.h:87
MagickExport MagickBooleanType CloneImageOptions(ImageInfo *, const ImageInfo *)
Definition: option.h:74
Definition: option.h:68