rmagick 4.0.0 → 5.3.0

data/ext/RMagick/rmmontage.c

@@ -12,8 +12,15 @@
 
 #include "rmagick.h"
 
+static void Montage_destroy(void *obj);
+static size_t Montage_memsize(const void *obj);
 
-
+const rb_data_type_t rm_montage_data_type = {
+    "Magick::ImageList::Montage",
+    { NULL, Montage_destroy, Montage_memsize, },
+    0, 0,
+    RUBY_TYPED_FROZEN_SHAREABLE,
+};
 
 
 /**
@@ -22,13 +29,13 @@
  * No Ruby usage (internal function)
  *
  * Notes:
- *   - If the Magick::Montage#texture method wrote a texture file, the file is
+ *   - If the Magick::ImageList::Montage#texture method wrote a texture file, the file is
  *     deleted here.
  *
  * @param obj the montage object
  */
 static void
-destroy_Montage(void *obj)
+Montage_destroy(void *obj)
 {
     Montage *montage = obj;
 
@@ -41,21 +48,31 @@ destroy_Montage(void *obj)
     }
     if (montage->info)
     {
-        (void) DestroyMontageInfo(montage->info);
+        DestroyMontageInfo(montage->info);
         montage->info = NULL;
     }
     xfree(montage);
 }
 
 
+/**
+  * Get Montage object size.
+  *
+  * No Ruby usage (internal function)
+  *
+  * @param ptr pointer to the Montage object
+  */
+static size_t
+Montage_memsize(const void *ptr)
+{
+    return sizeof(Montage);
+}
+
+
 /**
  * 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)
@@ -73,17 +90,17 @@ Montage_alloc(VALUE class)
     }
 
     montage_info = CloneMontageInfo(image_info, NULL);
-    (void) (void) DestroyImageInfo(image_info);
+    (void) DestroyImageInfo(image_info);
 
     if (!montage_info)
     {
-        rb_raise(rb_eNoMemError, "not enough memory to initialize Magick::Montage object");
+        rb_raise(rb_eNoMemError, "not enough memory to initialize Magick::ImageList::Montage object");
     }
 
     montage = ALLOC(Montage);
     montage->info = montage_info;
     montage->compose = OverCompositeOp;
-    montage_obj = Data_Wrap_Struct(class, NULL, destroy_Montage, montage);
+    montage_obj = TypedData_Wrap_Struct(class, &rm_montage_data_type, montage);
 
     RB_GC_GUARD(montage_obj);
 
@@ -94,19 +111,15 @@ 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 color
+ * @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)
 {
     Montage *montage;
 
-    Data_Get_Struct(self, Montage, montage);
+    TypedData_Get_Struct(self, Montage, &rm_montage_data_type, montage);
     Color_to_PixelColor(&montage->info->background_color, color);
     return color;
 }
@@ -115,19 +128,15 @@ Montage_background_color_eq(VALUE self, VALUE 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 color
+ * @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)
 {
     Montage *montage;
 
-    Data_Get_Struct(self, Montage, montage);
+    TypedData_Get_Struct(self, Montage, &rm_montage_data_type, montage);
     Color_to_PixelColor(&montage->info->border_color, color);
     return color;
 }
@@ -136,19 +145,15 @@ Montage_border_color_eq(VALUE self, VALUE color)
 /**
  * Set border_width value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#border_width(width) @endverbatim
- *
- * @param self this object
- * @param width the width
- * @return width
+ * @param width [Numeric] the width
+ * @return [Numeric] the given width
  */
 VALUE
 Montage_border_width_eq(VALUE self, VALUE width)
 {
     Montage *montage;
 
-    Data_Get_Struct(self, Montage, montage);
+    TypedData_Get_Struct(self, Montage, &rm_montage_data_type, montage);
     montage->info->border_width = NUM2ULONG(width);
     return width;
 }
@@ -157,19 +162,15 @@ Montage_border_width_eq(VALUE self, VALUE width)
 /**
  * Set a composition operator.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#compose(width) @endverbatim
- *
- * @param self this object
- * @param compose the composition operator
- * @return compose
+ * @param compose [Magick::CompositeOperator] the composition operator
+ * @return [Magick::CompositeOperator] the given compose operator
  */
 VALUE
 Montage_compose_eq(VALUE self, VALUE compose)
 {
     Montage *montage;
 
-    Data_Get_Struct(self, Montage, montage);
+    TypedData_Get_Struct(self, Montage, &rm_montage_data_type, montage);
     VALUE_TO_ENUM(compose, montage->compose, CompositeOperator);
     return compose;
 }
@@ -178,20 +179,16 @@ Montage_compose_eq(VALUE self, VALUE compose)
 /**
  * Set filename value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#filename(name) @endverbatim
- *
- * @param self this object
- * @param filename the filename
- * @return filename
+ * @param filename [String] the filename
+ * @return [String] filename
  */
 VALUE
 Montage_filename_eq(VALUE self, VALUE filename)
 {
     Montage *montage;
 
-    Data_Get_Struct(self, Montage, montage);
-    strncpy(montage->info->filename, StringValuePtr(filename), MaxTextExtent-1);
+    TypedData_Get_Struct(self, Montage, &rm_montage_data_type, montage);
+    strlcpy(montage->info->filename, StringValueCStr(filename), sizeof(montage->info->filename));
     return filename;
 }
 
@@ -199,19 +196,15 @@ Montage_filename_eq(VALUE self, VALUE filename)
 /**
  * Set fill value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#fill(color-name) @endverbatim
- *
- * @param self this object
- * @param color the color name
- * @return color
+ * @param color [Magick::Pixel, String] the color name
+ * @return [Magick::Pixel, String] the given color name
  */
 VALUE
 Montage_fill_eq(VALUE self, VALUE color)
 {
     Montage *montage;
 
-    Data_Get_Struct(self, Montage, montage);
+    TypedData_Get_Struct(self, Montage, &rm_montage_data_type, montage);
     Color_to_PixelColor(&montage->info->fill, color);
     return color;
 }
@@ -220,20 +213,16 @@ Montage_fill_eq(VALUE self, VALUE color)
 /**
  * Set font value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#font(font-name) @endverbatim
- *
- * @param self this object
- * @param font the font name
- * @return font
+ * @param font [String] the font name
+ * @return [String] the given font name
  */
 VALUE
 Montage_font_eq(VALUE self, VALUE font)
 {
     Montage *montage;
 
-    Data_Get_Struct(self, Montage, montage);
-    magick_clone_string(&montage->info->font, StringValuePtr(font));
+    TypedData_Get_Struct(self, Montage, &rm_montage_data_type, montage);
+    magick_clone_string(&montage->info->font, StringValueCStr(font));
 
     return font;
 }
@@ -242,17 +231,12 @@ Montage_font_eq(VALUE self, VALUE 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 frame_arg
+ * @param frame_arg [String] the frame geometry
+ * @see https://www.imagemagick.org/Magick++/Geometry.html
  */
 VALUE
 Montage_frame_eq(VALUE self, VALUE frame_arg)
@@ -260,9 +244,9 @@ Montage_frame_eq(VALUE self, VALUE frame_arg)
     Montage *montage;
     VALUE frame;
 
-    Data_Get_Struct(self, Montage, montage);
-    frame = rm_to_s(frame_arg);
-    magick_clone_string(&montage->info->frame, StringValuePtr(frame));
+    TypedData_Get_Struct(self, Montage, &rm_montage_data_type, montage);
+    frame = rb_String(frame_arg);
+    magick_clone_string(&montage->info->frame, StringValueCStr(frame));
 
     RB_GC_GUARD(frame);
 
@@ -273,12 +257,13 @@ Montage_frame_eq(VALUE self, VALUE 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 geometry_arg
+ * @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)
@@ -286,9 +271,9 @@ Montage_geometry_eq(VALUE self, VALUE geometry_arg)
     Montage *montage;
     VALUE geometry;
 
-    Data_Get_Struct(self, Montage, montage);
-    geometry = rm_to_s(geometry_arg);
-    magick_clone_string(&montage->info->geometry, StringValuePtr(geometry));
+    TypedData_Get_Struct(self, Montage, &rm_montage_data_type, montage);
+    geometry = rb_String(geometry_arg);
+    magick_clone_string(&montage->info->geometry, StringValueCStr(geometry));
 
     RB_GC_GUARD(geometry);
 
@@ -299,19 +284,15 @@ Montage_geometry_eq(VALUE self, VALUE geometry_arg)
 /**
  * Set gravity value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#gravity(gravity-type) @endverbatim
- *
- * @param self this object
- * @param gravity the gravity type
- * @return gravity
+ * @param gravity [Magick::GravityType] the gravity type
+ * @return [Magick::GravityType] the given gravity
  */
 VALUE
 Montage_gravity_eq(VALUE self, VALUE gravity)
 {
     Montage *montage;
 
-    Data_Get_Struct(self, Montage, montage);
+    TypedData_Get_Struct(self, Montage, &rm_montage_data_type, montage);
     VALUE_TO_ENUM(gravity, montage->info->gravity, GravityType);
     return gravity;
 }
@@ -320,11 +301,7 @@ Montage_gravity_eq(VALUE self, VALUE 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)
@@ -337,19 +314,15 @@ 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 color
+ * @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)
 {
     Montage *montage;
 
-    Data_Get_Struct(self, Montage, montage);
+    TypedData_Get_Struct(self, Montage, &rm_montage_data_type, montage);
     Color_to_PixelColor(&montage->info->matte_color, color);
     return color;
 }
@@ -358,19 +331,15 @@ Montage_matte_color_eq(VALUE self, VALUE color)
 /**
  * Set pointsize value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#pointsize= @endverbatim
- *
- * @param self this object
- * @param size the point size
- * @return size
+ * @param size [Numeric] the point size
+ * @return [Numeric] the given point size
  */
 VALUE
 Montage_pointsize_eq(VALUE self, VALUE size)
 {
     Montage *montage;
 
-    Data_Get_Struct(self, Montage, montage);
+    TypedData_Get_Struct(self, Montage, &rm_montage_data_type, montage);
     montage->info->pointsize = NUM2DBL(size);
     return size;
 }
@@ -379,19 +348,15 @@ Montage_pointsize_eq(VALUE self, VALUE size)
 /**
  * Set shadow value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#shadow= @endverbatim
- *
- * @param self this object
- * @param shadow the shadow
- * @return shadow
+ * @param shadow [Bool] true if the shadow will be enabled
+ * @return [Bool] the given value
  */
 VALUE
 Montage_shadow_eq(VALUE self, VALUE shadow)
 {
     Montage *montage;
 
-    Data_Get_Struct(self, Montage, montage);
+    TypedData_Get_Struct(self, Montage, &rm_montage_data_type, montage);
     montage->info->shadow = (MagickBooleanType) RTEST(shadow);
     return shadow;
 }
@@ -400,19 +365,15 @@ Montage_shadow_eq(VALUE self, VALUE 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)
 {
     Montage *montage;
 
-    Data_Get_Struct(self, Montage, montage);
+    TypedData_Get_Struct(self, Montage, &rm_montage_data_type, montage);
     Color_to_PixelColor(&montage->info->stroke, color);
     return color;
 }
@@ -421,12 +382,9 @@ Montage_stroke_eq(VALUE self, VALUE color)
 /**
  * Set texture value.
  *
- * Ruby usage:
- *   - @verbatim Montage#texture(texture-image) @endverbatim
- *
- * @param self this object
- * @param texture the texture image
- * @return texture
+ * @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)
@@ -435,7 +393,7 @@ Montage_texture_eq(VALUE self, VALUE texture)
     Image *texture_image;
     char temp_name[MaxTextExtent];
 
-    Data_Get_Struct(self, Montage, montage);
+    TypedData_Get_Struct(self, Montage, &rm_montage_data_type, montage);
 
     // If we had a previously defined temp texture image,
     // remove it now in preparation for this new one.
@@ -450,7 +408,7 @@ 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 texture;
@@ -460,12 +418,13 @@ Montage_texture_eq(VALUE self, VALUE 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 tile_arg
+ * @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)
@@ -473,9 +432,9 @@ Montage_tile_eq(VALUE self, VALUE tile_arg)
     Montage *montage;
     VALUE tile;
 
-    Data_Get_Struct(self, Montage, montage);
-    tile = rm_to_s(tile_arg);
-    magick_clone_string(&montage->info->tile, StringValuePtr(tile));
+    TypedData_Get_Struct(self, Montage, &rm_montage_data_type, montage);
+    tile = rb_String(tile_arg);
+    magick_clone_string(&montage->info->tile, StringValueCStr(tile));
 
     RB_GC_GUARD(tile);
 
@@ -486,30 +445,26 @@ Montage_tile_eq(VALUE self, VALUE tile_arg)
 /**
  * Set title value.
  *
- * Ruby usage:
- *   - @verbatim Magick::Montage#title(title) @endverbatim
- *
- * @param self this object
- * @param title the title
- * @return title
+ * @param title [String] the title
+ * @return [String] the given title
  */
 VALUE
 Montage_title_eq(VALUE self, VALUE title)
 {
     Montage *montage;
 
-    Data_Get_Struct(self, Montage, montage);
-    magick_clone_string(&montage->info->title, StringValuePtr(title));
+    TypedData_Get_Struct(self, Montage, &rm_montage_data_type, montage);
+    magick_clone_string(&montage->info->title, StringValueCStr(title));
     return title;
 }
 
 
 /**
- * Return a new Magick::Montage object.
+ * Return a new Magick::ImageList::Montage object.
  *
  * No Ruby usage (internal function)
  *
- * @return a new Magick::Montage object
+ * @return a new Magick::ImageList::Montage object
  */
 VALUE
 rm_montage_new(void)