rmagick 3.1.0 → 3.2.0

data/ext/RMagick/rmpixel.c

@@ -110,6 +110,24 @@ DEF_ATTR_READER(Pixel, green, int)
  */
 DEF_ATTR_READER(Pixel, blue, int)
 
+/**
+ * Get Pixel alpha attribute.
+ *
+ * Ruby usage:
+ *   - @verbatim Pixel#alpha @endverbatim
+ *
+ * @param self this object
+ * @return the alpha value
+ */
+VALUE
+Pixel_alpha(VALUE self)
+{
+    Pixel *pixel;
+    Data_Get_Struct(self, Pixel, pixel);
+    return C_int_to_R_int(QuantumRange - pixel->opacity);
+}
+
+
 /**
  * Get Pixel opacity attribute.
  *
@@ -118,8 +136,16 @@ DEF_ATTR_READER(Pixel, blue, int)
  *
  * @param self this object
  * @return the opacity value
+ * @deprecated This method has been deprecated. Please use Pixel_alpha.
  */
-DEF_ATTR_READER(Pixel, opacity, int)
+VALUE
+Pixel_opacity(VALUE self)
+{
+    Pixel *pixel;
+    rb_warning("Pixel#opacity is deprecated; use Pixel#alpha.");
+    Data_Get_Struct(self, Pixel, pixel);
+    return C_int_to_R_int(pixel->opacity);
+}
 
 /**
  * Set Pixel red attribute.
@@ -172,6 +198,35 @@ DEF_PIXEL_CHANNEL_WRITER(green)
  */
 DEF_PIXEL_CHANNEL_WRITER(blue)
 
+/**
+ * Set Pixel alpha attribute.
+ *
+ * Ruby usage:
+ *   - @verbatim Pixel#alpha= @endverbatim
+ *
+ * Notes:
+ *   - Pixel is Observable. Setters call changed, notify_observers
+ *   - Setters return their argument values for backward compatibility to when
+ *     Pixel was a Struct class.
+ *
+ * @param self this object
+ * @param v the alpha value
+ * @return self
+ */
+VALUE
+Pixel_alpha_eq(VALUE self, VALUE v)
+{
+    Pixel *pixel;
+ 
+    rb_check_frozen(self);
+    Data_Get_Struct(self, Pixel, pixel);
+    pixel->opacity = QuantumRange - APP2QUANTUM(v);
+    (void) rb_funcall(self, rm_ID_changed, 0);
+    (void) rb_funcall(self, rm_ID_notify_observers, 1, self);
+    return QUANTUM2NUM(QuantumRange - pixel->opacity);
+}
+
+
 /**
  * Set Pixel opacity attribute.
  *
@@ -186,9 +241,21 @@ DEF_PIXEL_CHANNEL_WRITER(blue)
  * @param self this object
  * @param v the opacity value
  * @return self
+ * @deprecated This method has been deprecated. Please use Pixel_alpha_eq.
  */
-DEF_PIXEL_CHANNEL_WRITER(opacity)
+VALUE
+Pixel_opacity_eq(VALUE self, VALUE v)
+{
+    Pixel *pixel;
 
+    rb_warning("Pixel#opacity= is deprecated; use Pixel#alpha=.");
+    rb_check_frozen(self);
+    Data_Get_Struct(self, Pixel, pixel);
+    pixel->opacity = APP2QUANTUM(v);
+    (void) rb_funcall(self, rm_ID_changed, 0);
+    (void) rb_funcall(self, rm_ID_notify_observers, 1, self);
+    return QUANTUM2NUM(pixel->opacity);
+}
 
 /*
  * Get/set Pixel CMYK attributes.
@@ -421,13 +488,12 @@ Pixel_eql_q(VALUE self, VALUE other)
 VALUE
 Pixel_fcmp(int argc, VALUE *argv, VALUE self)
 {
+    double fuzz = 0.0;
+    unsigned int equal;
+    ColorspaceType colorspace = RGBColorspace;
     Image *image;
     Info *info;
-
     Pixel *this, *that;
-    ColorspaceType colorspace = RGBColorspace;
-    double fuzz = 0.0;
-    unsigned int equal;
 
     switch (argc)
     {
@@ -493,14 +559,12 @@ Pixel_fcmp(int argc, VALUE *argv, VALUE self)
  * @see Pixel_to_color
  */
 VALUE
-Pixel_from_color(VALUE class, VALUE name)
+Pixel_from_color(VALUE class ATTRIBUTE_UNUSED, VALUE name)
 {
     PixelColor pp;
     ExceptionInfo *exception;
     MagickBooleanType okay;
 
-    class = class;      // defeat "never referenced" message from icc
-
     exception = AcquireExceptionInfo();
     okay = QueryColorCompliance(StringValuePtr(name), AllCompliance, &pp, exception);
     CHECK_EXCEPTION()
@@ -536,7 +600,7 @@ Pixel_from_color(VALUE class, VALUE name)
  * @return a new Magick::Pixel object
  */
 VALUE
-Pixel_from_hsla(int argc, VALUE *argv, VALUE class)
+Pixel_from_hsla(int argc, VALUE *argv, VALUE class ATTRIBUTE_UNUSED)
 {
     double h, s, l, a = 1.0;
     MagickPixel pp;
@@ -544,8 +608,6 @@ Pixel_from_hsla(int argc, VALUE *argv, VALUE class)
     char name[50];
     MagickBooleanType alpha = MagickFalse;
 
-    class = class;          // defeat "unused parameter" message.
-
     switch (argc)
     {
         case 4:
@@ -613,12 +675,11 @@ Pixel_from_hsla(int argc, VALUE *argv, VALUE class)
  * @deprecated This method has been deprecated. Please use Pixel_from_hsla.
  */
 VALUE
-Pixel_from_HSL(VALUE class, VALUE hsl)
+Pixel_from_HSL(VALUE class ATTRIBUTE_UNUSED, VALUE hsl)
 {
     PixelColor rgb;
     double hue, saturation, luminosity;
 
-    class = class;      // defeat "never referenced" message from icc
     memset(&rgb, 0, sizeof(rgb));
 
     hsl = rb_Array(hsl);    // Ensure array

data/ext/RMagick/rmstruct.c

@@ -233,7 +233,7 @@ Import_ColorInfo(const ColorInfo *ci)
     name       = rb_str_new2(ci->name);
 
     compliance_type = ci->compliance;
-    compliance = ComplianceType_new(compliance_type);
+    compliance = ComplianceType_find(compliance_type);
     color      = Pixel_from_MagickPixel(&(ci->color));
 
     RB_GC_GUARD(name);
@@ -390,8 +390,8 @@ Import_TypeInfo(const TypeInfo *ti)
 
     name        = rb_str_new2(ti->name);
     family      = rb_str_new2(ti->family);
-    style       = StyleType_new(ti->style);
-    stretch     = StretchType_new(ti->stretch);
+    style       = StyleType_find(ti->style);
+    stretch     = StretchType_find(ti->stretch);
     weight      = ULONG2NUM(ti->weight);
     description = ti->description ? rb_str_new2(ti->description) : Qnil;
     encoding    = ti->encoding    ? rb_str_new2(ti->encoding) : Qnil;
@@ -451,8 +451,8 @@ Export_TypeInfo(TypeInfo *ti, VALUE st)
     {
         (void) CloneString((char **)&(ti->family), StringValuePtr(m));
     }
-    m = rb_ary_entry(members, 3); ti->style   = m == Qnil ? 0 : FIX2INT(m);
-    m = rb_ary_entry(members, 4); ti->stretch = m == Qnil ? 0 : FIX2INT(m);
+    m = rb_ary_entry(members, 3); ti->style   = m == Qnil ? 0 : FIX2INT(Enum_to_i(m));
+    m = rb_ary_entry(members, 4); ti->stretch = m == Qnil ? 0 : FIX2INT(Enum_to_i(m));
     m = rb_ary_entry(members, 5); ti->weight  = m == Qnil ? 0 : FIX2INT(m);
 
     m = rb_ary_entry(members, 6);

data/ext/RMagick/rmutil.c

@@ -359,10 +359,7 @@ rm_str2cstr(VALUE str, long *len)
 static VALUE
 arg_is_number(VALUE arg)
 {
-    double d;
-    d = NUM2DBL(arg);
-    d = d;      // satisfy icc
-    return arg;
+    return DBL2NUM(NUM2DBL(arg));
 }
 
 
@@ -472,9 +469,8 @@ check_num2dbl(VALUE obj)
  * @return 0
  */
 static VALUE
-rescue_not_dbl(VALUE ignored)
+rescue_not_dbl(VALUE ignored ATTRIBUTE_UNUSED)
 {
-    ignored = ignored;      // defeat gcc message
     return INT2FIX(0);
 }
 
@@ -1490,7 +1486,7 @@ rm_clone_image(Image *image)
  */
 MagickBooleanType
 rm_progress_monitor(
-    const char *tag,
+    const char *tag ATTRIBUTE_UNUSED,
     const MagickOffsetType of,
     const MagickSizeType sp,
     void *client_data)
@@ -1509,8 +1505,6 @@ rm_progress_monitor(
         return MagickTrue;
     }
 
-    tag = tag;      // defeat gcc message
-
 #if defined(HAVE_LONG_LONG)     // defined in Ruby's defines.h
     offset = rb_ll2inum(of);
     span = rb_ull2inum(sp);
@@ -1625,11 +1619,7 @@ format_exception(const ExceptionType severity, const char *reason, const char *d
     int len;
     memset(msg, 0, sizeof(ERROR_MSG_SIZE));
 
-#if defined(HAVE_SNPRINTF)
     len = snprintf(msg, ERROR_MSG_SIZE, "%s%s%s",
-#else
-    len = sprintf(msg, "%.500s%s%.500s",
-#endif
         GetLocaleExceptionMessage(severity, reason),
         description ? ": " : "",
         description ? GetLocaleExceptionMessage(severity, description) : "");

data/lib/obsolete.rb

@@ -0,0 +1,66 @@
+module Magick
+  AddCompositeOp = ModulusAddCompositeOp
+  deprecate_constant 'AddCompositeOp'
+
+  AlphaChannelType = AlphaChannelOption
+  deprecate_constant 'AlphaChannelType'
+
+  ColorSeparationMatteType = ColorSeparationAlphaType
+  deprecate_constant 'ColorSeparationMatteType'
+
+  CopyOpacityCompositeOp = CopyAlphaCompositeOp
+  deprecate_constant 'CopyOpacityCompositeOp'
+
+  DistortImageMethod = DistortMethod
+  deprecate_constant 'DistortImageMethod'
+
+  DivideCompositeOp = DivideDstCompositeOp
+  deprecate_constant 'DivideDstCompositeOp'
+
+  FilterTypes = FilterType
+  deprecate_constant 'FilterTypes'
+
+  GrayscaleMatteType = GrayscaleAlphaType
+  deprecate_constant 'GrayscaleMatteType'
+
+  ImageLayerMethod = LayerMethod
+  deprecate_constant 'ImageLayerMethod'
+
+  InterpolatePixelMethod = PixelInterpolateMethod
+  deprecate_constant 'InterpolatePixelMethod'
+
+  MeanErrorPerPixelMetric = MeanErrorPerPixelErrorMetric
+  deprecate_constant 'MeanErrorPerPixelMetric'
+
+  MinusCompositeOp = MinusDstCompositeOp
+  deprecate_constant 'MinusCompositeOp'
+
+  PaletteBilevelMatteType = PaletteBilevelAlphaType
+  deprecate_constant 'PaletteBilevelMatteType'
+
+  PaletteMatteType = PaletteAlphaType
+  deprecate_constant 'PaletteMatteType'
+
+  PeakSignalToNoiseRatioMetric = PeakSignalToNoiseRatioErrorMetric
+  deprecate_constant 'PeakSignalToNoiseRatioMetric'
+
+  SubtractCompositeOp = ModulusSubtractCompositeOp
+  deprecate_constant 'SubtractCompositeOp'
+
+  TrueColorMatteType = TrueColorAlphaType
+  deprecate_constant 'TrueColorMatteType'
+
+  UndefinedMetric = UndefinedErrorMetric
+  deprecate_constant 'UndefinedMetric'
+
+  deprecate_constant 'ConstantVirtualPixelMethod'
+  deprecate_constant 'FlattenAlphaChannel'
+  deprecate_constant 'IntegerPixel'
+  deprecate_constant 'MatteChannel'
+  deprecate_constant 'OpaqueOpacity'
+  deprecate_constant 'Rec601LumaColorspace'
+  deprecate_constant 'Rec709LumaColorspace'
+  deprecate_constant 'ResetAlphaChannel'
+  deprecate_constant 'StaticGravity'
+  deprecate_constant 'TransparentOpacity'
+end

data/lib/rmagick/version.rb

@@ -1,5 +1,5 @@
 module Magick
-  VERSION = '3.1.0'
+  VERSION = '3.2.0'
   MIN_RUBY_VERSION = '2.3.0'
   MIN_IM_VERSION = '6.7.7'
 end

data/lib/rmagick_internal.rb

@@ -20,6 +20,7 @@ end
 
 require 'English'
 require 'RMagick2.so'
+require 'obsolete.rb'
 
 module Magick
   @formats = nil
@@ -220,6 +221,13 @@ module Magick
       end
     end
 
+    def check_opacity(opacity)
+      return if opacity.is_a?(String) && opacity['%']
+
+      value = Float(opacity)
+      Kernel.raise ArgumentError, 'opacity must be >= 0 and <= 1.0' if value < 0 || value > 1.0
+    end
+
     public
 
     # Apply coordinate transformations to support scaling (s), rotation (r),
@@ -228,6 +236,13 @@ module Magick
       primitive 'affine ' + format('%g,%g,%g,%g,%g,%g', sx, rx, ry, sy, tx, ty)
     end
 
+    # Set alpha (make transparent) in image according to the specified
+    # colorization rule
+    def alpha(x, y, method)
+      Kernel.raise ArgumentError, 'Unknown paint method' unless PAINT_METHOD_NAMES.key?(method.to_i)
+      primitive 'matte ' + format('%g,%g, %s', x, y, PAINT_METHOD_NAMES[method.to_i])
+    end
+
     # Draw an arc.
     def arc(start_x, start_y, end_x, end_y, start_degrees, end_degrees)
       primitive 'arc ' + format('%g,%g %g,%g %g,%g',
@@ -241,7 +256,7 @@ module Magick
       elsif points.length.odd?
         Kernel.raise ArgumentError, 'odd number of arguments specified'
       end
-      primitive 'bezier ' + points.join(',')
+      primitive 'bezier ' + points.map! { |x| format('%g', x) }.join(',')
     end
 
     # Draw a circle
@@ -270,7 +285,7 @@ module Magick
     # point, replace, floodfill, filltoborder,reset
     def color(x, y, method)
       Kernel.raise ArgumentError, "Unknown PaintMethod: #{method}" unless PAINT_METHOD_NAMES.key?(method.to_i)
-      primitive "color #{x},#{y},#{PAINT_METHOD_NAMES[method.to_i]}"
+      primitive 'color ' + format('%g,%g,%s', x, y, PAINT_METHOD_NAMES[method.to_i])
     end
 
     # Specify EITHER the text decoration (none, underline, overline,
@@ -290,7 +305,7 @@ module Magick
     # (pop) graphic-context".
     def define_clip_path(name)
       push('defs')
-      push('clip-path', name)
+      push("clip-path \"#{name}\"")
       push('graphic-context')
       yield
     ensure
@@ -320,6 +335,7 @@ module Magick
 
     # Specify fill opacity (use "xx%" to indicate percentage)
     def fill_opacity(opacity)
+      check_opacity(opacity)
       primitive "fill-opacity #{opacity}"
     end
 
@@ -350,10 +366,10 @@ module Magick
     # The font weight argument can be either a font weight
     # constant or [100,200,...,900]
     def font_weight(weight)
-      if FONT_WEIGHT_NAMES.key?(weight.to_i)
+      if weight.is_a?(WeightType)
         primitive "font-weight #{FONT_WEIGHT_NAMES[weight.to_i]}"
       else
-        primitive "font-weight #{weight}"
+        primitive "font-weight #{Integer(weight)}"
       end
     end
 
@@ -364,6 +380,12 @@ module Magick
       primitive "gravity #{GRAVITY_NAMES[grav.to_i]}"
     end
 
+    def image(composite, x, y, width, height, image_file_path)
+      Kernel.raise ArgumentError, 'Unknown composite' unless composite.is_a?(CompositeOperator)
+      composite_name = composite.to_s.sub!('CompositeOp', '')
+      primitive 'image ' + format('%s %g,%g %g,%g %s', composite_name, x, y, width, height, enquote(image_file_path))
+    end
+
     # IM 6.5.5-8 and later
     def interline_spacing(space)
       begin
@@ -408,16 +430,15 @@ module Magick
     # Set matte (make transparent) in image according to the specified
     # colorization rule
     def matte(x, y, method)
+      Kernel.warn 'Draw#matte is deprecated. Use Draw#alpha instead.'
       Kernel.raise ArgumentError, 'Unknown paint method' unless PAINT_METHOD_NAMES.key?(method.to_i)
-      primitive "matte #{x},#{y} #{PAINT_METHOD_NAMES[method.to_i]}"
+      primitive 'matte ' + format('%g,%g, %s', x, y, PAINT_METHOD_NAMES[method.to_i])
     end
 
     # Specify drawing fill and stroke opacities. If the value is a string
     # ending with a %, the number will be multiplied by 0.01.
     def opacity(opacity)
-      if opacity.is_a?(Numeric)
-        Kernel.raise ArgumentError, 'opacity must be >= 0 and <= 1.0' if opacity < 0 || opacity > 1.0
-      end
+      check_opacity(opacity)
       primitive "opacity #{opacity}"
     end
 
@@ -433,7 +454,7 @@ module Magick
     # as the argument to the 'fill' or 'stroke' methods
     def pattern(name, x, y, width, height)
       push('defs')
-      push("pattern #{name} #{x} #{y} #{width} #{height}")
+      push("pattern #{name} " + format('%g %g %g %g', x, y, width, height))
       push('graphic-context')
       yield
     ensure
@@ -444,13 +465,13 @@ module Magick
 
     # Set point to fill color.
     def point(x, y)
-      primitive "point #{x},#{y}"
+      primitive 'point ' + format('%g,%g', x, y)
     end
 
     # Specify the font size in points. Yes, the primitive is "font-size" but
     # in other places this value is called the "pointsize". Give it both names.
     def pointsize(points)
-      primitive "font-size #{points}"
+      primitive 'font-size ' + format('%g', points)
     end
     alias font_size pointsize
 
@@ -461,7 +482,7 @@ module Magick
       elsif points.length.odd?
         Kernel.raise ArgumentError, 'odd number of points specified'
       end
-      primitive 'polygon ' + points.join(',')
+      primitive 'polygon ' + points.map! { |x| format('%g', x) }.join(',')
     end
 
     # Draw a polyline
@@ -471,7 +492,7 @@ module Magick
       elsif points.length.odd?
         Kernel.raise ArgumentError, 'odd number of points specified'
       end
-      primitive 'polyline ' + points.join(',')
+      primitive 'polyline ' + points.map! { |x| format('%g', x) }.join(',')
     end
 
     # Return to the previously-saved set of whatever
@@ -511,7 +532,7 @@ module Magick
 
     # Specify coordinate space rotation. "angle" is measured in degrees
     def rotate(angle)
-      primitive "rotate #{angle}"
+      primitive 'rotate ' + format('%g', angle)
     end
 
     # Draw a rectangle with rounded corners
@@ -522,15 +543,15 @@ module Magick
 
     # Specify scaling to be applied to coordinate space on subsequent drawing commands.
     def scale(x, y)
-      primitive "scale #{x},#{y}"
+      primitive 'scale ' + format('%g,%g', x, y)
     end
 
     def skewx(angle)
-      primitive "skewX #{angle}"
+      primitive 'skewX ' + format('%g', angle)
     end
 
     def skewy(angle)
-      primitive "skewY #{angle}"
+      primitive 'skewY ' + format('%g', angle)
     end
 
     # Specify the object stroke, a color name or pattern name.
@@ -560,7 +581,7 @@ module Magick
 
     # Specify the initial offset in the dash pattern
     def stroke_dashoffset(value = 0)
-      primitive "stroke-dashoffset #{value}"
+      primitive 'stroke-dashoffset ' + format('%g', value)
     end
 
     def stroke_linecap(value)
@@ -580,13 +601,14 @@ module Magick
 
     # Specify opacity of stroke drawing color
     #  (use "xx%" to indicate percentage)
-    def stroke_opacity(value)
-      primitive "stroke-opacity #{value}"
+    def stroke_opacity(opacity)
+      check_opacity(opacity)
+      primitive "stroke-opacity #{opacity}"
     end
 
     # Specify stroke (outline) width in pixels.
     def stroke_width(pixels)
-      primitive "stroke-width #{pixels}"
+      primitive 'stroke-width ' + format('%g', pixels)
     end
 
     # Draw text at position x,y. Add quotes to text that is not already quoted.
@@ -604,7 +626,7 @@ module Magick
         # escape existing braces, surround with braces
         text = '{' + text.gsub(/[}]/) { |b| '\\' + b } + '}'
       end
-      primitive "text #{x},#{y} #{text}"
+      primitive 'text ' + format('%g,%g %s', x, y, text)
     end
 
     # Specify text alignment relative to a given point
@@ -633,7 +655,7 @@ module Magick
     # Specify center of coordinate space to use for subsequent drawing
     # commands.
     def translate(x, y)
-      primitive "translate #{x},#{y}"
+      primitive 'translate ' + format('%g,%g', x, y)
     end
   end # class Magick::Draw
 
@@ -904,9 +926,9 @@ module Magick
     # Make the pixel at (x,y) transparent.
     def matte_point(x, y)
       f = copy
-      f.opacity = OpaqueOpacity unless f.matte
+      f.alpha(OpaqueAlphaChannel) unless f.alpha?
       pixel = f.pixel_color(x, y)
-      pixel.opacity = TransparentOpacity
+      pixel.alpha = TransparentAlpha
       f.pixel_color(x, y, pixel)
       f
     end
@@ -915,7 +937,7 @@ module Magick
     # pixel at (x, y).
     def matte_replace(x, y)
       f = copy
-      f.opacity = OpaqueOpacity unless f.matte
+      f.alpha(OpaqueAlphaChannel) unless f.alpha?
       target = f.pixel_color(x, y)
       f.transparent(target)
     end
@@ -924,23 +946,21 @@ module Magick
     # at (x,y) and is a neighbor.
     def matte_floodfill(x, y)
       f = copy
-      f.opacity = OpaqueOpacity unless f.matte
+      f.alpha(OpaqueAlphaChannel) unless f.alpha?
       target = f.pixel_color(x, y)
-      f.matte_flood_fill(target, TransparentOpacity,
-                         x, y, FloodfillMethod)
+      f.matte_flood_fill(target, x, y, FloodfillMethod, alpha: TransparentAlpha)
     end
 
     # Make transparent any neighbor pixel that is not the border color.
     def matte_fill_to_border(x, y)
       f = copy
-      f.opacity = Magick::OpaqueOpacity unless f.matte
-      f.matte_flood_fill(border_color, TransparentOpacity,
-                         x, y, FillToBorderMethod)
+      f.alpha(OpaqueAlphaChannel) unless f.alpha?
+      f.matte_flood_fill(border_color, x, y, FillToBorderMethod, alpha: TransparentAlpha)
     end
 
     # Make all pixels transparent.
     def matte_reset!
-      self.opacity = Magick::TransparentOpacity
+      alpha(TransparentAlphaChannel)
       self
     end
 
@@ -1376,13 +1396,6 @@ module Magick
     end
     alias size length
 
-    # Array#nitems is not available in 1.9
-    if Array.instance_methods.include?('nitems')
-      def nitems
-        @images.nitems
-      end
-    end
-
     def clear
       @scene = nil
       @images.clear