MagickCore  6.9.6
option.h
Go to the documentation of this file.
1 /*
2  Copyright 1999-2016 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  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 {
102 } CommandOption;
103 
104 typedef enum
105 {
107  NoValidate = 0x00000,
109  CompareValidate = 0x00002,
110  CompositeValidate = 0x00004,
111  ConvertValidate = 0x00008,
115  IdentifyValidate = 0x00080,
117  MontageValidate = 0x00200,
118  StreamValidate = 0x00400,
119  AllValidate = 0x7fffffff
120 } ValidateType;
121 
122 typedef struct _OptionInfo
123 {
124  const char
126 
127  ssize_t
129  flags;
130 
133 } OptionInfo;
134 
135 /*
136  Flags to describe classes of image processing options.
137 */
138 typedef enum
139 {
141  FireOptionFlag = 0x0001, /* Option sequence firing point */
142  ImageInfoOptionFlag = 0x0002, /* Sets ImageInfo, no image needed */
143  DrawInfoOptionFlag = 0x0004, /* Sets DrawInfo, no image needed */
144  QuantizeInfoOptionFlag = 0x0008, /* Sets QuantizeInfo, no image needed */
145  GlobalOptionFlag = 0x0010, /* Sets Global Option, no image needed */
146  SimpleOperatorOptionFlag = 0x0100, /* Simple Image processing operator */
147  ListOperatorOptionFlag = 0x0200, /* Multi-Image List processing operator */
148  SpecialOperatorOptionFlag = 0x0400, /* Specially handled Operator Option */
149  GenesisOptionFlag = 0x0400, /* Genesis Command Wrapper Option */
150  NonConvertOptionFlag = 0x4000, /* Option not used by Convert */
151  DeprecateOptionFlag = 0x8000 /* Deprecate option, give warning */
153 
154 extern MagickExport char
155  **GetCommandOptions(const CommandOption),
156  *GetNextImageOption(const ImageInfo *),
157  *RemoveImageOption(ImageInfo *,const char *);
158 
159 extern MagickExport const char
160  *CommandOptionToMnemonic(const CommandOption,const ssize_t),
161  *GetImageOption(const ImageInfo *,const char *);
162 
165  DefineImageOption(ImageInfo *,const char *),
166  DeleteImageOption(ImageInfo *,const char *),
167  IsCommandOption(const char *),
168  IsOptionMember(const char *,const char *),
169  ListCommandOptions(FILE *,const CommandOption,ExceptionInfo *),
170  SetImageOption(ImageInfo *,const char *,const char *);
171 
172 extern MagickExport ssize_t
173  GetCommandOptionFlags(const CommandOption,const MagickBooleanType,
174  const char *),
175  ParseChannelOption(const char *),
176  ParseCommandOption(const CommandOption,const MagickBooleanType,const char *);
177 
178 extern MagickExport void
180  ResetImageOptions(const ImageInfo *),
182 
183 #if defined(__cplusplus) || defined(c_plusplus)
184 }
185 #endif
186 
187 #endif
Definition: option.h:93
Definition: option.h:95
Definition: option.h:69
Definition: option.h:147
Definition: option.h:146
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:2665
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:111
Definition: option.h:117
CommandOptionFlags
Definition: option.h:138
MagickBooleanType stealth
Definition: option.h:132
Definition: option.h:27
Definition: option.h:109
Definition: exception.h:102
Definition: image.h:361
Definition: option.h:73
Definition: option.h:84
Definition: option.h:56
Definition: option.h:110
Definition: option.h:67
Definition: option.h:36
Definition: option.h:106
Definition: option.h:118
Definition: option.h:70
Definition: option.h:49
Definition: option.h:38
Definition: option.h:81
MagickExport void ResetImageOptionIterator(const ImageInfo *)
Definition: option.c:2741
Definition: option.h:116
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:148
Definition: option.h:85
Definition: option.h:89
Definition: option.h:34
MagickBooleanType
Definition: magick-type.h:211
Definition: option.h:79
MagickExport void ResetImageOptions(const ImageInfo *)
Definition: option.h:43
Definition: option.h:91
Definition: option.h:39
Definition: option.h:107
Definition: option.h:88
struct _OptionInfo OptionInfo
Definition: option.h:144
Definition: option.h:63
Definition: option.h:58
Definition: option.h:72
const char * mnemonic
Definition: option.h:125
Definition: option.h:62
Definition: option.h:151
Definition: option.h:122
Definition: option.h:94
Definition: option.h:76
Definition: option.h:51
Definition: option.h:141
Definition: option.h:71
Definition: option.h:150
Definition: option.h:42
Definition: option.h:99
MagickExport MagickBooleanType IsOptionMember(const char *, const char *)
Definition: option.h:44
Definition: option.h:142
Definition: option.h:140
Definition: option.h:66
Definition: option.h:45
ssize_t type
Definition: option.h:128
Definition: option.h:54
MagickExport const char * CommandOptionToMnemonic(const CommandOption, const ssize_t)
Definition: option.h:108
Definition: option.h:64
MagickExport ssize_t GetCommandOptionFlags(const CommandOption, const MagickBooleanType, const char *)
Definition: option.h:113
Definition: option.h:115
ssize_t flags
Definition: option.h:128
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:1925
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:2780
MagickExport MagickBooleanType DefineImageOption(ImageInfo *, const char *)
Definition: option.h:92
Definition: option.h:28
Definition: option.h:112
MagickExport char ** GetCommandOptions(const CommandOption)
Definition: option.h:60
ValidateType
Definition: option.h:104
Definition: option.h:97
MagickExport char * GetNextImageOption(const ImageInfo *)
Definition: option.h:80
Definition: option.h:119
MagickExport ssize_t ParseCommandOption(const CommandOption, const MagickBooleanType, const char *)
Definition: option.c:2558
Definition: option.h:145
Definition: option.h:143
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:114
Definition: option.h:57
Definition: option.h:78
Definition: option.h:149
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