MagickWand  7.1.2-29
Convert, Edit, Or Compose Bitmap Images
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 "MagickWand/studio.h"
49 #include "MagickWand/MagickWand.h"
50 #include "MagickWand/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 
90 static 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 
119 WandExport 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  filename[MagickPathExtent],
148  *option;
149 
150  Image
151  *image;
152 
153  MagickStatusType
154  status;
155 
156  ssize_t
157  i;
158 
159  ssize_t
160  number_images;
161 
162  wand_unreferenced(metadata);
163 
164  /*
165  Set defaults.
166  */
167  assert(image_info != (ImageInfo *) NULL);
168  assert(image_info->signature == MagickCoreSignature);
169  assert(exception != (ExceptionInfo *) NULL);
170  if (IsEventLogging() != MagickFalse)
171  (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
172  if (argc < 2)
173  {
174  (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
175  "MissingArgument","%s","");
176  (void) ConjureUsage();
177  return(MagickFalse);
178  }
179  image=NewImageList();
180  number_images=0;
181  option=(char *) NULL;
182  /*
183  Conjure an image.
184  */
185  ReadCommandlLine(argc,&argv);
186  status=ExpandFilenames(&argc,&argv);
187  if (status == MagickFalse)
188  ThrowConjureException(ResourceLimitError,"MemoryAllocationFailed",
189  (char *) NULL);
190  for (i=1; i < (ssize_t) argc; i++)
191  {
192  option=argv[i];
193  if (IsCommandOption(option) != MagickFalse)
194  {
195  if (LocaleCompare("concurrent",option+1) == 0)
196  break;
197  if (LocaleCompare("debug",option+1) == 0)
198  {
199  ssize_t
200  event;
201 
202  if (*option == '+')
203  break;
204  i++;
205  if (i == (ssize_t) argc)
206  ThrowConjureException(OptionError,"MissingArgument",option);
207  event=ParseCommandOption(MagickLogEventOptions,MagickFalse,argv[i]);
208  if (event < 0)
209  ThrowConjureException(OptionError,"UnrecognizedEventType",
210  argv[i]);
211  (void) SetLogEventMask(argv[i]);
212  continue;
213  }
214  if (LocaleCompare("duration",option+1) == 0)
215  {
216  if (*option == '+')
217  break;
218  i++;
219  if (i == (ssize_t) argc)
220  ThrowConjureException(OptionError,"MissingArgument",option);
221  if (IsGeometry(argv[i]) == MagickFalse)
222  ThrowConjureInvalidArgumentException(option,argv[i]);
223  continue;
224  }
225  if ((LocaleCompare("help",option+1) == 0) ||
226  (LocaleCompare("-help",option+1) == 0))
227  {
228  if (*option == '-')
229  {
230  DestroyConjure();
231  return(ConjureUsage());
232  }
233  continue;
234  }
235  if (LocaleCompare("log",option+1) == 0)
236  {
237  if (*option == '-')
238  {
239  i++;
240  if (i == (ssize_t) argc)
241  ThrowConjureException(OptionError,"MissingLogFormat",option);
242  (void) SetLogFormat(argv[i]);
243  }
244  continue;
245  }
246  if (LocaleCompare("monitor",option+1) == 0)
247  continue;
248  if (LocaleCompare("quiet",option+1) == 0)
249  continue;
250  if (LocaleCompare("regard-warnings",option+1) == 0)
251  break;
252  if (LocaleCompare("seed",option+1) == 0)
253  {
254  if (*option == '+')
255  break;
256  i++;
257  if (i == (ssize_t) argc)
258  ThrowConjureException(OptionError,"MissingArgument",option);
259  if (IsGeometry(argv[i]) == MagickFalse)
260  ThrowConjureInvalidArgumentException(option,argv[i]);
261  break;
262  }
263  if (LocaleCompare("verbose",option+1) == 0)
264  {
265  image_info->verbose=(*option == '-') ? MagickTrue : MagickFalse;
266  continue;
267  }
268  if ((LocaleCompare("version",option+1) == 0) ||
269  (LocaleCompare("-version",option+1) == 0))
270  {
271  ListMagickVersion(stdout);
272  return(MagickTrue);
273  }
274  /*
275  Persist key/value pair.
276  */
277  (void) DeleteImageOption(image_info,option+1);
278  i++;
279  if (i == argc)
280  ThrowConjureException(OptionError,"MissingArgument",option);
281  status=SetImageOption(image_info,option+1,argv[i]);
282  if (status == MagickFalse)
283  ThrowConjureException(ImageError,"UnableToPersistKey",option);
284  continue;
285  }
286  /*
287  Interpret MSL script.
288  */
289  (void) DeleteImageOption(image_info,"filename");
290  status=SetImageOption(image_info,"filename",argv[i]);
291  if (status == MagickFalse)
292  ThrowConjureException(ImageError,"UnableToPersistKey",argv[i]);
293  (void) FormatLocaleString(filename,MagickPathExtent,"%s",argv[i]);
294  image=ReadImages(image_info,filename,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 }