root/ImageMagick/trunk/wand/conjure.c

Revision 464, 12.1 KB (checked in by cristy, 4 weeks ago)
Line 
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%                                John Cristy                                  %
17%                               December 2001                                 %
18%                                                                             %
19%                                                                             %
20%  Copyright 1999-2009 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%    http://www.imagemagick.org/script/license.php                            %
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  const char
93    **p;
94
95  static const char
96    *miscellaneous[]=
97    {
98      "-debug events        display copious debugging information",
99      "-help                print program options",
100      "-list type           print a list of supported option arguments",
101      "-log format          format of debugging information",
102      "-version             print version information",
103      (char *) NULL
104    },
105    *settings[]=
106    {
107      "-monitor             monitor progress",
108      "-quiet               suppress all warning messages",
109      "-regard-warnings     pay attention to warning messages",
110      "-seed value          seed a new sequence of pseudo-random numbers",
111      "-verbose             print detailed information about the image",
112      (char *) NULL
113    };
114
115  (void) printf("Version: %s\n",GetMagickVersion((unsigned long *) NULL));
116  (void) printf("Copyright: %s\n",GetMagickCopyright());
117  (void) printf("Features: %s\n\n",GetMagickFeatures());
118  (void) printf("Usage: %s [options ...] file [ [options ...] file ...]\n",
119    GetClientName());
120  (void) printf("\nImage Settings:\n");
121  for (p=settings; *p != (char *) NULL; p++)
122    (void) printf("  %s\n",*p);
123  (void) printf("\nMiscellaneous Options:\n");
124  for (p=miscellaneous; *p != (char *) NULL; p++)
125    (void) printf("  %s\n",*p);
126  (void) printf("\nIn additiion, define any key value pairs required by "
127    "your script.  For\nexample,\n\n");
128  (void) printf("    conjure -size 100x100 -color blue -foo bar script.msl\n");
129  return(MagickFalse);
130}
131
132WandExport MagickBooleanType ConjureImageCommand(ImageInfo *image_info,
133  int argc,char **argv,char **wand_unused(metadata),ExceptionInfo *exception)
134{
135#define DestroyConjure() \
136{ \
137  image=DestroyImageList(image); \
138  for (i=0; i < (long) argc; i++) \
139    argv[i]=DestroyString(argv[i]); \
140  argv=(char **) RelinquishMagickMemory(argv); \
141}
142#define ThrowConjureException(asperity,tag,option) \
143{ \
144  (void) ThrowMagickException(exception,GetMagickModule(),asperity,tag,"`%s'", \
145     option); \
146  DestroyConjure(); \
147  return(MagickFalse); \
148}
149#define ThrowConjureInvalidArgumentException(option,argument) \
150{ \
151  (void) ThrowMagickException(exception,GetMagickModule(),OptionError, \
152    "InvalidArgument","`%s': %s",option,argument); \
153  DestroyConjure(); \
154  return(MagickFalse); \
155}
156
157  char
158    *option;
159
160  Image
161    *image;
162
163  long
164    number_images;
165
166  MagickStatusType
167    status;
168
169  register long
170    i;
171
172  /*
173    Set defaults.
174  */
175  assert(image_info != (ImageInfo *) NULL);
176  assert(image_info->signature == MagickSignature);
177  if (image_info->debug != MagickFalse)
178    (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
179  assert(exception != (ExceptionInfo *) NULL);
180  if (argc < 2)
181    {
182      (void) ConjureUsage();
183      return(MagickTrue);
184    }
185  image=NewImageList();
186  number_images=0;
187  option=(char *) NULL;
188  (void) respect_parenthesis;
189  /*
190    Conjure an image.
191  */
192  ReadCommandlLine(argc,&argv);
193  status=ExpandFilenames(&argc,&argv);
194  if (status == MagickFalse)
195    ThrowConjureException(ResourceLimitError,"MemoryAllocationFailed",
196      GetExceptionMessage(errno));
197  for (i=1; i < (long) argc; i++)
198  {
199    option=argv[i];
200    if (IsMagickOption(option) != MagickFalse)
201      {
202        if (LocaleCompare("concurrent",option+1) == 0)
203          break;
204        if (LocaleCompare("debug",option+1) == 0)
205          {
206            long
207              event;
208
209            if (*option == '+')
210              break;
211            i++;
212            if (i == (long) argc)
213              ThrowConjureException(OptionError,"MissingArgument",option);
214            event=ParseMagickOption(MagickLogEventOptions,MagickFalse,argv[i]);
215            if (event < 0)
216              ThrowConjureException(OptionError,"UnrecognizedEventType",
217                argv[i]);
218            (void) SetLogEventMask(argv[i]);
219            continue;
220          }
221        if (LocaleCompare("duration",option+1) == 0)
222          {
223            if (*option == '+')
224              break;
225            i++;
226            if (i == (long) (argc-1))
227              ThrowConjureException(OptionError,"MissingArgument",option);
228            if (IsGeometry(argv[i]) == MagickFalse)
229              ThrowConjureInvalidArgumentException(option,argv[i]);
230            continue;
231          }
232        if ((LocaleCompare("help",option+1) == 0) ||
233            (LocaleCompare("-help",option+1) == 0))
234          {
235            if (*option == '-')
236              return(ConjureUsage());
237            continue;
238          }
239        if (LocaleCompare("log",option+1) == 0)
240          {
241            if (*option == '-')
242              {
243                i++;
244                if (i == (long) argc)
245                  ThrowConjureException(OptionError,"MissingLogFormat",option);
246                (void) SetLogFormat(argv[i]);
247              }
248            continue;
249          }
250        if (LocaleCompare("monitor",option+1) == 0)
251          continue;
252        if (LocaleCompare("quiet",option+1) == 0)
253          continue;
254        if (LocaleCompare("regard-warnings",option+1) == 0)
255          break;
256        if (LocaleCompare("seed",option+1) == 0)
257          {
258            if (*option == '+')
259              break;
260            i++;
261            if (i == (long) (argc-1))
262              ThrowConjureException(OptionError,"MissingArgument",option);
263            if (IsGeometry(argv[i]) == MagickFalse)
264              ThrowConjureInvalidArgumentException(option,argv[i]);
265            break;
266          }
267        if (LocaleCompare("verbose",option+1) == 0)
268          {
269            image_info->verbose=(*option == '-') ? MagickTrue : MagickFalse;
270            continue;
271          }
272        if ((LocaleCompare("version",option+1) == 0) ||
273            (LocaleCompare("-version",option+1) == 0))
274          {
275            (void) fprintf(stdout,"Version: %s\n",
276              GetMagickVersion((unsigned long *) NULL));
277            (void) fprintf(stdout,"Copyright: %s\n",GetMagickCopyright());
278            (void) fprintf(stdout,"Features: %s\n\n",GetMagickFeatures());
279            return(MagickFalse);
280          }
281        /*
282          Persist key/value pair.
283        */
284        (void) DeleteImageOption(image_info,option+1);
285        status=SetImageOption(image_info,option+1,argv[i+1]);
286        if (status == MagickFalse)
287          ThrowConjureException(ImageError,"UnableToPersistKey",option);
288        i++;
289        continue;
290      }
291    /*
292      Interpret MSL script.
293    */
294    (void) DeleteImageOption(image_info,"filename");
295    status=SetImageOption(image_info,"filename",argv[i]);
296    if (status == MagickFalse)
297      ThrowConjureException(ImageError,"UnableToPersistKey",argv[i]);
298    (void) FormatMagickString(image_info->filename,MaxTextExtent,"msl:%s",
299      argv[i]);
300    image=ReadImages(image_info,exception);
301    CatchException(exception);
302    if (image != (Image *) NULL)
303      image=DestroyImageList(image);
304    status=image != (Image *) NULL ? MagickTrue : MagickFalse;
305    number_images++;
306  }
307  if (i != argc)
308    ThrowConjureException(OptionError,"MissingAnImageFilename",argv[i]);
309  if (number_images == 0)
310    ThrowConjureException(OptionError,"MissingAnImageFilename",argv[argc-1]);
311  if (image != (Image *) NULL)
312    image=DestroyImageList(image);
313  for (i=0; i < (long) argc; i++)
314    argv[i]=DestroyString(argv[i]);
315  argv=(char **) RelinquishMagickMemory(argv);
316  return(status != 0 ? MagickTrue : MagickFalse);
317}
Note: See TracBrowser for help on using the browser.