2 Copyright 1999-2016 ImageMagick Studio LLC, a non-profit organization
3 dedicated to making software imaging solutions freely available.
5 You may not use this file except in compliance with the License.
6 obtain a copy of the License at
8 http://www.imagemagick.org/script/license.php
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.
16 ImageMagick pixel wand API.
18 #ifndef _MAGCIKWAND_WANDCLI_PRIVATE_H
19 #define _MAGCIKWAND_WANDCLI_PRIVATE_H
21 #if defined(__cplusplus) || defined(c_plusplus)
25 #define CLIWandException(severity,tag,option) \
26 (void) CLIThrowException(cli_wand,GetMagickModule(),severity,tag, \
29 #define CLIWandExceptionArg(severity,tag,option,arg) \
30 (void) CLIThrowException(cli_wand,GetMagickModule(),severity,tag, \
31 "'%s' '%s'",option, arg)
33 #define CLIWandWarnReplaced(message) \
34 if ( (cli_wand->process_flags & ProcessWarnDeprecated) != 0 ) \
35 (void) CLIThrowException(cli_wand,GetMagickModule(),OptionWarning, \
36 "ReplacedOption", "'%s', use \"%s\"",option,message)
38 #define CLIWandExceptionFile(severity,tag,context) \
39 { char *message=GetExceptionMessage(errno); \
40 (void) CLIThrowException(cli_wand,GetMagickModule(),severity,tag, \
41 "'%s': %s",context,message); \
42 message=DestroyString(message); \
45 #define CLIWandExceptionBreak(severity,tag,option) \
46 { CLIWandException(severity,tag,option); break; }
48 #define CLIWandExceptionReturn(severity,tag,option) \
49 { CLIWandException(severity,tag,option); return; }
51 #define CLIWandExceptArgBreak(severity,tag,option,arg) \
52 { CLIWandExceptionArg(severity,tag,option,arg); break; }
54 #define CLIWandExceptArgReturn(severity,tag,option,arg) \
55 { CLIWandExceptionArg(severity,tag,option,arg); return; }
59 /* Define how options should be processed */
62 /* General Option Handling */
63 ProcessImplictRead = 0x0001, /* Non-options are image reads.
64 If not set then skip implied read
65 without producing an error.
66 For use with "mogrify" handling */
67 ProcessInterpretProperities = 0x0010, /* allow general escapes in args */
69 /* Special Option Handling */
70 ProcessExitOption = 0x0100, /* allow '-exit' use */
71 ProcessScriptOption = 0x0200, /* allow '-script' use */
72 ProcessReadOption = 0x0400, /* allow '-read' use */
73 ProcessWarnDeprecated = 0x0800, /* warn about deprecated options */
75 /* Option Processing Flags */
76 ProcessOneOptionOnly = 0x4000, /* Process one option only */
77 ProcessImplictWrite = 0x8000, /* Last arg is an implict write */
79 /* Flag Groups for specific Situations */
80 MagickCommandOptionFlags = 0x8FFF, /* Magick Command Flags */
81 ConvertCommandOptionFlags = 0x800F, /* Convert Command Flags */
82 MagickScriptArgsFlags = 0x000F, /* Script CLI Process Args Flags */
86 /* Define a generic stack linked list, for pushing and popping
87 user defined ImageInfo settings, and Image lists.
88 See '(' ')' and '-clone' CLI options.
96 /* Note this defines an extension to the normal MagickWand
97 Which adds extra elements specific to the Shell API interface
98 while still allowing the Wand to be passed to MagickWand API
99 for specific operations.
101 struct _MagickCLI /* CLI interface version of MagickWand */
103 struct _MagickWand /* This must be the first structure */
104 wand; /* The Image List and Global Option Settings */
107 *quantize_info; /* for CLI API usage, not used by MagickWand API */
110 *draw_info; /* for CLI API usage, not used by MagickWand API */
113 process_flags; /* When handling CLI, what options do we process? */
116 *command; /* The option entry that is being processed */
119 *image_list_stack, /* Stacks of Image Lists and Image Info settings */
122 const char /* Location of option being processed for exception */
123 *location, /* location format string for exception reports */
124 *filename; /* "CLI", "unknown", or the script filename */
127 line, /* location of current option from source */
128 column; /* note: line also used for cli argument count */
136 #if defined(__cplusplus) || defined(c_plusplus)