rmagick 2.13.2 → 4.2.2

data/ext/RMagick/rmmontage.c

@@ -41,7 +41,7 @@ destroy_Montage(void *obj)
     }
     if (montage->info)
     {
-        (void) DestroyMontageInfo(montage->info);
+        DestroyMontageInfo(montage->info);
         montage->info = NULL;
     }
     xfree(montage);
@@ -51,11 +51,7 @@ destroy_Montage(void *obj)
 /**
  * Create a new Montage object.
  *
- * Ruby usage:
- *   - @verbatim Montage.new @endverbatim
- *
- * @param class the Ruby class to use
- * @return a new Montage object
+ * @return [Magick::ImageList::Montage] a new Montage object
  */
 VALUE
 Montage_alloc(VALUE class)
@@ -63,7 +59,7 @@ Montage_alloc(VALUE class)
     MontageInfo *montage_info;
     Montage *montage;
     Info *image_info;
-    volatile VALUE montage_obj;
+    VALUE montage_obj;
 
     // DO NOT call rm_info_new - we don't want to support an Info parm block.
     image_info = CloneImageInfo(NULL);
@@ -73,7 +69,7 @@ Montage_alloc(VALUE class)
     }
 
     montage_info = CloneMontageInfo(image_info, NULL);
-    (void) (void) DestroyImageInfo(image_info);
+    (void) DestroyImageInfo(image_info);
 
     if (!montage_info)
     {
@@ -85,6 +81,8 @@ Montage_alloc(VALUE class)
     montage->compose = OverCompositeOp;
     montage_obj = Data_Wrap_Struct(class, NULL, destroy_Montage, montage);
 
+    RB_GC_GUARD(montage_obj);
+
     return montage_obj;
 }
 
@@ -92,12 +90,8 @@ Montage_alloc(VALUE class)
 /**
  * Set background_color value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#background_color(color-name) @endverbatim
- *
- * @param self this object
- * @param color the color name
- * @return self
+ * @param color [Magick::Pixel, String] the color name
+ * @return [Magick::Pixel, String] the given color name
  */
 VALUE
 Montage_background_color_eq(VALUE self, VALUE color)
@@ -105,20 +99,16 @@ Montage_background_color_eq(VALUE self, VALUE color)
     Montage *montage;
 
     Data_Get_Struct(self, Montage, montage);
-    Color_to_PixelPacket(&montage->info->background_color, color);
-    return self;
+    Color_to_PixelColor(&montage->info->background_color, color);
+    return color;
 }
 
 
 /**
  * Set border_color value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#border_color(color-name) @endverbatim
- *
- * @param self this object
- * @param color the color name
- * @return self
+ * @param color [Magick::Pixel, String] the color name
+ * @return [Magick::Pixel, String] the given color name
  */
 VALUE
 Montage_border_color_eq(VALUE self, VALUE color)
@@ -126,20 +116,16 @@ Montage_border_color_eq(VALUE self, VALUE color)
     Montage *montage;
 
     Data_Get_Struct(self, Montage, montage);
-    Color_to_PixelPacket(&montage->info->border_color, color);
-    return self;
+    Color_to_PixelColor(&montage->info->border_color, color);
+    return color;
 }
 
 
 /**
  * Set border_width value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#border_width(width) @endverbatim
- *
- * @param self this object
- * @param width the width
- * @return self
+ * @param width [Numeric] the width
+ * @return [Numeric] the given width
  */
 VALUE
 Montage_border_width_eq(VALUE self, VALUE width)
@@ -148,19 +134,15 @@ Montage_border_width_eq(VALUE self, VALUE width)
 
     Data_Get_Struct(self, Montage, montage);
     montage->info->border_width = NUM2ULONG(width);
-    return self;
+    return width;
 }
 
 
 /**
  * Set a composition operator.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#compose(width) @endverbatim
- *
- * @param self this object
- * @param compose the composition operator
- * @return self
+ * @param compose [Magick::CompositeOperator] the composition operator
+ * @return [Magick::CompositeOperator] the given compose operator
  */
 VALUE
 Montage_compose_eq(VALUE self, VALUE compose)
@@ -169,19 +151,15 @@ Montage_compose_eq(VALUE self, VALUE compose)
 
     Data_Get_Struct(self, Montage, montage);
     VALUE_TO_ENUM(compose, montage->compose, CompositeOperator);
-    return self;
+    return compose;
 }
 
 
 /**
  * Set filename value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#filename(name) @endverbatim
- *
- * @param self this object
- * @param filename the filename
- * @return self
+ * @param filename [String] the filename
+ * @return [String] filename
  */
 VALUE
 Montage_filename_eq(VALUE self, VALUE filename)
@@ -189,20 +167,16 @@ Montage_filename_eq(VALUE self, VALUE filename)
     Montage *montage;
 
     Data_Get_Struct(self, Montage, montage);
-    strncpy(montage->info->filename, StringValuePtr(filename), MaxTextExtent-1);
-    return self;
+    strlcpy(montage->info->filename, StringValueCStr(filename), sizeof(montage->info->filename));
+    return filename;
 }
 
 
 /**
  * Set fill value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#fill(color-name) @endverbatim
- *
- * @param self this object
- * @param color the color name
- * @return self
+ * @param color [Magick::Pixel, String] the color name
+ * @return [Magick::Pixel, String] the given color name
  */
 VALUE
 Montage_fill_eq(VALUE self, VALUE color)
@@ -210,20 +184,16 @@ Montage_fill_eq(VALUE self, VALUE color)
     Montage *montage;
 
     Data_Get_Struct(self, Montage, montage);
-    Color_to_PixelPacket(&montage->info->fill, color);
-    return self;
+    Color_to_PixelColor(&montage->info->fill, color);
+    return color;
 }
 
 
 /**
  * Set font value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#font(font-name) @endverbatim
- *
- * @param self this object
- * @param font the font name
- * @return self
+ * @param font [String] the font name
+ * @return [String] the given font name
  */
 VALUE
 Montage_font_eq(VALUE self, VALUE font)
@@ -231,74 +201,70 @@ Montage_font_eq(VALUE self, VALUE font)
     Montage *montage;
 
     Data_Get_Struct(self, Montage, montage);
-    magick_clone_string(&montage->info->font, StringValuePtr(font));
+    magick_clone_string(&montage->info->font, StringValueCStr(font));
 
-    return self;
+    return font;
 }
 
 
 /**
  * Set frame value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#frame(frame-geometry) @endverbatim
- *
- * Notes:
- *   - The geometry is a string in the form:
- *     @verbatim <width>x<height>+<outer-bevel-width>+<inner-bevel-width> @endverbatim
- *     or a Geometry object
+ * - The geometry is a string in the form:
+ *      <width>x<height>+<outer-bevel-width>+<inner-bevel-width>
+ *   or a Geometry object
  *
- * @param self this object
- * @param frame_arg the frame geometry
- * @return self
+ * @param frame_arg [String] the frame geometry
+ * @see https://www.imagemagick.org/Magick++/Geometry.html
  */
 VALUE
 Montage_frame_eq(VALUE self, VALUE frame_arg)
 {
     Montage *montage;
-    volatile VALUE frame;
+    VALUE frame;
 
     Data_Get_Struct(self, Montage, montage);
-    frame = rm_to_s(frame_arg);
-    magick_clone_string(&montage->info->frame, StringValuePtr(frame));
+    frame = rb_String(frame_arg);
+    magick_clone_string(&montage->info->frame, StringValueCStr(frame));
 
-    return self;
+    RB_GC_GUARD(frame);
+
+    return frame_arg;
 }
 
 
 /**
  * Set geometry value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#geometry(geometry) @endverbatim
+ * - The geometry is a string in the form:
+ *      <width>x<height>+<outer-bevel-width>+<inner-bevel-width>
+ *   or a Geometry object
  *
- * @param self this object
- * @param geometry_arg the geometry
- * @return self
+ * @param geometry_arg [String] the geometry
+ * @return [String] the given geometry
+ * @see https://www.imagemagick.org/Magick++/Geometry.html
  */
 VALUE
 Montage_geometry_eq(VALUE self, VALUE geometry_arg)
 {
     Montage *montage;
-    volatile VALUE geometry;
+    VALUE geometry;
 
     Data_Get_Struct(self, Montage, montage);
-    geometry = rm_to_s(geometry_arg);
-    magick_clone_string(&montage->info->geometry, StringValuePtr(geometry));
+    geometry = rb_String(geometry_arg);
+    magick_clone_string(&montage->info->geometry, StringValueCStr(geometry));
 
-    return self;
+    RB_GC_GUARD(geometry);
+
+    return geometry_arg;
 }
 
 
 /**
  * Set gravity value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#gravity(gravity-type) @endverbatim
- *
- * @param self this object
- * @param gravity the gravity type
- * @return self
+ * @param gravity [Magick::GravityType] the gravity type
+ * @return [Magick::GravityType] the given gravity
  */
 VALUE
 Montage_gravity_eq(VALUE self, VALUE gravity)
@@ -307,18 +273,14 @@ Montage_gravity_eq(VALUE self, VALUE gravity)
 
     Data_Get_Struct(self, Montage, montage);
     VALUE_TO_ENUM(gravity, montage->info->gravity, GravityType);
-    return self;
+    return gravity;
 }
 
 
 /**
  * Initialize a Montage object. Does nothing currently.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#initialize @endverbatim
- *
- * @param self this object
- * @return self
+ * @return [Magick::ImageList::Montage] self
  */
 VALUE
 Montage_initialize(VALUE self)
@@ -331,12 +293,8 @@ Montage_initialize(VALUE self)
 /**
  * Set matte_color value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#matte_color(color-name) @endverbatim
- *
- * @param self this object
- * @param color the color name
- * @return self
+ * @param color [Magick::Pixel, String] the color name
+ * @return [Magick::Pixel, String] the given color name
  */
 VALUE
 Montage_matte_color_eq(VALUE self, VALUE color)
@@ -344,20 +302,16 @@ Montage_matte_color_eq(VALUE self, VALUE color)
     Montage *montage;
 
     Data_Get_Struct(self, Montage, montage);
-    Color_to_PixelPacket(&montage->info->matte_color, color);
-    return self;
+    Color_to_PixelColor(&montage->info->matte_color, color);
+    return color;
 }
 
 
 /**
  * Set pointsize value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#pointsize= @endverbatim
- *
- * @param self this object
- * @param size the point size
- * @return self
+ * @param size [Numeric] the point size
+ * @return [Numeric] the given point size
  */
 VALUE
 Montage_pointsize_eq(VALUE self, VALUE size)
@@ -366,19 +320,15 @@ Montage_pointsize_eq(VALUE self, VALUE size)
 
     Data_Get_Struct(self, Montage, montage);
     montage->info->pointsize = NUM2DBL(size);
-    return self;
+    return size;
 }
 
 
 /**
  * Set shadow value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#shadow= @endverbatim
- *
- * @param self this object
- * @param shadow the shadow
- * @return self
+ * @param shadow [Bool] true if the shadow will be enabled
+ * @return [Bool] the given value
  */
 VALUE
 Montage_shadow_eq(VALUE self, VALUE shadow)
@@ -387,19 +337,15 @@ Montage_shadow_eq(VALUE self, VALUE shadow)
 
     Data_Get_Struct(self, Montage, montage);
     montage->info->shadow = (MagickBooleanType) RTEST(shadow);
-    return self;
+    return shadow;
 }
 
 
 /**
  * Set stroke value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#stroke(color-name) @endverbatim
- *
- * @param self this object
- * @param color the color name
- * @return self
+ * @param color [Magick::Pixel, String] the color name
+ * @return [Magick::Pixel, String] the given color name
  */
 VALUE
 Montage_stroke_eq(VALUE self, VALUE color)
@@ -407,20 +353,17 @@ Montage_stroke_eq(VALUE self, VALUE color)
     Montage *montage;
 
     Data_Get_Struct(self, Montage, montage);
-    Color_to_PixelPacket(&montage->info->stroke, color);
-    return self;
+    Color_to_PixelColor(&montage->info->stroke, color);
+    return color;
 }
 
 
 /**
  * Set texture value.
  *
- * Ruby usage:
- *   - @verbatim Montage#texture(texture-image) @endverbatim
- *
- * @param self this object
- * @param texture the texture image
- * @return self
+ * @param texture [Magick::Image, Magick::ImageList] Either an imagelist or an image. If an
+ *   imagelist, uses the current image.
+ * @return [Magick::Image] the given texture image
  */
 VALUE
 Montage_texture_eq(VALUE self, VALUE texture)
@@ -444,46 +387,45 @@ Montage_texture_eq(VALUE self, VALUE texture)
     texture_image = rm_check_destroyed(texture);
 
     // Write a temp copy of the image & save its name.
-    rm_write_temp_image(texture_image, temp_name);
+    rm_write_temp_image(texture_image, temp_name, sizeof(temp_name));
     magick_clone_string(&montage->info->texture, temp_name);
 
-    return self;
+    return texture;
 }
 
 
 /**
  * Set tile value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#tile(tile) @endverbatim
+ * - The geometry is a string in the form:
+ *      <width>x<height>+<outer-bevel-width>+<inner-bevel-width>
+ *   or a Geometry object
  *
- * @param self this object
- * @param tile_arg the tile
- * @return self
+ * @param tile_arg [String] the tile geometry
+ * @return [String] the given tile geometry
+ * @see https://www.imagemagick.org/Magick++/Geometry.html
  */
 VALUE
 Montage_tile_eq(VALUE self, VALUE tile_arg)
 {
     Montage *montage;
-    volatile VALUE tile;
+    VALUE tile;
 
     Data_Get_Struct(self, Montage, montage);
-    tile = rm_to_s(tile_arg);
-    magick_clone_string(&montage->info->tile, StringValuePtr(tile));
+    tile = rb_String(tile_arg);
+    magick_clone_string(&montage->info->tile, StringValueCStr(tile));
 
-    return self;
+    RB_GC_GUARD(tile);
+
+    return tile_arg;
 }
 
 
 /**
  * Set title value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#title(title) @endverbatim
- *
- * @param self this object
- * @param title the title
- * @return self
+ * @param title [String] the title
+ * @return [String] the given title
  */
 VALUE
 Montage_title_eq(VALUE self, VALUE title)
@@ -491,8 +433,8 @@ Montage_title_eq(VALUE self, VALUE title)
     Montage *montage;
 
     Data_Get_Struct(self, Montage, montage);
-    magick_clone_string(&montage->info->title, StringValuePtr(title));
-    return self;
+    magick_clone_string(&montage->info->title, StringValueCStr(title));
+    return title;
 }