rmagick 3.2.0 → 4.3.0

data/ext/RMagick/rmkinfo.c

@@ -28,10 +28,7 @@ rm_kernel_info_destroy(void *kernel)
 /**
  * Create a KernelInfo object.
  *
- * No Ruby usage (internal function)
- *
- * @param class the Ruby class to use
- * @return a new KernelInfo object
+ * @return [Magick::KernelInfo] a new KernelInfo object
  */
 VALUE
 KernelInfo_alloc(VALUE class)
@@ -42,21 +39,33 @@ KernelInfo_alloc(VALUE class)
 /**
  * KernelInfo object constructor
  *
- * Ruby usage:
- *   - @verbatim KernelInfo#initialize @endverbatim
- *
- * @param self this object
- * @param kernel_string kernel info string representation to be parsed
- * @return self
+ * @param kernel_string [String] kernel info string representation to be parsed
+ * @return [Magick::KernelInfo] self
  */
 VALUE
 KernelInfo_initialize(VALUE self, VALUE kernel_string)
 {
     KernelInfo *kernel;
+#if defined(IMAGEMAGICK_7)
+    ExceptionInfo *exception;
+#endif
 
     Check_Type(kernel_string, T_STRING);
 
+#if defined(IMAGEMAGICK_7)
+    exception = AcquireExceptionInfo();
+    kernel = AcquireKernelInfo(StringValueCStr(kernel_string), exception);
+    if (rm_should_raise_exception(exception, DestroyExceptionRetention))
+    {
+        if (kernel != (KernelInfo *) NULL)
+        {
+            DestroyKernelInfo(kernel);
+        }
+        rm_raise_exception(exception);
+    }
+#else
     kernel = AcquireKernelInfo(StringValueCStr(kernel_string));
+#endif
 
     if (!kernel)
     {
@@ -68,83 +77,34 @@ KernelInfo_initialize(VALUE self, VALUE kernel_string)
     return self;
 }
 
-/**
- * Zero kerne NaNs.
- *
- * Ruby usage:
- *   - @verbatim KernelInfo#zero_nans @endverbatim
- *
- * @param self this object
- * @deprecated This method has been deprecated.
- */
-
-/* ZeroKernelNans() is private function in ImageMagick. */
-MagickExport void ZeroKernelNans(KernelInfo *kernel);
-
-VALUE
-KernelInfo_zero_nans(VALUE self)
-{
-    rb_warning("KernelInfo#zero_nans is deprecated");
-    ZeroKernelNans((KernelInfo*)DATA_PTR(self));
-    return Qnil;
-}
 
 /**
  * Adds a given amount of the 'Unity' Convolution Kernel to the given pre-scaled and normalized Kernel.
  *
- * Ruby usage:
- *   - @verbatim KernelInfo#unity_add(scale) @endverbatim
- *
- * @param self this object
- * @param scale scale to add
+ * @param scale [Numeric] scale to add
  */
-
-/* UnityAddKernelInfo() was private function until IM 6.9 */
-MagickExport void UnityAddKernelInfo(KernelInfo *kernel, const double scale);
-
 VALUE
 KernelInfo_unity_add(VALUE self, VALUE scale)
 {
     if (!FIXNUM_P(scale))
         Check_Type(scale, T_FLOAT);
 
+    /* UnityAddKernelInfo() was private function until IM 6.9 */
+    MagickExport void UnityAddKernelInfo(KernelInfo *kernel, const double scale);
+
     UnityAddKernelInfo((KernelInfo*)DATA_PTR(self), NUM2DBL(scale));
     return Qnil;
 }
 
-/**
- * Dumps KernelInfo object to stderr
- *
- * Ruby usage:
- *   - @verbatim KernelInfo#show @endverbatim
- *
- * @param self this object
- * @deprecated This method has been deprecated.
- */
-VALUE
-KernelInfo_show(VALUE self)
-{
-    rb_warning("KernelInfo#show is deprecated");
-    ShowKernelInfo((KernelInfo*)DATA_PTR(self));
-    return Qnil;
-}
 
 /**
  * Scales the given kernel list by the given amount, with or without normalization
  * of the sum of the kernel values (as per given flags).
  *
- * Ruby usage:
- *   - @verbatim KernelInfo#scale(scale, flags) @endverbatim
- *
- * @param scale scale to use
- * @param flags one of Magick::NormalizeValue, Magick::CorrelateNormalizeValue,
- *                     and/or Magick::PercentValue
- * @param self this object
+ * @param scale [Numeric] scale to use
+ * @param flags [Magick::GeometryFlags] one of Magick::NormalizeValue, Magick::CorrelateNormalizeValue,
+ *   and/or Magick::PercentValue
  */
-
-/* ScaleKernelInfo() was private function until IM 6.9 */
-MagickExport void ScaleKernelInfo(KernelInfo *kernel, const double scaling_factor,const GeometryFlags normalize_flags);
-
 VALUE
 KernelInfo_scale(VALUE self, VALUE scale, VALUE flags)
 {
@@ -158,19 +118,18 @@ KernelInfo_scale(VALUE self, VALUE scale, VALUE flags)
     else
         rb_raise(rb_eArgError, "expected Integer or Magick::GeometryFlags to specify flags");
 
+    /* ScaleKernelInfo() was private function until IM 6.9 */
+    MagickExport void ScaleKernelInfo(KernelInfo *kernel, const double scaling_factor, const GeometryFlags normalize_flags);
+
     ScaleKernelInfo((KernelInfo*)DATA_PTR(self), NUM2DBL(scale), geoflags);
     return Qnil;
 }
 
 /**
- * Takes a geometry argument string, typically provided as a "-set option:convolve:scale {geometry}" user setting,
+ * Takes a geometry argument string, typically provided as a +-set option:convolve:scale {geometry}+ user setting,
  * and modifies the kernel according to the parsed arguments of that setting.
  *
- * Ruby usage:
- *   - @verbatim KernelInfo#scale_geometry(geometry) @endverbatim
- *
- * @param geometry geometry string to parse and apply
- * @param self this object
+ * @param geometry [String] geometry string to parse and apply
  */
 VALUE
 KernelInfo_scale_geometry(VALUE self, VALUE geometry)
@@ -183,11 +142,7 @@ KernelInfo_scale_geometry(VALUE self, VALUE geometry)
 /**
  * Creates a new clone of the object so that its can be modified without effecting the original.
  *
- * Ruby usage:
- *   - @verbatim KernelInfo#clone @endverbatim
- *
- * @param self this object
- * @return new KernelInfo instance
+ * @return [Magick::KernelInfo] new KernelInfo object
  */
 VALUE
 KernelInfo_clone(VALUE self)
@@ -201,50 +156,9 @@ KernelInfo_clone(VALUE self)
  * kernels used for special purposes such as gaussian blurring, skeleton
  * pruning, and edge distance determination.
  *
- * Ruby usage:
- *   - @verbatim KernelInfo.builtin(kernel, geometry = nil) @endverbatim
- *
- * @parms kernel one of Magick::KernelInfoType enums:
- *                      Magick::UndefinedKernel
- *                      Magick::UnityKernel
- *                      Magick::GaussianKernel
- *                      Magick::DoGKernel
- *                      Magick::LoGKernel
- *                      Magick::BlurKernel
- *                      Magick::CometKernel
- *                      Magick::LaplacianKernel
- *                      Magick::SobelKernel
- *                      Magick::FreiChenKernel
- *                      Magick::RobertsKernel
- *                      Magick::PrewittKernel
- *                      Magick::CompassKernel
- *                      Magick::KirschKernel
- *                      Magick::DiamondKernel
- *                      Magick::SquareKernel
- *                      Magick::RectangleKernel
- *                      Magick::OctagonKernel
- *                      Magick::DiskKernel
- *                      Magick::PlusKernel
- *                      Magick::CrossKernel
- *                      Magick::RingKernel
- *                      Magick::PeaksKernel
- *                      Magick::EdgesKernel
- *                      Magick::CornersKernel
- *                      Magick::DiagonalsKernel
- *                      Magick::LineEndsKernel
- *                      Magick::LineJunctionsKernel
- *                      Magick::RidgesKernel
- *                      Magick::ConvexHullKernel
- *                      Magick::ThinSEKernel
- *                      Magick::SkeletonKernel
- *                      Magick::ChebyshevKernel
- *                      Magick::ManhattanKernel
- *                      Magick::OctagonalKernel
- *                      Magick::EuclideanKernel
- *                      Magick::UserDefinedKernel
- *                      Magick::BinomialKernel
- * @param geometry geometry to pass to default kernel
- * @return KernelInfo instance
+ * @param what [Magick::KernelInfoType] kernel one of Magick::KernelInfoType enums
+ * @param geometry [String] geometry to pass to default kernel
+ * @return [Magick::KernelInfo] a new KernelInfo object
  */
 VALUE
 KernelInfo_builtin(VALUE self, VALUE what, VALUE geometry)
@@ -252,12 +166,28 @@ KernelInfo_builtin(VALUE self, VALUE what, VALUE geometry)
     KernelInfo *kernel;
     KernelInfoType kernel_type;
     GeometryInfo info;
+#if defined(IMAGEMAGICK_7)
+    ExceptionInfo *exception;
+#endif
 
     Check_Type(geometry, T_STRING);
     VALUE_TO_ENUM(what, kernel_type, KernelInfoType);
     ParseGeometry(StringValueCStr(geometry), &info);
 
+#if defined(IMAGEMAGICK_7)
+    exception = AcquireExceptionInfo();
+    kernel = AcquireKernelBuiltIn(kernel_type, &info, exception);
+    if (rm_should_raise_exception(exception, DestroyExceptionRetention))
+    {
+        if (kernel != (KernelInfo *) NULL)
+        {
+            DestroyKernelInfo(kernel);
+        }
+        rm_raise_exception(exception);
+    }
+#else
     kernel = AcquireKernelBuiltIn(kernel_type, &info);
+#endif
 
     if (!kernel)
     {