rmagick 2.13.2 → 4.2.2

data/ext/RMagick/rmagick.c

@@ -14,41 +14,53 @@
 
 
 
+static VALUE rm_yield_handle_exception(VALUE, VALUE) ATTRIBUTE_NORETURN;
+
+static VALUE
+rm_yield_body(VALUE object)
+{
+    return rb_yield(object);
+}
+
+static VALUE
+rm_yield_handle_exception(VALUE allocated_area, VALUE exc)
+{
+    magick_free((void *)allocated_area);
+    rb_exc_raise(exc);
+}
 
 /**
  * If called with the optional block, iterates over the colors, otherwise
- * returns an array of Magick::Color objects.
+ * returns an array of {Magick::Color} objects.
  *
- * Ruby usage:
- *   - @verbatim Magick::colors @endverbatim
- *   - @verbatim Magick::colors { |colorinfo| } @endverbatim
+ * @overload colors
+ *   @return [Array<Magick::Color>] the array of {Magick::Color}
  *
- * Notes:
- *   - There are 3 implementations.
+ * @overload colors
+ *   @yield [colorinfo]
+ *   @yieldparam colorinfo [Magick::Color] the color
  *
- * @param class the class on which the method is run.
- * @return either the input class (if a block was given) or the array of colors.
  */
 VALUE
 Magick_colors(VALUE class)
 {
     const ColorInfo **color_info_list;
-    unsigned long number_colors, x;
-    volatile VALUE ary;
-    ExceptionInfo exception;
+    size_t number_colors, x;
+    VALUE ary;
+    ExceptionInfo *exception;
 
-    GetExceptionInfo(&exception);
+    exception = AcquireExceptionInfo();
 
-    color_info_list = GetColorInfoList("*", &number_colors, &exception);
-    CHECK_EXCEPTION()
-    (void) DestroyExceptionInfo(&exception);
+    color_info_list = GetColorInfoList("*", &number_colors, exception);
+    CHECK_EXCEPTION();
+    DestroyExceptionInfo(exception);
 
 
     if (rb_block_given_p())
     {
         for (x = 0; x < number_colors; x++)
         {
-            (void) rb_yield(Import_ColorInfo(color_info_list[x]));
+            rb_rescue(rm_yield_body, Import_ColorInfo(color_info_list[x]), rm_yield_handle_exception, (VALUE)color_info_list);
         }
         magick_free((void *)color_info_list);
         return class;
@@ -58,10 +70,11 @@ Magick_colors(VALUE class)
         ary = rb_ary_new2((long) number_colors);
         for (x = 0; x < number_colors; x++)
         {
-            (void) rb_ary_push(ary, Import_ColorInfo(color_info_list[x]));
+            rb_ary_push(ary, Import_ColorInfo(color_info_list[x]));
         }
 
         magick_free((void *)color_info_list);
+        RB_GC_GUARD(ary);
         return ary;
     }
 }
@@ -69,33 +82,34 @@ Magick_colors(VALUE class)
 
 /**
  * If called with the optional block, iterates over the fonts, otherwise returns
- * an array of Magick::Font objects.
+ * an array of {Magick::Font} objects.
  *
- * Ruby usage:
- *   - @verbatim Magick::fonts @endverbatim
- *   - @verbatim Magick::fonts { |fontinfo| } @endverbatim
+ * @overload fonts
+ *   @return [Array<Magick::Font>] the array of {Magick::Font}
+ *
+ * @overload fonts
+ *   @yield [fontinfo]
+ *   @yieldparam fontinfo [Magick::Font] the font
  *
- * @param class the class on which the method is run.
- * @return either the input class (if a block was given) or the array of fonts.
  */
 VALUE
 Magick_fonts(VALUE class)
 {
     const TypeInfo **type_info;
-    unsigned long number_types, x;
-    volatile VALUE ary;
-    ExceptionInfo exception;
+    size_t number_types, x;
+    VALUE ary;
+    ExceptionInfo *exception;
 
-    GetExceptionInfo(&exception);
-    type_info = GetTypeInfoList("*", &number_types, &exception);
-    CHECK_EXCEPTION()
-    (void) DestroyExceptionInfo(&exception);
+    exception = AcquireExceptionInfo();
+    type_info = GetTypeInfoList("*", &number_types, exception);
+    CHECK_EXCEPTION();
+    DestroyExceptionInfo(exception);
 
     if (rb_block_given_p())
     {
         for (x = 0; x < number_types; x++)
         {
-            (void) rb_yield(Import_TypeInfo((const TypeInfo *)type_info[x]));
+            rb_rescue(rm_yield_body, Import_TypeInfo((const TypeInfo *)type_info[x]), rm_yield_handle_exception, (VALUE)type_info);
         }
         magick_free((void *)type_info);
         return class;
@@ -105,9 +119,10 @@ Magick_fonts(VALUE class)
         ary = rb_ary_new2((long)number_types);
         for (x = 0; x < number_types; x++)
         {
-            (void) rb_ary_push(ary, Import_TypeInfo((const TypeInfo *)type_info[x]));
+            rb_ary_push(ary, Import_TypeInfo((const TypeInfo *)type_info[x]));
         }
         magick_free((void *)type_info);
+        RB_GC_GUARD(ary);
         return ary;
     }
 
@@ -122,7 +137,7 @@ Magick_fonts(VALUE class)
  *   - "R" is "r" if ImageMagick can read that format, or "-" otherwise.
  *   - "W" is "w" if ImageMagick can write that format, or "-" otherwise.
  *   - "A" is "+" if the format supports multi-image files, or "-" otherwise.
- * 
+ *
  * No Ruby usage (internal function)
  *
  * @param magick_info a MagickInfo object.
@@ -133,10 +148,10 @@ MagickInfo_to_format(const MagickInfo *magick_info)
 {
     char mode[4];
 
-    mode[0] = magick_info->blob_support ? '*': ' ';
-    mode[1] = magick_info->decoder ? 'r' : '-';
-    mode[2] = magick_info->encoder ? 'w' : '-';
-    mode[3] = magick_info->encoder && magick_info->adjoin ? '+' : '-';
+    mode[0] = GetMagickBlobSupport(magick_info) ? '*': ' ';
+    mode[1] = GetImageDecoder(magick_info) ? 'r' : '-';
+    mode[2] = GetImageEncoder(magick_info) ? 'w' : '-';
+    mode[3] = GetMagickAdjoin(magick_info) ? '+' : '-';
 
     return rb_str_new(mode, sizeof(mode));
 }
@@ -146,46 +161,39 @@ MagickInfo_to_format(const MagickInfo *magick_info)
  * Build the @@formats hash. The hash keys are image formats. The hash values
  * specify the format "mode string", i.e. a description of what ImageMagick can
  * do with that format. The mode string is in the form "BRWA", where
- *   - "B" is "*" if the format has native blob support, or " " otherwise.
- *   - "R" is "r" if ImageMagick can read that format, or "-" otherwise.
- *   - "W" is "w" if ImageMagick can write that format, or "-" otherwise.
- *   - "A" is "+" if the format supports multi-image files, or "-" otherwise.
- * 
- * Ruby usage:
- *   - @verbatim Magick.init_formats @endverbatim
  *
- * Notes:
- *   - Only called once.
- *   - There are 3 implementations.
+ * - "B" is "*" if the format has native blob support, or " " otherwise.
+ * - "R" is "r" if ImageMagick can read that format, or "-" otherwise.
+ * - "W" is "w" if ImageMagick can write that format, or "-" otherwise.
+ * - "A" is "+" if the format supports multi-image files, or "-" otherwise.
  *
- * @param class the class on which the method is run.
- * @return the formats hash.
- * @see MagickInfo_to_format
+ * @return [Hash] the formats hash.
  */
 VALUE
-Magick_init_formats(VALUE class)
+Magick_init_formats(VALUE class ATTRIBUTE_UNUSED)
 {
     const MagickInfo **magick_info;
-    unsigned long number_formats, x;
-    volatile VALUE formats;
-    ExceptionInfo exception;
+    size_t number_formats, x;
+    VALUE formats;
+    ExceptionInfo *exception;
 
-    class = class;      // defeat "never referenced" message from icc
     formats = rb_hash_new();
 
     // IM 6.1.3 added an exception argument to GetMagickInfoList
-    GetExceptionInfo(&exception);
-    magick_info = GetMagickInfoList("*", &number_formats, &exception);
-    CHECK_EXCEPTION()
-    (void) DestroyExceptionInfo(&exception);
+    exception = AcquireExceptionInfo();
+    magick_info = GetMagickInfoList("*", &number_formats, exception);
+    CHECK_EXCEPTION();
+    DestroyExceptionInfo(exception);
 
 
     for (x = 0; x < number_formats; x++)
     {
-        (void) rb_hash_aset(formats
-                            , rb_str_new2(magick_info[x]->name)
-                            , MagickInfo_to_format((const MagickInfo *)magick_info[x]));
+        rb_hash_aset(formats,
+                     rb_str_new2(magick_info[x]->name),
+                     MagickInfo_to_format((const MagickInfo *)magick_info[x]));
     }
+    magick_free((void *)magick_info);
+    RB_GC_GUARD(formats);
     return formats;
 }
 
@@ -194,19 +202,21 @@ Magick_init_formats(VALUE class)
  * Get/set resource limits. If a limit is specified the old limit is set to the
  * new value. Either way the current/old limit is returned.
  *
- * Ruby usage:
- *   - @verbatim Magick.limit_resource(resource) @endverbatim
- *   - @verbatim Magick.limit_resource(resource, limit) @endverbatim
+ * @overload limit_resource(resource)
+ *   Get resource limits.
+ *   @param resource [String, Symbol] the type of resource
  *
- * @param argc number of input arguments.
- * @param argv array of input arguments.
- * @param class the class on which the method is run.
- * @return the current/old limit.
+ * @overload limit_resource(resource, limit)
+ *   Set resource limits.
+ *   @param resource [String, Symbol] the type of resource
+ *   @param limit [Numeric] the new limit number
+ * 
+ * @return [Numeric] the old limit.
  */
 VALUE
 Magick_limit_resource(int argc, VALUE *argv, VALUE class)
 {
-    volatile VALUE resource, limit;
+    VALUE resource, limit;
     ResourceType res = UndefinedResource;
     char *str;
     ID id;
@@ -241,6 +251,10 @@ Magick_limit_resource(int argc, VALUE *argv, VALUE class)
             {
                 res = FileResource;
             }
+            else if (id == rb_intern("time"))
+            {
+                res = TimeResource;
+            }
             else
             {
                 rb_raise(rb_eArgError, "unknown resource: `:%s'", rb_id2name(id));
@@ -248,7 +262,7 @@ Magick_limit_resource(int argc, VALUE *argv, VALUE class)
             break;
 
         default:
-            str = StringValuePtr(resource);
+            str = StringValueCStr(resource);
             if (*str == '\0')
             {
                 return class;
@@ -273,6 +287,10 @@ Magick_limit_resource(int argc, VALUE *argv, VALUE class)
             {
                 res = FileResource;
             }
+            else if (rm_strcasecmp("time", str) == 0)
+            {
+                res = TimeResource;
+            }
             else
             {
                 rb_raise(rb_eArgError, "unknown resource: `%s'", str);
@@ -280,13 +298,17 @@ Magick_limit_resource(int argc, VALUE *argv, VALUE class)
             break;
     }
 
+    RB_GC_GUARD(resource);
+
     cur_limit = GetMagickResourceLimit(res);
 
     if (argc > 1)
     {
-        (void) SetMagickResourceLimit(res, (MagickSizeType)NUM2ULONG(limit));
+        SetMagickResourceLimit(res, (MagickSizeType)NUM2ULONG(limit));
     }
 
+    RB_GC_GUARD(limit);
+
     return ULONG2NUM(cur_limit);
 }
 
@@ -296,22 +318,14 @@ Magick_limit_resource(int argc, VALUE *argv, VALUE class)
  * threshold is exceeded, all subsequent pixels cache operations are to/from
  * disk.
  *
- * Ruby usage:
- *   - @verbatim Magick.set_cache_threshold(megabytes) @endverbatim
- *
- * Notes:
- *   - singleton method
- *
- * @param class the class on which the method is run.
- * @param threshold the number of megabytes to set.
- * @return the class.
+ * @param threshold [Numeric] the number of megabytes to set.
  */
 VALUE
 Magick_set_cache_threshold(VALUE class, VALUE threshold)
 {
     unsigned long thrshld = NUM2ULONG(threshold);
-    (void) SetMagickResourceLimit(MemoryResource, (MagickSizeType)thrshld);
-    (void) SetMagickResourceLimit(MapResource, (MagickSizeType)(2*thrshld));
+    SetMagickResourceLimit(MemoryResource, (MagickSizeType)thrshld);
+    SetMagickResourceLimit(MapResource, (MagickSizeType)(2*thrshld));
     return class;
 }
 
@@ -319,32 +333,25 @@ Magick_set_cache_threshold(VALUE class, VALUE threshold)
 /**
  * Set the log event mask.
  *
- * Ruby usage:
- *   - @verbatim Magick.set_log_event_mask(event) @endverbatim
- *   - @verbatim Magick.set_log_event_mask(event,...) @endverbatim
+ * The arguments are one of:
  *
- * Notes:
- *   - "event" is one of
- *     - "all"
- *     - "annotate"
- *     - "blob"
- *     - "cache"
- *     - "coder"
- *     - "configure"
- *     - "deprecate"
- *     - "locale"
- *     - "none"
- *     - "render"
- *     - "transform"
- *     - "user"
- *     - "x11"
- *   - Multiple events can be specified.
- *   - Event names may be capitalized.
+ * - "all"
+ * - "annotate"
+ * - "blob"
+ * - "cache"
+ * - "coder"
+ * - "configure"
+ * - "deprecate"
+ * - "locale"
+ * - "none"
+ * - "render"
+ * - "transform"
+ * - "user"
+ * - "x11"
  *
- * @param argc number of input arguments.
- * @param argv array of input arguments.
- * @param class the class on which the method is run.
- * @return the class.
+ * Multiple events can be specified as the aruments. Event names may be capitalized.
+ *
+ * @param args [String] the mask of log event.
  */
 VALUE
 Magick_set_log_event_mask(int argc, VALUE *argv, VALUE class)
@@ -357,38 +364,33 @@ Magick_set_log_event_mask(int argc, VALUE *argv, VALUE class)
     }
     for (x = 0; x < argc; x++)
     {
-        (void) SetLogEventMask(StringValuePtr(argv[x]));
+        SetLogEventMask(StringValueCStr(argv[x]));
     }
     return class;
 }
 
 /**
  * Set the format for log messages.
- * 
- * Ruby usage:
- *   - @verbatim Magick.set_log_format(format) @endverbatim
  *
- * Notes:
- *   - Format is a string containing one or more of:
- *     - %t  - current time
- *     - %r  - elapsed time
- *     - %u  - user time
- *     - %p  - pid
- *     - %m  - module (source file name)
- *     - %f  - function name
- *     - %l  - line number
- *     - %d  - event domain (one of the events listed above)
- *     - %e  - event name
- *     - Plus other characters, including \\n, etc.
+ * Format is a string containing one or more of:
+ *
+ * - %t  - current time
+ * - %r  - elapsed time
+ * - %u  - user time
+ * - %p  - pid
+ * - %m  - module (source file name)
+ * - %f  - function name
+ * - %l  - line number
+ * - %d  - event domain (one of the events listed above)
+ * - %e  - event name
+ * - Plus other characters, including \\n, etc.
  *
- * @param class the class on which the method is run.
- * @param format the format to set.
- * @return the class.
+ * @param format [String] the format to set.
  */
 VALUE
 Magick_set_log_format(VALUE class, VALUE format)
 {
-    SetLogFormat(StringValuePtr(format));
+    SetLogFormat(StringValueCStr(format));
     return class;
 }