ruby-oci8 2.1.7 → 2.1.8

data/ext/oci8/oradate.c

@@ -2,7 +2,7 @@
 /*
  *  oradate.c
  *
- * Copyright (C) 2002-2012 KUBO Takehiro <kubo@jiubao.org>
+ * Copyright (C) 2002-2015 Kubo Takehiro <kubo@jiubao.org>
  *
  * date and time between 4712 B.C. and 9999 A.D.
  */
@@ -61,6 +61,35 @@ typedef struct ora_date ora_date_t;
     if (sec < 0 || 59 < sec) \
         rb_raise(rb_eRangeError, "Out of range for second %d (expect 0 .. 59)", sec)
 
+#ifdef HAVE_RB_DATA_TYPE_T_FUNCTION
+#define check_oradate(obj) ((ora_date_t*)Check_TypedStruct((obj), &odate_data_type))
+#else
+static ora_date_t *check_oradate(VALUE obj)
+{
+    if (!rb_obj_is_kind_of(obj, cOraDate)) {
+        rb_raise(rb_eTypeError, "wrong argument type %s (expected %s)",
+                 rb_obj_classname(obj), rb_class2name(cOraDate));
+    }
+    return DATA_PTR(obj);
+}
+#endif
+
+static size_t odate_memsize(const void *ptr)
+{
+    return sizeof(ora_date_t);
+}
+
+static const rb_data_type_t odate_data_type = {
+    "OraDate",
+    {NULL, RUBY_DEFAULT_FREE, odate_memsize,},
+#ifdef RUBY_TYPED_FREE_IMMEDIATELY
+    NULL, NULL, RUBY_TYPED_FREE_IMMEDIATELY
+#endif
+#ifdef RUBY_TYPED_WB_PROTECTED
+    | RUBY_TYPED_WB_PROTECTED
+#endif
+};
+
 static void oci8_set_ora_date(ora_date_t *od, int year, int month, int day, int hour, int minute, int second)
 {
     Set_year(od, year);
@@ -74,12 +103,11 @@ static void oci8_set_ora_date(ora_date_t *od, int year, int month, int day, int
 static VALUE ora_date_s_allocate(VALUE klass)
 {
     ora_date_t *od;
-    return Data_Make_Struct(klass, ora_date_t, NULL, xfree, od);
+    return TypedData_Make_Struct(klass, ora_date_t, &odate_data_type, od);
 }
 
 /*
- *  call-seq:
- *   initialize(year = 1, month = 1, day = 1, hour = 0, min = 0, sec = 0)
+ * @overload initialize(year = 1, month = 1, day = 1, hour = 0, min = 0, sec = 0)
  *
  *  Returns an <code>OraDate</code> object initialized to the specified date and time.
  *
@@ -87,11 +115,18 @@ static VALUE ora_date_s_allocate(VALUE klass)
  *    OraDate.new              # => 0001-01-01 00:00:00
  *    OraDate.new(2012)        # => 2012-01-01 00:00:00
  *    OraDate.new(2012, 3, 4)  # => 2012-03-04 00:00:00
+ *
+ *  @param [Fixnum] year year
+ *  @param [Fixnum] month month
+ *  @param [Fixnum] day  day of month
+ *  @param [Fixnum] hour hour
+ *  @param [Fixnum] min  minute
+ *  @param [Fixnum] sec  second
  */
 static VALUE ora_date_initialize(int argc, VALUE *argv, VALUE self)
 {
     VALUE vyear, vmonth, vday, vhour, vmin, vsec;
-    ora_date_t *od = DATA_PTR(self);
+    ora_date_t *od = check_oradate(self);
     int year, month, day, hour, min, sec;
 
     rb_scan_args(argc, argv, "06", &vyear, &vmonth, &vday, &vhour, &vmin, &vsec);
@@ -147,16 +182,17 @@ static VALUE ora_date_initialize(int argc, VALUE *argv, VALUE self)
  */
 static VALUE ora_date_initialize_copy(VALUE lhs, VALUE rhs)
 {
-    ora_date_t *l, *r;
+    ora_date_t *l = check_oradate(lhs);
+    ora_date_t *r = check_oradate(rhs);
 
     rb_call_super(1, &rhs);
-    Data_Get_Struct(lhs, ora_date_t, l);
-    Data_Get_Struct(rhs, ora_date_t, r);
     memcpy(l, r, sizeof(ora_date_t));
     return lhs;
 }
 
 /*
+ * @overload now
+ *
  *  Returns an <code>OraDate</code> object initialized to the
  *  current local time.
  *
@@ -165,7 +201,7 @@ static VALUE ora_date_initialize_copy(VALUE lhs, VALUE rhs)
 static VALUE ora_date_s_now(int argc, VALUE *argv, VALUE klass)
 {
     VALUE obj = ora_date_s_allocate(klass);
-    ora_date_t *od = DATA_PTR(obj);
+    ora_date_t *od = check_oradate(obj);
     time_t tm = time(0);
     int year, month, day, hour, min, sec;
 #ifdef HAVE_LOCALTIME_R
@@ -188,6 +224,8 @@ static VALUE ora_date_s_now(int argc, VALUE *argv, VALUE klass)
 }
 
 /*
+ * @overload to_s
+ *
  *  Returns a string representing <i>self</i>.
  *  The string format is 'yyyy/mm/dd hh:mi:ss'.
  *
@@ -195,26 +233,26 @@ static VALUE ora_date_s_now(int argc, VALUE *argv, VALUE klass)
  */
 static VALUE ora_date_to_s(VALUE self)
 {
-    ora_date_t *od;
+    ora_date_t *od = check_oradate(self);
     char buf[30];
 
-    Data_Get_Struct(self, ora_date_t, od);
     sprintf(buf, "%04d/%02d/%02d %02d:%02d:%02d", Get_year(od), Get_month(od),
             Get_day(od), Get_hour(od), Get_minute(od), Get_second(od));
     return rb_usascii_str_new_cstr(buf);
 }
 
 /*
+ * @overload to_a
+ *
  *  Returns a 6-element <i>array</i> of year, month, day, hour, minute and second.
  *
  *  @return [Array]
  */
 static VALUE ora_date_to_a(VALUE self)
 {
-    ora_date_t *od;
+    ora_date_t *od = check_oradate(self);
     VALUE ary[6];
 
-    Data_Get_Struct(self, ora_date_t, od);
     ary[0] = INT2FIX(Get_year(od));
     ary[1] = INT2FIX(Get_month(od));
     ary[2] = INT2FIX(Get_day(od));
@@ -225,39 +263,39 @@ static VALUE ora_date_to_a(VALUE self)
 }
 
 /*
+ * @overload year
+ *
  *  Returns the year field of <i>self</i>.
  *
  *  @return [Fixnum]
  */
 static VALUE ora_date_year(VALUE self)
 {
-    ora_date_t *od;
+    ora_date_t *od = check_oradate(self);
 
-    Data_Get_Struct(self, ora_date_t, od);
     return INT2FIX(Get_year(od));
 }
 
 /*
- *  call-seq:
- *    year = num
+ * @overload year=num
  *
  *  Assigns <i>num</i> to the year field of <i>self</i>.
  *
- *  @param [Fixnum] number between -4712 and 9999
+ *  @param [Fixnum] num number between -4712 and 9999
  */
 static VALUE ora_date_set_year(VALUE self, VALUE val)
 {
-    ora_date_t *od;
-    int v;
+    ora_date_t *od = check_oradate(self);
+    int v = NUM2INT(val);
 
-    v = NUM2INT(val);
     Check_year(v);
-    Data_Get_Struct(self, ora_date_t, od);
     Set_year(od, v);
     return self;
 }
 
 /*
+ * @overload month
+ *
  *  Returns the month field of <i>self</i>.
  *  The month starts with one.
  *
@@ -265,166 +303,157 @@ static VALUE ora_date_set_year(VALUE self, VALUE val)
  */
 static VALUE ora_date_month(VALUE self)
 {
-    ora_date_t *od;
+    ora_date_t *od = check_oradate(self);
 
-    Data_Get_Struct(self, ora_date_t, od);
     return INT2FIX(Get_month(od));
 }
 
 /*
- *  call-seq:
- *    month = num
+ * @overload month=num
  *
  *  Assigns <i>num</i> to the month field of <i>self</i>.
  *  The month starts with one.
  *
- *  @param [Fixnum] number between 1 and 12
+ *  @param [Fixnum] num number between 1 and 12
  */
 static VALUE ora_date_set_month(VALUE self, VALUE val)
 {
-    ora_date_t *od;
-    int v;
+    ora_date_t *od = check_oradate(self);
+    int v = NUM2INT(val);
 
-    v = NUM2INT(val);
     Check_month(v);
-    Data_Get_Struct(self, ora_date_t, od);
     Set_month(od, v);
     return self;
 }
 
 /*
+ * @overload day
+ *
  *  Returns the day of month field of <i>self</i>.
  *
  *  @return [Fixnum]
  */
 static VALUE ora_date_day(VALUE self)
 {
-    ora_date_t *od;
+    ora_date_t *od = check_oradate(self);
 
-    Data_Get_Struct(self, ora_date_t, od);
     return INT2FIX(Get_day(od));
 }
 
 /*
- *  call-seq:
- *    day = num
+ * @overload day=num
  *
  *  Assigns <i>num</i> to the day of month field of <i>self</i>.
  *
- *  @param [Fixnum] number between 1 and 31
+ *  @param [Fixnum] num number between 1 and 31
  */
 static VALUE ora_date_set_day(VALUE self, VALUE val)
 {
-    ora_date_t *od;
-    int v;
+    ora_date_t *od = check_oradate(self);
+    int v = NUM2INT(val);
 
-    v = NUM2INT(val);
     Check_day(v);
-    Data_Get_Struct(self, ora_date_t, od);
     Set_day(od, v);
     return self;
 }
 
 /*
+ * @overload hour
+ *
  *  Returns the hour field of <i>self</i>.
  *
  *  @return [Fixnum]
  */
 static VALUE ora_date_hour(VALUE self)
 {
-    ora_date_t *od;
+    ora_date_t *od = check_oradate(self);
 
-    Data_Get_Struct(self, ora_date_t, od);
     return INT2FIX(Get_hour(od));
 }
 
 /*
- *  call-seq:
- *    hour = num
+ * @overload hour=num
  *
  *  Assigns <i>num</i> to the hour field of <i>self</i>.
  *
- *  @param [Fixnum] number between 0 and 23
+ *  @param [Fixnum] num number between 0 and 23
  */
 static VALUE ora_date_set_hour(VALUE self, VALUE val)
 {
-    ora_date_t *od;
-    int v;
+    ora_date_t *od = check_oradate(self);
+    int v = NUM2INT(val);
 
-    v = NUM2INT(val);
     Check_hour(v);
-    Data_Get_Struct(self, ora_date_t, od);
     Set_hour(od, v);
     return self;
 }
 
 /*
+ * @overload minute
+ *
  *  Returns the minute field of <i>self</i>.
  *
  *  @return [Fixnum]
  */
 static VALUE ora_date_minute(VALUE self)
 {
-    ora_date_t *od;
+    ora_date_t *od = check_oradate(self);
 
-    Data_Get_Struct(self, ora_date_t, od);
     return INT2FIX(Get_minute(od));
 }
 
 /*
- *  call-seq:
- *    minute = num
+ * @overload minute=num
  *
  *  Assigns <i>num</i> to the minute field of <i>self</i>.
  *
- *  @param [Fixnum] number between 0 and 59
+ *  @param [Fixnum] num number between 0 and 59
  */
 static VALUE ora_date_set_minute(VALUE self, VALUE val)
 {
-    ora_date_t *od;
-    int v;
+    ora_date_t *od = check_oradate(self);
+    int v = NUM2INT(val);
 
-    v = NUM2INT(val);
     Check_minute(v);
-    Data_Get_Struct(self, ora_date_t, od);
     Set_minute(od, v);
     return self;
 }
 
 /*
+ * @overload second
+ *
  *  Returns the second field of <i>self</i>.
  *
  *  @return [Fixnum]
  */
 static VALUE ora_date_second(VALUE self)
 {
-    ora_date_t *od;
+    ora_date_t *od = check_oradate(self);
 
-    Data_Get_Struct(self, ora_date_t, od);
     return INT2FIX(Get_second(od));
 }
 
 /*
- *  call-seq:
- *    second = num
+ * @overload second=num
  *
  *  Assigns <i>num</i> to the second field of <i>self</i>.
  *
- *  @param [Fixnum] number between 0 and 59
+ *  @param [Fixnum] num number between 0 and 59
  */
 static VALUE ora_date_set_second(VALUE self, VALUE val)
 {
-    ora_date_t *od;
+    ora_date_t *od = check_oradate(self);
     int v;
 
     v = NUM2INT(val);
     Check_second(v);
-    Data_Get_Struct(self, ora_date_t, od);
     Set_second(od, v);
     return self;
 }
 
 /*
+ * @overload trunc
+ *
  *  Truncates hour, minute and second fields to zero.
  *
  *  @example
@@ -435,9 +464,8 @@ static VALUE ora_date_set_second(VALUE self, VALUE val)
  */
 static VALUE ora_date_trunc(VALUE self)
 {
-    ora_date_t *od;
+    ora_date_t *od = check_oradate(self);
 
-    Data_Get_Struct(self, ora_date_t, od);
     od->hour = 1;
     od->minute = 1;
     od->second = 1;
@@ -445,18 +473,18 @@ static VALUE ora_date_trunc(VALUE self)
 }
 
 /*
- *  call-seq:
- *     self <=> other
+ * @overload <=>(other)
  *
  *  Returns -1, 0, or +1 depending on whether <i>self</i> is less than,
  *  equal to, or greater than <i>other</i>.
+ *
+ *  @return [-1, 0, +1]
  */
 static VALUE ora_date_cmp(VALUE self, VALUE val)
 {
-    ora_date_t *od1, *od2;
-    Data_Get_Struct(self, ora_date_t, od1);
-    Check_Object(val, cOraDate);
-    Data_Get_Struct(val, ora_date_t, od2);
+    ora_date_t *od1 = check_oradate(self);
+    ora_date_t *od2 = check_oradate(val);
+
     if (od1->century < od2->century) return INT2FIX(-1);
     if (od1->century > od2->century) return INT2FIX(1);
     if (od1->year < od2->year) return INT2FIX(-1);
@@ -479,10 +507,9 @@ static VALUE ora_date_cmp(VALUE self, VALUE val)
  */
 static VALUE ora_date_hash(VALUE self)
 {
-    ora_date_t *od;
+    ora_date_t *od = check_oradate(self);
     unsigned int v;
 
-    Data_Get_Struct(self, ora_date_t, od);
     v = (od->century <<  8)
         + (od->year    << 15)
         + (od->month   << 22)
@@ -494,6 +521,8 @@ static VALUE ora_date_hash(VALUE self)
 }
 
 /*
+ * @overload _dump
+ *
  *  Serializes <i>self</i>.
  *  This method is called by Marshal.dump().
  *
@@ -502,14 +531,13 @@ static VALUE ora_date_hash(VALUE self)
  */
 static VALUE ora_date_dump(int argc, VALUE *argv, VALUE self)
 {
-    ora_date_t *od;
-    Data_Get_Struct(self, ora_date_t, od);
+    ora_date_t *od = check_oradate(self);
+
     return rb_str_new((const char*)od, sizeof(ora_date_t)); /* ASCII-8BIT */
 }
 
 /*
- *  call-seq:
- *    _load(bytes)
+ * @overload _load(bytes)
  *
  *  Restores a byte stream serialized by {OraDate#_dump}.
  *  This method is called by Marshal.load() to deserialize a byte stream
@@ -527,7 +555,7 @@ static VALUE ora_date_s_load(VALUE klass, VALUE str)
     if (RSTRING_LEN(str) != sizeof(ora_date_t)) {
         rb_raise(rb_eTypeError, "marshaled OraDate format differ");
     }
-    obj = Data_Make_Struct(cOraDate, ora_date_t, NULL, xfree, od);
+    obj = TypedData_Make_Struct(cOraDate, ora_date_t, &odate_data_type, od);
     memcpy(od, RSTRING_PTR(str), sizeof(ora_date_t));
     return obj;
 }
@@ -542,17 +570,15 @@ static VALUE bind_oradate_get(oci8_bind_t *obind, void *data, void *null_struct)
 {
     ora_date_t *od;
 
-    VALUE obj = Data_Make_Struct(cOraDate, ora_date_t, NULL, xfree, od);
+    VALUE obj = TypedData_Make_Struct(cOraDate, ora_date_t, &odate_data_type, od);
     memcpy(od, data, sizeof(ora_date_t));
     return obj;
 }
 
 static void bind_oradate_set(oci8_bind_t *obind, void *data, void **null_structp, VALUE val)
 {
-    ora_date_t *od;
+    ora_date_t *od = check_oradate(val);
 
-    Check_Object(val, cOraDate);
-    Data_Get_Struct(val, ora_date_t, od);
     memcpy(data, od, sizeof(ora_date_t));
 }
 
@@ -571,9 +597,20 @@ static void bind_oradate_init_elem(oci8_bind_t *obind, VALUE svc)
     } while (++idx < obind->maxar_sz);
 }
 
-static const oci8_bind_vtable_t bind_oradate_vtable = {
+static const oci8_bind_data_type_t bind_oradate_data_type = {
     {
-        NULL,
+        {
+            "OCI8::BindType::OraDate",
+            {
+                NULL,
+                oci8_handle_cleanup,
+                oci8_handle_size,
+            },
+            &oci8_bind_data_type.rb_data_type, NULL,
+#ifdef RUBY_TYPED_WB_PROTECTED
+            RUBY_TYPED_WB_PROTECTED,
+#endif
+        },
         oci8_bind_free,
         sizeof(oci8_bind_t)
     },
@@ -585,6 +622,11 @@ static const oci8_bind_vtable_t bind_oradate_vtable = {
     SQLT_DAT,
 };
 
+static VALUE bind_oradate_alloc(VALUE klass)
+{
+    return oci8_allocate_typeddata(klass, &bind_oradate_data_type.base);
+}
+
 void Init_ora_date(void)
 {
     cOraDate = rb_define_class("OraDate", rb_cObject);
@@ -624,5 +666,5 @@ void Init_ora_date(void)
     rb_define_method(cOraDate, "_dump", ora_date_dump, -1);
     rb_define_singleton_method(cOraDate, "_load", ora_date_s_load, 1);
 
-    oci8_define_bind_class("OraDate", &bind_oradate_vtable);
+    oci8_define_bind_class("OraDate", &bind_oradate_data_type, bind_oradate_alloc);
 }