MagickWand 6.9.13-50
Convert, Edit, Or Compose Bitmap Images
Loading...
Searching...
No Matches
conjure.c
1/*
2%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3% %
4% %
5% %
6% CCCC OOO N N JJJJJ U U RRRR EEEEE %
7% C O O NN N J U U R R E %
8% C O O N N N J U U RRRR EEE %
9% C O O N NN J J U U R R E %
10% CCCC OOO N N JJJ UUU R R EEEEE %
11% %
12% %
13% Interpret Magick Scripting Language. %
14% %
15% Software Design %
16% Cristy %
17% December 2001 %
18% %
19% %
20% Copyright 1999 ImageMagick Studio LLC, a non-profit organization %
21% dedicated to making software imaging solutions freely available. %
22% %
23% You may not use this file except in compliance with the License. You may %
24% obtain a copy of the License at %
25% %
26% https://imagemagick.org/license/ %
27% %
28% Unless required by applicable law or agreed to in writing, software %
29% distributed under the License is distributed on an "AS IS" BASIS, %
30% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. %
31% See the License for the specific language governing permissions and %
32% limitations under the License. %
33% %
34%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
35%
36% The conjure program gives you the ability to perform custom image processing
37% tasks from a script written in the Magick Scripting Language (MSL). MSL is
38% XML-based and consists of action statements with attributes. Actions include
39% reading an image, processing an image, getting attributes from an image,
40% writing an image, and more. An attribute is a key/value pair that modifies
41% the behavior of an action.
42%
43*/
44␌
45/*
46 Include declarations.
47*/
48#include "wand/studio.h"
49#include "wand/MagickWand.h"
50#include "wand/mogrify-private.h"
51␌
52/*
53%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
54% %
55% %
56% %
57+ C o n j u r e I m a g e C o m m a n d %
58% %
59% %
60% %
61%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
62%
63% ConjureImageCommand() describes the format and characteristics of one or
64% more image files. It will also report if an image is incomplete or corrupt.
65% The information displayed includes the scene number, the file name, the
66% width and height of the image, whether the image is colormapped or not,
67% the number of colors in the image, the number of bytes in the image, the
68% format of the image (JPEG, PNM, etc.), and finally the number of seconds
69% it took to read and process the image.
70%
71% The format of the ConjureImageCommand method is:
72%
73% MagickBooleanType ConjureImageCommand(ImageInfo *image_info,int argc,
74% char **argv,char **metadata,ExceptionInfo *exception)
75%
76% A description of each parameter follows:
77%
78% o image_info: the image info.
79%
80% o argc: the number of elements in the argument vector.
81%
82% o argv: A text array containing the command line arguments.
83%
84% o metadata: any metadata is returned here.
85%
86% o exception: return any errors or warnings in this structure.
87%
88*/
89
90static MagickBooleanType ConjureUsage(void)
91{
92 static const char
93 miscellaneous[] =
94 " -debug events display copious debugging information\n"
95 " -help print program options\n"
96 " -list type print a list of supported option arguments\n"
97 " -log format format of debugging information\n"
98 " -version print version information",
99 settings[] =
100 " -monitor monitor progress\n"
101 " -quiet suppress all warning messages\n"
102 " -regard-warnings pay attention to warning messages\n"
103 " -seed value seed a new sequence of pseudo-random numbers\n"
104 " -verbose print detailed information about the image";
105
106 ListMagickVersion(stdout);
107 (void) printf("Usage: %s [options ...] file [ [options ...] file ...]\n",
108 GetClientName());
109 (void) printf("\nImage Settings:\n");
110 (void) puts(settings);
111 (void) printf("\nMiscellaneous Options:\n");
112 (void) puts(miscellaneous);
113 (void) printf("\nIn addition, define any key value pairs required by "
114 "your script. For\nexample,\n\n");
115 (void) printf(" conjure -size 100x100 -color blue -foo bar script.msl\n");
116 return(MagickTrue);
117}
118
119WandExport MagickBooleanType ConjureImageCommand(ImageInfo *image_info,
120 int argc,char **argv,char **wand_unused(metadata),ExceptionInfo *exception)
121{
122#define DestroyConjure() \
123{ \
124 image=DestroyImageList(image); \
125 for (i=0; i < (ssize_t) argc; i++) \
126 argv[i]=DestroyString(argv[i]); \
127 argv=(char **) RelinquishMagickMemory(argv); \
128}
129#define ThrowConjureException(asperity,tag,option) \
130{ \
131 char *message = GetExceptionMessage(errno); \
132 (void) ThrowMagickException(exception,GetMagickModule(),asperity,tag, \
133 "`%s'",option == (char *) NULL ? message : option); \
134 message=DestroyString(message); \
135 DestroyConjure(); \
136 return(MagickFalse); \
137}
138#define ThrowConjureInvalidArgumentException(option,argument) \
139{ \
140 (void) ThrowMagickException(exception,GetMagickModule(),OptionError, \
141 "InvalidArgument","`%s': %s",option,argument); \
142 DestroyConjure(); \
143 return(MagickFalse); \
144}
145
146 char
147 *option;
148
149 Image
150 *image;
151
152 MagickStatusType
153 status;
154
155 ssize_t
156 i;
157
158 ssize_t
159 number_images;
160
161 wand_unreferenced(metadata);
162
163 /*
164 Set defaults.
165 */
166 assert(image_info != (ImageInfo *) NULL);
167 assert(image_info->signature == MagickCoreSignature);
168 assert(exception != (ExceptionInfo *) NULL);
169 if (IsEventLogging() != MagickFalse)
170 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
171 if (argc < 2)
172 {
173 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
174 "MissingArgument","%s","");
175 (void) ConjureUsage();
176 return(MagickFalse);
177 }
178 image=NewImageList();
179 number_images=0;
180 option=(char *) NULL;
181 /*
182 Conjure an image.
183 */
184 ReadCommandlLine(argc,&argv);
185 status=ExpandFilenames(&argc,&argv);
186 if (status == MagickFalse)
187 ThrowConjureException(ResourceLimitError,"MemoryAllocationFailed",
188 (char *) NULL);
189 for (i=1; i < (ssize_t) argc; i++)
190 {
191 option=argv[i];
192 if (IsCommandOption(option) != MagickFalse)
193 {
194 if (LocaleCompare("concurrent",option+1) == 0)
195 break;
196 if (LocaleCompare("debug",option+1) == 0)
197 {
198 ssize_t
199 event;
200
201 if (*option == '+')
202 break;
203 i++;
204 if (i == (ssize_t) argc)
205 ThrowConjureException(OptionError,"MissingArgument",option);
206 event=ParseCommandOption(MagickLogEventOptions,MagickFalse,argv[i]);
207 if (event < 0)
208 ThrowConjureException(OptionError,"UnrecognizedEventType",
209 argv[i]);
210 (void) SetLogEventMask(argv[i]);
211 continue;
212 }
213 if (LocaleCompare("duration",option+1) == 0)
214 {
215 if (*option == '+')
216 break;
217 i++;
218 if (i == (ssize_t) argc)
219 ThrowConjureException(OptionError,"MissingArgument",option);
220 if (IsGeometry(argv[i]) == MagickFalse)
221 ThrowConjureInvalidArgumentException(option,argv[i]);
222 continue;
223 }
224 if ((LocaleCompare("help",option+1) == 0) ||
225 (LocaleCompare("-help",option+1) == 0))
226 {
227 if (*option == '-')
228 {
229 DestroyConjure();
230 return(ConjureUsage());
231 }
232 continue;
233 }
234 if (LocaleCompare("log",option+1) == 0)
235 {
236 if (*option == '-')
237 {
238 i++;
239 if (i == (ssize_t) argc)
240 ThrowConjureException(OptionError,"MissingLogFormat",option);
241 (void) SetLogFormat(argv[i]);
242 }
243 continue;
244 }
245 if (LocaleCompare("monitor",option+1) == 0)
246 continue;
247 if (LocaleCompare("quiet",option+1) == 0)
248 continue;
249 if (LocaleCompare("regard-warnings",option+1) == 0)
250 break;
251 if (LocaleCompare("seed",option+1) == 0)
252 {
253 if (*option == '+')
254 break;
255 i++;
256 if (i == (ssize_t) argc)
257 ThrowConjureException(OptionError,"MissingArgument",option);
258 if (IsGeometry(argv[i]) == MagickFalse)
259 ThrowConjureInvalidArgumentException(option,argv[i]);
260 break;
261 }
262 if (LocaleCompare("verbose",option+1) == 0)
263 {
264 image_info->verbose=(*option == '-') ? MagickTrue : MagickFalse;
265 continue;
266 }
267 if ((LocaleCompare("version",option+1) == 0) ||
268 (LocaleCompare("-version",option+1) == 0))
269 {
270 ListMagickVersion(stdout);
271 return(MagickTrue);
272 }
273 /*
274 Persist key/value pair.
275 */
276 (void) DeleteImageOption(image_info,option+1);
277 i++;
278 if (i == argc)
279 ThrowConjureException(OptionError,"MissingArgument",option);
280 status=SetImageOption(image_info,option+1,argv[i]);
281 if (status == MagickFalse)
282 ThrowConjureException(ImageError,"UnableToPersistKey",option);
283 continue;
284 }
285 /*
286 Interpret MSL script.
287 */
288 (void) DeleteImageOption(image_info,"filename");
289 status=SetImageOption(image_info,"filename",argv[i]);
290 if (status == MagickFalse)
291 ThrowConjureException(ImageError,"UnableToPersistKey",argv[i]);
292 (void) FormatLocaleString(image_info->filename,MaxTextExtent,"%s",argv[i]);
293 (void) SetImageOption(image_info,"filename",argv[i]);
294 image=ReadImages(image_info,exception);
295 CatchException(exception);
296 if (image != (Image *) NULL)
297 image=DestroyImageList(image);
298 status=image != (Image *) NULL ? MagickTrue : MagickFalse;
299 number_images++;
300 }
301 if (i != (ssize_t) argc)
302 ThrowConjureException(OptionError,"MissingAnImageFilename",argv[i]);
303 if (number_images == 0)
304 ThrowConjureException(OptionError,"MissingAnImageFilename",argv[argc-1]);
305 if (image != (Image *) NULL)
306 image=DestroyImageList(image);
307 for (i=0; i < (ssize_t) argc; i++)
308 argv[i]=DestroyString(argv[i]);
309 argv=(char **) RelinquishMagickMemory(argv);
310 return(status != 0 ? MagickTrue : MagickFalse);
311}