diff options
Diffstat (limited to 'compar.c')
| -rw-r--r-- | compar.c | 218 |
1 files changed, 148 insertions, 70 deletions
@@ -9,8 +9,12 @@ **********************************************************************/ -#include "ruby/ruby.h" #include "id.h" +#include "internal.h" +#include "internal/compar.h" +#include "internal/error.h" +#include "internal/vm.h" +#include "ruby/ruby.h" VALUE rb_mComparable; @@ -26,13 +30,13 @@ rb_cmperr(VALUE x, VALUE y) VALUE classname; if (SPECIAL_CONST_P(y) || BUILTIN_TYPE(y) == T_FLOAT) { - classname = rb_inspect(y); + classname = rb_inspect(y); } else { - classname = rb_obj_class(y); + classname = rb_obj_class(y); } rb_raise(rb_eArgError, "comparison of %"PRIsVALUE" with %"PRIsVALUE" failed", - rb_obj_class(x), classname); + rb_obj_class(x), classname); } static VALUE @@ -46,12 +50,12 @@ VALUE rb_invcmp(VALUE x, VALUE y) { VALUE invcmp = rb_exec_recursive(invcmp_recursive, x, y); - if (invcmp == Qundef || NIL_P(invcmp)) { - return Qnil; + if (NIL_OR_UNDEF_P(invcmp)) { + return Qnil; } else { - int result = -rb_cmpint(invcmp, x, y); - return INT2FIX(result); + int result = -rb_cmpint(invcmp, x, y); + return INT2FIX(result); } } @@ -80,8 +84,7 @@ cmp_equal(VALUE x, VALUE y) c = rb_exec_recursive_paired_outer(cmp_eq_recursive, x, y, y); if (NIL_P(c)) return Qfalse; - if (rb_cmpint(c, x, y) == 0) return Qtrue; - return Qfalse; + return RBOOL(rb_cmpint(c, x, y) == 0); } static int @@ -92,71 +95,84 @@ cmpint(VALUE x, VALUE y) /* * call-seq: - * obj > other -> true or false + * self > other -> true or false * - * Compares two objects based on the receiver's <code><=></code> - * method, returning true if it returns 1. + * Returns whether +self+ is "greater than" +other+; + * equivalent to <tt>(self <=> other) > 0</tt>: + * + * 'foo' > 'foo' # => false + * 'food' > 'foo' # => true */ static VALUE cmp_gt(VALUE x, VALUE y) { - if (cmpint(x, y) > 0) return Qtrue; - return Qfalse; + return RBOOL(cmpint(x, y) > 0); } /* * call-seq: - * obj >= other -> true or false + * self >= other -> true or false + * + * Returns whether +self+ is "greater than or equal to" +other+; + * equivalent to <tt>(self <=> other) >= 0</tt>: + * + * 'food' >= 'foo' # => true + * 'foo' >= 'foo' # => true + * 'foo' >= 'food' # => false * - * Compares two objects based on the receiver's <code><=></code> - * method, returning true if it returns 0 or 1. */ static VALUE cmp_ge(VALUE x, VALUE y) { - if (cmpint(x, y) >= 0) return Qtrue; - return Qfalse; + return RBOOL(cmpint(x, y) >= 0); } /* * call-seq: - * obj < other -> true or false + * self < other -> true or false + * + * Returns whether +self+ is "less than" +other+; + * equivalent to <tt>(self <=> other) < 0</tt>: + * + * 'foo' < 'foo' # => false + * 'foo' < 'food' # => true * - * Compares two objects based on the receiver's <code><=></code> - * method, returning true if it returns -1. */ static VALUE cmp_lt(VALUE x, VALUE y) { - if (cmpint(x, y) < 0) return Qtrue; - return Qfalse; + return RBOOL(cmpint(x, y) < 0); } /* * call-seq: - * obj <= other -> true or false + * self <= other -> true or false + * + * Returns whether +self+ is "less than or equal to" +other+; + * equivalent to <tt>(self <=> other) <= 0</tt>: + * + * 'foo' <= 'foo' # => true + * 'foo' <= 'food' # => true + * 'food' <= 'foo' # => false * - * Compares two objects based on the receiver's <code><=></code> - * method, returning true if it returns -1 or 0. */ static VALUE cmp_le(VALUE x, VALUE y) { - if (cmpint(x, y) <= 0) return Qtrue; - return Qfalse; + return RBOOL(cmpint(x, y) <= 0); } /* * call-seq: * obj.between?(min, max) -> true or false * - * Returns <code>false</code> if <i>obj</i> <code><=></code> - * <i>min</i> is less than zero or if <i>anObject</i> <code><=></code> - * <i>max</i> is greater than zero, <code>true</code> otherwise. + * Returns <code>false</code> if _obj_ <code><=></code> _min_ is less + * than zero or if _obj_ <code><=></code> _max_ is greater than zero, + * <code>true</code> otherwise. * * 3.between?(1, 5) #=> true * 6.between?(1, 5) #=> false @@ -168,18 +184,18 @@ cmp_le(VALUE x, VALUE y) static VALUE cmp_between(VALUE x, VALUE min, VALUE max) { - if (cmpint(x, min) < 0) return Qfalse; - if (cmpint(x, max) > 0) return Qfalse; - return Qtrue; + return RBOOL((cmpint(x, min) >= 0 && cmpint(x, max) <= 0)); } /* * call-seq: * obj.clamp(min, max) -> obj + * obj.clamp(range) -> obj * - * Returns <i>min</i> if <i>obj</i> <code><=></code> <i>min</i> is less - * than zero, <i>max</i> if <i>obj</i> <code><=></code> <i>max</i> is - * greater than zero and <i>obj</i> otherwise. + * In <code>(min, max)</code> form, returns _min_ if _obj_ + * <code><=></code> _min_ is less than zero, _max_ if _obj_ + * <code><=></code> _max_ is greater than zero, and _obj_ + * otherwise. * * 12.clamp(0, 100) #=> 12 * 523.clamp(0, 100) #=> 100 @@ -187,70 +203,132 @@ cmp_between(VALUE x, VALUE min, VALUE max) * * 'd'.clamp('a', 'f') #=> 'd' * 'z'.clamp('a', 'f') #=> 'f' + * + * If _min_ is +nil+, it is considered smaller than _obj_, + * and if _max_ is +nil+, it is considered greater than _obj_. + * + * -20.clamp(0, nil) #=> 0 + * 523.clamp(nil, 100) #=> 100 + * + * In <code>(range)</code> form, returns _range.begin_ if _obj_ + * <code><=></code> _range.begin_ is less than zero, _range.end_ + * if _obj_ <code><=></code> _range.end_ is greater than zero, and + * _obj_ otherwise. + * + * 12.clamp(0..100) #=> 12 + * 523.clamp(0..100) #=> 100 + * -3.123.clamp(0..100) #=> 0 + * + * 'd'.clamp('a'..'f') #=> 'd' + * 'z'.clamp('a'..'f') #=> 'f' + * + * If _range.begin_ is +nil+, it is considered smaller than _obj_, + * and if _range.end_ is +nil+, it is considered greater than + * _obj_. + * + * -20.clamp(0..) #=> 0 + * 523.clamp(..100) #=> 100 + * + * When _range.end_ is excluded and not +nil+, an exception is + * raised. + * + * 100.clamp(0...100) # ArgumentError */ static VALUE -cmp_clamp(VALUE x, VALUE min, VALUE max) +cmp_clamp(int argc, VALUE *argv, VALUE x) { - int c; - - if (cmpint(min, max) > 0) { - rb_raise(rb_eArgError, "min argument must be smaller than max argument"); + VALUE min, max; + int c, excl = 0; + + if (rb_scan_args(argc, argv, "11", &min, &max) == 1) { + VALUE range = min; + if (!rb_range_values(range, &min, &max, &excl)) { + rb_raise(rb_eTypeError, "wrong argument type %s (expected Range)", + rb_builtin_class_name(range)); + } + if (!NIL_P(max)) { + if (excl) rb_raise(rb_eArgError, "cannot clamp with an exclusive range"); + } + } + if (!NIL_P(min) && !NIL_P(max) && cmpint(min, max) > 0) { + rb_raise(rb_eArgError, "min argument must be less than or equal to max argument"); } - c = cmpint(x, min); - if (c == 0) return x; - if (c < 0) return min; - c = cmpint(x, max); - if (c > 0) return max; + if (!NIL_P(min)) { + c = cmpint(x, min); + if (c == 0) return x; + if (c < 0) return min; + } + if (!NIL_P(max)) { + c = cmpint(x, max); + if (c > 0) return max; + } return x; } /* - * The <code>Comparable</code> mixin is used by classes whose objects - * may be ordered. The class must define the <code><=></code> operator, - * which compares the receiver against another object, returning -1, 0, - * or +1 depending on whether the receiver is less than, equal to, or - * greater than the other object. If the other object is not comparable - * then the <code><=></code> operator should return nil. - * <code>Comparable</code> uses - * <code><=></code> to implement the conventional comparison operators - * (<code><</code>, <code><=</code>, <code>==</code>, <code>>=</code>, - * and <code>></code>) and the method <code>between?</code>. - * - * class SizeMatters + * The Comparable mixin is used by classes whose objects may be + * ordered. The class must define the <code><=></code> operator, + * which compares the receiver against another object, returning a + * value less than 0, returning 0, or returning a value greater than 0, + * depending on whether the receiver is less than, equal to, + * or greater than the other object. If the other object is not + * comparable then the <code><=></code> operator should return +nil+. + * Comparable uses <code><=></code> to implement the conventional + * comparison operators (<code><</code>, <code><=</code>, + * <code>==</code>, <code>>=</code>, and <code>></code>) and the + * method <code>between?</code>. + * + * class StringSorter * include Comparable + * * attr :str * def <=>(other) * str.size <=> other.str.size * end + * * def initialize(str) * @str = str * end + * * def inspect * @str * end * end * - * s1 = SizeMatters.new("Z") - * s2 = SizeMatters.new("YY") - * s3 = SizeMatters.new("XXX") - * s4 = SizeMatters.new("WWWW") - * s5 = SizeMatters.new("VVVVV") + * s1 = StringSorter.new("Z") + * s2 = StringSorter.new("YY") + * s3 = StringSorter.new("XXX") + * s4 = StringSorter.new("WWWW") + * s5 = StringSorter.new("VVVVV") * * s1 < s2 #=> true * s4.between?(s1, s3) #=> false * s4.between?(s3, s5) #=> true * [ s3, s2, s5, s4, s1 ].sort #=> [Z, YY, XXX, WWWW, VVVVV] * + * == What's Here + * + * Module \Comparable provides these methods, all of which use method <tt>#<=></tt>: + * + * - #<: Returns whether +self+ is less than the given object. + * - #<=: Returns whether +self+ is less than or equal to the given object. + * - #==: Returns whether +self+ is equal to the given object. + * - #>: Returns whether +self+ is greater than the given object. + * - #>=: Returns whether +self+ is greater than or equal to the given object. + * - #between?: Returns +true+ if +self+ is between two given objects. + * - #clamp: For given objects +min+ and +max+, or range <tt>(min..max)</tt>, returns: + * + * - +min+ if <tt>(self <=> min) < 0</tt>. + * - +max+ if <tt>(self <=> max) > 0</tt>. + * - +self+ otherwise. + * */ void Init_Comparable(void) { -#undef rb_intern -#define rb_intern(str) rb_intern_const(str) - rb_mComparable = rb_define_module("Comparable"); rb_define_method(rb_mComparable, "==", cmp_equal, 1); rb_define_method(rb_mComparable, ">", cmp_gt, 1); @@ -258,5 +336,5 @@ Init_Comparable(void) rb_define_method(rb_mComparable, "<", cmp_lt, 1); rb_define_method(rb_mComparable, "<=", cmp_le, 1); rb_define_method(rb_mComparable, "between?", cmp_between, 2); - rb_define_method(rb_mComparable, "clamp", cmp_clamp, 2); + rb_define_method(rb_mComparable, "clamp", cmp_clamp, -1); } |