{&: rooto:"YARD::CodeObjects::RootObject:@childrenIC:&YARD::CodeObjects::CodeObjectList[o:#YARD::CodeObjects::ClassObject;IC;["o:$YARD::CodeObjects::MethodObject:@module_functionF: @scope:
instance:@visibility: public:
@pathI"Rational#numerator:EF:@parameters[ : @files[[I"rational.c;Tiq: @current_file_has_commentsT:
@name:numerator:@source_type0:
@tags[ :@docstrings{ :@docstringIC:YARD::Docstring"Returns the numerator.
Rational(7).numerator #=> 7
Rational(7, 1).numerator #=> 7
Rational(9, -4).numerator #=> -9
Rational(-2, -10).numerator #=> 1
;T;[o: YARD::Tags::OverloadTag
:@tag_nameI"
overload;F:
@text0;;: @types0:@signatureI"numerator;T;IC;" ;T;[o:YARD::Tags::Tag
; I" return;F; I" ;T;0; [I" Integer;T: @object@
:@ref_tags[ : @allI"@return [Integer];T:@unresolved_reference0;"@
:
@summary0:@hash_flagF:@ref_tag_recurse_counti ;[ ;"@
;#[ ;$I"Returns the numerator.
Rational(7).numerator #=> 7
Rational(7, 1).numerator #=> 7
Rational(9, -4).numerator #=> -9
Rational(-2, -10).numerator #=> 1
@overload numerator
@return [Integer];T;%0;"@
;'F:@line_rangeo:
Range: exclT:
beginif:endio:@namespace@; I"static VALUE;T: @sourceI"Zstatic VALUE
nurat_numerator(VALUE self)
{
get_dat1(self);
return dat->num;
};T:@explicitTo;
; F; ;
;;;I"Rational#denominator;F;[ ;[[@i;T;:denominator;0;[ ;{ ;IC;" Returns the denominator (always positive).
Rational(7).denominator #=> 1
Rational(7, 1).denominator #=> 1
Rational(9, -4).denominator #=> 4
Rational(-2, -10).denominator #=> 5
rat.numerator.gcd(rat.denominator) #=> 1
;T;[o;
; I"
overload;F; 0;;1; 0; I"denominator;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@&;#[ ;$I"@return [Integer];T;%0;"@&;&0;'F;(i ;[ ;"@&;#[ ;$I"8Returns the denominator (always positive).
Rational(7).denominator #=> 1
Rational(7, 1).denominator #=> 1
Rational(9, -4).denominator #=> 4
Rational(-2, -10).denominator #=> 5
rat.numerator.gcd(rat.denominator) #=> 1
@overload denominator
@return [Integer];T;%0;"@&;'F;)o;*;+T;,ix;-i;.@; I"static VALUE;T;/I"\static VALUE
nurat_denominator(VALUE self)
{
get_dat1(self);
return dat->den;
};T;0To;
; F; ;
;;;I"Rational#+;F;[[I"
other;T0;[[@i;T;:+;0;[ ;{ ;IC;"Performs addition.
Rational(2, 3) + Rational(2, 3) #=> (4/3)
Rational(900) + Rational(1) #=> (900/1)
Rational(-2, 9) + Rational(-9, 2) #=> (-85/18)
Rational(9, 8) + 4 #=> (41/8)
Rational(20, 9) + 9.8 #=> 12.022222222222222
;T;[o;
; I"
overload;F; 0;;2; 0; I"+(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Numeric;T;"@A;#[ ;$I"@return [Numeric];T;%0;"@A;&0;'F;(i ;[[I" numeric;T0;"@A;#[ ;$I"APerforms addition.
Rational(2, 3) + Rational(2, 3) #=> (4/3)
Rational(900) + Rational(1) #=> (900/1)
Rational(-2, 9) + Rational(-9, 2) #=> (-85/18)
Rational(9, 8) + 4 #=> (41/8)
Rational(20, 9) + 9.8 #=> 12.022222222222222
@overload +(numeric)
@return [Numeric];T;%0;"@A;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"+static VALUE
nurat_add(VALUE self, VALUE other)
{
if (RB_TYPE_P(other, T_FIXNUM) || RB_TYPE_P(other, T_BIGNUM)) {
{
get_dat1(self);
return f_addsub(self,
dat->num, dat->den,
other, ONE, '+');
}
}
else if (RB_TYPE_P(other, T_FLOAT)) {
return f_add(f_to_f(self), other);
}
else if (RB_TYPE_P(other, T_RATIONAL)) {
{
get_dat2(self, other);
return f_addsub(self,
adat->num, adat->den,
bdat->num, bdat->den, '+');
}
}
else {
return rb_num_coerce_bin(self, other, '+');
}
};T;0To;
; F; ;
;;;I"Rational#-;F;[[I"
other;T0;[[@i;T;:-;0;[ ;{ ;IC;"Performs subtraction.
Rational(2, 3) - Rational(2, 3) #=> (0/1)
Rational(900) - Rational(1) #=> (899/1)
Rational(-2, 9) - Rational(-9, 2) #=> (77/18)
Rational(9, 8) - 4 #=> (23/8)
Rational(20, 9) - 9.8 #=> -7.577777777777778
;T;[o;
; I"
overload;F; 0;;3; 0; I"-(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Numeric;T;"@`;#[ ;$I"@return [Numeric];T;%0;"@`;&0;'F;(i ;[[I" numeric;T0;"@`;#[ ;$I"CPerforms subtraction.
Rational(2, 3) - Rational(2, 3) #=> (0/1)
Rational(900) - Rational(1) #=> (899/1)
Rational(-2, 9) - Rational(-9, 2) #=> (77/18)
Rational(9, 8) - 4 #=> (23/8)
Rational(20, 9) - 9.8 #=> -7.577777777777778
@overload -(numeric)
@return [Numeric];T;%0;"@`;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"+static VALUE
nurat_sub(VALUE self, VALUE other)
{
if (RB_TYPE_P(other, T_FIXNUM) || RB_TYPE_P(other, T_BIGNUM)) {
{
get_dat1(self);
return f_addsub(self,
dat->num, dat->den,
other, ONE, '-');
}
}
else if (RB_TYPE_P(other, T_FLOAT)) {
return f_sub(f_to_f(self), other);
}
else if (RB_TYPE_P(other, T_RATIONAL)) {
{
get_dat2(self, other);
return f_addsub(self,
adat->num, adat->den,
bdat->num, bdat->den, '-');
}
}
else {
return rb_num_coerce_bin(self, other, '-');
}
};T;0To;
; F; ;
;;;I"Rational#*;F;[[I"
other;T0;[[@id;T;:*;0;[ ;{ ;IC;"Performs multiplication.
Rational(2, 3) * Rational(2, 3) #=> (4/9)
Rational(900) * Rational(1) #=> (900/1)
Rational(-2, 9) * Rational(-9, 2) #=> (1/1)
Rational(9, 8) * 4 #=> (9/2)
Rational(20, 9) * 9.8 #=> 21.77777777777778
;T;[o;
; I"
overload;F; 0;;4; 0; I"*(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Numeric;T;"@;#[ ;$I"@return [Numeric];T;%0;"@;&0;'F;(i ;[[I" numeric;T0;"@;#[ ;$I"BPerforms multiplication.
Rational(2, 3) * Rational(2, 3) #=> (4/9)
Rational(900) * Rational(1) #=> (900/1)
Rational(-2, 9) * Rational(-9, 2) #=> (1/1)
Rational(9, 8) * 4 #=> (9/2)
Rational(20, 9) * 9.8 #=> 21.77777777777778
@overload *(numeric)
@return [Numeric];T;%0;"@;'F;)o;*;+T;,iX;-ib;.@; I"static VALUE;T;/I"+static VALUE
nurat_mul(VALUE self, VALUE other)
{
if (RB_TYPE_P(other, T_FIXNUM) || RB_TYPE_P(other, T_BIGNUM)) {
{
get_dat1(self);
return f_muldiv(self,
dat->num, dat->den,
other, ONE, '*');
}
}
else if (RB_TYPE_P(other, T_FLOAT)) {
return f_mul(f_to_f(self), other);
}
else if (RB_TYPE_P(other, T_RATIONAL)) {
{
get_dat2(self, other);
return f_muldiv(self,
adat->num, adat->den,
bdat->num, bdat->den, '*');
}
}
else {
return rb_num_coerce_bin(self, other, '*');
}
};T;0To;
; F; ;
;;;I"Rational#/;F;[[I"
other;T0;[[@i;T;:/;0;[ ;{ ;IC;"Performs division.
Rational(2, 3) / Rational(2, 3) #=> (1/1)
Rational(900) / Rational(1) #=> (900/1)
Rational(-2, 9) / Rational(-9, 2) #=> (4/81)
Rational(9, 8) / 4 #=> (9/32)
Rational(20, 9) / 9.8 #=> 0.22675736961451246
;T;[o;
; I"
overload;F; 0;;5; 0; I"/(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Numeric;T;"@;#[ ;$I"@return [Numeric];T;%0;"@;&0;'F;(i ;[[I" numeric;T0;"@o;
; I"
overload;F; 0;:quo; 0; I"quo(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Numeric;T;"@;#[ ;$I"@return [Numeric];T;%0;"@;&0;'F;(i ;[[I" numeric;T0;"@;#[ ;$I"kPerforms division.
Rational(2, 3) / Rational(2, 3) #=> (1/1)
Rational(900) / Rational(1) #=> (900/1)
Rational(-2, 9) / Rational(-9, 2) #=> (4/81)
Rational(9, 8) / 4 #=> (9/32)
Rational(20, 9) / 9.8 #=> 0.22675736961451246
@overload /(numeric)
@return [Numeric]
@overload quo(numeric)
@return [Numeric];T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"static VALUE
nurat_div(VALUE self, VALUE other)
{
if (RB_TYPE_P(other, T_FIXNUM) || RB_TYPE_P(other, T_BIGNUM)) {
if (f_zero_p(other))
rb_raise_zerodiv();
{
get_dat1(self);
return f_muldiv(self,
dat->num, dat->den,
other, ONE, '/');
}
}
else if (RB_TYPE_P(other, T_FLOAT))
return rb_funcall(f_to_f(self), '/', 1, other);
else if (RB_TYPE_P(other, T_RATIONAL)) {
if (f_zero_p(other))
rb_raise_zerodiv();
{
get_dat2(self, other);
if (f_one_p(self))
return f_rational_new_no_reduce2(CLASS_OF(self),
bdat->den, bdat->num);
return f_muldiv(self,
adat->num, adat->den,
bdat->num, bdat->den, '/');
}
}
else {
return rb_num_coerce_bin(self, other, '/');
}
};T;0To;
; F; ;
;;;I"Rational#quo;F;[[I"
other;T0;[[@i;T;;6;0;[ ;{ ;IC;"Performs division.
Rational(2, 3) / Rational(2, 3) #=> (1/1)
Rational(900) / Rational(1) #=> (900/1)
Rational(-2, 9) / Rational(-9, 2) #=> (4/81)
Rational(9, 8) / 4 #=> (9/32)
Rational(20, 9) / 9.8 #=> 0.22675736961451246
;T;[o;
; I"
overload;F; 0;;5; 0; I"/(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Numeric;T;"@;#[ ;$I"@return [Numeric];T;%0;"@;&0;'F;(i ;[[I" numeric;T0;"@o;
; I"
overload;F; 0;;6; 0; I"quo(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Numeric;T;"@;#[ ;$I"@return [Numeric];T;%0;"@;&0;'F;(i ;[[I" numeric;T0;"@;#[ ;$@;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"static VALUE
nurat_div(VALUE self, VALUE other)
{
if (RB_TYPE_P(other, T_FIXNUM) || RB_TYPE_P(other, T_BIGNUM)) {
if (f_zero_p(other))
rb_raise_zerodiv();
{
get_dat1(self);
return f_muldiv(self,
dat->num, dat->den,
other, ONE, '/');
}
}
else if (RB_TYPE_P(other, T_FLOAT))
return rb_funcall(f_to_f(self), '/', 1, other);
else if (RB_TYPE_P(other, T_RATIONAL)) {
if (f_zero_p(other))
rb_raise_zerodiv();
{
get_dat2(self, other);
if (f_one_p(self))
return f_rational_new_no_reduce2(CLASS_OF(self),
bdat->den, bdat->num);
return f_muldiv(self,
adat->num, adat->den,
bdat->num, bdat->den, '/');
}
}
else {
return rb_num_coerce_bin(self, other, '/');
}
};T;0To;
; F; ;
;;;I"Rational#fdiv;F;[[I"
other;T0;[[@i;T;: fdiv;0;[ ;{ ;IC;"Performs division and returns the value as a float.
Rational(2, 3).fdiv(1) #=> 0.6666666666666666
Rational(2, 3).fdiv(0.5) #=> 1.3333333333333333
Rational(2).fdiv(3) #=> 0.6666666666666666
;T;[o;
; I"
overload;F; 0;;7; 0; I"fdiv(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@;#[ ;$I"@return [Float];T;%0;"@;&0;'F;(i ;[[I" numeric;T0;"@;#[ ;$I"Performs division and returns the value as a float.
Rational(2, 3).fdiv(1) #=> 0.6666666666666666
Rational(2, 3).fdiv(0.5) #=> 1.3333333333333333
Rational(2).fdiv(3) #=> 0.6666666666666666
@overload fdiv(numeric)
@return [Float];T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"static VALUE
nurat_fdiv(VALUE self, VALUE other)
{
if (f_zero_p(other))
return f_div(self, f_to_f(other));
return f_to_f(f_div(self, other));
};T;0To;
; F; ;
;;;I"Rational#**;F;[[I"
other;T0;[[@i;T;:**;0;[ ;{ ;IC;"DPerforms exponentiation.
Rational(2) ** Rational(3) #=> (8/1)
Rational(10) ** -2 #=> (1/100)
Rational(10) ** -2.0 #=> 0.01
Rational(-4) ** Rational(1,2) #=> (1.2246063538223773e-16+2.0i)
Rational(1, 2) ** 0 #=> (1/1)
Rational(1, 2) ** 0.0 #=> 1.0
;T;[o;
; I"
overload;F; 0;;8; 0; I"**(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Numeric;T;"@;#[ ;$I"@return [Numeric];T;%0;"@;&0;'F;(i ;[[I" numeric;T0;"@;#[ ;$I"pPerforms exponentiation.
Rational(2) ** Rational(3) #=> (8/1)
Rational(10) ** -2 #=> (1/100)
Rational(10) ** -2.0 #=> 0.01
Rational(-4) ** Rational(1,2) #=> (1.2246063538223773e-16+2.0i)
Rational(1, 2) ** 0 #=> (1/1)
Rational(1, 2) ** 0.0 #=> 1.0
@overload **(numeric)
@return [Numeric];T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"cstatic VALUE
nurat_expt(VALUE self, VALUE other)
{
if (k_numeric_p(other) && k_exact_zero_p(other))
return f_rational_new_bang1(CLASS_OF(self), ONE);
if (k_rational_p(other)) {
get_dat1(other);
if (f_one_p(dat->den))
other = dat->num; /* c14n */
}
/* Deal with special cases of 0**n and 1**n */
if (k_numeric_p(other) && k_exact_p(other)) {
get_dat1(self);
if (f_one_p(dat->den)) {
if (f_one_p(dat->num)) {
return f_rational_new_bang1(CLASS_OF(self), ONE);
}
else if (f_minus_one_p(dat->num) && k_integer_p(other)) {
return f_rational_new_bang1(CLASS_OF(self), INT2FIX(f_odd_p(other) ? -1 : 1));
}
else if (f_zero_p(dat->num)) {
if (FIX2INT(f_cmp(other, ZERO)) == -1) {
rb_raise_zerodiv();
}
else {
return f_rational_new_bang1(CLASS_OF(self), ZERO);
}
}
}
}
/* General case */
if (RB_TYPE_P(other, T_FIXNUM)) {
{
VALUE num, den;
get_dat1(self);
switch (FIX2INT(f_cmp(other, ZERO))) {
case 1:
num = f_expt(dat->num, other);
den = f_expt(dat->den, other);
break;
case -1:
num = f_expt(dat->den, f_negate(other));
den = f_expt(dat->num, f_negate(other));
break;
default:
num = ONE;
den = ONE;
break;
}
return f_rational_new2(CLASS_OF(self), num, den);
}
}
else if (RB_TYPE_P(other, T_BIGNUM)) {
rb_warn("in a**b, b may be too big");
return f_expt(f_to_f(self), other);
}
else if (RB_TYPE_P(other, T_FLOAT) || RB_TYPE_P(other, T_RATIONAL)) {
return f_expt(f_to_f(self), other);
}
else {
return rb_num_coerce_bin(self, other, id_expt);
}
};T;0To;
; F; ;
;;;I"Rational#<=>;F;[[I"
other;T0;[[@i.;T;:<=>;0;[ ;{ ;IC;"GPerforms comparison and returns -1, 0, or +1.
+nil+ is returned if the two values are incomparable.
Rational(2, 3) <=> Rational(2, 3) #=> 0
Rational(5) <=> 5 #=> 0
Rational(2,3) <=> Rational(1,3) #=> 1
Rational(1,3) <=> 1 #=> -1
Rational(1,3) <=> 0.3 #=> 1
;T;[o;
; I"
overload;F; 0;;9; 0; I"<=>(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [ I"-1;TI"0;TI"+1;TI"nil;T;"@2;#[ ;$I" @return [ -1, 0, +1, nil];T;%0;"@2;&0;'F;(i ;[[I" numeric;T0;"@2;#[ ;$I"~Performs comparison and returns -1, 0, or +1.
+nil+ is returned if the two values are incomparable.
Rational(2, 3) <=> Rational(2, 3) #=> 0
Rational(5) <=> 5 #=> 0
Rational(2,3) <=> Rational(1,3) #=> 1
Rational(1,3) <=> 1 #=> -1
Rational(1,3) <=> 0.3 #=> 1
@overload <=>(numeric)
@return [ -1, 0, +1, nil];T;%0;"@2;'F;)o;*;+T;,i ;-i,;.@; I"static VALUE;T;/I"static VALUE
nurat_cmp(VALUE self, VALUE other)
{
if (RB_TYPE_P(other, T_FIXNUM) || RB_TYPE_P(other, T_BIGNUM)) {
{
get_dat1(self);
if (FIXNUM_P(dat->den) && FIX2LONG(dat->den) == 1)
return f_cmp(dat->num, other); /* c14n */
return f_cmp(self, f_rational_new_bang1(CLASS_OF(self), other));
}
}
else if (RB_TYPE_P(other, T_FLOAT)) {
return f_cmp(f_to_f(self), other);
}
else if (RB_TYPE_P(other, T_RATIONAL)) {
{
VALUE num1, num2;
get_dat2(self, other);
if (FIXNUM_P(adat->num) && FIXNUM_P(adat->den) &&
FIXNUM_P(bdat->num) && FIXNUM_P(bdat->den)) {
num1 = f_imul(FIX2LONG(adat->num), FIX2LONG(bdat->den));
num2 = f_imul(FIX2LONG(bdat->num), FIX2LONG(adat->den));
}
else {
num1 = f_mul(adat->num, bdat->den);
num2 = f_mul(bdat->num, adat->den);
}
return f_cmp(f_sub(num1, num2), ZERO);
}
}
else {
return rb_num_coerce_cmp(self, other, id_cmp);
}
};T;0To;
; F; ;
;;;I"Rational#==;F;[[I"
other;T0;[[@i`;T;:==;0;[ ;{ ;IC;"!Returns true if rat equals object numerically.
Rational(2, 3) == Rational(2, 3) #=> true
Rational(5) == 5 #=> true
Rational(0) == 0.0 #=> true
Rational('1/3') == 0.33 #=> false
Rational('1/2') == '1/2' #=> false
;T;[o;
; I"
overload;F; 0;;:; 0; I"==(object);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@T;#[ ;$I"@return [Boolean];T;%0;"@T;&0;'F;(i ;[[I" object;T0;"@T;#[ ;$I"LReturns true if rat equals object numerically.
Rational(2, 3) == Rational(2, 3) #=> true
Rational(5) == 5 #=> true
Rational(0) == 0.0 #=> true
Rational('1/3') == 0.33 #=> false
Rational('1/2') == '1/2' #=> false
@overload ==(object)
@return [Boolean];T;%0;"@T;'F;)o;*;+T;,iT;-i^;.@; I"static VALUE;T;/I"
static VALUE
nurat_eqeq_p(VALUE self, VALUE other)
{
if (RB_TYPE_P(other, T_FIXNUM) || RB_TYPE_P(other, T_BIGNUM)) {
{
get_dat1(self);
if (f_zero_p(dat->num) && f_zero_p(other))
return Qtrue;
if (!FIXNUM_P(dat->den))
return Qfalse;
if (FIX2LONG(dat->den) != 1)
return Qfalse;
if (f_eqeq_p(dat->num, other))
return Qtrue;
return Qfalse;
}
}
else if (RB_TYPE_P(other, T_FLOAT)) {
return f_eqeq_p(f_to_f(self), other);
}
else if (RB_TYPE_P(other, T_RATIONAL)) {
{
get_dat2(self, other);
if (f_zero_p(adat->num) && f_zero_p(bdat->num))
return Qtrue;
return f_boolcast(f_eqeq_p(adat->num, bdat->num) &&
f_eqeq_p(adat->den, bdat->den));
}
}
else {
return f_eqeq_p(other, self);
}
};T;0To;
; F; ;
;;;I"Rational#coerce;F;[[I"
other;T0;[[@i;T;: coerce;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@s;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"static VALUE
nurat_coerce(VALUE self, VALUE other)
{
if (RB_TYPE_P(other, T_FIXNUM) || RB_TYPE_P(other, T_BIGNUM)) {
return rb_assoc_new(f_rational_new_bang1(CLASS_OF(self), other), self);
}
else if (RB_TYPE_P(other, T_FLOAT)) {
return rb_assoc_new(other, f_to_f(self));
}
else if (RB_TYPE_P(other, T_RATIONAL)) {
return rb_assoc_new(other, self);
}
else if (RB_TYPE_P(other, T_COMPLEX)) {
if (k_exact_zero_p(RCOMPLEX(other)->imag))
return rb_assoc_new(f_rational_new_bang1
(CLASS_OF(self), RCOMPLEX(other)->real), self);
else
return rb_assoc_new(other, rb_Complex(self, INT2FIX(0)));
}
rb_raise(rb_eTypeError, "%s can't be coerced into %s",
rb_obj_classname(other), rb_obj_classname(self));
return Qnil;
};T;0To;
; F; ;
;;;I"Rational#quot;F;[[I"
other;T0;[[@i;T;: quot;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"dstatic VALUE
nurat_quot(VALUE self, VALUE other)
{
return f_truncate(f_div(self, other));
};T;0To;
; F; ;
;;;I"Rational#quotrem;F;[[I"
other;T0;[[@i;T;: quotrem;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"static VALUE
nurat_quotrem(VALUE self, VALUE other)
{
VALUE val = f_truncate(f_div(self, other));
return rb_assoc_new(val, f_sub(self, f_mul(other, val)));
};T;0To;
; F; ;
;;;I"Rational#rational?;F;[ ;[[@i;T;:rational?;0;[ ;{ ;IC;" :nodoc:
;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I" :nodoc:;T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I">static VALUE
nurat_true(VALUE self)
{
return Qtrue;
};T;0To;
; F; ;
;;;I"Rational#exact?;F;[ ;[[@i;T;: exact?;0;[ ;{ ;IC;" :nodoc:
;T;[o;!
; I" return;F; @;0; [@;"@;#[ ;$@;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I">static VALUE
nurat_true(VALUE self)
{
return Qtrue;
};T;0To;
; F; ;
;;;I"Rational#floor;F;[[I"
*args;T0;[[@i5;T;:
floor;0;[ ;{ ;IC;"Returns the truncated value (toward negative infinity).
Rational(3).floor #=> 3
Rational(2, 3).floor #=> 0
Rational(-3, 2).floor #=> -1
decimal - 1 2 3 . 4 5 6
^ ^ ^ ^ ^ ^
precision -3 -2 -1 0 +1 +2
'%f' % Rational('-123.456').floor(+1) #=> "-123.500000"
'%f' % Rational('-123.456').floor(-1) #=> "-130.000000"
;T;[o;
; I"
overload;F; 0;;@; 0; I"
floor;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@;#[ ;$I"@return [Integer];T;%0;"@;&0;'F;(i ;[ ;"@o;
; I"
overload;F; 0;;@; 0; I"floor(precision=0);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[[I"precision;TI"0;T;"@;#[ ;$I"Returns the truncated value (toward negative infinity).
Rational(3).floor #=> 3
Rational(2, 3).floor #=> 0
Rational(-3, 2).floor #=> -1
decimal - 1 2 3 . 4 5 6
^ ^ ^ ^ ^ ^
precision -3 -2 -1 0 +1 +2
'%f' % Rational('-123.456').floor(+1) #=> "-123.500000"
'%f' % Rational('-123.456').floor(-1) #=> "-130.000000"
@overload floor
@return [Integer]
@overload floor(precision=0);T;%0;"@;'F;)o;*;+T;,i#;-i3;.@; I"static VALUE;T;/I"{static VALUE
nurat_floor_n(int argc, VALUE *argv, VALUE self)
{
return f_round_common(argc, argv, self, nurat_floor);
};T;0To;
; F; ;
;;;I"Rational#ceil;F;[[@0;[[@iM;T;: ceil;0;[ ;{ ;IC;"Returns the truncated value (toward positive infinity).
Rational(3).ceil #=> 3
Rational(2, 3).ceil #=> 1
Rational(-3, 2).ceil #=> -1
decimal - 1 2 3 . 4 5 6
^ ^ ^ ^ ^ ^
precision -3 -2 -1 0 +1 +2
'%f' % Rational('-123.456').ceil(+1) #=> "-123.400000"
'%f' % Rational('-123.456').ceil(-1) #=> "-120.000000"
;T;[o;
; I"
overload;F; 0;;A; 0; I" ceil;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@;#[ ;$I"@return [Integer];T;%0;"@;&0;'F;(i ;[ ;"@o;
; I"
overload;F; 0;;A; 0; I"ceil(precision=0);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[[I"precision;TI"0;T;"@;#[ ;$I"Returns the truncated value (toward positive infinity).
Rational(3).ceil #=> 3
Rational(2, 3).ceil #=> 1
Rational(-3, 2).ceil #=> -1
decimal - 1 2 3 . 4 5 6
^ ^ ^ ^ ^ ^
precision -3 -2 -1 0 +1 +2
'%f' % Rational('-123.456').ceil(+1) #=> "-123.400000"
'%f' % Rational('-123.456').ceil(-1) #=> "-120.000000"
@overload ceil
@return [Integer]
@overload ceil(precision=0);T;%0;"@;'F;)o;*;+T;,i;;-iK;.@; I"static VALUE;T;/I"~static VALUE
nurat_ceil_n(int argc, VALUE *argv, VALUE self)
{
return f_round_common(argc, argv, self, nurat_ceil);
};T;0To;
; F; ;
;;;I"Rational#truncate;F;[[@0;[[@ie;T;:
truncate;0;[ ;{ ;IC;"Returns the truncated value (toward zero).
Rational(3).truncate #=> 3
Rational(2, 3).truncate #=> 0
Rational(-3, 2).truncate #=> -1
decimal - 1 2 3 . 4 5 6
^ ^ ^ ^ ^ ^
precision -3 -2 -1 0 +1 +2
'%f' % Rational('-123.456').truncate(+1) #=> "-123.400000"
'%f' % Rational('-123.456').truncate(-1) #=> "-120.000000"
;T;[o;
; I"
overload;F; 0;;B; 0; I"
truncate;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@;#[ ;$I"@return [Integer];T;%0;"@;&0;'F;(i ;[ ;"@o;
; I"
overload;F; 0;;B; 0; I"truncate(precision=0);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[[I"precision;TI"0;T;"@;#[ ;$I"Returns the truncated value (toward zero).
Rational(3).truncate #=> 3
Rational(2, 3).truncate #=> 0
Rational(-3, 2).truncate #=> -1
decimal - 1 2 3 . 4 5 6
^ ^ ^ ^ ^ ^
precision -3 -2 -1 0 +1 +2
'%f' % Rational('-123.456').truncate(+1) #=> "-123.400000"
'%f' % Rational('-123.456').truncate(-1) #=> "-120.000000"
@overload truncate
@return [Integer]
@overload truncate(precision=0);T;%0;"@;'F;)o;*;+T;,iS;-ic;.@; I"static VALUE;T;/I"static VALUE
nurat_truncate_n(int argc, VALUE *argv, VALUE self)
{
return f_round_common(argc, argv, self, nurat_truncate);
};T;0To;
; F; ;
;;;I"Rational#round;F;[[@0;[[@i~;T;:
round;0;[ ;{ ;IC;"Returns the truncated value (toward the nearest integer;
0.5 => 1; -0.5 => -1).
Rational(3).round #=> 3
Rational(2, 3).round #=> 1
Rational(-3, 2).round #=> -2
decimal - 1 2 3 . 4 5 6
^ ^ ^ ^ ^ ^
precision -3 -2 -1 0 +1 +2
'%f' % Rational('-123.456').round(+1) #=> "-123.500000"
'%f' % Rational('-123.456').round(-1) #=> "-120.000000"
;T;[o;
; I"
overload;F; 0;;C; 0; I"
round;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@<;#[ ;$I"@return [Integer];T;%0;"@<;&0;'F;(i ;[ ;"@<o;
; I"
overload;F; 0;;C; 0; I"round(precision=0);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@<;&0;'F;(i ;[[I"precision;TI"0;T;"@<;#[ ;$I"Returns the truncated value (toward the nearest integer;
0.5 => 1; -0.5 => -1).
Rational(3).round #=> 3
Rational(2, 3).round #=> 1
Rational(-3, 2).round #=> -2
decimal - 1 2 3 . 4 5 6
^ ^ ^ ^ ^ ^
precision -3 -2 -1 0 +1 +2
'%f' % Rational('-123.456').round(+1) #=> "-123.500000"
'%f' % Rational('-123.456').round(-1) #=> "-120.000000"
@overload round
@return [Integer]
@overload round(precision=0);T;%0;"@<;'F;)o;*;+T;,ik;-i|;.@; I"static VALUE;T;/I"{static VALUE
nurat_round_n(int argc, VALUE *argv, VALUE self)
{
return f_round_common(argc, argv, self, nurat_round);
};T;0To;
; F; ;
;;;I"Rational#to_i;F;[ ;[[@i;T;: to_i;0;[ ;{ ;IC;"Returns the truncated value as an integer.
Equivalent to
rat.truncate.
Rational(2, 3).to_i #=> 0
Rational(3).to_i #=> 3
Rational(300.6).to_i #=> 300
Rational(98,71).to_i #=> 1
Rational(-30,2).to_i #=> -15
;T;[o;
; I"
overload;F; 0;;D; 0; I" to_i;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@c;#[ ;$I"@return [Integer];T;%0;"@c;&0;'F;(i ;[ ;"@c;#[ ;$I"Returns the truncated value as an integer.
Equivalent to
rat.truncate.
Rational(2, 3).to_i #=> 0
Rational(3).to_i #=> 3
Rational(300.6).to_i #=> 300
Rational(98,71).to_i #=> 1
Rational(-30,2).to_i #=> -15
@overload to_i
@return [Integer];T;%0;"@c;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"static VALUE
nurat_truncate(VALUE self)
{
get_dat1(self);
if (f_negative_p(dat->num))
return f_negate(f_idiv(f_negate(dat->num), dat->den));
return f_idiv(dat->num, dat->den);
};T;0To;
; F; ;
;;;I"Rational#to_f;F;[ ;[[@i;T;: to_f;0;[ ;{ ;IC;"Return the value as a float.
Rational(2).to_f #=> 2.0
Rational(9, 4).to_f #=> 2.25
Rational(-3, 4).to_f #=> -0.75
Rational(20, 3).to_f #=> 6.666666666666667
;T;[o;
; I"
overload;F; 0;;E; 0; I" to_f;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@~;#[ ;$I"@return [Float];T;%0;"@~;&0;'F;(i ;[ ;"@~;#[ ;$I"Return the value as a float.
Rational(2).to_f #=> 2.0
Rational(9, 4).to_f #=> 2.25
Rational(-3, 4).to_f #=> -0.75
Rational(20, 3).to_f #=> 6.666666666666667
@overload to_f
@return [Float];T;%0;"@~;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"gstatic VALUE
nurat_to_f(VALUE self)
{
get_dat1(self);
return f_fdiv(dat->num, dat->den);
};T;0To;
; F; ;
;;;I"Rational#to_r;F;[ ;[[@i;T;: to_r;0;[ ;{ ;IC;"ZReturns self.
Rational(2).to_r #=> (2/1)
Rational(-8, 6).to_r #=> (-4/3)
;T;[o;
; I"
overload;F; 0;;F; 0; I" to_r;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" self;T;"@;#[ ;$I"@return [self];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"|Returns self.
Rational(2).to_r #=> (2/1)
Rational(-8, 6).to_r #=> (-4/3)
@overload to_r
@return [self];T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"=static VALUE
nurat_to_r(VALUE self)
{
return self;
};T;0To;
; F; ;
;;;I"Rational#rationalize;F;[[@0;[[@i;T;:rationalize;0;[ ;{ ;IC;"BReturns a simpler approximation of the value if the optional
argument eps is given (rat-|eps| <= result <= rat+|eps|), self
otherwise.
r = Rational(5033165, 16777216)
r.rationalize #=> (5033165/16777216)
r.rationalize(Rational('0.01')) #=> (3/10)
r.rationalize(Rational('0.1')) #=> (1/3)
;T;[o;
; I"
overload;F; 0;;G; 0; I"rationalize;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" self;T;"@;#[ ;$I"@return [self];T;%0;"@;&0;'F;(i ;[ ;"@o;
; I"
overload;F; 0;;G; 0; I"rationalize(eps);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[[I"eps;T0;"@;#[ ;$I"Returns a simpler approximation of the value if the optional
argument eps is given (rat-|eps| <= result <= rat+|eps|), self
otherwise.
r = Rational(5033165, 16777216)
r.rationalize #=> (5033165/16777216)
r.rationalize(Rational('0.01')) #=> (3/10)
r.rationalize(Rational('0.1')) #=> (1/3)
@overload rationalize
@return [self]
@overload rationalize(eps);T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"static VALUE
nurat_rationalize(int argc, VALUE *argv, VALUE self)
{
VALUE e, a, b, p, q;
if (argc == 0)
return self;
if (f_negative_p(self))
return f_negate(nurat_rationalize(argc, argv, f_abs(self)));
rb_scan_args(argc, argv, "01", &e);
e = f_abs(e);
a = f_sub(self, e);
b = f_add(self, e);
if (f_eqeq_p(a, b))
return self;
nurat_rationalize_internal(a, b, &p, &q);
return f_rational_new2(CLASS_OF(self), p, q);
};T;0To;
; F; ;
;;;I"Rational#hash;F;[ ;[[@i+;T;: hash;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@;'F;)o;*;+T;,i*;-i*;.@; I"static VALUE;T;/I"static VALUE
nurat_hash(VALUE self)
{
st_index_t v, h[2];
VALUE n;
get_dat1(self);
n = rb_hash(dat->num);
h[0] = NUM2LONG(n);
n = rb_hash(dat->den);
h[1] = NUM2LONG(n);
v = rb_memhash(h, sizeof(h));
return LONG2FIX(v);
};T;0To;
; F; ;
;;;I"Rational#to_s;F;[ ;[[@iQ;T;: to_s;0;[ ;{ ;IC;"Returns the value as a string.
Rational(2).to_s #=> "2/1"
Rational(-8, 6).to_s #=> "-4/3"
Rational('1/2').to_s #=> "1/2"
;T;[o;
; I"
overload;F; 0;;I; 0; I" to_s;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@;#[ ;$I"@return [String];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"Returns the value as a string.
Rational(2).to_s #=> "2/1"
Rational(-8, 6).to_s #=> "-4/3"
Rational('1/2').to_s #=> "1/2"
@overload to_s
@return [String];T;%0;"@;'F;)o;*;+T;,iG;-iO;.@; I"static VALUE;T;/I"Ostatic VALUE
nurat_to_s(VALUE self)
{
return f_format(self, f_to_s);
};T;0To;
; F; ;
;;;I"Rational#inspect;F;[ ;[[@ia;T;: inspect;0;[ ;{ ;IC;"Returns the value as a string for inspection.
Rational(2).inspect #=> "(2/1)"
Rational(-8, 6).inspect #=> "(-4/3)"
Rational('1/2').inspect #=> "(1/2)"
;T;[o;
; I"
overload;F; 0;;J; 0; I" inspect;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@;#[ ;$I"@return [String];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"Returns the value as a string for inspection.
Rational(2).inspect #=> "(2/1)"
Rational(-8, 6).inspect #=> "(-4/3)"
Rational('1/2').inspect #=> "(1/2)"
@overload inspect
@return [String];T;%0;"@;'F;)o;*;+T;,iW;-i_;.@; I"static VALUE;T;/I"static VALUE
nurat_inspect(VALUE self)
{
VALUE s;
s = rb_usascii_str_new2("(");
rb_str_concat(s, f_format(self, f_inspect));
rb_str_cat2(s, ")");
return s;
};T;0To;
; F; ;
;: private;I"Rational#marshal_dump;F;[ ;[[@i;T;:marshal_dump;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@ ;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"static VALUE
nurat_marshal_dump(VALUE self)
{
VALUE a;
get_dat1(self);
a = rb_assoc_new(dat->num, dat->den);
rb_copy_generic_ivar(a, self);
return a;
};T;0To; ;IC;[o;
; F; ;
;;K;I"&Rational::compatible#marshal_load;F;[[I"a;T0;[[@i;T;:marshal_load;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@.;'F;)o;*;+T;,i;-i;.@,; I"static VALUE;T;/I"static VALUE
nurat_marshal_load(VALUE self, VALUE a)
{
rb_check_frozen(self);
rb_check_trusted(self);
Check_Type(a, T_ARRAY);
if (RARRAY_LEN(a) != 2)
rb_raise(rb_eArgError, "marshaled rational must have an array whose length is 2 but %ld", RARRAY_LEN(a));
if (f_zero_p(RARRAY_AREF(a, 1)))
rb_raise_zerodiv();
rb_ivar_set(self, id_i_num, RARRAY_AREF(a, 0));
rb_ivar_set(self, id_i_den, RARRAY_AREF(a, 1));
return self;
};T;0T: @owner@,:@class_mixinsIC;[ ;N@,:@instance_mixinsIC;[ ;N@,:@attributesIC:SymbolHash{:
classIC;R{ :@symbolize_valueT;
IC;R{ ;TT;TT:
@aliases{ : @groups[ ;[[@i
;F;:compatible;: ruby;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@,;(i ;.@;I"Rational::compatible;F:@superclasso: YARD::CodeObjects::Proxy :@orignamespace0:@origname0:
@imethod0;: Object;.@: @objo; ;IC;[@o;
; F; ;
;;;I"Object#assert_Qundef;F;[[I"obj;T0[I"msg;T0;[[I"ext/ripper/ripper.c;TiF[I" parse.c;TiF;T;:assert_Qundef;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@P;'F;)o;*;+T;,i~F;-i~F;.@N; I"static VALUE;T;/I"static VALUE
ripper_assert_Qundef(VALUE self, VALUE obj, VALUE msg)
{
StringValue(msg);
if (obj == Qundef) {
rb_raise(rb_eArgError, "%"PRIsVALUE, msg);
}
return Qnil;
};T;0To;
; F; ;
;;;I"Object#rawVALUE;F;[[I"obj;T0;[[@YiF[@[iF;T;:
rawVALUE;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@e;'F;)o;*;+T;,iF;-iF;.@N; I"static VALUE;T;/I"Tstatic VALUE
ripper_value(VALUE self, VALUE obj)
{
return ULONG2NUM(obj);
};T;0To;
; F; ;
;;;I"Object#validate_object;F;[[I"x;T0;[[@YiCE[@[iD;T;:validate_object;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@v;'F;)o;*;+T;,iD;-iD;.@N; I"static VALUE;T;/I"Ustatic VALUE
ripper_validate_object(VALUE self, VALUE x)
{
if (x == Qfalse) return x;
if (x == Qtrue) return x;
if (x == Qnil) return x;
if (x == Qundef)
rb_raise(rb_eArgError, "Qundef given");
if (FIXNUM_P(x)) return x;
if (SYMBOL_P(x)) return x;
if (!rb_is_pointer_to_heap(x))
rb_raise(rb_eArgError, "invalid pointer: %p", x);
switch (BUILTIN_TYPE(x)) {
case T_STRING:
case T_OBJECT:
case T_ARRAY:
case T_BIGNUM:
case T_FLOAT:
case T_COMPLEX:
case T_RATIONAL:
return x;
case T_NODE:
if (nd_type(x) != NODE_RIPPER) {
rb_raise(rb_eArgError, "NODE given: %p", x);
}
return ((NODE *)x)->nd_rval;
default:
rb_raise(rb_eArgError, "wrong type of ruby object: %p (%s)",
x, rb_obj_classname(x));
}
return x;
};T;0To;
; F; ;
;;;I"Object#method;F;[[I"vid;T0;[[I" proc.c;TiE;T;: method;0;[ ;{ ;IC;"@Looks up the named method as a receiver in obj, returning a
Method object (or raising NameError). The
Method object acts as a closure in obj's object
instance, so instance variables and the value of self
remain available.
class Demo
def initialize(n)
@iv = n
end
def hello()
"Hello, @iv = #{@iv}"
end
end
k = Demo.new(99)
m = k.method(:hello)
m.call #=> "Hello, @iv = 99"
l = Demo.new('Fred')
m = l.method("hello")
m.call #=> "Hello, @iv = Fred"
;T;[o;
; I"
overload;F; 0;;c; 0; I"method(sym);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[[I"sym;T0;"@;#[ ;$I"XLooks up the named method as a receiver in obj, returning a
Method object (or raising NameError). The
Method object acts as a closure in obj's object
instance, so instance variables and the value of self
remain available.
class Demo
def initialize(n)
@iv = n
end
def hello()
"Hello, @iv = #{@iv}"
end
end
k = Demo.new(99)
m = k.method(:hello)
m.call #=> "Hello, @iv = 99"
l = Demo.new('Fred')
m = l.method("hello")
m.call #=> "Hello, @iv = Fred"
@overload method(sym);T;%0;"@;'F;)o;*;+T;,i);-iA;.@N; I"
VALUE;T;/I"ZVALUE
rb_obj_method(VALUE obj, VALUE vid)
{
return obj_method(obj, vid, FALSE);
};T;0To;
; F; ;
;;;I"Object#public_method;F;[[I"vid;T0;[[@iR;T;:public_method;0;[ ;{ ;IC;"6Similar to _method_, searches public method only.
;T;[o;
; I"
overload;F; 0;;d; 0; I"public_method(sym);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[[I"sym;T0;"@;#[ ;$I"USimilar to _method_, searches public method only.
@overload public_method(sym);T;%0;"@;'F;)o;*;+T;,iK;-iN;.@N; I"
VALUE;T;/I"`VALUE
rb_obj_public_method(VALUE obj, VALUE vid)
{
return obj_method(obj, vid, TRUE);
};T;0To;
; F; ;
;;;I" Object#singleton_method;F;[[I"vid;T0;[[@ip;T;:singleton_method;0;[ ;{ ;IC;"^Similar to _method_, searches singleton method only.
class Demo
def initialize(n)
@iv = n
end
def hello()
"Hello, @iv = #{@iv}"
end
end
k = Demo.new(99)
def k.hi
"Hi, @iv = #{@iv}"
end
m = k.singleton_method(:hi)
m.call #=> "Hi, @iv = 99"
m = k.singleton_method(:hello) #=> NameError
;T;[o;
; I"
overload;F; 0;;e; 0; I"singleton_method(sym);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[[I"sym;T0;"@;#[ ;$I"Similar to _method_, searches singleton method only.
class Demo
def initialize(n)
@iv = n
end
def hello()
"Hello, @iv = #{@iv}"
end
end
k = Demo.new(99)
def k.hi
"Hi, @iv = #{@iv}"
end
m = k.singleton_method(:hi)
m.call #=> "Hi, @iv = 99"
m = k.singleton_method(:hello) #=> NameError
@overload singleton_method(sym);T;%0;"@;'F;)o;*;+T;,iX;-il;.@N; I"
VALUE;T;/I"VALUE
rb_obj_singleton_method(VALUE obj, VALUE vid)
{
const rb_method_entry_t *me;
VALUE klass;
ID id = rb_check_id(&vid);
if (!id) {
if (!NIL_P(klass = rb_singleton_class_get(obj)) &&
respond_to_missing_p(klass, obj, vid, FALSE)) {
id = rb_intern_str(vid);
return mnew_missing(klass, obj, id, id, rb_cMethod);
}
undef:
rb_name_err_raise("undefined singleton method `%1$s' for `%2$s'",
obj, vid);
}
if (NIL_P(klass = rb_singleton_class_get(obj)) ||
UNDEFINED_METHOD_ENTRY_P(me = rb_method_entry_at(klass, id)) ||
UNDEFINED_REFINED_METHOD_P(me->def)) {
vid = ID2SYM(id);
goto undef;
}
return mnew_from_me(me, klass, obj, id, rb_cMethod, FALSE);
};T;0To;
; F; ;
;;;I"#Object#define_singleton_method;F;[[@0;[[@i];T;: define_singleton_method;0;[ ;{ ;IC;"Defines a singleton method in the receiver. The _method_
parameter can be a +Proc+, a +Method+ or an +UnboundMethod+ object.
If a block is specified, it is used as the method body.
class A
class << self
def class_name
to_s
end
end
end
A.define_singleton_method(:who_am_i) do
"I am: #{class_name}"
end
A.who_am_i # ==> "I am: A"
guy = "Bob"
guy.define_singleton_method(:hello) { "#{self}: Hello there!" }
guy.hello #=> "Bob: Hello there!"
;T;[o;
; I"
overload;F; 0;;f; 0; I",define_singleton_method(symbol, method);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[[I" symbol;T0[I" method;T0;"@o;
; I"
overload;F; 0;;f; 0; I"$define_singleton_method(symbol);T;IC;" ;T;[o;!
; I"
yield;F; I"[];T;0; 0;"@o;!
; I" return;F; I" ;T;0; [I" Proc;T;"@;#[ ;$I" @yield []
@return [Proc];T;%0;"@;&0;'F;(i ;[[I" symbol;T0;"@;#[ ;$I"vDefines a singleton method in the receiver. The _method_
parameter can be a +Proc+, a +Method+ or an +UnboundMethod+ object.
If a block is specified, it is used as the method body.
class A
class << self
def class_name
to_s
end
end
end
A.define_singleton_method(:who_am_i) do
"I am: #{class_name}"
end
A.who_am_i # ==> "I am: A"
guy = "Bob"
guy.define_singleton_method(:hello) { "#{self}: Hello there!" }
guy.hello #=> "Bob: Hello there!"
@overload define_singleton_method(symbol, method)
@overload define_singleton_method(symbol)
@yield []
@return [Proc];T;%0;"@;'F;)o;*;+T;,iC;-i[;.@N; I"static VALUE;T;/I"static VALUE
rb_obj_define_method(int argc, VALUE *argv, VALUE obj)
{
VALUE klass = rb_singleton_class(obj);
return rb_mod_define_method(argc, argv, klass);
};T;0To;
; F; ;
;;;I"Object#to_enum;F;[[@0;[[I"enumerator.c;Ti;T;: to_enum;0;[ ;{ ;IC;"6Creates a new Enumerator which will enumerate by calling +method+ on
+obj+, passing +args+ if any.
If a block is given, it will be used to calculate the size of
the enumerator without the need to iterate it (see Enumerator#size).
=== Examples
str = "xyz"
enum = str.enum_for(:each_byte)
enum.each { |b| puts b }
# => 120
# => 121
# => 122
# protect an array from being modified by some_method
a = [1, 2, 3]
some_method(a.to_enum)
It is typical to call to_enum when defining methods for
a generic Enumerable, in case no block is passed.
Here is such an example, with parameter passing and a sizing block:
module Enumerable
# a generic method to repeat the values of any enumerable
def repeat(n)
raise ArgumentError, "#{n} is negative!" if n < 0
unless block_given?
return to_enum(__method__, n) do # __method__ is :repeat here
sz = size # Call size and multiply by n...
sz * n if sz # but return nil if size itself is nil
end
end
each do |*val|
n.times { yield *val }
end
end
end
%i[hello world].repeat(2) { |w| puts w }
# => Prints 'hello', 'hello', 'world', 'world'
enum = (1..14).repeat(3)
# => returns an Enumerator when called without a block
enum.first(4) # => [1, 1, 1, 2]
enum.size # => 42
;T;[ o;
; I"
overload;F; 0;;g; 0; I"#to_enum(method = :each, *args);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"Enumerator;T;"@;#[ ;$I"@return [Enumerator];T;%0;"@;&0;'F;(i ;[[I" method;TI"
:each;T[I"
*args;T0;"@o;
; I"
overload;F; 0;:
enum_for; 0; I"$enum_for(method = :each, *args);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"Enumerator;T;"@;#[ ;$I"@return [Enumerator];T;%0;"@;&0;'F;(i ;[[I" method;TI"
:each;T[I"
*args;T0;"@o;
; I"
overload;F; 0;;g; 0; I"#to_enum(method = :each, *args);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"
*args;T;"@o;!
; I" return;F; I" ;T;0; [I"Enumerator;T;"@;#[ ;$I"(@yield [*args]
@return [Enumerator];T;%0;"@;&0;'F;(i ;[[I" method;TI"
:each;T[I"
*args;T0;"@o;
; I"
overload;F; 0;;h; 0; I"$enum_for(method = :each, *args);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"
*args;T;"@o;!
; I" return;F; I" ;T;0; [I"Enumerator;T;"@;#[ ;$I"(@yield [*args]
@return [Enumerator];T;%0;"@;&0;'F;(i ;[[I" method;TI"
:each;T[I"
*args;T0;"@;#[ ;$I"\Creates a new Enumerator which will enumerate by calling +method+ on
+obj+, passing +args+ if any.
If a block is given, it will be used to calculate the size of
the enumerator without the need to iterate it (see Enumerator#size).
=== Examples
str = "xyz"
enum = str.enum_for(:each_byte)
enum.each { |b| puts b }
# => 120
# => 121
# => 122
# protect an array from being modified by some_method
a = [1, 2, 3]
some_method(a.to_enum)
It is typical to call to_enum when defining methods for
a generic Enumerable, in case no block is passed.
Here is such an example, with parameter passing and a sizing block:
module Enumerable
# a generic method to repeat the values of any enumerable
def repeat(n)
raise ArgumentError, "#{n} is negative!" if n < 0
unless block_given?
return to_enum(__method__, n) do # __method__ is :repeat here
sz = size # Call size and multiply by n...
sz * n if sz # but return nil if size itself is nil
end
end
each do |*val|
n.times { yield *val }
end
end
end
%i[hello world].repeat(2) { |w| puts w }
# => Prints 'hello', 'hello', 'world', 'world'
enum = (1..14).repeat(3)
# => returns an Enumerator when called without a block
enum.first(4) # => [1, 1, 1, 2]
enum.size # => 42
@overload to_enum(method = :each, *args)
@return [Enumerator]
@overload enum_for(method = :each, *args)
@return [Enumerator]
@overload to_enum(method = :each, *args)
@yield [*args]
@return [Enumerator]
@overload enum_for(method = :each, *args)
@yield [*args]
@return [Enumerator];T;%0;"@;'F;)o;*;+T;,i;-i;.@N; I"static VALUE;T;/I"Qstatic VALUE
obj_to_enum(int argc, VALUE *argv, VALUE obj)
{
VALUE enumerator, meth = sym_each;
if (argc > 0) {
--argc;
meth = *argv++;
}
enumerator = rb_enumeratorize_with_size(obj, meth, argc, argv, 0);
if (rb_block_given_p()) {
enumerator_ptr(enumerator)->size = rb_block_proc();
}
return enumerator;
};T;0To;
; F; ;
;;;I"Object#enum_for;F;[[@0;[[@ i;T;;h;0;[ ;{ ;IC;"6Creates a new Enumerator which will enumerate by calling +method+ on
+obj+, passing +args+ if any.
If a block is given, it will be used to calculate the size of
the enumerator without the need to iterate it (see Enumerator#size).
=== Examples
str = "xyz"
enum = str.enum_for(:each_byte)
enum.each { |b| puts b }
# => 120
# => 121
# => 122
# protect an array from being modified by some_method
a = [1, 2, 3]
some_method(a.to_enum)
It is typical to call to_enum when defining methods for
a generic Enumerable, in case no block is passed.
Here is such an example, with parameter passing and a sizing block:
module Enumerable
# a generic method to repeat the values of any enumerable
def repeat(n)
raise ArgumentError, "#{n} is negative!" if n < 0
unless block_given?
return to_enum(__method__, n) do # __method__ is :repeat here
sz = size # Call size and multiply by n...
sz * n if sz # but return nil if size itself is nil
end
end
each do |*val|
n.times { yield *val }
end
end
end
%i[hello world].repeat(2) { |w| puts w }
# => Prints 'hello', 'hello', 'world', 'world'
enum = (1..14).repeat(3)
# => returns an Enumerator when called without a block
enum.first(4) # => [1, 1, 1, 2]
enum.size # => 42
;T;[ o;
; I"
overload;F; 0;;g; 0; I"#to_enum(method = :each, *args);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"Enumerator;T;"@e;#[ ;$I"@return [Enumerator];T;%0;"@e;&0;'F;(i ;[[I" method;TI"
:each;T[I"
*args;T0;"@eo;
; I"
overload;F; 0;;h; 0; I"$enum_for(method = :each, *args);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"Enumerator;T;"@e;#[ ;$I"@return [Enumerator];T;%0;"@e;&0;'F;(i ;[[I" method;TI"
:each;T[I"
*args;T0;"@eo;
; I"
overload;F; 0;;g; 0; I"#to_enum(method = :each, *args);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"
*args;T;"@eo;!
; I" return;F; I" ;T;0; [I"Enumerator;T;"@e;#[ ;$I"(@yield [*args]
@return [Enumerator];T;%0;"@e;&0;'F;(i ;[[I" method;TI"
:each;T[I"
*args;T0;"@eo;
; I"
overload;F; 0;;h; 0; I"$enum_for(method = :each, *args);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"
*args;T;"@eo;!
; I" return;F; I" ;T;0; [I"Enumerator;T;"@e;#[ ;$I"(@yield [*args]
@return [Enumerator];T;%0;"@e;&0;'F;(i ;[[I" method;TI"
:each;T[I"
*args;T0;"@e;#[ ;$@a;%0;"@e;'F;)o;*;+T;,i;-i;.@N; I"static VALUE;T;/I"Qstatic VALUE
obj_to_enum(int argc, VALUE *argv, VALUE obj)
{
VALUE enumerator, meth = sym_each;
if (argc > 0) {
--argc;
meth = *argv++;
}
enumerator = rb_enumeratorize_with_size(obj, meth, argc, argv, 0);
if (rb_block_given_p()) {
enumerator_ptr(enumerator)->size = rb_block_proc();
}
return enumerator;
};T;0To;
; F; ;
;;;I"Object#display;F;[[@0;[[I" io.c;TiK ;T;: display;0;[ ;{ ;IC;"Prints obj on the given port (default $>).
Equivalent to:
def display(port=$>)
port.write self
end
For example:
1.display
"cat".display
[ 4, 5, 6 ].display
puts
produces:
1cat456
;T;[o;
; I"
overload;F; 0;;i; 0; I"display(port=$>);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@;#[ ;$I"@return [nil];T;%0;"@;&0;'F;(i ;[[I" port;TI"$>;T;"@;#[ ;$I"Prints obj on the given port (default $>).
Equivalent to:
def display(port=$>)
port.write self
end
For example:
1.display
"cat".display
[ 4, 5, 6 ].display
puts
produces:
1cat456
@overload display(port=$>)
@return [nil];T;%0;"@;'F;)o;*;+T;,i4 ;-iH ;.@N; I"static VALUE;T;/I"static VALUE
rb_obj_display(int argc, VALUE *argv, VALUE self)
{
VALUE out;
if (argc == 0) {
out = rb_stdout;
}
else {
rb_scan_args(argc, argv, "01", &out);
}
rb_io_write(out, self);
return Qnil;
};T;0To;
; F; ;
;;;I"Object#extend;F;[[@0;[[I" eval.c;Til;T;: extend;0;[ ;{ ;IC;"sAdds to _obj_ the instance methods from each module given as a
parameter.
module Mod
def hello
"Hello from Mod.\n"
end
end
class Klass
def hello
"Hello from Klass.\n"
end
end
k = Klass.new
k.hello #=> "Hello from Klass.\n"
k.extend(Mod) #=> #
k.hello #=> "Hello from Mod.\n"
;T;[o;
; I"
overload;F; 0;;j; 0; I"extend(module, ...);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@;#[ ;$I"@return [Object];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"Adds to _obj_ the instance methods from each module given as a
parameter.
module Mod
def hello
"Hello from Mod.\n"
end
end
class Klass
def hello
"Hello from Klass.\n"
end
end
k = Klass.new
k.hello #=> "Hello from Klass.\n"
k.extend(Mod) #=> #
k.hello #=> "Hello from Mod.\n"
@overload extend(module, ...)
@return [Object];T;%0;"@;'F;)o;*;+T;,iS;-ii;.@N; I"static VALUE;T;/I"static VALUE
rb_obj_extend(int argc, VALUE *argv, VALUE obj)
{
int i;
ID id_extend_object, id_extended;
CONST_ID(id_extend_object, "extend_object");
CONST_ID(id_extended, "extended");
rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS);
for (i = 0; i < argc; i++)
Check_Type(argv[i], T_MODULE);
while (argc--) {
rb_funcall(argv[argc], id_extend_object, 1, obj);
rb_funcall(argv[argc], id_extended, 1, obj);
}
return obj;
};T;0To;
; F; ;
;;;I"Object#respond_to?;F;[[@0;[[I"vm_method.c;Ti;T;:respond_to?;0;[ ;{ ;IC;"Returns +true+ if _obj_ responds to the given method. Private and
protected methods are included in the search only if the optional
second parameter evaluates to +true+.
If the method is not implemented,
as Process.fork on Windows, File.lchmod on GNU/Linux, etc.,
false is returned.
If the method is not defined, respond_to_missing?
method is called and the result is returned.
When the method name parameter is given as a string, the string is
converted to a symbol.
;T;[o;
; I"
overload;F; 0;;k; 0; I"+respond_to?(symbol, include_all=false);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[[I" symbol;T0[I"include_all;TI"
false;T;"@o;
; I"
overload;F; 0;;k; 0; I"+respond_to?(string, include_all=false);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[[I" string;T0[I"include_all;TI"
false;T;"@o;!
; I" return;F; @;0; [@;"@;#[ ;$I"pReturns +true+ if _obj_ responds to the given method. Private and
protected methods are included in the search only if the optional
second parameter evaluates to +true+.
If the method is not implemented,
as Process.fork on Windows, File.lchmod on GNU/Linux, etc.,
false is returned.
If the method is not defined, respond_to_missing?
method is called and the result is returned.
When the method name parameter is given as a string, the string is
converted to a symbol.
@overload respond_to?(symbol, include_all=false)
@return [Boolean]
@overload respond_to?(string, include_all=false)
@return [Boolean];T;%0;"@;'F;)o;*;+T;,i;-i;.@N; I"static VALUE;T;/I"static VALUE
obj_respond_to(int argc, VALUE *argv, VALUE obj)
{
VALUE mid, priv;
ID id;
rb_thread_t *th = GET_THREAD();
rb_scan_args(argc, argv, "11", &mid, &priv);
if (!(id = rb_check_id(&mid))) {
VALUE ret = basic_obj_respond_to_missing(th, CLASS_OF(obj), obj,
rb_to_symbol(mid), priv);
if (ret == Qundef) ret = Qfalse;
return ret;
}
if (basic_obj_respond_to(th, obj, id, !RTEST(priv)))
return Qtrue;
return Qfalse;
};T;0To;
; F; ;
;;;I" Object#respond_to_missing?;F;[[I"mid;T0[I" priv;T0;[[@i;T;:respond_to_missing?;0;[ ;{ ;IC;"DO NOT USE THIS DIRECTLY.
Hook method to return whether the _obj_ can respond to _id_ method
or not.
When the method name parameter is given as a string, the string is
converted to a symbol.
See #respond_to?, and the example of BasicObject.
;T;[o;
; I"
overload;F; 0;;l; 0; I"-respond_to_missing?(symbol, include_all);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@9;#[ ;$I"@return [Boolean];T;%0;"@9;&0;'F;(i ;[[I" symbol;T0[I"include_all;T0;"@9o;
; I"
overload;F; 0;;l; 0; I"-respond_to_missing?(string, include_all);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@9;#[ ;$I"@return [Boolean];T;%0;"@9;&0;'F;(i ;[[I" string;T0[I"include_all;T0;"@9o;!
; I" return;F; @;0; [@;"@9;#[ ;$I"DO NOT USE THIS DIRECTLY.
Hook method to return whether the _obj_ can respond to _id_ method
or not.
When the method name parameter is given as a string, the string is
converted to a symbol.
See #respond_to?, and the example of BasicObject.
@overload respond_to_missing?(symbol, include_all)
@return [Boolean]
@overload respond_to_missing?(string, include_all)
@return [Boolean];T;%0;"@9;'F;)o;*;+T;,i;-i;.@N; I"static VALUE;T;/I"astatic VALUE
obj_respond_to_missing(VALUE obj, VALUE mid, VALUE priv)
{
return Qfalse;
};T;0To;
; F; ;
;;;I"Object#nil?;F;[ ;[[I"
object.c;TiY;T;: nil?;0;[ ;{ ;IC;"Only the object nil responds true to nil?.
Object.new.nil? #=> false
nil.nil? #=> true
;T;[o;
; I"
overload;F; 0;;m; 0; I" nil?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@p;#[ ;$I"@return [Boolean];T;%0;"@p;&0;'F;(i ;[ ;"@po;!
; I" return;F; @;0; [@;"@p;#[ ;$I"Only the object nil responds true to nil?.
Object.new.nil? #=> false
nil.nil? #=> true
@overload nil?
@return [Boolean];T;%0;"@p;'F;)o;*;+T;,iN;-iU;.@N; I"static VALUE;T;/I"#==, but typically overridden by descendants to provide
meaningful semantics in +case+ statements.
;T;[o;
; I"
overload;F; 0;;n; 0; I"===(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[[I"
other;T0;"@;#[ ;$I"Case Equality -- For class Object, effectively the same as calling
#==, but typically overridden by descendants to provide
meaningful semantics in +case+ statements.
@overload ===(other)
@return [Boolean];T;%0;"@;'F;)o;*;+T;,iQ;-iW;.@N; I"
VALUE;T;/I"VALUE
rb_equal(VALUE obj1, VALUE obj2)
{
VALUE result;
if (obj1 == obj2) return Qtrue;
result = rb_funcall(obj1, id_eq, 1, obj2);
if (RTEST(result)) return Qtrue;
return Qfalse;
};T;0To;
; F; ;
;;;I"Object#=~;F;[[I" obj2;T0;[[@uii;T;:=~;0;[ ;{ ;IC;"Pattern Match---Overridden by descendants (notably
Regexp and String) to provide meaningful
pattern-match semantics.
;T;[o;
; I"
overload;F; 0;;o; 0; I"=~(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@;#[ ;$I"@return [nil];T;%0;"@;&0;'F;(i ;[[I"
other;T0;"@;#[ ;$I"Pattern Match---Overridden by descendants (notably
Regexp and String) to provide meaningful
pattern-match semantics.
@overload =~(other)
@return [nil];T;%0;"@;'F;)o;*;+T;,i`;-if;.@N; I"static VALUE;T;/I"Kstatic VALUE
rb_obj_match(VALUE obj1, VALUE obj2)
{
return Qnil;
};T;0To;
; F; ;
;;;I"Object#!~;F;[[I" obj2;T0;[[@uiw;T;:!~;0;[ ;{ ;IC;"\Returns true if two objects do not match (using the =~
method), otherwise false.
;T;[o;
; I"
overload;F; 0;;p; 0; I"!~(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[[I"
other;T0;"@;#[ ;$I"Returns true if two objects do not match (using the =~
method), otherwise false.
@overload !~(other)
@return [Boolean];T;%0;"@;'F;)o;*;+T;,io;-it;.@N; I"static VALUE;T;/I"static VALUE
rb_obj_not_match(VALUE obj1, VALUE obj2)
{
VALUE result = rb_funcall(obj1, id_match, 1, obj2);
return RTEST(result) ? Qfalse : Qtrue;
};T;0To;
; F; ;
;;;I"Object#eql?;F;[[I" obj2;T0;[[@ui;T;: eql?;0;[ ;{ ;IC;"Equality --- At the Object level, == returns
true only if +obj+ and +other+ are the same object.
Typically, this method is overridden in descendant classes to provide
class-specific meaning.
Unlike ==, the equal? method should never be
overridden by subclasses as it is used to determine object identity
(that is, a.equal?(b) if and only if a is the
same object as b):
obj = "a"
other = obj.dup
obj == other #=> true
obj.equal? other #=> false
obj.equal? obj #=> true
The eql? method returns true if +obj+ and
+other+ refer to the same hash key. This is used by Hash to test members
for equality. For objects of class Object, eql?
is synonymous with ==. Subclasses normally continue this
tradition by aliasing eql? to their overridden ==
method, but there are exceptions. Numeric types, for
example, perform type conversion across ==, but not across
eql?, so:
1 == 1.0 #=> true
1.eql? 1.0 #=> false
;T;[ o;
; I"
overload;F; 0;;:; 0; I"==(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[[I"
other;T0;"@o;
; I"
overload;F; 0;: equal?; 0; I"equal?(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[[I"
other;T0;"@o;
; I"
overload;F; 0;;q; 0; I"eql?(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[[I"
other;T0;"@o;!
; I" return;F; @;0; [@;"@;#[ ;$I"Equality --- At the Object level, == returns
true only if +obj+ and +other+ are the same object.
Typically, this method is overridden in descendant classes to provide
class-specific meaning.
Unlike ==, the equal? method should never be
overridden by subclasses as it is used to determine object identity
(that is, a.equal?(b) if and only if a is the
same object as b):
obj = "a"
other = obj.dup
obj == other #=> true
obj.equal? other #=> false
obj.equal? obj #=> true
The eql? method returns true if +obj+ and
+other+ refer to the same hash key. This is used by Hash to test members
for equality. For objects of class Object, eql?
is synonymous with ==. Subclasses normally continue this
tradition by aliasing eql? to their overridden ==
method, but there are exceptions. Numeric types, for
example, perform type conversion across ==, but not across
eql?, so:
1 == 1.0 #=> true
1.eql? 1.0 #=> false
@overload ==(other)
@return [Boolean]
@overload equal?(other)
@return [Boolean]
@overload eql?(other)
@return [Boolean];T;%0;"@;'F;)o;*;+T;,ik;-i;.@N; I"
VALUE;T;/I"jVALUE
rb_obj_equal(VALUE obj1, VALUE obj2)
{
if (obj1 == obj2) return Qtrue;
return Qfalse;
};T;0To;
; F; ;
;;;I"Object#hash;F;[ ;[[@ui;T;;H;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@,;.@N; I""VALUE rb_obj_hash(VALUE obj);;T;/I""VALUE rb_obj_hash(VALUE obj);;T;0To;
; F; ;
;;;I"Object#<=>;F;[[I" obj2;T0;[[@ui;T;;9;0;[ ;{ ;IC;"Returns 0 if +obj+ and +other+ are the same object
or obj == other, otherwise nil.
The <=> is used by various methods to compare objects, for example
Enumerable#sort, Enumerable#max etc.
Your implementation of <=> should return one of the following values: -1, 0,
1 or nil. -1 means self is smaller than other. 0 means self is equal to other.
1 means self is bigger than other. Nil means the two values could not be
compared.
When you define <=>, you can include Comparable to gain the methods
<=, <, ==, >=, > and between?.
;T;[o;
; I"
overload;F; 0;;9; 0; I"<=>(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"nil;T;"@8;#[ ;$I"@return [0, nil];T;%0;"@8;&0;'F;(i ;[[I"
other;T0;"@8;#[ ;$I"Returns 0 if +obj+ and +other+ are the same object
or obj == other, otherwise nil.
The <=> is used by various methods to compare objects, for example
Enumerable#sort, Enumerable#max etc.
Your implementation of <=> should return one of the following values: -1, 0,
1 or nil. -1 means self is smaller than other. 0 means self is equal to other.
1 means self is bigger than other. Nil means the two values could not be
compared.
When you define <=>, you can include Comparable to gain the methods
<=, <, ==, >=, > and between?.
@overload <=>(other)
@return [0, nil];T;%0;"@8;'F;)o;*;+T;,i;-i;.@N; I"static VALUE;T;/I"static VALUE
rb_obj_cmp(VALUE obj1, VALUE obj2)
{
if (obj1 == obj2 || rb_equal(obj1, obj2))
return INT2FIX(0);
return Qnil;
};T;0To;
; F; ;
;;;I"Object#class;F;[ ;[[@ui;T;;S;0;[ ;{ ;IC;"Returns the class of obj. This method must always be
called with an explicit receiver, as class is also a
reserved word in Ruby.
1.class #=> Fixnum
self.class #=> Object
;T;[o;
; I"
overload;F; 0;;S; 0; I"
class;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Class;T;"@X;#[ ;$I"@return [Class];T;%0;"@X;&0;'F;(i ;[ ;"@X;#[ ;$I"Returns the class of obj. This method must always be
called with an explicit receiver, as class is also a
reserved word in Ruby.
1.class #=> Fixnum
self.class #=> Object
@overload class
@return [Class];T;%0;"@X;'F;)o;*;+T;,i;-i;.@N; I"
VALUE;T;/I"OVALUE
rb_obj_class(VALUE obj)
{
return rb_class_real(CLASS_OF(obj));
};T;0To;
; F; ;
;;;I"Object#singleton_class;F;[ ;[[@ui;T;:singleton_class;0;[ ;{ ;IC;"Returns the singleton class of obj. This method creates
a new singleton class if obj does not have one.
If obj is nil, true, or
false, it returns NilClass, TrueClass, or FalseClass,
respectively.
If obj is a Fixnum or a Symbol, it raises a TypeError.
Object.new.singleton_class #=> #>
String.singleton_class #=> #
nil.singleton_class #=> NilClass
;T;[o;
; I"
overload;F; 0;;s; 0; I"singleton_class;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Class;T;"@s;#[ ;$I"@return [Class];T;%0;"@s;&0;'F;(i ;[ ;"@s;#[ ;$I"Returns the singleton class of obj. This method creates
a new singleton class if obj does not have one.
If obj is nil, true, or
false, it returns NilClass, TrueClass, or FalseClass,
respectively.
If obj is a Fixnum or a Symbol, it raises a TypeError.
Object.new.singleton_class #=> #>
String.singleton_class #=> #
nil.singleton_class #=> NilClass
@overload singleton_class
@return [Class];T;%0;"@s;'F;)o;*;+T;,i;-i;.@N; I"static VALUE;T;/I"[static VALUE
rb_obj_singleton_class(VALUE obj)
{
return rb_singleton_class(obj);
};T;0To;
; F; ;
;;;I"Object#clone;F;[ ;[[@uiD;T;:
clone;0;[ ;{ ;IC;"Produces a shallow copy of obj---the instance variables of
obj are copied, but not the objects they reference.
clone copies the frozen and tainted state of obj.
See also the discussion under Object#dup.
class Klass
attr_accessor :str
end
s1 = Klass.new #=> #
s1.str = "Hello" #=> "Hello"
s2 = s1.clone #=> #
s2.str[1,4] = "i" #=> "i"
s1.inspect #=> "#"
s2.inspect #=> "#"
This method may have class-specific behavior. If so, that
behavior will be documented under the #+initialize_copy+ method of
the class.
;T;[o;
; I"
overload;F; 0;;t; 0; I"
clone;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@;#[ ;$I"@return [Object];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"Produces a shallow copy of obj---the instance variables of
obj are copied, but not the objects they reference.
clone copies the frozen and tainted state of obj.
See also the discussion under Object#dup.
class Klass
attr_accessor :str
end
s1 = Klass.new #=> #
s1.str = "Hello" #=> "Hello"
s2 = s1.clone #=> #
s2.str[1,4] = "i" #=> "i"
s1.inspect #=> "#"
s2.inspect #=> "#"
This method may have class-specific behavior. If so, that
behavior will be documented under the #+initialize_copy+ method of
the class.
@overload clone
@return [Object];T;%0;"@;'F;)o;*;+T;,i,;-iA;.@N; I"
VALUE;T;/I"VALUE
rb_obj_clone(VALUE obj)
{
VALUE clone;
VALUE singleton;
if (rb_special_const_p(obj)) {
rb_raise(rb_eTypeError, "can't clone %s", rb_obj_classname(obj));
}
clone = rb_obj_alloc(rb_obj_class(obj));
RBASIC(clone)->flags &= (FL_TAINT|FL_PROMOTED0|FL_PROMOTED1);
RBASIC(clone)->flags |= RBASIC(obj)->flags & ~(FL_PROMOTED0|FL_PROMOTED1|FL_FREEZE|FL_FINALIZE);
singleton = rb_singleton_class_clone_and_attach(obj, clone);
RBASIC_SET_CLASS(clone, singleton);
if (FL_TEST(singleton, FL_SINGLETON)) {
rb_singleton_class_attached(singleton, clone);
}
init_copy(clone, obj);
rb_funcall(clone, id_init_clone, 1, obj);
RBASIC(clone)->flags |= RBASIC(obj)->flags & FL_FREEZE;
return clone;
};T;0To;
; F; ;
;;;I"Object#dup;F;[ ;[[@ui;T;:dup;0;[ ;{ ;IC;" Produces a shallow copy of obj---the instance variables of
obj are copied, but not the objects they reference.
dup copies the tainted state of obj.
This method may have class-specific behavior. If so, that
behavior will be documented under the #+initialize_copy+ method of
the class.
=== on dup vs clone
In general, clone and dup may have different
semantics in descendant classes. While clone is used to
duplicate an object, including its internal state, dup
typically uses the class of the descendant object to create the new
instance.
When using #dup, any modules that the object has been extended with will not
be copied.
class Klass
attr_accessor :str
end
module Foo
def foo; 'foo'; end
end
s1 = Klass.new #=> #
s1.extend(Foo) #=> #
s1.foo #=> "foo"
s2 = s1.clone #=> #
s2.foo #=> "foo"
s3 = s1.dup #=> #
s3.foo #=> NoMethodError: undefined method `foo' for #
;T;[o;
; I"
overload;F; 0;;u; 0; I"dup;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@;#[ ;$I"@return [Object];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"@Produces a shallow copy of obj---the instance variables of
obj are copied, but not the objects they reference.
dup copies the tainted state of obj.
This method may have class-specific behavior. If so, that
behavior will be documented under the #+initialize_copy+ method of
the class.
=== on dup vs clone
In general, clone and dup may have different
semantics in descendant classes. While clone is used to
duplicate an object, including its internal state, dup
typically uses the class of the descendant object to create the new
instance.
When using #dup, any modules that the object has been extended with will not
be copied.
class Klass
attr_accessor :str
end
module Foo
def foo; 'foo'; end
end
s1 = Klass.new #=> #
s1.extend(Foo) #=> #
s1.foo #=> "foo"
s2 = s1.clone #=> #
s2.foo #=> "foo"
s3 = s1.dup #=> #
s3.foo #=> NoMethodError: undefined method `foo' for #
@overload dup
@return [Object];T;%0;"@;'F;)o;*;+T;,i^;-i;.@N; I"
VALUE;T;/I" VALUE
rb_obj_dup(VALUE obj)
{
VALUE dup;
if (rb_special_const_p(obj)) {
rb_raise(rb_eTypeError, "can't dup %s", rb_obj_classname(obj));
}
dup = rb_obj_alloc(rb_obj_class(obj));
init_copy(dup, obj);
rb_funcall(dup, id_init_dup, 1, obj);
return dup;
};T;0To;
; F; ;
;;;I"Object#itself;F;[ ;[[@ui;T;: itself;0;[ ;{ ;IC;"sReturns obj.
string = 'my string' #=> "my string"
string.itself.object_id == string.object_id #=> true
;T;[o;
; I"
overload;F; 0;;v; 0; I" itself;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@;#[ ;$I"@return [Object];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"Returns obj.
string = 'my string' #=> "my string"
string.itself.object_id == string.object_id #=> true
@overload itself
@return [Object];T;%0;"@;'F;)o;*;+T;,i;-i;.@N; I"static VALUE;T;/I">static VALUE
rb_obj_itself(VALUE obj)
{
return obj;
};T;0To;
; F; ;
;;;I"Object#initialize_copy;F;[[I" orig;T0;[[@ui;T;:initialize_copy;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@;'F;)o;*;+T;,i;-i;.@N; I"
VALUE;T;/I"6VALUE
rb_obj_init_copy(VALUE obj, VALUE orig)
{
if (obj == orig) return obj;
rb_check_frozen(obj);
rb_check_trusted(obj);
if (TYPE(obj) != TYPE(orig) || rb_obj_class(obj) != rb_obj_class(orig)) {
rb_raise(rb_eTypeError, "initialize_copy should take same class object");
}
return obj;
};T;0To;
; F; ;
;;;I"Object#initialize_dup;F;[[I" orig;T0;[[@ui;T;:initialize_dup;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@;'F;)o;*;+T;,i;-i;.@N; I"
VALUE;T;/I"wVALUE
rb_obj_init_dup_clone(VALUE obj, VALUE orig)
{
rb_funcall(obj, id_init_copy, 1, orig);
return obj;
};T;0To;
; F; ;
;;;I" Object#initialize_clone;F;[[I" orig;T0;[[@ui;T;:initialize_clone;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$@;%0;"@;'F;)o;*;+T;,i;-i;.@N; I"
VALUE;T;/I"wVALUE
rb_obj_init_dup_clone(VALUE obj, VALUE orig)
{
rb_funcall(obj, id_init_copy, 1, orig);
return obj;
};T;0To;
; F; ;
;;;I"Object#taint;F;[ ;[[@ui;T;:
taint;0;[ ;{ ;IC;"Mark the object as tainted.
Objects that are marked as tainted will be restricted from various built-in
methods. This is to prevent insecure data, such as command-line arguments
or strings read from Kernel#gets, from inadvertently compromising the user's
system.
To check whether an object is tainted, use #tainted?.
You should only untaint a tainted object if your code has inspected it and
determined that it is safe. To do so use #untaint.
;T;[o;
; I"
overload;F; 0;;z; 0; I"
taint;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@;#[ ;$I"@return [Object];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"Mark the object as tainted.
Objects that are marked as tainted will be restricted from various built-in
methods. This is to prevent insecure data, such as command-line arguments
or strings read from Kernel#gets, from inadvertently compromising the user's
system.
To check whether an object is tainted, use #tainted?.
You should only untaint a tainted object if your code has inspected it and
determined that it is safe. To do so use #untaint.
@overload taint
@return [Object];T;%0;"@;'F;)o;*;+T;,i;-i;.@N; I"
VALUE;T;/I"VALUE
rb_obj_taint(VALUE obj)
{
if (!OBJ_TAINTED(obj) && OBJ_TAINTABLE(obj)) {
rb_check_frozen(obj);
OBJ_TAINT(obj);
}
return obj;
};T;0To;
; F; ;
;;;I"Object#tainted?;F;[ ;[[@ui;T;:
tainted?;0;[ ;{ ;IC;"MReturns true if the object is tainted.
See #taint for more information.
;T;[o;
; I"
overload;F; 0;;{; 0; I"
tainted?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@);#[ ;$I"@return [Boolean];T;%0;"@);&0;'F;(i ;[ ;"@)o;!
; I" return;F; @;0; [@;"@);#[ ;$I"vReturns true if the object is tainted.
See #taint for more information.
@overload tainted?
@return [Boolean];T;%0;"@);'F;)o;*;+T;,i;-i;.@N; I"
VALUE;T;/I"dVALUE
rb_obj_tainted(VALUE obj)
{
if (OBJ_TAINTED(obj))
return Qtrue;
return Qfalse;
};T;0To;
; F; ;
;;;I"Object#untaint;F;[ ;[[@ui;T;: untaint;0;[ ;{ ;IC;"PRemoves the tainted mark from the object.
See #taint for more information.
;T;[o;
; I"
overload;F; 0;;|; 0; I" untaint;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@G;#[ ;$I"@return [Object];T;%0;"@G;&0;'F;(i ;[ ;"@G;#[ ;$I"wRemoves the tainted mark from the object.
See #taint for more information.
@overload untaint
@return [Object];T;%0;"@G;'F;)o;*;+T;,i;-i;.@N; I"
VALUE;T;/I"VALUE
rb_obj_untaint(VALUE obj)
{
if (OBJ_TAINTED(obj)) {
rb_check_frozen(obj);
FL_UNSET(obj, FL_TAINT);
}
return obj;
};T;0To;
; F; ;
;;;I"Object#untrust;F;[ ;[[@ui;T;: untrust;0;[ ;{ ;IC;"4Deprecated method that is equivalent to #taint.
;T;[o;
; I"
overload;F; 0;;}; 0; I" untrust;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@b;#[ ;$I"@return [Object];T;%0;"@b;&0;'F;(i ;[ ;"@b;#[ ;$I"[Deprecated method that is equivalent to #taint.
@overload untrust
@return [Object];T;%0;"@b;'F;)o;*;+T;,i;-i;.@N; I"
VALUE;T;/I"VALUE
rb_obj_untrust(VALUE obj)
{
rb_warning("untrust is deprecated and its behavior is same as taint");
return rb_obj_taint(obj);
};T;0To;
; F; ;
;;;I"Object#untrusted?;F;[ ;[[@ui;T;:untrusted?;0;[ ;{ ;IC;"7Deprecated method that is equivalent to #tainted?.
;T;[o;
; I"
overload;F; 0;;~; 0; I"untrusted?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@};#[ ;$I"@return [Boolean];T;%0;"@};&0;'F;(i ;[ ;"@}o;!
; I" return;F; @;0; [@;"@};#[ ;$I"bDeprecated method that is equivalent to #tainted?.
@overload untrusted?
@return [Boolean];T;%0;"@};'F;)o;*;+T;,i;-i;.@N; I"
VALUE;T;/I"VALUE
rb_obj_untrusted(VALUE obj)
{
rb_warning("untrusted? is deprecated and its behavior is same as tainted?");
return rb_obj_tainted(obj);
};T;0To;
; F; ;
;;;I"Object#trust;F;[ ;[[@ui;T;:
trust;0;[ ;{ ;IC;"6Deprecated method that is equivalent to #untaint.
;T;[o;
; I"
overload;F; 0;;; 0; I"
trust;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@;#[ ;$I"@return [Object];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"[Deprecated method that is equivalent to #untaint.
@overload trust
@return [Object];T;%0;"@;'F;)o;*;+T;,i;-i;.@N; I"
VALUE;T;/I"VALUE
rb_obj_trust(VALUE obj)
{
rb_warning("trust is deprecated and its behavior is same as untaint");
return rb_obj_untaint(obj);
};T;0To;
; F; ;
;;;I"Object#freeze;F;[ ;[[@ui+;T;: freeze;0;[ ;{ ;IC;"Prevents further modifications to obj. A
RuntimeError will be raised if modification is attempted.
There is no way to unfreeze a frozen object. See also
Object#frozen?.
This method returns self.
a = [ "a", "b", "c" ]
a.freeze
a << "z"
produces:
prog.rb:3:in `<<': can't modify frozen Array (RuntimeError)
from prog.rb:3
Objects of the following classes are always frozen: Fixnum,
Bignum, Float, Symbol.
;T;[o;
; I"
overload;F; 0;;{; 0; I" freeze;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@;#[ ;$I"@return [Object];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"Prevents further modifications to obj. A
RuntimeError will be raised if modification is attempted.
There is no way to unfreeze a frozen object. See also
Object#frozen?.
This method returns self.
a = [ "a", "b", "c" ]
a.freeze
a << "z"
produces:
prog.rb:3:in `<<': can't modify frozen Array (RuntimeError)
from prog.rb:3
Objects of the following classes are always frozen: Fixnum,
Bignum, Float, Symbol.
@overload freeze
@return [Object];T;%0;"@;'F;)o;*;+T;,i;-i(;.@N; I"
VALUE;T;/I"VALUE
rb_obj_freeze(VALUE obj)
{
if (!OBJ_FROZEN(obj)) {
OBJ_FREEZE(obj);
if (SPECIAL_CONST_P(obj)) {
rb_bug("special consts should be frozen.");
}
}
return obj;
};T;0To;
; F; ;
;;;I"Object#frozen?;F;[ ;[[@uiB;T;: frozen?;0;[ ;{ ;IC;"}Returns the freeze status of obj.
a = [ "a", "b", "c" ]
a.freeze #=> ["a", "b", "c"]
a.frozen? #=> true
;T;[o;
; I"
overload;F; 0;;|; 0; I" frozen?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[ ;"@o;!
; I" return;F; @;0; [@;"@;#[ ;$I"Returns the freeze status of obj.
a = [ "a", "b", "c" ]
a.freeze #=> ["a", "b", "c"]
a.frozen? #=> true
@overload frozen?
@return [Boolean];T;%0;"@;'F;)o;*;+T;,i7;-i?;.@N; I"
VALUE;T;/I"VVALUE
rb_obj_frozen_p(VALUE obj)
{
return OBJ_FROZEN(obj) ? Qtrue : Qfalse;
};T;0To;
; F; ;
;;;I"Object#to_s;F;[ ;[[@ui;T;;I;0;[ ;{ ;IC;"Returns a string representing obj. The default
to_s prints the object's class and an encoding of the
object id. As a special case, the top-level object that is the
initial execution context of Ruby programs returns ``main''.
;T;[o;
; I"
overload;F; 0;;I; 0; I" to_s;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@;#[ ;$I"@return [String];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"Returns a string representing obj. The default
to_s prints the object's class and an encoding of the
object id. As a special case, the top-level object that is the
initial execution context of Ruby programs returns ``main''.
@overload to_s
@return [String];T;%0;"@;'F;)o;*;+T;,i;-i;.@N; I"
VALUE;T;/I"VALUE
rb_any_to_s(VALUE obj)
{
VALUE str;
VALUE cname = rb_class_name(CLASS_OF(obj));
str = rb_sprintf("#<%"PRIsVALUE":%p>", cname, (void*)obj);
OBJ_INFECT(str, obj);
return str;
};T;0To;
; F; ;
;;;I"Object#inspect;F;[ ;[[@ui.;T;;J;0;[ ;{ ;IC;"=Returns a string containing a human-readable representation of obj.
The default inspect shows the object's class name,
an encoding of the object id, and a list of the instance variables and
their values (by calling #inspect on each of them).
User defined classes should override this method to provide a better
representation of obj. When overriding this method, it should
return a string whose encoding is compatible with the default external
encoding.
[ 1, 2, 3..4, 'five' ].inspect #=> "[1, 2, 3..4, \"five\"]"
Time.new.inspect #=> "2008-03-08 19:43:39 +0900"
class Foo
end
Foo.new.inspect #=> "#"
class Bar
def initialize
@bar = 1
end
end
Bar.new.inspect #=> "#"
;T;[o;
; I"
overload;F; 0;;J; 0; I" inspect;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@
;#[ ;$I"@return [String];T;%0;"@
;&0;'F;(i ;[ ;"@
;#[ ;$I"dReturns a string containing a human-readable representation of obj.
The default inspect shows the object's class name,
an encoding of the object id, and a list of the instance variables and
their values (by calling #inspect on each of them).
User defined classes should override this method to provide a better
representation of obj. When overriding this method, it should
return a string whose encoding is compatible with the default external
encoding.
[ 1, 2, 3..4, 'five' ].inspect #=> "[1, 2, 3..4, \"five\"]"
Time.new.inspect #=> "2008-03-08 19:43:39 +0900"
class Foo
end
Foo.new.inspect #=> "#"
class Bar
def initialize
@bar = 1
end
end
Bar.new.inspect #=> "#"
@overload inspect
@return [String];T;%0;"@
;'F;)o;*;+T;,i;-i+;.@N; I"static VALUE;T;/I" static VALUE
rb_obj_inspect(VALUE obj)
{
if (rb_ivar_count(obj) > 0) {
VALUE str;
VALUE c = rb_class_name(CLASS_OF(obj));
str = rb_sprintf("-<%"PRIsVALUE":%p", c, (void*)obj);
return rb_exec_recursive(inspect_obj, obj, str);
}
else {
return rb_any_to_s(obj);
}
};T;0To;
; F; ;
;;;I"Object#methods;F;[[@0;[[I" class.c;Ti#;T;: methods;0;[ ;{ ;IC;"+Returns a list of the names of public and protected methods of
obj. This will include all the methods accessible in
obj's ancestors.
If the optional parameter is false, it
returns an array of obj's public and protected singleton methods,
the array will not include methods in modules included in obj.
class Klass
def klass_method()
end
end
k = Klass.new
k.methods[0..9] #=> [:klass_method, :nil?, :===,
# :==~, :!, :eql?
# :hash, :<=>, :class, :singleton_class]
k.methods.length #=> 56
k.methods(false) #=> []
def k.singleton_method; end
k.methods(false) #=> [:singleton_method]
module M123; def m123; end end
k.extend M123
k.methods(false) #=> [:singleton_method]
;T;[o;
; I"
overload;F; 0;;}; 0; I"methods(regular=true);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@%;#[ ;$I"@return [Array];T;%0;"@%;&0;'F;(i ;[[I" regular;TI" true;T;"@%;#[ ;$I"_Returns a list of the names of public and protected methods of
obj. This will include all the methods accessible in
obj's ancestors.
If the optional parameter is false, it
returns an array of obj's public and protected singleton methods,
the array will not include methods in modules included in obj.
class Klass
def klass_method()
end
end
k = Klass.new
k.methods[0..9] #=> [:klass_method, :nil?, :===,
# :==~, :!, :eql?
# :hash, :<=>, :class, :singleton_class]
k.methods.length #=> 56
k.methods(false) #=> []
def k.singleton_method; end
k.methods(false) #=> [:singleton_method]
module M123; def m123; end end
k.extend M123
k.methods(false) #=> [:singleton_method]
@overload methods(regular=true)
@return [Array];T;%0;"@%;'F;)o;*;+T;,i;-i ;.@N; I"
VALUE;T;/I"VALUE
rb_obj_methods(int argc, const VALUE *argv, VALUE obj)
{
rb_check_arity(argc, 0, 1);
if (argc > 0 && !RTEST(argv[0])) {
return rb_obj_singleton_methods(argc, argv, obj);
}
return class_instance_method_list(argc, argv, CLASS_OF(obj), 1, ins_methods_i);
};T;0To;
; F; ;
;;;I" Object#singleton_methods;F;[[@0;[[@+i{;T;:singleton_methods;0;[ ;{ ;IC;"JReturns an array of the names of singleton methods for obj.
If the optional all parameter is true, the list will include
methods in modules included in obj.
Only public and protected singleton methods are returned.
module Other
def three() end
end
class Single
def Single.four() end
end
a = Single.new
def a.one()
end
class << a
include Other
def two()
end
end
Single.singleton_methods #=> [:four]
a.singleton_methods(false) #=> [:two, :one]
a.singleton_methods #=> [:two, :one, :three]
;T;[o;
; I"
overload;F; 0;;~; 0; I" singleton_methods(all=true);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@E;#[ ;$I"@return [Array];T;%0;"@E;&0;'F;(i ;[[I"all;TI" true;T;"@E;#[ ;$I"Returns an array of the names of singleton methods for obj.
If the optional all parameter is true, the list will include
methods in modules included in obj.
Only public and protected singleton methods are returned.
module Other
def three() end
end
class Single
def Single.four() end
end
a = Single.new
def a.one()
end
class << a
include Other
def two()
end
end
Single.singleton_methods #=> [:four]
a.singleton_methods(false) #=> [:two, :one]
a.singleton_methods #=> [:two, :one, :three]
@overload singleton_methods(all=true)
@return [Array];T;%0;"@E;'F;)o;*;+T;,iZ;-ix;.@N; I"
VALUE;T;/I"VALUE
rb_obj_singleton_methods(int argc, const VALUE *argv, VALUE obj)
{
VALUE recur, ary, klass, origin;
struct method_entry_arg me_arg;
struct rb_id_table *mtbl;
if (argc == 0) {
recur = Qtrue;
}
else {
rb_scan_args(argc, argv, "01", &recur);
}
klass = CLASS_OF(obj);
origin = RCLASS_ORIGIN(klass);
me_arg.list = st_init_numtable();
me_arg.recur = RTEST(recur);
if (klass && FL_TEST(klass, FL_SINGLETON)) {
if ((mtbl = RCLASS_M_TBL(origin)) != 0) rb_id_table_foreach(mtbl, method_entry_i, &me_arg);
klass = RCLASS_SUPER(klass);
}
if (RTEST(recur)) {
while (klass && (FL_TEST(klass, FL_SINGLETON) || RB_TYPE_P(klass, T_ICLASS))) {
if (klass != origin && (mtbl = RCLASS_M_TBL(klass)) != 0) rb_id_table_foreach(mtbl, method_entry_i, &me_arg);
klass = RCLASS_SUPER(klass);
}
}
ary = rb_ary_new();
st_foreach(me_arg.list, ins_methods_i, ary);
st_free_table(me_arg.list);
return ary;
};T;0To;
; F; ;
;;;I" Object#protected_methods;F;[[@0;[[@+i6;T;:protected_methods;0;[ ;{ ;IC;"Returns the list of protected methods accessible to obj. If
the all parameter is set to false, only those methods
in the receiver will be listed.
;T;[o;
; I"
overload;F; 0;;; 0; I" protected_methods(all=true);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@d;#[ ;$I"@return [Array];T;%0;"@d;&0;'F;(i ;[[I"all;TI" true;T;"@d;#[ ;$I"Returns the list of protected methods accessible to obj. If
the all parameter is set to false, only those methods
in the receiver will be listed.
@overload protected_methods(all=true)
@return [Array];T;%0;"@d;'F;)o;*;+T;,i-;-i3;.@N; I"
VALUE;T;/I"VALUE
rb_obj_protected_methods(int argc, const VALUE *argv, VALUE obj)
{
return class_instance_method_list(argc, argv, CLASS_OF(obj), 1, ins_methods_prot_i);
};T;0To;
; F; ;
;;;I"Object#private_methods;F;[[@0;[[@+iE;T;:private_methods;0;[ ;{ ;IC;"Returns the list of private methods accessible to obj. If
the all parameter is set to false, only those methods
in the receiver will be listed.
;T;[o;
; I"
overload;F; 0;;; 0; I" private_methods(all=true);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@;#[ ;$I"@return [Array];T;%0;"@;&0;'F;(i ;[[I"all;TI" true;T;"@;#[ ;$I"Returns the list of private methods accessible to obj. If
the all parameter is set to false, only those methods
in the receiver will be listed.
@overload private_methods(all=true)
@return [Array];T;%0;"@;'F;)o;*;+T;,i<;-iB;.@N; I"
VALUE;T;/I"VALUE
rb_obj_private_methods(int argc, const VALUE *argv, VALUE obj)
{
return class_instance_method_list(argc, argv, CLASS_OF(obj), 1, ins_methods_priv_i);
};T;0To;
; F; ;
;;;I"Object#public_methods;F;[[@0;[[@+iT;T;:public_methods;0;[ ;{ ;IC;"Returns the list of public methods accessible to obj. If
the all parameter is set to false, only those methods
in the receiver will be listed.
;T;[o;
; I"
overload;F; 0;;; 0; I" public_methods(all=true);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@;#[ ;$I"@return [Array];T;%0;"@;&0;'F;(i ;[[I"all;TI" true;T;"@;#[ ;$I"Returns the list of public methods accessible to obj. If
the all parameter is set to false, only those methods
in the receiver will be listed.
@overload public_methods(all=true)
@return [Array];T;%0;"@;'F;)o;*;+T;,iK;-iQ;.@N; I"
VALUE;T;/I"VALUE
rb_obj_public_methods(int argc, const VALUE *argv, VALUE obj)
{
return class_instance_method_list(argc, argv, CLASS_OF(obj), 1, ins_methods_pub_i);
};T;0To;
; F; ;
;;;I" Object#instance_variables;F;[ ;[[I"variable.c;Ti;T;:instance_variables;0;[ ;{ ;IC;" Returns an array of instance variable names for the receiver. Note
that simply defining an accessor does not create the corresponding
instance variable.
class Fred
attr_accessor :a1
def initialize
@iv = 3
end
end
Fred.new.instance_variables #=> [:@iv]
;T;[o;
; I"
overload;F; 0;;; 0; I"instance_variables;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@;#[ ;$I"@return [Array];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"NReturns an array of instance variable names for the receiver. Note
that simply defining an accessor does not create the corresponding
instance variable.
class Fred
attr_accessor :a1
def initialize
@iv = 3
end
end
Fred.new.instance_variables #=> [:@iv]
@overload instance_variables
@return [Array];T;%0;"@;'F;)o;*;+T;,iq;-i;.@N; I"
VALUE;T;/I"VALUE
rb_obj_instance_variables(VALUE obj)
{
VALUE ary;
ary = rb_ary_new();
rb_ivar_foreach(obj, ivar_i, ary);
return ary;
};T;0To;
; F; ;
;;;I"!Object#instance_variable_get;F;[[I"iv;T0;[[@ui& ;T;:instance_variable_get;0;[ ;{ ;IC;"!Returns the value of the given instance variable, or nil if the
instance variable is not set. The @ part of the
variable name should be included for regular instance
variables. Throws a NameError exception if the
supplied symbol is not valid as an instance variable name.
String arguments are converted to symbols.
class Fred
def initialize(p1, p2)
@a, @b = p1, p2
end
end
fred = Fred.new('cat', 99)
fred.instance_variable_get(:@a) #=> "cat"
fred.instance_variable_get("@b") #=> 99
;T;[o;
; I"
overload;F; 0;;; 0; I""instance_variable_get(symbol);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@;#[ ;$I"@return [Object];T;%0;"@;&0;'F;(i ;[[I" symbol;T0;"@o;
; I"
overload;F; 0;;; 0; I""instance_variable_get(string);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@;#[ ;$I"@return [Object];T;%0;"@;&0;'F;(i ;[[I" string;T0;"@;#[ ;$I"Returns the value of the given instance variable, or nil if the
instance variable is not set. The @ part of the
variable name should be included for regular instance
variables. Throws a NameError exception if the
supplied symbol is not valid as an instance variable name.
String arguments are converted to symbols.
class Fred
def initialize(p1, p2)
@a, @b = p1, p2
end
end
fred = Fred.new('cat', 99)
fred.instance_variable_get(:@a) #=> "cat"
fred.instance_variable_get("@b") #=> 99
@overload instance_variable_get(symbol)
@return [Object]
@overload instance_variable_get(string)
@return [Object];T;%0;"@;'F;)o;*;+T;,i ;-i$ ;.@N; I"static VALUE;T;/I"static VALUE
rb_obj_ivar_get(VALUE obj, VALUE iv)
{
ID id = id_for_var(obj, iv, an, instance);
if (!id) {
return Qnil;
}
return rb_ivar_get(obj, id);
};T;0To;
; F; ;
;;;I"!Object#instance_variable_set;F;[[I"iv;T0[I"val;T0;[[@uiH ;T;:instance_variable_set;0;[ ;{ ;IC;"zSets the instance variable named by symbol to the given
object, thereby frustrating the efforts of the class's
author to attempt to provide proper encapsulation. The variable
does not have to exist prior to this call.
If the instance variable name is passed as a string, that string
is converted to a symbol.
class Fred
def initialize(p1, p2)
@a, @b = p1, p2
end
end
fred = Fred.new('cat', 99)
fred.instance_variable_set(:@a, 'dog') #=> "dog"
fred.instance_variable_set(:@c, 'cat') #=> "cat"
fred.inspect #=> "#"
;T;[o;
; I"
overload;F; 0;;; 0; I"'instance_variable_set(symbol, obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@ ;#[ ;$I"@return [Object];T;%0;"@ ;&0;'F;(i ;[[I" symbol;T0[I"obj;T0;"@ o;
; I"
overload;F; 0;;; 0; I"'instance_variable_set(string, obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@ ;#[ ;$I"@return [Object];T;%0;"@ ;&0;'F;(i ;[[I" string;T0[I"obj;T0;"@ ;#[ ;$I"Sets the instance variable named by symbol to the given
object, thereby frustrating the efforts of the class's
author to attempt to provide proper encapsulation. The variable
does not have to exist prior to this call.
If the instance variable name is passed as a string, that string
is converted to a symbol.
class Fred
def initialize(p1, p2)
@a, @b = p1, p2
end
end
fred = Fred.new('cat', 99)
fred.instance_variable_set(:@a, 'dog') #=> "dog"
fred.instance_variable_set(:@c, 'cat') #=> "cat"
fred.inspect #=> "#"
@overload instance_variable_set(symbol, obj)
@return [Object]
@overload instance_variable_set(string, obj)
@return [Object];T;%0;"@ ;'F;)o;*;+T;,i1 ;-iF ;.@N; I"static VALUE;T;/I"static VALUE
rb_obj_ivar_set(VALUE obj, VALUE iv, VALUE val)
{
ID id = id_for_var(obj, iv, an, instance);
if (!id) id = rb_intern_str(iv);
return rb_ivar_set(obj, id, val);
};T;0To;
; F; ;
;;;I"&Object#instance_variable_defined?;F;[[I"iv;T0;[[@uid ;T;: instance_variable_defined?;0;[ ;{ ;IC;"Returns true if the given instance variable is
defined in obj.
String arguments are converted to symbols.
class Fred
def initialize(p1, p2)
@a, @b = p1, p2
end
end
fred = Fred.new('cat', 99)
fred.instance_variable_defined?(:@a) #=> true
fred.instance_variable_defined?("@b") #=> true
fred.instance_variable_defined?("@c") #=> false
;T;[o;
; I"
overload;F; 0;;; 0; I"'instance_variable_defined?(symbol);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@? ;#[ ;$I"@return [Boolean];T;%0;"@? ;&0;'F;(i ;[[I" symbol;T0;"@? o;
; I"
overload;F; 0;;; 0; I"'instance_variable_defined?(string);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@? ;#[ ;$I"@return [Boolean];T;%0;"@? ;&0;'F;(i ;[[I" string;T0;"@? o;!
; I" return;F; @;0; [@;"@? ;#[ ;$I"Returns true if the given instance variable is
defined in obj.
String arguments are converted to symbols.
class Fred
def initialize(p1, p2)
@a, @b = p1, p2
end
end
fred = Fred.new('cat', 99)
fred.instance_variable_defined?(:@a) #=> true
fred.instance_variable_defined?("@b") #=> true
fred.instance_variable_defined?("@c") #=> false
@overload instance_variable_defined?(symbol)
@return [Boolean]
@overload instance_variable_defined?(string)
@return [Boolean];T;%0;"@? ;'F;)o;*;+T;,iP ;-ib ;.@N; I"static VALUE;T;/I"static VALUE
rb_obj_ivar_defined(VALUE obj, VALUE iv)
{
ID id = id_for_var(obj, iv, an, instance);
if (!id) {
return Qfalse;
}
return rb_ivar_defined(obj, id);
};T;0To;
; F; ;
;;;I"$Object#remove_instance_variable;F;[[I" name;T0;[[@i;T;: remove_instance_variable;0;[ ;{ ;IC;"ARemoves the named instance variable from obj, returning that
variable's value.
class Dummy
attr_reader :var
def initialize
@var = 99
end
def remove
remove_instance_variable(:@var)
end
end
d = Dummy.new
d.var #=> 99
d.remove #=> 99
d.var #=> nil
;T;[o;
; I"
overload;F; 0;;; 0; I"%remove_instance_variable(symbol);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@p ;#[ ;$I"@return [Object];T;%0;"@p ;&0;'F;(i ;[[I" symbol;T0;"@p ;#[ ;$I"Removes the named instance variable from obj, returning that
variable's value.
class Dummy
attr_reader :var
def initialize
@var = 99
end
def remove
remove_instance_variable(:@var)
end
end
d = Dummy.new
d.var #=> 99
d.remove #=> 99
d.var #=> nil
@overload remove_instance_variable(symbol)
@return [Object];T;%0;"@p ;'F;)o;*;+T;,i;-i;.@N; I"
VALUE;T;/I"MVALUE
rb_obj_remove_instance_variable(VALUE obj, VALUE name)
{
VALUE val = Qnil;
const ID id = id_for_var(obj, name, an, instance);
st_data_t n, v;
struct st_table *iv_index_tbl;
st_data_t index;
rb_check_frozen(obj);
if (!id) {
goto not_defined;
}
switch (BUILTIN_TYPE(obj)) {
case T_OBJECT:
iv_index_tbl = ROBJECT_IV_INDEX_TBL(obj);
if (!iv_index_tbl) break;
if (!st_lookup(iv_index_tbl, (st_data_t)id, &index)) break;
if (ROBJECT_NUMIV(obj) <= (long)index) break;
val = ROBJECT_IVPTR(obj)[index];
if (val != Qundef) {
ROBJECT_IVPTR(obj)[index] = Qundef;
return val;
}
break;
case T_CLASS:
case T_MODULE:
n = id;
if (RCLASS_IV_TBL(obj) && st_delete(RCLASS_IV_TBL(obj), &n, &v)) {
return (VALUE)v;
}
break;
default:
if (FL_TEST(obj, FL_EXIVAR)) {
if (generic_ivar_remove(obj, id, &val)) {
return val;
}
}
break;
}
not_defined:
rb_name_err_raise("instance variable %1$s not defined",
obj, name);
UNREACHABLE;
};T;0To;
; F; ;
;;;I"Object#instance_of?;F;[[I"c;T0;[[@uia;T;:instance_of?;0;[ ;{ ;IC;"Returns true if obj is an instance of the given
class. See also Object#kind_of?.
class A; end
class B < A; end
class C < B; end
b = B.new
b.instance_of? A #=> false
b.instance_of? B #=> true
b.instance_of? C #=> false
;T;[o;
; I"
overload;F; 0;;; 0; I"instance_of?(class);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@ ;#[ ;$I"@return [Boolean];T;%0;"@ ;&0;'F;(i ;[ ;"@ o;!
; I" return;F; @;0; [@;"@ ;#[ ;$I"OReturns true if obj is an instance of the given
class. See also Object#kind_of?.
class A; end
class B < A; end
class C < B; end
b = B.new
b.instance_of? A #=> false
b.instance_of? B #=> true
b.instance_of? C #=> false
@overload instance_of?(class)
@return [Boolean];T;%0;"@ ;'F;)o;*;+T;,iP;-i^;.@N; I"
VALUE;T;/I"VALUE
rb_obj_is_instance_of(VALUE obj, VALUE c)
{
c = class_or_module_required(c);
if (rb_obj_class(obj) == c) return Qtrue;
return Qfalse;
};T;0To;
; F; ;
;;;I"Object#kind_of?;F;[[I"c;T0;[[@ui;T;:
kind_of?;0;[ ;{ ;IC;" Returns true if class is the class of
obj, or if class is one of the superclasses of
obj or modules included in obj.
module M; end
class A
include M
end
class B < A; end
class C < B; end
b = B.new
b.is_a? A #=> true
b.is_a? B #=> true
b.is_a? C #=> false
b.is_a? M #=> true
b.kind_of? A #=> true
b.kind_of? B #=> true
b.kind_of? C #=> false
b.kind_of? M #=> true
;T;[o;
; I"
overload;F; 0;:
is_a?; 0; I"is_a?(class);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@ ;#[ ;$I"@return [Boolean];T;%0;"@ ;&0;'F;(i ;[ ;"@ o;
; I"
overload;F; 0;;; 0; I"kind_of?(class);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@ ;#[ ;$I"@return [Boolean];T;%0;"@ ;&0;'F;(i ;[ ;"@ o;!
; I" return;F; @;0; [@;"@ ;#[ ;$I"fReturns true if class is the class of
obj, or if class is one of the superclasses of
obj or modules included in obj.
module M; end
class A
include M
end
class B < A; end
class C < B; end
b = B.new
b.is_a? A #=> true
b.is_a? B #=> true
b.is_a? C #=> false
b.is_a? M #=> true
b.kind_of? A #=> true
b.kind_of? B #=> true
b.kind_of? C #=> false
b.kind_of? M #=> true
@overload is_a?(class)
@return [Boolean]
@overload kind_of?(class)
@return [Boolean];T;%0;"@ ;'F;)o;*;+T;,ij;-i;.@N; I"
VALUE;T;/I"VALUE
rb_obj_is_kind_of(VALUE obj, VALUE c)
{
VALUE cl = CLASS_OF(obj);
c = class_or_module_required(c);
return class_search_ancestor(cl, RCLASS_ORIGIN(c)) ? Qtrue : Qfalse;
};T;0To;
; F; ;
;;;I"Object#is_a?;F;[[I"c;T0;[[@ui;T;;;0;[ ;{ ;IC;" Returns true if class is the class of
obj, or if class is one of the superclasses of
obj or modules included in obj.
module M; end
class A
include M
end
class B < A; end
class C < B; end
b = B.new
b.is_a? A #=> true
b.is_a? B #=> true
b.is_a? C #=> false
b.is_a? M #=> true
b.kind_of? A #=> true
b.kind_of? B #=> true
b.kind_of? C #=> false
b.kind_of? M #=> true
;T;[o;
; I"
overload;F; 0;;; 0; I"is_a?(class);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@ ;#[ ;$I"@return [Boolean];T;%0;"@ ;&0;'F;(i ;[ ;"@ o;
; I"
overload;F; 0;;; 0; I"kind_of?(class);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@ ;#[ ;$I"@return [Boolean];T;%0;"@ ;&0;'F;(i ;[ ;"@ o;!
; I" return;F; @;0; [@;"@ ;#[ ;$@ ;%0;"@ ;'F;)o;*;+T;,ij;-i;.@N; I"
VALUE;T;/I"VALUE
rb_obj_is_kind_of(VALUE obj, VALUE c)
{
VALUE cl = CLASS_OF(obj);
c = class_or_module_required(c);
return class_search_ancestor(cl, RCLASS_ORIGIN(c)) ? Qtrue : Qfalse;
};T;0To;
; F; ;
;;;I"Object#tap;F;[ ;[[@ui;T;:tap;0;[ ;{ ;IC;"Yields self to the block, and then returns self.
The primary purpose of this method is to "tap into" a method chain,
in order to perform operations on intermediate results within the chain.
(1..10) .tap {|x| puts "original: #{x.inspect}"}
.to_a .tap {|x| puts "array: #{x.inspect}"}
.select {|x| x%2==0} .tap {|x| puts "evens: #{x.inspect}"}
.map {|x| x*x} .tap {|x| puts "squares: #{x.inspect}"}
;T;[o;
; I"
overload;F; 0;;; 0; I"tap;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"x;T;"@
o;!
; I" return;F; I" ;T;0; [I" Object;T;"@
;#[ ;$I" @yield [x]
@return [Object];T;%0;"@
;&0;'F;(i ;[ ;"@
;#[ ;$I"Yields self to the block, and then returns self.
The primary purpose of this method is to "tap into" a method chain,
in order to perform operations on intermediate results within the chain.
(1..10) .tap {|x| puts "original: #{x.inspect}"}
.to_a .tap {|x| puts "array: #{x.inspect}"}
.select {|x| x%2==0} .tap {|x| puts "evens: #{x.inspect}"}
.map {|x| x*x} .tap {|x| puts "squares: #{x.inspect}"}
@overload tap
@yield [x]
@return [Object];T;%0;"@
;'F;)o;*;+T;,i;-i;.@N; I"
VALUE;T;/I"GVALUE
rb_obj_tap(VALUE obj)
{
rb_yield(obj);
return obj;
};T;0To:&YARD::CodeObjects::ConstantObject;[[I"7ext/-test-/wait_for_single_fd/wait_for_single_fd.c;Ti ;F;:RB_WAITFD_IN;:c;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@(
;.@N;I"Object::RB_WAITFD_IN;F: @valueI"INT2NUM(RB_WAITFD_IN);To;;[[@+
i ;F;:RB_WAITFD_OUT;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@3
;.@N;I"Object::RB_WAITFD_OUT;F;I"INT2NUM(RB_WAITFD_OUT);To;;[[@+
i ;F;:RB_WAITFD_PRI;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@=
;.@N;I"Object::RB_WAITFD_PRI;F;I"INT2NUM(RB_WAITFD_PRI);To;
; F; ;
;;;I"Object#rb_fatal;F;[[I"msg;T0;[[I" ext/-test-/fatal/rb_fatal.c;Ti;T;:
rb_fatal;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@G
;.@N; I"static VALUE;T;/I"static VALUE
ruby_fatal(VALUE obj, VALUE msg)
{
const char *cmsg = NULL;
(void)obj;
cmsg = RSTRING_PTR(msg);
rb_fatal("%s", cmsg);
return 0; /* never reached */
};T;0To;
; F; ;
;;;I"Object#object_id;F;[ ;[[I" gc.c;Ti ;T;:object_id;0;[ ;{ ;IC;"call-seq:
obj.__id__ -> integer
obj.object_id -> integer
Returns an integer identifier for +obj+.
The same number will be returned on all calls to +object_id+ for a given
object, and no two active objects will share an id.
Note: that some objects of builtin classes are reused for optimization.
This is the case for immediate values and frozen string literals.
Immediate values are not passed by reference but are passed by value:
+nil+, +true+, +false+, Fixnums, Symbols, and some Floats.
Object.new.object_id == Object.new.object_id # => false
(21 * 2).object_id == (21 * 2).object_id # => true
"hello".object_id == "hello".object_id # => false
"hi".freeze.object_id == "hi".freeze.object_id # => true
;T;[ ;#[ ;$I"
call-seq:
obj.__id__ -> integer
obj.object_id -> integer
Returns an integer identifier for +obj+.
The same number will be returned on all calls to +object_id+ for a given
object, and no two active objects will share an id.
Note: that some objects of builtin classes are reused for optimization.
This is the case for immediate values and frozen string literals.
Immediate values are not passed by reference but are passed by value:
+nil+, +true+, +false+, Fixnums, Symbols, and some Floats.
Object.new.object_id == Object.new.object_id # => false
(21 * 2).object_id == (21 * 2).object_id # => true
"hello".object_id == "hello".object_id # => false
"hi".freeze.object_id == "hi".freeze.object_id # => true
;T;%0;"@V
;'F;)o;*;+T;,i ;-i ;.@N; I"
VALUE;T;/I"HVALUE
rb_obj_id(VALUE obj)
{
/*
* 32-bit VALUE space
* MSB ------------------------ LSB
* false 00000000000000000000000000000000
* true 00000000000000000000000000000010
* nil 00000000000000000000000000000100
* undef 00000000000000000000000000000110
* symbol ssssssssssssssssssssssss00001110
* object oooooooooooooooooooooooooooooo00 = 0 (mod sizeof(RVALUE))
* fixnum fffffffffffffffffffffffffffffff1
*
* object_id space
* LSB
* false 00000000000000000000000000000000
* true 00000000000000000000000000000010
* nil 00000000000000000000000000000100
* undef 00000000000000000000000000000110
* symbol 000SSSSSSSSSSSSSSSSSSSSSSSSSSS0 S...S % A = 4 (S...S = s...s * A + 4)
* object oooooooooooooooooooooooooooooo0 o...o % A = 0
* fixnum fffffffffffffffffffffffffffffff1 bignum if required
*
* where A = sizeof(RVALUE)/4
*
* sizeof(RVALUE) is
* 20 if 32-bit, double is 4-byte aligned
* 24 if 32-bit, double is 8-byte aligned
* 40 if 64-bit
*/
if (STATIC_SYM_P(obj)) {
return (SYM2ID(obj) * sizeof(RVALUE) + (4 << 2)) | FIXNUM_FLAG;
}
else if (FLONUM_P(obj)) {
#if SIZEOF_LONG == SIZEOF_VOIDP
return LONG2NUM((SIGNED_VALUE)obj);
#else
return LL2NUM((SIGNED_VALUE)obj);
#endif
}
else if (SPECIAL_CONST_P(obj)) {
return LONG2NUM((SIGNED_VALUE)obj);
}
return nonspecial_obj_id(obj);
};T;0To;
; F; ;
;;;I"Object#send;F;[[@0;[[I" ext/io/console/console.c;TiY;T;: send;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@e
;.@N; I"static VALUE;T;/I"static VALUE
rb_f_send(int argc, VALUE *argv, VALUE recv)
{
VALUE sym = argv[0];
ID vid = rb_check_id(&sym);
if (vid) {
--argc;
++argv;
}
else {
vid = id___send__;
}
return rb_funcallv(recv, vid, argc, argv);
};T;0To;
; F; ;
;;;I"Object#public_send;F;[[@0;[[I"vm_eval.c;Ti;T;:public_send;0;[ ;{ ;IC;" Invokes the method identified by _symbol_, passing it any
arguments specified. Unlike send, public_send calls public
methods only.
When the method is identified by a string, the string is converted
to a symbol.
1.public_send(:puts, "hello") # causes NoMethodError
;T;[o;
; I"
overload;F; 0;;; 0; I"$public_send(symbol [, args...]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@s
;#[ ;$I"@return [Object];T;%0;"@s
;&0;'F;(i ;[[I"symbol[, args...];T0;"@s
o;
; I"
overload;F; 0;;; 0; I"$public_send(string [, args...]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@s
;#[ ;$I"@return [Object];T;%0;"@s
;&0;'F;(i ;[[I"string[, args...];T0;"@s
;#[ ;$I"Invokes the method identified by _symbol_, passing it any
arguments specified. Unlike send, public_send calls public
methods only.
When the method is identified by a string, the string is converted
to a symbol.
1.public_send(:puts, "hello") # causes NoMethodError
@overload public_send(symbol [, args...])
@return [Object]
@overload public_send(string [, args...])
@return [Object];T;%0;"@s
;'F;)o;*;+T;,i;-i;.@N; I"
VALUE;T;/I"{VALUE
rb_f_public_send(int argc, VALUE *argv, VALUE recv)
{
return send_internal(argc, argv, recv, CALL_PUBLIC);
};T;0T;N@N;OIC;[ ;N@N;PIC;[o:$YARD::CodeObjects::ModuleObject;IC;[Fo;
; F; ;
;;;I"Kernel#Rational;F;[[@0;[[@i`;T;:
Rational;0;[ ;{ ;IC;"Returns x/y;
Rational(1, 2) #=> (1/2)
Rational('1/2') #=> (1/2)
Rational(nil) #=> TypeError
Rational(1, nil) #=> TypeError
Syntax of string form:
string form = extra spaces , rational , extra spaces ;
rational = [ sign ] , unsigned rational ;
unsigned rational = numerator | numerator , "/" , denominator ;
numerator = integer part | fractional part | integer part , fractional part ;
denominator = digits ;
integer part = digits ;
fractional part = "." , digits , [ ( "e" | "E" ) , [ sign ] , digits ] ;
sign = "-" | "+" ;
digits = digit , { digit | "_" , digit } ;
digit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" ;
extra spaces = ? \s* ? ;
See String#to_r.
;T;[o;
; I"
overload;F; 0;;; 0; I"Rational(x[, y]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Numeric;T;"@
;#[ ;$I"@return [Numeric];T;%0;"@
;&0;'F;(i ;[[I" x[, y];T0;"@
;#[ ;$I"Returns x/y;
Rational(1, 2) #=> (1/2)
Rational('1/2') #=> (1/2)
Rational(nil) #=> TypeError
Rational(1, nil) #=> TypeError
Syntax of string form:
string form = extra spaces , rational , extra spaces ;
rational = [ sign ] , unsigned rational ;
unsigned rational = numerator | numerator , "/" , denominator ;
numerator = integer part | fractional part | integer part , fractional part ;
denominator = digits ;
integer part = digits ;
fractional part = "." , digits , [ ( "e" | "E" ) , [ sign ] , digits ] ;
sign = "-" | "+" ;
digits = digit , { digit | "_" , digit } ;
digit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" ;
extra spaces = ? \s* ? ;
See String#to_r.
@overload Rational(x[, y])
@return [Numeric];T;%0;"@
;'F;)o;*;+T;,iE;-i^;.@
; I"static VALUE;T;/I"static VALUE
nurat_f_rational(int argc, VALUE *argv, VALUE klass)
{
return rb_funcall2(rb_cRational, id_convert, argc, argv);
};T;0To;
; F; ;
;;;I"Kernel#at_exit;F;[ ;[[I"eval_jump.c;Ti*;T;: at_exit;0;[ ;{ ;IC;"Converts _block_ to a +Proc+ object (and therefore
binds it at the point of call) and registers it for execution when
the program exits. If multiple handlers are registered, they are
executed in reverse order of registration.
def do_at_exit(str1)
at_exit { print str1 }
end
at_exit { puts "cruel world" }
do_at_exit("goodbye ")
exit
produces:
goodbye cruel world
;T;[o;
; I"
overload;F; 0;;; 0; I" at_exit;T;IC;" ;T;[o;!
; I"
yield;F; I"[];T;0; 0;"@
o;!
; I" return;F; I" ;T;0; [I" Proc;T;"@
;#[ ;$I" @yield []
@return [Proc];T;%0;"@
;&0;'F;(i ;[ ;"@
;#[ ;$I"Converts _block_ to a +Proc+ object (and therefore
binds it at the point of call) and registers it for execution when
the program exits. If multiple handlers are registered, they are
executed in reverse order of registration.
def do_at_exit(str1)
at_exit { print str1 }
end
at_exit { puts "cruel world" }
do_at_exit("goodbye ")
exit
produces:
goodbye cruel world
@overload at_exit
@yield []
@return [Proc];T;%0;"@
;'F;)o;*;+T;,i;-i(;.@
; I"static VALUE;T;/I"static VALUE
rb_f_at_exit(void)
{
VALUE proc;
if (!rb_block_given_p()) {
rb_raise(rb_eArgError, "called without a block");
}
proc = rb_block_proc();
rb_set_end_proc(rb_call_end_proc, proc);
return proc;
};T;0To;
; F; ;
;;;I"Kernel#set_trace_func;F;[[I"
trace;T0;[[I"vm_trace.c;Ti;T;:set_trace_func;0;[ ;{ ;IC;"/Establishes _proc_ as the handler for tracing, or disables
tracing if the parameter is +nil+.
*Note:* this method is obsolete, please use TracePoint instead.
_proc_ takes up to six parameters:
* an event name
* a filename
* a line number
* an object id
* a binding
* the name of a class
_proc_ is invoked whenever an event occurs.
Events are:
+c-call+:: call a C-language routine
+c-return+:: return from a C-language routine
+call+:: call a Ruby method
+class+:: start a class or module definition),
+end+:: finish a class or module definition),
+line+:: execute code on a new line
+raise+:: raise an exception
+return+:: return from a Ruby method
Tracing is disabled within the context of _proc_.
class Test
def test
a = 1
b = 2
end
end
set_trace_func proc { |event, file, line, id, binding, classname|
printf "%8s %s:%-2d %10s %8s\n", event, file, line, id, classname
}
t = Test.new
t.test
line prog.rb:11 false
c-call prog.rb:11 new Class
c-call prog.rb:11 initialize Object
c-return prog.rb:11 initialize Object
c-return prog.rb:11 new Class
line prog.rb:12 false
call prog.rb:2 test Test
line prog.rb:3 test Test
line prog.rb:4 test Test
return prog.rb:4 test Test
;T;[o;
; I"
overload;F; 0;;; 0; I"set_trace_func(proc);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Proc;T;"@
;#[ ;$I"@return [Proc];T;%0;"@
;&0;'F;(i ;[[I" proc;T0;"@
o;
; I"
overload;F; 0;;; 0; I"set_trace_func(nil);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@
;#[ ;$I"@return [nil];T;%0;"@
;&0;'F;(i ;[[I"nil;T0;"@
;#[ ;$I"Establishes _proc_ as the handler for tracing, or disables
tracing if the parameter is +nil+.
*Note:* this method is obsolete, please use TracePoint instead.
_proc_ takes up to six parameters:
* an event name
* a filename
* a line number
* an object id
* a binding
* the name of a class
_proc_ is invoked whenever an event occurs.
Events are:
+c-call+:: call a C-language routine
+c-return+:: return from a C-language routine
+call+:: call a Ruby method
+class+:: start a class or module definition),
+end+:: finish a class or module definition),
+line+:: execute code on a new line
+raise+:: raise an exception
+return+:: return from a Ruby method
Tracing is disabled within the context of _proc_.
class Test
def test
a = 1
b = 2
end
end
set_trace_func proc { |event, file, line, id, binding, classname|
printf "%8s %s:%-2d %10s %8s\n", event, file, line, id, classname
}
t = Test.new
t.test
line prog.rb:11 false
c-call prog.rb:11 new Class
c-call prog.rb:11 initialize Object
c-return prog.rb:11 initialize Object
c-return prog.rb:11 new Class
line prog.rb:12 false
call prog.rb:2 test Test
line prog.rb:3 test Test
line prog.rb:4 test Test
return prog.rb:4 test Test
@overload set_trace_func(proc)
@return [Proc]
@overload set_trace_func(nil)
@return [nil];T;%0;"@
;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"Dstatic VALUE
set_trace_func(VALUE obj, VALUE trace)
{
rb_remove_event_hook(call_trace_func);
if (NIL_P(trace)) {
return Qnil;
}
if (!rb_obj_is_proc(trace)) {
rb_raise(rb_eTypeError, "trace_func needs to be Proc");
}
rb_add_event_hook(call_trace_func, RUBY_EVENT_ALL, trace);
return trace;
};T;0To;
; F; ;
;;;I"Kernel#trap;F;[[@0;[[I"
signal.c;Ti;T;: trap;0;[ ;{ ;IC;"Specifies the handling of signals. The first parameter is a signal
name (a string such as ``SIGALRM'', ``SIGUSR1'', and so on) or a
signal number. The characters ``SIG'' may be omitted from the
signal name. The command or block specifies code to be run when the
signal is raised.
If the command is the string ``IGNORE'' or ``SIG_IGN'', the signal
will be ignored.
If the command is ``DEFAULT'' or ``SIG_DFL'', the Ruby's default handler
will be invoked.
If the command is ``EXIT'', the script will be terminated by the signal.
If the command is ``SYSTEM_DEFAULT'', the operating system's default
handler will be invoked.
Otherwise, the given command or block will be run.
The special signal name ``EXIT'' or signal number zero will be
invoked just prior to program termination.
trap returns the previous handler for the given signal.
Signal.trap(0, proc { puts "Terminating: #{$$}" })
Signal.trap("CLD") { puts "Child died" }
fork && Process.wait
produces:
Terminating: 27461
Child died
Terminating: 27460
;T;[o;
; I"
overload;F; 0;;; 0; I" trap( signal, command );T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@ ;#[ ;$I"@return [Object];T;%0;"@ ;&0;'F;(i ;[[I" signal;T0[I" command;T0;"@ o;
; I"
overload;F; 0;;; 0; I"trap( signal );T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" ;T;"@ o;!
; I" return;F; I" ;T;0; [I" Object;T;"@ ;#[ ;$I" @yield [ ]
@return [Object];T;%0;"@ ;&0;'F;(i ;[[I" signal;T0;"@ ;#[ ;$I"xSpecifies the handling of signals. The first parameter is a signal
name (a string such as ``SIGALRM'', ``SIGUSR1'', and so on) or a
signal number. The characters ``SIG'' may be omitted from the
signal name. The command or block specifies code to be run when the
signal is raised.
If the command is the string ``IGNORE'' or ``SIG_IGN'', the signal
will be ignored.
If the command is ``DEFAULT'' or ``SIG_DFL'', the Ruby's default handler
will be invoked.
If the command is ``EXIT'', the script will be terminated by the signal.
If the command is ``SYSTEM_DEFAULT'', the operating system's default
handler will be invoked.
Otherwise, the given command or block will be run.
The special signal name ``EXIT'' or signal number zero will be
invoked just prior to program termination.
trap returns the previous handler for the given signal.
Signal.trap(0, proc { puts "Terminating: #{$$}" })
Signal.trap("CLD") { puts "Child died" }
fork && Process.wait
produces:
Terminating: 27461
Child died
Terminating: 27460
@overload trap( signal, command )
@return [Object]
@overload trap( signal )
@yield [ ]
@return [Object];T;%0;"@ ;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"static VALUE
sig_trap(int argc, VALUE *argv)
{
int sig;
sighandler_t func;
VALUE cmd;
rb_check_arity(argc, 1, 2);
sig = trap_signm(argv[0]);
if (reserved_signal_p(sig)) {
const char *name = signo2signm(sig);
if (name)
rb_raise(rb_eArgError, "can't trap reserved signal: SIG%s", name);
else
rb_raise(rb_eArgError, "can't trap reserved signal: %d", sig);
}
if (argc == 1) {
cmd = rb_block_proc();
func = sighandler;
}
else {
cmd = argv[1];
func = trap_handler(&cmd, sig);
}
if (OBJ_TAINTED(cmd)) {
rb_raise(rb_eSecurityError, "Insecure: tainted signal trap");
}
return trap(sig, func, cmd);
};T;0To;
; F; ;
;;;I"Kernel#caller;F;[[@0;[[I"vm_backtrace.c;Ti;T;: caller;0;[ ;{ ;IC;"Returns the current execution stack---an array containing strings in
the form file:line or file:line: in
`method'.
The optional _start_ parameter determines the number of initial stack
entries to omit from the top of the stack.
A second optional +length+ parameter can be used to limit how many entries
are returned from the stack.
Returns +nil+ if _start_ is greater than the size of
current execution stack.
Optionally you can pass a range, which will return an array containing the
entries within the specified range.
def a(skip)
caller(skip)
end
def b(skip)
a(skip)
end
def c(skip)
b(skip)
end
c(0) #=> ["prog:2:in `a'", "prog:5:in `b'", "prog:8:in `c'", "prog:10:in `'"]
c(1) #=> ["prog:5:in `b'", "prog:8:in `c'", "prog:11:in `'"]
c(2) #=> ["prog:8:in `c'", "prog:12:in `'"]
c(3) #=> ["prog:13:in `'"]
c(4) #=> []
c(5) #=> nil
;T;[o;
; I"
overload;F; 0;;; 0; I" caller(start=1, length=nil);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;TI"nil;T;"@F ;#[ ;$I"@return [Array, nil];T;%0;"@F ;&0;'F;(i ;[[I"
start;TI"1;T[I" length;TI"nil;T;"@F o;
; I"
overload;F; 0;;; 0; I"caller(range);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;TI"nil;T;"@F ;#[ ;$I"@return [Array, nil];T;%0;"@F ;&0;'F;(i ;[[I"
range;T0;"@F ;#[ ;$I"$Returns the current execution stack---an array containing strings in
the form file:line or file:line: in
`method'.
The optional _start_ parameter determines the number of initial stack
entries to omit from the top of the stack.
A second optional +length+ parameter can be used to limit how many entries
are returned from the stack.
Returns +nil+ if _start_ is greater than the size of
current execution stack.
Optionally you can pass a range, which will return an array containing the
entries within the specified range.
def a(skip)
caller(skip)
end
def b(skip)
a(skip)
end
def c(skip)
b(skip)
end
c(0) #=> ["prog:2:in `a'", "prog:5:in `b'", "prog:8:in `c'", "prog:10:in `'"]
c(1) #=> ["prog:5:in `b'", "prog:8:in `c'", "prog:11:in `'"]
c(2) #=> ["prog:8:in `c'", "prog:12:in `'"]
c(3) #=> ["prog:13:in `'"]
c(4) #=> []
c(5) #=> nil
@overload caller(start=1, length=nil)
@return [Array, nil]
@overload caller(range)
@return [Array, nil];T;%0;"@F ;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"{static VALUE
rb_f_caller(int argc, VALUE *argv)
{
return vm_backtrace_to_ary(GET_THREAD(), argc, argv, 1, 1, 1);
};T;0To;
; F; ;
;;;I" Kernel#caller_locations;F;[[@0;[[@L i;T;:caller_locations;0;[ ;{ ;IC;"&Returns the current execution stack---an array containing
backtrace location objects.
See Thread::Backtrace::Location for more information.
The optional _start_ parameter determines the number of initial stack
entries to omit from the top of the stack.
A second optional +length+ parameter can be used to limit how many entries
are returned from the stack.
Returns +nil+ if _start_ is greater than the size of
current execution stack.
Optionally you can pass a range, which will return an array containing the
entries within the specified range.
;T;[o;
; I"
overload;F; 0;;; 0; I":caller_locations(start=1, length=nil) -> array or nil;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@z ;&0;'F;(i ;[[I"
start;TI"1;T[I" length;TI"nil;T;"@z o;
; I"
overload;F; 0;;; 0; I".caller_locations(range) -> array or nil;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@z ;&0;'F;(i ;[[I"
range;T0;"@z ;#[ ;$I"Returns the current execution stack---an array containing
backtrace location objects.
See Thread::Backtrace::Location for more information.
The optional _start_ parameter determines the number of initial stack
entries to omit from the top of the stack.
A second optional +length+ parameter can be used to limit how many entries
are returned from the stack.
Returns +nil+ if _start_ is greater than the size of
current execution stack.
Optionally you can pass a range, which will return an array containing the
entries within the specified range.
@overload caller_locations(start=1, length=nil) -> array or nil
@overload caller_locations(range) -> array or nil;T;%0;"@z ;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"static VALUE
rb_f_caller_locations(int argc, VALUE *argv)
{
return vm_backtrace_to_ary(GET_THREAD(), argc, argv, 1, 1, 0);
};T;0To;
; F; ;
;;;I"Kernel#eval;F;[[@0;[[@y
i;T;: eval;0;[ ;{ ;IC;"Evaluates the Ruby expression(s) in string. If
binding is given, which must be a Binding
object, the evaluation is performed in its context. If the
optional filename and lineno parameters are
present, they will be used when reporting syntax errors.
def get_binding(str)
return binding
end
str = "hello"
eval "str + ' Fred'" #=> "hello Fred"
eval "str + ' Fred'", get_binding("bye") #=> "bye Fred"
;T;[o;
; I"
overload;F; 0;;; 0; I"4eval(string [, binding [, filename [,lineno]]]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@ ;#[ ;$I"@return [Object];T;%0;"@ ;&0;'F;(i ;[[I"-string[, binding [, filename [,lineno]]];T0;"@ ;#[ ;$I"7Evaluates the Ruby expression(s) in string. If
binding is given, which must be a Binding
object, the evaluation is performed in its context. If the
optional filename and lineno parameters are
present, they will be used when reporting syntax errors.
def get_binding(str)
return binding
end
str = "hello"
eval "str + ' Fred'" #=> "hello Fred"
eval "str + ' Fred'", get_binding("bye") #=> "bye Fred"
@overload eval(string [, binding [, filename [,lineno]]])
@return [Object];T;%0;"@ ;'F;)o;*;+T;,i;-i;.@
; I"
VALUE;T;/I"VALUE
rb_f_eval(int argc, const VALUE *argv, VALUE self)
{
VALUE src, scope, vfile, vline;
VALUE file = Qundef;
int line = 1;
rb_scan_args(argc, argv, "13", &src, &scope, &vfile, &vline);
SafeStringValue(src);
if (argc >= 3) {
StringValue(vfile);
}
if (argc >= 4) {
line = NUM2INT(vline);
}
if (!NIL_P(vfile))
file = vfile;
return eval_string(self, src, scope, file, line);
};T;0To;
; F; ;
;;;I"Kernel#local_variables;F;[ ;[[@y
i$;T;:local_variables;0;[ ;{ ;IC;"Returns the names of the current local variables.
fred = 1
for i in 1..10
# ...
end
local_variables #=> [:fred, :i]
;T;[o;
; I"
overload;F; 0;;; 0; I"local_variables;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@ ;#[ ;$I"@return [Array];T;%0;"@ ;&0;'F;(i ;[ ;"@ ;#[ ;$I"Returns the names of the current local variables.
fred = 1
for i in 1..10
# ...
end
local_variables #=> [:fred, :i]
@overload local_variables
@return [Array];T;%0;"@ ;'F;)o;*;+T;,i;-i!;.@
; I"static VALUE;T;/I"static VALUE
rb_f_local_variables(void)
{
struct local_var_list vars;
rb_thread_t *th = GET_THREAD();
rb_control_frame_t *cfp =
vm_get_ruby_level_caller_cfp(th, RUBY_VM_PREVIOUS_CONTROL_FRAME(th->cfp));
unsigned int i;
local_var_list_init(&vars);
while (cfp) {
if (cfp->iseq) {
for (i = 0; i < cfp->iseq->body->local_table_size; i++) {
local_var_list_add(&vars, cfp->iseq->body->local_table[i]);
}
}
if (!VM_EP_LEP_P(cfp->ep)) {
/* block */
VALUE *ep = VM_CF_PREV_EP(cfp);
if (vm_collect_local_variables_in_heap(th, ep, &vars)) {
break;
}
else {
while (cfp->ep != ep) {
cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
}
}
}
else {
break;
}
}
return local_var_list_finish(&vars);
};T;0To;
; F; ;
;;;I"Kernel#iterator?;F;[ ;[[@y
i^;T;:iterator?;0;[ ;{ ;IC;"\Returns true if yield would execute a
block in the current context. The iterator? form
is mildly deprecated.
def try
if block_given?
yield
else
"no block"
end
end
try #=> "no block"
try { "hello" } #=> "hello"
try do "hello" end #=> "hello"
;T;[o;
; I"
overload;F; 0;:block_given?; 0; I"block_given?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@ ;#[ ;$I"@return [Boolean];T;%0;"@ ;&0;'F;(i ;[ ;"@ o;
; I"
overload;F; 0;;; 0; I"iterator?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@ ;#[ ;$I"@return [Boolean];T;%0;"@ ;&0;'F;(i ;[ ;"@ o;!
; I" return;F; @;0; [@;"@ ;#[ ;$I"Returns true if yield would execute a
block in the current context. The iterator? form
is mildly deprecated.
def try
if block_given?
yield
else
"no block"
end
end
try #=> "no block"
try { "hello" } #=> "hello"
try do "hello" end #=> "hello"
@overload block_given?
@return [Boolean]
@overload iterator?
@return [Boolean];T;%0;"@ ;'F;)o;*;+T;,iH;-i[;.@
; I"
VALUE;T;/I"!VALUE
rb_f_block_given_p(void)
{
rb_thread_t *th = GET_THREAD();
rb_control_frame_t *cfp = th->cfp;
cfp = vm_get_ruby_level_caller_cfp(th, RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp));
if (cfp != 0 && VM_CF_BLOCK_PTR(cfp)) {
return Qtrue;
}
else {
return Qfalse;
}
};T;0To;
; F; ;
;;;I"Kernel#block_given?;F;[ ;[[@y
i^;T;;;0;[ ;{ ;IC;"\Returns true if yield would execute a
block in the current context. The iterator? form
is mildly deprecated.
def try
if block_given?
yield
else
"no block"
end
end
try #=> "no block"
try { "hello" } #=> "hello"
try do "hello" end #=> "hello"
;T;[o;
; I"
overload;F; 0;;; 0; I"block_given?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@ ;#[ ;$I"@return [Boolean];T;%0;"@ ;&0;'F;(i ;[ ;"@ o;
; I"
overload;F; 0;;; 0; I"iterator?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@ ;#[ ;$I"@return [Boolean];T;%0;"@ ;&0;'F;(i ;[ ;"@ o;!
; I" return;F; @;0; [@;"@ ;#[ ;$@ ;%0;"@ ;'F;)o;*;+T;,iH;-i[;.@
; I"
VALUE;T;/I"!VALUE
rb_f_block_given_p(void)
{
rb_thread_t *th = GET_THREAD();
rb_control_frame_t *cfp = th->cfp;
cfp = vm_get_ruby_level_caller_cfp(th, RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp));
if (cfp != 0 && VM_CF_BLOCK_PTR(cfp)) {
return Qtrue;
}
else {
return Qfalse;
}
};T;0To;
; F; ;
;;;I"Kernel#catch;F;[[@0;[[@y
i;T;:
catch;0;[ ;{ ;IC;"+catch+ executes its block. If +throw+ is not called, the block executes
normally, and +catch+ returns the value of the last expression evaluated.
catch(1) { 123 } # => 123
If throw(tag2, val) is called, Ruby searches up its stack for
a +catch+ block whose +tag+ has the same +object_id+ as _tag2_. When found,
the block stops executing and returns _val_ (or +nil+ if no second argument
was given to +throw+).
catch(1) { throw(1, 456) } # => 456
catch(1) { throw(1) } # => nil
When +tag+ is passed as the first argument, +catch+ yields it as the
parameter of the block.
catch(1) {|x| x + 2 } # => 3
When no +tag+ is given, +catch+ yields a new unique object (as from
+Object.new+) as the block parameter. This object can then be used as the
argument to +throw+, and will match the correct +catch+ block.
catch do |obj_A|
catch do |obj_B|
throw(obj_B, 123)
puts "This puts is not reached"
end
puts "This puts is displayed"
456
end
# => 456
catch do |obj_A|
catch do |obj_B|
throw(obj_A, 123)
puts "This puts is still not reached"
end
puts "Now this puts is also not reached"
456
end
# => 123
;T;[o;
; I"
overload;F; 0;;; 0; I"catch([tag]);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"tag;T;"@/ o;!
; I" return;F; I" ;T;0; [I" Object;T;"@/ ;#[ ;$I""@yield [tag]
@return [Object];T;%0;"@/ ;&0;'F;(i ;[[I"
[tag];T0;"@/ ;#[ ;$I"+catch+ executes its block. If +throw+ is not called, the block executes
normally, and +catch+ returns the value of the last expression evaluated.
catch(1) { 123 } # => 123
If throw(tag2, val) is called, Ruby searches up its stack for
a +catch+ block whose +tag+ has the same +object_id+ as _tag2_. When found,
the block stops executing and returns _val_ (or +nil+ if no second argument
was given to +throw+).
catch(1) { throw(1, 456) } # => 456
catch(1) { throw(1) } # => nil
When +tag+ is passed as the first argument, +catch+ yields it as the
parameter of the block.
catch(1) {|x| x + 2 } # => 3
When no +tag+ is given, +catch+ yields a new unique object (as from
+Object.new+) as the block parameter. This object can then be used as the
argument to +throw+, and will match the correct +catch+ block.
catch do |obj_A|
catch do |obj_B|
throw(obj_B, 123)
puts "This puts is not reached"
end
puts "This puts is displayed"
456
end
# => 456
catch do |obj_A|
catch do |obj_B|
throw(obj_A, 123)
puts "This puts is still not reached"
end
puts "Now this puts is also not reached"
456
end
# => 123
@overload catch([tag])
@yield [tag]
@return [Object];T;%0;"@/ ;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"static VALUE
rb_f_catch(int argc, VALUE *argv)
{
VALUE tag;
if (argc == 0) {
tag = rb_obj_alloc(rb_cObject);
}
else {
rb_scan_args(argc, argv, "01", &tag);
}
return rb_catch_obj(tag, catch_i, 0);
};T;0To;
; F; ;
;;;I"Kernel#throw;F;[[@0;[[@y
iS;T;:
throw;0;[ ;{ ;IC;"1Transfers control to the end of the active +catch+ block
waiting for _tag_. Raises +UncaughtThrowError+ if there
is no +catch+ block for the _tag_. The optional second
parameter supplies a return value for the +catch+ block,
which otherwise defaults to +nil+. For examples, see
Kernel::catch.
;T;[o;
; I"
overload;F; 0;;; 0; I"throw(tag [, obj]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@R ;&0;'F;(i ;[[I"tag[, obj];T0;"@R ;#[ ;$I"PTransfers control to the end of the active +catch+ block
waiting for _tag_. Raises +UncaughtThrowError+ if there
is no +catch+ block for the _tag_. The optional second
parameter supplies a return value for the +catch+ block,
which otherwise defaults to +nil+. For examples, see
Kernel::catch.
@overload throw(tag [, obj]);T;%0;"@R ;'F;)o;*;+T;,iG;-iO;.@
; I"static VALUE;T;/I"static VALUE
rb_f_throw(int argc, VALUE *argv)
{
VALUE tag, value;
rb_scan_args(argc, argv, "11", &tag, &value);
rb_throw_obj(tag, value);
UNREACHABLE;
};T;0To;
; F; ;
;;;I"Kernel#loop;F;[ ;[[@y
iq;T;: loop;0;[ ;{ ;IC;"Repeatedly executes the block.
If no block is given, an enumerator is returned instead.
loop do
print "Input: "
line = gets
break if !line or line =~ /^qQ/
# ...
end
StopIteration raised in the block breaks the loop. In this case,
loop returns the "result" value stored in the exception.
enum = Enumerator.new { |y|
y << "one"
y << "two"
:ok
}
result = loop {
puts enum.next
} #=> :ok
;T;[o;
; I"
overload;F; 0;;; 0; I" loop;T;IC;" ;T;[o;!
; I"
yield;F; I"[];T;0; 0;"@k ;#[ ;$I"@yield [];T;%0;"@k ;&0;'F;(i ;[ ;"@k o;
; I"
overload;F; 0;;; 0; I" loop;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@k ;&0;'F;(i ;[ ;"@k ;#[ ;$I"Repeatedly executes the block.
If no block is given, an enumerator is returned instead.
loop do
print "Input: "
line = gets
break if !line or line =~ /^qQ/
# ...
end
StopIteration raised in the block breaks the loop. In this case,
loop returns the "result" value stored in the exception.
enum = Enumerator.new { |y|
y << "one"
y << "two"
:ok
}
result = loop {
puts enum.next
} #=> :ok
@overload loop
@yield []
@overload loop;T;%0;"@k ;'F;)o;*;+T;,iS;-in;.@
; I"static VALUE;T;/I"static VALUE
rb_f_loop(VALUE self)
{
RETURN_SIZED_ENUMERATOR(self, 0, 0, rb_f_loop_size);
return rb_rescue2(loop_i, (VALUE)0, loop_stop, (VALUE)0, rb_eStopIteration, (VALUE)0);
};T;0To;
; F; ;
;;;I"Kernel#srand;F;[[@0;[[I"
random.c;Ti;T;:
srand;0;[ ;{ ;IC;"zSeeds the system pseudo-random number generator, Random::DEFAULT, with
+number+. The previous seed value is returned.
If +number+ is omitted, seeds the generator using a source of entropy
provided by the operating system, if available (/dev/urandom on Unix systems
or the RSA cryptographic provider on Windows), which is then combined with
the time, the process id, and a sequence number.
srand may be used to ensure repeatable sequences of pseudo-random numbers
between different runs of the program. By setting the seed to a known value,
programs can be made deterministic during testing.
srand 1234 # => 268519324636777531569100071560086917274
[ rand, rand ] # => [0.1915194503788923, 0.6221087710398319]
[ rand(10), rand(1000) ] # => [4, 664]
srand 1234 # => 1234
[ rand, rand ] # => [0.1915194503788923, 0.6221087710398319]
;T;[o;
; I"
overload;F; 0;;; 0; I"$srand(number = Random.new_seed);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ ;&0;'F;(i ;[[I" number;TI"Random.new_seed;T;"@ ;#[ ;$I"Seeds the system pseudo-random number generator, Random::DEFAULT, with
+number+. The previous seed value is returned.
If +number+ is omitted, seeds the generator using a source of entropy
provided by the operating system, if available (/dev/urandom on Unix systems
or the RSA cryptographic provider on Windows), which is then combined with
the time, the process id, and a sequence number.
srand may be used to ensure repeatable sequences of pseudo-random numbers
between different runs of the program. By setting the seed to a known value,
programs can be made deterministic during testing.
srand 1234 # => 268519324636777531569100071560086917274
[ rand, rand ] # => [0.1915194503788923, 0.6221087710398319]
[ rand(10), rand(1000) ] # => [4, 664]
srand 1234 # => 1234
[ rand, rand ] # => [0.1915194503788923, 0.6221087710398319]
@overload srand(number = Random.new_seed);T;%0;"@ ;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"-static VALUE
rb_f_srand(int argc, VALUE *argv, VALUE obj)
{
VALUE seed, old;
rb_random_t *r = &default_rand;
if (argc == 0) {
seed = random_seed();
}
else {
rb_scan_args(argc, argv, "01", &seed);
}
old = r->seed;
r->seed = rand_init(&r->mt, seed);
return old;
};T;0To;
; F; ;
;;;I"Kernel#rand;F;[[@0;[[@ iu;T;: rand;0;[ ;{ ;IC;"0If called without an argument, or if max.to_i.abs == 0, rand
returns a pseudo-random floating point number between 0.0 and 1.0,
including 0.0 and excluding 1.0.
rand #=> 0.2725926052826416
When +max.abs+ is greater than or equal to 1, +rand+ returns a pseudo-random
integer greater than or equal to 0 and less than +max.to_i.abs+.
rand(100) #=> 12
When +max+ is a Range, +rand+ returns a random number where
range.member?(number) == true.
Negative or floating point values for +max+ are allowed, but may give
surprising results.
rand(-100) # => 87
rand(-0.5) # => 0.8130921818028143
rand(1.9) # equivalent to rand(1), which is always 0
Kernel.srand may be used to ensure that sequences of random numbers are
reproducible between different runs of a program.
See also Random.rand.
;T;[o;
; I"
overload;F; 0;;; 0; I"rand(max=0);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Numeric;T;"@ ;#[ ;$I"@return [Numeric];T;%0;"@ ;&0;'F;(i ;[[I"max;TI"0;T;"@ ;#[ ;$I"\If called without an argument, or if max.to_i.abs == 0, rand
returns a pseudo-random floating point number between 0.0 and 1.0,
including 0.0 and excluding 1.0.
rand #=> 0.2725926052826416
When +max.abs+ is greater than or equal to 1, +rand+ returns a pseudo-random
integer greater than or equal to 0 and less than +max.to_i.abs+.
rand(100) #=> 12
When +max+ is a Range, +rand+ returns a random number where
range.member?(number) == true.
Negative or floating point values for +max+ are allowed, but may give
surprising results.
rand(-100) # => 87
rand(-0.5) # => 0.8130921818028143
rand(1.9) # equivalent to rand(1), which is always 0
Kernel.srand may be used to ensure that sequences of random numbers are
reproducible between different runs of a program.
See also Random.rand.
@overload rand(max=0)
@return [Numeric];T;%0;"@ ;'F;)o;*;+T;,iV;-ir;.@
; I"static VALUE;T;/I"static VALUE
rb_f_rand(int argc, VALUE *argv, VALUE obj)
{
VALUE v, vmax, r;
rb_random_t *rnd = rand_start(&default_rand);
if (argc == 0) goto zero_arg;
rb_scan_args(argc, argv, "01", &vmax);
if (NIL_P(vmax)) goto zero_arg;
if ((v = rand_range(Qnil, rnd, vmax)) != Qfalse) {
return v;
}
vmax = rb_to_int(vmax);
if (vmax == INT2FIX(0) || NIL_P(r = rand_int(Qnil, rnd, vmax, 0))) {
zero_arg:
return DBL2NUM(genrand_real(&rnd->mt));
}
return r;
};T;0To;
; F; ;
;;;I"Kernel#proc;F;[ ;[[@i;T;: proc;0;[ ;{ ;IC;")Equivalent to Proc.new.
;T;[o;
; I"
overload;F; 0;;; 0; I" proc;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"...;T;"@ o;!
; I" return;F; I" ;T;0; [I" Proc;T;"@ ;#[ ;$I" @yield [...]
@return [Proc];T;%0;"@ ;&0;'F;(i ;[ ;"@ ;#[ ;$I"ZEquivalent to Proc.new.
@overload proc
@yield [...]
@return [Proc];T;%0;"@ ;'F;)o;*;+T;,i;-i;.@
; I"
VALUE;T;/I"HVALUE
rb_block_proc(void)
{
return proc_new(rb_cProc, FALSE);
};T;0To;
; F; ;
;;;I"Kernel#lambda;F;[ ;[[@i;T;: lambda;0;[ ;{ ;IC;"~Equivalent to Proc.new, except the resulting Proc objects
check the number of parameters passed when called.
;T;[o;
; I"
overload;F; 0;;; 0; I" lambda;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"...;T;"@ o;!
; I" return;F; I" ;T;0; [I" Proc;T;"@ ;#[ ;$I" @yield [...]
@return [Proc];T;%0;"@ ;&0;'F;(i ;[ ;"@ ;#[ ;$I"Equivalent to Proc.new, except the resulting Proc objects
check the number of parameters passed when called.
@overload lambda
@yield [...]
@return [Proc];T;%0;"@ ;'F;)o;*;+T;,i;-i;.@
; I"
VALUE;T;/I"IVALUE
rb_block_lambda(void)
{
return proc_new(rb_cProc, TRUE);
};T;0To;
; F; ;
;;;I"Kernel#binding;F;[ ;[[@iX;T;: binding;0;[ ;{ ;IC;"`Returns a +Binding+ object, describing the variable and
method bindings at the point of call. This object can be used when
calling +eval+ to execute the evaluated command in this
environment. See also the description of class +Binding+.
def get_binding(param)
return binding
end
b = get_binding("hello")
eval("param", b) #=> "hello"
;T;[o;
; I"
overload;F; 0;;; 0; I" binding;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Binding;T;"@
;#[ ;$I"@return [Binding];T;%0;"@
;&0;'F;(i ;[ ;"@
;#[ ;$I"Returns a +Binding+ object, describing the variable and
method bindings at the point of call. This object can be used when
calling +eval+ to execute the evaluated command in this
environment. See also the description of class +Binding+.
def get_binding(param)
return binding
end
b = get_binding("hello")
eval("param", b) #=> "hello"
@overload binding
@return [Binding];T;%0;"@
;'F;)o;*;+T;,iH;-iU;.@
; I"static VALUE;T;/I"Kstatic VALUE
rb_f_binding(VALUE self)
{
return rb_binding_new();
};T;0To;
; F; ;
;;;I"Kernel#load;F;[[@0;[[I" load.c;Ti;T;: load;0;[ ;{ ;IC;"Loads and executes the Ruby
program in the file _filename_. If the filename does not
resolve to an absolute path, the file is searched for in the library
directories listed in $:. If the optional _wrap_
parameter is +true+, the loaded script will be executed
under an anonymous module, protecting the calling program's global
namespace. In no circumstance will any local variables in the loaded
file be propagated to the loading environment.
;T;[o;
; I"
overload;F; 0;;; 0; I" load(filename, wrap=false);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" true;T;"@!
;#[ ;$I"@return [true];T;%0;"@!
;&0;'F;(i ;[[I"
filename;T0[I" wrap;TI"
false;T;"@!
;#[ ;$I"Loads and executes the Ruby
program in the file _filename_. If the filename does not
resolve to an absolute path, the file is searched for in the library
directories listed in $:. If the optional _wrap_
parameter is +true+, the loaded script will be executed
under an anonymous module, protecting the calling program's global
namespace. In no circumstance will any local variables in the loaded
file be propagated to the loading environment.
@overload load(filename, wrap=false)
@return [true];T;%0;"@!
;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"$static VALUE
rb_f_load(int argc, VALUE *argv)
{
VALUE fname, wrap, path, orig_fname;
rb_scan_args(argc, argv, "11", &fname, &wrap);
RUBY_DTRACE_HOOK(LOAD_ENTRY, StringValuePtr(fname));
orig_fname = FilePathValue(fname);
fname = rb_str_encode_ospath(orig_fname);
path = rb_find_file(fname);
if (!path) {
if (!rb_file_load_ok(RSTRING_PTR(fname)))
load_failed(orig_fname);
path = fname;
}
rb_load_internal(path, RTEST(wrap));
RUBY_DTRACE_HOOK(LOAD_RETURN, StringValuePtr(fname));
return Qtrue;
};T;0To;
; F; ;
;;;I"Kernel#require;F;[[I"
fname;T0;[[@'
i5;T;: require;0;[ ;{ ;IC;"ELoads the given +name+, returning +true+ if successful and +false+ if the
feature is already loaded.
If the filename does not resolve to an absolute path, it will be searched
for in the directories listed in $LOAD_PATH ($:).
If the filename has the extension ".rb", it is loaded as a source file; if
the extension is ".so", ".o", or ".dll", or the default shared library
extension on the current platform, Ruby loads the shared library as a
Ruby extension. Otherwise, Ruby tries adding ".rb", ".so", and so on
to the name until found. If the file named cannot be found, a LoadError
will be raised.
For Ruby extensions the filename given may use any shared library
extension. For example, on Linux the socket extension is "socket.so" and
require 'socket.dll' will load the socket extension.
The absolute path of the loaded file is added to
$LOADED_FEATURES ($"). A file will not be
loaded again if its path already appears in $". For example,
require 'a'; require './a' will not load a.rb
again.
require "my-library.rb"
require "db-driver"
Any constants or globals within the loaded source file will be available
in the calling program's global namespace. However, local variables will
not be propagated to the loading environment.
;T;[o;
; I"
overload;F; 0;;; 0; I"require(name);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@C
;#[ ;$I"@return [Boolean];T;%0;"@C
;&0;'F;(i ;[[I" name;T0;"@C
;#[ ;$I"tLoads the given +name+, returning +true+ if successful and +false+ if the
feature is already loaded.
If the filename does not resolve to an absolute path, it will be searched
for in the directories listed in $LOAD_PATH ($:).
If the filename has the extension ".rb", it is loaded as a source file; if
the extension is ".so", ".o", or ".dll", or the default shared library
extension on the current platform, Ruby loads the shared library as a
Ruby extension. Otherwise, Ruby tries adding ".rb", ".so", and so on
to the name until found. If the file named cannot be found, a LoadError
will be raised.
For Ruby extensions the filename given may use any shared library
extension. For example, on Linux the socket extension is "socket.so" and
require 'socket.dll' will load the socket extension.
The absolute path of the loaded file is added to
$LOADED_FEATURES ($"). A file will not be
loaded again if its path already appears in $". For example,
require 'a'; require './a' will not load a.rb
again.
require "my-library.rb"
require "db-driver"
Any constants or globals within the loaded source file will be available
in the calling program's global namespace. However, local variables will
not be propagated to the loading environment.
@overload require(name)
@return [Boolean];T;%0;"@C
;'F;)o;*;+T;,i;-i2;.@
; I"
VALUE;T;/I"gVALUE
rb_f_require(VALUE obj, VALUE fname)
{
return rb_require_safe(fname, rb_safe_level());
};T;0To;
; F; ;
;;;I" Kernel#require_relative;F;[[I"
fname;T0;[[@'
iC;T;:require_relative;0;[ ;{ ;IC;"Ruby tries to load the library named _string_ relative to the requiring
file's path. If the file's path cannot be determined a LoadError is raised.
If a file is loaded +true+ is returned and false otherwise.
;T;[o;
; I"
overload;F; 0;;; 0; I" require_relative(string);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@b
;#[ ;$I"@return [Boolean];T;%0;"@b
;&0;'F;(i ;[[I" string;T0;"@b
;#[ ;$I" Ruby tries to load the library named _string_ relative to the requiring
file's path. If the file's path cannot be determined a LoadError is raised.
If a file is loaded +true+ is returned and false otherwise.
@overload require_relative(string)
@return [Boolean];T;%0;"@b
;'F;)o;*;+T;,i;;-iA;.@
; I"
VALUE;T;/I"VALUE
rb_f_require_relative(VALUE obj, VALUE fname)
{
VALUE base = rb_current_realfilepath();
if (NIL_P(base)) {
rb_loaderror("cannot infer basepath");
}
base = rb_file_dirname(base);
return rb_require_safe(rb_file_absolute_path(fname, base), rb_safe_level());
};T;0To;
; F; ;
;;;I"Kernel#autoload;F;[[I"sym;T0[I" file;T0;[[@'
i{;T;:
autoload;0;[ ;{ ;IC;"Registers _filename_ to be loaded (using Kernel::require)
the first time that _module_ (which may be a String or
a symbol) is accessed.
autoload(:MyModule, "/usr/local/lib/modules/my_module.rb")
;T;[o;
; I"
overload;F; 0;;; 0; I" autoload(module, filename);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@
;#[ ;$I"@return [nil];T;%0;"@
;&0;'F;(i ;[ ;"@
;#[ ;$I"Registers _filename_ to be loaded (using Kernel::require)
the first time that _module_ (which may be a String or
a symbol) is accessed.
autoload(:MyModule, "/usr/local/lib/modules/my_module.rb")
@overload autoload(module, filename)
@return [nil];T;%0;"@
;'F;)o;*;+T;,ip;-ix;.@
; I"static VALUE;T;/I"static VALUE
rb_f_autoload(VALUE obj, VALUE sym, VALUE file)
{
VALUE klass = rb_class_real(rb_vm_cbase());
if (NIL_P(klass)) {
rb_raise(rb_eTypeError, "Can not set autoload on singleton class");
}
return rb_mod_autoload(klass, sym, file);
};T;0To;
; F; ;
;;;I"Kernel#autoload?;F;[[I"sym;T0;[[@'
i;T;:autoload?;0;[ ;{ ;IC;"Returns _filename_ to be loaded if _name_ is registered as
+autoload+.
autoload(:B, "b")
autoload?(:B) #=> "b"
;T;[o;
; I"
overload;F; 0;;; 0; I"autoload?(name);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@
;#[ ;$I"@return [String, nil];T;%0;"@
;&0;'F;(i ;[[I" name;T0;"@
o;!
; I" return;F; @;0; [@;"@
;#[ ;$I"Returns _filename_ to be loaded if _name_ is registered as
+autoload+.
autoload(:B, "b")
autoload?(:B) #=> "b"
@overload autoload?(name)
@return [String, nil];T;%0;"@
;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"static VALUE
rb_f_autoload_p(VALUE obj, VALUE sym)
{
/* use rb_vm_cbase() as same as rb_f_autoload. */
VALUE klass = rb_vm_cbase();
if (NIL_P(klass)) {
return Qnil;
}
return rb_mod_autoload_p(klass, sym);
};T;0To;
; F; ;
;;;I"Kernel#exec;F;[[@0;[[I"process.c;Ti
;T;: exec;0;[ ;{ ;IC;"A
Replaces the current process by running the given external _command_, which
can take one of the following forms:
[exec(commandline)]
command line string which is passed to the standard shell
[exec(cmdname, arg1, ...)]
command name and one or more arguments (no shell)
[exec([cmdname, argv0], arg1, ...)]
command name, argv[0] and zero or more arguments (no shell)
In the first form, the string is taken as a command line that is subject to
shell expansion before being executed.
The standard shell always means "/bin/sh" on Unix-like systems,
same as ENV["RUBYSHELL"]
(or ENV["COMSPEC"] on Windows NT series), and similar.
If the string from the first form (exec("command")) follows
these simple rules:
* no meta characters
* no shell reserved word and no special built-in
* Ruby invokes the command directly without shell
You can force shell invocation by adding ";" to the string (because ";" is
a meta character).
Note that this behavior is observable by pid obtained
(return value of spawn() and IO#pid for IO.popen) is the pid of the invoked
command, not shell.
In the second form (exec("command1", "arg1", ...)), the first
is taken as a command name and the rest are passed as parameters to command
with no shell expansion.
In the third form (exec(["command", "argv0"], "arg1", ...)),
starting a two-element array at the beginning of the command, the first
element is the command to be executed, and the second argument is used as
the argv[0] value, which may show up in process listings.
In order to execute the command, one of the exec(2) system
calls are used, so the running command may inherit some of the environment
of the original program (including open file descriptors).
This behavior is modified by the given +env+ and +options+ parameters. See
::spawn for details.
If the command fails to execute (typically Errno::ENOENT when
it was not found) a SystemCallError exception is raised.
This method modifies process attributes according to given +options+ before
exec(2) system call. See ::spawn for more details about the
given +options+.
The modified attributes may be retained when exec(2) system
call fails.
For example, hard resource limits are not restorable.
Consider to create a child process using ::spawn or Kernel#system if this
is not acceptable.
exec "echo *" # echoes list of files in current directory
# never get here
exec "echo", "*" # echoes an asterisk
# never get here
;T;[o;
; I"
overload;F; 0;;; 0; I"'exec([env,] command... [,options]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@
;&0;'F;(i ;[[I"[env,][,options];T0;"@
;#[ ;$I"p
Replaces the current process by running the given external _command_, which
can take one of the following forms:
[exec(commandline)]
command line string which is passed to the standard shell
[exec(cmdname, arg1, ...)]
command name and one or more arguments (no shell)
[exec([cmdname, argv0], arg1, ...)]
command name, argv[0] and zero or more arguments (no shell)
In the first form, the string is taken as a command line that is subject to
shell expansion before being executed.
The standard shell always means "/bin/sh" on Unix-like systems,
same as ENV["RUBYSHELL"]
(or ENV["COMSPEC"] on Windows NT series), and similar.
If the string from the first form (exec("command")) follows
these simple rules:
* no meta characters
* no shell reserved word and no special built-in
* Ruby invokes the command directly without shell
You can force shell invocation by adding ";" to the string (because ";" is
a meta character).
Note that this behavior is observable by pid obtained
(return value of spawn() and IO#pid for IO.popen) is the pid of the invoked
command, not shell.
In the second form (exec("command1", "arg1", ...)), the first
is taken as a command name and the rest are passed as parameters to command
with no shell expansion.
In the third form (exec(["command", "argv0"], "arg1", ...)),
starting a two-element array at the beginning of the command, the first
element is the command to be executed, and the second argument is used as
the argv[0] value, which may show up in process listings.
In order to execute the command, one of the exec(2) system
calls are used, so the running command may inherit some of the environment
of the original program (including open file descriptors).
This behavior is modified by the given +env+ and +options+ parameters. See
::spawn for details.
If the command fails to execute (typically Errno::ENOENT when
it was not found) a SystemCallError exception is raised.
This method modifies process attributes according to given +options+ before
exec(2) system call. See ::spawn for more details about the
given +options+.
The modified attributes may be retained when exec(2) system
call fails.
For example, hard resource limits are not restorable.
Consider to create a child process using ::spawn or Kernel#system if this
is not acceptable.
exec "echo *" # echoes list of files in current directory
# never get here
exec "echo", "*" # echoes an asterisk
# never get here
@overload exec([env,] command... [,options]);T;%0;"@
;'F;)o;*;+T;,i ;-i
;.@
; I"
VALUE;T;/I"VALUE
rb_f_exec(int argc, const VALUE *argv)
{
VALUE execarg_obj, fail_str;
struct rb_execarg *eargp;
#define CHILD_ERRMSG_BUFLEN 80
char errmsg[CHILD_ERRMSG_BUFLEN] = { '\0' };
int err;
execarg_obj = rb_execarg_new(argc, argv, TRUE);
eargp = rb_execarg_get(execarg_obj);
before_exec(); /* stop timer thread before redirects */
rb_execarg_parent_start(execarg_obj);
fail_str = eargp->use_shell ? eargp->invoke.sh.shell_script : eargp->invoke.cmd.command_name;
rb_exec_async_signal_safe(eargp, errmsg, sizeof(errmsg));
err = errno;
after_exec(); /* restart timer thread */
rb_exec_fail(eargp, err, errmsg);
RB_GC_GUARD(execarg_obj);
rb_syserr_fail_str(err, fail_str);
return Qnil; /* dummy */
};T;0To;
; F; ;
;;;I"Kernel#fork;F;[ ;[[@
i~;T;: fork;0;[ ;{ ;IC;"Creates a subprocess. If a block is specified, that block is run
in the subprocess, and the subprocess terminates with a status of
zero. Otherwise, the +fork+ call returns twice, once in
the parent, returning the process ID of the child, and once in
the child, returning _nil_. The child process can exit using
Kernel.exit! to avoid running any
at_exit functions. The parent process should
use Process.wait to collect the termination statuses
of its children or use Process.detach to register
disinterest in their status; otherwise, the operating system
may accumulate zombie processes.
The thread calling fork is the only thread in the created child process.
fork doesn't copy other threads.
If fork is not usable, Process.respond_to?(:fork) returns false.
Note that fork(2) is not available on some platforms like Windows and NetBSD 4.
Therefore you should use spawn() instead of fork().
;T;[o;
; I"
overload;F; 0;;; 0; I" fork;T;IC;" ;T;[o;!
; I"
yield;F; I"[];T;0; 0;"@
o;!
; I" return;F; I" ;T;0; [I" Fixnum;TI"nil;T;"@
;#[ ;$I"$@yield []
@return [Fixnum, nil];T;%0;"@
;&0;'F;(i ;[ ;"@
o;
; I"
overload;F; 0;;; 0; I" fork;T;IC;" ;T;[o;!
; I"
yield;F; I"[];T;0; 0;"@
o;!
; I" return;F; I" ;T;0; [I" Fixnum;TI"nil;T;"@
;#[ ;$I"$@yield []
@return [Fixnum, nil];T;%0;"@
;&0;'F;(i ;[ ;"@
;#[ ;$I"Creates a subprocess. If a block is specified, that block is run
in the subprocess, and the subprocess terminates with a status of
zero. Otherwise, the +fork+ call returns twice, once in
the parent, returning the process ID of the child, and once in
the child, returning _nil_. The child process can exit using
Kernel.exit! to avoid running any
at_exit functions. The parent process should
use Process.wait to collect the termination statuses
of its children or use Process.detach to register
disinterest in their status; otherwise, the operating system
may accumulate zombie processes.
The thread calling fork is the only thread in the created child process.
fork doesn't copy other threads.
If fork is not usable, Process.respond_to?(:fork) returns false.
Note that fork(2) is not available on some platforms like Windows and NetBSD 4.
Therefore you should use spawn() instead of fork().
@overload fork
@yield []
@return [Fixnum, nil]
@overload fork
@yield []
@return [Fixnum, nil];T;%0;"@
;'F;)o;*;+T;,id;-i~;.@
; I"static VALUE;T;/I"istatic VALUE
rb_f_fork(VALUE obj)
{
rb_pid_t pid;
switch (pid = rb_fork_ruby(NULL)) {
case 0:
rb_thread_atfork();
if (rb_block_given_p()) {
int status;
rb_protect(rb_yield, Qundef, &status);
ruby_stop(status);
}
return Qnil;
case -1:
rb_sys_fail("fork(2)");
return Qnil;
default:
return PIDT2NUM(pid);
}
};T;0To;
; F; ;
;;;I"Kernel#exit!;F;[[@0;[[@
i;T;:
exit!;0;[ ;{ ;IC;"Exits the process immediately. No exit handlers are
run. status is returned to the underlying system as the
exit status.
Process.exit!(true)
;T;[o;
; I"
overload;F; 0;;; 0; I"exit!(status=false);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@
;&0;'F;(i ;[[I" status;TI"
false;T;"@
;#[ ;$I"Exits the process immediately. No exit handlers are
run. status is returned to the underlying system as the
exit status.
Process.exit!(true)
@overload exit!(status=false);T;%0;"@
;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"$static VALUE
rb_f_exit_bang(int argc, VALUE *argv, VALUE obj)
{
VALUE status;
int istatus;
if (argc > 0 && rb_scan_args(argc, argv, "01", &status) == 1) {
istatus = exit_status_code(status);
}
else {
istatus = EXIT_FAILURE;
}
_exit(istatus);
UNREACHABLE;
};T;0To;
; F; ;
;;;I"Kernel#system;F;[[@0;[[@
i;T;: system;0;[ ;{ ;IC;"uExecutes _command..._ in a subshell.
_command..._ is one of following forms.
commandline : command line string which is passed to the standard shell
cmdname, arg1, ... : command name and one or more arguments (no shell)
[cmdname, argv0], arg1, ... : command name, argv[0] and zero or more arguments (no shell)
system returns +true+ if the command gives zero exit status,
+false+ for non zero exit status.
Returns +nil+ if command execution fails.
An error status is available in $?.
The arguments are processed in the same way as
for Kernel.spawn.
The hash arguments, env and options, are same as
exec and spawn.
See Kernel.spawn for details.
system("echo *")
system("echo", "*")
produces:
config.h main.rb
*
See Kernel.exec for the standard shell.
;T;[o;
; I"
overload;F; 0;;; 0; I")system([env,] command... [,options]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" true;TI"
false;TI"nil;T;"@';#[ ;$I" @return [true, false, nil];T;%0;"@';&0;'F;(i ;[[I"[env,][,options];T0;"@';#[ ;$I"Executes _command..._ in a subshell.
_command..._ is one of following forms.
commandline : command line string which is passed to the standard shell
cmdname, arg1, ... : command name and one or more arguments (no shell)
[cmdname, argv0], arg1, ... : command name, argv[0] and zero or more arguments (no shell)
system returns +true+ if the command gives zero exit status,
+false+ for non zero exit status.
Returns +nil+ if command execution fails.
An error status is available in $?.
The arguments are processed in the same way as
for Kernel.spawn.
The hash arguments, env and options, are same as
exec and spawn.
See Kernel.spawn for details.
system("echo *")
system("echo", "*")
produces:
config.h main.rb
*
See Kernel.exec for the standard shell.
@overload system([env,] command... [,options])
@return [true, false, nil];T;%0;"@';'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I" static VALUE
rb_f_system(int argc, VALUE *argv)
{
rb_pid_t pid;
int status;
#if defined(SIGCLD) && !defined(SIGCHLD)
# define SIGCHLD SIGCLD
#endif
#ifdef SIGCHLD
RETSIGTYPE (*chfunc)(int);
rb_last_status_clear();
chfunc = signal(SIGCHLD, SIG_DFL);
#endif
pid = rb_spawn_internal(argc, argv, NULL, 0);
#if defined(HAVE_WORKING_FORK) || defined(HAVE_SPAWNV)
if (pid > 0) {
int ret, status;
ret = rb_waitpid(pid, &status, 0);
if (ret == (rb_pid_t)-1)
rb_sys_fail("Another thread waited the process started by system().");
}
#endif
#ifdef SIGCHLD
signal(SIGCHLD, chfunc);
#endif
if (pid < 0) {
return Qnil;
}
status = PST2INT(rb_last_status_get());
if (status == EXIT_SUCCESS) return Qtrue;
return Qfalse;
};T;0To;
; F; ;
;;;I"Kernel#spawn;F;[[@0;[[@
i;T;:
spawn;0;[ ;{ ;IC;"c*spawn executes specified command and return its pid.
pid = spawn("tar xf ruby-2.0.0-p195.tar.bz2")
Process.wait pid
pid = spawn(RbConfig.ruby, "-eputs'Hello, world!'")
Process.wait pid
This method is similar to Kernel#system but it doesn't wait for the command
to finish.
The parent process should
use Process.wait to collect
the termination status of its child or
use Process.detach to register
disinterest in their status;
otherwise, the operating system may accumulate zombie processes.
spawn has bunch of options to specify process attributes:
env: hash
name => val : set the environment variable
name => nil : unset the environment variable
the keys and the values except for +nil+ must be strings.
command...:
commandline : command line string which is passed to the standard shell
cmdname, arg1, ... : command name and one or more arguments (This form does not use the shell. See below for caveats.)
[cmdname, argv0], arg1, ... : command name, argv[0] and zero or more arguments (no shell)
options: hash
clearing environment variables:
:unsetenv_others => true : clear environment variables except specified by env
:unsetenv_others => false : don't clear (default)
process group:
:pgroup => true or 0 : make a new process group
:pgroup => pgid : join the specified process group
:pgroup => nil : don't change the process group (default)
create new process group: Windows only
:new_pgroup => true : the new process is the root process of a new process group
:new_pgroup => false : don't create a new process group (default)
resource limit: resourcename is core, cpu, data, etc. See Process.setrlimit.
:rlimit_resourcename => limit
:rlimit_resourcename => [cur_limit, max_limit]
umask:
:umask => int
redirection:
key:
FD : single file descriptor in child process
[FD, FD, ...] : multiple file descriptor in child process
value:
FD : redirect to the file descriptor in parent process
string : redirect to file with open(string, "r" or "w")
[string] : redirect to file with open(string, File::RDONLY)
[string, open_mode] : redirect to file with open(string, open_mode, 0644)
[string, open_mode, perm] : redirect to file with open(string, open_mode, perm)
[:child, FD] : redirect to the redirected file descriptor
:close : close the file descriptor in child process
FD is one of follows
:in : the file descriptor 0 which is the standard input
:out : the file descriptor 1 which is the standard output
:err : the file descriptor 2 which is the standard error
integer : the file descriptor of specified the integer
io : the file descriptor specified as io.fileno
file descriptor inheritance: close non-redirected non-standard fds (3, 4, 5, ...) or not
:close_others => true : don't inherit
current directory:
:chdir => str
The 'cmdname, arg1, ...' form does not use the shell. However,
on different OSes, different things are provided as built-in
commands. An example of this is 'echo', which is a built-in
on Windows, but is a normal program on Linux and Mac OS X.
This means that `Process.spawn 'echo', '%Path%'` will display
the contents of the `%Path%` environment variable on Windows,
but `Process.spawn 'echo', '$PATH'` prints the literal '$PATH'.
If a hash is given as +env+, the environment is
updated by +env+ before exec(2) in the child process.
If a pair in +env+ has nil as the value, the variable is deleted.
# set FOO as BAR and unset BAZ.
pid = spawn({"FOO"=>"BAR", "BAZ"=>nil}, command)
If a hash is given as +options+,
it specifies
process group,
create new process group,
resource limit,
current directory,
umask and
redirects for the child process.
Also, it can be specified to clear environment variables.
The :unsetenv_others key in +options+ specifies
to clear environment variables, other than specified by +env+.
pid = spawn(command, :unsetenv_others=>true) # no environment variable
pid = spawn({"FOO"=>"BAR"}, command, :unsetenv_others=>true) # FOO only
The :pgroup key in +options+ specifies a process group.
The corresponding value should be true, zero, a positive integer, or nil.
true and zero cause the process to be a process leader of a new process group.
A non-zero positive integer causes the process to join the provided process group.
The default value, nil, causes the process to remain in the same process group.
pid = spawn(command, :pgroup=>true) # process leader
pid = spawn(command, :pgroup=>10) # belongs to the process group 10
The :new_pgroup key in +options+ specifies to pass
+CREATE_NEW_PROCESS_GROUP+ flag to CreateProcessW() that is
Windows API. This option is only for Windows.
true means the new process is the root process of the new process group.
The new process has CTRL+C disabled. This flag is necessary for
Process.kill(:SIGINT, pid) on the subprocess.
:new_pgroup is false by default.
pid = spawn(command, :new_pgroup=>true) # new process group
pid = spawn(command, :new_pgroup=>false) # same process group
The :rlimit_foo key specifies a resource limit.
foo should be one of resource types such as core.
The corresponding value should be an integer or an array which have one or
two integers: same as cur_limit and max_limit arguments for
Process.setrlimit.
cur, max = Process.getrlimit(:CORE)
pid = spawn(command, :rlimit_core=>[0,max]) # disable core temporary.
pid = spawn(command, :rlimit_core=>max) # enable core dump
pid = spawn(command, :rlimit_core=>0) # never dump core.
The :umask key in +options+ specifies the umask.
pid = spawn(command, :umask=>077)
The :in, :out, :err, a fixnum, an IO and an array key specifies a redirection.
The redirection maps a file descriptor in the child process.
For example, stderr can be merged into stdout as follows:
pid = spawn(command, :err=>:out)
pid = spawn(command, 2=>1)
pid = spawn(command, STDERR=>:out)
pid = spawn(command, STDERR=>STDOUT)
The hash keys specifies a file descriptor
in the child process started by spawn.
:err, 2 and STDERR specifies the standard error stream (stderr).
The hash values specifies a file descriptor
in the parent process which invokes spawn.
:out, 1 and STDOUT specifies the standard output stream (stdout).
In the above example,
the standard output in the child process is not specified.
So it is inherited from the parent process.
The standard input stream (stdin) can be specified by :in, 0 and STDIN.
A filename can be specified as a hash value.
pid = spawn(command, :in=>"/dev/null") # read mode
pid = spawn(command, :out=>"/dev/null") # write mode
pid = spawn(command, :err=>"log") # write mode
pid = spawn(command, [:out, :err]=>"/dev/null") # write mode
pid = spawn(command, 3=>"/dev/null") # read mode
For stdout and stderr (and combination of them),
it is opened in write mode.
Otherwise read mode is used.
For specifying flags and permission of file creation explicitly,
an array is used instead.
pid = spawn(command, :in=>["file"]) # read mode is assumed
pid = spawn(command, :in=>["file", "r"])
pid = spawn(command, :out=>["log", "w"]) # 0644 assumed
pid = spawn(command, :out=>["log", "w", 0600])
pid = spawn(command, :out=>["log", File::WRONLY|File::EXCL|File::CREAT, 0600])
The array specifies a filename, flags and permission.
The flags can be a string or an integer.
If the flags is omitted or nil, File::RDONLY is assumed.
The permission should be an integer.
If the permission is omitted or nil, 0644 is assumed.
If an array of IOs and integers are specified as a hash key,
all the elements are redirected.
# stdout and stderr is redirected to log file.
# The file "log" is opened just once.
pid = spawn(command, [:out, :err]=>["log", "w"])
Another way to merge multiple file descriptors is [:child, fd].
\[:child, fd] means the file descriptor in the child process.
This is different from fd.
For example, :err=>:out means redirecting child stderr to parent stdout.
But :err=>[:child, :out] means redirecting child stderr to child stdout.
They differ if stdout is redirected in the child process as follows.
# stdout and stderr is redirected to log file.
# The file "log" is opened just once.
pid = spawn(command, :out=>["log", "w"], :err=>[:child, :out])
\[:child, :out] can be used to merge stderr into stdout in IO.popen.
In this case, IO.popen redirects stdout to a pipe in the child process
and [:child, :out] refers the redirected stdout.
io = IO.popen(["sh", "-c", "echo out; echo err >&2", :err=>[:child, :out]])
p io.read #=> "out\nerr\n"
The :chdir key in +options+ specifies the current directory.
pid = spawn(command, :chdir=>"/var/tmp")
spawn closes all non-standard unspecified descriptors by default.
The "standard" descriptors are 0, 1 and 2.
This behavior is specified by :close_others option.
:close_others doesn't affect the standard descriptors which are
closed only if :close is specified explicitly.
pid = spawn(command, :close_others=>true) # close 3,4,5,... (default)
pid = spawn(command, :close_others=>false) # don't close 3,4,5,...
:close_others is true by default for spawn and IO.popen.
Note that fds which close-on-exec flag is already set are closed
regardless of :close_others option.
So IO.pipe and spawn can be used as IO.popen.
# similar to r = IO.popen(command)
r, w = IO.pipe
pid = spawn(command, :out=>w) # r, w is closed in the child process.
w.close
:close is specified as a hash value to close a fd individually.
f = open(foo)
system(command, f=>:close) # don't inherit f.
If a file descriptor need to be inherited,
io=>io can be used.
# valgrind has --log-fd option for log destination.
# log_w=>log_w indicates log_w.fileno inherits to child process.
log_r, log_w = IO.pipe
pid = spawn("valgrind", "--log-fd=#{log_w.fileno}", "echo", "a", log_w=>log_w)
log_w.close
p log_r.read
It is also possible to exchange file descriptors.
pid = spawn(command, :out=>:err, :err=>:out)
The hash keys specify file descriptors in the child process.
The hash values specifies file descriptors in the parent process.
So the above specifies exchanging stdout and stderr.
Internally, +spawn+ uses an extra file descriptor to resolve such cyclic
file descriptor mapping.
See Kernel.exec for the standard shell.
;T;[o;
; I"
overload;F; 0;;; 0; I"(spawn([env,] command... [,options]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@G;&0;'F;(i ;[[I"[env,][,options];T0;"@Go;
; I"
overload;F; 0;;; 0; I"(spawn([env,] command... [,options]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@G;&0;'F;(i ;[[I"[env,][,options];T0;"@G;#[ ;$I"*spawn executes specified command and return its pid.
pid = spawn("tar xf ruby-2.0.0-p195.tar.bz2")
Process.wait pid
pid = spawn(RbConfig.ruby, "-eputs'Hello, world!'")
Process.wait pid
This method is similar to Kernel#system but it doesn't wait for the command
to finish.
The parent process should
use Process.wait to collect
the termination status of its child or
use Process.detach to register
disinterest in their status;
otherwise, the operating system may accumulate zombie processes.
spawn has bunch of options to specify process attributes:
env: hash
name => val : set the environment variable
name => nil : unset the environment variable
the keys and the values except for +nil+ must be strings.
command...:
commandline : command line string which is passed to the standard shell
cmdname, arg1, ... : command name and one or more arguments (This form does not use the shell. See below for caveats.)
[cmdname, argv0], arg1, ... : command name, argv[0] and zero or more arguments (no shell)
options: hash
clearing environment variables:
:unsetenv_others => true : clear environment variables except specified by env
:unsetenv_others => false : don't clear (default)
process group:
:pgroup => true or 0 : make a new process group
:pgroup => pgid : join the specified process group
:pgroup => nil : don't change the process group (default)
create new process group: Windows only
:new_pgroup => true : the new process is the root process of a new process group
:new_pgroup => false : don't create a new process group (default)
resource limit: resourcename is core, cpu, data, etc. See Process.setrlimit.
:rlimit_resourcename => limit
:rlimit_resourcename => [cur_limit, max_limit]
umask:
:umask => int
redirection:
key:
FD : single file descriptor in child process
[FD, FD, ...] : multiple file descriptor in child process
value:
FD : redirect to the file descriptor in parent process
string : redirect to file with open(string, "r" or "w")
[string] : redirect to file with open(string, File::RDONLY)
[string, open_mode] : redirect to file with open(string, open_mode, 0644)
[string, open_mode, perm] : redirect to file with open(string, open_mode, perm)
[:child, FD] : redirect to the redirected file descriptor
:close : close the file descriptor in child process
FD is one of follows
:in : the file descriptor 0 which is the standard input
:out : the file descriptor 1 which is the standard output
:err : the file descriptor 2 which is the standard error
integer : the file descriptor of specified the integer
io : the file descriptor specified as io.fileno
file descriptor inheritance: close non-redirected non-standard fds (3, 4, 5, ...) or not
:close_others => true : don't inherit
current directory:
:chdir => str
The 'cmdname, arg1, ...' form does not use the shell. However,
on different OSes, different things are provided as built-in
commands. An example of this is 'echo', which is a built-in
on Windows, but is a normal program on Linux and Mac OS X.
This means that `Process.spawn 'echo', '%Path%'` will display
the contents of the `%Path%` environment variable on Windows,
but `Process.spawn 'echo', '$PATH'` prints the literal '$PATH'.
If a hash is given as +env+, the environment is
updated by +env+ before exec(2) in the child process.
If a pair in +env+ has nil as the value, the variable is deleted.
# set FOO as BAR and unset BAZ.
pid = spawn({"FOO"=>"BAR", "BAZ"=>nil}, command)
If a hash is given as +options+,
it specifies
process group,
create new process group,
resource limit,
current directory,
umask and
redirects for the child process.
Also, it can be specified to clear environment variables.
The :unsetenv_others key in +options+ specifies
to clear environment variables, other than specified by +env+.
pid = spawn(command, :unsetenv_others=>true) # no environment variable
pid = spawn({"FOO"=>"BAR"}, command, :unsetenv_others=>true) # FOO only
The :pgroup key in +options+ specifies a process group.
The corresponding value should be true, zero, a positive integer, or nil.
true and zero cause the process to be a process leader of a new process group.
A non-zero positive integer causes the process to join the provided process group.
The default value, nil, causes the process to remain in the same process group.
pid = spawn(command, :pgroup=>true) # process leader
pid = spawn(command, :pgroup=>10) # belongs to the process group 10
The :new_pgroup key in +options+ specifies to pass
+CREATE_NEW_PROCESS_GROUP+ flag to CreateProcessW() that is
Windows API. This option is only for Windows.
true means the new process is the root process of the new process group.
The new process has CTRL+C disabled. This flag is necessary for
Process.kill(:SIGINT, pid) on the subprocess.
:new_pgroup is false by default.
pid = spawn(command, :new_pgroup=>true) # new process group
pid = spawn(command, :new_pgroup=>false) # same process group
The :rlimit_foo key specifies a resource limit.
foo should be one of resource types such as core.
The corresponding value should be an integer or an array which have one or
two integers: same as cur_limit and max_limit arguments for
Process.setrlimit.
cur, max = Process.getrlimit(:CORE)
pid = spawn(command, :rlimit_core=>[0,max]) # disable core temporary.
pid = spawn(command, :rlimit_core=>max) # enable core dump
pid = spawn(command, :rlimit_core=>0) # never dump core.
The :umask key in +options+ specifies the umask.
pid = spawn(command, :umask=>077)
The :in, :out, :err, a fixnum, an IO and an array key specifies a redirection.
The redirection maps a file descriptor in the child process.
For example, stderr can be merged into stdout as follows:
pid = spawn(command, :err=>:out)
pid = spawn(command, 2=>1)
pid = spawn(command, STDERR=>:out)
pid = spawn(command, STDERR=>STDOUT)
The hash keys specifies a file descriptor
in the child process started by spawn.
:err, 2 and STDERR specifies the standard error stream (stderr).
The hash values specifies a file descriptor
in the parent process which invokes spawn.
:out, 1 and STDOUT specifies the standard output stream (stdout).
In the above example,
the standard output in the child process is not specified.
So it is inherited from the parent process.
The standard input stream (stdin) can be specified by :in, 0 and STDIN.
A filename can be specified as a hash value.
pid = spawn(command, :in=>"/dev/null") # read mode
pid = spawn(command, :out=>"/dev/null") # write mode
pid = spawn(command, :err=>"log") # write mode
pid = spawn(command, [:out, :err]=>"/dev/null") # write mode
pid = spawn(command, 3=>"/dev/null") # read mode
For stdout and stderr (and combination of them),
it is opened in write mode.
Otherwise read mode is used.
For specifying flags and permission of file creation explicitly,
an array is used instead.
pid = spawn(command, :in=>["file"]) # read mode is assumed
pid = spawn(command, :in=>["file", "r"])
pid = spawn(command, :out=>["log", "w"]) # 0644 assumed
pid = spawn(command, :out=>["log", "w", 0600])
pid = spawn(command, :out=>["log", File::WRONLY|File::EXCL|File::CREAT, 0600])
The array specifies a filename, flags and permission.
The flags can be a string or an integer.
If the flags is omitted or nil, File::RDONLY is assumed.
The permission should be an integer.
If the permission is omitted or nil, 0644 is assumed.
If an array of IOs and integers are specified as a hash key,
all the elements are redirected.
# stdout and stderr is redirected to log file.
# The file "log" is opened just once.
pid = spawn(command, [:out, :err]=>["log", "w"])
Another way to merge multiple file descriptors is [:child, fd].
\[:child, fd] means the file descriptor in the child process.
This is different from fd.
For example, :err=>:out means redirecting child stderr to parent stdout.
But :err=>[:child, :out] means redirecting child stderr to child stdout.
They differ if stdout is redirected in the child process as follows.
# stdout and stderr is redirected to log file.
# The file "log" is opened just once.
pid = spawn(command, :out=>["log", "w"], :err=>[:child, :out])
\[:child, :out] can be used to merge stderr into stdout in IO.popen.
In this case, IO.popen redirects stdout to a pipe in the child process
and [:child, :out] refers the redirected stdout.
io = IO.popen(["sh", "-c", "echo out; echo err >&2", :err=>[:child, :out]])
p io.read #=> "out\nerr\n"
The :chdir key in +options+ specifies the current directory.
pid = spawn(command, :chdir=>"/var/tmp")
spawn closes all non-standard unspecified descriptors by default.
The "standard" descriptors are 0, 1 and 2.
This behavior is specified by :close_others option.
:close_others doesn't affect the standard descriptors which are
closed only if :close is specified explicitly.
pid = spawn(command, :close_others=>true) # close 3,4,5,... (default)
pid = spawn(command, :close_others=>false) # don't close 3,4,5,...
:close_others is true by default for spawn and IO.popen.
Note that fds which close-on-exec flag is already set are closed
regardless of :close_others option.
So IO.pipe and spawn can be used as IO.popen.
# similar to r = IO.popen(command)
r, w = IO.pipe
pid = spawn(command, :out=>w) # r, w is closed in the child process.
w.close
:close is specified as a hash value to close a fd individually.
f = open(foo)
system(command, f=>:close) # don't inherit f.
If a file descriptor need to be inherited,
io=>io can be used.
# valgrind has --log-fd option for log destination.
# log_w=>log_w indicates log_w.fileno inherits to child process.
log_r, log_w = IO.pipe
pid = spawn("valgrind", "--log-fd=#{log_w.fileno}", "echo", "a", log_w=>log_w)
log_w.close
p log_r.read
It is also possible to exchange file descriptors.
pid = spawn(command, :out=>:err, :err=>:out)
The hash keys specify file descriptors in the child process.
The hash values specifies file descriptors in the parent process.
So the above specifies exchanging stdout and stderr.
Internally, +spawn+ uses an extra file descriptor to resolve such cyclic
file descriptor mapping.
See Kernel.exec for the standard shell.
@overload spawn([env,] command... [,options])
@overload spawn([env,] command... [,options]);T;%0;"@G;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"static VALUE
rb_f_spawn(int argc, VALUE *argv)
{
rb_pid_t pid;
char errmsg[CHILD_ERRMSG_BUFLEN] = { '\0' };
VALUE execarg_obj, fail_str;
struct rb_execarg *eargp;
execarg_obj = rb_execarg_new(argc, argv, TRUE);
eargp = rb_execarg_get(execarg_obj);
fail_str = eargp->use_shell ? eargp->invoke.sh.shell_script : eargp->invoke.cmd.command_name;
pid = rb_execarg_spawn(execarg_obj, errmsg, sizeof(errmsg));
if (pid == -1) {
int err = errno;
rb_exec_fail(eargp, err, errmsg);
RB_GC_GUARD(execarg_obj);
rb_syserr_fail_str(err, fail_str);
}
#if defined(HAVE_WORKING_FORK) || defined(HAVE_SPAWNV)
return PIDT2NUM(pid);
#else
return Qnil;
#endif
};T;0To;
; F; ;
;;;I"Kernel#sleep;F;[[@0;[[@
i4;T;:
sleep;0;[ ;{ ;IC;"Suspends the current thread for _duration_ seconds (which may be any number,
including a +Float+ with fractional seconds). Returns the actual number of
seconds slept (rounded), which may be less than that asked for if another
thread calls Thread#run. Called without an argument, sleep()
will sleep forever.
Time.new #=> 2008-03-08 19:56:19 +0900
sleep 1.2 #=> 1
Time.new #=> 2008-03-08 19:56:20 +0900
sleep 1.9 #=> 2
Time.new #=> 2008-03-08 19:56:22 +0900
;T;[o;
; I"
overload;F; 0;;; 0; I"sleep([duration]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;T;"@j;#[ ;$I"@return [Fixnum];T;%0;"@j;&0;'F;(i ;[[I"[duration];T0;"@j;#[ ;$I""Suspends the current thread for _duration_ seconds (which may be any number,
including a +Float+ with fractional seconds). Returns the actual number of
seconds slept (rounded), which may be less than that asked for if another
thread calls Thread#run. Called without an argument, sleep()
will sleep forever.
Time.new #=> 2008-03-08 19:56:19 +0900
sleep 1.2 #=> 1
Time.new #=> 2008-03-08 19:56:20 +0900
sleep 1.9 #=> 2
Time.new #=> 2008-03-08 19:56:22 +0900
@overload sleep([duration])
@return [Fixnum];T;%0;"@j;'F;)o;*;+T;,i#;-i1;.@
; I"static VALUE;T;/I"$static VALUE
rb_f_sleep(int argc, VALUE *argv)
{
time_t beg, end;
beg = time(0);
if (argc == 0) {
rb_thread_sleep_forever();
}
else {
rb_check_arity(argc, 0, 1);
rb_thread_wait_for(rb_time_interval(argv[0]));
}
end = time(0) - beg;
return INT2FIX(end);
};T;0To;
; F; ;
;;;I"Kernel#exit;F;[[@0;[[@
i;T;: exit;0;[ ;{ ;IC;"Initiates the termination of the Ruby script by raising the
SystemExit exception. This exception may be caught. The
optional parameter is used to return a status code to the invoking
environment.
+true+ and +FALSE+ of _status_ means success and failure
respectively. The interpretation of other integer values are
system dependent.
begin
exit
puts "never get here"
rescue SystemExit
puts "rescued a SystemExit exception"
end
puts "after begin block"
produces:
rescued a SystemExit exception
after begin block
Just prior to termination, Ruby executes any at_exit functions
(see Kernel::at_exit) and runs any object finalizers (see
ObjectSpace::define_finalizer).
at_exit { puts "at_exit function" }
ObjectSpace.define_finalizer("string", proc { puts "in finalizer" })
exit
produces:
at_exit function
in finalizer
;T;[o;
; I"
overload;F; 0;;; 0; I"exit(status=true);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[[I" status;TI" true;T;"@o;
; I"
overload;F; 0;:Kernel::exit; 0; I" Kernel::exit(status=true);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[[I" status;TI" true;T;"@o;
; I"
overload;F; 0;:Process::exit; 0; I" Process::exit(status=true);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[[I" status;TI" true;T;"@;#[ ;$I"Initiates the termination of the Ruby script by raising the
SystemExit exception. This exception may be caught. The
optional parameter is used to return a status code to the invoking
environment.
+true+ and +FALSE+ of _status_ means success and failure
respectively. The interpretation of other integer values are
system dependent.
begin
exit
puts "never get here"
rescue SystemExit
puts "rescued a SystemExit exception"
end
puts "after begin block"
produces:
rescued a SystemExit exception
after begin block
Just prior to termination, Ruby executes any at_exit functions
(see Kernel::at_exit) and runs any object finalizers (see
ObjectSpace::define_finalizer).
at_exit { puts "at_exit function" }
ObjectSpace.define_finalizer("string", proc { puts "in finalizer" })
exit
produces:
at_exit function
in finalizer
@overload exit(status=true)
@overload Kernel::exit(status=true)
@overload Process::exit(status=true);T;%0;"@;'F;)o;*;+T;,i;-i ;.@
; I"
VALUE;T;/I"VALUE
rb_f_exit(int argc, const VALUE *argv)
{
VALUE status;
int istatus;
if (argc > 0 && rb_scan_args(argc, argv, "01", &status) == 1) {
istatus = exit_status_code(status);
}
else {
istatus = EXIT_SUCCESS;
}
rb_exit(istatus);
UNREACHABLE;
};T;0To;
; F; ;
;;;I"Kernel#abort;F;[[@0;[[@
i!;T;:
abort;0;[ ;{ ;IC;"Terminate execution immediately, effectively by calling
Kernel.exit(false). If _msg_ is given, it is written
to STDERR prior to terminating.
;T;[o;
; I"
overload;F; 0;;; 0; I"
abort;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[ ;"@o;
; I"
overload;F; 0;:Kernel::abort; 0; I"Kernel::abort([msg]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[[I"
[msg];T0;"@o;
; I"
overload;F; 0;:Process::abort; 0; I"Process::abort([msg]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[[I"
[msg];T0;"@;#[ ;$I"Terminate execution immediately, effectively by calling
Kernel.exit(false). If _msg_ is given, it is written
to STDERR prior to terminating.
@overload abort
@overload Kernel::abort([msg])
@overload Process::abort([msg]);T;%0;"@;'F;)o;*;+T;,i;-i ;.@
; I"
VALUE;T;/I"VALUE
rb_f_abort(int argc, const VALUE *argv)
{
rb_check_arity(argc, 0, 1);
if (argc == 0) {
if (!NIL_P(GET_THREAD()->errinfo)) {
ruby_error_print();
}
rb_exit(EXIT_FAILURE);
}
else {
VALUE args[2];
args[1] = args[0] = argv[0];
StringValue(args[0]);
rb_io_puts(1, args, rb_stderr);
args[0] = INT2NUM(EXIT_FAILURE);
rb_exc_raise(rb_class_new_instance(2, args, rb_eSystemExit));
}
UNREACHABLE;
};T;0To;
; F; ;
;;;I"Kernel#test;F;[[@0;[[I" file.c;Tit;T;: test;0;[ ;{ ;IC;" Uses the character +cmd+ to perform various tests on +file1+ (first
table below) or on +file1+ and +file2+ (second table).
File tests on a single file:
Cmd Returns Meaning
"A" | Time | Last access time for file1
"b" | boolean | True if file1 is a block device
"c" | boolean | True if file1 is a character device
"C" | Time | Last change time for file1
"d" | boolean | True if file1 exists and is a directory
"e" | boolean | True if file1 exists
"f" | boolean | True if file1 exists and is a regular file
"g" | boolean | True if file1 has the \CF{setgid} bit
| | set (false under NT)
"G" | boolean | True if file1 exists and has a group
| | ownership equal to the caller's group
"k" | boolean | True if file1 exists and has the sticky bit set
"l" | boolean | True if file1 exists and is a symbolic link
"M" | Time | Last modification time for file1
"o" | boolean | True if file1 exists and is owned by
| | the caller's effective uid
"O" | boolean | True if file1 exists and is owned by
| | the caller's real uid
"p" | boolean | True if file1 exists and is a fifo
"r" | boolean | True if file1 is readable by the effective
| | uid/gid of the caller
"R" | boolean | True if file is readable by the real
| | uid/gid of the caller
"s" | int/nil | If file1 has nonzero size, return the size,
| | otherwise return nil
"S" | boolean | True if file1 exists and is a socket
"u" | boolean | True if file1 has the setuid bit set
"w" | boolean | True if file1 exists and is writable by
| | the effective uid/gid
"W" | boolean | True if file1 exists and is writable by
| | the real uid/gid
"x" | boolean | True if file1 exists and is executable by
| | the effective uid/gid
"X" | boolean | True if file1 exists and is executable by
| | the real uid/gid
"z" | boolean | True if file1 exists and has a zero length
Tests that take two files:
"-" | boolean | True if file1 and file2 are identical
"=" | boolean | True if the modification times of file1
| | and file2 are equal
"<" | boolean | True if the modification time of file1
| | is prior to that of file2
">" | boolean | True if the modification time of file1
| | is after that of file2
;T;[o;
; I"
overload;F; 0;;; 0; I" test(cmd, file1 [, file2] );T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@;#[ ;$I"@return [Object];T;%0;"@;&0;'F;(i ;[[I"cmd;T0[I"file1[, file2];T0;"@;#[ ;$I" Uses the character +cmd+ to perform various tests on +file1+ (first
table below) or on +file1+ and +file2+ (second table).
File tests on a single file:
Cmd Returns Meaning
"A" | Time | Last access time for file1
"b" | boolean | True if file1 is a block device
"c" | boolean | True if file1 is a character device
"C" | Time | Last change time for file1
"d" | boolean | True if file1 exists and is a directory
"e" | boolean | True if file1 exists
"f" | boolean | True if file1 exists and is a regular file
"g" | boolean | True if file1 has the \CF{setgid} bit
| | set (false under NT)
"G" | boolean | True if file1 exists and has a group
| | ownership equal to the caller's group
"k" | boolean | True if file1 exists and has the sticky bit set
"l" | boolean | True if file1 exists and is a symbolic link
"M" | Time | Last modification time for file1
"o" | boolean | True if file1 exists and is owned by
| | the caller's effective uid
"O" | boolean | True if file1 exists and is owned by
| | the caller's real uid
"p" | boolean | True if file1 exists and is a fifo
"r" | boolean | True if file1 is readable by the effective
| | uid/gid of the caller
"R" | boolean | True if file is readable by the real
| | uid/gid of the caller
"s" | int/nil | If file1 has nonzero size, return the size,
| | otherwise return nil
"S" | boolean | True if file1 exists and is a socket
"u" | boolean | True if file1 has the setuid bit set
"w" | boolean | True if file1 exists and is writable by
| | the effective uid/gid
"W" | boolean | True if file1 exists and is writable by
| | the real uid/gid
"x" | boolean | True if file1 exists and is executable by
| | the effective uid/gid
"X" | boolean | True if file1 exists and is executable by
| | the real uid/gid
"z" | boolean | True if file1 exists and has a zero length
Tests that take two files:
"-" | boolean | True if file1 and file2 are identical
"=" | boolean | True if the modification times of file1
| | and file2 are equal
"<" | boolean | True if the modification time of file1
| | is prior to that of file2
">" | boolean | True if the modification time of file1
| | is after that of file2
@overload test(cmd, file1 [, file2] )
@return [Object];T;%0;"@;'F;)o;*;+T;,i:;-iq;.@
; I"static VALUE;T;/I"c static VALUE
rb_f_test(int argc, VALUE *argv)
{
int cmd;
if (argc == 0) rb_check_arity(argc, 2, 3);
cmd = NUM2CHR(argv[0]);
if (cmd == 0) {
unknown:
/* unknown command */
if (ISPRINT(cmd)) {
rb_raise(rb_eArgError, "unknown command '%s%c'", cmd == '\'' || cmd == '\\' ? "\\" : "", cmd);
}
else {
rb_raise(rb_eArgError, "unknown command \"\\x%02X\"", cmd);
}
}
if (strchr("bcdefgGkloOprRsSuwWxXz", cmd)) {
CHECK(1);
switch (cmd) {
case 'b':
return rb_file_blockdev_p(0, argv[1]);
case 'c':
return rb_file_chardev_p(0, argv[1]);
case 'd':
return rb_file_directory_p(0, argv[1]);
case 'e':
return rb_file_exist_p(0, argv[1]);
case 'f':
return rb_file_file_p(0, argv[1]);
case 'g':
return rb_file_sgid_p(0, argv[1]);
case 'G':
return rb_file_grpowned_p(0, argv[1]);
case 'k':
return rb_file_sticky_p(0, argv[1]);
case 'l':
return rb_file_symlink_p(0, argv[1]);
case 'o':
return rb_file_owned_p(0, argv[1]);
case 'O':
return rb_file_rowned_p(0, argv[1]);
case 'p':
return rb_file_pipe_p(0, argv[1]);
case 'r':
return rb_file_readable_p(0, argv[1]);
case 'R':
return rb_file_readable_real_p(0, argv[1]);
case 's':
return rb_file_size_p(0, argv[1]);
case 'S':
return rb_file_socket_p(0, argv[1]);
case 'u':
return rb_file_suid_p(0, argv[1]);
case 'w':
return rb_file_writable_p(0, argv[1]);
case 'W':
return rb_file_writable_real_p(0, argv[1]);
case 'x':
return rb_file_executable_p(0, argv[1]);
case 'X':
return rb_file_executable_real_p(0, argv[1]);
case 'z':
return rb_file_zero_p(0, argv[1]);
}
}
if (strchr("MAC", cmd)) {
struct stat st;
VALUE fname = argv[1];
CHECK(1);
if (rb_stat(fname, &st) == -1) {
int e = errno;
FilePathValue(fname);
rb_syserr_fail_path(e, fname);
}
switch (cmd) {
case 'A':
return stat_atime(&st);
case 'M':
return stat_mtime(&st);
case 'C':
return stat_ctime(&st);
}
}
if (cmd == '-') {
CHECK(2);
return rb_file_identical_p(0, argv[1], argv[2]);
}
if (strchr("=<>", cmd)) {
struct stat st1, st2;
struct timespec t1, t2;
CHECK(2);
if (rb_stat(argv[1], &st1) < 0) return Qfalse;
if (rb_stat(argv[2], &st2) < 0) return Qfalse;
t1 = stat_mtimespec(&st1);
t2 = stat_mtimespec(&st2);
switch (cmd) {
case '=':
if (t1.tv_sec == t2.tv_sec && t1.tv_nsec == t2.tv_nsec) return Qtrue;
return Qfalse;
case '>':
if (t1.tv_sec > t2.tv_sec) return Qtrue;
if (t1.tv_sec == t2.tv_sec && t1.tv_nsec > t2.tv_nsec) return Qtrue;
return Qfalse;
case '<':
if (t1.tv_sec < t2.tv_sec) return Qtrue;
if (t1.tv_sec == t2.tv_sec && t1.tv_nsec < t2.tv_nsec) return Qtrue;
return Qfalse;
}
}
goto unknown;
};T;0To;
; F; ;
;;;I"Kernel#syscall;F;[[@0;[[@i^$;T;: syscall;0;[ ;{ ;IC;"Calls the operating system function identified by _num_ and
returns the result of the function or raises SystemCallError if
it failed.
Arguments for the function can follow _num_. They must be either
+String+ objects or +Integer+ objects. A +String+ object is passed
as a pointer to the byte sequence. An +Integer+ object is passed
as an integer whose bit size is same as a pointer.
Up to nine parameters may be passed (14 on the Atari-ST).
The function identified by _num_ is system
dependent. On some Unix systems, the numbers may be obtained from a
header file called syscall.h.
syscall 4, 1, "hello\n", 6 # '4' is write(2) on our box
produces:
hello
Calling +syscall+ on a platform which does not have any way to
an arbitrary system function just fails with NotImplementedError.
Note::
+syscall+ is essentially unsafe and unportable. Feel free to shoot your foot.
DL (Fiddle) library is preferred for safer and a bit more portable programming.
;T;[o;
; I"
overload;F; 0;;; 0; I" syscall(num [, args...]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@;#[ ;$I"@return [Integer];T;%0;"@;&0;'F;(i ;[[I"num[, args...];T0;"@;#[ ;$I"Calls the operating system function identified by _num_ and
returns the result of the function or raises SystemCallError if
it failed.
Arguments for the function can follow _num_. They must be either
+String+ objects or +Integer+ objects. A +String+ object is passed
as a pointer to the byte sequence. An +Integer+ object is passed
as an integer whose bit size is same as a pointer.
Up to nine parameters may be passed (14 on the Atari-ST).
The function identified by _num_ is system
dependent. On some Unix systems, the numbers may be obtained from a
header file called syscall.h.
syscall 4, 1, "hello\n", 6 # '4' is write(2) on our box
produces:
hello
Calling +syscall+ on a platform which does not have any way to
an arbitrary system function just fails with NotImplementedError.
Note::
+syscall+ is essentially unsafe and unportable. Feel free to shoot your foot.
DL (Fiddle) library is preferred for safer and a bit more portable programming.
@overload syscall(num [, args...])
@return [Integer];T;%0;"@;'F;)o;*;+T;,i=$;-i[$;.@
; I"static VALUE;T;/I" static VALUE
rb_f_syscall(int argc, VALUE *argv)
{
#ifdef atarist
VALUE arg[13]; /* yes, we really need that many ! */
#else
VALUE arg[8];
#endif
#if SIZEOF_VOIDP == 8 && defined(HAVE___SYSCALL) && SIZEOF_INT != 8 /* mainly *BSD */
# define SYSCALL __syscall
# define NUM2SYSCALLID(x) NUM2LONG(x)
# define RETVAL2NUM(x) LONG2NUM(x)
# if SIZEOF_LONG == 8
long num, retval = -1;
# elif SIZEOF_LONG_LONG == 8
long long num, retval = -1;
# else
# error ---->> it is asserted that __syscall takes the first argument and returns retval in 64bit signed integer. <<----
# endif
#elif defined(__linux__)
# define SYSCALL syscall
# define NUM2SYSCALLID(x) NUM2LONG(x)
# define RETVAL2NUM(x) LONG2NUM(x)
/*
* Linux man page says, syscall(2) function prototype is below.
*
* int syscall(int number, ...);
*
* But, it's incorrect. Actual one takes and returned long. (see unistd.h)
*/
long num, retval = -1;
#else
# define SYSCALL syscall
# define NUM2SYSCALLID(x) NUM2INT(x)
# define RETVAL2NUM(x) INT2NUM(x)
int num, retval = -1;
#endif
int i;
if (RTEST(ruby_verbose)) {
rb_warning("We plan to remove a syscall function at future release. DL(Fiddle) provides safer alternative.");
}
if (argc == 0)
rb_raise(rb_eArgError, "too few arguments for syscall");
if (argc > numberof(arg))
rb_raise(rb_eArgError, "too many arguments for syscall");
num = NUM2SYSCALLID(argv[0]); ++argv;
for (i = argc - 1; i--; ) {
VALUE v = rb_check_string_type(argv[i]);
if (!NIL_P(v)) {
SafeStringValue(v);
rb_str_modify(v);
arg[i] = (VALUE)StringValueCStr(v);
}
else {
arg[i] = (VALUE)NUM2LONG(argv[i]);
}
}
switch (argc) {
case 1:
retval = SYSCALL(num);
break;
case 2:
retval = SYSCALL(num, arg[0]);
break;
case 3:
retval = SYSCALL(num, arg[0],arg[1]);
break;
case 4:
retval = SYSCALL(num, arg[0],arg[1],arg[2]);
break;
case 5:
retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3]);
break;
case 6:
retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3],arg[4]);
break;
case 7:
retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3],arg[4],arg[5]);
break;
case 8:
retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3],arg[4],arg[5],arg[6]);
break;
#ifdef atarist
case 9:
retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3],arg[4],arg[5],arg[6],
arg[7]);
break;
case 10:
retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3],arg[4],arg[5],arg[6],
arg[7], arg[8]);
break;
case 11:
retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3],arg[4],arg[5],arg[6],
arg[7], arg[8], arg[9]);
break;
case 12:
retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3],arg[4],arg[5],arg[6],
arg[7], arg[8], arg[9], arg[10]);
break;
case 13:
retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3],arg[4],arg[5],arg[6],
arg[7], arg[8], arg[9], arg[10], arg[11]);
break;
case 14:
retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3],arg[4],arg[5],arg[6],
arg[7], arg[8], arg[9], arg[10], arg[11], arg[12]);
break;
#endif
}
if (retval == -1)
rb_sys_fail(0);
return RETVAL2NUM(retval);
#undef SYSCALL
#undef NUM2SYSCALLID
#undef RETVAL2NUM
};T;0To;
; F; ;
;;;I"Kernel#open;F;[[@0;[[@i;T;: open;0;[ ;{ ;IC;" Creates an IO object connected to the given stream, file, or subprocess.
If +path+ does not start with a pipe character (|), treat it
as the name of a file to open using the specified mode (defaulting to
"r").
The +mode+ is either a string or an integer. If it is an integer, it
must be bitwise-or of open(2) flags, such as File::RDWR or File::EXCL. If
it is a string, it is either "fmode", "fmode:ext_enc", or
"fmode:ext_enc:int_enc".
See the documentation of IO.new for full documentation of the +mode+ string
directives.
If a file is being created, its initial permissions may be set using the
+perm+ parameter. See File.new and the open(2) and chmod(2) man pages for
a description of permissions.
If a block is specified, it will be invoked with the IO object as a
parameter, and the IO will be automatically closed when the block
terminates. The call returns the value of the block.
If +path+ starts with a pipe character ("|"), a subprocess is
created, connected to the caller by a pair of pipes. The returned IO
object may be used to write to the standard input and read from the
standard output of this subprocess.
If the command following the pipe is a single minus sign
("|-"), Ruby forks, and this subprocess is connected to the
parent. If the command is not "-", the subprocess runs the
command.
When the subprocess is ruby (opened via "|-"), the +open+
call returns +nil+. If a block is associated with the open call, that
block will run twice --- once in the parent and once in the child.
The block parameter will be an IO object in the parent and +nil+ in the
child. The parent's +IO+ object will be connected to the child's $stdin
and $stdout. The subprocess will be terminated at the end of the block.
=== Examples
Reading from "testfile":
open("testfile") do |f|
print f.gets
end
Produces:
This is line one
Open a subprocess and read its output:
cmd = open("|date")
print cmd.gets
cmd.close
Produces:
Wed Apr 9 08:56:31 CDT 2003
Open a subprocess running the same Ruby program:
f = open("|-", "w+")
if f == nil
puts "in Child"
exit
else
puts "Got: #{f.gets}"
end
Produces:
Got: in Child
Open a subprocess using a block to receive the IO object:
open "|-" do |f|
if f then
# parent process
puts "Got: #{f.gets}"
else
# child process
puts "in Child"
end
end
Produces:
Got: in Child
;T;[o;
; I"
overload;F; 0;;; 0; I")open(path [, mode [, perm]] [, opt]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"IO;TI"nil;T;"@";#[ ;$I"@return [IO, nil];T;%0;"@";&0;'F;(i ;[[I"!path[, mode [, perm]][, opt];T0;"@"o;
; I"
overload;F; 0;;; 0; I")open(path [, mode [, perm]] [, opt]);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"io;T;"@"o;!
; I" return;F; I" ;T;0; [I" Object;T;"@";#[ ;$I"!@yield [io]
@return [Object];T;%0;"@";&0;'F;(i ;[[I"!path[, mode [, perm]][, opt];T0;"@";#[ ;$I"^
Creates an IO object connected to the given stream, file, or subprocess.
If +path+ does not start with a pipe character (|), treat it
as the name of a file to open using the specified mode (defaulting to
"r").
The +mode+ is either a string or an integer. If it is an integer, it
must be bitwise-or of open(2) flags, such as File::RDWR or File::EXCL. If
it is a string, it is either "fmode", "fmode:ext_enc", or
"fmode:ext_enc:int_enc".
See the documentation of IO.new for full documentation of the +mode+ string
directives.
If a file is being created, its initial permissions may be set using the
+perm+ parameter. See File.new and the open(2) and chmod(2) man pages for
a description of permissions.
If a block is specified, it will be invoked with the IO object as a
parameter, and the IO will be automatically closed when the block
terminates. The call returns the value of the block.
If +path+ starts with a pipe character ("|"), a subprocess is
created, connected to the caller by a pair of pipes. The returned IO
object may be used to write to the standard input and read from the
standard output of this subprocess.
If the command following the pipe is a single minus sign
("|-"), Ruby forks, and this subprocess is connected to the
parent. If the command is not "-", the subprocess runs the
command.
When the subprocess is ruby (opened via "|-"), the +open+
call returns +nil+. If a block is associated with the open call, that
block will run twice --- once in the parent and once in the child.
The block parameter will be an IO object in the parent and +nil+ in the
child. The parent's +IO+ object will be connected to the child's $stdin
and $stdout. The subprocess will be terminated at the end of the block.
=== Examples
Reading from "testfile":
open("testfile") do |f|
print f.gets
end
Produces:
This is line one
Open a subprocess and read its output:
cmd = open("|date")
print cmd.gets
cmd.close
Produces:
Wed Apr 9 08:56:31 CDT 2003
Open a subprocess running the same Ruby program:
f = open("|-", "w+")
if f == nil
puts "in Child"
exit
else
puts "Got: #{f.gets}"
end
Produces:
Got: in Child
Open a subprocess using a block to receive the IO object:
open "|-" do |f|
if f then
# parent process
puts "Got: #{f.gets}"
else
# child process
puts "in Child"
end
end
Produces:
Got: in Child
@overload open(path [, mode [, perm]] [, opt])
@return [IO, nil]
@overload open(path [, mode [, perm]] [, opt])
@yield [io]
@return [Object];T;%0;"@";'F;)o;*;+T;,i2;-i;.@
; I"static VALUE;T;/I"static VALUE
rb_f_open(int argc, VALUE *argv)
{
ID to_open = 0;
int redirect = FALSE;
if (argc >= 1) {
CONST_ID(to_open, "to_open");
if (rb_respond_to(argv[0], to_open)) {
redirect = TRUE;
}
else {
VALUE tmp = argv[0];
FilePathValue(tmp);
if (NIL_P(tmp)) {
redirect = TRUE;
}
else {
VALUE cmd = check_pipe_command(tmp);
if (!NIL_P(cmd)) {
argv[0] = cmd;
return rb_io_s_popen(argc, argv, rb_cIO);
}
}
}
}
if (redirect) {
VALUE io = rb_funcall2(argv[0], to_open, argc-1, argv+1);
if (rb_block_given_p()) {
return rb_ensure(rb_yield, io, io_close, io);
}
return io;
}
return rb_io_s_open(argc, argv, rb_cFile);
};T;0To;
; F; ;
;;;I"Kernel#printf;F;[[@0;[[@i;T;: printf;0;[ ;{ ;IC;"iEquivalent to:
io.write(sprintf(string, obj, ...))
or
$stdout.write(sprintf(string, obj, ...))
;T;[o;
; I"
overload;F; 0;;; 0; I"$printf(io, string [, obj ... ]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@U;#[ ;$I"@return [nil];T;%0;"@U;&0;'F;(i ;[[I"io;T0[I"string[, obj ... ];T0;"@Uo;
; I"
overload;F; 0;;; 0; I" printf(string [, obj ... ]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@U;#[ ;$I"@return [nil];T;%0;"@U;&0;'F;(i ;[[I"string[, obj ... ];T0;"@U;#[ ;$I"Equivalent to:
io.write(sprintf(string, obj, ...))
or
$stdout.write(sprintf(string, obj, ...))
@overload printf(io, string [, obj ... ])
@return [nil]
@overload printf(string [, obj ... ])
@return [nil];T;%0;"@U;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"static VALUE
rb_f_printf(int argc, VALUE *argv)
{
VALUE out;
if (argc == 0) return Qnil;
if (RB_TYPE_P(argv[0], T_STRING)) {
out = rb_stdout;
}
else {
out = argv[0];
argv++;
argc--;
}
rb_io_write(out, rb_f_sprintf(argc, argv));
return Qnil;
};T;0To;
; F; ;
;;;I"Kernel#print;F;[[@0;[[@iF;T;:
print;0;[ ;{ ;IC;"Prints each object in turn to $stdout. If the output
field separator ($,) is not +nil+, its
contents will appear between each field. If the output record
separator ($\\) is not +nil+, it will be
appended to the output. If no arguments are given, prints
$_. Objects that aren't strings will be converted by
calling their to_s method.
print "cat", [1,2,3], 99, "\n"
$, = ", "
$\ = "\n"
print "cat", [1,2,3], 99
produces:
cat12399
cat, 1, 2, 3, 99
;T;[o;
; I"
overload;F; 0;;; 0; I"print(obj, ...);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@;#[ ;$I"@return [nil];T;%0;"@;&0;'F;(i ;[[I"obj;T0[I"...;T0;"@;#[ ;$I"GPrints each object in turn to $stdout. If the output
field separator ($,) is not +nil+, its
contents will appear between each field. If the output record
separator ($\\) is not +nil+, it will be
appended to the output. If no arguments are given, prints
$_. Objects that aren't strings will be converted by
calling their to_s method.
print "cat", [1,2,3], 99, "\n"
$, = ", "
$\ = "\n"
print "cat", [1,2,3], 99
produces:
cat12399
cat, 1, 2, 3, 99
@overload print(obj, ...)
@return [nil];T;%0;"@;'F;)o;*;+T;,i/;-iC;.@
; I"static VALUE;T;/I"vstatic VALUE
rb_f_print(int argc, const VALUE *argv)
{
rb_io_print(argc, argv, rb_stdout);
return Qnil;
};T;0To;
; F; ;
;;;I"Kernel#putc;F;[[I"ch;T0;[[@iz;T;: putc;0;[ ;{ ;IC;"Equivalent to:
$stdout.putc(int)
Refer to the documentation for IO#putc for important information regarding
multi-byte characters.
;T;[o;
; I"
overload;F; 0;;; 0; I"putc(int);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@;#[ ;$I"@return [Integer];T;%0;"@;&0;'F;(i ;[[I"int;T0;"@;#[ ;$I"Equivalent to:
$stdout.putc(int)
Refer to the documentation for IO#putc for important information regarding
multi-byte characters.
@overload putc(int)
@return [Integer];T;%0;"@;'F;)o;*;+T;,in;-iw;.@
; I"static VALUE;T;/I"static VALUE
rb_f_putc(VALUE recv, VALUE ch)
{
if (recv == rb_stdout) {
return rb_io_putc(recv, ch);
}
return rb_funcall2(rb_stdout, rb_intern("putc"), 1, &ch);
};T;0To;
; F; ;
;;;I"Kernel#puts;F;[[@0;[[@i;T;: puts;0;[ ;{ ;IC;".Equivalent to
$stdout.puts(obj, ...)
;T;[o;
; I"
overload;F; 0;;; 0; I"puts(obj, ...);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@;#[ ;$I"@return [nil];T;%0;"@;&0;'F;(i ;[[I"obj;T0[I"...;T0;"@;#[ ;$I"YEquivalent to
$stdout.puts(obj, ...)
@overload puts(obj, ...)
@return [nil];T;%0;"@;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"static VALUE
rb_f_puts(int argc, VALUE *argv, VALUE recv)
{
if (recv == rb_stdout) {
return rb_io_puts(argc, argv, recv);
}
return rb_funcall2(rb_stdout, rb_intern("puts"), argc, argv);
};T;0To;
; F; ;
;;;I"Kernel#gets;F;[[@0;[[@i ;T;: gets;0;[ ;{ ;IC;"Returns (and assigns to $_) the next line from the list
of files in +ARGV+ (or $*), or from standard input if
no files are present on the command line. Returns +nil+ at end of
file. The optional argument specifies the record separator. The
separator is included with the contents of each record. A separator
of +nil+ reads the entire contents, and a zero-length separator
reads the input one paragraph at a time, where paragraphs are
divided by two consecutive newlines. If the first argument is an
integer, or optional second argument is given, the returning string
would not be longer than the given value in bytes. If multiple
filenames are present in +ARGV+, +gets(nil)+ will read the contents
one file at a time.
ARGV << "testfile"
print while gets
produces:
This is line one
This is line two
This is line three
And so on...
The style of programming using $_ as an implicit
parameter is gradually losing favor in the Ruby community.
;T;[o;
; I"
overload;F; 0;;; 0; I"gets(sep=$/);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@;#[ ;$I"@return [String, nil];T;%0;"@;&0;'F;(i ;[[I"sep;TI"$/;T;"@o;
; I"
overload;F; 0;;; 0; I"gets(limit);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@;#[ ;$I"@return [String, nil];T;%0;"@;&0;'F;(i ;[[I"
limit;T0;"@o;
; I"
overload;F; 0;;; 0; I"gets(sep,limit);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@;#[ ;$I"@return [String, nil];T;%0;"@;&0;'F;(i ;[[I"sep;T0[I"
limit;T0;"@;#[ ;$I"Returns (and assigns to $_) the next line from the list
of files in +ARGV+ (or $*), or from standard input if
no files are present on the command line. Returns +nil+ at end of
file. The optional argument specifies the record separator. The
separator is included with the contents of each record. A separator
of +nil+ reads the entire contents, and a zero-length separator
reads the input one paragraph at a time, where paragraphs are
divided by two consecutive newlines. If the first argument is an
integer, or optional second argument is given, the returning string
would not be longer than the given value in bytes. If multiple
filenames are present in +ARGV+, +gets(nil)+ will read the contents
one file at a time.
ARGV << "testfile"
print while gets
produces:
This is line one
This is line two
This is line three
And so on...
The style of programming using $_ as an implicit
parameter is gradually losing favor in the Ruby community.
@overload gets(sep=$/)
@return [String, nil]
@overload gets(limit)
@return [String, nil]
@overload gets(sep,limit)
@return [String, nil];T;%0;"@;'F;)o;*;+T;,i ;-i ;.@
; I"static VALUE;T;/I"static VALUE
rb_f_gets(int argc, VALUE *argv, VALUE recv)
{
if (recv == argf) {
return argf_gets(argc, argv, argf);
}
return rb_funcall2(argf, idGets, argc, argv);
};T;0To;
; F; ;
;;;I"Kernel#readline;F;[[@0;[[@i* ;T;:
readline;0;[ ;{ ;IC;"aEquivalent to Kernel::gets, except
+readline+ raises +EOFError+ at end of file.
;T;[o;
; I"
overload;F; 0;;; 0; I"readline(sep=$/);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@%;#[ ;$I"@return [String];T;%0;"@%;&0;'F;(i ;[[I"sep;TI"$/;T;"@%o;
; I"
overload;F; 0;;; 0; I"readline(limit);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@%;#[ ;$I"@return [String];T;%0;"@%;&0;'F;(i ;[[I"
limit;T0;"@%o;
; I"
overload;F; 0;;; 0; I"readline(sep, limit);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@%;#[ ;$I"@return [String];T;%0;"@%;&0;'F;(i ;[[I"sep;T0[I"
limit;T0;"@%;#[ ;$I"Equivalent to Kernel::gets, except
+readline+ raises +EOFError+ at end of file.
@overload readline(sep=$/)
@return [String]
@overload readline(limit)
@return [String]
@overload readline(sep, limit)
@return [String];T;%0;"@%;'F;)o;*;+T;,i ;-i) ;.@
; I"static VALUE;T;/I"static VALUE
rb_f_readline(int argc, VALUE *argv, VALUE recv)
{
if (recv == argf) {
return argf_readline(argc, argv, argf);
}
return rb_funcall2(argf, rb_intern("readline"), argc, argv);
};T;0To;
; F; ;
;;;I"Kernel#select;F;[[@0;[[@i";T;: select;0;[ ;{ ;IC;"aCalls select(2) system call.
It monitors given arrays of IO objects, waits until one or more
of IO objects are ready for reading, are ready for writing,
and have pending exceptions respectively, and returns an array that
contains arrays of those IO objects. It will return nil
if optional timeout value is given and no IO object
is ready in timeout seconds.
IO.select peeks the buffer of IO objects for testing readability.
If the IO buffer is not empty,
IO.select immediately notifies readability.
This "peek" only happens for IO objects.
It does not happen for IO-like objects such as OpenSSL::SSL::SSLSocket.
The best way to use IO.select is invoking it
after nonblocking methods such as read_nonblock, write_nonblock, etc.
The methods raise an exception which is extended by
IO::WaitReadable or IO::WaitWritable.
The modules notify how the caller should wait with IO.select.
If IO::WaitReadable is raised, the caller should wait for reading.
If IO::WaitWritable is raised, the caller should wait for writing.
So, blocking read (readpartial) can be emulated using
read_nonblock and IO.select as follows:
begin
result = io_like.read_nonblock(maxlen)
rescue IO::WaitReadable
IO.select([io_like])
retry
rescue IO::WaitWritable
IO.select(nil, [io_like])
retry
end
Especially, the combination of nonblocking methods and
IO.select is preferred for IO like
objects such as OpenSSL::SSL::SSLSocket.
It has to_io method to return underlying IO object.
IO.select calls to_io to obtain the file descriptor to wait.
This means that readability notified by IO.select doesn't mean
readability from OpenSSL::SSL::SSLSocket object.
The most likely situation is that OpenSSL::SSL::SSLSocket buffers some data.
IO.select doesn't see the buffer.
So IO.select can block when OpenSSL::SSL::SSLSocket#readpartial doesn't block.
However, several more complicated situations exist.
SSL is a protocol which is sequence of records.
The record consists of multiple bytes.
So, the remote side of SSL sends a partial record,
IO.select notifies readability but
OpenSSL::SSL::SSLSocket cannot decrypt a byte and
OpenSSL::SSL::SSLSocket#readpartial will blocks.
Also, the remote side can request SSL renegotiation which forces
the local SSL engine to write some data.
This means OpenSSL::SSL::SSLSocket#readpartial may
invoke write system call and it can block.
In such a situation, OpenSSL::SSL::SSLSocket#read_nonblock
raises IO::WaitWritable instead of blocking.
So, the caller should wait for ready for writability as above example.
The combination of nonblocking methods and IO.select is
also useful for streams such as tty, pipe socket socket when
multiple processes read from a stream.
Finally, Linux kernel developers don't guarantee that
readability of select(2) means readability of following read(2) even
for a single process.
See select(2) manual on GNU/Linux system.
Invoking IO.select before IO#readpartial works well as usual.
However it is not the best way to use IO.select.
The writability notified by select(2) doesn't show
how many bytes writable.
IO#write method blocks until given whole string is written.
So, IO#write(two or more bytes) can block after writability is notified by IO.select.
IO#write_nonblock is required to avoid the blocking.
Blocking write (write) can be emulated using
write_nonblock and IO.select as follows:
IO::WaitReadable should also be rescued for SSL renegotiation in OpenSSL::SSL::SSLSocket.
while 0 < string.bytesize
begin
written = io_like.write_nonblock(string)
rescue IO::WaitReadable
IO.select([io_like])
retry
rescue IO::WaitWritable
IO.select(nil, [io_like])
retry
end
string = string.byteslice(written..-1)
end
=== Parameters
read_array:: an array of IO objects that wait until ready for read
write_array:: an array of IO objects that wait until ready for write
error_array:: an array of IO objects that wait for exceptions
timeout:: a numeric value in second
=== Example
rp, wp = IO.pipe
mesg = "ping "
100.times {
# IO.select follows IO#read. Not the best way to use IO.select.
rs, ws, = IO.select([rp], [wp])
if r = rs[0]
ret = r.read(5)
print ret
case ret
when /ping/
mesg = "pong\n"
when /pong/
mesg = "ping "
end
end
if w = ws[0]
w.write(mesg)
end
}
produces:
ping pong
ping pong
ping pong
(snipped)
ping
;T;[o;
; I"
overload;F; 0;;; 0; I"Cselect(read_array [, write_array [, error_array [, timeout]]]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;TI"nil;T;"@d;#[ ;$I"@return [Array, nil];T;%0;"@d;&0;'F;(i ;[[I":read_array[, write_array [, error_array [, timeout]]];T0;"@d;#[ ;$I"Calls select(2) system call.
It monitors given arrays of IO objects, waits until one or more
of IO objects are ready for reading, are ready for writing,
and have pending exceptions respectively, and returns an array that
contains arrays of those IO objects. It will return nil
if optional timeout value is given and no IO object
is ready in timeout seconds.
IO.select peeks the buffer of IO objects for testing readability.
If the IO buffer is not empty,
IO.select immediately notifies readability.
This "peek" only happens for IO objects.
It does not happen for IO-like objects such as OpenSSL::SSL::SSLSocket.
The best way to use IO.select is invoking it
after nonblocking methods such as read_nonblock, write_nonblock, etc.
The methods raise an exception which is extended by
IO::WaitReadable or IO::WaitWritable.
The modules notify how the caller should wait with IO.select.
If IO::WaitReadable is raised, the caller should wait for reading.
If IO::WaitWritable is raised, the caller should wait for writing.
So, blocking read (readpartial) can be emulated using
read_nonblock and IO.select as follows:
begin
result = io_like.read_nonblock(maxlen)
rescue IO::WaitReadable
IO.select([io_like])
retry
rescue IO::WaitWritable
IO.select(nil, [io_like])
retry
end
Especially, the combination of nonblocking methods and
IO.select is preferred for IO like
objects such as OpenSSL::SSL::SSLSocket.
It has to_io method to return underlying IO object.
IO.select calls to_io to obtain the file descriptor to wait.
This means that readability notified by IO.select doesn't mean
readability from OpenSSL::SSL::SSLSocket object.
The most likely situation is that OpenSSL::SSL::SSLSocket buffers some data.
IO.select doesn't see the buffer.
So IO.select can block when OpenSSL::SSL::SSLSocket#readpartial doesn't block.
However, several more complicated situations exist.
SSL is a protocol which is sequence of records.
The record consists of multiple bytes.
So, the remote side of SSL sends a partial record,
IO.select notifies readability but
OpenSSL::SSL::SSLSocket cannot decrypt a byte and
OpenSSL::SSL::SSLSocket#readpartial will blocks.
Also, the remote side can request SSL renegotiation which forces
the local SSL engine to write some data.
This means OpenSSL::SSL::SSLSocket#readpartial may
invoke write system call and it can block.
In such a situation, OpenSSL::SSL::SSLSocket#read_nonblock
raises IO::WaitWritable instead of blocking.
So, the caller should wait for ready for writability as above example.
The combination of nonblocking methods and IO.select is
also useful for streams such as tty, pipe socket socket when
multiple processes read from a stream.
Finally, Linux kernel developers don't guarantee that
readability of select(2) means readability of following read(2) even
for a single process.
See select(2) manual on GNU/Linux system.
Invoking IO.select before IO#readpartial works well as usual.
However it is not the best way to use IO.select.
The writability notified by select(2) doesn't show
how many bytes writable.
IO#write method blocks until given whole string is written.
So, IO#write(two or more bytes) can block after writability is notified by IO.select.
IO#write_nonblock is required to avoid the blocking.
Blocking write (write) can be emulated using
write_nonblock and IO.select as follows:
IO::WaitReadable should also be rescued for SSL renegotiation in OpenSSL::SSL::SSLSocket.
while 0 < string.bytesize
begin
written = io_like.write_nonblock(string)
rescue IO::WaitReadable
IO.select([io_like])
retry
rescue IO::WaitWritable
IO.select(nil, [io_like])
retry
end
string = string.byteslice(written..-1)
end
=== Parameters
read_array:: an array of IO objects that wait until ready for read
write_array:: an array of IO objects that wait until ready for write
error_array:: an array of IO objects that wait for exceptions
timeout:: a numeric value in second
=== Example
rp, wp = IO.pipe
mesg = "ping "
100.times {
# IO.select follows IO#read. Not the best way to use IO.select.
rs, ws, = IO.select([rp], [wp])
if r = rs[0]
ret = r.read(5)
print ret
case ret
when /ping/
mesg = "pong\n"
when /pong/
mesg = "ping "
end
end
if w = ws[0]
w.write(mesg)
end
}
produces:
ping pong
ping pong
ping pong
(snipped)
ping
@overload select(read_array [, write_array [, error_array [, timeout]]])
@return [Array, nil];T;%0;"@d;'F;)o;*;+T;,i!;-i";.@
; I"static VALUE;T;/I"
static VALUE
rb_f_select(int argc, VALUE *argv, VALUE obj)
{
VALUE timeout;
struct select_args args;
struct timeval timerec;
int i;
rb_scan_args(argc, argv, "13", &args.read, &args.write, &args.except, &timeout);
if (NIL_P(timeout)) {
args.timeout = 0;
}
else {
timerec = rb_time_interval(timeout);
args.timeout = &timerec;
}
for (i = 0; i < numberof(args.fdsets); ++i)
rb_fd_init(&args.fdsets[i]);
return rb_ensure(select_call, (VALUE)&args, select_end, (VALUE)&args);
};T;0To;
; F; ;
;;;I"Kernel#readlines;F;[[@0;[[@i_ ;T;:readlines;0;[ ;{ ;IC;"zReturns an array containing the lines returned by calling
Kernel.gets(sep) until the end of file.
;T;[o;
; I"
overload;F; 0;;; 0; I"readlines(sep=$/);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@;#[ ;$I"@return [Array];T;%0;"@;&0;'F;(i ;[[I"sep;TI"$/;T;"@o;
; I"
overload;F; 0;;; 0; I"readlines(limit);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@;#[ ;$I"@return [Array];T;%0;"@;&0;'F;(i ;[[I"
limit;T0;"@o;
; I"
overload;F; 0;;; 0; I"readlines(sep,limit);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@;#[ ;$I"@return [Array];T;%0;"@;&0;'F;(i ;[[I"sep;T0[I"
limit;T0;"@;#[ ;$I"Returns an array containing the lines returned by calling
Kernel.gets(sep) until the end of file.
@overload readlines(sep=$/)
@return [Array]
@overload readlines(limit)
@return [Array]
@overload readlines(sep,limit)
@return [Array];T;%0;"@;'F;)o;*;+T;,iU ;-i^ ;.@
; I"static VALUE;T;/I"static VALUE
rb_f_readlines(int argc, VALUE *argv, VALUE recv)
{
if (recv == argf) {
return argf_readlines(argc, argv, argf);
}
return rb_funcall2(argf, rb_intern("readlines"), argc, argv);
};T;0To;
; F; ;
;;;I"
Kernel#`;F;[[I"str;T0;[[@i ;T;:`;0;[ ;{ ;IC;"ZReturns the standard output of running _cmd_ in a subshell.
The built-in syntax %x{...} uses
this method. Sets $? to the process status.
`date` #=> "Wed Apr 9 08:56:30 CDT 2003\n"
`ls testdir`.split[1] #=> "main.rb"
`echo oops && exit 99` #=> "oops\n"
$?.exitstatus #=> 99
;T;[o;
; I"
overload;F; 0;;; 0; I"
`cmd`;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@;#[ ;$I"@return [String];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"Returns the standard output of running _cmd_ in a subshell.
The built-in syntax %x{...} uses
this method. Sets $? to the process status.
`date` #=> "Wed Apr 9 08:56:30 CDT 2003\n"
`ls testdir`.split[1] #=> "main.rb"
`echo oops && exit 99` #=> "oops\n"
$?.exitstatus #=> 99
@overload `cmd`
@return [String];T;%0;"@;'F;)o;*;+T;,i ;-i ;.@
; I"static VALUE;T;/I"static VALUE
rb_f_backquote(VALUE obj, VALUE str)
{
VALUE port;
VALUE result;
rb_io_t *fptr;
SafeStringValue(str);
rb_last_status_clear();
port = pipe_open_s(str, "r", FMODE_READABLE|DEFAULT_TEXTMODE, NULL);
if (NIL_P(port)) return rb_str_new(0,0);
GetOpenFile(port, fptr);
result = read_all(fptr, remain_size(fptr), Qnil);
rb_io_close(port);
rb_io_fptr_finalize(fptr);
rb_gc_force_recycle(port); /* also guards from premature GC */
return result;
};T;0To;
; F; ;
;;;I"
Kernel#p;F;[[@0;[[@i* ;T;:p;0;[ ;{ ;IC;"For each object, directly writes _obj_.+inspect+ followed by a
newline to the program's standard output.
S = Struct.new(:name, :state)
s = S['dave', 'TX']
p s
produces:
#
;T;[o;
; I"
overload;F; 0;;; 0; I" p(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@;#[ ;$I"@return [Object];T;%0;"@;&0;'F;(i ;[[I"obj;T0;"@o;
; I"
overload;F; 0;;; 0; I"p(obj1, obj2, ...);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@;#[ ;$I"@return [Array];T;%0;"@;&0;'F;(i ;[[I" obj1;T0[I" obj2;T0[I"...;T0;"@o;
; I"
overload;F; 0;;; 0; I"p();T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@;#[ ;$I"@return [nil];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"PFor each object, directly writes _obj_.+inspect+ followed by a
newline to the program's standard output.
S = Struct.new(:name, :state)
s = S['dave', 'TX']
p s
produces:
#
@overload p(obj)
@return [Object]
@overload p(obj1, obj2, ...)
@return [Array]
@overload p()
@return [nil];T;%0;"@;'F;)o;*;+T;,i ;-i) ;.@
; I"static VALUE;T;/I"static VALUE
rb_f_p(int argc, VALUE *argv, VALUE self)
{
struct rb_f_p_arg arg;
arg.argc = argc;
arg.argv = argv;
return rb_uninterruptible(rb_f_p_internal, (VALUE)&arg);
};T;0To;
; F; ;
;;;I"Kernel#raise;F;[[@0;[[@i;T;:
raise;0;[ ;{ ;IC;"With no arguments, raises the exception in $! or raises
a RuntimeError if $! is +nil+.
With a single +String+ argument, raises a
+RuntimeError+ with the string as a message. Otherwise,
the first parameter should be the name of an +Exception+
class (or an object that returns an +Exception+ object when sent
an +exception+ message). The optional second parameter sets the
message associated with the exception, and the third parameter is an
array of callback information. Exceptions are caught by the
+rescue+ clause of begin...end blocks.
raise "Failed to create socket"
raise ArgumentError, "No parameters", caller
;T;[ o;
; I"
overload;F; 0;;; 0; I"
raise;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ ;&0;'F;(i ;[ ;"@ o;
; I"
overload;F; 0;;; 0; I"raise(string);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ ;&0;'F;(i ;[[I" string;T0;"@ o;
; I"
overload;F; 0;;; 0; I"*raise(exception [, string [, array]]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ ;&0;'F;(i ;[[I""exception[, string [, array]];T0;"@ o;
; I"
overload;F; 0;: fail; 0; I" fail;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ ;&0;'F;(i ;[ ;"@ o;
; I"
overload;F; 0;;; 0; I"fail(string);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ ;&0;'F;(i ;[[I" string;T0;"@ o;
; I"
overload;F; 0;;; 0; I")fail(exception [, string [, array]]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ ;&0;'F;(i ;[[I""exception[, string [, array]];T0;"@ ;#[ ;$I"QWith no arguments, raises the exception in $! or raises
a RuntimeError if $! is +nil+.
With a single +String+ argument, raises a
+RuntimeError+ with the string as a message. Otherwise,
the first parameter should be the name of an +Exception+
class (or an object that returns an +Exception+ object when sent
an +exception+ message). The optional second parameter sets the
message associated with the exception, and the third parameter is an
array of callback information. Exceptions are caught by the
+rescue+ clause of begin...end blocks.
raise "Failed to create socket"
raise ArgumentError, "No parameters", caller
@overload raise
@overload raise(string)
@overload raise(exception [, string [, array]])
@overload fail
@overload fail(string)
@overload fail(exception [, string [, array]]);T;%0;"@ ;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"static VALUE
rb_f_raise(int argc, VALUE *argv)
{
VALUE err;
VALUE opts[raise_max_opt], *const cause = &opts[raise_opt_cause];
argc = extract_raise_opts(argc, argv, opts);
if (argc == 0) {
if (*cause != Qundef) {
rb_raise(rb_eArgError, "only cause is given with no arguments");
}
err = get_errinfo();
if (!NIL_P(err)) {
argc = 1;
argv = &err;
}
}
rb_raise_jump(rb_make_exception(argc, argv), *cause);
UNREACHABLE;
};T;0To;
; F; ;
;;;I"Kernel#fail;F;[[@0;[[@i;T;;;0;[ ;{ ;IC;"With no arguments, raises the exception in $! or raises
a RuntimeError if $! is +nil+.
With a single +String+ argument, raises a
+RuntimeError+ with the string as a message. Otherwise,
the first parameter should be the name of an +Exception+
class (or an object that returns an +Exception+ object when sent
an +exception+ message). The optional second parameter sets the
message associated with the exception, and the third parameter is an
array of callback information. Exceptions are caught by the
+rescue+ clause of begin...end blocks.
raise "Failed to create socket"
raise ArgumentError, "No parameters", caller
;T;[ o;
; I"
overload;F; 0;;; 0; I"
raise;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@d;&0;'F;(i ;[ ;"@do;
; I"
overload;F; 0;;; 0; I"raise(string);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@d;&0;'F;(i ;[[I" string;T0;"@do;
; I"
overload;F; 0;;; 0; I"*raise(exception [, string [, array]]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@d;&0;'F;(i ;[[I""exception[, string [, array]];T0;"@do;
; I"
overload;F; 0;;; 0; I" fail;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@d;&0;'F;(i ;[ ;"@do;
; I"
overload;F; 0;;; 0; I"fail(string);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@d;&0;'F;(i ;[[I" string;T0;"@do;
; I"
overload;F; 0;;; 0; I")fail(exception [, string [, array]]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@d;&0;'F;(i ;[[I""exception[, string [, array]];T0;"@d;#[ ;$@`;%0;"@d;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"static VALUE
rb_f_raise(int argc, VALUE *argv)
{
VALUE err;
VALUE opts[raise_max_opt], *const cause = &opts[raise_opt_cause];
argc = extract_raise_opts(argc, argv, opts);
if (argc == 0) {
if (*cause != Qundef) {
rb_raise(rb_eArgError, "only cause is given with no arguments");
}
err = get_errinfo();
if (!NIL_P(err)) {
argc = 1;
argv = &err;
}
}
rb_raise_jump(rb_make_exception(argc, argv), *cause);
UNREACHABLE;
};T;0To;
; F; ;
;;;I" Kernel#global_variables;F;[ ;[[@ip;T;:global_variables;0;[ ;{ ;IC;"{Returns an array of the names of global variables.
global_variables.grep /std/ #=> [:$stdin, :$stdout, :$stderr]
;T;[o;
; I"
overload;F; 0;;; 0; I"global_variables;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@;#[ ;$I"@return [Array];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"Returns an array of the names of global variables.
global_variables.grep /std/ #=> [:$stdin, :$stdout, :$stderr]
@overload global_variables
@return [Array];T;%0;"@;'F;)o;*;+T;,ig;-im;.@
; I"
VALUE;T;/I".VALUE
rb_f_global_variables(void)
{
VALUE ary = rb_ary_new();
char buf[2];
int i;
rb_id_table_foreach(rb_global_tbl, gvar_i, (void *)ary);
buf[0] = '$';
for (i = 1; i <= 9; ++i) {
buf[1] = (char)(i + '0');
rb_ary_push(ary, ID2SYM(rb_intern2(buf, 2)));
}
return ary;
};T;0To;
; F; ;
;;;I"Kernel#__method__;F;[ ;[[@i ;T;:__method__;0;[ ;{ ;IC;"Returns the name at the definition of the current method as a
Symbol.
If called outside of a method, it returns nil.
;T;[o;
; I"
overload;F; 0;;; 0; I"__method__;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"Returns the name at the definition of the current method as a
Symbol.
If called outside of a method, it returns nil.
@overload __method__;T;%0;"@;'F;)o;*;+T;,i;-i ;.@
; I"static VALUE;T;/I"static VALUE
rb_f_method_name(void)
{
ID fname = prev_frame_func(); /* need *method* ID */
if (fname) {
return ID2SYM(fname);
}
else {
return Qnil;
}
};T;0To;
; F; ;
;;;I"Kernel#__callee__;F;[ ;[[@i6;T;:__callee__;0;[ ;{ ;IC;"{Returns the called name of the current method as a Symbol.
If called outside of a method, it returns nil.
;T;[o;
; I"
overload;F; 0;;; 0; I"__callee__;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"Returns the called name of the current method as a Symbol.
If called outside of a method, it returns nil.
@overload __callee__;T;%0;"@;'F;)o;*;+T;,i-;-i2;.@
; I"static VALUE;T;/I"static VALUE
rb_f_callee_name(void)
{
ID fname = prev_frame_callee(); /* need *callee* ID */
if (fname) {
return ID2SYM(fname);
}
else {
return Qnil;
}
};T;0To;
; F; ;
;;;I"Kernel#__dir__;F;[ ;[[@iM;T;: __dir__;0;[ ;{ ;IC;"+Returns the canonicalized absolute path of the directory of the file from
which this method is called. It means symlinks in the path is resolved.
If __FILE__ is nil, it returns nil.
The return value equals to File.dirname(File.realpath(__FILE__)).
;T;[o;
; I"
overload;F; 0;;; 0; I" __dir__;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@;#[ ;$I"@return [String];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"SReturns the canonicalized absolute path of the directory of the file from
which this method is called. It means symlinks in the path is resolved.
If __FILE__ is nil, it returns nil.
The return value equals to File.dirname(File.realpath(__FILE__)).
@overload __dir__
@return [String];T;%0;"@;'F;)o;*;+T;,iC;-iK;.@
; I"static VALUE;T;/I"static VALUE
f_current_dirname(void)
{
VALUE base = rb_current_realfilepath();
if (NIL_P(base)) {
return Qnil;
}
base = rb_file_dirname(base);
return base;
};T;0To;
; F; ;
;;;I"Kernel#trace_var;F;[[@0;[[@i;T;:trace_var;0;[ ;{ ;IC;"Controls tracing of assignments to global variables. The parameter
+symbol+ identifies the variable (as either a string name or a
symbol identifier). _cmd_ (which may be a string or a
+Proc+ object) or block is executed whenever the variable
is assigned. The block or +Proc+ object receives the
variable's new value as a parameter. Also see
Kernel::untrace_var.
trace_var :$_, proc {|v| puts "$_ is now '#{v}'" }
$_ = "hello"
$_ = ' there'
produces:
$_ is now 'hello'
$_ is now ' there'
;T;[o;
; I"
overload;F; 0;;; 0; I" trace_var(symbol, cmd );T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@ ;#[ ;$I"@return [nil];T;%0;"@ ;&0;'F;(i ;[[I" symbol;T0[I"cmd;T0;"@ o;
; I"
overload;F; 0;;; 0; I"trace_var(symbol);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"val;T;"@ o;!
; I" return;F; I" ;T;0; [I"nil;T;"@ ;#[ ;$I" @yield [val]
@return [nil];T;%0;"@ ;&0;'F;(i ;[[I" symbol;T0;"@ ;#[ ;$I"}Controls tracing of assignments to global variables. The parameter
+symbol+ identifies the variable (as either a string name or a
symbol identifier). _cmd_ (which may be a string or a
+Proc+ object) or block is executed whenever the variable
is assigned. The block or +Proc+ object receives the
variable's new value as a parameter. Also see
Kernel::untrace_var.
trace_var :$_, proc {|v| puts "$_ is now '#{v}'" }
$_ = "hello"
$_ = ' there'
produces:
$_ is now 'hello'
$_ is now ' there'
@overload trace_var(symbol, cmd )
@return [nil]
@overload trace_var(symbol)
@yield [val]
@return [nil];T;%0;"@ ;'F;)o;*;+T;,i;-i;.@
; I"
VALUE;T;/I"VALUE
rb_f_trace_var(int argc, const VALUE *argv)
{
VALUE var, cmd;
struct rb_global_entry *entry;
struct trace_var *trace;
if (rb_scan_args(argc, argv, "11", &var, &cmd) == 1) {
cmd = rb_block_proc();
}
if (NIL_P(cmd)) {
return rb_f_untrace_var(argc, argv);
}
entry = rb_global_entry(rb_to_id(var));
if (OBJ_TAINTED(cmd)) {
rb_raise(rb_eSecurityError, "Insecure: tainted variable trace");
}
trace = ALLOC(struct trace_var);
trace->next = entry->var->trace;
trace->func = rb_trace_eval;
trace->data = cmd;
trace->removed = 0;
entry->var->trace = trace;
return Qnil;
};T;0To;
; F; ;
;;;I"Kernel#untrace_var;F;[[@0;[[@i;T;:untrace_var;0;[ ;{ ;IC;"Removes tracing for the specified command on the given global
variable and returns +nil+. If no command is specified,
removes all tracing for that variable and returns an array
containing the commands actually removed.
;T;[o;
; I"
overload;F; 0;;; 0; I"!untrace_var(symbol [, cmd] );T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;TI"nil;T;"@@;#[ ;$I"@return [Array, nil];T;%0;"@@;&0;'F;(i ;[[I"symbol[, cmd];T0;"@@;#[ ;$I"Removes tracing for the specified command on the given global
variable and returns +nil+. If no command is specified,
removes all tracing for that variable and returns an array
containing the commands actually removed.
@overload untrace_var(symbol [, cmd] )
@return [Array, nil];T;%0;"@@;'F;)o;*;+T;,i;-i;.@
; I"
VALUE;T;/I" VALUE
rb_f_untrace_var(int argc, const VALUE *argv)
{
VALUE var, cmd;
ID id;
struct rb_global_entry *entry;
struct trace_var *trace;
VALUE data;
rb_scan_args(argc, argv, "11", &var, &cmd);
id = rb_check_id(&var);
if (!id) {
rb_name_error_str(var, "undefined global variable %"PRIsVALUE"", QUOTE(var));
}
if (!rb_id_table_lookup(rb_global_tbl, id, &data)) {
rb_name_error(id, "undefined global variable %"PRIsVALUE"", QUOTE_ID(id));
}
trace = (entry = (struct rb_global_entry *)data)->var->trace;
if (NIL_P(cmd)) {
VALUE ary = rb_ary_new();
while (trace) {
struct trace_var *next = trace->next;
rb_ary_push(ary, (VALUE)trace->data);
trace->removed = 1;
trace = next;
}
if (!entry->var->block_trace) remove_trace(entry->var);
return ary;
}
else {
while (trace) {
if (trace->data == cmd) {
trace->removed = 1;
if (!entry->var->block_trace) remove_trace(entry->var);
return rb_ary_new3(1, cmd);
}
trace = trace->next;
}
}
return Qnil;
};T;0To;
; F; ;
;;;I"Kernel#callcc;F;[ ;[[I" cont.c;Ti;T;: callcc;0;[ ;{ ;IC;"Generates a Continuation object, which it passes to
the associated block. You need to require
'continuation' before using this method. Performing a
cont.call will cause the #callcc
to return (as will falling through the end of the block). The
value returned by the #callcc is the value of the
block, or the value passed to cont.call. See
class Continuation for more details. Also see
Kernel#throw for an alternative mechanism for
unwinding a call stack.
;T;[o;
; I"
overload;F; 0;;; 0; I" callcc;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" cont;T;"@_o;!
; I" return;F; I" ;T;0; [I" Object;T;"@_;#[ ;$I"#@yield [cont]
@return [Object];T;%0;"@_;&0;'F;(i ;[ ;"@_;#[ ;$I"4Generates a Continuation object, which it passes to
the associated block. You need to require
'continuation' before using this method. Performing a
cont.call will cause the #callcc
to return (as will falling through the end of the block). The
value returned by the #callcc is the value of the
block, or the value passed to cont.call. See
class Continuation for more details. Also see
Kernel#throw for an alternative mechanism for
unwinding a call stack.
@overload callcc
@yield [cont]
@return [Object];T;%0;"@_;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"static VALUE
rb_callcc(VALUE self)
{
volatile int called;
volatile VALUE val = cont_capture(&called);
if (called) {
return val;
}
else {
return rb_yield(val);
}
};T;0To;
; F; ;
;;;I"Kernel#Complex;F;[[@0;[[I"complex.c;Ti;T;: Complex;0;[ ;{ ;IC;"Returns x+i*y;
Complex(1, 2) #=> (1+2i)
Complex('1+2i') #=> (1+2i)
Complex(nil) #=> TypeError
Complex(1, nil) #=> TypeError
Syntax of string form:
string form = extra spaces , complex , extra spaces ;
complex = real part | [ sign ] , imaginary part
| real part , sign , imaginary part
| rational , "@" , rational ;
real part = rational ;
imaginary part = imaginary unit | unsigned rational , imaginary unit ;
rational = [ sign ] , unsigned rational ;
unsigned rational = numerator | numerator , "/" , denominator ;
numerator = integer part | fractional part | integer part , fractional part ;
denominator = digits ;
integer part = digits ;
fractional part = "." , digits , [ ( "e" | "E" ) , [ sign ] , digits ] ;
imaginary unit = "i" | "I" | "j" | "J" ;
sign = "-" | "+" ;
digits = digit , { digit | "_" , digit };
digit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" ;
extra spaces = ? \s* ? ;
See String#to_c.
;T;[o;
; I"
overload;F; 0;;; 0; I"Complex(x[, y]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Numeric;T;"@;#[ ;$I"@return [Numeric];T;%0;"@;&0;'F;(i ;[[I" x[, y];T0;"@;#[ ;$I"Returns x+i*y;
Complex(1, 2) #=> (1+2i)
Complex('1+2i') #=> (1+2i)
Complex(nil) #=> TypeError
Complex(1, nil) #=> TypeError
Syntax of string form:
string form = extra spaces , complex , extra spaces ;
complex = real part | [ sign ] , imaginary part
| real part , sign , imaginary part
| rational , "@" , rational ;
real part = rational ;
imaginary part = imaginary unit | unsigned rational , imaginary unit ;
rational = [ sign ] , unsigned rational ;
unsigned rational = numerator | numerator , "/" , denominator ;
numerator = integer part | fractional part | integer part , fractional part ;
denominator = digits ;
integer part = digits ;
fractional part = "." , digits , [ ( "e" | "E" ) , [ sign ] , digits ] ;
imaginary unit = "i" | "I" | "j" | "J" ;
sign = "-" | "+" ;
digits = digit , { digit | "_" , digit };
digit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" ;
extra spaces = ? \s* ? ;
See String#to_c.
@overload Complex(x[, y])
@return [Numeric];T;%0;"@;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"static VALUE
nucomp_f_complex(int argc, VALUE *argv, VALUE klass)
{
return rb_funcall2(rb_cComplex, id_convert, argc, argv);
};T;0To;
; F; ;
;;;I"Kernel#sprintf;F;[[@0;[[I"sprintf.c;Ti;T;: sprintf;0;[ ;{ ;IC;"C,Returns the string resulting from applying format_string to
any additional arguments. Within the format string, any characters
other than format sequences are copied to the result.
The syntax of a format sequence is follows.
%[flags][width][.precision]type
A format
sequence consists of a percent sign, followed by optional flags,
width, and precision indicators, then terminated with a field type
character. The field type controls how the corresponding
sprintf argument is to be interpreted, while the flags
modify that interpretation.
The field type characters are:
Field | Integer Format
------+--------------------------------------------------------------
b | Convert argument as a binary number.
| Negative numbers will be displayed as a two's complement
| prefixed with `..1'.
B | Equivalent to `b', but uses an uppercase 0B for prefix
| in the alternative format by #.
d | Convert argument as a decimal number.
i | Identical to `d'.
o | Convert argument as an octal number.
| Negative numbers will be displayed as a two's complement
| prefixed with `..7'.
u | Identical to `d'.
x | Convert argument as a hexadecimal number.
| Negative numbers will be displayed as a two's complement
| prefixed with `..f' (representing an infinite string of
| leading 'ff's).
X | Equivalent to `x', but uses uppercase letters.
Field | Float Format
------+--------------------------------------------------------------
e | Convert floating point argument into exponential notation
| with one digit before the decimal point as [-]d.dddddde[+-]dd.
| The precision specifies the number of digits after the decimal
| point (defaulting to six).
E | Equivalent to `e', but uses an uppercase E to indicate
| the exponent.
f | Convert floating point argument as [-]ddd.dddddd,
| where the precision specifies the number of digits after
| the decimal point.
g | Convert a floating point number using exponential form
| if the exponent is less than -4 or greater than or
| equal to the precision, or in dd.dddd form otherwise.
| The precision specifies the number of significant digits.
G | Equivalent to `g', but use an uppercase `E' in exponent form.
a | Convert floating point argument as [-]0xh.hhhhp[+-]dd,
| which is consisted from optional sign, "0x", fraction part
| as hexadecimal, "p", and exponential part as decimal.
A | Equivalent to `a', but use uppercase `X' and `P'.
Field | Other Format
------+--------------------------------------------------------------
c | Argument is the numeric code for a single character or
| a single character string itself.
p | The valuing of argument.inspect.
s | Argument is a string to be substituted. If the format
| sequence contains a precision, at most that many characters
| will be copied.
% | A percent sign itself will be displayed. No argument taken.
The flags modifies the behavior of the formats.
The flag characters are:
Flag | Applies to | Meaning
---------+---------------+-----------------------------------------
space | bBdiouxX | Leave a space at the start of
| aAeEfgG | non-negative numbers.
| (numeric fmt) | For `o', `x', `X', `b' and `B', use
| | a minus sign with absolute value for
| | negative values.
---------+---------------+-----------------------------------------
(digit)$ | all | Specifies the absolute argument number
| | for this field. Absolute and relative
| | argument numbers cannot be mixed in a
| | sprintf string.
---------+---------------+-----------------------------------------
# | bBoxX | Use an alternative format.
| aAeEfgG | For the conversions `o', increase the precision
| | until the first digit will be `0' if
| | it is not formatted as complements.
| | For the conversions `x', `X', `b' and `B'
| | on non-zero, prefix the result with ``0x'',
| | ``0X'', ``0b'' and ``0B'', respectively.
| | For `a', `A', `e', `E', `f', `g', and 'G',
| | force a decimal point to be added,
| | even if no digits follow.
| | For `g' and 'G', do not remove trailing zeros.
---------+---------------+-----------------------------------------
+ | bBdiouxX | Add a leading plus sign to non-negative
| aAeEfgG | numbers.
| (numeric fmt) | For `o', `x', `X', `b' and `B', use
| | a minus sign with absolute value for
| | negative values.
---------+---------------+-----------------------------------------
- | all | Left-justify the result of this conversion.
---------+---------------+-----------------------------------------
0 (zero) | bBdiouxX | Pad with zeros, not spaces.
| aAeEfgG | For `o', `x', `X', `b' and `B', radix-1
| (numeric fmt) | is used for negative numbers formatted as
| | complements.
---------+---------------+-----------------------------------------
* | all | Use the next argument as the field width.
| | If negative, left-justify the result. If the
| | asterisk is followed by a number and a dollar
| | sign, use the indicated argument as the width.
Examples of flags:
# `+' and space flag specifies the sign of non-negative numbers.
sprintf("%d", 123) #=> "123"
sprintf("%+d", 123) #=> "+123"
sprintf("% d", 123) #=> " 123"
# `#' flag for `o' increases number of digits to show `0'.
# `+' and space flag changes format of negative numbers.
sprintf("%o", 123) #=> "173"
sprintf("%#o", 123) #=> "0173"
sprintf("%+o", -123) #=> "-173"
sprintf("%o", -123) #=> "..7605"
sprintf("%#o", -123) #=> "..7605"
# `#' flag for `x' add a prefix `0x' for non-zero numbers.
# `+' and space flag disables complements for negative numbers.
sprintf("%x", 123) #=> "7b"
sprintf("%#x", 123) #=> "0x7b"
sprintf("%+x", -123) #=> "-7b"
sprintf("%x", -123) #=> "..f85"
sprintf("%#x", -123) #=> "0x..f85"
sprintf("%#x", 0) #=> "0"
# `#' for `X' uses the prefix `0X'.
sprintf("%X", 123) #=> "7B"
sprintf("%#X", 123) #=> "0X7B"
# `#' flag for `b' add a prefix `0b' for non-zero numbers.
# `+' and space flag disables complements for negative numbers.
sprintf("%b", 123) #=> "1111011"
sprintf("%#b", 123) #=> "0b1111011"
sprintf("%+b", -123) #=> "-1111011"
sprintf("%b", -123) #=> "..10000101"
sprintf("%#b", -123) #=> "0b..10000101"
sprintf("%#b", 0) #=> "0"
# `#' for `B' uses the prefix `0B'.
sprintf("%B", 123) #=> "1111011"
sprintf("%#B", 123) #=> "0B1111011"
# `#' for `e' forces to show the decimal point.
sprintf("%.0e", 1) #=> "1e+00"
sprintf("%#.0e", 1) #=> "1.e+00"
# `#' for `f' forces to show the decimal point.
sprintf("%.0f", 1234) #=> "1234"
sprintf("%#.0f", 1234) #=> "1234."
# `#' for `g' forces to show the decimal point.
# It also disables stripping lowest zeros.
sprintf("%g", 123.4) #=> "123.4"
sprintf("%#g", 123.4) #=> "123.400"
sprintf("%g", 123456) #=> "123456"
sprintf("%#g", 123456) #=> "123456."
The field width is an optional integer, followed optionally by a
period and a precision. The width specifies the minimum number of
characters that will be written to the result for this field.
Examples of width:
# padding is done by spaces, width=20
# 0 or radix-1. <------------------>
sprintf("%20d", 123) #=> " 123"
sprintf("%+20d", 123) #=> " +123"
sprintf("%020d", 123) #=> "00000000000000000123"
sprintf("%+020d", 123) #=> "+0000000000000000123"
sprintf("% 020d", 123) #=> " 0000000000000000123"
sprintf("%-20d", 123) #=> "123 "
sprintf("%-+20d", 123) #=> "+123 "
sprintf("%- 20d", 123) #=> " 123 "
sprintf("%020x", -123) #=> "..ffffffffffffffff85"
For
numeric fields, the precision controls the number of decimal places
displayed. For string fields, the precision determines the maximum
number of characters to be copied from the string. (Thus, the format
sequence %10.10s will always contribute exactly ten
characters to the result.)
Examples of precisions:
# precision for `d', 'o', 'x' and 'b' is
# minimum number of digits <------>
sprintf("%20.8d", 123) #=> " 00000123"
sprintf("%20.8o", 123) #=> " 00000173"
sprintf("%20.8x", 123) #=> " 0000007b"
sprintf("%20.8b", 123) #=> " 01111011"
sprintf("%20.8d", -123) #=> " -00000123"
sprintf("%20.8o", -123) #=> " ..777605"
sprintf("%20.8x", -123) #=> " ..ffff85"
sprintf("%20.8b", -11) #=> " ..110101"
# "0x" and "0b" for `#x' and `#b' is not counted for
# precision but "0" for `#o' is counted. <------>
sprintf("%#20.8d", 123) #=> " 00000123"
sprintf("%#20.8o", 123) #=> " 00000173"
sprintf("%#20.8x", 123) #=> " 0x0000007b"
sprintf("%#20.8b", 123) #=> " 0b01111011"
sprintf("%#20.8d", -123) #=> " -00000123"
sprintf("%#20.8o", -123) #=> " ..777605"
sprintf("%#20.8x", -123) #=> " 0x..ffff85"
sprintf("%#20.8b", -11) #=> " 0b..110101"
# precision for `e' is number of
# digits after the decimal point <------>
sprintf("%20.8e", 1234.56789) #=> " 1.23456789e+03"
# precision for `f' is number of
# digits after the decimal point <------>
sprintf("%20.8f", 1234.56789) #=> " 1234.56789000"
# precision for `g' is number of
# significant digits <------->
sprintf("%20.8g", 1234.56789) #=> " 1234.5679"
# <------->
sprintf("%20.8g", 123456789) #=> " 1.2345679e+08"
# precision for `s' is
# maximum number of characters <------>
sprintf("%20.8s", "string test") #=> " string t"
Examples:
sprintf("%d %04x", 123, 123) #=> "123 007b"
sprintf("%08b '%4s'", 123, 123) #=> "01111011 ' 123'"
sprintf("%1$*2$s %2$d %1$s", "hello", 8) #=> " hello 8 hello"
sprintf("%1$*2$s %2$d", "hello", -8) #=> "hello -8"
sprintf("%+g:% g:%-g", 1.23, 1.23, 1.23) #=> "+1.23: 1.23:1.23"
sprintf("%u", -123) #=> "-123"
For more complex formatting, Ruby supports a reference by name.
%s style uses format style, but %{name} style doesn't.
Examples:
sprintf("%d : %f", { :foo => 1, :bar => 2 })
#=> 1 : 2.000000
sprintf("%{foo}f", { :foo => 1 })
# => "1f"
;T;[o;
; I"
overload;F; 0;: format; 0; I",format(format_string [, arguments...] );T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@;#[ ;$I"@return [String];T;%0;"@;&0;'F;(i ;[[I""format_string[, arguments...];T0;"@o;
; I"
overload;F; 0;;; 0; I"-sprintf(format_string [, arguments...] );T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@;#[ ;$I"@return [String];T;%0;"@;&0;'F;(i ;[[I""format_string[, arguments...];T0;"@;#[ ;$I",Returns the string resulting from applying format_string to
any additional arguments. Within the format string, any characters
other than format sequences are copied to the result.
The syntax of a format sequence is follows.
%[flags][width][.precision]type
A format
sequence consists of a percent sign, followed by optional flags,
width, and precision indicators, then terminated with a field type
character. The field type controls how the corresponding
sprintf argument is to be interpreted, while the flags
modify that interpretation.
The field type characters are:
Field | Integer Format
------+--------------------------------------------------------------
b | Convert argument as a binary number.
| Negative numbers will be displayed as a two's complement
| prefixed with `..1'.
B | Equivalent to `b', but uses an uppercase 0B for prefix
| in the alternative format by #.
d | Convert argument as a decimal number.
i | Identical to `d'.
o | Convert argument as an octal number.
| Negative numbers will be displayed as a two's complement
| prefixed with `..7'.
u | Identical to `d'.
x | Convert argument as a hexadecimal number.
| Negative numbers will be displayed as a two's complement
| prefixed with `..f' (representing an infinite string of
| leading 'ff's).
X | Equivalent to `x', but uses uppercase letters.
Field | Float Format
------+--------------------------------------------------------------
e | Convert floating point argument into exponential notation
| with one digit before the decimal point as [-]d.dddddde[+-]dd.
| The precision specifies the number of digits after the decimal
| point (defaulting to six).
E | Equivalent to `e', but uses an uppercase E to indicate
| the exponent.
f | Convert floating point argument as [-]ddd.dddddd,
| where the precision specifies the number of digits after
| the decimal point.
g | Convert a floating point number using exponential form
| if the exponent is less than -4 or greater than or
| equal to the precision, or in dd.dddd form otherwise.
| The precision specifies the number of significant digits.
G | Equivalent to `g', but use an uppercase `E' in exponent form.
a | Convert floating point argument as [-]0xh.hhhhp[+-]dd,
| which is consisted from optional sign, "0x", fraction part
| as hexadecimal, "p", and exponential part as decimal.
A | Equivalent to `a', but use uppercase `X' and `P'.
Field | Other Format
------+--------------------------------------------------------------
c | Argument is the numeric code for a single character or
| a single character string itself.
p | The valuing of argument.inspect.
s | Argument is a string to be substituted. If the format
| sequence contains a precision, at most that many characters
| will be copied.
% | A percent sign itself will be displayed. No argument taken.
The flags modifies the behavior of the formats.
The flag characters are:
Flag | Applies to | Meaning
---------+---------------+-----------------------------------------
space | bBdiouxX | Leave a space at the start of
| aAeEfgG | non-negative numbers.
| (numeric fmt) | For `o', `x', `X', `b' and `B', use
| | a minus sign with absolute value for
| | negative values.
---------+---------------+-----------------------------------------
(digit)$ | all | Specifies the absolute argument number
| | for this field. Absolute and relative
| | argument numbers cannot be mixed in a
| | sprintf string.
---------+---------------+-----------------------------------------
# | bBoxX | Use an alternative format.
| aAeEfgG | For the conversions `o', increase the precision
| | until the first digit will be `0' if
| | it is not formatted as complements.
| | For the conversions `x', `X', `b' and `B'
| | on non-zero, prefix the result with ``0x'',
| | ``0X'', ``0b'' and ``0B'', respectively.
| | For `a', `A', `e', `E', `f', `g', and 'G',
| | force a decimal point to be added,
| | even if no digits follow.
| | For `g' and 'G', do not remove trailing zeros.
---------+---------------+-----------------------------------------
+ | bBdiouxX | Add a leading plus sign to non-negative
| aAeEfgG | numbers.
| (numeric fmt) | For `o', `x', `X', `b' and `B', use
| | a minus sign with absolute value for
| | negative values.
---------+---------------+-----------------------------------------
- | all | Left-justify the result of this conversion.
---------+---------------+-----------------------------------------
0 (zero) | bBdiouxX | Pad with zeros, not spaces.
| aAeEfgG | For `o', `x', `X', `b' and `B', radix-1
| (numeric fmt) | is used for negative numbers formatted as
| | complements.
---------+---------------+-----------------------------------------
* | all | Use the next argument as the field width.
| | If negative, left-justify the result. If the
| | asterisk is followed by a number and a dollar
| | sign, use the indicated argument as the width.
Examples of flags:
# `+' and space flag specifies the sign of non-negative numbers.
sprintf("%d", 123) #=> "123"
sprintf("%+d", 123) #=> "+123"
sprintf("% d", 123) #=> " 123"
# `#' flag for `o' increases number of digits to show `0'.
# `+' and space flag changes format of negative numbers.
sprintf("%o", 123) #=> "173"
sprintf("%#o", 123) #=> "0173"
sprintf("%+o", -123) #=> "-173"
sprintf("%o", -123) #=> "..7605"
sprintf("%#o", -123) #=> "..7605"
# `#' flag for `x' add a prefix `0x' for non-zero numbers.
# `+' and space flag disables complements for negative numbers.
sprintf("%x", 123) #=> "7b"
sprintf("%#x", 123) #=> "0x7b"
sprintf("%+x", -123) #=> "-7b"
sprintf("%x", -123) #=> "..f85"
sprintf("%#x", -123) #=> "0x..f85"
sprintf("%#x", 0) #=> "0"
# `#' for `X' uses the prefix `0X'.
sprintf("%X", 123) #=> "7B"
sprintf("%#X", 123) #=> "0X7B"
# `#' flag for `b' add a prefix `0b' for non-zero numbers.
# `+' and space flag disables complements for negative numbers.
sprintf("%b", 123) #=> "1111011"
sprintf("%#b", 123) #=> "0b1111011"
sprintf("%+b", -123) #=> "-1111011"
sprintf("%b", -123) #=> "..10000101"
sprintf("%#b", -123) #=> "0b..10000101"
sprintf("%#b", 0) #=> "0"
# `#' for `B' uses the prefix `0B'.
sprintf("%B", 123) #=> "1111011"
sprintf("%#B", 123) #=> "0B1111011"
# `#' for `e' forces to show the decimal point.
sprintf("%.0e", 1) #=> "1e+00"
sprintf("%#.0e", 1) #=> "1.e+00"
# `#' for `f' forces to show the decimal point.
sprintf("%.0f", 1234) #=> "1234"
sprintf("%#.0f", 1234) #=> "1234."
# `#' for `g' forces to show the decimal point.
# It also disables stripping lowest zeros.
sprintf("%g", 123.4) #=> "123.4"
sprintf("%#g", 123.4) #=> "123.400"
sprintf("%g", 123456) #=> "123456"
sprintf("%#g", 123456) #=> "123456."
The field width is an optional integer, followed optionally by a
period and a precision. The width specifies the minimum number of
characters that will be written to the result for this field.
Examples of width:
# padding is done by spaces, width=20
# 0 or radix-1. <------------------>
sprintf("%20d", 123) #=> " 123"
sprintf("%+20d", 123) #=> " +123"
sprintf("%020d", 123) #=> "00000000000000000123"
sprintf("%+020d", 123) #=> "+0000000000000000123"
sprintf("% 020d", 123) #=> " 0000000000000000123"
sprintf("%-20d", 123) #=> "123 "
sprintf("%-+20d", 123) #=> "+123 "
sprintf("%- 20d", 123) #=> " 123 "
sprintf("%020x", -123) #=> "..ffffffffffffffff85"
For
numeric fields, the precision controls the number of decimal places
displayed. For string fields, the precision determines the maximum
number of characters to be copied from the string. (Thus, the format
sequence %10.10s will always contribute exactly ten
characters to the result.)
Examples of precisions:
# precision for `d', 'o', 'x' and 'b' is
# minimum number of digits <------>
sprintf("%20.8d", 123) #=> " 00000123"
sprintf("%20.8o", 123) #=> " 00000173"
sprintf("%20.8x", 123) #=> " 0000007b"
sprintf("%20.8b", 123) #=> " 01111011"
sprintf("%20.8d", -123) #=> " -00000123"
sprintf("%20.8o", -123) #=> " ..777605"
sprintf("%20.8x", -123) #=> " ..ffff85"
sprintf("%20.8b", -11) #=> " ..110101"
# "0x" and "0b" for `#x' and `#b' is not counted for
# precision but "0" for `#o' is counted. <------>
sprintf("%#20.8d", 123) #=> " 00000123"
sprintf("%#20.8o", 123) #=> " 00000173"
sprintf("%#20.8x", 123) #=> " 0x0000007b"
sprintf("%#20.8b", 123) #=> " 0b01111011"
sprintf("%#20.8d", -123) #=> " -00000123"
sprintf("%#20.8o", -123) #=> " ..777605"
sprintf("%#20.8x", -123) #=> " 0x..ffff85"
sprintf("%#20.8b", -11) #=> " 0b..110101"
# precision for `e' is number of
# digits after the decimal point <------>
sprintf("%20.8e", 1234.56789) #=> " 1.23456789e+03"
# precision for `f' is number of
# digits after the decimal point <------>
sprintf("%20.8f", 1234.56789) #=> " 1234.56789000"
# precision for `g' is number of
# significant digits <------->
sprintf("%20.8g", 1234.56789) #=> " 1234.5679"
# <------->
sprintf("%20.8g", 123456789) #=> " 1.2345679e+08"
# precision for `s' is
# maximum number of characters <------>
sprintf("%20.8s", "string test") #=> " string t"
Examples:
sprintf("%d %04x", 123, 123) #=> "123 007b"
sprintf("%08b '%4s'", 123, 123) #=> "01111011 ' 123'"
sprintf("%1$*2$s %2$d %1$s", "hello", 8) #=> " hello 8 hello"
sprintf("%1$*2$s %2$d", "hello", -8) #=> "hello -8"
sprintf("%+g:% g:%-g", 1.23, 1.23, 1.23) #=> "+1.23: 1.23:1.23"
sprintf("%u", -123) #=> "-123"
For more complex formatting, Ruby supports a reference by name.
%s style uses format style, but %{name} style doesn't.
Examples:
sprintf("%d : %f", { :foo => 1, :bar => 2 })
#=> 1 : 2.000000
sprintf("%{foo}f", { :foo => 1 })
# => "1f"
@overload format(format_string [, arguments...] )
@return [String]
@overload sprintf(format_string [, arguments...] )
@return [String];T;%0;"@;'F;)o;*;+T;,i;-i;.@
; I"
VALUE;T;/I"tVALUE
rb_f_sprintf(int argc, const VALUE *argv)
{
return rb_str_format(argc - 1, argv + 1, GETNTHARG(0));
};T;0To;
; F; ;
;;;I"Kernel#format;F;[[@0;[[@i;T;;;0;[ ;{ ;IC;"C,Returns the string resulting from applying format_string to
any additional arguments. Within the format string, any characters
other than format sequences are copied to the result.
The syntax of a format sequence is follows.
%[flags][width][.precision]type
A format
sequence consists of a percent sign, followed by optional flags,
width, and precision indicators, then terminated with a field type
character. The field type controls how the corresponding
sprintf argument is to be interpreted, while the flags
modify that interpretation.
The field type characters are:
Field | Integer Format
------+--------------------------------------------------------------
b | Convert argument as a binary number.
| Negative numbers will be displayed as a two's complement
| prefixed with `..1'.
B | Equivalent to `b', but uses an uppercase 0B for prefix
| in the alternative format by #.
d | Convert argument as a decimal number.
i | Identical to `d'.
o | Convert argument as an octal number.
| Negative numbers will be displayed as a two's complement
| prefixed with `..7'.
u | Identical to `d'.
x | Convert argument as a hexadecimal number.
| Negative numbers will be displayed as a two's complement
| prefixed with `..f' (representing an infinite string of
| leading 'ff's).
X | Equivalent to `x', but uses uppercase letters.
Field | Float Format
------+--------------------------------------------------------------
e | Convert floating point argument into exponential notation
| with one digit before the decimal point as [-]d.dddddde[+-]dd.
| The precision specifies the number of digits after the decimal
| point (defaulting to six).
E | Equivalent to `e', but uses an uppercase E to indicate
| the exponent.
f | Convert floating point argument as [-]ddd.dddddd,
| where the precision specifies the number of digits after
| the decimal point.
g | Convert a floating point number using exponential form
| if the exponent is less than -4 or greater than or
| equal to the precision, or in dd.dddd form otherwise.
| The precision specifies the number of significant digits.
G | Equivalent to `g', but use an uppercase `E' in exponent form.
a | Convert floating point argument as [-]0xh.hhhhp[+-]dd,
| which is consisted from optional sign, "0x", fraction part
| as hexadecimal, "p", and exponential part as decimal.
A | Equivalent to `a', but use uppercase `X' and `P'.
Field | Other Format
------+--------------------------------------------------------------
c | Argument is the numeric code for a single character or
| a single character string itself.
p | The valuing of argument.inspect.
s | Argument is a string to be substituted. If the format
| sequence contains a precision, at most that many characters
| will be copied.
% | A percent sign itself will be displayed. No argument taken.
The flags modifies the behavior of the formats.
The flag characters are:
Flag | Applies to | Meaning
---------+---------------+-----------------------------------------
space | bBdiouxX | Leave a space at the start of
| aAeEfgG | non-negative numbers.
| (numeric fmt) | For `o', `x', `X', `b' and `B', use
| | a minus sign with absolute value for
| | negative values.
---------+---------------+-----------------------------------------
(digit)$ | all | Specifies the absolute argument number
| | for this field. Absolute and relative
| | argument numbers cannot be mixed in a
| | sprintf string.
---------+---------------+-----------------------------------------
# | bBoxX | Use an alternative format.
| aAeEfgG | For the conversions `o', increase the precision
| | until the first digit will be `0' if
| | it is not formatted as complements.
| | For the conversions `x', `X', `b' and `B'
| | on non-zero, prefix the result with ``0x'',
| | ``0X'', ``0b'' and ``0B'', respectively.
| | For `a', `A', `e', `E', `f', `g', and 'G',
| | force a decimal point to be added,
| | even if no digits follow.
| | For `g' and 'G', do not remove trailing zeros.
---------+---------------+-----------------------------------------
+ | bBdiouxX | Add a leading plus sign to non-negative
| aAeEfgG | numbers.
| (numeric fmt) | For `o', `x', `X', `b' and `B', use
| | a minus sign with absolute value for
| | negative values.
---------+---------------+-----------------------------------------
- | all | Left-justify the result of this conversion.
---------+---------------+-----------------------------------------
0 (zero) | bBdiouxX | Pad with zeros, not spaces.
| aAeEfgG | For `o', `x', `X', `b' and `B', radix-1
| (numeric fmt) | is used for negative numbers formatted as
| | complements.
---------+---------------+-----------------------------------------
* | all | Use the next argument as the field width.
| | If negative, left-justify the result. If the
| | asterisk is followed by a number and a dollar
| | sign, use the indicated argument as the width.
Examples of flags:
# `+' and space flag specifies the sign of non-negative numbers.
sprintf("%d", 123) #=> "123"
sprintf("%+d", 123) #=> "+123"
sprintf("% d", 123) #=> " 123"
# `#' flag for `o' increases number of digits to show `0'.
# `+' and space flag changes format of negative numbers.
sprintf("%o", 123) #=> "173"
sprintf("%#o", 123) #=> "0173"
sprintf("%+o", -123) #=> "-173"
sprintf("%o", -123) #=> "..7605"
sprintf("%#o", -123) #=> "..7605"
# `#' flag for `x' add a prefix `0x' for non-zero numbers.
# `+' and space flag disables complements for negative numbers.
sprintf("%x", 123) #=> "7b"
sprintf("%#x", 123) #=> "0x7b"
sprintf("%+x", -123) #=> "-7b"
sprintf("%x", -123) #=> "..f85"
sprintf("%#x", -123) #=> "0x..f85"
sprintf("%#x", 0) #=> "0"
# `#' for `X' uses the prefix `0X'.
sprintf("%X", 123) #=> "7B"
sprintf("%#X", 123) #=> "0X7B"
# `#' flag for `b' add a prefix `0b' for non-zero numbers.
# `+' and space flag disables complements for negative numbers.
sprintf("%b", 123) #=> "1111011"
sprintf("%#b", 123) #=> "0b1111011"
sprintf("%+b", -123) #=> "-1111011"
sprintf("%b", -123) #=> "..10000101"
sprintf("%#b", -123) #=> "0b..10000101"
sprintf("%#b", 0) #=> "0"
# `#' for `B' uses the prefix `0B'.
sprintf("%B", 123) #=> "1111011"
sprintf("%#B", 123) #=> "0B1111011"
# `#' for `e' forces to show the decimal point.
sprintf("%.0e", 1) #=> "1e+00"
sprintf("%#.0e", 1) #=> "1.e+00"
# `#' for `f' forces to show the decimal point.
sprintf("%.0f", 1234) #=> "1234"
sprintf("%#.0f", 1234) #=> "1234."
# `#' for `g' forces to show the decimal point.
# It also disables stripping lowest zeros.
sprintf("%g", 123.4) #=> "123.4"
sprintf("%#g", 123.4) #=> "123.400"
sprintf("%g", 123456) #=> "123456"
sprintf("%#g", 123456) #=> "123456."
The field width is an optional integer, followed optionally by a
period and a precision. The width specifies the minimum number of
characters that will be written to the result for this field.
Examples of width:
# padding is done by spaces, width=20
# 0 or radix-1. <------------------>
sprintf("%20d", 123) #=> " 123"
sprintf("%+20d", 123) #=> " +123"
sprintf("%020d", 123) #=> "00000000000000000123"
sprintf("%+020d", 123) #=> "+0000000000000000123"
sprintf("% 020d", 123) #=> " 0000000000000000123"
sprintf("%-20d", 123) #=> "123 "
sprintf("%-+20d", 123) #=> "+123 "
sprintf("%- 20d", 123) #=> " 123 "
sprintf("%020x", -123) #=> "..ffffffffffffffff85"
For
numeric fields, the precision controls the number of decimal places
displayed. For string fields, the precision determines the maximum
number of characters to be copied from the string. (Thus, the format
sequence %10.10s will always contribute exactly ten
characters to the result.)
Examples of precisions:
# precision for `d', 'o', 'x' and 'b' is
# minimum number of digits <------>
sprintf("%20.8d", 123) #=> " 00000123"
sprintf("%20.8o", 123) #=> " 00000173"
sprintf("%20.8x", 123) #=> " 0000007b"
sprintf("%20.8b", 123) #=> " 01111011"
sprintf("%20.8d", -123) #=> " -00000123"
sprintf("%20.8o", -123) #=> " ..777605"
sprintf("%20.8x", -123) #=> " ..ffff85"
sprintf("%20.8b", -11) #=> " ..110101"
# "0x" and "0b" for `#x' and `#b' is not counted for
# precision but "0" for `#o' is counted. <------>
sprintf("%#20.8d", 123) #=> " 00000123"
sprintf("%#20.8o", 123) #=> " 00000173"
sprintf("%#20.8x", 123) #=> " 0x0000007b"
sprintf("%#20.8b", 123) #=> " 0b01111011"
sprintf("%#20.8d", -123) #=> " -00000123"
sprintf("%#20.8o", -123) #=> " ..777605"
sprintf("%#20.8x", -123) #=> " 0x..ffff85"
sprintf("%#20.8b", -11) #=> " 0b..110101"
# precision for `e' is number of
# digits after the decimal point <------>
sprintf("%20.8e", 1234.56789) #=> " 1.23456789e+03"
# precision for `f' is number of
# digits after the decimal point <------>
sprintf("%20.8f", 1234.56789) #=> " 1234.56789000"
# precision for `g' is number of
# significant digits <------->
sprintf("%20.8g", 1234.56789) #=> " 1234.5679"
# <------->
sprintf("%20.8g", 123456789) #=> " 1.2345679e+08"
# precision for `s' is
# maximum number of characters <------>
sprintf("%20.8s", "string test") #=> " string t"
Examples:
sprintf("%d %04x", 123, 123) #=> "123 007b"
sprintf("%08b '%4s'", 123, 123) #=> "01111011 ' 123'"
sprintf("%1$*2$s %2$d %1$s", "hello", 8) #=> " hello 8 hello"
sprintf("%1$*2$s %2$d", "hello", -8) #=> "hello -8"
sprintf("%+g:% g:%-g", 1.23, 1.23, 1.23) #=> "+1.23: 1.23:1.23"
sprintf("%u", -123) #=> "-123"
For more complex formatting, Ruby supports a reference by name.
%s style uses format style, but %{name} style doesn't.
Examples:
sprintf("%d : %f", { :foo => 1, :bar => 2 })
#=> 1 : 2.000000
sprintf("%{foo}f", { :foo => 1 })
# => "1f"
;T;[o;
; I"
overload;F; 0;;; 0; I",format(format_string [, arguments...] );T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@;#[ ;$I"@return [String];T;%0;"@;&0;'F;(i ;[[I""format_string[, arguments...];T0;"@o;
; I"
overload;F; 0;;; 0; I"-sprintf(format_string [, arguments...] );T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@;#[ ;$I"@return [String];T;%0;"@;&0;'F;(i ;[[I""format_string[, arguments...];T0;"@;#[ ;$@;%0;"@;'F;)o;*;+T;,i;-i;.@
; I"
VALUE;T;/I"tVALUE
rb_f_sprintf(int argc, const VALUE *argv)
{
return rb_str_format(argc - 1, argv + 1, GETNTHARG(0));
};T;0To;
; F; ;
;;;I"Kernel#Integer;F;[[@0;[[@ui
;T;: Integer;0;[ ;{ ;IC;"xConverts arg to a Fixnum or Bignum.
Numeric types are converted directly (with floating point numbers
being truncated). base (0, or between 2 and 36) is a base for
integer string representation. If arg is a String,
when base is omitted or equals zero, radix indicators
(0, 0b, and 0x) are honored.
In any case, strings should be strictly conformed to numeric
representation. This behavior is different from that of
String#to_i. Non string values will be converted by first
trying to_int, then to_i. Passing nil
raises a TypeError.
Integer(123.999) #=> 123
Integer("0x1a") #=> 26
Integer(Time.new) #=> 1204973019
Integer("0930", 10) #=> 930
Integer("111", 2) #=> 7
Integer(nil) #=> TypeError
;T;[o;
; I"
overload;F; 0;;; 0; I"Integer(arg, base=0);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@;#[ ;$I"@return [Integer];T;%0;"@;&0;'F;(i ;[[I"arg;T0[I" base;TI"0;T;"@;#[ ;$I"Converts arg to a Fixnum or Bignum.
Numeric types are converted directly (with floating point numbers
being truncated). base (0, or between 2 and 36) is a base for
integer string representation. If arg is a String,
when base is omitted or equals zero, radix indicators
(0, 0b, and 0x) are honored.
In any case, strings should be strictly conformed to numeric
representation. This behavior is different from that of
String#to_i. Non string values will be converted by first
trying to_int, then to_i. Passing nil
raises a TypeError.
Integer(123.999) #=> 123
Integer("0x1a") #=> 26
Integer(Time.new) #=> 1204973019
Integer("0930", 10) #=> 930
Integer("111", 2) #=> 7
Integer(nil) #=> TypeError
@overload Integer(arg, base=0)
@return [Integer];T;%0;"@;'F;)o;*;+T;,i
;-i
;.@
; I"static VALUE;T;/I"[static VALUE
rb_f_integer(int argc, VALUE *argv, VALUE obj)
{
VALUE arg = Qnil;
int base = 0;
switch (argc) {
case 2:
base = NUM2INT(argv[1]);
case 1:
arg = argv[0];
break;
default:
/* should cause ArgumentError */
rb_scan_args(argc, argv, "11", NULL, NULL);
}
return rb_convert_to_integer(arg, base);
};T;0To;
; F; ;
;;;I"Kernel#Float;F;[[I"arg;T0;[[@ui ;T;:
Float;0;[ ;{ ;IC;"8Returns arg converted to a float. Numeric types are converted
directly, and with exception to string and nil the rest are converted using arg.to_f.
Converting a string with invalid characters will result in a ArgumentError.
Converting nil generates a TypeError.
Float(1) #=> 1.0
Float("123.456") #=> 123.456
Float("123.0_badstring") #=> ArgumentError: invalid value for Float(): "123.0_badstring"
Float(nil) #=> TypeError: can't convert nil into Float
;T;[o;
; I"
overload;F; 0;;; 0; I"Float(arg);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@;#[ ;$I"@return [Float];T;%0;"@;&0;'F;(i ;[[I"arg;T0;"@;#[ ;$I"aReturns arg converted to a float. Numeric types are converted
directly, and with exception to string and nil the rest are converted using arg.to_f.
Converting a string with invalid characters will result in a ArgumentError.
Converting nil generates a TypeError.
Float(1) #=> 1.0
Float("123.456") #=> 123.456
Float("123.0_badstring") #=> ArgumentError: invalid value for Float(): "123.0_badstring"
Float(nil) #=> TypeError: can't convert nil into Float
@overload Float(arg)
@return [Float];T;%0;"@;'F;)o;*;+T;,i} ;-i ;.@
; I"static VALUE;T;/I"Pstatic VALUE
rb_f_float(VALUE obj, VALUE arg)
{
return rb_Float(arg);
};T;0To;
; F; ;
;;;I"Kernel#String;F;[[I"arg;T0;[[@ui ;T;: String;0;[ ;{ ;IC;"Returns arg as a String.
First tries to call its to_str method, then its to_s method.
String(self) #=> "main"
String(self.class) #=> "Object"
String(123456) #=> "123456"
;T;[o;
; I"
overload;F; 0;;; 0; I"String(arg);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@9;#[ ;$I"@return [String];T;%0;"@9;&0;'F;(i ;[[I"arg;T0;"@9;#[ ;$I"Returns arg as a String.
First tries to call its to_str method, then its to_s method.
String(self) #=> "main"
String(self.class) #=> "Object"
String(123456) #=> "123456"
@overload String(arg)
@return [String];T;%0;"@9;'F;)o;*;+T;,i ;-i ;.@
; I"static VALUE;T;/I"Rstatic VALUE
rb_f_string(VALUE obj, VALUE arg)
{
return rb_String(arg);
};T;0To;
; F; ;
;;;I"Kernel#Array;F;[[I"arg;T0;[[@ui- ;T;:
Array;0;[ ;{ ;IC;"Returns +arg+ as an Array.
First tries to call to_ary on +arg+, then to_a.
Array(1..5) #=> [1, 2, 3, 4, 5]
;T;[o;
; I"
overload;F; 0;;; 0; I"Array(arg);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@X;#[ ;$I"@return [Array];T;%0;"@X;&0;'F;(i ;[[I"arg;T0;"@X;#[ ;$I"Returns +arg+ as an Array.
First tries to call to_ary on +arg+, then to_a.
Array(1..5) #=> [1, 2, 3, 4, 5]
@overload Array(arg)
@return [Array];T;%0;"@X;'F;)o;*;+T;,i" ;-i* ;.@
; I"static VALUE;T;/I"Pstatic VALUE
rb_f_array(VALUE obj, VALUE arg)
{
return rb_Array(arg);
};T;0To;
; F; ;
;;;I"Kernel#Hash;F;[[I"arg;T0;[[@uiP ;T;: Hash;0;[ ;{ ;IC;"/Converts arg to a Hash by calling
arg.to_hash. Returns an empty Hash when
arg is nil or [].
Hash([]) #=> {}
Hash(nil) #=> {}
Hash(key: :value) #=> {:key => :value}
Hash([1, 2, 3]) #=> TypeError
;T;[o;
; I"
overload;F; 0;;; 0; I"Hash(arg);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@w;#[ ;$I"@return [Hash];T;%0;"@w;&0;'F;(i ;[[I"arg;T0;"@w;#[ ;$I"VConverts arg to a Hash by calling
arg.to_hash. Returns an empty Hash when
arg is nil or [].
Hash([]) #=> {}
Hash(nil) #=> {}
Hash(key: :value) #=> {:key => :value}
Hash([1, 2, 3]) #=> TypeError
@overload Hash(arg)
@return [Hash];T;%0;"@w;'F;)o;*;+T;,iB ;-iM ;.@
; I"static VALUE;T;/I"Nstatic VALUE
rb_f_hash(VALUE obj, VALUE arg)
{
return rb_Hash(arg);
};T;0To;
; F; ;
;;;I"Kernel#BigDecimal;F;[[@0;[[I" ext/bigdecimal/bigdecimal.c;Ti'
;T;:BigDecimal;0;[ ;{ ;IC;" See also BigDecimal.new
;T;[ ;#[ ;$I" See also BigDecimal.new;T;%0;"@;'F;)o;*;+T;,i&
;-i&
;.@
; I"static VALUE;T;/I"Tstatic VALUE
BigDecimal_global_new(int argc, VALUE *argv, VALUE self)
{
ENTER(1);
Real *pv;
VALUE obj;
obj = TypedData_Wrap_Struct(rb_cBigDecimal, &BigDecimal_data_type, 0);
GUARD_OBJ(pv, BigDecimal_new(argc, argv));
if (ToValue(pv)) pv = VpCopy(NULL, pv);
RTYPEDDATA_DATA(obj) = pv;
return pv->obj = obj;
};T;0To;
; F; ;
;;;I"Kernel#Pathname;F;[[I"str;T0;[[I" ext/pathname/pathname.c;Ti;T;:
Pathname;0;[ ;{ ;IC;"Y:call-seq:
Pathname(path) -> pathname
Creates a new Pathname object from the given string, +path+, and returns
pathname object.
In order to use this constructor, you must first require the Pathname
standard library extension.
require 'pathname'
Pathname("/home/zzak")
#=> #
See also Pathname::new for more information.
;T;[ ;#[ ;$I"Z:call-seq:
Pathname(path) -> pathname
Creates a new Pathname object from the given string, +path+, and returns
pathname object.
In order to use this constructor, you must first require the Pathname
standard library extension.
require 'pathname'
Pathname("/home/zzak")
#=> #
See also Pathname::new for more information.
;T;%0;"@;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"ustatic VALUE
path_f_pathname(VALUE self, VALUE str)
{
return rb_class_new_instance(1, &str, rb_cPathname);
};T;0To;
; F; ;
;;;I"(Kernel#register_sample_bug_reporter;F;[[I"obj;T0;[[I"+ext/-test-/bug_reporter/bug_reporter.c;Ti;T;:!register_sample_bug_reporter;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@;.@
; I"static VALUE;T;/I"static VALUE
register_sample_bug_reporter(VALUE self, VALUE obj)
{
rb_bug_reporter_add(sample_bug_reporter, (void *)(uintptr_t)NUM2INT(obj));
return Qnil;
};T;0To;
; F; ;
;;;I"Kernel#warn;F;[[@0;[[I" error.c;Ti5;T;: warn;0;[ ;{ ;IC;"Displays each of the given messages followed by a record separator on
STDERR unless warnings have been disabled (for example with the
-W0 flag).
warn("warning 1", "warning 2")
produces:
warning 1
warning 2
;T;[o;
; I"
overload;F; 0;;; 0; I"warn(msg, ...);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@;#[ ;$I"@return [nil];T;%0;"@;&0;'F;(i ;[[I"msg;T0[I"...;T0;"@;#[ ;$I"Displays each of the given messages followed by a record separator on
STDERR unless warnings have been disabled (for example with the
-W0 flag).
warn("warning 1", "warning 2")
produces:
warning 1
warning 2
@overload warn(msg, ...)
@return [nil];T;%0;"@;'F;)o;*;+T;,i%;-i2;.@
; I"static VALUE;T;/I"static VALUE
rb_warn_m(int argc, VALUE *argv, VALUE exc)
{
if (!NIL_P(ruby_verbose) && argc > 0) {
rb_io_puts(argc, argv, rb_stderr);
}
return Qnil;
};T;0T;N@
;OIC;[ ;N@
;PIC;[ ;N@
;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@uiH
[@uiT
;T;: Kernel;;X;;;[ ;{ ;IC;"FThe Kernel module is included by class Object, so its methods are
available in every Ruby object.
The Kernel instance methods are documented in class Object while the
module methods are documented here. These methods are called without a
receiver and thus can be called in functional form:
sprintf "%.1f", 1.234 #=> "1.2";T;[ ;#[ ;$I"I
The Kernel module is included by class Object, so its methods are
available in every Ruby object.
The Kernel instance methods are documented in class Object while the
module methods are documented here. These methods are called without a
receiver and thus can be called in functional form:
sprintf "%.1f", 1.234 #=> "1.2"
;T;%0;"@
;'F;(i ;)o;*;+T;,iH
;-iR
;.@;I" Kernel;F;N@N;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@ui
[@+i'[@ui5
;T;;^;;X;;;[ ;{ ;IC;"Object is the default root of all Ruby objects. Object inherits from
BasicObject which allows creating alternate object hierarchies. Methods
on Object are available to all classes unless explicitly overridden.
Object mixes in the Kernel module, making the built-in kernel functions
globally accessible. Although the instance methods of Object are defined
by the Kernel module, we have chosen to document them here for clarity.
When referencing constants in classes inheriting from Object you do not
need to use the full namespace. For example, referencing +File+ inside
+YourClass+ will find the top-level File class.
In the descriptions of Object's methods, the parameter symbol refers
to a symbol, which is either a quoted string or a Symbol (such as
:name).;T;[ ;#[ ;$I"
Object is the default root of all Ruby objects. Object inherits from
BasicObject which allows creating alternate object hierarchies. Methods
on Object are available to all classes unless explicitly overridden.
Object mixes in the Kernel module, making the built-in kernel functions
globally accessible. Although the instance methods of Object are defined
by the Kernel module, we have chosen to document them here for clarity.
When referencing constants in classes inheriting from Object you do not
need to use the full namespace. For example, referencing +File+ inside
+YourClass+ will find the top-level File class.
In the descriptions of Object's methods, the parameter symbol refers
to a symbol, which is either a quoted string or a Symbol (such as
:name).
;T;%0;"@N;'F;(i ;)o;*;+T;,i
;-i*
;.@;I" Object;F;Yo; ;IC;[o;
; F; ;
;;K;I"BasicObject#initialize;F;[ ;[[@ui;T;:initialize;0;[ ;{ ;IC;"Not documented
;T;[ ;#[ ;$I"Not documented
;T;%0;"@ ;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"9static VALUE
rb_obj_dummy(void)
{
return Qnil;
};T;0To;
; F; ;
;;;I"BasicObject#==;F;[[I" obj2;T0;[[@ui;T;;:;0;[ ;{ ;IC;"Equality --- At the Object level, == returns
true only if +obj+ and +other+ are the same object.
Typically, this method is overridden in descendant classes to provide
class-specific meaning.
Unlike ==, the equal? method should never be
overridden by subclasses as it is used to determine object identity
(that is, a.equal?(b) if and only if a is the
same object as b):
obj = "a"
other = obj.dup
obj == other #=> true
obj.equal? other #=> false
obj.equal? obj #=> true
The eql? method returns true if +obj+ and
+other+ refer to the same hash key. This is used by Hash to test members
for equality. For objects of class Object, eql?
is synonymous with ==. Subclasses normally continue this
tradition by aliasing eql? to their overridden ==
method, but there are exceptions. Numeric types, for
example, perform type conversion across ==, but not across
eql?, so:
1 == 1.0 #=> true
1.eql? 1.0 #=> false
;T;[o;
; I"
overload;F; 0;;:; 0; I"==(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[[I"
other;T0;"@o;
; I"
overload;F; 0;;r; 0; I"equal?(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[[I"
other;T0;"@o;
; I"
overload;F; 0;;q; 0; I"eql?(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[[I"
other;T0;"@;#[ ;$@(;%0;"@;'F;)o;*;+T;,ik;-i;.@
; I"
VALUE;T;/I"jVALUE
rb_obj_equal(VALUE obj1, VALUE obj2)
{
if (obj1 == obj2) return Qtrue;
return Qfalse;
};T;0To;
; F; ;
;;;I"BasicObject#equal?;F;[[I" obj2;T0;[[@ui;T;;r;0;[ ;{ ;IC;"Equality --- At the Object level, == returns
true only if +obj+ and +other+ are the same object.
Typically, this method is overridden in descendant classes to provide
class-specific meaning.
Unlike ==, the equal? method should never be
overridden by subclasses as it is used to determine object identity
(that is, a.equal?(b) if and only if a is the
same object as b):
obj = "a"
other = obj.dup
obj == other #=> true
obj.equal? other #=> false
obj.equal? obj #=> true
The eql? method returns true if +obj+ and
+other+ refer to the same hash key. This is used by Hash to test members
for equality. For objects of class Object, eql?
is synonymous with ==. Subclasses normally continue this
tradition by aliasing eql? to their overridden ==
method, but there are exceptions. Numeric types, for
example, perform type conversion across ==, but not across
eql?, so:
1 == 1.0 #=> true
1.eql? 1.0 #=> false
;T;[ o;
; I"
overload;F; 0;;:; 0; I"==(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@V;#[ ;$I"@return [Boolean];T;%0;"@V;&0;'F;(i ;[[I"
other;T0;"@Vo;
; I"
overload;F; 0;;r; 0; I"equal?(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@V;#[ ;$I"@return [Boolean];T;%0;"@V;&0;'F;(i ;[[I"
other;T0;"@Vo;
; I"
overload;F; 0;;q; 0; I"eql?(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@V;#[ ;$I"@return [Boolean];T;%0;"@V;&0;'F;(i ;[[I"
other;T0;"@Vo;!
; I" return;F; @;0; [@;"@V;#[ ;$@(;%0;"@V;'F;)o;*;+T;,ik;-i;.@
; I"
VALUE;T;/I"jVALUE
rb_obj_equal(VALUE obj1, VALUE obj2)
{
if (obj1 == obj2) return Qtrue;
return Qfalse;
};T;0To;
; F; ;
;;;I"BasicObject#!;F;[ ;[[@ui;T;:!;0;[ ;{ ;IC;"Boolean negate.
;T;[o;
; I"
overload;F; 0;;; 0; I" !obj;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"9Boolean negate.
@overload !obj
@return [Boolean];T;%0;"@;'F;)o;*;+T;,i;-i;.@
; I"
VALUE;T;/I"LVALUE
rb_obj_not(VALUE obj)
{
return RTEST(obj) ? Qfalse : Qtrue;
};T;0To;
; F; ;
;;;I"BasicObject#!=;F;[[I" obj2;T0;[[@ui;T;:!=;0;[ ;{ ;IC;"@Returns true if two objects are not-equal, otherwise false.
;T;[o;
; I"
overload;F; 0;;; 0; I"!=(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[[I"
other;T0;"@;#[ ;$I"jReturns true if two objects are not-equal, otherwise false.
@overload !=(other)
@return [Boolean];T;%0;"@;'F;)o;*;+T;,i;-i;.@
; I"
VALUE;T;/I"VALUE
rb_obj_not_equal(VALUE obj1, VALUE obj2)
{
VALUE result = rb_funcall(obj1, id_eq, 1, obj2);
return RTEST(result) ? Qfalse : Qtrue;
};T;0To;
; F; ;
;;K;I"'BasicObject#singleton_method_added;F;[ ;[[@ui;T;:singleton_method_added;0;[ ;{ ;IC;"Not documented
;T;[ ;#[ ;$@;%0;"@;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"9static VALUE
rb_obj_dummy(void)
{
return Qnil;
};T;0To;
; F; ;
;;K;I")BasicObject#singleton_method_removed;F;[ ;[[@ui;T;: singleton_method_removed;0;[ ;{ ;IC;"Not documented
;T;[ ;#[ ;$@;%0;"@;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"9static VALUE
rb_obj_dummy(void)
{
return Qnil;
};T;0To;
; F; ;
;;K;I"+BasicObject#singleton_method_undefined;F;[ ;[[@ui;T;: singleton_method_undefined;0;[ ;{ ;IC;"Not documented
;T;[ ;#[ ;$@;%0;"@;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"9static VALUE
rb_obj_dummy(void)
{
return Qnil;
};T;0To;
; F; ;
;;;I"BasicObject#__id__;F;[ ;[[@[
i ;T;: __id__;0;[ ;{ ;IC;"call-seq:
obj.__id__ -> integer
obj.object_id -> integer
Returns an integer identifier for +obj+.
The same number will be returned on all calls to +object_id+ for a given
object, and no two active objects will share an id.
Note: that some objects of builtin classes are reused for optimization.
This is the case for immediate values and frozen string literals.
Immediate values are not passed by reference but are passed by value:
+nil+, +true+, +false+, Fixnums, Symbols, and some Floats.
Object.new.object_id == Object.new.object_id # => false
(21 * 2).object_id == (21 * 2).object_id # => true
"hello".object_id == "hello".object_id # => false
"hi".freeze.object_id == "hi".freeze.object_id # => true
;T;[ ;#[ ;$@a
;%0;"@;'F;)o;*;+T;,i ;-i ;.@
; I"
VALUE;T;/I"HVALUE
rb_obj_id(VALUE obj)
{
/*
* 32-bit VALUE space
* MSB ------------------------ LSB
* false 00000000000000000000000000000000
* true 00000000000000000000000000000010
* nil 00000000000000000000000000000100
* undef 00000000000000000000000000000110
* symbol ssssssssssssssssssssssss00001110
* object oooooooooooooooooooooooooooooo00 = 0 (mod sizeof(RVALUE))
* fixnum fffffffffffffffffffffffffffffff1
*
* object_id space
* LSB
* false 00000000000000000000000000000000
* true 00000000000000000000000000000010
* nil 00000000000000000000000000000100
* undef 00000000000000000000000000000110
* symbol 000SSSSSSSSSSSSSSSSSSSSSSSSSSS0 S...S % A = 4 (S...S = s...s * A + 4)
* object oooooooooooooooooooooooooooooo0 o...o % A = 0
* fixnum fffffffffffffffffffffffffffffff1 bignum if required
*
* where A = sizeof(RVALUE)/4
*
* sizeof(RVALUE) is
* 20 if 32-bit, double is 4-byte aligned
* 24 if 32-bit, double is 8-byte aligned
* 40 if 64-bit
*/
if (STATIC_SYM_P(obj)) {
return (SYM2ID(obj) * sizeof(RVALUE) + (4 << 2)) | FIXNUM_FLAG;
}
else if (FLONUM_P(obj)) {
#if SIZEOF_LONG == SIZEOF_VOIDP
return LONG2NUM((SIGNED_VALUE)obj);
#else
return LL2NUM((SIGNED_VALUE)obj);
#endif
}
else if (SPECIAL_CONST_P(obj)) {
return LONG2NUM((SIGNED_VALUE)obj);
}
return nonspecial_obj_id(obj);
};T;0To;
; F; ;
;;;I" BasicObject#instance_eval;T;[[@0;[[@y
i;T;:instance_eval;0;[ ;{ ;IC;"Evaluates a string containing Ruby source code, or the given block,
within the context of the receiver (_obj_). In order to set the
context, the variable +self+ is set to _obj_ while
the code is executing, giving the code access to _obj_'s
instance variables and private methods.
When instance_eval is given a block, _obj_ is also
passed in as the block's only argument.
When instance_eval is given a +String+, the optional
second and third parameters supply a filename and starting line number
that are used when reporting compilation errors.
class KlassWithSecret
def initialize
@secret = 99
end
private
def the_secret
"Ssssh! The secret is #{@secret}."
end
end
k = KlassWithSecret.new
k.instance_eval { @secret } #=> 99
k.instance_eval { the_secret } #=> "Ssssh! The secret is 99."
k.instance_eval {|obj| obj == self } #=> true
;T;[o;
; I"
overload;F; 0;;; 0; I"3instance_eval(string [, filename [, lineno]] );T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@;#[ ;$I"@return [Object];T;%0;"@;&0;'F;(i ;[[I""string[, filename [, lineno]];T0;"@o;
; I"
overload;F; 0;;; 0; I"instance_eval;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@o;!
; I" return;F; I" ;T;0; [I" Object;T;"@;#[ ;$I""@yield [obj]
@return [Object];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"+Evaluates a string containing Ruby source code, or the given block,
within the context of the receiver (_obj_). In order to set the
context, the variable +self+ is set to _obj_ while
the code is executing, giving the code access to _obj_'s
instance variables and private methods.
When instance_eval is given a block, _obj_ is also
passed in as the block's only argument.
When instance_eval is given a +String+, the optional
second and third parameters supply a filename and starting line number
that are used when reporting compilation errors.
class KlassWithSecret
def initialize
@secret = 99
end
private
def the_secret
"Ssssh! The secret is #{@secret}."
end
end
k = KlassWithSecret.new
k.instance_eval { @secret } #=> 99
k.instance_eval { the_secret } #=> "Ssssh! The secret is 99."
k.instance_eval {|obj| obj == self } #=> true
@overload instance_eval(string [, filename [, lineno]] )
@return [Object]
@overload instance_eval
@yield [obj]
@return [Object];T;%0;"@;'F;)o;*;+T;,i;-i;.o;Z ;[0;\0;]0;:BasicObject;.@;_@
:
@type0; I"
VALUE;T;/I"VALUE
rb_obj_instance_eval(int argc, const VALUE *argv, VALUE self)
{
VALUE klass = singleton_class_for_eval(self);
return specific_eval(argc, argv, klass, self);
};T;0To;
; F; ;
;;;I" BasicObject#instance_exec;F;[[@0;[[@y
i;T;:instance_exec;0;[ ;{ ;IC;"Executes the given block within the context of the receiver
(_obj_). In order to set the context, the variable +self+ is set
to _obj_ while the code is executing, giving the code access to
_obj_'s instance variables. Arguments are passed as block parameters.
class KlassWithSecret
def initialize
@secret = 99
end
end
k = KlassWithSecret.new
k.instance_exec(5) {|x| @secret+x } #=> 104
;T;[o;
; I"
overload;F; 0;;; 0; I"instance_exec(arg...);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" var...;T;"@4o;!
; I" return;F; I" ;T;0; [I" Object;T;"@4;#[ ;$I"%@yield [var...]
@return [Object];T;%0;"@4;&0;'F;(i ;[[I" arg...;T0;"@4;#[ ;$I"Executes the given block within the context of the receiver
(_obj_). In order to set the context, the variable +self+ is set
to _obj_ while the code is executing, giving the code access to
_obj_'s instance variables. Arguments are passed as block parameters.
class KlassWithSecret
def initialize
@secret = 99
end
end
k = KlassWithSecret.new
k.instance_exec(5) {|x| @secret+x } #=> 104
@overload instance_exec(arg...)
@yield [var...]
@return [Object];T;%0;"@4;'F;)o;*;+T;,i;-i;.@
; I"
VALUE;T;/I"VALUE
rb_obj_instance_exec(int argc, const VALUE *argv, VALUE self)
{
VALUE klass = singleton_class_for_eval(self);
return yield_under(klass, self, rb_ary_new4(argc, argv));
};T;0To;
; F; ;
;;K;I" BasicObject#method_missing;F;[[@0;[[@y
i;T;:method_missing;0;[ ;{ ;IC;"zInvoked by Ruby when obj is sent a message it cannot handle.
symbol is the symbol for the method called, and args
are any arguments that were passed to it. By default, the interpreter
raises an error when this method is called. However, it is possible
to override the method to provide more dynamic behavior.
If it is decided that a particular method should not be handled, then
super should be called, so that ancestors can pick up the
missing method.
The example below creates
a class Roman, which responds to methods with names
consisting of roman numerals, returning the corresponding integer
values.
class Roman
def roman_to_int(str)
# ...
end
def method_missing(methId)
str = methId.id2name
roman_to_int(str)
end
end
r = Roman.new
r.iv #=> 4
r.xxiii #=> 23
r.mm #=> 2000
;T;[o;
; I"
overload;F; 0;;; 0; I"&method_missing(symbol [, *args] );T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@W;&0;'F;(i ;[[I"symbol[, *args];T0;"@W;#[ ;$I"Invoked by Ruby when obj is sent a message it cannot handle.
symbol is the symbol for the method called, and args
are any arguments that were passed to it. By default, the interpreter
raises an error when this method is called. However, it is possible
to override the method to provide more dynamic behavior.
If it is decided that a particular method should not be handled, then
super should be called, so that ancestors can pick up the
missing method.
The example below creates
a class Roman, which responds to methods with names
consisting of roman numerals, returning the corresponding integer
values.
class Roman
def roman_to_int(str)
# ...
end
def method_missing(methId)
str = methId.id2name
roman_to_int(str)
end
end
r = Roman.new
r.iv #=> 4
r.xxiii #=> 23
r.mm #=> 2000
@overload method_missing(symbol [, *args] );T;%0;"@W;'F;)o;*;+T;,i;-i;.@
; I"static VALUE;T;/I"static VALUE
rb_method_missing(int argc, const VALUE *argv, VALUE obj)
{
rb_thread_t *th = GET_THREAD();
raise_method_missing(th, argc, argv, obj, th->method_missing_reason);
UNREACHABLE;
};T;0To;
; F; ;
;;;I"BasicObject#__send__;F;[[@0;[[@k
iY;T;:
__send__;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@p;.@
; I"static VALUE;T;/I"static VALUE
rb_f_send(int argc, VALUE *argv, VALUE recv)
{
VALUE sym = argv[0];
ID vid = rb_check_id(&sym);
if (vid) {
--argc;
++argv;
}
else {
vid = id___send__;
}
return rb_funcallv(recv, vid, argc, argv);
};T;0T;N@
;OIC;[ ;N@
;PIC;[ ;N@
;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@ui [@+i&[@ui4
;T;;;;X;;;[ ;{ ;IC;"BasicObject is the parent class of all classes in Ruby. It's an explicit
blank class.
BasicObject can be used for creating object hierarchies independent of
Ruby's object hierarchy, proxy objects like the Delegator class, or other
uses where namespace pollution from Ruby's methods and classes must be
avoided.
To avoid polluting BasicObject for other users an appropriately named
subclass of BasicObject should be created instead of directly modifying
BasicObject:
class MyObjectSystem < BasicObject
end
BasicObject does not include Kernel (for methods like +puts+) and
BasicObject is outside of the namespace of the standard library so common
classes will not be found without using a full class path.
A variety of strategies can be used to provide useful portions of the
standard library to subclasses of BasicObject. A subclass could
include Kernel to obtain +puts+, +exit+, etc. A custom
Kernel-like module could be created and included or delegation can be used
via #method_missing:
class MyObjectSystem < BasicObject
DELEGATE = [:puts, :p]
def method_missing(name, *args, &block)
super unless DELEGATE.include? name
::Kernel.send(name, *args, &block)
end
def respond_to_missing?(name, include_private = false)
DELEGATE.include?(name) or super
end
end
Access to classes and modules from the Ruby standard library can be
obtained in a BasicObject subclass by referencing the desired constant
from the root like ::File or ::Enumerator.
Like #method_missing, #const_missing can be used to delegate constant
lookup to +Object+:
class MyObjectSystem < BasicObject
def self.const_missing(name)
::Object.const_get(name)
end
end;T;[ ;#[ ;$I"
BasicObject is the parent class of all classes in Ruby. It's an explicit
blank class.
BasicObject can be used for creating object hierarchies independent of
Ruby's object hierarchy, proxy objects like the Delegator class, or other
uses where namespace pollution from Ruby's methods and classes must be
avoided.
To avoid polluting BasicObject for other users an appropriately named
subclass of BasicObject should be created instead of directly modifying
BasicObject:
class MyObjectSystem < BasicObject
end
BasicObject does not include Kernel (for methods like +puts+) and
BasicObject is outside of the namespace of the standard library so common
classes will not be found without using a full class path.
A variety of strategies can be used to provide useful portions of the
standard library to subclasses of BasicObject. A subclass could
include Kernel to obtain +puts+, +exit+, etc. A custom
Kernel-like module could be created and included or delegation can be used
via #method_missing:
class MyObjectSystem < BasicObject
DELEGATE = [:puts, :p]
def method_missing(name, *args, &block)
super unless DELEGATE.include? name
::Kernel.send(name, *args, &block)
end
def respond_to_missing?(name, include_private = false)
DELEGATE.include?(name) or super
end
end
Access to classes and modules from the Ruby standard library can be
obtained in a BasicObject subclass by referencing the desired constant
from the root like ::File or ::Enumerator.
Like #method_missing, #const_missing can be used to delegate constant
lookup to +Object+:
class MyObjectSystem < BasicObject
def self.const_missing(name)
::Object.const_get(name)
end
end
;T;%0;"@
;'F;(i ;)o;*;+T;,i ;-i
;.@;I"BasicObject;F;Yo;Z ;[0;\0;]0;: Qnil;.@;_0;;S;;S;N@;OIC;[ ;N@;PIC;[ ;N@;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i ;F;;;;X;;;[ ;{ ;IC;"DA rational number can be represented as a paired integer number;
a/b (b>0). Where a is numerator and b is denominator. Integer a
equals rational a/1 mathematically.
In ruby, you can create rational object with Rational, to_r,
rationalize method or suffixing r to a literal. The return values will be irreducible.
Rational(1) #=> (1/1)
Rational(2, 3) #=> (2/3)
Rational(4, -6) #=> (-2/3)
3.to_r #=> (3/1)
2/3r #=> (2/3)
You can also create rational object from floating-point numbers or
strings.
Rational(0.3) #=> (5404319552844595/18014398509481984)
Rational('0.3') #=> (3/10)
Rational('2/3') #=> (2/3)
0.3.to_r #=> (5404319552844595/18014398509481984)
'0.3'.to_r #=> (3/10)
'2/3'.to_r #=> (2/3)
0.3.rationalize #=> (3/10)
A rational object is an exact number, which helps you to write
program without any rounding errors.
10.times.inject(0){|t,| t + 0.1} #=> 0.9999999999999999
10.times.inject(0){|t,| t + Rational('0.1')} #=> (1/1)
However, when an expression has inexact factor (numerical value or
operation), will produce an inexact result.
Rational(10) / 3 #=> (10/3)
Rational(10) / 3.0 #=> 3.3333333333333335
Rational(-8) ** Rational(1, 3)
#=> (1.0000000000000002+1.7320508075688772i)
;T;[ ;#[ ;$I"EA rational number can be represented as a paired integer number;
a/b (b>0). Where a is numerator and b is denominator. Integer a
equals rational a/1 mathematically.
In ruby, you can create rational object with Rational, to_r,
rationalize method or suffixing r to a literal. The return values will be irreducible.
Rational(1) #=> (1/1)
Rational(2, 3) #=> (2/3)
Rational(4, -6) #=> (-2/3)
3.to_r #=> (3/1)
2/3r #=> (2/3)
You can also create rational object from floating-point numbers or
strings.
Rational(0.3) #=> (5404319552844595/18014398509481984)
Rational('0.3') #=> (3/10)
Rational('2/3') #=> (2/3)
0.3.to_r #=> (5404319552844595/18014398509481984)
'0.3'.to_r #=> (3/10)
'2/3'.to_r #=> (2/3)
0.3.rationalize #=> (3/10)
A rational object is an exact number, which helps you to write
program without any rounding errors.
10.times.inject(0){|t,| t + 0.1} #=> 0.9999999999999999
10.times.inject(0){|t,| t + Rational('0.1')} #=> (1/1)
However, when an expression has inexact factor (numerical value or
operation), will produce an inexact result.
Rational(10) / 3 #=> (10/3)
Rational(10) / 3.0 #=> 3.3333333333333335
Rational(-8) ** Rational(1, 3)
#=> (1.0000000000000002+1.7320508075688772i)
;T;%0;"@;'F;)o;*;+T;,i ;-i ;.@;I"
Rational;F;Yo;Z ;[0;\0;]0;: Numeric;.@;_o; ;IC;[1o;
; F; ;
;;;I"Numeric#numerator;F;[ ;[[@i;T;;;0;[ ;{ ;IC;"Returns the numerator.
;T;[o;
; I"
overload;F; 0;;; 0; I"numerator;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@;#[ ;$I"@return [Integer];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"EReturns the numerator.
@overload numerator
@return [Integer];T;%0;"@;'F;)o;*;+T;,i ;-i
;.@; I"static VALUE;T;/I"Ystatic VALUE
numeric_numerator(VALUE self)
{
return f_numerator(f_to_r(self));
};T;0To;
; F; ;
;;;I"Numeric#denominator;F;[ ;[[@i;T;;1;0;[ ;{ ;IC;"/Returns the denominator (always positive).
;T;[o;
; I"
overload;F; 0;;1; 0; I"denominator;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@;#[ ;$I"@return [Integer];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"[Returns the denominator (always positive).
@overload denominator
@return [Integer];T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"]static VALUE
numeric_denominator(VALUE self)
{
return f_denominator(f_to_r(self));
};T;0To;
; F; ;
;;;I"Numeric#quo;F;[[I"y;T0;[[@i*;T;;6;0;[ ;{ ;IC;"KReturns most exact division (rational for integers, float for floats).
;T;[o;
; I"
overload;F; 0;;6; 0; I"quo(int_or_rat);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[[I"int_or_rat;T0;"@o;
; I"
overload;F; 0;;6; 0; I"
quo(flo);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[[I"flo;T0;"@;#[ ;$I"zReturns most exact division (rational for integers, float for floats).
@overload quo(int_or_rat)
@overload quo(flo);T;%0;"@;'F;)o;*;+T;,i";-i&;.@; I"static VALUE;T;/I"Dstatic VALUE
numeric_quo(VALUE x, VALUE y)
{
if (RB_TYPE_P(y, T_FLOAT)) {
return f_fdiv(x, y);
}
#ifdef CANON
if (canonicalization) {
x = rb_rational_raw1(x);
}
else
#endif
{
x = rb_convert_type(x, T_RATIONAL, "Rational", "to_r");
}
return rb_funcall(x, '/', 1, y);
};T;0To;
; F; ;
;;;I"#Numeric#singleton_method_added;F;[[I" name;T0;[[I"numeric.c;TiQ;T;;;0;[ ;{ ;IC;"Trap attempts to add methods to Numeric objects. Always raises a TypeError.
Numerics should be values; singleton_methods should not be added to them.
;T;[ ;#[ ;$I"Trap attempts to add methods to Numeric objects. Always raises a TypeError.
Numerics should be values; singleton_methods should not be added to them.
;T;%0;"@;'F;)o;*;+T;,iK;-iN;.@; I"static VALUE;T;/I"{static VALUE
num_sadded(VALUE x, VALUE name)
{
ID mid = rb_to_id(name);
/* ruby_frame = ruby_frame->prev; */ /* pop frame for "singleton_method_added" */
rb_remove_method_id(rb_singleton_class(x), mid);
rb_raise(rb_eTypeError,
"can't define singleton method \"%"PRIsVALUE"\" for %"PRIsVALUE,
rb_id2str(mid),
rb_obj_class(x));
UNREACHABLE;
};T;0To;
; F; ;
;;;I" Numeric#initialize_copy;F;[[I"y;T0;[[@id;T;;w;0;[ ;{ ;IC;"Numerics are immutable values, which should not be copied.
Any attempt to use this method on a Numeric will raise a TypeError.
;T;[ ;#[ ;$I"Numerics are immutable values, which should not be copied.
Any attempt to use this method on a Numeric will raise a TypeError.
;T;%0;"@;'F;)o;*;+T;,i_;-ib;.@; I"static VALUE;T;/I"static VALUE
num_init_copy(VALUE x, VALUE y)
{
rb_raise(rb_eTypeError, "can't copy %"PRIsVALUE, rb_obj_class(x));
UNREACHABLE;
};T;0To;
; F; ;
;;;I"Numeric#coerce;F;[[I"y;T0;[[@i;T;;;;0;[ ;{ ;IC;"If a +numeric+ is the same type as +num+, returns an array containing
+numeric+ and +num+. Otherwise, returns an array with both a +numeric+ and
+num+ represented as Float objects.
This coercion mechanism is used by Ruby to handle mixed-type numeric
operations: it is intended to find a compatible common type between the two
operands of the operator.
1.coerce(2.5) #=> [2.5, 1.0]
1.2.coerce(3) #=> [3.0, 1.2]
1.coerce(2) #=> [2, 1]
;T;[o;
; I"
overload;F; 0;;;; 0; I"coerce(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@ ;#[ ;$I"@return [Array];T;%0;"@ ;&0;'F;(i ;[[I" numeric;T0;"@ ;#[ ;$I"If a +numeric+ is the same type as +num+, returns an array containing
+numeric+ and +num+. Otherwise, returns an array with both a +numeric+ and
+num+ represented as Float objects.
This coercion mechanism is used by Ruby to handle mixed-type numeric
operations: it is intended to find a compatible common type between the two
operands of the operator.
1.coerce(2.5) #=> [2.5, 1.0]
1.2.coerce(3) #=> [3.0, 1.2]
1.coerce(2) #=> [2, 1]
@overload coerce(numeric)
@return [Array];T;%0;"@ ;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"static VALUE
num_coerce(VALUE x, VALUE y)
{
if (CLASS_OF(x) == CLASS_OF(y))
return rb_assoc_new(y, x);
x = rb_Float(x);
y = rb_Float(y);
return rb_assoc_new(y, x);
};T;0To;
; F; ;
;;;I"Numeric#i;F;[ ;[[@i;T;:i;0;[ ;{ ;IC;"SReturns the corresponding imaginary number.
Not available for complex numbers.
;T;[o;
; I"
overload;F; 0;;; 0; I"i;T;IC;" ;T;[o;!
; I" return;F; I"Complex(0];T;0; [I"Complex(0];T;"@?;#[ ;$I"@return [ Complex(0];T;%0;"@?;&0;'F;(i ;[ ;"@?;#[ ;$I"xReturns the corresponding imaginary number.
Not available for complex numbers.
@overload i
@return [ Complex(0];T;%0;"@?;'F;)o;*;+T;,iy;-i~;.@; I"static VALUE;T;/I"Zstatic VALUE
num_imaginary(VALUE num)
{
return rb_complex_new(INT2FIX(0), num);
};T;0To;
; F; ;
;;;I"Numeric#+@;F;[ ;[[@is;T;:+@;0;[ ;{ ;IC;"/Unary Plus---Returns the receiver's value.
;T;[o;
; I"
overload;F; 0;;2; 0; I" +num;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Numeric;T;"@Z;#[ ;$I"@return [Numeric];T;%0;"@Z;&0;'F;(i ;[ ;"@Z;#[ ;$I"TUnary Plus---Returns the receiver's value.
@overload +num
@return [Numeric];T;%0;"@Z;'F;)o;*;+T;,il;-ip;.@; I"static VALUE;T;/I":static VALUE
num_uplus(VALUE num)
{
return num;
};T;0To;
; F; ;
;;;I"Numeric#-@;F;[ ;[[@i;T;:-@;0;[ ;{ ;IC;"9Unary Minus---Returns the receiver's value, negated.
;T;[o;
; I"
overload;F; 0;;3; 0; I" -num;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Numeric;T;"@u;#[ ;$I"@return [Numeric];T;%0;"@u;&0;'F;(i ;[ ;"@u;#[ ;$I"^Unary Minus---Returns the receiver's value, negated.
@overload -num
@return [Numeric];T;%0;"@u;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"static VALUE
num_uminus(VALUE num)
{
VALUE zero;
zero = INT2FIX(0);
do_coerce(&zero, &num, TRUE);
return rb_funcall(zero, '-', 1, num);
};T;0To;
; F; ;
;;;I"Numeric#<=>;F;[[I"y;T0;[[@i];T;;9;0;[ ;{ ;IC;"mReturns zero if +number+ equals +other+, otherwise +nil+ is returned if the
two values are incomparable.
;T;[o;
; I"
overload;F; 0;;9; 0; I"<=>(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"nil;T;"@;#[ ;$I"@return [ 0, nil];T;%0;"@;&0;'F;(i ;[[I"
other;T0;"@;#[ ;$I"Returns zero if +number+ equals +other+, otherwise +nil+ is returned if the
two values are incomparable.
@overload <=>(other)
@return [ 0, nil];T;%0;"@;'F;)o;*;+T;,iU;-iZ;.@; I"static VALUE;T;/I"cstatic VALUE
num_cmp(VALUE x, VALUE y)
{
if (x == y) return INT2FIX(0);
return Qnil;
};T;0To;
; F; ;
;;;I"Numeric#eql?;F;[[I"y;T0;[[@iM;T;;q;0;[ ;{ ;IC;"Returns +true+ if +num+ and +numeric+ are the same type and have equal
values.
1 == 1.0 #=> true
1.eql?(1.0) #=> false
(1.0).eql?(1.0) #=> true
;T;[o;
; I"
overload;F; 0;;q; 0; I"eql?(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[[I" numeric;T0;"@o;!
; I" return;F; @;0; [@;"@;#[ ;$I"Returns +true+ if +num+ and +numeric+ are the same type and have equal
values.
1 == 1.0 #=> true
1.eql?(1.0) #=> false
(1.0).eql?(1.0) #=> true
@overload eql?(numeric)
@return [Boolean];T;%0;"@;'F;)o;*;+T;,iA;-iJ;.@; I"static VALUE;T;/I"vstatic VALUE
num_eql(VALUE x, VALUE y)
{
if (TYPE(x) != TYPE(y)) return Qfalse;
return rb_equal(x, y);
};T;0To;
; F; ;
;;;I"Numeric#fdiv;F;[[I"y;T0;[[@i;T;;7;0;[ ;{ ;IC;" Returns float division.
;T;[o;
; I"
overload;F; 0;;7; 0; I"fdiv(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@;#[ ;$I"@return [Float];T;%0;"@;&0;'F;(i ;[[I" numeric;T0;"@;#[ ;$I"HReturns float division.
@overload fdiv(numeric)
@return [Float];T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"_static VALUE
num_fdiv(VALUE x, VALUE y)
{
return rb_funcall(rb_Float(x), '/', 1, y);
};T;0To;
; F; ;
;;;I"Numeric#div;F;[[I"y;T0;[[@i;T;:div;0;[ ;{ ;IC;"Uses +/+ to perform division, then converts the result to an integer.
+numeric+ does not define the +/+ operator; this is left to subclasses.
Equivalent to num.divmod(numeric)[0].
See Numeric#divmod.
;T;[o;
; I"
overload;F; 0;;; 0; I"div(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@;#[ ;$I"@return [Integer];T;%0;"@;&0;'F;(i ;[[I" numeric;T0;"@;#[ ;$I"Uses +/+ to perform division, then converts the result to an integer.
+numeric+ does not define the +/+ operator; this is left to subclasses.
Equivalent to num.divmod(numeric)[0].
See Numeric#divmod.
@overload div(numeric)
@return [Integer];T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"static VALUE
num_div(VALUE x, VALUE y)
{
if (rb_equal(INT2FIX(0), y)) rb_num_zerodiv();
return rb_funcall(rb_funcall(x, '/', 1, y), rb_intern("floor"), 0);
};T;0To;
; F; ;
;;;I"Numeric#divmod;F;[[I"y;T0;[[@i;T;: divmod;0;[ ;{ ;IC;"3Returns an array containing the quotient and modulus obtained by dividing
+num+ by +numeric+.
If q, r = * x.divmod(y), then
q = floor(x/y)
x = q*y+r
The quotient is rounded toward -infinity, as shown in the following table:
a | b | a.divmod(b) | a/b | a.modulo(b) | a.remainder(b)
------+-----+---------------+---------+-------------+---------------
13 | 4 | 3, 1 | 3 | 1 | 1
------+-----+---------------+---------+-------------+---------------
13 | -4 | -4, -3 | -4 | -3 | 1
------+-----+---------------+---------+-------------+---------------
-13 | 4 | -4, 3 | -4 | 3 | -1
------+-----+---------------+---------+-------------+---------------
-13 | -4 | 3, -1 | 3 | -1 | -1
------+-----+---------------+---------+-------------+---------------
11.5 | 4 | 2, 3.5 | 2.875 | 3.5 | 3.5
------+-----+---------------+---------+-------------+---------------
11.5 | -4 | -3, -0.5 | -2.875 | -0.5 | 3.5
------+-----+---------------+---------+-------------+---------------
-11.5 | 4 | -3, 0.5 | -2.875 | 0.5 | -3.5
------+-----+---------------+---------+-------------+---------------
-11.5 | -4 | 2, -3.5 | 2.875 | -3.5 | -3.5
Examples
11.divmod(3) #=> [3, 2]
11.divmod(-3) #=> [-4, -1]
11.divmod(3.5) #=> [3, 0.5]
(-11).divmod(3.5) #=> [-4, 3.0]
(11.5).divmod(3.5) #=> [3, 1.0]
;T;[o;
; I"
overload;F; 0;;; 0; I"divmod(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@;#[ ;$I"@return [Array];T;%0;"@;&0;'F;(i ;[[I" numeric;T0;"@;#[ ;$I"aReturns an array containing the quotient and modulus obtained by dividing
+num+ by +numeric+.
If q, r = * x.divmod(y), then
q = floor(x/y)
x = q*y+r
The quotient is rounded toward -infinity, as shown in the following table:
a | b | a.divmod(b) | a/b | a.modulo(b) | a.remainder(b)
------+-----+---------------+---------+-------------+---------------
13 | 4 | 3, 1 | 3 | 1 | 1
------+-----+---------------+---------+-------------+---------------
13 | -4 | -4, -3 | -4 | -3 | 1
------+-----+---------------+---------+-------------+---------------
-13 | 4 | -4, 3 | -4 | 3 | -1
------+-----+---------------+---------+-------------+---------------
-13 | -4 | 3, -1 | 3 | -1 | -1
------+-----+---------------+---------+-------------+---------------
11.5 | 4 | 2, 3.5 | 2.875 | 3.5 | 3.5
------+-----+---------------+---------+-------------+---------------
11.5 | -4 | -3, -0.5 | -2.875 | -0.5 | 3.5
------+-----+---------------+---------+-------------+---------------
-11.5 | 4 | -3, 0.5 | -2.875 | 0.5 | -3.5
------+-----+---------------+---------+-------------+---------------
-11.5 | -4 | 2, -3.5 | 2.875 | -3.5 | -3.5
Examples
11.divmod(3) #=> [3, 2]
11.divmod(-3) #=> [-4, -1]
11.divmod(3.5) #=> [3, 0.5]
(-11).divmod(3.5) #=> [-4, 3.0]
(11.5).divmod(3.5) #=> [3, 1.0]
@overload divmod(numeric)
@return [Array];T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"lstatic VALUE
num_divmod(VALUE x, VALUE y)
{
return rb_assoc_new(num_div(x, y), num_modulo(x, y));
};T;0To;
; F; ;
;;;I"Numeric#%;F;[[I"y;T0;[[@i;T;:%;0;[ ;{ ;IC;"ox.modulo(y) means x-y*(x/y).floor
Equivalent to num.divmod(numeric)[1].
See Numeric#divmod.
;T;[o;
; I"
overload;F; 0;: modulo; 0; I"modulo(numeric);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@/;&0;'F;(i ;[[I" numeric;T0;"@/;#[ ;$I" x.modulo(y) means x-y*(x/y).floor
Equivalent to num.divmod(numeric)[1].
See Numeric#divmod.
@overload modulo(numeric);T;%0;"@/;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"static VALUE
num_modulo(VALUE x, VALUE y)
{
return rb_funcall(x, '-', 1,
rb_funcall(y, '*', 1,
rb_funcall(x, id_div, 1, y)));
};T;0To;
; F; ;
;;;I"Numeric#modulo;F;[[I"y;T0;[[@i;T;;;0;[ ;{ ;IC;"ox.modulo(y) means x-y*(x/y).floor
Equivalent to num.divmod(numeric)[1].
See Numeric#divmod.
;T;[o;
; I"
overload;F; 0;;; 0; I"modulo(numeric);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@I;&0;'F;(i ;[[I" numeric;T0;"@I;#[ ;$@E;%0;"@I;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"static VALUE
num_modulo(VALUE x, VALUE y)
{
return rb_funcall(x, '-', 1,
rb_funcall(y, '*', 1,
rb_funcall(x, id_div, 1, y)));
};T;0To;
; F; ;
;;;I"Numeric#remainder;F;[[I"y;T0;[[@i;T;:remainder;0;[ ;{ ;IC;"Ax.remainder(y) means x-y*(x/y).truncate
See Numeric#divmod.
;T;[o;
; I"
overload;F; 0;;; 0; I"remainder(numeric);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@b;&0;'F;(i ;[[I" numeric;T0;"@b;#[ ;$I"c x.remainder(y) means x-y*(x/y).truncate
See Numeric#divmod.
@overload remainder(numeric);T;%0;"@b;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"static VALUE
num_remainder(VALUE x, VALUE y)
{
VALUE z = rb_funcall(x, '%', 1, y);
if ((!rb_equal(z, INT2FIX(0))) &&
((negative_int_p(x) &&
positive_int_p(y)) ||
(positive_int_p(x) &&
negative_int_p(y)))) {
return rb_funcall(z, '-', 1, y);
}
return z;
};T;0To;
; F; ;
;;;I"Numeric#abs;F;[ ;[[@iB;T;:abs;0;[ ;{ ;IC;"Returns the absolute value of +num+.
12.abs #=> 12
(-34.56).abs #=> 34.56
-34.56.abs #=> 34.56
Numeric#magnitude is an alias of Numeric#abs.
;T;[o;
; I"
overload;F; 0;;; 0; I"abs;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Numeric;T;"@|;#[ ;$I"@return [Numeric];T;%0;"@|;&0;'F;(i ;[ ;"@|o;
; I"
overload;F; 0;:magnitude; 0; I"magnitude;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Numeric;T;"@|;#[ ;$I"@return [Numeric];T;%0;"@|;&0;'F;(i ;[ ;"@|;#[ ;$I"Returns the absolute value of +num+.
12.abs #=> 12
(-34.56).abs #=> 34.56
-34.56.abs #=> 34.56
Numeric#magnitude is an alias of Numeric#abs.
@overload abs
@return [Numeric]
@overload magnitude
@return [Numeric];T;%0;"@|;'F;)o;*;+T;,i4;-i@;.@; I"static VALUE;T;/I"~static VALUE
num_abs(VALUE num)
{
if (negative_int_p(num)) {
return rb_funcall(num, idUMinus, 0);
}
return num;
};T;0To;
; F; ;
;;;I"Numeric#magnitude;F;[ ;[[@iB;T;;;0;[ ;{ ;IC;"Returns the absolute value of +num+.
12.abs #=> 12
(-34.56).abs #=> 34.56
-34.56.abs #=> 34.56
Numeric#magnitude is an alias of Numeric#abs.
;T;[o;
; I"
overload;F; 0;;; 0; I"abs;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Numeric;T;"@;#[ ;$I"@return [Numeric];T;%0;"@;&0;'F;(i ;[ ;"@o;
; I"
overload;F; 0;;; 0; I"magnitude;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Numeric;T;"@;#[ ;$I"@return [Numeric];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$@;%0;"@;'F;)o;*;+T;,i4;-i@;.@; I"static VALUE;T;/I"~static VALUE
num_abs(VALUE num)
{
if (negative_int_p(num)) {
return rb_funcall(num, idUMinus, 0);
}
return num;
};T;0To;
; F; ;
;;;I"Numeric#to_int;F;[ ;[[@i~;T;: to_int;0;[ ;{ ;IC;"Invokes the child class's +to_i+ method to convert +num+ to an integer.
1.0.class => Float
1.0.to_int.class => Fixnum
1.0.to_i.class => Fixnum
;T;[o;
; I"
overload;F; 0;;; 0; I" to_int;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@;#[ ;$I"@return [Integer];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"Invokes the child class's +to_i+ method to convert +num+ to an integer.
1.0.class => Float
1.0.to_int.class => Fixnum
1.0.to_i.class => Fixnum
@overload to_int
@return [Integer];T;%0;"@;'F;)o;*;+T;,is;-i{;.@; I"static VALUE;T;/I"Wstatic VALUE
num_to_int(VALUE num)
{
return rb_funcallv(num, id_to_i, 0, 0);
};T;0To;
; F; ;
;;;I"Numeric#real?;F;[ ;[[@i ;T;:
real?;0;[ ;{ ;IC;"BReturns +true+ if +num+ is a Real number. (i.e. not Complex).
;T;[o;
; I"
overload;F; 0;;; 0; I"
real?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[ ;"@o;!
; I" return;F; @;0; [@;"@;#[ ;$I"hReturns +true+ if +num+ is a Real number. (i.e. not Complex).
@overload real?
@return [Boolean];T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"=static VALUE
num_real_p(VALUE num)
{
return Qtrue;
};T;0To;
; F; ;
;;;I"Numeric#integer?;F;[ ;[[@i.;T;:
integer?;0;[ ;{ ;IC;"~Returns +true+ if +num+ is an Integer (including Fixnum and Bignum).
(1.0).integer? #=> false
(1).integer? #=> true
;T;[o;
; I"
overload;F; 0;;; 0; I"
integer?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[ ;"@o;!
; I" return;F; @;0; [@;"@;#[ ;$I"Returns +true+ if +num+ is an Integer (including Fixnum and Bignum).
(1.0).integer? #=> false
(1).integer? #=> true
@overload integer?
@return [Boolean];T;%0;"@;'F;)o;*;+T;,i$;-i+;.@; I"static VALUE;T;/I"=static VALUE
num_int_p(VALUE num)
{
return Qfalse;
};T;0To;
; F; ;
;;;I"Numeric#zero?;F;[ ;[[@iS;T;:
zero?;0;[ ;{ ;IC;".Returns +true+ if +num+ has a zero value.
;T;[o;
; I"
overload;F; 0;;; 0; I"
zero?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@";#[ ;$I"@return [Boolean];T;%0;"@";&0;'F;(i ;[ ;"@"o;!
; I" return;F; @;0; [@;"@";#[ ;$I"TReturns +true+ if +num+ has a zero value.
@overload zero?
@return [Boolean];T;%0;"@";'F;)o;*;+T;,iL;-iP;.@; I"static VALUE;T;/I"xstatic VALUE
num_zero_p(VALUE num)
{
if (rb_equal(num, INT2FIX(0))) {
return Qtrue;
}
return Qfalse;
};T;0To;
; F; ;
;;;I"Numeric#nonzero?;F;[ ;[[@ij;T;:
nonzero?;0;[ ;{ ;IC;" Returns +self+ if +num+ is not zero, +nil+ otherwise.
This behavior is useful when chaining comparisons:
a = %w( z Bb bB bb BB a aA Aa AA A )
b = a.sort {|a,b| (a.downcase <=> b.downcase).nonzero? || a <=> b }
b #=> ["A", "a", "AA", "Aa", "aA", "BB", "Bb", "bB", "bb", "z"]
;T;[o;
; I"
overload;F; 0;;; 0; I"
nonzero?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" self;TI"nil;T;"@@;#[ ;$I"@return [self, nil];T;%0;"@@;&0;'F;(i ;[ ;"@@o;!
; I" return;F; @;0; [@;"@@;#[ ;$I"IReturns +self+ if +num+ is not zero, +nil+ otherwise.
This behavior is useful when chaining comparisons:
a = %w( z Bb bB bb BB a aA Aa AA A )
b = a.sort {|a,b| (a.downcase <=> b.downcase).nonzero? || a <=> b }
b #=> ["A", "a", "AA", "Aa", "aA", "BB", "Bb", "bB", "bb", "z"]
@overload nonzero?
@return [self, nil];T;%0;"@@;'F;)o;*;+T;,i];-ig;.@; I"static VALUE;T;/I"static VALUE
num_nonzero_p(VALUE num)
{
if (RTEST(rb_funcallv(num, rb_intern("zero?"), 0, 0))) {
return Qnil;
}
return num;
};T;0To;
; F; ;
;;;I"Numeric#floor;F;[ ;[[@in;T;;@;0;[ ;{ ;IC;"Returns the largest integer less than or equal to +num+.
Numeric implements this by converting an Integer to a Float and invoking
Float#floor.
1.floor #=> 1
(-1).floor #=> -1
;T;[o;
; I"
overload;F; 0;;@; 0; I"
floor;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@_;#[ ;$I"@return [Integer];T;%0;"@_;&0;'F;(i ;[ ;"@_;#[ ;$I"Returns the largest integer less than or equal to +num+.
Numeric implements this by converting an Integer to a Float and invoking
Float#floor.
1.floor #=> 1
(-1).floor #=> -1
@overload floor
@return [Integer];T;%0;"@_;'F;)o;*;+T;,ia;-ik;.@; I"static VALUE;T;/I"Ostatic VALUE
num_floor(VALUE num)
{
return flo_floor(rb_Float(num));
};T;0To;
; F; ;
;;;I"Numeric#ceil;F;[ ;[[@i;T;;A;0;[ ;{ ;IC;"Returns the smallest possible Integer that is greater than or equal to
+num+.
Numeric achieves this by converting itself to a Float then invoking
Float#ceil.
1.ceil #=> 1
1.2.ceil #=> 2
(-1.2).ceil #=> -1
(-1.0).ceil #=> -1
;T;[o;
; I"
overload;F; 0;;A; 0; I" ceil;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@z;#[ ;$I"@return [Integer];T;%0;"@z;&0;'F;(i ;[ ;"@z;#[ ;$I""Returns the smallest possible Integer that is greater than or equal to
+num+.
Numeric achieves this by converting itself to a Float then invoking
Float#ceil.
1.ceil #=> 1
1.2.ceil #=> 2
(-1.2).ceil #=> -1
(-1.0).ceil #=> -1
@overload ceil
@return [Integer];T;%0;"@z;'F;)o;*;+T;,iu;-i;.@; I"static VALUE;T;/I"Mstatic VALUE
num_ceil(VALUE num)
{
return flo_ceil(rb_Float(num));
};T;0To;
; F; ;
;;;I"Numeric#round;F;[[@0;[[@i;T;;C;0;[ ;{ ;IC;"Rounds +num+ to a given precision in decimal digits (default 0 digits).
Precision may be negative. Returns a floating point number when +ndigits+
is more than zero.
Numeric implements this by converting itself to a Float and invoking
Float#round.
;T;[o;
; I"
overload;F; 0;;C; 0; I"round([ndigits]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;TI"
Float;T;"@;#[ ;$I" @return [Integer, Float];T;%0;"@;&0;'F;(i ;[[I"[ndigits];T0;"@;#[ ;$I"1Rounds +num+ to a given precision in decimal digits (default 0 digits).
Precision may be negative. Returns a floating point number when +ndigits+
is more than zero.
Numeric implements this by converting itself to a Float and invoking
Float#round.
@overload round([ndigits])
@return [Integer, Float];T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"rstatic VALUE
num_round(int argc, VALUE* argv, VALUE num)
{
return flo_round(argc, argv, rb_Float(num));
};T;0To;
; F; ;
;;;I"Numeric#truncate;F;[ ;[[@i;T;;B;0;[ ;{ ;IC;"Returns +num+ truncated to an Integer.
Numeric implements this by converting its value to a Float and invoking
Float#truncate.
;T;[o;
; I"
overload;F; 0;;B; 0; I"
truncate;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@;#[ ;$I"@return [Integer];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"Returns +num+ truncated to an Integer.
Numeric implements this by converting its value to a Float and invoking
Float#truncate.
@overload truncate
@return [Integer];T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"Ustatic VALUE
num_truncate(VALUE num)
{
return flo_truncate(rb_Float(num));
};T;0To;
; F; ;
;;;I"Numeric#step;F;[[@0;[[@i;T;: step;0;[ ;{ ;IC;"Invokes the given block with the sequence of numbers starting at +num+,
incremented by +step+ (defaulted to +1+) on each call.
The loop finishes when the value to be passed to the block is greater than
+limit+ (if +step+ is positive) or less than +limit+ (if +step+ is
negative), where limit is defaulted to infinity.
In the recommended keyword argument style, either or both of
+step+ and +limit+ (default infinity) can be omitted. In the
fixed position argument style, zero as a step
(i.e. num.step(limit, 0)) is not allowed for historical
compatibility reasons.
If all the arguments are integers, the loop operates using an integer
counter.
If any of the arguments are floating point numbers, all are converted to floats, and the loop is executed the following expression:
floor(n + n*epsilon)+ 1
Where the +n+ is the following:
n = (limit - num)/step
Otherwise, the loop starts at +num+, uses either the less-than (<) or
greater-than (>) operator to compare the counter against +limit+, and
increments itself using the + operator.
If no block is given, an Enumerator is returned instead.
For example:
p 1.step.take(4)
p 10.step(by: -1).take(4)
3.step(to: 5) { |i| print i, " " }
1.step(10, 2) { |i| print i, " " }
Math::E.step(to: Math::PI, by: 0.2) { |f| print f, " " }
Will produce:
[1, 2, 3, 4]
[10, 9, 8, 7]
3 4 5
1 3 5 7 9
2.71828182845905 2.91828182845905 3.11828182845905
;T;[ o;
; I"
overload;F; 0;;; 0; I" step(by: step, to: limit);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"i;T;"@o;!
; I" return;F; I" ;T;0; [I" self;T;"@;#[ ;$I" @yield [i]
@return [self];T;%0;"@;&0;'F;(i ;[[I"by:;TI" step;T[I"to:;TI"
limit;T;"@o;
; I"
overload;F; 0;;; 0; I" step(by: step, to: limit);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[[I"by:;TI" step;T[I"to:;TI"
limit;T;"@o;
; I"
overload;F; 0;;; 0; I" step(limit=nil, step=1);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"i;T;"@o;!
; I" return;F; I" ;T;0; [I" self;T;"@;#[ ;$I" @yield [i]
@return [self];T;%0;"@;&0;'F;(i ;[[I"
limit;TI"nil;T[I" step;TI"1;T;"@o;
; I"
overload;F; 0;;; 0; I" step(limit=nil, step=1);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[[I"
limit;TI"nil;T[I" step;TI"1;T;"@;#[ ;$I"pInvokes the given block with the sequence of numbers starting at +num+,
incremented by +step+ (defaulted to +1+) on each call.
The loop finishes when the value to be passed to the block is greater than
+limit+ (if +step+ is positive) or less than +limit+ (if +step+ is
negative), where limit is defaulted to infinity.
In the recommended keyword argument style, either or both of
+step+ and +limit+ (default infinity) can be omitted. In the
fixed position argument style, zero as a step
(i.e. num.step(limit, 0)) is not allowed for historical
compatibility reasons.
If all the arguments are integers, the loop operates using an integer
counter.
If any of the arguments are floating point numbers, all are converted to floats, and the loop is executed the following expression:
floor(n + n*epsilon)+ 1
Where the +n+ is the following:
n = (limit - num)/step
Otherwise, the loop starts at +num+, uses either the less-than (<) or
greater-than (>) operator to compare the counter against +limit+, and
increments itself using the + operator.
If no block is given, an Enumerator is returned instead.
For example:
p 1.step.take(4)
p 10.step(by: -1).take(4)
3.step(to: 5) { |i| print i, " " }
1.step(10, 2) { |i| print i, " " }
Math::E.step(to: Math::PI, by: 0.2) { |f| print f, " " }
Will produce:
[1, 2, 3, 4]
[10, 9, 8, 7]
3 4 5
1 3 5 7 9
2.71828182845905 2.91828182845905 3.11828182845905
@overload step(by: step, to: limit)
@yield [i]
@return [self]
@overload step(by: step, to: limit)
@overload step(limit=nil, step=1)
@yield [i]
@return [self]
@overload step(limit=nil, step=1);T;%0;"@;'F;)o;*;+T;,iK;-i;.@; I"static VALUE;T;/I"{static VALUE
num_step(int argc, VALUE *argv, VALUE from)
{
VALUE to, step;
int desc, inf;
RETURN_SIZED_ENUMERATOR(from, argc, argv, num_step_size);
desc = num_step_scan_args(argc, argv, &to, &step);
if (RTEST(rb_num_coerce_cmp(step, INT2FIX(0), id_eq))) {
inf = 1;
}
else if (RB_TYPE_P(to, T_FLOAT)) {
double f = RFLOAT_VALUE(to);
inf = isinf(f) && (signbit(f) ? desc : !desc);
}
else inf = 0;
if (FIXNUM_P(from) && (inf || FIXNUM_P(to)) && FIXNUM_P(step)) {
long i = FIX2LONG(from);
long diff = FIX2LONG(step);
if (inf) {
for (;; i += diff)
rb_yield(LONG2FIX(i));
}
else {
long end = FIX2LONG(to);
if (desc) {
for (; i >= end; i += diff)
rb_yield(LONG2FIX(i));
}
else {
for (; i <= end; i += diff)
rb_yield(LONG2FIX(i));
}
}
}
else if (!ruby_float_step(from, to, step, FALSE)) {
VALUE i = from;
if (inf) {
for (;; i = rb_funcall(i, '+', 1, step))
rb_yield(i);
}
else {
ID cmp = desc ? '<' : '>';
for (; !RTEST(rb_funcall(i, cmp, 1, to)); i = rb_funcall(i, '+', 1, step))
rb_yield(i);
}
}
return from;
};T;0To;
; F; ;
;;;I"Numeric#positive?;F;[ ;[[@i;T;:positive?;0;[ ;{ ;IC;"/Returns +true+ if +num+ is greater than 0.
;T;[o;
; I"
overload;F; 0;;; 0; I"positive?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@*;#[ ;$I"@return [Boolean];T;%0;"@*;&0;'F;(i ;[ ;"@*o;!
; I" return;F; @;0; [@;"@*;#[ ;$I"YReturns +true+ if +num+ is greater than 0.
@overload positive?
@return [Boolean];T;%0;"@*;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"static VALUE
num_positive_p(VALUE num)
{
const ID mid = '>';
if (FIXNUM_P(num)) {
if (method_basic_p(rb_cFixnum))
return (SIGNED_VALUE)num > (SIGNED_VALUE)INT2FIX(0) ? Qtrue : Qfalse;
}
else if (RB_TYPE_P(num, T_BIGNUM)) {
if (method_basic_p(rb_cBignum))
return BIGNUM_POSITIVE_P(num) && !rb_bigzero_p(num) ? Qtrue : Qfalse;
}
return compare_with_zero(num, mid);
};T;0To;
; F; ;
;;;I"Numeric#negative?;F;[ ;[[@i;T;:negative?;0;[ ;{ ;IC;",Returns +true+ if +num+ is less than 0.
;T;[o;
; I"
overload;F; 0;;; 0; I"negative?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@H;#[ ;$I"@return [Boolean];T;%0;"@H;&0;'F;(i ;[ ;"@Ho;!
; I" return;F; @;0; [@;"@H;#[ ;$I"VReturns +true+ if +num+ is less than 0.
@overload negative?
@return [Boolean];T;%0;"@H;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"`static VALUE
num_negative_p(VALUE num)
{
return negative_int_p(num) ? Qtrue : Qfalse;
};T;0To;
; F; ;
;;;I"Numeric#to_c;F;[ ;[[@i;T;: to_c;0;[ ;{ ;IC;"$Returns the value as a complex.
;T;[o;
; I"
overload;F; 0;;; 0; I" to_c;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@f;&0;'F;(i ;[ ;"@f;#[ ;$I"5Returns the value as a complex.
@overload to_c;T;%0;"@f;'F;)o;*;+T;,i
;-i
;.@; I"static VALUE;T;/I"Pstatic VALUE
numeric_to_c(VALUE self)
{
return rb_complex_new1(self);
};T;0To;
; F; ;
;;;I"Numeric#real;F;[ ;[[@i;T;: real;0;[ ;{ ;IC;"Returns self.
;T;[o;
; I"
overload;F; 0;;; 0; I" real;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" self;T;"@|;#[ ;$I"@return [self];T;%0;"@|;&0;'F;(i ;[ ;"@|;#[ ;$I"4Returns self.
@overload real
@return [self];T;%0;"@|;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"?static VALUE
numeric_real(VALUE self)
{
return self;
};T;0To;
; F; ;
;;;I"Numeric#imaginary;F;[ ;[[@i;T;:imaginary;0;[ ;{ ;IC;"Returns zero.
;T;[o;
; I"
overload;F; 0;: imag; 0; I" imag;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;T;"@;#[ ;$I"@return [ 0];T;%0;"@;&0;'F;(i ;[ ;"@o;
; I"
overload;F; 0;;; 0; I"imaginary;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;T;"@;#[ ;$I"@return [ 0];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"UReturns zero.
@overload imag
@return [ 0]
@overload imaginary
@return [ 0];T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"Estatic VALUE
numeric_imag(VALUE self)
{
return INT2FIX(0);
};T;0To;
; F; ;
;;;I"Numeric#imag;F;[ ;[[@i;T;; ;0;[ ;{ ;IC;"Returns zero.
;T;[o;
; I"
overload;F; 0;; ; 0; I" imag;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;T;"@;#[ ;$I"@return [ 0];T;%0;"@;&0;'F;(i ;[ ;"@o;
; I"
overload;F; 0;;; 0; I"imaginary;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;T;"@;#[ ;$I"@return [ 0];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$@;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"Estatic VALUE
numeric_imag(VALUE self)
{
return INT2FIX(0);
};T;0To;
; F; ;
;;;I"Numeric#abs2;F;[ ;[[@i;T;: abs2;0;[ ;{ ;IC;" Returns square of self.
;T;[o;
; I"
overload;F; 0;;; 0; I" abs2;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"-Returns square of self.
@overload abs2;T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"Lstatic VALUE
numeric_abs2(VALUE self)
{
return f_mul(self, self);
};T;0To;
; F; ;
;;;I"Numeric#arg;F;[ ;[[@i;T;:arg;0;[ ;{ ;IC;"6Returns 0 if the value is positive, pi otherwise.
;T;[o;
; I"
overload;F; 0;;; 0; I"arg;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"
Float;T;"@;#[ ;$I"@return [ 0, Float];T;%0;"@;&0;'F;(i ;[ ;"@o;
; I"
overload;F; 0;:
angle; 0; I"
angle;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"
Float;T;"@;#[ ;$I"@return [ 0, Float];T;%0;"@;&0;'F;(i ;[ ;"@o;
; I"
overload;F; 0;:
phase; 0; I"
phase;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"
Float;T;"@;#[ ;$I"@return [ 0, Float];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"Returns 0 if the value is positive, pi otherwise.
@overload arg
@return [ 0, Float]
@overload angle
@return [ 0, Float]
@overload phase
@return [ 0, Float];T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"static VALUE
numeric_arg(VALUE self)
{
if (f_positive_p(self))
return INT2FIX(0);
return rb_const_get(rb_mMath, id_PI);
};T;0To;
; F; ;
;;;I"Numeric#angle;F;[ ;[[@i;T;;;0;[ ;{ ;IC;"6Returns 0 if the value is positive, pi otherwise.
;T;[o;
; I"
overload;F; 0;;; 0; I"arg;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"
Float;T;"@4;#[ ;$I"@return [ 0, Float];T;%0;"@4;&0;'F;(i ;[ ;"@4o;
; I"
overload;F; 0;;; 0; I"
angle;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"
Float;T;"@4;#[ ;$I"@return [ 0, Float];T;%0;"@4;&0;'F;(i ;[ ;"@4o;
; I"
overload;F; 0;;; 0; I"
phase;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"
Float;T;"@4;#[ ;$I"@return [ 0, Float];T;%0;"@4;&0;'F;(i ;[ ;"@4;#[ ;$@0;%0;"@4;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"static VALUE
numeric_arg(VALUE self)
{
if (f_positive_p(self))
return INT2FIX(0);
return rb_const_get(rb_mMath, id_PI);
};T;0To;
; F; ;
;;;I"Numeric#phase;F;[ ;[[@i;T;;;0;[ ;{ ;IC;"6Returns 0 if the value is positive, pi otherwise.
;T;[o;
; I"
overload;F; 0;;; 0; I"arg;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"
Float;T;"@k;#[ ;$I"@return [ 0, Float];T;%0;"@k;&0;'F;(i ;[ ;"@ko;
; I"
overload;F; 0;;; 0; I"
angle;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"
Float;T;"@k;#[ ;$I"@return [ 0, Float];T;%0;"@k;&0;'F;(i ;[ ;"@ko;
; I"
overload;F; 0;;; 0; I"
phase;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"
Float;T;"@k;#[ ;$I"@return [ 0, Float];T;%0;"@k;&0;'F;(i ;[ ;"@k;#[ ;$@0;%0;"@k;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"static VALUE
numeric_arg(VALUE self)
{
if (f_positive_p(self))
return INT2FIX(0);
return rb_const_get(rb_mMath, id_PI);
};T;0To;
; F; ;
;;;I"Numeric#rectangular;F;[ ;[[@i;T;:rectangular;0;[ ;{ ;IC;" Returns an array; [num, 0].
;T;[o;
; I"
overload;F; 0;: rect; 0; I" rect;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@;#[ ;$I"@return [Array];T;%0;"@;&0;'F;(i ;[ ;"@o;
; I"
overload;F; 0;;; 0; I"rectangular;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@;#[ ;$I"@return [Array];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"kReturns an array; [num, 0].
@overload rect
@return [Array]
@overload rectangular
@return [Array];T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"Ystatic VALUE
numeric_rect(VALUE self)
{
return rb_assoc_new(self, INT2FIX(0));
};T;0To;
; F; ;
;;;I"Numeric#rect;F;[ ;[[@i;T;;;0;[ ;{ ;IC;" Returns an array; [num, 0].
;T;[o;
; I"
overload;F; 0;;; 0; I" rect;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@;#[ ;$I"@return [Array];T;%0;"@;&0;'F;(i ;[ ;"@o;
; I"
overload;F; 0;;; 0; I"rectangular;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@;#[ ;$I"@return [Array];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$@;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"Ystatic VALUE
numeric_rect(VALUE self)
{
return rb_assoc_new(self, INT2FIX(0));
};T;0To;
; F; ;
;;;I"Numeric#polar;F;[ ;[[@i;T;:
polar;0;[ ;{ ;IC;"*Returns an array; [num.abs, num.arg].
;T;[o;
; I"
overload;F; 0;;; 0; I"
polar;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@;#[ ;$I"@return [Array];T;%0;"@;&0;'F;(i ;[ ;"@;#[ ;$I"NReturns an array; [num.abs, num.arg].
@overload polar
@return [Array];T;%0;"@;'F;)o;*;+T;,i;-i;.@; I"static VALUE;T;/I"bstatic VALUE
numeric_polar(VALUE self)
{
return rb_assoc_new(f_abs(self), f_arg(self));
};T;0To;
; F; ;
;;;I"Numeric#conjugate;F;[ ;[[@i ;T;:conjugate;0;[ ;{ ;IC;"Returns self.
;T;[o;
; I"
overload;F; 0;: conj; 0; I" conj;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" self;T;"@ ;#[ ;$I"@return [self];T;%0;"@ ;&0;'F;(i ;[ ;"@ o;
; I"
overload;F; 0;;; 0; I"conjugate;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" self;T;"@ ;#[ ;$I"@return [self];T;%0;"@ ;&0;'F;(i ;[ ;"@ ;#[ ;$I"YReturns self.
@overload conj
@return [self]
@overload conjugate
@return [self];T;%0;"@ ;'F;)o;*;+T;,i;-i ;.@; I"static VALUE;T;/I"?static VALUE
numeric_conj(VALUE self)
{
return self;
};T;0To;
; F; ;
;;;I"Numeric#conj;F;[ ;[[@i ;T;; ;0;[ ;{ ;IC;"Returns self.
;T;[o;
; I"
overload;F; 0;; ; 0; I" conj;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" self;T;"@4;#[ ;$I"@return [self];T;%0;"@4;&0;'F;(i ;[ ;"@4o;
; I"
overload;F; 0;;; 0; I"conjugate;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" self;T;"@4;#[ ;$I"@return [self];T;%0;"@4;&0;'F;(i ;[ ;"@4;#[ ;$@0;%0;"@4;'F;)o;*;+T;,i;-i ;.@; I"static VALUE;T;/I"?static VALUE
numeric_conj(VALUE self)
{
return self;
};T;0T;N@;OIC;[ ;N@;PIC;[o;;IC;[ o;
; F; ;
;;;I"Comparable#==;F;[[I"y;T0;[[I"
compar.c;TiJ;T;;:;0;[ ;{ ;IC;"Compares two objects based on the receiver's <=>
method, returning true if it returns 0. Also returns true if
_obj_ and _other_ are the same object.
;T;[o;
; I"
overload;F; 0;;:; 0; I"==(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@_;#[ ;$I"@return [Boolean];T;%0;"@_;&0;'F;(i ;[[I"
other;T0;"@_;#[ ;$I"Compares two objects based on the receiver's <=>
method, returning true if it returns 0. Also returns true if
_obj_ and _other_ are the same object.
@overload ==(other)
@return [Boolean];T;%0;"@_;'F;)o;*;+T;,iA;-iG;.@]; I"static VALUE;T;/I"static VALUE
cmp_equal(VALUE x, VALUE y)
{
VALUE c;
if (x == y) return Qtrue;
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;
};T;0To;
; F; ;
;;;I"Comparable#>;F;[[I"y;T0;[[@fi_;T;:>;0;[ ;{ ;IC;"jCompares two objects based on the receiver's <=>
method, returning true if it returns 1.
;T;[o;
; I"
overload;F; 0;;
; 0; I"
>(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[[I"
other;T0;"@;#[ ;$I"Compares two objects based on the receiver's <=>
method, returning true if it returns 1.
@overload >(other)
@return [Boolean];T;%0;"@;'F;)o;*;+T;,iW;-i\;.@]; I"static VALUE;T;/I"static VALUE
cmp_gt(VALUE x, VALUE y)
{
VALUE c = rb_funcall(x, cmp, 1, y);
if (rb_cmpint(c, x, y) > 0) return Qtrue;
return Qfalse;
};T;0To;
; F; ;
;;;I"Comparable#>=;F;[[I"y;T0;[[@fip;T;:>=;0;[ ;{ ;IC;"oCompares two objects based on the receiver's <=>
method, returning true if it returns 0 or 1.
;T;[o;
; I"
overload;F; 0;; ; 0; I">=(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[[I"
other;T0;"@;#[ ;$I"Compares two objects based on the receiver's <=>
method, returning true if it returns 0 or 1.
@overload >=(other)
@return [Boolean];T;%0;"@;'F;)o;*;+T;,ih;-im;.@]; I"static VALUE;T;/I"static VALUE
cmp_ge(VALUE x, VALUE y)
{
VALUE c = rb_funcall(x, cmp, 1, y);
if (rb_cmpint(c, x, y) >= 0) return Qtrue;
return Qfalse;
};T;0To;
; F; ;
;;;I"Comparable#<;F;[[I"y;T0;[[@fi|;T;:<;0;[ ;{ ;IC;"kCompares two objects based on the receiver's <=>
method, returning true if it returns -1.
;T;[o;
; I"
overload;F; 0;; ; 0; I"
<(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[[I"
other;T0;"@;#[ ;$I"Compares two objects based on the receiver's <=>
method, returning true if it returns -1.
@overload <(other)
@return [Boolean];T;%0;"@;'F;)o;*;+T;,iy;-i~;.@]; I"static VALUE;T;/I"static VALUE
cmp_lt(VALUE x, VALUE y)
{
VALUE c = rb_funcall(x, cmp, 1, y);
if (rb_cmpint(c, x, y) < 0) return Qtrue;
return Qfalse;
};T;0To;
; F; ;
;;;I"Comparable#<=;F;[[I"y;T0;[[@fi;T;:<=;0;[ ;{ ;IC;"pCompares two objects based on the receiver's <=>
method, returning true if it returns -1 or 0.
;T;[o;
; I"
overload;F; 0;;
; 0; I"<=(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[[I"
other;T0;"@;#[ ;$I"Compares two objects based on the receiver's <=>
method, returning true if it returns -1 or 0.
@overload <=(other)
@return [Boolean];T;%0;"@;'F;)o;*;+T;,i;-i;.@]; I"static VALUE;T;/I"static VALUE
cmp_le(VALUE x, VALUE y)
{
VALUE c = rb_funcall(x, cmp, 1, y);
if (rb_cmpint(c, x, y) <= 0) return Qtrue;
return Qfalse;
};T;0To;
; F; ;
;;;I"Comparable#between?;F;[[I"min;T0[I"max;T0;[[@fi;T;:
between?;0;[ ;{ ;IC;"jReturns false if obj <=>
min is less than zero or if anObject <=>
max is greater than zero, true otherwise.
3.between?(1, 5) #=> true
6.between?(1, 5) #=> false
'cat'.between?('ant', 'dog') #=> true
'gnu'.between?('ant', 'dog') #=> false
;T;[o;
; I"
overload;F; 0;;; 0; I"between?(min, max);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#[ ;$I"@return [Boolean];T;%0;"@;&0;'F;(i ;[[I"min;T0[I"max;T0;"@o;!
; I" return;F; @;0; [@;"@;#[ ;$I"Returns false if obj <=>
min is less than zero or if anObject <=>
max is greater than zero, true otherwise.
3.between?(1, 5) #=> true
6.between?(1, 5) #=> false
'cat'.between?('ant', 'dog') #=> true
'gnu'.between?('ant', 'dog') #=> false
@overload between?(min, max)
@return [Boolean];T;%0;"@;'F;)o;*;+T;,i;-i;.@]; I"static VALUE;T;/I"static VALUE
cmp_between(VALUE x, VALUE min, VALUE max)
{
if (RTEST(cmp_lt(x, min))) return Qfalse;
if (RTEST(cmp_gt(x, max))) return Qfalse;
return Qtrue;
};T;0T;N@];OIC;[ ;N@];PIC;[ ;N@];QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@fi;F;:Comparable;;X;;;[ ;{ ;IC;"The Comparable mixin is used by classes whose objects
may be ordered. The class must define the <=> 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 <=> operator should return nil.
Comparable uses
<=> to implement the conventional comparison operators
(<, <=, ==, >=,
and >) and the method between?.
class SizeMatters
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 < s2 #=> true
s4.between?(s1, s3) #=> false
s4.between?(s3, s5) #=> true
[ s3, s2, s5, s4, s1 ].sort #=> [Z, YY, XXX, WWWW, VVVVV]
;T;[ ;#[ ;$I"The Comparable mixin is used by classes whose objects
may be ordered. The class must define the <=> 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 <=> operator should return nil.
Comparable uses
<=> to implement the conventional comparison operators
(<, <=, ==, >=,
and >) and the method between?.
class SizeMatters
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 < s2 #=> true
s4.between?(s1, s3) #=> false
s4.between?(s3, s5) #=> true
[ s3, s2, s5, s4, s1 ].sort #=> [Z, YY, XXX, WWWW, VVVVV]
;T;%0;"@];'F;)o;*;+T;,i;-i;.@;I"Comparable;F;N@;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i[@i<;T;;;;X;;;[ ;{ ;IC;"^Numeric is the class from which all higher-level numeric classes should inherit.
Numeric allows instantiation of heap-allocated objects. Other core numeric classes such as
Integer are implemented as immediates, which means that each Integer is a single immutable
object which is always passed by value.
a = 1
puts 1.object_id == a.object_id #=> true
There can only ever be one instance of the integer +1+, for example. Ruby ensures this
by preventing instantiation and duplication.
Integer.new(1) #=> NoMethodError: undefined method `new' for Integer:Class
1.dup #=> TypeError: can't dup Fixnum
For this reason, Numeric should be used when defining other numeric classes.
Classes which inherit from Numeric must implement +coerce+, which returns a two-member
Array containing an object that has been coerced into an instance of the new class
and +self+ (see #coerce).
Inheriting classes should also implement arithmetic operator methods (+,
-, * and /) and the <=> operator (see
Comparable). These methods may rely on +coerce+ to ensure interoperability with
instances of other numeric classes.
class Tally < Numeric
def initialize(string)
@string = string
end
def to_s
@string
end
def to_i
@string.size
end
def coerce(other)
[self.class.new('|' * other.to_i), self]
end
def <=>(other)
to_i <=> other.to_i
end
def +(other)
self.class.new('|' * (to_i + other.to_i))
end
def -(other)
self.class.new('|' * (to_i - other.to_i))
end
def *(other)
self.class.new('|' * (to_i * other.to_i))
end
def /(other)
self.class.new('|' * (to_i / other.to_i))
end
end
tally = Tally.new('||')
puts tally * 2 #=> "||||"
puts tally > 1 #=> true;T;[ ;#[ ;$I"`
Numeric is the class from which all higher-level numeric classes should inherit.
Numeric allows instantiation of heap-allocated objects. Other core numeric classes such as
Integer are implemented as immediates, which means that each Integer is a single immutable
object which is always passed by value.
a = 1
puts 1.object_id == a.object_id #=> true
There can only ever be one instance of the integer +1+, for example. Ruby ensures this
by preventing instantiation and duplication.
Integer.new(1) #=> NoMethodError: undefined method `new' for Integer:Class
1.dup #=> TypeError: can't dup Fixnum
For this reason, Numeric should be used when defining other numeric classes.
Classes which inherit from Numeric must implement +coerce+, which returns a two-member
Array containing an object that has been coerced into an instance of the new class
and +self+ (see #coerce).
Inheriting classes should also implement arithmetic operator methods (+,
-, * and /) and the <=> operator (see
Comparable). These methods may rely on +coerce+ to ensure interoperability with
instances of other numeric classes.
class Tally < Numeric
def initialize(string)
@string = string
end
def to_s
@string
end
def to_i
@string.size
end
def coerce(other)
[self.class.new('|' * other.to_i), self]
end
def <=>(other)
to_i <=> other.to_i
end
def +(other)
self.class.new('|' * (to_i + other.to_i))
end
def -(other)
self.class.new('|' * (to_i - other.to_i))
end
def *(other)
self.class.new('|' * (to_i * other.to_i))
end
def /(other)
self.class.new('|' * (to_i / other.to_i))
end
end
tally = Tally.new('||')
puts tally * 2 #=> "||||"
puts tally > 1 #=> true
;T;%0;"@;'F;(i ;)o;*;+T;,i;-i&;.@;I" Numeric;F;Y@N;;S@
o; ;IC;[:o;
; F; ;
;;;I"Integer#gcd;F;[[I"
other;T0;[[@i;T;:gcd;0;[ ;{ ;IC;"Returns the greatest common divisor (always positive). 0.gcd(x)
and x.gcd(0) return abs(x).
2.gcd(2) #=> 2
3.gcd(-7) #=> 1
((1<<31)-1).gcd((1<<61)-1) #=> 1
;T;[o;
; I"
overload;F; 0;;; 0; I"gcd(int2);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@D ;#[ ;$I"@return [Integer];T;%0;"@D ;&0;'F;(i ;[[I" int2;T0;"@D ;#[ ;$I"Returns the greatest common divisor (always positive). 0.gcd(x)
and x.gcd(0) return abs(x).
2.gcd(2) #=> 2
3.gcd(-7) #=> 1
((1<<31)-1).gcd((1<<61)-1) #=> 1
@overload gcd(int2)
@return [Integer];T;%0;"@D ;'F;)o;*;+T;,i;-i;.@B ; I"
VALUE;T;/I"qVALUE
rb_gcd(VALUE self, VALUE other)
{
other = nurat_int_value(other);
return f_gcd(self, other);
};T;0To;
; F; ;
;;;I"Integer#lcm;F;[[I"
other;T0;[[@i;T;:lcm;0;[ ;{ ;IC;"Returns the least common multiple (always positive). 0.lcm(x) and
x.lcm(0) return zero.
2.lcm(2) #=> 2
3.lcm(-7) #=> 21
((1<<31)-1).lcm((1<<61)-1) #=> 4951760154835678088235319297
;T;[o;
; I"
overload;F; 0;;; 0; I"lcm(int2);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@c ;#[ ;$I"@return [Integer];T;%0;"@c ;&0;'F;(i ;[[I" int2;T0;"@c ;#[ ;$I"Returns the least common multiple (always positive). 0.lcm(x) and
x.lcm(0) return zero.
2.lcm(2) #=> 2
3.lcm(-7) #=> 21
((1<<31)-1).lcm((1<<61)-1) #=> 4951760154835678088235319297
@overload lcm(int2)
@return [Integer];T;%0;"@c ;'F;)o;*;+T;,i;-i;.@B ; I"
VALUE;T;/I"qVALUE
rb_lcm(VALUE self, VALUE other)
{
other = nurat_int_value(other);
return f_lcm(self, other);
};T;0To;
; F; ;
;;;I"Integer#gcdlcm;F;[[I"
other;T0;[[@i;T;: gcdlcm;0;[ ;{ ;IC;"Returns an array; [int.gcd(int2), int.lcm(int2)].
2.gcdlcm(2) #=> [2, 2]
3.gcdlcm(-7) #=> [1, 21]
((1<<31)-1).gcdlcm((1<<61)-1) #=> [1, 4951760154835678088235319297]
;T;[o;
; I"
overload;F; 0;;; 0; I"gcdlcm(int2);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@ ;#[ ;$I"@return [Array];T;%0;"@ ;&0;'F;(i ;[[I" int2;T0;"@ ;#[ ;$I" Returns an array; [int.gcd(int2), int.lcm(int2)].
2.gcdlcm(2) #=> [2, 2]
3.gcdlcm(-7) #=> [1, 21]
((1<<31)-1).gcdlcm((1<<61)-1) #=> [1, 4951760154835678088235319297]
@overload gcdlcm(int2)
@return [Array];T;%0;"@ ;'F;)o;*;+T;,i;-i;.@B ; I"
VALUE;T;/I"VALUE
rb_gcdlcm(VALUE self, VALUE other)
{
other = nurat_int_value(other);
return rb_assoc_new(f_gcd(self, other), f_lcm(self, other));
};T;0To;
; F; ;
;;;I"Integer#numerator;F;[ ;[[@iD;T;;;0;[ ;{ ;IC;"Returns self.
;T;[o;
; I"
overload;F; 0;;; 0; I"numerator;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" self;T;"@ ;#[ ;$I"@return [self];T;%0;"@ ;&0;'F;(i ;[ ;"@ ;#[ ;$I"9Returns self.
@overload numerator
@return [self];T;%0;"@ ;'F;)o;*;+T;,i>;-iB;.@B ; I"static VALUE;T;/I"Dstatic VALUE
integer_numerator(VALUE self)
{
return self;
};T;0To;
; F; ;
;;;I"Integer#denominator;F;[ ;[[@iP;T;;1;0;[ ;{ ;IC;"Returns 1.
;T;[o;
; I"
overload;F; 0;;1; 0; I"denominator;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"1;T;"@ ;#[ ;$I"@return [ 1];T;%0;"@ ;&0;'F;(i ;[ ;"@ ;#[ ;$I"6Returns 1.
@overload denominator
@return [ 1];T;%0;"@ ;'F;)o;*;+T;,iJ;-iN;.@B ; I"static VALUE;T;/I"Lstatic VALUE
integer_denominator(VALUE self)
{
return INT2FIX(1);
};T;0To;
; F; ;
;;;I"Integer#to_r;F;[ ;[[@i;T;;F;0;[ ;{ ;IC;"oReturns the value as a rational.
1.to_r #=> (1/1)
(1<<64).to_r #=> (18446744073709551616/1)
;T;[o;
; I"
overload;F; 0;;F; 0; I" to_r;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ ;&0;'F;(i ;[ ;"@ ;#[ ;$I"{Returns the value as a rational.
1.to_r #=> (1/1)
(1<<64).to_r #=> (18446744073709551616/1)
@overload to_r;T;%0;"@ ;'F;)o;*;+T;,i;-i;.@B ; I"static VALUE;T;/I"Qstatic VALUE
integer_to_r(VALUE self)
{
return rb_rational_new1(self);
};T;0To;
; F; ;
;;;I"Integer#rationalize;F;[[@0;[[@i;T;;G;0;[ ;{ ;IC;"SReturns the value as a rational. The optional argument eps is
always ignored.
;T;[o;
; I"
overload;F; 0;;G; 0; I"rationalize([eps]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ ;&0;'F;(i ;[[I"
[eps];T0;"@ ;#[ ;$I"rReturns the value as a rational. The optional argument eps is
always ignored.
@overload rationalize([eps]);T;%0;"@ ;'F;)o;*;+T;,i;-i;.@B ; I"static VALUE;T;/I"static VALUE
integer_rationalize(int argc, VALUE *argv, VALUE self)
{
rb_scan_args(argc, argv, "01", NULL);
return integer_to_r(self);
};T;0To;
; F; ;
;;;I"Integer#integer?;F;[ ;[[@i8
;T;;;0;[ ;{ ;IC;"CSince +int+ is already an Integer, this always returns +true+.
;T;[o;
; I"
overload;F; 0;;; 0; I"
integer?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" true;T;"@ ;#[ ;$I"@return [true];T;%0;"@ ;&0;'F;(i ;[ ;"@ o;!
; I" return;F; @;0; [@;"@ ;#[ ;$I"iSince +int+ is already an Integer, this always returns +true+.
@overload integer?
@return [true];T;%0;"@ ;'F;)o;*;+T;,i1
;-i5
;.@B ; I"static VALUE;T;/I"
;-iB
;.@B ; I"static VALUE;T;/I"static VALUE
int_odd_p(VALUE num)
{
if (rb_funcall(num, '%', 1, INT2FIX(2)) != INT2FIX(0)) {
return Qtrue;
}
return Qfalse;
};T;0To;
; F; ;
;;;I"Integer#even?;F;[ ;[[@iU
;T;:
even?;0;[ ;{ ;IC;"/Returns +true+ if +int+ is an even number.
;T;[o;
; I"
overload;F; 0;;; 0; I"
even?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@B ;#[ ;$I"@return [Boolean];T;%0;"@B ;&0;'F;(i ;[ ;"@B o;!
; I" return;F; @;0; [@;"@B ;#[ ;$I"UReturns +true+ if +int+ is an even number.
@overload even?
@return [Boolean];T;%0;"@B ;'F;)o;*;+T;,iN
;-iR
;.@B ; I"static VALUE;T;/I"static VALUE
int_even_p(VALUE num)
{
if (rb_funcall(num, '%', 1, INT2FIX(2)) == INT2FIX(0)) {
return Qtrue;
}
return Qfalse;
};T;0To;
; F; ;
;;;I"Integer#upto;F;[[I"to;T0;[[@i;T;: upto;0;[ ;{ ;IC;"Iterates the given block, passing in integer values from +int+ up to and
including +limit+.
If no block is given, an Enumerator is returned instead.
For example:
5.upto(10) { |i| print i, " " }
#=> 5 6 7 8 9 10
;T;[o;
; I"
overload;F; 0;;; 0; I"upto(limit);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"i;T;"@` o;!
; I" return;F; I" ;T;0; [I" self;T;"@` ;#[ ;$I" @yield [i]
@return [self];T;%0;"@` ;&0;'F;(i ;[[I"
limit;T0;"@` o;
; I"
overload;F; 0;;; 0; I"upto(limit);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@` ;&0;'F;(i ;[[I"
limit;T0;"@` ;#[ ;$I"'Iterates the given block, passing in integer values from +int+ up to and
including +limit+.
If no block is given, an Enumerator is returned instead.
For example:
5.upto(10) { |i| print i, " " }
#=> 5 6 7 8 9 10
@overload upto(limit)
@yield [i]
@return [self]
@overload upto(limit);T;%0;"@` ;'F;)o;*;+T;,i;-i;.@B ; I"static VALUE;T;/I"static VALUE
int_upto(VALUE from, VALUE to)
{
RETURN_SIZED_ENUMERATOR(from, 1, &to, int_upto_size);
if (FIXNUM_P(from) && FIXNUM_P(to)) {
long i, end;
end = FIX2LONG(to);
for (i = FIX2LONG(from); i <= end; i++) {
rb_yield(LONG2FIX(i));
}
}
else {
VALUE i = from, c;
while (!(c = rb_funcall(i, '>', 1, to))) {
rb_yield(i);
i = rb_funcall(i, '+', 1, INT2FIX(1));
}
if (NIL_P(c)) rb_cmperr(i, to);
}
return from;
};T;0To;
; F; ;
;;;I"Integer#downto;F;[[I"to;T0;[[@i+;T;: downto;0;[ ;{ ;IC;"Iterates the given block, passing decreasing values from +int+ down to and
including +limit+.
If no block is given, an Enumerator is returned instead.
5.downto(1) { |n| print n, ".. " }
print " Liftoff!\n"
#=> "5.. 4.. 3.. 2.. 1.. Liftoff!"
;T;[o;
; I"
overload;F; 0;;; 0; I"downto(limit);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"i;T;"@ o;!
; I" return;F; I" ;T;0; [I" self;T;"@ ;#[ ;$I" @yield [i]
@return [self];T;%0;"@ ;&0;'F;(i ;[[I"
limit;T0;"@ o;
; I"
overload;F; 0;;; 0; I"downto(limit);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ ;&0;'F;(i ;[[I"
limit;T0;"@ ;#[ ;$I"NIterates the given block, passing decreasing values from +int+ down to and
including +limit+.
If no block is given, an Enumerator is returned instead.
5.downto(1) { |n| print n, ".. " }
print " Liftoff!\n"
#=> "5.. 4.. 3.. 2.. 1.. Liftoff!"
@overload downto(limit)
@yield [i]
@return [self]
@overload downto(limit);T;%0;"@ ;'F;)o;*;+T;,i ;-i);.@B ; I"static VALUE;T;/I"static VALUE
int_downto(VALUE from, VALUE to)
{
RETURN_SIZED_ENUMERATOR(from, 1, &to, int_downto_size);
if (FIXNUM_P(from) && FIXNUM_P(to)) {
long i, end;
end = FIX2LONG(to);
for (i=FIX2LONG(from); i >= end; i--) {
rb_yield(LONG2FIX(i));
}
}
else {
VALUE i = from, c;
while (!(c = rb_funcall(i, '<', 1, to))) {
rb_yield(i);
i = rb_funcall(i, '-', 1, INT2FIX(1));
}
if (NIL_P(c)) rb_cmperr(i, to);
}
return from;
};T;0To;
; F; ;
;;;I"Integer#times;F;[ ;[[@i_;T;:
times;0;[ ;{ ;IC;"Iterates the given block +int+ times, passing in values from zero to
int - 1.
If no block is given, an Enumerator is returned instead.
5.times do |i|
print i, " "
end
#=> 0 1 2 3 4
;T;[o;
; I"
overload;F; 0;;; 0; I"
times;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"i;T;"@ o;!
; I" return;F; I" ;T;0; [I" self;T;"@ ;#[ ;$I" @yield [i]
@return [self];T;%0;"@ ;&0;'F;(i ;[ ;"@ o;
; I"
overload;F; 0;;; 0; I"
times;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ ;&0;'F;(i ;[ ;"@ ;#[ ;$I"Iterates the given block +int+ times, passing in values from zero to
int - 1.
If no block is given, an Enumerator is returned instead.
5.times do |i|
print i, " "
end
#=> 0 1 2 3 4
@overload times
@yield [i]
@return [self]
@overload times;T;%0;"@ ;'F;)o;*;+T;,iO;-i];.@B ; I"static VALUE;T;/I"static VALUE
int_dotimes(VALUE num)
{
RETURN_SIZED_ENUMERATOR(num, 0, 0, int_dotimes_size);
if (FIXNUM_P(num)) {
long i, end;
end = FIX2LONG(num);
for (i=0; i "A"
230.chr #=> "\346"
255.chr(Encoding::UTF_8) #=> "\303\277"
;T;[o;
; I"
overload;F; 0;;; 0; I"chr([encoding]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@ ;#[ ;$I"@return [String];T;%0;"@ ;&0;'F;(i ;[[I"[encoding];T0;"@ ;#[ ;$I"Returns a string containing the character represented by the +int+'s value
according to +encoding+.
65.chr #=> "A"
230.chr #=> "\346"
255.chr(Encoding::UTF_8) #=> "\303\277"
@overload chr([encoding])
@return [String];T;%0;"@ ;'F;)o;*;+T;,i
;-i
;.@B ; I"static VALUE;T;/I"Rstatic VALUE
int_chr(int argc, VALUE *argv, VALUE num)
{
char c;
unsigned int i;
rb_encoding *enc;
if (rb_num_to_uint(num, &i) == 0) {
}
else if (FIXNUM_P(num)) {
rb_raise(rb_eRangeError, "%ld out of char range", FIX2LONG(num));
}
else {
rb_raise(rb_eRangeError, "bignum out of char range");
}
switch (argc) {
case 0:
if (0xff < i) {
enc = rb_default_internal_encoding();
if (!enc) {
rb_raise(rb_eRangeError, "%d out of char range", i);
}
goto decode;
}
c = (char)i;
if (i < 0x80) {
return rb_usascii_str_new(&c, 1);
}
else {
return rb_str_new(&c, 1);
}
case 1:
break;
default:
rb_check_arity(argc, 0, 1);
break;
}
enc = rb_to_encoding(argv[0]);
if (!enc) enc = rb_ascii8bit_encoding();
decode:
return rb_enc_uint_chr(i, enc);
};T;0To;
; F; ;
;;;I"Integer#ord;F;[ ;[[@i
;T;:ord;0;[ ;{ ;IC;"Returns the +int+ itself.
?a.ord #=> 97
This method is intended for compatibility to character constant in Ruby
1.9.
For example, ?a.ord returns 97 both in 1.8 and 1.9.
;T;[o;
; I"
overload;F; 0;; ; 0; I"ord;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" self;T;"@ ;#[ ;$I"@return [self];T;%0;"@ ;&0;'F;(i ;[ ;"@ ;#[ ;$I"Returns the +int+ itself.
?a.ord #=> 97
This method is intended for compatibility to character constant in Ruby
1.9.
For example, ?a.ord returns 97 both in 1.8 and 1.9.
@overload ord
@return [self];T;%0;"@ ;'F;)o;*;+T;,i
;-i
;.@B ; I"static VALUE;T;/I"8static VALUE
int_ord(VALUE num)
{
return num;
};T;0To;
; F; ;
;;;I"Integer#to_i;F;[ ;[[@i+
;T;;D;0;[ ;{ ;IC;"~As +int+ is already an Integer, all these methods simply return the receiver.
Synonyms are #to_int, #floor, #ceil, #truncate.
;T;[o;
; I"
overload;F; 0;;D; 0; I" to_i;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@8 ;#[ ;$I"@return [Integer];T;%0;"@8 ;&0;'F;(i ;[ ;"@8 ;#[ ;$I"As +int+ is already an Integer, all these methods simply return the receiver.
Synonyms are #to_int, #floor, #ceil, #truncate.
@overload to_i
@return [Integer];T;%0;"@8 ;'F;)o;*;+T;,i"
;-i(
;.@B ; I"static VALUE;T;/I"9static VALUE
int_to_i(VALUE num)
{
return num;
};T;0To;
; F; ;
;;;I"Integer#to_int;F;[ ;[[@i+
;T;;;0;[ ;{ ;IC;"~As +int+ is already an Integer, all these methods simply return the receiver.
Synonyms are #to_int, #floor, #ceil, #truncate.
;T;[o;
; I"
overload;F; 0;;D; 0; I" to_i;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@S ;#[ ;$I"@return [Integer];T;%0;"@S ;&0;'F;(i ;[ ;"@S ;#[ ;$@O ;%0;"@S ;'F;)o;*;+T;,i"
;-i(
;.@B ; I"static VALUE;T;/I"9static VALUE
int_to_i(VALUE num)
{
return num;
};T;0To;
; F; ;
;;;I"Integer#floor;F;[ ;[[@i+
;T;;@;0;[ ;{ ;IC;"~As +int+ is already an Integer, all these methods simply return the receiver.
Synonyms are #to_int, #floor, #ceil, #truncate.
;T;[o;
; I"
overload;F; 0;;D; 0; I" to_i;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@m ;#[ ;$I"@return [Integer];T;%0;"@m ;&0;'F;(i ;[ ;"@m ;#[ ;$@O ;%0;"@m ;'F;)o;*;+T;,i"
;-i(
;.@B ; I"static VALUE;T;/I"9static VALUE
int_to_i(VALUE num)
{
return num;
};T;0To;
; F; ;
;;;I"Integer#ceil;F;[ ;[[@i+
;T;;A;0;[ ;{ ;IC;"~As +int+ is already an Integer, all these methods simply return the receiver.
Synonyms are #to_int, #floor, #ceil, #truncate.
;T;[o;
; I"
overload;F; 0;;D; 0; I" to_i;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@ ;#[ ;$I"@return [Integer];T;%0;"@ ;&0;'F;(i ;[ ;"@ ;#[ ;$@O ;%0;"@ ;'F;)o;*;+T;,i"
;-i(
;.@B ; I"static VALUE;T;/I"9static VALUE
int_to_i(VALUE num)
{
return num;
};T;0To;
; F; ;
;;;I"Integer#truncate;F;[ ;[[@i+
;T;;B;0;[ ;{ ;IC;"~As +int+ is already an Integer, all these methods simply return the receiver.
Synonyms are #to_int, #floor, #ceil, #truncate.
;T;[o;
; I"
overload;F; 0;;D; 0; I" to_i;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@ ;#[ ;$I"@return [Integer];T;%0;"@ ;&0;'F;(i ;[ ;"@ ;#[ ;$@O ;%0;"@ ;'F;)o;*;+T;,i"
;-i(
;.@B ; I"static VALUE;T;/I"9static VALUE
int_to_i(VALUE num)
{
return num;
};T;0To;
; F; ;
;;;I"Integer#round;F;[[@0;[[@i;T;;C;0;[ ;{ ;IC;"Rounds +int+ to a given precision in decimal digits (default 0 digits).
Precision may be negative. Returns a floating point number when +ndigits+
is positive, +self+ for zero, and round down for negative.
1.round #=> 1
1.round(2) #=> 1.0
15.round(-1) #=> 20
;T;[o;
; I"
overload;F; 0;;C; 0; I"round([ndigits]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;TI"
Float;T;"@ ;#[ ;$I" @return [Integer, Float];T;%0;"@ ;&0;'F;(i ;[[I"[ndigits];T0;"@ ;#[ ;$I"RRounds +int+ to a given precision in decimal digits (default 0 digits).
Precision may be negative. Returns a floating point number when +ndigits+
is positive, +self+ for zero, and round down for negative.
1.round #=> 1
1.round(2) #=> 1.0
15.round(-1) #=> 20
@overload round([ndigits])
@return [Integer, Float];T;%0;"@ ;'F;)o;*;+T;,ix;-i;.@B ; I"static VALUE;T;/I"@static VALUE
int_round(int argc, VALUE* argv, VALUE num)
{
VALUE n;
int ndigits;
if (argc == 0) return num;
rb_scan_args(argc, argv, "1", &n);
ndigits = NUM2INT(n);
if (ndigits > 0) {
return rb_Float(num);
}
if (ndigits == 0) {
return num;
}
return int_round_0(num, ndigits);
};T;0To;
; F; ;
;;;I"Integer#gcd_normal;F;[[I"y;T0;[[I" ext/-test-/rational/rat.c;Ti;T;:gcd_normal;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ ;.@B ; I"static VALUE;T;/I"ustatic VALUE
gcd_normal(VALUE x, VALUE y)
{
return rb_big_norm(rb_gcd_normal(rb_to_int(x), rb_to_int(y)));
};T;0To;
; F; ;
;;;I"Integer#gcd_gmp;F;[[I"y;T0;[[@ i ;T;: gcd_gmp;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ ;.@B ; I"static VALUE;T;/I"cstatic VALUE
gcd_gmp(VALUE x, VALUE y)
{
return rb_big_norm(rb_gcd_gmp(big(x), big(y)));
};T;0To;
; F; ;
;;;I" Integer#big_divrem_normal;F;[[I"y;T0;[[I" ext/-test-/bignum/div.c;Ti;T;:big_divrem_normal;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ ;.@B ; I"static VALUE;T;/I"sstatic VALUE
divrem_normal(VALUE x, VALUE y)
{
return rb_big_norm(rb_big_divrem_normal(big(x), big(y)));
};T;0To;
; F; ;
;;;I"Integer#big_divrem_gmp;F;[[I"y;T0;[[@ i;T;:big_divrem_gmp;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ ;.@B ; I"static VALUE;T;/I"mstatic VALUE
divrem_gmp(VALUE x, VALUE y)
{
return rb_big_norm(rb_big_divrem_gmp(big(x), big(y)));
};T;0To;
; F; ;
;;;I"Integer#test_pack_raw;F;[
[I"buf;T0[I"numwords_arg;T0[I"wordsize_arg;T0[I"
nails;T0[I"
flags;T0;[[I" ext/-test-/bignum/intpack.c;Ti;T;:test_pack_raw;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ ;.@B ; I"static VALUE;T;/I"static VALUE
rb_integer_pack_raw_m(VALUE val, VALUE buf, VALUE numwords_arg, VALUE wordsize_arg, VALUE nails, VALUE flags)
{
int sign;
size_t numwords = 0;
size_t wordsize = NUM2SIZET(wordsize_arg);
StringValue(buf);
rb_str_modify(buf);
sign = rb_integer_pack(val,
RSTRING_PTR(buf), NUM2SIZET(numwords_arg),
NUM2SIZET(wordsize_arg), NUM2SIZET(nails), NUM2INT(flags));
return rb_ary_new_from_args(2, INT2NUM(sign), rb_str_new(RSTRING_PTR(buf), wordsize * numwords));
};T;0To;
; F; ;
;;;I"Integer#test_pack;F;[ [I"numwords_arg;T0[I"wordsize_arg;T0[I"
nails;T0[I"
flags;T0;[[@# i;T;:test_pack;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@+ ;.@B ; I"static VALUE;T;/I"6static VALUE
rb_integer_pack_m(VALUE val, VALUE numwords_arg, VALUE wordsize_arg, VALUE nails, VALUE flags)
{
int sign;
size_t numwords = NUM2SIZET(numwords_arg);
size_t wordsize = NUM2SIZET(wordsize_arg);
VALUE buf;
if (numwords != 0 && wordsize != 0 && LONG_MAX / wordsize < numwords)
rb_raise(rb_eArgError, "too big numwords * wordsize");
buf = rb_str_new(NULL, numwords * wordsize);
sign = rb_integer_pack(val,
RSTRING_PTR(buf), numwords,
wordsize, NUM2SIZET(nails), NUM2INT(flags));
return rb_assoc_new(INT2NUM(sign), buf);
};T;0To;
; F; ;S;;;I"Integer.test_unpack;F;[
[I"buf;T0[I"
numwords;T0[I"
wordsize;T0[I"
nails;T0[I"
flags;T0;[[@# i*;T;:test_unpack;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@? ;.@B ; I"static VALUE;T;/I"!static VALUE
rb_integer_unpack_m(VALUE klass, VALUE buf, VALUE numwords, VALUE wordsize, VALUE nails, VALUE flags)
{
StringValue(buf);
return rb_integer_unpack(RSTRING_PTR(buf),
NUM2SIZET(numwords), NUM2SIZET(wordsize),
NUM2SIZET(nails), NUM2INT(flags));
};T;0To;;[[@# iN;F;: INTEGER_PACK_MSWORD_FIRST;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@U ;.@B ;I"'Integer::INTEGER_PACK_MSWORD_FIRST;F;I"'INT2NUM(INTEGER_PACK_MSWORD_FIRST);To;;[[@# iO;F;: INTEGER_PACK_LSWORD_FIRST;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@_ ;.@B ;I"'Integer::INTEGER_PACK_LSWORD_FIRST;F;I"'INT2NUM(INTEGER_PACK_LSWORD_FIRST);To;;[[@# iP;F;: INTEGER_PACK_MSBYTE_FIRST;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@i ;.@B ;I"'Integer::INTEGER_PACK_MSBYTE_FIRST;F;I"'INT2NUM(INTEGER_PACK_MSBYTE_FIRST);To;;[[@# iQ;F;: INTEGER_PACK_LSBYTE_FIRST;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@s ;.@B ;I"'Integer::INTEGER_PACK_LSBYTE_FIRST;F;I"'INT2NUM(INTEGER_PACK_LSBYTE_FIRST);To;;[[@# iR;F;:#INTEGER_PACK_NATIVE_BYTE_ORDER;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@} ;.@B ;I",Integer::INTEGER_PACK_NATIVE_BYTE_ORDER;F;I",INT2NUM(INTEGER_PACK_NATIVE_BYTE_ORDER);To;;[[@# iS;F;:INTEGER_PACK_2COMP;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ ;.@B ;I" Integer::INTEGER_PACK_2COMP;F;I" INT2NUM(INTEGER_PACK_2COMP);To;;[[@# iT;F;: INTEGER_PACK_LITTLE_ENDIAN;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ ;.@B ;I"(Integer::INTEGER_PACK_LITTLE_ENDIAN;F;I"(INT2NUM(INTEGER_PACK_LITTLE_ENDIAN);To;;[[@# iU;F;: INTEGER_PACK_BIG_ENDIAN;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ ;.@B ;I"%Integer::INTEGER_PACK_BIG_ENDIAN;F;I"%INT2NUM(INTEGER_PACK_BIG_ENDIAN);To;;[[@# iV;F;: INTEGER_PACK_FORCE_BIGNUM;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ ;.@B ;I"'Integer::INTEGER_PACK_FORCE_BIGNUM;F;I"'INT2NUM(INTEGER_PACK_FORCE_BIGNUM);To;;[[@# iW;F;:INTEGER_PACK_NEGATIVE;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ ;.@B ;I"#Integer::INTEGER_PACK_NEGATIVE;F;I"#INT2NUM(INTEGER_PACK_NEGATIVE);To;;[[@# iX;F;:.INTEGER_PACK_FORCE_GENERIC_IMPLEMENTATION;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ ;.@B ;I"7Integer::INTEGER_PACK_FORCE_GENERIC_IMPLEMENTATION;F;I"7INT2NUM(INTEGER_PACK_FORCE_GENERIC_IMPLEMENTATION);To;
; F; ;
;;;I",Integer#test_numbits_2comp_without_sign;F;[ ;[[@# i4;T;:$test_numbits_2comp_without_sign;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ ;.@B ; I"static VALUE;T;/I"static VALUE
rb_integer_test_numbits_2comp_without_sign(VALUE val)
{
size_t size;
int neg = FIXNUM_P(val) ? FIX2LONG(val) < 0 : BIGNUM_NEGATIVE_P(val);
size = rb_absint_numwords(val, 1, NULL) - (neg && rb_absint_singlebit_p(val));
return SIZET2NUM(size);
};T;0To;
; F; ;
;;;I"*Integer#test_numbytes_2comp_with_sign;F;[ ;[[@# i=;T;:"test_numbytes_2comp_with_sign;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ ;.@B ; I"static VALUE;T;/I"/static VALUE
rb_integer_test_numbytes_2comp_with_sign(VALUE val)
{
int neg = FIXNUM_P(val) ? FIX2LONG(val) < 0 : BIGNUM_NEGATIVE_P(val);
int nlz_bits;
size_t size = rb_absint_size(val, &nlz_bits);
if (nlz_bits == 0 && !(neg && rb_absint_singlebit_p(val)))
size++;
return SIZET2NUM(size);
};T;0To;
; F; ;
;;;I" Integer#big2str_generic;F;[[I"
vbase;T0;[[I" ext/-test-/bignum/big2str.c;Ti;T;:big2str_generic;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ ;.@B ; I"static VALUE;T;/I"static VALUE
big2str_generic(VALUE x, VALUE vbase)
{
int base = NUM2INT(vbase);
if (base < 2 || 36 < base)
rb_raise(rb_eArgError, "invalid radix %d", base);
return rb_big2str_generic(big(x), base);
};T;0To;
; F; ;
;;;I" Integer#big2str_poweroftwo;F;[[I"
vbase;T0;[[@ i ;T;:big2str_poweroftwo;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ ;.@B ; I"static VALUE;T;/I"static VALUE
big2str_poweroftwo(VALUE x, VALUE vbase)
{
int base = NUM2INT(vbase);
if (base < 2 || 36 < base || !POW2_P(base))
rb_raise(rb_eArgError, "invalid radix %d", base);
return rb_big2str_poweroftwo(big(x), base);
};T;0To;
; F; ;
;;;I"Integer#big2str_gmp;F;[[I"
vbase;T0;[[@ i(;T;:big2str_gmp;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ ;.@B ; I"static VALUE;T;/I"static VALUE
big2str_gmp(VALUE x, VALUE vbase)
{
int base = NUM2INT(vbase);
if (base < 2 || 36 < base)
rb_raise(rb_eArgError, "invalid radix %d", base);
return rb_big2str_gmp(big(x), base);
};T;0To;
; F; ;
;;;I"Integer#big_mul_normal;F;[[I"y;T0;[[I" ext/-test-/bignum/mul.c;Ti;T;:big_mul_normal;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ ;.@B ; I"static VALUE;T;/I"mstatic VALUE
mul_normal(VALUE x, VALUE y)
{
return rb_big_norm(rb_big_mul_normal(big(x), big(y)));
};T;0To;
; F; ;
;;;I"Integer#big_sq_fast;F;[ ;[[@
i;T;:big_sq_fast;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ ;.@B ; I"static VALUE;T;/I"Vstatic VALUE
sq_fast(VALUE x)
{
return rb_big_norm(rb_big_sq_fast(big(x)));
};T;0To;
; F; ;
;;;I" Integer#big_mul_balance;F;[[I"y;T0;[[@
i ;T;:big_mul_balance;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@! ;.@B ; I"static VALUE;T;/I"ostatic VALUE
mul_balance(VALUE x, VALUE y)
{
return rb_big_norm(rb_big_mul_balance(big(x), big(y)));
};T;0To;
; F; ;
;;;I" Integer#big_mul_karatsuba;F;[[I"y;T0;[[@
i%;T;:big_mul_karatsuba;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@/ ;.@B ; I"static VALUE;T;/I"sstatic VALUE
mul_karatsuba(VALUE x, VALUE y)
{
return rb_big_norm(rb_big_mul_karatsuba(big(x), big(y)));
};T;0To;
; F; ;
;;;I"Integer#big_mul_toom3;F;[[I"y;T0;[[@
i+;T;:big_mul_toom3;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@= ;.@B ; I"static VALUE;T;/I"kstatic VALUE
mul_toom3(VALUE x, VALUE y)
{
return rb_big_norm(rb_big_mul_toom3(big(x), big(y)));
};T;0To;
; F; ;
;;;I"Integer#big_mul_gmp;F;[[I"y;T0;[[@
i2;T;:big_mul_gmp;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@K ;.@B ; I"static VALUE;T;/I"gstatic VALUE
mul_gmp(VALUE x, VALUE y)
{
return rb_big_norm(rb_big_mul_gmp(big(x), big(y)));
};T;0T;N@B ;OIC;[ ;N@B ;PIC;[ ;N@B ;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i
[@i_;T;;;;X;;;[ ;{ ;IC;"fThis class is the basis for the two concrete classes that hold whole
numbers, Bignum and Fixnum.;T;[ ;#[ ;$I"j
This class is the basis for the two concrete classes that hold whole
numbers, Bignum and Fixnum.
;T;%0;"@B ;'F;(i ;)o;*;+T;,i
;-i
;.@;I" Integer;F;Y@@o; ;IC;[Ao;
; F; ;
;;;I"Float#numerator;F;[ ;[[@i`;T;;;0;[ ;{ ;IC;"Returns the numerator. The result is machine dependent.
n = 0.3.numerator #=> 5404319552844595
d = 0.3.denominator #=> 18014398509481984
n.fdiv(d) #=> 0.3
;T;[o;
; I"
overload;F; 0;;; 0; I"numerator;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@m ;#[ ;$I"@return [Integer];T;%0;"@m ;&0;'F;(i ;[ ;"@m ;#[ ;$I"Returns the numerator. The result is machine dependent.
n = 0.3.numerator #=> 5404319552844595
d = 0.3.denominator #=> 18014398509481984
n.fdiv(d) #=> 0.3
@overload numerator
@return [Integer];T;%0;"@m ;'F;)o;*;+T;,iV;-i^;.@k ; I"static VALUE;T;/I"static VALUE
float_numerator(VALUE self)
{
double d = RFLOAT_VALUE(self);
if (isinf(d) || isnan(d))
return self;
return rb_call_super(0, 0);
};T;0To;
; F; ;
;;;I"Float#denominator;F;[ ;[[@ir;T;;1;0;[ ;{ ;IC;"aReturns the denominator (always positive). The result is machine
dependent.
See numerator.
;T;[o;
; I"
overload;F; 0;;1; 0; I"denominator;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@ ;#[ ;$I"@return [Integer];T;%0;"@ ;&0;'F;(i ;[ ;"@ ;#[ ;$I"Returns the denominator (always positive). The result is machine
dependent.
See numerator.
@overload denominator
@return [Integer];T;%0;"@ ;'F;)o;*;+T;,ii;-ip;.@k ; I"static VALUE;T;/I"static VALUE
float_denominator(VALUE self)
{
double d = RFLOAT_VALUE(self);
if (isinf(d) || isnan(d))
return INT2FIX(1);
return rb_call_super(0, 0);
};T;0To;
; F; ;
;;;I"Float#to_r;F;[ ;[[@i;T;;F;0;[ ;{ ;IC;" Returns the value as a rational.
NOTE: 0.3.to_r isn't the same as '0.3'.to_r. The latter is
equivalent to '3/10'.to_r, but the former isn't so.
2.0.to_r #=> (2/1)
2.5.to_r #=> (5/2)
-0.75.to_r #=> (-3/4)
0.0.to_r #=> (0/1)
See rationalize.
;T;[o;
; I"
overload;F; 0;;F; 0; I" to_r;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ ;&0;'F;(i ;[ ;"@ ;#[ ;$I"Returns the value as a rational.
NOTE: 0.3.to_r isn't the same as '0.3'.to_r. The latter is
equivalent to '3/10'.to_r, but the former isn't so.
2.0.to_r #=> (2/1)
2.5.to_r #=> (5/2)
-0.75.to_r #=> (-3/4)
0.0.to_r #=> (0/1)
See rationalize.
@overload to_r;T;%0;"@ ;'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"|static VALUE
float_to_r(VALUE self)
{
VALUE f, n;
float_decode_internal(self, &f, &n);
#if FLT_RADIX == 2
{
long ln = FIX2LONG(n);
if (ln == 0)
return f_to_r(f);
if (ln > 0)
return f_to_r(f_lshift(f, n));
ln = -ln;
return rb_rational_new2(f, f_lshift(ONE, INT2FIX(ln)));
}
#else
return f_to_r(f_mul(f, f_expt(INT2FIX(FLT_RADIX), n)));
#endif
};T;0To;
; F; ;
;;;I"Float#rationalize;F;[[@0;[[@i7;T;;G;0;[ ;{ ;IC;"Returns a simpler approximation of the value (flt-|eps| <= result
<= flt+|eps|). if the optional eps is not given, it will be chosen
automatically.
0.3.rationalize #=> (3/10)
1.333.rationalize #=> (1333/1000)
1.333.rationalize(0.01) #=> (4/3)
See to_r.
;T;[o;
; I"
overload;F; 0;;G; 0; I"rationalize([eps]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ ;&0;'F;(i ;[[I"
[eps];T0;"@ ;#[ ;$I"8Returns a simpler approximation of the value (flt-|eps| <= result
<= flt+|eps|). if the optional eps is not given, it will be chosen
automatically.
0.3.rationalize #=> (3/10)
1.333.rationalize #=> (1333/1000)
1.333.rationalize(0.01) #=> (4/3)
See to_r.
@overload rationalize([eps]);T;%0;"@ ;'F;)o;*;+T;,i);-i4;.@k ; I"static VALUE;T;/I"istatic VALUE
float_rationalize(int argc, VALUE *argv, VALUE self)
{
VALUE e;
if (f_negative_p(self))
return f_negate(float_rationalize(argc, argv, f_abs(self)));
rb_scan_args(argc, argv, "01", &e);
if (argc != 0) {
return rb_flt_rationalize_with_prec(self, e);
}
else {
return rb_flt_rationalize(self);
}
};T;0To;;[[@i;F;: ROUNDS;;;;;[ ;{ ;IC;"-1:: Indeterminable
0:: Rounding towards zero
1:: Rounding to the nearest number
2:: Rounding towards positive infinity
3:: Rounding towards negative infinity
;T;[ ;#[ ;$I"-1:: Indeterminable
0:: Rounding towards zero
1:: Rounding to the nearest number
2:: Rounding towards positive infinity
3:: Rounding towards negative infinity
;T;%0;"@ ;'F;)o;*;+T;,i;-i;.@k ;I"Float::ROUNDS;F;I"Represents the rounding mode for floating point addition.
Usually defaults to 1, rounding to the nearest number.
Other modes include;To;;[[@i;F;:
RADIX;;;;;[ ;{ ;IC;"The base of the floating point, or number of unique digits used to
represent the number.
Usually defaults to 2 on most systems, which would represent a base-10 decimal.
;T;[ ;#[ ;$I"The base of the floating point, or number of unique digits used to
represent the number.
Usually defaults to 2 on most systems, which would represent a base-10 decimal.
;T;%0;"@ ;'F;)o;*;+T;,i;-i;.@k ;I"Float::RADIX;F;I"INT2FIX(FLT_RADIX);To;;[[@i;F;:
MANT_DIG;;;;;[ ;{ ;IC;"SThe number of base digits for the +double+ data type.
Usually defaults to 53.
;T;[ ;#[ ;$I"TThe number of base digits for the +double+ data type.
Usually defaults to 53.
;T;%0;"@ ;'F;)o;*;+T;,i;-i;.@k ;I"Float::MANT_DIG;F;I"INT2FIX(DBL_MANT_DIG);To;;[[@i;F;:DIG;;;;;[ ;{ ;IC;"tThe minimum number of significant decimal digits in a double-precision
floating point.
Usually defaults to 15.
;T;[ ;#[ ;$I"uThe minimum number of significant decimal digits in a double-precision
floating point.
Usually defaults to 15.
;T;%0;"@ ;'F;)o;*;+T;,i;-i;.@k ;I"Float::DIG;F;I"INT2FIX(DBL_DIG);To;;[[@i;F;: MIN_EXP;;;;;[ ;{ ;IC;"jThe smallest posable exponent value in a double-precision floating
point.
Usually defaults to -1021.
;T;[ ;#[ ;$I"kThe smallest posable exponent value in a double-precision floating
point.
Usually defaults to -1021.
;T;%0;"@!;'F;)o;*;+T;,i;-i;.@k ;I"Float::MIN_EXP;F;I"INT2FIX(DBL_MIN_EXP);To;;[[@i;F;: MAX_EXP;;;;;[ ;{ ;IC;"iThe largest possible exponent value in a double-precision floating
point.
Usually defaults to 1024.
;T;[ ;#[ ;$I"jThe largest possible exponent value in a double-precision floating
point.
Usually defaults to 1024.
;T;%0;"@!;'F;)o;*;+T;,i;-i;.@k ;I"Float::MAX_EXP;F;I"INT2FIX(DBL_MAX_EXP);To;;[[@i;F;:MIN_10_EXP;;;;;[ ;{ ;IC;"The smallest negative exponent in a double-precision floating point
where 10 raised to this power minus 1.
Usually defaults to -307.
;T;[ ;#[ ;$I"The smallest negative exponent in a double-precision floating point
where 10 raised to this power minus 1.
Usually defaults to -307.
;T;%0;"@!;'F;)o;*;+T;,i;-i;.@k ;I"Float::MIN_10_EXP;F;I" INT2FIX(DBL_MIN_10_EXP);To;;[[@i;F;:MAX_10_EXP;;;;;[ ;{ ;IC;"The largest positive exponent in a double-precision floating point where
10 raised to this power minus 1.
Usually defaults to 308.
;T;[ ;#[ ;$I"The largest positive exponent in a double-precision floating point where
10 raised to this power minus 1.
Usually defaults to 308.
;T;%0;"@&!;'F;)o;*;+T;,i;-i;.@k ;I"Float::MAX_10_EXP;F;I" INT2FIX(DBL_MAX_10_EXP);To;;[[@i;F;:MIN;;;;;[ ;{ ;IC;"m:MIN.
0.0.next_float returns the smallest positive floating point number
including denormalized numbers.
;T;[ ;#[ ;$I"n:MIN.
0.0.next_float returns the smallest positive floating point number
including denormalized numbers.
;T;%0;"@2!;'F;)o;*;+T;,i;-i;.@k ;I"Float::MIN;F;I"The smallest positive normalized number in a double-precision floating point.
Usually defaults to 2.2250738585072014e-308.
If the platform supports denormalized numbers,
there are numbers between zero and Float;To;;[[@i;F;:MAX;;;;;[ ;{ ;IC;"|The largest possible integer in a double-precision floating point number.
Usually defaults to 1.7976931348623157e+308.
;T;[ ;#[ ;$I"}The largest possible integer in a double-precision floating point number.
Usually defaults to 1.7976931348623157e+308.
;T;%0;"@>!;'F;)o;*;+T;,i;-i;.@k ;I"Float::MAX;F;I"DBL2NUM(DBL_MAX);To;;[[@i;F;: EPSILON;;;;;[ ;{ ;IC;"The difference between 1 and the smallest double-precision floating
point number greater than 1.
Usually defaults to 2.2204460492503131e-16.
;T;[ ;#[ ;$I"The difference between 1 and the smallest double-precision floating
point number greater than 1.
Usually defaults to 2.2204460492503131e-16.
;T;%0;"@J!;'F;)o;*;+T;,i;-i;.@k ;I"Float::EPSILON;F;I"DBL2NUM(DBL_EPSILON);To;;[[@i ;F;:
INFINITY;;;;;[ ;{ ;IC;"2An expression representing positive infinity.
;T;[ ;#[ ;$I"3An expression representing positive infinity.
;T;%0;"@V!;'F;)o;*;+T;,i;-i;.@k ;I"Float::INFINITY;F;I"DBL2NUM(INFINITY);To;;[[@i;F;:NAN;;;;;[ ;{ ;IC;"@An expression representing a value which is "not a number".
;T;[ ;#[ ;$I"AAn expression representing a value which is "not a number".
;T;%0;"@b!;'F;)o;*;+T;,i;-i;.@k ;I"Float::NAN;F;I"DBL2NUM(NAN);To;
; F; ;
;;;I"Float#to_s;F;[ ;[[@i;T;;I;0;[ ;{ ;IC;"Returns a string containing a representation of self. As well as a fixed or
exponential form of the +float+, the call may return +NaN+, +Infinity+, and
+-Infinity+.
;T;[o;
; I"
overload;F; 0;;I; 0; I" to_s;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@n!;#[ ;$I"@return [String];T;%0;"@n!;&0;'F;(i ;[ ;"@n!;#[ ;$I"Returns a string containing a representation of self. As well as a fixed or
exponential form of the +float+, the call may return +NaN+, +Infinity+, and
+-Infinity+.
@overload to_s
@return [String];T;%0;"o;
; F; ;
;;;I"Float#inspect;F;[ ;[[@i;F;;J;;X;[ ;{ ;@u!;.@k ; I"static VALUE;T;/I"ostatic VALUE
flo_to_s(VALUE flt)
{
enum {decimal_mant = DBL_MANT_DIG-DBL_DIG};
enum {float_dig = DBL_DIG+1};
char buf[float_dig + (decimal_mant + CHAR_BIT - 1) / CHAR_BIT + 10];
double value = RFLOAT_VALUE(flt);
VALUE s;
char *p, *e;
int sign, decpt, digs;
if (isinf(value))
return rb_usascii_str_new2(value < 0 ? "-Infinity" : "Infinity");
else if (isnan(value))
return rb_usascii_str_new2("NaN");
p = ruby_dtoa(value, 0, 0, &decpt, &sign, &e);
s = sign ? rb_usascii_str_new_cstr("-") : rb_usascii_str_new(0, 0);
if ((digs = (int)(e - p)) >= (int)sizeof(buf)) digs = (int)sizeof(buf) - 1;
memcpy(buf, p, digs);
xfree(p);
if (decpt > 0) {
if (decpt < digs) {
memmove(buf + decpt + 1, buf + decpt, digs - decpt);
buf[decpt] = '.';
rb_str_cat(s, buf, digs + 1);
}
else if (decpt <= DBL_DIG) {
long len;
char *ptr;
rb_str_cat(s, buf, digs);
rb_str_resize(s, (len = RSTRING_LEN(s)) + decpt - digs + 2);
ptr = RSTRING_PTR(s) + len;
if (decpt > digs) {
memset(ptr, '0', decpt - digs);
ptr += decpt - digs;
}
memcpy(ptr, ".0", 2);
}
else {
goto exp;
}
}
else if (decpt > -4) {
long len;
char *ptr;
rb_str_cat(s, "0.", 2);
rb_str_resize(s, (len = RSTRING_LEN(s)) - decpt + digs);
ptr = RSTRING_PTR(s);
memset(ptr += len, '0', -decpt);
memcpy(ptr -= decpt, buf, digs);
}
else {
exp:
if (digs > 1) {
memmove(buf + 2, buf + 1, digs - 1);
}
else {
buf[2] = '0';
digs++;
}
buf[1] = '.';
rb_str_cat(s, buf, digs + 1);
rb_str_catf(s, "e%+03d", decpt - 1);
}
return s;
};T;'F;)o;*;+T;,i;-i;.@k ; @!;/I"ostatic VALUE
flo_to_s(VALUE flt)
{
enum {decimal_mant = DBL_MANT_DIG-DBL_DIG};
enum {float_dig = DBL_DIG+1};
char buf[float_dig + (decimal_mant + CHAR_BIT - 1) / CHAR_BIT + 10];
double value = RFLOAT_VALUE(flt);
VALUE s;
char *p, *e;
int sign, decpt, digs;
if (isinf(value))
return rb_usascii_str_new2(value < 0 ? "-Infinity" : "Infinity");
else if (isnan(value))
return rb_usascii_str_new2("NaN");
p = ruby_dtoa(value, 0, 0, &decpt, &sign, &e);
s = sign ? rb_usascii_str_new_cstr("-") : rb_usascii_str_new(0, 0);
if ((digs = (int)(e - p)) >= (int)sizeof(buf)) digs = (int)sizeof(buf) - 1;
memcpy(buf, p, digs);
xfree(p);
if (decpt > 0) {
if (decpt < digs) {
memmove(buf + decpt + 1, buf + decpt, digs - decpt);
buf[decpt] = '.';
rb_str_cat(s, buf, digs + 1);
}
else if (decpt <= DBL_DIG) {
long len;
char *ptr;
rb_str_cat(s, buf, digs);
rb_str_resize(s, (len = RSTRING_LEN(s)) + decpt - digs + 2);
ptr = RSTRING_PTR(s) + len;
if (decpt > digs) {
memset(ptr, '0', decpt - digs);
ptr += decpt - digs;
}
memcpy(ptr, ".0", 2);
}
else {
goto exp;
}
}
else if (decpt > -4) {
long len;
char *ptr;
rb_str_cat(s, "0.", 2);
rb_str_resize(s, (len = RSTRING_LEN(s)) - decpt + digs);
ptr = RSTRING_PTR(s);
memset(ptr += len, '0', -decpt);
memcpy(ptr -= decpt, buf, digs);
}
else {
exp:
if (digs > 1) {
memmove(buf + 2, buf + 1, digs - 1);
}
else {
buf[2] = '0';
digs++;
}
buf[1] = '.';
rb_str_cat(s, buf, digs + 1);
rb_str_catf(s, "e%+03d", decpt - 1);
}
return s;
};T;0T@!o;
; F; ;
;;;I"Float#coerce;F;[[I"y;T0;[[@i ;T;;;;0;[ ;{ ;IC;"Returns an array with both a +numeric+ and a +float+ represented as Float
objects.
This is achieved by converting a +numeric+ to a Float.
1.2.coerce(3) #=> [3.0, 1.2]
2.5.coerce(1.1) #=> [1.1, 2.5]
;T;[o;
; I"
overload;F; 0;;;; 0; I"coerce(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@!;#[ ;$I"@return [Array];T;%0;"@!;&0;'F;(i ;[[I" numeric;T0;"@!;#[ ;$I"Returns an array with both a +numeric+ and a +float+ represented as Float
objects.
This is achieved by converting a +numeric+ to a Float.
1.2.coerce(3) #=> [3.0, 1.2]
2.5.coerce(1.1) #=> [1.1, 2.5]
@overload coerce(numeric)
@return [Array];T;%0;"@!;'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"[static VALUE
flo_coerce(VALUE x, VALUE y)
{
return rb_assoc_new(rb_Float(y), x);
};T;0To;
; F; ;
;;;I"
Float#-@;F;[ ;[[@i);T;;;0;[ ;{ ;IC;" Returns float, negated.
;T;[o;
; I"
overload;F; 0;;3; 0; I" -float;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@!;#[ ;$I"@return [Float];T;%0;"@!;&0;'F;(i ;[ ;"@!;#[ ;$I"AReturns float, negated.
@overload -float
@return [Float];T;%0;"@!;'F;)o;*;+T;,i";-i&;.@k ; I"static VALUE;T;/I"Sstatic VALUE
flo_uminus(VALUE flt)
{
return DBL2NUM(-RFLOAT_VALUE(flt));
};T;0To;
; F; ;
;;;I" Float#+;F;[[I"y;T0;[[@i6;T;;2;0;[ ;{ ;IC;"AReturns a new float which is the sum of +float+ and +other+.
;T;[o;
; I"
overload;F; 0;;2; 0; I"
+(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@!;#[ ;$I"@return [Float];T;%0;"@!;&0;'F;(i ;[[I"
other;T0;"@!;#[ ;$I"hReturns a new float which is the sum of +float+ and +other+.
@overload +(other)
@return [Float];T;%0;"@!;'F;)o;*;+T;,i/;-i3;.@k ; I"static VALUE;T;/I"static VALUE
flo_plus(VALUE x, VALUE y)
{
if (RB_TYPE_P(y, T_FIXNUM)) {
return DBL2NUM(RFLOAT_VALUE(x) + (double)FIX2LONG(y));
}
else if (RB_TYPE_P(y, T_BIGNUM)) {
return DBL2NUM(RFLOAT_VALUE(x) + rb_big2dbl(y));
}
else if (RB_TYPE_P(y, T_FLOAT)) {
return DBL2NUM(RFLOAT_VALUE(x) + RFLOAT_VALUE(y));
}
else {
return rb_num_coerce_bin(x, y, '+');
}
};T;0To;
; F; ;
;;;I" Float#-;F;[[I"y;T0;[[@iN;T;;3;0;[ ;{ ;IC;"HReturns a new float which is the difference of +float+ and +other+.
;T;[o;
; I"
overload;F; 0;;3; 0; I"
-(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@!;#[ ;$I"@return [Float];T;%0;"@!;&0;'F;(i ;[[I"
other;T0;"@!;#[ ;$I"oReturns a new float which is the difference of +float+ and +other+.
@overload -(other)
@return [Float];T;%0;"@!;'F;)o;*;+T;,iG;-iK;.@k ; I"static VALUE;T;/I"static VALUE
flo_minus(VALUE x, VALUE y)
{
if (RB_TYPE_P(y, T_FIXNUM)) {
return DBL2NUM(RFLOAT_VALUE(x) - (double)FIX2LONG(y));
}
else if (RB_TYPE_P(y, T_BIGNUM)) {
return DBL2NUM(RFLOAT_VALUE(x) - rb_big2dbl(y));
}
else if (RB_TYPE_P(y, T_FLOAT)) {
return DBL2NUM(RFLOAT_VALUE(x) - RFLOAT_VALUE(y));
}
else {
return rb_num_coerce_bin(x, y, '-');
}
};T;0To;
; F; ;
;;;I" Float#*;F;[[I"y;T0;[[@if;T;;4;0;[ ;{ ;IC;"EReturns a new float which is the product of +float+ and +other+.
;T;[o;
; I"
overload;F; 0;;4; 0; I"
*(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@ ";#[ ;$I"@return [Float];T;%0;"@ ";&0;'F;(i ;[[I"
other;T0;"@ ";#[ ;$I"lReturns a new float which is the product of +float+ and +other+.
@overload *(other)
@return [Float];T;%0;"@ ";'F;)o;*;+T;,i_;-ic;.@k ; I"static VALUE;T;/I"static VALUE
flo_mul(VALUE x, VALUE y)
{
if (RB_TYPE_P(y, T_FIXNUM)) {
return DBL2NUM(RFLOAT_VALUE(x) * (double)FIX2LONG(y));
}
else if (RB_TYPE_P(y, T_BIGNUM)) {
return DBL2NUM(RFLOAT_VALUE(x) * rb_big2dbl(y));
}
else if (RB_TYPE_P(y, T_FLOAT)) {
return DBL2NUM(RFLOAT_VALUE(x) * RFLOAT_VALUE(y));
}
else {
return rb_num_coerce_bin(x, y, '*');
}
};T;0To;
; F; ;
;;;I" Float#/;F;[[I"y;T0;[[@i~;T;;5;0;[ ;{ ;IC;"LReturns a new float which is the result of dividing +float+ by +other+.
;T;[o;
; I"
overload;F; 0;;5; 0; I"
/(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@(";#[ ;$I"@return [Float];T;%0;"@(";&0;'F;(i ;[[I"
other;T0;"@(";#[ ;$I"sReturns a new float which is the result of dividing +float+ by +other+.
@overload /(other)
@return [Float];T;%0;"@(";'F;)o;*;+T;,iw;-i{;.@k ; I"static VALUE;T;/I"static VALUE
flo_div(VALUE x, VALUE y)
{
long f_y;
double d;
if (RB_TYPE_P(y, T_FIXNUM)) {
f_y = FIX2LONG(y);
return DBL2NUM(RFLOAT_VALUE(x) / (double)f_y);
}
else if (RB_TYPE_P(y, T_BIGNUM)) {
d = rb_big2dbl(y);
return DBL2NUM(RFLOAT_VALUE(x) / d);
}
else if (RB_TYPE_P(y, T_FLOAT)) {
return DBL2NUM(RFLOAT_VALUE(x) / RFLOAT_VALUE(y));
}
else {
return rb_num_coerce_bin(x, y, '/');
}
};T;0To;
; F; ;
;;;I"Float#quo;F;[[I"y;T0;[[@i;T;;6;0;[ ;{ ;IC;";Returns float / numeric, same as Float#/.
;T;[o;
; I"
overload;F; 0;;7; 0; I"fdiv(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@G";#[ ;$I"@return [Float];T;%0;"@G";&0;'F;(i ;[[I" numeric;T0;"@G"o;
; I"
overload;F; 0;;6; 0; I"quo(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@G";#[ ;$I"@return [Float];T;%0;"@G";&0;'F;(i ;[[I" numeric;T0;"@G";#[ ;$I"Returns float / numeric, same as Float#/.
@overload fdiv(numeric)
@return [Float]
@overload quo(numeric)
@return [Float];T;%0;"@G";'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"Tstatic VALUE
flo_quo(VALUE x, VALUE y)
{
return rb_funcall(x, '/', 1, y);
};T;0To;
; F; ;
;;;I"Float#fdiv;F;[[I"y;T0;[[@i;T;;7;0;[ ;{ ;IC;";Returns float / numeric, same as Float#/.
;T;[o;
; I"
overload;F; 0;;7; 0; I"fdiv(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@u";#[ ;$I"@return [Float];T;%0;"@u";&0;'F;(i ;[[I" numeric;T0;"@u"o;
; I"
overload;F; 0;;6; 0; I"quo(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@u";#[ ;$I"@return [Float];T;%0;"@u";&0;'F;(i ;[[I" numeric;T0;"@u";#[ ;$@q";%0;"@u";'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"Tstatic VALUE
flo_quo(VALUE x, VALUE y)
{
return rb_funcall(x, '/', 1, y);
};T;0To;
; F; ;
;;;I" Float#%;F;[[I"y;T0;[[@i;T;;;0;[ ;{ ;IC;"Return the modulo after division of +float+ by +other+.
6543.21.modulo(137) #=> 104.21
6543.21.modulo(137.24) #=> 92.9299999999996
;T;[o;
; I"
overload;F; 0;;; 0; I"
%(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@";#[ ;$I"@return [Float];T;%0;"@";&0;'F;(i ;[[I"
other;T0;"@"o;
; I"
overload;F; 0;;; 0; I"modulo(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@";#[ ;$I"@return [Float];T;%0;"@";&0;'F;(i ;[[I"
other;T0;"@";#[ ;$I"Return the modulo after division of +float+ by +other+.
6543.21.modulo(137) #=> 104.21
6543.21.modulo(137.24) #=> 92.9299999999996
@overload %(other)
@return [Float]
@overload modulo(other)
@return [Float];T;%0;"@";'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"rstatic VALUE
flo_mod(VALUE x, VALUE y)
{
double fy;
if (RB_TYPE_P(y, T_FIXNUM)) {
fy = (double)FIX2LONG(y);
}
else if (RB_TYPE_P(y, T_BIGNUM)) {
fy = rb_big2dbl(y);
}
else if (RB_TYPE_P(y, T_FLOAT)) {
fy = RFLOAT_VALUE(y);
}
else {
return rb_num_coerce_bin(x, y, '%');
}
return DBL2NUM(ruby_float_mod(RFLOAT_VALUE(x), fy));
};T;0To;
; F; ;
;;;I"Float#modulo;F;[[I"y;T0;[[@i;T;;;0;[ ;{ ;IC;"Return the modulo after division of +float+ by +other+.
6543.21.modulo(137) #=> 104.21
6543.21.modulo(137.24) #=> 92.9299999999996
;T;[o;
; I"
overload;F; 0;;; 0; I"
%(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@";#[ ;$I"@return [Float];T;%0;"@";&0;'F;(i ;[[I"
other;T0;"@"o;
; I"
overload;F; 0;;; 0; I"modulo(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@";#[ ;$I"@return [Float];T;%0;"@";&0;'F;(i ;[[I"
other;T0;"@";#[ ;$@";%0;"@";'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"rstatic VALUE
flo_mod(VALUE x, VALUE y)
{
double fy;
if (RB_TYPE_P(y, T_FIXNUM)) {
fy = (double)FIX2LONG(y);
}
else if (RB_TYPE_P(y, T_BIGNUM)) {
fy = rb_big2dbl(y);
}
else if (RB_TYPE_P(y, T_FLOAT)) {
fy = RFLOAT_VALUE(y);
}
else {
return rb_num_coerce_bin(x, y, '%');
}
return DBL2NUM(ruby_float_mod(RFLOAT_VALUE(x), fy));
};T;0To;
; F; ;
;;;I"Float#divmod;F;[[I"y;T0;[[@i;T;;;0;[ ;{ ;IC;"WSee Numeric#divmod.
42.0.divmod 6 #=> [7, 0.0]
42.0.divmod 5 #=> [8, 2.0]
;T;[o;
; I"
overload;F; 0;;; 0; I"divmod(numeric);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@";#[ ;$I"@return [Array];T;%0;"@";&0;'F;(i ;[[I" numeric;T0;"@";#[ ;$I"See Numeric#divmod.
42.0.divmod 6 #=> [7, 0.0]
42.0.divmod 5 #=> [8, 2.0]
@overload divmod(numeric)
@return [Array];T;%0;"@";'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"static VALUE
flo_divmod(VALUE x, VALUE y)
{
double fy, div, mod;
volatile VALUE a, b;
if (RB_TYPE_P(y, T_FIXNUM)) {
fy = (double)FIX2LONG(y);
}
else if (RB_TYPE_P(y, T_BIGNUM)) {
fy = rb_big2dbl(y);
}
else if (RB_TYPE_P(y, T_FLOAT)) {
fy = RFLOAT_VALUE(y);
}
else {
return rb_num_coerce_bin(x, y, id_divmod);
}
flodivmod(RFLOAT_VALUE(x), fy, &div, &mod);
a = dbl2ival(div);
b = DBL2NUM(mod);
return rb_assoc_new(a, b);
};T;0To;
; F; ;
;;;I"
Float#**;F;[[I"y;T0;[[@i);T;;8;0;[ ;{ ;IC;"DRaises +float+ to the power of +other+.
2.0**3 #=> 8.0
;T;[o;
; I"
overload;F; 0;;8; 0; I"**(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@ #;#[ ;$I"@return [Float];T;%0;"@ #;&0;'F;(i ;[[I"
other;T0;"@ #;#[ ;$I"lRaises +float+ to the power of +other+.
2.0**3 #=> 8.0
@overload **(other)
@return [Float];T;%0;"@ #;'F;)o;*;+T;,i ;-i%;.@k ; I"static VALUE;T;/I"static VALUE
flo_pow(VALUE x, VALUE y)
{
double dx, dy;
if (RB_TYPE_P(y, T_FIXNUM)) {
dx = RFLOAT_VALUE(x);
dy = (double)FIX2LONG(y);
}
else if (RB_TYPE_P(y, T_BIGNUM)) {
dx = RFLOAT_VALUE(x);
dy = rb_big2dbl(y);
}
else if (RB_TYPE_P(y, T_FLOAT)) {
dx = RFLOAT_VALUE(x);
dy = RFLOAT_VALUE(y);
if (dx < 0 && dy != round(dy))
return rb_funcall(rb_complex_raw1(x), idPow, 1, y);
}
else {
return rb_num_coerce_bin(x, y, idPow);
}
return DBL2NUM(pow(dx, dy));
};T;0To;
; F; ;
;;;I"
Float#==;F;[[I"y;T0;[[@iy;T;;:;0;[ ;{ ;IC;"Returns +true+ only if +obj+ has the same value as +float+. Contrast this
with Float#eql?, which requires obj to be a Float.
The result of NaN == NaN is undefined, so the
implementation-dependent value is returned.
1.0 == 1 #=> true
;T;[o;
; I"
overload;F; 0;;:; 0; I" ==(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@;#;#[ ;$I"@return [Boolean];T;%0;"@;#;&0;'F;(i ;[[I"obj;T0;"@;#;#[ ;$I"%Returns +true+ only if +obj+ has the same value as +float+. Contrast this
with Float#eql?, which requires obj to be a Float.
The result of NaN == NaN is undefined, so the
implementation-dependent value is returned.
1.0 == 1 #=> true
@overload ==(obj)
@return [Boolean];T;%0;"@;#;'F;)o;*;+T;,ik;-iv;.@k ; I"static VALUE;T;/I"static VALUE
flo_eq(VALUE x, VALUE y)
{
volatile double a, b;
if (RB_TYPE_P(y, T_FIXNUM) || RB_TYPE_P(y, T_BIGNUM)) {
return rb_integer_float_eq(y, x);
}
else if (RB_TYPE_P(y, T_FLOAT)) {
b = RFLOAT_VALUE(y);
#if defined(_MSC_VER) && _MSC_VER < 1300
if (isnan(b)) return Qfalse;
#endif
}
else {
return num_equal(x, y);
}
a = RFLOAT_VALUE(x);
#if defined(_MSC_VER) && _MSC_VER < 1300
if (isnan(a)) return Qfalse;
#endif
return (a == b)?Qtrue:Qfalse;
};T;0To;
; F; ;
;;;I"Float#===;F;[[I"y;T0;[[@iy;T;;n;0;[ ;{ ;IC;"Returns +true+ only if +obj+ has the same value as +float+. Contrast this
with Float#eql?, which requires obj to be a Float.
The result of NaN == NaN is undefined, so the
implementation-dependent value is returned.
1.0 == 1 #=> true
;T;[o;
; I"
overload;F; 0;;:; 0; I" ==(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@Z#;#[ ;$I"@return [Boolean];T;%0;"@Z#;&0;'F;(i ;[[I"obj;T0;"@Z#;#[ ;$@V#;%0;"@Z#;'F;)o;*;+T;,ik;-iv;.@k ; I"static VALUE;T;/I"static VALUE
flo_eq(VALUE x, VALUE y)
{
volatile double a, b;
if (RB_TYPE_P(y, T_FIXNUM) || RB_TYPE_P(y, T_BIGNUM)) {
return rb_integer_float_eq(y, x);
}
else if (RB_TYPE_P(y, T_FLOAT)) {
b = RFLOAT_VALUE(y);
#if defined(_MSC_VER) && _MSC_VER < 1300
if (isnan(b)) return Qfalse;
#endif
}
else {
return num_equal(x, y);
}
a = RFLOAT_VALUE(x);
#if defined(_MSC_VER) && _MSC_VER < 1300
if (isnan(a)) return Qfalse;
#endif
return (a == b)?Qtrue:Qfalse;
};T;0To;
; F; ;
;;;I"Float#<=>;F;[[I"y;T0;[[@i;T;;9;0;[ ;{ ;IC;"4Returns -1, 0, +1 or nil depending on whether +float+ is less than, equal
to, or greater than +real+. This is the basis for the tests in Comparable.
The result of NaN <=> NaN is undefined, so the
implementation-dependent value is returned.
+nil+ is returned if the two values are incomparable.
;T;[o;
; I"
overload;F; 0;;9; 0; I"<=>(real);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [ I"-1;TI"0;TI"+1;TI"nil;T;"@x#;#[ ;$I" @return [ -1, 0, +1, nil];T;%0;"@x#;&0;'F;(i ;[[I" real;T0;"@x#;#[ ;$I"hReturns -1, 0, +1 or nil depending on whether +float+ is less than, equal
to, or greater than +real+. This is the basis for the tests in Comparable.
The result of NaN <=> NaN is undefined, so the
implementation-dependent value is returned.
+nil+ is returned if the two values are incomparable.
@overload <=>(real)
@return [ -1, 0, +1, nil];T;%0;"@x#;'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"static VALUE
flo_cmp(VALUE x, VALUE y)
{
double a, b;
VALUE i;
a = RFLOAT_VALUE(x);
if (isnan(a)) return Qnil;
if (RB_TYPE_P(y, T_FIXNUM) || RB_TYPE_P(y, T_BIGNUM)) {
VALUE rel = rb_integer_float_cmp(y, x);
if (FIXNUM_P(rel))
return INT2FIX(-FIX2INT(rel));
return rel;
}
else if (RB_TYPE_P(y, T_FLOAT)) {
b = RFLOAT_VALUE(y);
}
else {
if (isinf(a) && (i = rb_check_funcall(y, rb_intern("infinite?"), 0, 0)) != Qundef) {
if (RTEST(i)) {
int j = rb_cmpint(i, x, y);
j = (a > 0.0) ? (j > 0 ? 0 : +1) : (j < 0 ? 0 : -1);
return INT2FIX(j);
}
if (a > 0.0) return INT2FIX(1);
return INT2FIX(-1);
}
return rb_num_coerce_cmp(x, y, id_cmp);
}
return rb_dbl_cmp(a, b);
};T;0To;
; F; ;
;;;I" Float#>;F;[[I"y;T0;[[@i;T;;
;0;[ ;{ ;IC;"Returns +true+ if +float+ is greater than +real+.
The result of NaN > NaN is undefined, so the
implementation-dependent value is returned.
;T;[o;
; I"
overload;F; 0;;
; 0; I" >(real);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@#;#[ ;$I"@return [Boolean];T;%0;"@#;&0;'F;(i ;[[I" real;T0;"@#;#[ ;$I"Returns +true+ if +float+ is greater than +real+.
The result of NaN > NaN is undefined, so the
implementation-dependent value is returned.
@overload >(real)
@return [Boolean];T;%0;"@#;'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"jstatic VALUE
flo_gt(VALUE x, VALUE y)
{
double a, b;
a = RFLOAT_VALUE(x);
if (RB_TYPE_P(y, T_FIXNUM) || RB_TYPE_P(y, T_BIGNUM)) {
VALUE rel = rb_integer_float_cmp(y, x);
if (FIXNUM_P(rel))
return -FIX2INT(rel) > 0 ? Qtrue : Qfalse;
return Qfalse;
}
else if (RB_TYPE_P(y, T_FLOAT)) {
b = RFLOAT_VALUE(y);
#if defined(_MSC_VER) && _MSC_VER < 1300
if (isnan(b)) return Qfalse;
#endif
}
else {
return rb_num_coerce_relop(x, y, '>');
}
#if defined(_MSC_VER) && _MSC_VER < 1300
if (isnan(a)) return Qfalse;
#endif
return (a > b)?Qtrue:Qfalse;
};T;0To;
; F; ;
;;;I"
Float#>=;F;[[I"y;T0;[[@i;T;; ;0;[ ;{ ;IC;"Returns +true+ if +float+ is greater than or equal to +real+.
The result of NaN >= NaN is undefined, so the
implementation-dependent value is returned.
;T;[o;
; I"
overload;F; 0;; ; 0; I"
>=(real);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@#;#[ ;$I"@return [Boolean];T;%0;"@#;&0;'F;(i ;[[I" real;T0;"@#;#[ ;$I"Returns +true+ if +float+ is greater than or equal to +real+.
The result of NaN >= NaN is undefined, so the
implementation-dependent value is returned.
@overload >=(real)
@return [Boolean];T;%0;"@#;'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"mstatic VALUE
flo_ge(VALUE x, VALUE y)
{
double a, b;
a = RFLOAT_VALUE(x);
if (RB_TYPE_P(y, T_FIXNUM) || RB_TYPE_P(y, T_BIGNUM)) {
VALUE rel = rb_integer_float_cmp(y, x);
if (FIXNUM_P(rel))
return -FIX2INT(rel) >= 0 ? Qtrue : Qfalse;
return Qfalse;
}
else if (RB_TYPE_P(y, T_FLOAT)) {
b = RFLOAT_VALUE(y);
#if defined(_MSC_VER) && _MSC_VER < 1300
if (isnan(b)) return Qfalse;
#endif
}
else {
return rb_num_coerce_relop(x, y, idGE);
}
#if defined(_MSC_VER) && _MSC_VER < 1300
if (isnan(a)) return Qfalse;
#endif
return (a >= b)?Qtrue:Qfalse;
};T;0To;
; F; ;
;;;I" Float#<;F;[[I"y;T0;[[@i6;T;; ;0;[ ;{ ;IC;"Returns +true+ if +float+ is less than +real+.
The result of NaN < NaN is undefined, so the
implementation-dependent value is returned.
;T;[o;
; I"
overload;F; 0;; ; 0; I" <(real);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@#;#[ ;$I"@return [Boolean];T;%0;"@#;&0;'F;(i ;[[I" real;T0;"@#;#[ ;$I"Returns +true+ if +float+ is less than +real+.
The result of NaN < NaN is undefined, so the
implementation-dependent value is returned.
@overload <(real)
@return [Boolean];T;%0;"@#;'F;)o;*;+T;,i,;-i3;.@k ; I"static VALUE;T;/I"jstatic VALUE
flo_lt(VALUE x, VALUE y)
{
double a, b;
a = RFLOAT_VALUE(x);
if (RB_TYPE_P(y, T_FIXNUM) || RB_TYPE_P(y, T_BIGNUM)) {
VALUE rel = rb_integer_float_cmp(y, x);
if (FIXNUM_P(rel))
return -FIX2INT(rel) < 0 ? Qtrue : Qfalse;
return Qfalse;
}
else if (RB_TYPE_P(y, T_FLOAT)) {
b = RFLOAT_VALUE(y);
#if defined(_MSC_VER) && _MSC_VER < 1300
if (isnan(b)) return Qfalse;
#endif
}
else {
return rb_num_coerce_relop(x, y, '<');
}
#if defined(_MSC_VER) && _MSC_VER < 1300
if (isnan(a)) return Qfalse;
#endif
return (a < b)?Qtrue:Qfalse;
};T;0To;
; F; ;
;;;I"
Float#<=;F;[[I"y;T0;[[@i[;T;;
;0;[ ;{ ;IC;"Returns +true+ if +float+ is less than or equal to +real+.
The result of NaN <= NaN is undefined, so the
implementation-dependent value is returned.
;T;[o;
; I"
overload;F; 0;;
; 0; I"
<=(real);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@#;#[ ;$I"@return [Boolean];T;%0;"@#;&0;'F;(i ;[[I" real;T0;"@#;#[ ;$I"Returns +true+ if +float+ is less than or equal to +real+.
The result of NaN <= NaN is undefined, so the
implementation-dependent value is returned.
@overload <=(real)
@return [Boolean];T;%0;"@#;'F;)o;*;+T;,iQ;-iX;.@k ; I"static VALUE;T;/I"mstatic VALUE
flo_le(VALUE x, VALUE y)
{
double a, b;
a = RFLOAT_VALUE(x);
if (RB_TYPE_P(y, T_FIXNUM) || RB_TYPE_P(y, T_BIGNUM)) {
VALUE rel = rb_integer_float_cmp(y, x);
if (FIXNUM_P(rel))
return -FIX2INT(rel) <= 0 ? Qtrue : Qfalse;
return Qfalse;
}
else if (RB_TYPE_P(y, T_FLOAT)) {
b = RFLOAT_VALUE(y);
#if defined(_MSC_VER) && _MSC_VER < 1300
if (isnan(b)) return Qfalse;
#endif
}
else {
return rb_num_coerce_relop(x, y, idLE);
}
#if defined(_MSC_VER) && _MSC_VER < 1300
if (isnan(a)) return Qfalse;
#endif
return (a <= b)?Qtrue:Qfalse;
};T;0To;
; F; ;
;;;I"Float#eql?;F;[[I"y;T0;[[@i;T;;q;0;[ ;{ ;IC;" Returns +true+ only if +obj+ is a Float with the same value as +float+.
Contrast this with Float#==, which performs type conversions.
The result of NaN.eql?(NaN) is undefined, so the
implementation-dependent value is returned.
1.0.eql?(1) #=> false
;T;[o;
; I"
overload;F; 0;;q; 0; I"eql?(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@$;#[ ;$I"@return [Boolean];T;%0;"@$;&0;'F;(i ;[[I"obj;T0;"@$o;!
; I" return;F; @;0; [@;"@$;#[ ;$I"6Returns +true+ only if +obj+ is a Float with the same value as +float+.
Contrast this with Float#==, which performs type conversions.
The result of NaN.eql?(NaN) is undefined, so the
implementation-dependent value is returned.
1.0.eql?(1) #=> false
@overload eql?(obj)
@return [Boolean];T;%0;"@$;'F;)o;*;+T;,iv;-i;.@k ; I"static VALUE;T;/I"static VALUE
flo_eql(VALUE x, VALUE y)
{
if (RB_TYPE_P(y, T_FLOAT)) {
double a = RFLOAT_VALUE(x);
double b = RFLOAT_VALUE(y);
#if defined(_MSC_VER) && _MSC_VER < 1300
if (isnan(a) || isnan(b)) return Qfalse;
#endif
if (a == b)
return Qtrue;
}
return Qfalse;
};T;0To;
; F; ;
;;;I"Float#hash;F;[ ;[[@i;T;;H;0;[ ;{ ;IC;"?Returns a hash code for this float.
See also Object#hash.
;T;[o;
; I"
overload;F; 0;;H; 0; I" hash;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@8$;#[ ;$I"@return [Integer];T;%0;"@8$;&0;'F;(i ;[ ;"@8$;#[ ;$I"dReturns a hash code for this float.
See also Object#hash.
@overload hash
@return [Integer];T;%0;"@8$;'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"Tstatic VALUE
flo_hash(VALUE num)
{
return rb_dbl_hash(RFLOAT_VALUE(num));
};T;0To;
; F; ;
;;;I"Float#to_f;F;[ ;[[@i;T;;E;0;[ ;{ ;IC;"6Since +float+ is already a float, returns +self+.
;T;[o;
; I"
overload;F; 0;;E; 0; I" to_f;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" self;T;"@S$;#[ ;$I"@return [self];T;%0;"@S$;&0;'F;(i ;[ ;"@S$;#[ ;$I"XSince +float+ is already a float, returns +self+.
@overload to_f
@return [self];T;%0;"@S$;'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"9static VALUE
flo_to_f(VALUE num)
{
return num;
};T;0To;
; F; ;
;;;I"Float#abs;F;[ ;[[@i;T;;;0;[ ;{ ;IC;"dReturns the absolute value of +float+.
(-34.56).abs #=> 34.56
-34.56.abs #=> 34.56
;T;[o;
; I"
overload;F; 0;;; 0; I"abs;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@n$;#[ ;$I"@return [Float];T;%0;"@n$;&0;'F;(i ;[ ;"@n$o;
; I"
overload;F; 0;;; 0; I"magnitude;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@n$;#[ ;$I"@return [Float];T;%0;"@n$;&0;'F;(i ;[ ;"@n$;#[ ;$I"Returns the absolute value of +float+.
(-34.56).abs #=> 34.56
-34.56.abs #=> 34.56
@overload abs
@return [Float]
@overload magnitude
@return [Float];T;%0;"@n$;'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"kstatic VALUE
flo_abs(VALUE flt)
{
double val = fabs(RFLOAT_VALUE(flt));
return DBL2NUM(val);
};T;0To;
; F; ;
;;;I"Float#magnitude;F;[ ;[[@i;T;;;0;[ ;{ ;IC;"dReturns the absolute value of +float+.
(-34.56).abs #=> 34.56
-34.56.abs #=> 34.56
;T;[o;
; I"
overload;F; 0;;; 0; I"abs;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@$;#[ ;$I"@return [Float];T;%0;"@$;&0;'F;(i ;[ ;"@$o;
; I"
overload;F; 0;;; 0; I"magnitude;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@$;#[ ;$I"@return [Float];T;%0;"@$;&0;'F;(i ;[ ;"@$;#[ ;$@$;%0;"@$;'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"kstatic VALUE
flo_abs(VALUE flt)
{
double val = fabs(RFLOAT_VALUE(flt));
return DBL2NUM(val);
};T;0To;
; F; ;
;;;I"Float#zero?;F;[ ;[[@i;T;;;0;[ ;{ ;IC;"&Returns +true+ if +float+ is 0.0.
;T;[o;
; I"
overload;F; 0;;; 0; I"
zero?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@$;#[ ;$I"@return [Boolean];T;%0;"@$;&0;'F;(i ;[ ;"@$o;!
; I" return;F; @;0; [@;"@$;#[ ;$I"MReturns +true+ if +float+ is 0.0.
@overload zero?
@return [Boolean];T;%0;"@$;'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"wstatic VALUE
flo_zero_p(VALUE num)
{
if (RFLOAT_VALUE(num) == 0.0) {
return Qtrue;
}
return Qfalse;
};T;0To;
; F; ;
;;;I"Float#to_i;F;[ ;[[@i5;T;;D;0;[ ;{ ;IC;"^Returns the +float+ truncated to an Integer.
Synonyms are #to_i, #to_int, and #truncate.
;T;[o;
; I"
overload;F; 0;;D; 0; I" to_i;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@$;#[ ;$I"@return [Integer];T;%0;"@$;&0;'F;(i ;[ ;"@$o;
; I"
overload;F; 0;;; 0; I" to_int;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@$;#[ ;$I"@return [Integer];T;%0;"@$;&0;'F;(i ;[ ;"@$o;
; I"
overload;F; 0;;B; 0; I"
truncate;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@$;#[ ;$I"@return [Integer];T;%0;"@$;&0;'F;(i ;[ ;"@$;#[ ;$I"Returns the +float+ truncated to an Integer.
Synonyms are #to_i, #to_int, and #truncate.
@overload to_i
@return [Integer]
@overload to_int
@return [Integer]
@overload truncate
@return [Integer];T;%0;"@$;'F;)o;*;+T;,i*;-i4;.@k ; I"static VALUE;T;/I"static VALUE
flo_truncate(VALUE num)
{
double f = RFLOAT_VALUE(num);
long val;
if (f > 0.0) f = floor(f);
if (f < 0.0) f = ceil(f);
if (!FIXABLE(f)) {
return rb_dbl2big(f);
}
val = (long)f;
return LONG2FIX(val);
};T;0To;
; F; ;
;;;I"Float#to_int;F;[ ;[[@i5;T;;;0;[ ;{ ;IC;"^Returns the +float+ truncated to an Integer.
Synonyms are #to_i, #to_int, and #truncate.
;T;[o;
; I"
overload;F; 0;;D; 0; I" to_i;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@%;#[ ;$I"@return [Integer];T;%0;"@%;&0;'F;(i ;[ ;"@%o;
; I"
overload;F; 0;;; 0; I" to_int;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@%;#[ ;$I"@return [Integer];T;%0;"@%;&0;'F;(i ;[ ;"@%o;
; I"
overload;F; 0;;B; 0; I"
truncate;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@%;#[ ;$I"@return [Integer];T;%0;"@%;&0;'F;(i ;[ ;"@%;#[ ;$@ %;%0;"@%;'F;)o;*;+T;,i*;-i4;.@k ; I"static VALUE;T;/I"static VALUE
flo_truncate(VALUE num)
{
double f = RFLOAT_VALUE(num);
long val;
if (f > 0.0) f = floor(f);
if (f < 0.0) f = ceil(f);
if (!FIXABLE(f)) {
return rb_dbl2big(f);
}
val = (long)f;
return LONG2FIX(val);
};T;0To;
; F; ;
;;;I"Float#floor;F;[ ;[[@i;T;;@;0;[ ;{ ;IC;"Returns the largest integer less than or equal to +float+.
1.2.floor #=> 1
2.0.floor #=> 2
(-1.2).floor #=> -2
(-2.0).floor #=> -2
;T;[o;
; I"
overload;F; 0;;@; 0; I"
floor;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@D%;#[ ;$I"@return [Integer];T;%0;"@D%;&0;'F;(i ;[ ;"@D%;#[ ;$I"Returns the largest integer less than or equal to +float+.
1.2.floor #=> 1
2.0.floor #=> 2
(-1.2).floor #=> -2
(-2.0).floor #=> -2
@overload floor
@return [Integer];T;%0;"@D%;'F;)o;*;+T;,i~;-i;.@k ; I"static VALUE;T;/I"static VALUE
flo_floor(VALUE num)
{
double f = floor(RFLOAT_VALUE(num));
long val;
if (!FIXABLE(f)) {
return rb_dbl2big(f);
}
val = (long)f;
return LONG2FIX(val);
};T;0To;
; F; ;
;;;I"Float#ceil;F;[ ;[[@i;T;;A;0;[ ;{ ;IC;"Returns the smallest Integer greater than or equal to +float+.
1.2.ceil #=> 2
2.0.ceil #=> 2
(-1.2).ceil #=> -1
(-2.0).ceil #=> -2
;T;[o;
; I"
overload;F; 0;;A; 0; I" ceil;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@_%;#[ ;$I"@return [Integer];T;%0;"@_%;&0;'F;(i ;[ ;"@_%;#[ ;$I"Returns the smallest Integer greater than or equal to +float+.
1.2.ceil #=> 2
2.0.ceil #=> 2
(-1.2).ceil #=> -1
(-2.0).ceil #=> -2
@overload ceil
@return [Integer];T;%0;"@_%;'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"static VALUE
flo_ceil(VALUE num)
{
double f = ceil(RFLOAT_VALUE(num));
long val;
if (!FIXABLE(f)) {
return rb_dbl2big(f);
}
val = (long)f;
return LONG2FIX(val);
};T;0To;
; F; ;
;;;I"Float#round;F;[[@0;[[@i;T;;C;0;[ ;{ ;IC;"Rounds +float+ to a given precision in decimal digits (default 0 digits).
Precision may be negative. Returns a floating point number when +ndigits+
is more than zero.
1.4.round #=> 1
1.5.round #=> 2
1.6.round #=> 2
(-1.5).round #=> -2
1.234567.round(2) #=> 1.23
1.234567.round(3) #=> 1.235
1.234567.round(4) #=> 1.2346
1.234567.round(5) #=> 1.23457
34567.89.round(-5) #=> 0
34567.89.round(-4) #=> 30000
34567.89.round(-3) #=> 35000
34567.89.round(-2) #=> 34600
34567.89.round(-1) #=> 34570
34567.89.round(0) #=> 34568
34567.89.round(1) #=> 34567.9
34567.89.round(2) #=> 34567.89
34567.89.round(3) #=> 34567.89
;T;[o;
; I"
overload;F; 0;;C; 0; I"round([ndigits]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;TI"
Float;T;"@z%;#[ ;$I" @return [Integer, Float];T;%0;"@z%;&0;'F;(i ;[[I"[ndigits];T0;"@z%;#[ ;$I"Rounds +float+ to a given precision in decimal digits (default 0 digits).
Precision may be negative. Returns a floating point number when +ndigits+
is more than zero.
1.4.round #=> 1
1.5.round #=> 2
1.6.round #=> 2
(-1.5).round #=> -2
1.234567.round(2) #=> 1.23
1.234567.round(3) #=> 1.235
1.234567.round(4) #=> 1.2346
1.234567.round(5) #=> 1.23457
34567.89.round(-5) #=> 0
34567.89.round(-4) #=> 30000
34567.89.round(-3) #=> 35000
34567.89.round(-2) #=> 34600
34567.89.round(-1) #=> 34570
34567.89.round(0) #=> 34568
34567.89.round(1) #=> 34567.9
34567.89.round(2) #=> 34567.89
34567.89.round(3) #=> 34567.89
@overload round([ndigits])
@return [Integer, Float];T;%0;"@z%;'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"ystatic VALUE
flo_round(int argc, VALUE *argv, VALUE num)
{
VALUE nd;
double number, f;
int ndigits = 0;
int binexp;
enum {float_dig = DBL_DIG+2};
if (argc > 0 && rb_scan_args(argc, argv, "01", &nd) == 1) {
ndigits = NUM2INT(nd);
}
if (ndigits < 0) {
return int_round_0(flo_truncate(num), ndigits);
}
number = RFLOAT_VALUE(num);
if (ndigits == 0) {
return dbl2ival(number);
}
frexp(number, &binexp);
/* Let `exp` be such that `number` is written as:"0.#{digits}e#{exp}",
i.e. such that 10 ** (exp - 1) <= |number| < 10 ** exp
Recall that up to float_dig digits can be needed to represent a double,
so if ndigits + exp >= float_dig, the intermediate value (number * 10 ** ndigits)
will be an integer and thus the result is the original number.
If ndigits + exp <= 0, the result is 0 or "1e#{exp}", so
if ndigits + exp < 0, the result is 0.
We have:
2 ** (binexp-1) <= |number| < 2 ** binexp
10 ** ((binexp-1)/log_2(10)) <= |number| < 10 ** (binexp/log_2(10))
If binexp >= 0, and since log_2(10) = 3.322259:
10 ** (binexp/4 - 1) < |number| < 10 ** (binexp/3)
floor(binexp/4) <= exp <= ceil(binexp/3)
If binexp <= 0, swap the /4 and the /3
So if ndigits + floor(binexp/(4 or 3)) >= float_dig, the result is number
If ndigits + ceil(binexp/(3 or 4)) < 0 the result is 0
*/
if (isinf(number) || isnan(number) ||
(ndigits >= float_dig - (binexp > 0 ? binexp / 4 : binexp / 3 - 1))) {
return num;
}
if (ndigits < - (binexp > 0 ? binexp / 3 + 1 : binexp / 4)) {
return DBL2NUM(0);
}
f = pow(10, ndigits);
return DBL2NUM(round(number * f) / f);
};T;0To;
; F; ;
;;;I"Float#truncate;F;[ ;[[@i5;T;;B;0;[ ;{ ;IC;"^Returns the +float+ truncated to an Integer.
Synonyms are #to_i, #to_int, and #truncate.
;T;[o;
; I"
overload;F; 0;;D; 0; I" to_i;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@%;#[ ;$I"@return [Integer];T;%0;"@%;&0;'F;(i ;[ ;"@%o;
; I"
overload;F; 0;;; 0; I" to_int;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@%;#[ ;$I"@return [Integer];T;%0;"@%;&0;'F;(i ;[ ;"@%o;
; I"
overload;F; 0;;B; 0; I"
truncate;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@%;#[ ;$I"@return [Integer];T;%0;"@%;&0;'F;(i ;[ ;"@%;#[ ;$@ %;%0;"@%;'F;)o;*;+T;,i*;-i4;.@k ; I"static VALUE;T;/I"static VALUE
flo_truncate(VALUE num)
{
double f = RFLOAT_VALUE(num);
long val;
if (f > 0.0) f = floor(f);
if (f < 0.0) f = ceil(f);
if (!FIXABLE(f)) {
return rb_dbl2big(f);
}
val = (long)f;
return LONG2FIX(val);
};T;0To;
; F; ;
;;;I"Float#nan?;F;[ ;[[@i;T;: nan?;0;[ ;{ ;IC;"Returns +true+ if +float+ is an invalid IEEE floating point number.
a = -1.0 #=> -1.0
a.nan? #=> false
a = 0.0/0.0 #=> NaN
a.nan? #=> true
;T;[o;
; I"
overload;F; 0;;G; 0; I" nan?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@%;#[ ;$I"@return [Boolean];T;%0;"@%;&0;'F;(i ;[ ;"@%o;!
; I" return;F; @;0; [@;"@%;#[ ;$I"Returns +true+ if +float+ is an invalid IEEE floating point number.
a = -1.0 #=> -1.0
a.nan? #=> false
a = 0.0/0.0 #=> NaN
a.nan? #=> true
@overload nan?
@return [Boolean];T;%0;"@%;'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"~static VALUE
flo_is_nan_p(VALUE num)
{
double value = RFLOAT_VALUE(num);
return isnan(value) ? Qtrue : Qfalse;
};T;0To;
; F; ;
;;;I"Float#infinite?;F;[ ;[[@i;T;:infinite?;0;[ ;{ ;IC;"Return values corresponding to the value of +float+:
+finite+:: +nil+
+-Infinity+:: +-1+
++Infinity+:: +1+
For example:
(0.0).infinite? #=> nil
(-1.0/0.0).infinite? #=> -1
(+1.0/0.0).infinite? #=> 1
;T;[o;
; I"
overload;F; 0;;H; 0; I"infinite?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;TI"-1;TI"+1;T;"@%;#[ ;$I" @return [nil, -1, +1];T;%0;"@%;&0;'F;(i ;[ ;"@%o;!
; I" return;F; @;0; [@;"@%;#[ ;$I"Return values corresponding to the value of +float+:
+finite+:: +nil+
+-Infinity+:: +-1+
++Infinity+:: +1+
For example:
(0.0).infinite? #=> nil
(-1.0/0.0).infinite? #=> -1
(+1.0/0.0).infinite? #=> 1
@overload infinite?
@return [nil, -1, +1];T;%0;"@%;'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"static VALUE
flo_is_infinite_p(VALUE num)
{
double value = RFLOAT_VALUE(num);
if (isinf(value)) {
return INT2FIX( value < 0 ? -1 : 1 );
}
return Qnil;
};T;0To;
; F; ;
;;;I"Float#finite?;F;[ ;[[@i;T;: finite?;0;[ ;{ ;IC;"uReturns +true+ if +float+ is a valid IEEE floating point number (it is not
infinite, and Float#nan? is +false+).
;T;[o;
; I"
overload;F; 0;;I; 0; I" finite?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@ &;#[ ;$I"@return [Boolean];T;%0;"@ &;&0;'F;(i ;[ ;"@ &o;!
; I" return;F; @;0; [@;"@ &;#[ ;$I"Returns +true+ if +float+ is a valid IEEE floating point number (it is not
infinite, and Float#nan? is +false+).
@overload finite?
@return [Boolean];T;%0;"@ &;'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"static VALUE
flo_is_finite_p(VALUE num)
{
double value = RFLOAT_VALUE(num);
#ifdef HAVE_ISFINITE
if (!isfinite(value))
return Qfalse;
#else
if (isinf(value) || isnan(value))
return Qfalse;
#endif
return Qtrue;
};T;0To;
; F; ;
;;;I"Float#next_float;F;[ ;[[@iA;T;:next_float;0;[ ;{ ;IC;"+Returns the next representable floating-point number.
Float::MAX.next_float and Float::INFINITY.next_float is Float::INFINITY.
Float::NAN.next_float is Float::NAN.
For example:
p 0.01.next_float #=> 0.010000000000000002
p 1.0.next_float #=> 1.0000000000000002
p 100.0.next_float #=> 100.00000000000001
p 0.01.next_float - 0.01 #=> 1.734723475976807e-18
p 1.0.next_float - 1.0 #=> 2.220446049250313e-16
p 100.0.next_float - 100.0 #=> 1.4210854715202004e-14
f = 0.01; 20.times { printf "%-20a %s\n", f, f.to_s; f = f.next_float }
#=> 0x1.47ae147ae147bp-7 0.01
# 0x1.47ae147ae147cp-7 0.010000000000000002
# 0x1.47ae147ae147dp-7 0.010000000000000004
# 0x1.47ae147ae147ep-7 0.010000000000000005
# 0x1.47ae147ae147fp-7 0.010000000000000007
# 0x1.47ae147ae148p-7 0.010000000000000009
# 0x1.47ae147ae1481p-7 0.01000000000000001
# 0x1.47ae147ae1482p-7 0.010000000000000012
# 0x1.47ae147ae1483p-7 0.010000000000000014
# 0x1.47ae147ae1484p-7 0.010000000000000016
# 0x1.47ae147ae1485p-7 0.010000000000000018
# 0x1.47ae147ae1486p-7 0.01000000000000002
# 0x1.47ae147ae1487p-7 0.010000000000000021
# 0x1.47ae147ae1488p-7 0.010000000000000023
# 0x1.47ae147ae1489p-7 0.010000000000000024
# 0x1.47ae147ae148ap-7 0.010000000000000026
# 0x1.47ae147ae148bp-7 0.010000000000000028
# 0x1.47ae147ae148cp-7 0.01000000000000003
# 0x1.47ae147ae148dp-7 0.010000000000000031
# 0x1.47ae147ae148ep-7 0.010000000000000033
f = 0.0
100.times { f += 0.1 }
p f #=> 9.99999999999998 # should be 10.0 in the ideal world.
p 10-f #=> 1.9539925233402755e-14 # the floating-point error.
p(10.0.next_float-10) #=> 1.7763568394002505e-15 # 1 ulp (units in the last place).
p((10-f)/(10.0.next_float-10)) #=> 11.0 # the error is 11 ulp.
p((10-f)/(10*Float::EPSILON)) #=> 8.8 # approximation of the above.
p "%a" % f #=> "0x1.3fffffffffff5p+3" # the last hex digit is 5. 16 - 5 = 11 ulp.
;T;[o;
; I"
overload;F; 0;;J; 0; I"next_float;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@)&;#[ ;$I"@return [Float];T;%0;"@)&;&0;'F;(i ;[ ;"@)&;#[ ;$I"UReturns the next representable floating-point number.
Float::MAX.next_float and Float::INFINITY.next_float is Float::INFINITY.
Float::NAN.next_float is Float::NAN.
For example:
p 0.01.next_float #=> 0.010000000000000002
p 1.0.next_float #=> 1.0000000000000002
p 100.0.next_float #=> 100.00000000000001
p 0.01.next_float - 0.01 #=> 1.734723475976807e-18
p 1.0.next_float - 1.0 #=> 2.220446049250313e-16
p 100.0.next_float - 100.0 #=> 1.4210854715202004e-14
f = 0.01; 20.times { printf "%-20a %s\n", f, f.to_s; f = f.next_float }
#=> 0x1.47ae147ae147bp-7 0.01
# 0x1.47ae147ae147cp-7 0.010000000000000002
# 0x1.47ae147ae147dp-7 0.010000000000000004
# 0x1.47ae147ae147ep-7 0.010000000000000005
# 0x1.47ae147ae147fp-7 0.010000000000000007
# 0x1.47ae147ae148p-7 0.010000000000000009
# 0x1.47ae147ae1481p-7 0.01000000000000001
# 0x1.47ae147ae1482p-7 0.010000000000000012
# 0x1.47ae147ae1483p-7 0.010000000000000014
# 0x1.47ae147ae1484p-7 0.010000000000000016
# 0x1.47ae147ae1485p-7 0.010000000000000018
# 0x1.47ae147ae1486p-7 0.01000000000000002
# 0x1.47ae147ae1487p-7 0.010000000000000021
# 0x1.47ae147ae1488p-7 0.010000000000000023
# 0x1.47ae147ae1489p-7 0.010000000000000024
# 0x1.47ae147ae148ap-7 0.010000000000000026
# 0x1.47ae147ae148bp-7 0.010000000000000028
# 0x1.47ae147ae148cp-7 0.01000000000000003
# 0x1.47ae147ae148dp-7 0.010000000000000031
# 0x1.47ae147ae148ep-7 0.010000000000000033
f = 0.0
100.times { f += 0.1 }
p f #=> 9.99999999999998 # should be 10.0 in the ideal world.
p 10-f #=> 1.9539925233402755e-14 # the floating-point error.
p(10.0.next_float-10) #=> 1.7763568394002505e-15 # 1 ulp (units in the last place).
p((10-f)/(10.0.next_float-10)) #=> 11.0 # the error is 11 ulp.
p((10-f)/(10*Float::EPSILON)) #=> 8.8 # approximation of the above.
p "%a" % f #=> "0x1.3fffffffffff5p+3" # the last hex digit is 5. 16 - 5 = 11 ulp.
@overload next_float
@return [Float];T;%0;"@)&;'F;)o;*;+T;,i
;-i?;.@k ; I"static VALUE;T;/I"static VALUE
flo_next_float(VALUE vx)
{
double x, y;
x = NUM2DBL(vx);
y = nextafter(x, INFINITY);
return DBL2NUM(y);
};T;0To;
; F; ;
;;;I"Float#prev_float;F;[ ;[[@iu;T;:prev_float;0;[ ;{ ;IC;"Returns the previous representable floating-point number.
(-Float::MAX).prev_float and (-Float::INFINITY).prev_float is -Float::INFINITY.
Float::NAN.prev_float is Float::NAN.
For example:
p 0.01.prev_float #=> 0.009999999999999998
p 1.0.prev_float #=> 0.9999999999999999
p 100.0.prev_float #=> 99.99999999999999
p 0.01 - 0.01.prev_float #=> 1.734723475976807e-18
p 1.0 - 1.0.prev_float #=> 1.1102230246251565e-16
p 100.0 - 100.0.prev_float #=> 1.4210854715202004e-14
f = 0.01; 20.times { printf "%-20a %s\n", f, f.to_s; f = f.prev_float }
#=> 0x1.47ae147ae147bp-7 0.01
# 0x1.47ae147ae147ap-7 0.009999999999999998
# 0x1.47ae147ae1479p-7 0.009999999999999997
# 0x1.47ae147ae1478p-7 0.009999999999999995
# 0x1.47ae147ae1477p-7 0.009999999999999993
# 0x1.47ae147ae1476p-7 0.009999999999999992
# 0x1.47ae147ae1475p-7 0.00999999999999999
# 0x1.47ae147ae1474p-7 0.009999999999999988
# 0x1.47ae147ae1473p-7 0.009999999999999986
# 0x1.47ae147ae1472p-7 0.009999999999999985
# 0x1.47ae147ae1471p-7 0.009999999999999983
# 0x1.47ae147ae147p-7 0.009999999999999981
# 0x1.47ae147ae146fp-7 0.00999999999999998
# 0x1.47ae147ae146ep-7 0.009999999999999978
# 0x1.47ae147ae146dp-7 0.009999999999999976
# 0x1.47ae147ae146cp-7 0.009999999999999974
# 0x1.47ae147ae146bp-7 0.009999999999999972
# 0x1.47ae147ae146ap-7 0.00999999999999997
# 0x1.47ae147ae1469p-7 0.009999999999999969
# 0x1.47ae147ae1468p-7 0.009999999999999967
;T;[o;
; I"
overload;F; 0;;K; 0; I"prev_float;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@D&;#[ ;$I"@return [Float];T;%0;"@D&;&0;'F;(i ;[ ;"@D&;#[ ;$I"Returns the previous representable floating-point number.
(-Float::MAX).prev_float and (-Float::INFINITY).prev_float is -Float::INFINITY.
Float::NAN.prev_float is Float::NAN.
For example:
p 0.01.prev_float #=> 0.009999999999999998
p 1.0.prev_float #=> 0.9999999999999999
p 100.0.prev_float #=> 99.99999999999999
p 0.01 - 0.01.prev_float #=> 1.734723475976807e-18
p 1.0 - 1.0.prev_float #=> 1.1102230246251565e-16
p 100.0 - 100.0.prev_float #=> 1.4210854715202004e-14
f = 0.01; 20.times { printf "%-20a %s\n", f, f.to_s; f = f.prev_float }
#=> 0x1.47ae147ae147bp-7 0.01
# 0x1.47ae147ae147ap-7 0.009999999999999998
# 0x1.47ae147ae1479p-7 0.009999999999999997
# 0x1.47ae147ae1478p-7 0.009999999999999995
# 0x1.47ae147ae1477p-7 0.009999999999999993
# 0x1.47ae147ae1476p-7 0.009999999999999992
# 0x1.47ae147ae1475p-7 0.00999999999999999
# 0x1.47ae147ae1474p-7 0.009999999999999988
# 0x1.47ae147ae1473p-7 0.009999999999999986
# 0x1.47ae147ae1472p-7 0.009999999999999985
# 0x1.47ae147ae1471p-7 0.009999999999999983
# 0x1.47ae147ae147p-7 0.009999999999999981
# 0x1.47ae147ae146fp-7 0.00999999999999998
# 0x1.47ae147ae146ep-7 0.009999999999999978
# 0x1.47ae147ae146dp-7 0.009999999999999976
# 0x1.47ae147ae146cp-7 0.009999999999999974
# 0x1.47ae147ae146bp-7 0.009999999999999972
# 0x1.47ae147ae146ap-7 0.00999999999999997
# 0x1.47ae147ae1469p-7 0.009999999999999969
# 0x1.47ae147ae1468p-7 0.009999999999999967
@overload prev_float
@return [Float];T;%0;"@D&;'F;)o;*;+T;,iJ;-is;.@k ; I"static VALUE;T;/I"static VALUE
flo_prev_float(VALUE vx)
{
double x, y;
x = NUM2DBL(vx);
y = nextafter(x, -INFINITY);
return DBL2NUM(y);
};T;0To;
; F; ;
;;;I"Float#positive?;F;[ ;[[@iL;T;;;0;[ ;{ ;IC;"1Returns +true+ if +float+ is greater than 0.
;T;[o;
; I"
overload;F; 0;;; 0; I"positive?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@_&;#[ ;$I"@return [Boolean];T;%0;"@_&;&0;'F;(i ;[ ;"@_&o;!
; I" return;F; @;0; [@;"@_&;#[ ;$I"[Returns +true+ if +float+ is greater than 0.
@overload positive?
@return [Boolean];T;%0;"@_&;'F;)o;*;+T;,iE;-iI;.@k ; I"static VALUE;T;/I"vstatic VALUE
flo_positive_p(VALUE num)
{
double f = RFLOAT_VALUE(num);
return f > 0.0 ? Qtrue : Qfalse;
};T;0To;
; F; ;
;;;I"Float#negative?;F;[ ;[[@iZ;T;;;0;[ ;{ ;IC;".Returns +true+ if +float+ is less than 0.
;T;[o;
; I"
overload;F; 0;;; 0; I"negative?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@}&;#[ ;$I"@return [Boolean];T;%0;"@}&;&0;'F;(i ;[ ;"@}&o;!
; I" return;F; @;0; [@;"@}&;#[ ;$I"XReturns +true+ if +float+ is less than 0.
@overload negative?
@return [Boolean];T;%0;"@}&;'F;)o;*;+T;,iS;-iW;.@k ; I"static VALUE;T;/I"vstatic VALUE
flo_negative_p(VALUE num)
{
double f = RFLOAT_VALUE(num);
return f < 0.0 ? Qtrue : Qfalse;
};T;0To;
; F; ;
;;;I"Float#arg;F;[ ;[[@i;T;;;0;[ ;{ ;IC;"6Returns 0 if the value is positive, pi otherwise.
;T;[o;
; I"
overload;F; 0;;; 0; I"arg;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"
Float;T;"@&;#[ ;$I"@return [ 0, Float];T;%0;"@&;&0;'F;(i ;[ ;"@&o;
; I"
overload;F; 0;;; 0; I"
angle;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"
Float;T;"@&;#[ ;$I"@return [ 0, Float];T;%0;"@&;&0;'F;(i ;[ ;"@&o;
; I"
overload;F; 0;;; 0; I"
phase;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"
Float;T;"@&;#[ ;$I"@return [ 0, Float];T;%0;"@&;&0;'F;(i ;[ ;"@&;#[ ;$I"Returns 0 if the value is positive, pi otherwise.
@overload arg
@return [ 0, Float]
@overload angle
@return [ 0, Float]
@overload phase
@return [ 0, Float];T;%0;"@&;'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"static VALUE
float_arg(VALUE self)
{
if (isnan(RFLOAT_VALUE(self)))
return self;
if (f_tpositive_p(self))
return INT2FIX(0);
return rb_const_get(rb_mMath, id_PI);
};T;0To;
; F; ;
;;;I"Float#angle;F;[ ;[[@i;T;;;0;[ ;{ ;IC;"6Returns 0 if the value is positive, pi otherwise.
;T;[o;
; I"
overload;F; 0;;; 0; I"arg;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"
Float;T;"@&;#[ ;$I"@return [ 0, Float];T;%0;"@&;&0;'F;(i ;[ ;"@&o;
; I"
overload;F; 0;;; 0; I"
angle;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"
Float;T;"@&;#[ ;$I"@return [ 0, Float];T;%0;"@&;&0;'F;(i ;[ ;"@&o;
; I"
overload;F; 0;;; 0; I"
phase;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"
Float;T;"@&;#[ ;$I"@return [ 0, Float];T;%0;"@&;&0;'F;(i ;[ ;"@&;#[ ;$@&;%0;"@&;'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"static VALUE
float_arg(VALUE self)
{
if (isnan(RFLOAT_VALUE(self)))
return self;
if (f_tpositive_p(self))
return INT2FIX(0);
return rb_const_get(rb_mMath, id_PI);
};T;0To;
; F; ;
;;;I"Float#phase;F;[ ;[[@i;T;;;0;[ ;{ ;IC;"6Returns 0 if the value is positive, pi otherwise.
;T;[o;
; I"
overload;F; 0;;; 0; I"arg;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"
Float;T;"@
';#[ ;$I"@return [ 0, Float];T;%0;"@
';&0;'F;(i ;[ ;"@
'o;
; I"
overload;F; 0;;; 0; I"
angle;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"
Float;T;"@
';#[ ;$I"@return [ 0, Float];T;%0;"@
';&0;'F;(i ;[ ;"@
'o;
; I"
overload;F; 0;;; 0; I"
phase;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;TI"
Float;T;"@
';#[ ;$I"@return [ 0, Float];T;%0;"@
';&0;'F;(i ;[ ;"@
';#[ ;$@&;%0;"@
';'F;)o;*;+T;,i;-i;.@k ; I"static VALUE;T;/I"static VALUE
float_arg(VALUE self)
{
if (isnan(RFLOAT_VALUE(self)))
return self;
if (f_tpositive_p(self))
return INT2FIX(0);
return rb_const_get(rb_mMath, id_PI);
};T;0T;N@k ;OIC;[ ;N@k ;PIC;[ ;N@k ;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{@!;I;V[ ;[[@i[@i;T;;;;X;;;[ ;{ ;IC;"******************************************************************
Float objects represent inexact real numbers using the native
architecture's double-precision floating point representation.
Floating point has a different arithmetic and is an inexact number.
So you should know its esoteric system. see following:
- http://docs.sun.com/source/806-3568/ncg_goldberg.html
- http://wiki.github.com/rdp/ruby_tutorials_core/ruby-talk-faq#wiki-floats_imprecise
- http://en.wikipedia.org/wiki/Floating_point#Accuracy_problems;T;[ ;#[ ;$I"******************************************************************
Float objects represent inexact real numbers using the native
architecture's double-precision floating point representation.
Floating point has a different arithmetic and is an inexact number.
So you should know its esoteric system. see following:
- http://docs.sun.com/source/806-3568/ncg_goldberg.html
- http://wiki.github.com/rdp/ruby_tutorials_core/ruby-talk-faq#wiki-floats_imprecise
- http://en.wikipedia.org/wiki/Floating_point#Accuracy_problems
;T;%0;"@k ;'F;(i ;)o;*;+T;,i;-i;.@;I"
Float;F;Y@o; ;IC;[o;
; F; ;
;;;I"NilClass#to_r;F;[ ;[[@i;T;;F;0;[ ;{ ;IC;" Returns zero as a rational.
;T;[o;
; I"
overload;F; 0;;F; 0; I" to_r;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@U';&0;'F;(i ;[ ;"@U';#[ ;$I"1Returns zero as a rational.
@overload to_r;T;%0;"@U';'F;)o;*;+T;,i{;-i~;.@S'; I"static VALUE;T;/I"Xstatic VALUE
nilclass_to_r(VALUE self)
{
return rb_rational_new1(INT2FIX(0));
};T;0To;
; F; ;
;;;I"NilClass#rationalize;F;[[@0;[[@i;T;;G;0;[ ;{ ;IC;"NReturns zero as a rational. The optional argument eps is always
ignored.
;T;[o;
; I"
overload;F; 0;;G; 0; I"rationalize([eps]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@k';&0;'F;(i ;[[I"
[eps];T0;"@k';#[ ;$I"mReturns zero as a rational. The optional argument eps is always
ignored.
@overload rationalize([eps]);T;%0;"@k';'F;)o;*;+T;,i;-i;.@S'; I"static VALUE;T;/I"static VALUE
nilclass_rationalize(int argc, VALUE *argv, VALUE self)
{
rb_scan_args(argc, argv, "01", NULL);
return nilclass_to_r(self);
};T;0To;
; F; ;
;;;I"NilClass#to_c;F;[ ;[[@i;T;;;0;[ ;{ ;IC;" Returns zero as a complex.
;T;[o;
; I"
overload;F; 0;;; 0; I" to_c;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@';&0;'F;(i ;[ ;"@';#[ ;$I"0Returns zero as a complex.
@overload to_c;T;%0;"@';'F;)o;*;+T;,i;-i;.@S'; I"static VALUE;T;/I"Wstatic VALUE
nilclass_to_c(VALUE self)
{
return rb_complex_new1(INT2FIX(0));
};T;0To;
; F; ;
;;;I"NilClass#to_i;F;[ ;[[@uiY;T;;D;0;[ ;{ ;IC;".Always returns zero.
nil.to_i #=> 0
;T;[o;
; I"
overload;F; 0;;D; 0; I" to_i;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0;T;"@';#[ ;$I"@return [0];T;%0;"@';&0;'F;(i ;[ ;"@';#[ ;$I"MAlways returns zero.
nil.to_i #=> 0
@overload to_i
@return [0];T;%0;"@';'F;)o;*;+T;,iO;-iU;.@S'; I"static VALUE;T;/I"@static VALUE
nil_to_i(VALUE obj)
{
return INT2FIX(0);
};T;0To;
; F; ;
;;;I"NilClass#to_f;F;[ ;[[@uih;T;;E;0;[ ;{ ;IC;"0Always returns zero.
nil.to_f #=> 0.0
;T;[o;
; I"
overload;F; 0;;E; 0; I" to_f;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"0.0;T;"@';#[ ;$I"@return [0.0];T;%0;"@';&0;'F;(i ;[ ;"@';#[ ;$I"QAlways returns zero.
nil.to_f #=> 0.0
@overload to_f
@return [0.0];T;%0;"@';'F;)o;*;+T;,i_;-ie;.@S'; I"static VALUE;T;/I"Bstatic VALUE
nil_to_f(VALUE obj)
{
return DBL2NUM(0.0);
};T;0To;
; F; ;
;;;I"NilClass#to_s;F;[ ;[[@uiu;T;;I;0;[ ;{ ;IC;"%Always returns the empty string.
;T;[o;
; I"
overload;F; 0;;I; 0; I" to_s;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@';&0;'F;(i ;[ ;"@';#[ ;$I"6Always returns the empty string.
@overload to_s;T;%0;"@';'F;)o;*;+T;,in;-iq;.@S'; I"static VALUE;T;/I"Nstatic VALUE
nil_to_s(VALUE obj)
{
return rb_usascii_str_new(0, 0);
};T;0To;
; F; ;
;;;I"NilClass#to_a;F;[ ;[[@ui;T;: to_a;0;[ ;{ ;IC;"\call-seq:
nil.to_a -> []
Always returns an empty array.
nil.to_a #=> []
;T;[ ;#[ ;$I"_
call-seq:
nil.to_a -> []
Always returns an empty array.
nil.to_a #=> []
;T;%0;"@';'F;)o;*;+T;,i{;-i;.@S'; I"static VALUE;T;/I"Dstatic VALUE
nil_to_a(VALUE obj)
{
return rb_ary_new2(0);
};T;0To;
; F; ;
;;;I"NilClass#to_h;F;[ ;[[@ui;T;: to_h;0;[ ;{ ;IC;"[call-seq:
nil.to_h -> {}
Always returns an empty hash.
nil.to_h #=> {}
;T;[ ;#[ ;$I"^
call-seq:
nil.to_h -> {}
Always returns an empty hash.
nil.to_h #=> {}
;T;%0;"@';'F;)o;*;+T;,i;-i;.@S'; I"static VALUE;T;/I"Cstatic VALUE
nil_to_h(VALUE obj)
{
return rb_hash_new();
};T;0To;
; F; ;
;;;I"NilClass#inspect;F;[ ;[[@ui;T;;J;0;[ ;{ ;IC;"%Always returns the string "nil".
;T;[o;
; I"
overload;F; 0;;J; 0; I" inspect;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@(;&0;'F;(i ;[ ;"@(;#[ ;$I"9Always returns the string "nil".
@overload inspect;T;%0;"@(;'F;)o;*;+T;,i;-i;.@S'; I"static VALUE;T;/I"Sstatic VALUE
nil_inspect(VALUE obj)
{
return rb_usascii_str_new2("nil");
};T;0To;
; F; ;
;;;I"NilClass#&;F;[[I" obj2;T0;[[@ui;T;:&;0;[ ;{ ;IC;"And---Returns false. obj is always
evaluated as it is the argument to a method call---there is no
short-circuit evaluation in this case.
;T;[o;
; I"
overload;F; 0;;N; 0; I" &(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
false;T;"@(;#[ ;$I"@return [false];T;%0;"@(;&0;'F;(i ;[[I"obj;T0;"@(o;
; I"
overload;F; 0;;N; 0; I" &(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
false;T;"@(;#[ ;$I"@return [false];T;%0;"@(;&0;'F;(i ;[[I"obj;T0;"@(;#[ ;$I"And---Returns false. obj is always
evaluated as it is the argument to a method call---there is no
short-circuit evaluation in this case.
@overload &(obj)
@return [false]
@overload &(obj)
@return [false];T;%0;"@(;'F;)o;*;+T;,i;-i;.@S'; I"static VALUE;T;/I"Istatic VALUE
false_and(VALUE obj, VALUE obj2)
{
return Qfalse;
};T;0To;
; F; ;
;;;I"NilClass#|;F;[[I" obj2;T0;[[@ui(;T;:|;0;[ ;{ ;IC;"zOr---Returns false if obj is
nil or false; true otherwise.
;T;[o;
; I"
overload;F; 0;;O; 0; I" |(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@F(;#[ ;$I"@return [Boolean];T;%0;"@F(;&0;'F;(i ;[[I"obj;T0;"@F(o;
; I"
overload;F; 0;;O; 0; I" |(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@F(;#[ ;$I"@return [Boolean];T;%0;"@F(;&0;'F;(i ;[[I"obj;T0;"@F(;#[ ;$I"Or---Returns false if obj is
nil or false; true otherwise.
@overload |(obj)
@return [Boolean]
@overload |(obj)
@return [Boolean];T;%0;"@F(;'F;)o;*;+T;,i ;-i&;.@S'; I"static VALUE;T;/I"Zstatic VALUE
false_or(VALUE obj, VALUE obj2)
{
return RTEST(obj2)?Qtrue:Qfalse;
};T;0To;
; F; ;
;;;I"NilClass#^;F;[[I" obj2;T0;[[@ui;;T;:^;0;[ ;{ ;IC;"Exclusive Or---If obj is nil or
false, returns false; otherwise, returns
true.
;T;[o;
; I"
overload;F; 0;;P; 0; I" ^(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@t(;#[ ;$I"@return [Boolean];T;%0;"@t(;&0;'F;(i ;[[I"obj;T0;"@t(o;
; I"
overload;F; 0;;P; 0; I" ^(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@t(;#[ ;$I"@return [Boolean];T;%0;"@t(;&0;'F;(i ;[[I"obj;T0;"@t(;#[ ;$I"Exclusive Or---If obj is nil or
false, returns false; otherwise, returns
true.
@overload ^(obj)
@return [Boolean]
@overload ^(obj)
@return [Boolean];T;%0;"@t(;'F;)o;*;+T;,i0;-i9;.@S'; I"static VALUE;T;/I"[static VALUE
false_xor(VALUE obj, VALUE obj2)
{
return RTEST(obj2)?Qtrue:Qfalse;
};T;0To;
; F; ;
;;;I"NilClass#===;F;[[I" obj2;T0;[[@uiZ;T;;n;0;[ ;{ ;IC;"Case Equality -- For class Object, effectively the same as calling
#==, but typically overridden by descendants to provide
meaningful semantics in +case+ statements.
;T;[o;
; I"
overload;F; 0;;n; 0; I"===(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@(;#[ ;$I"@return [Boolean];T;%0;"@(;&0;'F;(i ;[[I"
other;T0;"@(;#[ ;$@;%0;"@(;'F;)o;*;+T;,iQ;-iW;.@S'; I"
VALUE;T;/I"VALUE
rb_equal(VALUE obj1, VALUE obj2)
{
VALUE result;
if (obj1 == obj2) return Qtrue;
result = rb_funcall(obj1, id_eq, 1, obj2);
if (RTEST(result)) return Qtrue;
return Qfalse;
};T;0To;
; F; ;
;;;I"NilClass#nil?;F;[ ;[[@uiH;T;;m;0;[ ;{ ;IC;"POnly the object nil responds true to nil?.
;T;[o;
; I"
overload;F; 0;;m; 0; I" nil?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" true;T;"@(;#[ ;$I"@return [true];T;%0;"@(;&0;'F;(i ;[ ;"@(o;!
; I" return;F; @;0; [@;"@(;#[ ;$I"rOnly the object nil responds true to nil?.
@overload nil?
@return [true];T;%0;"@(;'F;)o;*;+T;,iA;-iE;.@S'; I"static VALUE;T;/I":static VALUE
rb_true(VALUE obj)
{
return Qtrue;
};T;0T;N@S';OIC;[ ;N@S';PIC;[ ;N@S';QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@uiI[@ui
;T;:
NilClass;;X;;;[ ;{ ;IC;"8The class of the singleton object nil.;T;[ ;#[ ;$I";
The class of the singleton object nil.
;T;%0;"@S';'F;(i ;)o;*;+T;,iI;-iK;.@;I"
NilClass;F;Y@No; ;IC;[o;
; F; ;
;;;I"String#to_r;F;[ ;[[@i: ;T;;F;0;[ ;{ ;IC;"gReturns a rational which denotes the string form. The parser
ignores leading whitespaces and trailing garbage. Any digit
sequences can be separated by an underscore. Returns zero for null
or garbage string.
NOTE: '0.3'.to_r isn't the same as 0.3.to_r. The former is
equivalent to '3/10'.to_r, but the latter isn't so.
' 2 '.to_r #=> (2/1)
'300/2'.to_r #=> (150/1)
'-9.2'.to_r #=> (-46/5)
'-9.2e2'.to_r #=> (-920/1)
'1_234_567'.to_r #=> (1234567/1)
'21 june 09'.to_r #=> (21/1)
'21/06/09'.to_r #=> (7/2)
'bwv 1079'.to_r #=> (0/1)
See Kernel.Rational.
;T;[o;
; I"
overload;F; 0;;F; 0; I" to_r;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@(;&0;'F;(i ;[ ;"@(;#[ ;$I"xReturns a rational which denotes the string form. The parser
ignores leading whitespaces and trailing garbage. Any digit
sequences can be separated by an underscore. Returns zero for null
or garbage string.
NOTE: '0.3'.to_r isn't the same as 0.3.to_r. The former is
equivalent to '3/10'.to_r, but the latter isn't so.
' 2 '.to_r #=> (2/1)
'300/2'.to_r #=> (150/1)
'-9.2'.to_r #=> (-46/5)
'-9.2e2'.to_r #=> (-920/1)
'1_234_567'.to_r #=> (1234567/1)
'21 june 09'.to_r #=> (21/1)
'21/06/09'.to_r #=> (7/2)
'bwv 1079'.to_r #=> (0/1)
See Kernel.Rational.
@overload to_r;T;%0;"@(;'F;)o;*;+T;,i# ;-i7 ;.@(; I"static VALUE;T;/I"static VALUE
string_to_r(VALUE self)
{
char *s;
VALUE num;
rb_must_asciicompat(self);
s = RSTRING_PTR(self);
if (s && s[RSTRING_LEN(self)]) {
rb_str_modify(self);
s = RSTRING_PTR(self);
s[RSTRING_LEN(self)] = '\0';
}
if (!s)
s = (char *)"";
(void)parse_rat(s, 0, &num);
if (RB_TYPE_P(num, T_FLOAT))
rb_raise(rb_eFloatDomainError, "Infinity");
return num;
};T;0To;
; F; ;S;;;I"String.try_convert;F;[[I"str;T0;[[I"
string.c;Ti;T;:try_convert;0;[ ;{ ;IC;"Try to convert obj into a String, using to_str method.
Returns converted string or nil if obj cannot be converted
for any reason.
String.try_convert("str") #=> "str"
String.try_convert(/re/) #=> nil
;T;[o;
; I"
overload;F; 0;;R; 0; I"try_convert(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@);#[ ;$I"@return [String, nil];T;%0;"@);&0;'F;(i ;[[I"obj;T0;"@);#[ ;$I"Try to convert obj into a String, using to_str method.
Returns converted string or nil if obj cannot be converted
for any reason.
String.try_convert("str") #=> "str"
String.try_convert(/re/) #=> nil
@overload try_convert(obj)
@return [String, nil];T;%0;"@);'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"hstatic VALUE
rb_str_s_try_convert(VALUE dummy, VALUE str)
{
return rb_check_string_type(str);
};T;0To;
; F; ;
;;;I"String#initialize;F;[[@0;[[@)iP;T;;;0;[ ;{ ;IC;"Returns a new string object containing a copy of str.
The optional enc argument specifies the encoding of the new string.
If not specified, the encoding of str (or ASCII-8BIT, if str
is not specified) is used.
;T;[o;
; I"
overload;F; 0;:new; 0; I"new(str="");T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@));#[ ;$I"@return [String];T;%0;"@));&0;'F;(i ;[[I"str;TI""";T;"@))o;
; I"
overload;F; 0;;S; 0; I" new(str="", encoding: enc);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@));#[ ;$I"@return [String];T;%0;"@));&0;'F;(i ;[[I"str;TI""";T[I"encoding:;TI"enc;T;"@));#[ ;$I"PReturns a new string object containing a copy of str.
The optional enc argument specifies the encoding of the new string.
If not specified, the encoding of str (or ASCII-8BIT, if str
is not specified) is used.
@overload new(str="")
@return [String]
@overload new(str="", encoding: enc)
@return [String];T;%0;"@));'F;)o;*;+T;,iE;-iN;.@(; I"static VALUE;T;/I"static VALUE
rb_str_init(int argc, VALUE *argv, VALUE str)
{
static ID keyword_ids[1];
VALUE orig, opt, enc;
int n;
if (!keyword_ids[0])
keyword_ids[0] = rb_id_encoding();
n = rb_scan_args(argc, argv, "01:", &orig, &opt);
if (argc > 0 && n == 1)
rb_str_replace(str, orig);
if (!NIL_P(opt)) {
rb_get_kwargs(opt, keyword_ids, 0, 1, &enc);
if (enc != Qundef && !NIL_P(enc)) {
rb_enc_associate(str, rb_to_encoding(enc));
ENC_CODERANGE_CLEAR(str);
}
}
return str;
};T;0To;
; F; ;
;;;I"String#initialize_copy;F;[[I" str2;T0;[[@)i;T;;w;0;[ ;{ ;IC;"Replaces the contents and taintedness of str with the corresponding
values in other_str.
s = "hello" #=> "hello"
s.replace "world" #=> "world"
;T;[o;
; I"
overload;F; 0;: replace; 0; I"replace(other_str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@[);#[ ;$I"@return [String];T;%0;"@[);&0;'F;(i ;[[I"other_str;T0;"@[);#[ ;$I"Replaces the contents and taintedness of str with the corresponding
values in other_str.
s = "hello" #=> "hello"
s.replace "world" #=> "world"
@overload replace(other_str)
@return [String];T;%0;"@[);'F;)o;*;+T;,i;-i;.@(; I"
VALUE;T;/I"VALUE
rb_str_replace(VALUE str, VALUE str2)
{
str_modifiable(str);
if (str == str2) return str;
StringValue(str2);
str_discard(str);
return str_replace(str, str2);
};T;0To;
; F; ;
;;;I"String#<=>;F;[[I" str2;T0;[[@)i ;T;;9;0;[ ;{ ;IC;"Comparison---Returns -1, 0, +1 or nil depending on whether +string+ is less
than, equal to, or greater than +other_string+.
+nil+ is returned if the two values are incomparable.
If the strings are of different lengths, and the strings are equal when
compared up to the shortest length, then the longer string is considered
greater than the shorter one.
<=> is the basis for the methods <,
<=, >, >=, and
between?, included from module Comparable. The method
String#== does not use Comparable#==.
"abcdef" <=> "abcde" #=> 1
"abcdef" <=> "abcdef" #=> 0
"abcdef" <=> "abcdefg" #=> -1
"abcdef" <=> "ABCDEF" #=> 1
"abcdef" <=> 1 #=> nil
;T;[o;
; I"
overload;F; 0;;9; 0; I"<=>(other_string);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [ I"-1;TI"0;TI"+1;TI"nil;T;"@z);#[ ;$I" @return [-1, 0, +1, nil];T;%0;"@z);&0;'F;(i ;[[I"other_string;T0;"@z);#[ ;$I"*
Comparison---Returns -1, 0, +1 or nil depending on whether +string+ is less
than, equal to, or greater than +other_string+.
+nil+ is returned if the two values are incomparable.
If the strings are of different lengths, and the strings are equal when
compared up to the shortest length, then the longer string is considered
greater than the shorter one.
<=> is the basis for the methods <,
<=, >, >=, and
between?, included from module Comparable. The method
String#== does not use Comparable#==.
"abcdef" <=> "abcde" #=> 1
"abcdef" <=> "abcdef" #=> 0
"abcdef" <=> "abcdefg" #=> -1
"abcdef" <=> "ABCDEF" #=> 1
"abcdef" <=> 1 #=> nil
@overload <=>(other_string)
@return [-1, 0, +1, nil];T;%0;"@z);'F;)o;*;+T;,il ;-i ;.@(; I"static VALUE;T;/I"mstatic VALUE
rb_str_cmp_m(VALUE str1, VALUE str2)
{
int result;
if (!RB_TYPE_P(str2, T_STRING)) {
VALUE tmp = rb_check_funcall(str2, idTo_str, 0, 0);
if (RB_TYPE_P(tmp, T_STRING)) {
result = rb_str_cmp(str1, tmp);
}
else {
return rb_invcmp(str1, str2);
}
}
else {
result = rb_str_cmp(str1, str2);
}
return INT2FIX(result);
};T;0To;
; F; ;
;;;I"String#==;F;[[I" str2;T0;[[@)iP ;T;;:;0;[ ;{ ;IC;"=== Equality
Returns whether +str+ == +obj+, similar to Object#==.
If +obj+ is not an instance of String but responds to +to_str+, then the
two strings are compared using case equality Object#===.
Otherwise, returns similarly to String#eql?, comparing length and content.
;T;[o;
; I"
overload;F; 0;;:; 0; I" ==(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@);#[ ;$I"@return [Boolean];T;%0;"@);&0;'F;(i ;[[I"obj;T0;"@)o;
; I"
overload;F; 0;;n; 0; I"
===(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@);#[ ;$I"@return [Boolean];T;%0;"@);&0;'F;(i ;[[I"obj;T0;"@);#[ ;$I"a=== Equality
Returns whether +str+ == +obj+, similar to Object#==.
If +obj+ is not an instance of String but responds to +to_str+, then the
two strings are compared using case equality Object#===.
Otherwise, returns similarly to String#eql?, comparing length and content.
@overload ==(obj)
@return [Boolean]
@overload ===(obj)
@return [Boolean];T;%0;"@);'F;)o;*;+T;,iA ;-iN ;.@(; I"
VALUE;T;/I"VALUE
rb_str_equal(VALUE str1, VALUE str2)
{
if (str1 == str2) return Qtrue;
if (!RB_TYPE_P(str2, T_STRING)) {
if (!rb_respond_to(str2, idTo_str)) {
return Qfalse;
}
return rb_equal(str2, str1);
}
return str_eql(str1, str2);
};T;0To;
; F; ;
;;;I"String#===;F;[[I" str2;T0;[[@)iP ;T;;n;0;[ ;{ ;IC;"=== Equality
Returns whether +str+ == +obj+, similar to Object#==.
If +obj+ is not an instance of String but responds to +to_str+, then the
two strings are compared using case equality Object#===.
Otherwise, returns similarly to String#eql?, comparing length and content.
;T;[o;
; I"
overload;F; 0;;:; 0; I" ==(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@);#[ ;$I"@return [Boolean];T;%0;"@);&0;'F;(i ;[[I"obj;T0;"@)o;
; I"
overload;F; 0;;n; 0; I"
===(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@);#[ ;$I"@return [Boolean];T;%0;"@);&0;'F;(i ;[[I"obj;T0;"@);#[ ;$@);%0;"@);'F;)o;*;+T;,iA ;-iN ;.@(; I"
VALUE;T;/I"VALUE
rb_str_equal(VALUE str1, VALUE str2)
{
if (str1 == str2) return Qtrue;
if (!RB_TYPE_P(str2, T_STRING)) {
if (!rb_respond_to(str2, idTo_str)) {
return Qfalse;
}
return rb_equal(str2, str1);
}
return str_eql(str1, str2);
};T;0To;
; F; ;
;;;I"String#eql?;F;[[I" str2;T0;[[@)id ;T;;q;0;[ ;{ ;IC;"DTwo strings are equal if they have the same length and content.
;T;[o;
; I"
overload;F; 0;;q; 0; I"eql?(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@);#[ ;$I"@return [Boolean];T;%0;"@);&0;'F;(i ;[[I"
other;T0;"@)o;!
; I" return;F; @;0; [@;"@);#[ ;$I"pTwo strings are equal if they have the same length and content.
@overload eql?(other)
@return [Boolean];T;%0;"@);'F;)o;*;+T;,i] ;-ia ;.@(; I"static VALUE;T;/I"static VALUE
rb_str_eql(VALUE str1, VALUE str2)
{
if (str1 == str2) return Qtrue;
if (!RB_TYPE_P(str2, T_STRING)) return Qfalse;
return str_eql(str1, str2);
};T;0To;
; F; ;
;;;I"String#hash;F;[ ;[[@)i
;T;;H;0;[ ;{ ;IC;"]Return a hash based on the string's length, content and encoding.
See also Object#hash.
;T;[o;
; I"
overload;F; 0;;H; 0; I" hash;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;T;"@*;#[ ;$I"@return [Fixnum];T;%0;"@*;&0;'F;(i ;[ ;"@*;#[ ;$I"|Return a hash based on the string's length, content and encoding.
See also Object#hash.
@overload hash
@return [Fixnum];T;%0;"@*;'F;)o;*;+T;,i
;-i
;.@(; I"static VALUE;T;/I"pstatic VALUE
rb_str_hash_m(VALUE str)
{
st_index_t hval = rb_str_hash(str);
return INT2FIX(hval);
};T;0To;
; F; ;
;;;I"String#casecmp;F;[[I" str2;T0;[[@)i ;T;: casecmp;0;[ ;{ ;IC;"Case-insensitive version of String#<=>.
"abcdef".casecmp("abcde") #=> 1
"aBcDeF".casecmp("abcdef") #=> 0
"abcdef".casecmp("abcdefg") #=> -1
"abcdef".casecmp("ABCDEF") #=> 0
;T;[o;
; I"
overload;F; 0;;U; 0; I"casecmp(other_str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [ I"-1;TI"0;TI"+1;TI"nil;T;"@4*;#[ ;$I" @return [-1, 0, +1, nil];T;%0;"@4*;&0;'F;(i ;[[I"other_str;T0;"@4*;#[ ;$I"Case-insensitive version of String#<=>.
"abcdef".casecmp("abcde") #=> 1
"aBcDeF".casecmp("abcdef") #=> 0
"abcdef".casecmp("abcdefg") #=> -1
"abcdef".casecmp("ABCDEF") #=> 0
@overload casecmp(other_str)
@return [-1, 0, +1, nil];T;%0;"@4*;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"sstatic VALUE
rb_str_casecmp(VALUE str1, VALUE str2)
{
long len;
rb_encoding *enc;
char *p1, *p1end, *p2, *p2end;
StringValue(str2);
enc = rb_enc_compatible(str1, str2);
if (!enc) {
return Qnil;
}
p1 = RSTRING_PTR(str1); p1end = RSTRING_END(str1);
p2 = RSTRING_PTR(str2); p2end = RSTRING_END(str2);
if (single_byte_optimizable(str1) && single_byte_optimizable(str2)) {
while (p1 < p1end && p2 < p2end) {
if (*p1 != *p2) {
unsigned int c1 = TOUPPER(*p1 & 0xff);
unsigned int c2 = TOUPPER(*p2 & 0xff);
if (c1 != c2)
return INT2FIX(c1 < c2 ? -1 : 1);
}
p1++;
p2++;
}
}
else {
while (p1 < p1end && p2 < p2end) {
int l1, c1 = rb_enc_ascget(p1, p1end, &l1, enc);
int l2, c2 = rb_enc_ascget(p2, p2end, &l2, enc);
if (0 <= c1 && 0 <= c2) {
c1 = TOUPPER(c1);
c2 = TOUPPER(c2);
if (c1 != c2)
return INT2FIX(c1 < c2 ? -1 : 1);
}
else {
int r;
l1 = rb_enc_mbclen(p1, p1end, enc);
l2 = rb_enc_mbclen(p2, p2end, enc);
len = l1 < l2 ? l1 : l2;
r = memcmp(p1, p2, len);
if (r != 0)
return INT2FIX(r < 0 ? -1 : 1);
if (l1 != l2)
return INT2FIX(l1 < l2 ? -1 : 1);
}
p1 += l1;
p2 += l2;
}
}
if (RSTRING_LEN(str1) == RSTRING_LEN(str2)) return INT2FIX(0);
if (RSTRING_LEN(str1) > RSTRING_LEN(str2)) return INT2FIX(1);
return INT2FIX(-1);
};T;0To;
; F; ;
;;;I"
String#+;F;[[I" str2;T0;[[@)ik;T;;2;0;[ ;{ ;IC;"Concatenation---Returns a new String containing
other_str concatenated to str.
"Hello from " + self.to_s #=> "Hello from main"
;T;[o;
; I"
overload;F; 0;;2; 0; I"+(other_str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@V*;#[ ;$I"@return [String];T;%0;"@V*;&0;'F;(i ;[[I"other_str;T0;"@V*;#[ ;$I"Concatenation---Returns a new String containing
other_str concatenated to str.
"Hello from " + self.to_s #=> "Hello from main"
@overload +(other_str)
@return [String];T;%0;"@V*;'F;)o;*;+T;,ia;-ih;.@(; I"
VALUE;T;/I"VALUE
rb_str_plus(VALUE str1, VALUE str2)
{
VALUE str3;
rb_encoding *enc;
char *ptr1, *ptr2, *ptr3;
long len1, len2;
int termlen;
StringValue(str2);
enc = rb_enc_check_str(str1, str2);
RSTRING_GETMEM(str1, ptr1, len1);
RSTRING_GETMEM(str2, ptr2, len2);
termlen = rb_enc_mbminlen(enc);
str3 = str_new0(rb_cString, 0, len1+len2, termlen);
ptr3 = RSTRING_PTR(str3);
memcpy(ptr3, ptr1, len1);
memcpy(ptr3+len1, ptr2, len2);
TERM_FILL(&ptr3[len1+len2], termlen);
FL_SET_RAW(str3, OBJ_TAINTED_RAW(str1) | OBJ_TAINTED_RAW(str2));
ENCODING_CODERANGE_SET(str3, rb_enc_to_index(enc),
ENC_CODERANGE_AND(ENC_CODERANGE(str1), ENC_CODERANGE(str2)));
RB_GC_GUARD(str1);
RB_GC_GUARD(str2);
return str3;
};T;0To;
; F; ;
;;;I"
String#*;F;[[I"
times;T0;[[@)i;T;;4;0;[ ;{ ;IC;"Copy --- Returns a new String containing +integer+ copies of the receiver.
+integer+ must be greater than or equal to 0.
"Ho! " * 3 #=> "Ho! Ho! Ho! "
"Ho! " * 0 #=> ""
;T;[o;
; I"
overload;F; 0;;4; 0; I"*(integer);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@u*;#[ ;$I"@return [String];T;%0;"@u*;&0;'F;(i ;[[I" integer;T0;"@u*;#[ ;$I"Copy --- Returns a new String containing +integer+ copies of the receiver.
+integer+ must be greater than or equal to 0.
"Ho! " * 3 #=> "Ho! Ho! Ho! "
"Ho! " * 0 #=> ""
@overload *(integer)
@return [String];T;%0;"@u*;'F;)o;*;+T;,i;-i;.@(; I"
VALUE;T;/I"VALUE
rb_str_times(VALUE str, VALUE times)
{
VALUE str2;
long n, len;
char *ptr2;
int termlen;
if (times == INT2FIX(1)) {
return rb_str_dup(str);
}
if (times == INT2FIX(0)) {
str2 = str_alloc(rb_obj_class(str));
rb_enc_copy(str2, str);
OBJ_INFECT(str2, str);
return str2;
}
len = NUM2LONG(times);
if (len < 0) {
rb_raise(rb_eArgError, "negative argument");
}
if (len && LONG_MAX/len < RSTRING_LEN(str)) {
rb_raise(rb_eArgError, "argument too big");
}
len *= RSTRING_LEN(str);
termlen = TERM_LEN(str);
str2 = str_new0(rb_obj_class(str), 0, len, termlen);
ptr2 = RSTRING_PTR(str2);
if (len) {
n = RSTRING_LEN(str);
memcpy(ptr2, RSTRING_PTR(str), n);
while (n <= len/2) {
memcpy(ptr2 + n, ptr2, n);
n *= 2;
}
memcpy(ptr2 + n, ptr2, len-n);
}
STR_SET_LEN(str2, len);
TERM_FILL(&ptr2[len], termlen);
OBJ_INFECT(str2, str);
rb_enc_cr_str_copy_for_substr(str2, str);
return str2;
};T;0To;
; F; ;
;;;I"
String#%;F;[[I"arg;T0;[[@)i;T;;;0;[ ;{ ;IC;"Format---Uses str as a format specification, and returns the result
of applying it to arg. If the format specification contains more than
one substitution, then arg must be an Array or Hash
containing the values to be substituted. See Kernel::sprintf for
details of the format string.
"%05d" % 123 #=> "00123"
"%-5s: %08x" % [ "ID", self.object_id ] #=> "ID : 200e14d6"
"foo = %{foo}" % { :foo => 'bar' } #=> "foo = bar"
;T;[o;
; I"
overload;F; 0;;; 0; I" %(arg);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@*;#[ ;$I"@return [String];T;%0;"@*;&0;'F;(i ;[[I"arg;T0;"@*;#[ ;$I"8Format---Uses str as a format specification, and returns the result
of applying it to arg. If the format specification contains more than
one substitution, then arg must be an Array or Hash
containing the values to be substituted. See Kernel::sprintf for
details of the format string.
"%05d" % 123 #=> "00123"
"%-5s: %08x" % [ "ID", self.object_id ] #=> "ID : 200e14d6"
"foo = %{foo}" % { :foo => 'bar' } #=> "foo = bar"
@overload %(arg)
@return [String];T;%0;"@*;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"static VALUE
rb_str_format_m(VALUE str, VALUE arg)
{
VALUE tmp = rb_check_array_type(arg);
if (!NIL_P(tmp)) {
VALUE rv = rb_str_format(RARRAY_LENINT(tmp), RARRAY_CONST_PTR(tmp), str);
RB_GC_GUARD(tmp);
return rv;
}
return rb_str_format(1, &arg, str);
};T;0To;
; F; ;
;;;I"String#[];F;[[@0;[[@)i;T;:[];0;[ ;{ ;IC;"Element Reference --- If passed a single +index+, returns a substring of
one character at that index. If passed a +start+ index and a +length+,
returns a substring containing +length+ characters starting at the
+start+ index. If passed a +range+, its beginning and end are interpreted as
offsets delimiting the substring to be returned.
In these three cases, if an index is negative, it is counted from the end
of the string. For the +start+ and +range+ cases the starting index
is just before a character and an index matching the string's size.
Additionally, an empty string is returned when the starting index for a
character range is at the end of the string.
Returns +nil+ if the initial index falls outside the string or the length
is negative.
If a +Regexp+ is supplied, the matching portion of the string is
returned. If a +capture+ follows the regular expression, which may be a
capture group index or name, follows the regular expression that component
of the MatchData is returned instead.
If a +match_str+ is given, that string is returned if it occurs in
the string.
Returns +nil+ if the regular expression does not match or the match string
cannot be found.
a = "hello there"
a[1] #=> "e"
a[2, 3] #=> "llo"
a[2..3] #=> "ll"
a[-3, 2] #=> "er"
a[7..-2] #=> "her"
a[-4..-2] #=> "her"
a[-2..-4] #=> ""
a[11, 0] #=> ""
a[11] #=> nil
a[12, 0] #=> nil
a[12..-1] #=> nil
a[/[aeiou](.)\1/] #=> "ell"
a[/[aeiou](.)\1/, 0] #=> "ell"
a[/[aeiou](.)\1/, 1] #=> "l"
a[/[aeiou](.)\1/, 2] #=> nil
a[/(?[aeiou])(?[^aeiou])/, "non_vowel"] #=> "l"
a[/(?[aeiou])(?[^aeiou])/, "vowel"] #=> "e"
a["lo"] #=> "lo"
a["bye"] #=> nil
;T;[o;
; I"
overload;F; 0;;V; 0; I"[](index);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@*;#[ ;$I"@return [String, nil];T;%0;"@*;&0;'F;(i ;[[I"
index;T0;"@*o;
; I"
overload;F; 0;;V; 0; I"[](start, length);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@*;#[ ;$I"@return [String, nil];T;%0;"@*;&0;'F;(i ;[[I"
start;T0[I" length;T0;"@*o;
; I"
overload;F; 0;;V; 0; I"[](range);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@*;#[ ;$I"@return [String, nil];T;%0;"@*;&0;'F;(i ;[[I"
range;T0;"@*o;
; I"
overload;F; 0;;V; 0; I"[](regexp);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@*;#[ ;$I"@return [String, nil];T;%0;"@*;&0;'F;(i ;[[I" regexp;T0;"@*o;
; I"
overload;F; 0;;V; 0; I"[](regexp, capture);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@*;#[ ;$I"@return [String, nil];T;%0;"@*;&0;'F;(i ;[[I" regexp;T0[I" capture;T0;"@*o;
; I"
overload;F; 0;;V; 0; I"[](match_str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@*;#[ ;$I"@return [String, nil];T;%0;"@*;&0;'F;(i ;[[I"match_str;T0;"@*o;
; I"
overload;F; 0;:
slice; 0; I"slice(index);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@*;#[ ;$I"@return [String, nil];T;%0;"@*;&0;'F;(i ;[[I"
index;T0;"@*o;
; I"
overload;F; 0;;W; 0; I"slice(start, length);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@*;#[ ;$I"@return [String, nil];T;%0;"@*;&0;'F;(i ;[[I"
start;T0[I" length;T0;"@*o;
; I"
overload;F; 0;;W; 0; I"slice(range);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@*;#[ ;$I"@return [String, nil];T;%0;"@*;&0;'F;(i ;[[I"
range;T0;"@*o;
; I"
overload;F; 0;;W; 0; I"slice(regexp);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@*;#[ ;$I"@return [String, nil];T;%0;"@*;&0;'F;(i ;[[I" regexp;T0;"@*o;
; I"
overload;F; 0;;W; 0; I"slice(regexp, capture);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@*;#[ ;$I"@return [String, nil];T;%0;"@*;&0;'F;(i ;[[I" regexp;T0[I" capture;T0;"@*o;
; I"
overload;F; 0;;W; 0; I"slice(match_str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@*;#[ ;$I"@return [String, nil];T;%0;"@*;&0;'F;(i ;[[I"match_str;T0;"@*;#[ ;$I" Element Reference --- If passed a single +index+, returns a substring of
one character at that index. If passed a +start+ index and a +length+,
returns a substring containing +length+ characters starting at the
+start+ index. If passed a +range+, its beginning and end are interpreted as
offsets delimiting the substring to be returned.
In these three cases, if an index is negative, it is counted from the end
of the string. For the +start+ and +range+ cases the starting index
is just before a character and an index matching the string's size.
Additionally, an empty string is returned when the starting index for a
character range is at the end of the string.
Returns +nil+ if the initial index falls outside the string or the length
is negative.
If a +Regexp+ is supplied, the matching portion of the string is
returned. If a +capture+ follows the regular expression, which may be a
capture group index or name, follows the regular expression that component
of the MatchData is returned instead.
If a +match_str+ is given, that string is returned if it occurs in
the string.
Returns +nil+ if the regular expression does not match or the match string
cannot be found.
a = "hello there"
a[1] #=> "e"
a[2, 3] #=> "llo"
a[2..3] #=> "ll"
a[-3, 2] #=> "er"
a[7..-2] #=> "her"
a[-4..-2] #=> "her"
a[-2..-4] #=> ""
a[11, 0] #=> ""
a[11] #=> nil
a[12, 0] #=> nil
a[12..-1] #=> nil
a[/[aeiou](.)\1/] #=> "ell"
a[/[aeiou](.)\1/, 0] #=> "ell"
a[/[aeiou](.)\1/, 1] #=> "l"
a[/[aeiou](.)\1/, 2] #=> nil
a[/(?[aeiou])(?[^aeiou])/, "non_vowel"] #=> "l"
a[/(?[aeiou])(?[^aeiou])/, "vowel"] #=> "e"
a["lo"] #=> "lo"
a["bye"] #=> nil
@overload [](index)
@return [String, nil]
@overload [](start, length)
@return [String, nil]
@overload [](range)
@return [String, nil]
@overload [](regexp)
@return [String, nil]
@overload [](regexp, capture)
@return [String, nil]
@overload [](match_str)
@return [String, nil]
@overload slice(index)
@return [String, nil]
@overload slice(start, length)
@return [String, nil]
@overload slice(range)
@return [String, nil]
@overload slice(regexp)
@return [String, nil]
@overload slice(regexp, capture)
@return [String, nil]
@overload slice(match_str)
@return [String, nil];T;%0;"@*;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"=static VALUE
rb_str_aref_m(int argc, VALUE *argv, VALUE str)
{
if (argc == 2) {
if (RB_TYPE_P(argv[0], T_REGEXP)) {
return rb_str_subpat(str, argv[0], argv[1]);
}
return rb_str_substr(str, NUM2LONG(argv[0]), NUM2LONG(argv[1]));
}
rb_check_arity(argc, 1, 2);
return rb_str_aref(str, argv[0]);
};T;0To;
; F; ;
;;;I"String#[]=;F;[[@0;[[@)i;T;:[]=;0;[ ;{ ;IC;"Element Assignment---Replaces some or all of the content of str. The
portion of the string affected is determined using the same criteria as
String#[]. If the replacement string is not the same length as
the text it is replacing, the string will be adjusted accordingly. If the
regular expression or string is used as the index doesn't match a position
in the string, IndexError is raised. If the regular expression
form is used, the optional second Fixnum allows you to specify
which portion of the match to replace (effectively using the
MatchData indexing rules. The forms that take a
Fixnum will raise an IndexError if the value is
out of range; the Range form will raise a
RangeError, and the Regexp and String
will raise an IndexError on negative match.
;T;[ o;
; I"
overload;F; 0;;X; 0; I"[]=(fixnum);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@+;&0;'F;(i ;[[I" fixnum;T0;"@+o;
; I"
overload;F; 0;;X; 0; I"[]=(fixnum, fixnum);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@+;&0;'F;(i ;[[I" fixnum;T0[I" fixnum;T0;"@+o;
; I"
overload;F; 0;;X; 0; I"[]=(range);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@+;&0;'F;(i ;[[I"
range;T0;"@+o;
; I"
overload;F; 0;;X; 0; I"[]=(regexp);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@+;&0;'F;(i ;[[I" regexp;T0;"@+o;
; I"
overload;F; 0;;X; 0; I"[]=(regexp, fixnum);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@+;&0;'F;(i ;[[I" regexp;T0[I" fixnum;T0;"@+o;
; I"
overload;F; 0;;X; 0; I"[]=(regexp, name);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@+;&0;'F;(i ;[[I" regexp;T0[I" name;T0;"@+o;
; I"
overload;F; 0;;X; 0; I"[]=(other_str);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@+;&0;'F;(i ;[[I"other_str;T0;"@+;#[ ;$I"AElement Assignment---Replaces some or all of the content of str. The
portion of the string affected is determined using the same criteria as
String#[]. If the replacement string is not the same length as
the text it is replacing, the string will be adjusted accordingly. If the
regular expression or string is used as the index doesn't match a position
in the string, IndexError is raised. If the regular expression
form is used, the optional second Fixnum allows you to specify
which portion of the match to replace (effectively using the
MatchData indexing rules. The forms that take a
Fixnum will raise an IndexError if the value is
out of range; the Range form will raise a
RangeError, and the Regexp and String
will raise an IndexError on negative match.
@overload []=(fixnum)
@overload []=(fixnum, fixnum)
@overload []=(range)
@overload []=(regexp)
@overload []=(regexp, fixnum)
@overload []=(regexp, name)
@overload []=(other_str);T;%0;"@+;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"nstatic VALUE
rb_str_aset_m(int argc, VALUE *argv, VALUE str)
{
if (argc == 3) {
if (RB_TYPE_P(argv[0], T_REGEXP)) {
rb_str_subpat_set(str, argv[0], argv[1], argv[2]);
}
else {
rb_str_splice(str, NUM2LONG(argv[0]), NUM2LONG(argv[1]), argv[2]);
}
return argv[2];
}
rb_check_arity(argc, 2, 3);
return rb_str_aset(str, argv[0], argv[1]);
};T;0To;
; F; ;
;;;I"String#insert;F;[[I"idx;T0[I" str2;T0;[[@)i;T;: insert;0;[ ;{ ;IC;"Inserts other_str before the character at the given
index, modifying str. Negative indices count from the
end of the string, and insert after the given character.
The intent is insert aString so that it starts at the given
index.
"abcd".insert(0, 'X') #=> "Xabcd"
"abcd".insert(3, 'X') #=> "abcXd"
"abcd".insert(4, 'X') #=> "abcdX"
"abcd".insert(-3, 'X') #=> "abXcd"
"abcd".insert(-1, 'X') #=> "abcdX"
;T;[o;
; I"
overload;F; 0;;Y; 0; I" insert(index, other_str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@+;#[ ;$I"@return [String];T;%0;"@+;&0;'F;(i ;[[I"
index;T0[I"other_str;T0;"@+;#[ ;$I"Inserts other_str before the character at the given
index, modifying str. Negative indices count from the
end of the string, and insert after the given character.
The intent is insert aString so that it starts at the given
index.
"abcd".insert(0, 'X') #=> "Xabcd"
"abcd".insert(3, 'X') #=> "abcXd"
"abcd".insert(4, 'X') #=> "abcdX"
"abcd".insert(-3, 'X') #=> "abXcd"
"abcd".insert(-1, 'X') #=> "abcdX"
@overload insert(index, other_str)
@return [String];T;%0;"@+;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"static VALUE
rb_str_insert(VALUE str, VALUE idx, VALUE str2)
{
long pos = NUM2LONG(idx);
if (pos == -1) {
return rb_str_append(str, str2);
}
else if (pos < 0) {
pos++;
}
rb_str_splice(str, pos, 0, str2);
return str;
};T;0To;
; F; ;
;;;I"String#length;F;[ ;[[@)i8;T;: length;0;[ ;{ ;IC;"0Returns the character length of str.
;T;[o;
; I"
overload;F; 0;;Z; 0; I" length;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@,;#[ ;$I"@return [Integer];T;%0;"@,;&0;'F;(i ;[ ;"@,o;
; I"
overload;F; 0;: size; 0; I" size;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@,;#[ ;$I"@return [Integer];T;%0;"@,;&0;'F;(i ;[ ;"@,;#[ ;$I"zReturns the character length of str.
@overload length
@return [Integer]
@overload size
@return [Integer];T;%0;"@,;'F;)o;*;+T;,i0;-i6;.@(; I"
VALUE;T;/I"SVALUE
rb_str_length(VALUE str)
{
return LONG2NUM(str_strlen(str, NULL));
};T;0To;
; F; ;
;;;I"String#size;F;[ ;[[@)i8;T;;[;0;[ ;{ ;IC;"0Returns the character length of str.
;T;[o;
; I"
overload;F; 0;;Z; 0; I" length;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@0,;#[ ;$I"@return [Integer];T;%0;"@0,;&0;'F;(i ;[ ;"@0,o;
; I"
overload;F; 0;;[; 0; I" size;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@0,;#[ ;$I"@return [Integer];T;%0;"@0,;&0;'F;(i ;[ ;"@0,;#[ ;$@,,;%0;"@0,;'F;)o;*;+T;,i0;-i6;.@(; I"
VALUE;T;/I"SVALUE
rb_str_length(VALUE str)
{
return LONG2NUM(str_strlen(str, NULL));
};T;0To;
; F; ;
;;;I"String#bytesize;F;[ ;[[@)iH;T;:
bytesize;0;[ ;{ ;IC;"iReturns the length of +str+ in bytes.
"\x80\u3042".bytesize #=> 4
"hello".bytesize #=> 5
;T;[o;
; I"
overload;F; 0;;\; 0; I"
bytesize;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@W,;#[ ;$I"@return [Integer];T;%0;"@W,;&0;'F;(i ;[ ;"@W,;#[ ;$I"Returns the length of +str+ in bytes.
"\x80\u3042".bytesize #=> 4
"hello".bytesize #=> 5
@overload bytesize
@return [Integer];T;%0;"@W,;'F;)o;*;+T;,i>;-iE;.@(; I"static VALUE;T;/I"Wstatic VALUE
rb_str_bytesize(VALUE str)
{
return LONG2NUM(RSTRING_LEN(str));
};T;0To;
; F; ;
;;;I"String#empty?;F;[ ;[[@)iY;T;: empty?;0;[ ;{ ;IC;"Returns true if str has a length of zero.
"hello".empty? #=> false
" ".empty? #=> false
"".empty? #=> true
;T;[o;
; I"
overload;F; 0;;]; 0; I" empty?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@r,;#[ ;$I"@return [Boolean];T;%0;"@r,;&0;'F;(i ;[ ;"@r,o;!
; I" return;F; @;0; [@;"@r,;#[ ;$I"Returns true if str has a length of zero.
"hello".empty? #=> false
" ".empty? #=> false
"".empty? #=> true
@overload empty?
@return [Boolean];T;%0;"@r,;'F;)o;*;+T;,iN;-iV;.@(; I"static VALUE;T;/I"nstatic VALUE
rb_str_empty(VALUE str)
{
if (RSTRING_LEN(str) == 0)
return Qtrue;
return Qfalse;
};T;0To;
; F; ;
;;;I"String#=~;F;[[I"y;T0;[[@)i
;T;;o;0;[ ;{ ;IC;"FMatch---If obj is a Regexp, use it as a pattern to match
against str,and returns the position the match starts, or
nil if there is no match. Otherwise, invokes
obj.=~, passing str as an argument. The default
=~ in Object returns nil.
Note: str =~ regexp is not the same as
regexp =~ str. Strings captured from named capture groups
are assigned to local variables only in the second case.
"cat o' 9 tails" =~ /\d/ #=> 7
"cat o' 9 tails" =~ 9 #=> nil
;T;[o;
; I"
overload;F; 0;;o; 0; I" =~(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;TI"nil;T;"@,;#[ ;$I"@return [Fixnum, nil];T;%0;"@,;&0;'F;(i ;[[I"obj;T0;"@,;#[ ;$I"rMatch---If obj is a Regexp, use it as a pattern to match
against str,and returns the position the match starts, or
nil if there is no match. Otherwise, invokes
obj.=~, passing str as an argument. The default
=~ in Object returns nil.
Note: str =~ regexp is not the same as
regexp =~ str. Strings captured from named capture groups
are assigned to local variables only in the second case.
"cat o' 9 tails" =~ /\d/ #=> 7
"cat o' 9 tails" =~ 9 #=> nil
@overload =~(obj)
@return [Fixnum, nil];T;%0;"@,;'F;)o;*;+T;,i
;-i
;.@(; I"static VALUE;T;/I"Estatic VALUE
rb_str_match(VALUE x, VALUE y)
{
if (SPECIAL_CONST_P(y)) goto generic;
switch (BUILTIN_TYPE(y)) {
case T_STRING:
rb_raise(rb_eTypeError, "type mismatch: String given");
case T_REGEXP:
return rb_reg_match(y, x);
generic:
default:
return rb_funcall(y, idEqTilde, 1, x);
}
};T;0To;
; F; ;
;;;I"String#match;F;[[@0;[[@)iD
;T;:
match;0;[ ;{ ;IC;"Converts pattern to a Regexp (if it isn't already one),
then invokes its match method on str. If the second
parameter is present, it specifies the position in the string to begin the
search.
'hello'.match('(.)\1') #=> #
'hello'.match('(.)\1')[0] #=> "ll"
'hello'.match(/(.)\1/)[0] #=> "ll"
'hello'.match('xx') #=> nil
If a block is given, invoke the block with MatchData if match succeed, so
that you can write
str.match(pat) {|m| ...}
instead of
if m = str.match(pat)
...
end
The return value is a value from block execution in this case.
;T;[o;
; I"
overload;F; 0;;^; 0; I"match(pattern);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"MatchData;TI"nil;T;"@,;#[ ;$I" @return [MatchData, nil];T;%0;"@,;&0;'F;(i ;[[I" pattern;T0;"@,o;
; I"
overload;F; 0;;^; 0; I"match(pattern, pos);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"MatchData;TI"nil;T;"@,;#[ ;$I" @return [MatchData, nil];T;%0;"@,;&0;'F;(i ;[[I" pattern;T0[I"pos;T0;"@,;#[ ;$I"Converts pattern to a Regexp (if it isn't already one),
then invokes its match method on str. If the second
parameter is present, it specifies the position in the string to begin the
search.
'hello'.match('(.)\1') #=> #
'hello'.match('(.)\1')[0] #=> "ll"
'hello'.match(/(.)\1/)[0] #=> "ll"
'hello'.match('xx') #=> nil
If a block is given, invoke the block with MatchData if match succeed, so
that you can write
str.match(pat) {|m| ...}
instead of
if m = str.match(pat)
...
end
The return value is a value from block execution in this case.
@overload match(pattern)
@return [MatchData, nil]
@overload match(pattern, pos)
@return [MatchData, nil];T;%0;"@,;'F;)o;*;+T;,i'
;-iB
;.@(; I"static VALUE;T;/I"Ustatic VALUE
rb_str_match_m(int argc, VALUE *argv, VALUE str)
{
VALUE re, result;
if (argc < 1)
rb_check_arity(argc, 1, 2);
re = argv[0];
argv[0] = str;
result = rb_funcall2(get_pat(re), rb_intern("match"), argc, argv);
if (!NIL_P(result) && rb_block_given_p()) {
return rb_yield(result);
}
return result;
};T;0To;
; F; ;
;;;I"String#succ;F;[ ;[[@)i%;T;;;0;[ ;{ ;IC;")Returns the successor to str. The successor is calculated by
incrementing characters starting from the rightmost alphanumeric (or
the rightmost character if there are no alphanumerics) in the
string. Incrementing a digit always results in another digit, and
incrementing a letter results in another letter of the same case.
Incrementing nonalphanumerics uses the underlying character set's
collating sequence.
If the increment generates a ``carry,'' the character to the left of
it is incremented. This process repeats until there is no carry,
adding an additional character if necessary.
"abcd".succ #=> "abce"
"THX1138".succ #=> "THX1139"
"<>".succ #=> "<>"
"1999zzz".succ #=> "2000aaa"
"ZZZ9999".succ #=> "AAAA0000"
"***".succ #=> "**+"
;T;[o;
; I"
overload;F; 0;;; 0; I" succ;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@,;#[ ;$I"@return [String];T;%0;"@,;&0;'F;(i ;[ ;"@,o;
; I"
overload;F; 0;;; 0; I" next;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@,;#[ ;$I"@return [String];T;%0;"@,;&0;'F;(i ;[ ;"@,;#[ ;$I"oReturns the successor to str. The successor is calculated by
incrementing characters starting from the rightmost alphanumeric (or
the rightmost character if there are no alphanumerics) in the
string. Incrementing a digit always results in another digit, and
incrementing a letter results in another letter of the same case.
Incrementing nonalphanumerics uses the underlying character set's
collating sequence.
If the increment generates a ``carry,'' the character to the left of
it is incremented. This process repeats until there is no carry,
adding an additional character if necessary.
"abcd".succ #=> "abce"
"THX1138".succ #=> "THX1139"
"<>".succ #=> "<>"
"1999zzz".succ #=> "2000aaa"
"ZZZ9999".succ #=> "AAAA0000"
"***".succ #=> "**+"
@overload succ
@return [String]
@overload next
@return [String];T;%0;"@,;'F;)o;*;+T;,i ;-i#;.@(; I"
VALUE;T;/I"VALUE
rb_str_succ(VALUE orig)
{
VALUE str;
str = rb_str_new_with_class(orig, RSTRING_PTR(orig), RSTRING_LEN(orig));
rb_enc_cr_str_copy_for_substr(str, orig);
OBJ_INFECT(str, orig);
return str_succ(str);
};T;0To;
; F; ;
;;;I"String#succ!;F;[ ;[[@)i;T;:
succ!;0;[ ;{ ;IC;"PEquivalent to String#succ, but modifies the receiver in
place.
;T;[o;
; I"
overload;F; 0;;_; 0; I"
succ!;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@ -;#[ ;$I"@return [String];T;%0;"@ -;&0;'F;(i ;[ ;"@ -o;
; I"
overload;F; 0;:
next!; 0; I"
next!;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@ -;#[ ;$I"@return [String];T;%0;"@ -;&0;'F;(i ;[ ;"@ -;#[ ;$I"Equivalent to String#succ, but modifies the receiver in
place.
@overload succ!
@return [String]
@overload next!
@return [String];T;%0;"@ -;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"lstatic VALUE
rb_str_succ_bang(VALUE str)
{
rb_str_modify(str);
str_succ(str);
return str;
};T;0To;
; F; ;
;;;I"String#next;F;[ ;[[@)i%;T;;;0;[ ;{ ;IC;")Returns the successor to str. The successor is calculated by
incrementing characters starting from the rightmost alphanumeric (or
the rightmost character if there are no alphanumerics) in the
string. Incrementing a digit always results in another digit, and
incrementing a letter results in another letter of the same case.
Incrementing nonalphanumerics uses the underlying character set's
collating sequence.
If the increment generates a ``carry,'' the character to the left of
it is incremented. This process repeats until there is no carry,
adding an additional character if necessary.
"abcd".succ #=> "abce"
"THX1138".succ #=> "THX1139"
"<>".succ #=> "<>"
"1999zzz".succ #=> "2000aaa"
"ZZZ9999".succ #=> "AAAA0000"
"***".succ #=> "**+"
;T;[o;
; I"
overload;F; 0;;; 0; I" succ;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@1-;#[ ;$I"@return [String];T;%0;"@1-;&0;'F;(i ;[ ;"@1-o;
; I"
overload;F; 0;;; 0; I" next;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@1-;#[ ;$I"@return [String];T;%0;"@1-;&0;'F;(i ;[ ;"@1-;#[ ;$@-;%0;"@1-;'F;)o;*;+T;,i ;-i#;.@(; I"
VALUE;T;/I"VALUE
rb_str_succ(VALUE orig)
{
VALUE str;
str = rb_str_new_with_class(orig, RSTRING_PTR(orig), RSTRING_LEN(orig));
rb_enc_cr_str_copy_for_substr(str, orig);
OBJ_INFECT(str, orig);
return str_succ(str);
};T;0To;
; F; ;
;;;I"String#next!;F;[ ;[[@)i;T;;`;0;[ ;{ ;IC;"PEquivalent to String#succ, but modifies the receiver in
place.
;T;[o;
; I"
overload;F; 0;;_; 0; I"
succ!;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@X-;#[ ;$I"@return [String];T;%0;"@X-;&0;'F;(i ;[ ;"@X-o;
; I"
overload;F; 0;;`; 0; I"
next!;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@X-;#[ ;$I"@return [String];T;%0;"@X-;&0;'F;(i ;[ ;"@X-;#[ ;$@--;%0;"@X-;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"lstatic VALUE
rb_str_succ_bang(VALUE str)
{
rb_str_modify(str);
str_succ(str);
return str;
};T;0To;
; F; ;
;;;I"String#upto;F;[[@0;[[@)i;T;;;0;[ ;{ ;IC;"Iterates through successive values, starting at str and
ending at other_str inclusive, passing each value in turn to
the block. The String#succ method is used to generate
each value. If optional second argument exclusive is omitted or is false,
the last value will be included; otherwise it will be excluded.
If no block is given, an enumerator is returned instead.
"a8".upto("b6") {|s| print s, ' ' }
for s in "a8".."b6"
print s, ' '
end
produces:
a8 a9 b0 b1 b2 b3 b4 b5 b6
a8 a9 b0 b1 b2 b3 b4 b5 b6
If str and other_str contains only ascii numeric characters,
both are recognized as decimal numbers. In addition, the width of
string (e.g. leading zeros) is handled appropriately.
"9".upto("11").to_a #=> ["9", "10", "11"]
"25".upto("5").to_a #=> []
"07".upto("11").to_a #=> ["07", "08", "09", "10", "11"]
;T;[o;
; I"
overload;F; 0;;; 0; I"%upto(other_str, exclusive=false);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"s;T;"@-o;!
; I" return;F; I" ;T;0; [I" String;T;"@-;#[ ;$I" @yield [s]
@return [String];T;%0;"@-;&0;'F;(i ;[[I"other_str;T0[I"exclusive;TI"
false;T;"@-o;
; I"
overload;F; 0;;; 0; I"%upto(other_str, exclusive=false);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@-;&0;'F;(i ;[[I"other_str;T0[I"exclusive;TI"
false;T;"@-;#[ ;$I"Iterates through successive values, starting at str and
ending at other_str inclusive, passing each value in turn to
the block. The String#succ method is used to generate
each value. If optional second argument exclusive is omitted or is false,
the last value will be included; otherwise it will be excluded.
If no block is given, an enumerator is returned instead.
"a8".upto("b6") {|s| print s, ' ' }
for s in "a8".."b6"
print s, ' '
end
produces:
a8 a9 b0 b1 b2 b3 b4 b5 b6
a8 a9 b0 b1 b2 b3 b4 b5 b6
If str and other_str contains only ascii numeric characters,
both are recognized as decimal numbers. In addition, the width of
string (e.g. leading zeros) is handled appropriately.
"9".upto("11").to_a #=> ["9", "10", "11"]
"25".upto("5").to_a #=> []
"07".upto("11").to_a #=> ["07", "08", "09", "10", "11"]
@overload upto(other_str, exclusive=false)
@yield [s]
@return [String]
@overload upto(other_str, exclusive=false);T;%0;"@-;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"static VALUE
rb_str_upto(int argc, VALUE *argv, VALUE beg)
{
VALUE end, exclusive;
rb_scan_args(argc, argv, "11", &end, &exclusive);
RETURN_ENUMERATOR(beg, argc, argv);
return str_upto_each(beg, end, RTEST(exclusive), str_upto_i, Qnil);
};T;0To;
; F; ;
;;;I"String#index;F;[[@0;[[@)i ;T;:
index;0;[ ;{ ;IC;"Returns the index of the first occurrence of the given substring or
pattern (regexp) in str. Returns nil if not
found. If the second parameter is present, it specifies the position in the
string to begin the search.
"hello".index('e') #=> 1
"hello".index('lo') #=> 3
"hello".index('a') #=> nil
"hello".index(?e) #=> 1
"hello".index(/[aeiou]/, -3) #=> 4
;T;[o;
; I"
overload;F; 0;;a; 0; I" index(substring [, offset]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;TI"nil;T;"@-;#[ ;$I"@return [Fixnum, nil];T;%0;"@-;&0;'F;(i ;[[I"substring[, offset];T0;"@-o;
; I"
overload;F; 0;;a; 0; I" index(regexp [, offset]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;TI"nil;T;"@-;#[ ;$I"@return [Fixnum, nil];T;%0;"@-;&0;'F;(i ;[[I"regexp[, offset];T0;"@-;#[ ;$I"?Returns the index of the first occurrence of the given substring or
pattern (regexp) in str. Returns nil if not
found. If the second parameter is present, it specifies the position in the
string to begin the search.
"hello".index('e') #=> 1
"hello".index('lo') #=> 3
"hello".index('a') #=> nil
"hello".index(?e) #=> 1
"hello".index(/[aeiou]/, -3) #=> 4
@overload index(substring [, offset])
@return [Fixnum, nil]
@overload index(regexp [, offset])
@return [Fixnum, nil];T;%0;"@-;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"rstatic VALUE
rb_str_index_m(int argc, VALUE *argv, VALUE str)
{
VALUE sub;
VALUE initpos;
long pos;
if (rb_scan_args(argc, argv, "11", &sub, &initpos) == 2) {
pos = NUM2LONG(initpos);
}
else {
pos = 0;
}
if (pos < 0) {
pos += str_strlen(str, NULL);
if (pos < 0) {
if (RB_TYPE_P(sub, T_REGEXP)) {
rb_backref_set(Qnil);
}
return Qnil;
}
}
if (SPECIAL_CONST_P(sub)) goto generic;
switch (BUILTIN_TYPE(sub)) {
case T_REGEXP:
if (pos > str_strlen(str, NULL))
return Qnil;
pos = str_offset(RSTRING_PTR(str), RSTRING_END(str), pos,
rb_enc_check(str, sub), single_byte_optimizable(str));
pos = rb_reg_search(sub, str, pos, 0);
pos = rb_str_sublen(str, pos);
break;
generic:
default: {
VALUE tmp;
tmp = rb_check_string_type(sub);
if (NIL_P(tmp)) {
rb_raise(rb_eTypeError, "type mismatch: %s given",
rb_obj_classname(sub));
}
sub = tmp;
}
/* fall through */
case T_STRING:
pos = rb_str_index(str, sub, pos);
pos = rb_str_sublen(str, pos);
break;
}
if (pos == -1) return Qnil;
return LONG2NUM(pos);
};T;0To;
; F; ;
;;;I"String#rindex;F;[[@0;[[@)i ;T;: rindex;0;[ ;{ ;IC;"Returns the index of the last occurrence of the given substring or
pattern (regexp) in str. Returns nil if not
found. If the second parameter is present, it specifies the position in the
string to end the search---characters beyond this point will not be
considered.
"hello".rindex('e') #=> 1
"hello".rindex('l') #=> 3
"hello".rindex('a') #=> nil
"hello".rindex(?e) #=> 1
"hello".rindex(/[aeiou]/, -2) #=> 1
;T;[o;
; I"
overload;F; 0;;b; 0; I"!rindex(substring [, fixnum]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;TI"nil;T;"@-;#[ ;$I"@return [Fixnum, nil];T;%0;"@-;&0;'F;(i ;[[I"substring[, fixnum];T0;"@-o;
; I"
overload;F; 0;;b; 0; I" rindex(regexp [, fixnum]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;TI"nil;T;"@-;#[ ;$I"@return [Fixnum, nil];T;%0;"@-;&0;'F;(i ;[[I"regexp[, fixnum];T0;"@-;#[ ;$I"yReturns the index of the last occurrence of the given substring or
pattern (regexp) in str. Returns nil if not
found. If the second parameter is present, it specifies the position in the
string to end the search---characters beyond this point will not be
considered.
"hello".rindex('e') #=> 1
"hello".rindex('l') #=> 3
"hello".rindex('a') #=> nil
"hello".rindex(?e) #=> 1
"hello".rindex(/[aeiou]/, -2) #=> 1
@overload rindex(substring [, fixnum])
@return [Fixnum, nil]
@overload rindex(regexp [, fixnum])
@return [Fixnum, nil];T;%0;"@-;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"static VALUE
rb_str_rindex_m(int argc, VALUE *argv, VALUE str)
{
VALUE sub;
VALUE vpos;
rb_encoding *enc = STR_ENC_GET(str);
long pos, len = str_strlen(str, enc); /* str's enc */
if (rb_scan_args(argc, argv, "11", &sub, &vpos) == 2) {
pos = NUM2LONG(vpos);
if (pos < 0) {
pos += len;
if (pos < 0) {
if (RB_TYPE_P(sub, T_REGEXP)) {
rb_backref_set(Qnil);
}
return Qnil;
}
}
if (pos > len) pos = len;
}
else {
pos = len;
}
if (SPECIAL_CONST_P(sub)) goto generic;
switch (BUILTIN_TYPE(sub)) {
case T_REGEXP:
/* enc = rb_get_check(str, sub); */
pos = str_offset(RSTRING_PTR(str), RSTRING_END(str), pos,
enc, single_byte_optimizable(str));
if (!RREGEXP(sub)->ptr || RREGEXP_SRC_LEN(sub)) {
pos = rb_reg_search(sub, str, pos, 1);
pos = rb_str_sublen(str, pos);
}
if (pos >= 0) return LONG2NUM(pos);
break;
generic:
default: {
VALUE tmp;
tmp = rb_check_string_type(sub);
if (NIL_P(tmp)) {
rb_raise(rb_eTypeError, "type mismatch: %s given",
rb_obj_classname(sub));
}
sub = tmp;
}
/* fall through */
case T_STRING:
pos = rb_str_rindex(str, sub, pos);
if (pos >= 0) return LONG2NUM(pos);
break;
}
return Qnil;
};T;0To;
; F; ;
;;;I"String#replace;F;[[I" str2;T0;[[@)i;T;;T;0;[ ;{ ;IC;"Replaces the contents and taintedness of str with the corresponding
values in other_str.
s = "hello" #=> "hello"
s.replace "world" #=> "world"
;T;[o;
; I"
overload;F; 0;;T; 0; I"replace(other_str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@.;#[ ;$I"@return [String];T;%0;"@.;&0;'F;(i ;[[I"other_str;T0;"@.;#[ ;$@v);%0;"@.;'F;)o;*;+T;,i;-i;.@(; I"
VALUE;T;/I"VALUE
rb_str_replace(VALUE str, VALUE str2)
{
str_modifiable(str);
if (str == str2) return str;
StringValue(str2);
str_discard(str);
return str_replace(str, str2);
};T;0To;
; F; ;
;;;I"String#clear;F;[ ;[[@)i;T;:
clear;0;[ ;{ ;IC;"=Makes string empty.
a = "abcde"
a.clear #=> ""
;T;[o;
; I"
overload;F; 0;;c; 0; I"
clear;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@..;#[ ;$I"@return [String];T;%0;"@..;&0;'F;(i ;[ ;"@..;#[ ;$I"bMakes string empty.
a = "abcde"
a.clear #=> ""
@overload clear
@return [String];T;%0;"@..;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"4static VALUE
rb_str_clear(VALUE str)
{
str_discard(str);
STR_SET_EMBED(str);
STR_SET_EMBED_LEN(str, 0);
RSTRING_PTR(str)[0] = 0;
if (rb_enc_asciicompat(STR_ENC_GET(str)))
ENC_CODERANGE_SET(str, ENC_CODERANGE_7BIT);
else
ENC_CODERANGE_SET(str, ENC_CODERANGE_VALID);
return str;
};T;0To;
; F; ;
;;;I"String#chr;F;[ ;[[@)i;T;;;0;[ ;{ ;IC;"gReturns a one-character string at the beginning of the string.
a = "abcde"
a.chr #=> "a"
;T;[o;
; I"
overload;F; 0;;; 0; I"chr;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@I.;#[ ;$I"@return [String];T;%0;"@I.;&0;'F;(i ;[ ;"@I.;#[ ;$I"Returns a one-character string at the beginning of the string.
a = "abcde"
a.chr #=> "a"
@overload chr
@return [String];T;%0;"@I.;'F;)o;*;+T;,i
;-i;.@(; I"static VALUE;T;/I"Pstatic VALUE
rb_str_chr(VALUE str)
{
return rb_str_substr(str, 0, 1);
};T;0To;
; F; ;
;;;I"String#getbyte;F;[[I"
index;T0;[[@)i ;T;: getbyte;0;[ ;{ ;IC;"3returns the indexth byte as an integer.
;T;[o;
; I"
overload;F; 0;;d; 0; I"getbyte(index);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
0 .. 255;T;"@d.;#[ ;$I"@return [0 .. 255];T;%0;"@d.;&0;'F;(i ;[[I"
index;T0;"@d.;#[ ;$I"creturns the indexth byte as an integer.
@overload getbyte(index)
@return [0 .. 255];T;%0;"@d.;'F;)o;*;+T;,i;-i ;.@(; I"static VALUE;T;/I"static VALUE
rb_str_getbyte(VALUE str, VALUE index)
{
long pos = NUM2LONG(index);
if (pos < 0)
pos += RSTRING_LEN(str);
if (pos < 0 || RSTRING_LEN(str) <= pos)
return Qnil;
return INT2FIX((unsigned char)RSTRING_PTR(str)[pos]);
};T;0To;
; F; ;
;;;I"String#setbyte;F;[[I"
index;T0[I"
value;T0;[[@)i3;T;: setbyte;0;[ ;{ ;IC;"8modifies the indexth byte as integer.
;T;[o;
; I"
overload;F; 0;;e; 0; I" setbyte(index, integer);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@.;#[ ;$I"@return [Integer];T;%0;"@.;&0;'F;(i ;[[I"
index;T0[I" integer;T0;"@.;#[ ;$I"pmodifies the indexth byte as integer.
@overload setbyte(index, integer)
@return [Integer];T;%0;"@.;'F;)o;*;+T;,i-;-i1;.@(; I"static VALUE;T;/I"static VALUE
rb_str_setbyte(VALUE str, VALUE index, VALUE value)
{
long pos = NUM2LONG(index);
int byte = NUM2INT(value);
long len = RSTRING_LEN(str);
char *head, *ptr, *left = 0;
rb_encoding *enc;
int cr = ENC_CODERANGE_UNKNOWN, width, nlen;
if (pos < -len || len <= pos)
rb_raise(rb_eIndexError, "index %ld out of string", pos);
if (pos < 0)
pos += len;
if (!str_independent(str))
str_make_independent(str);
enc = STR_ENC_GET(str);
head = RSTRING_PTR(str);
ptr = &head[pos];
if (len > (RSTRING_EMBED_LEN_MAX + 1 - rb_enc_mbminlen(enc))) {
cr = ENC_CODERANGE(str);
switch (cr) {
case ENC_CODERANGE_7BIT:
left = ptr;
*ptr = byte;
if (ISASCII(byte)) break;
nlen = rb_enc_precise_mbclen(left, head+len, enc);
if (!MBCLEN_CHARFOUND_P(nlen))
ENC_CODERANGE_SET(str, ENC_CODERANGE_BROKEN);
else
ENC_CODERANGE_SET(str, ENC_CODERANGE_VALID);
goto end;
case ENC_CODERANGE_VALID:
left = rb_enc_left_char_head(head, ptr, head+len, enc);
width = rb_enc_precise_mbclen(left, head+len, enc);
*ptr = byte;
nlen = rb_enc_precise_mbclen(left, head+len, enc);
if (!MBCLEN_CHARFOUND_P(nlen))
ENC_CODERANGE_SET(str, ENC_CODERANGE_BROKEN);
else if (MBCLEN_CHARFOUND_LEN(nlen) != width || ISASCII(byte))
ENC_CODERANGE_CLEAR(str);
goto end;
}
}
ENC_CODERANGE_CLEAR(str);
*ptr = byte;
end:
return value;
};T;0To;
; F; ;
;;;I"String#byteslice;F;[[@0;[[@)i;T;:byteslice;0;[ ;{ ;IC;"VByte Reference---If passed a single Fixnum, returns a
substring of one byte at that position. If passed two Fixnum
objects, returns a substring starting at the offset given by the first, and
a length given by the second. If given a Range, a substring containing
bytes at offsets given by the range is returned. In all three cases, if
an offset is negative, it is counted from the end of str. Returns
nil if the initial offset falls outside the string, the length
is negative, or the beginning of the range is greater than the end.
The encoding of the resulted string keeps original encoding.
"hello".byteslice(1) #=> "e"
"hello".byteslice(-1) #=> "o"
"hello".byteslice(1, 2) #=> "el"
"\x80\u3042".byteslice(1, 3) #=> "\u3042"
"\x03\u3042\xff".byteslice(1..3) #=> "\u3042"
;T;[o;
; I"
overload;F; 0;;f; 0; I"byteslice(fixnum);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@.;#[ ;$I"@return [String, nil];T;%0;"@.;&0;'F;(i ;[[I" fixnum;T0;"@.o;
; I"
overload;F; 0;;f; 0; I" byteslice(fixnum, fixnum);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@.;#[ ;$I"@return [String, nil];T;%0;"@.;&0;'F;(i ;[[I" fixnum;T0[I" fixnum;T0;"@.o;
; I"
overload;F; 0;;f; 0; I"byteslice(range);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@.;#[ ;$I"@return [String, nil];T;%0;"@.;&0;'F;(i ;[[I"
range;T0;"@.;#[ ;$I"Byte Reference---If passed a single Fixnum, returns a
substring of one byte at that position. If passed two Fixnum
objects, returns a substring starting at the offset given by the first, and
a length given by the second. If given a Range, a substring containing
bytes at offsets given by the range is returned. In all three cases, if
an offset is negative, it is counted from the end of str. Returns
nil if the initial offset falls outside the string, the length
is negative, or the beginning of the range is greater than the end.
The encoding of the resulted string keeps original encoding.
"hello".byteslice(1) #=> "e"
"hello".byteslice(-1) #=> "o"
"hello".byteslice(1, 2) #=> "el"
"\x80\u3042".byteslice(1, 3) #=> "\u3042"
"\x03\u3042\xff".byteslice(1..3) #=> "\u3042"
@overload byteslice(fixnum)
@return [String, nil]
@overload byteslice(fixnum, fixnum)
@return [String, nil]
@overload byteslice(range)
@return [String, nil];T;%0;"@.;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"static VALUE
rb_str_byteslice(int argc, VALUE *argv, VALUE str)
{
if (argc == 2) {
return str_byte_substr(str, NUM2LONG(argv[0]), NUM2LONG(argv[1]));
}
rb_check_arity(argc, 1, 2);
return str_byte_aref(str, argv[0]);
};T;0To;
; F; ;
;;;I"String#scrub;F;[[@0;[[@)i#;T;:
scrub;0;[ ;{ ;IC;"{If the string is invalid byte sequence then replace invalid bytes with given replacement
character, else returns self.
If block is given, replace invalid bytes with returned value of the block.
"abc\u3042\x81".scrub #=> "abc\u3042\uFFFD"
"abc\u3042\x81".scrub("*") #=> "abc\u3042*"
"abc\u3042\xE3\x80".scrub{|bytes| '<'+bytes.unpack('H*')[0]+'>' } #=> "abc\u3042"
;T;[o;
; I"
overload;F; 0;;g; 0; I"
scrub;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@.;#[ ;$I"@return [String];T;%0;"@.;&0;'F;(i ;[ ;"@.o;
; I"
overload;F; 0;;g; 0; I"scrub(repl);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@.;#[ ;$I"@return [String];T;%0;"@.;&0;'F;(i ;[[I" repl;T0;"@.o;
; I"
overload;F; 0;;g; 0; I"
scrub;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"
bytes;T;"@.o;!
; I" return;F; I" ;T;0; [I" String;T;"@.;#[ ;$I"$@yield [bytes]
@return [String];T;%0;"@.;&0;'F;(i ;[ ;"@.;#[ ;$I"If the string is invalid byte sequence then replace invalid bytes with given replacement
character, else returns self.
If block is given, replace invalid bytes with returned value of the block.
"abc\u3042\x81".scrub #=> "abc\u3042\uFFFD"
"abc\u3042\x81".scrub("*") #=> "abc\u3042*"
"abc\u3042\xE3\x80".scrub{|bytes| '<'+bytes.unpack('H*')[0]+'>' } #=> "abc\u3042"
@overload scrub
@return [String]
@overload scrub(repl)
@return [String]
@overload scrub
@yield [bytes]
@return [String];T;%0;"@.;'F;)o;*;+T;,i #;-i#;.@(; I"static VALUE;T;/I"static VALUE
str_scrub(int argc, VALUE *argv, VALUE str)
{
VALUE repl = argc ? (rb_check_arity(argc, 0, 1), argv[0]) : Qnil;
VALUE new = rb_str_scrub(str, repl);
return NIL_P(new) ? rb_str_dup(str): new;
};T;0To;
; F; ;
;;;I"String#scrub!;F;[[@0;[[@)i0#;T;: scrub!;0;[ ;{ ;IC;"~If the string is invalid byte sequence then replace invalid bytes with given replacement
character, else returns self.
If block is given, replace invalid bytes with returned value of the block.
"abc\u3042\x81".scrub! #=> "abc\u3042\uFFFD"
"abc\u3042\x81".scrub!("*") #=> "abc\u3042*"
"abc\u3042\xE3\x80".scrub!{|bytes| '<'+bytes.unpack('H*')[0]+'>' } #=> "abc\u3042"
;T;[o;
; I"
overload;F; 0;;h; 0; I" scrub!;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@$/;#[ ;$I"@return [String];T;%0;"@$/;&0;'F;(i ;[ ;"@$/o;
; I"
overload;F; 0;;h; 0; I"scrub!(repl);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@$/;#[ ;$I"@return [String];T;%0;"@$/;&0;'F;(i ;[[I" repl;T0;"@$/o;
; I"
overload;F; 0;;h; 0; I" scrub!;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"
bytes;T;"@$/o;!
; I" return;F; I" ;T;0; [I" String;T;"@$/;#[ ;$I"$@yield [bytes]
@return [String];T;%0;"@$/;&0;'F;(i ;[ ;"@$/;#[ ;$I"If the string is invalid byte sequence then replace invalid bytes with given replacement
character, else returns self.
If block is given, replace invalid bytes with returned value of the block.
"abc\u3042\x81".scrub! #=> "abc\u3042\uFFFD"
"abc\u3042\x81".scrub!("*") #=> "abc\u3042*"
"abc\u3042\xE3\x80".scrub!{|bytes| '<'+bytes.unpack('H*')[0]+'>' } #=> "abc\u3042"
@overload scrub!
@return [String]
@overload scrub!(repl)
@return [String]
@overload scrub!
@yield [bytes]
@return [String];T;%0;"@$/;'F;)o;*;+T;,i"#;-i1#;.@(; I"static VALUE;T;/I"static VALUE
str_scrub_bang(int argc, VALUE *argv, VALUE str)
{
VALUE repl = argc ? (rb_check_arity(argc, 0, 1), argv[0]) : Qnil;
VALUE new = rb_str_scrub(str, repl);
if (!NIL_P(new)) rb_str_replace(str, new);
return str;
};T;0To;
; F; ;
;;;I"String#freeze;F;[ ;[[@)i;T;;{;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@a/;.@(; I"
VALUE;T;/I"VALUE
rb_str_freeze(VALUE str)
{
if (OBJ_FROZEN(str)) return str;
rb_str_resize(str, RSTRING_LEN(str));
return rb_obj_freeze(str);
};T;0To;
; F; ;
;;;I"String#+@;F;[ ;[[@)i ;T;;;0;[ ;{ ;IC;"|If the string is frozen, then return duplicated mutable string.
If the string is not frozen, then return the string itself.
;T;[o;
; I"
overload;F; 0;;2; 0; I" +str;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@m/;&0;'F;(i ;[ ;"@m/;#[ ;$I"If the string is frozen, then return duplicated mutable string.
If the string is not frozen, then return the string itself.
@overload +str;T;%0;"@m/;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"}static VALUE
str_uplus(VALUE str)
{
if (OBJ_FROZEN(str)) {
return rb_str_dup(str);
}
else {
return str;
}
};T;0To;
; F; ;
;;;I"String#-@;F;[ ;[[@)i" ;T;;;0;[ ;{ ;IC;"If the string is frozen, then return the string itself.
If the string is not frozen, then duplicate the string
freeze it and return it.
;T;[o;
; I"
overload;F; 0;;3; 0; I" -str;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@/;&0;'F;(i ;[ ;"@/;#[ ;$I"If the string is frozen, then return the string itself.
If the string is not frozen, then duplicate the string
freeze it and return it.
@overload -str;T;%0;"@/;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"static VALUE
str_uminus(VALUE str)
{
if (OBJ_FROZEN(str)) {
return str;
}
else {
return rb_str_freeze(rb_str_dup(str));
}
};T;0To;
; F; ;
;;;I"String#to_i;F;[[@0;[[@)in;T;;D;0;[ ;{ ;IC;"Returns the result of interpreting leading characters in str as an
integer base base (between 2 and 36). Extraneous characters past the
end of a valid number are ignored. If there is not a valid number at the
start of str, 0 is returned. This method never raises an
exception when base is valid.
"12345".to_i #=> 12345
"99 red balloons".to_i #=> 99
"0a".to_i #=> 0
"0a".to_i(16) #=> 10
"hello".to_i #=> 0
"1100101".to_i(2) #=> 101
"1100101".to_i(8) #=> 294977
"1100101".to_i(10) #=> 1100101
"1100101".to_i(16) #=> 17826049
;T;[o;
; I"
overload;F; 0;;D; 0; I"to_i(base=10);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@/;#[ ;$I"@return [Integer];T;%0;"@/;&0;'F;(i ;[[I" base;TI"10;T;"@/;#[ ;$I"Returns the result of interpreting leading characters in str as an
integer base base (between 2 and 36). Extraneous characters past the
end of a valid number are ignored. If there is not a valid number at the
start of str, 0 is returned. This method never raises an
exception when base is valid.
"12345".to_i #=> 12345
"99 red balloons".to_i #=> 99
"0a".to_i #=> 0
"0a".to_i(16) #=> 10
"hello".to_i #=> 0
"1100101".to_i(2) #=> 101
"1100101".to_i(8) #=> 294977
"1100101".to_i(10) #=> 1100101
"1100101".to_i(16) #=> 17826049
@overload to_i(base=10)
@return [Integer];T;%0;"@/;'F;)o;*;+T;,iY;-ik;.@(; I"static VALUE;T;/I":static VALUE
rb_str_to_i(int argc, VALUE *argv, VALUE str)
{
int base;
if (argc == 0) base = 10;
else {
VALUE b;
rb_scan_args(argc, argv, "01", &b);
base = NUM2INT(b);
}
if (base < 0) {
rb_raise(rb_eArgError, "invalid radix %d", base);
}
return rb_str_to_inum(str, base, FALSE);
};T;0To;
; F; ;
;;;I"String#to_f;F;[ ;[[@)i;T;;E;0;[ ;{ ;IC;"Returns the result of interpreting leading characters in str as a
floating point number. Extraneous characters past the end of a valid number
are ignored. If there is not a valid number at the start of str,
0.0 is returned. This method never raises an exception.
"123.45e1".to_f #=> 1234.5
"45.67 degrees".to_f #=> 45.67
"thx1138".to_f #=> 0.0
;T;[o;
; I"
overload;F; 0;;E; 0; I" to_f;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Float;T;"@/;#[ ;$I"@return [Float];T;%0;"@/;&0;'F;(i ;[ ;"@/;#[ ;$I"Returns the result of interpreting leading characters in str as a
floating point number. Extraneous characters past the end of a valid number
are ignored. If there is not a valid number at the start of str,
0.0 is returned. This method never raises an exception.
"123.45e1".to_f #=> 1234.5
"45.67 degrees".to_f #=> 45.67
"thx1138".to_f #=> 0.0
@overload to_f
@return [Float];T;%0;"@/;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"[static VALUE
rb_str_to_f(VALUE str)
{
return DBL2NUM(rb_str_to_dbl(str, FALSE));
};T;0To;
; F; ;
;;;I"String#to_s;F;[ ;[[@)i;T;;I;0;[ ;{ ;IC;"bReturns +self+.
If called on a subclass of String, converts the receiver to a String object.
;T;[o;
; I"
overload;F; 0;;I; 0; I" to_s;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@/;#[ ;$I"@return [String];T;%0;"@/;&0;'F;(i ;[ ;"@/o;
; I"
overload;F; 0;: to_str; 0; I" to_str;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@/;#[ ;$I"@return [String];T;%0;"@/;&0;'F;(i ;[ ;"@/;#[ ;$I"Returns +self+.
If called on a subclass of String, converts the receiver to a String object.
@overload to_s
@return [String]
@overload to_str
@return [String];T;%0;"@/;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"static VALUE
rb_str_to_s(VALUE str)
{
if (rb_obj_class(str) != rb_cString) {
return str_duplicate(rb_cString, str);
}
return str;
};T;0To;
; F; ;
;;;I"String#to_str;F;[ ;[[@)i;T;;i;0;[ ;{ ;IC;"bReturns +self+.
If called on a subclass of String, converts the receiver to a String object.
;T;[o;
; I"
overload;F; 0;;I; 0; I" to_s;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@/;#[ ;$I"@return [String];T;%0;"@/;&0;'F;(i ;[ ;"@/o;
; I"
overload;F; 0;;i; 0; I" to_str;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@/;#[ ;$I"@return [String];T;%0;"@/;&0;'F;(i ;[ ;"@/;#[ ;$@/;%0;"@/;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"static VALUE
rb_str_to_s(VALUE str)
{
if (rb_obj_class(str) != rb_cString) {
return str_duplicate(rb_cString, str);
}
return str;
};T;0To;
; F; ;
;;;I"String#inspect;F;[ ;[[@)i$;T;;J;0;[ ;{ ;IC;"Returns a printable version of _str_, surrounded by quote marks,
with special characters escaped.
str = "hello"
str[3] = "\b"
str.inspect #=> "\"hel\\bo\""
;T;[o;
; I"
overload;F; 0;;J; 0; I" inspect;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@"0;#[ ;$I"@return [String];T;%0;"@"0;&0;'F;(i ;[ ;"@"0;#[ ;$I"Returns a printable version of _str_, surrounded by quote marks,
with special characters escaped.
str = "hello"
str[3] = "\b"
str.inspect #=> "\"hel\\bo\""
@overload inspect
@return [String];T;%0;"@"0;'F;)o;*;+T;,i;-i!;.@(; I"
VALUE;T;/I"
VALUE
rb_str_inspect(VALUE str)
{
int encidx = ENCODING_GET(str);
rb_encoding *enc = rb_enc_from_index(encidx), *actenc;
const char *p, *pend, *prev;
char buf[CHAR_ESC_LEN + 1];
VALUE result = rb_str_buf_new(0);
rb_encoding *resenc = rb_default_internal_encoding();
int unicode_p = rb_enc_unicode_p(enc);
int asciicompat = rb_enc_asciicompat(enc);
if (resenc == NULL) resenc = rb_default_external_encoding();
if (!rb_enc_asciicompat(resenc)) resenc = rb_usascii_encoding();
rb_enc_associate(result, resenc);
str_buf_cat2(result, "\"");
p = RSTRING_PTR(str); pend = RSTRING_END(str);
prev = p;
actenc = get_actual_encoding(encidx, str);
if (actenc != enc) {
enc = actenc;
if (unicode_p) unicode_p = rb_enc_unicode_p(enc);
}
while (p < pend) {
unsigned int c, cc;
int n;
n = rb_enc_precise_mbclen(p, pend, enc);
if (!MBCLEN_CHARFOUND_P(n)) {
if (p > prev) str_buf_cat(result, prev, p - prev);
n = rb_enc_mbminlen(enc);
if (pend < p + n)
n = (int)(pend - p);
while (n--) {
snprintf(buf, CHAR_ESC_LEN, "\\x%02X", *p & 0377);
str_buf_cat(result, buf, strlen(buf));
prev = ++p;
}
continue;
}
n = MBCLEN_CHARFOUND_LEN(n);
c = rb_enc_mbc_to_codepoint(p, pend, enc);
p += n;
if ((asciicompat || unicode_p) &&
(c == '"'|| c == '\\' ||
(c == '#' &&
p < pend &&
MBCLEN_CHARFOUND_P(rb_enc_precise_mbclen(p,pend,enc)) &&
(cc = rb_enc_codepoint(p,pend,enc),
(cc == '$' || cc == '@' || cc == '{'))))) {
if (p - n > prev) str_buf_cat(result, prev, p - n - prev);
str_buf_cat2(result, "\\");
if (asciicompat || enc == resenc) {
prev = p - n;
continue;
}
}
switch (c) {
case '\n': cc = 'n'; break;
case '\r': cc = 'r'; break;
case '\t': cc = 't'; break;
case '\f': cc = 'f'; break;
case '\013': cc = 'v'; break;
case '\010': cc = 'b'; break;
case '\007': cc = 'a'; break;
case 033: cc = 'e'; break;
default: cc = 0; break;
}
if (cc) {
if (p - n > prev) str_buf_cat(result, prev, p - n - prev);
buf[0] = '\\';
buf[1] = (char)cc;
str_buf_cat(result, buf, 2);
prev = p;
continue;
}
if ((enc == resenc && rb_enc_isprint(c, enc)) ||
(asciicompat && rb_enc_isascii(c, enc) && ISPRINT(c))) {
continue;
}
else {
if (p - n > prev) str_buf_cat(result, prev, p - n - prev);
rb_str_buf_cat_escaped_char(result, c, unicode_p);
prev = p;
continue;
}
}
if (p > prev) str_buf_cat(result, prev, p - prev);
str_buf_cat2(result, "\"");
OBJ_INFECT_RAW(result, str);
return result;
};T;0To;
; F; ;
;;;I"String#dump;F;[ ;[[@)i;T;: dump;0;[ ;{ ;IC;"Produces a version of +str+ with all non-printing characters replaced by
\nnn notation and all special characters escaped.
"hello \n ''".dump #=> "\"hello \\n ''\"
;T;[o;
; I"
overload;F; 0;;j; 0; I" dump;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@=0;#[ ;$I"@return [String];T;%0;"@=0;&0;'F;(i ;[ ;"@=0;#[ ;$I"Produces a version of +str+ with all non-printing characters replaced by
\nnn notation and all special characters escaped.
"hello \n ''".dump #=> "\"hello \\n ''\"
@overload dump
@return [String];T;%0;"@=0;'F;)o;*;+T;,i;-i;.@(; I"
VALUE;T;/I"_
VALUE
rb_str_dump(VALUE str)
{
rb_encoding *enc = rb_enc_get(str);
long len;
const char *p, *pend;
char *q, *qend;
VALUE result;
int u8 = (enc == rb_utf8_encoding());
len = 2; /* "" */
p = RSTRING_PTR(str); pend = p + RSTRING_LEN(str);
while (p < pend) {
unsigned char c = *p++;
switch (c) {
case '"': case '\\':
case '\n': case '\r':
case '\t': case '\f':
case '\013': case '\010': case '\007': case '\033':
len += 2;
break;
case '#':
len += IS_EVSTR(p, pend) ? 2 : 1;
break;
default:
if (ISPRINT(c)) {
len++;
}
else {
if (u8 && c > 0x7F) { /* \u{NN} */
int n = rb_enc_precise_mbclen(p-1, pend, enc);
if (MBCLEN_CHARFOUND_P(n)) {
unsigned int cc = rb_enc_mbc_to_codepoint(p-1, pend, enc);
while (cc >>= 4) len++;
len += 5;
p += MBCLEN_CHARFOUND_LEN(n)-1;
break;
}
}
len += 4; /* \xNN */
}
break;
}
}
if (!rb_enc_asciicompat(enc)) {
len += 19; /* ".force_encoding('')" */
len += strlen(enc->name);
}
result = rb_str_new_with_class(str, 0, len);
p = RSTRING_PTR(str); pend = p + RSTRING_LEN(str);
q = RSTRING_PTR(result); qend = q + len + 1;
*q++ = '"';
while (p < pend) {
unsigned char c = *p++;
if (c == '"' || c == '\\') {
*q++ = '\\';
*q++ = c;
}
else if (c == '#') {
if (IS_EVSTR(p, pend)) *q++ = '\\';
*q++ = '#';
}
else if (c == '\n') {
*q++ = '\\';
*q++ = 'n';
}
else if (c == '\r') {
*q++ = '\\';
*q++ = 'r';
}
else if (c == '\t') {
*q++ = '\\';
*q++ = 't';
}
else if (c == '\f') {
*q++ = '\\';
*q++ = 'f';
}
else if (c == '\013') {
*q++ = '\\';
*q++ = 'v';
}
else if (c == '\010') {
*q++ = '\\';
*q++ = 'b';
}
else if (c == '\007') {
*q++ = '\\';
*q++ = 'a';
}
else if (c == '\033') {
*q++ = '\\';
*q++ = 'e';
}
else if (ISPRINT(c)) {
*q++ = c;
}
else {
*q++ = '\\';
if (u8) {
int n = rb_enc_precise_mbclen(p-1, pend, enc) - 1;
if (MBCLEN_CHARFOUND_P(n)) {
int cc = rb_enc_mbc_to_codepoint(p-1, pend, enc);
p += n;
snprintf(q, qend-q, "u{%x}", cc);
q += strlen(q);
continue;
}
}
snprintf(q, qend-q, "x%02X", c);
q += 3;
}
}
*q++ = '"';
*q = '\0';
if (!rb_enc_asciicompat(enc)) {
snprintf(q, qend-q, ".force_encoding(\"%s\")", enc->name);
enc = rb_ascii8bit_encoding();
}
OBJ_INFECT_RAW(result, str);
/* result from dump is ASCII */
rb_enc_associate(result, enc);
ENC_CODERANGE_SET(result, ENC_CODERANGE_7BIT);
return result;
};T;0To;
; F; ;
;;;I"String#upcase;F;[ ;[[@)if;T;: upcase;0;[ ;{ ;IC;"Returns a copy of str with all lowercase letters replaced with their
uppercase counterparts. The operation is locale insensitive---only
characters ``a'' to ``z'' are affected.
Note: case replacement is effective only in ASCII region.
"hEllO".upcase #=> "HELLO"
;T;[o;
; I"
overload;F; 0;;k; 0; I" upcase;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@X0;#[ ;$I"@return [String];T;%0;"@X0;&0;'F;(i ;[ ;"@X0;#[ ;$I"7Returns a copy of str with all lowercase letters replaced with their
uppercase counterparts. The operation is locale insensitive---only
characters ``a'' to ``z'' are affected.
Note: case replacement is effective only in ASCII region.
"hEllO".upcase #=> "HELLO"
@overload upcase
@return [String];T;%0;"@X0;'F;)o;*;+T;,iZ;-ic;.@(; I"static VALUE;T;/I"vstatic VALUE
rb_str_upcase(VALUE str)
{
str = rb_str_dup(str);
rb_str_upcase_bang(str);
return str;
};T;0To;
; F; ;
;;;I"String#downcase;F;[ ;[[@)i;T;:
downcase;0;[ ;{ ;IC;"Returns a copy of str with all uppercase letters replaced with their
lowercase counterparts. The operation is locale insensitive---only
characters ``A'' to ``Z'' are affected.
Note: case replacement is effective only in ASCII region.
"hEllO".downcase #=> "hello"
;T;[o;
; I"
overload;F; 0;;l; 0; I"
downcase;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@s0;#[ ;$I"@return [String];T;%0;"@s0;&0;'F;(i ;[ ;"@s0;#[ ;$I";Returns a copy of str with all uppercase letters replaced with their
lowercase counterparts. The operation is locale insensitive---only
characters ``A'' to ``Z'' are affected.
Note: case replacement is effective only in ASCII region.
"hEllO".downcase #=> "hello"
@overload downcase
@return [String];T;%0;"@s0;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"zstatic VALUE
rb_str_downcase(VALUE str)
{
str = rb_str_dup(str);
rb_str_downcase_bang(str);
return str;
};T;0To;
; F; ;
;;;I"String#capitalize;F;[ ;[[@)i ;T;:capitalize;0;[ ;{ ;IC;"Returns a copy of str with the first character converted to uppercase
and the remainder to lowercase.
Note: case conversion is effective only in ASCII region.
"hello".capitalize #=> "Hello"
"HELLO".capitalize #=> "Hello"
"123ABC".capitalize #=> "123abc"
;T;[o;
; I"
overload;F; 0;;m; 0; I"capitalize;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@0;#[ ;$I"@return [String];T;%0;"@0;&0;'F;(i ;[ ;"@0;#[ ;$I"@Returns a copy of str with the first character converted to uppercase
and the remainder to lowercase.
Note: case conversion is effective only in ASCII region.
"hello".capitalize #=> "Hello"
"HELLO".capitalize #=> "Hello"
"123ABC".capitalize #=> "123abc"
@overload capitalize
@return [String];T;%0;"@0;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"~static VALUE
rb_str_capitalize(VALUE str)
{
str = rb_str_dup(str);
rb_str_capitalize_bang(str);
return str;
};T;0To;
; F; ;
;;;I"String#swapcase;F;[ ;[[@)i?;T;:
swapcase;0;[ ;{ ;IC;" Returns a copy of str with uppercase alphabetic characters converted
to lowercase and lowercase characters converted to uppercase.
Note: case conversion is effective only in ASCII region.
"Hello".swapcase #=> "hELLO"
"cYbEr_PuNk11".swapcase #=> "CyBeR_pUnK11"
;T;[o;
; I"
overload;F; 0;;n; 0; I"
swapcase;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@0;#[ ;$I"@return [String];T;%0;"@0;&0;'F;(i ;[ ;"@0;#[ ;$I"DReturns a copy of str with uppercase alphabetic characters converted
to lowercase and lowercase characters converted to uppercase.
Note: case conversion is effective only in ASCII region.
"Hello".swapcase #=> "hELLO"
"cYbEr_PuNk11".swapcase #=> "CyBeR_pUnK11"
@overload swapcase
@return [String];T;%0;"@0;'F;)o;*;+T;,i3;-i<;.@(; I"static VALUE;T;/I"zstatic VALUE
rb_str_swapcase(VALUE str)
{
str = rb_str_dup(str);
rb_str_swapcase_bang(str);
return str;
};T;0To;
; F; ;
;;;I"String#upcase!;F;[ ;[[@)i%;T;: upcase!;0;[ ;{ ;IC;"Upcases the contents of str, returning nil if no changes
were made.
Note: case replacement is effective only in ASCII region.
;T;[o;
; I"
overload;F; 0;;o; 0; I" upcase!;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@0;#[ ;$I"@return [String, nil];T;%0;"@0;&0;'F;(i ;[ ;"@0;#[ ;$I"Upcases the contents of str, returning nil if no changes
were made.
Note: case replacement is effective only in ASCII region.
@overload upcase!
@return [String, nil];T;%0;"@0;'F;)o;*;+T;,i ;-i";.@(; I"static VALUE;T;/I"!static VALUE
rb_str_upcase_bang(VALUE str)
{
rb_encoding *enc;
char *s, *send;
int modify = 0;
int n;
str_modify_keep_cr(str);
enc = STR_ENC_GET(str);
rb_str_check_dummy_enc(enc);
s = RSTRING_PTR(str); send = RSTRING_END(str);
if (single_byte_optimizable(str)) {
while (s < send) {
unsigned int c = *(unsigned char*)s;
if (rb_enc_isascii(c, enc) && 'a' <= c && c <= 'z') {
*s = 'A' + (c - 'a');
modify = 1;
}
s++;
}
}
else {
int ascompat = rb_enc_asciicompat(enc);
while (s < send) {
unsigned int c;
if (ascompat && (c = *(unsigned char*)s) < 0x80) {
if (rb_enc_isascii(c, enc) && 'a' <= c && c <= 'z') {
*s = 'A' + (c - 'a');
modify = 1;
}
s++;
}
else {
c = rb_enc_codepoint_len(s, send, &n, enc);
if (rb_enc_islower(c, enc)) {
/* assuming toupper returns codepoint with same size */
rb_enc_mbcput(rb_enc_toupper(c, enc), s, enc);
modify = 1;
}
s += n;
}
}
}
if (modify) return str;
return Qnil;
};T;0To;
; F; ;
;;;I"String#downcase!;F;[ ;[[@)ix;T;:downcase!;0;[ ;{ ;IC;"Downcases the contents of str, returning nil if no
changes were made.
Note: case replacement is effective only in ASCII region.
;T;[o;
; I"
overload;F; 0;;p; 0; I"downcase!;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@0;#[ ;$I"@return [String, nil];T;%0;"@0;&0;'F;(i ;[ ;"@0;#[ ;$I"Downcases the contents of str, returning nil if no
changes were made.
Note: case replacement is effective only in ASCII region.
@overload downcase!
@return [String, nil];T;%0;"@0;'F;)o;*;+T;,io;-iu;.@(; I"static VALUE;T;/I"$static VALUE
rb_str_downcase_bang(VALUE str)
{
rb_encoding *enc;
char *s, *send;
int modify = 0;
str_modify_keep_cr(str);
enc = STR_ENC_GET(str);
rb_str_check_dummy_enc(enc);
s = RSTRING_PTR(str); send = RSTRING_END(str);
if (single_byte_optimizable(str)) {
while (s < send) {
unsigned int c = *(unsigned char*)s;
if (rb_enc_isascii(c, enc) && 'A' <= c && c <= 'Z') {
*s = 'a' + (c - 'A');
modify = 1;
}
s++;
}
}
else {
int ascompat = rb_enc_asciicompat(enc);
while (s < send) {
unsigned int c;
int n;
if (ascompat && (c = *(unsigned char*)s) < 0x80) {
if (rb_enc_isascii(c, enc) && 'A' <= c && c <= 'Z') {
*s = 'a' + (c - 'A');
modify = 1;
}
s++;
}
else {
c = rb_enc_codepoint_len(s, send, &n, enc);
if (rb_enc_isupper(c, enc)) {
/* assuming toupper returns codepoint with same size */
rb_enc_mbcput(rb_enc_tolower(c, enc), s, enc);
modify = 1;
}
s += n;
}
}
}
if (modify) return str;
return Qnil;
};T;0To;
; F; ;
;;;I"String#capitalize!;F;[ ;[[@)i;T;:capitalize!;0;[ ;{ ;IC;"5Modifies str by converting the first character to uppercase and the
remainder to lowercase. Returns nil if no changes are made.
Note: case conversion is effective only in ASCII region.
a = "hello"
a.capitalize! #=> "Hello"
a #=> "Hello"
a.capitalize! #=> nil
;T;[o;
; I"
overload;F; 0;;q; 0; I"capitalize!;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@0;#[ ;$I"@return [String, nil];T;%0;"@0;&0;'F;(i ;[ ;"@0;#[ ;$I"eModifies str by converting the first character to uppercase and the
remainder to lowercase. Returns nil if no changes are made.
Note: case conversion is effective only in ASCII region.
a = "hello"
a.capitalize! #=> "Hello"
a #=> "Hello"
a.capitalize! #=> nil
@overload capitalize!
@return [String, nil];T;%0;"@0;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"static VALUE
rb_str_capitalize_bang(VALUE str)
{
rb_encoding *enc;
char *s, *send;
int modify = 0;
unsigned int c;
int n;
str_modify_keep_cr(str);
enc = STR_ENC_GET(str);
rb_str_check_dummy_enc(enc);
if (RSTRING_LEN(str) == 0 || !RSTRING_PTR(str)) return Qnil;
s = RSTRING_PTR(str); send = RSTRING_END(str);
c = rb_enc_codepoint_len(s, send, &n, enc);
if (rb_enc_islower(c, enc)) {
rb_enc_mbcput(rb_enc_toupper(c, enc), s, enc);
modify = 1;
}
s += n;
while (s < send) {
c = rb_enc_codepoint_len(s, send, &n, enc);
if (rb_enc_isupper(c, enc)) {
rb_enc_mbcput(rb_enc_tolower(c, enc), s, enc);
modify = 1;
}
s += n;
}
if (modify) return str;
return Qnil;
};T;0To;
; F; ;
;;;I"String#swapcase!;F;[ ;[[@)i;T;:swapcase!;0;[ ;{ ;IC;"Equivalent to String#swapcase, but modifies the receiver in
place, returning str, or nil if no changes were made.
Note: case conversion is effective only in ASCII region.
;T;[o;
; I"
overload;F; 0;;r; 0; I"swapcase!;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@1;#[ ;$I"@return [String, nil];T;%0;"@1;&0;'F;(i ;[ ;"@1;#[ ;$I"Equivalent to String#swapcase, but modifies the receiver in
place, returning str, or nil if no changes were made.
Note: case conversion is effective only in ASCII region.
@overload swapcase!
@return [String, nil];T;%0;"@1;'F;)o;*;+T;,i ;-i;.@(; I"static VALUE;T;/I"static VALUE
rb_str_swapcase_bang(VALUE str)
{
rb_encoding *enc;
char *s, *send;
int modify = 0;
int n;
str_modify_keep_cr(str);
enc = STR_ENC_GET(str);
rb_str_check_dummy_enc(enc);
s = RSTRING_PTR(str); send = RSTRING_END(str);
while (s < send) {
unsigned int c = rb_enc_codepoint_len(s, send, &n, enc);
if (rb_enc_isupper(c, enc)) {
/* assuming toupper returns codepoint with same size */
rb_enc_mbcput(rb_enc_tolower(c, enc), s, enc);
modify = 1;
}
else if (rb_enc_islower(c, enc)) {
/* assuming tolower returns codepoint with same size */
rb_enc_mbcput(rb_enc_toupper(c, enc), s, enc);
modify = 1;
}
s += n;
}
if (modify) return str;
return Qnil;
};T;0To;
; F; ;
;;;I"String#hex;F;[ ;[[@)i ;T;:hex;0;[ ;{ ;IC;"*Treats leading characters from str as a string of hexadecimal digits
(with an optional sign and an optional 0x) and returns the
corresponding number. Zero is returned on error.
"0x0a".hex #=> 10
"-1234".hex #=> -4660
"0".hex #=> 0
"wombat".hex #=> 0
;T;[o;
; I"
overload;F; 0;;s; 0; I"hex;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@41;#[ ;$I"@return [Integer];T;%0;"@41;&0;'F;(i ;[ ;"@41;#[ ;$I"NTreats leading characters from str as a string of hexadecimal digits
(with an optional sign and an optional 0x) and returns the
corresponding number. Zero is returned on error.
"0x0a".hex #=> 10
"-1234".hex #=> -4660
"0".hex #=> 0
"wombat".hex #=> 0
@overload hex
@return [Integer];T;%0;"@41;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"Vstatic VALUE
rb_str_hex(VALUE str)
{
return rb_str_to_inum(str, 16, FALSE);
};T;0To;
; F; ;
;;;I"String#oct;F;[ ;[[@)i ;T;:oct;0;[ ;{ ;IC;"iTreats leading characters of str as a string of octal digits (with an
optional sign) and returns the corresponding number. Returns 0 if the
conversion fails.
"123".oct #=> 83
"-377".oct #=> -255
"bad".oct #=> 0
"0377bad".oct #=> 255
If +str+ starts with 0, radix indicators are hornored.
See Kernel#Integer.
;T;[o;
; I"
overload;F; 0;;t; 0; I"oct;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@O1;#[ ;$I"@return [Integer];T;%0;"@O1;&0;'F;(i ;[ ;"@O1;#[ ;$I"Treats leading characters of str as a string of octal digits (with an
optional sign) and returns the corresponding number. Returns 0 if the
conversion fails.
"123".oct #=> 83
"-377".oct #=> -255
"bad".oct #=> 0
"0377bad".oct #=> 255
If +str+ starts with 0, radix indicators are hornored.
See Kernel#Integer.
@overload oct
@return [Integer];T;%0;"@O1;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"Vstatic VALUE
rb_str_oct(VALUE str)
{
return rb_str_to_inum(str, -8, FALSE);
};T;0To;
; F; ;
;;;I"String#split;F;[[@0;[[@)i;T;:
split;0;[ ;{ ;IC;",Divides str into substrings based on a delimiter, returning an array
of these substrings.
If pattern is a String, then its contents are used as
the delimiter when splitting str. If pattern is a single
space, str is split on whitespace, with leading whitespace and runs
of contiguous whitespace characters ignored.
If pattern is a Regexp, str is divided where the
pattern matches. Whenever the pattern matches a zero-length string,
str is split into individual characters. If pattern contains
groups, the respective matches will be returned in the array as well.
If pattern is nil, the value of $; is used.
If $; is nil (which is the default), str is
split on whitespace as if ` ' were specified.
If the limit parameter is omitted, trailing null fields are
suppressed. If limit is a positive number, at most that number of
fields will be returned (if limit is 1, the entire
string is returned as the only entry in an array). If negative, there is no
limit to the number of fields returned, and trailing null fields are not
suppressed.
When the input +str+ is empty an empty Array is returned as the string is
considered to have no fields to split.
" now's the time".split #=> ["now's", "the", "time"]
" now's the time".split(' ') #=> ["now's", "the", "time"]
" now's the time".split(/ /) #=> ["", "now's", "", "the", "time"]
"1, 2.34,56, 7".split(%r{,\s*}) #=> ["1", "2.34", "56", "7"]
"hello".split(//) #=> ["h", "e", "l", "l", "o"]
"hello".split(//, 3) #=> ["h", "e", "llo"]
"hi mom".split(%r{\s*}) #=> ["h", "i", "m", "o", "m"]
"mellow yellow".split("ello") #=> ["m", "w y", "w"]
"1,2,,3,4,,".split(',') #=> ["1", "2", "", "3", "4"]
"1,2,,3,4,,".split(',', 4) #=> ["1", "2", "", "3,4,,"]
"1,2,,3,4,,".split(',', -4) #=> ["1", "2", "", "3", "4", "", ""]
"".split(',', -1) #=> []
;T;[o;
; I"
overload;F; 0;;u; 0; I" split(pattern=nil, [limit]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@j1;#[ ;$I"@return [Array];T;%0;"@j1;&0;'F;(i ;[[I" pattern;TI"nil;T[I" [limit];T0;"@j1;#[ ;$I"fDivides str into substrings based on a delimiter, returning an array
of these substrings.
If pattern is a String, then its contents are used as
the delimiter when splitting str. If pattern is a single
space, str is split on whitespace, with leading whitespace and runs
of contiguous whitespace characters ignored.
If pattern is a Regexp, str is divided where the
pattern matches. Whenever the pattern matches a zero-length string,
str is split into individual characters. If pattern contains
groups, the respective matches will be returned in the array as well.
If pattern is nil, the value of $; is used.
If $; is nil (which is the default), str is
split on whitespace as if ` ' were specified.
If the limit parameter is omitted, trailing null fields are
suppressed. If limit is a positive number, at most that number of
fields will be returned (if limit is 1, the entire
string is returned as the only entry in an array). If negative, there is no
limit to the number of fields returned, and trailing null fields are not
suppressed.
When the input +str+ is empty an empty Array is returned as the string is
considered to have no fields to split.
" now's the time".split #=> ["now's", "the", "time"]
" now's the time".split(' ') #=> ["now's", "the", "time"]
" now's the time".split(/ /) #=> ["", "now's", "", "the", "time"]
"1, 2.34,56, 7".split(%r{,\s*}) #=> ["1", "2.34", "56", "7"]
"hello".split(//) #=> ["h", "e", "l", "l", "o"]
"hello".split(//, 3) #=> ["h", "e", "llo"]
"hi mom".split(%r{\s*}) #=> ["h", "i", "m", "o", "m"]
"mellow yellow".split("ello") #=> ["m", "w y", "w"]
"1,2,,3,4,,".split(',') #=> ["1", "2", "", "3", "4"]
"1,2,,3,4,,".split(',', 4) #=> ["1", "2", "", "3,4,,"]
"1,2,,3,4,,".split(',', -4) #=> ["1", "2", "", "3", "4", "", ""]
"".split(',', -1) #=> []
@overload split(pattern=nil, [limit])
@return [Array];T;%0;"@j1;'F;)o;*;+T;,it;-i;.@(; I"static VALUE;T;/I"pstatic VALUE
rb_str_split_m(int argc, VALUE *argv, VALUE str)
{
rb_encoding *enc;
VALUE spat;
VALUE limit;
enum {awk, string, regexp} split_type;
long beg, end, i = 0;
int lim = 0;
VALUE result, tmp;
if (rb_scan_args(argc, argv, "02", &spat, &limit) == 2) {
lim = NUM2INT(limit);
if (lim <= 0) limit = Qnil;
else if (lim == 1) {
if (RSTRING_LEN(str) == 0)
return rb_ary_new2(0);
return rb_ary_new3(1, str);
}
i = 1;
}
enc = STR_ENC_GET(str);
if (NIL_P(spat) && NIL_P(spat = rb_fs)) {
split_type = awk;
}
else {
spat = get_pat_quoted(spat, 0);
if (BUILTIN_TYPE(spat) == T_STRING) {
rb_encoding *enc2 = STR_ENC_GET(spat);
mustnot_broken(spat);
split_type = string;
if (RSTRING_LEN(spat) == 0) {
/* Special case - split into chars */
spat = rb_reg_regcomp(spat);
split_type = regexp;
}
else if (rb_enc_asciicompat(enc2) == 1) {
if (RSTRING_LEN(spat) == 1 && RSTRING_PTR(spat)[0] == ' '){
split_type = awk;
}
}
else {
int l;
if (rb_enc_ascget(RSTRING_PTR(spat), RSTRING_END(spat), &l, enc2) == ' ' &&
RSTRING_LEN(spat) == l) {
split_type = awk;
}
}
}
else {
split_type = regexp;
}
}
result = rb_ary_new();
beg = 0;
if (split_type == awk) {
char *ptr = RSTRING_PTR(str);
char *eptr = RSTRING_END(str);
char *bptr = ptr;
int skip = 1;
unsigned int c;
end = beg;
if (is_ascii_string(str)) {
while (ptr < eptr) {
c = (unsigned char)*ptr++;
if (skip) {
if (ascii_isspace(c)) {
beg = ptr - bptr;
}
else {
end = ptr - bptr;
skip = 0;
if (!NIL_P(limit) && lim <= i) break;
}
}
else if (ascii_isspace(c)) {
rb_ary_push(result, rb_str_subseq(str, beg, end-beg));
skip = 1;
beg = ptr - bptr;
if (!NIL_P(limit)) ++i;
}
else {
end = ptr - bptr;
}
}
}
else {
while (ptr < eptr) {
int n;
c = rb_enc_codepoint_len(ptr, eptr, &n, enc);
ptr += n;
if (skip) {
if (rb_isspace(c)) {
beg = ptr - bptr;
}
else {
end = ptr - bptr;
skip = 0;
if (!NIL_P(limit) && lim <= i) break;
}
}
else if (rb_isspace(c)) {
rb_ary_push(result, rb_str_subseq(str, beg, end-beg));
skip = 1;
beg = ptr - bptr;
if (!NIL_P(limit)) ++i;
}
else {
end = ptr - bptr;
}
}
}
}
else if (split_type == string) {
char *ptr = RSTRING_PTR(str);
char *temp = ptr;
char *eptr = RSTRING_END(str);
char *sptr = RSTRING_PTR(spat);
long slen = RSTRING_LEN(spat);
mustnot_broken(str);
enc = rb_enc_check(str, spat);
while (ptr < eptr &&
(end = rb_memsearch(sptr, slen, ptr, eptr - ptr, enc)) >= 0) {
/* Check we are at the start of a char */
char *t = rb_enc_right_char_head(ptr, ptr + end, eptr, enc);
if (t != ptr + end) {
ptr = t;
continue;
}
rb_ary_push(result, rb_str_subseq(str, ptr - temp, end));
ptr += end + slen;
if (!NIL_P(limit) && lim <= ++i) break;
}
beg = ptr - temp;
}
else {
char *ptr = RSTRING_PTR(str);
long len = RSTRING_LEN(str);
long start = beg;
long idx;
int last_null = 0;
struct re_registers *regs;
while ((end = rb_reg_search(spat, str, start, 0)) >= 0) {
regs = RMATCH_REGS(rb_backref_get());
if (start == end && BEG(0) == END(0)) {
if (!ptr) {
rb_ary_push(result, str_new_empty(str));
break;
}
else if (last_null == 1) {
rb_ary_push(result, rb_str_subseq(str, beg,
rb_enc_fast_mbclen(ptr+beg,
ptr+len,
enc)));
beg = start;
}
else {
if (start == len)
start++;
else
start += rb_enc_fast_mbclen(ptr+start,ptr+len,enc);
last_null = 1;
continue;
}
}
else {
rb_ary_push(result, rb_str_subseq(str, beg, end-beg));
beg = start = END(0);
}
last_null = 0;
for (idx=1; idx < regs->num_regs; idx++) {
if (BEG(idx) == -1) continue;
if (BEG(idx) == END(idx))
tmp = str_new_empty(str);
else
tmp = rb_str_subseq(str, BEG(idx), END(idx)-BEG(idx));
rb_ary_push(result, tmp);
}
if (!NIL_P(limit) && lim <= ++i) break;
}
}
if (RSTRING_LEN(str) > 0 && (!NIL_P(limit) || RSTRING_LEN(str) > beg || lim < 0)) {
if (RSTRING_LEN(str) == beg)
tmp = str_new_empty(str);
else
tmp = rb_str_subseq(str, beg, RSTRING_LEN(str)-beg);
rb_ary_push(result, tmp);
}
if (NIL_P(limit) && lim == 0) {
long len;
while ((len = RARRAY_LEN(result)) > 0 &&
(tmp = RARRAY_AREF(result, len-1), RSTRING_LEN(tmp) == 0))
rb_ary_pop(result);
}
return result;
};T;0To;
; F; ;
;;;I"String#lines;F;[[@0;[[@)i# ;T;:
lines;0;[ ;{ ;IC;"Returns an array of lines in str split using the supplied
record separator ($/ by default). This is a
shorthand for str.each_line(separator).to_a.
If a block is given, which is a deprecated form, works the same as
each_line.
;T;[o;
; I"
overload;F; 0;;v; 0; I"lines(separator=$/);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@1;#[ ;$I"@return [Array];T;%0;"@1;&0;'F;(i ;[[I"separator;TI"$/;T;"@1;#[ ;$I"BReturns an array of lines in str split using the supplied
record separator ($/ by default). This is a
shorthand for str.each_line(separator).to_a.
If a block is given, which is a deprecated form, works the same as
each_line.
@overload lines(separator=$/)
@return [Array];T;%0;"@1;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"{static VALUE
rb_str_lines(int argc, VALUE *argv, VALUE str)
{
return rb_str_enumerate_lines(argc, argv, str, 1);
};T;0To;
; F; ;
;;;I"String#bytes;F;[ ;[[@)is ;T;:
bytes;0;[ ;{ ;IC;"Returns an array of bytes in str. This is a shorthand for
str.each_byte.to_a.
If a block is given, which is a deprecated form, works the same as
each_byte.
;T;[o;
; I"
overload;F; 0;;w; 0; I"
bytes;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@1;#[ ;$I"@return [Array];T;%0;"@1;&0;'F;(i ;[ ;"@1;#[ ;$I"Returns an array of bytes in str. This is a shorthand for
str.each_byte.to_a.
If a block is given, which is a deprecated form, works the same as
each_byte.
@overload bytes
@return [Array];T;%0;"@1;'F;)o;*;+T;,ih ;-ip ;.@(; I"static VALUE;T;/I"Xstatic VALUE
rb_str_bytes(VALUE str)
{
return rb_str_enumerate_bytes(str, 1);
};T;0To;
; F; ;
;;;I"String#chars;F;[ ;[[@)i ;T;:
chars;0;[ ;{ ;IC;"Returns an array of characters in str. This is a shorthand
for str.each_char.to_a.
If a block is given, which is a deprecated form, works the same as
each_char.
;T;[o;
; I"
overload;F; 0;;x; 0; I"
chars;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@1;#[ ;$I"@return [Array];T;%0;"@1;&0;'F;(i ;[ ;"@1;#[ ;$I"Returns an array of characters in str. This is a shorthand
for str.each_char.to_a.
If a block is given, which is a deprecated form, works the same as
each_char.
@overload chars
@return [Array];T;%0;"@1;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"Xstatic VALUE
rb_str_chars(VALUE str)
{
return rb_str_enumerate_chars(str, 1);
};T;0To;
; F; ;
;;;I"String#codepoints;F;[ ;[[@)i9 ;T;:codepoints;0;[ ;{ ;IC;"Returns an array of the Integer ordinals of the
characters in str. This is a shorthand for
str.each_codepoint.to_a.
If a block is given, which is a deprecated form, works the same as
each_codepoint.
;T;[o;
; I"
overload;F; 0;;y; 0; I"codepoints;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@1;#[ ;$I"@return [Array];T;%0;"@1;&0;'F;(i ;[ ;"@1;#[ ;$I" Returns an array of the Integer ordinals of the
characters in str. This is a shorthand for
str.each_codepoint.to_a.
If a block is given, which is a deprecated form, works the same as
each_codepoint.
@overload codepoints
@return [Array];T;%0;"@1;'F;)o;*;+T;,i- ;-i6 ;.@(; I"static VALUE;T;/I"bstatic VALUE
rb_str_codepoints(VALUE str)
{
return rb_str_enumerate_codepoints(str, 1);
};T;0To;
; F; ;
;;;I"String#reverse;F;[ ;[[@)i;T;: reverse;0;[ ;{ ;IC;"wReturns a new string with the characters from str in reverse order.
"stressed".reverse #=> "desserts"
;T;[o;
; I"
overload;F; 0;;z; 0; I" reverse;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@1;#[ ;$I"@return [String];T;%0;"@1;&0;'F;(i ;[ ;"@1;#[ ;$I"Returns a new string with the characters from str in reverse order.
"stressed".reverse #=> "desserts"
@overload reverse
@return [String];T;%0;"@1;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I" static VALUE
rb_str_reverse(VALUE str)
{
rb_encoding *enc;
VALUE rev;
char *s, *e, *p;
int cr;
if (RSTRING_LEN(str) <= 1) return rb_str_dup(str);
enc = STR_ENC_GET(str);
rev = rb_str_new_with_class(str, 0, RSTRING_LEN(str));
s = RSTRING_PTR(str); e = RSTRING_END(str);
p = RSTRING_END(rev);
cr = ENC_CODERANGE(str);
if (RSTRING_LEN(str) > 1) {
if (single_byte_optimizable(str)) {
while (s < e) {
*--p = *s++;
}
}
else if (cr == ENC_CODERANGE_VALID) {
while (s < e) {
int clen = rb_enc_fast_mbclen(s, e, enc);
p -= clen;
memcpy(p, s, clen);
s += clen;
}
}
else {
cr = rb_enc_asciicompat(enc) ?
ENC_CODERANGE_7BIT : ENC_CODERANGE_VALID;
while (s < e) {
int clen = rb_enc_mbclen(s, e, enc);
if (clen > 1 || (*s & 0x80)) cr = ENC_CODERANGE_UNKNOWN;
p -= clen;
memcpy(p, s, clen);
s += clen;
}
}
}
STR_SET_LEN(rev, RSTRING_LEN(str));
OBJ_INFECT_RAW(rev, str);
str_enc_copy(rev, str);
ENC_CODERANGE_SET(rev, cr);
return rev;
};T;0To;
; F; ;
;;;I"String#reverse!;F;[ ;[[@)i%;T;:
reverse!;0;[ ;{ ;IC;""Reverses str in place.
;T;[o;
; I"
overload;F; 0;;{; 0; I"
reverse!;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@2;#[ ;$I"@return [String];T;%0;"@2;&0;'F;(i ;[ ;"@2;#[ ;$I"JReverses str in place.
@overload reverse!
@return [String];T;%0;"@2;'F;)o;*;+T;,i ;-i";.@(; I"static VALUE;T;/I"static VALUE
rb_str_reverse_bang(VALUE str)
{
if (RSTRING_LEN(str) > 1) {
if (single_byte_optimizable(str)) {
char *s, *e, c;
str_modify_keep_cr(str);
s = RSTRING_PTR(str);
e = RSTRING_END(str) - 1;
while (s < e) {
c = *s;
*s++ = *e;
*e-- = c;
}
}
else {
str_shared_replace(str, rb_str_reverse(str));
}
}
else {
str_modify_keep_cr(str);
}
return str;
};T;0To;
; F; ;
;;;I"String#concat;F;[[I" str2;T0;[[@)i
;T;: concat;0;[ ;{ ;IC;"Append---Concatenates the given object to str. If the object is a
Integer, it is considered as a codepoint, and is converted
to a character before concatenation.
a = "hello "
a << "world" #=> "hello world"
a.concat(33) #=> "hello world!"
;T;[ o;
; I"
overload;F; 0;:<<; 0; I"<<(integer);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@12;#[ ;$I"@return [String];T;%0;"@12;&0;'F;(i ;[[I" integer;T0;"@12o;
; I"
overload;F; 0;;|; 0; I"concat(integer);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@12;#[ ;$I"@return [String];T;%0;"@12;&0;'F;(i ;[[I" integer;T0;"@12o;
; I"
overload;F; 0;;}; 0; I" <<(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@12;#[ ;$I"@return [String];T;%0;"@12;&0;'F;(i ;[[I"obj;T0;"@12o;
; I"
overload;F; 0;;|; 0; I"concat(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@12;#[ ;$I"@return [String];T;%0;"@12;&0;'F;(i ;[[I"obj;T0;"@12;#[ ;$I"Append---Concatenates the given object to str. If the object is a
Integer, it is considered as a codepoint, and is converted
to a character before concatenation.
a = "hello "
a << "world" #=> "hello world"
a.concat(33) #=> "hello world!"
@overload <<(integer)
@return [String]
@overload concat(integer)
@return [String]
@overload <<(obj)
@return [String]
@overload concat(obj)
@return [String];T;%0;"@12;'F;)o;*;+T;,it
;-i
;.@(; I"
VALUE;T;/I"nVALUE
rb_str_concat(VALUE str1, VALUE str2)
{
unsigned int code;
rb_encoding *enc = STR_ENC_GET(str1);
if (FIXNUM_P(str2) || RB_TYPE_P(str2, T_BIGNUM)) {
if (rb_num_to_uint(str2, &code) == 0) {
}
else if (FIXNUM_P(str2)) {
rb_raise(rb_eRangeError, "%ld out of char range", FIX2LONG(str2));
}
else {
rb_raise(rb_eRangeError, "bignum out of char range");
}
}
else {
return rb_str_append(str1, str2);
}
if (enc == rb_usascii_encoding()) {
/* US-ASCII automatically extended to ASCII-8BIT */
char buf[1];
buf[0] = (char)code;
if (code > 0xFF) {
rb_raise(rb_eRangeError, "%u out of char range", code);
}
rb_str_cat(str1, buf, 1);
if (code > 127) {
rb_enc_associate(str1, rb_ascii8bit_encoding());
ENC_CODERANGE_SET(str1, ENC_CODERANGE_VALID);
}
}
else {
long pos = RSTRING_LEN(str1);
int cr = ENC_CODERANGE(str1);
int len;
char *buf;
switch (len = rb_enc_codelen(code, enc)) {
case ONIGERR_INVALID_CODE_POINT_VALUE:
rb_raise(rb_eRangeError, "invalid codepoint 0x%X in %s", code, rb_enc_name(enc));
break;
case ONIGERR_TOO_BIG_WIDE_CHAR_VALUE:
case 0:
rb_raise(rb_eRangeError, "%u out of char range", code);
break;
}
buf = ALLOCA_N(char, len + 1);
rb_enc_mbcput(code, buf, enc);
if (rb_enc_precise_mbclen(buf, buf + len + 1, enc) != len) {
rb_raise(rb_eRangeError, "invalid codepoint 0x%X in %s", code, rb_enc_name(enc));
}
rb_str_resize(str1, pos+len);
memcpy(RSTRING_PTR(str1) + pos, buf, len);
if (cr == ENC_CODERANGE_7BIT && code > 127)
cr = ENC_CODERANGE_VALID;
ENC_CODERANGE_SET(str1, cr);
}
return str1;
};T;0To;
; F; ;
;;;I"String#<<;F;[[I" str2;T0;[[@)i
;T;;};0;[ ;{ ;IC;"Append---Concatenates the given object to str. If the object is a
Integer, it is considered as a codepoint, and is converted
to a character before concatenation.
a = "hello "
a << "world" #=> "hello world"
a.concat(33) #=> "hello world!"
;T;[ o;
; I"
overload;F; 0;;}; 0; I"<<(integer);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@}2;#[ ;$I"@return [String];T;%0;"@}2;&0;'F;(i ;[[I" integer;T0;"@}2o;
; I"
overload;F; 0;;|; 0; I"concat(integer);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@}2;#[ ;$I"@return [String];T;%0;"@}2;&0;'F;(i ;[[I" integer;T0;"@}2o;
; I"
overload;F; 0;;}; 0; I" <<(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@}2;#[ ;$I"@return [String];T;%0;"@}2;&0;'F;(i ;[[I"obj;T0;"@}2o;
; I"
overload;F; 0;;|; 0; I"concat(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@}2;#[ ;$I"@return [String];T;%0;"@}2;&0;'F;(i ;[[I"obj;T0;"@}2;#[ ;$@y2;%0;"@}2;'F;)o;*;+T;,it
;-i
;.@(; I"
VALUE;T;/I"nVALUE
rb_str_concat(VALUE str1, VALUE str2)
{
unsigned int code;
rb_encoding *enc = STR_ENC_GET(str1);
if (FIXNUM_P(str2) || RB_TYPE_P(str2, T_BIGNUM)) {
if (rb_num_to_uint(str2, &code) == 0) {
}
else if (FIXNUM_P(str2)) {
rb_raise(rb_eRangeError, "%ld out of char range", FIX2LONG(str2));
}
else {
rb_raise(rb_eRangeError, "bignum out of char range");
}
}
else {
return rb_str_append(str1, str2);
}
if (enc == rb_usascii_encoding()) {
/* US-ASCII automatically extended to ASCII-8BIT */
char buf[1];
buf[0] = (char)code;
if (code > 0xFF) {
rb_raise(rb_eRangeError, "%u out of char range", code);
}
rb_str_cat(str1, buf, 1);
if (code > 127) {
rb_enc_associate(str1, rb_ascii8bit_encoding());
ENC_CODERANGE_SET(str1, ENC_CODERANGE_VALID);
}
}
else {
long pos = RSTRING_LEN(str1);
int cr = ENC_CODERANGE(str1);
int len;
char *buf;
switch (len = rb_enc_codelen(code, enc)) {
case ONIGERR_INVALID_CODE_POINT_VALUE:
rb_raise(rb_eRangeError, "invalid codepoint 0x%X in %s", code, rb_enc_name(enc));
break;
case ONIGERR_TOO_BIG_WIDE_CHAR_VALUE:
case 0:
rb_raise(rb_eRangeError, "%u out of char range", code);
break;
}
buf = ALLOCA_N(char, len + 1);
rb_enc_mbcput(code, buf, enc);
if (rb_enc_precise_mbclen(buf, buf + len + 1, enc) != len) {
rb_raise(rb_eRangeError, "invalid codepoint 0x%X in %s", code, rb_enc_name(enc));
}
rb_str_resize(str1, pos+len);
memcpy(RSTRING_PTR(str1) + pos, buf, len);
if (cr == ENC_CODERANGE_7BIT && code > 127)
cr = ENC_CODERANGE_VALID;
ENC_CODERANGE_SET(str1, cr);
}
return str1;
};T;0To;
; F; ;
;;;I"String#prepend;F;[[I" str2;T0;[[@)i
;T;: prepend;0;[ ;{ ;IC;"Prepend---Prepend the given string to str.
a = "world"
a.prepend("hello ") #=> "hello world"
a #=> "hello world"
;T;[o;
; I"
overload;F; 0;;~; 0; I"prepend(other_str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@2;#[ ;$I"@return [String];T;%0;"@2;&0;'F;(i ;[[I"other_str;T0;"@2;#[ ;$I"Prepend---Prepend the given string to str.
a = "world"
a.prepend("hello ") #=> "hello world"
a #=> "hello world"
@overload prepend(other_str)
@return [String];T;%0;"@2;'F;)o;*;+T;,i
;-i
;.@(; I"static VALUE;T;/I"static VALUE
rb_str_prepend(VALUE str, VALUE str2)
{
StringValue(str2);
StringValue(str);
rb_str_update(str, 0L, 0L, str2);
return str;
};T;0To;
; F; ;
;;;I"String#crypt;F;[[I" salt;T0;[[@)i ;T;:
crypt;0;[ ;{ ;IC;"Applies a one-way cryptographic hash to str by invoking the
standard library function crypt(3) with the given
salt string. While the format and the result are system and
implementation dependent, using a salt matching the regular
expression \A[a-zA-Z0-9./]{2} should be valid and
safe on any platform, in which only the first two characters are
significant.
This method is for use in system specific scripts, so if you want
a cross-platform hash function consider using Digest or OpenSSL
instead.
;T;[o;
; I"
overload;F; 0;;; 0; I"crypt(salt_str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@2;#[ ;$I"@return [String];T;%0;"@2;&0;'F;(i ;[[I"
salt_str;T0;"@2;#[ ;$I"BApplies a one-way cryptographic hash to str by invoking the
standard library function crypt(3) with the given
salt string. While the format and the result are system and
implementation dependent, using a salt matching the regular
expression \A[a-zA-Z0-9./]{2} should be valid and
safe on any platform, in which only the first two characters are
significant.
This method is for use in system specific scripts, so if you want
a cross-platform hash function consider using Digest or OpenSSL
instead.
@overload crypt(salt_str)
@return [String];T;%0;"@2;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"static VALUE
rb_str_crypt(VALUE str, VALUE salt)
{
extern char *crypt(const char *, const char *);
VALUE result;
const char *s, *saltp;
char *res;
#ifdef BROKEN_CRYPT
char salt_8bit_clean[3];
#endif
StringValue(salt);
mustnot_wchar(str);
mustnot_wchar(salt);
if (RSTRING_LEN(salt) < 2) {
short_salt:
rb_raise(rb_eArgError, "salt too short (need >=2 bytes)");
}
s = StringValueCStr(str);
saltp = RSTRING_PTR(salt);
if (!saltp[0] || !saltp[1]) goto short_salt;
#ifdef BROKEN_CRYPT
if (!ISASCII((unsigned char)saltp[0]) || !ISASCII((unsigned char)saltp[1])) {
salt_8bit_clean[0] = saltp[0] & 0x7f;
salt_8bit_clean[1] = saltp[1] & 0x7f;
salt_8bit_clean[2] = '\0';
saltp = salt_8bit_clean;
}
#endif
res = crypt(s, saltp);
if (!res) {
rb_sys_fail("crypt");
}
result = rb_str_new_cstr(res);
FL_SET_RAW(result, OBJ_TAINTED_RAW(str) | OBJ_TAINTED_RAW(salt));
return result;
};T;0To;
; F; ;
;;;I"String#intern;F;[ ;[[I"
symbol.c;Ti;T;: intern;0;[ ;{ ;IC;"Returns the Symbol corresponding to str, creating the
symbol if it did not previously exist. See Symbol#id2name.
"Koala".intern #=> :Koala
s = 'cat'.to_sym #=> :cat
s == :cat #=> true
s = '@cat'.to_sym #=> :@cat
s == :@cat #=> true
This can also be used to create symbols that cannot be represented using the
:xxx notation.
'cat and dog'.to_sym #=> :"cat and dog"
;T;[o;
; I"
overload;F; 0;;; 0; I" intern;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@3;&0;'F;(i ;[ ;"@3o;
; I"
overload;F; 0;: to_sym; 0; I" to_sym;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@3;&0;'F;(i ;[ ;"@3;#[ ;$I" Returns the Symbol corresponding to str, creating the
symbol if it did not previously exist. See Symbol#id2name.
"Koala".intern #=> :Koala
s = 'cat'.to_sym #=> :cat
s == :cat #=> true
s = '@cat'.to_sym #=> :@cat
s == :@cat #=> true
This can also be used to create symbols that cannot be represented using the
:xxx notation.
'cat and dog'.to_sym #=> :"cat and dog"
@overload intern
@overload to_sym;T;%0;"@3;'F;)o;*;+T;,i;-i;.@(; I"
VALUE;T;/I"VALUE
rb_str_intern(VALUE str)
{
#if USE_SYMBOL_GC
rb_encoding *enc, *ascii;
int type;
#else
ID id;
#endif
VALUE sym = lookup_str_sym(str);
if (sym) {
return sym;
}
#if USE_SYMBOL_GC
enc = rb_enc_get(str);
ascii = rb_usascii_encoding();
if (enc != ascii && sym_check_asciionly(str)) {
str = rb_str_dup(str);
rb_enc_associate(str, ascii);
OBJ_FREEZE(str);
enc = ascii;
}
else {
str = rb_str_new_frozen(str);
}
str = rb_fstring(str);
type = rb_str_symname_type(str, IDSET_ATTRSET_FOR_INTERN);
if (type < 0) type = ID_JUNK;
return dsymbol_alloc(rb_cSymbol, str, enc, type);
#else
id = intern_str(str, 0);
return ID2SYM(id);
#endif
};T;0To;
; F; ;
;;;I"String#to_sym;F;[ ;[[@ 3i;T;;;0;[ ;{ ;IC;"Returns the Symbol corresponding to str, creating the
symbol if it did not previously exist. See Symbol#id2name.
"Koala".intern #=> :Koala
s = 'cat'.to_sym #=> :cat
s == :cat #=> true
s = '@cat'.to_sym #=> :@cat
s == :@cat #=> true
This can also be used to create symbols that cannot be represented using the
:xxx notation.
'cat and dog'.to_sym #=> :"cat and dog"
;T;[o;
; I"
overload;F; 0;;; 0; I" intern;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@%3;&0;'F;(i ;[ ;"@%3o;
; I"
overload;F; 0;;; 0; I" to_sym;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@%3;&0;'F;(i ;[ ;"@%3;#[ ;$@!3;%0;"@%3;'F;)o;*;+T;,i;-i;.@(; I"
VALUE;T;/I"VALUE
rb_str_intern(VALUE str)
{
#if USE_SYMBOL_GC
rb_encoding *enc, *ascii;
int type;
#else
ID id;
#endif
VALUE sym = lookup_str_sym(str);
if (sym) {
return sym;
}
#if USE_SYMBOL_GC
enc = rb_enc_get(str);
ascii = rb_usascii_encoding();
if (enc != ascii && sym_check_asciionly(str)) {
str = rb_str_dup(str);
rb_enc_associate(str, ascii);
OBJ_FREEZE(str);
enc = ascii;
}
else {
str = rb_str_new_frozen(str);
}
str = rb_fstring(str);
type = rb_str_symname_type(str, IDSET_ATTRSET_FOR_INTERN);
if (type < 0) type = ID_JUNK;
return dsymbol_alloc(rb_cSymbol, str, enc, type);
#else
id = intern_str(str, 0);
return ID2SYM(id);
#endif
};T;0To;
; F; ;
;;;I"String#ord;F;[ ;[[@)i ;T;; ;0;[ ;{ ;IC;"bReturn the Integer ordinal of a one-character string.
"a".ord #=> 97
;T;[o;
; I"
overload;F; 0;; ; 0; I"ord;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@B3;#[ ;$I"@return [Integer];T;%0;"@B3;&0;'F;(i ;[ ;"@B3;#[ ;$I"Return the Integer ordinal of a one-character string.
"a".ord #=> 97
@overload ord
@return [Integer];T;%0;"@B3;'F;)o;*;+T;,i ;-i ;.@(; I"
VALUE;T;/I"VALUE
rb_str_ord(VALUE s)
{
unsigned int c;
c = rb_enc_codepoint(RSTRING_PTR(s), RSTRING_END(s), STR_ENC_GET(s));
return UINT2NUM(c);
};T;0To;
; F; ;
;;;I"String#include?;F;[[I"arg;T0;[[@)iL;T;:
include?;0;[ ;{ ;IC;"Returns true if str contains the given string or
character.
"hello".include? "lo" #=> true
"hello".include? "ol" #=> false
"hello".include? ?h #=> true
;T;[o;
; I"
overload;F; 0;;; 0; I"include? other_str;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@]3;#[ ;$I"@return [Boolean];T;%0;"@]3;&0;'F;(i ;[[I"other_str;T0;"@]3o;!
; I" return;F; @;0; [@;"@]3;#[ ;$I"Returns true if str contains the given string or
character.
"hello".include? "lo" #=> true
"hello".include? "ol" #=> false
"hello".include? ?h #=> true
@overload include? other_str
@return [Boolean];T;%0;"@]3;'F;)o;*;+T;,i@;-iI;.@(; I"static VALUE;T;/I"static VALUE
rb_str_include(VALUE str, VALUE arg)
{
long i;
StringValue(arg);
i = rb_str_index(str, arg, 0);
if (i == -1) return Qfalse;
return Qtrue;
};T;0To;
; F; ;
;;;I"String#start_with?;F;[[@0;[[@)iJ!;T;:start_with?;0;[ ;{ ;IC;"Returns true if +str+ starts with one of the +prefixes+ given.
"hello".start_with?("hell") #=> true
# returns true if one of the prefixes matches.
"hello".start_with?("heaven", "hell") #=> true
"hello".start_with?("heaven", "paradise") #=> false
;T;[o;
; I"
overload;F; 0;;; 0; I" start_with?([prefixes]+);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@3;#[ ;$I"@return [Boolean];T;%0;"@3;&0;'F;(i ;[[I"[prefixes];T0;"@3o;!
; I" return;F; @;0; [@;"@3;#[ ;$I"JReturns true if +str+ starts with one of the +prefixes+ given.
"hello".start_with?("hell") #=> true
# returns true if one of the prefixes matches.
"hello".start_with?("heaven", "hell") #=> true
"hello".start_with?("heaven", "paradise") #=> false
@overload start_with?([prefixes]+)
@return [Boolean];T;%0;"@3;'F;)o;*;+T;,i=!;-iG!;.@(; I"static VALUE;T;/I"Wstatic VALUE
rb_str_start_with(int argc, VALUE *argv, VALUE str)
{
int i;
for (i=0; i true
# returns true if one of the +suffixes+ matches.
"hello".end_with?("heaven", "ello") #=> true
"hello".end_with?("heaven", "paradise") #=> false
;T;[o;
; I"
overload;F; 0;;; 0; I"end_with?([suffixes]+);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@3;#[ ;$I"@return [Boolean];T;%0;"@3;&0;'F;(i ;[[I"[suffixes];T0;"@3o;!
; I" return;F; @;0; [@;"@3;#[ ;$I"BReturns true if +str+ ends with one of the +suffixes+ given.
"hello".end_with?("ello") #=> true
# returns true if one of the +suffixes+ matches.
"hello".end_with?("heaven", "ello") #=> true
"hello".end_with?("heaven", "paradise") #=> false
@overload end_with?([suffixes]+)
@return [Boolean];T;%0;"@3;'F;)o;*;+T;,iZ!;-id!;.@(; I"static VALUE;T;/I" static VALUE
rb_str_end_with(int argc, VALUE *argv, VALUE str)
{
int i;
char *p, *s, *e;
rb_encoding *enc;
for (i=0; istr, matching the pattern (which may be a
Regexp or a String). For each match, a result is
generated and either added to the result array or passed to the block. If
the pattern contains no groups, each individual result consists of the
matched string, $&. If the pattern contains groups, each
individual result is itself an array containing one entry per group.
a = "cruel world"
a.scan(/\w+/) #=> ["cruel", "world"]
a.scan(/.../) #=> ["cru", "el ", "wor"]
a.scan(/(...)/) #=> [["cru"], ["el "], ["wor"]]
a.scan(/(..)(..)/) #=> [["cr", "ue"], ["l ", "wo"]]
And the block form:
a.scan(/\w+/) {|w| print "<<#{w}>> " }
print "\n"
a.scan(/(.)(.)/) {|x,y| print y, x }
print "\n"
produces:
<> <>
rceu lowlr
;T;[o;
; I"
overload;F; 0;;; 0; I"scan(pattern);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@3;#[ ;$I"@return [Array];T;%0;"@3;&0;'F;(i ;[[I" pattern;T0;"@3o;
; I"
overload;F; 0;;; 0; I"scan(pattern);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"
match;TI"...;T;"@3o;!
; I" return;F; I" ;T;0; [I" String;T;"@3;#[ ;$I")@yield [match, ...]
@return [String];T;%0;"@3;&0;'F;(i ;[[I" pattern;T0;"@3;#[ ;$I"Both forms iterate through str, matching the pattern (which may be a
Regexp or a String). For each match, a result is
generated and either added to the result array or passed to the block. If
the pattern contains no groups, each individual result consists of the
matched string, $&. If the pattern contains groups, each
individual result is itself an array containing one entry per group.
a = "cruel world"
a.scan(/\w+/) #=> ["cruel", "world"]
a.scan(/.../) #=> ["cru", "el ", "wor"]
a.scan(/(...)/) #=> [["cru"], ["el "], ["wor"]]
a.scan(/(..)(..)/) #=> [["cr", "ue"], ["l ", "wo"]]
And the block form:
a.scan(/\w+/) {|w| print "<<#{w}>> " }
print "\n"
a.scan(/(.)(.)/) {|x,y| print y, x }
print "\n"
produces:
<> <>
rceu lowlr
@overload scan(pattern)
@return [Array]
@overload scan(pattern)
@yield [match, ...]
@return [String];T;%0;"@3;'F;)o;*;+T;,iI ;-ig ;.@(; I"static VALUE;T;/I"static VALUE
rb_str_scan(VALUE str, VALUE pat)
{
VALUE result;
long start = 0;
long last = -1, prev = 0;
char *p = RSTRING_PTR(str); long len = RSTRING_LEN(str);
pat = get_pat_quoted(pat, 1);
mustnot_broken(str);
if (!rb_block_given_p()) {
VALUE ary = rb_ary_new();
while (!NIL_P(result = scan_once(str, pat, &start))) {
last = prev;
prev = start;
rb_ary_push(ary, result);
}
if (last >= 0) rb_pat_search(pat, str, last, 1);
return ary;
}
while (!NIL_P(result = scan_once(str, pat, &start))) {
last = prev;
prev = start;
rb_yield(result);
str_mod_check(str, p, len);
}
if (last >= 0) rb_pat_search(pat, str, last, 1);
return str;
};T;0To;
; F; ;
;;;I"String#ljust;F;[[@0;[[@)i ;T;:
ljust;0;[ ;{ ;IC;"sIf integer is greater than the length of str, returns a new
String of length integer with str left justified
and padded with padstr; otherwise, returns str.
"hello".ljust(4) #=> "hello"
"hello".ljust(20) #=> "hello "
"hello".ljust(20, '1234') #=> "hello123412341234123"
;T;[o;
; I"
overload;F; 0;;; 0; I" ljust(integer, padstr=' ');T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@3;#[ ;$I"@return [String];T;%0;"@3;&0;'F;(i ;[[I" integer;T0[I" padstr;TI"' ';T;"@3;#[ ;$I"If integer is greater than the length of str, returns a new
String of length integer with str left justified
and padded with padstr; otherwise, returns str.
"hello".ljust(4) #=> "hello"
"hello".ljust(20) #=> "hello "
"hello".ljust(20, '1234') #=> "hello123412341234123"
@overload ljust(integer, padstr=' ')
@return [String];T;%0;"@3;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"ustatic VALUE
rb_str_ljust(int argc, VALUE *argv, VALUE str)
{
return rb_str_justify(argc, argv, str, 'l');
};T;0To;
; F; ;
;;;I"String#rjust;F;[[@0;[[@)i ;T;:
rjust;0;[ ;{ ;IC;"tIf integer is greater than the length of str, returns a new
String of length integer with str right justified
and padded with padstr; otherwise, returns str.
"hello".rjust(4) #=> "hello"
"hello".rjust(20) #=> " hello"
"hello".rjust(20, '1234') #=> "123412341234123hello"
;T;[o;
; I"
overload;F; 0;;; 0; I" rjust(integer, padstr=' ');T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@4;#[ ;$I"@return [String];T;%0;"@4;&0;'F;(i ;[[I" integer;T0[I" padstr;TI"' ';T;"@4;#[ ;$I"If integer is greater than the length of str, returns a new
String of length integer with str right justified
and padded with padstr; otherwise, returns str.
"hello".rjust(4) #=> "hello"
"hello".rjust(20) #=> " hello"
"hello".rjust(20, '1234') #=> "123412341234123hello"
@overload rjust(integer, padstr=' ')
@return [String];T;%0;"@4;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"ustatic VALUE
rb_str_rjust(int argc, VALUE *argv, VALUE str)
{
return rb_str_justify(argc, argv, str, 'r');
};T;0To;
; F; ;
;;;I"String#center;F;[[@0;[[@)i ;T;: center;0;[ ;{ ;IC;"SCenters +str+ in +width+. If +width+ is greater than the length of +str+,
returns a new String of length +width+ with +str+ centered and padded with
+padstr+; otherwise, returns +str+.
"hello".center(4) #=> "hello"
"hello".center(20) #=> " hello "
"hello".center(20, '123') #=> "1231231hello12312312"
;T;[o;
; I"
overload;F; 0;;; 0; I" center(width, padstr=' ');T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@74;#[ ;$I"@return [String];T;%0;"@74;&0;'F;(i ;[[I"
width;T0[I" padstr;TI"' ';T;"@74;#[ ;$I"Centers +str+ in +width+. If +width+ is greater than the length of +str+,
returns a new String of length +width+ with +str+ centered and padded with
+padstr+; otherwise, returns +str+.
"hello".center(4) #=> "hello"
"hello".center(20) #=> " hello "
"hello".center(20, '123') #=> "1231231hello12312312"
@overload center(width, padstr=' ')
@return [String];T;%0;"@74;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"vstatic VALUE
rb_str_center(int argc, VALUE *argv, VALUE str)
{
return rb_str_justify(argc, argv, str, 'c');
};T;0To;
; F; ;
;;;I"String#sub;F;[[@0;[[@)i ;T;:sub;0;[ ;{ ;IC;"eReturns a copy of +str+ with the _first_ occurrence of +pattern+
replaced by the second argument. The +pattern+ is typically a Regexp; if
given as a String, any regular expression metacharacters it contains will
be interpreted literally, e.g. '\\\d' will match a backlash
followed by 'd', instead of a digit.
If +replacement+ is a String it will be substituted for the matched text.
It may contain back-references to the pattern's capture groups of the form
"\\d", where d is a group number, or
"\\k", where n is a group name. If it is a
double-quoted string, both back-references must be preceded by an
additional backslash. However, within +replacement+ the special match
variables, such as &$, will not refer to the current match.
If +replacement+ is a String that looks like a pattern's capture group but
is actually not a pattern capture group e.g. "\\'", then it
will have to be preceded by two backslashes like so "\\\\'".
If the second argument is a Hash, and the matched text is one of its keys,
the corresponding value is the replacement string.
In the block form, the current match string is passed in as a parameter,
and variables such as $1, $2, $`,
$&, and $' will be set appropriately. The value
returned by the block will be substituted for the match on each call.
The result inherits any tainting in the original string or any supplied
replacement string.
"hello".sub(/[aeiou]/, '*') #=> "h*llo"
"hello".sub(/([aeiou])/, '<\1>') #=> "hllo"
"hello".sub(/./) {|s| s.ord.to_s + ' ' } #=> "104 ello"
"hello".sub(/(?[aeiou])/, '*\k*') #=> "h*e*llo"
'Is SHELL your preferred shell?'.sub(/[[:upper:]]{2,}/, ENV)
#=> "Is /bin/bash your preferred shell?"
;T;[o;
; I"
overload;F; 0;;; 0; I" sub(pattern, replacement);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@X4;#[ ;$I"@return [String];T;%0;"@X4;&0;'F;(i ;[[I" pattern;T0[I"replacement;T0;"@X4o;
; I"
overload;F; 0;;; 0; I"sub(pattern, hash);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@X4;#[ ;$I"@return [String];T;%0;"@X4;&0;'F;(i ;[[I" pattern;T0[I" hash;T0;"@X4o;
; I"
overload;F; 0;;; 0; I"sub(pattern);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"
match;T;"@X4o;!
; I" return;F; I" ;T;0; [I" String;T;"@X4;#[ ;$I"$@yield [match]
@return [String];T;%0;"@X4;&0;'F;(i ;[[I" pattern;T0;"@X4;#[ ;$I" Returns a copy of +str+ with the _first_ occurrence of +pattern+
replaced by the second argument. The +pattern+ is typically a Regexp; if
given as a String, any regular expression metacharacters it contains will
be interpreted literally, e.g. '\\\d' will match a backlash
followed by 'd', instead of a digit.
If +replacement+ is a String it will be substituted for the matched text.
It may contain back-references to the pattern's capture groups of the form
"\\d", where d is a group number, or
"\\k", where n is a group name. If it is a
double-quoted string, both back-references must be preceded by an
additional backslash. However, within +replacement+ the special match
variables, such as &$, will not refer to the current match.
If +replacement+ is a String that looks like a pattern's capture group but
is actually not a pattern capture group e.g. "\\'", then it
will have to be preceded by two backslashes like so "\\\\'".
If the second argument is a Hash, and the matched text is one of its keys,
the corresponding value is the replacement string.
In the block form, the current match string is passed in as a parameter,
and variables such as $1, $2, $`,
$&, and $' will be set appropriately. The value
returned by the block will be substituted for the match on each call.
The result inherits any tainting in the original string or any supplied
replacement string.
"hello".sub(/[aeiou]/, '*') #=> "h*llo"
"hello".sub(/([aeiou])/, '<\1>') #=> "hllo"
"hello".sub(/./) {|s| s.ord.to_s + ' ' } #=> "104 ello"
"hello".sub(/(?[aeiou])/, '*\k*') #=> "h*e*llo"
'Is SHELL your preferred shell?'.sub(/[[:upper:]]{2,}/, ENV)
#=> "Is /bin/bash your preferred shell?"
@overload sub(pattern, replacement)
@return [String]
@overload sub(pattern, hash)
@return [String]
@overload sub(pattern)
@yield [match]
@return [String];T;%0;"@X4;'F;)o;*;+T;,i;-i ;.@(; I"static VALUE;T;/I"static VALUE
rb_str_sub(int argc, VALUE *argv, VALUE str)
{
str = rb_str_dup(str);
rb_str_sub_bang(argc, argv, str);
return str;
};T;0To;
; F; ;
;;;I"String#gsub;F;[[@0;[[@)i;T;: gsub;0;[ ;{ ;IC;"!Returns a copy of str with the all occurrences of
pattern substituted for the second argument. The pattern is
typically a Regexp; if given as a String, any
regular expression metacharacters it contains will be interpreted
literally, e.g. '\\\d' will match a backlash followed by 'd',
instead of a digit.
If replacement is a String it will be substituted for
the matched text. It may contain back-references to the pattern's capture
groups of the form \\\d, where d is a group number, or
\\\k, where n is a group name. If it is a
double-quoted string, both back-references must be preceded by an
additional backslash. However, within replacement the special match
variables, such as $&, will not refer to the current match.
If the second argument is a Hash, and the matched text is one
of its keys, the corresponding value is the replacement string.
In the block form, the current match string is passed in as a parameter,
and variables such as $1, $2, $`,
$&, and $' will be set appropriately. The value
returned by the block will be substituted for the match on each call.
The result inherits any tainting in the original string or any supplied
replacement string.
When neither a block nor a second argument is supplied, an
Enumerator is returned.
"hello".gsub(/[aeiou]/, '*') #=> "h*ll*"
"hello".gsub(/([aeiou])/, '<\1>') #=> "hll"
"hello".gsub(/./) {|s| s.ord.to_s + ' '} #=> "104 101 108 108 111 "
"hello".gsub(/(?[aeiou])/, '{\k}') #=> "h{e}ll{o}"
'hello'.gsub(/[eo]/, 'e' => 3, 'o' => '*') #=> "h3ll*"
;T;[ o;
; I"
overload;F; 0;;; 0; I" gsub(pattern, replacement);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@4;#[ ;$I"@return [String];T;%0;"@4;&0;'F;(i ;[[I" pattern;T0[I"replacement;T0;"@4o;
; I"
overload;F; 0;;; 0; I"gsub(pattern, hash);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@4;#[ ;$I"@return [String];T;%0;"@4;&0;'F;(i ;[[I" pattern;T0[I" hash;T0;"@4o;
; I"
overload;F; 0;;; 0; I"gsub(pattern);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"
match;T;"@4o;!
; I" return;F; I" ;T;0; [I" String;T;"@4;#[ ;$I"$@yield [match]
@return [String];T;%0;"@4;&0;'F;(i ;[[I" pattern;T0;"@4o;
; I"
overload;F; 0;;; 0; I"gsub(pattern);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@4;&0;'F;(i ;[[I" pattern;T0;"@4;#[ ;$I"Returns a copy of str with the all occurrences of
pattern substituted for the second argument. The pattern is
typically a Regexp; if given as a String, any
regular expression metacharacters it contains will be interpreted
literally, e.g. '\\\d' will match a backlash followed by 'd',
instead of a digit.
If replacement is a String it will be substituted for
the matched text. It may contain back-references to the pattern's capture
groups of the form \\\d, where d is a group number, or
\\\k, where n is a group name. If it is a
double-quoted string, both back-references must be preceded by an
additional backslash. However, within replacement the special match
variables, such as $&, will not refer to the current match.
If the second argument is a Hash, and the matched text is one
of its keys, the corresponding value is the replacement string.
In the block form, the current match string is passed in as a parameter,
and variables such as $1, $2, $`,
$&, and $' will be set appropriately. The value
returned by the block will be substituted for the match on each call.
The result inherits any tainting in the original string or any supplied
replacement string.
When neither a block nor a second argument is supplied, an
Enumerator is returned.
"hello".gsub(/[aeiou]/, '*') #=> "h*ll*"
"hello".gsub(/([aeiou])/, '<\1>') #=> "hll"
"hello".gsub(/./) {|s| s.ord.to_s + ' '} #=> "104 101 108 108 111 "
"hello".gsub(/(?[aeiou])/, '{\k}') #=> "h{e}ll{o}"
'hello'.gsub(/[eo]/, 'e' => 3, 'o' => '*') #=> "h3ll*"
@overload gsub(pattern, replacement)
@return [String]
@overload gsub(pattern, hash)
@return [String]
@overload gsub(pattern)
@yield [match]
@return [String]
@overload gsub(pattern);T;%0;"@4;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"lstatic VALUE
rb_str_gsub(int argc, VALUE *argv, VALUE str)
{
return str_gsub(argc, argv, str, 0);
};T;0To;
; F; ;
;;;I"String#chop;F;[ ;[[@)i~ ;T;: chop;0;[ ;{ ;IC;"Returns a new String with the last character removed. If the
string ends with \r\n, both characters are removed. Applying
chop to an empty string returns an empty
string. String#chomp is often a safer alternative, as it leaves
the string unchanged if it doesn't end in a record separator.
"string\r\n".chop #=> "string"
"string\n\r".chop #=> "string\n"
"string\n".chop #=> "string"
"string".chop #=> "strin"
"x".chop.chop #=> ""
;T;[o;
; I"
overload;F; 0;;; 0; I" chop;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@4;#[ ;$I"@return [String];T;%0;"@4;&0;'F;(i ;[ ;"@4;#[ ;$I")Returns a new String with the last character removed. If the
string ends with \r\n, both characters are removed. Applying
chop to an empty string returns an empty
string. String#chomp is often a safer alternative, as it leaves
the string unchanged if it doesn't end in a record separator.
"string\r\n".chop #=> "string"
"string\n\r".chop #=> "string\n"
"string\n".chop #=> "string"
"string".chop #=> "strin"
"x".chop.chop #=> ""
@overload chop
@return [String];T;%0;"@4;'F;)o;*;+T;,im ;-i{ ;.@(; I"static VALUE;T;/I"cstatic VALUE
rb_str_chop(VALUE str)
{
return rb_str_subseq(str, 0, chopped_length(str));
};T;0To;
; F; ;
;;;I"String#chomp;F;[[@0;[[@)i* ;T;:
chomp;0;[ ;{ ;IC;"LReturns a new String with the given record separator removed
from the end of str (if present). If $/ has not been
changed from the default Ruby record separator, then chomp also
removes carriage return characters (that is it will remove \n,
\r, and \r\n). If $/ is an empty string,
it will remove all trailing newlines from the string.
"hello".chomp #=> "hello"
"hello\n".chomp #=> "hello"
"hello\r\n".chomp #=> "hello"
"hello\n\r".chomp #=> "hello\n"
"hello\r".chomp #=> "hello"
"hello \n there".chomp #=> "hello \n there"
"hello".chomp("llo") #=> "he"
"hello\r\n\r\n".chomp('') #=> "hello"
"hello\r\n\r\r\n".chomp('') #=> "hello\r\n\r"
;T;[o;
; I"
overload;F; 0;;; 0; I"chomp(separator=$/);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@5;#[ ;$I"@return [String];T;%0;"@5;&0;'F;(i ;[[I"separator;TI"$/;T;"@5;#[ ;$I"Returns a new String with the given record separator removed
from the end of str (if present). If $/ has not been
changed from the default Ruby record separator, then chomp also
removes carriage return characters (that is it will remove \n,
\r, and \r\n). If $/ is an empty string,
it will remove all trailing newlines from the string.
"hello".chomp #=> "hello"
"hello\n".chomp #=> "hello"
"hello\r\n".chomp #=> "hello"
"hello\n\r".chomp #=> "hello\n"
"hello\r".chomp #=> "hello"
"hello \n there".chomp #=> "hello \n there"
"hello".chomp("llo") #=> "he"
"hello\r\n\r\n".chomp('') #=> "hello"
"hello\r\n\r\r\n".chomp('') #=> "hello\r\n\r"
@overload chomp(separator=$/)
@return [String];T;%0;"@5;'F;)o;*;+T;,i ;-i' ;.@(; I"static VALUE;T;/I"static VALUE
rb_str_chomp(int argc, VALUE *argv, VALUE str)
{
VALUE rs = chomp_rs(argc, argv);
if (NIL_P(rs)) return rb_str_dup(str);
return rb_str_subseq(str, 0, chompped_length(str, rs));
};T;0To;
; F; ;
;;;I"String#strip;F;[ ;[[@)i ;T;:
strip;0;[ ;{ ;IC;"JReturns a copy of str with leading and trailing whitespace removed.
Whitespace is defined as any of the following characters:
null, horizontal tab, line feed, vertical tab, form feed, carriage return, space.
" hello ".strip #=> "hello"
"\tgoodbye\r\n".strip #=> "goodbye"
"\x00\t\n\v\f\r ".strip #=> ""
;T;[o;
; I"
overload;F; 0;;; 0; I"
strip;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@&5;#[ ;$I"@return [String];T;%0;"@&5;&0;'F;(i ;[ ;"@&5;#[ ;$I"oReturns a copy of str with leading and trailing whitespace removed.
Whitespace is defined as any of the following characters:
null, horizontal tab, line feed, vertical tab, form feed, carriage return, space.
" hello ".strip #=> "hello"
"\tgoodbye\r\n".strip #=> "goodbye"
"\x00\t\n\v\f\r ".strip #=> ""
@overload strip
@return [String];T;%0;"@&5;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"static VALUE
rb_str_strip(VALUE str)
{
char *start;
long olen, loffset, roffset;
rb_encoding *enc = STR_ENC_GET(str);
RSTRING_GETMEM(str, start, olen);
loffset = lstrip_offset(str, start, start+olen, enc);
roffset = rstrip_offset(str, start+loffset, start+olen, enc);
if (loffset <= 0 && roffset <= 0) return rb_str_dup(str);
return rb_str_subseq(str, loffset, olen-loffset-roffset);
};T;0To;
; F; ;
;;;I"String#lstrip;F;[ ;[[@)iw ;T;: lstrip;0;[ ;{ ;IC;"
Returns a copy of str with leading whitespace removed. See also
String#rstrip and String#strip.
Refer to strip for the definition of whitespace.
" hello ".lstrip #=> "hello "
"hello".lstrip #=> "hello"
;T;[o;
; I"
overload;F; 0;;; 0; I" lstrip;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@A5;#[ ;$I"@return [String];T;%0;"@A5;&0;'F;(i ;[ ;"@A5;#[ ;$I"0Returns a copy of str with leading whitespace removed. See also
String#rstrip and String#strip.
Refer to strip for the definition of whitespace.
" hello ".lstrip #=> "hello "
"hello".lstrip #=> "hello"
@overload lstrip
@return [String];T;%0;"@A5;'F;)o;*;+T;,ij ;-it ;.@(; I"static VALUE;T;/I"!static VALUE
rb_str_lstrip(VALUE str)
{
char *start;
long len, loffset;
RSTRING_GETMEM(str, start, len);
loffset = lstrip_offset(str, start, start+len, STR_ENC_GET(str));
if (loffset <= 0) return rb_str_dup(str);
return rb_str_subseq(str, loffset, len - loffset);
};T;0To;
; F; ;
;;;I"String#rstrip;F;[ ;[[@)i ;T;: rstrip;0;[ ;{ ;IC;" Returns a copy of str with trailing whitespace removed. See also
String#lstrip and String#strip.
Refer to strip for the definition of whitespace.
" hello ".rstrip #=> " hello"
"hello".rstrip #=> "hello"
;T;[o;
; I"
overload;F; 0;;; 0; I" rstrip;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@\5;#[ ;$I"@return [String];T;%0;"@\5;&0;'F;(i ;[ ;"@\5;#[ ;$I"1Returns a copy of str with trailing whitespace removed. See also
String#lstrip and String#strip.
Refer to strip for the definition of whitespace.
" hello ".rstrip #=> " hello"
"hello".rstrip #=> "hello"
@overload rstrip
@return [String];T;%0;"@\5;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"Dstatic VALUE
rb_str_rstrip(VALUE str)
{
rb_encoding *enc;
char *start;
long olen, roffset;
enc = STR_ENC_GET(str);
RSTRING_GETMEM(str, start, olen);
roffset = rstrip_offset(str, start, start+olen, enc);
if (roffset <= 0) return rb_str_dup(str);
return rb_str_subseq(str, 0, olen-roffset);
};T;0To;
; F; ;
;;;I"String#sub!;F;[[@0;[[@)ir;T;: sub!;0;[ ;{ ;IC;"Performs the same substitution as String#sub in-place.
Returns +str+ if a substitution was performed or +nil+ if no substitution
was performed.
;T;[o;
; I"
overload;F; 0;;; 0; I" sub!(pattern, replacement);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@w5;#[ ;$I"@return [String, nil];T;%0;"@w5;&0;'F;(i ;[[I" pattern;T0[I"replacement;T0;"@w5o;
; I"
overload;F; 0;;; 0; I"sub!(pattern);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"
match;T;"@w5o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@w5;#[ ;$I")@yield [match]
@return [String, nil];T;%0;"@w5;&0;'F;(i ;[[I" pattern;T0;"@w5;#[ ;$I"Performs the same substitution as String#sub in-place.
Returns +str+ if a substitution was performed or +nil+ if no substitution
was performed.
@overload sub!(pattern, replacement)
@return [String, nil]
@overload sub!(pattern)
@yield [match]
@return [String, nil];T;%0;"@w5;'F;)o;*;+T;,ig;-iq;.@(; I"static VALUE;T;/I"Z static VALUE
rb_str_sub_bang(int argc, VALUE *argv, VALUE str)
{
VALUE pat, repl, hash = Qnil;
int iter = 0;
int tainted = 0;
long plen;
int min_arity = rb_block_given_p() ? 1 : 2;
long beg;
rb_check_arity(argc, min_arity, 2);
if (argc == 1) {
iter = 1;
}
else {
repl = argv[1];
hash = rb_check_hash_type(argv[1]);
if (NIL_P(hash)) {
StringValue(repl);
}
tainted = OBJ_TAINTED_RAW(repl);
}
pat = get_pat_quoted(argv[0], 1);
str_modifiable(str);
beg = rb_pat_search(pat, str, 0, 1);
if (beg >= 0) {
rb_encoding *enc;
int cr = ENC_CODERANGE(str);
long beg0, end0;
VALUE match, match0 = Qnil;
struct re_registers *regs;
char *p, *rp;
long len, rlen;
match = rb_backref_get();
regs = RMATCH_REGS(match);
if (RB_TYPE_P(pat, T_STRING)) {
beg0 = beg;
end0 = beg0 + RSTRING_LEN(pat);
match0 = pat;
}
else {
beg0 = BEG(0);
end0 = END(0);
if (iter) match0 = rb_reg_nth_match(0, match);
}
if (iter || !NIL_P(hash)) {
p = RSTRING_PTR(str); len = RSTRING_LEN(str);
if (iter) {
repl = rb_obj_as_string(rb_yield(match0));
}
else {
repl = rb_hash_aref(hash, rb_str_subseq(str, beg0, end0 - beg0));
repl = rb_obj_as_string(repl);
}
str_mod_check(str, p, len);
rb_check_frozen(str);
}
else {
repl = rb_reg_regsub(repl, str, regs, RB_TYPE_P(pat, T_STRING) ? Qnil : pat);
}
enc = rb_enc_compatible(str, repl);
if (!enc) {
rb_encoding *str_enc = STR_ENC_GET(str);
p = RSTRING_PTR(str); len = RSTRING_LEN(str);
if (coderange_scan(p, beg0, str_enc) != ENC_CODERANGE_7BIT ||
coderange_scan(p+end0, len-end0, str_enc) != ENC_CODERANGE_7BIT) {
rb_raise(rb_eEncCompatError, "incompatible character encodings: %s and %s",
rb_enc_name(str_enc),
rb_enc_name(STR_ENC_GET(repl)));
}
enc = STR_ENC_GET(repl);
}
rb_str_modify(str);
rb_enc_associate(str, enc);
tainted |= OBJ_TAINTED_RAW(repl);
if (ENC_CODERANGE_UNKNOWN < cr && cr < ENC_CODERANGE_BROKEN) {
int cr2 = ENC_CODERANGE(repl);
if (cr2 == ENC_CODERANGE_BROKEN ||
(cr == ENC_CODERANGE_VALID && cr2 == ENC_CODERANGE_7BIT))
cr = ENC_CODERANGE_UNKNOWN;
else
cr = cr2;
}
plen = end0 - beg0;
rp = RSTRING_PTR(repl); rlen = RSTRING_LEN(repl);
len = RSTRING_LEN(str);
if (rlen > plen) {
RESIZE_CAPA(str, len + rlen - plen);
}
p = RSTRING_PTR(str);
if (rlen != plen) {
memmove(p + beg0 + rlen, p + beg0 + plen, len - beg0 - plen);
}
memcpy(p + beg0, rp, rlen);
len += rlen - plen;
STR_SET_LEN(str, len);
TERM_FILL(&RSTRING_PTR(str)[len], TERM_LEN(str));
ENC_CODERANGE_SET(str, cr);
FL_SET_RAW(str, tainted);
return str;
}
return Qnil;
};T;0To;
; F; ;
;;;I"String#gsub!;F;[[@0;[[@)i;T;:
gsub!;0;[ ;{ ;IC;"Performs the substitutions of String#gsub in place, returning
str, or nil if no substitutions were performed.
If no block and no replacement is given, an enumerator is returned instead.
;T;[ o;
; I"
overload;F; 0;;; 0; I" gsub!(pattern, replacement);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@5;#[ ;$I"@return [String, nil];T;%0;"@5;&0;'F;(i ;[[I" pattern;T0[I"replacement;T0;"@5o;
; I"
overload;F; 0;;; 0; I"gsub!(pattern, hash);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@5;#[ ;$I"@return [String, nil];T;%0;"@5;&0;'F;(i ;[[I" pattern;T0[I" hash;T0;"@5o;
; I"
overload;F; 0;;; 0; I"gsub!(pattern);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"
match;T;"@5o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@5;#[ ;$I")@yield [match]
@return [String, nil];T;%0;"@5;&0;'F;(i ;[[I" pattern;T0;"@5o;
; I"
overload;F; 0;;; 0; I"gsub!(pattern);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@5;&0;'F;(i ;[[I" pattern;T0;"@5;#[ ;$I"Performs the substitutions of String#gsub in place, returning
str, or nil if no substitutions were performed.
If no block and no replacement is given, an enumerator is returned instead.
@overload gsub!(pattern, replacement)
@return [String, nil]
@overload gsub!(pattern, hash)
@return [String, nil]
@overload gsub!(pattern)
@yield [match]
@return [String, nil]
@overload gsub!(pattern);T;%0;"@5;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"static VALUE
rb_str_gsub_bang(int argc, VALUE *argv, VALUE str)
{
str_modify_keep_cr(str);
return str_gsub(argc, argv, str, 1);
};T;0To;
; F; ;
;;;I"String#chop!;F;[ ;[[@)i[ ;T;:
chop!;0;[ ;{ ;IC;"Processes str as for String#chop, returning str,
or nil if str is the empty string. See also
String#chomp!.
;T;[o;
; I"
overload;F; 0;;; 0; I"
chop!;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@5;#[ ;$I"@return [String, nil];T;%0;"@5;&0;'F;(i ;[ ;"@5;#[ ;$I"Processes str as for String#chop, returning str,
or nil if str is the empty string. See also
String#chomp!.
@overload chop!
@return [String, nil];T;%0;"@5;'F;)o;*;+T;,iR ;-iX ;.@(; I"static VALUE;T;/I"Rstatic VALUE
rb_str_chop_bang(VALUE str)
{
str_modify_keep_cr(str);
if (RSTRING_LEN(str) > 0) {
long len;
len = chopped_length(str);
STR_SET_LEN(str, len);
TERM_FILL(&RSTRING_PTR(str)[len], TERM_LEN(str));
if (ENC_CODERANGE(str) != ENC_CODERANGE_7BIT) {
ENC_CODERANGE_CLEAR(str);
}
return str;
}
return Qnil;
};T;0To;
; F; ;
;;;I"String#chomp!;F;[[@0;[[@)i ;T;: chomp!;0;[ ;{ ;IC;"Modifies str in place as described for String#chomp,
returning str, or nil if no modifications were made.
;T;[o;
; I"
overload;F; 0;;; 0; I"chomp!(separator=$/);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@6;#[ ;$I"@return [String, nil];T;%0;"@6;&0;'F;(i ;[[I"separator;TI"$/;T;"@6;#[ ;$I"Modifies str in place as described for String#chomp,
returning str, or nil if no modifications were made.
@overload chomp!(separator=$/)
@return [String, nil];T;%0;"@6;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"static VALUE
rb_str_chomp_bang(int argc, VALUE *argv, VALUE str)
{
VALUE rs;
long olen;
str_modify_keep_cr(str);
if ((olen = RSTRING_LEN(str)) > 0 && !NIL_P(rs = chomp_rs(argc, argv))) {
long len;
len = chompped_length(str, rs);
if (len < olen) {
STR_SET_LEN(str, len);
TERM_FILL(&RSTRING_PTR(str)[len], TERM_LEN(str));
if (ENC_CODERANGE(str) != ENC_CODERANGE_7BIT) {
ENC_CODERANGE_CLEAR(str);
}
return str;
}
}
return Qnil;
};T;0To;
; F; ;
;;;I"String#strip!;F;[ ;[[@)i ;T;: strip!;0;[ ;{ ;IC;"Removes leading and trailing whitespace from str. Returns
nil if str was not altered.
Refer to strip for the definition of whitespace.
;T;[o;
; I"
overload;F; 0;;; 0; I" strip!;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@;6;#[ ;$I"@return [String, nil];T;%0;"@;6;&0;'F;(i ;[ ;"@;6;#[ ;$I"Removes leading and trailing whitespace from str. Returns
nil if str was not altered.
Refer to strip for the definition of whitespace.
@overload strip!
@return [String, nil];T;%0;"@;6;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"xstatic VALUE
rb_str_strip_bang(VALUE str)
{
char *start;
long olen, loffset, roffset;
rb_encoding *enc;
str_modify_keep_cr(str);
enc = STR_ENC_GET(str);
RSTRING_GETMEM(str, start, olen);
loffset = lstrip_offset(str, start, start+olen, enc);
roffset = rstrip_offset(str, start+loffset, start+olen, enc);
if (loffset > 0 || roffset > 0) {
long len = olen-roffset;
if (loffset > 0) {
len -= loffset;
memmove(start, start + loffset, len);
}
STR_SET_LEN(str, len);
#if !SHARABLE_MIDDLE_SUBSTRING
TERM_FILL(start+len, rb_enc_mbminlen(enc));
#endif
return str;
}
return Qnil;
};T;0To;
; F; ;
;;;I"String#lstrip!;F;[ ;[[@)iQ ;T;: lstrip!;0;[ ;{ ;IC;"(Removes leading whitespace from str, returning nil if no
change was made. See also String#rstrip! and
String#strip!.
Refer to strip for the definition of whitespace.
" hello ".lstrip #=> "hello "
"hello".lstrip! #=> nil
;T;[o;
; I"
overload;F; 0;;; 0; I" lstrip!;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" self;TI"nil;T;"@W6;#[ ;$I"@return [self, nil];T;%0;"@W6;&0;'F;(i ;[ ;"@W6;#[ ;$I"RRemoves leading whitespace from str, returning nil if no
change was made. See also String#rstrip! and
String#strip!.
Refer to strip for the definition of whitespace.
" hello ".lstrip #=> "hello "
"hello".lstrip! #=> nil
@overload lstrip!
@return [self, nil];T;%0;"@W6;'F;)o;*;+T;,iC ;-iN ;.@(; I"static VALUE;T;/I"static VALUE
rb_str_lstrip_bang(VALUE str)
{
rb_encoding *enc;
char *start, *s;
long olen, loffset;
str_modify_keep_cr(str);
enc = STR_ENC_GET(str);
RSTRING_GETMEM(str, start, olen);
loffset = lstrip_offset(str, start, start+olen, enc);
if (loffset > 0) {
long len = olen-loffset;
s = start + loffset;
memmove(start, s, len);
STR_SET_LEN(str, len);
#if !SHARABLE_MIDDLE_SUBSTRING
TERM_FILL(start+len, rb_enc_mbminlen(enc));
#endif
return str;
}
return Qnil;
};T;0To;
; F; ;
;;;I"String#rstrip!;F;[ ;[[@)i ;T;: rstrip!;0;[ ;{ ;IC;")Removes trailing whitespace from str, returning nil if
no change was made. See also String#lstrip! and
String#strip!.
Refer to strip for the definition of whitespace.
" hello ".rstrip #=> " hello"
"hello".rstrip! #=> nil
;T;[o;
; I"
overload;F; 0;;; 0; I" rstrip!;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" self;TI"nil;T;"@s6;#[ ;$I"@return [self, nil];T;%0;"@s6;&0;'F;(i ;[ ;"@s6;#[ ;$I"SRemoves trailing whitespace from str, returning nil if
no change was made. See also String#lstrip! and
String#strip!.
Refer to strip for the definition of whitespace.
" hello ".rstrip #=> " hello"
"hello".rstrip! #=> nil
@overload rstrip!
@return [self, nil];T;%0;"@s6;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"static VALUE
rb_str_rstrip_bang(VALUE str)
{
rb_encoding *enc;
char *start;
long olen, roffset;
str_modify_keep_cr(str);
enc = STR_ENC_GET(str);
RSTRING_GETMEM(str, start, olen);
roffset = rstrip_offset(str, start, start+olen, enc);
if (roffset > 0) {
long len = olen - roffset;
STR_SET_LEN(str, len);
#if !SHARABLE_MIDDLE_SUBSTRING
TERM_FILL(start+len, rb_enc_mbminlen(enc));
#endif
return str;
}
return Qnil;
};T;0To;
; F; ;
;;;I"String#tr;F;[[I"src;T0[I" repl;T0;[[@)i;T;:tr;0;[ ;{ ;IC;"Returns a copy of +str+ with the characters in +from_str+ replaced by the
corresponding characters in +to_str+. If +to_str+ is shorter than
+from_str+, it is padded with its last character in order to maintain the
correspondence.
"hello".tr('el', 'ip') #=> "hippo"
"hello".tr('aeiou', '*') #=> "h*ll*"
"hello".tr('aeiou', 'AA*') #=> "hAll*"
Both strings may use the c1-c2 notation to denote ranges of
characters, and +from_str+ may start with a ^, which denotes
all characters except those listed.
"hello".tr('a-y', 'b-z') #=> "ifmmp"
"hello".tr('^aeiou', '*') #=> "*e**o"
The backslash character \\ can be used to escape
^ or - and is otherwise ignored unless it
appears at the end of a range or the end of the +from_str+ or +to_str+:
"hello^world".tr("\\^aeiou", "*") #=> "h*ll**w*rld"
"hello-world".tr("a\\-eo", "*") #=> "h*ll**w*rld"
"hello\r\nworld".tr("\r", "") #=> "hello\nworld"
"hello\r\nworld".tr("\\r", "") #=> "hello\r\nwold"
"hello\r\nworld".tr("\\\r", "") #=> "hello\nworld"
"X['\\b']".tr("X\\", "") #=> "['b']"
"X['\\b']".tr("X-\\]", "") #=> "'b'"
;T;[o;
; I"
overload;F; 0;;; 0; I"tr(from_str, to_str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@6;#[ ;$I"@return [String];T;%0;"@6;&0;'F;(i ;[[I"
from_str;T0[I" to_str;T0;"@6;#[ ;$I"Returns a copy of +str+ with the characters in +from_str+ replaced by the
corresponding characters in +to_str+. If +to_str+ is shorter than
+from_str+, it is padded with its last character in order to maintain the
correspondence.
"hello".tr('el', 'ip') #=> "hippo"
"hello".tr('aeiou', '*') #=> "h*ll*"
"hello".tr('aeiou', 'AA*') #=> "hAll*"
Both strings may use the c1-c2 notation to denote ranges of
characters, and +from_str+ may start with a ^, which denotes
all characters except those listed.
"hello".tr('a-y', 'b-z') #=> "ifmmp"
"hello".tr('^aeiou', '*') #=> "*e**o"
The backslash character \\ can be used to escape
^ or - and is otherwise ignored unless it
appears at the end of a range or the end of the +from_str+ or +to_str+:
"hello^world".tr("\\^aeiou", "*") #=> "h*ll**w*rld"
"hello-world".tr("a\\-eo", "*") #=> "h*ll**w*rld"
"hello\r\nworld".tr("\r", "") #=> "hello\nworld"
"hello\r\nworld".tr("\\r", "") #=> "hello\r\nwold"
"hello\r\nworld".tr("\\\r", "") #=> "hello\nworld"
"X['\\b']".tr("X\\", "") #=> "['b']"
"X['\\b']".tr("X-\\]", "") #=> "'b'"
@overload tr(from_str, to_str)
@return [String];T;%0;"@6;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"static VALUE
rb_str_tr(VALUE str, VALUE src, VALUE repl)
{
str = rb_str_dup(str);
tr_trans(str, src, repl, 0);
return str;
};T;0To;
; F; ;
;;;I"String#tr_s;F;[[I"src;T0[I" repl;T0;[[@)i;T;: tr_s;0;[ ;{ ;IC;"Processes a copy of str as described under String#tr,
then removes duplicate characters in regions that were affected by the
translation.
"hello".tr_s('l', 'r') #=> "hero"
"hello".tr_s('el', '*') #=> "h*o"
"hello".tr_s('el', 'hx') #=> "hhxo"
;T;[o;
; I"
overload;F; 0;;; 0; I"tr_s(from_str, to_str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@6;#[ ;$I"@return [String];T;%0;"@6;&0;'F;(i ;[[I"
from_str;T0[I" to_str;T0;"@6;#[ ;$I"NProcesses a copy of str as described under String#tr,
then removes duplicate characters in regions that were affected by the
translation.
"hello".tr_s('l', 'r') #=> "hero"
"hello".tr_s('el', '*') #=> "h*o"
"hello".tr_s('el', 'hx') #=> "hhxo"
@overload tr_s(from_str, to_str)
@return [String];T;%0;"@6;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"static VALUE
rb_str_tr_s(VALUE str, VALUE src, VALUE repl)
{
str = rb_str_dup(str);
tr_trans(str, src, repl, 1);
return str;
};T;0To;
; F; ;
;;;I"String#delete;F;[[@0;[[@)id;T;: delete;0;[ ;{ ;IC;"cReturns a copy of str with all characters in the intersection of its
arguments deleted. Uses the same rules for building the set of characters as
String#count.
"hello".delete "l","lo" #=> "heo"
"hello".delete "lo" #=> "he"
"hello".delete "aeiou", "^e" #=> "hell"
"hello".delete "ej-m" #=> "ho"
;T;[o;
; I"
overload;F; 0;;; 0; I"delete([other_str]+);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@6;#[ ;$I"@return [String];T;%0;"@6;&0;'F;(i ;[[I"[other_str];T0;"@6;#[ ;$I"Returns a copy of str with all characters in the intersection of its
arguments deleted. Uses the same rules for building the set of characters as
String#count.
"hello".delete "l","lo" #=> "heo"
"hello".delete "lo" #=> "he"
"hello".delete "aeiou", "^e" #=> "hell"
"hello".delete "ej-m" #=> "ho"
@overload delete([other_str]+)
@return [String];T;%0;"@6;'F;)o;*;+T;,iV;-ia;.@(; I"static VALUE;T;/I"static VALUE
rb_str_delete(int argc, VALUE *argv, VALUE str)
{
str = rb_str_dup(str);
rb_str_delete_bang(argc, argv, str);
return str;
};T;0To;
; F; ;
;;;I"String#squeeze;F;[[@0;[[@)i;T;: squeeze;0;[ ;{ ;IC;"Builds a set of characters from the other_str parameter(s) using the
procedure described for String#count. Returns a new string
where runs of the same character that occur in this set are replaced by a
single character. If no arguments are given, all runs of identical
characters are replaced by a single character.
"yellow moon".squeeze #=> "yelow mon"
" now is the".squeeze(" ") #=> " now is the"
"putters shoot balls".squeeze("m-z") #=> "puters shot balls"
;T;[o;
; I"
overload;F; 0;;; 0; I"squeeze([other_str]*);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@6;#[ ;$I"@return [String];T;%0;"@6;&0;'F;(i ;[[I"[other_str];T0;"@6;#[ ;$I"=Builds a set of characters from the other_str parameter(s) using the
procedure described for String#count. Returns a new string
where runs of the same character that occur in this set are replaced by a
single character. If no arguments are given, all runs of identical
characters are replaced by a single character.
"yellow moon".squeeze #=> "yelow mon"
" now is the".squeeze(" ") #=> " now is the"
"putters shoot balls".squeeze("m-z") #=> "puters shot balls"
@overload squeeze([other_str]*)
@return [String];T;%0;"@6;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"static VALUE
rb_str_squeeze(int argc, VALUE *argv, VALUE str)
{
str = rb_str_dup(str);
rb_str_squeeze_bang(argc, argv, str);
return str;
};T;0To;
; F; ;
;;;I"String#count;F;[[@0;[[@)i;T;:
count;0;[ ;{ ;IC;"tEach +other_str+ parameter defines a set of characters to count. The
intersection of these sets defines the characters to count in +str+. Any
+other_str+ that starts with a caret ^ is negated. The
sequence c1-c2 means all characters between c1 and c2. The
backslash character \\ can be used to escape ^ or
- and is otherwise ignored unless it appears at the end of a
sequence or the end of a +other_str+.
a = "hello world"
a.count "lo" #=> 5
a.count "lo", "o" #=> 2
a.count "hello", "^l" #=> 4
a.count "ej-m" #=> 4
"hello^world".count "\\^aeiou" #=> 4
"hello-world".count "a\\-eo" #=> 4
c = "hello world\\r\\n"
c.count "\\" #=> 2
c.count "\\A" #=> 0
c.count "X-\\w" #=> 3
;T;[o;
; I"
overload;F; 0;;; 0; I"count([other_str]+);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;T;"@7;#[ ;$I"@return [Fixnum];T;%0;"@7;&0;'F;(i ;[[I"[other_str];T0;"@7;#[ ;$I"Each +other_str+ parameter defines a set of characters to count. The
intersection of these sets defines the characters to count in +str+. Any
+other_str+ that starts with a caret ^ is negated. The
sequence c1-c2 means all characters between c1 and c2. The
backslash character \\ can be used to escape ^ or
- and is otherwise ignored unless it appears at the end of a
sequence or the end of a +other_str+.
a = "hello world"
a.count "lo" #=> 5
a.count "lo", "o" #=> 2
a.count "hello", "^l" #=> 4
a.count "ej-m" #=> 4
"hello^world".count "\\^aeiou" #=> 4
"hello-world".count "a\\-eo" #=> 4
c = "hello world\\r\\n"
c.count "\\" #=> 2
c.count "\\A" #=> 0
c.count "X-\\w" #=> 3
@overload count([other_str]+)
@return [Fixnum];T;%0;"@7;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"`static VALUE
rb_str_count(int argc, VALUE *argv, VALUE str)
{
char table[TR_TABLE_SIZE];
rb_encoding *enc = 0;
VALUE del = 0, nodel = 0, tstr;
char *s, *send;
int i;
int ascompat;
rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS);
tstr = argv[0];
StringValue(tstr);
enc = rb_enc_check(str, tstr);
if (argc == 1) {
const char *ptstr;
if (RSTRING_LEN(tstr) == 1 && rb_enc_asciicompat(enc) &&
(ptstr = RSTRING_PTR(tstr),
ONIGENC_IS_ALLOWED_REVERSE_MATCH(enc, (const unsigned char *)ptstr, (const unsigned char *)ptstr+1)) &&
!is_broken_string(str)) {
int n = 0;
int clen;
unsigned char c = rb_enc_codepoint_len(ptstr, ptstr+1, &clen, enc);
s = RSTRING_PTR(str);
if (!s || RSTRING_LEN(str) == 0) return INT2FIX(0);
send = RSTRING_END(str);
while (s < send) {
if (*(unsigned char*)s++ == c) n++;
}
return INT2NUM(n);
}
}
tr_setup_table(tstr, table, TRUE, &del, &nodel, enc);
for (i=1; istr in place, using the same rules as
String#tr. Returns str, or nil if no
changes were made.
;T;[o;
; I"
overload;F; 0;;; 0; I"tr!(from_str, to_str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@/7;#[ ;$I"@return [String, nil];T;%0;"@/7;&0;'F;(i ;[[I"
from_str;T0[I" to_str;T0;"@/7;#[ ;$I"Translates str in place, using the same rules as
String#tr. Returns str, or nil if no
changes were made.
@overload tr!(from_str, to_str)
@return [String, nil];T;%0;"@/7;'F;)o;*;+T;,i~;-i;.@(; I"static VALUE;T;/I"nstatic VALUE
rb_str_tr_bang(VALUE str, VALUE src, VALUE repl)
{
return tr_trans(str, src, repl, 0);
};T;0To;
; F; ;
;;;I"String#tr_s!;F;[[I"src;T0[I" repl;T0;[[@)i;T;:
tr_s!;0;[ ;{ ;IC;"Performs String#tr_s processing on str in place,
returning str, or nil if no changes were made.
;T;[o;
; I"
overload;F; 0;;; 0; I" tr_s!(from_str, to_str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@S7;#[ ;$I"@return [String, nil];T;%0;"@S7;&0;'F;(i ;[[I"
from_str;T0[I" to_str;T0;"@S7;#[ ;$I"Performs String#tr_s processing on str in place,
returning str, or nil if no changes were made.
@overload tr_s!(from_str, to_str)
@return [String, nil];T;%0;"@S7;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"pstatic VALUE
rb_str_tr_s_bang(VALUE str, VALUE src, VALUE repl)
{
return tr_trans(str, src, repl, 1);
};T;0To;
; F; ;
;;;I"String#delete!;F;[[@0;[[@)i;T;: delete!;0;[ ;{ ;IC;"|Performs a delete operation in place, returning str, or
nil if str was not modified.
;T;[o;
; I"
overload;F; 0;;; 0; I"delete!([other_str]+);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@w7;#[ ;$I"@return [String, nil];T;%0;"@w7;&0;'F;(i ;[[I"[other_str];T0;"@w7;#[ ;$I"Performs a delete operation in place, returning str, or
nil if str was not modified.
@overload delete!([other_str]+)
@return [String, nil];T;%0;"@w7;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"3static VALUE
rb_str_delete_bang(int argc, VALUE *argv, VALUE str)
{
char squeez[TR_TABLE_SIZE];
rb_encoding *enc = 0;
char *s, *send, *t;
VALUE del = 0, nodel = 0;
int modify = 0;
int i, ascompat, cr;
if (RSTRING_LEN(str) == 0 || !RSTRING_PTR(str)) return Qnil;
rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS);
for (i=0; istr in place, returning either str, or
nil if no changes were made.
;T;[o;
; I"
overload;F; 0;;; 0; I"squeeze!([other_str]*);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@7;#[ ;$I"@return [String, nil];T;%0;"@7;&0;'F;(i ;[[I"[other_str];T0;"@7;#[ ;$I"Squeezes str in place, returning either str, or
nil if no changes were made.
@overload squeeze!([other_str]*)
@return [String, nil];T;%0;"@7;'F;)o;*;+T;,im;-ir;.@(; I"static VALUE;T;/I"Rstatic VALUE
rb_str_squeeze_bang(int argc, VALUE *argv, VALUE str)
{
char squeez[TR_TABLE_SIZE];
rb_encoding *enc = 0;
VALUE del = 0, nodel = 0;
char *s, *send, *t;
int i, modify = 0;
int ascompat, singlebyte = single_byte_optimizable(str);
unsigned int save;
if (argc == 0) {
enc = STR_ENC_GET(str);
}
else {
for (i=0; i 0 && !squeez[c])) {
*t++ = save = c;
}
}
}
else {
while (s < send) {
unsigned int c;
int clen;
if (ascompat && (c = *(unsigned char*)s) < 0x80) {
if (c != save || (argc > 0 && !squeez[c])) {
*t++ = save = c;
}
s++;
}
else {
c = rb_enc_codepoint_len(s, send, &clen, enc);
if (c != save || (argc > 0 && !tr_find(c, squeez, del, nodel))) {
if (t != s) rb_enc_mbcput(c, t, enc);
save = c;
t += clen;
}
s += clen;
}
}
}
TERM_FILL(t, TERM_LEN(str));
if (t - RSTRING_PTR(str) != RSTRING_LEN(str)) {
STR_SET_LEN(str, t - RSTRING_PTR(str));
modify = 1;
}
if (modify) return str;
return Qnil;
};T;0To;
; F; ;
;;;I"String#each_line;F;[[@0;[[@)i ;T;:each_line;0;[ ;{ ;IC;"Splits str using the supplied parameter as the record
separator ($/ by default), passing each substring in
turn to the supplied block. If a zero-length record separator is
supplied, the string is split into paragraphs delimited by
multiple successive newlines.
If no block is given, an enumerator is returned instead.
print "Example one\n"
"hello\nworld".each_line {|s| p s}
print "Example two\n"
"hello\nworld".each_line('l') {|s| p s}
print "Example three\n"
"hello\n\n\nworld".each_line('') {|s| p s}
produces:
Example one
"hello\n"
"world"
Example two
"hel"
"l"
"o\nworl"
"d"
Example three
"hello\n\n\n"
"world"
;T;[o;
; I"
overload;F; 0;;; 0; I" each_line(separator=$/);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" substr;T;"@7o;!
; I" return;F; I" ;T;0; [I" String;T;"@7;#[ ;$I"%@yield [substr]
@return [String];T;%0;"@7;&0;'F;(i ;[[I"separator;TI"$/;T;"@7o;
; I"
overload;F; 0;;; 0; I" each_line(separator=$/);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@7;&0;'F;(i ;[[I"separator;TI"$/;T;"@7;#[ ;$I"'Splits str using the supplied parameter as the record
separator ($/ by default), passing each substring in
turn to the supplied block. If a zero-length record separator is
supplied, the string is split into paragraphs delimited by
multiple successive newlines.
If no block is given, an enumerator is returned instead.
print "Example one\n"
"hello\nworld".each_line {|s| p s}
print "Example two\n"
"hello\nworld".each_line('l') {|s| p s}
print "Example three\n"
"hello\n\n\nworld".each_line('') {|s| p s}
produces:
Example one
"hello\n"
"world"
Example two
"hel"
"l"
"o\nworl"
"d"
Example three
"hello\n\n\n"
"world"
@overload each_line(separator=$/)
@yield [substr]
@return [String]
@overload each_line(separator=$/);T;%0;"@7;'F;)o;*;+T;,i;-i ;.@(; I"static VALUE;T;/I"static VALUE
rb_str_each_line(int argc, VALUE *argv, VALUE str)
{
return rb_str_enumerate_lines(argc, argv, str, 0);
};T;0To;
; F; ;
;;;I"String#each_byte;F;[ ;[[@)ib ;T;:each_byte;0;[ ;{ ;IC;"Passes each byte in str to the given block, or returns an
enumerator if no block is given.
"hello".each_byte {|c| print c, ' ' }
produces:
104 101 108 108 111
;T;[o;
; I"
overload;F; 0;;; 0; I"each_byte;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" fixnum;T;"@7o;!
; I" return;F; I" ;T;0; [I" String;T;"@7;#[ ;$I"%@yield [fixnum]
@return [String];T;%0;"@7;&0;'F;(i ;[ ;"@7o;
; I"
overload;F; 0;;; 0; I"each_byte;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@7;&0;'F;(i ;[ ;"@7;#[ ;$I"Passes each byte in str to the given block, or returns an
enumerator if no block is given.
"hello".each_byte {|c| print c, ' ' }
produces:
104 101 108 108 111
@overload each_byte
@yield [fixnum]
@return [String]
@overload each_byte;T;%0;"@7;'F;)o;*;+T;,iS ;-i` ;.@(; I"static VALUE;T;/I"\static VALUE
rb_str_each_byte(VALUE str)
{
return rb_str_enumerate_bytes(str, 0);
};T;0To;
; F; ;
;;;I"String#each_char;F;[ ;[[@)i ;T;:each_char;0;[ ;{ ;IC;"Passes each character in str to the given block, or returns
an enumerator if no block is given.
"hello".each_char {|c| print c, ' ' }
produces:
h e l l o
;T;[o;
; I"
overload;F; 0;;; 0; I"each_char;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" cstr;T;"@ 8o;!
; I" return;F; I" ;T;0; [I" String;T;"@ 8;#[ ;$I"#@yield [cstr]
@return [String];T;%0;"@ 8;&0;'F;(i ;[ ;"@ 8o;
; I"
overload;F; 0;;; 0; I"each_char;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ 8;&0;'F;(i ;[ ;"@ 8;#[ ;$I"Passes each character in str to the given block, or returns
an enumerator if no block is given.
"hello".each_char {|c| print c, ' ' }
produces:
h e l l o
@overload each_char
@yield [cstr]
@return [String]
@overload each_char;T;%0;"@ 8;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"\static VALUE
rb_str_each_char(VALUE str)
{
return rb_str_enumerate_chars(str, 0);
};T;0To;
; F; ;
;;;I"String#each_codepoint;F;[ ;[[@)i' ;T;:each_codepoint;0;[ ;{ ;IC;"=Passes the Integer ordinal of each character in str,
also known as a codepoint when applied to Unicode strings to the
given block.
If no block is given, an enumerator is returned instead.
"hello\u0639".each_codepoint {|c| print c, ' ' }
produces:
104 101 108 108 111 1593
;T;[o;
; I"
overload;F; 0;;; 0; I"each_codepoint;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" integer;T;"@48o;!
; I" return;F; I" ;T;0; [I" String;T;"@48;#[ ;$I"&@yield [integer]
@return [String];T;%0;"@48;&0;'F;(i ;[ ;"@48o;
; I"
overload;F; 0;;; 0; I"each_codepoint;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@48;&0;'F;(i ;[ ;"@48;#[ ;$I"Passes the Integer ordinal of each character in str,
also known as a codepoint when applied to Unicode strings to the
given block.
If no block is given, an enumerator is returned instead.
"hello\u0639".each_codepoint {|c| print c, ' ' }
produces:
104 101 108 108 111 1593
@overload each_codepoint
@yield [integer]
@return [String]
@overload each_codepoint;T;%0;"@48;'F;)o;*;+T;,i ;-i% ;.@(; I"static VALUE;T;/I"fstatic VALUE
rb_str_each_codepoint(VALUE str)
{
return rb_str_enumerate_codepoints(str, 0);
};T;0To;
; F; ;
;;;I"String#sum;F;[[@0;[[@)i ;T;:sum;0;[ ;{ ;IC;".Returns a basic n-bit checksum of the characters in str,
where n is the optional Fixnum parameter, defaulting
to 16. The result is simply the sum of the binary value of each byte in
str modulo 2**n - 1. This is not a particularly good
checksum.
;T;[o;
; I"
overload;F; 0;;; 0; I"sum(n=16);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@\8;#[ ;$I"@return [Integer];T;%0;"@\8;&0;'F;(i ;[[I"n;TI"16;T;"@\8;#[ ;$I"XReturns a basic n-bit checksum of the characters in str,
where n is the optional Fixnum parameter, defaulting
to 16. The result is simply the sum of the binary value of each byte in
str modulo 2**n - 1. This is not a particularly good
checksum.
@overload sum(n=16)
@return [Integer];T;%0;"@\8;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"Pstatic VALUE
rb_str_sum(int argc, VALUE *argv, VALUE str)
{
VALUE vbits;
int bits;
char *ptr, *p, *pend;
long len;
VALUE sum = INT2FIX(0);
unsigned long sum0 = 0;
if (argc == 0) {
bits = 16;
}
else {
rb_scan_args(argc, argv, "01", &vbits);
bits = NUM2INT(vbits);
if (bits < 0)
bits = 0;
}
ptr = p = RSTRING_PTR(str);
len = RSTRING_LEN(str);
pend = p + len;
while (p < pend) {
if (FIXNUM_MAX - UCHAR_MAX < sum0) {
sum = rb_funcall(sum, '+', 1, LONG2FIX(sum0));
str_mod_check(str, ptr, len);
sum0 = 0;
}
sum0 += (unsigned char)*p;
p++;
}
if (bits == 0) {
if (sum0) {
sum = rb_funcall(sum, '+', 1, LONG2FIX(sum0));
}
}
else {
if (sum == INT2FIX(0)) {
if (bits < (int)sizeof(long)*CHAR_BIT) {
sum0 &= (((unsigned long)1)< "e"
a[2, 3] #=> "llo"
a[2..3] #=> "ll"
a[-3, 2] #=> "er"
a[7..-2] #=> "her"
a[-4..-2] #=> "her"
a[-2..-4] #=> ""
a[11, 0] #=> ""
a[11] #=> nil
a[12, 0] #=> nil
a[12..-1] #=> nil
a[/[aeiou](.)\1/] #=> "ell"
a[/[aeiou](.)\1/, 0] #=> "ell"
a[/[aeiou](.)\1/, 1] #=> "l"
a[/[aeiou](.)\1/, 2] #=> nil
a[/(?[aeiou])(?[^aeiou])/, "non_vowel"] #=> "l"
a[/(?[aeiou])(?[^aeiou])/, "vowel"] #=> "e"
a["lo"] #=> "lo"
a["bye"] #=> nil
;T;[o;
; I"
overload;F; 0;;V; 0; I"[](index);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@{8;#[ ;$I"@return [String, nil];T;%0;"@{8;&0;'F;(i ;[[I"
index;T0;"@{8o;
; I"
overload;F; 0;;V; 0; I"[](start, length);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@{8;#[ ;$I"@return [String, nil];T;%0;"@{8;&0;'F;(i ;[[I"
start;T0[I" length;T0;"@{8o;
; I"
overload;F; 0;;V; 0; I"[](range);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@{8;#[ ;$I"@return [String, nil];T;%0;"@{8;&0;'F;(i ;[[I"
range;T0;"@{8o;
; I"
overload;F; 0;;V; 0; I"[](regexp);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@{8;#[ ;$I"@return [String, nil];T;%0;"@{8;&0;'F;(i ;[[I" regexp;T0;"@{8o;
; I"
overload;F; 0;;V; 0; I"[](regexp, capture);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@{8;#[ ;$I"@return [String, nil];T;%0;"@{8;&0;'F;(i ;[[I" regexp;T0[I" capture;T0;"@{8o;
; I"
overload;F; 0;;V; 0; I"[](match_str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@{8;#[ ;$I"@return [String, nil];T;%0;"@{8;&0;'F;(i ;[[I"match_str;T0;"@{8o;
; I"
overload;F; 0;;W; 0; I"slice(index);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@{8;#[ ;$I"@return [String, nil];T;%0;"@{8;&0;'F;(i ;[[I"
index;T0;"@{8o;
; I"
overload;F; 0;;W; 0; I"slice(start, length);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@{8;#[ ;$I"@return [String, nil];T;%0;"@{8;&0;'F;(i ;[[I"
start;T0[I" length;T0;"@{8o;
; I"
overload;F; 0;;W; 0; I"slice(range);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@{8;#[ ;$I"@return [String, nil];T;%0;"@{8;&0;'F;(i ;[[I"
range;T0;"@{8o;
; I"
overload;F; 0;;W; 0; I"slice(regexp);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@{8;#[ ;$I"@return [String, nil];T;%0;"@{8;&0;'F;(i ;[[I" regexp;T0;"@{8o;
; I"
overload;F; 0;;W; 0; I"slice(regexp, capture);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@{8;#[ ;$I"@return [String, nil];T;%0;"@{8;&0;'F;(i ;[[I" regexp;T0[I" capture;T0;"@{8o;
; I"
overload;F; 0;;W; 0; I"slice(match_str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@{8;#[ ;$I"@return [String, nil];T;%0;"@{8;&0;'F;(i ;[[I"match_str;T0;"@{8;#[ ;$@+;%0;"@{8;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"=static VALUE
rb_str_aref_m(int argc, VALUE *argv, VALUE str)
{
if (argc == 2) {
if (RB_TYPE_P(argv[0], T_REGEXP)) {
return rb_str_subpat(str, argv[0], argv[1]);
}
return rb_str_substr(str, NUM2LONG(argv[0]), NUM2LONG(argv[1]));
}
rb_check_arity(argc, 1, 2);
return rb_str_aref(str, argv[0]);
};T;0To;
; F; ;
;;;I"String#slice!;F;[[@0;[[@)i;T;: slice!;0;[ ;{ ;IC;")Deletes the specified portion from str, and returns the portion
deleted.
string = "this is a string"
string.slice!(2) #=> "i"
string.slice!(3..6) #=> " is "
string.slice!(/s.*t/) #=> "sa st"
string.slice!("r") #=> "r"
string #=> "thing"
;T;[
o;
; I"
overload;F; 0;;; 0; I"slice!(fixnum);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@Q9;#[ ;$I"@return [String, nil];T;%0;"@Q9;&0;'F;(i ;[[I" fixnum;T0;"@Q9o;
; I"
overload;F; 0;;; 0; I"slice!(fixnum, fixnum);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@Q9;#[ ;$I"@return [String, nil];T;%0;"@Q9;&0;'F;(i ;[[I" fixnum;T0[I" fixnum;T0;"@Q9o;
; I"
overload;F; 0;;; 0; I"slice!(range);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@Q9;#[ ;$I"@return [String, nil];T;%0;"@Q9;&0;'F;(i ;[[I"
range;T0;"@Q9o;
; I"
overload;F; 0;;; 0; I"slice!(regexp);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@Q9;#[ ;$I"@return [String, nil];T;%0;"@Q9;&0;'F;(i ;[[I" regexp;T0;"@Q9o;
; I"
overload;F; 0;;; 0; I"slice!(other_str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@Q9;#[ ;$I"@return [String, nil];T;%0;"@Q9;&0;'F;(i ;[[I"other_str;T0;"@Q9;#[ ;$I"*Deletes the specified portion from str, and returns the portion
deleted.
string = "this is a string"
string.slice!(2) #=> "i"
string.slice!(3..6) #=> " is "
string.slice!(/s.*t/) #=> "sa st"
string.slice!("r") #=> "r"
string #=> "thing"
@overload slice!(fixnum)
@return [String, nil]
@overload slice!(fixnum, fixnum)
@return [String, nil]
@overload slice!(range)
@return [String, nil]
@overload slice!(regexp)
@return [String, nil]
@overload slice!(other_str)
@return [String, nil];T;%0;"@Q9;'F;)o;*;+T;,i;-i;.@(; I"static VALUE;T;/I"static VALUE
rb_str_slice_bang(int argc, VALUE *argv, VALUE str)
{
VALUE result;
VALUE buf[3];
int i;
rb_check_arity(argc, 1, 2);
for (i=0; isep or pattern (regexp) in the string
and returns the part before it, the match, and the part
after it.
If it is not found, returns two empty strings and str.
"hello".partition("l") #=> ["he", "l", "lo"]
"hello".partition("x") #=> ["hello", "", ""]
"hello".partition(/.l/) #=> ["h", "el", "lo"]
;T;[o;
; I"
overload;F; 0;;; 0; I"partition(sep);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@9;#[ ;$I"@return [Array];T;%0;"@9;&0;'F;(i ;[[I"sep;T0;"@9o;
; I"
overload;F; 0;;; 0; I"partition(regexp);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@9;#[ ;$I"@return [Array];T;%0;"@9;&0;'F;(i ;[[I" regexp;T0;"@9;#[ ;$I"Searches sep or pattern (regexp) in the string
and returns the part before it, the match, and the part
after it.
If it is not found, returns two empty strings and str.
"hello".partition("l") #=> ["he", "l", "lo"]
"hello".partition("x") #=> ["hello", "", ""]
"hello".partition(/.l/) #=> ["h", "el", "lo"]
@overload partition(sep)
@return [Array]
@overload partition(regexp)
@return [Array];T;%0;"@9;'F;)o;*;+T;,i ;-i ;.@(; I"static VALUE;T;/I"}static VALUE
rb_str_partition(VALUE str, VALUE sep)
{
long pos;
sep = get_pat_quoted(sep, 0);
if (RB_TYPE_P(sep, T_REGEXP)) {
pos = rb_reg_search(sep, str, 0, 0);
if (pos < 0) {
failed:
return rb_ary_new3(3, str, str_new_empty(str), str_new_empty(str));
}
sep = rb_str_subpat(str, sep, INT2FIX(0));
if (pos == 0 && RSTRING_LEN(sep) == 0) goto failed;
}
else {
pos = rb_str_index(str, sep, 0);
if (pos < 0) goto failed;
}
return rb_ary_new3(3, rb_str_subseq(str, 0, pos),
sep,
rb_str_subseq(str, pos+RSTRING_LEN(sep),
RSTRING_LEN(str)-pos-RSTRING_LEN(sep)));
};T;0To;
; F; ;
;;;I"String#rpartition;F;[[I"sep;T0;[[@)i!;T;:rpartition;0;[ ;{ ;IC;"Searches sep or pattern (regexp) in the string from the end
of the string, and returns the part before it, the match, and the part
after it.
If it is not found, returns two empty strings and str.
"hello".rpartition("l") #=> ["hel", "l", "o"]
"hello".rpartition("x") #=> ["", "", "hello"]
"hello".rpartition(/.l/) #=> ["he", "ll", "o"]
;T;[o;
; I"
overload;F; 0;;; 0; I"rpartition(sep);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@9;#[ ;$I"@return [Array];T;%0;"@9;&0;'F;(i ;[[I"sep;T0;"@9o;
; I"
overload;F; 0;;; 0; I"rpartition(regexp);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@9;#[ ;$I"@return [Array];T;%0;"@9;&0;'F;(i ;[[I" regexp;T0;"@9;#[ ;$I"Searches sep or pattern (regexp) in the string from the end
of the string, and returns the part before it, the match, and the part
after it.
If it is not found, returns two empty strings and str.
"hello".rpartition("l") #=> ["hel", "l", "o"]
"hello".rpartition("x") #=> ["", "", "hello"]
"hello".rpartition(/.l/) #=> ["he", "ll", "o"]
@overload rpartition(sep)
@return [Array]
@overload rpartition(regexp)
@return [Array];T;%0;"@9;'F;)o;*;+T;,i !;-i!;.@(; I"static VALUE;T;/I"Nstatic VALUE
rb_str_rpartition(VALUE str, VALUE sep)
{
long pos = RSTRING_LEN(str);
int regex = FALSE;
if (RB_TYPE_P(sep, T_REGEXP)) {
pos = rb_reg_search(sep, str, pos, 1);
regex = TRUE;
}
else {
VALUE tmp;
tmp = rb_check_string_type(sep);
if (NIL_P(tmp)) {
rb_raise(rb_eTypeError, "type mismatch: %s given",
rb_obj_classname(sep));
}
sep = tmp;
pos = rb_str_sublen(str, pos);
pos = rb_str_rindex(str, sep, pos);
}
if (pos < 0) {
return rb_ary_new3(3, str_new_empty(str), str_new_empty(str), str);
}
if (regex) {
sep = rb_reg_nth_match(0, rb_backref_get());
}
else {
pos = rb_str_offset(str, pos);
}
return rb_ary_new3(3, rb_str_subseq(str, 0, pos),
sep,
rb_str_subseq(str, pos+RSTRING_LEN(sep),
RSTRING_LEN(str)-pos-RSTRING_LEN(sep)));
};T;0To;
; F; ;
;;;I"String#encoding;F;[ ;[[I"encoding.c;Ti;T;:
encoding;0;[ ;{ ;IC;"EReturns the Encoding object that represents the encoding of obj.
;T;[o;
; I"
overload;F; 0;;; 0; I"
encoding;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Encoding;T;"@:;#[ ;$I"@return [Encoding];T;%0;"@:;&0;'F;(i ;[ ;"@:;#[ ;$I"oReturns the Encoding object that represents the encoding of obj.
@overload encoding
@return [Encoding];T;%0;"@:;'F;)o;*;+T;,i;-i;.@(; I"
VALUE;T;/I"VALUE
rb_obj_encoding(VALUE obj)
{
int idx = rb_enc_get_index(obj);
if (idx < 0) {
rb_raise(rb_eTypeError, "unknown encoding");
}
return rb_enc_from_encoding_index(idx & ENC_INDEX_MASK);
};T;0To;
; F; ;
;;;I"String#force_encoding;F;[[I"enc;T0;[[@)i!;T;:force_encoding;0;[ ;{ ;IC;"9Changes the encoding to +encoding+ and returns self.
;T;[o;
; I"
overload;F; 0;;; 0; I" force_encoding(encoding);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@*:;#[ ;$I"@return [String];T;%0;"@*:;&0;'F;(i ;[[I"
encoding;T0;"@*:;#[ ;$I"qChanges the encoding to +encoding+ and returns self.
@overload force_encoding(encoding)
@return [String];T;%0;"@*:;'F;)o;*;+T;,i!;-i!;.@(; I"static VALUE;T;/I"static VALUE
rb_str_force_encoding(VALUE str, VALUE enc)
{
str_modifiable(str);
rb_enc_associate(str, rb_to_encoding(enc));
ENC_CODERANGE_CLEAR(str);
return str;
};T;0To;
; F; ;
;;;I"
String#b;F;[ ;[[@)i!;T;:b;0;[ ;{ ;IC;":Returns a copied string whose encoding is ASCII-8BIT.
;T;[o;
; I"
overload;F; 0;;; 0; I"b;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@I:;#[ ;$I"@return [String];T;%0;"@I:;&0;'F;(i ;[ ;"@I:;#[ ;$I"[Returns a copied string whose encoding is ASCII-8BIT.
@overload b
@return [String];T;%0;"@I:;'F;)o;*;+T;,i!;-i!;.@(; I"static VALUE;T;/I"static VALUE
rb_str_b(VALUE str)
{
VALUE str2 = str_alloc(rb_cString);
str_replace_shared_without_enc(str2, str);
OBJ_INFECT_RAW(str2, str);
ENC_CODERANGE_CLEAR(str2);
return str2;
};T;0To;
; F; ;
;;;I"String#valid_encoding?;F;[ ;[[@)i!;T;:valid_encoding?;0;[ ;{ ;IC;"Returns true for a string which encoded correctly.
"\xc2\xa1".force_encoding("UTF-8").valid_encoding? #=> true
"\xc2".force_encoding("UTF-8").valid_encoding? #=> false
"\x80".force_encoding("UTF-8").valid_encoding? #=> false
;T;[o;
; I"
overload;F; 0;;; 0; I"valid_encoding?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@d:;#[ ;$I"@return [Boolean];T;%0;"@d:;&0;'F;(i ;[ ;"@d:o;!
; I" return;F; @;0; [@;"@d:;#[ ;$I""Returns true for a string which encoded correctly.
"\xc2\xa1".force_encoding("UTF-8").valid_encoding? #=> true
"\xc2".force_encoding("UTF-8").valid_encoding? #=> false
"\x80".force_encoding("UTF-8").valid_encoding? #=> false
@overload valid_encoding?
@return [Boolean];T;%0;"@d:;'F;)o;*;+T;,i!;-i!;.@(; I"static VALUE;T;/I"static VALUE
rb_str_valid_encoding_p(VALUE str)
{
int cr = rb_enc_str_coderange(str);
return cr == ENC_CODERANGE_BROKEN ? Qfalse : Qtrue;
};T;0To;
; F; ;
;;;I"String#ascii_only?;F;[ ;[[@)i!;T;:ascii_only?;0;[ ;{ ;IC;"Returns true for a string which has only ASCII characters.
"abc".force_encoding("UTF-8").ascii_only? #=> true
"abc\u{6666}".force_encoding("UTF-8").ascii_only? #=> false
;T;[o;
; I"
overload;F; 0;;; 0; I"ascii_only?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@:;#[ ;$I"@return [Boolean];T;%0;"@:;&0;'F;(i ;[ ;"@:o;!
; I" return;F; @;0; [@;"@:;#[ ;$I"Returns true for a string which has only ASCII characters.
"abc".force_encoding("UTF-8").ascii_only? #=> true
"abc\u{6666}".force_encoding("UTF-8").ascii_only? #=> false
@overload ascii_only?
@return [Boolean];T;%0;"@:;'F;)o;*;+T;,i!;-i!;.@(; I"static VALUE;T;/I"static VALUE
rb_str_is_ascii_only_p(VALUE str)
{
int cr = rb_enc_str_coderange(str);
return cr == ENC_CODERANGE_7BIT ? Qtrue : Qfalse;
};T;0To;
; F; ;
;;;I"String#encode;F;[[@0;[[I"transcode.c;Ti; ;T;: encode;0;[ ;{ ;IC;"The first form returns a copy of +str+ transcoded
to encoding +encoding+.
The second form returns a copy of +str+ transcoded
from src_encoding to dst_encoding.
The last form returns a copy of +str+ transcoded to
Encoding.default_internal.
By default, the first and second form raise
Encoding::UndefinedConversionError for characters that are
undefined in the destination encoding, and
Encoding::InvalidByteSequenceError for invalid byte sequences
in the source encoding. The last form by default does not raise
exceptions but uses replacement strings.
The +options+ Hash gives details for conversion and can have the following
keys:
:invalid ::
If the value is +:replace+, #encode replaces invalid byte sequences in
+str+ with the replacement character. The default is to raise the
Encoding::InvalidByteSequenceError exception
:undef ::
If the value is +:replace+, #encode replaces characters which are
undefined in the destination encoding with the replacement character.
The default is to raise the Encoding::UndefinedConversionError.
:replace ::
Sets the replacement string to the given value. The default replacement
string is "\uFFFD" for Unicode encoding forms, and "?" otherwise.
:fallback ::
Sets the replacement string by the given object for undefined
character. The object should be a Hash, a Proc, a Method, or an
object which has [] method.
Its key is an undefined character encoded in the source encoding
of current transcoder. Its value can be any encoding until it
can be converted into the destination encoding of the transcoder.
:xml ::
The value must be +:text+ or +:attr+.
If the value is +:text+ #encode replaces undefined characters with their
(upper-case hexadecimal) numeric character references. '&', '<', and '>'
are converted to "&", "<", and ">", respectively.
If the value is +:attr+, #encode also quotes the replacement result
(using '"'), and replaces '"' with """.
:cr_newline ::
Replaces LF ("\n") with CR ("\r") if value is true.
:crlf_newline ::
Replaces LF ("\n") with CRLF ("\r\n") if value is true.
:universal_newline ::
Replaces CRLF ("\r\n") and CR ("\r") with LF ("\n") if value is true.
;T;[o;
; I"
overload;F; 0;;; 0; I""encode(encoding [, options] );T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@:;#[ ;$I"@return [String];T;%0;"@:;&0;'F;(i ;[[I"encoding[, options];T0;"@:o;
; I"
overload;F; 0;;; 0; I"4encode(dst_encoding, src_encoding [, options] );T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@:;#[ ;$I"@return [String];T;%0;"@:;&0;'F;(i ;[[I"dst_encoding;T0[I" src_encoding[, options];T0;"@:o;
; I"
overload;F; 0;;; 0; I"encode([options]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@:;#[ ;$I"@return [String];T;%0;"@:;&0;'F;(i ;[[I"[options];T0;"@:;#[ ;$I"T The first form returns a copy of +str+ transcoded
to encoding +encoding+.
The second form returns a copy of +str+ transcoded
from src_encoding to dst_encoding.
The last form returns a copy of +str+ transcoded to
Encoding.default_internal.
By default, the first and second form raise
Encoding::UndefinedConversionError for characters that are
undefined in the destination encoding, and
Encoding::InvalidByteSequenceError for invalid byte sequences
in the source encoding. The last form by default does not raise
exceptions but uses replacement strings.
The +options+ Hash gives details for conversion and can have the following
keys:
:invalid ::
If the value is +:replace+, #encode replaces invalid byte sequences in
+str+ with the replacement character. The default is to raise the
Encoding::InvalidByteSequenceError exception
:undef ::
If the value is +:replace+, #encode replaces characters which are
undefined in the destination encoding with the replacement character.
The default is to raise the Encoding::UndefinedConversionError.
:replace ::
Sets the replacement string to the given value. The default replacement
string is "\uFFFD" for Unicode encoding forms, and "?" otherwise.
:fallback ::
Sets the replacement string by the given object for undefined
character. The object should be a Hash, a Proc, a Method, or an
object which has [] method.
Its key is an undefined character encoded in the source encoding
of current transcoder. Its value can be any encoding until it
can be converted into the destination encoding of the transcoder.
:xml ::
The value must be +:text+ or +:attr+.
If the value is +:text+ #encode replaces undefined characters with their
(upper-case hexadecimal) numeric character references. '&', '<', and '>'
are converted to "&", "<", and ">", respectively.
If the value is +:attr+, #encode also quotes the replacement result
(using '"'), and replaces '"' with """.
:cr_newline ::
Replaces LF ("\n") with CR ("\r") if value is true.
:crlf_newline ::
Replaces LF ("\n") with CRLF ("\r\n") if value is true.
:universal_newline ::
Replaces CRLF ("\r\n") and CR ("\r") with LF ("\n") if value is true.
@overload encode(encoding [, options] )
@return [String]
@overload encode(dst_encoding, src_encoding [, options] )
@return [String]
@overload encode([options])
@return [String];T;%0;"@:;'F;)o;*;+T;,i ;-i: ;.@(; I"static VALUE;T;/I"static VALUE
str_encode(int argc, VALUE *argv, VALUE str)
{
VALUE newstr = str;
int encidx = str_transcode(argc, argv, &newstr);
return encoded_dup(newstr, str, encidx);
};T;0To;
; F; ;
;;;I"String#encode!;F;[[@0;[[@:i
;T;: encode!;0;[ ;{ ;IC;"-The first form transcodes the contents of str from
str.encoding to +encoding+.
The second form transcodes the contents of str from
src_encoding to dst_encoding.
The options Hash gives details for conversion. See String#encode
for details.
Returns the string even if no changes were made.
;T;[o;
; I"
overload;F; 0;;; 0; I"#encode!(encoding [, options] );T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@:;#[ ;$I"@return [String];T;%0;"@:;&0;'F;(i ;[[I"encoding[, options];T0;"@:o;
; I"
overload;F; 0;;; 0; I"5encode!(dst_encoding, src_encoding [, options] );T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@:;#[ ;$I"@return [String];T;%0;"@:;&0;'F;(i ;[[I"dst_encoding;T0[I" src_encoding[, options];T0;"@:;#[ ;$I"The first form transcodes the contents of str from
str.encoding to +encoding+.
The second form transcodes the contents of str from
src_encoding to dst_encoding.
The options Hash gives details for conversion. See String#encode
for details.
Returns the string even if no changes were made.
@overload encode!(encoding [, options] )
@return [String]
@overload encode!(dst_encoding, src_encoding [, options] )
@return [String];T;%0;"@:;'F;)o;*;+T;,i
;-i
;.@(; I"static VALUE;T;/I"static VALUE
str_encode_bang(int argc, VALUE *argv, VALUE str)
{
VALUE newstr;
int encidx;
rb_check_frozen(str);
newstr = str;
encidx = str_transcode(argc, argv, &newstr);
if (encidx < 0) return str;
if (newstr == str) {
rb_enc_associate_index(str, encidx);
return str;
}
rb_str_shared_replace(str, newstr);
return str_encode_associate(str, encidx);
};T;0To;
; F; ;
;;;I"String#unpack;F;[[I"fmt;T0;[[I" pack.c;Ti|;T;: unpack;0;[ ;{ ;IC;"Decodes str (which may contain binary data) according to the
format string, returning an array of each value extracted. The
format string consists of a sequence of single-character directives,
summarized in the table at the end of this entry.
Each directive may be followed
by a number, indicating the number of times to repeat with this
directive. An asterisk (``*'') will use up all
remaining elements. The directives sSiIlL may each be
followed by an underscore (``_'') or
exclamation mark (``!'') to use the underlying
platform's native size for the specified type; otherwise, it uses a
platform-independent consistent size. Spaces are ignored in the
format string. See also Array#pack.
"abc \0\0abc \0\0".unpack('A6Z6') #=> ["abc", "abc "]
"abc \0\0".unpack('a3a3') #=> ["abc", " \000\000"]
"abc \0abc \0".unpack('Z*Z*') #=> ["abc ", "abc "]
"aa".unpack('b8B8') #=> ["10000110", "01100001"]
"aaa".unpack('h2H2c') #=> ["16", "61", 97]
"\xfe\xff\xfe\xff".unpack('sS') #=> [-2, 65534]
"now=20is".unpack('M*') #=> ["now is"]
"whole".unpack('xax2aX2aX1aX2a') #=> ["h", "e", "l", "l", "o"]
This table summarizes the various formats and the Ruby classes
returned by each.
Integer | |
Directive | Returns | Meaning
-----------------------------------------------------------------
C | Integer | 8-bit unsigned (unsigned char)
S | Integer | 16-bit unsigned, native endian (uint16_t)
L | Integer | 32-bit unsigned, native endian (uint32_t)
Q | Integer | 64-bit unsigned, native endian (uint64_t)
| |
c | Integer | 8-bit signed (signed char)
s | Integer | 16-bit signed, native endian (int16_t)
l | Integer | 32-bit signed, native endian (int32_t)
q | Integer | 64-bit signed, native endian (int64_t)
| |
S_, S! | Integer | unsigned short, native endian
I, I_, I! | Integer | unsigned int, native endian
L_, L! | Integer | unsigned long, native endian
Q_, Q! | Integer | unsigned long long, native endian (ArgumentError
| | if the platform has no long long type.)
| | (Q_ and Q! is available since Ruby 2.1.)
| |
s_, s! | Integer | signed short, native endian
i, i_, i! | Integer | signed int, native endian
l_, l! | Integer | signed long, native endian
q_, q! | Integer | signed long long, native endian (ArgumentError
| | if the platform has no long long type.)
| | (q_ and q! is available since Ruby 2.1.)
| |
S> L> Q> | Integer | same as the directives without ">" except
s> l> q> | | big endian
S!> I!> | | (available since Ruby 1.9.3)
L!> Q!> | | "S>" is same as "n"
s!> i!> | | "L>" is same as "N"
l!> q!> | |
| |
S< L< Q< | Integer | same as the directives without "<" except
s< l< q< | | little endian
S!< I!< | | (available since Ruby 1.9.3)
L!< Q!< | | "S<" is same as "v"
s!< i!< | | "L<" is same as "V"
l!< q!< | |
| |
n | Integer | 16-bit unsigned, network (big-endian) byte order
N | Integer | 32-bit unsigned, network (big-endian) byte order
v | Integer | 16-bit unsigned, VAX (little-endian) byte order
V | Integer | 32-bit unsigned, VAX (little-endian) byte order
| |
U | Integer | UTF-8 character
w | Integer | BER-compressed integer (see Array.pack)
Float | |
Directive | Returns | Meaning
-----------------------------------------------------------------
D, d | Float | double-precision, native format
F, f | Float | single-precision, native format
E | Float | double-precision, little-endian byte order
e | Float | single-precision, little-endian byte order
G | Float | double-precision, network (big-endian) byte order
g | Float | single-precision, network (big-endian) byte order
String | |
Directive | Returns | Meaning
-----------------------------------------------------------------
A | String | arbitrary binary string (remove trailing nulls and ASCII spaces)
a | String | arbitrary binary string
Z | String | null-terminated string
B | String | bit string (MSB first)
b | String | bit string (LSB first)
H | String | hex string (high nibble first)
h | String | hex string (low nibble first)
u | String | UU-encoded string
M | String | quoted-printable, MIME encoding (see RFC2045)
m | String | base64 encoded string (RFC 2045) (default)
| | base64 encoded string (RFC 4648) if followed by 0
P | String | pointer to a structure (fixed-length string)
p | String | pointer to a null-terminated string
Misc. | |
Directive | Returns | Meaning
-----------------------------------------------------------------
@ | --- | skip to the offset given by the length argument
X | --- | skip backward one byte
x | --- | skip forward one byte
;T;[o;
; I"
overload;F; 0;;; 0; I"unpack(format);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@;;#[ ;$I"@return [Array];T;%0;"@;;&0;'F;(i ;[[I" format;T0;"@;;#[ ;$I"Decodes str (which may contain binary data) according to the
format string, returning an array of each value extracted. The
format string consists of a sequence of single-character directives,
summarized in the table at the end of this entry.
Each directive may be followed
by a number, indicating the number of times to repeat with this
directive. An asterisk (``*'') will use up all
remaining elements. The directives sSiIlL may each be
followed by an underscore (``_'') or
exclamation mark (``!'') to use the underlying
platform's native size for the specified type; otherwise, it uses a
platform-independent consistent size. Spaces are ignored in the
format string. See also Array#pack.
"abc \0\0abc \0\0".unpack('A6Z6') #=> ["abc", "abc "]
"abc \0\0".unpack('a3a3') #=> ["abc", " \000\000"]
"abc \0abc \0".unpack('Z*Z*') #=> ["abc ", "abc "]
"aa".unpack('b8B8') #=> ["10000110", "01100001"]
"aaa".unpack('h2H2c') #=> ["16", "61", 97]
"\xfe\xff\xfe\xff".unpack('sS') #=> [-2, 65534]
"now=20is".unpack('M*') #=> ["now is"]
"whole".unpack('xax2aX2aX1aX2a') #=> ["h", "e", "l", "l", "o"]
This table summarizes the various formats and the Ruby classes
returned by each.
Integer | |
Directive | Returns | Meaning
-----------------------------------------------------------------
C | Integer | 8-bit unsigned (unsigned char)
S | Integer | 16-bit unsigned, native endian (uint16_t)
L | Integer | 32-bit unsigned, native endian (uint32_t)
Q | Integer | 64-bit unsigned, native endian (uint64_t)
| |
c | Integer | 8-bit signed (signed char)
s | Integer | 16-bit signed, native endian (int16_t)
l | Integer | 32-bit signed, native endian (int32_t)
q | Integer | 64-bit signed, native endian (int64_t)
| |
S_, S! | Integer | unsigned short, native endian
I, I_, I! | Integer | unsigned int, native endian
L_, L! | Integer | unsigned long, native endian
Q_, Q! | Integer | unsigned long long, native endian (ArgumentError
| | if the platform has no long long type.)
| | (Q_ and Q! is available since Ruby 2.1.)
| |
s_, s! | Integer | signed short, native endian
i, i_, i! | Integer | signed int, native endian
l_, l! | Integer | signed long, native endian
q_, q! | Integer | signed long long, native endian (ArgumentError
| | if the platform has no long long type.)
| | (q_ and q! is available since Ruby 2.1.)
| |
S> L> Q> | Integer | same as the directives without ">" except
s> l> q> | | big endian
S!> I!> | | (available since Ruby 1.9.3)
L!> Q!> | | "S>" is same as "n"
s!> i!> | | "L>" is same as "N"
l!> q!> | |
| |
S< L< Q< | Integer | same as the directives without "<" except
s< l< q< | | little endian
S!< I!< | | (available since Ruby 1.9.3)
L!< Q!< | | "S<" is same as "v"
s!< i!< | | "L<" is same as "V"
l!< q!< | |
| |
n | Integer | 16-bit unsigned, network (big-endian) byte order
N | Integer | 32-bit unsigned, network (big-endian) byte order
v | Integer | 16-bit unsigned, VAX (little-endian) byte order
V | Integer | 32-bit unsigned, VAX (little-endian) byte order
| |
U | Integer | UTF-8 character
w | Integer | BER-compressed integer (see Array.pack)
Float | |
Directive | Returns | Meaning
-----------------------------------------------------------------
D, d | Float | double-precision, native format
F, f | Float | single-precision, native format
E | Float | double-precision, little-endian byte order
e | Float | single-precision, little-endian byte order
G | Float | double-precision, network (big-endian) byte order
g | Float | single-precision, network (big-endian) byte order
String | |
Directive | Returns | Meaning
-----------------------------------------------------------------
A | String | arbitrary binary string (remove trailing nulls and ASCII spaces)
a | String | arbitrary binary string
Z | String | null-terminated string
B | String | bit string (MSB first)
b | String | bit string (LSB first)
H | String | hex string (high nibble first)
h | String | hex string (low nibble first)
u | String | UU-encoded string
M | String | quoted-printable, MIME encoding (see RFC2045)
m | String | base64 encoded string (RFC 2045) (default)
| | base64 encoded string (RFC 4648) if followed by 0
P | String | pointer to a structure (fixed-length string)
p | String | pointer to a null-terminated string
Misc. | |
Directive | Returns | Meaning
-----------------------------------------------------------------
@ | --- | skip to the offset given by the length argument
X | --- | skip backward one byte
x | --- | skip forward one byte
@overload unpack(format)
@return [Array];T;%0;"@;;'F;)o;*;+T;,i
;-iy;.@(; I"static VALUE;T;/I"=static VALUE
pack_unpack(VALUE str, VALUE fmt)
{
#define hexdigits ruby_hexdigits
char *s, *send;
char *p, *pend;
VALUE ary;
char type;
long len;
AVOID_CC_BUG long tmp_len;
int star;
#ifdef NATINT_PACK
int natint; /* native integer */
#endif
int block_p = rb_block_given_p();
int signed_p, integer_size, bigendian_p;
#define UNPACK_PUSH(item) do {\
VALUE item_val = (item);\
if (block_p) {\
rb_yield(item_val);\
}\
else {\
rb_ary_push(ary, item_val);\
}\
} while (0)
StringValue(str);
StringValue(fmt);
s = RSTRING_PTR(str);
send = s + RSTRING_LEN(str);
p = RSTRING_PTR(fmt);
pend = p + RSTRING_LEN(fmt);
ary = block_p ? Qnil : rb_ary_new();
while (p < pend) {
int explicit_endian = 0;
type = *p++;
#ifdef NATINT_PACK
natint = 0;
#endif
if (ISSPACE(type)) continue;
if (type == '#') {
while ((p < pend) && (*p != '\n')) {
p++;
}
continue;
}
star = 0;
{
modifiers:
switch (*p) {
case '_':
case '!':
if (strchr(natstr, type)) {
#ifdef NATINT_PACK
natint = 1;
#endif
p++;
}
else {
rb_raise(rb_eArgError, "'%c' allowed only after types %s", *p, natstr);
}
goto modifiers;
case '<':
case '>':
if (!strchr(endstr, type)) {
rb_raise(rb_eArgError, "'%c' allowed only after types %s", *p, endstr);
}
if (explicit_endian) {
rb_raise(rb_eRangeError, "Can't use both '<' and '>'");
}
explicit_endian = *p++;
goto modifiers;
}
}
if (p >= pend)
len = 1;
else if (*p == '*') {
star = 1;
len = send - s;
p++;
}
else if (ISDIGIT(*p)) {
errno = 0;
len = STRTOUL(p, (char**)&p, 10);
if (errno) {
rb_raise(rb_eRangeError, "pack length too big");
}
}
else {
len = (type != '@');
}
switch (type) {
case '%':
rb_raise(rb_eArgError, "%% is not supported");
break;
case 'A':
if (len > send - s) len = send - s;
{
long end = len;
char *t = s + len - 1;
while (t >= s) {
if (*t != ' ' && *t != '\0') break;
t--; len--;
}
UNPACK_PUSH(infected_str_new(s, len, str));
s += end;
}
break;
case 'Z':
{
char *t = s;
if (len > send-s) len = send-s;
while (t < s+len && *t) t++;
UNPACK_PUSH(infected_str_new(s, t-s, str));
if (t < send) t++;
s = star ? t : s+len;
}
break;
case 'a':
if (len > send - s) len = send - s;
UNPACK_PUSH(infected_str_new(s, len, str));
s += len;
break;
case 'b':
{
VALUE bitstr;
char *t;
int bits;
long i;
if (p[-1] == '*' || len > (send - s) * 8)
len = (send - s) * 8;
bits = 0;
UNPACK_PUSH(bitstr = rb_usascii_str_new(0, len));
t = RSTRING_PTR(bitstr);
for (i=0; i>= 1;
else bits = (unsigned char)*s++;
*t++ = (bits & 1) ? '1' : '0';
}
}
break;
case 'B':
{
VALUE bitstr;
char *t;
int bits;
long i;
if (p[-1] == '*' || len > (send - s) * 8)
len = (send - s) * 8;
bits = 0;
UNPACK_PUSH(bitstr = rb_usascii_str_new(0, len));
t = RSTRING_PTR(bitstr);
for (i=0; i (send - s) * 2)
len = (send - s) * 2;
bits = 0;
UNPACK_PUSH(bitstr = rb_usascii_str_new(0, len));
t = RSTRING_PTR(bitstr);
for (i=0; i>= 4;
else
bits = (unsigned char)*s++;
*t++ = hexdigits[bits & 15];
}
}
break;
case 'H':
{
VALUE bitstr;
char *t;
int bits;
long i;
if (p[-1] == '*' || len > (send - s) * 2)
len = (send - s) * 2;
bits = 0;
UNPACK_PUSH(bitstr = rb_usascii_str_new(0, len));
t = RSTRING_PTR(bitstr);
for (i=0; i> 4) & 15];
}
}
break;
case 'c':
signed_p = 1;
integer_size = 1;
bigendian_p = BIGENDIAN_P(); /* not effective */
goto unpack_integer;
case 'C':
signed_p = 0;
integer_size = 1;
bigendian_p = BIGENDIAN_P(); /* not effective */
goto unpack_integer;
case 's':
signed_p = 1;
integer_size = NATINT_LEN(short, 2);
bigendian_p = BIGENDIAN_P();
goto unpack_integer;
case 'S':
signed_p = 0;
integer_size = NATINT_LEN(short, 2);
bigendian_p = BIGENDIAN_P();
goto unpack_integer;
case 'i':
signed_p = 1;
integer_size = (int)sizeof(int);
bigendian_p = BIGENDIAN_P();
goto unpack_integer;
case 'I':
signed_p = 0;
integer_size = (int)sizeof(int);
bigendian_p = BIGENDIAN_P();
goto unpack_integer;
case 'l':
signed_p = 1;
integer_size = NATINT_LEN(long, 4);
bigendian_p = BIGENDIAN_P();
goto unpack_integer;
case 'L':
signed_p = 0;
integer_size = NATINT_LEN(long, 4);
bigendian_p = BIGENDIAN_P();
goto unpack_integer;
case 'q':
signed_p = 1;
integer_size = NATINT_LEN_Q;
bigendian_p = BIGENDIAN_P();
goto unpack_integer;
case 'Q':
signed_p = 0;
integer_size = NATINT_LEN_Q;
bigendian_p = BIGENDIAN_P();
goto unpack_integer;
case 'j':
signed_p = 1;
integer_size = sizeof(intptr_t);
bigendian_p = BIGENDIAN_P();
goto unpack_integer;
case 'J':
signed_p = 0;
integer_size = sizeof(uintptr_t);
bigendian_p = BIGENDIAN_P();
goto unpack_integer;
case 'n':
signed_p = 0;
integer_size = 2;
bigendian_p = 1;
goto unpack_integer;
case 'N':
signed_p = 0;
integer_size = 4;
bigendian_p = 1;
goto unpack_integer;
case 'v':
signed_p = 0;
integer_size = 2;
bigendian_p = 0;
goto unpack_integer;
case 'V':
signed_p = 0;
integer_size = 4;
bigendian_p = 0;
goto unpack_integer;
unpack_integer:
if (explicit_endian) {
bigendian_p = explicit_endian == '>';
}
PACK_LENGTH_ADJUST_SIZE(integer_size);
while (len-- > 0) {
int flags = bigendian_p ? INTEGER_PACK_BIG_ENDIAN : INTEGER_PACK_LITTLE_ENDIAN;
VALUE val;
if (signed_p)
flags |= INTEGER_PACK_2COMP;
val = rb_integer_unpack(s, integer_size, 1, 0, flags);
UNPACK_PUSH(val);
s += integer_size;
}
PACK_ITEM_ADJUST();
break;
case 'f':
case 'F':
PACK_LENGTH_ADJUST_SIZE(sizeof(float));
while (len-- > 0) {
float tmp;
memcpy(&tmp, s, sizeof(float));
s += sizeof(float);
UNPACK_PUSH(DBL2NUM((double)tmp));
}
PACK_ITEM_ADJUST();
break;
case 'e':
PACK_LENGTH_ADJUST_SIZE(sizeof(float));
while (len-- > 0) {
FLOAT_CONVWITH(tmp);
memcpy(tmp.buf, s, sizeof(float));
s += sizeof(float);
VTOHF(tmp);
UNPACK_PUSH(DBL2NUM(tmp.f));
}
PACK_ITEM_ADJUST();
break;
case 'E':
PACK_LENGTH_ADJUST_SIZE(sizeof(double));
while (len-- > 0) {
DOUBLE_CONVWITH(tmp);
memcpy(tmp.buf, s, sizeof(double));
s += sizeof(double);
VTOHD(tmp);
UNPACK_PUSH(DBL2NUM(tmp.d));
}
PACK_ITEM_ADJUST();
break;
case 'D':
case 'd':
PACK_LENGTH_ADJUST_SIZE(sizeof(double));
while (len-- > 0) {
double tmp;
memcpy(&tmp, s, sizeof(double));
s += sizeof(double);
UNPACK_PUSH(DBL2NUM(tmp));
}
PACK_ITEM_ADJUST();
break;
case 'g':
PACK_LENGTH_ADJUST_SIZE(sizeof(float));
while (len-- > 0) {
FLOAT_CONVWITH(tmp);
memcpy(tmp.buf, s, sizeof(float));
s += sizeof(float);
NTOHF(tmp);
UNPACK_PUSH(DBL2NUM(tmp.f));
}
PACK_ITEM_ADJUST();
break;
case 'G':
PACK_LENGTH_ADJUST_SIZE(sizeof(double));
while (len-- > 0) {
DOUBLE_CONVWITH(tmp);
memcpy(tmp.buf, s, sizeof(double));
s += sizeof(double);
NTOHD(tmp);
UNPACK_PUSH(DBL2NUM(tmp.d));
}
PACK_ITEM_ADJUST();
break;
case 'U':
if (len > send - s) len = send - s;
while (len > 0 && s < send) {
long alen = send - s;
unsigned long l;
l = utf8_to_uv(s, &alen);
s += alen; len--;
UNPACK_PUSH(ULONG2NUM(l));
}
break;
case 'u':
{
VALUE buf = infected_str_new(0, (send - s)*3/4, str);
char *ptr = RSTRING_PTR(buf);
long total = 0;
while (s < send && (unsigned char)*s > ' ' && (unsigned char)*s < 'a') {
long a,b,c,d;
char hunk[3];
len = ((unsigned char)*s++ - ' ') & 077;
total += len;
if (total > RSTRING_LEN(buf)) {
len -= total - RSTRING_LEN(buf);
total = RSTRING_LEN(buf);
}
while (len > 0) {
long mlen = len > 3 ? 3 : len;
if (s < send && (unsigned char)*s >= ' ' && (unsigned char)*s < 'a')
a = ((unsigned char)*s++ - ' ') & 077;
else
a = 0;
if (s < send && (unsigned char)*s >= ' ' && (unsigned char)*s < 'a')
b = ((unsigned char)*s++ - ' ') & 077;
else
b = 0;
if (s < send && (unsigned char)*s >= ' ' && (unsigned char)*s < 'a')
c = ((unsigned char)*s++ - ' ') & 077;
else
c = 0;
if (s < send && (unsigned char)*s >= ' ' && (unsigned char)*s < 'a')
d = ((unsigned char)*s++ - ' ') & 077;
else
d = 0;
hunk[0] = (char)(a << 2 | b >> 4);
hunk[1] = (char)(b << 4 | c >> 2);
hunk[2] = (char)(c << 6 | d);
memcpy(ptr, hunk, mlen);
ptr += mlen;
len -= mlen;
}
if (s < send && (unsigned char)*s != '\r' && *s != '\n')
s++; /* possible checksum byte */
if (s < send && *s == '\r') s++;
if (s < send && *s == '\n') s++;
}
rb_str_set_len(buf, total);
UNPACK_PUSH(buf);
}
break;
case 'm':
{
VALUE buf = infected_str_new(0, (send - s + 3)*3/4, str); /* +3 is for skipping paddings */
char *ptr = RSTRING_PTR(buf);
int a = -1,b = -1,c = 0,d = 0;
static signed char b64_xtable[256];
if (b64_xtable['/'] <= 0) {
int i;
for (i = 0; i < 256; i++) {
b64_xtable[i] = -1;
}
for (i = 0; i < 64; i++) {
b64_xtable[(unsigned char)b64_table[i]] = (char)i;
}
}
if (len == 0) {
while (s < send) {
a = b = c = d = -1;
a = b64_xtable[(unsigned char)*s++];
if (s >= send || a == -1) rb_raise(rb_eArgError, "invalid base64");
b = b64_xtable[(unsigned char)*s++];
if (s >= send || b == -1) rb_raise(rb_eArgError, "invalid base64");
if (*s == '=') {
if (s + 2 == send && *(s + 1) == '=') break;
rb_raise(rb_eArgError, "invalid base64");
}
c = b64_xtable[(unsigned char)*s++];
if (s >= send || c == -1) rb_raise(rb_eArgError, "invalid base64");
if (s + 1 == send && *s == '=') break;
d = b64_xtable[(unsigned char)*s++];
if (d == -1) rb_raise(rb_eArgError, "invalid base64");
*ptr++ = castchar(a << 2 | b >> 4);
*ptr++ = castchar(b << 4 | c >> 2);
*ptr++ = castchar(c << 6 | d);
}
if (c == -1) {
*ptr++ = castchar(a << 2 | b >> 4);
if (b & 0xf) rb_raise(rb_eArgError, "invalid base64");
}
else if (d == -1) {
*ptr++ = castchar(a << 2 | b >> 4);
*ptr++ = castchar(b << 4 | c >> 2);
if (c & 0x3) rb_raise(rb_eArgError, "invalid base64");
}
}
else {
while (s < send) {
a = b = c = d = -1;
while ((a = b64_xtable[(unsigned char)*s]) == -1 && s < send) {s++;}
if (s >= send) break;
s++;
while ((b = b64_xtable[(unsigned char)*s]) == -1 && s < send) {s++;}
if (s >= send) break;
s++;
while ((c = b64_xtable[(unsigned char)*s]) == -1 && s < send) {if (*s == '=') break; s++;}
if (*s == '=' || s >= send) break;
s++;
while ((d = b64_xtable[(unsigned char)*s]) == -1 && s < send) {if (*s == '=') break; s++;}
if (*s == '=' || s >= send) break;
s++;
*ptr++ = castchar(a << 2 | b >> 4);
*ptr++ = castchar(b << 4 | c >> 2);
*ptr++ = castchar(c << 6 | d);
a = -1;
}
if (a != -1 && b != -1) {
if (c == -1)
*ptr++ = castchar(a << 2 | b >> 4);
else {
*ptr++ = castchar(a << 2 | b >> 4);
*ptr++ = castchar(b << 4 | c >> 2);
}
}
}
rb_str_set_len(buf, ptr - RSTRING_PTR(buf));
UNPACK_PUSH(buf);
}
break;
case 'M':
{
VALUE buf = infected_str_new(0, send - s, str);
char *ptr = RSTRING_PTR(buf), *ss = s;
int c1, c2;
while (s < send) {
if (*s == '=') {
if (++s == send) break;
if (s+1 < send && *s == '\r' && *(s+1) == '\n')
s++;
if (*s != '\n') {
if ((c1 = hex2num(*s)) == -1) break;
if (++s == send) break;
if ((c2 = hex2num(*s)) == -1) break;
*ptr++ = castchar(c1 << 4 | c2);
}
}
else {
*ptr++ = *s;
}
s++;
ss = s;
}
rb_str_set_len(buf, ptr - RSTRING_PTR(buf));
rb_str_buf_cat(buf, ss, send-ss);
ENCODING_CODERANGE_SET(buf, rb_ascii8bit_encindex(), ENC_CODERANGE_VALID);
UNPACK_PUSH(buf);
}
break;
case '@':
if (len > RSTRING_LEN(str))
rb_raise(rb_eArgError, "@ outside of string");
s = RSTRING_PTR(str) + len;
break;
case 'X':
if (len > s - RSTRING_PTR(str))
rb_raise(rb_eArgError, "X outside of string");
s -= len;
break;
case 'x':
if (len > send - s)
rb_raise(rb_eArgError, "x outside of string");
s += len;
break;
case 'P':
if (sizeof(char *) <= (size_t)(send - s)) {
VALUE tmp = Qnil;
char *t;
memcpy(&t, s, sizeof(char *));
s += sizeof(char *);
if (t) {
VALUE a;
const VALUE *p, *pend;
if (!(a = str_associated(str))) {
rb_raise(rb_eArgError, "no associated pointer");
}
p = RARRAY_CONST_PTR(a);
pend = p + RARRAY_LEN(a);
while (p < pend) {
if (RB_TYPE_P(*p, T_STRING) && RSTRING_PTR(*p) == t) {
if (len < RSTRING_LEN(*p)) {
tmp = rb_tainted_str_new(t, len);
str_associate(tmp, a);
}
else {
tmp = *p;
}
break;
}
p++;
}
if (p == pend) {
rb_raise(rb_eArgError, "non associated pointer");
}
}
UNPACK_PUSH(tmp);
}
break;
case 'p':
if (len > (long)((send - s) / sizeof(char *)))
len = (send - s) / sizeof(char *);
while (len-- > 0) {
if ((size_t)(send - s) < sizeof(char *))
break;
else {
VALUE tmp = Qnil;
char *t;
memcpy(&t, s, sizeof(char *));
s += sizeof(char *);
if (t) {
VALUE a;
const VALUE *p, *pend;
if (!(a = str_associated(str))) {
rb_raise(rb_eArgError, "no associated pointer");
}
p = RARRAY_CONST_PTR(a);
pend = p + RARRAY_LEN(a);
while (p < pend) {
if (RB_TYPE_P(*p, T_STRING) && RSTRING_PTR(*p) == t) {
tmp = *p;
break;
}
p++;
}
if (p == pend) {
rb_raise(rb_eArgError, "non associated pointer");
}
}
UNPACK_PUSH(tmp);
}
}
break;
case 'w':
{
char *s0 = s;
while (len > 0 && s < send) {
if (*s & 0x80) {
s++;
}
else {
s++;
UNPACK_PUSH(rb_integer_unpack(s0, s-s0, 1, 1, INTEGER_PACK_BIG_ENDIAN));
len--;
s0 = s;
}
}
}
break;
default:
rb_warning("unknown unpack directive '%c' in '%s'",
type, RSTRING_PTR(fmt));
break;
}
}
return ary;
};T;0To;
; F; ;
;;;I"String#to_c;F;[ ;[[@iV;T;;;0;[ ;{ ;IC;"sReturns a complex which denotes the string form. The parser
ignores leading whitespaces and trailing garbage. Any digit
sequences can be separated by an underscore. Returns zero for null
or garbage string.
'9'.to_c #=> (9+0i)
'2.5'.to_c #=> (2.5+0i)
'2.5/1'.to_c #=> ((5/2)+0i)
'-3/2'.to_c #=> ((-3/2)+0i)
'-i'.to_c #=> (0-1i)
'45i'.to_c #=> (0+45i)
'3-4i'.to_c #=> (3-4i)
'-4e2-4e-2i'.to_c #=> (-400.0-0.04i)
'-0.0-0.0i'.to_c #=> (-0.0-0.0i)
'1/2+3/4i'.to_c #=> ((1/2)+(3/4)*i)
'ruby'.to_c #=> (0+0i)
See Kernel.Complex.
;T;[o;
; I"
overload;F; 0;;; 0; I" to_c;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@.;;&0;'F;(i ;[ ;"@.;;#[ ;$I"Returns a complex which denotes the string form. The parser
ignores leading whitespaces and trailing garbage. Any digit
sequences can be separated by an underscore. Returns zero for null
or garbage string.
'9'.to_c #=> (9+0i)
'2.5'.to_c #=> (2.5+0i)
'2.5/1'.to_c #=> ((5/2)+0i)
'-3/2'.to_c #=> ((-3/2)+0i)
'-i'.to_c #=> (0-1i)
'45i'.to_c #=> (0+45i)
'3-4i'.to_c #=> (3-4i)
'-4e2-4e-2i'.to_c #=> (-400.0-0.04i)
'-0.0-0.0i'.to_c #=> (-0.0-0.0i)
'1/2+3/4i'.to_c #=> ((1/2)+(3/4)*i)
'ruby'.to_c #=> (0+0i)
See Kernel.Complex.
@overload to_c;T;%0;"@.;;'F;)o;*;+T;,i?;-iS;.@(; I"static VALUE;T;/I"Jstatic VALUE
string_to_c(VALUE self)
{
char *s;
VALUE num;
rb_must_asciicompat(self);
s = RSTRING_PTR(self);
if (s && s[RSTRING_LEN(self)]) {
rb_str_modify(self);
s = RSTRING_PTR(self);
s[RSTRING_LEN(self)] = '\0';
}
if (!s)
s = (char *)"";
(void)parse_comp(s, 0, &num);
return num;
};T;0To;
; F; ;
;;;I" String#str2big_poweroftwo;F;[[I"
vbase;T0[I"
badcheck;T0;[[I" ext/-test-/bignum/str2big.c;Ti;T;:str2big_poweroftwo;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@D;;.@(; I"static VALUE;T;/I"static VALUE
str2big_poweroftwo(VALUE str, VALUE vbase, VALUE badcheck)
{
return rb_str2big_poweroftwo(str, NUM2INT(vbase), RTEST(badcheck));
};T;0To;
; F; ;
;;;I"String#str2big_normal;F;[[I"
vbase;T0[I"
badcheck;T0;[[@M;i;T;:str2big_normal;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@U;;.@(; I"static VALUE;T;/I"static VALUE
str2big_normal(VALUE str, VALUE vbase, VALUE badcheck)
{
return rb_str2big_normal(str, NUM2INT(vbase), RTEST(badcheck));
};T;0To;
; F; ;
;;;I" String#str2big_karatsuba;F;[[I"
vbase;T0[I"
badcheck;T0;[[@M;i;T;:str2big_karatsuba;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@e;;.@(; I"static VALUE;T;/I"static VALUE
str2big_karatsuba(VALUE str, VALUE vbase, VALUE badcheck)
{
return rb_str2big_karatsuba(str, NUM2INT(vbase), RTEST(badcheck));
};T;0To;
; F; ;
;;;I"String#str2big_gmp;F;[[I"
vbase;T0[I"
badcheck;T0;[[@M;i;T;:str2big_gmp;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@u;;.@(; I"static VALUE;T;/I"static VALUE
str2big_gmp(VALUE str, VALUE vbase, VALUE badcheck)
{
return rb_str2big_gmp(str, NUM2INT(vbase), RTEST(badcheck));
};T;0T;N@(;OIC;[ ;N@(;PIC;[@];N@(;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@)i$;F;;;;X;;;[ ;{ ;IC;"A String object holds and manipulates an arbitrary sequence of
bytes, typically representing characters. String objects may be created
using String::new or as literals.
Because of aliasing issues, users of strings should be aware of the methods
that modify the contents of a String object. Typically,
methods with names ending in ``!'' modify their receiver, while those
without a ``!'' return a new String. However, there are
exceptions, such as String#[]=.;T;[ ;#[ ;$I"A String object holds and manipulates an arbitrary sequence of
bytes, typically representing characters. String objects may be created
using String::new or as literals.
Because of aliasing issues, users of strings should be aware of the methods
that modify the contents of a String object. Typically,
methods with names ending in ``!'' modify their receiver, while those
without a ``!'' return a new String. However, there are
exceptions, such as String#[]=.
;T;%0;"@(;'F;(i ;)o;*;+T;,i$;-i$;.@;I" String;F;Y@N@]o;;IC;[o;
; F; ;
;;K;I" NKF#nkf;F;[[I"opt;T0[I"src;T0;[[I"ext/nkf/nkf.c;Ti;T;:nkf;0;[ ;{ ;IC;"Convert _str_ and return converted result.
Conversion details are specified by _opt_ as String.
require 'nkf'
output = NKF.nkf("-s", input)
;T;[o;
; I"
overload;F; 0;;; 0; I"nkf(opt, str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@;;#[ ;$I"@return [String];T;%0;"@;;&0;'F;(i ;[[I"opt;T0[I"str;T0;"@;;#[ ;$I"Convert _str_ and return converted result.
Conversion details are specified by _opt_ as String.
require 'nkf'
output = NKF.nkf("-s", input)
@overload nkf(opt, str)
@return [String];T;%0;"@;;&0;'F;.@;; I"static VALUE;T;/I"Xstatic VALUE
rb_nkf_convert(VALUE obj, VALUE opt, VALUE src)
{
VALUE tmp;
reinit();
StringValue(opt);
nkf_split_options(RSTRING_PTR(opt));
if (!output_encoding) rb_raise(rb_eArgError, "no output encoding given");
switch (nkf_enc_to_index(output_encoding)) {
case UTF_8_BOM: output_encoding = nkf_enc_from_index(UTF_8); break;
case UTF_16BE_BOM: output_encoding = nkf_enc_from_index(UTF_16BE); break;
case UTF_16LE_BOM: output_encoding = nkf_enc_from_index(UTF_16LE); break;
case UTF_32BE_BOM: output_encoding = nkf_enc_from_index(UTF_32BE); break;
case UTF_32LE_BOM: output_encoding = nkf_enc_from_index(UTF_32LE); break;
}
output_bom_f = FALSE;
incsize = INCSIZE;
input_ctr = 0;
StringValue(src);
input = (unsigned char *)RSTRING_PTR(src);
i_len = RSTRING_LENINT(src);
tmp = rb_str_new(0, i_len*3 + 10);
output_ctr = 0;
output = (unsigned char *)RSTRING_PTR(tmp);
o_len = RSTRING_LENINT(tmp);
*output = '\0';
/* use _result_ begin*/
result = tmp;
kanji_convert(NULL);
result = Qnil;
/* use _result_ end */
rb_str_set_len(tmp, output_ctr);
OBJ_INFECT(tmp, src);
if (mimeout_f)
rb_enc_associate(tmp, rb_usascii_encoding());
else
rb_enc_associate(tmp, rb_nkf_enc_get(nkf_enc_name(output_encoding)));
return tmp;
};T;0To;
; T; ;S;;;I" NKF.nkf;F;@;;@;;T;;;0;@;;{ ;IC;"Convert _str_ and return converted result.
Conversion details are specified by _opt_ as String.
require 'nkf'
output = NKF.nkf("-s", input);T;[o;
; I"
overload;F; 0;;; 0; I"nkf(opt, str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@;;#[ ;$I"@return [String];T;%0;"@;;&0;'F;(i ;[[I"opt;T0[I"str;T0;"@;;#[ ;$I"Convert _str_ and return converted result.
Conversion details are specified by _opt_ as String.
require 'nkf'
output = NKF.nkf("-s", input)
@overload nkf(opt, str)
@return [String];T;%0;"@;;'F;(i ;)o;*;+T;,i|;-i;.@;; @;;/@;;0To;
; F; ;
;;K;I"NKF#guess;F;[[I"src;T0;[[@;i;T;:
guess;0;[ ;{ ;IC;"6Returns guessed encoding of _str_ by nkf routine.
;T;[o;
; I"
overload;F; 0;;; 0; I"guess(str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Encoding;T;"@;;#[ ;$I"@return [Encoding];T;%0;"@;;&0;'F;(i ;[[I"str;T0;"@;;#[ ;$I"aReturns guessed encoding of _str_ by nkf routine.
@overload guess(str)
@return [Encoding];T;%0;"@;;&0;'F;.@;; I"static VALUE;T;/I"Fstatic VALUE
rb_nkf_guess(VALUE obj, VALUE src)
{
reinit();
input_ctr = 0;
StringValue(src);
input = (unsigned char *)RSTRING_PTR(src);
i_len = RSTRING_LENINT(src);
guess_f = TRUE;
kanji_convert( NULL );
guess_f = FALSE;
return rb_enc_from_encoding(rb_nkf_enc_get(get_guessed_code()));
};T;0To;
; T; ;S;;;I"NKF.guess;F;@;;@;;T;;;0;@;;{ ;IC;"6Returns guessed encoding of _str_ by nkf routine.;T;[o;
; I"
overload;F; 0;;; 0; I"guess(str);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Encoding;T;"@;;#[ ;$I"@return [Encoding];T;%0;"@;;&0;'F;(i ;[[I"str;T0;"@;;#[ ;$I"cReturns guessed encoding of _str_ by nkf routine.
@overload guess(str)
@return [Encoding];T;%0;"@;;'F;(i ;)o;*;+T;,i;-i;.@;; @;;/@;;0To;;[[@;i;F;: AUTO;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ <;.@;;I"NKF::AUTO;F;I" Qnil;To;;[[@;i;F;: NOCONV;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@<;.@;;I"NKF::NOCONV;F;I" Qnil;To;;[[@;i;F;: UNKNOWN;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ <;.@;;I"NKF::UNKNOWN;F;I" Qnil;To;;[[@;i;F;: BINARY;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@'<;.@;;I"NKF::BINARY;F;I"3rb_enc_from_encoding(rb_nkf_enc_get("BINARY"));To;;[[@;i;F;:
ASCII;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@1<;.@;;I"NKF::ASCII;F;I"5rb_enc_from_encoding(rb_nkf_enc_get("US-ASCII"));To;;[[@;i;F;:JIS;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@;<;.@;;I"
NKF::JIS;F;I"8rb_enc_from_encoding(rb_nkf_enc_get("ISO-2022-JP"));To;;[[@;i;F;:EUC;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@E<;.@;;I"
NKF::EUC;F;I"3rb_enc_from_encoding(rb_nkf_enc_get("EUC-JP"));To;;[[@;i;F;: SJIS;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@O<;.@;;I"NKF::SJIS;F;I"6rb_enc_from_encoding(rb_nkf_enc_get("Shift_JIS"));To;;[[@;i;F;: UTF8;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@Y<;.@;;I"NKF::UTF8;F;I"-rb_enc_from_encoding(rb_utf8_encoding());To;;[[@;i;F;:
UTF16;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@c<;.@;;I"NKF::UTF16;F;I"5rb_enc_from_encoding(rb_nkf_enc_get("UTF-16BE"));To;;[[@;i;F;:
UTF32;;;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@m<;.@;;I"NKF::UTF32;F;I"5rb_enc_from_encoding(rb_nkf_enc_get("UTF-32BE"));To;;[[@;i;F;: VERSION;;;;;[ ;{ ;IC;" Full version string of nkf
;T;[ ;#[ ;$I" Full version string of nkf;T;%0;"@w<;'F;)o;*;+T;,i;-i;.@;;I"NKF::VERSION;F;I""rb_str_new2(RUBY_NKF_VERSION);To;;[[@;i;F;:NKF_VERSION;;;;;[ ;{ ;IC;"Version of nkf
;T;[ ;#[ ;$I"Version of nkf;T;%0;"@<;'F;)o;*;+T;,i;-i;.@;;I"NKF::NKF_VERSION;F;I" rb_str_new2(NKF_VERSION);To;;[[@;i;F;:NKF_RELEASE_DATE;;;;;[ ;{ ;IC;"Release date of nkf
;T;[ ;#[ ;$I"Release date of nkf;T;%0;"@<;'F;)o;*;+T;,i;-i;.@;;I"NKF::NKF_RELEASE_DATE;F;I""rb_str_new2(NKF_RELEASE_DATE);T;N@;;OIC;[ ;N@;;PIC;[ ;N@;;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@;i;F;:NKF;;X;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@;;(i ;.@;I"NKF;Fo; ;IC;[o;;[[@YiF[@[iF;F;: Version;;;;;[ ;{ ;IC;"version of Ripper
;T;[ ;#[ ;$I"version of Ripper;T;%0;"@<;'F;)o;*;+T;,iF;-iF;.@<;I"Ripper::Version;F;I"(rb_usascii_str_new2(RIPPER_VERSION);To;
; F; ;
;;;I"Ripper#initialize;F;[[@0;[[@YiCF[@[iE;T;;;0;[ ;{ ;IC;"Create a new Ripper object.
_src_ must be a String, an IO, or an Object which has #gets method.
This method does not starts parsing.
See also Ripper#parse and Ripper.parse.
;T;[o;
; I"
overload;F; 0;;S; 0; I",new(src, filename="(ripper)", lineno=1);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@<;&0;'F;(i ;[[I"src;T0[I"
filename;TI""(ripper)";T[I" lineno;TI"1;T;"@<;#[ ;$I"Create a new Ripper object.
_src_ must be a String, an IO, or an Object which has #gets method.
This method does not starts parsing.
See also Ripper#parse and Ripper.parse.
@overload new(src, filename="(ripper)", lineno=1);T;%0;"@<;'F;)o;*;+T;,iE;-iE;.@<; I"static VALUE;T;/I"Bstatic VALUE
ripper_initialize(int argc, VALUE *argv, VALUE self)
{
struct parser_params *parser;
VALUE src, fname, lineno;
TypedData_Get_Struct(self, struct parser_params, &parser_data_type, parser);
rb_scan_args(argc, argv, "12", &src, &fname, &lineno);
if (RB_TYPE_P(src, T_FILE)) {
lex_gets = ripper_lex_get_generic;
}
else {
StringValue(src);
lex_gets = lex_get_str;
}
lex_input = src;
parser->eofp = 0;
if (NIL_P(fname)) {
fname = STR_NEW2("(ripper)");
OBJ_FREEZE(fname);
}
else {
StringValue(fname);
fname = rb_str_new_frozen(fname);
}
parser_initialize(parser);
ruby_sourcefile_string = fname;
ruby_sourcefile = RSTRING_PTR(fname);
ruby_sourceline = NIL_P(lineno) ? 0 : NUM2INT(lineno) - 1;
return Qnil;
};T;0To;
; F; ;
;;;I"Ripper#parse;F;[ ;[[@YiF[@[i,F;T;:
parse;0;[ ;{ ;IC;"parsing_thread)) {
if (parser->parsing_thread == rb_thread_current())
rb_raise(rb_eArgError, "Ripper#parse is not reentrant");
else
rb_raise(rb_eArgError, "Ripper#parse is not multithread-safe");
}
parser->parsing_thread = rb_thread_current();
rb_ensure(ripper_parse0, self, ripper_ensure, self);
return parser->result;
};T;0To;
; F; ;
;;;I"Ripper#column;F;[ ;[[@YiF[@[iHF;T;: column;0;[ ;{ ;IC;"MReturn column number of current parsing line.
This number starts from 0.
;T;[o;
; I"
overload;F; 0;;; 0; I" column;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@<;#[ ;$I"@return [Integer];T;%0;"@<;&0;'F;(i ;[ ;"@<;#[ ;$I"tReturn column number of current parsing line.
This number starts from 0.
@overload column
@return [Integer];T;%0;"@<;'F;)o;*;+T;,iAF;-iFF;.@<; I"static VALUE;T;/I"static VALUE
ripper_column(VALUE self)
{
struct parser_params *parser;
long col;
TypedData_Get_Struct(self, struct parser_params, &parser_data_type, parser);
if (!ripper_initialized_p(parser)) {
rb_raise(rb_eArgError, "method called for uninitialized object");
}
if (NIL_P(parser->parsing_thread)) return Qnil;
col = parser->tokp - lex_pbeg;
return LONG2NUM(col);
};T;0To;
; F; ;
;;;I"Ripper#filename;F;[ ;[[@YiF[@[i]F;T;:
filename;0;[ ;{ ;IC;"%Return current parsing filename.
;T;[o;
; I"
overload;F; 0;;; 0; I"
filename;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@ =;#[ ;$I"@return [String];T;%0;"@ =;&0;'F;(i ;[ ;"@ =;#[ ;$I"MReturn current parsing filename.
@overload filename
@return [String];T;%0;"@ =;'F;)o;*;+T;,iWF;-i[F;.@<; I"static VALUE;T;/I"<static VALUE
ripper_filename(VALUE self)
{
struct parser_params *parser;
TypedData_Get_Struct(self, struct parser_params, &parser_data_type, parser);
if (!ripper_initialized_p(parser)) {
rb_raise(rb_eArgError, "method called for uninitialized object");
}
return ruby_sourcefile_string;
};T;0To;
; F; ;
;;;I"Ripper#lineno;F;[ ;[[@YiF[@[ipF;T;: lineno;0;[ ;{ ;IC;"KReturn line number of current parsing line.
This number starts from 1.
;T;[o;
; I"
overload;F; 0;;; 0; I" lineno;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@(=;#[ ;$I"@return [Integer];T;%0;"@(=;&0;'F;(i ;[ ;"@(=;#[ ;$I"rReturn line number of current parsing line.
This number starts from 1.
@overload lineno
@return [Integer];T;%0;"@(=;'F;)o;*;+T;,iiF;-inF;.@<; I"static VALUE;T;/I"pstatic VALUE
ripper_lineno(VALUE self)
{
struct parser_params *parser;
TypedData_Get_Struct(self, struct parser_params, &parser_data_type, parser);
if (!ripper_initialized_p(parser)) {
rb_raise(rb_eArgError, "method called for uninitialized object");
}
if (NIL_P(parser->parsing_thread)) return Qnil;
return INT2NUM(ruby_sourceline);
};T;0To;
; F; ;
;;;I"Ripper#end_seen?;F;[ ;[[@YiD[@[i\D;T;:end_seen?;0;[ ;{ ;IC;"9Return true if parsed source ended by +\_\_END\_\_+.
;T;[o;
; I"
overload;F; 0;;; 0; I"end_seen?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@D=;#[ ;$I"@return [Boolean];T;%0;"@D=;&0;'F;(i ;[ ;"@D=o;!
; I" return;F; @;0; [@;"@D=;#[ ;$I"cReturn true if parsed source ended by +\_\_END\_\_+.
@overload end_seen?
@return [Boolean];T;%0;"@D=;'F;)o;*;+T;,iVD;-iZD;.@<; I"
VALUE;T;/I"VALUE
rb_parser_end_seen_p(VALUE vparser)
{
struct parser_params *parser;
TypedData_Get_Struct(vparser, struct parser_params, &parser_data_type, parser);
return ruby__end__seen ? Qtrue : Qfalse;
};T;0To;
; F; ;
;;;I"Ripper#encoding;F;[ ;[[@YiD[@[ikD;T;;;0;[ ;{ ;IC;"#Return encoding of the source.
;T;[o;
; I"
overload;F; 0;;; 0; I"
encoding;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Encoding;T;"@c=;#[ ;$I"@return [Encoding];T;%0;"@c=;&0;'F;(i ;[ ;"@c=;#[ ;$I"MReturn encoding of the source.
@overload encoding
@return [Encoding];T;%0;"@c=;'F;)o;*;+T;,ieD;-iiD;.@<; I"
VALUE;T;/I"VALUE
rb_parser_encoding(VALUE vparser)
{
struct parser_params *parser;
TypedData_Get_Struct(vparser, struct parser_params, &parser_data_type, parser);
return rb_enc_from_encoding(current_enc);
};T;0To;
; F; ;
;;;I"Ripper#yydebug;F;[ ;[[@YiD[@[izD;T;: yydebug;0;[ ;{ ;IC;"Get yydebug.
;T;[o;
; I"
overload;F; 0;;; 0; I" yydebug;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@=;#[ ;$I"@return [Boolean];T;%0;"@=;&0;'F;(i ;[ ;"@=;#[ ;$I"9Get yydebug.
@overload yydebug
@return [Boolean];T;%0;"@=;'F;)o;*;+T;,itD;-ixD;.@<; I"
VALUE;T;/I"VALUE
rb_parser_get_yydebug(VALUE self)
{
struct parser_params *parser;
TypedData_Get_Struct(self, struct parser_params, &parser_data_type, parser);
return yydebug ? Qtrue : Qfalse;
};T;0To;
; F; ;
;;;I"Ripper#yydebug=;F;[[I" flag;T0;[[@YiD[@[iD;T;:
yydebug=;0;[ ;{ ;IC;"Set yydebug.
;T;[o;
; I"
overload;F; 0;;; 0; I"yydebug=(flag);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@=;&0;'F;(i ;[[I" flag;T0;"@=;#[ ;$I",Set yydebug.
@overload yydebug=(flag);T;%0;"@=;'F;)o;*;+T;,iD;-iD;.@<; I"
VALUE;T;/I"VALUE
rb_parser_set_yydebug(VALUE self, VALUE flag)
{
struct parser_params *parser;
TypedData_Get_Struct(self, struct parser_params, &parser_data_type, parser);
yydebug = RTEST(flag);
return flag;
};T;0To;
; F; ;
;;;I"Ripper#error?;F;[ ;[[@YiD[@[iLD;T;: error?;0;[ ;{ ;IC;"-Return true if parsed source has errors.
;T;[o;
; I"
overload;F; 0;;; 0; I" error?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@=;#[ ;$I"@return [Boolean];T;%0;"@=;&0;'F;(i ;[ ;"@=o;!
; I" return;F; @;0; [@;"@=;#[ ;$I"TReturn true if parsed source has errors.
@overload error?
@return [Boolean];T;%0;"@=;'F;)o;*;+T;,iFD;-iJD;.@<; I"static VALUE;T;/I"static VALUE
ripper_error_p(VALUE vparser)
{
struct parser_params *parser;
TypedData_Get_Struct(vparser, struct parser_params, &parser_data_type, parser);
return parser->error_p ? Qtrue : Qfalse;
};T;0To;
; F; ;S;;;I"Ripper.dedent_string;F;[[I"
input;T0[I"
width;T0;[[@Yi!4[@[i3;T;:dedent_string;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@=;.@<; I"static VALUE;T;/I"static VALUE
parser_dedent_string(VALUE self, VALUE input, VALUE width)
{
char *str;
long len;
int wid, col;
StringValue(input);
wid = NUM2UINT(width);
rb_str_modify(input);
RSTRING_GETMEM(input, str, len);
col = dedent_pos(str, len, wid);
MEMMOVE(str, str + col, char, len - col);
rb_str_set_len(input, len - col);
return INT2NUM(col);
};T;0To;
; F; ;
;;K;I"Ripper#dedent_string;F;[[I"
input;T0[I"
width;T0;[[@Yi!4[@[i3;T;;;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@=;.@<; I"static VALUE;T;/I"static VALUE
parser_dedent_string(VALUE self, VALUE input, VALUE width)
{
char *str;
long len;
int wid, col;
StringValue(input);
wid = NUM2UINT(width);
rb_str_modify(input);
RSTRING_GETMEM(input, str, len);
col = dedent_pos(str, len, wid);
MEMMOVE(str, str + col, char, len - col);
rb_str_set_len(input, len - col);
return INT2NUM(col);
};T;0T;N@<;OIC;[ ;N@<;PIC;[ ;N@<;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@YiF[@[iF;F;: Ripper;;X;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@<;(i ;.@;I" Ripper;F;Y@N@No;;[[@Yi G[@[iF;F;:SCRIPT_LINES__;;;;;[ ;{ ;IC;"When a Hash is assigned to +SCRIPT_LINES__+ the contents of files loaded
after the assignment will be added as an Array of lines with the file
name as the key.
;T;[ ;#[ ;$I"When a Hash is assigned to +SCRIPT_LINES__+ the contents of files loaded
after the assignment will be added as an Array of lines with the file
name as the key.
;T;%0;"@>;'F;)o;*;+T;,iF;-iF;.@;I"SCRIPT_LINES__;F;I" Qnil;To; ;IC;[Go;
; F; ;S;;;I" Hash.[];F;[[@0;[[I" hash.c;Tie;T;;V;0;[ ;{ ;IC;"Creates a new hash populated with the given objects.
Similar to the literal { _key_ => _value_, ... }. In the first
form, keys and values occur in pairs, so there must be an even number of
arguments.
The second and third form take a single argument which is either an array
of key-value pairs or an object convertible to a hash.
Hash["a", 100, "b", 200] #=> {"a"=>100, "b"=>200}
Hash[ [ ["a", 100], ["b", 200] ] ] #=> {"a"=>100, "b"=>200}
Hash["a" => 100, "b" => 200] #=> {"a"=>100, "b"=>200}
;T;[o;
; I"
overload;F; 0;;V; 0; I"[]( key, value, ... );T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@>;&0;'F;(i ;[[I"key;T0[I"
value;T0[I"...;T0;"@>o;
; I"
overload;F; 0;;V; 0; I"[]( [ [key, value);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@>;&0;'F;(i ;[[I"[ [key, value);T0;"@>o;
; I"
overload;F; 0;;V; 0; I"[]( object );T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@>;&0;'F;(i ;[[I" object;T0;"@>;#[ ;$I"qCreates a new hash populated with the given objects.
Similar to the literal { _key_ => _value_, ... }. In the first
form, keys and values occur in pairs, so there must be an even number of
arguments.
The second and third form take a single argument which is either an array
of key-value pairs or an object convertible to a hash.
Hash["a", 100, "b", 200] #=> {"a"=>100, "b"=>200}
Hash[ [ ["a", 100], ["b", 200] ] ] #=> {"a"=>100, "b"=>200}
Hash["a" => 100, "b" => 200] #=> {"a"=>100, "b"=>200}
@overload []( key, value, ... )
@overload []( [ [key, value)
@overload []( object );T;%0;"@>;'F;)o;*;+T;,iQ;-ia;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_s_create(int argc, VALUE *argv, VALUE klass)
{
VALUE hash, tmp;
int i;
if (argc == 1) {
tmp = rb_hash_s_try_convert(Qnil, argv[0]);
if (!NIL_P(tmp)) {
hash = hash_alloc(klass);
if (RHASH(tmp)->ntbl) {
RHASH(hash)->ntbl = st_copy(RHASH(tmp)->ntbl);
}
return hash;
}
tmp = rb_check_array_type(argv[0]);
if (!NIL_P(tmp)) {
long i;
hash = hash_alloc(klass);
for (i = 0; i < RARRAY_LEN(tmp); ++i) {
VALUE e = RARRAY_AREF(tmp, i);
VALUE v = rb_check_array_type(e);
VALUE key, val = Qnil;
if (NIL_P(v)) {
#if 0 /* refix in the next release */
rb_raise(rb_eArgError, "wrong element type %s at %ld (expected array)",
rb_builtin_class_name(e), i);
#else
rb_warn("wrong element type %s at %ld (expected array)",
rb_builtin_class_name(e), i);
rb_warn("ignoring wrong elements is deprecated, remove them explicitly");
rb_warn("this causes ArgumentError in the next release");
continue;
#endif
}
switch (RARRAY_LEN(v)) {
default:
rb_raise(rb_eArgError, "invalid number of elements (%ld for 1..2)",
RARRAY_LEN(v));
case 2:
val = RARRAY_AREF(v, 1);
case 1:
key = RARRAY_AREF(v, 0);
rb_hash_aset(hash, key, val);
}
}
return hash;
}
}
if (argc % 2 != 0) {
rb_raise(rb_eArgError, "odd number of arguments for Hash");
}
hash = hash_alloc(klass);
for (i=0; ii;T;;R;0;[ ;{ ;IC;"Try to convert obj into a hash, using to_hash method.
Returns converted hash or nil if obj cannot be converted
for any reason.
Hash.try_convert({1=>2}) # => {1=>2}
Hash.try_convert("1=>2") # => nil
;T;[o;
; I"
overload;F; 0;;R; 0; I"try_convert(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;TI"nil;T;"@H>;#[ ;$I"@return [Hash, nil];T;%0;"@H>;&0;'F;(i ;[[I"obj;T0;"@H>;#[ ;$I"Try to convert obj into a hash, using to_hash method.
Returns converted hash or nil if obj cannot be converted
for any reason.
Hash.try_convert({1=>2}) # => {1=>2}
Hash.try_convert("1=>2") # => nil
@overload try_convert(obj)
@return [Hash, nil];T;%0;"@H>;'F;)o;*;+T;,i;-i;.@>; I"static VALUE;T;/I"istatic VALUE
rb_hash_s_try_convert(VALUE dummy, VALUE hash)
{
return rb_check_hash_type(hash);
};T;0To;
; F; ;
;;;I"Hash#initialize;F;[[@0;[[@ >i;;T;;;0;[ ;{ ;IC;"8Returns a new, empty hash. If this hash is subsequently accessed by
a key that doesn't correspond to a hash entry, the value returned
depends on the style of new used to create the hash. In
the first form, the access returns nil. If
obj is specified, this single object will be used for
all default values. If a block is specified, it will be
called with the hash object and the key, and should return the
default value. It is the block's responsibility to store the value
in the hash if required.
h = Hash.new("Go Fish")
h["a"] = 100
h["b"] = 200
h["a"] #=> 100
h["c"] #=> "Go Fish"
# The following alters the single default object
h["c"].upcase! #=> "GO FISH"
h["d"] #=> "GO FISH"
h.keys #=> ["a", "b"]
# While this creates a new default object each time
h = Hash.new { |hash, key| hash[key] = "Go Fish: #{key}" }
h["c"] #=> "Go Fish: c"
h["c"].upcase! #=> "GO FISH: C"
h["d"] #=> "Go Fish: d"
h.keys #=> ["c", "d"]
;T;[o;
; I"
overload;F; 0;;S; 0; I"new;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@h>;&0;'F;(i ;[ ;"@h>o;
; I"
overload;F; 0;;S; 0; I"
new(obj);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@h>;&0;'F;(i ;[[I"obj;T0;"@h>o;
; I"
overload;F; 0;;S; 0; I"new;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" hash;TI"key;T;"@h>;#[ ;$I"@yield [hash, key];T;%0;"@h>;&0;'F;(i ;[ ;"@h>;#[ ;$I"Returns a new, empty hash. If this hash is subsequently accessed by
a key that doesn't correspond to a hash entry, the value returned
depends on the style of new used to create the hash. In
the first form, the access returns nil. If
obj is specified, this single object will be used for
all default values. If a block is specified, it will be
called with the hash object and the key, and should return the
default value. It is the block's responsibility to store the value
in the hash if required.
h = Hash.new("Go Fish")
h["a"] = 100
h["b"] = 200
h["a"] #=> 100
h["c"] #=> "Go Fish"
# The following alters the single default object
h["c"].upcase! #=> "GO FISH"
h["d"] #=> "GO FISH"
h.keys #=> ["a", "b"]
# While this creates a new default object each time
h = Hash.new { |hash, key| hash[key] = "Go Fish: #{key}" }
h["c"] #=> "Go Fish: c"
h["c"].upcase! #=> "GO FISH: C"
h["d"] #=> "Go Fish: d"
h.keys #=> ["c", "d"]
@overload new
@overload new(obj)
@overload new
@yield [hash, key];T;%0;"@h>;'F;)o;*;+T;,i;-i8;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_initialize(int argc, VALUE *argv, VALUE hash)
{
VALUE ifnone;
rb_hash_modify(hash);
if (rb_block_given_p()) {
rb_check_arity(argc, 0, 0);
ifnone = rb_block_proc();
default_proc_arity_check(ifnone);
RHASH_SET_IFNONE(hash, ifnone);
FL_SET(hash, HASH_PROC_DEFAULT);
}
else {
rb_check_arity(argc, 0, 1);
ifnone = argc == 0 ? Qnil : argv[0];
RHASH_SET_IFNONE(hash, ifnone);
}
return hash;
};T;0To;
; F; ;
;;;I"Hash#initialize_copy;F;[[I"
hash2;T0;[[@ >i;T;;w;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@>;'F;)o;*;+T;,i;-i;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_initialize_copy(VALUE hash, VALUE hash2)
{
st_table *ntbl;
rb_hash_modify_check(hash);
hash2 = to_hash(hash2);
Check_Type(hash2, T_HASH);
if (hash == hash2) return hash;
ntbl = RHASH(hash)->ntbl;
if (RHASH(hash2)->ntbl) {
if (ntbl) st_free_table(ntbl);
RHASH(hash)->ntbl = st_copy(RHASH(hash2)->ntbl);
if (RHASH(hash)->ntbl->num_entries)
rb_hash_rehash(hash);
}
else if (ntbl) {
st_clear(ntbl);
}
if (FL_TEST(hash2, HASH_PROC_DEFAULT)) {
FL_SET(hash, HASH_PROC_DEFAULT);
}
else {
FL_UNSET(hash, HASH_PROC_DEFAULT);
}
RHASH_SET_IFNONE(hash, RHASH_IFNONE(hash2));
return hash;
};T;0To;
; F; ;
;;;I"Hash#rehash;F;[ ;[[@ >i;T;: rehash;0;[ ;{ ;IC;"Rebuilds the hash based on the current hash values for each key. If
values of key objects have changed since they were inserted, this
method will reindex hsh. If Hash#rehash is
called while an iterator is traversing the hash, a
RuntimeError will be raised in the iterator.
a = [ "a", "b" ]
c = [ "c", "d" ]
h = { a => 100, c => 300 }
h[a] #=> 100
a[0] = "z"
h[a] #=> nil
h.rehash #=> {["z", "b"]=>100, ["c", "d"]=>300}
h[a] #=> 100
;T;[o;
; I"
overload;F; 0;;; 0; I" rehash;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@>;#[ ;$I"@return [Hash];T;%0;"@>;&0;'F;(i ;[ ;"@>;#[ ;$I"!Rebuilds the hash based on the current hash values for each key. If
values of key objects have changed since they were inserted, this
method will reindex hsh. If Hash#rehash is
called while an iterator is traversing the hash, a
RuntimeError will be raised in the iterator.
a = [ "a", "b" ]
c = [ "c", "d" ]
h = { a => 100, c => 300 }
h[a] #=> 100
a[0] = "z"
h[a] #=> nil
h.rehash #=> {["z", "b"]=>100, ["c", "d"]=>300}
h[a] #=> 100
@overload rehash
@return [Hash];T;%0;"@>;'F;)o;*;+T;,i;-i;.@>; I"
VALUE;T;/I"4VALUE
rb_hash_rehash(VALUE hash)
{
VALUE tmp;
st_table *tbl;
if (RHASH_ITER_LEV(hash) > 0) {
rb_raise(rb_eRuntimeError, "rehash during iteration");
}
rb_hash_modify_check(hash);
if (!RHASH(hash)->ntbl)
return hash;
tmp = hash_alloc(0);
tbl = st_init_table_with_size(RHASH(hash)->ntbl->type, RHASH(hash)->ntbl->num_entries);
RHASH(tmp)->ntbl = tbl;
rb_hash_foreach(hash, rb_hash_rehash_i, (VALUE)tbl);
st_free_table(RHASH(hash)->ntbl);
RHASH(hash)->ntbl = tbl;
RHASH(tmp)->ntbl = 0;
return hash;
};T;0To;
; F; ;
;;;I"Hash#to_hash;F;[ ;[[@ >iM;T;: to_hash;0;[ ;{ ;IC;"Returns +self+.
;T;[o;
; I"
overload;F; 0;;; 0; I" to_hash;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@>;#[ ;$I"@return [Hash];T;%0;"@>;&0;'F;(i ;[ ;"@>;#[ ;$I"9Returns +self+.
@overload to_hash
@return [Hash];T;%0;"@>;'F;)o;*;+T;,iF;-iJ;.@>; I"static VALUE;T;/I"Bstatic VALUE
rb_hash_to_hash(VALUE hash)
{
return hash;
};T;0To;
; F; ;
;;;I"Hash#to_h;F;[ ;[[@ >i[;T;;M;0;[ ;{ ;IC;"]Returns +self+. If called on a subclass of Hash, converts
the receiver to a Hash object.
;T;[o;
; I"
overload;F; 0;;M; 0; I" to_h;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@>;#[ ;$I"@return [Hash];T;%0;"@>;&0;'F;(i ;[ ;"@>;#[ ;$I"Returns +self+. If called on a subclass of Hash, converts
the receiver to a Hash object.
@overload to_h
@return [Hash];T;%0;"@>;'F;)o;*;+T;,iS;-iX;.@>; I"static VALUE;T;/I"_static VALUE
rb_hash_to_h(VALUE hash)
{
if (rb_obj_class(hash) != rb_cHash) {
VALUE ret = rb_hash_new();
if (!RHASH_EMPTY_P(hash))
RHASH(ret)->ntbl = st_copy(RHASH(hash)->ntbl);
if (FL_TEST(hash, HASH_PROC_DEFAULT)) {
FL_SET(ret, HASH_PROC_DEFAULT);
}
RHASH_SET_IFNONE(ret, RHASH_IFNONE(hash));
return ret;
}
return hash;
};T;0To;
; F; ;
;;;I"Hash#to_a;F;[ ;[[@ >i;T;;L;0;[ ;{ ;IC;"Converts hsh to a nested array of [ key,
value ] arrays.
h = { "c" => 300, "a" => 100, "d" => 400, "c" => 300 }
h.to_a #=> [["c", 300], ["a", 100], ["d", 400]]
;T;[o;
; I"
overload;F; 0;;L; 0; I" to_a;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@>;#[ ;$I"@return [Array];T;%0;"@>;&0;'F;(i ;[ ;"@>;#[ ;$I"Converts hsh to a nested array of [ key,
value ] arrays.
h = { "c" => 300, "a" => 100, "d" => 400, "c" => 300 }
h.to_a #=> [["c", 300], ["a", 100], ["d", 400]]
@overload to_a
@return [Array];T;%0;"@>;'F;)o;*;+T;,i;-i ;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_to_a(VALUE hash)
{
VALUE ary;
ary = rb_ary_new_capa(RHASH_SIZE(hash));
rb_hash_foreach(hash, to_a_i, ary);
OBJ_INFECT(ary, hash);
return ary;
};T;0To;
; F; ;
;;;I"Hash#inspect;F;[ ;[[@ >i>;T;;J;0;[ ;{ ;IC;"Return the contents of this hash as a string.
h = { "c" => 300, "a" => 100, "d" => 400, "c" => 300 }
h.to_s #=> "{\"c\"=>300, \"a\"=>100, \"d\"=>400}"
;T;[o;
; I"
overload;F; 0;;I; 0; I" to_s;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@?;#[ ;$I"@return [String];T;%0;"@?;&0;'F;(i ;[ ;"@?o;
; I"
overload;F; 0;;J; 0; I" inspect;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@?;#[ ;$I"@return [String];T;%0;"@?;&0;'F;(i ;[ ;"@?;#[ ;$I"Return the contents of this hash as a string.
h = { "c" => 300, "a" => 100, "d" => 400, "c" => 300 }
h.to_s #=> "{\"c\"=>300, \"a\"=>100, \"d\"=>400}"
@overload to_s
@return [String]
@overload inspect
@return [String];T;%0;"o;
; F; ;
;;;I"Hash#to_s;F;[ ;[[@ >i;F;;I;;X;[ ;{ ;@?;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_inspect(VALUE hash)
{
if (RHASH_EMPTY_P(hash))
return rb_usascii_str_new2("{}");
return rb_exec_recursive(inspect_hash, hash, 0);
};T;'F;)o;*;+T;,i3;-i<;.@>; @??;/I"static VALUE
rb_hash_inspect(VALUE hash)
{
if (RHASH_EMPTY_P(hash))
return rb_usascii_str_new2("{}");
return rb_exec_recursive(inspect_hash, hash, 0);
};T;0T@8?o;
; F; ;
;;;I"Hash#to_proc;F;[ ;[[@ >i ;T;: to_proc;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@C?;.@>; I"static VALUE;T;/I"dstatic VALUE
rb_hash_to_proc(VALUE hash)
{
return rb_func_proc_new(hash_proc_call, hash);
};T;0To;
; F; ;
;;;I" Hash#==;F;[[I"
hash2;T0;[[@ >ii;T;;:;0;[ ;{ ;IC;"+Equality---Two hashes are equal if they each contain the same number
of keys and if each key-value pair is equal to (according to
Object#==) the corresponding elements in the other
hash.
h1 = { "a" => 1, "c" => 2 }
h2 = { 7 => 35, "c" => 2, "a" => 1 }
h3 = { "a" => 1, "c" => 2, 7 => 35 }
h4 = { "a" => 1, "d" => 2, "f" => 35 }
h1 == h2 #=> false
h2 == h3 #=> true
h3 == h4 #=> false
The orders of each hashes are not compared.
h1 = { "a" => 1, "c" => 2 }
h2 = { "c" => 2, "a" => 1 }
h1 == h2 #=> true
;T;[o;
; I"
overload;F; 0;;:; 0; I"==(other_hash);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@O?;#[ ;$I"@return [Boolean];T;%0;"@O?;&0;'F;(i ;[[I"other_hash;T0;"@O?;#[ ;$I"[Equality---Two hashes are equal if they each contain the same number
of keys and if each key-value pair is equal to (according to
Object#==) the corresponding elements in the other
hash.
h1 = { "a" => 1, "c" => 2 }
h2 = { 7 => 35, "c" => 2, "a" => 1 }
h3 = { "a" => 1, "c" => 2, 7 => 35 }
h4 = { "a" => 1, "d" => 2, "f" => 35 }
h1 == h2 #=> false
h2 == h3 #=> true
h3 == h4 #=> false
The orders of each hashes are not compared.
h1 = { "a" => 1, "c" => 2 }
h2 = { "c" => 2, "a" => 1 }
h1 == h2 #=> true
@overload ==(other_hash)
@return [Boolean];T;%0;"@O?;'F;)o;*;+T;,iP;-if;.@>; I"static VALUE;T;/I"istatic VALUE
rb_hash_equal(VALUE hash1, VALUE hash2)
{
return hash_equal(hash1, hash2, FALSE);
};T;0To;
; F; ;
;;;I" Hash#[];F;[[I"key;T0;[[@ >i;T;;V;0;[ ;{ ;IC;"Element Reference---Retrieves the value object corresponding
to the key object. If not found, returns the default value (see
Hash::new for details).
h = { "a" => 100, "b" => 200 }
h["a"] #=> 100
h["c"] #=> nil
;T;[o;
; I"
overload;F; 0;;V; 0; I" [](key);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@n?;&0;'F;(i ;[[I"key;T0;"@n?;#[ ;$I"Element Reference---Retrieves the value object corresponding
to the key object. If not found, returns the default value (see
Hash::new for details).
h = { "a" => 100, "b" => 200 }
h["a"] #=> 100
h["c"] #=> nil
@overload [](key);T;%0;"@n?;'F;)o;*;+T;,i ;-i;.@>; I"
VALUE;T;/I"VALUE
rb_hash_aref(VALUE hash, VALUE key)
{
st_data_t val;
if (!RHASH(hash)->ntbl || !st_lookup(RHASH(hash)->ntbl, key, &val)) {
return rb_hash_default_value(hash, key);
}
return (VALUE)val;
};T;0To;
; F; ;
;;;I"Hash#hash;F;[ ;[[@ >i;T;;H;0;[ ;{ ;IC;"Compute a hash-code for this hash. Two hashes with the same content
will have the same hash code (and will compare using eql?).
See also Object#hash.
;T;[o;
; I"
overload;F; 0;;H; 0; I" hash;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;T;"@?;#[ ;$I"@return [Fixnum];T;%0;"@?;&0;'F;(i ;[ ;"@?;#[ ;$I"Compute a hash-code for this hash. Two hashes with the same content
will have the same hash code (and will compare using eql?).
See also Object#hash.
@overload hash
@return [Fixnum];T;%0;"@?;'F;)o;*;+T;,i;-i;.@>; I"static VALUE;T;/I"1static VALUE
rb_hash_hash(VALUE hash)
{
st_index_t size = RHASH_SIZE(hash);
st_index_t hval = rb_hash_start(size);
hval = rb_hash_uint(hval, (st_index_t)rb_hash_hash);
if (size) {
rb_hash_foreach(hash, hash_i, (VALUE)&hval);
}
hval = rb_hash_end(hval);
return INT2FIX(hval);
};T;0To;
; F; ;
;;;I"Hash#eql?;F;[[I"
hash2;T0;[[@ >ix;T;;q;0;[ ;{ ;IC;"Returns true if hash and other are
both hashes with the same content.
The orders of each hashes are not compared.
;T;[o;
; I"
overload;F; 0;;q; 0; I"eql?(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@?;#[ ;$I"@return [Boolean];T;%0;"@?;&0;'F;(i ;[[I"
other;T0;"@?o;!
; I" return;F; @;0; [@;"@?;#[ ;$I"Returns true if hash and other are
both hashes with the same content.
The orders of each hashes are not compared.
@overload eql?(other)
@return [Boolean];T;%0;"@?;'F;)o;*;+T;,io;-iu;.@>; I"static VALUE;T;/I"fstatic VALUE
rb_hash_eql(VALUE hash1, VALUE hash2)
{
return hash_equal(hash1, hash2, TRUE);
};T;0To;
; F; ;
;;;I"Hash#fetch;F;[[@0;[[@ >iR;T;:
fetch;0;[ ;{ ;IC;"Returns a value from the hash for the given key. If the key can't be
found, there are several options: With no other arguments, it will
raise an KeyError exception; if default is
given, then that will be returned; if the optional code block is
specified, then that will be run and its result returned.
h = { "a" => 100, "b" => 200 }
h.fetch("a") #=> 100
h.fetch("z", "go fish") #=> "go fish"
h.fetch("z") { |el| "go fish, #{el}"} #=> "go fish, z"
The following example shows that an exception is raised if the key
is not found and a default value is not supplied.
h = { "a" => 100, "b" => 200 }
h.fetch("z")
produces:
prog.rb:2:in `fetch': key not found (KeyError)
from prog.rb:2
;T;[o;
; I"
overload;F; 0;;; 0; I" fetch(key [, default] );T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@?;#[ ;$I"@return [Object];T;%0;"@?;&0;'F;(i ;[[I"key[, default];T0;"@?o;
; I"
overload;F; 0;;; 0; I"fetch(key);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"key;T;"@?o;!
; I" return;F; I" ;T;0; [I" Object;T;"@?;#[ ;$I"$@yield [ key ]
@return [Object];T;%0;"@?;&0;'F;(i ;[[I"key;T0;"@?;#[ ;$I"Returns a value from the hash for the given key. If the key can't be
found, there are several options: With no other arguments, it will
raise an KeyError exception; if default is
given, then that will be returned; if the optional code block is
specified, then that will be run and its result returned.
h = { "a" => 100, "b" => 200 }
h.fetch("a") #=> 100
h.fetch("z", "go fish") #=> "go fish"
h.fetch("z") { |el| "go fish, #{el}"} #=> "go fish, z"
The following example shows that an exception is raised if the key
is not found and a default value is not supplied.
h = { "a" => 100, "b" => 200 }
h.fetch("z")
produces:
prog.rb:2:in `fetch': key not found (KeyError)
from prog.rb:2
@overload fetch(key [, default] )
@return [Object]
@overload fetch(key)
@yield [ key ]
@return [Object];T;%0;"@?;'F;)o;*;+T;,i5;-iQ;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_fetch_m(int argc, VALUE *argv, VALUE hash)
{
VALUE key;
st_data_t val;
long block_given;
rb_check_arity(argc, 1, 2);
key = argv[0];
block_given = rb_block_given_p();
if (block_given && argc == 2) {
rb_warn("block supersedes default value argument");
}
if (!RHASH(hash)->ntbl || !st_lookup(RHASH(hash)->ntbl, key, &val)) {
if (block_given) return rb_yield(key);
if (argc == 1) {
VALUE desc = rb_protect(rb_inspect, key, 0);
if (NIL_P(desc)) {
desc = rb_any_to_s(key);
}
desc = rb_str_ellipsize(desc, 65);
rb_raise(rb_eKeyError, "key not found: %"PRIsVALUE, desc);
}
return argv[1];
}
return (VALUE)val;
};T;0To;
; F; ;
;;;I"
Hash#[]=;F;[ ;[ ;F;;X;;X;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@?;.@>;0To;
; F; ;
;;;I"Hash#store;F;[ ;[ ;F;:
store;;X;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@ @;.@>;0To;
; F; ;
;;;I"Hash#default;F;[[@0;[[@ >i;T;: default;0;[ ;{ ;IC;"Returns the default value, the value that would be returned by
hsh[key] if key did not exist in hsh.
See also Hash::new and Hash#default=.
h = Hash.new #=> {}
h.default #=> nil
h.default(2) #=> nil
h = Hash.new("cat") #=> {}
h.default #=> "cat"
h.default(2) #=> "cat"
h = Hash.new {|h,k| h[k] = k.to_i*10} #=> {}
h.default #=> nil
h.default(2) #=> 20
;T;[o;
; I"
overload;F; 0;;; 0; I"default(key=nil);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@ @;#[ ;$I"@return [Object];T;%0;"@ @;&0;'F;(i ;[[I"key;TI"nil;T;"@ @;#[ ;$I"Returns the default value, the value that would be returned by
hsh[key] if key did not exist in hsh.
See also Hash::new and Hash#default=.
h = Hash.new #=> {}
h.default #=> nil
h.default(2) #=> nil
h = Hash.new("cat") #=> {}
h.default #=> "cat"
h.default(2) #=> "cat"
h = Hash.new {|h,k| h[k] = k.to_i*10} #=> {}
h.default #=> nil
h.default(2) #=> 20
@overload default(key=nil)
@return [Object];T;%0;"@ @;'F;)o;*;+T;,iu;-i;.@>; I"static VALUE;T;/I"Wstatic VALUE
rb_hash_default(int argc, VALUE *argv, VALUE hash)
{
VALUE args[2], ifnone;
rb_check_arity(argc, 0, 1);
ifnone = RHASH_IFNONE(hash);
if (FL_TEST(hash, HASH_PROC_DEFAULT)) {
if (argc == 0) return Qnil;
args[0] = hash;
args[1] = argv[0];
return rb_funcallv(ifnone, id_yield, 2, args);
}
return ifnone;
};T;0To;
; F; ;
;;;I"Hash#default=;F;[[I" ifnone;T0;[[@ >i;T;:
default=;0;[ ;{ ;IC;"Sets the default value, the value returned for a key that does not
exist in the hash. It is not possible to set the default to a
Proc that will be executed on each key lookup.
h = { "a" => 100, "b" => 200 }
h.default = "Go fish"
h["a"] #=> 100
h["z"] #=> "Go fish"
# This doesn't do what you might hope...
h.default = proc do |hash, key|
hash[key] = key + key
end
h[2] #=> #
h["cat"] #=> #
;T;[o;
; I"
overload;F; 0;;; 0; I"default=(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@(@;#[ ;$I"@return [Object];T;%0;"@(@;&0;'F;(i ;[[I"obj;T0;"@(@;#[ ;$I"Sets the default value, the value returned for a key that does not
exist in the hash. It is not possible to set the default to a
Proc that will be executed on each key lookup.
h = { "a" => 100, "b" => 200 }
h.default = "Go fish"
h["a"] #=> 100
h["z"] #=> "Go fish"
# This doesn't do what you might hope...
h.default = proc do |hash, key|
hash[key] = key + key
end
h[2] #=> #
h["cat"] #=> #
@overload default=(obj)
@return [Object];T;%0;"@(@;'F;)o;*;+T;,i;-i;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_set_default(VALUE hash, VALUE ifnone)
{
rb_hash_modify_check(hash);
RHASH_SET_IFNONE(hash, ifnone);
FL_UNSET(hash, HASH_PROC_DEFAULT);
return ifnone;
};T;0To;
; F; ;
;;;I"Hash#default_proc;F;[ ;[[@ >i;T;:default_proc;0;[ ;{ ;IC;"MIf Hash::new was invoked with a block, return that
block, otherwise return nil.
h = Hash.new {|h,k| h[k] = k*k } #=> {}
p = h.default_proc #=> #
a = [] #=> []
p.call(a, 2)
a #=> [nil, nil, 4]
;T;[o;
; I"
overload;F; 0;;; 0; I"default_proc;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@G@;#[ ;$I"@return [Object];T;%0;"@G@;&0;'F;(i ;[ ;"@G@;#[ ;$I"yIf Hash::new was invoked with a block, return that
block, otherwise return nil.
h = Hash.new {|h,k| h[k] = k*k } #=> {}
p = h.default_proc #=> #
a = [] #=> []
p.call(a, 2)
a #=> [nil, nil, 4]
@overload default_proc
@return [Object];T;%0;"@G@;'F;)o;*;+T;,i;-i;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_default_proc(VALUE hash)
{
if (FL_TEST(hash, HASH_PROC_DEFAULT)) {
return RHASH_IFNONE(hash);
}
return Qnil;
};T;0To;
; F; ;
;;;I"Hash#default_proc=;F;[[I" proc;T0;[[@ >i;T;:default_proc=;0;[ ;{ ;IC;"Sets the default proc to be executed on each failed key lookup.
h.default_proc = proc do |hash, key|
hash[key] = key + key
end
h[2] #=> 4
h["cat"] #=> "catcat"
;T;[o;
; I"
overload;F; 0;;; 0; I" default_proc=(proc_obj);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@b@;&0;'F;(i ;[[I"
proc_obj;T0;"@b@;#[ ;$I"Sets the default proc to be executed on each failed key lookup.
h.default_proc = proc do |hash, key|
hash[key] = key + key
end
h[2] #=> 4
h["cat"] #=> "catcat"
@overload default_proc=(proc_obj);T;%0;"@b@;'F;)o;*;+T;,i;-i;.@>; I"
VALUE;T;/I"6VALUE
rb_hash_set_default_proc(VALUE hash, VALUE proc)
{
VALUE b;
rb_hash_modify_check(hash);
if (NIL_P(proc)) {
FL_UNSET(hash, HASH_PROC_DEFAULT);
RHASH_SET_IFNONE(hash, proc);
return proc;
}
b = rb_check_convert_type(proc, T_DATA, "Proc", "to_proc");
if (NIL_P(b) || !rb_obj_is_proc(b)) {
rb_raise(rb_eTypeError,
"wrong default_proc type %s (expected Proc)",
rb_obj_classname(proc));
}
proc = b;
default_proc_arity_check(proc);
RHASH_SET_IFNONE(hash, proc);
FL_SET(hash, HASH_PROC_DEFAULT);
return proc;
};T;0To;
; F; ;
;;;I"
Hash#key;F;[[I"
value;T0;[[@ >i;T;:key;0;[ ;{ ;IC;"Returns the key of an occurrence of a given value. If the value is
not found, returns nil.
h = { "a" => 100, "b" => 200, "c" => 300, "d" => 300 }
h.key(200) #=> "b"
h.key(300) #=> "c"
h.key(999) #=> nil
;T;[o;
; I"
overload;F; 0;;; 0; I"key(value);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@|@;&0;'F;(i ;[[I"
value;T0;"@|@;#[ ;$I"Returns the key of an occurrence of a given value. If the value is
not found, returns nil.
h = { "a" => 100, "b" => 200, "c" => 300, "d" => 300 }
h.key(200) #=> "b"
h.key(300) #=> "c"
h.key(999) #=> nil
@overload key(value);T;%0;"@|@;'F;)o;*;+T;,i ;-i
;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_key(VALUE hash, VALUE value)
{
VALUE args[2];
args[0] = value;
args[1] = Qnil;
rb_hash_foreach(hash, key_i, (VALUE)args);
return args[1];
};T;0To;
; F; ;
;;;I"Hash#index;F;[[I"
value;T0;[[@ >i ;T;;a;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@@;'F;)o;*;+T;,i;-i;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_index(VALUE hash, VALUE value)
{
rb_warn("Hash#index is deprecated; use Hash#key");
return rb_hash_key(hash, value);
};T;0To;
; F; ;
;;;I"Hash#size;F;[ ;[[@ >ih;T;;[;0;[ ;{ ;IC;"Returns the number of key-value pairs in the hash.
h = { "d" => 100, "a" => 200, "v" => 300, "e" => 400 }
h.length #=> 4
h.delete("a") #=> 200
h.length #=> 3
;T;[o;
; I"
overload;F; 0;;Z; 0; I" length;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;T;"@@;#[ ;$I"@return [Fixnum];T;%0;"@@;&0;'F;(i ;[ ;"@@o;
; I"
overload;F; 0;;[; 0; I" size;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;T;"@@;#[ ;$I"@return [Fixnum];T;%0;"@@;&0;'F;(i ;[ ;"@@;#[ ;$I"Returns the number of key-value pairs in the hash.
h = { "d" => 100, "a" => 200, "v" => 300, "e" => 400 }
h.length #=> 4
h.delete("a") #=> 200
h.length #=> 3
@overload length
@return [Fixnum]
@overload size
@return [Fixnum];T;%0;"@@;'F;)o;*;+T;,i[;-if;.@>; I"
VALUE;T;/I"MVALUE
rb_hash_size(VALUE hash)
{
return INT2FIX(RHASH_SIZE(hash));
};T;0To;
; F; ;
;;;I"Hash#length;F;[ ;[[@ >ih;T;;Z;0;[ ;{ ;IC;"Returns the number of key-value pairs in the hash.
h = { "d" => 100, "a" => 200, "v" => 300, "e" => 400 }
h.length #=> 4
h.delete("a") #=> 200
h.length #=> 3
;T;[o;
; I"
overload;F; 0;;Z; 0; I" length;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;T;"@@;#[ ;$I"@return [Fixnum];T;%0;"@@;&0;'F;(i ;[ ;"@@o;
; I"
overload;F; 0;;[; 0; I" size;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;T;"@@;#[ ;$I"@return [Fixnum];T;%0;"@@;&0;'F;(i ;[ ;"@@;#[ ;$@@;%0;"@@;'F;)o;*;+T;,i[;-if;.@>; I"
VALUE;T;/I"MVALUE
rb_hash_size(VALUE hash)
{
return INT2FIX(RHASH_SIZE(hash));
};T;0To;
; F; ;
;;;I"Hash#empty?;F;[ ;[[@ >iy;T;;];0;[ ;{ ;IC;"bReturns true if hsh contains no key-value pairs.
{}.empty? #=> true
;T;[o;
; I"
overload;F; 0;;]; 0; I" empty?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@@;#[ ;$I"@return [Boolean];T;%0;"@@;&0;'F;(i ;[ ;"@@o;!
; I" return;F; @;0; [@;"@@;#[ ;$I"Returns true if hsh contains no key-value pairs.
{}.empty? #=> true
@overload empty?
@return [Boolean];T;%0;"@@;'F;)o;*;+T;,io;-iv;.@>; I"static VALUE;T;/I"bstatic VALUE
rb_hash_empty_p(VALUE hash)
{
return RHASH_EMPTY_P(hash) ? Qtrue : Qfalse;
};T;0To;
; F; ;
;;;I"Hash#each_value;F;[ ;[[@ >i;T;:each_value;0;[ ;{ ;IC;"Calls block once for each key in hsh, passing the
value as a parameter.
If no block is given, an enumerator is returned instead.
h = { "a" => 100, "b" => 200 }
h.each_value {|value| puts value }
produces:
100
200
;T;[o;
; I"
overload;F; 0;;; 0; I"each_value;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"
value;T;"@Ao;!
; I" return;F; I" ;T;0; [I" Hash;T;"@A;#[ ;$I"$@yield [ value ]
@return [Hash];T;%0;"@A;&0;'F;(i ;[ ;"@Ao;
; I"
overload;F; 0;;; 0; I"each_value;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@A;&0;'F;(i ;[ ;"@A;#[ ;$I"KCalls block once for each key in hsh, passing the
value as a parameter.
If no block is given, an enumerator is returned instead.
h = { "a" => 100, "b" => 200 }
h.each_value {|value| puts value }
produces:
100
200
@overload each_value
@yield [ value ]
@return [Hash]
@overload each_value;T;%0;"@A;'F;)o;*;+T;,i;-i;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_each_value(VALUE hash)
{
RETURN_SIZED_ENUMERATOR(hash, 0, 0, hash_enum_size);
rb_hash_foreach(hash, each_value_i, 0);
return hash;
};T;0To;
; F; ;
;;;I"Hash#each_key;F;[ ;[[@ >i;T;:
each_key;0;[ ;{ ;IC;"Calls block once for each key in hsh, passing the key
as a parameter.
If no block is given, an enumerator is returned instead.
h = { "a" => 100, "b" => 200 }
h.each_key {|key| puts key }
produces:
a
b
;T;[o;
; I"
overload;F; 0;;; 0; I"
each_key;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"key;T;"@;Ao;!
; I" return;F; I" ;T;0; [I" Hash;T;"@;A;#[ ;$I""@yield [ key ]
@return [Hash];T;%0;"@;A;&0;'F;(i ;[ ;"@;Ao;
; I"
overload;F; 0;;; 0; I"
each_key;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@;A;&0;'F;(i ;[ ;"@;A;#[ ;$I"9Calls block once for each key in hsh, passing the key
as a parameter.
If no block is given, an enumerator is returned instead.
h = { "a" => 100, "b" => 200 }
h.each_key {|key| puts key }
produces:
a
b
@overload each_key
@yield [ key ]
@return [Hash]
@overload each_key;T;%0;"@;A;'F;)o;*;+T;,i;-i;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_each_key(VALUE hash)
{
RETURN_SIZED_ENUMERATOR(hash, 0, 0, hash_enum_size);
rb_hash_foreach(hash, each_key_i, 0);
return hash;
};T;0To;
; F; ;
;;;I"Hash#each_pair;F;[ ;[[@ >i;T;:each_pair;0;[ ;{ ;IC;"Calls block once for each key in hsh, passing the key-value
pair as parameters.
If no block is given, an enumerator is returned instead.
h = { "a" => 100, "b" => 200 }
h.each {|key, value| puts "#{key} is #{value}" }
produces:
a is 100
b is 200
;T;[ o;
; I"
overload;F; 0;: each; 0; I" each;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"key;TI"
value;T;"@cAo;!
; I" return;F; I" ;T;0; [I" Hash;T;"@cA;#[ ;$I")@yield [ key, value ]
@return [Hash];T;%0;"@cA;&0;'F;(i ;[ ;"@cAo;
; I"
overload;F; 0;;; 0; I"each_pair;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"key;TI"
value;T;"@cAo;!
; I" return;F; I" ;T;0; [I" Hash;T;"@cA;#[ ;$I")@yield [ key, value ]
@return [Hash];T;%0;"@cA;&0;'F;(i ;[ ;"@cAo;
; I"
overload;F; 0;;; 0; I" each;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@cA;&0;'F;(i ;[ ;"@cAo;
; I"
overload;F; 0;;; 0; I"each_pair;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@cA;&0;'F;(i ;[ ;"@cA;#[ ;$I"Calls block once for each key in hsh, passing the key-value
pair as parameters.
If no block is given, an enumerator is returned instead.
h = { "a" => 100, "b" => 200 }
h.each {|key, value| puts "#{key} is #{value}" }
produces:
a is 100
b is 200
@overload each
@yield [ key, value ]
@return [Hash]
@overload each_pair
@yield [ key, value ]
@return [Hash]
@overload each
@overload each_pair;T;%0;"@cA;'F;)o;*;+T;,i;-i;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_each_pair(VALUE hash)
{
RETURN_SIZED_ENUMERATOR(hash, 0, 0, hash_enum_size);
if (rb_block_arity() > 1)
rb_hash_foreach(hash, each_pair_i_fast, 0);
else
rb_hash_foreach(hash, each_pair_i, 0);
return hash;
};T;0To;
; F; ;
;;;I"Hash#each;F;[ ;[[@ >i;T;;;0;[ ;{ ;IC;"Calls block once for each key in hsh, passing the key-value
pair as parameters.
If no block is given, an enumerator is returned instead.
h = { "a" => 100, "b" => 200 }
h.each {|key, value| puts "#{key} is #{value}" }
produces:
a is 100
b is 200
;T;[ o;
; I"
overload;F; 0;;; 0; I" each;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"key;TI"
value;T;"@Ao;!
; I" return;F; I" ;T;0; [I" Hash;T;"@A;#[ ;$I")@yield [ key, value ]
@return [Hash];T;%0;"@A;&0;'F;(i ;[ ;"@Ao;
; I"
overload;F; 0;;; 0; I"each_pair;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"key;TI"
value;T;"@Ao;!
; I" return;F; I" ;T;0; [I" Hash;T;"@A;#[ ;$I")@yield [ key, value ]
@return [Hash];T;%0;"@A;&0;'F;(i ;[ ;"@Ao;
; I"
overload;F; 0;;; 0; I" each;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@A;&0;'F;(i ;[ ;"@Ao;
; I"
overload;F; 0;;; 0; I"each_pair;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@A;&0;'F;(i ;[ ;"@A;#[ ;$@A;%0;"@A;'F;)o;*;+T;,i;-i;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_each_pair(VALUE hash)
{
RETURN_SIZED_ENUMERATOR(hash, 0, 0, hash_enum_size);
if (rb_block_arity() > 1)
rb_hash_foreach(hash, each_pair_i_fast, 0);
else
rb_hash_foreach(hash, each_pair_i, 0);
return hash;
};T;0To;
; F; ;
;;;I"Hash#keys;F;[ ;[[@ >i~;T;: keys;0;[ ;{ ;IC;"Returns a new array populated with the keys from this hash. See also
Hash#values.
h = { "a" => 100, "b" => 200, "c" => 300, "d" => 400 }
h.keys #=> ["a", "b", "c", "d"]
;T;[o;
; I"
overload;F; 0;;; 0; I" keys;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@A;#[ ;$I"@return [Array];T;%0;"@A;&0;'F;(i ;[ ;"@A;#[ ;$I"Returns a new array populated with the keys from this hash. See also
Hash#values.
h = { "a" => 100, "b" => 200, "c" => 300, "d" => 400 }
h.keys #=> ["a", "b", "c", "d"]
@overload keys
@return [Array];T;%0;"@A;'F;)o;*;+T;,ir;-i{;.@>; I"
VALUE;T;/I"VALUE
rb_hash_keys(VALUE hash)
{
VALUE keys;
st_index_t size = RHASH_SIZE(hash);
keys = rb_ary_new_capa(size);
if (size == 0) return keys;
if (ST_DATA_COMPATIBLE_P(VALUE)) {
st_table *table = RHASH(hash)->ntbl;
rb_gc_writebarrier_remember(keys);
RARRAY_PTR_USE(keys, ptr, {
size = st_keys_check(table, ptr, size, Qundef);
});
rb_ary_set_len(keys, size);
}
else {
rb_hash_foreach(hash, keys_i, keys);
}
return keys;
};T;0To;
; F; ;
;;;I"Hash#values;F;[ ;[[@ >i;T;: values;0;[ ;{ ;IC;"Returns a new array populated with the values from hsh. See
also Hash#keys.
h = { "a" => 100, "b" => 200, "c" => 300 }
h.values #=> [100, 200, 300]
;T;[o;
; I"
overload;F; 0;;; 0; I" values;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@B;#[ ;$I"@return [Array];T;%0;"@B;&0;'F;(i ;[ ;"@B;#[ ;$I"Returns a new array populated with the values from hsh. See
also Hash#keys.
h = { "a" => 100, "b" => 200, "c" => 300 }
h.values #=> [100, 200, 300]
@overload values
@return [Array];T;%0;"@B;'F;)o;*;+T;,i;-i;.@>; I"
VALUE;T;/I"VALUE
rb_hash_values(VALUE hash)
{
VALUE values;
st_index_t size = RHASH_SIZE(hash);
values = rb_ary_new_capa(size);
if (size == 0) return values;
if (ST_DATA_COMPATIBLE_P(VALUE)) {
st_table *table = RHASH(hash)->ntbl;
rb_gc_writebarrier_remember(values);
RARRAY_PTR_USE(values, ptr, {
size = st_values_check(table, ptr, size, Qundef);
});
rb_ary_set_len(values, size);
}
else {
rb_hash_foreach(hash, values_i, values);
}
return values;
};T;0To;
; F; ;
;;;I"Hash#values_at;F;[[@0;[[@ >i ;T;:values_at;0;[ ;{ ;IC;"Return an array containing the values associated with the given keys.
Also see Hash.select.
h = { "cat" => "feline", "dog" => "canine", "cow" => "bovine" }
h.values_at("cow", "cat") #=> ["bovine", "feline"]
;T;[o;
; I"
overload;F; 0;;; 0; I"values_at(key, ...);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@ B;#[ ;$I"@return [Array];T;%0;"@ B;&0;'F;(i ;[[I"key;T0[I"...;T0;"@ B;#[ ;$I"Return an array containing the values associated with the given keys.
Also see Hash.select.
h = { "cat" => "feline", "dog" => "canine", "cow" => "bovine" }
h.values_at("cow", "cat") #=> ["bovine", "feline"]
@overload values_at(key, ...)
@return [Array];T;%0;"@ B;'F;)o;*;+T;,i;-i;.@>; I"
VALUE;T;/I"VALUE
rb_hash_values_at(int argc, VALUE *argv, VALUE hash)
{
VALUE result = rb_ary_new2(argc);
long i;
for (i=0; ii:;T;:fetch_values;0;[ ;{ ;IC;"Returns an array containing the values associated with the given keys
but also raises KeyError when one of keys can't be found.
Also see Hash#values_at and Hash#fetch.
h = { "cat" => "feline", "dog" => "canine", "cow" => "bovine" }
h.fetch_values("cow", "cat") #=> ["bovine", "feline"]
h.fetch_values("cow", "bird") # raises KeyError
h.fetch_values("cow", "bird") { |k| k.upcase } #=> ["bovine", "BIRD"]
;T;[o;
; I"
overload;F; 0;;; 0; I"fetch_values(key, ...);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@@B;#[ ;$I"@return [Array];T;%0;"@@B;&0;'F;(i ;[[I"key;T0[I"...;T0;"@@Bo;
; I"
overload;F; 0;;; 0; I"fetch_values(key, ...);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"key;T;"@@Bo;!
; I" return;F; I" ;T;0; [I"
Array;T;"@@B;#[ ;$I"!@yield [key]
@return [Array];T;%0;"@@B;&0;'F;(i ;[[I"key;T0[I"...;T0;"@@B;#[ ;$I"^Returns an array containing the values associated with the given keys
but also raises KeyError when one of keys can't be found.
Also see Hash#values_at and Hash#fetch.
h = { "cat" => "feline", "dog" => "canine", "cow" => "bovine" }
h.fetch_values("cow", "cat") #=> ["bovine", "feline"]
h.fetch_values("cow", "bird") # raises KeyError
h.fetch_values("cow", "bird") { |k| k.upcase } #=> ["bovine", "BIRD"]
@overload fetch_values(key, ...)
@return [Array]
@overload fetch_values(key, ...)
@yield [key]
@return [Array];T;%0;"@@B;'F;)o;*;+T;,i*;-i9;.@>; I"
VALUE;T;/I"VALUE
rb_hash_fetch_values(int argc, VALUE *argv, VALUE hash)
{
VALUE result = rb_ary_new2(argc);
long i;
for (i=0; ii;T;:
shift;0;[ ;{ ;IC;"Removes a key-value pair from hsh and returns it as the
two-item array [ key, value ], or
the hash's default value if the hash is empty.
h = { 1 => "a", 2 => "b", 3 => "c" }
h.shift #=> [1, "a"]
h #=> {2=>"b", 3=>"c"}
;T;[o;
; I"
overload;F; 0;;; 0; I"
shift;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;TI" Object;T;"@vB;#[ ;$I" @return [Array, Object];T;%0;"@vB;&0;'F;(i ;[ ;"@vB;#[ ;$I"ARemoves a key-value pair from hsh and returns it as the
two-item array [ key, value ], or
the hash's default value if the hash is empty.
h = { 1 => "a", 2 => "b", 3 => "c" }
h.shift #=> [1, "a"]
h #=> {2=>"b", 3=>"c"}
@overload shift
@return [Array, Object];T;%0;"@vB;'F;)o;*;+T;,i;-i;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_shift(VALUE hash)
{
struct shift_var var;
rb_hash_modify_check(hash);
if (RHASH(hash)->ntbl) {
var.key = Qundef;
if (RHASH_ITER_LEV(hash) == 0) {
if (st_shift(RHASH(hash)->ntbl, &var.key, &var.val)) {
return rb_assoc_new(var.key, var.val);
}
}
else {
rb_hash_foreach(hash, shift_i_safe, (VALUE)&var);
if (var.key != Qundef) {
rb_hash_delete_entry(hash, var.key);
return rb_assoc_new(var.key, var.val);
}
}
}
return rb_hash_default_value(hash, Qnil);
};T;0To;
; F; ;
;;;I"Hash#delete;F;[[I"key;T0;[[@ >ia;T;;;0;[ ;{ ;IC;"Deletes the key-value pair and returns the value from hsh whose
key is equal to key. If the key is not found, it returns
nil. If the optional code block is given and the
key is not found, pass in the key and return the result of
block.
h = { "a" => 100, "b" => 200 }
h.delete("a") #=> 100
h.delete("z") #=> nil
h.delete("z") { |el| "#{el} not found" } #=> "z not found"
;T;[o;
; I"
overload;F; 0;;; 0; I"delete(key);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@B;&0;'F;(i ;[[I"key;T0;"@Bo;
; I"
overload;F; 0;;; 0; I"delete(key);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"key;T;"@B;#[ ;$I"@yield [ key ];T;%0;"@B;&0;'F;(i ;[[I"key;T0;"@B;#[ ;$I"Deletes the key-value pair and returns the value from hsh whose
key is equal to key. If the key is not found, it returns
nil. If the optional code block is given and the
key is not found, pass in the key and return the result of
block.
h = { "a" => 100, "b" => 200 }
h.delete("a") #=> 100
h.delete("z") #=> nil
h.delete("z") { |el| "#{el} not found" } #=> "z not found"
@overload delete(key)
@overload delete(key)
@yield [ key ];T;%0;"@B;'F;)o;*;+T;,iO;-i^;.@>; I"static VALUE;T;/I"'static VALUE
rb_hash_delete_m(VALUE hash, VALUE key)
{
VALUE val;
rb_hash_modify_check(hash);
val = rb_hash_delete_entry(hash, key);
if (val != Qundef) {
return val;
}
else {
if (rb_block_given_p()) {
return rb_yield(key);
}
else {
return Qnil;
}
}
};T;0To;
; F; ;
;;;I"Hash#delete_if;F;[ ;[[@ >i;T;:delete_if;0;[ ;{ ;IC;"Deletes every key-value pair from hsh for which block
evaluates to true.
If no block is given, an enumerator is returned instead.
h = { "a" => 100, "b" => 200, "c" => 300 }
h.delete_if {|key, value| key >= "b" } #=> {"a"=>100}
;T;[o;
; I"
overload;F; 0;;; 0; I"delete_if;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"key;TI"
value;T;"@Bo;!
; I" return;F; I" ;T;0; [I" Hash;T;"@B;#[ ;$I")@yield [ key, value ]
@return [Hash];T;%0;"@B;&0;'F;(i ;[ ;"@Bo;
; I"
overload;F; 0;;; 0; I"delete_if;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@B;&0;'F;(i ;[ ;"@B;#[ ;$I"[Deletes every key-value pair from hsh for which block
evaluates to true.
If no block is given, an enumerator is returned instead.
h = { "a" => 100, "b" => 200, "c" => 300 }
h.delete_if {|key, value| key >= "b" } #=> {"a"=>100}
@overload delete_if
@yield [ key, value ]
@return [Hash]
@overload delete_if;T;%0;"@B;'F;)o;*;+T;,i;-i;.@>; I"
VALUE;T;/I"VALUE
rb_hash_delete_if(VALUE hash)
{
RETURN_SIZED_ENUMERATOR(hash, 0, 0, hash_enum_size);
rb_hash_modify_check(hash);
if (RHASH(hash)->ntbl)
rb_hash_foreach(hash, delete_if_i, hash);
return hash;
};T;0To;
; F; ;
;;;I"Hash#keep_if;F;[ ;[[@ >i;T;: keep_if;0;[ ;{ ;IC;"Deletes every key-value pair from hsh for which block
evaluates to false.
If no block is given, an enumerator is returned instead.
;T;[o;
; I"
overload;F; 0;;; 0; I" keep_if;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"key;TI"
value;T;"@Bo;!
; I" return;F; I" ;T;0; [I" Hash;T;"@B;#[ ;$I")@yield [ key, value ]
@return [Hash];T;%0;"@B;&0;'F;(i ;[ ;"@Bo;
; I"
overload;F; 0;;; 0; I" keep_if;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@B;&0;'F;(i ;[ ;"@B;#[ ;$I"Deletes every key-value pair from hsh for which block
evaluates to false.
If no block is given, an enumerator is returned instead.
@overload keep_if
@yield [ key, value ]
@return [Hash]
@overload keep_if;T;%0;"@B;'F;)o;*;+T;,i;-i;.@>; I"
VALUE;T;/I"VALUE
rb_hash_keep_if(VALUE hash)
{
RETURN_SIZED_ENUMERATOR(hash, 0, 0, hash_enum_size);
rb_hash_modify_check(hash);
if (RHASH(hash)->ntbl)
rb_hash_foreach(hash, keep_if_i, hash);
return hash;
};T;0To;
; F; ;
;;;I"Hash#select;F;[ ;[[@ >i];T;;;0;[ ;{ ;IC;"Returns a new hash consisting of entries for which the block returns true.
If no block is given, an enumerator is returned instead.
h = { "a" => 100, "b" => 200, "c" => 300 }
h.select {|k,v| k > "a"} #=> {"b" => 200, "c" => 300}
h.select {|k,v| v < 200} #=> {"a" => 100}
;T;[o;
; I"
overload;F; 0;;; 0; I" select;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"key;TI"
value;T;"@
Co;!
; I" return;F; I" ;T;0; [I" Hash;T;"@
C;#[ ;$I"'@yield [key, value]
@return [Hash];T;%0;"@
C;&0;'F;(i ;[ ;"@
Co;
; I"
overload;F; 0;;; 0; I" select;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@
C;&0;'F;(i ;[ ;"@
C;#[ ;$I"fReturns a new hash consisting of entries for which the block returns true.
If no block is given, an enumerator is returned instead.
h = { "a" => 100, "b" => 200, "c" => 300 }
h.select {|k,v| k > "a"} #=> {"b" => 200, "c" => 300}
h.select {|k,v| v < 200} #=> {"a" => 100}
@overload select
@yield [key, value]
@return [Hash]
@overload select;T;%0;"@
C;'F;)o;*;+T;,iO;-i[;.@>; I"
VALUE;T;/I"VALUE
rb_hash_select(VALUE hash)
{
VALUE result;
RETURN_SIZED_ENUMERATOR(hash, 0, 0, hash_enum_size);
result = rb_hash_new();
if (!RHASH_EMPTY_P(hash)) {
rb_hash_foreach(hash, select_i, result);
}
return result;
};T;0To;
; F; ;
;;;I"Hash#select!;F;[ ;[[@ >i|;T;: select!;0;[ ;{ ;IC;"cEquivalent to Hash#keep_if, but returns
nil if no changes were made.
;T;[o;
; I"
overload;F; 0;;; 0; I" select!;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"key;TI"
value;T;"@6Co;!
; I" return;F; I" ;T;0; [I" Hash;TI"nil;T;"@6C;#[ ;$I".@yield [ key, value ]
@return [Hash, nil];T;%0;"@6C;&0;'F;(i ;[ ;"@6Co;
; I"
overload;F; 0;;; 0; I" select!;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@6C;&0;'F;(i ;[ ;"@6C;#[ ;$I"Equivalent to Hash#keep_if, but returns
nil if no changes were made.
@overload select!
@yield [ key, value ]
@return [Hash, nil]
@overload select!;T;%0;"@6C;'F;)o;*;+T;,is;-iz;.@>; I"
VALUE;T;/I"eVALUE
rb_hash_select_bang(VALUE hash)
{
st_index_t n;
RETURN_SIZED_ENUMERATOR(hash, 0, 0, hash_enum_size);
rb_hash_modify_check(hash);
if (!RHASH(hash)->ntbl)
return Qnil;
n = RHASH(hash)->ntbl->num_entries;
rb_hash_foreach(hash, keep_if_i, hash);
if (n == RHASH(hash)->ntbl->num_entries) return Qnil;
return hash;
};T;0To;
; F; ;
;;;I"Hash#reject;F;[ ;[[@ >i ;T;: reject;0;[ ;{ ;IC;" Returns a new hash consisting of entries for which the block returns false.
If no block is given, an enumerator is returned instead.
h = { "a" => 100, "b" => 200, "c" => 300 }
h.reject {|k,v| k < "b"} #=> {"b" => 200, "c" => 300}
h.reject {|k,v| v > 100} #=> {"a" => 100}
;T;[o;
; I"
overload;F; 0;;; 0; I" reject;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"key;TI"
value;T;"@`Co;!
; I" return;F; I" ;T;0; [I" Hash;T;"@`C;#[ ;$I"'@yield [key, value]
@return [Hash];T;%0;"@`C;&0;'F;(i ;[ ;"@`Co;
; I"
overload;F; 0;;; 0; I" reject;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@`C;&0;'F;(i ;[ ;"@`C;#[ ;$I"gReturns a new hash consisting of entries for which the block returns false.
If no block is given, an enumerator is returned instead.
h = { "a" => 100, "b" => 200, "c" => 300 }
h.reject {|k,v| k < "b"} #=> {"b" => 200, "c" => 300}
h.reject {|k,v| v > 100} #=> {"a" => 100}
@overload reject
@yield [key, value]
@return [Hash]
@overload reject;T;%0;"@`C;'F;)o;*;+T;,i;-i;.@>; I"
VALUE;T;/I"VALUE
rb_hash_reject(VALUE hash)
{
VALUE result;
RETURN_SIZED_ENUMERATOR(hash, 0, 0, hash_enum_size);
if (RTEST(ruby_verbose)) {
VALUE klass;
if (HAS_EXTRA_STATES(hash, klass)) {
rb_warn("extra states are no longer copied: %+"PRIsVALUE, hash);
}
}
result = rb_hash_new();
if (!RHASH_EMPTY_P(hash)) {
rb_hash_foreach(hash, reject_i, result);
}
return result;
};T;0To;
; F; ;
;;;I"Hash#reject!;F;[ ;[[@ >i;T;: reject!;0;[ ;{ ;IC;"eEquivalent to Hash#delete_if, but returns
nil if no changes were made.
;T;[o;
; I"
overload;F; 0;;; 0; I" reject!;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"key;TI"
value;T;"@Co;!
; I" return;F; I" ;T;0; [I" Hash;TI"nil;T;"@C;#[ ;$I".@yield [ key, value ]
@return [Hash, nil];T;%0;"@C;&0;'F;(i ;[ ;"@Co;
; I"
overload;F; 0;;; 0; I" reject!;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@C;&0;'F;(i ;[ ;"@C;#[ ;$I"Equivalent to Hash#delete_if, but returns
nil if no changes were made.
@overload reject!
@yield [ key, value ]
@return [Hash, nil]
@overload reject!;T;%0;"@C;'F;)o;*;+T;,i;-i;.@>; I"
VALUE;T;/I";VALUE
rb_hash_reject_bang(VALUE hash)
{
st_index_t n;
RETURN_SIZED_ENUMERATOR(hash, 0, 0, hash_enum_size);
rb_hash_modify(hash);
n = RHASH_SIZE(hash);
if (!n) return Qnil;
rb_hash_foreach(hash, delete_if_i, hash);
if (n == RHASH(hash)->ntbl->num_entries) return Qnil;
return hash;
};T;0To;
; F; ;
;;;I"Hash#clear;F;[ ;[[@ >i;T;;c;0;[ ;{ ;IC;"Removes all key-value pairs from hsh.
h = { "a" => 100, "b" => 200 } #=> {"a"=>100, "b"=>200}
h.clear #=> {}
;T;[o;
; I"
overload;F; 0;;c; 0; I"
clear;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@C;#[ ;$I"@return [Hash];T;%0;"@C;&0;'F;(i ;[ ;"@C;#[ ;$I"Removes all key-value pairs from hsh.
h = { "a" => 100, "b" => 200 } #=> {"a"=>100, "b"=>200}
h.clear #=> {}
@overload clear
@return [Hash];T;%0;"@C;'F;)o;*;+T;,i;-i;.@>; I"
VALUE;T;/I")VALUE
rb_hash_clear(VALUE hash)
{
rb_hash_modify_check(hash);
if (!RHASH(hash)->ntbl)
return hash;
if (RHASH(hash)->ntbl->num_entries > 0) {
if (RHASH_ITER_LEV(hash) > 0)
rb_hash_foreach(hash, clear_i, 0);
else
st_clear(RHASH(hash)->ntbl);
}
return hash;
};T;0To;
; F; ;
;;;I"Hash#invert;F;[ ;[[@ >i;T;: invert;0;[ ;{ ;IC;"eReturns a new hash created by using hsh's values as keys, and
the keys as values.
If a key with the same value already exists in the hsh, then
the last one defined will be used, the earlier value(s) will be discarded.
h = { "n" => 100, "m" => 100, "y" => 300, "d" => 200, "a" => 0 }
h.invert #=> {0=>"a", 100=>"m", 200=>"d", 300=>"y"}
;T;[o;
; I"
overload;F; 0;;; 0; I" invert;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@C;&0;'F;(i ;[ ;"@C;#[ ;$I"yReturns a new hash created by using hsh's values as keys, and
the keys as values.
If a key with the same value already exists in the hsh, then
the last one defined will be used, the earlier value(s) will be discarded.
h = { "n" => 100, "m" => 100, "y" => 300, "d" => 200, "a" => 0 }
h.invert #=> {0=>"a", 100=>"m", 200=>"d", 300=>"y"}
@overload invert;T;%0;"@C;'F;)o;*;+T;,i;-i;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_invert(VALUE hash)
{
VALUE h = rb_hash_new();
rb_hash_foreach(hash, rb_hash_invert_i, h);
return h;
};T;0To;
; F; ;
;;;I"Hash#update;F;[[I"
hash2;T0;[[@ >i ;T;: update;0;[ ;{ ;IC;"BAdds the contents of _other_hash_ to _hsh_. If no block is specified,
entries with duplicate keys are overwritten with the values from
_other_hash_, otherwise the value of each duplicate key is determined by
calling the block with the key, its value in _hsh_ and its value in
_other_hash_.
h1 = { "a" => 100, "b" => 200 }
h2 = { "b" => 254, "c" => 300 }
h1.merge!(h2) #=> {"a"=>100, "b"=>254, "c"=>300}
h1 = { "a" => 100, "b" => 200 }
h2 = { "b" => 254, "c" => 300 }
h1.merge!(h2) { |key, v1, v2| v1 }
#=> {"a"=>100, "b"=>200, "c"=>300}
;T;[ o;
; I"
overload;F; 0;: merge!; 0; I"merge!(other_hash);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@C;#[ ;$I"@return [Hash];T;%0;"@C;&0;'F;(i ;[[I"other_hash;T0;"@Co;
; I"
overload;F; 0;;; 0; I"update(other_hash);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@C;#[ ;$I"@return [Hash];T;%0;"@C;&0;'F;(i ;[[I"other_hash;T0;"@Co;
; I"
overload;F; 0;;; 0; I"merge!(other_hash);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"key;TI" oldval;TI" newval;T;"@Co;!
; I" return;F; I" ;T;0; [I" Hash;T;"@C;#[ ;$I"0@yield [key, oldval, newval]
@return [Hash];T;%0;"@C;&0;'F;(i ;[[I"other_hash;T0;"@Co;
; I"
overload;F; 0;;; 0; I"update(other_hash);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"key;TI" oldval;TI" newval;T;"@Co;!
; I" return;F; I" ;T;0; [I" Hash;T;"@C;#[ ;$I"0@yield [key, oldval, newval]
@return [Hash];T;%0;"@C;&0;'F;(i ;[[I"other_hash;T0;"@C;#[ ;$I":Adds the contents of _other_hash_ to _hsh_. If no block is specified,
entries with duplicate keys are overwritten with the values from
_other_hash_, otherwise the value of each duplicate key is determined by
calling the block with the key, its value in _hsh_ and its value in
_other_hash_.
h1 = { "a" => 100, "b" => 200 }
h2 = { "b" => 254, "c" => 300 }
h1.merge!(h2) #=> {"a"=>100, "b"=>254, "c"=>300}
h1 = { "a" => 100, "b" => 200 }
h2 = { "b" => 254, "c" => 300 }
h1.merge!(h2) { |key, v1, v2| v1 }
#=> {"a"=>100, "b"=>200, "c"=>300}
@overload merge!(other_hash)
@return [Hash]
@overload update(other_hash)
@return [Hash]
@overload merge!(other_hash)
@yield [key, oldval, newval]
@return [Hash]
@overload update(other_hash)
@yield [key, oldval, newval]
@return [Hash];T;%0;"@C;'F;)o;*;+T;,i;-i ;.@>; I"static VALUE;T;/I"!static VALUE
rb_hash_update(VALUE hash1, VALUE hash2)
{
rb_hash_modify(hash1);
hash2 = to_hash(hash2);
if (rb_block_given_p()) {
rb_hash_foreach(hash2, rb_hash_update_block_i, hash1);
}
else {
rb_hash_foreach(hash2, rb_hash_update_i, hash1);
}
return hash1;
};T;0To;
; F; ;
;;;I"Hash#replace;F;[[I"
hash2;T0;[[@ >iC;T;;T;0;[ ;{ ;IC;"Replaces the contents of hsh with the contents of
other_hash.
h = { "a" => 100, "b" => 200 }
h.replace({ "c" => 300, "d" => 400 }) #=> {"c"=>300, "d"=>400}
;T;[o;
; I"
overload;F; 0;;T; 0; I"replace(other_hash);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@>D;#[ ;$I"@return [Hash];T;%0;"@>D;&0;'F;(i ;[[I"other_hash;T0;"@>D;#[ ;$I"Replaces the contents of hsh with the contents of
other_hash.
h = { "a" => 100, "b" => 200 }
h.replace({ "c" => 300, "d" => 400 }) #=> {"c"=>300, "d"=>400}
@overload replace(other_hash)
@return [Hash];T;%0;"@>D;'F;)o;*;+T;,i7;-i@;.@>; I"static VALUE;T;/I" static VALUE
rb_hash_replace(VALUE hash, VALUE hash2)
{
st_table *table2;
rb_hash_modify_check(hash);
if (hash == hash2) return hash;
hash2 = to_hash(hash2);
RHASH_SET_IFNONE(hash, RHASH_IFNONE(hash2));
if (FL_TEST(hash2, HASH_PROC_DEFAULT))
FL_SET(hash, HASH_PROC_DEFAULT);
else
FL_UNSET(hash, HASH_PROC_DEFAULT);
table2 = RHASH(hash2)->ntbl;
rb_hash_clear(hash);
if (table2) hash_tbl(hash)->type = table2->type;
rb_hash_foreach(hash2, replace_i, hash);
return hash;
};T;0To;
; F; ;
;;;I"Hash#merge!;F;[[I"
hash2;T0;[[@ >i ;T;;;0;[ ;{ ;IC;"BAdds the contents of _other_hash_ to _hsh_. If no block is specified,
entries with duplicate keys are overwritten with the values from
_other_hash_, otherwise the value of each duplicate key is determined by
calling the block with the key, its value in _hsh_ and its value in
_other_hash_.
h1 = { "a" => 100, "b" => 200 }
h2 = { "b" => 254, "c" => 300 }
h1.merge!(h2) #=> {"a"=>100, "b"=>254, "c"=>300}
h1 = { "a" => 100, "b" => 200 }
h2 = { "b" => 254, "c" => 300 }
h1.merge!(h2) { |key, v1, v2| v1 }
#=> {"a"=>100, "b"=>200, "c"=>300}
;T;[ o;
; I"
overload;F; 0;;; 0; I"merge!(other_hash);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@]D;#[ ;$I"@return [Hash];T;%0;"@]D;&0;'F;(i ;[[I"other_hash;T0;"@]Do;
; I"
overload;F; 0;;; 0; I"update(other_hash);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@]D;#[ ;$I"@return [Hash];T;%0;"@]D;&0;'F;(i ;[[I"other_hash;T0;"@]Do;
; I"
overload;F; 0;;; 0; I"merge!(other_hash);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"key;TI" oldval;TI" newval;T;"@]Do;!
; I" return;F; I" ;T;0; [I" Hash;T;"@]D;#[ ;$I"0@yield [key, oldval, newval]
@return [Hash];T;%0;"@]D;&0;'F;(i ;[[I"other_hash;T0;"@]Do;
; I"
overload;F; 0;;; 0; I"update(other_hash);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"key;TI" oldval;TI" newval;T;"@]Do;!
; I" return;F; I" ;T;0; [I" Hash;T;"@]D;#[ ;$I"0@yield [key, oldval, newval]
@return [Hash];T;%0;"@]D;&0;'F;(i ;[[I"other_hash;T0;"@]D;#[ ;$@:D;%0;"@]D;'F;)o;*;+T;,i;-i ;.@>; I"static VALUE;T;/I"!static VALUE
rb_hash_update(VALUE hash1, VALUE hash2)
{
rb_hash_modify(hash1);
hash2 = to_hash(hash2);
if (rb_block_given_p()) {
rb_hash_foreach(hash2, rb_hash_update_block_i, hash1);
}
else {
rb_hash_foreach(hash2, rb_hash_update_i, hash1);
}
return hash1;
};T;0To;
; F; ;
;;;I"Hash#merge;F;[[I"
hash2;T0;[[@ >ib ;T;:
merge;0;[ ;{ ;IC;"qReturns a new hash containing the contents of other_hash and
the contents of hsh. If no block is specified, the value for
entries with duplicate keys will be that of other_hash. Otherwise
the value for each duplicate key is determined by calling the block
with the key, its value in hsh and its value in other_hash.
h1 = { "a" => 100, "b" => 200 }
h2 = { "b" => 254, "c" => 300 }
h1.merge(h2) #=> {"a"=>100, "b"=>254, "c"=>300}
h1.merge(h2){|key, oldval, newval| newval - oldval}
#=> {"a"=>100, "b"=>54, "c"=>300}
h1 #=> {"a"=>100, "b"=>200}
;T;[o;
; I"
overload;F; 0;;; 0; I"merge(other_hash);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@D;&0;'F;(i ;[[I"other_hash;T0;"@Do;
; I"
overload;F; 0;;; 0; I"merge(other_hash);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"key;TI" oldval;TI" newval;T;"@D;#[ ;$I"!@yield [key, oldval, newval];T;%0;"@D;&0;'F;(i ;[[I"other_hash;T0;"@D;#[ ;$I"Returns a new hash containing the contents of other_hash and
the contents of hsh. If no block is specified, the value for
entries with duplicate keys will be that of other_hash. Otherwise
the value for each duplicate key is determined by calling the block
with the key, its value in hsh and its value in other_hash.
h1 = { "a" => 100, "b" => 200 }
h2 = { "b" => 254, "c" => 300 }
h1.merge(h2) #=> {"a"=>100, "b"=>254, "c"=>300}
h1.merge(h2){|key, oldval, newval| newval - oldval}
#=> {"a"=>100, "b"=>54, "c"=>300}
h1 #=> {"a"=>100, "b"=>200}
@overload merge(other_hash)
@overload merge(other_hash)
@yield [key, oldval, newval];T;%0;"@D;'F;)o;*;+T;,iN ;-i_ ;.@>; I"static VALUE;T;/I"rstatic VALUE
rb_hash_merge(VALUE hash1, VALUE hash2)
{
return rb_hash_update(rb_obj_dup(hash1), hash2);
};T;0To;
; F; ;
;;;I"Hash#assoc;F;[[I"key;T0;[[@ >i ;T;:
assoc;0;[ ;{ ;IC;"iSearches through the hash comparing _obj_ with the key using ==.
Returns the key-value pair (two elements array) or +nil+
if no match is found. See Array#assoc.
h = {"colors" => ["red", "blue", "green"],
"letters" => ["a", "b", "c" ]}
h.assoc("letters") #=> ["letters", ["a", "b", "c"]]
h.assoc("foo") #=> nil
;T;[o;
; I"
overload;F; 0;;; 0; I"assoc(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;TI"nil;T;"@D;#[ ;$I"@return [Array, nil];T;%0;"@D;&0;'F;(i ;[[I"obj;T0;"@D;#[ ;$I"Searches through the hash comparing _obj_ with the key using ==.
Returns the key-value pair (two elements array) or +nil+
if no match is found. See Array#assoc.
h = {"colors" => ["red", "blue", "green"],
"letters" => ["a", "b", "c" ]}
h.assoc("letters") #=> ["letters", ["a", "b", "c"]]
h.assoc("foo") #=> nil
@overload assoc(obj)
@return [Array, nil];T;%0;"@D;'F;)o;*;+T;,i ;-i ;.@>; I"
VALUE;T;/I"VALUE
rb_hash_assoc(VALUE hash, VALUE key)
{
st_table *table;
const struct st_hash_type *orighash;
VALUE args[2];
if (RHASH_EMPTY_P(hash)) return Qnil;
table = RHASH(hash)->ntbl;
orighash = table->type;
if (orighash != &identhash) {
VALUE value;
struct reset_hash_type_arg ensure_arg;
struct st_hash_type assochash;
assochash.compare = assoc_cmp;
assochash.hash = orighash->hash;
table->type = &assochash;
args[0] = hash;
args[1] = key;
ensure_arg.hash = hash;
ensure_arg.orighash = orighash;
value = rb_ensure(lookup2_call, (VALUE)&args, reset_hash_type, (VALUE)&ensure_arg);
if (value != Qundef) return rb_assoc_new(key, value);
}
args[0] = key;
args[1] = Qnil;
rb_hash_foreach(hash, assoc_i, (VALUE)args);
return args[1];
};T;0To;
; F; ;
;;;I"Hash#rassoc;F;[[I"obj;T0;[[@ >i ;T;: rassoc;0;[ ;{ ;IC;"6Searches through the hash comparing _obj_ with the value using ==.
Returns the first key-value pair (two-element array) that matches. See
also Array#rassoc.
a = {1=> "one", 2 => "two", 3 => "three", "ii" => "two"}
a.rassoc("two") #=> [2, "two"]
a.rassoc("four") #=> nil
;T;[o;
; I"
overload;F; 0;;; 0; I"rassoc(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;TI"nil;T;"@E;#[ ;$I"@return [Array, nil];T;%0;"@E;&0;'F;(i ;[[I"obj;T0;"@E;#[ ;$I"eSearches through the hash comparing _obj_ with the value using ==.
Returns the first key-value pair (two-element array) that matches. See
also Array#rassoc.
a = {1=> "one", 2 => "two", 3 => "three", "ii" => "two"}
a.rassoc("two") #=> [2, "two"]
a.rassoc("four") #=> nil
@overload rassoc(obj)
@return [Array, nil];T;%0;"@E;'F;)o;*;+T;,i ;-i ;.@>; I"
VALUE;T;/I"VALUE
rb_hash_rassoc(VALUE hash, VALUE obj)
{
VALUE args[2];
args[0] = obj;
args[1] = Qnil;
rb_hash_foreach(hash, rassoc_i, (VALUE)args);
return args[1];
};T;0To;
; F; ;
;;;I"Hash#flatten;F;[[@0;[[@ >i ;T;: flatten;0;[ ;{ ;IC;"Returns a new array that is a one-dimensional flattening of this
hash. That is, for every key or value that is an array, extract
its elements into the new array. Unlike Array#flatten, this
method does not flatten recursively by default. The optional
level argument determines the level of recursion to flatten.
a = {1=> "one", 2 => [2,"two"], 3 => "three"}
a.flatten # => [1, "one", 2, [2, "two"], 3, "three"]
a.flatten(2) # => [1, "one", 2, 2, "two", 3, "three"]
;T;[o;
; I"
overload;F; 0;;; 0; I" flatten;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@!E;#[ ;$I"@return [Array];T;%0;"@!E;&0;'F;(i ;[ ;"@!Eo;
; I"
overload;F; 0;;; 0; I"flatten(level);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@!E;#[ ;$I"@return [Array];T;%0;"@!E;&0;'F;(i ;[[I"
level;T0;"@!E;#[ ;$I"7Returns a new array that is a one-dimensional flattening of this
hash. That is, for every key or value that is an array, extract
its elements into the new array. Unlike Array#flatten, this
method does not flatten recursively by default. The optional
level argument determines the level of recursion to flatten.
a = {1=> "one", 2 => [2,"two"], 3 => "three"}
a.flatten # => [1, "one", 2, [2, "two"], 3, "three"]
a.flatten(2) # => [1, "one", 2, 2, "two", 3, "three"]
@overload flatten
@return [Array]
@overload flatten(level)
@return [Array];T;%0;"@!E;'F;)o;*;+T;,i ;-i ;.@>; I"static VALUE;T;/I"7static VALUE
rb_hash_flatten(int argc, VALUE *argv, VALUE hash)
{
VALUE ary;
if (argc) {
int level = NUM2INT(*argv);
if (level == 0) return rb_hash_to_a(hash);
ary = rb_ary_new_capa(RHASH_SIZE(hash) * 2);
rb_hash_foreach(hash, flatten_i, ary);
if (level - 1 > 0) {
*argv = INT2FIX(level - 1);
rb_funcall2(ary, id_flatten_bang, argc, argv);
}
else if (level < 0) {
rb_funcall2(ary, id_flatten_bang, 0, 0);
}
}
else {
ary = rb_ary_new_capa(RHASH_SIZE(hash) * 2);
rb_hash_foreach(hash, flatten_i, ary);
}
return ary;
};T;0To;
; F; ;
;;;I"Hash#include?;F;[[I"key;T0;[[@ >i;T;;;0;[ ;{ ;IC;"GReturns true if the given key is present in hsh.
h = { "a" => 100, "b" => 200 }
h.has_key?("a") #=> true
h.has_key?("z") #=> false
Note that include? and member? do not test member
equality using == as do other Enumerables.
See also Enumerable#include?
;T;[
o;
; I"
overload;F; 0;:
has_key?; 0; I"has_key?(key);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@LE;#[ ;$I"@return [Boolean];T;%0;"@LE;&0;'F;(i ;[[I"key;T0;"@LEo;
; I"
overload;F; 0;;; 0; I"include?(key);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@LE;#[ ;$I"@return [Boolean];T;%0;"@LE;&0;'F;(i ;[[I"key;T0;"@LEo;
; I"
overload;F; 0;: key?; 0; I"key?(key);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@LE;#[ ;$I"@return [Boolean];T;%0;"@LE;&0;'F;(i ;[[I"key;T0;"@LEo;
; I"
overload;F; 0;: member?; 0; I"member?(key);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@LE;#[ ;$I"@return [Boolean];T;%0;"@LE;&0;'F;(i ;[[I"key;T0;"@LEo;!
; I" return;F; @;0; [@;"@LE;#[ ;$I"Returns true if the given key is present in hsh.
h = { "a" => 100, "b" => 200 }
h.has_key?("a") #=> true
h.has_key?("z") #=> false
Note that include? and member? do not test member
equality using == as do other Enumerables.
See also Enumerable#include?
@overload has_key?(key)
@return [Boolean]
@overload include?(key)
@return [Boolean]
@overload key?(key)
@return [Boolean]
@overload member?(key)
@return [Boolean];T;%0;"@LE;'F;)o;*;+T;,i;-i;.@>; I"
VALUE;T;/I"VALUE
rb_hash_has_key(VALUE hash, VALUE key)
{
if (!RHASH(hash)->ntbl)
return Qfalse;
if (st_lookup(RHASH(hash)->ntbl, key, 0)) {
return Qtrue;
}
return Qfalse;
};T;0To;
; F; ;
;;;I"Hash#member?;F;[[I"key;T0;[[@ >i;T;;;0;[ ;{ ;IC;"GReturns true if the given key is present in hsh.
h = { "a" => 100, "b" => 200 }
h.has_key?("a") #=> true
h.has_key?("z") #=> false
Note that include? and member? do not test member
equality using == as do other Enumerables.
See also Enumerable#include?
;T;[
o;
; I"
overload;F; 0;;; 0; I"has_key?(key);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@E;#[ ;$I"@return [Boolean];T;%0;"@E;&0;'F;(i ;[[I"key;T0;"@Eo;
; I"
overload;F; 0;;; 0; I"include?(key);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@E;#[ ;$I"@return [Boolean];T;%0;"@E;&0;'F;(i ;[[I"key;T0;"@Eo;
; I"
overload;F; 0;;; 0; I"key?(key);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@E;#[ ;$I"@return [Boolean];T;%0;"@E;&0;'F;(i ;[[I"key;T0;"@Eo;
; I"
overload;F; 0;;; 0; I"member?(key);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@E;#[ ;$I"@return [Boolean];T;%0;"@E;&0;'F;(i ;[[I"key;T0;"@Eo;!
; I" return;F; @;0; [@;"@E;#[ ;$@E;%0;"@E;'F;)o;*;+T;,i;-i;.@>; I"
VALUE;T;/I"VALUE
rb_hash_has_key(VALUE hash, VALUE key)
{
if (!RHASH(hash)->ntbl)
return Qfalse;
if (st_lookup(RHASH(hash)->ntbl, key, 0)) {
return Qtrue;
}
return Qfalse;
};T;0To;
; F; ;
;;;I"Hash#has_key?;F;[[I"key;T0;[[@ >i;T;;;0;[ ;{ ;IC;"GReturns true if the given key is present in hsh.
h = { "a" => 100, "b" => 200 }
h.has_key?("a") #=> true
h.has_key?("z") #=> false
Note that include? and member? do not test member
equality using == as do other Enumerables.
See also Enumerable#include?
;T;[
o;
; I"
overload;F; 0;;; 0; I"has_key?(key);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@E;#[ ;$I"@return [Boolean];T;%0;"@E;&0;'F;(i ;[[I"key;T0;"@Eo;
; I"
overload;F; 0;;; 0; I"include?(key);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@E;#[ ;$I"@return [Boolean];T;%0;"@E;&0;'F;(i ;[[I"key;T0;"@Eo;
; I"
overload;F; 0;;; 0; I"key?(key);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@E;#[ ;$I"@return [Boolean];T;%0;"@E;&0;'F;(i ;[[I"key;T0;"@Eo;
; I"
overload;F; 0;;; 0; I"member?(key);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@E;#[ ;$I"@return [Boolean];T;%0;"@E;&0;'F;(i ;[[I"key;T0;"@Eo;!
; I" return;F; @;0; [@;"@E;#[ ;$@E;%0;"@E;'F;)o;*;+T;,i;-i;.@>; I"
VALUE;T;/I"VALUE
rb_hash_has_key(VALUE hash, VALUE key)
{
if (!RHASH(hash)->ntbl)
return Qfalse;
if (st_lookup(RHASH(hash)->ntbl, key, 0)) {
return Qtrue;
}
return Qfalse;
};T;0To;
; F; ;
;;;I"Hash#has_value?;F;[[I"val;T0;[[@ >i;T;:has_value?;0;[ ;{ ;IC;"Returns true if the given value is present for some key
in hsh.
h = { "a" => 100, "b" => 200 }
h.has_value?(100) #=> true
h.has_value?(999) #=> false
;T;[o;
; I"
overload;F; 0;;; 0; I"has_value?(value);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@7F;#[ ;$I"@return [Boolean];T;%0;"@7F;&0;'F;(i ;[[I"
value;T0;"@7Fo;
; I"
overload;F; 0;: value?; 0; I"value?(value);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@7F;#[ ;$I"@return [Boolean];T;%0;"@7F;&0;'F;(i ;[[I"
value;T0;"@7Fo;!
; I" return;F; @;0; [@;"@7F;#[ ;$I"Returns true if the given value is present for some key
in hsh.
h = { "a" => 100, "b" => 200 }
h.has_value?(100) #=> true
h.has_value?(999) #=> false
@overload has_value?(value)
@return [Boolean]
@overload value?(value)
@return [Boolean];T;%0;"@7F;'F;)o;*;+T;,i;-i;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_has_value(VALUE hash, VALUE val)
{
VALUE data[2];
data[0] = Qfalse;
data[1] = val;
rb_hash_foreach(hash, rb_hash_search_value, (VALUE)data);
return data[0];
};T;0To;
; F; ;
;;;I"Hash#key?;F;[[I"key;T0;[[@ >i;T;;;0;[ ;{ ;IC;"GReturns true if the given key is present in hsh.
h = { "a" => 100, "b" => 200 }
h.has_key?("a") #=> true
h.has_key?("z") #=> false
Note that include? and member? do not test member
equality using == as do other Enumerables.
See also Enumerable#include?
;T;[
o;
; I"
overload;F; 0;;; 0; I"has_key?(key);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@hF;#[ ;$I"@return [Boolean];T;%0;"@hF;&0;'F;(i ;[[I"key;T0;"@hFo;
; I"
overload;F; 0;;; 0; I"include?(key);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@hF;#[ ;$I"@return [Boolean];T;%0;"@hF;&0;'F;(i ;[[I"key;T0;"@hFo;
; I"
overload;F; 0;;; 0; I"key?(key);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@hF;#[ ;$I"@return [Boolean];T;%0;"@hF;&0;'F;(i ;[[I"key;T0;"@hFo;
; I"
overload;F; 0;;; 0; I"member?(key);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@hF;#[ ;$I"@return [Boolean];T;%0;"@hF;&0;'F;(i ;[[I"key;T0;"@hFo;!
; I" return;F; @;0; [@;"@hF;#[ ;$@E;%0;"@hF;'F;)o;*;+T;,i;-i;.@>; I"
VALUE;T;/I"VALUE
rb_hash_has_key(VALUE hash, VALUE key)
{
if (!RHASH(hash)->ntbl)
return Qfalse;
if (st_lookup(RHASH(hash)->ntbl, key, 0)) {
return Qtrue;
}
return Qfalse;
};T;0To;
; F; ;
;;;I"Hash#value?;F;[[I"val;T0;[[@ >i;T;;;0;[ ;{ ;IC;"Returns true if the given value is present for some key
in hsh.
h = { "a" => 100, "b" => 200 }
h.has_value?(100) #=> true
h.has_value?(999) #=> false
;T;[o;
; I"
overload;F; 0;;; 0; I"has_value?(value);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@F;#[ ;$I"@return [Boolean];T;%0;"@F;&0;'F;(i ;[[I"
value;T0;"@Fo;
; I"
overload;F; 0;;; 0; I"value?(value);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@F;#[ ;$I"@return [Boolean];T;%0;"@F;&0;'F;(i ;[[I"
value;T0;"@Fo;!
; I" return;F; @;0; [@;"@F;#[ ;$@dF;%0;"@F;'F;)o;*;+T;,i;-i;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_has_value(VALUE hash, VALUE val)
{
VALUE data[2];
data[0] = Qfalse;
data[1] = val;
rb_hash_foreach(hash, rb_hash_search_value, (VALUE)data);
return data[0];
};T;0To;
; F; ;
;;;I" Hash#compare_by_identity;F;[ ;[[@ >i*
;T;:compare_by_identity;0;[ ;{ ;IC;"ZMakes hsh compare its keys by their identity, i.e. it
will consider exact same objects as same keys.
h1 = { "a" => 100, "b" => 200, :c => "c" }
h1["a"] #=> 100
h1.compare_by_identity
h1.compare_by_identity? #=> true
h1["a".dup] #=> nil # different objects.
h1[:c] #=> "c" # same symbols are all same.
;T;[o;
; I"
overload;F; 0;;; 0; I"compare_by_identity;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@F;#[ ;$I"@return [Hash];T;%0;"@F;&0;'F;(i ;[ ;"@F;#[ ;$I"Makes hsh compare its keys by their identity, i.e. it
will consider exact same objects as same keys.
h1 = { "a" => 100, "b" => 200, :c => "c" }
h1["a"] #=> 100
h1.compare_by_identity
h1.compare_by_identity? #=> true
h1["a".dup] #=> nil # different objects.
h1[:c] #=> "c" # same symbols are all same.
@overload compare_by_identity
@return [Hash];T;%0;"@F;'F;)o;*;+T;,i
;-i'
;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_compare_by_id(VALUE hash)
{
if (rb_hash_compare_by_id_p(hash)) return hash;
rb_hash_modify(hash);
RHASH(hash)->ntbl->type = &identhash;
rb_hash_rehash(hash);
return hash;
};T;0To;
; F; ;
;;;I" Hash#compare_by_identity?;F;[ ;[[@ >i=
;T;:compare_by_identity?;0;[ ;{ ;IC;"Returns true if hsh will compare its keys by
their identity. Also see Hash#compare_by_identity.
;T;[o;
; I"
overload;F; 0;;; 0; I"compare_by_identity?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@G;#[ ;$I"@return [Boolean];T;%0;"@G;&0;'F;(i ;[ ;"@Go;!
; I" return;F; @;0; [@;"@G;#[ ;$I"Returns true if hsh will compare its keys by
their identity. Also see Hash#compare_by_identity.
@overload compare_by_identity?
@return [Boolean];T;%0;"@G;'F;)o;*;+T;,i4
;-i:
;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_compare_by_id_p(VALUE hash)
{
if (!RHASH(hash)->ntbl)
return Qfalse;
if (RHASH(hash)->ntbl->type == &identhash) {
return Qtrue;
}
return Qfalse;
};T;0To;
; F; ;
;;;I"Hash#any?;F;[ ;[[@ >iy
;T;: any?;0;[ ;{ ;IC;" See also Enumerable#any?
;T;[o;
; I"
overload;F; 0;;; 0; I" any?;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"(key, value);T;"@ Go;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@ G;#[ ;$I",@yield [(key, value)]
@return [Boolean];T;%0;"@ G;&0;'F;(i ;[ ;"@ Go;!
; I" return;F; @;0; [@;"@ G;#[ ;$I"ZSee also Enumerable#any?
@overload any?
@yield [(key, value)]
@return [Boolean];T;%0;"@ G;'F;)o;*;+T;,ir
;-iw
;.@>; I"static VALUE;T;/I"\static VALUE
rb_hash_any_p(VALUE hash)
{
VALUE ret = Qfalse;
if (RHASH_EMPTY_P(hash)) return Qfalse;
if (!rb_block_given_p()) {
/* yields pairs, never false */
return Qtrue;
}
if (rb_block_arity() > 1)
rb_hash_foreach(hash, any_p_i_fast, (VALUE)&ret);
else
rb_hash_foreach(hash, any_p_i, (VALUE)&ret);
return ret;
};T;0To;
; F; ;
;;;I"
Hash#dig;F;[[@0;[[@ >i
;T;:dig;0;[ ;{ ;IC;"YExtracts the nested value specified by the sequence of idx
objects by calling +dig+ at each step, returning +nil+ if any
intermediate step is +nil+.
h = { foo: {bar: {baz: 1}}}
h.dig(:foo, :bar, :baz) #=> 1
h.dig(:foo, :zot, :xyz) #=> nil
g = { foo: [10, 11, 12] }
g.dig(:foo, 1) #=> 11
;T;[o;
; I"
overload;F; 0;;; 0; I"dig(key, ...);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@BG;#[ ;$I"@return [Object];T;%0;"@BG;&0;'F;(i ;[[I"key;T0[I"...;T0;"@BG;#[ ;$I"Extracts the nested value specified by the sequence of idx
objects by calling +dig+ at each step, returning +nil+ if any
intermediate step is +nil+.
h = { foo: {bar: {baz: 1}}}
h.dig(:foo, :bar, :baz) #=> 1
h.dig(:foo, :zot, :xyz) #=> nil
g = { foo: [10, 11, 12] }
g.dig(:foo, 1) #=> 11
@overload dig(key, ...)
@return [Object];T;%0;"@BG;'F;)o;*;+T;,i
;-i
;.@>; I"
VALUE;T;/I"VALUE
rb_hash_dig(int argc, VALUE *argv, VALUE self)
{
rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS);
self = rb_hash_aref(self, *argv);
if (!--argc) return self;
++argv;
return rb_obj_dig(argc, argv, self, Qnil);
};T;0To;
; F; ;
;;;I" Hash#<=;F;[[I"
other;T0;[[@ >i
;T;;
;0;[ ;{ ;IC;"Returns true if hash is subset of
other or equals to other.
h1 = {a:1, b:2}
h2 = {a:1, b:2, c:3}
h1 <= h2 #=> true
h2 <= h1 #=> false
h1 <= h1 #=> true
;T;[o;
; I"
overload;F; 0;;
; 0; I"<=(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@bG;#[ ;$I"@return [Boolean];T;%0;"@bG;&0;'F;(i ;[[I"
other;T0;"@bG;#[ ;$I"Returns true if hash is subset of
other or equals to other.
h1 = {a:1, b:2}
h2 = {a:1, b:2, c:3}
h1 <= h2 #=> true
h2 <= h1 #=> false
h1 <= h1 #=> true
@overload <=(other)
@return [Boolean];T;%0;"@bG;'F;)o;*;+T;,i
;-i
;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_le(VALUE hash, VALUE other)
{
other = to_hash(other);
if (RHASH_SIZE(hash) > RHASH_SIZE(other)) return Qfalse;
return hash_le(hash, other);
};T;0To;
; F; ;
;;;I" Hash#<;F;[[I"
other;T0;[[@ >i
;T;; ;0;[ ;{ ;IC;"Returns true if hash is subset of
other.
h1 = {a:1, b:2}
h2 = {a:1, b:2, c:3}
h1 < h2 #=> true
h2 < h1 #=> false
h1 < h1 #=> false
;T;[o;
; I"
overload;F; 0;; ; 0; I"
<(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@G;#[ ;$I"@return [Boolean];T;%0;"@G;&0;'F;(i ;[[I"
other;T0;"@G;#[ ;$I"Returns true if hash is subset of
other.
h1 = {a:1, b:2}
h2 = {a:1, b:2, c:3}
h1 < h2 #=> true
h2 < h1 #=> false
h1 < h1 #=> false
@overload <(other)
@return [Boolean];T;%0;"@G;'F;)o;*;+T;,i
;-i
;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_lt(VALUE hash, VALUE other)
{
other = to_hash(other);
if (RHASH_SIZE(hash) >= RHASH_SIZE(other)) return Qfalse;
return hash_le(hash, other);
};T;0To;
; F; ;
;;;I" Hash#>=;F;[[I"
other;T0;[[@ >i
;T;; ;0;[ ;{ ;IC;"Returns true if other is subset of
hash or equals to hash.
h1 = {a:1, b:2}
h2 = {a:1, b:2, c:3}
h1 >= h2 #=> false
h2 >= h1 #=> true
h1 >= h1 #=> true
;T;[o;
; I"
overload;F; 0;; ; 0; I">=(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@G;#[ ;$I"@return [Boolean];T;%0;"@G;&0;'F;(i ;[[I"
other;T0;"@G;#[ ;$I"Returns true if other is subset of
hash or equals to hash.
h1 = {a:1, b:2}
h2 = {a:1, b:2, c:3}
h1 >= h2 #=> false
h2 >= h1 #=> true
h1 >= h1 #=> true
@overload >=(other)
@return [Boolean];T;%0;"@G;'F;)o;*;+T;,i
;-i
;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_ge(VALUE hash, VALUE other)
{
other = to_hash(other);
if (RHASH_SIZE(hash) < RHASH_SIZE(other)) return Qfalse;
return hash_le(other, hash);
};T;0To;
; F; ;
;;;I" Hash#>;F;[[I"
other;T0;[[@ >i ;T;;
;0;[ ;{ ;IC;"Returns true if other is subset of
hash.
h1 = {a:1, b:2}
h2 = {a:1, b:2, c:3}
h1 > h2 #=> false
h2 > h1 #=> true
h1 > h1 #=> false
;T;[o;
; I"
overload;F; 0;;
; 0; I"
>(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@G;#[ ;$I"@return [Boolean];T;%0;"@G;&0;'F;(i ;[[I"
other;T0;"@G;#[ ;$I"Returns true if other is subset of
hash.
h1 = {a:1, b:2}
h2 = {a:1, b:2, c:3}
h1 > h2 #=> false
h2 > h1 #=> true
h1 > h1 #=> false
@overload >(other)
@return [Boolean];T;%0;"@G;'F;)o;*;+T;,i
;-i ;.@>; I"static VALUE;T;/I"static VALUE
rb_hash_gt(VALUE hash, VALUE other)
{
other = to_hash(other);
if (RHASH_SIZE(hash) <= RHASH_SIZE(other)) return Qfalse;
return hash_le(other, hash);
};T;0T;N@>;OIC;[ ;N@>;PIC;[o;Z ;[0;\0;]0;:Enumerable;.@;_o;;IC;[:o;
; F; ;
;;;I"Enumerable#to_a;F;[[@0;[[I" enum.c;Ti ;T;;L;0;[ ;{ ;IC;"Returns an array containing the items in enum.
(1..7).to_a #=> [1, 2, 3, 4, 5, 6, 7]
{ 'a'=>1, 'b'=>2, 'c'=>3 }.to_a #=> [["a", 1], ["b", 2], ["c", 3]]
require 'prime'
Prime.entries 10 #=> [2, 3, 5, 7]
;T;[o;
; I"
overload;F; 0;;L; 0; I"to_a(*args);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@G;#[ ;$I"@return [Array];T;%0;"@G;&0;'F;(i ;[[I"
*args;T0;"@Go;
; I"
overload;F; 0;: entries; 0; I"entries(*args);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@G;#[ ;$I"@return [Array];T;%0;"@G;&0;'F;(i ;[[I"
*args;T0;"@G;#[ ;$I"\Returns an array containing the items in enum.
(1..7).to_a #=> [1, 2, 3, 4, 5, 6, 7]
{ 'a'=>1, 'b'=>2, 'c'=>3 }.to_a #=> [["a", 1], ["b", 2], ["c", 3]]
require 'prime'
Prime.entries 10 #=> [2, 3, 5, 7]
@overload to_a(*args)
@return [Array]
@overload entries(*args)
@return [Array];T;%0;"@G;'F;)o;*;+T;,i;-i ;.@G; I"static VALUE;T;/I"static VALUE
enum_to_a(int argc, VALUE *argv, VALUE obj)
{
VALUE ary = rb_ary_new();
rb_block_call(obj, id_each, argc, argv, collect_all, ary);
OBJ_INFECT(ary, obj);
return ary;
};T;0To;
; F; ;
;;;I"Enumerable#entries;F;[[@0;[[@Gi ;T;;;0;[ ;{ ;IC;"Returns an array containing the items in enum.
(1..7).to_a #=> [1, 2, 3, 4, 5, 6, 7]
{ 'a'=>1, 'b'=>2, 'c'=>3 }.to_a #=> [["a", 1], ["b", 2], ["c", 3]]
require 'prime'
Prime.entries 10 #=> [2, 3, 5, 7]
;T;[o;
; I"
overload;F; 0;;L; 0; I"to_a(*args);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@H;#[ ;$I"@return [Array];T;%0;"@H;&0;'F;(i ;[[I"
*args;T0;"@Ho;
; I"
overload;F; 0;;; 0; I"entries(*args);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@H;#[ ;$I"@return [Array];T;%0;"@H;&0;'F;(i ;[[I"
*args;T0;"@H;#[ ;$@
H;%0;"@H;'F;)o;*;+T;,i;-i ;.@G; I"static VALUE;T;/I"static VALUE
enum_to_a(int argc, VALUE *argv, VALUE obj)
{
VALUE ary = rb_ary_new();
rb_block_call(obj, id_each, argc, argv, collect_all, ary);
OBJ_INFECT(ary, obj);
return ary;
};T;0To;
; F; ;
;;;I"Enumerable#to_h;F;[[@0;[[@GiF;T;;M;0;[ ;{ ;IC;"Returns the result of interpreting enum as a list of
[key, value] pairs.
%i[hello world].each_with_index.to_h
# => {:hello => 0, :world => 1}
;T;[o;
; I"
overload;F; 0;;M; 0; I"to_h(*args);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@=H;#[ ;$I"@return [Hash];T;%0;"@=H;&0;'F;(i ;[[I"
*args;T0;"@=H;#[ ;$I"Returns the result of interpreting enum as a list of
[key, value] pairs.
%i[hello world].each_with_index.to_h
# => {:hello => 0, :world => 1}
@overload to_h(*args)
@return [Hash];T;%0;"@=H;'F;)o;*;+T;,i;;-iC;.@G; I"static VALUE;T;/I"static VALUE
enum_to_h(int argc, VALUE *argv, VALUE obj)
{
VALUE hash = rb_hash_new();
rb_block_call(obj, id_each, argc, argv, enum_to_h_i, hash);
OBJ_INFECT(hash, obj);
return hash;
};T;0To;
; F; ;
;;;I"Enumerable#sort;F;[ ;[[@Gid;T;: sort;0;[ ;{ ;IC;"*Returns an array containing the items in enum sorted,
either according to their own <=> method, or by using
the results of the supplied block. The block should return -1, 0, or
+1 depending on the comparison between a and b. As of
Ruby 1.8, the method Enumerable#sort_by implements a
built-in Schwartzian Transform, useful when key computation or
comparison is expensive.
%w(rhea kea flea).sort #=> ["flea", "kea", "rhea"]
(1..10).sort { |a, b| b <=> a } #=> [10, 9, 8, 7, 6, 5, 4, 3, 2, 1]
;T;[o;
; I"
overload;F; 0;;; 0; I" sort;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@[H;#[ ;$I"@return [Array];T;%0;"@[H;&0;'F;(i ;[ ;"@[Ho;
; I"
overload;F; 0;;; 0; I" sort;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"a;TI"b;T;"@[Ho;!
; I" return;F; I" ;T;0; [I"
Array;T;"@[H;#[ ;$I""@yield [a, b]
@return [Array];T;%0;"@[H;&0;'F;(i ;[ ;"@[H;#[ ;$I"~Returns an array containing the items in enum sorted,
either according to their own <=> method, or by using
the results of the supplied block. The block should return -1, 0, or
+1 depending on the comparison between a and b. As of
Ruby 1.8, the method Enumerable#sort_by implements a
built-in Schwartzian Transform, useful when key computation or
comparison is expensive.
%w(rhea kea flea).sort #=> ["flea", "kea", "rhea"]
(1..10).sort { |a, b| b <=> a } #=> [10, 9, 8, 7, 6, 5, 4, 3, 2, 1]
@overload sort
@return [Array]
@overload sort
@yield [a, b]
@return [Array];T;%0;"@[H;'F;)o;*;+T;,iS;-ic;.@G; I"static VALUE;T;/I"Xstatic VALUE
enum_sort(VALUE obj)
{
return rb_ary_sort(enum_to_a(0, 0, obj));
};T;0To;
; F; ;
;;;I"Enumerable#sort_by;F;[ ;[[@Gi;T;: sort_by;0;[ ;{ ;IC;"Sorts enum using a set of keys generated by mapping the
values in enum through the given block.
If no block is given, an enumerator is returned instead.
%w{apple pear fig}.sort_by { |word| word.length}
#=> ["fig", "pear", "apple"]
The current implementation of sort_by generates an
array of tuples containing the original collection element and the
mapped value. This makes sort_by fairly expensive when
the keysets are simple.
require 'benchmark'
a = (1..100000).map { rand(100000) }
Benchmark.bm(10) do |b|
b.report("Sort") { a.sort }
b.report("Sort by") { a.sort_by { |a| a } }
end
produces:
user system total real
Sort 0.180000 0.000000 0.180000 ( 0.175469)
Sort by 1.980000 0.040000 2.020000 ( 2.013586)
However, consider the case where comparing the keys is a non-trivial
operation. The following code sorts some files on modification time
using the basic sort method.
files = Dir["*"]
sorted = files.sort { |a, b| File.new(a).mtime <=> File.new(b).mtime }
sorted #=> ["mon", "tues", "wed", "thurs"]
This sort is inefficient: it generates two new File
objects during every comparison. A slightly better technique is to
use the Kernel#test method to generate the modification
times directly.
files = Dir["*"]
sorted = files.sort { |a, b|
test(?M, a) <=> test(?M, b)
}
sorted #=> ["mon", "tues", "wed", "thurs"]
This still generates many unnecessary Time objects. A
more efficient technique is to cache the sort keys (modification
times in this case) before the sort. Perl users often call this
approach a Schwartzian Transform, after Randal Schwartz. We
construct a temporary array, where each element is an array
containing our sort key along with the filename. We sort this array,
and then extract the filename from the result.
sorted = Dir["*"].collect { |f|
[test(?M, f), f]
}.sort.collect { |f| f[1] }
sorted #=> ["mon", "tues", "wed", "thurs"]
This is exactly what sort_by does internally.
sorted = Dir["*"].sort_by { |f| test(?M, f) }
sorted #=> ["mon", "tues", "wed", "thurs"]
;T;[o;
; I"
overload;F; 0;;; 0; I" sort_by;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@Ho;!
; I" return;F; I" ;T;0; [I"
Array;T;"@H;#[ ;$I"!@yield [obj]
@return [Array];T;%0;"@H;&0;'F;(i ;[ ;"@Ho;
; I"
overload;F; 0;;; 0; I" sort_by;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@H;&0;'F;(i ;[ ;"@H;#[ ;$I" Sorts enum using a set of keys generated by mapping the
values in enum through the given block.
If no block is given, an enumerator is returned instead.
%w{apple pear fig}.sort_by { |word| word.length}
#=> ["fig", "pear", "apple"]
The current implementation of sort_by generates an
array of tuples containing the original collection element and the
mapped value. This makes sort_by fairly expensive when
the keysets are simple.
require 'benchmark'
a = (1..100000).map { rand(100000) }
Benchmark.bm(10) do |b|
b.report("Sort") { a.sort }
b.report("Sort by") { a.sort_by { |a| a } }
end
produces:
user system total real
Sort 0.180000 0.000000 0.180000 ( 0.175469)
Sort by 1.980000 0.040000 2.020000 ( 2.013586)
However, consider the case where comparing the keys is a non-trivial
operation. The following code sorts some files on modification time
using the basic sort method.
files = Dir["*"]
sorted = files.sort { |a, b| File.new(a).mtime <=> File.new(b).mtime }
sorted #=> ["mon", "tues", "wed", "thurs"]
This sort is inefficient: it generates two new File
objects during every comparison. A slightly better technique is to
use the Kernel#test method to generate the modification
times directly.
files = Dir["*"]
sorted = files.sort { |a, b|
test(?M, a) <=> test(?M, b)
}
sorted #=> ["mon", "tues", "wed", "thurs"]
This still generates many unnecessary Time objects. A
more efficient technique is to cache the sort keys (modification
times in this case) before the sort. Perl users often call this
approach a Schwartzian Transform, after Randal Schwartz. We
construct a temporary array, where each element is an array
containing our sort key along with the filename. We sort this array,
and then extract the filename from the result.
sorted = Dir["*"].collect { |f|
[test(?M, f), f]
}.sort.collect { |f| f[1] }
sorted #=> ["mon", "tues", "wed", "thurs"]
This is exactly what sort_by does internally.
sorted = Dir["*"].sort_by { |f| test(?M, f) }
sorted #=> ["mon", "tues", "wed", "thurs"]
@overload sort_by
@yield [obj]
@return [Array]
@overload sort_by;T;%0;"@H;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"static VALUE
enum_sort_by(VALUE obj)
{
VALUE ary, buf;
struct MEMO *memo;
long i;
struct sort_by_data *data;
RETURN_SIZED_ENUMERATOR(obj, 0, 0, enum_size);
if (RB_TYPE_P(obj, T_ARRAY) && RARRAY_LEN(obj) <= LONG_MAX/2) {
ary = rb_ary_new2(RARRAY_LEN(obj)*2);
}
else {
ary = rb_ary_new();
}
RBASIC_CLEAR_CLASS(ary);
buf = rb_ary_tmp_new(SORT_BY_BUFSIZE*2);
rb_ary_store(buf, SORT_BY_BUFSIZE*2-1, Qnil);
memo = MEMO_NEW(0, 0, 0);
OBJ_INFECT(memo, obj);
data = (struct sort_by_data *)&memo->v1;
RB_OBJ_WRITE(memo, &data->ary, ary);
RB_OBJ_WRITE(memo, &data->buf, buf);
data->n = 0;
rb_block_call(obj, id_each, 0, 0, sort_by_i, (VALUE)memo);
ary = data->ary;
buf = data->buf;
if (data->n) {
rb_ary_resize(buf, data->n*2);
rb_ary_concat(ary, buf);
}
if (RARRAY_LEN(ary) > 2) {
RARRAY_PTR_USE(ary, ptr,
ruby_qsort(ptr, RARRAY_LEN(ary)/2, 2*sizeof(VALUE),
sort_by_cmp, (void *)ary));
}
if (RBASIC(ary)->klass) {
rb_raise(rb_eRuntimeError, "sort_by reentered");
}
for (i=1; ienum for which
Pattern === element. If the optional block is
supplied, each matching element is passed to it, and the block's
result is stored in the output array.
(1..100).grep 38..44 #=> [38, 39, 40, 41, 42, 43, 44]
c = IO.constants
c.grep(/SEEK/) #=> [:SEEK_SET, :SEEK_CUR, :SEEK_END]
res = c.grep(/SEEK/) { |v| IO.const_get(v) }
res #=> [0, 1, 2]
;T;[o;
; I"
overload;F; 0;;; 0; I"grep(pattern);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@H;#[ ;$I"@return [Array];T;%0;"@H;&0;'F;(i ;[[I" pattern;T0;"@Ho;
; I"
overload;F; 0;;; 0; I"grep(pattern);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@Ho;!
; I" return;F; I" ;T;0; [I"
Array;T;"@H;#[ ;$I"!@yield [obj]
@return [Array];T;%0;"@H;&0;'F;(i ;[[I" pattern;T0;"@H;#[ ;$I"3Returns an array of every element in enum for which
Pattern === element. If the optional block is
supplied, each matching element is passed to it, and the block's
result is stored in the output array.
(1..100).grep 38..44 #=> [38, 39, 40, 41, 42, 43, 44]
c = IO.constants
c.grep(/SEEK/) #=> [:SEEK_SET, :SEEK_CUR, :SEEK_END]
res = c.grep(/SEEK/) { |v| IO.const_get(v) }
res #=> [0, 1, 2]
@overload grep(pattern)
@return [Array]
@overload grep(pattern)
@yield [obj]
@return [Array];T;%0;"@H;'F;)o;*;+T;,iG;-iX;.@G; I"static VALUE;T;/I"static VALUE
enum_grep(VALUE obj, VALUE pat)
{
VALUE ary = rb_ary_new();
struct MEMO *memo = MEMO_NEW(pat, ary, Qtrue);
rb_block_call(obj, id_each, 0, 0, rb_block_given_p() ? grep_iter_i : grep_i, (VALUE)memo);
return ary;
};T;0To;
; F; ;
;;;I"Enumerable#grep_v;F;[[I"pat;T0;[[@Gis;T;: grep_v;0;[ ;{ ;IC;"Inverted version of Enumerable#grep.
Returns an array of every element in enum for which
not Pattern === element.
(1..10).grep_v 2..5 #=> [1, 6, 7, 8, 9, 10]
res =(1..10).grep_v(2..5) { |v| v * 2 }
res #=> [2, 12, 14, 16, 18, 20]
;T;[o;
; I"
overload;F; 0;;; 0; I"grep_v(pattern);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@H;#[ ;$I"@return [Array];T;%0;"@H;&0;'F;(i ;[[I" pattern;T0;"@Ho;
; I"
overload;F; 0;;; 0; I"grep_v(pattern);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@Ho;!
; I" return;F; I" ;T;0; [I"
Array;T;"@H;#[ ;$I"!@yield [obj]
@return [Array];T;%0;"@H;&0;'F;(i ;[[I" pattern;T0;"@H;#[ ;$I"Inverted version of Enumerable#grep.
Returns an array of every element in enum for which
not Pattern === element.
(1..10).grep_v 2..5 #=> [1, 6, 7, 8, 9, 10]
res =(1..10).grep_v(2..5) { |v| v * 2 }
res #=> [2, 12, 14, 16, 18, 20]
@overload grep_v(pattern)
@return [Array]
@overload grep_v(pattern)
@yield [obj]
@return [Array];T;%0;"@H;'F;)o;*;+T;,id;-ir;.@G; I"static VALUE;T;/I"static VALUE
enum_grep_v(VALUE obj, VALUE pat)
{
VALUE ary = rb_ary_new();
struct MEMO *memo = MEMO_NEW(pat, ary, Qfalse);
rb_block_call(obj, id_each, 0, 0, rb_block_given_p() ? grep_iter_i : grep_i, (VALUE)memo);
return ary;
};T;0To;
; F; ;
;;;I"Enumerable#count;F;[[@0;[[@Gi;T;;;0;[ ;{ ;IC;"_Returns the number of items in +enum+ through enumeration.
If an argument is given, the number of items in +enum+ that
are equal to +item+ are counted. If a block is given, it
counts the number of elements yielding a true value.
ary = [1, 2, 4, 2]
ary.count #=> 4
ary.count(2) #=> 2
ary.count{ |x| x%2==0 } #=> 3
;T;[o;
; I"
overload;F; 0;;; 0; I"
count;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@I;#[ ;$I"@return [Integer];T;%0;"@I;&0;'F;(i ;[ ;"@Io;
; I"
overload;F; 0;;; 0; I"count(item);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@I;#[ ;$I"@return [Integer];T;%0;"@I;&0;'F;(i ;[[I" item;T0;"@Io;
; I"
overload;F; 0;;; 0; I"
count;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@Io;!
; I" return;F; I" ;T;0; [I" Integer;T;"@I;#[ ;$I"#@yield [obj]
@return [Integer];T;%0;"@I;&0;'F;(i ;[ ;"@I;#[ ;$I"Returns the number of items in +enum+ through enumeration.
If an argument is given, the number of items in +enum+ that
are equal to +item+ are counted. If a block is given, it
counts the number of elements yielding a true value.
ary = [1, 2, 4, 2]
ary.count #=> 4
ary.count(2) #=> 2
ary.count{ |x| x%2==0 } #=> 3
@overload count
@return [Integer]
@overload count(item)
@return [Integer]
@overload count
@yield [obj]
@return [Integer];T;%0;"@I;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"static VALUE
enum_count(int argc, VALUE *argv, VALUE obj)
{
VALUE item = Qnil;
struct MEMO *memo;
rb_block_call_func *func;
if (argc == 0) {
if (rb_block_given_p()) {
func = count_iter_i;
}
else {
func = count_all_i;
}
}
else {
rb_scan_args(argc, argv, "1", &item);
if (rb_block_given_p()) {
rb_warn("given block not used");
}
func = count_i;
}
memo = MEMO_NEW(item, 0, 0);
rb_block_call(obj, id_each, 0, 0, func, (VALUE)memo);
return INT2NUM(memo->u3.cnt);
};T;0To;
; F; ;
;;;I"Enumerable#find;F;[[@0;[[@Gi;T;: find;0;[ ;{ ;IC;"Passes each entry in enum to block. Returns the
first for which block is not false. If no
object matches, calls ifnone and returns its result when it
is specified, or returns nil otherwise.
If no block is given, an enumerator is returned instead.
(1..10).detect { |i| i % 5 == 0 and i % 7 == 0 } #=> nil
(1..100).find { |i| i % 5 == 0 and i % 7 == 0 } #=> 35
;T;[ o;
; I"
overload;F; 0;: detect; 0; I"detect(ifnone = nil);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@TIo;!
; I" return;F; I" ;T;0; [I" Object;TI"nil;T;"@TI;#[ ;$I"'@yield [obj]
@return [Object, nil];T;%0;"@TI;&0;'F;(i ;[[I" ifnone;TI"nil;T;"@TIo;
; I"
overload;F; 0;;; 0; I"find(ifnone = nil);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@TIo;!
; I" return;F; I" ;T;0; [I" Object;TI"nil;T;"@TI;#[ ;$I"'@yield [obj]
@return [Object, nil];T;%0;"@TI;&0;'F;(i ;[[I" ifnone;TI"nil;T;"@TIo;
; I"
overload;F; 0;; ; 0; I"detect(ifnone = nil);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@TI;&0;'F;(i ;[[I" ifnone;TI"nil;T;"@TIo;
; I"
overload;F; 0;;; 0; I"find(ifnone = nil);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@TI;&0;'F;(i ;[[I" ifnone;TI"nil;T;"@TI;#[ ;$I"iPasses each entry in enum to block. Returns the
first for which block is not false. If no
object matches, calls ifnone and returns its result when it
is specified, or returns nil otherwise.
If no block is given, an enumerator is returned instead.
(1..10).detect { |i| i % 5 == 0 and i % 7 == 0 } #=> nil
(1..100).find { |i| i % 5 == 0 and i % 7 == 0 } #=> 35
@overload detect(ifnone = nil)
@yield [obj]
@return [Object, nil]
@overload find(ifnone = nil)
@yield [obj]
@return [Object, nil]
@overload detect(ifnone = nil)
@overload find(ifnone = nil);T;%0;"@TI;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"static VALUE
enum_find(int argc, VALUE *argv, VALUE obj)
{
struct MEMO *memo;
VALUE if_none;
rb_scan_args(argc, argv, "01", &if_none);
RETURN_ENUMERATOR(obj, argc, argv);
memo = MEMO_NEW(Qundef, 0, 0);
rb_block_call(obj, id_each, 0, 0, find_i, (VALUE)memo);
if (memo->u3.cnt) {
return memo->v1;
}
if (!NIL_P(if_none)) {
return rb_funcallv(if_none, id_call, 0, 0);
}
return Qnil;
};T;0To;
; F; ;
;;;I"Enumerable#detect;F;[[@0;[[@Gi;T;; ;0;[ ;{ ;IC;"Passes each entry in enum to block. Returns the
first for which block is not false. If no
object matches, calls ifnone and returns its result when it
is specified, or returns nil otherwise.
If no block is given, an enumerator is returned instead.
(1..10).detect { |i| i % 5 == 0 and i % 7 == 0 } #=> nil
(1..100).find { |i| i % 5 == 0 and i % 7 == 0 } #=> 35
;T;[ o;
; I"
overload;F; 0;; ; 0; I"detect(ifnone = nil);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@Io;!
; I" return;F; I" ;T;0; [I" Object;TI"nil;T;"@I;#[ ;$I"'@yield [obj]
@return [Object, nil];T;%0;"@I;&0;'F;(i ;[[I" ifnone;TI"nil;T;"@Io;
; I"
overload;F; 0;;; 0; I"find(ifnone = nil);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@Io;!
; I" return;F; I" ;T;0; [I" Object;TI"nil;T;"@I;#[ ;$I"'@yield [obj]
@return [Object, nil];T;%0;"@I;&0;'F;(i ;[[I" ifnone;TI"nil;T;"@Io;
; I"
overload;F; 0;; ; 0; I"detect(ifnone = nil);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@I;&0;'F;(i ;[[I" ifnone;TI"nil;T;"@Io;
; I"
overload;F; 0;;; 0; I"find(ifnone = nil);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@I;&0;'F;(i ;[[I" ifnone;TI"nil;T;"@I;#[ ;$@I;%0;"@I;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"static VALUE
enum_find(int argc, VALUE *argv, VALUE obj)
{
struct MEMO *memo;
VALUE if_none;
rb_scan_args(argc, argv, "01", &if_none);
RETURN_ENUMERATOR(obj, argc, argv);
memo = MEMO_NEW(Qundef, 0, 0);
rb_block_call(obj, id_each, 0, 0, find_i, (VALUE)memo);
if (memo->u3.cnt) {
return memo->v1;
}
if (!NIL_P(if_none)) {
return rb_funcallv(if_none, id_call, 0, 0);
}
return Qnil;
};T;0To;
; F; ;
;;;I"Enumerable#find_index;F;[[@0;[[@Gi+;T;:find_index;0;[ ;{ ;IC;"Compares each entry in enum with value or passes
to block. Returns the index for the first for which the
evaluated value is non-false. If no object matches, returns
nil
If neither block nor argument is given, an enumerator is returned instead.
(1..10).find_index { |i| i % 5 == 0 and i % 7 == 0 } #=> nil
(1..100).find_index { |i| i % 5 == 0 and i % 7 == 0 } #=> 34
(1..100).find_index(50) #=> 49
;T;[o;
; I"
overload;F; 0;;; 0; I"find_index(value);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;TI"nil;T;"@I;#[ ;$I"@return [Integer, nil];T;%0;"@I;&0;'F;(i ;[[I"
value;T0;"@Io;
; I"
overload;F; 0;;; 0; I"find_index;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@Io;!
; I" return;F; I" ;T;0; [I" Integer;TI"nil;T;"@I;#[ ;$I"(@yield [obj]
@return [Integer, nil];T;%0;"@I;&0;'F;(i ;[ ;"@Io;
; I"
overload;F; 0;;; 0; I"find_index;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@I;&0;'F;(i ;[ ;"@I;#[ ;$I"kCompares each entry in enum with value or passes
to block. Returns the index for the first for which the
evaluated value is non-false. If no object matches, returns
nil
If neither block nor argument is given, an enumerator is returned instead.
(1..10).find_index { |i| i % 5 == 0 and i % 7 == 0 } #=> nil
(1..100).find_index { |i| i % 5 == 0 and i % 7 == 0 } #=> 34
(1..100).find_index(50) #=> 49
@overload find_index(value)
@return [Integer, nil]
@overload find_index
@yield [obj]
@return [Integer, nil]
@overload find_index;T;%0;"@I;'F;)o;*;+T;,i;-i*;.@G; I"static VALUE;T;/I"Fstatic VALUE
enum_find_index(int argc, VALUE *argv, VALUE obj)
{
struct MEMO *memo; /* [return value, current index, ] */
VALUE condition_value = Qnil;
rb_block_call_func *func;
if (argc == 0) {
RETURN_ENUMERATOR(obj, 0, 0);
func = find_index_iter_i;
}
else {
rb_scan_args(argc, argv, "1", &condition_value);
if (rb_block_given_p()) {
rb_warn("given block not used");
}
func = find_index_i;
}
memo = MEMO_NEW(Qnil, condition_value, 0);
rb_block_call(obj, id_each, 0, 0, func, (VALUE)memo);
return memo->v1;
};T;0To;
; F; ;
;;;I"Enumerable#find_all;F;[ ;[[@Gi|;T;:
find_all;0;[ ;{ ;IC;"/Returns an array containing all elements of +enum+
for which the given +block+ returns a true value.
If no block is given, an Enumerator is returned instead.
(1..10).find_all { |i| i % 3 == 0 } #=> [3, 6, 9]
[1,2,3,4,5].select { |num| num.even? } #=> [2, 4]
See also Enumerable#reject.
;T;[ o;
; I"
overload;F; 0;;; 0; I"
find_all;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@/Jo;!
; I" return;F; I" ;T;0; [I"
Array;T;"@/J;#[ ;$I"!@yield [obj]
@return [Array];T;%0;"@/J;&0;'F;(i ;[ ;"@/Jo;
; I"
overload;F; 0;;; 0; I" select;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@/Jo;!
; I" return;F; I" ;T;0; [I"
Array;T;"@/J;#[ ;$I"!@yield [obj]
@return [Array];T;%0;"@/J;&0;'F;(i ;[ ;"@/Jo;
; I"
overload;F; 0;;; 0; I"
find_all;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@/J;&0;'F;(i ;[ ;"@/Jo;
; I"
overload;F; 0;;; 0; I" select;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@/J;&0;'F;(i ;[ ;"@/J;#[ ;$I"Returns an array containing all elements of +enum+
for which the given +block+ returns a true value.
If no block is given, an Enumerator is returned instead.
(1..10).find_all { |i| i % 3 == 0 } #=> [3, 6, 9]
[1,2,3,4,5].select { |num| num.even? } #=> [2, 4]
See also Enumerable#reject.
@overload find_all
@yield [obj]
@return [Array]
@overload select
@yield [obj]
@return [Array]
@overload find_all
@overload select;T;%0;"@/J;'F;)o;*;+T;,ih;-i|;.@G; I"static VALUE;T;/I"static VALUE
enum_find_all(VALUE obj)
{
VALUE ary;
RETURN_SIZED_ENUMERATOR(obj, 0, 0, enum_size);
ary = rb_ary_new();
rb_block_call(obj, id_each, 0, 0, find_all_i, ary);
return ary;
};T;0To;
; F; ;
;;;I"Enumerable#select;F;[ ;[[@Gi|;T;;;0;[ ;{ ;IC;"/Returns an array containing all elements of +enum+
for which the given +block+ returns a true value.
If no block is given, an Enumerator is returned instead.
(1..10).find_all { |i| i % 3 == 0 } #=> [3, 6, 9]
[1,2,3,4,5].select { |num| num.even? } #=> [2, 4]
See also Enumerable#reject.
;T;[ o;
; I"
overload;F; 0;;; 0; I"
find_all;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@qJo;!
; I" return;F; I" ;T;0; [I"
Array;T;"@qJ;#[ ;$I"!@yield [obj]
@return [Array];T;%0;"@qJ;&0;'F;(i ;[ ;"@qJo;
; I"
overload;F; 0;;; 0; I" select;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@qJo;!
; I" return;F; I" ;T;0; [I"
Array;T;"@qJ;#[ ;$I"!@yield [obj]
@return [Array];T;%0;"@qJ;&0;'F;(i ;[ ;"@qJo;
; I"
overload;F; 0;;; 0; I"
find_all;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@qJ;&0;'F;(i ;[ ;"@qJo;
; I"
overload;F; 0;;; 0; I" select;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@qJ;&0;'F;(i ;[ ;"@qJ;#[ ;$@mJ;%0;"@qJ;'F;)o;*;+T;,ih;-i|;.@G; I"static VALUE;T;/I"static VALUE
enum_find_all(VALUE obj)
{
VALUE ary;
RETURN_SIZED_ENUMERATOR(obj, 0, 0, enum_size);
ary = rb_ary_new();
rb_block_call(obj, id_each, 0, 0, find_all_i, ary);
return ary;
};T;0To;
; F; ;
;;;I"Enumerable#reject;F;[ ;[[@Gi;T;;;0;[ ;{ ;IC;"0Returns an array for all elements of +enum+ for which the given
+block+ returns false.
If no block is given, an Enumerator is returned instead.
(1..10).reject { |i| i % 3 == 0 } #=> [1, 2, 4, 5, 7, 8, 10]
[1, 2, 3, 4, 5].reject { |num| num.even? } #=> [1, 3, 5]
See also Enumerable#find_all.
;T;[o;
; I"
overload;F; 0;;; 0; I" reject;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@Jo;!
; I" return;F; I" ;T;0; [I"
Array;T;"@J;#[ ;$I"!@yield [obj]
@return [Array];T;%0;"@J;&0;'F;(i ;[ ;"@Jo;
; I"
overload;F; 0;;; 0; I" reject;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@J;&0;'F;(i ;[ ;"@J;#[ ;$I"uReturns an array for all elements of +enum+ for which the given
+block+ returns false.
If no block is given, an Enumerator is returned instead.
(1..10).reject { |i| i % 3 == 0 } #=> [1, 2, 4, 5, 7, 8, 10]
[1, 2, 3, 4, 5].reject { |num| num.even? } #=> [1, 3, 5]
See also Enumerable#find_all.
@overload reject
@yield [obj]
@return [Array]
@overload reject;T;%0;"@J;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"static VALUE
enum_reject(VALUE obj)
{
VALUE ary;
RETURN_SIZED_ENUMERATOR(obj, 0, 0, enum_size);
ary = rb_ary_new();
rb_block_call(obj, id_each, 0, 0, reject_i, ary);
return ary;
};T;0To;
; F; ;
;;;I"Enumerable#collect;F;[ ;[[@Gi;T;: collect;0;[ ;{ ;IC;"Returns a new array with the results of running block once
for every element in enum.
If no block is given, an enumerator is returned instead.
(1..4).map { |i| i*i } #=> [1, 4, 9, 16]
(1..4).collect { "cat" } #=> ["cat", "cat", "cat", "cat"]
;T;[ o;
; I"
overload;F; 0;;; 0; I" collect;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@Jo;!
; I" return;F; I" ;T;0; [I"
Array;T;"@J;#[ ;$I"!@yield [obj]
@return [Array];T;%0;"@J;&0;'F;(i ;[ ;"@Jo;
; I"
overload;F; 0;:map; 0; I"map;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@Jo;!
; I" return;F; I" ;T;0; [I"
Array;T;"@J;#[ ;$I"!@yield [obj]
@return [Array];T;%0;"@J;&0;'F;(i ;[ ;"@Jo;
; I"
overload;F; 0;;; 0; I" collect;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@J;&0;'F;(i ;[ ;"@Jo;
; I"
overload;F; 0;;; 0; I"map;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@J;&0;'F;(i ;[ ;"@J;#[ ;$I"Returns a new array with the results of running block once
for every element in enum.
If no block is given, an enumerator is returned instead.
(1..4).map { |i| i*i } #=> [1, 4, 9, 16]
(1..4).collect { "cat" } #=> ["cat", "cat", "cat", "cat"]
@overload collect
@yield [obj]
@return [Array]
@overload map
@yield [obj]
@return [Array]
@overload collect
@overload map;T;%0;"@J;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"static VALUE
enum_collect(VALUE obj)
{
VALUE ary;
RETURN_SIZED_ENUMERATOR(obj, 0, 0, enum_size);
ary = rb_ary_new();
rb_block_call(obj, id_each, 0, 0, collect_i, ary);
return ary;
};T;0To;
; F; ;
;;;I"Enumerable#map;F;[ ;[[@Gi;T;;;0;[ ;{ ;IC;"Returns a new array with the results of running block once
for every element in enum.
If no block is given, an enumerator is returned instead.
(1..4).map { |i| i*i } #=> [1, 4, 9, 16]
(1..4).collect { "cat" } #=> ["cat", "cat", "cat", "cat"]
;T;[ o;
; I"
overload;F; 0;;; 0; I" collect;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@ Ko;!
; I" return;F; I" ;T;0; [I"
Array;T;"@ K;#[ ;$I"!@yield [obj]
@return [Array];T;%0;"@ K;&0;'F;(i ;[ ;"@ Ko;
; I"
overload;F; 0;;; 0; I"map;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@ Ko;!
; I" return;F; I" ;T;0; [I"
Array;T;"@ K;#[ ;$I"!@yield [obj]
@return [Array];T;%0;"@ K;&0;'F;(i ;[ ;"@ Ko;
; I"
overload;F; 0;;; 0; I" collect;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ K;&0;'F;(i ;[ ;"@ Ko;
; I"
overload;F; 0;;; 0; I"map;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ K;&0;'F;(i ;[ ;"@ K;#[ ;$@K;%0;"@ K;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"static VALUE
enum_collect(VALUE obj)
{
VALUE ary;
RETURN_SIZED_ENUMERATOR(obj, 0, 0, enum_size);
ary = rb_ary_new();
rb_block_call(obj, id_each, 0, 0, collect_i, ary);
return ary;
};T;0To;
; F; ;
;;;I"Enumerable#flat_map;F;[ ;[[@Gi;T;:
flat_map;0;[ ;{ ;IC;"AReturns a new array with the concatenated results of running
block once for every element in enum.
If no block is given, an enumerator is returned instead.
[1, 2, 3, 4].flat_map { |e| [e, -e] } #=> [1, -1, 2, -2, 3, -3, 4, -4]
[[1, 2], [3, 4]].flat_map { |e| e + [100] } #=> [1, 2, 100, 3, 4, 100]
;T;[ o;
; I"
overload;F; 0;;; 0; I"
flat_map;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@]Ko;!
; I" return;F; I" ;T;0; [I"
Array;T;"@]K;#[ ;$I"!@yield [obj]
@return [Array];T;%0;"@]K;&0;'F;(i ;[ ;"@]Ko;
; I"
overload;F; 0;:collect_concat; 0; I"collect_concat;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@]Ko;!
; I" return;F; I" ;T;0; [I"
Array;T;"@]K;#[ ;$I"!@yield [obj]
@return [Array];T;%0;"@]K;&0;'F;(i ;[ ;"@]Ko;
; I"
overload;F; 0;;; 0; I"
flat_map;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@]K;&0;'F;(i ;[ ;"@]Ko;
; I"
overload;F; 0;;; 0; I"collect_concat;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@]K;&0;'F;(i ;[ ;"@]K;#[ ;$I"Returns a new array with the concatenated results of running
block once for every element in enum.
If no block is given, an enumerator is returned instead.
[1, 2, 3, 4].flat_map { |e| [e, -e] } #=> [1, -1, 2, -2, 3, -3, 4, -4]
[[1, 2], [3, 4]].flat_map { |e| e + [100] } #=> [1, 2, 100, 3, 4, 100]
@overload flat_map
@yield [obj]
@return [Array]
@overload collect_concat
@yield [obj]
@return [Array]
@overload flat_map
@overload collect_concat;T;%0;"@]K;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"static VALUE
enum_flat_map(VALUE obj)
{
VALUE ary;
RETURN_SIZED_ENUMERATOR(obj, 0, 0, enum_size);
ary = rb_ary_new();
rb_block_call(obj, id_each, 0, 0, flat_map_i, ary);
return ary;
};T;0To;
; F; ;
;;;I" Enumerable#collect_concat;F;[ ;[[@Gi;T;;;0;[ ;{ ;IC;"AReturns a new array with the concatenated results of running
block once for every element in enum.
If no block is given, an enumerator is returned instead.
[1, 2, 3, 4].flat_map { |e| [e, -e] } #=> [1, -1, 2, -2, 3, -3, 4, -4]
[[1, 2], [3, 4]].flat_map { |e| e + [100] } #=> [1, 2, 100, 3, 4, 100]
;T;[ o;
; I"
overload;F; 0;;; 0; I"
flat_map;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@Ko;!
; I" return;F; I" ;T;0; [I"
Array;T;"@K;#[ ;$I"!@yield [obj]
@return [Array];T;%0;"@K;&0;'F;(i ;[ ;"@Ko;
; I"
overload;F; 0;;; 0; I"collect_concat;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@Ko;!
; I" return;F; I" ;T;0; [I"
Array;T;"@K;#[ ;$I"!@yield [obj]
@return [Array];T;%0;"@K;&0;'F;(i ;[ ;"@Ko;
; I"
overload;F; 0;;; 0; I"
flat_map;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@K;&0;'F;(i ;[ ;"@Ko;
; I"
overload;F; 0;;; 0; I"collect_concat;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@K;&0;'F;(i ;[ ;"@K;#[ ;$@K;%0;"@K;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"static VALUE
enum_flat_map(VALUE obj)
{
VALUE ary;
RETURN_SIZED_ENUMERATOR(obj, 0, 0, enum_size);
ary = rb_ary_new();
rb_block_call(obj, id_each, 0, 0, flat_map_i, ary);
return ary;
};T;0To;
; F; ;
;;;I"Enumerable#inject;F;[[@0;[[@Gi;T;: inject;0;[ ;{ ;IC;"Combines all elements of enum by applying a binary
operation, specified by a block or a symbol that names a
method or operator.
If you specify a block, then for each element in enum
the block is passed an accumulator value (memo) and the element.
If you specify a symbol instead, then each element in the collection
will be passed to the named method of memo.
In either case, the result becomes the new value for memo.
At the end of the iteration, the final value of memo is the
return value for the method.
If you do not explicitly specify an initial value for memo,
then the first element of collection is used as the initial value
of memo.
# Sum some numbers
(5..10).reduce(:+) #=> 45
# Same using a block and inject
(5..10).inject { |sum, n| sum + n } #=> 45
# Multiply some numbers
(5..10).reduce(1, :*) #=> 151200
# Same using a block
(5..10).inject(1) { |product, n| product * n } #=> 151200
# find the longest word
longest = %w{ cat sheep bear }.inject do |memo, word|
memo.length > word.length ? memo : word
end
longest #=> "sheep"
;T;[
o;
; I"
overload;F; 0;;; 0; I"inject(initial, sym);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@K;#[ ;$I"@return [Object];T;%0;"@K;&0;'F;(i ;[[I" initial;T0[I"sym;T0;"@Ko;
; I"
overload;F; 0;;; 0; I"inject(sym);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@K;#[ ;$I"@return [Object];T;%0;"@K;&0;'F;(i ;[[I"sym;T0;"@Ko;
; I"
overload;F; 0;;; 0; I"inject(initial);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" memo;TI"obj;T;"@Ko;!
; I" return;F; I" ;T;0; [I" Object;T;"@K;#[ ;$I"(@yield [memo, obj]
@return [Object];T;%0;"@K;&0;'F;(i ;[[I" initial;T0;"@Ko;
; I"
overload;F; 0;;; 0; I" inject;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" memo;TI"obj;T;"@Ko;!
; I" return;F; I" ;T;0; [I" Object;T;"@K;#[ ;$I"(@yield [memo, obj]
@return [Object];T;%0;"@K;&0;'F;(i ;[ ;"@Ko;
; I"
overload;F; 0;: reduce; 0; I"reduce(initial, sym);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@K;#[ ;$I"@return [Object];T;%0;"@K;&0;'F;(i ;[[I" initial;T0[I"sym;T0;"@Ko;
; I"
overload;F; 0;;; 0; I"reduce(sym);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@K;#[ ;$I"@return [Object];T;%0;"@K;&0;'F;(i ;[[I"sym;T0;"@Ko;
; I"
overload;F; 0;;; 0; I"reduce(initial);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" memo;TI"obj;T;"@Ko;!
; I" return;F; I" ;T;0; [I" Object;T;"@K;#[ ;$I"(@yield [memo, obj]
@return [Object];T;%0;"@K;&0;'F;(i ;[[I" initial;T0;"@Ko;
; I"
overload;F; 0;;; 0; I" reduce;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" memo;TI"obj;T;"@Ko;!
; I" return;F; I" ;T;0; [I" Object;T;"@K;#[ ;$I"(@yield [memo, obj]
@return [Object];T;%0;"@K;&0;'F;(i ;[ ;"@K;#[ ;$I"Combines all elements of enum by applying a binary
operation, specified by a block or a symbol that names a
method or operator.
If you specify a block, then for each element in enum
the block is passed an accumulator value (memo) and the element.
If you specify a symbol instead, then each element in the collection
will be passed to the named method of memo.
In either case, the result becomes the new value for memo.
At the end of the iteration, the final value of memo is the
return value for the method.
If you do not explicitly specify an initial value for memo,
then the first element of collection is used as the initial value
of memo.
# Sum some numbers
(5..10).reduce(:+) #=> 45
# Same using a block and inject
(5..10).inject { |sum, n| sum + n } #=> 45
# Multiply some numbers
(5..10).reduce(1, :*) #=> 151200
# Same using a block
(5..10).inject(1) { |product, n| product * n } #=> 151200
# find the longest word
longest = %w{ cat sheep bear }.inject do |memo, word|
memo.length > word.length ? memo : word
end
longest #=> "sheep"
@overload inject(initial, sym)
@return [Object]
@overload inject(sym)
@return [Object]
@overload inject(initial)
@yield [memo, obj]
@return [Object]
@overload inject
@yield [memo, obj]
@return [Object]
@overload reduce(initial, sym)
@return [Object]
@overload reduce(sym)
@return [Object]
@overload reduce(initial)
@yield [memo, obj]
@return [Object]
@overload reduce
@yield [memo, obj]
@return [Object];T;%0;"@K;'F;)o;*;+T;,iw;-i;.@G; I"static VALUE;T;/I"static VALUE
enum_inject(int argc, VALUE *argv, VALUE obj)
{
struct MEMO *memo;
VALUE init, op;
rb_block_call_func *iter = inject_i;
ID id;
switch (rb_scan_args(argc, argv, "02", &init, &op)) {
case 0:
init = Qundef;
break;
case 1:
if (rb_block_given_p()) {
break;
}
id = rb_check_id(&init);
op = id ? ID2SYM(id) : init;
init = Qundef;
iter = inject_op_i;
break;
case 2:
if (rb_block_given_p()) {
rb_warning("given block not used");
}
id = rb_check_id(&op);
if (id) op = ID2SYM(id);
iter = inject_op_i;
break;
}
memo = MEMO_NEW(init, Qnil, op);
rb_block_call(obj, id_each, 0, 0, iter, (VALUE)memo);
if (memo->v1 == Qundef) return Qnil;
return memo->v1;
};T;0To;
; F; ;
;;;I"Enumerable#reduce;F;[[@0;[[@Gi;T;;;0;[ ;{ ;IC;"Combines all elements of enum by applying a binary
operation, specified by a block or a symbol that names a
method or operator.
If you specify a block, then for each element in enum
the block is passed an accumulator value (memo) and the element.
If you specify a symbol instead, then each element in the collection
will be passed to the named method of memo.
In either case, the result becomes the new value for memo.
At the end of the iteration, the final value of memo is the
return value for the method.
If you do not explicitly specify an initial value for memo,
then the first element of collection is used as the initial value
of memo.
# Sum some numbers
(5..10).reduce(:+) #=> 45
# Same using a block and inject
(5..10).inject { |sum, n| sum + n } #=> 45
# Multiply some numbers
(5..10).reduce(1, :*) #=> 151200
# Same using a block
(5..10).inject(1) { |product, n| product * n } #=> 151200
# find the longest word
longest = %w{ cat sheep bear }.inject do |memo, word|
memo.length > word.length ? memo : word
end
longest #=> "sheep"
;T;[
o;
; I"
overload;F; 0;;; 0; I"inject(initial, sym);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@L;#[ ;$I"@return [Object];T;%0;"@L;&0;'F;(i ;[[I" initial;T0[I"sym;T0;"@Lo;
; I"
overload;F; 0;;; 0; I"inject(sym);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@L;#[ ;$I"@return [Object];T;%0;"@L;&0;'F;(i ;[[I"sym;T0;"@Lo;
; I"
overload;F; 0;;; 0; I"inject(initial);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" memo;TI"obj;T;"@Lo;!
; I" return;F; I" ;T;0; [I" Object;T;"@L;#[ ;$I"(@yield [memo, obj]
@return [Object];T;%0;"@L;&0;'F;(i ;[[I" initial;T0;"@Lo;
; I"
overload;F; 0;;; 0; I" inject;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" memo;TI"obj;T;"@Lo;!
; I" return;F; I" ;T;0; [I" Object;T;"@L;#[ ;$I"(@yield [memo, obj]
@return [Object];T;%0;"@L;&0;'F;(i ;[ ;"@Lo;
; I"
overload;F; 0;;; 0; I"reduce(initial, sym);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@L;#[ ;$I"@return [Object];T;%0;"@L;&0;'F;(i ;[[I" initial;T0[I"sym;T0;"@Lo;
; I"
overload;F; 0;;; 0; I"reduce(sym);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@L;#[ ;$I"@return [Object];T;%0;"@L;&0;'F;(i ;[[I"sym;T0;"@Lo;
; I"
overload;F; 0;;; 0; I"reduce(initial);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" memo;TI"obj;T;"@Lo;!
; I" return;F; I" ;T;0; [I" Object;T;"@L;#[ ;$I"(@yield [memo, obj]
@return [Object];T;%0;"@L;&0;'F;(i ;[[I" initial;T0;"@Lo;
; I"
overload;F; 0;;; 0; I" reduce;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" memo;TI"obj;T;"@Lo;!
; I" return;F; I" ;T;0; [I" Object;T;"@L;#[ ;$I"(@yield [memo, obj]
@return [Object];T;%0;"@L;&0;'F;(i ;[ ;"@L;#[ ;$@{L;%0;"@L;'F;)o;*;+T;,iw;-i;.@G; I"static VALUE;T;/I"static VALUE
enum_inject(int argc, VALUE *argv, VALUE obj)
{
struct MEMO *memo;
VALUE init, op;
rb_block_call_func *iter = inject_i;
ID id;
switch (rb_scan_args(argc, argv, "02", &init, &op)) {
case 0:
init = Qundef;
break;
case 1:
if (rb_block_given_p()) {
break;
}
id = rb_check_id(&init);
op = id ? ID2SYM(id) : init;
init = Qundef;
iter = inject_op_i;
break;
case 2:
if (rb_block_given_p()) {
rb_warning("given block not used");
}
id = rb_check_id(&op);
if (id) op = ID2SYM(id);
iter = inject_op_i;
break;
}
memo = MEMO_NEW(init, Qnil, op);
rb_block_call(obj, id_each, 0, 0, iter, (VALUE)memo);
if (memo->v1 == Qundef) return Qnil;
return memo->v1;
};T;0To;
; F; ;
;;;I"Enumerable#partition;F;[ ;[[@Gi;T;;;0;[ ;{ ;IC;"Returns two arrays, the first containing the elements of
enum for which the block evaluates to true, the second
containing the rest.
If no block is given, an enumerator is returned instead.
(1..6).partition { |v| v.even? } #=> [[2, 4, 6], [1, 3, 5]]
;T;[o;
; I"
overload;F; 0;;; 0; I"partition;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@ Mo;!
; I" return;F; I" ;T;0; [I"
Array;T;"@ M;#[ ;$I"!@yield [obj]
@return [Array];T;%0;"@ M;&0;'F;(i ;[ ;"@ Mo;
; I"
overload;F; 0;;; 0; I"partition;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ M;&0;'F;(i ;[ ;"@ M;#[ ;$I"RReturns two arrays, the first containing the elements of
enum for which the block evaluates to true, the second
containing the rest.
If no block is given, an enumerator is returned instead.
(1..6).partition { |v| v.even? } #=> [[2, 4, 6], [1, 3, 5]]
@overload partition
@yield [obj]
@return [Array]
@overload partition;T;%0;"@ M;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"static VALUE
enum_partition(VALUE obj)
{
struct MEMO *memo;
RETURN_SIZED_ENUMERATOR(obj, 0, 0, enum_size);
memo = MEMO_NEW(rb_ary_new(), rb_ary_new(), 0);
rb_block_call(obj, id_each, 0, 0, partition_i, (VALUE)memo);
return rb_assoc_new(memo->v1, memo->v2);
};T;0To;
; F; ;
;;;I"Enumerable#group_by;F;[ ;[[@Gi;T;:
group_by;0;[ ;{ ;IC;"AGroups the collection by result of the block. Returns a hash where the
keys are the evaluated result from the block and the values are
arrays of elements in the collection that correspond to the key.
If no block is given an enumerator is returned.
(1..6).group_by { |i| i%3 } #=> {0=>[3, 6], 1=>[1, 4], 2=>[2, 5]}
;T;[o;
; I"
overload;F; 0;; ; 0; I"
group_by;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@EMo;!
; I" return;F; I" ;T;0; [I" Hash;T;"@EM;#[ ;$I" @yield [obj]
@return [Hash];T;%0;"@EM;&0;'F;(i ;[ ;"@EMo;
; I"
overload;F; 0;; ; 0; I"
group_by;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@EM;&0;'F;(i ;[ ;"@EM;#[ ;$I"Groups the collection by result of the block. Returns a hash where the
keys are the evaluated result from the block and the values are
arrays of elements in the collection that correspond to the key.
If no block is given an enumerator is returned.
(1..6).group_by { |i| i%3 } #=> {0=>[3, 6], 1=>[1, 4], 2=>[2, 5]}
@overload group_by
@yield [obj]
@return [Hash]
@overload group_by;T;%0;"@EM;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"static VALUE
enum_group_by(VALUE obj)
{
VALUE hash;
RETURN_SIZED_ENUMERATOR(obj, 0, 0, enum_size);
hash = rb_hash_new();
rb_block_call(obj, id_each, 0, 0, group_by_i, hash);
OBJ_INFECT(hash, obj);
return hash;
};T;0To;
; F; ;
;;;I"Enumerable#first;F;[[@0;[[@GiC;T;:
first;0;[ ;{ ;IC;"Returns the first element, or the first +n+ elements, of the enumerable.
If the enumerable is empty, the first form returns nil, and the
second form returns an empty array.
%w[foo bar baz].first #=> "foo"
%w[foo bar baz].first(2) #=> ["foo", "bar"]
%w[foo bar baz].first(10) #=> ["foo", "bar", "baz"]
[].first #=> nil
[].first(10) #=> []
;T;[o;
; I"
overload;F; 0;;
; 0; I"
first;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;TI"nil;T;"@mM;#[ ;$I"@return [Object, nil];T;%0;"@mM;&0;'F;(i ;[ ;"@mMo;
; I"
overload;F; 0;;
; 0; I"
first(n);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@mM;#[ ;$I"@return [Array];T;%0;"@mM;&0;'F;(i ;[[I"n;T0;"@mM;#[ ;$I"Returns the first element, or the first +n+ elements, of the enumerable.
If the enumerable is empty, the first form returns nil, and the
second form returns an empty array.
%w[foo bar baz].first #=> "foo"
%w[foo bar baz].first(2) #=> ["foo", "bar"]
%w[foo bar baz].first(10) #=> ["foo", "bar", "baz"]
[].first #=> nil
[].first(10) #=> []
@overload first
@return [Object, nil]
@overload first(n)
@return [Array];T;%0;"@mM;'F;)o;*;+T;,i2;-iA;.@G; I"static VALUE;T;/I"*static VALUE
enum_first(int argc, VALUE *argv, VALUE obj)
{
struct MEMO *memo;
rb_check_arity(argc, 0, 1);
if (argc > 0) {
return enum_take(obj, argv[0]);
}
else {
memo = MEMO_NEW(Qnil, 0, 0);
rb_block_call(obj, id_each, 0, 0, first_i, (VALUE)memo);
return memo->v1;
}
};T;0To;
; F; ;
;;;I"Enumerable#all?;F;[ ;[[@GiE;T;: all?;0;[ ;{ ;IC;"Passes each element of the collection to the given block. The method
returns true if the block never returns
false or nil. If the block is not given,
Ruby adds an implicit block of { |obj| obj } which will
cause #all? to return +true+ when none of the collection members are
+false+ or +nil+.
%w[ant bear cat].all? { |word| word.length >= 3 } #=> true
%w[ant bear cat].all? { |word| word.length >= 4 } #=> false
[nil, true, 99].all? #=> false
;T;[o;
; I"
overload;F; 0;; ; 0; I" all?;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@Mo;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@M;#[ ;$I"#@yield [obj]
@return [Boolean];T;%0;"@M;&0;'F;(i ;[ ;"@Mo;!
; I" return;F; @;0; [@;"@M;#[ ;$I"JPasses each element of the collection to the given block. The method
returns true if the block never returns
false or nil. If the block is not given,
Ruby adds an implicit block of { |obj| obj } which will
cause #all? to return +true+ when none of the collection members are
+false+ or +nil+.
%w[ant bear cat].all? { |word| word.length >= 3 } #=> true
%w[ant bear cat].all? { |word| word.length >= 4 } #=> false
[nil, true, 99].all? #=> false
@overload all?
@yield [obj]
@return [Boolean];T;%0;"@M;'F;)o;*;+T;,i4;-iC;.@G; I"static VALUE;T;/I"static VALUE
enum_all(VALUE obj)
{
struct MEMO *memo = MEMO_NEW(Qtrue, 0, 0);
rb_block_call(obj, id_each, 0, 0, ENUMFUNC(all), (VALUE)memo);
return memo->v1;
};T;0To;
; F; ;
;;;I"Enumerable#any?;F;[ ;[[@Gig;T;;;0;[ ;{ ;IC;"-Passes each element of the collection to the given block. The method
returns true if the block ever returns a value other
than false or nil. If the block is not
given, Ruby adds an implicit block of { |obj| obj } that
will cause #any? to return +true+ if at least one of the collection
members is not +false+ or +nil+.
%w[ant bear cat].any? { |word| word.length >= 3 } #=> true
%w[ant bear cat].any? { |word| word.length >= 4 } #=> true
[nil, true, 99].any? #=> true
;T;[o;
; I"
overload;F; 0;;; 0; I" any?;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@Mo;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@M;#[ ;$I"#@yield [obj]
@return [Boolean];T;%0;"@M;&0;'F;(i ;[ ;"@Mo;!
; I" return;F; @;0; [@;"@M;#[ ;$I"bPasses each element of the collection to the given block. The method
returns true if the block ever returns a value other
than false or nil. If the block is not
given, Ruby adds an implicit block of { |obj| obj } that
will cause #any? to return +true+ if at least one of the collection
members is not +false+ or +nil+.
%w[ant bear cat].any? { |word| word.length >= 3 } #=> true
%w[ant bear cat].any? { |word| word.length >= 4 } #=> true
[nil, true, 99].any? #=> true
@overload any?
@yield [obj]
@return [Boolean];T;%0;"@M;'F;)o;*;+T;,iV;-ie;.@G; I"static VALUE;T;/I"static VALUE
enum_any(VALUE obj)
{
struct MEMO *memo = MEMO_NEW(Qfalse, 0, 0);
rb_block_call(obj, id_each, 0, 0, ENUMFUNC(any), (VALUE)memo);
return memo->v1;
};T;0To;
; F; ;
;;;I"Enumerable#one?;F;[ ;[[@GiZ;T;: one?;0;[ ;{ ;IC;"TPasses each element of the collection to the given block. The method
returns true if the block returns true
exactly once. If the block is not given, one? will return
true only if exactly one of the collection members is
true.
%w{ant bear cat}.one? { |word| word.length == 4 } #=> true
%w{ant bear cat}.one? { |word| word.length > 4 } #=> false
%w{ant bear cat}.one? { |word| word.length < 4 } #=> false
[ nil, true, 99 ].one? #=> false
[ nil, true, false ].one? #=> true
;T;[o;
; I"
overload;F; 0;; ; 0; I" one?;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@Mo;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@M;#[ ;$I"#@yield [obj]
@return [Boolean];T;%0;"@M;&0;'F;(i ;[ ;"@Mo;!
; I" return;F; @;0; [@;"@M;#[ ;$I"Passes each element of the collection to the given block. The method
returns true if the block returns true
exactly once. If the block is not given, one? will return
true only if exactly one of the collection members is
true.
%w{ant bear cat}.one? { |word| word.length == 4 } #=> true
%w{ant bear cat}.one? { |word| word.length > 4 } #=> false
%w{ant bear cat}.one? { |word| word.length < 4 } #=> false
[ nil, true, 99 ].one? #=> false
[ nil, true, false ].one? #=> true
@overload one?
@yield [obj]
@return [Boolean];T;%0;"@M;'F;)o;*;+T;,iI;-iY;.@G; I"static VALUE;T;/I"static VALUE
enum_one(VALUE obj)
{
struct MEMO *memo = MEMO_NEW(Qundef, 0, 0);
VALUE result;
rb_block_call(obj, id_each, 0, 0, ENUMFUNC(one), (VALUE)memo);
result = memo->v1;
if (result == Qundef) return Qfalse;
return result;
};T;0To;
; F; ;
;;;I"Enumerable#none?;F;[ ;[[@Gi;T;:
none?;0;[ ;{ ;IC;"Passes each element of the collection to the given block. The method
returns true if the block never returns true
for all elements. If the block is not given, none? will return
true only if none of the collection members is true.
%w{ant bear cat}.none? { |word| word.length == 5 } #=> true
%w{ant bear cat}.none? { |word| word.length >= 4 } #=> false
[].none? #=> true
[nil].none? #=> true
[nil, false].none? #=> true
[nil, false, true].none? #=> false
;T;[o;
; I"
overload;F; 0;;
; 0; I"
none?;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@No;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@N;#[ ;$I"#@yield [obj]
@return [Boolean];T;%0;"@N;&0;'F;(i ;[ ;"@No;!
; I" return;F; @;0; [@;"@N;#[ ;$I"Passes each element of the collection to the given block. The method
returns true if the block never returns true
for all elements. If the block is not given, none? will return
true only if none of the collection members is true.
%w{ant bear cat}.none? { |word| word.length == 5 } #=> true
%w{ant bear cat}.none? { |word| word.length >= 4 } #=> false
[].none? #=> true
[nil].none? #=> true
[nil, false].none? #=> true
[nil, false, true].none? #=> false
@overload none?
@yield [obj]
@return [Boolean];T;%0;"@N;'F;)o;*;+T;,io;-i~;.@G; I"static VALUE;T;/I"static VALUE
enum_none(VALUE obj)
{
struct MEMO *memo = MEMO_NEW(Qtrue, 0, 0);
rb_block_call(obj, id_each, 0, 0, ENUMFUNC(none), (VALUE)memo);
return memo->v1;
};T;0To;
; F; ;
;;;I"Enumerable#min;F;[[@0;[[@Gi;T;:min;0;[ ;{ ;IC;";Returns the object in enum with the minimum value. The
first form assumes all objects implement Comparable;
the second uses the block to return a <=> b.
a = %w(albatross dog horse)
a.min #=> "albatross"
a.min { |a, b| a.length <=> b.length } #=> "dog"
If the +n+ argument is given, minimum +n+ elements are returned
as an array.
a = %w[albatross dog horse]
a.min(2) #=> ["albatross", "dog"]
a.min(2) {|a, b| a.length <=> b.length } #=> ["dog", "horse"]
;T;[ o;
; I"
overload;F; 0;;; 0; I"min;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@%N;#[ ;$I"@return [Object];T;%0;"@%N;&0;'F;(i ;[ ;"@%No;
; I"
overload;F; 0;;; 0; I"min;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"a;TI"b;T;"@%No;!
; I" return;F; I" ;T;0; [I" Object;T;"@%N;#[ ;$I"$@yield [ a,b ]
@return [Object];T;%0;"@%N;&0;'F;(i ;[ ;"@%No;
; I"
overload;F; 0;;; 0; I" min(n);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@%N;#[ ;$I"@return [Array];T;%0;"@%N;&0;'F;(i ;[[I"n;T0;"@%No;
; I"
overload;F; 0;;; 0; I" min(n);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"a;TI"b;T;"@%No;!
; I" return;F; I" ;T;0; [I"
Array;T;"@%N;#[ ;$I"#@yield [ a,b ]
@return [Array];T;%0;"@%N;&0;'F;(i ;[[I"n;T0;"@%N;#[ ;$I"Returns the object in enum with the minimum value. The
first form assumes all objects implement Comparable;
the second uses the block to return a <=> b.
a = %w(albatross dog horse)
a.min #=> "albatross"
a.min { |a, b| a.length <=> b.length } #=> "dog"
If the +n+ argument is given, minimum +n+ elements are returned
as an array.
a = %w[albatross dog horse]
a.min(2) #=> ["albatross", "dog"]
a.min(2) {|a, b| a.length <=> b.length } #=> ["dog", "horse"]
@overload min
@return [Object]
@overload min
@yield [ a,b ]
@return [Object]
@overload min(n)
@return [Array]
@overload min(n)
@yield [ a,b ]
@return [Array];T;%0;"@%N;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"static VALUE
enum_min(int argc, VALUE *argv, VALUE obj)
{
struct MEMO *memo = MEMO_NEW(Qundef, 0, 0);
VALUE result;
VALUE num;
rb_scan_args(argc, argv, "01", &num);
if (!NIL_P(num))
return nmin_run(obj, num, 0, 0);
if (rb_block_given_p()) {
rb_block_call(obj, id_each, 0, 0, min_ii, (VALUE)memo);
}
else {
rb_block_call(obj, id_each, 0, 0, min_i, (VALUE)memo);
}
result = memo->v1;
if (result == Qundef) return Qnil;
return result;
};T;0To;
; F; ;
;;;I"Enumerable#max;F;[[@0;[[@Gi ;T;:max;0;[ ;{ ;IC;":Returns the object in _enum_ with the maximum value. The
first form assumes all objects implement Comparable;
the second uses the block to return a <=> b.
a = %w(albatross dog horse)
a.max #=> "horse"
a.max { |a, b| a.length <=> b.length } #=> "albatross"
If the +n+ argument is given, maximum +n+ elements are returned
as an array.
a = %w[albatross dog horse]
a.max(2) #=> ["horse", "dog"]
a.max(2) {|a, b| a.length <=> b.length } #=> ["albatross", "horse"]
;T;[ o;
; I"
overload;F; 0;;; 0; I"max;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@xN;#[ ;$I"@return [Object];T;%0;"@xN;&0;'F;(i ;[ ;"@xNo;
; I"
overload;F; 0;;; 0; I"max;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"a;TI"b;T;"@xNo;!
; I" return;F; I" ;T;0; [I" Object;T;"@xN;#[ ;$I"#@yield [a, b]
@return [Object];T;%0;"@xN;&0;'F;(i ;[ ;"@xNo;
; I"
overload;F; 0;;; 0; I" max(n);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@xN;#[ ;$I"@return [Object];T;%0;"@xN;&0;'F;(i ;[[I"n;T0;"@xNo;
; I"
overload;F; 0;;; 0; I" max(n);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"a;TI"b;T;"@xNo;!
; I" return;F; I" ;T;0; [I" Object;T;"@xN;#[ ;$I""@yield [a,b]
@return [Object];T;%0;"@xN;&0;'F;(i ;[[I"n;T0;"@xN;#[ ;$I"Returns the object in _enum_ with the maximum value. The
first form assumes all objects implement Comparable;
the second uses the block to return a <=> b.
a = %w(albatross dog horse)
a.max #=> "horse"
a.max { |a, b| a.length <=> b.length } #=> "albatross"
If the +n+ argument is given, maximum +n+ elements are returned
as an array.
a = %w[albatross dog horse]
a.max(2) #=> ["horse", "dog"]
a.max(2) {|a, b| a.length <=> b.length } #=> ["albatross", "horse"]
@overload max
@return [Object]
@overload max
@yield [a, b]
@return [Object]
@overload max(n)
@return [Object]
@overload max(n)
@yield [a,b]
@return [Object];T;%0;"@xN;'F;)o;*;+T;,i;-i ;.@G; I"static VALUE;T;/I"static VALUE
enum_max(int argc, VALUE *argv, VALUE obj)
{
struct MEMO *memo = MEMO_NEW(Qundef, 0, 0);
VALUE result;
VALUE num;
rb_scan_args(argc, argv, "01", &num);
if (!NIL_P(num))
return nmin_run(obj, num, 0, 1);
if (rb_block_given_p()) {
rb_block_call(obj, id_each, 0, 0, max_ii, (VALUE)memo);
}
else {
rb_block_call(obj, id_each, 0, 0, max_i, (VALUE)memo);
}
result = memo->v1;
if (result == Qundef) return Qnil;
return result;
};T;0To;
; F; ;
;;;I"Enumerable#minmax;F;[ ;[[@Gi;T;: minmax;0;[ ;{ ;IC;"Returns a two element array which contains the minimum and the
maximum value in the enumerable. The first form assumes all
objects implement Comparable; the second uses the
block to return a <=> b.
a = %w(albatross dog horse)
a.minmax #=> ["albatross", "horse"]
a.minmax { |a, b| a.length <=> b.length } #=> ["dog", "albatross"]
;T;[o;
; I"
overload;F; 0;;; 0; I" minmax;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@N;#[ ;$I"@return [Array];T;%0;"@N;&0;'F;(i ;[ ;"@No;
; I"
overload;F; 0;;; 0; I" minmax;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"a;TI"b;T;"@No;!
; I" return;F; I" ;T;0; [I"
Array;T;"@N;#[ ;$I""@yield [a, b]
@return [Array];T;%0;"@N;&0;'F;(i ;[ ;"@N;#[ ;$I"Returns a two element array which contains the minimum and the
maximum value in the enumerable. The first form assumes all
objects implement Comparable; the second uses the
block to return a <=> b.
a = %w(albatross dog horse)
a.minmax #=> ["albatross", "horse"]
a.minmax { |a, b| a.length <=> b.length } #=> ["dog", "albatross"]
@overload minmax
@return [Array]
@overload minmax
@yield [a, b]
@return [Array];T;%0;"@N;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"dstatic VALUE
enum_minmax(VALUE obj)
{
struct MEMO *memo = MEMO_NEW(Qundef, Qundef, Qundef);
struct minmax_t *m = (struct minmax_t *)&memo->v1;
m->min = Qundef;
m->last = Qundef;
if (rb_block_given_p()) {
rb_block_call(obj, id_each, 0, 0, minmax_ii, (VALUE)memo);
if (m->last != Qundef)
minmax_ii_update(m->last, m->last, m);
}
else {
rb_block_call(obj, id_each, 0, 0, minmax_i, (VALUE)memo);
if (m->last != Qundef)
minmax_i_update(m->last, m->last, m);
}
if (m->min != Qundef) {
return rb_assoc_new(m->min, m->max);
}
return rb_assoc_new(Qnil, Qnil);
};T;0To;
; F; ;
;;;I"Enumerable#min_by;F;[[@0;[[@Gi;T;: min_by;0;[ ;{ ;IC;"{Returns the object in enum that gives the minimum
value from the given block.
If no block is given, an enumerator is returned instead.
a = %w(albatross dog horse)
a.min_by { |x| x.length } #=> "dog"
If the +n+ argument is given, minimum +n+ elements are returned
as an array.
a = %w[albatross dog horse]
p a.min_by(2) {|x| x.length } #=> ["dog", "horse"]
;T;[ o;
; I"
overload;F; 0;;; 0; I" min_by;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@No;!
; I" return;F; I" ;T;0; [I" Object;T;"@N;#[ ;$I""@yield [obj]
@return [Object];T;%0;"@N;&0;'F;(i ;[ ;"@No;
; I"
overload;F; 0;;; 0; I" min_by;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@N;&0;'F;(i ;[ ;"@No;
; I"
overload;F; 0;;; 0; I"min_by(n);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@No;!
; I" return;F; I" ;T;0; [I"
Array;T;"@N;#[ ;$I"!@yield [obj]
@return [Array];T;%0;"@N;&0;'F;(i ;[[I"n;T0;"@No;
; I"
overload;F; 0;;; 0; I"min_by(n);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@N;&0;'F;(i ;[[I"n;T0;"@N;#[ ;$I"
Returns the object in enum that gives the minimum
value from the given block.
If no block is given, an enumerator is returned instead.
a = %w(albatross dog horse)
a.min_by { |x| x.length } #=> "dog"
If the +n+ argument is given, minimum +n+ elements are returned
as an array.
a = %w[albatross dog horse]
p a.min_by(2) {|x| x.length } #=> ["dog", "horse"]
@overload min_by
@yield [obj]
@return [Object]
@overload min_by
@overload min_by(n)
@yield [obj]
@return [Array]
@overload min_by(n);T;%0;"@N;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"static VALUE
enum_min_by(int argc, VALUE *argv, VALUE obj)
{
struct MEMO *memo;
VALUE num;
rb_scan_args(argc, argv, "01", &num);
RETURN_SIZED_ENUMERATOR(obj, argc, argv, enum_size);
if (!NIL_P(num))
return nmin_run(obj, num, 1, 0);
memo = MEMO_NEW(Qundef, Qnil, 0);
rb_block_call(obj, id_each, 0, 0, min_by_i, (VALUE)memo);
return memo->v2;
};T;0To;
; F; ;
;;;I"Enumerable#max_by;F;[[@0;[[@Gi^;T;: max_by;0;[ ;{ ;IC;"Returns the object in enum that gives the maximum
value from the given block.
If no block is given, an enumerator is returned instead.
a = %w(albatross dog horse)
a.max_by { |x| x.length } #=> "albatross"
If the +n+ argument is given, minimum +n+ elements are returned
as an array.
a = %w[albatross dog horse]
a.max_by(2) {|x| x.length } #=> ["albatross", "horse"]
enum.max_by(n) can be used to implement weighted random sampling.
Following example implements and use Enumerable#wsample.
module Enumerable
# weighted random sampling.
#
# Pavlos S. Efraimidis, Paul G. Spirakis
# Weighted random sampling with a reservoir
# Information Processing Letters
# Volume 97, Issue 5 (16 March 2006)
def wsample(n)
self.max_by(n) {|v| rand ** (1.0/yield(v)) }
end
end
e = (-20..20).to_a*10000
a = e.wsample(20000) {|x|
Math.exp(-(x/5.0)**2) # normal distribution
}
# a is 20000 samples from e.
p a.length #=> 20000
h = a.group_by {|x| x }
-10.upto(10) {|x| puts "*" * (h[x].length/30.0).to_i if h[x] }
#=> *
# ***
# ******
# ***********
# ******************
# *****************************
# *****************************************
# ****************************************************
# ***************************************************************
# ********************************************************************
# ***********************************************************************
# ***********************************************************************
# **************************************************************
# ****************************************************
# ***************************************
# ***************************
# ******************
# ***********
# *******
# ***
# *
;T;[ o;
; I"
overload;F; 0;;; 0; I" max_by;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@@Oo;!
; I" return;F; I" ;T;0; [I" Object;T;"@@O;#[ ;$I""@yield [obj]
@return [Object];T;%0;"@@O;&0;'F;(i ;[ ;"@@Oo;
; I"
overload;F; 0;;; 0; I" max_by;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@@O;&0;'F;(i ;[ ;"@@Oo;
; I"
overload;F; 0;;; 0; I"max_by(n);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@@Oo;!
; I" return;F; I" ;T;0; [I" Object;T;"@@O;#[ ;$I""@yield [obj]
@return [Object];T;%0;"@@O;&0;'F;(i ;[[I"n;T0;"@@Oo;
; I"
overload;F; 0;;; 0; I"max_by(n);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@@O;&0;'F;(i ;[[I"n;T0;"@@O;#[ ;$I"Returns the object in enum that gives the maximum
value from the given block.
If no block is given, an enumerator is returned instead.
a = %w(albatross dog horse)
a.max_by { |x| x.length } #=> "albatross"
If the +n+ argument is given, minimum +n+ elements are returned
as an array.
a = %w[albatross dog horse]
a.max_by(2) {|x| x.length } #=> ["albatross", "horse"]
enum.max_by(n) can be used to implement weighted random sampling.
Following example implements and use Enumerable#wsample.
module Enumerable
# weighted random sampling.
#
# Pavlos S. Efraimidis, Paul G. Spirakis
# Weighted random sampling with a reservoir
# Information Processing Letters
# Volume 97, Issue 5 (16 March 2006)
def wsample(n)
self.max_by(n) {|v| rand ** (1.0/yield(v)) }
end
end
e = (-20..20).to_a*10000
a = e.wsample(20000) {|x|
Math.exp(-(x/5.0)**2) # normal distribution
}
# a is 20000 samples from e.
p a.length #=> 20000
h = a.group_by {|x| x }
-10.upto(10) {|x| puts "*" * (h[x].length/30.0).to_i if h[x] }
#=> *
# ***
# ******
# ***********
# ******************
# *****************************
# *****************************************
# ****************************************************
# ***************************************************************
# ********************************************************************
# ***********************************************************************
# ***********************************************************************
# **************************************************************
# ****************************************************
# ***************************************
# ***************************
# ******************
# ***********
# *******
# ***
# *
@overload max_by
@yield [obj]
@return [Object]
@overload max_by
@overload max_by(n)
@yield [obj]
@return [Object]
@overload max_by(n);T;%0;"@@O;'F;)o;*;+T;,i;-i^;.@G; I"static VALUE;T;/I"static VALUE
enum_max_by(int argc, VALUE *argv, VALUE obj)
{
struct MEMO *memo;
VALUE num;
rb_scan_args(argc, argv, "01", &num);
RETURN_SIZED_ENUMERATOR(obj, argc, argv, enum_size);
if (!NIL_P(num))
return nmin_run(obj, num, 1, 1);
memo = MEMO_NEW(Qundef, Qnil, 0);
rb_block_call(obj, id_each, 0, 0, max_by_i, (VALUE)memo);
return memo->v2;
};T;0To;
; F; ;
;;;I"Enumerable#minmax_by;F;[ ;[[@Gi;T;:minmax_by;0;[ ;{ ;IC;"+Returns a two element array containing the objects in
enum that correspond to the minimum and maximum values respectively
from the given block.
If no block is given, an enumerator is returned instead.
a = %w(albatross dog horse)
a.minmax_by { |x| x.length } #=> ["dog", "albatross"]
;T;[o;
; I"
overload;F; 0;;; 0; I"minmax_by;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@Oo;!
; I" return;F; I" ;T;0; [I"
Array;T;"@O;#[ ;$I"!@yield [obj]
@return [Array];T;%0;"@O;&0;'F;(i ;[ ;"@Oo;
; I"
overload;F; 0;;; 0; I"minmax_by;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@O;&0;'F;(i ;[ ;"@O;#[ ;$I"vReturns a two element array containing the objects in
enum that correspond to the minimum and maximum values respectively
from the given block.
If no block is given, an enumerator is returned instead.
a = %w(albatross dog horse)
a.minmax_by { |x| x.length } #=> ["dog", "albatross"]
@overload minmax_by
@yield [obj]
@return [Array]
@overload minmax_by;T;%0;"@O;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I".static VALUE
enum_minmax_by(VALUE obj)
{
VALUE memo;
struct minmax_by_t *m = NEW_MEMO_FOR(struct minmax_by_t, memo);
RETURN_SIZED_ENUMERATOR(obj, 0, 0, enum_size);
m->min_bv = Qundef;
m->max_bv = Qundef;
m->min = Qnil;
m->max = Qnil;
m->last_bv = Qundef;
m->last = Qundef;
rb_block_call(obj, id_each, 0, 0, minmax_by_i, memo);
if (m->last_bv != Qundef)
minmax_by_i_update(m->last_bv, m->last_bv, m->last, m->last, m);
m = MEMO_FOR(struct minmax_by_t, memo);
return rb_assoc_new(m->min, m->max);
};T;0To;
; F; ;
;;;I"Enumerable#member?;F;[[I"val;T0;[[@Gi;T;;;0;[ ;{ ;IC;"HReturns true if any member of enum equals
obj. Equality is tested using ==.
IO.constants.include? :SEEK_SET #=> true
IO.constants.include? :SEEK_NO_FURTHER #=> false
IO.constants.member? :SEEK_SET #=> true
IO.constants.member? :SEEK_NO_FURTHER #=> false
;T;[o;
; I"
overload;F; 0;;; 0; I"include?(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@O;#[ ;$I"@return [Boolean];T;%0;"@O;&0;'F;(i ;[[I"obj;T0;"@Oo;
; I"
overload;F; 0;;; 0; I"member?(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@O;#[ ;$I"@return [Boolean];T;%0;"@O;&0;'F;(i ;[[I"obj;T0;"@Oo;!
; I" return;F; @;0; [@;"@O;#[ ;$I"Returns true if any member of enum equals
obj. Equality is tested using ==.
IO.constants.include? :SEEK_SET #=> true
IO.constants.include? :SEEK_NO_FURTHER #=> false
IO.constants.member? :SEEK_SET #=> true
IO.constants.member? :SEEK_NO_FURTHER #=> false
@overload include?(obj)
@return [Boolean]
@overload member?(obj)
@return [Boolean];T;%0;"@O;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"static VALUE
enum_member(VALUE obj, VALUE val)
{
struct MEMO *memo = MEMO_NEW(val, Qfalse, 0);
rb_block_call(obj, id_each, 0, 0, member_i, (VALUE)memo);
return memo->v2;
};T;0To;
; F; ;
;;;I"Enumerable#include?;F;[[I"val;T0;[[@Gi;T;;;0;[ ;{ ;IC;"HReturns true if any member of enum equals
obj. Equality is tested using ==.
IO.constants.include? :SEEK_SET #=> true
IO.constants.include? :SEEK_NO_FURTHER #=> false
IO.constants.member? :SEEK_SET #=> true
IO.constants.member? :SEEK_NO_FURTHER #=> false
;T;[o;
; I"
overload;F; 0;;; 0; I"include?(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@O;#[ ;$I"@return [Boolean];T;%0;"@O;&0;'F;(i ;[[I"obj;T0;"@Oo;
; I"
overload;F; 0;;; 0; I"member?(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@O;#[ ;$I"@return [Boolean];T;%0;"@O;&0;'F;(i ;[[I"obj;T0;"@Oo;!
; I" return;F; @;0; [@;"@O;#[ ;$@O;%0;"@O;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"static VALUE
enum_member(VALUE obj, VALUE val)
{
struct MEMO *memo = MEMO_NEW(val, Qfalse, 0);
rb_block_call(obj, id_each, 0, 0, member_i, (VALUE)memo);
return memo->v2;
};T;0To;
; F; ;
;;;I" Enumerable#each_with_index;F;[[@0;[[@Gi;T;:each_with_index;0;[ ;{ ;IC;"_Calls block with two arguments, the item and its index,
for each item in enum. Given arguments are passed through
to #each().
If no block is given, an enumerator is returned instead.
hash = Hash.new
%w(cat dog wombat).each_with_index { |item, index|
hash[item] = index
}
hash #=> {"cat"=>0, "dog"=>1, "wombat"=>2}
;T;[o;
; I"
overload;F; 0;;; 0; I"each_with_index(*args);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;TI"i;T;"@Po;!
; I" return;F; I" ;T;0; [I"Enumerator;T;"@P;#[ ;$I")@yield [obj, i]
@return [Enumerator];T;%0;"@P;&0;'F;(i ;[[I"
*args;T0;"@Po;
; I"
overload;F; 0;;; 0; I"each_with_index(*args);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@P;&0;'F;(i ;[[I"
*args;T0;"@P;#[ ;$I"Calls block with two arguments, the item and its index,
for each item in enum. Given arguments are passed through
to #each().
If no block is given, an enumerator is returned instead.
hash = Hash.new
%w(cat dog wombat).each_with_index { |item, index|
hash[item] = index
}
hash #=> {"cat"=>0, "dog"=>1, "wombat"=>2}
@overload each_with_index(*args)
@yield [obj, i]
@return [Enumerator]
@overload each_with_index(*args);T;%0;"@P;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"static VALUE
enum_each_with_index(int argc, VALUE *argv, VALUE obj)
{
struct MEMO *memo;
RETURN_SIZED_ENUMERATOR(obj, argc, argv, enum_size);
memo = MEMO_NEW(0, 0, 0);
rb_block_call(obj, id_each, argc, argv, each_with_index_i, (VALUE)memo);
return obj;
};T;0To;
; F; ;
;;;I" Enumerable#reverse_each;F;[[@0;[[@Gi8;T;:reverse_each;0;[ ;{ ;IC;"Builds a temporary array and traverses that array in reverse order.
If no block is given, an enumerator is returned instead.
(1..3).reverse_each { |v| p v }
produces:
3
2
1
;T;[o;
; I"
overload;F; 0;;; 0; I"reverse_each(*args);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" item;T;"@>Po;!
; I" return;F; I" ;T;0; [I"Enumerator;T;"@>P;#[ ;$I"'@yield [item]
@return [Enumerator];T;%0;"@>P;&0;'F;(i ;[[I"
*args;T0;"@>Po;
; I"
overload;F; 0;;; 0; I"reverse_each(*args);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@>P;&0;'F;(i ;[[I"
*args;T0;"@>P;#[ ;$I"'Builds a temporary array and traverses that array in reverse order.
If no block is given, an enumerator is returned instead.
(1..3).reverse_each { |v| p v }
produces:
3
2
1
@overload reverse_each(*args)
@yield [item]
@return [Enumerator]
@overload reverse_each(*args);T;%0;"@>P;'F;)o;*;+T;,i&;-i6;.@G; I"static VALUE;T;/I"$static VALUE
enum_reverse_each(int argc, VALUE *argv, VALUE obj)
{
VALUE ary;
long i;
RETURN_SIZED_ENUMERATOR(obj, argc, argv, enum_size);
ary = enum_to_a(argc, argv, obj);
for (i = RARRAY_LEN(ary); --i >= 0; ) {
rb_yield(RARRAY_AREF(ary, i));
}
return obj;
};T;0To;
; F; ;
;;;I"Enumerable#each_entry;F;[[@0;[[@Gio;T;:each_entry;0;[ ;{ ;IC;"zCalls block once for each element in +self+, passing that
element as a parameter, converting multiple values from yield to an
array.
If no block is given, an enumerator is returned instead.
class Foo
include Enumerable
def each
yield 1
yield 1, 2
yield
end
end
Foo.new.each_entry{ |o| p o }
produces:
1
[1, 2]
nil
;T;[o;
; I"
overload;F; 0;;; 0; I"each_entry;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@kPo;!
; I" return;F; I" ;T;0; [I"Enumerator;T;"@kP;#[ ;$I"&@yield [obj]
@return [Enumerator];T;%0;"@kP;&0;'F;(i ;[ ;"@kPo;
; I"
overload;F; 0;;; 0; I"each_entry;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@kP;&0;'F;(i ;[ ;"@kP;#[ ;$I"Calls block once for each element in +self+, passing that
element as a parameter, converting multiple values from yield to an
array.
If no block is given, an enumerator is returned instead.
class Foo
include Enumerable
def each
yield 1
yield 1, 2
yield
end
end
Foo.new.each_entry{ |o| p o }
produces:
1
[1, 2]
nil
@overload each_entry
@yield [obj]
@return [Enumerator]
@overload each_entry;T;%0;"@kP;'F;)o;*;+T;,iR;-im;.@G; I"static VALUE;T;/I"static VALUE
enum_each_entry(int argc, VALUE *argv, VALUE obj)
{
RETURN_SIZED_ENUMERATOR(obj, argc, argv, enum_size);
rb_block_call(obj, id_each, argc, argv, each_val_i, 0);
return obj;
};T;0To;
; F; ;
;;;I"Enumerable#each_slice;F;[[I"n;T0;[[@Gi;T;:each_slice;0;[ ;{ ;IC;"Iterates the given block for each slice of elements. If no
block is given, returns an enumerator.
(1..10).each_slice(3) { |a| p a }
# outputs below
[1, 2, 3]
[4, 5, 6]
[7, 8, 9]
[10]
;T;[o;
; I"
overload;F; 0;;; 0; I"each_slice(n);T;IC;" ;T;[o;!
; I"
yield;F; I"[];T;0; 0;"@Po;!
; I" return;F; I" ;T;0; [I"nil;T;"@P;#[ ;$I" @yield []
@return [nil];T;%0;"@P;&0;'F;(i ;[[I"n;T0;"@Po;
; I"
overload;F; 0;;; 0; I"each_slice(n);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@P;&0;'F;(i ;[[I"n;T0;"@P;#[ ;$I"#Iterates the given block for each slice of elements. If no
block is given, returns an enumerator.
(1..10).each_slice(3) { |a| p a }
# outputs below
[1, 2, 3]
[4, 5, 6]
[7, 8, 9]
[10]
@overload each_slice(n)
@yield []
@return [nil]
@overload each_slice(n);T;%0;"@P;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"?static VALUE
enum_each_slice(VALUE obj, VALUE n)
{
long size = NUM2LONG(n);
VALUE ary;
struct MEMO *memo;
int arity;
if (size <= 0) rb_raise(rb_eArgError, "invalid slice size");
RETURN_SIZED_ENUMERATOR(obj, 1, &n, enum_each_slice_size);
size = limit_by_enum_size(obj, size);
ary = rb_ary_new2(size);
arity = rb_block_arity();
memo = MEMO_NEW(ary, dont_recycle_block_arg(arity), size);
rb_block_call(obj, id_each, 0, 0, each_slice_i, (VALUE)memo);
ary = memo->v1;
if (RARRAY_LEN(ary) > 0) rb_yield(ary);
return Qnil;
};T;0To;
; F; ;
;;;I"Enumerable#each_cons;F;[[I"n;T0;[[@Gi;T;:each_cons;0;[ ;{ ;IC;"#Iterates the given block for each array of consecutive
elements. If no block is given, returns an enumerator.
e.g.:
(1..10).each_cons(3) { |a| p a }
# outputs below
[1, 2, 3]
[2, 3, 4]
[3, 4, 5]
[4, 5, 6]
[5, 6, 7]
[6, 7, 8]
[7, 8, 9]
[8, 9, 10]
;T;[o;
; I"
overload;F; 0;;; 0; I"each_cons(n);T;IC;" ;T;[o;!
; I"
yield;F; I"[];T;0; 0;"@Po;!
; I" return;F; I" ;T;0; [I"nil;T;"@P;#[ ;$I" @yield []
@return [nil];T;%0;"@P;&0;'F;(i ;[[I"n;T0;"@Po;
; I"
overload;F; 0;;; 0; I"each_cons(n);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@P;&0;'F;(i ;[[I"n;T0;"@P;#[ ;$I"pIterates the given block for each array of consecutive
elements. If no block is given, returns an enumerator.
e.g.:
(1..10).each_cons(3) { |a| p a }
# outputs below
[1, 2, 3]
[2, 3, 4]
[3, 4, 5]
[4, 5, 6]
[5, 6, 7]
[6, 7, 8]
[7, 8, 9]
[8, 9, 10]
@overload each_cons(n)
@yield []
@return [nil]
@overload each_cons(n);T;%0;"@P;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"static VALUE
enum_each_cons(VALUE obj, VALUE n)
{
long size = NUM2LONG(n);
struct MEMO *memo;
int arity;
if (size <= 0) rb_raise(rb_eArgError, "invalid size");
RETURN_SIZED_ENUMERATOR(obj, 1, &n, enum_each_cons_size);
arity = rb_block_arity();
if (enum_size_over_p(obj, size)) return Qnil;
memo = MEMO_NEW(rb_ary_new2(size), dont_recycle_block_arg(arity), size);
rb_block_call(obj, id_each, 0, 0, each_cons_i, (VALUE)memo);
return Qnil;
};T;0To;
; F; ;
;;;I" Enumerable#each_with_object;F;[[I" memo;T0;[[@Gi$ ;T;:each_with_object;0;[ ;{ ;IC;"
Iterates the given block for each element with an arbitrary
object given, and returns the initially given object.
If no block is given, returns an enumerator.
evens = (1..10).each_with_object([]) { |i, a| a << i*2 }
#=> [2, 4, 6, 8, 10, 12, 14, 16, 18, 20]
;T;[o;
; I"
overload;F; 0;;; 0; I"each_with_object(obj);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" (*args);TI"
memo_obj;T;"@Po;!
; I" return;F; I" ;T;0; [I" Object;T;"@P;#[ ;$I"0@yield [(*args), memo_obj]
@return [Object];T;%0;"@P;&0;'F;(i ;[[I"obj;T0;"@Po;
; I"
overload;F; 0;;; 0; I"each_with_object(obj);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@P;&0;'F;(i ;[[I"obj;T0;"@P;#[ ;$I"}Iterates the given block for each element with an arbitrary
object given, and returns the initially given object.
If no block is given, returns an enumerator.
evens = (1..10).each_with_object([]) { |i, a| a << i*2 }
#=> [2, 4, 6, 8, 10, 12, 14, 16, 18, 20]
@overload each_with_object(obj)
@yield [(*args), memo_obj]
@return [Object]
@overload each_with_object(obj);T;%0;"@P;'F;)o;*;+T;,i ;-i# ;.@G; I"static VALUE;T;/I"static VALUE
enum_each_with_object(VALUE obj, VALUE memo)
{
RETURN_SIZED_ENUMERATOR(obj, 1, &memo, enum_size);
rb_block_call(obj, id_each, 0, 0, each_with_object_i, memo);
return memo;
};T;0To;
; F; ;
;;;I"Enumerable#zip;F;[[@0;[[@Gi ;T;:zip;0;[ ;{ ;IC;"lTakes one element from enum and merges corresponding
elements from each args. This generates a sequence of
n-element arrays, where n is one more than the
count of arguments. The length of the resulting sequence will be
enum#size. If the size of any argument is less than
enum#size, nil values are supplied. If
a block is given, it is invoked for each output array, otherwise
an array of arrays is returned.
a = [ 4, 5, 6 ]
b = [ 7, 8, 9 ]
a.zip(b) #=> [[4, 7], [5, 8], [6, 9]]
[1, 2, 3].zip(a, b) #=> [[1, 4, 7], [2, 5, 8], [3, 6, 9]]
[1, 2].zip(a, b) #=> [[1, 4, 7], [2, 5, 8]]
a.zip([1, 2], [8]) #=> [[4, 1, 8], [5, 2, nil], [6, nil, nil]]
c = []
a.zip(b) { |x, y| c << x + y } #=> nil
c #=> [11, 13, 15]
;T;[o;
; I"
overload;F; 0;;; 0; I"zip(arg, ...);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@Q;&0;'F;(i ;[[I"arg;T0[I"...;T0;"@Qo;
; I"
overload;F; 0;;; 0; I"zip(arg, ...);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"arr;T;"@Qo;!
; I" return;F; I" ;T;0; [I"nil;T;"@Q;#[ ;$I" @yield [arr]
@return [nil];T;%0;"@Q;&0;'F;(i ;[[I"arg;T0[I"...;T0;"@Q;#[ ;$I"Takes one element from enum and merges corresponding
elements from each args. This generates a sequence of
n-element arrays, where n is one more than the
count of arguments. The length of the resulting sequence will be
enum#size. If the size of any argument is less than
enum#size, nil values are supplied. If
a block is given, it is invoked for each output array, otherwise
an array of arrays is returned.
a = [ 4, 5, 6 ]
b = [ 7, 8, 9 ]
a.zip(b) #=> [[4, 7], [5, 8], [6, 9]]
[1, 2, 3].zip(a, b) #=> [[1, 4, 7], [2, 5, 8], [3, 6, 9]]
[1, 2].zip(a, b) #=> [[1, 4, 7], [2, 5, 8]]
a.zip([1, 2], [8]) #=> [[4, 1, 8], [5, 2, nil], [6, nil, nil]]
c = []
a.zip(b) { |x, y| c << x + y } #=> nil
c #=> [11, 13, 15]
@overload zip(arg, ...)
@overload zip(arg, ...)
@yield [arr]
@return [nil];T;%0;"@Q;'F;)o;*;+T;,i ;-i ;.@G; I"static VALUE;T;/I"static VALUE
enum_zip(int argc, VALUE *argv, VALUE obj)
{
int i;
ID conv;
struct MEMO *memo;
VALUE result = Qnil;
VALUE args = rb_ary_new4(argc, argv);
int allary = TRUE;
argv = RARRAY_PTR(args);
for (i=0; ienum.
a = [1, 2, 3, 4, 5, 0]
a.take(3) #=> [1, 2, 3]
a.take(30) #=> [1, 2, 3, 4, 5, 0]
;T;[o;
; I"
overload;F; 0;;; 0; I" take(n);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@LQ;#[ ;$I"@return [Array];T;%0;"@LQ;&0;'F;(i ;[[I"n;T0;"@LQ;#[ ;$I"Returns first n elements from enum.
a = [1, 2, 3, 4, 5, 0]
a.take(3) #=> [1, 2, 3]
a.take(30) #=> [1, 2, 3, 4, 5, 0]
@overload take(n)
@return [Array];T;%0;"@LQ;'F;)o;*;+T;,i ;-i ;.@G; I"static VALUE;T;/I"static VALUE
enum_take(VALUE obj, VALUE n)
{
struct MEMO *memo;
VALUE result;
long len = NUM2LONG(n);
if (len < 0) {
rb_raise(rb_eArgError, "attempt to take negative size");
}
if (len == 0) return rb_ary_new2(0);
result = rb_ary_new2(len);
memo = MEMO_NEW(result, 0, len);
rb_block_call(obj, id_each, 0, 0, take_i, (VALUE)memo);
return result;
};T;0To;
; F; ;
;;;I"Enumerable#take_while;F;[ ;[[@Gi
;T;:take_while;0;[ ;{ ;IC;"Passes elements to the block until the block returns +nil+ or +false+,
then stops iterating and returns an array of all prior elements.
If no block is given, an enumerator is returned instead.
a = [1, 2, 3, 4, 5, 0]
a.take_while { |i| i < 3 } #=> [1, 2]
;T;[o;
; I"
overload;F; 0;; ; 0; I"take_while;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"arr;T;"@kQo;!
; I" return;F; I" ;T;0; [I"
Array;T;"@kQ;#[ ;$I"!@yield [arr]
@return [Array];T;%0;"@kQ;&0;'F;(i ;[ ;"@kQo;
; I"
overload;F; 0;; ; 0; I"take_while;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@kQ;&0;'F;(i ;[ ;"@kQ;#[ ;$I"UPasses elements to the block until the block returns +nil+ or +false+,
then stops iterating and returns an array of all prior elements.
If no block is given, an enumerator is returned instead.
a = [1, 2, 3, 4, 5, 0]
a.take_while { |i| i < 3 } #=> [1, 2]
@overload take_while
@yield [arr]
@return [Array]
@overload take_while;T;%0;"@kQ;'F;)o;*;+T;,i ;-i
;.@G; I"static VALUE;T;/I"static VALUE
enum_take_while(VALUE obj)
{
VALUE ary;
RETURN_ENUMERATOR(obj, 0, 0);
ary = rb_ary_new();
rb_block_call(obj, id_each, 0, 0, take_while_i, ary);
return ary;
};T;0To;
; F; ;
;;;I"Enumerable#drop;F;[[I"n;T0;[[@Gi*
;T;: drop;0;[ ;{ ;IC;"Drops first n elements from enum, and returns rest elements
in an array.
a = [1, 2, 3, 4, 5, 0]
a.drop(3) #=> [4, 5, 0]
;T;[o;
; I"
overload;F; 0;; ; 0; I" drop(n);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@Q;#[ ;$I"@return [Array];T;%0;"@Q;&0;'F;(i ;[[I"n;T0;"@Q;#[ ;$I"Drops first n elements from enum, and returns rest elements
in an array.
a = [1, 2, 3, 4, 5, 0]
a.drop(3) #=> [4, 5, 0]
@overload drop(n)
@return [Array];T;%0;"@Q;'F;)o;*;+T;,i
;-i'
;.@G; I"static VALUE;T;/I"Wstatic VALUE
enum_drop(VALUE obj, VALUE n)
{
VALUE result;
struct MEMO *memo;
long len = NUM2LONG(n);
if (len < 0) {
rb_raise(rb_eArgError, "attempt to drop negative size");
}
result = rb_ary_new();
memo = MEMO_NEW(result, 0, len);
rb_block_call(obj, id_each, 0, 0, drop_i, (VALUE)memo);
return result;
};T;0To;
; F; ;
;;;I"Enumerable#drop_while;F;[ ;[[@Gi[
;T;:drop_while;0;[ ;{ ;IC;"%Drops elements up to, but not including, the first element for
which the block returns +nil+ or +false+ and returns an array
containing the remaining elements.
If no block is given, an enumerator is returned instead.
a = [1, 2, 3, 4, 5, 0]
a.drop_while { |i| i < 3 } #=> [3, 4, 5, 0]
;T;[o;
; I"
overload;F; 0;; ; 0; I"drop_while;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"arr;T;"@Qo;!
; I" return;F; I" ;T;0; [I"
Array;T;"@Q;#[ ;$I"!@yield [arr]
@return [Array];T;%0;"@Q;&0;'F;(i ;[ ;"@Qo;
; I"
overload;F; 0;; ; 0; I"drop_while;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@Q;&0;'F;(i ;[ ;"@Q;#[ ;$I"sDrops elements up to, but not including, the first element for
which the block returns +nil+ or +false+ and returns an array
containing the remaining elements.
If no block is given, an enumerator is returned instead.
a = [1, 2, 3, 4, 5, 0]
a.drop_while { |i| i < 3 } #=> [3, 4, 5, 0]
@overload drop_while
@yield [arr]
@return [Array]
@overload drop_while;T;%0;"@Q;'F;)o;*;+T;,iK
;-iY
;.@G; I"static VALUE;T;/I"static VALUE
enum_drop_while(VALUE obj)
{
VALUE result;
struct MEMO *memo;
RETURN_ENUMERATOR(obj, 0, 0);
result = rb_ary_new();
memo = MEMO_NEW(result, 0, FALSE);
rb_block_call(obj, id_each, 0, 0, drop_while_i, (VALUE)memo);
return result;
};T;0To;
; F; ;
;;;I"Enumerable#cycle;F;[[@0;[[@Gi
;T;:
cycle;0;[ ;{ ;IC;"@Calls block for each element of enum repeatedly _n_
times or forever if none or +nil+ is given. If a non-positive
number is given or the collection is empty, does nothing. Returns
+nil+ if the loop has finished without getting interrupted.
Enumerable#cycle saves elements in an internal array so changes
to enum after the first pass have no effect.
If no block is given, an enumerator is returned instead.
a = ["a", "b", "c"]
a.cycle { |x| puts x } # print, a, b, c, a, b, c,.. forever.
a.cycle(2) { |x| puts x } # print, a, b, c, a, b, c.
;T;[o;
; I"
overload;F; 0;; ; 0; I"cycle(n=nil);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@Qo;!
; I" return;F; I" ;T;0; [I"nil;T;"@Q;#[ ;$I" @yield [obj]
@return [nil];T;%0;"@Q;&0;'F;(i ;[[I"n;TI"nil;T;"@Qo;
; I"
overload;F; 0;; ; 0; I"cycle(n=nil);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@Q;&0;'F;(i ;[[I"n;TI"nil;T;"@Q;#[ ;$I"Calls block for each element of enum repeatedly _n_
times or forever if none or +nil+ is given. If a non-positive
number is given or the collection is empty, does nothing. Returns
+nil+ if the loop has finished without getting interrupted.
Enumerable#cycle saves elements in an internal array so changes
to enum after the first pass have no effect.
If no block is given, an enumerator is returned instead.
a = ["a", "b", "c"]
a.cycle { |x| puts x } # print, a, b, c, a, b, c,.. forever.
a.cycle(2) { |x| puts x } # print, a, b, c, a, b, c.
@overload cycle(n=nil)
@yield [obj]
@return [nil]
@overload cycle(n=nil);T;%0;"@Q;'F;)o;*;+T;,i
;-i
;.@G; I"static VALUE;T;/I"static VALUE
enum_cycle(int argc, VALUE *argv, VALUE obj)
{
VALUE ary;
VALUE nv = Qnil;
long n, i, len;
rb_scan_args(argc, argv, "01", &nv);
RETURN_SIZED_ENUMERATOR(obj, argc, argv, enum_cycle_size);
if (NIL_P(nv)) {
n = -1;
}
else {
n = NUM2LONG(nv);
if (n <= 0) return Qnil;
}
ary = rb_ary_new();
RBASIC_CLEAR_CLASS(ary);
rb_block_call(obj, id_each, 0, 0, cycle_i, ary);
len = RARRAY_LEN(ary);
if (len == 0) return Qnil;
while (n < 0 || 0 < --n) {
for (i=0; i [false, [3, 1]]
# [true, [4]]
# [false, [1, 5, 9]]
# [true, [2, 6]]
# [false, [5, 3, 5]]
This method is especially useful for sorted series of elements.
The following example counts words for each initial letter.
open("/usr/share/dict/words", "r:iso-8859-1") { |f|
f.chunk { |line| line.ord }.each { |ch, lines| p [ch.chr, lines.length] }
}
#=> ["\n", 1]
# ["A", 1327]
# ["B", 1372]
# ["C", 1507]
# ["D", 791]
# ...
The following key values have special meaning:
- +nil+ and +:_separator+ specifies that the elements should be dropped.
- +:_alone+ specifies that the element should be chunked by itself.
Any other symbols that begin with an underscore will raise an error:
items.chunk { |item| :_underscore }
#=> RuntimeError: symbols beginning with an underscore are reserved
+nil+ and +:_separator+ can be used to ignore some elements.
For example, the sequence of hyphens in svn log can be eliminated as follows:
sep = "-"*72 + "\n"
IO.popen("svn log README") { |f|
f.chunk { |line|
line != sep || nil
}.each { |_, lines|
pp lines
}
}
#=> ["r20018 | knu | 2008-10-29 13:20:42 +0900 (Wed, 29 Oct 2008) | 2 lines\n",
# "\n",
# "* README, README.ja: Update the portability section.\n",
# "\n"]
# ["r16725 | knu | 2008-05-31 23:34:23 +0900 (Sat, 31 May 2008) | 2 lines\n",
# "\n",
# "* README, README.ja: Add a note about default C flags.\n",
# "\n"]
# ...
Paragraphs separated by empty lines can be parsed as follows:
File.foreach("README").chunk { |line|
/\A\s*\z/ !~ line || nil
}.each { |_, lines|
pp lines
}
+:_alone+ can be used to force items into their own chunk.
For example, you can put lines that contain a URL by themselves,
and chunk the rest of the lines together, like this:
pattern = /http/
open(filename) { |f|
f.chunk { |line| line =~ pattern ? :_alone : true }.each { |key, lines|
pp lines
}
}
;T;[o;
; I"
overload;F; 0;; ; 0; I"
chunk;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"elt;T;"@ R;#[ ;$I"@yield [elt];T;%0;"@ R;&0;'F;(i ;[ ;"@ R;#[ ;$I"E Enumerates over the items, chunking them together based on the return
value of the block.
Consecutive elements which return the same block value are chunked together.
For example, consecutive even numbers and odd numbers can be
chunked as follows.
[3, 1, 4, 1, 5, 9, 2, 6, 5, 3, 5].chunk { |n|
n.even?
}.each { |even, ary|
p [even, ary]
}
#=> [false, [3, 1]]
# [true, [4]]
# [false, [1, 5, 9]]
# [true, [2, 6]]
# [false, [5, 3, 5]]
This method is especially useful for sorted series of elements.
The following example counts words for each initial letter.
open("/usr/share/dict/words", "r:iso-8859-1") { |f|
f.chunk { |line| line.ord }.each { |ch, lines| p [ch.chr, lines.length] }
}
#=> ["\n", 1]
# ["A", 1327]
# ["B", 1372]
# ["C", 1507]
# ["D", 791]
# ...
The following key values have special meaning:
- +nil+ and +:_separator+ specifies that the elements should be dropped.
- +:_alone+ specifies that the element should be chunked by itself.
Any other symbols that begin with an underscore will raise an error:
items.chunk { |item| :_underscore }
#=> RuntimeError: symbols beginning with an underscore are reserved
+nil+ and +:_separator+ can be used to ignore some elements.
For example, the sequence of hyphens in svn log can be eliminated as follows:
sep = "-"*72 + "\n"
IO.popen("svn log README") { |f|
f.chunk { |line|
line != sep || nil
}.each { |_, lines|
pp lines
}
}
#=> ["r20018 | knu | 2008-10-29 13:20:42 +0900 (Wed, 29 Oct 2008) | 2 lines\n",
# "\n",
# "* README, README.ja: Update the portability section.\n",
# "\n"]
# ["r16725 | knu | 2008-05-31 23:34:23 +0900 (Sat, 31 May 2008) | 2 lines\n",
# "\n",
# "* README, README.ja: Add a note about default C flags.\n",
# "\n"]
# ...
Paragraphs separated by empty lines can be parsed as follows:
File.foreach("README").chunk { |line|
/\A\s*\z/ !~ line || nil
}.each { |_, lines|
pp lines
}
+:_alone+ can be used to force items into their own chunk.
For example, you can put lines that contain a URL by themselves,
and chunk the rest of the lines together, like this:
pattern = /http/
open(filename) { |f|
f.chunk { |line| line =~ pattern ? :_alone : true }.each { |key, lines|
pp lines
}
}
@overload chunk
@yield [elt];T;%0;"@ R;'F;)o;*;+T;,i ;-iV ;.@G; I"static VALUE;T;/I"static VALUE
enum_chunk(VALUE enumerable)
{
VALUE enumerator;
if (!rb_block_given_p())
rb_raise(rb_eArgError, "no block given");
enumerator = rb_obj_alloc(rb_cEnumerator);
rb_ivar_set(enumerator, rb_intern("chunk_enumerable"), enumerable);
rb_ivar_set(enumerator, rb_intern("chunk_categorize"), rb_block_proc());
rb_block_call(enumerator, idInitialize, 0, 0, chunk_i, enumerator);
return enumerator;
};T;0To;
; F; ;
;;;I" Enumerable#slice_before;F;[[@0;[[@Gi- ;T;:slice_before;0;[ ;{ ;IC;"XCreates an enumerator for each chunked elements.
The beginnings of chunks are defined by _pattern_ and the block.
If _pattern_ === _elt_ returns true or the block
returns true for the element, the element is beginning of a
chunk.
The === and _block_ is called from the first element to the last
element of _enum_. The result for the first element is ignored.
The result enumerator yields the chunked elements as an array.
So +each+ method can be called as follows:
enum.slice_before(pattern).each { |ary| ... }
enum.slice_before { |elt| bool }.each { |ary| ... }
Other methods of the Enumerator class and Enumerable module,
such as map, etc., are also usable.
For example, iteration over ChangeLog entries can be implemented as
follows:
# iterate over ChangeLog entries.
open("ChangeLog") { |f|
f.slice_before(/\A\S/).each { |e| pp e }
}
# same as above. block is used instead of pattern argument.
open("ChangeLog") { |f|
f.slice_before { |line| /\A\S/ === line }.each { |e| pp e }
}
"svn proplist -R" produces multiline output for each file.
They can be chunked as follows:
IO.popen([{"LC_ALL"=>"C"}, "svn", "proplist", "-R"]) { |f|
f.lines.slice_before(/\AProp/).each { |lines| p lines }
}
#=> ["Properties on '.':\n", " svn:ignore\n", " svk:merge\n"]
# ["Properties on 'goruby.c':\n", " svn:eol-style\n"]
# ["Properties on 'complex.c':\n", " svn:mime-type\n", " svn:eol-style\n"]
# ["Properties on 'regparse.c':\n", " svn:eol-style\n"]
# ...
If the block needs to maintain state over multiple elements,
local variables can be used.
For example, three or more consecutive increasing numbers can be squashed
as follows:
a = [0, 2, 3, 4, 6, 7, 9]
prev = a[0]
p a.slice_before { |e|
prev, prev2 = e, prev
prev2 + 1 != e
}.map { |es|
es.length <= 2 ? es.join(",") : "#{es.first}-#{es.last}"
}.join(",")
#=> "0,2-4,6,7,9"
However local variables should be used carefully
if the result enumerator is enumerated twice or more.
The local variables should be initialized for each enumeration.
Enumerator.new can be used to do it.
# Word wrapping. This assumes all characters have same width.
def wordwrap(words, maxwidth)
Enumerator.new {|y|
# cols is initialized in Enumerator.new.
cols = 0
words.slice_before { |w|
cols += 1 if cols != 0
cols += w.length
if maxwidth < cols
cols = w.length
true
else
false
end
}.each {|ws| y.yield ws }
}
end
text = (1..20).to_a.join(" ")
enum = wordwrap(text.split(/\s+/), 10)
puts "-"*10
enum.each { |ws| puts ws.join(" ") } # first enumeration.
puts "-"*10
enum.each { |ws| puts ws.join(" ") } # second enumeration generates same result as the first.
puts "-"*10
#=> ----------
# 1 2 3 4 5
# 6 7 8 9 10
# 11 12 13
# 14 15 16
# 17 18 19
# 20
# ----------
# 1 2 3 4 5
# 6 7 8 9 10
# 11 12 13
# 14 15 16
# 17 18 19
# 20
# ----------
mbox contains series of mails which start with Unix From line.
So each mail can be extracted by slice before Unix From line.
# parse mbox
open("mbox") { |f|
f.slice_before { |line|
line.start_with? "From "
}.each { |mail|
unix_from = mail.shift
i = mail.index("\n")
header = mail[0...i]
body = mail[(i+1)..-1]
body.pop if body.last == "\n"
fields = header.slice_before { |line| !" \t".include?(line[0]) }.to_a
p unix_from
pp fields
pp body
}
}
# split mails in mbox (slice before Unix From line after an empty line)
open("mbox") { |f|
f.slice_before(emp: true) { |line, h|
prevemp = h[:emp]
h[:emp] = line == "\n"
prevemp && line.start_with?("From ")
}.each { |mail|
mail.pop if mail.last == "\n"
pp mail
}
}
;T;[o;
; I"
overload;F; 0;;!; 0; I"slice_before(pattern);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@$R;&0;'F;(i ;[[I" pattern;T0;"@$Ro;
; I"
overload;F; 0;;!; 0; I"slice_before;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"elt;T;"@$R;#[ ;$I"@yield [elt];T;%0;"@$R;&0;'F;(i ;[ ;"@$R;#[ ;$I"Creates an enumerator for each chunked elements.
The beginnings of chunks are defined by _pattern_ and the block.
If _pattern_ === _elt_ returns true or the block
returns true for the element, the element is beginning of a
chunk.
The === and _block_ is called from the first element to the last
element of _enum_. The result for the first element is ignored.
The result enumerator yields the chunked elements as an array.
So +each+ method can be called as follows:
enum.slice_before(pattern).each { |ary| ... }
enum.slice_before { |elt| bool }.each { |ary| ... }
Other methods of the Enumerator class and Enumerable module,
such as map, etc., are also usable.
For example, iteration over ChangeLog entries can be implemented as
follows:
# iterate over ChangeLog entries.
open("ChangeLog") { |f|
f.slice_before(/\A\S/).each { |e| pp e }
}
# same as above. block is used instead of pattern argument.
open("ChangeLog") { |f|
f.slice_before { |line| /\A\S/ === line }.each { |e| pp e }
}
"svn proplist -R" produces multiline output for each file.
They can be chunked as follows:
IO.popen([{"LC_ALL"=>"C"}, "svn", "proplist", "-R"]) { |f|
f.lines.slice_before(/\AProp/).each { |lines| p lines }
}
#=> ["Properties on '.':\n", " svn:ignore\n", " svk:merge\n"]
# ["Properties on 'goruby.c':\n", " svn:eol-style\n"]
# ["Properties on 'complex.c':\n", " svn:mime-type\n", " svn:eol-style\n"]
# ["Properties on 'regparse.c':\n", " svn:eol-style\n"]
# ...
If the block needs to maintain state over multiple elements,
local variables can be used.
For example, three or more consecutive increasing numbers can be squashed
as follows:
a = [0, 2, 3, 4, 6, 7, 9]
prev = a[0]
p a.slice_before { |e|
prev, prev2 = e, prev
prev2 + 1 != e
}.map { |es|
es.length <= 2 ? es.join(",") : "#{es.first}-#{es.last}"
}.join(",")
#=> "0,2-4,6,7,9"
However local variables should be used carefully
if the result enumerator is enumerated twice or more.
The local variables should be initialized for each enumeration.
Enumerator.new can be used to do it.
# Word wrapping. This assumes all characters have same width.
def wordwrap(words, maxwidth)
Enumerator.new {|y|
# cols is initialized in Enumerator.new.
cols = 0
words.slice_before { |w|
cols += 1 if cols != 0
cols += w.length
if maxwidth < cols
cols = w.length
true
else
false
end
}.each {|ws| y.yield ws }
}
end
text = (1..20).to_a.join(" ")
enum = wordwrap(text.split(/\s+/), 10)
puts "-"*10
enum.each { |ws| puts ws.join(" ") } # first enumeration.
puts "-"*10
enum.each { |ws| puts ws.join(" ") } # second enumeration generates same result as the first.
puts "-"*10
#=> ----------
# 1 2 3 4 5
# 6 7 8 9 10
# 11 12 13
# 14 15 16
# 17 18 19
# 20
# ----------
# 1 2 3 4 5
# 6 7 8 9 10
# 11 12 13
# 14 15 16
# 17 18 19
# 20
# ----------
mbox contains series of mails which start with Unix From line.
So each mail can be extracted by slice before Unix From line.
# parse mbox
open("mbox") { |f|
f.slice_before { |line|
line.start_with? "From "
}.each { |mail|
unix_from = mail.shift
i = mail.index("\n")
header = mail[0...i]
body = mail[(i+1)..-1]
body.pop if body.last == "\n"
fields = header.slice_before { |line| !" \t".include?(line[0]) }.to_a
p unix_from
pp fields
pp body
}
}
# split mails in mbox (slice before Unix From line after an empty line)
open("mbox") { |f|
f.slice_before(emp: true) { |line, h|
prevemp = h[:emp]
h[:emp] = line == "\n"
prevemp && line.start_with?("From ")
}.each { |mail|
mail.pop if mail.last == "\n"
pp mail
}
}
@overload slice_before(pattern)
@overload slice_before
@yield [elt];T;%0;"@$R;'F;)o;*;+T;,i ;-i+ ;.@G; I"static VALUE;T;/I"static VALUE
enum_slice_before(int argc, VALUE *argv, VALUE enumerable)
{
VALUE enumerator;
if (rb_block_given_p()) {
if (argc != 0)
rb_error_arity(argc, 0, 0);
enumerator = rb_obj_alloc(rb_cEnumerator);
rb_ivar_set(enumerator, rb_intern("slicebefore_sep_pred"), rb_block_proc());
}
else {
VALUE sep_pat;
rb_scan_args(argc, argv, "1", &sep_pat);
enumerator = rb_obj_alloc(rb_cEnumerator);
rb_ivar_set(enumerator, rb_intern("slicebefore_sep_pat"), sep_pat);
}
rb_ivar_set(enumerator, rb_intern("slicebefore_enumerable"), enumerable);
rb_block_call(enumerator, idInitialize, 0, 0, slicebefore_i, enumerator);
return enumerator;
};T;0To;
; F; ;
;;;I"Enumerable#slice_after;F;[[@0;[[@Gi ;T;:slice_after;0;[ ;{ ;IC;"
Creates an enumerator for each chunked elements.
The ends of chunks are defined by _pattern_ and the block.
If _pattern_ === _elt_ returns true or the block
returns true for the element, the element is end of a
chunk.
The === and _block_ is called from the first element to the last
element of _enum_.
The result enumerator yields the chunked elements as an array.
So +each+ method can be called as follows:
enum.slice_after(pattern).each { |ary| ... }
enum.slice_after { |elt| bool }.each { |ary| ... }
Other methods of the Enumerator class and Enumerable module,
such as +map+, etc., are also usable.
For example, continuation lines (lines end with backslash) can be
concatenated as follows:
lines = ["foo\n", "bar\\\n", "baz\n", "\n", "qux\n"]
e = lines.slice_after(/(? [["foo\n"], ["bar\\\n", "baz\n"], ["\n"], ["qux\n"]]
p e.map {|ll| ll[0...-1].map {|l| l.sub(/\\\n\z/, "") }.join + ll.last }
#=>["foo\n", "barbaz\n", "\n", "qux\n"]
;T;[o;
; I"
overload;F; 0;;"; 0; I"slice_after(pattern);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@JR;&0;'F;(i ;[[I" pattern;T0;"@JRo;
; I"
overload;F; 0;;"; 0; I"slice_after;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"elt;T;"@JR;#[ ;$I"@yield [elt];T;%0;"@JR;&0;'F;(i ;[ ;"@JR;#[ ;$I"TCreates an enumerator for each chunked elements.
The ends of chunks are defined by _pattern_ and the block.
If _pattern_ === _elt_ returns true or the block
returns true for the element, the element is end of a
chunk.
The === and _block_ is called from the first element to the last
element of _enum_.
The result enumerator yields the chunked elements as an array.
So +each+ method can be called as follows:
enum.slice_after(pattern).each { |ary| ... }
enum.slice_after { |elt| bool }.each { |ary| ... }
Other methods of the Enumerator class and Enumerable module,
such as +map+, etc., are also usable.
For example, continuation lines (lines end with backslash) can be
concatenated as follows:
lines = ["foo\n", "bar\\\n", "baz\n", "\n", "qux\n"]
e = lines.slice_after(/(? [["foo\n"], ["bar\\\n", "baz\n"], ["\n"], ["qux\n"]]
p e.map {|ll| ll[0...-1].map {|l| l.sub(/\\\n\z/, "") }.join + ll.last }
#=>["foo\n", "barbaz\n", "\n", "qux\n"]
@overload slice_after(pattern)
@overload slice_after
@yield [elt];T;%0;"@JR;'F;)o;*;+T;,i ;-i ;.@G; I"static VALUE;T;/I"static VALUE
enum_slice_after(int argc, VALUE *argv, VALUE enumerable)
{
VALUE enumerator;
VALUE pat = Qnil, pred = Qnil;
if (rb_block_given_p()) {
if (0 < argc)
rb_raise(rb_eArgError, "both pattern and block are given");
pred = rb_block_proc();
}
else {
rb_scan_args(argc, argv, "1", &pat);
}
enumerator = rb_obj_alloc(rb_cEnumerator);
rb_ivar_set(enumerator, rb_intern("sliceafter_enum"), enumerable);
rb_ivar_set(enumerator, rb_intern("sliceafter_pat"), pat);
rb_ivar_set(enumerator, rb_intern("sliceafter_pred"), pred);
rb_block_call(enumerator, idInitialize, 0, 0, sliceafter_i, enumerator);
return enumerator;
};T;0To;
; F; ;
;;;I"Enumerable#slice_when;F;[ ;[[@Gi>
;T;:slice_when;0;[ ;{ ;IC;"Creates an enumerator for each chunked elements.
The beginnings of chunks are defined by the block.
This method split each chunk using adjacent elements,
_elt_before_ and _elt_after_,
in the receiver enumerator.
This method split chunks between _elt_before_ and _elt_after_ where
the block returns true.
The block is called the length of the receiver enumerator minus one.
The result enumerator yields the chunked elements as an array.
So +each+ method can be called as follows:
enum.slice_when { |elt_before, elt_after| bool }.each { |ary| ... }
Other methods of the Enumerator class and Enumerable module,
such as +to_a+, +map+, etc., are also usable.
For example, one-by-one increasing subsequence can be chunked as follows:
a = [1,2,4,9,10,11,12,15,16,19,20,21]
b = a.slice_when {|i, j| i+1 != j }
p b.to_a #=> [[1, 2], [4], [9, 10, 11, 12], [15, 16], [19, 20, 21]]
c = b.map {|a| a.length < 3 ? a : "#{a.first}-#{a.last}" }
p c #=> [[1, 2], [4], "9-12", [15, 16], "19-21"]
d = c.join(",")
p d #=> "1,2,4,9-12,15,16,19-21"
Near elements (threshold: 6) in sorted array can be chunked as follows:
a = [3, 11, 14, 25, 28, 29, 29, 41, 55, 57]
p a.slice_when {|i, j| 6 < j - i }.to_a
#=> [[3], [11, 14], [25, 28, 29, 29], [41], [55, 57]]
Increasing (non-decreasing) subsequence can be chunked as follows:
a = [0, 9, 2, 2, 3, 2, 7, 5, 9, 5]
p a.slice_when {|i, j| i > j }.to_a
#=> [[0, 9], [2, 2, 3], [2, 7], [5, 9], [5]]
Adjacent evens and odds can be chunked as follows:
(Enumerable#chunk is another way to do it.)
a = [7, 5, 9, 2, 0, 7, 9, 4, 2, 0]
p a.slice_when {|i, j| i.even? != j.even? }.to_a
#=> [[7, 5, 9], [2, 0], [7, 9], [4, 2, 0]]
Paragraphs (non-empty lines with trailing empty lines) can be chunked as follows:
(See Enumerable#chunk to ignore empty lines.)
lines = ["foo\n", "bar\n", "\n", "baz\n", "qux\n"]
p lines.slice_when {|l1, l2| /\A\s*\z/ =~ l1 && /\S/ =~ l2 }.to_a
#=> [["foo\n", "bar\n", "\n"], ["baz\n", "qux\n"]]
;T;[o;
; I"
overload;F; 0;;#; 0; I"slice_when;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"elt_before;TI"elt_after;T;"@pR;#[ ;$I"#@yield [elt_before, elt_after];T;%0;"@pR;&0;'F;(i ;[ ;"@pR;#[ ;$I"Creates an enumerator for each chunked elements.
The beginnings of chunks are defined by the block.
This method split each chunk using adjacent elements,
_elt_before_ and _elt_after_,
in the receiver enumerator.
This method split chunks between _elt_before_ and _elt_after_ where
the block returns true.
The block is called the length of the receiver enumerator minus one.
The result enumerator yields the chunked elements as an array.
So +each+ method can be called as follows:
enum.slice_when { |elt_before, elt_after| bool }.each { |ary| ... }
Other methods of the Enumerator class and Enumerable module,
such as +to_a+, +map+, etc., are also usable.
For example, one-by-one increasing subsequence can be chunked as follows:
a = [1,2,4,9,10,11,12,15,16,19,20,21]
b = a.slice_when {|i, j| i+1 != j }
p b.to_a #=> [[1, 2], [4], [9, 10, 11, 12], [15, 16], [19, 20, 21]]
c = b.map {|a| a.length < 3 ? a : "#{a.first}-#{a.last}" }
p c #=> [[1, 2], [4], "9-12", [15, 16], "19-21"]
d = c.join(",")
p d #=> "1,2,4,9-12,15,16,19-21"
Near elements (threshold: 6) in sorted array can be chunked as follows:
a = [3, 11, 14, 25, 28, 29, 29, 41, 55, 57]
p a.slice_when {|i, j| 6 < j - i }.to_a
#=> [[3], [11, 14], [25, 28, 29, 29], [41], [55, 57]]
Increasing (non-decreasing) subsequence can be chunked as follows:
a = [0, 9, 2, 2, 3, 2, 7, 5, 9, 5]
p a.slice_when {|i, j| i > j }.to_a
#=> [[0, 9], [2, 2, 3], [2, 7], [5, 9], [5]]
Adjacent evens and odds can be chunked as follows:
(Enumerable#chunk is another way to do it.)
a = [7, 5, 9, 2, 0, 7, 9, 4, 2, 0]
p a.slice_when {|i, j| i.even? != j.even? }.to_a
#=> [[7, 5, 9], [2, 0], [7, 9], [4, 2, 0]]
Paragraphs (non-empty lines with trailing empty lines) can be chunked as follows:
(See Enumerable#chunk to ignore empty lines.)
lines = ["foo\n", "bar\n", "\n", "baz\n", "qux\n"]
p lines.slice_when {|l1, l2| /\A\s*\z/ =~ l1 && /\S/ =~ l2 }.to_a
#=> [["foo\n", "bar\n", "\n"], ["baz\n", "qux\n"]]
@overload slice_when
@yield [elt_before, elt_after];T;%0;"@pR;'F;)o;*;+T;,i
;-i<
;.@G; I"static VALUE;T;/I"static VALUE
enum_slice_when(VALUE enumerable)
{
VALUE enumerator;
VALUE pred;
pred = rb_block_proc();
enumerator = rb_obj_alloc(rb_cEnumerator);
rb_ivar_set(enumerator, rb_intern("slicewhen_enum"), enumerable);
rb_ivar_set(enumerator, rb_intern("slicewhen_pred"), pred);
rb_ivar_set(enumerator, rb_intern("slicewhen_inverted"), Qfalse);
rb_block_call(enumerator, idInitialize, 0, 0, slicewhen_i, enumerator);
return enumerator;
};T;0To;
; F; ;
;;;I"Enumerable#chunk_while;F;[ ;[[@Gi~
;T;:chunk_while;0;[ ;{ ;IC;"Creates an enumerator for each chunked elements.
The beginnings of chunks are defined by the block.
This method split each chunk using adjacent elements,
_elt_before_ and _elt_after_,
in the receiver enumerator.
This method split chunks between _elt_before_ and _elt_after_ where
the block returns false.
The block is called the length of the receiver enumerator minus one.
The result enumerator yields the chunked elements as an array.
So +each+ method can be called as follows:
enum.chunk_while { |elt_before, elt_after| bool }.each { |ary| ... }
Other methods of the Enumerator class and Enumerable module,
such as +to_a+, +map+, etc., are also usable.
For example, one-by-one increasing subsequence can be chunked as follows:
a = [1,2,4,9,10,11,12,15,16,19,20,21]
b = a.chunk_while {|i, j| i+1 == j }
p b.to_a #=> [[1, 2], [4], [9, 10, 11, 12], [15, 16], [19, 20, 21]]
c = b.map {|a| a.length < 3 ? a : "#{a.first}-#{a.last}" }
p c #=> [[1, 2], [4], "9-12", [15, 16], "19-21"]
d = c.join(",")
p d #=> "1,2,4,9-12,15,16,19-21"
Increasing (non-decreasing) subsequence can be chunked as follows:
a = [0, 9, 2, 2, 3, 2, 7, 5, 9, 5]
p a.chunk_while {|i, j| i <= j }.to_a
#=> [[0, 9], [2, 2, 3], [2, 7], [5, 9], [5]]
Adjacent evens and odds can be chunked as follows:
(Enumerable#chunk is another way to do it.)
a = [7, 5, 9, 2, 0, 7, 9, 4, 2, 0]
p a.chunk_while {|i, j| i.even? == j.even? }.to_a
#=> [[7, 5, 9], [2, 0], [7, 9], [4, 2, 0]]
;T;[o;
; I"
overload;F; 0;;$; 0; I"chunk_while;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"elt_before;TI"elt_after;T;"@R;#[ ;$I"#@yield [elt_before, elt_after];T;%0;"@R;&0;'F;(i ;[ ;"@R;#[ ;$I"Creates an enumerator for each chunked elements.
The beginnings of chunks are defined by the block.
This method split each chunk using adjacent elements,
_elt_before_ and _elt_after_,
in the receiver enumerator.
This method split chunks between _elt_before_ and _elt_after_ where
the block returns false.
The block is called the length of the receiver enumerator minus one.
The result enumerator yields the chunked elements as an array.
So +each+ method can be called as follows:
enum.chunk_while { |elt_before, elt_after| bool }.each { |ary| ... }
Other methods of the Enumerator class and Enumerable module,
such as +to_a+, +map+, etc., are also usable.
For example, one-by-one increasing subsequence can be chunked as follows:
a = [1,2,4,9,10,11,12,15,16,19,20,21]
b = a.chunk_while {|i, j| i+1 == j }
p b.to_a #=> [[1, 2], [4], [9, 10, 11, 12], [15, 16], [19, 20, 21]]
c = b.map {|a| a.length < 3 ? a : "#{a.first}-#{a.last}" }
p c #=> [[1, 2], [4], "9-12", [15, 16], "19-21"]
d = c.join(",")
p d #=> "1,2,4,9-12,15,16,19-21"
Increasing (non-decreasing) subsequence can be chunked as follows:
a = [0, 9, 2, 2, 3, 2, 7, 5, 9, 5]
p a.chunk_while {|i, j| i <= j }.to_a
#=> [[0, 9], [2, 2, 3], [2, 7], [5, 9], [5]]
Adjacent evens and odds can be chunked as follows:
(Enumerable#chunk is another way to do it.)
a = [7, 5, 9, 2, 0, 7, 9, 4, 2, 0]
p a.chunk_while {|i, j| i.even? == j.even? }.to_a
#=> [[7, 5, 9], [2, 0], [7, 9], [4, 2, 0]]
@overload chunk_while
@yield [elt_before, elt_after];T;%0;"@R;'F;)o;*;+T;,iO
;-i|
;.@G; I"static VALUE;T;/I"static VALUE
enum_chunk_while(VALUE enumerable)
{
VALUE enumerator;
VALUE pred;
pred = rb_block_proc();
enumerator = rb_obj_alloc(rb_cEnumerator);
rb_ivar_set(enumerator, rb_intern("slicewhen_enum"), enumerable);
rb_ivar_set(enumerator, rb_intern("slicewhen_pred"), pred);
rb_ivar_set(enumerator, rb_intern("slicewhen_inverted"), Qtrue);
rb_block_call(enumerator, idInitialize, 0, 0, slicewhen_i, enumerator);
return enumerator;
};T;0To;
; F; ;
;;;I"Enumerable#lazy;F;[ ;[[@ i;T;: lazy;0;[ ;{ ;IC;"FReturns a lazy enumerator, whose methods map/collect,
flat_map/collect_concat, select/find_all, reject, grep, grep_v, zip, take,
take_while, drop, and drop_while enumerate values only on an
as-needed basis. However, if a block is given to zip, values
are enumerated immediately.
=== Example
The following program finds pythagorean triples:
def pythagorean_triples
(1..Float::INFINITY).lazy.flat_map {|z|
(1..z).flat_map {|x|
(x..z).select {|y|
x**2 + y**2 == z**2
}.map {|y|
[x, y, z]
}
}
}
end
# show first ten pythagorean triples
p pythagorean_triples.take(10).force # take is lazy, so force is needed
p pythagorean_triples.first(10) # first is eager
# show pythagorean triples less than 100
p pythagorean_triples.take_while { |*, z| z < 100 }.force
;T;[o;
; I"
overload;F; 0;;%; 0; I" lazy;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@R;&0;'F;(i ;[ ;"@R;#[ ;$I"WReturns a lazy enumerator, whose methods map/collect,
flat_map/collect_concat, select/find_all, reject, grep, grep_v, zip, take,
take_while, drop, and drop_while enumerate values only on an
as-needed basis. However, if a block is given to zip, values
are enumerated immediately.
=== Example
The following program finds pythagorean triples:
def pythagorean_triples
(1..Float::INFINITY).lazy.flat_map {|z|
(1..z).flat_map {|x|
(x..z).select {|y|
x**2 + y**2 == z**2
}.map {|y|
[x, y, z]
}
}
}
end
# show first ten pythagorean triples
p pythagorean_triples.take(10).force # take is lazy, so force is needed
p pythagorean_triples.first(10) # first is eager
# show pythagorean triples less than 100
p pythagorean_triples.take_while { |*, z| z < 100 }.force
@overload lazy;T;%0;"@R;'F;)o;*;+T;,i;-i;.@G; I"static VALUE;T;/I"static VALUE
enumerable_lazy(VALUE obj)
{
VALUE result = lazy_to_enum_i(obj, sym_each, 0, 0, lazyenum_size);
/* Qfalse indicates that the Enumerator::Lazy has no method name */
rb_ivar_set(result, id_method, Qfalse);
return result;
};T;0T;N@G;OIC;[ ;N@G;PIC;[ ;N@G;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@Gi
;F;;;;X;;;[ ;{ ;IC;"The Enumerable mixin provides collection classes with
several traversal and searching methods, and with the ability to
sort. The class must provide a method each, which
yields successive members of the collection. If
Enumerable#max, #min, or
#sort is used, the objects in the collection must also
implement a meaningful <=> operator, as these methods
rely on an ordering between members of the collection.;T;[ ;#[ ;$I"The Enumerable mixin provides collection classes with
several traversal and searching methods, and with the ability to
sort. The class must provide a method each, which
yields successive members of the collection. If
Enumerable#max, #min, or
#sort is used, the objects in the collection must also
implement a meaningful <=> operator, as these methods
rely on an ordering between members of the collection.
;T;%0;"@G;'F;(i ;)o;*;+T;,i
;-i
;.@;I"Enumerable;F;0;N@>;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{@8?;J;V[ ;[[@ >i;F;;;;X;;;[ ;{ ;IC;"K A Hash is a dictionary-like collection of unique keys and their values.
Also called associative arrays, they are similar to Arrays, but where an
Array uses integers as its index, a Hash allows you to use any object
type.
Hashes enumerate their values in the order that the corresponding keys
were inserted.
A Hash can be easily created by using its implicit form:
grades = { "Jane Doe" => 10, "Jim Doe" => 6 }
Hashes allow an alternate syntax for keys that are symbols.
Instead of
options = { :font_size => 10, :font_family => "Arial" }
You could write it as:
options = { font_size: 10, font_family: "Arial" }
Each named key is a symbol you can access in hash:
options[:font_size] # => 10
A Hash can also be created through its ::new method:
grades = Hash.new
grades["Dorothy Doe"] = 9
Hashes have a default value that is returned when accessing
keys that do not exist in the hash. If no default is set +nil+ is used.
You can set the default value by sending it as an argument to Hash.new:
grades = Hash.new(0)
Or by using the #default= method:
grades = {"Timmy Doe" => 8}
grades.default = 0
Accessing a value in a Hash requires using its key:
puts grades["Jane Doe"] # => 0
=== Common Uses
Hashes are an easy way to represent data structures, such as
books = {}
books[:matz] = "The Ruby Language"
books[:black] = "The Well-Grounded Rubyist"
Hashes are also commonly used as a way to have named parameters in
functions. Note that no brackets are used below. If a hash is the last
argument on a method call, no braces are needed, thus creating a really
clean interface:
Person.create(name: "John Doe", age: 27)
def self.create(params)
@name = params[:name]
@age = params[:age]
end
=== Hash Keys
Two objects refer to the same hash key when their hash value
is identical and the two objects are eql? to each other.
A user-defined class may be used as a hash key if the hash
and eql? methods are overridden to provide meaningful
behavior. By default, separate instances refer to separate hash keys.
A typical implementation of hash is based on the
object's data while eql? is usually aliased to the overridden
== method:
class Book
attr_reader :author, :title
def initialize(author, title)
@author = author
@title = title
end
def ==(other)
self.class === other and
other.author == @author and
other.title == @title
end
alias eql? ==
def hash
@author.hash ^ @title.hash # XOR
end
end
book1 = Book.new 'matz', 'Ruby in a Nutshell'
book2 = Book.new 'matz', 'Ruby in a Nutshell'
reviews = {}
reviews[book1] = 'Great reference!'
reviews[book2] = 'Nice and compact!'
reviews.length #=> 1
See also Object#hash and Object#eql?
;T;[ ;#[ ;$I"L A Hash is a dictionary-like collection of unique keys and their values.
Also called associative arrays, they are similar to Arrays, but where an
Array uses integers as its index, a Hash allows you to use any object
type.
Hashes enumerate their values in the order that the corresponding keys
were inserted.
A Hash can be easily created by using its implicit form:
grades = { "Jane Doe" => 10, "Jim Doe" => 6 }
Hashes allow an alternate syntax for keys that are symbols.
Instead of
options = { :font_size => 10, :font_family => "Arial" }
You could write it as:
options = { font_size: 10, font_family: "Arial" }
Each named key is a symbol you can access in hash:
options[:font_size] # => 10
A Hash can also be created through its ::new method:
grades = Hash.new
grades["Dorothy Doe"] = 9
Hashes have a default value that is returned when accessing
keys that do not exist in the hash. If no default is set +nil+ is used.
You can set the default value by sending it as an argument to Hash.new:
grades = Hash.new(0)
Or by using the #default= method:
grades = {"Timmy Doe" => 8}
grades.default = 0
Accessing a value in a Hash requires using its key:
puts grades["Jane Doe"] # => 0
=== Common Uses
Hashes are an easy way to represent data structures, such as
books = {}
books[:matz] = "The Ruby Language"
books[:black] = "The Well-Grounded Rubyist"
Hashes are also commonly used as a way to have named parameters in
functions. Note that no brackets are used below. If a hash is the last
argument on a method call, no braces are needed, thus creating a really
clean interface:
Person.create(name: "John Doe", age: 27)
def self.create(params)
@name = params[:name]
@age = params[:age]
end
=== Hash Keys
Two objects refer to the same hash key when their hash value
is identical and the two objects are eql? to each other.
A user-defined class may be used as a hash key if the hash
and eql? methods are overridden to provide meaningful
behavior. By default, separate instances refer to separate hash keys.
A typical implementation of hash is based on the
object's data while eql? is usually aliased to the overridden
== method:
class Book
attr_reader :author, :title
def initialize(author, title)
@author = author
@title = title
end
def ==(other)
self.class === other and
other.author == @author and
other.title == @title
end
alias eql? ==
def hash
@author.hash ^ @title.hash # XOR
end
end
book1 = Book.new 'matz', 'Ruby in a Nutshell'
book2 = Book.new 'matz', 'Ruby in a Nutshell'
reviews = {}
reviews[book1] = 'Great reference!'
reviews[book2] = 'Nice and compact!'
reviews.length #=> 1
See also Object#hash and Object#eql?
;T;%0;"@>;'F;)o;*;+T;,i;-i~;.@;I" Hash;F;Y@No;;[[@ >i;F;:ENV;;;;;[ ;{ ;IC;"bENV is a Hash-like accessor for environment variables.
See ENV (the class) for more details.
;T;[ ;#[ ;$I"cENV is a Hash-like accessor for environment variables.
See ENV (the class) for more details.
;T;%0;"@R;'F;)o;*;+T;,i;-i;.@;I"ENV;F;I" envtbl;To; ;IC;[ o;
; F; ;S;;;I"Struct.new;F;[[@0;[[I"
struct.c;Ti;T;;S;0;[ ;{ ;IC;"The first two forms are used to create a new Struct subclass +class_name+
that can contain a value for each +member_name+. This subclass can be
used to create instances of the structure like any other Class.
If the +class_name+ is omitted an anonymous structure class will be
created. Otherwise, the name of this struct will appear as a constant in
class Struct, so it must be unique for all Structs in the system and
must start with a capital letter. Assigning a structure class to a
constant also gives the class the name of the constant.
# Create a structure with a name under Struct
Struct.new("Customer", :name, :address)
#=> Struct::Customer
Struct::Customer.new("Dave", "123 Main")
#=> #
If a block is given it will be evaluated in the context of
+StructClass+, passing the created class as a parameter:
Customer = Struct.new(:name, :address) do
def greeting
"Hello #{name}!"
end
end
Customer.new("Dave", "123 Main").greeting # => "Hello Dave!"
This is the recommended way to customize a struct. Subclassing an
anonymous struct creates an extra anonymous class that will never be used.
The last two forms create a new instance of a struct subclass. The number
of +value+ parameters must be less than or equal to the number of
attributes defined for the structure. Unset parameters default to +nil+.
Passing more parameters than number of attributes will raise
an ArgumentError.
# Create a structure named by its constant
Customer = Struct.new(:name, :address)
#=> Customer
Customer.new("Dave", "123 Main")
#=> #
;T;[ o;
; I"
overload;F; 0;;S; 0; I"(new([class_name] [, member_name]+>);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"StructClass;T;"@R;#[ ;$I"@return [StructClass];T;%0;"@R;&0;'F;(i ;[[I" [class_name][, member_name];T0;"@Ro;
; I"
overload;F; 0;;S; 0; I"(new([class_name] [, member_name]+>);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"StructClass;T;"@Ro;!
; I" return;F; I" ;T;0; [I"StructClass;T;"@R;#[ ;$I"/@yield [StructClass]
@return [StructClass];T;%0;"@R;&0;'F;(i ;[[I" [class_name][, member_name];T0;"@Ro;
; I"
overload;F; 0;;S; 0; I"new(value, ...);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@R;#[ ;$I"@return [Object];T;%0;"@R;&0;'F;(i ;[[I"
value;T0[I"...;T0;"@Ro;
; I"
overload;F; 0;;V; 0; I"[](value, ...);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@R;#[ ;$I"@return [Object];T;%0;"@R;&0;'F;(i ;[[I"
value;T0[I"...;T0;"@R;#[ ;$I"The first two forms are used to create a new Struct subclass +class_name+
that can contain a value for each +member_name+. This subclass can be
used to create instances of the structure like any other Class.
If the +class_name+ is omitted an anonymous structure class will be
created. Otherwise, the name of this struct will appear as a constant in
class Struct, so it must be unique for all Structs in the system and
must start with a capital letter. Assigning a structure class to a
constant also gives the class the name of the constant.
# Create a structure with a name under Struct
Struct.new("Customer", :name, :address)
#=> Struct::Customer
Struct::Customer.new("Dave", "123 Main")
#=> #
If a block is given it will be evaluated in the context of
+StructClass+, passing the created class as a parameter:
Customer = Struct.new(:name, :address) do
def greeting
"Hello #{name}!"
end
end
Customer.new("Dave", "123 Main").greeting # => "Hello Dave!"
This is the recommended way to customize a struct. Subclassing an
anonymous struct creates an extra anonymous class that will never be used.
The last two forms create a new instance of a struct subclass. The number
of +value+ parameters must be less than or equal to the number of
attributes defined for the structure. Unset parameters default to +nil+.
Passing more parameters than number of attributes will raise
an ArgumentError.
# Create a structure named by its constant
Customer = Struct.new(:name, :address)
#=> Customer
Customer.new("Dave", "123 Main")
#=> #
@overload new([class_name] [, member_name]+>)
@return [StructClass]
@overload new([class_name] [, member_name]+>)
@yield [StructClass]
@return [StructClass]
@overload new(value, ...)
@return [Object]
@overload [](value, ...)
@return [Object];T;%0;"@R;'F;)o;*;+T;,i;-i;.@R; I"static VALUE;T;/I"lstatic VALUE
rb_struct_s_def(int argc, VALUE *argv, VALUE klass)
{
VALUE name, rest;
long i;
VALUE st;
st_table *tbl;
rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS);
name = argv[0];
if (SYMBOL_P(name)) {
name = Qnil;
}
else {
--argc;
++argv;
}
rest = rb_ident_hash_new();
RBASIC_CLEAR_CLASS(rest);
tbl = RHASH_TBL(rest);
for (i=0; i argc) {
rb_mem_clear((VALUE *)RSTRUCT_CONST_PTR(self)+argc, n-argc);
}
return Qnil;
};T;0To;
; F; ;
;;;I"Struct#initialize_copy;F;[[I"s;T0;[[@Ri%;T;;w;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@NS;'F;)o;*;+T;,i$;-i$;.@R; I"
VALUE;T;/I"OVALUE
rb_struct_init_copy(VALUE copy, VALUE s)
{
long i, len;
if (!OBJ_INIT_COPY(copy, s)) return copy;
if (RSTRUCT_LEN(copy) != RSTRUCT_LEN(s)) {
rb_raise(rb_eTypeError, "struct size mismatch");
}
for (i=0, len=RSTRUCT_LEN(copy); i true
joe == jane #=> false
;T;[o;
; I"
overload;F; 0;;:; 0; I"==(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@^S;#[ ;$I"@return [Boolean];T;%0;"@^S;&0;'F;(i ;[[I"
other;T0;"@^S;#[ ;$I"Equality---Returns +true+ if +other+ has the same struct subclass and has
equal member values (according to Object#==).
Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joejr = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
jane = Customer.new("Jane Doe", "456 Elm, Anytown NC", 12345)
joe == joejr #=> true
joe == jane #=> false
@overload ==(other)
@return [Boolean];T;%0;"@^S;'F;)o;*;+T;,i;-i;.@R; I"static VALUE;T;/I"nstatic VALUE
rb_struct_equal(VALUE s, VALUE s2)
{
if (s == s2) return Qtrue;
if (!RB_TYPE_P(s2, T_STRUCT)) return Qfalse;
if (rb_obj_class(s) != rb_obj_class(s2)) return Qfalse;
if (RSTRUCT_LEN(s) != RSTRUCT_LEN(s2)) {
rb_bug("inconsistent struct"); /* should never happen */
}
return rb_exec_recursive_paired(recursive_equal, s, s2, s2);
};T;0To;
; F; ;
;;;I"Struct#eql?;F;[[I"s2;T0;[[@RiM;T;;q;0;[ ;{ ;IC;"Hash equality---+other+ and +struct+ refer to the same hash key if they
have the same struct subclass and have equal member values (according to
Object#eql?).
;T;[o;
; I"
overload;F; 0;;q; 0; I"eql?(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@}S;#[ ;$I"@return [Boolean];T;%0;"@}S;&0;'F;(i ;[[I"
other;T0;"@}So;!
; I" return;F; @;0; [@;"@}S;#[ ;$I"Hash equality---+other+ and +struct+ refer to the same hash key if they
have the same struct subclass and have equal member values (according to
Object#eql?).
@overload eql?(other)
@return [Boolean];T;%0;"@}S;'F;)o;*;+T;,iD;-iJ;.@R; I"static VALUE;T;/I"jstatic VALUE
rb_struct_eql(VALUE s, VALUE s2)
{
if (s == s2) return Qtrue;
if (!RB_TYPE_P(s2, T_STRUCT)) return Qfalse;
if (rb_obj_class(s) != rb_obj_class(s2)) return Qfalse;
if (RSTRUCT_LEN(s) != RSTRUCT_LEN(s2)) {
rb_bug("inconsistent struct"); /* should never happen */
}
return rb_exec_recursive_paired(recursive_eql, s, s2, s2);
};T;0To;
; F; ;
;;;I"Struct#hash;F;[ ;[[@Ri!;T;;H;0;[ ;{ ;IC;"cReturns a hash value based on this struct's contents (see Object#hash).
See also Object#hash.
;T;[o;
; I"
overload;F; 0;;H; 0; I" hash;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;T;"@S;#[ ;$I"@return [Fixnum];T;%0;"@S;&0;'F;(i ;[ ;"@S;#[ ;$I"Returns a hash value based on this struct's contents (see Object#hash).
See also Object#hash.
@overload hash
@return [Fixnum];T;%0;"@S;'F;)o;*;+T;,i;-i ;.@R; I"static VALUE;T;/I"hstatic VALUE
rb_struct_hash(VALUE s)
{
long i, len;
st_index_t h;
VALUE n;
const VALUE *ptr;
h = rb_hash_start(rb_hash(rb_obj_class(s)));
ptr = RSTRUCT_CONST_PTR(s);
len = RSTRUCT_LEN(s);
for (i = 0; i < len; i++) {
n = rb_hash(ptr[i]);
h = rb_hash_uint(h, NUM2LONG(n));
}
h = rb_hash_end(h);
return INT2FIX(h);
};T;0To;
; F; ;
;;;I"Struct#inspect;F;[ ;[[@Ri;T;;J;0;[ ;{ ;IC;"6Describe the contents of this struct in a string.
;T;[o;
; I"
overload;F; 0;;I; 0; I" to_s;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@S;#[ ;$I"@return [String];T;%0;"@S;&0;'F;(i ;[ ;"@So;
; I"
overload;F; 0;;J; 0; I" inspect;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@S;#[ ;$I"@return [String];T;%0;"@S;&0;'F;(i ;[ ;"@S;#[ ;$I"Describe the contents of this struct in a string.
@overload to_s
@return [String]
@overload inspect
@return [String];T;%0;"o;
; F; ;
;;;I"Struct#to_s;F;[ ;[[@Ri;F;;I;;X;[ ;{ ;@S;.@R; I"static VALUE;T;/I"dstatic VALUE
rb_struct_inspect(VALUE s)
{
return rb_exec_recursive(inspect_struct, s, 0);
};T;'F;)o;*;+T;,i;-i;.@R; @S;/I"dstatic VALUE
rb_struct_inspect(VALUE s)
{
return rb_exec_recursive(inspect_struct, s, 0);
};T;0T@So;
; F; ;
;;;I"Struct#to_a;F;[ ;[[@Ri;T;;L;0;[ ;{ ;IC;"Returns the values for this struct as an Array.
Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.to_a[1] #=> "123 Maple, Anytown NC"
;T;[o;
; I"
overload;F; 0;;L; 0; I" to_a;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@S;#[ ;$I"@return [Array];T;%0;"@S;&0;'F;(i ;[ ;"@So;
; I"
overload;F; 0;;; 0; I" values;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@S;#[ ;$I"@return [Array];T;%0;"@S;&0;'F;(i ;[ ;"@S;#[ ;$I"Returns the values for this struct as an Array.
Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.to_a[1] #=> "123 Maple, Anytown NC"
@overload to_a
@return [Array]
@overload values
@return [Array];T;%0;"@S;'F;)o;*;+T;,i;-i;.@R; I"static VALUE;T;/I"kstatic VALUE
rb_struct_to_a(VALUE s)
{
return rb_ary_new4(RSTRUCT_LEN(s), RSTRUCT_CONST_PTR(s));
};T;0To;
; F; ;
;;;I"Struct#to_h;F;[ ;[[@Ri;T;;M;0;[ ;{ ;IC;"Returns a Hash containing the names and values for the struct's members.
Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.to_h[:address] #=> "123 Maple, Anytown NC"
;T;[o;
; I"
overload;F; 0;;M; 0; I" to_h;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@T;#[ ;$I"@return [Hash];T;%0;"@T;&0;'F;(i ;[ ;"@T;#[ ;$I"Returns a Hash containing the names and values for the struct's members.
Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.to_h[:address] #=> "123 Maple, Anytown NC"
@overload to_h
@return [Hash];T;%0;"@T;'F;)o;*;+T;,i ;-i;.@R; I"static VALUE;T;/I"static VALUE
rb_struct_to_h(VALUE s)
{
VALUE h = rb_hash_new();
VALUE members = rb_struct_members(s);
long i;
for (i=0; i "123 Maple, Anytown NC"
;T;[o;
; I"
overload;F; 0;;L; 0; I" to_a;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@-T;#[ ;$I"@return [Array];T;%0;"@-T;&0;'F;(i ;[ ;"@-To;
; I"
overload;F; 0;;; 0; I" values;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@-T;#[ ;$I"@return [Array];T;%0;"@-T;&0;'F;(i ;[ ;"@-T;#[ ;$@T;%0;"@-T;'F;)o;*;+T;,i;-i;.@R; I"static VALUE;T;/I"kstatic VALUE
rb_struct_to_a(VALUE s)
{
return rb_ary_new4(RSTRUCT_LEN(s), RSTRUCT_CONST_PTR(s));
};T;0To;
; F; ;
;;;I"Struct#size;F;[ ;[[@Rif;T;;[;0;[ ;{ ;IC;"Returns the number of struct members.
Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.length #=> 3
;T;[o;
; I"
overload;F; 0;;Z; 0; I" length;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;T;"@TT;#[ ;$I"@return [Fixnum];T;%0;"@TT;&0;'F;(i ;[ ;"@TTo;
; I"
overload;F; 0;;[; 0; I" size;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;T;"@TT;#[ ;$I"@return [Fixnum];T;%0;"@TT;&0;'F;(i ;[ ;"@TT;#[ ;$I"Returns the number of struct members.
Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.length #=> 3
@overload length
@return [Fixnum]
@overload size
@return [Fixnum];T;%0;"@TT;'F;)o;*;+T;,iZ;-id;.@R; I"static VALUE;T;/I"Rstatic VALUE
rb_struct_size(VALUE s)
{
return LONG2FIX(RSTRUCT_LEN(s));
};T;0To;
; F; ;
;;;I"Struct#length;F;[ ;[[@Rif;T;;Z;0;[ ;{ ;IC;"Returns the number of struct members.
Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.length #=> 3
;T;[o;
; I"
overload;F; 0;;Z; 0; I" length;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;T;"@|T;#[ ;$I"@return [Fixnum];T;%0;"@|T;&0;'F;(i ;[ ;"@|To;
; I"
overload;F; 0;;[; 0; I" size;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;T;"@|T;#[ ;$I"@return [Fixnum];T;%0;"@|T;&0;'F;(i ;[ ;"@|T;#[ ;$@xT;%0;"@|T;'F;)o;*;+T;,iZ;-id;.@R; I"static VALUE;T;/I"Rstatic VALUE
rb_struct_size(VALUE s)
{
return LONG2FIX(RSTRUCT_LEN(s));
};T;0To;
; F; ;
;;;I"Struct#each;F;[ ;[[@Ri;T;;;0;[ ;{ ;IC;"+Yields the value of each struct member in order. If no block is given an
enumerator is returned.
Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.each {|x| puts(x) }
Produces:
Joe Smith
123 Maple, Anytown NC
12345
;T;[o;
; I"
overload;F; 0;;; 0; I" each;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@T;#[ ;$I"@yield [obj];T;%0;"@T;&0;'F;(i ;[ ;"@To;
; I"
overload;F; 0;;; 0; I" each;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@T;&0;'F;(i ;[ ;"@T;#[ ;$I"ZYields the value of each struct member in order. If no block is given an
enumerator is returned.
Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.each {|x| puts(x) }
Produces:
Joe Smith
123 Maple, Anytown NC
12345
@overload each
@yield [obj]
@overload each;T;%0;"@T;'F;)o;*;+T;,it;-i;.@R; I"static VALUE;T;/I"static VALUE
rb_struct_each(VALUE s)
{
long i;
RETURN_SIZED_ENUMERATOR(s, 0, 0, struct_enum_size);
for (i=0; i #{value}") }
Produces:
name => Joe Smith
address => 123 Maple, Anytown NC
zip => 12345
;T;[o;
; I"
overload;F; 0;;; 0; I"each_pair;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"sym;TI"obj;T;"@T;#[ ;$I"@yield [sym, obj];T;%0;"@T;&0;'F;(i ;[ ;"@To;
; I"
overload;F; 0;;; 0; I"each_pair;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@T;&0;'F;(i ;[ ;"@T;#[ ;$I"Yields the name and value of each struct member in order. If no block is
given an enumerator is returned.
Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.each_pair {|name, value| puts("#{name} => #{value}") }
Produces:
name => Joe Smith
address => 123 Maple, Anytown NC
zip => 12345
@overload each_pair
@yield [sym, obj]
@overload each_pair;T;%0;"@T;'F;)o;*;+T;,i;-i;.@R; I"static VALUE;T;/I",static VALUE
rb_struct_each_pair(VALUE s)
{
VALUE members;
long i;
RETURN_SIZED_ENUMERATOR(s, 0, 0, struct_enum_size);
members = rb_struct_members(s);
if (rb_block_arity() > 1) {
for (i=0; i "Joe Smith"
joe[:name] #=> "Joe Smith"
joe[0] #=> "Joe Smith"
;T;[o;
; I"
overload;F; 0;;V; 0; I"[](member);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@T;#[ ;$I"@return [Object];T;%0;"@T;&0;'F;(i ;[[I" member;T0;"@To;
; I"
overload;F; 0;;V; 0; I"[](index);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@T;#[ ;$I"@return [Object];T;%0;"@T;&0;'F;(i ;[[I"
index;T0;"@T;#[ ;$I"Attribute Reference---Returns the value of the given struct +member+ or
the member at the given +index+. Raises NameError if the +member+ does
not exist and IndexError if the +index+ is out of range.
Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe["name"] #=> "Joe Smith"
joe[:name] #=> "Joe Smith"
joe[0] #=> "Joe Smith"
@overload [](member)
@return [Object]
@overload [](index)
@return [Object];T;%0;"@T;'F;)o;*;+T;,ik;-iz;.@R; I"
VALUE;T;/I"VALUE
rb_struct_aref(VALUE s, VALUE idx)
{
int i = rb_struct_pos(s, &idx);
if (i < 0) invalid_struct_pos(s, idx);
return RSTRUCT_GET(s, i);
};T;0To;
; F; ;
;;;I"Struct#[]=;F;[[I"idx;T0[I"val;T0;[[@Ri;T;;X;0;[ ;{ ;IC;"Attribute Assignment---Sets the value of the given struct +member+ or
the member at the given +index+. Raises NameError if the +member+ does not
exist and IndexError if the +index+ is out of range.
Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe["name"] = "Luke"
joe[:zip] = "90210"
joe.name #=> "Luke"
joe.zip #=> "90210"
;T;[o;
; I"
overload;F; 0;;X; 0; I"[]=(member);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@U;#[ ;$I"@return [Object];T;%0;"@U;&0;'F;(i ;[[I" member;T0;"@Uo;
; I"
overload;F; 0;;X; 0; I"[]=(index);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@U;#[ ;$I"@return [Object];T;%0;"@U;&0;'F;(i ;[[I"
index;T0;"@U;#[ ;$I"Attribute Assignment---Sets the value of the given struct +member+ or
the member at the given +index+. Raises NameError if the +member+ does not
exist and IndexError if the +index+ is out of range.
Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe["name"] = "Luke"
joe[:zip] = "90210"
joe.name #=> "Luke"
joe.zip #=> "90210"
@overload []=(member)
@return [Object]
@overload []=(index)
@return [Object];T;%0;"@U;'F;)o;*;+T;,i;-i;.@R; I"
VALUE;T;/I"VALUE
rb_struct_aset(VALUE s, VALUE idx, VALUE val)
{
int i = rb_struct_pos(s, &idx);
if (i < 0) invalid_struct_pos(s, idx);
rb_struct_modify(s);
RSTRUCT_SET(s, i, val);
return val;
};T;0To;
; F; ;
;;;I"Struct#select;F;[[@0;[[@Ri;T;;;0;[ ;{ ;IC;"UYields each member value from the struct to the block and returns an Array
containing the member values from the +struct+ for which the given block
returns a true value (equivalent to Enumerable#select).
Lots = Struct.new(:a, :b, :c, :d, :e, :f)
l = Lots.new(11, 22, 33, 44, 55, 66)
l.select {|v| (v % 2).zero? } #=> [22, 44, 66]
;T;[o;
; I"
overload;F; 0;;; 0; I" select;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"i;T;"@HUo;!
; I" return;F; I" ;T;0; [I"
Array;T;"@HU;#[ ;$I" @yield [i]
@return [Array];T;%0;"@HU;&0;'F;(i ;[ ;"@HUo;
; I"
overload;F; 0;;; 0; I" select;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@HU;&0;'F;(i ;[ ;"@HU;#[ ;$I"Yields each member value from the struct to the block and returns an Array
containing the member values from the +struct+ for which the given block
returns a true value (equivalent to Enumerable#select).
Lots = Struct.new(:a, :b, :c, :d, :e, :f)
l = Lots.new(11, 22, 33, 44, 55, 66)
l.select {|v| (v % 2).zero? } #=> [22, 44, 66]
@overload select
@yield [i]
@return [Array]
@overload select;T;%0;"@HU;'F;)o;*;+T;,i;-i;.@R; I"static VALUE;T;/I"sstatic VALUE
rb_struct_select(int argc, VALUE *argv, VALUE s)
{
VALUE result;
long i;
rb_check_arity(argc, 0, 0);
RETURN_SIZED_ENUMERATOR(s, 0, 0, struct_enum_size);
result = rb_ary_new();
for (i = 0; i < RSTRUCT_LEN(s); i++) {
if (RTEST(rb_yield(RSTRUCT_GET(s, i)))) {
rb_ary_push(result, RSTRUCT_GET(s, i));
}
}
return result;
};T;0To;
; F; ;
;;;I"Struct#values_at;F;[[@0;[[@Ri;T;;;0;[ ;{ ;IC;"AReturns the struct member values for each +selector+ as an Array. A
+selector+ may be either an Integer offset or a Range of offsets (as in
Array#values_at).
Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.values_at 0, 2 #=> ["Joe Smith", 12345]
;T;[o;
; I"
overload;F; 0;;; 0; I" values_at(selector, ...);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@qU;#[ ;$I"@return [Array];T;%0;"@qU;&0;'F;(i ;[[I"
selector;T0[I"...;T0;"@qU;#[ ;$I"yReturns the struct member values for each +selector+ as an Array. A
+selector+ may be either an Integer offset or a Range of offsets (as in
Array#values_at).
Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.values_at 0, 2 #=> ["Joe Smith", 12345]
@overload values_at(selector, ...)
@return [Array];T;%0;"@qU;'F;)o;*;+T;,i;-i;.@R; I"static VALUE;T;/I"static VALUE
rb_struct_values_at(int argc, VALUE *argv, VALUE s)
{
return rb_get_values_at(s, RSTRUCT_LEN(s), argc, argv, struct_entry);
};T;0To;
; F; ;
;;;I"Struct#members;F;[ ;[[@Ri;T;: members;0;[ ;{ ;IC;"Returns the struct members as an array of symbols:
Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.members #=> [:name, :address, :zip]
;T;[o;
; I"
overload;F; 0;;'; 0; I" members;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@U;#[ ;$I"@return [Array];T;%0;"@U;&0;'F;(i ;[ ;"@U;#[ ;$I"Returns the struct members as an array of symbols:
Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.members #=> [:name, :address, :zip]
@overload members
@return [Array];T;%0;"@U;'F;)o;*;+T;,i;-i;.@R; I"static VALUE;T;/I"istatic VALUE
rb_struct_members_m(VALUE obj)
{
return rb_struct_s_members_m(rb_obj_class(obj));
};T;0To;
; F; ;
;;;I"Struct#dig;F;[[@0;[[@Ri{;T;;;0;[ ;{ ;IC;"7Extracts the nested value specified by the sequence of idx
objects by calling +dig+ at each step, returning +nil+ if any
intermediate step is +nil+.
klass = Struct.new(:a)
o = klass.new(klass.new({b: [1, 2, 3]}))
o.dig(:a, :a, :b, 0) #=> 1
o.dig(:b, 0) #=> nil
;T;[o;
; I"
overload;F; 0;;; 0; I"dig(key, ...);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@U;#[ ;$I"@return [Object];T;%0;"@U;&0;'F;(i ;[[I"key;T0[I"...;T0;"@U;#[ ;$I"dExtracts the nested value specified by the sequence of idx
objects by calling +dig+ at each step, returning +nil+ if any
intermediate step is +nil+.
klass = Struct.new(:a)
o = klass.new(klass.new({b: [1, 2, 3]}))
o.dig(:a, :a, :b, 0) #=> 1
o.dig(:b, 0) #=> nil
@overload dig(key, ...)
@return [Object];T;%0;"@U;'F;)o;*;+T;,il;-ix;.@R; I"static VALUE;T;/I"static VALUE
rb_struct_dig(int argc, VALUE *argv, VALUE self)
{
rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS);
self = rb_struct_lookup(self, *argv);
if (!--argc) return self;
++argv;
return rb_obj_dig(argc, argv, self, Qnil);
};T;0To;;[[@
i ;F;:Tms;;;;;[ ;{ ;IC;"#for the backward compatibility
;T;[ ;#[ ;$I"#for the backward compatibility;T;%0;"@U;'F;)o;*;+T;,i ;-i ;.@R;I"Struct::Tms;F;I"rb_cProcessTms;To;;[[I"ext/etc/etc.c;Ti;F;: Passwd;;;;;[ ;{ ;IC;"deprecated name
;T;[ ;#[ ;$I"deprecated name;T;%0;"@U;'F;)o;*;+T;,i;-i;.@R;I"Struct::Passwd;F;I" sPasswd;To;;[[@Ui;F;:
Group;;;;;[ ;{ ;IC;"deprecated name
;T;[ ;#[ ;$I"deprecated name;T;%0;"@U;'F;)o;*;+T;,i;-i;.@R;I"Struct::Group;F;I" sGroup;T;N@R;OIC;[ ;N@R;PIC;[o;Z ;[0;\0;]0;;;.@;_@G;0;N@R;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{@S;J;V[ ;[[@Ri;F;: Struct;;X;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@R;(i ;.@;I" Struct;F;Y@No;;IC;[Ao;
; F; ;
;;K;I"ObjectSpace#memsize_of;F;[[I"obj;T0;[[I" ext/objspace/objspace.c;Ti,;T;:memsize_of;0;[ ;{ ;IC;"?Return consuming memory size of obj.
Note that the return size is incomplete. You need to deal with this
information as only a *HINT*. Especially, the size of +T_DATA+ may not be
correct.
This method is only expected to work with C Ruby.
From Ruby 2.2, memsize_of(obj) returns a memory size includes
sizeof(RVALUE).
;T;[o;
; I"
overload;F; 0;;,; 0; I"memsize_of(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@V;#[ ;$I"@return [Integer];T;%0;"@V;&0;'F;(i ;[[I"obj;T0;"@V;#[ ;$I"nReturn consuming memory size of obj.
Note that the return size is incomplete. You need to deal with this
information as only a *HINT*. Especially, the size of +T_DATA+ may not be
correct.
This method is only expected to work with C Ruby.
From Ruby 2.2, memsize_of(obj) returns a memory size includes
sizeof(RVALUE).
@overload memsize_of(obj)
@return [Integer];T;%0;"@V;&0;'F;.@V; I"static VALUE;T;/I"gstatic VALUE
memsize_of_m(VALUE self, VALUE obj)
{
return SIZET2NUM(rb_obj_memsize_of(obj));
};T;0To;
; T; ;S;;;I"ObjectSpace.memsize_of;F;@V;@V;T;;,;0;@ V;{ ;IC;"?Return consuming memory size of obj.
Note that the return size is incomplete. You need to deal with this
information as only a *HINT*. Especially, the size of +T_DATA+ may not be
correct.
This method is only expected to work with C Ruby.
From Ruby 2.2, memsize_of(obj) returns a memory size includes
sizeof(RVALUE).;T;[o;
; I"
overload;F; 0;;,; 0; I"memsize_of(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@"V;#[ ;$I"@return [Integer];T;%0;"@"V;&0;'F;(i ;[[I"obj;T0;"@"V;#[ ;$I"oReturn consuming memory size of obj.
Note that the return size is incomplete. You need to deal with this
information as only a *HINT*. Especially, the size of +T_DATA+ may not be
correct.
This method is only expected to work with C Ruby.
From Ruby 2.2, memsize_of(obj) returns a memory size includes
sizeof(RVALUE).
@overload memsize_of(obj)
@return [Integer];T;%0;"@"V;'F;(i ;)o;*;+T;,i ;-i);.@V; @ V;/@!V;0To;
; F; ;
;;K;I" ObjectSpace#memsize_of_all;F;[[@0;[[@
Vim;T;:memsize_of_all;0;[ ;{ ;IC;"Return consuming memory size of all living objects.
If +klass+ (should be Class object) is given, return the total memory size
of instances of the given class.
Note that the returned size is incomplete. You need to deal with this
information as only a *HINT*. Especially, the size of +T_DATA+ may not be
correct.
Note that this method does *NOT* return total malloc'ed memory size.
This method can be defined by the following Ruby code:
def memsize_of_all klass = false
total = 0
ObjectSpace.each_object{|e|
total += ObjectSpace.memsize_of(e) if klass == false || e.kind_of?(klass)
}
total
end
This method is only expected to work with C Ruby.
;T;[o;
; I"
overload;F; 0;;-; 0; I" memsize_of_all([klass]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@9V;#[ ;$I"@return [Integer];T;%0;"@9V;&0;'F;(i ;[[I" [klass];T0;"@9V;#[ ;$I"Return consuming memory size of all living objects.
If +klass+ (should be Class object) is given, return the total memory size
of instances of the given class.
Note that the returned size is incomplete. You need to deal with this
information as only a *HINT*. Especially, the size of +T_DATA+ may not be
correct.
Note that this method does *NOT* return total malloc'ed memory size.
This method can be defined by the following Ruby code:
def memsize_of_all klass = false
total = 0
ObjectSpace.each_object{|e|
total += ObjectSpace.memsize_of(e) if klass == false || e.kind_of?(klass)
}
total
end
This method is only expected to work with C Ruby.
@overload memsize_of_all([klass])
@return [Integer];T;%0;"@9V;&0;'F;.@V; I"static VALUE;T;/I"static VALUE
memsize_of_all_m(int argc, VALUE *argv, VALUE self)
{
struct total_data data = {0, 0};
if (argc > 0) {
rb_scan_args(argc, argv, "01", &data.klass);
}
rb_objspace_each_objects(total_i, &data);
return SIZET2NUM(data.total);
};T;0To;
; T; ;S;;;I" ObjectSpace.memsize_of_all;F;@;V;@=V;T;;-;0;@?V;{ ;IC;"Return consuming memory size of all living objects.
If +klass+ (should be Class object) is given, return the total memory size
of instances of the given class.
Note that the returned size is incomplete. You need to deal with this
information as only a *HINT*. Especially, the size of +T_DATA+ may not be
correct.
Note that this method does *NOT* return total malloc'ed memory size.
This method can be defined by the following Ruby code:
def memsize_of_all klass = false
total = 0
ObjectSpace.each_object{|e|
total += ObjectSpace.memsize_of(e) if klass == false || e.kind_of?(klass)
}
total
end
This method is only expected to work with C Ruby.;T;[o;
; I"
overload;F; 0;;-; 0; I" memsize_of_all([klass]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@VV;#[ ;$I"@return [Integer];T;%0;"@VV;&0;'F;(i ;[[I" [klass];T0;"@VV;#[ ;$I"Return consuming memory size of all living objects.
If +klass+ (should be Class object) is given, return the total memory size
of instances of the given class.
Note that the returned size is incomplete. You need to deal with this
information as only a *HINT*. Especially, the size of +T_DATA+ may not be
correct.
Note that this method does *NOT* return total malloc'ed memory size.
This method can be defined by the following Ruby code:
def memsize_of_all klass = false
total = 0
ObjectSpace.each_object{|e|
total += ObjectSpace.memsize_of(e) if klass == false || e.kind_of?(klass)
}
total
end
This method is only expected to work with C Ruby.
@overload memsize_of_all([klass])
@return [Integer];T;%0;"@VV;'F;(i ;)o;*;+T;,iQ;-ij;.@V; @TV;/@UV;0To;
; F; ;
;;K;I"#ObjectSpace#count_objects_size;F;[[@0;[[@
Vi;T;:count_objects_size;0;[ ;{ ;IC;"7Counts objects size (in bytes) for each type.
Note that this information is incomplete. You need to deal with
this information as only a *HINT*. Especially, total size of
T_DATA may not right size.
It returns a hash as:
{:TOTAL=>1461154, :T_CLASS=>158280, :T_MODULE=>20672, :T_STRING=>527249, ...}
If the optional argument, result_hash, is given,
it is overwritten and returned.
This is intended to avoid probe effect.
The contents of the returned hash is implementation defined.
It may be changed in future.
This method is only expected to work with C Ruby.
;T;[o;
; I"
overload;F; 0;;.; 0; I"&count_objects_size([result_hash]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@mV;#[ ;$I"@return [Hash];T;%0;"@mV;&0;'F;(i ;[[I"[result_hash];T0;"@mV;#[ ;$I"uCounts objects size (in bytes) for each type.
Note that this information is incomplete. You need to deal with
this information as only a *HINT*. Especially, total size of
T_DATA may not right size.
It returns a hash as:
{:TOTAL=>1461154, :T_CLASS=>158280, :T_MODULE=>20672, :T_STRING=>527249, ...}
If the optional argument, result_hash, is given,
it is overwritten and returned.
This is intended to avoid probe effect.
The contents of the returned hash is implementation defined.
It may be changed in future.
This method is only expected to work with C Ruby.
@overload count_objects_size([result_hash])
@return [Hash];T;%0;"@mV;&0;'F;.@V; I"static VALUE;T;/I"static VALUE
count_objects_size(int argc, VALUE *argv, VALUE os)
{
size_t counts[T_MASK+1];
size_t total = 0;
enum ruby_value_type i;
VALUE hash = setup_hash(argc, argv);
for (i = 0; i <= T_MASK; i++) {
counts[i] = 0;
}
rb_objspace_each_objects(cos_i, &counts[0]);
if (hash == Qnil) {
hash = rb_hash_new();
}
else if (!RHASH_EMPTY_P(hash)) {
st_foreach(RHASH_TBL(hash), set_zero_i, hash);
}
for (i = 0; i <= T_MASK; i++) {
if (counts[i]) {
VALUE type = type2sym(i);
total += counts[i];
rb_hash_aset(hash, type, SIZET2NUM(counts[i]));
}
}
rb_hash_aset(hash, ID2SYM(rb_intern("TOTAL")), SIZET2NUM(total));
return hash;
};T;0To;
; T; ;S;;;I"#ObjectSpace.count_objects_size;F;@oV;@qV;T;;.;0;@sV;{ ;IC;"7Counts objects size (in bytes) for each type.
Note that this information is incomplete. You need to deal with
this information as only a *HINT*. Especially, total size of
T_DATA may not right size.
It returns a hash as:
{:TOTAL=>1461154, :T_CLASS=>158280, :T_MODULE=>20672, :T_STRING=>527249, ...}
If the optional argument, result_hash, is given,
it is overwritten and returned.
This is intended to avoid probe effect.
The contents of the returned hash is implementation defined.
It may be changed in future.
This method is only expected to work with C Ruby.;T;[o;
; I"
overload;F; 0;;.; 0; I"&count_objects_size([result_hash]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@V;#[ ;$I"@return [Hash];T;%0;"@V;&0;'F;(i ;[[I"[result_hash];T0;"@V;#[ ;$I"vCounts objects size (in bytes) for each type.
Note that this information is incomplete. You need to deal with
this information as only a *HINT*. Especially, total size of
T_DATA may not right size.
It returns a hash as:
{:TOTAL=>1461154, :T_CLASS=>158280, :T_MODULE=>20672, :T_STRING=>527249, ...}
If the optional argument, result_hash, is given,
it is overwritten and returned.
This is intended to avoid probe effect.
The contents of the returned hash is implementation defined.
It may be changed in future.
This method is only expected to work with C Ruby.
@overload count_objects_size([result_hash])
@return [Hash];T;%0;"@V;'F;(i ;)o;*;+T;,i;-i;.@V; @V;/@V;0To;
; F; ;
;;K;I" ObjectSpace#count_symbols;F;[[@0;[[@
Vi3;T;:count_symbols;0;[ ;{ ;IC;"'Counts symbols for each Symbol type.
This method is only for MRI developers interested in performance and memory
usage of Ruby programs.
If the optional argument, result_hash, is given, it is overwritten and
returned. This is intended to avoid probe effect.
Note:
The contents of the returned hash is implementation defined.
It may be changed in future.
This method is only expected to work with C Ruby.
On this version of MRI, they have 3 types of Symbols (and 1 total counts).
* mortal_dynamic_symbol: GC target symbols (collected by GC)
* immortal_dynamic_symbol: Immortal symbols promoted from dynamic symbols (do not collected by GC)
* immortal_static_symbol: Immortal symbols (do not collected by GC)
* immortal_symbol: total immortal symbols (immortal_dynamic_symbol+immortal_static_symbol)
;T;[o;
; I"
overload;F; 0;;/; 0; I"!count_symbols([result_hash]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@V;#[ ;$I"@return [Hash];T;%0;"@V;&0;'F;(i ;[[I"[result_hash];T0;"@V;#[ ;$I"`Counts symbols for each Symbol type.
This method is only for MRI developers interested in performance and memory
usage of Ruby programs.
If the optional argument, result_hash, is given, it is overwritten and
returned. This is intended to avoid probe effect.
Note:
The contents of the returned hash is implementation defined.
It may be changed in future.
This method is only expected to work with C Ruby.
On this version of MRI, they have 3 types of Symbols (and 1 total counts).
* mortal_dynamic_symbol: GC target symbols (collected by GC)
* immortal_dynamic_symbol: Immortal symbols promoted from dynamic symbols (do not collected by GC)
* immortal_static_symbol: Immortal symbols (do not collected by GC)
* immortal_symbol: total immortal symbols (immortal_dynamic_symbol+immortal_static_symbol)
@overload count_symbols([result_hash])
@return [Hash];T;%0;"@V;&0;'F;.@V; I"static VALUE;T;/I"sstatic VALUE
count_symbols(int argc, VALUE *argv, VALUE os)
{
struct dynamic_symbol_counts dynamic_counts = {0, 0};
VALUE hash = setup_hash(argc, argv);
size_t immortal_symbols = rb_sym_immortal_count();
rb_objspace_each_objects(cs_i, &dynamic_counts);
if (hash == Qnil) {
hash = rb_hash_new();
}
else if (!RHASH_EMPTY_P(hash)) {
st_foreach(RHASH_TBL(hash), set_zero_i, hash);
}
rb_hash_aset(hash, ID2SYM(rb_intern("mortal_dynamic_symbol")), SIZET2NUM(dynamic_counts.mortal));
rb_hash_aset(hash, ID2SYM(rb_intern("immortal_dynamic_symbol")), SIZET2NUM(dynamic_counts.immortal));
rb_hash_aset(hash, ID2SYM(rb_intern("immortal_static_symbol")), SIZET2NUM(immortal_symbols - dynamic_counts.immortal));
rb_hash_aset(hash, ID2SYM(rb_intern("immortal_symbol")), SIZET2NUM(immortal_symbols));
return hash;
};T;0To;
; T; ;S;;;I" ObjectSpace.count_symbols;F;@V;@V;T;;/;0;@V;{ ;IC;"'Counts symbols for each Symbol type.
This method is only for MRI developers interested in performance and memory
usage of Ruby programs.
If the optional argument, result_hash, is given, it is overwritten and
returned. This is intended to avoid probe effect.
Note:
The contents of the returned hash is implementation defined.
It may be changed in future.
This method is only expected to work with C Ruby.
On this version of MRI, they have 3 types of Symbols (and 1 total counts).
* mortal_dynamic_symbol: GC target symbols (collected by GC)
* immortal_dynamic_symbol: Immortal symbols promoted from dynamic symbols (do not collected by GC)
* immortal_static_symbol: Immortal symbols (do not collected by GC)
* immortal_symbol: total immortal symbols (immortal_dynamic_symbol+immortal_static_symbol);T;[o;
; I"
overload;F; 0;;/; 0; I"!count_symbols([result_hash]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@V;#[ ;$I"@return [Hash];T;%0;"@V;&0;'F;(i ;[[I"[result_hash];T0;"@V;#[ ;$I"aCounts symbols for each Symbol type.
This method is only for MRI developers interested in performance and memory
usage of Ruby programs.
If the optional argument, result_hash, is given, it is overwritten and
returned. This is intended to avoid probe effect.
Note:
The contents of the returned hash is implementation defined.
It may be changed in future.
This method is only expected to work with C Ruby.
On this version of MRI, they have 3 types of Symbols (and 1 total counts).
* mortal_dynamic_symbol: GC target symbols (collected by GC)
* immortal_dynamic_symbol: Immortal symbols promoted from dynamic symbols (do not collected by GC)
* immortal_static_symbol: Immortal symbols (do not collected by GC)
* immortal_symbol: total immortal symbols (immortal_dynamic_symbol+immortal_static_symbol)
@overload count_symbols([result_hash])
@return [Hash];T;%0;"@V;'F;(i ;)o;*;+T;,i;-i0;.@V; @V;/@V;0To;
; F; ;
;;K;I" ObjectSpace#count_nodes;F;[[@0;[[@
Vir;T;:count_nodes;0;[ ;{ ;IC;"Counts nodes for each node type.
This method is only for MRI developers interested in performance and memory
usage of Ruby programs.
It returns a hash as:
{:NODE_METHOD=>2027, :NODE_FBODY=>1927, :NODE_CFUNC=>1798, ...}
If the optional argument, result_hash, is given, it is overwritten and
returned. This is intended to avoid probe effect.
Note:
The contents of the returned hash is implementation defined.
It may be changed in future.
This method is only expected to work with C Ruby.
;T;[o;
; I"
overload;F; 0;;0; 0; I" count_nodes([result_hash]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@V;#[ ;$I"@return [Hash];T;%0;"@V;&0;'F;(i ;[[I"[result_hash];T0;"@V;#[ ;$I""Counts nodes for each node type.
This method is only for MRI developers interested in performance and memory
usage of Ruby programs.
It returns a hash as:
{:NODE_METHOD=>2027, :NODE_FBODY=>1927, :NODE_CFUNC=>1798, ...}
If the optional argument, result_hash, is given, it is overwritten and
returned. This is intended to avoid probe effect.
Note:
The contents of the returned hash is implementation defined.
It may be changed in future.
This method is only expected to work with C Ruby.
@overload count_nodes([result_hash])
@return [Hash];T;%0;"@V;&0;'F;.@V; I"static VALUE;T;/I"s
static VALUE
count_nodes(int argc, VALUE *argv, VALUE os)
{
size_t nodes[NODE_LAST+1];
size_t i;
VALUE hash = setup_hash(argc, argv);
for (i = 0; i <= NODE_LAST; i++) {
nodes[i] = 0;
}
rb_objspace_each_objects(cn_i, &nodes[0]);
if (hash == Qnil) {
hash = rb_hash_new();
}
else if (!RHASH_EMPTY_P(hash)) {
st_foreach(RHASH_TBL(hash), set_zero_i, hash);
}
for (i=0; i2027, :NODE_FBODY=>1927, :NODE_CFUNC=>1798, ...}
If the optional argument, result_hash, is given, it is overwritten and
returned. This is intended to avoid probe effect.
Note:
The contents of the returned hash is implementation defined.
It may be changed in future.
This method is only expected to work with C Ruby.;T;[o;
; I"
overload;F; 0;;0; 0; I" count_nodes([result_hash]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@V;#[ ;$I"@return [Hash];T;%0;"@V;&0;'F;(i ;[[I"[result_hash];T0;"@V;#[ ;$I"#Counts nodes for each node type.
This method is only for MRI developers interested in performance and memory
usage of Ruby programs.
It returns a hash as:
{:NODE_METHOD=>2027, :NODE_FBODY=>1927, :NODE_CFUNC=>1798, ...}
If the optional argument, result_hash, is given, it is overwritten and
returned. This is intended to avoid probe effect.
Note:
The contents of the returned hash is implementation defined.
It may be changed in future.
This method is only expected to work with C Ruby.
@overload count_nodes([result_hash])
@return [Hash];T;%0;"@V;'F;(i ;)o;*;+T;,i[;-io;.@V; @V;/@V;0To;
; F; ;
;;K;I"$ObjectSpace#count_tdata_objects;F;[[@0;[[@
Vi;;T;:count_tdata_objects;0;[ ;{ ;IC;"Counts objects for each +T_DATA+ type.
This method is only for MRI developers interested in performance and memory
usage of Ruby programs.
It returns a hash as:
{RubyVM::InstructionSequence=>504, :parser=>5, :barrier=>6,
:mutex=>6, Proc=>60, RubyVM::Env=>57, Mutex=>1, Encoding=>99,
ThreadGroup=>1, Binding=>1, Thread=>1, RubyVM=>1, :iseq=>1,
Random=>1, ARGF.class=>1, Data=>1, :autoload=>3, Time=>2}
# T_DATA objects existing at startup on r32276.
If the optional argument, result_hash, is given, it is overwritten and
returned. This is intended to avoid probe effect.
The contents of the returned hash is implementation specific and may change
in the future.
In this version, keys are Class object or Symbol object.
If object is kind of normal (accessible) object, the key is Class object.
If object is not a kind of normal (internal) object, the key is symbol
name, registered by rb_data_type_struct.
This method is only expected to work with C Ruby.
;T;[o;
; I"
overload;F; 0;;1; 0; I"'count_tdata_objects([result_hash]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@ W;#[ ;$I"@return [Hash];T;%0;"@ W;&0;'F;(i ;[[I"[result_hash];T0;"@ W;#[ ;$I"Counts objects for each +T_DATA+ type.
This method is only for MRI developers interested in performance and memory
usage of Ruby programs.
It returns a hash as:
{RubyVM::InstructionSequence=>504, :parser=>5, :barrier=>6,
:mutex=>6, Proc=>60, RubyVM::Env=>57, Mutex=>1, Encoding=>99,
ThreadGroup=>1, Binding=>1, Thread=>1, RubyVM=>1, :iseq=>1,
Random=>1, ARGF.class=>1, Data=>1, :autoload=>3, Time=>2}
# T_DATA objects existing at startup on r32276.
If the optional argument, result_hash, is given, it is overwritten and
returned. This is intended to avoid probe effect.
The contents of the returned hash is implementation specific and may change
in the future.
In this version, keys are Class object or Symbol object.
If object is kind of normal (accessible) object, the key is Class object.
If object is not a kind of normal (internal) object, the key is symbol
name, registered by rb_data_type_struct.
This method is only expected to work with C Ruby.
@overload count_tdata_objects([result_hash])
@return [Hash];T;%0;"@ W;&0;'F;.@V; I"static VALUE;T;/I"static VALUE
count_tdata_objects(int argc, VALUE *argv, VALUE self)
{
VALUE hash = setup_hash(argc, argv);
rb_objspace_each_objects(cto_i, (void *)hash);
return hash;
};T;0To;
; T; ;S;;;I"$ObjectSpace.count_tdata_objects;F;@ W;@
W;T;;1;0;@W;{ ;IC;"Counts objects for each +T_DATA+ type.
This method is only for MRI developers interested in performance and memory
usage of Ruby programs.
It returns a hash as:
{RubyVM::InstructionSequence=>504, :parser=>5, :barrier=>6,
:mutex=>6, Proc=>60, RubyVM::Env=>57, Mutex=>1, Encoding=>99,
ThreadGroup=>1, Binding=>1, Thread=>1, RubyVM=>1, :iseq=>1,
Random=>1, ARGF.class=>1, Data=>1, :autoload=>3, Time=>2}
# T_DATA objects existing at startup on r32276.
If the optional argument, result_hash, is given, it is overwritten and
returned. This is intended to avoid probe effect.
The contents of the returned hash is implementation specific and may change
in the future.
In this version, keys are Class object or Symbol object.
If object is kind of normal (accessible) object, the key is Class object.
If object is not a kind of normal (internal) object, the key is symbol
name, registered by rb_data_type_struct.
This method is only expected to work with C Ruby.;T;[o;
; I"
overload;F; 0;;1; 0; I"'count_tdata_objects([result_hash]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@&W;#[ ;$I"@return [Hash];T;%0;"@&W;&0;'F;(i ;[[I"[result_hash];T0;"@&W;#[ ;$I"Counts objects for each +T_DATA+ type.
This method is only for MRI developers interested in performance and memory
usage of Ruby programs.
It returns a hash as:
{RubyVM::InstructionSequence=>504, :parser=>5, :barrier=>6,
:mutex=>6, Proc=>60, RubyVM::Env=>57, Mutex=>1, Encoding=>99,
ThreadGroup=>1, Binding=>1, Thread=>1, RubyVM=>1, :iseq=>1,
Random=>1, ARGF.class=>1, Data=>1, :autoload=>3, Time=>2}
# T_DATA objects existing at startup on r32276.
If the optional argument, result_hash, is given, it is overwritten and
returned. This is intended to avoid probe effect.
The contents of the returned hash is implementation specific and may change
in the future.
In this version, keys are Class object or Symbol object.
If object is kind of normal (accessible) object, the key is Class object.
If object is not a kind of normal (internal) object, the key is symbol
name, registered by rb_data_type_struct.
This method is only expected to work with C Ruby.
@overload count_tdata_objects([result_hash])
@return [Hash];T;%0;"@&W;'F;(i ;)o;*;+T;,i;-i8;.@V; @$W;/@%W;0To;
; F; ;
;;K;I"$ObjectSpace#count_imemo_objects;F;[[@0;[[@
Vi|;T;:count_imemo_objects;0;[ ;{ ;IC;"OCounts objects for each +T_IMEMO+ type.
This method is only for MRI developers interested in performance and memory
usage of Ruby programs.
It returns a hash as:
{:imemo_ifunc=>8,
:imemo_svar=>7,
:imemo_cref=>509,
:imemo_memo=>1,
:imemo_throw_data=>1}
If the optional argument, result_hash, is given, it is overwritten and
returned. This is intended to avoid probe effect.
The contents of the returned hash is implementation specific and may change
in the future.
In this version, keys are symbol objects.
This method is only expected to work with C Ruby.
;T;[o;
; I"
overload;F; 0;;2; 0; I"'count_imemo_objects([result_hash]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@=W;#[ ;$I"@return [Hash];T;%0;"@=W;&0;'F;(i ;[[I"[result_hash];T0;"@=W;#[ ;$I"Counts objects for each +T_IMEMO+ type.
This method is only for MRI developers interested in performance and memory
usage of Ruby programs.
It returns a hash as:
{:imemo_ifunc=>8,
:imemo_svar=>7,
:imemo_cref=>509,
:imemo_memo=>1,
:imemo_throw_data=>1}
If the optional argument, result_hash, is given, it is overwritten and
returned. This is intended to avoid probe effect.
The contents of the returned hash is implementation specific and may change
in the future.
In this version, keys are symbol objects.
This method is only expected to work with C Ruby.
@overload count_imemo_objects([result_hash])
@return [Hash];T;%0;"@=W;&0;'F;.@V; I"static VALUE;T;/I"fstatic VALUE
count_imemo_objects(int argc, VALUE *argv, VALUE self)
{
VALUE hash = setup_hash(argc, argv);
if (imemo_type_ids[0] == 0) {
imemo_type_ids[0] = rb_intern("imemo_none");
imemo_type_ids[1] = rb_intern("imemo_cref");
imemo_type_ids[2] = rb_intern("imemo_svar");
imemo_type_ids[3] = rb_intern("imemo_throw_data");
imemo_type_ids[4] = rb_intern("imemo_ifunc");
imemo_type_ids[5] = rb_intern("imemo_memo");
imemo_type_ids[6] = rb_intern("imemo_ment");
imemo_type_ids[7] = rb_intern("imemo_iseq");
}
rb_objspace_each_objects(count_imemo_objects_i, (void *)hash);
return hash;
};T;0To;
; T; ;S;;;I"$ObjectSpace.count_imemo_objects;F;@?W;@AW;T;;2;0;@CW;{ ;IC;"OCounts objects for each +T_IMEMO+ type.
This method is only for MRI developers interested in performance and memory
usage of Ruby programs.
It returns a hash as:
{:imemo_ifunc=>8,
:imemo_svar=>7,
:imemo_cref=>509,
:imemo_memo=>1,
:imemo_throw_data=>1}
If the optional argument, result_hash, is given, it is overwritten and
returned. This is intended to avoid probe effect.
The contents of the returned hash is implementation specific and may change
in the future.
In this version, keys are symbol objects.
This method is only expected to work with C Ruby.;T;[o;
; I"
overload;F; 0;;2; 0; I"'count_imemo_objects([result_hash]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@ZW;#[ ;$I"@return [Hash];T;%0;"@ZW;&0;'F;(i ;[[I"[result_hash];T0;"@ZW;#[ ;$I"Counts objects for each +T_IMEMO+ type.
This method is only for MRI developers interested in performance and memory
usage of Ruby programs.
It returns a hash as:
{:imemo_ifunc=>8,
:imemo_svar=>7,
:imemo_cref=>509,
:imemo_memo=>1,
:imemo_throw_data=>1}
If the optional argument, result_hash, is given, it is overwritten and
returned. This is intended to avoid probe effect.
The contents of the returned hash is implementation specific and may change
in the future.
In this version, keys are symbol objects.
This method is only expected to work with C Ruby.
@overload count_imemo_objects([result_hash])
@return [Hash];T;%0;"@ZW;'F;(i ;)o;*;+T;,i`;-iy;.@V; @XW;/@YW;0To;
; F; ;
;;K;I"'ObjectSpace#reachable_objects_from;F;[[I"obj;T0;[[@
Vi
;T;:reachable_objects_from;0;[ ;{ ;IC;"[MRI specific feature] Return all reachable objects from `obj'.
This method returns all reachable objects from `obj'.
If `obj' has two or more references to the same object `x', then returned
array only includes one `x' object.
If `obj' is a non-markable (non-heap management) object such as true,
false, nil, symbols and Fixnums (and Flonum) then it simply returns nil.
If `obj' has references to an internal object, then it returns instances of
ObjectSpace::InternalObjectWrapper class. This object contains a reference
to an internal object and you can check the type of internal object with
`type' method.
If `obj' is instance of ObjectSpace::InternalObjectWrapper class, then this
method returns all reachable object from an internal object, which is
pointed by `obj'.
With this method, you can find memory leaks.
This method is only expected to work except with C Ruby.
Example:
ObjectSpace.reachable_objects_from(['a', 'b', 'c'])
#=> [Array, 'a', 'b', 'c']
ObjectSpace.reachable_objects_from(['a', 'a', 'a'])
#=> [Array, 'a', 'a', 'a'] # all 'a' strings have different object id
ObjectSpace.reachable_objects_from([v = 'a', v, v])
#=> [Array, 'a']
ObjectSpace.reachable_objects_from(1)
#=> nil # 1 is not markable (heap managed) object
;T;[o;
; I"
overload;F; 0;;3; 0; I" reachable_objects_from(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;TI"nil;T;"@qW;#[ ;$I"@return [Array, nil];T;%0;"@qW;&0;'F;(i ;[[I"obj;T0;"@qW;#[ ;$I"3[MRI specific feature] Return all reachable objects from `obj'.
This method returns all reachable objects from `obj'.
If `obj' has two or more references to the same object `x', then returned
array only includes one `x' object.
If `obj' is a non-markable (non-heap management) object such as true,
false, nil, symbols and Fixnums (and Flonum) then it simply returns nil.
If `obj' has references to an internal object, then it returns instances of
ObjectSpace::InternalObjectWrapper class. This object contains a reference
to an internal object and you can check the type of internal object with
`type' method.
If `obj' is instance of ObjectSpace::InternalObjectWrapper class, then this
method returns all reachable object from an internal object, which is
pointed by `obj'.
With this method, you can find memory leaks.
This method is only expected to work except with C Ruby.
Example:
ObjectSpace.reachable_objects_from(['a', 'b', 'c'])
#=> [Array, 'a', 'b', 'c']
ObjectSpace.reachable_objects_from(['a', 'a', 'a'])
#=> [Array, 'a', 'a', 'a'] # all 'a' strings have different object id
ObjectSpace.reachable_objects_from([v = 'a', v, v])
#=> [Array, 'a']
ObjectSpace.reachable_objects_from(1)
#=> nil # 1 is not markable (heap managed) object
@overload reachable_objects_from(obj)
@return [Array, nil];T;%0;"@qW;&0;'F;.@V; I"static VALUE;T;/I"static VALUE
reachable_objects_from(VALUE self, VALUE obj)
{
if (rb_objspace_markable_object_p(obj)) {
VALUE ret = rb_ary_new();
struct rof_data data;
if (rb_typeddata_is_kind_of(obj, &iow_data_type)) {
obj = (VALUE)DATA_PTR(obj);
}
data.refs = st_init_numtable();
data.internals = rb_ary_new();
rb_objspace_reachable_objects_from(obj, reachable_object_from_i, &data);
st_foreach(data.refs, collect_values, (st_data_t)ret);
return ret;
}
else {
return Qnil;
}
};T;0To;
; T; ;S;;;I"'ObjectSpace.reachable_objects_from;F;@sW;@vW;T;;3;0;@xW;{ ;IC;"[MRI specific feature] Return all reachable objects from `obj'.
This method returns all reachable objects from `obj'.
If `obj' has two or more references to the same object `x', then returned
array only includes one `x' object.
If `obj' is a non-markable (non-heap management) object such as true,
false, nil, symbols and Fixnums (and Flonum) then it simply returns nil.
If `obj' has references to an internal object, then it returns instances of
ObjectSpace::InternalObjectWrapper class. This object contains a reference
to an internal object and you can check the type of internal object with
`type' method.
If `obj' is instance of ObjectSpace::InternalObjectWrapper class, then this
method returns all reachable object from an internal object, which is
pointed by `obj'.
With this method, you can find memory leaks.
This method is only expected to work except with C Ruby.
Example:
ObjectSpace.reachable_objects_from(['a', 'b', 'c'])
#=> [Array, 'a', 'b', 'c']
ObjectSpace.reachable_objects_from(['a', 'a', 'a'])
#=> [Array, 'a', 'a', 'a'] # all 'a' strings have different object id
ObjectSpace.reachable_objects_from([v = 'a', v, v])
#=> [Array, 'a']
ObjectSpace.reachable_objects_from(1)
#=> nil # 1 is not markable (heap managed) object;T;[o;
; I"
overload;F; 0;;3; 0; I" reachable_objects_from(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;TI"nil;T;"@W;#[ ;$I"@return [Array, nil];T;%0;"@W;&0;'F;(i ;[[I"obj;T0;"@W;#[ ;$I"5[MRI specific feature] Return all reachable objects from `obj'.
This method returns all reachable objects from `obj'.
If `obj' has two or more references to the same object `x', then returned
array only includes one `x' object.
If `obj' is a non-markable (non-heap management) object such as true,
false, nil, symbols and Fixnums (and Flonum) then it simply returns nil.
If `obj' has references to an internal object, then it returns instances of
ObjectSpace::InternalObjectWrapper class. This object contains a reference
to an internal object and you can check the type of internal object with
`type' method.
If `obj' is instance of ObjectSpace::InternalObjectWrapper class, then this
method returns all reachable object from an internal object, which is
pointed by `obj'.
With this method, you can find memory leaks.
This method is only expected to work except with C Ruby.
Example:
ObjectSpace.reachable_objects_from(['a', 'b', 'c'])
#=> [Array, 'a', 'b', 'c']
ObjectSpace.reachable_objects_from(['a', 'a', 'a'])
#=> [Array, 'a', 'a', 'a'] # all 'a' strings have different object id
ObjectSpace.reachable_objects_from([v = 'a', v, v])
#=> [Array, 'a']
ObjectSpace.reachable_objects_from(1)
#=> nil # 1 is not markable (heap managed) object
@overload reachable_objects_from(obj)
@return [Array, nil];T;%0;"@W;'F;(i ;)o;*;+T;,i;-i
;.@V; @W;/@W;0To;
; F; ;
;;K;I",ObjectSpace#reachable_objects_from_root;F;[ ;[[@
ViZ;T;: reachable_objects_from_root;0;[ ;{ ;IC;"C[MRI specific feature] Return all reachable objects from root.
;T;[o;
; I"
overload;F; 0;;4; 0; I" reachable_objects_from_root;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@W;#[ ;$I"@return [Hash];T;%0;"@W;&0;'F;(i ;[ ;"@W;#[ ;$I"{[MRI specific feature] Return all reachable objects from root.
@overload reachable_objects_from_root
@return [Hash];T;%0;"@W;&0;'F;.@V; I"static VALUE;T;/I"Gstatic VALUE
reachable_objects_from_root(VALUE self)
{
struct rofr_data data;
VALUE hash = data.categories = rb_ident_hash_new();
data.last_category = 0;
rb_objspace_reachable_objects_from_root(reachable_object_from_root_i, &data);
rb_hash_foreach(hash, collect_values_of_values, hash);
return hash;
};T;0To;
; T; ;S;;;I",ObjectSpace.reachable_objects_from_root;F;@W;@W;T;;4;0;@W;{ ;IC;"C[MRI specific feature] Return all reachable objects from root.;T;[o;
; I"
overload;F; 0;;4; 0; I" reachable_objects_from_root;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@W;#[ ;$I"@return [Hash];T;%0;"@W;&0;'F;(i ;[ ;"@W;#[ ;$I"|[MRI specific feature] Return all reachable objects from root.
@overload reachable_objects_from_root
@return [Hash];T;%0;"@W;'F;(i ;)o;*;+T;,iT;-iX;.@V; @W;/@W;0To;
; F; ;
;;K;I""ObjectSpace#internal_class_of;F;[[I"obj;T0;[[@
Vi~;T;:internal_class_of;0;[ ;{ ;IC;"[MRI specific feature] Return internal class of obj.
obj can be an instance of InternalObjectWrapper.
Note that you should not use this method in your application.
;T;[o;
; I"
overload;F; 0;;5; 0; I"internal_class_of(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Class;TI" Module;T;"@W;#[ ;$I" @return [Class, Module];T;%0;"@W;&0;'F;(i ;[[I"obj;T0;"@W;#[ ;$I"[MRI specific feature] Return internal class of obj.
obj can be an instance of InternalObjectWrapper.
Note that you should not use this method in your application.
@overload internal_class_of(obj)
@return [Class, Module];T;%0;"@W;&0;'F;.@V; I"static VALUE;T;/I"static VALUE
objspace_internal_class_of(VALUE self, VALUE obj)
{
VALUE klass;
if (rb_typeddata_is_kind_of(obj, &iow_data_type)) {
obj = (VALUE)DATA_PTR(obj);
}
klass = CLASS_OF(obj);
return wrap_klass_iow(klass);
};T;0To;
; T; ;S;;;I""ObjectSpace.internal_class_of;F;@W;@W;T;;5;0;@W;{ ;IC;"[MRI specific feature] Return internal class of obj.
obj can be an instance of InternalObjectWrapper.
Note that you should not use this method in your application.;T;[o;
; I"
overload;F; 0;;5; 0; I"internal_class_of(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Class;TI" Module;T;"@W;#[ ;$I" @return [Class, Module];T;%0;"@W;&0;'F;(i ;[[I"obj;T0;"@W;#[ ;$I"[MRI specific feature] Return internal class of obj.
obj can be an instance of InternalObjectWrapper.
Note that you should not use this method in your application.
@overload internal_class_of(obj)
@return [Class, Module];T;%0;"@W;'F;(i ;)o;*;+T;,iu;-i|;.@V; @W;/@W;0To;
; F; ;
;;K;I""ObjectSpace#internal_super_of;F;[[I"obj;T0;[[@
Vi;T;:internal_super_of;0;[ ;{ ;IC;"[MRI specific feature] Return internal super class of cls (Class or Module).
obj can be an instance of InternalObjectWrapper.
Note that you should not use this method in your application.
;T;[o;
; I"
overload;F; 0;;6; 0; I"internal_super_of(cls);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Class;TI" Module;T;"@X;#[ ;$I" @return [Class, Module];T;%0;"@X;&0;'F;(i ;[[I"cls;T0;"@X;#[ ;$I"[MRI specific feature] Return internal super class of cls (Class or Module).
obj can be an instance of InternalObjectWrapper.
Note that you should not use this method in your application.
@overload internal_super_of(cls)
@return [Class, Module];T;%0;"@X;&0;'F;.@V; I"static VALUE;T;/I"static VALUE
objspace_internal_super_of(VALUE self, VALUE obj)
{
VALUE super;
if (rb_typeddata_is_kind_of(obj, &iow_data_type)) {
obj = (VALUE)DATA_PTR(obj);
}
switch (TYPE(obj)) {
case T_MODULE:
case T_CLASS:
case T_ICLASS:
super = RCLASS_SUPER(obj);
break;
default:
rb_raise(rb_eArgError, "class or module is expected");
}
return wrap_klass_iow(super);
};T;0To;
; T; ;S;;;I""ObjectSpace.internal_super_of;F;@X;@X;T;;6;0;@X;{ ;IC;"[MRI specific feature] Return internal super class of cls (Class or Module).
obj can be an instance of InternalObjectWrapper.
Note that you should not use this method in your application.;T;[o;
; I"
overload;F; 0;;6; 0; I"internal_super_of(cls);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Class;TI" Module;T;"@-X;#[ ;$I" @return [Class, Module];T;%0;"@-X;&0;'F;(i ;[[I"cls;T0;"@-X;#[ ;$I"[MRI specific feature] Return internal super class of cls (Class or Module).
obj can be an instance of InternalObjectWrapper.
Note that you should not use this method in your application.
@overload internal_super_of(cls)
@return [Class, Module];T;%0;"@-X;'F;(i ;)o;*;+T;,i;-i;.@V; @+X;/@,X;0To; ;IC;[o;
; F; ;
;;;I",ObjectSpace::InternalObjectWrapper#type;F;[ ;[[@
Vi;T;: type;0;[ ;{ ;IC;"-Returns the type of the internal object.
;T;[ ;#[ ;$I"-Returns the type of the internal object.;T;%0;"@GX;'F;)o;*;+T;,i;-i;.@EX; I"static VALUE;T;/I"ystatic VALUE
iow_type(VALUE self)
{
VALUE obj = (VALUE)DATA_PTR(self);
return type2sym(BUILTIN_TYPE(obj));
};T;0To;
; F; ;
;;;I"/ObjectSpace::InternalObjectWrapper#inspect;F;[ ;[[@
Vi;T;;J;0;[ ;{ ;IC;"See Object#inspect.
;T;[ ;#[ ;$I"See Object#inspect.;T;%0;"@UX;'F;)o;*;+T;,i;-i;.@EX; I"static VALUE;T;/I"static VALUE
iow_inspect(VALUE self)
{
VALUE obj = (VALUE)DATA_PTR(self);
VALUE type = type2sym(BUILTIN_TYPE(obj));
return rb_sprintf("#", (void *)obj, rb_sym2str(type));
};T;0To;
; F; ;
;;;I":ObjectSpace::InternalObjectWrapper#internal_object_id;F;[ ;[[@
Vi;T;:internal_object_id;0;[ ;{ ;IC;"9Returns the Object#object_id of the internal object.
;T;[ ;#[ ;$I"9Returns the Object#object_id of the internal object.;T;%0;"@cX;'F;)o;*;+T;,i;-i;.@EX; I"static VALUE;T;/I"zstatic VALUE
iow_internal_object_id(VALUE self)
{
VALUE obj = (VALUE)DATA_PTR(self);
return rb_obj_id(obj);
};T;0T;N@EX;OIC;[ ;N@EX;PIC;[ ;N@EX;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@
Vi;F;:InternalObjectWrapper;;X;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@EX;(i ;.@V;I"'ObjectSpace::InternalObjectWrapper;F;Y@No;
; F; ;
;;K;I"ObjectSpace#dump;F;[[@0;[[I"!ext/objspace/objspace_dump.c;Ti;T;;j;0;[ ;{ ;IC;"Dump the contents of a ruby object as JSON.
This method is only expected to work with C Ruby.
This is an experimental method and is subject to change.
In particular, the function signature and output format are
not guaranteed to be compatible in future versions of ruby.
;T;[o;
; I"
overload;F; 0;;j; 0; I"#dump(obj[, output: :string]) #;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@X;&0;'F;(i ;[[I"obj[, output:;TI"
:string];T;"@Xo;
; I"
overload;F; 0;;j; 0; I"#dump(obj, output: :file) #;T;IC;" ;T;[o;!
; I" return;F; I"];T;0; [I"3#@return [#];T;%0;"@X;&0;'F;(i ;[[I"obj;T0[I" output:;TI"
:file;T;"@Xo;
; I"
overload;F; 0;;j; 0; I"#dump(obj, output: :stdout) #;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@X;#[ ;$I"@return [nil];T;%0;"@X;&0;'F;(i ;[[I"obj;T0[I" output:;TI" :stdout;T;"@X;#[ ;$I"Dump the contents of a ruby object as JSON.
This method is only expected to work with C Ruby.
This is an experimental method and is subject to change.
In particular, the function signature and output format are
not guaranteed to be compatible in future versions of ruby.
@overload dump(obj[, output: :string]) #
@overload dump(obj, output: :file) #
@return [#]
@overload dump(obj, output: :stdout) #
@return [nil];T;%0;"@X;&0;'F;.@V; I"static VALUE;T;/I"jstatic VALUE
objspace_dump(int argc, VALUE *argv, VALUE os)
{
static const char filename[] = "rubyobj";
VALUE obj = Qnil, opts = Qnil, output;
struct dump_config dc = {0,};
rb_scan_args(argc, argv, "1:", &obj, &opts);
output = dump_output(&dc, opts, sym_string, filename);
dump_object(obj, &dc);
return dump_result(&dc, output);
};T;0To;
; T; ;S;;;I"ObjectSpace.dump;F;@X;@X;T;;j;0;@X;{ ;IC;"Dump the contents of a ruby object as JSON.
This method is only expected to work with C Ruby.
This is an experimental method and is subject to change.
In particular, the function signature and output format are
not guaranteed to be compatible in future versions of ruby.;T;[o;
; I"
overload;F; 0;;j; 0; I"#dump(obj[, output: :string]) #;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@X;&0;'F;(i ;[[I"obj[, output:;TI"
:string];T;"@Xo;
; I"
overload;F; 0;;j; 0; I"#dump(obj, output: :file) #;T;IC;" ;T;[o;!
; I" return;F; I"];T;0; [I"3#@return [#];T;%0;"@X;&0;'F;(i ;[[I"obj;T0[I" output:;TI"
:file;T;"@Xo;
; I"
overload;F; 0;;j; 0; I"#dump(obj, output: :stdout) #;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@X;#[ ;$I"@return [nil];T;%0;"@X;&0;'F;(i ;[[I"obj;T0[I" output:;TI" :stdout;T;"@X;#[ ;$I"Dump the contents of a ruby object as JSON.
This method is only expected to work with C Ruby.
This is an experimental method and is subject to change.
In particular, the function signature and output format are
not guaranteed to be compatible in future versions of ruby.
@overload dump(obj[, output: :string]) #
@overload dump(obj, output: :file) #
@return [#]
@overload dump(obj, output: :stdout) #
@return [nil];T;%0;"@X;'F;(i ;)o;*;+T;,i;-i;.@V; @X;/@X;0To;
; F; ;
;;K;I"ObjectSpace#dump_all;F;[[@0;[[@Xi;T;:
dump_all;0;[ ;{ ;IC;"Dump the contents of the ruby heap as JSON.
This method is only expected to work with C Ruby.
This is an experimental method and is subject to change.
In particular, the function signature and output format are
not guaranteed to be compatible in future versions of ruby.
;T;[
o;
; I"
overload;F; 0;;:; 0; I" dump_all([output: :file]) #;T;IC;" ;T;[o;!
; I" return;F; I"];T;0; [I"3#@return [#];T;%0;"@X;&0;'F;(i ;[[I"
[output:;TI" :file];T;"@Xo;
; I"
overload;F; 0;;:; 0; I" dump_all(output: :stdout) #;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@X;#[ ;$I"@return [nil];T;%0;"@X;&0;'F;(i ;[[I" output:;TI" :stdout;T;"@Xo;
; I"
overload;F; 0;;:; 0; I" dump_all(output: :string) #;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@X;&0;'F;(i ;[[I" output:;TI" :string;T;"@Xo;
; I"
overload;F; 0;;:; 0; I"dump_all(output:;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@X;&0;'F;(i ;[[I" output:;TI" ;T;"@Xo;
; I"
overload;F; 0;;; 0; I"%open('heap.json','w')) #;T;IC;" ;T;[o;!
; I" return;F; I"];T;0; [I"#];T;%0;"@X;&0;'F;(i ;[["'heap.json'0["'w'0;"@X;#[ ;$I"6Dump the contents of the ruby heap as JSON.
This method is only expected to work with C Ruby.
This is an experimental method and is subject to change.
In particular, the function signature and output format are
not guaranteed to be compatible in future versions of ruby.
@overload dump_all([output: :file]) #
@return [#]
@overload dump_all(output: :stdout) #
@return [nil]
@overload dump_all(output: :string) #
@overload dump_all(output:
@overload open('heap.json','w')) #
@return [#];T;%0;"@X;&0;'F;.@V; I"static VALUE;T;/I"static VALUE
objspace_dump_all(int argc, VALUE *argv, VALUE os)
{
static const char filename[] = "rubyheap";
VALUE opts = Qnil, output;
struct dump_config dc = {0,};
rb_scan_args(argc, argv, "0:", &opts);
output = dump_output(&dc, opts, sym_file, filename);
/* dump roots */
rb_objspace_reachable_objects_from_root(root_obj_i, &dc);
if (dc.roots) dump_append(&dc, "]}\n");
/* dump all objects */
rb_objspace_each_objects(heap_i, &dc);
return dump_result(&dc, output);
};T;0To;
; T; ;S;;;I"ObjectSpace.dump_all;F;@X;@X;T;;:;0;@X;{ ;IC;"Dump the contents of the ruby heap as JSON.
This method is only expected to work with C Ruby.
This is an experimental method and is subject to change.
In particular, the function signature and output format are
not guaranteed to be compatible in future versions of ruby.;T;[
o;
; I"
overload;F; 0;;:; 0; I" dump_all([output: :file]) #;T;IC;" ;T;[o;!
; I" return;F; I"];T;0; [I"3#@return [#];T;%0;"@JY;&0;'F;(i ;[[I"
[output:;TI" :file];T;"@JYo;
; I"
overload;F; 0;;:; 0; I" dump_all(output: :stdout) #;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@JY;#[ ;$I"@return [nil];T;%0;"@JY;&0;'F;(i ;[[I" output:;TI" :stdout;T;"@JYo;
; I"
overload;F; 0;;:; 0; I" dump_all(output: :string) #;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@JY;&0;'F;(i ;[[I" output:;TI" :string;T;"@JYo;
; I"
overload;F; 0;;:; 0; I"dump_all(output:;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@JY;&0;'F;(i ;[[I" output:;TI" ;T;"@JYo;
; I"
overload;F; 0;;; 0; I"%open('heap.json','w')) #;T;IC;" ;T;[o;!
; I" return;F; I"];T;0; [I"#];T;%0;"@JY;&0;'F;(i ;[["'heap.json'0["'w'0;"@JY;#[ ;$I"3Dump the contents of the ruby heap as JSON.
This method is only expected to work with C Ruby.
This is an experimental method and is subject to change.
In particular, the function signature and output format are
not guaranteed to be compatible in future versions of ruby.
@overload dump_all([output: :file]) #
@return [#]
@overload dump_all(output: :stdout) #
@return [nil]
@overload dump_all(output: :string) #
@overload dump_all(output:
@overload open('heap.json','w')) #
@return [#];T;%0;"@JY;'F;(i ;)o;*;+T;,i;-i;.@V; @HY;/@IY;0To;
; F; ;
;;K;I")ObjectSpace#trace_object_allocations;F;[ ;[[I""ext/objspace/object_tracing.c;Ti ;T;: trace_object_allocations;0;[ ;{ ;IC;"7Starts tracing object allocations from the ObjectSpace extension module.
For example:
require 'objspace'
class C
include ObjectSpace
def foo
trace_object_allocations do
obj = Object.new
p "#{allocation_sourcefile(obj)}:#{allocation_sourceline(obj)}"
end
end
end
C.new.foo #=> "objtrace.rb:8"
This example has included the ObjectSpace module to make it easier to read,
but you can also use the ::trace_object_allocations notation (recommended).
Note that this feature introduces a huge performance decrease and huge
memory consumption.
;T;[o;
; I"
overload;F; 0;;;; 0; I" trace_object_allocations;T;IC;" ;T;[o;!
; I"
yield;F; I"[];T;0; 0;"@Y;#[ ;$I"@yield [];T;%0;"@Y;&0;'F;(i ;[ ;"@Y;#[ ;$I"gStarts tracing object allocations from the ObjectSpace extension module.
For example:
require 'objspace'
class C
include ObjectSpace
def foo
trace_object_allocations do
obj = Object.new
p "#{allocation_sourcefile(obj)}:#{allocation_sourceline(obj)}"
end
end
end
C.new.foo #=> "objtrace.rb:8"
This example has included the ObjectSpace module to make it easier to read,
but you can also use the ::trace_object_allocations notation (recommended).
Note that this feature introduces a huge performance decrease and huge
memory consumption.
@overload trace_object_allocations
@yield [];T;%0;"@Y;&0;'F;.@V; I"static VALUE;T;/I"static VALUE
trace_object_allocations(VALUE self)
{
trace_object_allocations_start(self);
return rb_ensure(rb_yield, Qnil, trace_object_allocations_stop, self);
};T;0To;
; T; ;S;;;I")ObjectSpace.trace_object_allocations;F;@Y;@Y;T;;;;0;@Y;{ ;IC;"7Starts tracing object allocations from the ObjectSpace extension module.
For example:
require 'objspace'
class C
include ObjectSpace
def foo
trace_object_allocations do
obj = Object.new
p "#{allocation_sourcefile(obj)}:#{allocation_sourceline(obj)}"
end
end
end
C.new.foo #=> "objtrace.rb:8"
This example has included the ObjectSpace module to make it easier to read,
but you can also use the ::trace_object_allocations notation (recommended).
Note that this feature introduces a huge performance decrease and huge
memory consumption.;T;[o;
; I"
overload;F; 0;;;; 0; I" trace_object_allocations;T;IC;" ;T;[o;!
; I"
yield;F; I"[];T;0; 0;"@Y;#[ ;$I"@yield [];T;%0;"@Y;&0;'F;(i ;[ ;"@Y;#[ ;$I"hStarts tracing object allocations from the ObjectSpace extension module.
For example:
require 'objspace'
class C
include ObjectSpace
def foo
trace_object_allocations do
obj = Object.new
p "#{allocation_sourcefile(obj)}:#{allocation_sourceline(obj)}"
end
end
end
C.new.foo #=> "objtrace.rb:8"
This example has included the ObjectSpace module to make it easier to read,
but you can also use the ::trace_object_allocations notation (recommended).
Note that this feature introduces a huge performance decrease and huge
memory consumption.
@overload trace_object_allocations
@yield [];T;%0;"@Y;'F;(i ;)o;*;+T;,i;-i ;.@V; @Y;/@Y;0To;
; F; ;
;;K;I"/ObjectSpace#trace_object_allocations_start;F;[ ;[[@Yi;T;:#trace_object_allocations_start;0;[ ;{ ;IC;"'Starts tracing object allocations.
;T;[o;
; I"
overload;F; 0;;<; 0; I"#trace_object_allocations_start;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@Y;&0;'F;(i ;[ ;"@Y;#[ ;$I"QStarts tracing object allocations.
@overload trace_object_allocations_start
;T;%0;"@Y;&0;'F;.@V; I"static VALUE;T;/I"static VALUE
trace_object_allocations_start(VALUE self)
{
struct traceobj_arg *arg = get_traceobj_arg();
if (arg->running++ > 0) {
/* do nothing */
}
else {
if (arg->newobj_trace == 0) {
arg->newobj_trace = rb_tracepoint_new(0, RUBY_INTERNAL_EVENT_NEWOBJ, newobj_i, arg);
arg->freeobj_trace = rb_tracepoint_new(0, RUBY_INTERNAL_EVENT_FREEOBJ, freeobj_i, arg);
}
rb_tracepoint_enable(arg->newobj_trace);
rb_tracepoint_enable(arg->freeobj_trace);
}
return Qnil;
};T;0To;
; T; ;S;;;I"/ObjectSpace.trace_object_allocations_start;F;@Y;@Y;T;;<;0;@Y;{ ;IC;"'Starts tracing object allocations.;T;[o;
; I"
overload;F; 0;;<; 0; I"#trace_object_allocations_start;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@Y;&0;'F;(i ;[ ;"@Y;#[ ;$I"SStarts tracing object allocations.
@overload trace_object_allocations_start;T;%0;"@Y;'F;(i ;)o;*;+T;,i;-i;.@V; @Y;/@Y;0To;
; F; ;
;;K;I".ObjectSpace#trace_object_allocations_stop;F;[ ;[[@Yi;T;:"trace_object_allocations_stop;0;[ ;{ ;IC;"Stop tracing object allocations.
Note that if ::trace_object_allocations_start is called n-times, then
tracing will stop after calling ::trace_object_allocations_stop n-times.
;T;[o;
; I"
overload;F; 0;;=; 0; I""trace_object_allocations_stop;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@Y;&0;'F;(i ;[ ;"@Y;#[ ;$I"Stop tracing object allocations.
Note that if ::trace_object_allocations_start is called n-times, then
tracing will stop after calling ::trace_object_allocations_stop n-times.
@overload trace_object_allocations_stop
;T;%0;"@Y;&0;'F;.@V; I"static VALUE;T;/I"_static VALUE
trace_object_allocations_stop(VALUE self)
{
struct traceobj_arg *arg = get_traceobj_arg();
if (arg->running > 0) {
arg->running--;
}
if (arg->running == 0) {
rb_tracepoint_disable(arg->newobj_trace);
rb_tracepoint_disable(arg->freeobj_trace);
arg->newobj_trace = 0;
arg->freeobj_trace = 0;
}
return Qnil;
};T;0To;
; T; ;S;;;I".ObjectSpace.trace_object_allocations_stop;F;@Y;@Y;T;;=;0;@Y;{ ;IC;"Stop tracing object allocations.
Note that if ::trace_object_allocations_start is called n-times, then
tracing will stop after calling ::trace_object_allocations_stop n-times.;T;[o;
; I"
overload;F; 0;;=; 0; I""trace_object_allocations_stop;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@Y;&0;'F;(i ;[ ;"@Y;#[ ;$I"Stop tracing object allocations.
Note that if ::trace_object_allocations_start is called n-times, then
tracing will stop after calling ::trace_object_allocations_stop n-times.
@overload trace_object_allocations_stop;T;%0;"@Y;'F;(i ;)o;*;+T;,i;-i;.@V; @Y;/@Y;0To;
; F; ;
;;K;I"/ObjectSpace#trace_object_allocations_clear;F;[ ;[[@Yi;T;:#trace_object_allocations_clear;0;[ ;{ ;IC;"(Clear recorded tracing information.
;T;[o;
; I"
overload;F; 0;;>; 0; I"#trace_object_allocations_clear;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@Z;&0;'F;(i ;[ ;"@Z;#[ ;$I"RClear recorded tracing information.
@overload trace_object_allocations_clear
;T;%0;"@Z;&0;'F;.@V; I"static VALUE;T;/I"`static VALUE
trace_object_allocations_clear(VALUE self)
{
struct traceobj_arg *arg = get_traceobj_arg();
/* clear tables */
st_foreach(arg->object_table, free_values_i, 0);
st_clear(arg->object_table);
st_foreach(arg->str_table, free_keys_i, 0);
st_clear(arg->str_table);
/* do not touch TracePoints */
return Qnil;
};T;0To;
; T; ;S;;;I"/ObjectSpace.trace_object_allocations_clear;F;@Z;@Z;T;;>;0;@Z;{ ;IC;"(Clear recorded tracing information.;T;[o;
; I"
overload;F; 0;;>; 0; I"#trace_object_allocations_clear;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@$Z;&0;'F;(i ;[ ;"@$Z;#[ ;$I"TClear recorded tracing information.
@overload trace_object_allocations_clear;T;%0;"@$Z;'F;(i ;)o;*;+T;,i;-i;.@V; @"Z;/@#Z;0To;
; F; ;
;;K;I"5ObjectSpace#trace_object_allocations_debug_start;F;[ ;[[@Yi4;T;:)trace_object_allocations_debug_start;0;[ ;{ ;IC;"
;T;[ ;#[ ;$I" ;F;%0;"@4Z;&0;'F;.@V; I"static VALUE;T;/I"-static VALUE
trace_object_allocations_debug_start(VALUE self)
{
tmp_keep_remains = 1;
if (object_allocations_reporter_registered == 0) {
object_allocations_reporter_registered = 1;
rb_bug_reporter_add(object_allocations_reporter, 0);
}
return trace_object_allocations_start(self);
};T;0To;
; T; ;S;;;I"5ObjectSpace.trace_object_allocations_debug_start;F;@6Z;@7Z;T;;?;0;@9Z;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@AZ;(i ;.@V; @?Z;/@@Z;0To;
; F; ;
;;K;I"&ObjectSpace#allocation_sourcefile;F;[[I"obj;T0;[[@YiY;T;:allocation_sourcefile;0;[ ;{ ;IC;"Returns the source file origin from the given +object+.
See ::trace_object_allocations for more information and examples.
;T;[o;
; I"
overload;F; 0;;@; 0; I""allocation_sourcefile(object);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@GZ;#[ ;$I"@return [String];T;%0;"@GZ;&0;'F;(i ;[[I" object;T0;"@GZ;#[ ;$I"Returns the source file origin from the given +object+.
See ::trace_object_allocations for more information and examples.
@overload allocation_sourcefile(object)
@return [String];T;%0;"@GZ;&0;'F;.@V; I"static VALUE;T;/I"static VALUE
allocation_sourcefile(VALUE self, VALUE obj)
{
struct allocation_info *info = lookup_allocation_info(obj);
if (info && info->path) {
return rb_str_new2(info->path);
}
else {
return Qnil;
}
};T;0To;
; T; ;S;;;I"&ObjectSpace.allocation_sourcefile;F;@IZ;@LZ;T;;@;0;@NZ;{ ;IC;"Returns the source file origin from the given +object+.
See ::trace_object_allocations for more information and examples.;T;[o;
; I"
overload;F; 0;;@; 0; I""allocation_sourcefile(object);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@eZ;#[ ;$I"@return [String];T;%0;"@eZ;&0;'F;(i ;[[I" object;T0;"@eZ;#[ ;$I"Returns the source file origin from the given +object+.
See ::trace_object_allocations for more information and examples.
@overload allocation_sourcefile(object)
@return [String];T;%0;"@eZ;'F;(i ;)o;*;+T;,iR;-iX;.@V; @cZ;/@dZ;0To;
; F; ;
;;K;I"&ObjectSpace#allocation_sourceline;F;[[I"obj;T0;[[@Yim;T;:allocation_sourceline;0;[ ;{ ;IC;"Returns the original line from source for from the given +object+.
See ::trace_object_allocations for more information and examples.
;T;[o;
; I"
overload;F; 0;;A; 0; I""allocation_sourceline(object);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@|Z;#[ ;$I"@return [String];T;%0;"@|Z;&0;'F;(i ;[[I" object;T0;"@|Z;#[ ;$I"Returns the original line from source for from the given +object+.
See ::trace_object_allocations for more information and examples.
@overload allocation_sourceline(object)
@return [String];T;%0;"@|Z;&0;'F;.@V; I"static VALUE;T;/I"static VALUE
allocation_sourceline(VALUE self, VALUE obj)
{
struct allocation_info *info = lookup_allocation_info(obj);
if (info) {
return INT2FIX(info->line);
}
else {
return Qnil;
}
};T;0To;
; T; ;S;;;I"&ObjectSpace.allocation_sourceline;F;@~Z;@Z;T;;A;0;@Z;{ ;IC;"Returns the original line from source for from the given +object+.
See ::trace_object_allocations for more information and examples.;T;[o;
; I"
overload;F; 0;;A; 0; I""allocation_sourceline(object);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@Z;#[ ;$I"@return [String];T;%0;"@Z;&0;'F;(i ;[[I" object;T0;"@Z;#[ ;$I"Returns the original line from source for from the given +object+.
See ::trace_object_allocations for more information and examples.
@overload allocation_sourceline(object)
@return [String];T;%0;"@Z;'F;(i ;)o;*;+T;,if;-il;.@V; @Z;/@Z;0To;
; F; ;
;;K;I"&ObjectSpace#allocation_class_path;F;[[I"obj;T0;[[@Yi;T;:allocation_class_path;0;[ ;{ ;IC;"!Returns the class for the given +object+.
class A
def foo
ObjectSpace::trace_object_allocations do
obj = Object.new
p "#{ObjectSpace::allocation_class_path(obj)}"
end
end
end
A.new.foo #=> "Class"
See ::trace_object_allocations for more information and examples.
;T;[o;
; I"
overload;F; 0;;B; 0; I""allocation_class_path(object);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@Z;#[ ;$I"@return [String];T;%0;"@Z;&0;'F;(i ;[[I" object;T0;"@Z;#[ ;$I"]Returns the class for the given +object+.
class A
def foo
ObjectSpace::trace_object_allocations do
obj = Object.new
p "#{ObjectSpace::allocation_class_path(obj)}"
end
end
end
A.new.foo #=> "Class"
See ::trace_object_allocations for more information and examples.
@overload allocation_class_path(object)
@return [String];T;%0;"@Z;&0;'F;.@V; I"static VALUE;T;/I"static VALUE
allocation_class_path(VALUE self, VALUE obj)
{
struct allocation_info *info = lookup_allocation_info(obj);
if (info && info->class_path) {
return rb_str_new2(info->class_path);
}
else {
return Qnil;
}
};T;0To;
; T; ;S;;;I"&ObjectSpace.allocation_class_path;F;@Z;@Z;T;;B;0;@Z;{ ;IC;"!Returns the class for the given +object+.
class A
def foo
ObjectSpace::trace_object_allocations do
obj = Object.new
p "#{ObjectSpace::allocation_class_path(obj)}"
end
end
end
A.new.foo #=> "Class"
See ::trace_object_allocations for more information and examples.;T;[o;
; I"
overload;F; 0;;B; 0; I""allocation_class_path(object);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@Z;#[ ;$I"@return [String];T;%0;"@Z;&0;'F;(i ;[[I" object;T0;"@Z;#[ ;$I"^Returns the class for the given +object+.
class A
def foo
ObjectSpace::trace_object_allocations do
obj = Object.new
p "#{ObjectSpace::allocation_class_path(obj)}"
end
end
end
A.new.foo #=> "Class"
See ::trace_object_allocations for more information and examples.
@overload allocation_class_path(object)
@return [String];T;%0;"@Z;'F;(i ;)o;*;+T;,iz;-i;.@V; @Z;/@Z;0To;
; F; ;
;;K;I"%ObjectSpace#allocation_method_id;F;[[I"obj;T0;[[@Yi;T;:allocation_method_id;0;[ ;{ ;IC;"KReturns the method identifier for the given +object+.
class A
include ObjectSpace
def foo
trace_object_allocations do
obj = Object.new
p "#{allocation_class_path(obj)}##{allocation_method_id(obj)}"
end
end
end
A.new.foo #=> "Class#new"
See ::trace_object_allocations for more information and examples.
;T;[o;
; I"
overload;F; 0;;C; 0; I"!allocation_method_id(object);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@Z;#[ ;$I"@return [String];T;%0;"@Z;&0;'F;(i ;[[I" object;T0;"@Z;#[ ;$I"Returns the method identifier for the given +object+.
class A
include ObjectSpace
def foo
trace_object_allocations do
obj = Object.new
p "#{allocation_class_path(obj)}##{allocation_method_id(obj)}"
end
end
end
A.new.foo #=> "Class#new"
See ::trace_object_allocations for more information and examples.
@overload allocation_method_id(object)
@return [String];T;%0;"@Z;&0;'F;.@V; I"static VALUE;T;/I"static VALUE
allocation_method_id(VALUE self, VALUE obj)
{
struct allocation_info *info = lookup_allocation_info(obj);
if (info) {
return info->mid;
}
else {
return Qnil;
}
};T;0To;
; T; ;S;;;I"%ObjectSpace.allocation_method_id;F;@Z;@Z;T;;C;0;@Z;{ ;IC;"KReturns the method identifier for the given +object+.
class A
include ObjectSpace
def foo
trace_object_allocations do
obj = Object.new
p "#{allocation_class_path(obj)}##{allocation_method_id(obj)}"
end
end
end
A.new.foo #=> "Class#new"
See ::trace_object_allocations for more information and examples.;T;[o;
; I"
overload;F; 0;;C; 0; I"!allocation_method_id(object);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@[;#[ ;$I"@return [String];T;%0;"@[;&0;'F;(i ;[[I" object;T0;"@[;#[ ;$I"Returns the method identifier for the given +object+.
class A
include ObjectSpace
def foo
trace_object_allocations do
obj = Object.new
p "#{allocation_class_path(obj)}##{allocation_method_id(obj)}"
end
end
end
A.new.foo #=> "Class#new"
See ::trace_object_allocations for more information and examples.
@overload allocation_method_id(object)
@return [String];T;%0;"@[;'F;(i ;)o;*;+T;,i;-i;.@V; @[;/@[;0To;
; F; ;
;;K;I"&ObjectSpace#allocation_generation;F;[[I"obj;T0;[[@Yi;T;:allocation_generation;0;[ ;{ ;IC;"IReturns garbage collector generation for the given +object+.
class B
include ObjectSpace
def foo
trace_object_allocations do
obj = Object.new
p "Generation is #{allocation_generation(obj)}"
end
end
end
B.new.foo #=> "Generation is 3"
See ::trace_object_allocations for more information and examples.
;T;[o;
; I"
overload;F; 0;;D; 0; I""allocation_generation(object);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;T;"@[;#[ ;$I"@return [Fixnum];T;%0;"@[;&0;'F;(i ;[[I" object;T0;"@[;#[ ;$I"Returns garbage collector generation for the given +object+.
class B
include ObjectSpace
def foo
trace_object_allocations do
obj = Object.new
p "Generation is #{allocation_generation(obj)}"
end
end
end
B.new.foo #=> "Generation is 3"
See ::trace_object_allocations for more information and examples.
@overload allocation_generation(object)
@return [Fixnum];T;%0;"@[;&0;'F;.@V; I"static VALUE;T;/I"static VALUE
allocation_generation(VALUE self, VALUE obj)
{
struct allocation_info *info = lookup_allocation_info(obj);
if (info) {
return SIZET2NUM(info->generation);
}
else {
return Qnil;
}
};T;0To;
; T; ;S;;;I"&ObjectSpace.allocation_generation;F;@ [;@ [;T;;D;0;@"[;{ ;IC;"IReturns garbage collector generation for the given +object+.
class B
include ObjectSpace
def foo
trace_object_allocations do
obj = Object.new
p "Generation is #{allocation_generation(obj)}"
end
end
end
B.new.foo #=> "Generation is 3"
See ::trace_object_allocations for more information and examples.;T;[o;
; I"
overload;F; 0;;D; 0; I""allocation_generation(object);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;T;"@9[;#[ ;$I"@return [Fixnum];T;%0;"@9[;&0;'F;(i ;[[I" object;T0;"@9[;#[ ;$I"Returns garbage collector generation for the given +object+.
class B
include ObjectSpace
def foo
trace_object_allocations do
obj = Object.new
p "Generation is #{allocation_generation(obj)}"
end
end
end
B.new.foo #=> "Generation is 3"
See ::trace_object_allocations for more information and examples.
@overload allocation_generation(object)
@return [Fixnum];T;%0;"@9[;'F;(i ;)o;*;+T;,i;-i;.@V; @7[;/@8[;0To; ;IC;[o;
; F; ;
;;;I" ObjectSpace::WeakMap#[]=;F;[[I" wmap;T0[I" orig;T0;[[@[
i& ;T;;X;0;[ ;{ ;IC;"CCreates a weak reference from the given key to the given value
;T;[ ;#[ ;$I"CCreates a weak reference from the given key to the given value;T;%0;"@R[;'F;)o;*;+T;,i% ;-i% ;.@P[; I"static VALUE;T;/I"static VALUE
wmap_aset(VALUE self, VALUE wmap, VALUE orig)
{
struct weakmap *w;
TypedData_Get_Struct(self, struct weakmap, &weakmap_type, w);
should_be_finalizable(orig);
should_be_finalizable(wmap);
define_final0(orig, w->final);
define_final0(wmap, w->final);
st_update(w->obj2wmap, (st_data_t)orig, wmap_aset_update, wmap);
st_insert(w->wmap2obj, (st_data_t)wmap, (st_data_t)orig);
return nonspecial_obj_id(orig);
};T;0To;
; F; ;
;;;I" ObjectSpace::WeakMap#[];F;[[I" wmap;T0;[[@[
i6 ;T;;V;0;[ ;{ ;IC;"wmap2obj, (st_data_t)wmap, &data)) return Qnil;
obj = (VALUE)data;
if (!is_id_value(objspace, obj)) return Qnil;
if (!is_live_object(objspace, obj)) return Qnil;
return obj;
};T;0To;
; F; ;
;;;I""ObjectSpace::WeakMap#include?;F;[[I"key;T0;[[@[
iG ;T;;;0;[ ;{ ;IC;"*Returns +true+ if +key+ is registered
;T;[o;!
; I" return;F; @;0; [@;"@t[;#[ ;$I"*Returns +true+ if +key+ is registered;T;%0;"@t[;'F;)o;*;+T;,iF ;-iF ;.@P[; I"static VALUE;T;/I"rstatic VALUE
wmap_has_key(VALUE self, VALUE key)
{
return NIL_P(wmap_aref(self, key)) ? Qfalse : Qtrue;
};T;0To;
; F; ;
;;;I"!ObjectSpace::WeakMap#member?;F;[[I"key;T0;[[@[
iG ;T;;;0;[ ;{ ;IC;"*Returns +true+ if +key+ is registered
;T;[o;!
; I" return;F; @;0; [@;"@[;#[ ;$@[;%0;"@[;'F;)o;*;+T;,iF ;-iF ;.@P[; I"static VALUE;T;/I"rstatic VALUE
wmap_has_key(VALUE self, VALUE key)
{
return NIL_P(wmap_aref(self, key)) ? Qfalse : Qtrue;
};T;0To;
; F; ;
;;;I" ObjectSpace::WeakMap#key?;F;[[I"key;T0;[[@[
iG ;T;;;0;[ ;{ ;IC;"*Returns +true+ if +key+ is registered
;T;[o;!
; I" return;F; @;0; [@;"@[;#[ ;$@[;%0;"@[;'F;)o;*;+T;,iF ;-iF ;.@P[; I"static VALUE;T;/I"rstatic VALUE
wmap_has_key(VALUE self, VALUE key)
{
return NIL_P(wmap_aref(self, key)) ? Qfalse : Qtrue;
};T;0To;
; F; ;
;;;I"!ObjectSpace::WeakMap#inspect;F;[ ;[[@[
i ;T;;J;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@[;.@P[; I"static VALUE;T;/I"static VALUE
wmap_inspect(VALUE self)
{
VALUE str;
VALUE c = rb_class_name(CLASS_OF(self));
struct weakmap *w;
TypedData_Get_Struct(self, struct weakmap, &weakmap_type, w);
str = rb_sprintf("-<%"PRIsVALUE":%p", c, (void *)self);
if (w->wmap2obj) {
st_foreach(w->wmap2obj, wmap_inspect_i, str);
}
RSTRING_PTR(str)[0] = '#';
rb_str_cat2(str, ">");
return str;
};T;0To;
; F; ;
;;;I" ObjectSpace::WeakMap#each;F;[ ;[[@[
i ;T;;;0;[ ;{ ;IC;"AIterates over keys and objects in a weakly referenced object
;T;[ ;#[ ;$I"AIterates over keys and objects in a weakly referenced object;T;%0;"@[;'F;)o;*;+T;,i ;-i ;.@P[; I"static VALUE;T;/I"static VALUE
wmap_each(VALUE self)
{
struct weakmap *w;
rb_objspace_t *objspace = &rb_objspace;
TypedData_Get_Struct(self, struct weakmap, &weakmap_type, w);
st_foreach(w->wmap2obj, wmap_each_i, (st_data_t)objspace);
return self;
};T;0To;
; F; ;
;;;I"#ObjectSpace::WeakMap#each_pair;F;[ ;[[@[
i ;T;;;0;[ ;{ ;IC;"AIterates over keys and objects in a weakly referenced object
;T;[ ;#[ ;$@[;%0;"@[;'F;)o;*;+T;,i ;-i ;.@P[; I"static VALUE;T;/I"static VALUE
wmap_each(VALUE self)
{
struct weakmap *w;
rb_objspace_t *objspace = &rb_objspace;
TypedData_Get_Struct(self, struct weakmap, &weakmap_type, w);
st_foreach(w->wmap2obj, wmap_each_i, (st_data_t)objspace);
return self;
};T;0To;
; F; ;
;;;I""ObjectSpace::WeakMap#each_key;F;[ ;[[@[
i ;T;;;0;[ ;{ ;IC;"AIterates over keys and objects in a weakly referenced object
;T;[ ;#[ ;$I"AIterates over keys and objects in a weakly referenced object;T;%0;"@[;'F;)o;*;+T;,i ;-i ;.@P[; I"static VALUE;T;/I"static VALUE
wmap_each_key(VALUE self)
{
struct weakmap *w;
rb_objspace_t *objspace = &rb_objspace;
TypedData_Get_Struct(self, struct weakmap, &weakmap_type, w);
st_foreach(w->wmap2obj, wmap_each_key_i, (st_data_t)objspace);
return self;
};T;0To;
; F; ;
;;;I"$ObjectSpace::WeakMap#each_value;F;[ ;[[@[
i ;T;;;0;[ ;{ ;IC;"AIterates over keys and objects in a weakly referenced object
;T;[ ;#[ ;$I"AIterates over keys and objects in a weakly referenced object;T;%0;"@[;'F;)o;*;+T;,i ;-i ;.@P[; I"static VALUE;T;/I"static VALUE
wmap_each_value(VALUE self)
{
struct weakmap *w;
rb_objspace_t *objspace = &rb_objspace;
TypedData_Get_Struct(self, struct weakmap, &weakmap_type, w);
st_foreach(w->wmap2obj, wmap_each_value_i, (st_data_t)objspace);
return self;
};T;0To;
; F; ;
;;;I" ObjectSpace::WeakMap#keys;F;[ ;[[@[
i ;T;;;0;[ ;{ ;IC;"AIterates over keys and objects in a weakly referenced object
;T;[ ;#[ ;$I"AIterates over keys and objects in a weakly referenced object;T;%0;"@[;'F;)o;*;+T;,i ;-i ;.@P[; I"static VALUE;T;/I"3static VALUE
wmap_keys(VALUE self)
{
struct weakmap *w;
struct wmap_iter_arg args;
TypedData_Get_Struct(self, struct weakmap, &weakmap_type, w);
args.objspace = &rb_objspace;
args.value = rb_ary_new();
st_foreach(w->wmap2obj, wmap_keys_i, (st_data_t)&args);
return args.value;
};T;0To;
; F; ;
;;;I" ObjectSpace::WeakMap#values;F;[ ;[[@[
i ;T;;;0;[ ;{ ;IC;"CIterates over values and objects in a weakly referenced object
;T;[ ;#[ ;$I"CIterates over values and objects in a weakly referenced object;T;%0;"@[;'F;)o;*;+T;,i ;-i ;.@P[; I"static VALUE;T;/I"7static VALUE
wmap_values(VALUE self)
{
struct weakmap *w;
struct wmap_iter_arg args;
TypedData_Get_Struct(self, struct weakmap, &weakmap_type, w);
args.objspace = &rb_objspace;
args.value = rb_ary_new();
st_foreach(w->wmap2obj, wmap_values_i, (st_data_t)&args);
return args.value;
};T;0To;
; F; ;
;;;I" ObjectSpace::WeakMap#size;F;[ ;[[@[
iM ;T;;[;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@
\;.@P[; I"static VALUE;T;/I"static VALUE
wmap_size(VALUE self)
{
struct weakmap *w;
st_index_t n;
TypedData_Get_Struct(self, struct weakmap, &weakmap_type, w);
n = w->wmap2obj->num_entries;
#if SIZEOF_ST_INDEX_T <= SIZEOF_LONG
return ULONG2NUM(n);
#else
return ULL2NUM(n);
#endif
};T;0To;
; F; ;
;;;I" ObjectSpace::WeakMap#length;F;[ ;[[@[
iM ;T;;Z;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@\;.@P[; I"static VALUE;T;/I"static VALUE
wmap_size(VALUE self)
{
struct weakmap *w;
st_index_t n;
TypedData_Get_Struct(self, struct weakmap, &weakmap_type, w);
n = w->wmap2obj->num_entries;
#if SIZEOF_ST_INDEX_T <= SIZEOF_LONG
return ULONG2NUM(n);
#else
return ULL2NUM(n);
#endif
};T;0To;
; F; ;
;;K;I""ObjectSpace::WeakMap#finalize;F;[[I"
objid;T0;[[@[
iH ;T;:
finalize;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@"\;.@P[; I"static VALUE;T;/I"/static VALUE
wmap_finalize(VALUE self, VALUE objid)
{
st_data_t orig, wmap, data;
VALUE obj, *rids, i, size;
struct weakmap *w;
TypedData_Get_Struct(self, struct weakmap, &weakmap_type, w);
/* Get reference from object id. */
obj = obj_id_to_ref(objid);
/* obj is original referenced object and/or weak reference. */
orig = (st_data_t)obj;
if (st_delete(w->obj2wmap, &orig, &data)) {
rids = (VALUE *)data;
size = *rids++;
for (i = 0; i < size; ++i) {
wmap = (st_data_t)rids[i];
st_delete(w->wmap2obj, &wmap, NULL);
}
ruby_sized_xfree((VALUE *)data, (size + 1) * sizeof(VALUE));
}
wmap = (st_data_t)obj;
if (st_delete(w->wmap2obj, &wmap, &orig)) {
wmap = (st_data_t)obj;
st_update(w->obj2wmap, orig, wmap_final_func, wmap);
}
return self;
};T;0T;N@P[;OIC;[ ;N@P[;PIC;[@G;N@P[;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@[
i$[@[
iw$;T;: WeakMap;;X;;;[ ;{ ;IC;"An ObjectSpace::WeakMap object holds references to
any objects, but those objects can get garbage collected.
This class is mostly used internally by WeakRef, please use
+lib/weakref.rb+ for the public interface.;T;[ ;#[ ;$I"
An ObjectSpace::WeakMap object holds references to
any objects, but those objects can get garbage collected.
This class is mostly used internally by WeakRef, please use
+lib/weakref.rb+ for the public interface.
;T;%0;"@P[;'F;(i ;)o;*;+T;,i$;-i $;.o;Z ;[0;\0;]0;:ObjectSpace;.@;_@V;0;I"ObjectSpace::WeakMap;F;Y@No;
; F; ;
;;K;I" ObjectSpace#each_object;F;[[@0;[[@[
i ;T;:each_object;0;[ ;{ ;IC;"Calls the block once for each living, nonimmediate object in this
Ruby process. If module is specified, calls the block
for only those classes or modules that match (or are a subclass of)
module. Returns the number of objects found. Immediate
objects (Fixnums, Symbols
true, false, and nil) are
never returned. In the example below, each_object
returns both the numbers we defined and several constants defined in
the Math module.
If no block is given, an enumerator is returned instead.
a = 102.7
b = 95 # Won't be returned
c = 12345678987654321
count = ObjectSpace.each_object(Numeric) {|x| p x }
puts "Total count: #{count}"
produces:
12345678987654321
102.7
2.71828182845905
3.14159265358979
2.22044604925031e-16
1.7976931348623157e+308
2.2250738585072e-308
Total count: 7
;T;[o;
; I"
overload;F; 0;;H; 0; I"each_object([module]);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@C\o;!
; I" return;F; I" ;T;0; [I" Fixnum;T;"@C\;#[ ;$I""@yield [obj]
@return [Fixnum];T;%0;"@C\;&0;'F;(i ;[[I"[;T0;"@C\o;
; I"
overload;F; 0;;H; 0; I"each_object([module]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@C\;&0;'F;(i ;[[I"[;T0;"@C\;#[ ;$I"Calls the block once for each living, nonimmediate object in this
Ruby process. If module is specified, calls the block
for only those classes or modules that match (or are a subclass of)
module. Returns the number of objects found. Immediate
objects (Fixnums, Symbols
true, false, and nil) are
never returned. In the example below, each_object
returns both the numbers we defined and several constants defined in
the Math module.
If no block is given, an enumerator is returned instead.
a = 102.7
b = 95 # Won't be returned
c = 12345678987654321
count = ObjectSpace.each_object(Numeric) {|x| p x }
puts "Total count: #{count}"
produces:
12345678987654321
102.7
2.71828182845905
3.14159265358979
2.22044604925031e-16
1.7976931348623157e+308
2.2250738585072e-308
Total count: 7
@overload each_object([module])
@yield [obj]
@return [Fixnum]
@overload each_object([module])
;T;%0;"@C\;&0;'F;.@V; I"static VALUE;T;/I"static VALUE
os_each_obj(int argc, VALUE *argv, VALUE os)
{
VALUE of;
if (argc == 0) {
of = 0;
}
else {
rb_scan_args(argc, argv, "01", &of);
}
RETURN_ENUMERATOR(os, 1, &of);
return os_obj_of(of);
};T;0To;
; T; ;S;;;I" ObjectSpace.each_object;F;@E\;@G\;T;;H;0;@I\;{ ;IC;"Calls the block once for each living, nonimmediate object in this
Ruby process. If module is specified, calls the block
for only those classes or modules that match (or are a subclass of)
module. Returns the number of objects found. Immediate
objects (Fixnums, Symbols
true, false, and nil) are
never returned. In the example below, each_object
returns both the numbers we defined and several constants defined in
the Math module.
If no block is given, an enumerator is returned instead.
a = 102.7
b = 95 # Won't be returned
c = 12345678987654321
count = ObjectSpace.each_object(Numeric) {|x| p x }
puts "Total count: #{count}"
produces:
12345678987654321
102.7
2.71828182845905
3.14159265358979
2.22044604925031e-16
1.7976931348623157e+308
2.2250738585072e-308
Total count: 7;T;[o;
; I"
overload;F; 0;;H; 0; I"each_object([module]);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"obj;T;"@o\o;!
; I" return;F; I" ;T;0; [I" Fixnum;T;"@o\;#[ ;$I""@yield [obj]
@return [Fixnum];T;%0;"@o\;&0;'F;(i ;[[I"[;T0;"@o\o;
; I"
overload;F; 0;;H; 0; I"each_object([module]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@o\;&0;'F;(i ;[[I"[;T0;"@o\;#[ ;$I"Calls the block once for each living, nonimmediate object in this
Ruby process. If module is specified, calls the block
for only those classes or modules that match (or are a subclass of)
module. Returns the number of objects found. Immediate
objects (Fixnums, Symbols
true, false, and nil) are
never returned. In the example below, each_object
returns both the numbers we defined and several constants defined in
the Math module.
If no block is given, an enumerator is returned instead.
a = 102.7
b = 95 # Won't be returned
c = 12345678987654321
count = ObjectSpace.each_object(Numeric) {|x| p x }
puts "Total count: #{count}"
produces:
12345678987654321
102.7
2.71828182845905
3.14159265358979
2.22044604925031e-16
1.7976931348623157e+308
2.2250738585072e-308
Total count: 7
@overload each_object([module])
@yield [obj]
@return [Fixnum]
@overload each_object([module]);T;%0;"@o\;'F;(i ;)o;*;+T;,i ;-i ;.@V; @m\;/@n\;0To;
; F; ;
;;K;I" ObjectSpace#garbage_collect;F;[[@0;[[@[
i1;T;:garbage_collect;0;[ ;{ ;IC;"Initiates garbage collection, unless manually disabled.
This method is defined with keyword arguments that default to true:
def GC.start(full_mark: true, immediate_sweep: true); end
Use full_mark: false to perform a minor GC.
Use immediate_sweep: false to defer sweeping (use lazy sweep).
Note: These keyword arguments are implementation and version dependent. They
are not guaranteed to be future-compatible, and may be ignored if the
underlying implementation does not support them.
;T;[ o;
; I"
overload;F; 0;:
start; 0; I"
start;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@\;#[ ;$I"@return [nil];T;%0;"@\;&0;'F;(i ;[ ;"@\o;
; I"
overload;F; 0;;I; 0; I"garbage_collect;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@\;#[ ;$I"@return [nil];T;%0;"@\;&0;'F;(i ;[ ;"@\o;
; I"
overload;F; 0;;J; 0; I"2start(full_mark: true, immediate_sweep: true);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@\;#[ ;$I"@return [nil];T;%0;"@\;&0;'F;(i ;[[I"full_mark:;TI" true;T[I"immediate_sweep:;TI" true;T;"@\o;
; I"
overload;F; 0;;I; 0; I"aProc as a finalizer, to be called after obj
was destroyed. The object ID of the obj will be passed
as an argument to aProc. If aProc is a lambda or
method, make sure it can be called with a single argument.
;T;[o;
; I"
overload;F; 0;;K; 0; I"(define_finalizer(obj, aProc=proc());T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@+];&0;'F;(i ;[[I"obj;T0[I"
aProc;TI" proc();T;"@+];#[ ;$I"&Adds aProc as a finalizer, to be called after obj
was destroyed. The object ID of the obj will be passed
as an argument to aProc. If aProc is a lambda or
method, make sure it can be called with a single argument.
@overload define_finalizer(obj, aProc=proc())
;T;%0;"@+];&0;'F;.@V; I"static VALUE;T;/I"0static VALUE
define_final(int argc, VALUE *argv, VALUE os)
{
VALUE obj, block;
rb_scan_args(argc, argv, "11", &obj, &block);
should_be_finalizable(obj);
if (argc == 1) {
block = rb_block_proc();
}
else {
should_be_callable(block);
}
return define_final0(obj, block);
};T;0To;
; T; ;S;;;I"!ObjectSpace.define_finalizer;F;@-];@/];T;;K;0;@1];{ ;IC;"Adds aProc as a finalizer, to be called after obj
was destroyed. The object ID of the obj will be passed
as an argument to aProc. If aProc is a lambda or
method, make sure it can be called with a single argument.;T;[o;
; I"
overload;F; 0;;K; 0; I"(define_finalizer(obj, aProc=proc());T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@F];&0;'F;(i ;[[I"obj;T0[I"
aProc;TI" proc();T;"@F];#[ ;$I"(Adds aProc as a finalizer, to be called after obj
was destroyed. The object ID of the obj will be passed
as an argument to aProc. If aProc is a lambda or
method, make sure it can be called with a single argument.
@overload define_finalizer(obj, aProc=proc());T;%0;"@F];'F;(i ;)o;*;+T;,i ;-i ;.@V; @D];/@E];0To;
; F; ;
;;K;I"#ObjectSpace#undefine_finalizer;F;[[I"obj;T0;[[@[
i ;T;:undefine_finalizer;0;[ ;{ ;IC;"+Removes all finalizers for obj.
;T;[o;
; I"
overload;F; 0;;L; 0; I" undefine_finalizer(obj);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@[];&0;'F;(i ;[[I"obj;T0;"@[];#[ ;$I"NRemoves all finalizers for obj.
@overload undefine_finalizer(obj)
;T;%0;"@[];&0;'F;.@V; I"static VALUE;T;/I"`static VALUE
undefine_final(VALUE os, VALUE obj)
{
return rb_undefine_finalizer(obj);
};T;0To;
; T; ;S;;;I"#ObjectSpace.undefine_finalizer;F;@]];@`];T;;L;0;@b];{ ;IC;"+Removes all finalizers for obj.;T;[o;
; I"
overload;F; 0;;L; 0; I" undefine_finalizer(obj);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@t];&0;'F;(i ;[[I"obj;T0;"@t];#[ ;$I"PRemoves all finalizers for obj.
@overload undefine_finalizer(obj);T;%0;"@t];'F;(i ;)o;*;+T;,i ;-i ;.@V; @r];/@s];0To;
; F; ;
;;K;I"ObjectSpace#_id2ref;F;[[I"
objid;T0;[[@[
i} ;T;: _id2ref;0;[ ;{ ;IC;"+Converts an object id to a reference to the object. May not be
called on an object id passed as a parameter to a finalizer.
s = "I am a string" #=> "I am a string"
r = ObjectSpace._id2ref(s.object_id) #=> "I am a string"
r == s #=> true
;T;[o;
; I"
overload;F; 0;;M; 0; I"_id2ref(object_id);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@];#[ ;$I"@return [Object];T;%0;"@];&0;'F;(i ;[[I"object_id;T0;"@];#[ ;$I"\Converts an object id to a reference to the object. May not be
called on an object id passed as a parameter to a finalizer.
s = "I am a string" #=> "I am a string"
r = ObjectSpace._id2ref(s.object_id) #=> "I am a string"
r == s #=> true
@overload _id2ref(object_id)
@return [Object];T;%0;"@];&0;'F;.@V; I"static VALUE;T;/I"1static VALUE
id2ref(VALUE obj, VALUE objid)
{
#if SIZEOF_LONG == SIZEOF_VOIDP
#define NUM2PTR(x) NUM2ULONG(x)
#elif SIZEOF_LONG_LONG == SIZEOF_VOIDP
#define NUM2PTR(x) NUM2ULL(x)
#endif
rb_objspace_t *objspace = &rb_objspace;
VALUE ptr;
void *p0;
ptr = NUM2PTR(objid);
p0 = (void *)ptr;
if (ptr == Qtrue) return Qtrue;
if (ptr == Qfalse) return Qfalse;
if (ptr == Qnil) return Qnil;
if (FIXNUM_P(ptr)) return (VALUE)ptr;
if (FLONUM_P(ptr)) return (VALUE)ptr;
ptr = obj_id_to_ref(objid);
if ((ptr % sizeof(RVALUE)) == (4 << 2)) {
ID symid = ptr / sizeof(RVALUE);
if (rb_id2str(symid) == 0)
rb_raise(rb_eRangeError, "%p is not symbol id value", p0);
return ID2SYM(symid);
}
if (!is_id_value(objspace, ptr)) {
rb_raise(rb_eRangeError, "%p is not id value", p0);
}
if (!is_live_object(objspace, ptr)) {
rb_raise(rb_eRangeError, "%p is recycled object", p0);
}
if (RBASIC(ptr)->klass == 0) {
rb_raise(rb_eRangeError, "%p is internal object", p0);
}
return (VALUE)ptr;
};T;0To;
; T; ;S;;;I"ObjectSpace._id2ref;F;@];@];T;;M;0;@];{ ;IC;"+Converts an object id to a reference to the object. May not be
called on an object id passed as a parameter to a finalizer.
s = "I am a string" #=> "I am a string"
r = ObjectSpace._id2ref(s.object_id) #=> "I am a string"
r == s #=> true;T;[o;
; I"
overload;F; 0;;M; 0; I"_id2ref(object_id);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@];#[ ;$I"@return [Object];T;%0;"@];&0;'F;(i ;[[I"object_id;T0;"@];#[ ;$I"^Converts an object id to a reference to the object. May not be
called on an object id passed as a parameter to a finalizer.
s = "I am a string" #=> "I am a string"
r = ObjectSpace._id2ref(s.object_id) #=> "I am a string"
r == s #=> true
@overload _id2ref(object_id)
@return [Object];T;%0;"@];'F;(i ;)o;*;+T;,ip ;-iz ;.@V; @];/@];0To;
; F; ;
;;K;I" ObjectSpace#count_objects;F;[[@0;[[@[
i ;T;:count_objects;0;[ ;{ ;IC;"Counts all objects grouped by type.
It returns a hash, such as:
{
:TOTAL=>10000,
:FREE=>3011,
:T_OBJECT=>6,
:T_CLASS=>404,
# ...
}
The contents of the returned hash are implementation specific.
It may be changed in future.
The keys starting with +:T_+ means live objects.
For example, +:T_ARRAY+ is the number of arrays.
+:FREE+ means object slots which is not used now.
+:TOTAL+ means sum of above.
If the optional argument +result_hash+ is given,
it is overwritten and returned. This is intended to avoid probe effect.
h = {}
ObjectSpace.count_objects(h)
puts h
# => { :TOTAL=>10000, :T_CLASS=>158280, :T_MODULE=>20672, :T_STRING=>527249 }
This method is only expected to work on C Ruby.
;T;[o;
; I"
overload;F; 0;;N; 0; I"!count_objects([result_hash]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@];#[ ;$I"@return [Hash];T;%0;"@];&0;'F;(i ;[[I"[result_hash];T0;"@];#[ ;$I"Counts all objects grouped by type.
It returns a hash, such as:
{
:TOTAL=>10000,
:FREE=>3011,
:T_OBJECT=>6,
:T_CLASS=>404,
# ...
}
The contents of the returned hash are implementation specific.
It may be changed in future.
The keys starting with +:T_+ means live objects.
For example, +:T_ARRAY+ is the number of arrays.
+:FREE+ means object slots which is not used now.
+:TOTAL+ means sum of above.
If the optional argument +result_hash+ is given,
it is overwritten and returned. This is intended to avoid probe effect.
h = {}
ObjectSpace.count_objects(h)
puts h
# => { :TOTAL=>10000, :T_CLASS=>158280, :T_MODULE=>20672, :T_STRING=>527249 }
This method is only expected to work on C Ruby.
@overload count_objects([result_hash])
@return [Hash];T;%0;"@];&0;'F;.@V; I"static VALUE;T;/I" static VALUE
count_objects(int argc, VALUE *argv, VALUE os)
{
rb_objspace_t *objspace = &rb_objspace;
size_t counts[T_MASK+1];
size_t freed = 0;
size_t total = 0;
size_t i;
VALUE hash;
if (rb_scan_args(argc, argv, "01", &hash) == 1) {
if (!RB_TYPE_P(hash, T_HASH))
rb_raise(rb_eTypeError, "non-hash given");
}
for (i = 0; i <= T_MASK; i++) {
counts[i] = 0;
}
for (i = 0; i < heap_allocated_pages; i++) {
struct heap_page *page = heap_pages_sorted[i];
RVALUE *p, *pend;
p = page->start; pend = p + page->total_slots;
for (;p < pend; p++) {
if (p->as.basic.flags) {
counts[BUILTIN_TYPE(p)]++;
}
else {
freed++;
}
}
total += page->total_slots;
}
if (hash == Qnil) {
hash = rb_hash_new();
}
else if (!RHASH_EMPTY_P(hash)) {
st_foreach(RHASH_TBL_RAW(hash), set_zero, hash);
}
rb_hash_aset(hash, ID2SYM(rb_intern("TOTAL")), SIZET2NUM(total));
rb_hash_aset(hash, ID2SYM(rb_intern("FREE")), SIZET2NUM(freed));
for (i = 0; i <= T_MASK; i++) {
VALUE type;
switch (i) {
#define COUNT_TYPE(t) case (t): type = ID2SYM(rb_intern(#t)); break;
COUNT_TYPE(T_NONE);
COUNT_TYPE(T_OBJECT);
COUNT_TYPE(T_CLASS);
COUNT_TYPE(T_MODULE);
COUNT_TYPE(T_FLOAT);
COUNT_TYPE(T_STRING);
COUNT_TYPE(T_REGEXP);
COUNT_TYPE(T_ARRAY);
COUNT_TYPE(T_HASH);
COUNT_TYPE(T_STRUCT);
COUNT_TYPE(T_BIGNUM);
COUNT_TYPE(T_FILE);
COUNT_TYPE(T_DATA);
COUNT_TYPE(T_MATCH);
COUNT_TYPE(T_COMPLEX);
COUNT_TYPE(T_RATIONAL);
COUNT_TYPE(T_NIL);
COUNT_TYPE(T_TRUE);
COUNT_TYPE(T_FALSE);
COUNT_TYPE(T_SYMBOL);
COUNT_TYPE(T_FIXNUM);
COUNT_TYPE(T_IMEMO);
COUNT_TYPE(T_UNDEF);
COUNT_TYPE(T_NODE);
COUNT_TYPE(T_ICLASS);
COUNT_TYPE(T_ZOMBIE);
#undef COUNT_TYPE
default: type = INT2NUM(i); break;
}
if (counts[i])
rb_hash_aset(hash, type, SIZET2NUM(counts[i]));
}
return hash;
};T;0To;
; T; ;S;;;I" ObjectSpace.count_objects;F;@];@];T;;N;0;@];{ ;IC;"Counts all objects grouped by type.
It returns a hash, such as:
{
:TOTAL=>10000,
:FREE=>3011,
:T_OBJECT=>6,
:T_CLASS=>404,
# ...
}
The contents of the returned hash are implementation specific.
It may be changed in future.
The keys starting with +:T_+ means live objects.
For example, +:T_ARRAY+ is the number of arrays.
+:FREE+ means object slots which is not used now.
+:TOTAL+ means sum of above.
If the optional argument +result_hash+ is given,
it is overwritten and returned. This is intended to avoid probe effect.
h = {}
ObjectSpace.count_objects(h)
puts h
# => { :TOTAL=>10000, :T_CLASS=>158280, :T_MODULE=>20672, :T_STRING=>527249 }
This method is only expected to work on C Ruby.;T;[o;
; I"
overload;F; 0;;N; 0; I"!count_objects([result_hash]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Hash;T;"@];#[ ;$I"@return [Hash];T;%0;"@];&0;'F;(i ;[[I"[result_hash];T0;"@];#[ ;$I"Counts all objects grouped by type.
It returns a hash, such as:
{
:TOTAL=>10000,
:FREE=>3011,
:T_OBJECT=>6,
:T_CLASS=>404,
# ...
}
The contents of the returned hash are implementation specific.
It may be changed in future.
The keys starting with +:T_+ means live objects.
For example, +:T_ARRAY+ is the number of arrays.
+:FREE+ means object slots which is not used now.
+:TOTAL+ means sum of above.
If the optional argument +result_hash+ is given,
it is overwritten and returned. This is intended to avoid probe effect.
h = {}
ObjectSpace.count_objects(h)
puts h
# => { :TOTAL=>10000, :T_CLASS=>158280, :T_MODULE=>20672, :T_STRING=>527249 }
This method is only expected to work on C Ruby.
@overload count_objects([result_hash])
@return [Hash];T;%0;"@];'F;(i ;)o;*;+T;,it ;-i ;.@V; @];/@];0T;N@V;OIC;[ ;N@V;PIC;[ ;N@V;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[ [@
Vi[@
Vi[@Xi[@Yi[@[
i$[@[
if$;T;;G;;X;;;[ ;{ ;IC;"eThe ObjectSpace module contains a number of routines
that interact with the garbage collection facility and allow you to
traverse all living objects with an iterator.
ObjectSpace also provides support for object finalizers, procs that will be
called when a specific object is about to be destroyed by garbage
collection.
require 'objspace'
a = "A"
b = "B"
ObjectSpace.define_finalizer(a, proc {|id| puts "Finalizer one on #{id}" })
ObjectSpace.define_finalizer(b, proc {|id| puts "Finalizer two on #{id}" })
_produces:_
Finalizer two on 537763470
Finalizer one on 537763480;T;[ ;#[ ;$I"h
The ObjectSpace module contains a number of routines
that interact with the garbage collection facility and allow you to
traverse all living objects with an iterator.
ObjectSpace also provides support for object finalizers, procs that will be
called when a specific object is about to be destroyed by garbage
collection.
require 'objspace'
a = "A"
b = "B"
ObjectSpace.define_finalizer(a, proc {|id| puts "Finalizer one on #{id}" })
ObjectSpace.define_finalizer(b, proc {|id| puts "Finalizer two on #{id}" })
_produces:_
Finalizer two on 537763470
Finalizer one on 537763480
;T;%0;"@V;'F;(i ;)o;*;+T;,i$;-i$;.@;I"ObjectSpace;Fo;;IC;[ ;N@^;OIC;[ ;N@^;PIC;[ ;N@^;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i[@i;T;:
Errno;;X;;;[ ;{ ;IC;"Ruby exception objects are subclasses of Exception.
However, operating systems typically report errors using plain
integers. Module Errno is created dynamically to map
these operating system errors to Ruby classes, with each error
number generating its own subclass of SystemCallError.
As the subclass is created in module Errno, its name
will start Errno::.
The names of the Errno:: classes depend on
the environment in which Ruby runs. On a typical Unix or Windows
platform, there are Errno classes such as
Errno::EACCES, Errno::EAGAIN,
Errno::EINTR, and so on.
The integer operating system error number corresponding to a
particular error is available as the class constant
Errno::error::Errno.
Errno::EACCES::Errno #=> 13
Errno::EAGAIN::Errno #=> 11
Errno::EINTR::Errno #=> 4
The full list of operating system errors on your particular platform
are available as the constants of Errno.
Errno.constants #=> :E2BIG, :EACCES, :EADDRINUSE, :EADDRNOTAVAIL, ...
;T;[ ;#[ ;$I"
Ruby exception objects are subclasses of Exception.
However, operating systems typically report errors using plain
integers. Module Errno is created dynamically to map
these operating system errors to Ruby classes, with each error
number generating its own subclass of SystemCallError.
As the subclass is created in module Errno, its name
will start Errno::.
The names of the Errno:: classes depend on
the environment in which Ruby runs. On a typical Unix or Windows
platform, there are Errno classes such as
Errno::EACCES, Errno::EAGAIN,
Errno::EINTR, and so on.
The integer operating system error number corresponding to a
particular error is available as the class constant
Errno::error::Errno.
Errno::EACCES::Errno #=> 13
Errno::EAGAIN::Errno #=> 11
Errno::EINTR::Errno #=> 4
The full list of operating system errors on your particular platform
are available as the constants of Errno.
Errno.constants #=> :E2BIG, :EACCES, :EADDRINUSE, :EADDRNOTAVAIL, ...
;T;%0;"@^;'F;)o;*;+T;,i;-i;.@;I"
Errno;Fo; ;IC;[ ;N@^;OIC;[ ;N@^;PIC;[ ;N@^;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i6[@i;T;:StandardError;;X;;;[ ;{ ;IC;"The most standard error types are subclasses of StandardError. A
rescue clause without an explicit Exception class will rescue all
StandardErrors (and only those).
def foo
raise "Oups"
end
foo rescue "Hello" #=> "Hello"
On the other hand:
require 'does/not/exist' rescue "Hi"
raises the exception:
LoadError: no such file to load -- does/not/exist
;T;[ ;#[ ;$I"
The most standard error types are subclasses of StandardError. A
rescue clause without an explicit Exception class will rescue all
StandardErrors (and only those).
def foo
raise "Oups"
end
foo rescue "Hello" #=> "Hello"
On the other hand:
require 'does/not/exist' rescue "Hi"
raises the exception:
LoadError: no such file to load -- does/not/exist
;T;%0;"@^;'F;)o;*;+T;,i6;-iH;.@;I"StandardError;F;Yo; ;IC;[o;
; F; ;S;;;I"Exception.exception;F;[[@0;[[@ui:;T;:exception;0;[ ;{ ;IC;"Calls allocate to create a new object of
class's class, then invokes that object's
initialize method, passing it args.
This is the method that ends up getting called whenever
an object is constructed using .new.
;T;[o;
; I"
overload;F; 0;;S; 0; I"new(args, ...);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@/^;#[ ;$I"@return [Object];T;%0;"@/^;&0;'F;(i ;[[I" args;T0[I"...;T0;"@/^;#[ ;$I"*Calls allocate to create a new object of
class's class, then invokes that object's
initialize method, passing it args.
This is the method that ends up getting called whenever
an object is constructed using .new.
@overload new(args, ...)
@return [Object];T;%0;"@/^;'F;)o;*;+T;,i.;-i7;.@-^; I"
VALUE;T;/I"VALUE
rb_class_new_instance(int argc, const VALUE *argv, VALUE klass)
{
VALUE obj;
obj = rb_obj_alloc(klass);
rb_obj_call_init(obj, argc, argv);
return obj;
};T;0To;
; F; ;
;;;I"Exception#exception;F;[[@0;[[@i;T;;Q;0;[ ;{ ;IC;"call-seq:
exc.exception(string) -> an_exception or exc
With no argument, or if the argument is the same as the receiver,
return the receiver. Otherwise, create a new
exception object of the same class as the receiver, but with a
message equal to string.to_str.
;T;[ ;#[ ;$I"
call-seq:
exc.exception(string) -> an_exception or exc
With no argument, or if the argument is the same as the receiver,
return the receiver. Otherwise, create a new
exception object of the same class as the receiver, but with a
message equal to string.to_str.
;T;%0;"@O^;'F;)o;*;+T;,i;-i;.@-^; I"static VALUE;T;/I"static VALUE
exc_exception(int argc, VALUE *argv, VALUE self)
{
VALUE exc;
if (argc == 0) return self;
if (argc == 1 && self == argv[0]) return self;
exc = rb_obj_clone(self);
exc_initialize(argc, argv, exc);
return exc;
};T;0To;
; F; ;
;;;I"Exception#initialize;F;[[@0;[[@i;T;;;0;[ ;{ ;IC;"HConstruct a new Exception object, optionally passing in
a message.
;T;[o;
; I"
overload;F; 0;;S; 0; I"new(msg = nil);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"Exception;T;"@^^;#[ ;$I"@return [Exception];T;%0;"@^^;&0;'F;(i ;[[I"msg;TI"nil;T;"@^^;#[ ;$I"z Construct a new Exception object, optionally passing in
a message.
@overload new(msg = nil)
@return [Exception];T;%0;"@^^;'F;)o;*;+T;,i;-i;.@-^; I"static VALUE;T;/I"static VALUE
exc_initialize(int argc, VALUE *argv, VALUE exc)
{
VALUE arg;
rb_scan_args(argc, argv, "01", &arg);
rb_ivar_set(exc, id_mesg, arg);
rb_ivar_set(exc, id_bt, Qnil);
return exc;
};T;0To;
; F; ;
;;;I"Exception#==;F;[[I"obj;T0;[[@i;T;;:;0;[ ;{ ;IC;"Equality---If obj is not an Exception, returns
false. Otherwise, returns true if exc and
obj share same class, messages, and backtrace.
;T;[o;
; I"
overload;F; 0;;:; 0; I" ==(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@}^;#[ ;$I"@return [Boolean];T;%0;"@}^;&0;'F;(i ;[[I"obj;T0;"@}^;#[ ;$I"Equality---If obj is not an Exception, returns
false. Otherwise, returns true if exc and
obj share same class, messages, and backtrace.
@overload ==(obj)
@return [Boolean];T;%0;"@}^;'F;)o;*;+T;,i;-i;.@-^; I"static VALUE;T;/I"&static VALUE
exc_equal(VALUE exc, VALUE obj)
{
VALUE mesg, backtrace;
if (exc == obj) return Qtrue;
if (rb_obj_class(exc) != rb_obj_class(obj)) {
int status = 0;
obj = rb_protect(try_convert_to_exception, obj, &status);
if (status || obj == Qundef) {
rb_set_errinfo(Qnil);
return Qfalse;
}
if (rb_obj_class(exc) != rb_obj_class(obj)) return Qfalse;
mesg = rb_check_funcall(obj, id_message, 0, 0);
if (mesg == Qundef) return Qfalse;
backtrace = rb_check_funcall(obj, id_backtrace, 0, 0);
if (backtrace == Qundef) return Qfalse;
}
else {
mesg = rb_attr_get(obj, id_mesg);
backtrace = exc_backtrace(obj);
}
if (!rb_equal(rb_attr_get(exc, id_mesg), mesg))
return Qfalse;
if (!rb_equal(exc_backtrace(exc), backtrace))
return Qfalse;
return Qtrue;
};T;0To;
; F; ;
;;;I"Exception#to_s;F;[ ;[[@i ;T;;I;0;[ ;{ ;IC;"UReturns exception's message (or the name of the exception if
no message is set).
;T;[o;
; I"
overload;F; 0;;I; 0; I" to_s;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@^;#[ ;$I"@return [String];T;%0;"@^;&0;'F;(i ;[ ;"@^;#[ ;$I"yReturns exception's message (or the name of the exception if
no message is set).
@overload to_s
@return [String];T;%0;"@^;'F;)o;*;+T;,i;-i;.@-^; I"static VALUE;T;/I"static VALUE
exc_to_s(VALUE exc)
{
VALUE mesg = rb_attr_get(exc, idMesg);
if (NIL_P(mesg)) return rb_class_name(CLASS_OF(exc));
return rb_String(mesg);
};T;0To;
; F; ;
;;;I"Exception#message;F;[ ;[[@i;T;: message;0;[ ;{ ;IC;"Returns the result of invoking exception.to_s.
Normally this returns the exception's message or name. By
supplying a to_str method, exceptions are agreeing to
be used where Strings are expected.
;T;[o;
; I"
overload;F; 0;;R; 0; I" message;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@^;#[ ;$I"@return [String];T;%0;"@^;&0;'F;(i ;[ ;"@^;#[ ;$I"Returns the result of invoking exception.to_s.
Normally this returns the exception's message or name. By
supplying a to_str method, exceptions are agreeing to
be used where Strings are expected.
@overload message
@return [String];T;%0;"@^;'F;)o;*;+T;,i ;-i;.@-^; I"static VALUE;T;/I"Wstatic VALUE
exc_message(VALUE exc)
{
return rb_funcallv(exc, idTo_s, 0, 0);
};T;0To;
; F; ;
;;;I"Exception#inspect;F;[ ;[[@i ;T;;J;0;[ ;{ ;IC;"3Return this exception's class name and message
;T;[o;
; I"
overload;F; 0;;J; 0; I" inspect;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@^;#[ ;$I"@return [String];T;%0;"@^;&0;'F;(i ;[ ;"@^;#[ ;$I"ZReturn this exception's class name and message
@overload inspect
@return [String];T;%0;"@^;'F;)o;*;+T;,i;-i ;.@-^; I"static VALUE;T;/I"static VALUE
exc_inspect(VALUE exc)
{
VALUE str, klass;
klass = CLASS_OF(exc);
exc = rb_obj_as_string(exc);
if (RSTRING_LEN(exc) == 0) {
return rb_str_dup(rb_class_name(klass));
}
str = rb_str_buf_new2("#<");
klass = rb_class_name(klass);
rb_str_buf_append(str, klass);
rb_str_buf_cat(str, ": ", 2);
rb_str_buf_append(str, exc);
rb_str_buf_cat(str, ">", 1);
return str;
};T;0To;
; F; ;
;;;I"Exception#backtrace;F;[ ;[[@iR;T;:backtrace;0;[ ;{ ;IC;"Returns any backtrace associated with the exception. The backtrace
is an array of strings, each containing either ``filename:lineNo: in
`method''' or ``filename:lineNo.''
def a
raise "boom"
end
def b
a()
end
begin
b()
rescue => detail
print detail.backtrace.join("\n")
end
produces:
prog.rb:2:in `a'
prog.rb:6:in `b'
prog.rb:10
;T;[o;
; I"
overload;F; 0;;S; 0; I"backtrace;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@^;#[ ;$I"@return [Array];T;%0;"@^;&0;'F;(i ;[ ;"@^;#[ ;$I"Returns any backtrace associated with the exception. The backtrace
is an array of strings, each containing either ``filename:lineNo: in
`method''' or ``filename:lineNo.''
def a
raise "boom"
end
def b
a()
end
begin
b()
rescue => detail
print detail.backtrace.join("\n")
end
produces:
prog.rb:2:in `a'
prog.rb:6:in `b'
prog.rb:10
@overload backtrace
@return [Array];T;%0;"@^;'F;)o;*;+T;,i5;-iO;.@-^; I"static VALUE;T;/I"static VALUE
exc_backtrace(VALUE exc)
{
VALUE obj;
obj = rb_attr_get(exc, id_bt);
if (rb_backtrace_p(obj)) {
obj = rb_backtrace_to_str_ary(obj);
/* rb_ivar_set(exc, id_bt, obj); */
}
return obj;
};T;0To;
; F; ;
;;;I""Exception#backtrace_locations;F;[ ;[[@i~;T;:backtrace_locations;0;[ ;{ ;IC;"Returns any backtrace associated with the exception. This method is
similar to Exception#backtrace, but the backtrace is an array of
Thread::Backtrace::Location.
Now, this method is not affected by Exception#set_backtrace().
;T;[o;
; I"
overload;F; 0;;T; 0; I"backtrace_locations;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@_;#[ ;$I"@return [Array];T;%0;"@_;&0;'F;(i ;[ ;"@_;#[ ;$I"Returns any backtrace associated with the exception. This method is
similar to Exception#backtrace, but the backtrace is an array of
Thread::Backtrace::Location.
Now, this method is not affected by Exception#set_backtrace().
@overload backtrace_locations
@return [Array];T;%0;"@_;'F;)o;*;+T;,it;-i|;.@-^; I"static VALUE;T;/I"static VALUE
exc_backtrace_locations(VALUE exc)
{
VALUE obj;
obj = rb_attr_get(exc, id_bt_locations);
if (!NIL_P(obj)) {
obj = rb_backtrace_to_location_ary(obj);
}
return obj;
};T;0To;
; F; ;
;;;I" Exception#set_backtrace;F;[[I"bt;T0;[[@i;T;:set_backtrace;0;[ ;{ ;IC;"Sets the backtrace information associated with +exc+. The +backtrace+ must
be an array of String objects or a single String in the format described
in Exception#backtrace.
;T;[o;
; I"
overload;F; 0;;U; 0; I" set_backtrace(backtrace);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@#_;#[ ;$I"@return [Array];T;%0;"@#_;&0;'F;(i ;[[I"backtrace;T0;"@#_;#[ ;$I"Sets the backtrace information associated with +exc+. The +backtrace+ must
be an array of String objects or a single String in the format described
in Exception#backtrace.
@overload set_backtrace(backtrace)
@return [Array];T;%0;"@#_;'F;)o;*;+T;,i;-i;.@-^; I"static VALUE;T;/I"xstatic VALUE
exc_set_backtrace(VALUE exc, VALUE bt)
{
return rb_ivar_set(exc, id_bt, rb_check_backtrace(bt));
};T;0To;
; F; ;
;;;I"Exception#cause;F;[ ;[[@i;T;:
cause;0;[ ;{ ;IC;"Returns the previous exception ($!) at the time this exception was raised.
This is useful for wrapping exceptions and retaining the original exception
information.
;T;[o;
; I"
overload;F; 0;;V; 0; I"
cause;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"Exception;TI"nil;T;"@B_;#[ ;$I" @return [Exception, nil];T;%0;"@B_;&0;'F;(i ;[ ;"@B_;#[ ;$I"Returns the previous exception ($!) at the time this exception was raised.
This is useful for wrapping exceptions and retaining the original exception
information.
@overload cause
@return [Exception, nil];T;%0;"@B_;'F;)o;*;+T;,i;-i;.@-^; I"static VALUE;T;/I"Qstatic VALUE
exc_cause(VALUE exc)
{
return rb_attr_get(exc, id_cause);
};T;0T;N@-^;OIC;[ ;N@-^;PIC;[ ;N@-^;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i;F;:Exception;;X;;;[ ;{ ;IC;" Descendants of class Exception are used to communicate between
Kernel#raise and +rescue+ statements in begin ... end blocks.
Exception objects carry information about the exception -- its type (the
exception's class name), an optional descriptive string, and optional
traceback information. Exception subclasses may add additional
information like NameError#name.
Programs may make subclasses of Exception, typically of StandardError or
RuntimeError, to provide custom classes and add additional information.
See the subclass list below for defaults for +raise+ and +rescue+.
When an exception has been raised but not yet handled (in +rescue+,
+ensure+, +at_exit+ and +END+ blocks) the global variable $!
will contain the current exception and $@ contains the
current exception's backtrace.
It is recommended that a library should have one subclass of StandardError
or RuntimeError and have specific exception types inherit from it. This
allows the user to rescue a generic exception type to catch all exceptions
the library may raise even if future versions of the library add new
exception subclasses.
For example:
class MyLibrary
class Error < RuntimeError
end
class WidgetError < Error
end
class FrobError < Error
end
end
To handle both WidgetError and FrobError the library user can rescue
MyLibrary::Error.
The built-in subclasses of Exception are:
* NoMemoryError
* ScriptError
* LoadError
* NotImplementedError
* SyntaxError
* SecurityError
* SignalException
* Interrupt
* StandardError -- default for +rescue+
* ArgumentError
* UncaughtThrowError
* EncodingError
* FiberError
* IOError
* EOFError
* IndexError
* KeyError
* StopIteration
* LocalJumpError
* NameError
* NoMethodError
* RangeError
* FloatDomainError
* RegexpError
* RuntimeError -- default for +raise+
* SystemCallError
* Errno::*
* ThreadError
* TypeError
* ZeroDivisionError
* SystemExit
* SystemStackError
* fatal -- impossible to rescue
;T;[ ;#[ ;$I"
Descendants of class Exception are used to communicate between
Kernel#raise and +rescue+ statements in begin ... end blocks.
Exception objects carry information about the exception -- its type (the
exception's class name), an optional descriptive string, and optional
traceback information. Exception subclasses may add additional
information like NameError#name.
Programs may make subclasses of Exception, typically of StandardError or
RuntimeError, to provide custom classes and add additional information.
See the subclass list below for defaults for +raise+ and +rescue+.
When an exception has been raised but not yet handled (in +rescue+,
+ensure+, +at_exit+ and +END+ blocks) the global variable $!
will contain the current exception and $@ contains the
current exception's backtrace.
It is recommended that a library should have one subclass of StandardError
or RuntimeError and have specific exception types inherit from it. This
allows the user to rescue a generic exception type to catch all exceptions
the library may raise even if future versions of the library add new
exception subclasses.
For example:
class MyLibrary
class Error < RuntimeError
end
class WidgetError < Error
end
class FrobError < Error
end
end
To handle both WidgetError and FrobError the library user can rescue
MyLibrary::Error.
The built-in subclasses of Exception are:
* NoMemoryError
* ScriptError
* LoadError
* NotImplementedError
* SyntaxError
* SecurityError
* SignalException
* Interrupt
* StandardError -- default for +rescue+
* ArgumentError
* UncaughtThrowError
* EncodingError
* FiberError
* IOError
* EOFError
* IndexError
* KeyError
* StopIteration
* LocalJumpError
* NameError
* NoMethodError
* RangeError
* FloatDomainError
* RegexpError
* RuntimeError -- default for +raise+
* SystemCallError
* Errno::*
* ThreadError
* TypeError
* ZeroDivisionError
* SystemExit
* SystemStackError
* fatal -- impossible to rescue
;T;%0;"@-^;'F;)o;*;+T;,ii;-i;.@;I"Exception;F;Y@No; ;IC;[o;
; F; ;
;;;I"SystemExit#initialize;F;[[@0;[[@i;T;;;0;[ ;{ ;IC;"Create a new +SystemExit+ exception with the given status and message.
Status is true, false, or an integer.
If status is not given, true is used.
;T;[ o;
; I"
overload;F; 0;;S; 0; I"new;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@q_;&0;'F;(i ;[ ;"@q_o;
; I"
overload;F; 0;;S; 0; I"new(status);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@q_;&0;'F;(i ;[[I" status;T0;"@q_o;
; I"
overload;F; 0;;S; 0; I"new(status, msg);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@q_;&0;'F;(i ;[[I" status;T0[I"msg;T0;"@q_o;
; I"
overload;F; 0;;S; 0; I"
new(msg);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@q_;&0;'F;(i ;[[I"msg;T0;"@q_;#[ ;$I"Create a new +SystemExit+ exception with the given status and message.
Status is true, false, or an integer.
If status is not given, true is used.
@overload new
@overload new(status)
@overload new(status, msg)
@overload new(msg);T;%0;"@q_;'F;)o;*;+T;,i;-i;.@o_; I"static VALUE;T;/I"static VALUE
exit_initialize(int argc, VALUE *argv, VALUE exc)
{
VALUE status;
if (argc > 0) {
status = *argv;
switch (status) {
case Qtrue:
status = INT2FIX(EXIT_SUCCESS);
++argv;
--argc;
break;
case Qfalse:
status = INT2FIX(EXIT_FAILURE);
++argv;
--argc;
break;
default:
status = rb_check_to_int(status);
if (NIL_P(status)) {
status = INT2FIX(EXIT_SUCCESS);
}
else {
#if EXIT_SUCCESS != 0
if (status == INT2FIX(0))
status = INT2FIX(EXIT_SUCCESS);
#endif
++argv;
--argc;
}
break;
}
}
else {
status = INT2FIX(EXIT_SUCCESS);
}
rb_call_super(argc, argv);
rb_ivar_set(exc, id_status, status);
return exc;
};T;0To;
; F; ;
;;;I"SystemExit#status;F;[ ;[[@i3;T;: status;0;[ ;{ ;IC;">Return the status value associated with this system exit.
;T;[o;
; I"
overload;F; 0;;X; 0; I" status;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;T;"@_;#[ ;$I"@return [Fixnum];T;%0;"@_;&0;'F;(i ;[ ;"@_;#[ ;$I"dReturn the status value associated with this system exit.
@overload status
@return [Fixnum];T;%0;"@_;'F;)o;*;+T;,i,;-i0;.@o_; I"static VALUE;T;/I"Tstatic VALUE
exit_status(VALUE exc)
{
return rb_attr_get(exc, id_status);
};T;0To;
; F; ;
;;;I"SystemExit#success?;F;[ ;[[@iA;T;:
success?;0;[ ;{ ;IC;":Returns +true+ if exiting successful, +false+ if not.
;T;[o;
; I"
overload;F; 0;;Y; 0; I"
success?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@_;#[ ;$I"@return [Boolean];T;%0;"@_;&0;'F;(i ;[ ;"@_o;!
; I" return;F; @;0; [@;"@_;#[ ;$I"cReturns +true+ if exiting successful, +false+ if not.
@overload success?
@return [Boolean];T;%0;"@_;'F;)o;*;+T;,i:;-i>;.@o_; I"static VALUE;T;/I" static VALUE
exit_success_p(VALUE exc)
{
VALUE status_val = rb_attr_get(exc, id_status);
int status;
if (NIL_P(status_val))
return Qtrue;
status = NUM2INT(status_val);
if (WIFEXITED(status) && WEXITSTATUS(status) == EXIT_SUCCESS)
return Qtrue;
return Qfalse;
};T;0T;N@o_;OIC;[ ;N@o_;PIC;[ ;N@o_;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@iL[@i;T;:SystemExit;;X;;;[ ;{ ;IC;"@Raised by +exit+ to initiate the termination of the script.;T;[ ;#[ ;$I"B
Raised by +exit+ to initiate the termination of the script.
;T;%0;"@o_;'F;(i ;)o;*;+T;,iL;-iN;.@;I"SystemExit;F;Y@-^o; ;IC;[ ;N@_;OIC;[ ;N@_;PIC;[ ;N@_;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@iR[@i;T;:SignalException;;X;;;[ ;{ ;IC;"Raised when a signal is received.
begin
Process.kill('HUP',Process.pid)
sleep # wait for receiver to handle signal sent by Process.kill
rescue SignalException => e
puts "received Exception #{e}"
end
produces:
received Exception SIGHUP
;T;[ ;#[ ;$I"
Raised when a signal is received.
begin
Process.kill('HUP',Process.pid)
sleep # wait for receiver to handle signal sent by Process.kill
rescue SignalException => e
puts "received Exception #{e}"
end
produces:
received Exception SIGHUP
;T;%0;"@_;'F;)o;*;+T;,iR;-i_;.@;I"SignalException;F;Y@-^o; ;IC;[o;
; F; ;
;;;I"Interrupt#initialize;F;[[@0;[[@ i\;T;;;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@ `;'F;)o;*;+T;,i[;-i[;.@`; I"static VALUE;T;/I"static VALUE
interrupt_init(int argc, VALUE *argv, VALUE self)
{
VALUE args[2];
args[0] = INT2FIX(SIGINT);
rb_scan_args(argc, argv, "01", &args[1]);
return rb_call_super(2, args);
};T;0T;N@`;OIC;[ ;N@`;PIC;[ ;N@`;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@ic[@i;T;:Interrupt;;X;;;[ ;{ ;IC;"Raised with the interrupt signal is received, typically because the
user pressed on Control-C (on most posix platforms). As such, it is a
subclass of +SignalException+.
begin
puts "Press ctrl-C when you get bored"
loop {}
rescue Interrupt => e
puts "Note: You will typically use Signal.trap instead."
end
produces:
Press ctrl-C when you get bored
then waits until it is interrupted with Control-C and then prints:
Note: You will typically use Signal.trap instead.;T;[ ;#[ ;$I"
Raised with the interrupt signal is received, typically because the
user pressed on Control-C (on most posix platforms). As such, it is a
subclass of +SignalException+.
begin
puts "Press ctrl-C when you get bored"
loop {}
rescue Interrupt => e
puts "Note: You will typically use Signal.trap instead."
end
produces:
Press ctrl-C when you get bored
then waits until it is interrupted with Control-C and then prints:
Note: You will typically use Signal.trap instead.
;T;%0;"@`;'F;(i ;)o;*;+T;,ic;-iv;.@;I"Interrupt;F;Y@_o; ;IC;[ ;N@*`;OIC;[ ;N@*`;PIC;[ ;N@*`;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@iz[@i;T;:TypeError;;X;;;[ ;{ ;IC;"Raised when encountering an object that is not of the expected type.
[1, 2, 3].first("two")
raises the exception:
TypeError: no implicit conversion of String into Integer
;T;[ ;#[ ;$I"
Raised when encountering an object that is not of the expected type.
[1, 2, 3].first("two")
raises the exception:
TypeError: no implicit conversion of String into Integer
;T;%0;"@*`;'F;)o;*;+T;,iz;-i;.@;I"TypeError;F;Y@^o; ;IC;[ ;N@>`;OIC;[ ;N@>`;PIC;[ ;N@>`;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i[@i;T;:ArgumentError;;X;;;[ ;{ ;IC;"Raised when the arguments are wrong and there isn't a more specific
Exception class.
Ex: passing the wrong number of arguments
[1, 2, 3].first(4, 5)
raises the exception:
ArgumentError: wrong number of arguments (given 2, expected 1)
Ex: passing an argument that is not acceptable:
[1, 2, 3].first(-4)
raises the exception:
ArgumentError: negative array size
;T;[ ;#[ ;$I"
Raised when the arguments are wrong and there isn't a more specific
Exception class.
Ex: passing the wrong number of arguments
[1, 2, 3].first(4, 5)
raises the exception:
ArgumentError: wrong number of arguments (given 2, expected 1)
Ex: passing an argument that is not acceptable:
[1, 2, 3].first(-4)
raises the exception:
ArgumentError: negative array size
;T;%0;"@>`;'F;)o;*;+T;,i;-i;.@;I"ArgumentError;F;Y@^o; ;IC;[ ;N@R`;OIC;[ ;N@R`;PIC;[ ;N@R`;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i[@i;T;:IndexError;;X;;;[ ;{ ;IC;"Raised when the given index is invalid.
a = [:foo, :bar]
a.fetch(0) #=> :foo
a[4] #=> nil
a.fetch(4) #=> IndexError: index 4 outside of array bounds: -2...2
;T;[ ;#[ ;$I"
Raised when the given index is invalid.
a = [:foo, :bar]
a.fetch(0) #=> :foo
a[4] #=> nil
a.fetch(4) #=> IndexError: index 4 outside of array bounds: -2...2
;T;%0;"@R`;'F;)o;*;+T;,i;-i;.@;I"IndexError;F;Y@^o; ;IC;[ ;N@f`;OIC;[ ;N@f`;PIC;[ ;N@f`;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i[@i;T;:
KeyError;;X;;;[ ;{ ;IC;"Raised when the specified key is not found. It is a subclass of
IndexError.
h = {"foo" => :bar}
h.fetch("foo") #=> :bar
h.fetch("baz") #=> KeyError: key not found: "baz"
;T;[ ;#[ ;$I"
Raised when the specified key is not found. It is a subclass of
IndexError.
h = {"foo" => :bar}
h.fetch("foo") #=> :bar
h.fetch("baz") #=> KeyError: key not found: "baz"
;T;%0;"@f`;'F;)o;*;+T;,i;-i;.@;I"
KeyError;F;Y@R`o; ;IC;[ ;N@z`;OIC;[ ;N@z`;PIC;[ ;N@z`;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i[@i;T;:RangeError;;X;;;[ ;{ ;IC;"Raised when a given numerical value is out of range.
[1, 2, 3].drop(1 << 100)
raises the exception:
RangeError: bignum too big to convert into `long'
;T;[ ;#[ ;$I"
Raised when a given numerical value is out of range.
[1, 2, 3].drop(1 << 100)
raises the exception:
RangeError: bignum too big to convert into `long'
;T;%0;"@z`;'F;)o;*;+T;,i;-i;.@;I"RangeError;F;Y@^o; ;IC;[ ;N@`;OIC;[ ;N@`;PIC;[ ;N@`;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i[@i;T;:ScriptError;;X;;;[ ;{ ;IC;"(ScriptError is the superclass for errors raised when a script
can not be executed because of a +LoadError+,
+NotImplementedError+ or a +SyntaxError+. Note these type of
+ScriptErrors+ are not +StandardError+ and will not be
rescued unless it is specified explicitly (or its ancestor
+Exception+).
;T;[ ;#[ ;$I"*
ScriptError is the superclass for errors raised when a script
can not be executed because of a +LoadError+,
+NotImplementedError+ or a +SyntaxError+. Note these type of
+ScriptErrors+ are not +StandardError+ and will not be
rescued unless it is specified explicitly (or its ancestor
+Exception+).
;T;%0;"@`;'F;)o;*;+T;,i;-i;.@;I"ScriptError;F;Y@-^o; ;IC;[ ;N@`;OIC;[ ;N@`;PIC;[ ;N@`;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i[@i;T;:SyntaxError;;X;;;[ ;{ ;IC;"Raised when encountering Ruby code with an invalid syntax.
eval("1+1=2")
raises the exception:
SyntaxError: (eval):1: syntax error, unexpected '=', expecting $end
;T;[ ;#[ ;$I"
Raised when encountering Ruby code with an invalid syntax.
eval("1+1=2")
raises the exception:
SyntaxError: (eval):1: syntax error, unexpected '=', expecting $end
;T;%0;"@`;'F;)o;*;+T;,i;-i;.@;I"SyntaxError;F;Y@`o; ;IC;[ ;N@`;OIC;[ ;N@`;PIC;[ ;N@`;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i[@i;T;:LoadError;;X;;;[ ;{ ;IC;"Raised when a file required (a Ruby script, extension library, ...)
fails to load.
require 'this/file/does/not/exist'
raises the exception:
LoadError: no such file to load -- this/file/does/not/exist
;T;[ ;#[ ;$I"
Raised when a file required (a Ruby script, extension library, ...)
fails to load.
require 'this/file/does/not/exist'
raises the exception:
LoadError: no such file to load -- this/file/does/not/exist
;T;%0;"@`;'F;)o;*;+T;,i;-i;.@;I"LoadError;F;Y@`o; ;IC;[ ;N@`;OIC;[ ;N@`;PIC;[ ;N@`;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i[@i;T;:NotImplementedError;;X;;;[ ;{ ;IC;"TRaised when a feature is not implemented on the current platform. For
example, methods depending on the +fsync+ or +fork+ system calls may
raise this exception if the underlying operating system or Ruby
runtime does not support them.
Note that if +fork+ raises a +NotImplementedError+, then
respond_to?(:fork) returns +false+.
;T;[ ;#[ ;$I"V
Raised when a feature is not implemented on the current platform. For
example, methods depending on the +fsync+ or +fork+ system calls may
raise this exception if the underlying operating system or Ruby
runtime does not support them.
Note that if +fork+ raises a +NotImplementedError+, then
respond_to?(:fork) returns +false+.
;T;%0;"@`;'F;)o;*;+T;,i;-i;.@;I"NotImplementedError;F;Y@`o; ;IC;[
o; ;IC;[ o;
; F; ;
;;;I"NameError::message#==;F;[[I" obj2;T0;[[@i;T;;:;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@`;'F;)o;*;+T;,i;-i;.@`; I"static VALUE;T;/I"static VALUE
name_err_mesg_equal(VALUE obj1, VALUE obj2)
{
VALUE *ptr1, *ptr2;
int i;
if (obj1 == obj2) return Qtrue;
if (rb_obj_class(obj2) != rb_cNameErrorMesg)
return Qfalse;
TypedData_Get_Struct(obj1, VALUE, &name_err_mesg_data_type, ptr1);
TypedData_Get_Struct(obj2, VALUE, &name_err_mesg_data_type, ptr2);
for (i=0; i 65) {
d = rb_any_to_s(obj);
}
singleton = (RSTRING_LEN(d) > 0 && RSTRING_PTR(d)[0] == '#');
d = QUOTE(d);
break;
}
if (!singleton) {
s = FAKE_CSTR(&s_str, ":");
c = rb_class_name(CLASS_OF(obj));
}
else {
c = s = FAKE_CSTR(&s_str, "");
}
args[0] = QUOTE(rb_obj_as_string(ptr[NAME_ERR_MESG__NAME]));
args[1] = d;
args[2] = s;
args[3] = c;
mesg = rb_str_format(4, args, mesg);
}
return mesg;
};T;0To;
; F; ;
;;;I" NameError::message#_dump;F;[[I"
limit;T0;[[@iG;T;:
_dump;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@ a;'F;)o;*;+T;,iF;-iF;.@`; I"static VALUE;T;/I"fstatic VALUE
name_err_mesg_dump(VALUE obj, VALUE limit)
{
return name_err_mesg_to_str(obj);
};T;0To;
; F; ;S;;;I" NameError::message._load;F;[[I"str;T0;[[@iN;T;:
_load;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@a;'F;)o;*;+T;,iM;-iM;.@`; I"static VALUE;T;/I"Pstatic VALUE
name_err_mesg_load(VALUE klass, VALUE str)
{
return str;
};T;0T;N@`;OIC;[ ;N@`;PIC;[ ;N@`;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@id[@i;T;;R;;X;;;[ ;{ ;IC;" :nodoc:;T;[ ;#[ ;$I"
:nodoc:
;T;%0;"@`;'F;(i ;)o;*;+T;,id;-ie;.o;Z ;[0;\0;]0;:NameError;.@;_@`;0;I"NameError::message;F;Yo; ;IC;[ ;N@3a;OIC;[ ;N@3a;PIC;[ ;N@3a;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@ui
[@ui
;T;: Data;;X;;;[ ;{ ;IC;"~This is a recommended base class for C extensions using Data_Make_Struct
or Data_Wrap_Struct, see README.EXT for details.
;T;[ ;#[ ;$I"{
This is a recommended base class for C extensions using Data_Make_Struct
or Data_Wrap_Struct, see README.EXT for details.
;T;%0;"@3a;'F;)o;*;+T;,i
;-i
;.@;I" Data;F;Y@No;
; F; ;
;;;I"NameError#initialize;F;[[@0;[[@iw;T;;;0;[ ;{ ;IC;"Construct a new NameError exception. If given the name
parameter may subsequently be examined using the NameError.name
method.
;T;[o;
; I"
overload;F; 0;;S; 0; I"new(msg [, name]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@Ga;&0;'F;(i ;[[I"msg[, name];T0;"@Ga;#[ ;$I"Construct a new NameError exception. If given the name
parameter may subsequently be examined using the NameError.name
method.
@overload new(msg [, name]);T;%0;"@Ga;'F;)o;*;+T;,in;-is;.@`; I"static VALUE;T;/I"static VALUE
name_err_initialize(int argc, VALUE *argv, VALUE self)
{
VALUE name;
VALUE iseqw = Qnil;
name = (argc > 1) ? argv[--argc] : Qnil;
rb_call_super(argc, argv);
rb_ivar_set(self, id_name, name);
{
rb_thread_t *th = GET_THREAD();
rb_control_frame_t *cfp =
rb_vm_get_ruby_level_next_cfp(th, RUBY_VM_PREVIOUS_CONTROL_FRAME(th->cfp));
if (cfp) iseqw = rb_iseqw_new(cfp->iseq);
}
rb_ivar_set(self, id_iseq, iseqw);
return self;
};T;0To;
; F; ;
;;;I"NameError#name;F;[ ;[[@i;T;: name;0;[ ;{ ;IC;">Return the name associated with this NameError exception.
;T;[o;
; I"
overload;F; 0;;j; 0; I" name;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"nil;T;"@`a;#[ ;$I"@return [String, nil];T;%0;"@`a;&0;'F;(i ;[ ;"@`a;#[ ;$I"gReturn the name associated with this NameError exception.
@overload name
@return [String, nil];T;%0;"@`a;'F;)o;*;+T;,i;-i;.@`; I"static VALUE;T;/I"Vstatic VALUE
name_err_name(VALUE self)
{
return rb_attr_get(self, id_name);
};T;0To;
; F; ;
;;;I"NameError#receiver;F;[ ;[[@i[;T;:
receiver;0;[ ;{ ;IC;"BReturn the receiver associated with this NameError exception.
;T;[o;
; I"
overload;F; 0;;k; 0; I"
receiver;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@|a;#[ ;$I"@return [Object];T;%0;"@|a;&0;'F;(i ;[ ;"@|a;#[ ;$I"jReturn the receiver associated with this NameError exception.
@overload receiver
@return [Object];T;%0;"@|a;'F;)o;*;+T;,iT;-iX;.@`; I"static VALUE;T;/I"static VALUE
name_err_receiver(VALUE self)
{
VALUE *ptr, recv, mesg;
recv = rb_ivar_lookup(self, id_receiver, Qundef);
if (recv != Qundef) return recv;
mesg = rb_attr_get(self, id_mesg);
if (!rb_typeddata_is_kind_of(mesg, &name_err_mesg_data_type)) {
rb_raise(rb_eArgError, "no receiver is available");
}
ptr = DATA_PTR(mesg);
return ptr[NAME_ERR_MESG__RECV];
};T;0To;
; F; ;
;;;I" NameError#local_variables;F;[ ;[[@i;T;;;0;[ ;{ ;IC;"uReturn a list of the local variable names defined where this
NameError exception was raised.
Internal use only.
;T;[o;
; I"
overload;F; 0;;; 0; I"local_variables;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@a;#[ ;$I"@return [Array];T;%0;"@a;&0;'F;(i ;[ ;"@a;#[ ;$I"Return a list of the local variable names defined where this
NameError exception was raised.
Internal use only.
@overload local_variables
@return [Array];T;%0;"@a;'F;)o;*;+T;,i;-i;.@`; I"static VALUE;T;/I"Xstatic VALUE
name_err_local_variables(VALUE self)
{
VALUE vars = rb_attr_get(self, id_local_variables);
if (NIL_P(vars)) {
VALUE iseqw = rb_attr_get(self, id_iseq);
if (!NIL_P(iseqw)) vars = rb_iseqw_local_variables(iseqw);
if (NIL_P(vars)) vars = rb_ary_new();
rb_ivar_set(self, id_local_variables, vars);
}
return vars;
};T;0T;N@`;OIC;[ ;N@`;PIC;[ ;N@`;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i[@i;T;;h;;X;;;[ ;{ ;IC;"BRaised when a given name is invalid or undefined.
puts foo
raises the exception:
NameError: undefined local variable or method `foo' for main:Object
Since constant names must start with a capital:
Fixnum.const_set :answer, 42
raises the exception:
NameError: wrong constant name answer;T;[ ;#[ ;$I"D
Raised when a given name is invalid or undefined.
puts foo
raises the exception:
NameError: undefined local variable or method `foo' for main:Object
Since constant names must start with a capital:
Fixnum.const_set :answer, 42
raises the exception:
NameError: wrong constant name answer
;T;%0;"@`;'F;(i ;)o;*;+T;,i;-i;.@;I"NameError;F;Y@^o; ;IC;[o;
; F; ;
;;;I" NoMethodError#initialize;F;[[@0;[[@i;T;;;0;[ ;{ ;IC;"Construct a NoMethodError exception for a method of the given name
called with the given arguments. The name may be accessed using
the #name method on the resulting object, and the
arguments using the #args method.
;T;[o;
; I"
overload;F; 0;;S; 0; I" new(msg, name [, args]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@a;&0;'F;(i ;[[I"msg;T0[I"name[, args];T0;"@a;#[ ;$I"Construct a NoMethodError exception for a method of the given name
called with the given arguments. The name may be accessed using
the #name method on the resulting object, and the
arguments using the #args method.
@overload new(msg, name [, args]);T;%0;"@a;'F;)o;*;+T;,i;-i;.@a; I"static VALUE;T;/I"static VALUE
nometh_err_initialize(int argc, VALUE *argv, VALUE self)
{
VALUE args = (argc > 2) ? argv[--argc] : Qnil;
name_err_initialize(argc, argv, self);
rb_ivar_set(self, id_args, args);
return self;
};T;0To;
; F; ;
;;;I"NoMethodError#args;F;[ ;[[@is;T;: args;0;[ ;{ ;IC;"NReturn the arguments passed in as the third parameter to
the constructor.
;T;[o;
; I"
overload;F; 0;;l; 0; I" args;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@a;#[ ;$I"@return [Object];T;%0;"@a;&0;'F;(i ;[ ;"@a;#[ ;$I"rReturn the arguments passed in as the third parameter to
the constructor.
@overload args
@return [Object];T;%0;"@a;'F;)o;*;+T;,ik;-ip;.@a; I"static VALUE;T;/I"Xstatic VALUE
nometh_err_args(VALUE self)
{
return rb_attr_get(self, id_args);
};T;0T;N@a;OIC;[ ;N@a;PIC;[ ;N@a;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i[@i;T;:NoMethodError;;X;;;[ ;{ ;IC;"Raised when a method is called on a receiver which doesn't have it
defined and also fails to respond with +method_missing+.
"hello".to_ary
raises the exception:
NoMethodError: undefined method `to_ary' for "hello":String;T;[ ;#[ ;$I"
Raised when a method is called on a receiver which doesn't have it
defined and also fails to respond with +method_missing+.
"hello".to_ary
raises the exception:
NoMethodError: undefined method `to_ary' for "hello":String
;T;%0;"@a;'F;(i ;)o;*;+T;,i;-i;.@;I"NoMethodError;F;Y@`o; ;IC;[ ;N@b;OIC;[ ;N@b;PIC;[ ;N@b;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i[@i;T;:RuntimeError;;X;;;[ ;{ ;IC;">A generic error class raised when an invalid operation is attempted.
[1, 2, 3].freeze << 4
raises the exception:
RuntimeError: can't modify frozen Array
Kernel.raise will raise a RuntimeError if no Exception class is
specified.
raise "ouch"
raises the exception:
RuntimeError: ouch
;T;[ ;#[ ;$I"@
A generic error class raised when an invalid operation is attempted.
[1, 2, 3].freeze << 4
raises the exception:
RuntimeError: can't modify frozen Array
Kernel.raise will raise a RuntimeError if no Exception class is
specified.
raise "ouch"
raises the exception:
RuntimeError: ouch
;T;%0;"@b;'F;)o;*;+T;,i;-i$;.@;I"RuntimeError;F;Y@^o; ;IC;[ ;N@"b;OIC;[ ;N@"b;PIC;[ ;N@"b;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i([@i;T;:SecurityError;;X;;;[ ;{ ;IC;"%Raised when attempting a potential unsafe operation, typically when
the $SAFE level is raised above 0.
foo = "bar"
proc = Proc.new do
$SAFE = 3
foo.untaint
end
proc.call
raises the exception:
SecurityError: Insecure: Insecure operation `untaint' at level 3
;T;[ ;#[ ;$I"'
Raised when attempting a potential unsafe operation, typically when
the $SAFE level is raised above 0.
foo = "bar"
proc = Proc.new do
$SAFE = 3
foo.untaint
end
proc.call
raises the exception:
SecurityError: Insecure: Insecure operation `untaint' at level 3
;T;%0;"@"b;'F;)o;*;+T;,i(;-i6;.@;I"SecurityError;F;Y@-^o; ;IC;[ ;N@6b;OIC;[ ;N@6b;PIC;[ ;N@6b;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i:[@i;T;:NoMemoryError;;X;;;[ ;{ ;IC;")Raised when memory allocation fails.
;T;[ ;#[ ;$I"+
Raised when memory allocation fails.
;T;%0;"@6b;'F;)o;*;+T;,i:;-i<;.@;I"NoMemoryError;F;Y@-^o; ;IC;[o;
; F; ;
;;;I" SystemCallError#initialize;F;[[@0;[[@i;T;;;0;[ ;{ ;IC;"
If _errno_ corresponds to a known system error code, constructs
the appropriate Errno class for that error, otherwise
constructs a generic SystemCallError object. The
error number is subsequently available via the errno
method.
;T;[o;
; I"
overload;F; 0;;S; 0; I"new(msg, errno);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@Lb;&0;'F;(i ;[[I"msg;T0[I"
errno;T0;"@Lb;#[ ;$I"&If _errno_ corresponds to a known system error code, constructs
the appropriate Errno class for that error, otherwise
constructs a generic SystemCallError object. The
error number is subsequently available via the errno
method.
@overload new(msg, errno);T;%0;"@Lb;'F;)o;*;+T;,i;-i;.@Jb; I"static VALUE;T;/I"static VALUE
syserr_initialize(int argc, VALUE *argv, VALUE self)
{
#if !defined(_WIN32)
char *strerror();
#endif
const char *err;
VALUE mesg, error, func, errmsg;
VALUE klass = rb_obj_class(self);
if (klass == rb_eSystemCallError) {
st_data_t data = (st_data_t)klass;
rb_scan_args(argc, argv, "12", &mesg, &error, &func);
if (argc == 1 && FIXNUM_P(mesg)) {
error = mesg; mesg = Qnil;
}
if (!NIL_P(error) && st_lookup(syserr_tbl, NUM2LONG(error), &data)) {
klass = (VALUE)data;
/* change class */
if (!RB_TYPE_P(self, T_OBJECT)) { /* insurance to avoid type crash */
rb_raise(rb_eTypeError, "invalid instance type");
}
RBASIC_SET_CLASS(self, klass);
}
}
else {
rb_scan_args(argc, argv, "02", &mesg, &func);
error = rb_const_get(klass, id_Errno);
}
if (!NIL_P(error)) err = strerror(NUM2INT(error));
else err = "unknown error";
errmsg = rb_enc_str_new_cstr(err, rb_locale_encoding());
if (!NIL_P(mesg)) {
VALUE str = StringValue(mesg);
if (!NIL_P(func)) rb_str_catf(errmsg, " @ %"PRIsVALUE, func);
rb_str_catf(errmsg, " - %"PRIsVALUE, str);
OBJ_INFECT(errmsg, mesg);
}
mesg = errmsg;
rb_call_super(1, &mesg);
rb_ivar_set(self, id_errno, error);
return self;
};T;0To;
; F; ;
;;;I"SystemCallError#errno;F;[ ;[[@i;T;:
errno;0;[ ;{ ;IC;"0Return this SystemCallError's error number.
;T;[o;
; I"
overload;F; 0;;q; 0; I"
errno;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;T;"@gb;#[ ;$I"@return [Fixnum];T;%0;"@gb;&0;'F;(i ;[ ;"@gb;#[ ;$I"UReturn this SystemCallError's error number.
@overload errno
@return [Fixnum];T;%0;"@gb;'F;)o;*;+T;,i ;-i;.@Jb; I"static VALUE;T;/I"Vstatic VALUE
syserr_errno(VALUE self)
{
return rb_attr_get(self, id_errno);
};T;0To;
; F; ;S;;;I"SystemCallError.===;F;[[I"exc;T0;[[@i!;T;;n;0;[ ;{ ;IC;"{Return +true+ if the receiver is a generic +SystemCallError+, or
if the error numbers +self+ and _other_ are the same.
;T;[o;
; I"
overload;F; 0;;n; 0; I"===(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@b;#[ ;$I"@return [Boolean];T;%0;"@b;&0;'F;(i ;[[I"
other;T0;"@b;#[ ;$I"Return +true+ if the receiver is a generic +SystemCallError+, or
if the error numbers +self+ and _other_ are the same.
@overload ===(other)
@return [Boolean];T;%0;"@b;'F;)o;*;+T;,i;-i ;.@Jb; I"static VALUE;T;/I"static VALUE
syserr_eqq(VALUE self, VALUE exc)
{
VALUE num, e;
if (!rb_obj_is_kind_of(exc, rb_eSystemCallError)) {
if (!rb_respond_to(exc, id_errno)) return Qfalse;
}
else if (self == rb_eSystemCallError) return Qtrue;
num = rb_attr_get(exc, id_errno);
if (NIL_P(num)) {
num = rb_funcallv(exc, id_errno, 0, 0);
}
e = rb_const_get(self, id_Errno);
if (FIXNUM_P(num) ? num == e : rb_equal(num, e))
return Qtrue;
return Qfalse;
};T;0T;N@Jb;OIC;[ ;N@Jb;PIC;[ ;N@Jb;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@i@[@i;T;:SystemCallError;;X;;;[ ;{ ;IC;"ASystemCallError is the base class for all low-level
platform-dependent errors.
The errors available on the current platform are subclasses of
SystemCallError and are defined in the Errno module.
File.open("does/not/exist")
raises the exception:
Errno::ENOENT: No such file or directory - does/not/exist;T;[ ;#[ ;$I"C
SystemCallError is the base class for all low-level
platform-dependent errors.
The errors available on the current platform are subclasses of
SystemCallError and are defined in the Errno module.
File.open("does/not/exist")
raises the exception:
Errno::ENOENT: No such file or directory - does/not/exist
;T;%0;"@Jb;'F;(i ;)o;*;+T;,i@;-iL;.@;I"SystemCallError;F;Y@^o; ;IC;[ ;N@b;OIC;[ ;N@b;PIC;[ ;N@b;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@iP[@i;T;:EncodingError;;X;;;[ ;{ ;IC;"9EncodingError is the base class for encoding errors.
;T;[ ;#[ ;$I";
EncodingError is the base class for encoding errors.
;T;%0;"@b;'F;)o;*;+T;,iP;-iR;.@;I"EncodingError;F;Y@^o; ;IC;[ ;N@b;OIC;[ ;N@b;PIC;[ ;N@b;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[I""ext/win32ole/win32ole_error.c;TiG[@biW;T;:WIN32OLERuntimeError;;X;;;[ ;{ ;IC;"Raised when OLE processing failed.
EX:
obj = WIN32OLE.new("NonExistProgID")
raises the exception:
WIN32OLERuntimeError: unknown OLE server: `NonExistProgID'
HRESULT error code:0x800401f3
Invalid class string
;T;[ ;#[ ;$I"
Raised when OLE processing failed.
EX:
obj = WIN32OLE.new("NonExistProgID")
raises the exception:
WIN32OLERuntimeError: unknown OLE server: `NonExistProgID'
HRESULT error code:0x800401f3
Invalid class string
;T;%0;"@b;'F;)o;*;+T;,iG;-iT;.@;I"WIN32OLERuntimeError;F;Y@bo; ;IC;[o;
; F; ;
;;;I" WIN32OLE_METHOD#initialize;F;[[I" oletype;T0[I" method;T0;[[I"#ext/win32ole/win32ole_method.c;Ti ;T;;;0;[ ;{ ;IC;"Returns a new WIN32OLE_METHOD object which represents the information
about OLE method.
The first argument ole_type specifies WIN32OLE_TYPE object.
The second argument method specifies OLE method name defined OLE class
which represents WIN32OLE_TYPE object.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
;T;[o;
; I"
overload;F; 0;;S; 0; I"new(ole_type, method);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"WIN32OLE_METHOD object;T;"@b;#[ ;$I"%@return [WIN32OLE_METHOD object];T;%0;"@b;&0;'F;(i ;[[I"
ole_type;T0[I" method;T0;"@b;#[ ;$I"Returns a new WIN32OLE_METHOD object which represents the information
about OLE method.
The first argument ole_type specifies WIN32OLE_TYPE object.
The second argument method specifies OLE method name defined OLE class
which represents WIN32OLE_TYPE object.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
@overload new(ole_type, method)
@return [WIN32OLE_METHOD object];T;%0;"@b;'F;)o;*;+T;,i;-i;.@b; I"static VALUE;T;/I"Dstatic VALUE
folemethod_initialize(VALUE self, VALUE oletype, VALUE method)
{
VALUE obj = Qnil;
ITypeInfo *pTypeInfo;
if (rb_obj_is_kind_of(oletype, cWIN32OLE_TYPE)) {
SafeStringValue(method);
pTypeInfo = itypeinfo(oletype);
obj = olemethod_from_typeinfo(self, pTypeInfo, method);
if (obj == Qnil) {
rb_raise(eWIN32OLERuntimeError, "not found %s",
StringValuePtr(method));
}
}
else {
rb_raise(rb_eTypeError, "1st argument should be WIN32OLE_TYPE object");
}
return obj;
};T;0To;
; F; ;
;;;I"WIN32OLE_METHOD#name;F;[ ;[[@bi(;T;;j;0;[ ;{ ;IC;"call-seq
WIN32OLE_METHOD#name
Returns the name of the method.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
puts method.name # => SaveAs
;T;[ ;#[ ;$I"call-seq
WIN32OLE_METHOD#name
Returns the name of the method.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
puts method.name # => SaveAs
;T;%0;"o;
; F; ;
;;;I"WIN32OLE_METHOD#to_s;F;[ ;[[@bi;F;;I;;X;[ ;{ ;@ c;.@b; I"static VALUE;T;/I"bstatic VALUE
folemethod_name(VALUE self)
{
return rb_ivar_get(self, rb_intern("name"));
};T;'F;)o;*;+T;,i ;-i&;.@b; @c;/I"bstatic VALUE
folemethod_name(VALUE self)
{
return rb_ivar_get(self, rb_intern("name"));
};T;0To;
; F; ;
;;;I" WIN32OLE_METHOD#return_type;F;[ ;[[@biH;T;:return_type;0;[ ;{ ;IC;"Returns string of return value type of method.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.return_type # => Workbook
;T;[o;
; I"
overload;F; 0;;u; 0; I"return_type;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@c;&0;'F;(i ;[ ;"@c;#[ ;$I"Returns string of return value type of method.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.return_type # => Workbook
@overload return_type;T;%0;"@c;'F;)o;*;+T;,i>;-iE;.@b; I"static VALUE;T;/I"static VALUE
folemethod_return_type(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_return_type(pmethod->pTypeInfo, pmethod->index);
};T;0To;
; F; ;
;;;I"!WIN32OLE_METHOD#return_vtype;F;[ ;[[@bij;T;:return_vtype;0;[ ;{ ;IC;"Returns number of return value type of method.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.return_vtype # => 26
;T;[o;
; I"
overload;F; 0;;v; 0; I"return_vtype;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@.c;&0;'F;(i ;[ ;"@.c;#[ ;$I"Returns number of return value type of method.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.return_vtype # => 26
@overload return_vtype;T;%0;"@.c;'F;)o;*;+T;,i`;-ig;.@b; I"static VALUE;T;/I"static VALUE
folemethod_return_vtype(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_return_vtype(pmethod->pTypeInfo, pmethod->index);
};T;0To;
; F; ;
;;;I"'WIN32OLE_METHOD#return_type_detail;F;[ ;[[@bi;T;:return_type_detail;0;[ ;{ ;IC;"Returns detail information of return value type of method.
The information is array.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
p method.return_type_detail # => ["PTR", "USERDEFINED", "Workbook"]
;T;[o;
; I"
overload;F; 0;;w; 0; I"return_type_detail;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@Dc;&0;'F;(i ;[ ;"@Dc;#[ ;$I"6Returns detail information of return value type of method.
The information is array.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
p method.return_type_detail # => ["PTR", "USERDEFINED", "Workbook"]
@overload return_type_detail;T;%0;"@Dc;'F;)o;*;+T;,i;-i;.@b; I"static VALUE;T;/I"static VALUE
folemethod_return_type_detail(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_return_type_detail(pmethod->pTypeInfo, pmethod->index);
};T;0To;
; F; ;
;;;I" WIN32OLE_METHOD#invoke_kind;F;[ ;[[@bi;T;:invoke_kind;0;[ ;{ ;IC;"8Returns the method kind string. The string is "UNKNOWN" or "PROPERTY"
or "PROPERTY" or "PROPERTYGET" or "PROPERTYPUT" or "PROPERTYPPUTREF"
or "FUNC".
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.invoke_kind # => "FUNC"
;T;[o;
; I"
overload;F; 0;;x; 0; I"invoke_kind;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@Zc;&0;'F;(i ;[ ;"@Zc;#[ ;$I"PReturns the method kind string. The string is "UNKNOWN" or "PROPERTY"
or "PROPERTY" or "PROPERTYGET" or "PROPERTYPUT" or "PROPERTYPPUTREF"
or "FUNC".
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.invoke_kind # => "FUNC"
@overload invoke_kind;T;%0;"@Zc;'F;)o;*;+T;,i;-i;.@b; I"static VALUE;T;/I"static VALUE
folemethod_invoke_kind(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_invoke_kind(pmethod->pTypeInfo, pmethod->index);
};T;0To;
; F; ;
;;;I" WIN32OLE_METHOD#invkind;F;[ ;[[@bi;T;: invkind;0;[ ;{ ;IC;"Returns the method invoke kind.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.invkind # => 1
;T;[o;
; I"
overload;F; 0;;y; 0; I" invkind;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@pc;&0;'F;(i ;[ ;"@pc;#[ ;$I"Returns the method invoke kind.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.invkind # => 1
@overload invkind;T;%0;"@pc;'F;)o;*;+T;,i;-i;.@b; I"static VALUE;T;/I"static VALUE
folemethod_invkind(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_invkind(pmethod->pTypeInfo, pmethod->index);
};T;0To;
; F; ;
;;;I" WIN32OLE_METHOD#visible?;F;[ ;[[@bi;T;:
visible?;0;[ ;{ ;IC;"Returns true if the method is public.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.visible? # => true
;T;[o;
; I"
overload;F; 0;;z; 0; I"
visible?;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@c;&0;'F;(i ;[ ;"@co;!
; I" return;F; @;0; [@;"@c;#[ ;$I"Returns true if the method is public.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.visible? # => true
@overload visible?;T;%0;"@c;'F;)o;*;+T;,i;-i;.@b; I"static VALUE;T;/I"static VALUE
folemethod_visible(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_visible(pmethod->pTypeInfo, pmethod->index);
};T;0To;
; F; ;
;;;I"WIN32OLE_METHOD#event?;F;[ ;[[@biJ;T;: event?;0;[ ;{ ;IC;"Returns true if the method is event.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SheetActivate')
puts method.event? # => true
;T;[o;
; I"
overload;F; 0;;{; 0; I" event?;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@c;&0;'F;(i ;[ ;"@co;!
; I" return;F; @;0; [@;"@c;#[ ;$I"Returns true if the method is event.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SheetActivate')
puts method.event? # => true
@overload event?;T;%0;"@c;'F;)o;*;+T;,i@;-iG;.@b; I"static VALUE;T;/I"static VALUE
folemethod_event(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
if (!pmethod->pOwnerTypeInfo)
return Qfalse;
return ole_method_event(pmethod->pOwnerTypeInfo,
pmethod->index,
rb_ivar_get(self, rb_intern("name")));
};T;0To;
; F; ;
;;;I"$WIN32OLE_METHOD#event_interface;F;[ ;[[@bi_;T;:event_interface;0;[ ;{ ;IC;"Returns event interface name if the method is event.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SheetActivate')
puts method.event_interface # => WorkbookEvents
;T;[o;
; I"
overload;F; 0;;|; 0; I"event_interface;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@c;&0;'F;(i ;[ ;"@c;#[ ;$I"Returns event interface name if the method is event.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SheetActivate')
puts method.event_interface # => WorkbookEvents
@overload event_interface;T;%0;"@c;'F;)o;*;+T;,iV;-i\;.@b; I"static VALUE;T;/I"static VALUE
folemethod_event_interface(VALUE self)
{
BSTR name;
struct olemethoddata *pmethod;
HRESULT hr;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
if(folemethod_event(self) == Qtrue) {
hr = ole_docinfo_from_type(pmethod->pTypeInfo, &name, NULL, NULL, NULL);
if(SUCCEEDED(hr))
return WC2VSTR(name);
}
return Qnil;
};T;0To;
; F; ;
;;;I" WIN32OLE_METHOD#helpstring;F;[ ;[[@bi;T;:helpstring;0;[ ;{ ;IC;"Returns help string of OLE method. If the help string is not found,
then the method returns nil.
tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', 'IWebBrowser')
method = WIN32OLE_METHOD.new(tobj, 'Navigate')
puts method.helpstring # => Navigates to a URL or file.
;T;[o;
; I"
overload;F; 0;;}; 0; I"helpstring;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@c;&0;'F;(i ;[ ;"@c;#[ ;$I"/Returns help string of OLE method. If the help string is not found,
then the method returns nil.
tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', 'IWebBrowser')
method = WIN32OLE_METHOD.new(tobj, 'Navigate')
puts method.helpstring # => Navigates to a URL or file.
@overload helpstring;T;%0;"@c;'F;)o;*;+T;,i;-i;.@b; I"static VALUE;T;/I"static VALUE
folemethod_helpstring(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_helpstring(pmethod->pTypeInfo, pmethod->index);
};T;0To;
; F; ;
;;;I" WIN32OLE_METHOD#helpfile;F;[ ;[[@bi;T;:
helpfile;0;[ ;{ ;IC;"Returns help file. If help file is not found, then
the method returns nil.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.helpfile # => C:\...\VBAXL9.CHM
;T;[o;
; I"
overload;F; 0;;~; 0; I"
helpfile;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@c;&0;'F;(i ;[ ;"@c;#[ ;$I"
Returns help file. If help file is not found, then
the method returns nil.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.helpfile # => C:\...\VBAXL9.CHM
@overload helpfile;T;%0;"@c;'F;)o;*;+T;,i;-i;.@b; I"static VALUE;T;/I"static VALUE
folemethod_helpfile(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_helpfile(pmethod->pTypeInfo, pmethod->index);
};T;0To;
; F; ;
;;;I" WIN32OLE_METHOD#helpcontext;F;[ ;[[@bi;T;:helpcontext;0;[ ;{ ;IC;"Returns help context.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.helpcontext # => 65717
;T;[o;
; I"
overload;F; 0;;; 0; I"helpcontext;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@c;&0;'F;(i ;[ ;"@c;#[ ;$I"Returns help context.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.helpcontext # => 65717
@overload helpcontext;T;%0;"@c;'F;)o;*;+T;,i;-i;.@b; I"static VALUE;T;/I"static VALUE
folemethod_helpcontext(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_helpcontext(pmethod->pTypeInfo, pmethod->index);
};T;0To;
; F; ;
;;;I"WIN32OLE_METHOD#dispid;F;[ ;[[@bi;T;: dispid;0;[ ;{ ;IC;"Returns dispatch ID.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.dispid # => 181
;T;[o;
; I"
overload;F; 0;;; 0; I" dispid;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@d;&0;'F;(i ;[ ;"@d;#[ ;$I"Returns dispatch ID.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.dispid # => 181
@overload dispid;T;%0;"@d;'F;)o;*;+T;,i;-i;.@b; I"static VALUE;T;/I"static VALUE
folemethod_dispid(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_dispid(pmethod->pTypeInfo, pmethod->index);
};T;0To;
; F; ;
;;;I" WIN32OLE_METHOD#offset_vtbl;F;[ ;[[@bi;T;:offset_vtbl;0;[ ;{ ;IC;"Returns the offset ov VTBL.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.offset_vtbl # => 40
;T;[o;
; I"
overload;F; 0;;; 0; I"offset_vtbl;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@&d;&0;'F;(i ;[ ;"@&d;#[ ;$I"Returns the offset ov VTBL.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.offset_vtbl # => 40
@overload offset_vtbl;T;%0;"@&d;'F;)o;*;+T;,i ;-i;.@b; I"static VALUE;T;/I"static VALUE
folemethod_offset_vtbl(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_offset_vtbl(pmethod->pTypeInfo, pmethod->index);
};T;0To;
; F; ;
;;;I" WIN32OLE_METHOD#size_params;F;[ ;[[@bi5;T;:size_params;0;[ ;{ ;IC;"Returns the size of arguments of the method.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
puts method.size_params # => 11
;T;[o;
; I"
overload;F; 0;;; 0; I"size_params;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ 11
@overload size_params;T;%0;"@pTypeInfo, pmethod->index);
};T;0To;
; F; ;
;;;I"$WIN32OLE_METHOD#size_opt_params;F;[ ;[[@biT;T;:size_opt_params;0;[ ;{ ;IC;"Returns the size of optional parameters.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
puts method.size_opt_params # => 4
;T;[o;
; I"
overload;F; 0;;; 0; I"size_opt_params;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@Rd;&0;'F;(i ;[ ;"@Rd;#[ ;$I"Returns the size of optional parameters.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
puts method.size_opt_params # => 4
@overload size_opt_params;T;%0;"@Rd;'F;)o;*;+T;,iK;-iQ;.@b; I"static VALUE;T;/I"static VALUE
folemethod_size_opt_params(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_size_opt_params(pmethod->pTypeInfo, pmethod->index);
};T;0To;
; F; ;
;;;I"WIN32OLE_METHOD#params;F;[ ;[[@bi;T;: params;0;[ ;{ ;IC;"returns array of WIN32OLE_PARAM object corresponding with method parameters.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
p method.params # => [Filename, FileFormat, Password, WriteResPassword,
ReadOnlyRecommended, CreateBackup, AccessMode,
ConflictResolution, AddToMru, TextCodepage,
TextVisualLayout]
;T;[o;
; I"
overload;F; 0;;; 0; I" params;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@hd;&0;'F;(i ;[ ;"@hd;#[ ;$I"returns array of WIN32OLE_PARAM object corresponding with method parameters.
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
p method.params # => [Filename, FileFormat, Password, WriteResPassword,
ReadOnlyRecommended, CreateBackup, AccessMode,
ConflictResolution, AddToMru, TextCodepage,
TextVisualLayout]
@overload params;T;%0;"@hd;'F;)o;*;+T;,i};-i;.@b; I"static VALUE;T;/I"static VALUE
folemethod_params(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_params(pmethod->pTypeInfo, pmethod->index);
};T;0T@
co;
; F; ;
;;;I" WIN32OLE_METHOD#inspect;F;[ ;[[@bi;T;;J;0;[ ;{ ;IC;"-Returns the method name with class name.
;T;[o;
; I"
overload;F; 0;;J; 0; I" inspect;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@~d;#[ ;$I"@return [String];T;%0;"@~d;&0;'F;(i ;[ ;"@~d;#[ ;$I"UReturns the method name with class name.
@overload inspect
@return [String];T;%0;"@~d;'F;)o;*;+T;,i;-i;.@b; I"static VALUE;T;/I"istatic VALUE
folemethod_inspect(VALUE self)
{
return default_inspect(self, "WIN32OLE_METHOD");
};T;0T;N@b;OIC;[ ;N@b;PIC;[ ;N@b;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{@
c;j;V[ ;[[@bi[@bi;T;:WIN32OLE_METHOD;;X;;;[ ;{ ;IC;"KWIN32OLE_METHOD objects represent OLE method information.;T;[ ;#[ ;$I"O
WIN32OLE_METHOD objects represent OLE method information.
;T;%0;"@b;'F;(i ;)o;*;+T;,i;-i;.@;I"WIN32OLE_METHOD;F;Y@No; ;IC;[ o;
; F; ;S;;;I"Symbol.all_symbols;F;[ ;[[@ 3i,;T;:all_symbols;0;[ ;{ ;IC;"Returns an array of all the symbols currently in Ruby's symbol
table.
Symbol.all_symbols.size #=> 903
Symbol.all_symbols[1,20] #=> [:floor, :ARGV, :Binding, :symlink,
:chown, :EOFError, :$;, :String,
:LOCK_SH, :"setuid?", :$<,
:default_proc, :compact, :extend,
:Tms, :getwd, :$=, :ThreadGroup,
:wait2, :$>]
;T;[o;
; I"
overload;F; 0;;; 0; I"all_symbols;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@d;#[ ;$I"@return [Array];T;%0;"@d;&0;'F;(i ;[ ;"@d;#[ ;$I"Returns an array of all the symbols currently in Ruby's symbol
table.
Symbol.all_symbols.size #=> 903
Symbol.all_symbols[1,20] #=> [:floor, :ARGV, :Binding, :symlink,
:chown, :EOFError, :$;, :String,
:LOCK_SH, :"setuid?", :$<,
:default_proc, :compact, :extend,
:Tms, :getwd, :$=, :ThreadGroup,
:wait2, :$>]
@overload all_symbols
@return [Array];T;%0;"@d;'F;)o;*;+T;,i ;-i);.@d; I"
VALUE;T;/I"VALUE
rb_sym_all_symbols(void)
{
VALUE ary = rb_ary_new2(global_symbols.str_sym->num_entries);
st_foreach(global_symbols.str_sym, symbols_i, ary);
return ary;
};T;0To;
; F; ;
;;;I"Symbol#==;F;[ ;[ ;F;;:;;X;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@d;.@d;0To;
; F; ;
;;;I"Symbol#===;F;[ ;[ ;F;;n;;X;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@d;.@d;0To;
; F; ;
;;;I"Symbol#inspect;F;[ ;[[@)i#;T;;J;0;[ ;{ ;IC;"bReturns the representation of sym as a symbol literal.
:fred.inspect #=> ":fred"
;T;[o;
; I"
overload;F; 0;;J; 0; I" inspect;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@d;#[ ;$I"@return [String];T;%0;"@d;&0;'F;(i ;[ ;"@d;#[ ;$I"Returns the representation of sym as a symbol literal.
:fred.inspect #=> ":fred"
@overload inspect
@return [String];T;%0;"@d;'F;)o;*;+T;,i#;-i#;.@d; I"static VALUE;T;/I" static VALUE
sym_inspect(VALUE sym)
{
VALUE str = rb_sym2str(sym);
const char *ptr;
long len;
char *dest;
if (!rb_str_symname_p(str)) {
str = rb_str_inspect(str);
len = RSTRING_LEN(str);
rb_str_resize(str, len + 1);
dest = RSTRING_PTR(str);
memmove(dest + 1, dest, len);
}
else {
rb_encoding *enc = STR_ENC_GET(str);
RSTRING_GETMEM(str, ptr, len);
str = rb_enc_str_new(0, len + 1, enc);
dest = RSTRING_PTR(str);
memcpy(dest + 1, ptr, len);
}
dest[0] = ':';
return str;
};T;0To;
; F; ;
;;;I"Symbol#to_s;F;[ ;[[@)i#;T;;I;0;[ ;{ ;IC;"[Returns the name or string corresponding to sym.
:fred.id2name #=> "fred"
;T;[o;
; I"
overload;F; 0;: id2name; 0; I" id2name;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@d;#[ ;$I"@return [String];T;%0;"@d;&0;'F;(i ;[ ;"@do;
; I"
overload;F; 0;;I; 0; I" to_s;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@d;#[ ;$I"@return [String];T;%0;"@d;&0;'F;(i ;[ ;"@d;#[ ;$I"Returns the name or string corresponding to sym.
:fred.id2name #=> "fred"
@overload id2name
@return [String]
@overload to_s
@return [String];T;%0;"@d;'F;)o;*;+T;,i#;-i#;.@d; I"
VALUE;T;/I"]VALUE
rb_sym_to_s(VALUE sym)
{
return str_new_shared(rb_cString, rb_sym2str(sym));
};T;0To;
; F; ;
;;;I"Symbol#id2name;F;[ ;[[@)i#;T;;;0;[ ;{ ;IC;"[Returns the name or string corresponding to sym.
:fred.id2name #=> "fred"
;T;[o;
; I"
overload;F; 0;;; 0; I" id2name;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@ e;#[ ;$I"@return [String];T;%0;"@ e;&0;'F;(i ;[ ;"@ eo;
; I"
overload;F; 0;;I; 0; I" to_s;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@ e;#[ ;$I"@return [String];T;%0;"@ e;&0;'F;(i ;[ ;"@ e;#[ ;$@e;%0;"@ e;'F;)o;*;+T;,i#;-i#;.@d; I"
VALUE;T;/I"]VALUE
rb_sym_to_s(VALUE sym)
{
return str_new_shared(rb_cString, rb_sym2str(sym));
};T;0To;
; F; ;
;;;I"Symbol#intern;F;[ ;[[@)i#;T;;;0;[ ;{ ;IC;"In general, to_sym returns the Symbol corresponding
to an object. As sym is already a symbol, self is returned
in this case.
;T;[o;
; I"
overload;F; 0;;; 0; I" to_sym;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@De;&0;'F;(i ;[ ;"@Deo;
; I"
overload;F; 0;;; 0; I" intern;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@De;&0;'F;(i ;[ ;"@De;#[ ;$I"In general, to_sym returns the Symbol corresponding
to an object. As sym is already a symbol, self is returned
in this case.
@overload to_sym
@overload intern;T;%0;"@De;'F;)o;*;+T;,i#;-i#;.@d; I"static VALUE;T;/I";static VALUE
sym_to_sym(VALUE sym)
{
return sym;
};T;0To;
; F; ;
;;;I"Symbol#to_sym;F;[ ;[[@)i#;T;;;0;[ ;{ ;IC;"In general, to_sym returns the Symbol corresponding
to an object. As sym is already a symbol, self is returned
in this case.
;T;[o;
; I"
overload;F; 0;;; 0; I" to_sym;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@be;&0;'F;(i ;[ ;"@beo;
; I"
overload;F; 0;;; 0; I" intern;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@be;&0;'F;(i ;[ ;"@be;#[ ;$@^e;%0;"@be;'F;)o;*;+T;,i#;-i#;.@d; I"static VALUE;T;/I";static VALUE
sym_to_sym(VALUE sym)
{
return sym;
};T;0To;
; F; ;
;;;I"Symbol#to_proc;F;[ ;[[@)i#;T;;;0;[ ;{ ;IC;"wReturns a _Proc_ object which respond to the given method by _sym_.
(1..3).collect(&:to_s) #=> ["1", "2", "3"]
;T;[o;
; I"
overload;F; 0;;; 0; I" to_proc;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@e;&0;'F;(i ;[ ;"@e;#[ ;$I"Returns a _Proc_ object which respond to the given method by _sym_.
(1..3).collect(&:to_s) #=> ["1", "2", "3"]
@overload to_proc;T;%0;"@e;'F;)o;*;+T;,i#;-i#;.@d; I"
VALUE;T;/I"(VALUE
rb_sym_to_proc(VALUE sym)
{
};T;0To;
; F; ;
;;;I"Symbol#succ;F;[ ;[[@)i
$;T;;;0;[ ;{ ;IC;"/Same as sym.to_s.succ.intern.
;T;[o;
; I"
overload;F; 0;;; 0; I" succ;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@e;&0;'F;(i ;[ ;"@e;#[ ;$I"@Same as sym.to_s.succ.intern.
@overload succ;T;%0;"@e;'F;)o;*;+T;,i$;-i$;.@d; I"static VALUE;T;/I"astatic VALUE
sym_succ(VALUE sym)
{
return rb_str_intern(rb_str_succ(rb_sym2str(sym)));
};T;0To;
; F; ;
;;;I"Symbol#next;F;[ ;[[@)i
$;T;;;0;[ ;{ ;IC;"/Same as sym.to_s.succ.intern.
;T;[o;
; I"
overload;F; 0;;; 0; I" succ;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@e;&0;'F;(i ;[ ;"@e;#[ ;$@e;%0;"@e;'F;)o;*;+T;,i$;-i$;.@d; I"static VALUE;T;/I"astatic VALUE
sym_succ(VALUE sym)
{
return rb_str_intern(rb_str_succ(rb_sym2str(sym)));
};T;0To;
; F; ;
;;;I"Symbol#<=>;F;[[I"
other;T0;[[@)i!$;T;;9;0;[ ;{ ;IC;" Compares +symbol+ with +other_symbol+ after calling #to_s on each of the
symbols. Returns -1, 0, +1 or nil depending on whether +symbol+ is less
than, equal to, or greater than +other_symbol+.
+nil+ is returned if the two values are incomparable.
See String#<=> for more information.
;T;[o;
; I"
overload;F; 0;;9; 0; I"<=>(other_symbol);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [ I"-1;TI"0;TI"+1;TI"nil;T;"@e;#[ ;$I" @return [-1, 0, +1, nil];T;%0;"@e;&0;'F;(i ;[[I"other_symbol;T0;"@e;#[ ;$I"YCompares +symbol+ with +other_symbol+ after calling #to_s on each of the
symbols. Returns -1, 0, +1 or nil depending on whether +symbol+ is less
than, equal to, or greater than +other_symbol+.
+nil+ is returned if the two values are incomparable.
See String#<=> for more information.
@overload <=>(other_symbol)
@return [-1, 0, +1, nil];T;%0;"@e;'F;)o;*;+T;,i$;-i $;.@d; I"static VALUE;T;/I"static VALUE
sym_cmp(VALUE sym, VALUE other)
{
if (!SYMBOL_P(other)) {
return Qnil;
}
return rb_str_cmp_m(rb_sym2str(sym), rb_sym2str(other));
};T;0To;
; F; ;
;;;I"Symbol#casecmp;F;[[I"
other;T0;[[@)i2$;T;;U;0;[ ;{ ;IC;"9Case-insensitive version of Symbol#<=>.
;T;[o;
; I"
overload;F; 0;;U; 0; I"casecmp(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [ I"-1;TI"0;TI"+1;TI"nil;T;"@e;#[ ;$I" @return [-1, 0, +1, nil];T;%0;"@e;&0;'F;(i ;[[I"
other;T0;"@e;#[ ;$I"qCase-insensitive version of Symbol#<=>.
@overload casecmp(other)
@return [-1, 0, +1, nil];T;%0;"@e;'F;)o;*;+T;,i*$;-i.$;.@d; I"static VALUE;T;/I"static VALUE
sym_casecmp(VALUE sym, VALUE other)
{
if (!SYMBOL_P(other)) {
return Qnil;
}
return rb_str_casecmp(rb_sym2str(sym), rb_sym2str(other));
};T;0To;
; F; ;
;;;I"Symbol#=~;F;[[I"
other;T0;[[@)iC$;T;;o;0;[ ;{ ;IC;"*Returns sym.to_s =~ obj.
;T;[o;
; I"
overload;F; 0;;o; 0; I" =~(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;TI"nil;T;"@f;#[ ;$I"@return [Fixnum, nil];T;%0;"@f;&0;'F;(i ;[[I"obj;T0;"@fo;
; I"
overload;F; 0;;^; 0; I"match(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;TI"nil;T;"@f;#[ ;$I"@return [Fixnum, nil];T;%0;"@f;&0;'F;(i ;[[I"obj;T0;"@f;#[ ;$I"~Returns sym.to_s =~ obj.
@overload =~(obj)
@return [Fixnum, nil]
@overload match(obj)
@return [Fixnum, nil];T;%0;"@f;'F;)o;*;+T;,i;$;-iA$;.@d; I"static VALUE;T;/I"hstatic VALUE
sym_match(VALUE sym, VALUE other)
{
return rb_str_match(rb_sym2str(sym), other);
};T;0To;
; F; ;
;;;I"Symbol#[];F;[[@0;[[@)iS$;T;;V;0;[ ;{ ;IC;"%Returns sym.to_s[].
;T;[ o;
; I"
overload;F; 0;;V; 0; I" [](idx);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@4f;#[ ;$I"@return [String];T;%0;"@4f;&0;'F;(i ;[[I"idx;T0;"@4fo;
; I"
overload;F; 0;;V; 0; I"
[](b, n);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@4f;#[ ;$I"@return [String];T;%0;"@4f;&0;'F;(i ;[[I"b;T0[I"n;T0;"@4fo;
; I"
overload;F; 0;;W; 0; I"slice(idx);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@4f;#[ ;$I"@return [String];T;%0;"@4f;&0;'F;(i ;[[I"idx;T0;"@4fo;
; I"
overload;F; 0;;W; 0; I"slice(b, n);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@4f;#[ ;$I"@return [String];T;%0;"@4f;&0;'F;(i ;[[I"b;T0[I"n;T0;"@4f;#[ ;$I"Returns sym.to_s[].
@overload [](idx)
@return [String]
@overload [](b, n)
@return [String]
@overload slice(idx)
@return [String]
@overload slice(b, n)
@return [String];T;%0;"@4f;'F;)o;*;+T;,iI$;-iS$;.@d; I"static VALUE;T;/I"wstatic VALUE
sym_aref(int argc, VALUE *argv, VALUE sym)
{
return rb_str_aref_m(argc, argv, rb_sym2str(sym));
};T;0To;
; F; ;
;;;I"Symbol#slice;F;[[@0;[[@)iS$;T;;W;0;[ ;{ ;IC;"%Returns sym.to_s[].
;T;[ o;
; I"
overload;F; 0;;V; 0; I" [](idx);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@f;#[ ;$I"@return [String];T;%0;"@f;&0;'F;(i ;[[I"idx;T0;"@fo;
; I"
overload;F; 0;;V; 0; I"
[](b, n);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@f;#[ ;$I"@return [String];T;%0;"@f;&0;'F;(i ;[[I"b;T0[I"n;T0;"@fo;
; I"
overload;F; 0;;W; 0; I"slice(idx);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@f;#[ ;$I"@return [String];T;%0;"@f;&0;'F;(i ;[[I"idx;T0;"@fo;
; I"
overload;F; 0;;W; 0; I"slice(b, n);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@f;#[ ;$I"@return [String];T;%0;"@f;&0;'F;(i ;[[I"b;T0[I"n;T0;"@f;#[ ;$@f;%0;"@f;'F;)o;*;+T;,iI$;-iS$;.@d; I"static VALUE;T;/I"wstatic VALUE
sym_aref(int argc, VALUE *argv, VALUE sym)
{
return rb_str_aref_m(argc, argv, rb_sym2str(sym));
};T;0To;
; F; ;
;;;I"Symbol#length;F;[ ;[[@)ia$;T;;Z;0;[ ;{ ;IC;"*Same as sym.to_s.length.
;T;[o;
; I"
overload;F; 0;;Z; 0; I" length;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@f;#[ ;$I"@return [Integer];T;%0;"@f;&0;'F;(i ;[ ;"@fo;
; I"
overload;F; 0;;[; 0; I" size;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@f;#[ ;$I"@return [Integer];T;%0;"@f;&0;'F;(i ;[ ;"@f;#[ ;$I"tSame as sym.to_s.length.
@overload length
@return [Integer]
@overload size
@return [Integer];T;%0;"@f;'F;)o;*;+T;,iY$;-i_$;.@d; I"static VALUE;T;/I"Vstatic VALUE
sym_length(VALUE sym)
{
return rb_str_length(rb_sym2str(sym));
};T;0To;
; F; ;
;;;I"Symbol#size;F;[ ;[[@)ia$;T;;[;0;[ ;{ ;IC;"*Same as sym.to_s.length.
;T;[o;
; I"
overload;F; 0;;Z; 0; I" length;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@f;#[ ;$I"@return [Integer];T;%0;"@f;&0;'F;(i ;[ ;"@fo;
; I"
overload;F; 0;;[; 0; I" size;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@f;#[ ;$I"@return [Integer];T;%0;"@f;&0;'F;(i ;[ ;"@f;#[ ;$@f;%0;"@f;'F;)o;*;+T;,iY$;-i_$;.@d; I"static VALUE;T;/I"Vstatic VALUE
sym_length(VALUE sym)
{
return rb_str_length(rb_sym2str(sym));
};T;0To;
; F; ;
;;;I"Symbol#empty?;F;[ ;[[@)in$;T;;];0;[ ;{ ;IC;"&Returns that _sym_ is :"" or not.
;T;[o;
; I"
overload;F; 0;;]; 0; I" empty?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@ g;#[ ;$I"@return [Boolean];T;%0;"@ g;&0;'F;(i ;[ ;"@ go;!
; I" return;F; @;0; [@;"@ g;#[ ;$I"MReturns that _sym_ is :"" or not.
@overload empty?
@return [Boolean];T;%0;"@ g;'F;)o;*;+T;,ig$;-ik$;.@d; I"static VALUE;T;/I"Tstatic VALUE
sym_empty(VALUE sym)
{
return rb_str_empty(rb_sym2str(sym));
};T;0To;
; F; ;
;;;I"Symbol#match;F;[[I"
other;T0;[[@)iC$;T;;^;0;[ ;{ ;IC;"*Returns sym.to_s =~ obj.
;T;[o;
; I"
overload;F; 0;;o; 0; I" =~(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;TI"nil;T;"@>g;#[ ;$I"@return [Fixnum, nil];T;%0;"@>g;&0;'F;(i ;[[I"obj;T0;"@>go;
; I"
overload;F; 0;;^; 0; I"match(obj);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Fixnum;TI"nil;T;"@>g;#[ ;$I"@return [Fixnum, nil];T;%0;"@>g;&0;'F;(i ;[[I"obj;T0;"@>g;#[ ;$@0f;%0;"@>g;'F;)o;*;+T;,i;$;-iA$;.@d; I"static VALUE;T;/I"hstatic VALUE
sym_match(VALUE sym, VALUE other)
{
return rb_str_match(rb_sym2str(sym), other);
};T;0To;
; F; ;
;;;I"Symbol#upcase;F;[ ;[[@)i{$;T;;k;0;[ ;{ ;IC;"1Same as sym.to_s.upcase.intern.
;T;[o;
; I"
overload;F; 0;;k; 0; I" upcase;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@mg;&0;'F;(i ;[ ;"@mg;#[ ;$I"DSame as sym.to_s.upcase.intern.
@overload upcase;T;%0;"@mg;'F;)o;*;+T;,it$;-iw$;.@d; I"static VALUE;T;/I"estatic VALUE
sym_upcase(VALUE sym)
{
return rb_str_intern(rb_str_upcase(rb_sym2str(sym)));
};T;0To;
; F; ;
;;;I"Symbol#downcase;F;[ ;[[@)i$;T;;l;0;[ ;{ ;IC;"3Same as sym.to_s.downcase.intern.
;T;[o;
; I"
overload;F; 0;;l; 0; I"
downcase;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@g;&0;'F;(i ;[ ;"@g;#[ ;$I"HSame as sym.to_s.downcase.intern.
@overload downcase;T;%0;"@g;'F;)o;*;+T;,i$;-i$;.@d; I"static VALUE;T;/I"istatic VALUE
sym_downcase(VALUE sym)
{
return rb_str_intern(rb_str_downcase(rb_sym2str(sym)));
};T;0To;
; F; ;
;;;I"Symbol#capitalize;F;[ ;[[@)i$;T;;m;0;[ ;{ ;IC;"5Same as sym.to_s.capitalize.intern.
;T;[o;
; I"
overload;F; 0;;m; 0; I"capitalize;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@g;&0;'F;(i ;[ ;"@g;#[ ;$I"LSame as sym.to_s.capitalize.intern.
@overload capitalize;T;%0;"@g;'F;)o;*;+T;,i$;-i$;.@d; I"static VALUE;T;/I"mstatic VALUE
sym_capitalize(VALUE sym)
{
return rb_str_intern(rb_str_capitalize(rb_sym2str(sym)));
};T;0To;
; F; ;
;;;I"Symbol#swapcase;F;[ ;[[@)i$;T;;n;0;[ ;{ ;IC;"3Same as sym.to_s.swapcase.intern.
;T;[o;
; I"
overload;F; 0;;n; 0; I"
swapcase;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@g;&0;'F;(i ;[ ;"@g;#[ ;$I"HSame as sym.to_s.swapcase.intern.
@overload swapcase;T;%0;"@g;'F;)o;*;+T;,i$;-i$;.@d; I"static VALUE;T;/I"istatic VALUE
sym_swapcase(VALUE sym)
{
return rb_str_intern(rb_str_swapcase(rb_sym2str(sym)));
};T;0To;
; F; ;
;;;I"Symbol#encoding;F;[ ;[[@)i$;T;;;0;[ ;{ ;IC;"GReturns the Encoding object that represents the encoding of _sym_.
;T;[o;
; I"
overload;F; 0;;; 0; I"
encoding;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Encoding;T;"@g;#[ ;$I"@return [Encoding];T;%0;"@g;&0;'F;(i ;[ ;"@g;#[ ;$I"qReturns the Encoding object that represents the encoding of _sym_.
@overload encoding
@return [Encoding];T;%0;"@g;'F;)o;*;+T;,i$;-i$;.@d; I"static VALUE;T;/I"Zstatic VALUE
sym_encoding(VALUE sym)
{
return rb_obj_encoding(rb_sym2str(sym));
};T;0T;N@d;OIC;[ ;N@d;PIC;[@];N@d;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@)i9#[@)is%;T;: Symbol;;X;;;[ ;{ ;IC;"********************************************************************
Symbol objects represent names and some strings
inside the Ruby
interpreter. They are generated using the :name and
:"string" literals
syntax, and by the various to_sym methods. The same
Symbol object will be created for a given name or string
for the duration of a program's execution, regardless of the context
or meaning of that name. Thus if Fred is a constant in
one context, a method in another, and a class in a third, the
Symbol :Fred will be the same object in
all three contexts.
module One
class Fred
end
$f1 = :Fred
end
module Two
Fred = 1
$f2 = :Fred
end
def Fred()
end
$f3 = :Fred
$f1.object_id #=> 2514190
$f2.object_id #=> 2514190
$f3.object_id #=> 2514190;T;[ ;#[ ;$I"********************************************************************
Symbol objects represent names and some strings
inside the Ruby
interpreter. They are generated using the :name and
:"string" literals
syntax, and by the various to_sym methods. The same
Symbol object will be created for a given name or string
for the duration of a program's execution, regardless of the context
or meaning of that name. Thus if Fred is a constant in
one context, a method in another, and a class in a third, the
Symbol :Fred will be the same object in
all three contexts.
module One
class Fred
end
$f1 = :Fred
end
module Two
Fred = 1
$f2 = :Fred
end
def Fred()
end
$f3 = :Fred
$f1.object_id #=> 2514190
$f2.object_id #=> 2514190
$f3.object_id #=> 2514190
;T;%0;"@d;'F;(i ;)o;*;+T;,i9#;-iW#;.@;I" Symbol;F;Y@No; ;IC;[ o;
; F; ;
;;;I"Encoding#to_s;F;[ ;[[@:it;T;;I;0;[ ;{ ;IC;"OReturns the name of the encoding.
Encoding::UTF_8.name #=> "UTF-8"
;T;[o;
; I"
overload;F; 0;;j; 0; I" name;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@g;#[ ;$I"@return [String];T;%0;"@g;&0;'F;(i ;[ ;"@go;
; I"
overload;F; 0;;I; 0; I" to_s;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@g;#[ ;$I"@return [String];T;%0;"@g;&0;'F;(i ;[ ;"@g;#[ ;$I"Returns the name of the encoding.
Encoding::UTF_8.name #=> "UTF-8"
@overload name
@return [String]
@overload to_s
@return [String];T;%0;"@g;'F;)o;*;+T;,ik;-is;.@g; I"static VALUE;T;/I"qstatic VALUE
enc_name(VALUE self)
{
return rb_fstring_cstr(rb_enc_name((rb_encoding*)DATA_PTR(self)));
};T;0To;
; F; ;
;;;I"Encoding#inspect;F;[ ;[[@:iY;T;;J;0;[ ;{ ;IC;"Returns a string which represents the encoding for programmers.
Encoding::UTF_8.inspect #=> "#"
Encoding::ISO_2022_JP.inspect #=> "#"
;T;[o;
; I"
overload;F; 0;;J; 0; I" inspect;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@ h;#[ ;$I"@return [String];T;%0;"@ h;&0;'F;(i ;[ ;"@ h;#[ ;$I"Returns a string which represents the encoding for programmers.
Encoding::UTF_8.inspect #=> "#"
Encoding::ISO_2022_JP.inspect #=> "#"
@overload inspect
@return [String];T;%0;"@ h;'F;)o;*;+T;,iP;-iW;.@g; I"static VALUE;T;/I"static VALUE
enc_inspect(VALUE self)
{
rb_encoding *enc;
if (!is_data_encoding(self)) {
not_encoding(self);
}
if (!(enc = DATA_PTR(self)) || rb_enc_from_index(rb_enc_to_index(enc)) != enc) {
rb_raise(rb_eTypeError, "broken Encoding");
}
return rb_enc_sprintf(rb_usascii_encoding(),
"#<%"PRIsVALUE":%s%s%s>", rb_obj_class(self),
rb_enc_name(enc),
(ENC_DUMMY_P(enc) ? " (dummy)" : ""),
enc_autoload_p(enc) ? " (autoload)" : "");
};T;0To;
; F; ;
;;;I"Encoding#name;F;[ ;[[@:it;T;;j;0;[ ;{ ;IC;"OReturns the name of the encoding.
Encoding::UTF_8.name #=> "UTF-8"
;T;[o;
; I"
overload;F; 0;;j; 0; I" name;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@7h;#[ ;$I"@return [String];T;%0;"@7h;&0;'F;(i ;[ ;"@7ho;
; I"
overload;F; 0;;I; 0; I" to_s;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@7h;#[ ;$I"@return [String];T;%0;"@7h;&0;'F;(i ;[ ;"@7h;#[ ;$@h;%0;"@7h;'F;)o;*;+T;,ik;-is;.@g; I"static VALUE;T;/I"qstatic VALUE
enc_name(VALUE self)
{
return rb_fstring_cstr(rb_enc_name((rb_encoding*)DATA_PTR(self)));
};T;0To;
; F; ;
;;;I"Encoding#names;F;[ ;[[@:i;T;:
names;0;[ ;{ ;IC;"Returns the list of name and aliases of the encoding.
Encoding::WINDOWS_31J.names #=> ["Windows-31J", "CP932", "csWindows31J"]
;T;[o;
; I"
overload;F; 0;;; 0; I"
names;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@^h;#[ ;$I"@return [Array];T;%0;"@^h;&0;'F;(i ;[ ;"@^h;#[ ;$I"Returns the list of name and aliases of the encoding.
Encoding::WINDOWS_31J.names #=> ["Windows-31J", "CP932", "csWindows31J"]
@overload names
@return [Array];T;%0;"@^h;'F;)o;*;+T;,i;-i;.@g; I"static VALUE;T;/I"static VALUE
enc_names(VALUE self)
{
VALUE args[2];
args[0] = (VALUE)rb_to_encoding_index(self);
args[1] = rb_ary_new2(0);
st_foreach(enc_table.names, enc_names_i, (st_data_t)args);
return args[1];
};T;0To;
; F; ;
;;;I"Encoding#dummy?;F;[ ;[[@:i;T;: dummy?;0;[ ;{ ;IC;"Returns true for dummy encodings.
A dummy encoding is an encoding for which character handling is not properly
implemented.
It is used for stateful encodings.
Encoding::ISO_2022_JP.dummy? #=> true
Encoding::UTF_8.dummy? #=> false
;T;[o;
; I"
overload;F; 0;;; 0; I" dummy?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@yh;#[ ;$I"@return [Boolean];T;%0;"@yh;&0;'F;(i ;[ ;"@yho;!
; I" return;F; @;0; [@;"@yh;#[ ;$I"$Returns true for dummy encodings.
A dummy encoding is an encoding for which character handling is not properly
implemented.
It is used for stateful encodings.
Encoding::ISO_2022_JP.dummy? #=> true
Encoding::UTF_8.dummy? #=> false
@overload dummy?
@return [Boolean];T;%0;"@yh;'F;)o;*;+T;,i;-i;.@g; I"static VALUE;T;/I"istatic VALUE
enc_dummy_p(VALUE enc)
{
return ENC_DUMMY_P(must_encoding(enc)) ? Qtrue : Qfalse;
};T;0To;
; F; ;
;;;I" Encoding#ascii_compatible?;F;[ ;[[@:i;T;:ascii_compatible?;0;[ ;{ ;IC;"Returns whether ASCII-compatible or not.
Encoding::UTF_8.ascii_compatible? #=> true
Encoding::UTF_16BE.ascii_compatible? #=> false
;T;[o;
; I"
overload;F; 0;;; 0; I"ascii_compatible?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@h;#[ ;$I"@return [Boolean];T;%0;"@h;&0;'F;(i ;[ ;"@ho;!
; I" return;F; @;0; [@;"@h;#[ ;$I"Returns whether ASCII-compatible or not.
Encoding::UTF_8.ascii_compatible? #=> true
Encoding::UTF_16BE.ascii_compatible? #=> false
@overload ascii_compatible?
@return [Boolean];T;%0;"@h;'F;)o;*;+T;,i;-i;.@g; I"static VALUE;T;/I"{static VALUE
enc_ascii_compatible_p(VALUE enc)
{
return rb_enc_asciicompat(must_encoding(enc)) ? Qtrue : Qfalse;
};T;0To;
; F; ;
;;;I"Encoding#replicate;F;[[I" name;T0;[[@:i;T;:replicate;0;[ ;{ ;IC;"Returns a replicated encoding of _enc_ whose name is _name_.
The new encoding should have the same byte structure of _enc_.
If _name_ is used by another encoding, raise ArgumentError.
;T;[o;
; I"
overload;F; 0;;; 0; I"replicate(name);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Encoding;T;"@h;#[ ;$I"@return [Encoding];T;%0;"@h;&0;'F;(i ;[[I" name;T0;"@h;#[ ;$I"Returns a replicated encoding of _enc_ whose name is _name_.
The new encoding should have the same byte structure of _enc_.
If _name_ is used by another encoding, raise ArgumentError.
@overload replicate(name)
@return [Encoding];T;%0;"@h;'F;)o;*;+T;,i;-i;.@g; I"static VALUE;T;/I"static VALUE
enc_replicate(VALUE encoding, VALUE name)
{
return rb_enc_from_encoding_index(
rb_enc_replicate(StringValueCStr(name),
rb_to_encoding(encoding)));
};T;0To;
; F; ;S;;;I"Encoding.list;F;[ ;[[@:i;T;: list;0;[ ;{ ;IC;"KReturns the list of loaded encodings.
Encoding.list
#=> [#, #,
#]
Encoding.find("US-ASCII")
#=> #
Encoding.list
#=> [#, #,
#, #]
;T;[o;
; I"
overload;F; 0;;; 0; I" list;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@h;#[ ;$I"@return [Array];T;%0;"@h;&0;'F;(i ;[ ;"@h;#[ ;$I"oReturns the list of loaded encodings.
Encoding.list
#=> [#, #,
#]
Encoding.find("US-ASCII")
#=> #
Encoding.list
#=> [#, #,
#, #]
@overload list
@return [Array];T;%0;"@h;'F;)o;*;+T;,i;-i;.@g; I"static VALUE;T;/I"static VALUE
enc_list(VALUE klass)
{
VALUE ary = rb_ary_new2(0);
rb_ary_replace(ary, rb_encoding_list);
return ary;
};T;0To;
; F; ;S;;;I"Encoding.name_list;F;[ ;[[@:i};T;:name_list;0;[ ;{ ;IC;"Returns the list of available encoding names.
Encoding.name_list
#=> ["US-ASCII", "ASCII-8BIT", "UTF-8",
"ISO-8859-1", "Shift_JIS", "EUC-JP",
"Windows-31J",
"BINARY", "CP932", "eucJP"]
;T;[o;
; I"
overload;F; 0;;; 0; I"name_list;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@h;#[ ;$I"@return [Array];T;%0;"@h;&0;'F;(i ;[ ;"@h;#[ ;$I"Returns the list of available encoding names.
Encoding.name_list
#=> ["US-ASCII", "ASCII-8BIT", "UTF-8",
"ISO-8859-1", "Shift_JIS", "EUC-JP",
"Windows-31J",
"BINARY", "CP932", "eucJP"]
@overload name_list
@return [Array];T;%0;"@h;'F;)o;*;+T;,io;-iz;.@g; I"static VALUE;T;/I"static VALUE
rb_enc_name_list(VALUE klass)
{
VALUE ary = rb_ary_new2(enc_table.names->num_entries);
st_foreach(enc_table.names, rb_enc_name_list_i, (st_data_t)ary);
return ary;
};T;0To;
; F; ;S;;;I"Encoding.aliases;F;[ ;[[@:i;T;: aliases;0;[ ;{ ;IC;"Returns the hash of available encoding alias and original encoding name.
Encoding.aliases
#=> {"BINARY"=>"ASCII-8BIT", "ASCII"=>"US-ASCII", "ANSI_X3.4-1986"=>"US-ASCII",
"SJIS"=>"Shift_JIS", "eucJP"=>"EUC-JP", "CP932"=>"Windows-31J"}
;T;[o;
; I"
overload;F; 0;;; 0; I" aliases;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@
i;&0;'F;(i ;[ ;"@
i;#[ ;$I" Returns the hash of available encoding alias and original encoding name.
Encoding.aliases
#=> {"BINARY"=>"ASCII-8BIT", "ASCII"=>"US-ASCII", "ANSI_X3.4-1986"=>"US-ASCII",
"SJIS"=>"Shift_JIS", "eucJP"=>"EUC-JP", "CP932"=>"Windows-31J"}
@overload aliases;T;%0;"@
i;'F;)o;*;+T;,i;-i;.@g; I"static VALUE;T;/I"static VALUE
rb_enc_aliases(VALUE klass)
{
VALUE aliases[2];
aliases[0] = rb_hash_new();
aliases[1] = rb_ary_new();
st_foreach(enc_table.names, rb_enc_aliases_enc_i, (st_data_t)aliases);
return aliases[0];
};T;0To;
; F; ;S;;;I"Encoding.find;F;[[I"enc;T0;[[@:i;T;;;0;[ ;{ ;IC;"\Search the encoding with specified name.
name should be a string.
Encoding.find("US-ASCII") #=> #
Names which this method accept are encoding names and aliases
including following special aliases
"external":: default external encoding
"internal":: default internal encoding
"locale":: locale encoding
"filesystem":: filesystem encoding
An ArgumentError is raised when no encoding with name.
Only Encoding.find("internal") however returns nil
when no encoding named "internal", in other words, when Ruby has no
default internal encoding.
;T;[o;
; I"
overload;F; 0;;; 0; I"find(string);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ i;&0;'F;(i ;[[I" string;T0;"@ i;#[ ;$I"uSearch the encoding with specified name.
name should be a string.
Encoding.find("US-ASCII") #=> #
Names which this method accept are encoding names and aliases
including following special aliases
"external":: default external encoding
"internal":: default internal encoding
"locale":: locale encoding
"filesystem":: filesystem encoding
An ArgumentError is raised when no encoding with name.
Only Encoding.find("internal") however returns nil
when no encoding named "internal", in other words, when Ruby has no
default internal encoding.
@overload find(string);T;%0;"@ i;'F;)o;*;+T;,i;-i;.@g; I"static VALUE;T;/I"static VALUE
enc_find(VALUE klass, VALUE enc)
{
int idx;
if (is_obj_encoding(enc))
return enc;
idx = str_to_encindex(enc);
if (idx == UNSPECIFIED_ENCODING) return Qnil;
return rb_enc_from_encoding_index(idx);
};T;0To;
; F; ;S;;;I"Encoding.compatible?;F;[[I" str1;T0[I" str2;T0;[[@:i;T;:compatible?;0;[ ;{ ;IC;"iChecks the compatibility of two objects.
If the objects are both strings they are compatible when they are
concatenatable. The encoding of the concatenated string will be returned
if they are compatible, nil if they are not.
Encoding.compatible?("\xa1".force_encoding("iso-8859-1"), "b")
#=> #
Encoding.compatible?(
"\xa1".force_encoding("iso-8859-1"),
"\xa1\xa1".force_encoding("euc-jp"))
#=> nil
If the objects are non-strings their encodings are compatible when they
have an encoding and:
* Either encoding is US-ASCII compatible
* One of the encodings is a 7-bit encoding
;T;[o;
; I"
overload;F; 0;;; 0; I" compatible?(obj1, obj2);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@:i;#[ ;$I"@return [nil];T;%0;"@:i;&0;'F;(i ;[[I" obj1;T0[I" obj2;T0;"@:io;!
; I" return;F; @;0; [@;"@:i;#[ ;$I"Checks the compatibility of two objects.
If the objects are both strings they are compatible when they are
concatenatable. The encoding of the concatenated string will be returned
if they are compatible, nil if they are not.
Encoding.compatible?("\xa1".force_encoding("iso-8859-1"), "b")
#=> #
Encoding.compatible?(
"\xa1".force_encoding("iso-8859-1"),
"\xa1\xa1".force_encoding("euc-jp"))
#=> nil
If the objects are non-strings their encodings are compatible when they
have an encoding and:
* Either encoding is US-ASCII compatible
* One of the encodings is a 7-bit encoding
@overload compatible?(obj1, obj2)
@return [nil];T;%0;"@:i;'F;)o;*;+T;,i;-i;.@g; I"static VALUE;T;/I"static VALUE
enc_compatible_p(VALUE klass, VALUE str1, VALUE str2)
{
rb_encoding *enc;
if (!enc_capable(str1)) return Qnil;
if (!enc_capable(str2)) return Qnil;
enc = rb_enc_compatible(str1, str2);
if (!enc) return Qnil;
return rb_enc_from_encoding(enc);
};T;0To;
; F; ;
;;;I"Encoding#_dump;F;[[@0;[[@:i;T;;f;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@`i;'F;)o;*;+T;,i;-i;.@g; I"static VALUE;T;/I"|static VALUE
enc_dump(int argc, VALUE *argv, VALUE self)
{
rb_check_arity(argc, 0, 1);
return enc_name(self);
};T;0To;
; F; ;S;;;I"Encoding._load;F;[[I"str;T0;[[@:i
;T;;g;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@oi;'F;)o;*;+T;,i ;-i ;.@g; I"static VALUE;T;/I"Fstatic VALUE
enc_load(VALUE klass, VALUE str)
{
return str;
};T;0To;
; F; ;S;;;I" Encoding.default_external;F;[ ;[[@:i;T;:default_external;0;[ ;{ ;IC;"7Returns default external encoding.
The default external encoding is used by default for strings created from
the following locations:
* CSV
* File data read from disk
* SDBM
* StringIO
* Zlib::GzipReader
* Zlib::GzipWriter
* String#inspect
* Regexp#inspect
While strings created from these locations will have this encoding, the
encoding may not be valid. Be sure to check String#valid_encoding?.
File data written to disk will be transcoded to the default external
encoding when written.
The default external encoding is initialized by the locale or -E option.
;T;[o;
; I"
overload;F; 0;;; 0; I"default_external;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@i;&0;'F;(i ;[ ;"@i;#[ ;$I"TReturns default external encoding.
The default external encoding is used by default for strings created from
the following locations:
* CSV
* File data read from disk
* SDBM
* StringIO
* Zlib::GzipReader
* Zlib::GzipWriter
* String#inspect
* Regexp#inspect
While strings created from these locations will have this encoding, the
encoding may not be valid. Be sure to check String#valid_encoding?.
File data written to disk will be transcoded to the default external
encoding when written.
The default external encoding is initialized by the locale or -E option.
@overload default_external;T;%0;"@i;'F;)o;*;+T;,i;-i;.@g; I"static VALUE;T;/I"]static VALUE
get_default_external(VALUE klass)
{
return rb_enc_default_external();
};T;0To;
; F; ;S;;;I" Encoding.default_external=;F;[[I"
encoding;T0;[[@:i;T;:default_external=;0;[ ;{ ;IC;"Sets default external encoding. You should not set
Encoding::default_external in ruby code as strings created before changing
the value may have a different encoding from strings created after the value
was changed., instead you should use ruby -E to invoke ruby with
the correct default_external.
See Encoding::default_external for information on how the default external
encoding is used.
;T;[o;
; I"
overload;F; 0;;; 0; I"default_external=(enc);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@i;&0;'F;(i ;[[I"enc;T0;"@i;#[ ;$I"Sets default external encoding. You should not set
Encoding::default_external in ruby code as strings created before changing
the value may have a different encoding from strings created after the value
was changed., instead you should use ruby -E to invoke ruby with
the correct default_external.
See Encoding::default_external for information on how the default external
encoding is used.
@overload default_external=(enc);T;%0;"@i;'F;)o;*;+T;,i;-i;.@g; I"static VALUE;T;/I"static VALUE
set_default_external(VALUE klass, VALUE encoding)
{
rb_warning("setting Encoding.default_external");
rb_enc_set_default_external(encoding);
return encoding;
};T;0To;
; F; ;S;;;I" Encoding.default_internal;F;[ ;[[@:i;T;:default_internal;0;[ ;{ ;IC;"Returns default internal encoding. Strings will be transcoded to the
default internal encoding in the following places if the default internal
encoding is not nil:
* CSV
* Etc.sysconfdir and Etc.systmpdir
* File data read from disk
* File names from Dir
* Integer#chr
* String#inspect and Regexp#inspect
* Strings returned from Readline
* Strings returned from SDBM
* Time#zone
* Values from ENV
* Values in ARGV including $PROGRAM_NAME
Additionally String#encode and String#encode! use the default internal
encoding if no encoding is given.
The locale encoding (__ENCODING__), not default_internal, is used as the
encoding of created strings.
Encoding::default_internal is initialized by the source file's
internal_encoding or -E option.
;T;[o;
; I"
overload;F; 0;;; 0; I"default_internal;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@i;&0;'F;(i ;[ ;"@i;#[ ;$I"Returns default internal encoding. Strings will be transcoded to the
default internal encoding in the following places if the default internal
encoding is not nil:
* CSV
* Etc.sysconfdir and Etc.systmpdir
* File data read from disk
* File names from Dir
* Integer#chr
* String#inspect and Regexp#inspect
* Strings returned from Readline
* Strings returned from SDBM
* Time#zone
* Values from ENV
* Values in ARGV including $PROGRAM_NAME
Additionally String#encode and String#encode! use the default internal
encoding if no encoding is given.
The locale encoding (__ENCODING__), not default_internal, is used as the
encoding of created strings.
Encoding::default_internal is initialized by the source file's
internal_encoding or -E option.
@overload default_internal;T;%0;"@i;'F;)o;*;+T;,i;-i;.@g; I"static VALUE;T;/I"]static VALUE
get_default_internal(VALUE klass)
{
return rb_enc_default_internal();
};T;0To;
; F; ;S;;;I" Encoding.default_internal=;F;[[I"
encoding;T0;[[@:i+;T;:default_internal=;0;[ ;{ ;IC;"Sets default internal encoding or removes default internal encoding when
passed nil. You should not set Encoding::default_internal in ruby code as
strings created before changing the value may have a different encoding
from strings created after the change. Instead you should use
ruby -E to invoke ruby with the correct default_internal.
See Encoding::default_internal for information on how the default internal
encoding is used.
;T;[o;
; I"
overload;F; 0;;; 0; I"default_internal=(enc);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@i;&0;'F;(i ;[[I"enc;T0;"@i;#[ ;$I"Sets default internal encoding or removes default internal encoding when
passed nil. You should not set Encoding::default_internal in ruby code as
strings created before changing the value may have a different encoding
from strings created after the change. Instead you should use
ruby -E to invoke ruby with the correct default_internal.
See Encoding::default_internal for information on how the default internal
encoding is used.
@overload default_internal=(enc);T;%0;"@i;'F;)o;*;+T;,i ;-i(;.@g; I"static VALUE;T;/I"static VALUE
set_default_internal(VALUE klass, VALUE encoding)
{
rb_warning("setting Encoding.default_internal");
rb_enc_set_default_internal(encoding);
return encoding;
};T;0To;
; F; ;S;;;I" Encoding.locale_charmap;F;[ ;[[I"localeinit.c;TiT;T;:locale_charmap;0;[ ;{ ;IC;" Returns the locale charmap name.
It returns nil if no appropriate information.
Debian GNU/Linux
LANG=C
Encoding.locale_charmap #=> "ANSI_X3.4-1968"
LANG=ja_JP.EUC-JP
Encoding.locale_charmap #=> "EUC-JP"
SunOS 5
LANG=C
Encoding.locale_charmap #=> "646"
LANG=ja
Encoding.locale_charmap #=> "eucJP"
The result is highly platform dependent.
So Encoding.find(Encoding.locale_charmap) may cause an error.
If you need some encoding object even for unknown locale,
Encoding.find("locale") can be used.
;T;[o;
; I"
overload;F; 0;;; 0; I"locale_charmap;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@i;#[ ;$I"@return [String];T;%0;"@i;&0;'F;(i ;[ ;"@i;#[ ;$I"OReturns the locale charmap name.
It returns nil if no appropriate information.
Debian GNU/Linux
LANG=C
Encoding.locale_charmap #=> "ANSI_X3.4-1968"
LANG=ja_JP.EUC-JP
Encoding.locale_charmap #=> "EUC-JP"
SunOS 5
LANG=C
Encoding.locale_charmap #=> "646"
LANG=ja
Encoding.locale_charmap #=> "eucJP"
The result is highly platform dependent.
So Encoding.find(Encoding.locale_charmap) may cause an error.
If you need some encoding object even for unknown locale,
Encoding.find("locale") can be used.
@overload locale_charmap
@return [String];T;%0;"@i;'F;)o;*;+T;,i;;-iR;.@g; I"
VALUE;T;/I"aVALUE
rb_locale_charmap(VALUE klass)
{
return locale_charmap(rb_usascii_str_new_cstr);
};T;0To; ;IC;[
o;
; F; ;
;;;I" UTF-8 -> EUC-JP
begin
ec.convert("\xa0") # NO-BREAK SPACE, which is available in UTF-8 but not in EUC-JP.
rescue Encoding::UndefinedConversionError
p $!.source_encoding #=> #
p $!.destination_encoding #=> #
p $!.source_encoding_name #=> "UTF-8"
p $!.destination_encoding_name #=> "EUC-JP"
end
;T;[o;
; I"
overload;F; 0;;; 0; I"source_encoding;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Encoding;T;"@3j;#[ ;$I"@return [Encoding];T;%0;"@3j;&0;'F;(i ;[ ;"@3j;#[ ;$I"Returns the source encoding as an encoding object.
Note that the result may not be equal to the source encoding of
the encoding converter if the conversion has multiple steps.
ec = Encoding::Converter.new("ISO-8859-1", "EUC-JP") # ISO-8859-1 -> UTF-8 -> EUC-JP
begin
ec.convert("\xa0") # NO-BREAK SPACE, which is available in UTF-8 but not in EUC-JP.
rescue Encoding::UndefinedConversionError
p $!.source_encoding #=> #
p $!.destination_encoding #=> #
p $!.source_encoding_name #=> "UTF-8"
p $!.destination_encoding_name #=> "EUC-JP"
end
@overload source_encoding
@return [Encoding];T;%0;"@3j;'F;)o;*;+T;,i;-i;.@i; I"static VALUE;T;/I"sstatic VALUE
ecerr_source_encoding(VALUE self)
{
return rb_attr_get(self, rb_intern("source_encoding"));
};T;0To;
; F; ;
;;;I" "\xC2\xA0"
p $!.error_char.encoding #=> #
end
;T;[o;
; I"
overload;F; 0;;; 0; I"error_char;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@ij;#[ ;$I"@return [String];T;%0;"@ij;&0;'F;(i ;[ ;"@ij;#[ ;$I"^Returns the one-character string which cause Encoding::UndefinedConversionError.
ec = Encoding::Converter.new("ISO-8859-1", "EUC-JP")
begin
ec.convert("\xa0")
rescue Encoding::UndefinedConversionError
puts $!.error_char.dump #=> "\xC2\xA0"
p $!.error_char.encoding #=> #
end
@overload error_char
@return [String];T;%0;"@ij;'F;)o;*;+T;,i;-i;.@i; I"static VALUE;T;/I"istatic VALUE
ecerr_error_char(VALUE self)
{
return rb_attr_get(self, rb_intern("error_char"));
};T;0T;N@i;OIC;[ ;N@i;PIC;[ ;N@i;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@:i#[@:ib;T;: UndefinedConversionError;;X;;;[ ;{ ;IC;"NRaised by Encoding and String methods when a transcoding operation
fails.;T;[ ;#[ ;$I"P
Raised by Encoding and String methods when a transcoding operation
fails.
;T;%0;"@i;'F;(i ;)o;*;+T;,i#;-i&;.o;Z ;[0;\0;]0;:
Encoding;.@;_@g;0;I"'Encoding::UndefinedConversionError;F;Y@bo; ;IC;[ o;
; F; ;
;;;I" UTF-8 -> EUC-JP
begin
ec.convert("\xa0") # NO-BREAK SPACE, which is available in UTF-8 but not in EUC-JP.
rescue Encoding::UndefinedConversionError
p $!.source_encoding #=> #
p $!.destination_encoding #=> #
p $!.source_encoding_name #=> "UTF-8"
p $!.destination_encoding_name #=> "EUC-JP"
end
;T;[o;
; I"
overload;F; 0;;; 0; I"source_encoding;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Encoding;T;"@j;#[ ;$I"@return [Encoding];T;%0;"@j;&0;'F;(i ;[ ;"@j;#[ ;$@Jj;%0;"@j;'F;)o;*;+T;,i;-i;.@j; I"static VALUE;T;/I"sstatic VALUE
ecerr_source_encoding(VALUE self)
{
return rb_attr_get(self, rb_intern("source_encoding"));
};T;0To;
; F; ;
;;;I" #
puts $!.error_bytes.dump #=> "\xA1"
puts $!.readagain_bytes.dump #=> "\xFF"
end
;T;[o;
; I"
overload;F; 0;;; 0; I"error_bytes;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@k;#[ ;$I"@return [String];T;%0;"@k;&0;'F;(i ;[ ;"@k;#[ ;$I"Returns the discarded bytes when Encoding::InvalidByteSequenceError occurs.
ec = Encoding::Converter.new("EUC-JP", "ISO-8859-1")
begin
ec.convert("abc\xA1\xFFdef")
rescue Encoding::InvalidByteSequenceError
p $! #=> #
puts $!.error_bytes.dump #=> "\xA1"
puts $!.readagain_bytes.dump #=> "\xFF"
end
@overload error_bytes
@return [String];T;%0;"@k;'F;)o;*;+T;,i;-i;.@j; I"static VALUE;T;/I"kstatic VALUE
ecerr_error_bytes(VALUE self)
{
return rb_attr_get(self, rb_intern("error_bytes"));
};T;0To;
; F; ;
;;;I"7Encoding::InvalidByteSequenceError#readagain_bytes;F;[ ;[[@:i;T;:readagain_bytes;0;[ ;{ ;IC;"WReturns the bytes to be read again when Encoding::InvalidByteSequenceError occurs.
;T;[o;
; I"
overload;F; 0;;; 0; I"readagain_bytes;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@ k;#[ ;$I"@return [String];T;%0;"@ k;&0;'F;(i ;[ ;"@ k;#[ ;$I"Returns the bytes to be read again when Encoding::InvalidByteSequenceError occurs.
@overload readagain_bytes
@return [String];T;%0;"@ k;'F;)o;*;+T;,i;-i;.@j; I"static VALUE;T;/I"sstatic VALUE
ecerr_readagain_bytes(VALUE self)
{
return rb_attr_get(self, rb_intern("readagain_bytes"));
};T;0To;
; F; ;
;;;I"9Encoding::InvalidByteSequenceError#incomplete_input?;F;[ ;[[@:i ;T;:incomplete_input?;0;[ ;{ ;IC;"6Returns true if the invalid byte sequence error is caused by
premature end of string.
ec = Encoding::Converter.new("EUC-JP", "ISO-8859-1")
begin
ec.convert("abc\xA1z")
rescue Encoding::InvalidByteSequenceError
p $! #=> #
p $!.incomplete_input? #=> false
end
begin
ec.convert("abc\xA1")
ec.finish
rescue Encoding::InvalidByteSequenceError
p $! #=> #
p $!.incomplete_input? #=> true
end
;T;[o;
; I"
overload;F; 0;;; 0; I"incomplete_input?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@7k;#[ ;$I"@return [Boolean];T;%0;"@7k;&0;'F;(i ;[ ;"@7ko;!
; I" return;F; @;0; [@;"@7k;#[ ;$I"hReturns true if the invalid byte sequence error is caused by
premature end of string.
ec = Encoding::Converter.new("EUC-JP", "ISO-8859-1")
begin
ec.convert("abc\xA1z")
rescue Encoding::InvalidByteSequenceError
p $! #=> #
p $!.incomplete_input? #=> false
end
begin
ec.convert("abc\xA1")
ec.finish
rescue Encoding::InvalidByteSequenceError
p $! #=> #
p $!.incomplete_input? #=> true
end
@overload incomplete_input?
@return [Boolean];T;%0;"@7k;'F;)o;*;+T;,i;-i;.@j; I"static VALUE;T;/I"ustatic VALUE
ecerr_incomplete_input(VALUE self)
{
return rb_attr_get(self, rb_intern("incomplete_input"));
};T;0T;N@j;OIC;[ ;N@j;PIC;[ ;N@j;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@:i*[@:ic;T;: InvalidByteSequenceError;;X;;;[ ;{ ;IC;"Raised by Encoding and String methods when the string being
transcoded contains a byte invalid for the either the source or
target encoding.;T;[ ;#[ ;$I"
Raised by Encoding and String methods when the string being
transcoded contains a byte invalid for the either the source or
target encoding.
;T;%0;"@j;'F;(i ;)o;*;+T;,i*;-i.;.o;Z ;[0;\0;]0;;;.@;_@g;0;I"'Encoding::InvalidByteSequenceError;F;Y@bo; ;IC;[ ;N@hk;OIC;[ ;N@hk;PIC;[ ;N@hk;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@:i2[@:id;T;:ConverterNotFoundError;;X;;;[ ;{ ;IC;"dRaised by transcoding methods when a named encoding does not
correspond with a known converter.
;T;[ ;#[ ;$I"f
Raised by transcoding methods when a named encoding does not
correspond with a known converter.
;T;%0;"@hk;'F;)o;*;+T;,i2;-i5;.o;Z ;[0;\0;]0;;;.@;_@g;0;I"%Encoding::ConverterNotFoundError;F;Y@bo; ;IC;[#o;
; F; ;S;;;I"-Encoding::Converter.asciicompat_encoding;F;[[I"arg;T0;[[@:i ;T;:asciicompat_encoding;0;[ ;{ ;IC;"VReturns the corresponding ASCII compatible encoding.
Returns nil if the argument is an ASCII compatible encoding.
"corresponding ASCII compatible encoding" is an ASCII compatible encoding which
can represents exactly the same characters as the given ASCII incompatible encoding.
So, no conversion undefined error occurs when converting between the two encodings.
Encoding::Converter.asciicompat_encoding("ISO-2022-JP") #=> #
Encoding::Converter.asciicompat_encoding("UTF-16BE") #=> #
Encoding::Converter.asciicompat_encoding("UTF-8") #=> nil
;T;[o;
; I"
overload;F; 0;:-Encoding::Converter.asciicompat_encoding; 0; I"5Encoding::Converter.asciicompat_encoding(string);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Encoding;TI"nil;T;"@k;#[ ;$I" @return [Encoding, nil];T;%0;"@k;&0;'F;(i ;[[I" string;T0;"@ko;
; I"
overload;F; 0;;; 0; I"7Encoding::Converter.asciicompat_encoding(encoding);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Encoding;TI"nil;T;"@k;#[ ;$I" @return [Encoding, nil];T;%0;"@k;&0;'F;(i ;[[I"
encoding;T0;"@k;#[ ;$I"Returns the corresponding ASCII compatible encoding.
Returns nil if the argument is an ASCII compatible encoding.
"corresponding ASCII compatible encoding" is an ASCII compatible encoding which
can represents exactly the same characters as the given ASCII incompatible encoding.
So, no conversion undefined error occurs when converting between the two encodings.
Encoding::Converter.asciicompat_encoding("ISO-2022-JP") #=> #
Encoding::Converter.asciicompat_encoding("UTF-16BE") #=> #
Encoding::Converter.asciicompat_encoding("UTF-8") #=> nil
@overload Encoding::Converter.asciicompat_encoding(string)
@return [Encoding, nil]
@overload Encoding::Converter.asciicompat_encoding(encoding)
@return [Encoding, nil];T;%0;"@k;'F;)o;*;+T;,i ;-i ;.@}k; I"static VALUE;T;/I"static VALUE
econv_s_asciicompat_encoding(VALUE klass, VALUE arg)
{
const char *arg_name, *result_name;
rb_encoding *arg_enc, *result_enc;
enc_arg(&arg, &arg_name, &arg_enc);
result_name = rb_econv_asciicompat_encoding(arg_name);
if (result_name == NULL)
return Qnil;
result_enc = make_encoding(result_name);
return rb_enc_from_encoding(result_enc);
};T;0To;
; F; ;S;;;I"(Encoding::Converter.search_convpath;F;[[@0;[[@:iB ;T;:search_convpath;0;[ ;{ ;IC;"-Returns a conversion path.
p Encoding::Converter.search_convpath("ISO-8859-1", "EUC-JP")
#=> [[#, #],
# [#, #]]
p Encoding::Converter.search_convpath("ISO-8859-1", "EUC-JP", universal_newline: true)
or
p Encoding::Converter.search_convpath("ISO-8859-1", "EUC-JP", newline: :universal)
#=> [[#, #],
# [#, #],
# "universal_newline"]
p Encoding::Converter.search_convpath("ISO-8859-1", "UTF-32BE", universal_newline: true)
or
p Encoding::Converter.search_convpath("ISO-8859-1", "UTF-32BE", newline: :universal)
#=> [[#, #],
# "universal_newline",
# [#, #]]
;T;[o;
; I"
overload;F; 0;:(Encoding::Converter.search_convpath; 0; I"OEncoding::Converter.search_convpath(source_encoding, destination_encoding);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@k;&0;'F;(i ;[[I"source_encoding;T0[I"destination_encoding;T0;"@ko;
; I"
overload;F; 0;;; 0; I"TEncoding::Converter.search_convpath(source_encoding, destination_encoding, opt);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@k;&0;'F;(i ;[[I"source_encoding;T0[I"destination_encoding;T0[I"opt;T0;"@k;#[ ;$I" Returns a conversion path.
p Encoding::Converter.search_convpath("ISO-8859-1", "EUC-JP")
#=> [[#, #],
# [#, #]]
p Encoding::Converter.search_convpath("ISO-8859-1", "EUC-JP", universal_newline: true)
or
p Encoding::Converter.search_convpath("ISO-8859-1", "EUC-JP", newline: :universal)
#=> [[#, #],
# [#, #],
# "universal_newline"]
p Encoding::Converter.search_convpath("ISO-8859-1", "UTF-32BE", universal_newline: true)
or
p Encoding::Converter.search_convpath("ISO-8859-1", "UTF-32BE", newline: :universal)
#=> [[#, #],
# "universal_newline",
# [#, #]]
@overload Encoding::Converter.search_convpath(source_encoding, destination_encoding)
@overload Encoding::Converter.search_convpath(source_encoding, destination_encoding, opt);T;%0;"@k;'F;)o;*;+T;,i) ;-i? ;.@}k; I"static VALUE;T;/I"static VALUE
econv_s_search_convpath(int argc, VALUE *argv, VALUE klass)
{
VALUE snamev, dnamev;
const char *sname, *dname;
rb_encoding *senc, *denc;
int ecflags;
VALUE ecopts;
VALUE convpath;
econv_args(argc, argv, &snamev, &dnamev, &sname, &dname, &senc, &denc, &ecflags, &ecopts);
convpath = Qnil;
transcode_search_path(sname, dname, search_convpath_i, &convpath);
if (NIL_P(convpath))
rb_exc_raise(rb_econv_open_exc(sname, dname, ecflags));
if (decorate_convpath(convpath, ecflags) == -1) {
VALUE exc = rb_econv_open_exc(sname, dname, ecflags);
RB_GC_GUARD(snamev);
RB_GC_GUARD(dnamev);
rb_exc_raise(exc);
}
return convpath;
};T;0To;
; F; ;
;;;I"#Encoding::Converter#initialize;F;[[@0;[[@:i7
;T;;;0;[ ;{ ;IC;")possible options elements:
hash form:
:invalid => nil # raise error on invalid byte sequence (default)
:invalid => :replace # replace invalid byte sequence
:undef => nil # raise error on undefined conversion (default)
:undef => :replace # replace undefined conversion
:replace => string # replacement string ("?" or "\uFFFD" if not specified)
:newline => :universal # decorator for converting CRLF and CR to LF
:newline => :crlf # decorator for converting LF to CRLF
:newline => :cr # decorator for converting LF to CR
:universal_newline => true # decorator for converting CRLF and CR to LF
:crlf_newline => true # decorator for converting LF to CRLF
:cr_newline => true # decorator for converting LF to CR
:xml => :text # escape as XML CharData.
:xml => :attr # escape as XML AttValue
integer form:
Encoding::Converter::INVALID_REPLACE
Encoding::Converter::UNDEF_REPLACE
Encoding::Converter::UNDEF_HEX_CHARREF
Encoding::Converter::UNIVERSAL_NEWLINE_DECORATOR
Encoding::Converter::CRLF_NEWLINE_DECORATOR
Encoding::Converter::CR_NEWLINE_DECORATOR
Encoding::Converter::XML_TEXT_DECORATOR
Encoding::Converter::XML_ATTR_CONTENT_DECORATOR
Encoding::Converter::XML_ATTR_QUOTE_DECORATOR
Encoding::Converter.new creates an instance of Encoding::Converter.
Source_encoding and destination_encoding should be a string or
Encoding object.
opt should be nil, a hash or an integer.
convpath should be an array.
convpath may contain
- two-element arrays which contain encodings or encoding names, or
- strings representing decorator names.
Encoding::Converter.new optionally takes an option.
The option should be a hash or an integer.
The option hash can contain :invalid => nil, etc.
The option integer should be logical-or of constants such as
Encoding::Converter::INVALID_REPLACE, etc.
[:invalid => nil]
Raise error on invalid byte sequence. This is a default behavior.
[:invalid => :replace]
Replace invalid byte sequence by replacement string.
[:undef => nil]
Raise an error if a character in source_encoding is not defined in destination_encoding.
This is a default behavior.
[:undef => :replace]
Replace undefined character in destination_encoding with replacement string.
[:replace => string]
Specify the replacement string.
If not specified, "\uFFFD" is used for Unicode encodings and "?" for others.
[:universal_newline => true]
Convert CRLF and CR to LF.
[:crlf_newline => true]
Convert LF to CRLF.
[:cr_newline => true]
Convert LF to CR.
[:xml => :text]
Escape as XML CharData.
This form can be used as a HTML 4.0 #PCDATA.
- '&' -> '&'
- '<' -> '<'
- '>' -> '>'
- undefined characters in destination_encoding -> hexadecimal CharRef such as &#xHH;
[:xml => :attr]
Escape as XML AttValue.
The converted result is quoted as "...".
This form can be used as a HTML 4.0 attribute value.
- '&' -> '&'
- '<' -> '<'
- '>' -> '>'
- '"' -> '"'
- undefined characters in destination_encoding -> hexadecimal CharRef such as &#xHH;
Examples:
# UTF-16BE to UTF-8
ec = Encoding::Converter.new("UTF-16BE", "UTF-8")
# Usually, decorators such as newline conversion are inserted last.
ec = Encoding::Converter.new("UTF-16BE", "UTF-8", :universal_newline => true)
p ec.convpath #=> [[#, #],
# "universal_newline"]
# But, if the last encoding is ASCII incompatible,
# decorators are inserted before the last conversion.
ec = Encoding::Converter.new("UTF-8", "UTF-16BE", :crlf_newline => true)
p ec.convpath #=> ["crlf_newline",
# [#, #]]
# Conversion path can be specified directly.
ec = Encoding::Converter.new(["universal_newline", ["EUC-JP", "UTF-8"], ["UTF-8", "UTF-16BE"]])
p ec.convpath #=> ["universal_newline",
# [#, #],
# [#, #]]
;T;[o;
; I"
overload;F; 0;: Encoding::Converter.new; 0; I"CEncoding::Converter.new(source_encoding, destination_encoding);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@k;&0;'F;(i ;[[I"source_encoding;T0[I"destination_encoding;T0;"@ko;
; I"
overload;F; 0;;; 0; I"HEncoding::Converter.new(source_encoding, destination_encoding, opt);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@k;&0;'F;(i ;[[I"source_encoding;T0[I"destination_encoding;T0[I"opt;T0;"@ko;
; I"
overload;F; 0;;; 0; I"&Encoding::Converter.new(convpath);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@k;&0;'F;(i ;[[I"
convpath;T0;"@k;#[ ;$I"possible options elements:
hash form:
:invalid => nil # raise error on invalid byte sequence (default)
:invalid => :replace # replace invalid byte sequence
:undef => nil # raise error on undefined conversion (default)
:undef => :replace # replace undefined conversion
:replace => string # replacement string ("?" or "\uFFFD" if not specified)
:newline => :universal # decorator for converting CRLF and CR to LF
:newline => :crlf # decorator for converting LF to CRLF
:newline => :cr # decorator for converting LF to CR
:universal_newline => true # decorator for converting CRLF and CR to LF
:crlf_newline => true # decorator for converting LF to CRLF
:cr_newline => true # decorator for converting LF to CR
:xml => :text # escape as XML CharData.
:xml => :attr # escape as XML AttValue
integer form:
Encoding::Converter::INVALID_REPLACE
Encoding::Converter::UNDEF_REPLACE
Encoding::Converter::UNDEF_HEX_CHARREF
Encoding::Converter::UNIVERSAL_NEWLINE_DECORATOR
Encoding::Converter::CRLF_NEWLINE_DECORATOR
Encoding::Converter::CR_NEWLINE_DECORATOR
Encoding::Converter::XML_TEXT_DECORATOR
Encoding::Converter::XML_ATTR_CONTENT_DECORATOR
Encoding::Converter::XML_ATTR_QUOTE_DECORATOR
Encoding::Converter.new creates an instance of Encoding::Converter.
Source_encoding and destination_encoding should be a string or
Encoding object.
opt should be nil, a hash or an integer.
convpath should be an array.
convpath may contain
- two-element arrays which contain encodings or encoding names, or
- strings representing decorator names.
Encoding::Converter.new optionally takes an option.
The option should be a hash or an integer.
The option hash can contain :invalid => nil, etc.
The option integer should be logical-or of constants such as
Encoding::Converter::INVALID_REPLACE, etc.
[:invalid => nil]
Raise error on invalid byte sequence. This is a default behavior.
[:invalid => :replace]
Replace invalid byte sequence by replacement string.
[:undef => nil]
Raise an error if a character in source_encoding is not defined in destination_encoding.
This is a default behavior.
[:undef => :replace]
Replace undefined character in destination_encoding with replacement string.
[:replace => string]
Specify the replacement string.
If not specified, "\uFFFD" is used for Unicode encodings and "?" for others.
[:universal_newline => true]
Convert CRLF and CR to LF.
[:crlf_newline => true]
Convert LF to CRLF.
[:cr_newline => true]
Convert LF to CR.
[:xml => :text]
Escape as XML CharData.
This form can be used as a HTML 4.0 #PCDATA.
- '&' -> '&'
- '<' -> '<'
- '>' -> '>'
- undefined characters in destination_encoding -> hexadecimal CharRef such as &#xHH;
[:xml => :attr]
Escape as XML AttValue.
The converted result is quoted as "...".
This form can be used as a HTML 4.0 attribute value.
- '&' -> '&'
- '<' -> '<'
- '>' -> '>'
- '"' -> '"'
- undefined characters in destination_encoding -> hexadecimal CharRef such as &#xHH;
Examples:
# UTF-16BE to UTF-8
ec = Encoding::Converter.new("UTF-16BE", "UTF-8")
# Usually, decorators such as newline conversion are inserted last.
ec = Encoding::Converter.new("UTF-16BE", "UTF-8", :universal_newline => true)
p ec.convpath #=> [[#, #],
# "universal_newline"]
# But, if the last encoding is ASCII incompatible,
# decorators are inserted before the last conversion.
ec = Encoding::Converter.new("UTF-8", "UTF-16BE", :crlf_newline => true)
p ec.convpath #=> ["crlf_newline",
# [#, #]]
# Conversion path can be specified directly.
ec = Encoding::Converter.new(["universal_newline", ["EUC-JP", "UTF-8"], ["UTF-8", "UTF-16BE"]])
p ec.convpath #=> ["universal_newline",
# [#, #],
# [#, #]]
@overload Encoding::Converter.new(source_encoding, destination_encoding)
@overload Encoding::Converter.new(source_encoding, destination_encoding, opt)
@overload Encoding::Converter.new(convpath);T;%0;"@k;'F;)o;*;+T;,i ;-i4
;.@}k; I"static VALUE;T;/I"static VALUE
econv_init(int argc, VALUE *argv, VALUE self)
{
VALUE ecopts;
VALUE snamev, dnamev;
const char *sname, *dname;
rb_encoding *senc, *denc;
rb_econv_t *ec;
int ecflags;
VALUE convpath;
if (rb_check_typeddata(self, &econv_data_type)) {
rb_raise(rb_eTypeError, "already initialized");
}
if (argc == 1 && !NIL_P(convpath = rb_check_array_type(argv[0]))) {
ec = rb_econv_init_by_convpath(self, convpath, &sname, &dname, &senc, &denc);
ecflags = 0;
ecopts = Qnil;
}
else {
econv_args(argc, argv, &snamev, &dnamev, &sname, &dname, &senc, &denc, &ecflags, &ecopts);
ec = rb_econv_open_opts(sname, dname, ecflags, ecopts);
}
if (!ec) {
VALUE exc = rb_econv_open_exc(sname, dname, ecflags);
RB_GC_GUARD(snamev);
RB_GC_GUARD(dnamev);
rb_exc_raise(exc);
}
if (!DECORATOR_P(sname, dname)) {
if (!senc)
senc = make_dummy_encoding(sname);
if (!denc)
denc = make_dummy_encoding(dname);
RB_GC_GUARD(snamev);
RB_GC_GUARD(dnamev);
}
ec->source_encoding = senc;
ec->destination_encoding = denc;
DATA_PTR(self) = ec;
return self;
};T;0To;
; F; ;
;;;I" Encoding::Converter#inspect;F;[ ;[[@:ir
;T;;J;0;[ ;{ ;IC;"Returns a printable version of ec
ec = Encoding::Converter.new("iso-8859-1", "utf-8")
puts ec.inspect #=> #
;T;[o;
; I"
overload;F; 0;;J; 0; I" inspect;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@ l;#[ ;$I"@return [String];T;%0;"@ l;&0;'F;(i ;[ ;"@ l;#[ ;$I"Returns a printable version of ec
ec = Encoding::Converter.new("iso-8859-1", "utf-8")
puts ec.inspect #=> #
@overload inspect
@return [String];T;%0;"@ l;'F;)o;*;+T;,ih
;-ip
;.@}k; I"static VALUE;T;/I"$static VALUE
econv_inspect(VALUE self)
{
const char *cname = rb_obj_classname(self);
rb_econv_t *ec;
TypedData_Get_Struct(self, rb_econv_t, &econv_data_type, ec);
if (!ec)
return rb_sprintf("#<%s: uninitialized>", cname);
else {
const char *sname = ec->source_encoding_name;
const char *dname = ec->destination_encoding_name;
VALUE str;
str = rb_sprintf("#<%s: ", cname);
econv_description(sname, dname, ec->flags, str);
rb_str_cat2(str, ">");
return str;
}
};T;0To;
; F; ;
;;;I"!Encoding::Converter#convpath;F;[ ;[[@:i
;T;:
convpath;0;[ ;{ ;IC;"HReturns the conversion path of ec.
The result is an array of conversions.
ec = Encoding::Converter.new("ISO-8859-1", "EUC-JP", crlf_newline: true)
p ec.convpath
#=> [[#, #],
# [#, #],
# "crlf_newline"]
Each element of the array is a pair of encodings or a string.
A pair means an encoding conversion.
A string means a decorator.
In the above example, [#, #] means
a converter from ISO-8859-1 to UTF-8.
"crlf_newline" means newline converter from LF to CRLF.
;T;[o;
; I"
overload;F; 0;;; 0; I"
convpath;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@&l;&0;'F;(i ;[ ;"@&l;#[ ;$I"]Returns the conversion path of ec.
The result is an array of conversions.
ec = Encoding::Converter.new("ISO-8859-1", "EUC-JP", crlf_newline: true)
p ec.convpath
#=> [[#, #],
# [#, #],
# "crlf_newline"]
Each element of the array is a pair of encodings or a string.
A pair means an encoding conversion.
A string means a decorator.
In the above example, [#, #] means
a converter from ISO-8859-1 to UTF-8.
"crlf_newline" means newline converter from LF to CRLF.
@overload convpath;T;%0;"@&l;'F;)o;*;+T;,i
;-i
;.@}k; I"static VALUE;T;/I"static VALUE
econv_convpath(VALUE self)
{
rb_econv_t *ec = check_econv(self);
VALUE result;
int i;
result = rb_ary_new();
for (i = 0; i < ec->num_trans; i++) {
const rb_transcoder *tr = ec->elems[i].tc->transcoder;
VALUE v;
if (DECORATOR_P(tr->src_encoding, tr->dst_encoding))
v = rb_str_new_cstr(tr->dst_encoding);
else
v = rb_assoc_new(make_encobj(tr->src_encoding), make_encobj(tr->dst_encoding));
rb_ary_push(result, v);
}
return result;
};T;0To;
; F; ;
;;;I"(Encoding::Converter#source_encoding;F;[ ;[[@:i
;T;;;0;[ ;{ ;IC;"7Returns the source encoding as an Encoding object.
;T;[o;
; I"
overload;F; 0;;; 0; I"source_encoding;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Encoding;T;"@source_encoding)
return Qnil;
return rb_enc_from_encoding(ec->source_encoding);
};T;0To;
; F; ;
;;;I"-Encoding::Converter#destination_encoding;F;[ ;[[@:i
;T;;;0;[ ;{ ;IC;"destination_encoding)
return Qnil;
return rb_enc_from_encoding(ec->destination_encoding);
};T;0To;
; F; ;
;;;I"*Encoding::Converter#primitive_convert;F;[[@0;[[@:in;T;:primitive_convert;0;[ ;{ ;IC;"f
possible opt elements:
hash form:
:partial_input => true # source buffer may be part of larger source
:after_output => true # stop conversion after output before input
integer form:
Encoding::Converter::PARTIAL_INPUT
Encoding::Converter::AFTER_OUTPUT
possible results:
:invalid_byte_sequence
:incomplete_input
:undefined_conversion
:after_output
:destination_buffer_full
:source_buffer_empty
:finished
primitive_convert converts source_buffer into destination_buffer.
source_buffer should be a string or nil.
nil means an empty string.
destination_buffer should be a string.
destination_byteoffset should be an integer or nil.
nil means the end of destination_buffer.
If it is omitted, nil is assumed.
destination_bytesize should be an integer or nil.
nil means unlimited.
If it is omitted, nil is assumed.
opt should be nil, a hash or an integer.
nil means no flags.
If it is omitted, nil is assumed.
primitive_convert converts the content of source_buffer from beginning
and store the result into destination_buffer.
destination_byteoffset and destination_bytesize specify the region which
the converted result is stored.
destination_byteoffset specifies the start position in destination_buffer in bytes.
If destination_byteoffset is nil,
destination_buffer.bytesize is used for appending the result.
destination_bytesize specifies maximum number of bytes.
If destination_bytesize is nil,
destination size is unlimited.
After conversion, destination_buffer is resized to
destination_byteoffset + actually produced number of bytes.
Also destination_buffer's encoding is set to destination_encoding.
primitive_convert drops the converted part of source_buffer.
the dropped part is converted in destination_buffer or
buffered in Encoding::Converter object.
primitive_convert stops conversion when one of following condition met.
- invalid byte sequence found in source buffer (:invalid_byte_sequence)
+primitive_errinfo+ and +last_error+ methods returns the detail of the error.
- unexpected end of source buffer (:incomplete_input)
this occur only when :partial_input is not specified.
+primitive_errinfo+ and +last_error+ methods returns the detail of the error.
- character not representable in output encoding (:undefined_conversion)
+primitive_errinfo+ and +last_error+ methods returns the detail of the error.
- after some output is generated, before input is done (:after_output)
this occur only when :after_output is specified.
- destination buffer is full (:destination_buffer_full)
this occur only when destination_bytesize is non-nil.
- source buffer is empty (:source_buffer_empty)
this occur only when :partial_input is specified.
- conversion is finished (:finished)
example:
ec = Encoding::Converter.new("UTF-8", "UTF-16BE")
ret = ec.primitive_convert(src="pi", dst="", nil, 100)
p [ret, src, dst] #=> [:finished, "", "\x00p\x00i"]
ec = Encoding::Converter.new("UTF-8", "UTF-16BE")
ret = ec.primitive_convert(src="pi", dst="", nil, 1)
p [ret, src, dst] #=> [:destination_buffer_full, "i", "\x00"]
ret = ec.primitive_convert(src, dst="", nil, 1)
p [ret, src, dst] #=> [:destination_buffer_full, "", "p"]
ret = ec.primitive_convert(src, dst="", nil, 1)
p [ret, src, dst] #=> [:destination_buffer_full, "", "\x00"]
ret = ec.primitive_convert(src, dst="", nil, 1)
p [ret, src, dst] #=> [:finished, "", "i"]
;T;[ o;
; I"
overload;F; 0;;; 0; I"9primitive_convert(source_buffer, destination_buffer);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@rl;&0;'F;(i ;[[I"source_buffer;T0[I"destination_buffer;T0;"@rlo;
; I"
overload;F; 0;;; 0; I"Qprimitive_convert(source_buffer, destination_buffer, destination_byteoffset);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@rl;&0;'F;(i ;[[I"source_buffer;T0[I"destination_buffer;T0[I"destination_byteoffset;T0;"@rlo;
; I"
overload;F; 0;;; 0; I"gprimitive_convert(source_buffer, destination_buffer, destination_byteoffset, destination_bytesize);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@rl;&0;'F;(i ;[ [I"source_buffer;T0[I"destination_buffer;T0[I"destination_byteoffset;T0[I"destination_bytesize;T0;"@rlo;
; I"
overload;F; 0;;; 0; I"lprimitive_convert(source_buffer, destination_buffer, destination_byteoffset, destination_bytesize, opt);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@rl;&0;'F;(i ;[
[I"source_buffer;T0[I"destination_buffer;T0[I"destination_byteoffset;T0[I"destination_bytesize;T0[I"opt;T0;"@rl;#[ ;$I"possible opt elements:
hash form:
:partial_input => true # source buffer may be part of larger source
:after_output => true # stop conversion after output before input
integer form:
Encoding::Converter::PARTIAL_INPUT
Encoding::Converter::AFTER_OUTPUT
possible results:
:invalid_byte_sequence
:incomplete_input
:undefined_conversion
:after_output
:destination_buffer_full
:source_buffer_empty
:finished
primitive_convert converts source_buffer into destination_buffer.
source_buffer should be a string or nil.
nil means an empty string.
destination_buffer should be a string.
destination_byteoffset should be an integer or nil.
nil means the end of destination_buffer.
If it is omitted, nil is assumed.
destination_bytesize should be an integer or nil.
nil means unlimited.
If it is omitted, nil is assumed.
opt should be nil, a hash or an integer.
nil means no flags.
If it is omitted, nil is assumed.
primitive_convert converts the content of source_buffer from beginning
and store the result into destination_buffer.
destination_byteoffset and destination_bytesize specify the region which
the converted result is stored.
destination_byteoffset specifies the start position in destination_buffer in bytes.
If destination_byteoffset is nil,
destination_buffer.bytesize is used for appending the result.
destination_bytesize specifies maximum number of bytes.
If destination_bytesize is nil,
destination size is unlimited.
After conversion, destination_buffer is resized to
destination_byteoffset + actually produced number of bytes.
Also destination_buffer's encoding is set to destination_encoding.
primitive_convert drops the converted part of source_buffer.
the dropped part is converted in destination_buffer or
buffered in Encoding::Converter object.
primitive_convert stops conversion when one of following condition met.
- invalid byte sequence found in source buffer (:invalid_byte_sequence)
+primitive_errinfo+ and +last_error+ methods returns the detail of the error.
- unexpected end of source buffer (:incomplete_input)
this occur only when :partial_input is not specified.
+primitive_errinfo+ and +last_error+ methods returns the detail of the error.
- character not representable in output encoding (:undefined_conversion)
+primitive_errinfo+ and +last_error+ methods returns the detail of the error.
- after some output is generated, before input is done (:after_output)
this occur only when :after_output is specified.
- destination buffer is full (:destination_buffer_full)
this occur only when destination_bytesize is non-nil.
- source buffer is empty (:source_buffer_empty)
this occur only when :partial_input is specified.
- conversion is finished (:finished)
example:
ec = Encoding::Converter.new("UTF-8", "UTF-16BE")
ret = ec.primitive_convert(src="pi", dst="", nil, 100)
p [ret, src, dst] #=> [:finished, "", "\x00p\x00i"]
ec = Encoding::Converter.new("UTF-8", "UTF-16BE")
ret = ec.primitive_convert(src="pi", dst="", nil, 1)
p [ret, src, dst] #=> [:destination_buffer_full, "i", "\x00"]
ret = ec.primitive_convert(src, dst="", nil, 1)
p [ret, src, dst] #=> [:destination_buffer_full, "", "p"]
ret = ec.primitive_convert(src, dst="", nil, 1)
p [ret, src, dst] #=> [:destination_buffer_full, "", "\x00"]
ret = ec.primitive_convert(src, dst="", nil, 1)
p [ret, src, dst] #=> [:finished, "", "i"]
@overload primitive_convert(source_buffer, destination_buffer)
@overload primitive_convert(source_buffer, destination_buffer, destination_byteoffset)
@overload primitive_convert(source_buffer, destination_buffer, destination_byteoffset, destination_bytesize)
@overload primitive_convert(source_buffer, destination_buffer, destination_byteoffset, destination_bytesize, opt);T;%0;"@rl;'F;)o;*;+T;,i;-ik;.@}k; I"static VALUE;T;/I" static VALUE
econv_primitive_convert(int argc, VALUE *argv, VALUE self)
{
VALUE input, output, output_byteoffset_v, output_bytesize_v, opt, flags_v;
rb_econv_t *ec = check_econv(self);
rb_econv_result_t res;
const unsigned char *ip, *is;
unsigned char *op, *os;
long output_byteoffset, output_bytesize;
unsigned long output_byteend;
int flags;
argc = rb_scan_args(argc, argv, "23:", &input, &output, &output_byteoffset_v, &output_bytesize_v, &flags_v, &opt);
if (NIL_P(output_byteoffset_v))
output_byteoffset = 0; /* dummy */
else
output_byteoffset = NUM2LONG(output_byteoffset_v);
if (NIL_P(output_bytesize_v))
output_bytesize = 0; /* dummy */
else
output_bytesize = NUM2LONG(output_bytesize_v);
if (!NIL_P(flags_v)) {
if (!NIL_P(opt)) {
rb_error_arity(argc + 1, 2, 5);
}
flags = NUM2INT(rb_to_int(flags_v));
}
else if (!NIL_P(opt)) {
VALUE v;
flags = 0;
v = rb_hash_aref(opt, sym_partial_input);
if (RTEST(v))
flags |= ECONV_PARTIAL_INPUT;
v = rb_hash_aref(opt, sym_after_output);
if (RTEST(v))
flags |= ECONV_AFTER_OUTPUT;
}
else {
flags = 0;
}
StringValue(output);
if (!NIL_P(input))
StringValue(input);
rb_str_modify(output);
if (NIL_P(output_bytesize_v)) {
output_bytesize = RSTRING_EMBED_LEN_MAX;
if (!NIL_P(input) && output_bytesize < RSTRING_LEN(input))
output_bytesize = RSTRING_LEN(input);
}
retry:
if (NIL_P(output_byteoffset_v))
output_byteoffset = RSTRING_LEN(output);
if (output_byteoffset < 0)
rb_raise(rb_eArgError, "negative output_byteoffset");
if (RSTRING_LEN(output) < output_byteoffset)
rb_raise(rb_eArgError, "output_byteoffset too big");
if (output_bytesize < 0)
rb_raise(rb_eArgError, "negative output_bytesize");
output_byteend = (unsigned long)output_byteoffset +
(unsigned long)output_bytesize;
if (output_byteend < (unsigned long)output_byteoffset ||
LONG_MAX < output_byteend)
rb_raise(rb_eArgError, "output_byteoffset+output_bytesize too big");
if (rb_str_capacity(output) < output_byteend)
rb_str_resize(output, output_byteend);
if (NIL_P(input)) {
ip = is = NULL;
}
else {
ip = (const unsigned char *)RSTRING_PTR(input);
is = ip + RSTRING_LEN(input);
}
op = (unsigned char *)RSTRING_PTR(output) + output_byteoffset;
os = op + output_bytesize;
res = rb_econv_convert(ec, &ip, is, &op, os, flags);
rb_str_set_len(output, op-(unsigned char *)RSTRING_PTR(output));
if (!NIL_P(input)) {
OBJ_INFECT_RAW(output, input);
rb_str_drop_bytes(input, ip - (unsigned char *)RSTRING_PTR(input));
}
if (NIL_P(output_bytesize_v) && res == econv_destination_buffer_full) {
if (LONG_MAX / 2 < output_bytesize)
rb_raise(rb_eArgError, "too long conversion result");
output_bytesize *= 2;
output_byteoffset_v = Qnil;
goto retry;
}
if (ec->destination_encoding) {
rb_enc_associate(output, ec->destination_encoding);
}
return econv_result_to_symbol(res);
};T;0To;
; F; ;
;;;I" Encoding::Converter#convert;F;[[I"source_string;T0;[[@:i ;T;: convert;0;[ ;{ ;IC;"Convert source_string and return destination_string.
source_string is assumed as a part of source.
i.e. :partial_input=>true is specified internally.
finish method should be used last.
ec = Encoding::Converter.new("utf-8", "euc-jp")
puts ec.convert("\u3042").dump #=> "\xA4\xA2"
puts ec.finish.dump #=> ""
ec = Encoding::Converter.new("euc-jp", "utf-8")
puts ec.convert("\xA4").dump #=> ""
puts ec.convert("\xA2").dump #=> "\xE3\x81\x82"
puts ec.finish.dump #=> ""
ec = Encoding::Converter.new("utf-8", "iso-2022-jp")
puts ec.convert("\xE3").dump #=> "".force_encoding("ISO-2022-JP")
puts ec.convert("\x81").dump #=> "".force_encoding("ISO-2022-JP")
puts ec.convert("\x82").dump #=> "\e$B$\"".force_encoding("ISO-2022-JP")
puts ec.finish.dump #=> "\e(B".force_encoding("ISO-2022-JP")
If a conversion error occur,
Encoding::UndefinedConversionError or
Encoding::InvalidByteSequenceError is raised.
Encoding::Converter#convert doesn't supply methods to recover or restart
from these exceptions.
When you want to handle these conversion errors,
use Encoding::Converter#primitive_convert.
;T;[o;
; I"
overload;F; 0;;; 0; I"convert(source_string);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@l;&0;'F;(i ;[[I"source_string;T0;"@l;#[ ;$I"Convert source_string and return destination_string.
source_string is assumed as a part of source.
i.e. :partial_input=>true is specified internally.
finish method should be used last.
ec = Encoding::Converter.new("utf-8", "euc-jp")
puts ec.convert("\u3042").dump #=> "\xA4\xA2"
puts ec.finish.dump #=> ""
ec = Encoding::Converter.new("euc-jp", "utf-8")
puts ec.convert("\xA4").dump #=> ""
puts ec.convert("\xA2").dump #=> "\xE3\x81\x82"
puts ec.finish.dump #=> ""
ec = Encoding::Converter.new("utf-8", "iso-2022-jp")
puts ec.convert("\xE3").dump #=> "".force_encoding("ISO-2022-JP")
puts ec.convert("\x81").dump #=> "".force_encoding("ISO-2022-JP")
puts ec.convert("\x82").dump #=> "\e$B$\"".force_encoding("ISO-2022-JP")
puts ec.finish.dump #=> "\e(B".force_encoding("ISO-2022-JP")
If a conversion error occur,
Encoding::UndefinedConversionError or
Encoding::InvalidByteSequenceError is raised.
Encoding::Converter#convert doesn't supply methods to recover or restart
from these exceptions.
When you want to handle these conversion errors,
use Encoding::Converter#primitive_convert.
@overload convert(source_string);T;%0;"@l;'F;)o;*;+T;,i;-i;.@}k; I"static VALUE;T;/I"Rstatic VALUE
econv_convert(VALUE self, VALUE source_string)
{
VALUE ret, dst;
VALUE av[5];
int ac;
rb_econv_t *ec = check_econv(self);
StringValue(source_string);
dst = rb_str_new(NULL, 0);
av[0] = rb_str_dup(source_string);
av[1] = dst;
av[2] = Qnil;
av[3] = Qnil;
av[4] = INT2NUM(ECONV_PARTIAL_INPUT);
ac = 5;
ret = econv_primitive_convert(ac, av, self);
if (ret == sym_invalid_byte_sequence ||
ret == sym_undefined_conversion ||
ret == sym_incomplete_input) {
VALUE exc = make_econv_exception(ec);
rb_exc_raise(exc);
}
if (ret == sym_finished) {
rb_raise(rb_eArgError, "converter already finished");
}
if (ret != sym_source_buffer_empty) {
rb_bug("unexpected result of econv_primitive_convert");
}
return dst;
};T;0To;
; F; ;
;;;I" Encoding::Converter#finish;F;[ ;[[@:i2;T;: finish;0;[ ;{ ;IC;"Finishes the converter.
It returns the last part of the converted string.
ec = Encoding::Converter.new("utf-8", "iso-2022-jp")
p ec.convert("\u3042") #=> "\e$B$\""
p ec.finish #=> "\e(B"
;T;[o;
; I"
overload;F; 0;;; 0; I" finish;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@l;#[ ;$I"@return [String];T;%0;"@l;&0;'F;(i ;[ ;"@l;#[ ;$I"Finishes the converter.
It returns the last part of the converted string.
ec = Encoding::Converter.new("utf-8", "iso-2022-jp")
p ec.convert("\u3042") #=> "\e$B$\""
p ec.finish #=> "\e(B"
@overload finish
@return [String];T;%0;"@l;'F;)o;*;+T;,i';-i0;.@}k; I"static VALUE;T;/I"static VALUE
econv_finish(VALUE self)
{
VALUE ret, dst;
VALUE av[5];
int ac;
rb_econv_t *ec = check_econv(self);
dst = rb_str_new(NULL, 0);
av[0] = Qnil;
av[1] = dst;
av[2] = Qnil;
av[3] = Qnil;
av[4] = INT2FIX(0);
ac = 5;
ret = econv_primitive_convert(ac, av, self);
if (ret == sym_invalid_byte_sequence ||
ret == sym_undefined_conversion ||
ret == sym_incomplete_input) {
VALUE exc = make_econv_exception(ec);
rb_exc_raise(exc);
}
if (ret != sym_finished) {
rb_bug("unexpected result of econv_primitive_convert");
}
return dst;
};T;0To;
; F; ;
;;;I"*Encoding::Converter#primitive_errinfo;F;[ ;[[@:i;T;:primitive_errinfo;0;[ ;{ ;IC;" primitive_errinfo returns important information regarding the last error
as a 5-element array:
[result, enc1, enc2, error_bytes, readagain_bytes]
result is the last result of primitive_convert.
Other elements are only meaningful when result is
:invalid_byte_sequence, :incomplete_input or :undefined_conversion.
enc1 and enc2 indicate a conversion step as a pair of strings.
For example, a converter from EUC-JP to ISO-8859-1 converts
a string as follows: EUC-JP -> UTF-8 -> ISO-8859-1.
So [enc1, enc2] is either ["EUC-JP", "UTF-8"] or ["UTF-8", "ISO-8859-1"].
error_bytes and readagain_bytes indicate the byte sequences which caused the error.
error_bytes is discarded portion.
readagain_bytes is buffered portion which is read again on next conversion.
Example:
# \xff is invalid as EUC-JP.
ec = Encoding::Converter.new("EUC-JP", "Shift_JIS")
ec.primitive_convert(src="\xff", dst="", nil, 10)
p ec.primitive_errinfo
#=> [:invalid_byte_sequence, "EUC-JP", "UTF-8", "\xFF", ""]
# HIRAGANA LETTER A (\xa4\xa2 in EUC-JP) is not representable in ISO-8859-1.
# Since this error is occur in UTF-8 to ISO-8859-1 conversion,
# error_bytes is HIRAGANA LETTER A in UTF-8 (\xE3\x81\x82).
ec = Encoding::Converter.new("EUC-JP", "ISO-8859-1")
ec.primitive_convert(src="\xa4\xa2", dst="", nil, 10)
p ec.primitive_errinfo
#=> [:undefined_conversion, "UTF-8", "ISO-8859-1", "\xE3\x81\x82", ""]
# partial character is invalid
ec = Encoding::Converter.new("EUC-JP", "ISO-8859-1")
ec.primitive_convert(src="\xa4", dst="", nil, 10)
p ec.primitive_errinfo
#=> [:incomplete_input, "EUC-JP", "UTF-8", "\xA4", ""]
# Encoding::Converter::PARTIAL_INPUT prevents invalid errors by
# partial characters.
ec = Encoding::Converter.new("EUC-JP", "ISO-8859-1")
ec.primitive_convert(src="\xa4", dst="", nil, 10, Encoding::Converter::PARTIAL_INPUT)
p ec.primitive_errinfo
#=> [:source_buffer_empty, nil, nil, nil, nil]
# \xd8\x00\x00@ is invalid as UTF-16BE because
# no low surrogate after high surrogate (\xd8\x00).
# It is detected by 3rd byte (\00) which is part of next character.
# So the high surrogate (\xd8\x00) is discarded and
# the 3rd byte is read again later.
# Since the byte is buffered in ec, it is dropped from src.
ec = Encoding::Converter.new("UTF-16BE", "UTF-8")
ec.primitive_convert(src="\xd8\x00\x00@", dst="", nil, 10)
p ec.primitive_errinfo
#=> [:invalid_byte_sequence, "UTF-16BE", "UTF-8", "\xD8\x00", "\x00"]
p src
#=> "@"
# Similar to UTF-16BE, \x00\xd8@\x00 is invalid as UTF-16LE.
# The problem is detected by 4th byte.
ec = Encoding::Converter.new("UTF-16LE", "UTF-8")
ec.primitive_convert(src="\x00\xd8@\x00", dst="", nil, 10)
p ec.primitive_errinfo
#=> [:invalid_byte_sequence, "UTF-16LE", "UTF-8", "\x00\xD8", "@\x00"]
p src
#=> ""
;T;[o;
; I"
overload;F; 0;;; 0; I"primitive_errinfo;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@l;#[ ;$I"@return [Array];T;%0;"@l;&0;'F;(i ;[ ;"@l;#[ ;$I"A primitive_errinfo returns important information regarding the last error
as a 5-element array:
[result, enc1, enc2, error_bytes, readagain_bytes]
result is the last result of primitive_convert.
Other elements are only meaningful when result is
:invalid_byte_sequence, :incomplete_input or :undefined_conversion.
enc1 and enc2 indicate a conversion step as a pair of strings.
For example, a converter from EUC-JP to ISO-8859-1 converts
a string as follows: EUC-JP -> UTF-8 -> ISO-8859-1.
So [enc1, enc2] is either ["EUC-JP", "UTF-8"] or ["UTF-8", "ISO-8859-1"].
error_bytes and readagain_bytes indicate the byte sequences which caused the error.
error_bytes is discarded portion.
readagain_bytes is buffered portion which is read again on next conversion.
Example:
# \xff is invalid as EUC-JP.
ec = Encoding::Converter.new("EUC-JP", "Shift_JIS")
ec.primitive_convert(src="\xff", dst="", nil, 10)
p ec.primitive_errinfo
#=> [:invalid_byte_sequence, "EUC-JP", "UTF-8", "\xFF", ""]
# HIRAGANA LETTER A (\xa4\xa2 in EUC-JP) is not representable in ISO-8859-1.
# Since this error is occur in UTF-8 to ISO-8859-1 conversion,
# error_bytes is HIRAGANA LETTER A in UTF-8 (\xE3\x81\x82).
ec = Encoding::Converter.new("EUC-JP", "ISO-8859-1")
ec.primitive_convert(src="\xa4\xa2", dst="", nil, 10)
p ec.primitive_errinfo
#=> [:undefined_conversion, "UTF-8", "ISO-8859-1", "\xE3\x81\x82", ""]
# partial character is invalid
ec = Encoding::Converter.new("EUC-JP", "ISO-8859-1")
ec.primitive_convert(src="\xa4", dst="", nil, 10)
p ec.primitive_errinfo
#=> [:incomplete_input, "EUC-JP", "UTF-8", "\xA4", ""]
# Encoding::Converter::PARTIAL_INPUT prevents invalid errors by
# partial characters.
ec = Encoding::Converter.new("EUC-JP", "ISO-8859-1")
ec.primitive_convert(src="\xa4", dst="", nil, 10, Encoding::Converter::PARTIAL_INPUT)
p ec.primitive_errinfo
#=> [:source_buffer_empty, nil, nil, nil, nil]
# \xd8\x00\x00@ is invalid as UTF-16BE because
# no low surrogate after high surrogate (\xd8\x00).
# It is detected by 3rd byte (\00) which is part of next character.
# So the high surrogate (\xd8\x00) is discarded and
# the 3rd byte is read again later.
# Since the byte is buffered in ec, it is dropped from src.
ec = Encoding::Converter.new("UTF-16BE", "UTF-8")
ec.primitive_convert(src="\xd8\x00\x00@", dst="", nil, 10)
p ec.primitive_errinfo
#=> [:invalid_byte_sequence, "UTF-16BE", "UTF-8", "\xD8\x00", "\x00"]
p src
#=> "@"
# Similar to UTF-16BE, \x00\xd8@\x00 is invalid as UTF-16LE.
# The problem is detected by 4th byte.
ec = Encoding::Converter.new("UTF-16LE", "UTF-8")
ec.primitive_convert(src="\x00\xd8@\x00", dst="", nil, 10)
p ec.primitive_errinfo
#=> [:invalid_byte_sequence, "UTF-16LE", "UTF-8", "\x00\xD8", "@\x00"]
p src
#=> ""
@overload primitive_errinfo
@return [Array];T;%0;"@l;'F;)o;*;+T;,iS;-i;.@}k; I"static VALUE;T;/I":static VALUE
econv_primitive_errinfo(VALUE self)
{
rb_econv_t *ec = check_econv(self);
VALUE ary;
ary = rb_ary_new2(5);
rb_ary_store(ary, 0, econv_result_to_symbol(ec->last_error.result));
rb_ary_store(ary, 4, Qnil);
if (ec->last_error.source_encoding)
rb_ary_store(ary, 1, rb_str_new2(ec->last_error.source_encoding));
if (ec->last_error.destination_encoding)
rb_ary_store(ary, 2, rb_str_new2(ec->last_error.destination_encoding));
if (ec->last_error.error_bytes_start) {
rb_ary_store(ary, 3, rb_str_new((const char *)ec->last_error.error_bytes_start, ec->last_error.error_bytes_len));
rb_ary_store(ary, 4, rb_str_new((const char *)ec->last_error.error_bytes_start + ec->last_error.error_bytes_len, ec->last_error.readagain_len));
}
return ary;
};T;0To;
; F; ;
;;;I"&Encoding::Converter#insert_output;F;[[I" string;T0;[[@:i;T;:insert_output;0;[ ;{ ;IC;"Inserts string into the encoding converter.
The string will be converted to the destination encoding and
output on later conversions.
If the destination encoding is stateful,
string is converted according to the state and the state is updated.
This method should be used only when a conversion error occurs.
ec = Encoding::Converter.new("utf-8", "iso-8859-1")
src = "HIRAGANA LETTER A is \u{3042}."
dst = ""
p ec.primitive_convert(src, dst) #=> :undefined_conversion
puts "[#{dst.dump}, #{src.dump}]" #=> ["HIRAGANA LETTER A is ", "."]
ec.insert_output("")
p ec.primitive_convert(src, dst) #=> :finished
puts "[#{dst.dump}, #{src.dump}]" #=> ["HIRAGANA LETTER A is .", ""]
ec = Encoding::Converter.new("utf-8", "iso-2022-jp")
src = "\u{306F 3041 3068 2661 3002}" # U+2661 is not representable in iso-2022-jp
dst = ""
p ec.primitive_convert(src, dst) #=> :undefined_conversion
puts "[#{dst.dump}, #{src.dump}]" #=> ["\e$B$O$!$H".force_encoding("ISO-2022-JP"), "\xE3\x80\x82"]
ec.insert_output "?" # state change required to output "?".
p ec.primitive_convert(src, dst) #=> :finished
puts "[#{dst.dump}, #{src.dump}]" #=> ["\e$B$O$!$H\e(B?\e$B!#\e(B".force_encoding("ISO-2022-JP"), ""]
;T;[o;
; I"
overload;F; 0;;; 0; I"insert_output(string);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@
m;#[ ;$I"@return [nil];T;%0;"@
m;&0;'F;(i ;[[I" string;T0;"@
m;#[ ;$I"Inserts string into the encoding converter.
The string will be converted to the destination encoding and
output on later conversions.
If the destination encoding is stateful,
string is converted according to the state and the state is updated.
This method should be used only when a conversion error occurs.
ec = Encoding::Converter.new("utf-8", "iso-8859-1")
src = "HIRAGANA LETTER A is \u{3042}."
dst = ""
p ec.primitive_convert(src, dst) #=> :undefined_conversion
puts "[#{dst.dump}, #{src.dump}]" #=> ["HIRAGANA LETTER A is ", "."]
ec.insert_output("")
p ec.primitive_convert(src, dst) #=> :finished
puts "[#{dst.dump}, #{src.dump}]" #=> ["HIRAGANA LETTER A is .", ""]
ec = Encoding::Converter.new("utf-8", "iso-2022-jp")
src = "\u{306F 3041 3068 2661 3002}" # U+2661 is not representable in iso-2022-jp
dst = ""
p ec.primitive_convert(src, dst) #=> :undefined_conversion
puts "[#{dst.dump}, #{src.dump}]" #=> ["\e$B$O$!$H".force_encoding("ISO-2022-JP"), "\xE3\x80\x82"]
ec.insert_output "?" # state change required to output "?".
p ec.primitive_convert(src, dst) #=> :finished
puts "[#{dst.dump}, #{src.dump}]" #=> ["\e$B$O$!$H\e(B?\e$B!#\e(B".force_encoding("ISO-2022-JP"), ""]
@overload insert_output(string)
@return [nil];T;%0;"@
m;'F;)o;*;+T;,i;-i;.@}k; I"static VALUE;T;/I" static VALUE
econv_insert_output(VALUE self, VALUE string)
{
const char *insert_enc;
int ret;
rb_econv_t *ec = check_econv(self);
StringValue(string);
insert_enc = rb_econv_encoding_to_insert_output(ec);
string = rb_str_encode(string, rb_enc_from_encoding(rb_enc_find(insert_enc)), 0, Qnil);
ret = rb_econv_insert_output(ec, (const unsigned char *)RSTRING_PTR(string), RSTRING_LEN(string), insert_enc);
if (ret == -1) {
rb_raise(rb_eArgError, "too big string");
}
return Qnil;
};T;0To;
; F; ;
;;;I" Encoding::Converter#putback;F;[[@0;[[@:i;T;: putback;0;[ ;{ ;IC;"9call-seq
ec.putback -> string
ec.putback(max_numbytes) -> string
Put back the bytes which will be converted.
The bytes are caused by invalid_byte_sequence error.
When invalid_byte_sequence error, some bytes are discarded and
some bytes are buffered to be converted later.
The latter bytes can be put back.
It can be observed by
Encoding::InvalidByteSequenceError#readagain_bytes and
Encoding::Converter#primitive_errinfo.
ec = Encoding::Converter.new("utf-16le", "iso-8859-1")
src = "\x00\xd8\x61\x00"
dst = ""
p ec.primitive_convert(src, dst) #=> :invalid_byte_sequence
p ec.primitive_errinfo #=> [:invalid_byte_sequence, "UTF-16LE", "UTF-8", "\x00\xD8", "a\x00"]
p ec.putback #=> "a\x00"
p ec.putback #=> "" # no more bytes to put back
;T;[ ;#[ ;$I";call-seq
ec.putback -> string
ec.putback(max_numbytes) -> string
Put back the bytes which will be converted.
The bytes are caused by invalid_byte_sequence error.
When invalid_byte_sequence error, some bytes are discarded and
some bytes are buffered to be converted later.
The latter bytes can be put back.
It can be observed by
Encoding::InvalidByteSequenceError#readagain_bytes and
Encoding::Converter#primitive_errinfo.
ec = Encoding::Converter.new("utf-16le", "iso-8859-1")
src = "\x00\xd8\x61\x00"
dst = ""
p ec.primitive_convert(src, dst) #=> :invalid_byte_sequence
p ec.primitive_errinfo #=> [:invalid_byte_sequence, "UTF-16LE", "UTF-8", "\x00\xD8", "a\x00"]
p ec.putback #=> "a\x00"
p ec.putback #=> "" # no more bytes to put back
;T;%0;"@,m;'F;)o;*;+T;,i;-i;.@}k; I"static VALUE;T;/I"cstatic VALUE
econv_putback(int argc, VALUE *argv, VALUE self)
{
rb_econv_t *ec = check_econv(self);
int n;
int putbackable;
VALUE str, max;
rb_scan_args(argc, argv, "01", &max);
if (NIL_P(max))
n = rb_econv_putbackable(ec);
else {
n = NUM2INT(max);
putbackable = rb_econv_putbackable(ec);
if (putbackable < n)
n = putbackable;
}
str = rb_str_new(NULL, n);
rb_econv_putback(ec, (unsigned char *)RSTRING_PTR(str), n);
if (ec->source_encoding) {
rb_enc_associate(str, ec->source_encoding);
}
return str;
};T;0To;
; F; ;
;;;I"#Encoding::Converter#last_error;F;[ ;[[@:i6;T;:last_error;0;[ ;{ ;IC;"Returns an exception object for the last conversion.
Returns nil if the last conversion did not produce an error.
"error" means that
Encoding::InvalidByteSequenceError and Encoding::UndefinedConversionError for
Encoding::Converter#convert and
:invalid_byte_sequence, :incomplete_input and :undefined_conversion for
Encoding::Converter#primitive_convert.
ec = Encoding::Converter.new("utf-8", "iso-8859-1")
p ec.primitive_convert(src="\xf1abcd", dst="") #=> :invalid_byte_sequence
p ec.last_error #=> #
p ec.primitive_convert(src, dst, nil, 1) #=> :destination_buffer_full
p ec.last_error #=> nil
;T;[o;
; I"
overload;F; 0;;; 0; I"last_error;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"Exception;TI"nil;T;"@;m;#[ ;$I" @return [Exception, nil];T;%0;"@;m;&0;'F;(i ;[ ;"@;m;#[ ;$I"Returns an exception object for the last conversion.
Returns nil if the last conversion did not produce an error.
"error" means that
Encoding::InvalidByteSequenceError and Encoding::UndefinedConversionError for
Encoding::Converter#convert and
:invalid_byte_sequence, :incomplete_input and :undefined_conversion for
Encoding::Converter#primitive_convert.
ec = Encoding::Converter.new("utf-8", "iso-8859-1")
p ec.primitive_convert(src="\xf1abcd", dst="") #=> :invalid_byte_sequence
p ec.last_error #=> #
p ec.primitive_convert(src, dst, nil, 1) #=> :destination_buffer_full
p ec.last_error #=> nil
@overload last_error
@return [Exception, nil];T;%0;"@;m;'F;)o;*;+T;,i";-i4;.@}k; I"static VALUE;T;/I"static VALUE
econv_last_error(VALUE self)
{
rb_econv_t *ec = check_econv(self);
VALUE exc;
exc = make_econv_exception(ec);
if (NIL_P(exc))
return Qnil;
return exc;
};T;0To;
; F; ;
;;;I"$Encoding::Converter#replacement;F;[ ;[[@:iN;T;:replacement;0;[ ;{ ;IC;"Returns the replacement string.
ec = Encoding::Converter.new("euc-jp", "us-ascii")
p ec.replacement #=> "?"
ec = Encoding::Converter.new("euc-jp", "utf-8")
p ec.replacement #=> "\uFFFD"
;T;[o;
; I"
overload;F; 0;;; 0; I"replacement;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@Wm;#[ ;$I"@return [String];T;%0;"@Wm;&0;'F;(i ;[ ;"@Wm;#[ ;$I"Returns the replacement string.
ec = Encoding::Converter.new("euc-jp", "us-ascii")
p ec.replacement #=> "?"
ec = Encoding::Converter.new("euc-jp", "utf-8")
p ec.replacement #=> "\uFFFD"
@overload replacement
@return [String];T;%0;"@Wm;'F;)o;*;+T;,iB;-iL;.@}k; I"static VALUE;T;/I"static VALUE
econv_get_replacement(VALUE self)
{
rb_econv_t *ec = check_econv(self);
int ret;
rb_encoding *enc;
ret = make_replacement(ec);
if (ret == -1) {
rb_raise(rb_eUndefinedConversionError, "replacement character setup failed");
}
enc = rb_enc_find(ec->replacement_enc);
return rb_enc_str_new((const char *)ec->replacement_str, (long)ec->replacement_len, enc);
};T;0To;
; F; ;
;;;I"%Encoding::Converter#replacement=;F;[[I"arg;T0;[[@:ih;T;:replacement=;0;[ ;{ ;IC;"Sets the replacement string.
ec = Encoding::Converter.new("utf-8", "us-ascii", :undef => :replace)
ec.replacement = ""
p ec.convert("a \u3042 b") #=> "a b"
;T;[o;
; I"
overload;F; 0;;; 0; I"replacement=(string);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@rm;&0;'F;(i ;[[I" string;T0;"@rm;#[ ;$I"Sets the replacement string.
ec = Encoding::Converter.new("utf-8", "us-ascii", :undef => :replace)
ec.replacement = ""
p ec.convert("a \u3042 b") #=> "a b"
@overload replacement=(string);T;%0;"@rm;'F;)o;*;+T;,i^;-ie;.@}k; I"static VALUE;T;/I",static VALUE
econv_set_replacement(VALUE self, VALUE arg)
{
rb_econv_t *ec = check_econv(self);
VALUE string = arg;
int ret;
rb_encoding *enc;
StringValue(string);
enc = rb_enc_get(string);
ret = rb_econv_set_replacement(ec,
(const unsigned char *)RSTRING_PTR(string),
RSTRING_LEN(string),
rb_enc_name(enc));
if (ret == -1) {
/* xxx: rb_eInvalidByteSequenceError? */
rb_raise(rb_eUndefinedConversionError, "replacement character setup failed");
}
return arg;
};T;0To;
; F; ;
;;;I"Encoding::Converter#==;F;[[I"
other;T0;[[@:i
;T;;:;0;[ ;{ ;IC;"
;T;[o;
; I"
overload;F; 0;;:; 0; I"==(other);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@m;#[ ;$I"@return [Boolean];T;%0;"@m;&0;'F;(i ;[[I"
other;T0;"@m;#[ ;$I"-
@overload ==(other)
@return [Boolean];T;%0;"@m;'F;)o;*;+T;,i
;-i
;.@}k; I"static VALUE;T;/I"static VALUE
econv_equal(VALUE self, VALUE other)
{
rb_econv_t *ec1 = check_econv(self);
rb_econv_t *ec2;
int i;
if (!rb_typeddata_is_kind_of(other, &econv_data_type)) {
return Qnil;
}
ec2 = DATA_PTR(other);
if (!ec2) return Qfalse;
if (ec1->source_encoding_name != ec2->source_encoding_name &&
strcmp(ec1->source_encoding_name, ec2->source_encoding_name))
return Qfalse;
if (ec1->destination_encoding_name != ec2->destination_encoding_name &&
strcmp(ec1->destination_encoding_name, ec2->destination_encoding_name))
return Qfalse;
if (ec1->flags != ec2->flags) return Qfalse;
if (ec1->replacement_enc != ec2->replacement_enc &&
strcmp(ec1->replacement_enc, ec2->replacement_enc))
return Qfalse;
if (ec1->replacement_len != ec2->replacement_len) return Qfalse;
if (ec1->replacement_str != ec2->replacement_str &&
memcmp(ec1->replacement_str, ec2->replacement_str, ec2->replacement_len))
return Qfalse;
if (ec1->num_trans != ec2->num_trans) return Qfalse;
for (i = 0; i < ec1->num_trans; i++) {
if (ec1->elems[i].tc->transcoder != ec2->elems[i].tc->transcoder)
return Qfalse;
}
return Qtrue;
};T;0To;;[[@:i;F;:INVALID_MASK;;;;;[ ;{ ;IC;"$Mask for invalid byte sequences
;T;[ ;#[ ;$I"&
Mask for invalid byte sequences
;T;%0;"@m;'F;)o;*;+T;,i};-i;.@}k;I"&Encoding::Converter::INVALID_MASK;F;I" INT2FIX(ECONV_INVALID_MASK);To;;[[@:i;F;:INVALID_REPLACE;;;;;[ ;{ ;IC;"#Replace invalid byte sequences
;T;[ ;#[ ;$I"%
Replace invalid byte sequences
;T;%0;"@m;'F;)o;*;+T;,i;-i;.@}k;I")Encoding::Converter::INVALID_REPLACE;F;I"#INT2FIX(ECONV_INVALID_REPLACE);To;;[[@:i;F;:UNDEF_MASK;;;;;[ ;{ ;IC;"kMask for a valid character in the source encoding but no related
character(s) in destination encoding.
;T;[ ;#[ ;$I"m
Mask for a valid character in the source encoding but no related
character(s) in destination encoding.
;T;%0;"@m;'F;)o;*;+T;,i;-i;.@}k;I"$Encoding::Converter::UNDEF_MASK;F;I" INT2FIX(ECONV_UNDEF_MASK);To;;[[@:i;F;:UNDEF_REPLACE;;;;;[ ;{ ;IC;"KReplace byte sequences that are undefined in the destination encoding.
;T;[ ;#[ ;$I"M
Replace byte sequences that are undefined in the destination encoding.
;T;%0;"@m;'F;)o;*;+T;,i;-i;.@}k;I"'Encoding::Converter::UNDEF_REPLACE;F;I"!INT2FIX(ECONV_UNDEF_REPLACE);To;;[[@:i;F;:UNDEF_HEX_CHARREF;;;;;[ ;{ ;IC;"Replace byte sequences that are undefined in the destination encoding
with an XML hexadecimal character reference. This is valid for XML
conversion.
;T;[ ;#[ ;$I"
Replace byte sequences that are undefined in the destination encoding
with an XML hexadecimal character reference. This is valid for XML
conversion.
;T;%0;"@m;'F;)o;*;+T;,i;-i;.@}k;I"+Encoding::Converter::UNDEF_HEX_CHARREF;F;I"%INT2FIX(ECONV_UNDEF_HEX_CHARREF);To;;[[@:i;F;:PARTIAL_INPUT;;;;;[ ;{ ;IC;"`Indicates the source may be part of a larger string. See
primitive_convert for an example.
;T;[ ;#[ ;$I"b
Indicates the source may be part of a larger string. See
primitive_convert for an example.
;T;%0;"@m;'F;)o;*;+T;,i;-i;.@}k;I"'Encoding::Converter::PARTIAL_INPUT;F;I"!INT2FIX(ECONV_PARTIAL_INPUT);To;;[[@:i;F;:AFTER_OUTPUT;;;;;[ ;{ ;IC;"~Stop converting after some output is complete but before all of the
input was consumed. See primitive_convert for an example.
;T;[ ;#[ ;$I"
Stop converting after some output is complete but before all of the
input was consumed. See primitive_convert for an example.
;T;%0;"@m;'F;)o;*;+T;,i;-i;.@}k;I"&Encoding::Converter::AFTER_OUTPUT;F;I" INT2FIX(ECONV_AFTER_OUTPUT);To;;[[@:i;F;: UNIVERSAL_NEWLINE_DECORATOR;;;;;[ ;{ ;IC;"/Decorator for converting CRLF and CR to LF
;T;[ ;#[ ;$I"1
Decorator for converting CRLF and CR to LF
;T;%0;"@m;'F;)o;*;+T;,i;-i;.@}k;I"5Encoding::Converter::UNIVERSAL_NEWLINE_DECORATOR;F;I"/INT2FIX(ECONV_UNIVERSAL_NEWLINE_DECORATOR);To;;[[@:i;F;:CRLF_NEWLINE_DECORATOR;;;;;[ ;{ ;IC;"(Decorator for converting LF to CRLF
;T;[ ;#[ ;$I"*
Decorator for converting LF to CRLF
;T;%0;"@ n;'F;)o;*;+T;,i;-i;.@}k;I"0Encoding::Converter::CRLF_NEWLINE_DECORATOR;F;I"*INT2FIX(ECONV_CRLF_NEWLINE_DECORATOR);To;;[[@:i;F;:CR_NEWLINE_DECORATOR;;;;;[ ;{ ;IC;"&Decorator for converting LF to CR
;T;[ ;#[ ;$I"(
Decorator for converting LF to CR
;T;%0;"@n;'F;)o;*;+T;,i;-i;.@}k;I".Encoding::Converter::CR_NEWLINE_DECORATOR;F;I"(INT2FIX(ECONV_CR_NEWLINE_DECORATOR);To;;[[@:i;F;:XML_TEXT_DECORATOR;;;;;[ ;{ ;IC;"Escape as XML CharData
;T;[ ;#[ ;$I"
Escape as XML CharData
;T;%0;"@#n;'F;)o;*;+T;,i;-i;.@}k;I",Encoding::Converter::XML_TEXT_DECORATOR;F;I"&INT2FIX(ECONV_XML_TEXT_DECORATOR);To;;[[@:i;F;: XML_ATTR_CONTENT_DECORATOR;;;;;[ ;{ ;IC;"Escape as XML AttValue
;T;[ ;#[ ;$I"
Escape as XML AttValue
;T;%0;"@/n;'F;)o;*;+T;,i;-i;.@}k;I"4Encoding::Converter::XML_ATTR_CONTENT_DECORATOR;F;I".INT2FIX(ECONV_XML_ATTR_CONTENT_DECORATOR);To;;[[@:i;F;: XML_ATTR_QUOTE_DECORATOR;;;;;[ ;{ ;IC;"Escape as XML AttValue
;T;[ ;#[ ;$I"
Escape as XML AttValue
;T;%0;"@;n;'F;)o;*;+T;,i;-i;.@}k;I"2Encoding::Converter::XML_ATTR_QUOTE_DECORATOR;F;I",INT2FIX(ECONV_XML_ATTR_QUOTE_DECORATOR);T;N@}k;OIC;[ ;N@}k;PIC;[ ;N@}k;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@:ii;F;:Converter;;X;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@}k;(i ;.@g;I"Encoding::Converter;F;Yo;Z ;[0;\0;]0;;i;.@;_@3a;;So; ;IC;[ ;N@Wn;OIC;[ ;N@Wn;PIC;[ ;N@Wn;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@iV[@i;T;:CompatibilityError;;X;;;[ ;{ ;IC;"mRaised by Encoding and String methods when the source encoding is
incompatible with the target encoding.
;T;[ ;#[ ;$I"o
Raised by Encoding and String methods when the source encoding is
incompatible with the target encoding.
;T;%0;"@Wn;'F;)o;*;+T;,iV;-iY;.o;Z ;[0;\0;]0;;;.@;_@g;0;I"!Encoding::CompatibilityError;T;Y@b;N@g;OIC;[ ;N@g;PIC;[ ;N@g;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@:i;F;;;;X;;;[ ;{ ;IC;"An Encoding instance represents a character encoding usable in Ruby. It is
defined as a constant under the Encoding namespace. It has a name and
optionally, aliases:
Encoding::ISO_8859_1.name
#=> "ISO-8859-1"
Encoding::ISO_8859_1.names
#=> ["ISO-8859-1", "ISO8859-1"]
Ruby methods dealing with encodings return or accept Encoding instances as
arguments (when a method accepts an Encoding instance as an argument, it
can be passed an Encoding name or alias instead).
"some string".encoding
#=> #
string = "some string".encode(Encoding::ISO_8859_1)
#=> "some string"
string.encoding
#=> #
"some string".encode "ISO-8859-1"
#=> "some string"
Encoding::ASCII_8BIT is a special encoding that is usually
used for a byte string, not a character string. But as the name insists,
its characters in the range of ASCII are considered as ASCII characters.
This is useful when you use ASCII-8BIT characters with other ASCII
compatible characters.
== Changing an encoding
The associated Encoding of a String can be changed in two different ways.
First, it is possible to set the Encoding of a string to a new Encoding
without changing the internal byte representation of the string, with
String#force_encoding. This is how you can tell Ruby the correct encoding
of a string.
string
#=> "R\xC3\xA9sum\xC3\xA9"
string.encoding
#=> #
string.force_encoding(Encoding::UTF_8)
#=> "R\u00E9sum\u00E9"
Second, it is possible to transcode a string, i.e. translate its internal
byte representation to another encoding. Its associated encoding is also
set to the other encoding. See String#encode for the various forms of
transcoding, and the Encoding::Converter class for additional control over
the transcoding process.
string
#=> "R\u00E9sum\u00E9"
string.encoding
#=> #
string = string.encode!(Encoding::ISO_8859_1)
#=> "R\xE9sum\xE9"
string.encoding
#=> #
== Script encoding
All Ruby script code has an associated Encoding which any String literal
created in the source code will be associated to.
The default script encoding is Encoding::UTF-8 after v2.0, but it can
be changed by a magic comment on the first line of the source code file (or
second line, if there is a shebang line on the first). The comment must
contain the word coding or encoding, followed
by a colon, space and the Encoding name or alias:
# encoding: UTF-8
"some string".encoding
#=> #
The __ENCODING__ keyword returns the script encoding of the file
which the keyword is written:
# encoding: ISO-8859-1
__ENCODING__
#=> #
ruby -K will change the default locale encoding, but this is
not recommended. Ruby source files should declare its script encoding by a
magic comment even when they only depend on US-ASCII strings or regular
expressions.
== Locale encoding
The default encoding of the environment. Usually derived from locale.
see Encoding.locale_charmap, Encoding.find('locale')
== Filesystem encoding
The default encoding of strings from the filesystem of the environment.
This is used for strings of file names or paths.
see Encoding.find('filesystem')
== External encoding
Each IO object has an external encoding which indicates the encoding that
Ruby will use to read its data. By default Ruby sets the external encoding
of an IO object to the default external encoding. The default external
encoding is set by locale encoding or the interpreter -E option.
Encoding.default_external returns the current value of the external
encoding.
ENV["LANG"]
#=> "UTF-8"
Encoding.default_external
#=> #
$ ruby -E ISO-8859-1 -e "p Encoding.default_external"
#
$ LANG=C ruby -e 'p Encoding.default_external'
#
The default external encoding may also be set through
Encoding.default_external=, but you should not do this as strings created
before and after the change will have inconsistent encodings. Instead use
ruby -E to invoke ruby with the correct external encoding.
When you know that the actual encoding of the data of an IO object is not
the default external encoding, you can reset its external encoding with
IO#set_encoding or set it at IO object creation (see IO.new options).
== Internal encoding
To process the data of an IO object which has an encoding different
from its external encoding, you can set its internal encoding. Ruby will use
this internal encoding to transcode the data when it is read from the IO
object.
Conversely, when data is written to the IO object it is transcoded from the
internal encoding to the external encoding of the IO object.
The internal encoding of an IO object can be set with
IO#set_encoding or at IO object creation (see IO.new options).
The internal encoding is optional and when not set, the Ruby default
internal encoding is used. If not explicitly set this default internal
encoding is +nil+ meaning that by default, no transcoding occurs.
The default internal encoding can be set with the interpreter option
-E. Encoding.default_internal returns the current internal
encoding.
$ ruby -e 'p Encoding.default_internal'
nil
$ ruby -E ISO-8859-1:UTF-8 -e "p [Encoding.default_external, \
Encoding.default_internal]"
[#, #]
The default internal encoding may also be set through
Encoding.default_internal=, but you should not do this as strings created
before and after the change will have inconsistent encodings. Instead use
ruby -E to invoke ruby with the correct internal encoding.
== IO encoding example
In the following example a UTF-8 encoded string "R\u00E9sum\u00E9" is transcoded for
output to ISO-8859-1 encoding, then read back in and transcoded to UTF-8:
string = "R\u00E9sum\u00E9"
open("transcoded.txt", "w:ISO-8859-1") do |io|
io.write(string)
end
puts "raw text:"
p File.binread("transcoded.txt")
puts
open("transcoded.txt", "r:ISO-8859-1:UTF-8") do |io|
puts "transcoded text:"
p io.read
end
While writing the file, the internal encoding is not specified as it is
only necessary for reading. While reading the file both the internal and
external encoding must be specified to obtain the correct result.
$ ruby t.rb
raw text:
"R\xE9sum\xE9"
transcoded text:
"R\u00E9sum\u00E9";T;[ ;#[ ;$I"An Encoding instance represents a character encoding usable in Ruby. It is
defined as a constant under the Encoding namespace. It has a name and
optionally, aliases:
Encoding::ISO_8859_1.name
#=> "ISO-8859-1"
Encoding::ISO_8859_1.names
#=> ["ISO-8859-1", "ISO8859-1"]
Ruby methods dealing with encodings return or accept Encoding instances as
arguments (when a method accepts an Encoding instance as an argument, it
can be passed an Encoding name or alias instead).
"some string".encoding
#=> #
string = "some string".encode(Encoding::ISO_8859_1)
#=> "some string"
string.encoding
#=> #
"some string".encode "ISO-8859-1"
#=> "some string"
Encoding::ASCII_8BIT is a special encoding that is usually
used for a byte string, not a character string. But as the name insists,
its characters in the range of ASCII are considered as ASCII characters.
This is useful when you use ASCII-8BIT characters with other ASCII
compatible characters.
== Changing an encoding
The associated Encoding of a String can be changed in two different ways.
First, it is possible to set the Encoding of a string to a new Encoding
without changing the internal byte representation of the string, with
String#force_encoding. This is how you can tell Ruby the correct encoding
of a string.
string
#=> "R\xC3\xA9sum\xC3\xA9"
string.encoding
#=> #
string.force_encoding(Encoding::UTF_8)
#=> "R\u00E9sum\u00E9"
Second, it is possible to transcode a string, i.e. translate its internal
byte representation to another encoding. Its associated encoding is also
set to the other encoding. See String#encode for the various forms of
transcoding, and the Encoding::Converter class for additional control over
the transcoding process.
string
#=> "R\u00E9sum\u00E9"
string.encoding
#=> #
string = string.encode!(Encoding::ISO_8859_1)
#=> "R\xE9sum\xE9"
string.encoding
#=> #
== Script encoding
All Ruby script code has an associated Encoding which any String literal
created in the source code will be associated to.
The default script encoding is Encoding::UTF-8 after v2.0, but it can
be changed by a magic comment on the first line of the source code file (or
second line, if there is a shebang line on the first). The comment must
contain the word coding or encoding, followed
by a colon, space and the Encoding name or alias:
# encoding: UTF-8
"some string".encoding
#=> #
The __ENCODING__ keyword returns the script encoding of the file
which the keyword is written:
# encoding: ISO-8859-1
__ENCODING__
#=> #
ruby -K will change the default locale encoding, but this is
not recommended. Ruby source files should declare its script encoding by a
magic comment even when they only depend on US-ASCII strings or regular
expressions.
== Locale encoding
The default encoding of the environment. Usually derived from locale.
see Encoding.locale_charmap, Encoding.find('locale')
== Filesystem encoding
The default encoding of strings from the filesystem of the environment.
This is used for strings of file names or paths.
see Encoding.find('filesystem')
== External encoding
Each IO object has an external encoding which indicates the encoding that
Ruby will use to read its data. By default Ruby sets the external encoding
of an IO object to the default external encoding. The default external
encoding is set by locale encoding or the interpreter -E option.
Encoding.default_external returns the current value of the external
encoding.
ENV["LANG"]
#=> "UTF-8"
Encoding.default_external
#=> #
$ ruby -E ISO-8859-1 -e "p Encoding.default_external"
#
$ LANG=C ruby -e 'p Encoding.default_external'
#
The default external encoding may also be set through
Encoding.default_external=, but you should not do this as strings created
before and after the change will have inconsistent encodings. Instead use
ruby -E to invoke ruby with the correct external encoding.
When you know that the actual encoding of the data of an IO object is not
the default external encoding, you can reset its external encoding with
IO#set_encoding or set it at IO object creation (see IO.new options).
== Internal encoding
To process the data of an IO object which has an encoding different
from its external encoding, you can set its internal encoding. Ruby will use
this internal encoding to transcode the data when it is read from the IO
object.
Conversely, when data is written to the IO object it is transcoded from the
internal encoding to the external encoding of the IO object.
The internal encoding of an IO object can be set with
IO#set_encoding or at IO object creation (see IO.new options).
The internal encoding is optional and when not set, the Ruby default
internal encoding is used. If not explicitly set this default internal
encoding is +nil+ meaning that by default, no transcoding occurs.
The default internal encoding can be set with the interpreter option
-E. Encoding.default_internal returns the current internal
encoding.
$ ruby -e 'p Encoding.default_internal'
nil
$ ruby -E ISO-8859-1:UTF-8 -e "p [Encoding.default_external, \
Encoding.default_internal]"
[#, #]
The default internal encoding may also be set through
Encoding.default_internal=, but you should not do this as strings created
before and after the change will have inconsistent encodings. Instead use
ruby -E to invoke ruby with the correct internal encoding.
== IO encoding example
In the following example a UTF-8 encoded string "R\u00E9sum\u00E9" is transcoded for
output to ISO-8859-1 encoding, then read back in and transcoded to UTF-8:
string = "R\u00E9sum\u00E9"
open("transcoded.txt", "w:ISO-8859-1") do |io|
io.write(string)
end
puts "raw text:"
p File.binread("transcoded.txt")
puts
open("transcoded.txt", "r:ISO-8859-1:UTF-8") do |io|
puts "transcoded text:"
p io.read
end
While writing the file, the internal encoding is not specified as it is
only necessary for reading. While reading the file both the internal and
external encoding must be specified to obtain the correct result.
$ ruby t.rb
raw text:
"R\xE9sum\xE9"
transcoded text:
"R\u00E9sum\u00E9"
;T;%0;"@g;'F;(i ;)o;*;+T;,i;-ix;.@;I"
Encoding;F;Y@No; ;IC;[4o;
; F; ;
;;;I"WIN32OLE#initialize;F;[[@0;[[I" ext/win32ole/win32ole.c;Ti ;T;;;0;[ ;{ ;IC;"Returns a new WIN32OLE object(OLE Automation object).
The first argument server specifies OLE Automation server.
The first argument should be CLSID or PROGID.
If second argument host specified, then returns OLE Automation
object on host.
WIN32OLE.new('Excel.Application') # => Excel OLE Automation WIN32OLE object.
WIN32OLE.new('{00024500-0000-0000-C000-000000000046}') # => Excel OLE Automation WIN32OLE object.
;T;[o;
; I"
overload;F; 0;;S; 0; I"new(server, [host]);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"WIN32OLE object;T;"@n;#[ ;$I" @return [WIN32OLE object];T;%0;"@n;&0;'F;(i ;[[I" server;T0[I" [host];T0;"@n;#[ ;$I"Returns a new WIN32OLE object(OLE Automation object).
The first argument server specifies OLE Automation server.
The first argument should be CLSID or PROGID.
If second argument host specified, then returns OLE Automation
object on host.
WIN32OLE.new('Excel.Application') # => Excel OLE Automation WIN32OLE object.
WIN32OLE.new('{00024500-0000-0000-C000-000000000046}') # => Excel OLE Automation WIN32OLE object.
@overload new(server, [host])
@return [WIN32OLE object];T;%0;"@n;'F;)o;*;+T;,iy ;-i ;.@}n; I"static VALUE;T;/I"Istatic VALUE
fole_initialize(int argc, VALUE *argv, VALUE self)
{
VALUE svr_name;
VALUE host;
VALUE others;
HRESULT hr;
CLSID clsid;
OLECHAR *pBuf;
IDispatch *pDispatch;
void *p;
rb_call_super(0, 0);
rb_scan_args(argc, argv, "11*", &svr_name, &host, &others);
StringValue(svr_name);
if (rb_safe_level() > 0 && OBJ_TAINTED(svr_name)) {
rb_raise(rb_eSecurityError, "insecure object creation - `%s'",
StringValuePtr(svr_name));
}
if (!NIL_P(host)) {
StringValue(host);
if (rb_safe_level() > 0 && OBJ_TAINTED(host)) {
rb_raise(rb_eSecurityError, "insecure object creation - `%s'",
StringValuePtr(host));
}
return ole_create_dcom(self, svr_name, host, others);
}
/* get CLSID from OLE server name */
pBuf = ole_vstr2wc(svr_name);
hr = CLSIDFromProgID(pBuf, &clsid);
if(FAILED(hr)) {
hr = CLSIDFromString(pBuf, &clsid);
}
SysFreeString(pBuf);
if(FAILED(hr)) {
ole_raise(hr, eWIN32OLERuntimeError,
"unknown OLE server: `%s'",
StringValuePtr(svr_name));
}
/* get IDispatch interface */
hr = CoCreateInstance(&clsid, NULL, CLSCTX_INPROC_SERVER | CLSCTX_LOCAL_SERVER,
&IID_IDispatch, &p);
pDispatch = p;
if(FAILED(hr)) {
ole_raise(hr, eWIN32OLERuntimeError,
"failed to create WIN32OLE object from `%s'",
StringValuePtr(svr_name));
}
ole_set_member(self, pDispatch);
return self;
};T;0To;
; F; ;S;;;I"WIN32OLE.connect;F;[[@0;[[@ni;T;: connect;0;[ ;{ ;IC;"Returns running OLE Automation object or WIN32OLE object from moniker.
1st argument should be OLE program id or class id or moniker.
WIN32OLE.connect('Excel.Application') # => WIN32OLE object which represents running Excel.
;T;[o;
; I"
overload;F; 0;;; 0; I"!connect( ole ) --> aWIN32OLE;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@n;&0;'F;(i ;[[I"ole;T0;"@n;#[ ;$I" Returns running OLE Automation object or WIN32OLE object from moniker.
1st argument should be OLE program id or class id or moniker.
WIN32OLE.connect('Excel.Application') # => WIN32OLE object which represents running Excel.
@overload connect( ole ) --> aWIN32OLE;T;%0;"@n;'F;)o;*;+T;,i;-i;.@}n; I"static VALUE;T;/I"{static VALUE
fole_s_connect(int argc, VALUE *argv, VALUE self)
{
VALUE svr_name;
VALUE others;
HRESULT hr;
CLSID clsid;
OLECHAR *pBuf;
IDispatch *pDispatch;
void *p;
IUnknown *pUnknown;
/* initialize to use OLE */
ole_initialize();
rb_scan_args(argc, argv, "1*", &svr_name, &others);
StringValue(svr_name);
if (rb_safe_level() > 0 && OBJ_TAINTED(svr_name)) {
rb_raise(rb_eSecurityError, "insecure connection - `%s'",
StringValuePtr(svr_name));
}
/* get CLSID from OLE server name */
pBuf = ole_vstr2wc(svr_name);
hr = CLSIDFromProgID(pBuf, &clsid);
if(FAILED(hr)) {
hr = CLSIDFromString(pBuf, &clsid);
}
SysFreeString(pBuf);
if(FAILED(hr)) {
return ole_bind_obj(svr_name, argc, argv, self);
}
hr = GetActiveObject(&clsid, 0, &pUnknown);
if (FAILED(hr)) {
ole_raise(hr, eWIN32OLERuntimeError,
"OLE server `%s' not running", StringValuePtr(svr_name));
}
hr = pUnknown->lpVtbl->QueryInterface(pUnknown, &IID_IDispatch, &p);
pDispatch = p;
if(FAILED(hr)) {
OLE_RELEASE(pUnknown);
ole_raise(hr, eWIN32OLERuntimeError,
"failed to create WIN32OLE server `%s'",
StringValuePtr(svr_name));
}
OLE_RELEASE(pUnknown);
return create_win32ole_object(self, pDispatch, argc, argv);
};T;0To;
; F; ;S;;;I"WIN32OLE.const_load;F;[[@0;[[@ni;T;:const_load;0;[ ;{ ;IC;"Defines the constants of OLE Automation server as mod's constants.
The first argument is WIN32OLE object or type library name.
If 2nd argument is omitted, the default is WIN32OLE.
The first letter of Ruby's constant variable name is upper case,
so constant variable name of WIN32OLE object is capitalized.
For example, the 'xlTop' constant of Excel is changed to 'XlTop'
in WIN32OLE.
If the first letter of constant variable is not [A-Z], then
the constant is defined as CONSTANTS hash element.
module EXCEL_CONST
end
excel = WIN32OLE.new('Excel.Application')
WIN32OLE.const_load(excel, EXCEL_CONST)
puts EXCEL_CONST::XlTop # => -4160
puts EXCEL_CONST::CONSTANTS['_xlDialogChartSourceData'] # => 541
WIN32OLE.const_load(excel)
puts WIN32OLE::XlTop # => -4160
module MSO
end
WIN32OLE.const_load('Microsoft Office 9.0 Object Library', MSO)
puts MSO::MsoLineSingle # => 1
;T;[o;
; I"
overload;F; 0;;; 0; I"%const_load( ole, mod = WIN32OLE);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@n;&0;'F;(i ;[[I"ole;T0[I"mod;TI"
WIN32OLE;T;"@n;#[ ;$I"Defines the constants of OLE Automation server as mod's constants.
The first argument is WIN32OLE object or type library name.
If 2nd argument is omitted, the default is WIN32OLE.
The first letter of Ruby's constant variable name is upper case,
so constant variable name of WIN32OLE object is capitalized.
For example, the 'xlTop' constant of Excel is changed to 'XlTop'
in WIN32OLE.
If the first letter of constant variable is not [A-Z], then
the constant is defined as CONSTANTS hash element.
module EXCEL_CONST
end
excel = WIN32OLE.new('Excel.Application')
WIN32OLE.const_load(excel, EXCEL_CONST)
puts EXCEL_CONST::XlTop # => -4160
puts EXCEL_CONST::CONSTANTS['_xlDialogChartSourceData'] # => 541
WIN32OLE.const_load(excel)
puts WIN32OLE::XlTop # => -4160
module MSO
end
WIN32OLE.const_load('Microsoft Office 9.0 Object Library', MSO)
puts MSO::MsoLineSingle # => 1
@overload const_load( ole, mod = WIN32OLE);T;%0;"@n;'F;)o;*;+T;,i;-i;.@}n; I"static VALUE;T;/I"static VALUE
fole_s_const_load(int argc, VALUE *argv, VALUE self)
{
VALUE ole;
VALUE klass;
struct oledata *pole = NULL;
ITypeInfo *pTypeInfo;
ITypeLib *pTypeLib;
unsigned int index;
HRESULT hr;
OLECHAR *pBuf;
VALUE file;
LCID lcid = cWIN32OLE_lcid;
rb_scan_args(argc, argv, "11", &ole, &klass);
if (!RB_TYPE_P(klass, T_CLASS) &&
!RB_TYPE_P(klass, T_MODULE) &&
!RB_TYPE_P(klass, T_NIL)) {
rb_raise(rb_eTypeError, "2nd parameter must be Class or Module");
}
if (rb_obj_is_kind_of(ole, cWIN32OLE)) {
pole = oledata_get_struct(ole);
hr = pole->pDispatch->lpVtbl->GetTypeInfo(pole->pDispatch,
0, lcid, &pTypeInfo);
if(FAILED(hr)) {
ole_raise(hr, rb_eRuntimeError, "failed to GetTypeInfo");
}
hr = pTypeInfo->lpVtbl->GetContainingTypeLib(pTypeInfo, &pTypeLib, &index);
if(FAILED(hr)) {
OLE_RELEASE(pTypeInfo);
ole_raise(hr, rb_eRuntimeError, "failed to GetContainingTypeLib");
}
OLE_RELEASE(pTypeInfo);
if(!RB_TYPE_P(klass, T_NIL)) {
ole_const_load(pTypeLib, klass, self);
}
else {
ole_const_load(pTypeLib, cWIN32OLE, self);
}
OLE_RELEASE(pTypeLib);
}
else if(RB_TYPE_P(ole, T_STRING)) {
file = typelib_file(ole);
if (file == Qnil) {
file = ole;
}
pBuf = ole_vstr2wc(file);
hr = LoadTypeLibEx(pBuf, REGKIND_NONE, &pTypeLib);
SysFreeString(pBuf);
if (FAILED(hr))
ole_raise(hr, eWIN32OLERuntimeError, "failed to LoadTypeLibEx");
if(!RB_TYPE_P(klass, T_NIL)) {
ole_const_load(pTypeLib, klass, self);
}
else {
ole_const_load(pTypeLib, cWIN32OLE, self);
}
OLE_RELEASE(pTypeLib);
}
else {
rb_raise(rb_eTypeError, "1st parameter must be WIN32OLE instance");
}
return Qnil;
};T;0To;
; F; ;S;;;I"WIN32OLE.ole_free;F;[[I"obj;T0;[[@niW;T;:
ole_free;0;[ ;{ ;IC;"Invokes Release method of Dispatch interface of WIN32OLE object.
You should not use this method because this method
exists only for debugging WIN32OLE.
The return value is reference counter of OLE object.
;T;[o;
; I"
overload;F; 0;;; 0; I"#ole_free(aWIN32OLE) --> number;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@n;&0;'F;(i ;[[I"aWIN32OLE;T0;"@n;#[ ;$I"Invokes Release method of Dispatch interface of WIN32OLE object.
You should not use this method because this method
exists only for debugging WIN32OLE.
The return value is reference counter of OLE object.
@overload ole_free(aWIN32OLE) --> number;T;%0;"@n;'F;)o;*;+T;,iN;-iT;.@}n; I"static VALUE;T;/I""static VALUE
fole_s_free(VALUE self, VALUE obj)
{
ULONG n = 0;
struct oledata * pole = NULL;
pole = oledata_get_struct(obj);
if(pole->pDispatch) {
if (reference_count(pole) > 0) {
n = OLE_RELEASE(pole->pDispatch);
}
}
return INT2NUM(n);
};T;0To;
; F; ;S;;;I"!WIN32OLE.ole_reference_count;F;[[I"obj;T0;[[@niF;T;:ole_reference_count;0;[ ;{ ;IC;"Returns reference counter of Dispatch interface of WIN32OLE object.
You should not use this method because this method
exists only for debugging WIN32OLE.
;T;[o;
; I"
overload;F; 0;;; 0; I".ole_reference_count(aWIN32OLE) --> number;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@n;&0;'F;(i ;[[I"aWIN32OLE;T0;"@n;#[ ;$I"Returns reference counter of Dispatch interface of WIN32OLE object.
You should not use this method because this method
exists only for debugging WIN32OLE.
@overload ole_reference_count(aWIN32OLE) --> number;T;%0;"@n;'F;)o;*;+T;,i>;-iC;.@}n; I"static VALUE;T;/I"static VALUE
fole_s_reference_count(VALUE self, VALUE obj)
{
struct oledata * pole = NULL;
pole = oledata_get_struct(obj);
return INT2NUM(reference_count(pole));
};T;0To;
; F; ;S;;;I"WIN32OLE.ole_show_help;F;[[@0;[[@ni;T;:ole_show_help;0;[ ;{ ;IC;"Displays helpfile. The 1st argument specifies WIN32OLE_TYPE
object or WIN32OLE_METHOD object or helpfile.
excel = WIN32OLE.new('Excel.Application')
typeobj = excel.ole_type
WIN32OLE.ole_show_help(typeobj)
;T;[o;
; I"
overload;F; 0;;; 0; I"&ole_show_help(obj [,helpcontext]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ o;&0;'F;(i ;[[I"obj[,helpcontext];T0;"@ o;#[ ;$I"Displays helpfile. The 1st argument specifies WIN32OLE_TYPE
object or WIN32OLE_METHOD object or helpfile.
excel = WIN32OLE.new('Excel.Application')
typeobj = excel.ole_type
WIN32OLE.ole_show_help(typeobj)
@overload ole_show_help(obj [,helpcontext]);T;%0;"@ o;'F;)o;*;+T;,iz;-i;.@}n; I"static VALUE;T;/I">static VALUE
fole_s_show_help(int argc, VALUE *argv, VALUE self)
{
VALUE target;
VALUE helpcontext;
VALUE helpfile;
VALUE name;
HWND hwnd;
rb_scan_args(argc, argv, "11", &target, &helpcontext);
if (rb_obj_is_kind_of(target, cWIN32OLE_TYPE) ||
rb_obj_is_kind_of(target, cWIN32OLE_METHOD)) {
helpfile = rb_funcall(target, rb_intern("helpfile"), 0);
if(strlen(StringValuePtr(helpfile)) == 0) {
name = rb_ivar_get(target, rb_intern("name"));
rb_raise(rb_eRuntimeError, "no helpfile of `%s'",
StringValuePtr(name));
}
helpcontext = rb_funcall(target, rb_intern("helpcontext"), 0);
} else {
helpfile = target;
}
if (!RB_TYPE_P(helpfile, T_STRING)) {
rb_raise(rb_eTypeError, "1st parameter must be (String|WIN32OLE_TYPE|WIN32OLE_METHOD)");
}
hwnd = ole_show_help(helpfile, helpcontext);
if(hwnd == 0) {
rb_raise(rb_eRuntimeError, "failed to open help file `%s'",
StringValuePtr(helpfile));
}
return Qnil;
};T;0To;
; F; ;S;;;I"WIN32OLE.codepage;F;[ ;[[@ni;T;:
codepage;0;[ ;{ ;IC;"IReturns current codepage.
WIN32OLE.codepage # => WIN32OLE::CP_ACP
;T;[o;
; I"
overload;F; 0;;; 0; I"
codepage;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@"o;&0;'F;(i ;[ ;"@"o;#[ ;$I"^Returns current codepage.
WIN32OLE.codepage # => WIN32OLE::CP_ACP
@overload codepage;T;%0;"@"o;'F;)o;*;+T;,i;-i;.@}n; I"static VALUE;T;/I"Xstatic VALUE
fole_s_get_code_page(VALUE self)
{
return INT2FIX(cWIN32OLE_cp);
};T;0To;
; F; ;S;;;I"WIN32OLE.codepage=;F;[[I"vcp;T0;[[@ni;T;:codepage=;0;[ ;{ ;IC;" Sets current codepage.
The WIN32OLE.codepage is initialized according to
Encoding.default_internal.
If Encoding.default_internal is nil then WIN32OLE.codepage
is initialized according to Encoding.default_external.
WIN32OLE.codepage = WIN32OLE::CP_UTF8
WIN32OLE.codepage = 65001
;T;[o;
; I"
overload;F; 0;;; 0; I"codepage=(CP);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@8o;&0;'F;(i ;[[I"CP;T0;"@8o;#[ ;$I"6Sets current codepage.
The WIN32OLE.codepage is initialized according to
Encoding.default_internal.
If Encoding.default_internal is nil then WIN32OLE.codepage
is initialized according to Encoding.default_external.
WIN32OLE.codepage = WIN32OLE::CP_UTF8
WIN32OLE.codepage = 65001
@overload codepage=(CP);T;%0;"@8o;'F;)o;*;+T;,i;-i;.@}n; I"static VALUE;T;/I"static VALUE
fole_s_set_code_page(VALUE self, VALUE vcp)
{
UINT cp = FIX2INT(vcp);
set_ole_codepage(cp);
/*
* Should this method return old codepage?
*/
return Qnil;
};T;0To;
; F; ;S;;;I"WIN32OLE.locale;F;[ ;[[@ni;T;: locale;0;[ ;{ ;IC;"xReturns current locale id (lcid). The default locale is
WIN32OLE::LOCALE_SYSTEM_DEFAULT.
lcid = WIN32OLE.locale
;T;[o;
; I"
overload;F; 0;;; 0; I" locale;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@Ro;&0;'F;(i ;[ ;"@Ro;#[ ;$I"Returns current locale id (lcid). The default locale is
WIN32OLE::LOCALE_SYSTEM_DEFAULT.
lcid = WIN32OLE.locale
@overload locale;T;%0;"@Ro;'F;)o;*;+T;,i;-i;.@}n; I"static VALUE;T;/I"Wstatic VALUE
fole_s_get_locale(VALUE self)
{
return INT2FIX(cWIN32OLE_lcid);
};T;0To;
; F; ;S;;;I"WIN32OLE.locale=;F;[[I"
vlcid;T0;[[@ni ;T;: locale=;0;[ ;{ ;IC;"Sets current locale id (lcid).
WIN32OLE.locale = 1033 # set locale English(U.S)
obj = WIN32OLE_VARIANT.new("$100,000", WIN32OLE::VARIANT::VT_CY)
;T;[o;
; I"
overload;F; 0;;; 0; I"locale=(lcid);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ho;&0;'F;(i ;[[I" lcid;T0;"@ho;#[ ;$I"Sets current locale id (lcid).
WIN32OLE.locale = 1033 # set locale English(U.S)
obj = WIN32OLE_VARIANT.new("$100,000", WIN32OLE::VARIANT::VT_CY)
@overload locale=(lcid);T;%0;"@ho;'F;)o;*;+T;,i;-i ;.@}n; I"static VALUE;T;/I"static VALUE
fole_s_set_locale(VALUE self, VALUE vlcid)
{
LCID lcid = FIX2INT(vlcid);
if (lcid_installed(lcid)) {
cWIN32OLE_lcid = lcid;
} else {
switch (lcid) {
case LOCALE_SYSTEM_DEFAULT:
case LOCALE_USER_DEFAULT:
cWIN32OLE_lcid = lcid;
break;
default:
rb_raise(eWIN32OLERuntimeError, "not installed locale: %u", (unsigned int)lcid);
}
}
return Qnil;
};T;0To;
; F; ;S;;;I"WIN32OLE.create_guid;F;[ ;[[@ni" ;T;:create_guid;0;[ ;{ ;IC;"VCreates GUID.
WIN32OLE.create_guid # => {1CB530F1-F6B1-404D-BCE6-1959BF91F4A8}
;T;[o;
; I"
overload;F; 0;;; 0; I"create_guid;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@o;&0;'F;(i ;[ ;"@o;#[ ;$I"nCreates GUID.
WIN32OLE.create_guid # => {1CB530F1-F6B1-404D-BCE6-1959BF91F4A8}
@overload create_guid;T;%0;"@o;'F;)o;*;+T;,i ;-i ;.@}n; I"static VALUE;T;/I"static VALUE
fole_s_create_guid(VALUE self)
{
GUID guid;
HRESULT hr;
OLECHAR bstr[80];
int len = 0;
hr = CoCreateGuid(&guid);
if (FAILED(hr)) {
ole_raise(hr, eWIN32OLERuntimeError, "failed to create GUID");
}
len = StringFromGUID2(&guid, bstr, sizeof(bstr)/sizeof(OLECHAR));
if (len == 0) {
rb_raise(rb_eRuntimeError, "failed to create GUID(buffer over)");
}
return ole_wc2vstr(bstr, FALSE);
};T;0To;
; F; ;S;;;I" WIN32OLE.ole_initialize;F;[ ;[[@ni; ;T;:ole_initialize;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@o;'F;)o;*;+T;,i: ;-i: ;.@}n; I"static VALUE;T;/I"^static VALUE
fole_s_ole_initialize(VALUE self)
{
ole_initialize();
return Qnil;
};T;0To;
; F; ;S;;;I" WIN32OLE.ole_uninitialize;F;[ ;[[@niC ;T;:ole_uninitialize;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@o;'F;)o;*;+T;,iB ;-iB ;.@}n; I"static VALUE;T;/I"bstatic VALUE
fole_s_ole_uninitialize(VALUE self)
{
ole_uninitialize();
return Qnil;
};T;0To;
; F; ;
;;;I"WIN32OLE#invoke;F;[[@0;[[@ni
;T;: invoke;0;[ ;{ ;IC;"3Runs OLE method.
The first argument specifies the method name of OLE Automation object.
The others specify argument of the method.
If you can not execute method directly, then use this method instead.
excel = WIN32OLE.new('Excel.Application')
excel.invoke('Quit') # => same as excel.Quit
;T;[o;
; I"
overload;F; 0;;; 0; I" invoke(method, [arg1,...]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@o;&0;'F;(i ;[[I" method;T0[I"[arg1,...];T0;"@o;#[ ;$I"[Runs OLE method.
The first argument specifies the method name of OLE Automation object.
The others specify argument of the method.
If you can not execute method directly, then use this method instead.
excel = WIN32OLE.new('Excel.Application')
excel.invoke('Quit') # => same as excel.Quit
@overload invoke(method, [arg1,...]);T;%0;"@o;'F;)o;*;+T;,i
;-i
;.@}n; I"static VALUE;T;/I"static VALUE
fole_invoke(int argc, VALUE *argv, VALUE self)
{
return ole_invoke(argc, argv, self, DISPATCH_METHOD|DISPATCH_PROPERTYGET, FALSE);
};T;0To;
; F; ;
;;;I"WIN32OLE#[];F;[[@0;[[@ni$ ;T;;V;0;[ ;{ ;IC;"Returns the value of Collection specified by a1, a2,....
dict = WIN32OLE.new('Scripting.Dictionary')
dict.add('ruby', 'Ruby')
puts dict['ruby'] # => 'Ruby' (same as `puts dict.item('ruby')')
Remark: You can not use this method to get the property.
excel = WIN32OLE.new('Excel.Application')
# puts excel['Visible'] This is error !!!
puts excel.Visible # You should to use this style to get the property.
;T;[o;
; I"
overload;F; 0;;V; 0; I"[](a1,a2,...);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@o;&0;'F;(i ;[[I"a1;T0[I"a2;T0[I"...;T0;"@o;#[ ;$I"Returns the value of Collection specified by a1, a2,....
dict = WIN32OLE.new('Scripting.Dictionary')
dict.add('ruby', 'Ruby')
puts dict['ruby'] # => 'Ruby' (same as `puts dict.item('ruby')')
Remark: You can not use this method to get the property.
excel = WIN32OLE.new('Excel.Application')
# puts excel['Visible'] This is error !!!
puts excel.Visible # You should to use this style to get the property.
@overload [](a1,a2,...);T;%0;"@o;'F;)o;*;+T;,i ;-i! ;.@}n; I"static VALUE;T;/I"static VALUE
fole_getproperty_with_bracket(int argc, VALUE *argv, VALUE self)
{
return ole_invoke(argc, argv, self, DISPATCH_PROPERTYGET, TRUE);
};T;0To;
; F; ;
;;;I"WIN32OLE#_invoke;F;[[I" dispid;T0[I" args;T0[I"
types;T0;[[@ni ;T;: _invoke;0;[ ;{ ;IC;"!Runs the early binding method.
The 1st argument specifies dispatch ID,
the 2nd argument specifies the array of arguments,
the 3rd argument specifies the array of the type of arguments.
excel = WIN32OLE.new('Excel.Application')
excel._invoke(302, [], []) # same effect as excel.Quit
;T;[o;
; I"
overload;F; 0;;; 0; I"!_invoke(dispid, args, types);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@o;&0;'F;(i ;[[I" dispid;T0[I" args;T0[I"
types;T0;"@o;#[ ;$I"JRuns the early binding method.
The 1st argument specifies dispatch ID,
the 2nd argument specifies the array of arguments,
the 3rd argument specifies the array of the type of arguments.
excel = WIN32OLE.new('Excel.Application')
excel._invoke(302, [], []) # same effect as excel.Quit
@overload _invoke(dispid, args, types);T;%0;"@o;'F;)o;*;+T;,i ;-i ;.@}n; I"static VALUE;T;/I"static VALUE
fole_invoke2(VALUE self, VALUE dispid, VALUE args, VALUE types)
{
return ole_invoke2(self, dispid, args, types, DISPATCH_METHOD);
};T;0To;
; F; ;
;;;I"WIN32OLE#_getproperty;F;[[I" dispid;T0[I" args;T0[I"
types;T0;[[@ni ;T;:_getproperty;0;[ ;{ ;IC;"BRuns the early binding method to get property.
The 1st argument specifies dispatch ID,
the 2nd argument specifies the array of arguments,
the 3rd argument specifies the array of the type of arguments.
excel = WIN32OLE.new('Excel.Application')
puts excel._getproperty(558, [], []) # same effect as puts excel.visible
;T;[o;
; I"
overload;F; 0;;; 0; I"&_getproperty(dispid, args, types);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@p;&0;'F;(i ;[[I" dispid;T0[I" args;T0[I"
types;T0;"@p;#[ ;$I"pRuns the early binding method to get property.
The 1st argument specifies dispatch ID,
the 2nd argument specifies the array of arguments,
the 3rd argument specifies the array of the type of arguments.
excel = WIN32OLE.new('Excel.Application')
puts excel._getproperty(558, [], []) # same effect as puts excel.visible
@overload _getproperty(dispid, args, types);T;%0;"@p;'F;)o;*;+T;,i ;-i ;.@}n; I"static VALUE;T;/I"static VALUE
fole_getproperty2(VALUE self, VALUE dispid, VALUE args, VALUE types)
{
return ole_invoke2(self, dispid, args, types, DISPATCH_PROPERTYGET);
};T;0To;
; F; ;
;;;I"WIN32OLE#_setproperty;F;[[I" dispid;T0[I" args;T0[I"
types;T0;[[@ni ;T;:_setproperty;0;[ ;{ ;IC;"]Runs the early binding method to set property.
The 1st argument specifies dispatch ID,
the 2nd argument specifies the array of arguments,
the 3rd argument specifies the array of the type of arguments.
excel = WIN32OLE.new('Excel.Application')
excel._setproperty(558, [true], [WIN32OLE::VARIANT::VT_BOOL]) # same effect as excel.visible = true
;T;[o;
; I"
overload;F; 0;;; 0; I"&_setproperty(dispid, args, types);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@0p;&0;'F;(i ;[[I" dispid;T0[I" args;T0[I"
types;T0;"@0p;#[ ;$I"Runs the early binding method to set property.
The 1st argument specifies dispatch ID,
the 2nd argument specifies the array of arguments,
the 3rd argument specifies the array of the type of arguments.
excel = WIN32OLE.new('Excel.Application')
excel._setproperty(558, [true], [WIN32OLE::VARIANT::VT_BOOL]) # same effect as excel.visible = true
@overload _setproperty(dispid, args, types);T;%0;"@0p;'F;)o;*;+T;,i ;-i ;.@}n; I"static VALUE;T;/I"static VALUE
fole_setproperty2(VALUE self, VALUE dispid, VALUE args, VALUE types)
{
return ole_invoke2(self, dispid, args, types, DISPATCH_PROPERTYPUT);
};T;0To;
; F; ;
;;;I"WIN32OLE#[]=;F;[[@0;[[@ni ;T;;X;0;[ ;{ ;IC;"Sets the value to WIN32OLE object specified by a1, a2, ...
dict = WIN32OLE.new('Scripting.Dictionary')
dict.add('ruby', 'RUBY')
dict['ruby'] = 'Ruby'
puts dict['ruby'] # => 'Ruby'
Remark: You can not use this method to set the property value.
excel = WIN32OLE.new('Excel.Application')
# excel['Visible'] = true # This is error !!!
excel.Visible = true # You should to use this style to set the property.
;T;[o;
; I"
overload;F; 0;;X; 0; I"[]=(a1, a2, ...);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@Rp;&0;'F;(i ;[[I"a1;T0[I"a2;T0[I"...;T0;"@Rp;#[ ;$I"Sets the value to WIN32OLE object specified by a1, a2, ...
dict = WIN32OLE.new('Scripting.Dictionary')
dict.add('ruby', 'RUBY')
dict['ruby'] = 'Ruby'
puts dict['ruby'] # => 'Ruby'
Remark: You can not use this method to set the property value.
excel = WIN32OLE.new('Excel.Application')
# excel['Visible'] = true # This is error !!!
excel.Visible = true # You should to use this style to set the property.
@overload []=(a1, a2, ...);T;%0;"@Rp;'F;)o;*;+T;,i ;-i ;.@}n; I"static VALUE;T;/I"static VALUE
fole_setproperty_with_bracket(int argc, VALUE *argv, VALUE self)
{
return ole_invoke(argc, argv, self, DISPATCH_PROPERTYPUT, TRUE);
};T;0To;
; F; ;
;;;I"WIN32OLE#ole_free;F;[ ;[[@nil ;T;;;0;[ ;{ ;IC;"invokes Release method of Dispatch interface of WIN32OLE object.
Usually, you do not need to call this method because Release method
called automatically when WIN32OLE object garbaged.
;T;[o;
; I"
overload;F; 0;;; 0; I"
ole_free;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@op;&0;'F;(i ;[ ;"@op;#[ ;$I"invokes Release method of Dispatch interface of WIN32OLE object.
Usually, you do not need to call this method because Release method
called automatically when WIN32OLE object garbaged.
@overload ole_free;T;%0;"@op;'F;)o;*;+T;,ic ;-ii ;.@}n; I"static VALUE;T;/I"static VALUE
fole_free(VALUE self)
{
struct oledata *pole = NULL;
pole = oledata_get_struct(self);
OLE_FREE(pole->pDispatch);
pole->pDispatch = NULL;
return Qnil;
};T;0To;
; F; ;
;;;I"WIN32OLE#each;F;[ ;[[@ni ;T;;;0;[ ;{ ;IC;" Iterates over each item of OLE collection which has IEnumVARIANT interface.
excel = WIN32OLE.new('Excel.Application')
book = excel.workbooks.add
sheets = book.worksheets(1)
cells = sheets.cells("A1:A5")
cells.each do |cell|
cell.value = 10
end
;T;[o;
; I"
overload;F; 0;;; 0; I" each;T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I"i;T;"@p;#[ ;$I"@yield [i];T;%0;"@p;&0;'F;(i ;[ ;"@p;#[ ;$I")Iterates over each item of OLE collection which has IEnumVARIANT interface.
excel = WIN32OLE.new('Excel.Application')
book = excel.workbooks.add
sheets = book.worksheets(1)
cells = sheets.cells("A1:A5")
cells.each do |cell|
cell.value = 10
end
@overload each
@yield [i];T;%0;"@p;'F;)o;*;+T;,i ;-i ;.@}n; I"static VALUE;T;/I"/static VALUE
fole_each(VALUE self)
{
LCID lcid = cWIN32OLE_lcid;
struct oledata *pole = NULL;
unsigned int argErr;
EXCEPINFO excepinfo;
DISPPARAMS dispParams;
VARIANT result;
HRESULT hr;
IEnumVARIANT *pEnum = NULL;
void *p;
RETURN_ENUMERATOR(self, 0, 0);
VariantInit(&result);
dispParams.rgvarg = NULL;
dispParams.rgdispidNamedArgs = NULL;
dispParams.cNamedArgs = 0;
dispParams.cArgs = 0;
memset(&excepinfo, 0, sizeof(excepinfo));
pole = oledata_get_struct(self);
hr = pole->pDispatch->lpVtbl->Invoke(pole->pDispatch, DISPID_NEWENUM,
&IID_NULL, lcid,
DISPATCH_METHOD | DISPATCH_PROPERTYGET,
&dispParams, &result,
&excepinfo, &argErr);
if (FAILED(hr)) {
VariantClear(&result);
ole_raise(hr, eWIN32OLERuntimeError, "failed to get IEnum Interface");
}
if (V_VT(&result) == VT_UNKNOWN) {
hr = V_UNKNOWN(&result)->lpVtbl->QueryInterface(V_UNKNOWN(&result),
&IID_IEnumVARIANT,
&p);
pEnum = p;
} else if (V_VT(&result) == VT_DISPATCH) {
hr = V_DISPATCH(&result)->lpVtbl->QueryInterface(V_DISPATCH(&result),
&IID_IEnumVARIANT,
&p);
pEnum = p;
}
if (FAILED(hr) || !pEnum) {
VariantClear(&result);
ole_raise(hr, rb_eRuntimeError, "failed to get IEnum Interface");
}
VariantClear(&result);
rb_ensure(ole_each_sub, (VALUE)pEnum, ole_ienum_free, (VALUE)pEnum);
return Qnil;
};T;0To;
; F; ;
;;;I" WIN32OLE#method_missing;F;[[@0;[[@ni ;T;;;0;[ ;{ ;IC;""Calls WIN32OLE#invoke method.
;T;[o;
; I"
overload;F; 0;;; 0; I"*method_missing(id [,arg1, arg2, ...]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@p;&0;'F;(i ;[[I"id[,arg1, arg2, ...];T0;"@p;#[ ;$I"TCalls WIN32OLE#invoke method.
@overload method_missing(id [,arg1, arg2, ...]);T;%0;"@p;'F;)o;*;+T;,i ;-i ;.@}n; I"static VALUE;T;/I"static VALUE
fole_missing(int argc, VALUE *argv, VALUE self)
{
VALUE mid, sym;
const char* mname;
long n;
rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS);
mid = argv[0];
sym = rb_check_symbol(&mid);
if (!NIL_P(sym)) mid = rb_sym2str(sym);
mname = StringValueCStr(mid);
if(!mname) {
rb_raise(rb_eRuntimeError, "fail: unknown method or property");
}
n = RSTRING_LEN(mid);
#if SIZEOF_SIZE_T > SIZEOF_LONG
if (n >= LONG_MAX) {
rb_raise(rb_eRuntimeError, "too long method or property name");
}
#endif
if(mname[n-1] == '=') {
rb_check_arity(argc, 2, 2);
argv[0] = rb_enc_str_new(mname, (n-1), cWIN32OLE_enc);
return ole_propertyput(self, argv[0], argv[1]);
}
else {
argv[0] = rb_enc_str_new(mname, n, cWIN32OLE_enc);
return ole_invoke(argc, argv, self, DISPATCH_METHOD|DISPATCH_PROPERTYGET, FALSE);
}
};T;0To;
; F; ;
;;;I"WIN32OLE#setproperty;F;[[@0;[[@ni ;T;:setproperty;0;[ ;{ ;IC;"*Sets property of OLE object.
When you want to set property with argument, you can use this method.
excel = WIN32OLE.new('Excel.Application')
excel.Visible = true
book = excel.workbooks.add
sheet = book.worksheets(1)
sheet.setproperty('Cells', 1, 2, 10) # => The B1 cell value is 10.
;T;[o;
; I"
overload;F; 0;;; 0; I"2setproperty('property', [arg1, arg2,...] val);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@p;&0;'F;(i ;[["'property'0[I"[arg1, arg2,...];T0;"@p;#[ ;$I"dSets property of OLE object.
When you want to set property with argument, you can use this method.
excel = WIN32OLE.new('Excel.Application')
excel.Visible = true
book = excel.workbooks.add
sheet = book.worksheets(1)
sheet.setproperty('Cells', 1, 2, 10) # => The B1 cell value is 10.
@overload setproperty('property', [arg1, arg2,...] val);T;%0;"@p;'F;)o;*;+T;,i ;-i ;.@}n; I"static VALUE;T;/I"static VALUE
fole_setproperty(int argc, VALUE *argv, VALUE self)
{
return ole_invoke(argc, argv, self, DISPATCH_PROPERTYPUT, FALSE);
};T;0To;
; F; ;
;;;I"WIN32OLE#ole_methods;F;[ ;[[@niB
;T;:ole_methods;0;[ ;{ ;IC;"Returns the array of WIN32OLE_METHOD object.
The element is OLE method of WIN32OLE object.
excel = WIN32OLE.new('Excel.Application')
methods = excel.ole_methods
;T;[o;
; I"
overload;F; 0;;; 0; I"ole_methods;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@p;&0;'F;(i ;[ ;"@p;#[ ;$I"Returns the array of WIN32OLE_METHOD object.
The element is OLE method of WIN32OLE object.
excel = WIN32OLE.new('Excel.Application')
methods = excel.ole_methods
@overload ole_methods;T;%0;"@p;'F;)o;*;+T;,i7
;-i?
;.@}n; I"static VALUE;T;/I"static VALUE
fole_methods(VALUE self)
{
return ole_methods( self, INVOKE_FUNC | INVOKE_PROPERTYGET | INVOKE_PROPERTYPUT | INVOKE_PROPERTYPUTREF);
};T;0To;
; F; ;
;;;I" WIN32OLE#ole_get_methods;F;[ ;[[@niR
;T;:ole_get_methods;0;[ ;{ ;IC;"Returns the array of WIN32OLE_METHOD object .
The element of the array is property (gettable) of WIN32OLE object.
excel = WIN32OLE.new('Excel.Application')
properties = excel.ole_get_methods
;T;[o;
; I"
overload;F; 0;;; 0; I"ole_get_methods;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@p;&0;'F;(i ;[ ;"@p;#[ ;$I"Returns the array of WIN32OLE_METHOD object .
The element of the array is property (gettable) of WIN32OLE object.
excel = WIN32OLE.new('Excel.Application')
properties = excel.ole_get_methods
@overload ole_get_methods;T;%0;"@p;'F;)o;*;+T;,iH
;-iO
;.@}n; I"static VALUE;T;/I"estatic VALUE
fole_get_methods(VALUE self)
{
return ole_methods( self, INVOKE_PROPERTYGET);
};T;0To;
; F; ;
;;;I" WIN32OLE#ole_put_methods;F;[ ;[[@nib
;T;:ole_put_methods;0;[ ;{ ;IC;"Returns the array of WIN32OLE_METHOD object .
The element of the array is property (settable) of WIN32OLE object.
excel = WIN32OLE.new('Excel.Application')
properties = excel.ole_put_methods
;T;[o;
; I"
overload;F; 0;;; 0; I"ole_put_methods;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ q;&0;'F;(i ;[ ;"@ q;#[ ;$I"Returns the array of WIN32OLE_METHOD object .
The element of the array is property (settable) of WIN32OLE object.
excel = WIN32OLE.new('Excel.Application')
properties = excel.ole_put_methods
@overload ole_put_methods;T;%0;"@ q;'F;)o;*;+T;,iX
;-i_
;.@}n; I"static VALUE;T;/I"{static VALUE
fole_put_methods(VALUE self)
{
return ole_methods( self, INVOKE_PROPERTYPUT|INVOKE_PROPERTYPUTREF);
};T;0To;
; F; ;
;;;I" WIN32OLE#ole_func_methods;F;[ ;[[@nis
;T;:ole_func_methods;0;[ ;{ ;IC;"Returns the array of WIN32OLE_METHOD object .
The element of the array is property (settable) of WIN32OLE object.
excel = WIN32OLE.new('Excel.Application')
properties = excel.ole_func_methods
;T;[o;
; I"
overload;F; 0;;; 0; I"ole_func_methods;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@q;&0;'F;(i ;[ ;"@q;#[ ;$I"Returns the array of WIN32OLE_METHOD object .
The element of the array is property (settable) of WIN32OLE object.
excel = WIN32OLE.new('Excel.Application')
properties = excel.ole_func_methods
@overload ole_func_methods;T;%0;"@q;'F;)o;*;+T;,ih
;-ip
;.@}n; I"static VALUE;T;/I"_static VALUE
fole_func_methods(VALUE self)
{
return ole_methods( self, INVOKE_FUNC);
};T;0To;
; F; ;
;;;I"WIN32OLE#ole_method;F;[[I" cmdname;T0;[[@ni;T;:ole_method;0;[ ;{ ;IC;"Returns WIN32OLE_METHOD object corresponding with method
specified by 1st argument.
excel = WIN32OLE.new('Excel.Application')
method = excel.ole_method_help('Quit')
;T;[o;
; I"
overload;F; 0;:ole_method_help; 0; I" ole_method_help(method);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@,q;&0;'F;(i ;[[I" method;T0;"@,q;#[ ;$I"Returns WIN32OLE_METHOD object corresponding with method
specified by 1st argument.
excel = WIN32OLE.new('Excel.Application')
method = excel.ole_method_help('Quit')
@overload ole_method_help(method);T;%0;"o;
; F; ;
;;;I" WIN32OLE#ole_method_help;F;[ ;[[@ni|;F;;;;X;[ ;{ ;@5q;.@}n; I"static VALUE;T;/I";static VALUE
fole_method_help(VALUE self, VALUE cmdname)
{
ITypeInfo *pTypeInfo;
HRESULT hr;
struct oledata *pole = NULL;
VALUE obj;
SafeStringValue(cmdname);
pole = oledata_get_struct(self);
hr = typeinfo_from_ole(pole, &pTypeInfo);
if(FAILED(hr))
ole_raise(hr, rb_eRuntimeError, "failed to get ITypeInfo");
obj = create_win32ole_method(pTypeInfo, cmdname);
OLE_RELEASE(pTypeInfo);
if (obj == Qnil)
rb_raise(eWIN32OLERuntimeError, "not found %s",
StringValuePtr(cmdname));
return obj;
};T;'F;)o;*;+T;,i;-i;.@}n; @Jq;/I";static VALUE
fole_method_help(VALUE self, VALUE cmdname)
{
ITypeInfo *pTypeInfo;
HRESULT hr;
struct oledata *pole = NULL;
VALUE obj;
SafeStringValue(cmdname);
pole = oledata_get_struct(self);
hr = typeinfo_from_ole(pole, &pTypeInfo);
if(FAILED(hr))
ole_raise(hr, rb_eRuntimeError, "failed to get ITypeInfo");
obj = create_win32ole_method(pTypeInfo, cmdname);
OLE_RELEASE(pTypeInfo);
if (obj == Qnil)
rb_raise(eWIN32OLERuntimeError, "not found %s",
StringValuePtr(cmdname));
return obj;
};T;0T@Cqo;
; F; ;
;;;I"$WIN32OLE#ole_activex_initialize;F;[ ;[[@ni;T;:ole_activex_initialize;0;[ ;{ ;IC;"Initialize WIN32OLE object(ActiveX Control) by calling
IPersistMemory::InitNew.
Before calling OLE method, some kind of the ActiveX controls
created with MFC should be initialized by calling
IPersistXXX::InitNew.
If and only if you received the exception "HRESULT error code:
0x8000ffff catastrophic failure", try this method before
invoking any ole_method.
obj = WIN32OLE.new("ProgID_or_GUID_of_ActiveX_Control")
obj.ole_activex_initialize
obj.method(...)
;T;[o;
; I"
overload;F; 0;;; 0; I" ole_activex_initialize();T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Qnil;T;"@Nq;#[ ;$I"@return [Qnil];T;%0;"@Nq;&0;'F;(i ;[ ;"@Nq;#[ ;$I" Initialize WIN32OLE object(ActiveX Control) by calling
IPersistMemory::InitNew.
Before calling OLE method, some kind of the ActiveX controls
created with MFC should be initialized by calling
IPersistXXX::InitNew.
If and only if you received the exception "HRESULT error code:
0x8000ffff catastrophic failure", try this method before
invoking any ole_method.
obj = WIN32OLE.new("ProgID_or_GUID_of_ActiveX_Control")
obj.ole_activex_initialize
obj.method(...)
@overload ole_activex_initialize()
@return [Qnil];T;%0;"@Nq;'F;)o;*;+T;,i;-i;.@}n; I"static VALUE;T;/I"~static VALUE
fole_activex_initialize(VALUE self)
{
struct oledata *pole = NULL;
IPersistMemory *pPersistMemory;
void *p;
HRESULT hr = S_OK;
pole = oledata_get_struct(self);
hr = pole->pDispatch->lpVtbl->QueryInterface(pole->pDispatch, &IID_IPersistMemory, &p);
pPersistMemory = p;
if (SUCCEEDED(hr)) {
hr = pPersistMemory->lpVtbl->InitNew(pPersistMemory);
OLE_RELEASE(pPersistMemory);
if (SUCCEEDED(hr)) {
return Qnil;
}
}
if (FAILED(hr)) {
ole_raise(hr, eWIN32OLERuntimeError, "fail to initialize ActiveX control");
}
return Qnil;
};T;0To;
; F; ;
;;;I"WIN32OLE#ole_type;F;[ ;[[@ni
;T;:
ole_type;0;[ ;{ ;IC;"iReturns WIN32OLE_TYPE object.
excel = WIN32OLE.new('Excel.Application')
tobj = excel.ole_type
;T;[o;
; I"
overload;F; 0;;; 0; I"
ole_type;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@iq;&0;'F;(i ;[ ;"@iq;#[ ;$I"~Returns WIN32OLE_TYPE object.
excel = WIN32OLE.new('Excel.Application')
tobj = excel.ole_type
@overload ole_type;T;%0;"o;
; F; ;
;;;I"WIN32OLE#ole_obj_help;F;[ ;[[@ni;F;:ole_obj_help;;X;[ ;{ ;@pq;.@}n; I"static VALUE;T;/I"Wstatic VALUE
fole_type(VALUE self)
{
ITypeInfo *pTypeInfo;
HRESULT hr;
struct oledata *pole = NULL;
LCID lcid = cWIN32OLE_lcid;
VALUE type = Qnil;
pole = oledata_get_struct(self);
hr = pole->pDispatch->lpVtbl->GetTypeInfo( pole->pDispatch, 0, lcid, &pTypeInfo );
if(FAILED(hr)) {
ole_raise(hr, rb_eRuntimeError, "failed to GetTypeInfo");
}
type = ole_type_from_itypeinfo(pTypeInfo);
OLE_RELEASE(pTypeInfo);
if (type == Qnil) {
rb_raise(rb_eRuntimeError, "failed to create WIN32OLE_TYPE obj from ITypeInfo");
}
return type;
};T;'F;)o;*;+T;,iy
;-i
;.@}n; @q;/I"Wstatic VALUE
fole_type(VALUE self)
{
ITypeInfo *pTypeInfo;
HRESULT hr;
struct oledata *pole = NULL;
LCID lcid = cWIN32OLE_lcid;
VALUE type = Qnil;
pole = oledata_get_struct(self);
hr = pole->pDispatch->lpVtbl->GetTypeInfo( pole->pDispatch, 0, lcid, &pTypeInfo );
if(FAILED(hr)) {
ole_raise(hr, rb_eRuntimeError, "failed to GetTypeInfo");
}
type = ole_type_from_itypeinfo(pTypeInfo);
OLE_RELEASE(pTypeInfo);
if (type == Qnil) {
rb_raise(rb_eRuntimeError, "failed to create WIN32OLE_TYPE obj from ITypeInfo");
}
return type;
};T;0T@|qo;
; F; ;
;;;I"WIN32OLE#ole_typelib;F;[ ;[[@ni
;T;:ole_typelib;0;[ ;{ ;IC;"Returns the WIN32OLE_TYPELIB object. The object represents the
type library which contains the WIN32OLE object.
excel = WIN32OLE.new('Excel.Application')
tlib = excel.ole_typelib
puts tlib.name # -> 'Microsoft Excel 9.0 Object Library'
;T;[o;
; I"
overload;F; 0;;; 0; I"ole_typelib;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" The WIN32OLE_TYPELIB object;T;"@q;#[ ;$I"*@return [The WIN32OLE_TYPELIB object];T;%0;"@q;&0;'F;(i ;[ ;"@q;#[ ;$I"6Returns the WIN32OLE_TYPELIB object. The object represents the
type library which contains the WIN32OLE object.
excel = WIN32OLE.new('Excel.Application')
tlib = excel.ole_typelib
puts tlib.name # -> 'Microsoft Excel 9.0 Object Library'
@overload ole_typelib
@return [The WIN32OLE_TYPELIB object];T;%0;"@q;'F;)o;*;+T;,i
;-i
;.@}n; I"static VALUE;T;/I"{static VALUE
fole_typelib(VALUE self)
{
struct oledata *pole = NULL;
HRESULT hr;
ITypeInfo *pTypeInfo;
LCID lcid = cWIN32OLE_lcid;
VALUE vtlib = Qnil;
pole = oledata_get_struct(self);
hr = pole->pDispatch->lpVtbl->GetTypeInfo(pole->pDispatch,
0, lcid, &pTypeInfo);
if(FAILED(hr)) {
ole_raise(hr, rb_eRuntimeError, "failed to GetTypeInfo");
}
vtlib = ole_typelib_from_itypeinfo(pTypeInfo);
OLE_RELEASE(pTypeInfo);
if (vtlib == Qnil) {
rb_raise(rb_eRuntimeError, "failed to get type library info.");
}
return vtlib;
};T;0To;
; F; ;
;;;I"!WIN32OLE#ole_query_interface;F;[[I" str_iid;T0;[[@ni
;T;:ole_query_interface;0;[ ;{ ;IC;"Returns WIN32OLE object for a specific dispatch or dual
interface specified by iid.
ie = WIN32OLE.new('InternetExplorer.Application')
ie_web_app = ie.ole_query_interface('{0002DF05-0000-0000-C000-000000000046}') # => WIN32OLE object for dispinterface IWebBrowserApp
;T;[o;
; I"
overload;F; 0;;; 0; I" ole_query_interface(iid);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"WIN32OLE object;T;"@q;#[ ;$I" @return [WIN32OLE object];T;%0;"@q;&0;'F;(i ;[[I"iid;T0;"@q;#[ ;$I"SReturns WIN32OLE object for a specific dispatch or dual
interface specified by iid.
ie = WIN32OLE.new('InternetExplorer.Application')
ie_web_app = ie.ole_query_interface('{0002DF05-0000-0000-C000-000000000046}') # => WIN32OLE object for dispinterface IWebBrowserApp
@overload ole_query_interface(iid)
@return [WIN32OLE object];T;%0;"@q;'F;)o;*;+T;,i
;-i
;.@}n; I"static VALUE;T;/I"static VALUE
fole_query_interface(VALUE self, VALUE str_iid)
{
HRESULT hr;
OLECHAR *pBuf;
IID iid;
struct oledata *pole = NULL;
IDispatch *pDispatch;
void *p;
pBuf = ole_vstr2wc(str_iid);
hr = CLSIDFromString(pBuf, &iid);
SysFreeString(pBuf);
if(FAILED(hr)) {
ole_raise(hr, eWIN32OLERuntimeError,
"invalid iid: `%s'",
StringValuePtr(str_iid));
}
pole = oledata_get_struct(self);
if(!pole->pDispatch) {
rb_raise(rb_eRuntimeError, "failed to get dispatch interface");
}
hr = pole->pDispatch->lpVtbl->QueryInterface(pole->pDispatch, &iid,
&p);
if(FAILED(hr)) {
ole_raise(hr, eWIN32OLERuntimeError,
"failed to get interface `%s'",
StringValuePtr(str_iid));
}
pDispatch = p;
return create_win32ole_object(cWIN32OLE, pDispatch, 0, 0);
};T;0To;
; F; ;
;;;I" WIN32OLE#ole_respond_to?;F;[[I" method;T0;[[@ni
;T;:ole_respond_to?;0;[ ;{ ;IC;"Returns true when OLE object has OLE method, otherwise returns false.
ie = WIN32OLE.new('InternetExplorer.Application')
ie.ole_respond_to?("gohome") => true
;T;[o;
; I"
overload;F; 0;;; 0; I" ole_respond_to?(method);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@q;#[ ;$I"@return [Boolean];T;%0;"@q;&0;'F;(i ;[[I" method;T0;"@qo;!
; I" return;F; @;0; [@;"@q;#[ ;$I"Returns true when OLE object has OLE method, otherwise returns false.
ie = WIN32OLE.new('InternetExplorer.Application')
ie.ole_respond_to?("gohome") => true
@overload ole_respond_to?(method)
@return [Boolean];T;%0;"@q;'F;)o;*;+T;,i
;-i
;.@}n; I"static VALUE;T;/I"static VALUE
fole_respond_to(VALUE self, VALUE method)
{
struct oledata *pole = NULL;
BSTR wcmdname;
DISPID DispID;
HRESULT hr;
if(!RB_TYPE_P(method, T_STRING) && !RB_TYPE_P(method, T_SYMBOL)) {
rb_raise(rb_eTypeError, "wrong argument type (expected String or Symbol)");
}
if (RB_TYPE_P(method, T_SYMBOL)) {
method = rb_sym2str(method);
}
pole = oledata_get_struct(self);
wcmdname = ole_vstr2wc(method);
hr = pole->pDispatch->lpVtbl->GetIDsOfNames( pole->pDispatch, &IID_NULL,
&wcmdname, 1, cWIN32OLE_lcid, &DispID);
SysFreeString(wcmdname);
return SUCCEEDED(hr) ? Qtrue : Qfalse;
};T;0To;;[[@ni;F;;;;;;;[ ;{ ;IC;" Version string of WIN32OLE.
;T;[ ;#[ ;$I"!Version string of WIN32OLE.
;T;%0;"@q;'F;)o;*;+T;,i;-i;.@}n;I"WIN32OLE::VERSION;F;I""rb_str_new2(WIN32OLE_VERSION);To;;[[@ni;F;: ARGV;;;;;[ ;{ ;IC;"void calcsum(int a, int b, out int c) {
c = a + b;
}
then, the Ruby OLE(COM) client script to retrieve the value of
argument c after invoking calcsum method is following:
a = 10
b = 20
c = 0
comserver.calcsum(a, b, c)
p c # => 0
p WIN32OLE::ARGV # => [10, 20, 30]
You can use WIN32OLE_VARIANT object to retrieve the value of reference
arguments instead of referring WIN32OLE::ARGV.
;T;[ ;#[ ;$I"void calcsum(int a, int b, out int c) {
c = a + b;
}
then, the Ruby OLE(COM) client script to retrieve the value of
argument c after invoking calcsum method is following:
a = 10
b = 20
c = 0
comserver.calcsum(a, b, c)
p c # => 0
p WIN32OLE::ARGV # => [10, 20, 30]
You can use WIN32OLE_VARIANT object to retrieve the value of reference
arguments instead of referring WIN32OLE::ARGV.
;T;%0;"@q;'F;)o;*;+T;,i;-i;.@}n;I"WIN32OLE::ARGV;F;I"After invoking OLE methods with reference arguments, you can access
the value of arguments by using ARGV.
If the method of OLE(COM) server written by C#.NET is following;To;;[[@ni;F;: CP_ACP;;;;;[ ;{ ;IC;"BANSI code page. See WIN32OLE.codepage and WIN32OLE.codepage=.
;T;[ ;#[ ;$I"CANSI code page. See WIN32OLE.codepage and WIN32OLE.codepage=.
;T;%0;"@q;'F;)o;*;+T;,i;-i;.@}n;I"WIN32OLE::CP_ACP;F;I"0;To;;[[@ni;F;:
CP_OEMCP;;;;;[ ;{ ;IC;"AOEM code page. See WIN32OLE.codepage and WIN32OLE.codepage=.
;T;[ ;#[ ;$I"BOEM code page. See WIN32OLE.codepage and WIN32OLE.codepage=.
;T;%0;"@r;'F;)o;*;+T;,i;-i;.@}n;I"WIN32OLE::CP_OEMCP;F;I"1;To;;[[@ni;F;:
CP_MACCP;;;;;[ ;{ ;IC;"2
;T;[ ;#[ ;$I"2
;T;%0;"@r;'F;)o;*;+T;,i;-i;.@}n;I"WIN32OLE::CP_MACCP;F;I"INT2FIX(CP_MACCP);To;;[[@ni;F;:CP_THREAD_ACP;;;;;[ ;{ ;IC;"Qcurrent thread ANSI code page. See WIN32OLE.codepage and
WIN32OLE.codepage=.
;T;[ ;#[ ;$I"Rcurrent thread ANSI code page. See WIN32OLE.codepage and
WIN32OLE.codepage=.
;T;%0;"@ r;'F;)o;*;+T;,i;-i;.@}n;I" WIN32OLE::CP_THREAD_ACP;F;I"3;To;;[[@ni;F;:CP_SYMBOL;;;;;[ ;{ ;IC;"Dsymbol code page. See WIN32OLE.codepage and WIN32OLE.codepage=.
;T;[ ;#[ ;$I"Esymbol code page. See WIN32OLE.codepage and WIN32OLE.codepage=.
;T;%0;"@+r;'F;)o;*;+T;,i;-i;.@}n;I"WIN32OLE::CP_SYMBOL;F;I"42;To;;[[@ni;F;: CP_UTF7;;;;;[ ;{ ;IC;"CUTF-7 code page. See WIN32OLE.codepage and WIN32OLE.codepage=.
;T;[ ;#[ ;$I"DUTF-7 code page. See WIN32OLE.codepage and WIN32OLE.codepage=.
;T;%0;"@7r;'F;)o;*;+T;,i;-i;.@}n;I"WIN32OLE::CP_UTF7;F;I"
65000;To;;[[@ni;F;: CP_UTF8;;;;;[ ;{ ;IC;"CUTF-8 code page. See WIN32OLE.codepage and WIN32OLE.codepage=.
;T;[ ;#[ ;$I"DUTF-8 code page. See WIN32OLE.codepage and WIN32OLE.codepage=.
;T;%0;"@Cr;'F;)o;*;+T;,i;-i;.@}n;I"WIN32OLE::CP_UTF8;F;I"
65001;To;;[[@ni;F;:LOCALE_SYSTEM_DEFAULT;;;;;[ ;{ ;IC;"Wdefault locale for the operating system. See WIN32OLE.locale
and WIN32OLE.locale=.
;T;[ ;#[ ;$I"Xdefault locale for the operating system. See WIN32OLE.locale
and WIN32OLE.locale=.
;T;%0;"@Or;'F;)o;*;+T;,i;-i;.@}n;I"$WIN32OLE::LOCALE_SYSTEM_DEFAULT;F;I" 0x0800;To;;[[@ni;F;:LOCALE_USER_DEFAULT;;;;;[ ;{ ;IC;"Vdefault locale for the user or process. See WIN32OLE.locale
and WIN32OLE.locale=.
;T;[ ;#[ ;$I"Wdefault locale for the user or process. See WIN32OLE.locale
and WIN32OLE.locale=.
;T;%0;"@[r;'F;)o;*;+T;,i;-i;.@}n;I""WIN32OLE::LOCALE_USER_DEFAULT;F;I" 0x0400;To;;IC;[ o;;[[I"&ext/win32ole/win32ole_variant_m.c;Ti;F;:
VT_EMPTY;;;;;[ ;{ ;IC;"'represents VT_EMPTY type constant.
;T;[ ;#[ ;$I"(represents VT_EMPTY type constant.
;T;%0;"@ir;'F;)o;*;+T;,i;-i;.@gr;I" WIN32OLE::VARIANT::VT_EMPTY;F;I"INT2FIX(VT_EMPTY);To;;[[@lri ;F;: VT_NULL;;;;;[ ;{ ;IC;"&represents VT_NULL type constant.
;T;[ ;#[ ;$I"'represents VT_NULL type constant.
;T;%0;"@vr;'F;)o;*;+T;,i;-i ;.@gr;I" WIN32OLE::VARIANT::VT_NULL;F;I"INT2FIX(VT_NULL);To;;[[@lri#;F;:
VT_I2;;;;;[ ;{ ;IC;"$represents VT_I2 type constant.
;T;[ ;#[ ;$I"%represents VT_I2 type constant.
;T;%0;"@r;'F;)o;*;+T;,i ;-i!;.@gr;I" WIN32OLE::VARIANT::VT_I2;F;I"INT2FIX(VT_I2);To;;[[@lri(;F;:
VT_I4;;;;;[ ;{ ;IC;"$represents VT_I4 type constant.
;T;[ ;#[ ;$I"%represents VT_I4 type constant.
;T;%0;"@r;'F;)o;*;+T;,i%;-i&;.@gr;I" WIN32OLE::VARIANT::VT_I4;F;I"INT2FIX(VT_I4);To;;[[@lri-;F;:
VT_R4;;;;;[ ;{ ;IC;"$represents VT_R4 type constant.
;T;[ ;#[ ;$I"%represents VT_R4 type constant.
;T;%0;"@r;'F;)o;*;+T;,i*;-i+;.@gr;I" WIN32OLE::VARIANT::VT_R4;F;I"INT2FIX(VT_R4);To;;[[@lri2;F;:
VT_R8;;;;;[ ;{ ;IC;"$represents VT_R8 type constant.
;T;[ ;#[ ;$I"%represents VT_R8 type constant.
;T;%0;"@r;'F;)o;*;+T;,i/;-i0;.@gr;I" WIN32OLE::VARIANT::VT_R8;F;I"INT2FIX(VT_R8);To;;[[@lri7;F;:
VT_CY;;;;;[ ;{ ;IC;"$represents VT_CY type constant.
;T;[ ;#[ ;$I"%represents VT_CY type constant.
;T;%0;"@r;'F;)o;*;+T;,i4;-i5;.@gr;I" WIN32OLE::VARIANT::VT_CY;F;I"INT2FIX(VT_CY);To;;[[@lri<;F;: VT_DATE;;;;;[ ;{ ;IC;"&represents VT_DATE type constant.
;T;[ ;#[ ;$I"'represents VT_DATE type constant.
;T;%0;"@r;'F;)o;*;+T;,i9;-i:;.@gr;I" WIN32OLE::VARIANT::VT_DATE;F;I"INT2FIX(VT_DATE);To;;[[@lriA;F;: VT_BSTR;;;;;[ ;{ ;IC;"&represents VT_BSTR type constant.
;T;[ ;#[ ;$I"'represents VT_BSTR type constant.
;T;%0;"@r;'F;)o;*;+T;,i>;-i?;.@gr;I" WIN32OLE::VARIANT::VT_BSTR;F;I"INT2FIX(VT_BSTR);To;;[[@lriF;F;:VT_USERDEFINED;;;;;[ ;{ ;IC;"-represents VT_USERDEFINED type constant.
;T;[ ;#[ ;$I".represents VT_USERDEFINED type constant.
;T;%0;"@r;'F;)o;*;+T;,iC;-iD;.@gr;I"&WIN32OLE::VARIANT::VT_USERDEFINED;F;I" INT2FIX(VT_USERDEFINED);To;;[[@lriK;F;: VT_PTR;;;;;[ ;{ ;IC;"%represents VT_PTR type constant.
;T;[ ;#[ ;$I"&represents VT_PTR type constant.
;T;%0;"@r;'F;)o;*;+T;,iH;-iI;.@gr;I" WIN32OLE::VARIANT::VT_PTR;F;I"INT2FIX(VT_PTR);To;;[[@lriP;F;:VT_DISPATCH;;;;;[ ;{ ;IC;"*represents VT_DISPATCH type constant.
;T;[ ;#[ ;$I"+represents VT_DISPATCH type constant.
;T;%0;"@r;'F;)o;*;+T;,iM;-iN;.@gr;I"#WIN32OLE::VARIANT::VT_DISPATCH;F;I"INT2FIX(VT_DISPATCH);To;;[[@lriU;F;:
VT_ERROR;;;;;[ ;{ ;IC;"'represents VT_ERROR type constant.
;T;[ ;#[ ;$I"(represents VT_ERROR type constant.
;T;%0;"@r;'F;)o;*;+T;,iR;-iS;.@gr;I" WIN32OLE::VARIANT::VT_ERROR;F;I"INT2FIX(VT_ERROR);To;;[[@lriZ;F;: VT_BOOL;;;;;[ ;{ ;IC;"&represents VT_BOOL type constant.
;T;[ ;#[ ;$I"'represents VT_BOOL type constant.
;T;%0;"@s;'F;)o;*;+T;,iW;-iX;.@gr;I" WIN32OLE::VARIANT::VT_BOOL;F;I"INT2FIX(VT_BOOL);To;;[[@lri_;F;:VT_VARIANT;;;;;[ ;{ ;IC;")represents VT_VARIANT type constant.
;T;[ ;#[ ;$I"*represents VT_VARIANT type constant.
;T;%0;"@s;'F;)o;*;+T;,i\;-i];.@gr;I""WIN32OLE::VARIANT::VT_VARIANT;F;I"INT2FIX(VT_VARIANT);To;;[[@lrid;F;:VT_UNKNOWN;;;;;[ ;{ ;IC;")represents VT_UNKNOWN type constant.
;T;[ ;#[ ;$I"*represents VT_UNKNOWN type constant.
;T;%0;"@ s;'F;)o;*;+T;,ia;-ib;.@gr;I""WIN32OLE::VARIANT::VT_UNKNOWN;F;I"INT2FIX(VT_UNKNOWN);To;;[[@lrii;F;:
VT_I1;;;;;[ ;{ ;IC;"$represents VT_I1 type constant.
;T;[ ;#[ ;$I"%represents VT_I1 type constant.
;T;%0;"@*s;'F;)o;*;+T;,if;-ig;.@gr;I" WIN32OLE::VARIANT::VT_I1;F;I"INT2FIX(VT_I1);To;;[[@lrin;F;: VT_UI1;;;;;[ ;{ ;IC;"%represents VT_UI1 type constant.
;T;[ ;#[ ;$I"&represents VT_UI1 type constant.
;T;%0;"@6s;'F;)o;*;+T;,ik;-il;.@gr;I" WIN32OLE::VARIANT::VT_UI1;F;I"INT2FIX(VT_UI1);To;;[[@lris;F;: VT_UI2;;;;;[ ;{ ;IC;"%represents VT_UI2 type constant.
;T;[ ;#[ ;$I"&represents VT_UI2 type constant.
;T;%0;"@Bs;'F;)o;*;+T;,ip;-iq;.@gr;I" WIN32OLE::VARIANT::VT_UI2;F;I"INT2FIX(VT_UI2);To;;[[@lrix;F;: VT_UI4;;;;;[ ;{ ;IC;"%represents VT_UI4 type constant.
;T;[ ;#[ ;$I"&represents VT_UI4 type constant.
;T;%0;"@Ns;'F;)o;*;+T;,iu;-iv;.@gr;I" WIN32OLE::VARIANT::VT_UI4;F;I"INT2FIX(VT_UI4);To;;[[@lri~;F;:
VT_I8;;;;;[ ;{ ;IC;"$represents VT_I8 type constant.
;T;[ ;#[ ;$I"%represents VT_I8 type constant.
;T;%0;"@Zs;'F;)o;*;+T;,i{;-i|;.@gr;I" WIN32OLE::VARIANT::VT_I8;F;I"INT2FIX(VT_I8);To;;[[@lri~;F;: VT_UI8;;;;;[ ;{ ;IC;"%represents VT_UI8 type constant.
;T;[ ;#[ ;$I"&represents VT_UI8 type constant.
;T;%0;"@fs;'F;)o;*;+T;,i{;-i|;.@gr;I" WIN32OLE::VARIANT::VT_UI8;F;I"INT2FIX(VT_UI8);To;;[[@lri;F;: VT_INT;;;;;[ ;{ ;IC;"%represents VT_INT type constant.
;T;[ ;#[ ;$I"&represents VT_INT type constant.
;T;%0;"@rs;'F;)o;*;+T;,i;-i;.@gr;I" WIN32OLE::VARIANT::VT_INT;F;I"INT2FIX(VT_INT);To;;[[@lri;F;: VT_UINT;;;;;[ ;{ ;IC;"&represents VT_UINT type constant.
;T;[ ;#[ ;$I"'represents VT_UINT type constant.
;T;%0;"@~s;'F;)o;*;+T;,i;-i;.@gr;I" WIN32OLE::VARIANT::VT_UINT;F;I"INT2FIX(VT_UINT);To;;[[@lri;F;:
VT_ARRAY;;;;;[ ;{ ;IC;"'represents VT_ARRAY type constant.
;T;[ ;#[ ;$I"(represents VT_ARRAY type constant.
;T;%0;"@s;'F;)o;*;+T;,i;-i;.@gr;I" WIN32OLE::VARIANT::VT_ARRAY;F;I"INT2FIX(VT_ARRAY);To;;[[@lri;F;:
VT_BYREF;;;;;[ ;{ ;IC;"'represents VT_BYREF type constant.
;T;[ ;#[ ;$I"(represents VT_BYREF type constant.
;T;%0;"@s;'F;)o;*;+T;,i;-i;.@gr;I" WIN32OLE::VARIANT::VT_BYREF;F;I"INT2FIX(VT_BYREF);T;N@gr;OIC;[ ;N@gr;PIC;[ ;N@gr;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@lri
[@lri;T;: VARIANT;;X;;;[ ;{ ;IC;"The WIN32OLE::VARIANT module includes constants of VARIANT type constants.
The constants is used when creating WIN32OLE_VARIANT object.
obj = WIN32OLE_VARIANT.new("2e3", WIN32OLE::VARIANT::VT_R4)
obj.value # => 2000.0
;T;[ ;#[ ;$I"
The WIN32OLE::VARIANT module includes constants of VARIANT type constants.
The constants is used when creating WIN32OLE_VARIANT object.
obj = WIN32OLE_VARIANT.new("2e3", WIN32OLE::VARIANT::VT_R4)
obj.value # => 2000.0
;T;%0;"@gr;'F;)o;*;+T;,i
;-i;.@}n;I"WIN32OLE::VARIANT;F;N@}n;OIC;[ ;N@}n;PIC;[ ;N@}n;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{@Cq;@|q;;V[ ;[[@niJ [@niQ;T;:
WIN32OLE;;X;;;[ ;{ ;IC;"3WIN32OLE objects represent OLE Automation object in Ruby.
By using WIN32OLE, you can access OLE server like VBScript.
Here is sample script.
require 'win32ole'
excel = WIN32OLE.new('Excel.Application')
excel.visible = true
workbook = excel.Workbooks.Add();
worksheet = workbook.Worksheets(1);
worksheet.Range("A1:D1").value = ["North","South","East","West"];
worksheet.Range("A2:B2").value = [5.2, 10];
worksheet.Range("C2").value = 8;
worksheet.Range("D2").value = 20;
range = worksheet.Range("A1:D2");
range.select
chart = workbook.Charts.Add;
workbook.saved = true;
excel.ActiveWorkbook.Close(0);
excel.Quit();
Unfortunately, Win32OLE doesn't support the argument passed by
reference directly.
Instead, Win32OLE provides WIN32OLE::ARGV or WIN32OLE_VARIANT object.
If you want to get the result value of argument passed by reference,
you can use WIN32OLE::ARGV or WIN32OLE_VARIANT.
oleobj.method(arg1, arg2, refargv3)
puts WIN32OLE::ARGV[2] # the value of refargv3 after called oleobj.method
or
refargv3 = WIN32OLE_VARIANT.new(XXX,
WIN32OLE::VARIANT::VT_BYREF|WIN32OLE::VARIANT::VT_XXX)
oleobj.method(arg1, arg2, refargv3)
p refargv3.value # the value of refargv3 after called oleobj.method.;T;[ ;#[ ;$I"8
WIN32OLE objects represent OLE Automation object in Ruby.
By using WIN32OLE, you can access OLE server like VBScript.
Here is sample script.
require 'win32ole'
excel = WIN32OLE.new('Excel.Application')
excel.visible = true
workbook = excel.Workbooks.Add();
worksheet = workbook.Worksheets(1);
worksheet.Range("A1:D1").value = ["North","South","East","West"];
worksheet.Range("A2:B2").value = [5.2, 10];
worksheet.Range("C2").value = 8;
worksheet.Range("D2").value = 20;
range = worksheet.Range("A1:D2");
range.select
chart = workbook.Charts.Add;
workbook.saved = true;
excel.ActiveWorkbook.Close(0);
excel.Quit();
Unfortunately, Win32OLE doesn't support the argument passed by
reference directly.
Instead, Win32OLE provides WIN32OLE::ARGV or WIN32OLE_VARIANT object.
If you want to get the result value of argument passed by reference,
you can use WIN32OLE::ARGV or WIN32OLE_VARIANT.
oleobj.method(arg1, arg2, refargv3)
puts WIN32OLE::ARGV[2] # the value of refargv3 after called oleobj.method
or
refargv3 = WIN32OLE_VARIANT.new(XXX,
WIN32OLE::VARIANT::VT_BYREF|WIN32OLE::VARIANT::VT_XXX)
oleobj.method(arg1, arg2, refargv3)
p refargv3.value # the value of refargv3 after called oleobj.method.
;T;%0;"@}n;'F;(i ;)o;*;+T;,iJ ;-iu ;.@;I"
WIN32OLE;F;Y@No; ;IC;[;o;
; F; ;
;;;I"Thread#set_trace_func;F;[[I"
trace;T0;[[@
i#;T;;;0;[ ;{ ;IC;"Establishes _proc_ on _thr_ as the handler for tracing, or
disables tracing if the parameter is +nil+.
See Kernel#set_trace_func.
;T;[o;
; I"
overload;F; 0;;; 0; I"set_trace_func(proc);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Proc;T;"@s;#[ ;$I"@return [Proc];T;%0;"@s;&0;'F;(i ;[[I" proc;T0;"@so;
; I"
overload;F; 0;;; 0; I"set_trace_func(nil);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@s;#[ ;$I"@return [nil];T;%0;"@s;&0;'F;(i ;[[I"nil;T0;"@s;#[ ;$I"Establishes _proc_ on _thr_ as the handler for tracing, or
disables tracing if the parameter is +nil+.
See Kernel#set_trace_func.
@overload set_trace_func(proc)
@return [Proc]
@overload set_trace_func(nil)
@return [nil];T;%0;"@s;'F;)o;*;+T;,i;-i!;.@s; I"static VALUE;T;/I"static VALUE
thread_set_trace_func_m(VALUE obj, VALUE trace)
{
rb_thread_t *th;
GetThreadPtr(obj, th);
rb_threadptr_remove_event_hook(th, call_trace_func, Qundef);
if (NIL_P(trace)) {
return Qnil;
}
thread_add_trace_func(th, trace);
return trace;
};T;0To;
; F; ;
;;;I"Thread#add_trace_func;F;[[I"
trace;T0;[[@
i;T;:add_trace_func;0;[ ;{ ;IC;"`Adds _proc_ as a handler for tracing.
See Thread#set_trace_func and Kernel#set_trace_func.
;T;[o;
; I"
overload;F; 0;;; 0; I"add_trace_func(proc);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Proc;T;"@s;#[ ;$I"@return [Proc];T;%0;"@s;&0;'F;(i ;[[I" proc;T0;"@s;#[ ;$I"Adds _proc_ as a handler for tracing.
See Thread#set_trace_func and Kernel#set_trace_func.
@overload add_trace_func(proc)
@return [Proc];T;%0;"@s;'F;)o;*;+T;,i;-i ;.@s; I"static VALUE;T;/I"static VALUE
thread_add_trace_func_m(VALUE obj, VALUE trace)
{
rb_thread_t *th;
GetThreadPtr(obj, th);
thread_add_trace_func(th, trace);
return trace;
};T;0To; ;IC;[o; ;IC;[ o;
; F; ;
;;;I"'Thread::Backtrace::Location#lineno;F;[ ;[[@L i;T;;;0;[ ;{ ;IC;"Returns the line number of this frame.
For example, using +caller_locations.rb+ from Thread::Backtrace::Location
loc = c(0..1).first
loc.lineno #=> 2
;T;[ ;#[ ;$I"Returns the line number of this frame.
For example, using +caller_locations.rb+ from Thread::Backtrace::Location
loc = c(0..1).first
loc.lineno #=> 2
;T;%0;"@t;'F;)o;*;+T;,i;-i;.@t; I"static VALUE;T;/I"lstatic VALUE
location_lineno_m(VALUE self)
{
return INT2FIX(location_lineno(location_ptr(self)));
};T;0To;
; F; ;
;;;I"&Thread::Backtrace::Location#label;F;[ ;[[@L i;T;:
label;0;[ ;{ ;IC;"Returns the label of this frame.
Usually consists of method, class, module, etc names with decoration.
Consider the following example:
def foo
puts caller_locations(0).first.label
1.times do
puts caller_locations(0).first.label
1.times do
puts caller_locations(0).first.label
end
end
end
The result of calling +foo+ is this:
label: foo
label: block in foo
label: block (2 levels) in foo
;T;[ ;#[ ;$I"Returns the label of this frame.
Usually consists of method, class, module, etc names with decoration.
Consider the following example:
def foo
puts caller_locations(0).first.label
1.times do
puts caller_locations(0).first.label
1.times do
puts caller_locations(0).first.label
end
end
end
The result of calling +foo+ is this:
label: foo
label: block in foo
label: block (2 levels) in foo
;T;%0;"@'t;'F;)o;*;+T;,i;-i;.@t; I"static VALUE;T;/I"astatic VALUE
location_label_m(VALUE self)
{
return location_label(location_ptr(self));
};T;0To;
; F; ;
;;;I"+Thread::Backtrace::Location#base_label;F;[ ;[[@L i;T;:base_label;0;[ ;{ ;IC;"WReturns the base label of this frame.
Usually same as #label, without decoration.
;T;[ ;#[ ;$I"XReturns the base label of this frame.
Usually same as #label, without decoration.
;T;%0;"@5t;'F;)o;*;+T;,i;-i;.@t; I"static VALUE;T;/I"kstatic VALUE
location_base_label_m(VALUE self)
{
return location_base_label(location_ptr(self));
};T;0To;
; F; ;
;;;I"%Thread::Backtrace::Location#path;F;[ ;[[@L i;T;: path;0;[ ;{ ;IC;"Returns the file name of this frame.
For example, using +caller_locations.rb+ from Thread::Backtrace::Location
loc = c(0..1).first
loc.path #=> caller_locations.rb
;T;[ ;#[ ;$I"Returns the file name of this frame.
For example, using +caller_locations.rb+ from Thread::Backtrace::Location
loc = c(0..1).first
loc.path #=> caller_locations.rb
;T;%0;"@Ct;'F;)o;*;+T;,i;-i;.@t; I"static VALUE;T;/I"_static VALUE
location_path_m(VALUE self)
{
return location_path(location_ptr(self));
};T;0To;
; F; ;
;;;I".Thread::Backtrace::Location#absolute_path;F;[ ;[[@L i ;T;:absolute_path;0;[ ;{ ;IC;"^Returns the full file path of this frame.
Same as #path, but includes the absolute path.
;T;[ ;#[ ;$I"_Returns the full file path of this frame.
Same as #path, but includes the absolute path.
;T;%0;"@Qt;'F;)o;*;+T;,i;-i ;.@t; I"static VALUE;T;/I"qstatic VALUE
location_absolute_path_m(VALUE self)
{
return location_absolute_path(location_ptr(self));
};T;0To;
; F; ;
;;;I"%Thread::Backtrace::Location#to_s;F;[ ;[[@L i`;T;;I;0;[ ;{ ;IC;"BReturns a Kernel#caller style string representing this frame.
;T;[ ;#[ ;$I"CReturns a Kernel#caller style string representing this frame.
;T;%0;"@_t;'F;)o;*;+T;,i];-i^;.@t; I"static VALUE;T;/I"cstatic VALUE
location_to_str_m(VALUE self)
{
return location_to_str(location_ptr(self));
};T;0To;
; F; ;
;;;I"(Thread::Backtrace::Location#inspect;F;[ ;[[@L ij;T;;J;0;[ ;{ ;IC;"RReturns the same as calling +inspect+ on the string representation of
#to_str
;T;[ ;#[ ;$I"SReturns the same as calling +inspect+ on the string representation of
#to_str
;T;%0;"@mt;'F;)o;*;+T;,if;-ih;.@t; I"static VALUE;T;/I"tstatic VALUE
location_inspect_m(VALUE self)
{
return rb_str_inspect(location_to_str(location_ptr(self)));
};T;0T;N@t;OIC;[ ;N@t;PIC;[ ;N@t;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@L i;F;:
Location;;X;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@t;(i ;.@t;I" Thread::Backtrace::Location;F;Y@N;N@t;OIC;[ ;N@t;PIC;[ ;N@t;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@L i;F;:Backtrace;;X;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@t;.@s;I"Thread::Backtrace;F;Y@No; ;IC;[
o;
; F; ;
;;;I" Thread::Mutex#initialize;F;[ ;[[I"thread_sync.c;Tir;T;;;0;[ ;{ ;IC;"Creates a new Mutex
;T;[o;
; I"
overload;F; 0;;S; 0; I"new;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@t;&0;'F;(i ;[ ;"@t;#[ ;$I"(Creates a new Mutex
@overload new;T;%0;"@t;'F;)o;*;+T;,il;-io;.@t; I"static VALUE;T;/I"Cstatic VALUE
mutex_initialize(VALUE self)
{
return self;
};T;0To;
; F; ;
;;;I"Thread::Mutex#locked?;F;[ ;[[@ti;T;: locked?;0;[ ;{ ;IC;"BReturns +true+ if this lock is currently held by some thread.
;T;[o;
; I"
overload;F; 0;;
; 0; I" locked?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@t;#[ ;$I"@return [Boolean];T;%0;"@t;&0;'F;(i ;[ ;"@to;!
; I" return;F; @;0; [@;"@t;#[ ;$I"jReturns +true+ if this lock is currently held by some thread.
@overload locked?
@return [Boolean];T;%0;"@t;'F;)o;*;+T;,i~;-i};.@t; I"
VALUE;T;/I"VALUE
rb_mutex_locked_p(VALUE self)
{
rb_mutex_t *mutex;
GetMutexPtr(self, mutex);
return mutex->th ? Qtrue : Qfalse;
};T;0To;
; F; ;
;;;I"Thread::Mutex#try_lock;F;[ ;[[@ti;T;:
try_lock;0;[ ;{ ;IC;"aAttempts to obtain the lock and returns immediately. Returns +true+ if the
lock was granted.
;T;[o;
; I"
overload;F; 0;; ; 0; I"
try_lock;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@t;#[ ;$I"@return [Boolean];T;%0;"@t;&0;'F;(i ;[ ;"@t;#[ ;$I"Attempts to obtain the lock and returns immediately. Returns +true+ if the
lock was granted.
@overload try_lock
@return [Boolean];T;%0;"@t;'F;)o;*;+T;,i;-i;.@t; I"
VALUE;T;/I"TVALUE
rb_mutex_trylock(VALUE self)
{
rb_mutex_t *mutex;
VALUE locked = Qfalse;
GetMutexPtr(self, mutex);
native_mutex_lock(&mutex->lock);
if (mutex->th == 0) {
rb_thread_t *th = GET_THREAD();
mutex->th = th;
locked = Qtrue;
mutex_locked(th, self);
}
native_mutex_unlock(&mutex->lock);
return locked;
};T;0To;
; F; ;
;;;I"Thread::Mutex#lock;F;[ ;[[@ti;T;: lock;0;[ ;{ ;IC;"|Attempts to grab the lock and waits if it isn't available.
Raises +ThreadError+ if +mutex+ was locked by the current thread.
;T;[o;
; I"
overload;F; 0;; ; 0; I" lock;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" self;T;"@t;#[ ;$I"@return [self];T;%0;"@t;&0;'F;(i ;[ ;"@t;#[ ;$I"Attempts to grab the lock and waits if it isn't available.
Raises +ThreadError+ if +mutex+ was locked by the current thread.
@overload lock
@return [self];T;%0;"@t;'F;)o;*;+T;,i;-i;.@t; I"
VALUE;T;/I"VALUE
rb_mutex_lock(VALUE self)
{
rb_thread_t *th = GET_THREAD();
rb_mutex_t *mutex;
GetMutexPtr(self, mutex);
/* When running trap handler */
if (!mutex->allow_trap && th->interrupt_mask & TRAP_INTERRUPT_MASK) {
rb_raise(rb_eThreadError, "can't be called from trap context");
}
if (rb_mutex_trylock(self) == Qfalse) {
if (mutex->th == th) {
rb_raise(rb_eThreadError, "deadlock; recursive locking");
}
while (mutex->th != th) {
int interrupted;
enum rb_thread_status prev_status = th->status;
volatile int timeout_ms = 0;
struct rb_unblock_callback oldubf;
set_unblock_function(th, lock_interrupt, mutex, &oldubf, FALSE);
th->status = THREAD_STOPPED_FOREVER;
th->locking_mutex = self;
native_mutex_lock(&mutex->lock);
th->vm->sleeper++;
/*
* Carefully! while some contended threads are in lock_func(),
* vm->sleepr is unstable value. we have to avoid both deadlock
* and busy loop.
*/
if ((vm_living_thread_num(th->vm) == th->vm->sleeper) &&
!patrol_thread) {
timeout_ms = 100;
patrol_thread = th;
}
GVL_UNLOCK_BEGIN();
interrupted = lock_func(th, mutex, (int)timeout_ms);
native_mutex_unlock(&mutex->lock);
GVL_UNLOCK_END();
if (patrol_thread == th)
patrol_thread = NULL;
reset_unblock_function(th, &oldubf);
th->locking_mutex = Qfalse;
if (mutex->th && interrupted == 2) {
rb_check_deadlock(th->vm);
}
if (th->status == THREAD_STOPPED_FOREVER) {
th->status = prev_status;
}
th->vm->sleeper--;
if (mutex->th == th) mutex_locked(th, self);
if (interrupted) {
RUBY_VM_CHECK_INTS_BLOCKING(th);
}
}
}
return self;
};T;0To;
; F; ;
;;;I"Thread::Mutex#unlock;F;[ ;[[@tip;T;: unlock;0;[ ;{ ;IC;"\Releases the lock.
Raises +ThreadError+ if +mutex+ wasn't locked by the current thread.
;T;[o;
; I"
overload;F; 0;;
; 0; I" unlock;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" self;T;"@u;#[ ;$I"@return [self];T;%0;"@u;&0;'F;(i ;[ ;"@u;#[ ;$I"{Releases the lock.
Raises +ThreadError+ if +mutex+ wasn't locked by the current thread.
@overload unlock
@return [self];T;%0;"@u;'F;)o;*;+T;,ii;-in;.@t; I"
VALUE;T;/I"VALUE
rb_mutex_unlock(VALUE self)
{
const char *err;
rb_mutex_t *mutex;
GetMutexPtr(self, mutex);
err = rb_mutex_unlock_th(mutex, GET_THREAD());
if (err) rb_raise(rb_eThreadError, "%s", err);
return self;
};T;0To;
; F; ;
;;;I"Thread::Mutex#sleep;F;[[@0;[[@ti;T;;;0;[ ;{ ;IC;"UReleases the lock and sleeps +timeout+ seconds if it is given and
non-nil or forever. Raises +ThreadError+ if +mutex+ wasn't locked by
the current thread.
When the thread is next woken up, it will attempt to reacquire
the lock.
Note that this method can wakeup without explicit Thread#wakeup call.
For example, receiving signal and so on.
;T;[o;
; I"
overload;F; 0;;; 0; I"sleep(timeout = nil);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Numeric;T;"@!u;#[ ;$I"@return [Numeric];T;%0;"@!u;&0;'F;(i ;[[I" timeout;TI"nil;T;"@!u;#[ ;$I"Releases the lock and sleeps +timeout+ seconds if it is given and
non-nil or forever. Raises +ThreadError+ if +mutex+ wasn't locked by
the current thread.
When the thread is next woken up, it will attempt to reacquire
the lock.
Note that this method can wakeup without explicit Thread#wakeup call.
For example, receiving signal and so on.
@overload sleep(timeout = nil)
@return [Numeric];T;%0;"@!u;'F;)o;*;+T;,i;-i;.@t; I"static VALUE;T;/I"static VALUE
mutex_sleep(int argc, VALUE *argv, VALUE self)
{
VALUE timeout;
rb_scan_args(argc, argv, "01", &timeout);
return rb_mutex_sleep(self, timeout);
};T;0To;
; F; ;
;;;I" Thread::Mutex#synchronize;F;[[I" args;T0;[[@ti;T;:synchronize;0;[ ;{ ;IC;"tObtains a lock, runs the block, and releases the lock when the block
completes. See the example under +Mutex+.
;T;[o;
; I"
overload;F; 0;;; 0; I"synchronize;T;IC;" ;T;[o;!
; I"
yield;F; I"[];T;0; 0;"@@u;#[ ;$I"@yield [];T;%0;"@@u;&0;'F;(i ;[ ;"@@u;#[ ;$I"Obtains a lock, runs the block, and releases the lock when the block
completes. See the example under +Mutex+.
@overload synchronize
@yield [];T;%0;"@@u;'F;)o;*;+T;,i;-i;.@t; I"static VALUE;T;/I"static VALUE
rb_mutex_synchronize_m(VALUE self, VALUE args)
{
if (!rb_block_given_p()) {
rb_raise(rb_eThreadError, "must be called with a block");
}
return rb_mutex_synchronize(self, rb_yield, Qundef);
};T;0To;
; F; ;
;;;I"Thread::Mutex#owned?;F;[ ;[[@ti9;T;: owned?;0;[ ;{ ;IC;"EReturns +true+ if this lock is currently held by current thread.
;T;[o;
; I"
overload;F; 0;;; 0; I" owned?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@[u;#[ ;$I"@return [Boolean];T;%0;"@[u;&0;'F;(i ;[ ;"@[uo;!
; I" return;F; @;0; [@;"@[u;#[ ;$I"lReturns +true+ if this lock is currently held by current thread.
@overload owned?
@return [Boolean];T;%0;"@[u;'F;)o;*;+T;,i3;-i7;.@t; I"
VALUE;T;/I"VALUE
rb_mutex_owned_p(VALUE self)
{
VALUE owned = Qfalse;
rb_thread_t *th = GET_THREAD();
rb_mutex_t *mutex;
GetMutexPtr(self, mutex);
if (mutex->th == th)
owned = Qtrue;
return owned;
};T;0T;N@t;OIC;[ ;N@t;PIC;[ ;N@t;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[@ti;F;:
Mutex;;X;;;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@t;(i ;.@s;I"Thread::Mutex;F;Y@No;
; F; ;S;;;I"Thread.new;F;[[@0;[[I"
thread.c;Ti;T;;S;0;[ ;{ ;IC;"Thread.new(*args, &proc) -> thread
Thread.new(*args) { |args| ... } -> thread
Creates a new thread executing the given block.
Any +args+ given to ::new will be passed to the block:
arr = []
a, b, c = 1, 2, 3
Thread.new(a,b,c) { |d,e,f| arr << d << e << f }.join
arr #=> [1, 2, 3]
A ThreadError exception is raised if ::new is called without a block.
If you're going to subclass Thread, be sure to call super in your
+initialize+ method, otherwise a ThreadError will be raised.
;T;[ ;#[ ;$I" Thread.new(*args, &proc) -> thread
Thread.new(*args) { |args| ... } -> thread
Creates a new thread executing the given block.
Any +args+ given to ::new will be passed to the block:
arr = []
a, b, c = 1, 2, 3
Thread.new(a,b,c) { |d,e,f| arr << d << e << f }.join
arr #=> [1, 2, 3]
A ThreadError exception is raised if ::new is called without a block.
If you're going to subclass Thread, be sure to call super in your
+initialize+ method, otherwise a ThreadError will be raised.
;T;%0;"@u;'F;)o;*;+T;,i;-i;.@s; I"static VALUE;T;/I"static VALUE
thread_s_new(int argc, VALUE *argv, VALUE klass)
{
rb_thread_t *th;
VALUE thread = rb_thread_alloc(klass);
if (GET_VM()->main_thread->status == THREAD_KILLED)
rb_raise(rb_eThreadError, "can't alloc thread");
rb_obj_call_init(thread, argc, argv);
GetThreadPtr(thread, th);
if (!threadptr_initialized(th)) {
rb_raise(rb_eThreadError, "uninitialized thread - check `%"PRIsVALUE"#initialize'",
klass);
}
return thread;
};T;0To;
; F; ;S;;;I"Thread.start;F;[[I" args;T0;[[@ui;T;;J;0;[ ;{ ;IC;"Basically the same as ::new. However, if class Thread is subclassed, then
calling +start+ in that subclass will not invoke the subclass's
+initialize+ method.
;T;[o;
; I"
overload;F; 0;;J; 0; I"start([args]*);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" args;T;"@u;#[ ;$I"@yield [args];T;%0;"@u;&0;'F;(i ;[[I" [args];T0;"@uo;
; I"
overload;F; 0;;; 0; I"fork([args]*);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" args;T;"@u;#[ ;$I"@yield [args];T;%0;"@u;&0;'F;(i ;[[I" [args];T0;"@u;#[ ;$I"Basically the same as ::new. However, if class Thread is subclassed, then
calling +start+ in that subclass will not invoke the subclass's
+initialize+ method.
@overload start([args]*)
@yield [args]
@overload fork([args]*)
@yield [args];T;%0;"@u;'F;)o;*;+T;,i;-i;.@s; I"static VALUE;T;/I"{static VALUE
thread_start(VALUE klass, VALUE args)
{
return thread_create_core(rb_thread_alloc(klass), args, 0);
};T;0To;
; F; ;S;;;I"Thread.fork;F;[[I" args;T0;[[@ui;T;;;0;[ ;{ ;IC;"Basically the same as ::new. However, if class Thread is subclassed, then
calling +start+ in that subclass will not invoke the subclass's
+initialize+ method.
;T;[o;
; I"
overload;F; 0;;J; 0; I"start([args]*);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" args;T;"@u;#[ ;$I"@yield [args];T;%0;"@u;&0;'F;(i ;[[I" [args];T0;"@uo;
; I"
overload;F; 0;;; 0; I"fork([args]*);T;IC;" ;T;[o;!
; I"
yield;F; I" ;T;0; [I" args;T;"@u;#[ ;$I"@yield [args];T;%0;"@u;&0;'F;(i ;[[I" [args];T0;"@u;#[ ;$@u;%0;"@u;'F;)o;*;+T;,i;-i;.@s; I"static VALUE;T;/I"{static VALUE
thread_start(VALUE klass, VALUE args)
{
return thread_create_core(rb_thread_alloc(klass), args, 0);
};T;0To;
; F; ;S;;;I"Thread.main;F;[ ;[[@ui ;T;: main;0;[ ;{ ;IC;" Returns the main thread.
;T;[o;
; I"
overload;F; 0;;; 0; I" main;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@u;&0;'F;(i ;[ ;"@u;#[ ;$I".Returns the main thread.
@overload main;T;%0;"@u;'F;)o;*;+T;,i ;-i ;.@s; I"static VALUE;T;/I"Pstatic VALUE
rb_thread_s_main(VALUE klass)
{
return rb_thread_main();
};T;0To;
; F; ;S;;;I"Thread.current;F;[ ;[[@ui ;T;: current;0;[ ;{ ;IC;"^Returns the currently executing thread.
Thread.current #=> #
;T;[o;
; I"
overload;F; 0;;; 0; I" current;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@ v;&0;'F;(i ;[ ;"@ v;#[ ;$I"rReturns the currently executing thread.
Thread.current #=> #
@overload current;T;%0;"@ v;'F;)o;*;+T;,i ;-i ;.@s; I"static VALUE;T;/I"Sstatic VALUE
thread_s_current(VALUE klass)
{
return rb_thread_current();
};T;0To;
; F; ;S;;;I"Thread.stop;F;[ ;[[@uiS ;T;: stop;0;[ ;{ ;IC;"Stops execution of the current thread, putting it into a ``sleep'' state,
and schedules execution of another thread.
a = Thread.new { print "a"; Thread.stop; print "c" }
sleep 0.1 while a.status!='sleep'
print "b"
a.run
a.join
#=> "abc"
;T;[o;
; I"
overload;F; 0;;; 0; I" stop;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@ v;#[ ;$I"@return [nil];T;%0;"@ v;&0;'F;(i ;[ ;"@ v;#[ ;$I" Stops execution of the current thread, putting it into a ``sleep'' state,
and schedules execution of another thread.
a = Thread.new { print "a"; Thread.stop; print "c" }
sleep 0.1 while a.status!='sleep'
print "b"
a.run
a.join
#=> "abc"
@overload stop
@return [nil];T;%0;"@ v;'F;)o;*;+T;,iD ;-iP ;.@s; I"
VALUE;T;/I"VALUE
rb_thread_stop(void)
{
if (rb_thread_alone()) {
rb_raise(rb_eThreadError,
"stopping only thread\n\tnote: use sleep to stop forever");
}
rb_thread_sleep_deadly();
return Qnil;
};T;0To;
; F; ;S;;;I"Thread.kill;F;[[I"th;T0;[[@ui;T;: kill;0;[ ;{ ;IC;"Causes the given +thread+ to exit, see also Thread::exit.
count = 0
a = Thread.new { loop { count += 1 } }
sleep(0.1) #=> 0
Thread.kill(a) #=> #
count #=> 93947
a.alive? #=> false
;T;[o;
; I"
overload;F; 0;;; 0; I"kill(thread);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@:v;&0;'F;(i ;[[I" thread;T0;"@:v;#[ ;$I"Causes the given +thread+ to exit, see also Thread::exit.
count = 0
a = Thread.new { loop { count += 1 } }
sleep(0.1) #=> 0
Thread.kill(a) #=> #
count #=> 93947
a.alive? #=> false
@overload kill(thread);T;%0;"@:v;'F;)o;*;+T;,i;-i;.@s; I"static VALUE;T;/I"Zstatic VALUE
rb_thread_s_kill(VALUE obj, VALUE th)
{
return rb_thread_kill(th);
};T;0To;
; F; ;S;;;I"Thread.exit;F;[ ;[[@ui;T;;;0;[ ;{ ;IC;"Terminates the currently running thread and schedules another thread to be
run.
If this thread is already marked to be killed, ::exit returns the Thread.
If this is the main thread, or the last thread, exit the process.
;T;[o;
; I"
overload;F; 0;;; 0; I" exit;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@Tv;&0;'F;(i ;[ ;"@Tv;#[ ;$I"Terminates the currently running thread and schedules another thread to be
run.
If this thread is already marked to be killed, ::exit returns the Thread.
If this is the main thread, or the last thread, exit the process.
@overload exit;T;%0;"@Tv;'F;)o;*;+T;,i;-i;.@s; I"static VALUE;T;/I"sstatic VALUE
rb_thread_exit(void)
{
rb_thread_t *th = GET_THREAD();
return rb_thread_kill(th->self);
};T;0To;
; F; ;S;;;I"Thread.pass;F;[ ;[[@ui;T;: pass;0;[ ;{ ;IC;"Give the thread scheduler a hint to pass execution to another thread.
A running thread may or may not switch, it depends on OS and processor.
;T;[o;
; I"
overload;F; 0;;; 0; I" pass;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@jv;#[ ;$I"@return [nil];T;%0;"@jv;&0;'F;(i ;[ ;"@jv;#[ ;$I"Give the thread scheduler a hint to pass execution to another thread.
A running thread may or may not switch, it depends on OS and processor.
@overload pass
@return [nil];T;%0;"@jv;'F;)o;*;+T;,i;-i;.@s; I"static VALUE;T;/I"[static VALUE
thread_s_pass(VALUE klass)
{
rb_thread_schedule();
return Qnil;
};T;0To;
; F; ;S;;;I"Thread.list;F;[ ;[[@uit ;T;;;0;[ ;{ ;IC;"eReturns an array of Thread objects for all threads that are either runnable
or stopped.
Thread.new { sleep(200) }
Thread.new { 1000000.times {|i| i*i } }
Thread.new { Thread.stop }
Thread.list.each {|t| p t}
This will produce:
#
#
#
#
;T;[o;
; I"
overload;F; 0;;; 0; I" list;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@v;#[ ;$I"@return [Array];T;%0;"@v;&0;'F;(i ;[ ;"@v;#[ ;$I"Returns an array of Thread objects for all threads that are either runnable
or stopped.
Thread.new { sleep(200) }
Thread.new { 1000000.times {|i| i*i } }
Thread.new { Thread.stop }
Thread.list.each {|t| p t}
This will produce:
#
#
#
#
@overload list
@return [Array];T;%0;"@v;'F;)o;*;+T;,i` ;-iq ;.@s; I"
VALUE;T;/I"lVALUE
rb_thread_list(void)
{
VALUE ary = rb_ary_new();
rb_vm_t *vm = GET_THREAD()->vm;
rb_thread_t *th = 0;
list_for_each(&vm->living_threads, th, vmlt_node) {
switch (th->status) {
case THREAD_RUNNABLE:
case THREAD_STOPPED:
case THREAD_STOPPED_FOREVER:
rb_ary_push(ary, th->self);
default:
break;
}
}
return ary;
};T;0To;
; F; ;S;;;I" Thread.abort_on_exception;F;[ ;[[@ui ;T;:abort_on_exception;0;[ ;{ ;IC;"Returns the status of the global ``abort on exception'' condition.
The default is +false+.
When set to +true+, all threads will abort (the process will
exit(0)) if an exception is raised in any thread.
Can also be specified by the global $DEBUG flag or command line option
+-d+.
See also ::abort_on_exception=.
There is also an instance level method to set this for a specific thread,
see #abort_on_exception.
;T;[o;
; I"
overload;F; 0;;; 0; I"abort_on_exception;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@v;#[ ;$I"@return [Boolean];T;%0;"@v;&0;'F;(i ;[ ;"@v;#[ ;$I"Returns the status of the global ``abort on exception'' condition.
The default is +false+.
When set to +true+, all threads will abort (the process will
exit(0)) if an exception is raised in any thread.
Can also be specified by the global $DEBUG flag or command line option
+-d+.
See also ::abort_on_exception=.
There is also an instance level method to set this for a specific thread,
see #abort_on_exception.
@overload abort_on_exception
@return [Boolean];T;%0;"@v;'F;)o;*;+T;,i ;-i ;.@s; I"static VALUE;T;/I"zstatic VALUE
rb_thread_s_abort_exc(void)
{
return GET_THREAD()->vm->thread_abort_on_exception ? Qtrue : Qfalse;
};T;0To;
; F; ;S;;;I" Thread.abort_on_exception=;F;[[I"val;T0;[[@ui ;T;:abort_on_exception=;0;[ ;{ ;IC;".When set to +true+, all threads will abort if an exception is raised.
Returns the new state.
Thread.abort_on_exception = true
t1 = Thread.new do
puts "In new thread"
raise "Exception from thread"
end
sleep(1)
puts "not reached"
This will produce:
In new thread
prog.rb:4: Exception from thread (RuntimeError)
from prog.rb:2:in `initialize'
from prog.rb:2:in `new'
from prog.rb:2
See also ::abort_on_exception.
There is also an instance level method to set this for a specific thread,
see #abort_on_exception=.
;T;[o;
; I"
overload;F; 0;;; 0; I"!abort_on_exception=(boolean);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@v;#[ ;$I"@return [Boolean];T;%0;"@v;&0;'F;(i ;[[I" boolean;T0;"@v;#[ ;$I"kWhen set to +true+, all threads will abort if an exception is raised.
Returns the new state.
Thread.abort_on_exception = true
t1 = Thread.new do
puts "In new thread"
raise "Exception from thread"
end
sleep(1)
puts "not reached"
This will produce:
In new thread
prog.rb:4: Exception from thread (RuntimeError)
from prog.rb:2:in `initialize'
from prog.rb:2:in `new'
from prog.rb:2
See also ::abort_on_exception.
There is also an instance level method to set this for a specific thread,
see #abort_on_exception=.
@overload abort_on_exception=(boolean)
@return [Boolean];T;%0;"@v;'F;)o;*;+T;,i ;-i ;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_s_abort_exc_set(VALUE self, VALUE val)
{
GET_THREAD()->vm->thread_abort_on_exception = RTEST(val);
return val;
};T;0To;
; F; ;S;;;I"Thread.DEBUG;F;[ ;[[@ui;T;:
DEBUG;0;[ ;{ ;IC;"VReturns the thread debug level. Available only if compiled with
THREAD_DEBUG=-1.
;T;[o;
; I"
overload;F; 0;;; 0; I"
DEBUG;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Numeric;T;"@v;#[ ;$I"@return [Numeric];T;%0;"@v;&0;'F;(i ;[ ;"@v;#[ ;$I"|Returns the thread debug level. Available only if compiled with
THREAD_DEBUG=-1.
@overload DEBUG
@return [Numeric];T;%0;"@v;'F;)o;*;+T;,i;-i;.@s; I"static VALUE;T;/I"Zstatic VALUE
rb_thread_s_debug(void)
{
return INT2NUM(rb_thread_debug_enabled);
};T;0To;
; F; ;S;;;I"Thread.DEBUG=;F;[[I"val;T0;[[@ui;T;: DEBUG=;0;[ ;{ ;IC;"SSets the thread debug level. Available only if compiled with
THREAD_DEBUG=-1.
;T;[o;
; I"
overload;F; 0;;; 0; I"DEBUG=(num);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@v;&0;'F;(i ;[[I"num;T0;"@v;#[ ;$I"kSets the thread debug level. Available only if compiled with
THREAD_DEBUG=-1.
@overload DEBUG=(num);T;%0;"@v;'F;)o;*;+T;,i;-i;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_s_debug_set(VALUE self, VALUE val)
{
rb_thread_debug_enabled = RTEST(val) ? NUM2INT(val) : 0;
return val;
};T;0To;
; F; ;S;;;I" Thread.handle_interrupt;F;[[I"
mask_arg;T0;[[@ui;T;:handle_interrupt;0;[ ;{ ;IC;"X
Changes asynchronous interrupt timing.
_interrupt_ means asynchronous event and corresponding procedure
by Thread#raise, Thread#kill, signal trap (not supported yet)
and main thread termination (if main thread terminates, then all
other thread will be killed).
The given +hash+ has pairs like ExceptionClass =>
:TimingSymbol. Where the ExceptionClass is the interrupt handled by
the given block. The TimingSymbol can be one of the following symbols:
[+:immediate+] Invoke interrupts immediately.
[+:on_blocking+] Invoke interrupts while _BlockingOperation_.
[+:never+] Never invoke all interrupts.
_BlockingOperation_ means that the operation will block the calling thread,
such as read and write. On CRuby implementation, _BlockingOperation_ is any
operation executed without GVL.
Masked asynchronous interrupts are delayed until they are enabled.
This method is similar to sigprocmask(3).
=== NOTE
Asynchronous interrupts are difficult to use.
If you need to communicate between threads, please consider to use another way such as Queue.
Or use them with deep understanding about this method.
=== Usage
In this example, we can guard from Thread#raise exceptions.
Using the +:never+ TimingSymbol the RuntimeError exception will always be
ignored in the first block of the main thread. In the second
::handle_interrupt block we can purposefully handle RuntimeError exceptions.
th = Thread.new do
Thread.handle_interrupt(RuntimeError => :never) {
begin
# You can write resource allocation code safely.
Thread.handle_interrupt(RuntimeError => :immediate) {
# ...
}
ensure
# You can write resource deallocation code safely.
end
}
end
Thread.pass
# ...
th.raise "stop"
While we are ignoring the RuntimeError exception, it's safe to write our
resource allocation code. Then, the ensure block is where we can safely
deallocate your resources.
==== Guarding from Timeout::Error
In the next example, we will guard from the Timeout::Error exception. This
will help prevent from leaking resources when Timeout::Error exceptions occur
during normal ensure clause. For this example we use the help of the
standard library Timeout, from lib/timeout.rb
require 'timeout'
Thread.handle_interrupt(Timeout::Error => :never) {
timeout(10){
# Timeout::Error doesn't occur here
Thread.handle_interrupt(Timeout::Error => :on_blocking) {
# possible to be killed by Timeout::Error
# while blocking operation
}
# Timeout::Error doesn't occur here
}
}
In the first part of the +timeout+ block, we can rely on Timeout::Error being
ignored. Then in the Timeout::Error => :on_blocking block, any
operation that will block the calling thread is susceptible to a
Timeout::Error exception being raised.
==== Stack control settings
It's possible to stack multiple levels of ::handle_interrupt blocks in order
to control more than one ExceptionClass and TimingSymbol at a time.
Thread.handle_interrupt(FooError => :never) {
Thread.handle_interrupt(BarError => :never) {
# FooError and BarError are prohibited.
}
}
==== Inheritance with ExceptionClass
All exceptions inherited from the ExceptionClass parameter will be considered.
Thread.handle_interrupt(Exception => :never) {
# all exceptions inherited from Exception are prohibited.
}
;T;[o;
; I"
overload;F; 0;;; 0; I"handle_interrupt(hash);T;IC;" ;T;[o;!
; I"
yield;F; I"[];T;0; 0;"@w;#[ ;$I"@yield [];T;%0;"@w;&0;'F;(i ;[[I" hash;T0;"@w;#[ ;$I"
Changes asynchronous interrupt timing.
_interrupt_ means asynchronous event and corresponding procedure
by Thread#raise, Thread#kill, signal trap (not supported yet)
and main thread termination (if main thread terminates, then all
other thread will be killed).
The given +hash+ has pairs like ExceptionClass =>
:TimingSymbol. Where the ExceptionClass is the interrupt handled by
the given block. The TimingSymbol can be one of the following symbols:
[+:immediate+] Invoke interrupts immediately.
[+:on_blocking+] Invoke interrupts while _BlockingOperation_.
[+:never+] Never invoke all interrupts.
_BlockingOperation_ means that the operation will block the calling thread,
such as read and write. On CRuby implementation, _BlockingOperation_ is any
operation executed without GVL.
Masked asynchronous interrupts are delayed until they are enabled.
This method is similar to sigprocmask(3).
=== NOTE
Asynchronous interrupts are difficult to use.
If you need to communicate between threads, please consider to use another way such as Queue.
Or use them with deep understanding about this method.
=== Usage
In this example, we can guard from Thread#raise exceptions.
Using the +:never+ TimingSymbol the RuntimeError exception will always be
ignored in the first block of the main thread. In the second
::handle_interrupt block we can purposefully handle RuntimeError exceptions.
th = Thread.new do
Thread.handle_interrupt(RuntimeError => :never) {
begin
# You can write resource allocation code safely.
Thread.handle_interrupt(RuntimeError => :immediate) {
# ...
}
ensure
# You can write resource deallocation code safely.
end
}
end
Thread.pass
# ...
th.raise "stop"
While we are ignoring the RuntimeError exception, it's safe to write our
resource allocation code. Then, the ensure block is where we can safely
deallocate your resources.
==== Guarding from Timeout::Error
In the next example, we will guard from the Timeout::Error exception. This
will help prevent from leaking resources when Timeout::Error exceptions occur
during normal ensure clause. For this example we use the help of the
standard library Timeout, from lib/timeout.rb
require 'timeout'
Thread.handle_interrupt(Timeout::Error => :never) {
timeout(10){
# Timeout::Error doesn't occur here
Thread.handle_interrupt(Timeout::Error => :on_blocking) {
# possible to be killed by Timeout::Error
# while blocking operation
}
# Timeout::Error doesn't occur here
}
}
In the first part of the +timeout+ block, we can rely on Timeout::Error being
ignored. Then in the Timeout::Error => :on_blocking block, any
operation that will block the calling thread is susceptible to a
Timeout::Error exception being raised.
==== Stack control settings
It's possible to stack multiple levels of ::handle_interrupt blocks in order
to control more than one ExceptionClass and TimingSymbol at a time.
Thread.handle_interrupt(FooError => :never) {
Thread.handle_interrupt(BarError => :never) {
# FooError and BarError are prohibited.
}
}
==== Inheritance with ExceptionClass
All exceptions inherited from the ExceptionClass parameter will be considered.
Thread.handle_interrupt(Exception => :never) {
# all exceptions inherited from Exception are prohibited.
}
@overload handle_interrupt(hash)
@yield [];T;%0;"@w;'F;)o;*;+T;,i;-i;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_s_handle_interrupt(VALUE self, VALUE mask_arg)
{
VALUE mask;
rb_thread_t *th = GET_THREAD();
volatile VALUE r = Qnil;
int state;
if (!rb_block_given_p()) {
rb_raise(rb_eArgError, "block is needed.");
}
mask = 0;
mask_arg = rb_convert_type(mask_arg, T_HASH, "Hash", "to_hash");
rb_hash_foreach(mask_arg, handle_interrupt_arg_check_i, (VALUE)&mask);
if (!mask) {
return rb_yield(Qnil);
}
OBJ_FREEZE_RAW(mask);
rb_ary_push(th->pending_interrupt_mask_stack, mask);
if (!rb_threadptr_pending_interrupt_empty_p(th)) {
th->pending_interrupt_queue_checked = 0;
RUBY_VM_SET_INTERRUPT(th);
}
TH_PUSH_TAG(th);
if ((state = EXEC_TAG()) == 0) {
r = rb_yield(Qnil);
}
TH_POP_TAG();
rb_ary_pop(th->pending_interrupt_mask_stack);
if (!rb_threadptr_pending_interrupt_empty_p(th)) {
th->pending_interrupt_queue_checked = 0;
RUBY_VM_SET_INTERRUPT(th);
}
RUBY_VM_CHECK_INTS(th);
if (state) {
JUMP_TAG(state);
}
return r;
};T;0To;
; F; ;S;;;I" Thread.pending_interrupt?;F;[[@0;[[@ui;T;:pending_interrupt?;0;[ ;{ ;IC;"Returns whether or not the asynchronous queue is empty.
Since Thread::handle_interrupt can be used to defer asynchronous events,
this method can be used to determine if there are any deferred events.
If you find this method returns true, then you may finish +:never+ blocks.
For example, the following method processes deferred asynchronous events
immediately.
def Thread.kick_interrupt_immediately
Thread.handle_interrupt(Object => :immediate) {
Thread.pass
}
end
If +error+ is given, then check only for +error+ type deferred events.
=== Usage
th = Thread.new{
Thread.handle_interrupt(RuntimeError => :on_blocking){
while true
...
# reach safe point to invoke interrupt
if Thread.pending_interrupt?
Thread.handle_interrupt(Object => :immediate){}
end
...
end
}
}
...
th.raise # stop thread
This example can also be written as the following, which you should use to
avoid asynchronous interrupts.
flag = true
th = Thread.new{
Thread.handle_interrupt(RuntimeError => :on_blocking){
while true
...
# reach safe point to invoke interrupt
break if flag == false
...
end
}
}
...
flag = false # stop thread
;T;[o;
; I"
overload;F; 0;;; 0; I"$pending_interrupt?(error = nil);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@,w;&0;'F;(i ;[[I"
error;TI"nil;T;"@,wo;!
; I" return;F; @;0; [@;"@,w;#[ ;$I" Returns whether or not the asynchronous queue is empty.
Since Thread::handle_interrupt can be used to defer asynchronous events,
this method can be used to determine if there are any deferred events.
If you find this method returns true, then you may finish +:never+ blocks.
For example, the following method processes deferred asynchronous events
immediately.
def Thread.kick_interrupt_immediately
Thread.handle_interrupt(Object => :immediate) {
Thread.pass
}
end
If +error+ is given, then check only for +error+ type deferred events.
=== Usage
th = Thread.new{
Thread.handle_interrupt(RuntimeError => :on_blocking){
while true
...
# reach safe point to invoke interrupt
if Thread.pending_interrupt?
Thread.handle_interrupt(Object => :immediate){}
end
...
end
}
}
...
th.raise # stop thread
This example can also be written as the following, which you should use to
avoid asynchronous interrupts.
flag = true
th = Thread.new{
Thread.handle_interrupt(RuntimeError => :on_blocking){
while true
...
# reach safe point to invoke interrupt
break if flag == false
...
end
}
}
...
flag = false # stop thread
@overload pending_interrupt?(error = nil);T;%0;"@,w;'F;)o;*;+T;,io;-i;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_s_pending_interrupt_p(int argc, VALUE *argv, VALUE self)
{
return rb_thread_pending_interrupt_p(argc, argv, GET_THREAD()->self);
};T;0To;
; F; ;
;;;I" Thread#pending_interrupt?;F;[[@0;[[@uiP;T;;;0;[ ;{ ;IC;"Returns whether or not the asynchronous queue is empty for the target thread.
If +error+ is given, then check only for +error+ type deferred events.
See ::pending_interrupt? for more information.
;T;[o;
; I"
overload;F; 0;;; 0; I"$pending_interrupt?(error = nil);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@Iw;&0;'F;(i ;[[I"
error;TI"nil;T;"@Iwo;!
; I" return;F; @;0; [@;"@Iw;#[ ;$I"Returns whether or not the asynchronous queue is empty for the target thread.
If +error+ is given, then check only for +error+ type deferred events.
See ::pending_interrupt? for more information.
@overload pending_interrupt?(error = nil);T;%0;"@Iw;'F;)o;*;+T;,iF;-iM;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_pending_interrupt_p(int argc, VALUE *argv, VALUE target_thread)
{
rb_thread_t *target_th;
GetThreadPtr(target_thread, target_th);
if (!target_th->pending_interrupt_queue) {
return Qfalse;
}
if (rb_threadptr_pending_interrupt_empty_p(target_th)) {
return Qfalse;
}
else {
if (argc == 1) {
VALUE err;
rb_scan_args(argc, argv, "01", &err);
if (!rb_obj_is_kind_of(err, rb_cModule)) {
rb_raise(rb_eTypeError, "class or module required for rescue clause");
}
if (rb_threadptr_pending_interrupt_include_p(target_th, err)) {
return Qtrue;
}
else {
return Qfalse;
}
}
return Qtrue;
}
};T;0To;
; F; ;
;;;I"Thread#initialize;F;[[I" args;T0;[[@ui;T;;;0;[ ;{ ;IC;" :nodoc:
;T;[ ;#[ ;$I" :nodoc:;T;%0;"@fw;'F;)o;*;+T;,i;-i;.@s; I"static VALUE;T;/I"static VALUE
thread_initialize(VALUE thread, VALUE args)
{
rb_thread_t *th;
if (!rb_block_given_p()) {
rb_raise(rb_eThreadError, "must be called with a block");
}
GetThreadPtr(thread, th);
if (th->first_args) {
VALUE proc = th->first_proc, line, loc;
VALUE file;
if (!proc || !RTEST(loc = rb_proc_location(proc))) {
rb_raise(rb_eThreadError, "already initialized thread");
}
file = RARRAY_AREF(loc, 0);
if (NIL_P(line = RARRAY_AREF(loc, 1))) {
rb_raise(rb_eThreadError,
"already initialized thread - %"PRIsVALUE, file);
}
rb_raise(rb_eThreadError,
"already initialized thread - %"PRIsVALUE":%"PRIsVALUE,
file, line);
}
return thread_create_core(thread, args, 0);
};T;0To;
; F; ;
;;;I"Thread#raise;F;[[@0;[[@ui;T;;;0;[ ;{ ;IC;"]Raises an exception from the given thread. The caller does not have to be
+thr+. See Kernel#raise for more information.
Thread.abort_on_exception = true
a = Thread.new { sleep(200) }
a.raise("Gotcha")
This will produce:
prog.rb:3: Gotcha (RuntimeError)
from prog.rb:2:in `initialize'
from prog.rb:2:in `new'
from prog.rb:2
;T;[o;
; I"
overload;F; 0;;; 0; I"
raise;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@vw;&0;'F;(i ;[ ;"@vwo;
; I"
overload;F; 0;;; 0; I"raise(string);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@vw;&0;'F;(i ;[[I" string;T0;"@vwo;
; I"
overload;F; 0;;; 0; I"*raise(exception [, string [, array]]);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@vw;&0;'F;(i ;[[I""exception[, string [, array]];T0;"@vw;#[ ;$I"Raises an exception from the given thread. The caller does not have to be
+thr+. See Kernel#raise for more information.
Thread.abort_on_exception = true
a = Thread.new { sleep(200) }
a.raise("Gotcha")
This will produce:
prog.rb:3: Gotcha (RuntimeError)
from prog.rb:2:in `initialize'
from prog.rb:2:in `new'
from prog.rb:2
@overload raise
@overload raise(string)
@overload raise(exception [, string [, array]]);T;%0;"@vw;'F;)o;*;+T;,ix;-i;.@s; I"static VALUE;T;/I"static VALUE
thread_raise_m(int argc, VALUE *argv, VALUE self)
{
rb_thread_t *target_th;
rb_thread_t *th = GET_THREAD();
GetThreadPtr(self, target_th);
threadptr_check_pending_interrupt_queue(target_th);
rb_threadptr_raise(target_th, argc, argv);
/* To perform Thread.current.raise as Kernel.raise */
if (th == target_th) {
RUBY_VM_CHECK_INTS(th);
}
return Qnil;
};T;0To;
; F; ;
;;;I"Thread#join;F;[[@0;[[@ui;T;: join;0;[ ;{ ;IC;"The calling thread will suspend execution and run this +thr+.
Does not return until +thr+ exits or until the given +limit+ seconds have
passed.
If the time limit expires, +nil+ will be returned, otherwise +thr+ is
returned.
Any threads not joined will be killed when the main program exits.
If +thr+ had previously raised an exception and the ::abort_on_exception or
$DEBUG flags are not set, (so the exception has not yet been processed), it
will be processed at this time.
a = Thread.new { print "a"; sleep(10); print "b"; print "c" }
x = Thread.new { print "x"; Thread.pass; print "y"; print "z" }
x.join # Let thread x finish, thread a will be killed on exit.
#=> "axyz"
The following example illustrates the +limit+ parameter.
y = Thread.new { 4.times { sleep 0.1; puts 'tick... ' }}
puts "Waiting" until y.join(0.15)
This will produce:
tick...
Waiting
tick...
Waiting
tick...
tick...
;T;[o;
; I"
overload;F; 0;; ; 0; I" join;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@w;&0;'F;(i ;[ ;"@wo;
; I"
overload;F; 0;; ; 0; I"join(limit);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@w;&0;'F;(i ;[[I"
limit;T0;"@w;#[ ;$I"The calling thread will suspend execution and run this +thr+.
Does not return until +thr+ exits or until the given +limit+ seconds have
passed.
If the time limit expires, +nil+ will be returned, otherwise +thr+ is
returned.
Any threads not joined will be killed when the main program exits.
If +thr+ had previously raised an exception and the ::abort_on_exception or
$DEBUG flags are not set, (so the exception has not yet been processed), it
will be processed at this time.
a = Thread.new { print "a"; sleep(10); print "b"; print "c" }
x = Thread.new { print "x"; Thread.pass; print "y"; print "z" }
x.join # Let thread x finish, thread a will be killed on exit.
#=> "axyz"
The following example illustrates the +limit+ parameter.
y = Thread.new { 4.times { sleep 0.1; puts 'tick... ' }}
puts "Waiting" until y.join(0.15)
This will produce:
tick...
Waiting
tick...
Waiting
tick...
tick...
@overload join
@overload join(limit);T;%0;"@w;'F;)o;*;+T;,i;-i;.@s; I"static VALUE;T;/I"Estatic VALUE
thread_join_m(int argc, VALUE *argv, VALUE self)
{
rb_thread_t *target_th;
double delay = DELAY_INFTY;
VALUE limit;
GetThreadPtr(self, target_th);
rb_scan_args(argc, argv, "01", &limit);
if (!NIL_P(limit)) {
delay = rb_num2dbl(limit);
}
return thread_join(target_th, delay);
};T;0To;
; F; ;
;;;I"Thread#value;F;[ ;[[@ui;T;:
value;0;[ ;{ ;IC;" Waits for +thr+ to complete, using #join, and returns its value or raises
the exception which terminated the thread.
a = Thread.new { 2 + 2 }
a.value #=> 4
b = Thread.new { raise 'something went wrong' }
b.value #=> RuntimeError: something went wrong
;T;[o;
; I"
overload;F; 0;; ; 0; I"
value;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@w;#[ ;$I"@return [Object];T;%0;"@w;&0;'F;(i ;[ ;"@w;#[ ;$I"1Waits for +thr+ to complete, using #join, and returns its value or raises
the exception which terminated the thread.
a = Thread.new { 2 + 2 }
a.value #=> 4
b = Thread.new { raise 'something went wrong' }
b.value #=> RuntimeError: something went wrong
@overload value
@return [Object];T;%0;"@w;'F;)o;*;+T;,i;-i;.@s; I"static VALUE;T;/I"static VALUE
thread_value(VALUE self)
{
rb_thread_t *th;
GetThreadPtr(self, th);
thread_join(th, DELAY_INFTY);
return th->value;
};T;0To;
; F; ;
;;;I"Thread#kill;F;[ ;[[@ui;T;;;0;[ ;{ ;IC;"Terminates +thr+ and schedules another thread to be run.
If this thread is already marked to be killed, #exit returns the Thread.
If this is the main thread, or the last thread, exits the process.
;T;[o;
; I"
overload;F; 0;;; 0; I" exit;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@w;#[ ;$I"@return [nil];T;%0;"@w;&0;'F;(i ;[ ;"@wo;
; I"
overload;F; 0;;; 0; I" kill;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@w;#[ ;$I"@return [nil];T;%0;"@w;&0;'F;(i ;[ ;"@wo;
; I"
overload;F; 0;:terminate; 0; I"terminate;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@w;#[ ;$I"@return [nil];T;%0;"@w;&0;'F;(i ;[ ;"@w;#[ ;$I"*Terminates +thr+ and schedules another thread to be run.
If this thread is already marked to be killed, #exit returns the Thread.
If this is the main thread, or the last thread, exits the process.
@overload exit
@return [nil]
@overload kill
@return [nil]
@overload terminate
@return [nil];T;%0;"@w;'F;)o;*;+T;,i;-i;.@s; I"
VALUE;T;/I"MVALUE
rb_thread_kill(VALUE thread)
{
rb_thread_t *th;
GetThreadPtr(thread, th);
if (th->to_kill || th->status == THREAD_KILLED) {
return thread;
}
if (th == th->vm->main_thread) {
rb_exit(EXIT_SUCCESS);
}
thread_debug("rb_thread_kill: %p (%"PRI_THREAD_ID")\n", (void *)th, thread_id_str(th));
if (th == GET_THREAD()) {
/* kill myself immediately */
rb_threadptr_to_kill(th);
}
else {
threadptr_check_pending_interrupt_queue(th);
rb_threadptr_pending_interrupt_enque(th, eKillSignal);
rb_threadptr_interrupt(th);
}
return thread;
};T;0To;
; F; ;
;;;I"Thread#terminate;F;[ ;[[@ui;T;; ;0;[ ;{ ;IC;"Terminates +thr+ and schedules another thread to be run.
If this thread is already marked to be killed, #exit returns the Thread.
If this is the main thread, or the last thread, exits the process.
;T;[o;
; I"
overload;F; 0;;; 0; I" exit;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@x;#[ ;$I"@return [nil];T;%0;"@x;&0;'F;(i ;[ ;"@xo;
; I"
overload;F; 0;;; 0; I" kill;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@x;#[ ;$I"@return [nil];T;%0;"@x;&0;'F;(i ;[ ;"@xo;
; I"
overload;F; 0;; ; 0; I"terminate;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@x;#[ ;$I"@return [nil];T;%0;"@x;&0;'F;(i ;[ ;"@x;#[ ;$@x;%0;"@x;'F;)o;*;+T;,i;-i;.@s; I"
VALUE;T;/I"MVALUE
rb_thread_kill(VALUE thread)
{
rb_thread_t *th;
GetThreadPtr(thread, th);
if (th->to_kill || th->status == THREAD_KILLED) {
return thread;
}
if (th == th->vm->main_thread) {
rb_exit(EXIT_SUCCESS);
}
thread_debug("rb_thread_kill: %p (%"PRI_THREAD_ID")\n", (void *)th, thread_id_str(th));
if (th == GET_THREAD()) {
/* kill myself immediately */
rb_threadptr_to_kill(th);
}
else {
threadptr_check_pending_interrupt_queue(th);
rb_threadptr_pending_interrupt_enque(th, eKillSignal);
rb_threadptr_interrupt(th);
}
return thread;
};T;0To;
; F; ;
;;;I"Thread#exit;F;[ ;[[@ui;T;;;0;[ ;{ ;IC;"Terminates +thr+ and schedules another thread to be run.
If this thread is already marked to be killed, #exit returns the Thread.
If this is the main thread, or the last thread, exits the process.
;T;[o;
; I"
overload;F; 0;;; 0; I" exit;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@Fx;#[ ;$I"@return [nil];T;%0;"@Fx;&0;'F;(i ;[ ;"@Fxo;
; I"
overload;F; 0;;; 0; I" kill;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@Fx;#[ ;$I"@return [nil];T;%0;"@Fx;&0;'F;(i ;[ ;"@Fxo;
; I"
overload;F; 0;; ; 0; I"terminate;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@Fx;#[ ;$I"@return [nil];T;%0;"@Fx;&0;'F;(i ;[ ;"@Fx;#[ ;$@x;%0;"@Fx;'F;)o;*;+T;,i;-i;.@s; I"
VALUE;T;/I"MVALUE
rb_thread_kill(VALUE thread)
{
rb_thread_t *th;
GetThreadPtr(thread, th);
if (th->to_kill || th->status == THREAD_KILLED) {
return thread;
}
if (th == th->vm->main_thread) {
rb_exit(EXIT_SUCCESS);
}
thread_debug("rb_thread_kill: %p (%"PRI_THREAD_ID")\n", (void *)th, thread_id_str(th));
if (th == GET_THREAD()) {
/* kill myself immediately */
rb_threadptr_to_kill(th);
}
else {
threadptr_check_pending_interrupt_queue(th);
rb_threadptr_pending_interrupt_enque(th, eKillSignal);
rb_threadptr_interrupt(th);
}
return thread;
};T;0To;
; F; ;
;;;I"Thread#run;F;[ ;[[@ui; ;T;:run;0;[ ;{ ;IC;"Wakes up +thr+, making it eligible for scheduling.
a = Thread.new { puts "a"; Thread.stop; puts "c" }
sleep 0.1 while a.status!='sleep'
puts "Got here"
a.run
a.join
This will produce:
a
Got here
c
See also the instance method #wakeup.
;T;[o;
; I"
overload;F; 0;; ; 0; I"run;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@zx;&0;'F;(i ;[ ;"@zx;#[ ;$I"Wakes up +thr+, making it eligible for scheduling.
a = Thread.new { puts "a"; Thread.stop; puts "c" }
sleep 0.1 while a.status!='sleep'
puts "Got here"
a.run
a.join
This will produce:
a
Got here
c
See also the instance method #wakeup.
@overload run;T;%0;"@zx;'F;)o;*;+T;,i& ;-i7 ;.@s; I"
VALUE;T;/I"uVALUE
rb_thread_run(VALUE thread)
{
rb_thread_wakeup(thread);
rb_thread_schedule();
return thread;
};T;0To;
; F; ;
;;;I"Thread#wakeup;F;[ ;[[@ui
;T;: wakeup;0;[ ;{ ;IC;"!Marks a given thread as eligible for scheduling, however it may still
remain blocked on I/O.
*Note:* This does not invoke the scheduler, see #run for more information.
c = Thread.new { Thread.stop; puts "hey!" }
sleep 0.1 while c.status!='sleep'
c.wakeup
c.join
#=> "hey!"
;T;[o;
; I"
overload;F; 0;; ; 0; I" wakeup;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@x;&0;'F;(i ;[ ;"@x;#[ ;$I"4Marks a given thread as eligible for scheduling, however it may still
remain blocked on I/O.
*Note:* This does not invoke the scheduler, see #run for more information.
c = Thread.new { Thread.stop; puts "hey!" }
sleep 0.1 while c.status!='sleep'
c.wakeup
c.join
#=> "hey!"
@overload wakeup;T;%0;"@x;'F;)o;*;+T;,i;-i ;.@s; I"
VALUE;T;/I"VALUE
rb_thread_wakeup(VALUE thread)
{
if (!RTEST(rb_thread_wakeup_alive(thread))) {
rb_raise(rb_eThreadError, "killed thread");
}
return thread;
};T;0To;
; F; ;
;;;I"Thread#[];F;[[I"key;T0;[[@ui ;T;;V;0;[ ;{ ;IC;"Attribute Reference---Returns the value of a fiber-local variable (current thread's root fiber
if not explicitly inside a Fiber), using either a symbol or a string name.
If the specified variable does not exist, returns +nil+.
[
Thread.new { Thread.current["name"] = "A" },
Thread.new { Thread.current[:name] = "B" },
Thread.new { Thread.current["name"] = "C" }
].each do |th|
th.join
puts "#{th.inspect}: #{th[:name]}"
end
This will produce:
#: A
#: B
#: C
Thread#[] and Thread#[]= are not thread-local but fiber-local.
This confusion did not exist in Ruby 1.8 because
fibers are only available since Ruby 1.9.
Ruby 1.9 chooses that the methods behaves fiber-local to save
following idiom for dynamic scope.
def meth(newvalue)
begin
oldvalue = Thread.current[:name]
Thread.current[:name] = newvalue
yield
ensure
Thread.current[:name] = oldvalue
end
end
The idiom may not work as dynamic scope if the methods are thread-local
and a given block switches fiber.
f = Fiber.new {
meth(1) {
Fiber.yield
}
}
meth(2) {
f.resume
}
f.resume
p Thread.current[:name]
#=> nil if fiber-local
#=> 2 if thread-local (The value 2 is leaked to outside of meth method.)
For thread-local variables, please see #thread_variable_get and
#thread_variable_set.
;T;[o;
; I"
overload;F; 0;;V; 0; I" [](sym);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;TI"nil;T;"@x;#[ ;$I"@return [Object, nil];T;%0;"@x;&0;'F;(i ;[[I"sym;T0;"@x;#[ ;$I"Attribute Reference---Returns the value of a fiber-local variable (current thread's root fiber
if not explicitly inside a Fiber), using either a symbol or a string name.
If the specified variable does not exist, returns +nil+.
[
Thread.new { Thread.current["name"] = "A" },
Thread.new { Thread.current[:name] = "B" },
Thread.new { Thread.current["name"] = "C" }
].each do |th|
th.join
puts "#{th.inspect}: #{th[:name]}"
end
This will produce:
#: A
#: B
#: C
Thread#[] and Thread#[]= are not thread-local but fiber-local.
This confusion did not exist in Ruby 1.8 because
fibers are only available since Ruby 1.9.
Ruby 1.9 chooses that the methods behaves fiber-local to save
following idiom for dynamic scope.
def meth(newvalue)
begin
oldvalue = Thread.current[:name]
Thread.current[:name] = newvalue
yield
ensure
Thread.current[:name] = oldvalue
end
end
The idiom may not work as dynamic scope if the methods are thread-local
and a given block switches fiber.
f = Fiber.new {
meth(1) {
Fiber.yield
}
}
meth(2) {
f.resume
}
f.resume
p Thread.current[:name]
#=> nil if fiber-local
#=> 2 if thread-local (The value 2 is leaked to outside of meth method.)
For thread-local variables, please see #thread_variable_get and
#thread_variable_set.
@overload [](sym)
@return [Object, nil];T;%0;"@x;'F;)o;*;+T;,iC ;-i| ;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_aref(VALUE thread, VALUE key)
{
ID id = rb_check_id(&key);
if (!id) return Qnil;
return rb_thread_local_aref(thread, id);
};T;0To;
; F; ;
;;;I"Thread#[]=;F;[[I"id;T0[I"val;T0;[[@ui ;T;;X;0;[ ;{ ;IC;"Attribute Assignment---Sets or creates the value of a fiber-local variable,
using either a symbol or a string.
See also Thread#[].
For thread-local variables, please see #thread_variable_set and
#thread_variable_get.
;T;[o;
; I"
overload;F; 0;;X; 0; I"
[]=(sym);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;T;"@x;#[ ;$I"@return [Object];T;%0;"@x;&0;'F;(i ;[[I"sym;T0;"@x;#[ ;$I"Attribute Assignment---Sets or creates the value of a fiber-local variable,
using either a symbol or a string.
See also Thread#[].
For thread-local variables, please see #thread_variable_set and
#thread_variable_get.
@overload []=(sym)
@return [Object];T;%0;"@x;'F;)o;*;+T;,i ;-i ;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_aset(VALUE self, VALUE id, VALUE val)
{
return rb_thread_local_aset(self, rb_to_id(id), val);
};T;0To;
; F; ;
;;;I"Thread#key?;F;[[I"key;T0;[[@ui ;T;;;0;[ ;{ ;IC;"Returns +true+ if the given string (or symbol) exists as a fiber-local
variable.
me = Thread.current
me[:oliver] = "a"
me.key?(:oliver) #=> true
me.key?(:stanley) #=> false
;T;[o;
; I"
overload;F; 0;;; 0; I"key?(sym);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@x;#[ ;$I"@return [Boolean];T;%0;"@x;&0;'F;(i ;[[I"sym;T0;"@xo;!
; I" return;F; @;0; [@;"@x;#[ ;$I"Returns +true+ if the given string (or symbol) exists as a fiber-local
variable.
me = Thread.current
me[:oliver] = "a"
me.key?(:oliver) #=> true
me.key?(:stanley) #=> false
@overload key?(sym)
@return [Boolean];T;%0;"@x;'F;)o;*;+T;,i ;-i ;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_key_p(VALUE self, VALUE key)
{
rb_thread_t *th;
ID id = rb_check_id(&key);
GetThreadPtr(self, th);
if (!id || !th->local_storage) {
return Qfalse;
}
if (st_lookup(th->local_storage, id, 0)) {
return Qtrue;
}
return Qfalse;
};T;0To;
; F; ;
;;;I"Thread#keys;F;[ ;[[@ui0 ;T;;;0;[ ;{ ;IC;"Returns an array of the names of the fiber-local variables (as Symbols).
thr = Thread.new do
Thread.current[:cat] = 'meow'
Thread.current["dog"] = 'woof'
end
thr.join #=> #
thr.keys #=> [:dog, :cat]
;T;[o;
; I"
overload;F; 0;;; 0; I" keys;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@ y;#[ ;$I"@return [Array];T;%0;"@ y;&0;'F;(i ;[ ;"@ y;#[ ;$I" Returns an array of the names of the fiber-local variables (as Symbols).
thr = Thread.new do
Thread.current[:cat] = 'meow'
Thread.current["dog"] = 'woof'
end
thr.join #=> #
thr.keys #=> [:dog, :cat]
@overload keys
@return [Array];T;%0;"@ y;'F;)o;*;+T;,i" ;-i- ;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_keys(VALUE self)
{
rb_thread_t *th;
VALUE ary = rb_ary_new();
GetThreadPtr(self, th);
if (th->local_storage) {
st_foreach(th->local_storage, thread_keys_i, ary);
}
return ary;
};T;0To;
; F; ;
;;;I"Thread#priority;F;[ ;[[@ui ;T;:
priority;0;[ ;{ ;IC;"Returns the priority of thr. Default is inherited from the
current thread which creating the new thread, or zero for the
initial main thread; higher-priority thread will run more frequently
than lower-priority threads (but lower-priority threads can also run).
This is just hint for Ruby thread scheduler. It may be ignored on some
platform.
Thread.current.priority #=> 0
;T;[o;
; I"
overload;F; 0;;!; 0; I"
priority;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@$y;#[ ;$I"@return [Integer];T;%0;"@$y;&0;'F;(i ;[ ;"@$y;#[ ;$I"Returns the priority of thr. Default is inherited from the
current thread which creating the new thread, or zero for the
initial main thread; higher-priority thread will run more frequently
than lower-priority threads (but lower-priority threads can also run).
This is just hint for Ruby thread scheduler. It may be ignored on some
platform.
Thread.current.priority #=> 0
@overload priority
@return [Integer];T;%0;"@$y;'F;)o;*;+T;,i ;-i ;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_priority(VALUE thread)
{
rb_thread_t *th;
GetThreadPtr(thread, th);
return INT2NUM(th->priority);
};T;0To;
; F; ;
;;;I"Thread#priority=;F;[[I" prio;T0;[[@ui ;T;:priority=;0;[ ;{ ;IC;"Sets the priority of thr to integer. Higher-priority threads
will run more frequently than lower-priority threads (but lower-priority
threads can also run).
This is just hint for Ruby thread scheduler. It may be ignored on some
platform.
count1 = count2 = 0
a = Thread.new do
loop { count1 += 1 }
end
a.priority = -1
b = Thread.new do
loop { count2 += 1 }
end
b.priority = -2
sleep 1 #=> 1
count1 #=> 622504
count2 #=> 5832
;T;[o;
; I"
overload;F; 0;;"; 0; I"priority=(integer);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@?y;&0;'F;(i ;[[I" integer;T0;"@?y;#[ ;$I"Sets the priority of thr to integer. Higher-priority threads
will run more frequently than lower-priority threads (but lower-priority
threads can also run).
This is just hint for Ruby thread scheduler. It may be ignored on some
platform.
count1 = count2 = 0
a = Thread.new do
loop { count1 += 1 }
end
a.priority = -1
b = Thread.new do
loop { count2 += 1 }
end
b.priority = -2
sleep 1 #=> 1
count1 #=> 622504
count2 #=> 5832
@overload priority=(integer);T;%0;"@?y;'F;)o;*;+T;,i ;-i ;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_priority_set(VALUE thread, VALUE prio)
{
rb_thread_t *th;
int priority;
GetThreadPtr(thread, th);
#if USE_NATIVE_THREAD_PRIORITY
th->priority = NUM2INT(prio);
native_thread_apply_priority(th);
#else
priority = NUM2INT(prio);
if (priority > RUBY_THREAD_PRIORITY_MAX) {
priority = RUBY_THREAD_PRIORITY_MAX;
}
else if (priority < RUBY_THREAD_PRIORITY_MIN) {
priority = RUBY_THREAD_PRIORITY_MIN;
}
th->priority = priority;
#endif
return INT2NUM(th->priority);
};T;0To;
; F; ;
;;;I"Thread#status;F;[ ;[[@uit
;T;;X;0;[ ;{ ;IC;"Returns the status of +thr+.
["sleep"]
Returned if this thread is sleeping or waiting on I/O
["run"]
When this thread is executing
["aborting"]
If this thread is aborting
[+false+]
When this thread is terminated normally
[+nil+]
If terminated with an exception.
a = Thread.new { raise("die now") }
b = Thread.new { Thread.stop }
c = Thread.new { Thread.exit }
d = Thread.new { sleep }
d.kill #=> #
a.status #=> nil
b.status #=> "sleep"
c.status #=> false
d.status #=> "aborting"
Thread.current.status #=> "run"
See also the instance methods #alive? and #stop?
;T;[o;
; I"
overload;F; 0;;X; 0; I" status;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;TI"
false;TI"nil;T;"@Yy;#[ ;$I"!@return [String, false, nil];T;%0;"@Yy;&0;'F;(i ;[ ;"@Yy;#[ ;$I"Returns the status of +thr+.
["sleep"]
Returned if this thread is sleeping or waiting on I/O
["run"]
When this thread is executing
["aborting"]
If this thread is aborting
[+false+]
When this thread is terminated normally
[+nil+]
If terminated with an exception.
a = Thread.new { raise("die now") }
b = Thread.new { Thread.stop }
c = Thread.new { Thread.exit }
d = Thread.new { sleep }
d.kill #=> #
a.status #=> nil
b.status #=> "sleep"
c.status #=> false
d.status #=> "aborting"
Thread.current.status #=> "run"
See also the instance methods #alive? and #stop?
@overload status
@return [String, false, nil];T;%0;"@Yy;'F;)o;*;+T;,iU
;-iq
;.@s; I"static VALUE;T;/I"&static VALUE
rb_thread_status(VALUE thread)
{
rb_thread_t *th;
GetThreadPtr(thread, th);
if (rb_threadptr_dead(th)) {
if (!NIL_P(th->errinfo) && !FIXNUM_P(th->errinfo)
/* TODO */ ) {
return Qnil;
}
return Qfalse;
}
return rb_str_new2(thread_status_name(th));
};T;0To;
; F; ;
;;;I" Thread#thread_variable_get;F;[[I"key;T0;[[@ui ;T;:thread_variable_get;0;[ ;{ ;IC;"WReturns the value of a thread local variable that has been set. Note that
these are different than fiber local values. For fiber local values,
please see Thread#[] and Thread#[]=.
Thread local values are carried along with threads, and do not respect
fibers. For example:
Thread.new {
Thread.current.thread_variable_set("foo", "bar") # set a thread local
Thread.current["foo"] = "bar" # set a fiber local
Fiber.new {
Fiber.yield [
Thread.current.thread_variable_get("foo"), # get the thread local
Thread.current["foo"], # get the fiber local
]
}.resume
}.join.value # => ['bar', nil]
The value "bar" is returned for the thread local, where nil is returned
for the fiber local. The fiber is executed in the same thread, so the
thread local values are available.
;T;[o;
; I"
overload;F; 0;;#; 0; I" thread_variable_get(key);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Object;TI"nil;T;"@vy;#[ ;$I"@return [Object, nil];T;%0;"@vy;&0;'F;(i ;[[I"key;T0;"@vy;#[ ;$I"Returns the value of a thread local variable that has been set. Note that
these are different than fiber local values. For fiber local values,
please see Thread#[] and Thread#[]=.
Thread local values are carried along with threads, and do not respect
fibers. For example:
Thread.new {
Thread.current.thread_variable_set("foo", "bar") # set a thread local
Thread.current["foo"] = "bar" # set a fiber local
Fiber.new {
Fiber.yield [
Thread.current.thread_variable_get("foo"), # get the thread local
Thread.current["foo"], # get the fiber local
]
}.resume
}.join.value # => ['bar', nil]
The value "bar" is returned for the thread local, where nil is returned
for the fiber local. The fiber is executed in the same thread, so the
thread local values are available.
@overload thread_variable_get(key)
@return [Object, nil];T;%0;"@vy;'F;)o;*;+T;,i ;-i ;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_variable_get(VALUE thread, VALUE key)
{
VALUE locals;
locals = rb_ivar_get(thread, id_locals);
return rb_hash_aref(locals, rb_to_symbol(key));
};T;0To;
; F; ;
;;;I" Thread#thread_variable_set;F;[[I"id;T0[I"val;T0;[[@ui ;T;:thread_variable_set;0;[ ;{ ;IC;"Sets a thread local with +key+ to +value+. Note that these are local to
threads, and not to fibers. Please see Thread#thread_variable_get and
Thread#[] for more information.
;T;[o;
; I"
overload;F; 0;;$; 0; I"$thread_variable_set(key, value);T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@y;&0;'F;(i ;[[I"key;T0[I"
value;T0;"@y;#[ ;$I"Sets a thread local with +key+ to +value+. Note that these are local to
threads, and not to fibers. Please see Thread#thread_variable_get and
Thread#[] for more information.
@overload thread_variable_set(key, value);T;%0;"@y;'F;)o;*;+T;,i ;-i ;.@s; I"static VALUE;T;/I"
static VALUE
rb_thread_variable_set(VALUE thread, VALUE id, VALUE val)
{
VALUE locals;
if (OBJ_FROZEN(thread)) {
rb_error_frozen("thread locals");
}
locals = rb_ivar_get(thread, id_locals);
return rb_hash_aset(locals, rb_to_symbol(id), val);
};T;0To;
; F; ;
;;;I" Thread#thread_variables;F;[ ;[[@uiU ;T;:thread_variables;0;[ ;{ ;IC;"Returns an array of the names of the thread-local variables (as Symbols).
thr = Thread.new do
Thread.current.thread_variable_set(:cat, 'meow')
Thread.current.thread_variable_set("dog", 'woof')
end
thr.join #=> #
thr.thread_variables #=> [:dog, :cat]
Note that these are not fiber local variables. Please see Thread#[] and
Thread#thread_variable_get for more details.
;T;[o;
; I"
overload;F; 0;;%; 0; I"thread_variables;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@y;#[ ;$I"@return [Array];T;%0;"@y;&0;'F;(i ;[ ;"@y;#[ ;$I"Returns an array of the names of the thread-local variables (as Symbols).
thr = Thread.new do
Thread.current.thread_variable_set(:cat, 'meow')
Thread.current.thread_variable_set("dog", 'woof')
end
thr.join #=> #
thr.thread_variables #=> [:dog, :cat]
Note that these are not fiber local variables. Please see Thread#[] and
Thread#thread_variable_get for more details.
@overload thread_variables
@return [Array];T;%0;"@y;'F;)o;*;+T;,iD ;-iR ;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_variables(VALUE thread)
{
VALUE locals;
VALUE ary;
locals = rb_ivar_get(thread, id_locals);
ary = rb_ary_new();
rb_hash_foreach(locals, keys_i, ary);
return ary;
};T;0To;
; F; ;
;;;I" Thread#thread_variable?;F;[[I"key;T0;[[@uir ;T;:thread_variable?;0;[ ;{ ;IC;"aReturns +true+ if the given string (or symbol) exists as a thread-local
variable.
me = Thread.current
me.thread_variable_set(:oliver, "a")
me.thread_variable?(:oliver) #=> true
me.thread_variable?(:stanley) #=> false
Note that these are not fiber local variables. Please see Thread#[] and
Thread#thread_variable_get for more details.
;T;[o;
; I"
overload;F; 0;;&; 0; I"thread_variable?(key);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@y;#[ ;$I"@return [Boolean];T;%0;"@y;&0;'F;(i ;[[I"key;T0;"@yo;!
; I" return;F; @;0; [@;"@y;#[ ;$I"Returns +true+ if the given string (or symbol) exists as a thread-local
variable.
me = Thread.current
me.thread_variable_set(:oliver, "a")
me.thread_variable?(:oliver) #=> true
me.thread_variable?(:stanley) #=> false
Note that these are not fiber local variables. Please see Thread#[] and
Thread#thread_variable_get for more details.
@overload thread_variable?(key)
@return [Boolean];T;%0;"@y;'F;)o;*;+T;,ib ;-io ;.@s; I"static VALUE;T;/I"Sstatic VALUE
rb_thread_variable_p(VALUE thread, VALUE key)
{
VALUE locals;
ID id = rb_check_id(&key);
if (!id) return Qfalse;
locals = rb_ivar_get(thread, id_locals);
if (!RHASH(locals)->ntbl)
return Qfalse;
if (st_lookup(RHASH(locals)->ntbl, ID2SYM(id), 0)) {
return Qtrue;
}
return Qfalse;
};T;0To;
; F; ;
;;;I"Thread#alive?;F;[ ;[[@ui
;T;: alive?;0;[ ;{ ;IC;"Returns +true+ if +thr+ is running or sleeping.
thr = Thread.new { }
thr.join #=> #
Thread.current.alive? #=> true
thr.alive? #=> false
See also #stop? and #status.
;T;[o;
; I"
overload;F; 0;;'; 0; I" alive?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@y;#[ ;$I"@return [Boolean];T;%0;"@y;&0;'F;(i ;[ ;"@yo;!
; I" return;F; @;0; [@;"@y;#[ ;$I"Returns +true+ if +thr+ is running or sleeping.
thr = Thread.new { }
thr.join #=> #
Thread.current.alive? #=> true
thr.alive? #=> false
See also #stop? and #status.
@overload alive?
@return [Boolean];T;%0;"@y;'F;)o;*;+T;,i
;-i
;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_alive_p(VALUE thread)
{
rb_thread_t *th;
GetThreadPtr(thread, th);
if (rb_threadptr_dead(th))
return Qfalse;
return Qtrue;
};T;0To;
; F; ;
;;;I"Thread#stop?;F;[ ;[[@ui
;T;:
stop?;0;[ ;{ ;IC;"Returns +true+ if +thr+ is dead or sleeping.
a = Thread.new { Thread.stop }
b = Thread.current
a.stop? #=> true
b.stop? #=> false
See also #alive? and #status.
;T;[o;
; I"
overload;F; 0;;(; 0; I"
stop?;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@z;#[ ;$I"@return [Boolean];T;%0;"@z;&0;'F;(i ;[ ;"@zo;!
; I" return;F; @;0; [@;"@z;#[ ;$I"Returns +true+ if +thr+ is dead or sleeping.
a = Thread.new { Thread.stop }
b = Thread.current
a.stop? #=> true
b.stop? #=> false
See also #alive? and #status.
@overload stop?
@return [Boolean];T;%0;"@z;'F;)o;*;+T;,i
;-i
;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_stop_p(VALUE thread)
{
rb_thread_t *th;
GetThreadPtr(thread, th);
if (rb_threadptr_dead(th))
return Qtrue;
if (th->status == THREAD_STOPPED || th->status == THREAD_STOPPED_FOREVER)
return Qtrue;
return Qfalse;
};T;0To;
; F; ;
;;;I" Thread#abort_on_exception;F;[ ;[[@ui
;T;;;0;[ ;{ ;IC;"Returns the status of the thread-local ``abort on exception'' condition for
this +thr+.
The default is +false+.
See also #abort_on_exception=.
There is also a class level method to set this for all threads, see
::abort_on_exception.
;T;[o;
; I"
overload;F; 0;;; 0; I"abort_on_exception;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@-z;#[ ;$I"@return [Boolean];T;%0;"@-z;&0;'F;(i ;[ ;"@-z;#[ ;$I" Returns the status of the thread-local ``abort on exception'' condition for
this +thr+.
The default is +false+.
See also #abort_on_exception=.
There is also a class level method to set this for all threads, see
::abort_on_exception.
@overload abort_on_exception
@return [Boolean];T;%0;"@-z;'F;)o;*;+T;,i ;-i ;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_abort_exc(VALUE thread)
{
rb_thread_t *th;
GetThreadPtr(thread, th);
return th->abort_on_exception ? Qtrue : Qfalse;
};T;0To;
; F; ;
;;;I" Thread#abort_on_exception=;F;[[I"val;T0;[[@ui
;T;;;0;[ ;{ ;IC;" When set to +true+, all threads (including the main program) will abort if
an exception is raised in this +thr+.
The process will effectively exit(0).
See also #abort_on_exception.
There is also a class level method to set this for all threads, see
::abort_on_exception=.
;T;[o;
; I"
overload;F; 0;;; 0; I"!abort_on_exception=(boolean);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Boolean;T;"@Hz;#[ ;$I"@return [Boolean];T;%0;"@Hz;&0;'F;(i ;[[I" boolean;T0;"@Hz;#[ ;$I"\When set to +true+, all threads (including the main program) will abort if
an exception is raised in this +thr+.
The process will effectively exit(0).
See also #abort_on_exception.
There is also a class level method to set this for all threads, see
::abort_on_exception=.
@overload abort_on_exception=(boolean)
@return [Boolean];T;%0;"@Hz;'F;)o;*;+T;,i
;-i
;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_abort_exc_set(VALUE thread, VALUE val)
{
rb_thread_t *th;
GetThreadPtr(thread, th);
th->abort_on_exception = RTEST(val);
return val;
};T;0To;
; F; ;
;;;I"Thread#safe_level;F;[ ;[[@ui
;T;:safe_level;0;[ ;{ ;IC;"Returns the safe level in effect for thr. Setting thread-local safe
levels can help when implementing sandboxes which run insecure code.
thr = Thread.new { $SAFE = 1; sleep }
Thread.current.safe_level #=> 0
thr.safe_level #=> 1
;T;[o;
; I"
overload;F; 0;;); 0; I"safe_level;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" Integer;T;"@gz;#[ ;$I"@return [Integer];T;%0;"@gz;&0;'F;(i ;[ ;"@gz;#[ ;$I".Returns the safe level in effect for thr. Setting thread-local safe
levels can help when implementing sandboxes which run insecure code.
thr = Thread.new { $SAFE = 1; sleep }
Thread.current.safe_level #=> 0
thr.safe_level #=> 1
@overload safe_level
@return [Integer];T;%0;"@gz;'F;)o;*;+T;,i
;-i
;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_safe_level(VALUE thread)
{
rb_thread_t *th;
GetThreadPtr(thread, th);
return INT2NUM(th->safe_level);
};T;0To;
; F; ;
;;;I"Thread#group;F;[ ;[[@ui-
;T;:
group;0;[ ;{ ;IC;"Returns the ThreadGroup which contains the given thread, or returns +nil+
if +thr+ is not a member of any group.
Thread.main.group #=> #
;T;[o;
; I"
overload;F; 0;;*; 0; I"
group;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"nil;T;"@z;#[ ;$I"@return [nil];T;%0;"@z;&0;'F;(i ;[ ;"@z;#[ ;$I"Returns the ThreadGroup which contains the given thread, or returns +nil+
if +thr+ is not a member of any group.
Thread.main.group #=> #
@overload group
@return [nil];T;%0;"@z;'F;)o;*;+T;,i#
;-i*
;.@s; I"
VALUE;T;/I"VALUE
rb_thread_group(VALUE thread)
{
rb_thread_t *th;
VALUE group;
GetThreadPtr(thread, th);
group = th->thgroup;
if (!group) {
group = Qnil;
}
return group;
};T;0To;
; F; ;
;;;I"Thread#backtrace;F;[[@0;[[@ui;T;;S;0;[ ;{ ;IC;"8Returns the current backtrace of the target thread.
;T;[o;
; I"
overload;F; 0;;S; 0; I"backtrace;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I"
Array;T;"@z;#[ ;$I"@return [Array];T;%0;"@z;&0;'F;(i ;[ ;"@z;#[ ;$I"aReturns the current backtrace of the target thread.
@overload backtrace
@return [Array];T;%0;"@z;'F;)o;*;+T;,i;-i;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_backtrace_m(int argc, VALUE *argv, VALUE thval)
{
return rb_vm_thread_backtrace(argc, argv, thval);
};T;0To;
; F; ;
;;;I" Thread#backtrace_locations;F;[[@0;[[@ui;T;;T;0;[ ;{ ;IC;"Returns the execution stack for the target thread---an array containing
backtrace location objects.
See Thread::Backtrace::Location for more information.
This method behaves similarly to Kernel#caller_locations except it applies
to a specific thread.
;T;[o;
; I"
overload;F; 0;;T; 0; I"/backtrace_locations(*args) -> array or nil;T;IC;" ;T;[ ;#[ ;$I" ;T;%0;"@z;&0;'F;(i ;[[I"
*args;T0;"@z;#[ ;$I"3Returns the execution stack for the target thread---an array containing
backtrace location objects.
See Thread::Backtrace::Location for more information.
This method behaves similarly to Kernel#caller_locations except it applies
to a specific thread.
@overload backtrace_locations(*args) -> array or nil;T;%0;"@z;'F;)o;*;+T;,i;-i;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_backtrace_locations_m(int argc, VALUE *argv, VALUE thval)
{
return rb_vm_thread_backtrace_locations(argc, argv, thval);
};T;0To;
; F; ;
;;;I"Thread#name;F;[ ;[[@ui
;T;;j;0;[ ;{ ;IC;"!show the name of the thread.
;T;[o;
; I"
overload;F; 0;;j; 0; I" name;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@z;#[ ;$I"@return [String];T;%0;"@z;&0;'F;(i ;[ ;"@z;#[ ;$I"Eshow the name of the thread.
@overload name
@return [String];T;%0;"@z;'F;)o;*;+T;,i
;-i
;.@s; I"static VALUE;T;/I"}static VALUE
rb_thread_getname(VALUE thread)
{
rb_thread_t *th;
GetThreadPtr(thread, th);
return th->name;
};T;0To;
; F; ;
;;;I"Thread#name=;F;[[I" name;T0;[[@ui
;T;:
name=;0;[ ;{ ;IC;"gset given name to the ruby thread.
On some platform, it may set the name to pthread and/or kernel.
;T;[o;
; I"
overload;F; 0;;+; 0; I"name=(name);T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@z;#[ ;$I"@return [String];T;%0;"@z;&0;'F;(i ;[[I" name;T0;"@z;#[ ;$I"set given name to the ruby thread.
On some platform, it may set the name to pthread and/or kernel.
@overload name=(name)
@return [String];T;%0;"@z;'F;)o;*;+T;,i
;-i
;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_setname(VALUE thread, VALUE name)
{
#ifdef SET_ANOTHER_THREAD_NAME
const char *s = "";
#endif
rb_thread_t *th;
GetThreadPtr(thread, th);
if (!NIL_P(name)) {
rb_encoding *enc;
StringValueCStr(name);
enc = rb_enc_get(name);
if (!rb_enc_asciicompat(enc)) {
rb_raise(rb_eArgError, "ASCII incompatible encoding (%s)",
rb_enc_name(enc));
}
name = rb_str_new_frozen(name);
#ifdef SET_ANOTHER_THREAD_NAME
s = RSTRING_PTR(name);
#endif
}
th->name = name;
#if defined(SET_ANOTHER_THREAD_NAME)
if (threadptr_initialized(th)) {
SET_ANOTHER_THREAD_NAME(th->thread_id, s);
}
#endif
return name;
};T;0To;
; F; ;
;;;I"Thread#inspect;F;[ ;[[@ui
;T;;J;0;[ ;{ ;IC;"8Dump the name, id, and status of _thr_ to a string.
;T;[o;
; I"
overload;F; 0;;J; 0; I" inspect;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@ {;#[ ;$I"@return [String];T;%0;"@ {;&0;'F;(i ;[ ;"@ {;#[ ;$I"_Dump the name, id, and status of _thr_ to a string.
@overload inspect
@return [String];T;%0;"@ {;'F;)o;*;+T;,i ;-i ;.@s; I"static VALUE;T;/I"static VALUE
rb_thread_inspect(VALUE thread)
{
VALUE cname = rb_class_path(rb_obj_class(thread));
rb_thread_t *th;
const char *status;
VALUE str;
GetThreadPtr(thread, th);
status = thread_status_name(th);
str = rb_sprintf("#<%"PRIsVALUE":%p", cname, (void *)thread);
if (!NIL_P(th->name)) {
rb_str_catf(str, "@%"PRIsVALUE, th->name);
}
if (!th->first_func && th->first_proc) {
VALUE loc = rb_proc_location(th->first_proc);
if (!NIL_P(loc)) {
const VALUE *ptr = RARRAY_CONST_PTR(loc);
rb_str_catf(str, "@%"PRIsVALUE":%"PRIsVALUE, ptr[0], ptr[1]);
rb_gc_force_recycle(loc);
}
}
rb_str_catf(str, " %s>", status);
OBJ_INFECT(str, thread);
return str;
};T;0To;
; F; ;
;;;I" Thread#__runnable_sleep__;F;[[I" timeout;T0;[[I"7ext/-test-/gvl/call_without_gvl/call_without_gvl.c;Ti;T;:__runnable_sleep__;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@'{;.@s; I"static VALUE;T;/I"Gstatic VALUE
thread_runnable_sleep(VALUE thread, VALUE timeout)
{
struct timeval timeval;
if (NIL_P(timeout)) {
rb_raise(rb_eArgError, "timeout must be non nil");
}
timeval = rb_time_interval(timeout);
rb_thread_call_without_gvl(native_sleep_callback, &timeval, RUBY_UBF_IO, NULL);
return thread;
};T;0To;
; F; ;
;;;I"#Thread#__infinite_loop_dlsym__;F;[[I" name;T0;[[I"4ext/-test-/popen_deadlock/infinite_loop_dlsym.c;Ti%;T;: __infinite_loop_dlsym__;0;[ ;{ ;IC;" ;T;[ ;#[ ;$@;%0;"@6{;.@s; I"static VALUE;T;/I"
static VALUE
loop_dlsym(VALUE self, VALUE name)
{
struct data_for_loop_dlsym d;
d.stop = 0;
d.name = StringValuePtr(name);
rb_thread_call_without_gvl(native_loop_dlsym, &d,
ubf_for_loop_dlsym, &d);
return self;
};T;0T;N@s;OIC;[ ;N@s;PIC;[ ;N@s;QIC;R{;SIC;R{ ;TT;
IC;R{ ;TT;TT;U{ ;V[ ;[[I" vm.c;Ti
[@N{i" ;T;: Thread;;X;;;[ ;{ ;IC;"AThreads are the Ruby implementation for a concurrent programming model.
Programs that require multiple threads of execution are a perfect
candidate for Ruby's Thread class.
For example, we can create a new thread separate from the main thread's
execution using ::new.
thr = Thread.new { puts "Whats the big deal" }
Then we are able to pause the execution of the main thread and allow
our new thread to finish, using #join:
thr.join #=> "Whats the big deal"
If we don't call +thr.join+ before the main thread terminates, then all
other threads including +thr+ will be killed.
Alternatively, you can use an array for handling multiple threads at
once, like in the following example:
threads = []
threads << Thread.new { puts "Whats the big deal" }
threads << Thread.new { 3.times { puts "Threads are fun!" } }
After creating a few threads we wait for them all to finish
consecutively.
threads.each { |thr| thr.join }
=== Thread initialization
In order to create new threads, Ruby provides ::new, ::start, and
::fork. A block must be provided with each of these methods, otherwise
a ThreadError will be raised.
When subclassing the Thread class, the +initialize+ method of your
subclass will be ignored by ::start and ::fork. Otherwise, be sure to
call super in your +initialize+ method.
=== Thread termination
For terminating threads, Ruby provides a variety of ways to do this.
The class method ::kill, is meant to exit a given thread:
thr = Thread.new { ... }
Thread.kill(thr) # sends exit() to thr
Alternatively, you can use the instance method #exit, or any of its
aliases #kill or #terminate.
thr.exit
=== Thread status
Ruby provides a few instance methods for querying the state of a given
thread. To get a string with the current thread's state use #status
thr = Thread.new { sleep }
thr.status # => "sleep"
thr.exit
thr.status # => false
You can also use #alive? to tell if the thread is running or sleeping,
and #stop? if the thread is dead or sleeping.
=== Thread variables and scope
Since threads are created with blocks, the same rules apply to other
Ruby blocks for variable scope. Any local variables created within this
block are accessible to only this thread.
==== Fiber-local vs. Thread-local
Each fiber has its own bucket for Thread#[] storage. When you set a
new fiber-local it is only accessible within this Fiber. To illustrate:
Thread.new {
Thread.current[:foo] = "bar"
Fiber.new {
p Thread.current[:foo] # => nil
}.resume
}.join
This example uses #[] for getting and #[]= for setting fiber-locals,
you can also use #keys to list the fiber-locals for a given
thread and #key? to check if a fiber-local exists.
When it comes to thread-locals, they are accessible within the entire
scope of the thread. Given the following example:
Thread.new{
Thread.current.thread_variable_set(:foo, 1)
p Thread.current.thread_variable_get(:foo) # => 1
Fiber.new{
Thread.current.thread_variable_set(:foo, 2)
p Thread.current.thread_variable_get(:foo) # => 2
}.resume
p Thread.current.thread_variable_get(:foo) # => 2
}.join
You can see that the thread-local +:foo+ carried over into the fiber
and was changed to +2+ by the end of the thread.
This example makes use of #thread_variable_set to create new
thread-locals, and #thread_variable_get to reference them.
There is also #thread_variables to list all thread-locals, and
#thread_variable? to check if a given thread-local exists.
=== Exception handling
Any thread can raise an exception using the #raise instance method,
which operates similarly to Kernel#raise.
However, it's important to note that an exception that occurs in any
thread except the main thread depends on #abort_on_exception. This
option is +false+ by default, meaning that any unhandled exception will
cause the thread to terminate silently when waited on by either #join
or #value. You can change this default by either #abort_on_exception=
+true+ or setting $DEBUG to +true+.
With the addition of the class method ::handle_interrupt, you can now
handle exceptions asynchronously with threads.
=== Scheduling
Ruby provides a few ways to support scheduling threads in your program.
The first way is by using the class method ::stop, to put the current
running thread to sleep and schedule the execution of another thread.
Once a thread is asleep, you can use the instance method #wakeup to
mark your thread as eligible for scheduling.
You can also try ::pass, which attempts to pass execution to another
thread but is dependent on the OS whether a running thread will switch
or not. The same goes for #priority, which lets you hint to the thread
scheduler which threads you want to take precedence when passing
execution. This method is also dependent on the OS and may be ignored
on some platforms.;T;[ ;#[ ;$I"D
Threads are the Ruby implementation for a concurrent programming model.
Programs that require multiple threads of execution are a perfect
candidate for Ruby's Thread class.
For example, we can create a new thread separate from the main thread's
execution using ::new.
thr = Thread.new { puts "Whats the big deal" }
Then we are able to pause the execution of the main thread and allow
our new thread to finish, using #join:
thr.join #=> "Whats the big deal"
If we don't call +thr.join+ before the main thread terminates, then all
other threads including +thr+ will be killed.
Alternatively, you can use an array for handling multiple threads at
once, like in the following example:
threads = []
threads << Thread.new { puts "Whats the big deal" }
threads << Thread.new { 3.times { puts "Threads are fun!" } }
After creating a few threads we wait for them all to finish
consecutively.
threads.each { |thr| thr.join }
=== Thread initialization
In order to create new threads, Ruby provides ::new, ::start, and
::fork. A block must be provided with each of these methods, otherwise
a ThreadError will be raised.
When subclassing the Thread class, the +initialize+ method of your
subclass will be ignored by ::start and ::fork. Otherwise, be sure to
call super in your +initialize+ method.
=== Thread termination
For terminating threads, Ruby provides a variety of ways to do this.
The class method ::kill, is meant to exit a given thread:
thr = Thread.new { ... }
Thread.kill(thr) # sends exit() to thr
Alternatively, you can use the instance method #exit, or any of its
aliases #kill or #terminate.
thr.exit
=== Thread status
Ruby provides a few instance methods for querying the state of a given
thread. To get a string with the current thread's state use #status
thr = Thread.new { sleep }
thr.status # => "sleep"
thr.exit
thr.status # => false
You can also use #alive? to tell if the thread is running or sleeping,
and #stop? if the thread is dead or sleeping.
=== Thread variables and scope
Since threads are created with blocks, the same rules apply to other
Ruby blocks for variable scope. Any local variables created within this
block are accessible to only this thread.
==== Fiber-local vs. Thread-local
Each fiber has its own bucket for Thread#[] storage. When you set a
new fiber-local it is only accessible within this Fiber. To illustrate:
Thread.new {
Thread.current[:foo] = "bar"
Fiber.new {
p Thread.current[:foo] # => nil
}.resume
}.join
This example uses #[] for getting and #[]= for setting fiber-locals,
you can also use #keys to list the fiber-locals for a given
thread and #key? to check if a fiber-local exists.
When it comes to thread-locals, they are accessible within the entire
scope of the thread. Given the following example:
Thread.new{
Thread.current.thread_variable_set(:foo, 1)
p Thread.current.thread_variable_get(:foo) # => 1
Fiber.new{
Thread.current.thread_variable_set(:foo, 2)
p Thread.current.thread_variable_get(:foo) # => 2
}.resume
p Thread.current.thread_variable_get(:foo) # => 2
}.join
You can see that the thread-local +:foo+ carried over into the fiber
and was changed to +2+ by the end of the thread.
This example makes use of #thread_variable_set to create new
thread-locals, and #thread_variable_get to reference them.
There is also #thread_variables to list all thread-locals, and
#thread_variable? to check if a given thread-local exists.
=== Exception handling
Any thread can raise an exception using the #raise instance method,
which operates similarly to Kernel#raise.
However, it's important to note that an exception that occurs in any
thread except the main thread depends on #abort_on_exception. This
option is +false+ by default, meaning that any unhandled exception will
cause the thread to terminate silently when waited on by either #join
or #value. You can change this default by either #abort_on_exception=
+true+ or setting $DEBUG to +true+.
With the addition of the class method ::handle_interrupt, you can now
handle exceptions asynchronously with threads.
=== Scheduling
Ruby provides a few ways to support scheduling threads in your program.
The first way is by using the class method ::stop, to put the current
running thread to sleep and schedule the execution of another thread.
Once a thread is asleep, you can use the instance method #wakeup to
mark your thread as eligible for scheduling.
You can also try ::pass, which attempts to pass execution to another
thread but is dependent on the OS whether a running thread will switch
or not. The same goes for #priority, which lets you hint to the thread
scheduler which threads you want to take precedence when passing
execution. This method is also dependent on the OS and may be ignored
on some platforms.
;T;%0;"@s;'F;(i ;)o;*;+T;,i
;-i ;.@;I" Thread;F;Y@No; ;IC;[o;
; F; ;S;;;I"TracePoint.new;F;[[@0;[[@
i;T;;S;0;[ ;{ ;IC;"BTracePoint.new(*events) { |obj| block } -> obj
Returns a new TracePoint object, not enabled by default.
Next, in order to activate the trace, you must use TracePoint.enable
trace = TracePoint.new(:call) do |tp|
p [tp.lineno, tp.defined_class, tp.method_id, tp.event]
end
#=> #
trace.enable
#=> false
puts "Hello, TracePoint!"
# ...
# [48, IRB::Notifier::AbstractNotifier, :printf, :call]
# ...
When you want to deactivate the trace, you must use TracePoint.disable
trace.disable
See TracePoint@Events for possible events and more information.
A block must be given, otherwise a ThreadError is raised.
If the trace method isn't included in the given events filter, a
RuntimeError is raised.
TracePoint.trace(:line) do |tp|
p tp.raised_exception
end
#=> RuntimeError: 'raised_exception' not supported by this event
If the trace method is called outside block, a RuntimeError is raised.
TracePoint.trace(:line) do |tp|
$tp = tp
end
$tp.line #=> access from outside (RuntimeError)
Access from other threads is also forbidden.
;T;[ ;#[ ;$I"ETracePoint.new(*events) { |obj| block } -> obj
Returns a new TracePoint object, not enabled by default.
Next, in order to activate the trace, you must use TracePoint.enable
trace = TracePoint.new(:call) do |tp|
p [tp.lineno, tp.defined_class, tp.method_id, tp.event]
end
#=> #
trace.enable
#=> false
puts "Hello, TracePoint!"
# ...
# [48, IRB::Notifier::AbstractNotifier, :printf, :call]
# ...
When you want to deactivate the trace, you must use TracePoint.disable
trace.disable
See TracePoint@Events for possible events and more information.
A block must be given, otherwise a ThreadError is raised.
If the trace method isn't included in the given events filter, a
RuntimeError is raised.
TracePoint.trace(:line) do |tp|
p tp.raised_exception
end
#=> RuntimeError: 'raised_exception' not supported by this event
If the trace method is called outside block, a RuntimeError is raised.
TracePoint.trace(:line) do |tp|
$tp = tp
end
$tp.line #=> access from outside (RuntimeError)
Access from other threads is also forbidden.
;T;%0;"@Z{;'F;)o;*;+T;,i;-i;.@X{; I"static VALUE;T;/I"static VALUE
tracepoint_new_s(int argc, VALUE *argv, VALUE self)
{
rb_event_flag_t events = 0;
int i;
if (argc > 0) {
for (i=0; i obj
A convenience method for TracePoint.new, that activates the trace
automatically.
trace = TracePoint.trace(:call) { |tp| [tp.lineno, tp.event] }
#=> #
trace.enabled? #=> true
;T;[ ;#[ ;$I"
call-seq:
TracePoint.trace(*events) { |obj| block } -> obj
A convenience method for TracePoint.new, that activates the trace
automatically.
trace = TracePoint.trace(:call) { |tp| [tp.lineno, tp.event] }
#=> #
trace.enabled? #=> true
;T;%0;"@i{;'F;)o;*;+T;,i;-i;.@X{; I"static VALUE;T;/I"static VALUE
tracepoint_trace_s(int argc, VALUE *argv, VALUE self)
{
VALUE trace = tracepoint_new_s(argc, argv, self);
rb_tracepoint_enable(trace);
return trace;
};T;0To;
; F; ;
;;;I"TracePoint#enable;F;[ ;[[@
i:;T;: enable;0;[ ;{ ;IC;"trace.enable -> true or false
trace.enable { block } -> obj
Activates the trace
Return true if trace was enabled.
Return false if trace was disabled.
trace.enabled? #=> false
trace.enable #=> false (previous state)
# trace is enabled
trace.enabled? #=> true
trace.enable #=> true (previous state)
# trace is still enabled
If a block is given, the trace will only be enabled within the scope of the
block.
trace.enabled?
#=> false
trace.enable do
trace.enabled?
# only enabled for this block
end
trace.enabled?
#=> false
Note: You cannot access event hooks within the block.
trace.enable { p tp.lineno }
#=> RuntimeError: access from outside
;T;[ ;#[ ;$I"trace.enable -> true or false
trace.enable { block } -> obj
Activates the trace
Return true if trace was enabled.
Return false if trace was disabled.
trace.enabled? #=> false
trace.enable #=> false (previous state)
# trace is enabled
trace.enabled? #=> true
trace.enable #=> true (previous state)
# trace is still enabled
If a block is given, the trace will only be enabled within the scope of the
block.
trace.enabled?
#=> false
trace.enable do
trace.enabled?
# only enabled for this block
end
trace.enabled?
#=> false
Note: You cannot access event hooks within the block.
trace.enable { p tp.lineno }
#=> RuntimeError: access from outside
;T;%0;"@x{;'F;)o;*;+T;,i;-i8;.@X{; I"static VALUE;T;/I"nstatic VALUE
tracepoint_enable_m(VALUE tpval)
{
rb_tp_t *tp = tpptr(tpval);
int previous_tracing = tp->tracing;
rb_tracepoint_enable(tpval);
if (rb_block_given_p()) {
return rb_ensure(rb_yield, Qnil,
previous_tracing ? rb_tracepoint_enable : rb_tracepoint_disable,
tpval);
}
else {
return previous_tracing ? Qtrue : Qfalse;
}
};T;0To;
; F; ;
;;;I"TracePoint#disable;F;[ ;[[@
im;T;: disable;0;[ ;{ ;IC;"^trace.disable -> true or false
trace.disable { block } -> obj
Deactivates the trace
Return true if trace was enabled.
Return false if trace was disabled.
trace.enabled? #=> true
trace.disable #=> false (previous status)
trace.enabled? #=> false
trace.disable #=> false
If a block is given, the trace will only be disable within the scope of the
block.
trace.enabled?
#=> true
trace.disable do
trace.enabled?
# only disabled for this block
end
trace.enabled?
#=> true
Note: You cannot access event hooks within the block.
trace.disable { p tp.lineno }
#=> RuntimeError: access from outside
;T;[ ;#[ ;$I"`trace.disable -> true or false
trace.disable { block } -> obj
Deactivates the trace
Return true if trace was enabled.
Return false if trace was disabled.
trace.enabled? #=> true
trace.disable #=> false (previous status)
trace.enabled? #=> false
trace.disable #=> false
If a block is given, the trace will only be disable within the scope of the
block.
trace.enabled?
#=> true
trace.disable do
trace.enabled?
# only disabled for this block
end
trace.enabled?
#=> true
Note: You cannot access event hooks within the block.
trace.disable { p tp.lineno }
#=> RuntimeError: access from outside
;T;%0;"@{;'F;)o;*;+T;,iK;-ik;.@X{; I"static VALUE;T;/I"pstatic VALUE
tracepoint_disable_m(VALUE tpval)
{
rb_tp_t *tp = tpptr(tpval);
int previous_tracing = tp->tracing;
rb_tracepoint_disable(tpval);
if (rb_block_given_p()) {
return rb_ensure(rb_yield, Qnil,
previous_tracing ? rb_tracepoint_enable : rb_tracepoint_disable,
tpval);
}
else {
return previous_tracing ? Qtrue : Qfalse;
}
};T;0To;
; F; ;
;;;I"TracePoint#enabled?;F;[ ;[[@
i;T;:
enabled?;0;[ ;{ ;IC;"Itrace.enabled? -> true or false
The current status of the trace
;T;[o;!
; I" return;F; @;0; [@;"@{;#[ ;$I"Ktrace.enabled? -> true or false
The current status of the trace
;T;%0;"@{;'F;)o;*;+T;,i~;-i;.@X{; I"
VALUE;T;/I"|VALUE
rb_tracepoint_enabled_p(VALUE tpval)
{
rb_tp_t *tp = tpptr(tpval);
return tp->tracing ? Qtrue : Qfalse;
};T;0To;
; F; ;
;;;I"TracePoint#inspect;F;[ ;[[@
i;T;;J;0;[ ;{ ;IC;"CReturn a string containing a human-readable TracePoint
status.
;T;[o;
; I"
overload;F; 0;;J; 0; I" inspect;T;IC;" ;T;[o;!
; I" return;F; I" ;T;0; [I" String;T;"@{;#[ ;$I"@return [String];T;%0;"@{;&0;'F;(i ;[ ;"@{;#[ ;$I"jReturn a string containing a human-readable TracePoint
status.
@overload inspect
@return [String];T;%0;"@{;'F;)o;*;+T;,i;-i;.@X{; I"static VALUE;T;/I"static VALUE
tracepoint_inspect(VALUE self)
{
rb_tp_t *tp = tpptr(self);
rb_trace_arg_t *trace_arg = GET_THREAD()->trace_arg;
if (trace_arg) {
switch (trace_arg->event) {
case RUBY_EVENT_LINE:
case RUBY_EVENT_SPECIFIED_LINE:
{
VALUE sym = rb_tracearg_method_id(trace_arg);
if (NIL_P(sym))
goto default_inspect;
return rb_sprintf("#",
rb_tracearg_event(trace_arg),
rb_tracearg_path(trace_arg),
FIX2INT(rb_tracearg_lineno(trace_arg)),
sym);
}
case RUBY_EVENT_CALL:
case RUBY_EVENT_C_CALL:
case RUBY_EVENT_RETURN:
case RUBY_EVENT_C_RETURN:
return rb_sprintf("#",
rb_tracearg_event(trace_arg),
rb_tracearg_method_id(trace_arg),
rb_tracearg_path(trace_arg),
FIX2INT(rb_tracearg_lineno(trace_arg)));
case RUBY_EVENT_THREAD_BEGIN:
case RUBY_EVENT_THREAD_END:
return rb_sprintf("#