rmagick 4.0.0 → 5.3.0

data/ext/RMagick/rmenum.c

@@ -18,9 +18,15 @@
 
 static VALUE Enum_type_values(VALUE);
 static VALUE Enum_type_inspect(VALUE);
+static void rm_enum_free(void *magick_enum);
+static size_t rm_enum_memsize(const void *magick_enum);
 
-
-
+const rb_data_type_t rm_enum_data_type = {
+    "Magick::Enum",
+    { NULL, rm_enum_free, rm_enum_memsize, },
+    0, 0,
+    RUBY_TYPED_FROZEN_SHAREABLE,
+};
 
 
 /**
@@ -76,57 +82,69 @@ rm_enum_new(VALUE class, VALUE sym, VALUE val)
 static const char *
 rm_enum_to_cstr(VALUE enum_type)
 {
-   MagickEnum *magick_enum;
+    MagickEnum *magick_enum;
 
-   Data_Get_Struct(enum_type, MagickEnum, magick_enum);
-   return rb_id2name(magick_enum->id);
+    TypedData_Get_Struct(enum_type, MagickEnum, &rm_enum_data_type, magick_enum);
+    return rb_id2name(magick_enum->id);
 }
 
 /**
- * Enum class alloc function.
+ * Free Enum or Enum subclass object
  *
  * No Ruby usage (internal function)
  *
- * @param class the Ruby class to use
- * @return a new enumerator
+ * @param magick_enum the enum
+ */
+static void rm_enum_free(void *magick_enum)
+{
+    xfree(magick_enum);
+}
+
+/**
+  * Get Enum object size.
+  *
+  * No Ruby usage (internal function)
+  *
+  * @param magick_enum the enum
+  */
+ static size_t rm_enum_memsize(const void *magick_enum)
+ {
+     return sizeof(MagickEnum);
+ }
+
+/**
+ * Enum class alloc function.
+ *
+ * @return [Magick::Enum] a new enumerator
  */
 VALUE
 Enum_alloc(VALUE class)
 {
-   MagickEnum *magick_enum;
-   VALUE enumr;
-
-   enumr = Data_Make_Struct(class, MagickEnum, NULL, NULL, magick_enum);
-   rb_obj_freeze(enumr);
+    MagickEnum *magick_enum;
+    VALUE enumr;
 
-   RB_GC_GUARD(enumr);
+    enumr = TypedData_Make_Struct(class, MagickEnum, &rm_enum_data_type, magick_enum);
+    rb_obj_freeze(enumr);
 
-   return enumr;
+    return enumr;
 }
 
 
 /**
  * "Case equal" operator for Enum.
  *
- * Ruby usage:
- *   - @verbatim Enum#=== @endverbatim
- *
- * Notes:
- *   - Yes, I know "case equal" is a misnomer.
- *
- * @param self this object
- * @param other the other object
- * @return true or false
+ * @param other [Object] the other object
+ * @return [Boolean] true or false
  */
 VALUE
 Enum_case_eq(VALUE self, VALUE other)
 {
-    MagickEnum *this, *that;
-
     if (CLASS_OF(self) == CLASS_OF(other))
     {
-        Data_Get_Struct(self, MagickEnum, this);
-        Data_Get_Struct(other, MagickEnum, that);
+        MagickEnum *this, *that;
+
+        TypedData_Get_Struct(self, MagickEnum, &rm_enum_data_type, this);
+        TypedData_Get_Struct(other, MagickEnum, &rm_enum_data_type, that);
         return this->val == that->val ? Qtrue : Qfalse;
     }
 
@@ -137,58 +155,43 @@ Enum_case_eq(VALUE self, VALUE other)
 /**
  * Initialize a new Enum instance.
  *
- * Ruby usage:
- *   - @verbatim Enum#initialize(sym,val) @endverbatim
- *
- * @param self this object
- * @param sym the symbol
- * @param val the value for the symbol
- * @return self
+ * @param sym [Symbol] the symbol as enum name
+ * @param val [Numeric] the value for enum
+ * @return [Magick::Enum] self
  */
 VALUE
 Enum_initialize(VALUE self, VALUE sym, VALUE val)
 {
-   MagickEnum *magick_enum;
+    MagickEnum *magick_enum;
 
-   Data_Get_Struct(self, MagickEnum, magick_enum);
-   magick_enum->id = rb_to_id(sym); /* convert symbol to ID */
-   magick_enum->val = NUM2INT(val);
+    TypedData_Get_Struct(self, MagickEnum, &rm_enum_data_type, magick_enum);
+    magick_enum->id = rb_to_id(sym); /* convert symbol to ID */
+    magick_enum->val = NUM2INT(val);
 
-   return self;
+    return self;
 }
 
 
 /**
  * Return the value of an enum.
  *
- * Ruby usage:
- *   - @verbatim Enum#to_i @endverbatim
- *
- * @param self this object
- * @return this object's value
+ * @return [Numeric] this object's value
  */
 VALUE
 Enum_to_i(VALUE self)
 {
-   MagickEnum *magick_enum;
+    MagickEnum *magick_enum;
 
-   Data_Get_Struct(self, MagickEnum, magick_enum);
-   return INT2NUM(magick_enum->val);
+    TypedData_Get_Struct(self, MagickEnum, &rm_enum_data_type, magick_enum);
+    return INT2NUM(magick_enum->val);
 }
 
 
 /**
  * Support Comparable module in Enum.
  *
- * Ruby usage:
- *   - @verbatim Enum#<=> @endverbatim
- *
- * Notes:
- *   - Enums must be instances of the same class to be equal.
- *
- * @param self this object
- * @param other the other object
- * @return -1, 0, 1, or nil
+ * @param other [Object] the other object
+ * @return [-1, 0, 1, nil] the result of compare
  */
 VALUE
 Enum_spaceship(VALUE self, VALUE other)
@@ -199,8 +202,8 @@ Enum_spaceship(VALUE self, VALUE other)
         return Qnil;
     }
 
-    Data_Get_Struct(self, MagickEnum, this);
-    Data_Get_Struct(other, MagickEnum, that);
+    TypedData_Get_Struct(self, MagickEnum, &rm_enum_data_type, this);
+    TypedData_Get_Struct(other, MagickEnum, &rm_enum_data_type, that);
 
     if (this->val > that->val)
     {
@@ -216,67 +219,52 @@ Enum_spaceship(VALUE self, VALUE other)
 
 /**
  * Bitwise OR for enums
- * 
- * Ruby usage:
- *   - @verbatim Enum1 | Enum2 @endverbatim
- * 
- * Notes:
- *   - Enums must be instances of the same class.
  *
- * @param Enum1 this object
- * @param Enum2 another enum
- * @return new Enum instance
+ * @param another [Magick::Enum] the another enum
+ * @return [Magick::Enum] new Enum instance
  */
 VALUE
 Enum_bitwise_or(VALUE self, VALUE another)
 {
-  VALUE new_enum, cls;
-  MagickEnum *this, *that, *new_enum_data;
+    VALUE new_enum, cls;
+    MagickEnum *this, *that, *new_enum_data;
 
-  cls = CLASS_OF(self);
-  if (CLASS_OF(another) != cls)
-  {
-    rb_raise(rb_eArgError, "Expected class %s but got %s", rb_class2name(cls), rb_class2name(CLASS_OF(another)));
-  }
+    cls = CLASS_OF(self);
+    if (CLASS_OF(another) != cls)
+    {
+        rb_raise(rb_eArgError, "Expected class %s but got %s", rb_class2name(cls), rb_class2name(CLASS_OF(another)));
+    }
 
-  new_enum = Enum_alloc(cls);
+    new_enum = Enum_alloc(cls);
 
-  Data_Get_Struct(self, MagickEnum, this);
-  Data_Get_Struct(another, MagickEnum, that);
-  Data_Get_Struct(new_enum, MagickEnum, new_enum_data);
+    TypedData_Get_Struct(self, MagickEnum, &rm_enum_data_type, this);
+    TypedData_Get_Struct(another, MagickEnum, &rm_enum_data_type, that);
+    TypedData_Get_Struct(new_enum, MagickEnum, &rm_enum_data_type, new_enum_data);
 
-  new_enum_data->id = rb_to_id(rb_sprintf("%s|%s", rb_id2name(this->id), rb_id2name(that->id)));
-  new_enum_data->val = this->val | that->val;
+    new_enum_data->id = rb_to_id(rb_sprintf("%s|%s", rb_id2name(this->id), rb_id2name(that->id)));
+    new_enum_data->val = this->val | that->val;
 
-  return new_enum;
+    return new_enum;
 }
 
 /**
  * Return the name of an enum.
  *
- * Ruby usage:
- *   - @verbatim Enum#to_s @endverbatim
- *
- * @param self this object
- * @return the name
+ * @return [String] the name of an enum
  */
 VALUE
 Enum_to_s(VALUE self)
 {
-   return rb_str_new2(rm_enum_to_cstr(self));
+    return rb_str_new2(rm_enum_to_cstr(self));
 }
 
 
 /**
  * Initialize method for all Enum subclasses.
  *
- * Ruby usage:
- *   - @verbatim xxx#initialize(sym,val) @endverbatim
- *
- * @param self this object
- * @param sym the symbol
- * @param val the value of the symbol
- * @return self
+ * @param sym [Symbol] the symbol as enum name
+ * @param val [Numeric] the value for enum
+ * @return [Magick::Enum] self
  */
 VALUE
 Enum_type_initialize(VALUE self, VALUE sym, VALUE val)
@@ -286,7 +274,7 @@ Enum_type_initialize(VALUE self, VALUE sym, VALUE val)
 
     super_argv[0] = sym;
     super_argv[1] = val;
-    (void) rb_call_super(2, (const VALUE *)super_argv);
+    rb_call_super(2, (const VALUE *)super_argv);
 
     if (rb_cvar_defined(CLASS_OF(self), rb_intern(ENUMERATORS_CLASS_VAR)) != Qtrue)
     {
@@ -294,7 +282,7 @@ Enum_type_initialize(VALUE self, VALUE sym, VALUE val)
     }
 
     enumerators = rb_cv_get(CLASS_OF(self), ENUMERATORS_CLASS_VAR);
-    (void) rb_ary_push(enumerators, self);
+    rb_ary_push(enumerators, self);
 
     RB_GC_GUARD(enumerators);
 
@@ -305,11 +293,7 @@ Enum_type_initialize(VALUE self, VALUE sym, VALUE val)
 /**
  * Enum subclass #inspect.
  *
- * Ruby usage:
- *   - @verbatim xxx#inspect @endverbatim
- *
- * @param self this object
- * @return string representation of self
+ * @return [String] representation of self
  */
 static VALUE
 Enum_type_inspect(VALUE self)
@@ -317,8 +301,8 @@ Enum_type_inspect(VALUE self)
     char str[100];
     MagickEnum *magick_enum;
 
-    Data_Get_Struct(self, MagickEnum, magick_enum);
-    sprintf(str, "%.48s=%d", rb_id2name(magick_enum->id), magick_enum->val);
+    TypedData_Get_Struct(self, MagickEnum, &rm_enum_data_type, magick_enum);
+    snprintf(str, sizeof(str), "%.48s=%d", rb_id2name(magick_enum->id), magick_enum->val);
 
     return rb_str_new2(str);
 }
@@ -327,15 +311,14 @@ Enum_type_inspect(VALUE self)
 /**
  * Behaves like #each if a block is present, otherwise like #to_a.
  *
- * Ruby usage:
- *   - @verbatim xxx.values @endverbatim
- *   - @verbatim xxx.values {|v| } @endverbatim
- *
- * Notes:
- *   - Defined for each Enum subclass
+ * @overload values
+ *   @return [Array<Magick::Enum>] the enum values
  *
- * @param class the subclass
- * @return iterator over values if given block, a copy of the values otherwise
+ * @overload values
+ *   iterator over values if given block
+ *   @yield [val]
+ *   @yieldparam val [Magick::Enum] an enum
+ *   @return [Magick::Enum] self
  */
 static VALUE
 Enum_type_values(VALUE class)
@@ -350,7 +333,7 @@ Enum_type_values(VALUE class)
     {
         for (x = 0; x < RARRAY_LEN(enumerators); x++)
         {
-            (void) rb_yield(rb_ary_entry(enumerators, x));
+            rb_yield(rb_ary_entry(enumerators, x));
         }
         rv = class;
     }
@@ -359,7 +342,7 @@ Enum_type_values(VALUE class)
         copy = rb_ary_new2(RARRAY_LEN(enumerators));
         for (x = 0; x < RARRAY_LEN(enumerators); x++)
         {
-            (void) rb_ary_push(copy, rb_ary_entry(enumerators, x));
+            rb_ary_push(copy, rb_ary_entry(enumerators, x));
         }
         rb_obj_freeze(copy);
         rv = copy;
@@ -394,12 +377,12 @@ Enum_find(VALUE class, int val)
 
     for (x = 0; x < RARRAY_LEN(enumerators); x++)
     {
-       VALUE enumerator = rb_ary_entry(enumerators, x);
-       Data_Get_Struct(enumerator, MagickEnum, magick_enum);
-       if (magick_enum->val == val)
-       {
-           return enumerator;
-       }
+        VALUE enumerator = rb_ary_entry(enumerators, x);
+        TypedData_Get_Struct(enumerator, MagickEnum, &rm_enum_data_type, magick_enum);
+        if (magick_enum->val == val)
+        {
+            return enumerator;
+        }
     }
 
     return Qnil;
@@ -496,7 +479,35 @@ ComplianceType_name(ComplianceType *c)
 VALUE
 ComplianceType_find(ComplianceType compliance)
 {
-    return Enum_find(Class_ComplianceType, compliance);
+    ComplianceType c;
+
+    // Turn off undefined bits
+    if ((compliance & (SVGCompliance|X11Compliance|XPMCompliance))
+        == (SVGCompliance|X11Compliance|XPMCompliance))
+    {
+        c = SVGCompliance|X11Compliance|XPMCompliance;
+    }
+    else if (compliance & SVGCompliance)
+    {
+        c = SVGCompliance;
+    }
+    else if (compliance & X11Compliance)
+    {
+        c = X11Compliance;
+    }
+    else if (compliance & XPMCompliance)
+    {
+        c = XPMCompliance;
+    }
+    else if (compliance == NoCompliance)
+    {
+        c = NoCompliance;
+    }
+    else
+    {
+        c = UndefinedCompliance;
+    }
+    return Enum_find(Class_ComplianceType, c);
 }