option.h 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189
  1. /*
  2. Copyright 1999 ImageMagick Studio LLC, a non-profit organization
  3. dedicated to making software imaging solutions freely available.
  4. You may not use this file except in compliance with the License. You may
  5. obtain a copy of the License at
  6. https://imagemagick.org/script/license.php
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. MagickCore option methods.
  13. */
  14. #ifndef MAGICKCORE_OPTION_H
  15. #define MAGICKCORE_OPTION_H
  16. #if defined(__cplusplus) || defined(c_plusplus)
  17. extern "C" {
  18. #endif
  19. typedef enum
  20. {
  21. MagickUndefinedOptions = -1,
  22. MagickAlignOptions = 0,
  23. MagickAlphaOptions,
  24. MagickBooleanOptions,
  25. MagickCacheOptions,
  26. MagickChannelOptions,
  27. MagickClassOptions,
  28. MagickClipPathOptions,
  29. MagickCoderOptions,
  30. MagickColorOptions,
  31. MagickColorspaceOptions,
  32. MagickCommandOptions,
  33. MagickComposeOptions,
  34. MagickCompressOptions,
  35. MagickConfigureOptions,
  36. MagickDataTypeOptions,
  37. MagickDebugOptions,
  38. MagickDecorateOptions,
  39. MagickDelegateOptions,
  40. MagickDirectionOptions,
  41. MagickDisposeOptions,
  42. MagickDistortOptions,
  43. MagickDitherOptions,
  44. MagickEndianOptions,
  45. MagickEvaluateOptions,
  46. MagickFillRuleOptions,
  47. MagickFilterOptions,
  48. MagickFontOptions,
  49. MagickFontsOptions,
  50. MagickFormatOptions,
  51. MagickFunctionOptions,
  52. MagickGravityOptions,
  53. MagickIntentOptions,
  54. MagickInterlaceOptions,
  55. MagickInterpolateOptions,
  56. MagickKernelOptions,
  57. MagickLayerOptions,
  58. MagickLineCapOptions,
  59. MagickLineJoinOptions,
  60. MagickListOptions,
  61. MagickLocaleOptions,
  62. MagickLogEventOptions,
  63. MagickLogOptions,
  64. MagickMagicOptions,
  65. MagickMethodOptions,
  66. MagickMetricOptions,
  67. MagickMimeOptions,
  68. MagickModeOptions,
  69. MagickModuleOptions,
  70. MagickMorphologyOptions,
  71. MagickNoiseOptions,
  72. MagickOrientationOptions,
  73. MagickPixelIntensityOptions,
  74. MagickPolicyOptions,
  75. MagickPolicyDomainOptions,
  76. MagickPolicyRightsOptions,
  77. MagickPreviewOptions,
  78. MagickPrimitiveOptions,
  79. MagickQuantumFormatOptions,
  80. MagickResolutionOptions,
  81. MagickResourceOptions,
  82. MagickSparseColorOptions,
  83. MagickStatisticOptions,
  84. MagickStorageOptions,
  85. MagickStretchOptions,
  86. MagickStyleOptions,
  87. MagickThresholdOptions,
  88. MagickTypeOptions,
  89. MagickValidateOptions,
  90. MagickVirtualPixelOptions,
  91. MagickComplexOptions,
  92. MagickIntensityOptions,
  93. MagickGradientOptions,
  94. MagickWeightOptions,
  95. MagickComplianceOptions,
  96. MagickAutoThresholdOptions,
  97. MagickPagesizeOptions
  98. } CommandOption;
  99. typedef enum
  100. {
  101. UndefinedValidate,
  102. NoValidate = 0x00000,
  103. ColorspaceValidate = 0x00001,
  104. CompareValidate = 0x00002,
  105. CompositeValidate = 0x00004,
  106. ConvertValidate = 0x00008,
  107. FormatsDiskValidate = 0x00010,
  108. FormatsMapValidate = 0x00020,
  109. FormatsMemoryValidate = 0x00040,
  110. IdentifyValidate = 0x00080,
  111. ImportExportValidate = 0x00100,
  112. MontageValidate = 0x00200,
  113. StreamValidate = 0x00400,
  114. AllValidate = 0x7fffffff
  115. } ValidateType;
  116. typedef struct _OptionInfo
  117. {
  118. const char
  119. *mnemonic;
  120. ssize_t
  121. type,
  122. flags;
  123. MagickBooleanType
  124. stealth;
  125. } OptionInfo;
  126. /*
  127. Flags to describe classes of image processing options.
  128. */
  129. typedef enum
  130. {
  131. UndefinedOptionFlag = 0x0000,
  132. FireOptionFlag = 0x0001, /* Option sequence firing point */
  133. ImageInfoOptionFlag = 0x0002, /* Sets ImageInfo, no image needed */
  134. DrawInfoOptionFlag = 0x0004, /* Sets DrawInfo, no image needed */
  135. QuantizeInfoOptionFlag = 0x0008, /* Sets QuantizeInfo, no image needed */
  136. GlobalOptionFlag = 0x0010, /* Sets Global Option, no image needed */
  137. SimpleOperatorOptionFlag = 0x0100, /* Simple Image processing operator */
  138. ListOperatorOptionFlag = 0x0200, /* Multi-Image List processing operator */
  139. SpecialOperatorOptionFlag = 0x0400, /* Specially handled Operator Option */
  140. GenesisOptionFlag = 0x0400, /* Genesis Command Wrapper Option */
  141. NonConvertOptionFlag = 0x4000, /* Option not used by Convert */
  142. DeprecateOptionFlag = 0x8000 /* Deprecate option, give warning */
  143. } CommandOptionFlags;
  144. extern MagickExport char
  145. **GetCommandOptions(const CommandOption),
  146. *GetNextImageOption(const ImageInfo *),
  147. *RemoveImageOption(ImageInfo *,const char *);
  148. extern MagickExport const char
  149. *CommandOptionToMnemonic(const CommandOption,const ssize_t),
  150. *GetImageOption(const ImageInfo *,const char *);
  151. extern MagickExport MagickBooleanType
  152. CloneImageOptions(ImageInfo *,const ImageInfo *),
  153. DefineImageOption(ImageInfo *,const char *),
  154. DeleteImageOption(ImageInfo *,const char *),
  155. IsCommandOption(const char *),
  156. IsOptionMember(const char *,const char *),
  157. ListCommandOptions(FILE *,const CommandOption,ExceptionInfo *),
  158. SetImageOption(ImageInfo *,const char *,const char *);
  159. extern MagickExport ssize_t
  160. GetCommandOptionFlags(const CommandOption,const MagickBooleanType,
  161. const char *),
  162. ParseChannelOption(const char *),
  163. ParseCommandOption(const CommandOption,const MagickBooleanType,const char *);
  164. extern MagickExport void
  165. DestroyImageOptions(ImageInfo *),
  166. ResetImageOptions(const ImageInfo *),
  167. ResetImageOptionIterator(const ImageInfo *);
  168. #if defined(__cplusplus) || defined(c_plusplus)
  169. }
  170. #endif
  171. #endif