% January 2012 %
% %
% %
-% Copyright 1999-2012 ImageMagick Studio LLC, a non-profit organization %
+% Copyright 1999-2013 ImageMagick Studio LLC, a non-profit organization %
% dedicated to making software imaging solutions freely available. %
% %
% You may not use this file except in compliance with the License. You may %
#include "MagickWand/studio.h"
#include "MagickWand/MagickWand.h"
#include "MagickWand/magick-wand-private.h"
+#include "MagickWand/wandcli.h"
+#include "MagickWand/wandcli-private.h"
#include "MagickWand/operation.h"
-#include "MagickWand/operation-private.h"
#include "MagickWand/magick-cli.h"
#include "MagickWand/script-token.h"
#include "MagickCore/utility-private.h"
+#include "MagickCore/exception-private.h"
#include "MagickCore/version.h"
\f
/* verbose debugging,
- 1 - option type
- 2 - source of option
- 3 - mnemonic lookup */
+ 0 - no debug lines
+ 3 - show option details (better to use -debug Command now)
+ 5 - image counts (after option runs)
+*/
#define MagickCommandDebug 0
-#define ThrowFileException(exception,severity,tag,context) \
-{ \
- char \
- *message; \
- \
- message=GetExceptionMessage(errno); \
- (void) ThrowMagickException(exception,GetMagickModule(),severity, \
- tag == (const char *) NULL ? "unknown" : tag,"`%s': %s",context,message); \
- message=DestroyString(message); \
-}
\f
/*
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% ProcessScriptOptions() reads options and processes options as they are
% found in the given file, or pipeline. The filename to open and read
-% options is given as the zeroth argument of the argument array given.
+% options is given as the 'index' argument of the argument array given.
+%
+% Other arguments following index may be read by special script options
+% as settings (strings), images, or as operations to be processed in various
+% ways. How they are treated is up to the script being processed.
%
-% A script not 'return' to the command line processing, nor can they
-% call (and return from) other scripts. At least not at this time.
+% Note that a script not 'return' to the command line processing, nor can
+% they call (and return from) other scripts. At least not at this time.
%
-% However special script options may used to read and process the other
-% argument provided, typically those that followed a "-script" option on the
-% command line. These extra script arguments may be interpreted as being
-% images to read or write, settings (strings), or more options to be
-% processed. How they are treated is up to the script being processed.
+% There are no 'ProcessOptionFlags' control flags at this time.
%
% The format of the ProcessScriptOptions method is:
%
-% void ProcessScriptOptions(MagickCLI *cli_wand,int argc,char **argv)
+% void ProcessScriptOptions(MagickCLI *cli_wand,const char *filename,
+% int argc,char **argv,int index)
%
% A description of each parameter follows:
%
% o cli_wand: the main CLI Wand to use.
%
-% o argc: the number of elements in the argument vector.
+% o filename: the filename of script to process
%
-% o argv: A text array containing the command line arguments.
+% o argc: the number of elements in the argument vector. (optional)
+%
+% o argv: A text array containing the command line arguments. (optional)
+%
+% o index: offset of next argment in argv (script arguments) (optional)
%
*/
-WandExport void ProcessScriptOptions(MagickCLI *cli_wand,int argc,char **argv)
+WandExport void ProcessScriptOptions(MagickCLI *cli_wand,const char *filename,
+ int argc,char **argv,int index)
{
ScriptTokenInfo
*token_info;
CommandOptionFlags
option_type;
- ssize_t
+ int
count;
char
*arg1,
*arg2;
- assert(argc>0 && argv[argc-1] != (char *)NULL);
+ assert(filename != (char *)NULL ); /* at least one argument - script name */
assert(cli_wand != (MagickCLI *) NULL);
assert(cli_wand->signature == WandSignature);
- if (cli_wand->wand.debug != MagickFalse)
- (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",cli_wand->wand.name);
-
-
- token_info = AcquireScriptTokenInfo(argv[0]);
- if (token_info->token == (char *) NULL) {
- ThrowFileException(cli_wand->wand.exception,OptionFatalError,
- "UnableToOpenScript",argv[0]);
+ if (IfMagickTrue(cli_wand->wand.debug))
+ (void) LogMagickEvent(CommandEvent,GetMagickModule(),
+ "Processing script \"%s\"", filename);
+
+ /* open file script or stream, and set up tokenizer */
+ token_info = AcquireScriptTokenInfo(filename);
+ if (token_info == (ScriptTokenInfo *) NULL) {
+ CLIWandExceptionFile(OptionFatalError,"UnableToOpenScript",filename);
return;
}
+ /* define the error location string for use in exceptions
+ order of localtion format escapes: filename, line, column */
+ cli_wand->location="in \"%s\" at line %u,column %u";
+ if ( LocaleCompare("-", filename) == 0 )
+ cli_wand->filename="stdin";
+ else
+ cli_wand->filename=filename;
+
/* Process Options from Script */
- cli_wand->location="'%s' in \"%s\" line %d column %d";
- cli_wand->filename=cli_wand->wand.name;
option = arg1 = arg2 = (char*)NULL;
-
while (1) {
- /* Get a option */
- if( GetScriptToken(token_info) == MagickFalse )
- break;
+ { MagickBooleanType status = GetScriptToken(token_info);
+ cli_wand->line=token_info->token_line;
+ cli_wand->column=token_info->token_column;
+ if( IfMagickFalse(status) )
+ break; /* error or end of options */
+ }
- cli_wand->line=token_info->token_line;
- cli_wand->column=token_info->token_column;
+ do { /* use break to loop to exception handler and loop */
- /* Sanity check: option is larger than what should be posible */
- if( strlen(token_info->token) > INITAL_TOKEN_LENGTH-1 ) {
- token_info->token[INITAL_TOKEN_LENGTH-4] = '.';
- token_info->token[INITAL_TOKEN_LENGTH-3] = '.';
- token_info->token[INITAL_TOKEN_LENGTH-2] = '.';
- token_info->token[INITAL_TOKEN_LENGTH-1] = '\0';
- CLIWandException(OptionFatalError,"UnrecognizedOption",token_info->token);
- break;
- }
+ /* save option details */
+ CloneString(&option,token_info->token);
- /* save option details */
- CloneString(&option,token_info->token);
-#if MagickCommandDebug >=2
- (void) FormatLocaleFile(stderr, "Script Option Token: %u,%u: \"%s\"\n",
- option_line, option_column, option );
+ /* get option, its argument count, and option type */
+ cli_wand->command = GetCommandOptionInfo(option);
+ count=cli_wand->command->type;
+ option_type=(CommandOptionFlags) cli_wand->command->flags;
+#if 0
+ (void) FormatLocaleFile(stderr, "Script: %u,%u: \"%s\" matched \"%s\"\n",
+ cli_wand->line, cli_wand->line, option, cli_wand->command->mnemonic );
#endif
- { /* get option type and argument count */
- const OptionInfo *option_info = GetCommandOptionInfo(option);
- count=option_info->type;
- option_type=option_info->flags;
+ /* handle a undefined option - image read - always for "magick-script" */
+ if ( option_type == UndefinedOptionFlag ||
+ (option_type & NonMagickOptionFlag) != 0 ) {
#if MagickCommandDebug >= 3
- (void) FormatLocaleFile(stderr, "option \"%s\" matched \"%s\"\n",
- option, option_info->mnemonic );
+ (void) FormatLocaleFile(stderr, "Script %u,%u Non-Option: \"%s\"\n",
+ cli_wand->line, cli_wand->line, option);
#endif
- }
+ if ( IfMagickFalse(IsCommandOption(option))) {
+ /* non-option -- treat as a image read */
+ cli_wand->command=(const OptionInfo *)NULL;
+ CLIOption(cli_wand,"-read",option);
+ break; /* next option */
+ }
+ CLIWandException(OptionFatalError,"UnrecognizedOption",option);
+ break; /* next option */
+ }
- /* handle a undefined option - image read? */
- if ( option_type == UndefinedOptionFlag ||
- (option_type & NonMagickOptionFlag) != 0 ) {
-#if MagickCommandDebug
- (void) FormatLocaleFile(stderr, "Script Non-Option: \"%s\"\n", option);
-#endif
- if ( IsCommandOption(option) == MagickFalse) {
- /* non-option -- treat as a image read */
- CLISpecialOperator(cli_wand,"-read",option);
- count = 0;
+ if ( count >= 1 ) {
+ if( IfMagickFalse(GetScriptToken(token_info)) )
+ CLIWandException(OptionFatalError,"MissingArgument",option);
+ CloneString(&arg1,token_info->token);
}
else
- CLIWandExceptionBreak(OptionFatalError,"UnrecognizedOption",option);
-
- if ( CLICatchException(cli_wand, MagickFalse) != MagickFalse )
- break;
- continue;
- }
-
- if ( count >= 1 ) {
- if( GetScriptToken(token_info) == MagickFalse )
- CLIWandExceptionBreak(OptionFatalError,"MissingArgument",option);
- CloneString(&arg1,token_info->token);
- }
- else
- CloneString(&arg1,(char *)NULL);
+ CloneString(&arg1,(char *)NULL);
- if ( count >= 2 ) {
- if( GetScriptToken(token_info) == MagickFalse )
- CLIWandExceptionBreak(OptionFatalError,"MissingArgument",option);
- CloneString(&arg2,token_info->token);
- }
- else
- CloneString(&arg2,(char *)NULL);
-
- /* handle script special options here */
- //either continue processing command line
- // or making use of the command line options.
- //CLICommandOptions(cli_wand,count+1,argv, MagickScriptArgsFlags);
+ if ( count >= 2 ) {
+ if( IfMagickFalse(GetScriptToken(token_info)) )
+ CLIWandExceptionBreak(OptionFatalError,"MissingArgument",option);
+ CloneString(&arg2,token_info->token);
+ }
+ else
+ CloneString(&arg2,(char *)NULL);
-#if MagickCommandDebug
- (void) FormatLocaleFile(stderr,
- "Script Option: \"%s\" \tCount: %d Flags: %04x Args: \"%s\" \"%s\"\n",
- option,(int) count,option_type,arg1,arg2);
+ /*
+ Process Options
+ */
+#if MagickCommandDebug >= 3
+ (void) FormatLocaleFile(stderr,
+ "Script %u,%u Option: \"%s\" Count: %d Flags: %04x Args: \"%s\" \"%s\"\n",
+ cli_wand->line,cli_wand->line,option,count,option_type,arg1,arg2);
#endif
+ /* Hard Depreciated Options, no code to execute - error */
+ if ( (option_type & DeprecateOptionFlag) != 0 ) {
+ CLIWandException(OptionError,"DeprecatedOptionNoCode",option);
+ break; /* next option */
+ }
- /* Process non-script specific option from file */
- if ( (option_type & SpecialOptionFlag) != 0 ) {
- if ( LocaleCompare(option,"-exit") == 0 )
- break;
- /* No "-script" from script at this time */
- CLISpecialOperator(cli_wand,option,arg1);
- }
+ /* MagickCommandGenesis() options have no place in a magick script */
+ if ( (option_type & GenesisOptionFlag) != 0 ) {
+ CLIWandException(OptionError,"InvalidUseOfOption",option);
+ break; /* next option */
+ }
- if ( (option_type & SettingOptionFlags) != 0 ) {
- CLISettingOptionInfo(cli_wand, option, arg1);
- // FUTURE: Sync Specific Settings into Images
- }
+ /* handle any special 'script' options */
+ if ( (option_type & SpecialOptionFlag) != 0 ) {
+ if ( LocaleCompare(option,"-exit") == 0 ) {
+ goto loop_exit; /* break out of loop - return from script */
+ }
+ if ( LocaleCompare(option,"-script") == 0 ) {
+ /* FUTURE: call new script from this script - error for now */
+ CLIWandException(OptionError,"InvalidUseOfOption",option);
+ break; /* next option */
+ }
+ /* FUTURE: handle special script-argument options here */
+ /* handle any other special operators now */
+ CLIWandException(OptionError,"InvalidUseOfOption",option);
+ break; /* next option */
+ }
- if ( (option_type & SimpleOperatorOptionFlag) != 0)
- CLISimpleOperatorImages(cli_wand, option, arg1, arg2);
+ /* Process non-specific Option */
+ CLIOption(cli_wand, option, arg1, arg2);
- if ( (option_type & ListOperatorOptionFlag) != 0 )
- CLIListOperatorImages(cli_wand, option, arg1, arg2);
+ } while (0); /* break block to next option */
- if ( CLICatchException(cli_wand, MagickFalse) != MagickFalse )
- break;
+#if MagickCommandDebug >= 5
+ fprintf(stderr, "Script Image Count = %ld\n",
+ GetImageListLength(cli_wand->wand.images) );
+#endif
+ if ( IfMagickTrue(CLICatchException(cli_wand, MagickFalse)) )
+ break; /* exit loop */
}
-#if MagickCommandDebug
+ /*
+ Loop exit - check for some tokenization error
+ */
+loop_exit:
+#if MagickCommandDebug >= 3
(void) FormatLocaleFile(stderr, "Script End: %d\n", token_info->status);
#endif
switch( token_info->status ) {
case TokenStatusOK:
case TokenStatusEOF:
+ if (cli_wand->image_list_stack != (Stack *)NULL)
+ CLIWandException(OptionError,"UnbalancedParenthesis", "(eof)");
+ else if (cli_wand->image_info_stack != (Stack *)NULL)
+ CLIWandException(OptionError,"UnbalancedBraces", "(eof)");
break;
case TokenStatusBadQuotes:
/* Ensure last token has a sane length for error report */
CLIWandException(OptionFatalError,"ScriptIsBinary","");
break;
}
+ if (IfMagickTrue(cli_wand->wand.debug))
+ (void) LogMagickEvent(CommandEvent,GetMagickModule(),
+ "Script End \"%s\"", filename);
/* Clean up */
token_info = DestroyScriptTokenInfo(token_info);
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% ProcessCommandOptions() reads and processes arguments in the given
-% command line argument array. The array does not contain the command
-% being processed, only the options.
+% command line argument array. The 'index' defines where in the array we
+% should begin processing
%
% The 'process_flags' can be used to control and limit option processing.
% For example, to only process one option, or how unknown and special options
%
% The format of the ProcessCommandOptions method is:
%
-% int ProcessCommandOptions(MagickCLI *cli_wand,int argc,char **argv,
-% ProcessOptionFlags process_flags )
+% int ProcessCommandOptions(MagickCLI *cli_wand,
+% int argc,char **argv,int index)
%
% A description of each parameter follows:
%
%
% o argv: A text array containing the command line arguments.
%
-% o process_flags: What type of arguments we are allowed to process
+% o process_flags: What type of arguments will be processed, ignored
+% or return errors.
+%
+% o index: index in the argv array to start processing from
+%
+% The function returns the index ot the next option to be processed. This
+% is really only releven if process_flags contains a ProcessOneOptionOnly
+% flag.
%
*/
-WandExport void ProcessCommandOptions(MagickCLI *cli_wand,int argc,
- char **argv, ProcessOptionFlags process_flags )
+WandExport int ProcessCommandOptions(MagickCLI *cli_wand, int argc,
+ char **argv, int index )
{
const char
*option,
*arg1,
*arg2;
- ssize_t
+ int
i,
end,
count;
CommandOptionFlags
option_type;
- assert(argc>0 && argv[argc-1] != (char *)NULL);
+ assert(argc>=index); /* you may have no arguments left! */
+ assert(argv != (char **)NULL);
+ assert(argv[index] != (char *)NULL);
+ assert(argv[argc-1] != (char *)NULL);
assert(cli_wand != (MagickCLI *) NULL);
assert(cli_wand->signature == WandSignature);
- if (cli_wand->wand.debug != MagickFalse)
- (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",cli_wand->wand.name);
- /*
- Parse command-line options.
- */
- cli_wand->location="'%s' %s arg %d";
+ /* define the error location string for use in exceptions
+ order of localtion format escapes: filename, line, column */
+ cli_wand->location="at %s arg %u";
cli_wand->filename="CLI";
+ cli_wand->line=index; /* note first argument we will process */
+
+ if (IfMagickTrue(cli_wand->wand.debug))
+ (void) CLILogEvent(cli_wand,CommandEvent,GetMagickModule(),
+ "- Starting (\"%s\")", argv[index]);
end = argc;
- if ( ( process_flags & ProcessOutputFile ) != 0 )
- end--;
- for (i=0; i < end; i += count +1) {
+ if ( (cli_wand->process_flags & ProcessImplictWrite) != 0 )
+ end--; /* the last arument is an implied write, do not process directly */
+
+ for (i=index; i < end; i += count +1) {
/* Finished processing one option? */
- if ( ( process_flags & ProcessOneOptionOnly ) != 0 && i != 0 )
- return;
+ if ( (cli_wand->process_flags & ProcessOneOptionOnly) != 0 && i != index )
+ return(i);
- option=argv[i];
- cli_wand->line=i;
+ do { /* use break to loop to exception handler and loop */
- { const OptionInfo *option_info = GetCommandOptionInfo(argv[i]);
- count=option_info->type;
- option_type=option_info->flags;
-#if MagickCommandDebug >= 3
- (void) FormatLocaleFile(stderr, "option \"%s\" matched \"%s\"\n",
- argv[i], option_info->mnemonic );
+ option=argv[i];
+ cli_wand->line=i; /* note the argument for this option */
+
+ /* get option, its argument count, and option type */
+ cli_wand->command = GetCommandOptionInfo(argv[i]);
+ count=cli_wand->command->type;
+ option_type=(CommandOptionFlags) cli_wand->command->flags;
+#if 0
+ (void) FormatLocaleFile(stderr, "CLI %d: \"%s\" matched \"%s\"\n",
+ i, argv[i], cli_wand->command->mnemonic );
#endif
- }
- if ( option_type == UndefinedOptionFlag ||
- (option_type & NonMagickOptionFlag) != 0 ) {
-#if MagickCommandDebug
- (void) FormatLocaleFile(stderr, "CLI Non-Option: \"%s\"\n", option);
+ if ( option_type == UndefinedOptionFlag ||
+ (option_type & NonMagickOptionFlag) != 0 ) {
+#if MagickCommandDebug >= 3
+ (void) FormatLocaleFile(stderr, "CLI arg %d Non-Option: \"%s\"\n",
+ i, option);
#endif
- if ( ( IsCommandOption(option) == MagickFalse ) &&
- ( (process_flags & ProcessNonOptionImageRead) != 0 ) ) {
- /* non-option -- treat as a image read */
- CLISpecialOperator(cli_wand,"-read",option);
- count = 0;
- }
- else if ( (process_flags & ProcessUnknownOptionError) != 0 )
+ if ( IfMagickFalse(IsCommandOption(option)) ) {
+ if ( (cli_wand->process_flags & ProcessImplictRead) != 0 ) {
+ /* non-option -- treat as a image read */
+ cli_wand->command=(const OptionInfo *)NULL;
+ CLIOption(cli_wand,"-read",option);
+ break; /* next option */
+ }
+ }
CLIWandException(OptionFatalError,"UnrecognizedOption",option);
+ break; /* next option */
+ }
- if ( CLICatchException(cli_wand, MagickFalse) != MagickFalse )
- break;
-
- continue;
- }
+ if ( ((option_type & SpecialOptionFlag) != 0 ) &&
+ ((cli_wand->process_flags & ProcessScriptOption) != 0) &&
+ (LocaleCompare(option,"-script") == 0) ) {
+ /* Call Script from CLI, with a filename as a zeroth argument.
+ NOTE: -script may need to use the 'implict write filename' argument
+ so it must be handled specially to prevent a 'missing argument' error.
+ */
+ if ( (i+count) >= argc )
+ CLIWandException(OptionFatalError,"MissingArgument",option);
+ ProcessScriptOptions(cli_wand,argv[i+1],argc,argv,i+count);
+ return(argc); /* Script does not return to CLI -- Yet */
+ /* FUTURE: when it does, their may be no write arg! */
+ }
- if ( (option_type & DeprecateOptionFlag) != 0 ) {
- CLIWandException(OptionWarning,"DeprecatedOption",option);
- if ( CLICatchException(cli_wand, MagickFalse) != MagickFalse )
- break;
- }
- if ((i+count) >= end ) {
- CLIWandException(OptionError,"MissingArgument",option);
- if ( CLICatchException(cli_wand, MagickFalse) != MagickFalse )
- break;
- continue; /* no arguments unable to proceed */
- }
+ if ((i+count) >= end ) {
+ CLIWandException(OptionFatalError,"MissingArgument",option);
+ if ( CLICatchException(cli_wand, MagickFalse) != MagickFalse )
+ return(end);
+ break; /* next option - not that their is any! */
+ }
- arg1 = ( count >= 1 ) ? argv[i+1] : (char *)NULL;
- arg2 = ( count >= 2 ) ? argv[i+2] : (char *)NULL;
+ arg1 = ( count >= 1 ) ? argv[i+1] : (char *)NULL;
+ arg2 = ( count >= 2 ) ? argv[i+2] : (char *)NULL;
-#if MagickCommandDebug
- (void) FormatLocaleFile(stderr,
- "CLI Option: \"%s\" \tCount: %d Flags: %04x Args: \"%s\" \"%s\"\n",
- option,(int) count,option_type,arg1,arg2);
+ /*
+ Process Known Options
+ */
+#if MagickCommandDebug >= 3
+ (void) FormatLocaleFile(stderr,
+ "CLI arg %u Option: \"%s\" Count: %d Flags: %04x Args: \"%s\" \"%s\"\n",
+ i,option,count,option_type,arg1,arg2);
#endif
+ /* ignore 'genesis options' in command line args */
+ if ( (option_type & GenesisOptionFlag) != 0 )
+ break; /* next option */
+
+ /* Handle any special options for CLI (-script handled above) */
+ if ( (option_type & SpecialOptionFlag) != 0 ) {
+ if ( (cli_wand->process_flags & ProcessExitOption) != 0
+ && LocaleCompare(option,"-exit") == 0 )
+ return(i+count);
+ break; /* next option */
+ }
- if ( (option_type & SpecialOptionFlag) != 0 ) {
- if ( ( process_flags & ProcessExitOption ) != 0
- && LocaleCompare(option,"-exit") == 0 )
- return;
- if ( ( process_flags & ProcessScriptOption ) != 0
- && LocaleCompare(option,"-script") == 0)
- {
- // Unbalanced Parenthesis if stack not empty
- // Call Script, with a filename as a zeroth argument
- ProcessScriptOptions(cli_wand,argc-(i+1),argv+(i+1));
- return;
- }
- CLISpecialOperator(cli_wand,option,arg1);
- }
-
- if ( (option_type & SettingOptionFlags) != 0 ) {
- CLISettingOptionInfo(cli_wand, option, arg1);
- // FUTURE: Sync Specific Settings into Images
- }
-
- if ( (option_type & SimpleOperatorOptionFlag) != 0)
- CLISimpleOperatorImages(cli_wand, option, arg1, arg2);
+ /* Process standard image option */
+ CLIOption(cli_wand, option, arg1, arg2);
- if ( (option_type & ListOperatorOptionFlag) != 0 )
- CLIListOperatorImages(cli_wand, option, arg1, arg2);
+ } while (0); /* break block to next option */
+#if MagickCommandDebug >= 5
+ (void) FormatLocaleFile(stderr, "CLI-post Image Count = %ld\n",
+ (long) GetImageListLength(cli_wand->wand.images) );
+#endif
if ( CLICatchException(cli_wand, MagickFalse) != MagickFalse )
- break;
+ return(i+count);
}
+ assert(i==end);
- if ( CLICatchException(cli_wand, MagickFalse) != MagickFalse )
- return;
+ if ( (cli_wand->process_flags & ProcessImplictWrite) == 0 )
+ return(end); /* no implied write -- just return to caller */
- if ( ( process_flags & ProcessOutputFile ) == 0 )
- return;
- assert(end==argc-1);
+ assert(end==argc-1); /* end should not include last argument */
/*
Implicit Write of images to final CLI argument
*/
option=argv[i];
+ cli_wand->line=i;
-#if MagickCommandDebug
- (void) FormatLocaleFile(stderr, "CLI Write File: \"%s\"\n", option );
-#endif
+ /* check that stacks are empty - or cause exception */
+ if (cli_wand->image_list_stack != (Stack *)NULL)
+ CLIWandException(OptionError,"UnbalancedParenthesis", "(end of cli)");
+ else if (cli_wand->image_info_stack != (Stack *)NULL)
+ CLIWandException(OptionError,"UnbalancedBraces", "(end of cli)");
+ if ( CLICatchException(cli_wand, MagickFalse) != MagickFalse )
+ return(argc);
- // if stacks are not empty
- // ThrowConvertException(OptionError,"UnbalancedParenthesis",option,i);
+#if MagickCommandDebug >= 3
+ (void) FormatLocaleFile(stderr,"CLI arg %d Write File: \"%s\"\n",i,option);
+#endif
- /* This is a valid 'do no write' option for a CLI */
+ /* Valid 'do no write' replacement option (instead of "null:") */
if (LocaleCompare(option,"-exit") == 0 )
- return; /* just exit, no image write */
-
- /* If there is an option -- produce an error */
- if (IsCommandOption(option) != MagickFalse)
- CLIWandExceptionReturn(OptionError,"MissingOutputFilename",option);
-
- /* If no images in MagickCLI */
- if ( cli_wand->wand.images == (Image *) NULL ) {
- /* a "null:" output coder with no images is not an error! */
- if ( LocaleCompare(option,"null:") == 0 )
- return;
- CLIWandExceptionReturn(OptionError,"NoImagesForFinalWrite",option);
+ return(argc); /* just exit, no image write */
+
+ /* If filename looks like an option,
+ Or the common 'end of line' error of a single space.
+ -- produce an error */
+ if (IfMagickTrue(IsCommandOption(option)) ||
+ (option[0] == ' ' && option[1] == '\0') ) {
+ CLIWandException(OptionError,"MissingOutputFilename",option);
+ return(argc);
}
-#if 0
- WandListOperatorImages(cli_wand,"-write",option,(const char *)NULL);
-#else
- (void) SyncImagesSettings(cli_wand->wand.image_info,cli_wand->wand.images,
- cli_wand->wand.exception);
- (void) WriteImages(cli_wand->wand.image_info,cli_wand->wand.images,option,
- cli_wand->wand.exception);
-#endif
- return;
+ cli_wand->command=(const OptionInfo *)NULL;
+ CLIOption(cli_wand,"-write",option);
+ return(argc);
}
\f
/*
%
% The format of the MagickImageCommand method is:
%
-% MagickBooleanType MagickImageCommand(ImageInfo *image_info,
-% int argc, char **argv, char **metadata, ExceptionInfo *exception)
+% MagickBooleanType MagickImageCommand(ImageInfo *image_info,int argc,
+% char **argv,char **metadata,ExceptionInfo *exception)
%
% A description of each parameter follows:
%
% o image_info: the starting image_info structure
-% (for compatibilty with MagickCommandGenisis())
+% (for compatibilty with MagickCommandGenisis())
%
% o argc: the number of elements in the argument vector.
%
% o argv: A text array containing the command line arguments.
%
-% o metadata: any metadata is returned here.
-% (for compatibilty with MagickCommandGenisis())
+% o metadata: any metadata (for VBS) is returned here.
+% (for compatibilty with MagickCommandGenisis())
%
% o exception: return any errors or warnings in this structure.
%
*/
-static MagickBooleanType MagickUsage(void)
+static void MagickUsage(MagickBooleanType verbose)
{
- printf("Version: %s\n",GetMagickVersion((size_t *) NULL));
- printf("Copyright: %s\n",GetMagickCopyright());
- printf("Features: %s\n\n",GetMagickFeatures());
- printf("\n");
-
- printf("Usage: %s [(options|images) ...] output_image\n", GetClientName());
- printf(" %s -script filename [script args...]\n", GetClientName());
- printf(" ... | %s -script - | ...\n", GetClientName());
- printf("\n");
-
- printf(" For more information on usage, options, examples, and technqiues\n");
- printf(" see the ImageMagick website at\n %s\n", MagickAuthoritativeURL);
- printf(" Or the web pages in ImageMagick Sources\n");
- return(MagickFalse);
+ const char
+ *name;
+
+ size_t
+ len;
+
+ name=GetClientName();
+ len=strlen(name);
+
+ if (len>=7 && LocaleCompare("convert",name+len-7) == 0) {
+ /* convert usage */
+ (void) FormatLocaleFile(stdout,
+ "Usage: %s [ {option} | {image} ... ] {output_image}\n",name);
+ (void) FormatLocaleFile(stdout,
+ " %s -help | -version | -usage | -list {option}\n\n",name);
+ return;
+ }
+ else if (len>=6 && LocaleCompare("script",name+len-6) == 0) {
+ /* magick-script usage */
+ (void) FormatLocaleFile(stdout,
+ "Usage: %s {filename} [ {script_args} ... ]\n",name);
+ }
+ else {
+ /* magick usage */
+ (void) FormatLocaleFile(stdout,
+ "Usage: %s [ {option} | {image} ... ] {output_image}\n",name);
+ (void) FormatLocaleFile(stdout,
+ " %s [ {option} | {image} ... ] -script {filename} [ {script_args} ...]\n",
+ name);
+ }
+ (void) FormatLocaleFile(stdout,
+ " %s -help | -version | -usage | -list {option}\n\n",name);
+
+ if (IfMagickFalse(verbose))
+ return;
+
+ (void) FormatLocaleFile(stdout,"%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s\n",
+ "All options are performed in a strict 'as you see them' order\n",
+ "You must read-in images before you can operate on them.\n",
+ "\n",
+ "Magick Script files can use any of the following forms...\n",
+ " #!/path/to/magick -script\n",
+ "or\n",
+ " #!/bin/sh\n",
+ " :; exec magick -script \"$0\" \"$@\"; exit 10\n",
+ " # Magick script from here...\n",
+ "or\n",
+ " #!/usr/bin/env magick-script\n",
+ "The latter two forms do not require the path to the command hard coded.\n",
+ "Note: \"magick-script\" needs to be linked to the \"magick\" command.\n",
+ "\n",
+ "For more information on usage, options, examples, and techniques\n",
+ "see the ImageMagick website at ", MagickAuthoritativeURL);
+
+ return;
}
/*
however the last argument provides the output filename.
*/
static MagickBooleanType ConcatenateImages(int argc,char **argv,
- ExceptionInfo *exception)
+ ExceptionInfo *exception )
{
FILE
*input,
register ssize_t
i;
+ if (IfMagickFalse( ExpandFilenames(&argc,&argv) ))
+ ThrowFileException(exception,ResourceLimitError,"MemoryAllocationFailed",
+ GetExceptionMessage(errno));
+
output=fopen_utf8(argv[argc-1],"wb");
if (output == (FILE *) NULL) {
- ThrowFileException(exception,FileOpenError,"UnableToOpenFile",
- argv[argc-1]);
+ ThrowFileException(exception,FileOpenError,"UnableToOpenFile",argv[argc-1]);
return(MagickFalse);
}
for (i=2; i < (ssize_t) (argc-1); i++) {
+#if 0
+ fprintf(stderr, "DEBUG: Concatenate Image: \"%s\"\n", argv[i]);
+#endif
input=fopen_utf8(argv[i],"rb");
- if (input == (FILE *) NULL)
- ThrowFileException(exception,FileOpenError,"UnableToOpenFile",argv[i]);
+ if (input == (FILE *) NULL) {
+ ThrowFileException(exception,FileOpenError,"UnableToOpenFile",argv[i]);
+ continue;
+ }
for (c=fgetc(input); c != EOF; c=fgetc(input))
(void) fputc((char) c,output);
(void) fclose(input);
MagickCLI
*cli_wand;
- const char
- *option;
+ size_t
+ len;
- /* Handle special single use options */
+ assert(image_info != (ImageInfo *)NULL);
+
+ /* For specific OS command line requirements */
+ ReadCommandlLine(argc,&argv);
+
+ /* Initialize special "CLI Wand" to hold images and settings (empty) */
+ cli_wand=AcquireMagickCLI(image_info,exception);
+ cli_wand->location="Initializing";
+ cli_wand->filename=argv[0];
+ cli_wand->line=1;
+
+ if (IfMagickTrue(cli_wand->wand.debug))
+ (void) CLILogEvent(cli_wand,CommandEvent,GetMagickModule(),
+ "\"%s\"",argv[0]);
+
+
+ GetPathComponent(argv[0],TailPath,cli_wand->wand.name);
+ SetClientName(cli_wand->wand.name);
+ ConcatenateMagickString(cli_wand->wand.name,"-CLI",MaxTextExtent);
+
+ len=strlen(argv[0]); /* precaution */
+
+ /* "convert" command - give a "depreciation" warning" */
+ if (len>=7 && LocaleCompare("convert",argv[0]+len-7) == 0) {
+ cli_wand->process_flags = ConvertCommandOptionFlags;
+ (void) FormatLocaleFile(stderr,"WARNING: %s\n",
+ "The convert is depreciated in IMv7, use \"magick\"\n");
+ }
+
+ /* Special Case: If command name ends with "script" implied "-script" */
+ if (len>=6 && LocaleCompare("script",argv[0]+len-6) == 0) {
+ if (argc >= 2 && ( (*(argv[1]) != '-') || (strlen(argv[1]) == 1) )) {
+ GetPathComponent(argv[1],TailPath,cli_wand->wand.name);
+ ProcessScriptOptions(cli_wand,argv[1],argc,argv,2);
+ goto Magick_Command_Cleanup;
+ }
+ }
+
+ /* Special Case: Version Information and Abort */
if (argc == 2) {
- option=argv[1];
- if ((LocaleCompare("-version",option+1) == 0) ||
- (LocaleCompare("--version",option+1) == 0) ) {
- (void) FormatLocaleFile(stdout,"Version: %s\n",
- GetMagickVersion((size_t *) NULL));
- (void) FormatLocaleFile(stdout,"Copyright: %s\n",
- GetMagickCopyright());
- (void) FormatLocaleFile(stdout,"Features: %s\n\n",
- GetMagickFeatures());
- return(MagickFalse);
+ if ((LocaleCompare("-version",argv[1]) == 0) || /* GNU standard option */
+ (LocaleCompare("--version",argv[1]) == 0) ) { /* just version */
+ CLIOption(cli_wand, "-version");
+ goto Magick_Command_Exit;
+ }
+ if ((LocaleCompare("-help",argv[1]) == 0) || /* GNU standard option */
+ (LocaleCompare("--help",argv[1]) == 0) ) { /* just a brief summary */
+ if (IfMagickTrue(cli_wand->wand.debug))
+ (void) CLILogEvent(cli_wand,CommandEvent,GetMagickModule(),
+ "- Special Option \"%s\"", argv[1]);
+ MagickUsage(MagickFalse);
+ goto Magick_Command_Exit;
+ }
+ if (LocaleCompare("-usage",argv[1]) == 0) { /* both version & usage */
+ if (IfMagickTrue(cli_wand->wand.debug))
+ (void) CLILogEvent(cli_wand,CommandEvent,GetMagickModule(),
+ "- Special Option \"%s\"", argv[1]);
+ CLIOption(cli_wand, "-version" );
+ MagickUsage(MagickTrue);
+ goto Magick_Command_Exit;
}
}
- /* The "magick" command must have at least two arguments */
- if (argc < 3)
- return(MagickUsage());
- ReadCommandlLine(argc,&argv);
-#if 0
- /* FUTURE: This does not make sense! Remove it.
- Only a 'image read' needs to expand file name glob patterns
- */
- status=ExpandFilenames(&argc,&argv);
- if (status == MagickFalse)
- ThrowConvertException(ResourceLimitError,"MemoryAllocationFailed",
- GetExceptionMessage(errno));
-#endif
+ /* not enough arguments -- including -help */
+ if (argc < 3) {
+ (void) FormatLocaleFile(stderr,
+ "Error: Invalid argument or not enough arguments\n\n");
+ MagickUsage(MagickFalse);
+ goto Magick_Command_Exit;
+ }
- /* Special option (hidden) for delegate usage - no wand needed */
- if (LocaleCompare("-concatenate",argv[1]) == 0)
- return(ConcatenateImages(argc,argv,exception));
+ /* Special "concatenate option (hidden) for delegate usage */
+ if (LocaleCompare("-concatenate",argv[1]) == 0) {
+ if (IfMagickTrue(cli_wand->wand.debug))
+ (void) CLILogEvent(cli_wand,CommandEvent,GetMagickModule(),
+ "- Special Option \"%s\"", argv[1]);
+ ConcatenateImages(argc,argv,exception);
+ goto Magick_Command_Exit;
+ }
- /* Initialize special "CLI Wand" to hold images and settings (empty) */
- /* FUTURE: add this to 'operations.c' */
- cli_wand=AcquireMagickCLI(image_info,exception);
+ /* List Information and Abort */
+ if (argc == 3 && LocaleCompare("-list",argv[1]) == 0) {
+ CLIOption(cli_wand, argv[1], argv[2]);
+ goto Magick_Command_Exit;
+ }
- if (LocaleCompare("-list",argv[1]) == 0)
- /* Special option, list information and exit
- FUTURE: this should be a MagickCore option,
- especially as no wand is actually needed!
- */
- CLISpecialOperator(cli_wand, argv[1], argv[2]);
- else if (LocaleCompare("-script",argv[1]) == 0) {
+ /* ------------- */
+ /* The Main Call */
+
+ if (LocaleCompare("-script",argv[1]) == 0) {
/* Start processing directly from script, no pre-script options
- Replace wand command name with script name
+ Replace wand command name with script name
+ First argument in the argv array is the script name to read.
*/
GetPathComponent(argv[2],TailPath,cli_wand->wand.name);
- ProcessScriptOptions(cli_wand,argc-2,argv+2);
+ ProcessScriptOptions(cli_wand,argv[2],argc,argv,3);
}
- else
- /* Processing Command line, assuming output file as last option */
- ProcessCommandOptions(cli_wand,argc-1,argv+1,MagickCommandOptionFlags);
-
- /* recover original image_info from bottom of stack */
+ else {
+ /* Normal Command Line, assumes output file as last option */
+ ProcessCommandOptions(cli_wand,argc,argv,1);
+ }
+ /* ------------- */
+
+Magick_Command_Cleanup:
+ cli_wand->location="Cleanup";
+ cli_wand->filename=argv[0];
+ if (IfMagickTrue(cli_wand->wand.debug))
+ (void) CLILogEvent(cli_wand,CommandEvent,GetMagickModule(),
+ "\"%s\"",argv[0]);
+
+ /* recover original image_info and clean up stacks
+ FUTURE: "-reset stacks" option */
+ while (cli_wand->image_list_stack != (Stack *)NULL)
+ CLIOption(cli_wand,")");
while (cli_wand->image_info_stack != (Stack *)NULL)
- CLISpecialOperator(cli_wand,"}",(const char *)NULL);
+ CLIOption(cli_wand,"}");
/* assert we have recovered the original structures */
assert(cli_wand->wand.image_info == image_info);
format="%w,%h,%m"; // Get this from image_info Option splaytree
text=InterpretImageProperties(image_info,cli_wand->wand.images,format,
- exception);
+ exception);
if (text == (char *) NULL)
ThrowMagickException(exception,GetMagickModule(),ResourceLimitError,
- "MemoryAllocationFailed","`%s'", GetExceptionMessage(errno));
+ "MemoryAllocationFailed","`%s'", GetExceptionMessage(errno));
else {
(void) ConcatenateString(&(*metadata),text);
text=DestroyString(text);
}
}
+
+Magick_Command_Exit:
+ cli_wand->location="Exiting";
+ cli_wand->filename=argv[0];
+ if (IfMagickTrue(cli_wand->wand.debug))
+ (void) CLILogEvent(cli_wand,CommandEvent,GetMagickModule(),
+ "\"%s\"",argv[0]);
+
/* Destroy the special CLI Wand */
cli_wand->wand.image_info = (ImageInfo *)NULL; /* not these */
cli_wand->wand.exception = (ExceptionInfo *)NULL;
cli_wand=DestroyMagickCLI(cli_wand);
- return((exception->severity > ErrorException) ? MagickFalse : MagickTrue);
+ return(IsMagickTrue(exception->severity > ErrorException));
}
projects / imagemagick / blobdiff