'"] 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;= ;3I" overload;F;40;;¿;50;)I" caller(start=1, length=nil);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;TI"nil;T; @;[;I"@return [Array, nil];T;0;6i;[[I" start;TI"1;T[I"length;TI"nil;T; @o;= ;3I" overload;F;40;;¿;50;)I"caller(range);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;TI"nil;T; @;[;I"@return [Array, nil];T;0;6i;[[I" range;T0; @;[;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;"o;#;$T;%i”;&i¸;'@6;(I"{static VALUE rb_f_caller(int argc, VALUE *argv, VALUE _) { return ec_backtrace_to_ary(GET_EC(), argc, argv, 1, 1, 1); };T;)I"static VALUE;T;*To;;F; ;;;;I"Kernel#caller_locations;F;[[@c0;[[@³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;= ;3I" overload;F;40;;À;50;)I":caller_locations(start=1, length=nil) -> array or nil;T;IC;";T; @á;>0;!F;[;[;I";T;0;6i;[[I" start;TI"1;T[I"length;TI"nil;T; @áo;= ;3I" overload;F;40;;À;50;)I".caller_locations(range) -> array or nil;T;IC;";T; @á;>0;!F;[;[;I";T;0;6i;[[I" range;T0; @á;[;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; @á;!F;"o;#;$T;%iÀ;&iÓ;'@6;(I"…static VALUE rb_f_caller_locations(int argc, VALUE *argv, VALUE _) { return ec_backtrace_to_ary(GET_EC(), argc, argv, 1, 1, 0); };T;)I"static VALUE;T;*To;;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;= ;3I" overload;F;40;;Á;50;)I"at_exit;T;IC;";T; @;>0;!F;[o;2 ;3I" yield;F;4I"[];T;0;50; @o;2 ;3I"return;F;4I";T;0;5[I" Proc;T; @;[;I"@yield [] @return [Proc];T;0;6i;[; @;[;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(;'@6;(I"éstatic VALUE rb_f_at_exit(VALUE _) { 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;)I"static VALUE;T;*To;;F; ;;;;I"Kernel#proc;F;[;[[@iF;T;: proc;0;[;{;IC;"Equivalent to Proc.new. ;T;[o;= ;3I" overload;F;40;;Â;50;)I" proc;T;IC;";T; @';>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"...;T; @'o;2 ;3I"return;F;4I";T;0;5[I" Proc;T; @';[;I" @yield [...] @return [Proc];T;0;6i;[; @';[;I"MEquivalent to Proc.new. @overload proc @yield [...] @return [Proc];T;0; @';!F;"o;#;$T;%i?;&iD;'@6;(I"Qstatic VALUE f_proc(VALUE _) { return proc_new(rb_cProc, FALSE, TRUE); };T;)I"static VALUE;T;*To;;F; ;;;;I"Kernel#lambda;F;[;[[@iv;T;:lambda;0;[;{;IC;"qEquivalent to Proc.new, except the resulting Proc objects check the number of parameters passed when called. ;T;[o;= ;3I" overload;F;40;;Ã;50;)I"lambda;T;IC;";T; @G;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"...;T; @Go;2 ;3I"return;F;4I";T;0;5[I" Proc;T; @G;[;I" @yield [...] @return [Proc];T;0;6i;[; @G;[;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; @G;!F;"o;#;$T;%in;⁢'@6;(I"Zstatic VALUE f_lambda(VALUE _) { f_lambda_warn(); return rb_block_lambda(); };T;)I"static VALUE;T;*To;;F; ;;;;I"Kernel#binding;F;[;[[@i‚;T;:binding;0;[;{;IC;"YReturns 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) binding end b = get_binding("hello") eval("param", b) #=> "hello" ;T;[o;= ;3I" overload;F;40;;Ä;50;)I"binding;T;IC;";T; @g;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Binding;T; @g;[;I"@return [Binding];T;0;6i;[; @g;[;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) binding end b = get_binding("hello") eval("param", b) #=> "hello" @overload binding @return [Binding];T;0; @g;!F;"o;#;$T;%ir;&i;'@6;(I"Kstatic VALUE rb_f_binding(VALUE self) { return rb_binding_new(); };T;)I"static VALUE;T;*To;;F; ;;;;I"Kernel#eval;F;[[@c0;[[@viñ;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;= ;3I" overload;F;40;;Å;50;)I"4eval(string [, binding [, filename [,lineno]]]);T;IC;";T; @‚;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @‚;[;I"@return [Object];T;0;6i;[[I"-string[, binding [, filename [,lineno]]];T0; @‚;[;I"*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" @overload eval(string [, binding [, filename [,lineno]]]) @return [Object];T;0; @‚;!F;"o;#;$T;%iß;&iî;'@6;(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; if (NIL_P(scope)) return eval_string_with_cref(self, src, NULL, file, line); else return eval_string_with_scope(scope, src, file, line); };T;)I" VALUE;T;*To;;F; ;;;;I"Kernel#local_variables;F;[;[[@vi´ ;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;= ;3I" overload;F;40;;Æ;50;)I"local_variables;T;IC;";T; @ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ ;[;I"@return [Array];T;0;6i;[; @ ;[;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± ;'@6;(I"static VALUE rb_f_local_variables(VALUE _) { struct local_var_list vars; rb_execution_context_t *ec = GET_EC(); rb_control_frame_t *cfp = vm_get_ruby_level_caller_cfp(ec, RUBY_VM_PREVIOUS_CONTROL_FRAME(ec->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_ENV_LOCAL_P(cfp->ep)) { /* block */ const VALUE *ep = VM_CF_PREV_EP(cfp); if (vm_collect_local_variables_in_heap(ep, &vars)) { break; } else { while (cfp->ep != ep) { cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp); } } } else { break; } } return local_var_list_finish(&vars); };T;)I"static VALUE;T;*To;;F; ;;;;I"Kernel#iterator?;F;[;[[@vi ;T;:iterator?;0;[;{;IC;"+Deprecated. Use block_given? instead.;T;[o;= ;3I" overload;F;40;;Ç;50;)I"iterator?;T;IC;";T; @»;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @»;[;I"@return [Boolean];T;0;6i;[; @»;[;I"UDeprecated. Use block_given? instead. @overload iterator? @return [Boolean];T;0; @»;!F;"o;#;$T;%iú ;&iþ ;6i;'@6;(I"†static VALUE rb_f_iterator_p(VALUE self) { rb_warn_deprecated("iterator?", "block_given?"); return rb_f_block_given_p(self); };T;)I"static VALUE;T;*To;;F; ;;;;I"Kernel#block_given?;F;[;[[@vië ;T;:block_given?;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;= ;3I" overload;F;40;;È;50;)I"block_given?;T;IC;";T; @Ö;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Ö;[;I"@return [Boolean];T;0;6i;[; @Ö;[;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];T;0; @Ö;!F;"o;#;$T;%i× ;&iè ;6i;'@6;(I"Rstatic VALUE rb_f_block_given_p(VALUE _) { rb_execution_context_t *ec = GET_EC(); rb_control_frame_t *cfp = ec->cfp; cfp = vm_get_ruby_level_caller_cfp(ec, RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp)); if (cfp != NULL && VM_CF_BLOCK_HANDLER(cfp) != VM_BLOCK_HANDLER_NONE) { return Qtrue; } else { return Qfalse; } };T;)I"static VALUE;T;*To;;F; ;;;;I"Kernel#catch;F;[[@c0;[[@viI ;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;= ;3I" overload;F;40;;É;50;)I"catch([tag]);T;IC;";T; @ñ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"tag;T; @ño;2 ;3I"return;F;4I";T;0;5[I"Object;T; @ñ;[;I""@yield [tag] @return [Object];T;0;6i;[[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 ;&iG ;'@6;(I"¹static VALUE rb_f_catch(int argc, VALUE *argv, VALUE self) { VALUE tag = rb_check_arity(argc, 0, 1) ? argv[0] : rb_obj_alloc(rb_cObject); return rb_catch_obj(tag, catch_i, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"Kernel#throw;F;[[@c0;[[@viç;T;: throw;0;[;{;IC;"$Transfers 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;= ;3I" overload;F;40;;Ê;50;)I"throw(tag [, obj]);T;IC;";T; @;>0;!F;[;[;I";T;0;6i;[[I"tag[, obj];T0; @;[;I"CTransfers 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; @;!F;"o;#;$T;%iÛ;&iã;'@6;(I"Àstatic VALUE rb_f_throw(int argc, VALUE *argv, VALUE _) { VALUE tag, value; rb_scan_args(argc, argv, "11", &tag, &value); rb_throw_obj(tag, value); UNREACHABLE_RETURN(Qnil); };T;)I"static VALUE;T;*To;;F; ;;;;I"Kernel#loop;F;[;[[@viÅ;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;= ;3I" overload;F;40;;Ë;50;)I" loop;T;IC;";T; @-;>0;!F;[o;2 ;3I" yield;F;4I"[];T;0;50; @-;[;I"@yield [];T;0;6i;[; @-o;= ;3I" overload;F;40;;Ë;50;)I" loop;T;IC;";T; @-;>0;!F;[;[;I";T;0;6i;[; @-;[;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; @-;!F;"o;#;$T;%i§;&iÂ;'@6;(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;)I"static VALUE;T;*To;;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; @N;'@6;(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;)I"static VALUE;T;*To;;F; ;;;;I"Kernel#test;F;[[@c0;[[I"file.c;TiØ;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;= ;3I" overload;F;40;;Í;50;)I" test(cmd, file1 [, file2] );T;IC;";T; @];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @];[;I"@return [Object];T;0;6i;[[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ž;&iÕ;'@6;(I"¡static VALUE rb_f_test(int argc, VALUE *argv, VALUE _) { int cmd; if (argc == 0) rb_check_arity(argc, 2, 3); cmd = NUM2CHR(argv[0]); if (cmd == 0) { goto unknown; } 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; } } 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); } UNREACHABLE_RETURN(Qundef); };T;)I"static VALUE;T;*T;A@6;BIC;[;A@6;CIC;[;A@6;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ÌiŸ[@Ìi«;T;:Kernel;;K;;;[;{;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; @6;!F;"o;#;$T;%iŸ;&i©;6i;'@;I"Kernel;F;A@];DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@Ìi_[@i‹[@Ìi;T;;T;;K;;;[;{;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; @];!F;"o;#;$T;%i_;&io;6i;'@;I"Object;F;So; ;IC;[o;;F; ;;:private;I"BasicObject#initialize;F;[;[[@Ìit;T;:initialize;0;[;{;IC;"=call-seq: BasicObject.new Returns a new BasicObject. ;T;[;[;I"? call-seq: BasicObject.new Returns a new BasicObject. ;T;0; @£;!F;"o;#;$T;%ia;&if;'@¡;(I"Gstatic VALUE rb_obj_dummy0(VALUE _) { return rb_obj_dummy(); };T;)I"static VALUE;T;*To;;F; ;;;;I"BasicObject#==;F;[[I" obj2;T0;[[@Ìiê;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 any pair of objects where #eql? returns +true+, the #hash value of both objects must be equal. So any subclass that overrides #eql? should also override #hash appropriately. 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;= ;3I" overload;F;40;;`;50;)I"==(other);T;IC;";T; @±;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @±;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @±o;= ;3I" overload;F;40;;a;50;)I"equal?(other);T;IC;";T; @±;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @±;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @±o;= ;3I" overload;F;40;;_;50;)I"eql?(other);T;IC;";T; @±;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @±;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @±;[;@c;0; @±;!F;"o;#;$T;%iÁ;&iè;'@¡;(I"}MJIT_FUNC_EXPORTED VALUE rb_obj_equal(VALUE obj1, VALUE obj2) { if (obj1 == obj2) return Qtrue; return Qfalse; };T;)I"MJIT_FUNC_EXPORTED VALUE;T;*To;;F; ;;;;I"BasicObject#equal?;F;[[I" obj2;T0;[[@Ìiê;T;;a;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 any pair of objects where #eql? returns +true+, the #hash value of both objects must be equal. So any subclass that overrides #eql? should also override #hash appropriately. 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;= ;3I" overload;F;40;;`;50;)I"==(other);T;IC;";T; @í;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @í;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @ío;= ;3I" overload;F;40;;a;50;)I"equal?(other);T;IC;";T; @í;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @í;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @ío;= ;3I" overload;F;40;;_;50;)I"eql?(other);T;IC;";T; @í;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @í;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @í;[;@c;0; @í;!F;"o;#;$T;%iÁ;&iè;6i;'@¡;(I"}MJIT_FUNC_EXPORTED VALUE rb_obj_equal(VALUE obj1, VALUE obj2) { if (obj1 == obj2) return Qtrue; return Qfalse; };T;)I"MJIT_FUNC_EXPORTED VALUE;T;*To;;F; ;;;;I"BasicObject#!;F;[;[[@Ìiý;T;:!;0;[;{;IC;"Boolean negate. ;T;[o;= ;3I" overload;F;40;;Ñ;50;)I" !obj;T;IC;";T; @);>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @);[;I"@return [Boolean];T;0;6i;[; @);[;I":Boolean negate. @overload !obj @return [Boolean];T;0; @);!F;"o;#;$T;%ió;&iø;'@¡;(I"_MJIT_FUNC_EXPORTED VALUE rb_obj_not(VALUE obj) { return RTEST(obj) ? Qfalse : Qtrue; };T;)I"MJIT_FUNC_EXPORTED VALUE;T;*To;;F; ;;;;I"BasicObject#!=;F;[[I" obj2;T0;[[@Ìi ;T;:!=;0;[;{;IC;"@Returns true if two objects are not-equal, otherwise false. ;T;[o;= ;3I" overload;F;40;;Ò;50;)I"!=(other);T;IC;";T; @D;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @D;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @D;[;I"kReturns true if two objects are not-equal, otherwise false. @overload !=(other) @return [Boolean];T;0; @D;!F;"o;#;$T;%i;&i;'@¡;(I"¥MJIT_FUNC_EXPORTED VALUE rb_obj_not_equal(VALUE obj1, VALUE obj2) { VALUE result = rb_funcall(obj1, id_eq, 1, obj2); return RTEST(result) ? Qfalse : Qtrue; };T;)I"MJIT_FUNC_EXPORTED VALUE;T;*To;;F; ;;;Ï;I"'BasicObject#singleton_method_added;F;[[I"_y;T0;[[@Ìiz;T;:singleton_method_added;0;[;{;IC;"Ÿcall-seq: singleton_method_added(symbol) Invoked as a callback whenever a singleton method is added to the receiver. module Chatty def Chatty.singleton_method_added(id) puts "Adding #{id.id2name}" end def self.one() end def two() end def Chatty.three() end end produces: Adding singleton_method_added Adding one Adding three ;T;[;[;I"£ call-seq: singleton_method_added(symbol) Invoked as a callback whenever a singleton method is added to the receiver. module Chatty def Chatty.singleton_method_added(id) puts "Adding #{id.id2name}" end def self.one() end def two() end def Chatty.three() end end produces: Adding singleton_method_added Adding one Adding three ;T;0; @c;!F;"o;#;$T;%i×;&ií;'@¡;(I"Rstatic VALUE rb_obj_dummy1(VALUE _x, VALUE _y) { return rb_obj_dummy(); };T;)I"static VALUE;T;*To;;F; ;;;Ï;I")BasicObject#singleton_method_removed;F;[[I"_y;T0;[[@Ìiz;T;:singleton_method_removed;0;[;{;IC;"ácall-seq: singleton_method_removed(symbol) Invoked as a callback whenever a singleton method is removed from the receiver. module Chatty def Chatty.singleton_method_removed(id) puts "Removing #{id.id2name}" end def self.one() end def two() end def Chatty.three() end class << self remove_method :three remove_method :one end end produces: Removing three Removing one ;T;[;[;I"ä call-seq: singleton_method_removed(symbol) Invoked as a callback whenever a singleton method is removed from the receiver. module Chatty def Chatty.singleton_method_removed(id) puts "Removing #{id.id2name}" end def self.one() end def two() end def Chatty.three() end class << self remove_method :three remove_method :one end end produces: Removing three Removing one ;T;0; @s;!F;"o;#;$T;%iñ;&i ;'@¡;(I"Rstatic VALUE rb_obj_dummy1(VALUE _x, VALUE _y) { return rb_obj_dummy(); };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"+BasicObject#singleton_method_undefined;F;[[I"_y;T0;[[@Ìiz;T;:singleton_method_undefined;0;[;{;IC;"€call-seq: singleton_method_undefined(symbol) Invoked as a callback whenever a singleton method is undefined in the receiver. module Chatty def Chatty.singleton_method_undefined(id) puts "Undefining #{id.id2name}" end def Chatty.one() end class << self undef_method(:one) end end produces: Undefining one ;T;[;[;I"ƒ call-seq: singleton_method_undefined(symbol) Invoked as a callback whenever a singleton method is undefined in the receiver. module Chatty def Chatty.singleton_method_undefined(id) puts "Undefining #{id.id2name}" end def Chatty.one() end class << self undef_method(:one) end end produces: Undefining one ;T;0; @ƒ;!F;"o;#;$T;%i ;&i!;'@¡;(I"Rstatic VALUE rb_obj_dummy1(VALUE _x, VALUE _y) { return rb_obj_dummy(); };T;)I"static VALUE;T;*To;;F; ;;;;I"BasicObject#instance_eval;F;[[@c0;[[@vi$;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;= ;3I" overload;F;40;;Ö;50;)I"3instance_eval(string [, filename [, lineno]] );T;IC;";T; @“;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @“;[;I"@return [Object];T;0;6i;[[I""string[, filename [, lineno]];T0; @“o;= ;3I" overload;F;40;;Ö;50;)I"instance_eval;T;IC;";T; @“;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @“o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @“;[;I""@yield [obj] @return [Object];T;0;6i;[; @“;[;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#;'@¡;(I"Õstatic VALUE rb_obj_instance_eval_internal(int argc, const VALUE *argv, VALUE self) { VALUE klass = singleton_class_for_eval(self); return specific_eval(argc, argv, klass, self, RB_PASS_CALLED_KEYWORDS); };T;)I"static VALUE;T;*To;;F; ;;;;I"BasicObject#instance_exec;F;[[@c0;[[@viD;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;= ;3I" overload;F;40;;×;50;)I"instance_exec(arg...);T;IC;";T; @Ã;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"var...;T; @Ão;2 ;3I"return;F;4I";T;0;5[I"Object;T; @Ã;[;I"%@yield [var...] @return [Object];T;0;6i;[[I"arg...;T0; @Ã;[;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; @Ã;!F;"o;#;$T;%i2;&iB;'@¡;(I"Óstatic VALUE rb_obj_instance_exec_internal(int argc, const VALUE *argv, VALUE self) { VALUE klass = singleton_class_for_eval(self); return yield_under(klass, self, argc, argv, RB_PASS_CALLED_KEYWORDS); };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"BasicObject#method_missing;F;[[@c0;[[@vim;T;:method_missing;0;[;{;IC;"ç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(symbol, *args) str = symbol.id2name begin roman_to_int(str) rescue super(symbol, *args) end end end r = Roman.new r.iv #=> 4 r.xxiii #=> 23 r.mm #=> 2000 r.foo #=> NoMethodError ;T;[o;= ;3I" overload;F;40;;Ø;50;)I"&method_missing(symbol [, *args] );T;IC;";T; @æ;>0;!F;[;[;I";T;0;6i;[[I"symbol[, *args];T0; @æ;[;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(symbol, *args) str = symbol.id2name begin roman_to_int(str) rescue super(symbol, *args) end end end r = Roman.new r.iv #=> 4 r.xxiii #=> 23 r.mm #=> 2000 r.foo #=> NoMethodError @overload method_missing(symbol [, *args] );T;0; @æ;!F;"o;#;$T;%iF;ⅈ'@¡;(I"Ýstatic VALUE rb_method_missing(int argc, const VALUE *argv, VALUE obj) { rb_execution_context_t *ec = GET_EC(); raise_method_missing(ec, argc, argv, obj, ec->method_missing_reason); UNREACHABLE_RETURN(Qnil); };T;)I"static VALUE;T;*To;;F; ;;;;I"BasicObject#__send__;F;[[@c0;[[@vi;T;;„;0;[;{;IC;"!Invokes the method identified by _symbol_, passing it any arguments specified. When the method is identified by a string, the string is converted to a symbol. BasicObject implements +__send__+, Kernel implements +send+. __send__ is safer than +send+ when _obj_ has the same method name like Socket. See also public_send. class Klass def hello(*args) "Hello " + args.join(' ') end end k = Klass.new k.send :hello, "gentle", "readers" #=> "Hello gentle readers" ;T;[ o;= ;3I" overload;F;40;;ƒ;50;)I"send(symbol [, args...]);T;IC;";T; @ÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @ÿ;[;I"@return [Object];T;0;6i;[[I"symbol[, args...];T0; @ÿo;= ;3I" overload;F;40;;„;50;)I"!__send__(symbol [, args...]);T;IC;";T; @ÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @ÿ;[;I"@return [Object];T;0;6i;[[I"symbol[, args...];T0; @ÿo;= ;3I" overload;F;40;;ƒ;50;)I"send(string [, args...]);T;IC;";T; @ÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @ÿ;[;I"@return [Object];T;0;6i;[[I"string[, args...];T0; @ÿo;= ;3I" overload;F;40;;„;50;)I"!__send__(string [, args...]);T;IC;";T; @ÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @ÿ;[;I"@return [Object];T;0;6i;[[I"string[, args...];T0; @ÿ;[;@¸;0; @ÿ;!F;"o;#;$T;%iô;&i;'@¡;(I"vVALUE rb_f_send(int argc, VALUE *argv, VALUE recv) { return send_internal_kw(argc, argv, recv, CALL_FCALL); };T;)I" VALUE;T;*To;;F; ;;;;I"BasicObject#__id__;T;[;[[@i ;T;:__id__;0;[;{;IC;"4call-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. BasicObject implements +__id__+, Kernel implements +object_id+. 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; @I;!F;"o;#;$T;%iò;&i;'o;L;M0;N0;O0;:BasicObject;'@;Q@¡;R0;(I"VALUE 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 */ return rb_find_object_id(obj, cached_object_id); };T;)I" VALUE;T;*T;A@¡;BIC;[;A@¡;CIC;[;A@¡;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@Ìi*[@iŠ[@ÌiŽ;T;;Ú;;K;;;[;{;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) return 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) return 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;"o;#;$T;%i*;&i\;6i;'@;I"BasicObject;F;So;L;M0;N0;O0;: Qnil;'@;Q0;R;F;R;Fo; ;IC;[ o;;F; ;F;;;I"Zlib::Deflate.deflate;F;[[@c0;[[@iµ;T;:deflate;0;[;{;IC;"Õcall-seq: Zlib.deflate(string[, level]) Zlib::Deflate.deflate(string[, level]) Compresses the given +string+. Valid values of level are Zlib::NO_COMPRESSION, Zlib::BEST_SPEED, Zlib::BEST_COMPRESSION, Zlib::DEFAULT_COMPRESSION, or an integer from 0 to 9. This method is almost equivalent to the following code: def deflate(string, level) z = Zlib::Deflate.new(level) dst = z.deflate(string, Zlib::FINISH) z.close dst end See also Zlib.inflate ;T;[;[;I"Ø call-seq: Zlib.deflate(string[, level]) Zlib::Deflate.deflate(string[, level]) Compresses the given +string+. Valid values of level are Zlib::NO_COMPRESSION, Zlib::BEST_SPEED, Zlib::BEST_COMPRESSION, Zlib::DEFAULT_COMPRESSION, or an integer from 0 to 9. This method is almost equivalent to the following code: def deflate(string, level) z = Zlib::Deflate.new(level) dst = z.deflate(string, Zlib::FINISH) z.close dst end See also Zlib.inflate ;T;0; @m;!F;"o;#;$T;%iž;&i²;'@k;(I"&static VALUE rb_deflate_s_deflate(int argc, VALUE *argv, VALUE klass) { struct zstream z; VALUE src, level, dst, args[2]; int err, lev; rb_scan_args(argc, argv, "11", &src, &level); lev = ARG_LEVEL(level); StringValue(src); zstream_init_deflate(&z); err = deflateInit(&z.stream, lev); if (err != Z_OK) { raise_zlib_error(err, z.stream.msg); } ZSTREAM_READY(&z); args[0] = (VALUE)&z; args[1] = src; dst = rb_ensure(deflate_run, (VALUE)args, zstream_ensure_end, (VALUE)&z); return dst; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::Deflate#initialize;F;[[@c0;[[@ie;T;;Ð;0;[;{;IC;"¿call-seq: Zlib::Deflate.new(level=DEFAULT_COMPRESSION, window_bits=MAX_WBITS, mem_level=DEF_MEM_LEVEL, strategy=DEFAULT_STRATEGY) Creates a new deflate stream for compression. If a given argument is nil, the default value of that argument is used. The +level+ sets the compression level for the deflate stream between 0 (no compression) and 9 (best compression). The following constants have been defined to make code more readable: * Zlib::DEFAULT_COMPRESSION * Zlib::NO_COMPRESSION * Zlib::BEST_SPEED * Zlib::BEST_COMPRESSION See http://www.zlib.net/manual.html#Constants for further information. The +window_bits+ sets the size of the history buffer and should be between 8 and 15. Larger values of this parameter result in better compression at the expense of memory usage. The +mem_level+ specifies how much memory should be allocated for the internal compression state. 1 uses minimum memory but is slow and reduces compression ratio while 9 uses maximum memory for optimal speed. The default value is 8. Two constants are defined: * Zlib::DEF_MEM_LEVEL * Zlib::MAX_MEM_LEVEL The +strategy+ sets the deflate compression strategy. The following strategies are available: Zlib::DEFAULT_STRATEGY:: For normal data Zlib::FILTERED:: For data produced by a filter or predictor Zlib::FIXED:: Prevents dynamic Huffman codes Zlib::HUFFMAN_ONLY:: Prevents string matching Zlib::RLE:: Designed for better compression of PNG image data See the constants for further description. == Examples === Basic open "compressed.file", "w+" do |io| io << Zlib::Deflate.new.deflate(File.read("big.file")) end === Custom compression open "compressed.file", "w+" do |compressed_io| deflate = Zlib::Deflate.new(Zlib::BEST_COMPRESSION, Zlib::MAX_WBITS, Zlib::MAX_MEM_LEVEL, Zlib::HUFFMAN_ONLY) begin open "big.file" do |big_io| until big_io.eof? do compressed_io << zd.deflate(big_io.read(16384)) end end ensure deflate.close end end While this example will work, for best optimization review the flags for your specific time, memory usage and output space requirements. ;T;[;[;I"Á call-seq: Zlib::Deflate.new(level=DEFAULT_COMPRESSION, window_bits=MAX_WBITS, mem_level=DEF_MEM_LEVEL, strategy=DEFAULT_STRATEGY) Creates a new deflate stream for compression. If a given argument is nil, the default value of that argument is used. The +level+ sets the compression level for the deflate stream between 0 (no compression) and 9 (best compression). The following constants have been defined to make code more readable: * Zlib::DEFAULT_COMPRESSION * Zlib::NO_COMPRESSION * Zlib::BEST_SPEED * Zlib::BEST_COMPRESSION See http://www.zlib.net/manual.html#Constants for further information. The +window_bits+ sets the size of the history buffer and should be between 8 and 15. Larger values of this parameter result in better compression at the expense of memory usage. The +mem_level+ specifies how much memory should be allocated for the internal compression state. 1 uses minimum memory but is slow and reduces compression ratio while 9 uses maximum memory for optimal speed. The default value is 8. Two constants are defined: * Zlib::DEF_MEM_LEVEL * Zlib::MAX_MEM_LEVEL The +strategy+ sets the deflate compression strategy. The following strategies are available: Zlib::DEFAULT_STRATEGY:: For normal data Zlib::FILTERED:: For data produced by a filter or predictor Zlib::FIXED:: Prevents dynamic Huffman codes Zlib::HUFFMAN_ONLY:: Prevents string matching Zlib::RLE:: Designed for better compression of PNG image data See the constants for further description. == Examples === Basic open "compressed.file", "w+" do |io| io << Zlib::Deflate.new.deflate(File.read("big.file")) end === Custom compression open "compressed.file", "w+" do |compressed_io| deflate = Zlib::Deflate.new(Zlib::BEST_COMPRESSION, Zlib::MAX_WBITS, Zlib::MAX_MEM_LEVEL, Zlib::HUFFMAN_ONLY) begin open "big.file" do |big_io| until big_io.eof? do compressed_io << zd.deflate(big_io.read(16384)) end end ensure deflate.close end end While this example will work, for best optimization review the flags for your specific time, memory usage and output space requirements. ;T;0; @|;!F;"o;#;$T;%i;&ib;'@k;(I"+static VALUE rb_deflate_initialize(int argc, VALUE *argv, VALUE obj) { struct zstream *z; VALUE level, wbits, memlevel, strategy; int err; rb_scan_args(argc, argv, "04", &level, &wbits, &memlevel, &strategy); TypedData_Get_Struct(obj, struct zstream, &zstream_data_type, z); err = deflateInit2(&z->stream, ARG_LEVEL(level), Z_DEFLATED, ARG_WBITS(wbits), ARG_MEMLEVEL(memlevel), ARG_STRATEGY(strategy)); if (err != Z_OK) { raise_zlib_error(err, z->stream.msg); } ZSTREAM_READY(z); return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I""Zlib::Deflate#initialize_copy;F;[[I" orig;T0;[[@i;T;;g;0;[;{;IC;"#Duplicates the deflate stream. ;T;[;[;I"% Duplicates the deflate stream. ;T;0; @‹;!F;"o;#;$T;%iz;&i|;'@k;(I"static VALUE rb_deflate_init_copy(VALUE self, VALUE orig) { struct zstream *z1, *z2; int err; TypedData_Get_Struct(self, struct zstream, &zstream_data_type, z1); z2 = get_zstream(orig); if (z1 == z2) return self; err = deflateCopy(&z1->stream, &z2->stream); if (err != Z_OK) { raise_zlib_error(err, 0); } z1->input = NIL_P(z2->input) ? Qnil : rb_str_dup(z2->input); z1->buf = NIL_P(z2->buf) ? Qnil : rb_str_dup(z2->buf); z1->flags = z2->flags; return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::Deflate#deflate;F;[[@c0;[[@iõ;T;;Ü;0;[;{;IC;"ccall-seq: z.deflate(string, flush = Zlib::NO_FLUSH) -> String z.deflate(string, flush = Zlib::NO_FLUSH) { |chunk| ... } -> nil Inputs +string+ into the deflate stream and returns the output from the stream. On calling this method, both the input and the output buffers of the stream are flushed. If +string+ is nil, this method finishes the stream, just like Zlib::ZStream#finish. If a block is given consecutive deflated chunks from the +string+ are yielded to the block and +nil+ is returned. The +flush+ parameter specifies the flush mode. The following constants may be used: Zlib::NO_FLUSH:: The default Zlib::SYNC_FLUSH:: Flushes the output to a byte boundary Zlib::FULL_FLUSH:: SYNC_FLUSH + resets the compression state Zlib::FINISH:: Pending input is processed, pending output is flushed. See the constants for further description. ;T;[;[;I"f call-seq: z.deflate(string, flush = Zlib::NO_FLUSH) -> String z.deflate(string, flush = Zlib::NO_FLUSH) { |chunk| ... } -> nil Inputs +string+ into the deflate stream and returns the output from the stream. On calling this method, both the input and the output buffers of the stream are flushed. If +string+ is nil, this method finishes the stream, just like Zlib::ZStream#finish. If a block is given consecutive deflated chunks from the +string+ are yielded to the block and +nil+ is returned. The +flush+ parameter specifies the flush mode. The following constants may be used: Zlib::NO_FLUSH:: The default Zlib::SYNC_FLUSH:: Flushes the output to a byte boundary Zlib::FULL_FLUSH:: SYNC_FLUSH + resets the compression state Zlib::FINISH:: Pending input is processed, pending output is flushed. See the constants for further description. ;T;0; @›;!F;"o;#;$T;%iÛ;&iò;'@k;(I"static VALUE rb_deflate_deflate(int argc, VALUE *argv, VALUE obj) { struct zstream *z = get_zstream(obj); VALUE src, flush; rb_scan_args(argc, argv, "11", &src, &flush); do_deflate(z, src, ARG_FLUSH(flush)); return zstream_detach_buffer(z); };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::Deflate#<<;F;[[I"src;T0;[[@i ;T;:<<;0;[;{;IC;"Åcall-seq: << string Inputs +string+ into the deflate stream just like Zlib::Deflate#deflate, but returns the Zlib::Deflate object itself. The output from the stream is preserved in output buffer. ;T;[;[;I"Ç call-seq: << string Inputs +string+ into the deflate stream just like Zlib::Deflate#deflate, but returns the Zlib::Deflate object itself. The output from the stream is preserved in output buffer. ;T;0; @ª;!F;"o;#;$T;%i;&i;'@k;(I"{static VALUE rb_deflate_addstr(VALUE obj, VALUE src) { do_deflate(get_zstream(obj), src, Z_NO_FLUSH); return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::Deflate#flush;F;[[@c0;[[@i ;T;: flush;0;[;{;IC;"×call-seq: flush(flush = Zlib::SYNC_FLUSH) -> String flush(flush = Zlib::SYNC_FLUSH) { |chunk| ... } -> nil This method is equivalent to deflate('', flush). This method is just provided to improve the readability of your Ruby program. If a block is given chunks of deflate output are yielded to the block until the buffer is flushed. See Zlib::Deflate#deflate for detail on the +flush+ constants NO_FLUSH, SYNC_FLUSH, FULL_FLUSH and FINISH. ;T;[;[;I"Ù call-seq: flush(flush = Zlib::SYNC_FLUSH) -> String flush(flush = Zlib::SYNC_FLUSH) { |chunk| ... } -> nil This method is equivalent to deflate('', flush). This method is just provided to improve the readability of your Ruby program. If a block is given chunks of deflate output are yielded to the block until the buffer is flushed. See Zlib::Deflate#deflate for detail on the +flush+ constants NO_FLUSH, SYNC_FLUSH, FULL_FLUSH and FINISH. ;T;0; @º;!F;"o;#;$T;%i;&i;'@k;(I"ystatic VALUE rb_deflate_flush(int argc, VALUE *argv, VALUE obj) { struct zstream *z = get_zstream(obj); VALUE v_flush; int flush; rb_scan_args(argc, argv, "01", &v_flush); flush = FIXNUMARG(v_flush, Z_SYNC_FLUSH); if (flush != Z_NO_FLUSH) { /* prevent Z_BUF_ERROR */ zstream_run(z, (Bytef*)"", 0, flush); } return zstream_detach_buffer(z); };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::Deflate#params;F;[[I"v_level;T0[I"v_strategy;T0;[[@i<;T;:params;0;[;{;IC;".call-seq: params(level, strategy) Changes the parameters of the deflate stream to allow changes between different types of data that require different types of compression. Any unprocessed data is flushed before changing the params. See Zlib::Deflate.new for a description of +level+ and +strategy+. ;T;[;[;I"1 call-seq: params(level, strategy) Changes the parameters of the deflate stream to allow changes between different types of data that require different types of compression. Any unprocessed data is flushed before changing the params. See Zlib::Deflate.new for a description of +level+ and +strategy+. ;T;0; @É;!F;"o;#;$T;%i0;&i9;'@k;(I"-static VALUE rb_deflate_params(VALUE obj, VALUE v_level, VALUE v_strategy) { struct zstream *z = get_zstream(obj); int level, strategy; int err; uInt n; long filled; level = ARG_LEVEL(v_level); strategy = ARG_STRATEGY(v_strategy); n = z->stream.avail_out; err = deflateParams(&z->stream, level, strategy); filled = n - z->stream.avail_out; while (err == Z_BUF_ERROR) { rb_warning("deflateParams() returned Z_BUF_ERROR"); zstream_expand_buffer(z); rb_str_set_len(z->buf, RSTRING_LEN(z->buf) + filled); n = z->stream.avail_out; err = deflateParams(&z->stream, level, strategy); filled = n - z->stream.avail_out; } if (err != Z_OK) { raise_zlib_error(err, z->stream.msg); } rb_str_set_len(z->buf, RSTRING_LEN(z->buf) + filled); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"!Zlib::Deflate#set_dictionary;F;[[I"dic;T0;[[@ii;T;:set_dictionary;0;[;{;IC;"ªcall-seq: set_dictionary(string) Sets the preset dictionary and returns +string+. This method is available just only after Zlib::Deflate.new or Zlib::ZStream#reset method was called. See zlib.h for details. Can raise errors of Z_STREAM_ERROR if a parameter is invalid (such as NULL dictionary) or the stream state is inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the expected one (incorrect adler32 value) ;T;[;[;I" call-seq: set_dictionary(string) Sets the preset dictionary and returns +string+. This method is available just only after Zlib::Deflate.new or Zlib::ZStream#reset method was called. See zlib.h for details. Can raise errors of Z_STREAM_ERROR if a parameter is invalid (such as NULL dictionary) or the stream state is inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the expected one (incorrect adler32 value) ;T;0; @Û;!F;"o;#;$T;%i[;&if;'@k;(I"]static VALUE rb_deflate_set_dictionary(VALUE obj, VALUE dic) { struct zstream *z = get_zstream(obj); VALUE src = dic; int err; StringValue(src); err = deflateSetDictionary(&z->stream, (Bytef*)RSTRING_PTR(src), RSTRING_LENINT(src)); if (err != Z_OK) { raise_zlib_error(err, z->stream.msg); } return dic; };T;)I"static VALUE;T;*T;A@k;BIC;[;A@k;CIC;[;A@k;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@i[@i\;T;:Deflate;;K;;;[;{;IC;"^Zlib::Deflate is the class for compressing data. See Zlib::ZStream for more information.;T;[;[;I"` Zlib::Deflate is the class for compressing data. See Zlib::ZStream for more information. ;T;0; @k;!F;"o;#;$T;%i;&i;6i;'o;L;M0;N0;O0;;P;'@;Q@;R0;I"Zlib::Deflate;F;S@ o; ;IC;[ o;;F; ;F;;;I"Zlib::Inflate.inflate;F;[[I"src;T0;[[@iï;T;:inflate;0;[;{;IC;"Šcall-seq: Zlib.inflate(string) Zlib::Inflate.inflate(string) Decompresses +string+. Raises a Zlib::NeedDict exception if a preset dictionary is needed for decompression. This method is almost equivalent to the following code: def inflate(string) zstream = Zlib::Inflate.new buf = zstream.inflate(string) zstream.finish zstream.close buf end See also Zlib.deflate ;T;[;[;I" call-seq: Zlib.inflate(string) Zlib::Inflate.inflate(string) Decompresses +string+. Raises a Zlib::NeedDict exception if a preset dictionary is needed for decompression. This method is almost equivalent to the following code: def inflate(string) zstream = Zlib::Inflate.new buf = zstream.inflate(string) zstream.finish zstream.close buf end See also Zlib.deflate ;T;0; @;!F;"o;#;$T;%iØ;&iì;'@þ;(I"³static VALUE rb_inflate_s_inflate(VALUE obj, VALUE src) { struct zstream z; VALUE dst, args[2]; int err; StringValue(src); zstream_init_inflate(&z); err = inflateInit(&z.stream); if (err != Z_OK) { raise_zlib_error(err, z.stream.msg); } ZSTREAM_READY(&z); args[0] = (VALUE)&z; args[1] = src; dst = rb_ensure(inflate_run, (VALUE)args, zstream_ensure_end, (VALUE)&z); return dst; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::Inflate#initialize;F;[[@c0;[[@iº;T;;Ð;0;[;{;IC;"ècall-seq: Zlib::Inflate.new(window_bits = Zlib::MAX_WBITS) Creates a new inflate stream for decompression. +window_bits+ sets the size of the history buffer and can have the following values: 0:: Have inflate use the window size from the zlib header of the compressed stream. (8..15):: Overrides the window size of the inflate header in the compressed stream. The window size must be greater than or equal to the window size of the compressed stream. Greater than 15:: Add 32 to window_bits to enable zlib and gzip decoding with automatic header detection, or add 16 to decode only the gzip format (a Zlib::DataError will be raised for a non-gzip stream). (-8..-15):: Enables raw deflate mode which will not generate a check value, and will not look for any check values for comparison at the end of the stream. This is for use with other formats that use the deflate compressed data format such as zip which provide their own check values. == Example open "compressed.file" do |compressed_io| zi = Zlib::Inflate.new(Zlib::MAX_WBITS + 32) begin open "uncompressed.file", "w+" do |uncompressed_io| uncompressed_io << zi.inflate(compressed_io.read) end ensure zi.close end end ;T;[;[;I"ë call-seq: Zlib::Inflate.new(window_bits = Zlib::MAX_WBITS) Creates a new inflate stream for decompression. +window_bits+ sets the size of the history buffer and can have the following values: 0:: Have inflate use the window size from the zlib header of the compressed stream. (8..15):: Overrides the window size of the inflate header in the compressed stream. The window size must be greater than or equal to the window size of the compressed stream. Greater than 15:: Add 32 to window_bits to enable zlib and gzip decoding with automatic header detection, or add 16 to decode only the gzip format (a Zlib::DataError will be raised for a non-gzip stream). (-8..-15):: Enables raw deflate mode which will not generate a check value, and will not look for any check values for comparison at the end of the stream. This is for use with other formats that use the deflate compressed data format such as zip which provide their own check values. == Example open "compressed.file" do |compressed_io| zi = Zlib::Inflate.new(Zlib::MAX_WBITS + 32) begin open "uncompressed.file", "w+" do |uncompressed_io| uncompressed_io << zi.inflate(compressed_io.read) end ensure zi.close end end ;T;0; @;!F;"o;#;$T;%i;&i·;'@þ;(I"’static VALUE rb_inflate_initialize(int argc, VALUE *argv, VALUE obj) { struct zstream *z; VALUE wbits; int err; rb_scan_args(argc, argv, "01", &wbits); TypedData_Get_Struct(obj, struct zstream, &zstream_data_type, z); err = inflateInit2(&z->stream, ARG_WBITS(wbits)); if (err != Z_OK) { raise_zlib_error(err, z->stream.msg); } ZSTREAM_READY(z); return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"!Zlib::Inflate#add_dictionary;F;[[I"dictionary;T0;[[@i;T;:add_dictionary;0;[;{;IC;"call-seq: add_dictionary(string) Provide the inflate stream with a dictionary that may be required in the future. Multiple dictionaries may be provided. The inflate stream will automatically choose the correct user-provided dictionary based on the stream's required dictionary. ;T;[;[;I" call-seq: add_dictionary(string) Provide the inflate stream with a dictionary that may be required in the future. Multiple dictionaries may be provided. The inflate stream will automatically choose the correct user-provided dictionary based on the stream's required dictionary. ;T;0; @;!F;"o;#;$T;%i;&i;'@þ;(I"static VALUE rb_inflate_add_dictionary(VALUE obj, VALUE dictionary) { VALUE dictionaries = rb_ivar_get(obj, id_dictionaries); VALUE checksum = do_checksum(1, &dictionary, adler32); rb_hash_aset(dictionaries, checksum, dictionary); return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::Inflate#inflate;F;[[@c0;[[@iT;T;;â;0;[;{;IC;"Ócall-seq: inflate(deflate_string, buffer: nil) -> String inflate(deflate_string, buffer: nil) { |chunk| ... } -> nil Inputs +deflate_string+ into the inflate stream and returns the output from the stream. Calling this method, both the input and the output buffer of the stream are flushed. If string is +nil+, this method finishes the stream, just like Zlib::ZStream#finish. If a block is given consecutive inflated chunks from the +deflate_string+ are yielded to the block and +nil+ is returned. If a :buffer keyword argument is given and not nil: * The :buffer keyword should be a String, and will used as the output buffer. Using this option can reuse the memory required during inflation. * When not passing a block, the return value will be the same object as the :buffer keyword argument. * When passing a block, the yielded chunks will be the same value as the :buffer keyword argument. Raises a Zlib::NeedDict exception if a preset dictionary is needed to decompress. Set the dictionary by Zlib::Inflate#set_dictionary and then call this method again with an empty string to flush the stream: inflater = Zlib::Inflate.new begin out = inflater.inflate compressed rescue Zlib::NeedDict # ensure the dictionary matches the stream's required dictionary raise unless inflater.adler == Zlib.adler32(dictionary) inflater.set_dictionary dictionary inflater.inflate '' end # ... inflater.close See also Zlib::Inflate.new ;T;[;[;I"Õ call-seq: inflate(deflate_string, buffer: nil) -> String inflate(deflate_string, buffer: nil) { |chunk| ... } -> nil Inputs +deflate_string+ into the inflate stream and returns the output from the stream. Calling this method, both the input and the output buffer of the stream are flushed. If string is +nil+, this method finishes the stream, just like Zlib::ZStream#finish. If a block is given consecutive inflated chunks from the +deflate_string+ are yielded to the block and +nil+ is returned. If a :buffer keyword argument is given and not nil: * The :buffer keyword should be a String, and will used as the output buffer. Using this option can reuse the memory required during inflation. * When not passing a block, the return value will be the same object as the :buffer keyword argument. * When passing a block, the yielded chunks will be the same value as the :buffer keyword argument. Raises a Zlib::NeedDict exception if a preset dictionary is needed to decompress. Set the dictionary by Zlib::Inflate#set_dictionary and then call this method again with an empty string to flush the stream: inflater = Zlib::Inflate.new begin out = inflater.inflate compressed rescue Zlib::NeedDict # ensure the dictionary matches the stream's required dictionary raise unless inflater.adler == Zlib.adler32(dictionary) inflater.set_dictionary dictionary inflater.inflate '' end # ... inflater.close See also Zlib::Inflate.new ;T;0; @/;!F;"o;#;$T;%i&;&iQ;'@þ;(I"ästatic VALUE rb_inflate_inflate(int argc, VALUE* argv, VALUE obj) { struct zstream *z = get_zstream(obj); VALUE dst, src, opts, buffer = Qnil; if (OPTHASH_GIVEN_P(opts)) { VALUE buf; rb_get_kwargs(opts, &id_buffer, 0, 1, &buf); if (buf != Qundef && buf != Qnil) { buffer = StringValue(buf); } } if (buffer != Qnil) { if (!(ZSTREAM_REUSE_BUFFER_P(z) && z->buf == buffer)) { long len = RSTRING_LEN(buffer); if (len >= ZSTREAM_AVAIL_OUT_STEP_MAX) { rb_str_modify(buffer); } else { len = ZSTREAM_AVAIL_OUT_STEP_MAX - len; rb_str_modify_expand(buffer, len); } rb_str_set_len(buffer, 0); z->flags |= ZSTREAM_REUSE_BUFFER; z->buf = buffer; } } else if (ZSTREAM_REUSE_BUFFER_P(z)) { z->flags &= ~ZSTREAM_REUSE_BUFFER; z->buf = Qnil; } rb_scan_args(argc, argv, "10", &src); if (ZSTREAM_IS_FINISHED(z)) { if (NIL_P(src)) { dst = zstream_detach_buffer(z); } else { StringValue(src); zstream_append_buffer2(z, src); if (ZSTREAM_REUSE_BUFFER_P(z)) { dst = rb_str_resize(buffer, 0); } else { dst = rb_str_new(0, 0); } } } else { do_inflate(z, src); dst = zstream_detach_buffer(z); if (ZSTREAM_IS_FINISHED(z)) { zstream_passthrough_input(z); } } return dst; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::Inflate#<<;F;[[I"src;T0;[[@i•;T;;Ý;0;[;{;IC;"°Inputs +string+ into the inflate stream just like Zlib::Inflate#inflate, but returns the Zlib::Inflate object itself. The output from the stream is preserved in output buffer. ;T;[o;= ;3I" overload;F;40;;Ý;50;)I"<< string;T;IC;";T; @>;>0;!F;[;[;I";T;0;6i;[[I"string;T0; @>;[;I"ÆInputs +string+ into the inflate stream just like Zlib::Inflate#inflate, but returns the Zlib::Inflate object itself. The output from the stream is preserved in output buffer. @overload << string;T;0; @>;!F;"o;#;$T;%iŽ;&i“;'@þ;(I"Zstatic VALUE rb_inflate_addstr(VALUE obj, VALUE src) { struct zstream *z = get_zstream(obj); if (ZSTREAM_IS_FINISHED(z)) { if (!NIL_P(src)) { StringValue(src); zstream_append_buffer2(z, src); } } else { do_inflate(z, src); if (ZSTREAM_IS_FINISHED(z)) { zstream_passthrough_input(z); } } return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::Inflate#sync;F;[[I"src;T0;[[@i²;T;: sync;0;[;{;IC;"Inputs +string+ into the end of input buffer and skips data until a full flush point can be found. If the point is found in the buffer, this method flushes the buffer and returns false. Otherwise it returns +true+ and the following data of full flush point is preserved in the buffer. ;T;[o;= ;3I" overload;F;40;;ä;50;)I"sync(string);T;IC;";T; @X;>0;!F;[;[;I";T;0;6i;[[I"string;T0; @X;[;I"7Inputs +string+ into the end of input buffer and skips data until a full flush point can be found. If the point is found in the buffer, this method flushes the buffer and returns false. Otherwise it returns +true+ and the following data of full flush point is preserved in the buffer. @overload sync(string);T;0; @X;!F;"o;#;$T;%iª;&i°;'@þ;(I"¿static VALUE rb_inflate_sync(VALUE obj, VALUE src) { struct zstream *z = get_zstream(obj); StringValue(src); return zstream_sync(z, (Bytef*)RSTRING_PTR(src), RSTRING_LEN(src)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::Inflate#sync_point?;F;[;[[@iÂ;T;:sync_point?;0;[;{;IC;"OQuoted verbatim from original documentation: What is this? :);T;[o;2 ;3I"return;F;4@|;0;5[@~; @r;[;I"PQuoted verbatim from original documentation: What is this? :) ;T;0; @r;!F;"o;#;$T;%i»;&iÀ;6i;'@þ;(I"static VALUE rb_inflate_sync_point_p(VALUE obj) { struct zstream *z = get_zstream(obj); int err; err = inflateSyncPoint(&z->stream); if (err == 1) { return Qtrue; } if (err != Z_OK) { raise_zlib_error(err, z->stream.msg); } return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"!Zlib::Inflate#set_dictionary;F;[[I"dic;T0;[[@iÙ;T;;à;0;[;{;IC;"šSets the preset dictionary and returns +string+. This method is available just only after a Zlib::NeedDict exception was raised. See zlib.h for details. ;T;[;[;I" Sets the preset dictionary and returns +string+. This method is available just only after a Zlib::NeedDict exception was raised. See zlib.h for details. ;T;0; @ƒ;!F;"o;#;$T;%iÒ;&iÖ;'@þ;(I"]static VALUE rb_inflate_set_dictionary(VALUE obj, VALUE dic) { struct zstream *z = get_zstream(obj); VALUE src = dic; int err; StringValue(src); err = inflateSetDictionary(&z->stream, (Bytef*)RSTRING_PTR(src), RSTRING_LENINT(src)); if (err != Z_OK) { raise_zlib_error(err, z->stream.msg); } return dic; };T;)I"static VALUE;T;*T;A@þ;BIC;[;A@þ;CIC;[;A@þ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@i}[@ih;T;:Inflate;;K;;;[;{;IC;"›Zlib:Inflate is the class for decompressing compressed data. Unlike Zlib::Deflate, an instance of this class is not able to duplicate (clone, dup) itself.;T;[;[;I" Zlib:Inflate is the class for decompressing compressed data. Unlike Zlib::Deflate, an instance of this class is not able to duplicate (clone, dup) itself. ;T;0; @þ;!F;"o;#;$T;%i};&i;6i;'o;L;M0;N0;O0;;P;'@;Q@;R0;I"Zlib::Inflate;F;S@ o; ;IC;[o; ;IC;[o;;F; ;;;;I" Zlib::GzipFile::Error#input;F;[;[[@iÒ;F;: input;;K;[;{;IC;"input gzipped string ;T;[;[;I"input gzipped string;T;0; @ª;!F;"o;#;$T;%iÑ;&iÑ;'@¨;*To;;F; ;;;;I""Zlib::GzipFile::Error#inspect;F;[;[[@i; ;T;;r;0;[;{;IC;".Constructs a String of the GzipFile Error ;T;[;[;I"0 Constructs a String of the GzipFile Error ;T;0; @¶;!F;"o;#;$T;%i6 ;&i8 ;'@¨;(I"Cstatic VALUE gzfile_error_inspect(VALUE error) { VALUE str = rb_call_super(0, 0); VALUE input = rb_attr_get(error, id_input); if (!NIL_P(input)) { rb_str_resize(str, RSTRING_LEN(str)-1); rb_str_cat2(str, ", input="); rb_str_append(str, rb_str_inspect(input)); rb_str_cat2(str, ">"); } return str; };T;)I"static VALUE;T;*T;A@¨;BIC;[;A@¨;CIC;[;A@¨;DIC;E{;FIC;E{;GT;IC;E{;çIC;E{: read@ª: write0;GT;GT;GT;H{;I[;[[@i®[@iÏ;T;: Error;;K;;;[;{;IC;"@Base class of errors that occur when processing GZIP files. ;T;[;[;I"B Base class of errors that occur when processing GZIP files. ;T;0; @¨;!F;"o;#;$T;%i®;&i°;'@¦;I"Zlib::GzipFile::Error;F;So; ;IC;[;A@×;BIC;[;A@×;CIC;[;A@×;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@iE[@i;T;;ê;;K;;;[;{;IC;"hThe superclass for all exceptions raised by Ruby/zlib. The following exceptions are defined as subclasses of Zlib::Error. These exceptions are raised when zlib library functions return with an error status. - Zlib::StreamEnd - Zlib::NeedDict - Zlib::DataError - Zlib::StreamError - Zlib::MemError - Zlib::BufError - Zlib::VersionError - Zlib::InProgressError ;T;[;[;I"k The superclass for all exceptions raised by Ruby/zlib. The following exceptions are defined as subclasses of Zlib::Error. These exceptions are raised when zlib library functions return with an error status. - Zlib::StreamEnd - Zlib::NeedDict - Zlib::DataError - Zlib::StreamError - Zlib::MemError - Zlib::BufError - Zlib::VersionError - Zlib::InProgressError ;T;0; @×;!F;"o;#;$T;%iE;&iU;'@;I"Zlib::Error;F;So;L;M0;N0;O0;:StandardError;'@;Qo; ;IC;[;A@ì;BIC;[;A@ì;CIC;[;A@ì;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[I"error.c;Ti [@÷iì ;T;;ë;;K;;;[;{;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;%i ;&i( ;'@;I"StandardError;F;So; ;IC;[o;;F; ;F;;;I"Exception.exception;F;[[@c0;[[@Ìi[;T;:exception;0;[;{;IC;"DAllocates and initializes an instance of \a klass. Equivalent to \c Class\#new in Ruby \param[in] argc the number of arguments to \c #initialize \param[in] argv a pointer to an array of arguments to \c #initialize \param[in] klass a Class object \return the new instance of \a klass \sa rb_obj_call_init \sa rb_obj_alloc ;T;[;[;I"EAllocates and initializes an instance of \a klass. Equivalent to \c Class\#new in Ruby \param[in] argc the number of arguments to \c #initialize \param[in] argv a pointer to an array of arguments to \c #initialize \param[in] klass a Class object \return the new instance of \a klass \sa rb_obj_call_init \sa rb_obj_alloc ;T;0; @;!F;"o;#;$T;%iO;&iY;'@;(I"åVALUE rb_class_new_instance(int argc, const VALUE *argv, VALUE klass) { VALUE obj; Check_Type(klass, T_CLASS); obj = rb_class_alloc(klass); rb_obj_call_init_kw(obj, argc, argv, RB_NO_KEYWORDS); return obj; };T;)I" VALUE;T;*To;;F; ;F;;;I"Exception.to_tty?;F;[;[[@÷i±;T;:to_tty?;0;[;{;IC;"@Returns +true+ if exception messages will be sent to a tty.;T;[o;= ;3I" overload;F;40;;í;50;)I"to_tty?;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @;[;I"@return [Boolean];T;0;6i;[; @;[;I"hReturns +true+ if exception messages will be sent to a tty. @overload to_tty? @return [Boolean];T;0; @;!F;"o;#;$T;%i«;&i¯;6i;'@;(I"_static VALUE exc_s_to_tty_p(VALUE self) { return rb_stderr_tty_p() ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Exception#exception;F;[[@c0;[[@÷i;T;;ì;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; @-;!F;"o;#;$T;%it;&i};'@;(I"!static VALUE exc_exception(int argc, VALUE *argv, VALUE self) { VALUE exc; argc = rb_check_arity(argc, 0, 1); if (argc == 0) return self; if (argc == 1 && self == argv[0]) return self; exc = rb_obj_clone(self); rb_ivar_set(exc, id_mesg, argv[0]); return exc; };T;)I"static VALUE;T;*To;;F; ;;;;I"Exception#initialize;F;[[@c0;[[@÷ik;T;;Ð;0;[;{;IC;"HConstruct a new Exception object, optionally passing in a message. ;T;[o;= ;3I" overload;F;40;:new;50;)I"new(msg = nil);T;IC;";T; @<;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Exception;T; @<;[;I"@return [Exception];T;0;6i;[[I"msg;TI"nil;T; @<o;= ;3I" overload;F;40;;ì;50;)I"exception(msg = nil);T;IC;";T; @<;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Exception;T; @<;[;I"@return [Exception];T;0;6i;[[I"msg;TI"nil;T; @<;[;I"ª Construct a new Exception object, optionally passing in a message. @overload new(msg = nil) @return [Exception] @overload exception(msg = nil) @return [Exception];T;0; @<;!F;"o;#;$T;%ib;ⅈ'@;(I"ªstatic VALUE exc_initialize(int argc, VALUE *argv, VALUE exc) { VALUE arg; arg = (!rb_check_arity(argc, 0, 1) ? Qnil : argv[0]); return exc_init(exc, arg); };T;)I"static VALUE;T;*To;;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;= ;3I" overload;F;40;;`;50;)I"==(obj);T;IC;";T; @k;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @k;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @k;[;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; @k;!F;"o;#;$T;%iÀ;&iÆ;'@;(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 state; obj = rb_protect(try_convert_to_exception, obj, &state); if (state || 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;)I"static VALUE;T;*To;;F; ;;;;I"Exception#to_s;F;[;[[@÷i–;T;;q;0;[;{;IC;"UReturns exception's message (or the name of the exception if no message is set). ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @Š;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Š;[;I"@return [String];T;0;6i;[; @Š;[;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 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;)I"static VALUE;T;*To;;F; ;;;;I"Exception#message;F;[;[[@÷iþ;T;:message;0;[;{;IC;"wReturns the result of invoking exception.to_s. Normally this returns the exception's message or name. ;T;[o;= ;3I" overload;F;40;;ï;50;)I"message;T;IC;";T; @¥;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @¥;[;I"@return [String];T;0;6i;[; @¥;[;I"™Returns the result of invoking exception.to_s. Normally this returns the exception's message or name. @overload message @return [String];T;0; @¥;!F;"o;#;$T;%iö;&iû;'@;(I"Wstatic VALUE exc_message(VALUE exc) { return rb_funcallv(exc, idTo_s, 0, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"Exception#full_message;F;[[@c0;[[@÷iÉ;T;:full_message;0;[;{;IC;"çReturns formatted string of _exception_. The returned string is formatted using the same format that Ruby uses when printing an uncaught exceptions to stderr. If _highlight_ is +true+ the default error handler will send the messages to a tty. _order_ must be either of +:top+ or +:bottom+, and places the error message and the innermost backtrace come at the top or the bottom. The default values of these options depend on $stderr and its +tty?+ at the timing of a call. ;T;[o;= ;3I" overload;F;40;;ð;50;)I"0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @À;[;I"@return [String];T;0;6i;[[I"highlight:;TI" bool;T[I"order:;TI" [:top;T; @À;[;I">Returns formatted string of _exception_. The returned string is formatted using the same format that Ruby uses when printing an uncaught exceptions to stderr. If _highlight_ is +true+ the default error handler will send the messages to a tty. _order_ must be either of +:top+ or +:bottom+, and places the error message and the innermost backtrace come at the top or the bottom. The default values of these options depend on $stderr and its +tty?+ at the timing of a call. @overload full_message(highlight: bool, order: [:top or :bottom]) @return [String];T;0; @À;!F;"o;#;$T;%i·;&iÆ;'@;(I"Ústatic VALUE exc_full_message(int argc, VALUE *argv, VALUE exc) { VALUE opt, str, emesg, errat; enum {kw_highlight, kw_order, kw_max_}; static ID kw[kw_max_]; VALUE args[kw_max_] = {Qnil, Qnil}; rb_scan_args(argc, argv, "0:", &opt); if (!NIL_P(opt)) { if (!kw[0]) { #define INIT_KW(n) kw[kw_##n] = rb_intern_const(#n) INIT_KW(highlight); INIT_KW(order); #undef INIT_KW } rb_get_kwargs(opt, kw, 0, kw_max_, args); switch (args[kw_highlight]) { default: rb_raise(rb_eArgError, "expected true or false as " "highlight: %+"PRIsVALUE, args[kw_highlight]); case Qundef: args[kw_highlight] = Qnil; break; case Qtrue: case Qfalse: case Qnil: break; } if (args[kw_order] == Qundef) { args[kw_order] = Qnil; } else { ID id = rb_check_id(&args[kw_order]); if (id == id_bottom) args[kw_order] = Qtrue; else if (id == id_top) args[kw_order] = Qfalse; else { rb_raise(rb_eArgError, "expected :top or :bottom as " "order: %+"PRIsVALUE, args[kw_order]); } } } str = rb_str_new2(""); errat = rb_get_backtrace(exc); emesg = rb_get_message(exc); rb_error_write(exc, emesg, errat, str, args[kw_highlight], args[kw_order]); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"Exception#inspect;F;[;[[@÷i;T;;r;0;[;{;IC;"4Return this exception's class name and message. ;T;[o;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @â;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @â;[;I"@return [String];T;0;6i;[; @â;[;I"[Return this exception's class name and message. @overload inspect @return [String];T;0; @â;!F;"o;#;$T;%i;&i;'@;(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_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;)I"static VALUE;T;*To;;F; ;;;;I"Exception#backtrace;F;[;[[@÷iC;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 In the case no backtrace has been set, +nil+ is returned ex = StandardError.new ex.backtrace #=> nil ;T;[o;= ;3I" overload;F;40;;ñ;50;)I"backtrace;T;IC;";T; @ý;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;TI"nil;T; @ý;[;I"@return [Array, nil];T;0;6i;[; @ý;[;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 In the case no backtrace has been set, +nil+ is returned ex = StandardError.new ex.backtrace #=> nil @overload backtrace @return [Array, nil];T;0; @ý;!F;"o;#;$T;%i ;&i@;'@;(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;)I"static VALUE;T;*To;;F; ;;;;I""Exception#backtrace_locations;F;[;[[@÷is;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. This method is not affected by Exception#set_backtrace(). ;T;[o;= ;3I" overload;F;40;;ò;50;)I"backtrace_locations;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;TI"nil;T; @;[;I"@return [Array, nil];T;0;6i;[; @;[;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. This method is not affected by Exception#set_backtrace(). @overload backtrace_locations @return [Array, nil];T;0; @;!F;"o;#;$T;%ii;&iq;'@;(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;)I"static VALUE;T;*To;;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;= ;3I" overload;F;40;;ó;50;)I"set_backtrace(backtrace);T;IC;";T; @5;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @5;[;I"@return [Array];T;0;6i;[[I"backtrace;T0; @5;[;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; @5;!F;"o;#;$T;%i•;&iœ;'@;(I"xstatic VALUE exc_set_backtrace(VALUE exc, VALUE bt) { return rb_ivar_set(exc, id_bt, rb_check_backtrace(bt)); };T;)I"static VALUE;T;*To;;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;= ;3I" overload;F;40;;ô;50;)I" cause;T;IC;";T; @T;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Exception;TI"nil;T; @T;[;I"@return [Exception, nil];T;0;6i;[; @T;[;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; @T;!F;"o;#;$T;%i«;&i±;'@;(I"Qstatic VALUE exc_cause(VALUE exc) { return rb_attr_get(exc, id_cause); };T;)I"static VALUE;T;*T;A@;BIC;[;A@;CIC;[;A@;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷iB [@÷iÒ ;T;:Exception;;K;;;[;{;IC;"Õ\Class Exception and its subclasses are used to communicate between Kernel#raise and +rescue+ statements in begin ... end blocks. An Exception object carries information about an exception: - Its type (the exception's class). - An optional descriptive message. - Optional backtrace information. Some built-in subclasses of Exception have additional methods: e.g., NameError#name. == Defaults Two Ruby statements have default exception classes: - +raise+: defaults to RuntimeError. - +rescue+: defaults to StandardError. == Global Variables When an exception has been raised but not yet handled (in +rescue+, +ensure+, +at_exit+ and +END+ blocks), two global variables are set: - $! contains the current exception. - $@ contains its backtrace. == Custom Exceptions To provide additional or alternate information, a program may create custom exception classes that derive from the built-in exception classes. A good practice is for a library to create a single "generic" exception class (typically a subclass of StandardError or RuntimeError) and have its other exception classes derive from that class. This allows the user to rescue the generic exception, thus catching all exceptions the library may raise even if future versions of the library add new exception subclasses. For example: class MyLibrary class Error < ::StandardError end class WidgetError < Error end class FrobError < Error end end To handle both MyLibrary::WidgetError and MyLibrary::FrobError the library user can rescue MyLibrary::Error. == Built-In Exception Classes The built-in subclasses of Exception are: * NoMemoryError * ScriptError * LoadError * NotImplementedError * SyntaxError * SecurityError * SignalException * Interrupt * StandardError * ArgumentError * UncaughtThrowError * EncodingError * FiberError * IOError * EOFError * IndexError * KeyError * StopIteration * ClosedQueueError * LocalJumpError * NameError * NoMethodError * RangeError * FloatDomainError * RegexpError * RuntimeError * FrozenError * SystemCallError * Errno::* * ThreadError * TypeError * ZeroDivisionError * SystemExit * SystemStackError * fatal;T;[;[;I"× \Class Exception and its subclasses are used to communicate between Kernel#raise and +rescue+ statements in begin ... end blocks. An Exception object carries information about an exception: - Its type (the exception's class). - An optional descriptive message. - Optional backtrace information. Some built-in subclasses of Exception have additional methods: e.g., NameError#name. == Defaults Two Ruby statements have default exception classes: - +raise+: defaults to RuntimeError. - +rescue+: defaults to StandardError. == Global Variables When an exception has been raised but not yet handled (in +rescue+, +ensure+, +at_exit+ and +END+ blocks), two global variables are set: - $! contains the current exception. - $@ contains its backtrace. == Custom Exceptions To provide additional or alternate information, a program may create custom exception classes that derive from the built-in exception classes. A good practice is for a library to create a single "generic" exception class (typically a subclass of StandardError or RuntimeError) and have its other exception classes derive from that class. This allows the user to rescue the generic exception, thus catching all exceptions the library may raise even if future versions of the library add new exception subclasses. For example: class MyLibrary class Error < ::StandardError end class WidgetError < Error end class FrobError < Error end end To handle both MyLibrary::WidgetError and MyLibrary::FrobError the library user can rescue MyLibrary::Error. == Built-In Exception Classes The built-in subclasses of Exception are: * NoMemoryError * ScriptError * LoadError * NotImplementedError * SyntaxError * SecurityError * SignalException * Interrupt * StandardError * ArgumentError * UncaughtThrowError * EncodingError * FiberError * IOError * EOFError * IndexError * KeyError * StopIteration * ClosedQueueError * LocalJumpError * NameError * NoMethodError * RangeError * FloatDomainError * RegexpError * RuntimeError * FrozenError * SystemCallError * Errno::* * ThreadError * TypeError * ZeroDivisionError * SystemExit * SystemStackError * fatal ;T;0; @;!F;"o;#;$T;%iB ;&iŸ ;6i;'@;I"Exception;F;S@];R;Fo; ;IC;[;A@‚;BIC;[;A@‚;CIC;[;A@‚;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@i´[@iÕ;T;: NoFooter;;K;;;[;{;IC;"/Raised when gzip file footer is not found. ;T;[;[;I"1 Raised when gzip file footer is not found. ;T;0; @‚;!F;"o;#;$T;%i´;&i¶;'@¦;I"Zlib::GzipFile::NoFooter;F;S@¨o; ;IC;[;A@–;BIC;[;A@–;CIC;[;A@–;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@iº[@iÖ;T;: CRCError;;K;;;[;{;IC;"€Raised when the CRC checksum recorded in gzip file footer is not equivalent to the CRC checksum of the actual uncompressed data. ;T;[;[;I"‚ Raised when the CRC checksum recorded in gzip file footer is not equivalent to the CRC checksum of the actual uncompressed data. ;T;0; @–;!F;"o;#;$T;%iº;&i½;'@¦;I"Zlib::GzipFile::CRCError;F;S@¨o; ;IC;[;A@ª;BIC;[;A@ª;CIC;[;A@ª;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@iÁ[@i×;T;:LengthError;;K;;;[;{;IC;"}Raised when the data length recorded in the gzip file footer is not equivalent to the length of the actual uncompressed data. ;T;[;[;I" Raised when the data length recorded in the gzip file footer is not equivalent to the length of the actual uncompressed data. ;T;0; @ª;!F;"o;#;$T;%iÁ;&iÄ;'@¦;I" Zlib::GzipFile::LengthError;F;S@¨o;;F; ;F;;;I"Zlib::GzipFile.wrap;F;[[@c0;[[@i‹;T;: wrap;0;[;{;IC;"Écall-seq: Zlib::GzipReader.wrap(io, ...) { |gz| ... } Zlib::GzipWriter.wrap(io, ...) { |gz| ... } Creates a GzipReader or GzipWriter associated with +io+, passing in any necessary extra options, and executes the block with the newly created object just like File.open. The GzipFile object will be closed automatically after executing the block. If you want to keep the associated IO object open, you may call Zlib::GzipFile#finish method in the block. ;T;[;[;I"Ë call-seq: Zlib::GzipReader.wrap(io, ...) { |gz| ... } Zlib::GzipWriter.wrap(io, ...) { |gz| ... } Creates a GzipReader or GzipWriter associated with +io+, passing in any necessary extra options, and executes the block with the newly created object just like File.open. The GzipFile object will be closed automatically after executing the block. If you want to keep the associated IO object open, you may call Zlib::GzipFile#finish method in the block. ;T;0; @¾;!F;"o;#;$T;%i|;&iˆ;'@¦;(I"xstatic VALUE rb_gzfile_s_wrap(int argc, VALUE *argv, VALUE klass) { return gzfile_wrap(argc, argv, klass, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipFile#to_io;F;[;[[@i§;T;: to_io;0;[;{;IC;"Same as IO. ;T;[;[;I" Same as IO. ;T;0; @Í;!F;"o;#;$T;%i¢;&i¤;'@¦;(I"Pstatic VALUE rb_gzfile_to_io(VALUE obj) { return get_gzfile(obj)->io; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipFile#crc;F;[;[[@i²;T;:crc;0;[;{;IC;"0Returns CRC value of the uncompressed data. ;T;[;[;I"2 Returns CRC value of the uncompressed data. ;T;0; @Û;!F;"o;#;$T;%i;&i¯;'@¦;(I"]static VALUE rb_gzfile_crc(VALUE obj) { return rb_uint2inum(get_gzfile(obj)->crc); };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipFile#mtime;F;[;[[@i½;T;: mtime;0;[;{;IC;"EReturns last modification time recorded in the gzip file header. ;T;[;[;I"G Returns last modification time recorded in the gzip file header. ;T;0; @é;!F;"o;#;$T;%i¸;&iº;'@¦;(I"kstatic VALUE rb_gzfile_mtime(VALUE obj) { return rb_time_new(get_gzfile(obj)->mtime, (time_t)0); };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipFile#level;F;[;[[@iÈ;T;: level;0;[;{;IC;"Returns compression level. ;T;[;[;I"! Returns compression level. ;T;0; @÷;!F;"o;#;$T;%iÃ;&iÅ;'@¦;(I"\static VALUE rb_gzfile_level(VALUE obj) { return INT2FIX(get_gzfile(obj)->level); };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipFile#os_code;F;[;[[@iÓ;T;:os_code;0;[;{;IC;"=Returns OS code number recorded in the gzip file header. ;T;[;[;I"? Returns OS code number recorded in the gzip file header. ;T;0; @;!F;"o;#;$T;%iÎ;&iÐ;'@¦;(I"`static VALUE rb_gzfile_os_code(VALUE obj) { return INT2FIX(get_gzfile(obj)->os_code); };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipFile#orig_name;F;[;[[@iß;T;:orig_name;0;[;{;IC;"nReturns original filename recorded in the gzip file header, or +nil+ if original filename is not present. ;T;[;[;I"p Returns original filename recorded in the gzip file header, or +nil+ if original filename is not present. ;T;0; @;!F;"o;#;$T;%iÙ;&iÜ;'@¦;(I" static VALUE rb_gzfile_orig_name(VALUE obj) { VALUE str = get_gzfile(obj)->orig_name; if (!NIL_P(str)) { str = rb_str_dup(str); } return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipFile#comment;F;[;[[@iï;T;:comment;0;[;{;IC;"^Returns comments recorded in the gzip file header, or nil if the comments is not present. ;T;[;[;I"` Returns comments recorded in the gzip file header, or nil if the comments is not present. ;T;0; @!;!F;"o;#;$T;%ié;&iì;'@¦;(I"œstatic VALUE rb_gzfile_comment(VALUE obj) { VALUE str = get_gzfile(obj)->comment; if (!NIL_P(str)) { str = rb_str_dup(str); } return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipFile#close;F;[;[[@ik ;T;;:;0;[;{;IC;"~Closes the GzipFile object. This method calls close method of the associated IO object. Returns the associated IO object. ;T;[;[;I"{ Closes the GzipFile object. This method calls close method of the associated IO object. Returns the associated IO object. ;T;0; @/;!F;"o;#;$T;%ie ;&ih ;'@¦;(I"static VALUE rb_gzfile_close(VALUE obj) { struct gzfile *gz; VALUE io; TypedData_Get_Struct(obj, struct gzfile, &gzfile_data_type, gz); if (!ZSTREAM_IS_READY(&gz->z)) { return Qnil; } io = gz->io; gzfile_close(gz, 1); return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipFile#finish;F;[;[[@i ;T;;<;0;[;{;IC;" Closes the GzipFile object. Unlike Zlib::GzipFile#close, this method never calls the close method of the associated IO object. Returns the associated IO object. ;T;[;[;I"¢ Closes the GzipFile object. Unlike Zlib::GzipFile#close, this method never calls the close method of the associated IO object. Returns the associated IO object. ;T;0; @=;!F;"o;#;$T;%iz ;&i~ ;'@¦;(I"static VALUE rb_gzfile_finish(VALUE obj) { struct gzfile *gz = get_gzfile(obj); VALUE io; io = gz->io; gzfile_close(gz, 0); return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipFile#closed?;F;[;[[@i’ ;T;;8;0;[;{;IC;"Same as IO#closed?;T;[o;2 ;3I"return;F;4@|;0;5[@~; @K;[;I" Same as IO#closed? ;T;0; @K;!F;"o;#;$T;%iŒ ;&i ;6i;'@¦;(I"µstatic VALUE rb_gzfile_closed_p(VALUE obj) { struct gzfile *gz; TypedData_Get_Struct(obj, struct gzfile, &gzfile_data_type, gz); return NIL_P(gz->io) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipFile#sync;F;[;[[@i¬ ;T;;ä;0;[;{;IC;"Same as IO#sync ;T;[;[;I" Same as IO#sync ;T;0; @\;!F;"o;#;$T;%i¦ ;&i© ;'@¦;(I"zstatic VALUE rb_gzfile_sync(VALUE obj) { return (get_gzfile(obj)->z.flags & GZFILE_FLAG_SYNC) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipFile#sync=;F;[[I" mode;T0;[[@i» ;T;: sync=;0;[;{;IC;"ºcall-seq: sync = flag Same as IO. If flag is +true+, the associated IO object must respond to the +flush+ method. While +sync+ mode is +true+, the compression ratio decreases sharply. ;T;[;[;I"¼ call-seq: sync = flag Same as IO. If flag is +true+, the associated IO object must respond to the +flush+ method. While +sync+ mode is +true+, the compression ratio decreases sharply. ;T;0; @j;!F;"o;#;$T;%i² ;&i¸ ;'@¦;(I"èstatic VALUE rb_gzfile_set_sync(VALUE obj, VALUE mode) { struct gzfile *gz = get_gzfile(obj); if (RTEST(mode)) { gz->z.flags |= GZFILE_FLAG_SYNC; } else { gz->z.flags &= ~GZFILE_FLAG_SYNC; } return mode; };T;)I"static VALUE;T;*T;A@¦;BIC;[;A@¦;CIC;[;A@¦;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@i [@iÎ;T;: GzipFile;;K;;;[;{;IC;"AZlib::GzipFile is an abstract class for handling a gzip formatted compressed file. The operations are defined in the subclasses, Zlib::GzipReader for reading, and Zlib::GzipWriter for writing. GzipReader should be used by associating an IO, or IO-like, object. == Method Catalogue - ::wrap - ::open (Zlib::GzipReader::open and Zlib::GzipWriter::open) - #close - #closed? - #comment - comment= (Zlib::GzipWriter#comment=) - #crc - eof? (Zlib::GzipReader#eof?) - #finish - #level - lineno (Zlib::GzipReader#lineno) - lineno= (Zlib::GzipReader#lineno=) - #mtime - mtime= (Zlib::GzipWriter#mtime=) - #orig_name - orig_name (Zlib::GzipWriter#orig_name=) - #os_code - path (when the underlying IO supports #path) - #sync - #sync= - #to_io (due to internal structure, documentation may appear under Zlib::GzipReader or Zlib::GzipWriter);T;[;[;I"C Zlib::GzipFile is an abstract class for handling a gzip formatted compressed file. The operations are defined in the subclasses, Zlib::GzipReader for reading, and Zlib::GzipWriter for writing. GzipReader should be used by associating an IO, or IO-like, object. == Method Catalogue - ::wrap - ::open (Zlib::GzipReader::open and Zlib::GzipWriter::open) - #close - #closed? - #comment - comment= (Zlib::GzipWriter#comment=) - #crc - eof? (Zlib::GzipReader#eof?) - #finish - #level - lineno (Zlib::GzipReader#lineno) - lineno= (Zlib::GzipReader#lineno=) - #mtime - mtime= (Zlib::GzipWriter#mtime=) - #orig_name - orig_name (Zlib::GzipWriter#orig_name=) - #os_code - path (when the underlying IO supports #path) - #sync - #sync= - #to_io (due to internal structure, documentation may appear under Zlib::GzipReader or Zlib::GzipWriter) ;T;0; @¦;!F;"o;#;$T;%i ;&iA;6i;'o;L;M0;N0;O0;;P;'@;Q@;R0;I"Zlib::GzipFile;F;So;L;M0;N0;O0;;T;'@;Q@];R;Fo; ;IC;[o;;F; ;;;;I"Zlib::GzipWriter#mtime=;F;[[I" mtime;T0;[[@i$ ;T;:mtime=;0;[;{;IC;"}Specify the modification time (+mtime+) in the gzip header. Using an Integer. Setting the mtime in the gzip header does not effect the mtime of the file generated. Different utilities that expand the gzipped files may use the mtime header. For example the gunzip utility can use the `-N` flag which will set the resultant file's mtime to the value in the header. By default many tools will set the mtime of the expanded file to the mtime of the gzipped file, not the mtime in the header. If you do not set an mtime, the default value will be the time when compression started. Setting a value of 0 indicates no time stamp is available. ;T;[;[;I" Specify the modification time (+mtime+) in the gzip header. Using an Integer. Setting the mtime in the gzip header does not effect the mtime of the file generated. Different utilities that expand the gzipped files may use the mtime header. For example the gunzip utility can use the `-N` flag which will set the resultant file's mtime to the value in the header. By default many tools will set the mtime of the expanded file to the mtime of the gzipped file, not the mtime in the header. If you do not set an mtime, the default value will be the time when compression started. Setting a value of 0 indicates no time stamp is available. ;T;0; @;!F;"o;#;$T;%i ;&i! ;'@Ž;(I"_static VALUE rb_gzfile_set_mtime(VALUE obj, VALUE mtime) { struct gzfile *gz = get_gzfile(obj); VALUE val; if (gz->z.flags & GZFILE_FLAG_HEADER_FINISHED) { rb_raise(cGzError, "header is already written"); } val = rb_Integer(mtime); gz->mtime = NUM2UINT(val); gz->z.flags |= GZFILE_FLAG_MTIME_IS_SET; return mtime; };T;)I"static VALUE;T;*To;;F; ;;;;I" Zlib::GzipWriter#orig_name=;F;[[I"str;T0;[[@i: ;T;:orig_name=;0;[;{;IC;":Specify the original name (+str+) in the gzip header. ;T;[;[;I"< Specify the original name (+str+) in the gzip header. ;T;0; @ ;!F;"o;#;$T;%i5 ;&i7 ;'@Ž;(I"®static VALUE rb_gzfile_set_orig_name(VALUE obj, VALUE str) { struct gzfile *gz = get_gzfile(obj); VALUE s; char *p; if (gz->z.flags & GZFILE_FLAG_HEADER_FINISHED) { rb_raise(cGzError, "header is already written"); } s = rb_str_dup(rb_str_to_str(str)); p = memchr(RSTRING_PTR(s), '\0', RSTRING_LEN(s)); if (p) { rb_str_resize(s, p - RSTRING_PTR(s)); } gz->orig_name = s; return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipWriter#comment=;F;[[I"str;T0;[[@iR ;T;: comment=;0;[;{;IC;"4Specify the comment (+str+) in the gzip header. ;T;[;[;I"6 Specify the comment (+str+) in the gzip header. ;T;0; @°;!F;"o;#;$T;%iM ;&iO ;'@Ž;(I"ªstatic VALUE rb_gzfile_set_comment(VALUE obj, VALUE str) { struct gzfile *gz = get_gzfile(obj); VALUE s; char *p; if (gz->z.flags & GZFILE_FLAG_HEADER_FINISHED) { rb_raise(cGzError, "header is already written"); } s = rb_str_dup(rb_str_to_str(str)); p = memchr(RSTRING_PTR(s), '\0', RSTRING_LEN(s)); if (p) { rb_str_resize(s, p - RSTRING_PTR(s)); } gz->comment = s; return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipWriter#pos;F;[;[[@iÎ ;T;:pos;0;[;{;IC;"-Total number of input bytes read so far. ;T;[;[;I"/ Total number of input bytes read so far. ;T;0; @À;!F;"o;#;$T;%iÉ ;&iË ;'@Ž;(I"pstatic VALUE rb_gzfile_total_in(VALUE obj) { return rb_uint2inum(get_gzfile(obj)->z.stream.total_in); };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipWriter#tell;F;[;[[@iÎ ;T;: tell;0;[;{;IC;"-Total number of input bytes read so far. ;T;[;[;@Ê;0; @Î;!F;"o;#;$T;%iÉ ;&iË ;'@Ž;(I"pstatic VALUE rb_gzfile_total_in(VALUE obj) { return rb_uint2inum(get_gzfile(obj)->z.stream.total_in); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Zlib::GzipWriter.open;F;[[@c0;[[@i?;T;;Ÿ;0;[;{;IC;"ÜOpens a file specified by +filename+ for writing gzip compressed data, and returns a GzipWriter object associated with that file. Further details of this method are found in Zlib::GzipWriter.new and Zlib::GzipFile.wrap. ;T;[o;= ;3I" overload;F;40;:Zlib::GzipWriter.open;50;)I"=Zlib::GzipWriter.open(filename, level=nil, strategy=nil);T;IC;";T; @Û;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"gz;T; @Û;[;I"@yield [gz];T;0;6i;[[I" filename;T0[I" level;TI"nil;T[I" strategy;TI"nil;T; @Û;[;I"/Opens a file specified by +filename+ for writing gzip compressed data, and returns a GzipWriter object associated with that file. Further details of this method are found in Zlib::GzipWriter.new and Zlib::GzipFile.wrap. @overload Zlib::GzipWriter.open(filename, level=nil, strategy=nil) @yield [gz];T;0; @Û;!F;"o;#;$T;%i8;&i>;'@Ž;(I"static VALUE rb_gzwriter_s_open(int argc, VALUE *argv, VALUE klass) { return gzfile_s_open(argc, argv, klass, "wb"); };T;)I"static VALUE;T;*To;;F; ;;;;I" Zlib::GzipWriter#initialize;F;[[@c0;[[@iR;T;;Ð;0;[;{;IC;"˜Creates a GzipWriter object associated with +io+. +level+ and +strategy+ should be the same as the arguments of Zlib::Deflate.new. The GzipWriter object writes gzipped data to +io+. +io+ must respond to the +write+ method that behaves the same as IO#write. The +options+ hash may be used to set the encoding of the data. +:external_encoding+, +:internal_encoding+ and +:encoding+ may be set as in IO::new. ;T;[o;= ;3I" overload;F;40;:Zlib::GzipWriter.new;50;)I"HZlib::GzipWriter.new(io, level = nil, strategy = nil, options = {});T;IC;";T; @ÿ;>0;!F;[;[;I";T;0;6i;[ [I"io;T0[I" level;TI"nil;T[I" strategy;TI"nil;T[I"options;TI"{};T; @ÿ;[;I"èCreates a GzipWriter object associated with +io+. +level+ and +strategy+ should be the same as the arguments of Zlib::Deflate.new. The GzipWriter object writes gzipped data to +io+. +io+ must respond to the +write+ method that behaves the same as IO#write. The +options+ hash may be used to set the encoding of the data. +:external_encoding+, +:internal_encoding+ and +:encoding+ may be set as in IO::new. @overload Zlib::GzipWriter.new(io, level = nil, strategy = nil, options = {});T;0; @ÿ;!F;"o;#;$T;%iE;&iO;'@Ž;(I"Ístatic VALUE rb_gzwriter_initialize(int argc, VALUE *argv, VALUE obj) { struct gzfile *gz; VALUE io, level, strategy, opt = Qnil; int err; if (argc > 1) { opt = rb_check_convert_type(argv[argc-1], T_HASH, "Hash", "to_hash"); if (!NIL_P(opt)) argc--; } rb_scan_args(argc, argv, "12", &io, &level, &strategy); TypedData_Get_Struct(obj, struct gzfile, &gzfile_data_type, gz); /* this is undocumented feature of zlib */ gz->level = ARG_LEVEL(level); err = deflateInit2(&gz->z.stream, gz->level, Z_DEFLATED, -MAX_WBITS, DEF_MEM_LEVEL, ARG_STRATEGY(strategy)); if (err != Z_OK) { raise_zlib_error(err, gz->z.stream.msg); } gz->io = io; ZSTREAM_READY(&gz->z); rb_gzfile_ecopts(gz, opt); if (rb_respond_to(io, id_path)) { /* File#path may raise IOError in case when a path is unavailable */ rb_rescue2(gzfile_initialize_path_partial, obj, NULL, Qnil, rb_eIOError, (VALUE)0); } return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipWriter#flush;F;[[@c0;[[@i{;T;;Þ;0;[;{;IC;"åFlushes all the internal buffers of the GzipWriter object. The meaning of +flush+ is same as in Zlib::Deflate#deflate. Zlib::SYNC_FLUSH is used if +flush+ is omitted. It is no use giving flush Zlib::NO_FLUSH. ;T;[o;= ;3I" overload;F;40;;Þ;50;)I"flush(flush=nil);T;IC;";T; @!;>0;!F;[;[;I";T;0;6i;[[I" flush;TI"nil;T; @!;[;I"Flushes all the internal buffers of the GzipWriter object. The meaning of +flush+ is same as in Zlib::Deflate#deflate. Zlib::SYNC_FLUSH is used if +flush+ is omitted. It is no use giving flush Zlib::NO_FLUSH. @overload flush(flush=nil);T;0; @!;!F;"o;#;$T;%it;&iy;'@Ž;(I"×static VALUE rb_gzwriter_flush(int argc, VALUE *argv, VALUE obj) { struct gzfile *gz = get_gzfile(obj); VALUE v_flush; int flush; rb_scan_args(argc, argv, "01", &v_flush); flush = FIXNUMARG(v_flush, Z_SYNC_FLUSH); if (flush != Z_NO_FLUSH) { /* prevent Z_BUF_ERROR */ zstream_run(&gz->z, (Bytef*)"", 0, flush); } gzfile_write_raw(gz); if (rb_respond_to(gz->io, id_flush)) { rb_funcall(gz->io, id_flush, 0); } return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipWriter#write;F;[[@c0;[[@i“;T;;é;0;[;{;IC;"Same as IO. ;T;[;[;I"Same as IO. ;T;0; @;;!F;"o;#;$T;%i;&i‘;'@Ž;(I"ýstatic VALUE rb_gzwriter_write(int argc, VALUE *argv, VALUE obj) { struct gzfile *gz = get_gzfile(obj); size_t total = 0; while (argc-- > 0) { VALUE str = *argv++; if (!RB_TYPE_P(str, T_STRING)) str = rb_obj_as_string(str); if (gz->enc2 && gz->enc2 != rb_ascii8bit_encoding()) { str = rb_str_conv_enc(str, rb_enc_get(str), gz->enc2); } gzfile_write(gz, (Bytef*)RSTRING_PTR(str), RSTRING_LEN(str)); total += RSTRING_LEN(str); RB_GC_GUARD(str); } return SIZET2NUM(total); };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipWriter#putc;F;[[I"ch;T0;[[@iª;T;;¢;0;[;{;IC;"Same as IO. ;T;[;[;I"Same as IO. ;T;0; @J;!F;"o;#;$T;%i§;&i¨;'@Ž;(I"®static VALUE rb_gzwriter_putc(VALUE obj, VALUE ch) { struct gzfile *gz = get_gzfile(obj); char c = NUM2CHR(ch); gzfile_write(gz, (Bytef*)&c, 1); return ch; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipWriter#<<;F;[;[;F;;Ý;;K;[;{;IC;"Same as IO. ;T;[;[;I"Same as IO. ;T;0; @Z;!F;"o;#;$T;%i¶;&i·;'@Ž;*To;;F; ;;;;I"Zlib::GzipWriter#printf;F;[;[;F;; ;;K;[;{;IC;"Same as IO. ;T;[;[;I"Same as IO. ;T;0; @e;!F;"o;#;$T;%i»;&i¼;'@Ž;*To;;F; ;;;;I"Zlib::GzipWriter#print;F;[;[;F;;¡;;K;[;{;IC;"Same as IO. ;T;[;[;I"Same as IO. ;T;0; @p;!F;"o;#;$T;%iÀ;&iÁ;'@Ž;*To;;F; ;;;;I"Zlib::GzipWriter#puts;F;[;[;F;;£;;K;[;{;IC;"Same as IO. ;T;[;[;I"Same as IO. ;T;0; @{;!F;"o;#;$T;%iÅ;&iÆ;'@Ž;*T;A@Ž;BIC;[;A@Ž;CIC;[;A@Ž;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@i[@iÙ;T;:GzipWriter;;K;;;[;{;IC;"HZlib::GzipWriter is a class for writing gzipped files. GzipWriter should be used with an instance of IO, or IO-like, object. Following two example generate the same result. Zlib::GzipWriter.open('hoge.gz') do |gz| gz.write 'jugemu jugemu gokou no surikire...' end File.open('hoge.gz', 'w') do |f| gz = Zlib::GzipWriter.new(f) gz.write 'jugemu jugemu gokou no surikire...' gz.close end To make like gzip(1) does, run following: orig = 'hoge.txt' Zlib::GzipWriter.open('hoge.gz') do |gz| gz.mtime = File.mtime(orig) gz.orig_name = orig gz.write IO.binread(orig) end NOTE: Due to the limitation of Ruby's finalizer, you must explicitly close GzipWriter objects by Zlib::GzipWriter#close etc. Otherwise, GzipWriter will be not able to write the gzip footer and will generate a broken gzip file.;T;[;[;I"J Zlib::GzipWriter is a class for writing gzipped files. GzipWriter should be used with an instance of IO, or IO-like, object. Following two example generate the same result. Zlib::GzipWriter.open('hoge.gz') do |gz| gz.write 'jugemu jugemu gokou no surikire...' end File.open('hoge.gz', 'w') do |f| gz = Zlib::GzipWriter.new(f) gz.write 'jugemu jugemu gokou no surikire...' gz.close end To make like gzip(1) does, run following: orig = 'hoge.txt' Zlib::GzipWriter.open('hoge.gz') do |gz| gz.mtime = File.mtime(orig) gz.orig_name = orig gz.write IO.binread(orig) end NOTE: Due to the limitation of Ruby's finalizer, you must explicitly close GzipWriter objects by Zlib::GzipWriter#close etc. Otherwise, GzipWriter will be not able to write the gzip footer and will generate a broken gzip file. ;T;0; @Ž;!F;"o;#;$T;%i;&i.;6i;'o;L;M0;N0;O0;;P;'@;Q@;R0;I"Zlib::GzipWriter;F;S@¦o; ;IC;[ o;;F; ;;;;I"Zlib::GzipReader#lineno;F;[;[[@iþ;T;:lineno;0;[;{;IC;"9The line number of the last row read from this file. ;T;[;[;I"; The line number of the last row read from this file. ;T;0; @›;!F;"o;#;$T;%iù;&iû;'@™;(I"^static VALUE rb_gzfile_lineno(VALUE obj) { return INT2NUM(get_gzfile(obj)->lineno); };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#lineno=;F;[[I"lineno;T0;[[@i ;T;:lineno=;0;[;{;IC;"=Specify line number of the last row read from this file. ;T;[;[;I"? Specify line number of the last row read from this file. ;T;0; @©;!F;"o;#;$T;%i ;&i ;'@™;(I"œstatic VALUE rb_gzfile_set_lineno(VALUE obj, VALUE lineno) { struct gzfile *gz = get_gzfile(obj); gz->lineno = NUM2INT(lineno); return lineno; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#eof;F;[;[[@iŸ ;T;:eof;0;[;{;IC;"FReturns +true+ or +false+ whether the stream has reached the end. ;T;[;[;I"H Returns +true+ or +false+ whether the stream has reached the end. ;T;0; @¹;!F;"o;#;$T;%iš ;&iœ ;'@™;(I"ˆstatic VALUE rb_gzfile_eof_p(VALUE obj) { struct gzfile *gz = get_gzfile(obj); return GZFILE_IS_FINISHED(gz) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#eof?;F;[;[[@iŸ ;T;: eof?;0;[;{;IC;"FReturns +true+ or +false+ whether the stream has reached the end.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @Ç;[;@Ã;0; @Ç;!F;"o;#;$T;%iš ;&iœ ;6i;'@™;(I"ˆstatic VALUE rb_gzfile_eof_p(VALUE obj) { struct gzfile *gz = get_gzfile(obj); return GZFILE_IS_FINISHED(gz) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#pos;F;[;[[@iÙ ;T;;;0;[;{;IC;"0Total number of output bytes output so far. ;T;[;[;I"2 Total number of output bytes output so far. ;T;0; @×;!F;"o;#;$T;%iÔ ;&iÖ ;'@™;(I"estatic VALUE rb_gzfile_total_out(VALUE obj) { struct gzfile *gz = get_gzfile(obj); uLong total_out = gz->z.stream.total_out; long buf_filled = ZSTREAM_BUF_FILLED(&gz->z); if (total_out >= (uLong)buf_filled) { return rb_uint2inum(total_out - buf_filled); } else { return LONG2FIX(-(buf_filled - (long)total_out)); } };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#tell;F;[;[[@iÙ ;T;;;0;[;{;IC;"0Total number of output bytes output so far. ;T;[;[;@á;0; @å;!F;"o;#;$T;%iÔ ;&iÖ ;'@™;(I"estatic VALUE rb_gzfile_total_out(VALUE obj) { struct gzfile *gz = get_gzfile(obj); uLong total_out = gz->z.stream.total_out; long buf_filled = ZSTREAM_BUF_FILLED(&gz->z); if (total_out >= (uLong)buf_filled) { return rb_uint2inum(total_out - buf_filled); } else { return LONG2FIX(-(buf_filled - (long)total_out)); } };T;)I"static VALUE;T;*To;;F; ;F;;;I"Zlib::GzipReader.open;F;[[@c0;[[@i;T;;Ÿ;0;[;{;IC;"þcall-seq: Zlib::GzipReader.open(filename) {|gz| ... } Opens a file specified by +filename+ as a gzipped file, and returns a GzipReader object associated with that file. Further details of this method are in Zlib::GzipReader.new and ZLib::GzipFile.wrap. ;T;[;[;I" call-seq: Zlib::GzipReader.open(filename) {|gz| ... } Opens a file specified by +filename+ as a gzipped file, and returns a GzipReader object associated with that file. Further details of this method are in Zlib::GzipReader.new and ZLib::GzipFile.wrap. ;T;0; @ò;!F;"o;#;$T;%i;&i;'@™;(I"static VALUE rb_gzreader_s_open(int argc, VALUE *argv, VALUE klass) { return gzfile_s_open(argc, argv, klass, "rb"); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Zlib::GzipReader.zcat;F;[[@c0;[[@i';T;: zcat;0;[;{;IC;"äcall-seq: Zlib::GzipReader.zcat(io, options = {}, &block) => nil Zlib::GzipReader.zcat(io, options = {}) => string Decompresses all gzip data in the +io+, handling multiple gzip streams until the end of the +io+. There should not be any non-gzip data after the gzip streams. If a block is given, it is yielded strings of uncompressed data, and the method returns +nil+. If a block is not given, the method returns the concatenation of all uncompressed data in all gzip streams. ;T;[;[;I"æ call-seq: Zlib::GzipReader.zcat(io, options = {}, &block) => nil Zlib::GzipReader.zcat(io, options = {}) => string Decompresses all gzip data in the +io+, handling multiple gzip streams until the end of the +io+. There should not be any non-gzip data after the gzip streams. If a block is given, it is yielded strings of uncompressed data, and the method returns +nil+. If a block is not given, the method returns the concatenation of all uncompressed data in all gzip streams. ;T;0; @;!F;"o;#;$T;%i;&i$;'@™;(I"!static VALUE rb_gzreader_s_zcat(int argc, VALUE *argv, VALUE klass) { VALUE io, unused, obj, buf=0, tmpbuf; long pos; rb_check_arity(argc, 1, 2); io = argv[0]; do { obj = rb_funcallv(klass, rb_intern("new"), argc, argv); if (rb_block_given_p()) { rb_gzreader_each(0, 0, obj); } else { if (!buf) { buf = rb_str_new(0, 0); } tmpbuf = gzfile_read_all(get_gzfile(obj)); rb_str_cat(buf, RSTRING_PTR(tmpbuf), RSTRING_LEN(tmpbuf)); } rb_gzreader_read(0, 0, obj); pos = NUM2LONG(rb_funcall(io, rb_intern("pos"), 0)); unused = rb_gzreader_unused(obj); rb_gzfile_finish(obj); if (!NIL_P(unused)) { pos -= NUM2LONG(rb_funcall(unused, rb_intern("length"), 0)); rb_funcall(io, rb_intern("pos="), 1, LONG2NUM(pos)); } } while (pos < NUM2LONG(rb_funcall(io, rb_intern("size"), 0))); if (rb_block_given_p()) { return Qnil; } return buf; };T;)I"static VALUE;T;*To;;F; ;;;;I" Zlib::GzipReader#initialize;F;[[@c0;[[@i^;T;;Ð;0;[;{;IC;"ãcall-seq: Zlib::GzipReader.new(io, options = {}) Creates a GzipReader object associated with +io+. The GzipReader object reads gzipped data from +io+, and parses/decompresses it. The +io+ must have a +read+ method that behaves same as the IO#read. The +options+ hash may be used to set the encoding of the data. +:external_encoding+, +:internal_encoding+ and +:encoding+ may be set as in IO::new. If the gzip file header is incorrect, raises an Zlib::GzipFile::Error exception. ;T;[;[;I"å call-seq: Zlib::GzipReader.new(io, options = {}) Creates a GzipReader object associated with +io+. The GzipReader object reads gzipped data from +io+, and parses/decompresses it. The +io+ must have a +read+ method that behaves same as the IO#read. The +options+ hash may be used to set the encoding of the data. +:external_encoding+, +:internal_encoding+ and +:encoding+ may be set as in IO::new. If the gzip file header is incorrect, raises an Zlib::GzipFile::Error exception. ;T;0; @;!F;"o;#;$T;%iM;&i[;'@™;(I"ìstatic VALUE rb_gzreader_initialize(int argc, VALUE *argv, VALUE obj) { VALUE io, opt = Qnil; struct gzfile *gz; int err; TypedData_Get_Struct(obj, struct gzfile, &gzfile_data_type, gz); rb_scan_args(argc, argv, "1:", &io, &opt); /* this is undocumented feature of zlib */ err = inflateInit2(&gz->z.stream, -MAX_WBITS); if (err != Z_OK) { raise_zlib_error(err, gz->z.stream.msg); } gz->io = io; ZSTREAM_READY(&gz->z); gzfile_read_header(gz, Qnil); rb_gzfile_ecopts(gz, opt); if (rb_respond_to(io, id_path)) { /* File#path may raise IOError in case when a path is unavailable */ rb_rescue2(gzfile_initialize_path_partial, obj, NULL, Qnil, rb_eIOError, (VALUE)0); } return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#rewind;F;[;[[@i€;T;:rewind;0;[;{;IC;"”Resets the position of the file pointer to the point created the GzipReader object. The associated IO object needs to respond to the +seek+ method. ;T;[;[;I"– Resets the position of the file pointer to the point created the GzipReader object. The associated IO object needs to respond to the +seek+ method. ;T;0; @;!F;"o;#;$T;%iz;&i};'@™;(I"Œstatic VALUE rb_gzreader_rewind(VALUE obj) { struct gzfile *gz = get_gzfile(obj); gzfile_reader_rewind(gz); return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#unused;F;[;[[@iŽ;T;:unused;0;[;{;IC;"|Returns the rest of the data which had read for parsing gzip format, or +nil+ if the whole gzip file is not parsed yet. ;T;[;[;I"~ Returns the rest of the data which had read for parsing gzip format, or +nil+ if the whole gzip file is not parsed yet. ;T;0; @-;!F;"o;#;$T;%iˆ;&i‹;'@™;(I"³static VALUE rb_gzreader_unused(VALUE obj) { struct gzfile *gz; TypedData_Get_Struct(obj, struct gzfile, &gzfile_data_type, gz); return gzfile_reader_get_unused(gz); };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#read;F;[[@c0;[[@i›;T;;è;0;[;{;IC;":See Zlib::GzipReader documentation for a description. ;T;[;[;I"< See Zlib::GzipReader documentation for a description. ;T;0; @;;!F;"o;#;$T;%i–;&i˜;'@™;(I"static VALUE rb_gzreader_read(int argc, VALUE *argv, VALUE obj) { struct gzfile *gz = get_gzfile(obj); VALUE vlen; long len; rb_scan_args(argc, argv, "01", &vlen); if (NIL_P(vlen)) { return gzfile_read_all(gz); } len = NUM2INT(vlen); if (len < 0) { rb_raise(rb_eArgError, "negative length %ld given", len); } return gzfile_read(gz, len); };T;)I"static VALUE;T;*To;;F; ;;;;I"!Zlib::GzipReader#readpartial;F;[[@c0;[[@iº;T;:readpartial;0;[;{;IC;"qcall-seq: gzipreader.readpartial(maxlen [, outbuf]) => string, outbuf Reads at most maxlen bytes from the gziped stream but it blocks only if gzipreader has no data immediately available. If the optional outbuf argument is present, it must reference a String, which will receive the data. It raises EOFError on end of file. ;T;[;[;I"t call-seq: gzipreader.readpartial(maxlen [, outbuf]) => string, outbuf Reads at most maxlen bytes from the gziped stream but it blocks only if gzipreader has no data immediately available. If the optional outbuf argument is present, it must reference a String, which will receive the data. It raises EOFError on end of file. ;T;0; @J;!F;"o;#;$T;%i®;&i·;'@™;(I"ªstatic VALUE rb_gzreader_readpartial(int argc, VALUE *argv, VALUE obj) { struct gzfile *gz = get_gzfile(obj); VALUE vlen, outbuf; long len; rb_scan_args(argc, argv, "11", &vlen, &outbuf); len = NUM2INT(vlen); if (len < 0) { rb_raise(rb_eArgError, "negative length %ld given", len); } if (!NIL_P(outbuf)) Check_Type(outbuf, T_STRING); return gzfile_readpartial(gz, len, outbuf); };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#getc;F;[;[[@iÑ;T;: getc;0;[;{;IC;":See Zlib::GzipReader documentation for a description. ;T;[;[;I"< See Zlib::GzipReader documentation for a description. ;T;0; @Y;!F;"o;#;$T;%iÌ;&iÎ;'@™;(I"wstatic VALUE rb_gzreader_getc(VALUE obj) { struct gzfile *gz = get_gzfile(obj); return gzfile_getc(gz); };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#getbyte;F;[;[[@iî;T;:getbyte;0;[;{;IC;":See Zlib::GzipReader documentation for a description. ;T;[;[;I"< See Zlib::GzipReader documentation for a description. ;T;0; @g;!F;"o;#;$T;%ié;&ië;'@™;(I"ïstatic VALUE rb_gzreader_getbyte(VALUE obj) { struct gzfile *gz = get_gzfile(obj); VALUE dst; dst = gzfile_read(gz, 1); if (!NIL_P(dst)) { dst = INT2FIX((unsigned int)(RSTRING_PTR(dst)[0]) & 0xff); } return dst; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#readchar;F;[;[[@iÞ;T;: readchar;0;[;{;IC;":See Zlib::GzipReader documentation for a description. ;T;[;[;I"< See Zlib::GzipReader documentation for a description. ;T;0; @u;!F;"o;#;$T;%iÙ;&iÛ;'@™;(I"¼static VALUE rb_gzreader_readchar(VALUE obj) { VALUE dst; dst = rb_gzreader_getc(obj); if (NIL_P(dst)) { rb_raise(rb_eEOFError, "end of file reached"); } return dst; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#readbyte;F;[;[[@i;T;: readbyte;0;[;{;IC;":See Zlib::GzipReader documentation for a description. ;T;[;[;I"< See Zlib::GzipReader documentation for a description. ;T;0; @ƒ;!F;"o;#;$T;%iû;&iý;'@™;(I"¿static VALUE rb_gzreader_readbyte(VALUE obj) { VALUE dst; dst = rb_gzreader_getbyte(obj); if (NIL_P(dst)) { rb_raise(rb_eEOFError, "end of file reached"); } return dst; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#each_byte;F;[;[[@i";T;:each_byte;0;[;{;IC;":See Zlib::GzipReader documentation for a description. ;T;[;[;I"< See Zlib::GzipReader documentation for a description. ;T;0; @‘;!F;"o;#;$T;%i;&i;'@™;(I"ºstatic VALUE rb_gzreader_each_byte(VALUE obj) { VALUE c; RETURN_ENUMERATOR(obj, 0, 0); while (!NIL_P(c = rb_gzreader_getbyte(obj))) { rb_yield(c); } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#each_char;F;[;[[@i;T;:each_char;0;[;{;IC;":See Zlib::GzipReader documentation for a description. ;T;[;[;I"< See Zlib::GzipReader documentation for a description. ;T;0; @Ÿ;!F;"o;#;$T;%i;&i ;'@™;(I"·static VALUE rb_gzreader_each_char(VALUE obj) { VALUE c; RETURN_ENUMERATOR(obj, 0, 0); while (!NIL_P(c = rb_gzreader_getc(obj))) { rb_yield(c); } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#ungetc;F;[[I"s;T0;[[@i4;T;:ungetc;0;[;{;IC;":See Zlib::GzipReader documentation for a description. ;T;[;[;I"< See Zlib::GzipReader documentation for a description. ;T;0; @;!F;"o;#;$T;%i/;&i1;'@™;(I"–static VALUE rb_gzreader_ungetc(VALUE obj, VALUE s) { struct gzfile *gz; if (FIXNUM_P(s)) return rb_gzreader_ungetbyte(obj, s); gz = get_gzfile(obj); StringValue(s); if (gz->enc2 && gz->enc2 != rb_ascii8bit_encoding()) { s = rb_str_conv_enc(s, rb_enc_get(s), gz->enc2); } gzfile_ungets(gz, (const Bytef*)RSTRING_PTR(s), RSTRING_LEN(s)); RB_GC_GUARD(s); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#ungetbyte;F;[[I"ch;T0;[[@iJ;T;:ungetbyte;0;[;{;IC;":See Zlib::GzipReader documentation for a description. ;T;[;[;I"< See Zlib::GzipReader documentation for a description. ;T;0; @½;!F;"o;#;$T;%iE;&iG;'@™;(I"œstatic VALUE rb_gzreader_ungetbyte(VALUE obj, VALUE ch) { struct gzfile *gz = get_gzfile(obj); gzfile_ungetbyte(gz, NUM2CHR(ch)); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#gets;F;[[@c0;[[@i;T;;¤;0;[;{;IC;"¤See Zlib::GzipReader documentation for a description. However, note that this method can return +nil+ even if #eof? returns false, unlike the behavior of File#gets. ;T;[;[;I"¦ See Zlib::GzipReader documentation for a description. However, note that this method can return +nil+ even if #eof? returns false, unlike the behavior of File#gets. ;T;0; @Í;!F;"o;#;$T;%i ;&i;'@™;(I"Àstatic VALUE rb_gzreader_gets(int argc, VALUE *argv, VALUE obj) { VALUE dst; dst = gzreader_gets(argc, argv, obj); if (!NIL_P(dst)) { rb_lastline_set(dst); } return dst; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#readline;F;[[@c0;[[@i$;T;;¥;0;[;{;IC;":See Zlib::GzipReader documentation for a description. ;T;[;[;I"< See Zlib::GzipReader documentation for a description. ;T;0; @Ü;!F;"o;#;$T;%i;&i!;'@™;(I"ßstatic VALUE rb_gzreader_readline(int argc, VALUE *argv, VALUE obj) { VALUE dst; dst = rb_gzreader_gets(argc, argv, obj); if (NIL_P(dst)) { rb_raise(rb_eEOFError, "end of file reached"); } return dst; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#each;F;[[@c0;[[@i4;T;: each;0;[;{;IC;":See Zlib::GzipReader documentation for a description. ;T;[;[;I"< See Zlib::GzipReader documentation for a description. ;T;0; @ë;!F;"o;#;$T;%i/;&i1;'@™;(I"×static VALUE rb_gzreader_each(int argc, VALUE *argv, VALUE obj) { VALUE str; RETURN_ENUMERATOR(obj, 0, 0); while (!NIL_P(str = gzreader_gets(argc, argv, obj))) { rb_yield(str); } return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#each_line;F;[[@c0;[[@i4;T;:each_line;0;[;{;IC;":See Zlib::GzipReader documentation for a description. ;T;[;[;@ö;0; @ú;!F;"o;#;$T;%i/;&i1;'@™;(I"×static VALUE rb_gzreader_each(int argc, VALUE *argv, VALUE obj) { VALUE str; RETURN_ENUMERATOR(obj, 0, 0); while (!NIL_P(str = gzreader_gets(argc, argv, obj))) { rb_yield(str); } return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"Zlib::GzipReader#readlines;F;[[@c0;[[@iF;T;;§;0;[;{;IC;":See Zlib::GzipReader documentation for a description. ;T;[;[;I"< See Zlib::GzipReader documentation for a description. ;T;0; @;!F;"o;#;$T;%iA;&iC;'@™;(I"Ýstatic VALUE rb_gzreader_readlines(int argc, VALUE *argv, VALUE obj) { VALUE str, dst; dst = rb_ary_new(); while (!NIL_P(str = gzreader_gets(argc, argv, obj))) { rb_ary_push(dst, str); } return dst; };T;)I"static VALUE;T;*To;;F; ;;;;I"'Zlib::GzipReader#external_encoding;F;[;[[@iV;T;:external_encoding;0;[;{;IC;":See Zlib::GzipReader documentation for a description. ;T;[;[;I"< See Zlib::GzipReader documentation for a description. ;T;0; @;!F;"o;#;$T;%iQ;&iS;'@™;(I"wstatic VALUE rb_gzreader_external_encoding(VALUE self) { return rb_enc_from_encoding(get_gzfile(self)->enc); };T;)I"static VALUE;T;*T;A@™;BIC;[;A@™;CIC;[o;L;M0;N0;O0;:Enumerable;'@;Qo; ;IC;[@o;;F; ;;;;I"Enumerable#chain;F;[[@c0;[[@ëi×;T;: chain;0;[;{;IC;"‹Returns an enumerator object generated from this enumerator and given enumerables. e = (1..3).chain([4, 5]) e.to_a #=> [1, 2, 3, 4, 5] ;T;[o;= ;3I" overload;F;40;;;50;)I"chain(*enums);T;IC;";T; @*;>0;!F;[;[;I";T;0;6i;[[I"*enums;T0; @*;[;I"¥Returns an enumerator object generated from this enumerator and given enumerables. e = (1..3).chain([4, 5]) e.to_a #=> [1, 2, 3, 4, 5] @overload chain(*enums);T;0; @*;!F;"o;#;$T;%iÍ;&iÔ;'@(;(I"ástatic VALUE enum_chain(int argc, VALUE *argv, VALUE obj) { VALUE enums = rb_ary_new_from_values(1, &obj); rb_ary_cat(enums, argv, argc); return enum_chain_initialize(enum_chain_allocate(rb_cEnumChain), enums); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#lazy;F;[;[[@ëif;T;: lazy;0;[;{;IC;"¼Returns an Enumerator::Lazy, which redefines most Enumerable methods to postpone enumeration and enumerate values only on an as-needed basis. === 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;= ;3I" overload;F;40;; ;50;)I" lazy;T;IC;";T; @C;>0;!F;[;[;I";T;0;6i;[; @C;[;I"ÍReturns an Enumerator::Lazy, which redefines most Enumerable methods to postpone enumeration and enumerate values only on an as-needed basis. === 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; @C;!F;"o;#;$T;%iI;⁣'@(;(I"static VALUE enumerable_lazy(VALUE obj) { VALUE result = lazy_to_enum_i(obj, sym_each, 0, 0, lazyenum_size, rb_keyword_given_p()); /* Qfalse indicates that the Enumerator::Lazy has no method name */ rb_ivar_set(result, id_method, Qfalse); return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#to_a;F;[[@c0;[[I"enum.c;Ti¨;T;: to_a;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;= ;3I" overload;F;40;;!;50;)I"to_a(*args);T;IC;";T; @Y;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @Y;[;I"@return [Array];T;0;6i;[[I" *args;T0; @Yo;= ;3I" overload;F;40;:entries;50;)I"entries(*args);T;IC;";T; @Y;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @Y;[;I"@return [Array];T;0;6i;[[I" *args;T0; @Y;[;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; @Y;!F;"o;#;$T;%i›;&i§;'@(;(I"Çstatic VALUE enum_to_a(int argc, VALUE *argv, VALUE obj) { VALUE ary = rb_ary_new(); rb_block_call_kw(obj, id_each, argc, argv, collect_all, ary, RB_PASS_CALLED_KEYWORDS); return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#entries;F;[[@c0;[[@_i¨;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;= ;3I" overload;F;40;;!;50;)I"to_a(*args);T;IC;";T; @‡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @‡;[;I"@return [Array];T;0;6i;[[I" *args;T0; @‡o;= ;3I" overload;F;40;;";50;)I"entries(*args);T;IC;";T; @‡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @‡;[;I"@return [Array];T;0;6i;[[I" *args;T0; @‡;[;@ƒ;0; @‡;!F;"o;#;$T;%i›;&i§;'@(;(I"Çstatic VALUE enum_to_a(int argc, VALUE *argv, VALUE obj) { VALUE ary = rb_ary_new(); rb_block_call_kw(obj, id_each, argc, argv, collect_all, ary, RB_PASS_CALLED_KEYWORDS); return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#to_h;F;[[@c0;[[@_iÙ;T;: to_h;0;[;{;IC;"TReturns the result of interpreting enum as a list of [key, value] pairs. %i[hello world].each_with_index.to_h # => {:hello => 0, :world => 1} If a block is given, the results of the block on each element of the enum will be used as pairs. (1..5).to_h {|x| [x, x ** 2]} #=> {1=>1, 2=>4, 3=>9, 4=>16, 5=>25} ;T;[o;= ;3I" overload;F;40;;#;50;)I"to_h(*args);T;IC;";T; @³;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @³;[;I"@return [Hash];T;0;6i;[[I" *args;T0; @³o;= ;3I" overload;F;40;;#;50;)I"to_h(*args);T;IC;";T; @³;>0;!F;[o;2 ;3I" yield;F;4I"[];T;0;50; @³o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @³;[;I"@yield [] @return [Hash];T;0;6i;[[I" *args;T0; @³;[;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} If a block is given, the results of the block on each element of the enum will be used as pairs. (1..5).to_h {|x| [x, x ** 2]} #=> {1=>1, 2=>4, 3=>9, 4=>16, 5=>25} @overload to_h(*args) @return [Hash] @overload to_h(*args) @yield [] @return [Hash];T;0; @³;!F;"o;#;$T;%iÇ;&iØ;'@(;(I"¼static VALUE enum_to_h(int argc, VALUE *argv, VALUE obj) { rb_block_call_func *iter = rb_block_given_p() ? enum_to_h_ii : enum_to_h_i; return enum_hashify(obj, argc, argv, iter); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#sort;F;[;[[@_id;T;: sort;0;[;{;IC;"Returns an array containing the items in enum sorted. Comparisons for the sort will be done using the items' own <=> operator or using an optional code block. The block must implement a comparison between +a+ and +b+ and return an integer less than 0 when +b+ follows +a+, +0+ when +a+ and +b+ are equivalent, or an integer greater than 0 when +a+ follows +b+. The result is not guaranteed to be stable. When the comparison of two elements returns +0+, the order of the elements is unpredictable. %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] See also Enumerable#sort_by. It implements a Schwartzian transform which is useful when key computation or comparison is expensive. ;T;[o;= ;3I" overload;F;40;;$;50;)I" sort;T;IC;";T; @ã;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ã;[;I"@return [Array];T;0;6i;[; @ão;= ;3I" overload;F;40;;$;50;)I" sort;T;IC;";T; @ã;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"a;TI"b;T; @ão;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ã;[;I""@yield [a, b] @return [Array];T;0;6i;[; @ã;[;I"jReturns an array containing the items in enum sorted. Comparisons for the sort will be done using the items' own <=> operator or using an optional code block. The block must implement a comparison between +a+ and +b+ and return an integer less than 0 when +b+ follows +a+, +0+ when +a+ and +b+ are equivalent, or an integer greater than 0 when +a+ follows +b+. The result is not guaranteed to be stable. When the comparison of two elements returns +0+, the order of the elements is unpredictable. %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] See also Enumerable#sort_by. It implements a Schwartzian transform which is useful when key computation or comparison is expensive. @overload sort @return [Array] @overload sort @yield [a, b] @return [Array];T;0; @ã;!F;"o;#;$T;%iL;⁣'@(;(I"]static VALUE enum_sort(VALUE obj) { return rb_ary_sort_bang(enum_to_a(0, 0, obj)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#sort_by;F;[;[[@_ií;T;:sort_by;0;[;{;IC;"k Sorts enum using a set of keys generated by mapping the values in enum through the given block. The result is not guaranteed to be stable. When two keys are equal, the order of the corresponding elements is unpredictable. 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"] To produce the reverse of a specific order, the following can be used: ary.sort_by { ... }.reverse! ;T;[o;= ;3I" overload;F;40;;%;50;)I"sort_by;T;IC;";T; @;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @;[;I"!@yield [obj] @return [Array];T;0;6i;[; @o;= ;3I" overload;F;40;;%;50;)I"sort_by;T;IC;";T; @;>0;!F;[;[;I";T;0;6i;[; @;[;I"² Sorts enum using a set of keys generated by mapping the values in enum through the given block. The result is not guaranteed to be stable. When two keys are equal, the order of the corresponding elements is unpredictable. 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"] To produce the reverse of a specific order, the following can be used: ary.sort_by { ... }.reverse! @overload sort_by @yield [obj] @return [Array] @overload sort_by;T;0; @;!F;"o;#;$T;%iŸ;&ië;'@(;(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); 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;= ;3I" overload;F;40;;&;50;)I"grep(pattern);T;IC;";T; @9;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @9;[;I"@return [Array];T;0;6i;[[I"pattern;T0; @9o;= ;3I" overload;F;40;;&;50;)I"grep(pattern);T;IC;";T; @9;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @9o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @9;[;I"!@yield [obj] @return [Array];T;0;6i;[[I"pattern;T0; @9;[;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; @9;!F;"o;#;$T;%i†;&i—;'@(;(I"]static VALUE enum_grep(VALUE obj, VALUE pat) { return enum_grep0(obj, pat, Qtrue); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#grep_v;F;[[I"pat;T0;[[@_i;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;= ;3I" overload;F;40;;';50;)I"grep_v(pattern);T;IC;";T; @l;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @l;[;I"@return [Array];T;0;6i;[[I"pattern;T0; @lo;= ;3I" overload;F;40;;';50;)I"grep_v(pattern);T;IC;";T; @l;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @lo;2 ;3I"return;F;4I";T;0;5[I" Array;T; @l;[;I"!@yield [obj] @return [Array];T;0;6i;[[I"pattern;T0; @l;[;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; @l;!F;"o;#;$T;%iž;&i¬;'@(;(I"`static VALUE enum_grep_v(VALUE obj, VALUE pat) { return enum_grep0(obj, pat, Qfalse); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#count;F;[[@c0;[[@_i;T;: count;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;= ;3I" overload;F;40;;(;50;)I" count;T;IC;";T; @Ÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ÿ;[;I"@return [Integer];T;0;6i;[; @Ÿo;= ;3I" overload;F;40;;(;50;)I"count(item);T;IC;";T; @Ÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ÿ;[;I"@return [Integer];T;0;6i;[[I" item;T0; @Ÿo;= ;3I" overload;F;40;;(;50;)I" count;T;IC;";T; @Ÿ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @Ÿo;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ÿ;[;I"#@yield [obj] @return [Integer];T;0;6i;[; @Ÿ;[;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; @Ÿ;!F;"o;#;$T;%ið;&i;'@(;(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 imemo_count_value(memo); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#find;F;[[@c0;[[@_iF;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..100).detect #=> # (1..100).find #=> # (1..10).detect { |i| i % 5 == 0 && i % 7 == 0 } #=> nil (1..10).find { |i| i % 5 == 0 && i % 7 == 0 } #=> nil (1..10).detect(-> {0}) { |i| i % 5 == 0 && i % 7 == 0 } #=> 0 (1..10).find(-> {0}) { |i| i % 5 == 0 && i % 7 == 0 } #=> 0 (1..100).detect { |i| i % 5 == 0 && i % 7 == 0 } #=> 35 (1..100).find { |i| i % 5 == 0 && i % 7 == 0 } #=> 35 ;T;[ o;= ;3I" overload;F;40;:detect;50;)I"detect(ifnone = nil);T;IC;";T; @Ü;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @Üo;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @Ü;[;I"'@yield [obj] @return [Object, nil];T;0;6i;[[I"ifnone;TI"nil;T; @Üo;= ;3I" overload;F;40;;);50;)I"find(ifnone = nil);T;IC;";T; @Ü;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @Üo;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @Ü;[;I"'@yield [obj] @return [Object, nil];T;0;6i;[[I"ifnone;TI"nil;T; @Üo;= ;3I" overload;F;40;;*;50;)I"detect(ifnone = nil);T;IC;";T; @Ü;>0;!F;[;[;I";T;0;6i;[[I"ifnone;TI"nil;T; @Üo;= ;3I" overload;F;40;;);50;)I"find(ifnone = nil);T;IC;";T; @Ü;>0;!F;[;[;I";T;0;6i;[[I"ifnone;TI"nil;T; @Ü;[;I"ð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..100).detect #=> # (1..100).find #=> # (1..10).detect { |i| i % 5 == 0 && i % 7 == 0 } #=> nil (1..10).find { |i| i % 5 == 0 && i % 7 == 0 } #=> nil (1..10).detect(-> {0}) { |i| i % 5 == 0 && i % 7 == 0 } #=> 0 (1..10).find(-> {0}) { |i| i % 5 == 0 && i % 7 == 0 } #=> 0 (1..100).detect { |i| i % 5 == 0 && i % 7 == 0 } #=> 35 (1..100).find { |i| i % 5 == 0 && 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; @Ü;!F;"o;#;$T;%i,;&iF;'@(;(I"¸static VALUE enum_find(int argc, VALUE *argv, VALUE obj) { struct MEMO *memo; VALUE if_none; if_none = rb_check_arity(argc, 0, 1) ? argv[0] : Qnil; 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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#detect;F;[[@c0;[[@_iF;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..100).detect #=> # (1..100).find #=> # (1..10).detect { |i| i % 5 == 0 && i % 7 == 0 } #=> nil (1..10).find { |i| i % 5 == 0 && i % 7 == 0 } #=> nil (1..10).detect(-> {0}) { |i| i % 5 == 0 && i % 7 == 0 } #=> 0 (1..10).find(-> {0}) { |i| i % 5 == 0 && i % 7 == 0 } #=> 0 (1..100).detect { |i| i % 5 == 0 && i % 7 == 0 } #=> 35 (1..100).find { |i| i % 5 == 0 && i % 7 == 0 } #=> 35 ;T;[ o;= ;3I" overload;F;40;;*;50;)I"detect(ifnone = nil);T;IC;";T; @-;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @-o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @-;[;I"'@yield [obj] @return [Object, nil];T;0;6i;[[I"ifnone;TI"nil;T; @-o;= ;3I" overload;F;40;;);50;)I"find(ifnone = nil);T;IC;";T; @-;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @-o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @-;[;I"'@yield [obj] @return [Object, nil];T;0;6i;[[I"ifnone;TI"nil;T; @-o;= ;3I" overload;F;40;;*;50;)I"detect(ifnone = nil);T;IC;";T; @-;>0;!F;[;[;I";T;0;6i;[[I"ifnone;TI"nil;T; @-o;= ;3I" overload;F;40;;);50;)I"find(ifnone = nil);T;IC;";T; @-;>0;!F;[;[;I";T;0;6i;[[I"ifnone;TI"nil;T; @-;[;@);0; @-;!F;"o;#;$T;%i,;&iF;'@(;(I"¸static VALUE enum_find(int argc, VALUE *argv, VALUE obj) { struct MEMO *memo; VALUE if_none; if_none = rb_check_arity(argc, 0, 1) ? argv[0] : Qnil; 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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#find_index;F;[[@c0;[[@_iˆ;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 && i % 7 == 0 } #=> nil (1..100).find_index { |i| i % 5 == 0 && i % 7 == 0 } #=> 34 (1..100).find_index(50) #=> 49 ;T;[o;= ;3I" overload;F;40;;+;50;)I"find_index(value);T;IC;";T; @};>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @};[;I"@return [Integer, nil];T;0;6i;[[I" value;T0; @}o;= ;3I" overload;F;40;;+;50;)I"find_index;T;IC;";T; @};>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @}o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @};[;I"(@yield [obj] @return [Integer, nil];T;0;6i;[; @}o;= ;3I" overload;F;40;;+;50;)I"find_index;T;IC;";T; @};>0;!F;[;[;I";T;0;6i;[; @};[;I"hCompares 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 && i % 7 == 0 } #=> nil (1..100).find_index { |i| i % 5 == 0 && 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; @};!F;"o;#;$T;%iu;&i‡;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#find_all;F;[;[[@_iÞ;T;: find_all;0;[;{;IC;"ÞReturns an array containing all elements of +enum+ for which the given +block+ returns a true value. The find_all and select methods are aliases. There is no performance benefit to either. 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] [:foo, :bar].filter { |x| x == :foo } #=> [:foo] See also Enumerable#reject, Enumerable#grep. ;T;[o;= ;3I" overload;F;40;;,;50;)I" find_all;T;IC;";T; @·;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @·o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @·;[;I"!@yield [obj] @return [Array];T;0;6i;[; @·o;= ;3I" overload;F;40;;¦;50;)I"select;T;IC;";T; @·;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @·o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @·;[;I"!@yield [obj] @return [Array];T;0;6i;[; @·o;= ;3I" overload;F;40;:filter;50;)I"filter;T;IC;";T; @·;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @·o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @·;[;I"!@yield [obj] @return [Array];T;0;6i;[; @·o;= ;3I" overload;F;40;;,;50;)I" find_all;T;IC;";T; @·;>0;!F;[;[;I";T;0;6i;[; @·o;= ;3I" overload;F;40;;¦;50;)I"select;T;IC;";T; @·;>0;!F;[;[;I";T;0;6i;[; @·o;= ;3I" overload;F;40;;-;50;)I"filter;T;IC;";T; @·;>0;!F;[;[;I";T;0;6i;[; @·;[;I"Returns an array containing all elements of +enum+ for which the given +block+ returns a true value. The find_all and select methods are aliases. There is no performance benefit to either. 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] [:foo, :bar].filter { |x| x == :foo } #=> [:foo] See also Enumerable#reject, Enumerable#grep. @overload find_all @yield [obj] @return [Array] @overload select @yield [obj] @return [Array] @overload filter @yield [obj] @return [Array] @overload find_all @overload select @overload filter;T;0; @·;!F;"o;#;$T;%iÃ;&ià;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#select;F;[;[[@_iÞ;T;;¦;0;[;{;IC;"ÞReturns an array containing all elements of +enum+ for which the given +block+ returns a true value. The find_all and select methods are aliases. There is no performance benefit to either. 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] [:foo, :bar].filter { |x| x == :foo } #=> [:foo] See also Enumerable#reject, Enumerable#grep. ;T;[o;= ;3I" overload;F;40;;,;50;)I" find_all;T;IC;";T; @;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @;[;I"!@yield [obj] @return [Array];T;0;6i;[; @o;= ;3I" overload;F;40;;¦;50;)I"select;T;IC;";T; @;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @;[;I"!@yield [obj] @return [Array];T;0;6i;[; @o;= ;3I" overload;F;40;;-;50;)I"filter;T;IC;";T; @;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @;[;I"!@yield [obj] @return [Array];T;0;6i;[; @o;= ;3I" overload;F;40;;,;50;)I" find_all;T;IC;";T; @;>0;!F;[;[;I";T;0;6i;[; @o;= ;3I" overload;F;40;;¦;50;)I"select;T;IC;";T; @;>0;!F;[;[;I";T;0;6i;[; @o;= ;3I" overload;F;40;;-;50;)I"filter;T;IC;";T; @;>0;!F;[;[;I";T;0;6i;[; @;[;@;0; @;!F;"o;#;$T;%iÃ;&ià;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#filter;F;[;[[@_iÞ;T;;-;0;[;{;IC;"ÞReturns an array containing all elements of +enum+ for which the given +block+ returns a true value. The find_all and select methods are aliases. There is no performance benefit to either. 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] [:foo, :bar].filter { |x| x == :foo } #=> [:foo] See also Enumerable#reject, Enumerable#grep. ;T;[o;= ;3I" overload;F;40;;,;50;)I" find_all;T;IC;";T; @n;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @no;2 ;3I"return;F;4I";T;0;5[I" Array;T; @n;[;I"!@yield [obj] @return [Array];T;0;6i;[; @no;= ;3I" overload;F;40;;¦;50;)I"select;T;IC;";T; @n;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @no;2 ;3I"return;F;4I";T;0;5[I" Array;T; @n;[;I"!@yield [obj] @return [Array];T;0;6i;[; @no;= ;3I" overload;F;40;;-;50;)I"filter;T;IC;";T; @n;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @no;2 ;3I"return;F;4I";T;0;5[I" Array;T; @n;[;I"!@yield [obj] @return [Array];T;0;6i;[; @no;= ;3I" overload;F;40;;,;50;)I" find_all;T;IC;";T; @n;>0;!F;[;[;I";T;0;6i;[; @no;= ;3I" overload;F;40;;¦;50;)I"select;T;IC;";T; @n;>0;!F;[;[;I";T;0;6i;[; @no;= ;3I" overload;F;40;;-;50;)I"filter;T;IC;";T; @n;>0;!F;[;[;I";T;0;6i;[; @n;[;@;0; @n;!F;"o;#;$T;%iÃ;&ià;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#filter_map;F;[;[[@_i;T;:filter_map;0;[;{;IC;"Returns a new array containing the truthy results (everything except +false+ or +nil+) of running the +block+ for every element in +enum+. If no block is given, an Enumerator is returned instead. (1..10).filter_map { |i| i * 2 if i.even? } #=> [4, 8, 12, 16, 20] ;T;[o;= ;3I" overload;F;40;;.;50;)I"filter_map;T;IC;";T; @É;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @Éo;2 ;3I"return;F;4I";T;0;5[I" Array;T; @É;[;I"!@yield [obj] @return [Array];T;0;6i;[; @Éo;= ;3I" overload;F;40;;.;50;)I"filter_map;T;IC;";T; @É;>0;!F;[;[;I";T;0;6i;[; @É;[;I"ZReturns a new array containing the truthy results (everything except +false+ or +nil+) of running the +block+ for every element in +enum+. If no block is given, an Enumerator is returned instead. (1..10).filter_map { |i| i * 2 if i.even? } #=> [4, 8, 12, 16, 20] @overload filter_map @yield [obj] @return [Array] @overload filter_map;T;0; @É;!F;"o;#;$T;%i÷;&i;'@(;(I"Òstatic VALUE enum_filter_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, filter_map_i, ary); return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#reject;F;[;[[@_i/;T;:reject;0;[;{;IC;"=Returns 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;= ;3I" overload;F;40;;/;50;)I"reject;T;IC;";T; @ñ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @ño;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ñ;[;I"!@yield [obj] @return [Array];T;0;6i;[; @ño;= ;3I" overload;F;40;;/;50;)I"reject;T;IC;";T; @ñ;>0;!F;[;[;I";T;0;6i;[; @ñ;[;I"‚Returns 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; @ñ;!F;"o;#;$T;%i;&i-;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#collect;F;[;[[@_i];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;= ;3I" overload;F;40;;0;50;)I"collect;T;IC;";T; @;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @;[;I"!@yield [obj] @return [Array];T;0;6i;[; @o;= ;3I" overload;F;40;:map;50;)I"map;T;IC;";T; @;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @;[;I"!@yield [obj] @return [Array];T;0;6i;[; @o;= ;3I" overload;F;40;;0;50;)I"collect;T;IC;";T; @;>0;!F;[;[;I";T;0;6i;[; @o;= ;3I" overload;F;40;;1;50;)I"map;T;IC;";T; @;>0;!F;[;[;I";T;0;6i;[; @;[;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; @;!F;"o;#;$T;%iL;&i];'@(;(I"/static VALUE enum_collect(VALUE obj) { VALUE ary; int min_argc, max_argc; RETURN_SIZED_ENUMERATOR(obj, 0, 0, enum_size); ary = rb_ary_new(); min_argc = rb_block_min_max_arity(&max_argc); rb_lambda_call(obj, id_each, 0, 0, collect_i, min_argc, max_argc, ary); return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#map;F;[;[[@_i];T;;1;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;= ;3I" overload;F;40;;0;50;)I"collect;T;IC;";T; @[;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @[;[;I"!@yield [obj] @return [Array];T;0;6i;[; @[o;= ;3I" overload;F;40;;1;50;)I"map;T;IC;";T; @[;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @[;[;I"!@yield [obj] @return [Array];T;0;6i;[; @[o;= ;3I" overload;F;40;;0;50;)I"collect;T;IC;";T; @[;>0;!F;[;[;I";T;0;6i;[; @[o;= ;3I" overload;F;40;;1;50;)I"map;T;IC;";T; @[;>0;!F;[;[;I";T;0;6i;[; @[;[;@W;0; @[;!F;"o;#;$T;%iL;&i];'@(;(I"/static VALUE enum_collect(VALUE obj) { VALUE ary; int min_argc, max_argc; RETURN_SIZED_ENUMERATOR(obj, 0, 0, enum_size); ary = rb_ary_new(); min_argc = rb_block_min_max_arity(&max_argc); rb_lambda_call(obj, id_each, 0, 0, collect_i, min_argc, max_argc, ary); return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#flat_map;F;[;[[@_iŽ;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;= ;3I" overload;F;40;;2;50;)I" flat_map;T;IC;";T; @œ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @œo;2 ;3I"return;F;4I";T;0;5[I" Array;T; @œ;[;I"!@yield [obj] @return [Array];T;0;6i;[; @œo;= ;3I" overload;F;40;:collect_concat;50;)I"collect_concat;T;IC;";T; @œ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @œo;2 ;3I"return;F;4I";T;0;5[I" Array;T; @œ;[;I"!@yield [obj] @return [Array];T;0;6i;[; @œo;= ;3I" overload;F;40;;2;50;)I" flat_map;T;IC;";T; @œ;>0;!F;[;[;I";T;0;6i;[; @œo;= ;3I" overload;F;40;;3;50;)I"collect_concat;T;IC;";T; @œ;>0;!F;[;[;I";T;0;6i;[; @œ;[;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; @œ;!F;"o;#;$T;%i};&iŽ;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#collect_concat;F;[;[[@_iŽ;T;;3;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;= ;3I" overload;F;40;;2;50;)I" flat_map;T;IC;";T; @Þ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @Þo;2 ;3I"return;F;4I";T;0;5[I" Array;T; @Þ;[;I"!@yield [obj] @return [Array];T;0;6i;[; @Þo;= ;3I" overload;F;40;;3;50;)I"collect_concat;T;IC;";T; @Þ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @Þo;2 ;3I"return;F;4I";T;0;5[I" Array;T; @Þ;[;I"!@yield [obj] @return [Array];T;0;6i;[; @Þo;= ;3I" overload;F;40;;2;50;)I" flat_map;T;IC;";T; @Þ;>0;!F;[;[;I";T;0;6i;[; @Þo;= ;3I" overload;F;40;;3;50;)I"collect_concat;T;IC;";T; @Þ;>0;!F;[;[;I";T;0;6i;[; @Þ;[;@Ú;0; @Þ;!F;"o;#;$T;%i};&iŽ;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#inject;F;[[@c0;[[@_io;T;:inject;0;[;{;IC;"ICombines all elements of enum by applying a binary operation, specified by a block or a symbol that names a method or operator. The inject and reduce methods are aliases. There is no performance benefit to either. 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;= ;3I" overload;F;40;;4;50;)I"inject(initial, sym);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @;[;I"@return [Object];T;0;6i;[[I"initial;T0[I"sym;T0; @o;= ;3I" overload;F;40;;4;50;)I"inject(sym);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @;[;I"@return [Object];T;0;6i;[[I"sym;T0; @o;= ;3I" overload;F;40;;4;50;)I"inject(initial);T;IC;";T; @;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" memo;TI"obj;T; @o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @;[;I"(@yield [memo, obj] @return [Object];T;0;6i;[[I"initial;T0; @o;= ;3I" overload;F;40;;4;50;)I"inject;T;IC;";T; @;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" memo;TI"obj;T; @o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @;[;I"(@yield [memo, obj] @return [Object];T;0;6i;[; @o;= ;3I" overload;F;40;:reduce;50;)I"reduce(initial, sym);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @;[;I"@return [Object];T;0;6i;[[I"initial;T0[I"sym;T0; @o;= ;3I" overload;F;40;;5;50;)I"reduce(sym);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @;[;I"@return [Object];T;0;6i;[[I"sym;T0; @o;= ;3I" overload;F;40;;5;50;)I"reduce(initial);T;IC;";T; @;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" memo;TI"obj;T; @o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @;[;I"(@yield [memo, obj] @return [Object];T;0;6i;[[I"initial;T0; @o;= ;3I" overload;F;40;;5;50;)I"reduce;T;IC;";T; @;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" memo;TI"obj;T; @o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @;[;I"(@yield [memo, obj] @return [Object];T;0;6i;[; @;[;I"øCombines all elements of enum by applying a binary operation, specified by a block or a symbol that names a method or operator. The inject and reduce methods are aliases. There is no performance benefit to either. 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; @;!F;"o;#;$T;%iA;&ix;'@(;(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; } if (iter == inject_op_i && SYMBOL_P(op) && RB_TYPE_P(obj, T_ARRAY) && rb_method_basic_definition_p(CLASS_OF(obj), id_each)) { return ary_inject_op(obj, init, op); } 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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#reduce;F;[[@c0;[[@_io;T;;5;0;[;{;IC;"ICombines all elements of enum by applying a binary operation, specified by a block or a symbol that names a method or operator. The inject and reduce methods are aliases. There is no performance benefit to either. 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;= ;3I" overload;F;40;;4;50;)I"inject(initial, sym);T;IC;";T; @¾;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @¾;[;I"@return [Object];T;0;6i;[[I"initial;T0[I"sym;T0; @¾o;= ;3I" overload;F;40;;4;50;)I"inject(sym);T;IC;";T; @¾;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @¾;[;I"@return [Object];T;0;6i;[[I"sym;T0; @¾o;= ;3I" overload;F;40;;4;50;)I"inject(initial);T;IC;";T; @¾;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" memo;TI"obj;T; @¾o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @¾;[;I"(@yield [memo, obj] @return [Object];T;0;6i;[[I"initial;T0; @¾o;= ;3I" overload;F;40;;4;50;)I"inject;T;IC;";T; @¾;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" memo;TI"obj;T; @¾o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @¾;[;I"(@yield [memo, obj] @return [Object];T;0;6i;[; @¾o;= ;3I" overload;F;40;;5;50;)I"reduce(initial, sym);T;IC;";T; @¾;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @¾;[;I"@return [Object];T;0;6i;[[I"initial;T0[I"sym;T0; @¾o;= ;3I" overload;F;40;;5;50;)I"reduce(sym);T;IC;";T; @¾;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @¾;[;I"@return [Object];T;0;6i;[[I"sym;T0; @¾o;= ;3I" overload;F;40;;5;50;)I"reduce(initial);T;IC;";T; @¾;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" memo;TI"obj;T; @¾o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @¾;[;I"(@yield [memo, obj] @return [Object];T;0;6i;[[I"initial;T0; @¾o;= ;3I" overload;F;40;;5;50;)I"reduce;T;IC;";T; @¾;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" memo;TI"obj;T; @¾o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @¾;[;I"(@yield [memo, obj] @return [Object];T;0;6i;[; @¾;[;@º;0; @¾;!F;"o;#;$T;%iA;&ix;'@(;(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; } if (iter == inject_op_i && SYMBOL_P(op) && RB_TYPE_P(obj, T_ARRAY) && rb_method_basic_definition_p(CLASS_OF(obj), id_each)) { return ary_inject_op(obj, init, op); } 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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#partition;F;[;[[@_i»;T;:partition;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;= ;3I" overload;F;40;;6;50;)I"partition;T;IC;";T; @\ ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @\ o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @\ ;[;I"!@yield [obj] @return [Array];T;0;6i;[; @\ o;= ;3I" overload;F;40;;6;50;)I"partition;T;IC;";T; @\ ;>0;!F;[;[;I";T;0;6i;[; @\ ;[;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; @\ ;!F;"o;#;$T;%i¬;&i¹;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#group_by;F;[;[[@_ië;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;= ;3I" overload;F;40;;7;50;)I" group_by;T;IC;";T; @„ ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @„ o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @„ ;[;I" @yield [obj] @return [Hash];T;0;6i;[; @„ o;= ;3I" overload;F;40;;7;50;)I" group_by;T;IC;";T; @„ ;>0;!F;[;[;I";T;0;6i;[; @„ ;[;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; @„ ;!F;"o;#;$T;%iÜ;&ié;'@(;(I"static VALUE enum_group_by(VALUE obj) { RETURN_SIZED_ENUMERATOR(obj, 0, 0, enum_size); return enum_hashify(obj, 0, 0, group_by_i); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#tally;F;[;[[@_i;T;: tally;0;[;{;IC;"åTallies the collection, i.e., counts the occurrences of each element. Returns a hash with the elements of the collection as keys and the corresponding counts as values. ["a", "b", "c", "b"].tally #=> {"a"=>1, "b"=>2, "c"=>1} ;T;[o;= ;3I" overload;F;40;;8;50;)I" tally;T;IC;";T; @¬ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @¬ ;[;I"@return [Hash];T;0;6i;[; @¬ ;[;I"Tallies the collection, i.e., counts the occurrences of each element. Returns a hash with the elements of the collection as keys and the corresponding counts as values. ["a", "b", "c", "b"].tally #=> {"a"=>1, "b"=>2, "c"=>1} @overload tally @return [Hash];T;0; @¬ ;!F;"o;#;$T;%i;&i;'@(;(I"Xstatic VALUE enum_tally(VALUE obj) { return enum_hashify(obj, 0, 0, tally_i); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#first;F;[[@c0;[[@_i<;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;= ;3I" overload;F;40;;9;50;)I" first;T;IC;";T; @Ç ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @Ç ;[;I"@return [Object, nil];T;0;6i;[; @Ç o;= ;3I" overload;F;40;;9;50;)I" first(n);T;IC;";T; @Ç ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @Ç ;[;I"@return [Array];T;0;6i;[[I"n;T0; @Ç ;[;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; @Ç ;!F;"o;#;$T;%i+;&i:;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#all?;F;[[@c0;[[@_ia;T;: all?;0;[;{;IC;"LPasses 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+. If instead a pattern is supplied, the method returns whether pattern === element for every collection member. %w[ant bear cat].all? { |word| word.length >= 3 } #=> true %w[ant bear cat].all? { |word| word.length >= 4 } #=> false %w[ant bear cat].all?(/t/) #=> false [1, 2i, 3.14].all?(Numeric) #=> true [nil, true, 99].all? #=> false [].all? #=> true;T;[o;= ;3I" overload;F;40;;:;50;)I" all?;T;IC;";T; @ó ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @ó o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ó ;[;I"#@yield [obj] @return [Boolean];T;0;6i;[; @ó o;= ;3I" overload;F;40;;:;50;)I"all?(pattern);T;IC;";T; @ó ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ó ;[;I"@return [Boolean];T;0;6i;[[I"pattern;T0; @ó ;[;I"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+. If instead a pattern is supplied, the method returns whether pattern === element for every collection member. %w[ant bear cat].all? { |word| word.length >= 3 } #=> true %w[ant bear cat].all? { |word| word.length >= 4 } #=> false %w[ant bear cat].all?(/t/) #=> false [1, 2i, 3.14].all?(Numeric) #=> true [nil, true, 99].all? #=> false [].all? #=> true @overload all? @yield [obj] @return [Boolean] @overload all?(pattern) @return [Boolean];T;0; @ó ;!F;"o;#;$T;%iI;&i`;6i;'@(;(I"Þstatic VALUE enum_all(int argc, VALUE *argv, VALUE obj) { struct MEMO *memo = MEMO_ENUM_NEW(Qtrue); WARN_UNUSED_BLOCK(argc); rb_block_call(obj, id_each, 0, 0, ENUMFUNC(all), (VALUE)memo); return memo->v1; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#any?;F;[[@c0;[[@_i‹;T;: any?;0;[;{;IC;"cPasses 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+. If instead a pattern is supplied, the method returns whether pattern === element for any collection member. %w[ant bear cat].any? { |word| word.length >= 3 } #=> true %w[ant bear cat].any? { |word| word.length >= 4 } #=> true %w[ant bear cat].any?(/d/) #=> false [nil, true, 99].any?(Integer) #=> true [nil, true, 99].any? #=> true [].any? #=> false;T;[o;= ;3I" overload;F;40;;;;50;)I" any?;T;IC;";T; @#!;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @#!o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @#!;[;I"#@yield [obj] @return [Boolean];T;0;6i;[; @#!o;= ;3I" overload;F;40;;;;50;)I"any?(pattern);T;IC;";T; @#!;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @#!;[;I"@return [Boolean];T;0;6i;[[I"pattern;T0; @#!;[;I"Ä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+. If instead a pattern is supplied, the method returns whether pattern === element for any collection member. %w[ant bear cat].any? { |word| word.length >= 3 } #=> true %w[ant bear cat].any? { |word| word.length >= 4 } #=> true %w[ant bear cat].any?(/d/) #=> false [nil, true, 99].any?(Integer) #=> true [nil, true, 99].any? #=> true [].any? #=> false @overload any? @yield [obj] @return [Boolean] @overload any?(pattern) @return [Boolean];T;0; @#!;!F;"o;#;$T;%is;&iŠ;6i;'@(;(I"ßstatic VALUE enum_any(int argc, VALUE *argv, VALUE obj) { struct MEMO *memo = MEMO_ENUM_NEW(Qfalse); WARN_UNUSED_BLOCK(argc); rb_block_call(obj, id_each, 0, 0, ENUMFUNC(any), (VALUE)memo); return memo->v1; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#one?;F;[[@c0;[[@_i˜;T;: one?;0;[;{;IC;"•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. If instead a pattern is supplied, the method returns whether pattern === element for exactly one collection member. %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 %w{ant bear cat}.one?(/t/) #=> false [ nil, true, 99 ].one? #=> false [ nil, true, false ].one? #=> true [ nil, true, 99 ].one?(Integer) #=> true [].one? #=> false;T;[o;= ;3I" overload;F;40;;<;50;)I" one?;T;IC;";T; @S!;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @S!o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @S!;[;I"#@yield [obj] @return [Boolean];T;0;6i;[; @S!o;= ;3I" overload;F;40;;<;50;)I"one?(pattern);T;IC;";T; @S!;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @S!;[;I"@return [Boolean];T;0;6i;[[I"pattern;T0; @S!;[;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. If instead a pattern is supplied, the method returns whether pattern === element for exactly one collection member. %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 %w{ant bear cat}.one?(/t/) #=> false [ nil, true, 99 ].one? #=> false [ nil, true, false ].one? #=> true [ nil, true, 99 ].one?(Integer) #=> true [].one? #=> false @overload one? @yield [obj] @return [Boolean] @overload one?(pattern) @return [Boolean];T;0; @S!;!F;"o;#;$T;%i€;&i˜;6i;'@(;(I"0static VALUE enum_one(int argc, VALUE *argv, VALUE obj) { struct MEMO *memo = MEMO_ENUM_NEW(Qundef); VALUE result; WARN_UNUSED_BLOCK(argc); rb_block_call(obj, id_each, 0, 0, ENUMFUNC(one), (VALUE)memo); result = memo->v1; if (result == Qundef) return Qfalse; return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#none?;F;[[@c0;[[@_iÄ;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. If instead a pattern is supplied, the method returns whether pattern === element for none of the collection members. %w{ant bear cat}.none? { |word| word.length == 5 } #=> true %w{ant bear cat}.none? { |word| word.length >= 4 } #=> false %w{ant bear cat}.none?(/d/) #=> true [1, 3.14, 42].none?(Float) #=> false [].none? #=> true [nil].none? #=> true [nil, false].none? #=> true [nil, false, true].none? #=> false;T;[o;= ;3I" overload;F;40;;=;50;)I" none?;T;IC;";T; @ƒ!;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @ƒ!o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ƒ!;[;I"#@yield [obj] @return [Boolean];T;0;6i;[; @ƒ!o;= ;3I" overload;F;40;;=;50;)I"none?(pattern);T;IC;";T; @ƒ!;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ƒ!;[;I"@return [Boolean];T;0;6i;[[I"pattern;T0; @ƒ!;[;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. If instead a pattern is supplied, the method returns whether pattern === element for none of the collection members. %w{ant bear cat}.none? { |word| word.length == 5 } #=> true %w{ant bear cat}.none? { |word| word.length >= 4 } #=> false %w{ant bear cat}.none?(/d/) #=> true [1, 3.14, 42].none?(Float) #=> false [].none? #=> true [nil].none? #=> true [nil, false].none? #=> true [nil, false, true].none? #=> false @overload none? @yield [obj] @return [Boolean] @overload none?(pattern) @return [Boolean];T;0; @ƒ!;!F;"o;#;$T;%i®;&iÄ;6i;'@(;(I"ástatic VALUE enum_none(int argc, VALUE *argv, VALUE obj) { struct MEMO *memo = MEMO_ENUM_NEW(Qtrue); WARN_UNUSED_BLOCK(argc); rb_block_call(obj, id_each, 0, 0, ENUMFUNC(none), (VALUE)memo); return memo->v1; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#min;F;[[@c0;[[@_i;T;:min;0;[;{;IC;"pReturns the object in _enum_ with the minimum value. The first form assumes all objects implement <=>; 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 a sorted array. a = %w[albatross dog horse] a.min(2) #=> ["albatross", "dog"] a.min(2) {|a, b| a.length <=> b.length } #=> ["dog", "horse"] [5, 1, 3, 4, 2].min(3) #=> [1, 2, 3] ;T;[ o;= ;3I" overload;F;40;;>;50;)I"min;T;IC;";T; @³!;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @³!;[;I"@return [Object];T;0;6i;[; @³!o;= ;3I" overload;F;40;;>;50;)I"min;T;IC;";T; @³!;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"a;TI"b;T; @³!o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @³!;[;I"#@yield [a, b] @return [Object];T;0;6i;[; @³!o;= ;3I" overload;F;40;;>;50;)I"min(n);T;IC;";T; @³!;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @³!;[;I"@return [Array];T;0;6i;[[I"n;T0; @³!o;= ;3I" overload;F;40;;>;50;)I"min(n);T;IC;";T; @³!;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"a;TI"b;T; @³!o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @³!;[;I""@yield [a, b] @return [Array];T;0;6i;[[I"n;T0; @³!;[;I"Returns the object in _enum_ with the minimum value. The first form assumes all objects implement <=>; 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 a sorted array. a = %w[albatross dog horse] a.min(2) #=> ["albatross", "dog"] a.min(2) {|a, b| a.length <=> b.length } #=> ["dog", "horse"] [5, 1, 3, 4, 2].min(3) #=> [1, 2, 3] @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; @³!;!F;"o;#;$T;%iú;&i;'@(;(I"Pstatic VALUE enum_min(int argc, VALUE *argv, VALUE obj) { VALUE memo; struct min_t *m = NEW_CMP_OPT_MEMO(struct min_t, memo); VALUE result; VALUE num; if (rb_check_arity(argc, 0, 1) && !NIL_P(num = argv[0])) return rb_nmin_run(obj, num, 0, 0, 0); m->min = Qundef; m->cmp_opt.opt_methods = 0; m->cmp_opt.opt_inited = 0; if (rb_block_given_p()) { rb_block_call(obj, id_each, 0, 0, min_ii, memo); } else { rb_block_call(obj, id_each, 0, 0, min_i, memo); } result = m->min; if (result == Qundef) return Qnil; return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#max;F;[[@c0;[[@_in;T;:max;0;[;{;IC;"ŠReturns the object in _enum_ with the maximum value. The first form assumes all objects implement <=>; 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, sorted in descending order. a = %w[albatross dog horse] a.max(2) #=> ["horse", "dog"] a.max(2) {|a, b| a.length <=> b.length } #=> ["albatross", "horse"] [5, 1, 3, 4, 2].max(3) #=> [5, 4, 3] ;T;[ o;= ;3I" overload;F;40;;?;50;)I"max;T;IC;";T; @";>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @";[;I"@return [Object];T;0;6i;[; @"o;= ;3I" overload;F;40;;?;50;)I"max;T;IC;";T; @";>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"a;TI"b;T; @"o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @";[;I"#@yield [a, b] @return [Object];T;0;6i;[; @"o;= ;3I" overload;F;40;;?;50;)I"max(n);T;IC;";T; @";>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @";[;I"@return [Array];T;0;6i;[[I"n;T0; @"o;= ;3I" overload;F;40;;?;50;)I"max(n);T;IC;";T; @";>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"a;TI"b;T; @"o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @";[;I""@yield [a, b] @return [Array];T;0;6i;[[I"n;T0; @";[;I"4Returns the object in _enum_ with the maximum value. The first form assumes all objects implement <=>; 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, sorted in descending order. a = %w[albatross dog horse] a.max(2) #=> ["horse", "dog"] a.max(2) {|a, b| a.length <=> b.length } #=> ["albatross", "horse"] [5, 1, 3, 4, 2].max(3) #=> [5, 4, 3] @overload max @return [Object] @overload max @yield [a, b] @return [Object] @overload max(n) @return [Array] @overload max(n) @yield [a, b] @return [Array];T;0; @";!F;"o;#;$T;%iV;&ip;'@(;(I"^static VALUE enum_max(int argc, VALUE *argv, VALUE obj) { VALUE memo; struct max_t *m = NEW_CMP_OPT_MEMO(struct max_t, memo); VALUE result; VALUE num; if (rb_check_arity(argc, 0, 1) && !NIL_P(num = argv[0])) return rb_nmin_run(obj, num, 0, 1, 0); m->max = Qundef; m->cmp_opt.opt_methods = 0; m->cmp_opt.opt_inited = 0; 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 = m->max; if (result == Qundef) return Qnil; return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#minmax;F;[;[[@_i;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 <=>; 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;= ;3I" overload;F;40;;@;50;)I"minmax;T;IC;";T; @Y";>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @Y";[;I"@return [Array];T;0;6i;[; @Y"o;= ;3I" overload;F;40;;@;50;)I"minmax;T;IC;";T; @Y";>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"a;TI"b;T; @Y"o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @Y";[;I""@yield [a, b] @return [Array];T;0;6i;[; @Y";[;I"ÛReturns a two element array which contains the minimum and the maximum value in the enumerable. The first form assumes all objects implement <=>; 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; @Y";!F;"o;#;$T;%iö;&i;'@(;(I"vstatic VALUE enum_minmax(VALUE obj) { VALUE memo; struct minmax_t *m = NEW_CMP_OPT_MEMO(struct minmax_t, memo); m->min = Qundef; m->last = Qundef; m->cmp_opt.opt_methods = 0; m->cmp_opt.opt_inited = 0; if (rb_block_given_p()) { rb_block_call(obj, id_each, 0, 0, minmax_ii, memo); if (m->last != Qundef) minmax_ii_update(m->last, m->last, m); } else { rb_block_call(obj, id_each, 0, 0, minmax_i, 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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#min_by;F;[[@c0;[[@_iK;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. These +n+ elements are sorted by the value from the given block. a = %w[albatross dog horse] p a.min_by(2) {|x| x.length } #=> ["dog", "horse"] ;T;[ o;= ;3I" overload;F;40;;A;50;)I"min_by;T;IC;";T; @‡";>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @‡"o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @‡";[;I""@yield [obj] @return [Object];T;0;6i;[; @‡"o;= ;3I" overload;F;40;;A;50;)I"min_by;T;IC;";T; @‡";>0;!F;[;[;I";T;0;6i;[; @‡"o;= ;3I" overload;F;40;;A;50;)I"min_by(n);T;IC;";T; @‡";>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @‡"o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @‡";[;I"!@yield [obj] @return [Array];T;0;6i;[[I"n;T0; @‡"o;= ;3I" overload;F;40;;A;50;)I"min_by(n);T;IC;";T; @‡";>0;!F;[;[;I";T;0;6i;[[I"n;T0; @‡";[;I"KReturns 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. These +n+ elements are sorted by the value from the given block. 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; @‡";!F;"o;#;$T;%i4;&iK;'@(;(I"static VALUE enum_min_by(int argc, VALUE *argv, VALUE obj) { struct MEMO *memo; VALUE num; rb_check_arity(argc, 0, 1); RETURN_SIZED_ENUMERATOR(obj, argc, argv, enum_size); if (argc && !NIL_P(num = argv[0])) return rb_nmin_run(obj, num, 1, 0, 0); memo = MEMO_NEW(Qundef, Qnil, 0); rb_block_call(obj, id_each, 0, 0, min_by_i, (VALUE)memo); return memo->v2; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#max_by;F;[[@c0;[[@_i¶;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, maximum +n+ elements are returned as an array. These +n+ elements are sorted by the value from the given block, in descending order. 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;= ;3I" overload;F;40;;B;50;)I"max_by;T;IC;";T; @Î";>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @Î"o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @Î";[;I""@yield [obj] @return [Object];T;0;6i;[; @Î"o;= ;3I" overload;F;40;;B;50;)I"max_by;T;IC;";T; @Î";>0;!F;[;[;I";T;0;6i;[; @Î"o;= ;3I" overload;F;40;;B;50;)I"max_by(n);T;IC;";T; @Î";>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @Î"o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @Î";[;I""@yield [obj] @return [Object];T;0;6i;[[I"n;T0; @Î"o;= ;3I" overload;F;40;;B;50;)I"max_by(n);T;IC;";T; @Î";>0;!F;[;[;I";T;0;6i;[[I"n;T0; @Î";[;I"gReturns 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, maximum +n+ elements are returned as an array. These +n+ elements are sorted by the value from the given block, in descending order. 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; @Î";!F;"o;#;$T;%ir;&i¶;'@(;(I"static VALUE enum_max_by(int argc, VALUE *argv, VALUE obj) { struct MEMO *memo; VALUE num; rb_check_arity(argc, 0, 1); RETURN_SIZED_ENUMERATOR(obj, argc, argv, enum_size); if (argc && !NIL_P(num = argv[0])) return rb_nmin_run(obj, num, 1, 1, 0); memo = MEMO_NEW(Qundef, Qnil, 0); rb_block_call(obj, id_each, 0, 0, max_by_i, (VALUE)memo); return memo->v2; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#minmax_by;F;[;[[@_i ;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;= ;3I" overload;F;40;;C;50;)I"minmax_by;T;IC;";T; @#;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @#o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @#;[;I"!@yield [obj] @return [Array];T;0;6i;[; @#o;= ;3I" overload;F;40;;C;50;)I"minmax_by;T;IC;";T; @#;>0;!F;[;[;I";T;0;6i;[; @#;[;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; @#;!F;"o;#;$T;%i ;&i ;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#member?;F;[[I"val;T0;[[@_iP ;T;:member?;0;[;{;IC;"öReturns true if any member of enum equals obj. Equality is tested using ==. (1..10).include? 5 #=> true (1..10).include? 15 #=> false (1..10).member? 5 #=> true (1..10).member? 15 #=> false;T;[o;= ;3I" overload;F;40;: include?;50;)I"include?(obj);T;IC;";T; @=#;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @=#;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @=#o;= ;3I" overload;F;40;;D;50;)I"member?(obj);T;IC;";T; @=#;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @=#;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @=#;[;I"PReturns true if any member of enum equals obj. Equality is tested using ==. (1..10).include? 5 #=> true (1..10).include? 15 #=> false (1..10).member? 5 #=> true (1..10).member? 15 #=> false @overload include?(obj) @return [Boolean] @overload member?(obj) @return [Boolean];T;0; @=#;!F;"o;#;$T;%iA ;&iN ;6i;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#include?;F;[[I"val;T0;[[@_iP ;T;;E;0;[;{;IC;"öReturns true if any member of enum equals obj. Equality is tested using ==. (1..10).include? 5 #=> true (1..10).include? 15 #=> false (1..10).member? 5 #=> true (1..10).member? 15 #=> false;T;[o;= ;3I" overload;F;40;;E;50;)I"include?(obj);T;IC;";T; @k#;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @k#;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @k#o;= ;3I" overload;F;40;;D;50;)I"member?(obj);T;IC;";T; @k#;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @k#;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @k#;[;@g#;0; @k#;!F;"o;#;$T;%iA ;&iN ;6i;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#each_with_index;F;[[@c0;[[@_iv ;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;= ;3I" overload;F;40;;F;50;)I"each_with_index(*args);T;IC;";T; @˜#;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;TI"i;T; @˜#o;2 ;3I"return;F;4I";T;0;5[I"Enumerator;T; @˜#;[;I")@yield [obj, i] @return [Enumerator];T;0;6i;[[I" *args;T0; @˜#o;= ;3I" overload;F;40;;F;50;)I"each_with_index(*args);T;IC;";T; @˜#;>0;!F;[;[;I";T;0;6i;[[I" *args;T0; @˜#;[;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; @˜#;!F;"o;#;$T;%ic ;&it ;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#reverse_each;F;[[@c0;[[@_i• ;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;= ;3I" overload;F;40;;G;50;)I"reverse_each(*args);T;IC;";T; @Æ#;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" item;T; @Æ#o;2 ;3I"return;F;4I";T;0;5[I"Enumerator;T; @Æ#;[;I"'@yield [item] @return [Enumerator];T;0;6i;[[I" *args;T0; @Æ#o;= ;3I" overload;F;40;;G;50;)I"reverse_each(*args);T;IC;";T; @Æ#;>0;!F;[;[;I";T;0;6i;[[I" *args;T0; @Æ#;[;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; @Æ#;!F;"o;#;$T;%iƒ ;&i“ ;'@(;(I"¡static VALUE enum_reverse_each(int argc, VALUE *argv, VALUE obj) { VALUE ary; long len; RETURN_SIZED_ENUMERATOR(obj, argc, argv, enum_size); ary = enum_to_a(argc, argv, obj); len = RARRAY_LEN(ary); while (len--) { long nlen; rb_yield(RARRAY_AREF(ary, len)); nlen = RARRAY_LEN(ary); if (nlen < len) { len = nlen; } } return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#each_entry;F;[[@c0;[[@_iÒ ;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;= ;3I" overload;F;40;;H;50;)I"each_entry;T;IC;";T; @ó#;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @ó#o;2 ;3I"return;F;4I";T;0;5[I"Enumerator;T; @ó#;[;I"&@yield [obj] @return [Enumerator];T;0;6i;[; @ó#o;= ;3I" overload;F;40;;H;50;)I"each_entry;T;IC;";T; @ó#;>0;!F;[;[;I";T;0;6i;[; @ó#;[;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; @ó#;!F;"o;#;$T;%iµ ;&iÐ ;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#each_slice;F;[[I"n;T0;[[@_i( ;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;= ;3I" overload;F;40;;I;50;)I"each_slice(n);T;IC;";T; @$;>0;!F;[o;2 ;3I" yield;F;4I"[];T;0;50; @$o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @$;[;I"@yield [] @return [nil];T;0;6i;[[I"n;T0; @$o;= ;3I" overload;F;40;;I;50;)I"each_slice(n);T;IC;";T; @$;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @$;[;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; @$;!F;"o;#;$T;%i ;&i' ;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#each_cons;F;[[I"n;T0;[[@_ix ;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;= ;3I" overload;F;40;;J;50;)I"each_cons(n);T;IC;";T; @H$;>0;!F;[o;2 ;3I" yield;F;4I"[];T;0;50; @H$o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @H$;[;I"@yield [] @return [nil];T;0;6i;[[I"n;T0; @H$o;= ;3I" overload;F;40;;J;50;)I"each_cons(n);T;IC;";T; @H$;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @H$;[;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; @H$;!F;"o;#;$T;%ic ;&iw ;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I" Enumerable#each_with_object;F;[[I" memo;T0;[[@_iž ;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;= ;3I" overload;F;40;;K;50;)I"each_with_object(obj);T;IC;";T; @t$;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"(*args);TI" memo_obj;T; @t$o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @t$;[;I"0@yield [(*args), memo_obj] @return [Object];T;0;6i;[[I"obj;T0; @t$o;= ;3I" overload;F;40;;K;50;)I"each_with_object(obj);T;IC;";T; @t$;>0;!F;[;[;I";T;0;6i;[[I"obj;T0; @t$;[;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; @t$;!F;"o;#;$T;%i ;&i ;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#zip;F;[[@c0;[[@_i;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;= ;3I" overload;F;40;;L;50;)I"zip(arg, ...);T;IC;";T; @£$;>0;!F;[;[;I";T;0;6i;[[I"arg;T0[I"...;T0; @£$o;= ;3I" overload;F;40;;L;50;)I"zip(arg, ...);T;IC;";T; @£$;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"arr;T; @£$o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @£$;[;I"@yield [arr] @return [nil];T;0;6i;[[I"arg;T0[I"...;T0; @£$;[;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; @£$;!F;"o;#;$T;%iÿ ;&i;'@(;(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;= ;3I" overload;F;40;;M;50;)I"take(n);T;IC;";T; @Ô$;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @Ô$;[;I"@return [Array];T;0;6i;[[I"n;T0; @Ô$;[;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; @Ô$;!F;"o;#;$T;%iM;&iV;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#take_while;F;[;[[@_iƒ;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;= ;3I" overload;F;40;;N;50;)I"take_while;T;IC;";T; @ó$;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @ó$o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ó$;[;I"!@yield [obj] @return [Array];T;0;6i;[; @ó$o;= ;3I" overload;F;40;;N;50;)I"take_while;T;IC;";T; @ó$;>0;!F;[;[;I";T;0;6i;[; @ó$;[;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 [obj] @return [Array] @overload take_while;T;0; @ó$;!F;"o;#;$T;%it;&i;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#drop;F;[[I"n;T0;[[@_i§;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;= ;3I" overload;F;40;;O;50;)I"drop(n);T;IC;";T; @%;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @%;[;I"@return [Array];T;0;6i;[[I"n;T0; @%;[;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; @%;!F;"o;#;$T;%i›;&i¤;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#drop_while;F;[;[[@_iØ;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;= ;3I" overload;F;40;;P;50;)I"drop_while;T;IC;";T; @:%;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @:%o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @:%;[;I"!@yield [obj] @return [Array];T;0;6i;[; @:%o;= ;3I" overload;F;40;;P;50;)I"drop_while;T;IC;";T; @:%;>0;!F;[;[;I";T;0;6i;[; @:%;[;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 [obj] @return [Array] @overload drop_while;T;0; @:%;!F;"o;#;$T;%iÈ;&iÖ;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#cycle;F;[[@c0;[[@_i;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;= ;3I" overload;F;40;;Q;50;)I"cycle(n=nil);T;IC;";T; @b%;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @b%o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @b%;[;I"@yield [obj] @return [nil];T;0;6i;[[I"n;TI"nil;T; @b%o;= ;3I" overload;F;40;;Q;50;)I"cycle(n=nil);T;IC;";T; @b%;>0;!F;[;[;I";T;0;6i;[[I"n;TI"nil;T; @b%;[;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; @b%;!F;"o;#;$T;%i;&i;'@(;(I"static VALUE enum_cycle(int argc, VALUE *argv, VALUE obj) { VALUE ary; VALUE nv = Qnil; long n, i, len; rb_check_arity(argc, 0, 1); RETURN_SIZED_ENUMERATOR(obj, argc, argv, enum_cycle_size); if (!argc || NIL_P(nv = argv[0])) { 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.upcase.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 } } If no block is given, an enumerator to `chunk` is returned instead. ;T;[o;= ;3I" overload;F;40;;R;50;)I" chunk;T;IC;";T; @‘%;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"elt;T; @‘%;[;I"@yield [elt];T;0;6i;[; @‘%;[;I" 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.upcase.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 } } If no block is given, an enumerator to `chunk` is returned instead. @overload chunk @yield [elt];T;0; @‘%;!F;"o;#;$T;%i‡;&iÝ;'@(;(I"¢static VALUE enum_chunk(VALUE enumerable) { VALUE enumerator; RETURN_SIZED_ENUMERATOR(enumerable, 0, 0, enum_size); 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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#slice_before;F;[[@c0;[[@_i´ ;T;:slice_before;0;[;{;IC;"€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 +to_a+, +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 (see +chunk_while+ for a better way): 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| emp = true f.slice_before { |line| prevemp = emp emp = line == "\n" prevemp && line.start_with?("From ") }.each { |mail| mail.pop if mail.last == "\n" pp mail } } ;T;[o;= ;3I" overload;F;40;;S;50;)I"slice_before(pattern);T;IC;";T; @¬%;>0;!F;[;[;I";T;0;6i;[[I"pattern;T0; @¬%o;= ;3I" overload;F;40;;S;50;)I"slice_before;T;IC;";T; @¬%;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"elt;T; @¬%;[;I"@yield [elt];T;0;6i;[; @¬%;[;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 +to_a+, +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 (see +chunk_while+ for a better way): 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| emp = true f.slice_before { |line| prevemp = emp 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; @¬%;!F;"o;#;$T;%i$ ;&i² ;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#slice_after;F;[[@c0;[[@_i.;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;= ;3I" overload;F;40;;T;50;)I"slice_after(pattern);T;IC;";T; @Ò%;>0;!F;[;[;I";T;0;6i;[[I"pattern;T0; @Ò%o;= ;3I" overload;F;40;;T;50;)I"slice_after;T;IC;";T; @Ò%;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"elt;T; @Ò%;[;I"@yield [elt];T;0;6i;[; @Ò%;[;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; @Ò%;!F;"o;#;$T;%i ;&i+;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#slice_when;F;[;[[@_iË;T;:slice_when;0;[;{;IC;"VCreates an enumerator for each chunked elements. The beginnings of chunks are defined by the block. This method splits 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"]] Enumerable#chunk_while does the same, except splitting when the block returns false instead of true. ;T;[o;= ;3I" overload;F;40;;U;50;)I"slice_when;T;IC;";T; @ø%;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"elt_before;TI"elt_after;T; @ø%;[;I"#@yield [elt_before, elt_after];T;0;6i;[; @ø%;[;I"ŽCreates an enumerator for each chunked elements. The beginnings of chunks are defined by the block. This method splits 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"]] Enumerable#chunk_while does the same, except splitting when the block returns false instead of true. @overload slice_when @yield [elt_before, elt_after];T;0; @ø%;!F;"o;#;$T;%i;&iÉ;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#chunk_while;F;[;[[@_i ;T;:chunk_while;0;[;{;IC;"QCreates an enumerator for each chunked elements. The beginnings of chunks are defined by the block. This method splits 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]] Enumerable#slice_when does the same, except splitting when the block returns true instead of false. ;T;[o;= ;3I" overload;F;40;;V;50;)I"chunk_while;T;IC;";T; @&;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"elt_before;TI"elt_after;T; @&;[;I"#@yield [elt_before, elt_after];T;0;6i;[; @&;[;I"ŠCreates an enumerator for each chunked elements. The beginnings of chunks are defined by the block. This method splits 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]] Enumerable#slice_when does the same, except splitting when the block returns true instead of false. @overload chunk_while @yield [elt_before, elt_after];T;0; @&;!F;"o;#;$T;%iÜ;&i;'@(;(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;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#sum;F;[[@c0;[[@_iý;T;:sum;0;[;{;IC;"rReturns the sum of elements in an Enumerable. If a block is given, the block is applied to each element before addition. If enum is empty, it returns init. For example: { 1 => 10, 2 => 20 }.sum {|k, v| k * v } #=> 50 (1..10).sum #=> 55 (1..10).sum {|v| v * 2 } #=> 110 ('a'..'z').sum #=> TypeError This method can be used for non-numeric objects by explicit init argument. { 1 => 10, 2 => 20 }.sum([]) #=> [1, 10, 2, 20] "a\nb\nc".each_line.lazy.map(&:chomp).sum("") #=> "abc" If the method is applied to an Integer range without a block, the sum is not done by iteration, but instead using Gauss's summation formula. Enumerable#sum method may not respect method redefinition of "+" methods such as Integer#+, or "each" methods such as Range#each. ;T;[o;= ;3I" overload;F;40;;W;50;)I"sum(init=0);T;IC;";T; @0&;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @0&;[;I"@return [Numeric];T;0;6i;[[I" init;TI"0;T; @0&o;= ;3I" overload;F;40;;W;50;)I"sum(init=0);T;IC;";T; @0&;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"e;T; @0&o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @0&;[;I"!@yield [e] @return [Numeric];T;0;6i;[[I" init;TI"0;T; @0&;[;I"ÕReturns the sum of elements in an Enumerable. If a block is given, the block is applied to each element before addition. If enum is empty, it returns init. For example: { 1 => 10, 2 => 20 }.sum {|k, v| k * v } #=> 50 (1..10).sum #=> 55 (1..10).sum {|v| v * 2 } #=> 110 ('a'..'z').sum #=> TypeError This method can be used for non-numeric objects by explicit init argument. { 1 => 10, 2 => 20 }.sum([]) #=> [1, 10, 2, 20] "a\nb\nc".each_line.lazy.map(&:chomp).sum("") #=> "abc" If the method is applied to an Integer range without a block, the sum is not done by iteration, but instead using Gauss's summation formula. Enumerable#sum method may not respect method redefinition of "+" methods such as Integer#+, or "each" methods such as Range#each. @overload sum(init=0) @return [Numeric] @overload sum(init=0) @yield [e] @return [Numeric];T;0; @0&;!F;"o;#;$T;%iÝ;&iý;'@(;(I"static VALUE enum_sum(int argc, VALUE* argv, VALUE obj) { struct enum_sum_memo memo; VALUE beg, end; int excl; memo.v = (rb_check_arity(argc, 0, 1) == 0) ? LONG2FIX(0) : argv[0]; memo.block_given = rb_block_given_p(); memo.n = 0; memo.r = Qundef; if ((memo.float_value = RB_FLOAT_TYPE_P(memo.v))) { memo.f = RFLOAT_VALUE(memo.v); memo.c = 0.0; } else { memo.f = 0.0; memo.c = 0.0; } if (RTEST(rb_range_values(obj, &beg, &end, &excl))) { if (!memo.block_given && !memo.float_value && (FIXNUM_P(beg) || RB_TYPE_P(beg, T_BIGNUM)) && (FIXNUM_P(end) || RB_TYPE_P(end, T_BIGNUM))) { return int_range_sum(beg, end, excl, memo.v); } } if (RB_TYPE_P(obj, T_HASH) && rb_method_basic_definition_p(CLASS_OF(obj), id_each)) hash_sum(obj, &memo); else rb_block_call(obj, id_each, 0, 0, enum_sum_i, (VALUE)&memo); if (memo.float_value) { return DBL2NUM(memo.f + memo.c); } else { if (memo.n != 0) memo.v = rb_fix_plus(LONG2FIX(memo.n), memo.v); if (memo.r != Qundef) { memo.v = rb_rational_plus(memo.r, memo.v); } return memo.v; } };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerable#uniq;F;[;[[@_iG;T;: uniq;0;[;{;IC;"VReturns a new array by removing duplicate values in +self+. See also Array#uniq. ;T;[o;= ;3I" overload;F;40;;X;50;)I" uniq;T;IC;";T; @d&;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @d&;[;I"@return [Array];T;0;6i;[; @d&o;= ;3I" overload;F;40;;X;50;)I" uniq;T;IC;";T; @d&;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" item;T; @d&o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @d&;[;I""@yield [item] @return [Array];T;0;6i;[; @d&;[;I"¥Returns a new array by removing duplicate values in +self+. See also Array#uniq. @overload uniq @return [Array] @overload uniq @yield [item] @return [Array];T;0; @d&;!F;"o;#;$T;%i=;&iF;'@(;(I"0static VALUE enum_uniq(VALUE obj) { VALUE hash, ret; rb_block_call_func *const func = rb_block_given_p() ? uniq_iter : uniq_func; hash = rb_obj_hide(rb_hash_new()); rb_block_call(obj, id_each, 0, 0, func, hash); ret = rb_hash_values(hash); rb_hash_clear(hash); return ret; };T;)I"static VALUE;T;*T;A@(;BIC;[;A@(;CIC;[;A@(;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@_ib;F;;;;K;;;[;{;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; @(;!F;"o;#;$T;%iU;&i\;'@;I"Enumerable;F;R0;A@™;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@iÎ[@iÚ;T;:GzipReader;;K;;;[;{;IC;"ˆZlib::GzipReader is the class for reading a gzipped file. GzipReader should be used as an IO, or -IO-like, object. Zlib::GzipReader.open('hoge.gz') {|gz| print gz.read } File.open('hoge.gz') do |f| gz = Zlib::GzipReader.new(f) print gz.read gz.close end == Method Catalogue The following methods in Zlib::GzipReader are just like their counterparts in IO, but they raise Zlib::Error or Zlib::GzipFile::Error exception if an error was found in the gzip file. - #each - #each_line - #each_byte - #gets - #getc - #lineno - #lineno= - #read - #readchar - #readline - #readlines - #ungetc Be careful of the footer of the gzip file. A gzip file has the checksum of pre-compressed data in its footer. GzipReader checks all uncompressed data against that checksum at the following cases, and if it fails, raises Zlib::GzipFile::NoFooter, Zlib::GzipFile::CRCError, or Zlib::GzipFile::LengthError exception. - When an reading request is received beyond the end of file (the end of compressed data). That is, when Zlib::GzipReader#read, Zlib::GzipReader#gets, or some other methods for reading returns nil. - When Zlib::GzipFile#close method is called after the object reaches the end of file. - When Zlib::GzipReader#unused method is called after the object reaches the end of file. The rest of the methods are adequately described in their own documentation.;T;[;[;I"Š Zlib::GzipReader is the class for reading a gzipped file. GzipReader should be used as an IO, or -IO-like, object. Zlib::GzipReader.open('hoge.gz') {|gz| print gz.read } File.open('hoge.gz') do |f| gz = Zlib::GzipReader.new(f) print gz.read gz.close end == Method Catalogue The following methods in Zlib::GzipReader are just like their counterparts in IO, but they raise Zlib::Error or Zlib::GzipFile::Error exception if an error was found in the gzip file. - #each - #each_line - #each_byte - #gets - #getc - #lineno - #lineno= - #read - #readchar - #readline - #readlines - #ungetc Be careful of the footer of the gzip file. A gzip file has the checksum of pre-compressed data in its footer. GzipReader checks all uncompressed data against that checksum at the following cases, and if it fails, raises Zlib::GzipFile::NoFooter, Zlib::GzipFile::CRCError, or Zlib::GzipFile::LengthError exception. - When an reading request is received beyond the end of file (the end of compressed data). That is, when Zlib::GzipReader#read, Zlib::GzipReader#gets, or some other methods for reading returns nil. - When Zlib::GzipFile#close method is called after the object reaches the end of file. - When Zlib::GzipReader#unused method is called after the object reaches the end of file. The rest of the methods are adequately described in their own documentation. ;T;0; @™;!F;"o;#;$T;%iÎ;&iþ;6i;'o;L;M0;N0;O0;;P;'@;Q@;R0;I"Zlib::GzipReader;F;S@¦@×o; ;IC;[;A@³&;BIC;[;A@³&;CIC;[;A@³&;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@iY[@i;T;:StreamEnd;;K;;;[;{;IC;"¦Subclass of Zlib::Error When zlib returns a Z_STREAM_END is return if the end of the compressed data has been reached and all uncompressed out put has been produced. ;T;[;[;I"© Subclass of Zlib::Error When zlib returns a Z_STREAM_END is return if the end of the compressed data has been reached and all uncompressed out put has been produced. ;T;0; @³&;!F;"o;#;$T;%iY;&i`;'@;I"Zlib::StreamEnd;F;S@×o; ;IC;[;A@Ç&;BIC;[;A@Ç&;CIC;[;A@Ç&;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@id[@i;T;: NeedDict;;K;;;[;{;IC;"¡Subclass of Zlib::Error When zlib returns a Z_NEED_DICT if a preset dictionary is needed at this point. Used by Zlib::Inflate.inflate and Zlib.inflate ;T;[;[;I"£ Subclass of Zlib::Error When zlib returns a Z_NEED_DICT if a preset dictionary is needed at this point. Used by Zlib::Inflate.inflate and Zlib.inflate ;T;0; @Ç&;!F;"o;#;$T;%id;&ik;'@;I"Zlib::NeedDict;F;S@×o; ;IC;[;A@Û&;BIC;[;A@Û&;CIC;[;A@Û&;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@i—[@i;T;:DataError;;K;;;[;{;IC;"jSubclass of Zlib::Error when zlib returns a Z_DATA_ERROR. Usually if a stream was prematurely freed. ;T;[;[;I"m Subclass of Zlib::Error when zlib returns a Z_DATA_ERROR. Usually if a stream was prematurely freed. ;T;0; @Û&;!F;"o;#;$T;%i—;&iœ;'@;I"Zlib::DataError;F;S@×o; ;IC;[;A@ï&;BIC;[;A@ï&;CIC;[;A@ï&;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@i„[@i;T;:StreamError;;K;;;[;{;IC;"oSubclass of Zlib::Error When zlib returns a Z_STREAM_ERROR, usually if the stream state was inconsistent. ;T;[;[;I"r Subclass of Zlib::Error When zlib returns a Z_STREAM_ERROR, usually if the stream state was inconsistent. ;T;0; @ï&;!F;"o;#;$T;%i„;&iŠ;'@;I"Zlib::StreamError;F;S@×o; ;IC;[;A@';BIC;[;A@';CIC;[;A@';DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@iz[@i;T;: MemError;;K;;;[;{;IC;"fSubclass of Zlib::Error When zlib returns a Z_MEM_ERROR, usually if there was not enough memory. ;T;[;[;I"i Subclass of Zlib::Error When zlib returns a Z_MEM_ERROR, usually if there was not enough memory. ;T;0; @';!F;"o;#;$T;%iz;&i€;'@;I"Zlib::MemError;F;S@×o; ;IC;[;A@';BIC;[;A@';CIC;[;A@';DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@iŽ[@i;T;: BufError;;K;;;[;{;IC;"bSubclass of Zlib::Error when zlib returns a Z_BUF_ERROR. Usually if no progress is possible. ;T;[;[;I"e Subclass of Zlib::Error when zlib returns a Z_BUF_ERROR. Usually if no progress is possible. ;T;0; @';!F;"o;#;$T;%iŽ;&i“;'@;I"Zlib::BufError;F;S@×o; ;IC;[;A@+';BIC;[;A@+';CIC;[;A@+';DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@io[@i ;T;:VersionError;;K;;;[;{;IC;"™Subclass of Zlib::Error When zlib returns a Z_VERSION_ERROR, usually if the zlib library version is incompatible with the version assumed by the caller. ;T;[;[;I"œ Subclass of Zlib::Error When zlib returns a Z_VERSION_ERROR, usually if the zlib library version is incompatible with the version assumed by the caller. ;T;0; @+';!F;"o;#;$T;%io;&iv;'@;I"Zlib::VersionError;F;S@×o; ;IC;[;A@?';BIC;[;A@?';CIC;[;A@?';DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@i [@i!;T;:InProgressError;;K;;;[;{;IC;"òSubclass of Zlib::Error. This error is raised when the zlib stream is currently in progress. For example: inflater = Zlib::Inflate.new inflater.inflate(compressed) do inflater.inflate(compressed) # Raises Zlib::InProgressError end ;T;[;[;I"ô Subclass of Zlib::Error. This error is raised when the zlib stream is currently in progress. For example: inflater = Zlib::Inflate.new inflater.inflate(compressed) do inflater.inflate(compressed) # Raises Zlib::InProgressError end ;T;0; @?';!F;"o;#;$T;%i ;&iª;'@;I"Zlib::InProgressError;F;S@×o;;F; ;;;Ï;I"Zlib#zlib_version;F;[;[[@iq;T;:zlib_version;0;[;{;IC;"EReturns the string which represents the version of zlib library. ;T; @S';>0;!F;[;[;I"EReturns the string which represents the version of zlib library.;T;0;'@;(I"Ystatic VALUE rb_zlib_version(VALUE klass) { return rb_str_new2(zlibVersion()); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Zlib.zlib_version;F;@U';@V';T;;b;0;@X';{;IC;"EReturns the string which represents the version of zlib library.;T;[;[;I"G Returns the string which represents the version of zlib library. ;T;0; @`';!F;"o;#;$T;%il;∈6i;'@;(@^';)@_';*To;;F; ;;;Ï;I"Zlib#adler32;F;[[@c0;[[@iÂ;T;:adler32;0;[;{;IC;"call-seq: Zlib.adler32(string, adler) Calculates Adler-32 checksum for +string+, and returns updated value of +adler+. If +string+ is omitted, it returns the Adler-32 initial value. If +adler+ is omitted, it assumes that the initial value is given to +adler+. If +string+ is an IO instance, reads from the IO until the IO returns nil and returns Adler-32 of all read data. Example usage: require "zlib" data = "foo" puts "Adler32 checksum: #{Zlib.adler32(data).to_s(16)}" #=> Adler32 checksum: 2820145 ;T; @h';>0;!F;[;[;I"call-seq: Zlib.adler32(string, adler) Calculates Adler-32 checksum for +string+, and returns updated value of +adler+. If +string+ is omitted, it returns the Adler-32 initial value. If +adler+ is omitted, it assumes that the initial value is given to +adler+. If +string+ is an IO instance, reads from the IO until the IO returns nil and returns Adler-32 of all read data. Example usage: require "zlib" data = "foo" puts "Adler32 checksum: #{Zlib.adler32(data).to_s(16)}" #=> Adler32 checksum: 2820145;T;0;'@;(I"vstatic VALUE rb_zlib_adler32(int argc, VALUE *argv, VALUE klass) { return do_checksum(argc, argv, adler32); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Zlib.adler32;F;@j';@l';T;;c;0;@n';{;IC;"call-seq: Zlib.adler32(string, adler) Calculates Adler-32 checksum for +string+, and returns updated value of +adler+. If +string+ is omitted, it returns the Adler-32 initial value. If +adler+ is omitted, it assumes that the initial value is given to +adler+. If +string+ is an IO instance, reads from the IO until the IO returns nil and returns Adler-32 of all read data. Example usage: require "zlib" data = "foo" puts "Adler32 checksum: #{Zlib.adler32(data).to_s(16)}" #=> Adler32 checksum: 2820145;T;[;[;I" call-seq: Zlib.adler32(string, adler) Calculates Adler-32 checksum for +string+, and returns updated value of +adler+. If +string+ is omitted, it returns the Adler-32 initial value. If +adler+ is omitted, it assumes that the initial value is given to +adler+. If +string+ is an IO instance, reads from the IO until the IO returns nil and returns Adler-32 of all read data. Example usage: require "zlib" data = "foo" puts "Adler32 checksum: #{Zlib.adler32(data).to_s(16)}" #=> Adler32 checksum: 2820145 ;T;0; @v';!F;"o;#;$T;%i®;&i¿;6i;'@;(@t';)@u';*To;;F; ;;;Ï;I"Zlib#adler32_combine;F;[[I"adler1;T0[I"adler2;T0[I" len2;T0;[[@iÓ;T;:adler32_combine;0;[;{;IC;"ïcall-seq: Zlib.adler32_combine(adler1, adler2, len2) Combine two Adler-32 check values in to one. +alder1+ is the first Adler-32 value, +adler2+ is the second Adler-32 value. +len2+ is the length of the string used to generate +adler2+. ;T; @~';>0;!F;[;[;I"ïcall-seq: Zlib.adler32_combine(adler1, adler2, len2) Combine two Adler-32 check values in to one. +alder1+ is the first Adler-32 value, +adler2+ is the second Adler-32 value. +len2+ is the length of the string used to generate +adler2+.;T;0;'@;(I"¼static VALUE rb_zlib_adler32_combine(VALUE klass, VALUE adler1, VALUE adler2, VALUE len2) { return ULONG2NUM( adler32_combine(NUM2ULONG(adler1), NUM2ULONG(adler2), NUM2LONG(len2))); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Zlib.adler32_combine;F;@€';@‡';T;;d;0;@‰';{;IC;"ïcall-seq: Zlib.adler32_combine(adler1, adler2, len2) Combine two Adler-32 check values in to one. +alder1+ is the first Adler-32 value, +adler2+ is the second Adler-32 value. +len2+ is the length of the string used to generate +adler2+.;T;[;[;I"ò call-seq: Zlib.adler32_combine(adler1, adler2, len2) Combine two Adler-32 check values in to one. +alder1+ is the first Adler-32 value, +adler2+ is the second Adler-32 value. +len2+ is the length of the string used to generate +adler2+. ;T;0; @‘';!F;"o;#;$T;%iÉ;&iÐ;6i;'@;(@';)@';*To;;F; ;;;Ï;I"Zlib#crc32;F;[[@c0;[[@iê;T;: crc32;0;[;{;IC;"ycall-seq: Zlib.crc32(string, crc) Calculates CRC checksum for +string+, and returns updated value of +crc+. If +string+ is omitted, it returns the CRC initial value. If +crc+ is omitted, it assumes that the initial value is given to +crc+. If +string+ is an IO instance, reads from the IO until the IO returns nil and returns CRC checksum of all read data. FIXME: expression. ;T; @™';>0;!F;[;[;I"ycall-seq: Zlib.crc32(string, crc) Calculates CRC checksum for +string+, and returns updated value of +crc+. If +string+ is omitted, it returns the CRC initial value. If +crc+ is omitted, it assumes that the initial value is given to +crc+. If +string+ is an IO instance, reads from the IO until the IO returns nil and returns CRC checksum of all read data. FIXME: expression.;T;0;'@;(I"rstatic VALUE rb_zlib_crc32(int argc, VALUE *argv, VALUE klass) { return do_checksum(argc, argv, crc32); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Zlib.crc32;F;@›';@';T;;e;0;@Ÿ';{;IC;"ycall-seq: Zlib.crc32(string, crc) Calculates CRC checksum for +string+, and returns updated value of +crc+. If +string+ is omitted, it returns the CRC initial value. If +crc+ is omitted, it assumes that the initial value is given to +crc+. If +string+ is an IO instance, reads from the IO until the IO returns nil and returns CRC checksum of all read data. FIXME: expression.;T;[;[;I"{ call-seq: Zlib.crc32(string, crc) Calculates CRC checksum for +string+, and returns updated value of +crc+. If +string+ is omitted, it returns the CRC initial value. If +crc+ is omitted, it assumes that the initial value is given to +crc+. If +string+ is an IO instance, reads from the IO until the IO returns nil and returns CRC checksum of all read data. FIXME: expression. ;T;0; @§';!F;"o;#;$T;%iÝ;&iç;6i;'@;(@¥';)@¦';*To;;F; ;;;Ï;I"Zlib#crc32_combine;F;[[I" crc1;T0[I" crc2;T0[I" len2;T0;[[@iû;T;:crc32_combine;0;[;{;IC;"Ýcall-seq: Zlib.crc32_combine(crc1, crc2, len2) Combine two CRC-32 check values in to one. +crc1+ is the first CRC-32 value, +crc2+ is the second CRC-32 value. +len2+ is the length of the string used to generate +crc2+. ;T; @¯';>0;!F;[;[;I"Ýcall-seq: Zlib.crc32_combine(crc1, crc2, len2) Combine two CRC-32 check values in to one. +crc1+ is the first CRC-32 value, +crc2+ is the second CRC-32 value. +len2+ is the length of the string used to generate +crc2+.;T;0;'@;(I"°static VALUE rb_zlib_crc32_combine(VALUE klass, VALUE crc1, VALUE crc2, VALUE len2) { return ULONG2NUM( crc32_combine(NUM2ULONG(crc1), NUM2ULONG(crc2), NUM2LONG(len2))); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Zlib.crc32_combine;F;@±';@¸';T;;f;0;@º';{;IC;"Ýcall-seq: Zlib.crc32_combine(crc1, crc2, len2) Combine two CRC-32 check values in to one. +crc1+ is the first CRC-32 value, +crc2+ is the second CRC-32 value. +len2+ is the length of the string used to generate +crc2+.;T;[;[;I"à call-seq: Zlib.crc32_combine(crc1, crc2, len2) Combine two CRC-32 check values in to one. +crc1+ is the first CRC-32 value, +crc2+ is the second CRC-32 value. +len2+ is the length of the string used to generate +crc2+. ;T;0; @Â';!F;"o;#;$T;%iñ;&iø;6i;'@;(@À';)@Á';*To;;F; ;;;Ï;I"Zlib#crc_table;F;[;[[@i ;T;:crc_table;0;[;{;IC;"@Returns the table for calculating CRC checksum as an array. ;T; @Ê';>0;!F;[;[;I"@Returns the table for calculating CRC checksum as an array.;T;0;'@;(I"ystatic VALUE rb_zlib_crc_table(VALUE obj) { #if !defined(HAVE_TYPE_Z_CRC_T) /* z_crc_t is defined since zlib-1.2.7. */ typedef unsigned long z_crc_t; #endif const z_crc_t *crctbl; VALUE dst; int i; crctbl = get_crc_table(); dst = rb_ary_new2(256); for (i = 0; i < 256; i++) { rb_ary_push(dst, rb_uint2inum(crctbl[i])); } return dst; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Zlib.crc_table;F;@Ì';@Í';T;;g;0;@Ï';{;IC;"@Returns the table for calculating CRC checksum as an array.;T;[;[;I"B Returns the table for calculating CRC checksum as an array. ;T;0; @×';!F;"o;#;$T;%i;&i;6i;'@;(@Õ';)@Ö';*To;{;[[@i+;F;:VERSION;;};;;[;{;IC;""The Ruby/zlib version string. ;T;[;[;I""The Ruby/zlib version string.;T;0; @ß';!F;"o;#;$T;%i*;&i*;'@;I"Zlib::VERSION;F;~I"#rb_str_new2(RUBY_ZLIB_VERSION);To;{;[[@i-;F;:ZLIB_VERSION;;};;;[;{;IC;"6The string which represents the version of zlib.h ;T;[;[;I"6The string which represents the version of zlib.h;T;0; @ë';!F;"o;#;$T;%i,;&i,;'@;I"Zlib::ZLIB_VERSION;F;~I"rb_str_new2(ZLIB_VERSION);To;{;[[@iF;F;:BINARY;;};;;[;{;IC;":Deflate#data_type. ;T;[;[;I":Deflate#data_type.;T;0; @÷';!F;"o;#;$T;%iC;&iE;'@;I"Zlib::BINARY;F;~I"0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @);[;I"@return [String];T;0;6i;[[I"src;T0[I"level:;TI"nil;T[I"strategy:;TI"nil;T; @);[;I"Gzip the given +string+. Valid values of level are Zlib::NO_COMPRESSION, Zlib::BEST_SPEED, Zlib::BEST_COMPRESSION, Zlib::DEFAULT_COMPRESSION (default), or an integer from 0 to 9. This method is almost equivalent to the following code: def gzip(string, level: nil, strategy: nil) sio = StringIO.new sio.binmode gz = Zlib::GzipWriter.new(sio, level, strategy) gz.write(string) gz.close sio.string end See also Zlib.gunzip @overload gzip(src, level: nil, strategy: nil) @return [String];T;0; @);!F;"o;#;$T;%iv;&iŠ;'@;(I"çstatic VALUE zlib_s_gzip(int argc, VALUE *argv, VALUE klass) { struct gzfile gz0; struct gzfile *gz = &gz0; int err; VALUE src, opts, level=Qnil, strategy=Qnil, args[2]; if (OPTHASH_GIVEN_P(opts)) { ID keyword_ids[2]; VALUE kwargs[2]; keyword_ids[0] = id_level; keyword_ids[1] = id_strategy; rb_get_kwargs(opts, keyword_ids, 0, 2, kwargs); if (kwargs[0] != Qundef) { level = kwargs[0]; } if (kwargs[1] != Qundef) { strategy = kwargs[1]; } } rb_scan_args(argc, argv, "10", &src); StringValue(src); gzfile_init(gz, &deflate_funcs, zlib_gzip_end); gz->level = ARG_LEVEL(level); err = deflateInit2(&gz->z.stream, gz->level, Z_DEFLATED, -MAX_WBITS, DEF_MEM_LEVEL, ARG_STRATEGY(strategy)); if (err != Z_OK) { zlib_gzip_end(gz); raise_zlib_error(err, gz->z.stream.msg); } ZSTREAM_READY(&gz->z); args[0] = (VALUE)gz; args[1] = src; return rb_ensure(zlib_gzip_run, (VALUE)args, zlib_gzip_ensure, (VALUE)gz); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Zlib.gunzip;F;[[I"src;T0;[[@iß;T;:gunzip;0;[;{;IC;"Decode the given gzipped +string+. This method is almost equivalent to the following code: def gunzip(string) sio = StringIO.new(string) gz = Zlib::GzipReader.new(sio, encoding: Encoding::ASCII_8BIT) gz.read ensure gz&.close end See also Zlib.gzip ;T;[o;= ;3I" overload;F;40;;;50;)I"gunzip(src);T;IC;";T; @();>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @();[;I"@return [String];T;0;6i;[[I"src;T0; @();[;I";Decode the given gzipped +string+. This method is almost equivalent to the following code: def gunzip(string) sio = StringIO.new(string) gz = Zlib::GzipReader.new(sio, encoding: Encoding::ASCII_8BIT) gz.read ensure gz&.close end See also Zlib.gzip @overload gunzip(src) @return [String];T;0; @();!F;"o;#;$T;%iÍ;&iÝ;'@;(I"Ôstatic VALUE zlib_gunzip(VALUE klass, VALUE src) { struct gzfile gz0; struct gzfile *gz = &gz0; int err; StringValue(src); gzfile_init(gz, &inflate_funcs, zlib_gunzip_end); err = inflateInit2(&gz->z.stream, -MAX_WBITS); if (err != Z_OK) { raise_zlib_error(err, gz->z.stream.msg); } gz->io = Qundef; gz->z.input = src; ZSTREAM_READY(&gz->z); return rb_ensure(zlib_gunzip_run, (VALUE)gz, zlib_gzip_ensure, (VALUE)gz); };T;)I"static VALUE;T;*To;{;[[@i;F;:OS_CODE;;};;;[;{;IC;" The OS code of current host ;T;[;[;I" The OS code of current host;T;0; @G);!F;"o;#;$T;%i;&i;'@;I"Zlib::OS_CODE;F;~I"INT2FIX(OS_CODE);To;{;[[@i;F;: OS_MSDOS;;};;;[;{;IC;"OS code for MSDOS hosts ;T;[;[;I"OS code for MSDOS hosts;T;0; @S);!F;"o;#;$T;%i;&i;'@;I"Zlib::OS_MSDOS;F;~I"INT2FIX(OS_MSDOS);To;{;[[@i!;F;: OS_AMIGA;;};;;[;{;IC;"OS code for Amiga hosts ;T;[;[;I"OS code for Amiga hosts;T;0; @_);!F;"o;#;$T;%i ;&i ;'@;I"Zlib::OS_AMIGA;F;~I"INT2FIX(OS_AMIGA);To;{;[[@i#;F;:OS_VMS;;};;;[;{;IC;"OS code for VMS hosts ;T;[;[;I"OS code for VMS hosts;T;0; @k);!F;"o;#;$T;%i";&i";'@;I"Zlib::OS_VMS;F;~I"INT2FIX(OS_VMS);To;{;[[@i%;F;:OS_UNIX;;};;;[;{;IC;"OS code for UNIX hosts ;T;[;[;I"OS code for UNIX hosts;T;0; @w);!F;"o;#;$T;%i$;&i$;'@;I"Zlib::OS_UNIX;F;~I"INT2FIX(OS_UNIX);To;{;[[@i';F;: OS_ATARI;;};;;[;{;IC;"OS code for Atari hosts ;T;[;[;I"OS code for Atari hosts;T;0; @ƒ);!F;"o;#;$T;%i&;&i&;'@;I"Zlib::OS_ATARI;F;~I"INT2FIX(OS_ATARI);To;{;[[@i);F;:OS_OS2;;};;;[;{;IC;"OS code for OS2 hosts ;T;[;[;I"OS code for OS2 hosts;T;0; @);!F;"o;#;$T;%i(;&i(;'@;I"Zlib::OS_OS2;F;~I"INT2FIX(OS_OS2);To;{;[[@i+;F;: OS_MACOS;;};;;[;{;IC;"OS code for Mac OS hosts ;T;[;[;I"OS code for Mac OS hosts;T;0; @›);!F;"o;#;$T;%i*;&i*;'@;I"Zlib::OS_MACOS;F;~I"INT2FIX(OS_MACOS);To;{;[[@i-;F;:OS_TOPS20;;};;;[;{;IC;"OS code for TOPS-20 hosts ;T;[;[;I"OS code for TOPS-20 hosts;T;0; @§);!F;"o;#;$T;%i,;&i,;'@;I"Zlib::OS_TOPS20;F;~I"INT2FIX(OS_TOPS20);To;{;[[@i/;F;: OS_WIN32;;};;;[;{;IC;"OS code for Win32 hosts ;T;[;[;I"OS code for Win32 hosts;T;0; @³);!F;"o;#;$T;%i.;&i.;'@;I"Zlib::OS_WIN32;F;~I"INT2FIX(OS_WIN32);To;{;[[@i1;F;: OS_VMCMS;;};;;[;{;IC;"OS code for VM OS hosts ;T;[;[;I"OS code for VM OS hosts;T;0; @¿);!F;"o;#;$T;%i0;&i0;'@;I"Zlib::OS_VMCMS;F;~I"INT2FIX(OS_VMCMS);To;{;[[@i3;F;:OS_ZSYSTEM;;};;;[;{;IC;"OS code for Z-System hosts ;T;[;[;I"OS code for Z-System hosts;T;0; @Ë);!F;"o;#;$T;%i2;&i2;'@;I"Zlib::OS_ZSYSTEM;F;~I"INT2FIX(OS_ZSYSTEM);To;{;[[@i5;F;:OS_CPM;;};;;[;{;IC;"OS code for CP/M hosts ;T;[;[;I"OS code for CP/M hosts;T;0; @×);!F;"o;#;$T;%i4;&i4;'@;I"Zlib::OS_CPM;F;~I"INT2FIX(OS_CPM);To;{;[[@i7;F;:OS_QDOS;;};;;[;{;IC;"OS code for QDOS hosts ;T;[;[;I"OS code for QDOS hosts;T;0; @ã);!F;"o;#;$T;%i6;&i6;'@;I"Zlib::OS_QDOS;F;~I"INT2FIX(OS_QDOS);To;{;[[@i9;F;:OS_RISCOS;;};;;[;{;IC;"OS code for RISC OS hosts ;T;[;[;I"OS code for RISC OS hosts;T;0; @ï);!F;"o;#;$T;%i8;&i8;'@;I"Zlib::OS_RISCOS;F;~I"INT2FIX(OS_RISCOS);To;{;[[@i;;F;:OS_UNKNOWN;;};;;[;{;IC;"OS code for unknown hosts ;T;[;[;I"OS code for unknown hosts;T;0; @û);!F;"o;#;$T;%i:;&i:;'@;I"Zlib::OS_UNKNOWN;F;~I"INT2FIX(OS_UNKNOWN);T;A@;BIC;[;A@;CIC;[;A@;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@iæ[@i;T;;P;;K;;;[;{;IC;"ZThis module provides access to the {zlib library}[http://zlib.net]. Zlib is designed to be a portable, free, general-purpose, legally unencumbered -- that is, not covered by any patents -- lossless data-compression library for use on virtually any computer hardware and operating system. The zlib compression library provides in-memory compression and decompression functions, including integrity checks of the uncompressed data. The zlib compressed data format is described in RFC 1950, which is a wrapper around a deflate stream which is described in RFC 1951. The library also supports reading and writing files in gzip (.gz) format with an interface similar to that of IO. The gzip format is described in RFC 1952 which is also a wrapper around a deflate stream. The zlib format was designed to be compact and fast for use in memory and on communications channels. The gzip format was designed for single-file compression on file systems, has a larger header than zlib to maintain directory information, and uses a different, slower check method than zlib. See your system's zlib.h for further information about zlib == Sample usage Using the wrapper to compress strings with default parameters is quite simple: require "zlib" data_to_compress = File.read("don_quixote.txt") puts "Input size: #{data_to_compress.size}" #=> Input size: 2347740 data_compressed = Zlib::Deflate.deflate(data_to_compress) puts "Compressed size: #{data_compressed.size}" #=> Compressed size: 887238 uncompressed_data = Zlib::Inflate.inflate(data_compressed) puts "Uncompressed data is: #{uncompressed_data}" #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote... == Class tree - Zlib::Deflate - Zlib::Inflate - Zlib::ZStream - Zlib::Error - Zlib::StreamEnd - Zlib::NeedDict - Zlib::DataError - Zlib::StreamError - Zlib::MemError - Zlib::BufError - Zlib::VersionError - Zlib::InProgressError (if you have GZIP_SUPPORT) - Zlib::GzipReader - Zlib::GzipWriter - Zlib::GzipFile - Zlib::GzipFile::Error - Zlib::GzipFile::LengthError - Zlib::GzipFile::CRCError - Zlib::GzipFile::NoFooter;T;[;[;I"] This module provides access to the {zlib library}[http://zlib.net]. Zlib is designed to be a portable, free, general-purpose, legally unencumbered -- that is, not covered by any patents -- lossless data-compression library for use on virtually any computer hardware and operating system. The zlib compression library provides in-memory compression and decompression functions, including integrity checks of the uncompressed data. The zlib compressed data format is described in RFC 1950, which is a wrapper around a deflate stream which is described in RFC 1951. The library also supports reading and writing files in gzip (.gz) format with an interface similar to that of IO. The gzip format is described in RFC 1952 which is also a wrapper around a deflate stream. The zlib format was designed to be compact and fast for use in memory and on communications channels. The gzip format was designed for single-file compression on file systems, has a larger header than zlib to maintain directory information, and uses a different, slower check method than zlib. See your system's zlib.h for further information about zlib == Sample usage Using the wrapper to compress strings with default parameters is quite simple: require "zlib" data_to_compress = File.read("don_quixote.txt") puts "Input size: #{data_to_compress.size}" #=> Input size: 2347740 data_compressed = Zlib::Deflate.deflate(data_to_compress) puts "Compressed size: #{data_compressed.size}" #=> Compressed size: 887238 uncompressed_data = Zlib::Inflate.inflate(data_compressed) puts "Uncompressed data is: #{uncompressed_data}" #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote... == Class tree - Zlib::Deflate - Zlib::Inflate - Zlib::ZStream - Zlib::Error - Zlib::StreamEnd - Zlib::NeedDict - Zlib::DataError - Zlib::StreamError - Zlib::MemError - Zlib::BufError - Zlib::VersionError - Zlib::InProgressError (if you have GZIP_SUPPORT) - Zlib::GzipReader - Zlib::GzipWriter - Zlib::GzipFile - Zlib::GzipFile::Error - Zlib::GzipFile::LengthError - Zlib::GzipFile::CRCError - Zlib::GzipFile::NoFooter ;T;0; @;!F;"o;#;$T;%iæ;&i,;6i;'@;I" Zlib;Fo; ;IC;[ˆo;;F; ;;;Ï;I"Process#argv0;F;[;[[I"ruby.c;TiX ;T;: argv0;0;[;{;IC;"ÒReturns the name of the script being executed. The value is not affected by assigning a new value to $0. This method first appeared in Ruby 2.1 to serve as a global variable free means to get the script name. ;T; @*;>0;!F;[o;= ;3I" overload;F;40;;;50;)I" argv0;T;IC;";T; @*;>0;!F;[;[;I";T;0;6i;[; @*;[;I"ãReturns the name of the script being executed. The value is not affected by assigning a new value to $0. This method first appeared in Ruby 2.1 to serve as a global variable free means to get the script name. @overload argv0 ;T;0;'@*;(I"Lstatic VALUE proc_argv0(VALUE process) { return rb_orig_progname; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.argv0;F;@*;@*;T;;;0;@!*;{;IC;"ÒReturns the name of the script being executed. The value is not affected by assigning a new value to $0. This method first appeared in Ruby 2.1 to serve as a global variable free means to get the script name.;T;[o;= ;3I" overload;F;40;;;50;)I" argv0;T;IC;";T; @1*;>0;!F;[;[;I";T;0;6i;[; @1*;[;I"äReturns the name of the script being executed. The value is not affected by assigning a new value to $0. This method first appeared in Ruby 2.1 to serve as a global variable free means to get the script name. @overload argv0;T;0; @1*;!F;"o;#;$T;%iM ;&iT ;6i;'@*;(@/*;)@0*;*To;;F; ;;;Ï;I"Process#setproctitle;F;[[I" title;T0;[[@ *iq ;T;:setproctitle;0;[;{;IC;"ÕSets the process title that appears on the ps(1) command. Not necessarily effective on all platforms. No exception will be raised regardless of the result, nor will NotImplementedError be raised even if the platform does not support the feature. Calling this method does not affect the value of $0. Process.setproctitle('myapp: worker #%d' % worker_id) This method first appeared in Ruby 2.1 to serve as a global variable free means to change the process title. ;T; @A*;>0;!F;[o;= ;3I" overload;F;40;;‘;50;)I"setproctitle(string);T;IC;";T; @A*;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @A*;[;I"@return [String];T;0;6i;[[I"string;T0; @A*;[;I"Sets the process title that appears on the ps(1) command. Not necessarily effective on all platforms. No exception will be raised regardless of the result, nor will NotImplementedError be raised even if the platform does not support the feature. Calling this method does not affect the value of $0. Process.setproctitle('myapp: worker #%d' % worker_id) This method first appeared in Ruby 2.1 to serve as a global variable free means to change the process title. @overload setproctitle(string) @return [String];T;0;'@*;(I"hstatic VALUE proc_setproctitle(VALUE process, VALUE title) { return ruby_setproctitle(title); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.setproctitle;F;@C*;@F*;T;;‘;0;@H*;{;IC;"ÕSets the process title that appears on the ps(1) command. Not necessarily effective on all platforms. No exception will be raised regardless of the result, nor will NotImplementedError be raised even if the platform does not support the feature. Calling this method does not affect the value of $0. Process.setproctitle('myapp: worker #%d' % worker_id) This method first appeared in Ruby 2.1 to serve as a global variable free means to change the process title.;T;[o;= ;3I" overload;F;40;;‘;50;)I"setproctitle(string);T;IC;";T; @_*;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @_*;[;I"@return [String];T;0;6i;[[I"string;T0; @_*;[;I" Sets the process title that appears on the ps(1) command. Not necessarily effective on all platforms. No exception will be raised regardless of the result, nor will NotImplementedError be raised even if the platform does not support the feature. Calling this method does not affect the value of $0. Process.setproctitle('myapp: worker #%d' % worker_id) This method first appeared in Ruby 2.1 to serve as a global variable free means to change the process title. @overload setproctitle(string) @return [String];T;0; @_*;!F;"o;#;$T;%i` ;&in ;6i;'@*;(@]*;)@^*;*To; ;IC;[o;;F; ;F;;;I"Process::Status.wait;F;[[@c0;[[@P i;T;: wait;0;[;{;IC;"Waits for a child process to exit and returns a Process::Status object containing information on that process. Which child it waits on depends on the value of _pid_: > 0:: Waits for the child whose process ID equals _pid_. 0:: Waits for any child whose process group ID equals that of the calling process. -1:: Waits for any child process (the default if no _pid_ is given). < -1:: Waits for any child whose process group ID equals the absolute value of _pid_. The _flags_ argument may be a logical or of the flag values Process::WNOHANG (do not block if no child available) or Process::WUNTRACED (return stopped children that haven't been reported). Not all flags are available on all platforms, but a flag value of zero will work on all platforms. Returns +nil+ if there are no child processes. Not available on all platforms. May invoke the scheduler hook _process_wait_. fork { exit 99 } #=> 27429 Process::Status.wait #=> pid 27429 exit 99 $? #=> nil pid = fork { sleep 3 } #=> 27440 Time.now #=> 2008-03-08 19:56:16 +0900 Process::Status.wait(pid, Process::WNOHANG) #=> nil Time.now #=> 2008-03-08 19:56:16 +0900 Process::Status.wait(pid, 0) #=> pid 27440 exit 99 Time.now #=> 2008-03-08 19:56:19 +0900 This is an EXPERIMENTAL FEATURE. ;T;[o;= ;3I" overload;F;40;:Process::Status.wait;50;)I"*Process::Status.wait(pid=-1, flags=0);T;IC;";T; @x*;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Process::Status;T; @x*;[;I"@return [Process::Status];T;0;6i;[[I"pid;TI"-1;T[I" flags;TI"0;T; @x*;[;I"hWaits for a child process to exit and returns a Process::Status object containing information on that process. Which child it waits on depends on the value of _pid_: > 0:: Waits for the child whose process ID equals _pid_. 0:: Waits for any child whose process group ID equals that of the calling process. -1:: Waits for any child process (the default if no _pid_ is given). < -1:: Waits for any child whose process group ID equals the absolute value of _pid_. The _flags_ argument may be a logical or of the flag values Process::WNOHANG (do not block if no child available) or Process::WUNTRACED (return stopped children that haven't been reported). Not all flags are available on all platforms, but a flag value of zero will work on all platforms. Returns +nil+ if there are no child processes. Not available on all platforms. May invoke the scheduler hook _process_wait_. fork { exit 99 } #=> 27429 Process::Status.wait #=> pid 27429 exit 99 $? #=> nil pid = fork { sleep 3 } #=> 27440 Time.now #=> 2008-03-08 19:56:16 +0900 Process::Status.wait(pid, Process::WNOHANG) #=> nil Time.now #=> 2008-03-08 19:56:16 +0900 Process::Status.wait(pid, 0) #=> pid 27440 exit 99 Time.now #=> 2008-03-08 19:56:19 +0900 This is an EXPERIMENTAL FEATURE. @overload Process::Status.wait(pid=-1, flags=0) @return [Process::Status];T;0; @x*;!F;"o;#;$T;%ic;&iŒ;'@v*;(I":VALUE rb_process_status_waitv(int argc, VALUE *argv, VALUE _) { rb_check_arity(argc, 0, 2); rb_pid_t pid = -1; int flags = 0; if (argc >= 1) { pid = NUM2PIDT(argv[0]); } if (argc >= 2) { flags = RB_NUM2INT(argv[1]); } return rb_process_status_wait(pid, flags); };T;)I" VALUE;T;*To;;F; ;;;;I"Process::Status#==;F;[[I"st2;T0;[[@P iB;T;;`;0;[;{;IC;"IReturns +true+ if the integer value of _stat_ equals other. ;T;[o;= ;3I" overload;F;40;;`;50;)I"==(other);T;IC;";T; @š*;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @š*;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @š*;[;I"sReturns +true+ if the integer value of _stat_ equals other. @overload ==(other) @return [Boolean];T;0; @š*;!F;"o;#;$T;%i:;&i?;'@v*;(I"{static VALUE pst_equal(VALUE st1, VALUE st2) { if (st1 == st2) return Qtrue; return rb_equal(pst_to_i(st1), st2); };T;)I"static VALUE;T;*To;;F; ;;;;I"Process::Status#&;F;[[I"st2;T0;[[@P iV;T;:&;0;[;{;IC;"µLogical AND of the bits in _stat_ with num. fork { exit 0x37 } Process.wait sprintf('%04x', $?.to_i) #=> "3700" sprintf('%04x', $? & 0x1e00) #=> "1600" ;T;[o;= ;3I" overload;F;40;;”;50;)I"&(num);T;IC;";T; @¹*;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¹*;[;I"@return [Integer];T;0;6i;[[I"num;T0; @¹*;[;I"ÜLogical AND of the bits in _stat_ with num. fork { exit 0x37 } Process.wait sprintf('%04x', $?.to_i) #=> "3700" sprintf('%04x', $? & 0x1e00) #=> "1600" @overload &(num) @return [Integer];T;0; @¹*;!F;"o;#;$T;%iJ;&iS;'@v*;(I"|static VALUE pst_bitand(VALUE st1, VALUE st2) { int status = PST2INT(st1) & NUM2INT(st2); return INT2NUM(status); };T;)I"static VALUE;T;*To;;F; ;;;;I"Process::Status#>>;F;[[I"st2;T0;[[@P ik;T;:>>;0;[;{;IC;"±Shift the bits in _stat_ right num places. fork { exit 99 } #=> 26563 Process.wait #=> 26563 $?.to_i #=> 25344 $? >> 8 #=> 99 ;T;[o;= ;3I" overload;F;40;;•;50;)I">>(num);T;IC;";T; @Ø*;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ø*;[;I"@return [Integer];T;0;6i;[[I"num;T0; @Ø*;[;I"ÙShift the bits in _stat_ right num places. fork { exit 99 } #=> 26563 Process.wait #=> 26563 $?.to_i #=> 25344 $? >> 8 #=> 99 @overload >>(num) @return [Integer];T;0; @Ø*;!F;"o;#;$T;%i_;&ih;'@v*;(I"}static VALUE pst_rshift(VALUE st1, VALUE st2) { int status = PST2INT(st1) >> NUM2INT(st2); return INT2NUM(status); };T;)I"static VALUE;T;*To;;F; ;;;;I"Process::Status#to_i;F;[;[[@P i¹;T;: to_i;0;[;{;IC;"ÖReturns the bits in _stat_ as an Integer. Poking around in these bits is platform dependent. fork { exit 0xab } #=> 26566 Process.wait #=> 26566 sprintf('%04x', $?.to_i) #=> "ab00" ;T;[o;= ;3I" overload;F;40;;–;50;)I" to_i;T;IC;";T; @÷*;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @÷*;[;I"@return [Integer];T;0;6i;[; @÷*;[;I"ûReturns the bits in _stat_ as an Integer. Poking around in these bits is platform dependent. fork { exit 0xab } #=> 26566 Process.wait #=> 26566 sprintf('%04x', $?.to_i) #=> "ab00" @overload to_i @return [Integer];T;0; @÷*;!F;"o;#;$T;%i;&i¶;'@v*;(I"lstatic VALUE pst_to_i(VALUE self) { int status = pst_status(self); return RB_INT2NUM(status); };T;)I"static VALUE;T;*To;;F; ;;;;I"Process::Status#to_s;F;[;[[@P i;T;;q;0;[;{;IC;"hShow pid and exit status as a string. system("false") p $?.to_s #=> "pid 12766 exit 1" ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @+;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @+;[;I"@return [String];T;0;6i;[; @+;[;I"ˆShow pid and exit status as a string. system("false") p $?.to_s #=> "pid 12766 exit 1" @overload to_s @return [String];T;0; @+;!F;"o;#;$T;%i;&i;'@v*;(I"×static VALUE pst_to_s(VALUE st) { rb_pid_t pid; int status; VALUE str; pid = pst_pid(st); status = PST2INT(st); str = rb_str_buf_new(0); pst_message(str, pid, status); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"Process::Status#inspect;F;[;[[@P i&;T;;r;0;[;{;IC;"qOverride the inspection method. system("false") p $?.inspect #=> "#" ;T;[o;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @-+;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @-+;[;I"@return [String];T;0;6i;[; @-+;[;I"”Override the inspection method. system("false") p $?.inspect #=> "#" @overload inspect @return [String];T;0; @-+;!F;"o;#;$T;%i;&i#;'@v*;(I"{static VALUE pst_inspect(VALUE st) { rb_pid_t pid; int status; VALUE str; pid = pst_pid(st); if (!pid) { return rb_sprintf("#<%s: uninitialized>", rb_class2name(CLASS_OF(st))); } status = PST2INT(st); str = rb_sprintf("#<%s: ", rb_class2name(CLASS_OF(st))); pst_message(str, pid, status); rb_str_cat2(str, ">"); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"Process::Status#pid;F;[;[[@P iÍ;T;:pid;0;[;{;IC;"’Returns the process ID that this status object represents. fork { exit } #=> 26569 Process.wait #=> 26569 $?.pid #=> 26569 ;T;[o;= ;3I" overload;F;40;;—;50;)I"pid;T;IC;";T; @H+;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @H+;[;I"@return [Integer];T;0;6i;[; @H+;[;I"¶Returns the process ID that this status object represents. fork { exit } #=> 26569 Process.wait #=> 26569 $?.pid #=> 26569 @overload pid @return [Integer];T;0; @H+;!F;"o;#;$T;%iÂ;&iÊ;'@v*;(I"gstatic VALUE pst_pid_m(VALUE self) { rb_pid_t pid = pst_pid(self); return PIDT2NUM(pid); };T;)I"static VALUE;T;*To;;F; ;;;;I"Process::Status#stopped?;F;[;[[@P i};T;: stopped?;0;[;{;IC;"…Returns +true+ if this process is stopped. This is only returned if the corresponding #wait call had the Process::WUNTRACED flag set.;T;[o;= ;3I" overload;F;40;;˜;50;)I" stopped?;T;IC;";T; @c+;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @c+;[;I"@return [Boolean];T;0;6i;[; @c+;[;I"®Returns +true+ if this process is stopped. This is only returned if the corresponding #wait call had the Process::WUNTRACED flag set. @overload stopped? @return [Boolean];T;0; @c+;!F;"o;#;$T;%it;&iz;6i;'@v*;(I"Œstatic VALUE pst_wifstopped(VALUE st) { int status = PST2INT(st); if (WIFSTOPPED(status)) return Qtrue; else return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Process::Status#stopsig;F;[;[[@P i‘;T;:stopsig;0;[;{;IC;"cReturns the number of the signal that caused _stat_ to stop (or +nil+ if self is not stopped). ;T;[o;= ;3I" overload;F;40;;™;50;)I"stopsig;T;IC;";T; @~+;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @~+;[;I"@return [Integer, nil];T;0;6i;[; @~+;[;I"‹Returns the number of the signal that caused _stat_ to stop (or +nil+ if self is not stopped). @overload stopsig @return [Integer, nil];T;0; @~+;!F;"o;#;$T;%i‰;&iŽ;'@v*;(I"–static VALUE pst_wstopsig(VALUE st) { int status = PST2INT(st); if (WIFSTOPPED(status)) return INT2NUM(WSTOPSIG(status)); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Process::Status#signaled?;F;[;[[@P i¤;T;:signaled?;0;[;{;IC;"GReturns +true+ if _stat_ terminated because of an uncaught signal.;T;[o;= ;3I" overload;F;40;;š;50;)I"signaled?;T;IC;";T; @š+;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @š+;[;I"@return [Boolean];T;0;6i;[; @š+;[;I"qReturns +true+ if _stat_ terminated because of an uncaught signal. @overload signaled? @return [Boolean];T;0; @š+;!F;"o;#;$T;%iœ;&i¡;6i;'@v*;(I"Žstatic VALUE pst_wifsignaled(VALUE st) { int status = PST2INT(st); if (WIFSIGNALED(status)) return Qtrue; else return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Process::Status#termsig;F;[;[[@P i¹;T;:termsig;0;[;{;IC;"}Returns the number of the signal that caused _stat_ to terminate (or +nil+ if self was not terminated by an uncaught signal). ;T;[o;= ;3I" overload;F;40;;›;50;)I"termsig;T;IC;";T; @µ+;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @µ+;[;I"@return [Integer, nil];T;0;6i;[; @µ+;[;I"ªReturns the number of the signal that caused _stat_ to terminate (or +nil+ if self was not terminated by an uncaught signal). @overload termsig @return [Integer, nil];T;0; @µ+;!F;"o;#;$T;%i°;&i¶;'@v*;(I"—static VALUE pst_wtermsig(VALUE st) { int status = PST2INT(st); if (WIFSIGNALED(status)) return INT2NUM(WTERMSIG(status)); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Process::Status#exited?;F;[;[[@P iÍ;T;:exited?;0;[;{;IC;"wReturns +true+ if _stat_ exited normally (for example using an exit() call or finishing the program).;T;[o;= ;3I" overload;F;40;;œ;50;)I"exited?;T;IC;";T; @Ñ+;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Ñ+;[;I"@return [Boolean];T;0;6i;[; @Ñ+;[;I"šReturns +true+ if _stat_ exited normally (for example using an exit() call or finishing the program). @overload exited? @return [Boolean];T;0; @Ñ+;!F;"o;#;$T;%iÄ;&iÊ;6i;'@v*;(I"Šstatic VALUE pst_wifexited(VALUE st) { int status = PST2INT(st); if (WIFEXITED(status)) return Qtrue; else return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Process::Status#exitstatus;F;[;[[@P ië;T;:exitstatus;0;[;{;IC;"eReturns the least significant eight bits of the return code of _stat_. Only available if #exited? is +true+. fork { } #=> 26572 Process.wait #=> 26572 $?.exited? #=> true $?.exitstatus #=> 0 fork { exit 99 } #=> 26573 Process.wait #=> 26573 $?.exited? #=> true $?.exitstatus #=> 99 ;T;[o;= ;3I" overload;F;40;;;50;)I"exitstatus;T;IC;";T; @ì+;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @ì+;[;I"@return [Integer, nil];T;0;6i;[; @ì+;[;I"•Returns the least significant eight bits of the return code of _stat_. Only available if #exited? is +true+. fork { } #=> 26572 Process.wait #=> 26572 $?.exited? #=> true $?.exitstatus #=> 0 fork { exit 99 } #=> 26573 Process.wait #=> 26573 $?.exited? #=> true $?.exitstatus #=> 99 @overload exitstatus @return [Integer, nil];T;0; @ì+;!F;"o;#;$T;%iÙ;&iè;'@v*;(I"›static VALUE pst_wexitstatus(VALUE st) { int status = PST2INT(st); if (WIFEXITED(status)) return INT2NUM(WEXITSTATUS(status)); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Process::Status#success?;F;[;[[@P iþ;T;: success?;0;[;{;IC;"eReturns +true+ if _stat_ is successful, +false+ if not. Returns +nil+ if #exited? is not +true+.;T;[o;= ;3I" overload;F;40;;ž;50;)I" success?;T;IC;";T; @,;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" true;TI" false;TI"nil;T; @,;[;I"@return [true, false, nil];T;0;6i;[; @,;[;I"’Returns +true+ if _stat_ is successful, +false+ if not. Returns +nil+ if #exited? is not +true+. @overload success? @return [true, false, nil];T;0; @,;!F;"o;#;$T;%iö;&iû;6i;'@v*;(I"²static VALUE pst_success_p(VALUE st) { int status = PST2INT(st); if (!WIFEXITED(status)) return Qnil; return WEXITSTATUS(status) == EXIT_SUCCESS ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Process::Status#coredump?;F;[;[[@P i;T;:coredump?;0;[;{;IC;"fReturns +true+ if _stat_ generated a coredump when it terminated. Not available on all platforms.;T;[o;= ;3I" overload;F;40;;Ÿ;50;)I"coredump?;T;IC;";T; @%,;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @%,;[;I"@return [Boolean];T;0;6i;[; @%,;[;I"‹Returns +true+ if _stat_ generated a coredump when it terminated. Not available on all platforms. @overload coredump? @return [Boolean];T;0; @%,;!F;"o;#;$T;%i ;&i;6i;'@v*;(I"»static VALUE pst_wcoredump(VALUE st) { #ifdef WCOREDUMP int status = PST2INT(st); if (WCOREDUMP(status)) return Qtrue; else return Qfalse; #else return Qfalse; #endif };T;)I"static VALUE;T;*T;A@v*;BIC;[;A@v*;CIC;[;A@v*;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@P i[@P iä!;T;:Status;;K;;;[;{;IC;"†******************************************************************* Process::Status encapsulates the information on the status of a running or terminated system process. The built-in variable $? is either +nil+ or a Process::Status object. fork { exit 99 } #=> 26557 Process.wait #=> 26557 $?.class #=> Process::Status $?.to_i #=> 25344 $? >> 8 #=> 99 $?.stopped? #=> false $?.exited? #=> true $?.exitstatus #=> 99 Posix systems record information on processes using a 16-bit integer. The lower bits record the process status (stopped, exited, signaled) and the upper bits possibly contain additional information (for example the program's return code in the case of exited processes). Pre Ruby 1.8, these bits were exposed directly to the Ruby program. Ruby now encapsulates these in a Process::Status object. To maximize compatibility, however, these objects retain a bit-oriented interface. In the descriptions that follow, when we talk about the integer value of _stat_, we're referring to this 16 bit value.;T;[;[;I"‡******************************************************************* Process::Status encapsulates the information on the status of a running or terminated system process. The built-in variable $? is either +nil+ or a Process::Status object. fork { exit 99 } #=> 26557 Process.wait #=> 26557 $?.class #=> Process::Status $?.to_i #=> 25344 $? >> 8 #=> 99 $?.stopped? #=> false $?.exited? #=> true $?.exitstatus #=> 99 Posix systems record information on processes using a 16-bit integer. The lower bits record the process status (stopped, exited, signaled) and the upper bits possibly contain additional information (for example the program's return code in the case of exited processes). Pre Ruby 1.8, these bits were exposed directly to the Ruby program. Ruby now encapsulates these in a Process::Status object. To maximize compatibility, however, these objects retain a bit-oriented interface. In the descriptions that follow, when we talk about the integer value of _stat_, we're referring to this 16 bit value. ;T;0; @v*;!F;"o;#;$T;%i;&i7;6i;'o;L;M0;N0;O0;:Process;'@;Q@*;R0;I"Process::Status;F;S@]o;{;[[@P iÁ![@P iÄ!;F;:WNOHANG;;};;;[;{;IC;"see Process.wait ;T;[;[;I"see Process.wait;T;0; @S,;!F;"o;#;$T;%iÃ!;&iÃ!;'@*;I"Process::WNOHANG;F;~I"INT2FIX(0);To;{;[[@P iÈ![@P iË!;F;:WUNTRACED;;};;;[;{;IC;"see Process.wait ;T;[;[;I"see Process.wait;T;0; @`,;!F;"o;#;$T;%iÊ!;&iÊ!;'@*;I"Process::WUNTRACED;F;~I"INT2FIX(0);To;;F; ;F;;;I"Process.exec;F;[[I"*a;T0[I"_;T0;[[@P i;T;;«;0;[;{;IC;"4 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;= ;3I" overload;F;40;;«;50;)I"'exec([env,] command... [,options]);T;IC;";T; @m,;>0;!F;[;[;I";T;0;6i;[[I"[env,][,options];T0; @m,;[;@` ;0; @m,;!F;"o;#;$T;%iF;&i‹;'@*;(I"ostatic VALUE f_exec(int c, const VALUE *a, VALUE _) { rb_f_exec(c, a); UNREACHABLE_RETURN(Qnil); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Process.fork;F;[;[[@P iñ;T;;¬;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;= ;3I" overload;F;40;;¬;50;)I" fork;T;IC;";T; @ˆ,;>0;!F;[o;2 ;3I" yield;F;4I"[];T;0;50; @ˆ,o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @ˆ,;[;I"%@yield [] @return [Integer, nil];T;0;6i;[; @ˆ,o;= ;3I" overload;F;40;;¬;50;)I" fork;T;IC;";T; @ˆ,;>0;!F;[o;2 ;3I" yield;F;4I"[];T;0;50; @ˆ,o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @ˆ,;[;I"%@yield [] @return [Integer, nil];T;0;6i;[; @ˆ,;[;@ ;0; @ˆ,;!F;"o;#;$T;%iØ;&iñ;'@*;(I"hstatic 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;)I"static VALUE;T;*To;;F; ;F;;;I"Process.spawn;F;[[@c0;[[@P iÃ;T;;¯;0;[;{;IC;"7*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 => false : 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, an integer, 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 false 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;= ;3I" overload;F;40;;¯;50;)I"(spawn([env,] command... [,options]);T;IC;";T; @·,;>0;!F;[;[;I";T;0;6i;[[I"[env,][,options];T0; @·,o;= ;3I" overload;F;40;;¯;50;)I"(spawn([env,] command... [,options]);T;IC;";T; @·,;>0;!F;[;[;I";T;0;6i;[[I"[env,][,options];T0; @·,;[;@ð ;0; @·,;!F;"o;#;$T;%i¶;&i¿;'@*;(I"Åstatic VALUE rb_f_spawn(int argc, VALUE *argv, VALUE _) { 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, FALSE); 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;)I"static VALUE;T;*To;;F; ;F;;;I"Process.exit!;F;[[@c0;[[@P i/;T;;;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;= ;3I" overload;F;40;;;50;)I"exit!(status=false);T;IC;";T; @Ù,;>0;!F;[;[;I";T;0;6i;[[I"status;TI" false;T; @Ù,;[;@ª ;0; @Ù,;!F;"o;#;$T;%i$;&i+;'@*;(I"static VALUE rb_f_exit_bang(int argc, VALUE *argv, VALUE obj) { int istatus; if (rb_check_arity(argc, 0, 1) == 1) { istatus = exit_status_code(argv[0]); } else { istatus = EXIT_FAILURE; } _exit(istatus); UNREACHABLE_RETURN(Qnil); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Process.exit;F;[[I"*a;T0[I"_;T0;[[@P i†;T;;±;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;= ;3I" overload;F;40;;±;50;)I"exit(status=true);T;IC;";T; @ò,;>0;!F;[;[;I";T;0;6i;[[I"status;TI" true;T; @ò,o;= ;3I" overload;F;40;;²;50;)I"Kernel::exit(status=true);T;IC;";T; @ò,;>0;!F;[;[;I";T;0;6i;[[I"status;TI" true;T; @ò,o;= ;3I" overload;F;40;;³;50;)I"Process::exit(status=true);T;IC;";T; @ò,;>0;!F;[;[;I";T;0;6i;[[I"status;TI" true;T; @ò,;[;@A;0; @ò,;!F;"o;#;$T;%i];&i‚;'@*;(I"ostatic VALUE f_exit(int c, const VALUE *a, VALUE _) { rb_f_exit(c, a); UNREACHABLE_RETURN(Qnil); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Process.abort;F;[[I"*a;T0[I"_;T0;[[@P i³;T;;´;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;= ;3I" overload;F;40;;´;50;)I" abort;T;IC;";T; @$-;>0;!F;[;[;I";T;0;6i;[; @$-o;= ;3I" overload;F;40;;µ;50;)I"Kernel::abort([msg]);T;IC;";T; @$-;>0;!F;[;[;I";T;0;6i;[[I" [msg];T0; @$-o;= ;3I" overload;F;40;;´;50;)I"abort([msg]);T;IC;";T; @$-;>0;!F;[;[;I";T;0;6i;[[I" [msg];T0; @$-;[;@o;0; @$-;!F;"o;#;$T;%i¨;&i¯;'@*;(I"qstatic VALUE f_abort(int c, const VALUE *a, VALUE _) { rb_f_abort(c, a); UNREACHABLE_RETURN(Qnil); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Process.last_status;F;[;[[@P ih;T;:last_status;0;[;{;IC;"?Returns the status of the last executed child process in the current thread. Process.wait Process.spawn("ruby", "-e", "exit 13") Process.last_status #=> # If no child process has ever been executed in the current thread, this returns +nil+. Process.last_status #=> nil ;T;[o;= ;3I" overload;F;40;;¤;50;)I"last_status;T;IC;";T; @Q-;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Process::Status;TI"nil;T; @Q-;[;I"#@return [Process::Status, nil];T;0;6i;[; @Q-;[;I"xReturns the status of the last executed child process in the current thread. Process.wait Process.spawn("ruby", "-e", "exit 13") Process.last_status #=> # If no child process has ever been executed in the current thread, this returns +nil+. Process.last_status #=> nil @overload last_status @return [Process::Status, nil];T;0; @Q-;!F;"o;#;$T;%iY;&if;'@*;(I"Tstatic VALUE proc_s_last_status(VALUE mod) { return rb_last_status_get(); };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Process#kill;F;[[I"*v;T0[I"_;T0;[[@P iš!;T;: kill;0;[;{;IC;"ˆSends the given signal to the specified process id(s) if _pid_ is positive. If _pid_ is zero, _signal_ is sent to all processes whose group ID is equal to the group ID of the process. If _pid_ is negative, results are dependent on the operating system. _signal_ may be an integer signal number or a POSIX signal name (either with or without a +SIG+ prefix). If _signal_ is negative (or starts with a minus sign), kills process groups instead of processes. Not all signals are available on all platforms. The keys and values of Signal.list are known signal names and numbers, respectively. pid = fork do Signal.trap("HUP") { puts "Ouch!"; exit } # ... do some work ... end # ... Process.kill("HUP", pid) Process.wait produces: Ouch! If _signal_ is an integer but wrong for signal, Errno::EINVAL or RangeError will be raised. Otherwise unless _signal_ is a String or a Symbol, and a known signal name, ArgumentError will be raised. Also, Errno::ESRCH or RangeError for invalid _pid_, Errno::EPERM when failed because of no privilege, will be raised. In these cases, signals may have been sent to preceding processes. ;T; @m-;>0;!F;[o;= ;3I" overload;F;40;;¥;50;)I"kill(signal, pid, ...);T;IC;";T; @m-;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @m-;[;I"@return [Integer];T;0;6i;[[I"signal;T0[I"pid;T0[I"...;T0; @m-;[;I"¾Sends the given signal to the specified process id(s) if _pid_ is positive. If _pid_ is zero, _signal_ is sent to all processes whose group ID is equal to the group ID of the process. If _pid_ is negative, results are dependent on the operating system. _signal_ may be an integer signal number or a POSIX signal name (either with or without a +SIG+ prefix). If _signal_ is negative (or starts with a minus sign), kills process groups instead of processes. Not all signals are available on all platforms. The keys and values of Signal.list are known signal names and numbers, respectively. pid = fork do Signal.trap("HUP") { puts "Ouch!"; exit } # ... do some work ... end # ... Process.kill("HUP", pid) Process.wait produces: Ouch! If _signal_ is an integer but wrong for signal, Errno::EINVAL or RangeError will be raised. Otherwise unless _signal_ is a String or a Symbol, and a known signal name, ArgumentError will be raised. Also, Errno::ESRCH or RangeError for invalid _pid_, Errno::EPERM when failed because of no privilege, will be raised. In these cases, signals may have been sent to preceding processes. @overload kill(signal, pid, ...) @return [Integer];T;0;'@*;(I"`static VALUE proc_rb_f_kill(int c, const VALUE *v, VALUE _) { return rb_f_kill(c, v); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.kill;F;@o-;@t-;T;;¥;0;@v-;{;IC;"ˆSends the given signal to the specified process id(s) if _pid_ is positive. If _pid_ is zero, _signal_ is sent to all processes whose group ID is equal to the group ID of the process. If _pid_ is negative, results are dependent on the operating system. _signal_ may be an integer signal number or a POSIX signal name (either with or without a +SIG+ prefix). If _signal_ is negative (or starts with a minus sign), kills process groups instead of processes. Not all signals are available on all platforms. The keys and values of Signal.list are known signal names and numbers, respectively. pid = fork do Signal.trap("HUP") { puts "Ouch!"; exit } # ... do some work ... end # ... Process.kill("HUP", pid) Process.wait produces: Ouch! If _signal_ is an integer but wrong for signal, Errno::EINVAL or RangeError will be raised. Otherwise unless _signal_ is a String or a Symbol, and a known signal name, ArgumentError will be raised. Also, Errno::ESRCH or RangeError for invalid _pid_, Errno::EPERM when failed because of no privilege, will be raised. In these cases, signals may have been sent to preceding processes.;T;[o;= ;3I" overload;F;40;;¥;50;)I"kill(signal, pid, ...);T;IC;";T; @‘-;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @‘-;[;I"@return [Integer];T;0;6i;[[I"signal;T0[I"pid;T0[I"...;T0; @‘-;[;I"¿Sends the given signal to the specified process id(s) if _pid_ is positive. If _pid_ is zero, _signal_ is sent to all processes whose group ID is equal to the group ID of the process. If _pid_ is negative, results are dependent on the operating system. _signal_ may be an integer signal number or a POSIX signal name (either with or without a +SIG+ prefix). If _signal_ is negative (or starts with a minus sign), kills process groups instead of processes. Not all signals are available on all platforms. The keys and values of Signal.list are known signal names and numbers, respectively. pid = fork do Signal.trap("HUP") { puts "Ouch!"; exit } # ... do some work ... end # ... Process.kill("HUP", pid) Process.wait produces: Ouch! If _signal_ is an integer but wrong for signal, Errno::EINVAL or RangeError will be raised. Otherwise unless _signal_ is a String or a Symbol, and a known signal name, ArgumentError will be raised. Also, Errno::ESRCH or RangeError for invalid _pid_, Errno::EPERM when failed because of no privilege, will be raised. In these cases, signals may have been sent to preceding processes. @overload kill(signal, pid, ...) @return [Integer];T;0; @‘-;!F;"o;#;$T;%iv!;&i—!;6i;'@*;(@-;)@-;*To;;F; ;;;Ï;I"Process#wait;F;[[I"*v;T0[I"_;T0;[[@P i;T;;’;0;[;{;IC;"–Waits for a child process to exit, returns its process id, and sets $? to a Process::Status object containing information on that process. Which child it waits on depends on the value of _pid_: > 0:: Waits for the child whose process ID equals _pid_. 0:: Waits for any child whose process group ID equals that of the calling process. -1:: Waits for any child process (the default if no _pid_ is given). < -1:: Waits for any child whose process group ID equals the absolute value of _pid_. The _flags_ argument may be a logical or of the flag values Process::WNOHANG (do not block if no child available) or Process::WUNTRACED (return stopped children that haven't been reported). Not all flags are available on all platforms, but a flag value of zero will work on all platforms. Calling this method raises a SystemCallError if there are no child processes. Not available on all platforms. include Process fork { exit 99 } #=> 27429 wait #=> 27429 $?.exitstatus #=> 99 pid = fork { sleep 3 } #=> 27440 Time.now #=> 2008-03-08 19:56:16 +0900 waitpid(pid, Process::WNOHANG) #=> nil Time.now #=> 2008-03-08 19:56:16 +0900 waitpid(pid, 0) #=> 27440 Time.now #=> 2008-03-08 19:56:19 +0900 ;T; @¬-;>0;!F;[o;= ;3I" overload;F;40;;’;50;)I"wait();T;IC;";T; @¬-;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¬-;[;I"@return [Integer];T;0;6i;[; @¬-o;= ;3I" overload;F;40;;’;50;)I"wait(pid=-1, flags=0);T;IC;";T; @¬-;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¬-;[;I"@return [Integer];T;0;6i;[[I"pid;TI"-1;T[I" flags;TI"0;T; @¬-o;= ;3I" overload;F;40;:waitpid;50;)I"waitpid(pid=-1, flags=0);T;IC;";T; @¬-;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¬-;[;I"@return [Integer];T;0;6i;[[I"pid;TI"-1;T[I" flags;TI"0;T; @¬-;[;I")Waits for a child process to exit, returns its process id, and sets $? to a Process::Status object containing information on that process. Which child it waits on depends on the value of _pid_: > 0:: Waits for the child whose process ID equals _pid_. 0:: Waits for any child whose process group ID equals that of the calling process. -1:: Waits for any child process (the default if no _pid_ is given). < -1:: Waits for any child whose process group ID equals the absolute value of _pid_. The _flags_ argument may be a logical or of the flag values Process::WNOHANG (do not block if no child available) or Process::WUNTRACED (return stopped children that haven't been reported). Not all flags are available on all platforms, but a flag value of zero will work on all platforms. Calling this method raises a SystemCallError if there are no child processes. Not available on all platforms. include Process fork { exit 99 } #=> 27429 wait #=> 27429 $?.exitstatus #=> 99 pid = fork { sleep 3 } #=> 27440 Time.now #=> 2008-03-08 19:56:16 +0900 waitpid(pid, Process::WNOHANG) #=> nil Time.now #=> 2008-03-08 19:56:16 +0900 waitpid(pid, 0) #=> 27440 Time.now #=> 2008-03-08 19:56:19 +0900 @overload wait() @return [Integer] @overload wait(pid=-1, flags=0) @return [Integer] @overload waitpid(pid=-1, flags=0) @return [Integer];T;0;'@*;(I"Wstatic VALUE proc_m_wait(int c, VALUE *v, VALUE _) { return proc_wait(c, v); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.wait;F;@®-;@³-;T;;’;0;@µ-;{;IC;"–Waits for a child process to exit, returns its process id, and sets $? to a Process::Status object containing information on that process. Which child it waits on depends on the value of _pid_: > 0:: Waits for the child whose process ID equals _pid_. 0:: Waits for any child whose process group ID equals that of the calling process. -1:: Waits for any child process (the default if no _pid_ is given). < -1:: Waits for any child whose process group ID equals the absolute value of _pid_. The _flags_ argument may be a logical or of the flag values Process::WNOHANG (do not block if no child available) or Process::WUNTRACED (return stopped children that haven't been reported). Not all flags are available on all platforms, but a flag value of zero will work on all platforms. Calling this method raises a SystemCallError if there are no child processes. Not available on all platforms. include Process fork { exit 99 } #=> 27429 wait #=> 27429 $?.exitstatus #=> 99 pid = fork { sleep 3 } #=> 27440 Time.now #=> 2008-03-08 19:56:16 +0900 waitpid(pid, Process::WNOHANG) #=> nil Time.now #=> 2008-03-08 19:56:16 +0900 waitpid(pid, 0) #=> 27440 Time.now #=> 2008-03-08 19:56:19 +0900;T;[o;= ;3I" overload;F;40;;’;50;)I"wait();T;IC;";T; @ð-;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ð-;[;I"@return [Integer];T;0;6i;[; @ð-o;= ;3I" overload;F;40;;’;50;)I"wait(pid=-1, flags=0);T;IC;";T; @ð-;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ð-;[;I"@return [Integer];T;0;6i;[[I"pid;TI"-1;T[I" flags;TI"0;T; @ð-o;= ;3I" overload;F;40;;¦;50;)I"waitpid(pid=-1, flags=0);T;IC;";T; @ð-;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ð-;[;I"@return [Integer];T;0;6i;[[I"pid;TI"-1;T[I" flags;TI"0;T; @ð-;[;I"(Waits for a child process to exit, returns its process id, and sets $? to a Process::Status object containing information on that process. Which child it waits on depends on the value of _pid_: > 0:: Waits for the child whose process ID equals _pid_. 0:: Waits for any child whose process group ID equals that of the calling process. -1:: Waits for any child process (the default if no _pid_ is given). < -1:: Waits for any child whose process group ID equals the absolute value of _pid_. The _flags_ argument may be a logical or of the flag values Process::WNOHANG (do not block if no child available) or Process::WUNTRACED (return stopped children that haven't been reported). Not all flags are available on all platforms, but a flag value of zero will work on all platforms. Calling this method raises a SystemCallError if there are no child processes. Not available on all platforms. include Process fork { exit 99 } #=> 27429 wait #=> 27429 $?.exitstatus #=> 99 pid = fork { sleep 3 } #=> 27440 Time.now #=> 2008-03-08 19:56:16 +0900 waitpid(pid, Process::WNOHANG) #=> nil Time.now #=> 2008-03-08 19:56:16 +0900 waitpid(pid, 0) #=> 27440 Time.now #=> 2008-03-08 19:56:19 +0900 @overload wait() @return [Integer] @overload wait(pid=-1, flags=0) @return [Integer] @overload waitpid(pid=-1, flags=0) @return [Integer];T;0; @ð-;!F;"o;#;$T;%iâ;&i ;6i;'@*;(@î-;)@ï-;*To;;F; ;;;Ï;I"Process#wait2;F;[[@c0;[[@P i%;T;: wait2;0;[;{;IC;"ˆWaits for a child process to exit (see Process::waitpid for exact semantics) and returns an array containing the process id and the exit status (a Process::Status object) of that child. Raises a SystemCallError if there are no child processes. Process.fork { exit 99 } #=> 27437 pid, status = Process.wait2 pid #=> 27437 status.exitstatus #=> 99 ;T; @+.;>0;!F;[o;= ;3I" overload;F;40;;§;50;)I"wait2(pid=-1, flags=0);T;IC;";T; @+.;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @+.;[;I"@return [Array];T;0;6i;[[I"pid;TI"-1;T[I" flags;TI"0;T; @+.o;= ;3I" overload;F;40;: waitpid2;50;)I"waitpid2(pid=-1, flags=0);T;IC;";T; @+.;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @+.;[;I"@return [Array];T;0;6i;[[I"pid;TI"-1;T[I" flags;TI"0;T; @+.;[;I"óWaits for a child process to exit (see Process::waitpid for exact semantics) and returns an array containing the process id and the exit status (a Process::Status object) of that child. Raises a SystemCallError if there are no child processes. Process.fork { exit 99 } #=> 27437 pid, status = Process.wait2 pid #=> 27437 status.exitstatus #=> 99 @overload wait2(pid=-1, flags=0) @return [Array] @overload waitpid2(pid=-1, flags=0) @return [Array];T;0;'@*;(I"·static VALUE proc_wait2(int argc, VALUE *argv, VALUE _) { VALUE pid = proc_wait(argc, argv); if (NIL_P(pid)) return Qnil; return rb_assoc_new(pid, rb_last_status_get()); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.wait2;F;@-.;@/.;T;;§;0;@1.;{;IC;"ˆWaits for a child process to exit (see Process::waitpid for exact semantics) and returns an array containing the process id and the exit status (a Process::Status object) of that child. Raises a SystemCallError if there are no child processes. Process.fork { exit 99 } #=> 27437 pid, status = Process.wait2 pid #=> 27437 status.exitstatus #=> 99;T;[o;= ;3I" overload;F;40;;§;50;)I"wait2(pid=-1, flags=0);T;IC;";T; @_.;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @_.;[;I"@return [Array];T;0;6i;[[I"pid;TI"-1;T[I" flags;TI"0;T; @_.o;= ;3I" overload;F;40;;¨;50;)I"waitpid2(pid=-1, flags=0);T;IC;";T; @_.;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @_.;[;I"@return [Array];T;0;6i;[[I"pid;TI"-1;T[I" flags;TI"0;T; @_.;[;I"óWaits for a child process to exit (see Process::waitpid for exact semantics) and returns an array containing the process id and the exit status (a Process::Status object) of that child. Raises a SystemCallError if there are no child processes. Process.fork { exit 99 } #=> 27437 pid, status = Process.wait2 pid #=> 27437 status.exitstatus #=> 99 @overload wait2(pid=-1, flags=0) @return [Array] @overload waitpid2(pid=-1, flags=0) @return [Array];T;0; @_.;!F;"o;#;$T;%i;&i#;6i;'@*;(@].;)@^.;*To;;F; ;;;Ï;I"Process#waitpid;F;[[I"*v;T0[I"_;T0;[[@P i;T;;¦;0;[;{;IC;"–Waits for a child process to exit, returns its process id, and sets $? to a Process::Status object containing information on that process. Which child it waits on depends on the value of _pid_: > 0:: Waits for the child whose process ID equals _pid_. 0:: Waits for any child whose process group ID equals that of the calling process. -1:: Waits for any child process (the default if no _pid_ is given). < -1:: Waits for any child whose process group ID equals the absolute value of _pid_. The _flags_ argument may be a logical or of the flag values Process::WNOHANG (do not block if no child available) or Process::WUNTRACED (return stopped children that haven't been reported). Not all flags are available on all platforms, but a flag value of zero will work on all platforms. Calling this method raises a SystemCallError if there are no child processes. Not available on all platforms. include Process fork { exit 99 } #=> 27429 wait #=> 27429 $?.exitstatus #=> 99 pid = fork { sleep 3 } #=> 27440 Time.now #=> 2008-03-08 19:56:16 +0900 waitpid(pid, Process::WNOHANG) #=> nil Time.now #=> 2008-03-08 19:56:16 +0900 waitpid(pid, 0) #=> 27440 Time.now #=> 2008-03-08 19:56:19 +0900 ;T; @.;>0;!F;[o;= ;3I" overload;F;40;;’;50;)I"wait();T;IC;";T; @.;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @.;[;I"@return [Integer];T;0;6i;[; @.o;= ;3I" overload;F;40;;’;50;)I"wait(pid=-1, flags=0);T;IC;";T; @.;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @.;[;I"@return [Integer];T;0;6i;[[I"pid;TI"-1;T[I" flags;TI"0;T; @.o;= ;3I" overload;F;40;;¦;50;)I"waitpid(pid=-1, flags=0);T;IC;";T; @.;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @.;[;I"@return [Integer];T;0;6i;[[I"pid;TI"-1;T[I" flags;TI"0;T; @.;[;I")Waits for a child process to exit, returns its process id, and sets $? to a Process::Status object containing information on that process. Which child it waits on depends on the value of _pid_: > 0:: Waits for the child whose process ID equals _pid_. 0:: Waits for any child whose process group ID equals that of the calling process. -1:: Waits for any child process (the default if no _pid_ is given). < -1:: Waits for any child whose process group ID equals the absolute value of _pid_. The _flags_ argument may be a logical or of the flag values Process::WNOHANG (do not block if no child available) or Process::WUNTRACED (return stopped children that haven't been reported). Not all flags are available on all platforms, but a flag value of zero will work on all platforms. Calling this method raises a SystemCallError if there are no child processes. Not available on all platforms. include Process fork { exit 99 } #=> 27429 wait #=> 27429 $?.exitstatus #=> 99 pid = fork { sleep 3 } #=> 27440 Time.now #=> 2008-03-08 19:56:16 +0900 waitpid(pid, Process::WNOHANG) #=> nil Time.now #=> 2008-03-08 19:56:16 +0900 waitpid(pid, 0) #=> 27440 Time.now #=> 2008-03-08 19:56:19 +0900 @overload wait() @return [Integer] @overload wait(pid=-1, flags=0) @return [Integer] @overload waitpid(pid=-1, flags=0) @return [Integer];T;0;'@*;(I"Wstatic VALUE proc_m_wait(int c, VALUE *v, VALUE _) { return proc_wait(c, v); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.waitpid;F;@.;@”.;T;;¦;0;@–.;{;IC;"–Waits for a child process to exit, returns its process id, and sets $? to a Process::Status object containing information on that process. Which child it waits on depends on the value of _pid_: > 0:: Waits for the child whose process ID equals _pid_. 0:: Waits for any child whose process group ID equals that of the calling process. -1:: Waits for any child process (the default if no _pid_ is given). < -1:: Waits for any child whose process group ID equals the absolute value of _pid_. The _flags_ argument may be a logical or of the flag values Process::WNOHANG (do not block if no child available) or Process::WUNTRACED (return stopped children that haven't been reported). Not all flags are available on all platforms, but a flag value of zero will work on all platforms. Calling this method raises a SystemCallError if there are no child processes. Not available on all platforms. include Process fork { exit 99 } #=> 27429 wait #=> 27429 $?.exitstatus #=> 99 pid = fork { sleep 3 } #=> 27440 Time.now #=> 2008-03-08 19:56:16 +0900 waitpid(pid, Process::WNOHANG) #=> nil Time.now #=> 2008-03-08 19:56:16 +0900 waitpid(pid, 0) #=> 27440 Time.now #=> 2008-03-08 19:56:19 +0900;T;[o;= ;3I" overload;F;40;;’;50;)I"wait();T;IC;";T; @Ñ.;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ñ.;[;I"@return [Integer];T;0;6i;[; @Ñ.o;= ;3I" overload;F;40;;’;50;)I"wait(pid=-1, flags=0);T;IC;";T; @Ñ.;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ñ.;[;I"@return [Integer];T;0;6i;[[I"pid;TI"-1;T[I" flags;TI"0;T; @Ñ.o;= ;3I" overload;F;40;;¦;50;)I"waitpid(pid=-1, flags=0);T;IC;";T; @Ñ.;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ñ.;[;I"@return [Integer];T;0;6i;[[I"pid;TI"-1;T[I" flags;TI"0;T; @Ñ.;[;@).;0; @Ñ.;!F;"o;#;$T;%iâ;&i ;6i;'@*;(@Ï.;)@Ð.;*To;;F; ;;;Ï;I"Process#waitpid2;F;[[@c0;[[@P i%;T;;¨;0;[;{;IC;"ˆWaits for a child process to exit (see Process::waitpid for exact semantics) and returns an array containing the process id and the exit status (a Process::Status object) of that child. Raises a SystemCallError if there are no child processes. Process.fork { exit 99 } #=> 27437 pid, status = Process.wait2 pid #=> 27437 status.exitstatus #=> 99 ;T; @/;>0;!F;[o;= ;3I" overload;F;40;;§;50;)I"wait2(pid=-1, flags=0);T;IC;";T; @/;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @/;[;I"@return [Array];T;0;6i;[[I"pid;TI"-1;T[I" flags;TI"0;T; @/o;= ;3I" overload;F;40;;¨;50;)I"waitpid2(pid=-1, flags=0);T;IC;";T; @/;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @/;[;I"@return [Array];T;0;6i;[[I"pid;TI"-1;T[I" flags;TI"0;T; @/;[;I"óWaits for a child process to exit (see Process::waitpid for exact semantics) and returns an array containing the process id and the exit status (a Process::Status object) of that child. Raises a SystemCallError if there are no child processes. Process.fork { exit 99 } #=> 27437 pid, status = Process.wait2 pid #=> 27437 status.exitstatus #=> 99 @overload wait2(pid=-1, flags=0) @return [Array] @overload waitpid2(pid=-1, flags=0) @return [Array];T;0;'@*;(I"·static VALUE proc_wait2(int argc, VALUE *argv, VALUE _) { VALUE pid = proc_wait(argc, argv); if (NIL_P(pid)) return Qnil; return rb_assoc_new(pid, rb_last_status_get()); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.waitpid2;F;@ /;@/;T;;¨;0;@/;{;IC;"ˆWaits for a child process to exit (see Process::waitpid for exact semantics) and returns an array containing the process id and the exit status (a Process::Status object) of that child. Raises a SystemCallError if there are no child processes. Process.fork { exit 99 } #=> 27437 pid, status = Process.wait2 pid #=> 27437 status.exitstatus #=> 99;T;[o;= ;3I" overload;F;40;;§;50;)I"wait2(pid=-1, flags=0);T;IC;";T; @?/;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @?/;[;I"@return [Array];T;0;6i;[[I"pid;TI"-1;T[I" flags;TI"0;T; @?/o;= ;3I" overload;F;40;;¨;50;)I"waitpid2(pid=-1, flags=0);T;IC;";T; @?/;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @?/;[;I"@return [Array];T;0;6i;[[I"pid;TI"-1;T[I" flags;TI"0;T; @?/;[;@‹.;0; @?/;!F;"o;#;$T;%i;&i#;6i;'@*;(@=/;)@>/;*To;;F; ;;;Ï;I"Process#waitall;F;[;[[@P iB;T;:waitall;0;[;{;IC;"²Waits for all children, returning an array of _pid_/_status_ pairs (where _status_ is a Process::Status object). fork { sleep 0.2; exit 2 } #=> 27432 fork { sleep 0.1; exit 1 } #=> 27433 fork { exit 0 } #=> 27434 p Process.waitall produces: [[30982, #], [30979, #], [30976, #]] ;T; @l/;>0;!F;[o;= ;3I" overload;F;40;;©;50;)I"waitall;T;IC;";T; @l/;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @l/;[;I"@return [Array];T;0;6i;[; @l/;[;I"×Waits for all children, returning an array of _pid_/_status_ pairs (where _status_ is a Process::Status object). fork { sleep 0.2; exit 2 } #=> 27432 fork { sleep 0.1; exit 1 } #=> 27433 fork { exit 0 } #=> 27434 p Process.waitall produces: [[30982, #], [30979, #], [30976, #]] @overload waitall @return [Array];T;0;'@*;(I"’static VALUE proc_waitall(VALUE _) { VALUE result; rb_pid_t pid; int status; result = rb_ary_new(); rb_last_status_clear(); for (pid = -1;;) { pid = rb_waitpid(-1, &status, 0); if (pid == -1) { int e = errno; if (e == ECHILD) break; rb_syserr_fail(e, 0); } rb_ary_push(result, rb_assoc_new(PIDT2NUM(pid), rb_last_status_get())); } return result; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.waitall;F;@n/;@o/;T;;©;0;@q/;{;IC;"²Waits for all children, returning an array of _pid_/_status_ pairs (where _status_ is a Process::Status object). fork { sleep 0.2; exit 2 } #=> 27432 fork { sleep 0.1; exit 1 } #=> 27433 fork { exit 0 } #=> 27434 p Process.waitall produces: [[30982, #], [30979, #], [30976, #]];T;[o;= ;3I" overload;F;40;;©;50;)I"waitall;T;IC;";T; @†/;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @†/;[;I"@return [Array];T;0;6i;[; @†/;[;I"ØWaits for all children, returning an array of _pid_/_status_ pairs (where _status_ is a Process::Status object). fork { sleep 0.2; exit 2 } #=> 27432 fork { sleep 0.1; exit 1 } #=> 27433 fork { exit 0 } #=> 27434 p Process.waitall produces: [[30982, #], [30979, #], [30976, #]] @overload waitall @return [Array];T;0; @†/;!F;"o;#;$T;%i.;&i?;6i;'@*;(@„/;)@…/;*To;;F; ;;;Ï;I"Process#detach;F;[[I"pid;T0;[[@P i¥;T;:detach;0;[;{;IC;""Some operating systems retain the status of terminated child processes until the parent collects that status (normally using some variant of wait()). If the parent never collects this status, the child stays around as a zombie process. Process::detach prevents this by setting up a separate Ruby thread whose sole job is to reap the status of the process _pid_ when it terminates. Use #detach only when you do not intend to explicitly wait for the child to terminate. The waiting thread returns the exit status of the detached process when it terminates, so you can use Thread#join to know the result. If specified _pid_ is not a valid child process ID, the thread returns +nil+ immediately. The waiting thread has #pid method which returns the pid. In this first example, we don't reap the first child process, so it appears as a zombie in the process status display. p1 = fork { sleep 0.1 } p2 = fork { sleep 0.2 } Process.waitpid(p2) sleep 2 system("ps -ho pid,state -p #{p1}") produces: 27389 Z In the next example, Process::detach is used to reap the child automatically. p1 = fork { sleep 0.1 } p2 = fork { sleep 0.2 } Process.detach(p1) Process.waitpid(p2) sleep 2 system("ps -ho pid,state -p #{p1}") (produces no output) ;T; @›/;>0;!F;[o;= ;3I" overload;F;40;;ª;50;)I"detach(pid);T;IC;";T; @›/;>0;!F;[;[;I";T;0;6i;[[I"pid;T0; @›/;[;I"9Some operating systems retain the status of terminated child processes until the parent collects that status (normally using some variant of wait()). If the parent never collects this status, the child stays around as a zombie process. Process::detach prevents this by setting up a separate Ruby thread whose sole job is to reap the status of the process _pid_ when it terminates. Use #detach only when you do not intend to explicitly wait for the child to terminate. The waiting thread returns the exit status of the detached process when it terminates, so you can use Thread#join to know the result. If specified _pid_ is not a valid child process ID, the thread returns +nil+ immediately. The waiting thread has #pid method which returns the pid. In this first example, we don't reap the first child process, so it appears as a zombie in the process status display. p1 = fork { sleep 0.1 } p2 = fork { sleep 0.2 } Process.waitpid(p2) sleep 2 system("ps -ho pid,state -p #{p1}") produces: 27389 Z In the next example, Process::detach is used to reap the child automatically. p1 = fork { sleep 0.1 } p2 = fork { sleep 0.2 } Process.detach(p1) Process.waitpid(p2) sleep 2 system("ps -ho pid,state -p #{p1}") (produces no output) @overload detach(pid) ;T;0;'@*;(I"dstatic VALUE proc_detach(VALUE obj, VALUE pid) { return rb_detach_process(NUM2PIDT(pid)); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.detach;F;@/;@ /;T;;ª;0;@¢/;{;IC;""Some operating systems retain the status of terminated child processes until the parent collects that status (normally using some variant of wait()). If the parent never collects this status, the child stays around as a zombie process. Process::detach prevents this by setting up a separate Ruby thread whose sole job is to reap the status of the process _pid_ when it terminates. Use #detach only when you do not intend to explicitly wait for the child to terminate. The waiting thread returns the exit status of the detached process when it terminates, so you can use Thread#join to know the result. If specified _pid_ is not a valid child process ID, the thread returns +nil+ immediately. The waiting thread has #pid method which returns the pid. In this first example, we don't reap the first child process, so it appears as a zombie in the process status display. p1 = fork { sleep 0.1 } p2 = fork { sleep 0.2 } Process.waitpid(p2) sleep 2 system("ps -ho pid,state -p #{p1}") produces: 27389 Z In the next example, Process::detach is used to reap the child automatically. p1 = fork { sleep 0.1 } p2 = fork { sleep 0.2 } Process.detach(p1) Process.waitpid(p2) sleep 2 system("ps -ho pid,state -p #{p1}") (produces no output);T;[o;= ;3I" overload;F;40;;ª;50;)I"detach(pid);T;IC;";T; @´/;>0;!F;[;[;I";T;0;6i;[[I"pid;T0; @´/;[;I":Some operating systems retain the status of terminated child processes until the parent collects that status (normally using some variant of wait()). If the parent never collects this status, the child stays around as a zombie process. Process::detach prevents this by setting up a separate Ruby thread whose sole job is to reap the status of the process _pid_ when it terminates. Use #detach only when you do not intend to explicitly wait for the child to terminate. The waiting thread returns the exit status of the detached process when it terminates, so you can use Thread#join to know the result. If specified _pid_ is not a valid child process ID, the thread returns +nil+ immediately. The waiting thread has #pid method which returns the pid. In this first example, we don't reap the first child process, so it appears as a zombie in the process status display. p1 = fork { sleep 0.1 } p2 = fork { sleep 0.2 } Process.waitpid(p2) sleep 2 system("ps -ho pid,state -p #{p1}") produces: 27389 Z In the next example, Process::detach is used to reap the child automatically. p1 = fork { sleep 0.1 } p2 = fork { sleep 0.2 } Process.detach(p1) Process.waitpid(p2) sleep 2 system("ps -ho pid,state -p #{p1}") (produces no output) @overload detach(pid);T;0; @´/;!F;"o;#;$T;%iw;&i¡;6i;'@*;(@²/;)@³/;*To; ;IC;[o;;F; ;;;;I"Process::Waiter#pid;F;[;[[@P i[;T;;—;0;[;{;IC;";T;[;[;@|;0; @È/;'@Æ/;(I"gstatic VALUE detach_process_pid(VALUE thread) { return rb_thread_local_aref(thread, id_pid); };T;)I"static VALUE;T;*T;A@Æ/;BIC;[;A@Æ/;CIC;[;A@Æ/;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@P iß!;F;:Waiter;;K;;;[;{;IC;";T;[;[;@|;0; @Æ/;'@*;I"Process::Waiter;F;So; ;IC;[Bo;;F; ;;;;I"Thread#set_trace_func;F;[[I" trace;T0;[[@àiB;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;= ;3I" overload;F;40;;‘;50;)I"set_trace_func(proc);T;IC;";T; @å/;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Proc;T; @å/;[;I"@return [Proc];T;0;6i;[[I" proc;T0; @å/o;= ;3I" overload;F;40;;‘;50;)I"set_trace_func(nil);T;IC;";T; @å/;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @å/;[;I"@return [nil];T;0;6i;[[I"nil;T0; @å/;[;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; @å/;!F;"o;#;$T;%i7;&i@;'@ã/;(I"xstatic VALUE thread_set_trace_func_m(VALUE target_thread, VALUE trace) { rb_execution_context_t *ec = GET_EC(); rb_thread_t *target_th = rb_thread_ptr(target_thread); rb_threadptr_remove_event_hook(ec, target_th, call_trace_func, Qundef); if (NIL_P(trace)) { return Qnil; } else { thread_add_trace_func(ec, target_th, trace); return trace; } };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#add_trace_func;F;[[I" trace;T0;[[@ài0;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;= ;3I" overload;F;40;;¬;50;)I"add_trace_func(proc);T;IC;";T; @0;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Proc;T; @0;[;I"@return [Proc];T;0;6i;[[I" proc;T0; @0;[;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; @0;!F;"o;#;$T;%i';&i-;'@ã/;(I"’static VALUE thread_add_trace_func_m(VALUE obj, VALUE trace) { thread_add_trace_func(GET_EC(), rb_thread_ptr(obj), trace); return trace; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Thread.new;F;[[@c0;[[I" thread.c;Ti ;T;;î;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; @20;!F;"o;#;$T;%iù;&i ;'@ã/;(I"static VALUE thread_s_new(int argc, VALUE *argv, VALUE klass) { rb_thread_t *th; VALUE thread = rb_thread_alloc(klass); if (GET_RACTOR()->threads.main->status == THREAD_KILLED) { rb_raise(rb_eThreadError, "can't alloc thread"); } rb_obj_call_init_kw(thread, argc, argv, RB_PASS_CALLED_KEYWORDS); th = rb_thread_ptr(thread); if (!threadptr_initialized(th)) { rb_raise(rb_eThreadError, "uninitialized thread - check `%"PRIsVALUE"#initialize'", klass); } return thread; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Thread.start;F;[[I" args;T0;[[@80i*;T;: start;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;= ;3I" overload;F;40;;;50;)I"start([args]*);T;IC;";T; @B0;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" args;T; @B0;[;I"@yield [args];T;0;6i;[[I"[args];T0; @B0o;= ;3I" overload;F;40;;¬;50;)I"fork([args]*);T;IC;";T; @B0;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" args;T; @B0;[;I"@yield [args];T;0;6i;[[I"[args];T0; @B0;[;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; @B0;!F;"o;#;$T;%i ;&i(;'@ã/;(I"static VALUE thread_start(VALUE klass, VALUE args) { struct thread_create_params params = { .type = thread_invoke_type_proc, .args = args, .proc = rb_block_proc(), }; return thread_create_core(rb_thread_alloc(klass), ¶ms); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Thread.fork;F;[[I" args;T0;[[@80i*;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;= ;3I" overload;F;40;;;50;)I"start([args]*);T;IC;";T; @p0;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" args;T; @p0;[;I"@yield [args];T;0;6i;[[I"[args];T0; @p0o;= ;3I" overload;F;40;;¬;50;)I"fork([args]*);T;IC;";T; @p0;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" args;T; @p0;[;I"@yield [args];T;0;6i;[[I"[args];T0; @p0;[;@l0;0; @p0;!F;"o;#;$T;%i ;&i(;'@ã/;(I"static VALUE thread_start(VALUE klass, VALUE args) { struct thread_create_params params = { .type = thread_invoke_type_proc, .args = args, .proc = rb_block_proc(), }; return thread_create_core(rb_thread_alloc(klass), ¶ms); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Thread.main;F;[;[[@80i€;T;: main;0;[;{;IC;"Returns the main thread. ;T;[o;= ;3I" overload;F;40;;®;50;)I" main;T;IC;";T; @0;>0;!F;[;[;I";T;0;6i;[; @0;[;I".Returns the main thread. @overload main;T;0; @0;!F;"o;#;$T;%iy;&i|;'@ã/;(I"Pstatic VALUE rb_thread_s_main(VALUE klass) { return rb_thread_main(); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Thread.current;F;[;[[@80im;T;:current;0;[;{;IC;"^Returns the currently executing thread. Thread.current #=> # ;T;[o;= ;3I" overload;F;40;;¯;50;)I"current;T;IC;";T; @³0;>0;!F;[;[;I";T;0;6i;[; @³0;[;I"rReturns the currently executing thread. Thread.current #=> # @overload current;T;0; @³0;!F;"o;#;$T;%id;&ii;'@ã/;(I"Sstatic VALUE thread_s_current(VALUE klass) { return rb_thread_current(); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Thread.stop;F;[;[[@80i5;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;= ;3I" overload;F;40;;°;50;)I" stop;T;IC;";T; @É0;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @É0;[;I"@return [nil];T;0;6i;[; @É0;[;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; @É0;!F;"o;#;$T;%i&;&i2;'@ã/;(I"Gstatic VALUE thread_stop(VALUE _) { return rb_thread_stop(); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Thread.kill;F;[[I"th;T0;[[@80i¸ ;T;;¥;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;= ;3I" overload;F;40;;¥;50;)I"kill(thread);T;IC;";T; @ä0;>0;!F;[;[;I";T;0;6i;[[I"thread;T0; @ä0;[;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; @ä0;!F;"o;#;$T;%iª ;&i´ ;'@ã/;(I"Zstatic VALUE rb_thread_s_kill(VALUE obj, VALUE th) { return rb_thread_kill(th); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Thread.exit;F;[;[[@80iË ;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;= ;3I" overload;F;40;;±;50;)I" exit;T;IC;";T; @þ0;>0;!F;[;[;I";T;0;6i;[; @þ0;[;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; @þ0;!F;"o;#;$T;%i¿ ;&iÇ ;'@ã/;(I"vstatic VALUE rb_thread_exit(VALUE _) { rb_thread_t *th = GET_THREAD(); return rb_thread_kill(th->self); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Thread.pass;F;[;[[@80i£;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;= ;3I" overload;F;40;;±;50;)I" pass;T;IC;";T; @1;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @1;[;I"@return [nil];T;0;6i;[; @1;[;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; @1;!F;"o;#;$T;%i›;&i ;'@ã/;(I"[static VALUE thread_s_pass(VALUE klass) { rb_thread_schedule(); return Qnil; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Thread.list;F;[;[[@80iX;T;: list;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;= ;3I" overload;F;40;;²;50;)I" list;T;IC;";T; @/1;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @/1;[;I"@return [Array];T;0;6i;[; @/1;[;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; @/1;!F;"o;#;$T;%iD;&iU;'@ã/;(I"Gstatic VALUE thread_list(VALUE _) { return rb_thread_list(); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Thread.abort_on_exception;F;[;[[@80i›;T;:abort_on_exception;0;[;{;IC;"¨Returns the status of the global ``abort on exception'' condition. The default is +false+. When set to +true+, if any thread is aborted by an exception, the raised exception will be re-raised in the main 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;= ;3I" overload;F;40;;³;50;)I"abort_on_exception;T;IC;";T; @J1;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @J1;[;I"@return [Boolean];T;0;6i;[; @J1;[;I"ÛReturns the status of the global ``abort on exception'' condition. The default is +false+. When set to +true+, if any thread is aborted by an exception, the raised exception will be re-raised in the main 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; @J1;!F;"o;#;$T;%i‡;&i˜;'@ã/;(I"}static VALUE rb_thread_s_abort_exc(VALUE _) { return GET_THREAD()->vm->thread_abort_on_exception ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Thread.abort_on_exception=;F;[[I"val;T0;[[@80iÀ;T;:abort_on_exception=;0;[;{;IC;"aWhen set to +true+, if any thread is aborted by an exception, the raised exception will be re-raised in the main thread. 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;= ;3I" overload;F;40;;´;50;)I"!abort_on_exception=(boolean);T;IC;";T; @e1;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @e1;[;I"@return [Boolean];T;0;6i;[[I"boolean;T0; @e1;[;I"žWhen set to +true+, if any thread is aborted by an exception, the raised exception will be re-raised in the main thread. 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; @e1;!F;"o;#;$T;%i¢;&i½;'@ã/;(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;)I"static VALUE;T;*To;;F; ;F;;;I"Thread.report_on_exception;F;[;[[@80i;T;:report_on_exception;0;[;{;IC;"^Returns the status of the global ``report on exception'' condition. The default is +true+ since Ruby 2.5. All threads created when this flag is true will report a message on $stderr if an exception kills the thread. Thread.new { 1.times { raise } } will produce this output on $stderr: # terminated with exception (report_on_exception is true): Traceback (most recent call last): 2: from -e:1:in `block in

' 1: from -e:1:in `times' This is done to catch errors in threads early. In some cases, you might not want this output. There are multiple ways to avoid the extra output: * If the exception is not intended, the best is to fix the cause of the exception so it does not happen anymore. * If the exception is intended, it might be better to rescue it closer to where it is raised rather then let it kill the Thread. * If it is guaranteed the Thread will be joined with Thread#join or Thread#value, then it is safe to disable this report with Thread.current.report_on_exception = false when starting the Thread. However, this might handle the exception much later, or not at all if the Thread is never joined due to the parent thread being blocked, etc. See also ::report_on_exception=. There is also an instance level method to set this for a specific thread, see #report_on_exception=. ;T;[o;= ;3I" overload;F;40;;µ;50;)I"report_on_exception;T;IC;";T; @„1;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @„1;[;I"@return [Boolean];T;0;6i;[; @„1;[;I"“Returns the status of the global ``report on exception'' condition. The default is +true+ since Ruby 2.5. All threads created when this flag is true will report a message on $stderr if an exception kills the thread. Thread.new { 1.times { raise } } will produce this output on $stderr: # terminated with exception (report_on_exception is true): Traceback (most recent call last): 2: from -e:1:in `block in

' 1: from -e:1:in `times' This is done to catch errors in threads early. In some cases, you might not want this output. There are multiple ways to avoid the extra output: * If the exception is not intended, the best is to fix the cause of the exception so it does not happen anymore. * If the exception is intended, it might be better to rescue it closer to where it is raised rather then let it kill the Thread. * If it is guaranteed the Thread will be joined with Thread#join or Thread#value, then it is safe to disable this report with Thread.current.report_on_exception = false when starting the Thread. However, this might handle the exception much later, or not at all if the Thread is never joined due to the parent thread being blocked, etc. See also ::report_on_exception=. There is also an instance level method to set this for a specific thread, see #report_on_exception=. @overload report_on_exception @return [Boolean];T;0; @„1;!F;"o;#;$T;%ió;&i;'@ã/;(I"static VALUE rb_thread_s_report_exc(VALUE _) { return GET_THREAD()->vm->thread_report_on_exception ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;F;;;I" Thread.report_on_exception=;F;[[I"val;T0;[[@80iB;T;:report_on_exception=;0;[;{;IC;"ÒReturns the new state. When set to +true+, all threads created afterwards will inherit the condition and report a message on $stderr if an exception kills a thread: Thread.report_on_exception = true t1 = Thread.new do puts "In new thread" raise "Exception from thread" end sleep(1) puts "In the main thread" This will produce: In new thread # terminated with exception (report_on_exception is true): Traceback (most recent call last): prog.rb:4:in `block in

': Exception from thread (RuntimeError) In the main thread See also ::report_on_exception. There is also an instance level method to set this for a specific thread, see #report_on_exception=. ;T;[o;= ;3I" overload;F;40;;¶;50;)I""report_on_exception=(boolean);T;IC;";T; @Ÿ1;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Ÿ1;[;I"@return [Boolean];T;0;6i;[[I"boolean;T0; @Ÿ1;[;I"Returns the new state. When set to +true+, all threads created afterwards will inherit the condition and report a message on $stderr if an exception kills a thread: Thread.report_on_exception = true t1 = Thread.new do puts "In new thread" raise "Exception from thread" end sleep(1) puts "In the main thread" This will produce: In new thread # terminated with exception (report_on_exception is true): Traceback (most recent call last): prog.rb:4:in `block in

': Exception from thread (RuntimeError) In the main thread See also ::report_on_exception. There is also an instance level method to set this for a specific thread, see #report_on_exception=. @overload report_on_exception=(boolean) @return [Boolean];T;0; @Ÿ1;!F;"o;#;$T;%i$;&i?;'@ã/;(I"‘static VALUE rb_thread_s_report_exc_set(VALUE self, VALUE val) { GET_THREAD()->vm->thread_report_on_exception = RTEST(val); return val; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Thread.ignore_deadlock;F;[;[[@80iU;T;:ignore_deadlock;0;[;{;IC;"¢Returns the status of the global ``ignore deadlock'' condition. The default is +false+, so that deadlock conditions are not ignored. See also ::ignore_deadlock=. ;T;[o;= ;3I" overload;F;40;;·;50;)I"ignore_deadlock;T;IC;";T; @¾1;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @¾1;[;I"@return [Boolean];T;0;6i;[; @¾1;[;I"ÓReturns the status of the global ``ignore deadlock'' condition. The default is +false+, so that deadlock conditions are not ignored. See also ::ignore_deadlock=. @overload ignore_deadlock @return [Boolean];T;0; @¾1;!F;"o;#;$T;%iJ;&iR;'@ã/;(I"{static VALUE rb_thread_s_ignore_deadlock(VALUE _) { return GET_THREAD()->vm->thread_ignore_deadlock ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Thread.ignore_deadlock=;F;[[I"val;T0;[[@80ip;T;:ignore_deadlock=;0;[;{;IC;"›Returns the new state. When set to +true+, the VM will not check for deadlock conditions. It is only useful to set this if your application can break a deadlock condition via some other means, such as a signal. Thread.ignore_deadlock = true queue = Queue.new trap(:SIGUSR1){queue.push "Received signal"} # raises fatal error unless ignoring deadlock puts queue.pop See also ::ignore_deadlock. ;T;[o;= ;3I" overload;F;40;;¸;50;)I"ignore_deadlock=(boolean);T;IC;";T; @Ù1;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Ù1;[;I"@return [Boolean];T;0;6i;[[I"boolean;T0; @Ù1;[;I"ÕReturns the new state. When set to +true+, the VM will not check for deadlock conditions. It is only useful to set this if your application can break a deadlock condition via some other means, such as a signal. Thread.ignore_deadlock = true queue = Queue.new trap(:SIGUSR1){queue.push "Received signal"} # raises fatal error unless ignoring deadlock puts queue.pop See also ::ignore_deadlock. @overload ignore_deadlock=(boolean) @return [Boolean];T;0; @Ù1;!F;"o;#;$T;%i\;&im;'@ã/;(I"’static VALUE rb_thread_s_ignore_deadlock_set(VALUE self, VALUE val) { GET_THREAD()->vm->thread_ignore_deadlock = RTEST(val); return val; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Thread.DEBUG;F;[;[[@80i5;T;: DEBUG;0;[;{;IC;"VReturns the thread debug level. Available only if compiled with THREAD_DEBUG=-1. ;T;[o;= ;3I" overload;F;40;;¹;50;)I" DEBUG;T;IC;";T; @ø1;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @ø1;[;I"@return [Numeric];T;0;6i;[; @ø1;[;I"|Returns the thread debug level. Available only if compiled with THREAD_DEBUG=-1. @overload DEBUG @return [Numeric];T;0; @ø1;!F;"o;#;$T;%i-;&i2;'@ã/;(I"]static VALUE rb_thread_s_debug(VALUE _) { return INT2NUM(rb_thread_debug_enabled); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Thread.DEBUG=;F;[[I"val;T0;[[@80iC;T;:DEBUG=;0;[;{;IC;"SSets the thread debug level. Available only if compiled with THREAD_DEBUG=-1. ;T;[o;= ;3I" overload;F;40;;º;50;)I"DEBUG=(num);T;IC;";T; @2;>0;!F;[;[;I";T;0;6i;[[I"num;T0; @2;[;I"kSets the thread debug level. Available only if compiled with THREAD_DEBUG=-1. @overload DEBUG=(num);T;0; @2;!F;"o;#;$T;%i;;&i?;'@ã/;(I"Šstatic VALUE rb_thread_s_debug_set(VALUE self, VALUE val) { rb_thread_debug_enabled = RTEST(val) ? NUM2INT(val) : 0; return val; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Thread.handle_interrupt;F;[[I" mask_arg;T0;[[@80iÉ;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

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; @-2;!F;"o;#;$T;%i_;&iÇ;'@ã/;(I"tstatic VALUE rb_thread_s_handle_interrupt(VALUE self, VALUE mask_arg) { VALUE mask; rb_execution_context_t * volatile ec = GET_EC(); rb_thread_t * volatile th = rb_ec_thread_ptr(ec); volatile VALUE r = Qnil; enum ruby_tag_type state; if (!rb_block_given_p()) { rb_raise(rb_eArgError, "block is needed."); } mask = 0; mask_arg = rb_to_hash_type(mask_arg); 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->ec); } EC_PUSH_TAG(th->ec); if ((state = EC_EXEC_TAG()) == TAG_NONE) { r = rb_yield(Qnil); } EC_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->ec); } RUBY_VM_CHECK_INTS(th->ec); if (state) { EC_JUMP_TAG(th->ec, state); } return r; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Thread.pending_interrupt?;F;[[@c0;[[@80iW ;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;= ;3I" overload;F;40;;¼;50;)I"$pending_interrupt?(error = nil);T;IC;";T; @J2;>0;!F;[;[;I";T;0;6i;[[I" error;TI"nil;T; @J2o;2 ;3I"return;F;4@|;0;5[@~; @J2;[;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; @J2;!F;"o;#;$T;%i ;&iS ;6i;'@ã/;(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;)I"static VALUE;T;*To;;F; ;;;;I"Thread#pending_interrupt?;F;[[@c0;[[@80i ;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;= ;3I" overload;F;40;;¼;50;)I"$pending_interrupt?(error = nil);T;IC;";T; @g2;>0;!F;[;[;I";T;0;6i;[[I" error;TI"nil;T; @g2o;2 ;3I"return;F;4@|;0;5[@~; @g2;[;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; @g2;!F;"o;#;$T;%iø;&iÿ;6i;'@ã/;(I"Çstatic VALUE rb_thread_pending_interrupt_p(int argc, VALUE *argv, VALUE target_thread) { rb_thread_t *target_th = rb_thread_ptr(target_thread); if (!target_th->pending_interrupt_queue) { return Qfalse; } if (rb_threadptr_pending_interrupt_empty_p(target_th)) { return Qfalse; } if (rb_check_arity(argc, 0, 1)) { VALUE err = argv[0]; 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; } } else { return Qtrue; } };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#initialize;F;[[I" args;T0;[[@80iA;T;;Ð;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @„2;!F;"o;#;$T;%i@;&i@;'@ã/;(I"kstatic VALUE thread_initialize(VALUE thread, VALUE args) { rb_thread_t *th = rb_thread_ptr(thread); if (!rb_block_given_p()) { rb_raise(rb_eThreadError, "must be called with a block"); } else if (th->invoke_type != thread_invoke_type_none) { VALUE loc = threadptr_invoke_proc_location(th); if (!NIL_P(loc)) { rb_raise(rb_eThreadError, "already initialized thread - %"PRIsVALUE":%"PRIsVALUE, RARRAY_AREF(loc, 0), RARRAY_AREF(loc, 1)); } else { rb_raise(rb_eThreadError, "already initialized thread"); } } else { struct thread_create_params params = { .type = thread_invoke_type_proc, .args = args, .proc = rb_block_proc(), }; return thread_create_core(thread, ¶ms); } };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#raise;F;[[@c0;[[@80ii ;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;= ;3I" overload;F;40;;’;50;)I" raise;T;IC;";T; @”2;>0;!F;[;[;I";T;0;6i;[; @”2o;= ;3I" overload;F;40;;’;50;)I"raise(string);T;IC;";T; @”2;>0;!F;[;[;I";T;0;6i;[[I"string;T0; @”2o;= ;3I" overload;F;40;;’;50;)I"*raise(exception [, string [, array]]);T;IC;";T; @”2;>0;!F;[;[;I";T;0;6i;[[I""exception[, string [, array]];T0; @”2;[;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; @”2;!F;"o;#;$T;%iT ;&ie ;'@ã/;(I"§static VALUE thread_raise_m(int argc, VALUE *argv, VALUE self) { rb_thread_t *target_th = rb_thread_ptr(self); const rb_thread_t *current_th = GET_THREAD(); threadptr_check_pending_interrupt_queue(target_th); rb_threadptr_raise(target_th, argc, argv); /* To perform Thread.current.raise as Kernel.raise */ if (current_th == target_th) { RUBY_VM_CHECK_INTS(target_th->ec); } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#join;F;[[@c0;[[@80i8;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;= ;3I" overload;F;40;;½;50;)I" join;T;IC;";T; @¿2;>0;!F;[;[;I";T;0;6i;[; @¿2o;= ;3I" overload;F;40;;½;50;)I"join(limit);T;IC;";T; @¿2;>0;!F;[;[;I";T;0;6i;[[I" limit;T0; @¿2;[;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; @¿2;!F;"o;#;$T;%i;&i4;'@ã/;(I"ústatic VALUE thread_join_m(int argc, VALUE *argv, VALUE self) { VALUE timeout = Qnil; if (rb_check_arity(argc, 0, 1)) { timeout = argv[0]; } // Convert the timeout eagerly, so it's always converted and deterministic if (timeout == Qnil) { /* unlimited */ } else if (FIXNUM_P(timeout)) { /* handled directly in thread_join_sleep() */ } else { timeout = rb_to_float(timeout); } return thread_join(rb_thread_ptr(self), timeout); };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#value;F;[;[[@80i];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;= ;3I" overload;F;40;;¾;50;)I" value;T;IC;";T; @à2;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @à2;[;I"@return [Object];T;0;6i;[; @à2;[;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; @à2;!F;"o;#;$T;%iO;&iZ;'@ã/;(I"…static VALUE thread_value(VALUE self) { rb_thread_t *th = rb_thread_ptr(self); thread_join(th, Qnil); return th->value; };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#kill;F;[;[[@80i… ;T;;¥;0;[;{;IC;"Terminates +thr+ and schedules another thread to be run, returning the terminated Thread. If this is the main thread, or the last thread, exits the process. ;T;[o;= ;3I" overload;F;40;;±;50;)I" exit;T;IC;";T; @û2;>0;!F;[;[;I";T;0;6i;[; @û2o;= ;3I" overload;F;40;;¥;50;)I" kill;T;IC;";T; @û2;>0;!F;[;[;I";T;0;6i;[; @û2o;= ;3I" overload;F;40;:terminate;50;)I"terminate;T;IC;";T; @û2;>0;!F;[;[;I";T;0;6i;[; @û2;[;I"ÑTerminates +thr+ and schedules another thread to be run, returning the terminated Thread. If this is the main thread, or the last thread, exits the process. @overload exit @overload kill @overload terminate;T;0; @û2;!F;"o;#;$T;%iz ;&i ;'@ã/;(I"MVALUE rb_thread_kill(VALUE thread) { rb_thread_t *th = rb_thread_ptr(thread); if (th->to_kill || th->status == THREAD_KILLED) { return thread; } if (th == th->vm->ractor.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;)I" VALUE;T;*To;;F; ;;;;I"Thread#terminate;F;[;[[@80i… ;T;;¿;0;[;{;IC;"Terminates +thr+ and schedules another thread to be run, returning the terminated Thread. If this is the main thread, or the last thread, exits the process. ;T;[o;= ;3I" overload;F;40;;±;50;)I" exit;T;IC;";T; @!3;>0;!F;[;[;I";T;0;6i;[; @!3o;= ;3I" overload;F;40;;¥;50;)I" kill;T;IC;";T; @!3;>0;!F;[;[;I";T;0;6i;[; @!3o;= ;3I" overload;F;40;;¿;50;)I"terminate;T;IC;";T; @!3;>0;!F;[;[;I";T;0;6i;[; @!3;[;@3;0; @!3;!F;"o;#;$T;%iz ;&i ;'@ã/;(I"MVALUE rb_thread_kill(VALUE thread) { rb_thread_t *th = rb_thread_ptr(thread); if (th->to_kill || th->status == THREAD_KILLED) { return thread; } if (th == th->vm->ractor.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;)I" VALUE;T;*To;;F; ;;;;I"Thread#exit;F;[;[[@80i… ;T;;±;0;[;{;IC;"Terminates +thr+ and schedules another thread to be run, returning the terminated Thread. If this is the main thread, or the last thread, exits the process. ;T;[o;= ;3I" overload;F;40;;±;50;)I" exit;T;IC;";T; @F3;>0;!F;[;[;I";T;0;6i;[; @F3o;= ;3I" overload;F;40;;¥;50;)I" kill;T;IC;";T; @F3;>0;!F;[;[;I";T;0;6i;[; @F3o;= ;3I" overload;F;40;;¿;50;)I"terminate;T;IC;";T; @F3;>0;!F;[;[;I";T;0;6i;[; @F3;[;@3;0; @F3;!F;"o;#;$T;%iz ;&i ;'@ã/;(I"MVALUE rb_thread_kill(VALUE thread) { rb_thread_t *th = rb_thread_ptr(thread); if (th->to_kill || th->status == THREAD_KILLED) { return thread; } if (th == th->vm->ractor.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;)I" VALUE;T;*To;;F; ;;;;I"Thread#run;F;[;[[@80i;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;= ;3I" overload;F;40;;À;50;)I"run;T;IC;";T; @k3;>0;!F;[;[;I";T;0;6i;[; @k3;[;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; @k3;!F;"o;#;$T;%iý ;&i;'@ã/;(I"uVALUE rb_thread_run(VALUE thread) { rb_thread_wakeup(thread); rb_thread_schedule(); return thread; };T;)I" VALUE;T;*To;;F; ;;;;I"Thread#wakeup;F;[;[[@80iã ;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;= ;3I" overload;F;40;;Á;50;)I"wakeup;T;IC;";T; @3;>0;!F;[;[;I";T;0;6i;[; @3;[;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; @3;!F;"o;#;$T;%iÓ ;&iß ;'@ã/;(I" VALUE rb_thread_wakeup(VALUE thread) { if (!RTEST(rb_thread_wakeup_alive(thread))) { rb_raise(rb_eThreadError, "killed thread"); } return thread; };T;)I" VALUE;T;*To;;F; ;;;;I"Thread#[];F;[[I"key;T0;[[@80iÙ ;T;:[];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;= ;3I" overload;F;40;;Â;50;)I"[](sym);T;IC;";T; @—3;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @—3;[;I"@return [Object, nil];T;0;6i;[[I"sym;T0; @—3;[;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; @—3;!F;"o;#;$T;%i ;&iÖ ;'@ã/;(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;)I"static VALUE;T;*To;;F; ;;;;I"Thread#[]=;F;[[I"id;T0[I"val;T0;[[@80iB;T;:[]=;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;= ;3I" overload;F;40;;Ã;50;)I" []=(sym);T;IC;";T; @·3;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @·3;[;I"@return [Object];T;0;6i;[[I"sym;T0; @·3;[;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; @·3;!F;"o;#;$T;%i5;&i?;'@ã/;(I"static VALUE rb_thread_aset(VALUE self, VALUE id, VALUE val) { return rb_thread_local_aset(self, rb_to_id(id), val); };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#fetch;F;[[@c0;[[@80iî ;T;: fetch;0;[;{;IC;"JReturns a fiber-local for the given key. If the key can't be found, there are several options: With no other arguments, it will raise a 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. See Thread#[] and Hash#fetch. ;T;[o;= ;3I" overload;F;40;;Ä;50;)I"fetch(sym);T;IC;";T; @Ø3;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @Ø3;[;I"@return [Object];T;0;6i;[[I"sym;T0; @Ø3o;= ;3I" overload;F;40;;Ä;50;)I"fetch(sym);T;IC;";T; @Ø3;>0;!F;[o;2 ;3I" yield;F;4I"[];T;0;50; @Ø3o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @Ø3;[;I"@yield [] @return [Object];T;0;6i;[[I"sym;T0; @Ø3o;= ;3I" overload;F;40;;Ä;50;)I"fetch(sym, default);T;IC;";T; @Ø3;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @Ø3;[;I"@return [Object];T;0;6i;[[I"sym;T0[I"default;T0; @Ø3;[;I"ÙReturns a fiber-local for the given key. If the key can't be found, there are several options: With no other arguments, it will raise a 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. See Thread#[] and Hash#fetch. @overload fetch(sym) @return [Object] @overload fetch(sym) @yield [] @return [Object] @overload fetch(sym, default) @return [Object];T;0; @Ø3;!F;"o;#;$T;%iá ;&iï ;'@ã/;(I"-static VALUE rb_thread_fetch(int argc, VALUE *argv, VALUE self) { VALUE key, val; ID id; rb_thread_t *target_th = rb_thread_ptr(self); int 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"); } id = rb_check_id(&key); if (id == recursive_key) { return target_th->ec->local_storage_recursive_hash; } else if (id && target_th->ec->local_storage && rb_id_table_lookup(target_th->ec->local_storage, id, &val)) { return val; } else if (block_given) { return rb_yield(key); } else if (argc == 1) { rb_key_err_raise(rb_sprintf("key not found: %+"PRIsVALUE, key), self, key); } else { return argv[1]; } };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#key?;F;[[I"key;T0;[[@80i“;T;: key?;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;= ;3I" overload;F;40;;Å;50;)I"key?(sym);T;IC;";T; @4;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @4;[;I"@return [Boolean];T;0;6i;[[I"sym;T0; @4;[;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; @4;!F;"o;#;$T;%i†;&i;6i;'@ã/;(I"fstatic VALUE rb_thread_key_p(VALUE self, VALUE key) { VALUE val; ID id = rb_check_id(&key); struct rb_id_table *local_storage = rb_thread_ptr(self)->ec->local_storage; if (!id || local_storage == NULL) { return Qfalse; } else if (rb_id_table_lookup(local_storage, id, &val)) { return Qtrue; } else { return Qfalse; } };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#keys;F;[;[[@80iÁ;T;: keys;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;= ;3I" overload;F;40;;Æ;50;)I" keys;T;IC;";T; @84;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @84;[;I"@return [Array];T;0;6i;[; @84;[;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; @84;!F;"o;#;$T;%i³;&i¾;'@ã/;(I" static VALUE rb_thread_keys(VALUE self) { struct rb_id_table *local_storage = rb_thread_ptr(self)->ec->local_storage; VALUE ary = rb_ary_new(); if (local_storage) { rb_id_table_foreach(local_storage, thread_keys_i, (void *)ary); } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#priority;F;[;[[@80i(;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;= ;3I" overload;F;40;;Ç;50;)I" priority;T;IC;";T; @S4;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @S4;[;I"@return [Integer];T;0;6i;[; @S4;[;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; @S4;!F;"o;#;$T;%i;&i%;'@ã/;(I"kstatic VALUE rb_thread_priority(VALUE thread) { return INT2NUM(rb_thread_ptr(thread)->priority); };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#priority=;F;[[I" prio;T0;[[@80iI;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;= ;3I" overload;F;40;;È;50;)I"priority=(integer);T;IC;";T; @n4;>0;!F;[;[;I";T;0;6i;[[I"integer;T0; @n4;[;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; @n4;!F;"o;#;$T;%i/;&iE;'@ã/;(I"1static VALUE rb_thread_priority_set(VALUE thread, VALUE prio) { rb_thread_t *target_th = rb_thread_ptr(thread); int priority; #if USE_NATIVE_THREAD_PRIORITY target_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; } target_th->priority = (int8_t)priority; #endif return INT2NUM(target_th->priority); };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#status;F;[;[[@80iì;T;:status;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;= ;3I" overload;F;40;;É;50;)I"status;T;IC;";T; @ˆ4;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI" false;TI"nil;T; @ˆ4;[;I"!@return [String, false, nil];T;0;6i;[; @ˆ4;[;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; @ˆ4;!F;"o;#;$T;%iÍ;&ié;'@ã/;(I"cstatic VALUE rb_thread_status(VALUE thread) { rb_thread_t *target_th = rb_thread_ptr(thread); if (rb_threadptr_dead(target_th)) { if (!NIL_P(target_th->ec->errinfo) && !FIXNUM_P(target_th->ec->errinfo)) { return Qnil; } else { return Qfalse; } } else { return rb_str_new2(thread_status_name(target_th, FALSE)); } };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#thread_variable_get;F;[[I"key;T0;[[@80id;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;= ;3I" overload;F;40;;Ê;50;)I"thread_variable_get(key);T;IC;";T; @¥4;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @¥4;[;I"@return [Object, nil];T;0;6i;[[I"key;T0; @¥4;[;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; @¥4;!F;"o;#;$T;%iH;&ia;'@ã/;(I"static VALUE rb_thread_variable_get(VALUE thread, VALUE key) { VALUE locals; if (LIKELY(!THREAD_LOCAL_STORAGE_INITIALISED_P(thread))) { return Qnil; } locals = rb_thread_local_storage(thread); return rb_hash_aref(locals, rb_to_symbol(key)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#thread_variable_set;F;[[I"key;T0[I"val;T0;[[@80iy;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;= ;3I" overload;F;40;;Ë;50;)I"$thread_variable_set(key, value);T;IC;";T; @Å4;>0;!F;[;[;I";T;0;6i;[[I"key;T0[I" value;T0; @Å4;[;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; @Å4;!F;"o;#;$T;%ip;&iu;'@ã/;(I"6static VALUE rb_thread_variable_set(VALUE thread, VALUE key, VALUE val) { VALUE locals; if (OBJ_FROZEN(thread)) { rb_frozen_error_raise(thread, "can't modify frozen thread locals"); } locals = rb_thread_local_storage(thread); return rb_hash_aset(locals, rb_to_symbol(key), val); };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#thread_variables;F;[;[[@80iå;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;= ;3I" overload;F;40;;Ì;50;)I"thread_variables;T;IC;";T; @ã4;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ã4;[;I"@return [Array];T;0;6i;[; @ã4;[;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; @ã4;!F;"o;#;$T;%iÔ;&iâ;'@ã/;(I".static VALUE rb_thread_variables(VALUE thread) { VALUE locals; VALUE ary; ary = rb_ary_new(); if (LIKELY(!THREAD_LOCAL_STORAGE_INITIALISED_P(thread))) { return ary; } locals = rb_thread_local_storage(thread); rb_hash_foreach(locals, keys_i, ary); return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#thread_variable?;F;[[I"key;T0;[[@80i;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;= ;3I" overload;F;40;;Í;50;)I"thread_variable?(key);T;IC;";T; @þ4;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @þ4;[;I"@return [Boolean];T;0;6i;[[I"key;T0; @þ4;[;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; @þ4;!F;"o;#;$T;%iõ;&i;6i;'@ã/;(I"qstatic VALUE rb_thread_variable_p(VALUE thread, VALUE key) { VALUE locals; if (LIKELY(!THREAD_LOCAL_STORAGE_INITIALISED_P(thread))) { return Qfalse; } locals = rb_thread_local_storage(thread); if (rb_hash_lookup(locals, rb_to_symbol(key)) != Qnil) { return Qtrue; } else { return Qfalse; } return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#alive?;F;[;[[@80i ;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;= ;3I" overload;F;40;;Î;50;)I"alive?;T;IC;";T; @5;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @5;[;I"@return [Boolean];T;0;6i;[; @5;[;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; @5;!F;"o;#;$T;%i ;&i ;6i;'@ã/;(I"¦static VALUE rb_thread_alive_p(VALUE thread) { if (thread_finished(rb_thread_ptr(thread))) { return Qfalse; } else { return Qtrue; } };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#stop?;F;[;[[@80i' ;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;= ;3I" overload;F;40;;Ï;50;)I" stop?;T;IC;";T; @85;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @85;[;I"@return [Boolean];T;0;6i;[; @85;[;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; @85;!F;"o;#;$T;%i ;&i$ ;6i;'@ã/;(I"$static VALUE rb_thread_stop_p(VALUE thread) { rb_thread_t *th = rb_thread_ptr(thread); if (rb_threadptr_dead(th)) { return Qtrue; } else if (th->status == THREAD_STOPPED || th->status == THREAD_STOPPED_FOREVER) { return Qtrue; } else { return Qfalse; } };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#abort_on_exception;F;[;[[@80i×;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;= ;3I" overload;F;40;;³;50;)I"abort_on_exception;T;IC;";T; @S5;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @S5;[;I"@return [Boolean];T;0;6i;[; @S5;[;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; @S5;!F;"o;#;$T;%iÈ;&iÔ;'@ã/;(I"~static VALUE rb_thread_abort_exc(VALUE thread) { return rb_thread_ptr(thread)->abort_on_exception ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#abort_on_exception=;F;[[I"val;T0;[[@80ië;T;;´;0;[;{;IC;"óWhen set to +true+, if this +thr+ is aborted by an exception, the raised exception will be re-raised in the main thread. See also #abort_on_exception. There is also a class level method to set this for all threads, see ::abort_on_exception=. ;T;[o;= ;3I" overload;F;40;;´;50;)I"!abort_on_exception=(boolean);T;IC;";T; @n5;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @n5;[;I"@return [Boolean];T;0;6i;[[I"boolean;T0; @n5;[;I"0When set to +true+, if this +thr+ is aborted by an exception, the raised exception will be re-raised in the main thread. 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; @n5;!F;"o;#;$T;%iÞ;&iè;'@ã/;(I"static VALUE rb_thread_abort_exc_set(VALUE thread, VALUE val) { rb_thread_ptr(thread)->abort_on_exception = RTEST(val); return val; };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#report_on_exception;F;[;[[@80iˆ;T;;µ;0;[;{;IC;"@Returns the status of the thread-local ``report on exception'' condition for this +thr+. The default value when creating a Thread is the value of the global flag Thread.report_on_exception. See also #report_on_exception=. There is also a class level method to set this for all new threads, see ::report_on_exception=. ;T;[o;= ;3I" overload;F;40;;µ;50;)I"report_on_exception;T;IC;";T; @5;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @5;[;I"@return [Boolean];T;0;6i;[; @5;[;I"tReturns the status of the thread-local ``report on exception'' condition for this +thr+. The default value when creating a Thread is the value of the global flag Thread.report_on_exception. See also #report_on_exception=. There is also a class level method to set this for all new threads, see ::report_on_exception=. @overload report_on_exception @return [Boolean];T;0; @5;!F;"o;#;$T;%ix;&i…;'@ã/;(I"{static VALUE rb_thread_report_exc(VALUE thread) { return rb_thread_ptr(thread)->report_on_exception ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I" Thread#report_on_exception=;F;[[I"val;T0;[[@80iœ;T;;¶;0;[;{;IC;"þWhen set to +true+, a message is printed on $stderr if an exception kills this +thr+. See ::report_on_exception for details. See also #report_on_exception. There is also a class level method to set this for all new threads, see ::report_on_exception=. ;T;[o;= ;3I" overload;F;40;;¶;50;)I""report_on_exception=(boolean);T;IC;";T; @¨5;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @¨5;[;I"@return [Boolean];T;0;6i;[[I"boolean;T0; @¨5;[;I"report_on_exception = RTEST(val); return val; };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#group;F;[;[[@80i®;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;= ;3I" overload;F;40;;Ð;50;)I" group;T;IC;";T; @Ç5;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @Ç5;[;I"@return [nil];T;0;6i;[; @Ç5;[;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; @Ç5;!F;"o;#;$T;%i¤;&i«;'@ã/;(I"VALUE rb_thread_group(VALUE thread) { VALUE group = rb_thread_ptr(thread)->thgroup; return group == 0 ? Qnil : group; };T;)I" VALUE;T;*To;;F; ;;;;I"Thread#backtrace;F;[[@c0;[[@80i ;T;;ñ;0;[;{;IC;"8Returns the current backtrace of the target thread. ;T;[o;= ;3I" overload;F;40;;ñ;50;)I"backtrace;T;IC;";T; @â5;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;TI"nil;T; @â5;[;I"@return [Array, nil];T;0;6i;[; @â5;[;I"fReturns the current backtrace of the target thread. @overload backtrace @return [Array, nil];T;0; @â5;!F;"o;#;$T;%i;&i;'@ã/;(I"€static VALUE rb_thread_backtrace_m(int argc, VALUE *argv, VALUE thval) { return rb_vm_thread_backtrace(argc, argv, thval); };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#backtrace_locations;F;[[@c0;[[@80i1;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;= ;3I" overload;F;40;;ò;50;)I"/backtrace_locations(*args) -> array or nil;T;IC;";T; @ÿ5;>0;!F;[;[;I";T;0;6i;[[I" *args;T0; @ÿ5;[;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; @ÿ5;!F;"o;#;$T;%i&;&i/;'@ã/;(I"”static VALUE rb_thread_backtrace_locations_m(int argc, VALUE *argv, VALUE thval) { return rb_vm_thread_backtrace_locations(argc, argv, thval); };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#name;F;[;[[@80i? ;T;: name;0;[;{;IC;"!show the name of the thread. ;T;[o;= ;3I" overload;F;40;;Ñ;50;)I" name;T;IC;";T; @6;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @6;[;I"@return [String];T;0;6i;[; @6;[;I"Eshow the name of the thread. @overload name @return [String];T;0; @6;!F;"o;#;$T;%i8 ;&i< ;'@ã/;(I"]static VALUE rb_thread_getname(VALUE thread) { return rb_thread_ptr(thread)->name; };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#name=;F;[[I" name;T0;[[@80iM ;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;= ;3I" overload;F;40;;Ò;50;)I"name=(name);T;IC;";T; @36;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @36;[;I"@return [String];T;0;6i;[[I" name;T0; @36;[;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; @36;!F;"o;#;$T;%iE ;&iJ ;'@ã/;(I"static VALUE rb_thread_setname(VALUE thread, VALUE name) { rb_thread_t *target_th = rb_thread_ptr(thread); 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); } target_th->name = name; if (threadptr_initialized(target_th)) { native_set_another_thread_name(target_th->thread_id, name); } return name; };T;)I"static VALUE;T;*To;;F; ;;;;I"Thread#to_s;F;[;[[@80ij ;T;;q;0;[;{;IC;"8Dump the name, id, and status of _thr_ to a string. ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @R6;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @R6;[;I"@return [String];T;0;6i;[; @R6;[;I"\Dump the name, id, and status of _thr_ to a string. @overload to_s @return [String];T;0; o;;F; ;;;;I"Thread#inspect;F;[;[[@80i”;F;;r;;K;[;{;@Y6;'@ã/;)I"static VALUE;T;(I"´static VALUE rb_thread_to_s(VALUE thread) { VALUE cname = rb_class_path(rb_obj_class(thread)); rb_thread_t *target_th = rb_thread_ptr(thread); const char *status; VALUE str, loc; status = thread_status_name(target_th, TRUE); str = rb_sprintf("#<%"PRIsVALUE":%p", cname, (void *)thread); if (!NIL_P(target_th->name)) { rb_str_catf(str, "@%"PRIsVALUE, target_th->name); } if ((loc = threadptr_invoke_proc_location(target_th)) != Qnil) { rb_str_catf(str, " %"PRIsVALUE":%"PRIsVALUE, RARRAY_AREF(loc, 0), RARRAY_AREF(loc, 1)); rb_gc_force_recycle(loc); } rb_str_catf(str, " %s>", status); return str; };T;!F;"o;#;$T;%ic ;&ig ;'@ã/;(I"´static VALUE rb_thread_to_s(VALUE thread) { VALUE cname = rb_class_path(rb_obj_class(thread)); rb_thread_t *target_th = rb_thread_ptr(thread); const char *status; VALUE str, loc; status = thread_status_name(target_th, TRUE); str = rb_sprintf("#<%"PRIsVALUE":%p", cname, (void *)thread); if (!NIL_P(target_th->name)) { rb_str_catf(str, "@%"PRIsVALUE, target_th->name); } if ((loc = threadptr_invoke_proc_location(target_th)) != Qnil) { rb_str_catf(str, " %"PRIsVALUE":%"PRIsVALUE, RARRAY_AREF(loc, 0), RARRAY_AREF(loc, 1)); rb_gc_force_recycle(loc); } rb_str_catf(str, " %s>", status); return str; };T;)@q6;*T@j6o; ;IC;[o; ;IC;[o;;F; ;;;;I"'Thread::Backtrace::Location#lineno;F;[;[[@³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; @y6;!F;"o;#;$T;%i±;&i·;'@w6;(I"lstatic VALUE location_lineno_m(VALUE self) { return INT2FIX(location_lineno(location_ptr(self))); };T;)I"static VALUE;T;*To;;F; ;;;;I"&Thread::Backtrace::Location#label;F;[;[[@³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; @‡6;!F;"o;#;$T;%iÎ;&iç;'@w6;(I"astatic VALUE location_label_m(VALUE self) { return location_label(location_ptr(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"+Thread::Backtrace::Location#base_label;F;[;[[@³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; @•6;!F;"o;#;$T;%iþ;&i;'@w6;(I"kstatic VALUE location_base_label_m(VALUE self) { return location_base_label(location_ptr(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"%Thread::Backtrace::Location#path;F;[;[[@³i%;T;: path;0;[;{;IC;"?Returns the file name of this frame. This will generally be an absolute path, unless the frame is in the main script, in which case it will be the script location passed on the command line. 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. This will generally be an absolute path, unless the frame is in the main script, in which case it will be the script location passed on the command line. For example, using +caller_locations.rb+ from Thread::Backtrace::Location loc = c(0..1).first loc.path #=> caller_locations.rb ;T;0; @£6;!F;"o;#;$T;%i;&i#;'@w6;(I"_static VALUE location_path_m(VALUE self) { return location_path(location_ptr(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I".Thread::Backtrace::Location#absolute_path;F;[;[[@³iC;T;:absolute_path;0;[;{;IC;"‹Returns the full file path of this frame. Same as #path, except that it will return absolute path even if the frame is in the main script. ;T;[;[;I"ŒReturns the full file path of this frame. Same as #path, except that it will return absolute path even if the frame is in the main script. ;T;0; @±6;!F;"o;#;$T;%i=;&iA;'@w6;(I"lstatic VALUE location_absolute_path_m(VALUE self) { return location_realpath(location_ptr(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"%Thread::Backtrace::Location#to_s;F;[;[[@³i‚;T;;q;0;[;{;IC;"BReturns a Kernel#caller style string representing this frame. ;T;[;[;I"CReturns a Kernel#caller style string representing this frame. ;T;0; @¿6;!F;"o;#;$T;%i;&i€;'@w6;(I"cstatic VALUE location_to_str_m(VALUE self) { return location_to_str(location_ptr(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"(Thread::Backtrace::Location#inspect;F;[;[[@³iŒ;T;;r;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; @Í6;!F;"o;#;$T;%iˆ;&iŠ;'@w6;(I"tstatic VALUE location_inspect_m(VALUE self) { return rb_str_inspect(location_to_str(location_ptr(self))); };T;)I"static VALUE;T;*T;A@w6;BIC;[;A@w6;CIC;[;A@w6;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@³i;F;: Location;;K;;;[;{;IC;";T;[;[;@|;0; @w6;6i;'@u6;I" Thread::Backtrace::Location;F;S@];A@u6;BIC;[;A@u6;CIC;[;A@u6;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@³iá;F;:Backtrace;;K;;;[;{;IC;";T;[;[;@|;0; @u6;'@ã/;I"Thread::Backtrace;F;S@]o;;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;'@ã/;(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;)I"static VALUE;T;*To;;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; @7;'@ã/;(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;)I"static VALUE;T;*To;;F; ;;;;I"Thread#__ubf_async_safe__;F;[[I"notify_fd;T0;[[@7i@;T;:__ubf_async_safe__;0;[;{;IC;";T;[;[;@|;0; @7;'@ã/;(I"óstatic VALUE thread_ubf_async_safe(VALUE thread, VALUE notify_fd) { struct loop_ctl ctl; ctl.notify_fd = NUM2INT(notify_fd); ctl.stop = 0; rb_nogvl(do_loop, &ctl, stop_set, &ctl, RB_NOGVL_UBF_ASYNC_SAFE); return thread; };T;)I"static VALUE;T;*T;A@ã/;BIC;[;A@ã/;CIC;[;A@ã/;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@j6;q;I[;[[I" vm.c;TiI [@.7iç ;T;:Thread;;K;;;[;{;IC;"±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 "What's 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 #=> "What's 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 "What's 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 } To retrieve the last value of a thread, use #value thr = Thread.new { sleep 1; "Useful value" } thr.value #=> "Useful value" === 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 { sleep } 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 When an unhandled exception is raised inside a thread, it will terminate. By default, this exception will not propagate to other threads. The exception is stored and when another thread calls #value or #join, the exception will be re-raised in that thread. t = Thread.new{ raise 'something went wrong' } t.value #=> RuntimeError: something went wrong An exception can be raised from outside the thread using the Thread#raise instance method, which takes the same parameters as Kernel#raise. Setting Thread.abort_on_exception = true, Thread#abort_on_exception = true, or $DEBUG = true will cause a subsequent unhandled exception raised in a thread to be automatically re-raised in the main thread. 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"´ 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 "What's 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 #=> "What's 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 "What's 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 } To retrieve the last value of a thread, use #value thr = Thread.new { sleep 1; "Useful value" } thr.value #=> "Useful value" === 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 { sleep } 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 When an unhandled exception is raised inside a thread, it will terminate. By default, this exception will not propagate to other threads. The exception is stored and when another thread calls #value or #join, the exception will be re-raised in that thread. t = Thread.new{ raise 'something went wrong' } t.value #=> RuntimeError: something went wrong An exception can be raised from outside the thread using the Thread#raise instance method, which takes the same parameters as Kernel#raise. Setting Thread.abort_on_exception = true, Thread#abort_on_exception = true, or $DEBUG = true will cause a subsequent unhandled exception raised in a thread to be automatically re-raised in the main thread. 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; @ã/;!F;"o;#;$T;%iI ;&iä ;'@;I"Thread;F;S@]o;;F; ;;;Ï;I"Process#pid;F;[;[[@P iù;T;;—;0;[;{;IC;"hReturns the process id of this process. Not available on all platforms. Process.pid #=> 27415 ;T; @87;>0;!F;[o;= ;3I" overload;F;40;;—;50;)I"pid;T;IC;";T; @87;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @87;[;I"@return [Integer];T;0;6i;[; @87;[;I"†Returns the process id of this process. Not available on all platforms. Process.pid #=> 27415 @overload pid @return [Integer];T;0;'@*;(I"Astatic VALUE proc_get_pid(VALUE _) { return get_pid(); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.pid;F;@:7;@;7;T;;—;0;@=7;{;IC;"hReturns the process id of this process. Not available on all platforms. Process.pid #=> 27415;T;[o;= ;3I" overload;F;40;;—;50;)I"pid;T;IC;";T; @R7;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @R7;[;I"@return [Integer];T;0;6i;[; @R7;[;I"‡Returns the process id of this process. Not available on all platforms. Process.pid #=> 27415 @overload pid @return [Integer];T;0; @R7;!F;"o;#;$T;%iï;&iö;6i;'@*;(@P7;)@Q7;*To;;F; ;;;Ï;I"Process#ppid;F;[;[[@P i;T;: ppid;0;[;{;IC;"Returns the process id of the parent of this process. Returns untrustworthy value on Win32/64. Not available on all platforms. puts "I am #{Process.pid}" Process.fork { puts "Dad is #{Process.ppid}" } produces: I am 27417 Dad is 27417 ;T; @g7;>0;!F;[o;= ;3I" overload;F;40;;Ý;50;)I" ppid;T;IC;";T; @g7;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @g7;[;I"@return [Integer];T;0;6i;[; @g7;[;I"&Returns the process id of the parent of this process. Returns untrustworthy value on Win32/64. Not available on all platforms. puts "I am #{Process.pid}" Process.fork { puts "Dad is #{Process.ppid}" } produces: I am 27417 Dad is 27417 @overload ppid @return [Integer];T;0;'@*;(I"Cstatic VALUE proc_get_ppid(VALUE _) { return get_ppid(); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.ppid;F;@i7;@j7;T;;Ý;0;@l7;{;IC;"Returns the process id of the parent of this process. Returns untrustworthy value on Win32/64. Not available on all platforms. puts "I am #{Process.pid}" Process.fork { puts "Dad is #{Process.ppid}" } produces: I am 27417 Dad is 27417;T;[o;= ;3I" overload;F;40;;Ý;50;)I" ppid;T;IC;";T; @7;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @7;[;I"@return [Integer];T;0;6i;[; @7;[;I"'Returns the process id of the parent of this process. Returns untrustworthy value on Win32/64. Not available on all platforms. puts "I am #{Process.pid}" Process.fork { puts "Dad is #{Process.ppid}" } produces: I am 27417 Dad is 27417 @overload ppid @return [Integer];T;0; @7;!F;"o;#;$T;%i;&i;6i;'@*;(@7;)@€7;*To;;F; ;;;Ï;I"Process#getpgrp;F;[;[[@P i;T;:getpgrp;0;[;{;IC;"“Returns the process group ID for this process. Not available on all platforms. Process.getpgid(0) #=> 25527 Process.getpgrp #=> 25527 ;T; @–7;>0;!F;[o;= ;3I" overload;F;40;;Þ;50;)I"getpgrp;T;IC;";T; @–7;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @–7;[;I"@return [Integer];T;0;6i;[; @–7;[;I"ºReturns the process group ID for this process. Not available on all platforms. Process.getpgid(0) #=> 25527 Process.getpgrp #=> 25527 @overload getpgrp @return [Integer];T;0;'@*;(I"=static VALUE proc_getpgrp(VALUE _) { rb_pid_t pgrp; #if defined(HAVE_GETPGRP) && defined(GETPGRP_VOID) pgrp = getpgrp(); if (pgrp < 0) rb_sys_fail(0); return PIDT2NUM(pgrp); #else /* defined(HAVE_GETPGID) */ pgrp = getpgid(0); if (pgrp < 0) rb_sys_fail(0); return PIDT2NUM(pgrp); #endif };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.getpgrp;F;@˜7;@™7;T;;Þ;0;@›7;{;IC;"“Returns the process group ID for this process. Not available on all platforms. Process.getpgid(0) #=> 25527 Process.getpgrp #=> 25527;T;[o;= ;3I" overload;F;40;;Þ;50;)I"getpgrp;T;IC;";T; @°7;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @°7;[;I"@return [Integer];T;0;6i;[; @°7;[;I"»Returns the process group ID for this process. Not available on all platforms. Process.getpgid(0) #=> 25527 Process.getpgrp #=> 25527 @overload getpgrp @return [Integer];T;0; @°7;!F;"o;#;$T;%i ;&i;6i;'@*;(@®7;)@¯7;*To;;F; ;;;Ï;I"Process#setpgrp;F;[;[[@P i1;T;:setpgrp;0;[;{;IC;"MEquivalent to setpgid(0,0). Not available on all platforms. ;T; @Å7;>0;!F;[o;= ;3I" overload;F;40;;ß;50;)I"setpgrp;T;IC;";T; @Å7;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @Å7;[;I"@return [0];T;0;6i;[; @Å7;[;I"nEquivalent to setpgid(0,0). Not available on all platforms. @overload setpgrp @return [0];T;0;'@*;(I"Ëstatic VALUE proc_setpgrp(VALUE _) { /* check for posix setpgid() first; this matches the posix */ /* getpgrp() above. It appears that configure will set SETPGRP_VOID */ /* even though setpgrp(0,0) would be preferred. The posix call avoids */ /* this confusion. */ #ifdef HAVE_SETPGID if (setpgid(0,0) < 0) rb_sys_fail(0); #elif defined(HAVE_SETPGRP) && defined(SETPGRP_VOID) if (setpgrp() < 0) rb_sys_fail(0); #endif return INT2FIX(0); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.setpgrp;F;@Ç7;@È7;T;;ß;0;@Ê7;{;IC;"MEquivalent to setpgid(0,0). Not available on all platforms.;T;[o;= ;3I" overload;F;40;;ß;50;)I"setpgrp;T;IC;";T; @ß7;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @ß7;[;I"@return [0];T;0;6i;[; @ß7;[;I"oEquivalent to setpgid(0,0). Not available on all platforms. @overload setpgrp @return [0];T;0; @ß7;!F;"o;#;$T;%i);&i.;6i;'@*;(@Ý7;)@Þ7;*To;;F; ;;;Ï;I"Process#getpgid;F;[[I"pid;T0;[[@P iO;T;:getpgid;0;[;{;IC;"†Returns the process group ID for the given process id. Not available on all platforms. Process.getpgid(Process.ppid()) #=> 25527 ;T; @ô7;>0;!F;[o;= ;3I" overload;F;40;;à;50;)I"getpgid(pid);T;IC;";T; @ô7;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ô7;[;I"@return [Integer];T;0;6i;[[I"pid;T0; @ô7;[;I"²Returns the process group ID for the given process id. Not available on all platforms. Process.getpgid(Process.ppid()) #=> 25527 @overload getpgid(pid) @return [Integer];T;0;'@*;(I"›static VALUE proc_getpgid(VALUE obj, VALUE pid) { rb_pid_t i; i = getpgid(NUM2PIDT(pid)); if (i < 0) rb_sys_fail(0); return PIDT2NUM(i); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.getpgid;F;@ö7;@ù7;T;;à;0;@û7;{;IC;"†Returns the process group ID for the given process id. Not available on all platforms. Process.getpgid(Process.ppid()) #=> 25527;T;[o;= ;3I" overload;F;40;;à;50;)I"getpgid(pid);T;IC;";T; @8;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @8;[;I"@return [Integer];T;0;6i;[[I"pid;T0; @8;[;I"³Returns the process group ID for the given process id. Not available on all platforms. Process.getpgid(Process.ppid()) #=> 25527 @overload getpgid(pid) @return [Integer];T;0; @8;!F;"o;#;$T;%iE;&iL;6i;'@*;(@8;)@8;*To;;F; ;;;Ï;I"Process#setpgid;F;[[I"pid;T0[I" pgrp;T0;[[@P if;T;:setpgid;0;[;{;IC;"wSets the process group ID of _pid_ (0 indicates this process) to integer. Not available on all platforms. ;T; @)8;>0;!F;[o;= ;3I" overload;F;40;;á;50;)I"setpgid(pid, integer);T;IC;";T; @)8;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @)8;[;I"@return [0];T;0;6i;[[I"pid;T0[I"integer;T0; @)8;[;I"¡Sets the process group ID of _pid_ (0 indicates this process) to integer. Not available on all platforms. @overload setpgid(pid, integer) @return [0];T;0;'@*;(I"Ústatic VALUE proc_setpgid(VALUE obj, VALUE pid, VALUE pgrp) { rb_pid_t ipid, ipgrp; ipid = NUM2PIDT(pid); ipgrp = NUM2PIDT(pgrp); if (setpgid(ipid, ipgrp) < 0) rb_sys_fail(0); return INT2FIX(0); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.setpgid;F;@+8;@08;T;;á;0;@28;{;IC;"wSets the process group ID of _pid_ (0 indicates this process) to integer. Not available on all platforms.;T;[o;= ;3I" overload;F;40;;á;50;)I"setpgid(pid, integer);T;IC;";T; @K8;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @K8;[;I"@return [0];T;0;6i;[[I"pid;T0[I"integer;T0; @K8;[;I"¢Sets the process group ID of _pid_ (0 indicates this process) to integer. Not available on all platforms. @overload setpgid(pid, integer) @return [0];T;0; @K8;!F;"o;#;$T;%i^;⁣6i;'@*;(@I8;)@J8;*To;;F; ;;;Ï;I"Process#getsid;F;[[@c0;[[@P iƒ;T;:getsid;0;[;{;IC;"Returns the session ID for the given process id. If not given, return current process sid. Not available on all platforms. Process.getsid() #=> 27422 Process.getsid(0) #=> 27422 Process.getsid(Process.pid()) #=> 27422 ;T; @d8;>0;!F;[o;= ;3I" overload;F;40;;â;50;)I" getsid();T;IC;";T; @d8;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @d8;[;I"@return [Integer];T;0;6i;[; @d8o;= ;3I" overload;F;40;;â;50;)I"getsid(pid);T;IC;";T; @d8;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @d8;[;I"@return [Integer];T;0;6i;[[I"pid;T0; @d8;[;I"UReturns the session ID for the given process id. If not given, return current process sid. Not available on all platforms. Process.getsid() #=> 27422 Process.getsid(0) #=> 27422 Process.getsid(Process.pid()) #=> 27422 @overload getsid() @return [Integer] @overload getsid(pid) @return [Integer];T;0;'@*;(I"static VALUE proc_getsid(int argc, VALUE *argv, VALUE _) { rb_pid_t sid; rb_pid_t pid = 0; if (rb_check_arity(argc, 0, 1) == 1 && !NIL_P(argv[0])) pid = NUM2PIDT(argv[0]); sid = getsid(pid); if (sid < 0) rb_sys_fail(0); return PIDT2NUM(sid); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.getsid;F;@f8;@h8;T;;â;0;@j8;{;IC;"Returns the session ID for the given process id. If not given, return current process sid. Not available on all platforms. Process.getsid() #=> 27422 Process.getsid(0) #=> 27422 Process.getsid(Process.pid()) #=> 27422;T;[o;= ;3I" overload;F;40;;â;50;)I" getsid();T;IC;";T; @Ž8;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ž8;[;I"@return [Integer];T;0;6i;[; @Ž8o;= ;3I" overload;F;40;;â;50;)I"getsid(pid);T;IC;";T; @Ž8;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ž8;[;I"@return [Integer];T;0;6i;[[I"pid;T0; @Ž8;[;I"UReturns the session ID for the given process id. If not given, return current process sid. Not available on all platforms. Process.getsid() #=> 27422 Process.getsid(0) #=> 27422 Process.getsid(Process.pid()) #=> 27422 @overload getsid() @return [Integer] @overload getsid(pid) @return [Integer];T;0; @Ž8;!F;"o;#;$T;%iw;&i‚;6i;'@*;(@Œ8;)@8;*To;;F; ;;;Ï;I"Process#setsid;F;[;[[@P i¥;T;:setsid;0;[;{;IC;"³Establishes this process as a new session and process group leader, with no controlling tty. Returns the session id. Not available on all platforms. Process.setsid #=> 27422 ;T; @²8;>0;!F;[o;= ;3I" overload;F;40;;ã;50;)I"setsid;T;IC;";T; @²8;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @²8;[;I"@return [Integer];T;0;6i;[; @²8;[;I"ÙEstablishes this process as a new session and process group leader, with no controlling tty. Returns the session id. Not available on all platforms. Process.setsid #=> 27422 @overload setsid @return [Integer];T;0;'@*;(I"‡static VALUE proc_setsid(VALUE _) { rb_pid_t pid; pid = setsid(); if (pid < 0) rb_sys_fail(0); return PIDT2NUM(pid); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.setsid;F;@´8;@µ8;T;;ã;0;@·8;{;IC;"³Establishes this process as a new session and process group leader, with no controlling tty. Returns the session id. Not available on all platforms. Process.setsid #=> 27422;T;[o;= ;3I" overload;F;40;;ã;50;)I"setsid;T;IC;";T; @Ì8;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ì8;[;I"@return [Integer];T;0;6i;[; @Ì8;[;I"ÚEstablishes this process as a new session and process group leader, with no controlling tty. Returns the session id. Not available on all platforms. Process.setsid #=> 27422 @overload setsid @return [Integer];T;0; @Ì8;!F;"o;#;$T;%iš;&i¢;6i;'@*;(@Ê8;)@Ë8;*To;;F; ;;;Ï;I"Process#getpriority;F;[[I" which;T0[I"who;T0;[[@P iá;T;:getpriority;0;[;{;IC;"üGets the scheduling priority for specified process, process group, or user. kind indicates the kind of entity to find: one of Process::PRIO_PGRP, Process::PRIO_USER, or Process::PRIO_PROCESS. _integer_ is an id indicating the particular process, process group, or user (an id of 0 means _current_). Lower priorities are more favorable for scheduling. Not available on all platforms. Process.getpriority(Process::PRIO_USER, 0) #=> 19 Process.getpriority(Process::PRIO_PROCESS, 0) #=> 19 ;T; @á8;>0;!F;[o;= ;3I" overload;F;40;;ä;50;)I"getpriority(kind, integer);T;IC;";T; @á8;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @á8;[;I"@return [Integer];T;0;6i;[[I" kind;T0[I"integer;T0; @á8;[;I"6Gets the scheduling priority for specified process, process group, or user. kind indicates the kind of entity to find: one of Process::PRIO_PGRP, Process::PRIO_USER, or Process::PRIO_PROCESS. _integer_ is an id indicating the particular process, process group, or user (an id of 0 means _current_). Lower priorities are more favorable for scheduling. Not available on all platforms. Process.getpriority(Process::PRIO_USER, 0) #=> 19 Process.getpriority(Process::PRIO_PROCESS, 0) #=> 19 @overload getpriority(kind, integer) @return [Integer];T;0;'@*;(I"static VALUE proc_getpriority(VALUE obj, VALUE which, VALUE who) { int prio, iwhich, iwho; iwhich = NUM2INT(which); iwho = NUM2INT(who); errno = 0; prio = getpriority(iwhich, iwho); if (errno) rb_sys_fail(0); return INT2FIX(prio); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.getpriority;F;@ã8;@è8;T;;ä;0;@ê8;{;IC;"üGets the scheduling priority for specified process, process group, or user. kind indicates the kind of entity to find: one of Process::PRIO_PGRP, Process::PRIO_USER, or Process::PRIO_PROCESS. _integer_ is an id indicating the particular process, process group, or user (an id of 0 means _current_). Lower priorities are more favorable for scheduling. Not available on all platforms. Process.getpriority(Process::PRIO_USER, 0) #=> 19 Process.getpriority(Process::PRIO_PROCESS, 0) #=> 19;T;[o;= ;3I" overload;F;40;;ä;50;)I"getpriority(kind, integer);T;IC;";T; @9;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @9;[;I"@return [Integer];T;0;6i;[[I" kind;T0[I"integer;T0; @9;[;I"7Gets the scheduling priority for specified process, process group, or user. kind indicates the kind of entity to find: one of Process::PRIO_PGRP, Process::PRIO_USER, or Process::PRIO_PROCESS. _integer_ is an id indicating the particular process, process group, or user (an id of 0 means _current_). Lower priorities are more favorable for scheduling. Not available on all platforms. Process.getpriority(Process::PRIO_USER, 0) #=> 19 Process.getpriority(Process::PRIO_PROCESS, 0) #=> 19 @overload getpriority(kind, integer) @return [Integer];T;0; @9;!F;"o;#;$T;%iÐ;&iÞ;6i;'@*;(@9;)@9;*To;;F; ;;;Ï;I"Process#setpriority;F;[[I" which;T0[I"who;T0[I" prio;T0;[[@P i;T;:setpriority;0;[;{;IC;"See Process.getpriority. Process.setpriority(Process::PRIO_USER, 0, 19) #=> 0 Process.setpriority(Process::PRIO_PROCESS, 0, 19) #=> 0 Process.getpriority(Process::PRIO_USER, 0) #=> 19 Process.getpriority(Process::PRIO_PROCESS, 0) #=> 19 ;T; @9;>0;!F;[o;= ;3I" overload;F;40;;å;50;)I")setpriority(kind, integer, priority);T;IC;";T; @9;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @9;[;I"@return [0];T;0;6i;[[I" kind;T0[I"integer;T0[I" priority;T0; @9;[;I"MSee Process.getpriority. Process.setpriority(Process::PRIO_USER, 0, 19) #=> 0 Process.setpriority(Process::PRIO_PROCESS, 0, 19) #=> 0 Process.getpriority(Process::PRIO_USER, 0) #=> 19 Process.getpriority(Process::PRIO_PROCESS, 0) #=> 19 @overload setpriority(kind, integer, priority) @return [0];T;0;'@*;(I"static VALUE proc_setpriority(VALUE obj, VALUE which, VALUE who, VALUE prio) { int iwhich, iwho, iprio; iwhich = NUM2INT(which); iwho = NUM2INT(who); iprio = NUM2INT(prio); if (setpriority(iwhich, iwho, iprio) < 0) rb_sys_fail(0); return INT2FIX(0); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.setpriority;F;@9;@%9;T;;å;0;@'9;{;IC;"See Process.getpriority. Process.setpriority(Process::PRIO_USER, 0, 19) #=> 0 Process.setpriority(Process::PRIO_PROCESS, 0, 19) #=> 0 Process.getpriority(Process::PRIO_USER, 0) #=> 19 Process.getpriority(Process::PRIO_PROCESS, 0) #=> 19;T;[o;= ;3I" overload;F;40;;å;50;)I")setpriority(kind, integer, priority);T;IC;";T; @B9;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @B9;[;I"@return [0];T;0;6i;[[I" kind;T0[I"integer;T0[I" priority;T0; @B9;[;I"NSee Process.getpriority. Process.setpriority(Process::PRIO_USER, 0, 19) #=> 0 Process.setpriority(Process::PRIO_PROCESS, 0, 19) #=> 0 Process.getpriority(Process::PRIO_USER, 0) #=> 19 Process.getpriority(Process::PRIO_PROCESS, 0) #=> 19 @overload setpriority(kind, integer, priority) @return [0];T;0; @B9;!F;"o;#;$T;%iô;&iý;6i;'@*;(@@9;)@A9;*To;{;[[@P i";F;:PRIO_PROCESS;;};;;[;{;IC;"see Process.setpriority ;T;[;[;I"see Process.setpriority;T;0; @]9;!F;"o;#;$T;%i ";&i ";'@*;I"Process::PRIO_PROCESS;F;~I"INT2FIX(PRIO_PROCESS);To;{;[[@P i";F;:PRIO_PGRP;;};;;[;{;IC;"see Process.setpriority ;T;[;[;I"see Process.setpriority;T;0; @i9;!F;"o;#;$T;%i";&i";'@*;I"Process::PRIO_PGRP;F;~I"INT2FIX(PRIO_PGRP);To;{;[[@P i";F;:PRIO_USER;;};;;[;{;IC;"see Process.setpriority ;T;[;[;I"see Process.setpriority;T;0; @u9;!F;"o;#;$T;%i";&i";'@*;I"Process::PRIO_USER;F;~I"INT2FIX(PRIO_USER);To;;F; ;;;Ï;I"Process#getrlimit;F;[[I" resource;T0;[[@P i;T;:getrlimit;0;[;{;IC;"Gets the resource limit of the process. _cur_limit_ means current (soft) limit and _max_limit_ means maximum (hard) limit. _resource_ indicates the kind of resource to limit. It is specified as a symbol such as :CORE, a string such as "CORE" or a constant such as Process::RLIMIT_CORE. See Process.setrlimit for details. _cur_limit_ and _max_limit_ may be Process::RLIM_INFINITY, Process::RLIM_SAVED_MAX or Process::RLIM_SAVED_CUR. See Process.setrlimit and the system getrlimit(2) manual for details. ;T; @9;>0;!F;[o;= ;3I" overload;F;40;;é;50;)I"getrlimit(resource);T;IC;";T; @9;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @9;[;I"@return [Array];T;0;6i;[[I" resource;T0; @9;[;I"BGets the resource limit of the process. _cur_limit_ means current (soft) limit and _max_limit_ means maximum (hard) limit. _resource_ indicates the kind of resource to limit. It is specified as a symbol such as :CORE, a string such as "CORE" or a constant such as Process::RLIMIT_CORE. See Process.setrlimit for details. _cur_limit_ and _max_limit_ may be Process::RLIM_INFINITY, Process::RLIM_SAVED_MAX or Process::RLIM_SAVED_CUR. See Process.setrlimit and the system getrlimit(2) manual for details. @overload getrlimit(resource) @return [Array];T;0;'@*;(I"ÿstatic VALUE proc_getrlimit(VALUE obj, VALUE resource) { struct rlimit rlim; if (getrlimit(rlimit_resource_type(resource), &rlim) < 0) { rb_sys_fail("getrlimit"); } return rb_assoc_new(RLIM2NUM(rlim.rlim_cur), RLIM2NUM(rlim.rlim_max)); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.getrlimit;F;@ƒ9;@†9;T;;é;0;@ˆ9;{;IC;"Gets the resource limit of the process. _cur_limit_ means current (soft) limit and _max_limit_ means maximum (hard) limit. _resource_ indicates the kind of resource to limit. It is specified as a symbol such as :CORE, a string such as "CORE" or a constant such as Process::RLIMIT_CORE. See Process.setrlimit for details. _cur_limit_ and _max_limit_ may be Process::RLIM_INFINITY, Process::RLIM_SAVED_MAX or Process::RLIM_SAVED_CUR. See Process.setrlimit and the system getrlimit(2) manual for details.;T;[o;= ;3I" overload;F;40;;é;50;)I"getrlimit(resource);T;IC;";T; @Ÿ9;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @Ÿ9;[;I"@return [Array];T;0;6i;[[I" resource;T0; @Ÿ9;[;I"CGets the resource limit of the process. _cur_limit_ means current (soft) limit and _max_limit_ means maximum (hard) limit. _resource_ indicates the kind of resource to limit. It is specified as a symbol such as :CORE, a string such as "CORE" or a constant such as Process::RLIMIT_CORE. See Process.setrlimit for details. _cur_limit_ and _max_limit_ may be Process::RLIM_INFINITY, Process::RLIM_SAVED_MAX or Process::RLIM_SAVED_CUR. See Process.setrlimit and the system getrlimit(2) manual for details. @overload getrlimit(resource) @return [Array];T;0; @Ÿ9;!F;"o;#;$T;%ið;&i;6i;'@*;(@9;)@ž9;*To;;F; ;;;Ï;I"Process#setrlimit;F;[[@c0;[[@P iF;T;:setrlimit;0;[;{;IC;"õSets the resource limit of the process. _cur_limit_ means current (soft) limit and _max_limit_ means maximum (hard) limit. If _max_limit_ is not given, _cur_limit_ is used. _resource_ indicates the kind of resource to limit. It should be a symbol such as :CORE, a string such as "CORE" or a constant such as Process::RLIMIT_CORE. The available resources are OS dependent. Ruby may support following resources. [AS] total available memory (bytes) (SUSv3, NetBSD, FreeBSD, OpenBSD but 4.4BSD-Lite) [CORE] core size (bytes) (SUSv3) [CPU] CPU time (seconds) (SUSv3) [DATA] data segment (bytes) (SUSv3) [FSIZE] file size (bytes) (SUSv3) [MEMLOCK] total size for mlock(2) (bytes) (4.4BSD, GNU/Linux) [MSGQUEUE] allocation for POSIX message queues (bytes) (GNU/Linux) [NICE] ceiling on process's nice(2) value (number) (GNU/Linux) [NOFILE] file descriptors (number) (SUSv3) [NPROC] number of processes for the user (number) (4.4BSD, GNU/Linux) [RSS] resident memory size (bytes) (4.2BSD, GNU/Linux) [RTPRIO] ceiling on the process's real-time priority (number) (GNU/Linux) [RTTIME] CPU time for real-time process (us) (GNU/Linux) [SBSIZE] all socket buffers (bytes) (NetBSD, FreeBSD) [SIGPENDING] number of queued signals allowed (signals) (GNU/Linux) [STACK] stack size (bytes) (SUSv3) _cur_limit_ and _max_limit_ may be :INFINITY, "INFINITY" or Process::RLIM_INFINITY, which means that the resource is not limited. They may be Process::RLIM_SAVED_MAX, Process::RLIM_SAVED_CUR and corresponding symbols and strings too. See system setrlimit(2) manual for details. The following example raises the soft limit of core size to the hard limit to try to make core dump possible. Process.setrlimit(:CORE, Process.getrlimit(:CORE)[1]) ;T; @¶9;>0;!F;[o;= ;3I" overload;F;40;;ê;50;)I".setrlimit(resource, cur_limit, max_limit);T;IC;";T; @¶9;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @¶9;[;I"@return [nil];T;0;6i;[[I" resource;T0[I"cur_limit;T0[I"max_limit;T0; @¶9o;= ;3I" overload;F;40;;ê;50;)I"#setrlimit(resource, cur_limit);T;IC;";T; @¶9;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @¶9;[;I"@return [nil];T;0;6i;[[I" resource;T0[I"cur_limit;T0; @¶9;[;I"tSets the resource limit of the process. _cur_limit_ means current (soft) limit and _max_limit_ means maximum (hard) limit. If _max_limit_ is not given, _cur_limit_ is used. _resource_ indicates the kind of resource to limit. It should be a symbol such as :CORE, a string such as "CORE" or a constant such as Process::RLIMIT_CORE. The available resources are OS dependent. Ruby may support following resources. [AS] total available memory (bytes) (SUSv3, NetBSD, FreeBSD, OpenBSD but 4.4BSD-Lite) [CORE] core size (bytes) (SUSv3) [CPU] CPU time (seconds) (SUSv3) [DATA] data segment (bytes) (SUSv3) [FSIZE] file size (bytes) (SUSv3) [MEMLOCK] total size for mlock(2) (bytes) (4.4BSD, GNU/Linux) [MSGQUEUE] allocation for POSIX message queues (bytes) (GNU/Linux) [NICE] ceiling on process's nice(2) value (number) (GNU/Linux) [NOFILE] file descriptors (number) (SUSv3) [NPROC] number of processes for the user (number) (4.4BSD, GNU/Linux) [RSS] resident memory size (bytes) (4.2BSD, GNU/Linux) [RTPRIO] ceiling on the process's real-time priority (number) (GNU/Linux) [RTTIME] CPU time for real-time process (us) (GNU/Linux) [SBSIZE] all socket buffers (bytes) (NetBSD, FreeBSD) [SIGPENDING] number of queued signals allowed (signals) (GNU/Linux) [STACK] stack size (bytes) (SUSv3) _cur_limit_ and _max_limit_ may be :INFINITY, "INFINITY" or Process::RLIM_INFINITY, which means that the resource is not limited. They may be Process::RLIM_SAVED_MAX, Process::RLIM_SAVED_CUR and corresponding symbols and strings too. See system setrlimit(2) manual for details. The following example raises the soft limit of core size to the hard limit to try to make core dump possible. Process.setrlimit(:CORE, Process.getrlimit(:CORE)[1]) @overload setrlimit(resource, cur_limit, max_limit) @return [nil] @overload setrlimit(resource, cur_limit) @return [nil];T;0;'@*;(I"üstatic VALUE proc_setrlimit(int argc, VALUE *argv, VALUE obj) { VALUE resource, rlim_cur, rlim_max; struct rlimit rlim; rb_check_arity(argc, 2, 3); resource = argv[0]; rlim_cur = argv[1]; if (argc < 3 || NIL_P(rlim_max = argv[2])) rlim_max = rlim_cur; rlim.rlim_cur = rlimit_resource_value(rlim_cur); rlim.rlim_max = rlimit_resource_value(rlim_max); if (setrlimit(rlimit_resource_type(resource), &rlim) < 0) { rb_sys_fail("setrlimit"); } return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.setrlimit;F;@¸9;@º9;T;;ê;0;@¼9;{;IC;"õSets the resource limit of the process. _cur_limit_ means current (soft) limit and _max_limit_ means maximum (hard) limit. If _max_limit_ is not given, _cur_limit_ is used. _resource_ indicates the kind of resource to limit. It should be a symbol such as :CORE, a string such as "CORE" or a constant such as Process::RLIMIT_CORE. The available resources are OS dependent. Ruby may support following resources. [AS] total available memory (bytes) (SUSv3, NetBSD, FreeBSD, OpenBSD but 4.4BSD-Lite) [CORE] core size (bytes) (SUSv3) [CPU] CPU time (seconds) (SUSv3) [DATA] data segment (bytes) (SUSv3) [FSIZE] file size (bytes) (SUSv3) [MEMLOCK] total size for mlock(2) (bytes) (4.4BSD, GNU/Linux) [MSGQUEUE] allocation for POSIX message queues (bytes) (GNU/Linux) [NICE] ceiling on process's nice(2) value (number) (GNU/Linux) [NOFILE] file descriptors (number) (SUSv3) [NPROC] number of processes for the user (number) (4.4BSD, GNU/Linux) [RSS] resident memory size (bytes) (4.2BSD, GNU/Linux) [RTPRIO] ceiling on the process's real-time priority (number) (GNU/Linux) [RTTIME] CPU time for real-time process (us) (GNU/Linux) [SBSIZE] all socket buffers (bytes) (NetBSD, FreeBSD) [SIGPENDING] number of queued signals allowed (signals) (GNU/Linux) [STACK] stack size (bytes) (SUSv3) _cur_limit_ and _max_limit_ may be :INFINITY, "INFINITY" or Process::RLIM_INFINITY, which means that the resource is not limited. They may be Process::RLIM_SAVED_MAX, Process::RLIM_SAVED_CUR and corresponding symbols and strings too. See system setrlimit(2) manual for details. The following example raises the soft limit of core size to the hard limit to try to make core dump possible. Process.setrlimit(:CORE, Process.getrlimit(:CORE)[1]);T;[o;= ;3I" overload;F;40;;ê;50;)I".setrlimit(resource, cur_limit, max_limit);T;IC;";T; @è9;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @è9;[;I"@return [nil];T;0;6i;[[I" resource;T0[I"cur_limit;T0[I"max_limit;T0; @è9o;= ;3I" overload;F;40;;ê;50;)I"#setrlimit(resource, cur_limit);T;IC;";T; @è9;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @è9;[;I"@return [nil];T;0;6i;[[I" resource;T0[I"cur_limit;T0; @è9;[;I"uSets the resource limit of the process. _cur_limit_ means current (soft) limit and _max_limit_ means maximum (hard) limit. If _max_limit_ is not given, _cur_limit_ is used. _resource_ indicates the kind of resource to limit. It should be a symbol such as :CORE, a string such as "CORE" or a constant such as Process::RLIMIT_CORE. The available resources are OS dependent. Ruby may support following resources. [AS] total available memory (bytes) (SUSv3, NetBSD, FreeBSD, OpenBSD but 4.4BSD-Lite) [CORE] core size (bytes) (SUSv3) [CPU] CPU time (seconds) (SUSv3) [DATA] data segment (bytes) (SUSv3) [FSIZE] file size (bytes) (SUSv3) [MEMLOCK] total size for mlock(2) (bytes) (4.4BSD, GNU/Linux) [MSGQUEUE] allocation for POSIX message queues (bytes) (GNU/Linux) [NICE] ceiling on process's nice(2) value (number) (GNU/Linux) [NOFILE] file descriptors (number) (SUSv3) [NPROC] number of processes for the user (number) (4.4BSD, GNU/Linux) [RSS] resident memory size (bytes) (4.2BSD, GNU/Linux) [RTPRIO] ceiling on the process's real-time priority (number) (GNU/Linux) [RTTIME] CPU time for real-time process (us) (GNU/Linux) [SBSIZE] all socket buffers (bytes) (NetBSD, FreeBSD) [SIGPENDING] number of queued signals allowed (signals) (GNU/Linux) [STACK] stack size (bytes) (SUSv3) _cur_limit_ and _max_limit_ may be :INFINITY, "INFINITY" or Process::RLIM_INFINITY, which means that the resource is not limited. They may be Process::RLIM_SAVED_MAX, Process::RLIM_SAVED_CUR and corresponding symbols and strings too. See system setrlimit(2) manual for details. The following example raises the soft limit of core size to the hard limit to try to make core dump possible. Process.setrlimit(:CORE, Process.getrlimit(:CORE)[1]) @overload setrlimit(resource, cur_limit, max_limit) @return [nil] @overload setrlimit(resource, cur_limit) @return [nil];T;0; @è9;!F;"o;#;$T;%i;&iD;6i;'@*;(@æ9;)@ç9;*To;{;[[@P i";F;:RLIM_SAVED_MAX;;};;;[;{;IC;"see Process.setrlimit ;T;[;[;I"see Process.setrlimit;T;0; @:;!F;"o;#;$T;%i";&i";'@*;I"Process::RLIM_SAVED_MAX;F;~I"v;To;{;[[@P i"";F;:RLIM_INFINITY;;};;;[;{;IC;"see Process.setrlimit ;T;[;[;I"see Process.setrlimit;T;0; @ :;!F;"o;#;$T;%i!";&i!";'@*;I"Process::RLIM_INFINITY;F;~I"inf;To;{;[[@P i'";F;:RLIM_SAVED_CUR;;};;;[;{;IC;"see Process.setrlimit ;T;[;[;I"see Process.setrlimit;T;0; @,:;!F;"o;#;$T;%i&";&i&";'@*;I"Process::RLIM_SAVED_CUR;F;~I"v;To;{;[[@P i0";F;:RLIMIT_AS;;};;;[;{;IC;"|Maximum size of the process's virtual memory (address space) in bytes. see the system getrlimit(2) manual for details. ;T;[;[;I"}Maximum size of the process's virtual memory (address space) in bytes. see the system getrlimit(2) manual for details. ;T;0; @8:;!F;"o;#;$T;%i,";&i/";'@*;I"Process::RLIMIT_AS;F;~I"INT2FIX(RLIMIT_AS);To;{;[[@P i7";F;:RLIMIT_CORE;;};;;[;{;IC;"TMaximum size of the core file. see the system getrlimit(2) manual for details. ;T;[;[;I"UMaximum size of the core file. see the system getrlimit(2) manual for details. ;T;0; @D:;!F;"o;#;$T;%i3";&i6";'@*;I"Process::RLIMIT_CORE;F;~I"INT2FIX(RLIMIT_CORE);To;{;[[@P i>";F;:RLIMIT_CPU;;};;;[;{;IC;"PCPU time limit in seconds. see the system getrlimit(2) manual for details. ;T;[;[;I"QCPU time limit in seconds. see the system getrlimit(2) manual for details. ;T;0; @P:;!F;"o;#;$T;%i:";&i=";'@*;I"Process::RLIMIT_CPU;F;~I"INT2FIX(RLIMIT_CPU);To;{;[[@P iE";F;:RLIMIT_DATA;;};;;[;{;IC;"aMaximum size of the process's data segment. see the system getrlimit(2) manual for details. ;T;[;[;I"bMaximum size of the process's data segment. see the system getrlimit(2) manual for details. ;T;0; @\:;!F;"o;#;$T;%iA";&iD";'@*;I"Process::RLIMIT_DATA;F;~I"INT2FIX(RLIMIT_DATA);To;{;[[@P iL";F;:RLIMIT_FSIZE;;};;;[;{;IC;"hMaximum size of files that the process may create. see the system getrlimit(2) manual for details. ;T;[;[;I"iMaximum size of files that the process may create. see the system getrlimit(2) manual for details. ;T;0; @h:;!F;"o;#;$T;%iH";&iK";'@*;I"Process::RLIMIT_FSIZE;F;~I"INT2FIX(RLIMIT_FSIZE);To;{;[[@P iS";F;:RLIMIT_MEMLOCK;;};;;[;{;IC;"tMaximum number of bytes of memory that may be locked into RAM. see the system getrlimit(2) manual for details. ;T;[;[;I"uMaximum number of bytes of memory that may be locked into RAM. see the system getrlimit(2) manual for details. ;T;0; @t:;!F;"o;#;$T;%iO";&iR";'@*;I"Process::RLIMIT_MEMLOCK;F;~I"INT2FIX(RLIMIT_MEMLOCK);To;{;[[@P i[";F;:RLIMIT_MSGQUEUE;;};;;[;{;IC;"·Specifies the limit on the number of bytes that can be allocated for POSIX message queues for the real user ID of the calling process. see the system getrlimit(2) manual for details. ;T;[;[;I"¸Specifies the limit on the number of bytes that can be allocated for POSIX message queues for the real user ID of the calling process. see the system getrlimit(2) manual for details. ;T;0; @€:;!F;"o;#;$T;%iV";&iZ";'@*;I"Process::RLIMIT_MSGQUEUE;F;~I"INT2FIX(RLIMIT_MSGQUEUE);To;{;[[@P ib";F;:RLIMIT_NICE;;};;;[;{;IC;"zSpecifies a ceiling to which the process's nice value can be raised. see the system getrlimit(2) manual for details. ;T;[;[;I"{Specifies a ceiling to which the process's nice value can be raised. see the system getrlimit(2) manual for details. ;T;0; @Œ:;!F;"o;#;$T;%i^";&ia";'@*;I"Process::RLIMIT_NICE;F;~I"INT2FIX(RLIMIT_NICE);To;{;[[@P ij";F;:RLIMIT_NOFILE;;};;;[;{;IC;"šSpecifies a value one greater than the maximum file descriptor number that can be opened by this process. see the system getrlimit(2) manual for details. ;T;[;[;I"›Specifies a value one greater than the maximum file descriptor number that can be opened by this process. see the system getrlimit(2) manual for details. ;T;0; @˜:;!F;"o;#;$T;%ie";&ii";'@*;I"Process::RLIMIT_NOFILE;F;~I"INT2FIX(RLIMIT_NOFILE);To;{;[[@P ir";F;:RLIMIT_NPROC;;};;;[;{;IC;"‘The maximum number of processes that can be created for the real user ID of the calling process. see the system getrlimit(2) manual for details. ;T;[;[;I"’The maximum number of processes that can be created for the real user ID of the calling process. see the system getrlimit(2) manual for details. ;T;0; @¤:;!F;"o;#;$T;%im";&iq";'@*;I"Process::RLIMIT_NPROC;F;~I"INT2FIX(RLIMIT_NPROC);To;{;[[@P iy";F;:RLIMIT_RSS;;};;;[;{;IC;"sSpecifies the limit (in pages) of the process's resident set. see the system getrlimit(2) manual for details. ;T;[;[;I"tSpecifies the limit (in pages) of the process's resident set. see the system getrlimit(2) manual for details. ;T;0; @°:;!F;"o;#;$T;%iu";&ix";'@*;I"Process::RLIMIT_RSS;F;~I"INT2FIX(RLIMIT_RSS);To;{;[[@P i€";F;:RLIMIT_RTPRIO;;};;;[;{;IC;"€Specifies a ceiling on the real-time priority that may be set for this process. see the system getrlimit(2) manual for details. ;T;[;[;I"Specifies a ceiling on the real-time priority that may be set for this process. see the system getrlimit(2) manual for details. ;T;0; @¼:;!F;"o;#;$T;%i|";&i";'@*;I"Process::RLIMIT_RTPRIO;F;~I"INT2FIX(RLIMIT_RTPRIO);To;{;[[@P iˆ";F;:RLIMIT_RTTIME;;};;;[;{;IC;"”Specifies limit on CPU time this process scheduled under a real-time scheduling policy can consume. see the system getrlimit(2) manual for details. ;T;[;[;I"•Specifies limit on CPU time this process scheduled under a real-time scheduling policy can consume. see the system getrlimit(2) manual for details. ;T;0; @È:;!F;"o;#;$T;%iƒ";&i‡";'@*;I"Process::RLIMIT_RTTIME;F;~I"INT2FIX(RLIMIT_RTTIME);To;{;[[@P i";F;:RLIMIT_SBSIZE;;};;;[;{;IC;"'Maximum size of the socket buffer. ;T;[;[;I"(Maximum size of the socket buffer. ;T;0; @Ô:;!F;"o;#;$T;%i‹";&iŒ";'@*;I"Process::RLIMIT_SBSIZE;F;~I"INT2FIX(RLIMIT_SBSIZE);To;{;[[@P i•";F;:RLIMIT_SIGPENDING;;};;;[;{;IC;"›Specifies a limit on the number of signals that may be queued for the real user ID of the calling process. see the system getrlimit(2) manual for details. ;T;[;[;I"œSpecifies a limit on the number of signals that may be queued for the real user ID of the calling process. see the system getrlimit(2) manual for details. ;T;0; @à:;!F;"o;#;$T;%i";&i”";'@*;I"Process::RLIMIT_SIGPENDING;F;~I"INT2FIX(RLIMIT_SIGPENDING);To;{;[[@P iœ";F;:RLIMIT_STACK;;};;;[;{;IC;"ZMaximum size of the stack, in bytes. see the system getrlimit(2) manual for details. ;T;[;[;I"[Maximum size of the stack, in bytes. see the system getrlimit(2) manual for details. ;T;0; @ì:;!F;"o;#;$T;%i˜";&i›";'@*;I"Process::RLIMIT_STACK;F;~I"INT2FIX(RLIMIT_STACK);To;;F; ;;;Ï;I"Process#uid;F;[;[[@P i;T;:uid;0;[;{;IC;"JReturns the (real) user ID of this process. Process.uid #=> 501 ;T; @ø:;>0;!F;[o;= ;3I" overload;F;40;;þ;50;)I"uid;T;IC;";T; @ø:;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ø:;[;I"@return [Integer];T;0;6i;[; @ø:o;= ;3I" overload;F;40;:Process::UID.rid;50;)I"Process::UID.rid;T;IC;";T; @ø:;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ø:;[;I"@return [Integer];T;0;6i;[; @ø:o;= ;3I" overload;F;40;:Process::Sys.getuid;50;)I"Process::Sys.getuid;T;IC;";T; @ø:;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ø:;[;I"@return [Integer];T;0;6i;[; @ø:;[;I"ËReturns the (real) user ID of this process. Process.uid #=> 501 @overload uid @return [Integer] @overload Process::UID.rid @return [Integer] @overload Process::Sys.getuid @return [Integer];T;0;'@*;(I"cstatic VALUE proc_getuid(VALUE obj) { rb_uid_t uid = getuid(); return UIDT2NUM(uid); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.uid;F;@ú:;@û:;T;;þ;0;@ý:;{;IC;"JReturns the (real) user ID of this process. Process.uid #=> 501;T;[o;= ;3I" overload;F;40;;þ;50;)I"uid;T;IC;";T; @,;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @,;;[;I"@return [Integer];T;0;6i;[; @,;o;= ;3I" overload;F;40;;ÿ;50;)I"Process::UID.rid;T;IC;";T; @,;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @,;;[;I"@return [Integer];T;0;6i;[; @,;o;= ;3I" overload;F;40;;;50;)I"Process::Sys.getuid;T;IC;";T; @,;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @,;;[;I"@return [Integer];T;0;6i;[; @,;;[;I"ÊReturns the (real) user ID of this process. Process.uid #=> 501 @overload uid @return [Integer] @overload Process::UID.rid @return [Integer] @overload Process::Sys.getuid @return [Integer];T;0; @,;;!F;"o;#;$T;%i„;&iŽ;6i;'@*;(@*;;)@+;;*To;;F; ;;;Ï;I"Process#uid=;F;[[I"id;T0;[[@P i ;T;: uid=;0;[;{;IC;"NSets the (user) user ID for this process. Not available on all platforms. ;T; @[;;>0;!F;[o;= ;3I" overload;F;40;;;50;)I"uid=(user);T;IC;";T; @[;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @[;;[;I"@return [Numeric];T;0;6i;[[I" user;T0; @[;;[;I"xSets the (user) user ID for this process. Not available on all platforms. @overload uid=(user) @return [Numeric];T;0;'@*;(I"ùstatic VALUE proc_setuid(VALUE obj, VALUE id) { rb_uid_t uid; check_uid_switch(); uid = OBJ2UID(id); #if defined(HAVE_SETRESUID) if (setresuid(uid, -1, -1) < 0) rb_sys_fail(0); #elif defined HAVE_SETREUID if (setreuid(uid, -1) < 0) rb_sys_fail(0); #elif defined HAVE_SETRUID if (setruid(uid) < 0) rb_sys_fail(0); #elif defined HAVE_SETUID { if (geteuid() == uid) { if (setuid(uid) < 0) rb_sys_fail(0); } else { rb_notimplement(); } } #endif return id; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.uid=;F;@];;@`;;T;;;0;@b;;{;IC;"NSets the (user) user ID for this process. Not available on all platforms.;T;[o;= ;3I" overload;F;40;;;50;)I"uid=(user);T;IC;";T; @y;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @y;;[;I"@return [Numeric];T;0;6i;[[I" user;T0; @y;;[;I"ySets the (user) user ID for this process. Not available on all platforms. @overload uid=(user) @return [Numeric];T;0; @y;;!F;"o;#;$T;%i˜;&i;6i;'@*;(@w;;)@x;;*To;;F; ;;;Ï;I"Process#gid;F;[;[[@P i";T;:gid;0;[;{;IC;"LReturns the (real) group ID for this process. Process.gid #=> 500 ;T; @;;>0;!F;[o;= ;3I" overload;F;40;;;50;)I"gid;T;IC;";T; @;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @;;[;I"@return [Integer];T;0;6i;[; @;o;= ;3I" overload;F;40;:Process::GID.rid;50;)I"Process::GID.rid;T;IC;";T; @;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @;;[;I"@return [Integer];T;0;6i;[; @;o;= ;3I" overload;F;40;:Process::Sys.getgid;50;)I"Process::Sys.getgid;T;IC;";T; @;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @;;[;I"@return [Integer];T;0;6i;[; @;;[;I"ÍReturns the (real) group ID for this process. Process.gid #=> 500 @overload gid @return [Integer] @overload Process::GID.rid @return [Integer] @overload Process::Sys.getgid @return [Integer];T;0;'@*;(I"cstatic VALUE proc_getgid(VALUE obj) { rb_gid_t gid = getgid(); return GIDT2NUM(gid); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.gid;F;@’;;@“;;T;;;0;@•;;{;IC;"LReturns the (real) group ID for this process. Process.gid #=> 500;T;[o;= ;3I" overload;F;40;;;50;)I"gid;T;IC;";T; @Ä;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ä;;[;I"@return [Integer];T;0;6i;[; @Ä;o;= ;3I" overload;F;40;;;50;)I"Process::GID.rid;T;IC;";T; @Ä;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ä;;[;I"@return [Integer];T;0;6i;[; @Ä;o;= ;3I" overload;F;40;;;50;)I"Process::Sys.getgid;T;IC;";T; @Ä;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ä;;[;I"@return [Integer];T;0;6i;[; @Ä;;[;I"ÌReturns the (real) group ID for this process. Process.gid #=> 500 @overload gid @return [Integer] @overload Process::GID.rid @return [Integer] @overload Process::Sys.getgid @return [Integer];T;0; @Ä;;!F;"o;#;$T;%i;&i!;6i;'@*;(@Â;;)@Ã;;*To;;F; ;;;Ï;I"Process#gid=;F;[[I"id;T0;[[@P i2;T;: gid=;0;[;{;IC;"(Sets the group ID for this process. ;T; @ó;;>0;!F;[o;= ;3I" overload;F;40;;;50;)I"gid=(integer);T;IC;";T; @ó;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ó;;[;I"@return [Integer];T;0;6i;[[I"integer;T0; @ó;;[;I"USets the group ID for this process. @overload gid=(integer) @return [Integer];T;0;'@*;(I"static VALUE proc_setgid(VALUE obj, VALUE id) { rb_gid_t gid; check_gid_switch(); gid = OBJ2GID(id); #if defined(HAVE_SETRESGID) if (setresgid(gid, -1, -1) < 0) rb_sys_fail(0); #elif defined HAVE_SETREGID if (setregid(gid, -1) < 0) rb_sys_fail(0); #elif defined HAVE_SETRGID if (setrgid(gid) < 0) rb_sys_fail(0); #elif defined HAVE_SETGID { if (getegid() == gid) { if (setgid(gid) < 0) rb_sys_fail(0); } else { rb_notimplement(); } } #endif return GIDT2NUM(gid); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.gid=;F;@õ;;@ø;;T;;;0;@ú;;{;IC;"(Sets the group ID for this process.;T;[o;= ;3I" overload;F;40;;;50;)I"gid=(integer);T;IC;";T; @<;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @<;[;I"@return [Integer];T;0;6i;[[I"integer;T0; @<;[;I"VSets the group ID for this process. @overload gid=(integer) @return [Integer];T;0; @<;!F;"o;#;$T;%i+;&i/;6i;'@*;(@<;)@<;*To;;F; ;;;Ï;I"Process#euid;F;[;[[@P iX;T;: euid;0;[;{;IC;"OReturns the effective user ID for this process. Process.euid #=> 501 ;T; @(<;>0;!F;[o;= ;3I" overload;F;40;;;50;)I" euid;T;IC;";T; @(<;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @(<;[;I"@return [Integer];T;0;6i;[; @(0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @(<;[;I"@return [Integer];T;0;6i;[; @(0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @(<;[;I"@return [Integer];T;0;6i;[; @(<;[;I"ÒReturns the effective user ID for this process. Process.euid #=> 501 @overload euid @return [Integer] @overload Process::UID.eid @return [Integer] @overload Process::Sys.geteuid @return [Integer];T;0;'@*;(I"gstatic VALUE proc_geteuid(VALUE obj) { rb_uid_t euid = geteuid(); return UIDT2NUM(euid); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.euid;F;@*<;@+<;T;;;0;@-<;{;IC;"OReturns the effective user ID for this process. Process.euid #=> 501;T;[o;= ;3I" overload;F;40;;;50;)I" euid;T;IC;";T; @\<;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @\<;[;I"@return [Integer];T;0;6i;[; @\0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @\<;[;I"@return [Integer];T;0;6i;[; @\0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @\<;[;I"@return [Integer];T;0;6i;[; @\<;[;I"ÑReturns the effective user ID for this process. Process.euid #=> 501 @overload euid @return [Integer] @overload Process::UID.eid @return [Integer] @overload Process::Sys.geteuid @return [Integer];T;0; @\<;!F;"o;#;$T;%iM;&iW;6i;'@*;(@Z<;)@[<;*To;;F; ;;;Ï;I"Process#euid=;F;[[I" euid;T0;[[@P i;T;: euid=;0;[;{;IC;"QSets the effective user ID for this process. Not available on all platforms. ;T; @‹<;>0;!F;[o;= ;3I" overload;F;40;; ;50;)I"euid=(user);T;IC;";T; @‹<;>0;!F;[;[;I";T;0;6i;[[I" user;T0; @‹<;[;I"hSets the effective user ID for this process. Not available on all platforms. @overload euid=(user) ;T;0;'@*;(I"€static VALUE proc_seteuid_m(VALUE mod, VALUE euid) { check_uid_switch(); proc_seteuid(OBJ2UID(euid)); return euid; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.euid=;F;@<;@<;T;; ;0;@’<;{;IC;"QSets the effective user ID for this process. Not available on all platforms.;T;[o;= ;3I" overload;F;40;; ;50;)I"euid=(user);T;IC;";T; @¤<;>0;!F;[;[;I";T;0;6i;[[I" user;T0; @¤<;[;I"iSets the effective user ID for this process. Not available on all platforms. @overload euid=(user);T;0; @¤<;!F;"o;#;$T;%iw;&i{;6i;'@*;(@¢<;)@£<;*To;;F; ;;;Ï;I"Process#egid;F;[;[[@P iÔ;T;: egid;0;[;{;IC;"pReturns the effective group ID for this process. Not available on all platforms. Process.egid #=> 500 ;T; @¶<;>0;!F;[o;= ;3I" overload;F;40;; ;50;)I" egid;T;IC;";T; @¶<;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¶<;[;I"@return [Integer];T;0;6i;[; @¶0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¶<;[;I"@return [Integer];T;0;6i;[; @¶0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¶<;[;I"@return [Integer];T;0;6i;[; @¶<;[;I"òReturns the effective group ID for this process. Not available on all platforms. Process.egid #=> 500 @overload egid @return [Integer] @overload Process::GID.eid @return [Integer] @overload Process::Sys.geteid @return [Integer];T;0;'@*;(I"hstatic VALUE proc_getegid(VALUE obj) { rb_gid_t egid = getegid(); return GIDT2NUM(egid); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.egid;F;@¸<;@¹<;T;; ;0;@»<;{;IC;"pReturns the effective group ID for this process. Not available on all platforms. Process.egid #=> 500;T;[o;= ;3I" overload;F;40;; ;50;)I" egid;T;IC;";T; @ê<;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ê<;[;I"@return [Integer];T;0;6i;[; @ê0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ê<;[;I"@return [Integer];T;0;6i;[; @ê0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ê<;[;I"@return [Integer];T;0;6i;[; @ê<;[;I"ñReturns the effective group ID for this process. Not available on all platforms. Process.egid #=> 500 @overload egid @return [Integer] @overload Process::GID.eid @return [Integer] @overload Process::Sys.geteid @return [Integer];T;0; @ê<;!F;"o;#;$T;%iÈ;&iÓ;6i;'@*;(@è<;)@é<;*To;;F; ;;;Ï;I"Process#egid=;F;[;[;F;: egid=;;K;[;{;IC;" ;T; @=;>0;!F;[;[;I";F;0;'@*;*To;;T; ;F;;;I"Process.egid=;F;@=;@=;F;; ;;K;@=;{;IC;";T;[;[;@|;0; @#=;6i;'@*;*To;;F; ;;;Ï;I"Process#initgroups;F;[[I" uname;T0[I" base_grp;T0;[[@P iû;T;:initgroups;0;[;{;IC;"úInitializes the supplemental group access list by reading the system group database and using all groups of which the given user is a member. The group with the specified gid is also added to the list. Returns the resulting Array of the gids of all the groups in the supplementary group access list. Not available on all platforms. Process.groups #=> [0, 1, 2, 3, 4, 6, 10, 11, 20, 26, 27] Process.initgroups( "mgranger", 30 ) #=> [30, 6, 10, 11] Process.groups #=> [30, 6, 10, 11] ;T; @)=;>0;!F;[o;= ;3I" overload;F;40;;;50;)I"initgroups(username, gid);T;IC;";T; @)=;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @)=;[;I"@return [Array];T;0;6i;[[I" username;T0[I"gid;T0; @)=;[;I"1Initializes the supplemental group access list by reading the system group database and using all groups of which the given user is a member. The group with the specified gid is also added to the list. Returns the resulting Array of the gids of all the groups in the supplementary group access list. Not available on all platforms. Process.groups #=> [0, 1, 2, 3, 4, 6, 10, 11, 20, 26, 27] Process.initgroups( "mgranger", 30 ) #=> [30, 6, 10, 11] Process.groups #=> [30, 6, 10, 11] @overload initgroups(username, gid) @return [Array];T;0;'@*;(I"Åstatic VALUE proc_initgroups(VALUE obj, VALUE uname, VALUE base_grp) { if (initgroups(StringValueCStr(uname), OBJ2GID(base_grp)) != 0) { rb_sys_fail(0); } return proc_getgroups(obj); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.initgroups;F;@+=;@0=;T;;;0;@2=;{;IC;"úInitializes the supplemental group access list by reading the system group database and using all groups of which the given user is a member. The group with the specified gid is also added to the list. Returns the resulting Array of the gids of all the groups in the supplementary group access list. Not available on all platforms. Process.groups #=> [0, 1, 2, 3, 4, 6, 10, 11, 20, 26, 27] Process.initgroups( "mgranger", 30 ) #=> [30, 6, 10, 11] Process.groups #=> [30, 6, 10, 11];T;[o;= ;3I" overload;F;40;;;50;)I"initgroups(username, gid);T;IC;";T; @K=;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @K=;[;I"@return [Array];T;0;6i;[[I" username;T0[I"gid;T0; @K=;[;I"3Initializes the supplemental group access list by reading the system group database and using all groups of which the given user is a member. The group with the specified gid is also added to the list. Returns the resulting Array of the gids of all the groups in the supplementary group access list. Not available on all platforms. Process.groups #=> [0, 1, 2, 3, 4, 6, 10, 11, 20, 26, 27] Process.initgroups( "mgranger", 30 ) #=> [30, 6, 10, 11] Process.groups #=> [30, 6, 10, 11] @overload initgroups(username, gid) @return [Array];T;0; @K=;!F;"o;#;$T;%iê;&iø;6i;'@*;(@I=;)@J=;*To;;F; ;;;Ï;I"Process#groups;F;[;[[@P iš;T;:groups;0;[;{;IC;"üGet an Array of the group IDs in the supplemental group access list for this process. Process.groups #=> [27, 6, 10, 11] Note that this method is just a wrapper of getgroups(2). This means that the following characteristics of the result completely depend on your system: - the result is sorted - the result includes effective GIDs - the result does not include duplicated GIDs You can make sure to get a sorted unique GID list of the current process by this expression: Process.groups.uniq.sort ;T; @d=;>0;!F;[o;= ;3I" overload;F;40;;;50;)I"groups;T;IC;";T; @d=;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @d=;[;I"@return [Array];T;0;6i;[; @d=;[;I" Get an Array of the group IDs in the supplemental group access list for this process. Process.groups #=> [27, 6, 10, 11] Note that this method is just a wrapper of getgroups(2). This means that the following characteristics of the result completely depend on your system: - the result is sorted - the result includes effective GIDs - the result does not include duplicated GIDs You can make sure to get a sorted unique GID list of the current process by this expression: Process.groups.uniq.sort @overload groups @return [Array];T;0;'@*;(I"Àstatic VALUE proc_getgroups(VALUE obj) { VALUE ary, tmp; int i, ngroups; rb_gid_t *groups; ngroups = getgroups(0, NULL); if (ngroups == -1) rb_sys_fail(0); groups = ALLOCV_N(rb_gid_t, tmp, ngroups); ngroups = getgroups(ngroups, groups); if (ngroups == -1) rb_sys_fail(0); ary = rb_ary_new(); for (i = 0; i < ngroups; i++) rb_ary_push(ary, GIDT2NUM(groups[i])); ALLOCV_END(tmp); return ary; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.groups;F;@f=;@g=;T;;;0;@i=;{;IC;"üGet an Array of the group IDs in the supplemental group access list for this process. Process.groups #=> [27, 6, 10, 11] Note that this method is just a wrapper of getgroups(2). This means that the following characteristics of the result completely depend on your system: - the result is sorted - the result includes effective GIDs - the result does not include duplicated GIDs You can make sure to get a sorted unique GID list of the current process by this expression: Process.groups.uniq.sort;T;[o;= ;3I" overload;F;40;;;50;)I"groups;T;IC;";T; @~=;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @~=;[;I"@return [Array];T;0;6i;[; @~=;[;I""Get an Array of the group IDs in the supplemental group access list for this process. Process.groups #=> [27, 6, 10, 11] Note that this method is just a wrapper of getgroups(2). This means that the following characteristics of the result completely depend on your system: - the result is sorted - the result includes effective GIDs - the result does not include duplicated GIDs You can make sure to get a sorted unique GID list of the current process by this expression: Process.groups.uniq.sort @overload groups @return [Array];T;0; @~=;!F;"o;#;$T;%i‚;&i—;6i;'@*;(@|=;)@}=;*To;;F; ;;;Ï;I"Process#groups=;F;[[I"ary;T0;[[@P iÆ;T;:groups=;0;[;{;IC;"éSet the supplemental group access list to the given Array of group IDs. Process.groups #=> [0, 1, 2, 3, 4, 6, 10, 11, 20, 26, 27] Process.groups = [27, 6, 10, 11] #=> [27, 6, 10, 11] Process.groups #=> [27, 6, 10, 11] ;T; @“=;>0;!F;[o;= ;3I" overload;F;40;;;50;)I"groups=(array);T;IC;";T; @“=;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @“=;[;I"@return [Array];T;0;6i;[[I" array;T0; @“=;[;I"Set the supplemental group access list to the given Array of group IDs. Process.groups #=> [0, 1, 2, 3, 4, 6, 10, 11, 20, 26, 27] Process.groups = [27, 6, 10, 11] #=> [27, 6, 10, 11] Process.groups #=> [27, 6, 10, 11] @overload groups=(array) @return [Array];T;0;'@*;(I"_static VALUE proc_setgroups(VALUE obj, VALUE ary) { int ngroups, i; rb_gid_t *groups; VALUE tmp; PREPARE_GETGRNAM; Check_Type(ary, T_ARRAY); ngroups = RARRAY_LENINT(ary); if (ngroups > maxgroups()) rb_raise(rb_eArgError, "too many groups, %d max", maxgroups()); groups = ALLOCV_N(rb_gid_t, tmp, ngroups); for (i = 0; i < ngroups; i++) { VALUE g = RARRAY_AREF(ary, i); groups[i] = OBJ2GID1(g); } FINISH_GETGRNAM; if (setgroups(ngroups, groups) == -1) /* ngroups <= maxgroups */ rb_sys_fail(0); ALLOCV_END(tmp); return proc_getgroups(obj); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.groups=;F;@•=;@˜=;T;;;0;@š=;{;IC;"éSet the supplemental group access list to the given Array of group IDs. Process.groups #=> [0, 1, 2, 3, 4, 6, 10, 11, 20, 26, 27] Process.groups = [27, 6, 10, 11] #=> [27, 6, 10, 11] Process.groups #=> [27, 6, 10, 11];T;[o;= ;3I" overload;F;40;;;50;)I"groups=(array);T;IC;";T; @±=;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @±=;[;I"@return [Array];T;0;6i;[[I" array;T0; @±=;[;I"Set the supplemental group access list to the given Array of group IDs. Process.groups #=> [0, 1, 2, 3, 4, 6, 10, 11, 20, 26, 27] Process.groups = [27, 6, 10, 11] #=> [27, 6, 10, 11] Process.groups #=> [27, 6, 10, 11] @overload groups=(array) @return [Array];T;0; @±=;!F;"o;#;$T;%i¹;&iÃ;6i;'@*;(@¯=;)@°=;*To;;F; ;;;Ï;I"Process#maxgroups;F;[;[[@P i;T;:maxgroups;0;[;{;IC;"uReturns the maximum number of gids allowed in the supplemental group access list. Process.maxgroups #=> 32 ;T; @È=;>0;!F;[o;= ;3I" overload;F;40;;;50;)I"maxgroups;T;IC;";T; @È=;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @È=;[;I"@return [Integer];T;0;6i;[; @È=;[;I"™Returns the maximum number of gids allowed in the supplemental group access list. Process.maxgroups #=> 32 @overload maxgroups @return [Integer];T;0;'@*;(I"Sstatic VALUE proc_getmaxgroups(VALUE obj) { return INT2FIX(maxgroups()); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.maxgroups;F;@Ê=;@Ë=;T;;;0;@Í=;{;IC;"uReturns the maximum number of gids allowed in the supplemental group access list. Process.maxgroups #=> 32;T;[o;= ;3I" overload;F;40;;;50;)I"maxgroups;T;IC;";T; @â=;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @â=;[;I"@return [Integer];T;0;6i;[; @â=;[;I"šReturns the maximum number of gids allowed in the supplemental group access list. Process.maxgroups #=> 32 @overload maxgroups @return [Integer];T;0; @â=;!F;"o;#;$T;%i;&i;6i;'@*;(@à=;)@á=;*To;;F; ;;;Ï;I"Process#maxgroups=;F;[[I"val;T0;[[@P i$;T;:maxgroups=;0;[;{;IC;"SSets the maximum number of gids allowed in the supplemental group access list. ;T; @÷=;>0;!F;[o;= ;3I" overload;F;40;;;50;)I"maxgroups=(integer);T;IC;";T; @÷=;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @÷=;[;I"@return [Integer];T;0;6i;[[I"integer;T0; @÷=;[;I"Sets the maximum number of gids allowed in the supplemental group access list. @overload maxgroups=(integer) @return [Integer];T;0;'@*;(I"£static VALUE proc_setmaxgroups(VALUE obj, VALUE val) { int ngroups = FIX2INT(val); int ngroups_max = get_sc_ngroups_max(); if (ngroups <= 0) rb_raise(rb_eArgError, "maxgroups %d should be positive", ngroups); if (ngroups > RB_MAX_GROUPS) ngroups = RB_MAX_GROUPS; if (ngroups_max > 0 && ngroups > ngroups_max) ngroups = ngroups_max; _maxgroups = ngroups; return INT2FIX(_maxgroups); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.maxgroups=;F;@ù=;@ü=;T;;;0;@þ=;{;IC;"SSets the maximum number of gids allowed in the supplemental group access list.;T;[o;= ;3I" overload;F;40;;;50;)I"maxgroups=(integer);T;IC;";T; @>;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @>;[;I"@return [Integer];T;0;6i;[[I"integer;T0; @>;[;I"‚Sets the maximum number of gids allowed in the supplemental group access list. @overload maxgroups=(integer) @return [Integer];T;0; @>;!F;"o;#;$T;%i;&i!;6i;'@*;(@>;)@>;*To;;F; ;;;Ï;I"Process#daemon;F;[[@c0;[[@P iL;T;:daemon;0;[;{;IC;"zDetach the process from controlling terminal and run in the background as system daemon. Unless the argument nochdir is true (i.e. non false), it changes the current working directory to the root ("/"). Unless the argument noclose is true, daemon() will redirect standard input, standard output and standard error to /dev/null. Return zero on success, or raise one of Errno::*. ;T; @,>;>0;!F;[o;= ;3I" overload;F;40;;;50;)I" daemon();T;IC;";T; @,>;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @,>;[;I"@return [0];T;0;6i;[; @,>o;= ;3I" overload;F;40;;;50;)I"$daemon(nochdir=nil,noclose=nil);T;IC;";T; @,>;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @,>;[;I"@return [0];T;0;6i;[[I"nochdir;TI"nil;T[I"noclose;TI"nil;T; @,>;[;I"ÕDetach the process from controlling terminal and run in the background as system daemon. Unless the argument nochdir is true (i.e. non false), it changes the current working directory to the root ("/"). Unless the argument noclose is true, daemon() will redirect standard input, standard output and standard error to /dev/null. Return zero on success, or raise one of Errno::*. @overload daemon() @return [0] @overload daemon(nochdir=nil,noclose=nil) @return [0];T;0;'@*;(I"vstatic VALUE proc_daemon(int argc, VALUE *argv, VALUE _) { int n, nochdir = FALSE, noclose = FALSE; switch (rb_check_arity(argc, 0, 2)) { case 2: noclose = TO_BOOL(argv[1], "noclose"); case 1: nochdir = TO_BOOL(argv[0], "nochdir"); } prefork(); n = rb_daemon(nochdir, noclose); if (n < 0) rb_sys_fail("daemon"); return INT2FIX(n); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.daemon;F;@.>;@0>;T;;;0;@2>;{;IC;"zDetach the process from controlling terminal and run in the background as system daemon. Unless the argument nochdir is true (i.e. non false), it changes the current working directory to the root ("/"). Unless the argument noclose is true, daemon() will redirect standard input, standard output and standard error to /dev/null. Return zero on success, or raise one of Errno::*.;T;[o;= ;3I" overload;F;40;;;50;)I" daemon();T;IC;";T; @Z>;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @Z>;[;I"@return [0];T;0;6i;[; @Z>o;= ;3I" overload;F;40;;;50;)I"$daemon(nochdir=nil,noclose=nil);T;IC;";T; @Z>;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @Z>;[;I"@return [0];T;0;6i;[[I"nochdir;TI"nil;T[I"noclose;TI"nil;T; @Z>;[;I"ÕDetach the process from controlling terminal and run in the background as system daemon. Unless the argument nochdir is true (i.e. non false), it changes the current working directory to the root ("/"). Unless the argument noclose is true, daemon() will redirect standard input, standard output and standard error to /dev/null. Return zero on success, or raise one of Errno::*. @overload daemon() @return [0] @overload daemon(nochdir=nil,noclose=nil) @return [0];T;0; @Z>;!F;"o;#;$T;%i>;&iJ;6i;'@*;(@X>;)@Y>;*To;;F; ;;;Ï;I"Process#times;F;[;[[@P iÅ;T;: times;0;[;{;IC;"òReturns a Tms structure (see Process::Tms) that contains user and system CPU times for this process, and also for children processes. t = Process.times [ t.utime, t.stime, t.cutime, t.cstime ] #=> [0.0, 0.02, 0.00, 0.00] ;T; @‚>;>0;!F;[o;= ;3I" overload;F;40;;;50;)I" times;T;IC;";T; @‚>;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aProcessTms;T; @‚>;[;I"@return [aProcessTms];T;0;6i;[; @‚>;[;I"Returns a Tms structure (see Process::Tms) that contains user and system CPU times for this process, and also for children processes. t = Process.times [ t.utime, t.stime, t.cutime, t.cstime ] #=> [0.0, 0.02, 0.00, 0.00] @overload times @return [aProcessTms];T;0;'@*;(I"fVALUE rb_proc_times(VALUE obj) { VALUE utime, stime, cutime, cstime, ret; #if defined(RUSAGE_SELF) && defined(RUSAGE_CHILDREN) struct rusage usage_s, usage_c; if (getrusage(RUSAGE_SELF, &usage_s) != 0 || getrusage(RUSAGE_CHILDREN, &usage_c) != 0) rb_sys_fail("getrusage"); utime = DBL2NUM((double)usage_s.ru_utime.tv_sec + (double)usage_s.ru_utime.tv_usec/1e6); stime = DBL2NUM((double)usage_s.ru_stime.tv_sec + (double)usage_s.ru_stime.tv_usec/1e6); cutime = DBL2NUM((double)usage_c.ru_utime.tv_sec + (double)usage_c.ru_utime.tv_usec/1e6); cstime = DBL2NUM((double)usage_c.ru_stime.tv_sec + (double)usage_c.ru_stime.tv_usec/1e6); #else const double hertz = (double)get_clk_tck(); struct tms buf; times(&buf); utime = DBL2NUM(buf.tms_utime / hertz); stime = DBL2NUM(buf.tms_stime / hertz); cutime = DBL2NUM(buf.tms_cutime / hertz); cstime = DBL2NUM(buf.tms_cstime / hertz); #endif ret = rb_struct_new(rb_cProcessTms, utime, stime, cutime, cstime); RB_GC_GUARD(utime); RB_GC_GUARD(stime); RB_GC_GUARD(cutime); RB_GC_GUARD(cstime); return ret; };T;)I" VALUE;T;*To;;T; ;F;;;I"Process.times;F;@„>;@…>;T;;;0;@‡>;{;IC;"òReturns a Tms structure (see Process::Tms) that contains user and system CPU times for this process, and also for children processes. t = Process.times [ t.utime, t.stime, t.cutime, t.cstime ] #=> [0.0, 0.02, 0.00, 0.00];T;[o;= ;3I" overload;F;40;;;50;)I" times;T;IC;";T; @œ>;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aProcessTms;T; @œ>;[;I"@return [aProcessTms];T;0;6i;[; @œ>;[;I"Returns a Tms structure (see Process::Tms) that contains user and system CPU times for this process, and also for children processes. t = Process.times [ t.utime, t.stime, t.cutime, t.cstime ] #=> [0.0, 0.02, 0.00, 0.00] @overload times @return [aProcessTms];T;0; @œ>;!F;"o;#;$T;%i¹;&iÂ;6i;'@*;(@š>;)@›>;*To;{;[[@P i´"[@P i·";F;:CLOCK_REALTIME;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @±>;!F;"o;#;$T;%i¶";&i¶";'@*;I"Process::CLOCK_REALTIME;F;~I"+RUBY_GETTIMEOFDAY_BASED_CLOCK_REALTIME;To;{;[[@P i»"[@P i¾";F;:CLOCK_MONOTONIC;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @¾>;!F;"o;#;$T;%i½";&i½";'@*;I"Process::CLOCK_MONOTONIC;F;~I"2RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC;To;{;[[@P iÂ"[@P iÅ";F;:CLOCK_PROCESS_CPUTIME_ID;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @Ë>;!F;"o;#;$T;%iÄ";&iÄ";'@*;I"&Process::CLOCK_PROCESS_CPUTIME_ID;F;~I"2RUBY_GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID;To;{;[[@P iÉ";F;:CLOCK_THREAD_CPUTIME_ID;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @Ø>;!F;"o;#;$T;%iÈ";&iÈ";'@*;I"%Process::CLOCK_THREAD_CPUTIME_ID;F;~I")CLOCKID2NUM(CLOCK_THREAD_CPUTIME_ID);To;{;[[@P iÍ";F;:CLOCK_VIRTUAL;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @ä>;!F;"o;#;$T;%iÌ";&iÌ";'@*;I"Process::CLOCK_VIRTUAL;F;~I"CLOCKID2NUM(CLOCK_VIRTUAL);To;{;[[@P iÑ";F;:CLOCK_PROF;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @ð>;!F;"o;#;$T;%iÐ";&iÐ";'@*;I"Process::CLOCK_PROF;F;~I"CLOCKID2NUM(CLOCK_PROF);To;{;[[@P iÕ";F;:CLOCK_REALTIME_FAST;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @ü>;!F;"o;#;$T;%iÔ";&iÔ";'@*;I"!Process::CLOCK_REALTIME_FAST;F;~I"%CLOCKID2NUM(CLOCK_REALTIME_FAST);To;{;[[@P iÙ";F;:CLOCK_REALTIME_PRECISE;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @?;!F;"o;#;$T;%iØ";&iØ";'@*;I"$Process::CLOCK_REALTIME_PRECISE;F;~I"(CLOCKID2NUM(CLOCK_REALTIME_PRECISE);To;{;[[@P iÝ";F;:CLOCK_REALTIME_COARSE;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @?;!F;"o;#;$T;%iÜ";&iÜ";'@*;I"#Process::CLOCK_REALTIME_COARSE;F;~I"'CLOCKID2NUM(CLOCK_REALTIME_COARSE);To;{;[[@P iá";F;:CLOCK_REALTIME_ALARM;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @ ?;!F;"o;#;$T;%ià";&ià";'@*;I""Process::CLOCK_REALTIME_ALARM;F;~I"&CLOCKID2NUM(CLOCK_REALTIME_ALARM);To;{;[[@P iå";F;:CLOCK_MONOTONIC_FAST;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @,?;!F;"o;#;$T;%iä";&iä";'@*;I""Process::CLOCK_MONOTONIC_FAST;F;~I"&CLOCKID2NUM(CLOCK_MONOTONIC_FAST);To;{;[[@P ié";F;:CLOCK_MONOTONIC_PRECISE;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @8?;!F;"o;#;$T;%iè";&iè";'@*;I"%Process::CLOCK_MONOTONIC_PRECISE;F;~I")CLOCKID2NUM(CLOCK_MONOTONIC_PRECISE);To;{;[[@P ií";F;:CLOCK_MONOTONIC_RAW;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @D?;!F;"o;#;$T;%iì";&iì";'@*;I"!Process::CLOCK_MONOTONIC_RAW;F;~I"%CLOCKID2NUM(CLOCK_MONOTONIC_RAW);To;{;[[@P iñ";F;:CLOCK_MONOTONIC_RAW_APPROX;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @P?;!F;"o;#;$T;%ið";&ið";'@*;I"(Process::CLOCK_MONOTONIC_RAW_APPROX;F;~I",CLOCKID2NUM(CLOCK_MONOTONIC_RAW_APPROX);To;{;[[@P iõ";F;:CLOCK_MONOTONIC_COARSE;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @\?;!F;"o;#;$T;%iô";&iô";'@*;I"$Process::CLOCK_MONOTONIC_COARSE;F;~I"(CLOCKID2NUM(CLOCK_MONOTONIC_COARSE);To;{;[[@P iù";F;:CLOCK_BOOTTIME;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @h?;!F;"o;#;$T;%iø";&iø";'@*;I"Process::CLOCK_BOOTTIME;F;~I" CLOCKID2NUM(CLOCK_BOOTTIME);To;{;[[@P iý";F;:CLOCK_BOOTTIME_ALARM;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @t?;!F;"o;#;$T;%iü";&iü";'@*;I""Process::CLOCK_BOOTTIME_ALARM;F;~I"&CLOCKID2NUM(CLOCK_BOOTTIME_ALARM);To;{;[[@P i#;F;:CLOCK_UPTIME;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @€?;!F;"o;#;$T;%i#;&i#;'@*;I"Process::CLOCK_UPTIME;F;~I"CLOCKID2NUM(CLOCK_UPTIME);To;{;[[@P i#;F;:CLOCK_UPTIME_FAST;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @Œ?;!F;"o;#;$T;%i#;&i#;'@*;I"Process::CLOCK_UPTIME_FAST;F;~I"#CLOCKID2NUM(CLOCK_UPTIME_FAST);To;{;[[@P i #;F;:CLOCK_UPTIME_PRECISE;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @˜?;!F;"o;#;$T;%i#;&i#;'@*;I""Process::CLOCK_UPTIME_PRECISE;F;~I"&CLOCKID2NUM(CLOCK_UPTIME_PRECISE);To;{;[[@P i #;F;:CLOCK_UPTIME_RAW;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @¤?;!F;"o;#;$T;%i#;&i#;'@*;I"Process::CLOCK_UPTIME_RAW;F;~I""CLOCKID2NUM(CLOCK_UPTIME_RAW);To;{;[[@P i#;F;:CLOCK_UPTIME_RAW_APPROX;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @°?;!F;"o;#;$T;%i#;&i#;'@*;I"%Process::CLOCK_UPTIME_RAW_APPROX;F;~I")CLOCKID2NUM(CLOCK_UPTIME_RAW_APPROX);To;{;[[@P i#;F;:CLOCK_SECOND;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @¼?;!F;"o;#;$T;%i#;&i#;'@*;I"Process::CLOCK_SECOND;F;~I"CLOCKID2NUM(CLOCK_SECOND);To;{;[[@P i#;F;:CLOCK_TAI;;};;;[;{;IC;"see Process.clock_gettime ;T;[;[;I"see Process.clock_gettime;T;0; @È?;!F;"o;#;$T;%i#;&i#;'@*;I"Process::CLOCK_TAI;F;~I"CLOCKID2NUM(CLOCK_TAI);To;;F; ;;;Ï;I"Process#clock_gettime;F;[[@c0;[[@P i9 ;T;:clock_gettime;0;[;{;IC;"pReturns a time returned by POSIX clock_gettime() function. p Process.clock_gettime(Process::CLOCK_MONOTONIC) #=> 896053.968060096 +clock_id+ specifies a kind of clock. It is specified as a constant which begins with Process::CLOCK_ such as Process::CLOCK_REALTIME and Process::CLOCK_MONOTONIC. The supported constants depends on OS and version. Ruby provides following types of +clock_id+ if available. [CLOCK_REALTIME] SUSv2 to 4, Linux 2.5.63, FreeBSD 3.0, NetBSD 2.0, OpenBSD 2.1, macOS 10.12 [CLOCK_MONOTONIC] SUSv3 to 4, Linux 2.5.63, FreeBSD 3.0, NetBSD 2.0, OpenBSD 3.4, macOS 10.12 [CLOCK_PROCESS_CPUTIME_ID] SUSv3 to 4, Linux 2.5.63, FreeBSD 9.3, OpenBSD 5.4, macOS 10.12 [CLOCK_THREAD_CPUTIME_ID] SUSv3 to 4, Linux 2.5.63, FreeBSD 7.1, OpenBSD 5.4, macOS 10.12 [CLOCK_VIRTUAL] FreeBSD 3.0, OpenBSD 2.1 [CLOCK_PROF] FreeBSD 3.0, OpenBSD 2.1 [CLOCK_REALTIME_FAST] FreeBSD 8.1 [CLOCK_REALTIME_PRECISE] FreeBSD 8.1 [CLOCK_REALTIME_COARSE] Linux 2.6.32 [CLOCK_REALTIME_ALARM] Linux 3.0 [CLOCK_MONOTONIC_FAST] FreeBSD 8.1 [CLOCK_MONOTONIC_PRECISE] FreeBSD 8.1 [CLOCK_MONOTONIC_COARSE] Linux 2.6.32 [CLOCK_MONOTONIC_RAW] Linux 2.6.28, macOS 10.12 [CLOCK_MONOTONIC_RAW_APPROX] macOS 10.12 [CLOCK_BOOTTIME] Linux 2.6.39 [CLOCK_BOOTTIME_ALARM] Linux 3.0 [CLOCK_UPTIME] FreeBSD 7.0, OpenBSD 5.5 [CLOCK_UPTIME_FAST] FreeBSD 8.1 [CLOCK_UPTIME_RAW] macOS 10.12 [CLOCK_UPTIME_RAW_APPROX] macOS 10.12 [CLOCK_UPTIME_PRECISE] FreeBSD 8.1 [CLOCK_SECOND] FreeBSD 8.1 [CLOCK_TAI] Linux 3.10 Note that SUS stands for Single Unix Specification. SUS contains POSIX and clock_gettime is defined in the POSIX part. SUS defines CLOCK_REALTIME mandatory but CLOCK_MONOTONIC, CLOCK_PROCESS_CPUTIME_ID and CLOCK_THREAD_CPUTIME_ID are optional. Also, several symbols are accepted as +clock_id+. There are emulations for clock_gettime(). For example, Process::CLOCK_REALTIME is defined as +:GETTIMEOFDAY_BASED_CLOCK_REALTIME+ when clock_gettime() is not available. Emulations for +CLOCK_REALTIME+: [:GETTIMEOFDAY_BASED_CLOCK_REALTIME] Use gettimeofday() defined by SUS. (SUSv4 obsoleted it, though.) The resolution is 1 microsecond. [:TIME_BASED_CLOCK_REALTIME] Use time() defined by ISO C. The resolution is 1 second. Emulations for +CLOCK_MONOTONIC+: [:MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC] Use mach_absolute_time(), available on Darwin. The resolution is CPU dependent. [:TIMES_BASED_CLOCK_MONOTONIC] Use the result value of times() defined by POSIX. POSIX defines it as "times() shall return the elapsed real time, in clock ticks, since an arbitrary point in the past (for example, system start-up time)". For example, GNU/Linux returns a value based on jiffies and it is monotonic. However, 4.4BSD uses gettimeofday() and it is not monotonic. (FreeBSD uses clock_gettime(CLOCK_MONOTONIC) instead, though.) The resolution is the clock tick. "getconf CLK_TCK" command shows the clock ticks per second. (The clock ticks per second is defined by HZ macro in older systems.) If it is 100 and clock_t is 32 bits integer type, the resolution is 10 millisecond and cannot represent over 497 days. Emulations for +CLOCK_PROCESS_CPUTIME_ID+: [:GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID] Use getrusage() defined by SUS. getrusage() is used with RUSAGE_SELF to obtain the time only for the calling process (excluding the time for child processes). The result is addition of user time (ru_utime) and system time (ru_stime). The resolution is 1 microsecond. [:TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID] Use times() defined by POSIX. The result is addition of user time (tms_utime) and system time (tms_stime). tms_cutime and tms_cstime are ignored to exclude the time for child processes. The resolution is the clock tick. "getconf CLK_TCK" command shows the clock ticks per second. (The clock ticks per second is defined by HZ macro in older systems.) If it is 100, the resolution is 10 millisecond. [:CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID] Use clock() defined by ISO C. The resolution is 1/CLOCKS_PER_SEC. CLOCKS_PER_SEC is the C-level macro defined by time.h. SUS defines CLOCKS_PER_SEC is 1000000. Non-Unix systems may define it a different value, though. If CLOCKS_PER_SEC is 1000000 as SUS, the resolution is 1 microsecond. If CLOCKS_PER_SEC is 1000000 and clock_t is 32 bits integer type, it cannot represent over 72 minutes. If the given +clock_id+ is not supported, Errno::EINVAL is raised. +unit+ specifies a type of the return value. [:float_second] number of seconds as a float (default) [:float_millisecond] number of milliseconds as a float [:float_microsecond] number of microseconds as a float [:second] number of seconds as an integer [:millisecond] number of milliseconds as an integer [:microsecond] number of microseconds as an integer [:nanosecond] number of nanoseconds as an integer The underlying function, clock_gettime(), returns a number of nanoseconds. Float object (IEEE 754 double) is not enough to represent the return value for CLOCK_REALTIME. If the exact nanoseconds value is required, use +:nanoseconds+ as the +unit+. The origin (zero) of the returned value varies. For example, system start up time, process start up time, the Epoch, etc. The origin in CLOCK_REALTIME is defined as the Epoch (1970-01-01 00:00:00 UTC). But some systems count leap seconds and others doesn't. So the result can be interpreted differently across systems. Time.now is recommended over CLOCK_REALTIME. ;T; @Ô?;>0;!F;[o;= ;3I" overload;F;40;;-;50;)I"%clock_gettime(clock_id [, unit]);T;IC;";T; @Ô?;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @Ô?;[;I"@return [Numeric];T;0;6i;[[I"clock_id[, unit];T0; @Ô?;[;I"°Returns a time returned by POSIX clock_gettime() function. p Process.clock_gettime(Process::CLOCK_MONOTONIC) #=> 896053.968060096 +clock_id+ specifies a kind of clock. It is specified as a constant which begins with Process::CLOCK_ such as Process::CLOCK_REALTIME and Process::CLOCK_MONOTONIC. The supported constants depends on OS and version. Ruby provides following types of +clock_id+ if available. [CLOCK_REALTIME] SUSv2 to 4, Linux 2.5.63, FreeBSD 3.0, NetBSD 2.0, OpenBSD 2.1, macOS 10.12 [CLOCK_MONOTONIC] SUSv3 to 4, Linux 2.5.63, FreeBSD 3.0, NetBSD 2.0, OpenBSD 3.4, macOS 10.12 [CLOCK_PROCESS_CPUTIME_ID] SUSv3 to 4, Linux 2.5.63, FreeBSD 9.3, OpenBSD 5.4, macOS 10.12 [CLOCK_THREAD_CPUTIME_ID] SUSv3 to 4, Linux 2.5.63, FreeBSD 7.1, OpenBSD 5.4, macOS 10.12 [CLOCK_VIRTUAL] FreeBSD 3.0, OpenBSD 2.1 [CLOCK_PROF] FreeBSD 3.0, OpenBSD 2.1 [CLOCK_REALTIME_FAST] FreeBSD 8.1 [CLOCK_REALTIME_PRECISE] FreeBSD 8.1 [CLOCK_REALTIME_COARSE] Linux 2.6.32 [CLOCK_REALTIME_ALARM] Linux 3.0 [CLOCK_MONOTONIC_FAST] FreeBSD 8.1 [CLOCK_MONOTONIC_PRECISE] FreeBSD 8.1 [CLOCK_MONOTONIC_COARSE] Linux 2.6.32 [CLOCK_MONOTONIC_RAW] Linux 2.6.28, macOS 10.12 [CLOCK_MONOTONIC_RAW_APPROX] macOS 10.12 [CLOCK_BOOTTIME] Linux 2.6.39 [CLOCK_BOOTTIME_ALARM] Linux 3.0 [CLOCK_UPTIME] FreeBSD 7.0, OpenBSD 5.5 [CLOCK_UPTIME_FAST] FreeBSD 8.1 [CLOCK_UPTIME_RAW] macOS 10.12 [CLOCK_UPTIME_RAW_APPROX] macOS 10.12 [CLOCK_UPTIME_PRECISE] FreeBSD 8.1 [CLOCK_SECOND] FreeBSD 8.1 [CLOCK_TAI] Linux 3.10 Note that SUS stands for Single Unix Specification. SUS contains POSIX and clock_gettime is defined in the POSIX part. SUS defines CLOCK_REALTIME mandatory but CLOCK_MONOTONIC, CLOCK_PROCESS_CPUTIME_ID and CLOCK_THREAD_CPUTIME_ID are optional. Also, several symbols are accepted as +clock_id+. There are emulations for clock_gettime(). For example, Process::CLOCK_REALTIME is defined as +:GETTIMEOFDAY_BASED_CLOCK_REALTIME+ when clock_gettime() is not available. Emulations for +CLOCK_REALTIME+: [:GETTIMEOFDAY_BASED_CLOCK_REALTIME] Use gettimeofday() defined by SUS. (SUSv4 obsoleted it, though.) The resolution is 1 microsecond. [:TIME_BASED_CLOCK_REALTIME] Use time() defined by ISO C. The resolution is 1 second. Emulations for +CLOCK_MONOTONIC+: [:MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC] Use mach_absolute_time(), available on Darwin. The resolution is CPU dependent. [:TIMES_BASED_CLOCK_MONOTONIC] Use the result value of times() defined by POSIX. POSIX defines it as "times() shall return the elapsed real time, in clock ticks, since an arbitrary point in the past (for example, system start-up time)". For example, GNU/Linux returns a value based on jiffies and it is monotonic. However, 4.4BSD uses gettimeofday() and it is not monotonic. (FreeBSD uses clock_gettime(CLOCK_MONOTONIC) instead, though.) The resolution is the clock tick. "getconf CLK_TCK" command shows the clock ticks per second. (The clock ticks per second is defined by HZ macro in older systems.) If it is 100 and clock_t is 32 bits integer type, the resolution is 10 millisecond and cannot represent over 497 days. Emulations for +CLOCK_PROCESS_CPUTIME_ID+: [:GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID] Use getrusage() defined by SUS. getrusage() is used with RUSAGE_SELF to obtain the time only for the calling process (excluding the time for child processes). The result is addition of user time (ru_utime) and system time (ru_stime). The resolution is 1 microsecond. [:TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID] Use times() defined by POSIX. The result is addition of user time (tms_utime) and system time (tms_stime). tms_cutime and tms_cstime are ignored to exclude the time for child processes. The resolution is the clock tick. "getconf CLK_TCK" command shows the clock ticks per second. (The clock ticks per second is defined by HZ macro in older systems.) If it is 100, the resolution is 10 millisecond. [:CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID] Use clock() defined by ISO C. The resolution is 1/CLOCKS_PER_SEC. CLOCKS_PER_SEC is the C-level macro defined by time.h. SUS defines CLOCKS_PER_SEC is 1000000. Non-Unix systems may define it a different value, though. If CLOCKS_PER_SEC is 1000000 as SUS, the resolution is 1 microsecond. If CLOCKS_PER_SEC is 1000000 and clock_t is 32 bits integer type, it cannot represent over 72 minutes. If the given +clock_id+ is not supported, Errno::EINVAL is raised. +unit+ specifies a type of the return value. [:float_second] number of seconds as a float (default) [:float_millisecond] number of milliseconds as a float [:float_microsecond] number of microseconds as a float [:second] number of seconds as an integer [:millisecond] number of milliseconds as an integer [:microsecond] number of microseconds as an integer [:nanosecond] number of nanoseconds as an integer The underlying function, clock_gettime(), returns a number of nanoseconds. Float object (IEEE 754 double) is not enough to represent the return value for CLOCK_REALTIME. If the exact nanoseconds value is required, use +:nanoseconds+ as the +unit+. The origin (zero) of the returned value varies. For example, system start up time, process start up time, the Epoch, etc. The origin in CLOCK_REALTIME is defined as the Epoch (1970-01-01 00:00:00 UTC). But some systems count leap seconds and others doesn't. So the result can be interpreted differently across systems. Time.now is recommended over CLOCK_REALTIME. @overload clock_gettime(clock_id [, unit]) @return [Numeric];T;0;'@*;(I"¹static VALUE rb_clock_gettime(int argc, VALUE *argv, VALUE _) { int ret; struct timetick tt; timetick_int_t numerators[2]; timetick_int_t denominators[2]; int num_numerators = 0; int num_denominators = 0; VALUE unit = (rb_check_arity(argc, 1, 2) == 2) ? argv[1] : Qnil; VALUE clk_id = argv[0]; if (SYMBOL_P(clk_id)) { /* * Non-clock_gettime clocks are provided by symbol clk_id. */ #ifdef HAVE_GETTIMEOFDAY /* * GETTIMEOFDAY_BASED_CLOCK_REALTIME is used for * CLOCK_REALTIME if clock_gettime is not available. */ #define RUBY_GETTIMEOFDAY_BASED_CLOCK_REALTIME ID2SYM(id_GETTIMEOFDAY_BASED_CLOCK_REALTIME) if (clk_id == RUBY_GETTIMEOFDAY_BASED_CLOCK_REALTIME) { struct timeval tv; ret = gettimeofday(&tv, 0); if (ret != 0) rb_sys_fail("gettimeofday"); tt.giga_count = tv.tv_sec; tt.count = (int32_t)tv.tv_usec * 1000; denominators[num_denominators++] = 1000000000; goto success; } #endif #define RUBY_TIME_BASED_CLOCK_REALTIME ID2SYM(id_TIME_BASED_CLOCK_REALTIME) if (clk_id == RUBY_TIME_BASED_CLOCK_REALTIME) { time_t t; t = time(NULL); if (t == (time_t)-1) rb_sys_fail("time"); tt.giga_count = t; tt.count = 0; denominators[num_denominators++] = 1000000000; goto success; } #ifdef HAVE_TIMES #define RUBY_TIMES_BASED_CLOCK_MONOTONIC \ ID2SYM(id_TIMES_BASED_CLOCK_MONOTONIC) if (clk_id == RUBY_TIMES_BASED_CLOCK_MONOTONIC) { struct tms buf; clock_t c; unsigned_clock_t uc; c = times(&buf); if (c == (clock_t)-1) rb_sys_fail("times"); uc = (unsigned_clock_t)c; tt.count = (int32_t)(uc % 1000000000); tt.giga_count = (uc / 1000000000); denominators[num_denominators++] = get_clk_tck(); goto success; } #endif #ifdef RUSAGE_SELF #define RUBY_GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID \ ID2SYM(id_GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID) if (clk_id == RUBY_GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID) { struct rusage usage; int32_t usec; ret = getrusage(RUSAGE_SELF, &usage); if (ret != 0) rb_sys_fail("getrusage"); tt.giga_count = usage.ru_utime.tv_sec + usage.ru_stime.tv_sec; usec = (int32_t)(usage.ru_utime.tv_usec + usage.ru_stime.tv_usec); if (1000000 <= usec) { tt.giga_count++; usec -= 1000000; } tt.count = usec * 1000; denominators[num_denominators++] = 1000000000; goto success; } #endif #ifdef HAVE_TIMES #define RUBY_TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID \ ID2SYM(id_TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID) if (clk_id == RUBY_TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID) { struct tms buf; unsigned_clock_t utime, stime; if (times(&buf) == (clock_t)-1) rb_sys_fail("times"); utime = (unsigned_clock_t)buf.tms_utime; stime = (unsigned_clock_t)buf.tms_stime; tt.count = (int32_t)((utime % 1000000000) + (stime % 1000000000)); tt.giga_count = (utime / 1000000000) + (stime / 1000000000); if (1000000000 <= tt.count) { tt.count -= 1000000000; tt.giga_count++; } denominators[num_denominators++] = get_clk_tck(); goto success; } #endif #define RUBY_CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID \ ID2SYM(id_CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID) if (clk_id == RUBY_CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID) { clock_t c; unsigned_clock_t uc; errno = 0; c = clock(); if (c == (clock_t)-1) rb_sys_fail("clock"); uc = (unsigned_clock_t)c; tt.count = (int32_t)(uc % 1000000000); tt.giga_count = uc / 1000000000; denominators[num_denominators++] = CLOCKS_PER_SEC; goto success; } #ifdef __APPLE__ #define RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC ID2SYM(id_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC) if (clk_id == RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC) { const mach_timebase_info_data_t *info = get_mach_timebase_info(); uint64_t t = mach_absolute_time(); tt.count = (int32_t)(t % 1000000000); tt.giga_count = t / 1000000000; numerators[num_numerators++] = info->numer; denominators[num_denominators++] = info->denom; denominators[num_denominators++] = 1000000000; goto success; } #endif } else { #if defined(HAVE_CLOCK_GETTIME) struct timespec ts; clockid_t c; c = NUM2CLOCKID(clk_id); ret = clock_gettime(c, &ts); if (ret == -1) rb_sys_fail("clock_gettime"); tt.count = (int32_t)ts.tv_nsec; tt.giga_count = ts.tv_sec; denominators[num_denominators++] = 1000000000; goto success; #endif } /* EINVAL emulates clock_gettime behavior when clock_id is invalid. */ rb_syserr_fail(EINVAL, 0); success: return make_clock_result(&tt, numerators, num_numerators, denominators, num_denominators, unit); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.clock_gettime;F;@Ö?;@Ø?;T;;-;0;@Ú?;{;IC;"pReturns a time returned by POSIX clock_gettime() function. p Process.clock_gettime(Process::CLOCK_MONOTONIC) #=> 896053.968060096 +clock_id+ specifies a kind of clock. It is specified as a constant which begins with Process::CLOCK_ such as Process::CLOCK_REALTIME and Process::CLOCK_MONOTONIC. The supported constants depends on OS and version. Ruby provides following types of +clock_id+ if available. [CLOCK_REALTIME] SUSv2 to 4, Linux 2.5.63, FreeBSD 3.0, NetBSD 2.0, OpenBSD 2.1, macOS 10.12 [CLOCK_MONOTONIC] SUSv3 to 4, Linux 2.5.63, FreeBSD 3.0, NetBSD 2.0, OpenBSD 3.4, macOS 10.12 [CLOCK_PROCESS_CPUTIME_ID] SUSv3 to 4, Linux 2.5.63, FreeBSD 9.3, OpenBSD 5.4, macOS 10.12 [CLOCK_THREAD_CPUTIME_ID] SUSv3 to 4, Linux 2.5.63, FreeBSD 7.1, OpenBSD 5.4, macOS 10.12 [CLOCK_VIRTUAL] FreeBSD 3.0, OpenBSD 2.1 [CLOCK_PROF] FreeBSD 3.0, OpenBSD 2.1 [CLOCK_REALTIME_FAST] FreeBSD 8.1 [CLOCK_REALTIME_PRECISE] FreeBSD 8.1 [CLOCK_REALTIME_COARSE] Linux 2.6.32 [CLOCK_REALTIME_ALARM] Linux 3.0 [CLOCK_MONOTONIC_FAST] FreeBSD 8.1 [CLOCK_MONOTONIC_PRECISE] FreeBSD 8.1 [CLOCK_MONOTONIC_COARSE] Linux 2.6.32 [CLOCK_MONOTONIC_RAW] Linux 2.6.28, macOS 10.12 [CLOCK_MONOTONIC_RAW_APPROX] macOS 10.12 [CLOCK_BOOTTIME] Linux 2.6.39 [CLOCK_BOOTTIME_ALARM] Linux 3.0 [CLOCK_UPTIME] FreeBSD 7.0, OpenBSD 5.5 [CLOCK_UPTIME_FAST] FreeBSD 8.1 [CLOCK_UPTIME_RAW] macOS 10.12 [CLOCK_UPTIME_RAW_APPROX] macOS 10.12 [CLOCK_UPTIME_PRECISE] FreeBSD 8.1 [CLOCK_SECOND] FreeBSD 8.1 [CLOCK_TAI] Linux 3.10 Note that SUS stands for Single Unix Specification. SUS contains POSIX and clock_gettime is defined in the POSIX part. SUS defines CLOCK_REALTIME mandatory but CLOCK_MONOTONIC, CLOCK_PROCESS_CPUTIME_ID and CLOCK_THREAD_CPUTIME_ID are optional. Also, several symbols are accepted as +clock_id+. There are emulations for clock_gettime(). For example, Process::CLOCK_REALTIME is defined as +:GETTIMEOFDAY_BASED_CLOCK_REALTIME+ when clock_gettime() is not available. Emulations for +CLOCK_REALTIME+: [:GETTIMEOFDAY_BASED_CLOCK_REALTIME] Use gettimeofday() defined by SUS. (SUSv4 obsoleted it, though.) The resolution is 1 microsecond. [:TIME_BASED_CLOCK_REALTIME] Use time() defined by ISO C. The resolution is 1 second. Emulations for +CLOCK_MONOTONIC+: [:MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC] Use mach_absolute_time(), available on Darwin. The resolution is CPU dependent. [:TIMES_BASED_CLOCK_MONOTONIC] Use the result value of times() defined by POSIX. POSIX defines it as "times() shall return the elapsed real time, in clock ticks, since an arbitrary point in the past (for example, system start-up time)". For example, GNU/Linux returns a value based on jiffies and it is monotonic. However, 4.4BSD uses gettimeofday() and it is not monotonic. (FreeBSD uses clock_gettime(CLOCK_MONOTONIC) instead, though.) The resolution is the clock tick. "getconf CLK_TCK" command shows the clock ticks per second. (The clock ticks per second is defined by HZ macro in older systems.) If it is 100 and clock_t is 32 bits integer type, the resolution is 10 millisecond and cannot represent over 497 days. Emulations for +CLOCK_PROCESS_CPUTIME_ID+: [:GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID] Use getrusage() defined by SUS. getrusage() is used with RUSAGE_SELF to obtain the time only for the calling process (excluding the time for child processes). The result is addition of user time (ru_utime) and system time (ru_stime). The resolution is 1 microsecond. [:TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID] Use times() defined by POSIX. The result is addition of user time (tms_utime) and system time (tms_stime). tms_cutime and tms_cstime are ignored to exclude the time for child processes. The resolution is the clock tick. "getconf CLK_TCK" command shows the clock ticks per second. (The clock ticks per second is defined by HZ macro in older systems.) If it is 100, the resolution is 10 millisecond. [:CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID] Use clock() defined by ISO C. The resolution is 1/CLOCKS_PER_SEC. CLOCKS_PER_SEC is the C-level macro defined by time.h. SUS defines CLOCKS_PER_SEC is 1000000. Non-Unix systems may define it a different value, though. If CLOCKS_PER_SEC is 1000000 as SUS, the resolution is 1 microsecond. If CLOCKS_PER_SEC is 1000000 and clock_t is 32 bits integer type, it cannot represent over 72 minutes. If the given +clock_id+ is not supported, Errno::EINVAL is raised. +unit+ specifies a type of the return value. [:float_second] number of seconds as a float (default) [:float_millisecond] number of milliseconds as a float [:float_microsecond] number of microseconds as a float [:second] number of seconds as an integer [:millisecond] number of milliseconds as an integer [:microsecond] number of microseconds as an integer [:nanosecond] number of nanoseconds as an integer The underlying function, clock_gettime(), returns a number of nanoseconds. Float object (IEEE 754 double) is not enough to represent the return value for CLOCK_REALTIME. If the exact nanoseconds value is required, use +:nanoseconds+ as the +unit+. The origin (zero) of the returned value varies. For example, system start up time, process start up time, the Epoch, etc. The origin in CLOCK_REALTIME is defined as the Epoch (1970-01-01 00:00:00 UTC). But some systems count leap seconds and others doesn't. So the result can be interpreted differently across systems. Time.now is recommended over CLOCK_REALTIME.;T;[o;= ;3I" overload;F;40;;-;50;)I"%clock_gettime(clock_id [, unit]);T;IC;";T; @ñ?;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @ñ?;[;I"@return [Numeric];T;0;6i;[[I"clock_id[, unit];T0; @ñ?;[;I"±Returns a time returned by POSIX clock_gettime() function. p Process.clock_gettime(Process::CLOCK_MONOTONIC) #=> 896053.968060096 +clock_id+ specifies a kind of clock. It is specified as a constant which begins with Process::CLOCK_ such as Process::CLOCK_REALTIME and Process::CLOCK_MONOTONIC. The supported constants depends on OS and version. Ruby provides following types of +clock_id+ if available. [CLOCK_REALTIME] SUSv2 to 4, Linux 2.5.63, FreeBSD 3.0, NetBSD 2.0, OpenBSD 2.1, macOS 10.12 [CLOCK_MONOTONIC] SUSv3 to 4, Linux 2.5.63, FreeBSD 3.0, NetBSD 2.0, OpenBSD 3.4, macOS 10.12 [CLOCK_PROCESS_CPUTIME_ID] SUSv3 to 4, Linux 2.5.63, FreeBSD 9.3, OpenBSD 5.4, macOS 10.12 [CLOCK_THREAD_CPUTIME_ID] SUSv3 to 4, Linux 2.5.63, FreeBSD 7.1, OpenBSD 5.4, macOS 10.12 [CLOCK_VIRTUAL] FreeBSD 3.0, OpenBSD 2.1 [CLOCK_PROF] FreeBSD 3.0, OpenBSD 2.1 [CLOCK_REALTIME_FAST] FreeBSD 8.1 [CLOCK_REALTIME_PRECISE] FreeBSD 8.1 [CLOCK_REALTIME_COARSE] Linux 2.6.32 [CLOCK_REALTIME_ALARM] Linux 3.0 [CLOCK_MONOTONIC_FAST] FreeBSD 8.1 [CLOCK_MONOTONIC_PRECISE] FreeBSD 8.1 [CLOCK_MONOTONIC_COARSE] Linux 2.6.32 [CLOCK_MONOTONIC_RAW] Linux 2.6.28, macOS 10.12 [CLOCK_MONOTONIC_RAW_APPROX] macOS 10.12 [CLOCK_BOOTTIME] Linux 2.6.39 [CLOCK_BOOTTIME_ALARM] Linux 3.0 [CLOCK_UPTIME] FreeBSD 7.0, OpenBSD 5.5 [CLOCK_UPTIME_FAST] FreeBSD 8.1 [CLOCK_UPTIME_RAW] macOS 10.12 [CLOCK_UPTIME_RAW_APPROX] macOS 10.12 [CLOCK_UPTIME_PRECISE] FreeBSD 8.1 [CLOCK_SECOND] FreeBSD 8.1 [CLOCK_TAI] Linux 3.10 Note that SUS stands for Single Unix Specification. SUS contains POSIX and clock_gettime is defined in the POSIX part. SUS defines CLOCK_REALTIME mandatory but CLOCK_MONOTONIC, CLOCK_PROCESS_CPUTIME_ID and CLOCK_THREAD_CPUTIME_ID are optional. Also, several symbols are accepted as +clock_id+. There are emulations for clock_gettime(). For example, Process::CLOCK_REALTIME is defined as +:GETTIMEOFDAY_BASED_CLOCK_REALTIME+ when clock_gettime() is not available. Emulations for +CLOCK_REALTIME+: [:GETTIMEOFDAY_BASED_CLOCK_REALTIME] Use gettimeofday() defined by SUS. (SUSv4 obsoleted it, though.) The resolution is 1 microsecond. [:TIME_BASED_CLOCK_REALTIME] Use time() defined by ISO C. The resolution is 1 second. Emulations for +CLOCK_MONOTONIC+: [:MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC] Use mach_absolute_time(), available on Darwin. The resolution is CPU dependent. [:TIMES_BASED_CLOCK_MONOTONIC] Use the result value of times() defined by POSIX. POSIX defines it as "times() shall return the elapsed real time, in clock ticks, since an arbitrary point in the past (for example, system start-up time)". For example, GNU/Linux returns a value based on jiffies and it is monotonic. However, 4.4BSD uses gettimeofday() and it is not monotonic. (FreeBSD uses clock_gettime(CLOCK_MONOTONIC) instead, though.) The resolution is the clock tick. "getconf CLK_TCK" command shows the clock ticks per second. (The clock ticks per second is defined by HZ macro in older systems.) If it is 100 and clock_t is 32 bits integer type, the resolution is 10 millisecond and cannot represent over 497 days. Emulations for +CLOCK_PROCESS_CPUTIME_ID+: [:GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID] Use getrusage() defined by SUS. getrusage() is used with RUSAGE_SELF to obtain the time only for the calling process (excluding the time for child processes). The result is addition of user time (ru_utime) and system time (ru_stime). The resolution is 1 microsecond. [:TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID] Use times() defined by POSIX. The result is addition of user time (tms_utime) and system time (tms_stime). tms_cutime and tms_cstime are ignored to exclude the time for child processes. The resolution is the clock tick. "getconf CLK_TCK" command shows the clock ticks per second. (The clock ticks per second is defined by HZ macro in older systems.) If it is 100, the resolution is 10 millisecond. [:CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID] Use clock() defined by ISO C. The resolution is 1/CLOCKS_PER_SEC. CLOCKS_PER_SEC is the C-level macro defined by time.h. SUS defines CLOCKS_PER_SEC is 1000000. Non-Unix systems may define it a different value, though. If CLOCKS_PER_SEC is 1000000 as SUS, the resolution is 1 microsecond. If CLOCKS_PER_SEC is 1000000 and clock_t is 32 bits integer type, it cannot represent over 72 minutes. If the given +clock_id+ is not supported, Errno::EINVAL is raised. +unit+ specifies a type of the return value. [:float_second] number of seconds as a float (default) [:float_millisecond] number of milliseconds as a float [:float_microsecond] number of microseconds as a float [:second] number of seconds as an integer [:millisecond] number of milliseconds as an integer [:microsecond] number of microseconds as an integer [:nanosecond] number of nanoseconds as an integer The underlying function, clock_gettime(), returns a number of nanoseconds. Float object (IEEE 754 double) is not enough to represent the return value for CLOCK_REALTIME. If the exact nanoseconds value is required, use +:nanoseconds+ as the +unit+. The origin (zero) of the returned value varies. For example, system start up time, process start up time, the Epoch, etc. The origin in CLOCK_REALTIME is defined as the Epoch (1970-01-01 00:00:00 UTC). But some systems count leap seconds and others doesn't. So the result can be interpreted differently across systems. Time.now is recommended over CLOCK_REALTIME. @overload clock_gettime(clock_id [, unit]) @return [Numeric];T;0; @ñ?;!F;"o;#;$T;%iº;&i7 ;6i;'@*;(@ï?;)@ð?;*To;;F; ;;;Ï;I"Process#clock_getres;F;[[@c0;[[@P i!;T;:clock_getres;0;[;{;IC;"äReturns an estimate of the resolution of a +clock_id+ using the POSIX clock_getres() function. Note the reported resolution is often inaccurate on most platforms due to underlying bugs for this function and therefore the reported resolution often differs from the actual resolution of the clock in practice. Inaccurate reported resolutions have been observed for various clocks including CLOCK_MONOTONIC and CLOCK_MONOTONIC_RAW when using Linux, macOS, BSD or AIX platforms, when using ARM processors, or when using virtualization. +clock_id+ specifies a kind of clock. See the document of +Process.clock_gettime+ for details. +clock_id+ can be a symbol as for +Process.clock_gettime+. If the given +clock_id+ is not supported, Errno::EINVAL is raised. +unit+ specifies the type of the return value. +Process.clock_getres+ accepts +unit+ as +Process.clock_gettime+. The default value, +:float_second+, is also the same as +Process.clock_gettime+. +Process.clock_getres+ also accepts +:hertz+ as +unit+. +:hertz+ means the reciprocal of +:float_second+. +:hertz+ can be used to obtain the exact value of the clock ticks per second for the times() function and CLOCKS_PER_SEC for the clock() function. Process.clock_getres(:TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID, :hertz) returns the clock ticks per second. Process.clock_getres(:CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID, :hertz) returns CLOCKS_PER_SEC. p Process.clock_getres(Process::CLOCK_MONOTONIC) #=> 1.0e-09 ;T; @@;>0;!F;[o;= ;3I" overload;F;40;;.;50;)I"$clock_getres(clock_id [, unit]);T;IC;";T; @@;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @@;[;I"@return [Numeric];T;0;6i;[[I"clock_id[, unit];T0; @@;[;I"#Returns an estimate of the resolution of a +clock_id+ using the POSIX clock_getres() function. Note the reported resolution is often inaccurate on most platforms due to underlying bugs for this function and therefore the reported resolution often differs from the actual resolution of the clock in practice. Inaccurate reported resolutions have been observed for various clocks including CLOCK_MONOTONIC and CLOCK_MONOTONIC_RAW when using Linux, macOS, BSD or AIX platforms, when using ARM processors, or when using virtualization. +clock_id+ specifies a kind of clock. See the document of +Process.clock_gettime+ for details. +clock_id+ can be a symbol as for +Process.clock_gettime+. If the given +clock_id+ is not supported, Errno::EINVAL is raised. +unit+ specifies the type of the return value. +Process.clock_getres+ accepts +unit+ as +Process.clock_gettime+. The default value, +:float_second+, is also the same as +Process.clock_gettime+. +Process.clock_getres+ also accepts +:hertz+ as +unit+. +:hertz+ means the reciprocal of +:float_second+. +:hertz+ can be used to obtain the exact value of the clock ticks per second for the times() function and CLOCKS_PER_SEC for the clock() function. Process.clock_getres(:TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID, :hertz) returns the clock ticks per second. Process.clock_getres(:CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID, :hertz) returns CLOCKS_PER_SEC. p Process.clock_getres(Process::CLOCK_MONOTONIC) #=> 1.0e-09 @overload clock_getres(clock_id [, unit]) @return [Numeric];T;0;'@*;(I"˜static VALUE rb_clock_getres(int argc, VALUE *argv, VALUE _) { struct timetick tt; timetick_int_t numerators[2]; timetick_int_t denominators[2]; int num_numerators = 0; int num_denominators = 0; VALUE unit = (rb_check_arity(argc, 1, 2) == 2) ? argv[1] : Qnil; VALUE clk_id = argv[0]; if (SYMBOL_P(clk_id)) { #ifdef RUBY_GETTIMEOFDAY_BASED_CLOCK_REALTIME if (clk_id == RUBY_GETTIMEOFDAY_BASED_CLOCK_REALTIME) { tt.giga_count = 0; tt.count = 1000; denominators[num_denominators++] = 1000000000; goto success; } #endif #ifdef RUBY_TIME_BASED_CLOCK_REALTIME if (clk_id == RUBY_TIME_BASED_CLOCK_REALTIME) { tt.giga_count = 1; tt.count = 0; denominators[num_denominators++] = 1000000000; goto success; } #endif #ifdef RUBY_TIMES_BASED_CLOCK_MONOTONIC if (clk_id == RUBY_TIMES_BASED_CLOCK_MONOTONIC) { tt.count = 1; tt.giga_count = 0; denominators[num_denominators++] = get_clk_tck(); goto success; } #endif #ifdef RUBY_GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID if (clk_id == RUBY_GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID) { tt.giga_count = 0; tt.count = 1000; denominators[num_denominators++] = 1000000000; goto success; } #endif #ifdef RUBY_TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID if (clk_id == RUBY_TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID) { tt.count = 1; tt.giga_count = 0; denominators[num_denominators++] = get_clk_tck(); goto success; } #endif #ifdef RUBY_CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID if (clk_id == RUBY_CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID) { tt.count = 1; tt.giga_count = 0; denominators[num_denominators++] = CLOCKS_PER_SEC; goto success; } #endif #ifdef RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC if (clk_id == RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC) { const mach_timebase_info_data_t *info = get_mach_timebase_info(); tt.count = 1; tt.giga_count = 0; numerators[num_numerators++] = info->numer; denominators[num_denominators++] = info->denom; denominators[num_denominators++] = 1000000000; goto success; } #endif } else { #if defined(HAVE_CLOCK_GETRES) struct timespec ts; clockid_t c = NUM2CLOCKID(clk_id); int ret = clock_getres(c, &ts); if (ret == -1) rb_sys_fail("clock_getres"); tt.count = (int32_t)ts.tv_nsec; tt.giga_count = ts.tv_sec; denominators[num_denominators++] = 1000000000; goto success; #endif } /* EINVAL emulates clock_getres behavior when clock_id is invalid. */ rb_syserr_fail(EINVAL, 0); success: if (unit == ID2SYM(id_hertz)) { return timetick2dblnum_reciprocal(&tt, numerators, num_numerators, denominators, num_denominators); } else { return make_clock_result(&tt, numerators, num_numerators, denominators, num_denominators, unit); } };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process.clock_getres;F;@ @;@@;T;;.;0;@@;{;IC;"äReturns an estimate of the resolution of a +clock_id+ using the POSIX clock_getres() function. Note the reported resolution is often inaccurate on most platforms due to underlying bugs for this function and therefore the reported resolution often differs from the actual resolution of the clock in practice. Inaccurate reported resolutions have been observed for various clocks including CLOCK_MONOTONIC and CLOCK_MONOTONIC_RAW when using Linux, macOS, BSD or AIX platforms, when using ARM processors, or when using virtualization. +clock_id+ specifies a kind of clock. See the document of +Process.clock_gettime+ for details. +clock_id+ can be a symbol as for +Process.clock_gettime+. If the given +clock_id+ is not supported, Errno::EINVAL is raised. +unit+ specifies the type of the return value. +Process.clock_getres+ accepts +unit+ as +Process.clock_gettime+. The default value, +:float_second+, is also the same as +Process.clock_gettime+. +Process.clock_getres+ also accepts +:hertz+ as +unit+. +:hertz+ means the reciprocal of +:float_second+. +:hertz+ can be used to obtain the exact value of the clock ticks per second for the times() function and CLOCKS_PER_SEC for the clock() function. Process.clock_getres(:TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID, :hertz) returns the clock ticks per second. Process.clock_getres(:CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID, :hertz) returns CLOCKS_PER_SEC. p Process.clock_getres(Process::CLOCK_MONOTONIC) #=> 1.0e-09;T;[o;= ;3I" overload;F;40;;.;50;)I"$clock_getres(clock_id [, unit]);T;IC;";T; @%@;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @%@;[;I"@return [Numeric];T;0;6i;[[I"clock_id[, unit];T0; @%@;[;I"%Returns an estimate of the resolution of a +clock_id+ using the POSIX clock_getres() function. Note the reported resolution is often inaccurate on most platforms due to underlying bugs for this function and therefore the reported resolution often differs from the actual resolution of the clock in practice. Inaccurate reported resolutions have been observed for various clocks including CLOCK_MONOTONIC and CLOCK_MONOTONIC_RAW when using Linux, macOS, BSD or AIX platforms, when using ARM processors, or when using virtualization. +clock_id+ specifies a kind of clock. See the document of +Process.clock_gettime+ for details. +clock_id+ can be a symbol as for +Process.clock_gettime+. If the given +clock_id+ is not supported, Errno::EINVAL is raised. +unit+ specifies the type of the return value. +Process.clock_getres+ accepts +unit+ as +Process.clock_gettime+. The default value, +:float_second+, is also the same as +Process.clock_gettime+. +Process.clock_getres+ also accepts +:hertz+ as +unit+. +:hertz+ means the reciprocal of +:float_second+. +:hertz+ can be used to obtain the exact value of the clock ticks per second for the times() function and CLOCKS_PER_SEC for the clock() function. Process.clock_getres(:TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID, :hertz) returns the clock ticks per second. Process.clock_getres(:CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID, :hertz) returns CLOCKS_PER_SEC. p Process.clock_getres(Process::CLOCK_MONOTONIC) #=> 1.0e-09 @overload clock_getres(clock_id [, unit]) @return [Numeric];T;0; @%@;!F;"o;#;$T;%iØ ;&i!;6i;'@*;(@#@;)@$@;*To; ;IC;[o;;F; ;;;Ï;I"Process::UID#rid;F;[;[[@P i;T;:rid;0;[;{;IC;"JReturns the (real) user ID of this process. Process.uid #=> 501 ;T; @>@;>0;!F;[o;= ;3I" overload;F;40;;þ;50;)I"uid;T;IC;";T; @>@;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @>@;[;I"@return [Integer];T;0;6i;[; @>@o;= ;3I" overload;F;40;;ÿ;50;)I"Process::UID.rid;T;IC;";T; @>@;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @>@;[;I"@return [Integer];T;0;6i;[; @>@o;= ;3I" overload;F;40;;;50;)I"Process::Sys.getuid;T;IC;";T; @>@;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @>@;[;I"@return [Integer];T;0;6i;[; @>@;[;I"ËReturns the (real) user ID of this process. Process.uid #=> 501 @overload uid @return [Integer] @overload Process::UID.rid @return [Integer] @overload Process::Sys.getuid @return [Integer];T;0;'@<@;(I"cstatic VALUE proc_getuid(VALUE obj) { rb_uid_t uid = getuid(); return UIDT2NUM(uid); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::UID.rid;F;@@@;@A@;T;;/;0;@C@;{;IC;"JReturns the (real) user ID of this process. Process.uid #=> 501;T;[o;= ;3I" overload;F;40;;þ;50;)I"uid;T;IC;";T; @r@;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @r@;[;I"@return [Integer];T;0;6i;[; @r@o;= ;3I" overload;F;40;;ÿ;50;)I"Process::UID.rid;T;IC;";T; @r@;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @r@;[;I"@return [Integer];T;0;6i;[; @r@o;= ;3I" overload;F;40;;;50;)I"Process::Sys.getuid;T;IC;";T; @r@;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @r@;[;I"@return [Integer];T;0;6i;[; @r@;[;@Y;;0; @r@;!F;"o;#;$T;%i„;&iŽ;6i;'@<@;(@p@;)@q@;*To;;F; ;;;Ï;I"Process::UID#eid;F;[;[[@P iX;T;:eid;0;[;{;IC;"OReturns the effective user ID for this process. Process.euid #=> 501 ;T; @ @;>0;!F;[o;= ;3I" overload;F;40;;;50;)I" euid;T;IC;";T; @ @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ @;[;I"@return [Integer];T;0;6i;[; @ @o;= ;3I" overload;F;40;;;50;)I"Process::UID.eid;T;IC;";T; @ @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ @;[;I"@return [Integer];T;0;6i;[; @ @o;= ;3I" overload;F;40;;;50;)I"Process::Sys.geteuid;T;IC;";T; @ @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ @;[;I"@return [Integer];T;0;6i;[; @ @;[;I"ÒReturns the effective user ID for this process. Process.euid #=> 501 @overload euid @return [Integer] @overload Process::UID.eid @return [Integer] @overload Process::Sys.geteuid @return [Integer];T;0;'@<@;(I"gstatic VALUE proc_geteuid(VALUE obj) { rb_uid_t euid = geteuid(); return UIDT2NUM(euid); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::UID.eid;F;@¢@;@£@;T;;0;0;@¥@;{;IC;"OReturns the effective user ID for this process. Process.euid #=> 501;T;[o;= ;3I" overload;F;40;;;50;)I" euid;T;IC;";T; @Ô@;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ô@;[;I"@return [Integer];T;0;6i;[; @Ô@o;= ;3I" overload;F;40;;;50;)I"Process::UID.eid;T;IC;";T; @Ô@;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ô@;[;I"@return [Integer];T;0;6i;[; @Ô@o;= ;3I" overload;F;40;;;50;)I"Process::Sys.geteuid;T;IC;";T; @Ô@;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ô@;[;I"@return [Integer];T;0;6i;[; @Ô@;[;@‰<;0; @Ô@;!F;"o;#;$T;%iM;&iW;6i;'@<@;(@Ò@;)@Ó@;*To;;F; ;;;Ï;I""Process::UID#change_privilege;F;[[I"id;T0;[[@P iç;T;:change_privilege;0;[;{;IC;"%Change the current process's real and effective user ID to that specified by _user_. Returns the new user ID. Not available on all platforms. [Process.uid, Process.euid] #=> [0, 0] Process::UID.change_privilege(31) #=> 31 [Process.uid, Process.euid] #=> [31, 31] ;T; @A;>0;!F;[o;= ;3I" overload;F;40;:"Process::UID.change_privilege;50;)I"(Process::UID.change_privilege(user);T;IC;";T; @A;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @A;[;I"@return [Integer];T;0;6i;[[I" user;T0; @A;[;I"hChange the current process's real and effective user ID to that specified by _user_. Returns the new user ID. Not available on all platforms. [Process.uid, Process.euid] #=> [0, 0] Process::UID.change_privilege(31) #=> 31 [Process.uid, Process.euid] #=> [31, 31] @overload Process::UID.change_privilege(user) @return [Integer];T;0;'@<@;(I"kstatic VALUE p_uid_change_privilege(VALUE obj, VALUE id) { rb_uid_t uid; check_uid_switch(); uid = OBJ2UID(id); if (geteuid() == 0) { /* root-user */ #if defined(HAVE_SETRESUID) if (setresuid(uid, uid, uid) < 0) rb_sys_fail(0); SAVED_USER_ID = uid; #elif defined(HAVE_SETUID) if (setuid(uid) < 0) rb_sys_fail(0); SAVED_USER_ID = uid; #elif defined(HAVE_SETREUID) && !defined(OBSOLETE_SETREUID) if (getuid() == uid) { if (SAVED_USER_ID == uid) { if (setreuid(-1, uid) < 0) rb_sys_fail(0); } else { if (uid == 0) { /* (r,e,s) == (root, root, x) */ if (setreuid(-1, SAVED_USER_ID) < 0) rb_sys_fail(0); if (setreuid(SAVED_USER_ID, 0) < 0) rb_sys_fail(0); SAVED_USER_ID = 0; /* (r,e,s) == (x, root, root) */ if (setreuid(uid, uid) < 0) rb_sys_fail(0); SAVED_USER_ID = uid; } else { if (setreuid(0, -1) < 0) rb_sys_fail(0); SAVED_USER_ID = 0; if (setreuid(uid, uid) < 0) rb_sys_fail(0); SAVED_USER_ID = uid; } } } else { if (setreuid(uid, uid) < 0) rb_sys_fail(0); SAVED_USER_ID = uid; } #elif defined(HAVE_SETRUID) && defined(HAVE_SETEUID) if (getuid() == uid) { if (SAVED_USER_ID == uid) { if (seteuid(uid) < 0) rb_sys_fail(0); } else { if (uid == 0) { if (setruid(SAVED_USER_ID) < 0) rb_sys_fail(0); SAVED_USER_ID = 0; if (setruid(0) < 0) rb_sys_fail(0); } else { if (setruid(0) < 0) rb_sys_fail(0); SAVED_USER_ID = 0; if (seteuid(uid) < 0) rb_sys_fail(0); if (setruid(uid) < 0) rb_sys_fail(0); SAVED_USER_ID = uid; } } } else { if (seteuid(uid) < 0) rb_sys_fail(0); if (setruid(uid) < 0) rb_sys_fail(0); SAVED_USER_ID = uid; } #else (void)uid; rb_notimplement(); #endif } else { /* unprivileged user */ #if defined(HAVE_SETRESUID) if (setresuid((getuid() == uid)? (rb_uid_t)-1: uid, (geteuid() == uid)? (rb_uid_t)-1: uid, (SAVED_USER_ID == uid)? (rb_uid_t)-1: uid) < 0) rb_sys_fail(0); SAVED_USER_ID = uid; #elif defined(HAVE_SETREUID) && !defined(OBSOLETE_SETREUID) if (SAVED_USER_ID == uid) { if (setreuid((getuid() == uid)? (rb_uid_t)-1: uid, (geteuid() == uid)? (rb_uid_t)-1: uid) < 0) rb_sys_fail(0); } else if (getuid() != uid) { if (setreuid(uid, (geteuid() == uid)? (rb_uid_t)-1: uid) < 0) rb_sys_fail(0); SAVED_USER_ID = uid; } else if (/* getuid() == uid && */ geteuid() != uid) { if (setreuid(geteuid(), uid) < 0) rb_sys_fail(0); SAVED_USER_ID = uid; if (setreuid(uid, -1) < 0) rb_sys_fail(0); } else { /* getuid() == uid && geteuid() == uid */ if (setreuid(-1, SAVED_USER_ID) < 0) rb_sys_fail(0); if (setreuid(SAVED_USER_ID, uid) < 0) rb_sys_fail(0); SAVED_USER_ID = uid; if (setreuid(uid, -1) < 0) rb_sys_fail(0); } #elif defined(HAVE_SETRUID) && defined(HAVE_SETEUID) if (SAVED_USER_ID == uid) { if (geteuid() != uid && seteuid(uid) < 0) rb_sys_fail(0); if (getuid() != uid && setruid(uid) < 0) rb_sys_fail(0); } else if (/* SAVED_USER_ID != uid && */ geteuid() == uid) { if (getuid() != uid) { if (setruid(uid) < 0) rb_sys_fail(0); SAVED_USER_ID = uid; } else { if (setruid(SAVED_USER_ID) < 0) rb_sys_fail(0); SAVED_USER_ID = uid; if (setruid(uid) < 0) rb_sys_fail(0); } } else if (/* geteuid() != uid && */ getuid() == uid) { if (seteuid(uid) < 0) rb_sys_fail(0); if (setruid(SAVED_USER_ID) < 0) rb_sys_fail(0); SAVED_USER_ID = uid; if (setruid(uid) < 0) rb_sys_fail(0); } else { rb_syserr_fail(EPERM, 0); } #elif defined HAVE_44BSD_SETUID if (getuid() == uid) { /* (r,e,s)==(uid,?,?) ==> (uid,uid,uid) */ if (setuid(uid) < 0) rb_sys_fail(0); SAVED_USER_ID = uid; } else { rb_syserr_fail(EPERM, 0); } #elif defined HAVE_SETEUID if (getuid() == uid && SAVED_USER_ID == uid) { if (seteuid(uid) < 0) rb_sys_fail(0); } else { rb_syserr_fail(EPERM, 0); } #elif defined HAVE_SETUID if (getuid() == uid && SAVED_USER_ID == uid) { if (setuid(uid) < 0) rb_sys_fail(0); } else { rb_syserr_fail(EPERM, 0); } #else rb_notimplement(); #endif } return id; };T;)I"static VALUE;T;*To;;T; ;F;;;I""Process::UID.change_privilege;F;@A;@A;T;;1;0;@ A;{;IC;"%Change the current process's real and effective user ID to that specified by _user_. Returns the new user ID. Not available on all platforms. [Process.uid, Process.euid] #=> [0, 0] Process::UID.change_privilege(31) #=> 31 [Process.uid, Process.euid] #=> [31, 31];T;[o;= ;3I" overload;F;40;;2;50;)I"(Process::UID.change_privilege(user);T;IC;";T; @ A;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ A;[;I"@return [Integer];T;0;6i;[[I" user;T0; @ A;[;I"iChange the current process's real and effective user ID to that specified by _user_. Returns the new user ID. Not available on all platforms. [Process.uid, Process.euid] #=> [0, 0] Process::UID.change_privilege(31) #=> 31 [Process.uid, Process.euid] #=> [31, 31] @overload Process::UID.change_privilege(user) @return [Integer];T;0; @ A;!F;"o;#;$T;%iÚ;&iä;6i;'@<@;(@A;)@A;*To;;F; ;;;Ï;I"!Process::UID#grant_privilege;F;[[I"id;T0;[[@P iÀ;T;:grant_privilege;0;[;{;IC;";Set the effective user ID, and if possible, the saved user ID of the process to the given _user_. Returns the new effective user ID. Not available on all platforms. [Process.uid, Process.euid] #=> [0, 0] Process::UID.grant_privilege(31) #=> 31 [Process.uid, Process.euid] #=> [0, 31] ;T; @7A;>0;!F;[o;= ;3I" overload;F;40;:!Process::UID.grant_privilege;50;)I"'Process::UID.grant_privilege(user);T;IC;";T; @7A;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @7A;[;I"@return [Integer];T;0;6i;[[I" user;T0; @7Ao;= ;3I" overload;F;40;:Process::UID.eid=;50;)I"Process::UID.eid= user;T;IC;";T; @7A;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @7A;[;I"@return [Integer];T;0;6i;[[I" user;T0; @7A;[;I"³Set the effective user ID, and if possible, the saved user ID of the process to the given _user_. Returns the new effective user ID. Not available on all platforms. [Process.uid, Process.euid] #=> [0, 0] Process::UID.grant_privilege(31) #=> 31 [Process.uid, Process.euid] #=> [0, 31] @overload Process::UID.grant_privilege(user) @return [Integer] @overload Process::UID.eid= user @return [Integer];T;0;'@<@;(I"qstatic VALUE p_uid_grant_privilege(VALUE obj, VALUE id) { rb_seteuid_core(OBJ2UID(id)); return id; };T;)I"static VALUE;T;*To;;T; ;F;;;I"!Process::UID.grant_privilege;F;@9A;@A;{;IC;";Set the effective user ID, and if possible, the saved user ID of the process to the given _user_. Returns the new effective user ID. Not available on all platforms. [Process.uid, Process.euid] #=> [0, 0] Process::UID.grant_privilege(31) #=> 31 [Process.uid, Process.euid] #=> [0, 31];T;[o;= ;3I" overload;F;40;;4;50;)I"'Process::UID.grant_privilege(user);T;IC;";T; @dA;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @dA;[;I"@return [Integer];T;0;6i;[[I" user;T0; @dAo;= ;3I" overload;F;40;;5;50;)I"Process::UID.eid= user;T;IC;";T; @dA;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @dA;[;I"@return [Integer];T;0;6i;[[I" user;T0; @dA;[;I"³Set the effective user ID, and if possible, the saved user ID of the process to the given _user_. Returns the new effective user ID. Not available on all platforms. [Process.uid, Process.euid] #=> [0, 0] Process::UID.grant_privilege(31) #=> 31 [Process.uid, Process.euid] #=> [0, 31] @overload Process::UID.grant_privilege(user) @return [Integer] @overload Process::UID.eid= user @return [Integer];T;0; @dA;!F;"o;#;$T;%i²;&i¾;6i;'@<@;(@bA;)@cA;*To;;F; ;;;Ï;I"Process::UID#re_exchange;F;[;[[@P il;T;:re_exchange;0;[;{;IC;"ìExchange real and effective user IDs and return the new effective user ID. Not available on all platforms. [Process.uid, Process.euid] #=> [0, 31] Process::UID.re_exchange #=> 0 [Process.uid, Process.euid] #=> [31, 0] ;T; @ŠA;>0;!F;[o;= ;3I" overload;F;40;:Process::UID.re_exchange;50;)I"Process::UID.re_exchange;T;IC;";T; @ŠA;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ŠA;[;I"@return [Integer];T;0;6i;[; @ŠA;[;I"$Exchange real and effective user IDs and return the new effective user ID. Not available on all platforms. [Process.uid, Process.euid] #=> [0, 31] Process::UID.re_exchange #=> 0 [Process.uid, Process.euid] #=> [31, 0] @overload Process::UID.re_exchange @return [Integer];T;0;'@<@;(I"static VALUE p_uid_exchange(VALUE obj) { rb_uid_t uid; #if defined(HAVE_SETRESUID) || (defined(HAVE_SETREUID) && !defined(OBSOLETE_SETREUID)) rb_uid_t euid; #endif check_uid_switch(); uid = getuid(); #if defined(HAVE_SETRESUID) || (defined(HAVE_SETREUID) && !defined(OBSOLETE_SETREUID)) euid = geteuid(); #endif #if defined(HAVE_SETRESUID) if (setresuid(euid, uid, uid) < 0) rb_sys_fail(0); SAVED_USER_ID = uid; #elif defined(HAVE_SETREUID) && !defined(OBSOLETE_SETREUID) if (setreuid(euid,uid) < 0) rb_sys_fail(0); SAVED_USER_ID = uid; #else rb_notimplement(); #endif return UIDT2NUM(uid); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::UID.re_exchange;F;@ŒA;@A;T;;6;0;@A;{;IC;"ìExchange real and effective user IDs and return the new effective user ID. Not available on all platforms. [Process.uid, Process.euid] #=> [0, 31] Process::UID.re_exchange #=> 0 [Process.uid, Process.euid] #=> [31, 0];T;[o;= ;3I" overload;F;40;;7;50;)I"Process::UID.re_exchange;T;IC;";T; @¤A;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¤A;[;I"@return [Integer];T;0;6i;[; @¤A;[;I"%Exchange real and effective user IDs and return the new effective user ID. Not available on all platforms. [Process.uid, Process.euid] #=> [0, 31] Process::UID.re_exchange #=> 0 [Process.uid, Process.euid] #=> [31, 0] @overload Process::UID.re_exchange @return [Integer];T;0; @¤A;!F;"o;#;$T;%i`;&ii;6i;'@<@;(@¢A;)@£A;*To;;F; ;;;Ï;I""Process::UID#re_exchangeable?;F;[;[[@P iS;T;:re_exchangeable?;0;[;{;IC;"mReturns +true+ if the real and effective user IDs of a process may be exchanged on the current platform. ;T; @¹A;>0;!F;[o;= ;3I" overload;F;40;:"Process::UID.re_exchangeable?;50;)I""Process::UID.re_exchangeable?;T;IC;";T; @¹A;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @¹A;[;I"@return [Boolean];T;0;6i;[; @¹A;[;I"¥Returns +true+ if the real and effective user IDs of a process may be exchanged on the current platform. @overload Process::UID.re_exchangeable? @return [Boolean];T;0;'@<@;(I"Èstatic VALUE p_uid_exchangeable(VALUE _) { #if defined(HAVE_SETRESUID) return Qtrue; #elif defined(HAVE_SETREUID) && !defined(OBSOLETE_SETREUID) return Qtrue; #else return Qfalse; #endif };T;)I"static VALUE;T;*To;;T; ;F;;;I""Process::UID.re_exchangeable?;F;@»A;@¼A;T;;8;0;@¾A;{;IC;"mReturns +true+ if the real and effective user IDs of a process may be exchanged on the current platform.;T;[o;= ;3I" overload;F;40;;9;50;)I""Process::UID.re_exchangeable?;T;IC;";T; @ÓA;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ÓA;[;I"@return [Boolean];T;0;6i;[; @ÓA;[;I"§Returns +true+ if the real and effective user IDs of a process may be exchanged on the current platform. @overload Process::UID.re_exchangeable? @return [Boolean];T;0; @ÓA;!F;"o;#;$T;%iJ;&iP;6i;'@<@;(@ÑA;)@ÒA;*To;;F; ;;;Ï;I" Process::UID#sid_available?;F;[;[[@P iÐ;T;:sid_available?;0;[;{;IC;"LReturns +true+ if the current platform has saved user ID functionality. ;T; @èA;>0;!F;[o;= ;3I" overload;F;40;: Process::UID.sid_available?;50;)I" Process::UID.sid_available?;T;IC;";T; @èA;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @èA;[;I"@return [Boolean];T;0;6i;[; @èA;[;I"‚Returns +true+ if the current platform has saved user ID functionality. @overload Process::UID.sid_available? @return [Boolean];T;0;'@<@;(I"±static VALUE p_uid_have_saved_id(VALUE _) { #if defined(HAVE_SETRESUID) || defined(HAVE_SETEUID) || defined(_POSIX_SAVED_IDS) return Qtrue; #else return Qfalse; #endif };T;)I"static VALUE;T;*To;;T; ;F;;;I" Process::UID.sid_available?;F;@êA;@ëA;T;;:;0;@íA;{;IC;"LReturns +true+ if the current platform has saved user ID functionality.;T;[o;= ;3I" overload;F;40;;;;50;)I" Process::UID.sid_available?;T;IC;";T; @B;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @B;[;I"@return [Boolean];T;0;6i;[; @B;[;I"„Returns +true+ if the current platform has saved user ID functionality. @overload Process::UID.sid_available? @return [Boolean];T;0; @B;!F;"o;#;$T;%iÇ;&iÍ;6i;'@<@;(@B;)@B;*To;;F; ;;;Ï;I"Process::UID#switch;F;[;[[@P i;T;:switch;0;[;{;IC;" ;T; @B;>0;!F;[;[;I";F;0;'@<@;(I"sstatic VALUE p_uid_switch(VALUE obj) { rb_uid_t uid, euid; check_uid_switch(); uid = getuid(); euid = geteuid(); if (uid == euid) { rb_syserr_fail(EPERM, 0); } p_uid_exchange(obj); if (rb_block_given_p()) { under_uid_switch = 1; return rb_ensure(rb_yield, Qnil, p_uid_sw_ensure, obj); } else { return UIDT2NUM(euid); } };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::UID.switch;F;@B;@B;T;;<;0;@B;{;IC;";T;[;[;@|;0; @$B;6i;'@<@;(@"B;)@#B;*To;;F; ;;;Ï;I"Process::UID#from_name;F;[[I"id;T0;[[@P i°;T;:from_name;0;[;{;IC;"ÜGet the user ID by the _name_. If the user is not found, +ArgumentError+ will be raised. Process::UID.from_name("root") #=> 0 Process::UID.from_name("nosuchuser") #=> can't find user for nosuchuser (ArgumentError) ;T; @*B;>0;!F;[o;= ;3I" overload;F;40;:Process::UID.from_name;50;)I"!Process::UID.from_name(name);T;IC;";T; @*B;>0;!F;[;[;I";T;0;6i;[[I" name;T0; @*B;[;I"Get the user ID by the _name_. If the user is not found, +ArgumentError+ will be raised. Process::UID.from_name("root") #=> 0 Process::UID.from_name("nosuchuser") #=> can't find user for nosuchuser (ArgumentError) @overload Process::UID.from_name(name) ;T;0;'@<@;(I"]static VALUE p_uid_from_name(VALUE self, VALUE id) { return UIDT2NUM(OBJ2UID(id)); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::UID.from_name;F;@,B;@/B;T;;=;0;@1B;{;IC;"ÜGet the user ID by the _name_. If the user is not found, +ArgumentError+ will be raised. Process::UID.from_name("root") #=> 0 Process::UID.from_name("nosuchuser") #=> can't find user for nosuchuser (ArgumentError);T;[o;= ;3I" overload;F;40;;>;50;)I"!Process::UID.from_name(name);T;IC;";T; @CB;>0;!F;[;[;I";T;0;6i;[[I" name;T0; @CB;[;I"Get the user ID by the _name_. If the user is not found, +ArgumentError+ will be raised. Process::UID.from_name("root") #=> 0 Process::UID.from_name("nosuchuser") #=> can't find user for nosuchuser (ArgumentError) @overload Process::UID.from_name(name);T;0; @CB;!F;"o;#;$T;%i¥;&i¬;6i;'@<@;(@AB;)@BB;*T;A@<@;BIC;[;A@<@;CIC;[;A@<@;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@P i&#;F;:UID;;K;;;[;{;IC;";T;[;[;@|;0; @<@;6i;'@*;I"Process::UID;Fo; ;IC;[o;;F; ;;;Ï;I"Process::GID#rid;F;[;[[@P i";T;;/;0;[;{;IC;"LReturns the (real) group ID for this process. Process.gid #=> 500 ;T; @fB;>0;!F;[o;= ;3I" overload;F;40;;;50;)I"gid;T;IC;";T; @fB;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @fB;[;I"@return [Integer];T;0;6i;[; @fBo;= ;3I" overload;F;40;;;50;)I"Process::GID.rid;T;IC;";T; @fB;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @fB;[;I"@return [Integer];T;0;6i;[; @fBo;= ;3I" overload;F;40;;;50;)I"Process::Sys.getgid;T;IC;";T; @fB;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @fB;[;I"@return [Integer];T;0;6i;[; @fB;[;I"ÍReturns the (real) group ID for this process. Process.gid #=> 500 @overload gid @return [Integer] @overload Process::GID.rid @return [Integer] @overload Process::Sys.getgid @return [Integer];T;0;'@dB;(I"cstatic VALUE proc_getgid(VALUE obj) { rb_gid_t gid = getgid(); return GIDT2NUM(gid); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::GID.rid;F;@hB;@iB;T;;/;0;@kB;{;IC;"LReturns the (real) group ID for this process. Process.gid #=> 500;T;[o;= ;3I" overload;F;40;;;50;)I"gid;T;IC;";T; @šB;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @šB;[;I"@return [Integer];T;0;6i;[; @šBo;= ;3I" overload;F;40;;;50;)I"Process::GID.rid;T;IC;";T; @šB;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @šB;[;I"@return [Integer];T;0;6i;[; @šBo;= ;3I" overload;F;40;;;50;)I"Process::Sys.getgid;T;IC;";T; @šB;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @šB;[;I"@return [Integer];T;0;6i;[; @šB;[;@ñ;;0; @šB;!F;"o;#;$T;%i;&i!;6i;'@dB;(@˜B;)@™B;*To;;F; ;;;Ï;I"Process::GID#eid;F;[;[[@P iÔ;T;;0;0;[;{;IC;"pReturns the effective group ID for this process. Not available on all platforms. Process.egid #=> 500 ;T; @ÈB;>0;!F;[o;= ;3I" overload;F;40;; ;50;)I" egid;T;IC;";T; @ÈB;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ÈB;[;I"@return [Integer];T;0;6i;[; @ÈBo;= ;3I" overload;F;40;;;50;)I"Process::GID.eid;T;IC;";T; @ÈB;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ÈB;[;I"@return [Integer];T;0;6i;[; @ÈBo;= ;3I" overload;F;40;;;50;)I"Process::Sys.geteid;T;IC;";T; @ÈB;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ÈB;[;I"@return [Integer];T;0;6i;[; @ÈB;[;I"òReturns the effective group ID for this process. Not available on all platforms. Process.egid #=> 500 @overload egid @return [Integer] @overload Process::GID.eid @return [Integer] @overload Process::Sys.geteid @return [Integer];T;0;'@dB;(I"hstatic VALUE proc_getegid(VALUE obj) { rb_gid_t egid = getegid(); return GIDT2NUM(egid); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::GID.eid;F;@ÊB;@ËB;T;;0;0;@ÍB;{;IC;"pReturns the effective group ID for this process. Not available on all platforms. Process.egid #=> 500;T;[o;= ;3I" overload;F;40;; ;50;)I" egid;T;IC;";T; @üB;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @üB;[;I"@return [Integer];T;0;6i;[; @üBo;= ;3I" overload;F;40;;;50;)I"Process::GID.eid;T;IC;";T; @üB;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @üB;[;I"@return [Integer];T;0;6i;[; @üBo;= ;3I" overload;F;40;;;50;)I"Process::Sys.geteid;T;IC;";T; @üB;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @üB;[;I"@return [Integer];T;0;6i;[; @üB;[;@=;0; @üB;!F;"o;#;$T;%iÈ;&iÓ;6i;'@dB;(@úB;)@ûB;*To;;F; ;;;Ï;I""Process::GID#change_privilege;F;[[I"id;T0;[[@P i±;T;;1;0;[;{;IC;"(Change the current process's real and effective group ID to that specified by _group_. Returns the new group ID. Not available on all platforms. [Process.gid, Process.egid] #=> [0, 0] Process::GID.change_privilege(33) #=> 33 [Process.gid, Process.egid] #=> [33, 33] ;T; @*C;>0;!F;[o;= ;3I" overload;F;40;:"Process::GID.change_privilege;50;)I")Process::GID.change_privilege(group);T;IC;";T; @*C;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @*C;[;I"@return [Integer];T;0;6i;[[I" group;T0; @*C;[;I"lChange the current process's real and effective group ID to that specified by _group_. Returns the new group ID. Not available on all platforms. [Process.gid, Process.egid] #=> [0, 0] Process::GID.change_privilege(33) #=> 33 [Process.gid, Process.egid] #=> [33, 33] @overload Process::GID.change_privilege(group) @return [Integer];T;0;'@dB;(I"Ðstatic VALUE p_gid_change_privilege(VALUE obj, VALUE id) { rb_gid_t gid; check_gid_switch(); gid = OBJ2GID(id); if (geteuid() == 0) { /* root-user */ #if defined(HAVE_SETRESGID) if (setresgid(gid, gid, gid) < 0) rb_sys_fail(0); SAVED_GROUP_ID = gid; #elif defined HAVE_SETGID if (setgid(gid) < 0) rb_sys_fail(0); SAVED_GROUP_ID = gid; #elif defined(HAVE_SETREGID) && !defined(OBSOLETE_SETREGID) if (getgid() == gid) { if (SAVED_GROUP_ID == gid) { if (setregid(-1, gid) < 0) rb_sys_fail(0); } else { if (gid == 0) { /* (r,e,s) == (root, y, x) */ if (setregid(-1, SAVED_GROUP_ID) < 0) rb_sys_fail(0); if (setregid(SAVED_GROUP_ID, 0) < 0) rb_sys_fail(0); SAVED_GROUP_ID = 0; /* (r,e,s) == (x, root, root) */ if (setregid(gid, gid) < 0) rb_sys_fail(0); SAVED_GROUP_ID = gid; } else { /* (r,e,s) == (z, y, x) */ if (setregid(0, 0) < 0) rb_sys_fail(0); SAVED_GROUP_ID = 0; if (setregid(gid, gid) < 0) rb_sys_fail(0); SAVED_GROUP_ID = gid; } } } else { if (setregid(gid, gid) < 0) rb_sys_fail(0); SAVED_GROUP_ID = gid; } #elif defined(HAVE_SETRGID) && defined (HAVE_SETEGID) if (getgid() == gid) { if (SAVED_GROUP_ID == gid) { if (setegid(gid) < 0) rb_sys_fail(0); } else { if (gid == 0) { if (setegid(gid) < 0) rb_sys_fail(0); if (setrgid(SAVED_GROUP_ID) < 0) rb_sys_fail(0); SAVED_GROUP_ID = 0; if (setrgid(0) < 0) rb_sys_fail(0); } else { if (setrgid(0) < 0) rb_sys_fail(0); SAVED_GROUP_ID = 0; if (setegid(gid) < 0) rb_sys_fail(0); if (setrgid(gid) < 0) rb_sys_fail(0); SAVED_GROUP_ID = gid; } } } else { if (setegid(gid) < 0) rb_sys_fail(0); if (setrgid(gid) < 0) rb_sys_fail(0); SAVED_GROUP_ID = gid; } #else rb_notimplement(); #endif } else { /* unprivileged user */ #if defined(HAVE_SETRESGID) if (setresgid((getgid() == gid)? (rb_gid_t)-1: gid, (getegid() == gid)? (rb_gid_t)-1: gid, (SAVED_GROUP_ID == gid)? (rb_gid_t)-1: gid) < 0) rb_sys_fail(0); SAVED_GROUP_ID = gid; #elif defined(HAVE_SETREGID) && !defined(OBSOLETE_SETREGID) if (SAVED_GROUP_ID == gid) { if (setregid((getgid() == gid)? (rb_uid_t)-1: gid, (getegid() == gid)? (rb_uid_t)-1: gid) < 0) rb_sys_fail(0); } else if (getgid() != gid) { if (setregid(gid, (getegid() == gid)? (rb_uid_t)-1: gid) < 0) rb_sys_fail(0); SAVED_GROUP_ID = gid; } else if (/* getgid() == gid && */ getegid() != gid) { if (setregid(getegid(), gid) < 0) rb_sys_fail(0); SAVED_GROUP_ID = gid; if (setregid(gid, -1) < 0) rb_sys_fail(0); } else { /* getgid() == gid && getegid() == gid */ if (setregid(-1, SAVED_GROUP_ID) < 0) rb_sys_fail(0); if (setregid(SAVED_GROUP_ID, gid) < 0) rb_sys_fail(0); SAVED_GROUP_ID = gid; if (setregid(gid, -1) < 0) rb_sys_fail(0); } #elif defined(HAVE_SETRGID) && defined(HAVE_SETEGID) if (SAVED_GROUP_ID == gid) { if (getegid() != gid && setegid(gid) < 0) rb_sys_fail(0); if (getgid() != gid && setrgid(gid) < 0) rb_sys_fail(0); } else if (/* SAVED_GROUP_ID != gid && */ getegid() == gid) { if (getgid() != gid) { if (setrgid(gid) < 0) rb_sys_fail(0); SAVED_GROUP_ID = gid; } else { if (setrgid(SAVED_GROUP_ID) < 0) rb_sys_fail(0); SAVED_GROUP_ID = gid; if (setrgid(gid) < 0) rb_sys_fail(0); } } else if (/* getegid() != gid && */ getgid() == gid) { if (setegid(gid) < 0) rb_sys_fail(0); if (setrgid(SAVED_GROUP_ID) < 0) rb_sys_fail(0); SAVED_GROUP_ID = gid; if (setrgid(gid) < 0) rb_sys_fail(0); } else { rb_syserr_fail(EPERM, 0); } #elif defined HAVE_44BSD_SETGID if (getgid() == gid) { /* (r,e,s)==(gid,?,?) ==> (gid,gid,gid) */ if (setgid(gid) < 0) rb_sys_fail(0); SAVED_GROUP_ID = gid; } else { rb_syserr_fail(EPERM, 0); } #elif defined HAVE_SETEGID if (getgid() == gid && SAVED_GROUP_ID == gid) { if (setegid(gid) < 0) rb_sys_fail(0); } else { rb_syserr_fail(EPERM, 0); } #elif defined HAVE_SETGID if (getgid() == gid && SAVED_GROUP_ID == gid) { if (setgid(gid) < 0) rb_sys_fail(0); } else { rb_syserr_fail(EPERM, 0); } #else (void)gid; rb_notimplement(); #endif } return id; };T;)I"static VALUE;T;*To;;T; ;F;;;I""Process::GID.change_privilege;F;@,C;@/C;T;;1;0;@1C;{;IC;"(Change the current process's real and effective group ID to that specified by _group_. Returns the new group ID. Not available on all platforms. [Process.gid, Process.egid] #=> [0, 0] Process::GID.change_privilege(33) #=> 33 [Process.gid, Process.egid] #=> [33, 33];T;[o;= ;3I" overload;F;40;;@;50;)I")Process::GID.change_privilege(group);T;IC;";T; @HC;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @HC;[;I"@return [Integer];T;0;6i;[[I" group;T0; @HC;[;I"mChange the current process's real and effective group ID to that specified by _group_. Returns the new group ID. Not available on all platforms. [Process.gid, Process.egid] #=> [0, 0] Process::GID.change_privilege(33) #=> 33 [Process.gid, Process.egid] #=> [33, 33] @overload Process::GID.change_privilege(group) @return [Integer];T;0; @HC;!F;"o;#;$T;%i¤;&i®;6i;'@dB;(@FC;)@GC;*To;;F; ;;;Ï;I"!Process::GID#grant_privilege;F;[[I"id;T0;[[@P iB;T;;3;0;[;{;IC;"?Set the effective group ID, and if possible, the saved group ID of the process to the given _group_. Returns the new effective group ID. Not available on all platforms. [Process.gid, Process.egid] #=> [0, 0] Process::GID.grant_privilege(31) #=> 33 [Process.gid, Process.egid] #=> [0, 33] ;T; @_C;>0;!F;[o;= ;3I" overload;F;40;:!Process::GID.grant_privilege;50;)I"(Process::GID.grant_privilege(group);T;IC;";T; @_C;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @_C;[;I"@return [Integer];T;0;6i;[[I" group;T0; @_Co;= ;3I" overload;F;40;;;50;)I"Process::GID.eid = group;T;IC;";T; @_C;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @_C;[;I"@return [Integer];T;0;6i;[[I";TI" group;T; @_C;[;I"ºSet the effective group ID, and if possible, the saved group ID of the process to the given _group_. Returns the new effective group ID. Not available on all platforms. [Process.gid, Process.egid] #=> [0, 0] Process::GID.grant_privilege(31) #=> 33 [Process.gid, Process.egid] #=> [0, 33] @overload Process::GID.grant_privilege(group) @return [Integer] @overload Process::GID.eid = group @return [Integer];T;0;'@dB;(I"qstatic VALUE p_gid_grant_privilege(VALUE obj, VALUE id) { rb_setegid_core(OBJ2GID(id)); return id; };T;)I"static VALUE;T;*To;;T; ;F;;;I"!Process::GID.grant_privilege;F;@aC;@dC;T;;3;0;@fC;{;IC;"?Set the effective group ID, and if possible, the saved group ID of the process to the given _group_. Returns the new effective group ID. Not available on all platforms. [Process.gid, Process.egid] #=> [0, 0] Process::GID.grant_privilege(31) #=> 33 [Process.gid, Process.egid] #=> [0, 33];T;[o;= ;3I" overload;F;40;;A;50;)I"(Process::GID.grant_privilege(group);T;IC;";T; @C;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @C;[;I"@return [Integer];T;0;6i;[[I" group;T0; @Co;= ;3I" overload;F;40;;;50;)I"Process::GID.eid = group;T;IC;";T; @C;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @C;[;I"@return [Integer];T;0;6i;[[I";TI" group;T; @C;[;I"ºSet the effective group ID, and if possible, the saved group ID of the process to the given _group_. Returns the new effective group ID. Not available on all platforms. [Process.gid, Process.egid] #=> [0, 0] Process::GID.grant_privilege(31) #=> 33 [Process.gid, Process.egid] #=> [0, 33] @overload Process::GID.grant_privilege(group) @return [Integer] @overload Process::GID.eid = group @return [Integer];T;0; @C;!F;"o;#;$T;%i4;&i@;6i;'@dB;(@‹C;)@ŒC;*To;;F; ;;;Ï;I"Process::GID#re_exchange;F;[;[[@P iª;T;;6;0;[;{;IC;"îExchange real and effective group IDs and return the new effective group ID. Not available on all platforms. [Process.gid, Process.egid] #=> [0, 33] Process::GID.re_exchange #=> 0 [Process.gid, Process.egid] #=> [33, 0] ;T; @´C;>0;!F;[o;= ;3I" overload;F;40;:Process::GID.re_exchange;50;)I"Process::GID.re_exchange;T;IC;";T; @´C;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @´C;[;I"@return [Integer];T;0;6i;[; @´C;[;I"&Exchange real and effective group IDs and return the new effective group ID. Not available on all platforms. [Process.gid, Process.egid] #=> [0, 33] Process::GID.re_exchange #=> 0 [Process.gid, Process.egid] #=> [33, 0] @overload Process::GID.re_exchange @return [Integer];T;0;'@dB;(I"static VALUE p_gid_exchange(VALUE obj) { rb_gid_t gid; #if defined(HAVE_SETRESGID) || (defined(HAVE_SETREGID) && !defined(OBSOLETE_SETREGID)) rb_gid_t egid; #endif check_gid_switch(); gid = getgid(); #if defined(HAVE_SETRESGID) || (defined(HAVE_SETREGID) && !defined(OBSOLETE_SETREGID)) egid = getegid(); #endif #if defined(HAVE_SETRESGID) if (setresgid(egid, gid, gid) < 0) rb_sys_fail(0); SAVED_GROUP_ID = gid; #elif defined(HAVE_SETREGID) && !defined(OBSOLETE_SETREGID) if (setregid(egid,gid) < 0) rb_sys_fail(0); SAVED_GROUP_ID = gid; #else rb_notimplement(); #endif return GIDT2NUM(gid); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::GID.re_exchange;F;@¶C;@·C;T;;6;0;@¹C;{;IC;"îExchange real and effective group IDs and return the new effective group ID. Not available on all platforms. [Process.gid, Process.egid] #=> [0, 33] Process::GID.re_exchange #=> 0 [Process.gid, Process.egid] #=> [33, 0];T;[o;= ;3I" overload;F;40;;B;50;)I"Process::GID.re_exchange;T;IC;";T; @ÎC;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ÎC;[;I"@return [Integer];T;0;6i;[; @ÎC;[;I"'Exchange real and effective group IDs and return the new effective group ID. Not available on all platforms. [Process.gid, Process.egid] #=> [0, 33] Process::GID.re_exchange #=> 0 [Process.gid, Process.egid] #=> [33, 0] @overload Process::GID.re_exchange @return [Integer];T;0; @ÎC;!F;"o;#;$T;%iž;&i§;6i;'@dB;(@ÌC;)@ÍC;*To;;F; ;;;Ï;I""Process::GID#re_exchangeable?;F;[;[[@P i‘;T;;8;0;[;{;IC;"nReturns +true+ if the real and effective group IDs of a process may be exchanged on the current platform. ;T; @ãC;>0;!F;[o;= ;3I" overload;F;40;:"Process::GID.re_exchangeable?;50;)I""Process::GID.re_exchangeable?;T;IC;";T; @ãC;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ãC;[;I"@return [Boolean];T;0;6i;[; @ãC;[;I"¦Returns +true+ if the real and effective group IDs of a process may be exchanged on the current platform. @overload Process::GID.re_exchangeable? @return [Boolean];T;0;'@dB;(I"Èstatic VALUE p_gid_exchangeable(VALUE _) { #if defined(HAVE_SETRESGID) return Qtrue; #elif defined(HAVE_SETREGID) && !defined(OBSOLETE_SETREGID) return Qtrue; #else return Qfalse; #endif };T;)I"static VALUE;T;*To;;T; ;F;;;I""Process::GID.re_exchangeable?;F;@åC;@æC;T;;8;0;@èC;{;IC;"nReturns +true+ if the real and effective group IDs of a process may be exchanged on the current platform.;T;[o;= ;3I" overload;F;40;;C;50;)I""Process::GID.re_exchangeable?;T;IC;";T; @ýC;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ýC;[;I"@return [Boolean];T;0;6i;[; @ýC;[;I"¨Returns +true+ if the real and effective group IDs of a process may be exchanged on the current platform. @overload Process::GID.re_exchangeable? @return [Boolean];T;0; @ýC;!F;"o;#;$T;%iˆ;&iŽ;6i;'@dB;(@ûC;)@üC;*To;;F; ;;;Ï;I" Process::GID#sid_available?;F;[;[[@P iC;T;;:;0;[;{;IC;"MReturns +true+ if the current platform has saved group ID functionality. ;T; @D;>0;!F;[o;= ;3I" overload;F;40;: Process::GID.sid_available?;50;)I" Process::GID.sid_available?;T;IC;";T; @D;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @D;[;I"@return [Boolean];T;0;6i;[; @D;[;I"ƒReturns +true+ if the current platform has saved group ID functionality. @overload Process::GID.sid_available? @return [Boolean];T;0;'@dB;(I"±static VALUE p_gid_have_saved_id(VALUE _) { #if defined(HAVE_SETRESGID) || defined(HAVE_SETEGID) || defined(_POSIX_SAVED_IDS) return Qtrue; #else return Qfalse; #endif };T;)I"static VALUE;T;*To;;T; ;F;;;I" Process::GID.sid_available?;F;@D;@D;T;;:;0;@D;{;IC;"MReturns +true+ if the current platform has saved group ID functionality.;T;[o;= ;3I" overload;F;40;;D;50;)I" Process::GID.sid_available?;T;IC;";T; @,D;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @,D;[;I"@return [Boolean];T;0;6i;[; @,D;[;I"…Returns +true+ if the current platform has saved group ID functionality. @overload Process::GID.sid_available? @return [Boolean];T;0; @,D;!F;"o;#;$T;%i:;&i@;6i;'@dB;(@*D;)@+D;*To;;F; ;;;Ï;I"Process::GID#switch;F;[;[[@P i‘;T;;<;0;[;{;IC;" ;T; @AD;>0;!F;[;[;I";F;0;'@dB;(I"sstatic VALUE p_gid_switch(VALUE obj) { rb_gid_t gid, egid; check_gid_switch(); gid = getgid(); egid = getegid(); if (gid == egid) { rb_syserr_fail(EPERM, 0); } p_gid_exchange(obj); if (rb_block_given_p()) { under_gid_switch = 1; return rb_ensure(rb_yield, Qnil, p_gid_sw_ensure, obj); } else { return GIDT2NUM(egid); } };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::GID.switch;F;@CD;@DD;T;;<;0;@FD;{;IC;";T;[;[;@|;0; @ND;6i;'@dB;(@LD;)@MD;*To;;F; ;;;Ï;I"Process::GID#from_name;F;[[I"id;T0;[[@P iÿ;T;;=;0;[;{;IC;"âGet the group ID by the _name_. If the group is not found, +ArgumentError+ will be raised. Process::GID.from_name("wheel") #=> 0 Process::GID.from_name("nosuchgroup") #=> can't find group for nosuchgroup (ArgumentError) ;T; @TD;>0;!F;[o;= ;3I" overload;F;40;:Process::GID.from_name;50;)I"!Process::GID.from_name(name);T;IC;";T; @TD;>0;!F;[;[;I";T;0;6i;[[I" name;T0; @TD;[;I" Get the group ID by the _name_. If the group is not found, +ArgumentError+ will be raised. Process::GID.from_name("wheel") #=> 0 Process::GID.from_name("nosuchgroup") #=> can't find group for nosuchgroup (ArgumentError) @overload Process::GID.from_name(name) ;T;0;'@dB;(I"]static VALUE p_gid_from_name(VALUE self, VALUE id) { return GIDT2NUM(OBJ2GID(id)); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::GID.from_name;F;@VD;@YD;T;;=;0;@[D;{;IC;"âGet the group ID by the _name_. If the group is not found, +ArgumentError+ will be raised. Process::GID.from_name("wheel") #=> 0 Process::GID.from_name("nosuchgroup") #=> can't find group for nosuchgroup (ArgumentError);T;[o;= ;3I" overload;F;40;;E;50;)I"!Process::GID.from_name(name);T;IC;";T; @mD;>0;!F;[;[;I";T;0;6i;[[I" name;T0; @mD;[;I"Get the group ID by the _name_. If the group is not found, +ArgumentError+ will be raised. Process::GID.from_name("wheel") #=> 0 Process::GID.from_name("nosuchgroup") #=> can't find group for nosuchgroup (ArgumentError) @overload Process::GID.from_name(name);T;0; @mD;!F;"o;#;$T;%iô;&iû;6i;'@dB;(@kD;)@lD;*T;A@dB;BIC;[;A@dB;CIC;[;A@dB;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@P i'#;F;:GID;;K;;;[;{;IC;";T;[;[;@|;0; @dB;6i;'@*;I"Process::GID;Fo; ;IC;[#o;;F; ;;;Ï;I"Process::Sys#getuid;F;[;[[@P i;T;:getuid;0;[;{;IC;"JReturns the (real) user ID of this process. Process.uid #=> 501 ;T; @D;>0;!F;[o;= ;3I" overload;F;40;;þ;50;)I"uid;T;IC;";T; @D;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @D;[;I"@return [Integer];T;0;6i;[; @Do;= ;3I" overload;F;40;;ÿ;50;)I"Process::UID.rid;T;IC;";T; @D;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @D;[;I"@return [Integer];T;0;6i;[; @Do;= ;3I" overload;F;40;;;50;)I"Process::Sys.getuid;T;IC;";T; @D;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @D;[;I"@return [Integer];T;0;6i;[; @D;[;I"ËReturns the (real) user ID of this process. Process.uid #=> 501 @overload uid @return [Integer] @overload Process::UID.rid @return [Integer] @overload Process::Sys.getuid @return [Integer];T;0;'@ŽD;(I"cstatic VALUE proc_getuid(VALUE obj) { rb_uid_t uid = getuid(); return UIDT2NUM(uid); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::Sys.getuid;F;@’D;@“D;T;;G;0;@•D;{;IC;"JReturns the (real) user ID of this process. Process.uid #=> 501;T;[o;= ;3I" overload;F;40;;þ;50;)I"uid;T;IC;";T; @ÄD;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ÄD;[;I"@return [Integer];T;0;6i;[; @ÄDo;= ;3I" overload;F;40;;ÿ;50;)I"Process::UID.rid;T;IC;";T; @ÄD;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ÄD;[;I"@return [Integer];T;0;6i;[; @ÄDo;= ;3I" overload;F;40;;;50;)I"Process::Sys.getuid;T;IC;";T; @ÄD;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ÄD;[;I"@return [Integer];T;0;6i;[; @ÄD;[;@Y;;0; @ÄD;!F;"o;#;$T;%i„;&iŽ;6i;'@ŽD;(@ÂD;)@ÃD;*To;;F; ;;;Ï;I"Process::Sys#geteuid;F;[;[[@P iX;T;:geteuid;0;[;{;IC;"OReturns the effective user ID for this process. Process.euid #=> 501 ;T; @òD;>0;!F;[o;= ;3I" overload;F;40;;;50;)I" euid;T;IC;";T; @òD;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @òD;[;I"@return [Integer];T;0;6i;[; @òDo;= ;3I" overload;F;40;;;50;)I"Process::UID.eid;T;IC;";T; @òD;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @òD;[;I"@return [Integer];T;0;6i;[; @òDo;= ;3I" overload;F;40;;;50;)I"Process::Sys.geteuid;T;IC;";T; @òD;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @òD;[;I"@return [Integer];T;0;6i;[; @òD;[;I"ÒReturns the effective user ID for this process. Process.euid #=> 501 @overload euid @return [Integer] @overload Process::UID.eid @return [Integer] @overload Process::Sys.geteuid @return [Integer];T;0;'@ŽD;(I"gstatic VALUE proc_geteuid(VALUE obj) { rb_uid_t euid = geteuid(); return UIDT2NUM(euid); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::Sys.geteuid;F;@ôD;@õD;T;;H;0;@÷D;{;IC;"OReturns the effective user ID for this process. Process.euid #=> 501;T;[o;= ;3I" overload;F;40;;;50;)I" euid;T;IC;";T; @&E;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @&E;[;I"@return [Integer];T;0;6i;[; @&Eo;= ;3I" overload;F;40;;;50;)I"Process::UID.eid;T;IC;";T; @&E;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @&E;[;I"@return [Integer];T;0;6i;[; @&Eo;= ;3I" overload;F;40;;;50;)I"Process::Sys.geteuid;T;IC;";T; @&E;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @&E;[;I"@return [Integer];T;0;6i;[; @&E;[;@‰<;0; @&E;!F;"o;#;$T;%iM;&iW;6i;'@ŽD;(@$E;)@%E;*To;;F; ;;;Ï;I"Process::Sys#getgid;F;[;[[@P i";T;:getgid;0;[;{;IC;"LReturns the (real) group ID for this process. Process.gid #=> 500 ;T; @TE;>0;!F;[o;= ;3I" overload;F;40;;;50;)I"gid;T;IC;";T; @TE;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @TE;[;I"@return [Integer];T;0;6i;[; @TEo;= ;3I" overload;F;40;;;50;)I"Process::GID.rid;T;IC;";T; @TE;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @TE;[;I"@return [Integer];T;0;6i;[; @TEo;= ;3I" overload;F;40;;;50;)I"Process::Sys.getgid;T;IC;";T; @TE;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @TE;[;I"@return [Integer];T;0;6i;[; @TE;[;I"ÍReturns the (real) group ID for this process. Process.gid #=> 500 @overload gid @return [Integer] @overload Process::GID.rid @return [Integer] @overload Process::Sys.getgid @return [Integer];T;0;'@ŽD;(I"cstatic VALUE proc_getgid(VALUE obj) { rb_gid_t gid = getgid(); return GIDT2NUM(gid); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::Sys.getgid;F;@VE;@WE;T;;I;0;@YE;{;IC;"LReturns the (real) group ID for this process. Process.gid #=> 500;T;[o;= ;3I" overload;F;40;;;50;)I"gid;T;IC;";T; @ˆE;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ˆE;[;I"@return [Integer];T;0;6i;[; @ˆEo;= ;3I" overload;F;40;;;50;)I"Process::GID.rid;T;IC;";T; @ˆE;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ˆE;[;I"@return [Integer];T;0;6i;[; @ˆEo;= ;3I" overload;F;40;;;50;)I"Process::Sys.getgid;T;IC;";T; @ˆE;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ˆE;[;I"@return [Integer];T;0;6i;[; @ˆE;[;@ñ;;0; @ˆE;!F;"o;#;$T;%i;&i!;6i;'@ŽD;(@†E;)@‡E;*To;;F; ;;;Ï;I"Process::Sys#getegid;F;[;[[@P iÔ;T;:getegid;0;[;{;IC;"pReturns the effective group ID for this process. Not available on all platforms. Process.egid #=> 500 ;T; @¶E;>0;!F;[o;= ;3I" overload;F;40;; ;50;)I" egid;T;IC;";T; @¶E;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¶E;[;I"@return [Integer];T;0;6i;[; @¶Eo;= ;3I" overload;F;40;;;50;)I"Process::GID.eid;T;IC;";T; @¶E;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¶E;[;I"@return [Integer];T;0;6i;[; @¶Eo;= ;3I" overload;F;40;;;50;)I"Process::Sys.geteid;T;IC;";T; @¶E;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¶E;[;I"@return [Integer];T;0;6i;[; @¶E;[;I"òReturns the effective group ID for this process. Not available on all platforms. Process.egid #=> 500 @overload egid @return [Integer] @overload Process::GID.eid @return [Integer] @overload Process::Sys.geteid @return [Integer];T;0;'@ŽD;(I"hstatic VALUE proc_getegid(VALUE obj) { rb_gid_t egid = getegid(); return GIDT2NUM(egid); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::Sys.getegid;F;@¸E;@¹E;T;;J;0;@»E;{;IC;"pReturns the effective group ID for this process. Not available on all platforms. Process.egid #=> 500;T;[o;= ;3I" overload;F;40;; ;50;)I" egid;T;IC;";T; @êE;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @êE;[;I"@return [Integer];T;0;6i;[; @êEo;= ;3I" overload;F;40;;;50;)I"Process::GID.eid;T;IC;";T; @êE;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @êE;[;I"@return [Integer];T;0;6i;[; @êEo;= ;3I" overload;F;40;;;50;)I"Process::Sys.geteid;T;IC;";T; @êE;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @êE;[;I"@return [Integer];T;0;6i;[; @êE;[;@=;0; @êE;!F;"o;#;$T;%iÈ;&iÓ;6i;'@ŽD;(@èE;)@éE;*To;;F; ;;;Ï;I"Process::Sys#setuid;F;[[I"id;T0;[[@P i;T;:setuid;0;[;{;IC;"VSet the user ID of the current process to _user_. Not available on all platforms. ;T; @F;>0;!F;[o;= ;3I" overload;F;40;:Process::Sys.setuid;50;)I"Process::Sys.setuid(user);T;IC;";T; @F;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @F;[;I"@return [nil];T;0;6i;[[I" user;T0; @F;[;I"†Set the user ID of the current process to _user_. Not available on all platforms. @overload Process::Sys.setuid(user) @return [nil];T;0;'@ŽD;(I"static VALUE p_sys_setuid(VALUE obj, VALUE id) { check_uid_switch(); if (setuid(OBJ2UID(id)) != 0) rb_sys_fail(0); return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::Sys.setuid;F;@F;@F;T;;K;0;@F;{;IC;"VSet the user ID of the current process to _user_. Not available on all platforms.;T;[o;= ;3I" overload;F;40;;L;50;)I"Process::Sys.setuid(user);T;IC;";T; @6F;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @6F;[;I"@return [nil];T;0;6i;[[I" user;T0; @6F;[;I"ˆSet the user ID of the current process to _user_. Not available on all platforms. @overload Process::Sys.setuid(user) @return [nil];T;0; @6F;!F;"o;#;$T;%i;&i;6i;'@ŽD;(@4F;)@5F;*To;;F; ;;;Ï;I"Process::Sys#setgid;F;[[I"id;T0;[[@P i;T;:setgid;0;[;{;IC;"XSet the group ID of the current process to _group_. Not available on all platforms. ;T; @MF;>0;!F;[o;= ;3I" overload;F;40;:Process::Sys.setgid;50;)I"Process::Sys.setgid(group);T;IC;";T; @MF;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @MF;[;I"@return [nil];T;0;6i;[[I" group;T0; @MF;[;I"‰Set the group ID of the current process to _group_. Not available on all platforms. @overload Process::Sys.setgid(group) @return [nil];T;0;'@ŽD;(I"static VALUE p_sys_setgid(VALUE obj, VALUE id) { check_gid_switch(); if (setgid(OBJ2GID(id)) != 0) rb_sys_fail(0); return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::Sys.setgid;F;@OF;@RF;T;;M;0;@TF;{;IC;"XSet the group ID of the current process to _group_. Not available on all platforms.;T;[o;= ;3I" overload;F;40;;N;50;)I"Process::Sys.setgid(group);T;IC;";T; @kF;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @kF;[;I"@return [nil];T;0;6i;[[I" group;T0; @kF;[;I"‹Set the group ID of the current process to _group_. Not available on all platforms. @overload Process::Sys.setgid(group) @return [nil];T;0; @kF;!F;"o;#;$T;%i„;&iŠ;6i;'@ŽD;(@iF;)@jF;*To;;F; ;;;Ï;I"Process::Sys#setruid;F;[[I"id;T0;[[@P i';T;:setruid;0;[;{;IC;"[Set the real user ID of the calling process to _user_. Not available on all platforms. ;T; @‚F;>0;!F;[o;= ;3I" overload;F;40;:Process::Sys.setruid;50;)I"Process::Sys.setruid(user);T;IC;";T; @‚F;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @‚F;[;I"@return [nil];T;0;6i;[[I" user;T0; @‚F;[;I"ŒSet the real user ID of the calling process to _user_. Not available on all platforms. @overload Process::Sys.setruid(user) @return [nil];T;0;'@ŽD;(I"static VALUE p_sys_setruid(VALUE obj, VALUE id) { check_uid_switch(); if (setruid(OBJ2UID(id)) != 0) rb_sys_fail(0); return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::Sys.setruid;F;@„F;@‡F;T;;O;0;@‰F;{;IC;"[Set the real user ID of the calling process to _user_. Not available on all platforms.;T;[o;= ;3I" overload;F;40;;P;50;)I"Process::Sys.setruid(user);T;IC;";T; @ F;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @ F;[;I"@return [nil];T;0;6i;[[I" user;T0; @ F;[;I"ŽSet the real user ID of the calling process to _user_. Not available on all platforms. @overload Process::Sys.setruid(user) @return [nil];T;0; @ F;!F;"o;#;$T;%i;&i$;6i;'@ŽD;(@žF;)@ŸF;*To;;F; ;;;Ï;I"Process::Sys#setrgid;F;[[I"id;T0;[[@P i£;T;:setrgid;0;[;{;IC;"]Set the real group ID of the calling process to _group_. Not available on all platforms. ;T; @·F;>0;!F;[o;= ;3I" overload;F;40;:Process::Sys.setrgid;50;)I" Process::Sys.setrgid(group);T;IC;";T; @·F;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @·F;[;I"@return [nil];T;0;6i;[[I" group;T0; @·F;[;I"Set the real group ID of the calling process to _group_. Not available on all platforms. @overload Process::Sys.setrgid(group) @return [nil];T;0;'@ŽD;(I"static VALUE p_sys_setrgid(VALUE obj, VALUE id) { check_gid_switch(); if (setrgid(OBJ2GID(id)) != 0) rb_sys_fail(0); return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::Sys.setrgid;F;@¹F;@¼F;T;;Q;0;@¾F;{;IC;"]Set the real group ID of the calling process to _group_. Not available on all platforms.;T;[o;= ;3I" overload;F;40;;R;50;)I" Process::Sys.setrgid(group);T;IC;";T; @ÕF;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @ÕF;[;I"@return [nil];T;0;6i;[[I" group;T0; @ÕF;[;I"‘Set the real group ID of the calling process to _group_. Not available on all platforms. @overload Process::Sys.setrgid(group) @return [nil];T;0; @ÕF;!F;"o;#;$T;%iš;&i ;6i;'@ŽD;(@ÓF;)@ÔF;*To;;F; ;;;Ï;I"Process::Sys#seteuid;F;[[I"id;T0;[[@P i=;T;:seteuid;0;[;{;IC;"aSet the effective user ID of the calling process to _user_. Not available on all platforms. ;T; @ìF;>0;!F;[o;= ;3I" overload;F;40;:Process::Sys.seteuid;50;)I"Process::Sys.seteuid(user);T;IC;";T; @ìF;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @ìF;[;I"@return [nil];T;0;6i;[[I" user;T0; @ìF;[;I"’Set the effective user ID of the calling process to _user_. Not available on all platforms. @overload Process::Sys.seteuid(user) @return [nil];T;0;'@ŽD;(I"static VALUE p_sys_seteuid(VALUE obj, VALUE id) { check_uid_switch(); if (seteuid(OBJ2UID(id)) != 0) rb_sys_fail(0); return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::Sys.seteuid;F;@îF;@ñF;T;;S;0;@óF;{;IC;"aSet the effective user ID of the calling process to _user_. Not available on all platforms.;T;[o;= ;3I" overload;F;40;;T;50;)I"Process::Sys.seteuid(user);T;IC;";T; @ G;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @ G;[;I"@return [nil];T;0;6i;[[I" user;T0; @ G;[;I"”Set the effective user ID of the calling process to _user_. Not available on all platforms. @overload Process::Sys.seteuid(user) @return [nil];T;0; @ G;!F;"o;#;$T;%i4;&i:;6i;'@ŽD;(@G;)@ G;*To;;F; ;;;Ï;I"Process::Sys#setegid;F;[[I"id;T0;[[@P i¹;T;:setegid;0;[;{;IC;"cSet the effective group ID of the calling process to _group_. Not available on all platforms. ;T; @!G;>0;!F;[o;= ;3I" overload;F;40;:Process::Sys.setegid;50;)I" Process::Sys.setegid(group);T;IC;";T; @!G;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @!G;[;I"@return [nil];T;0;6i;[[I" group;T0; @!G;[;I"•Set the effective group ID of the calling process to _group_. Not available on all platforms. @overload Process::Sys.setegid(group) @return [nil];T;0;'@ŽD;(I"static VALUE p_sys_setegid(VALUE obj, VALUE id) { check_gid_switch(); if (setegid(OBJ2GID(id)) != 0) rb_sys_fail(0); return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::Sys.setegid;F;@#G;@&G;T;;U;0;@(G;{;IC;"cSet the effective group ID of the calling process to _group_. Not available on all platforms.;T;[o;= ;3I" overload;F;40;;V;50;)I" Process::Sys.setegid(group);T;IC;";T; @?G;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @?G;[;I"@return [nil];T;0;6i;[[I" group;T0; @?G;[;I"—Set the effective group ID of the calling process to _group_. Not available on all platforms. @overload Process::Sys.setegid(group) @return [nil];T;0; @?G;!F;"o;#;$T;%i°;&i¶;6i;'@ŽD;(@=G;)@>G;*To;;F; ;;;Ï;I"Process::Sys#setreuid;F;[[I"rid;T0[I"eid;T0;[[@P iU;T;: setreuid;0;[;{;IC;"ÏSets the (user) real and/or effective user IDs of the current process to _rid_ and _eid_, respectively. A value of -1 for either means to leave that ID unchanged. Not available on all platforms. ;T; @VG;>0;!F;[o;= ;3I" overload;F;40;:Process::Sys.setreuid;50;)I"$Process::Sys.setreuid(rid, eid);T;IC;";T; @VG;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @VG;[;I"@return [nil];T;0;6i;[[I"rid;T0[I"eid;T0; @VG;[;I" Sets the (user) real and/or effective user IDs of the current process to _rid_ and _eid_, respectively. A value of -1 for either means to leave that ID unchanged. Not available on all platforms. @overload Process::Sys.setreuid(rid, eid) @return [nil];T;0;'@ŽD;(I"static VALUE p_sys_setreuid(VALUE obj, VALUE rid, VALUE eid) { rb_uid_t ruid, euid; PREPARE_GETPWNAM; check_uid_switch(); ruid = OBJ2UID1(rid); euid = OBJ2UID1(eid); FINISH_GETPWNAM; if (setreuid(ruid, euid) != 0) rb_sys_fail(0); return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::Sys.setreuid;F;@XG;@]G;T;;W;0;@_G;{;IC;"ÏSets the (user) real and/or effective user IDs of the current process to _rid_ and _eid_, respectively. A value of -1 for either means to leave that ID unchanged. Not available on all platforms.;T;[o;= ;3I" overload;F;40;;X;50;)I"$Process::Sys.setreuid(rid, eid);T;IC;";T; @xG;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @xG;[;I"@return [nil];T;0;6i;[[I"rid;T0[I"eid;T0; @xG;[;I"Sets the (user) real and/or effective user IDs of the current process to _rid_ and _eid_, respectively. A value of -1 for either means to leave that ID unchanged. Not available on all platforms. @overload Process::Sys.setreuid(rid, eid) @return [nil];T;0; @xG;!F;"o;#;$T;%iJ;&iR;6i;'@ŽD;(@vG;)@wG;*To;;F; ;;;Ï;I"Process::Sys#setregid;F;[[I"rid;T0[I"eid;T0;[[@P iÑ;T;: setregid;0;[;{;IC;"ßSets the (group) real and/or effective group IDs of the current process to rid and eid, respectively. A value of -1 for either means to leave that ID unchanged. Not available on all platforms. ;T; @‘G;>0;!F;[o;= ;3I" overload;F;40;:Process::Sys.setregid;50;)I"$Process::Sys.setregid(rid, eid);T;IC;";T; @‘G;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @‘G;[;I"@return [nil];T;0;6i;[[I"rid;T0[I"eid;T0; @‘G;[;I"Sets the (group) real and/or effective group IDs of the current process to rid and eid, respectively. A value of -1 for either means to leave that ID unchanged. Not available on all platforms. @overload Process::Sys.setregid(rid, eid) @return [nil];T;0;'@ŽD;(I"çstatic VALUE p_sys_setregid(VALUE obj, VALUE rid, VALUE eid) { rb_gid_t rgid, egid; check_gid_switch(); rgid = OBJ2GID(rid); egid = OBJ2GID(eid); if (setregid(rgid, egid) != 0) rb_sys_fail(0); return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::Sys.setregid;F;@“G;@˜G;T;;Y;0;@šG;{;IC;"ßSets the (group) real and/or effective group IDs of the current process to rid and eid, respectively. A value of -1 for either means to leave that ID unchanged. Not available on all platforms.;T;[o;= ;3I" overload;F;40;;Z;50;)I"$Process::Sys.setregid(rid, eid);T;IC;";T; @³G;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @³G;[;I"@return [nil];T;0;6i;[[I"rid;T0[I"eid;T0; @³G;[;I"Sets the (group) real and/or effective group IDs of the current process to rid and eid, respectively. A value of -1 for either means to leave that ID unchanged. Not available on all platforms. @overload Process::Sys.setregid(rid, eid) @return [nil];T;0; @³G;!F;"o;#;$T;%iÆ;&iÎ;6i;'@ŽD;(@±G;)@²G;*To;;F; ;;;Ï;I"Process::Sys#setresuid;F;[[I"rid;T0[I"eid;T0[I"sid;T0;[[@P ir;T;:setresuid;0;[;{;IC;"ÞSets the (user) real, effective, and saved user IDs of the current process to _rid_, _eid_, and _sid_ respectively. A value of -1 for any value means to leave that ID unchanged. Not available on all platforms. ;T; @ÌG;>0;!F;[o;= ;3I" overload;F;40;:Process::Sys.setresuid;50;)I"*Process::Sys.setresuid(rid, eid, sid);T;IC;";T; @ÌG;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @ÌG;[;I"@return [nil];T;0;6i;[[I"rid;T0[I"eid;T0[I"sid;T0; @ÌG;[;I"Sets the (user) real, effective, and saved user IDs of the current process to _rid_, _eid_, and _sid_ respectively. A value of -1 for any value means to leave that ID unchanged. Not available on all platforms. @overload Process::Sys.setresuid(rid, eid, sid) @return [nil];T;0;'@ŽD;(I"Gstatic VALUE p_sys_setresuid(VALUE obj, VALUE rid, VALUE eid, VALUE sid) { rb_uid_t ruid, euid, suid; PREPARE_GETPWNAM; check_uid_switch(); ruid = OBJ2UID1(rid); euid = OBJ2UID1(eid); suid = OBJ2UID1(sid); FINISH_GETPWNAM; if (setresuid(ruid, euid, suid) != 0) rb_sys_fail(0); return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::Sys.setresuid;F;@ÎG;@ÕG;T;;[;0;@×G;{;IC;"ÞSets the (user) real, effective, and saved user IDs of the current process to _rid_, _eid_, and _sid_ respectively. A value of -1 for any value means to leave that ID unchanged. Not available on all platforms.;T;[o;= ;3I" overload;F;40;;\;50;)I"*Process::Sys.setresuid(rid, eid, sid);T;IC;";T; @òG;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @òG;[;I"@return [nil];T;0;6i;[[I"rid;T0[I"eid;T0[I"sid;T0; @òG;[;I"!Sets the (user) real, effective, and saved user IDs of the current process to _rid_, _eid_, and _sid_ respectively. A value of -1 for any value means to leave that ID unchanged. Not available on all platforms. @overload Process::Sys.setresuid(rid, eid, sid) @return [nil];T;0; @òG;!F;"o;#;$T;%ig;&io;6i;'@ŽD;(@ðG;)@ñG;*To;;F; ;;;Ï;I"Process::Sys#setresgid;F;[[I"rid;T0[I"eid;T0[I"sid;T0;[[@P ië;T;:setresgid;0;[;{;IC;"ôSets the (group) real, effective, and saved user IDs of the current process to rid, eid, and sid respectively. A value of -1 for any value means to leave that ID unchanged. Not available on all platforms. ;T; @ H;>0;!F;[o;= ;3I" overload;F;40;:Process::Sys.setresgid;50;)I"*Process::Sys.setresgid(rid, eid, sid);T;IC;";T; @ H;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @ H;[;I"@return [nil];T;0;6i;[[I"rid;T0[I"eid;T0[I"sid;T0; @ H;[;I"5Sets the (group) real, effective, and saved user IDs of the current process to rid, eid, and sid respectively. A value of -1 for any value means to leave that ID unchanged. Not available on all platforms. @overload Process::Sys.setresgid(rid, eid, sid) @return [nil];T;0;'@ŽD;(I"static VALUE p_sys_setresgid(VALUE obj, VALUE rid, VALUE eid, VALUE sid) { rb_gid_t rgid, egid, sgid; check_gid_switch(); rgid = OBJ2GID(rid); egid = OBJ2GID(eid); sgid = OBJ2GID(sid); if (setresgid(rgid, egid, sgid) != 0) rb_sys_fail(0); return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::Sys.setresgid;F;@H;@H;T;;];0;@H;{;IC;"ôSets the (group) real, effective, and saved user IDs of the current process to rid, eid, and sid respectively. A value of -1 for any value means to leave that ID unchanged. Not available on all platforms.;T;[o;= ;3I" overload;F;40;;^;50;)I"*Process::Sys.setresgid(rid, eid, sid);T;IC;";T; @3H;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @3H;[;I"@return [nil];T;0;6i;[[I"rid;T0[I"eid;T0[I"sid;T0; @3H;[;I"7Sets the (group) real, effective, and saved user IDs of the current process to rid, eid, and sid respectively. A value of -1 for any value means to leave that ID unchanged. Not available on all platforms. @overload Process::Sys.setresgid(rid, eid, sid) @return [nil];T;0; @3H;!F;"o;#;$T;%ià;&iè;6i;'@ŽD;(@1H;)@2H;*To;;F; ;;;Ï;I"Process::Sys#issetugid;F;[;[[@P i;T;:issetugid;0;[;{;IC;"Returns +true+ if the process was created as a result of an execve(2) system call which had either of the setuid or setgid bits set (and extra privileges were given as a result) or if it has changed any of its real, effective or saved user or group IDs since it began execution. ;T; @NH;>0;!F;[o;= ;3I" overload;F;40;:Process::Sys.issetugid;50;)I"Process::Sys.issetugid;T;IC;";T; @NH;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @NH;[;I"@return [Boolean];T;0;6i;[; @NH;[;I"LReturns +true+ if the process was created as a result of an execve(2) system call which had either of the setuid or setgid bits set (and extra privileges were given as a result) or if it has changed any of its real, effective or saved user or group IDs since it began execution. @overload Process::Sys.issetugid @return [Boolean];T;0;'@ŽD;(I"}static VALUE p_sys_issetugid(VALUE obj) { if (issetugid()) { return Qtrue; } else { return Qfalse; } };T;)I"static VALUE;T;*To;;T; ;F;;;I"Process::Sys.issetugid;F;@PH;@QH;T;;_;0;@SH;{;IC;"Returns +true+ if the process was created as a result of an execve(2) system call which had either of the setuid or setgid bits set (and extra privileges were given as a result) or if it has changed any of its real, effective or saved user or group IDs since it began execution.;T;[o;= ;3I" overload;F;40;;`;50;)I"Process::Sys.issetugid;T;IC;";T; @hH;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @hH;[;I"@return [Boolean];T;0;6i;[; @hH;[;I"NReturns +true+ if the process was created as a result of an execve(2) system call which had either of the setuid or setgid bits set (and extra privileges were given as a result) or if it has changed any of its real, effective or saved user or group IDs since it began execution. @overload Process::Sys.issetugid @return [Boolean];T;0; @hH;!F;"o;#;$T;%iü;&i;6i;'@ŽD;(@fH;)@gH;*T;A@ŽD;BIC;[;A@ŽD;CIC;[;A@ŽD;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@P iB#;F;:Sys;;K;;;[;{;IC;";T;[;[;@|;0; @ŽD;6i;'@*;I"Process::Sys;F;A@*;BIC;[;A@*;CIC;[;A@*;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@P i×[@P i½!;T;;¡;;K;;;[;{;IC;"êThe module contains several groups of functionality for handling OS processes: * Low-level property introspection and management of the current process, like Process.argv0, Process.pid; * Low-level introspection of other processes, like Process.getpgid, Process.getpriority; * Management of the current process: Process.abort, Process.exit, Process.daemon, etc. (for convenience, most of those are also available as global functions and module functions of Kernel); * Creation and management of child processes: Process.fork, Process.spawn, and related methods; * Management of low-level system clock: Process.times and Process.clock_gettime, which could be important for proper benchmarking and other elapsed time measurement tasks.;T;[;[;I"ì The module contains several groups of functionality for handling OS processes: * Low-level property introspection and management of the current process, like Process.argv0, Process.pid; * Low-level introspection of other processes, like Process.getpgid, Process.getpriority; * Management of the current process: Process.abort, Process.exit, Process.daemon, etc. (for convenience, most of those are also available as global functions and module functions of Kernel); * Creation and management of child processes: Process.fork, Process.spawn, and related methods; * Management of low-level system clock: Process.times and Process.clock_gettime, which could be important for proper benchmarking and other elapsed time measurement tasks. ;T;0; @*;!F;"o;#;$T;%i×;&iå;6i;'@;I"Process;Fo;{;[[@ *i ;F;: ARGV;;};;;[;{;IC;"†ARGV contains the command line arguments used to run ruby. A library like OptionParser can be used to process command-line arguments. ;T;[;[;I"‡ARGV contains the command line arguments used to run ruby. A library like OptionParser can be used to process command-line arguments. ;T;0; @žH;!F;"o;#;$T;%i ;&i ;'@;I" ARGV;F;~I"rb_argv;T@6o; ;IC;[Uo;;F; ;;;;I"Module#autoload;F;[[I"sym;T0[I" file;T0;[[@>iÛ;T;;;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 in the namespace of _mod_. module A end A.autoload(:B, "b") A::B.doit # autoloads "b" ;T;[o;= ;3I" overload;F;40;;;50;)I"autoload(module, filename);T;IC;";T; @¬H;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @¬H;[;I"@return [nil];T;0;6i;[; @¬H;[;I"+Registers _filename_ to be loaded (using Kernel::require) the first time that _module_ (which may be a String or a symbol) is accessed in the namespace of _mod_. module A end A.autoload(:B, "b") A::B.doit # autoloads "b" @overload autoload(module, filename) @return [nil];T;0; @¬H;!F;"o;#;$T;%iÍ;&iØ;'@ªH;(I"¬static VALUE rb_mod_autoload(VALUE mod, VALUE sym, VALUE file) { ID id = rb_to_id(sym); FilePathValue(file); rb_autoload_str(mod, id, file); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#autoload?;F;[[@c0;[[@>iÿ;T;;;0;[;{;IC;"èReturns _filename_ to be loaded if _name_ is registered as +autoload+ in the namespace of _mod_ or one of its ancestors. module A end A.autoload(:B, "b") A.autoload?(:B) #=> "b" If +inherit+ is false, the lookup only checks the autoloads in the receiver: class A autoload :CONST, "const.rb" end class B < A end B.autoload?(:CONST) #=> "const.rb", found in A (ancestor) B.autoload?(:CONST, false) #=> nil, not found in B itself;T;[o;= ;3I" overload;F;40;;;50;)I""autoload?(name, inherit=true);T;IC;";T; @ËH;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @ËH;[;I"@return [String, nil];T;0;6i;[[I" name;T0[I"inherit;TI" true;T; @ËH;[;I"+Returns _filename_ to be loaded if _name_ is registered as +autoload+ in the namespace of _mod_ or one of its ancestors. module A end A.autoload(:B, "b") A.autoload?(:B) #=> "b" If +inherit+ is false, the lookup only checks the autoloads in the receiver: class A autoload :CONST, "const.rb" end class B < A end B.autoload?(:CONST) #=> "const.rb", found in A (ancestor) B.autoload?(:CONST, false) #=> nil, not found in B itself @overload autoload?(name, inherit=true) @return [String, nil];T;0; @ËH;!F;"o;#;$T;%iå;&iü;6i;'@ªH;(I"static VALUE rb_mod_autoload_p(int argc, VALUE *argv, VALUE mod) { int recur = (rb_check_arity(argc, 1, 2) == 1) ? TRUE : RTEST(argv[1]); VALUE sym = argv[0]; ID id = rb_check_id(&sym); if (!id) { return Qnil; } return rb_autoload_at_p(mod, id, recur); };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#include;F;[[@c0;[[@fi";T;:include;0;[;{;IC;"GInvokes Module.append_features on each parameter in reverse order. ;T;[o;= ;3I" overload;F;40;;c;50;)I"include(module, ...);T;IC;";T; @íH;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @íH;[;I"@return [self];T;0;6i;[; @íH;[;I"yInvokes Module.append_features on each parameter in reverse order. @overload include(module, ...) @return [self];T;0; @íH;!F;"o;#;$T;%i;&i;'@ªH;(I"Ýstatic VALUE rb_mod_include(int argc, VALUE *argv, VALUE module) { int i; ID id_append_features, id_included; CONST_ID(id_append_features, "append_features"); CONST_ID(id_included, "included"); 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_append_features, 1, module); rb_funcall(argv[argc], id_included, 1, module); } return module; };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#prepend;F;[[@c0;[[@fiS;T;:prepend;0;[;{;IC;"HInvokes Module.prepend_features on each parameter in reverse order. ;T;[o;= ;3I" overload;F;40;;d;50;)I"prepend(module, ...);T;IC;";T; @ I;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @ I;[;I"@return [self];T;0;6i;[; @ I;[;I"zInvokes Module.prepend_features on each parameter in reverse order. @overload prepend(module, ...) @return [self];T;0; @ I;!F;"o;#;$T;%iL;&iP;'@ªH;(I"åstatic VALUE rb_mod_prepend(int argc, VALUE *argv, VALUE module) { int i; ID id_prepend_features, id_prepended; CONST_ID(id_prepend_features, "prepend_features"); CONST_ID(id_prepended, "prepended"); 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_prepend_features, 1, module); rb_funcall(argv[argc], id_prepended, 1, module); } return module; };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Module#append_features;F;[[I"include;T0;[[@fi;T;:append_features;0;[;{;IC;"PWhen this module is included in another, Ruby calls #append_features in this module, passing it the receiving module in _mod_. Ruby's default implementation is to add the constants, methods, and module variables of this module to _mod_ if this module has not already been added to _mod_ or one of its ancestors. See also Module#include. ;T;[o;= ;3I" overload;F;40;;e;50;)I"append_features(mod);T;IC;";T; @%I;>0;!F;[;[;I";T;0;6i;[[I"mod;T0; @%I;[;I"qWhen this module is included in another, Ruby calls #append_features in this module, passing it the receiving module in _mod_. Ruby's default implementation is to add the constants, methods, and module variables of this module to _mod_ if this module has not already been added to _mod_ or one of its ancestors. See also Module#include. @overload append_features(mod);T;0; @%I;!F;"o;#;$T;%i;&i;'@ªH;(I"Ìstatic VALUE rb_mod_append_features(VALUE module, VALUE include) { if (!CLASS_OR_MODULE_P(include)) { Check_Type(include, T_CLASS); } rb_include_module(include, module); return module; };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Module#extend_object;F;[[I"obj;T0;[[@fiâ;T;:extend_object;0;[;{;IC;"#Extends the specified object by adding this module's constants and methods (which are added as singleton methods). This is the callback method used by Object#extend. module Picky def Picky.extend_object(o) if String === o puts "Can't add Picky to a String" else puts "Picky added to #{o.class}" super end end end (s = Array.new).extend Picky # Call Object.extend (s = "quick brown fox").extend Picky produces: Picky added to Array Can't add Picky to a String ;T;[o;= ;3I" overload;F;40;;f;50;)I"extend_object(obj);T;IC;";T; @?I;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @?I;[;I"@return [Object];T;0;6i;[[I"obj;T0; @?I;[;I"UExtends the specified object by adding this module's constants and methods (which are added as singleton methods). This is the callback method used by Object#extend. module Picky def Picky.extend_object(o) if String === o puts "Can't add Picky to a String" else puts "Picky added to #{o.class}" super end end end (s = Array.new).extend Picky # Call Object.extend (s = "quick brown fox").extend Picky produces: Picky added to Array Can't add Picky to a String @overload extend_object(obj) @return [Object];T;0; @?I;!F;"o;#;$T;%iÇ;&iß;'@ªH;(I"pstatic VALUE rb_mod_extend_object(VALUE mod, VALUE obj) { rb_extend_object(obj, mod); return obj; };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Module#prepend_features;F;[[I"prepend;T0;[[@fiA;T;:prepend_features;0;[;{;IC;"VWhen this module is prepended in another, Ruby calls #prepend_features in this module, passing it the receiving module in _mod_. Ruby's default implementation is to overlay the constants, methods, and module variables of this module to _mod_ if this module has not already been added to _mod_ or one of its ancestors. See also Module#prepend. ;T;[o;= ;3I" overload;F;40;;g;50;)I"prepend_features(mod);T;IC;";T; @^I;>0;!F;[;[;I";T;0;6i;[[I"mod;T0; @^I;[;I"xWhen this module is prepended in another, Ruby calls #prepend_features in this module, passing it the receiving module in _mod_. Ruby's default implementation is to overlay the constants, methods, and module variables of this module to _mod_ if this module has not already been added to _mod_ or one of its ancestors. See also Module#prepend. @overload prepend_features(mod);T;0; @^I;!F;"o;#;$T;%i5;&i=;'@ªH;(I"Ístatic VALUE rb_mod_prepend_features(VALUE module, VALUE prepend) { if (!CLASS_OR_MODULE_P(prepend)) { Check_Type(prepend, T_CLASS); } rb_prepend_module(prepend, module); return module; };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Module#refine;F;[[I" klass;T0;[[@fi;T;:refine;0;[;{;IC;"]Refine mod in the receiver. Returns a module, where refined methods are defined. ;T;[o;= ;3I" overload;F;40;;h;50;)I"refine(mod);T;IC;";T; @xI;>0;!F;[o;2 ;3I" yield;F;4I"[];T;0;50; @xI;[;I"@yield [];T;0;6i;[[I"mod;T0; @xI;[;I"|Refine mod in the receiver. Returns a module, where refined methods are defined. @overload refine(mod) @yield [];T;0; @xI;!F;"o;#;$T;%i;&i;'@ªH;(I"static VALUE rb_mod_refine(VALUE module, VALUE klass) { VALUE refinement; ID id_refinements, id_activated_refinements, id_refined_class, id_defined_at; VALUE refinements, activated_refinements; rb_thread_t *th = GET_THREAD(); VALUE block_handler = rb_vm_frame_block_handler(th->ec->cfp); if (block_handler == VM_BLOCK_HANDLER_NONE) { rb_raise(rb_eArgError, "no block given"); } if (vm_block_handler_type(block_handler) != block_handler_type_iseq) { rb_raise(rb_eArgError, "can't pass a Proc as a block to Module#refine"); } ensure_class_or_module(klass); CONST_ID(id_refinements, "__refinements__"); refinements = rb_attr_get(module, id_refinements); if (NIL_P(refinements)) { refinements = hidden_identity_hash_new(); rb_ivar_set(module, id_refinements, refinements); } CONST_ID(id_activated_refinements, "__activated_refinements__"); activated_refinements = rb_attr_get(module, id_activated_refinements); if (NIL_P(activated_refinements)) { activated_refinements = hidden_identity_hash_new(); rb_ivar_set(module, id_activated_refinements, activated_refinements); } refinement = rb_hash_lookup(refinements, klass); if (NIL_P(refinement)) { VALUE superclass = refinement_superclass(klass); refinement = rb_module_new(); RCLASS_SET_SUPER(refinement, superclass); FL_SET(refinement, RMODULE_IS_REFINEMENT); CONST_ID(id_refined_class, "__refined_class__"); rb_ivar_set(refinement, id_refined_class, klass); CONST_ID(id_defined_at, "__defined_at__"); rb_ivar_set(refinement, id_defined_at, module); rb_hash_aset(refinements, klass, refinement); add_activated_refinement(activated_refinements, klass, refinement); } rb_yield_refine_block(refinement, activated_refinements); return refinement; };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Module#using;F;[[I"module;T0;[[@fi[;T;: using;0;[;{;IC;"]Import class refinements from module into the current class or module definition. ;T;[o;= ;3I" overload;F;40;;i;50;)I"using(module);T;IC;";T; @•I;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @•I;[;I"@return [self];T;0;6i;[; @•I;[;I"ƒImport class refinements from module into the current class or module definition. @overload using(module) @return [self];T;0; @•I;!F;"o;#;$T;%iS;&iX;'@ªH;(I"østatic VALUE mod_using(VALUE self, VALUE module) { rb_control_frame_t *prev_cfp = previous_frame(GET_EC()); if (prev_frame_func()) { rb_raise(rb_eRuntimeError, "Module#using is not permitted in methods"); } if (prev_cfp && prev_cfp->self != self) { rb_raise(rb_eRuntimeError, "Module#using is not called on self"); } if (rb_block_given_p()) { ignored_block(module, "Module#"); } rb_using_module(rb_vm_cref_replace_with_duplicated_cref(), module); return self; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Module.used_modules;F;[;[[@fi“;T;:used_modules;0;[;{;IC;".Returns an array of all modules used in the current scope. The ordering of modules in the resulting array is not defined. module A refine Object do end end module B refine Object do end end using A using B p Module.used_modules produces: [B, A] ;T;[o;= ;3I" overload;F;40;;j;50;)I"used_modules;T;IC;";T; @²I;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @²I;[;I"@return [Array];T;0;6i;[; @²I;[;I"YReturns an array of all modules used in the current scope. The ordering of modules in the resulting array is not defined. module A refine Object do end end module B refine Object do end end using A using B p Module.used_modules produces: [B, A] @overload used_modules @return [Array];T;0; @²I;!F;"o;#;$T;%iz;&i‘;'@ªH;(I"Jstatic VALUE rb_mod_s_used_modules(VALUE _) { const rb_cref_t *cref = rb_vm_cref(); VALUE ary = rb_ary_new(); while (cref) { if (!NIL_P(CREF_REFINEMENTS(cref))) { rb_hash_foreach(CREF_REFINEMENTS(cref), used_modules_i, ary); } cref = CREF_NEXT(cref); } return rb_funcall(ary, rb_intern("uniq"), 0); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Module.nesting;F;[;[[@fi‘;T;:nesting;0;[;{;IC;"ÀReturns the list of +Modules+ nested at the point of call. module M1 module M2 $a = Module.nesting end end $a #=> [M1::M2, M1] $a[0].name #=> "M1::M2" ;T;[o;= ;3I" overload;F;40;;k;50;)I"nesting;T;IC;";T; @ÍI;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ÍI;[;I"@return [Array];T;0;6i;[; @ÍI;[;I"æReturns the list of +Modules+ nested at the point of call. module M1 module M2 $a = Module.nesting end end $a #=> [M1::M2, M1] $a[0].name #=> "M1::M2" @overload nesting @return [Array];T;0; @ÍI;!F;"o;#;$T;%i‚;&iŽ;'@ªH;(I"Astatic VALUE rb_mod_nesting(VALUE _) { VALUE ary = rb_ary_new(); const rb_cref_t *cref = rb_vm_cref(); while (cref && CREF_NEXT(cref)) { VALUE klass = CREF_CLASS(cref); if (!CREF_PUSHED_BY_EVAL(cref) && !NIL_P(klass)) { rb_ary_push(ary, klass); } cref = CREF_NEXT(cref); } return ary; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Module.constants;F;[[@c0;[[@fi¸;T;:constants;0;[;{;IC;"¿In the first form, returns an array of the names of all constants accessible from the point of call. This list includes the names of all modules and classes defined in the global scope. Module.constants.first(4) # => [:ARGF, :ARGV, :ArgumentError, :Array] Module.constants.include?(:SEEK_SET) # => false class IO Module.constants.include?(:SEEK_SET) # => true end The second form calls the instance method +constants+. ;T;[o;= ;3I" overload;F;40;;l;50;)I"constants;T;IC;";T; @èI;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @èI;[;I"@return [Array];T;0;6i;[; @èIo;= ;3I" overload;F;40;;l;50;)I"constants(inherited);T;IC;";T; @èI;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @èI;[;I"@return [Array];T;0;6i;[[I"inherited;T0; @èI;[;I"In the first form, returns an array of the names of all constants accessible from the point of call. This list includes the names of all modules and classes defined in the global scope. Module.constants.first(4) # => [:ARGF, :ARGV, :ArgumentError, :Array] Module.constants.include?(:SEEK_SET) # => false class IO Module.constants.include?(:SEEK_SET) # => true end The second form calls the instance method +constants+. @overload constants @return [Array] @overload constants(inherited) @return [Array];T;0; @èI;!F;"o;#;$T;%i¢;&i¶;'@ªH;(I"Lstatic VALUE rb_mod_s_constants(int argc, VALUE *argv, VALUE mod) { const rb_cref_t *cref = rb_vm_cref(); VALUE klass; VALUE cbase = 0; void *data = 0; if (argc > 0 || mod != rb_cModule) { return rb_mod_constants(argc, argv, mod); } while (cref) { klass = CREF_CLASS(cref); if (!CREF_PUSHED_BY_EVAL(cref) && !NIL_P(klass)) { data = rb_mod_const_at(CREF_CLASS(cref), data); if (!cbase) { cbase = klass; } } cref = CREF_NEXT(cref); } if (cbase) { data = rb_mod_const_of(cbase, data); } return rb_const_list(data); };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#remove_method;F;[[@c0;[[@ƒi\;T;:remove_method;0;[;{;IC;"•Removes the method identified by _symbol_ from the current class. For an example, see Module#undef_method. String arguments are converted to symbols. ;T;[o;= ;3I" overload;F;40;;m;50;)I"remove_method(symbol);T;IC;";T; @J;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @J;[;I"@return [self];T;0;6i;[[I"symbol;T0; @Jo;= ;3I" overload;F;40;;m;50;)I"remove_method(string);T;IC;";T; @J;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @J;[;I"@return [self];T;0;6i;[[I"string;T0; @J;[;I"ùRemoves the method identified by _symbol_ from the current class. For an example, see Module#undef_method. String arguments are converted to symbols. @overload remove_method(symbol) @return [self] @overload remove_method(string) @return [self];T;0; @J;!F;"o;#;$T;%iR;&iZ;'@ªH;(I".static VALUE rb_mod_remove_method(int argc, VALUE *argv, VALUE mod) { int i; for (i = 0; i < argc; i++) { VALUE v = argv[i]; ID id = rb_check_id(&v); if (!id) { rb_name_err_raise("method `%1$s' not defined in %2$s", mod, v); } remove_method(mod, id); } return mod; };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#undef_method;F;[[@c0;[[@ƒiQ;T;:undef_method;0;[;{;IC;"Prevents the current class from responding to calls to the named method. Contrast this with remove_method, which deletes the method from the particular class; Ruby will still search superclasses and mixed-in modules for a possible receiver. String arguments are converted to symbols. class Parent def hello puts "In parent" end end class Child < Parent def hello puts "In child" end end c = Child.new c.hello class Child remove_method :hello # remove from child, still in parent end c.hello class Child undef_method :hello # prevent any calls to 'hello' end c.hello produces: In child In parent prog.rb:23: undefined method `hello' for # (NoMethodError) ;T;[o;= ;3I" overload;F;40;;n;50;)I"undef_method(symbol);T;IC;";T; @@J;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @@J;[;I"@return [self];T;0;6i;[[I"symbol;T0; @@Jo;= ;3I" overload;F;40;;n;50;)I"undef_method(string);T;IC;";T; @@J;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @@J;[;I"@return [self];T;0;6i;[[I"string;T0; @@J;[;I"|Prevents the current class from responding to calls to the named method. Contrast this with remove_method, which deletes the method from the particular class; Ruby will still search superclasses and mixed-in modules for a possible receiver. String arguments are converted to symbols. class Parent def hello puts "In parent" end end class Child < Parent def hello puts "In child" end end c = Child.new c.hello class Child remove_method :hello # remove from child, still in parent end c.hello class Child undef_method :hello # prevent any calls to 'hello' end c.hello produces: In child In parent prog.rb:23: undefined method `hello' for # (NoMethodError) @overload undef_method(symbol) @return [self] @overload undef_method(string) @return [self];T;0; @@J;!F;"o;#;$T;%i$;&iO;'@ªH;(I"üstatic VALUE rb_mod_undef_method(int argc, VALUE *argv, VALUE mod) { int i; for (i = 0; i < argc; i++) { VALUE v = argv[i]; ID id = rb_check_id(&v); if (!id) { rb_method_name_error(mod, v); } rb_undef(mod, id); } return mod; };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#alias_method;F;[[I"newname;T0[I"oldname;T0;[[@ƒiÑ;T;:alias_method;0;[;{;IC;"pMakes new_name a new copy of the method old_name. This can be used to retain access to methods that are overridden. module Mod alias_method :orig_exit, :exit #=> :orig_exit def exit(code=0) puts "Exiting with code #{code}" orig_exit(code) end end include Mod exit(99) produces: Exiting with code 99 ;T;[o;= ;3I" overload;F;40;;o;50;)I"%alias_method(new_name, old_name);T;IC;";T; @mJ;>0;!F;[;[;I";T;0;6i;[[I" new_name;T0[I" old_name;T0; @mJ;[;I"Makes new_name a new copy of the method old_name. This can be used to retain access to methods that are overridden. module Mod alias_method :orig_exit, :exit #=> :orig_exit def exit(code=0) puts "Exiting with code #{code}" orig_exit(code) end end include Mod exit(99) produces: Exiting with code 99 @overload alias_method(new_name, old_name);T;0; @mJ;!F;"o;#;$T;%i»;&iÍ;'@ªH;(I"static VALUE rb_mod_alias_method(VALUE mod, VALUE newname, VALUE oldname) { ID oldid = rb_check_id(&oldname); if (!oldid) { rb_print_undef_str(mod, oldname); } VALUE id = rb_to_id(newname); rb_alias(mod, id, oldid); return ID2SYM(id); };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Module#public;F;[[@c0;[[@ƒi;T;;;0;[;{;IC;"ýWith no arguments, sets the default visibility for subsequently defined methods to public. With arguments, sets the named methods to have public visibility. String arguments are converted to symbols. An Array of Symbols and/or Strings are also accepted. ;T;[ o;= ;3I" overload;F;40;;;50;)I"public;T;IC;";T; @‹J;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @‹J;[;I"@return [self];T;0;6i;[; @‹Jo;= ;3I" overload;F;40;;;50;)I"public(symbol, ...);T;IC;";T; @‹J;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @‹J;[;I"@return [self];T;0;6i;[[I"symbol;T0[I"...;T0; @‹Jo;= ;3I" overload;F;40;;;50;)I"public(string, ...);T;IC;";T; @‹J;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @‹J;[;I"@return [self];T;0;6i;[[I"string;T0[I"...;T0; @‹Jo;= ;3I" overload;F;40;;;50;)I"public(array);T;IC;";T; @‹J;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @‹J;[;I"@return [self];T;0;6i;[[I" array;T0; @‹J;[;I"¨With no arguments, sets the default visibility for subsequently defined methods to public. With arguments, sets the named methods to have public visibility. String arguments are converted to symbols. An Array of Symbols and/or Strings are also accepted. @overload public @return [self] @overload public(symbol, ...) @return [self] @overload public(string, ...) @return [self] @overload public(array) @return [self];T;0; @‹J;!F;"o;#;$T;%i;&i;'@ªH;(I"†static VALUE rb_mod_public(int argc, VALUE *argv, VALUE module) { return set_visibility(argc, argv, module, METHOD_VISI_PUBLIC); };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Module#protected;F;[[@c0;[[@ƒi;;T;:protected;0;[;{;IC;" With no arguments, sets the default visibility for subsequently defined methods to protected. With arguments, sets the named methods to have protected visibility. String arguments are converted to symbols. An Array of Symbols and/or Strings are also accepted. If a method has protected visibility, it is callable only where self of the context is the same as the method. (method definition or instance_eval). This behavior is different from Java's protected method. Usually private should be used. Note that a protected method is slow because it can't use inline cache. To show a private method on RDoc, use :doc: instead of this. ;T;[ o;= ;3I" overload;F;40;;p;50;)I"protected;T;IC;";T; @ØJ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @ØJ;[;I"@return [self];T;0;6i;[; @ØJo;= ;3I" overload;F;40;;p;50;)I"protected(symbol, ...);T;IC;";T; @ØJ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @ØJ;[;I"@return [self];T;0;6i;[[I"symbol;T0[I"...;T0; @ØJo;= ;3I" overload;F;40;;p;50;)I"protected(string, ...);T;IC;";T; @ØJ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @ØJ;[;I"@return [self];T;0;6i;[[I"string;T0[I"...;T0; @ØJo;= ;3I" overload;F;40;;p;50;)I"protected(array);T;IC;";T; @ØJ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @ØJ;[;I"@return [self];T;0;6i;[[I" array;T0; @ØJ;[;I"WWith no arguments, sets the default visibility for subsequently defined methods to protected. With arguments, sets the named methods to have protected visibility. String arguments are converted to symbols. An Array of Symbols and/or Strings are also accepted. If a method has protected visibility, it is callable only where self of the context is the same as the method. (method definition or instance_eval). This behavior is different from Java's protected method. Usually private should be used. Note that a protected method is slow because it can't use inline cache. To show a private method on RDoc, use :doc: instead of this. @overload protected @return [self] @overload protected(symbol, ...) @return [self] @overload protected(string, ...) @return [self] @overload protected(array) @return [self];T;0; @ØJ;!F;"o;#;$T;%i$;&i;;'@ªH;(I"Œstatic VALUE rb_mod_protected(int argc, VALUE *argv, VALUE module) { return set_visibility(argc, argv, module, METHOD_VISI_PROTECTED); };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Module#private;F;[[@c0;[[@ƒiZ;T;;Ï;0;[;{;IC;"ÜWith no arguments, sets the default visibility for subsequently defined methods to private. With arguments, sets the named methods to have private visibility. String arguments are converted to symbols. An Array of Symbols and/or Strings are also accepted. module Mod def a() end def b() end private def c() end private :a end Mod.private_instance_methods #=> [:a, :c] Note that to show a private method on RDoc, use :doc:. ;T;[ o;= ;3I" overload;F;40;;Ï;50;)I"private;T;IC;";T; @%K;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @%K;[;I"@return [self];T;0;6i;[; @%Ko;= ;3I" overload;F;40;;Ï;50;)I"private(symbol, ...);T;IC;";T; @%K;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @%K;[;I"@return [self];T;0;6i;[[I"symbol;T0[I"...;T0; @%Ko;= ;3I" overload;F;40;;Ï;50;)I"private(string, ...);T;IC;";T; @%K;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @%K;[;I"@return [self];T;0;6i;[[I"string;T0[I"...;T0; @%Ko;= ;3I" overload;F;40;;Ï;50;)I"private(array);T;IC;";T; @%K;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @%K;[;I"@return [self];T;0;6i;[[I" array;T0; @%K;[;I"‹With no arguments, sets the default visibility for subsequently defined methods to private. With arguments, sets the named methods to have private visibility. String arguments are converted to symbols. An Array of Symbols and/or Strings are also accepted. module Mod def a() end def b() end private def c() end private :a end Mod.private_instance_methods #=> [:a, :c] Note that to show a private method on RDoc, use :doc:. @overload private @return [self] @overload private(symbol, ...) @return [self] @overload private(string, ...) @return [self] @overload private(array) @return [self];T;0; @%K;!F;"o;#;$T;%iA;&iZ;'@ªH;(I"ˆstatic VALUE rb_mod_private(int argc, VALUE *argv, VALUE module) { return set_visibility(argc, argv, module, METHOD_VISI_PRIVATE); };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Module#module_function;F;[[@c0;[[@ƒiX ;T;:module_function;0;[;{;IC;"CCreates module functions for the named methods. These functions may be called with the module as a receiver, and also become available as instance methods to classes that mix in the module. Module functions are copies of the original, and so may be changed independently. The instance-method versions are made private. If used with no arguments, subsequently defined methods become module functions. String arguments are converted to symbols. module Mod def one "This is one" end module_function :one end class Cls include Mod def call_one one end end Mod.one #=> "This is one" c = Cls.new c.call_one #=> "This is one" module Mod def one "This is the new one" end end Mod.one #=> "This is one" c.call_one #=> "This is the new one" ;T;[o;= ;3I" overload;F;40;;q;50;)I"!module_function(symbol, ...);T;IC;";T; @rK;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @rK;[;I"@return [self];T;0;6i;[[I"symbol;T0[I"...;T0; @rKo;= ;3I" overload;F;40;;q;50;)I"!module_function(string, ...);T;IC;";T; @rK;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @rK;[;I"@return [self];T;0;6i;[[I"string;T0[I"...;T0; @rK;[;I"µCreates module functions for the named methods. These functions may be called with the module as a receiver, and also become available as instance methods to classes that mix in the module. Module functions are copies of the original, and so may be changed independently. The instance-method versions are made private. If used with no arguments, subsequently defined methods become module functions. String arguments are converted to symbols. module Mod def one "This is one" end module_function :one end class Cls include Mod def call_one one end end Mod.one #=> "This is one" c = Cls.new c.call_one #=> "This is one" module Mod def one "This is the new one" end end Mod.one #=> "This is one" c.call_one #=> "This is the new one" @overload module_function(symbol, ...) @return [self] @overload module_function(string, ...) @return [self];T;0; @rK;!F;"o;#;$T;%i2 ;&iV ;'@ªH;(I"³static VALUE rb_mod_modfunc(int argc, VALUE *argv, VALUE module) { int i; ID id; const rb_method_entry_t *me; if (!RB_TYPE_P(module, T_MODULE)) { rb_raise(rb_eTypeError, "module_function must be called for modules"); } if (argc == 0) { rb_scope_module_func_set(); return module; } set_method_visibility(module, argc, argv, METHOD_VISI_PRIVATE); for (i = 0; i < argc; i++) { VALUE m = module; id = rb_to_id(argv[i]); for (;;) { me = search_method(m, id, 0); if (me == 0) { me = search_method(rb_cObject, id, 0); } if (UNDEFINED_METHOD_ENTRY_P(me)) { rb_print_undef(module, id, METHOD_VISI_UNDEF); } if (me->def->type != VM_METHOD_TYPE_ZSUPER) { break; /* normal case: need not to follow 'super' link */ } m = RCLASS_SUPER(m); if (!m) break; } rb_method_entry_set(rb_singleton_class(module), id, me, METHOD_VISI_PUBLIC); } return module; };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Module#ruby2_keywords;F;[[@c0;[[@ƒi;T;:ruby2_keywords;0;[;{;IC;"For the given method names, marks the method as passing keywords through a normal argument splat. This should only be called on methods that accept an argument splat (*args) but not explicit keywords or a keyword splat. It marks the method such that if the method is called with keyword arguments, the final hash argument is marked with a special flag such that if it is the final element of a normal argument splat to another method call, and that method call does not include explicit keywords or a keyword splat, the final element is interpreted as keywords. In other words, keywords will be passed through the method to other methods. This should only be used for methods that delegate keywords to another method, and only for backwards compatibility with Ruby versions before 2.7. This method will probably be removed at some point, as it exists only for backwards compatibility. As it does not exist in Ruby versions before 2.7, check that the module responds to this method before calling it. Also, be aware that if this method is removed, the behavior of the method will change so that it does not pass through keywords. module Mod def foo(meth, *args, &block) send(:"do_#{meth}", *args, &block) end ruby2_keywords(:foo) if respond_to?(:ruby2_keywords, true) end ;T;[o;= ;3I" overload;F;40;;r;50;)I"%ruby2_keywords(method_name, ...);T;IC;";T; @£K;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @£K;[;I"@return [nil];T;0;6i;[[I"method_name;T0[I"...;T0; @£K;[;I"WFor the given method names, marks the method as passing keywords through a normal argument splat. This should only be called on methods that accept an argument splat (*args) but not explicit keywords or a keyword splat. It marks the method such that if the method is called with keyword arguments, the final hash argument is marked with a special flag such that if it is the final element of a normal argument splat to another method call, and that method call does not include explicit keywords or a keyword splat, the final element is interpreted as keywords. In other words, keywords will be passed through the method to other methods. This should only be used for methods that delegate keywords to another method, and only for backwards compatibility with Ruby versions before 2.7. This method will probably be removed at some point, as it exists only for backwards compatibility. As it does not exist in Ruby versions before 2.7, check that the module responds to this method before calling it. Also, be aware that if this method is removed, the behavior of the method will change so that it does not pass through keywords. module Mod def foo(meth, *args, &block) send(:"do_#{meth}", *args, &block) end ruby2_keywords(:foo) if respond_to?(:ruby2_keywords, true) end @overload ruby2_keywords(method_name, ...) @return [nil];T;0; @£K;!F;"o;#;$T;%i`;&i~;'@ªH;(I":static VALUE rb_mod_ruby2_keywords(int argc, VALUE *argv, VALUE module) { int i; VALUE origin_class = RCLASS_ORIGIN(module); rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS); rb_check_frozen(module); for (i = 0; i < argc; i++) { VALUE v = argv[i]; ID name = rb_check_id(&v); rb_method_entry_t *me; VALUE defined_class; if (!name) { rb_print_undef_str(module, v); } me = search_method(origin_class, name, &defined_class); if (!me && RB_TYPE_P(module, T_MODULE)) { me = search_method(rb_cObject, name, &defined_class); } if (UNDEFINED_METHOD_ENTRY_P(me) || UNDEFINED_REFINED_METHOD_P(me->def)) { rb_print_undef(module, name, METHOD_VISI_UNDEF); } if (module == defined_class || origin_class == defined_class) { switch (me->def->type) { case VM_METHOD_TYPE_ISEQ: if (me->def->body.iseq.iseqptr->body->param.flags.has_rest && !me->def->body.iseq.iseqptr->body->param.flags.has_kw && !me->def->body.iseq.iseqptr->body->param.flags.has_kwrest) { me->def->body.iseq.iseqptr->body->param.flags.ruby2_keywords = 1; rb_clear_method_cache(module, name); } else { rb_warn("Skipping set of ruby2_keywords flag for %s (method accepts keywords or method does not accept argument splat)", rb_id2name(name)); } break; case VM_METHOD_TYPE_BMETHOD: { VALUE procval = me->def->body.bmethod.proc; if (vm_block_handler_type(procval) == block_handler_type_proc) { procval = vm_proc_to_block_handler(VM_BH_TO_PROC(procval)); } if (vm_block_handler_type(procval) == block_handler_type_iseq) { const struct rb_captured_block *captured = VM_BH_TO_ISEQ_BLOCK(procval); const rb_iseq_t *iseq = rb_iseq_check(captured->code.iseq); if (iseq->body->param.flags.has_rest && !iseq->body->param.flags.has_kw && !iseq->body->param.flags.has_kwrest) { iseq->body->param.flags.ruby2_keywords = 1; rb_clear_method_cache(module, name); } else { rb_warn("Skipping set of ruby2_keywords flag for %s (method accepts keywords or method does not accept argument splat)", rb_id2name(name)); } break; } } /* fallthrough */ default: rb_warn("Skipping set of ruby2_keywords flag for %s (method not defined in Ruby)", rb_id2name(name)); break; } } else { rb_warn("Skipping set of ruby2_keywords flag for %s (can only set in method defining module)", rb_id2name(name)); } } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#method_defined?;F;[[@c0;[[@ƒi£;T;:method_defined?;0;[;{;IC;"¾Returns +true+ if the named method is defined by _mod_. If _inherit_ is set, the lookup will also search _mod_'s ancestors. Public and protected methods are matched. String arguments are converted to symbols. module A def method1() end def protected_method1() end protected :protected_method1 end class B def method2() end def private_method2() end private :private_method2 end class C < B include A def method3() end end A.method_defined? :method1 #=> true C.method_defined? "method1" #=> true C.method_defined? "method2" #=> true C.method_defined? "method2", true #=> true C.method_defined? "method2", false #=> false C.method_defined? "method3" #=> true C.method_defined? "protected_method1" #=> true C.method_defined? "method4" #=> false C.method_defined? "private_method2" #=> false;T;[o;= ;3I" overload;F;40;;s;50;)I"*method_defined?(symbol, inherit=true);T;IC;";T; @ÃK;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ÃK;[;I"@return [Boolean];T;0;6i;[[I"symbol;T0[I"inherit;TI" true;T; @ÃKo;= ;3I" overload;F;40;;s;50;)I"*method_defined?(string, inherit=true);T;IC;";T; @ÃK;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ÃK;[;I"@return [Boolean];T;0;6i;[[I"string;T0[I"inherit;TI" true;T; @ÃK;[;I"HReturns +true+ if the named method is defined by _mod_. If _inherit_ is set, the lookup will also search _mod_'s ancestors. Public and protected methods are matched. String arguments are converted to symbols. module A def method1() end def protected_method1() end protected :protected_method1 end class B def method2() end def private_method2() end private :private_method2 end class C < B include A def method3() end end A.method_defined? :method1 #=> true C.method_defined? "method1" #=> true C.method_defined? "method2" #=> true C.method_defined? "method2", true #=> true C.method_defined? "method2", false #=> false C.method_defined? "method3" #=> true C.method_defined? "protected_method1" #=> true C.method_defined? "method4" #=> false C.method_defined? "private_method2" #=> false @overload method_defined?(symbol, inherit=true) @return [Boolean] @overload method_defined?(string, inherit=true) @return [Boolean];T;0; @ÃK;!F;"o;#;$T;%i;&i¡;6i;'@ªH;(I"óstatic VALUE rb_mod_method_defined(int argc, VALUE *argv, VALUE mod) { rb_method_visibility_t visi = check_definition_visibility(mod, argc, argv); return (visi == METHOD_VISI_PUBLIC || visi == METHOD_VISI_PROTECTED) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I""Module#public_method_defined?;F;[[@c0;[[@ƒiÎ;T;:public_method_defined?;0;[;{;IC;"œReturns +true+ if the named public method is defined by _mod_. If _inherit_ is set, the lookup will also search _mod_'s ancestors. String arguments are converted to symbols. module A def method1() end end class B protected def method2() end end class C < B include A def method3() end end A.method_defined? :method1 #=> true C.public_method_defined? "method1" #=> true C.public_method_defined? "method1", true #=> true C.public_method_defined? "method1", false #=> true C.public_method_defined? "method2" #=> false C.method_defined? "method2" #=> true;T;[o;= ;3I" overload;F;40;;t;50;)I"1public_method_defined?(symbol, inherit=true);T;IC;";T; @öK;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @öK;[;I"@return [Boolean];T;0;6i;[[I"symbol;T0[I"inherit;TI" true;T; @öKo;= ;3I" overload;F;40;;t;50;)I"1public_method_defined?(string, inherit=true);T;IC;";T; @öK;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @öK;[;I"@return [Boolean];T;0;6i;[[I"string;T0[I"inherit;TI" true;T; @öK;[;I"4Returns +true+ if the named public method is defined by _mod_. If _inherit_ is set, the lookup will also search _mod_'s ancestors. String arguments are converted to symbols. module A def method1() end end class B protected def method2() end end class C < B include A def method3() end end A.method_defined? :method1 #=> true C.public_method_defined? "method1" #=> true C.public_method_defined? "method1", true #=> true C.public_method_defined? "method1", false #=> true C.public_method_defined? "method2" #=> false C.method_defined? "method2" #=> true @overload public_method_defined?(symbol, inherit=true) @return [Boolean] @overload public_method_defined?(string, inherit=true) @return [Boolean];T;0; @öK;!F;"o;#;$T;%i°;&iÌ;6i;'@ªH;(I"‘static VALUE rb_mod_public_method_defined(int argc, VALUE *argv, VALUE mod) { return check_definition(mod, argc, argv, METHOD_VISI_PUBLIC); };T;)I"static VALUE;T;*To;;F; ;;;;I"#Module#private_method_defined?;F;[[@c0;[[@ƒiò;T;:private_method_defined?;0;[;{;IC;"©Returns +true+ if the named private method is defined by _mod_. If _inherit_ is set, the lookup will also search _mod_'s ancestors. String arguments are converted to symbols. module A def method1() end end class B private def method2() end end class C < B include A def method3() end end A.method_defined? :method1 #=> true C.private_method_defined? "method1" #=> false C.private_method_defined? "method2" #=> true C.private_method_defined? "method2", true #=> true C.private_method_defined? "method2", false #=> false C.method_defined? "method2" #=> false;T;[o;= ;3I" overload;F;40;;u;50;)I"2private_method_defined?(symbol, inherit=true);T;IC;";T; @)L;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @)L;[;I"@return [Boolean];T;0;6i;[[I"symbol;T0[I"inherit;TI" true;T; @)Lo;= ;3I" overload;F;40;;u;50;)I"2private_method_defined?(string, inherit=true);T;IC;";T; @)L;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @)L;[;I"@return [Boolean];T;0;6i;[[I"string;T0[I"inherit;TI" true;T; @)L;[;I"CReturns +true+ if the named private method is defined by _mod_. If _inherit_ is set, the lookup will also search _mod_'s ancestors. String arguments are converted to symbols. module A def method1() end end class B private def method2() end end class C < B include A def method3() end end A.method_defined? :method1 #=> true C.private_method_defined? "method1" #=> false C.private_method_defined? "method2" #=> true C.private_method_defined? "method2", true #=> true C.private_method_defined? "method2", false #=> false C.method_defined? "method2" #=> false @overload private_method_defined?(symbol, inherit=true) @return [Boolean] @overload private_method_defined?(string, inherit=true) @return [Boolean];T;0; @)L;!F;"o;#;$T;%iÔ;&ið;6i;'@ªH;(I"“static VALUE rb_mod_private_method_defined(int argc, VALUE *argv, VALUE mod) { return check_definition(mod, argc, argv, METHOD_VISI_PRIVATE); };T;)I"static VALUE;T;*To;;F; ;;;;I"%Module#protected_method_defined?;F;[[@c0;[[@ƒi;T;:protected_method_defined?;0;[;{;IC;"¯Returns +true+ if the named protected method is defined _mod_. If _inherit_ is set, the lookup will also search _mod_'s ancestors. String arguments are converted to symbols. module A def method1() end end class B protected def method2() end end class C < B include A def method3() end end A.method_defined? :method1 #=> true C.protected_method_defined? "method1" #=> false C.protected_method_defined? "method2" #=> true C.protected_method_defined? "method2", true #=> true C.protected_method_defined? "method2", false #=> false C.method_defined? "method2" #=> true;T;[o;= ;3I" overload;F;40;;v;50;)I"4protected_method_defined?(symbol, inherit=true);T;IC;";T; @\L;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @\L;[;I"@return [Boolean];T;0;6i;[[I"symbol;T0[I"inherit;TI" true;T; @\Lo;= ;3I" overload;F;40;;v;50;)I"4protected_method_defined?(string, inherit=true);T;IC;";T; @\L;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @\L;[;I"@return [Boolean];T;0;6i;[[I"string;T0[I"inherit;TI" true;T; @\L;[;I"MReturns +true+ if the named protected method is defined _mod_. If _inherit_ is set, the lookup will also search _mod_'s ancestors. String arguments are converted to symbols. module A def method1() end end class B protected def method2() end end class C < B include A def method3() end end A.method_defined? :method1 #=> true C.protected_method_defined? "method1" #=> false C.protected_method_defined? "method2" #=> true C.protected_method_defined? "method2", true #=> true C.protected_method_defined? "method2", false #=> false C.method_defined? "method2" #=> true @overload protected_method_defined?(symbol, inherit=true) @return [Boolean] @overload protected_method_defined?(string, inherit=true) @return [Boolean];T;0; @\L;!F;"o;#;$T;%iø;&i;6i;'@ªH;(I"—static VALUE rb_mod_protected_method_defined(int argc, VALUE *argv, VALUE mod) { return check_definition(mod, argc, argv, METHOD_VISI_PROTECTED); };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#public_class_method;F;[[@c0;[[@ƒiÙ;T;:public_class_method;0;[;{;IC;"Makes a list of existing class methods public. String arguments are converted to symbols. An Array of Symbols and/or Strings are also accepted. ;T;[o;= ;3I" overload;F;40;;w;50;)I"%public_class_method(symbol, ...);T;IC;";T; @L;>0;!F;[;[;I";T;0;6i;[[I"symbol;T0[I"...;T0; @Lo;= ;3I" overload;F;40;;w;50;)I"%public_class_method(string, ...);T;IC;";T; @L;>0;!F;[;[;I";T;0;6i;[[I"string;T0[I"...;T0; @Lo;= ;3I" overload;F;40;;w;50;)I"public_class_method(array);T;IC;";T; @L;>0;!F;[;[;I";T;0;6i;[[I" array;T0; @L;[;I" Makes a list of existing class methods public. String arguments are converted to symbols. An Array of Symbols and/or Strings are also accepted. @overload public_class_method(symbol, ...) @overload public_class_method(string, ...) @overload public_class_method(array);T;0; @L;!F;"o;#;$T;%iÍ;&iÕ;'@ªH;(I"«static VALUE rb_mod_public_method(int argc, VALUE *argv, VALUE obj) { set_method_visibility(rb_singleton_class(obj), argc, argv, METHOD_VISI_PUBLIC); return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I" Module#private_class_method;F;[[@c0;[[@ƒiõ;T;:private_class_method;0;[;{;IC;"ƒMakes existing class methods private. Often used to hide the default constructor new. String arguments are converted to symbols. An Array of Symbols and/or Strings are also accepted. class SimpleSingleton # Not thread safe private_class_method :new def SimpleSingleton.create(*args, &block) @me = new(*args, &block) if ! @me @me end end ;T;[o;= ;3I" overload;F;40;;x;50;)I"&private_class_method(symbol, ...);T;IC;";T; @ÀL;>0;!F;[;[;I";T;0;6i;[[I"symbol;T0[I"...;T0; @ÀLo;= ;3I" overload;F;40;;x;50;)I"&private_class_method(string, ...);T;IC;";T; @ÀL;>0;!F;[;[;I";T;0;6i;[[I"string;T0[I"...;T0; @ÀLo;= ;3I" overload;F;40;;x;50;)I" private_class_method(array);T;IC;";T; @ÀL;>0;!F;[;[;I";T;0;6i;[[I" array;T0; @ÀL;[;I"Makes existing class methods private. Often used to hide the default constructor new. String arguments are converted to symbols. An Array of Symbols and/or Strings are also accepted. class SimpleSingleton # Not thread safe private_class_method :new def SimpleSingleton.create(*args, &block) @me = new(*args, &block) if ! @me @me end end @overload private_class_method(symbol, ...) @overload private_class_method(string, ...) @overload private_class_method(array);T;0; @ÀL;!F;"o;#;$T;%ià;&iñ;'@ªH;(I"static VALUE rb_mod_private_method(int argc, VALUE *argv, VALUE obj) { set_method_visibility(rb_singleton_class(obj), argc, argv, METHOD_VISI_PRIVATE); return obj; };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Module#included;F;[[I"_y;T0;[[@Ìiz;T;: included;0;[;{;IC;"Ýcall-seq: included(othermod) Callback invoked whenever the receiver is included in another module or class. This should be used in preference to Module.append_features if your code wants to perform some action when a module is included in another. module A def A.included(mod) puts "#{self} included in #{mod}" end end module Enumerable include A end # => prints "A included in Enumerable" ;T;[;[;I"ß call-seq: included(othermod) Callback invoked whenever the receiver is included in another module or class. This should be used in preference to Module.append_features if your code wants to perform some action when a module is included in another. module A def A.included(mod) puts "#{self} included in #{mod}" end end module Enumerable include A end # => prints "A included in Enumerable" ;T;0; @ñL;!F;"o;#;$T;%i8;&iJ;'@ªH;(I"Rstatic VALUE rb_obj_dummy1(VALUE _x, VALUE _y) { return rb_obj_dummy(); };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Module#extended;F;[[I"_y;T0;[[@Ìiz;T;: extended;0;[;{;IC;":call-seq: extended(othermod) The equivalent of included, but for extended modules. module A def self.extended(mod) puts "#{self} extended in #{mod}" end end module Enumerable extend A end # => prints "A extended in Enumerable" ;T;[;[;I"< call-seq: extended(othermod) The equivalent of included, but for extended modules. module A def self.extended(mod) puts "#{self} extended in #{mod}" end end module Enumerable extend A end # => prints "A extended in Enumerable" ;T;0; @M;!F;"o;#;$T;%i%;&i4;'@ªH;(I"Rstatic VALUE rb_obj_dummy1(VALUE _x, VALUE _y) { return rb_obj_dummy(); };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Module#prepended;F;[[I"_y;T0;[[@Ìiz;T;:prepended;0;[;{;IC;"@call-seq: prepended(othermod) The equivalent of included, but for prepended modules. module A def self.prepended(mod) puts "#{self} prepended to #{mod}" end end module Enumerable prepend A end # => prints "A prepended to Enumerable" ;T;[;[;I"B call-seq: prepended(othermod) The equivalent of included, but for prepended modules. module A def self.prepended(mod) puts "#{self} prepended to #{mod}" end end module Enumerable prepend A end # => prints "A prepended to Enumerable" ;T;0; @M;!F;"o;#;$T;%iN;&i];'@ªH;(I"Rstatic VALUE rb_obj_dummy1(VALUE _x, VALUE _y) { return rb_obj_dummy(); };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Module#method_added;F;[[I"_y;T0;[[@Ìiz;T;:method_added;0;[;{;IC;"_call-seq: method_added(method_name) Invoked as a callback whenever an instance method is added to the receiver. module Chatty def self.method_added(method_name) puts "Adding #{method_name.inspect}" end def self.some_class_method() end def some_instance_method() end end produces: Adding :some_instance_method ;T;[;[;I"b call-seq: method_added(method_name) Invoked as a callback whenever an instance method is added to the receiver. module Chatty def self.method_added(method_name) puts "Adding #{method_name.inspect}" end def self.some_class_method() end def some_instance_method() end end produces: Adding :some_instance_method ;T;0; @!M;!F;"o;#;$T;%i§;&iº;'@ªH;(I"Rstatic VALUE rb_obj_dummy1(VALUE _x, VALUE _y) { return rb_obj_dummy(); };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Module#method_removed;F;[[I"_y;T0;[[@Ìiz;T;:method_removed;0;[;{;IC;"Ôcall-seq: method_removed(method_name) Invoked as a callback whenever an instance method is removed from the receiver. module Chatty def self.method_removed(method_name) puts "Removing #{method_name.inspect}" end def self.some_class_method() end def some_instance_method() end class << self remove_method :some_class_method end remove_method :some_instance_method end produces: Removing :some_instance_method ;T;[;[;I"× call-seq: method_removed(method_name) Invoked as a callback whenever an instance method is removed from the receiver. module Chatty def self.method_removed(method_name) puts "Removing #{method_name.inspect}" end def self.some_class_method() end def some_instance_method() end class << self remove_method :some_class_method end remove_method :some_instance_method end produces: Removing :some_instance_method ;T;0; @1M;!F;"o;#;$T;%i½;&iÔ;'@ªH;(I"Rstatic VALUE rb_obj_dummy1(VALUE _x, VALUE _y) { return rb_obj_dummy(); };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Module#method_undefined;F;[[I"_y;T0;[[@Ìiz;T;:method_undefined;0;[;{;IC;";T;[;[;@|;0; @AM;'@ªH;(I"Rstatic VALUE rb_obj_dummy1(VALUE _x, VALUE _y) { return rb_obj_dummy(); };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#freeze;F;[;[[@Ìi¹;T;;p;0;[;{;IC;"MPrevents further modifications to mod. This method returns self. ;T;[o;= ;3I" overload;F;40;;p;50;)I"freeze;T;IC;";T; @OM;>0;!F;[;[;I";T;0;6i;[; @OM;[;I"`Prevents further modifications to mod. This method returns self. @overload freeze;T;0; @OM;!F;"o;#;$T;%i°;&iµ;'@ªH;(I"estatic VALUE rb_mod_freeze(VALUE mod) { rb_class_name(mod); return rb_obj_freeze(mod); };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#===;F;[[I"arg;T0;[[@ÌiÊ;T;;\;0;[;{;IC;"ñCase Equality---Returns true if obj is an instance of mod or an instance of one of mod's descendants. Of limited use for modules, but can be used in case statements to classify objects by class. ;T;[o;= ;3I" overload;F;40;;\;50;)I" ===(obj);T;IC;";T; @eM;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @eM;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @eM;[;I"Case Equality---Returns true if obj is an instance of mod or an instance of one of mod's descendants. Of limited use for modules, but can be used in case statements to classify objects by class. @overload ===(obj) @return [Boolean];T;0; @eM;!F;"o;#;$T;%iÀ;&iÇ;'@ªH;(I"^static VALUE rb_mod_eqq(VALUE mod, VALUE arg) { return rb_obj_is_kind_of(arg, mod); };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#==;F;[[I" obj2;T0;[[@Ìiê;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 any pair of objects where #eql? returns +true+, the #hash value of both objects must be equal. So any subclass that overrides #eql? should also override #hash appropriately. 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;= ;3I" overload;F;40;;`;50;)I"==(other);T;IC;";T; @„M;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @„M;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @„Mo;= ;3I" overload;F;40;;a;50;)I"equal?(other);T;IC;";T; @„M;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @„M;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @„Mo;= ;3I" overload;F;40;;_;50;)I"eql?(other);T;IC;";T; @„M;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @„M;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @„M;[;@c;0; @„M;!F;"o;#;$T;%iÁ;&iè;'@ªH;(I"}MJIT_FUNC_EXPORTED VALUE rb_obj_equal(VALUE obj1, VALUE obj2) { if (obj1 == obj2) return Qtrue; return Qfalse; };T;)I"MJIT_FUNC_EXPORTED VALUE;T;*To;;F; ;;;;I"Module#<=>;F;[[I"arg;T0;[[@Ìi<;T;;c;0;[;{;IC;"+Comparison---Returns -1, 0, +1 or nil depending on whether +module+ includes +other_module+, they are the same, or if +module+ is included by +other_module+. Returns +nil+ if +module+ has no relationship with +other_module+, if +other_module+ is not a module, or if the two values are incomparable. ;T;[o;= ;3I" overload;F;40;;c;50;)I"<=>(other_module);T;IC;";T; @ÀM;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[ I"-1;TI"0;TI"+1;TI"nil;T; @ÀM;[;I"@return [-1, 0, +1, nil];T;0;6i;[[I"other_module;T0; @ÀM;[;I"fComparison---Returns -1, 0, +1 or nil depending on whether +module+ includes +other_module+, they are the same, or if +module+ is included by +other_module+. Returns +nil+ if +module+ has no relationship with +other_module+, if +other_module+ is not a module, or if the two values are incomparable. @overload <=>(other_module) @return [-1, 0, +1, nil];T;0; @ÀM;!F;"o;#;$T;%i0;&i9;'@ªH;(I",static VALUE rb_mod_cmp(VALUE mod, VALUE arg) { VALUE cmp; if (mod == arg) return INT2FIX(0); if (!CLASS_OR_MODULE_P(arg)) { return Qnil; } cmp = rb_class_inherited_p(mod, arg); if (NIL_P(cmp)) return Qnil; if (cmp) { return INT2FIX(-1); } return INT2FIX(1); };T;)I"static VALUE;T;*To;;F; ;;;;I" Module#<;F;[[I"arg;T0;[[@Ìi;T;:<;0;[;{;IC;"ÛReturns true if mod is a subclass of other. Returns nil if there's no relationship between the two. (Think of the relationship in terms of the class definition: "class A < B" implies "A < B".) ;T;[o;= ;3I" overload;F;40;;;50;)I" <(other);T;IC;";T; @âM;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" true;TI" false;TI"nil;T; @âM;[;I"@return [true, false, nil];T;0;6i;[[I" other;T0; @âM;[;I"Returns true if mod is a subclass of other. Returns nil if there's no relationship between the two. (Think of the relationship in terms of the class definition: "class A < B" implies "A < B".) @overload <(other) @return [true, false, nil];T;0; @âM;!F;"o;#;$T;%iõ;&iý;'@ªH;(I"~static VALUE rb_mod_lt(VALUE mod, VALUE arg) { if (mod == arg) return Qfalse; return rb_class_inherited_p(mod, arg); };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#<=;F;[[I"arg;T0;[[@Ìiä;T;:<=;0;[;{;IC;"úReturns true if mod is a subclass of other or is the same as other. Returns nil if there's no relationship between the two. (Think of the relationship in terms of the class definition: "class A < B" implies "A < B".) ;T;[o;= ;3I" overload;F;40;;€;50;)I"<=(other);T;IC;";T; @N;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" true;TI" false;TI"nil;T; @N;[;I"@return [true, false, nil];T;0;6i;[[I" other;T0; @N;[;I".Returns true if mod is a subclass of other or is the same as other. Returns nil if there's no relationship between the two. (Think of the relationship in terms of the class definition: "class A < B" implies "A < B".) @overload <=(other) @return [true, false, nil];T;0; @N;!F;"o;#;$T;%iÐ;&iÙ;'@ªH;(I"¥VALUE rb_class_inherited_p(VALUE mod, VALUE arg) { if (mod == arg) return Qtrue; if (!CLASS_OR_MODULE_P(arg) && !RB_TYPE_P(arg, T_ICLASS)) { rb_raise(rb_eTypeError, "compared with non class/module"); } if (class_search_ancestor(mod, RCLASS_ORIGIN(arg))) { return Qtrue; } /* not mod < arg; check if mod > arg */ if (class_search_ancestor(arg, mod)) { return Qfalse; } return Qnil; };T;)I" VALUE;T;*To;;F; ;;;;I" Module#>;F;[[I"arg;T0;[[@Ìi);T;:>;0;[;{;IC;"ÜReturns true if mod is an ancestor of other. Returns nil if there's no relationship between the two. (Think of the relationship in terms of the class definition: "class A < B" implies "B > A".) ;T;[o;= ;3I" overload;F;40;;;50;)I" >(other);T;IC;";T; @$N;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" true;TI" false;TI"nil;T; @$N;[;I"@return [true, false, nil];T;0;6i;[[I" other;T0; @$N;[;I"Returns true if mod is an ancestor of other. Returns nil if there's no relationship between the two. (Think of the relationship in terms of the class definition: "class A < B" implies "B > A".) @overload >(other) @return [true, false, nil];T;0; @$N;!F;"o;#;$T;%i;&i&;'@ªH;(I"xstatic VALUE rb_mod_gt(VALUE mod, VALUE arg) { if (mod == arg) return Qfalse; return rb_mod_ge(mod, arg); };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#>=;F;[[I"arg;T0;[[@Ìi;T;:>=;0;[;{;IC;"ýReturns true if mod is an ancestor of other, or the two modules are the same. Returns nil if there's no relationship between the two. (Think of the relationship in terms of the class definition: "class A < B" implies "B > A".) ;T;[o;= ;3I" overload;F;40;;‚;50;)I">=(other);T;IC;";T; @EN;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" true;TI" false;TI"nil;T; @EN;[;I"@return [true, false, nil];T;0;6i;[[I" other;T0; @EN;[;I"1Returns true if mod is an ancestor of other, or the two modules are the same. Returns nil if there's no relationship between the two. (Think of the relationship in terms of the class definition: "class A < B" implies "B > A".) @overload >=(other) @return [true, false, nil];T;0; @EN;!F;"o;#;$T;%i;&i;'@ªH;(I"Ástatic VALUE rb_mod_ge(VALUE mod, VALUE arg) { if (!CLASS_OR_MODULE_P(arg)) { rb_raise(rb_eTypeError, "compared with non class/module"); } return rb_class_inherited_p(arg, mod); };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#initialize_copy;F;[[I" orig;T0;[[@if;T;;g;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @fN;!F;"o;#;$T;%ie;&ie;'@ªH;(I"½ VALUE rb_mod_init_copy(VALUE clone, VALUE orig) { if (RB_TYPE_P(clone, T_CLASS)) { class_init_copy_check(clone, orig); } if (!OBJ_INIT_COPY(clone, orig)) return clone; /* cloned flag is refer at constant inline cache * see vm_get_const_key_cref() in vm_insnhelper.c */ FL_SET(clone, RCLASS_CLONED); FL_SET(orig , RCLASS_CLONED); if (!FL_TEST(CLASS_OF(clone), FL_SINGLETON)) { RBASIC_SET_CLASS(clone, rb_singleton_class_clone(orig)); rb_singleton_class_attached(RBASIC(clone)->klass, (VALUE)clone); } RCLASS_EXT(clone)->allocator = RCLASS_EXT(orig)->allocator; copy_tables(clone, orig); if (RCLASS_M_TBL(orig)) { struct clone_method_arg arg; arg.old_klass = orig; arg.new_klass = clone; RCLASS_M_TBL_INIT(clone); rb_id_table_foreach(RCLASS_M_TBL(orig), clone_method_i, &arg); } if (RCLASS_ORIGIN(orig) == orig) { RCLASS_SET_SUPER(clone, RCLASS_SUPER(orig)); } else { VALUE p = RCLASS_SUPER(orig); VALUE orig_origin = RCLASS_ORIGIN(orig); VALUE prev_clone_p = clone; VALUE origin_stack = rb_ary_tmp_new(2); VALUE origin[2]; VALUE clone_p = 0; long origin_len; int add_subclass; VALUE clone_origin; ensure_origin(clone); clone_origin = RCLASS_ORIGIN(clone); while (p && p != orig_origin) { if (BUILTIN_TYPE(p) != T_ICLASS) { rb_bug("non iclass between module/class and origin"); } clone_p = class_alloc(RBASIC(p)->flags, RBASIC(p)->klass); RCLASS_SET_SUPER(prev_clone_p, clone_p); prev_clone_p = clone_p; RCLASS_M_TBL(clone_p) = RCLASS_M_TBL(p); RCLASS_CONST_TBL(clone_p) = RCLASS_CONST_TBL(p); RCLASS_IV_TBL(clone_p) = RCLASS_IV_TBL(p); RCLASS_EXT(clone_p)->allocator = RCLASS_EXT(p)->allocator; if (RB_TYPE_P(clone, T_CLASS)) { RCLASS_SET_INCLUDER(clone_p, clone); } add_subclass = TRUE; if (p != RCLASS_ORIGIN(p)) { origin[0] = clone_p; origin[1] = RCLASS_ORIGIN(p); rb_ary_cat(origin_stack, origin, 2); } else if ((origin_len = RARRAY_LEN(origin_stack)) > 1 && RARRAY_AREF(origin_stack, origin_len - 1) == p) { RCLASS_SET_ORIGIN(RARRAY_AREF(origin_stack, (origin_len -= 2)), clone_p); RICLASS_SET_ORIGIN_SHARED_MTBL(clone_p); rb_ary_resize(origin_stack, origin_len); add_subclass = FALSE; } if (add_subclass) { rb_module_add_to_subclasses_list(RBASIC(p)->klass, clone_p); } p = RCLASS_SUPER(p); } if (p == orig_origin) { if (clone_p) { RCLASS_SET_SUPER(clone_p, clone_origin); RCLASS_SET_SUPER(clone_origin, RCLASS_SUPER(orig_origin)); } copy_tables(clone_origin, orig_origin); if (RCLASS_M_TBL(orig_origin)) { struct clone_method_arg arg; arg.old_klass = orig; arg.new_klass = clone; RCLASS_M_TBL_INIT(clone_origin); rb_id_table_foreach(RCLASS_M_TBL(orig_origin), clone_method_i, &arg); } } else { rb_bug("no origin for class that has origin"); } } return clone; };T;)I" VALUE;T;*To;;F; ;;;;I"Module#to_s;F;[;[[@Ìi;T;;q;0;[;{;IC;"°Returns a string representing this module or class. For basic classes and modules, this is the name. For singletons, we show information on the thing we're attached to as well. ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @vN;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @vN;[;I"@return [String];T;0;6i;[; @vN;[;I"ÔReturns a string representing this module or class. For basic classes and modules, this is the name. For singletons, we show information on the thing we're attached to as well. @overload to_s @return [String];T;0; o;;F; ;;;;I"Module#inspect;F;[;[[@Ìi;F;;r;;K;[;{;@}N;'@ªH;)I"static VALUE;T;(I"3static VALUE rb_mod_to_s(VALUE klass) { ID id_defined_at; VALUE refined_class, defined_at; if (FL_TEST(klass, FL_SINGLETON)) { VALUE s = rb_usascii_str_new2("#"); return s; } refined_class = rb_refinement_module_get_refined_class(klass); if (!NIL_P(refined_class)) { VALUE s = rb_usascii_str_new2("#"); return s; } return rb_class_name(klass); };T;!F;"o;#;$T;%i„;&iŠ;'@ªH;(I"3static VALUE rb_mod_to_s(VALUE klass) { ID id_defined_at; VALUE refined_class, defined_at; if (FL_TEST(klass, FL_SINGLETON)) { VALUE s = rb_usascii_str_new2("#"); return s; } refined_class = rb_refinement_module_get_refined_class(klass); if (!NIL_P(refined_class)) { VALUE s = rb_usascii_str_new2("#"); return s; } return rb_class_name(klass); };T;)@•N;*T@ŽNo;;F; ;;;;I"Module#included_modules;F;[;[[@iÐ;T;:included_modules;0;[;{;IC;"Returns the list of modules included or prepended in mod or one of mod's ancestors. module Sub end module Mixin prepend Sub end module Outer include Mixin end Mixin.included_modules #=> [Sub] Outer.included_modules #=> [Sub, Mixin] ;T;[o;= ;3I" overload;F;40;;ƒ;50;)I"included_modules;T;IC;";T; @™N;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @™N;[;I"@return [Array];T;0;6i;[; @™N;[;I"NReturns the list of modules included or prepended in mod or one of mod's ancestors. module Sub end module Mixin prepend Sub end module Outer include Mixin end Mixin.included_modules #=> [Sub] Outer.included_modules #=> [Sub, Mixin] @overload included_modules @return [Array];T;0; @™N;!F;"o;#;$T;%iº;&iÍ;'@ªH;(I"~VALUE rb_mod_included_modules(VALUE mod) { VALUE ary = rb_ary_new(); VALUE p; VALUE origin = RCLASS_ORIGIN(mod); for (p = RCLASS_SUPER(mod); p; p = RCLASS_SUPER(p)) { if (p != origin && RCLASS_ORIGIN(p) == p && BUILTIN_TYPE(p) == T_ICLASS) { VALUE m = RBASIC(p)->klass; if (RB_TYPE_P(m, T_MODULE)) rb_ary_push(ary, m); } } return ary; };T;)I" VALUE;T;*To;;F; ;;;;I"Module#include?;F;[[I" mod2;T0;[[@iô;T;;E;0;[;{;IC;"Returns true if module is included or prepended in mod or one of mod's ancestors. module A end class B include A end class C < B end B.include?(A) #=> true C.include?(A) #=> true A.include?(A) #=> false;T;[o;= ;3I" overload;F;40;;E;50;)I"include?(module);T;IC;";T; @´N;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @´N;[;I"@return [Boolean];T;0;6i;[; @´N;[;I"DReturns true if module is included or prepended in mod or one of mod's ancestors. module A end class B include A end class C < B end B.include?(A) #=> true C.include?(A) #=> true A.include?(A) #=> false @overload include?(module) @return [Boolean];T;0; @´N;!F;"o;#;$T;%iá;&iñ;6i;'@ªH;(I"3VALUE rb_mod_include_p(VALUE mod, VALUE mod2) { VALUE p; Check_Type(mod2, T_MODULE); for (p = RCLASS_SUPER(mod); p; p = RCLASS_SUPER(p)) { if (BUILTIN_TYPE(p) == T_ICLASS && !FL_TEST(p, RICLASS_IS_ORIGIN)) { if (RBASIC(p)->klass == mod2) return Qtrue; } } return Qfalse; };T;)I" VALUE;T;*To;;F; ;;;;I"Module#name;F;[;[[@§iz;T;;Ñ;0;[;{;IC;"SReturns the name of the module mod. Returns nil for anonymous modules. ;T;[o;= ;3I" overload;F;40;;Ñ;50;)I" name;T;IC;";T; @ÑN;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ÑN;[;I"@return [String];T;0;6i;[; @ÑN;[;I"wReturns the name of the module mod. Returns nil for anonymous modules. @overload name @return [String];T;0; @ÑN;!F;"o;#;$T;%is;&iw;'@ªH;(I"_VALUE rb_mod_name(VALUE mod) { int permanent; return classname(mod, &permanent); };T;)I" VALUE;T;*To;;F; ;;;;I"Module#ancestors;F;[;[[@i;T;:ancestors;0;[;{;IC;">Returns a list of modules included/prepended in mod (including mod itself). module Mod include Math include Comparable prepend Enumerable end Mod.ancestors #=> [Enumerable, Mod, Comparable, Math] Math.ancestors #=> [Math] Enumerable.ancestors #=> [Enumerable] ;T;[o;= ;3I" overload;F;40;;„;50;)I"ancestors;T;IC;";T; @ìN;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ìN;[;I"@return [Array];T;0;6i;[; @ìN;[;I"fReturns a list of modules included/prepended in mod (including mod itself). module Mod include Math include Comparable prepend Enumerable end Mod.ancestors #=> [Enumerable, Mod, Comparable, Math] Math.ancestors #=> [Math] Enumerable.ancestors #=> [Enumerable] @overload ancestors @return [Array];T;0; @ìN;!F;"o;#;$T;%i;&i;'@ªH;(I"2VALUE rb_mod_ancestors(VALUE mod) { VALUE p, ary = rb_ary_new(); for (p = mod; p; p = RCLASS_SUPER(p)) { if (p != RCLASS_ORIGIN(p)) continue; if (BUILTIN_TYPE(p) == T_ICLASS) { rb_ary_push(ary, RBASIC(p)->klass); } else { rb_ary_push(ary, p); } } return ary; };T;)I" VALUE;T;*To;;F; ;;;;I"Module#attr;F;[[@c0;[[@Ìiú;T;: attr;0;[;{;IC;"The first form is equivalent to #attr_reader. The second form is equivalent to attr_accessor(name) but deprecated. The last form is equivalent to attr_reader(name) but deprecated. Returns an array of defined method names as symbols. ;T;[o;= ;3I" overload;F;40;;…;50;)I"attr(name, ...);T;IC;";T; @O;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @O;[;I"@return [Array];T;0;6i;[[I" name;T0[I"...;T0; @Oo;= ;3I" overload;F;40;;…;50;)I"attr(name, true);T;IC;";T; @O;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @O;[;I"@return [Array];T;0;6i;[[I" name;T0[I" true;T0; @Oo;= ;3I" overload;F;40;;…;50;)I"attr(name, false);T;IC;";T; @O;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @O;[;I"@return [Array];T;0;6i;[[I" name;T0[I" false;T0; @O;[;I"ŒThe first form is equivalent to #attr_reader. The second form is equivalent to attr_accessor(name) but deprecated. The last form is equivalent to attr_reader(name) but deprecated. Returns an array of defined method names as symbols. @overload attr(name, ...) @return [Array] @overload attr(name, true) @return [Array] @overload attr(name, false) @return [Array];T;0; @O;!F;"o;#;$T;%ië;&i÷;'@ªH;(I"öVALUE rb_mod_attr(int argc, VALUE *argv, VALUE klass) { if (argc == 2 && (argv[1] == Qtrue || argv[1] == Qfalse)) { ID id = id_for_attr(klass, argv[0]); VALUE names = rb_ary_new(); rb_category_warning(RB_WARN_CATEGORY_DEPRECATED, "optional boolean argument is obsoleted"); rb_attr(klass, id, 1, RTEST(argv[1]), TRUE); rb_ary_push(names, ID2SYM(id)); if (argv[1] == Qtrue) rb_ary_push(names, ID2SYM(rb_id_attrset(id))); return names; } return rb_mod_attr_reader(argc, argv, klass); };T;)I" VALUE;T;*To;;F; ;;;;I"Module#attr_reader;F;[[@c0;[[@ÌiÝ;T;:attr_reader;0;[;{;IC;"Creates instance variables and corresponding methods that return the value of each instance variable. Equivalent to calling ``attr:name'' on each name in turn. String arguments are converted to symbols. Returns an array of defined method names as symbols. ;T;[ o;= ;3I" overload;F;40;;†;50;)I"attr_reader(symbol, ...);T;IC;";T; @IO;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @IO;[;I"@return [Array];T;0;6i;[[I"symbol;T0[I"...;T0; @IOo;= ;3I" overload;F;40;;…;50;)I"attr(symbol, ...);T;IC;";T; @IO;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @IO;[;I"@return [Array];T;0;6i;[[I"symbol;T0[I"...;T0; @IOo;= ;3I" overload;F;40;;†;50;)I"attr_reader(string, ...);T;IC;";T; @IO;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @IO;[;I"@return [Array];T;0;6i;[[I"string;T0[I"...;T0; @IOo;= ;3I" overload;F;40;;…;50;)I"attr(string, ...);T;IC;";T; @IO;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @IO;[;I"@return [Array];T;0;6i;[[I"string;T0[I"...;T0; @IO;[;I"ÛCreates instance variables and corresponding methods that return the value of each instance variable. Equivalent to calling ``attr:name'' on each name in turn. String arguments are converted to symbols. Returns an array of defined method names as symbols. @overload attr_reader(symbol, ...) @return [Array] @overload attr(symbol, ...) @return [Array] @overload attr_reader(string, ...) @return [Array] @overload attr(string, ...) @return [Array];T;0; @IO;!F;"o;#;$T;%iÏ;&iÝ;'@ªH;(I"static VALUE rb_mod_attr_reader(int argc, VALUE *argv, VALUE klass) { int i; VALUE names = rb_ary_new2(argc); for (i=0; isymbol.id2name. String arguments are converted to symbols. Returns an array of defined method names as symbols. ;T;[o;= ;3I" overload;F;40;;‡;50;)I"attr_writer(symbol, ...);T;IC;";T; @œO;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @œO;[;I"@return [Array];T;0;6i;[[I"symbol;T0[I"...;T0; @œOo;= ;3I" overload;F;40;;‡;50;)I"attr_writer(string, ...);T;IC;";T; @œO;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @œO;[;I"@return [Array];T;0;6i;[[I"string;T0[I"...;T0; @œO;[;I"/Creates an accessor method to allow assignment to the attribute symbol.id2name. String arguments are converted to symbols. Returns an array of defined method names as symbols. @overload attr_writer(symbol, ...) @return [Array] @overload attr_writer(string, ...) @return [Array];T;0; @œO;!F;"o;#;$T;%i ;&i ;'@ªH;(I"+static VALUE rb_mod_attr_writer(int argc, VALUE *argv, VALUE klass) { int i; VALUE names = rb_ary_new2(argc); for (i=0; isymbol.id2name, creating an instance variable (@name) and a corresponding access method to read it. Also creates a method called name= to set the attribute. String arguments are converted to symbols. Returns an array of defined method names as symbols. module Mod attr_accessor(:one, :two) #=> [:one, :one=, :two, :two=] end Mod.instance_methods.sort #=> [:one, :one=, :two, :two=] ;T;[o;= ;3I" overload;F;40;;ˆ;50;)I"attr_accessor(symbol, ...);T;IC;";T; @ÍO;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ÍO;[;I"@return [Array];T;0;6i;[[I"symbol;T0[I"...;T0; @ÍOo;= ;3I" overload;F;40;;ˆ;50;)I"attr_accessor(string, ...);T;IC;";T; @ÍO;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ÍO;[;I"@return [Array];T;0;6i;[[I"string;T0[I"...;T0; @ÍO;[;I"iDefines a named attribute for this module, where the name is symbol.id2name, creating an instance variable (@name) and a corresponding access method to read it. Also creates a method called name= to set the attribute. String arguments are converted to symbols. Returns an array of defined method names as symbols. module Mod attr_accessor(:one, :two) #=> [:one, :one=, :two, :two=] end Mod.instance_methods.sort #=> [:one, :one=, :two, :two=] @overload attr_accessor(symbol, ...) @return [Array] @overload attr_accessor(string, ...) @return [Array];T;0; @ÍO;!F;"o;#;$T;%i# ;&i3 ;'@ªH;(I"Rstatic VALUE rb_mod_attr_accessor(int argc, VALUE *argv, VALUE klass) { int i; VALUE names = rb_ary_new2(argc * 2); for (i=0; i "my string" a.meth1 #=> "hello" a.meth2 #=> "bye" Assign the module to a constant (name starting uppercase) if you want to treat it like a regular module. ;T;[o;= ;3I" overload;F;40;;î;50;)I"new;T;IC;";T; @þO;>0;!F;[;[;I";T;0;6i;[; @þOo;= ;3I" overload;F;40;;î;50;)I"new;T;IC;";T; @þO;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"mod;T; @þO;[;I"@yield [mod];T;0;6i;[; @þO;[;I"Creates a new anonymous module. If a block is given, it is passed the module object, and the block is evaluated in the context of this module like #module_eval. fred = Module.new do def meth1 "hello" end def meth2 "bye" end end a = "my string" a.extend(fred) #=> "my string" a.meth1 #=> "hello" a.meth2 #=> "bye" Assign the module to a constant (name starting uppercase) if you want to treat it like a regular module. @overload new @overload new @yield [mod];T;0; @þO;!F;"o;#;$T;%i];⁢'@ªH;(I"Žstatic VALUE rb_mod_initialize(VALUE module) { if (rb_block_given_p()) { rb_mod_module_exec(1, &module, module); } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#initialize_clone;F;[[@c0;[[@Ìi;T;;i;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @!P;!F;"o;#;$T;%i€;&i€;'@ªH;(I"static VALUE rb_mod_initialize_clone(int argc, VALUE* argv, VALUE clone) { VALUE ret, orig, opts; rb_scan_args(argc, argv, "1:", &orig, &opts); ret = rb_obj_init_clone(argc, argv, clone); if (OBJ_FROZEN(orig)) rb_class_name(clone); return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#instance_methods;F;[[@c0;[[@iÁ;T;:instance_methods;0;[;{;IC;"÷Returns an array containing the names of the public and protected instance methods in the receiver. For a module, these are the public and protected methods; for a class, they are the instance (not singleton) methods. If the optional parameter is false, the methods of any ancestors are not included. module A def method1() end end class B include A def method2() end end class C < B def method3() end end A.instance_methods(false) #=> [:method1] B.instance_methods(false) #=> [:method2] B.instance_methods(true).include?(:method1) #=> true C.instance_methods(false) #=> [:method3] C.instance_methods.include?(:method2) #=> true ;T;[o;= ;3I" overload;F;40;;‰;50;)I")instance_methods(include_super=true);T;IC;";T; @0P;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @0P;[;I"@return [Array];T;0;6i;[[I"include_super;TI" true;T; @0P;[;I":Returns an array containing the names of the public and protected instance methods in the receiver. For a module, these are the public and protected methods; for a class, they are the instance (not singleton) methods. If the optional parameter is false, the methods of any ancestors are not included. module A def method1() end end class B include A def method2() end end class C < B def method3() end end A.instance_methods(false) #=> [:method1] B.instance_methods(false) #=> [:method2] B.instance_methods(true).include?(:method1) #=> true C.instance_methods(false) #=> [:method3] C.instance_methods.include?(:method2) #=> true @overload instance_methods(include_super=true) @return [Array];T;0; @0P;!F;"o;#;$T;%i¦;&i¾;'@ªH;(I"•VALUE rb_class_instance_methods(int argc, const VALUE *argv, VALUE mod) { return class_instance_method_list(argc, argv, mod, 0, ins_methods_i); };T;)I" VALUE;T;*To;;F; ;;;;I"#Module#public_instance_methods;F;[[@c0;[[@iö;T;:public_instance_methods;0;[;{;IC;"¤Returns a list of the public instance methods defined in mod. If the optional parameter is false, the methods of any ancestors are not included. ;T;[o;= ;3I" overload;F;40;;Š;50;)I"0public_instance_methods(include_super=true);T;IC;";T; @OP;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @OP;[;I"@return [Array];T;0;6i;[[I"include_super;TI" true;T; @OP;[;I"îReturns a list of the public instance methods defined in mod. If the optional parameter is false, the methods of any ancestors are not included. @overload public_instance_methods(include_super=true) @return [Array];T;0; @OP;!F;"o;#;$T;%ií;&ió;'@ªH;(I" VALUE rb_class_public_instance_methods(int argc, const VALUE *argv, VALUE mod) { return class_instance_method_list(argc, argv, mod, 0, ins_methods_pub_i); };T;)I" VALUE;T;*To;;F; ;;;;I"&Module#protected_instance_methods;F;[[@c0;[[@iÐ;T;:protected_instance_methods;0;[;{;IC;"§Returns a list of the protected instance methods defined in mod. If the optional parameter is false, the methods of any ancestors are not included. ;T;[o;= ;3I" overload;F;40;;‹;50;)I"3protected_instance_methods(include_super=true);T;IC;";T; @nP;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @nP;[;I"@return [Array];T;0;6i;[[I"include_super;TI" true;T; @nP;[;I"ôReturns a list of the protected instance methods defined in mod. If the optional parameter is false, the methods of any ancestors are not included. @overload protected_instance_methods(include_super=true) @return [Array];T;0; @nP;!F;"o;#;$T;%iÇ;&iÍ;'@ªH;(I"¤VALUE rb_class_protected_instance_methods(int argc, const VALUE *argv, VALUE mod) { return class_instance_method_list(argc, argv, mod, 0, ins_methods_prot_i); };T;)I" VALUE;T;*To;;F; ;;;;I"$Module#private_instance_methods;F;[[@c0;[[@iç;T;:private_instance_methods;0;[;{;IC;"cReturns a list of the private instance methods defined in mod. If the optional parameter is false, the methods of any ancestors are not included. module Mod def method1() end private :method1 def method2() end end Mod.instance_methods #=> [:method2] Mod.private_instance_methods #=> [:method1] ;T;[o;= ;3I" overload;F;40;;Œ;50;)I"1private_instance_methods(include_super=true);T;IC;";T; @P;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @P;[;I"@return [Array];T;0;6i;[[I"include_super;TI" true;T; @P;[;I"®Returns a list of the private instance methods defined in mod. If the optional parameter is false, the methods of any ancestors are not included. module Mod def method1() end private :method1 def method2() end end Mod.instance_methods #=> [:method2] Mod.private_instance_methods #=> [:method1] @overload private_instance_methods(include_super=true) @return [Array];T;0; @P;!F;"o;#;$T;%iÖ;&iä;'@ªH;(I"¢VALUE rb_class_private_instance_methods(int argc, const VALUE *argv, VALUE mod) { return class_instance_method_list(argc, argv, mod, 0, ins_methods_priv_i); };T;)I" VALUE;T;*To;;F; ;;;;I"Module#constants;F;[[@c0;[[@§i7;T;;l;0;[;{;IC;"ÃReturns an array of the names of the constants accessible in mod. This includes the names of constants in any included modules (example at start of section), unless the inherit parameter is set to false. The implementation makes no guarantees about the order in which the constants are yielded. IO.constants.include?(:SYNC) #=> true IO.constants(false).include?(:SYNC) #=> false Also see Module#const_defined?. ;T;[o;= ;3I" overload;F;40;;l;50;)I"constants(inherit=true);T;IC;";T; @¬P;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @¬P;[;I"@return [Array];T;0;6i;[[I"inherit;TI" true;T; @¬P;[;I"ùReturns an array of the names of the constants accessible in mod. This includes the names of constants in any included modules (example at start of section), unless the inherit parameter is set to false. The implementation makes no guarantees about the order in which the constants are yielded. IO.constants.include?(:SYNC) #=> true IO.constants(false).include?(:SYNC) #=> false Also see Module#const_defined?. @overload constants(inherit=true) @return [Array];T;0; @¬P;!F;"o;#;$T;%i%;&i4;'@ªH;(I"VALUE rb_mod_constants(int argc, const VALUE *argv, VALUE mod) { bool inherit = true; if (rb_check_arity(argc, 0, 1)) inherit = RTEST(argv[0]); if (inherit) { return rb_const_list(rb_mod_const_of(mod, 0)); } else { return rb_local_constants(mod); } };T;)I" VALUE;T;*To;;F; ;;;;I"Module#const_get;F;[[@c0;[[@Ìim ;T;:const_get;0;[;{;IC;"¡Checks for a constant with the given name in mod. If +inherit+ is set, the lookup will also search the ancestors (and +Object+ if mod is a +Module+). The value of the constant is returned if a definition is found, otherwise a +NameError+ is raised. Math.const_get(:PI) #=> 3.14159265358979 This method will recursively look up constant names if a namespaced class name is provided. For example: module Foo; class Bar; end end Object.const_get 'Foo::Bar' The +inherit+ flag is respected on each lookup. For example: module Foo class Bar VAL = 10 end class Baz < Bar; end end Object.const_get 'Foo::Baz::VAL' # => 10 Object.const_get 'Foo::Baz::VAL', false # => NameError If the argument is not a valid constant name a +NameError+ will be raised with a warning "wrong constant name". Object.const_get 'foobar' #=> NameError: wrong constant name foobar ;T;[o;= ;3I" overload;F;40;;;50;)I"!const_get(sym, inherit=true);T;IC;";T; @ËP;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @ËP;[;I"@return [Object];T;0;6i;[[I"sym;T0[I"inherit;TI" true;T; @ËPo;= ;3I" overload;F;40;;;50;)I"!const_get(str, inherit=true);T;IC;";T; @ËP;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @ËP;[;I"@return [Object];T;0;6i;[[I"str;T0[I"inherit;TI" true;T; @ËP;[;I"Checks for a constant with the given name in mod. If +inherit+ is set, the lookup will also search the ancestors (and +Object+ if mod is a +Module+). The value of the constant is returned if a definition is found, otherwise a +NameError+ is raised. Math.const_get(:PI) #=> 3.14159265358979 This method will recursively look up constant names if a namespaced class name is provided. For example: module Foo; class Bar; end end Object.const_get 'Foo::Bar' The +inherit+ flag is respected on each lookup. For example: module Foo class Bar VAL = 10 end class Baz < Bar; end end Object.const_get 'Foo::Baz::VAL' # => 10 Object.const_get 'Foo::Baz::VAL', false # => NameError If the argument is not a valid constant name a +NameError+ will be raised with a warning "wrong constant name". Object.const_get 'foobar' #=> NameError: wrong constant name foobar @overload const_get(sym, inherit=true) @return [Object] @overload const_get(str, inherit=true) @return [Object];T;0; @ËP;!F;"o;#;$T;%iE ;&ik ;'@ªH;(I"ístatic VALUE rb_mod_const_get(int argc, VALUE *argv, VALUE mod) { VALUE name, recur; rb_encoding *enc; const char *pbeg, *p, *path, *pend; ID id; rb_check_arity(argc, 1, 2); name = argv[0]; recur = (argc == 1) ? Qtrue : argv[1]; if (SYMBOL_P(name)) { if (!rb_is_const_sym(name)) goto wrong_name; id = rb_check_id(&name); if (!id) return rb_const_missing(mod, name); return RTEST(recur) ? rb_const_get(mod, id) : rb_const_get_at(mod, id); } path = StringValuePtr(name); enc = rb_enc_get(name); if (!rb_enc_asciicompat(enc)) { rb_raise(rb_eArgError, "invalid class path encoding (non ASCII)"); } pbeg = p = path; pend = path + RSTRING_LEN(name); if (p >= pend || !*p) { goto wrong_name; } if (p + 2 < pend && p[0] == ':' && p[1] == ':') { mod = rb_cObject; p += 2; pbeg = p; } while (p < pend) { VALUE part; long len, beglen; while (p < pend && *p != ':') p++; if (pbeg == p) goto wrong_name; id = rb_check_id_cstr(pbeg, len = p-pbeg, enc); beglen = pbeg-path; if (p < pend && p[0] == ':') { if (p + 2 >= pend || p[1] != ':') goto wrong_name; p += 2; pbeg = p; } if (!RB_TYPE_P(mod, T_MODULE) && !RB_TYPE_P(mod, T_CLASS)) { rb_raise(rb_eTypeError, "%"PRIsVALUE" does not refer to class/module", QUOTE(name)); } if (!id) { part = rb_str_subseq(name, beglen, len); OBJ_FREEZE(part); if (!rb_is_const_name(part)) { name = part; goto wrong_name; } else if (!rb_method_basic_definition_p(CLASS_OF(mod), id_const_missing)) { part = rb_str_intern(part); mod = rb_const_missing(mod, part); continue; } else { rb_mod_const_missing(mod, part); } } if (!rb_is_const_id(id)) { name = ID2SYM(id); goto wrong_name; } #if 0 mod = rb_const_get_0(mod, id, beglen > 0 || !RTEST(recur), RTEST(recur), FALSE); #else if (!RTEST(recur)) { mod = rb_const_get_at(mod, id); } else if (beglen == 0) { mod = rb_const_get(mod, id); } else { mod = rb_const_get_from(mod, id); } #endif } return mod; wrong_name: rb_name_err_raise(wrong_constant_name, mod, name); UNREACHABLE_RETURN(Qundef); };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#const_set;F;[[I" name;T0[I" value;T0;[[@Ìiç ;T;:const_set;0;[;{;IC;"ÜSets the named constant to the given object, returning that object. Creates a new constant if no constant with the given name previously existed. Math.const_set("HIGH_SCHOOL_PI", 22.0/7.0) #=> 3.14285714285714 Math::HIGH_SCHOOL_PI - Math::PI #=> 0.00126448926734968 If +sym+ or +str+ is not a valid constant name a +NameError+ will be raised with a warning "wrong constant name". Object.const_set('foobar', 42) #=> NameError: wrong constant name foobar ;T;[o;= ;3I" overload;F;40;;Ž;50;)I"const_set(sym, obj);T;IC;";T; @þP;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @þP;[;I"@return [Object];T;0;6i;[[I"sym;T0[I"obj;T0; @þPo;= ;3I" overload;F;40;;Ž;50;)I"const_set(str, obj);T;IC;";T; @þP;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @þP;[;I"@return [Object];T;0;6i;[[I"str;T0[I"obj;T0; @þP;[;I"ASets the named constant to the given object, returning that object. Creates a new constant if no constant with the given name previously existed. Math.const_set("HIGH_SCHOOL_PI", 22.0/7.0) #=> 3.14285714285714 Math::HIGH_SCHOOL_PI - Math::PI #=> 0.00126448926734968 If +sym+ or +str+ is not a valid constant name a +NameError+ will be raised with a warning "wrong constant name". Object.const_set('foobar', 42) #=> NameError: wrong constant name foobar @overload const_set(sym, obj) @return [Object] @overload const_set(str, obj) @return [Object];T;0; @þP;!F;"o;#;$T;%iÔ ;&iå ;'@ªH;(I"Ëstatic VALUE rb_mod_const_set(VALUE mod, VALUE name, VALUE value) { ID id = id_for_var(mod, name, const); if (!id) id = rb_intern_str(name); rb_const_set(mod, id, value); return value; };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#const_defined?;F;[[@c0;[[@Ìi ;T;:const_defined?;0;[;{;IC;"ÛSays whether _mod_ or its ancestors have a constant with the given name: Float.const_defined?(:EPSILON) #=> true, found in Float itself Float.const_defined?("String") #=> true, found in Object (ancestor) BasicObject.const_defined?(:Hash) #=> false If _mod_ is a +Module+, additionally +Object+ and its ancestors are checked: Math.const_defined?(:String) #=> true, found in Object In each of the checked classes or modules, if the constant is not present but there is an autoload for it, +true+ is returned directly without autoloading: module Admin autoload :User, 'admin/user' end Admin.const_defined?(:User) #=> true If the constant is not found the callback +const_missing+ is *not* called and the method returns +false+. If +inherit+ is false, the lookup only checks the constants in the receiver: IO.const_defined?(:SYNC) #=> true, found in File::Constants (ancestor) IO.const_defined?(:SYNC, false) #=> false, not found in IO itself In this case, the same logic for autoloading applies. If the argument is not a valid constant name a +NameError+ is raised with the message "wrong constant name _name_": Hash.const_defined? 'foobar' #=> NameError: wrong constant name foobar;T;[o;= ;3I" overload;F;40;;;50;)I"&const_defined?(sym, inherit=true);T;IC;";T; @2Q;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @2Q;[;I"@return [Boolean];T;0;6i;[[I"sym;T0[I"inherit;TI" true;T; @2Qo;= ;3I" overload;F;40;;;50;)I"&const_defined?(str, inherit=true);T;IC;";T; @2Q;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @2Q;[;I"@return [Boolean];T;0;6i;[[I"str;T0[I"inherit;TI" true;T; @2Q;[;I"^Says whether _mod_ or its ancestors have a constant with the given name: Float.const_defined?(:EPSILON) #=> true, found in Float itself Float.const_defined?("String") #=> true, found in Object (ancestor) BasicObject.const_defined?(:Hash) #=> false If _mod_ is a +Module+, additionally +Object+ and its ancestors are checked: Math.const_defined?(:String) #=> true, found in Object In each of the checked classes or modules, if the constant is not present but there is an autoload for it, +true+ is returned directly without autoloading: module Admin autoload :User, 'admin/user' end Admin.const_defined?(:User) #=> true If the constant is not found the callback +const_missing+ is *not* called and the method returns +false+. If +inherit+ is false, the lookup only checks the constants in the receiver: IO.const_defined?(:SYNC) #=> true, found in File::Constants (ancestor) IO.const_defined?(:SYNC, false) #=> false, not found in IO itself In this case, the same logic for autoloading applies. If the argument is not a valid constant name a +NameError+ is raised with the message "wrong constant name _name_": Hash.const_defined? 'foobar' #=> NameError: wrong constant name foobar @overload const_defined?(sym, inherit=true) @return [Boolean] @overload const_defined?(str, inherit=true) @return [Boolean];T;0; @2Q;!F;"o;#;$T;%iñ ;&i ;6i;'@ªH;(I"§ static VALUE rb_mod_const_defined(int argc, VALUE *argv, VALUE mod) { VALUE name, recur; rb_encoding *enc; const char *pbeg, *p, *path, *pend; ID id; rb_check_arity(argc, 1, 2); name = argv[0]; recur = (argc == 1) ? Qtrue : argv[1]; if (SYMBOL_P(name)) { if (!rb_is_const_sym(name)) goto wrong_name; id = rb_check_id(&name); if (!id) return Qfalse; return RTEST(recur) ? rb_const_defined(mod, id) : rb_const_defined_at(mod, id); } path = StringValuePtr(name); enc = rb_enc_get(name); if (!rb_enc_asciicompat(enc)) { rb_raise(rb_eArgError, "invalid class path encoding (non ASCII)"); } pbeg = p = path; pend = path + RSTRING_LEN(name); if (p >= pend || !*p) { goto wrong_name; } if (p + 2 < pend && p[0] == ':' && p[1] == ':') { mod = rb_cObject; p += 2; pbeg = p; } while (p < pend) { VALUE part; long len, beglen; while (p < pend && *p != ':') p++; if (pbeg == p) goto wrong_name; id = rb_check_id_cstr(pbeg, len = p-pbeg, enc); beglen = pbeg-path; if (p < pend && p[0] == ':') { if (p + 2 >= pend || p[1] != ':') goto wrong_name; p += 2; pbeg = p; } if (!id) { part = rb_str_subseq(name, beglen, len); OBJ_FREEZE(part); if (!rb_is_const_name(part)) { name = part; goto wrong_name; } else { return Qfalse; } } if (!rb_is_const_id(id)) { name = ID2SYM(id); goto wrong_name; } #if 0 mod = rb_const_search(mod, id, beglen > 0 || !RTEST(recur), RTEST(recur), FALSE); if (mod == Qundef) return Qfalse; #else if (!RTEST(recur)) { if (!rb_const_defined_at(mod, id)) return Qfalse; if (p == pend) return Qtrue; mod = rb_const_get_at(mod, id); } else if (beglen == 0) { if (!rb_const_defined(mod, id)) return Qfalse; if (p == pend) return Qtrue; mod = rb_const_get(mod, id); } else { if (!rb_const_defined_from(mod, id)) return Qfalse; if (p == pend) return Qtrue; mod = rb_const_get_from(mod, id); } #endif if (p < pend && !RB_TYPE_P(mod, T_MODULE) && !RB_TYPE_P(mod, T_CLASS)) { rb_raise(rb_eTypeError, "%"PRIsVALUE" does not refer to class/module", QUOTE(name)); } } return Qtrue; wrong_name: rb_name_err_raise(wrong_constant_name, mod, name); UNREACHABLE_RETURN(Qundef); };T;)I"static VALUE;T;*To;;F; ;;;;I"!Module#const_source_location;F;[[@c0;[[@Ìiº ;T;:const_source_location;0;[;{;IC;"ºReturns the Ruby source filename and line number containing the definition of the constant specified. If the named constant is not found, +nil+ is returned. If the constant is found, but its source location can not be extracted (constant is defined in C code), empty array is returned. _inherit_ specifies whether to lookup in mod.ancestors (+true+ by default). # test.rb: class A # line 1 C1 = 1 C2 = 2 end module M # line 6 C3 = 3 end class B < A # line 10 include M C4 = 4 end class A # continuation of A definition C2 = 8 # constant redefinition; warned yet allowed end p B.const_source_location('C4') # => ["test.rb", 12] p B.const_source_location('C3') # => ["test.rb", 7] p B.const_source_location('C1') # => ["test.rb", 2] p B.const_source_location('C3', false) # => nil -- don't lookup in ancestors p A.const_source_location('C2') # => ["test.rb", 16] -- actual (last) definition place p Object.const_source_location('B') # => ["test.rb", 10] -- top-level constant could be looked through Object p Object.const_source_location('A') # => ["test.rb", 1] -- class reopening is NOT considered new definition p B.const_source_location('A') # => ["test.rb", 1] -- because Object is in ancestors p M.const_source_location('A') # => ["test.rb", 1] -- Object is not ancestor, but additionally checked for modules p Object.const_source_location('A::C1') # => ["test.rb", 2] -- nesting is supported p Object.const_source_location('String') # => [] -- constant is defined in C code ;T;[o;= ;3I" overload;F;40;;;50;)I"-const_source_location(sym, inherit=true);T;IC;";T; @eQ;>0;!F;[o;2 ;3I"return;F;4I"];T;0;5[I" Array;TI"Integer;T; @eQ;[;I"@return [Array, Integer]];T;0;6i;[[I"sym;T0[I"inherit;TI" true;T; @eQo;= ;3I" overload;F;40;;;50;)I"-const_source_location(str, inherit=true);T;IC;";T; @eQ;>0;!F;[o;2 ;3I"return;F;4I"];T;0;5[I" Array;TI"Integer;T; @eQ;[;I"@return [Array, Integer]];T;0;6i;[[I"str;T0[I"inherit;TI" true;T; @eQ;[;I"^Returns the Ruby source filename and line number containing the definition of the constant specified. If the named constant is not found, +nil+ is returned. If the constant is found, but its source location can not be extracted (constant is defined in C code), empty array is returned. _inherit_ specifies whether to lookup in mod.ancestors (+true+ by default). # test.rb: class A # line 1 C1 = 1 C2 = 2 end module M # line 6 C3 = 3 end class B < A # line 10 include M C4 = 4 end class A # continuation of A definition C2 = 8 # constant redefinition; warned yet allowed end p B.const_source_location('C4') # => ["test.rb", 12] p B.const_source_location('C3') # => ["test.rb", 7] p B.const_source_location('C1') # => ["test.rb", 2] p B.const_source_location('C3', false) # => nil -- don't lookup in ancestors p A.const_source_location('C2') # => ["test.rb", 16] -- actual (last) definition place p Object.const_source_location('B') # => ["test.rb", 10] -- top-level constant could be looked through Object p Object.const_source_location('A') # => ["test.rb", 1] -- class reopening is NOT considered new definition p B.const_source_location('A') # => ["test.rb", 1] -- because Object is in ancestors p M.const_source_location('A') # => ["test.rb", 1] -- Object is not ancestor, but additionally checked for modules p Object.const_source_location('A::C1') # => ["test.rb", 2] -- nesting is supported p Object.const_source_location('String') # => [] -- constant is defined in C code @overload const_source_location(sym, inherit=true) @return [Array, Integer]] @overload const_source_location(str, inherit=true) @return [Array, Integer]];T;0; @eQ;!F;"o;#;$T;%i‡ ;&i¹ ;'@ªH;(I"þ static VALUE rb_mod_const_source_location(int argc, VALUE *argv, VALUE mod) { VALUE name, recur, loc = Qnil; rb_encoding *enc; const char *pbeg, *p, *path, *pend; ID id; rb_check_arity(argc, 1, 2); name = argv[0]; recur = (argc == 1) ? Qtrue : argv[1]; if (SYMBOL_P(name)) { if (!rb_is_const_sym(name)) goto wrong_name; id = rb_check_id(&name); if (!id) return Qnil; return RTEST(recur) ? rb_const_source_location(mod, id) : rb_const_source_location_at(mod, id); } path = StringValuePtr(name); enc = rb_enc_get(name); if (!rb_enc_asciicompat(enc)) { rb_raise(rb_eArgError, "invalid class path encoding (non ASCII)"); } pbeg = p = path; pend = path + RSTRING_LEN(name); if (p >= pend || !*p) { goto wrong_name; } if (p + 2 < pend && p[0] == ':' && p[1] == ':') { mod = rb_cObject; p += 2; pbeg = p; } while (p < pend) { VALUE part; long len, beglen; while (p < pend && *p != ':') p++; if (pbeg == p) goto wrong_name; id = rb_check_id_cstr(pbeg, len = p-pbeg, enc); beglen = pbeg-path; if (p < pend && p[0] == ':') { if (p + 2 >= pend || p[1] != ':') goto wrong_name; p += 2; pbeg = p; } if (!id) { part = rb_str_subseq(name, beglen, len); OBJ_FREEZE(part); if (!rb_is_const_name(part)) { name = part; goto wrong_name; } else { return Qnil; } } if (!rb_is_const_id(id)) { name = ID2SYM(id); goto wrong_name; } if (p < pend) { if (RTEST(recur)) { mod = rb_const_get(mod, id); } else { mod = rb_const_get_at(mod, id); } if (!RB_TYPE_P(mod, T_MODULE) && !RB_TYPE_P(mod, T_CLASS)) { rb_raise(rb_eTypeError, "%"PRIsVALUE" does not refer to class/module", QUOTE(name)); } } else { if (RTEST(recur)) { loc = rb_const_source_location(mod, id); } else { loc = rb_const_source_location_at(mod, id); } break; } recur = Qfalse; } return loc; wrong_name: rb_name_err_raise(wrong_constant_name, mod, name); UNREACHABLE_RETURN(Qundef); };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Module#remove_const;F;[[I" name;T0;[[@§i› ;T;:remove_const;0;[;{;IC;"ÂRemoves the definition of the given constant, returning that constant's previous value. If that constant referred to a module, this will not change that module's name and can lead to confusion. ;T;[o;= ;3I" overload;F;40;;‘;50;)I"remove_const(sym);T;IC;";T; @šQ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @šQ;[;I"@return [Object];T;0;6i;[[I"sym;T0; @šQ;[;I"óRemoves the definition of the given constant, returning that constant's previous value. If that constant referred to a module, this will not change that module's name and can lead to confusion. @overload remove_const(sym) @return [Object];T;0; @šQ;!F;"o;#;$T;%i‘ ;&i˜ ;'@ªH;(I"ÌVALUE rb_mod_remove_const(VALUE mod, VALUE name) { const ID id = id_for_var(mod, name, a, constant); if (!id) { undefined_constant(mod, name); } return rb_const_remove(mod, id); };T;)I" VALUE;T;*To;;F; ;;;;I"Module#const_missing;F;[[I" name;T0;[[@§i§;T;:const_missing;0;[;{;IC;"Invoked when a reference is made to an undefined constant in mod. It is passed a symbol for the undefined constant, and returns a value to be used for that constant. The following code is an example of the same: def Foo.const_missing(name) name # return the constant name as Symbol end Foo::UNDEFINED_CONST #=> :UNDEFINED_CONST: symbol returned In the next example when a reference is made to an undefined constant, it attempts to load a file whose name is the lowercase version of the constant (thus class Fred is assumed to be in file fred.rb). If found, it returns the loaded class. It therefore implements an autoload feature similar to Kernel#autoload and Module#autoload. def Object.const_missing(name) @looked_for ||= {} str_name = name.to_s raise "Class not found: #{name}" if @looked_for[str_name] @looked_for[str_name] = 1 file = str_name.downcase require file klass = const_get(name) return klass if klass raise "Class not found: #{name}" end ;T;[o;= ;3I" overload;F;40;;’;50;)I"const_missing(sym);T;IC;";T; @¹Q;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @¹Q;[;I"@return [Object];T;0;6i;[[I"sym;T0; @¹Q;[;I"GInvoked when a reference is made to an undefined constant in mod. It is passed a symbol for the undefined constant, and returns a value to be used for that constant. The following code is an example of the same: def Foo.const_missing(name) name # return the constant name as Symbol end Foo::UNDEFINED_CONST #=> :UNDEFINED_CONST: symbol returned In the next example when a reference is made to an undefined constant, it attempts to load a file whose name is the lowercase version of the constant (thus class Fred is assumed to be in file fred.rb). If found, it returns the loaded class. It therefore implements an autoload feature similar to Kernel#autoload and Module#autoload. def Object.const_missing(name) @looked_for ||= {} str_name = name.to_s raise "Class not found: #{name}" if @looked_for[str_name] @looked_for[str_name] = 1 file = str_name.downcase require file klass = const_get(name) return klass if klass raise "Class not found: #{name}" end @overload const_missing(sym) @return [Object];T;0; @¹Q;!F;"o;#;$T;%iƒ;&i¤;'@ªH;(I"2VALUE rb_mod_const_missing(VALUE klass, VALUE name) { VALUE ref = GET_EC()->private_const_reference; rb_vm_pop_cfunc_frame(); if (ref) { rb_name_err_raise("private constant %2$s::%1$s referenced", ref, name); } uninitialized_constant(klass, name); UNREACHABLE_RETURN(Qnil); };T;)I" VALUE;T;*To;;F; ;;;;I"Module#class_variables;F;[[@c0;[[@§i· ;T;:class_variables;0;[;{;IC;"§Returns an array of the names of class variables in mod. This includes the names of class variables in any included modules, unless the inherit parameter is set to false. class One @@var1 = 1 end class Two < One @@var2 = 2 end One.class_variables #=> [:@@var1] Two.class_variables #=> [:@@var2, :@@var1] Two.class_variables(false) #=> [:@@var2] ;T;[o;= ;3I" overload;F;40;;“;50;)I""class_variables(inherit=true);T;IC;";T; @ØQ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ØQ;[;I"@return [Array];T;0;6i;[[I"inherit;TI" true;T; @ØQ;[;I"ãReturns an array of the names of class variables in mod. This includes the names of class variables in any included modules, unless the inherit parameter is set to false. class One @@var1 = 1 end class Two < One @@var2 = 2 end One.class_variables #=> [:@@var1] Two.class_variables #=> [:@@var2, :@@var1] Two.class_variables(false) #=> [:@@var2] @overload class_variables(inherit=true) @return [Array];T;0; @ØQ;!F;"o;#;$T;%i£ ;&i´ ;'@ªH;(I"0VALUE rb_mod_class_variables(int argc, const VALUE *argv, VALUE mod) { bool inherit = true; st_table *tbl; if (rb_check_arity(argc, 0, 1)) inherit = RTEST(argv[0]); if (inherit) { tbl = mod_cvar_of(mod, 0); } else { tbl = mod_cvar_at(mod, 0); } return cvar_list(tbl); };T;)I" VALUE;T;*To;;F; ;;;;I"!Module#remove_class_variable;F;[[I" name;T0;[[@§iÚ ;T;:remove_class_variable;0;[;{;IC;"ÞRemoves the named class variable from the receiver, returning that variable's value. class Example @@var = 99 puts remove_class_variable(:@@var) p(defined? @@var) end produces: 99 nil ;T;[o;= ;3I" overload;F;40;;”;50;)I"remove_class_variable(sym);T;IC;";T; @÷Q;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @÷Q;[;I"@return [Object];T;0;6i;[[I"sym;T0; @÷Q;[;I"Removes the named class variable from the receiver, returning that variable's value. class Example @@var = 99 puts remove_class_variable(:@@var) p(defined? @@var) end produces: 99 nil @overload remove_class_variable(sym) @return [Object];T;0; @÷Q;!F;"o;#;$T;%iÇ ;&i× ;'@ªH;(I"VVALUE rb_mod_remove_cvar(VALUE mod, VALUE name) { const ID id = id_for_var_message(mod, name, class, "wrong class variable name %1$s"); st_data_t val, n = id; if (!id) { goto not_defined; } rb_check_frozen(mod); if (RCLASS_IV_TBL(mod) && st_delete(RCLASS_IV_TBL(mod), &n, &val)) { return (VALUE)val; } if (rb_cvar_defined(mod, id)) { rb_name_err_raise("cannot remove %1$s for %2$s", mod, ID2SYM(id)); } not_defined: rb_name_err_raise("class variable %1$s not defined for %2$s", mod, name); UNREACHABLE_RETURN(Qundef); };T;)I" VALUE;T;*To;;F; ;;;;I"Module#class_variable_get;F;[[I"iv;T0;[[@Ìi;T;:class_variable_get;0;[;{;IC;"-Returns the value of the given class variable (or throws a NameError exception). The @@ part of the variable name should be included for regular class variables. String arguments are converted to symbols. class Fred @@foo = 99 end Fred.class_variable_get(:@@foo) #=> 99 ;T;[o;= ;3I" overload;F;40;;•;50;)I"class_variable_get(symbol);T;IC;";T; @R;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @R;[;I"@return [Object];T;0;6i;[[I"symbol;T0; @Ro;= ;3I" overload;F;40;;•;50;)I"class_variable_get(string);T;IC;";T; @R;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @R;[;I"@return [Object];T;0;6i;[[I"string;T0; @R;[;I"ŸReturns the value of the given class variable (or throws a NameError exception). The @@ part of the variable name should be included for regular class variables. String arguments are converted to symbols. class Fred @@foo = 99 end Fred.class_variable_get(:@@foo) #=> 99 @overload class_variable_get(symbol) @return [Object] @overload class_variable_get(string) @return [Object];T;0; @R;!F;"o;#;$T;%i;&i;'@ªH;(I"ãstatic VALUE rb_mod_cvar_get(VALUE obj, VALUE iv) { ID id = id_for_var(obj, iv, class); if (!id) { rb_name_err_raise("uninitialized class variable %1$s in %2$s", obj, iv); } return rb_cvar_get(obj, id); };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#class_variable_set;F;[[I"iv;T0[I"val;T0;[[@Ìi¯;T;:class_variable_set;0;[;{;IC;"LSets the class variable named by symbol to the given object. If the class variable name is passed as a string, that string is converted to a symbol. class Fred @@foo = 99 def foo @@foo end end Fred.class_variable_set(:@@foo, 101) #=> 101 Fred.new.foo #=> 101 ;T;[o;= ;3I" overload;F;40;;–;50;)I"$class_variable_set(symbol, obj);T;IC;";T; @DR;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @DR;[;I"@return [Object];T;0;6i;[[I"symbol;T0[I"obj;T0; @DRo;= ;3I" overload;F;40;;–;50;)I"$class_variable_set(string, obj);T;IC;";T; @DR;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @DR;[;I"@return [Object];T;0;6i;[[I"string;T0[I"obj;T0; @DR;[;I"ÈSets the class variable named by symbol to the given object. If the class variable name is passed as a string, that string is converted to a symbol. class Fred @@foo = 99 def foo @@foo end end Fred.class_variable_set(:@@foo, 101) #=> 101 Fred.new.foo #=> 101 @overload class_variable_set(symbol, obj) @return [Object] @overload class_variable_set(string, obj) @return [Object];T;0; @DR;!F;"o;#;$T;%i›;&i;'@ªH;(I"¼static VALUE rb_mod_cvar_set(VALUE obj, VALUE iv, VALUE val) { ID id = id_for_var(obj, iv, class); if (!id) id = rb_intern_str(iv); rb_cvar_set(obj, id, val); return val; };T;)I"static VALUE;T;*To;;F; ;;;;I"#Module#class_variable_defined?;F;[[I"iv;T0;[[@ÌiÈ;T;:class_variable_defined?;0;[;{;IC;" Returns true if the given class variable is defined in obj. String arguments are converted to symbols. class Fred @@foo = 99 end Fred.class_variable_defined?(:@@foo) #=> true Fred.class_variable_defined?(:@@bar) #=> false;T;[o;= ;3I" overload;F;40;;—;50;)I"$class_variable_defined?(symbol);T;IC;";T; @xR;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @xR;[;I"@return [Boolean];T;0;6i;[[I"symbol;T0; @xRo;= ;3I" overload;F;40;;—;50;)I"$class_variable_defined?(string);T;IC;";T; @xR;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @xR;[;I"@return [Boolean];T;0;6i;[[I"string;T0; @xR;[;I"‡Returns true if the given class variable is defined in obj. String arguments are converted to symbols. class Fred @@foo = 99 end Fred.class_variable_defined?(:@@foo) #=> true Fred.class_variable_defined?(:@@bar) #=> false @overload class_variable_defined?(symbol) @return [Boolean] @overload class_variable_defined?(string) @return [Boolean];T;0; @xR;!F;"o;#;$T;%i¸;&iÆ;6i;'@ªH;(I"¬static VALUE rb_mod_cvar_defined(VALUE obj, VALUE iv) { ID id = id_for_var(obj, iv, class); if (!id) { return Qfalse; } return rb_cvar_defined(obj, id); };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#public_constant;F;[[@c0;[[@§i¶;T;:public_constant;0;[;{;IC;"/Makes a list of existing constants public. ;T;[o;= ;3I" overload;F;40;;˜;50;)I"!public_constant(symbol, ...);T;IC;";T; @¦R;>0;!F;[;[;I";T;0;6i;[[I"symbol;T0[I"...;T0; @¦R;[;I"XMakes a list of existing constants public. @overload public_constant(symbol, ...);T;0; @¦R;!F;"o;#;$T;%i¯;&i²;'@ªH;(I"¨VALUE rb_mod_public_constant(int argc, const VALUE *argv, VALUE obj) { set_const_visibility(obj, argc, argv, CONST_PUBLIC, CONST_VISIBILITY_MASK); return obj; };T;)I" VALUE;T;*To;;F; ;;;;I"Module#private_constant;F;[[@c0;[[@§i¨;T;:private_constant;0;[;{;IC;"0Makes a list of existing constants private. ;T;[o;= ;3I" overload;F;40;;™;50;)I""private_constant(symbol, ...);T;IC;";T; @ÁR;>0;!F;[;[;I";T;0;6i;[[I"symbol;T0[I"...;T0; @ÁR;[;I"ZMakes a list of existing constants private. @overload private_constant(symbol, ...);T;0; @ÁR;!F;"o;#;$T;%i¡;&i¤;'@ªH;(I"ªVALUE rb_mod_private_constant(int argc, const VALUE *argv, VALUE obj) { set_const_visibility(obj, argc, argv, CONST_PRIVATE, CONST_VISIBILITY_MASK); return obj; };T;)I" VALUE;T;*To;;F; ;;;;I"Module#deprecate_constant;F;[[@c0;[[@§iÐ;T;:deprecate_constant;0;[;{;IC;"LMakes a list of existing constants deprecated. Attempt to refer to them will produce a warning. module HTTP NotFound = Exception.new NOT_FOUND = NotFound # previous version of the library used this name deprecate_constant :NOT_FOUND end HTTP::NOT_FOUND # warning: constant HTTP::NOT_FOUND is deprecated ;T;[o;= ;3I" overload;F;40;;š;50;)I"$deprecate_constant(symbol, ...);T;IC;";T; @ÜR;>0;!F;[;[;I";T;0;6i;[[I"symbol;T0[I"...;T0; @ÜR;[;I"yMakes a list of existing constants deprecated. Attempt to refer to them will produce a warning. module HTTP NotFound = Exception.new NOT_FOUND = NotFound # previous version of the library used this name deprecate_constant :NOT_FOUND end HTTP::NOT_FOUND # warning: constant HTTP::NOT_FOUND is deprecated @overload deprecate_constant(symbol, ...);T;0; @ÜR;!F;"o;#;$T;%i½;&iÌ;'@ªH;(I"ªVALUE rb_mod_deprecate_constant(int argc, const VALUE *argv, VALUE obj) { set_const_visibility(obj, argc, argv, CONST_DEPRECATED, CONST_DEPRECATED); return obj; };T;)I" VALUE;T;*To;;F; ;;;;I"Module#singleton_class?;F;[;[[@Ìià;T;:singleton_class?;0;[;{;IC;"ìReturns true if mod is a singleton class or false if it is an ordinary class or module. class C end C.singleton_class? #=> false C.singleton_class.singleton_class? #=> true;T;[o;= ;3I" overload;F;40;;›;50;)I"singleton_class?;T;IC;";T; @÷R;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @÷R;[;I"@return [Boolean];T;0;6i;[; @÷R;[;I"Returns true if mod is a singleton class or false if it is an ordinary class or module. class C end C.singleton_class? #=> false C.singleton_class.singleton_class? #=> true @overload singleton_class? @return [Boolean];T;0; @÷R;!F;"o;#;$T;%iÓ;&iÝ;6i;'@ªH;(I"•static VALUE rb_mod_singleton_p(VALUE klass) { if (RB_TYPE_P(klass, T_CLASS) && FL_TEST(klass, FL_SINGLETON)) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#instance_method;F;[[I"vid;T0;[[@i7;T;:instance_method;0;[;{;IC;"}Returns an +UnboundMethod+ representing the given instance method in _mod_. class Interpreter def do_a() print "there, "; end def do_d() print "Hello "; end def do_e() print "!\n"; end def do_v() print "Dave"; end Dispatcher = { "a" => instance_method(:do_a), "d" => instance_method(:do_d), "e" => instance_method(:do_e), "v" => instance_method(:do_v) } def interpret(string) string.each_char {|b| Dispatcher[b].bind(self).call } end end interpreter = Interpreter.new interpreter.interpret('dave') produces: Hello there, Dave! ;T;[o;= ;3I" overload;F;40;;œ;50;)I"instance_method(symbol);T;IC;";T; @S;>0;!F;[;[;I";T;0;6i;[[I"symbol;T0; @S;[;I"¡Returns an +UnboundMethod+ representing the given instance method in _mod_. class Interpreter def do_a() print "there, "; end def do_d() print "Hello "; end def do_e() print "!\n"; end def do_v() print "Dave"; end Dispatcher = { "a" => instance_method(:do_a), "d" => instance_method(:do_d), "e" => instance_method(:do_e), "v" => instance_method(:do_v) } def interpret(string) string.each_char {|b| Dispatcher[b].bind(self).call } end end interpreter = Interpreter.new interpreter.interpret('dave') produces: Hello there, Dave! @overload instance_method(symbol);T;0; @S;!F;"o;#;$T;%i;&i3;'@ªH;(I"Îstatic VALUE rb_mod_instance_method(VALUE mod, VALUE vid) { ID id = rb_check_id(&vid); if (!id) { rb_method_name_error(mod, vid); } return mnew(mod, Qundef, id, rb_cUnboundMethod, FALSE); };T;)I"static VALUE;T;*To;;F; ;;;;I""Module#public_instance_method;F;[[I"vid;T0;[[@iH;T;:public_instance_method;0;[;{;IC;"?Similar to _instance_method_, searches public method only. ;T;[o;= ;3I" overload;F;40;;;50;)I"#public_instance_method(symbol);T;IC;";T; @,S;>0;!F;[;[;I";T;0;6i;[[I"symbol;T0; @,S;[;I"jSimilar to _instance_method_, searches public method only. @overload public_instance_method(symbol);T;0; @,S;!F;"o;#;$T;%iA;&iD;'@ªH;(I"Ôstatic VALUE rb_mod_public_instance_method(VALUE mod, VALUE vid) { ID id = rb_check_id(&vid); if (!id) { rb_method_name_error(mod, vid); } return mnew(mod, Qundef, id, rb_cUnboundMethod, TRUE); };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#define_method;F;[[@c0;[[@iz;T;:define_method;0;[;{;IC;"?Defines an instance 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. If a block or the _method_ parameter has parameters, they're used as method parameters. This block is evaluated using #instance_eval. class A def fred puts "In Fred" end def create_method(name, &block) self.class.define_method(name, &block) end define_method(:wilma) { puts "Charge it!" } define_method(:flint) {|name| puts "I'm #{name}!"} end class B < A define_method(:barney, instance_method(:fred)) end a = B.new a.barney a.wilma a.flint('Dino') a.create_method(:betty) { p self } a.betty produces: In Fred Charge it! I'm Dino! # ;T;[o;= ;3I" overload;F;40;;ž;50;)I""define_method(symbol, method);T;IC;";T; @FS;>0;!F;[;[;I";T;0;6i;[[I"symbol;T0[I"method;T0; @FSo;= ;3I" overload;F;40;;ž;50;)I"define_method(symbol);T;IC;";T; @FS;>0;!F;[o;2 ;3I" yield;F;4I"[];T;0;50; @FS;[;I"@yield [];T;0;6i;[[I"symbol;T0; @FS;[;I"•Defines an instance 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. If a block or the _method_ parameter has parameters, they're used as method parameters. This block is evaluated using #instance_eval. class A def fred puts "In Fred" end def create_method(name, &block) self.class.define_method(name, &block) end define_method(:wilma) { puts "Charge it!" } define_method(:flint) {|name| puts "I'm #{name}!"} end class B < A define_method(:barney, instance_method(:fred)) end a = B.new a.barney a.wilma a.flint('Dino') a.create_method(:betty) { p self } a.betty produces: In Fred Charge it! I'm Dino! # @overload define_method(symbol, method) @overload define_method(symbol) @yield [];T;0; @FS;!F;"o;#;$T;%iR;&iw;'@ªH;(I"ÿstatic VALUE rb_mod_define_method(int argc, VALUE *argv, VALUE mod) { ID id; VALUE body; VALUE name; const rb_cref_t *cref = rb_vm_cref_in_context(mod, mod); const rb_scope_visibility_t default_scope_visi = {METHOD_VISI_PUBLIC, FALSE}; const rb_scope_visibility_t *scope_visi = &default_scope_visi; int is_method = FALSE; if (cref) { scope_visi = CREF_SCOPE_VISI(cref); } rb_check_arity(argc, 1, 2); name = argv[0]; id = rb_check_id(&name); if (argc == 1) { body = rb_block_lambda(); } else { body = argv[1]; if (rb_obj_is_method(body)) { is_method = TRUE; } else if (rb_obj_is_proc(body)) { is_method = FALSE; } else { rb_raise(rb_eTypeError, "wrong argument type %s (expected Proc/Method/UnboundMethod)", rb_obj_classname(body)); } } if (!id) id = rb_to_id(name); if (is_method) { struct METHOD *method = (struct METHOD *)DATA_PTR(body); if (method->me->owner != mod && !RB_TYPE_P(method->me->owner, T_MODULE) && !RTEST(rb_class_inherited_p(mod, method->me->owner))) { if (FL_TEST(method->me->owner, FL_SINGLETON)) { rb_raise(rb_eTypeError, "can't bind singleton method to a different class"); } else { rb_raise(rb_eTypeError, "bind argument must be a subclass of % "PRIsVALUE, method->me->owner); } } rb_method_entry_set(mod, id, method->me, scope_visi->method_visi); if (scope_visi->module_func) { rb_method_entry_set(rb_singleton_class(mod), id, method->me, METHOD_VISI_PUBLIC); } RB_GC_GUARD(body); } else { VALUE procval = rb_proc_dup(body); if (vm_proc_iseq(procval) != NULL) { rb_proc_t *proc; GetProcPtr(procval, proc); proc->is_lambda = TRUE; proc->is_from_method = TRUE; } rb_add_method(mod, id, VM_METHOD_TYPE_BMETHOD, (void *)procval, scope_visi->method_visi); if (scope_visi->module_func) { rb_add_method(rb_singleton_class(mod), id, VM_METHOD_TYPE_BMETHOD, (void *)body, METHOD_VISI_PUBLIC); } } return ID2SYM(id); };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#module_exec;F;[[@c0;[[@vi;T;:module_exec;0;[;{;IC;"Evaluates the given block in the context of the class/module. The method defined in the block will belong to the receiver. Any arguments passed to the method will be passed to the block. This can be used if the block needs to access instance variables. class Thing end Thing.class_exec{ def hello() "Hello there!" end } puts Thing.new.hello() produces: Hello there! ;T;[o;= ;3I" overload;F;40;;Ÿ;50;)I"module_exec(arg...);T;IC;";T; @nS;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"var...;T; @nSo;2 ;3I"return;F;4I";T;0;5[I"Object;T; @nS;[;I"%@yield [var...] @return [Object];T;0;6i;[[I"arg...;T0; @nSo;= ;3I" overload;F;40;:class_exec;50;)I"class_exec(arg...);T;IC;";T; @nS;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"var...;T; @nSo;2 ;3I"return;F;4I";T;0;5[I"Object;T; @nS;[;I"%@yield [var...] @return [Object];T;0;6i;[[I"arg...;T0; @nS;[;I"Evaluates the given block in the context of the class/module. The method defined in the block will belong to the receiver. Any arguments passed to the method will be passed to the block. This can be used if the block needs to access instance variables. class Thing end Thing.class_exec{ def hello() "Hello there!" end } puts Thing.new.hello() produces: Hello there! @overload module_exec(arg...) @yield [var...] @return [Object] @overload class_exec(arg...) @yield [var...] @return [Object];T;0; @nS;!F;"o;#;$T;%iy;&i;'@ªH;(I"›static VALUE rb_mod_module_exec_internal(int argc, const VALUE *argv, VALUE mod) { return yield_under(mod, mod, argc, argv, RB_PASS_CALLED_KEYWORDS); };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#class_exec;F;[[@c0;[[@vi;T;; ;0;[;{;IC;"Evaluates the given block in the context of the class/module. The method defined in the block will belong to the receiver. Any arguments passed to the method will be passed to the block. This can be used if the block needs to access instance variables. class Thing end Thing.class_exec{ def hello() "Hello there!" end } puts Thing.new.hello() produces: Hello there! ;T;[o;= ;3I" overload;F;40;;Ÿ;50;)I"module_exec(arg...);T;IC;";T; @¥S;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"var...;T; @¥So;2 ;3I"return;F;4I";T;0;5[I"Object;T; @¥S;[;I"%@yield [var...] @return [Object];T;0;6i;[[I"arg...;T0; @¥So;= ;3I" overload;F;40;; ;50;)I"class_exec(arg...);T;IC;";T; @¥S;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"var...;T; @¥So;2 ;3I"return;F;4I";T;0;5[I"Object;T; @¥S;[;I"%@yield [var...] @return [Object];T;0;6i;[[I"arg...;T0; @¥S;[;@¡S;0; @¥S;!F;"o;#;$T;%iy;&i;'@ªH;(I"›static VALUE rb_mod_module_exec_internal(int argc, const VALUE *argv, VALUE mod) { return yield_under(mod, mod, argc, argv, RB_PASS_CALLED_KEYWORDS); };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#module_eval;F;[[@c0;[[@vim;T;:module_eval;0;[;{;IC;"yEvaluates the string or block in the context of _mod_, except that when a block is given, constant/class variable lookup is not affected. This can be used to add methods to a class. module_eval returns the result of evaluating its argument. The optional _filename_ and _lineno_ parameters set the text for error messages. class Thing end a = %q{def hello() "Hello there!" end} Thing.module_eval(a) puts Thing.new.hello() Thing.module_eval("invalid code", "dummy", 123) produces: Hello there! dummy:123:in `module_eval': undefined local variable or method `code' for Thing:Class ;T;[ o;= ;3I" overload;F;40;:class_eval;50;)I"/class_eval(string [, filename [, lineno]]);T;IC;";T; @ÛS;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @ÛS;[;I"@return [Object];T;0;6i;[[I""string[, filename [, lineno]];T0; @ÛSo;= ;3I" overload;F;40;;¢;50;)I"class_eval;T;IC;";T; @ÛS;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"mod;T; @ÛSo;2 ;3I"return;F;4I";T;0;5[I"Object;T; @ÛS;[;I""@yield [mod] @return [Object];T;0;6i;[; @ÛSo;= ;3I" overload;F;40;;¡;50;)I"0module_eval(string [, filename [, lineno]]);T;IC;";T; @ÛS;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @ÛS;[;I"@return [Object];T;0;6i;[[I""string[, filename [, lineno]];T0; @ÛSo;= ;3I" overload;F;40;;¡;50;)I"module_eval;T;IC;";T; @ÛS;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"mod;T; @ÛSo;2 ;3I"return;F;4I";T;0;5[I"Object;T; @ÛS;[;I""@yield [mod] @return [Object];T;0;6i;[; @ÛS;[;I"{Evaluates the string or block in the context of _mod_, except that when a block is given, constant/class variable lookup is not affected. This can be used to add methods to a class. module_eval returns the result of evaluating its argument. The optional _filename_ and _lineno_ parameters set the text for error messages. class Thing end a = %q{def hello() "Hello there!" end} Thing.module_eval(a) puts Thing.new.hello() Thing.module_eval("invalid code", "dummy", 123) produces: Hello there! dummy:123:in `module_eval': undefined local variable or method `code' for Thing:Class @overload class_eval(string [, filename [, lineno]]) @return [Object] @overload class_eval @yield [mod] @return [Object] @overload module_eval(string [, filename [, lineno]]) @return [Object] @overload module_eval @yield [mod] @return [Object];T;0; @ÛS;!F;"o;#;$T;%iR;&io;'@ªH;(I"static VALUE rb_mod_module_eval_internal(int argc, const VALUE *argv, VALUE mod) { return specific_eval(argc, argv, mod, mod, RB_PASS_CALLED_KEYWORDS); };T;)I"static VALUE;T;*To;;F; ;;;;I"Module#class_eval;F;[[@c0;[[@vim;T;;¢;0;[;{;IC;"yEvaluates the string or block in the context of _mod_, except that when a block is given, constant/class variable lookup is not affected. This can be used to add methods to a class. module_eval returns the result of evaluating its argument. The optional _filename_ and _lineno_ parameters set the text for error messages. class Thing end a = %q{def hello() "Hello there!" end} Thing.module_eval(a) puts Thing.new.hello() Thing.module_eval("invalid code", "dummy", 123) produces: Hello there! dummy:123:in `module_eval': undefined local variable or method `code' for Thing:Class ;T;[ o;= ;3I" overload;F;40;;¢;50;)I"/class_eval(string [, filename [, lineno]]);T;IC;";T; @,T;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @,T;[;I"@return [Object];T;0;6i;[[I""string[, filename [, lineno]];T0; @,To;= ;3I" overload;F;40;;¢;50;)I"class_eval;T;IC;";T; @,T;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"mod;T; @,To;2 ;3I"return;F;4I";T;0;5[I"Object;T; @,T;[;I""@yield [mod] @return [Object];T;0;6i;[; @,To;= ;3I" overload;F;40;;¡;50;)I"0module_eval(string [, filename [, lineno]]);T;IC;";T; @,T;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @,T;[;I"@return [Object];T;0;6i;[[I""string[, filename [, lineno]];T0; @,To;= ;3I" overload;F;40;;¡;50;)I"module_eval;T;IC;";T; @,T;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"mod;T; @,To;2 ;3I"return;F;4I";T;0;5[I"Object;T; @,T;[;I""@yield [mod] @return [Object];T;0;6i;[; @,T;[;@(T;0; @,T;!F;"o;#;$T;%iR;&io;'@ªH;(I"static VALUE rb_mod_module_eval_internal(int argc, const VALUE *argv, VALUE mod) { return specific_eval(argc, argv, mod, mod, RB_PASS_CALLED_KEYWORDS); };T;)I"static VALUE;T;*T;A@ªH;BIC;[;A@ªH;CIC;[;A@ªH;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@ŽN;q;I[;[[@Ìih[@i‘[@Ìi;T;:Module;;K;;;[;{;IC;"F********************************************************************* A Module is a collection of methods and constants. The methods in a module may be instance methods or module methods. Instance methods appear as methods in a class when the module is included, module methods do not. Conversely, module methods may be called without creating an encapsulating object, while instance methods may not. (See Module#module_function.) In the descriptions that follow, the parameter sym refers to a symbol, which is either a quoted string or a Symbol (such as :name). module Mod include Math CONST = 1 def meth # ... end end Mod.class #=> Module Mod.constants #=> [:CONST, :PI, :E] Mod.instance_methods #=> [:meth];T;[;[;I"H********************************************************************* A Module is a collection of methods and constants. The methods in a module may be instance methods or module methods. Instance methods appear as methods in a class when the module is included, module methods do not. Conversely, module methods may be called without creating an encapsulating object, while instance methods may not. (See Module#module_function.) In the descriptions that follow, the parameter sym refers to a symbol, which is either a quoted string or a Symbol (such as :name). module Mod include Math CONST = 1 def meth # ... end end Mod.class #=> Module Mod.constants #=> [:CONST, :PI, :E] Mod.instance_methods #=> [:meth] ;T;0; @ªH;!F;"o;#;$T;%ih;&i;6i;'@;I"Module;F;S@]o; ;IC;[So;;F; ;F;;;I"Hash.[];F;[[@c0;[[I"hash.c;Ti;T;;Â;0;[;{;IC;"Returns a new \Hash object populated with the given objects, if any. See Hash::new. With no argument, returns a new empty \Hash. When the single given argument is a \Hash, returns a new \Hash populated with the entries from the given \Hash. h = {foo: 0, bar: 1, baz: 2} Hash[h] # => {:foo=>0, :bar=>1, :baz=>2} When the single given argument is an \Array of 2-element Arrays, returns a new \Hash object wherein each 2-element array forms a key-value entry: Hash[ [ [:foo, 0], [:bar, 1] ] ] # => {:foo=>0, :bar=>1} When the argument count is an even number; returns a new \Hash object wherein each successive pair of arguments has become a key-value entry: Hash[:foo, 0, :bar, 1] # => {:foo=>0, :bar=>1} Raises an exception if the argument list does not conform to any of the above. ;T;[ o;= ;3I" overload;F;40;;¼;50;)I"Hash[];T;IC;";T; @‘T;>0;!F;[;[;I";T;0;6i;[; @‘To;= ;3I" overload;F;40;;Â;50;)I" [](hash);T;IC;";T; @‘T;>0;!F;[;[;I";T;0;6i;[[I" hash;T0; @‘To;= ;3I" overload;F;40;;Â;50;)I"[]( [*2_element_arrays);T;IC;";T; @‘T;>0;!F;[;[;I";T;0;6i;[[I"[*2_element_arrays);T0; @‘To;= ;3I" overload;F;40;;Â;50;)I"[](*objects);T;IC;";T; @‘T;>0;!F;[;[;I";T;0;6i;[[I" *objects;T0; @‘T;[;I"yReturns a new \Hash object populated with the given objects, if any. See Hash::new. With no argument, returns a new empty \Hash. When the single given argument is a \Hash, returns a new \Hash populated with the entries from the given \Hash. h = {foo: 0, bar: 1, baz: 2} Hash[h] # => {:foo=>0, :bar=>1, :baz=>2} When the single given argument is an \Array of 2-element Arrays, returns a new \Hash object wherein each 2-element array forms a key-value entry: Hash[ [ [:foo, 0], [:bar, 1] ] ] # => {:foo=>0, :bar=>1} When the argument count is an even number; returns a new \Hash object wherein each successive pair of arguments has become a key-value entry: Hash[:foo, 0, :bar, 1] # => {:foo=>0, :bar=>1} Raises an exception if the argument list does not conform to any of the above. @overload Hash[] @overload [](hash) @overload []( [*2_element_arrays) @overload [](*objects);T;0; @‘T;!F;"o;#;$T;%iÿ;&i;'@T;(I"ƒstatic VALUE rb_hash_s_create(int argc, VALUE *argv, VALUE klass) { VALUE hash, tmp; if (argc == 1) { tmp = rb_hash_s_try_convert(Qnil, argv[0]); if (!NIL_P(tmp)) { hash = hash_alloc(klass); hash_copy(hash, tmp); 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)) { rb_raise(rb_eArgError, "wrong element type %s at %ld (expected array)", rb_builtin_class_name(e), i); } 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); rb_hash_bulk_insert(argc, argv, hash); hash_verify(hash); return hash; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Hash.try_convert;F;[[I" hash;T0;[[@—Tii;T;:try_convert;0;[;{;IC;"If +obj+ is a \Hash object, returns +obj+. Otherwise if +obj+ responds to :to_hash, calls obj.to_hash and returns the result. Returns +nil+ if +obj+ does not respond to :to_hash Raises an exception unless obj.to_hash returns a \Hash object. ;T;[o;= ;3I" overload;F;40;;¤;50;)I"try_convert(obj);T;IC;";T; @ÇT;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @ÇT;[;I"@return [Object, nil];T;0;6i;[[I"obj;T0; @ÇT;[;I"LIf +obj+ is a \Hash object, returns +obj+. Otherwise if +obj+ responds to :to_hash, calls obj.to_hash and returns the result. Returns +nil+ if +obj+ does not respond to :to_hash Raises an exception unless obj.to_hash returns a \Hash object. @overload try_convert(obj) @return [Object, nil];T;0; @ÇT;!F;"o;#;$T;%i\;&ig;'@T;(I"istatic VALUE rb_hash_s_try_convert(VALUE dummy, VALUE hash) { return rb_check_hash_type(hash); };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#initialize;F;[[@c0;[[@—Tië;T;;Ð;0;[;{;IC;"rReturns a new empty \Hash object. The initial default value and initial default proc for the new hash depend on which form above was used. See {Default Values}[#class-Hash-label-Default+Values]. If neither an argument nor a block given, initializes both the default value and the default proc to nil: h = Hash.new h.default # => nil h.default_proc # => nil If argument default_value given but no block given, initializes the default value to the given default_value and the default proc to nil: h = Hash.new(false) h.default # => false h.default_proc # => nil If a block given but no argument, stores the block as the default proc and sets the default value to nil: h = Hash.new {|hash, key| "Default value for #{key}" } h.default # => nil h.default_proc.class # => Proc h[:nosuch] # => "Default value for nosuch" ;T;[o;= ;3I" overload;F;40;;î;50;)I"new(default_value = nil);T;IC;";T; @çT;>0;!F;[;[;I";T;0;6i;[[I"default_value;TI"nil;T; @çTo;= ;3I" overload;F;40;;î;50;)I"new;T;IC;";T; @çT;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" hash;TI"key;T; @çT;[;I"@yield [hash, key];T;0;6i;[; @çT;[;I"ºReturns a new empty \Hash object. The initial default value and initial default proc for the new hash depend on which form above was used. See {Default Values}[#class-Hash-label-Default+Values]. If neither an argument nor a block given, initializes both the default value and the default proc to nil: h = Hash.new h.default # => nil h.default_proc # => nil If argument default_value given but no block given, initializes the default value to the given default_value and the default proc to nil: h = Hash.new(false) h.default # => false h.default_proc # => nil If a block given but no argument, stores the block as the default proc and sets the default value to nil: h = Hash.new {|hash, key| "Default value for #{key}" } h.default # => nil h.default_proc.class # => Proc h[:nosuch] # => "Default value for nosuch" @overload new(default_value = nil) @overload new @yield [hash, key];T;0; @çT;!F;"o;#;$T;%iÌ;&iè;'@T;(I"wstatic 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(); SET_PROC_DEFAULT(hash, ifnone); } else { rb_check_arity(argc, 0, 1); ifnone = argc == 0 ? Qnil : argv[0]; RHASH_SET_IFNONE(hash, ifnone); } return hash; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#initialize_copy;F;[[I" hash2;T0;[[@—Ti†;T;;g;0;[;{;IC;"®Replaces the entire contents of +self+ with the contents of +other_hash+; returns +self+: h = {foo: 0, bar: 1, baz: 2} h.replace({bat: 3, bam: 4}) # => {:bat=>3, :bam=>4} ;T;[o;= ;3I" overload;F;40;:replace;50;)I"replace(other_hash);T;IC;";T; @U;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @U;[;I"@return [self];T;0;6i;[[I"other_hash;T0; @U;[;I"ßReplaces the entire contents of +self+ with the contents of +other_hash+; returns +self+: h = {foo: 0, bar: 1, baz: 2} h.replace({bat: 3, bam: 4}) # => {:bat=>3, :bam=>4} @overload replace(other_hash) @return [self];T;0; @U;!F;"o;#;$T;%i|;&iƒ;'@T;(I"ástatic VALUE rb_hash_replace(VALUE hash, VALUE hash2) { rb_hash_modify_check(hash); if (hash == hash2) return hash; if (RHASH_ITER_LEV(hash) > 0) { rb_raise(rb_eRuntimeError, "can't replace hash during iteration"); } hash2 = to_hash(hash2); COPY_DEFAULT(hash, hash2); if (RHASH_AR_TABLE_P(hash)) { if (RHASH_AR_TABLE_P(hash2)) { ar_clear(hash); } else { ar_free_and_clear_table(hash); RHASH_ST_TABLE_SET(hash, st_init_table_with_size(RHASH_TYPE(hash2), RHASH_SIZE(hash2))); } } else { if (RHASH_AR_TABLE_P(hash2)) { st_free_table(RHASH_ST_TABLE(hash)); RHASH_ST_CLEAR(hash); } else { st_clear(RHASH_ST_TABLE(hash)); RHASH_TBL_RAW(hash)->type = RHASH_ST_TABLE(hash2)->type; } } rb_hash_foreach(hash2, rb_hash_rehash_i, (VALUE)hash); rb_gc_writebarrier_remember(hash); return hash; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#rehash;F;[;[[@—Tiº;T;:rehash;0;[;{;IC;"Rebuilds the hash table by recomputing the hash index for each key; returns self. The hash table becomes invalid if the hash value of a key has changed after the entry was created. See {Modifying an Active Hash Key}[#class-Hash-label-Modifying+an+Active+Hash+Key]. ;T;[o;= ;3I" overload;F;40;;¦;50;)I"rehash;T;IC;";T; @.U;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @.U;[;I"@return [self];T;0;6i;[; @.U;[;I"6Rebuilds the hash table by recomputing the hash index for each key; returns self. The hash table becomes invalid if the hash value of a key has changed after the entry was created. See {Modifying an Active Hash Key}[#class-Hash-label-Modifying+an+Active+Hash+Key]. @overload rehash @return [self];T;0; @.U;!F;"o;#;$T;%i®;&i·;'@T;(I"ˆVALUE 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_AR_TABLE_P(hash)) { tmp = hash_alloc(0); ar_alloc_table(tmp); rb_hash_foreach(hash, rb_hash_rehash_i, (VALUE)tmp); ar_free_and_clear_table(hash); ar_copy(hash, tmp); ar_free_and_clear_table(tmp); } else if (RHASH_ST_TABLE_P(hash)) { st_table *old_tab = RHASH_ST_TABLE(hash); tmp = hash_alloc(0); tbl = st_init_table_with_size(old_tab->type, old_tab->num_entries); RHASH_ST_TABLE_SET(tmp, tbl); rb_hash_foreach(hash, rb_hash_rehash_i, (VALUE)tmp); st_free_table(old_tab); RHASH_ST_TABLE_SET(hash, tbl); RHASH_ST_CLEAR(tmp); } hash_verify(hash); return hash; };T;)I" VALUE;T;*To;;F; ;;;;I"Hash#to_hash;F;[;[[@—Ti˜ ;T;:to_hash;0;[;{;IC;"Returns +self+. ;T;[o;= ;3I" overload;F;40;;§;50;)I"to_hash;T;IC;";T; @IU;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @IU;[;I"@return [self];T;0;6i;[; @IU;[;I"9Returns +self+. @overload to_hash @return [self];T;0; @IU;!F;"o;#;$T;%i’ ;&i– ;'@T;(I"Bstatic VALUE rb_hash_to_hash(VALUE hash) { return hash; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#to_h;F;[;[[@—TiÒ ;T;;#;0;[;{;IC;"¸For an instance of \Hash, returns +self+. For a subclass of \Hash, returns a new \Hash containing the content of +self+. When a block is given, returns a new \Hash object whose content is based on the block; the block should return a 2-element \Array object specifying the key-value pair to be included in the returned \Array: h = {foo: 0, bar: 1, baz: 2} h1 = h.to_h {|key, value| [value, key] } h1 # => {0=>:foo, 1=>:bar, 2=>:baz} ;T;[o;= ;3I" overload;F;40;;#;50;)I" to_h;T;IC;";T; @dU;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @dU;[;I"@return [self];T;0;6i;[; @dUo;= ;3I" overload;F;40;;#;50;)I" to_h;T;IC;";T; @dU;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;TI" value;T; @dU;[;I"@yield [key, value];T;0;6i;[; @dU;[;I"ÿFor an instance of \Hash, returns +self+. For a subclass of \Hash, returns a new \Hash containing the content of +self+. When a block is given, returns a new \Hash object whose content is based on the block; the block should return a 2-element \Array object specifying the key-value pair to be included in the returned \Array: h = {foo: 0, bar: 1, baz: 2} h1 = h.to_h {|key, value| [value, key] } h1 # => {0=>:foo, 1=>:bar, 2=>:baz} @overload to_h @return [self] @overload to_h @yield [key, value];T;0; @dU;!F;"o;#;$T;%i¿ ;&iÐ ;'@T;(I"&static VALUE rb_hash_to_h(VALUE hash) { if (rb_block_given_p()) { return rb_hash_to_h_block(hash); } if (rb_obj_class(hash) != rb_cHash) { const VALUE flags = RBASIC(hash)->flags; hash = hash_dup(hash, rb_cHash, flags & RHASH_PROC_DEFAULT); } return hash; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#to_a;F;[;[[@—TiS ;T;;!;0;[;{;IC;"ºReturns a new \Array of 2-element \Array objects; each nested \Array contains a key-value pair from +self+: h = {foo: 0, bar: 1, baz: 2} h.to_a # => [[:foo, 0], [:bar, 1], [:baz, 2]] ;T;[o;= ;3I" overload;F;40;;!;50;)I" to_a;T;IC;";T; @U;>0;!F;[;[;I";T;0;6i;[; @U;[;I"ËReturns a new \Array of 2-element \Array objects; each nested \Array contains a key-value pair from +self+: h = {foo: 0, bar: 1, baz: 2} h.to_a # => [[:foo, 0], [:bar, 1], [:baz, 2]] @overload to_a;T;0; @U;!F;"o;#;$T;%iI ;&iO ;'@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); return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#inspect;F;[;[[@—TiŠ ;T;;r;0;[;{;IC;"©Returns a new \String containing the hash entries: h = {foo: 0, bar: 1, baz: 2} h.inspect # => "{:foo=>0, :bar=>1, :baz=>2}" Hash#to_s is an alias for Hash#inspect. ;T;[o;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @£U;>0;!F;[;[;I";T;0;6i;[; @£U;[;I"½Returns a new \String containing the hash entries: h = {foo: 0, bar: 1, baz: 2} h.inspect # => "{:foo=>0, :bar=>1, :baz=>2}" Hash#to_s is an alias for Hash#inspect. @overload inspect;T;0; o;;F; ;;;;I"Hash#to_s;F;[;[[@—Tià;F;;q;;K;[;{;@ªU;'@T;)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;%i ;&i† ;'@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;)@½U;*T@¶Uo;;F; ;;;;I"Hash#to_proc;F;[;[[@—Tiv;T;:to_proc;0;[;{;IC;"ÍReturns a \Proc object that maps a key to its value: h = {foo: 0, bar: 1, baz: 2} proc = h.to_proc proc.class # => Proc proc.call(:foo) # => 0 proc.call(:bar) # => 1 proc.call(:nosuch) # => nil ;T;[o;= ;3I" overload;F;40;;¨;50;)I"to_proc;T;IC;";T; @ÁU;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Proc;T; @ÁU;[;I"@return [Proc];T;0;6i;[; @ÁU;[;I"òReturns a \Proc object that maps a key to its value: h = {foo: 0, bar: 1, baz: 2} proc = h.to_proc proc.class # => Proc proc.call(:foo) # => 0 proc.call(:bar) # => 1 proc.call(:nosuch) # => nil @overload to_proc @return [Proc];T;0; @ÁU;!F;"o;#;$T;%ij;⁢'@T;(I"lstatic VALUE rb_hash_to_proc(VALUE hash) { return rb_func_lambda_new(hash_proc_call, hash, 1, 1); };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#==;F;[[I" hash2;T0;[[@—TiÕ;T;;`;0;[;{;IC;"vReturns +true+ if all of the following are true: * +object+ is a \Hash object. * +hash+ and +object+ have the same keys (regardless of order). * For each key +key+, hash[key] == object[key]. Otherwise, returns +false+. Equal: h1 = {foo: 0, bar: 1, baz: 2} h2 = {foo: 0, bar: 1, baz: 2} h1 == h2 # => true h3 = {baz: 2, bar: 1, foo: 0} h1 == h3 # => true ;T;[o;= ;3I" overload;F;40;;`;50;)I"==(object);T;IC;";T; @ÜU;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ÜU;[;I"@return [Boolean];T;0;6i;[[I"object;T0; @ÜU;[;I"¡Returns +true+ if all of the following are true: * +object+ is a \Hash object. * +hash+ and +object+ have the same keys (regardless of order). * For each key +key+, hash[key] == object[key]. Otherwise, returns +false+. Equal: h1 = {foo: 0, bar: 1, baz: 2} h2 = {foo: 0, bar: 1, baz: 2} h1 == h2 # => true h3 = {baz: 2, bar: 1, foo: 0} h1 == h3 # => true @overload ==(object) @return [Boolean];T;0; @ÜU;!F;"o;#;$T;%iÂ;&iÒ;'@T;(I"istatic VALUE rb_hash_equal(VALUE hash1, VALUE hash2) { return hash_equal(hash1, hash2, FALSE); };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#[];F;[[I"key;T0;[[@—Ti;T;;Â;0;[;{;IC;"Returns the value associated with the given +key+, if found: h = {foo: 0, bar: 1, baz: 2} h[:foo] # => 0 If +key+ is not found, returns a default value (see {Default Values}[#class-Hash-label-Default+Values]): h = {foo: 0, bar: 1, baz: 2} h[:nosuch] # => nil ;T;[o;= ;3I" overload;F;40;;Â;50;)I"[](key);T;IC;";T; @ûU;>0;!F;[;[;I";T;0;6i;[[I"key;T0; @ûU;[;I"Returns the value associated with the given +key+, if found: h = {foo: 0, bar: 1, baz: 2} h[:foo] # => 0 If +key+ is not found, returns a default value (see {Default Values}[#class-Hash-label-Default+Values]): h = {foo: 0, bar: 1, baz: 2} h[:nosuch] # => nil @overload [](key);T;0; @ûU;!F;"o;#;$T;%i;&i;'@T;(I"ÓVALUE rb_hash_aref(VALUE hash, VALUE key) { st_data_t val; if (hash_stlike_lookup(hash, key, &val)) { return (VALUE)val; } else { return rb_hash_default_value(hash, key); } };T;)I" VALUE;T;*To;;F; ;;;;I"Hash#hash;F;[;[[@—Ti;T;;b;0;[;{;IC;"Returns the \Integer hash-code for the hash. Two \Hash objects have the same hash-code if their content is the same (regardless or order): h1 = {foo: 0, bar: 1, baz: 2} h2 = {baz: 2, bar: 1, foo: 0} h2.hash == h1.hash # => true h2.eql? h1 # => true ;T;[o;= ;3I" overload;F;40;;b;50;)I" hash;T;IC;";T; @V;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @V;[;I"@return [Integer];T;0;6i;[; @V;[;I"&Returns the \Integer hash-code for the hash. Two \Hash objects have the same hash-code if their content is the same (regardless or order): h1 = {foo: 0, bar: 1, baz: 2} h2 = {baz: 2, bar: 1, foo: 0} h2.hash == h1.hash # => true h2.eql? h1 # => true @overload hash @return [Integer];T;0; @V;!F;"o;#;$T;%i;&i;'@T;(I"0static 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 ST2FIX(hval); };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#eql?;F;[[I" hash2;T0;[[@—Tiî;T;;_;0;[;{;IC;"yReturns +true+ if all of the following are true: * +object+ is a \Hash object. * +hash+ and +object+ have the same keys (regardless of order). * For each key +key+, h[key] eql? object[key]. Otherwise, returns +false+. Equal: h1 = {foo: 0, bar: 1, baz: 2} h2 = {foo: 0, bar: 1, baz: 2} h1.eql? h2 # => true h3 = {baz: 2, bar: 1, foo: 0} h1.eql? h3 # => true;T;[o;= ;3I" overload;F;40;;_;50;)I"eql? object;T;IC;";T; @0V;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @0V;[;I"@return [Boolean];T;0;6i;[[I"object;T0; @0V;[;I"¥Returns +true+ if all of the following are true: * +object+ is a \Hash object. * +hash+ and +object+ have the same keys (regardless of order). * For each key +key+, h[key] eql? object[key]. Otherwise, returns +false+. Equal: h1 = {foo: 0, bar: 1, baz: 2} h2 = {foo: 0, bar: 1, baz: 2} h1.eql? h2 # => true h3 = {baz: 2, bar: 1, foo: 0} h1.eql? h3 # => true @overload eql? object @return [Boolean];T;0; @0V;!F;"o;#;$T;%iÛ;&ië;6i;'@T;(I"fstatic VALUE rb_hash_eql(VALUE hash1, VALUE hash2) { return hash_equal(hash1, hash2, TRUE); };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#fetch;F;[[@c0;[[@—TiH;T;;Ä;0;[;{;IC;"=Returns the value for the given +key+, if found. h = {foo: 0, bar: 1, baz: 2} h.fetch(:bar) # => 1 If +key+ is not found and no block was given, returns +default_value+: {}.fetch(:nosuch, :default) # => :default {}.fetch(:nosuch) # => nil If +key+ is not found and a block was given, yields +key+ to the block and returns the block's return value: {}.fetch(:nosuch) {|key| "No key #{key}"} # => "No key nosuch" Raises KeyError if neither +default_value+ nor a block was given. Note that this method does not use the values of either #default or #default_proc. ;T;[o;= ;3I" overload;F;40;;Ä;50;)I"fetch(key);T;IC;";T; @OV;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @OV;[;I"@return [Object];T;0;6i;[[I"key;T0; @OVo;= ;3I" overload;F;40;;Ä;50;)I"fetch(key, default_value);T;IC;";T; @OV;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @OV;[;I"@return [Object];T;0;6i;[[I"key;T0[I"default_value;T0; @OVo;= ;3I" overload;F;40;;Ä;50;)I"fetch(key);T;IC;";T; @OV;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;T; @OVo;2 ;3I"return;F;4I";T;0;5[I"Object;T; @OV;[;I""@yield [key] @return [Object];T;0;6i;[[I"key;T0; @OV;[;I"ÕReturns the value for the given +key+, if found. h = {foo: 0, bar: 1, baz: 2} h.fetch(:bar) # => 1 If +key+ is not found and no block was given, returns +default_value+: {}.fetch(:nosuch, :default) # => :default {}.fetch(:nosuch) # => nil If +key+ is not found and a block was given, yields +key+ to the block and returns the block's return value: {}.fetch(:nosuch) {|key| "No key #{key}"} # => "No key nosuch" Raises KeyError if neither +default_value+ nor a block was given. Note that this method does not use the values of either #default or #default_proc. @overload fetch(key) @return [Object] @overload fetch(key, default_value) @return [Object] @overload fetch(key) @yield [key] @return [Object];T;0; @OV;!F;"o;#;$T;%i0;&iH;'@T;(I"Qstatic 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 (hash_stlike_lookup(hash, key, &val)) { return (VALUE)val; } else { if (block_given) { return rb_yield(key); } else 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_key_err_raise(rb_sprintf("key not found: %"PRIsVALUE, desc), hash, key); } else { return argv[1]; } } };T;)I"static VALUE;T;*To;;F; ;;;;I" Hash#[]=;F;[;[;F;;Ã;;K;[;{;IC;";T;[;[;@|;0; @’V;'@T;*To;;F; ;;;;I"Hash#store;F;[;[;F;: store;;K;[;{;IC;";T;[;[;@|;0; @›V;'@T;*To;;F; ;;;;I"Hash#default;F;[[@c0;[[@—Ti†;T;:default;0;[;{;IC;"æReturns the default value for the given +key+. The returned value will be determined either by the default proc or by the default value. See {Default Values}[#class-Hash-label-Default+Values]. With no argument, returns the current default value: h = {} h.default # => nil If +key+ is given, returns the default value for +key+, regardless of whether that key exists: h = Hash.new { |hash, key| hash[key] = "No key #{key}"} h[:foo] = "Hello" h.default(:foo) # => "No key foo" ;T;[o;= ;3I" overload;F;40;;ª;50;)I"default;T;IC;";T; @¤V;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @¤V;[;I"@return [Object];T;0;6i;[; @¤Vo;= ;3I" overload;F;40;;ª;50;)I"default(key);T;IC;";T; @¤V;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @¤V;[;I"@return [Object];T;0;6i;[[I"key;T0; @¤V;[;I"7Returns the default value for the given +key+. The returned value will be determined either by the default proc or by the default value. See {Default Values}[#class-Hash-label-Default+Values]. With no argument, returns the current default value: h = {} h.default # => nil If +key+ is given, returns the default value for +key+, regardless of whether that key exists: h = Hash.new { |hash, key| hash[key] = "No key #{key}"} h[:foo] = "Hello" h.default(:foo) # => "No key foo" @overload default @return [Object] @overload default(key) @return [Object];T;0; @¤V;!F;"o;#;$T;%ir;&i„;'@T;(I",static VALUE rb_hash_default(int argc, VALUE *argv, VALUE hash) { VALUE ifnone; rb_check_arity(argc, 0, 1); ifnone = RHASH_IFNONE(hash); if (FL_TEST(hash, RHASH_PROC_DEFAULT)) { if (argc == 0) return Qnil; return call_default_proc(ifnone, hash, argv[0]); } return ifnone; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#default=;F;[[I"ifnone;T0;[[@—Ti¡;T;: default=;0;[;{;IC;"ÀSets the default value to +value+; returns +value+: h = {} h.default # => nil h.default = false # => false h.default # => false See {Default Values}[#class-Hash-label-Default+Values]. ;T;[o;= ;3I" overload;F;40;;«;50;)I"default=(value);T;IC;";T; @ÏV;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @ÏV;[;I"@return [Object];T;0;6i;[[I" value;T0; @ÏV;[;I"ïSets the default value to +value+; returns +value+: h = {} h.default # => nil h.default = false # => false h.default # => false See {Default Values}[#class-Hash-label-Default+Values]. @overload default=(value) @return [Object];T;0; @ÏV;!F;"o;#;$T;%i”;&iž;'@T;(I"static VALUE rb_hash_set_default(VALUE hash, VALUE ifnone) { rb_hash_modify_check(hash); SET_DEFAULT(hash, ifnone); return ifnone; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#default_proc;F;[;[[@—Tiµ;T;:default_proc;0;[;{;IC;"ãReturns the default proc for +self+ (see {Default Values}[#class-Hash-label-Default+Values]): h = {} h.default_proc # => nil h.default_proc = proc {|hash, key| "Default value for #{key}" } h.default_proc.class # => Proc ;T;[o;= ;3I" overload;F;40;;¬;50;)I"default_proc;T;IC;";T; @îV;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Proc;TI"nil;T; @îV;[;I"@return [Proc, nil];T;0;6i;[; @îV;[;I"Returns the default proc for +self+ (see {Default Values}[#class-Hash-label-Default+Values]): h = {} h.default_proc # => nil h.default_proc = proc {|hash, key| "Default value for #{key}" } h.default_proc.class # => Proc @overload default_proc @return [Proc, nil];T;0; @îV;!F;"o;#;$T;%i©;&i²;'@T;(I"‘static VALUE rb_hash_default_proc(VALUE hash) { if (FL_TEST(hash, RHASH_PROC_DEFAULT)) { return RHASH_IFNONE(hash); } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#default_proc=;F;[[I" proc;T0;[[@—TiÌ;T;:default_proc=;0;[;{;IC;"Sets the default proc for +self+ to +proc+: (see {Default Values}[#class-Hash-label-Default+Values]): h = {} h.default_proc # => nil h.default_proc = proc { |hash, key| "Default value for #{key}" } h.default_proc.class # => Proc h.default_proc = nil h.default_proc # => nil ;T;[o;= ;3I" overload;F;40;;;50;)I"default_proc=(proc);T;IC;";T; @ W;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Proc;T; @ W;[;I"@return [Proc];T;0;6i;[[I" proc;T0; @ W;[;I"NSets the default proc for +self+ to +proc+: (see {Default Values}[#class-Hash-label-Default+Values]): h = {} h.default_proc # => nil h.default_proc = proc { |hash, key| "Default value for #{key}" } h.default_proc.class # => Proc h.default_proc = nil h.default_proc # => nil @overload default_proc=(proc) @return [Proc];T;0; @ W;!F;"o;#;$T;%i¾;&iÉ;'@T;(I"ÌVALUE rb_hash_set_default_proc(VALUE hash, VALUE proc) { VALUE b; rb_hash_modify_check(hash); if (NIL_P(proc)) { SET_DEFAULT(hash, proc); return proc; } b = rb_check_convert_type_with_id(proc, T_DATA, "Proc", idTo_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; SET_PROC_DEFAULT(hash, proc); return proc; };T;)I" VALUE;T;*To;;F; ;;;;I" Hash#key;F;[[I" value;T0;[[@—Tiú;T;:key;0;[;{;IC;"çReturns the key for the first-found entry with the given +value+ (see {Entry Order}[#class-Hash-label-Entry+Order]): h = {foo: 0, bar: 2, baz: 2} h.key(0) # => :foo h.key(2) # => :bar Returns +nil+ if so such value is found. ;T;[o;= ;3I" overload;F;40;;®;50;)I"key(value);T;IC;";T; @)W;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @)W;[;I"@return [nil];T;0;6i;[[I" value;T0; @)W;[;I"Returns the key for the first-found entry with the given +value+ (see {Entry Order}[#class-Hash-label-Entry+Order]): h = {foo: 0, bar: 2, baz: 2} h.key(0) # => :foo h.key(2) # => :bar Returns +nil+ if so such value is found. @overload key(value) @return [nil];T;0; @)W;!F;"o;#;$T;%ií;&i÷;'@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;)I"static VALUE;T;*To;;F; ;;;;I"Hash#size;F;[;[[@—Ti·;T;: size;0;[;{;IC;"}Returns the count of entries in +self+: {foo: 0, bar: 1, baz: 2}.length # => 3 Hash#length is an alias for Hash#size. ;T;[o;= ;3I" overload;F;40;:length;50;)I"length;T;IC;";T; @HW;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @HW;[;I"@return [Integer];T;0;6i;[; @HWo;= ;3I" overload;F;40;;¯;50;)I" size;T;IC;";T; @HW;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @HW;[;I"@return [Integer];T;0;6i;[; @HW;[;I"ÂReturns the count of entries in +self+: {foo: 0, bar: 1, baz: 2}.length # => 3 Hash#length is an alias for Hash#size. @overload length @return [Integer] @overload size @return [Integer];T;0; @HW;!F;"o;#;$T;%i¬;&iµ;'@T;(I"MVALUE rb_hash_size(VALUE hash) { return INT2FIX(RHASH_SIZE(hash)); };T;)I" VALUE;T;*To;;F; ;;;;I"Hash#length;F;[;[[@—Ti·;T;;°;0;[;{;IC;"}Returns the count of entries in +self+: {foo: 0, bar: 1, baz: 2}.length # => 3 Hash#length is an alias for Hash#size. ;T;[o;= ;3I" overload;F;40;;°;50;)I"length;T;IC;";T; @pW;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @pW;[;I"@return [Integer];T;0;6i;[; @pWo;= ;3I" overload;F;40;;¯;50;)I" size;T;IC;";T; @pW;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @pW;[;I"@return [Integer];T;0;6i;[; @pW;[;@lW;0; @pW;!F;"o;#;$T;%i¬;&iµ;'@T;(I"MVALUE rb_hash_size(VALUE hash) { return INT2FIX(RHASH_SIZE(hash)); };T;)I" VALUE;T;*To;;F; ;;;;I"Hash#empty?;F;[;[[@—TiÌ;T;:empty?;0;[;{;IC;"‚Returns +true+ if there are no hash entries, +false+ otherwise: {}.empty? # => true {foo: 0, bar: 1, baz: 2}.empty? # => false;T;[o;= ;3I" overload;F;40;;±;50;)I"empty?;T;IC;";T; @—W;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @—W;[;I"@return [Boolean];T;0;6i;[; @—W;[;I"©Returns +true+ if there are no hash entries, +false+ otherwise: {}.empty? # => true {foo: 0, bar: 1, baz: 2}.empty? # => false @overload empty? @return [Boolean];T;0; @—W;!F;"o;#;$T;%iÃ;&iÉ;6i;'@T;(I"bstatic VALUE rb_hash_empty_p(VALUE hash) { return RHASH_EMPTY_P(hash) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#each_value;F;[;[[@—Tiñ;T;:each_value;0;[;{;IC;"¨Calls the given block with each value; returns +self+: h = {foo: 0, bar: 1, baz: 2} h.each_value {|value| puts value } # => {:foo=>0, :bar=>1, :baz=>2} Output: 0 1 2 Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.each_value # => #0, :bar=>1, :baz=>2}:each_value> h1 = e.each {|value| puts value } h1 # => {:foo=>0, :bar=>1, :baz=>2} Output: 0 1 2 ;T;[o;= ;3I" overload;F;40;;²;50;)I"each_value;T;IC;";T; @²W;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" value;T; @²Wo;2 ;3I"return;F;4I";T;0;5[I" self;T; @²W;[;I""@yield [value] @return [self];T;0;6i;[; @²Wo;= ;3I" overload;F;40;;²;50;)I"each_value;T;IC;";T; @²W;>0;!F;[;[;I";T;0;6i;[; @²W;[;I"öCalls the given block with each value; returns +self+: h = {foo: 0, bar: 1, baz: 2} h.each_value {|value| puts value } # => {:foo=>0, :bar=>1, :baz=>2} Output: 0 1 2 Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.each_value # => #0, :bar=>1, :baz=>2}:each_value> h1 = e.each {|value| puts value } h1 # => {:foo=>0, :bar=>1, :baz=>2} Output: 0 1 2 @overload each_value @yield [value] @return [self] @overload each_value;T;0; @²W;!F;"o;#;$T;%iÙ;&iï;'@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;)I"static VALUE;T;*To;;F; ;;;;I"Hash#each_key;F;[;[[@—Ti;T;: each_key;0;[;{;IC;"¥Calls the given block with each key; returns +self+: h = {foo: 0, bar: 1, baz: 2} h.each_key {|key| puts key } # => {:foo=>0, :bar=>1, :baz=>2} Output: foo bar baz Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.each_key # => #0, :bar=>1, :baz=>2}:each_key> h1 = e.each {|key| puts key } h1 # => {:foo=>0, :bar=>1, :baz=>2} Output: foo bar baz ;T;[o;= ;3I" overload;F;40;;³;50;)I" each_key;T;IC;";T; @ÚW;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;T; @ÚWo;2 ;3I"return;F;4I";T;0;5[I" self;T; @ÚW;[;I" @yield [key] @return [self];T;0;6i;[; @ÚWo;= ;3I" overload;F;40;;³;50;)I" each_key;T;IC;";T; @ÚW;>0;!F;[;[;I";T;0;6i;[; @ÚW;[;I"íCalls the given block with each key; returns +self+: h = {foo: 0, bar: 1, baz: 2} h.each_key {|key| puts key } # => {:foo=>0, :bar=>1, :baz=>2} Output: foo bar baz Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.each_key # => #0, :bar=>1, :baz=>2}:each_key> h1 = e.each {|key| puts key } h1 # => {:foo=>0, :bar=>1, :baz=>2} Output: foo bar baz @overload each_key @yield [key] @return [self] @overload each_key;T;0; @ÚW;!F;"o;#;$T;%i;&i;'@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;)I"static VALUE;T;*To;;F; ;;;;I"Hash#each_pair;F;[;[[@—TiL;T;:each_pair;0;[;{;IC;"Hash#each is an alias for Hash#each_pair. Calls the given block with each key-value pair; returns +self+: h = {foo: 0, bar: 1, baz: 2} h.each_pair {|key, value| puts "#{key}: #{value}"} # => {:foo=>0, :bar=>1, :baz=>2} Output: foo: 0 bar: 1 baz: 2 Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.each_pair # => #0, :bar=>1, :baz=>2}:each_pair> h1 = e.each {|key, value| puts "#{key}: #{value}"} h1 # => {:foo=>0, :bar=>1, :baz=>2} Output: foo: 0 bar: 1 baz: 2 ;T;[ o;= ;3I" overload;F;40;;;50;)I" each;T;IC;";T; @X;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;TI" value;T; @Xo;2 ;3I"return;F;4I";T;0;5[I" self;T; @X;[;I"'@yield [key, value] @return [self];T;0;6i;[; @Xo;= ;3I" overload;F;40;;´;50;)I"each_pair;T;IC;";T; @X;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;TI" value;T; @Xo;2 ;3I"return;F;4I";T;0;5[I" self;T; @X;[;I"'@yield [key, value] @return [self];T;0;6i;[; @Xo;= ;3I" overload;F;40;;;50;)I" each;T;IC;";T; @X;>0;!F;[;[;I";T;0;6i;[; @Xo;= ;3I" overload;F;40;;´;50;)I"each_pair;T;IC;";T; @X;>0;!F;[;[;I";T;0;6i;[; @X;[;I"¯Hash#each is an alias for Hash#each_pair. Calls the given block with each key-value pair; returns +self+: h = {foo: 0, bar: 1, baz: 2} h.each_pair {|key, value| puts "#{key}: #{value}"} # => {:foo=>0, :bar=>1, :baz=>2} Output: foo: 0 bar: 1 baz: 2 Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.each_pair # => #0, :bar=>1, :baz=>2}:each_pair> h1 = e.each {|key, value| puts "#{key}: #{value}"} h1 # => {:foo=>0, :bar=>1, :baz=>2} Output: foo: 0 bar: 1 baz: 2 @overload each @yield [key, value] @return [self] @overload each_pair @yield [key, value] @return [self] @overload each @overload each_pair;T;0; @X;!F;"o;#;$T;%i0;&iL;'@T;(I"static VALUE rb_hash_each_pair(VALUE hash) { RETURN_SIZED_ENUMERATOR(hash, 0, 0, hash_enum_size); if (rb_block_pair_yield_optimizable()) rb_hash_foreach(hash, each_pair_i_fast, 0); else rb_hash_foreach(hash, each_pair_i, 0); return hash; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#each;F;[;[[@—TiL;T;;;0;[;{;IC;"Hash#each is an alias for Hash#each_pair. Calls the given block with each key-value pair; returns +self+: h = {foo: 0, bar: 1, baz: 2} h.each_pair {|key, value| puts "#{key}: #{value}"} # => {:foo=>0, :bar=>1, :baz=>2} Output: foo: 0 bar: 1 baz: 2 Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.each_pair # => #0, :bar=>1, :baz=>2}:each_pair> h1 = e.each {|key, value| puts "#{key}: #{value}"} h1 # => {:foo=>0, :bar=>1, :baz=>2} Output: foo: 0 bar: 1 baz: 2 ;T;[ o;= ;3I" overload;F;40;;;50;)I" each;T;IC;";T; @FX;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;TI" value;T; @FXo;2 ;3I"return;F;4I";T;0;5[I" self;T; @FX;[;I"'@yield [key, value] @return [self];T;0;6i;[; @FXo;= ;3I" overload;F;40;;´;50;)I"each_pair;T;IC;";T; @FX;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;TI" value;T; @FXo;2 ;3I"return;F;4I";T;0;5[I" self;T; @FX;[;I"'@yield [key, value] @return [self];T;0;6i;[; @FXo;= ;3I" overload;F;40;;;50;)I" each;T;IC;";T; @FX;>0;!F;[;[;I";T;0;6i;[; @FXo;= ;3I" overload;F;40;;´;50;)I"each_pair;T;IC;";T; @FX;>0;!F;[;[;I";T;0;6i;[; @FX;[;@BX;0; @FX;!F;"o;#;$T;%i0;&iL;'@T;(I"static VALUE rb_hash_each_pair(VALUE hash) { RETURN_SIZED_ENUMERATOR(hash, 0, 0, hash_enum_size); if (rb_block_pair_yield_optimizable()) rb_hash_foreach(hash, each_pair_i_fast, 0); else rb_hash_foreach(hash, each_pair_i, 0); return hash; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#transform_keys;F;[[@c0;[[@—Tiš;T;:transform_keys;0;[;{;IC;"¡Returns a new \Hash object; each entry has: * A key provided by the block. * The value from +self+. An optional hash argument can be provided to map keys to new keys. Any key not given will be mapped using the provided block, or remain the same if no block is given. Transform keys: h = {foo: 0, bar: 1, baz: 2} h1 = h.transform_keys {|key| key.to_s } h1 # => {"foo"=>0, "bar"=>1, "baz"=>2} h.transform_keys(foo: :bar, bar: :foo) #=> {bar: 0, foo: 1, baz: 2} h.transform_keys(foo: :hello, &:to_s) #=> {:hello=>0, "bar"=>1, "baz"=>2} Overwrites values for duplicate keys: h = {foo: 0, bar: 1, baz: 2} h1 = h.transform_keys {|key| :bat } h1 # => {:bat=>2} Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.transform_keys # => #0, :bar=>1, :baz=>2}:transform_keys> h1 = e.each { |key| key.to_s } h1 # => {"foo"=>0, "bar"=>1, "baz"=>2} ;T;[ o;= ;3I" overload;F;40;;µ;50;)I"transform_keys;T;IC;";T; @‰X;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;T; @‰X;[;I"@yield [key];T;0;6i;[; @‰Xo;= ;3I" overload;F;40;;µ;50;)I"transform_keys(hash2);T;IC;";T; @‰X;>0;!F;[;[;I";T;0;6i;[[I" hash2;T0; @‰Xo;= ;3I" overload;F;40;;µ;50;)I"transform_keys(hash2);T;IC;";T; @‰X;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"other_key;T; @‰X;[;I"@yield [other_key];T;0;6i;[[I" hash2;T0; @‰Xo;= ;3I" overload;F;40;;µ;50;)I"transform_keys;T;IC;";T; @‰X;>0;!F;[;[;I";T;0;6i;[; @‰X;[;I"9Returns a new \Hash object; each entry has: * A key provided by the block. * The value from +self+. An optional hash argument can be provided to map keys to new keys. Any key not given will be mapped using the provided block, or remain the same if no block is given. Transform keys: h = {foo: 0, bar: 1, baz: 2} h1 = h.transform_keys {|key| key.to_s } h1 # => {"foo"=>0, "bar"=>1, "baz"=>2} h.transform_keys(foo: :bar, bar: :foo) #=> {bar: 0, foo: 1, baz: 2} h.transform_keys(foo: :hello, &:to_s) #=> {:hello=>0, "bar"=>1, "baz"=>2} Overwrites values for duplicate keys: h = {foo: 0, bar: 1, baz: 2} h1 = h.transform_keys {|key| :bat } h1 # => {:bat=>2} Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.transform_keys # => #0, :bar=>1, :baz=>2}:transform_keys> h1 = e.each { |key| key.to_s } h1 # => {"foo"=>0, "bar"=>1, "baz"=>2} @overload transform_keys @yield [key] @overload transform_keys(hash2) @overload transform_keys(hash2) @yield [other_key] @overload transform_keys;T;0; @‰X;!F;"o;#;$T;%iu;&i™;'@T;(I"¿static VALUE rb_hash_transform_keys(int argc, VALUE *argv, VALUE hash) { VALUE result; struct transform_keys_args transarg = {0}; argc = rb_check_arity(argc, 0, 1); if (argc > 0) { transarg.trans = to_hash(argv[0]); transarg.block_given = rb_block_given_p(); } else { RETURN_SIZED_ENUMERATOR(hash, 0, 0, hash_enum_size); } result = rb_hash_new(); if (!RHASH_EMPTY_P(hash)) { if (transarg.trans) { transarg.result = result; rb_hash_foreach(hash, transform_keys_hash_i, (VALUE)&transarg); } else { rb_hash_foreach(hash, transform_keys_i, result); } } return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#transform_keys!;F;[[@c0;[[@—TiÂ;T;:transform_keys!;0;[;{;IC;"dSame as Hash#transform_keys but modifies the receiver in place instead of returning a new hash. ;T;[ o;= ;3I" overload;F;40;;¶;50;)I"transform_keys!;T;IC;";T; @ÆX;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;T; @ÆXo;2 ;3I"return;F;4I";T;0;5[I" self;T; @ÆX;[;I" @yield [key] @return [self];T;0;6i;[; @ÆXo;= ;3I" overload;F;40;;¶;50;)I"transform_keys!(hash2);T;IC;";T; @ÆX;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @ÆX;[;I"@return [self];T;0;6i;[[I" hash2;T0; @ÆXo;= ;3I" overload;F;40;;¶;50;)I"transform_keys!(hash2);T;IC;";T; @ÆX;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"other_key;T; @ÆXo;2 ;3I"return;F;4I";T;0;5[I" self;T; @ÆX;[;I"&@yield [other_key] @return [self];T;0;6i;[[I" hash2;T0; @ÆXo;= ;3I" overload;F;40;;¶;50;)I"transform_keys!;T;IC;";T; @ÆX;>0;!F;[;[;I";T;0;6i;[; @ÆX;[;I".Same as Hash#transform_keys but modifies the receiver in place instead of returning a new hash. @overload transform_keys! @yield [key] @return [self] @overload transform_keys!(hash2) @return [self] @overload transform_keys!(hash2) @yield [other_key] @return [self] @overload transform_keys!;T;0; @ÆX;!F;"o;#;$T;%i¸;&iÄ;'@T;(I"Ÿstatic VALUE rb_hash_transform_keys_bang(int argc, VALUE *argv, VALUE hash) { VALUE trans = 0; int block_given = 0; argc = rb_check_arity(argc, 0, 1); if (argc > 0) { trans = to_hash(argv[0]); block_given = rb_block_given_p(); } else { RETURN_SIZED_ENUMERATOR(hash, 0, 0, hash_enum_size); } rb_hash_modify_check(hash); if (!RHASH_TABLE_EMPTY_P(hash)) { long i; VALUE new_keys = hash_alloc(0); VALUE pairs = rb_ary_tmp_new(RHASH_SIZE(hash) * 2); rb_hash_foreach(hash, flatten_i, pairs); for (i = 0; i < RARRAY_LEN(pairs); i += 2) { VALUE key = RARRAY_AREF(pairs, i), new_key, val; if (!trans) { new_key = rb_yield(key); } else if ((new_key = rb_hash_lookup2(trans, key, Qundef)) != Qundef) { /* use the transformed key */ } else if (block_given) { new_key = rb_yield(key); } else { new_key = key; } val = RARRAY_AREF(pairs, i+1); if (!hash_stlike_lookup(new_keys, key, NULL)) { rb_hash_stlike_delete(hash, &key, NULL); } rb_hash_aset(hash, new_key, val); rb_hash_aset(new_keys, new_key, Qnil); } rb_ary_clear(pairs); rb_hash_clear(new_keys); } return hash; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#transform_values;F;[;[[@—Ti ;T;:transform_values;0;[;{;IC;"ãReturns a new \Hash object; each entry has: * A key from +self+. * A value provided by the block. Transform values: h = {foo: 0, bar: 1, baz: 2} h1 = h.transform_values {|value| value * 100} h1 # => {:foo=>0, :bar=>100, :baz=>200} Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.transform_values # => #0, :bar=>1, :baz=>2}:transform_values> h1 = e.each { |value| value * 100} h1 # => {:foo=>0, :bar=>100, :baz=>200} ;T;[o;= ;3I" overload;F;40;;·;50;)I"transform_values;T;IC;";T; @Y;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" value;T; @Y;[;I"@yield [value];T;0;6i;[; @Yo;= ;3I" overload;F;40;;·;50;)I"transform_values;T;IC;";T; @Y;>0;!F;[;[;I";T;0;6i;[; @Y;[;I",Returns a new \Hash object; each entry has: * A key from +self+. * A value provided by the block. Transform values: h = {foo: 0, bar: 1, baz: 2} h1 = h.transform_values {|value| value * 100} h1 # => {:foo=>0, :bar=>100, :baz=>200} Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.transform_values # => #0, :bar=>1, :baz=>2}:transform_values> h1 = e.each { |value| value * 100} h1 # => {:foo=>0, :bar=>100, :baz=>200} @overload transform_values @yield [value] @overload transform_values;T;0; @Y;!F;"o;#;$T;%i ;&i ;'@T;(I"static VALUE rb_hash_transform_values(VALUE hash) { VALUE result; RETURN_SIZED_ENUMERATOR(hash, 0, 0, hash_enum_size); result = hash_copy(hash_alloc(rb_cHash), hash); SET_DEFAULT(result, Qnil); if (!RHASH_EMPTY_P(hash)) { rb_hash_stlike_foreach_with_replace(result, transform_values_foreach_func, transform_values_foreach_replace, result); } return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#transform_values!;F;[;[[@—Ti5 ;T;:transform_values!;0;[;{;IC;"ÈReturns +self+, whose keys are unchanged, and whose values are determined by the given block. h = {foo: 0, bar: 1, baz: 2} h.transform_values! {|value| value * 100} # => {:foo=>0, :bar=>100, :baz=>200} Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.transform_values! # => #0, :bar=>100, :baz=>200}:transform_values!> h1 = e.each {|value| value * 100} h1 # => {:foo=>0, :bar=>100, :baz=>200} ;T;[o;= ;3I" overload;F;40;;¸;50;)I"transform_values!;T;IC;";T; @5Y;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" value;T; @5Yo;2 ;3I"return;F;4I";T;0;5[I" self;T; @5Y;[;I""@yield [value] @return [self];T;0;6i;[; @5Yo;= ;3I" overload;F;40;;¸;50;)I"transform_values!;T;IC;";T; @5Y;>0;!F;[;[;I";T;0;6i;[; @5Y;[;I"$Returns +self+, whose keys are unchanged, and whose values are determined by the given block. h = {foo: 0, bar: 1, baz: 2} h.transform_values! {|value| value * 100} # => {:foo=>0, :bar=>100, :baz=>200} Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.transform_values! # => #0, :bar=>100, :baz=>200}:transform_values!> h1 = e.each {|value| value * 100} h1 # => {:foo=>0, :bar=>100, :baz=>200} @overload transform_values! @yield [value] @return [self] @overload transform_values!;T;0; @5Y;!F;"o;#;$T;%i& ;&i4 ;'@T;(I"Lstatic VALUE rb_hash_transform_values_bang(VALUE hash) { RETURN_SIZED_ENUMERATOR(hash, 0, 0, hash_enum_size); rb_hash_modify_check(hash); if (!RHASH_TABLE_EMPTY_P(hash)) { rb_hash_stlike_foreach_with_replace(hash, transform_values_foreach_func, transform_values_foreach_replace, hash); } return hash; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#keys;F;[;[[@—Tiï ;T;;Æ;0;[;{;IC;"xReturns a new \Array containing all keys in +self+: h = {foo: 0, bar: 1, baz: 2} h.keys # => [:foo, :bar, :baz] ;T;[o;= ;3I" overload;F;40;;Æ;50;)I" keys;T;IC;";T; @]Y;>0;!F;[;[;I";T;0;6i;[; @]Y;[;I"„Returns a new \Array containing all keys in +self+: h = {foo: 0, bar: 1, baz: 2} h.keys # => [:foo, :bar, :baz] @overload keys;T;0; @]Y;!F;"o;#;$T;%iæ ;&ië ;'@T;(I"”MJIT_FUNC_EXPORTED VALUE rb_hash_keys(VALUE hash) { st_index_t size = RHASH_SIZE(hash); VALUE keys = rb_ary_new_capa(size); if (size == 0) return keys; if (ST_DATA_COMPATIBLE_P(VALUE)) { RARRAY_PTR_USE_TRANSIENT(keys, ptr, { if (RHASH_AR_TABLE_P(hash)) { size = ar_keys(hash, ptr, size); } else { st_table *table = RHASH_ST_TABLE(hash); size = st_keys(table, ptr, size); } }); rb_gc_writebarrier_remember(keys); rb_ary_set_len(keys, size); } else { rb_hash_foreach(hash, keys_i, keys); } return keys; };T;)I"MJIT_FUNC_EXPORTED VALUE;T;*To;;F; ;;;;I"Hash#values;F;[;[[@—Ti;T;:values;0;[;{;IC;"sReturns a new \Array containing all values in +self+: h = {foo: 0, bar: 1, baz: 2} h.values # => [0, 1, 2] ;T;[o;= ;3I" overload;F;40;;¹;50;)I"values;T;IC;";T; @sY;>0;!F;[;[;I";T;0;6i;[; @sY;[;I"Returns a new \Array containing all values in +self+: h = {foo: 0, bar: 1, baz: 2} h.values # => [0, 1, 2] @overload values;T;0; @sY;!F;"o;#;$T;%i;&i;'@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)) { if (RHASH_AR_TABLE_P(hash)) { rb_gc_writebarrier_remember(values); RARRAY_PTR_USE_TRANSIENT(values, ptr, { size = ar_values(hash, ptr, size); }); } else if (RHASH_ST_TABLE_P(hash)) { st_table *table = RHASH_ST_TABLE(hash); rb_gc_writebarrier_remember(values); RARRAY_PTR_USE_TRANSIENT(values, ptr, { size = st_values(table, ptr, size); }); } rb_ary_set_len(values, size); } else { rb_hash_foreach(hash, values_i, values); } return values; };T;)I" VALUE;T;*To;;F; ;;;;I"Hash#values_at;F;[[@c0;[[@—Tin ;T;:values_at;0;[;{;IC;"Returns a new \Array containing values for the given +keys+: h = {foo: 0, bar: 1, baz: 2} h.values_at(:baz, :foo) # => [2, 0] The {default values}[#class-Hash-label-Default+Values] are returned for any keys that are not found: h.values_at(:hello, :foo) # => [nil, 0] ;T;[o;= ;3I" overload;F;40;;º;50;)I"values_at(*keys);T;IC;";T; @‰Y;>0;!F;[;[;I";T;0;6i;[[I" *keys;T0; @‰Y;[;I".Returns a new \Array containing values for the given +keys+: h = {foo: 0, bar: 1, baz: 2} h.values_at(:baz, :foo) # => [2, 0] The {default values}[#class-Hash-label-Default+Values] are returned for any keys that are not found: h.values_at(:hello, :foo) # => [nil, 0] @overload values_at(*keys);T;0; @‰Y;!F;"o;#;$T;%ia ;&ij ;'@T;(I"ÚVALUE rb_hash_values_at(int argc, VALUE *argv, VALUE hash) { VALUE result = rb_ary_new2(argc); long i; for (i=0; i [2, 0] Returns a new empty \Array if no arguments given. When a block is given, calls the block with each missing key, treating the block's return value as the value for that key: h = {foo: 0, bar: 1, baz: 2} values = h.fetch_values(:bar, :foo, :bad, :bam) {|key| key.to_s} values # => [1, 0, "bad", "bam"] When no block is given, raises an exception if any given key is not found. ;T;[o;= ;3I" overload;F;40;;»;50;)I"fetch_values(*keys);T;IC;";T; @¢Y;>0;!F;[;[;I";T;0;6i;[[I" *keys;T0; @¢Yo;= ;3I" overload;F;40;;»;50;)I"fetch_values(*keys);T;IC;";T; @¢Y;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;T; @¢Y;[;I"@yield [key];T;0;6i;[[I" *keys;T0; @¢Y;[;I"eReturns a new \Array containing the values associated with the given keys *keys: h = {foo: 0, bar: 1, baz: 2} h.fetch_values(:baz, :foo) # => [2, 0] Returns a new empty \Array if no arguments given. When a block is given, calls the block with each missing key, treating the block's return value as the value for that key: h = {foo: 0, bar: 1, baz: 2} values = h.fetch_values(:bar, :foo, :bad, :bam) {|key| key.to_s} values # => [1, 0, "bad", "bam"] When no block is given, raises an exception if any given key is not found. @overload fetch_values(*keys) @overload fetch_values(*keys) @yield [key];T;0; @¢Y;!F;"o;#;$T;%iz ;&i‹ ;'@T;(I"åstatic VALUE rb_hash_fetch_values(int argc, VALUE *argv, VALUE hash) { VALUE result = rb_ary_new2(argc); long i; for (i=0; i [:foo, 0] h # => {:bar=>1, :baz=>2} Returns the default value if the hash is empty (see {Default Values}[#class-Hash-label-Default+Values]). ;T;[o;= ;3I" overload;F;40;;¼;50;)I" shift;T;IC;";T; @ÊY;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ÊY;[;I"@return [Array];T;0;6i;[; @ÊY;[;I"sRemoves the first hash entry (see {Entry Order}[#class-Hash-label-Entry+Order]); returns a 2-element \Array containing the removed key and value: h = {foo: 0, bar: 1, baz: 2} h.shift # => [:foo, 0] h # => {:bar=>1, :baz=>2} Returns the default value if the hash is empty (see {Default Values}[#class-Hash-label-Default+Values]). @overload shift @return [Array];T;0; @ÊY;!F;"o;#;$T;%iu ;&i ;'@T;(I"static VALUE rb_hash_shift(VALUE hash) { struct shift_var var; rb_hash_modify_check(hash); if (RHASH_AR_TABLE_P(hash)) { var.key = Qundef; if (RHASH_ITER_LEV(hash) == 0) { if (ar_shift(hash, &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); } } } if (RHASH_ST_TABLE_P(hash)) { var.key = Qundef; if (RHASH_ITER_LEV(hash) == 0) { if (st_shift(RHASH_ST_TABLE(hash), &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;)I"static VALUE;T;*To;;F; ;;;;I"Hash#delete;F;[[I"key;T0;[[@—TiQ ;T;:delete;0;[;{;IC;"Deletes the entry for the given +key+ and returns its associated value. If no block is given and +key+ is found, deletes the entry and returns the associated value: h = {foo: 0, bar: 1, baz: 2} h.delete(:bar) # => 1 h # => {:foo=>0, :baz=>2} If no block given and +key+ is not found, returns +nil+. If a block is given and +key+ is found, ignores the block, deletes the entry, and returns the associated value: h = {foo: 0, bar: 1, baz: 2} h.delete(:baz) { |key| raise 'Will never happen'} # => 2 h # => {:foo=>0, :bar=>1} If a block is given and +key+ is not found, calls the block and returns the block's return value: h = {foo: 0, bar: 1, baz: 2} h.delete(:nosuch) { |key| "Key #{key} not found" } # => "Key nosuch not found" h # => {:foo=>0, :bar=>1, :baz=>2} ;T;[o;= ;3I" overload;F;40;;½;50;)I"delete(key);T;IC;";T; @åY;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @åY;[;I"@return [nil];T;0;6i;[[I"key;T0; @åYo;= ;3I" overload;F;40;;½;50;)I"delete(key);T;IC;";T; @åY;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;T; @åYo;2 ;3I"return;F;4I";T;0;5[I"Object;T; @åY;[;I""@yield [key] @return [Object];T;0;6i;[[I"key;T0; @åY;[;I"qDeletes the entry for the given +key+ and returns its associated value. If no block is given and +key+ is found, deletes the entry and returns the associated value: h = {foo: 0, bar: 1, baz: 2} h.delete(:bar) # => 1 h # => {:foo=>0, :baz=>2} If no block given and +key+ is not found, returns +nil+. If a block is given and +key+ is found, ignores the block, deletes the entry, and returns the associated value: h = {foo: 0, bar: 1, baz: 2} h.delete(:baz) { |key| raise 'Will never happen'} # => 2 h # => {:foo=>0, :bar=>1} If a block is given and +key+ is not found, calls the block and returns the block's return value: h = {foo: 0, bar: 1, baz: 2} h.delete(:nosuch) { |key| "Key #{key} not found" } # => "Key nosuch not found" h # => {:foo=>0, :bar=>1, :baz=>2} @overload delete(key) @return [nil] @overload delete(key) @yield [key] @return [Object];T;0; @åY;!F;"o;#;$T;%i6 ;&iP ;'@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;)I"static VALUE;T;*To;;F; ;;;;I"Hash#delete_if;F;[;[[@—TiÌ ;T;:delete_if;0;[;{;IC;"If a block given, calls the block with each key-value pair; deletes each entry for which the block returns a truthy value; returns +self+: h = {foo: 0, bar: 1, baz: 2} h.delete_if {|key, value| value > 0 } # => {:foo=>0} If no block given, returns a new \Enumerator: h = {foo: 0, bar: 1, baz: 2} e = h.delete_if # => #0, :bar=>1, :baz=>2}:delete_if> e.each { |key, value| value > 0 } # => {:foo=>0} ;T;[o;= ;3I" overload;F;40;;¾;50;)I"delete_if;T;IC;";T; @Z;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;TI" value;T; @Zo;2 ;3I"return;F;4I";T;0;5[I" self;T; @Z;[;I"'@yield [key, value] @return [self];T;0;6i;[; @Zo;= ;3I" overload;F;40;;¾;50;)I"delete_if;T;IC;";T; @Z;>0;!F;[;[;I";T;0;6i;[; @Z;[;I"þIf a block given, calls the block with each key-value pair; deletes each entry for which the block returns a truthy value; returns +self+: h = {foo: 0, bar: 1, baz: 2} h.delete_if {|key, value| value > 0 } # => {:foo=>0} If no block given, returns a new \Enumerator: h = {foo: 0, bar: 1, baz: 2} e = h.delete_if # => #0, :bar=>1, :baz=>2}:delete_if> e.each { |key, value| value > 0 } # => {:foo=>0} @overload delete_if @yield [key, value] @return [self] @overload delete_if;T;0; @Z;!F;"o;#;$T;%i» ;&iÊ ;'@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_TABLE_EMPTY_P(hash)) { rb_hash_foreach(hash, delete_if_i, hash); } return hash; };T;)I" VALUE;T;*To;;F; ;;;;I"Hash#keep_if;F;[;[[@—Tiý ;T;:keep_if;0;[;{;IC;"ÑCalls the block for each key-value pair; retains the entry if the block returns a truthy value; otherwise deletes the entry; returns +self+. h = {foo: 0, bar: 1, baz: 2} h.keep_if { |key, value| key.start_with?('b') } # => {:bar=>1, :baz=>2} Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.keep_if # => #0, :bar=>1, :baz=>2}:keep_if> e.each { |key, value| key.start_with?('b') } # => {:bar=>1, :baz=>2} ;T;[o;= ;3I" overload;F;40;;¿;50;)I"keep_if;T;IC;";T; @AZ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;TI" value;T; @AZo;2 ;3I"return;F;4I";T;0;5[I" self;T; @AZ;[;I"'@yield [key, value] @return [self];T;0;6i;[; @AZo;= ;3I" overload;F;40;;¿;50;)I"keep_if;T;IC;";T; @AZ;>0;!F;[;[;I";T;0;6i;[; @AZ;[;I"Calls the block for each key-value pair; retains the entry if the block returns a truthy value; otherwise deletes the entry; returns +self+. h = {foo: 0, bar: 1, baz: 2} h.keep_if { |key, value| key.start_with?('b') } # => {:bar=>1, :baz=>2} Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.keep_if # => #0, :bar=>1, :baz=>2}:keep_if> e.each { |key, value| key.start_with?('b') } # => {:bar=>1, :baz=>2} @overload keep_if @yield [key, value] @return [self] @overload keep_if;T;0; @AZ;!F;"o;#;$T;%iì ;&iû ;'@T;(I"òstatic VALUE rb_hash_keep_if(VALUE hash) { RETURN_SIZED_ENUMERATOR(hash, 0, 0, hash_enum_size); rb_hash_modify_check(hash); if (!RHASH_TABLE_EMPTY_P(hash)) { rb_hash_foreach(hash, keep_if_i, hash); } return hash; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#select;F;[;[[@—Ti´ ;T;;¦;0;[;{;IC;"²Hash#filter is an alias for Hash#select. Returns a new \Hash object whose entries are those for which the block returns a truthy value: h = {foo: 0, bar: 1, baz: 2} h.select {|key, value| value < 2 } # => {:foo=>0, :bar=>1} Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.select # => #0, :bar=>1, :baz=>2}:select> e.each {|key, value| value < 2 } # => {:foo=>0, :bar=>1} ;T;[o;= ;3I" overload;F;40;;¦;50;)I"select;T;IC;";T; @jZ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;TI" value;T; @jZ;[;I"@yield [key, value];T;0;6i;[; @jZo;= ;3I" overload;F;40;;¦;50;)I"select;T;IC;";T; @jZ;>0;!F;[;[;I";T;0;6i;[; @jZ;[;I"ìHash#filter is an alias for Hash#select. Returns a new \Hash object whose entries are those for which the block returns a truthy value: h = {foo: 0, bar: 1, baz: 2} h.select {|key, value| value < 2 } # => {:foo=>0, :bar=>1} Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.select # => #0, :bar=>1, :baz=>2}:select> e.each {|key, value| value < 2 } # => {:foo=>0, :bar=>1} @overload select @yield [key, value] @overload select;T;0; @jZ;!F;"o;#;$T;%i£ ;&i± ;'@T;(I"östatic 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;)I"static VALUE;T;*To;;F; ;;;;I"Hash#select!;F;[;[[@—TiÞ ;T;:select!;0;[;{;IC;"ØHash#filter! is an alias for Hash#select!. Returns +self+, whose entries are those for which the block returns a truthy value: h = {foo: 0, bar: 1, baz: 2} h.select! {|key, value| value < 2 } => {:foo=>0, :bar=>1} Returns +nil+ if no entries were removed. Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.select! # => #0, :bar=>1, :baz=>2}:select!> e.each { |key, value| value < 2 } # => {:foo=>0, :bar=>1} ;T;[o;= ;3I" overload;F;40;;À;50;)I"select!;T;IC;";T; @ŽZ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;TI" value;T; @ŽZo;2 ;3I"return;F;4I";T;0;5[I" self;TI"nil;T; @ŽZ;[;I",@yield [key, value] @return [self, nil];T;0;6i;[; @ŽZo;= ;3I" overload;F;40;;À;50;)I"select!;T;IC;";T; @ŽZ;>0;!F;[;[;I";T;0;6i;[; @ŽZ;[;I"*Hash#filter! is an alias for Hash#select!. Returns +self+, whose entries are those for which the block returns a truthy value: h = {foo: 0, bar: 1, baz: 2} h.select! {|key, value| value < 2 } => {:foo=>0, :bar=>1} Returns +nil+ if no entries were removed. Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.select! # => #0, :bar=>1, :baz=>2}:select!> e.each { |key, value| value < 2 } # => {:foo=>0, :bar=>1} @overload select! @yield [key, value] @return [self, nil] @overload select!;T;0; @ŽZ;!F;"o;#;$T;%iË ;&iÜ ;'@T;(I"8static VALUE rb_hash_select_bang(VALUE hash) { st_index_t n; RETURN_SIZED_ENUMERATOR(hash, 0, 0, hash_enum_size); rb_hash_modify_check(hash); n = RHASH_SIZE(hash); if (!n) return Qnil; rb_hash_foreach(hash, keep_if_i, hash); if (n == RHASH_SIZE(hash)) return Qnil; return hash; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#filter;F;[;[[@—Ti´ ;T;;-;0;[;{;IC;"²Hash#filter is an alias for Hash#select. Returns a new \Hash object whose entries are those for which the block returns a truthy value: h = {foo: 0, bar: 1, baz: 2} h.select {|key, value| value < 2 } # => {:foo=>0, :bar=>1} Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.select # => #0, :bar=>1, :baz=>2}:select> e.each {|key, value| value < 2 } # => {:foo=>0, :bar=>1} ;T;[o;= ;3I" overload;F;40;;¦;50;)I"select;T;IC;";T; @¸Z;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;TI" value;T; @¸Z;[;I"@yield [key, value];T;0;6i;[; @¸Zo;= ;3I" overload;F;40;;¦;50;)I"select;T;IC;";T; @¸Z;>0;!F;[;[;I";T;0;6i;[; @¸Z;[;@ŠZ;0; @¸Z;!F;"o;#;$T;%i£ ;&i± ;'@T;(I"östatic 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;)I"static VALUE;T;*To;;F; ;;;;I"Hash#filter!;F;[;[[@—TiÞ ;T;:filter!;0;[;{;IC;"ØHash#filter! is an alias for Hash#select!. Returns +self+, whose entries are those for which the block returns a truthy value: h = {foo: 0, bar: 1, baz: 2} h.select! {|key, value| value < 2 } => {:foo=>0, :bar=>1} Returns +nil+ if no entries were removed. Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.select! # => #0, :bar=>1, :baz=>2}:select!> e.each { |key, value| value < 2 } # => {:foo=>0, :bar=>1} ;T;[o;= ;3I" overload;F;40;;À;50;)I"select!;T;IC;";T; @ÛZ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;TI" value;T; @ÛZo;2 ;3I"return;F;4I";T;0;5[I" self;TI"nil;T; @ÛZ;[;I",@yield [key, value] @return [self, nil];T;0;6i;[; @ÛZo;= ;3I" overload;F;40;;À;50;)I"select!;T;IC;";T; @ÛZ;>0;!F;[;[;I";T;0;6i;[; @ÛZ;[;@´Z;0; @ÛZ;!F;"o;#;$T;%iË ;&iÜ ;'@T;(I"8static VALUE rb_hash_select_bang(VALUE hash) { st_index_t n; RETURN_SIZED_ENUMERATOR(hash, 0, 0, hash_enum_size); rb_hash_modify_check(hash); n = RHASH_SIZE(hash); if (!n) return Qnil; rb_hash_foreach(hash, keep_if_i, hash); if (n == RHASH_SIZE(hash)) return Qnil; return hash; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#reject;F;[;[[@—Ti ;T;;/;0;[;{;IC;"²Returns a new \Hash object whose entries are all those from +self+ for which the block returns +false+ or +nil+: h = {foo: 0, bar: 1, baz: 2} h1 = h.reject {|key, value| key.start_with?('b') } h1 # => {:foo=>0} Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.reject # => #0, :bar=>1, :baz=>2}:reject> h1 = e.each {|key, value| key.start_with?('b') } h1 # => {:foo=>0} ;T;[o;= ;3I" overload;F;40;;/;50;)I"reject;T;IC;";T; @[;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;TI" value;T; @[;[;I"@yield [key, value];T;0;6i;[; @[o;= ;3I" overload;F;40;;/;50;)I"reject;T;IC;";T; @[;>0;!F;[;[;I";T;0;6i;[; @[;[;I"ìReturns a new \Hash object whose entries are all those from +self+ for which the block returns +false+ or +nil+: h = {foo: 0, bar: 1, baz: 2} h1 = h.reject {|key, value| key.start_with?('b') } h1 # => {:foo=>0} Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.reject # => #0, :bar=>1, :baz=>2}:reject> h1 = e.each {|key, value| key.start_with?('b') } h1 # => {:foo=>0} @overload reject @yield [key, value] @overload reject;T;0; @[;!F;"o;#;$T;%i ;&i ;'@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;)I" VALUE;T;*To;;F; ;;;;I"Hash#reject!;F;[;[[@—Tié ;T;:reject!;0;[;{;IC;"¯Returns +self+, whose remaining entries are those for which the block returns +false+ or +nil+: h = {foo: 0, bar: 1, baz: 2} h.reject! {|key, value| value < 2 } # => {:baz=>2} Returns +nil+ if no entries are removed. Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.reject! # => #0, :bar=>1, :baz=>2}:reject!> e.each {|key, value| key.start_with?('b') } # => {:foo=>0} ;T;[o;= ;3I" overload;F;40;;Â;50;)I"reject!;T;IC;";T; @([;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;TI" value;T; @([o;2 ;3I"return;F;4I";T;0;5[I" self;TI"nil;T; @([;[;I",@yield [key, value] @return [self, nil];T;0;6i;[; @([o;= ;3I" overload;F;40;;Â;50;)I"reject!;T;IC;";T; @([;>0;!F;[;[;I";T;0;6i;[; @([;[;I"Returns +self+, whose remaining entries are those for which the block returns +false+ or +nil+: h = {foo: 0, bar: 1, baz: 2} h.reject! {|key, value| value < 2 } # => {:baz=>2} Returns +nil+ if no entries are removed. Returns a new \Enumerator if no block given: h = {foo: 0, bar: 1, baz: 2} e = h.reject! # => #0, :bar=>1, :baz=>2}:reject!> e.each {|key, value| key.start_with?('b') } # => {:foo=>0} @overload reject! @yield [key, value] @return [self, nil] @overload reject!;T;0; @([;!F;"o;#;$T;%i× ;&iç ;'@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_SIZE(hash)) return Qnil; return hash; };T;)I" VALUE;T;*To;;F; ;;;;I"Hash#slice;F;[[@c0;[[@—Ti0 ;T;: slice;0;[;{;IC;"ÆReturns a new \Hash object containing the entries for the given +keys+: h = {foo: 0, bar: 1, baz: 2} h.slice(:baz, :foo) # => {:baz=>2, :foo=>0} Any given +keys+ that are not found are ignored. ;T;[o;= ;3I" overload;F;40;;Ã;50;)I"slice(*keys);T;IC;";T; @R[;>0;!F;[;[;I";T;0;6i;[[I" *keys;T0; @R[;[;I"ßReturns a new \Hash object containing the entries for the given +keys+: h = {foo: 0, bar: 1, baz: 2} h.slice(:baz, :foo) # => {:baz=>2, :foo=>0} Any given +keys+ that are not found are ignored. @overload slice(*keys);T;0; @R[;!F;"o;#;$T;%i% ;&i, ;'@T;(I"”static VALUE rb_hash_slice(int argc, VALUE *argv, VALUE hash) { int i; VALUE key, value, result; if (argc == 0 || RHASH_EMPTY_P(hash)) { return rb_hash_new(); } result = rb_hash_new_with_size(argc); for (i = 0; i < argc; i++) { key = argv[i]; value = rb_hash_lookup2(hash, key, Qundef); if (value != Qundef) rb_hash_aset(result, key, value); } return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#except;F;[[@c0;[[@—TiP ;T;:except;0;[;{;IC;"¿Returns a new \Hash excluding entries for the given +keys+: h = { a: 100, b: 200, c: 300 } h.except(:a) #=> {:b=>200, :c=>300} Any given +keys+ that are not found are ignored. ;T;[o;= ;3I" overload;F;40;;Ä;50;)I"except(*keys);T;IC;";T; @k[;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @k[;[;I"@return [Hash];T;0;6i;[[I" *keys;T0; @k[;[;I"êReturns a new \Hash excluding entries for the given +keys+: h = { a: 100, b: 200, c: 300 } h.except(:a) #=> {:b=>200, :c=>300} Any given +keys+ that are not found are ignored. @overload except(*keys) @return [Hash];T;0; @k[;!F;"o;#;$T;%iE ;&iM ;'@T;(I"static VALUE rb_hash_except(int argc, VALUE *argv, VALUE hash) { int i; VALUE key, result; result = hash_alloc(rb_cHash); hash_copy(result, hash); for (i = 0; i < argc; i++) { key = argv[i]; rb_hash_delete(result, key); } return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#clear;F;[;[[@—Ti;T;: clear;0;[;{;IC;".Removes all hash entries; returns +self+. ;T;[o;= ;3I" overload;F;40;;Å;50;)I" clear;T;IC;";T; @‰[;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @‰[;[;I"@return [self];T;0;6i;[; @‰[;[;I"QRemoves all hash entries; returns +self+. @overload clear @return [self];T;0; @‰[;!F;"o;#;$T;%i;&i;'@T;(I")VALUE rb_hash_clear(VALUE hash) { rb_hash_modify_check(hash); if (RHASH_ITER_LEV(hash) > 0) { rb_hash_foreach(hash, clear_i, 0); } else if (RHASH_AR_TABLE_P(hash)) { ar_clear(hash); } else { st_clear(RHASH_ST_TABLE(hash)); } return hash; };T;)I" VALUE;T;*To;;F; ;;;;I"Hash#invert;F;[;[[@—Ti1;T;:invert;0;[;{;IC;"&Returns a new \Hash object with the each key-value pair inverted: h = {foo: 0, bar: 1, baz: 2} h1 = h.invert h1 # => {0=>:foo, 1=>:bar, 2=>:baz} Overwrites any repeated new keys: (see {Entry Order}[#class-Hash-label-Entry+Order]): h = {foo: 0, bar: 0, baz: 0} h.invert # => {0=>:baz} ;T;[o;= ;3I" overload;F;40;;Æ;50;)I"invert;T;IC;";T; @¤[;>0;!F;[;[;I";T;0;6i;[; @¤[;[;I"9Returns a new \Hash object with the each key-value pair inverted: h = {foo: 0, bar: 1, baz: 2} h1 = h.invert h1 # => {0=>:foo, 1=>:bar, 2=>:baz} Overwrites any repeated new keys: (see {Entry Order}[#class-Hash-label-Entry+Order]): h = {foo: 0, bar: 0, baz: 0} h.invert # => {0=>:baz} @overload invert;T;0; @¤[;!F;"o;#;$T;%i";&i-;'@T;(I"¡static VALUE rb_hash_invert(VALUE hash) { VALUE h = rb_hash_new_with_size(RHASH_SIZE(hash)); rb_hash_foreach(hash, rb_hash_invert_i, h); return h; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#update;F;[[@c0;[[@—Tiž;T;:update;0;[;{;IC;"_Merges each of +other_hashes+ into +self+; returns +self+. Each argument in +other_hashes+ must be a \Hash. \Method #update is an alias for \#merge!. With arguments and no block: * Returns +self+, after the given hashes are merged into it. * The given hashes are merged left to right. * Each new entry is added at the end. * Each duplicate-key entry's value overwrites the previous value. Example: h = {foo: 0, bar: 1, baz: 2} h1 = {bat: 3, bar: 4} h2 = {bam: 5, bat:6} h.merge!(h1, h2) # => {:foo=>0, :bar=>4, :baz=>2, :bat=>6, :bam=>5} With arguments and a block: * Returns +self+, after the given hashes are merged. * The given hashes are merged left to right. * Each new-key entry is added at the end. * For each duplicate key: * Calls the block with the key and the old and new values. * The block's return value becomes the new value for the entry. Example: h = {foo: 0, bar: 1, baz: 2} h1 = {bat: 3, bar: 4} h2 = {bam: 5, bat:6} h3 = h.merge!(h1, h2) { |key, old_value, new_value| old_value + new_value } h3 # => {:foo=>0, :bar=>5, :baz=>2, :bat=>9, :bam=>5} With no arguments: * Returns +self+, unmodified. * The block, if given, is ignored. Example: h = {foo: 0, bar: 1, baz: 2} h.merge # => {:foo=>0, :bar=>1, :baz=>2} h1 = h.merge! { |key, old_value, new_value| raise 'Cannot happen' } h1 # => {:foo=>0, :bar=>1, :baz=>2} ;T;[o;= ;3I" overload;F;40;:merge!;50;)I"merge!;T;IC;";T; @º[;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @º[;[;I"@return [self];T;0;6i;[; @º[o;= ;3I" overload;F;40;;È;50;)I"merge!(*other_hashes);T;IC;";T; @º[;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @º[;[;I"@return [self];T;0;6i;[[I"*other_hashes;T0; @º[o;= ;3I" overload;F;40;;È;50;)I"merge!(*other_hashes);T;IC;";T; @º[;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;TI"old_value;TI"new_value;T; @º[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @º[;[;I"6@yield [key, old_value, new_value] @return [self];T;0;6i;[[I"*other_hashes;T0; @º[;[;I" Merges each of +other_hashes+ into +self+; returns +self+. Each argument in +other_hashes+ must be a \Hash. \Method #update is an alias for \#merge!. With arguments and no block: * Returns +self+, after the given hashes are merged into it. * The given hashes are merged left to right. * Each new entry is added at the end. * Each duplicate-key entry's value overwrites the previous value. Example: h = {foo: 0, bar: 1, baz: 2} h1 = {bat: 3, bar: 4} h2 = {bam: 5, bat:6} h.merge!(h1, h2) # => {:foo=>0, :bar=>4, :baz=>2, :bat=>6, :bam=>5} With arguments and a block: * Returns +self+, after the given hashes are merged. * The given hashes are merged left to right. * Each new-key entry is added at the end. * For each duplicate key: * Calls the block with the key and the old and new values. * The block's return value becomes the new value for the entry. Example: h = {foo: 0, bar: 1, baz: 2} h1 = {bat: 3, bar: 4} h2 = {bam: 5, bat:6} h3 = h.merge!(h1, h2) { |key, old_value, new_value| old_value + new_value } h3 # => {:foo=>0, :bar=>5, :baz=>2, :bat=>9, :bam=>5} With no arguments: * Returns +self+, unmodified. * The block, if given, is ignored. Example: h = {foo: 0, bar: 1, baz: 2} h.merge # => {:foo=>0, :bar=>1, :baz=>2} h1 = h.merge! { |key, old_value, new_value| raise 'Cannot happen' } h1 # => {:foo=>0, :bar=>1, :baz=>2} @overload merge! @return [self] @overload merge!(*other_hashes) @return [self] @overload merge!(*other_hashes) @yield [key, old_value, new_value] @return [self];T;0; @º[;!F;"o;#;$T;%il;&iž;'@T;(I"¤static VALUE rb_hash_update(int argc, VALUE *argv, VALUE self) { int i; bool block_given = rb_block_given_p(); rb_hash_modify(self); for (i = 0; i < argc; i++){ VALUE hash = to_hash(argv[i]); if (block_given) { rb_hash_foreach(hash, rb_hash_update_block_i, self); } else { rb_hash_foreach(hash, rb_hash_update_i, self); } } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#replace;F;[[I" hash2;T0;[[@—Ti†;T;;¥;0;[;{;IC;"®Replaces the entire contents of +self+ with the contents of +other_hash+; returns +self+: h = {foo: 0, bar: 1, baz: 2} h.replace({bat: 3, bam: 4}) # => {:bat=>3, :bam=>4} ;T;[o;= ;3I" overload;F;40;;¥;50;)I"replace(other_hash);T;IC;";T; @û[;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @û[;[;I"@return [self];T;0;6i;[[I"other_hash;T0; @û[;[;@*U;0; @û[;!F;"o;#;$T;%i|;&iƒ;'@T;(I"ástatic VALUE rb_hash_replace(VALUE hash, VALUE hash2) { rb_hash_modify_check(hash); if (hash == hash2) return hash; if (RHASH_ITER_LEV(hash) > 0) { rb_raise(rb_eRuntimeError, "can't replace hash during iteration"); } hash2 = to_hash(hash2); COPY_DEFAULT(hash, hash2); if (RHASH_AR_TABLE_P(hash)) { if (RHASH_AR_TABLE_P(hash2)) { ar_clear(hash); } else { ar_free_and_clear_table(hash); RHASH_ST_TABLE_SET(hash, st_init_table_with_size(RHASH_TYPE(hash2), RHASH_SIZE(hash2))); } } else { if (RHASH_AR_TABLE_P(hash2)) { st_free_table(RHASH_ST_TABLE(hash)); RHASH_ST_CLEAR(hash); } else { st_clear(RHASH_ST_TABLE(hash)); RHASH_TBL_RAW(hash)->type = RHASH_ST_TABLE(hash2)->type; } } rb_hash_foreach(hash2, rb_hash_rehash_i, (VALUE)hash); rb_gc_writebarrier_remember(hash); return hash; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#merge!;F;[[@c0;[[@—Tiž;T;;È;0;[;{;IC;"_Merges each of +other_hashes+ into +self+; returns +self+. Each argument in +other_hashes+ must be a \Hash. \Method #update is an alias for \#merge!. With arguments and no block: * Returns +self+, after the given hashes are merged into it. * The given hashes are merged left to right. * Each new entry is added at the end. * Each duplicate-key entry's value overwrites the previous value. Example: h = {foo: 0, bar: 1, baz: 2} h1 = {bat: 3, bar: 4} h2 = {bam: 5, bat:6} h.merge!(h1, h2) # => {:foo=>0, :bar=>4, :baz=>2, :bat=>6, :bam=>5} With arguments and a block: * Returns +self+, after the given hashes are merged. * The given hashes are merged left to right. * Each new-key entry is added at the end. * For each duplicate key: * Calls the block with the key and the old and new values. * The block's return value becomes the new value for the entry. Example: h = {foo: 0, bar: 1, baz: 2} h1 = {bat: 3, bar: 4} h2 = {bam: 5, bat:6} h3 = h.merge!(h1, h2) { |key, old_value, new_value| old_value + new_value } h3 # => {:foo=>0, :bar=>5, :baz=>2, :bat=>9, :bam=>5} With no arguments: * Returns +self+, unmodified. * The block, if given, is ignored. Example: h = {foo: 0, bar: 1, baz: 2} h.merge # => {:foo=>0, :bar=>1, :baz=>2} h1 = h.merge! { |key, old_value, new_value| raise 'Cannot happen' } h1 # => {:foo=>0, :bar=>1, :baz=>2} ;T;[o;= ;3I" overload;F;40;;È;50;)I"merge!;T;IC;";T; @\;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @\;[;I"@return [self];T;0;6i;[; @\o;= ;3I" overload;F;40;;È;50;)I"merge!(*other_hashes);T;IC;";T; @\;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @\;[;I"@return [self];T;0;6i;[[I"*other_hashes;T0; @\o;= ;3I" overload;F;40;;È;50;)I"merge!(*other_hashes);T;IC;";T; @\;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;TI"old_value;TI"new_value;T; @\o;2 ;3I"return;F;4I";T;0;5[I" self;T; @\;[;I"6@yield [key, old_value, new_value] @return [self];T;0;6i;[[I"*other_hashes;T0; @\;[;@÷[;0; @\;!F;"o;#;$T;%il;&iž;'@T;(I"¤static VALUE rb_hash_update(int argc, VALUE *argv, VALUE self) { int i; bool block_given = rb_block_given_p(); rb_hash_modify(self); for (i = 0; i < argc; i++){ VALUE hash = to_hash(argv[i]); if (block_given) { rb_hash_foreach(hash, rb_hash_update_block_i, self); } else { rb_hash_foreach(hash, rb_hash_update_i, self); } } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#merge;F;[[@c0;[[@—Ti;T;: merge;0;[;{;IC;"eReturns the new \Hash formed by merging each of +other_hashes+ into a copy of +self+. Each argument in +other_hashes+ must be a \Hash. --- With arguments and no block: * Returns the new \Hash object formed by merging each successive \Hash in +other_hashes+ into +self+. * Each new-key entry is added at the end. * Each duplicate-key entry's value overwrites the previous value. Example: h = {foo: 0, bar: 1, baz: 2} h1 = {bat: 3, bar: 4} h2 = {bam: 5, bat:6} h.merge(h1, h2) # => {:foo=>0, :bar=>4, :baz=>2, :bat=>6, :bam=>5} With arguments and a block: * Returns a new \Hash object that is the merge of +self+ and each given hash. * The given hashes are merged left to right. * Each new-key entry is added at the end. * For each duplicate key: * Calls the block with the key and the old and new values. * The block's return value becomes the new value for the entry. Example: h = {foo: 0, bar: 1, baz: 2} h1 = {bat: 3, bar: 4} h2 = {bam: 5, bat:6} h3 = h.merge(h1, h2) { |key, old_value, new_value| old_value + new_value } h3 # => {:foo=>0, :bar=>5, :baz=>2, :bat=>9, :bam=>5} With no arguments: * Returns a copy of +self+. * The block, if given, is ignored. Example: h = {foo: 0, bar: 1, baz: 2} h.merge # => {:foo=>0, :bar=>1, :baz=>2} h1 = h.merge { |key, old_value, new_value| raise 'Cannot happen' } h1 # => {:foo=>0, :bar=>1, :baz=>2} ;T;[o;= ;3I" overload;F;40;;É;50;)I" merge;T;IC;";T; @Y\;>0;!F;[;[;I";T;0;6i;[; @Y\o;= ;3I" overload;F;40;;É;50;)I"merge(*other_hashes);T;IC;";T; @Y\;>0;!F;[;[;I";T;0;6i;[[I"*other_hashes;T0; @Y\o;= ;3I" overload;F;40;;É;50;)I"merge(*other_hashes);T;IC;";T; @Y\;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;TI"old_value;TI"new_value;T; @Y\;[;I"'@yield [key, old_value, new_value];T;0;6i;[[I"*other_hashes;T0; @Y\;[;I"ÚReturns the new \Hash formed by merging each of +other_hashes+ into a copy of +self+. Each argument in +other_hashes+ must be a \Hash. --- With arguments and no block: * Returns the new \Hash object formed by merging each successive \Hash in +other_hashes+ into +self+. * Each new-key entry is added at the end. * Each duplicate-key entry's value overwrites the previous value. Example: h = {foo: 0, bar: 1, baz: 2} h1 = {bat: 3, bar: 4} h2 = {bam: 5, bat:6} h.merge(h1, h2) # => {:foo=>0, :bar=>4, :baz=>2, :bat=>6, :bam=>5} With arguments and a block: * Returns a new \Hash object that is the merge of +self+ and each given hash. * The given hashes are merged left to right. * Each new-key entry is added at the end. * For each duplicate key: * Calls the block with the key and the old and new values. * The block's return value becomes the new value for the entry. Example: h = {foo: 0, bar: 1, baz: 2} h1 = {bat: 3, bar: 4} h2 = {bam: 5, bat:6} h3 = h.merge(h1, h2) { |key, old_value, new_value| old_value + new_value } h3 # => {:foo=>0, :bar=>5, :baz=>2, :bat=>9, :bam=>5} With no arguments: * Returns a copy of +self+. * The block, if given, is ignored. Example: h = {foo: 0, bar: 1, baz: 2} h.merge # => {:foo=>0, :bar=>1, :baz=>2} h1 = h.merge { |key, old_value, new_value| raise 'Cannot happen' } h1 # => {:foo=>0, :bar=>1, :baz=>2} @overload merge @overload merge(*other_hashes) @overload merge(*other_hashes) @yield [key, old_value, new_value];T;0; @Y\;!F;"o;#;$T;%iç;&i;'@T;(I"{static VALUE rb_hash_merge(int argc, VALUE *argv, VALUE self) { return rb_hash_update(argc, argv, rb_hash_dup(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#assoc;F;[[I"key;T0;[[@—TiR;T;: assoc;0;[;{;IC;"ÂIf the given +key+ is found, returns a 2-element \Array containing that key and its value: h = {foo: 0, bar: 1, baz: 2} h.assoc(:bar) # => [:bar, 1] Returns +nil+ if key +key+ is not found. ;T;[o;= ;3I" overload;F;40;;Ê;50;)I"assoc(key);T;IC;";T; @‹\;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @‹\;[;I"@return [nil];T;0;6i;[[I"key;T0; @‹\;[;I"éIf the given +key+ is found, returns a 2-element \Array containing that key and its value: h = {foo: 0, bar: 1, baz: 2} h.assoc(:bar) # => [:bar, 1] Returns +nil+ if key +key+ is not found. @overload assoc(key) @return [nil];T;0; @‹\;!F;"o;#;$T;%iG;&iO;'@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; ar_force_convert_table(hash, __FILE__, __LINE__); HASH_ASSERT(RHASH_ST_TABLE_P(hash)); table = RHASH_ST_TABLE(hash); 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;)I" VALUE;T;*To;;F; ;;;;I"Hash#rassoc;F;[[I"obj;T0;[[@—Ti;T;:rassoc;0;[;{;IC;"Returns a new 2-element \Array consisting of the key and value of the first-found entry whose value is == to value (see {Entry Order}[#class-Hash-label-Entry+Order]): h = {foo: 0, bar: 1, baz: 1} h.rassoc(1) # => [:bar, 1] Returns +nil+ if no such value found. ;T;[o;= ;3I" overload;F;40;;Ë;50;)I"rassoc(value);T;IC;";T; @ª\;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @ª\;[;I"@return [nil];T;0;6i;[[I" value;T0; @ª\;[;I"== to value (see {Entry Order}[#class-Hash-label-Entry+Order]): h = {foo: 0, bar: 1, baz: 1} h.rassoc(1) # => [:bar, 1] Returns +nil+ if no such value found. @overload rassoc(value) @return [nil];T;0; @ª\;!F;"o;#;$T;%i‚;&iŒ;'@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;)I" VALUE;T;*To;;F; ;;;;I"Hash#flatten;F;[[@c0;[[@—TiÅ;T;:flatten;0;[;{;IC;"ÇReturns a new \Array object that is a 1-dimensional flattening of +self+. --- By default, nested Arrays are not flattened: h = {foo: 0, bar: [:bat, 3], baz: 2} h.flatten # => [:foo, 0, :bar, [:bat, 3], :baz, 2] Takes the depth of recursive flattening from \Integer argument +level+: h = {foo: 0, bar: [:bat, [:baz, [:bat, ]]]} h.flatten(1) # => [:foo, 0, :bar, [:bat, [:baz, [:bat]]]] h.flatten(2) # => [:foo, 0, :bar, :bat, [:baz, [:bat]]] h.flatten(3) # => [:foo, 0, :bar, :bat, :baz, [:bat]] h.flatten(4) # => [:foo, 0, :bar, :bat, :baz, :bat] When +level+ is negative, flattens all nested Arrays: h = {foo: 0, bar: [:bat, [:baz, [:bat, ]]]} h.flatten(-1) # => [:foo, 0, :bar, :bat, :baz, :bat] h.flatten(-2) # => [:foo, 0, :bar, :bat, :baz, :bat] When +level+ is zero, returns the equivalent of #to_a : h = {foo: 0, bar: [:bat, 3], baz: 2} h.flatten(0) # => [[:foo, 0], [:bar, [:bat, 3]], [:baz, 2]] h.flatten(0) == h.to_a # => true ;T;[o;= ;3I" overload;F;40;;Ì;50;)I"flatten;T;IC;";T; @É\;>0;!F;[;[;I";T;0;6i;[; @É\o;= ;3I" overload;F;40;;Ì;50;)I"flatten(level);T;IC;";T; @É\;>0;!F;[;[;I";T;0;6i;[[I" level;T0; @É\;[;I"ôReturns a new \Array object that is a 1-dimensional flattening of +self+. --- By default, nested Arrays are not flattened: h = {foo: 0, bar: [:bat, 3], baz: 2} h.flatten # => [:foo, 0, :bar, [:bat, 3], :baz, 2] Takes the depth of recursive flattening from \Integer argument +level+: h = {foo: 0, bar: [:bat, [:baz, [:bat, ]]]} h.flatten(1) # => [:foo, 0, :bar, [:bat, [:baz, [:bat]]]] h.flatten(2) # => [:foo, 0, :bar, :bat, [:baz, [:bat]]] h.flatten(3) # => [:foo, 0, :bar, :bat, :baz, [:bat]] h.flatten(4) # => [:foo, 0, :bar, :bat, :baz, :bat] When +level+ is negative, flattens all nested Arrays: h = {foo: 0, bar: [:bat, [:baz, [:bat, ]]]} h.flatten(-1) # => [:foo, 0, :bar, :bat, :baz, :bat] h.flatten(-2) # => [:foo, 0, :bar, :bat, :baz, :bat] When +level+ is zero, returns the equivalent of #to_a : h = {foo: 0, bar: [:bat, 3], baz: 2} h.flatten(0) # => [[:foo, 0], [:bar, [:bat, 3]], [:baz, 2]] h.flatten(0) == h.to_a # => true @overload flatten @overload flatten(level);T;0; @É\;!F;"o;#;$T;%i¦;&iÁ;'@T;(I"šstatic VALUE rb_hash_flatten(int argc, VALUE *argv, VALUE hash) { VALUE ary; rb_check_arity(argc, 0, 1); if (argc) { int level = NUM2INT(argv[0]); 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); level--; if (level > 0) { VALUE ary_flatten_level = INT2FIX(level); rb_funcallv(ary, id_flatten_bang, 1, &ary_flatten_level); } else if (level < 0) { /* flatten recursively */ rb_funcallv(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;)I"static VALUE;T;*To;;F; ;;;;I"Hash#compact;F;[;[[@—Ti;T;:compact;0;[;{;IC;"˜Returns a copy of +self+ with all +nil+-valued entries removed: h = {foo: 0, bar: nil, baz: 2, bat: nil} h1 = h.compact h1 # => {:foo=>0, :baz=>2} ;T;[o;= ;3I" overload;F;40;;Í;50;)I"compact;T;IC;";T; @ê\;>0;!F;[;[;I";T;0;6i;[; @ê\;[;I"¬Returns a copy of +self+ with all +nil+-valued entries removed: h = {foo: 0, bar: nil, baz: 2, bat: nil} h1 = h.compact h1 # => {:foo=>0, :baz=>2} @overload compact;T;0; @ê\;!F;"o;#;$T;%iø;&iþ;'@T;(I"·static VALUE rb_hash_compact(VALUE hash) { VALUE result = rb_hash_new(); if (!RHASH_EMPTY_P(hash)) { rb_hash_foreach(hash, set_if_not_nil, result); } return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#compact!;F;[;[[@—Ti;T;: compact!;0;[;{;IC;"¿Returns +self+ with all its +nil+-valued entries removed (in place): h = {foo: 0, bar: nil, baz: 2, bat: nil} h.compact! # => {:foo=>0, :baz=>2} Returns +nil+ if no entries were removed. ;T;[o;= ;3I" overload;F;40;;Î;50;)I" compact!;T;IC;";T; @];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;TI"nil;T; @];[;I"@return [self, nil];T;0;6i;[; @];[;I"êReturns +self+ with all its +nil+-valued entries removed (in place): h = {foo: 0, bar: nil, baz: 2, bat: nil} h.compact! # => {:foo=>0, :baz=>2} Returns +nil+ if no entries were removed. @overload compact! @return [self, nil];T;0; @];!F;"o;#;$T;%i;&i;'@T;(I"static VALUE rb_hash_compact_bang(VALUE hash) { st_index_t n; rb_hash_modify_check(hash); n = RHASH_SIZE(hash); if (n) { rb_hash_foreach(hash, delete_if_nil, hash); if (n != RHASH_SIZE(hash)) return hash; } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#include?;F;[[I"key;T0;[[@—TiH;T;;E;0;[;{;IC;"‚Methods #has_key?, #key?, and #member? are aliases for \#include?. Returns +true+ if +key+ is a key in +self+, otherwise +false+.;T;[ o;= ;3I" overload;F;40;;E;50;)I"include?(key);T;IC;";T; @];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @];[;I"@return [Boolean];T;0;6i;[[I"key;T0; @]o;= ;3I" overload;F;40;: has_key?;50;)I"has_key?(key);T;IC;";T; @];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @];[;I"@return [Boolean];T;0;6i;[[I"key;T0; @]o;= ;3I" overload;F;40;;Å;50;)I"key?(key);T;IC;";T; @];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @];[;I"@return [Boolean];T;0;6i;[[I"key;T0; @]o;= ;3I" overload;F;40;;D;50;)I"member?(key);T;IC;";T; @];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @];[;I"@return [Boolean];T;0;6i;[[I"key;T0; @];[;I"/Methods #has_key?, #key?, and #member? are aliases for \#include?. Returns +true+ if +key+ is a key in +self+, otherwise +false+. @overload include?(key) @return [Boolean] @overload has_key?(key) @return [Boolean] @overload key?(key) @return [Boolean] @overload member?(key) @return [Boolean];T;0; @];!F;"o;#;$T;%i<;&iH;6i;'@T;(I"¶MJIT_FUNC_EXPORTED VALUE rb_hash_has_key(VALUE hash, VALUE key) { if (hash_stlike_lookup(hash, key, NULL)) { return Qtrue; } else { return Qfalse; } };T;)I"MJIT_FUNC_EXPORTED VALUE;T;*To;;F; ;;;;I"Hash#member?;F;[[I"key;T0;[[@—TiH;T;;D;0;[;{;IC;"‚Methods #has_key?, #key?, and #member? are aliases for \#include?. Returns +true+ if +key+ is a key in +self+, otherwise +false+.;T;[ o;= ;3I" overload;F;40;;E;50;)I"include?(key);T;IC;";T; @h];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @h];[;I"@return [Boolean];T;0;6i;[[I"key;T0; @h]o;= ;3I" overload;F;40;;Ï;50;)I"has_key?(key);T;IC;";T; @h];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @h];[;I"@return [Boolean];T;0;6i;[[I"key;T0; @h]o;= ;3I" overload;F;40;;Å;50;)I"key?(key);T;IC;";T; @h];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @h];[;I"@return [Boolean];T;0;6i;[[I"key;T0; @h]o;= ;3I" overload;F;40;;D;50;)I"member?(key);T;IC;";T; @h];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @h];[;I"@return [Boolean];T;0;6i;[[I"key;T0; @h];[;@d];0; @h];!F;"o;#;$T;%i<;&iH;6i;'@T;(I"¶MJIT_FUNC_EXPORTED VALUE rb_hash_has_key(VALUE hash, VALUE key) { if (hash_stlike_lookup(hash, key, NULL)) { return Qtrue; } else { return Qfalse; } };T;)I"MJIT_FUNC_EXPORTED VALUE;T;*To;;F; ;;;;I"Hash#has_key?;F;[[I"key;T0;[[@—TiH;T;;Ï;0;[;{;IC;"‚Methods #has_key?, #key?, and #member? are aliases for \#include?. Returns +true+ if +key+ is a key in +self+, otherwise +false+.;T;[ o;= ;3I" overload;F;40;;E;50;)I"include?(key);T;IC;";T; @³];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @³];[;I"@return [Boolean];T;0;6i;[[I"key;T0; @³]o;= ;3I" overload;F;40;;Ï;50;)I"has_key?(key);T;IC;";T; @³];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @³];[;I"@return [Boolean];T;0;6i;[[I"key;T0; @³]o;= ;3I" overload;F;40;;Å;50;)I"key?(key);T;IC;";T; @³];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @³];[;I"@return [Boolean];T;0;6i;[[I"key;T0; @³]o;= ;3I" overload;F;40;;D;50;)I"member?(key);T;IC;";T; @³];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @³];[;I"@return [Boolean];T;0;6i;[[I"key;T0; @³];[;@d];0; @³];!F;"o;#;$T;%i<;&iH;6i;'@T;(I"¶MJIT_FUNC_EXPORTED VALUE rb_hash_has_key(VALUE hash, VALUE key) { if (hash_stlike_lookup(hash, key, NULL)) { return Qtrue; } else { return Qfalse; } };T;)I"MJIT_FUNC_EXPORTED VALUE;T;*To;;F; ;;;;I"Hash#has_value?;F;[[I"val;T0;[[@—Tif;T;:has_value?;0;[;{;IC;"GReturns +true+ if +value+ is a value in +self+, otherwise +false+.;T;[o;= ;3I" overload;F;40;;Ð;50;)I"has_value?(value);T;IC;";T; @þ];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @þ];[;I"@return [Boolean];T;0;6i;[[I" value;T0; @þ];[;I"yReturns +true+ if +value+ is a value in +self+, otherwise +false+. @overload has_value?(value) @return [Boolean];T;0; @þ];!F;"o;#;$T;%i_;⁣6i;'@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;)I"static VALUE;T;*To;;F; ;;;;I"Hash#key?;F;[[I"key;T0;[[@—TiH;T;;Å;0;[;{;IC;"‚Methods #has_key?, #key?, and #member? are aliases for \#include?. Returns +true+ if +key+ is a key in +self+, otherwise +false+.;T;[ o;= ;3I" overload;F;40;;E;50;)I"include?(key);T;IC;";T; @^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @^;[;I"@return [Boolean];T;0;6i;[[I"key;T0; @^o;= ;3I" overload;F;40;;Ï;50;)I"has_key?(key);T;IC;";T; @^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @^;[;I"@return [Boolean];T;0;6i;[[I"key;T0; @^o;= ;3I" overload;F;40;;Å;50;)I"key?(key);T;IC;";T; @^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @^;[;I"@return [Boolean];T;0;6i;[[I"key;T0; @^o;= ;3I" overload;F;40;;D;50;)I"member?(key);T;IC;";T; @^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @^;[;I"@return [Boolean];T;0;6i;[[I"key;T0; @^;[;@d];0; @^;!F;"o;#;$T;%i<;&iH;6i;'@T;(I"¶MJIT_FUNC_EXPORTED VALUE rb_hash_has_key(VALUE hash, VALUE key) { if (hash_stlike_lookup(hash, key, NULL)) { return Qtrue; } else { return Qfalse; } };T;)I"MJIT_FUNC_EXPORTED VALUE;T;*To;;F; ;;;;I"Hash#value?;F;[[I"val;T0;[[@—Tif;T;:value?;0;[;{;IC;"GReturns +true+ if +value+ is a value in +self+, otherwise +false+.;T;[o;= ;3I" overload;F;40;;Ð;50;)I"has_value?(value);T;IC;";T; @h^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @h^;[;I"@return [Boolean];T;0;6i;[[I" value;T0; @h^;[;@^;0; @h^;!F;"o;#;$T;%i_;⁣6i;'@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;)I"static VALUE;T;*To;;F; ;;;;I"Hash#compare_by_identity;F;[;[[@—TiC;T;:compare_by_identity;0;[;{;IC;"NSets +self+ to consider only identity in comparing keys; two keys are considered the same only if they are the same object; returns +self+. By default, these two object are considered to be the same key, so +s1+ will overwrite +s0+: s0 = 'x' s1 = 'x' h = {} h.compare_by_identity? # => false h[s0] = 0 h[s1] = 1 h # => {"x"=>1} After calling \#compare_by_identity, the keys are considered to be different, and therefore do not overwrite each other: h = {} h.compare_by_identity # => {} h.compare_by_identity? # => true h[s0] = 0 h[s1] = 1 h # => {"x"=>0, "x"=>1} ;T;[o;= ;3I" overload;F;40;;Ò;50;)I"compare_by_identity;T;IC;";T; @†^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @†^;[;I"@return [self];T;0;6i;[; @†^;[;I"Sets +self+ to consider only identity in comparing keys; two keys are considered the same only if they are the same object; returns +self+. By default, these two object are considered to be the same key, so +s1+ will overwrite +s0+: s0 = 'x' s1 = 'x' h = {} h.compare_by_identity? # => false h[s0] = 0 h[s1] = 1 h # => {"x"=>1} After calling \#compare_by_identity, the keys are considered to be different, and therefore do not overwrite each other: h = {} h.compare_by_identity # => {} h.compare_by_identity? # => true h[s0] = 0 h[s1] = 1 h # => {"x"=>0, "x"=>1} @overload compare_by_identity @return [self];T;0; @†^;!F;"o;#;$T;%i';&i@;'@T;(I"istatic VALUE rb_hash_compare_by_id(VALUE hash) { VALUE tmp; st_table *identtable; if (rb_hash_compare_by_id_p(hash)) return hash; rb_hash_modify_check(hash); ar_force_convert_table(hash, __FILE__, __LINE__); HASH_ASSERT(RHASH_ST_TABLE_P(hash)); tmp = hash_alloc(0); identtable = rb_init_identtable_with_size(RHASH_SIZE(hash)); RHASH_ST_TABLE_SET(tmp, identtable); rb_hash_foreach(hash, rb_hash_rehash_i, (VALUE)tmp); st_free_table(RHASH_ST_TABLE(hash)); RHASH_ST_TABLE_SET(hash, identtable); RHASH_ST_CLEAR(tmp); rb_gc_force_recycle(tmp); return hash; };T;)I"static VALUE;T;*To;;F; ;;;;I"Hash#compare_by_identity?;F;[;[[@—Tib;T;:compare_by_identity?;0;[;{;IC;"OReturns +true+ if #compare_by_identity has been called, +false+ otherwise.;T;[o;= ;3I" overload;F;40;;Ó;50;)I"compare_by_identity?;T;IC;";T; @¡^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @¡^;[;I"@return [Boolean];T;0;6i;[; @¡^;[;I"Returns +true+ if #compare_by_identity has been called, +false+ otherwise. @overload compare_by_identity? @return [Boolean];T;0; @¡^;!F;"o;#;$T;%i[;&i_;6i;'@T;(I"ËMJIT_FUNC_EXPORTED VALUE rb_hash_compare_by_id_p(VALUE hash) { if (RHASH_ST_TABLE_P(hash) && RHASH_ST_TABLE(hash)->type == &identhash) { return Qtrue; } else { return Qfalse; } };T;)I"MJIT_FUNC_EXPORTED VALUE;T;*To;;F; ;;;;I"Hash#any?;F;[[@c0;[[@—Ti¿;T;;;;0;[;{;IC;"”Returns +true+ if any element satisfies a given criterion; +false+ otherwise. With no argument and no block, returns +true+ if +self+ is non-empty; +false+ if empty. With argument +object+ and no block, returns +true+ if for any key +key+ h.assoc(key) == object: h = {foo: 0, bar: 1, baz: 2} h.any?([:bar, 1]) # => true h.any?([:bar, 0]) # => false h.any?([:baz, 1]) # => false With no argument and a block, calls the block with each key-value pair; returns +true+ if the block returns any truthy value, +false+ otherwise: h = {foo: 0, bar: 1, baz: 2} h.any? {|key, value| value < 3 } # => true h.any? {|key, value| value > 3 } # => false;T;[o;= ;3I" overload;F;40;;;;50;)I" any?;T;IC;";T; @¼^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @¼^;[;I"@return [Boolean];T;0;6i;[; @¼^o;= ;3I" overload;F;40;;;;50;)I"any?(object);T;IC;";T; @¼^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @¼^;[;I"@return [Boolean];T;0;6i;[[I"object;T0; @¼^o;= ;3I" overload;F;40;;;;50;)I" any?;T;IC;";T; @¼^;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"key;TI" value;T; @¼^o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @¼^;[;I"*@yield [key, value] @return [Boolean];T;0;6i;[; @¼^;[;I"Returns +true+ if any element satisfies a given criterion; +false+ otherwise. With no argument and no block, returns +true+ if +self+ is non-empty; +false+ if empty. With argument +object+ and no block, returns +true+ if for any key +key+ h.assoc(key) == object: h = {foo: 0, bar: 1, baz: 2} h.any?([:bar, 1]) # => true h.any?([:bar, 0]) # => false h.any?([:baz, 1]) # => false With no argument and a block, calls the block with each key-value pair; returns +true+ if the block returns any truthy value, +false+ otherwise: h = {foo: 0, bar: 1, baz: 2} h.any? {|key, value| value < 3 } # => true h.any? {|key, value| value > 3 } # => false @overload any? @return [Boolean] @overload any?(object) @return [Boolean] @overload any? @yield [key, value] @return [Boolean];T;0; @¼^;!F;"o;#;$T;%i¢;&i¿;6i;'@T;(I"‹static VALUE rb_hash_any_p(int argc, VALUE *argv, VALUE hash) { VALUE args[2]; args[0] = Qfalse; rb_check_arity(argc, 0, 1); if (RHASH_EMPTY_P(hash)) return Qfalse; if (argc) { if (rb_block_given_p()) { rb_warn("given block not used"); } args[1] = argv[0]; rb_hash_foreach(hash, any_p_i_pattern, (VALUE)args); } else { if (!rb_block_given_p()) { /* yields pairs, never false */ return Qtrue; } if (rb_block_pair_yield_optimizable()) rb_hash_foreach(hash, any_p_i_fast, (VALUE)args); else rb_hash_foreach(hash, any_p_i, (VALUE)args); } return args[0]; };T;)I"static VALUE;T;*To;;F; ;;;;I" Hash#dig;F;[[@c0;[[@—Tiù;T;:dig;0;[;{;IC;"Finds and returns the object in nested objects that is specified by +key+ and +identifiers+. The nested objects may be instances of various classes. See {Dig Methods}[rdoc-ref:doc/dig_methods.rdoc]. Nested Hashes: h = {foo: {bar: {baz: 2}}} h.dig(:foo) # => {:bar=>{:baz=>2}} h.dig(:foo, :bar) # => {:bar=>{:baz=>2}} h.dig(:foo, :bar, :baz) # => 2 h.dig(:foo, :bar, :BAZ) # => nil Nested Hashes and Arrays: h = {foo: {bar: [:a, :b, :c]}} h.dig(:foo, :bar, 2) # => :c This method will use the {default values}[#class-Hash-label-Default+Values] for keys that are not present: h = {foo: {bar: [:a, :b, :c]}} h.dig(:hello) # => nil h.default_proc = -> (hash, _key) { hash } h.dig(:hello, :world) # => h h.dig(:hello, :world, :foo, :bar, 2) # => :c ;T;[o;= ;3I" overload;F;40;;Ô;50;)I"dig(key, *identifiers);T;IC;";T; @ú^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @ú^;[;I"@return [Object];T;0;6i;[[I"key;T0[I"*identifiers;T0; @ú^;[;I"8Finds and returns the object in nested objects that is specified by +key+ and +identifiers+. The nested objects may be instances of various classes. See {Dig Methods}[rdoc-ref:doc/dig_methods.rdoc]. Nested Hashes: h = {foo: {bar: {baz: 2}}} h.dig(:foo) # => {:bar=>{:baz=>2}} h.dig(:foo, :bar) # => {:bar=>{:baz=>2}} h.dig(:foo, :bar, :baz) # => 2 h.dig(:foo, :bar, :BAZ) # => nil Nested Hashes and Arrays: h = {foo: {bar: [:a, :b, :c]}} h.dig(:foo, :bar, 2) # => :c This method will use the {default values}[#class-Hash-label-Default+Values] for keys that are not present: h = {foo: {bar: [:a, :b, :c]}} h.dig(:hello) # => nil h.default_proc = -> (hash, _key) { hash } h.dig(:hello, :world) # => h h.dig(:hello, :world, :foo, :bar, 2) # => :c @overload dig(key, *identifiers) @return [Object];T;0; @ú^;!F;"o;#;$T;%iÜ;&iö;'@T;(I"ðstatic 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;)I"static VALUE;T;*To;;F; ;;;;I"Hash#<=;F;[[I" other;T0;[[@—Ti";T;;€;0;[;{;IC;"ÀReturns +true+ if +hash+ is a subset of +other_hash+, +false+ otherwise: h1 = {foo: 0, bar: 1} h2 = {foo: 0, bar: 1, baz: 2} h1 <= h2 # => true h2 <= h1 # => false h1 <= h1 # => true ;T;[o;= ;3I" overload;F;40;;€;50;)I"<=(other_hash);T;IC;";T; @_;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @_;[;I"@return [Boolean];T;0;6i;[[I"other_hash;T0; @_;[;I"ïReturns +true+ if +hash+ is a subset of +other_hash+, +false+ otherwise: h1 = {foo: 0, bar: 1} h2 = {foo: 0, bar: 1, baz: 2} h1 <= h2 # => true h2 <= h1 # => false h1 <= h1 # => true @overload <=(other_hash) @return [Boolean];T;0; @_;!F;"o;#;$T;%i;&i ;'@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;)I"static VALUE;T;*To;;F; ;;;;I"Hash#<;F;[[I" other;T0;[[@—Ti5;T;;;0;[;{;IC;"ÅReturns +true+ if +hash+ is a proper subset of +other_hash+, +false+ otherwise: h1 = {foo: 0, bar: 1} h2 = {foo: 0, bar: 1, baz: 2} h1 < h2 # => true h2 < h1 # => false h1 < h1 # => false ;T;[o;= ;3I" overload;F;40;;;50;)I"<(other_hash);T;IC;";T; @9_;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @9_;[;I"@return [Boolean];T;0;6i;[[I"other_hash;T0; @9_;[;I"óReturns +true+ if +hash+ is a proper subset of +other_hash+, +false+ otherwise: h1 = {foo: 0, bar: 1} h2 = {foo: 0, bar: 1, baz: 2} h1 < h2 # => true h2 < h1 # => false h1 < h1 # => false @overload <(other_hash) @return [Boolean];T;0; @9_;!F;"o;#;$T;%i*;&i3;'@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;)I"static VALUE;T;*To;;F; ;;;;I"Hash#>=;F;[[I" other;T0;[[@—TiH;T;;‚;0;[;{;IC;"ÂReturns +true+ if +hash+ is a superset of +other_hash+, +false+ otherwise: h1 = {foo: 0, bar: 1, baz: 2} h2 = {foo: 0, bar: 1} h1 >= h2 # => true h2 >= h1 # => false h1 >= h1 # => true ;T;[o;= ;3I" overload;F;40;;‚;50;)I">=(other_hash);T;IC;";T; @X_;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @X_;[;I"@return [Boolean];T;0;6i;[[I"other_hash;T0; @X_;[;I"ñReturns +true+ if +hash+ is a superset of +other_hash+, +false+ otherwise: h1 = {foo: 0, bar: 1, baz: 2} h2 = {foo: 0, bar: 1} h1 >= h2 # => true h2 >= h1 # => false h1 >= h1 # => true @overload >=(other_hash) @return [Boolean];T;0; @X_;!F;"o;#;$T;%i=;&iF;'@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;)I"static VALUE;T;*To;;F; ;;;;I"Hash#>;F;[[I" other;T0;[[@—Ti[;T;;;0;[;{;IC;"ÇReturns +true+ if +hash+ is a proper superset of +other_hash+, +false+ otherwise: h1 = {foo: 0, bar: 1, baz: 2} h2 = {foo: 0, bar: 1} h1 > h2 # => true h2 > h1 # => false h1 > h1 # => false ;T;[o;= ;3I" overload;F;40;;;50;)I">(other_hash);T;IC;";T; @w_;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @w_;[;I"@return [Boolean];T;0;6i;[[I"other_hash;T0; @w_;[;I"õReturns +true+ if +hash+ is a proper superset of +other_hash+, +false+ otherwise: h1 = {foo: 0, bar: 1, baz: 2} h2 = {foo: 0, bar: 1} h1 > h2 # => true h2 > h1 # => false h1 > h1 # => false @overload >(other_hash) @return [Boolean];T;0; @w_;!F;"o;#;$T;%iP;&iY;'@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;)I"static VALUE;T;*To;;F; ;;;;I"Hash#deconstruct_keys;F;[[I" keys;T0;[[@—Ti|;T;:deconstruct_keys;0;[;{;IC;";T;[;[;@|;0; @–_;'@T;(I"Wstatic VALUE rb_hash_deconstruct_keys(VALUE hash, VALUE keys) { return hash; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Hash.ruby2_keywords_hash?;F;[[I" hash;T0;[[@—Ti~;T;:ruby2_keywords_hash?;0;[;{;IC;"SChecks if a given hash is flagged by Module#ruby2_keywords (or Proc#ruby2_keywords). This method is not for casual use; debugging, researching, and some truly necessary cases like serialization of arguments. ruby2_keywords def foo(*args) Hash.ruby2_keywords_hash?(args.last) end foo(k: 1) #=> true foo({k: 1}) #=> false;T;[o;= ;3I" overload;F;40;;Ö;50;)I"ruby2_keywords_hash?(hash);T;IC;";T; @¤_;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @¤_;[;I"@return [Boolean];T;0;6i;[[I" hash;T0; @¤_;[;I"ŽChecks if a given hash is flagged by Module#ruby2_keywords (or Proc#ruby2_keywords). This method is not for casual use; debugging, researching, and some truly necessary cases like serialization of arguments. ruby2_keywords def foo(*args) Hash.ruby2_keywords_hash?(args.last) end foo(k: 1) #=> true foo({k: 1}) #=> false @overload ruby2_keywords_hash?(hash) @return [Boolean];T;0; @¤_;!F;"o;#;$T;%io;&i|;6i;'@T;(I"¸static VALUE rb_hash_s_ruby2_keywords_hash_p(VALUE dummy, VALUE hash) { Check_Type(hash, T_HASH); return (RHASH(hash)->basic.flags & RHASH_PASS_AS_KEYWORDS) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Hash.ruby2_keywords_hash;F;[[I" hash;T0;[[@—Ti”;T;:ruby2_keywords_hash;0;[;{;IC;" 1 with neither a warning or an error ;T;[o;= ;3I" overload;F;40;;×;50;)I"ruby2_keywords_hash(hash);T;IC;";T; @Ã_;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @Ã_;[;I"@return [Hash];T;0;6i;[[I" hash;T0; @Ã_;[;I"sDuplicates a given hash and adds a ruby2_keywords flag. This method is not for casual use; debugging, researching, and some truly necessary cases like deserialization of arguments. h = {k: 1} h = Hash.ruby2_keywords_hash(h) def foo(k: 42) k end foo(*[h]) #=> 1 with neither a warning or an error @overload ruby2_keywords_hash(hash) @return [Hash];T;0; @Ã_;!F;"o;#;$T;%i…;&i’;'@T;(I"Ìstatic VALUE rb_hash_s_ruby2_keywords_hash(VALUE dummy, VALUE hash) { Check_Type(hash, T_HASH); hash = rb_hash_dup(hash); RHASH(hash)->basic.flags |= RHASH_PASS_AS_KEYWORDS; return hash; };T;)I"static VALUE;T;*T;A@T;BIC;[;A@T;CIC;[o;L;M0;N0;O0;;;'@;Q@(;R0;A@T;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@¶U;r;I[;[[@—TiÑ;F;;¼;;K;;;[;{;IC;"Y"A \Hash maps each of its unique keys to a specific value. A \Hash has certain similarities to an \Array, but: - An \Array index is always an \Integer. - A \Hash key can be (almost) any object. === \Hash \Data Syntax The older syntax for \Hash data uses the "hash rocket," =>: h = {:foo => 0, :bar => 1, :baz => 2} h # => {:foo=>0, :bar=>1, :baz=>2} Alternatively, but only for a \Hash key that's a \Symbol, you can use a newer JSON-style syntax, where each bareword becomes a \Symbol: h = {foo: 0, bar: 1, baz: 2} h # => {:foo=>0, :bar=>1, :baz=>2} You can also use a \String in place of a bareword: h = {'foo': 0, 'bar': 1, 'baz': 2} h # => {:foo=>0, :bar=>1, :baz=>2} And you can mix the styles: h = {foo: 0, :bar => 1, 'baz': 2} h # => {:foo=>0, :bar=>1, :baz=>2} But it's an error to try the JSON-style syntax for a key that's not a bareword or a String: # Raises SyntaxError (syntax error, unexpected ':', expecting =>): h = {0: 'zero'} === Common Uses You can use a \Hash to give names to objects: person = {name: 'Matz', language: 'Ruby'} person # => {:name=>"Matz", :language=>"Ruby"} You can use a \Hash to give names to method arguments: def some_method(hash) p hash end some_method({foo: 0, bar: 1, baz: 2}) # => {:foo=>0, :bar=>1, :baz=>2} Note: when the last argument in a method call is a \Hash, the curly braces may be omitted: some_method(foo: 0, bar: 1, baz: 2) # => {:foo=>0, :bar=>1, :baz=>2} You can use a \Hash to initialize an object: class Dev attr_accessor :name, :language def initialize(hash) self.name = hash[:name] self.language = hash[:language] end end matz = Dev.new(name: 'Matz', language: 'Ruby') matz # => # === Creating a \Hash Here are three ways to create a \Hash: - \Method Hash.new - \Method Hash[] - Literal form: {}. --- You can create a \Hash by calling method Hash.new. Create an empty Hash: h = Hash.new h # => {} h.class # => Hash --- You can create a \Hash by calling method Hash.[]. Create an empty Hash: h = Hash[] h # => {} Create a \Hash with initial entries: h = Hash[foo: 0, bar: 1, baz: 2] h # => {:foo=>0, :bar=>1, :baz=>2} --- You can create a \Hash by using its literal form (curly braces). Create an empty \Hash: h = {} h # => {} Create a \Hash with initial entries: h = {foo: 0, bar: 1, baz: 2} h # => {:foo=>0, :bar=>1, :baz=>2} === \Hash Value Basics The simplest way to retrieve a \Hash value (instance method #[]): h = {foo: 0, bar: 1, baz: 2} h[:foo] # => 0 The simplest way to create or update a \Hash value (instance method #[]=): h = {foo: 0, bar: 1, baz: 2} h[:bat] = 3 # => 3 h # => {:foo=>0, :bar=>1, :baz=>2, :bat=>3} h[:foo] = 4 # => 4 h # => {:foo=>4, :bar=>1, :baz=>2, :bat=>3} The simplest way to delete a \Hash entry (instance method #delete): h = {foo: 0, bar: 1, baz: 2} h.delete(:bar) # => 1 h # => {:foo=>0, :baz=>2} === Entry Order A \Hash object presents its entries in the order of their creation. This is seen in: - Iterative methods such as each, each_key, each_pair, each_value. - Other order-sensitive methods such as shift, keys, values. - The \String returned by method inspect. A new \Hash has its initial ordering per the given entries: h = Hash[foo: 0, bar: 1] h # => {:foo=>0, :bar=>1} New entries are added at the end: h[:baz] = 2 h # => {:foo=>0, :bar=>1, :baz=>2} Updating a value does not affect the order: h[:baz] = 3 h # => {:foo=>0, :bar=>1, :baz=>3} But re-creating a deleted entry can affect the order: h.delete(:foo) h[:foo] = 5 h # => {:bar=>1, :baz=>3, :foo=>5} === \Hash Keys ==== \Hash Key Equivalence Two objects are treated as the same \hash key when their hash value is identical and the two objects are eql? to each other. ==== Modifying an Active \Hash Key Modifying a \Hash key while it is in use damages the hash's index. This \Hash has keys that are Arrays: a0 = [ :foo, :bar ] a1 = [ :baz, :bat ] h = {a0 => 0, a1 => 1} h.include?(a0) # => true h[a0] # => 0 a0.hash # => 110002110 Modifying array element a0[0] changes its hash value: a0[0] = :bam a0.hash # => 1069447059 And damages the \Hash index: h.include?(a0) # => false h[a0] # => nil You can repair the hash index using method +rehash+: h.rehash # => {[:bam, :bar]=>0, [:baz, :bat]=>1} h.include?(a0) # => true h[a0] # => 0 A \String key is always safe. That's because an unfrozen \String passed as a key will be replaced by a duplicated and frozen \String: s = 'foo' s.frozen? # => false h = {s => 0} first_key = h.keys.first first_key.frozen? # => true ==== User-Defined \Hash Keys To be useable as a \Hash key, objects must implement the methods hash and eql?. Note: this requirement does not apply if the \Hash uses #compare_by_id since comparison will then rely on the keys' object id instead of hash and eql?. \Object defines basic implementation for hash and eq? that makes each object a distinct key. Typically, user-defined classes will want to override these methods to provide meaningful behavior, or for example inherit \Struct that has useful definitions for these. 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 && other.author == @author && 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 === Default Values The methods #[], #values_at and #dig need to return the value associated to a certain key. When that key is not found, that value will be determined by its default proc (if any) or else its default (initially `nil`). You can retrieve the default value with method #default: h = Hash.new h.default # => nil You can set the default value by passing an argument to method Hash.new or with method #default= h = Hash.new(-1) h.default # => -1 h.default = 0 h.default # => 0 This default value is returned for #[], #values_at and #dig when a key is not found: counts = {foo: 42} counts.default # => nil (default) counts[:foo] = 42 counts[:bar] # => nil counts.default = 0 counts[:bar] # => 0 counts.values_at(:foo, :bar, :baz) # => [42, 0, 0] counts.dig(:bar) # => 0 Note that the default value is used without being duplicated. It is not advised to set the default value to a mutable object: synonyms = Hash.new([]) synonyms[:hello] # => [] synonyms[:hello] << :hi # => [:hi], but this mutates the default! synonyms.default # => [:hi] synonyms[:world] << :universe synonyms[:world] # => [:hi, :universe], oops synonyms.keys # => [], oops To use a mutable object as default, it is recommended to use a default proc ==== Default \Proc When the default proc for a \Hash is set (i.e., not +nil+), the default value returned by method #[] is determined by the default proc alone. You can retrieve the default proc with method #default_proc: h = Hash.new h.default_proc # => nil You can set the default proc by calling Hash.new with a block or calling the method #default_proc= h = Hash.new { |hash, key| "Default value for #{key}" } h.default_proc.class # => Proc h.default_proc = proc { |hash, key| "Default value for #{key.inspect}" } h.default_proc.class # => Proc When the default proc is set (i.e., not +nil+) and method #[] is called with with a non-existent key, #[] calls the default proc with both the \Hash object itself and the missing key, then returns the proc's return value: h = Hash.new { |hash, key| "Default value for #{key}" } h[:nosuch] # => "Default value for nosuch" Note that in the example above no entry for key +:nosuch+ is created: h.include?(:nosuch) # => false However, the proc itself can add a new entry: synonyms = Hash.new { |hash, key| hash[key] = [] } synonyms.include?(:hello) # => false synonyms[:hello] << :hi # => [:hi] synonyms[:world] << :universe # => [:universe] synonyms.keys # => [:hello, :world] Note that setting the default proc will clear the default value and vice versa. ;T;[;[;I"Z"A \Hash maps each of its unique keys to a specific value. A \Hash has certain similarities to an \Array, but: - An \Array index is always an \Integer. - A \Hash key can be (almost) any object. === \Hash \Data Syntax The older syntax for \Hash data uses the "hash rocket," =>: h = {:foo => 0, :bar => 1, :baz => 2} h # => {:foo=>0, :bar=>1, :baz=>2} Alternatively, but only for a \Hash key that's a \Symbol, you can use a newer JSON-style syntax, where each bareword becomes a \Symbol: h = {foo: 0, bar: 1, baz: 2} h # => {:foo=>0, :bar=>1, :baz=>2} You can also use a \String in place of a bareword: h = {'foo': 0, 'bar': 1, 'baz': 2} h # => {:foo=>0, :bar=>1, :baz=>2} And you can mix the styles: h = {foo: 0, :bar => 1, 'baz': 2} h # => {:foo=>0, :bar=>1, :baz=>2} But it's an error to try the JSON-style syntax for a key that's not a bareword or a String: # Raises SyntaxError (syntax error, unexpected ':', expecting =>): h = {0: 'zero'} === Common Uses You can use a \Hash to give names to objects: person = {name: 'Matz', language: 'Ruby'} person # => {:name=>"Matz", :language=>"Ruby"} You can use a \Hash to give names to method arguments: def some_method(hash) p hash end some_method({foo: 0, bar: 1, baz: 2}) # => {:foo=>0, :bar=>1, :baz=>2} Note: when the last argument in a method call is a \Hash, the curly braces may be omitted: some_method(foo: 0, bar: 1, baz: 2) # => {:foo=>0, :bar=>1, :baz=>2} You can use a \Hash to initialize an object: class Dev attr_accessor :name, :language def initialize(hash) self.name = hash[:name] self.language = hash[:language] end end matz = Dev.new(name: 'Matz', language: 'Ruby') matz # => # === Creating a \Hash Here are three ways to create a \Hash: - \Method Hash.new - \Method Hash[] - Literal form: {}. --- You can create a \Hash by calling method Hash.new. Create an empty Hash: h = Hash.new h # => {} h.class # => Hash --- You can create a \Hash by calling method Hash.[]. Create an empty Hash: h = Hash[] h # => {} Create a \Hash with initial entries: h = Hash[foo: 0, bar: 1, baz: 2] h # => {:foo=>0, :bar=>1, :baz=>2} --- You can create a \Hash by using its literal form (curly braces). Create an empty \Hash: h = {} h # => {} Create a \Hash with initial entries: h = {foo: 0, bar: 1, baz: 2} h # => {:foo=>0, :bar=>1, :baz=>2} === \Hash Value Basics The simplest way to retrieve a \Hash value (instance method #[]): h = {foo: 0, bar: 1, baz: 2} h[:foo] # => 0 The simplest way to create or update a \Hash value (instance method #[]=): h = {foo: 0, bar: 1, baz: 2} h[:bat] = 3 # => 3 h # => {:foo=>0, :bar=>1, :baz=>2, :bat=>3} h[:foo] = 4 # => 4 h # => {:foo=>4, :bar=>1, :baz=>2, :bat=>3} The simplest way to delete a \Hash entry (instance method #delete): h = {foo: 0, bar: 1, baz: 2} h.delete(:bar) # => 1 h # => {:foo=>0, :baz=>2} === Entry Order A \Hash object presents its entries in the order of their creation. This is seen in: - Iterative methods such as each, each_key, each_pair, each_value. - Other order-sensitive methods such as shift, keys, values. - The \String returned by method inspect. A new \Hash has its initial ordering per the given entries: h = Hash[foo: 0, bar: 1] h # => {:foo=>0, :bar=>1} New entries are added at the end: h[:baz] = 2 h # => {:foo=>0, :bar=>1, :baz=>2} Updating a value does not affect the order: h[:baz] = 3 h # => {:foo=>0, :bar=>1, :baz=>3} But re-creating a deleted entry can affect the order: h.delete(:foo) h[:foo] = 5 h # => {:bar=>1, :baz=>3, :foo=>5} === \Hash Keys ==== \Hash Key Equivalence Two objects are treated as the same \hash key when their hash value is identical and the two objects are eql? to each other. ==== Modifying an Active \Hash Key Modifying a \Hash key while it is in use damages the hash's index. This \Hash has keys that are Arrays: a0 = [ :foo, :bar ] a1 = [ :baz, :bat ] h = {a0 => 0, a1 => 1} h.include?(a0) # => true h[a0] # => 0 a0.hash # => 110002110 Modifying array element a0[0] changes its hash value: a0[0] = :bam a0.hash # => 1069447059 And damages the \Hash index: h.include?(a0) # => false h[a0] # => nil You can repair the hash index using method +rehash+: h.rehash # => {[:bam, :bar]=>0, [:baz, :bat]=>1} h.include?(a0) # => true h[a0] # => 0 A \String key is always safe. That's because an unfrozen \String passed as a key will be replaced by a duplicated and frozen \String: s = 'foo' s.frozen? # => false h = {s => 0} first_key = h.keys.first first_key.frozen? # => true ==== User-Defined \Hash Keys To be useable as a \Hash key, objects must implement the methods hash and eql?. Note: this requirement does not apply if the \Hash uses #compare_by_id since comparison will then rely on the keys' object id instead of hash and eql?. \Object defines basic implementation for hash and eq? that makes each object a distinct key. Typically, user-defined classes will want to override these methods to provide meaningful behavior, or for example inherit \Struct that has useful definitions for these. 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 && other.author == @author && 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 === Default Values The methods #[], #values_at and #dig need to return the value associated to a certain key. When that key is not found, that value will be determined by its default proc (if any) or else its default (initially `nil`). You can retrieve the default value with method #default: h = Hash.new h.default # => nil You can set the default value by passing an argument to method Hash.new or with method #default= h = Hash.new(-1) h.default # => -1 h.default = 0 h.default # => 0 This default value is returned for #[], #values_at and #dig when a key is not found: counts = {foo: 42} counts.default # => nil (default) counts[:foo] = 42 counts[:bar] # => nil counts.default = 0 counts[:bar] # => 0 counts.values_at(:foo, :bar, :baz) # => [42, 0, 0] counts.dig(:bar) # => 0 Note that the default value is used without being duplicated. It is not advised to set the default value to a mutable object: synonyms = Hash.new([]) synonyms[:hello] # => [] synonyms[:hello] << :hi # => [:hi], but this mutates the default! synonyms.default # => [:hi] synonyms[:world] << :universe synonyms[:world] # => [:hi, :universe], oops synonyms.keys # => [], oops To use a mutable object as default, it is recommended to use a default proc ==== Default \Proc When the default proc for a \Hash is set (i.e., not +nil+), the default value returned by method #[] is determined by the default proc alone. You can retrieve the default proc with method #default_proc: h = Hash.new h.default_proc # => nil You can set the default proc by calling Hash.new with a block or calling the method #default_proc= h = Hash.new { |hash, key| "Default value for #{key}" } h.default_proc.class # => Proc h.default_proc = proc { |hash, key| "Default value for #{key.inspect}" } h.default_proc.class # => Proc When the default proc is set (i.e., not +nil+) and method #[] is called with with a non-existent key, #[] calls the default proc with both the \Hash object itself and the missing key, then returns the proc's return value: h = Hash.new { |hash, key| "Default value for #{key}" } h[:nosuch] # => "Default value for nosuch" Note that in the example above no entry for key +:nosuch+ is created: h.include?(:nosuch) # => false However, the proc itself can add a new entry: synonyms = Hash.new { |hash, key| hash[key] = [] } synonyms.include?(:hello) # => false synonyms[:hello] << :hi # => [:hi] synonyms[:world] << :universe # => [:universe] synonyms.keys # => [:hello, :world] Note that setting the default proc will clear the default value and vice versa. ;T;0; @T;!F;"o;#;$T;%it;&iÆ;'@;I" Hash;F;So;L;M0;N0;O0;;T;'@;Q@];R;Fo; ;IC;[;A@õ_;BIC;[;A@õ_;CIC;[;A@õ_;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@—Ti1;T;:ENV;;K;;;[;{;IC;"ö ENV is a hash-like accessor for environment variables. === Interaction with the Operating System The ENV object interacts with the operating system's environment variables: - When you get the value for a name in ENV, the value is retrieved from among the current environment variables. - When you create or set a name-value pair in ENV, the name and value are immediately set in the environment variables. - When you delete a name-value pair in ENV, it is immediately deleted from the environment variables. === Names and Values Generally, a name or value is a String. ==== Valid Names and Values Each name or value must be one of the following: - A String. - An object that responds to \#to_str by returning a String, in which case that String will be used as the name or value. ==== Invalid Names and Values A new name: - May not be the empty string: ENV[''] = '0' # Raises Errno::EINVAL (Invalid argument - ruby_setenv()) - May not contain character "=": ENV['='] = '0' # Raises Errno::EINVAL (Invalid argument - ruby_setenv(=)) A new name or value: - May not be a non-String that does not respond to \#to_str: ENV['foo'] = Object.new # Raises TypeError (no implicit conversion of Object into String) ENV[Object.new] = '0' # Raises TypeError (no implicit conversion of Object into String) - May not contain the NUL character "\0": ENV['foo'] = "\0" # Raises ArgumentError (bad environment variable value: contains null byte) ENV["\0"] == '0' # Raises ArgumentError (bad environment variable name: contains null byte) - May not have an ASCII-incompatible encoding such as UTF-16LE or ISO-2022-JP: ENV['foo'] = '0'.force_encoding(Encoding::ISO_2022_JP) # Raises ArgumentError (bad environment variable name: ASCII incompatible encoding: ISO-2022-JP) ENV["foo".force_encoding(Encoding::ISO_2022_JP)] = '0' # Raises ArgumentError (bad environment variable name: ASCII incompatible encoding: ISO-2022-JP) === About Ordering ENV enumerates its name/value pairs in the order found in the operating system's environment variables. Therefore the ordering of ENV content is OS-dependent, and may be indeterminate. This will be seen in: - A Hash returned by an ENV method. - An Enumerator returned by an ENV method. - An Array returned by ENV.keys, ENV.values, or ENV.to_a. - The String returned by ENV.inspect. - The Array returned by ENV.shift. - The name returned by ENV.key. === About the Examples Some methods in ENV return ENV itself. Typically, there are many environment variables. It's not useful to display a large ENV in the examples here, so most example snippets begin by resetting the contents of ENV: - ENV.replace replaces ENV with a new collection of entries. - ENV.clear empties ENV. ;T;[;[;I"ø ENV is a hash-like accessor for environment variables. === Interaction with the Operating System The ENV object interacts with the operating system's environment variables: - When you get the value for a name in ENV, the value is retrieved from among the current environment variables. - When you create or set a name-value pair in ENV, the name and value are immediately set in the environment variables. - When you delete a name-value pair in ENV, it is immediately deleted from the environment variables. === Names and Values Generally, a name or value is a String. ==== Valid Names and Values Each name or value must be one of the following: - A String. - An object that responds to \#to_str by returning a String, in which case that String will be used as the name or value. ==== Invalid Names and Values A new name: - May not be the empty string: ENV[''] = '0' # Raises Errno::EINVAL (Invalid argument - ruby_setenv()) - May not contain character "=": ENV['='] = '0' # Raises Errno::EINVAL (Invalid argument - ruby_setenv(=)) A new name or value: - May not be a non-String that does not respond to \#to_str: ENV['foo'] = Object.new # Raises TypeError (no implicit conversion of Object into String) ENV[Object.new] = '0' # Raises TypeError (no implicit conversion of Object into String) - May not contain the NUL character "\0": ENV['foo'] = "\0" # Raises ArgumentError (bad environment variable value: contains null byte) ENV["\0"] == '0' # Raises ArgumentError (bad environment variable name: contains null byte) - May not have an ASCII-incompatible encoding such as UTF-16LE or ISO-2022-JP: ENV['foo'] = '0'.force_encoding(Encoding::ISO_2022_JP) # Raises ArgumentError (bad environment variable name: ASCII incompatible encoding: ISO-2022-JP) ENV["foo".force_encoding(Encoding::ISO_2022_JP)] = '0' # Raises ArgumentError (bad environment variable name: ASCII incompatible encoding: ISO-2022-JP) === About Ordering ENV enumerates its name/value pairs in the order found in the operating system's environment variables. Therefore the ordering of ENV content is OS-dependent, and may be indeterminate. This will be seen in: - A Hash returned by an ENV method. - An Enumerator returned by an ENV method. - An Array returned by ENV.keys, ENV.values, or ENV.to_a. - The String returned by ENV.inspect. - The Array returned by ENV.shift. - The name returned by ENV.key. === About the Examples Some methods in ENV return ENV itself. Typically, there are many environment variables. It's not useful to display a large ENV in the examples here, so most example snippets begin by resetting the contents of ENV: - ENV.replace replaces ENV with a new collection of entries. - ENV.clear empties ENV. ;T;0; @õ_;!F;"o;#;$T;%i1;&i~;'@;I"ENV;F;So;L;M0;N0;O0;;T;'@;Q@];R0@ã/o; ;IC;[;A@ `;BIC;[;A@ `;CIC;[;A@ `;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ài;F;:TracePoint;;K;;;[;{;IC;";T;[;[;@|;0; @ `;'@;I"TracePoint;F;So;L;M0;N0;O0;;T;'@;Q@];R;Fo; ;IC;[ o;;F; ;;;;I"Range#initialize;F;[[@c0;[[I"range.c;Tid;T;;Ð;0;[;{;IC;"ÀConstructs a range using the given +begin+ and +end+. If the +exclude_end+ parameter is omitted or is false, the range will include the end object; otherwise, it will be excluded. ;T;[o;= ;3I" overload;F;40;;î;50;)I"'new(begin, end, exclude_end=false);T;IC;";T; @`;>0;!F;[;[;I";T;0;6i;[; @`;[;I"ïConstructs a range using the given +begin+ and +end+. If the +exclude_end+ parameter is omitted or is false, the range will include the end object; otherwise, it will be excluded. @overload new(begin, end, exclude_end=false);T;0; @`;!F;"o;#;$T;%i[;&i`;'@`;(I"ùstatic VALUE range_initialize(int argc, VALUE *argv, VALUE range) { VALUE beg, end, flags; rb_scan_args(argc, argv, "21", &beg, &end, &flags); range_modify(range); range_init(range, beg, end, RBOOL(RTEST(flags))); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#initialize_copy;F;[[I" orig;T0;[[@#`ip;T;;g;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @5`;!F;"o;#;$T;%io;&io;'@`;(I"static VALUE range_initialize_copy(VALUE range, VALUE orig) { range_modify(range); rb_struct_init_copy(range, orig); return range; };T;)I"static VALUE;T;*To;;F; ;;;;I" Range#==;F;[[I"obj;T0;[[@#`i ;T;;`;0;[;{;IC;",Returns true only if +obj+ is a Range, has equivalent begin and end items (by comparing them with ==), and has the same #exclude_end? setting as the range. (0..2) == (0..2) #=> true (0..2) == Range.new(0,2) #=> true (0..2) == (0...2) #=> false ;T;[o;= ;3I" overload;F;40;;`;50;)I"==(obj);T;IC;";T; @E`;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @E`;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @E`;[;I"UReturns true only if +obj+ is a Range, has equivalent begin and end items (by comparing them with ==), and has the same #exclude_end? setting as the range. (0..2) == (0..2) #=> true (0..2) == Range.new(0,2) #=> true (0..2) == (0...2) #=> false @overload ==(obj) @return [Boolean];T;0; @E`;!F;"o;#;$T;%i’;&i;'@`;(I"Ústatic VALUE range_eq(VALUE range, VALUE obj) { if (range == obj) return Qtrue; if (!rb_obj_is_kind_of(obj, rb_cRange)) return Qfalse; return rb_exec_recursive_paired(recursive_equal, range, obj, obj); };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#===;F;[[I"val;T0;[[@#`iÞ;T;;\;0;[;{;IC;"/Returns true if +obj+ is between begin and end of range, false otherwise (same as #cover?). Conveniently, === is the comparison operator used by case statements. case 79 when 1..50 then puts "low" when 51..75 then puts "medium" when 76..100 then puts "high" end # Prints "high" case "2.6.5" when ..."2.4" then puts "EOL" when "2.4"..."2.5" then puts "maintenance" when "2.5"..."2.7" then puts "stable" when "2.7".. then puts "upcoming" end # Prints "stable" ;T;[o;= ;3I" overload;F;40;;\;50;)I" ===(obj);T;IC;";T; @d`;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @d`;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @d`;[;I"YReturns true if +obj+ is between begin and end of range, false otherwise (same as #cover?). Conveniently, === is the comparison operator used by case statements. case 79 when 1..50 then puts "low" when 51..75 then puts "medium" when 76..100 then puts "high" end # Prints "high" case "2.6.5" when ..."2.4" then puts "EOL" when "2.4"..."2.5" then puts "maintenance" when "2.5"..."2.7" then puts "stable" when "2.7".. then puts "upcoming" end # Prints "stable" @overload ===(obj) @return [Boolean];T;0; @d`;!F;"o;#;$T;%iÄ;&iÛ;'@`;(I"Òstatic VALUE range_eqq(VALUE range, VALUE val) { VALUE ret = range_include_internal(range, val, 1); if (ret != Qundef) return ret; return r_cover_p(range, RANGE_BEG(range), RANGE_END(range), val); };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#eql?;F;[[I"obj;T0;[[@#`iÖ;T;;_;0;[;{;IC;"1Returns true only if +obj+ is a Range, has equivalent begin and end items (by comparing them with eql?), and has the same #exclude_end? setting as the range. (0..2).eql?(0..2) #=> true (0..2).eql?(Range.new(0,2)) #=> true (0..2).eql?(0...2) #=> false;T;[o;= ;3I" overload;F;40;;_;50;)I"eql?(obj);T;IC;";T; @ƒ`;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ƒ`;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @ƒ`;[;I"\Returns true only if +obj+ is a Range, has equivalent begin and end items (by comparing them with eql?), and has the same #exclude_end? setting as the range. (0..2).eql?(0..2) #=> true (0..2).eql?(Range.new(0,2)) #=> true (0..2).eql?(0...2) #=> false @overload eql?(obj) @return [Boolean];T;0; @ƒ`;!F;"o;#;$T;%iÈ;&iÓ;6i;'@`;(I"Østatic VALUE range_eql(VALUE range, VALUE obj) { if (range == obj) return Qtrue; if (!rb_obj_is_kind_of(obj, rb_cRange)) return Qfalse; return rb_exec_recursive_paired(recursive_eql, range, obj, obj); };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#hash;F;[;[[@#`ië;T;;b;0;[;{;IC;"ÃCompute a hash-code for this range. Two ranges with equal begin and end points (using eql?), and the same #exclude_end? value will generate the same hash-code. See also Object#hash. ;T;[o;= ;3I" overload;F;40;;b;50;)I" hash;T;IC;";T; @¢`;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¢`;[;I"@return [Integer];T;0;6i;[; @¢`;[;I"èCompute a hash-code for this range. Two ranges with equal begin and end points (using eql?), and the same #exclude_end? value will generate the same hash-code. See also Object#hash. @overload hash @return [Integer];T;0; @¢`;!F;"o;#;$T;%ià;&iè;'@`;(I"static VALUE range_hash(VALUE range) { st_index_t hash = EXCL(range); VALUE v; hash = rb_hash_start(hash); v = rb_hash(RANGE_BEG(range)); hash = rb_hash_uint(hash, NUM2LONG(v)); v = rb_hash(RANGE_END(range)); hash = rb_hash_uint(hash, NUM2LONG(v)); hash = rb_hash_uint(hash, EXCL(range) << 24); hash = rb_hash_end(hash); return ST2FIX(hash); };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#each;F;[;[[@#`i‚;T;;;0;[;{;IC;"ÕIterates over the elements of range, passing each in turn to the block. The +each+ method can only be used if the begin object of the range supports the +succ+ method. A TypeError is raised if the object does not have +succ+ method defined (like Float). If no block is given, an enumerator is returned instead. (10..15).each {|n| print n, ' ' } # prints: 10 11 12 13 14 15 (2.5..5).each {|n| print n, ' ' } # raises: TypeError: can't iterate from Float ;T;[o;= ;3I" overload;F;40;;;50;)I" each;T;IC;";T; @½`;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"i;T; @½`;[;I"@yield [ i ];T;0;6i;[; @½`o;= ;3I" overload;F;40;;;50;)I" each;T;IC;";T; @½`;>0;!F;[;[;I";T;0;6i;[; @½`;[;I"Iterates over the elements of range, passing each in turn to the block. The +each+ method can only be used if the begin object of the range supports the +succ+ method. A TypeError is raised if the object does not have +succ+ method defined (like Float). If no block is given, an enumerator is returned instead. (10..15).each {|n| print n, ' ' } # prints: 10 11 12 13 14 15 (2.5..5).each {|n| print n, ' ' } # raises: TypeError: can't iterate from Float @overload each @yield [ i ] @overload each;T;0; @½`;!F;"o;#;$T;%im;&i;'@`;(I"p static VALUE range_each(VALUE range) { VALUE beg, end; long i; RETURN_SIZED_ENUMERATOR(range, 0, 0, range_enum_size); beg = RANGE_BEG(range); end = RANGE_END(range); if (FIXNUM_P(beg) && NIL_P(end)) { range_each_fixnum_endless(beg); } else if (FIXNUM_P(beg) && FIXNUM_P(end)) { /* fixnums are special */ return range_each_fixnum_loop(beg, end, range); } else if (RB_INTEGER_TYPE_P(beg) && (NIL_P(end) || RB_INTEGER_TYPE_P(end))) { if (SPECIAL_CONST_P(end) || RBIGNUM_POSITIVE_P(end)) { /* end >= FIXNUM_MIN */ if (!FIXNUM_P(beg)) { if (RBIGNUM_NEGATIVE_P(beg)) { do { rb_yield(beg); } while (!FIXNUM_P(beg = rb_big_plus(beg, INT2FIX(1)))); if (NIL_P(end)) range_each_fixnum_endless(beg); if (FIXNUM_P(end)) return range_each_fixnum_loop(beg, end, range); } else { if (NIL_P(end)) range_each_bignum_endless(beg); if (FIXNUM_P(end)) return range; } } if (FIXNUM_P(beg)) { i = FIX2LONG(beg); do { rb_yield(LONG2FIX(i)); } while (POSFIXABLE(++i)); beg = LONG2NUM(i); } ASSUME(!FIXNUM_P(beg)); ASSUME(!SPECIAL_CONST_P(end)); } if (!FIXNUM_P(beg) && RBIGNUM_SIGN(beg) == RBIGNUM_SIGN(end)) { if (EXCL(range)) { while (rb_big_cmp(beg, end) == INT2FIX(-1)) { rb_yield(beg); beg = rb_big_plus(beg, INT2FIX(1)); } } else { VALUE c; while ((c = rb_big_cmp(beg, end)) != INT2FIX(1)) { rb_yield(beg); if (c == INT2FIX(0)) break; beg = rb_big_plus(beg, INT2FIX(1)); } } } } else if (SYMBOL_P(beg) && (NIL_P(end) || SYMBOL_P(end))) { /* symbols are special */ beg = rb_sym2str(beg); if (NIL_P(end)) { rb_str_upto_endless_each(beg, sym_each_i, 0); } else { rb_str_upto_each(beg, rb_sym2str(end), EXCL(range), sym_each_i, 0); } } else { VALUE tmp = rb_check_string_type(beg); if (!NIL_P(tmp)) { if (!NIL_P(end)) { rb_str_upto_each(tmp, end, EXCL(range), each_i, 0); } else { rb_str_upto_endless_each(tmp, each_i, 0); } } else { if (!discrete_object_p(beg)) { rb_raise(rb_eTypeError, "can't iterate from %s", rb_obj_classname(beg)); } if (!NIL_P(end)) range_each_func(range, each_i, 0); else for (;; beg = rb_funcallv(beg, id_succ, 0, 0)) rb_yield(beg); } } return range; };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#step;F;[[@c0;[[@#`i˜;T;: step;0;[;{;IC;"yIterates over the range, passing each nth element to the block. If begin and end are numeric, +n+ is added for each iteration. Otherwise #step invokes #succ to iterate through range elements. If no block is given, an enumerator is returned instead. Especially, the enumerator is an Enumerator::ArithmeticSequence if begin and end of the range are numeric. range = Xs.new(1)..Xs.new(10) range.step(2) {|x| puts x} puts range.step(3) {|x| puts x} produces: 1 x 3 xxx 5 xxxxx 7 xxxxxxx 9 xxxxxxxxx 1 x 4 xxxx 7 xxxxxxx 10 xxxxxxxxxx See Range for the definition of class Xs. ;T;[ o;= ;3I" overload;F;40;;Ú;50;)I"step(n=1);T;IC;";T; @à`;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @à`;[;I"@yield [ obj ];T;0;6i;[[I"n;TI"1;T; @à`o;= ;3I" overload;F;40;;Ú;50;)I"step(n=1);T;IC;";T; @à`;>0;!F;[;[;I";T;0;6i;[[I"n;TI"1;T; @à`o;= ;3I" overload;F;40;;Ú;50;)I"step(n=1);T;IC;";T; @à`;>0;!F;[;[;I";T;0;6i;[[I"n;TI"1;T; @à`o;= ;3I" overload;F;40;:%;50;)I" %(n);T;IC;";T; @à`;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @à`o;= ;3I" overload;F;40;;Û;50;)I" %(n);T;IC;";T; @à`;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @à`;[;I"æIterates over the range, passing each nth element to the block. If begin and end are numeric, +n+ is added for each iteration. Otherwise #step invokes #succ to iterate through range elements. If no block is given, an enumerator is returned instead. Especially, the enumerator is an Enumerator::ArithmeticSequence if begin and end of the range are numeric. range = Xs.new(1)..Xs.new(10) range.step(2) {|x| puts x} puts range.step(3) {|x| puts x} produces: 1 x 3 xxx 5 xxxxx 7 xxxxxxx 9 xxxxxxxxx 1 x 4 xxxx 7 xxxxxxx 10 xxxxxxxxxx See Range for the definition of class Xs. @overload step(n=1) @yield [ obj ] @overload step(n=1) @overload step(n=1) @overload %(n) @overload %(n);T;0; @à`;!F;"o;#;$T;%ip;&i’;'@`;(I"Kstatic VALUE range_step(int argc, VALUE *argv, VALUE range) { VALUE b, e, step, tmp; b = RANGE_BEG(range); e = RANGE_END(range); step = (!rb_check_arity(argc, 0, 1) ? INT2FIX(1) : argv[0]); if (!rb_block_given_p()) { if (!rb_obj_is_kind_of(step, rb_cNumeric)) { step = rb_to_int(step); } if (rb_equal(step, INT2FIX(0))) { rb_raise(rb_eArgError, "step can't be 0"); } const VALUE b_num_p = rb_obj_is_kind_of(b, rb_cNumeric); const VALUE e_num_p = rb_obj_is_kind_of(e, rb_cNumeric); if ((b_num_p && (NIL_P(e) || e_num_p)) || (NIL_P(b) && e_num_p)) { return rb_arith_seq_new(range, ID2SYM(rb_frame_this_func()), argc, argv, range_step_size, b, e, step, EXCL(range)); } RETURN_SIZED_ENUMERATOR(range, argc, argv, range_step_size); } step = check_step_domain(step); if (FIXNUM_P(b) && NIL_P(e) && FIXNUM_P(step)) { long i = FIX2LONG(b), unit = FIX2LONG(step); do { rb_yield(LONG2FIX(i)); i += unit; /* FIXABLE+FIXABLE never overflow */ } while (FIXABLE(i)); b = LONG2NUM(i); for (;; b = rb_big_plus(b, step)) rb_yield(b); } else if (FIXNUM_P(b) && FIXNUM_P(e) && FIXNUM_P(step)) { /* fixnums are special */ long end = FIX2LONG(e); long i, unit = FIX2LONG(step); if (!EXCL(range)) end += 1; i = FIX2LONG(b); while (i < end) { rb_yield(LONG2NUM(i)); if (i + unit < i) break; i += unit; } } else if (SYMBOL_P(b) && (NIL_P(e) || SYMBOL_P(e))) { /* symbols are special */ VALUE iter[2]; iter[0] = INT2FIX(1); iter[1] = step; b = rb_sym2str(b); if (NIL_P(e)) { rb_str_upto_endless_each(b, sym_step_i, (VALUE)iter); } else { rb_str_upto_each(b, rb_sym2str(e), EXCL(range), sym_step_i, (VALUE)iter); } } else if (ruby_float_step(b, e, step, EXCL(range), TRUE)) { /* done */ } else if (rb_obj_is_kind_of(b, rb_cNumeric) || !NIL_P(rb_check_to_integer(b, "to_int")) || !NIL_P(rb_check_to_integer(e, "to_int"))) { ID op = EXCL(range) ? '<' : idLE; VALUE v = b; int i = 0; while (NIL_P(e) || RTEST(rb_funcall(v, op, 1, e))) { rb_yield(v); i++; v = rb_funcall(b, '+', 1, rb_funcall(INT2NUM(i), '*', 1, step)); } } else { tmp = rb_check_string_type(b); if (!NIL_P(tmp)) { VALUE iter[2]; b = tmp; iter[0] = INT2FIX(1); iter[1] = step; if (NIL_P(e)) { rb_str_upto_endless_each(b, step_i, (VALUE)iter); } else { rb_str_upto_each(b, e, EXCL(range), step_i, (VALUE)iter); } } else { VALUE args[2]; if (!discrete_object_p(b)) { rb_raise(rb_eTypeError, "can't iterate from %s", rb_obj_classname(b)); } args[0] = INT2FIX(1); args[1] = step; range_each_func(range, step_i, (VALUE)args); } } return range; };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#%;F;[[I" step;T0;[[@#`i;T;;Û;0;[;{;IC;"yIterates over the range, passing each nth element to the block. If begin and end are numeric, +n+ is added for each iteration. Otherwise #step invokes #succ to iterate through range elements. If no block is given, an enumerator is returned instead. Especially, the enumerator is an Enumerator::ArithmeticSequence if begin and end of the range are numeric. range = Xs.new(1)..Xs.new(10) range.step(2) {|x| puts x} puts range.step(3) {|x| puts x} produces: 1 x 3 xxx 5 xxxxx 7 xxxxxxx 9 xxxxxxxxx 1 x 4 xxxx 7 xxxxxxx 10 xxxxxxxxxx See Range for the definition of class Xs. ;T;[ o;= ;3I" overload;F;40;;Ú;50;)I"step(n=1);T;IC;";T; @)a;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @)a;[;I"@yield [ obj ];T;0;6i;[[I"n;TI"1;T; @)ao;= ;3I" overload;F;40;;Ú;50;)I"step(n=1);T;IC;";T; @)a;>0;!F;[;[;I";T;0;6i;[[I"n;TI"1;T; @)ao;= ;3I" overload;F;40;;Ú;50;)I"step(n=1);T;IC;";T; @)a;>0;!F;[;[;I";T;0;6i;[[I"n;TI"1;T; @)ao;= ;3I" overload;F;40;;Û;50;)I" %(n);T;IC;";T; @)a;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @)ao;= ;3I" overload;F;40;;Û;50;)I" %(n);T;IC;";T; @)a;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @)a;[;@%a;0; @)a;!F;"o;#;$T;%ip;&i’;'@`;(I"istatic VALUE range_percent_step(VALUE range, VALUE step) { return range_step(1, &step, range); };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#bsearch;F;[;[[@#`i§;T;:bsearch;0;[;{;IC;""By using binary search, finds a value in range which meets the given condition in O(log n) where n is the size of the range. You can use this method in two use cases: a find-minimum mode and a find-any mode. In either case, the elements of the range must be monotone (or sorted) with respect to the block. In find-minimum mode (this is a good choice for typical use case), the block must return true or false, and there must be a value x so that: - the block returns false for any value which is less than x, and - the block returns true for any value which is greater than or equal to x. If x is within the range, this method returns the value x. Otherwise, it returns nil. ary = [0, 4, 7, 10, 12] (0...ary.size).bsearch {|i| ary[i] >= 4 } #=> 1 (0...ary.size).bsearch {|i| ary[i] >= 6 } #=> 2 (0...ary.size).bsearch {|i| ary[i] >= 8 } #=> 3 (0...ary.size).bsearch {|i| ary[i] >= 100 } #=> nil (0.0...Float::INFINITY).bsearch {|x| Math.log(x) >= 0 } #=> 1.0 In find-any mode (this behaves like libc's bsearch(3)), the block must return a number, and there must be two values x and y (x <= y) so that: - the block returns a positive number for v if v < x, - the block returns zero for v if x <= v < y, and - the block returns a negative number for v if y <= v. This method returns any value which is within the intersection of the given range and x...y (if any). If there is no value that satisfies the condition, it returns nil. ary = [0, 100, 100, 100, 200] (0..4).bsearch {|i| 100 - ary[i] } #=> 1, 2 or 3 (0..4).bsearch {|i| 300 - ary[i] } #=> nil (0..4).bsearch {|i| 50 - ary[i] } #=> nil You must not mix the two modes at a time; the block must always return either true/false, or always return a number. It is undefined which value is actually picked up at each iteration. ;T;[o;= ;3I" overload;F;40;;Ü;50;)I"bsearch;T;IC;";T; @ra;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @ra;[;I"@yield [obj];T;0;6i;[; @ra;[;I"EBy using binary search, finds a value in range which meets the given condition in O(log n) where n is the size of the range. You can use this method in two use cases: a find-minimum mode and a find-any mode. In either case, the elements of the range must be monotone (or sorted) with respect to the block. In find-minimum mode (this is a good choice for typical use case), the block must return true or false, and there must be a value x so that: - the block returns false for any value which is less than x, and - the block returns true for any value which is greater than or equal to x. If x is within the range, this method returns the value x. Otherwise, it returns nil. ary = [0, 4, 7, 10, 12] (0...ary.size).bsearch {|i| ary[i] >= 4 } #=> 1 (0...ary.size).bsearch {|i| ary[i] >= 6 } #=> 2 (0...ary.size).bsearch {|i| ary[i] >= 8 } #=> 3 (0...ary.size).bsearch {|i| ary[i] >= 100 } #=> nil (0.0...Float::INFINITY).bsearch {|x| Math.log(x) >= 0 } #=> 1.0 In find-any mode (this behaves like libc's bsearch(3)), the block must return a number, and there must be two values x and y (x <= y) so that: - the block returns a positive number for v if v < x, - the block returns zero for v if x <= v < y, and - the block returns a negative number for v if y <= v. This method returns any value which is within the intersection of the given range and x...y (if any). If there is no value that satisfies the condition, it returns nil. ary = [0, 100, 100, 100, 200] (0..4).bsearch {|i| 100 - ary[i] } #=> 1, 2 or 3 (0..4).bsearch {|i| 300 - ary[i] } #=> nil (0..4).bsearch {|i| 50 - ary[i] } #=> nil You must not mix the two modes at a time; the block must always return either true/false, or always return a number. It is undefined which value is actually picked up at each iteration. @overload bsearch @yield [obj];T;0; @ra;!F;"o;#;$T;%is;&i¤;'@`;(I"º static VALUE range_bsearch(VALUE range) { VALUE beg, end, satisfied = Qnil; int smaller; /* Implementation notes: * Floats are handled by mapping them to 64 bits integers. * Apart from sign issues, floats and their 64 bits integer have the * same order, assuming they are represented as exponent followed * by the mantissa. This is true with or without implicit bit. * * Finding the average of two ints needs to be careful about * potential overflow (since float to long can use 64 bits) * as well as the fact that -1/2 can be 0 or -1 in C89. * * Note that -0.0 is mapped to the same int as 0.0 as we don't want * (-1...0.0).bsearch to yield -0.0. */ #define BSEARCH(conv) \ do { \ RETURN_ENUMERATOR(range, 0, 0); \ if (EXCL(range)) high--; \ org_high = high; \ while (low < high) { \ mid = ((high < 0) == (low < 0)) ? low + ((high - low) / 2) \ : (low < -high) ? -((-1 - low - high)/2 + 1) : (low + high) / 2; \ BSEARCH_CHECK(conv(mid)); \ if (smaller) { \ high = mid; \ } \ else { \ low = mid + 1; \ } \ } \ if (low == org_high) { \ BSEARCH_CHECK(conv(low)); \ if (!smaller) return Qnil; \ } \ return satisfied; \ } while (0) beg = RANGE_BEG(range); end = RANGE_END(range); if (FIXNUM_P(beg) && FIXNUM_P(end)) { long low = FIX2LONG(beg); long high = FIX2LONG(end); long mid, org_high; BSEARCH(INT2FIX); } #if SIZEOF_DOUBLE == 8 && defined(HAVE_INT64_T) else if (RB_TYPE_P(beg, T_FLOAT) || RB_TYPE_P(end, T_FLOAT)) { int64_t low = double_as_int64(NIL_P(beg) ? -HUGE_VAL : RFLOAT_VALUE(rb_Float(beg))); int64_t high = double_as_int64(NIL_P(end) ? HUGE_VAL : RFLOAT_VALUE(rb_Float(end))); int64_t mid, org_high; BSEARCH(int64_as_double_to_num); } #endif else if (is_integer_p(beg) && is_integer_p(end)) { RETURN_ENUMERATOR(range, 0, 0); return bsearch_integer_range(beg, end, EXCL(range)); } else if (is_integer_p(beg) && NIL_P(end)) { VALUE diff = LONG2FIX(1); RETURN_ENUMERATOR(range, 0, 0); while (1) { VALUE mid = rb_funcall(beg, '+', 1, diff); BSEARCH_CHECK(mid); if (smaller) { return bsearch_integer_range(beg, mid, 0); } diff = rb_funcall(diff, '*', 1, LONG2FIX(2)); } } else if (NIL_P(beg) && is_integer_p(end)) { VALUE diff = LONG2FIX(-1); RETURN_ENUMERATOR(range, 0, 0); while (1) { VALUE mid = rb_funcall(end, '+', 1, diff); BSEARCH_CHECK(mid); if (!smaller) { return bsearch_integer_range(mid, end, 0); } diff = rb_funcall(diff, '*', 1, LONG2FIX(2)); } } else { rb_raise(rb_eTypeError, "can't do binary search for %s", rb_obj_classname(beg)); } return range; };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#begin;F;[;[[@#`ié;T;;%;0;[;{;IC;"[Returns the object that defines the beginning of the range. (1..10).begin #=> 1 ;T;[o;= ;3I" overload;F;40;;%;50;)I" begin;T;IC;";T; @a;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @a;[;I"@return [Object];T;0;6i;[; @a;[;I"{Returns the object that defines the beginning of the range. (1..10).begin #=> 1 @overload begin @return [Object];T;0; @a;!F;"o;#;$T;%ià;&iæ;'@`;(I"Kstatic VALUE range_begin(VALUE range) { return RANGE_BEG(range); };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#end;F;[;[[@#`iû;T;;&;0;[;{;IC;"mReturns the object that defines the end of the range. (1..10).end #=> 10 (1...10).end #=> 10 ;T;[o;= ;3I" overload;F;40;;&;50;)I"end;T;IC;";T; @¨a;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @¨a;[;I"@return [Object];T;0;6i;[; @¨a;[;I"‹Returns the object that defines the end of the range. (1..10).end #=> 10 (1...10).end #=> 10 @overload end @return [Object];T;0; @¨a;!F;"o;#;$T;%ið;&i÷;'@`;(I"Istatic VALUE range_end(VALUE range) { return RANGE_END(range); };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#first;F;[[@c0;[[@#`i;T;;9;0;[;{;IC;"Returns the first object in the range, or an array of the first +n+ elements. (10..20).first #=> 10 (10..20).first(3) #=> [10, 11, 12] ;T;[o;= ;3I" overload;F;40;;9;50;)I" first;T;IC;";T; @Ãa;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @Ãa;[;I"@return [Object];T;0;6i;[; @Ãao;= ;3I" overload;F;40;;9;50;)I" first(n);T;IC;";T; @Ãa;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @Ãa;[;I"@return [Array];T;0;6i;[[I"n;T0; @Ãa;[;I"ÚReturns the first object in the range, or an array of the first +n+ elements. (10..20).first #=> 10 (10..20).first(3) #=> [10, 11, 12] @overload first @return [Object] @overload first(n) @return [Array];T;0; @Ãa;!F;"o;#;$T;%i;&i;'@`;(I"°static VALUE range_first(int argc, VALUE *argv, VALUE range) { VALUE n, ary[2]; if (NIL_P(RANGE_BEG(range))) { rb_raise(rb_eRangeError, "cannot get the first element of beginless range"); } if (argc == 0) return RANGE_BEG(range); rb_scan_args(argc, argv, "1", &n); ary[0] = n; ary[1] = rb_ary_new2(NUM2LONG(n)); rb_block_call(range, idEach, 0, 0, first_i, (VALUE)ary); return ary[1]; };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#last;F;[[@c0;[[@#`iu;T;: last;0;[;{;IC;"NReturns the last object in the range, or an array of the last +n+ elements. Note that with no arguments +last+ will return the object that defines the end of the range even if #exclude_end? is +true+. (10..20).last #=> 20 (10...20).last #=> 20 (10..20).last(3) #=> [18, 19, 20] (10...20).last(3) #=> [17, 18, 19] ;T;[o;= ;3I" overload;F;40;;Ý;50;)I" last;T;IC;";T; @îa;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @îa;[;I"@return [Object];T;0;6i;[; @îao;= ;3I" overload;F;40;;Ý;50;)I"last(n);T;IC;";T; @îa;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @îa;[;I"@return [Array];T;0;6i;[[I"n;T0; @îa;[;I"–Returns the last object in the range, or an array of the last +n+ elements. Note that with no arguments +last+ will return the object that defines the end of the range even if #exclude_end? is +true+. (10..20).last #=> 20 (10...20).last #=> 20 (10..20).last(3) #=> [18, 19, 20] (10...20).last(3) #=> [17, 18, 19] @overload last @return [Object] @overload last(n) @return [Array];T;0; @îa;!F;"o;#;$T;%id;&is;'@`;(I"static VALUE range_last(int argc, VALUE *argv, VALUE range) { VALUE b, e; if (NIL_P(RANGE_END(range))) { rb_raise(rb_eRangeError, "cannot get the last element of endless range"); } if (argc == 0) return RANGE_END(range); b = RANGE_BEG(range); e = RANGE_END(range); if (RB_INTEGER_TYPE_P(b) && RB_INTEGER_TYPE_P(e) && RB_LIKELY(rb_method_basic_definition_p(rb_cRange, idEach))) { return rb_int_range_last(argc, argv, range); } return rb_ary_last(argc, argv, rb_Array(range)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#min;F;[[@c0;[[@#`i›;T;;>;0;[;{;IC;"?Returns the minimum value in the range. Returns +nil+ if the begin value of the range is larger than the end value. Returns +nil+ if the begin value of an exclusive range is equal to the end value. Can be given an optional block to override the default comparison method a <=> b. (10..20).min #=> 10 ;T;[ o;= ;3I" overload;F;40;;>;50;)I"min;T;IC;";T; @b;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @b;[;I"@return [Object];T;0;6i;[; @bo;= ;3I" overload;F;40;;>;50;)I"min;T;IC;";T; @b;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"a;TI"b;T; @bo;2 ;3I"return;F;4I";T;0;5[I"Object;T; @b;[;I"$@yield [ a,b ] @return [Object];T;0;6i;[; @bo;= ;3I" overload;F;40;;>;50;)I"min(n);T;IC;";T; @b;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @b;[;I"@return [Array];T;0;6i;[[I"n;T0; @bo;= ;3I" overload;F;40;;>;50;)I"min(n);T;IC;";T; @b;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"a;TI"b;T; @bo;2 ;3I"return;F;4I";T;0;5[I" Array;T; @b;[;I"#@yield [ a,b ] @return [Array];T;0;6i;[[I"n;T0; @b;[;I"ëReturns the minimum value in the range. Returns +nil+ if the begin value of the range is larger than the end value. Returns +nil+ if the begin value of an exclusive range is equal to the end value. Can be given an optional block to override the default comparison method a <=> b. (10..20).min #=> 10 @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; @b;!F;"o;#;$T;%i‰;&iœ;'@`;(I"Ïstatic VALUE range_min(int argc, VALUE *argv, VALUE range) { if (NIL_P(RANGE_BEG(range))) { rb_raise(rb_eRangeError, "cannot get the minimum of beginless range"); } if (rb_block_given_p()) { if (NIL_P(RANGE_END(range))) { rb_raise(rb_eRangeError, "cannot get the minimum of endless range with custom comparison method"); } return rb_call_super(argc, argv); } else if (argc != 0) { return range_first(argc, argv, range); } else { struct cmp_opt_data cmp_opt = { 0, 0 }; VALUE b = RANGE_BEG(range); VALUE e = RANGE_END(range); int c = NIL_P(e) ? -1 : OPTIMIZED_CMP(b, e, cmp_opt); if (c > 0 || (c == 0 && EXCL(range))) return Qnil; return b; } };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#max;F;[[@c0;[[@#`iÜ;T;;?;0;[;{;IC;"ËReturns the maximum value in the range, or an array of maximum values in the range if given an \Integer argument. For inclusive ranges with an end, the maximum value of the range is the same as the end of the range. If an argument or block is given, or +self+ is an exclusive, non-numeric range, calls Enumerable#max (via +super+) with the argument and/or block to get the maximum values, unless +self+ is a beginless range, in which case it raises a RangeError. If +self+ is an exclusive, integer range (both start and end of the range are integers), and no arguments or block are provided, returns last value in the range (1 before the end). Otherwise, if +self+ is an exclusive, numeric range, raises a TypeError. Returns +nil+ if the begin value of the range larger than the end value. Returns +nil+ if the begin value of an exclusive range is equal to the end value. Raises a RangeError if called on an endless range. Examples: (10..20).max #=> 20 (10..20).max(2) #=> [20, 19] (10...20).max #=> 19 (10...20).max(2) #=> [19, 18] (10...20).max{|x, y| -x <=> -y } #=> 10 (10...20).max(2){|x, y| -x <=> -y } #=> [10, 11] ;T;[ o;= ;3I" overload;F;40;;?;50;)I"max;T;IC;";T; @lb;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @lb;[;I"@return [Object];T;0;6i;[; @lbo;= ;3I" overload;F;40;;?;50;)I"max;T;IC;";T; @lb;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"a;TI"b;T; @lbo;2 ;3I"return;F;4I";T;0;5[I"Object;T; @lb;[;I"$@yield [ a,b ] @return [Object];T;0;6i;[; @lbo;= ;3I" overload;F;40;;?;50;)I"max(n);T;IC;";T; @lb;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @lb;[;I"@return [Object];T;0;6i;[[I"n;T0; @lbo;= ;3I" overload;F;40;;?;50;)I"max(n);T;IC;";T; @lb;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"a;TI"b;T; @lbo;2 ;3I"return;F;4I";T;0;5[I"Object;T; @lb;[;I"$@yield [ a,b ] @return [Object];T;0;6i;[[I"n;T0; @lb;[;I"yReturns the maximum value in the range, or an array of maximum values in the range if given an \Integer argument. For inclusive ranges with an end, the maximum value of the range is the same as the end of the range. If an argument or block is given, or +self+ is an exclusive, non-numeric range, calls Enumerable#max (via +super+) with the argument and/or block to get the maximum values, unless +self+ is a beginless range, in which case it raises a RangeError. If +self+ is an exclusive, integer range (both start and end of the range are integers), and no arguments or block are provided, returns last value in the range (1 before the end). Otherwise, if +self+ is an exclusive, numeric range, raises a TypeError. Returns +nil+ if the begin value of the range larger than the end value. Returns +nil+ if the begin value of an exclusive range is equal to the end value. Raises a RangeError if called on an endless range. Examples: (10..20).max #=> 20 (10..20).max(2) #=> [20, 19] (10...20).max #=> 19 (10...20).max(2) #=> [19, 18] (10...20).max{|x, y| -x <=> -y } #=> 10 (10...20).max(2){|x, y| -x <=> -y } #=> [10, 11] @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; @lb;!F;"o;#;$T;%i·;&iÞ;'@`;(I"îstatic VALUE range_max(int argc, VALUE *argv, VALUE range) { VALUE e = RANGE_END(range); int nm = FIXNUM_P(e) || rb_obj_is_kind_of(e, rb_cNumeric); if (NIL_P(RANGE_END(range))) { rb_raise(rb_eRangeError, "cannot get the maximum of endless range"); } VALUE b = RANGE_BEG(range); if (rb_block_given_p() || (EXCL(range) && !nm) || argc) { if (NIL_P(b)) { rb_raise(rb_eRangeError, "cannot get the maximum of beginless range with custom comparison method"); } return rb_call_super(argc, argv); } else { struct cmp_opt_data cmp_opt = { 0, 0 }; int c = NIL_P(b) ? -1 : OPTIMIZED_CMP(b, e, cmp_opt); if (c > 0) return Qnil; if (EXCL(range)) { if (!RB_INTEGER_TYPE_P(e)) { rb_raise(rb_eTypeError, "cannot exclude non Integer end value"); } if (c == 0) return Qnil; if (!RB_INTEGER_TYPE_P(b)) { rb_raise(rb_eTypeError, "cannot exclude end value with non Integer begin value"); } if (FIXNUM_P(e)) { return LONG2NUM(FIX2LONG(e) - 1); } return rb_funcall(e, '-', 1, INT2FIX(1)); } return e; } };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#minmax;F;[;[[@#`i;T;;@;0;[;{;IC;"ºReturns a two element array which contains the minimum and the maximum value in the range. Can be given an optional block to override the default comparison method a <=> b. ;T;[o;= ;3I" overload;F;40;;@;50;)I"minmax;T;IC;";T; @¿b;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @¿b;[;I"@return [Array];T;0;6i;[; @¿bo;= ;3I" overload;F;40;;@;50;)I"minmax;T;IC;";T; @¿b;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"a;TI"b;T; @¿bo;2 ;3I"return;F;4I";T;0;5[I" Array;T; @¿b;[;I"#@yield [ a,b ] @return [Array];T;0;6i;[; @¿b;[;I"Returns a two element array which contains the minimum and the maximum value in the range. Can be given an optional block to override the default comparison method a <=> b. @overload minmax @return [Array] @overload minmax @yield [ a,b ] @return [Array];T;0; @¿b;!F;"o;#;$T;%i;&i;'@`;(I"àstatic VALUE range_minmax(VALUE range) { if (rb_block_given_p()) { return rb_call_super(0, NULL); } return rb_assoc_new( rb_funcall(range, id_min, 0), rb_funcall(range, id_max, 0) ); };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#size;F;[;[[@#`i ;T;;¯;0;[;{;IC;"îReturns the number of elements in the range. Both the begin and the end of the Range must be Numeric, otherwise nil is returned. (10..20).size #=> 11 ('a'..'z').size #=> nil (-Float::INFINITY..Float::INFINITY).size #=> Infinity ;T;[o;= ;3I" overload;F;40;;¯;50;)I" size;T;IC;";T; @íb;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @íb;[;I"@return [Numeric];T;0;6i;[; @íb;[;I"Returns the number of elements in the range. Both the begin and the end of the Range must be Numeric, otherwise nil is returned. (10..20).size #=> 11 ('a'..'z').size #=> nil (-Float::INFINITY..Float::INFINITY).size #=> Infinity @overload size @return [Numeric];T;0; @íb;!F;"o;#;$T;%i;&i;'@`;(I"¯static VALUE range_size(VALUE range) { VALUE b = RANGE_BEG(range), e = RANGE_END(range); if (rb_obj_is_kind_of(b, rb_cNumeric)) { if (rb_obj_is_kind_of(e, rb_cNumeric)) { return ruby_num_interval_step_size(b, e, INT2FIX(1), EXCL(range)); } if (NIL_P(e)) { return DBL2NUM(HUGE_VAL); } } else if (NIL_P(b)) { return DBL2NUM(HUGE_VAL); } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#to_a;F;[;[[@#`i>;T;;!;0;[;{;IC;"¥Returns an array containing the items in the range. (1..7).to_a #=> [1, 2, 3, 4, 5, 6, 7] (1..).to_a #=> RangeError: cannot convert endless range to an array ;T;[o;= ;3I" overload;F;40;;!;50;)I" to_a;T;IC;";T; @c;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @c;[;I"@return [Array];T;0;6i;[; @co;= ;3I" overload;F;40;;";50;)I"entries;T;IC;";T; @c;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @c;[;I"@return [Array];T;0;6i;[; @c;[;I"ìReturns an array containing the items in the range. (1..7).to_a #=> [1, 2, 3, 4, 5, 6, 7] (1..).to_a #=> RangeError: cannot convert endless range to an array @overload to_a @return [Array] @overload entries @return [Array];T;0; @c;!F;"o;#;$T;%i3;&i<;'@`;(I"¸static VALUE range_to_a(VALUE range) { if (NIL_P(RANGE_END(range))) { rb_raise(rb_eRangeError, "cannot convert endless range to an array"); } return rb_call_super(0, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#entries;F;[;[[@#`i>;T;;";0;[;{;IC;"¥Returns an array containing the items in the range. (1..7).to_a #=> [1, 2, 3, 4, 5, 6, 7] (1..).to_a #=> RangeError: cannot convert endless range to an array ;T;[o;= ;3I" overload;F;40;;!;50;)I" to_a;T;IC;";T; @0c;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @0c;[;I"@return [Array];T;0;6i;[; @0co;= ;3I" overload;F;40;;";50;)I"entries;T;IC;";T; @0c;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @0c;[;I"@return [Array];T;0;6i;[; @0c;[;@,c;0; @0c;!F;"o;#;$T;%i3;&i<;'@`;(I"¸static VALUE range_to_a(VALUE range) { if (NIL_P(RANGE_END(range))) { rb_raise(rb_eRangeError, "cannot convert endless range to an array"); } return rb_call_super(0, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#to_s;F;[;[[@#`iŽ;T;;q;0;[;{;IC;"fConvert this range object to a printable form (using #to_s to convert the begin and end objects). ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @Wc;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Wc;[;I"@return [String];T;0;6i;[; @Wc;[;I"…Convert this range object to a printable form (using #to_s to convert the begin and end objects). @overload to_s @return [String];T;0; @Wc;!F;"o;#;$T;%i†;&i‹;'@`;(I"static VALUE range_to_s(VALUE range) { VALUE str, str2; str = rb_obj_as_string(RANGE_BEG(range)); str2 = rb_obj_as_string(RANGE_END(range)); str = rb_str_dup(str); rb_str_cat(str, "...", EXCL(range) ? 3 : 2); rb_str_append(str, str2); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#inspect;F;[;[[@#`i¼;T;;r;0;[;{;IC;"iConvert this range object to a printable form (using #inspect to convert the begin and end objects). ;T;[o;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @rc;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @rc;[;I"@return [String];T;0;6i;[; @rc;[;I"‹Convert this range object to a printable form (using #inspect to convert the begin and end objects). @overload inspect @return [String];T;0; @rc;!F;"o;#;$T;%i³;&i¸;'@`;(I"gstatic VALUE range_inspect(VALUE range) { return rb_exec_recursive(inspect_range, range, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#exclude_end?;F;[;[[@#`i};T;:exclude_end?;0;[;{;IC;"ˆReturns true if the range excludes its end value. (1..5).exclude_end? #=> false (1...5).exclude_end? #=> true;T;[o;= ;3I" overload;F;40;;Þ;50;)I"exclude_end?;T;IC;";T; @c;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @c;[;I"@return [Boolean];T;0;6i;[; @c;[;I"µReturns true if the range excludes its end value. (1..5).exclude_end? #=> false (1...5).exclude_end? #=> true @overload exclude_end? @return [Boolean];T;0; @c;!F;"o;#;$T;%ix;&i;6i;'@`;(I"_static VALUE range_exclude_end_p(VALUE range) { return EXCL(range) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#member?;F;[[I"val;T0;[[@#`iü;T;;D;0;[;{;IC;"¢Returns true if +obj+ is an element of the range, false otherwise. ("a".."z").include?("g") #=> true ("a".."z").include?("A") #=> false ("a".."z").include?("cc") #=> false If you need to ensure +obj+ is between +begin+ and +end+, use #cover? ("a".."z").cover?("cc") #=> true If begin and end are numeric, #include? behaves like #cover? (1..3).include?(1.5) # => true;T;[o;= ;3I" overload;F;40;;D;50;)I"member?(obj);T;IC;";T; @¨c;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @¨c;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @¨co;= ;3I" overload;F;40;;E;50;)I"include?(obj);T;IC;";T; @¨c;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @¨c;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @¨c;[;I"ûReturns true if +obj+ is an element of the range, false otherwise. ("a".."z").include?("g") #=> true ("a".."z").include?("A") #=> false ("a".."z").include?("cc") #=> false If you need to ensure +obj+ is between +begin+ and +end+, use #cover? ("a".."z").cover?("cc") #=> true If begin and end are numeric, #include? behaves like #cover? (1..3).include?(1.5) # => true @overload member?(obj) @return [Boolean] @overload include?(obj) @return [Boolean];T;0; @¨c;!F;"o;#;$T;%iç;&iú;6i;'@`;(I"³static VALUE range_include(VALUE range, VALUE val) { VALUE ret = range_include_internal(range, val, 0); if (ret != Qundef) return ret; return rb_call_super(1, &val); };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#include?;F;[[I"val;T0;[[@#`iü;T;;E;0;[;{;IC;"¢Returns true if +obj+ is an element of the range, false otherwise. ("a".."z").include?("g") #=> true ("a".."z").include?("A") #=> false ("a".."z").include?("cc") #=> false If you need to ensure +obj+ is between +begin+ and +end+, use #cover? ("a".."z").cover?("cc") #=> true If begin and end are numeric, #include? behaves like #cover? (1..3).include?(1.5) # => true;T;[o;= ;3I" overload;F;40;;D;50;)I"member?(obj);T;IC;";T; @Öc;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Öc;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @Öco;= ;3I" overload;F;40;;E;50;)I"include?(obj);T;IC;";T; @Öc;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Öc;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @Öc;[;@Òc;0; @Öc;!F;"o;#;$T;%iç;&iú;6i;'@`;(I"³static VALUE range_include(VALUE range, VALUE val) { VALUE ret = range_include_internal(range, val, 0); if (ret != Qundef) return ret; return rb_call_super(1, &val); };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#cover?;F;[[I"val;T0;[[@#`iM;T;:cover?;0;[;{;IC;"dReturns true if +obj+ is between the begin and end of the range. This tests begin <= obj <= end when #exclude_end? is +false+ and begin <= obj < end when #exclude_end? is +true+. If called with a Range argument, returns true when the given range is covered by the receiver, by comparing the begin and end values. If the argument can be treated as a sequence, this method treats it that way. In the specific case of (a..b).cover?(c...d) with a <= c && b < d, the end of the sequence must be calculated, which may exhibit poor performance if c is non-numeric. Returns false if the begin value of the range is larger than the end value. Also returns +false+ if one of the internal calls to <=> returns +nil+ (indicating the objects are not comparable). ("a".."z").cover?("c") #=> true ("a".."z").cover?("5") #=> false ("a".."z").cover?("cc") #=> true ("a".."z").cover?(1) #=> false (1..5).cover?(2..3) #=> true (1..5).cover?(0..6) #=> false (1..5).cover?(1...6) #=> true;T;[o;= ;3I" overload;F;40;;ß;50;)I"cover?(obj);T;IC;";T; @d;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @d;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @do;= ;3I" overload;F;40;;ß;50;)I"cover?(range);T;IC;";T; @d;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @d;[;I"@return [Boolean];T;0;6i;[[I" range;T0; @d;[;I"¼Returns true if +obj+ is between the begin and end of the range. This tests begin <= obj <= end when #exclude_end? is +false+ and begin <= obj < end when #exclude_end? is +true+. If called with a Range argument, returns true when the given range is covered by the receiver, by comparing the begin and end values. If the argument can be treated as a sequence, this method treats it that way. In the specific case of (a..b).cover?(c...d) with a <= c && b < d, the end of the sequence must be calculated, which may exhibit poor performance if c is non-numeric. Returns false if the begin value of the range is larger than the end value. Also returns +false+ if one of the internal calls to <=> returns +nil+ (indicating the objects are not comparable). ("a".."z").cover?("c") #=> true ("a".."z").cover?("5") #=> false ("a".."z").cover?("cc") #=> true ("a".."z").cover?(1) #=> false (1..5).cover?(2..3) #=> true (1..5).cover?(0..6) #=> false (1..5).cover?(1...6) #=> true @overload cover?(obj) @return [Boolean] @overload cover?(range) @return [Boolean];T;0; @d;!F;"o;#;$T;%i-;&iK;6i;'@`;(I"static VALUE range_cover(VALUE range, VALUE val) { VALUE beg, end; beg = RANGE_BEG(range); end = RANGE_END(range); if (rb_obj_is_kind_of(val, rb_cRange)) { return RBOOL(r_cover_range_p(range, beg, end, val)); } return r_cover_p(range, beg, end, val); };T;)I"static VALUE;T;*To;;F; ;;;;I"Range#count;F;[[@c0;[[@#`i¼;T;;(;0;[;{;IC;"RIdentical to Enumerable#count, except it returns Infinity for endless ranges. ;T;[o;= ;3I" overload;F;40;;(;50;)I" count;T;IC;";T; @1d;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @1d;[;I"@return [Integer];T;0;6i;[; @1do;= ;3I" overload;F;40;;(;50;)I"count(item);T;IC;";T; @1d;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @1d;[;I"@return [Integer];T;0;6i;[[I" item;T0; @1do;= ;3I" overload;F;40;;(;50;)I" count;T;IC;";T; @1d;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @1do;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @1d;[;I"#@yield [obj] @return [Integer];T;0;6i;[; @1d;[;I"ÑIdentical to Enumerable#count, except it returns Infinity for endless ranges. @overload count @return [Integer] @overload count(item) @return [Integer] @overload count @yield [obj] @return [Integer];T;0; @1d;!F;"o;#;$T;%i²;&i½;'@`;(I"static VALUE range_count(int argc, VALUE *argv, VALUE range) { if (argc != 0) { /* It is odd for instance (1...).count(0) to return Infinity. Just let * it loop. */ return rb_call_super(argc, argv); } else if (rb_block_given_p()) { /* Likewise it is odd for instance (1...).count {|x| x == 0 } to return * Infinity. Just let it loop. */ return rb_call_super(argc, argv); } else if (NIL_P(RANGE_END(range))) { /* We are confident that the answer is Infinity. */ return DBL2NUM(HUGE_VAL); } else if (NIL_P(RANGE_BEG(range))) { /* We are confident that the answer is Infinity. */ return DBL2NUM(HUGE_VAL); } else { return rb_call_super(argc, argv); } };T;)I"static VALUE;T;*T;A@`;BIC;[;A@`;CIC;[o;L;M0;N0;O0;;;'@;Q@(;R0;A@`;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@#`i:;F;;#;;K;;;[;{;IC;"A Range represents an interval---a set of values with a beginning and an end. Ranges may be constructed using the s..e and s...e literals, or with Range::new. Ranges constructed using .. run from the beginning to the end inclusively. Those created using ... exclude the end value. When used as an iterator, ranges return each value in the sequence. (-1..-5).to_a #=> [] (-5..-1).to_a #=> [-5, -4, -3, -2, -1] ('a'..'e').to_a #=> ["a", "b", "c", "d", "e"] ('a'...'e').to_a #=> ["a", "b", "c", "d"] == Beginless/Endless Ranges A "beginless range" and "endless range" represents a semi-infinite range. Literal notation for a beginless range is: (..1) # or (...1) Literal notation for an endless range is: (1..) # or similarly (1...) Which is equivalent to (1..nil) # or similarly (1...nil) Range.new(1, nil) # or Range.new(1, nil, true) Beginless/endless ranges are useful, for example, for idiomatic slicing of arrays: [1, 2, 3, 4, 5][...2] # => [1, 2] [1, 2, 3, 4, 5][2...] # => [3, 4, 5] Some implementation details: * +begin+ of beginless range and +end+ of endless range are +nil+; * +each+ of beginless range raises an exception; * +each+ of endless range enumerates infinite sequence (may be useful in combination with Enumerable#take_while or similar methods); * (1..) and (1...) are not equal, although technically representing the same sequence. == Custom Objects in Ranges Ranges can be constructed using any objects that can be compared using the <=> operator. Methods that treat the range as a sequence (#each and methods inherited from Enumerable) expect the begin object to implement a succ method to return the next object in sequence. The #step and #include? methods require the begin object to implement succ or to be numeric. In the Xs class below both <=> and succ are implemented so Xs can be used to construct ranges. Note that the Comparable module is included so the == method is defined in terms of <=>. class Xs # represent a string of 'x's include Comparable attr :length def initialize(n) @length = n end def succ Xs.new(@length + 1) end def <=>(other) @length <=> other.length end def to_s sprintf "%2d #{inspect}", @length end def inspect 'x' * @length end end An example of using Xs to construct a range: r = Xs.new(3)..Xs.new(6) #=> xxx..xxxxxx r.to_a #=> [xxx, xxxx, xxxxx, xxxxxx] r.member?(Xs.new(5)) #=> true ;T;[;[;I" A Range represents an interval---a set of values with a beginning and an end. Ranges may be constructed using the s..e and s...e literals, or with Range::new. Ranges constructed using .. run from the beginning to the end inclusively. Those created using ... exclude the end value. When used as an iterator, ranges return each value in the sequence. (-1..-5).to_a #=> [] (-5..-1).to_a #=> [-5, -4, -3, -2, -1] ('a'..'e').to_a #=> ["a", "b", "c", "d", "e"] ('a'...'e').to_a #=> ["a", "b", "c", "d"] == Beginless/Endless Ranges A "beginless range" and "endless range" represents a semi-infinite range. Literal notation for a beginless range is: (..1) # or (...1) Literal notation for an endless range is: (1..) # or similarly (1...) Which is equivalent to (1..nil) # or similarly (1...nil) Range.new(1, nil) # or Range.new(1, nil, true) Beginless/endless ranges are useful, for example, for idiomatic slicing of arrays: [1, 2, 3, 4, 5][...2] # => [1, 2] [1, 2, 3, 4, 5][2...] # => [3, 4, 5] Some implementation details: * +begin+ of beginless range and +end+ of endless range are +nil+; * +each+ of beginless range raises an exception; * +each+ of endless range enumerates infinite sequence (may be useful in combination with Enumerable#take_while or similar methods); * (1..) and (1...) are not equal, although technically representing the same sequence. == Custom Objects in Ranges Ranges can be constructed using any objects that can be compared using the <=> operator. Methods that treat the range as a sequence (#each and methods inherited from Enumerable) expect the begin object to implement a succ method to return the next object in sequence. The #step and #include? methods require the begin object to implement succ or to be numeric. In the Xs class below both <=> and succ are implemented so Xs can be used to construct ranges. Note that the Comparable module is included so the == method is defined in terms of <=>. class Xs # represent a string of 'x's include Comparable attr :length def initialize(n) @length = n end def succ Xs.new(@length + 1) end def <=>(other) @length <=> other.length end def to_s sprintf "%2d #{inspect}", @length end def inspect 'x' * @length end end An example of using Xs to construct a range: r = Xs.new(3)..Xs.new(6) #=> xxx..xxxxxx r.to_a #=> [xxx, xxxx, xxxxx, xxxxxx] r.member?(Xs.new(5)) #=> true ;T;0; @`;!F;"o;#;$T;%iÖ;&i1;'@;I" Range;F;So;L;M0;N0;O0;;T;'@;Q@];R;F@]o; ;IC;[o;{;[[@i—1;F;:INTERNAL_CONSTANTS;;};;;[;{;IC;"internal constants ;T;[;[;I"internal constants;T;0; @ƒd;!F;"o;#;$T;%i–1;&i–1;'@d;I"GC::INTERNAL_CONSTANTS;F;~I"gc_constants;To;;F; ;F;;;I"#GC.verify_internal_consistency;F;[;[;F;: verify_internal_consistency;;K;[;{;IC;"internal methods ;T;[;[;I"internal methods;T;0; @d;!F;"o;#;$T;%iÇ1;&iÇ1;'@d;*To;;F; ;F;;;I"2GC.verify_transient_heap_internal_consistency;F;[;[;F;:/verify_transient_heap_internal_consistency;;K;[;{;IC;";T;[;[;@|;0; @šd;'@d;*To;;F; ;F;;;I"GC.malloc_allocated_size;F;[;[;F;:malloc_allocated_size;;K;[;{;IC;";T;[;[;@|;0; @£d;'@d;*To;;F; ;F;;;I"GC.malloc_allocations;F;[;[;F;:malloc_allocations;;K;[;{;IC;";T;[;[;@|;0; @¬d;'@d;*To;;F; ;F;;;I"GC.add_stress_to_class;F;[;[;F;:add_stress_to_class;;K;[;{;IC;";T;[;[;@|;0; @µd;'@d;*To;;F; ;F;;;I"GC.remove_stress_to_class;F;[;[;F;:remove_stress_to_class;;K;[;{;IC;";T;[;[;@|;0; @¾d;'@d;*To;{;[[@i×1;F;: OPTS;;};;;[;{;IC;"GC build options ;T;[;[;I"GC build options;T;0; @Çd;!F;"o;#;$T;%iÖ1;&iÖ1;'@d;I" GC::OPTS;F;~I"opts = rb_ary_new();To; ;IC;[;A@Ód;BIC;[;A@Ód;CIC;[;A@Ód;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ip1;T;: Profiler;;K;;;[;{;IC;"The GC profiler provides access to information on GC runs including time, length and object space size. Example: GC::Profiler.enable require 'rdoc/rdoc' GC::Profiler.report GC::Profiler.disable See also GC.count, GC.malloc_allocated_size and GC.malloc_allocations ;T;[;[;I" The GC profiler provides access to information on GC runs including time, length and object space size. Example: GC::Profiler.enable require 'rdoc/rdoc' GC::Profiler.report GC::Profiler.disable See also GC.count, GC.malloc_allocated_size and GC.malloc_allocations ;T;0; @Ód;!F;"o;#;$T;%ip1;&i1;'o;L;M0;N0;O0;:GC;'@;Q@d;R0;I"GC::Profiler;F;So;L;M0;N0;O0;;T;'@;Q@];R0;A@d;BIC;[;A@d;CIC;[;A@d;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@iŒ1;F;;é;;K;;;[;{;IC;";T;[;[;@|;0; @d;6i;'@;I"GC;Fo; ;IC;[?o;;F; ;;;Ï;I"ObjectSpace#each_object;F;[[@c0;[[@id ;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; @ùd;>0;!F;[o;= ;3I" overload;F;40;;ê;50;)I"each_object([module]);T;IC;";T; @ùd;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @ùdo;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ùd;[;I"#@yield [obj] @return [Integer];T;0;6i;[[I"[;T0; @ùdo;= ;3I" overload;F;40;;ê;50;)I"each_object([module]);T;IC;";T; @ùd;>0;!F;[;[;I";T;0;6i;[[I"[;T0; @ùd;[;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 [Integer] @overload each_object([module]) ;T;0;'@÷d;(I"¿static VALUE os_each_obj(int argc, VALUE *argv, VALUE os) { VALUE of; of = (!rb_check_arity(argc, 0, 1) ? 0 : argv[0]); RETURN_ENUMERATOR(os, 1, &of); return os_obj_of(of); };T;)I"static VALUE;T;*To;;T; ;F;;;I"ObjectSpace.each_object;F;@ûd;@ýd;T;;ê;0;@ÿd;{;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;= ;3I" overload;F;40;;ê;50;)I"each_object([module]);T;IC;";T; @%e;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @%eo;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @%e;[;I"#@yield [obj] @return [Integer];T;0;6i;[[I"[;T0; @%eo;= ;3I" overload;F;40;;ê;50;)I"each_object([module]);T;IC;";T; @%e;>0;!F;[;[;I";T;0;6i;[[I"[;T0; @%e;[;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 [Integer] @overload each_object([module]);T;0; @%e;!F;"o;#;$T;%i@ ;&ib ;6i;'@÷d;(@#e;)@$e;*To;;F; ;;;Ï;I"!ObjectSpace#define_finalizer;F;[[@c0;[[@iØ ;T;:define_finalizer;0;[;{;IC;"KAdds 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. The return value is an array [0, aProc]. The two recommended patterns are to either create the finaliser proc in a non-instance method where it can safely capture the needed state, or to use a custom callable object that stores the needed state explicitly as instance variables. class Foo def initialize(data_needed_for_finalization) ObjectSpace.define_finalizer(self, self.class.create_finalizer(data_needed_for_finalization)) end def self.create_finalizer(data_needed_for_finalization) proc { puts "finalizing #{data_needed_for_finalization}" } end end class Bar class Remover def initialize(data_needed_for_finalization) @data_needed_for_finalization = data_needed_for_finalization end def call(id) puts "finalizing #{@data_needed_for_finalization}" end end def initialize(data_needed_for_finalization) ObjectSpace.define_finalizer(self, Remover.new(data_needed_for_finalization)) end end Note that if your finalizer references the object to be finalized it will never be run on GC, although it will still be run at exit. You will get a warning if you capture the object to be finalized as the receiver of the finalizer. class CapturesSelf def initialize(name) ObjectSpace.define_finalizer(self, proc { # this finalizer will only be run on exit puts "finalizing #{name}" }) end end Also note that finalization can be unpredictable and is never guaranteed to be run except on exit. ;T; @Ke;>0;!F;[o;= ;3I" overload;F;40;;ë;50;)I"(define_finalizer(obj, aProc=proc());T;IC;";T; @Ke;>0;!F;[;[;I";T;0;6i;[[I"obj;T0[I" aProc;TI"proc();T; @Ke;[;I"zAdds 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. The return value is an array [0, aProc]. The two recommended patterns are to either create the finaliser proc in a non-instance method where it can safely capture the needed state, or to use a custom callable object that stores the needed state explicitly as instance variables. class Foo def initialize(data_needed_for_finalization) ObjectSpace.define_finalizer(self, self.class.create_finalizer(data_needed_for_finalization)) end def self.create_finalizer(data_needed_for_finalization) proc { puts "finalizing #{data_needed_for_finalization}" } end end class Bar class Remover def initialize(data_needed_for_finalization) @data_needed_for_finalization = data_needed_for_finalization end def call(id) puts "finalizing #{@data_needed_for_finalization}" end end def initialize(data_needed_for_finalization) ObjectSpace.define_finalizer(self, Remover.new(data_needed_for_finalization)) end end Note that if your finalizer references the object to be finalized it will never be run on GC, although it will still be run at exit. You will get a warning if you capture the object to be finalized as the receiver of the finalizer. class CapturesSelf def initialize(name) ObjectSpace.define_finalizer(self, proc { # this finalizer will only be run on exit puts "finalizing #{name}" }) end end Also note that finalization can be unpredictable and is never guaranteed to be run except on exit. @overload define_finalizer(obj, aProc=proc()) ;T;0;'@÷d;(I"¥static 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); } if (rb_callable_receiver(block) == obj) { rb_warn("finalizer references object to be finalized"); } return define_final0(obj, block); };T;)I"static VALUE;T;*To;;T; ;F;;;I"!ObjectSpace.define_finalizer;F;@Me;@Oe;T;;ë;0;@Qe;{;IC;"KAdds 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. The return value is an array [0, aProc]. The two recommended patterns are to either create the finaliser proc in a non-instance method where it can safely capture the needed state, or to use a custom callable object that stores the needed state explicitly as instance variables. class Foo def initialize(data_needed_for_finalization) ObjectSpace.define_finalizer(self, self.class.create_finalizer(data_needed_for_finalization)) end def self.create_finalizer(data_needed_for_finalization) proc { puts "finalizing #{data_needed_for_finalization}" } end end class Bar class Remover def initialize(data_needed_for_finalization) @data_needed_for_finalization = data_needed_for_finalization end def call(id) puts "finalizing #{@data_needed_for_finalization}" end end def initialize(data_needed_for_finalization) ObjectSpace.define_finalizer(self, Remover.new(data_needed_for_finalization)) end end Note that if your finalizer references the object to be finalized it will never be run on GC, although it will still be run at exit. You will get a warning if you capture the object to be finalized as the receiver of the finalizer. class CapturesSelf def initialize(name) ObjectSpace.define_finalizer(self, proc { # this finalizer will only be run on exit puts "finalizing #{name}" }) end end Also note that finalization can be unpredictable and is never guaranteed to be run except on exit.;T;[o;= ;3I" overload;F;40;;ë;50;)I"(define_finalizer(obj, aProc=proc());T;IC;";T; @fe;>0;!F;[;[;I";T;0;6i;[[I"obj;T0[I" aProc;TI"proc();T; @fe;[;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. The return value is an array [0, aProc]. The two recommended patterns are to either create the finaliser proc in a non-instance method where it can safely capture the needed state, or to use a custom callable object that stores the needed state explicitly as instance variables. class Foo def initialize(data_needed_for_finalization) ObjectSpace.define_finalizer(self, self.class.create_finalizer(data_needed_for_finalization)) end def self.create_finalizer(data_needed_for_finalization) proc { puts "finalizing #{data_needed_for_finalization}" } end end class Bar class Remover def initialize(data_needed_for_finalization) @data_needed_for_finalization = data_needed_for_finalization end def call(id) puts "finalizing #{@data_needed_for_finalization}" end end def initialize(data_needed_for_finalization) ObjectSpace.define_finalizer(self, Remover.new(data_needed_for_finalization)) end end Note that if your finalizer references the object to be finalized it will never be run on GC, although it will still be run at exit. You will get a warning if you capture the object to be finalized as the receiver of the finalizer. class CapturesSelf def initialize(name) ObjectSpace.define_finalizer(self, proc { # this finalizer will only be run on exit puts "finalizing #{name}" }) end end Also note that finalization can be unpredictable and is never guaranteed to be run except on exit. @overload define_finalizer(obj, aProc=proc());T;0; @fe;!F;"o;#;$T;%iš ;&iÔ ;6i;'@÷d;(@de;)@ee;*To;;F; ;;;Ï;I"#ObjectSpace#undefine_finalizer;F;[[I"obj;T0;[[@iv ;T;:undefine_finalizer;0;[;{;IC;"+Removes all finalizers for obj. ;T; @{e;>0;!F;[o;= ;3I" overload;F;40;;ì;50;)I"undefine_finalizer(obj);T;IC;";T; @{e;>0;!F;[;[;I";T;0;6i;[[I"obj;T0; @{e;[;I"NRemoves all finalizers for obj. @overload undefine_finalizer(obj) ;T;0;'@÷d;(I"`static VALUE undefine_final(VALUE os, VALUE obj) { return rb_undefine_finalizer(obj); };T;)I"static VALUE;T;*To;;T; ;F;;;I"#ObjectSpace.undefine_finalizer;F;@}e;@€e;T;;ì;0;@‚e;{;IC;"+Removes all finalizers for obj.;T;[o;= ;3I" overload;F;40;;ì;50;)I"undefine_finalizer(obj);T;IC;";T; @”e;>0;!F;[;[;I";T;0;6i;[[I"obj;T0; @”e;[;I"PRemoves all finalizers for obj. @overload undefine_finalizer(obj);T;0; @”e;!F;"o;#;$T;%in ;&ir ;6i;'@÷d;(@’e;)@“e;*To;;F; ;;;Ï;I"ObjectSpace#_id2ref;F;[[I" objid;T0;[[@i°;T;:_id2ref;0;[;{;IC;" ;T; @¦e;>0;!F;[;[;I";F;0;'@÷d;(I"Pstatic VALUE os_id2ref(VALUE os, VALUE objid) { return id2ref(objid); };T;)I"static VALUE;T;*To;;T; ;F;;;I"ObjectSpace._id2ref;F;@¨e;@«e;T;;í;0;@e;{;IC;";T;[;[;@|;0; @µe;6i;'@÷d;(@³e;)@´e;*To;;F; ;;;Ï;I"ObjectSpace#_dump;F;[[I"obj;T0[I"output;T0;[[I"!ext/objspace/objspace_dump.c;TiP;T;: _dump;0;[;{;IC;" ;T; @»e;>0;!F;[;[;I";F;0;'@÷d;(I"Çstatic VALUE objspace_dump(VALUE os, VALUE obj, VALUE output) { struct dump_config dc = {0,}; dump_output(&dc, output, Qnil, Qnil); dump_object(obj, &dc); return dump_result(&dc); };T;)I"static VALUE;T;*To;;T; ;F;;;I"ObjectSpace._dump;F;@½e;@Âe;T;;î;0;@Åe;{;IC;";T;[;[;@|;0; @Íe;6i;'@÷d;(@Ëe;)@Ìe;*To;;F; ;;;Ï;I"ObjectSpace#_dump_all;F;[[I"output;T0[I" full;T0[I" since;T0;[[@Äei[;T;:_dump_all;0;[;{;IC;" ;T; @Óe;>0;!F;[;[;I";F;0;'@÷d;(I"Ästatic VALUE objspace_dump_all(VALUE os, VALUE output, VALUE full, VALUE since) { struct dump_config dc = {0,}; dump_output(&dc, output, full, since); if (!dc.partial_dump || dc.since == 0) { /* 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); };T;)I"static VALUE;T;*To;;T; ;F;;;I"ObjectSpace._dump_all;F;@Õe;@Üe;T;;ï;0;@Þe;{;IC;";T;[;[;@|;0; @æe;6i;'@÷d;(@äe;)@åe;*To;;F; ;;;Ï;I")ObjectSpace#trace_object_allocations;F;[;[[I""ext/objspace/object_tracing.c;Tic;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; @ìe;>0;!F;[o;= ;3I" overload;F;40;;ð;50;)I"trace_object_allocations;T;IC;";T; @ìe;>0;!F;[o;2 ;3I" yield;F;4I"[];T;0;50; @ìe;[;I"@yield [];T;0;6i;[; @ìe;[;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;'@÷d;(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;)I"static VALUE;T;*To;;T; ;F;;;I")ObjectSpace.trace_object_allocations;F;@îe;@ïe;T;;ð;0;@òe;{;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;= ;3I" overload;F;40;;ð;50;)I"trace_object_allocations;T;IC;";T; @f;>0;!F;[o;2 ;3I" yield;F;4I"[];T;0;50; @f;[;I"@yield [];T;0;6i;[; @f;[;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; @f;!F;"o;#;$T;%iG;&ib;6i;'@÷d;(@f;)@f;*To;;F; ;;;Ï;I"/ObjectSpace#trace_object_allocations_start;F;[;[[@ñeiÿ;T;:#trace_object_allocations_start;0;[;{;IC;"'Starts tracing object allocations. ;T; @f;>0;!F;[o;= ;3I" overload;F;40;;ñ;50;)I"#trace_object_allocations_start;T;IC;";T; @f;>0;!F;[;[;I";T;0;6i;[; @f;[;I"QStarts tracing object allocations. @overload trace_object_allocations_start ;T;0;'@÷d;(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;)I"static VALUE;T;*To;;T; ;F;;;I"/ObjectSpace.trace_object_allocations_start;F;@f;@f;T;;ñ;0;@f;{;IC;"'Starts tracing object allocations.;T;[o;= ;3I" overload;F;40;;ñ;50;)I"#trace_object_allocations_start;T;IC;";T; @-f;>0;!F;[;[;I";T;0;6i;[; @-f;[;I"SStarts tracing object allocations. @overload trace_object_allocations_start;T;0; @-f;!F;"o;#;$T;%iù;&iý;6i;'@÷d;(@+f;)@,f;*To;;F; ;;;Ï;I".ObjectSpace#trace_object_allocations_stop;F;[;[[@ñei;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; @=f;>0;!F;[o;= ;3I" overload;F;40;;ò;50;)I""trace_object_allocations_stop;T;IC;";T; @=f;>0;!F;[;[;I";T;0;6i;[; @=f;[;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;'@÷d;(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) { if (arg->newobj_trace != 0) { rb_tracepoint_disable(arg->newobj_trace); } if (arg->freeobj_trace != 0) { rb_tracepoint_disable(arg->freeobj_trace); } } return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I".ObjectSpace.trace_object_allocations_stop;F;@?f;@@f;T;;ò;0;@Bf;{;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;= ;3I" overload;F;40;;ò;50;)I""trace_object_allocations_stop;T;IC;";T; @Rf;>0;!F;[;[;I";T;0;6i;[; @Rf;[;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; @Rf;!F;"o;#;$T;%i;&i;6i;'@÷d;(@Pf;)@Qf;*To;;F; ;;;Ï;I"/ObjectSpace#trace_object_allocations_clear;F;[;[[@ñei7;T;:#trace_object_allocations_clear;0;[;{;IC;"(Clear recorded tracing information. ;T; @bf;>0;!F;[o;= ;3I" overload;F;40;;ó;50;)I"#trace_object_allocations_clear;T;IC;";T; @bf;>0;!F;[;[;I";T;0;6i;[; @bf;[;I"RClear recorded tracing information. @overload trace_object_allocations_clear ;T;0;'@÷d;(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;)I"static VALUE;T;*To;;T; ;F;;;I"/ObjectSpace.trace_object_allocations_clear;F;@df;@ef;T;;ó;0;@gf;{;IC;"(Clear recorded tracing information.;T;[o;= ;3I" overload;F;40;;ó;50;)I"#trace_object_allocations_clear;T;IC;";T; @wf;>0;!F;[;[;I";T;0;6i;[; @wf;[;I"TClear recorded tracing information. @overload trace_object_allocations_clear;T;0; @wf;!F;"o;#;$T;%i1;&i5;6i;'@÷d;(@uf;)@vf;*To;;F; ;;;Ï;I"5ObjectSpace#trace_object_allocations_debug_start;F;[;[[@ñei‹;T;:)trace_object_allocations_debug_start;0;[;{;IC;" ;T; @‡f;>0;!F;[;[;I";F;0;'@÷d;(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;)I"static VALUE;T;*To;;T; ;F;;;I"5ObjectSpace.trace_object_allocations_debug_start;F;@‰f;@Šf;T;;ô;0;@Œf;{;IC;";T;[;[;@|;0; @”f;6i;'@÷d;(@’f;)@“f;*To;;F; ;;;Ï;I"&ObjectSpace#allocation_sourcefile;F;[[I"obj;T0;[[@ñei°;T;:allocation_sourcefile;0;[;{;IC;"Returns the source file origin from the given +object+. See ::trace_object_allocations for more information and examples. ;T; @šf;>0;!F;[o;= ;3I" overload;F;40;;õ;50;)I""allocation_sourcefile(object);T;IC;";T; @šf;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @šf;[;I"@return [String];T;0;6i;[[I"object;T0; @šf;[;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;'@÷d;(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;)I"static VALUE;T;*To;;T; ;F;;;I"&ObjectSpace.allocation_sourcefile;F;@œf;@Ÿf;T;;õ;0;@¡f;{;IC;"Returns the source file origin from the given +object+. See ::trace_object_allocations for more information and examples.;T;[o;= ;3I" overload;F;40;;õ;50;)I""allocation_sourcefile(object);T;IC;";T; @¸f;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @¸f;[;I"@return [String];T;0;6i;[[I"object;T0; @¸f;[;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; @¸f;!F;"o;#;$T;%i©;&i¯;6i;'@÷d;(@¶f;)@·f;*To;;F; ;;;Ï;I"&ObjectSpace#allocation_sourceline;F;[[I"obj;T0;[[@ñeiÄ;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; @Ïf;>0;!F;[o;= ;3I" overload;F;40;;ö;50;)I""allocation_sourceline(object);T;IC;";T; @Ïf;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ïf;[;I"@return [Integer];T;0;6i;[[I"object;T0; @Ïf;[;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 [Integer];T;0;'@÷d;(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;)I"static VALUE;T;*To;;T; ;F;;;I"&ObjectSpace.allocation_sourceline;F;@Ñf;@Ôf;T;;ö;0;@Öf;{;IC;"…Returns the original line from source for from the given +object+. See ::trace_object_allocations for more information and examples.;T;[o;= ;3I" overload;F;40;;ö;50;)I""allocation_sourceline(object);T;IC;";T; @íf;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @íf;[;I"@return [Integer];T;0;6i;[[I"object;T0; @íf;[;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 [Integer];T;0; @íf;!F;"o;#;$T;%i½;&iÃ;6i;'@÷d;(@ëf;)@ìf;*To;;F; ;;;Ï;I"&ObjectSpace#allocation_class_path;F;[[I"obj;T0;[[@ñeiã;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; @g;>0;!F;[o;= ;3I" overload;F;40;;÷;50;)I""allocation_class_path(object);T;IC;";T; @g;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @g;[;I"@return [String];T;0;6i;[[I"object;T0; @g;[;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;'@÷d;(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;)I"static VALUE;T;*To;;T; ;F;;;I"&ObjectSpace.allocation_class_path;F;@g;@ g;T;;÷;0;@g;{;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;= ;3I" overload;F;40;;÷;50;)I""allocation_class_path(object);T;IC;";T; @"g;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @"g;[;I"@return [String];T;0;6i;[[I"object;T0; @"g;[;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; @"g;!F;"o;#;$T;%iÑ;&iâ;6i;'@÷d;(@ g;)@!g;*To;;F; ;;;Ï;I"%ObjectSpace#allocation_method_id;F;[[I"obj;T0;[[@ñei;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; @9g;>0;!F;[o;= ;3I" overload;F;40;;ø;50;)I"!allocation_method_id(object);T;IC;";T; @9g;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @9g;[;I"@return [String];T;0;6i;[[I"object;T0; @9g;[;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;'@÷d;(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;)I"static VALUE;T;*To;;T; ;F;;;I"%ObjectSpace.allocation_method_id;F;@;g;@>g;T;;ø;0;@@g;{;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;= ;3I" overload;F;40;;ø;50;)I"!allocation_method_id(object);T;IC;";T; @Wg;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Wg;[;I"@return [String];T;0;6i;[[I"object;T0; @Wg;[;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; @Wg;!F;"o;#;$T;%ið;&i;6i;'@÷d;(@Ug;)@Vg;*To;;F; ;;;Ï;I"&ObjectSpace#allocation_generation;F;[[I"obj;T0;[[@ñei$;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; @ng;>0;!F;[o;= ;3I" overload;F;40;;ù;50;)I""allocation_generation(object);T;IC;";T; @ng;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @ng;[;I"@return [Integer, nil];T;0;6i;[[I"object;T0; @ng;[;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 [Integer, nil];T;0;'@÷d;(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;)I"static VALUE;T;*To;;T; ;F;;;I"&ObjectSpace.allocation_generation;F;@pg;@sg;T;;ù;0;@ug;{;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;= ;3I" overload;F;40;;ù;50;)I""allocation_generation(object);T;IC;";T; @g;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @g;[;I"@return [Integer, nil];T;0;6i;[[I"object;T0; @g;[;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 [Integer, nil];T;0; @g;!F;"o;#;$T;%i;&i#;6i;'@÷d;(@‹g;)@Œg;*To;;F; ;;;Ï;I"ObjectSpace#memsize_of;F;[[I"obj;T0;[[I"ext/objspace/objspace.c;Ti5;T;:memsize_of;0;[;{;IC;"HReturn consuming memory size of obj in bytes. 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; @¥g;>0;!F;[o;= ;3I" overload;F;40;;ú;50;)I"memsize_of(obj);T;IC;";T; @¥g;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¥g;[;I"@return [Integer];T;0;6i;[[I"obj;T0; @¥g;[;I"wReturn consuming memory size of obj in bytes. 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;'@÷d;(I"gstatic VALUE memsize_of_m(VALUE self, VALUE obj) { return SIZET2NUM(rb_obj_memsize_of(obj)); };T;)I"static VALUE;T;*To;;T; ;F;;;I"ObjectSpace.memsize_of;F;@§g;@ªg;T;;ú;0;@g;{;IC;"HReturn consuming memory size of obj in bytes. 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;= ;3I" overload;F;40;;ú;50;)I"memsize_of(obj);T;IC;";T; @Äg;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Äg;[;I"@return [Integer];T;0;6i;[[I"obj;T0; @Äg;[;I"xReturn consuming memory size of obj in bytes. 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; @Äg;!F;"o;#;$T;%i%;&i2;6i;'@÷d;(@Âg;)@Ãg;*To;;F; ;;;Ï;I"ObjectSpace#memsize_of_all;F;[[@c0;[[@¬gi;T;:memsize_of_all;0;[;{;IC;"¤Return consuming memory size of all living objects in bytes. 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; @Ûg;>0;!F;[o;= ;3I" overload;F;40;;û;50;)I"memsize_of_all([klass]);T;IC;";T; @Ûg;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ûg;[;I"@return [Integer];T;0;6i;[[I"[klass];T0; @Ûg;[;I"ÛReturn consuming memory size of all living objects in bytes. 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;'@÷d;(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); } each_object_with_flags(total_i, &data); return SIZET2NUM(data.total); };T;)I"static VALUE;T;*To;;T; ;F;;;I"ObjectSpace.memsize_of_all;F;@Ýg;@ßg;T;;û;0;@ág;{;IC;"¤Return consuming memory size of all living objects in bytes. 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;= ;3I" overload;F;40;;û;50;)I"memsize_of_all([klass]);T;IC;";T; @øg;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @øg;[;I"@return [Integer];T;0;6i;[[I"[klass];T0; @øg;[;I"ÜReturn consuming memory size of all living objects in bytes. 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; @øg;!F;"o;#;$T;%iy;&i;6i;'@÷d;(@ög;)@÷g;*To;;F; ;;;Ï;I"#ObjectSpace#count_objects_size;F;[[@c0;[[@¬gi;T;:count_objects_size;0;[;{;IC;"1Counts 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 be wrong. 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; @h;>0;!F;[o;= ;3I" overload;F;40;;ü;50;)I"&count_objects_size([result_hash]);T;IC;";T; @h;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @h;[;I"@return [Hash];T;0;6i;[[I"[result_hash];T0; @h;[;I"oCounts 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 be wrong. 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;'@÷d;(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; } each_object_with_flags(cos_i, &counts[0]); 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;)I"static VALUE;T;*To;;T; ;F;;;I"#ObjectSpace.count_objects_size;F;@h;@h;T;;ü;0;@h;{;IC;"1Counts 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 be wrong. 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;= ;3I" overload;F;40;;ü;50;)I"&count_objects_size([result_hash]);T;IC;";T; @,h;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @,h;[;I"@return [Hash];T;0;6i;[[I"[result_hash];T0; @,h;[;I"pCounts 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 be wrong. 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; @,h;!F;"o;#;$T;%ié;&iý;6i;'@÷d;(@*h;)@+h;*To;;F; ;;;Ï;I"ObjectSpace#count_symbols;F;[[@c0;[[@¬giJ;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; @Ch;>0;!F;[o;= ;3I" overload;F;40;;ý;50;)I"!count_symbols([result_hash]);T;IC;";T; @Ch;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @Ch;[;I"@return [Hash];T;0;6i;[[I"[result_hash];T0; @Ch;[;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;'@÷d;(I"Òstatic 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(); each_object_with_flags(cs_i, &dynamic_counts); 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;)I"static VALUE;T;*To;;T; ;F;;;I"ObjectSpace.count_symbols;F;@Eh;@Gh;T;;ý;0;@Ih;{;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;= ;3I" overload;F;40;;ý;50;)I"!count_symbols([result_hash]);T;IC;";T; @`h;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @`h;[;I"@return [Hash];T;0;6i;[[I"[result_hash];T0; @`h;[;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; @`h;!F;"o;#;$T;%i0;&iG;6i;'@÷d;(@^h;)@_h;*To;;F; ;;;Ï;I"ObjectSpace#count_nodes;F;[[@c0;[[@¬gi};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; @wh;>0;!F;[o;= ;3I" overload;F;40;;þ;50;)I"count_nodes([result_hash]);T;IC;";T; @wh;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @wh;[;I"@return [Hash];T;0;6i;[[I"[result_hash];T0; @wh;[;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;'@÷d;(I" static VALUE count_nodes(int argc, VALUE *argv, VALUE os) { size_t nodes[NODE_LAST+1]; enum node_type i; VALUE hash = setup_hash(argc, argv); for (i = 0; i <= NODE_LAST; i++) { nodes[i] = 0; } each_object_with_flags(cn_i, &nodes[0]); 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;= ;3I" overload;F;40;;þ;50;)I"count_nodes([result_hash]);T;IC;";T; @”h;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @”h;[;I"@return [Hash];T;0;6i;[[I"[result_hash];T0; @”h;[;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; @”h;!F;"o;#;$T;%if;&iz;6i;'@÷d;(@’h;)@“h;*To;;F; ;;;Ï;I"$ObjectSpace#count_tdata_objects;F;[[@c0;[[@¬gi>;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; @«h;>0;!F;[o;= ;3I" overload;F;40;;ÿ;50;)I"'count_tdata_objects([result_hash]);T;IC;";T; @«h;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @«h;[;I"@return [Hash];T;0;6i;[[I"[result_hash];T0; @«h;[;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;'@÷d;(I"²static VALUE count_tdata_objects(int argc, VALUE *argv, VALUE self) { VALUE hash = setup_hash(argc, argv); each_object_with_flags(cto_i, (void *)hash); return hash; };T;)I"static VALUE;T;*To;;T; ;F;;;I"$ObjectSpace.count_tdata_objects;F;@h;@¯h;T;;ÿ;0;@±h;{;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;= ;3I" overload;F;40;;ÿ;50;)I"'count_tdata_objects([result_hash]);T;IC;";T; @Èh;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @Èh;[;I"@return [Hash];T;0;6i;[[I"[result_hash];T0; @Èh;[;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; @Èh;!F;"o;#;$T;%i;&i;;6i;'@÷d;(@Æh;)@Çh;*To;;F; ;;;Ï;I"$ObjectSpace#count_imemo_objects;F;[[@c0;[[@¬giz;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; @ßh;>0;!F;[o;= ;3I" overload;F;40;;;50;)I"'count_imemo_objects([result_hash]);T;IC;";T; @ßh;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @ßh;[;I"@return [Hash];T;0;6i;[[I"[result_hash];T0; @ßh;[;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;'@÷d;(I"¿static 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_env"); 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"); imemo_type_ids[8] = rb_intern("imemo_tmpbuf"); imemo_type_ids[9] = rb_intern("imemo_ast"); imemo_type_ids[10] = rb_intern("imemo_parser_strterm"); imemo_type_ids[11] = rb_intern("imemo_callinfo"); imemo_type_ids[12] = rb_intern("imemo_callcache"); imemo_type_ids[13] = rb_intern("imemo_constcache"); } each_object_with_flags(count_imemo_objects_i, (void *)hash); return hash; };T;)I"static VALUE;T;*To;;T; ;F;;;I"$ObjectSpace.count_imemo_objects;F;@áh;@ãh;T;;;0;@åh;{;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;= ;3I" overload;F;40;;;50;)I"'count_imemo_objects([result_hash]);T;IC;";T; @üh;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @üh;[;I"@return [Hash];T;0;6i;[[I"[result_hash];T0; @üh;[;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; @üh;!F;"o;#;$T;%i^;&iw;6i;'@÷d;(@úh;)@ûh;*To;;F; ;;;Ï;I"'ObjectSpace#reachable_objects_from;F;[[I"obj;T0;[[@¬gi;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; @i;>0;!F;[o;= ;3I" overload;F;40;;;50;)I" reachable_objects_from(obj);T;IC;";T; @i;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;TI"nil;T; @i;[;I"@return [Array, nil];T;0;6i;[[I"obj;T0; @i;[;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;'@÷d;(I"Ïstatic VALUE reachable_objects_from(VALUE self, VALUE obj) { if (rb_objspace_markable_object_p(obj)) { struct rof_data data; if (rb_typeddata_is_kind_of(obj, &iow_data_type)) { obj = (VALUE)DATA_PTR(obj); } data.refs = rb_ident_hash_new(); data.internals = rb_ary_new(); rb_objspace_reachable_objects_from(obj, reachable_object_from_i, &data); return rb_funcall(data.refs, rb_intern("values"), 0); } else { return Qnil; } };T;)I"static VALUE;T;*To;;T; ;F;;;I"'ObjectSpace.reachable_objects_from;F;@i;@i;T;;;0;@i;{;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;= ;3I" overload;F;40;;;50;)I" reachable_objects_from(obj);T;IC;";T; @2i;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;TI"nil;T; @2i;[;I"@return [Array, nil];T;0;6i;[[I"obj;T0; @2i;[;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; @2i;!F;"o;#;$T;%iç;&i;6i;'@÷d;(@0i;)@1i;*To;;F; ;;;Ï;I",ObjectSpace#reachable_objects_from_root;F;[;[[@¬gi\;T;: reachable_objects_from_root;0;[;{;IC;"C[MRI specific feature] Return all reachable objects from root. ;T; @Ji;>0;!F;[o;= ;3I" overload;F;40;;;50;)I" reachable_objects_from_root;T;IC;";T; @Ji;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @Ji;[;I"@return [Hash];T;0;6i;[; @Ji;[;I"{[MRI specific feature] Return all reachable objects from root. @overload reachable_objects_from_root @return [Hash];T;0;'@÷d;(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;)I"static VALUE;T;*To;;T; ;F;;;I",ObjectSpace.reachable_objects_from_root;F;@Li;@Mi;T;;;0;@Oi;{;IC;"C[MRI specific feature] Return all reachable objects from root.;T;[o;= ;3I" overload;F;40;;;50;)I" reachable_objects_from_root;T;IC;";T; @di;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @di;[;I"@return [Hash];T;0;6i;[; @di;[;I"|[MRI specific feature] Return all reachable objects from root. @overload reachable_objects_from_root @return [Hash];T;0; @di;!F;"o;#;$T;%iV;&iZ;6i;'@÷d;(@bi;)@ci;*To;;F; ;;;Ï;I""ObjectSpace#internal_class_of;F;[[I"obj;T0;[[@¬gi;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; @yi;>0;!F;[o;= ;3I" overload;F;40;;;50;)I"internal_class_of(obj);T;IC;";T; @yi;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Class;TI"Module;T; @yi;[;I"@return [Class, Module];T;0;6i;[[I"obj;T0; @yi;[;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;'@÷d;(I"Dstatic 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); } if (RB_TYPE_P(obj, T_IMEMO)) { return Qnil; } else { klass = CLASS_OF(obj); return wrap_klass_iow(klass); } };T;)I"static VALUE;T;*To;;T; ;F;;;I""ObjectSpace.internal_class_of;F;@{i;@~i;T;;;0;@€i;{;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;= ;3I" overload;F;40;;;50;)I"internal_class_of(obj);T;IC;";T; @˜i;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Class;TI"Module;T; @˜i;[;I"@return [Class, Module];T;0;6i;[[I"obj;T0; @˜i;[;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; @˜i;!F;"o;#;$T;%ix;&i;6i;'@÷d;(@–i;)@—i;*To;;F; ;;;Ï;I""ObjectSpace#internal_super_of;F;[[I"obj;T0;[[@¬giœ;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; @°i;>0;!F;[o;= ;3I" overload;F;40;;;50;)I"internal_super_of(cls);T;IC;";T; @°i;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Class;TI"Module;T; @°i;[;I"@return [Class, Module];T;0;6i;[[I"cls;T0; @°i;[;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;'@÷d;(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 (OBJ_BUILTIN_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;)I"static VALUE;T;*To;;T; ;F;;;I""ObjectSpace.internal_super_of;F;@²i;@µi;T;;;0;@·i;{;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;= ;3I" overload;F;40;;;50;)I"internal_super_of(cls);T;IC;";T; @Ïi;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Class;TI"Module;T; @Ïi;[;I"@return [Class, Module];T;0;6i;[[I"cls;T0; @Ïi;[;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; @Ïi;!F;"o;#;$T;%i“;&iš;6i;'@÷d;(@Íi;)@Îi;*To; ;IC;[o;;F; ;;;;I",ObjectSpace::InternalObjectWrapper#type;F;[;[[@¬gi±;T;: type;0;[;{;IC;"-Returns the type of the internal object. ;T;[;[;I"-Returns the type of the internal object.;T;0; @éi;!F;"o;#;$T;%i°;&i°;'@çi;(I"ystatic VALUE iow_type(VALUE self) { VALUE obj = (VALUE)DATA_PTR(self); return type2sym(BUILTIN_TYPE(obj)); };T;)I"static VALUE;T;*To;;F; ;;;;I"/ObjectSpace::InternalObjectWrapper#inspect;F;[;[[@¬gi¹;T;;r;0;[;{;IC;"See Object#inspect. ;T;[;[;I"See Object#inspect.;T;0; @÷i;!F;"o;#;$T;%i¸;&i¸;'@çi;(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;)I"static VALUE;T;*To;;F; ;;;;I":ObjectSpace::InternalObjectWrapper#internal_object_id;F;[;[[@¬giÃ;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; @j;!F;"o;#;$T;%iÂ;&iÂ;'@çi;(I"zstatic VALUE iow_internal_object_id(VALUE self) { VALUE obj = (VALUE)DATA_PTR(self); return rb_obj_id(obj); };T;)I"static VALUE;T;*T;A@çi;BIC;[;A@çi;CIC;[;A@çi;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@¬giæ;F;:InternalObjectWrapper;;K;;;[;{;IC;";T;[;[;@|;0; @çi;6i;'@÷d;I"'ObjectSpace::InternalObjectWrapper;F;S@]o;;F; ;;;Ï;I"ObjectSpace#count_objects;F;[[@c0;[[@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; @"j;>0;!F;[o;= ;3I" overload;F;40;;;50;)I"!count_objects([result_hash]);T;IC;";T; @"j;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @"j;[;I"@return [Hash];T;0;6i;[[I"[result_hash];T0; @"j;[;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;'@÷d;(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 = Qnil; if (rb_check_arity(argc, 0, 1) == 1) { hash = argv[0]; 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++) { VALUE vp = (VALUE)p; void *poisoned = asan_poisoned_object_p(vp); asan_unpoison_object(vp, false); if (p->as.basic.flags) { counts[BUILTIN_TYPE(vp)]++; } else { freed++; } if (poisoned) { GC_ASSERT(BUILTIN_TYPE(vp) == T_NONE); asan_poison_object(vp); } } total += page->total_slots; } if (hash == Qnil) { hash = rb_hash_new(); } else if (!RHASH_EMPTY_P(hash)) { rb_hash_stlike_foreach(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 = type_sym(i); if (counts[i]) rb_hash_aset(hash, type, SIZET2NUM(counts[i])); } return hash; };T;)I"static VALUE;T;*To;;T; ;F;;;I"ObjectSpace.count_objects;F;@$j;@&j;T;;;0;@(j;{;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;= ;3I" overload;F;40;;;50;)I"!count_objects([result_hash]);T;IC;";T; @?j;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @?j;[;I"@return [Hash];T;0;6i;[[I"[result_hash];T0; @?j;[;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; @?j;!F;"o;#;$T;%iû;&i;6i;'@÷d;(@=j;)@>j;*To; ;IC;[o;;F; ;;;;I"ObjectSpace::WeakMap#[]=;F;[;[;F;;Ã;;K;[;{;IC;";T;[;[;@|;0; @Xj;'@Vj;*To;;F; ;;;;I"ObjectSpace::WeakMap#[];F;[;[;F;;Â;;K;[;{;IC;";T;[;[;@|;0; @aj;'@Vj;*To;;F; ;;;;I""ObjectSpace::WeakMap#include?;F;[;[;F;;E;;K;[;{;IC;";T;[o;2 ;3I"return;F;4@|;0;5[@~; @jj;[;@|;0; @jj;6i;'@Vj;*To;;F; ;;;;I"!ObjectSpace::WeakMap#member?;F;[;[;F;;D;;K;[;{;IC;";T;[o;2 ;3I"return;F;4@|;0;5[@~; @vj;[;@|;0; @vj;6i;'@Vj;*To;;F; ;;;;I"ObjectSpace::WeakMap#key?;F;[;[;F;;Å;;K;[;{;IC;";T;[o;2 ;3I"return;F;4@|;0;5[@~; @‚j;[;@|;0; @‚j;6i;'@Vj;*To;;F; ;;;;I"!ObjectSpace::WeakMap#inspect;F;[;[;F;;r;;K;[;{;IC;";T;[;[;@|;0; @Žj;'@Vj;*To;;F; ;;;;I"ObjectSpace::WeakMap#each;F;[;[;F;;;;K;[;{;IC;";T;[;[;@|;0; @—j;'@Vj;*To;;F; ;;;;I"#ObjectSpace::WeakMap#each_pair;F;[;[;F;;´;;K;[;{;IC;";T;[;[;@|;0; @ j;'@Vj;*To;;F; ;;;;I""ObjectSpace::WeakMap#each_key;F;[;[;F;;³;;K;[;{;IC;";T;[;[;@|;0; @©j;'@Vj;*To;;F; ;;;;I"$ObjectSpace::WeakMap#each_value;F;[;[;F;;²;;K;[;{;IC;";T;[;[;@|;0; @²j;'@Vj;*To;;F; ;;;;I"ObjectSpace::WeakMap#keys;F;[;[;F;;Æ;;K;[;{;IC;";T;[;[;@|;0; @»j;'@Vj;*To;;F; ;;;;I" ObjectSpace::WeakMap#values;F;[;[;F;;¹;;K;[;{;IC;";T;[;[;@|;0; @Äj;'@Vj;*To;;F; ;;;;I"ObjectSpace::WeakMap#size;F;[;[;F;;¯;;K;[;{;IC;";T;[;[;@|;0; @Íj;'@Vj;*To;;F; ;;;;I" ObjectSpace::WeakMap#length;F;[;[;F;;°;;K;[;{;IC;";T;[;[;@|;0; @Öj;'@Vj;*T;A@Vj;BIC;[;A@Vj;CIC;[@(;A@Vj;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@if1[@i´1;T;:WeakMap;;K;;;[;{;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; @Vj;!F;"o;#;$T;%if1;&il1;'@÷d;I"ObjectSpace::WeakMap;F;S@];A@÷d;BIC;[;A@÷d;CIC;[;A@÷d;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@¬giµ[@i£1[@Äeir[@ñei4[@¬giÊ[@iJ1;T;:ObjectSpace;;K;;;[;{;IC;"ë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. See the documentation for ObjectSpace.define_finalizer for important information on how to use this method correctly. 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}" }) a = nil b = nil _produces:_ Finalizer two on 537763470 Finalizer one on 537763480;T;[;[;I"î 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. See the documentation for ObjectSpace.define_finalizer for important information on how to use this method correctly. 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}" }) a = nil b = nil _produces:_ Finalizer two on 537763470 Finalizer one on 537763480 ;T;0; @÷d;!F;"o;#;$T;%iJ1;&ib1;6i;'@;I"ObjectSpace;Fo; ;IC;[qo;;F; ;F;;;I" Array.[];F;[[@c0;[[I"array.c;Tih;T;;Â;0;[;{;IC;"ÃReturns a new array populated with the given objects. Array.[]( 1, 'a', /^A/) # => [1, "a", /^A/] Array[ 1, 'a', /^A/ ] # => [1, "a", /^A/] [ 1, 'a', /^A/ ] # => [1, "a", /^A/] ;T;[;[;I"ÄReturns a new array populated with the given objects. Array.[]( 1, 'a', /^A/) # => [1, "a", /^A/] Array[ 1, 'a', /^A/ ] # => [1, "a", /^A/] [ 1, 'a', /^A/ ] # => [1, "a", /^A/] ;T;0; @ k;!F;"o;#;$T;%i`;&ie;'@k;(I"åstatic VALUE rb_ary_s_create(int argc, VALUE *argv, VALUE klass) { VALUE ary = ary_new(klass, argc); if (argc > 0 && argv) { ary_memcpy(ary, 0, argc, argv); ARY_SET_LEN(ary, argc); } return ary; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Array.try_convert;F;[[I"ary;T0;[[@kiõ;T;;¤;0;[;{;IC;")If +object+ is an \Array object, returns +object+. Otherwise if +object+ responds to :to_ary, calls object.to_ary and returns the result. Returns +nil+ if +object+ does not respond to :to_ary Raises an exception unless object.to_ary returns an \Array object. ;T;[o;= ;3I" overload;F;40;;¤;50;)I"try_convert(object);T;IC;";T; @k;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @k;[;I"@return [Object, nil];T;0;6i;[[I"object;T0; @k;[;I"aIf +object+ is an \Array object, returns +object+. Otherwise if +object+ responds to :to_ary, calls object.to_ary and returns the result. Returns +nil+ if +object+ does not respond to :to_ary Raises an exception unless object.to_ary returns an \Array object. @overload try_convert(object) @return [Object, nil];T;0; @k;!F;"o;#;$T;%iç;&iò;'@k;(I"gstatic VALUE rb_ary_s_try_convert(VALUE dummy, VALUE ary) { return rb_check_array_type(ary); };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#initialize;F;[[@c0;[[@ki';T;;Ð;0;[;{;IC;"'Returns a new \Array. With no block and no arguments, returns a new empty \Array object. With no block and a single \Array argument +array+, returns a new \Array formed from +array+: a = Array.new([:foo, 'bar', 2]) a.class # => Array a # => [:foo, "bar", 2] With no block and a single \Integer argument +size+, returns a new \Array of the given size whose elements are all +nil+: a = Array.new(3) a # => [nil, nil, nil] With no block and arguments +size+ and +default_value+, returns an \Array of the given size; each element is that same +default_value+: a = Array.new(3, 'x') a # => ['x', 'x', 'x'] With a block and argument +size+, returns an \Array of the given size; the block is called with each successive integer +index+; the element for that +index+ is the return value from the block: a = Array.new(3) {|index| "Element #{index}" } a # => ["Element 0", "Element 1", "Element 2"] Raises ArgumentError if +size+ is negative. With a block and no argument, or a single argument +0+, ignores the block and returns a new empty \Array. ;T;[ o;= ;3I" overload;F;40;;î;50;)I"new;T;IC;";T; @9k;>0;!F;[;[;I";T;0;6i;[; @9ko;= ;3I" overload;F;40;;î;50;)I"new(array);T;IC;";T; @9k;>0;!F;[;[;I";T;0;6i;[[I" array;T0; @9ko;= ;3I" overload;F;40;;î;50;)I"new(size);T;IC;";T; @9k;>0;!F;[;[;I";T;0;6i;[[I" size;T0; @9ko;= ;3I" overload;F;40;;î;50;)I"new(size, default_value);T;IC;";T; @9k;>0;!F;[;[;I";T;0;6i;[[I" size;T0[I"default_value;T0; @9ko;= ;3I" overload;F;40;;î;50;)I"new(size);T;IC;";T; @9k;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" index;T; @9k;[;I"@yield [index];T;0;6i;[[I" size;T0; @9k;[;I"¨Returns a new \Array. With no block and no arguments, returns a new empty \Array object. With no block and a single \Array argument +array+, returns a new \Array formed from +array+: a = Array.new([:foo, 'bar', 2]) a.class # => Array a # => [:foo, "bar", 2] With no block and a single \Integer argument +size+, returns a new \Array of the given size whose elements are all +nil+: a = Array.new(3) a # => [nil, nil, nil] With no block and arguments +size+ and +default_value+, returns an \Array of the given size; each element is that same +default_value+: a = Array.new(3, 'x') a # => ['x', 'x', 'x'] With a block and argument +size+, returns an \Array of the given size; the block is called with each successive integer +index+; the element for that +index+ is the return value from the block: a = Array.new(3) {|index| "Element #{index}" } a # => ["Element 0", "Element 1", "Element 2"] Raises ArgumentError if +size+ is negative. With a block and no argument, or a single argument +0+, ignores the block and returns a new empty \Array. @overload new @overload new(array) @overload new(size) @overload new(size, default_value) @overload new(size) @yield [index];T;0; @9k;!F;"o;#;$T;%iû;&i$;'@k;(I"static VALUE rb_ary_initialize(int argc, VALUE *argv, VALUE ary) { long len; VALUE size, val; rb_ary_modify(ary); if (argc == 0) { if (ARY_OWNS_HEAP_P(ary) && ARY_HEAP_PTR(ary) != NULL) { ary_heap_free(ary); } rb_ary_unshare_safe(ary); FL_SET_EMBED(ary); ARY_SET_EMBED_LEN(ary, 0); if (rb_block_given_p()) { rb_warning("given block not used"); } return ary; } rb_scan_args(argc, argv, "02", &size, &val); if (argc == 1 && !FIXNUM_P(size)) { val = rb_check_array_type(size); if (!NIL_P(val)) { rb_ary_replace(ary, val); return ary; } } len = NUM2LONG(size); /* NUM2LONG() may call size.to_int, ary can be frozen, modified, etc */ if (len < 0) { rb_raise(rb_eArgError, "negative array size"); } if (len > ARY_MAX_SIZE) { rb_raise(rb_eArgError, "array size too big"); } /* recheck after argument conversion */ rb_ary_modify(ary); ary_resize_capa(ary, len); if (rb_block_given_p()) { long i; if (argc == 2) { rb_warn("block supersedes default value argument"); } for (i=0; i ["foo", :bar, 3] ;T;[o;= ;3I" overload;F;40;;¥;50;)I"replace(other_array);T;IC;";T; @k;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @k;[;I"@return [self];T;0;6i;[[I"other_array;T0; @k;[;I"ÎReplaces the content of +self+ with the content of +other_array+; returns +self+: a = [:foo, 'bar', 2] a.replace(['foo', :bar, 3]) # => ["foo", :bar, 3] @overload replace(other_array) @return [self];T;0; @k;!F;"o;#;$T;%iz;&i€;'@k;(I"IVALUE rb_ary_replace(VALUE copy, VALUE orig) { rb_ary_modify_check(copy); orig = to_ary(orig); if (copy == orig) return copy; if (RARRAY_LEN(orig) <= RARRAY_EMBED_LEN_MAX) { VALUE shared_root = 0; if (ARY_OWNS_HEAP_P(copy)) { ary_heap_free(copy); } else if (ARY_SHARED_P(copy)) { shared_root = ARY_SHARED_ROOT(copy); FL_UNSET_SHARED(copy); } FL_SET_EMBED(copy); ary_memcpy(copy, 0, RARRAY_LEN(orig), RARRAY_CONST_PTR_TRANSIENT(orig)); if (shared_root) { rb_ary_decrement_share(shared_root); } ARY_SET_LEN(copy, RARRAY_LEN(orig)); } else { VALUE shared_root = ary_make_shared(orig); if (ARY_OWNS_HEAP_P(copy)) { ary_heap_free(copy); } else { rb_ary_unshare_safe(copy); } FL_UNSET_EMBED(copy); ARY_SET_PTR(copy, ARY_HEAP_PTR(orig)); ARY_SET_LEN(copy, ARY_HEAP_LEN(orig)); rb_ary_set_shared(copy, shared_root); } ary_verify(copy); return copy; };T;)I" VALUE;T;*To;;F; ;;;;I"Array#inspect;F;[;[[@kiF;T;;r;0;[;{;IC;"ÁReturns the new \String formed by calling method #inspect on each array element: a = [:foo, 'bar', 2] a.inspect # => "[:foo, \"bar\", 2]" Array#to_s is an alias for Array#inspect. ;T;[o;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @žk;>0;!F;[;[;I";T;0;6i;[; @žk;[;I"ÕReturns the new \String formed by calling method #inspect on each array element: a = [:foo, 'bar', 2] a.inspect # => "[:foo, \"bar\", 2]" Array#to_s is an alias for Array#inspect. @overload inspect;T;0; o;;F; ;;;;I"Array#to_s;F;[;[[@kiž;F;;q;;K;[;{;@¥k;'@k;)I"static VALUE;T;(I"static VALUE rb_ary_inspect(VALUE ary) { if (RARRAY_LEN(ary) == 0) return rb_usascii_str_new2("[]"); return rb_exec_recursive(inspect_ary, ary, 0); };T;!F;"o;#;$T;%i:;&iB;'@k;(I"static VALUE rb_ary_inspect(VALUE ary) { if (RARRAY_LEN(ary) == 0) return rb_usascii_str_new2("[]"); return rb_exec_recursive(inspect_ary, ary, 0); };T;)@¸k;*T@±ko;;F; ;;;;I"Array#to_a;F;[;[[@kie;T;;!;0;[;{;IC;"ˆWhen +self+ is an instance of \Array, returns +self+: a = [:foo, 'bar', 2] a.to_a # => [:foo, "bar", 2] Otherwise, returns a new \Array containing the elements of +self+: class MyArray < Array; end a = MyArray.new(['foo', 'bar', 'two']) a.instance_of?(Array) # => false a.kind_of?(Array) # => true a1 = a.to_a a1 # => ["foo", "bar", "two"] a1.class # => Array # Not MyArray ;T;[o;= ;3I" overload;F;40;;!;50;)I" to_a;T;IC;";T; @¼k;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @¼k;[;I"@return [self];T;0;6i;[; @¼k;[;I"ªWhen +self+ is an instance of \Array, returns +self+: a = [:foo, 'bar', 2] a.to_a # => [:foo, "bar", 2] Otherwise, returns a new \Array containing the elements of +self+: class MyArray < Array; end a = MyArray.new(['foo', 'bar', 'two']) a.instance_of?(Array) # => false a.kind_of?(Array) # => true a1 = a.to_a a1 # => ["foo", "bar", "two"] a1.class # => Array # Not MyArray @overload to_a @return [self];T;0; @¼k;!F;"o;#;$T;%iS;&ib;'@k;(I"ºstatic VALUE rb_ary_to_a(VALUE ary) { if (rb_obj_class(ary) != rb_cArray) { VALUE dup = rb_ary_new2(RARRAY_LEN(ary)); rb_ary_replace(dup, ary); return dup; } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#to_h;F;[;[[@ki†;T;;#;0;[;{;IC;"†Returns a new \Hash formed from +self+. When a block is given, calls the block with each array element; the block must return a 2-element \Array whose two elements form a key-value pair in the returned \Hash: a = ['foo', :bar, 1, [2, 3], {baz: 4}] h = a.to_h {|item| [item, item] } h # => {"foo"=>"foo", :bar=>:bar, 1=>1, [2, 3]=>[2, 3], {:baz=>4}=>{:baz=>4}} When no block is given, +self+ must be an \Array of 2-element sub-arrays, each sub-array is formed into a key-value pair in the new \Hash: [].to_h # => {} a = [['foo', 'zero'], ['bar', 'one'], ['baz', 'two']] h = a.to_h h # => {"foo"=>"zero", "bar"=>"one", "baz"=>"two"} ;T;[o;= ;3I" overload;F;40;;#;50;)I" to_h;T;IC;";T; @×k;>0;!F;[;[;I";T;0;6i;[; @×ko;= ;3I" overload;F;40;;#;50;)I" to_h;T;IC;";T; @×k;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" item;T; @×k;[;I"@yield [item];T;0;6i;[; @×k;[;I"¶Returns a new \Hash formed from +self+. When a block is given, calls the block with each array element; the block must return a 2-element \Array whose two elements form a key-value pair in the returned \Hash: a = ['foo', :bar, 1, [2, 3], {baz: 4}] h = a.to_h {|item| [item, item] } h # => {"foo"=>"foo", :bar=>:bar, 1=>1, [2, 3]=>[2, 3], {:baz=>4}=>{:baz=>4}} When no block is given, +self+ must be an \Array of 2-element sub-arrays, each sub-array is formed into a key-value pair in the new \Hash: [].to_h # => {} a = [['foo', 'zero'], ['bar', 'one'], ['baz', 'two']] h = a.to_h h # => {"foo"=>"zero", "bar"=>"one", "baz"=>"two"} @overload to_h @overload to_h @yield [item];T;0; @×k;!F;"o;#;$T;%ip;&iƒ;'@k;(I"üstatic VALUE rb_ary_to_h(VALUE ary) { long i; VALUE hash = rb_hash_new_with_size(RARRAY_LEN(ary)); int block_given = rb_block_given_p(); for (i=0; i0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @úk;[;I"@return [self];T;0;6i;[; @úk;[;I"8Returns +self+. @overload to_ary @return [self];T;0; @úk;!F;"o;#;$T;%iž;&i¢;'@k;(I"@static VALUE rb_ary_to_ary_m(VALUE ary) { return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I" Array#==;F;[[I" ary2;T0;[[@ki©;T;;`;0;[;{;IC;"eReturns +true+ if both array.size == other_array.size and for each index +i+ in +array+, array[i] == other_array[i]: a0 = [:foo, 'bar', 2] a1 = [:foo, 'bar', 2.0] a1 == a0 # => true [] == [] # => true Otherwise, returns +false+. This method is different from method Array#eql?, which compares elements using Object#eql?. ;T;[o;= ;3I" overload;F;40;;`;50;)I"==(other_array);T;IC;";T; @l;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @l;[;I"@return [Boolean];T;0;6i;[[I"other_array;T0; @l;[;I"•Returns +true+ if both array.size == other_array.size and for each index +i+ in +array+, array[i] == other_array[i]: a0 = [:foo, 'bar', 2] a1 = [:foo, 'bar', 2.0] a1 == a0 # => true [] == [] # => true Otherwise, returns +false+. This method is different from method Array#eql?, which compares elements using Object#eql?. @overload ==(other_array) @return [Boolean];T;0; @l;!F;"o;#;$T;%i˜;&i¦;'@k;(I"Ástatic VALUE rb_ary_equal(VALUE ary1, VALUE ary2) { if (ary1 == ary2) return Qtrue; if (!RB_TYPE_P(ary2, T_ARRAY)) { if (!rb_respond_to(ary2, idTo_ary)) { return Qfalse; } return rb_equal(ary2, ary1); } if (RARRAY_LEN(ary1) != RARRAY_LEN(ary2)) return Qfalse; if (RARRAY_CONST_PTR_TRANSIENT(ary1) == RARRAY_CONST_PTR_TRANSIENT(ary2)) return Qtrue; return rb_exec_recursive_paired(recursive_equal, ary1, ary2, ary2); };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#eql?;F;[[I" ary2;T0;[[@kiÕ;T;;_;0;[;{;IC;"aReturns +true+ if +self+ and +other_array+ are the same size, and if, for each index +i+ in +self+, self[i].eql? other_array[i]: a0 = [:foo, 'bar', 2] a1 = [:foo, 'bar', 2] a1.eql?(a0) # => true Otherwise, returns +false+. This method is different from method {Array#==}[#method-i-3D-3D], which compares using method Object#==.;T;[o;= ;3I" overload;F;40;;_;50;)I"eql? other_array;T;IC;";T; @4l;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @4l;[;I"@return [Boolean];T;0;6i;[[I"other_array;T0; @4l;[;I"’Returns +true+ if +self+ and +other_array+ are the same size, and if, for each index +i+ in +self+, self[i].eql? other_array[i]: a0 = [:foo, 'bar', 2] a1 = [:foo, 'bar', 2] a1.eql?(a0) # => true Otherwise, returns +false+. This method is different from method {Array#==}[#method-i-3D-3D], which compares using method Object#==. @overload eql? other_array @return [Boolean];T;0; @4l;!F;"o;#;$T;%iÅ;&iÒ;6i;'@k;(I"hstatic VALUE rb_ary_eql(VALUE ary1, VALUE ary2) { if (ary1 == ary2) return Qtrue; if (!RB_TYPE_P(ary2, T_ARRAY)) return Qfalse; if (RARRAY_LEN(ary1) != RARRAY_LEN(ary2)) return Qfalse; if (RARRAY_CONST_PTR_TRANSIENT(ary1) == RARRAY_CONST_PTR_TRANSIENT(ary2)) return Qtrue; return rb_exec_recursive_paired(recursive_eql, ary1, ary2, ary2); };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#hash;F;[;[[@kiê;T;;b;0;[;{;IC;"ãReturns the integer hash value for +self+. Two arrays with the same content will have the same hash code (and will compare using eql?): [0, 1, 2].hash == [0, 1, 2].hash # => true [0, 1, 2].hash == [0, 1, 3].hash # => false ;T;[o;= ;3I" overload;F;40;;b;50;)I" hash;T;IC;";T; @Sl;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Sl;[;I"@return [Integer];T;0;6i;[; @Sl;[;I"Returns the integer hash value for +self+. Two arrays with the same content will have the same hash code (and will compare using eql?): [0, 1, 2].hash == [0, 1, 2].hash # => true [0, 1, 2].hash == [0, 1, 3].hash # => false @overload hash @return [Integer];T;0; @Sl;!F;"o;#;$T;%iß;&iç;'@k;(I"Ostatic VALUE rb_ary_hash(VALUE ary) { long i; st_index_t h; VALUE n; h = rb_hash_start(RARRAY_LEN(ary)); h = rb_hash_uint(h, (st_index_t)rb_ary_hash); for (i=0; i :foo a[2] # => 2 a # => [:foo, "bar", 2] If +index+ is negative, counts relative to the end of +self+: a = [:foo, 'bar', 2] a[-1] # => 2 a[-2] # => "bar" If +index+ is out of range, returns +nil+. When two \Integer arguments +start+ and +length+ are given, returns a new \Array of size +length+ containing successive elements beginning at offset +start+: a = [:foo, 'bar', 2] a[0, 2] # => [:foo, "bar"] a[1, 2] # => ["bar", 2] If start + length is greater than self.length, returns all elements from offset +start+ to the end: a = [:foo, 'bar', 2] a[0, 4] # => [:foo, "bar", 2] a[1, 3] # => ["bar", 2] a[2, 2] # => [2] If start == self.size and length >= 0, returns a new empty \Array. If +length+ is negative, returns +nil+. When a single \Range argument +range+ is given, treats range.min as +start+ above and range.size as +length+ above: a = [:foo, 'bar', 2] a[0..1] # => [:foo, "bar"] a[1..2] # => ["bar", 2] Special case: If range.start == a.size, returns a new empty \Array. If range.end is negative, calculates the end index from the end: a = [:foo, 'bar', 2] a[0..-1] # => [:foo, "bar", 2] a[0..-2] # => [:foo, "bar"] a[0..-3] # => [:foo] If range.start is negative, calculates the start index from the end: a = [:foo, 'bar', 2] a[-1..2] # => [2] a[-2..2] # => ["bar", 2] a[-3..2] # => [:foo, "bar", 2] If range.start is larger than the array size, returns +nil+. a = [:foo, 'bar', 2] a[4..1] # => nil a[4..0] # => nil a[4..-1] # => nil When a single Enumerator::ArithmeticSequence argument +aseq+ is given, returns an Array of elements corresponding to the indexes produced by the sequence. a = ['--', 'data1', '--', 'data2', '--', 'data3'] a[(1..).step(2)] # => ["data1", "data2", "data3"] Unlike slicing with range, if the start or the end of the arithmetic sequence is larger than array size, throws RangeError. a = ['--', 'data1', '--', 'data2', '--', 'data3'] a[(1..11).step(2)] # RangeError (((1..11).step(2)) out of range) a[(7..).step(2)] # RangeError (((7..).step(2)) out of range) If given a single argument, and its type is not one of the listed, tries to convert it to Integer, and raises if it is impossible: a = [:foo, 'bar', 2] # Raises TypeError (no implicit conversion of Symbol into Integer): a[:foo] Array#slice is an alias for Array#[]. ;T;[ o;= ;3I" overload;F;40;;Â;50;)I"[](index);T;IC;";T; @nl;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @nl;[;I"@return [Object, nil];T;0;6i;[[I" index;T0; @nlo;= ;3I" overload;F;40;;Â;50;)I"[](start, length);T;IC;";T; @nl;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @nl;[;I"@return [Object, nil];T;0;6i;[[I" start;T0[I"length;T0; @nlo;= ;3I" overload;F;40;;Â;50;)I"[](range);T;IC;";T; @nl;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @nl;[;I"@return [Object, nil];T;0;6i;[[I" range;T0; @nlo;= ;3I" overload;F;40;;Â;50;)I" [](aseq);T;IC;";T; @nl;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @nl;[;I"@return [Object, nil];T;0;6i;[[I" aseq;T0; @nlo;= ;3I" overload;F;40;;Ã;50;)I"slice(index);T;IC;";T; @nl;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @nl;[;I"@return [Object, nil];T;0;6i;[[I" index;T0; @nlo;= ;3I" overload;F;40;;Ã;50;)I"slice(start, length);T;IC;";T; @nl;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @nl;[;I"@return [Object, nil];T;0;6i;[[I" start;T0[I"length;T0; @nlo;= ;3I" overload;F;40;;Ã;50;)I"slice(range);T;IC;";T; @nl;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @nl;[;I"@return [Object, nil];T;0;6i;[[I" range;T0; @nlo;= ;3I" overload;F;40;;Ã;50;)I"slice(aseq);T;IC;";T; @nl;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @nl;[;I"@return [Object, nil];T;0;6i;[[I" aseq;T0; @nl;[;I"¼Returns elements from +self+; does not modify +self+. When a single \Integer argument +index+ is given, returns the element at offset +index+: a = [:foo, 'bar', 2] a[0] # => :foo a[2] # => 2 a # => [:foo, "bar", 2] If +index+ is negative, counts relative to the end of +self+: a = [:foo, 'bar', 2] a[-1] # => 2 a[-2] # => "bar" If +index+ is out of range, returns +nil+. When two \Integer arguments +start+ and +length+ are given, returns a new \Array of size +length+ containing successive elements beginning at offset +start+: a = [:foo, 'bar', 2] a[0, 2] # => [:foo, "bar"] a[1, 2] # => ["bar", 2] If start + length is greater than self.length, returns all elements from offset +start+ to the end: a = [:foo, 'bar', 2] a[0, 4] # => [:foo, "bar", 2] a[1, 3] # => ["bar", 2] a[2, 2] # => [2] If start == self.size and length >= 0, returns a new empty \Array. If +length+ is negative, returns +nil+. When a single \Range argument +range+ is given, treats range.min as +start+ above and range.size as +length+ above: a = [:foo, 'bar', 2] a[0..1] # => [:foo, "bar"] a[1..2] # => ["bar", 2] Special case: If range.start == a.size, returns a new empty \Array. If range.end is negative, calculates the end index from the end: a = [:foo, 'bar', 2] a[0..-1] # => [:foo, "bar", 2] a[0..-2] # => [:foo, "bar"] a[0..-3] # => [:foo] If range.start is negative, calculates the start index from the end: a = [:foo, 'bar', 2] a[-1..2] # => [2] a[-2..2] # => ["bar", 2] a[-3..2] # => [:foo, "bar", 2] If range.start is larger than the array size, returns +nil+. a = [:foo, 'bar', 2] a[4..1] # => nil a[4..0] # => nil a[4..-1] # => nil When a single Enumerator::ArithmeticSequence argument +aseq+ is given, returns an Array of elements corresponding to the indexes produced by the sequence. a = ['--', 'data1', '--', 'data2', '--', 'data3'] a[(1..).step(2)] # => ["data1", "data2", "data3"] Unlike slicing with range, if the start or the end of the arithmetic sequence is larger than array size, throws RangeError. a = ['--', 'data1', '--', 'data2', '--', 'data3'] a[(1..11).step(2)] # RangeError (((1..11).step(2)) out of range) a[(7..).step(2)] # RangeError (((7..).step(2)) out of range) If given a single argument, and its type is not one of the listed, tries to convert it to Integer, and raises if it is impossible: a = [:foo, 'bar', 2] # Raises TypeError (no implicit conversion of Symbol into Integer): a[:foo] Array#slice is an alias for Array#[]. @overload [](index) @return [Object, nil] @overload [](start, length) @return [Object, nil] @overload [](range) @return [Object, nil] @overload [](aseq) @return [Object, nil] @overload slice(index) @return [Object, nil] @overload slice(start, length) @return [Object, nil] @overload slice(range) @return [Object, nil] @overload slice(aseq) @return [Object, nil];T;0; @nl;!F;"o;#;$T;%i«;&i ;'@k;(I"ÌVALUE rb_ary_aref(int argc, const VALUE *argv, VALUE ary) { rb_check_arity(argc, 1, 2); if (argc == 2) { return rb_ary_aref2(ary, argv[0], argv[1]); } return rb_ary_aref1(ary, argv[0]); };T;)I" VALUE;T;*To;;F; ;;;;I"Array#[]=;F;[[@c0;[[@kiT ;T;;Ã;0;[;{;IC;"Assigns elements in +self+; returns the given +object+. When \Integer argument +index+ is given, assigns +object+ to an element in +self+. If +index+ is non-negative, assigns +object+ the element at offset +index+: a = [:foo, 'bar', 2] a[0] = 'foo' # => "foo" a # => ["foo", "bar", 2] If +index+ is greater than self.length, extends the array: a = [:foo, 'bar', 2] a[7] = 'foo' # => "foo" a # => [:foo, "bar", 2, nil, nil, nil, nil, "foo"] If +index+ is negative, counts backwards from the end of the array: a = [:foo, 'bar', 2] a[-1] = 'two' # => "two" a # => [:foo, "bar", "two"] When \Integer arguments +start+ and +length+ are given and +object+ is not an \Array, removes length - 1 elements beginning at offset +start+, and assigns +object+ at offset +start+: a = [:foo, 'bar', 2] a[0, 2] = 'foo' # => "foo" a # => ["foo", 2] If +start+ is negative, counts backwards from the end of the array: a = [:foo, 'bar', 2] a[-2, 2] = 'foo' # => "foo" a # => [:foo, "foo"] If +start+ is non-negative and outside the array ( >= self.size), extends the array with +nil+, assigns +object+ at offset +start+, and ignores +length+: a = [:foo, 'bar', 2] a[6, 50] = 'foo' # => "foo" a # => [:foo, "bar", 2, nil, nil, nil, "foo"] If +length+ is zero, shifts elements at and following offset +start+ and assigns +object+ at offset +start+: a = [:foo, 'bar', 2] a[1, 0] = 'foo' # => "foo" a # => [:foo, "foo", "bar", 2] If +length+ is too large for the existing array, does not extend the array: a = [:foo, 'bar', 2] a[1, 5] = 'foo' # => "foo" a # => [:foo, "foo"] When \Range argument +range+ is given and +object+ is an \Array, removes length - 1 elements beginning at offset +start+, and assigns +object+ at offset +start+: a = [:foo, 'bar', 2] a[0..1] = 'foo' # => "foo" a # => ["foo", 2] if range.begin is negative, counts backwards from the end of the array: a = [:foo, 'bar', 2] a[-2..2] = 'foo' # => "foo" a # => [:foo, "foo"] If the array length is less than range.begin, assigns +object+ at offset range.begin, and ignores +length+: a = [:foo, 'bar', 2] a[6..50] = 'foo' # => "foo" a # => [:foo, "bar", 2, nil, nil, nil, "foo"] If range.end is zero, shifts elements at and following offset +start+ and assigns +object+ at offset +start+: a = [:foo, 'bar', 2] a[1..0] = 'foo' # => "foo" a # => [:foo, "foo", "bar", 2] If range.end is negative, assigns +object+ at offset +start+, retains range.end.abs -1 elements past that, and removes those beyond: a = [:foo, 'bar', 2] a[1..-1] = 'foo' # => "foo" a # => [:foo, "foo"] a = [:foo, 'bar', 2] a[1..-2] = 'foo' # => "foo" a # => [:foo, "foo", 2] a = [:foo, 'bar', 2] a[1..-3] = 'foo' # => "foo" a # => [:foo, "foo", "bar", 2] a = [:foo, 'bar', 2] If range.end is too large for the existing array, replaces array elements, but does not extend the array with +nil+ values: a = [:foo, 'bar', 2] a[1..5] = 'foo' # => "foo" a # => [:foo, "foo"] ;T;[o;= ;3I" overload;F;40;;Ã;50;)I"[]=(index);T;IC;";T; @m;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @m;[;I"@return [Object];T;0;6i;[[I" index;T0; @mo;= ;3I" overload;F;40;;Ã;50;)I"[]=(start, length);T;IC;";T; @m;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @m;[;I"@return [Object];T;0;6i;[[I" start;T0[I"length;T0; @mo;= ;3I" overload;F;40;;Ã;50;)I"[]=(range);T;IC;";T; @m;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @m;[;I"@return [Object];T;0;6i;[[I" range;T0; @m;[;I"˜Assigns elements in +self+; returns the given +object+. When \Integer argument +index+ is given, assigns +object+ to an element in +self+. If +index+ is non-negative, assigns +object+ the element at offset +index+: a = [:foo, 'bar', 2] a[0] = 'foo' # => "foo" a # => ["foo", "bar", 2] If +index+ is greater than self.length, extends the array: a = [:foo, 'bar', 2] a[7] = 'foo' # => "foo" a # => [:foo, "bar", 2, nil, nil, nil, nil, "foo"] If +index+ is negative, counts backwards from the end of the array: a = [:foo, 'bar', 2] a[-1] = 'two' # => "two" a # => [:foo, "bar", "two"] When \Integer arguments +start+ and +length+ are given and +object+ is not an \Array, removes length - 1 elements beginning at offset +start+, and assigns +object+ at offset +start+: a = [:foo, 'bar', 2] a[0, 2] = 'foo' # => "foo" a # => ["foo", 2] If +start+ is negative, counts backwards from the end of the array: a = [:foo, 'bar', 2] a[-2, 2] = 'foo' # => "foo" a # => [:foo, "foo"] If +start+ is non-negative and outside the array ( >= self.size), extends the array with +nil+, assigns +object+ at offset +start+, and ignores +length+: a = [:foo, 'bar', 2] a[6, 50] = 'foo' # => "foo" a # => [:foo, "bar", 2, nil, nil, nil, "foo"] If +length+ is zero, shifts elements at and following offset +start+ and assigns +object+ at offset +start+: a = [:foo, 'bar', 2] a[1, 0] = 'foo' # => "foo" a # => [:foo, "foo", "bar", 2] If +length+ is too large for the existing array, does not extend the array: a = [:foo, 'bar', 2] a[1, 5] = 'foo' # => "foo" a # => [:foo, "foo"] When \Range argument +range+ is given and +object+ is an \Array, removes length - 1 elements beginning at offset +start+, and assigns +object+ at offset +start+: a = [:foo, 'bar', 2] a[0..1] = 'foo' # => "foo" a # => ["foo", 2] if range.begin is negative, counts backwards from the end of the array: a = [:foo, 'bar', 2] a[-2..2] = 'foo' # => "foo" a # => [:foo, "foo"] If the array length is less than range.begin, assigns +object+ at offset range.begin, and ignores +length+: a = [:foo, 'bar', 2] a[6..50] = 'foo' # => "foo" a # => [:foo, "bar", 2, nil, nil, nil, "foo"] If range.end is zero, shifts elements at and following offset +start+ and assigns +object+ at offset +start+: a = [:foo, 'bar', 2] a[1..0] = 'foo' # => "foo" a # => [:foo, "foo", "bar", 2] If range.end is negative, assigns +object+ at offset +start+, retains range.end.abs -1 elements past that, and removes those beyond: a = [:foo, 'bar', 2] a[1..-1] = 'foo' # => "foo" a # => [:foo, "foo"] a = [:foo, 'bar', 2] a[1..-2] = 'foo' # => "foo" a # => [:foo, "foo", 2] a = [:foo, 'bar', 2] a[1..-3] = 'foo' # => "foo" a # => [:foo, "foo", "bar", 2] a = [:foo, 'bar', 2] If range.end is too large for the existing array, replaces array elements, but does not extend the array with +nil+ values: a = [:foo, 'bar', 2] a[1..5] = 'foo' # => "foo" a # => [:foo, "foo"] @overload []=(index) @return [Object] @overload []=(start, length) @return [Object] @overload []=(range) @return [Object];T;0; @m;!F;"o;#;$T;%iñ;&iS ;'@k;(I"®static VALUE rb_ary_aset(int argc, VALUE *argv, VALUE ary) { long offset, beg, len; rb_check_arity(argc, 2, 3); rb_ary_modify_check(ary); if (argc == 3) { beg = NUM2LONG(argv[0]); len = NUM2LONG(argv[1]); return ary_aset_by_rb_ary_splice(ary, beg, len, argv[2]); } if (FIXNUM_P(argv[0])) { offset = FIX2LONG(argv[0]); return ary_aset_by_rb_ary_store(ary, offset, argv[1]); } if (rb_range_beg_len(argv[0], &beg, &len, RARRAY_LEN(ary), 1)) { /* check if idx is Range */ return ary_aset_by_rb_ary_splice(ary, beg, len, argv[1]); } offset = NUM2LONG(argv[0]); return ary_aset_by_rb_ary_store(ary, offset, argv[1]); };T;)I"static VALUE;T;*To;;F; ;;;;I" Array#at;F;[[I"pos;T0;[[@ki>;T;:at;0;[;{;IC;"ƒReturns the element at \Integer offset +index+; does not modify +self+. a = [:foo, 'bar', 2] a.at(0) # => :foo a.at(2) # => 2 ;T;[o;= ;3I" overload;F;40;;;50;)I"at(index);T;IC;";T; @?m;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @?m;[;I"@return [Object];T;0;6i;[[I" index;T0; @?m;[;I"¬Returns the element at \Integer offset +index+; does not modify +self+. a = [:foo, 'bar', 2] a.at(0) # => :foo a.at(2) # => 2 @overload at(index) @return [Object];T;0; @?m;!F;"o;#;$T;%i4;&i;;'@k;(I"[VALUE rb_ary_at(VALUE ary, VALUE pos) { return rb_ary_entry(ary, NUM2LONG(pos)); };T;)I" VALUE;T;*To;;F; ;;;;I"Array#fetch;F;[[@c0;[[@ki¹;T;;Ä;0;[;{;IC;"=Returns the element at offset +index+. With the single \Integer argument +index+, returns the element at offset +index+: a = [:foo, 'bar', 2] a.fetch(1) # => "bar" If +index+ is negative, counts from the end of the array: a = [:foo, 'bar', 2] a.fetch(-1) # => 2 a.fetch(-2) # => "bar" With arguments +index+ and +default_value+, returns the element at offset +index+ if index is in range, otherwise returns +default_value+: a = [:foo, 'bar', 2] a.fetch(1, nil) # => "bar" With argument +index+ and a block, returns the element at offset +index+ if index is in range (and the block is not called); otherwise calls the block with index and returns its return value: a = [:foo, 'bar', 2] a.fetch(1) {|index| raise 'Cannot happen' } # => "bar" a.fetch(50) {|index| "Value for #{index}" } # => "Value for 50" ;T;[o;= ;3I" overload;F;40;;Ä;50;)I"fetch(index);T;IC;";T; @^m;>0;!F;[;[;I";T;0;6i;[[I" index;T0; @^mo;= ;3I" overload;F;40;;Ä;50;)I" fetch(index, default_value);T;IC;";T; @^m;>0;!F;[;[;I";T;0;6i;[[I" index;T0[I"default_value;T0; @^mo;= ;3I" overload;F;40;;Ä;50;)I"fetch(index);T;IC;";T; @^m;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" index;T; @^m;[;I"@yield [index];T;0;6i;[[I" index;T0; @^m;[;I"¤Returns the element at offset +index+. With the single \Integer argument +index+, returns the element at offset +index+: a = [:foo, 'bar', 2] a.fetch(1) # => "bar" If +index+ is negative, counts from the end of the array: a = [:foo, 'bar', 2] a.fetch(-1) # => 2 a.fetch(-2) # => "bar" With arguments +index+ and +default_value+, returns the element at offset +index+ if index is in range, otherwise returns +default_value+: a = [:foo, 'bar', 2] a.fetch(1, nil) # => "bar" With argument +index+ and a block, returns the element at offset +index+ if index is in range (and the block is not called); otherwise calls the block with index and returns its return value: a = [:foo, 'bar', 2] a.fetch(1) {|index| raise 'Cannot happen' } # => "bar" a.fetch(50) {|index| "Value for #{index}" } # => "Value for 50" @overload fetch(index) @overload fetch(index, default_value) @overload fetch(index) @yield [index];T;0; @^m;!F;"o;#;$T;%i˜;&i¶;'@k;(I"¾static VALUE rb_ary_fetch(int argc, VALUE *argv, VALUE ary) { VALUE pos, ifnone; long block_given; long idx; rb_scan_args(argc, argv, "11", &pos, &ifnone); block_given = rb_block_given_p(); if (block_given && argc == 2) { rb_warn("block supersedes default value argument"); } idx = NUM2LONG(pos); if (idx < 0) { idx += RARRAY_LEN(ary); } if (idx < 0 || RARRAY_LEN(ary) <= idx) { if (block_given) return rb_yield(pos); if (argc == 1) { rb_raise(rb_eIndexError, "index %ld outside of array bounds: %ld...%ld", idx - (idx < 0 ? RARRAY_LEN(ary) : 0), -RARRAY_LEN(ary), RARRAY_LEN(ary)); } return ifnone; } return RARRAY_AREF(ary, idx); };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#first;F;[[@c0;[[@kia;T;;9;0;[;{;IC;"IReturns elements from +self+; does not modify +self+. When no argument is given, returns the first element: a = [:foo, 'bar', 2] a.first # => :foo a # => [:foo, "bar", 2] If +self+ is empty, returns +nil+. When non-negative \Integer argument +n+ is given, returns the first +n+ elements in a new \Array: a = [:foo, 'bar', 2] a.first(2) # => [:foo, "bar"] If n >= array.size, returns all elements: a = [:foo, 'bar', 2] a.first(50) # => [:foo, "bar", 2] If n == 0 returns an new empty \Array: a = [:foo, 'bar', 2] a.first(0) # [] Related: #last. ;T;[o;= ;3I" overload;F;40;;9;50;)I" first;T;IC;";T; @’m;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @’m;[;I"@return [Object, nil];T;0;6i;[; @’mo;= ;3I" overload;F;40;;9;50;)I" first(n);T;IC;";T; @’m;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @’m;[;I"†Returns elements from +self+; does not modify +self+. When no argument is given, returns the first element: a = [:foo, 'bar', 2] a.first # => :foo a # => [:foo, "bar", 2] If +self+ is empty, returns +nil+. When non-negative \Integer argument +n+ is given, returns the first +n+ elements in a new \Array: a = [:foo, 'bar', 2] a.first(2) # => [:foo, "bar"] If n >= array.size, returns all elements: a = [:foo, 'bar', 2] a.first(50) # => [:foo, "bar", 2] If n == 0 returns an new empty \Array: a = [:foo, 'bar', 2] a.first(0) # [] Related: #last. @overload first @return [Object, nil] @overload first(n);T;0; @’m;!F;"o;#;$T;%iD;&i_;'@k;(I"ñstatic VALUE rb_ary_first(int argc, VALUE *argv, VALUE ary) { if (argc == 0) { if (RARRAY_LEN(ary) == 0) return Qnil; return RARRAY_AREF(ary, 0); } else { return ary_take_first_or_last(argc, argv, ary, ARY_TAKE_FIRST); } };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#last;F;[[@c0;[[@ki‹;T;;Ý;0;[;{;IC;"@Returns elements from +self+; +self+ is not modified. When no argument is given, returns the last element: a = [:foo, 'bar', 2] a.last # => 2 a # => [:foo, "bar", 2] If +self+ is empty, returns +nil+. When non-negative \Innteger argument +n+ is given, returns the last +n+ elements in a new \Array: a = [:foo, 'bar', 2] a.last(2) # => ["bar", 2] If n >= array.size, returns all elements: a = [:foo, 'bar', 2] a.last(50) # => [:foo, "bar", 2] If n == 0, returns an new empty \Array: a = [:foo, 'bar', 2] a.last(0) # [] Related: #first. ;T;[o;= ;3I" overload;F;40;;Ý;50;)I" last;T;IC;";T; @¹m;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @¹m;[;I"@return [Object, nil];T;0;6i;[; @¹mo;= ;3I" overload;F;40;;Ý;50;)I"last(n);T;IC;";T; @¹m;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @¹m;[;I"{Returns elements from +self+; +self+ is not modified. When no argument is given, returns the last element: a = [:foo, 'bar', 2] a.last # => 2 a # => [:foo, "bar", 2] If +self+ is empty, returns +nil+. When non-negative \Innteger argument +n+ is given, returns the last +n+ elements in a new \Array: a = [:foo, 'bar', 2] a.last(2) # => ["bar", 2] If n >= array.size, returns all elements: a = [:foo, 'bar', 2] a.last(50) # => [:foo, "bar", 2] If n == 0, returns an new empty \Array: a = [:foo, 'bar', 2] a.last(0) # [] Related: #first. @overload last @return [Object, nil] @overload last(n);T;0; @¹m;!F;"o;#;$T;%im;&iˆ;'@k;(I"VALUE rb_ary_last(int argc, const VALUE *argv, VALUE ary) { if (argc == 0) { long len = RARRAY_LEN(ary); if (len == 0) return Qnil; return RARRAY_AREF(ary, len-1); } else { return ary_take_first_or_last(argc, argv, ary, ARY_TAKE_LAST); } };T;)I" VALUE;T;*To;;F; ;;;;I"Array#concat;F;[[@c0;[[@kiå;T;:concat;0;[;{;IC;"Adds to +array+ all elements from each \Array in +other_arrays+; returns +self+: a = [0, 1] a.concat([2, 3], [4, 5]) # => [0, 1, 2, 3, 4, 5] ;T;[o;= ;3I" overload;F;40;; ;50;)I"concat(*other_arrays);T;IC;";T; @àm;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @àm;[;I"@return [self];T;0;6i;[[I"*other_arrays;T0; @àm;[;I"ÃAdds to +array+ all elements from each \Array in +other_arrays+; returns +self+: a = [0, 1] a.concat([2, 3], [4, 5]) # => [0, 1, 2, 3, 4, 5] @overload concat(*other_arrays) @return [self];T;0; @àm;!F;"o;#;$T;%iÜ;&iâ;'@k;(I"kstatic VALUE rb_ary_concat_multi(int argc, VALUE *argv, VALUE ary) { rb_ary_modify_check(ary); if (argc == 1) { rb_ary_concat(ary, argv[0]); } else if (argc > 1) { int i; VALUE args = rb_ary_tmp_new(argc); for (i = 0; i < argc; i++) { rb_ary_concat(args, argv[i]); } ary_append(ary, args); } ary_verify(ary); return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#union;F;[[@c0;[[@kiœ;T;: union;0;[;{;IC;"Returns a new \Array that is the union of +self+ and all given Arrays +other_arrays+; duplicates are removed; order is preserved; items are compared using eql?: [0, 1, 2, 3].union([4, 5], [6, 7]) # => [0, 1, 2, 3, 4, 5, 6, 7] [0, 1, 1].union([2, 1], [3, 1]) # => [0, 1, 2, 3] [0, 1, 2, 3].union([3, 2], [1, 0]) # => [0, 1, 2, 3] Returns a copy of +self+ if no arguments given. Related: Array#|. ;T;[o;= ;3I" overload;F;40;;;50;)I"union(*other_arrays);T;IC;";T; @þm;>0;!F;[;[;I";T;0;6i;[[I"*other_arrays;T0; @þm;[;I"¾Returns a new \Array that is the union of +self+ and all given Arrays +other_arrays+; duplicates are removed; order is preserved; items are compared using eql?: [0, 1, 2, 3].union([4, 5], [6, 7]) # => [0, 1, 2, 3, 4, 5, 6, 7] [0, 1, 1].union([2, 1], [3, 1]) # => [0, 1, 2, 3] [0, 1, 2, 3].union([3, 2], [1, 0]) # => [0, 1, 2, 3] Returns a copy of +self+ if no arguments given. Related: Array#|. @overload union(*other_arrays);T;0; @þm;!F;"o;#;$T;%i;&i˜;'@k;(I"static VALUE rb_ary_union_multi(int argc, VALUE *argv, VALUE ary) { int i; long sum; VALUE hash, ary_union; sum = RARRAY_LEN(ary); for (i = 0; i < argc; i++) { argv[i] = to_ary(argv[i]); sum += RARRAY_LEN(argv[i]); } if (sum <= SMALL_ARRAY_LEN) { ary_union = rb_ary_new(); rb_ary_union(ary_union, ary); for (i = 0; i < argc; i++) rb_ary_union(ary_union, argv[i]); return ary_union; } hash = ary_make_hash(ary); for (i = 0; i < argc; i++) rb_ary_union_hash(hash, argv[i]); ary_union = rb_hash_values(hash); ary_recycle_hash(hash); return ary_union; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#difference;F;[[@c0;[[@kiÔ;T;:difference;0;[;{;IC;"ŸReturns a new \Array containing only those elements from +self+ that are not found in any of the Arrays +other_arrays+; items are compared using eql?; order from +self+ is preserved: [0, 1, 1, 2, 1, 1, 3, 1, 1].difference([1]) # => [0, 2, 3] [0, 1, 2, 3].difference([3, 0], [1, 3]) # => [2] [0, 1, 2].difference([4]) # => [0, 1, 2] Returns a copy of +self+ if no arguments given. Related: Array#-. ;T;[o;= ;3I" overload;F;40;;;50;)I"difference(*other_arrays);T;IC;";T; @n;>0;!F;[;[;I";T;0;6i;[[I"*other_arrays;T0; @n;[;I"ÅReturns a new \Array containing only those elements from +self+ that are not found in any of the Arrays +other_arrays+; items are compared using eql?; order from +self+ is preserved: [0, 1, 1, 2, 1, 1, 3, 1, 1].difference([1]) # => [0, 2, 3] [0, 1, 2, 3].difference([3, 0], [1, 3]) # => [2] [0, 1, 2].difference([4]) # => [0, 1, 2] Returns a copy of +self+ if no arguments given. Related: Array#-. @overload difference(*other_arrays);T;0; @n;!F;"o;#;$T;%iÄ;&iÐ;'@k;(I"Àstatic VALUE rb_ary_difference_multi(int argc, VALUE *argv, VALUE ary) { VALUE ary_diff; long i, length; volatile VALUE t0; bool *is_hash = ALLOCV_N(bool, t0, argc); ary_diff = rb_ary_new(); length = RARRAY_LEN(ary); for (i = 0; i < argc; i++) { argv[i] = to_ary(argv[i]); is_hash[i] = (length > SMALL_ARRAY_LEN && RARRAY_LEN(argv[i]) > SMALL_ARRAY_LEN); if (is_hash[i]) argv[i] = ary_make_hash(argv[i]); } for (i = 0; i < RARRAY_LEN(ary); i++) { int j; VALUE elt = rb_ary_elt(ary, i); for (j = 0; j < argc; j++) { if (is_hash[j]) { if (rb_hash_stlike_lookup(argv[j], RARRAY_AREF(ary, i), NULL)) break; } else { if (rb_ary_includes_by_eql(argv[j], elt)) break; } } if (j == argc) rb_ary_push(ary_diff, elt); } ALLOCV_END(t0); return ary_diff; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#intersection;F;[[@c0;[[@ki>;T;:intersection;0;[;{;IC;"ÇReturns a new \Array containing each element found both in +self+ and in all of the given Arrays +other_arrays+; duplicates are omitted; items are compared using eql?: [0, 1, 2, 3].intersection([0, 1, 2], [0, 1, 3]) # => [0, 1] [0, 0, 1, 1, 2, 3].intersection([0, 1, 2], [0, 1, 3]) # => [0, 1] Preserves order from +self+: [0, 1, 2].intersection([2, 1, 0]) # => [0, 1, 2] Returns a copy of +self+ if no arguments given. Related: Array#&. ;T;[o;= ;3I" overload;F;40;;;50;)I" intersection(*other_arrays);T;IC;";T; @0n;>0;!F;[;[;I";T;0;6i;[[I"*other_arrays;T0; @0n;[;I"ïReturns a new \Array containing each element found both in +self+ and in all of the given Arrays +other_arrays+; duplicates are omitted; items are compared using eql?: [0, 1, 2, 3].intersection([0, 1, 2], [0, 1, 3]) # => [0, 1] [0, 0, 1, 1, 2, 3].intersection([0, 1, 2], [0, 1, 3]) # => [0, 1] Preserves order from +self+: [0, 1, 2].intersection([2, 1, 0]) # => [0, 1, 2] Returns a copy of +self+ if no arguments given. Related: Array#&. @overload intersection(*other_arrays);T;0; @0n;!F;"o;#;$T;%i,;&i:;'@k;(I"åstatic VALUE rb_ary_intersection_multi(int argc, VALUE *argv, VALUE ary) { VALUE result = rb_ary_dup(ary); int i; for (i = 0; i < argc; i++) { result = rb_ary_and(result, argv[i]); } return result; };T;)I"static VALUE;T;*To;;F; ;;;;I" Array#<<;F;[[I" item;T0;[[@ki;T;;Ý;0;[;{;IC;"÷Appends +object+ to +self+; returns +self+: a = [:foo, 'bar', 2] a << :baz # => [:foo, "bar", 2, :baz] Appends +object+ as one element, even if it is another \Array: a = [:foo, 'bar', 2] a1 = a << [3, 4] a1 # => [:foo, "bar", 2, [3, 4]] ;T;[o;= ;3I" overload;F;40;;Ý;50;)I"<<(object);T;IC;";T; @In;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @In;[;I"@return [self];T;0;6i;[[I"object;T0; @In;[;I"Appends +object+ to +self+; returns +self+: a = [:foo, 'bar', 2] a << :baz # => [:foo, "bar", 2, :baz] Appends +object+ as one element, even if it is another \Array: a = [:foo, 'bar', 2] a1 = a << [3, 4] a1 # => [:foo, "bar", 2, [3, 4]] @overload <<(object) @return [self];T;0; @In;!F;"o;#;$T;%i;&i;'@k;(I"9VALUE rb_ary_push(VALUE ary, VALUE item) { long idx = RARRAY_LEN((ary_verify(ary), ary)); VALUE target_ary = ary_ensure_room_for_push(ary, 1); RARRAY_PTR_USE_TRANSIENT(ary, ptr, { RB_OBJ_WRITE(target_ary, &ptr[idx], item); }); ARY_SET_LEN(ary, idx + 1); ary_verify(ary); return ary; };T;)I" VALUE;T;*To;;F; ;;;;I"Array#push;F;[[@c0;[[@ki?;T;: push;0;[;{;IC;"²Appends trailing elements. Appends each argument in +objects+ to +self+; returns +self+: a = [:foo, 'bar', 2] a.push(:baz, :bat) # => [:foo, "bar", 2, :baz, :bat] Appends each argument as one element, even if it is another \Array: a = [:foo, 'bar', 2] a1 = a.push([:baz, :bat], [:bam, :bad]) a1 # => [:foo, "bar", 2, [:baz, :bat], [:bam, :bad]] Array#append is an alias for \Array#push. Related: #pop, #shift, #unshift. ;T;[o;= ;3I" overload;F;40;;;50;)I"push(*objects);T;IC;";T; @hn;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @hn;[;I"@return [self];T;0;6i;[[I" *objects;T0; @hn;[;I"ÞAppends trailing elements. Appends each argument in +objects+ to +self+; returns +self+: a = [:foo, 'bar', 2] a.push(:baz, :bat) # => [:foo, "bar", 2, :baz, :bat] Appends each argument as one element, even if it is another \Array: a = [:foo, 'bar', 2] a1 = a.push([:baz, :bat], [:bam, :bad]) a1 # => [:foo, "bar", 2, [:baz, :bat], [:bam, :bad]] Array#append is an alias for \Array#push. Related: #pop, #shift, #unshift. @overload push(*objects) @return [self];T;0; o;;F; ;;;;I"Array#append;F;[;[[@ki³;F;:append;;K;[;{;@pn;'@k;)I"static VALUE;T;(I"mstatic VALUE rb_ary_push_m(int argc, VALUE *argv, VALUE ary) { return rb_ary_cat(ary, argv, argc); };T;!F;"o;#;$T;%i+;&i<;'@k;(I"mstatic VALUE rb_ary_push_m(int argc, VALUE *argv, VALUE ary) { return rb_ary_cat(ary, argv, argc); };T;)@Šn;*T@ƒno;;F; ;;;;I"Array#pop;F;[[@c0;[[@kit;T;:pop;0;[;{;IC;"9Removes and returns trailing elements. When no argument is given and +self+ is not empty, removes and returns the last element: a = [:foo, 'bar', 2] a.pop # => 2 a # => [:foo, "bar"] Returns +nil+ if the array is empty. When a non-negative \Integer argument +n+ is given and is in range, removes and returns the last +n+ elements in a new \Array: a = [:foo, 'bar', 2] a.pop(2) # => ["bar", 2] If +n+ is positive and out of range, removes and returns all elements: a = [:foo, 'bar', 2] a.pop(50) # => [:foo, "bar", 2] Related: #push, #shift, #unshift. ;T;[o;= ;3I" overload;F;40;;;50;)I"pop;T;IC;";T; @Žn;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @Žn;[;I"@return [Object, nil];T;0;6i;[; @Žno;= ;3I" overload;F;40;;;50;)I"pop(n);T;IC;";T; @Žn;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @Žn;[;I"rRemoves and returns trailing elements. When no argument is given and +self+ is not empty, removes and returns the last element: a = [:foo, 'bar', 2] a.pop # => 2 a # => [:foo, "bar"] Returns +nil+ if the array is empty. When a non-negative \Integer argument +n+ is given and is in range, removes and returns the last +n+ elements in a new \Array: a = [:foo, 'bar', 2] a.pop(2) # => ["bar", 2] If +n+ is positive and out of range, removes and returns all elements: a = [:foo, 'bar', 2] a.pop(50) # => [:foo, "bar", 2] Related: #push, #shift, #unshift. @overload pop @return [Object, nil] @overload pop(n);T;0; @Žn;!F;"o;#;$T;%iX;&iq;'@k;(I"Bstatic VALUE rb_ary_pop_m(int argc, VALUE *argv, VALUE ary) { VALUE result; if (argc == 0) { return rb_ary_pop(ary); } rb_ary_modify_check(ary); result = ary_take_first_or_last(argc, argv, ary, ARY_TAKE_LAST); ARY_INCREASE_LEN(ary, -RARRAY_LEN(result)); ary_verify(ary); return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#shift;F;[[@c0;[[@kiÄ;T;;¼;0;[;{;IC;"Removes and returns leading elements. When no argument is given, removes and returns the first element: a = [:foo, 'bar', 2] a.shift # => :foo a # => ['bar', 2] Returns +nil+ if +self+ is empty. When positive \Integer argument +n+ is given, removes the first +n+ elements; returns those elements in a new \Array: a = [:foo, 'bar', 2] a.shift(2) # => [:foo, 'bar'] a # => [2] If +n+ is as large as or larger than self.length, removes all elements; returns those elements in a new \Array: a = [:foo, 'bar', 2] a.shift(3) # => [:foo, 'bar', 2] If +n+ is zero, returns a new empty \Array; +self+ is unmodified. Related: #push, #pop, #unshift. ;T;[o;= ;3I" overload;F;40;;¼;50;)I" shift;T;IC;";T; @µn;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @µn;[;I"@return [Object, nil];T;0;6i;[; @µno;= ;3I" overload;F;40;;¼;50;)I" shift(n);T;IC;";T; @µn;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @µn;[;I"ÚRemoves and returns leading elements. When no argument is given, removes and returns the first element: a = [:foo, 'bar', 2] a.shift # => :foo a # => ['bar', 2] Returns +nil+ if +self+ is empty. When positive \Integer argument +n+ is given, removes the first +n+ elements; returns those elements in a new \Array: a = [:foo, 'bar', 2] a.shift(2) # => [:foo, 'bar'] a # => [2] If +n+ is as large as or larger than self.length, removes all elements; returns those elements in a new \Array: a = [:foo, 'bar', 2] a.shift(3) # => [:foo, 'bar', 2] If +n+ is zero, returns a new empty \Array; +self+ is unmodified. Related: #push, #pop, #unshift. @overload shift @return [Object, nil] @overload shift(n);T;0; @µn;!F;"o;#;$T;%i¦;&iÁ;'@k;(I"Estatic VALUE rb_ary_shift_m(int argc, VALUE *argv, VALUE ary) { VALUE result; long n; if (argc == 0) { return rb_ary_shift(ary); } rb_ary_modify_check(ary); result = ary_take_first_or_last(argc, argv, ary, ARY_TAKE_FIRST); n = RARRAY_LEN(result); rb_ary_behead(ary,n); return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#unshift;F;[[@c0;[[@kid;T;:unshift;0;[;{;IC;"ÅPrepends the given +objects+ to +self+: a = [:foo, 'bar', 2] a.unshift(:bam, :bat) # => [:bam, :bat, :foo, "bar", 2] Array#prepend is an alias for Array#unshift. Related: #push, #pop, #shift. ;T;[o;= ;3I" overload;F;40;;;50;)I"unshift(*objects);T;IC;";T; @Ün;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @Ün;[;I"@return [self];T;0;6i;[[I" *objects;T0; @Ün;[;I"ôPrepends the given +objects+ to +self+: a = [:foo, 'bar', 2] a.unshift(:bam, :bat) # => [:bam, :bat, :foo, "bar", 2] Array#prepend is an alias for Array#unshift. Related: #push, #pop, #shift. @overload unshift(*objects) @return [self];T;0; o;;F; ;;;;I"Array#prepend;F;[;[[@ki·;F;;d;;K;[;{;@än;'@k;)I"static VALUE;T;(I"Zstatic VALUE rb_ary_unshift_m(int argc, VALUE *argv, VALUE ary) { long len = RARRAY_LEN(ary); VALUE target_ary; if (argc == 0) { rb_ary_modify_check(ary); return ary; } target_ary = ary_ensure_room_for_unshift(ary, argc); ary_memcpy0(ary, 0, argc, argv, target_ary); ARY_SET_LEN(ary, len + argc); return ary; };T;!F;"o;#;$T;%iW;&ia;'@k;(I"Zstatic VALUE rb_ary_unshift_m(int argc, VALUE *argv, VALUE ary) { long len = RARRAY_LEN(ary); VALUE target_ary; if (argc == 0) { rb_ary_modify_check(ary); return ary; } target_ary = ary_ensure_room_for_unshift(ary, argc); ary_memcpy0(ary, 0, argc, argv, target_ary); ARY_SET_LEN(ary, len + argc); return ary; };T;)@þn;*T@÷no;;F; ;;;;I"Array#insert;F;[[@c0;[[@kiŒ ;T;:insert;0;[;{;IC;" Inserts given +objects+ before or after the element at \Integer index +offset+; returns +self+. When +index+ is non-negative, inserts all given +objects+ before the element at offset +index+: a = [:foo, 'bar', 2] a.insert(1, :bat, :bam) # => [:foo, :bat, :bam, "bar", 2] Extends the array if +index+ is beyond the array (index >= self.size): a = [:foo, 'bar', 2] a.insert(5, :bat, :bam) a # => [:foo, "bar", 2, nil, nil, :bat, :bam] Does nothing if no objects given: a = [:foo, 'bar', 2] a.insert(1) a.insert(50) a.insert(-50) a # => [:foo, "bar", 2] When +index+ is negative, inserts all given +objects+ _after_ the element at offset index+self.size: a = [:foo, 'bar', 2] a.insert(-2, :bat, :bam) a # => [:foo, "bar", :bat, :bam, 2] ;T;[o;= ;3I" overload;F;40;;;50;)I"insert(index, *objects);T;IC;";T; @o;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @o;[;I"@return [self];T;0;6i;[[I" index;T0[I" *objects;T0; @o;[;I"BInserts given +objects+ before or after the element at \Integer index +offset+; returns +self+. When +index+ is non-negative, inserts all given +objects+ before the element at offset +index+: a = [:foo, 'bar', 2] a.insert(1, :bat, :bam) # => [:foo, :bat, :bam, "bar", 2] Extends the array if +index+ is beyond the array (index >= self.size): a = [:foo, 'bar', 2] a.insert(5, :bat, :bam) a # => [:foo, "bar", 2, nil, nil, :bat, :bam] Does nothing if no objects given: a = [:foo, 'bar', 2] a.insert(1) a.insert(50) a.insert(-50) a # => [:foo, "bar", 2] When +index+ is negative, inserts all given +objects+ _after_ the element at offset index+self.size: a = [:foo, 'bar', 2] a.insert(-2, :bat, :bam) a # => [:foo, "bar", :bat, :bam, 2] @overload insert(index, *objects) @return [self];T;0; @o;!F;"o;#;$T;%im ;&i‰ ;'@k;(I"static VALUE rb_ary_insert(int argc, VALUE *argv, VALUE ary) { long pos; rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS); rb_ary_modify_check(ary); pos = NUM2LONG(argv[0]); if (argc == 1) return ary; if (pos == -1) { pos = RARRAY_LEN(ary); } else if (pos < 0) { long minpos = -RARRAY_LEN(ary) - 1; if (pos < minpos) { rb_raise(rb_eIndexError, "index %ld too small for array; minimum: %ld", pos, minpos); } pos++; } rb_ary_splice(ary, pos, 0, argv + 1, argc - 1); return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#each;F;[;[[@kiÔ ;T;;;0;[;{;IC;"¸Iterates over array elements. When a block given, passes each successive array element to the block; returns +self+: a = [:foo, 'bar', 2] a.each {|element| puts "#{element.class} #{element}" } Output: Symbol foo String bar Integer 2 Allows the array to be modified during iteration: a = [:foo, 'bar', 2] a.each {|element| puts element; a.clear if element.to_s.start_with?('b') } Output: foo bar When no block given, returns a new \Enumerator: a = [:foo, 'bar', 2] e = a.each e # => # a1 = e.each {|element| puts "#{element.class} #{element}" } Output: Symbol foo String bar Integer 2 Related: #each_index, #reverse_each. ;T;[o;= ;3I" overload;F;40;;;50;)I" each;T;IC;";T; @"o;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @"oo;2 ;3I"return;F;4I";T;0;5[I" self;T; @"o;[;I"$@yield [element] @return [self];T;0;6i;[; @"oo;= ;3I" overload;F;40;;;50;)I" each;T;IC;";T; @"o;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Enumerator;T; @"o;[;I"@return [Enumerator];T;0;6i;[; @"o;[;I"Iterates over array elements. When a block given, passes each successive array element to the block; returns +self+: a = [:foo, 'bar', 2] a.each {|element| puts "#{element.class} #{element}" } Output: Symbol foo String bar Integer 2 Allows the array to be modified during iteration: a = [:foo, 'bar', 2] a.each {|element| puts element; a.clear if element.to_s.start_with?('b') } Output: foo bar When no block given, returns a new \Enumerator: a = [:foo, 'bar', 2] e = a.each e # => # a1 = e.each {|element| puts "#{element.class} #{element}" } Output: Symbol foo String bar Integer 2 Related: #each_index, #reverse_each. @overload each @yield [element] @return [self] @overload each @return [Enumerator];T;0; @"o;!F;"o;#;$T;%i ;&iÓ ;'@k;(I"ØVALUE rb_ary_each(VALUE ary) { long i; ary_verify(ary); RETURN_SIZED_ENUMERATOR(ary, 0, 0, ary_enum_length); for (i=0; i 0 } Output: 0 1 When no block given, returns a new \Enumerator: a = [:foo, 'bar', 2] e = a.each_index e # => # a1 = e.each {|index| puts "#{index} #{a[index]}"} Output: 0 foo 1 bar 2 2 Related: #each, #reverse_each. ;T;[o;= ;3I" overload;F;40;;;50;)I"each_index;T;IC;";T; @Oo;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" index;T; @Ooo;2 ;3I"return;F;4I";T;0;5[I" self;T; @Oo;[;I""@yield [index] @return [self];T;0;6i;[; @Ooo;= ;3I" overload;F;40;;;50;)I"each_index;T;IC;";T; @Oo;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Enumerator;T; @Oo;[;I"@return [Enumerator];T;0;6i;[; @Oo;[;I"ÝIterates over array indexes. When a block given, passes each successive array index to the block; returns +self+: a = [:foo, 'bar', 2] a.each_index {|index| puts "#{index} #{a[index]}" } Output: 0 foo 1 bar 2 2 Allows the array to be modified during iteration: a = [:foo, 'bar', 2] a.each_index {|index| puts index; a.clear if index > 0 } Output: 0 1 When no block given, returns a new \Enumerator: a = [:foo, 'bar', 2] e = a.each_index e # => # a1 = e.each {|index| puts "#{index} #{a[index]}"} Output: 0 foo 1 bar 2 2 Related: #each, #reverse_each. @overload each_index @yield [index] @return [self] @overload each_index @return [Enumerator];T;0; @Oo;!F;"o;#;$T;%ià ;&i ;'@k;(I"Éstatic VALUE rb_ary_each_index(VALUE ary) { long i; RETURN_SIZED_ENUMERATOR(ary, 0, 0, ary_enum_length); for (i=0; i # a1 = e.each {|element| puts "#{element.class} #{element}" } Output: Integer 2 String bar Symbol foo Related: #each, #each_index. ;T;[o;= ;3I" overload;F;40;;G;50;)I"reverse_each;T;IC;";T; @|o;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @|oo;2 ;3I"return;F;4I";T;0;5[I" self;T; @|o;[;I"$@yield [element] @return [self];T;0;6i;[; @|oo;= ;3I" overload;F;40;;G;50;)I"reverse_each;T;IC;";T; @|o;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Enumerator;T; @|o;[;I"@return [Enumerator];T;0;6i;[; @|o;[;I"DIterates backwards over array elements. When a block given, passes, in reverse order, each element to the block; returns +self+: a = [:foo, 'bar', 2] a.reverse_each {|element| puts "#{element.class} #{element}" } Output: Integer 2 String bar Symbol foo Allows the array to be modified during iteration: a = [:foo, 'bar', 2] a.reverse_each {|element| puts element; a.clear if element.to_s.start_with?('b') } Output: 2 bar When no block given, returns a new \Enumerator: a = [:foo, 'bar', 2] e = a.reverse_each e # => # a1 = e.each {|element| puts "#{element.class} #{element}" } Output: Integer 2 String bar Symbol foo Related: #each, #each_index. @overload reverse_each @yield [element] @return [self] @overload reverse_each @return [Enumerator];T;0; @|o;!F;"o;#;$T;%i ;&i8 ;'@k;(I"*static VALUE rb_ary_reverse_each(VALUE ary) { long len; RETURN_SIZED_ENUMERATOR(ary, 0, 0, ary_enum_length); len = RARRAY_LEN(ary); while (len--) { long nlen; rb_yield(RARRAY_AREF(ary, len)); nlen = RARRAY_LEN(ary); if (nlen < len) { len = nlen; } } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#length;F;[;[[@kiR ;T;;°;0;[;{;IC;"-Returns the count of elements in +self+. ;T;[o;= ;3I" overload;F;40;;°;50;)I"length;T;IC;";T; @©o;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @©o;[;I"@return [Integer];T;0;6i;[; @©o;[;I"TReturns the count of elements in +self+. @overload length @return [Integer];T;0; @©o;!F;"o;#;$T;%iK ;&iO ;'@k;(I"hstatic VALUE rb_ary_length(VALUE ary) { long len = RARRAY_LEN(ary); return LONG2NUM(len); };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#size;F;[;[[@kiR ;T;;¯;0;[;{;IC;"-Returns the count of elements in +self+. ;T;[o;= ;3I" overload;F;40;;°;50;)I"length;T;IC;";T; @Äo;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Äo;[;I"@return [Integer];T;0;6i;[; @Äo;[;@Ào;0; @Äo;!F;"o;#;$T;%iK ;&iO ;'@k;(I"hstatic VALUE rb_ary_length(VALUE ary) { long len = RARRAY_LEN(ary); return LONG2NUM(len); };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#empty?;F;[;[[@kia ;T;;±;0;[;{;IC;"RReturns +true+ if the count of elements in +self+ is zero, +false+ otherwise.;T;[o;= ;3I" overload;F;40;;±;50;)I"empty?;T;IC;";T; @Þo;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Þo;[;I"@return [Boolean];T;0;6i;[; @Þo;[;I"yReturns +true+ if the count of elements in +self+ is zero, +false+ otherwise. @overload empty? @return [Boolean];T;0; @Þo;!F;"o;#;$T;%iY ;&i^ ;6i;'@k;(I"ostatic VALUE rb_ary_empty_p(VALUE ary) { if (RARRAY_LEN(ary) == 0) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#find_index;F;[[@c0;[[@kiø;T;;+;0;[;{;IC;"XReturns the index of a specified element. When argument +object+ is given but no block, returns the index of the first element +element+ for which object == element: a = [:foo, 'bar', 2, 'bar'] a.index('bar') # => 1 Returns +nil+ if no such element found. When both argument +object+ and a block are given, calls the block with each successive element; returns the index of the first element for which the block returns a truthy value: a = [:foo, 'bar', 2, 'bar'] a.index {|element| element == 'bar' } # => 1 Returns +nil+ if the block never returns a truthy value. When neither an argument nor a block is given, returns a new Enumerator: a = [:foo, 'bar', 2] e = a.index e # => # e.each {|element| element == 'bar' } # => 1 Array#find_index is an alias for Array#index. Related: #rindex. ;T;[o;= ;3I" overload;F;40;: index;50;)I"index(object);T;IC;";T; @ùo;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @ùo;[;I"@return [Integer, nil];T;0;6i;[[I"object;T0; @ùoo;= ;3I" overload;F;40;;;50;)I" index;T;IC;";T; @ùo;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @ùoo;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @ùo;[;I",@yield [element] @return [Integer, nil];T;0;6i;[; @ùoo;= ;3I" overload;F;40;;;50;)I" index;T;IC;";T; @ùo;>0;!F;[;[;I";T;0;6i;[; @ùo;[;I"×Returns the index of a specified element. When argument +object+ is given but no block, returns the index of the first element +element+ for which object == element: a = [:foo, 'bar', 2, 'bar'] a.index('bar') # => 1 Returns +nil+ if no such element found. When both argument +object+ and a block are given, calls the block with each successive element; returns the index of the first element for which the block returns a truthy value: a = [:foo, 'bar', 2, 'bar'] a.index {|element| element == 'bar' } # => 1 Returns +nil+ if the block never returns a truthy value. When neither an argument nor a block is given, returns a new Enumerator: a = [:foo, 'bar', 2] e = a.index e # => # e.each {|element| element == 'bar' } # => 1 Array#find_index is an alias for Array#index. Related: #rindex. @overload index(object) @return [Integer, nil] @overload index @yield [element] @return [Integer, nil] @overload index;T;0; @ùo;!F;"o;#;$T;%iÕ;&i÷;'@k;(I"static VALUE rb_ary_index(int argc, VALUE *argv, VALUE ary) { VALUE val; long i; if (argc == 0) { RETURN_ENUMERATOR(ary, 0, 0); for (i=0; iobject == element: a = [:foo, 'bar', 2, 'bar'] a.index('bar') # => 1 Returns +nil+ if no such element found. When both argument +object+ and a block are given, calls the block with each successive element; returns the index of the first element for which the block returns a truthy value: a = [:foo, 'bar', 2, 'bar'] a.index {|element| element == 'bar' } # => 1 Returns +nil+ if the block never returns a truthy value. When neither an argument nor a block is given, returns a new Enumerator: a = [:foo, 'bar', 2] e = a.index e # => # e.each {|element| element == 'bar' } # => 1 Array#find_index is an alias for Array#index. Related: #rindex. ;T;[o;= ;3I" overload;F;40;;;50;)I"index(object);T;IC;";T; @3p;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @3p;[;I"@return [Integer, nil];T;0;6i;[[I"object;T0; @3po;= ;3I" overload;F;40;;;50;)I" index;T;IC;";T; @3p;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @3po;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @3p;[;I",@yield [element] @return [Integer, nil];T;0;6i;[; @3po;= ;3I" overload;F;40;;;50;)I" index;T;IC;";T; @3p;>0;!F;[;[;I";T;0;6i;[; @3p;[;@/p;0; @3p;!F;"o;#;$T;%iÕ;&i÷;'@k;(I"static VALUE rb_ary_index(int argc, VALUE *argv, VALUE ary) { VALUE val; long i; if (argc == 0) { RETURN_ENUMERATOR(ary, 0, 0); for (i=0; iobject == element. When argument +object+ is given but no block, returns the index of the last such element found: a = [:foo, 'bar', 2, 'bar'] a.rindex('bar') # => 3 Returns +nil+ if no such object found. When a block is given but no argument, calls the block with each successive element; returns the index of the last element for which the block returns a truthy value: a = [:foo, 'bar', 2, 'bar'] a.rindex {|element| element == 'bar' } # => 3 Returns +nil+ if the block never returns a truthy value. When neither an argument nor a block is given, returns a new \Enumerator: a = [:foo, 'bar', 2, 'bar'] e = a.rindex e # => # e.each {|element| element == 'bar' } # => 3 Related: #index. ;T;[o;= ;3I" overload;F;40;;;50;)I"rindex(object);T;IC;";T; @lp;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @lp;[;I"@return [Integer, nil];T;0;6i;[[I"object;T0; @lpo;= ;3I" overload;F;40;;;50;)I"rindex;T;IC;";T; @lp;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @lpo;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @lp;[;I",@yield [element] @return [Integer, nil];T;0;6i;[; @lpo;= ;3I" overload;F;40;;;50;)I"rindex;T;IC;";T; @lp;>0;!F;[;[;I";T;0;6i;[; @lp;[;I"Returns the index of the last element for which object == element. When argument +object+ is given but no block, returns the index of the last such element found: a = [:foo, 'bar', 2, 'bar'] a.rindex('bar') # => 3 Returns +nil+ if no such object found. When a block is given but no argument, calls the block with each successive element; returns the index of the last element for which the block returns a truthy value: a = [:foo, 'bar', 2, 'bar'] a.rindex {|element| element == 'bar' } # => 3 Returns +nil+ if the block never returns a truthy value. When neither an argument nor a block is given, returns a new \Enumerator: a = [:foo, 'bar', 2, 'bar'] e = a.rindex e # => # e.each {|element| element == 'bar' } # => 3 Related: #index. @overload rindex(object) @return [Integer, nil] @overload rindex @yield [element] @return [Integer, nil] @overload rindex;T;0; @lp;!F;"o;#;$T;%i;&i2;'@k;(I"{static VALUE rb_ary_rindex(int argc, VALUE *argv, VALUE ary) { VALUE val; long i = RARRAY_LEN(ary), len; if (argc == 0) { RETURN_ENUMERATOR(ary, 0, 0); while (i--) { if (RTEST(rb_yield(RARRAY_AREF(ary, i)))) return LONG2NUM(i); if (i > (len = RARRAY_LEN(ary))) { i = len; } } return Qnil; } rb_check_arity(argc, 0, 1); val = argv[0]; if (rb_block_given_p()) rb_warn("given block not used"); while (i--) { VALUE e = RARRAY_AREF(ary, i); if (rb_equal(e, val)) { return LONG2NUM(i); } if (i > RARRAY_LEN(ary)) { break; } } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#join;F;[[@c0;[[@ki;T;;½;0;[;{;IC;"vReturns the new \String formed by joining the array elements after conversion. For each element +element+ - Uses element.to_s if +element+ is not a kind_of?(Array). - Uses recursive element.join(separator) if +element+ is a kind_of?(Array). With no argument, joins using the output field separator, $,: a = [:foo, 'bar', 2] $, # => nil a.join # => "foobar2" With \string argument +separator+, joins using that separator: a = [:foo, 'bar', 2] a.join("\n") # => "foo\nbar\n2" Joins recursively for nested Arrays: a = [:foo, [:bar, [:baz, :bat]]] a.join # => "foobarbazbat" ;T;[o;= ;3I" overload;F;40;:-;50;)I"->new_string;T;IC;";T; @¦p;>0;!F;[;[;I";T;0;6i;[; @¦po;= ;3I" overload;F;40;;½;50;)I"join(separator = $,);T;IC;";T; @¦p;>0;!F;[;[;I";T;0;6i;[[I"separator;TI"$,;T; @¦p;[;I"®Returns the new \String formed by joining the array elements after conversion. For each element +element+ - Uses element.to_s if +element+ is not a kind_of?(Array). - Uses recursive element.join(separator) if +element+ is a kind_of?(Array). With no argument, joins using the output field separator, $,: a = [:foo, 'bar', 2] $, # => nil a.join # => "foobar2" With \string argument +separator+, joins using that separator: a = [:foo, 'bar', 2] a.join("\n") # => "foo\nbar\n2" Joins recursively for nested Arrays: a = [:foo, [:bar, [:baz, :bat]]] a.join # => "foobarbazbat" @overload ->new_string @overload join(separator = $,);T;0; @¦p;!F;"o;#;$T;%i;&i;'@k;(I"Vstatic VALUE rb_ary_join_m(int argc, VALUE *argv, VALUE ary) { VALUE sep; if (rb_check_arity(argc, 0, 1) == 0 || NIL_P(sep = argv[0])) { sep = rb_output_fs; if (!NIL_P(sep)) { rb_category_warn(RB_WARN_CATEGORY_DEPRECATED, "$, is set to non-nil value"); } } return rb_ary_join(ary, sep); };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#reverse;F;[;[[@kiÞ;T;:reverse;0;[;{;IC;"Returns a new \Array with the elements of +self+ in reverse order. a = ['foo', 'bar', 'two'] a1 = a.reverse a1 # => ["two", "bar", "foo"] ;T;[o;= ;3I" overload;F;40;;;50;)I"reverse;T;IC;";T; @Èp;>0;!F;[;[;I";T;0;6i;[; @Èp;[;I"£Returns a new \Array with the elements of +self+ in reverse order. a = ['foo', 'bar', 'two'] a1 = a.reverse a1 # => ["two", "bar", "foo"] @overload reverse;T;0; @Èp;!F;"o;#;$T;%iÔ;&iÚ;'@k;(I"hstatic VALUE rb_ary_reverse_m(VALUE ary) { long len = RARRAY_LEN(ary); VALUE dup = rb_ary_new2(len); if (len > 0) { const VALUE *p1 = RARRAY_CONST_PTR_TRANSIENT(ary); VALUE *p2 = (VALUE *)RARRAY_CONST_PTR_TRANSIENT(dup) + len - 1; do *p2-- = *p1++; while (--len > 0); } ARY_SET_LEN(dup, RARRAY_LEN(ary)); return dup; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#reverse!;F;[;[[@kiÎ;T;: reverse!;0;[;{;IC;"bReverses +self+ in place: a = ['foo', 'bar', 'two'] a.reverse! # => ["two", "bar", "foo"] ;T;[o;= ;3I" overload;F;40;;;50;)I" reverse!;T;IC;";T; @Þp;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @Þp;[;I"@return [self];T;0;6i;[; @Þp;[;I"ƒReverses +self+ in place: a = ['foo', 'bar', 'two'] a.reverse! # => ["two", "bar", "foo"] @overload reverse! @return [self];T;0; @Þp;!F;"o;#;$T;%iÅ;&iË;'@k;(I"Tstatic VALUE rb_ary_reverse_bang(VALUE ary) { return rb_ary_reverse(ary); };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#rotate;F;[[@c0;[[@kin;T;:rotate;0;[;{;IC;"CReturns a new \Array formed from +self+ with elements rotated from one end to the other. When no argument given, returns a new \Array that is like +self+, except that the first element has been rotated to the last position: a = [:foo, 'bar', 2, 'bar'] a1 = a.rotate a1 # => ["bar", 2, "bar", :foo] When given a non-negative \Integer +count+, returns a new \Array with +count+ elements rotated from the beginning to the end: a = [:foo, 'bar', 2] a1 = a.rotate(2) a1 # => [2, :foo, "bar"] If +count+ is large, uses count % array.size as the count: a = [:foo, 'bar', 2] a1 = a.rotate(20) a1 # => [2, :foo, "bar"] If +count+ is zero, returns a copy of +self+, unmodified: a = [:foo, 'bar', 2] a1 = a.rotate(0) a1 # => [:foo, "bar", 2] When given a negative \Integer +count+, rotates in the opposite direction, from end to beginning: a = [:foo, 'bar', 2] a1 = a.rotate(-2) a1 # => ["bar", 2, :foo] If +count+ is small (far from zero), uses count % array.size as the count: a = [:foo, 'bar', 2] a1 = a.rotate(-5) a1 # => ["bar", 2, :foo] ;T;[o;= ;3I" overload;F;40;;;50;)I"rotate;T;IC;";T; @ùp;>0;!F;[;[;I";T;0;6i;[; @ùpo;= ;3I" overload;F;40;;;50;)I"rotate(count);T;IC;";T; @ùp;>0;!F;[;[;I";T;0;6i;[[I" count;T0; @ùp;[;I"nReturns a new \Array formed from +self+ with elements rotated from one end to the other. When no argument given, returns a new \Array that is like +self+, except that the first element has been rotated to the last position: a = [:foo, 'bar', 2, 'bar'] a1 = a.rotate a1 # => ["bar", 2, "bar", :foo] When given a non-negative \Integer +count+, returns a new \Array with +count+ elements rotated from the beginning to the end: a = [:foo, 'bar', 2] a1 = a.rotate(2) a1 # => [2, :foo, "bar"] If +count+ is large, uses count % array.size as the count: a = [:foo, 'bar', 2] a1 = a.rotate(20) a1 # => [2, :foo, "bar"] If +count+ is zero, returns a copy of +self+, unmodified: a = [:foo, 'bar', 2] a1 = a.rotate(0) a1 # => [:foo, "bar", 2] When given a negative \Integer +count+, rotates in the opposite direction, from end to beginning: a = [:foo, 'bar', 2] a1 = a.rotate(-2) a1 # => ["bar", 2, :foo] If +count+ is small (far from zero), uses count % array.size as the count: a = [:foo, 'bar', 2] a1 = a.rotate(-5) a1 # => ["bar", 2, :foo] @overload rotate @overload rotate(count);T;0; @ùp;!F;"o;#;$T;%iD;&ij;'@k;(I"ûstatic VALUE rb_ary_rotate_m(int argc, VALUE *argv, VALUE ary) { VALUE rotated; const VALUE *ptr; long len; long cnt = (rb_check_arity(argc, 0, 1) ? NUM2LONG(argv[0]) : 1); len = RARRAY_LEN(ary); rotated = rb_ary_new2(len); if (len > 0) { cnt = rotate_count(cnt, len); ptr = RARRAY_CONST_PTR_TRANSIENT(ary); len -= cnt; ary_memcpy(rotated, 0, len, ptr + cnt); ary_memcpy(rotated, len, cnt, ptr); } ARY_SET_LEN(rotated, RARRAY_LEN(ary)); return rotated; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#rotate!;F;[[@c0;[[@ki<;T;:rotate!;0;[;{;IC;"¹Rotates +self+ in place by moving elements from one end to the other; returns +self+. When no argument given, rotates the first element to the last position: a = [:foo, 'bar', 2, 'bar'] a.rotate! # => ["bar", 2, "bar", :foo] When given a non-negative \Integer +count+, rotates +count+ elements from the beginning to the end: a = [:foo, 'bar', 2] a.rotate!(2) a # => [2, :foo, "bar"] If +count+ is large, uses count % array.size as the count: a = [:foo, 'bar', 2] a.rotate!(20) a # => [2, :foo, "bar"] If +count+ is zero, returns +self+ unmodified: a = [:foo, 'bar', 2] a.rotate!(0) a # => [:foo, "bar", 2] When given a negative Integer +count+, rotates in the opposite direction, from end to beginning: a = [:foo, 'bar', 2] a.rotate!(-2) a # => ["bar", 2, :foo] If +count+ is small (far from zero), uses count % array.size as the count: a = [:foo, 'bar', 2] a.rotate!(-5) a # => ["bar", 2, :foo] ;T;[o;= ;3I" overload;F;40;;;50;)I"rotate!;T;IC;";T; @q;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @q;[;I"@return [self];T;0;6i;[; @qo;= ;3I" overload;F;40;;;50;)I"rotate!(count);T;IC;";T; @q;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @q;[;I"@return [self];T;0;6i;[[I" count;T0; @q;[;I"Rotates +self+ in place by moving elements from one end to the other; returns +self+. When no argument given, rotates the first element to the last position: a = [:foo, 'bar', 2, 'bar'] a.rotate! # => ["bar", 2, "bar", :foo] When given a non-negative \Integer +count+, rotates +count+ elements from the beginning to the end: a = [:foo, 'bar', 2] a.rotate!(2) a # => [2, :foo, "bar"] If +count+ is large, uses count % array.size as the count: a = [:foo, 'bar', 2] a.rotate!(20) a # => [2, :foo, "bar"] If +count+ is zero, returns +self+ unmodified: a = [:foo, 'bar', 2] a.rotate!(0) a # => [:foo, "bar", 2] When given a negative Integer +count+, rotates in the opposite direction, from end to beginning: a = [:foo, 'bar', 2] a.rotate!(-2) a # => ["bar", 2, :foo] If +count+ is small (far from zero), uses count % array.size as the count: a = [:foo, 'bar', 2] a.rotate!(-5) a # => ["bar", 2, :foo] @overload rotate! @return [self] @overload rotate!(count) @return [self];T;0; @q;!F;"o;#;$T;%i;&i:;'@k;(I"³static VALUE rb_ary_rotate_bang(int argc, VALUE *argv, VALUE ary) { long n = (rb_check_arity(argc, 0, 1) ? NUM2LONG(argv[0]) : 1); rb_ary_rotate(ary, n); return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#sort;F;[;[[@kiC ;T;;$;0;[;{;IC;"ÍReturns a new \Array whose elements are those from +self+, sorted. With no block, compares elements using operator <=> (see Comparable): a = 'abcde'.split('').shuffle a # => ["e", "b", "d", "a", "c"] a1 = a.sort a1 # => ["a", "b", "c", "d", "e"] With a block, calls the block with each element pair; for each element pair +a+ and +b+, the block should return an integer: - Negative when +b+ is to follow +a+. - Zero when +a+ and +b+ are equivalent. - Positive when +a+ is to follow +b+. Example: a = 'abcde'.split('').shuffle a # => ["e", "b", "d", "a", "c"] a1 = a.sort {|a, b| a <=> b } a1 # => ["a", "b", "c", "d", "e"] a2 = a.sort {|a, b| b <=> a } a2 # => ["e", "d", "c", "b", "a"] When the block returns zero, the order for +a+ and +b+ is indeterminate, and may be unstable: a = 'abcde'.split('').shuffle a # => ["e", "b", "d", "a", "c"] a1 = a.sort {|a, b| 0 } a1 # => ["c", "e", "b", "d", "a"] Related: Enumerable#sort_by. ;T;[o;= ;3I" overload;F;40;;$;50;)I" sort;T;IC;";T; @Eq;>0;!F;[;[;I";T;0;6i;[; @Eqo;= ;3I" overload;F;40;;$;50;)I" sort;T;IC;";T; @Eq;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"a;TI"b;T; @Eq;[;I"@yield [a, b];T;0;6i;[; @Eq;[;I"ýReturns a new \Array whose elements are those from +self+, sorted. With no block, compares elements using operator <=> (see Comparable): a = 'abcde'.split('').shuffle a # => ["e", "b", "d", "a", "c"] a1 = a.sort a1 # => ["a", "b", "c", "d", "e"] With a block, calls the block with each element pair; for each element pair +a+ and +b+, the block should return an integer: - Negative when +b+ is to follow +a+. - Zero when +a+ and +b+ are equivalent. - Positive when +a+ is to follow +b+. Example: a = 'abcde'.split('').shuffle a # => ["e", "b", "d", "a", "c"] a1 = a.sort {|a, b| a <=> b } a1 # => ["a", "b", "c", "d", "e"] a2 = a.sort {|a, b| b <=> a } a2 # => ["e", "d", "c", "b", "a"] When the block returns zero, the order for +a+ and +b+ is indeterminate, and may be unstable: a = 'abcde'.split('').shuffle a # => ["e", "b", "d", "a", "c"] a1 = a.sort {|a, b| 0 } a1 # => ["c", "e", "b", "d", "a"] Related: Enumerable#sort_by. @overload sort @overload sort @yield [a, b];T;0; @Eq;!F;"o;#;$T;%i ;&i@ ;'@k;(I"kVALUE rb_ary_sort(VALUE ary) { ary = rb_ary_dup(ary); rb_ary_sort_bang(ary); return ary; };T;)I" VALUE;T;*To;;F; ;;;;I"Array#sort!;F;[;[[@kiá;T;: sort!;0;[;{;IC;"‰Returns +self+ with its elements sorted in place. With no block, compares elements using operator <=> (see Comparable): a = 'abcde'.split('').shuffle a # => ["e", "b", "d", "a", "c"] a.sort! a # => ["a", "b", "c", "d", "e"] With a block, calls the block with each element pair; for each element pair +a+ and +b+, the block should return an integer: - Negative when +b+ is to follow +a+. - Zero when +a+ and +b+ are equivalent. - Positive when +a+ is to follow +b+. Example: a = 'abcde'.split('').shuffle a # => ["e", "b", "d", "a", "c"] a.sort! {|a, b| a <=> b } a # => ["a", "b", "c", "d", "e"] a.sort! {|a, b| b <=> a } a # => ["e", "d", "c", "b", "a"] When the block returns zero, the order for +a+ and +b+ is indeterminate, and may be unstable: a = 'abcde'.split('').shuffle a # => ["e", "b", "d", "a", "c"] a.sort! {|a, b| 0 } a # => ["d", "e", "c", "a", "b"] ;T;[o;= ;3I" overload;F;40;;;50;)I" sort!;T;IC;";T; @iq;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @iq;[;I"@return [self];T;0;6i;[; @iqo;= ;3I" overload;F;40;;;50;)I" sort!;T;IC;";T; @iq;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"a;TI"b;T; @iqo;2 ;3I"return;F;4I";T;0;5[I" self;T; @iq;[;I"!@yield [a, b] @return [self];T;0;6i;[; @iq;[;I"ÝReturns +self+ with its elements sorted in place. With no block, compares elements using operator <=> (see Comparable): a = 'abcde'.split('').shuffle a # => ["e", "b", "d", "a", "c"] a.sort! a # => ["a", "b", "c", "d", "e"] With a block, calls the block with each element pair; for each element pair +a+ and +b+, the block should return an integer: - Negative when +b+ is to follow +a+. - Zero when +a+ and +b+ are equivalent. - Positive when +a+ is to follow +b+. Example: a = 'abcde'.split('').shuffle a # => ["e", "b", "d", "a", "c"] a.sort! {|a, b| a <=> b } a # => ["a", "b", "c", "d", "e"] a.sort! {|a, b| b <=> a } a # => ["e", "d", "c", "b", "a"] When the block returns zero, the order for +a+ and +b+ is indeterminate, and may be unstable: a = 'abcde'.split('').shuffle a # => ["e", "b", "d", "a", "c"] a.sort! {|a, b| 0 } a # => ["d", "e", "c", "a", "b"] @overload sort! @return [self] @overload sort! @yield [a, b] @return [self];T;0; @iq;!F;"o;#;$T;%i½;&ià;'@k;(I"éVALUE rb_ary_sort_bang(VALUE ary) { rb_ary_modify(ary); assert(!ARY_SHARED_P(ary)); if (RARRAY_LEN(ary) > 1) { VALUE tmp = ary_make_substitution(ary); /* only ary refers tmp */ struct ary_sort_data data; long len = RARRAY_LEN(ary); RBASIC_CLEAR_CLASS(tmp); data.ary = tmp; data.cmp_opt.opt_methods = 0; data.cmp_opt.opt_inited = 0; RARRAY_PTR_USE(tmp, ptr, { ruby_qsort(ptr, len, sizeof(VALUE), rb_block_given_p()?sort_1:sort_2, &data); }); /* WB: no new reference */ rb_ary_modify(ary); if (ARY_EMBED_P(tmp)) { if (ARY_SHARED_P(ary)) { /* ary might be destructively operated in the given block */ rb_ary_unshare(ary); FL_SET_EMBED(ary); } ary_memcpy(ary, 0, ARY_EMBED_LEN(tmp), ARY_EMBED_PTR(tmp)); ARY_SET_LEN(ary, ARY_EMBED_LEN(tmp)); } else { if (!ARY_EMBED_P(ary) && ARY_HEAP_PTR(ary) == ARY_HEAP_PTR(tmp)) { FL_UNSET_SHARED(ary); ARY_SET_CAPA(ary, RARRAY_LEN(tmp)); } else { assert(!ARY_SHARED_P(tmp)); if (ARY_EMBED_P(ary)) { FL_UNSET_EMBED(ary); } else if (ARY_SHARED_P(ary)) { /* ary might be destructively operated in the given block */ rb_ary_unshare(ary); } else { ary_heap_free(ary); } ARY_SET_PTR(ary, ARY_HEAP_PTR(tmp)); ARY_SET_HEAP_LEN(ary, len); ARY_SET_CAPA(ary, ARY_HEAP_LEN(tmp)); } /* tmp was lost ownership for the ptr */ FL_UNSET(tmp, FL_FREEZE); FL_SET_EMBED(tmp); ARY_SET_EMBED_LEN(tmp, 0); FL_SET(tmp, FL_FREEZE); } /* tmp will be GC'ed. */ RBASIC_SET_CLASS_RAW(tmp, rb_cArray); /* rb_cArray must be marked */ } ary_verify(ary); return ary; };T;)I" VALUE;T;*To;;F; ;;;;I"Array#sort_by!;F;[;[[@ki ;T;: sort_by!;0;[;{;IC;"XSorts the elements of +self+ in place, using an ordering determined by the block; returns self. Calls the block with each successive element; sorts elements based on the values returned from the block. For duplicates returned by the block, the ordering is indeterminate, and may be unstable. This example sorts strings based on their sizes: a = ['aaaa', 'bbb', 'cc', 'd'] a.sort_by! {|element| element.size } a # => ["d", "cc", "bbb", "aaaa"] Returns a new \Enumerator if no block given: a = ['aaaa', 'bbb', 'cc', 'd'] a.sort_by! # => # ;T;[o;= ;3I" overload;F;40;;;50;)I" sort_by!;T;IC;";T; @—q;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @—qo;2 ;3I"return;F;4I";T;0;5[I" self;T; @—q;[;I"$@yield [element] @return [self];T;0;6i;[; @—qo;= ;3I" overload;F;40;;;50;)I" sort_by!;T;IC;";T; @—q;>0;!F;[;[;I";T;0;6i;[; @—q;[;I"¤Sorts the elements of +self+ in place, using an ordering determined by the block; returns self. Calls the block with each successive element; sorts elements based on the values returned from the block. For duplicates returned by the block, the ordering is indeterminate, and may be unstable. This example sorts strings based on their sizes: a = ['aaaa', 'bbb', 'cc', 'd'] a.sort_by! {|element| element.size } a # => ["d", "cc", "bbb", "aaaa"] Returns a new \Enumerator if no block given: a = ['aaaa', 'bbb', 'cc', 'd'] a.sort_by! # => # @overload sort_by! @yield [element] @return [self] @overload sort_by!;T;0; @—q;!F;"o;#;$T;%iò ;&i;'@k;(I"static VALUE rb_ary_sort_by_bang(VALUE ary) { VALUE sorted; RETURN_SIZED_ENUMERATOR(ary, 0, 0, ary_enum_length); rb_ary_modify(ary); sorted = rb_block_call(ary, rb_intern("sort_by"), 0, 0, sort_by_i, 0); rb_ary_replace(ary, sorted); return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#collect;F;[;[[@ki*;T;;0;0;[;{;IC;"ŽCalls the block, if given, with each element of +self+; returns a new \Array whose elements are the return values from the block: a = [:foo, 'bar', 2] a1 = a.map {|element| element.class } a1 # => [Symbol, String, Integer] Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2] a1 = a.map a1 # => # Array#collect is an alias for Array#map. ;T;[o;= ;3I" overload;F;40;;1;50;)I"map;T;IC;";T; @¿q;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @¿q;[;I"@yield [element];T;0;6i;[; @¿qo;= ;3I" overload;F;40;;1;50;)I"map;T;IC;";T; @¿q;>0;!F;[;[;I";T;0;6i;[; @¿q;[;I"¿Calls the block, if given, with each element of +self+; returns a new \Array whose elements are the return values from the block: a = [:foo, 'bar', 2] a1 = a.map {|element| element.class } a1 # => [Symbol, String, Integer] Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2] a1 = a.map a1 # => # Array#collect is an alias for Array#map. @overload map @yield [element] @overload map;T;0; @¿q;!F;"o;#;$T;%i;&i';'@k;(I"2static VALUE rb_ary_collect(VALUE ary) { long i; VALUE collect; RETURN_SIZED_ENUMERATOR(ary, 0, 0, ary_enum_length); collect = rb_ary_new2(RARRAY_LEN(ary)); for (i = 0; i < RARRAY_LEN(ary); i++) { rb_ary_push(collect, rb_yield(RARRAY_AREF(ary, i))); } return collect; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#collect!;F;[;[[@kiK;T;: collect!;0;[;{;IC;"jCalls the block, if given, with each element; replaces the element with the block's return value: a = [:foo, 'bar', 2] a.map! { |element| element.class } # => [Symbol, String, Integer] Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2] a1 = a.map! a1 # => # Array#collect! is an alias for Array#map!. ;T;[o;= ;3I" overload;F;40;: map!;50;)I" map!;T;IC;";T; @âq;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @âqo;2 ;3I"return;F;4I";T;0;5[I" self;T; @âq;[;I"$@yield [element] @return [self];T;0;6i;[; @âqo;= ;3I" overload;F;40;;!;50;)I" map!;T;IC;";T; @âq;>0;!F;[;[;I";T;0;6i;[; @âq;[;I"®Calls the block, if given, with each element; replaces the element with the block's return value: a = [:foo, 'bar', 2] a.map! { |element| element.class } # => [Symbol, String, Integer] Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2] a1 = a.map! a1 # => # Array#collect! is an alias for Array#map!. @overload map! @yield [element] @return [self] @overload map!;T;0; @âq;!F;"o;#;$T;%i9;&iI;'@k;(I"static VALUE rb_ary_collect_bang(VALUE ary) { long i; RETURN_SIZED_ENUMERATOR(ary, 0, 0, ary_enum_length); rb_ary_modify(ary); for (i = 0; i < RARRAY_LEN(ary); i++) { rb_ary_store(ary, i, rb_yield(RARRAY_AREF(ary, i))); } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#map;F;[;[[@ki*;T;;1;0;[;{;IC;"ŽCalls the block, if given, with each element of +self+; returns a new \Array whose elements are the return values from the block: a = [:foo, 'bar', 2] a1 = a.map {|element| element.class } a1 # => [Symbol, String, Integer] Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2] a1 = a.map a1 # => # Array#collect is an alias for Array#map. ;T;[o;= ;3I" overload;F;40;;1;50;)I"map;T;IC;";T; @ r;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @ r;[;I"@yield [element];T;0;6i;[; @ ro;= ;3I" overload;F;40;;1;50;)I"map;T;IC;";T; @ r;>0;!F;[;[;I";T;0;6i;[; @ r;[;@Þq;0; @ r;!F;"o;#;$T;%i;&i';'@k;(I"2static VALUE rb_ary_collect(VALUE ary) { long i; VALUE collect; RETURN_SIZED_ENUMERATOR(ary, 0, 0, ary_enum_length); collect = rb_ary_new2(RARRAY_LEN(ary)); for (i = 0; i < RARRAY_LEN(ary); i++) { rb_ary_push(collect, rb_yield(RARRAY_AREF(ary, i))); } return collect; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#map!;F;[;[[@kiK;T;;!;0;[;{;IC;"jCalls the block, if given, with each element; replaces the element with the block's return value: a = [:foo, 'bar', 2] a.map! { |element| element.class } # => [Symbol, String, Integer] Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2] a1 = a.map! a1 # => # Array#collect! is an alias for Array#map!. ;T;[o;= ;3I" overload;F;40;;!;50;)I" map!;T;IC;";T; @,r;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @,ro;2 ;3I"return;F;4I";T;0;5[I" self;T; @,r;[;I"$@yield [element] @return [self];T;0;6i;[; @,ro;= ;3I" overload;F;40;;!;50;)I" map!;T;IC;";T; @,r;>0;!F;[;[;I";T;0;6i;[; @,r;[;@r;0; @,r;!F;"o;#;$T;%i9;&iI;'@k;(I"static VALUE rb_ary_collect_bang(VALUE ary) { long i; RETURN_SIZED_ENUMERATOR(ary, 0, 0, ary_enum_length); rb_ary_modify(ary); for (i = 0; i < RARRAY_LEN(ary); i++) { rb_ary_store(ary, i, rb_yield(RARRAY_AREF(ary, i))); } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#select;F;[;[[@kiÐ;T;;¦;0;[;{;IC;"ÀCalls the block, if given, with each element of +self+; returns a new \Array containing those elements of +self+ for which the block returns a truthy value: a = [:foo, 'bar', 2, :bam] a1 = a.select {|element| element.to_s.start_with?('b') } a1 # => ["bar", :bam] Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2, :bam] a.select # => # Array#filter is an alias for Array#select. ;T;[o;= ;3I" overload;F;40;;¦;50;)I"select;T;IC;";T; @Sr;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @Sr;[;I"@yield [element];T;0;6i;[; @Sro;= ;3I" overload;F;40;;¦;50;)I"select;T;IC;";T; @Sr;>0;!F;[;[;I";T;0;6i;[; @Sr;[;I"÷Calls the block, if given, with each element of +self+; returns a new \Array containing those elements of +self+ for which the block returns a truthy value: a = [:foo, 'bar', 2, :bam] a1 = a.select {|element| element.to_s.start_with?('b') } a1 # => ["bar", :bam] Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2, :bam] a.select # => # Array#filter is an alias for Array#select. @overload select @yield [element] @overload select;T;0; @Sr;!F;"o;#;$T;%i½;&iÍ;'@k;(I"Ostatic VALUE rb_ary_select(VALUE ary) { VALUE result; long i; RETURN_SIZED_ENUMERATOR(ary, 0, 0, ary_enum_length); result = rb_ary_new2(RARRAY_LEN(ary)); for (i = 0; i < RARRAY_LEN(ary); i++) { if (RTEST(rb_yield(RARRAY_AREF(ary, i)))) { rb_ary_push(result, rb_ary_elt(ary, i)); } } return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#select!;F;[;[[@ki";T;;À;0;[;{;IC;"Calls the block, if given with each element of +self+; removes from +self+ those elements for which the block returns +false+ or +nil+. Returns +self+ if any elements were removed: a = [:foo, 'bar', 2, :bam] a.select! {|element| element.to_s.start_with?('b') } # => ["bar", :bam] Returns +nil+ if no elements were removed. Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2, :bam] a.select! # => # Array#filter! is an alias for Array#select!. ;T;[o;= ;3I" overload;F;40;;À;50;)I"select!;T;IC;";T; @vr;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @vro;2 ;3I"return;F;4I";T;0;5[I" self;TI"nil;T; @vr;[;I")@yield [element] @return [self, nil];T;0;6i;[; @vro;= ;3I" overload;F;40;;À;50;)I"select!;T;IC;";T; @vr;>0;!F;[;[;I";T;0;6i;[; @vr;[;I"PCalls the block, if given with each element of +self+; removes from +self+ those elements for which the block returns +false+ or +nil+. Returns +self+ if any elements were removed: a = [:foo, 'bar', 2, :bam] a.select! {|element| element.to_s.start_with?('b') } # => ["bar", :bam] Returns +nil+ if no elements were removed. Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2, :bam] a.select! # => # Array#filter! is an alias for Array#select!. @overload select! @yield [element] @return [self, nil] @overload select!;T;0; @vr;!F;"o;#;$T;%i ;&i ;'@k;(I".static VALUE rb_ary_select_bang(VALUE ary) { struct select_bang_arg args; RETURN_SIZED_ENUMERATOR(ary, 0, 0, ary_enum_length); rb_ary_modify(ary); args.ary = ary; args.len[0] = args.len[1] = 0; return rb_ensure(select_bang_i, (VALUE)&args, select_bang_ensure, (VALUE)&args); };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#filter;F;[;[[@kiÐ;T;;-;0;[;{;IC;"ÀCalls the block, if given, with each element of +self+; returns a new \Array containing those elements of +self+ for which the block returns a truthy value: a = [:foo, 'bar', 2, :bam] a1 = a.select {|element| element.to_s.start_with?('b') } a1 # => ["bar", :bam] Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2, :bam] a.select # => # Array#filter is an alias for Array#select. ;T;[o;= ;3I" overload;F;40;;¦;50;)I"select;T;IC;";T; @Ÿr;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @Ÿr;[;I"@yield [element];T;0;6i;[; @Ÿro;= ;3I" overload;F;40;;¦;50;)I"select;T;IC;";T; @Ÿr;>0;!F;[;[;I";T;0;6i;[; @Ÿr;[;@rr;0; @Ÿr;!F;"o;#;$T;%i½;&iÍ;'@k;(I"Ostatic VALUE rb_ary_select(VALUE ary) { VALUE result; long i; RETURN_SIZED_ENUMERATOR(ary, 0, 0, ary_enum_length); result = rb_ary_new2(RARRAY_LEN(ary)); for (i = 0; i < RARRAY_LEN(ary); i++) { if (RTEST(rb_yield(RARRAY_AREF(ary, i)))) { rb_ary_push(result, rb_ary_elt(ary, i)); } } return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#filter!;F;[;[[@ki";T;;Á;0;[;{;IC;"Calls the block, if given with each element of +self+; removes from +self+ those elements for which the block returns +false+ or +nil+. Returns +self+ if any elements were removed: a = [:foo, 'bar', 2, :bam] a.select! {|element| element.to_s.start_with?('b') } # => ["bar", :bam] Returns +nil+ if no elements were removed. Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2, :bam] a.select! # => # Array#filter! is an alias for Array#select!. ;T;[o;= ;3I" overload;F;40;;À;50;)I"select!;T;IC;";T; @Ár;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @Áro;2 ;3I"return;F;4I";T;0;5[I" self;TI"nil;T; @Ár;[;I")@yield [element] @return [self, nil];T;0;6i;[; @Áro;= ;3I" overload;F;40;;À;50;)I"select!;T;IC;";T; @Ár;>0;!F;[;[;I";T;0;6i;[; @Ár;[;@›r;0; @Ár;!F;"o;#;$T;%i ;&i ;'@k;(I".static VALUE rb_ary_select_bang(VALUE ary) { struct select_bang_arg args; RETURN_SIZED_ENUMERATOR(ary, 0, 0, ary_enum_length); rb_ary_modify(ary); args.ary = ary; args.len[0] = args.len[1] = 0; return rb_ensure(select_bang_i, (VALUE)&args, select_bang_ensure, (VALUE)&args); };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#keep_if;F;[;[[@ki>;T;;¿;0;[;{;IC;"_Retains those elements for which the block returns a truthy value; deletes all other elements; returns +self+: a = [:foo, 'bar', 2, :bam] a.keep_if {|element| element.to_s.start_with?('b') } # => ["bar", :bam] Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2, :bam] a.keep_if # => # ;T;[o;= ;3I" overload;F;40;;¿;50;)I"keep_if;T;IC;";T; @ér;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @éro;2 ;3I"return;F;4I";T;0;5[I" self;T; @ér;[;I"$@yield [element] @return [self];T;0;6i;[; @éro;= ;3I" overload;F;40;;¿;50;)I"keep_if;T;IC;";T; @ér;>0;!F;[;[;I";T;0;6i;[; @ér;[;I"©Retains those elements for which the block returns a truthy value; deletes all other elements; returns +self+: a = [:foo, 'bar', 2, :bam] a.keep_if {|element| element.to_s.start_with?('b') } # => ["bar", :bam] Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2, :bam] a.keep_if # => # @overload keep_if @yield [element] @return [self] @overload keep_if;T;0; @ér;!F;"o;#;$T;%i/;&i<;'@k;(I"static VALUE rb_ary_keep_if(VALUE ary) { RETURN_SIZED_ENUMERATOR(ary, 0, 0, ary_enum_length); rb_ary_select_bang(ary); return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#values_at;F;[[@c0;[[@ki°;T;;º;0;[;{;IC;"§Returns a new \Array whose elements are the elements of +self+ at the given \Integer +indexes+. For each positive +index+, returns the element at offset +index+: a = [:foo, 'bar', 2] a.values_at(0, 2) # => [:foo, 2] The given +indexes+ may be in any order, and may repeat: a = [:foo, 'bar', 2] a.values_at(2, 0, 1, 0, 2) # => [2, :foo, "bar", :foo, 2] Assigns +nil+ for an +index+ that is too large: a = [:foo, 'bar', 2] a.values_at(0, 3, 1, 3) # => [:foo, nil, "bar", nil] Returns a new empty \Array if no arguments given. For each negative +index+, counts backward from the end of the array: a = [:foo, 'bar', 2] a.values_at(-1, -3) # => [2, :foo] Assigns +nil+ for an +index+ that is too small: a = [:foo, 'bar', 2] a.values_at(0, -5, 1, -6, 2) # => [:foo, nil, "bar", nil, 2] The given +indexes+ may have a mixture of signs: a = [:foo, 'bar', 2] a.values_at(0, -2, 1, -1) # => [:foo, "bar", "bar", 2] ;T;[o;= ;3I" overload;F;40;;º;50;)I"values_at(*indexes);T;IC;";T; @s;>0;!F;[;[;I";T;0;6i;[[I" *indexes;T0; @s;[;I"ÇReturns a new \Array whose elements are the elements of +self+ at the given \Integer +indexes+. For each positive +index+, returns the element at offset +index+: a = [:foo, 'bar', 2] a.values_at(0, 2) # => [:foo, 2] The given +indexes+ may be in any order, and may repeat: a = [:foo, 'bar', 2] a.values_at(2, 0, 1, 0, 2) # => [2, :foo, "bar", :foo, 2] Assigns +nil+ for an +index+ that is too large: a = [:foo, 'bar', 2] a.values_at(0, 3, 1, 3) # => [:foo, nil, "bar", nil] Returns a new empty \Array if no arguments given. For each negative +index+, counts backward from the end of the array: a = [:foo, 'bar', 2] a.values_at(-1, -3) # => [2, :foo] Assigns +nil+ for an +index+ that is too small: a = [:foo, 'bar', 2] a.values_at(0, -5, 1, -6, 2) # => [:foo, nil, "bar", nil, 2] The given +indexes+ may have a mixture of signs: a = [:foo, 'bar', 2] a.values_at(0, -2, 1, -1) # => [:foo, "bar", "bar", 2] @overload values_at(*indexes);T;0; @s;!F;"o;#;$T;%iŽ;&i¬;'@k;(I"static VALUE rb_ary_values_at(int argc, VALUE *argv, VALUE ary) { long i, olen = RARRAY_LEN(ary); VALUE result = rb_ary_new_capa(argc); for (i = 0; i < argc; ++i) { append_values_at_single(result, ary, olen, argv[i]); } RB_GC_GUARD(ary); return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#delete;F;[[I" item;T0;[[@kis;T;;½;0;[;{;IC;"Removes zero or more elements from +self+; returns +self+. When no block is given, removes from +self+ each element +ele+ such that ele == obj; returns the last deleted element: s1 = 'bar'; s2 = 'bar' a = [:foo, s1, 2, s2] a.delete('bar') # => "bar" a # => [:foo, 2] Returns +nil+ if no elements removed. When a block is given, removes from +self+ each element +ele+ such that ele == obj. If any such elements are found, ignores the block and returns the last deleted element: s1 = 'bar'; s2 = 'bar' a = [:foo, s1, 2, s2] deleted_obj = a.delete('bar') {|obj| fail 'Cannot happen' } a # => [:foo, 2] If no such elements are found, returns the block's return value: a = [:foo, 'bar', 2] a.delete(:nosuch) {|obj| "#{obj} not found" } # => "nosuch not found" ;T;[o;= ;3I" overload;F;40;;½;50;)I"delete(obj);T;IC;";T; @*s;>0;!F;[;[;I";T;0;6i;[[I"obj;T0; @*so;= ;3I" overload;F;40;;½;50;)I"delete(obj);T;IC;";T; @*s;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"nosuch;T; @*s;[;I"@yield [nosuch];T;0;6i;[[I"obj;T0; @*s;[;I"]Removes zero or more elements from +self+; returns +self+. When no block is given, removes from +self+ each element +ele+ such that ele == obj; returns the last deleted element: s1 = 'bar'; s2 = 'bar' a = [:foo, s1, 2, s2] a.delete('bar') # => "bar" a # => [:foo, 2] Returns +nil+ if no elements removed. When a block is given, removes from +self+ each element +ele+ such that ele == obj. If any such elements are found, ignores the block and returns the last deleted element: s1 = 'bar'; s2 = 'bar' a = [:foo, s1, 2, s2] deleted_obj = a.delete('bar') {|obj| fail 'Cannot happen' } a # => [:foo, 2] If no such elements are found, returns the block's return value: a = [:foo, 'bar', 2] a.delete(:nosuch) {|obj| "#{obj} not found" } # => "nosuch not found" @overload delete(obj) @overload delete(obj) @yield [nosuch];T;0; @*s;!F;"o;#;$T;%iS;&ip;'@k;(I"×VALUE rb_ary_delete(VALUE ary, VALUE item) { VALUE v = item; long i1, i2; for (i1 = i2 = 0; i1 < RARRAY_LEN(ary); i1++) { VALUE e = RARRAY_AREF(ary, i1); if (rb_equal(e, item)) { v = e; continue; } if (i1 != i2) { rb_ary_store(ary, i2, e); } i2++; } if (RARRAY_LEN(ary) == i2) { if (rb_block_given_p()) { return rb_yield(item); } return Qnil; } ary_resize_smaller(ary, i2); ary_verify(ary); return v; };T;)I" VALUE;T;*To;;F; ;;;;I"Array#delete_at;F;[[I"pos;T0;[[@kiÔ;T;:delete_at;0;[;{;IC;"¶Deletes an element from +self+, per the given \Integer +index+. When +index+ is non-negative, deletes the element at offset +index+: a = [:foo, 'bar', 2] a.delete_at(1) # => "bar" a # => [:foo, 2] If index is too large, returns +nil+. When +index+ is negative, counts backward from the end of the array: a = [:foo, 'bar', 2] a.delete_at(-2) # => "bar" a # => [:foo, 2] If +index+ is too small (far from zero), returns nil. ;T;[o;= ;3I" overload;F;40;;";50;)I"delete_at(index);T;IC;";T; @Ss;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @Ss;[;I"@return [nil];T;0;6i;[[I" index;T0; @Ss;[;I"ãDeletes an element from +self+, per the given \Integer +index+. When +index+ is non-negative, deletes the element at offset +index+: a = [:foo, 'bar', 2] a.delete_at(1) # => "bar" a # => [:foo, 2] If index is too large, returns +nil+. When +index+ is negative, counts backward from the end of the array: a = [:foo, 'bar', 2] a.delete_at(-2) # => "bar" a # => [:foo, 2] If +index+ is too small (far from zero), returns nil. @overload delete_at(index) @return [nil];T;0; @Ss;!F;"o;#;$T;%i¿;&iÑ;'@k;(I"ostatic VALUE rb_ary_delete_at_m(VALUE ary, VALUE pos) { return rb_ary_delete_at(ary, NUM2LONG(pos)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#delete_if;F;[;[[@kiÅ;T;;¾;0;[;{;IC;"BRemoves each element in +self+ for which the block returns a truthy value; returns +self+: a = [:foo, 'bar', 2, 'bat'] a.delete_if {|element| element.to_s.start_with?('b') } # => [:foo, 2] Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2] a.delete_if # => # ;T;[o;= ;3I" overload;F;40;;¾;50;)I"delete_if;T;IC;";T; @rs;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @rso;2 ;3I"return;F;4I";T;0;5[I" self;T; @rs;[;I"$@yield [element] @return [self];T;0;6i;[; @rso;= ;3I" overload;F;40;;¾;50;)I"delete_if;T;IC;";T; @rs;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Enumerator;T; @rs;[;I"@return [Enumerator];T;0;6i;[; @rs;[;I"§Removes each element in +self+ for which the block returns a truthy value; returns +self+: a = [:foo, 'bar', 2, 'bat'] a.delete_if {|element| element.to_s.start_with?('b') } # => [:foo, 2] Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2] a.delete_if # => # @overload delete_if @yield [element] @return [self] @overload delete_if @return [Enumerator];T;0; @rs;!F;"o;#;$T;%i¶;&iÄ;'@k;(I"¤static VALUE rb_ary_delete_if(VALUE ary) { ary_verify(ary); RETURN_SIZED_ENUMERATOR(ary, 0, 0, ary_enum_length); ary_reject_bang(ary); return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#reject;F;[;[[@ki«;T;;/;0;[;{;IC;"VReturns a new \Array whose elements are all those from +self+ for which the block returns +false+ or +nil+: a = [:foo, 'bar', 2, 'bat'] a1 = a.reject {|element| element.to_s.start_with?('b') } a1 # => [:foo, 2] Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2] a.reject # => # ;T;[o;= ;3I" overload;F;40;;/;50;)I"reject;T;IC;";T; @Ÿs;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @Ÿs;[;I"@yield [element];T;0;6i;[; @Ÿso;= ;3I" overload;F;40;;/;50;)I"reject;T;IC;";T; @Ÿs;>0;!F;[;[;I";T;0;6i;[; @Ÿs;[;I"Returns a new \Array whose elements are all those from +self+ for which the block returns +false+ or +nil+: a = [:foo, 'bar', 2, 'bat'] a1 = a.reject {|element| element.to_s.start_with?('b') } a1 # => [:foo, 2] Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2] a.reject # => # @overload reject @yield [element] @overload reject;T;0; @Ÿs;!F;"o;#;$T;%i›;&i¨;'@k;(I"Østatic VALUE rb_ary_reject(VALUE ary) { VALUE rejected_ary; RETURN_SIZED_ENUMERATOR(ary, 0, 0, ary_enum_length); rejected_ary = rb_ary_new(); ary_reject(ary, rejected_ary); return rejected_ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#reject!;F;[;[[@ki“;T;;Â;0;[;{;IC;"rRemoves each element for which the block returns a truthy value. Returns +self+ if any elements removed: a = [:foo, 'bar', 2, 'bat'] a.reject! {|element| element.to_s.start_with?('b') } # => [:foo, 2] Returns +nil+ if no elements removed. Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2] a.reject! # => # ;T;[o;= ;3I" overload;F;40;;Â;50;)I"reject!;T;IC;";T; @Âs;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @Âso;2 ;3I"return;F;4I";T;0;5[I" self;TI"nil;T; @Âs;[;I")@yield [element] @return [self, nil];T;0;6i;[; @Âso;= ;3I" overload;F;40;;Â;50;)I"reject!;T;IC;";T; @Âs;>0;!F;[;[;I";T;0;6i;[; @Âs;[;I"ÁRemoves each element for which the block returns a truthy value. Returns +self+ if any elements removed: a = [:foo, 'bar', 2, 'bat'] a.reject! {|element| element.to_s.start_with?('b') } # => [:foo, 2] Returns +nil+ if no elements removed. Returns a new \Enumerator if no block given: a = [:foo, 'bar', 2] a.reject! # => # @overload reject! @yield [element] @return [self, nil] @overload reject!;T;0; @Âs;!F;"o;#;$T;%i;&i‘;'@k;(I" static VALUE rb_ary_reject_bang(VALUE ary) { RETURN_SIZED_ENUMERATOR(ary, 0, 0, ary_enum_length); rb_ary_modify(ary); return ary_reject_bang(ary); };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#zip;F;[[@c0;[[@ki;T;;L;0;[;{;IC;"UWhen no block given, returns a new \Array +new_array+ of size self.size whose elements are Arrays. Each nested array new_array[n] is of size other_arrays.size+1, and contains: - The _nth_ element of +self+. - The _nth_ element of each of the +other_arrays+. If all +other_arrays+ and +self+ are the same size: a = [:a0, :a1, :a2, :a3] b = [:b0, :b1, :b2, :b3] c = [:c0, :c1, :c2, :c3] d = a.zip(b, c) d # => [[:a0, :b0, :c0], [:a1, :b1, :c1], [:a2, :b2, :c2], [:a3, :b3, :c3]] If any array in +other_arrays+ is smaller than +self+, fills to self.size with +nil+: a = [:a0, :a1, :a2, :a3] b = [:b0, :b1, :b2] c = [:c0, :c1] d = a.zip(b, c) d # => [[:a0, :b0, :c0], [:a1, :b1, :c1], [:a2, :b2, nil], [:a3, nil, nil]] If any array in +other_arrays+ is larger than +self+, its trailing elements are ignored: a = [:a0, :a1, :a2, :a3] b = [:b0, :b1, :b2, :b3, :b4] c = [:c0, :c1, :c2, :c3, :c4, :c5] d = a.zip(b, c) d # => [[:a0, :b0, :c0], [:a1, :b1, :c1], [:a2, :b2, :c2], [:a3, :b3, :c3]] When a block is given, calls the block with each of the sub-arrays (formed as above); returns nil a = [:a0, :a1, :a2, :a3] b = [:b0, :b1, :b2, :b3] c = [:c0, :c1, :c2, :c3] a.zip(b, c) {|sub_array| p sub_array} # => nil Output: [:a0, :b0, :c0] [:a1, :b1, :c1] [:a2, :b2, :c2] [:a3, :b3, :c3] ;T;[o;= ;3I" overload;F;40;;L;50;)I"zip(*other_arrays);T;IC;";T; @ës;>0;!F;[;[;I";T;0;6i;[[I"*other_arrays;T0; @ëso;= ;3I" overload;F;40;;L;50;)I"zip(*other_arrays);T;IC;";T; @ës;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"other_array;T; @ëso;2 ;3I"return;F;4I";T;0;5[I"nil;T; @ës;[;I"'@yield [other_array] @return [nil];T;0;6i;[[I"*other_arrays;T0; @ës;[;I"¸When no block given, returns a new \Array +new_array+ of size self.size whose elements are Arrays. Each nested array new_array[n] is of size other_arrays.size+1, and contains: - The _nth_ element of +self+. - The _nth_ element of each of the +other_arrays+. If all +other_arrays+ and +self+ are the same size: a = [:a0, :a1, :a2, :a3] b = [:b0, :b1, :b2, :b3] c = [:c0, :c1, :c2, :c3] d = a.zip(b, c) d # => [[:a0, :b0, :c0], [:a1, :b1, :c1], [:a2, :b2, :c2], [:a3, :b3, :c3]] If any array in +other_arrays+ is smaller than +self+, fills to self.size with +nil+: a = [:a0, :a1, :a2, :a3] b = [:b0, :b1, :b2] c = [:c0, :c1] d = a.zip(b, c) d # => [[:a0, :b0, :c0], [:a1, :b1, :c1], [:a2, :b2, nil], [:a3, nil, nil]] If any array in +other_arrays+ is larger than +self+, its trailing elements are ignored: a = [:a0, :a1, :a2, :a3] b = [:b0, :b1, :b2, :b3, :b4] c = [:c0, :c1, :c2, :c3, :c4, :c5] d = a.zip(b, c) d # => [[:a0, :b0, :c0], [:a1, :b1, :c1], [:a2, :b2, :c2], [:a3, :b3, :c3]] When a block is given, calls the block with each of the sub-arrays (formed as above); returns nil a = [:a0, :a1, :a2, :a3] b = [:b0, :b1, :b2, :b3] c = [:c0, :c1, :c2, :c3] a.zip(b, c) {|sub_array| p sub_array} # => nil Output: [:a0, :b0, :c0] [:a1, :b1, :c1] [:a2, :b2, :c2] [:a3, :b3, :c3] @overload zip(*other_arrays) @overload zip(*other_arrays) @yield [other_array] @return [nil];T;0; @ës;!F;"o;#;$T;%ié;&i;'@k;(I"Vstatic VALUE rb_ary_zip(int argc, VALUE *argv, VALUE ary) { int i, j; long len = RARRAY_LEN(ary); VALUE result = Qnil; for (i=0; i 1) { VALUE work, *tmp; tmp = ALLOCV_N(VALUE, work, argc+1); for (i=0; i [[:a0, :b0, :c0], [:a1, :b1, :c1]] ;T;[o;= ;3I" overload;F;40;;#;50;)I"transpose;T;IC;";T; @t;>0;!F;[;[;I";T;0;6i;[; @t;[;I"ÛTransposes the rows and columns in an \Array of Arrays; the nested Arrays must all be the same size: a = [[:a0, :a1], [:b0, :b1], [:c0, :c1]] a.transpose # => [[:a0, :b0, :c0], [:a1, :b1, :c1]] @overload transpose;T;0; @t;!F;"o;#;$T;%iT;&iZ;'@k;(I"±static VALUE rb_ary_transpose(VALUE ary) { long elen = -1, alen, i, j; VALUE tmp, result = 0; alen = RARRAY_LEN(ary); if (alen == 0) return rb_ary_dup(ary); for (i=0; i ["foo", :bar, 3] ;T;[o;= ;3I" overload;F;40;;¥;50;)I"replace(other_array);T;IC;";T; @.t;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @.t;[;I"@return [self];T;0;6i;[[I"other_array;T0; @.t;[;@šk;0; @.t;!F;"o;#;$T;%iz;&i€;'@k;(I"IVALUE rb_ary_replace(VALUE copy, VALUE orig) { rb_ary_modify_check(copy); orig = to_ary(orig); if (copy == orig) return copy; if (RARRAY_LEN(orig) <= RARRAY_EMBED_LEN_MAX) { VALUE shared_root = 0; if (ARY_OWNS_HEAP_P(copy)) { ary_heap_free(copy); } else if (ARY_SHARED_P(copy)) { shared_root = ARY_SHARED_ROOT(copy); FL_UNSET_SHARED(copy); } FL_SET_EMBED(copy); ary_memcpy(copy, 0, RARRAY_LEN(orig), RARRAY_CONST_PTR_TRANSIENT(orig)); if (shared_root) { rb_ary_decrement_share(shared_root); } ARY_SET_LEN(copy, RARRAY_LEN(orig)); } else { VALUE shared_root = ary_make_shared(orig); if (ARY_OWNS_HEAP_P(copy)) { ary_heap_free(copy); } else { rb_ary_unshare_safe(copy); } FL_UNSET_EMBED(copy); ARY_SET_PTR(copy, ARY_HEAP_PTR(orig)); ARY_SET_LEN(copy, ARY_HEAP_LEN(orig)); rb_ary_set_shared(copy, shared_root); } ary_verify(copy); return copy; };T;)I" VALUE;T;*To;;F; ;;;;I"Array#clear;F;[;[[@kiµ;T;;Å;0;[;{;IC;"ORemoves all elements from +self+: a = [:foo, 'bar', 2] a.clear # => [] ;T;[o;= ;3I" overload;F;40;;Å;50;)I" clear;T;IC;";T; @Lt;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @Lt;[;I"@return [self];T;0;6i;[; @Lt;[;I"rRemoves all elements from +self+: a = [:foo, 'bar', 2] a.clear # => [] @overload clear @return [self];T;0; @Lt;!F;"o;#;$T;%i¬;&i²;'@k;(I"¡VALUE rb_ary_clear(VALUE ary) { rb_ary_modify_check(ary); if (ARY_SHARED_P(ary)) { if (!ARY_EMBED_P(ary)) { rb_ary_unshare(ary); FL_SET_EMBED(ary); ARY_SET_EMBED_LEN(ary, 0); } } else { ARY_SET_LEN(ary, 0); if (ARY_DEFAULT_SIZE * 2 < ARY_CAPA(ary)) { ary_resize_capa(ary, ARY_DEFAULT_SIZE * 2); } } ary_verify(ary); return ary; };T;)I" VALUE;T;*To;;F; ;;;;I"Array#fill;F;[[@c0;[[@kis;T;: fill;0;[;{;IC;"ÚReplaces specified elements in +self+ with specified objects; returns +self+. With argument +obj+ and no block given, replaces all elements with that one object: a = ['a', 'b', 'c', 'd'] a # => ["a", "b", "c", "d"] a.fill(:X) # => [:X, :X, :X, :X] With arguments +obj+ and \Integer +start+, and no block given, replaces elements based on the given start. If +start+ is in range (0 <= start < array.size), replaces all elements from offset +start+ through the end: a = ['a', 'b', 'c', 'd'] a.fill(:X, 2) # => ["a", "b", :X, :X] If +start+ is too large (start >= array.size), does nothing: a = ['a', 'b', 'c', 'd'] a.fill(:X, 4) # => ["a", "b", "c", "d"] a = ['a', 'b', 'c', 'd'] a.fill(:X, 5) # => ["a", "b", "c", "d"] If +start+ is negative, counts from the end (starting index is start + array.size): a = ['a', 'b', 'c', 'd'] a.fill(:X, -2) # => ["a", "b", :X, :X] If +start+ is too small (less than and far from zero), replaces all elements: a = ['a', 'b', 'c', 'd'] a.fill(:X, -6) # => [:X, :X, :X, :X] a = ['a', 'b', 'c', 'd'] a.fill(:X, -50) # => [:X, :X, :X, :X] With arguments +obj+, \Integer +start+, and \Integer +length+, and no block given, replaces elements based on the given +start+ and +length+. If +start+ is in range, replaces +length+ elements beginning at offset +start+: a = ['a', 'b', 'c', 'd'] a.fill(:X, 1, 1) # => ["a", :X, "c", "d"] If +start+ is negative, counts from the end: a = ['a', 'b', 'c', 'd'] a.fill(:X, -2, 1) # => ["a", "b", :X, "d"] If +start+ is large (start >= array.size), extends +self+ with +nil+: a = ['a', 'b', 'c', 'd'] a.fill(:X, 5, 0) # => ["a", "b", "c", "d", nil] a = ['a', 'b', 'c', 'd'] a.fill(:X, 5, 2) # => ["a", "b", "c", "d", nil, :X, :X] If +length+ is zero or negative, replaces no elements: a = ['a', 'b', 'c', 'd'] a.fill(:X, 1, 0) # => ["a", "b", "c", "d"] a.fill(:X, 1, -1) # => ["a", "b", "c", "d"] With arguments +obj+ and \Range +range+, and no block given, replaces elements based on the given range. If the range is positive and ascending (0 < range.begin <= range.end), replaces elements from range.begin to range.end: a = ['a', 'b', 'c', 'd'] a.fill(:X, (1..1)) # => ["a", :X, "c", "d"] If range.first is negative, replaces no elements: a = ['a', 'b', 'c', 'd'] a.fill(:X, (-1..1)) # => ["a", "b", "c", "d"] If range.last is negative, counts from the end: a = ['a', 'b', 'c', 'd'] a.fill(:X, (0..-2)) # => [:X, :X, :X, "d"] a = ['a', 'b', 'c', 'd'] a.fill(:X, (1..-2)) # => ["a", :X, :X, "d"] If range.last and range.last are both negative, both count from the end of the array: a = ['a', 'b', 'c', 'd'] a.fill(:X, (-1..-1)) # => ["a", "b", "c", :X] a = ['a', 'b', 'c', 'd'] a.fill(:X, (-2..-2)) # => ["a", "b", :X, "d"] With no arguments and a block given, calls the block with each index; replaces the corresponding element with the block's return value: a = ['a', 'b', 'c', 'd'] a.fill { |index| "new_#{index}" } # => ["new_0", "new_1", "new_2", "new_3"] With argument +start+ and a block given, calls the block with each index from offset +start+ to the end; replaces the corresponding element with the block's return value: If start is in range (0 <= start < array.size), replaces from offset +start+ to the end: a = ['a', 'b', 'c', 'd'] a.fill(1) { |index| "new_#{index}" } # => ["a", "new_1", "new_2", "new_3"] If +start+ is too large(start >= array.size), does nothing: a = ['a', 'b', 'c', 'd'] a.fill(4) { |index| fail 'Cannot happen' } # => ["a", "b", "c", "d"] a = ['a', 'b', 'c', 'd'] a.fill(4) { |index| fail 'Cannot happen' } # => ["a", "b", "c", "d"] If +start+ is negative, counts from the end: a = ['a', 'b', 'c', 'd'] a.fill(-2) { |index| "new_#{index}" } # => ["a", "b", "new_2", "new_3"] If start is too small (start <= -array.size, replaces all elements: a = ['a', 'b', 'c', 'd'] a.fill(-6) { |index| "new_#{index}" } # => ["new_0", "new_1", "new_2", "new_3"] a = ['a', 'b', 'c', 'd'] a.fill(-50) { |index| "new_#{index}" } # => ["new_0", "new_1", "new_2", "new_3"] With arguments +start+ and +length+, and a block given, calls the block for each index specified by start length; replaces the corresponding element with the block's return value. If +start+ is in range, replaces +length+ elements beginning at offset +start+: a = ['a', 'b', 'c', 'd'] a.fill(1, 1) { |index| "new_#{index}" } # => ["a", "new_1", "c", "d"] If start is negative, counts from the end: a = ['a', 'b', 'c', 'd'] a.fill(-2, 1) { |index| "new_#{index}" } # => ["a", "b", "new_2", "d"] If +start+ is large (start >= array.size), extends +self+ with +nil+: a = ['a', 'b', 'c', 'd'] a.fill(5, 0) { |index| "new_#{index}" } # => ["a", "b", "c", "d", nil] a = ['a', 'b', 'c', 'd'] a.fill(5, 2) { |index| "new_#{index}" } # => ["a", "b", "c", "d", nil, "new_5", "new_6"] If +length+ is zero or less, replaces no elements: a = ['a', 'b', 'c', 'd'] a.fill(1, 0) { |index| "new_#{index}" } # => ["a", "b", "c", "d"] a.fill(1, -1) { |index| "new_#{index}" } # => ["a", "b", "c", "d"] With arguments +obj+ and +range+, and a block given, calls the block with each index in the given range; replaces the corresponding element with the block's return value. If the range is positive and ascending (range 0 < range.begin <= range.end, replaces elements from range.begin to range.end: a = ['a', 'b', 'c', 'd'] a.fill(1..1) { |index| "new_#{index}" } # => ["a", "new_1", "c", "d"] If +range.first+ is negative, does nothing: a = ['a', 'b', 'c', 'd'] a.fill(-1..1) { |index| fail 'Cannot happen' } # => ["a", "b", "c", "d"] If range.last is negative, counts from the end: a = ['a', 'b', 'c', 'd'] a.fill(0..-2) { |index| "new_#{index}" } # => ["new_0", "new_1", "new_2", "d"] a = ['a', 'b', 'c', 'd'] a.fill(1..-2) { |index| "new_#{index}" } # => ["a", "new_1", "new_2", "d"] If range.first and range.last are both negative, both count from the end: a = ['a', 'b', 'c', 'd'] a.fill(-1..-1) { |index| "new_#{index}" } # => ["a", "b", "c", "new_3"] a = ['a', 'b', 'c', 'd'] a.fill(-2..-2) { |index| "new_#{index}" } # => ["a", "b", "new_2", "d"] ;T;[ o;= ;3I" overload;F;40;;$;50;)I"fill(obj);T;IC;";T; @gt;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @gt;[;I"@return [self];T;0;6i;[[I"obj;T0; @gto;= ;3I" overload;F;40;;$;50;)I"fill(obj, start);T;IC;";T; @gt;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @gt;[;I"@return [self];T;0;6i;[[I"obj;T0[I" start;T0; @gto;= ;3I" overload;F;40;;$;50;)I"fill(obj, start, length);T;IC;";T; @gt;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @gt;[;I"@return [self];T;0;6i;[[I"obj;T0[I" start;T0[I"length;T0; @gto;= ;3I" overload;F;40;;$;50;)I"fill(obj, range);T;IC;";T; @gt;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @gt;[;I"@return [self];T;0;6i;[[I"obj;T0[I" range;T0; @gto;= ;3I" overload;F;40;;$;50;)I" fill;T;IC;";T; @gt;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" index;T; @gto;2 ;3I"return;F;4I";T;0;5[I" self;T; @gt;[;I""@yield [index] @return [self];T;0;6i;[; @gto;= ;3I" overload;F;40;;$;50;)I"fill(start);T;IC;";T; @gt;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" index;T; @gto;2 ;3I"return;F;4I";T;0;5[I" self;T; @gt;[;I""@yield [index] @return [self];T;0;6i;[[I" start;T0; @gto;= ;3I" overload;F;40;;$;50;)I"fill(start, length);T;IC;";T; @gt;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" index;T; @gto;2 ;3I"return;F;4I";T;0;5[I" self;T; @gt;[;I""@yield [index] @return [self];T;0;6i;[[I" start;T0[I"length;T0; @gto;= ;3I" overload;F;40;;$;50;)I"fill(range);T;IC;";T; @gt;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" index;T; @gto;2 ;3I"return;F;4I";T;0;5[I" self;T; @gt;[;I""@yield [index] @return [self];T;0;6i;[[I" range;T0; @gt;[;I"nReplaces specified elements in +self+ with specified objects; returns +self+. With argument +obj+ and no block given, replaces all elements with that one object: a = ['a', 'b', 'c', 'd'] a # => ["a", "b", "c", "d"] a.fill(:X) # => [:X, :X, :X, :X] With arguments +obj+ and \Integer +start+, and no block given, replaces elements based on the given start. If +start+ is in range (0 <= start < array.size), replaces all elements from offset +start+ through the end: a = ['a', 'b', 'c', 'd'] a.fill(:X, 2) # => ["a", "b", :X, :X] If +start+ is too large (start >= array.size), does nothing: a = ['a', 'b', 'c', 'd'] a.fill(:X, 4) # => ["a", "b", "c", "d"] a = ['a', 'b', 'c', 'd'] a.fill(:X, 5) # => ["a", "b", "c", "d"] If +start+ is negative, counts from the end (starting index is start + array.size): a = ['a', 'b', 'c', 'd'] a.fill(:X, -2) # => ["a", "b", :X, :X] If +start+ is too small (less than and far from zero), replaces all elements: a = ['a', 'b', 'c', 'd'] a.fill(:X, -6) # => [:X, :X, :X, :X] a = ['a', 'b', 'c', 'd'] a.fill(:X, -50) # => [:X, :X, :X, :X] With arguments +obj+, \Integer +start+, and \Integer +length+, and no block given, replaces elements based on the given +start+ and +length+. If +start+ is in range, replaces +length+ elements beginning at offset +start+: a = ['a', 'b', 'c', 'd'] a.fill(:X, 1, 1) # => ["a", :X, "c", "d"] If +start+ is negative, counts from the end: a = ['a', 'b', 'c', 'd'] a.fill(:X, -2, 1) # => ["a", "b", :X, "d"] If +start+ is large (start >= array.size), extends +self+ with +nil+: a = ['a', 'b', 'c', 'd'] a.fill(:X, 5, 0) # => ["a", "b", "c", "d", nil] a = ['a', 'b', 'c', 'd'] a.fill(:X, 5, 2) # => ["a", "b", "c", "d", nil, :X, :X] If +length+ is zero or negative, replaces no elements: a = ['a', 'b', 'c', 'd'] a.fill(:X, 1, 0) # => ["a", "b", "c", "d"] a.fill(:X, 1, -1) # => ["a", "b", "c", "d"] With arguments +obj+ and \Range +range+, and no block given, replaces elements based on the given range. If the range is positive and ascending (0 < range.begin <= range.end), replaces elements from range.begin to range.end: a = ['a', 'b', 'c', 'd'] a.fill(:X, (1..1)) # => ["a", :X, "c", "d"] If range.first is negative, replaces no elements: a = ['a', 'b', 'c', 'd'] a.fill(:X, (-1..1)) # => ["a", "b", "c", "d"] If range.last is negative, counts from the end: a = ['a', 'b', 'c', 'd'] a.fill(:X, (0..-2)) # => [:X, :X, :X, "d"] a = ['a', 'b', 'c', 'd'] a.fill(:X, (1..-2)) # => ["a", :X, :X, "d"] If range.last and range.last are both negative, both count from the end of the array: a = ['a', 'b', 'c', 'd'] a.fill(:X, (-1..-1)) # => ["a", "b", "c", :X] a = ['a', 'b', 'c', 'd'] a.fill(:X, (-2..-2)) # => ["a", "b", :X, "d"] With no arguments and a block given, calls the block with each index; replaces the corresponding element with the block's return value: a = ['a', 'b', 'c', 'd'] a.fill { |index| "new_#{index}" } # => ["new_0", "new_1", "new_2", "new_3"] With argument +start+ and a block given, calls the block with each index from offset +start+ to the end; replaces the corresponding element with the block's return value: If start is in range (0 <= start < array.size), replaces from offset +start+ to the end: a = ['a', 'b', 'c', 'd'] a.fill(1) { |index| "new_#{index}" } # => ["a", "new_1", "new_2", "new_3"] If +start+ is too large(start >= array.size), does nothing: a = ['a', 'b', 'c', 'd'] a.fill(4) { |index| fail 'Cannot happen' } # => ["a", "b", "c", "d"] a = ['a', 'b', 'c', 'd'] a.fill(4) { |index| fail 'Cannot happen' } # => ["a", "b", "c", "d"] If +start+ is negative, counts from the end: a = ['a', 'b', 'c', 'd'] a.fill(-2) { |index| "new_#{index}" } # => ["a", "b", "new_2", "new_3"] If start is too small (start <= -array.size, replaces all elements: a = ['a', 'b', 'c', 'd'] a.fill(-6) { |index| "new_#{index}" } # => ["new_0", "new_1", "new_2", "new_3"] a = ['a', 'b', 'c', 'd'] a.fill(-50) { |index| "new_#{index}" } # => ["new_0", "new_1", "new_2", "new_3"] With arguments +start+ and +length+, and a block given, calls the block for each index specified by start length; replaces the corresponding element with the block's return value. If +start+ is in range, replaces +length+ elements beginning at offset +start+: a = ['a', 'b', 'c', 'd'] a.fill(1, 1) { |index| "new_#{index}" } # => ["a", "new_1", "c", "d"] If start is negative, counts from the end: a = ['a', 'b', 'c', 'd'] a.fill(-2, 1) { |index| "new_#{index}" } # => ["a", "b", "new_2", "d"] If +start+ is large (start >= array.size), extends +self+ with +nil+: a = ['a', 'b', 'c', 'd'] a.fill(5, 0) { |index| "new_#{index}" } # => ["a", "b", "c", "d", nil] a = ['a', 'b', 'c', 'd'] a.fill(5, 2) { |index| "new_#{index}" } # => ["a", "b", "c", "d", nil, "new_5", "new_6"] If +length+ is zero or less, replaces no elements: a = ['a', 'b', 'c', 'd'] a.fill(1, 0) { |index| "new_#{index}" } # => ["a", "b", "c", "d"] a.fill(1, -1) { |index| "new_#{index}" } # => ["a", "b", "c", "d"] With arguments +obj+ and +range+, and a block given, calls the block with each index in the given range; replaces the corresponding element with the block's return value. If the range is positive and ascending (range 0 < range.begin <= range.end, replaces elements from range.begin to range.end: a = ['a', 'b', 'c', 'd'] a.fill(1..1) { |index| "new_#{index}" } # => ["a", "new_1", "c", "d"] If +range.first+ is negative, does nothing: a = ['a', 'b', 'c', 'd'] a.fill(-1..1) { |index| fail 'Cannot happen' } # => ["a", "b", "c", "d"] If range.last is negative, counts from the end: a = ['a', 'b', 'c', 'd'] a.fill(0..-2) { |index| "new_#{index}" } # => ["new_0", "new_1", "new_2", "d"] a = ['a', 'b', 'c', 'd'] a.fill(1..-2) { |index| "new_#{index}" } # => ["a", "new_1", "new_2", "d"] If range.first and range.last are both negative, both count from the end: a = ['a', 'b', 'c', 'd'] a.fill(-1..-1) { |index| "new_#{index}" } # => ["a", "b", "c", "new_3"] a = ['a', 'b', 'c', 'd'] a.fill(-2..-2) { |index| "new_#{index}" } # => ["a", "b", "new_2", "d"] @overload fill(obj) @return [self] @overload fill(obj, start) @return [self] @overload fill(obj, start, length) @return [self] @overload fill(obj, range) @return [self] @overload fill @yield [index] @return [self] @overload fill(start) @yield [index] @return [self] @overload fill(start, length) @yield [index] @return [self] @overload fill(range) @yield [index] @return [self];T;0; @gt;!F;"o;#;$T;%iÊ;&i{;'@k;(I"Cstatic VALUE rb_ary_fill(int argc, VALUE *argv, VALUE ary) { VALUE item = Qundef, arg1, arg2; long beg = 0, end = 0, len = 0; if (rb_block_given_p()) { rb_scan_args(argc, argv, "02", &arg1, &arg2); argc += 1; /* hackish */ } else { rb_scan_args(argc, argv, "12", &item, &arg1, &arg2); } switch (argc) { case 1: beg = 0; len = RARRAY_LEN(ary); break; case 2: if (rb_range_beg_len(arg1, &beg, &len, RARRAY_LEN(ary), 1)) { break; } /* fall through */ case 3: beg = NIL_P(arg1) ? 0 : NUM2LONG(arg1); if (beg < 0) { beg = RARRAY_LEN(ary) + beg; if (beg < 0) beg = 0; } len = NIL_P(arg2) ? RARRAY_LEN(ary) - beg : NUM2LONG(arg2); break; } rb_ary_modify(ary); if (len < 0) { return ary; } if (beg >= ARY_MAX_SIZE || len > ARY_MAX_SIZE - beg) { rb_raise(rb_eArgError, "argument too big"); } end = beg + len; if (RARRAY_LEN(ary) < end) { if (end >= ARY_CAPA(ary)) { ary_resize_capa(ary, end); } ary_mem_clear(ary, RARRAY_LEN(ary), end - RARRAY_LEN(ary)); ARY_SET_LEN(ary, end); } if (item == Qundef) { VALUE v; long i; for (i=beg; i=RARRAY_LEN(ary)) break; ARY_SET(ary, i, v); } } else { ary_memfill(ary, beg, len, item); } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#include?;F;[[I" item;T0;[[@ki;T;;E;0;[;{;IC;" Returns +true+ if for some index +i+ in +self+, obj == self[i]; otherwise +false+: [0, 1, 2].include?(2) # => true [0, 1, 2].include?(3) # => false;T;[o;= ;3I" overload;F;40;;E;50;)I"include?(obj);T;IC;";T; @ u;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ u;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @ u;[;I"ÎReturns +true+ if for some index +i+ in +self+, obj == self[i]; otherwise +false+: [0, 1, 2].include?(2) # => true [0, 1, 2].include?(3) # => false @overload include?(obj) @return [Boolean];T;0; @ u;!F;"o;#;$T;%iû;&i;6i;'@k;(I"ÕVALUE rb_ary_includes(VALUE ary, VALUE item) { long i; VALUE e; for (i=0; i;F;[[I" ary2;T0;[[@kiM;T;;c;0;[;{;IC;"[Returns -1, 0, or 1 as +self+ is less than, equal to, or greater than +other_array+. For each index +i+ in +self+, evaluates result = self[i] <=> other_array[i]. Returns -1 if any result is -1: [0, 1, 2] <=> [0, 1, 3] # => -1 Returns 1 if any result is 1: [0, 1, 2] <=> [0, 1, 1] # => 1 When all results are zero: - Returns -1 if +array+ is smaller than +other_array+: [0, 1, 2] <=> [0, 1, 2, 3] # => -1 - Returns 1 if +array+ is larger than +other_array+: [0, 1, 2] <=> [0, 1] # => 1 - Returns 0 if +array+ and +other_array+ are the same size: [0, 1, 2] <=> [0, 1, 2] # => 0 ;T;[o;= ;3I" overload;F;40;;c;50;)I"<=>(other_array);T;IC;";T; @)u;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"-1;TI"0;TI"1;T; @)u;[;I"@return [-1, 0, 1];T;0;6i;[[I"other_array;T0; @)u;[;I"ŽReturns -1, 0, or 1 as +self+ is less than, equal to, or greater than +other_array+. For each index +i+ in +self+, evaluates result = self[i] <=> other_array[i]. Returns -1 if any result is -1: [0, 1, 2] <=> [0, 1, 3] # => -1 Returns 1 if any result is 1: [0, 1, 2] <=> [0, 1, 1] # => 1 When all results are zero: - Returns -1 if +array+ is smaller than +other_array+: [0, 1, 2] <=> [0, 1, 2, 3] # => -1 - Returns 1 if +array+ is larger than +other_array+: [0, 1, 2] <=> [0, 1] # => 1 - Returns 0 if +array+ and +other_array+ are the same size: [0, 1, 2] <=> [0, 1, 2] # => 0 @overload <=>(other_array) @return [-1, 0, 1];T;0; @)u;!F;"o;#;$T;%i7;&iJ;'@k;(I"«VALUE rb_ary_cmp(VALUE ary1, VALUE ary2) { long len; VALUE v; ary2 = rb_check_array_type(ary2); if (NIL_P(ary2)) return Qnil; if (ary1 == ary2) return INT2FIX(0); v = rb_exec_recursive_paired(recursive_cmp, ary1, ary2, ary2); if (v != Qundef) return v; len = RARRAY_LEN(ary1) - RARRAY_LEN(ary2); if (len == 0) return INT2FIX(0); if (len > 0) return INT2FIX(1); return INT2FIX(-1); };T;)I" VALUE;T;*To;;F; ;;;;I"Array#slice;F;[[@c0;[[@ki ;T;;Ã;0;[;{;IC;"@ Returns elements from +self+; does not modify +self+. When a single \Integer argument +index+ is given, returns the element at offset +index+: a = [:foo, 'bar', 2] a[0] # => :foo a[2] # => 2 a # => [:foo, "bar", 2] If +index+ is negative, counts relative to the end of +self+: a = [:foo, 'bar', 2] a[-1] # => 2 a[-2] # => "bar" If +index+ is out of range, returns +nil+. When two \Integer arguments +start+ and +length+ are given, returns a new \Array of size +length+ containing successive elements beginning at offset +start+: a = [:foo, 'bar', 2] a[0, 2] # => [:foo, "bar"] a[1, 2] # => ["bar", 2] If start + length is greater than self.length, returns all elements from offset +start+ to the end: a = [:foo, 'bar', 2] a[0, 4] # => [:foo, "bar", 2] a[1, 3] # => ["bar", 2] a[2, 2] # => [2] If start == self.size and length >= 0, returns a new empty \Array. If +length+ is negative, returns +nil+. When a single \Range argument +range+ is given, treats range.min as +start+ above and range.size as +length+ above: a = [:foo, 'bar', 2] a[0..1] # => [:foo, "bar"] a[1..2] # => ["bar", 2] Special case: If range.start == a.size, returns a new empty \Array. If range.end is negative, calculates the end index from the end: a = [:foo, 'bar', 2] a[0..-1] # => [:foo, "bar", 2] a[0..-2] # => [:foo, "bar"] a[0..-3] # => [:foo] If range.start is negative, calculates the start index from the end: a = [:foo, 'bar', 2] a[-1..2] # => [2] a[-2..2] # => ["bar", 2] a[-3..2] # => [:foo, "bar", 2] If range.start is larger than the array size, returns +nil+. a = [:foo, 'bar', 2] a[4..1] # => nil a[4..0] # => nil a[4..-1] # => nil When a single Enumerator::ArithmeticSequence argument +aseq+ is given, returns an Array of elements corresponding to the indexes produced by the sequence. a = ['--', 'data1', '--', 'data2', '--', 'data3'] a[(1..).step(2)] # => ["data1", "data2", "data3"] Unlike slicing with range, if the start or the end of the arithmetic sequence is larger than array size, throws RangeError. a = ['--', 'data1', '--', 'data2', '--', 'data3'] a[(1..11).step(2)] # RangeError (((1..11).step(2)) out of range) a[(7..).step(2)] # RangeError (((7..).step(2)) out of range) If given a single argument, and its type is not one of the listed, tries to convert it to Integer, and raises if it is impossible: a = [:foo, 'bar', 2] # Raises TypeError (no implicit conversion of Symbol into Integer): a[:foo] Array#slice is an alias for Array#[]. ;T;[ o;= ;3I" overload;F;40;;Â;50;)I"[](index);T;IC;";T; @Ju;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @Ju;[;I"@return [Object, nil];T;0;6i;[[I" index;T0; @Juo;= ;3I" overload;F;40;;Â;50;)I"[](start, length);T;IC;";T; @Ju;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @Ju;[;I"@return [Object, nil];T;0;6i;[[I" start;T0[I"length;T0; @Juo;= ;3I" overload;F;40;;Â;50;)I"[](range);T;IC;";T; @Ju;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @Ju;[;I"@return [Object, nil];T;0;6i;[[I" range;T0; @Juo;= ;3I" overload;F;40;;Â;50;)I" [](aseq);T;IC;";T; @Ju;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @Ju;[;I"@return [Object, nil];T;0;6i;[[I" aseq;T0; @Juo;= ;3I" overload;F;40;;Ã;50;)I"slice(index);T;IC;";T; @Ju;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @Ju;[;I"@return [Object, nil];T;0;6i;[[I" index;T0; @Juo;= ;3I" overload;F;40;;Ã;50;)I"slice(start, length);T;IC;";T; @Ju;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @Ju;[;I"@return [Object, nil];T;0;6i;[[I" start;T0[I"length;T0; @Juo;= ;3I" overload;F;40;;Ã;50;)I"slice(range);T;IC;";T; @Ju;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @Ju;[;I"@return [Object, nil];T;0;6i;[[I" range;T0; @Juo;= ;3I" overload;F;40;;Ã;50;)I"slice(aseq);T;IC;";T; @Ju;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @Ju;[;I"@return [Object, nil];T;0;6i;[[I" aseq;T0; @Ju;[;@ýl;0; @Ju;!F;"o;#;$T;%i«;&i ;'@k;(I"ÌVALUE rb_ary_aref(int argc, const VALUE *argv, VALUE ary) { rb_check_arity(argc, 1, 2); if (argc == 2) { return rb_ary_aref2(ary, argv[0], argv[1]); } return rb_ary_aref1(ary, argv[0]); };T;)I" VALUE;T;*To;;F; ;;;;I"Array#slice!;F;[[@c0;[[@ki5;T;:slice!;0;[;{;IC;"GRemoves and returns elements from +self+. When the only argument is an \Integer +n+, removes and returns the _nth_ element in +self+: a = [:foo, 'bar', 2] a.slice!(1) # => "bar" a # => [:foo, 2] If +n+ is negative, counts backwards from the end of +self+: a = [:foo, 'bar', 2] a.slice!(-1) # => 2 a # => [:foo, "bar"] If +n+ is out of range, returns +nil+. When the only arguments are Integers +start+ and +length+, removes +length+ elements from +self+ beginning at offset +start+; returns the deleted objects in a new Array: a = [:foo, 'bar', 2] a.slice!(0, 2) # => [:foo, "bar"] a # => [2] If start + length exceeds the array size, removes and returns all elements from offset +start+ to the end: a = [:foo, 'bar', 2] a.slice!(1, 50) # => ["bar", 2] a # => [:foo] If start == a.size and +length+ is non-negative, returns a new empty \Array. If +length+ is negative, returns +nil+. When the only argument is a \Range object +range+, treats range.min as +start+ above and range.size as +length+ above: a = [:foo, 'bar', 2] a.slice!(1..2) # => ["bar", 2] a # => [:foo] If range.start == a.size, returns a new empty \Array. If range.start is larger than the array size, returns +nil+. If range.end is negative, counts backwards from the end of the array: a = [:foo, 'bar', 2] a.slice!(0..-2) # => [:foo, "bar"] a # => [2] If range.start is negative, calculates the start index backwards from the end of the array: a = [:foo, 'bar', 2] a.slice!(-2..2) # => ["bar", 2] a # => [:foo] ;T;[o;= ;3I" overload;F;40;;%;50;)I"slice!(n);T;IC;";T; @Üu;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @Üu;[;I"@return [Object, nil];T;0;6i;[[I"n;T0; @Üuo;= ;3I" overload;F;40;;%;50;)I"slice!(start, length);T;IC;";T; @Üu;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @Üu;[;I"@return [nil];T;0;6i;[[I" start;T0[I"length;T0; @Üuo;= ;3I" overload;F;40;;%;50;)I"slice!(range);T;IC;";T; @Üu;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @Üu;[;I"@return [nil];T;0;6i;[[I" range;T0; @Üu;[;I"ÍRemoves and returns elements from +self+. When the only argument is an \Integer +n+, removes and returns the _nth_ element in +self+: a = [:foo, 'bar', 2] a.slice!(1) # => "bar" a # => [:foo, 2] If +n+ is negative, counts backwards from the end of +self+: a = [:foo, 'bar', 2] a.slice!(-1) # => 2 a # => [:foo, "bar"] If +n+ is out of range, returns +nil+. When the only arguments are Integers +start+ and +length+, removes +length+ elements from +self+ beginning at offset +start+; returns the deleted objects in a new Array: a = [:foo, 'bar', 2] a.slice!(0, 2) # => [:foo, "bar"] a # => [2] If start + length exceeds the array size, removes and returns all elements from offset +start+ to the end: a = [:foo, 'bar', 2] a.slice!(1, 50) # => ["bar", 2] a # => [:foo] If start == a.size and +length+ is non-negative, returns a new empty \Array. If +length+ is negative, returns +nil+. When the only argument is a \Range object +range+, treats range.min as +start+ above and range.size as +length+ above: a = [:foo, 'bar', 2] a.slice!(1..2) # => ["bar", 2] a # => [:foo] If range.start == a.size, returns a new empty \Array. If range.start is larger than the array size, returns +nil+. If range.end is negative, counts backwards from the end of the array: a = [:foo, 'bar', 2] a.slice!(0..-2) # => [:foo, "bar"] a # => [2] If range.start is negative, calculates the start index backwards from the end of the array: a = [:foo, 'bar', 2] a.slice!(-2..2) # => ["bar", 2] a # => [:foo] @overload slice!(n) @return [Object, nil] @overload slice!(start, length) @return [nil] @overload slice!(range) @return [nil];T;0; @Üu;!F;"o;#;$T;%iø;&i4;'@k;(I"µstatic VALUE rb_ary_slice_bang(int argc, VALUE *argv, VALUE ary) { VALUE arg1; long pos, len; rb_ary_modify_check(ary); rb_check_arity(argc, 1, 2); arg1 = argv[0]; if (argc == 2) { pos = NUM2LONG(argv[0]); len = NUM2LONG(argv[1]); return ary_slice_bang_by_rb_ary_splice(ary, pos, len); } if (!FIXNUM_P(arg1)) { switch (rb_range_beg_len(arg1, &pos, &len, RARRAY_LEN(ary), 0)) { case Qtrue: /* valid range */ return ary_slice_bang_by_rb_ary_splice(ary, pos, len); case Qnil: /* invalid range */ return Qnil; default: /* not a range */ break; } } return rb_ary_delete_at(ary, NUM2LONG(arg1)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#assoc;F;[[I"key;T0;[[@kiI;T;;Ê;0;[;{;IC;"ãReturns the first element in +self+ that is an \Array whose first element == +obj+: a = [{foo: 0}, [2, 4], [4, 5, 6], [4, 5]] a.assoc(4) # => [4, 5, 6] Returns +nil+ if no such element is found. Related: #rassoc. ;T;[o;= ;3I" overload;F;40;;Ê;50;)I"assoc(obj);T;IC;";T; @v;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @v;[;I"@return [nil];T;0;6i;[[I"obj;T0; @v;[;I" Returns the first element in +self+ that is an \Array whose first element == +obj+: a = [{foo: 0}, [2, 4], [4, 5, 6], [4, 5]] a.assoc(4) # => [4, 5, 6] Returns +nil+ if no such element is found. Related: #rassoc. @overload assoc(obj) @return [nil];T;0; @v;!F;"o;#;$T;%i;;&iF;'@k;(I"VALUE rb_ary_assoc(VALUE ary, VALUE key) { long i; VALUE v; for (i = 0; i < RARRAY_LEN(ary); ++i) { v = rb_check_array_type(RARRAY_AREF(ary, i)); if (!NIL_P(v) && RARRAY_LEN(v) > 0 && rb_equal(RARRAY_AREF(v, 0), key)) return v; } return Qnil; };T;)I" VALUE;T;*To;;F; ;;;;I"Array#rassoc;F;[[I" value;T0;[[@kif;T;;Ë;0;[;{;IC;"áReturns the first element in +self+ that is an \Array whose second element == +obj+: a = [{foo: 0}, [2, 4], [4, 5, 6], [4, 5]] a.rassoc(4) # => [2, 4] Returns +nil+ if no such element is found. Related: #assoc. ;T;[o;= ;3I" overload;F;40;;Ë;50;)I"rassoc(obj);T;IC;";T; @:v;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @:v;[;I"@return [nil];T;0;6i;[[I"obj;T0; @:v;[;I" Returns the first element in +self+ that is an \Array whose second element == +obj+: a = [{foo: 0}, [2, 4], [4, 5, 6], [4, 5]] a.rassoc(4) # => [2, 4] Returns +nil+ if no such element is found. Related: #assoc. @overload rassoc(obj) @return [nil];T;0; @:v;!F;"o;#;$T;%iX;⁣'@k;(I"VALUE rb_ary_rassoc(VALUE ary, VALUE value) { long i; VALUE v; for (i = 0; i < RARRAY_LEN(ary); ++i) { v = RARRAY_AREF(ary, i); if (RB_TYPE_P(v, T_ARRAY) && RARRAY_LEN(v) > 1 && rb_equal(RARRAY_AREF(v, 1), value)) return v; } return Qnil; };T;)I" VALUE;T;*To;;F; ;;;;I"Array#+;F;[[I"y;T0;[[@ki¿;T;:+;0;[;{;IC;"¡Returns a new \Array containing all elements of +array+ followed by all elements of +other_array+: a = [0, 1] + [2, 3] a # => [0, 1, 2, 3] Related: #concat. ;T;[o;= ;3I" overload;F;40;;&;50;)I"+(other_array);T;IC;";T; @Yv;>0;!F;[;[;I";T;0;6i;[[I"other_array;T0; @Yv;[;I"¼Returns a new \Array containing all elements of +array+ followed by all elements of +other_array+: a = [0, 1] + [2, 3] a # => [0, 1, 2, 3] Related: #concat. @overload +(other_array);T;0; @Yv;!F;"o;#;$T;%i³;&i»;'@k;(I"hVALUE rb_ary_plus(VALUE x, VALUE y) { VALUE z; long len, xlen, ylen; y = to_ary(y); xlen = RARRAY_LEN(x); ylen = RARRAY_LEN(y); len = xlen + ylen; z = rb_ary_new2(len); ary_memcpy(z, 0, xlen, RARRAY_CONST_PTR_TRANSIENT(x)); ary_memcpy(z, xlen, ylen, RARRAY_CONST_PTR_TRANSIENT(y)); ARY_SET_LEN(z, len); return z; };T;)I" VALUE;T;*To;;F; ;;;;I"Array#*;F;[[I" times;T0;[[@ki;T;:*;0;[;{;IC;"VWhen non-negative argument \Integer +n+ is given, returns a new \Array built by concatenating the +n+ copies of +self+: a = ['x', 'y'] a * 3 # => ["x", "y", "x", "y", "x", "y"] When \String argument +string_separator+ is given, equivalent to array.join(string_separator): [0, [0, 1], {foo: 0}] * ', ' # => "0, 0, 1, {:foo=>0}" ;T;[o;= ;3I" overload;F;40;;';50;)I" *(n);T;IC;";T; @sv;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @svo;= ;3I" overload;F;40;;';50;)I"*(string_separator);T;IC;";T; @sv;>0;!F;[;[;I";T;0;6i;[[I"string_separator;T0; @sv;[;I"…When non-negative argument \Integer +n+ is given, returns a new \Array built by concatenating the +n+ copies of +self+: a = ['x', 'y'] a * 3 # => ["x", "y", "x", "y", "x", "y"] When \String argument +string_separator+ is given, equivalent to array.join(string_separator): [0, [0, 1], {foo: 0}] * ', ' # => "0, 0, 1, {:foo=>0}" @overload *(n) @overload *(string_separator);T;0; @sv;!F;"o;#;$T;%i;&i;'@k;(I"¸static VALUE rb_ary_times(VALUE ary, VALUE times) { VALUE ary2, tmp; const VALUE *ptr; long t, len; tmp = rb_check_string_type(times); if (!NIL_P(tmp)) { return rb_ary_join(ary, tmp); } len = NUM2LONG(times); if (len == 0) { ary2 = ary_new(rb_cArray, 0); goto out; } if (len < 0) { rb_raise(rb_eArgError, "negative argument"); } if (ARY_MAX_SIZE/len < RARRAY_LEN(ary)) { rb_raise(rb_eArgError, "argument too big"); } len *= RARRAY_LEN(ary); ary2 = ary_new(rb_cArray, len); ARY_SET_LEN(ary2, len); ptr = RARRAY_CONST_PTR_TRANSIENT(ary); t = RARRAY_LEN(ary); if (0 < t) { ary_memcpy(ary2, 0, t, ptr); while (t <= len/2) { ary_memcpy(ary2, t, t, RARRAY_CONST_PTR_TRANSIENT(ary2)); t *= 2; } if (t < len) { ary_memcpy(ary2, t, len-t, RARRAY_CONST_PTR_TRANSIENT(ary2)); } } out: return ary2; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#-;F;[[I" ary2;T0;[[@ki¨;T;;;0;[;{;IC;"MReturns a new \Array containing only those elements from +array+ that are not found in \Array +other_array+; items are compared using eql?; the order from +array+ is preserved: [0, 1, 1, 2, 1, 1, 3, 1, 1] - [1] # => [0, 2, 3] [0, 1, 2, 3] - [3, 0] # => [1, 2] [0, 1, 2] - [4] # => [0, 1, 2] Related: Array#difference. ;T;[o;= ;3I" overload;F;40;;;50;)I"-(other_array);T;IC;";T; @—v;>0;!F;[;[;I";T;0;6i;[[I"other_array;T0; @—v;[;I"hReturns a new \Array containing only those elements from +array+ that are not found in \Array +other_array+; items are compared using eql?; the order from +array+ is preserved: [0, 1, 1, 2, 1, 1, 3, 1, 1] - [1] # => [0, 2, 3] [0, 1, 2, 3] - [3, 0] # => [1, 2] [0, 1, 2] - [4] # => [0, 1, 2] Related: Array#difference. @overload -(other_array);T;0; @—v;!F;"o;#;$T;%i™;&i¤;'@k;(I"•static VALUE rb_ary_diff(VALUE ary1, VALUE ary2) { VALUE ary3; VALUE hash; long i; ary2 = to_ary(ary2); ary3 = rb_ary_new(); if (RARRAY_LEN(ary1) <= SMALL_ARRAY_LEN || RARRAY_LEN(ary2) <= SMALL_ARRAY_LEN) { for (i=0; ieql?: [0, 1, 2, 3] & [1, 2] # => [1, 2] [0, 1, 0, 1] & [0, 1] # => [0, 1] Preserves order from +array+: [0, 1, 2] & [3, 2, 1, 0] # => [0, 1, 2] Related: Array#intersection. ;T;[o;= ;3I" overload;F;40;;”;50;)I"&(other_array);T;IC;";T; @±v;>0;!F;[;[;I";T;0;6i;[[I"other_array;T0; @±v;[;I"fReturns a new \Array containing each element found in both +array+ and \Array +other_array+; duplicates are omitted; items are compared using eql?: [0, 1, 2, 3] & [1, 2] # => [1, 2] [0, 1, 0, 1] & [0, 1] # => [0, 1] Preserves order from +array+: [0, 1, 2] & [3, 2, 1, 0] # => [0, 1, 2] Related: Array#intersection. @overload &(other_array);T;0; @±v;!F;"o;#;$T;%iù;&i;'@k;(I"static VALUE rb_ary_and(VALUE ary1, VALUE ary2) { VALUE hash, ary3, v; st_data_t vv; long i; ary2 = to_ary(ary2); ary3 = rb_ary_new(); if (RARRAY_LEN(ary1) == 0 || RARRAY_LEN(ary2) == 0) return ary3; if (RARRAY_LEN(ary1) <= SMALL_ARRAY_LEN && RARRAY_LEN(ary2) <= SMALL_ARRAY_LEN) { for (i=0; ieql?: [0, 1] | [2, 3] # => [0, 1, 2, 3] [0, 1, 1] | [2, 2, 3] # => [0, 1, 2, 3] [0, 1, 2] | [3, 2, 1, 0] # => [0, 1, 2, 3] Related: Array#union. ;T;[o;= ;3I" overload;F;40;;(;50;)I"|(other_array);T;IC;";T; @Ëv;>0;!F;[;[;I";T;0;6i;[[I"other_array;T0; @Ëv;[;I"7Returns the union of +array+ and \Array +other_array+; duplicates are removed; order is preserved; items are compared using eql?: [0, 1] | [2, 3] # => [0, 1, 2, 3] [0, 1, 1] | [2, 2, 3] # => [0, 1, 2, 3] [0, 1, 2] | [3, 2, 1, 0] # => [0, 1, 2, 3] Related: Array#union. @overload |(other_array);T;0; @Ëv;!F;"o;#;$T;%ij;⁢'@k;(I"¥static VALUE rb_ary_or(VALUE ary1, VALUE ary2) { VALUE hash, ary3; ary2 = to_ary(ary2); if (RARRAY_LEN(ary1) + RARRAY_LEN(ary2) <= SMALL_ARRAY_LEN) { ary3 = rb_ary_new(); rb_ary_union(ary3, ary1); rb_ary_union(ary3, ary2); return ary3; } hash = ary_make_hash(ary1); rb_ary_union_hash(hash, ary2); ary3 = rb_hash_values(hash); ary_recycle_hash(hash); return ary3; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#max;F;[[@c0;[[@ki4;T;;?;0;[;{;IC;"Returns one of the following: - The maximum-valued element from +self+. - A new \Array of maximum-valued elements selected from +self+. When no block is given, each element in +self+ must respond to method <=> with an \Integer. With no argument and no block, returns the element in +self+ having the maximum value per method <=>: [0, 1, 2].max # => 2 With an argument \Integer +n+ and no block, returns a new \Array with at most +n+ elements, in descending order per method <=>: [0, 1, 2, 3].max(3) # => [3, 2, 1] [0, 1, 2, 3].max(6) # => [3, 2, 1] When a block is given, the block must return an \Integer. With a block and no argument, calls the block self.size-1 times to compare elements; returns the element having the maximum value per the block: ['0', '00', '000'].max {|a, b| a.size <=> b.size } # => "000" With an argument +n+ and a block, returns a new \Array with at most +n+ elements, in descending order per the block: ['0', '00', '000'].max(2) {|a, b| a.size <=> b.size } # => ["000", "00"] ;T;[ o;= ;3I" overload;F;40;;?;50;)I"max;T;IC;";T; @åv;>0;!F;[;[;I";T;0;6i;[; @åvo;= ;3I" overload;F;40;;?;50;)I"max;T;IC;";T; @åv;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"a;TI"b;T; @åv;[;I"@yield [a, b];T;0;6i;[; @åvo;= ;3I" overload;F;40;;?;50;)I"max(n);T;IC;";T; @åv;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @åvo;= ;3I" overload;F;40;;?;50;)I"max(n);T;IC;";T; @åv;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"a;TI"b;T; @åv;[;I"@yield [a, b];T;0;6i;[[I"n;T0; @åv;[;I"Returns one of the following: - The maximum-valued element from +self+. - A new \Array of maximum-valued elements selected from +self+. When no block is given, each element in +self+ must respond to method <=> with an \Integer. With no argument and no block, returns the element in +self+ having the maximum value per method <=>: [0, 1, 2].max # => 2 With an argument \Integer +n+ and no block, returns a new \Array with at most +n+ elements, in descending order per method <=>: [0, 1, 2, 3].max(3) # => [3, 2, 1] [0, 1, 2, 3].max(6) # => [3, 2, 1] When a block is given, the block must return an \Integer. With a block and no argument, calls the block self.size-1 times to compare elements; returns the element having the maximum value per the block: ['0', '00', '000'].max {|a, b| a.size <=> b.size } # => "000" With an argument +n+ and a block, returns a new \Array with at most +n+ elements, in descending order per the block: ['0', '00', '000'].max(2) {|a, b| a.size <=> b.size } # => ["000", "00"] @overload max @overload max @yield [a, b] @overload max(n) @overload max(n) @yield [a, b];T;0; @åv;!F;"o;#;$T;%i;&i3;'@k;(I"Èstatic VALUE rb_ary_max(int argc, VALUE *argv, VALUE ary) { struct cmp_opt_data cmp_opt = { 0, 0 }; VALUE result = Qundef, v; VALUE num; long i; if (rb_check_arity(argc, 0, 1) && !NIL_P(num = argv[0])) return rb_nmin_run(ary, num, 0, 1, 1); const long n = RARRAY_LEN(ary); if (rb_block_given_p()) { for (i = 0; i < RARRAY_LEN(ary); i++) { v = RARRAY_AREF(ary, i); if (result == Qundef || rb_cmpint(rb_yield_values(2, v, result), v, result) > 0) { result = v; } } } else if (n > 0) { result = RARRAY_AREF(ary, 0); if (n > 1) { if (FIXNUM_P(result) && CMP_OPTIMIZABLE(cmp_opt, Integer)) { return ary_max_opt_fixnum(ary, 1, result); } else if (STRING_P(result) && CMP_OPTIMIZABLE(cmp_opt, String)) { return ary_max_opt_string(ary, 1, result); } else if (RB_FLOAT_TYPE_P(result) && CMP_OPTIMIZABLE(cmp_opt, Float)) { return ary_max_opt_float(ary, 1, result); } else { return ary_max_generic(ary, 1, result); } } } if (result == Qundef) return Qnil; return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#min;F;[[@c0;[[@kiØ;T;;>;0;[;{;IC;"Returns one of the following: - The minimum-valued element from +self+. - A new \Array of minimum-valued elements selected from +self+. When no block is given, each element in +self+ must respond to method <=> with an \Integer. With no argument and no block, returns the element in +self+ having the minimum value per method <=>: [0, 1, 2].min # => 0 With \Integer argument +n+ and no block, returns a new \Array with at most +n+ elements, in ascending order per method <=>: [0, 1, 2, 3].min(3) # => [0, 1, 2] [0, 1, 2, 3].min(6) # => [0, 1, 2, 3] When a block is given, the block must return an Integer. With a block and no argument, calls the block self.size-1 times to compare elements; returns the element having the minimum value per the block: ['0', '00', '000'].min { |a, b| a.size <=> b.size } # => "0" With an argument +n+ and a block, returns a new \Array with at most +n+ elements, in ascending order per the block: [0, 1, 2, 3].min(3) # => [0, 1, 2] [0, 1, 2, 3].min(6) # => [0, 1, 2, 3] ;T;[ o;= ;3I" overload;F;40;;>;50;)I"min;T;IC;";T; @$w;>0;!F;[;[;I";T;0;6i;[; @$wo;= ;3I" overload;F;40;;>;50;)I"min;T;IC;";T; @$w;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"a;TI"b;T; @$w;[;I"@yield [a, b];T;0;6i;[; @$wo;= ;3I" overload;F;40;;>;50;)I"min(n);T;IC;";T; @$w;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @$wo;= ;3I" overload;F;40;;>;50;)I"min(n);T;IC;";T; @$w;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"a;TI"b;T; @$w;[;I"@yield [a, b];T;0;6i;[[I"n;T0; @$w;[;I"}Returns one of the following: - The minimum-valued element from +self+. - A new \Array of minimum-valued elements selected from +self+. When no block is given, each element in +self+ must respond to method <=> with an \Integer. With no argument and no block, returns the element in +self+ having the minimum value per method <=>: [0, 1, 2].min # => 0 With \Integer argument +n+ and no block, returns a new \Array with at most +n+ elements, in ascending order per method <=>: [0, 1, 2, 3].min(3) # => [0, 1, 2] [0, 1, 2, 3].min(6) # => [0, 1, 2, 3] When a block is given, the block must return an Integer. With a block and no argument, calls the block self.size-1 times to compare elements; returns the element having the minimum value per the block: ['0', '00', '000'].min { |a, b| a.size <=> b.size } # => "0" With an argument +n+ and a block, returns a new \Array with at most +n+ elements, in ascending order per the block: [0, 1, 2, 3].min(3) # => [0, 1, 2] [0, 1, 2, 3].min(6) # => [0, 1, 2, 3] @overload min @overload min @yield [a, b] @overload min(n) @overload min(n) @yield [a, b];T;0; @$w;!F;"o;#;$T;%i¶;&i×;'@k;(I"Èstatic VALUE rb_ary_min(int argc, VALUE *argv, VALUE ary) { struct cmp_opt_data cmp_opt = { 0, 0 }; VALUE result = Qundef, v; VALUE num; long i; if (rb_check_arity(argc, 0, 1) && !NIL_P(num = argv[0])) return rb_nmin_run(ary, num, 0, 0, 1); const long n = RARRAY_LEN(ary); if (rb_block_given_p()) { for (i = 0; i < RARRAY_LEN(ary); i++) { v = RARRAY_AREF(ary, i); if (result == Qundef || rb_cmpint(rb_yield_values(2, v, result), v, result) < 0) { result = v; } } } else if (n > 0) { result = RARRAY_AREF(ary, 0); if (n > 1) { if (FIXNUM_P(result) && CMP_OPTIMIZABLE(cmp_opt, Integer)) { return ary_min_opt_fixnum(ary, 1, result); } else if (STRING_P(result) && CMP_OPTIMIZABLE(cmp_opt, String)) { return ary_min_opt_string(ary, 1, result); } else if (RB_FLOAT_TYPE_P(result) && CMP_OPTIMIZABLE(cmp_opt, Float)) { return ary_min_opt_float(ary, 1, result); } else { return ary_min_generic(ary, 1, result); } } } if (result == Qundef) return Qnil; return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#minmax;F;[;[[@ki;T;;@;0;[;{;IC;"Returns a new 2-element \Array containing the minimum and maximum values from +self+, either per method <=> or per a given block:. When no block is given, each element in +self+ must respond to method <=> with an \Integer; returns a new 2-element \Array containing the minimum and maximum values from +self+, per method <=>: [0, 1, 2].minmax # => [0, 2] When a block is given, the block must return an \Integer; the block is called self.size-1 times to compare elements; returns a new 2-element \Array containing the minimum and maximum values from +self+, per the block: ['0', '00', '000'].minmax {|a, b| a.size <=> b.size } # => ["0", "000"] ;T;[o;= ;3I" overload;F;40;;@;50;)I"minmax;T;IC;";T; @cw;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @cw;[;I"@return [Array];T;0;6i;[; @cwo;= ;3I" overload;F;40;;@;50;)I"minmax;T;IC;";T; @cw;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"a;TI"b;T; @cwo;2 ;3I"return;F;4I";T;0;5[I" Array;T; @cw;[;I""@yield [a, b] @return [Array];T;0;6i;[; @cw;[;I"Returns a new 2-element \Array containing the minimum and maximum values from +self+, either per method <=> or per a given block:. When no block is given, each element in +self+ must respond to method <=> with an \Integer; returns a new 2-element \Array containing the minimum and maximum values from +self+, per method <=>: [0, 1, 2].minmax # => [0, 2] When a block is given, the block must return an \Integer; the block is called self.size-1 times to compare elements; returns a new 2-element \Array containing the minimum and maximum values from +self+, per the block: ['0', '00', '000'].minmax {|a, b| a.size <=> b.size } # => ["0", "000"] @overload minmax @return [Array] @overload minmax @yield [a, b] @return [Array];T;0; @cw;!F;"o;#;$T;%i;&i;'@k;(I"»static VALUE rb_ary_minmax(VALUE ary) { if (rb_block_given_p()) { return rb_call_super(0, NULL); } return rb_assoc_new(rb_ary_min(0, 0, ary), rb_ary_max(0, 0, ary)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#uniq;F;[;[[@kis;T;;X;0;[;{;IC;"2Returns a new \Array containing those elements from +self+ that are not duplicates, the first occurrence always being retained. With no block given, identifies and omits duplicates using method eql? to compare. a = [0, 0, 1, 1, 2, 2] a.uniq # => [0, 1, 2] With a block given, calls the block for each element; identifies (using method eql?) and omits duplicate values, that is, those elements for which the block returns the same value: a = ['a', 'aa', 'aaa', 'b', 'bb', 'bbb'] a.uniq {|element| element.size } # => ["a", "aa", "aaa"] ;T;[o;= ;3I" overload;F;40;;X;50;)I" uniq;T;IC;";T; @‘w;>0;!F;[;[;I";T;0;6i;[; @‘wo;= ;3I" overload;F;40;;X;50;)I" uniq;T;IC;";T; @‘w;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @‘w;[;I"@yield [element];T;0;6i;[; @‘w;[;I"eReturns a new \Array containing those elements from +self+ that are not duplicates, the first occurrence always being retained. With no block given, identifies and omits duplicates using method eql? to compare. a = [0, 0, 1, 1, 2, 2] a.uniq # => [0, 1, 2] With a block given, calls the block for each element; identifies (using method eql?) and omits duplicate values, that is, those elements for which the block returns the same value: a = ['a', 'aa', 'aaa', 'b', 'bb', 'bbb'] a.uniq {|element| element.size } # => ["a", "aa", "aaa"] @overload uniq @overload uniq @yield [element];T;0; @‘w;!F;"o;#;$T;%i_;&ip;'@k;(I"static VALUE rb_ary_uniq(VALUE ary) { VALUE hash, uniq; if (RARRAY_LEN(ary) <= 1) { hash = 0; uniq = rb_ary_dup(ary); } else if (rb_block_given_p()) { hash = ary_make_hash_by(ary); uniq = rb_hash_values(hash); } else { hash = ary_make_hash(ary); uniq = rb_hash_values(hash); } if (hash) { ary_recycle_hash(hash); } return uniq; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#uniq!;F;[;[[@ki@;T;: uniq!;0;[;{;IC;"ÄRemoves duplicate elements from +self+, the first occurrence always being retained; returns +self+ if any elements removed, +nil+ otherwise. With no block given, identifies and removes elements using method eql? to compare. Returns +self+ if any elements removed: a = [0, 0, 1, 1, 2, 2] a.uniq! # => [0, 1, 2] Returns +nil+ if no elements removed. With a block given, calls the block for each element; identifies (using method eql?) and removes elements for which the block returns duplicate values. Returns +self+ if any elements removed: a = ['a', 'aa', 'aaa', 'b', 'bb', 'bbb'] a.uniq! {|element| element.size } # => ['a', 'aa', 'aaa'] Returns +nil+ if no elements removed. ;T;[o;= ;3I" overload;F;40;;);50;)I" uniq!;T;IC;";T; @´w;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;TI"nil;T; @´w;[;I"@return [self, nil];T;0;6i;[; @´wo;= ;3I" overload;F;40;;);50;)I" uniq!;T;IC;";T; @´w;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @´wo;2 ;3I"return;F;4I";T;0;5[I" self;TI"nil;T; @´w;[;I")@yield [element] @return [self, nil];T;0;6i;[; @´w;[;I"%Removes duplicate elements from +self+, the first occurrence always being retained; returns +self+ if any elements removed, +nil+ otherwise. With no block given, identifies and removes elements using method eql? to compare. Returns +self+ if any elements removed: a = [0, 0, 1, 1, 2, 2] a.uniq! # => [0, 1, 2] Returns +nil+ if no elements removed. With a block given, calls the block for each element; identifies (using method eql?) and removes elements for which the block returns duplicate values. Returns +self+ if any elements removed: a = ['a', 'aa', 'aaa', 'b', 'bb', 'bbb'] a.uniq! {|element| element.size } # => ['a', 'aa', 'aaa'] Returns +nil+ if no elements removed. @overload uniq! @return [self, nil] @overload uniq! @yield [element] @return [self, nil];T;0; @´w;!F;"o;#;$T;%i%;&i@;'@k;(I"xstatic VALUE rb_ary_uniq_bang(VALUE ary) { VALUE hash; long hash_size; rb_ary_modify_check(ary); if (RARRAY_LEN(ary) <= 1) return Qnil; if (rb_block_given_p()) hash = ary_make_hash_by(ary); else hash = ary_make_hash(ary); hash_size = RHASH_SIZE(hash); if (RARRAY_LEN(ary) == hash_size) { return Qnil; } rb_ary_modify_check(ary); ARY_SET_LEN(ary, 0); if (ARY_SHARED_P(ary) && !ARY_EMBED_P(ary)) { rb_ary_unshare(ary); FL_SET_EMBED(ary); } ary_resize_capa(ary, hash_size); rb_hash_foreach(hash, push_value, ary); ary_recycle_hash(hash); return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#compact;F;[;[[@ki´;T;;Í;0;[;{;IC;"‚Returns a new \Array containing all non-+nil+ elements from +self+: a = [nil, 0, nil, 1, nil, 2, nil] a.compact # => [0, 1, 2] ;T;[o;= ;3I" overload;F;40;;Í;50;)I"compact;T;IC;";T; @ãw;>0;!F;[;[;I";T;0;6i;[; @ãw;[;I"–Returns a new \Array containing all non-+nil+ elements from +self+: a = [nil, 0, nil, 1, nil, 2, nil] a.compact # => [0, 1, 2] @overload compact;T;0; @ãw;!F;"o;#;$T;%i«;&i°;'@k;(I"xstatic VALUE rb_ary_compact(VALUE ary) { ary = rb_ary_dup(ary); rb_ary_compact_bang(ary); return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#compact!;F;[;[[@ki”;T;;Î;0;[;{;IC;"fRemoves all +nil+ elements from +self+. Returns +self+ if any elements removed, otherwise +nil+. ;T;[o;= ;3I" overload;F;40;;Î;50;)I" compact!;T;IC;";T; @ùw;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;TI"nil;T; @ùw;[;I"@return [self, nil];T;0;6i;[; @ùw;[;I"ŒRemoves all +nil+ elements from +self+. Returns +self+ if any elements removed, otherwise +nil+. @overload compact! @return [self, nil];T;0; @ùw;!F;"o;#;$T;%i‹;&i‘;'@k;(I"³static VALUE rb_ary_compact_bang(VALUE ary) { VALUE *p, *t, *end; long n; rb_ary_modify(ary); p = t = (VALUE *)RARRAY_CONST_PTR_TRANSIENT(ary); /* WB: no new reference */ end = p + RARRAY_LEN(ary); while (t < end) { if (NIL_P(*t)) t++; else *p++ = *t++; } n = p - RARRAY_CONST_PTR_TRANSIENT(ary); if (RARRAY_LEN(ary) == n) { return Qnil; } ary_resize_smaller(ary, n); return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#flatten;F;[[@c0;[[@kiž;T;;Ì;0;[;{;IC;"šReturns a new \Array that is a recursive flattening of +self+: - Each non-Array element is unchanged. - Each \Array is replaced by its individual elements. With non-negative \Integer argument +level+, flattens recursively through +level+ levels: a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten(0) # => [0, [1, [2, 3], 4], 5] a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten(1) # => [0, 1, [2, 3], 4, 5] a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten(2) # => [0, 1, 2, 3, 4, 5] a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten(3) # => [0, 1, 2, 3, 4, 5] With no argument, a +nil+ argument, or with negative argument +level+, flattens all levels: a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten # => [0, 1, 2, 3, 4, 5] [0, 1, 2].flatten # => [0, 1, 2] a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten(-1) # => [0, 1, 2, 3, 4, 5] a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten(-2) # => [0, 1, 2, 3, 4, 5] [0, 1, 2].flatten(-1) # => [0, 1, 2] ;T;[o;= ;3I" overload;F;40;;Ì;50;)I"flatten;T;IC;";T; @x;>0;!F;[;[;I";T;0;6i;[; @xo;= ;3I" overload;F;40;;Ì;50;)I"flatten(level);T;IC;";T; @x;>0;!F;[;[;I";T;0;6i;[[I" level;T0; @x;[;I"ÇReturns a new \Array that is a recursive flattening of +self+: - Each non-Array element is unchanged. - Each \Array is replaced by its individual elements. With non-negative \Integer argument +level+, flattens recursively through +level+ levels: a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten(0) # => [0, [1, [2, 3], 4], 5] a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten(1) # => [0, 1, [2, 3], 4, 5] a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten(2) # => [0, 1, 2, 3, 4, 5] a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten(3) # => [0, 1, 2, 3, 4, 5] With no argument, a +nil+ argument, or with negative argument +level+, flattens all levels: a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten # => [0, 1, 2, 3, 4, 5] [0, 1, 2].flatten # => [0, 1, 2] a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten(-1) # => [0, 1, 2, 3, 4, 5] a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten(-2) # => [0, 1, 2, 3, 4, 5] [0, 1, 2].flatten(-1) # => [0, 1, 2] @overload flatten @overload flatten(level);T;0; @x;!F;"o;#;$T;%i€;&iš;'@k;(I"…static VALUE rb_ary_flatten(int argc, VALUE *argv, VALUE ary) { int level = -1; VALUE result; if (rb_check_arity(argc, 0, 1) && !NIL_P(argv[0])) { level = NUM2INT(argv[0]); if (level == 0) return ary_make_shared_copy(ary); } result = flatten(ary, level); if (result == ary) { result = ary_make_shared_copy(ary); } return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#flatten!;F;[[@c0;[[@kij;T;: flatten!;0;[;{;IC;"IReplaces each nested \Array in +self+ with the elements from that \Array; returns +self+ if any changes, +nil+ otherwise. With non-negative \Integer argument +level+, flattens recursively through +level+ levels: a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten!(1) # => [0, 1, [2, 3], 4, 5] a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten!(2) # => [0, 1, 2, 3, 4, 5] a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten!(3) # => [0, 1, 2, 3, 4, 5] [0, 1, 2].flatten!(1) # => nil With no argument, a +nil+ argument, or with negative argument +level+, flattens all levels: a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten! # => [0, 1, 2, 3, 4, 5] [0, 1, 2].flatten! # => nil a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten!(-1) # => [0, 1, 2, 3, 4, 5] a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten!(-2) # => [0, 1, 2, 3, 4, 5] [0, 1, 2].flatten!(-1) # => nil ;T;[o;= ;3I" overload;F;40;;*;50;)I" flatten!;T;IC;";T; @6x;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;TI"nil;T; @6x;[;I"@return [self, nil];T;0;6i;[; @6xo;= ;3I" overload;F;40;;*;50;)I"flatten!(level);T;IC;";T; @6x;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;TI"nil;T; @6x;[;I"@return [self, nil];T;0;6i;[[I" level;T0; @6x;[;I"¤Replaces each nested \Array in +self+ with the elements from that \Array; returns +self+ if any changes, +nil+ otherwise. With non-negative \Integer argument +level+, flattens recursively through +level+ levels: a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten!(1) # => [0, 1, [2, 3], 4, 5] a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten!(2) # => [0, 1, 2, 3, 4, 5] a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten!(3) # => [0, 1, 2, 3, 4, 5] [0, 1, 2].flatten!(1) # => nil With no argument, a +nil+ argument, or with negative argument +level+, flattens all levels: a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten! # => [0, 1, 2, 3, 4, 5] [0, 1, 2].flatten! # => nil a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten!(-1) # => [0, 1, 2, 3, 4, 5] a = [ 0, [ 1, [2, 3], 4 ], 5 ] a.flatten!(-2) # => [0, 1, 2, 3, 4, 5] [0, 1, 2].flatten!(-1) # => nil @overload flatten! @return [self, nil] @overload flatten!(level) @return [self, nil];T;0; @6x;!F;"o;#;$T;%iN;&ih;'@k;(I"static VALUE rb_ary_flatten_bang(int argc, VALUE *argv, VALUE ary) { int mod = 0, level = -1; VALUE result, lv; lv = (rb_check_arity(argc, 0, 1) ? argv[0] : Qnil); rb_ary_modify_check(ary); if (!NIL_P(lv)) level = NUM2INT(lv); if (level == 0) return Qnil; result = flatten(ary, level); if (result == ary) { return Qnil; } if (!(mod = ARY_EMBED_P(result))) rb_obj_freeze(result); rb_ary_replace(ary, result); if (mod) ARY_SET_EMBED_LEN(result, 0); return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#count;F;[[@c0;[[@kiÔ;T;;(;0;[;{;IC;"hReturns a count of specified elements. With no argument and no block, returns the count of all elements: [0, 1, 2].count # => 3 [].count # => 0 With argument +obj+, returns the count of elements eql? to +obj+: [0, 1, 2, 0].count(0) # => 2 [0, 1, 2].count(3) # => 0 With no argument and a block given, calls the block with each element; returns the count of elements for which the block returns a truthy value: [0, 1, 2, 3].count {|element| element > 1} # => 2 With argument +obj+ and a block given, issues a warning, ignores the block, and returns the count of elements eql? to +obj+: ;T;[o;= ;3I" overload;F;40;;(;50;)I" count;T;IC;";T; @cx;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @cx;[;I"@return [Integer];T;0;6i;[; @cxo;= ;3I" overload;F;40;;(;50;)I"count(obj);T;IC;";T; @cx;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @cx;[;I"@return [Integer];T;0;6i;[[I"obj;T0; @cxo;= ;3I" overload;F;40;;(;50;)I" count;T;IC;";T; @cx;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @cxo;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @cx;[;I"'@yield [element] @return [Integer];T;0;6i;[; @cx;[;I"îReturns a count of specified elements. With no argument and no block, returns the count of all elements: [0, 1, 2].count # => 3 [].count # => 0 With argument +obj+, returns the count of elements eql? to +obj+: [0, 1, 2, 0].count(0) # => 2 [0, 1, 2].count(3) # => 0 With no argument and a block given, calls the block with each element; returns the count of elements for which the block returns a truthy value: [0, 1, 2, 3].count {|element| element > 1} # => 2 With argument +obj+ and a block given, issues a warning, ignores the block, and returns the count of elements eql? to +obj+: @overload count @return [Integer] @overload count(obj) @return [Integer] @overload count @yield [element] @return [Integer];T;0; @cx;!F;"o;#;$T;%i¼;&iÔ;'@k;(I"'static VALUE rb_ary_count(int argc, VALUE *argv, VALUE ary) { long i, n = 0; if (rb_check_arity(argc, 0, 1) == 0) { VALUE v; if (!rb_block_given_p()) return LONG2NUM(RARRAY_LEN(ary)); for (i = 0; i < RARRAY_LEN(ary); i++) { v = RARRAY_AREF(ary, i); if (RTEST(rb_yield(v))) n++; } } else { VALUE obj = argv[0]; if (rb_block_given_p()) { rb_warn("given block not used"); } for (i = 0; i < RARRAY_LEN(ary); i++) { if (rb_equal(RARRAY_AREF(ary, i), obj)) n++; } } return LONG2NUM(n); };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#cycle;F;[[@c0;[[@ki€;T;;Q;0;[;{;IC;"OWhen called with positive \Integer argument +count+ and a block, calls the block with each element, then does so again, until it has done so +count+ times; returns +nil+: output = [] [0, 1].cycle(2) {|element| output.push(element) } # => nil output # => [0, 1, 0, 1] If +count+ is zero or negative, does not call the block: [0, 1].cycle(0) {|element| fail 'Cannot happen' } # => nil [0, 1].cycle(-1) {|element| fail 'Cannot happen' } # => nil When a block is given, and argument is omitted or +nil+, cycles forever: # Prints 0 and 1 forever. [0, 1].cycle {|element| puts element } [0, 1].cycle(nil) {|element| puts element } When no block is given, returns a new \Enumerator: [0, 1].cycle(2) # => # [0, 1].cycle # => # => # [0, 1].cycle.first(5) # => [0, 1, 0, 1, 0] ;T;[ o;= ;3I" overload;F;40;;Q;50;)I" cycle;T;IC;";T; @ x;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @ xo;2 ;3I"return;F;4I";T;0;5[I"nil;T; @ x;[;I"#@yield [element] @return [nil];T;0;6i;[; @ xo;= ;3I" overload;F;40;;Q;50;)I"cycle(count);T;IC;";T; @ x;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @ xo;2 ;3I"return;F;4I";T;0;5[I"nil;T; @ x;[;I"#@yield [element] @return [nil];T;0;6i;[[I" count;T0; @ xo;= ;3I" overload;F;40;;Q;50;)I" cycle;T;IC;";T; @ x;>0;!F;[;[;I";T;0;6i;[; @ xo;= ;3I" overload;F;40;;Q;50;)I"cycle(count);T;IC;";T; @ x;>0;!F;[;[;I";T;0;6i;[[I" count;T0; @ x;[;I"åWhen called with positive \Integer argument +count+ and a block, calls the block with each element, then does so again, until it has done so +count+ times; returns +nil+: output = [] [0, 1].cycle(2) {|element| output.push(element) } # => nil output # => [0, 1, 0, 1] If +count+ is zero or negative, does not call the block: [0, 1].cycle(0) {|element| fail 'Cannot happen' } # => nil [0, 1].cycle(-1) {|element| fail 'Cannot happen' } # => nil When a block is given, and argument is omitted or +nil+, cycles forever: # Prints 0 and 1 forever. [0, 1].cycle {|element| puts element } [0, 1].cycle(nil) {|element| puts element } When no block is given, returns a new \Enumerator: [0, 1].cycle(2) # => # [0, 1].cycle # => # => # [0, 1].cycle.first(5) # => [0, 1, 0, 1, 0] @overload cycle @yield [element] @return [nil] @overload cycle(count) @yield [element] @return [nil] @overload cycle @overload cycle(count);T;0; @ x;!F;"o;#;$T;%ic;&i;'@k;(I"ðstatic VALUE rb_ary_cycle(int argc, VALUE *argv, VALUE ary) { long n, i; rb_check_arity(argc, 0, 1); RETURN_SIZED_ENUMERATOR(ary, argc, argv, rb_ary_cycle_size); if (argc == 0 || NIL_P(argv[0])) { n = -1; } else { n = NUM2LONG(argv[0]); if (n <= 0) return Qnil; } while (RARRAY_LEN(ary) > 0 && (n < 0 || 0 < n--)) { for (i=0; i0 < n <= self.size) are given, calls the block with all +n+-tuple permutations of +self+. Example: a = [0, 1, 2] a.permutation(2) {|permutation| p permutation } Output: [0, 1] [0, 2] [1, 0] [1, 2] [2, 0] [2, 1] Another example: a = [0, 1, 2] a.permutation(3) {|permutation| p permutation } Output: [0, 1, 2] [0, 2, 1] [1, 0, 2] [1, 2, 0] [2, 0, 1] [2, 1, 0] When +n+ is zero, calls the block once with a new empty \Array: a = [0, 1, 2] a.permutation(0) {|permutation| p permutation } Output: [] When +n+ is out of range (negative or larger than self.size), does not call the block: a = [0, 1, 2] a.permutation(-1) {|permutation| fail 'Cannot happen' } a.permutation(4) {|permutation| fail 'Cannot happen' } When a block given but no argument, behaves the same as a.permutation(a.size): a = [0, 1, 2] a.permutation {|permutation| p permutation } Output: [0, 1, 2] [0, 2, 1] [1, 0, 2] [1, 2, 0] [2, 0, 1] [2, 1, 0] Returns a new \Enumerator if no block given: a = [0, 1, 2] a.permutation # => # a.permutation(2) # => # ;T;[ o;= ;3I" overload;F;40;;+;50;)I"permutation;T;IC;";T; @çx;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @çxo;2 ;3I"return;F;4I";T;0;5[I" self;T; @çx;[;I"$@yield [element] @return [self];T;0;6i;[; @çxo;= ;3I" overload;F;40;;+;50;)I"permutation(n);T;IC;";T; @çx;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @çxo;2 ;3I"return;F;4I";T;0;5[I" self;T; @çx;[;I"$@yield [element] @return [self];T;0;6i;[[I"n;T0; @çxo;= ;3I" overload;F;40;;+;50;)I"permutation;T;IC;";T; @çx;>0;!F;[;[;I";T;0;6i;[; @çxo;= ;3I" overload;F;40;;+;50;)I"permutation(n);T;IC;";T; @çx;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @çx;[;I"When invoked with a block, yield all permutations of elements of +self+; returns +self+. The order of permutations is indeterminate. When a block and an in-range positive \Integer argument +n+ (0 < n <= self.size) are given, calls the block with all +n+-tuple permutations of +self+. Example: a = [0, 1, 2] a.permutation(2) {|permutation| p permutation } Output: [0, 1] [0, 2] [1, 0] [1, 2] [2, 0] [2, 1] Another example: a = [0, 1, 2] a.permutation(3) {|permutation| p permutation } Output: [0, 1, 2] [0, 2, 1] [1, 0, 2] [1, 2, 0] [2, 0, 1] [2, 1, 0] When +n+ is zero, calls the block once with a new empty \Array: a = [0, 1, 2] a.permutation(0) {|permutation| p permutation } Output: [] When +n+ is out of range (negative or larger than self.size), does not call the block: a = [0, 1, 2] a.permutation(-1) {|permutation| fail 'Cannot happen' } a.permutation(4) {|permutation| fail 'Cannot happen' } When a block given but no argument, behaves the same as a.permutation(a.size): a = [0, 1, 2] a.permutation {|permutation| p permutation } Output: [0, 1, 2] [0, 2, 1] [1, 0, 2] [1, 2, 0] [2, 0, 1] [2, 1, 0] Returns a new \Enumerator if no block given: a = [0, 1, 2] a.permutation # => # a.permutation(2) # => # @overload permutation @yield [element] @return [self] @overload permutation(n) @yield [element] @return [self] @overload permutation @overload permutation(n);T;0; @çx;!F;"o;#;$T;%i;&iO;'@k;(I"·static VALUE rb_ary_permutation(int argc, VALUE *argv, VALUE ary) { long r, n, i; n = RARRAY_LEN(ary); /* Array length */ RETURN_SIZED_ENUMERATOR(ary, argc, argv, rb_ary_permutation_size); /* Return enumerator if no block */ r = n; if (rb_check_arity(argc, 0, 1) && !NIL_P(argv[0])) r = NUM2LONG(argv[0]); /* Permutation size from argument */ if (r < 0 || n < r) { /* no permutations: yield nothing */ } else if (r == 0) { /* exactly one permutation: the zero-length array */ rb_yield(rb_ary_new2(0)); } else if (r == 1) { /* this is a special, easy case */ for (i = 0; i < RARRAY_LEN(ary); i++) { rb_yield(rb_ary_new3(1, RARRAY_AREF(ary, i))); } } else { /* this is the general case */ volatile VALUE t0; long *p = ALLOCV_N(long, t0, r+roomof(n, sizeof(long))); char *used = (char*)(p + r); VALUE ary0 = ary_make_shared_copy(ary); /* private defensive copy of ary */ RBASIC_CLEAR_CLASS(ary0); MEMZERO(used, char, n); /* initialize array */ permute0(n, r, p, used, ary0); /* compute and yield permutations */ ALLOCV_END(t0); RBASIC_SET_CLASS_RAW(ary0, rb_cArray); } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#combination;F;[[I"num;T0;[[@ki½;T;:combination;0;[;{;IC;"îCalls the block, if given, with combinations of elements of +self+; returns +self+. The order of combinations is indeterminate. When a block and an in-range positive \Integer argument +n+ (0 < n <= self.size) are given, calls the block with all +n+-tuple combinations of +self+. Example: a = [0, 1, 2] a.combination(2) {|combination| p combination } Output: [0, 1] [0, 2] [1, 2] Another example: a = [0, 1, 2] a.combination(3) {|combination| p combination } Output: [0, 1, 2] When +n+ is zero, calls the block once with a new empty \Array: a = [0, 1, 2] a1 = a.combination(0) {|combination| p combination } Output: [] When +n+ is out of range (negative or larger than self.size), does not call the block: a = [0, 1, 2] a.combination(-1) {|combination| fail 'Cannot happen' } a.combination(4) {|combination| fail 'Cannot happen' } Returns a new \Enumerator if no block given: a = [0, 1, 2] a.combination(2) # => # ;T;[o;= ;3I" overload;F;40;;,;50;)I"combination(n);T;IC;";T; @.y;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @.yo;2 ;3I"return;F;4I";T;0;5[I" self;T; @.y;[;I"$@yield [element] @return [self];T;0;6i;[[I"n;T0; @.yo;= ;3I" overload;F;40;;,;50;)I"combination(n);T;IC;";T; @.y;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @.y;[;I"FCalls the block, if given, with combinations of elements of +self+; returns +self+. The order of combinations is indeterminate. When a block and an in-range positive \Integer argument +n+ (0 < n <= self.size) are given, calls the block with all +n+-tuple combinations of +self+. Example: a = [0, 1, 2] a.combination(2) {|combination| p combination } Output: [0, 1] [0, 2] [1, 2] Another example: a = [0, 1, 2] a.combination(3) {|combination| p combination } Output: [0, 1, 2] When +n+ is zero, calls the block once with a new empty \Array: a = [0, 1, 2] a1 = a.combination(0) {|combination| p combination } Output: [] When +n+ is out of range (negative or larger than self.size), does not call the block: a = [0, 1, 2] a.combination(-1) {|combination| fail 'Cannot happen' } a.combination(4) {|combination| fail 'Cannot happen' } Returns a new \Enumerator if no block given: a = [0, 1, 2] a.combination(2) # => # @overload combination(n) @yield [element] @return [self] @overload combination(n);T;0; @.y;!F;"o;#;$T;%i“;&i»;'@k;(I"Ñstatic VALUE rb_ary_combination(VALUE ary, VALUE num) { long i, n, len; n = NUM2LONG(num); RETURN_SIZED_ENUMERATOR(ary, 1, &num, rb_ary_combination_size); len = RARRAY_LEN(ary); if (n < 0 || len < n) { /* yield nothing */ } else if (n == 0) { rb_yield(rb_ary_new2(0)); } else if (n == 1) { for (i = 0; i < RARRAY_LEN(ary); i++) { rb_yield(rb_ary_new3(1, RARRAY_AREF(ary, i))); } } else { VALUE ary0 = ary_make_shared_copy(ary); /* private defensive copy of ary */ volatile VALUE t0; long *stack = ALLOCV_N(long, t0, n+1); RBASIC_CLEAR_CLASS(ary0); combinate0(len, n, stack, ary0); ALLOCV_END(t0); RBASIC_SET_CLASS_RAW(ary0, rb_cArray); } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#repeated_permutation;F;[[I"num;T0;[[@kiF;T;:repeated_permutation;0;[;{;IC;"6Calls the block with each repeated permutation of length +n+ of the elements of +self+; each permutation is an \Array; returns +self+. The order of the permutations is indeterminate. When a block and a positive \Integer argument +n+ are given, calls the block with each +n+-tuple repeated permutation of the elements of +self+. The number of permutations is self.size**n. +n+ = 1: a = [0, 1, 2] a.repeated_permutation(1) {|permutation| p permutation } Output: [0] [1] [2] +n+ = 2: a.repeated_permutation(2) {|permutation| p permutation } Output: [0, 0] [0, 1] [0, 2] [1, 0] [1, 1] [1, 2] [2, 0] [2, 1] [2, 2] If +n+ is zero, calls the block once with an empty \Array. If +n+ is negative, does not call the block: a.repeated_permutation(-1) {|permutation| fail 'Cannot happen' } Returns a new \Enumerator if no block given: a = [0, 1, 2] a.repeated_permutation(2) # => # Using Enumerators, it's convenient to show the permutations and counts for some values of +n+: e = a.repeated_permutation(0) e.size # => 1 e.to_a # => [[]] e = a.repeated_permutation(1) e.size # => 3 e.to_a # => [[0], [1], [2]] e = a.repeated_permutation(2) e.size # => 9 e.to_a # => [[0, 0], [0, 1], [0, 2], [1, 0], [1, 1], [1, 2], [2, 0], [2, 1], [2, 2]] ;T;[o;= ;3I" overload;F;40;;-;50;)I"repeated_permutation(n);T;IC;";T; @\y;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"permutation;T; @\yo;2 ;3I"return;F;4I";T;0;5[I" self;T; @\y;[;I"(@yield [permutation] @return [self];T;0;6i;[[I"n;T0; @\yo;= ;3I" overload;F;40;;-;50;)I"repeated_permutation(n);T;IC;";T; @\y;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @\y;[;I"¤Calls the block with each repeated permutation of length +n+ of the elements of +self+; each permutation is an \Array; returns +self+. The order of the permutations is indeterminate. When a block and a positive \Integer argument +n+ are given, calls the block with each +n+-tuple repeated permutation of the elements of +self+. The number of permutations is self.size**n. +n+ = 1: a = [0, 1, 2] a.repeated_permutation(1) {|permutation| p permutation } Output: [0] [1] [2] +n+ = 2: a.repeated_permutation(2) {|permutation| p permutation } Output: [0, 0] [0, 1] [0, 2] [1, 0] [1, 1] [1, 2] [2, 0] [2, 1] [2, 2] If +n+ is zero, calls the block once with an empty \Array. If +n+ is negative, does not call the block: a.repeated_permutation(-1) {|permutation| fail 'Cannot happen' } Returns a new \Enumerator if no block given: a = [0, 1, 2] a.repeated_permutation(2) # => # Using Enumerators, it's convenient to show the permutations and counts for some values of +n+: e = a.repeated_permutation(0) e.size # => 1 e.to_a # => [[]] e = a.repeated_permutation(1) e.size # => 3 e.to_a # => [[0], [1], [2]] e = a.repeated_permutation(2) e.size # => 9 e.to_a # => [[0, 0], [0, 1], [0, 2], [1, 0], [1, 1], [1, 2], [2, 0], [2, 1], [2, 2]] @overload repeated_permutation(n) @yield [permutation] @return [self] @overload repeated_permutation(n);T;0; @\y;!F;"o;#;$T;%i;&iE;'@k;(I"static VALUE rb_ary_repeated_permutation(VALUE ary, VALUE num) { long r, n, i; n = RARRAY_LEN(ary); /* Array length */ RETURN_SIZED_ENUMERATOR(ary, 1, &num, rb_ary_repeated_permutation_size); /* Return Enumerator if no block */ r = NUM2LONG(num); /* Permutation size from argument */ if (r < 0) { /* no permutations: yield nothing */ } else if (r == 0) { /* exactly one permutation: the zero-length array */ rb_yield(rb_ary_new2(0)); } else if (r == 1) { /* this is a special, easy case */ for (i = 0; i < RARRAY_LEN(ary); i++) { rb_yield(rb_ary_new3(1, RARRAY_AREF(ary, i))); } } else { /* this is the general case */ volatile VALUE t0; long *p = ALLOCV_N(long, t0, r); VALUE ary0 = ary_make_shared_copy(ary); /* private defensive copy of ary */ RBASIC_CLEAR_CLASS(ary0); rpermute0(n, r, p, ary0); /* compute and yield repeated permutations */ ALLOCV_END(t0); RBASIC_SET_CLASS_RAW(ary0, rb_cArray); } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#repeated_combination;F;[[I"num;T0;[[@ki¾;T;:repeated_combination;0;[;{;IC;"Calls the block with each repeated combination of length +n+ of the elements of +self+; each combination is an \Array; returns +self+. The order of the combinations is indeterminate. When a block and a positive \Integer argument +n+ are given, calls the block with each +n+-tuple repeated combination of the elements of +self+. The number of combinations is (n+1)(n+2)/2. +n+ = 1: a = [0, 1, 2] a.repeated_combination(1) {|combination| p combination } Output: [0] [1] [2] +n+ = 2: a.repeated_combination(2) {|combination| p combination } Output: [0, 0] [0, 1] [0, 2] [1, 1] [1, 2] [2, 2] If +n+ is zero, calls the block once with an empty \Array. If +n+ is negative, does not call the block: a.repeated_combination(-1) {|combination| fail 'Cannot happen' } Returns a new \Enumerator if no block given: a = [0, 1, 2] a.repeated_combination(2) # => # Using Enumerators, it's convenient to show the combinations and counts for some values of +n+: e = a.repeated_combination(0) e.size # => 1 e.to_a # => [[]] e = a.repeated_combination(1) e.size # => 3 e.to_a # => [[0], [1], [2]] e = a.repeated_combination(2) e.size # => 6 e.to_a # => [[0, 0], [0, 1], [0, 2], [1, 1], [1, 2], [2, 2]] ;T;[o;= ;3I" overload;F;40;;.;50;)I"repeated_combination(n);T;IC;";T; @Šy;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"combination;T; @Šyo;2 ;3I"return;F;4I";T;0;5[I" self;T; @Šy;[;I"(@yield [combination] @return [self];T;0;6i;[[I"n;T0; @Šyo;= ;3I" overload;F;40;;.;50;)I"repeated_combination(n);T;IC;";T; @Šy;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @Šy;[;I"qCalls the block with each repeated combination of length +n+ of the elements of +self+; each combination is an \Array; returns +self+. The order of the combinations is indeterminate. When a block and a positive \Integer argument +n+ are given, calls the block with each +n+-tuple repeated combination of the elements of +self+. The number of combinations is (n+1)(n+2)/2. +n+ = 1: a = [0, 1, 2] a.repeated_combination(1) {|combination| p combination } Output: [0] [1] [2] +n+ = 2: a.repeated_combination(2) {|combination| p combination } Output: [0, 0] [0, 1] [0, 2] [1, 1] [1, 2] [2, 2] If +n+ is zero, calls the block once with an empty \Array. If +n+ is negative, does not call the block: a.repeated_combination(-1) {|combination| fail 'Cannot happen' } Returns a new \Enumerator if no block given: a = [0, 1, 2] a.repeated_combination(2) # => # Using Enumerators, it's convenient to show the combinations and counts for some values of +n+: e = a.repeated_combination(0) e.size # => 1 e.to_a # => [[]] e = a.repeated_combination(1) e.size # => 3 e.to_a # => [[0], [1], [2]] e = a.repeated_combination(2) e.size # => 6 e.to_a # => [[0, 0], [0, 1], [0, 2], [1, 1], [1, 2], [2, 2]] @overload repeated_combination(n) @yield [combination] @return [self] @overload repeated_combination(n);T;0; @Šy;!F;"o;#;$T;%i‰;&i¼;'@k;(I"static VALUE rb_ary_repeated_combination(VALUE ary, VALUE num) { long n, i, len; n = NUM2LONG(num); /* Combination size from argument */ RETURN_SIZED_ENUMERATOR(ary, 1, &num, rb_ary_repeated_combination_size); /* Return enumerator if no block */ len = RARRAY_LEN(ary); if (n < 0) { /* yield nothing */ } else if (n == 0) { rb_yield(rb_ary_new2(0)); } else if (n == 1) { for (i = 0; i < RARRAY_LEN(ary); i++) { rb_yield(rb_ary_new3(1, RARRAY_AREF(ary, i))); } } else if (len == 0) { /* yield nothing */ } else { volatile VALUE t0; long *p = ALLOCV_N(long, t0, n); VALUE ary0 = ary_make_shared_copy(ary); /* private defensive copy of ary */ RBASIC_CLEAR_CLASS(ary0); rcombinate0(len, n, p, n, ary0); /* compute and yield repeated combinations */ ALLOCV_END(t0); RBASIC_SET_CLASS_RAW(ary0, rb_cArray); } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#product;F;[[@c0;[[@ki;T;:product;0;[;{;IC;"yComputes and returns or yields all combinations of elements from all the Arrays, including both +self+ and +other_arrays+. - The number of combinations is the product of the sizes of all the arrays, including both +self+ and +other_arrays+. - The order of the returned combinations is indeterminate. When no block is given, returns the combinations as an \Array of Arrays: a = [0, 1, 2] a1 = [3, 4] a2 = [5, 6] p = a.product(a1) p.size # => 6 # a.size * a1.size p # => [[0, 3], [0, 4], [1, 3], [1, 4], [2, 3], [2, 4]] p = a.product(a1, a2) p.size # => 12 # a.size * a1.size * a2.size p # => [[0, 3, 5], [0, 3, 6], [0, 4, 5], [0, 4, 6], [1, 3, 5], [1, 3, 6], [1, 4, 5], [1, 4, 6], [2, 3, 5], [2, 3, 6], [2, 4, 5], [2, 4, 6]] If any argument is an empty \Array, returns an empty \Array. If no argument is given, returns an \Array of 1-element Arrays, each containing an element of +self+: a.product # => [[0], [1], [2]] When a block is given, yields each combination as an \Array; returns +self+: a.product(a1) {|combination| p combination } Output: [0, 3] [0, 4] [1, 3] [1, 4] [2, 3] [2, 4] If any argument is an empty \Array, does not call the block: a.product(a1, a2, []) {|combination| fail 'Cannot happen' } If no argument is given, yields each element of +self+ as a 1-element \Array: a.product {|combination| p combination } Output: [0] [1] [2] ;T;[o;= ;3I" overload;F;40;;/;50;)I"product(*other_arrays);T;IC;";T; @¸y;>0;!F;[;[;I";T;0;6i;[[I"*other_arrays;T0; @¸yo;= ;3I" overload;F;40;;/;50;)I"product(*other_arrays);T;IC;";T; @¸y;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"combination;T; @¸yo;2 ;3I"return;F;4I";T;0;5[I" self;T; @¸y;[;I"(@yield [combination] @return [self];T;0;6i;[[I"*other_arrays;T0; @¸y;[;I"åComputes and returns or yields all combinations of elements from all the Arrays, including both +self+ and +other_arrays+. - The number of combinations is the product of the sizes of all the arrays, including both +self+ and +other_arrays+. - The order of the returned combinations is indeterminate. When no block is given, returns the combinations as an \Array of Arrays: a = [0, 1, 2] a1 = [3, 4] a2 = [5, 6] p = a.product(a1) p.size # => 6 # a.size * a1.size p # => [[0, 3], [0, 4], [1, 3], [1, 4], [2, 3], [2, 4]] p = a.product(a1, a2) p.size # => 12 # a.size * a1.size * a2.size p # => [[0, 3, 5], [0, 3, 6], [0, 4, 5], [0, 4, 6], [1, 3, 5], [1, 3, 6], [1, 4, 5], [1, 4, 6], [2, 3, 5], [2, 3, 6], [2, 4, 5], [2, 4, 6]] If any argument is an empty \Array, returns an empty \Array. If no argument is given, returns an \Array of 1-element Arrays, each containing an element of +self+: a.product # => [[0], [1], [2]] When a block is given, yields each combination as an \Array; returns +self+: a.product(a1) {|combination| p combination } Output: [0, 3] [0, 4] [1, 3] [1, 4] [2, 3] [2, 4] If any argument is an empty \Array, does not call the block: a.product(a1, a2, []) {|combination| fail 'Cannot happen' } If no argument is given, yields each element of +self+ as a 1-element \Array: a.product {|combination| p combination } Output: [0] [1] [2] @overload product(*other_arrays) @overload product(*other_arrays) @yield [combination] @return [self];T;0; @¸y;!F;"o;#;$T;%iá;&i;'@k;(I"5 static VALUE rb_ary_product(int argc, VALUE *argv, VALUE ary) { int n = argc+1; /* How many arrays we're operating on */ volatile VALUE t0 = tmpary(n); volatile VALUE t1 = Qundef; VALUE *arrays = RARRAY_PTR(t0); /* The arrays we're computing the product of */ int *counters = ALLOCV_N(int, t1, n); /* The current position in each one */ VALUE result = Qnil; /* The array we'll be returning, when no block given */ long i,j; long resultlen = 1; RBASIC_CLEAR_CLASS(t0); /* initialize the arrays of arrays */ ARY_SET_LEN(t0, n); arrays[0] = ary; for (i = 1; i < n; i++) arrays[i] = Qnil; for (i = 1; i < n; i++) arrays[i] = to_ary(argv[i-1]); /* initialize the counters for the arrays */ for (i = 0; i < n; i++) counters[i] = 0; /* Otherwise, allocate and fill in an array of results */ if (rb_block_given_p()) { /* Make defensive copies of arrays; exit if any is empty */ for (i = 0; i < n; i++) { if (RARRAY_LEN(arrays[i]) == 0) goto done; arrays[i] = ary_make_shared_copy(arrays[i]); } } else { /* Compute the length of the result array; return [] if any is empty */ for (i = 0; i < n; i++) { long k = RARRAY_LEN(arrays[i]); if (k == 0) { result = rb_ary_new2(0); goto done; } if (MUL_OVERFLOW_LONG_P(resultlen, k)) rb_raise(rb_eRangeError, "too big to product"); resultlen *= k; } result = rb_ary_new2(resultlen); } for (;;) { int m; /* fill in one subarray */ VALUE subarray = rb_ary_new2(n); for (j = 0; j < n; j++) { rb_ary_push(subarray, rb_ary_entry(arrays[j], counters[j])); } /* put it on the result array */ if (NIL_P(result)) { FL_SET(t0, FL_USER5); rb_yield(subarray); if (! FL_TEST(t0, FL_USER5)) { rb_raise(rb_eRuntimeError, "product reentered"); } else { FL_UNSET(t0, FL_USER5); } } else { rb_ary_push(result, subarray); } /* * Increment the last counter. If it overflows, reset to 0 * and increment the one before it. */ m = n-1; counters[m]++; while (counters[m] == RARRAY_LEN(arrays[m])) { counters[m] = 0; /* If the first counter overflows, we are done */ if (--m < 0) goto done; counters[m]++; } } done: tmpary_discard(t0); ALLOCV_END(t1); return NIL_P(result) ? ary : result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#take;F;[[I"n;T0;[[@kiz;T;;M;0;[;{;IC;"Returns a new \Array containing the first +n+ element of +self+, where +n+ is a non-negative \Integer; does not modify +self+. Examples: a = [0, 1, 2, 3, 4, 5] a.take(1) # => [0] a.take(2) # => [0, 1] a.take(50) # => [0, 1, 2, 3, 4, 5] a # => [0, 1, 2, 3, 4, 5] ;T;[o;= ;3I" overload;F;40;;M;50;)I"take(n);T;IC;";T; @åy;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @åy;[;I"$Returns a new \Array containing the first +n+ element of +self+, where +n+ is a non-negative \Integer; does not modify +self+. Examples: a = [0, 1, 2, 3, 4, 5] a.take(1) # => [0] a.take(2) # => [0, 1] a.take(50) # => [0, 1, 2, 3, 4, 5] a # => [0, 1, 2, 3, 4, 5] @overload take(n);T;0; @åy;!F;"o;#;$T;%ij;&iv;'@k;(I"Æstatic VALUE rb_ary_take(VALUE obj, VALUE n) { long len = NUM2LONG(n); if (len < 0) { rb_raise(rb_eArgError, "attempt to take negative size"); } return rb_ary_subseq(obj, 0, len); };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#take_while;F;[;[[@ki˜;T;;N;0;[;{;IC;"EReturns a new \Array containing zero or more leading elements of +self+; does not modify +self+. With a block given, calls the block with each successive element of +self+; stops if the block returns +false+ or +nil+; returns a new Array containing those elements for which the block returned a truthy value: a = [0, 1, 2, 3, 4, 5] a.take_while {|element| element < 3 } # => [0, 1, 2] a.take_while {|element| true } # => [0, 1, 2, 3, 4, 5] a # => [0, 1, 2, 3, 4, 5] With no block given, returns a new \Enumerator: [0, 1].take_while # => # ;T;[o;= ;3I" overload;F;40;;N;50;)I"take_while;T;IC;";T; @ÿy;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @ÿy;[;I"@yield [element];T;0;6i;[; @ÿyo;= ;3I" overload;F;40;;N;50;)I"take_while;T;IC;";T; @ÿy;>0;!F;[;[;I";T;0;6i;[; @ÿy;[;I"„Returns a new \Array containing zero or more leading elements of +self+; does not modify +self+. With a block given, calls the block with each successive element of +self+; stops if the block returns +false+ or +nil+; returns a new Array containing those elements for which the block returned a truthy value: a = [0, 1, 2, 3, 4, 5] a.take_while {|element| element < 3 } # => [0, 1, 2] a.take_while {|element| true } # => [0, 1, 2, 3, 4, 5] a # => [0, 1, 2, 3, 4, 5] With no block given, returns a new \Enumerator: [0, 1].take_while # => # @overload take_while @yield [element] @overload take_while;T;0; @ÿy;!F;"o;#;$T;%i„;&i•;'@k;(I"ëstatic VALUE rb_ary_take_while(VALUE ary) { long i; RETURN_ENUMERATOR(ary, 0, 0); for (i = 0; i < RARRAY_LEN(ary); i++) { if (!RTEST(rb_yield(RARRAY_AREF(ary, i)))) break; } return rb_ary_take(ary, LONG2FIX(i)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#drop;F;[[I"n;T0;[[@ki³;T;;O;0;[;{;IC;" Returns a new \Array containing all but the first +n+ element of +self+, where +n+ is a non-negative \Integer; does not modify +self+. Examples: a = [0, 1, 2, 3, 4, 5] a.drop(0) # => [0, 1, 2, 3, 4, 5] a.drop(1) # => [1, 2, 3, 4, 5] a.drop(2) # => [2, 3, 4, 5] ;T;[o;= ;3I" overload;F;40;;O;50;)I"drop(n);T;IC;";T; @"z;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @"z;[;I"!Returns a new \Array containing all but the first +n+ element of +self+, where +n+ is a non-negative \Integer; does not modify +self+. Examples: a = [0, 1, 2, 3, 4, 5] a.drop(0) # => [0, 1, 2, 3, 4, 5] a.drop(1) # => [1, 2, 3, 4, 5] a.drop(2) # => [2, 3, 4, 5] @overload drop(n);T;0; @"z;!F;"o;#;$T;%i¤;&i¯;'@k;(I"+static VALUE rb_ary_drop(VALUE ary, VALUE n) { VALUE result; long pos = NUM2LONG(n); if (pos < 0) { rb_raise(rb_eArgError, "attempt to drop negative size"); } result = rb_ary_subseq(ary, pos, RARRAY_LEN(ary)); if (result == Qnil) result = rb_ary_new(); return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#drop_while;F;[;[[@kiÓ;T;;P;0;[;{;IC;"öReturns a new \Array containing zero or more trailing elements of +self+; does not modify +self+. With a block given, calls the block with each successive element of +self+; stops if the block returns +false+ or +nil+; returns a new Array _omitting_ those elements for which the block returned a truthy value: a = [0, 1, 2, 3, 4, 5] a.drop_while {|element| element < 3 } # => [3, 4, 5] With no block given, returns a new \Enumerator: [0, 1].drop_while # => # => # ;T;[o;= ;3I" overload;F;40;;P;50;)I"drop_while;T;IC;";T; @0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @0;!F;[;[;I";T;0;6i;[; @ [3, 4, 5] With no block given, returns a new \Enumerator: [0, 1].drop_while # => # => # @overload drop_while @yield [element] @overload drop_while;T;0; @O(log n) where +n+ is the size of the array. There are two search modes: - Find-minimum mode: the block should return +true+ or +false+. - Find-any mode: the block should return a numeric value. The block should not mix the modes by and sometimes returning +true+ or +false+ and sometimes returning a numeric value, but this is not checked. Find-Minimum Mode In find-minimum mode, the block always returns +true+ or +false+. The further requirement (though not checked) is that there are no indexes +i+ and +j+ such that: - 0 <= i < j <= self.size. - The block returns +true+ for self[i] and +false+ for self[j]. In find-minimum mode, method bsearch returns the first element for which the block returns true. Examples: a = [0, 4, 7, 10, 12] a.bsearch {|x| x >= 4 } # => 4 a.bsearch {|x| x >= 6 } # => 7 a.bsearch {|x| x >= -1 } # => 0 a.bsearch {|x| x >= 100 } # => nil Less formally: the block is such that all +false+-evaluating elements precede all +true+-evaluating elements. These make sense as blocks in find-minimum mode: a = [0, 4, 7, 10, 12] a.map {|x| x >= 4 } # => [false, true, true, true, true] a.map {|x| x >= 6 } # => [false, false, true, true, true] a.map {|x| x >= -1 } # => [true, true, true, true, true] a.map {|x| x >= 100 } # => [false, false, false, false, false] This would not make sense: a = [0, 4, 7, 10, 12] a.map {|x| x == 7 } # => [false, false, true, false, false] Find-Any Mode In find-any mode, the block always returns a numeric value. The further requirement (though not checked) is that there are no indexes +i+ and +j+ such that: - 0 <= i < j <= self.size. - The block returns a negative value for self[i] and a positive value for self[j]. - The block returns a negative value for self[i] and zero self[j]. - The block returns zero for self[i] and a positive value for self[j]. In find-any mode, method bsearch returns some element for which the block returns zero, or +nil+ if no such element is found. Examples: a = [0, 4, 7, 10, 12] a.bsearch {|element| 7 <=> element } # => 7 a.bsearch {|element| -1 <=> element } # => nil a.bsearch {|element| 5 <=> element } # => nil a.bsearch {|element| 15 <=> element } # => nil Less formally: the block is such that: - All positive-evaluating elements precede all zero-evaluating elements. - All positive-evaluating elements precede all negative-evaluating elements. - All zero-evaluating elements precede all negative-evaluating elements. These make sense as blocks in find-any mode: a = [0, 4, 7, 10, 12] a.map {|element| 7 <=> element } # => [1, 1, 0, -1, -1] a.map {|element| -1 <=> element } # => [-1, -1, -1, -1, -1] a.map {|element| 5 <=> element } # => [1, 1, -1, -1, -1] a.map {|element| 15 <=> element } # => [1, 1, 1, 1, 1] This would not make sense: a = [0, 4, 7, 10, 12] a.map {|element| element <=> 7 } # => [-1, -1, 0, 1, 1] Returns an enumerator if no block given: a = [0, 4, 7, 10, 12] a.bsearch # => # ;T;[o;= ;3I" overload;F;40;;Ü;50;)I"bsearch;T;IC;";T; @_z;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @_zo;2 ;3I"return;F;4I";T;0;5[I"Object;T; @_z;[;I"&@yield [element] @return [Object];T;0;6i;[; @_zo;= ;3I" overload;F;40;;Ü;50;)I"bsearch;T;IC;";T; @_z;>0;!F;[;[;I";T;0;6i;[; @_z;[;I"S Returns an element from +self+ selected by a binary search. +self+ should be sorted, but this is not checked. By using binary search, finds a value from this array which meets the given condition in O(log n) where +n+ is the size of the array. There are two search modes: - Find-minimum mode: the block should return +true+ or +false+. - Find-any mode: the block should return a numeric value. The block should not mix the modes by and sometimes returning +true+ or +false+ and sometimes returning a numeric value, but this is not checked. Find-Minimum Mode In find-minimum mode, the block always returns +true+ or +false+. The further requirement (though not checked) is that there are no indexes +i+ and +j+ such that: - 0 <= i < j <= self.size. - The block returns +true+ for self[i] and +false+ for self[j]. In find-minimum mode, method bsearch returns the first element for which the block returns true. Examples: a = [0, 4, 7, 10, 12] a.bsearch {|x| x >= 4 } # => 4 a.bsearch {|x| x >= 6 } # => 7 a.bsearch {|x| x >= -1 } # => 0 a.bsearch {|x| x >= 100 } # => nil Less formally: the block is such that all +false+-evaluating elements precede all +true+-evaluating elements. These make sense as blocks in find-minimum mode: a = [0, 4, 7, 10, 12] a.map {|x| x >= 4 } # => [false, true, true, true, true] a.map {|x| x >= 6 } # => [false, false, true, true, true] a.map {|x| x >= -1 } # => [true, true, true, true, true] a.map {|x| x >= 100 } # => [false, false, false, false, false] This would not make sense: a = [0, 4, 7, 10, 12] a.map {|x| x == 7 } # => [false, false, true, false, false] Find-Any Mode In find-any mode, the block always returns a numeric value. The further requirement (though not checked) is that there are no indexes +i+ and +j+ such that: - 0 <= i < j <= self.size. - The block returns a negative value for self[i] and a positive value for self[j]. - The block returns a negative value for self[i] and zero self[j]. - The block returns zero for self[i] and a positive value for self[j]. In find-any mode, method bsearch returns some element for which the block returns zero, or +nil+ if no such element is found. Examples: a = [0, 4, 7, 10, 12] a.bsearch {|element| 7 <=> element } # => 7 a.bsearch {|element| -1 <=> element } # => nil a.bsearch {|element| 5 <=> element } # => nil a.bsearch {|element| 15 <=> element } # => nil Less formally: the block is such that: - All positive-evaluating elements precede all zero-evaluating elements. - All positive-evaluating elements precede all negative-evaluating elements. - All zero-evaluating elements precede all negative-evaluating elements. These make sense as blocks in find-any mode: a = [0, 4, 7, 10, 12] a.map {|element| 7 <=> element } # => [1, 1, 0, -1, -1] a.map {|element| -1 <=> element } # => [-1, -1, -1, -1, -1] a.map {|element| 5 <=> element } # => [1, 1, -1, -1, -1] a.map {|element| 15 <=> element } # => [1, 1, 1, 1, 1] This would not make sense: a = [0, 4, 7, 10, 12] a.map {|element| element <=> 7 } # => [-1, -1, 0, 1, 1] Returns an enumerator if no block given: a = [0, 4, 7, 10, 12] a.bsearch # => # @overload bsearch @yield [element] @return [Object] @overload bsearch;T;0; @_z;!F;"o;#;$T;%iM ;&i¦ ;'@k;(I"Óstatic VALUE rb_ary_bsearch(VALUE ary) { VALUE index_result = rb_ary_bsearch_index(ary); if (FIXNUM_P(index_result)) { return rb_ary_entry(ary, FIX2LONG(index_result)); } return index_result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#bsearch_index;F;[;[[@ki¼ ;T;:bsearch_index;0;[;{;IC;"|Searches +self+ as described at method #bsearch, but returns the _index_ of the found element instead of the element itself. ;T;[o;= ;3I" overload;F;40;;0;50;)I"bsearch_index;T;IC;";T; @‡z;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @‡zo;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @‡z;[;I",@yield [element] @return [Integer, nil];T;0;6i;[; @‡zo;= ;3I" overload;F;40;;0;50;)I"bsearch_index;T;IC;";T; @‡z;>0;!F;[;[;I";T;0;6i;[; @‡z;[;I"ÚSearches +self+ as described at method #bsearch, but returns the _index_ of the found element instead of the element itself. @overload bsearch_index @yield [element] @return [Integer, nil] @overload bsearch_index;T;0; @‡z;!F;"o;#;$T;%i³ ;&iº ;'@k;(I"Kstatic VALUE rb_ary_bsearch_index(VALUE ary) { long low = 0, high = RARRAY_LEN(ary), mid; int smaller = 0, satisfied = 0; VALUE v, val; RETURN_ENUMERATOR(ary, 0, 0); while (low < high) { mid = low + ((high - low) / 2); val = rb_ary_entry(ary, mid); v = rb_yield(val); if (FIXNUM_P(v)) { if (v == INT2FIX(0)) return INT2FIX(mid); smaller = (SIGNED_VALUE)v < 0; /* Fixnum preserves its sign-bit */ } else if (v == Qtrue) { satisfied = 1; smaller = 1; } else if (v == Qfalse || v == Qnil) { smaller = 0; } else if (rb_obj_is_kind_of(v, rb_cNumeric)) { const VALUE zero = INT2FIX(0); switch (rb_cmpint(rb_funcallv(v, id_cmp, 1, &zero), v, zero)) { case 0: return INT2FIX(mid); case 1: smaller = 1; break; case -1: smaller = 0; } } else { rb_raise(rb_eTypeError, "wrong argument type %"PRIsVALUE " (must be numeric, true, false or nil)", rb_obj_class(v)); } if (smaller) { high = mid; } else { low = mid + 1; } } if (!satisfied) return Qnil; return INT2FIX(low); };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#any?;F;[[@c0;[[@kiý;T;;;;0;[;{;IC;"-Returns +true+ if any element of +self+ meets a given criterion. With no block given and no argument, returns +true+ if +self+ has any truthy element, +false+ otherwise: [nil, 0, false].any? # => true [nil, false].any? # => false [].any? # => false With a block given and no argument, calls the block with each element in +self+; returns +true+ if the block returns any truthy value, +false+ otherwise: [0, 1, 2].any? {|element| element > 1 } # => true [0, 1, 2].any? {|element| element > 2 } # => false If argument +obj+ is given, returns +true+ if +obj+.=== any element, +false+ otherwise: ['food', 'drink'].any?(/foo/) # => true ['food', 'drink'].any?(/bar/) # => false [].any?(/foo/) # => false [0, 1, 2].any?(1) # => true [0, 1, 2].any?(3) # => false Related: Enumerable#any?;T;[o;= ;3I" overload;F;40;;;;50;)I" any?;T;IC;";T; @°z;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @°z;[;I"@return [Boolean];T;0;6i;[; @°zo;= ;3I" overload;F;40;;;;50;)I" any?;T;IC;";T; @°z;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @°zo;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @°z;[;I"'@yield [element] @return [Boolean];T;0;6i;[; @°zo;= ;3I" overload;F;40;;;;50;)I"any?(obj);T;IC;";T; @°z;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @°z;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @°z;[;I"°Returns +true+ if any element of +self+ meets a given criterion. With no block given and no argument, returns +true+ if +self+ has any truthy element, +false+ otherwise: [nil, 0, false].any? # => true [nil, false].any? # => false [].any? # => false With a block given and no argument, calls the block with each element in +self+; returns +true+ if the block returns any truthy value, +false+ otherwise: [0, 1, 2].any? {|element| element > 1 } # => true [0, 1, 2].any? {|element| element > 2 } # => false If argument +obj+ is given, returns +true+ if +obj+.=== any element, +false+ otherwise: ['food', 'drink'].any?(/foo/) # => true ['food', 'drink'].any?(/bar/) # => false [].any?(/foo/) # => false [0, 1, 2].any?(1) # => true [0, 1, 2].any?(3) # => false Related: Enumerable#any? @overload any? @return [Boolean] @overload any? @yield [element] @return [Boolean] @overload any?(obj) @return [Boolean];T;0; @°z;!F;"o;#;$T;%iß;&iý;6i;'@k;(I"¬static VALUE rb_ary_any_p(int argc, VALUE *argv, VALUE ary) { long i, len = RARRAY_LEN(ary); rb_check_arity(argc, 0, 1); if (!len) return Qfalse; if (argc) { if (rb_block_given_p()) { rb_warn("given block not used"); } for (i = 0; i < RARRAY_LEN(ary); ++i) { if (RTEST(rb_funcall(argv[0], idEqq, 1, RARRAY_AREF(ary, i)))) return Qtrue; } } else if (!rb_block_given_p()) { for (i = 0; i < len; ++i) { if (RTEST(RARRAY_AREF(ary, i))) return Qtrue; } } else { for (i = 0; i < RARRAY_LEN(ary); ++i) { if (RTEST(rb_yield(RARRAY_AREF(ary, i)))) return Qtrue; } } return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#all?;F;[[@c0;[[@ki6;T;;:;0;[;{;IC;"9Returns +true+ if all elements of +self+ meet a given criterion. With no block given and no argument, returns +true+ if +self+ contains only truthy elements, +false+ otherwise: [0, 1, :foo].all? # => true [0, nil, 2].all? # => false [].all? # => true With a block given and no argument, calls the block with each element in +self+; returns +true+ if the block returns only truthy values, +false+ otherwise: [0, 1, 2].all? { |element| element < 3 } # => true [0, 1, 2].all? { |element| element < 2 } # => false If argument +obj+ is given, returns +true+ if obj.=== every element, +false+ otherwise: ['food', 'fool', 'foot'].all?(/foo/) # => true ['food', 'drink'].all?(/bar/) # => false [].all?(/foo/) # => true [0, 0, 0].all?(0) # => true [0, 1, 2].all?(1) # => false Related: Enumerable#all?;T;[o;= ;3I" overload;F;40;;:;50;)I" all?;T;IC;";T; @íz;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @íz;[;I"@return [Boolean];T;0;6i;[; @ízo;= ;3I" overload;F;40;;:;50;)I" all?;T;IC;";T; @íz;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @ízo;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @íz;[;I"'@yield [element] @return [Boolean];T;0;6i;[; @ízo;= ;3I" overload;F;40;;:;50;)I"all?(obj);T;IC;";T; @íz;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @íz;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @íz;[;I"¼Returns +true+ if all elements of +self+ meet a given criterion. With no block given and no argument, returns +true+ if +self+ contains only truthy elements, +false+ otherwise: [0, 1, :foo].all? # => true [0, nil, 2].all? # => false [].all? # => true With a block given and no argument, calls the block with each element in +self+; returns +true+ if the block returns only truthy values, +false+ otherwise: [0, 1, 2].all? { |element| element < 3 } # => true [0, 1, 2].all? { |element| element < 2 } # => false If argument +obj+ is given, returns +true+ if obj.=== every element, +false+ otherwise: ['food', 'fool', 'foot'].all?(/foo/) # => true ['food', 'drink'].all?(/bar/) # => false [].all?(/foo/) # => true [0, 0, 0].all?(0) # => true [0, 1, 2].all?(1) # => false Related: Enumerable#all? @overload all? @return [Boolean] @overload all? @yield [element] @return [Boolean] @overload all?(obj) @return [Boolean];T;0; @íz;!F;"o;#;$T;%i;&i6;6i;'@k;(I"Ústatic VALUE rb_ary_all_p(int argc, VALUE *argv, VALUE ary) { long i, len = RARRAY_LEN(ary); rb_check_arity(argc, 0, 1); if (!len) return Qtrue; if (argc) { if (rb_block_given_p()) { rb_warn("given block not used"); } for (i = 0; i < RARRAY_LEN(ary); ++i) { if (!RTEST(rb_funcall(argv[0], idEqq, 1, RARRAY_AREF(ary, i)))) return Qfalse; } } else if (!rb_block_given_p()) { for (i = 0; i < len; ++i) { if (!RTEST(RARRAY_AREF(ary, i))) return Qfalse; } } else { for (i = 0; i < RARRAY_LEN(ary); ++i) { if (!RTEST(rb_yield(RARRAY_AREF(ary, i)))) return Qfalse; } } return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#none?;F;[[@c0;[[@kio;T;;=;0;[;{;IC;"0Returns +true+ if no element of +self+ meet a given criterion. With no block given and no argument, returns +true+ if +self+ has no truthy elements, +false+ otherwise: [nil, false].none? # => true [nil, 0, false].none? # => false [].none? # => true With a block given and no argument, calls the block with each element in +self+; returns +true+ if the block returns no truthy value, +false+ otherwise: [0, 1, 2].none? {|element| element > 3 } # => true [0, 1, 2].none? {|element| element > 1 } # => false If argument +obj+ is given, returns +true+ if obj.=== no element, +false+ otherwise: ['food', 'drink'].none?(/bar/) # => true ['food', 'drink'].none?(/foo/) # => false [].none?(/foo/) # => true [0, 1, 2].none?(3) # => true [0, 1, 2].none?(1) # => false Related: Enumerable#none?;T;[o;= ;3I" overload;F;40;;=;50;)I" none?;T;IC;";T; @*{;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @*{;[;I"@return [Boolean];T;0;6i;[; @*{o;= ;3I" overload;F;40;;=;50;)I" none?;T;IC;";T; @*{;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @*{o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @*{;[;I"'@yield [element] @return [Boolean];T;0;6i;[; @*{o;= ;3I" overload;F;40;;=;50;)I"none?(obj);T;IC;";T; @*{;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @*{;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @*{;[;I"¶Returns +true+ if no element of +self+ meet a given criterion. With no block given and no argument, returns +true+ if +self+ has no truthy elements, +false+ otherwise: [nil, false].none? # => true [nil, 0, false].none? # => false [].none? # => true With a block given and no argument, calls the block with each element in +self+; returns +true+ if the block returns no truthy value, +false+ otherwise: [0, 1, 2].none? {|element| element > 3 } # => true [0, 1, 2].none? {|element| element > 1 } # => false If argument +obj+ is given, returns +true+ if obj.=== no element, +false+ otherwise: ['food', 'drink'].none?(/bar/) # => true ['food', 'drink'].none?(/foo/) # => false [].none?(/foo/) # => true [0, 1, 2].none?(3) # => true [0, 1, 2].none?(1) # => false Related: Enumerable#none? @overload none? @return [Boolean] @overload none? @yield [element] @return [Boolean] @overload none?(obj) @return [Boolean];T;0; @*{;!F;"o;#;$T;%iR;&io;6i;'@k;(I"Østatic VALUE rb_ary_none_p(int argc, VALUE *argv, VALUE ary) { long i, len = RARRAY_LEN(ary); rb_check_arity(argc, 0, 1); if (!len) return Qtrue; if (argc) { if (rb_block_given_p()) { rb_warn("given block not used"); } for (i = 0; i < RARRAY_LEN(ary); ++i) { if (RTEST(rb_funcall(argv[0], idEqq, 1, RARRAY_AREF(ary, i)))) return Qfalse; } } else if (!rb_block_given_p()) { for (i = 0; i < len; ++i) { if (RTEST(RARRAY_AREF(ary, i))) return Qfalse; } } else { for (i = 0; i < RARRAY_LEN(ary); ++i) { if (RTEST(rb_yield(RARRAY_AREF(ary, i)))) return Qfalse; } } return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#one?;F;[[@c0;[[@ki¬;T;;<;0;[;{;IC;"µReturns +true+ if exactly one element of +self+ meets a given criterion. With no block given and no argument, returns +true+ if +self+ has exactly one truthy element, +false+ otherwise: [nil, 0].one? # => true [0, 0].one? # => false [nil, nil].one? # => false [].one? # => false With a block given and no argument, calls the block with each element in +self+; returns +true+ if the block a truthy value for exactly one element, +false+ otherwise: [0, 1, 2].one? {|element| element > 0 } # => false [0, 1, 2].one? {|element| element > 1 } # => true [0, 1, 2].one? {|element| element > 2 } # => false If argument +obj+ is given, returns +true+ if obj.=== exactly one element, +false+ otherwise: [0, 1, 2].one?(0) # => true [0, 0, 1].one?(0) # => false [1, 1, 2].one?(0) # => false ['food', 'drink'].one?(/bar/) # => false ['food', 'drink'].one?(/foo/) # => true [].one?(/foo/) # => false Related: Enumerable#one?;T;[o;= ;3I" overload;F;40;;<;50;)I" one?;T;IC;";T; @g{;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @g{;[;I"@return [Boolean];T;0;6i;[; @g{o;= ;3I" overload;F;40;;<;50;)I" one?;T;IC;";T; @g{;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @g{o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @g{;[;I"'@yield [element] @return [Boolean];T;0;6i;[; @g{o;= ;3I" overload;F;40;;<;50;)I"one?(obj);T;IC;";T; @g{;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @g{;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @g{;[;I"8Returns +true+ if exactly one element of +self+ meets a given criterion. With no block given and no argument, returns +true+ if +self+ has exactly one truthy element, +false+ otherwise: [nil, 0].one? # => true [0, 0].one? # => false [nil, nil].one? # => false [].one? # => false With a block given and no argument, calls the block with each element in +self+; returns +true+ if the block a truthy value for exactly one element, +false+ otherwise: [0, 1, 2].one? {|element| element > 0 } # => false [0, 1, 2].one? {|element| element > 1 } # => true [0, 1, 2].one? {|element| element > 2 } # => false If argument +obj+ is given, returns +true+ if obj.=== exactly one element, +false+ otherwise: [0, 1, 2].one?(0) # => true [0, 0, 1].one?(0) # => false [1, 1, 2].one?(0) # => false ['food', 'drink'].one?(/bar/) # => false ['food', 'drink'].one?(/foo/) # => true [].one?(/foo/) # => false Related: Enumerable#one? @overload one? @return [Boolean] @overload one? @yield [element] @return [Boolean] @overload one?(obj) @return [Boolean];T;0; @g{;!F;"o;#;$T;%i‹;&i¬;6i;'@k;(I"Østatic VALUE rb_ary_one_p(int argc, VALUE *argv, VALUE ary) { long i, len = RARRAY_LEN(ary); VALUE result = Qfalse; rb_check_arity(argc, 0, 1); if (!len) return Qfalse; if (argc) { if (rb_block_given_p()) { rb_warn("given block not used"); } for (i = 0; i < RARRAY_LEN(ary); ++i) { if (RTEST(rb_funcall(argv[0], idEqq, 1, RARRAY_AREF(ary, i)))) { if (result) return Qfalse; result = Qtrue; } } } else if (!rb_block_given_p()) { for (i = 0; i < len; ++i) { if (RTEST(RARRAY_AREF(ary, i))) { if (result) return Qfalse; result = Qtrue; } } } else { for (i = 0; i < RARRAY_LEN(ary); ++i) { if (RTEST(rb_yield(RARRAY_AREF(ary, i)))) { if (result) return Qfalse; result = Qtrue; } } } return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#dig;F;[[@c0;[[@kiã;T;;Ô;0;[;{;IC;"|Finds and returns the object in nested objects that is specified by +index+ and +identifiers+. The nested objects may be instances of various classes. See {Dig Methods}[rdoc-ref:doc/dig_methods.rdoc]. Examples: a = [:foo, [:bar, :baz, [:bat, :bam]]] a.dig(1) # => [:bar, :baz, [:bat, :bam]] a.dig(1, 2) # => [:bat, :bam] a.dig(1, 2, 0) # => :bat a.dig(1, 2, 3) # => nil ;T;[o;= ;3I" overload;F;40;;Ô;50;)I"dig(index, *identifiers);T;IC;";T; @¤{;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @¤{;[;I"@return [Object];T;0;6i;[[I" index;T0[I"*identifiers;T0; @¤{;[;I"´Finds and returns the object in nested objects that is specified by +index+ and +identifiers+. The nested objects may be instances of various classes. See {Dig Methods}[rdoc-ref:doc/dig_methods.rdoc]. Examples: a = [:foo, [:bar, :baz, [:bat, :bam]]] a.dig(1) # => [:bar, :baz, [:bat, :bam]] a.dig(1, 2) # => [:bat, :bam] a.dig(1, 2, 0) # => :bat a.dig(1, 2, 3) # => nil @overload dig(index, *identifiers) @return [Object];T;0; @¤{;!F;"o;#;$T;%iÒ;&ià;'@k;(I"ìstatic VALUE rb_ary_dig(int argc, VALUE *argv, VALUE self) { rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS); self = rb_ary_at(self, *argv); if (!--argc) return self; ++argv; return rb_obj_dig(argc, argv, self, Qnil); };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#sum;F;[[@c0;[[@ki;T;;W;0;[;{;IC;"¥When no block is given, returns the object equivalent to: sum = init array.each {|element| sum += element } sum For example, [e1, e2, e3].sum returns init + e1 + e2 + e3. Examples: a = [0, 1, 2, 3] a.sum # => 6 a.sum(100) # => 106 The elements need not be numeric, but must be +-compatible with each other and with +init+: a = ['abc', 'def', 'ghi'] a.sum('jkl') # => "jklabcdefghi" When a block is given, it is called with each element and the block's return value (instead of the element itself) is used as the addend: a = ['zero', 1, :two] s = a.sum('Coerced and concatenated: ') {|element| element.to_s } s # => "Coerced and concatenated: zero1two" Notes: - Array#join and Array#flatten may be faster than Array#sum for an \Array of Strings or an \Array of Arrays. - Array#sum method may not respect method redefinition of "+" methods such as Integer#+. ;T;[o;= ;3I" overload;F;40;;W;50;)I"sum(init = 0);T;IC;";T; @Ä{;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @Ä{;[;I"@return [Object];T;0;6i;[[I" init;TI"0;T; @Ä{o;= ;3I" overload;F;40;;W;50;)I"sum(init = 0);T;IC;";T; @Ä{;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"element;T; @Ä{o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @Ä{;[;I"&@yield [element] @return [Object];T;0;6i;[[I" init;TI"0;T; @Ä{;[;I" When no block is given, returns the object equivalent to: sum = init array.each {|element| sum += element } sum For example, [e1, e2, e3].sum returns init + e1 + e2 + e3. Examples: a = [0, 1, 2, 3] a.sum # => 6 a.sum(100) # => 106 The elements need not be numeric, but must be +-compatible with each other and with +init+: a = ['abc', 'def', 'ghi'] a.sum('jkl') # => "jklabcdefghi" When a block is given, it is called with each element and the block's return value (instead of the element itself) is used as the addend: a = ['zero', 1, :two] s = a.sum('Coerced and concatenated: ') {|element| element.to_s } s # => "Coerced and concatenated: zero1two" Notes: - Array#join and Array#flatten may be faster than Array#sum for an \Array of Strings or an \Array of Arrays. - Array#sum method may not respect method redefinition of "+" methods such as Integer#+. @overload sum(init = 0) @return [Object] @overload sum(init = 0) @yield [element] @return [Object];T;0; @Ä{;!F;"o;#;$T;%iû;&i;'@k;(I"Ã static VALUE rb_ary_sum(int argc, VALUE *argv, VALUE ary) { VALUE e, v, r; long i, n; int block_given; v = (rb_check_arity(argc, 0, 1) ? argv[0] : LONG2FIX(0)); block_given = rb_block_given_p(); if (RARRAY_LEN(ary) == 0) return v; n = 0; r = Qundef; for (i = 0; i < RARRAY_LEN(ary); i++) { e = RARRAY_AREF(ary, i); if (block_given) e = rb_yield(e); if (FIXNUM_P(e)) { n += FIX2LONG(e); /* should not overflow long type */ if (!FIXABLE(n)) { v = rb_big_plus(LONG2NUM(n), v); n = 0; } } else if (RB_TYPE_P(e, T_BIGNUM)) v = rb_big_plus(e, v); else if (RB_TYPE_P(e, T_RATIONAL)) { if (r == Qundef) r = e; else r = rb_rational_plus(r, e); } else goto not_exact; } v = finish_exact_sum(n, r, v, argc!=0); return v; not_exact: v = finish_exact_sum(n, r, v, i!=0); if (RB_FLOAT_TYPE_P(e)) { /* * Kahan-Babuska balancing compensated summation algorithm * See https://link.springer.com/article/10.1007/s00607-005-0139-x */ double f, c; double x, t; f = NUM2DBL(v); c = 0.0; goto has_float_value; for (; i < RARRAY_LEN(ary); i++) { e = RARRAY_AREF(ary, i); if (block_given) e = rb_yield(e); if (RB_FLOAT_TYPE_P(e)) has_float_value: x = RFLOAT_VALUE(e); else if (FIXNUM_P(e)) x = FIX2LONG(e); else if (RB_TYPE_P(e, T_BIGNUM)) x = rb_big2dbl(e); else if (RB_TYPE_P(e, T_RATIONAL)) x = rb_num2dbl(e); else goto not_float; if (isnan(f)) continue; if (isnan(x)) { f = x; continue; } if (isinf(x)) { if (isinf(f) && signbit(x) != signbit(f)) f = NAN; else f = x; continue; } if (isinf(f)) continue; t = f + x; if (fabs(f) >= fabs(x)) c += ((f - t) + x); else c += ((x - t) + f); f = t; } f += c; return DBL2NUM(f); not_float: v = DBL2NUM(f); } goto has_some_value; for (; i < RARRAY_LEN(ary); i++) { e = RARRAY_AREF(ary, i); if (block_given) e = rb_yield(e); has_some_value: v = rb_funcall(v, idPLUS, 1, e); } return v; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#deconstruct;F;[;[[@kiŠ;T;:deconstruct;0;[;{;IC;";T;[;[;@|;0; @ø{;'@k;(I"Cstatic VALUE rb_ary_deconstruct(VALUE ary) { return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Array#__resize__;F;[[I"len;T0;[[I"%ext/-test-/array/resize/resize.c;Ti;T;:__resize__;0;[;{;IC;";T;[;[;@|;0; @|;'@k;(I"mstatic VALUE ary_resize(VALUE ary, VALUE len) { rb_ary_resize(ary, NUM2LONG(len)); return ary; };T;)I"static VALUE;T;*T;A@k;BIC;[;A@k;CIC;[o;L;M0;N0;O0;;;'@;Q@(;R0;A@k;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@±k;r@ƒn;@÷n;;I[;[[@ki”;F;;»;;K;;;[;{;IC;"’An \Array is an ordered, integer-indexed collection of objects, called _elements_. Any object may be an \Array element. == \Array Indexes \Array indexing starts at 0, as in C or Java. A positive index is an offset from the first element: - Index 0 indicates the first element. - Index 1 indicates the second element. - ... A negative index is an offset, backwards, from the end of the array: - Index -1 indicates the last element. - Index -2 indicates the next-to-last element. - ... A non-negative index is in range if it is smaller than the size of the array. For a 3-element array: - Indexes 0 through 2 are in range. - Index 3 is out of range. A negative index is in range if its absolute value is not larger than the size of the array. For a 3-element array: - Indexes -1 through -3 are in range. - Index -4 is out of range. == Creating Arrays A new array can be created by using the literal constructor []. Arrays can contain different types of objects. For example, the array below contains an Integer, a String and a Float: ary = [1, "two", 3.0] #=> [1, "two", 3.0] An array can also be created by explicitly calling Array.new with zero, one (the initial size of the Array) or two arguments (the initial size and a default object). ary = Array.new #=> [] Array.new(3) #=> [nil, nil, nil] Array.new(3, true) #=> [true, true, true] Note that the second argument populates the array with references to the same object. Therefore, it is only recommended in cases when you need to instantiate arrays with natively immutable objects such as Symbols, numbers, true or false. To create an array with separate objects a block can be passed instead. This method is safe to use with mutable objects such as hashes, strings or other arrays: Array.new(4) {Hash.new} #=> [{}, {}, {}, {}] Array.new(4) {|i| i.to_s } #=> ["0", "1", "2", "3"] This is also a quick way to build up multi-dimensional arrays: empty_table = Array.new(3) {Array.new(3)} #=> [[nil, nil, nil], [nil, nil, nil], [nil, nil, nil]] An array can also be created by using the Array() method, provided by Kernel, which tries to call #to_ary, then #to_a on its argument. Array({:a => "a", :b => "b"}) #=> [[:a, "a"], [:b, "b"]] == Example Usage In addition to the methods it mixes in through the Enumerable module, the Array class has proprietary methods for accessing, searching and otherwise manipulating arrays. Some of the more common ones are illustrated below. == Accessing Elements Elements in an array can be retrieved using the Array#[] method. It can take a single integer argument (a numeric index), a pair of arguments (start and length) or a range. Negative indices start counting from the end, with -1 being the last element. arr = [1, 2, 3, 4, 5, 6] arr[2] #=> 3 arr[100] #=> nil arr[-3] #=> 4 arr[2, 3] #=> [3, 4, 5] arr[1..4] #=> [2, 3, 4, 5] arr[1..-3] #=> [2, 3, 4] Another way to access a particular array element is by using the #at method arr.at(0) #=> 1 The #slice method works in an identical manner to Array#[]. To raise an error for indices outside of the array bounds or else to provide a default value when that happens, you can use #fetch. arr = ['a', 'b', 'c', 'd', 'e', 'f'] arr.fetch(100) #=> IndexError: index 100 outside of array bounds: -6...6 arr.fetch(100, "oops") #=> "oops" The special methods #first and #last will return the first and last elements of an array, respectively. arr.first #=> 1 arr.last #=> 6 To return the first +n+ elements of an array, use #take arr.take(3) #=> [1, 2, 3] #drop does the opposite of #take, by returning the elements after +n+ elements have been dropped: arr.drop(3) #=> [4, 5, 6] == Obtaining Information about an Array Arrays keep track of their own length at all times. To query an array about the number of elements it contains, use #length, #count or #size. browsers = ['Chrome', 'Firefox', 'Safari', 'Opera', 'IE'] browsers.length #=> 5 browsers.count #=> 5 To check whether an array contains any elements at all browsers.empty? #=> false To check whether a particular item is included in the array browsers.include?('Konqueror') #=> false == Adding Items to Arrays Items can be added to the end of an array by using either #push or #<< arr = [1, 2, 3, 4] arr.push(5) #=> [1, 2, 3, 4, 5] arr << 6 #=> [1, 2, 3, 4, 5, 6] #unshift will add a new item to the beginning of an array. arr.unshift(0) #=> [0, 1, 2, 3, 4, 5, 6] With #insert you can add a new element to an array at any position. arr.insert(3, 'apple') #=> [0, 1, 2, 'apple', 3, 4, 5, 6] Using the #insert method, you can also insert multiple values at once: arr.insert(3, 'orange', 'pear', 'grapefruit') #=> [0, 1, 2, "orange", "pear", "grapefruit", "apple", 3, 4, 5, 6] == Removing Items from an Array The method #pop removes the last element in an array and returns it: arr = [1, 2, 3, 4, 5, 6] arr.pop #=> 6 arr #=> [1, 2, 3, 4, 5] To retrieve and at the same time remove the first item, use #shift: arr.shift #=> 1 arr #=> [2, 3, 4, 5] To delete an element at a particular index: arr.delete_at(2) #=> 4 arr #=> [2, 3, 5] To delete a particular element anywhere in an array, use #delete: arr = [1, 2, 2, 3] arr.delete(2) #=> 2 arr #=> [1,3] A useful method if you need to remove +nil+ values from an array is #compact: arr = ['foo', 0, nil, 'bar', 7, 'baz', nil] arr.compact #=> ['foo', 0, 'bar', 7, 'baz'] arr #=> ['foo', 0, nil, 'bar', 7, 'baz', nil] arr.compact! #=> ['foo', 0, 'bar', 7, 'baz'] arr #=> ['foo', 0, 'bar', 7, 'baz'] Another common need is to remove duplicate elements from an array. It has the non-destructive #uniq, and destructive method #uniq! arr = [2, 5, 6, 556, 6, 6, 8, 9, 0, 123, 556] arr.uniq #=> [2, 5, 6, 556, 8, 9, 0, 123] == Iterating over Arrays Like all classes that include the Enumerable module, Array has an each method, which defines what elements should be iterated over and how. In case of Array's #each, all elements in the Array instance are yielded to the supplied block in sequence. Note that this operation leaves the array unchanged. arr = [1, 2, 3, 4, 5] arr.each {|a| print a -= 10, " "} # prints: -9 -8 -7 -6 -5 #=> [1, 2, 3, 4, 5] Another sometimes useful iterator is #reverse_each which will iterate over the elements in the array in reverse order. words = %w[first second third fourth fifth sixth] str = "" words.reverse_each {|word| str += "#{word} "} p str #=> "sixth fifth fourth third second first " The #map method can be used to create a new array based on the original array, but with the values modified by the supplied block: arr.map {|a| 2*a} #=> [2, 4, 6, 8, 10] arr #=> [1, 2, 3, 4, 5] arr.map! {|a| a**2} #=> [1, 4, 9, 16, 25] arr #=> [1, 4, 9, 16, 25] == Selecting Items from an Array Elements can be selected from an array according to criteria defined in a block. The selection can happen in a destructive or a non-destructive manner. While the destructive operations will modify the array they were called on, the non-destructive methods usually return a new array with the selected elements, but leave the original array unchanged. === Non-destructive Selection arr = [1, 2, 3, 4, 5, 6] arr.select {|a| a > 3} #=> [4, 5, 6] arr.reject {|a| a < 3} #=> [3, 4, 5, 6] arr.drop_while {|a| a < 4} #=> [4, 5, 6] arr #=> [1, 2, 3, 4, 5, 6] === Destructive Selection #select! and #reject! are the corresponding destructive methods to #select and #reject Similar to #select vs. #reject, #delete_if and #keep_if have the exact opposite result when supplied with the same block: arr.delete_if {|a| a < 4} #=> [4, 5, 6] arr #=> [4, 5, 6] arr = [1, 2, 3, 4, 5, 6] arr.keep_if {|a| a < 4} #=> [1, 2, 3] arr #=> [1, 2, 3] ;T;[;[;I"“An \Array is an ordered, integer-indexed collection of objects, called _elements_. Any object may be an \Array element. == \Array Indexes \Array indexing starts at 0, as in C or Java. A positive index is an offset from the first element: - Index 0 indicates the first element. - Index 1 indicates the second element. - ... A negative index is an offset, backwards, from the end of the array: - Index -1 indicates the last element. - Index -2 indicates the next-to-last element. - ... A non-negative index is in range if it is smaller than the size of the array. For a 3-element array: - Indexes 0 through 2 are in range. - Index 3 is out of range. A negative index is in range if its absolute value is not larger than the size of the array. For a 3-element array: - Indexes -1 through -3 are in range. - Index -4 is out of range. == Creating Arrays A new array can be created by using the literal constructor []. Arrays can contain different types of objects. For example, the array below contains an Integer, a String and a Float: ary = [1, "two", 3.0] #=> [1, "two", 3.0] An array can also be created by explicitly calling Array.new with zero, one (the initial size of the Array) or two arguments (the initial size and a default object). ary = Array.new #=> [] Array.new(3) #=> [nil, nil, nil] Array.new(3, true) #=> [true, true, true] Note that the second argument populates the array with references to the same object. Therefore, it is only recommended in cases when you need to instantiate arrays with natively immutable objects such as Symbols, numbers, true or false. To create an array with separate objects a block can be passed instead. This method is safe to use with mutable objects such as hashes, strings or other arrays: Array.new(4) {Hash.new} #=> [{}, {}, {}, {}] Array.new(4) {|i| i.to_s } #=> ["0", "1", "2", "3"] This is also a quick way to build up multi-dimensional arrays: empty_table = Array.new(3) {Array.new(3)} #=> [[nil, nil, nil], [nil, nil, nil], [nil, nil, nil]] An array can also be created by using the Array() method, provided by Kernel, which tries to call #to_ary, then #to_a on its argument. Array({:a => "a", :b => "b"}) #=> [[:a, "a"], [:b, "b"]] == Example Usage In addition to the methods it mixes in through the Enumerable module, the Array class has proprietary methods for accessing, searching and otherwise manipulating arrays. Some of the more common ones are illustrated below. == Accessing Elements Elements in an array can be retrieved using the Array#[] method. It can take a single integer argument (a numeric index), a pair of arguments (start and length) or a range. Negative indices start counting from the end, with -1 being the last element. arr = [1, 2, 3, 4, 5, 6] arr[2] #=> 3 arr[100] #=> nil arr[-3] #=> 4 arr[2, 3] #=> [3, 4, 5] arr[1..4] #=> [2, 3, 4, 5] arr[1..-3] #=> [2, 3, 4] Another way to access a particular array element is by using the #at method arr.at(0) #=> 1 The #slice method works in an identical manner to Array#[]. To raise an error for indices outside of the array bounds or else to provide a default value when that happens, you can use #fetch. arr = ['a', 'b', 'c', 'd', 'e', 'f'] arr.fetch(100) #=> IndexError: index 100 outside of array bounds: -6...6 arr.fetch(100, "oops") #=> "oops" The special methods #first and #last will return the first and last elements of an array, respectively. arr.first #=> 1 arr.last #=> 6 To return the first +n+ elements of an array, use #take arr.take(3) #=> [1, 2, 3] #drop does the opposite of #take, by returning the elements after +n+ elements have been dropped: arr.drop(3) #=> [4, 5, 6] == Obtaining Information about an Array Arrays keep track of their own length at all times. To query an array about the number of elements it contains, use #length, #count or #size. browsers = ['Chrome', 'Firefox', 'Safari', 'Opera', 'IE'] browsers.length #=> 5 browsers.count #=> 5 To check whether an array contains any elements at all browsers.empty? #=> false To check whether a particular item is included in the array browsers.include?('Konqueror') #=> false == Adding Items to Arrays Items can be added to the end of an array by using either #push or #<< arr = [1, 2, 3, 4] arr.push(5) #=> [1, 2, 3, 4, 5] arr << 6 #=> [1, 2, 3, 4, 5, 6] #unshift will add a new item to the beginning of an array. arr.unshift(0) #=> [0, 1, 2, 3, 4, 5, 6] With #insert you can add a new element to an array at any position. arr.insert(3, 'apple') #=> [0, 1, 2, 'apple', 3, 4, 5, 6] Using the #insert method, you can also insert multiple values at once: arr.insert(3, 'orange', 'pear', 'grapefruit') #=> [0, 1, 2, "orange", "pear", "grapefruit", "apple", 3, 4, 5, 6] == Removing Items from an Array The method #pop removes the last element in an array and returns it: arr = [1, 2, 3, 4, 5, 6] arr.pop #=> 6 arr #=> [1, 2, 3, 4, 5] To retrieve and at the same time remove the first item, use #shift: arr.shift #=> 1 arr #=> [2, 3, 4, 5] To delete an element at a particular index: arr.delete_at(2) #=> 4 arr #=> [2, 3, 5] To delete a particular element anywhere in an array, use #delete: arr = [1, 2, 2, 3] arr.delete(2) #=> 2 arr #=> [1,3] A useful method if you need to remove +nil+ values from an array is #compact: arr = ['foo', 0, nil, 'bar', 7, 'baz', nil] arr.compact #=> ['foo', 0, 'bar', 7, 'baz'] arr #=> ['foo', 0, nil, 'bar', 7, 'baz', nil] arr.compact! #=> ['foo', 0, 'bar', 7, 'baz'] arr #=> ['foo', 0, 'bar', 7, 'baz'] Another common need is to remove duplicate elements from an array. It has the non-destructive #uniq, and destructive method #uniq! arr = [2, 5, 6, 556, 6, 6, 8, 9, 0, 123, 556] arr.uniq #=> [2, 5, 6, 556, 8, 9, 0, 123] == Iterating over Arrays Like all classes that include the Enumerable module, Array has an each method, which defines what elements should be iterated over and how. In case of Array's #each, all elements in the Array instance are yielded to the supplied block in sequence. Note that this operation leaves the array unchanged. arr = [1, 2, 3, 4, 5] arr.each {|a| print a -= 10, " "} # prints: -9 -8 -7 -6 -5 #=> [1, 2, 3, 4, 5] Another sometimes useful iterator is #reverse_each which will iterate over the elements in the array in reverse order. words = %w[first second third fourth fifth sixth] str = "" words.reverse_each {|word| str += "#{word} "} p str #=> "sixth fifth fourth third second first " The #map method can be used to create a new array based on the original array, but with the values modified by the supplied block: arr.map {|a| 2*a} #=> [2, 4, 6, 8, 10] arr #=> [1, 2, 3, 4, 5] arr.map! {|a| a**2} #=> [1, 4, 9, 16, 25] arr #=> [1, 4, 9, 16, 25] == Selecting Items from an Array Elements can be selected from an array according to criteria defined in a block. The selection can happen in a destructive or a non-destructive manner. While the destructive operations will modify the array they were called on, the non-destructive methods usually return a new array with the selected elements, but leave the original array unchanged. === Non-destructive Selection arr = [1, 2, 3, 4, 5, 6] arr.select {|a| a > 3} #=> [4, 5, 6] arr.reject {|a| a < 3} #=> [3, 4, 5, 6] arr.drop_while {|a| a < 4} #=> [4, 5, 6] arr #=> [1, 2, 3, 4, 5, 6] === Destructive Selection #select! and #reject! are the corresponding destructive methods to #select and #reject Similar to #select vs. #reject, #delete_if and #keep_if have the exact opposite result when supplied with the same block: arr.delete_if {|a| a < 4} #=> [4, 5, 6] arr #=> [4, 5, 6] arr = [1, 2, 3, 4, 5, 6] arr.keep_if {|a| a < 4} #=> [1, 2, 3] arr #=> [1, 2, 3] ;T;0; @k;!F;"o;#;$T;%i;&iŽ;'@;I" Array;F;S@]o; ;IC;[2o;;F; ;F;;;I"Complex.rectangular;F;[[@c0;[[@t iä;T;:rectangular;0;[;{;IC;"qReturns a complex object which denotes the given rectangular form. Complex.rectangular(1, 2) #=> (1+2i) ;T;[o;= ;3I" overload;F;40;: rect;50;)I"rect(real[, imag]);T;IC;";T; @'|;>0;!F;[;[;I";T;0;6i;[[I"real[, imag];T0; @'|o;= ;3I" overload;F;40;;3;50;)I"rectangular(real[, imag]);T;IC;";T; @'|;>0;!F;[;[;I";T;0;6i;[[I"real[, imag];T0; @'|;[;I"¯Returns a complex object which denotes the given rectangular form. Complex.rectangular(1, 2) #=> (1+2i) @overload rect(real[, imag]) @overload rectangular(real[, imag]);T;0; @'|;!F;"o;#;$T;%iÛ;&iá;'@%|;(I"bstatic VALUE nucomp_s_new(int argc, VALUE *argv, VALUE klass) { VALUE real, imag; switch (rb_scan_args(argc, argv, "11", &real, &imag)) { case 1: nucomp_real_check(real); imag = ZERO; break; default: nucomp_real_check(real); nucomp_real_check(imag); break; } return nucomp_s_canonicalize_internal(klass, real, imag); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Complex.rect;F;[[@c0;[[@t iä;T;;4;0;[;{;IC;"qReturns a complex object which denotes the given rectangular form. Complex.rectangular(1, 2) #=> (1+2i) ;T;[o;= ;3I" overload;F;40;;4;50;)I"rect(real[, imag]);T;IC;";T; @J|;>0;!F;[;[;I";T;0;6i;[[I"real[, imag];T0; @J|o;= ;3I" overload;F;40;;3;50;)I"rectangular(real[, imag]);T;IC;";T; @J|;>0;!F;[;[;I";T;0;6i;[[I"real[, imag];T0; @J|;[;@F|;0; @J|;!F;"o;#;$T;%iÛ;&iá;'@%|;(I"bstatic VALUE nucomp_s_new(int argc, VALUE *argv, VALUE klass) { VALUE real, imag; switch (rb_scan_args(argc, argv, "11", &real, &imag)) { case 1: nucomp_real_check(real); imag = ZERO; break; default: nucomp_real_check(real); nucomp_real_check(imag); break; } return nucomp_s_canonicalize_internal(klass, real, imag); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Complex.polar;F;[[@c0;[[@t i¼;T;: polar;0;[;{;IC;"8Returns a complex object which denotes the given polar form. Complex.polar(3, 0) #=> (3.0+0.0i) Complex.polar(3, Math::PI/2) #=> (1.836909530733566e-16+3.0i) Complex.polar(3, Math::PI) #=> (-3.0+3.673819061467132e-16i) Complex.polar(3, -Math::PI/2) #=> (1.836909530733566e-16-3.0i) ;T;[o;= ;3I" overload;F;40;;5;50;)I"polar(abs[, arg]);T;IC;";T; @l|;>0;!F;[;[;I";T;0;6i;[[I"abs[, arg];T0; @l|;[;I"VReturns a complex object which denotes the given polar form. Complex.polar(3, 0) #=> (3.0+0.0i) Complex.polar(3, Math::PI/2) #=> (1.836909530733566e-16+3.0i) Complex.polar(3, Math::PI) #=> (-3.0+3.673819061467132e-16i) Complex.polar(3, -Math::PI/2) #=> (1.836909530733566e-16-3.0i) @overload polar(abs[, arg]);T;0; @l|;!F;"o;#;$T;%i±;&i¹;'@%|;(I"static VALUE nucomp_s_polar(int argc, VALUE *argv, VALUE klass) { VALUE abs, arg; switch (rb_scan_args(argc, argv, "11", &abs, &arg)) { case 1: nucomp_real_check(abs); return nucomp_s_new_internal(klass, abs, ZERO); default: nucomp_real_check(abs); nucomp_real_check(arg); break; } if (RB_TYPE_P(abs, T_COMPLEX)) { get_dat1(abs); abs = dat->real; } if (RB_TYPE_P(arg, T_COMPLEX)) { get_dat1(arg); arg = dat->real; } return f_complex_polar(klass, abs, arg); };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#real;F;[;[[@t iÞ;T;: real;0;[;{;IC;"XReturns the real part. Complex(7).real #=> 7 Complex(9, -4).real #=> 9 ;T;[o;= ;3I" overload;F;40;;6;50;)I" real;T;IC;";T; @…|;>0;!F;[;[;I";T;0;6i;[; @…|;[;I"iReturns the real part. Complex(7).real #=> 7 Complex(9, -4).real #=> 9 @overload real;T;0; @…|;!F;"o;#;$T;%iÕ;&iÛ;'@%|;(I"TVALUE rb_complex_real(VALUE self) { get_dat1(self); return dat->real; };T;)I" VALUE;T;*To;;F; ;;;;I"Complex#imaginary;F;[;[[@t iï;T;:imaginary;0;[;{;IC;"hReturns the imaginary part. Complex(7).imaginary #=> 0 Complex(9, -4).imaginary #=> -4 ;T;[o;= ;3I" overload;F;40;: imag;50;)I" imag;T;IC;";T; @›|;>0;!F;[;[;I";T;0;6i;[; @›|o;= ;3I" overload;F;40;;7;50;)I"imaginary;T;IC;";T; @›|;>0;!F;[;[;I";T;0;6i;[; @›|;[;I"ˆReturns the imaginary part. Complex(7).imaginary #=> 0 Complex(9, -4).imaginary #=> -4 @overload imag @overload imaginary;T;0; @›|;!F;"o;#;$T;%iå;&iì;'@%|;(I"TVALUE rb_complex_imag(VALUE self) { get_dat1(self); return dat->imag; };T;)I" VALUE;T;*To;;F; ;;;;I"Complex#imag;F;[;[[@t iï;T;;8;0;[;{;IC;"hReturns the imaginary part. Complex(7).imaginary #=> 0 Complex(9, -4).imaginary #=> -4 ;T;[o;= ;3I" overload;F;40;;8;50;)I" imag;T;IC;";T; @¹|;>0;!F;[;[;I";T;0;6i;[; @¹|o;= ;3I" overload;F;40;;7;50;)I"imaginary;T;IC;";T; @¹|;>0;!F;[;[;I";T;0;6i;[; @¹|;[;@µ|;0; @¹|;!F;"o;#;$T;%iå;&iì;'@%|;(I"TVALUE rb_complex_imag(VALUE self) { get_dat1(self); return dat->imag; };T;)I" VALUE;T;*To;;F; ;;;;I"Complex#-@;F;[;[[@t iþ;T;:-@;0;[;{;IC;"CReturns negation of the value. -Complex(1, 2) #=> (-1-2i) ;T;[o;= ;3I" overload;F;40;;;50;)I" -cmp;T;IC;";T; @Ö|;>0;!F;[;[;I";T;0;6i;[; @Ö|;[;I"TReturns negation of the value. -Complex(1, 2) #=> (-1-2i) @overload -cmp;T;0; @Ö|;!F;"o;#;$T;%iö;&iû;'@%|;(I"•VALUE rb_complex_uminus(VALUE self) { get_dat1(self); return f_complex_new2(CLASS_OF(self), f_negate(dat->real), f_negate(dat->imag)); };T;)I" VALUE;T;*To;;F; ;;;;I"Complex#+;F;[[I" other;T0;[[@t i;T;;&;0;[;{;IC;"Performs addition. Complex(2, 3) + Complex(2, 3) #=> (4+6i) Complex(900) + Complex(1) #=> (901+0i) Complex(-2, 9) + Complex(-9, 2) #=> (-11+11i) Complex(9, 8) + 4 #=> (13+8i) Complex(20, 9) + 9.8 #=> (29.8+9i) ;T;[o;= ;3I" overload;F;40;;&;50;)I"+(numeric);T;IC;";T; @ì|;>0;!F;[;[;I";T;0;6i;[[I"numeric;T0; @ì|;[;I"Performs addition. Complex(2, 3) + Complex(2, 3) #=> (4+6i) Complex(900) + Complex(1) #=> (901+0i) Complex(-2, 9) + Complex(-9, 2) #=> (-11+11i) Complex(9, 8) + 4 #=> (13+8i) Complex(20, 9) + 9.8 #=> (29.8+9i) @overload +(numeric);T;0; @ì|;!F;"o;#;$T;%i;&i;'@%|;(I"ÝVALUE rb_complex_plus(VALUE self, VALUE other) { if (RB_TYPE_P(other, T_COMPLEX)) { VALUE real, imag; get_dat2(self, other); real = f_add(adat->real, bdat->real); imag = f_add(adat->imag, bdat->imag); return f_complex_new2(CLASS_OF(self), real, imag); } if (k_numeric_p(other) && f_real_p(other)) { get_dat1(self); return f_complex_new2(CLASS_OF(self), f_add(dat->real, other), dat->imag); } return rb_num_coerce_bin(self, other, '+'); };T;)I" VALUE;T;*To;;F; ;;;;I"Complex#-;F;[[I" other;T0;[[@t i4;T;;;0;[;{;IC;"Performs subtraction. Complex(2, 3) - Complex(2, 3) #=> (0+0i) Complex(900) - Complex(1) #=> (899+0i) Complex(-2, 9) - Complex(-9, 2) #=> (7+7i) Complex(9, 8) - 4 #=> (5+8i) Complex(20, 9) - 9.8 #=> (10.2+9i) ;T;[o;= ;3I" overload;F;40;;;50;)I"-(numeric);T;IC;";T; @};>0;!F;[;[;I";T;0;6i;[[I"numeric;T0; @};[;I"Performs subtraction. Complex(2, 3) - Complex(2, 3) #=> (0+0i) Complex(900) - Complex(1) #=> (899+0i) Complex(-2, 9) - Complex(-9, 2) #=> (7+7i) Complex(9, 8) - 4 #=> (5+8i) Complex(20, 9) - 9.8 #=> (10.2+9i) @overload -(numeric);T;0; @};!F;"o;#;$T;%i(;&i1;'@%|;(I"ÞVALUE rb_complex_minus(VALUE self, VALUE other) { if (RB_TYPE_P(other, T_COMPLEX)) { VALUE real, imag; get_dat2(self, other); real = f_sub(adat->real, bdat->real); imag = f_sub(adat->imag, bdat->imag); return f_complex_new2(CLASS_OF(self), real, imag); } if (k_numeric_p(other) && f_real_p(other)) { get_dat1(self); return f_complex_new2(CLASS_OF(self), f_sub(dat->real, other), dat->imag); } return rb_num_coerce_bin(self, other, '-'); };T;)I" VALUE;T;*To;;F; ;;;;I"Complex#*;F;[[I" other;T0;[[@t ip;T;;';0;[;{;IC;"Performs multiplication. Complex(2, 3) * Complex(2, 3) #=> (-5+12i) Complex(900) * Complex(1) #=> (900+0i) Complex(-2, 9) * Complex(-9, 2) #=> (0-85i) Complex(9, 8) * 4 #=> (36+32i) Complex(20, 9) * 9.8 #=> (196.0+88.2i) ;T;[o;= ;3I" overload;F;40;;';50;)I"*(numeric);T;IC;";T; @ };>0;!F;[;[;I";T;0;6i;[[I"numeric;T0; @ };[;I")Performs multiplication. Complex(2, 3) * Complex(2, 3) #=> (-5+12i) Complex(900) * Complex(1) #=> (900+0i) Complex(-2, 9) * Complex(-9, 2) #=> (0-85i) Complex(9, 8) * 4 #=> (36+32i) Complex(20, 9) * 9.8 #=> (196.0+88.2i) @overload *(numeric);T;0; @ };!F;"o;#;$T;%id;&im;'@%|;(I"ôVALUE rb_complex_mul(VALUE self, VALUE other) { if (RB_TYPE_P(other, T_COMPLEX)) { VALUE real, imag; get_dat2(self, other); comp_mul(adat->real, adat->imag, bdat->real, bdat->imag, &real, &imag); return f_complex_new2(CLASS_OF(self), real, imag); } if (k_numeric_p(other) && f_real_p(other)) { get_dat1(self); return f_complex_new2(CLASS_OF(self), f_mul(dat->real, other), f_mul(dat->imag, other)); } return rb_num_coerce_bin(self, other, '*'); };T;)I" VALUE;T;*To;;F; ;;;;I"Complex#/;F;[[I" other;T0;[[@t i¼;T;:/;0;[;{;IC;"JPerforms division. Complex(2, 3) / Complex(2, 3) #=> ((1/1)+(0/1)*i) Complex(900) / Complex(1) #=> ((900/1)+(0/1)*i) Complex(-2, 9) / Complex(-9, 2) #=> ((36/85)-(77/85)*i) Complex(9, 8) / 4 #=> ((9/4)+(2/1)*i) Complex(20, 9) / 9.8 #=> (2.0408163265306123+0.9183673469387754i) ;T;[o;= ;3I" overload;F;40;;:;50;)I"/(numeric);T;IC;";T; @:};>0;!F;[;[;I";T;0;6i;[[I"numeric;T0; @:}o;= ;3I" overload;F;40;:quo;50;)I"quo(numeric);T;IC;";T; @:};>0;!F;[;[;I";T;0;6i;[[I"numeric;T0; @:};[;I"xPerforms division. Complex(2, 3) / Complex(2, 3) #=> ((1/1)+(0/1)*i) Complex(900) / Complex(1) #=> ((900/1)+(0/1)*i) Complex(-2, 9) / Complex(-9, 2) #=> ((36/85)-(77/85)*i) Complex(9, 8) / 4 #=> ((9/4)+(2/1)*i) Complex(20, 9) / 9.8 #=> (2.0408163265306123+0.9183673469387754i) @overload /(numeric) @overload quo(numeric);T;0; @:};!F;"o;#;$T;%i¯;&i¹;'@%|;(I"gVALUE rb_complex_div(VALUE self, VALUE other) { return f_divide(self, other, f_quo, id_quo); };T;)I" VALUE;T;*To;;F; ;;;;I"Complex#quo;F;[;[;F;;;;;K;[;{;IC;";T;[;[;@|;0; @^};'@%|;*To;;F; ;;;;I"Complex#fdiv;F;[[I" other;T0;[[@t iÌ;T;: fdiv;0;[;{;IC;"ŠPerforms division as each part is a float, never returns a float. Complex(11, 22).fdiv(3) #=> (3.6666666666666665+7.333333333333333i) ;T;[o;= ;3I" overload;F;40;;<;50;)I"fdiv(numeric);T;IC;";T; @g};>0;!F;[;[;I";T;0;6i;[[I"numeric;T0; @g};[;I"¤Performs division as each part is a float, never returns a float. Complex(11, 22).fdiv(3) #=> (3.6666666666666665+7.333333333333333i) @overload fdiv(numeric);T;0; @g};!F;"o;#;$T;%iÄ;&iÉ;'@%|;(I"mstatic VALUE nucomp_fdiv(VALUE self, VALUE other) { return f_divide(self, other, f_fdiv, id_fdiv); };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#**;F;[[I" other;T0;[[@t iá;T;:**;0;[;{;IC;"–Performs exponentiation. Complex('i') ** 2 #=> (-1+0i) Complex(-8) ** Rational(1, 3) #=> (1.0000000000000002+1.7320508075688772i) ;T;[o;= ;3I" overload;F;40;;=;50;)I"**(numeric);T;IC;";T; @};>0;!F;[;[;I";T;0;6i;[[I"numeric;T0; @};[;I"®Performs exponentiation. Complex('i') ** 2 #=> (-1+0i) Complex(-8) ** Rational(1, 3) #=> (1.0000000000000002+1.7320508075688772i) @overload **(numeric);T;0; @};!F;"o;#;$T;%iØ;&iÞ;'@%|;(I"H VALUE rb_complex_pow(VALUE self, VALUE other) { if (k_numeric_p(other) && k_exact_zero_p(other)) return f_complex_new_bang1(CLASS_OF(self), ONE); if (RB_TYPE_P(other, T_RATIONAL) && RRATIONAL(other)->den == LONG2FIX(1)) other = RRATIONAL(other)->num; /* c14n */ if (RB_TYPE_P(other, T_COMPLEX)) { get_dat1(other); if (k_exact_zero_p(dat->imag)) other = dat->real; /* c14n */ } if (RB_TYPE_P(other, T_COMPLEX)) { VALUE r, theta, nr, ntheta; get_dat1(other); r = f_abs(self); theta = f_arg(self); nr = m_exp_bang(f_sub(f_mul(dat->real, m_log_bang(r)), f_mul(dat->imag, theta))); ntheta = f_add(f_mul(theta, dat->real), f_mul(dat->imag, m_log_bang(r))); return f_complex_polar(CLASS_OF(self), nr, ntheta); } if (FIXNUM_P(other)) { long n = FIX2LONG(other); if (n == 0) { return nucomp_s_new_internal(CLASS_OF(self), ONE, ZERO); } if (n < 0) { self = f_reciprocal(self); other = rb_int_uminus(other); n = -n; } { get_dat1(self); VALUE xr = dat->real, xi = dat->imag, zr = xr, zi = xi; if (f_zero_p(xi)) { zr = rb_num_pow(zr, other); } else if (f_zero_p(xr)) { zi = rb_num_pow(zi, other); if (n & 2) zi = f_negate(zi); if (!(n & 1)) { VALUE tmp = zr; zr = zi; zi = tmp; } } else { while (--n) { long q, r; for (; q = n / 2, r = n % 2, r == 0; n = q) { VALUE tmp = f_sub(f_mul(xr, xr), f_mul(xi, xi)); xi = f_mul(f_mul(TWO, xr), xi); xr = tmp; } comp_mul(zr, zi, xr, xi, &zr, &zi); } } return nucomp_s_new_internal(CLASS_OF(self), zr, zi); } } if (k_numeric_p(other) && f_real_p(other)) { VALUE r, theta; if (RB_TYPE_P(other, T_BIGNUM)) rb_warn("in a**b, b may be too big"); r = f_abs(self); theta = f_arg(self); return f_complex_polar(CLASS_OF(self), f_expt(r, other), f_mul(theta, other)); } return rb_num_coerce_bin(self, other, id_expt); };T;)I" VALUE;T;*To;;F; ;;;;I"Complex#==;F;[[I" other;T0;[[@t iC;T;;`;0;[;{;IC;"Returns true if cmp equals object numerically. Complex(2, 3) == Complex(2, 3) #=> true Complex(5) == 5 #=> true Complex(0) == 0.0 #=> true Complex('1/3') == 0.33 #=> false Complex('1/2') == '1/2' #=> false ;T;[o;= ;3I" overload;F;40;;`;50;)I"==(object);T;IC;";T; @›};>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @›};[;I"@return [Boolean];T;0;6i;[[I"object;T0; @›};[;I"BReturns true if cmp equals object numerically. Complex(2, 3) == Complex(2, 3) #=> true Complex(5) == 5 #=> true Complex(0) == 0.0 #=> true Complex('1/3') == 0.33 #=> false Complex('1/2') == '1/2' #=> false @overload ==(object) @return [Boolean];T;0; @›};!F;"o;#;$T;%i7;&iA;'@%|;(I"šstatic VALUE nucomp_eqeq_p(VALUE self, VALUE other) { if (RB_TYPE_P(other, T_COMPLEX)) { get_dat2(self, other); return f_boolcast(f_eqeq_p(adat->real, bdat->real) && f_eqeq_p(adat->imag, bdat->imag)); } if (k_numeric_p(other) && f_real_p(other)) { get_dat1(self); return f_boolcast(f_eqeq_p(dat->real, other) && f_zero_p(dat->imag)); } return f_boolcast(f_eqeq_p(other, self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#<=>;F;[[I" other;T0;[[@t ii;T;;c;0;[;{;IC;"¡If +cmp+'s imaginary part is zero, and +object+ is also a real number (or a Complex number where the imaginary part is zero), compare the real part of +cmp+ to object. Otherwise, return nil. Complex(2, 3) <=> Complex(2, 3) #=> nil Complex(2, 3) <=> 1 #=> nil Complex(2) <=> 1 #=> 1 Complex(2) <=> 2 #=> 0 Complex(2) <=> 3 #=> -1 ;T;[o;= ;3I" overload;F;40;;c;50;)I"<=>(object);T;IC;";T; @º};>0;!F;[o;2 ;3I"return;F;4I";T;0;5[ I"0;TI"1;TI"-1;TI"nil;T; @º};[;I"@return [ 0, 1, -1, nil];T;0;6i;[[I"object;T0; @º};[;I"ÖIf +cmp+'s imaginary part is zero, and +object+ is also a real number (or a Complex number where the imaginary part is zero), compare the real part of +cmp+ to object. Otherwise, return nil. Complex(2, 3) <=> Complex(2, 3) #=> nil Complex(2, 3) <=> 1 #=> nil Complex(2) <=> 1 #=> 1 Complex(2) <=> 2 #=> 0 Complex(2) <=> 3 #=> -1 @overload <=>(object) @return [ 0, 1, -1, nil];T;0; @º};!F;"o;#;$T;%i[;&ig;'@%|;(I"¶static VALUE nucomp_cmp(VALUE self, VALUE other) { if (nucomp_real_p(self) && k_numeric_p(other)) { if (RB_TYPE_P(other, T_COMPLEX) && nucomp_real_p(other)) { get_dat2(self, other); return rb_funcall(adat->real, idCmp, 1, bdat->real); } else if (f_real_p(other)) { get_dat1(self); return rb_funcall(dat->real, idCmp, 1, other); } } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#coerce;F;[[I" other;T0;[[@t iz;T;:coerce;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @Ü};!F;"o;#;$T;%iy;&iy;'@%|;(I"Œstatic VALUE nucomp_coerce(VALUE self, VALUE other) { if (RB_TYPE_P(other, T_COMPLEX)) return rb_assoc_new(other, self); if (k_numeric_p(other) && f_real_p(other)) return rb_assoc_new(f_complex_new_bang1(CLASS_OF(self), other), self); rb_raise(rb_eTypeError, "%"PRIsVALUE" can't be coerced into %"PRIsVALUE, rb_obj_class(other), rb_obj_class(self)); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#abs;F;[;[[@t i‘;T;:abs;0;[;{;IC;"vReturns the absolute part of its polar form. Complex(-1).abs #=> 1 Complex(3.0, -4.0).abs #=> 5.0 ;T;[o;= ;3I" overload;F;40;;?;50;)I"abs;T;IC;";T; @ì};>0;!F;[;[;I";T;0;6i;[; @ì}o;= ;3I" overload;F;40;:magnitude;50;)I"magnitude;T;IC;";T; @ì};>0;!F;[;[;I";T;0;6i;[; @ì};[;I"•Returns the absolute part of its polar form. Complex(-1).abs #=> 1 Complex(3.0, -4.0).abs #=> 5.0 @overload abs @overload magnitude;T;0; @ì};!F;"o;#;$T;%i‡;&iŽ;'@%|;(I"«VALUE rb_complex_abs(VALUE self) { get_dat1(self); if (f_zero_p(dat->real)) { VALUE a = f_abs(dat->imag); if (RB_FLOAT_TYPE_P(dat->real) && !RB_FLOAT_TYPE_P(dat->imag)) a = f_to_f(a); return a; } if (f_zero_p(dat->imag)) { VALUE a = f_abs(dat->real); if (!RB_FLOAT_TYPE_P(dat->real) && RB_FLOAT_TYPE_P(dat->imag)) a = f_to_f(a); return a; } return rb_math_hypot(dat->real, dat->imag); };T;)I" VALUE;T;*To;;F; ;;;;I"Complex#magnitude;F;[;[[@t i‘;T;;@;0;[;{;IC;"vReturns the absolute part of its polar form. Complex(-1).abs #=> 1 Complex(3.0, -4.0).abs #=> 5.0 ;T;[o;= ;3I" overload;F;40;;?;50;)I"abs;T;IC;";T; @ ~;>0;!F;[;[;I";T;0;6i;[; @ ~o;= ;3I" overload;F;40;;@;50;)I"magnitude;T;IC;";T; @ ~;>0;!F;[;[;I";T;0;6i;[; @ ~;[;@~;0; @ ~;!F;"o;#;$T;%i‡;&iŽ;'@%|;(I"«VALUE rb_complex_abs(VALUE self) { get_dat1(self); if (f_zero_p(dat->real)) { VALUE a = f_abs(dat->imag); if (RB_FLOAT_TYPE_P(dat->real) && !RB_FLOAT_TYPE_P(dat->imag)) a = f_to_f(a); return a; } if (f_zero_p(dat->imag)) { VALUE a = f_abs(dat->real); if (!RB_FLOAT_TYPE_P(dat->real) && RB_FLOAT_TYPE_P(dat->imag)) a = f_to_f(a); return a; } return rb_math_hypot(dat->real, dat->imag); };T;)I" VALUE;T;*To;;F; ;;;;I"Complex#abs2;F;[;[[@t i®;T;: abs2;0;[;{;IC;"rReturns square of the absolute value. Complex(-1).abs2 #=> 1 Complex(3.0, -4.0).abs2 #=> 25.0 ;T;[o;= ;3I" overload;F;40;;A;50;)I" abs2;T;IC;";T; @'~;>0;!F;[;[;I";T;0;6i;[; @'~;[;I"~Returns square of the absolute value. Complex(-1).abs2 #=> 1 Complex(3.0, -4.0).abs2 #=> 25.0 @overload abs2;T;0; @'~;!F;"o;#;$T;%i¥;&i«;'@%|;(I"‹static VALUE nucomp_abs2(VALUE self) { get_dat1(self); return f_add(f_mul(dat->real, dat->real), f_mul(dat->imag, dat->imag)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#arg;F;[;[[@t iÀ;T;:arg;0;[;{;IC;"kReturns the angle part of its polar form. Complex.polar(3, Math::PI/2).arg #=> 1.5707963267948966 ;T;[o;= ;3I" overload;F;40;;B;50;)I"arg;T;IC;";T; @=~;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @=~;[;I"@return [Float];T;0;6i;[; @=~o;= ;3I" overload;F;40;: angle;50;)I" angle;T;IC;";T; @=~;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @=~;[;I"@return [Float];T;0;6i;[; @=~o;= ;3I" overload;F;40;: phase;50;)I" phase;T;IC;";T; @=~;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @=~;[;I"@return [Float];T;0;6i;[; @=~;[;I"ÌReturns the angle part of its polar form. Complex.polar(3, Math::PI/2).arg #=> 1.5707963267948966 @overload arg @return [Float] @overload angle @return [Float] @overload phase @return [Float];T;0; @=~;!F;"o;#;$T;%i¶;&iÀ;'@%|;(I"mVALUE rb_complex_arg(VALUE self) { get_dat1(self); return rb_math_atan2(dat->imag, dat->real); };T;)I" VALUE;T;*To;;F; ;;;;I"Complex#angle;F;[;[[@t iÀ;T;;C;0;[;{;IC;"kReturns the angle part of its polar form. Complex.polar(3, Math::PI/2).arg #=> 1.5707963267948966 ;T;[o;= ;3I" overload;F;40;;B;50;)I"arg;T;IC;";T; @r~;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @r~;[;I"@return [Float];T;0;6i;[; @r~o;= ;3I" overload;F;40;;C;50;)I" angle;T;IC;";T; @r~;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @r~;[;I"@return [Float];T;0;6i;[; @r~o;= ;3I" overload;F;40;;D;50;)I" phase;T;IC;";T; @r~;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @r~;[;I"@return [Float];T;0;6i;[; @r~;[;@n~;0; @r~;!F;"o;#;$T;%i¶;&iÀ;'@%|;(I"mVALUE rb_complex_arg(VALUE self) { get_dat1(self); return rb_math_atan2(dat->imag, dat->real); };T;)I" VALUE;T;*To;;F; ;;;;I"Complex#phase;F;[;[[@t iÀ;T;;D;0;[;{;IC;"kReturns the angle part of its polar form. Complex.polar(3, Math::PI/2).arg #=> 1.5707963267948966 ;T;[o;= ;3I" overload;F;40;;B;50;)I"arg;T;IC;";T; @¦~;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @¦~;[;I"@return [Float];T;0;6i;[; @¦~o;= ;3I" overload;F;40;;C;50;)I" angle;T;IC;";T; @¦~;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @¦~;[;I"@return [Float];T;0;6i;[; @¦~o;= ;3I" overload;F;40;;D;50;)I" phase;T;IC;";T; @¦~;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @¦~;[;I"@return [Float];T;0;6i;[; @¦~;[;@n~;0; @¦~;!F;"o;#;$T;%i¶;&iÀ;'@%|;(I"mVALUE rb_complex_arg(VALUE self) { get_dat1(self); return rb_math_atan2(dat->imag, dat->real); };T;)I" VALUE;T;*To;;F; ;;;;I"Complex#rectangular;F;[;[[@t iÐ;T;;3;0;[;{;IC;"VReturns an array; [cmp.real, cmp.imag]. Complex(1, 2).rectangular #=> [1, 2] ;T;[o;= ;3I" overload;F;40;;4;50;)I" rect;T;IC;";T; @Ú~;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @Ú~;[;I"@return [Array];T;0;6i;[; @Ú~o;= ;3I" overload;F;40;;3;50;)I"rectangular;T;IC;";T; @Ú~;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @Ú~;[;I"@return [Array];T;0;6i;[; @Ú~;[;I"œReturns an array; [cmp.real, cmp.imag]. Complex(1, 2).rectangular #=> [1, 2] @overload rect @return [Array] @overload rectangular @return [Array];T;0; @Ú~;!F;"o;#;$T;%iÇ;&iÏ;'@%|;(I"pstatic VALUE nucomp_rect(VALUE self) { get_dat1(self); return rb_assoc_new(dat->real, dat->imag); };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#rect;F;[;[[@t iÐ;T;;4;0;[;{;IC;"VReturns an array; [cmp.real, cmp.imag]. Complex(1, 2).rectangular #=> [1, 2] ;T;[o;= ;3I" overload;F;40;;4;50;)I" rect;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @;[;I"@return [Array];T;0;6i;[; @o;= ;3I" overload;F;40;;3;50;)I"rectangular;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @;[;I"@return [Array];T;0;6i;[; @;[;@þ~;0; @;!F;"o;#;$T;%iÇ;&iÏ;'@%|;(I"pstatic VALUE nucomp_rect(VALUE self) { get_dat1(self); return rb_assoc_new(dat->real, dat->imag); };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#polar;F;[;[[@t iß;T;;5;0;[;{;IC;"nReturns an array; [cmp.abs, cmp.arg]. Complex(1, 2).polar #=> [2.23606797749979, 1.1071487177940904] ;T;[o;= ;3I" overload;F;40;;5;50;)I" polar;T;IC;";T; @);>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @);[;I"@return [Array];T;0;6i;[; @);[;I"Returns an array; [cmp.abs, cmp.arg]. Complex(1, 2).polar #=> [2.23606797749979, 1.1071487177940904] @overload polar @return [Array];T;0; @);!F;"o;#;$T;%i×;&iÝ;'@%|;(I"astatic VALUE nucomp_polar(VALUE self) { return rb_assoc_new(f_abs(self), f_arg(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#conjugate;F;[;[[@t iî;T;:conjugate;0;[;{;IC;"KReturns the complex conjugate. Complex(1, 2).conjugate #=> (1-2i) ;T;[o;= ;3I" overload;F;40;: conj;50;)I" conj;T;IC;";T; @D;>0;!F;[;[;I";T;0;6i;[; @Do;= ;3I" overload;F;40;;E;50;)I"conjugate;T;IC;";T; @D;>0;!F;[;[;I";T;0;6i;[; @D;[;I"pReturns the complex conjugate. Complex(1, 2).conjugate #=> (1-2i) @overload conj @overload conjugate;T;0; @D;!F;"o;#;$T;%iå;&ië;'@%|;(I"‰VALUE rb_complex_conjugate(VALUE self) { get_dat1(self); return f_complex_new2(CLASS_OF(self), dat->real, f_negate(dat->imag)); };T;)I" VALUE;T;*To;;F; ;;;;I"Complex#conj;F;[;[[@t iî;T;;F;0;[;{;IC;"KReturns the complex conjugate. Complex(1, 2).conjugate #=> (1-2i) ;T;[o;= ;3I" overload;F;40;;F;50;)I" conj;T;IC;";T; @b;>0;!F;[;[;I";T;0;6i;[; @bo;= ;3I" overload;F;40;;E;50;)I"conjugate;T;IC;";T; @b;>0;!F;[;[;I";T;0;6i;[; @b;[;@^;0; @b;!F;"o;#;$T;%iå;&ië;'@%|;(I"‰VALUE rb_complex_conjugate(VALUE self) { get_dat1(self); return f_complex_new2(CLASS_OF(self), dat->real, f_negate(dat->imag)); };T;)I" VALUE;T;*To;;F; ;;;;I"Complex#real?;F;[;[[@t iü;T;: real?;0;[;{;IC;"EReturns false, even if the complex number has no imaginary part.;T;[o;= ;3I" overload;F;40;;š;50;)I"Complex(1).real?;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" false;T; @;[;I"@return [false];T;0;6i;[[I"1;T0; @o;= ;3I" overload;F;40;;š;50;)I"Complex(1, 2).real?;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" false;T; @;[;I"@return [false];T;0;6i;[[I"1;T0[I"2;T0; @;[;I"ŸReturns false, even if the complex number has no imaginary part. @overload Complex(1).real? @return [false] @overload Complex(1, 2).real? @return [false];T;0; @;!F;"o;#;$T;%iõ;&iû;6i;'@%|;(I"Astatic VALUE nucomp_false(VALUE self) { return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#numerator;F;[;[[@t i#;T;:numerator;0;[;{;IC;"ŸReturns the numerator. 1 2 3+4i <- numerator - + -i -> ---- 2 3 6 <- denominator c = Complex('1/2+2/3i') #=> ((1/2)+(2/3)*i) n = c.numerator #=> (3+4i) d = c.denominator #=> 6 n / d #=> ((1/2)+(2/3)*i) Complex(Rational(n.real, d), Rational(n.imag, d)) #=> ((1/2)+(2/3)*i) See denominator. ;T;[o;= ;3I" overload;F;40;;H;50;)I"numerator;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @;[;I"@return [Numeric];T;0;6i;[; @;[;I"ÉReturns the numerator. 1 2 3+4i <- numerator - + -i -> ---- 2 3 6 <- denominator c = Complex('1/2+2/3i') #=> ((1/2)+(2/3)*i) n = c.numerator #=> (3+4i) d = c.denominator #=> 6 n / d #=> ((1/2)+(2/3)*i) Complex(Rational(n.real, d), Rational(n.imag, d)) #=> ((1/2)+(2/3)*i) See denominator. @overload numerator @return [Numeric];T;0; @;!F;"o;#;$T;%i;&i!;'@%|;(I"9static VALUE nucomp_numerator(VALUE self) { VALUE cd; get_dat1(self); cd = nucomp_denominator(self); return f_complex_new2(CLASS_OF(self), f_mul(f_numerator(dat->real), f_div(cd, f_denominator(dat->real))), f_mul(f_numerator(dat->imag), f_div(cd, f_denominator(dat->imag)))); };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#denominator;F;[;[[@t i ;T;:denominator;0;[;{;IC;"WReturns the denominator (lcm of both denominator - real and imag). See numerator. ;T;[o;= ;3I" overload;F;40;;I;50;)I"denominator;T;IC;";T; @È;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @È;[;I"@return [Integer];T;0;6i;[; @È;[;I"~Returns the denominator (lcm of both denominator - real and imag). See numerator. @overload denominator @return [Integer];T;0; @È;!F;"o;#;$T;%i;&i;'@%|;(I"Šstatic VALUE nucomp_denominator(VALUE self) { get_dat1(self); return rb_lcm(f_denominator(dat->real), f_denominator(dat->imag)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#hash;F;[;[[@t iB;T;;b;0;[;{;IC;";T;[;[;@|;0; @ã;'@%|;(I"Wstatic VALUE nucomp_hash(VALUE self) { return ST2FIX(rb_complex_hash(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#eql?;F;[[I" other;T0;[[@t iI;T;;_;0;[;{;IC;":nodoc:;T;[o;2 ;3I"return;F;4@|;0;5[@~; @ï;[;I":nodoc:;T;0; @ï;!F;"o;#;$T;%iH;&iH;6i;'@%|;(I")static VALUE nucomp_eql_p(VALUE self, VALUE other) { if (RB_TYPE_P(other, T_COMPLEX)) { get_dat2(self, other); return f_boolcast((CLASS_OF(adat->real) == CLASS_OF(bdat->real)) && (CLASS_OF(adat->imag) == CLASS_OF(bdat->imag)) && f_eqeq_p(self, other)); } return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#to_s;F;[;[[@t iˆ;T;;q;0;[;{;IC;"5Returns the value as a string. Complex(2).to_s #=> "2+0i" Complex('-8/6').to_s #=> "-4/3+0i" Complex('1/2i').to_s #=> "0+1/2i" Complex(0, Float::INFINITY).to_s #=> "0+Infinity*i" Complex(Float::NAN, Float::NAN).to_s #=> "NaN+NaN*i" ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @€;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @€;[;I"@return [String];T;0;6i;[; @€;[;I"YReturns the value as a string. Complex(2).to_s #=> "2+0i" Complex('-8/6').to_s #=> "-4/3+0i" Complex('1/2i').to_s #=> "0+1/2i" Complex(0, Float::INFINITY).to_s #=> "0+Infinity*i" Complex(Float::NAN, Float::NAN).to_s #=> "NaN+NaN*i" @overload to_s @return [String];T;0; @€;!F;"o;#;$T;%i|;&i†;'@%|;(I"Sstatic VALUE nucomp_to_s(VALUE self) { return f_format(self, rb_String); };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#inspect;F;[;[[@t iš;T;;r;0;[;{;IC;"bReturns the value as a string for inspection. Complex(2).inspect #=> "(2+0i)" Complex('-8/6').inspect #=> "((-4/3)+0i)" Complex('1/2i').inspect #=> "(0+(1/2)*i)" Complex(0, Float::INFINITY).inspect #=> "(0+Infinity*i)" Complex(Float::NAN, Float::NAN).inspect #=> "(NaN+NaN*i)" ;T;[o;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @€;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @€;[;I"@return [String];T;0;6i;[; @€;[;I"‰Returns the value as a string for inspection. Complex(2).inspect #=> "(2+0i)" Complex('-8/6').inspect #=> "((-4/3)+0i)" Complex('1/2i').inspect #=> "(0+(1/2)*i)" Complex(0, Float::INFINITY).inspect #=> "(0+Infinity*i)" Complex(Float::NAN, Float::NAN).inspect #=> "(NaN+NaN*i)" @overload inspect @return [String];T;0; @€;!F;"o;#;$T;%iŽ;&i˜;'@%|;(I"µstatic VALUE nucomp_inspect(VALUE self) { VALUE s; s = rb_usascii_str_new2("("); rb_str_concat(s, f_format(self, rb_inspect)); rb_str_cat2(s, ")"); return s; };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#finite?;F;[;[[@t i¯;T;:finite?;0;[;{;IC;"kReturns +true+ if +cmp+'s real and imaginary parts are both finite numbers, otherwise returns +false+.;T;[o;= ;3I" overload;F;40;;J;50;)I"finite?;T;IC;";T; @8€;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @8€;[;I"@return [Boolean];T;0;6i;[; @8€;[;I"ŽReturns +true+ if +cmp+'s real and imaginary parts are both finite numbers, otherwise returns +false+. @overload finite? @return [Boolean];T;0; @8€;!F;"o;#;$T;%i¨;&i;6i;'@%|;(I"§static VALUE rb_complex_finite_p(VALUE self) { get_dat1(self); if (f_finite_p(dat->real) && f_finite_p(dat->imag)) { return Qtrue; } return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#infinite?;F;[;[[@t iÆ;T;:infinite?;0;[;{;IC;"ÉReturns +1+ if +cmp+'s real or imaginary part is an infinite number, otherwise returns +nil+. For example: (1+1i).infinite? #=> nil (Float::INFINITY + 1i).infinite? #=> 1;T;[o;= ;3I" overload;F;40;;K;50;)I"infinite?;T;IC;";T; @S€;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;TI"1;T; @S€;[;I"@return [nil, 1];T;0;6i;[; @S€;[;I"òReturns +1+ if +cmp+'s real or imaginary part is an infinite number, otherwise returns +nil+. For example: (1+1i).infinite? #=> nil (Float::INFINITY + 1i).infinite? #=> 1 @overload infinite? @return [nil, 1];T;0; @S€;!F;"o;#;$T;%iº;&iÄ;6i;'@%|;(I"·static VALUE rb_complex_infinite_p(VALUE self) { get_dat1(self); if (NIL_P(f_infinite_p(dat->real)) && NIL_P(f_infinite_p(dat->imag))) { return Qnil; } return ONE; };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Complex#marshal_dump;F;[;[[@t iæ;T;:marshal_dump;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @o€;!F;"o;#;$T;%iå;&iå;'@%|;(I"¯static VALUE nucomp_marshal_dump(VALUE self) { VALUE a; get_dat1(self); a = rb_assoc_new(dat->real, dat->imag); rb_copy_generic_ivar(a, self); return a; };T;)I"static VALUE;T;*To; ;IC;[o;;F; ;;;Ï;I"%Complex::compatible#marshal_load;F;[[I"a;T0;[[@t iò;T;:marshal_load;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @€;!F;"o;#;$T;%iñ;&iñ;'@}€;(I"Vstatic VALUE nucomp_marshal_load(VALUE self, VALUE a) { Check_Type(a, T_ARRAY); if (RARRAY_LEN(a) != 2) rb_raise(rb_eArgError, "marshaled complex must have an array whose length is 2 but %ld", RARRAY_LEN(a)); rb_ivar_set(self, id_i_real, RARRAY_AREF(a, 0)); rb_ivar_set(self, id_i_imag, RARRAY_AREF(a, 1)); return self; };T;)I"static VALUE;T;*T;A@}€;BIC;[;A@}€;CIC;[;A@}€;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@t ik ;F;:compatible;;K;;;[;{;IC;";T;[;[;@|;0; @}€;6i;'@%|;I"Complex::compatible;F;S@]o;;F; ;;;;I"Complex#to_i;F;[;[[@t i8;T;;–;0;[;{;IC;"ÄReturns the value as an integer if possible (the imaginary part should be exactly zero). Complex(1, 0).to_i #=> 1 Complex(1, 0.0).to_i # RangeError Complex(1, 2).to_i # RangeError ;T;[o;= ;3I" overload;F;40;;–;50;)I" to_i;T;IC;";T; @ž€;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ž€;[;I"@return [Integer];T;0;6i;[; @ž€;[;I"éReturns the value as an integer if possible (the imaginary part should be exactly zero). Complex(1, 0).to_i #=> 1 Complex(1, 0.0).to_i # RangeError Complex(1, 2).to_i # RangeError @overload to_i @return [Integer];T;0; @ž€;!F;"o;#;$T;%i-;&i6;'@%|;(I"Östatic VALUE nucomp_to_i(VALUE self) { get_dat1(self); if (!k_exact_zero_p(dat->imag)) { rb_raise(rb_eRangeError, "can't convert %"PRIsVALUE" into Integer", self); } return f_to_i(dat->real); };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#to_f;F;[;[[@t iO;T;: to_f;0;[;{;IC;"ÃReturns the value as a float if possible (the imaginary part should be exactly zero). Complex(1, 0).to_f #=> 1.0 Complex(1, 0.0).to_f # RangeError Complex(1, 2).to_f # RangeError ;T;[o;= ;3I" overload;F;40;;O;50;)I" to_f;T;IC;";T; @¹€;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @¹€;[;I"@return [Float];T;0;6i;[; @¹€;[;I"æReturns the value as a float if possible (the imaginary part should be exactly zero). Complex(1, 0).to_f #=> 1.0 Complex(1, 0.0).to_f # RangeError Complex(1, 2).to_f # RangeError @overload to_f @return [Float];T;0; @¹€;!F;"o;#;$T;%iD;&iM;'@%|;(I"Ôstatic VALUE nucomp_to_f(VALUE self) { get_dat1(self); if (!k_exact_zero_p(dat->imag)) { rb_raise(rb_eRangeError, "can't convert %"PRIsVALUE" into Float", self); } return f_to_f(dat->real); };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#to_r;F;[;[[@t ih;T;: to_r;0;[;{;IC;"ÚReturns the value as a rational if possible (the imaginary part should be exactly zero). Complex(1, 0).to_r #=> (1/1) Complex(1, 0.0).to_r # RangeError Complex(1, 2).to_r # RangeError See rationalize. ;T;[o;= ;3I" overload;F;40;;P;50;)I" to_r;T;IC;";T; @Ô€;>0;!F;[;[;I";T;0;6i;[; @Ô€;[;I"ëReturns the value as a rational if possible (the imaginary part should be exactly zero). Complex(1, 0).to_r #=> (1/1) Complex(1, 0.0).to_r # RangeError Complex(1, 2).to_r # RangeError See rationalize. @overload to_r;T;0; @Ô€;!F;"o;#;$T;%i[;&ie;'@%|;(I"×static VALUE nucomp_to_r(VALUE self) { get_dat1(self); if (!k_exact_zero_p(dat->imag)) { rb_raise(rb_eRangeError, "can't convert %"PRIsVALUE" into Rational", self); } return f_to_r(dat->real); };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#rationalize;F;[[@c0;[[@t i;T;:rationalize;0;[;{;IC;"îReturns the value as a rational if possible (the imaginary part should be exactly zero). Complex(1.0/3, 0).rationalize #=> (1/3) Complex(1, 0.0).rationalize # RangeError Complex(1, 2).rationalize # RangeError See to_r. ;T;[o;= ;3I" overload;F;40;;Q;50;)I"rationalize([eps]);T;IC;";T; @ê€;>0;!F;[;[;I";T;0;6i;[[I" [eps];T0; @ê€;[;I" Returns the value as a rational if possible (the imaginary part should be exactly zero). Complex(1.0/3, 0).rationalize #=> (1/3) Complex(1, 0.0).rationalize # RangeError Complex(1, 2).rationalize # RangeError See to_r. @overload rationalize([eps]);T;0; @ê€;!F;"o;#;$T;%it;&i~;'@%|;(I"Jstatic VALUE nucomp_rationalize(int argc, VALUE *argv, VALUE self) { get_dat1(self); rb_check_arity(argc, 0, 1); if (!k_exact_zero_p(dat->imag)) { rb_raise(rb_eRangeError, "can't convert %"PRIsVALUE" into Rational", self); } return rb_funcallv(dat->real, id_rationalize, argc, argv); };T;)I"static VALUE;T;*To;;F; ;;;;I"Complex#to_c;F;[;[[@t i˜;T;: to_c;0;[;{;IC;"ZReturns self. Complex(2).to_c #=> (2+0i) Complex(-8, 6).to_c #=> (-8+6i) ;T;[o;= ;3I" overload;F;40;;R;50;)I" to_c;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @;[;I"@return [self];T;0;6i;[; @;[;I"|Returns self. Complex(2).to_c #=> (2+0i) Complex(-8, 6).to_c #=> (-8+6i) @overload to_c @return [self];T;0; @;!F;"o;#;$T;%i;&i–;'@%|;(I">static VALUE nucomp_to_c(VALUE self) { return self; };T;)I"static VALUE;T;*To;{;[[@t i“ ;F;:I;;};;;[;{;IC;"The imaginary unit. ;T;[;[;I"The imaginary unit. ;T;0; @;!F;"o;#;$T;%i ;&i‘ ;'@%|;I"Complex::I;F;~I"0f_complex_new_bang2(rb_cComplex, ZERO, ONE);T;A@%|;BIC;[;A@%|;CIC;[;A@%|;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@t i! ;F;;š;;K;;;[;{;IC;"mA complex number can be represented as a paired real number with imaginary unit; a+bi. Where a is real part, b is imaginary part and i is imaginary unit. Real a equals complex a+0i mathematically. Complex object can be created as literal, and also by using Kernel#Complex, Complex::rect, Complex::polar or to_c method. 2+1i #=> (2+1i) Complex(1) #=> (1+0i) Complex(2, 3) #=> (2+3i) Complex.polar(2, 3) #=> (-1.9799849932008908+0.2822400161197344i) 3.to_c #=> (3+0i) You can also create complex object from floating-point numbers or strings. Complex(0.3) #=> (0.3+0i) Complex('0.3-0.5i') #=> (0.3-0.5i) Complex('2/3+3/4i') #=> ((2/3)+(3/4)*i) Complex('1@2') #=> (-0.4161468365471424+0.9092974268256817i) 0.3.to_c #=> (0.3+0i) '0.3-0.5i'.to_c #=> (0.3-0.5i) '2/3+3/4i'.to_c #=> ((2/3)+(3/4)*i) '1@2'.to_c #=> (-0.4161468365471424+0.9092974268256817i) A complex object is either an exact or an inexact number. Complex(1, 1) / 2 #=> ((1/2)+(1/2)*i) Complex(1, 1) / 2.0 #=> (0.5+0.5i) ;T;[;[;I"nA complex number can be represented as a paired real number with imaginary unit; a+bi. Where a is real part, b is imaginary part and i is imaginary unit. Real a equals complex a+0i mathematically. Complex object can be created as literal, and also by using Kernel#Complex, Complex::rect, Complex::polar or to_c method. 2+1i #=> (2+1i) Complex(1) #=> (1+0i) Complex(2, 3) #=> (2+3i) Complex.polar(2, 3) #=> (-1.9799849932008908+0.2822400161197344i) 3.to_c #=> (3+0i) You can also create complex object from floating-point numbers or strings. Complex(0.3) #=> (0.3+0i) Complex('0.3-0.5i') #=> (0.3-0.5i) Complex('2/3+3/4i') #=> ((2/3)+(3/4)*i) Complex('1@2') #=> (-0.4161468365471424+0.9092974268256817i) 0.3.to_c #=> (0.3+0i) '0.3-0.5i'.to_c #=> (0.3-0.5i) '2/3+3/4i'.to_c #=> ((2/3)+(3/4)*i) '1@2'.to_c #=> (-0.4161468365471424+0.9092974268256817i) A complex object is either an exact or an inexact number. Complex(1, 1) / 2 #=> ((1/2)+(1/2)*i) Complex(1, 1) / 2.0 #=> (0.5+0.5i) ;T;0; @%|;!F;"o;#;$T;%ið;&i ;'@;I"Complex;F;So;L;M0;N0;O0;:Numeric;'@;Qo; ;IC;[4o;;F; ;;;;I"Numeric#to_c;F;[;[[@t i°;T;;R;0;[;{;IC;"$Returns the value as a complex. ;T;[o;= ;3I" overload;F;40;;R;50;)I" to_c;T;IC;";T; @>;>0;!F;[;[;I";T;0;6i;[; @>;[;I"5Returns the value as a complex. @overload to_c;T;0; @>;!F;"o;#;$T;%iª;&i;'@<;(I"Pstatic VALUE numeric_to_c(VALUE self) { return rb_complex_new1(self); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#real;F;[;[[@t iu;T;;6;0;[;{;IC;"Returns self. ;T;[o;= ;3I" overload;F;40;;6;50;)I" real;T;IC;";T; @T;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @T;[;I"@return [self];T;0;6i;[; @T;[;I"4Returns self. @overload real @return [self];T;0; @T;!F;"o;#;$T;%io;&is;'@<;(I"?static VALUE numeric_real(VALUE self) { return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#imaginary;F;[;[[@t i‚;T;;7;0;[;{;IC;"Returns zero. ;T;[o;= ;3I" overload;F;40;;8;50;)I" imag;T;IC;";T; @o;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @o;[;I"@return [ 0];T;0;6i;[; @oo;= ;3I" overload;F;40;;7;50;)I"imaginary;T;IC;";T; @o;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @o;[;I"@return [ 0];T;0;6i;[; @o;[;I"UReturns zero. @overload imag @return [ 0] @overload imaginary @return [ 0];T;0; @o;!F;"o;#;$T;%i{;&i;'@<;(I"Estatic VALUE numeric_imag(VALUE self) { return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#imag;F;[;[[@t i‚;T;;8;0;[;{;IC;"Returns zero. ;T;[o;= ;3I" overload;F;40;;8;50;)I" imag;T;IC;";T; @—;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @—;[;I"@return [ 0];T;0;6i;[; @—o;= ;3I" overload;F;40;;7;50;)I"imaginary;T;IC;";T; @—;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @—;[;I"@return [ 0];T;0;6i;[; @—;[;@“;0; @—;!F;"o;#;$T;%i{;&i;'@<;(I"Estatic VALUE numeric_imag(VALUE self) { return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#abs2;F;[;[[@t iŽ;T;;A;0;[;{;IC;"Returns square of self. ;T;[o;= ;3I" overload;F;40;;A;50;)I" abs2;T;IC;";T; @¾;>0;!F;[;[;I";T;0;6i;[; @¾;[;I"-Returns square of self. @overload abs2;T;0; @¾;!F;"o;#;$T;%iˆ;&i‹;'@<;(I"Lstatic VALUE numeric_abs2(VALUE self) { return f_mul(self, self); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#arg;F;[;[[@t iœ;T;;B;0;[;{;IC;"6Returns 0 if the value is positive, pi otherwise. ;T;[o;= ;3I" overload;F;40;;B;50;)I"arg;T;IC;";T; @Ô;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI" Float;T; @Ô;[;I"@return [ 0, Float];T;0;6i;[; @Ôo;= ;3I" overload;F;40;;C;50;)I" angle;T;IC;";T; @Ô;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI" Float;T; @Ô;[;I"@return [ 0, Float];T;0;6i;[; @Ôo;= ;3I" overload;F;40;;D;50;)I" phase;T;IC;";T; @Ô;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI" Float;T; @Ô;[;I"@return [ 0, Float];T;0;6i;[; @Ô;[;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 numeric_arg(VALUE self) { if (f_positive_p(self)) return INT2FIX(0); return DBL2NUM(M_PI); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#angle;F;[;[[@t iœ;T;;C;0;[;{;IC;"6Returns 0 if the value is positive, pi otherwise. ;T;[o;= ;3I" overload;F;40;;B;50;)I"arg;T;IC;";T; @‚;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI" Float;T; @‚;[;I"@return [ 0, Float];T;0;6i;[; @‚o;= ;3I" overload;F;40;;C;50;)I" angle;T;IC;";T; @‚;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI" Float;T; @‚;[;I"@return [ 0, Float];T;0;6i;[; @‚o;= ;3I" overload;F;40;;D;50;)I" phase;T;IC;";T; @‚;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI" Float;T; @‚;[;I"@return [ 0, Float];T;0;6i;[; @‚;[;@‚;0; @‚;!F;"o;#;$T;%i”;&iœ;'@<;(I"~static VALUE numeric_arg(VALUE self) { if (f_positive_p(self)) return INT2FIX(0); return DBL2NUM(M_PI); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#phase;F;[;[[@t iœ;T;;D;0;[;{;IC;"6Returns 0 if the value is positive, pi otherwise. ;T;[o;= ;3I" overload;F;40;;B;50;)I"arg;T;IC;";T; @C‚;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI" Float;T; @C‚;[;I"@return [ 0, Float];T;0;6i;[; @C‚o;= ;3I" overload;F;40;;C;50;)I" angle;T;IC;";T; @C‚;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI" Float;T; @C‚;[;I"@return [ 0, Float];T;0;6i;[; @C‚o;= ;3I" overload;F;40;;D;50;)I" phase;T;IC;";T; @C‚;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI" Float;T; @C‚;[;I"@return [ 0, Float];T;0;6i;[; @C‚;[;@‚;0; @C‚;!F;"o;#;$T;%i”;&iœ;'@<;(I"~static VALUE numeric_arg(VALUE self) { if (f_positive_p(self)) return INT2FIX(0); return DBL2NUM(M_PI); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#rectangular;F;[;[[@t i«;T;;3;0;[;{;IC;" Returns an array; [num, 0]. ;T;[o;= ;3I" overload;F;40;;4;50;)I" rect;T;IC;";T; @z‚;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @z‚;[;I"@return [Array];T;0;6i;[; @z‚o;= ;3I" overload;F;40;;3;50;)I"rectangular;T;IC;";T; @z‚;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @z‚;[;I"@return [Array];T;0;6i;[; @z‚;[;I"kReturns an array; [num, 0]. @overload rect @return [Array] @overload rectangular @return [Array];T;0; @z‚;!F;"o;#;$T;%i¤;&iª;'@<;(I"Ystatic VALUE numeric_rect(VALUE self) { return rb_assoc_new(self, INT2FIX(0)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#rect;F;[;[[@t i«;T;;4;0;[;{;IC;" Returns an array; [num, 0]. ;T;[o;= ;3I" overload;F;40;;4;50;)I" rect;T;IC;";T; @¢‚;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @¢‚;[;I"@return [Array];T;0;6i;[; @¢‚o;= ;3I" overload;F;40;;3;50;)I"rectangular;T;IC;";T; @¢‚;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @¢‚;[;I"@return [Array];T;0;6i;[; @¢‚;[;@ž‚;0; @¢‚;!F;"o;#;$T;%i¤;&iª;'@<;(I"Ystatic VALUE numeric_rect(VALUE self) { return rb_assoc_new(self, INT2FIX(0)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#polar;F;[;[[@t i¹;T;;5;0;[;{;IC;"*Returns an array; [num.abs, num.arg]. ;T;[o;= ;3I" overload;F;40;;5;50;)I" polar;T;IC;";T; @É‚;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @É‚;[;I"@return [Array];T;0;6i;[; @É‚;[;I"NReturns an array; [num.abs, num.arg]. @overload polar @return [Array];T;0; @É‚;!F;"o;#;$T;%i³;&i·;'@<;(I"østatic VALUE numeric_polar(VALUE self) { VALUE abs, arg; if (RB_INTEGER_TYPE_P(self)) { abs = rb_int_abs(self); arg = numeric_arg(self); } else if (RB_FLOAT_TYPE_P(self)) { abs = rb_float_abs(self); arg = float_arg(self); } else if (RB_TYPE_P(self, T_RATIONAL)) { abs = rb_rational_abs(self); arg = numeric_arg(self); } else { abs = f_abs(self); arg = f_arg(self); } return rb_assoc_new(abs, arg); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#conjugate;F;[;[[@t iØ;T;;E;0;[;{;IC;"Returns self. ;T;[o;= ;3I" overload;F;40;;F;50;)I" conj;T;IC;";T; @ä‚;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @ä‚;[;I"@return [self];T;0;6i;[; @ä‚o;= ;3I" overload;F;40;;E;50;)I"conjugate;T;IC;";T; @ä‚;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @ä‚;[;I"@return [self];T;0;6i;[; @ä‚;[;I"YReturns self. @overload conj @return [self] @overload conjugate @return [self];T;0; @ä‚;!F;"o;#;$T;%iÑ;&i×;'@<;(I"?static VALUE numeric_conj(VALUE self) { return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#conj;F;[;[[@t iØ;T;;F;0;[;{;IC;"Returns self. ;T;[o;= ;3I" overload;F;40;;F;50;)I" conj;T;IC;";T; @ƒ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @ƒ;[;I"@return [self];T;0;6i;[; @ƒo;= ;3I" overload;F;40;;E;50;)I"conjugate;T;IC;";T; @ƒ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @ƒ;[;I"@return [self];T;0;6i;[; @ƒ;[;@ƒ;0; @ƒ;!F;"o;#;$T;%iÑ;&i×;'@<;(I"?static VALUE numeric_conj(VALUE self) { return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#numerator;F;[;[[@¨ iÓ;T;;H;0;[;{;IC;"Returns the numerator. ;T;[o;= ;3I" overload;F;40;;H;50;)I"numerator;T;IC;";T; @3ƒ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @3ƒ;[;I"@return [Integer];T;0;6i;[; @3ƒ;[;I"EReturns the numerator. @overload numerator @return [Integer];T;0; @3ƒ;!F;"o;#;$T;%iÍ;&iÑ;'@<;(I"Ystatic VALUE numeric_numerator(VALUE self) { return f_numerator(f_to_r(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#denominator;F;[;[[@¨ iß;T;;I;0;[;{;IC;"/Returns the denominator (always positive). ;T;[o;= ;3I" overload;F;40;;I;50;)I"denominator;T;IC;";T; @Nƒ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Nƒ;[;I"@return [Integer];T;0;6i;[; @Nƒ;[;I"[Returns the denominator (always positive). @overload denominator @return [Integer];T;0; @Nƒ;!F;"o;#;$T;%iÙ;&iÝ;'@<;(I"]static VALUE numeric_denominator(VALUE self) { return f_denominator(f_to_r(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#quo;F;[[I"y;T0;[[@¨ iî;T;;;;0;[;{;IC;"OReturns the most exact division (rational for integers, float for floats). ;T;[o;= ;3I" overload;F;40;;;;50;)I"quo(int_or_rat);T;IC;";T; @iƒ;>0;!F;[;[;I";T;0;6i;[[I"int_or_rat;T0; @iƒo;= ;3I" overload;F;40;;;;50;)I" quo(flo);T;IC;";T; @iƒ;>0;!F;[;[;I";T;0;6i;[[I"flo;T0; @iƒ;[;I"~Returns the most exact division (rational for integers, float for floats). @overload quo(int_or_rat) @overload quo(flo);T;0; @iƒ;!F;"o;#;$T;%iæ;&iê;'@<;(I"*VALUE rb_numeric_quo(VALUE x, VALUE y) { if (RB_TYPE_P(x, T_COMPLEX)) { return rb_complex_div(x, y); } if (RB_FLOAT_TYPE_P(y)) { return rb_funcallv(x, idFdiv, 1, &y); } x = rb_convert_type(x, T_RATIONAL, "Rational", "to_r"); return rb_rational_div(x, y); };T;)I" VALUE;T;*To;;F; ;;;;I"#Numeric#singleton_method_added;F;[[I" name;T0;[[@ïiï;T;;Ó;0;[;{;IC;"Ÿ:nodoc: 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" :nodoc: 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;%iç;&iì;'@<;(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_RETURN(Qnil); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#coerce;F;[[I"y;T0;[[@ïi•;T;;>;0;[;{;IC;"¼If +numeric+ is the same type as +num+, returns an array [numeric, num]. Otherwise, returns an array with both +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;= ;3I" overload;F;40;;>;50;)I"coerce(numeric);T;IC;";T; @ƒ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ƒ;[;I"@return [Array];T;0;6i;[[I"numeric;T0; @ƒ;[;I"êIf +numeric+ is the same type as +num+, returns an array [numeric, num]. Otherwise, returns an array with both +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 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;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#clone;F;[[@c0;[[@ïi;T;: clone;0;[;{;IC;"7Returns the receiver. +freeze+ cannot be +false+. ;T;[o;= ;3I" overload;F;40;;U;50;)I"clone(freeze: true);T;IC;";T; @¼ƒ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @¼ƒ;[;I"@return [Numeric];T;0;6i;[[I"freeze:;TI" true;T; @¼ƒ;[;I"kReturns the receiver. +freeze+ cannot be +false+. @overload clone(freeze: true) @return [Numeric];T;0; @¼ƒ;!F;"o;#;$T;%iþ;&i;'@<;(I"qstatic VALUE num_clone(int argc, VALUE *argv, VALUE x) { return rb_immutable_obj_clone(argc, argv, x); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#dup;F;[;[[@ïi;T;;e;0;[;{;IC;"Returns the receiver. ;T;[o;= ;3I" overload;F;40;;e;50;)I"dup;T;IC;";T; @Ûƒ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @Ûƒ;[;I"@return [Numeric];T;0;6i;[; @Ûƒ;[;I">Returns the receiver. @overload dup @return [Numeric];T;0; @Ûƒ;!F;"o;#;$T;%i;&i;'@<;(I"4static VALUE num_dup(VALUE x) { return x; };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#i;F;[;[[@ïi5;T;:i;0;[;{;IC;"|Returns the corresponding imaginary number. Not available for complex numbers. -42.i #=> (0-42i) 2.0.i #=> (0+2.0i) ;T;[o;= ;3I" overload;F;40;;V;50;)I"i;T;IC;";T; @öƒ;>0;!F;[o;2 ;3I"return;F;4I"Complex(0];T;0;5[I"Complex(0];T; @öƒ;[;I"@return [ Complex(0];T;0;6i;[; @öƒ;[;I"¡Returns the corresponding imaginary number. Not available for complex numbers. -42.i #=> (0-42i) 2.0.i #=> (0+2.0i) @overload i @return [ Complex(0];T;0; @öƒ;!F;"o;#;$T;%i*;&i2;'@<;(I"Zstatic VALUE num_imaginary(VALUE num) { return rb_complex_new(INT2FIX(0), num); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#+@;F;[;[[@ïi$;T;:+@;0;[;{;IC;"'Unary Plus---Returns the receiver. ;T;[o;= ;3I" overload;F;40;;&;50;)I" +num;T;IC;";T; @„;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @„;[;I"@return [Numeric];T;0;6i;[; @„;[;I"LUnary Plus---Returns the receiver. @overload +num @return [Numeric];T;0; @„;!F;"o;#;$T;%i;&i!;'@<;(I":static VALUE num_uplus(VALUE num) { return num; };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#-@;F;[;[[@ïiB;T;;9;0;[;{;IC;"1Unary Minus---Returns the receiver, negated. ;T;[o;= ;3I" overload;F;40;;;50;)I" -num;T;IC;";T; @,„;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @,„;[;I"@return [Numeric];T;0;6i;[; @,„;[;I"VUnary Minus---Returns the receiver, negated. @overload -num @return [Numeric];T;0; @,„;!F;"o;#;$T;%i;;&i?;'@<;(I"šstatic VALUE num_uminus(VALUE num) { VALUE zero; zero = INT2FIX(0); do_coerce(&zero, &num, TRUE); return num_funcall1(zero, '-', num); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#<=>;F;[[I"y;T0;[[@ïij;T;;c;0;[;{;IC;"FReturns zero if +number+ equals +other+, otherwise returns +nil+. ;T;[o;= ;3I" overload;F;40;;c;50;)I"<=>(other);T;IC;";T; @G„;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI"nil;T; @G„;[;I"@return [ 0, nil];T;0;6i;[[I" other;T0; @G„;[;I"qReturns zero if +number+ equals +other+, otherwise returns +nil+. @overload <=>(other) @return [ 0, nil];T;0; @G„;!F;"o;#;$T;%ic;&ig;'@<;(I"cstatic VALUE num_cmp(VALUE x, VALUE y) { if (x == y) return INT2FIX(0); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#eql?;F;[[I"y;T0;[[@ïiW;T;;_;0;[;{;IC;"åReturns +true+ if +num+ and +numeric+ are the same type and have equal values. Contrast this with Numeric#==, which performs type conversions. 1 == 1.0 #=> true 1.eql?(1.0) #=> false 1.0.eql?(1.0) #=> true;T;[o;= ;3I" overload;F;40;;_;50;)I"eql?(numeric);T;IC;";T; @g„;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @g„;[;I"@return [Boolean];T;0;6i;[[I"numeric;T0; @g„;[;I"Returns +true+ if +num+ and +numeric+ are the same type and have equal values. Contrast this with Numeric#==, which performs type conversions. 1 == 1.0 #=> true 1.eql?(1.0) #=> false 1.0.eql?(1.0) #=> true @overload eql?(numeric) @return [Boolean];T;0; @g„;!F;"o;#;$T;%iK;&iT;6i;'@<;(I"´static VALUE num_eql(VALUE x, VALUE y) { if (TYPE(x) != TYPE(y)) return Qfalse; if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_eql(x, y); } return rb_equal(x, y); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#fdiv;F;[[I"y;T0;[[@ïiT;T;;<;0;[;{;IC;"Returns float division. ;T;[o;= ;3I" overload;F;40;;<;50;)I"fdiv(numeric);T;IC;";T; @†„;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @†„;[;I"@return [Float];T;0;6i;[[I"numeric;T0; @†„;[;I"HReturns float division. @overload fdiv(numeric) @return [Float];T;0; @†„;!F;"o;#;$T;%iM;&iQ;'@<;(I"_static VALUE num_fdiv(VALUE x, VALUE y) { return rb_funcall(rb_Float(x), '/', 1, y); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#div;F;[[I"y;T0;[[@ïif;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;= ;3I" overload;F;40;;X;50;)I"div(numeric);T;IC;";T; @¥„;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¥„;[;I"@return [Integer];T;0;6i;[[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;%iZ;⁣'@<;(I"¤static VALUE num_div(VALUE x, VALUE y) { if (rb_equal(INT2FIX(0), y)) rb_num_zerodiv(); return rb_funcall(num_funcall1(x, '/', y), rb_intern("floor"), 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#divmod;F;[[I"y;T0;[[@ïiÃ;T;:divmod;0;[;{;IC;"6Returns 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 negative 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;= ;3I" overload;F;40;;Y;50;)I"divmod(numeric);T;IC;";T; @Ä„;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @Ä„;[;I"@return [Array];T;0;6i;[[I"numeric;T0; @Ä„;[;I"dReturns 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 negative 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"lstatic VALUE num_divmod(VALUE x, VALUE y) { return rb_assoc_new(num_div(x, y), num_modulo(x, y)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#%;F;[[I"y;T0;[[@ïix;T;;Û;0;[;{;IC;"…x.modulo(y) means x-y*(x/y).floor. Equivalent to num.divmod(numeric)[1]. See Numeric#divmod. ;T;[o;= ;3I" overload;F;40;:modulo;50;)I"modulo(numeric);T;IC;";T; @ã„;>0;!F;[;[;I";T;0;6i;[[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;%im;⁢'@<;(I"›static VALUE num_modulo(VALUE x, VALUE y) { VALUE q = num_funcall1(x, id_div, y); return rb_funcall(x, '-', 1, rb_funcall(y, '*', 1, q)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#modulo;F;[[I"y;T0;[[@ïix;T;;Z;0;[;{;IC;"…x.modulo(y) means x-y*(x/y).floor. Equivalent to num.divmod(numeric)[1]. See Numeric#divmod. ;T;[o;= ;3I" overload;F;40;;Z;50;)I"modulo(numeric);T;IC;";T; @ý„;>0;!F;[;[;I";T;0;6i;[[I"numeric;T0; @ý„;[;@ù„;0; @ý„;!F;"o;#;$T;%im;⁢'@<;(I"›static VALUE num_modulo(VALUE x, VALUE y) { VALUE q = num_funcall1(x, id_div, y); return rb_funcall(x, '-', 1, rb_funcall(y, '*', 1, q)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#remainder;F;[[I"y;T0;[[@ïi‰;T;:remainder;0;[;{;IC;"\x.remainder(y) means x-y*(x/y).truncate. See Numeric#divmod. ;T;[o;= ;3I" overload;F;40;;[;50;)I"remainder(numeric);T;IC;";T; @…;>0;!F;[;[;I";T;0;6i;[[I"numeric;T0; @…;[;I"{x.remainder(y) means x-y*(x/y).truncate. See Numeric#divmod. @overload remainder(numeric);T;0; @…;!F;"o;#;$T;%i€;&i…;'@<;(I"3static VALUE num_remainder(VALUE x, VALUE y) { VALUE z = num_funcall1(x, '%', y); if ((!rb_equal(z, INT2FIX(0))) && ((rb_num_negative_int_p(x) && rb_num_positive_int_p(y)) || (rb_num_positive_int_p(x) && rb_num_negative_int_p(y)))) { return rb_funcall(z, '-', 1, y); } return z; };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#abs;F;[;[[@ïiô;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 for Numeric#abs. ;T;[o;= ;3I" overload;F;40;;?;50;)I"abs;T;IC;";T; @0…;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @0…;[;I"@return [Numeric];T;0;6i;[; @0…o;= ;3I" overload;F;40;;@;50;)I"magnitude;T;IC;";T; @0…;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @0…;[;I"@return [Numeric];T;0;6i;[; @0…;[;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 for Numeric#abs. @overload abs @return [Numeric] @overload magnitude @return [Numeric];T;0; @0…;!F;"o;#;$T;%iæ;&iò;'@<;(I"„static VALUE num_abs(VALUE num) { if (rb_num_negative_int_p(num)) { return num_funcall0(num, idUMinus); } return num; };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#magnitude;F;[;[[@ïiô;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 for Numeric#abs. ;T;[o;= ;3I" overload;F;40;;?;50;)I"abs;T;IC;";T; @X…;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @X…;[;I"@return [Numeric];T;0;6i;[; @X…o;= ;3I" overload;F;40;;@;50;)I"magnitude;T;IC;";T; @X…;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @X…;[;I"@return [Numeric];T;0;6i;[; @X…;[;@T…;0; @X…;!F;"o;#;$T;%iæ;&iò;'@<;(I"„static VALUE num_abs(VALUE num) { if (rb_num_negative_int_p(num)) { return num_funcall0(num, idUMinus); } return num; };T;)I"static VALUE;T;*To;;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 #=> Integer 1.0.to_i.class #=> Integer ;T;[o;= ;3I" overload;F;40;;\;50;)I"to_int;T;IC;";T; @…;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @…;[;I"@return [Integer];T;0;6i;[; @…;[;I"ÖInvokes the child class's +to_i+ method to convert +num+ to an integer. 1.0.class #=> Float 1.0.to_int.class #=> Integer 1.0.to_i.class #=> Integer @overload to_int @return [Integer];T;0; @…;!F;"o;#;$T;%iT;&i\;'@<;(I"Rstatic VALUE num_to_int(VALUE num) { return num_funcall0(num, id_to_i); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#real?;F;[;[[@ïiÐ;T;;G;0;[;{;IC;"AReturns +true+ if +num+ is a real number (i.e. not Complex).;T;[o;= ;3I" overload;F;40;;G;50;)I" real?;T;IC;";T; @š…;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @š…;[;I"@return [Boolean];T;0;6i;[; @š…;[;I"gReturns +true+ if +num+ is a real number (i.e. not Complex). @overload real? @return [Boolean];T;0; @š…;!F;"o;#;$T;%iÉ;&iÍ;6i;'@<;(I"=static VALUE num_real_p(VALUE num) { return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#integer?;F;[;[[@ïià;T;: integer?;0;[;{;IC;"eReturns +true+ if +num+ is an Integer. 1.0.integer? #=> false 1.integer? #=> true;T;[o;= ;3I" overload;F;40;;];50;)I" integer?;T;IC;";T; @µ…;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @µ…;[;I"@return [Boolean];T;0;6i;[; @µ…;[;I"‰Returns +true+ if +num+ is an Integer. 1.0.integer? #=> false 1.integer? #=> true @overload integer? @return [Boolean];T;0; @µ…;!F;"o;#;$T;%iÖ;&iÝ;6i;'@<;(I"=static VALUE num_int_p(VALUE num) { return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#zero?;F;[;[[@ïi;T;: zero?;0;[;{;IC;".Returns +true+ if +num+ has a zero value.;T;[o;= ;3I" overload;F;40;;^;50;)I" zero?;T;IC;";T; @Ð…;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Ð…;[;I"@return [Boolean];T;0;6i;[; @Ð…;[;I"TReturns +true+ if +num+ has a zero value. @overload zero? @return [Boolean];T;0; @Ð…;!F;"o;#;$T;%iý;&i;6i;'@<;(I"static VALUE num_zero_p(VALUE num) { if (rb_equal(num, INT2FIX(0))) { return Qtrue; } return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#nonzero?;F;[;[[@ïi2;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;= ;3I" overload;F;40;;_;50;)I" nonzero?;T;IC;";T; @ë…;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;TI"nil;T; @ë…;[;I"@return [self, nil];T;0;6i;[; @ë…;[;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%;&i/;6i;'@<;(I"…static VALUE num_nonzero_p(VALUE num) { if (RTEST(num_funcall0(num, rb_intern("zero?")))) { return Qnil; } return num; };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#finite?;F;[;[[@ïiA;T;;J;0;[;{;IC;"KReturns +true+ if +num+ is a finite number, otherwise returns +false+.;T;[o;= ;3I" overload;F;40;;J;50;)I"finite?;T;IC;";T; @†;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @†;[;I"@return [Boolean];T;0;6i;[; @†;[;I"sReturns +true+ if +num+ is a finite number, otherwise returns +false+. @overload finite? @return [Boolean];T;0; @†;!F;"o;#;$T;%i;;&i?;6i;'@<;(I"?static VALUE num_finite_p(VALUE num) { return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#infinite?;F;[;[[@ïiN;T;;K;0;[;{;IC;"yReturns +nil+, -1, or 1 depending on whether the value is finite, -Infinity, or +Infinity.;T;[o;= ;3I" overload;F;40;;K;50;)I"infinite?;T;IC;";T; @"†;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"-1;TI"1;TI"nil;T; @"†;[;I"@return [ -1, 1, nil];T;0;6i;[; @"†;[;I"£Returns +nil+, -1, or 1 depending on whether the value is finite, -Infinity, or +Infinity. @overload infinite? @return [ -1, 1, nil];T;0; @"†;!F;"o;#;$T;%iG;&iL;6i;'@<;(I"@static VALUE num_infinite_p(VALUE num) { return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#floor;F;[[@c0;[[@ïi¯ ;T;: floor;0;[;{;IC;"ÇReturns the largest number less than or equal to +num+ with a precision of +ndigits+ decimal digits (default: 0). Numeric implements this by converting its value to a Float and invoking Float#floor. ;T;[o;= ;3I" overload;F;40;;`;50;)I"floor([ndigits]);T;IC;";T; @?†;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI" Float;T; @?†;[;I"@return [Integer, Float];T;0;6i;[[I"[ndigits];T0; @?†;[;I"ÿReturns the largest number less than or equal to +num+ with a precision of +ndigits+ decimal digits (default: 0). Numeric implements this by converting its value to a Float and invoking Float#floor. @overload floor([ndigits]) @return [Integer, Float];T;0; @?†;!F;"o;#;$T;%i¤ ;&i¬ ;'@<;(I"rstatic VALUE num_floor(int argc, VALUE *argv, VALUE num) { return flo_floor(argc, argv, rb_Float(num)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#ceil;F;[[@c0;[[@ïiÀ ;T;: ceil;0;[;{;IC;"ÊReturns the smallest number greater than or equal to +num+ with a precision of +ndigits+ decimal digits (default: 0). Numeric implements this by converting its value to a Float and invoking Float#ceil. ;T;[o;= ;3I" overload;F;40;;a;50;)I"ceil([ndigits]);T;IC;";T; @^†;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI" Float;T; @^†;[;I"@return [Integer, Float];T;0;6i;[[I"[ndigits];T0; @^†;[;I"Returns the smallest number greater than or equal to +num+ with a precision of +ndigits+ decimal digits (default: 0). Numeric implements this by converting its value to a Float and invoking Float#ceil. @overload ceil([ndigits]) @return [Integer, Float];T;0; @^†;!F;"o;#;$T;%iµ ;&i½ ;'@<;(I"pstatic VALUE num_ceil(int argc, VALUE *argv, VALUE num) { return flo_ceil(argc, argv, rb_Float(num)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#round;F;[[@c0;[[@ïiÑ ;T;: round;0;[;{;IC;"»Returns +num+ rounded to the nearest value with a precision of +ndigits+ decimal digits (default: 0). Numeric implements this by converting its value to a Float and invoking Float#round. ;T;[o;= ;3I" overload;F;40;;b;50;)I"round([ndigits]);T;IC;";T; @}†;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI" Float;T; @}†;[;I"@return [Integer, Float];T;0;6i;[[I"[ndigits];T0; @}†;[;I"óReturns +num+ rounded to the nearest value with a precision of +ndigits+ decimal digits (default: 0). Numeric implements this by converting its value to a Float and invoking Float#round. @overload round([ndigits]) @return [Integer, Float];T;0; @}†;!F;"o;#;$T;%iÆ ;&iÎ ;'@<;(I"rstatic VALUE num_round(int argc, VALUE* argv, VALUE num) { return flo_round(argc, argv, rb_Float(num)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#truncate;F;[[@c0;[[@ïiâ ;T;: truncate;0;[;{;IC;"·Returns +num+ truncated (toward zero) to a precision of +ndigits+ decimal digits (default: 0). Numeric implements this by converting its value to a Float and invoking Float#truncate. ;T;[o;= ;3I" overload;F;40;;c;50;)I"truncate([ndigits]);T;IC;";T; @œ†;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI" Float;T; @œ†;[;I"@return [Integer, Float];T;0;6i;[[I"[ndigits];T0; @œ†;[;I"òReturns +num+ truncated (toward zero) to a precision of +ndigits+ decimal digits (default: 0). Numeric implements this by converting its value to a Float and invoking Float#truncate. @overload truncate([ndigits]) @return [Integer, Float];T;0; @œ†;!F;"o;#;$T;%i× ;&iß ;'@<;(I"xstatic VALUE num_truncate(int argc, VALUE *argv, VALUE num) { return flo_truncate(argc, argv, rb_Float(num)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#step;F;[[@c0;[[@ïiè ;T;;Ú;0;[;{;IC;"4Invokes 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 floor(n + n*Float::EPSILON) + 1 times, where 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. Especially, the enumerator is an Enumerator::ArithmeticSequence if both +limit+ and +step+ are kind of Numeric or nil. 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.718281828459045 2.9182818284590453 3.118281828459045 ;T;[o;= ;3I" overload;F;40;;Ú;50;)I"step(by: step, to: limit);T;IC;";T; @»†;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"i;T; @»†o;2 ;3I"return;F;4I";T;0;5[I" self;T; @»†;[;I"@yield [i] @return [self];T;0;6i;[[I"by:;TI" step;T[I"to:;TI" limit;T; @»†o;= ;3I" overload;F;40;;Ú;50;)I"step(by: step, to: limit);T;IC;";T; @»†;>0;!F;[;[;I";T;0;6i;[[I"by:;TI" step;T[I"to:;TI" limit;T; @»†o;= ;3I" overload;F;40;;Ú;50;)I"step(by: step, to: limit);T;IC;";T; @»†;>0;!F;[;[;I";T;0;6i;[[I"by:;TI" step;T[I"to:;TI" limit;T; @»†o;= ;3I" overload;F;40;;Ú;50;)I"step(limit=nil, step=1);T;IC;";T; @»†;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"i;T; @»†o;2 ;3I"return;F;4I";T;0;5[I" self;T; @»†;[;I"@yield [i] @return [self];T;0;6i;[[I" limit;TI"nil;T[I" step;TI"1;T; @»†o;= ;3I" overload;F;40;;Ú;50;)I"step(limit=nil, step=1);T;IC;";T; @»†;>0;!F;[;[;I";T;0;6i;[[I" limit;TI"nil;T[I" step;TI"1;T; @»†o;= ;3I" overload;F;40;;Ú;50;)I"step(limit=nil, step=1);T;IC;";T; @»†;>0;!F;[;[;I";T;0;6i;[[I" limit;TI"nil;T[I" step;TI"1;T; @»†;[;I"DInvokes 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 floor(n + n*Float::EPSILON) + 1 times, where 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. Especially, the enumerator is an Enumerator::ArithmeticSequence if both +limit+ and +step+ are kind of Numeric or nil. 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.718281828459045 2.9182818284590453 3.118281828459045 @overload step(by: step, to: limit) @yield [i] @return [self] @overload step(by: step, to: limit) @overload step(by: step, to: limit) @overload step(limit=nil, step=1) @yield [i] @return [self] @overload step(limit=nil, step=1) @overload step(limit=nil, step=1);T;0; @»†;!F;"o;#;$T;%i° ;&iè ;'@<;(I"static VALUE num_step(int argc, VALUE *argv, VALUE from) { VALUE to, step; int desc, inf; if (!rb_block_given_p()) { VALUE by = Qundef; num_step_extract_args(argc, argv, &to, &step, &by); if (by != Qundef) { step = by; } if (NIL_P(step)) { step = INT2FIX(1); } else if (rb_equal(step, INT2FIX(0))) { rb_raise(rb_eArgError, "step can't be 0"); } if ((NIL_P(to) || rb_obj_is_kind_of(to, rb_cNumeric)) && rb_obj_is_kind_of(step, rb_cNumeric)) { return rb_arith_seq_new(from, ID2SYM(rb_frame_this_func()), argc, argv, num_step_size, from, to, step, FALSE); } return SIZED_ENUMERATOR(from, 2, ((VALUE [2]){to, step}), num_step_size); } desc = num_step_scan_args(argc, argv, &to, &step, TRUE, FALSE); if (rb_equal(step, INT2FIX(0))) { 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, 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;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#positive?;F;[;[[@ïil;T;:positive?;0;[;{;IC;"/Returns +true+ if +num+ is greater than 0.;T;[o;= ;3I" overload;F;40;;d;50;)I"positive?;T;IC;";T; @2‡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @2‡;[;I"@return [Boolean];T;0;6i;[; @2‡;[;I"YReturns +true+ if +num+ is greater than 0. @overload positive? @return [Boolean];T;0; @2‡;!F;"o;#;$T;%ie;ⅈ6i;'@<;(I"šstatic VALUE num_positive_p(VALUE num) { const ID mid = '>'; if (FIXNUM_P(num)) { if (method_basic_p(rb_cInteger)) return (SIGNED_VALUE)num > (SIGNED_VALUE)INT2FIX(0) ? Qtrue : Qfalse; } else if (RB_TYPE_P(num, T_BIGNUM)) { if (method_basic_p(rb_cInteger)) return BIGNUM_POSITIVE_P(num) && !rb_bigzero_p(num) ? Qtrue : Qfalse; } return rb_num_compare_with_zero(num, mid); };T;)I"static VALUE;T;*To;;F; ;;;;I"Numeric#negative?;F;[;[[@ïiƒ;T;:negative?;0;[;{;IC;",Returns +true+ if +num+ is less than 0.;T;[o;= ;3I" overload;F;40;;e;50;)I"negative?;T;IC;";T; @M‡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @M‡;[;I"@return [Boolean];T;0;6i;[; @M‡;[;I"VReturns +true+ if +num+ is less than 0. @overload negative? @return [Boolean];T;0; @M‡;!F;"o;#;$T;%i|;&i€;6i;'@<;(I"gstatic VALUE num_negative_p(VALUE num) { return rb_num_negative_int_p(num) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*T;A@<;BIC;[;A@<;CIC;[o; ;IC;[o;;F; ;;;;I"Comparable#==;F;[[I"y;T0;[[I" compar.c;TiS;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;= ;3I" overload;F;40;;`;50;)I"==(other);T;IC;";T; @l‡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @l‡;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @l‡;[;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; @l‡;!F;"o;#;$T;%iJ;&iP;'@j‡;(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;)I"static VALUE;T;*To;;F; ;;;;I"Comparable#>;F;[[I"y;T0;[[@s‡in;T;;;0;[;{;IC;"Compares two objects based on the receiver's <=> method, returning true if it returns a value greater than 0. ;T;[o;= ;3I" overload;F;40;;;50;)I" >(other);T;IC;";T; @Œ‡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Œ‡;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @Œ‡;[;I"£Compares two objects based on the receiver's <=> method, returning true if it returns a value greater than 0. @overload >(other) @return [Boolean];T;0; @Œ‡;!F;"o;#;$T;%if;&ik;'@j‡;(I"istatic VALUE cmp_gt(VALUE x, VALUE y) { if (cmpint(x, y) > 0) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Comparable#>=;F;[[I"y;T0;[[@s‡i};T;;‚;0;[;{;IC;"†Compares two objects based on the receiver's <=> method, returning true if it returns a value greater than or equal to 0. ;T;[o;= ;3I" overload;F;40;;‚;50;)I">=(other);T;IC;";T; @«‡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @«‡;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @«‡;[;I"°Compares two objects based on the receiver's <=> method, returning true if it returns a value greater than or equal to 0. @overload >=(other) @return [Boolean];T;0; @«‡;!F;"o;#;$T;%iu;&iz;'@j‡;(I"jstatic VALUE cmp_ge(VALUE x, VALUE y) { if (cmpint(x, y) >= 0) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Comparable#<;F;[[I"y;T0;[[@s‡i‡;T;;;0;[;{;IC;"|Compares two objects based on the receiver's <=> method, returning true if it returns a value less than 0. ;T;[o;= ;3I" overload;F;40;;;50;)I" <(other);T;IC;";T; @Ê‡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Ê‡;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @Ê‡;[;I" Compares two objects based on the receiver's <=> method, returning true if it returns a value less than 0. @overload <(other) @return [Boolean];T;0; @Ê‡;!F;"o;#;$T;%i;&i„;'@j‡;(I"istatic VALUE cmp_lt(VALUE x, VALUE y) { if (cmpint(x, y) < 0) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Comparable#<=;F;[[I"y;T0;[[@s‡i–;T;;€;0;[;{;IC;"ƒCompares two objects based on the receiver's <=> method, returning true if it returns a value less than or equal to 0. ;T;[o;= ;3I" overload;F;40;;€;50;)I"<=(other);T;IC;";T; @é‡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @é‡;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @é‡;[;I"Compares two objects based on the receiver's <=> method, returning true if it returns a value less than or equal to 0. @overload <=(other) @return [Boolean];T;0; @é‡;!F;"o;#;$T;%iŽ;&i“;'@j‡;(I"jstatic VALUE cmp_le(VALUE x, VALUE y) { if (cmpint(x, y) <= 0) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Comparable#between?;F;[[I"min;T0[I"max;T0;[[@s‡i¬;T;: between?;0;[;{;IC;"QReturns false if _obj_ <=> _min_ is less than zero or if _obj_ <=> _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;= ;3I" overload;F;40;;f;50;)I"between?(min, max);T;IC;";T; @ˆ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ˆ;[;I"@return [Boolean];T;0;6i;[[I"min;T0[I"max;T0; @ˆ;[;I"…Returns false if _obj_ <=> _min_ is less than zero or if _obj_ <=> _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©;6i;'@j‡;(I"£static VALUE cmp_between(VALUE x, VALUE min, VALUE max) { if (cmpint(x, min) < 0) return Qfalse; if (cmpint(x, max) > 0) return Qfalse; return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"Comparable#clamp;F;[[@c0;[[@s‡iÞ;T;: clamp;0;[;{;IC;"!In (min, max) form, returns _min_ if _obj_ <=> _min_ is less than zero, _max_ if _obj_ <=> _max_ is greater than zero, and _obj_ otherwise. 12.clamp(0, 100) #=> 12 523.clamp(0, 100) #=> 100 -3.123.clamp(0, 100) #=> 0 'd'.clamp('a', 'f') #=> 'd' 'z'.clamp('a', 'f') #=> 'f' In (range) form, returns _range.begin_ if _obj_ <=> _range.begin_ is less than zero, _range.end_ if _obj_ <=> _range.end_ is greater than zero, and _obj_ otherwise. 12.clamp(0..100) #=> 12 523.clamp(0..100) #=> 100 -3.123.clamp(0..100) #=> 0 'd'.clamp('a'..'f') #=> 'd' 'z'.clamp('a'..'f') #=> 'f' If _range.begin_ is +nil+, it is considered smaller than _obj_, and if _range.end_ is +nil+, it is considered greater than _obj_. -20.clamp(0..) #=> 0 523.clamp(..100) #=> 100 When _range.end_ is excluded and not +nil+, an exception is raised. 100.clamp(0...100) # ArgumentError ;T;[o;= ;3I" overload;F;40;;g;50;)I"clamp(min, max);T;IC;";T; @+ˆ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @+ˆ;[;I"@return [Object];T;0;6i;[[I"min;T0[I"max;T0; @+ˆo;= ;3I" overload;F;40;;g;50;)I"clamp(range);T;IC;";T; @+ˆ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @+ˆ;[;I"@return [Object];T;0;6i;[[I" range;T0; @+ˆ;[;I"zIn (min, max) form, returns _min_ if _obj_ <=> _min_ is less than zero, _max_ if _obj_ <=> _max_ is greater than zero, and _obj_ otherwise. 12.clamp(0, 100) #=> 12 523.clamp(0, 100) #=> 100 -3.123.clamp(0, 100) #=> 0 'd'.clamp('a', 'f') #=> 'd' 'z'.clamp('a', 'f') #=> 'f' In (range) form, returns _range.begin_ if _obj_ <=> _range.begin_ is less than zero, _range.end_ if _obj_ <=> _range.end_ is greater than zero, and _obj_ otherwise. 12.clamp(0..100) #=> 12 523.clamp(0..100) #=> 100 -3.123.clamp(0..100) #=> 0 'd'.clamp('a'..'f') #=> 'd' 'z'.clamp('a'..'f') #=> 'f' If _range.begin_ is +nil+, it is considered smaller than _obj_, and if _range.end_ is +nil+, it is considered greater than _obj_. -20.clamp(0..) #=> 0 523.clamp(..100) #=> 100 When _range.end_ is excluded and not +nil+, an exception is raised. 100.clamp(0...100) # ArgumentError @overload clamp(min, max) @return [Object] @overload clamp(range) @return [Object];T;0; @+ˆ;!F;"o;#;$T;%i´;&iÜ;'@j‡;(I"nstatic VALUE cmp_clamp(int argc, VALUE *argv, VALUE x) { VALUE min, max; int c, excl = 0; if (rb_scan_args(argc, argv, "11", &min, &max) == 1) { VALUE range = min; if (!rb_range_values(range, &min, &max, &excl)) { rb_raise(rb_eTypeError, "wrong argument type %s (expected Range)", rb_builtin_class_name(range)); } if (!NIL_P(max)) { if (excl) rb_raise(rb_eArgError, "cannot clamp with an exclusive range"); } } if (!NIL_P(min) && !NIL_P(max) && cmpint(min, max) > 0) { rb_raise(rb_eArgError, "min argument must be smaller than max argument"); } if (!NIL_P(min)) { c = cmpint(x, min); if (c == 0) return x; if (c < 0) return min; } if (!NIL_P(max)) { c = cmpint(x, max); if (c > 0) return max; } return x; };T;)I"static VALUE;T;*T;A@j‡;BIC;[;A@j‡;CIC;[;A@j‡;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@s‡i);F;:Comparable;;K;;;[;{;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 a value less than 0, returning 0, or returning a value greater than 0, depending on whether the receiver is less than, equal to, or greater than the other object. If the other object is not comparable then the <=> 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 a value less than 0, returning 0, or returning a value greater than 0, depending on whether the receiver is less than, equal to, or greater than the other object. If the other object is not comparable then the <=> 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; @j‡;!F;"o;#;$T;%iþ;&i#;'@;I"Comparable;F;A@<;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ïi"[@ïiw;T;;T;;K;;;[;{;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 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. If duplication is attempted, the same instance is returned. Integer.new(1) #=> NoMethodError: undefined method `new' for Integer:Class 1.dup #=> 1 1.object_id == 1.dup.object_id #=> true 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 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. If duplication is attempted, the same instance is returned. Integer.new(1) #=> NoMethodError: undefined method `new' for Integer:Class 1.dup #=> 1 1.object_id == 1.dup.object_id #=> true 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;"o;#;$T;%i";&ig;6i;'@;I"Numeric;F;S@];R;Fo; ;IC;[o;;F; ;;;;I"NilClass#to_c;F;[;[[@t i¤;T;;R;0;[;{;IC;"Returns zero as a complex. ;T;[o;= ;3I" overload;F;40;;R;50;)I" to_c;T;IC;";T; @}ˆ;>0;!F;[;[;I";T;0;6i;[; @}ˆ;[;I"0Returns zero as a complex. @overload to_c;T;0; @}ˆ;!F;"o;#;$T;%iž;&i¡;'@{ˆ;(I"Wstatic VALUE nilclass_to_c(VALUE self) { return rb_complex_new1(INT2FIX(0)); };T;)I"static VALUE;T;*To;;F; ;;;;I"NilClass#to_r;F;[;[[@¨ iP;T;;P;0;[;{;IC;" Returns zero as a rational. ;T;[o;= ;3I" overload;F;40;;P;50;)I" to_r;T;IC;";T; @“ˆ;>0;!F;[;[;I";T;0;6i;[; @“ˆ;[;I"1Returns zero as a rational. @overload to_r;T;0; @“ˆ;!F;"o;#;$T;%iJ;&iM;'@{ˆ;(I"Xstatic VALUE nilclass_to_r(VALUE self) { return rb_rational_new1(INT2FIX(0)); };T;)I"static VALUE;T;*To;;F; ;;;;I"NilClass#rationalize;F;[[@c0;[[@¨ i];T;;Q;0;[;{;IC;"PReturns zero as a rational. The optional argument +eps+ is always ignored. ;T;[o;= ;3I" overload;F;40;;Q;50;)I"rationalize([eps]);T;IC;";T; @©ˆ;>0;!F;[;[;I";T;0;6i;[[I" [eps];T0; @©ˆ;[;I"oReturns zero as a rational. The optional argument +eps+ is always ignored. @overload rationalize([eps]);T;0; @©ˆ;!F;"o;#;$T;%iV;&iZ;'@{ˆ;(I"ˆstatic VALUE nilclass_rationalize(int argc, VALUE *argv, VALUE self) { rb_check_arity(argc, 0, 1); return nilclass_to_r(self); };T;)I"static VALUE;T;*To;;F; ;;;;I"NilClass#to_i;F;[;[[@Ìi ;T;;–;0;[;{;IC;".Always returns zero. nil.to_i #=> 0 ;T;[o;= ;3I" overload;F;40;;–;50;)I" to_i;T;IC;";T; @Âˆ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @Âˆ;[;I"@return [0];T;0;6i;[; @Âˆ;[;I"MAlways returns zero. nil.to_i #=> 0 @overload to_i @return [0];T;0; @Âˆ;!F;"o;#;$T;%i;&i;'@{ˆ;(I"@static VALUE nil_to_i(VALUE obj) { return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;;;;I"NilClass#to_f;F;[;[[@Ìi/;T;;O;0;[;{;IC;"0Always returns zero. nil.to_f #=> 0.0 ;T;[o;= ;3I" overload;F;40;;O;50;)I" to_f;T;IC;";T; @Ýˆ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0.0;T; @Ýˆ;[;I"@return [0.0];T;0;6i;[; @Ýˆ;[;I"QAlways returns zero. nil.to_f #=> 0.0 @overload to_f @return [0.0];T;0; @Ýˆ;!F;"o;#;$T;%i&;&i,;'@{ˆ;(I"Bstatic VALUE nil_to_f(VALUE obj) { return DBL2NUM(0.0); };T;)I"static VALUE;T;*To;;F; ;;;;I"NilClass#to_s;F;[;[[@Ìi<;T;;q;0;[;{;IC;"%Always returns the empty string. ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @øˆ;>0;!F;[;[;I";T;0;6i;[; @øˆ;[;I"6Always returns the empty string. @overload to_s;T;0; @øˆ;!F;"o;#;$T;%i5;&i8;'@{ˆ;(I"Gstatic VALUE nil_to_s(VALUE obj) { return rb_cNilClass_to_s; };T;)I"static VALUE;T;*To;;F; ;;;;I"NilClass#to_a;F;[;[[@ÌiM;T;;!;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;%iB;&iI;'@{ˆ;(I"Dstatic VALUE nil_to_a(VALUE obj) { return rb_ary_new2(0); };T;)I"static VALUE;T;*To;;F; ;;;;I"NilClass#to_h;F;[;[[@Ìi^;T;;#;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;%iS;&iZ;'@{ˆ;(I"Cstatic VALUE nil_to_h(VALUE obj) { return rb_hash_new(); };T;)I"static VALUE;T;*To;;F; ;;;;I"NilClass#inspect;F;[;[[@Ìik;T;;r;0;[;{;IC;"%Always returns the string "nil". ;T;[o;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @*‰;>0;!F;[;[;I";T;0;6i;[; @*‰;[;I"9Always returns the string "nil". @overload inspect;T;0; @*‰;!F;"o;#;$T;%id;&ig;'@{ˆ;(I"Sstatic VALUE nil_inspect(VALUE obj) { return rb_usascii_str_new2("nil"); };T;)I"static VALUE;T;*To;;F; ;;;;I"NilClass#=~;F;[[I" obj2;T0;[[@Ìix;T;;];0;[;{;IC;"2Dummy pattern matching -- always returns nil. ;T;[o;= ;3I" overload;F;40;;];50;)I"=~(other);T;IC;";T; @@‰;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @@‰;[;I"@return [nil];T;0;6i;[[I" other;T0; @@‰;[;I"XDummy pattern matching -- always returns nil. @overload =~(other) @return [nil];T;0; @@‰;!F;"o;#;$T;%iq;&iu;'@{ˆ;(I"Hstatic VALUE nil_match(VALUE obj1, VALUE obj2) { return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"NilClass#&;F;[[I" obj2;T0;[[@Ìiì;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;= ;3I" overload;F;40;;”;50;)I"&(obj);T;IC;";T; @_‰;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" false;T; @_‰;[;I"@return [false];T;0;6i;[[I"obj;T0; @_‰o;= ;3I" overload;F;40;;”;50;)I"&(obj);T;IC;";T; @_‰;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" false;T; @_‰;[;I"@return [false];T;0;6i;[[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ê;'@{ˆ;(I"Istatic VALUE false_and(VALUE obj, VALUE obj2) { return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"NilClass#|;F;[;[;F;;(;;K;[;{;IC;";T;[;[;@|;0; @‰;'@{ˆ;*To;;F; ;;;;I"NilClass#^;F;[;[;F;:^;;K;[;{;IC;";T;[;[;@|;0; @–‰;'@{ˆ;*To;;F; ;;;;I"NilClass#===;F;[;[;F;;\;;K;[;{;IC;";T;[;[;@|;0; @Ÿ‰;'@{ˆ;*To;;F; ;;;;I"NilClass#nil?;F;[;[[@Ìi;T;;[;0;[;{;IC;"POnly the object nil responds true to nil?.;T;[o;= ;3I" overload;F;40;;[;50;)I" nil?;T;IC;";T; @¨‰;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" true;T; @¨‰;[;I"@return [true];T;0;6i;[; @¨‰;[;I"rOnly the object nil responds true to nil?. @overload nil? @return [true];T;0; @¨‰;!F;"o;#;$T;%i;&i;6i;'@{ˆ;(I":static VALUE rb_true(VALUE obj) { return Qtrue; };T;)I"static VALUE;T;*T;A@{ˆ;BIC;[;A@{ˆ;CIC;[;A@{ˆ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@Ìi[@Ìiç;T;: NilClass;;K;;;[;{;IC;"8The class of the singleton object nil.;T;[;[;I"; The class of the singleton object nil. ;T;0; @{ˆ;!F;"o;#;$T;%i;&i;6i;'@;I" NilClass;F;S@]@<o; ;IC;[…o;;F; ;;;;I"String#to_c;F;[;[[@t iö;T;;R;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;= ;3I" overload;F;40;;R;50;)I" to_c;T;IC;";T; @×‰;>0;!F;[;[;I";T;0;6i;[; @×‰;[;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ß;&ió;'@Õ‰;(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;)I"static VALUE;T;*To;;F; ;;;;I"String#to_r;F;[;[[@¨ iæ ;T;;P;0;[;{;IC;")Returns the result of interpreting leading characters in +str+ as a rational. Leading whitespace and extraneous characters past the end of a valid number are ignored. Digit sequences can be separated by an underscore. If there is not a valid number at the start of +str+, zero is returned. This method never raises an exception. ' 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) 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. "0.3".to_r == 3/10r #=> true 0.3.to_r == 3/10r #=> false See also Kernel#Rational. ;T;[o;= ;3I" overload;F;40;;P;50;)I" to_r;T;IC;";T; @í‰;>0;!F;[;[;I";T;0;6i;[; @í‰;[;I":Returns the result of interpreting leading characters in +str+ as a rational. Leading whitespace and extraneous characters past the end of a valid number are ignored. Digit sequences can be separated by an underscore. If there is not a valid number at the start of +str+, zero is returned. This method never raises an exception. ' 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) 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. "0.3".to_r == 3/10r #=> true 0.3.to_r == 3/10r #=> false See also Kernel#Rational. @overload to_r;T;0; @í‰;!F;"o;#;$T;%iÊ ;&iã ;'@Õ‰;(I"static VALUE string_to_r(VALUE self) { VALUE num; rb_must_asciicompat(self); num = parse_rat(RSTRING_PTR(self), RSTRING_END(self), 0, TRUE); if (RB_FLOAT_TYPE_P(num) && !FLOAT_ZERO_P(num)) rb_raise(rb_eFloatDomainError, "Infinity"); return num; };T;)I"static VALUE;T;*To;;F; ;F;;;I"String.try_convert;F;[[I"str;T0;[[I" string.c;Ti± ;T;;¤;0;[;{;IC;")If +object+ is a \String object, returns +object+. Otherwise if +object+ responds to :to_str, calls object.to_str and returns the result. Returns +nil+ if +object+ does not respond to :to_str Raises an exception unless object.to_str returns a \String object. ;T;[o;= ;3I" overload;F;40;;¤;50;)I"try_convert(object);T;IC;";T; @Š;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @Š;[;I"@return [Object, nil];T;0;6i;[[I"object;T0; @Š;[;I"aIf +object+ is a \String object, returns +object+. Otherwise if +object+ responds to :to_str, calls object.to_str and returns the result. Returns +nil+ if +object+ does not respond to :to_str Raises an exception unless object.to_str returns a \String object. @overload try_convert(object) @return [Object, nil];T;0; @Š;!F;"o;#;$T;%i¤ ;&i¯ ;'@Õ‰;(I"hstatic VALUE rb_str_s_try_convert(VALUE dummy, VALUE str) { return rb_check_string_type(str); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#initialize;F;[[@c0;[[@ Šiž;T;;Ð;0;[;{;IC;" Returns a new \String that is a copy of +string+. With no arguments, returns the empty string with the Encoding ASCII-8BIT: s = String.new s # => "" s.encoding # => # With the single \String argument +string+, returns a copy of +string+ with the same encoding as +string+: s = String.new("Que veut dire \u{e7}a?") s # => "Que veut dire \u{e7}a?" s.encoding # => # Literal strings like "" or here-documents always use {script encoding}[Encoding.html#class-Encoding-label-Script+encoding], unlike String.new. With keyword +encoding+, returns a copy of +str+ with the specified encoding: s = String.new(encoding: 'ASCII') s.encoding # => # s = String.new('foo', encoding: 'ASCII') s.encoding # => # Note that these are equivalent: s0 = String.new('foo', encoding: 'ASCII') s1 = 'foo'.force_encoding('ASCII') s0.encoding == s1.encoding # => true With keyword +capacity+, returns a copy of +str+; the given +capacity+ may set the size of the internal buffer, which may affect performance: String.new(capacity: 1) # => "" String.new(capacity: 4096) # => "" The +string+, +encoding+, and +capacity+ arguments may all be used together: String.new('hello', encoding: 'UTF-8', capacity: 25) ;T;[o;= ;3I" overload;F;40;;î;50;)I"new(string = '');T;IC;";T; @$Š;>0;!F;[;[;I";T;0;6i;[[I"string;TI"'';T; @$Šo;= ;3I" overload;F;40;;î;50;)I")new(string = '', encoding: encoding);T;IC;";T; @$Š;>0;!F;[;[;I";T;0;6i;[[I"string;TI"'';T[I"encoding:;TI" encoding;T; @$Šo;= ;3I" overload;F;40;;î;50;)I"%new(string = '', capacity: size);T;IC;";T; @$Š;>0;!F;[;[;I";T;0;6i;[[I"string;TI"'';T[I"capacity:;TI" size;T; @$Š;[;I"—Returns a new \String that is a copy of +string+. With no arguments, returns the empty string with the Encoding ASCII-8BIT: s = String.new s # => "" s.encoding # => # With the single \String argument +string+, returns a copy of +string+ with the same encoding as +string+: s = String.new("Que veut dire \u{e7}a?") s # => "Que veut dire \u{e7}a?" s.encoding # => # Literal strings like "" or here-documents always use {script encoding}[Encoding.html#class-Encoding-label-Script+encoding], unlike String.new. With keyword +encoding+, returns a copy of +str+ with the specified encoding: s = String.new(encoding: 'ASCII') s.encoding # => # s = String.new('foo', encoding: 'ASCII') s.encoding # => # Note that these are equivalent: s0 = String.new('foo', encoding: 'ASCII') s1 = 'foo'.force_encoding('ASCII') s0.encoding == s1.encoding # => true With keyword +capacity+, returns a copy of +str+; the given +capacity+ may set the size of the internal buffer, which may affect performance: String.new(capacity: 1) # => "" String.new(capacity: 4096) # => "" The +string+, +encoding+, and +capacity+ arguments may all be used together: String.new('hello', encoding: 'UTF-8', capacity: 25) @overload new(string = '') @overload new(string = '', encoding: encoding) @overload new(string = '', capacity: size);T;0; @$Š;!F;"o;#;$T;%ir;&iš;'@Õ‰;(I"[ static VALUE rb_str_init(int argc, VALUE *argv, VALUE str) { static ID keyword_ids[2]; VALUE orig, opt, venc, vcapa; VALUE kwargs[2]; rb_encoding *enc = 0; int n; if (!keyword_ids[0]) { keyword_ids[0] = rb_id_encoding(); CONST_ID(keyword_ids[1], "capacity"); } n = rb_scan_args(argc, argv, "01:", &orig, &opt); if (!NIL_P(opt)) { rb_get_kwargs(opt, keyword_ids, 0, 2, kwargs); venc = kwargs[0]; vcapa = kwargs[1]; if (venc != Qundef && !NIL_P(venc)) { enc = rb_to_encoding(venc); } if (vcapa != Qundef && !NIL_P(vcapa)) { long capa = NUM2LONG(vcapa); long len = 0; int termlen = enc ? rb_enc_mbminlen(enc) : 1; if (capa < STR_BUF_MIN_SIZE) { capa = STR_BUF_MIN_SIZE; } if (n == 1) { StringValue(orig); len = RSTRING_LEN(orig); if (capa < len) { capa = len; } if (orig == str) n = 0; } str_modifiable(str); if (STR_EMBED_P(str)) { /* make noembed always */ char *new_ptr = ALLOC_N(char, (size_t)capa + termlen); memcpy(new_ptr, RSTRING(str)->as.ary, RSTRING_EMBED_LEN_MAX + 1); RSTRING(str)->as.heap.ptr = new_ptr; } else if (FL_TEST(str, STR_SHARED|STR_NOFREE)) { const size_t size = (size_t)capa + termlen; const char *const old_ptr = RSTRING_PTR(str); const size_t osize = RSTRING(str)->as.heap.len + TERM_LEN(str); char *new_ptr = ALLOC_N(char, (size_t)capa + termlen); memcpy(new_ptr, old_ptr, osize < size ? osize : size); FL_UNSET_RAW(str, STR_SHARED|STR_NOFREE); RSTRING(str)->as.heap.ptr = new_ptr; } else if (STR_HEAP_SIZE(str) != (size_t)capa + termlen) { SIZED_REALLOC_N(RSTRING(str)->as.heap.ptr, char, (size_t)capa + termlen, STR_HEAP_SIZE(str)); } RSTRING(str)->as.heap.len = len; TERM_FILL(&RSTRING(str)->as.heap.ptr[len], termlen); if (n == 1) { memcpy(RSTRING(str)->as.heap.ptr, RSTRING_PTR(orig), len); rb_enc_cr_str_exact_copy(str, orig); } FL_SET(str, STR_NOEMBED); RSTRING(str)->as.heap.aux.capa = capa; } else if (n == 1) { rb_str_replace(str, orig); } if (enc) { rb_enc_associate(str, enc); ENC_CODERANGE_CLEAR(str); } } else if (n == 1) { rb_str_replace(str, orig); } return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#initialize_copy;F;[[I" str2;T0;[[@ Šiÿ;T;;g;0;[;{;IC;"Replaces the contents of str with the corresponding values in other_str. s = "hello" #=> "hello" s.replace "world" #=> "world" ;T;[o;= ;3I" overload;F;40;;¥;50;)I"replace(other_str);T;IC;";T; @ZŠ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ZŠ;[;I"@return [String];T;0;6i;[[I"other_str;T0; @ZŠ;[;I"ÏReplaces the contents of str with the corresponding values in other_str. s = "hello" #=> "hello" s.replace "world" #=> "world" @overload replace(other_str) @return [String];T;0; @ZŠ;!F;"o;#;$T;%iô;&iü;'@Õ‰;(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;)I" VALUE;T;*To;;F; ;;;;I"String#<=>;F;[[I" str2;T0;[[@ Ši• ;T;;c;0;[;{;IC;"TCompares +self+ and +other_string+, returning: - -1 if +other_string+ is larger. - 0 if the two are equal. - 1 if +other_string+ is smaller. - +nil+ if the two are incomparable. Examples: 'foo' <=> 'foo' # => 0 'foo' <=> 'food' # => -1 'food' <=> 'foo' # => 1 'FOO' <=> 'foo' # => -1 'foo' <=> 'FOO' # => 1 'foo' <=> 1 # => nil ;T;[o;= ;3I" overload;F;40;;c;50;)I"<=>(other_string);T;IC;";T; @yŠ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[ I"-1;TI"0;TI"1;TI"nil;T; @yŠ;[;I"@return [-1, 0, 1, nil];T;0;6i;[[I"other_string;T0; @yŠ;[;I"ŽCompares +self+ and +other_string+, returning: - -1 if +other_string+ is larger. - 0 if the two are equal. - 1 if +other_string+ is smaller. - +nil+ if the two are incomparable. Examples: 'foo' <=> 'foo' # => 0 'foo' <=> 'food' # => -1 'food' <=> 'foo' # => 1 'FOO' <=> 'foo' # => -1 'foo' <=> 'FOO' # => 1 'foo' <=> 1 # => nil @overload <=>(other_string) @return [-1, 0, 1, nil];T;0; @yŠ;!F;"o;#;$T;%i‚ ;&i’ ;'@Õ‰;(I"æstatic VALUE rb_str_cmp_m(VALUE str1, VALUE str2) { int result; VALUE s = rb_check_string_type(str2); if (NIL_P(s)) { return rb_invcmp(str1, str2); } result = rb_str_cmp(str1, s); return INT2FIX(result); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#==;F;[[I" str2;T0;[[@ Ši^ ;T;;`;0;[;{;IC;"ºReturns +true+ if +object+ has the same length and content; as +self+; +false+ otherwise: s = 'foo' s == 'foo' # => true s == 'food' # => false s == 'FOO' # => false Returns +false+ if the two strings' encodings are not compatible: "\u{e4 f6 fc}".encode("ISO-8859-1") == ("\u{c4 d6 dc}") # => false If +object+ is not an instance of \String but responds to +to_str+, then the two strings are compared using object.==. ;T;[o;= ;3I" overload;F;40;;`;50;)I"==(object);T;IC;";T; @›Š;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @›Š;[;I"@return [Boolean];T;0;6i;[[I"object;T0; @›Šo;= ;3I" overload;F;40;;\;50;)I"===(object);T;IC;";T; @›Š;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @›Š;[;I"@return [Boolean];T;0;6i;[[I"object;T0; @›Š;[;I"Returns +true+ if +object+ has the same length and content; as +self+; +false+ otherwise: s = 'foo' s == 'foo' # => true s == 'food' # => false s == 'FOO' # => false Returns +false+ if the two strings' encodings are not compatible: "\u{e4 f6 fc}".encode("ISO-8859-1") == ("\u{c4 d6 dc}") # => false If +object+ is not an instance of \String but responds to +to_str+, then the two strings are compared using object.==. @overload ==(object) @return [Boolean] @overload ===(object) @return [Boolean];T;0; @›Š;!F;"o;#;$T;%iK ;&i\ ;'@Õ‰;(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 rb_str_eql_internal(str1, str2); };T;)I" VALUE;T;*To;;F; ;;;;I"String#===;F;[[I" str2;T0;[[@ Ši^ ;T;;\;0;[;{;IC;"ºReturns +true+ if +object+ has the same length and content; as +self+; +false+ otherwise: s = 'foo' s == 'foo' # => true s == 'food' # => false s == 'FOO' # => false Returns +false+ if the two strings' encodings are not compatible: "\u{e4 f6 fc}".encode("ISO-8859-1") == ("\u{c4 d6 dc}") # => false If +object+ is not an instance of \String but responds to +to_str+, then the two strings are compared using object.==. ;T;[o;= ;3I" overload;F;40;;`;50;)I"==(object);T;IC;";T; @ÉŠ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ÉŠ;[;I"@return [Boolean];T;0;6i;[[I"object;T0; @ÉŠo;= ;3I" overload;F;40;;\;50;)I"===(object);T;IC;";T; @ÉŠ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ÉŠ;[;I"@return [Boolean];T;0;6i;[[I"object;T0; @ÉŠ;[;@ÅŠ;0; @ÉŠ;!F;"o;#;$T;%iK ;&i\ ;'@Õ‰;(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 rb_str_eql_internal(str1, str2); };T;)I" VALUE;T;*To;;F; ;;;;I"String#eql?;F;[[I" str2;T0;[[@ Šiz ;T;;_;0;[;{;IC;"FReturns +true+ if +object+ has the same length and content; as +self+; +false+ otherwise: s = 'foo' s.eql?('foo') # => true s.eql?('food') # => false s.eql?('FOO') # => false Returns +false+ if the two strings' encodings are not compatible: "\u{e4 f6 fc}".encode("ISO-8859-1").eql?("\u{c4 d6 dc}") # => false;T;[o;= ;3I" overload;F;40;;_;50;)I"eql?(object);T;IC;";T; @öŠ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @öŠ;[;I"@return [Boolean];T;0;6i;[[I"object;T0; @öŠ;[;I"t Returns +true+ if +object+ has the same length and content; as +self+; +false+ otherwise: s = 'foo' s.eql?('foo') # => true s.eql?('food') # => false s.eql?('FOO') # => false Returns +false+ if the two strings' encodings are not compatible: "\u{e4 f6 fc}".encode("ISO-8859-1").eql?("\u{c4 d6 dc}") # => false @overload eql?(object) @return [Boolean];T;0; @öŠ;!F;"o;#;$T;%ik ;&iw ;6i;'@Õ‰;(I"ÂMJIT_FUNC_EXPORTED VALUE rb_str_eql(VALUE str1, VALUE str2) { if (str1 == str2) return Qtrue; if (!RB_TYPE_P(str2, T_STRING)) return Qfalse; return rb_str_eql_internal(str1, str2); };T;)I"MJIT_FUNC_EXPORTED VALUE;T;*To;;F; ;;;;I"String#hash;F;[;[[@ Ši ;T;;b;0;[;{;IC;"qReturns the integer hash value for +self+. The value is based on the length, content and encoding of +self+. ;T;[o;= ;3I" overload;F;40;;b;50;)I" hash;T;IC;";T; @‹;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @‹;[;I"@return [Integer];T;0;6i;[; @‹;[;I"‘Returns the integer hash value for +self+. The value is based on the length, content and encoding of +self+. @overload hash @return [Integer];T;0; @‹;!F;"o;#;$T;%i ;&i ;'@Õ‰;(I"ostatic VALUE rb_str_hash_m(VALUE str) { st_index_t hval = rb_str_hash(str); return ST2FIX(hval); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#casecmp;F;[[I" str2;T0;[[@ Ši· ;T;:casecmp;0;[;{;IC;"„Compares +self+ and +other_string+, ignoring case, and returning: - -1 if +other_string+ is larger. - 0 if the two are equal. - 1 if +other_string+ is smaller. - +nil+ if the two are incomparable. Examples: 'foo'.casecmp('foo') # => 0 'foo'.casecmp('food') # => -1 'food'.casecmp('foo') # => 1 'FOO'.casecmp('foo') # => 0 'foo'.casecmp('FOO') # => 0 'foo'.casecmp(1) # => nil ;T;[o;= ;3I" overload;F;40;;k;50;)I"casecmp(other_str);T;IC;";T; @0‹;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[ I"-1;TI"0;TI"1;TI"nil;T; @0‹;[;I"@return [-1, 0, 1, nil];T;0;6i;[[I"other_str;T0; @0‹;[;I"¿Compares +self+ and +other_string+, ignoring case, and returning: - -1 if +other_string+ is larger. - 0 if the two are equal. - 1 if +other_string+ is smaller. - +nil+ if the two are incomparable. Examples: 'foo'.casecmp('foo') # => 0 'foo'.casecmp('food') # => -1 'food'.casecmp('foo') # => 1 'FOO'.casecmp('foo') # => 0 'foo'.casecmp('FOO') # => 0 'foo'.casecmp(1) # => nil @overload casecmp(other_str) @return [-1, 0, 1, nil];T;0; @0‹;!F;"o;#;$T;%i¤ ;&i´ ;'@Õ‰;(I"ªstatic VALUE rb_str_casecmp(VALUE str1, VALUE str2) { VALUE s = rb_check_string_type(str2); if (NIL_P(s)) { return Qnil; } return str_casecmp(str1, s); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#casecmp?;F;[[I" str2;T0;[[@ Ši ;T;: casecmp?;0;[;{;IC;"aReturns +true+ if +self+ and +other_string+ are equal after Unicode case folding, otherwise +false+: 'foo'.casecmp?('foo') # => true 'foo'.casecmp?('food') # => false 'food'.casecmp?('foo') # => true 'FOO'.casecmp?('foo') # => true 'foo'.casecmp?('FOO') # => true Returns +nil+ if the two values are incomparable: 'foo'.casecmp?(1) # => nil;T;[o;= ;3I" overload;F;40;;l;50;)I"casecmp?(other_string);T;IC;";T; @R‹;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" true;TI" false;TI"nil;T; @R‹;[;I"@return [true, false, nil];T;0;6i;[[I"other_string;T0; @R‹;[;I"¡Returns +true+ if +self+ and +other_string+ are equal after Unicode case folding, otherwise +false+: 'foo'.casecmp?('foo') # => true 'foo'.casecmp?('food') # => false 'food'.casecmp?('foo') # => true 'FOO'.casecmp?('foo') # => true 'foo'.casecmp?('FOO') # => true Returns +nil+ if the two values are incomparable: 'foo'.casecmp?(1) # => nil @overload casecmp?(other_string) @return [true, false, nil];T;0; @R‹;!F;"o;#;$T;%iú ;&i;6i;'@Õ‰;(I"®static VALUE rb_str_casecmp_p(VALUE str1, VALUE str2) { VALUE s = rb_check_string_type(str2); if (NIL_P(s)) { return Qnil; } return str_casecmp_p(str1, s); };T;)I"static VALUE;T;*To;;F; ;;;;I" String#+;F;[[I" str2;T0;[[@ Šiû;T;;&;0;[;{;IC;"Returns a new \String containing +other_string+ concatenated to +self+: "Hello from " + self.to_s # => "Hello from main" ;T;[o;= ;3I" overload;F;40;;&;50;)I"+(other_string);T;IC;";T; @s‹;>0;!F;[;[;I";T;0;6i;[[I"other_string;T0; @s‹;[;I"–Returns a new \String containing +other_string+ concatenated to +self+: "Hello from " + self.to_s # => "Hello from main" @overload +(other_string);T;0; @s‹;!F;"o;#;$T;%ió;&i÷;'@Õ‰;(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); if (len1 > LONG_MAX - len2) { rb_raise(rb_eArgError, "string size too big"); } 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); 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;)I" VALUE;T;*To;;F; ;;;;I" String#*;F;[[I" times;T0;[[@ ŠiA;T;;';0;[;{;IC;"wReturns a new \String containing +integer+ copies of +self+: "Ho! " * 3 # => "Ho! Ho! Ho! " "Ho! " * 0 # => "" ;T;[o;= ;3I" overload;F;40;;';50;)I"*(integer);T;IC;";T; @‹;>0;!F;[;[;I";T;0;6i;[[I"integer;T0; @‹;[;I"‰Returns a new \String containing +integer+ copies of +self+: "Ho! " * 3 # => "Ho! Ho! Ho! " "Ho! " * 0 # => "" @overload *(integer);T;0; @‹;!F;"o;#;$T;%i8;&i=;'@Õ‰;(I"yVALUE rb_str_times(VALUE str, VALUE times) { VALUE str2; long n, len; char *ptr2; int termlen; if (times == INT2FIX(1)) { return str_duplicate(rb_cString, str); } if (times == INT2FIX(0)) { str2 = str_alloc(rb_cString); rb_enc_copy(str2, str); return str2; } len = NUM2LONG(times); if (len < 0) { rb_raise(rb_eArgError, "negative argument"); } if (RSTRING_LEN(str) == 1 && RSTRING_PTR(str)[0] == 0) { str2 = str_alloc(rb_cString); if (!STR_EMBEDDABLE_P(len, 1)) { RSTRING(str2)->as.heap.aux.capa = len; RSTRING(str2)->as.heap.ptr = ZALLOC_N(char, (size_t)len + 1); STR_SET_NOEMBED(str2); } STR_SET_LEN(str2, len); rb_enc_copy(str2, str); return str2; } 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_cString, 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); rb_enc_cr_str_copy_for_substr(str2, str); return str2; };T;)I" VALUE;T;*To;;F; ;;;;I" String#%;F;[[I"arg;T0;[[@ Ši‡;T;;Û;0;[;{;IC;"áReturns the result of formatting +object+ into the format specification +self+ (see Kernel#sprintf for formatting details): "%05d" % 123 # => "00123" If +self+ contains multiple substitutions, +object+ must be an \Array or \Hash containing the values to be substituted: "%-5s: %016x" % [ "ID", self.object_id ] # => "ID : 00002b054ec93168" "foo = %{foo}" % {foo: 'bar'} # => "foo = bar" "foo = %{foo}, baz = %{baz}" % {foo: 'bar', baz: 'bat'} # => "foo = bar, baz = bat" ;T;[o;= ;3I" overload;F;40;;Û;50;)I"%(object);T;IC;";T; @§‹;>0;!F;[;[;I";T;0;6i;[[I"object;T0; @§‹;[;I"÷Returns the result of formatting +object+ into the format specification +self+ (see Kernel#sprintf for formatting details): "%05d" % 123 # => "00123" If +self+ contains multiple substitutions, +object+ must be an \Array or \Hash containing the values to be substituted: "%-5s: %016x" % [ "ID", self.object_id ] # => "ID : 00002b054ec93168" "foo = %{foo}" % {foo: 'bar'} # => "foo = bar" "foo = %{foo}, baz = %{baz}" % {foo: 'bar', baz: 'bat'} # => "foo = bar, baz = bat" @overload %(object);T;0; @§‹;!F;"o;#;$T;%ix;&iƒ;'@Õ‰;(I"ôstatic VALUE rb_str_format_m(VALUE str, VALUE arg) { VALUE tmp = rb_check_array_type(arg); if (!NIL_P(tmp)) { return rb_str_format(RARRAY_LENINT(tmp), RARRAY_CONST_PTR(tmp), str); } return rb_str_format(1, &arg, str); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#[];F;[[@c0;[[@ Ši©;T;;Â;0;[;{;IC;") Returns the substring of +self+ specified by the arguments. When the single \Integer argument +index+ is given, returns the 1-character substring found in +self+ at offset +index+: 'bar'[2] # => "r" Counts backward from the end of +self+ if +index+ is negative: 'foo'[-3] # => "f" Returns +nil+ if +index+ is out of range: 'foo'[3] # => nil 'foo'[-4] # => nil When the two \Integer arguments +start+ and +length+ are given, returns the substring of the given +length+ found in +self+ at offset +start+: 'foo'[0, 2] # => "fo" 'foo'[0, 0] # => "" Counts backward from the end of +self+ if +start+ is negative: 'foo'[-2, 2] # => "oo" Special case: returns a new empty \String if +start+ is equal to the length of +self+: 'foo'[3, 2] # => "" Returns +nil+ if +start+ is out of range: 'foo'[4, 2] # => nil 'foo'[-4, 2] # => nil Returns the trailing substring of +self+ if +length+ is large: 'foo'[1, 50] # => "oo" Returns +nil+ if +length+ is negative: 'foo'[0, -1] # => nil When the single \Range argument +range+ is given, derives +start+ and +length+ values from the given +range+, and returns values as above: - 'foo'[0..1] is equivalent to 'foo'[0, 2]. - 'foo'[0...1] is equivalent to 'foo'[0, 1]. When the \Regexp argument +regexp+ is given, and the +capture+ argument is 0, returns the first matching substring found in +self+, or +nil+ if none found: 'foo'[/o/] # => "o" 'foo'[/x/] # => nil s = 'hello there' s[/[aeiou](.)\1/] # => "ell" s[/[aeiou](.)\1/, 0] # => "ell" If argument +capture+ is given and not 0, it should be either an \Integer capture group index or a \String or \Symbol capture group name; the method call returns only the specified capture (see {Regexp Capturing}[Regexp.html#class-Regexp-label-Capturing]): s = 'hello there' s[/[aeiou](.)\1/, 1] # => "l" s[/(?[aeiou])(?[^aeiou])/, "non_vowel"] # => "l" s[/(?[aeiou])(?[^aeiou])/, :vowel] # => "e" If an invalid capture group index is given, +nil+ is returned. If an invalid capture group name is given, +IndexError+ is raised. When the single \String argument +substring+ is given, returns the substring from +self+ if found, otherwise +nil+: 'foo'['oo'] # => "oo" 'foo'['xx'] # => nil String#slice is an alias for String#[]. ;T;[ o;= ;3I" overload;F;40;;Â;50;)I"[](index);T;IC;";T; @Á‹;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @Á‹;[;I"@return [nil];T;0;6i;[[I" index;T0; @Á‹o;= ;3I" overload;F;40;;Â;50;)I"[](start, length);T;IC;";T; @Á‹;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @Á‹;[;I"@return [nil];T;0;6i;[[I" start;T0[I"length;T0; @Á‹o;= ;3I" overload;F;40;;Â;50;)I"[](range);T;IC;";T; @Á‹;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @Á‹;[;I"@return [nil];T;0;6i;[[I" range;T0; @Á‹o;= ;3I" overload;F;40;;Â;50;)I"[](regexp, capture = 0);T;IC;";T; @Á‹;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @Á‹;[;I"@return [nil];T;0;6i;[[I"regexp;T0[I"capture;TI"0;T; @Á‹o;= ;3I" overload;F;40;;Â;50;)I"[](substring);T;IC;";T; @Á‹;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @Á‹;[;I"@return [nil];T;0;6i;[[I"substring;T0; @Á‹;[;I"ù Returns the substring of +self+ specified by the arguments. When the single \Integer argument +index+ is given, returns the 1-character substring found in +self+ at offset +index+: 'bar'[2] # => "r" Counts backward from the end of +self+ if +index+ is negative: 'foo'[-3] # => "f" Returns +nil+ if +index+ is out of range: 'foo'[3] # => nil 'foo'[-4] # => nil When the two \Integer arguments +start+ and +length+ are given, returns the substring of the given +length+ found in +self+ at offset +start+: 'foo'[0, 2] # => "fo" 'foo'[0, 0] # => "" Counts backward from the end of +self+ if +start+ is negative: 'foo'[-2, 2] # => "oo" Special case: returns a new empty \String if +start+ is equal to the length of +self+: 'foo'[3, 2] # => "" Returns +nil+ if +start+ is out of range: 'foo'[4, 2] # => nil 'foo'[-4, 2] # => nil Returns the trailing substring of +self+ if +length+ is large: 'foo'[1, 50] # => "oo" Returns +nil+ if +length+ is negative: 'foo'[0, -1] # => nil When the single \Range argument +range+ is given, derives +start+ and +length+ values from the given +range+, and returns values as above: - 'foo'[0..1] is equivalent to 'foo'[0, 2]. - 'foo'[0...1] is equivalent to 'foo'[0, 1]. When the \Regexp argument +regexp+ is given, and the +capture+ argument is 0, returns the first matching substring found in +self+, or +nil+ if none found: 'foo'[/o/] # => "o" 'foo'[/x/] # => nil s = 'hello there' s[/[aeiou](.)\1/] # => "ell" s[/[aeiou](.)\1/, 0] # => "ell" If argument +capture+ is given and not 0, it should be either an \Integer capture group index or a \String or \Symbol capture group name; the method call returns only the specified capture (see {Regexp Capturing}[Regexp.html#class-Regexp-label-Capturing]): s = 'hello there' s[/[aeiou](.)\1/, 1] # => "l" s[/(?[aeiou])(?[^aeiou])/, "non_vowel"] # => "l" s[/(?[aeiou])(?[^aeiou])/, :vowel] # => "e" If an invalid capture group index is given, +nil+ is returned. If an invalid capture group name is given, +IndexError+ is raised. When the single \String argument +substring+ is given, returns the substring from +self+ if found, otherwise +nil+: 'foo'['oo'] # => "oo" 'foo'['xx'] # => nil String#slice is an alias for String#[]. @overload [](index) @return [nil] @overload [](start, length) @return [nil] @overload [](range) @return [nil] @overload [](regexp, capture = 0) @return [nil] @overload [](substring) @return [nil];T;0; @Á‹;!F;"o;#;$T;%ib;&iª;'@Õ‰;(I"vstatic 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]); } else { long beg = NUM2LONG(argv[0]); long len = NUM2LONG(argv[1]); return rb_str_substr(str, beg, len); } } rb_check_arity(argc, 1, 2); return rb_str_aref(str, argv[0]); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#[]=;F;[[@c0;[[@ Š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 Integer allows you to specify which portion of the match to replace (effectively using the MatchData indexing rules. The forms that take an Integer 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;= ;3I" overload;F;40;;Ã;50;)I"[]=(integer);T;IC;";T; @ Œ;>0;!F;[;[;I";T;0;6i;[[I"integer;T0; @ Œo;= ;3I" overload;F;40;;Ã;50;)I"[]=(integer, integer);T;IC;";T; @ Œ;>0;!F;[;[;I";T;0;6i;[[I"integer;T0[I"integer;T0; @ Œo;= ;3I" overload;F;40;;Ã;50;)I"[]=(range);T;IC;";T; @ Œ;>0;!F;[;[;I";T;0;6i;[[I" range;T0; @ Œo;= ;3I" overload;F;40;;Ã;50;)I"[]=(regexp);T;IC;";T; @ Œ;>0;!F;[;[;I";T;0;6i;[[I"regexp;T0; @ Œo;= ;3I" overload;F;40;;Ã;50;)I"[]=(regexp, integer);T;IC;";T; @ Œ;>0;!F;[;[;I";T;0;6i;[[I"regexp;T0[I"integer;T0; @ Œo;= ;3I" overload;F;40;;Ã;50;)I"[]=(regexp, name);T;IC;";T; @ Œ;>0;!F;[;[;I";T;0;6i;[[I"regexp;T0[I" name;T0; @ Œo;= ;3I" overload;F;40;;Ã;50;)I"[]=(other_str);T;IC;";T; @ Œ;>0;!F;[;[;I";T;0;6i;[[I"other_str;T0; @ Œ;[;I"¹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 Integer allows you to specify which portion of the match to replace (effectively using the MatchData indexing rules. The forms that take an Integer 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 []=(integer) @overload []=(integer, integer) @overload []=(range) @overload []=(regexp) @overload []=(regexp, integer) @overload []=(regexp, name) @overload []=(other_str);T;0; @ Œ;!F;"o;#;$T;%ir;&i†;'@Õ‰;(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;)I"static VALUE;T;*To;;F; ;;;;I"String#insert;F;[[I"idx;T0[I" str2;T0;[[@ Ši©;T;;;0;[;{;IC;"ˆInserts the given +other_string+ into +self+; returns +self+. If the \Integer +index+ is positive, inserts +other_string+ at offset +index+: 'foo'.insert(1, 'bar') # => "fbaroo" If the \Integer +index+ is negative, counts backward from the end of +self+ and inserts +other_string+ at offset index+1 (that is, _after_ self[index]): 'foo'.insert(-2, 'bar') # => "fobaro" ;T;[o;= ;3I" overload;F;40;;;50;)I" insert(index, other_string);T;IC;";T; @{Œ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @{Œ;[;I"@return [self];T;0;6i;[[I" index;T0[I"other_string;T0; @{Œ;[;I"ÁInserts the given +other_string+ into +self+; returns +self+. If the \Integer +index+ is positive, inserts +other_string+ at offset +index+: 'foo'.insert(1, 'bar') # => "fbaroo" If the \Integer +index+ is negative, counts backward from the end of +self+ and inserts +other_string+ at offset index+1 (that is, _after_ self[index]): 'foo'.insert(-2, 'bar') # => "fobaro" @overload insert(index, other_string) @return [self];T;0; @{Œ;!F;"o;#;$T;%iš;&i¦;'@Õ‰;(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;)I"static VALUE;T;*To;;F; ;;;;I"String#length;F;[;[[@ ŠiÊ;T;;°;0;[;{;IC;"²Returns the count of characters (not bytes) in +self+: "\x80\u3042".length # => 2 "hello".length # => 5 String#size is an alias for String#length. Related: String#bytesize. ;T;[o;= ;3I" overload;F;40;;°;50;)I"length;T;IC;";T; @žŒ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @žŒ;[;I"@return [Integer];T;0;6i;[; @žŒ;[;I"ÙReturns the count of characters (not bytes) in +self+: "\x80\u3042".length # => 2 "hello".length # => 5 String#size is an alias for String#length. Related: String#bytesize. @overload length @return [Integer];T;0; @žŒ;!F;"o;#;$T;%i½;&iÇ;'@Õ‰;(I"SVALUE rb_str_length(VALUE str) { return LONG2NUM(str_strlen(str, NULL)); };T;)I" VALUE;T;*To;;F; ;;;;I"String#size;F;[;[[@ ŠiÊ;T;;¯;0;[;{;IC;"²Returns the count of characters (not bytes) in +self+: "\x80\u3042".length # => 2 "hello".length # => 5 String#size is an alias for String#length. Related: String#bytesize. ;T;[o;= ;3I" overload;F;40;;°;50;)I"length;T;IC;";T; @¹Œ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¹Œ;[;I"@return [Integer];T;0;6i;[; @¹Œ;[;@µŒ;0; @¹Œ;!F;"o;#;$T;%i½;&iÇ;'@Õ‰;(I"SVALUE rb_str_length(VALUE str) { return LONG2NUM(str_strlen(str, NULL)); };T;)I" VALUE;T;*To;;F; ;;;;I"String#bytesize;F;[;[[@ ŠiÛ;T;: bytesize;0;[;{;IC;"}Returns the count of bytes in +self+: "\x80\u3042".bytesize # => 4 "hello".bytesize # => 5 Related: String#length. ;T;[o;= ;3I" overload;F;40;;m;50;)I" bytesize;T;IC;";T; @ÓŒ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ÓŒ;[;I"@return [Integer];T;0;6i;[; @ÓŒ;[;I"¡Returns the count of bytes in +self+: "\x80\u3042".bytesize # => 4 "hello".bytesize # => 5 Related: String#length. @overload bytesize @return [Integer];T;0; @ÓŒ;!F;"o;#;$T;%iÐ;&iØ;'@Õ‰;(I"Wstatic VALUE rb_str_bytesize(VALUE str) { return LONG2NUM(RSTRING_LEN(str)); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#empty?;F;[;[[@ Šië;T;;±;0;[;{;IC;"ŒReturns +true+ if the length of +self+ is zero, +false+ otherwise: "hello".empty? # => false " ".empty? # => false "".empty? # => true;T;[o;= ;3I" overload;F;40;;±;50;)I"empty?;T;IC;";T; @îŒ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @îŒ;[;I"@return [Boolean];T;0;6i;[; @îŒ;[;I"³Returns +true+ if the length of +self+ is zero, +false+ otherwise: "hello".empty? # => false " ".empty? # => false "".empty? # => true @overload empty? @return [Boolean];T;0; @îŒ;!F;"o;#;$T;%iá;&iè;6i;'@Õ‰;(I"nstatic VALUE rb_str_empty(VALUE str) { if (RSTRING_LEN(str) == 0) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#=~;F;[[I"y;T0;[[@ ŠiŠ;T;;];0;[;{;IC;"žReturns the \Integer index of the first substring that matches the given +regexp+, or +nil+ if no match found: 'foo' =~ /f/ # => 0 'foo' =~ /o/ # => 1 'foo' =~ /x/ # => nil Note: also updates {Regexp-related global variables}[Regexp.html#class-Regexp-label-Special+global+variables]. If the given +object+ is not a \Regexp, returns the value returned by object =~ self. Note that string =~ regexp is different from regexp =~ string (see {Regexp#=~}[https://ruby-doc.org/core-2.7.1/Regexp.html#method-i-3D-7E]): number= nil "no. 9" =~ /(?\d+)/ number # => nil (not assigned) /(?\d+)/ =~ "no. 9" number #=> "9" ;T;[o;= ;3I" overload;F;40;;];50;)I"=~(regexp);T;IC;";T; @ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @ ;[;I"@return [Integer, nil];T;0;6i;[[I"regexp;T0; @ o;= ;3I" overload;F;40;;];50;)I"=~(object);T;IC;";T; @ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @ ;[;I"@return [Integer, nil];T;0;6i;[[I"object;T0; @ ;[;I"üReturns the \Integer index of the first substring that matches the given +regexp+, or +nil+ if no match found: 'foo' =~ /f/ # => 0 'foo' =~ /o/ # => 1 'foo' =~ /x/ # => nil Note: also updates {Regexp-related global variables}[Regexp.html#class-Regexp-label-Special+global+variables]. If the given +object+ is not a \Regexp, returns the value returned by object =~ self. Note that string =~ regexp is different from regexp =~ string (see {Regexp#=~}[https://ruby-doc.org/core-2.7.1/Regexp.html#method-i-3D-7E]): number= nil "no. 9" =~ /(?\d+)/ number # => nil (not assigned) /(?\d+)/ =~ "no. 9" number #=> "9" @overload =~(regexp) @return [Integer, nil] @overload =~(object) @return [Integer, nil];T;0; @ ;!F;"o;#;$T;%ip;&iˆ;'@Õ‰;(I"static VALUE rb_str_match(VALUE x, VALUE y) { switch (OBJ_BUILTIN_TYPE(y)) { case T_STRING: rb_raise(rb_eTypeError, "type mismatch: String given"); case T_REGEXP: return rb_reg_match(y, x); default: return rb_funcall(y, idEqTilde, 1, x); } };T;)I"static VALUE;T;*To;;F; ;;;;I"String#match;F;[[@c0;[[@ Ši½;T;: match;0;[;{;IC;"Returns a \Matchdata object (or +nil+) based on +self+ and the given +pattern+. Note: also updates {Regexp-related global variables}[Regexp.html#class-Regexp-label-Special+global+variables]. - Computes +regexp+ by converting +pattern+ (if not already a \Regexp). regexp = Regexp.new(pattern) - Computes +matchdata+, which will be either a \MatchData object or +nil+ (see Regexp#match): matchdata = regexp.match(self) With no block given, returns the computed +matchdata+: 'foo'.match('f') # => # 'foo'.match('o') # => # 'foo'.match('x') # => nil If \Integer argument +offset+ is given, the search begins at index +offset+: 'foo'.match('f', 1) # => nil 'foo'.match('o', 1) # => # With a block given, calls the block with the computed +matchdata+ and returns the block's return value: 'foo'.match(/o/) {|matchdata| matchdata } # => # 'foo'.match(/x/) {|matchdata| matchdata } # => nil 'foo'.match(/f/, 1) {|matchdata| matchdata } # => nil ;T;[o;= ;3I" overload;F;40;;n;50;)I"match(pattern, offset = 0);T;IC;";T; @9;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"MatchData;TI"nil;T; @9;[;I"@return [MatchData, nil];T;0;6i;[[I"pattern;T0[I"offset;TI"0;T; @9o;= ;3I" overload;F;40;;n;50;)I"match(pattern, offset = 0);T;IC;";T; @9;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"matchdata;T; @9o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @9;[;I"(@yield [matchdata] @return [Object];T;0;6i;[[I"pattern;T0[I"offset;TI"0;T; @9;[;I"–Returns a \Matchdata object (or +nil+) based on +self+ and the given +pattern+. Note: also updates {Regexp-related global variables}[Regexp.html#class-Regexp-label-Special+global+variables]. - Computes +regexp+ by converting +pattern+ (if not already a \Regexp). regexp = Regexp.new(pattern) - Computes +matchdata+, which will be either a \MatchData object or +nil+ (see Regexp#match): matchdata = regexp.match(self) With no block given, returns the computed +matchdata+: 'foo'.match('f') # => # 'foo'.match('o') # => # 'foo'.match('x') # => nil If \Integer argument +offset+ is given, the search begins at index +offset+: 'foo'.match('f', 1) # => nil 'foo'.match('o', 1) # => # With a block given, calls the block with the computed +matchdata+ and returns the block's return value: 'foo'.match(/o/) {|matchdata| matchdata } # => # 'foo'.match(/x/) {|matchdata| matchdata } # => nil 'foo'.match(/f/, 1) {|matchdata| matchdata } # => nil @overload match(pattern, offset = 0) @return [MatchData, nil] @overload match(pattern, offset = 0) @yield [matchdata] @return [Object];T;0; @9;!F;"o;#;$T;%i;&i¼;'@Õ‰;(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_funcallv(get_pat(re), rb_intern("match"), argc, argv); if (!NIL_P(result) && rb_block_given_p()) { return rb_yield(result); } return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#match?;F;[[@c0;[[@ Šiã;T;:match?;0;[;{;IC;"zReturns +true+ or +false+ based on whether a match is found for +self+ and +pattern+. Note: does not update {Regexp-related global variables}[Regexp.html#class-Regexp-label-Special+global+variables]. Computes +regexp+ by converting +pattern+ (if not already a \Regexp). regexp = Regexp.new(pattern) Returns +true+ if self+.match(regexp) returns a \Matchdata object, +false+ otherwise: 'foo'.match?(/o/) # => true 'foo'.match?('o') # => true 'foo'.match?(/x/) # => false If \Integer argument +offset+ is given, the search begins at index +offset+: 'foo'.match?('f', 1) # => false 'foo'.match?('o', 1) # => true;T;[o;= ;3I" overload;F;40;;o;50;)I" match?(pattern, offset = 0);T;IC;";T; @r;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @r;[;I"@return [Boolean];T;0;6i;[[I"pattern;T0[I"offset;TI"0;T; @r;[;I"¶Returns +true+ or +false+ based on whether a match is found for +self+ and +pattern+. Note: does not update {Regexp-related global variables}[Regexp.html#class-Regexp-label-Special+global+variables]. Computes +regexp+ by converting +pattern+ (if not already a \Regexp). regexp = Regexp.new(pattern) Returns +true+ if self+.match(regexp) returns a \Matchdata object, +false+ otherwise: 'foo'.match?(/o/) # => true 'foo'.match?('o') # => true 'foo'.match?(/x/) # => false If \Integer argument +offset+ is given, the search begins at index +offset+: 'foo'.match?('f', 1) # => false 'foo'.match?('o', 1) # => true @overload match?(pattern, offset = 0) @return [Boolean];T;0; @r;!F;"o;#;$T;%iÌ;&ià;6i;'@Õ‰;(I"Òstatic VALUE rb_str_match_m_p(int argc, VALUE *argv, VALUE str) { VALUE re; rb_check_arity(argc, 1, 2); re = get_pat(argv[0]); return rb_reg_match_p(re, str, argc > 1 ? NUM2LONG(argv[1]) : 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#succ;F;[;[[@ ŠiÚ;T;: succ;0;[;{;IC;"¿Returns the successor to +self+. The successor is calculated by incrementing characters. The first character to be incremented is the rightmost alphanumeric: or, if no alphanumerics, the rightmost character: 'THX1138'.succ # => "THX1139" '<>'.succ # => "<>" '***'.succ # => '**+' The successor to a digit is another digit, "carrying" to the next-left character for a "rollover" from 9 to 0, and prepending another digit if necessary: '00'.succ # => "01" '09'.succ # => "10" '99'.succ # => "100" The successor to a letter is another letter of the same case, carrying to the next-left character for a rollover, and prepending another same-case letter if necessary: 'aa'.succ # => "ab" 'az'.succ # => "ba" 'zz'.succ # => "aaa" 'AA'.succ # => "AB" 'AZ'.succ # => "BA" 'ZZ'.succ # => "AAA" The successor to a non-alphanumeric character is the next character in the underlying character set's collating sequence, carrying to the next-left character for a rollover, and prepending another character if necessary: s = 0.chr * 3 s # => "\x00\x00\x00" s.succ # => "\x00\x00\x01" s = 255.chr * 3 s # => "\xFF\xFF\xFF" s.succ # => "\x01\x00\x00\x00" Carrying can occur between and among mixtures of alphanumeric characters: s = 'zz99zz99' s.succ # => "aaa00aa00" s = '99zz99zz' s.succ # => "100aa00aa" The successor to an empty \String is a new empty \String: ''.succ # => "" String#next is an alias for String#succ. ;T;[o;= ;3I" overload;F;40;;p;50;)I" succ;T;IC;";T; @“;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @“;[;I"@return [String];T;0;6i;[; @“;[;I"ãReturns the successor to +self+. The successor is calculated by incrementing characters. The first character to be incremented is the rightmost alphanumeric: or, if no alphanumerics, the rightmost character: 'THX1138'.succ # => "THX1139" '<>'.succ # => "<>" '***'.succ # => '**+' The successor to a digit is another digit, "carrying" to the next-left character for a "rollover" from 9 to 0, and prepending another digit if necessary: '00'.succ # => "01" '09'.succ # => "10" '99'.succ # => "100" The successor to a letter is another letter of the same case, carrying to the next-left character for a rollover, and prepending another same-case letter if necessary: 'aa'.succ # => "ab" 'az'.succ # => "ba" 'zz'.succ # => "aaa" 'AA'.succ # => "AB" 'AZ'.succ # => "BA" 'ZZ'.succ # => "AAA" The successor to a non-alphanumeric character is the next character in the underlying character set's collating sequence, carrying to the next-left character for a rollover, and prepending another character if necessary: s = 0.chr * 3 s # => "\x00\x00\x00" s.succ # => "\x00\x00\x01" s = 255.chr * 3 s # => "\xFF\xFF\xFF" s.succ # => "\x01\x00\x00\x00" Carrying can occur between and among mixtures of alphanumeric characters: s = 'zz99zz99' s.succ # => "aaa00aa00" s = '99zz99zz' s.succ # => "100aa00aa" The successor to an empty \String is a new empty \String: ''.succ # => "" String#next is an alias for String#succ. @overload succ @return [String];T;0; @“;!F;"o;#;$T;%i¥;&i×;'@Õ‰;(I"´VALUE rb_str_succ(VALUE orig) { VALUE str; str = rb_str_new(RSTRING_PTR(orig), RSTRING_LEN(orig)); rb_enc_cr_str_copy_for_substr(str, orig); return str_succ(str); };T;)I" VALUE;T;*To;;F; ;;;;I"String#succ!;F;[;[[@ ŠiD;T;: succ!;0;[;{;IC;"yEquivalent to String#succ, but modifies +self+ in place; returns +self+. String#next! is an alias for String#succ!. ;T;[o;= ;3I" overload;F;40;;q;50;)I" succ!;T;IC;";T; @®;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @®;[;I"@return [self];T;0;6i;[; @®;[;I"—Equivalent to String#succ, but modifies +self+ in place; returns +self+. String#next! is an alias for String#succ!. @overload succ! @return [self];T;0; @®;!F;"o;#;$T;%i;;&iA;'@Õ‰;(I"lstatic VALUE rb_str_succ_bang(VALUE str) { rb_str_modify(str); str_succ(str); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#next;F;[;[[@ ŠiÚ;T;: next;0;[;{;IC;"¿Returns the successor to +self+. The successor is calculated by incrementing characters. The first character to be incremented is the rightmost alphanumeric: or, if no alphanumerics, the rightmost character: 'THX1138'.succ # => "THX1139" '<>'.succ # => "<>" '***'.succ # => '**+' The successor to a digit is another digit, "carrying" to the next-left character for a "rollover" from 9 to 0, and prepending another digit if necessary: '00'.succ # => "01" '09'.succ # => "10" '99'.succ # => "100" The successor to a letter is another letter of the same case, carrying to the next-left character for a rollover, and prepending another same-case letter if necessary: 'aa'.succ # => "ab" 'az'.succ # => "ba" 'zz'.succ # => "aaa" 'AA'.succ # => "AB" 'AZ'.succ # => "BA" 'ZZ'.succ # => "AAA" The successor to a non-alphanumeric character is the next character in the underlying character set's collating sequence, carrying to the next-left character for a rollover, and prepending another character if necessary: s = 0.chr * 3 s # => "\x00\x00\x00" s.succ # => "\x00\x00\x01" s = 255.chr * 3 s # => "\xFF\xFF\xFF" s.succ # => "\x01\x00\x00\x00" Carrying can occur between and among mixtures of alphanumeric characters: s = 'zz99zz99' s.succ # => "aaa00aa00" s = '99zz99zz' s.succ # => "100aa00aa" The successor to an empty \String is a new empty \String: ''.succ # => "" String#next is an alias for String#succ. ;T;[o;= ;3I" overload;F;40;;p;50;)I" succ;T;IC;";T; @É;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @É;[;I"@return [String];T;0;6i;[; @É;[;@ª;0; @É;!F;"o;#;$T;%i¥;&i×;'@Õ‰;(I"´VALUE rb_str_succ(VALUE orig) { VALUE str; str = rb_str_new(RSTRING_PTR(orig), RSTRING_LEN(orig)); rb_enc_cr_str_copy_for_substr(str, orig); return str_succ(str); };T;)I" VALUE;T;*To;;F; ;;;;I"String#next!;F;[;[[@ ŠiD;T;: next!;0;[;{;IC;"yEquivalent to String#succ, but modifies +self+ in place; returns +self+. String#next! is an alias for String#succ!. ;T;[o;= ;3I" overload;F;40;;q;50;)I" succ!;T;IC;";T; @ã;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @ã;[;I"@return [self];T;0;6i;[; @ã;[;@Å;0; @ã;!F;"o;#;$T;%i;;&iA;'@Õ‰;(I"lstatic VALUE rb_str_succ_bang(VALUE str) { rb_str_modify(str); str_succ(str); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#upto;F;[[@c0;[[@ Šix;T;: upto;0;[;{;IC;"áWith a block given, calls the block with each \String value returned by successive calls to String#succ; the first value is +self+, the next is self.succ, and so on; the sequence terminates when value +other_string+ is reached; returns +self+: 'a8'.upto('b6') {|s| print s, ' ' } # => "a8" Output: a8 a9 b0 b1 b2 b3 b4 b5 b6 If argument +exclusive+ is given as a truthy object, the last value is omitted: 'a8'.upto('b6', true) {|s| print s, ' ' } # => "a8" Output: a8 a9 b0 b1 b2 b3 b4 b5 If +other_string+ would not be reached, does not call the block: '25'.upto('5') {|s| fail s } 'aa'.upto('a') {|s| fail s } With no block given, returns a new \Enumerator: 'a8'.upto('b6') # => # ;T;[o;= ;3I" overload;F;40;;t;50;)I"*upto(other_string, exclusive = false);T;IC;";T; @ý;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"string;T; @ýo;2 ;3I"return;F;4I";T;0;5[I" self;T; @ý;[;I"#@yield [string] @return [self];T;0;6i;[[I"other_string;T0[I"exclusive;TI" false;T; @ýo;= ;3I" overload;F;40;;t;50;)I"*upto(other_string, exclusive = false);T;IC;";T; @ý;>0;!F;[;[;I";T;0;6i;[[I"other_string;T0[I"exclusive;TI" false;T; @ý;[;I"fWith a block given, calls the block with each \String value returned by successive calls to String#succ; the first value is +self+, the next is self.succ, and so on; the sequence terminates when value +other_string+ is reached; returns +self+: 'a8'.upto('b6') {|s| print s, ' ' } # => "a8" Output: a8 a9 b0 b1 b2 b3 b4 b5 b6 If argument +exclusive+ is given as a truthy object, the last value is omitted: 'a8'.upto('b6', true) {|s| print s, ' ' } # => "a8" Output: a8 a9 b0 b1 b2 b3 b4 b5 If +other_string+ would not be reached, does not call the block: '25'.upto('5') {|s| fail s } 'aa'.upto('a') {|s| fail s } With no block given, returns a new \Enumerator: 'a8'.upto('b6') # => # @overload upto(other_string, exclusive = false) @yield [string] @return [self] @overload upto(other_string, exclusive = false);T;0; @ý;!F;"o;#;$T;%i];&iv;'@Õ‰;(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 rb_str_upto_each(beg, end, RTEST(exclusive), str_upto_i, Qnil); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#index;F;[[@c0;[[@ Ši…;T;;;0;[;{;IC;"3Returns the \Integer index of the first occurrence of the given +substring+, or +nil+ if none found: 'foo'.index('f') # => 0 'foo'.index('o') # => 1 'foo'.index('oo') # => 1 'foo'.index('ooo') # => nil Returns the \Integer index of the first match for the given \Regexp +regexp+, or +nil+ if none found: 'foo'.index(/f/) # => 0 'foo'.index(/o/) # => 1 'foo'.index(/oo/) # => 1 'foo'.index(/ooo/) # => nil \Integer argument +offset+, if given, specifies the position in the string to begin the search: 'foo'.index('o', 1) # => 1 'foo'.index('o', 2) # => 2 'foo'.index('o', 3) # => nil If +offset+ is negative, counts backward from the end of +self+: 'foo'.index('o', -1) # => 2 'foo'.index('o', -2) # => 1 'foo'.index('o', -3) # => 1 'foo'.index('o', -4) # => nil Related: String#rindex ;T;[o;= ;3I" overload;F;40;;;50;)I"!index(substring, offset = 0);T;IC;";T; @0Ž;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @0Ž;[;I"@return [Integer, nil];T;0;6i;[[I"substring;T0[I"offset;TI"0;T; @0Žo;= ;3I" overload;F;40;;;50;)I"index(regexp, offset = 0);T;IC;";T; @0Ž;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @0Ž;[;I"@return [Integer, nil];T;0;6i;[[I"regexp;T0[I"offset;TI"0;T; @0Ž;[;I"²Returns the \Integer index of the first occurrence of the given +substring+, or +nil+ if none found: 'foo'.index('f') # => 0 'foo'.index('o') # => 1 'foo'.index('oo') # => 1 'foo'.index('ooo') # => nil Returns the \Integer index of the first match for the given \Regexp +regexp+, or +nil+ if none found: 'foo'.index(/f/) # => 0 'foo'.index(/o/) # => 1 'foo'.index(/oo/) # => 1 'foo'.index(/ooo/) # => nil \Integer argument +offset+, if given, specifies the position in the string to begin the search: 'foo'.index('o', 1) # => 1 'foo'.index('o', 2) # => 2 'foo'.index('o', 3) # => nil If +offset+ is negative, counts backward from the end of +self+: 'foo'.index('o', -1) # => 2 'foo'.index('o', -2) # => 1 'foo'.index('o', -3) # => 1 'foo'.index('o', -4) # => nil Related: String#rindex @overload index(substring, offset = 0) @return [Integer, nil] @overload index(regexp, offset = 0) @return [Integer, nil];T;0; @0Ž;!F;"o;#;$T;%ic;&iƒ;'@Õ‰;(I"%static 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 (RB_TYPE_P(sub, 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)); if (rb_reg_search(sub, str, pos, 0) < 0) { return Qnil; } else { VALUE match = rb_backref_get(); struct re_registers *regs = RMATCH_REGS(match); pos = rb_str_sublen(str, BEG(0)); return LONG2NUM(pos); } } else { StringValue(sub); pos = rb_str_index(str, sub, pos); pos = rb_str_sublen(str, pos); } if (pos == -1) return Qnil; return LONG2NUM(pos); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#rindex;F;[[@c0;[[@ ŠiC;T;;;0;[;{;IC;"dReturns the \Integer index of the _last_ occurrence of the given +substring+, or +nil+ if none found: 'foo'.rindex('f') # => 0 'foo'.rindex('o') # => 2 'foo'.rindex('oo') # => 1 'foo'.rindex('ooo') # => nil Returns the \Integer index of the _last_ match for the given \Regexp +regexp+, or +nil+ if none found: 'foo'.rindex(/f/) # => 0 'foo'.rindex(/o/) # => 2 'foo'.rindex(/oo/) # => 1 'foo'.rindex(/ooo/) # => nil The _last_ match means starting at the possible last position, not the last of longest matches. 'foo'.rindex(/o+/) # => 2 $~ #=> # To get the last longest match, needs to combine with negative lookbehind. 'foo'.rindex(/(? 1 $~ #=> # Or String#index with negative lookforward. 'foo'.index(/o+(?!.*o)/) # => 1 $~ #=> # \Integer argument +offset+, if given and non-negative, specifies the maximum starting position in the string to _end_ the search: 'foo'.rindex('o', 0) # => nil 'foo'.rindex('o', 1) # => 1 'foo'.rindex('o', 2) # => 2 'foo'.rindex('o', 3) # => 2 If +offset+ is a negative \Integer, the maximum starting position in the string to _end_ the search is the sum of the string's length and +offset+: 'foo'.rindex('o', -1) # => 2 'foo'.rindex('o', -2) # => 1 'foo'.rindex('o', -3) # => nil 'foo'.rindex('o', -4) # => nil Related: String#index ;T;[o;= ;3I" overload;F;40;;;50;)I",rindex(substring, offset = self.length);T;IC;";T; @eŽ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @eŽ;[;I"@return [Integer, nil];T;0;6i;[[I"substring;T0[I"offset;TI"self.length;T; @eŽo;= ;3I" overload;F;40;;;50;)I")rindex(regexp, offset = self.length);T;IC;";T; @eŽ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @eŽ;[;I"@return [Integer, nil];T;0;6i;[[I"regexp;T0[I"offset;TI"self.length;T; @eŽ;[;I"ùReturns the \Integer index of the _last_ occurrence of the given +substring+, or +nil+ if none found: 'foo'.rindex('f') # => 0 'foo'.rindex('o') # => 2 'foo'.rindex('oo') # => 1 'foo'.rindex('ooo') # => nil Returns the \Integer index of the _last_ match for the given \Regexp +regexp+, or +nil+ if none found: 'foo'.rindex(/f/) # => 0 'foo'.rindex(/o/) # => 2 'foo'.rindex(/oo/) # => 1 'foo'.rindex(/ooo/) # => nil The _last_ match means starting at the possible last position, not the last of longest matches. 'foo'.rindex(/o+/) # => 2 $~ #=> # To get the last longest match, needs to combine with negative lookbehind. 'foo'.rindex(/(? 1 $~ #=> # Or String#index with negative lookforward. 'foo'.index(/o+(?!.*o)/) # => 1 $~ #=> # \Integer argument +offset+, if given and non-negative, specifies the maximum starting position in the string to _end_ the search: 'foo'.rindex('o', 0) # => nil 'foo'.rindex('o', 1) # => 1 'foo'.rindex('o', 2) # => 2 'foo'.rindex('o', 3) # => 2 If +offset+ is a negative \Integer, the maximum starting position in the string to _end_ the search is the sum of the string's length and +offset+: 'foo'.rindex('o', -1) # => 2 'foo'.rindex('o', -2) # => 1 'foo'.rindex('o', -3) # => nil 'foo'.rindex('o', -4) # => nil Related: String#index @overload rindex(substring, offset = self.length) @return [Integer, nil] @overload rindex(regexp, offset = self.length) @return [Integer, nil];T;0; @eŽ;!F;"o;#;$T;%i;&iA;'@Õ‰;(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 (RB_TYPE_P(sub, T_REGEXP)) { /* enc = rb_get_check(str, sub); */ pos = str_offset(RSTRING_PTR(str), RSTRING_END(str), pos, enc, single_byte_optimizable(str)); if (rb_reg_search(sub, str, pos, 1) >= 0) { VALUE match = rb_backref_get(); struct re_registers *regs = RMATCH_REGS(match); pos = rb_str_sublen(str, BEG(0)); return LONG2NUM(pos); } } else { StringValue(sub); pos = rb_str_rindex(str, sub, pos); if (pos >= 0) return LONG2NUM(pos); } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#replace;F;[[I" str2;T0;[[@ Šiÿ;T;;¥;0;[;{;IC;"Replaces the contents of str with the corresponding values in other_str. s = "hello" #=> "hello" s.replace "world" #=> "world" ;T;[o;= ;3I" overload;F;40;;¥;50;)I"replace(other_str);T;IC;";T; @šŽ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @šŽ;[;I"@return [String];T;0;6i;[[I"other_str;T0; @šŽ;[;@uŠ;0; @šŽ;!F;"o;#;$T;%iô;&iü;'@Õ‰;(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;)I" VALUE;T;*To;;F; ;;;;I"String#clear;F;[;[[@ Ši;T;;Å;0;[;{;IC;"=Makes string empty. a = "abcde" a.clear #=> "" ;T;[o;= ;3I" overload;F;40;;Å;50;)I" clear;T;IC;";T; @¸Ž;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @¸Ž;[;I"@return [String];T;0;6i;[; @¸Ž;[;I"bMakes string empty. a = "abcde" a.clear #=> "" @overload clear @return [String];T;0; @¸Ž;!F;"o;#;$T;%i ;&i;'@Õ‰;(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;)I"static VALUE;T;*To;;F; ;;;;I"String#chr;F;[;[[@ Ši,;T;:chr;0;[;{;IC;"gReturns a one-character string at the beginning of the string. a = "abcde" a.chr #=> "a" ;T;[o;= ;3I" overload;F;40;;u;50;)I"chr;T;IC;";T; @ÓŽ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ÓŽ;[;I"@return [String];T;0;6i;[; @ÓŽ;[;I"…Returns a one-character string at the beginning of the string. a = "abcde" a.chr #=> "a" @overload chr @return [String];T;0; @ÓŽ;!F;"o;#;$T;%i";&i);'@Õ‰;(I"Pstatic VALUE rb_str_chr(VALUE str) { return rb_str_substr(str, 0, 1); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#getbyte;F;[[I" index;T0;[[@ Ši8;T;;;0;[;{;IC;"3returns the indexth byte as an integer. ;T;[o;= ;3I" overload;F;40;;;50;)I"getbyte(index);T;IC;";T; @îŽ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" 0 .. 255;T; @îŽ;[;I"@return [0 .. 255];T;0;6i;[[I" index;T0; @îŽ;[;I"creturns the indexth byte as an integer. @overload getbyte(index) @return [0 .. 255];T;0; @îŽ;!F;"o;#;$T;%i2;&i6;'@Õ‰;(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;)I"static VALUE;T;*To;;F; ;;;;I"String#setbyte;F;[[I" index;T0[I" value;T0;[[@ ŠiK;T;:setbyte;0;[;{;IC;"8modifies the indexth byte as integer. ;T;[o;= ;3I" overload;F;40;;v;50;)I"setbyte(index, integer);T;IC;";T; @ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ ;[;I"@return [Integer];T;0;6i;[[I" index;T0[I"integer;T0; @ ;[;I"pmodifies the indexth byte as integer. @overload setbyte(index, integer) @return [Integer];T;0; @ ;!F;"o;#;$T;%iE;&iI;'@Õ‰;(I"static VALUE rb_str_setbyte(VALUE str, VALUE index, VALUE value) { long pos = NUM2LONG(index); long len = RSTRING_LEN(str); char *head, *left = 0; unsigned char *ptr; 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; VALUE v = rb_to_int(value); VALUE w = rb_int_and(v, INT2FIX(0xff)); unsigned char byte = NUM2INT(w) & 0xFF; if (!str_independent(str)) str_make_independent(str); enc = STR_ENC_GET(str); head = RSTRING_PTR(str); ptr = (unsigned char *)&head[pos]; if (!STR_EMBED_P(str)) { cr = ENC_CODERANGE(str); switch (cr) { case ENC_CODERANGE_7BIT: left = (char *)ptr; *ptr = byte; if (ISASCII(byte)) goto end; 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;)I"static VALUE;T;*To;;F; ;;;;I"String#byteslice;F;[[@c0;[[@ Šié;T;:byteslice;0;[;{;IC;"1Byte Reference---If passed a single Integer, returns a substring of one byte at that position. If passed two Integer 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;= ;3I" overload;F;40;;w;50;)I"byteslice(integer);T;IC;";T; @0;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @0;[;I"@return [String, nil];T;0;6i;[[I"integer;T0; @0o;= ;3I" overload;F;40;;w;50;)I" byteslice(integer, integer);T;IC;";T; @0;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @0;[;I"@return [String, nil];T;0;6i;[[I"integer;T0[I"integer;T0; @0o;= ;3I" overload;F;40;;w;50;)I"byteslice(range);T;IC;";T; @0;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @0;[;I"@return [String, nil];T;0;6i;[[I" range;T0; @0;[;I"ÙByte Reference---If passed a single Integer, returns a substring of one byte at that position. If passed two Integer 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(integer) @return [String, nil] @overload byteslice(integer, integer) @return [String, nil] @overload byteslice(range) @return [String, nil];T;0; @0;!F;"o;#;$T;%iÒ;&iè;'@Õ‰;(I"static VALUE rb_str_byteslice(int argc, VALUE *argv, VALUE str) { if (argc == 2) { long beg = NUM2LONG(argv[0]); long end = NUM2LONG(argv[1]); return str_byte_substr(str, beg, end, TRUE); } rb_check_arity(argc, 1, 2); return str_byte_aref(str, argv[0]); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#scrub;F;[[@c0;[[@ Šif*;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;= ;3I" overload;F;40;;x;50;)I" scrub;T;IC;";T; @q;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @q;[;I"@return [String];T;0;6i;[; @qo;= ;3I" overload;F;40;;x;50;)I"scrub(repl);T;IC;";T; @q;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @q;[;I"@return [String];T;0;6i;[[I" repl;T0; @qo;= ;3I" overload;F;40;;x;50;)I" scrub;T;IC;";T; @q;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" bytes;T; @qo;2 ;3I"return;F;4I";T;0;5[I"String;T; @q;[;I"$@yield [bytes] @return [String];T;0;6i;[; @q;[;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; @q;!F;"o;#;$T;%iX*;&ig*;'@Õ‰;(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) ? str_duplicate(rb_cString, str): new; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#scrub!;F;[[@c0;[[@ Š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;= ;3I" overload;F;40;;y;50;)I"scrub!;T;IC;";T; @®;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @®;[;I"@return [String];T;0;6i;[; @®o;= ;3I" overload;F;40;;y;50;)I"scrub!(repl);T;IC;";T; @®;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @®;[;I"@return [String];T;0;6i;[[I" repl;T0; @®o;= ;3I" overload;F;40;;y;50;)I"scrub!;T;IC;";T; @®;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" bytes;T; @®o;2 ;3I"return;F;4I";T;0;5[I"String;T; @®;[;I"$@yield [bytes] @return [String];T;0;6i;[; @®;[;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;%in*;&i}*;'@Õ‰;(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;)I"static VALUE;T;*To;;F; ;;;;I"String#freeze;F;[;[[@ ŠiÍ ;T;;p;0;[;{;IC;";T;[;[;@|;0; @ë;'@Õ‰;(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;)I" VALUE;T;*To;;F; ;;;;I"String#+@;F;[;[[@ ŠiÞ ;T;;W;0;[;{;IC;"hReturns +self+ if +self+ is not frozen. Otherwise. returns self.dup, which is not frozen. ;T;[o;= ;3I" overload;F;40;;&;50;)I"+string;T;IC;";T; @÷;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @÷;[;I"@return [self];T;0;6i;[; @÷;[;I"ˆReturns +self+ if +self+ is not frozen. Otherwise. returns self.dup, which is not frozen. @overload +string @return [self];T;0; @÷;!F;"o;#;$T;%iÖ ;&iÜ ;'@Õ‰;(I"}static VALUE str_uplus(VALUE str) { if (OBJ_FROZEN(str)) { return rb_str_dup(str); } else { return str; } };T;)I"static VALUE;T;*To;;F; ;;;;I"String#-@;F;[;[[@ Šiò ;T;;9;0;[;{;IC;"¤Returns a frozen, possibly pre-existing copy of the string. The returned \String will be deduplicated as long as it does not have any instance variables set on it. ;T;[o;= ;3I" overload;F;40;;;50;)I"-string;T;IC;";T; @;>0;!F;[;[;I";T;0;6i;[; @;[;I"¸Returns a frozen, possibly pre-existing copy of the string. The returned \String will be deduplicated as long as it does not have any instance variables set on it. @overload -string;T;0; @;!F;"o;#;$T;%ié ;&iï ;'@Õ‰;(I"Ÿstatic VALUE str_uminus(VALUE str) { if (!BARE_STRING_P(str) && !rb_obj_frozen_p(str)) { str = rb_str_dup(str); } return rb_fstring(str); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#to_i;F;[[@c0;[[@ Ši;T;;–;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;= ;3I" overload;F;40;;–;50;)I"to_i(base=10);T;IC;";T; @(;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @(;[;I"@return [Integer];T;0;6i;[[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;%il;&i~;'@Õ‰;(I"ÿstatic VALUE rb_str_to_i(int argc, VALUE *argv, VALUE str) { int base = 10; if (rb_check_arity(argc, 0, 1) && (base = NUM2INT(argv[0])) < 0) { rb_raise(rb_eArgError, "invalid radix %d", base); } return rb_str_to_inum(str, base, FALSE); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#to_f;F;[;[[@ Ši›;T;;O;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;= ;3I" overload;F;40;;O;50;)I" to_f;T;IC;";T; @G;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @G;[;I"@return [Float];T;0;6i;[; @G;[;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; @G;!F;"o;#;$T;%i;&i˜;'@Õ‰;(I"[static VALUE rb_str_to_f(VALUE str) { return DBL2NUM(rb_str_to_dbl(str, FALSE)); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#to_s;F;[;[[@ Ši¬;T;;q;0;[;{;IC;"bReturns +self+. If called on a subclass of String, converts the receiver to a String object. ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @b;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @b;[;I"@return [String];T;0;6i;[; @bo;= ;3I" overload;F;40;:to_str;50;)I"to_str;T;IC;";T; @b;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @b;[;I"@return [String];T;0;6i;[; @b;[;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; @b;!F;"o;#;$T;%i¢;&iª;'@Õ‰;(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;)I"static VALUE;T;*To;;F; ;;;;I"String#to_str;F;[;[[@ Ši¬;T;;z;0;[;{;IC;"bReturns +self+. If called on a subclass of String, converts the receiver to a String object. ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @Š;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Š;[;I"@return [String];T;0;6i;[; @Šo;= ;3I" overload;F;40;;z;50;)I"to_str;T;IC;";T; @Š;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Š;[;I"@return [String];T;0;6i;[; @Š;[;@†;0; @Š;!F;"o;#;$T;%i¢;&iª;'@Õ‰;(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;)I"static VALUE;T;*To;;F; ;;;;I"String#inspect;F;[;[[@ Ši6;T;;r;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;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @±;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @±;[;I"@return [String];T;0;6i;[; @±;[;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; @±;!F;"o;#;$T;%i*;&i3;'@Õ‰;(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, "\""); return result; };T;)I" VALUE;T;*To;;F; ;;;;I"String#dump;F;[;[[@ Ši¦;T;: dump;0;[;{;IC;"ŠReturns a quoted version of the string with all non-printing characters replaced by \xHH notation and all special characters escaped. This method can be used for round-trip: if the resulting +new_str+ is eval'ed, it will produce the original string. "hello \n ''".dump #=> "\"hello \\n ''\"" "\f\x00\xff\\\"".dump #=> "\"\\f\\x00\\xFF\\\\\\\"\"" See also String#undump. ;T;[o;= ;3I" overload;F;40;;{;50;)I" dump;T;IC;";T; @Ì;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Ì;[;I"@return [String];T;0;6i;[; @Ì;[;I"®Returns a quoted version of the string with all non-printing characters replaced by \xHH notation and all special characters escaped. This method can be used for round-trip: if the resulting +new_str+ is eval'ed, it will produce the original string. "hello \n ''".dump #=> "\"hello \\n ''\"" "\f\x00\xff\\\"".dump #=> "\"\\f\\x00\\xFF\\\\\\\"\"" See also String#undump. @overload dump @return [String];T;0; @Ì;!F;"o;#;$T;%i–;&i£;'@Õ‰;(I"!VALUE rb_str_dump(VALUE str) { int encidx = rb_enc_get_index(str); rb_encoding *enc = rb_enc_from_index(encidx); long len; const char *p, *pend; char *q, *qend; VALUE result; int u8 = (encidx == rb_utf8_encindex()); static const char nonascii_suffix[] = ".dup.force_encoding(\"%s\")"; len = 2; /* "" */ if (!rb_enc_asciicompat(enc)) { len += strlen(nonascii_suffix) - rb_strlen_lit("%s"); len += strlen(enc->name); } p = RSTRING_PTR(str); pend = p + RSTRING_LEN(str); while (p < pend) { int clen; unsigned char c = *p++; switch (c) { case '"': case '\\': case '\n': case '\r': case '\t': case '\f': case '\013': case '\010': case '\007': case '\033': clen = 2; break; case '#': clen = IS_EVSTR(p, pend) ? 2 : 1; break; default: if (ISPRINT(c)) { clen = 1; } else { if (u8 && c > 0x7F) { /* \u notation */ 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); if (cc <= 0xFFFF) clen = 6; /* \uXXXX */ else if (cc <= 0xFFFFF) clen = 9; /* \u{XXXXX} */ else clen = 10; /* \u{XXXXXX} */ p += MBCLEN_CHARFOUND_LEN(n)-1; break; } } clen = 4; /* \xNN */ } break; } if (clen > LONG_MAX - len) { rb_raise(rb_eRuntimeError, "string size too big"); } len += clen; } result = rb_str_new(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; if (cc <= 0xFFFF) snprintf(q, qend-q, "u%04X", cc); /* \uXXXX */ else snprintf(q, qend-q, "u{%X}", cc); /* \u{XXXXX} or \u{XXXXXX} */ 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, nonascii_suffix, enc->name); encidx = rb_ascii8bit_encindex(); } /* result from dump is ASCII */ rb_enc_associate_index(result, encidx); ENC_CODERANGE_SET(result, ENC_CODERANGE_7BIT); return result; };T;)I" VALUE;T;*To;;F; ;;;;I"String#undump;F;[;[[@ ŠiÈ;T;:undump;0;[;{;IC;"€Returns an unescaped version of the string. This does the inverse of String#dump. "\"hello \\n ''\"".undump #=> "hello \n ''" ;T;[o;= ;3I" overload;F;40;;|;50;)I"undump;T;IC;";T; @ç;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ç;[;I"@return [String];T;0;6i;[; @ç;[;I"¦Returns an unescaped version of the string. This does the inverse of String#dump. "\"hello \\n ''\"".undump #=> "hello \n ''" @overload undump @return [String];T;0; @ç;!F;"o;#;$T;%i¾;&iÅ;'@Õ‰;(I"% static VALUE str_undump(VALUE str) { const char *s = RSTRING_PTR(str); const char *s_end = RSTRING_END(str); rb_encoding *enc = rb_enc_get(str); VALUE undumped = rb_enc_str_new(s, 0L, enc); bool utf8 = false; bool binary = false; int w; rb_must_asciicompat(str); if (rb_str_is_ascii_only_p(str) == Qfalse) { rb_raise(rb_eRuntimeError, "non-ASCII character detected"); } if (!str_null_check(str, &w)) { rb_raise(rb_eRuntimeError, "string contains null byte"); } if (RSTRING_LEN(str) < 2) goto invalid_format; if (*s != '"') goto invalid_format; /* strip '"' at the start */ s++; for (;;) { if (s >= s_end) { rb_raise(rb_eRuntimeError, "unterminated dumped string"); } if (*s == '"') { /* epilogue */ s++; if (s == s_end) { /* ascii compatible dumped string */ break; } else { static const char force_encoding_suffix[] = ".force_encoding(\""; /* "\")" */ static const char dup_suffix[] = ".dup"; const char *encname; int encidx; ptrdiff_t size; /* check separately for strings dumped by older versions */ size = sizeof(dup_suffix) - 1; if (s_end - s > size && memcmp(s, dup_suffix, size) == 0) s += size; size = sizeof(force_encoding_suffix) - 1; if (s_end - s <= size) goto invalid_format; if (memcmp(s, force_encoding_suffix, size) != 0) goto invalid_format; s += size; if (utf8) { rb_raise(rb_eRuntimeError, "dumped string contained Unicode escape but used force_encoding"); } encname = s; s = memchr(s, '"', s_end-s); size = s - encname; if (!s) goto invalid_format; if (s_end - s != 2) goto invalid_format; if (s[0] != '"' || s[1] != ')') goto invalid_format; encidx = rb_enc_find_index2(encname, (long)size); if (encidx < 0) { rb_raise(rb_eRuntimeError, "dumped string has unknown encoding name"); } rb_enc_associate_index(undumped, encidx); } break; } if (*s == '\\') { s++; if (s >= s_end) { rb_raise(rb_eRuntimeError, "invalid escape"); } undump_after_backslash(undumped, &s, s_end, &enc, &utf8, &binary); } else { rb_str_cat(undumped, s++, 1); } } return undumped; invalid_format: rb_raise(rb_eRuntimeError, "invalid dumped string; not wrapped with '\"' nor '\"...\".force_encoding(\"...\")' form"); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#upcase;F;[[@c0;[[@ Ši2;T;:upcase;0;[;{;IC;"ÔReturns a copy of str with all lowercase letters replaced with their uppercase counterparts. See String#downcase for meaning of +options+ and use with different encodings. "hEllO".upcase #=> "HELLO" ;T;[o;= ;3I" overload;F;40;;};50;)I"upcase;T;IC;";T; @‘;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @‘;[;I"@return [String];T;0;6i;[; @‘o;= ;3I" overload;F;40;;};50;)I"upcase([options]);T;IC;";T; @‘;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @‘;[;I"@return [String];T;0;6i;[[I"[options];T0; @‘;[;I")Returns a copy of str with all lowercase letters replaced with their uppercase counterparts. See String#downcase for meaning of +options+ and use with different encodings. "hEllO".upcase #=> "HELLO" @overload upcase @return [String] @overload upcase([options]) @return [String];T;0; @‘;!F;"o;#;$T;%i%;&i0;'@Õ‰;(I"ƒstatic VALUE rb_str_upcase(int argc, VALUE *argv, VALUE str) { rb_encoding *enc; OnigCaseFoldType flags = ONIGENC_CASE_UPCASE; VALUE ret; flags = check_case_options(argc, argv, flags); enc = str_true_enc(str); if (case_option_single_p(flags, enc, str)) { ret = rb_str_new(RSTRING_PTR(str), RSTRING_LEN(str)); str_enc_copy(ret, str); upcase_single(ret); } else if (flags&ONIGENC_CASE_ASCII_ONLY) { ret = rb_str_new(0, RSTRING_LEN(str)); rb_str_ascii_casemap(str, ret, &flags, enc); } else { ret = rb_str_casemap(str, &flags, enc); } return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#downcase;F;[[@c0;[[@ Ši²;T;: downcase;0;[;{;IC;"ßReturns a copy of str with all uppercase letters replaced with their lowercase counterparts. Which letters exactly are replaced, and by which other letters, depends on the presence or absence of options, and on the +encoding+ of the string. The meaning of the +options+ is as follows: No option :: Full Unicode case mapping, suitable for most languages (see :turkic and :lithuanian options below for exceptions). Context-dependent case mapping as described in Table 3-14 of the Unicode standard is currently not supported. :ascii :: Only the ASCII region, i.e. the characters ``A'' to ``Z'' and ``a'' to ``z'', are affected. This option cannot be combined with any other option. :turkic :: Full Unicode case mapping, adapted for Turkic languages (Turkish, Azerbaijani, ...). This means that upper case I is mapped to lower case dotless i, and so on. :lithuanian :: Currently, just full Unicode case mapping. In the future, full Unicode case mapping adapted for Lithuanian (keeping the dot on the lower case i even if there is an accent on top). :fold :: Only available on +downcase+ and +downcase!+. Unicode case folding, which is more far-reaching than Unicode case mapping. This option currently cannot be combined with any other option (i.e. there is currently no variant for turkic languages). Please note that several assumptions that are valid for ASCII-only case conversions do not hold for more general case conversions. For example, the length of the result may not be the same as the length of the input (neither in characters nor in bytes), some roundtrip assumptions (e.g. str.downcase == str.upcase.downcase) may not apply, and Unicode normalization (i.e. String#unicode_normalize) is not necessarily maintained by case mapping operations. Non-ASCII case mapping/folding is currently supported for UTF-8, UTF-16BE/LE, UTF-32BE/LE, and ISO-8859-1~16 Strings/Symbols. This support will be extended to other encodings. "hEllO".downcase #=> "hello" ;T;[o;= ;3I" overload;F;40;;~;50;)I" downcase;T;IC;";T; @-‘;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @-‘;[;I"@return [String];T;0;6i;[; @-‘o;= ;3I" overload;F;40;;~;50;)I"downcase([options]);T;IC;";T; @-‘;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @-‘;[;I"@return [String];T;0;6i;[[I"[options];T0; @-‘;[;I"8Returns a copy of str with all uppercase letters replaced with their lowercase counterparts. Which letters exactly are replaced, and by which other letters, depends on the presence or absence of options, and on the +encoding+ of the string. The meaning of the +options+ is as follows: No option :: Full Unicode case mapping, suitable for most languages (see :turkic and :lithuanian options below for exceptions). Context-dependent case mapping as described in Table 3-14 of the Unicode standard is currently not supported. :ascii :: Only the ASCII region, i.e. the characters ``A'' to ``Z'' and ``a'' to ``z'', are affected. This option cannot be combined with any other option. :turkic :: Full Unicode case mapping, adapted for Turkic languages (Turkish, Azerbaijani, ...). This means that upper case I is mapped to lower case dotless i, and so on. :lithuanian :: Currently, just full Unicode case mapping. In the future, full Unicode case mapping adapted for Lithuanian (keeping the dot on the lower case i even if there is an accent on top). :fold :: Only available on +downcase+ and +downcase!+. Unicode case folding, which is more far-reaching than Unicode case mapping. This option currently cannot be combined with any other option (i.e. there is currently no variant for turkic languages). Please note that several assumptions that are valid for ASCII-only case conversions do not hold for more general case conversions. For example, the length of the result may not be the same as the length of the input (neither in characters nor in bytes), some roundtrip assumptions (e.g. str.downcase == str.upcase.downcase) may not apply, and Unicode normalization (i.e. String#unicode_normalize) is not necessarily maintained by case mapping operations. Non-ASCII case mapping/folding is currently supported for UTF-8, UTF-16BE/LE, UTF-32BE/LE, and ISO-8859-1~16 Strings/Symbols. This support will be extended to other encodings. "hEllO".downcase #=> "hello" @overload downcase @return [String] @overload downcase([options]) @return [String];T;0; @-‘;!F;"o;#;$T;%i€;&i°;'@Õ‰;(I"‰static VALUE rb_str_downcase(int argc, VALUE *argv, VALUE str) { rb_encoding *enc; OnigCaseFoldType flags = ONIGENC_CASE_DOWNCASE; VALUE ret; flags = check_case_options(argc, argv, flags); enc = str_true_enc(str); if (case_option_single_p(flags, enc, str)) { ret = rb_str_new(RSTRING_PTR(str), RSTRING_LEN(str)); str_enc_copy(ret, str); downcase_single(ret); } else if (flags&ONIGENC_CASE_ASCII_ONLY) { ret = rb_str_new(0, RSTRING_LEN(str)); rb_str_ascii_casemap(str, ret, &flags, enc); } else { ret = rb_str_casemap(str, &flags, enc); } return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#capitalize;F;[[@c0;[[@ Ši;T;:capitalize;0;[;{;IC;"-Returns a copy of str with the first character converted to uppercase and the remainder to lowercase. See String#downcase for meaning of +options+ and use with different encodings. "hello".capitalize #=> "Hello" "HELLO".capitalize #=> "Hello" "123ABC".capitalize #=> "123abc" ;T;[o;= ;3I" overload;F;40;;;50;)I"capitalize;T;IC;";T; @X‘;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @X‘;[;I"@return [String];T;0;6i;[; @X‘o;= ;3I" overload;F;40;;;50;)I"capitalize([options]);T;IC;";T; @X‘;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @X‘;[;I"@return [String];T;0;6i;[[I"[options];T0; @X‘;[;I"ŠReturns a copy of str with the first character converted to uppercase and the remainder to lowercase. See String#downcase for meaning of +options+ and use with different encodings. "hello".capitalize #=> "Hello" "HELLO".capitalize #=> "Hello" "123ABC".capitalize #=> "123abc" @overload capitalize @return [String] @overload capitalize([options]) @return [String];T;0; @X‘;!F;"o;#;$T;%iò;&iÿ;'@Õ‰;(I")static VALUE rb_str_capitalize(int argc, VALUE *argv, VALUE str) { rb_encoding *enc; OnigCaseFoldType flags = ONIGENC_CASE_UPCASE | ONIGENC_CASE_TITLECASE; VALUE ret; flags = check_case_options(argc, argv, flags); enc = str_true_enc(str); if (RSTRING_LEN(str) == 0 || !RSTRING_PTR(str)) return str; if (flags&ONIGENC_CASE_ASCII_ONLY) { ret = rb_str_new(0, RSTRING_LEN(str)); rb_str_ascii_casemap(str, ret, &flags, enc); } else { ret = rb_str_casemap(str, &flags, enc); } return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#swapcase;F;[[@c0;[[@ ŠiC;T;: swapcase;0;[;{;IC;"3Returns a copy of str with uppercase alphabetic characters converted to lowercase and lowercase characters converted to uppercase. See String#downcase for meaning of +options+ and use with different encodings. "Hello".swapcase #=> "hELLO" "cYbEr_PuNk11".swapcase #=> "CyBeR_pUnK11" ;T;[o;= ;3I" overload;F;40;;€;50;)I" swapcase;T;IC;";T; @ƒ‘;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ƒ‘;[;I"@return [String];T;0;6i;[; @ƒ‘o;= ;3I" overload;F;40;;€;50;)I"swapcase([options]);T;IC;";T; @ƒ‘;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ƒ‘;[;I"@return [String];T;0;6i;[[I"[options];T0; @ƒ‘;[;I"ŒReturns a copy of str with uppercase alphabetic characters converted to lowercase and lowercase characters converted to uppercase. See String#downcase for meaning of +options+ and use with different encodings. "Hello".swapcase #=> "hELLO" "cYbEr_PuNk11".swapcase #=> "CyBeR_pUnK11" @overload swapcase @return [String] @overload swapcase([options]) @return [String];T;0; @ƒ‘;!F;"o;#;$T;%i5;&iA;'@Õ‰;(I"Astatic VALUE rb_str_swapcase(int argc, VALUE *argv, VALUE str) { rb_encoding *enc; OnigCaseFoldType flags = ONIGENC_CASE_UPCASE | ONIGENC_CASE_DOWNCASE; VALUE ret; flags = check_case_options(argc, argv, flags); enc = str_true_enc(str); if (RSTRING_LEN(str) == 0 || !RSTRING_PTR(str)) return str_duplicate(rb_cString, str); if (flags&ONIGENC_CASE_ASCII_ONLY) { ret = rb_str_new(0, RSTRING_LEN(str)); rb_str_ascii_casemap(str, ret, &flags, enc); } else { ret = rb_str_casemap(str, &flags, enc); } return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#upcase!;F;[[@c0;[[@ Ši;T;:upcase!;0;[;{;IC;"§Upcases the contents of str, returning nil if no changes were made. See String#downcase for meaning of +options+ and use with different encodings. ;T;[o;= ;3I" overload;F;40;;;50;)I"upcase!;T;IC;";T; @®‘;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @®‘;[;I"@return [String, nil];T;0;6i;[; @®‘o;= ;3I" overload;F;40;;;50;)I"upcase!([options]);T;IC;";T; @®‘;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @®‘;[;I"@return [String, nil];T;0;6i;[[I"[options];T0; @®‘;[;I"Upcases the contents of str, returning nil if no changes were made. See String#downcase for meaning of +options+ and use with different encodings. @overload upcase! @return [String, nil] @overload upcase!([options]) @return [String, nil];T;0; @®‘;!F;"o;#;$T;%i;&i;'@Õ‰;(I"gstatic VALUE rb_str_upcase_bang(int argc, VALUE *argv, VALUE str) { rb_encoding *enc; OnigCaseFoldType flags = ONIGENC_CASE_UPCASE; flags = check_case_options(argc, argv, flags); str_modify_keep_cr(str); enc = str_true_enc(str); if (case_option_single_p(flags, enc, str)) { if (upcase_single(str)) flags |= ONIGENC_CASE_MODIFIED; } else if (flags&ONIGENC_CASE_ASCII_ONLY) rb_str_ascii_casemap(str, str, &flags, enc); else str_shared_replace(str, rb_str_casemap(str, &flags, enc)); if (ONIGENC_CASE_MODIFIED&flags) return str; return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#downcase!;F;[[@c0;[[@ Šii;T;:downcase!;0;[;{;IC;"©Downcases the contents of str, returning nil if no changes were made. See String#downcase for meaning of +options+ and use with different encodings. ;T;[o;= ;3I" overload;F;40;;‚;50;)I"downcase!;T;IC;";T; @Û‘;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @Û‘;[;I"@return [String, nil];T;0;6i;[; @Û‘o;= ;3I" overload;F;40;;‚;50;)I"downcase!([options]);T;IC;";T; @Û‘;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @Û‘;[;I"@return [String, nil];T;0;6i;[[I"[options];T0; @Û‘;[;I"Downcases the contents of str, returning nil if no changes were made. See String#downcase for meaning of +options+ and use with different encodings. @overload downcase! @return [String, nil] @overload downcase!([options]) @return [String, nil];T;0; @Û‘;!F;"o;#;$T;%i^;&ig;'@Õ‰;(I"mstatic VALUE rb_str_downcase_bang(int argc, VALUE *argv, VALUE str) { rb_encoding *enc; OnigCaseFoldType flags = ONIGENC_CASE_DOWNCASE; flags = check_case_options(argc, argv, flags); str_modify_keep_cr(str); enc = str_true_enc(str); if (case_option_single_p(flags, enc, str)) { if (downcase_single(str)) flags |= ONIGENC_CASE_MODIFIED; } else if (flags&ONIGENC_CASE_ASCII_ONLY) rb_str_ascii_casemap(str, str, &flags, enc); else str_shared_replace(str, rb_str_casemap(str, &flags, enc)); if (ONIGENC_CASE_MODIFIED&flags) return str; return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#capitalize!;F;[[@c0;[[@ ŠiÞ;T;:capitalize!;0;[;{;IC;"ÖModifies str by converting the first character to uppercase and the remainder to lowercase. Returns nil if no changes are made. There is an exception for modern Georgian (mkhedruli/MTAVRULI), where the result is the same as for String#downcase, to avoid mixed case. See String#downcase for meaning of +options+ and use with different encodings. a = "hello" a.capitalize! #=> "Hello" a #=> "Hello" a.capitalize! #=> nil ;T;[o;= ;3I" overload;F;40;;ƒ;50;)I"capitalize!;T;IC;";T; @’;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @’;[;I"@return [String, nil];T;0;6i;[; @’o;= ;3I" overload;F;40;;ƒ;50;)I"capitalize!([options]);T;IC;";T; @’;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @’;[;I"@return [String, nil];T;0;6i;[[I"[options];T0; @’;[;I"?Modifies str by converting the first character to uppercase and the remainder to lowercase. Returns nil if no changes are made. There is an exception for modern Georgian (mkhedruli/MTAVRULI), where the result is the same as for String#downcase, to avoid mixed case. See String#downcase for meaning of +options+ and use with different encodings. a = "hello" a.capitalize! #=> "Hello" a #=> "Hello" a.capitalize! #=> nil @overload capitalize! @return [String, nil] @overload capitalize!([options]) @return [String, nil];T;0; @’;!F;"o;#;$T;%iÌ;&iÜ;'@Õ‰;(I"=static VALUE rb_str_capitalize_bang(int argc, VALUE *argv, VALUE str) { rb_encoding *enc; OnigCaseFoldType flags = ONIGENC_CASE_UPCASE | ONIGENC_CASE_TITLECASE; flags = check_case_options(argc, argv, flags); str_modify_keep_cr(str); enc = str_true_enc(str); if (RSTRING_LEN(str) == 0 || !RSTRING_PTR(str)) return Qnil; if (flags&ONIGENC_CASE_ASCII_ONLY) rb_str_ascii_casemap(str, str, &flags, enc); else str_shared_replace(str, rb_str_casemap(str, &flags, enc)); if (ONIGENC_CASE_MODIFIED&flags) return str; return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#swapcase!;F;[[@c0;[[@ Ši";T;:swapcase!;0;[;{;IC;"ÕEquivalent to String#swapcase, but modifies the receiver in place, returning str, or nil if no changes were made. See String#downcase for meaning of +options+ and use with different encodings. ;T;[o;= ;3I" overload;F;40;;„;50;)I"swapcase!;T;IC;";T; @5’;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @5’;[;I"@return [String, nil];T;0;6i;[; @5’o;= ;3I" overload;F;40;;„;50;)I"swapcase!([options]);T;IC;";T; @5’;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @5’;[;I"@return [String, nil];T;0;6i;[[I"[options];T0; @5’;[;I":Equivalent to String#swapcase, but modifies the receiver in place, returning str, or nil if no changes were made. See String#downcase for meaning of +options+ and use with different encodings. @overload swapcase! @return [String, nil] @overload swapcase!([options]) @return [String, nil];T;0; @5’;!F;"o;#;$T;%i;&i ;'@Õ‰;(I"ùstatic VALUE rb_str_swapcase_bang(int argc, VALUE *argv, VALUE str) { rb_encoding *enc; OnigCaseFoldType flags = ONIGENC_CASE_UPCASE | ONIGENC_CASE_DOWNCASE; flags = check_case_options(argc, argv, flags); str_modify_keep_cr(str); enc = str_true_enc(str); if (flags&ONIGENC_CASE_ASCII_ONLY) rb_str_ascii_casemap(str, str, &flags, enc); else str_shared_replace(str, rb_str_casemap(str, &flags, enc)); if (ONIGENC_CASE_MODIFIED&flags) return str; return Qnil; };T;)I"static VALUE;T;*To;;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;= ;3I" overload;F;40;;…;50;)I"hex;T;IC;";T; @b’;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @b’;[;I"@return [Integer];T;0;6i;[; @b’;[;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; @b’;!F;"o;#;$T;%iÆ%;&iÑ%;'@Õ‰;(I"Vstatic VALUE rb_str_hex(VALUE str) { return rb_str_to_inum(str, 16, FALSE); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#oct;F;[;[[@ Šiì%;T;:oct;0;[;{;IC;"hTreats 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 honored. See Kernel#Integer. ;T;[o;= ;3I" overload;F;40;;†;50;)I"oct;T;IC;";T; @}’;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @}’;[;I"@return [Integer];T;0;6i;[; @}’;[;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 honored. See Kernel#Integer. @overload oct @return [Integer];T;0; @}’;!F;"o;#;$T;%iÛ%;&ié%;'@Õ‰;(I"Vstatic VALUE rb_str_oct(VALUE str) { return rb_str_to_inum(str, -8, FALSE); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#split;F;[[@c0;[[@ Š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 and trailing 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 split substrings will be returned (captured groups will be returned as well, but are not counted towards the limit). 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", "", ""] "1:2:3".split(/(:)()()/, 2) #=> ["1", ":", "", "", "2:3"] "".split(',', -1) #=> [] If a block is given, invoke the block with each split substring. ;T;[o;= ;3I" overload;F;40;;‡;50;)I" split(pattern=nil, [limit]);T;IC;";T; @˜’;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @˜’;[;I"@return [Array];T;0;6i;[[I"pattern;TI"nil;T[I"[limit];T0; @˜’o;= ;3I" overload;F;40;;‡;50;)I" split(pattern=nil, [limit]);T;IC;";T; @˜’;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"sub;T; @˜’o;2 ;3I"return;F;4I";T;0;5[I"String;T; @˜’;[;I""@yield [sub] @return [String];T;0;6i;[[I"pattern;TI"nil;T[I"[limit];T0; @˜’;[;I" 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 and trailing 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 split substrings will be returned (captured groups will be returned as well, but are not counted towards the limit). 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", "", ""] "1:2:3".split(/(:)()()/, 2) #=> ["1", ":", "", "", "2:3"] "".split(',', -1) #=> [] If a block is given, invoke the block with each split substring. @overload split(pattern=nil, [limit]) @return [Array] @overload split(pattern=nil, [limit]) @yield [sub] @return [String];T;0; @˜’;!F;"o;#;$T;%iÉ;&iÿ;'@Õ‰;(I"]static VALUE rb_str_split_m(int argc, VALUE *argv, VALUE str) { rb_encoding *enc; VALUE spat; VALUE limit; split_type_t split_type; long beg, end, i = 0, empty_count = -1; int lim = 0; VALUE result, tmp; result = rb_block_given_p() ? Qfalse : Qnil; 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 result ? rb_ary_new2(0) : str; tmp = str_duplicate(rb_cString, str); if (!result) { rb_yield(tmp); return str; } return rb_ary_new3(1, tmp); } i = 1; } if (NIL_P(limit) && !lim) empty_count = 0; enc = STR_ENC_GET(str); split_type = SPLIT_TYPE_REGEXP; if (!NIL_P(spat)) { spat = get_pat_quoted(spat, 0); } else if (NIL_P(spat = rb_fs)) { split_type = SPLIT_TYPE_AWK; } else if (!(spat = rb_fs_check(spat))) { rb_raise(rb_eTypeError, "value of $; must be String or Regexp"); } else { rb_category_warn(RB_WARN_CATEGORY_DEPRECATED, "$; is set to non-nil value"); } if (split_type != SPLIT_TYPE_AWK) { switch (BUILTIN_TYPE(spat)) { case T_REGEXP: rb_reg_options(spat); /* check if uninitialized */ tmp = RREGEXP_SRC(spat); split_type = literal_split_pattern(tmp, SPLIT_TYPE_REGEXP); if (split_type == SPLIT_TYPE_AWK) { spat = tmp; split_type = SPLIT_TYPE_STRING; } break; case T_STRING: mustnot_broken(spat); split_type = literal_split_pattern(spat, SPLIT_TYPE_STRING); break; default: UNREACHABLE_RETURN(Qnil); } } #define SPLIT_STR(beg, len) (empty_count = split_string(result, str, beg, len, empty_count)) if (result) result = rb_ary_new(); beg = 0; char *ptr = RSTRING_PTR(str); char *eptr = RSTRING_END(str); if (split_type == SPLIT_TYPE_AWK) { 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)) { SPLIT_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)) { SPLIT_STR(beg, end-beg); skip = 1; beg = ptr - bptr; if (!NIL_P(limit)) ++i; } else { end = ptr - bptr; } } } } else if (split_type == SPLIT_TYPE_STRING) { char *str_start = ptr; char *substr_start = ptr; 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; } SPLIT_STR(substr_start - str_start, (ptr+end) - substr_start); ptr += end + slen; substr_start = ptr; if (!NIL_P(limit) && lim <= ++i) break; } beg = ptr - str_start; } else if (split_type == SPLIT_TYPE_CHARS) { char *str_start = ptr; int n; mustnot_broken(str); enc = rb_enc_get(str); while (ptr < eptr && (n = rb_enc_precise_mbclen(ptr, eptr, enc)) > 0) { SPLIT_STR(ptr - str_start, n); ptr += n; if (!NIL_P(limit) && lim <= ++i) break; } beg = ptr - str_start; } else { long len = RSTRING_LEN(str); long start = beg; long idx; int last_null = 0; struct re_registers *regs; VALUE match = 0; for (; rb_reg_search(spat, str, start, 0) >= 0; (match ? (rb_match_unbusy(match), rb_backref_set(match)) : (void)0)) { match = rb_backref_get(); if (!result) rb_match_busy(match); regs = RMATCH_REGS(match); end = BEG(0); if (start == end && BEG(0) == END(0)) { if (!ptr) { SPLIT_STR(0, 0); break; } else if (last_null == 1) { SPLIT_STR(beg, rb_enc_fast_mbclen(ptr+beg, eptr, enc)); beg = start; } else { if (start == len) start++; else start += rb_enc_fast_mbclen(ptr+start,eptr,enc); last_null = 1; continue; } } else { SPLIT_STR(beg, end-beg); beg = start = END(0); } last_null = 0; for (idx=1; idx < regs->num_regs; idx++) { if (BEG(idx) == -1) continue; SPLIT_STR(BEG(idx), END(idx)-BEG(idx)); } if (!NIL_P(limit) && lim <= ++i) break; } if (match) rb_match_unbusy(match); } if (RSTRING_LEN(str) > 0 && (!NIL_P(limit) || RSTRING_LEN(str) > beg || lim < 0)) { SPLIT_STR(beg, RSTRING_LEN(str)-beg); } return result ? result : str; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#lines;F;[[@c0;[[@ Šiâ!;T;: lines;0;[;{;IC;"1Returns an array of lines in str split using the supplied record separator ($/ by default). This is a shorthand for str.each_line(separator, getline_args).to_a. If +chomp+ is +true+, +separator+ will be removed from the end of each line. "hello\nworld\n".lines #=> ["hello\n", "world\n"] "hello world".lines(' ') #=> ["hello ", " ", "world"] "hello\nworld\n".lines(chomp: true) #=> ["hello", "world"] If a block is given, which is a deprecated form, works the same as each_line. ;T;[o;= ;3I" overload;F;40;;ˆ;50;)I"&lines(separator=$/, chomp: false);T;IC;";T; @Ð’;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @Ð’;[;I"@return [Array];T;0;6i;[[I"separator;TI"$/;T[I"chomp:;TI" false;T; @Ð’;[;I"qReturns an array of lines in str split using the supplied record separator ($/ by default). This is a shorthand for str.each_line(separator, getline_args).to_a. If +chomp+ is +true+, +separator+ will be removed from the end of each line. "hello\nworld\n".lines #=> ["hello\n", "world\n"] "hello world".lines(' ') #=> ["hello ", " ", "world"] "hello\nworld\n".lines(chomp: true) #=> ["hello", "world"] If a block is given, which is a deprecated form, works the same as each_line. @overload lines(separator=$/, chomp: false) @return [Array];T;0; @Ð’;!F;"o;#;$T;%iÏ!;&iß!;'@Õ‰;(I"Ÿstatic VALUE rb_str_lines(int argc, VALUE *argv, VALUE str) { VALUE ary = WANTARRAY("lines", 0); return rb_str_enumerate_lines(argc, argv, str, ary); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#bytes;F;[;[[@ Ši";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;= ;3I" overload;F;40;;‰;50;)I" bytes;T;IC;";T; @ò’;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ò’;[;I"@return [Array];T;0;6i;[; @ò’;[;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; @ò’;!F;"o;#;$T;%i";&i";'@Õ‰;(I"‹static VALUE rb_str_bytes(VALUE str) { VALUE ary = WANTARRAY("bytes", RSTRING_LEN(str)); return rb_str_enumerate_bytes(str, ary); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#chars;F;[;[[@ Šil";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;= ;3I" overload;F;40;;Š;50;)I" chars;T;IC;";T; @ “;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ “;[;I"@return [Array];T;0;6i;[; @ “;[;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; @ “;!F;"o;#;$T;%ia";&ii";'@Õ‰;(I"static VALUE rb_str_chars(VALUE str) { VALUE ary = WANTARRAY("chars", rb_str_strlen(str)); return rb_str_enumerate_chars(str, ary); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#codepoints;F;[;[[@ Ši·";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;= ;3I" overload;F;40;;‹;50;)I"codepoints;T;IC;";T; @(“;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @(“;[;I"@return [Array];T;0;6i;[; @(“;[;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; @(“;!F;"o;#;$T;%i«";&i´";'@Õ‰;(I"œstatic VALUE rb_str_codepoints(VALUE str) { VALUE ary = WANTARRAY("codepoints", rb_str_strlen(str)); return rb_str_enumerate_codepoints(str, ary); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#grapheme_clusters;F;[;[[@ ŠiL#;T;:grapheme_clusters;0;[;{;IC;"âReturns an array of grapheme clusters in str. This is a shorthand for str.each_grapheme_cluster.to_a. If a block is given, which is a deprecated form, works the same as each_grapheme_cluster. ;T;[o;= ;3I" overload;F;40;;Œ;50;)I"grapheme_clusters;T;IC;";T; @C“;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @C“;[;I"@return [Array];T;0;6i;[; @C“;[;I"Returns an array of grapheme clusters in str. This is a shorthand for str.each_grapheme_cluster.to_a. If a block is given, which is a deprecated form, works the same as each_grapheme_cluster. @overload grapheme_clusters @return [Array];T;0; @C“;!F;"o;#;$T;%iA#;&iI#;'@Õ‰;(I"±static VALUE rb_str_grapheme_clusters(VALUE str) { VALUE ary = WANTARRAY("grapheme_clusters", rb_str_strlen(str)); return rb_str_enumerate_grapheme_clusters(str, ary); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#reverse;F;[;[[@ Šiþ;T;;;0;[;{;IC;"wReturns a new string with the characters from str in reverse order. "stressed".reverse #=> "desserts" ;T;[o;= ;3I" overload;F;40;;;50;)I"reverse;T;IC;";T; @^“;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @^“;[;I"@return [String];T;0;6i;[; @^“;[;I"™Returns a new string with the characters from str in reverse order. "stressed".reverse #=> "desserts" @overload reverse @return [String];T;0; @^“;!F;"o;#;$T;%iõ;&iû;'@Õ‰;(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 str_duplicate(rb_cString, str); enc = STR_ENC_GET(str); rev = rb_str_new(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)); str_enc_copy(rev, str); ENC_CODERANGE_SET(rev, cr); return rev; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#reverse!;F;[;[[@ Ši8;T;;;0;[;{;IC;""Reverses str in place. ;T;[o;= ;3I" overload;F;40;;;50;)I" reverse!;T;IC;";T; @y“;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @y“;[;I"@return [String];T;0;6i;[; @y“;[;I"JReverses str in place. @overload reverse! @return [String];T;0; @y“;!F;"o;#;$T;%i1;&i5;'@Õ‰;(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;)I"static VALUE;T;*To;;F; ;;;;I"String#concat;F;[[@c0;[[@ Šij;T;; ;0;[;{;IC;"¤Concatenates each object in +objects+ to +self+ and returns +self+: s = 'foo' s.concat('bar', 'baz') # => "foobarbaz" s # => "foobarbaz" For each given object +object+ that is an \Integer, the value is considered a codepoint and converted to a character before concatenation: s = 'foo' s.concat(32, 'bar', 32, 'baz') # => "foo bar baz" Related: String#<<, which takes a single argument. ;T;[o;= ;3I" overload;F;40;; ;50;)I"concat(*objects);T;IC;";T; @”“;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @”“;[;I"@return [String];T;0;6i;[[I" *objects;T0; @”“;[;I"ÔConcatenates each object in +objects+ to +self+ and returns +self+: s = 'foo' s.concat('bar', 'baz') # => "foobarbaz" s # => "foobarbaz" For each given object +object+ that is an \Integer, the value is considered a codepoint and converted to a character before concatenation: s = 'foo' s.concat(32, 'bar', 32, 'baz') # => "foo bar baz" Related: String#<<, which takes a single argument. @overload concat(*objects) @return [String];T;0; @”“;!F;"o;#;$T;%iY;&ih;'@Õ‰;(I"static VALUE rb_str_concat_multi(int argc, VALUE *argv, VALUE str) { str_modifiable(str); if (argc == 1) { return rb_str_concat(str, argv[0]); } else if (argc > 1) { int i; VALUE arg_str = rb_str_tmp_new(0); rb_enc_copy(arg_str, str); for (i = 0; i < argc; i++) { rb_str_concat(arg_str, argv[i]); } rb_str_buf_append(str, arg_str); } return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#<<;F;[[I" str2;T0;[[@ Ši;T;;Ý;0;[;{;IC;"EConcatenates +object+ to +self+ and returns +self+: s = 'foo' s << 'bar' # => "foobar" s # => "foobar" If +object+ is an \Integer, the value is considered a codepoint and converted to a character before concatenation: s = 'foo' s << 33 # => "foo!" Related: String#concat, which takes multiple arguments. ;T;[o;= ;3I" overload;F;40;;Ý;50;)I"<<(object);T;IC;";T; @²“;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @²“;[;I"@return [String];T;0;6i;[[I"object;T0; @²“;[;I"oConcatenates +object+ to +self+ and returns +self+: s = 'foo' s << 'bar' # => "foobar" s # => "foobar" If +object+ is an \Integer, the value is considered a codepoint and converted to a character before concatenation: s = 'foo' s << 33 # => "foo!" Related: String#concat, which takes multiple arguments. @overload <<(object) @return [String];T;0; @²“;!F;"o;#;$T;%i;&iŽ;'@Õ‰;(I"ÄVALUE rb_str_concat(VALUE str1, VALUE str2) { unsigned int code; rb_encoding *enc = STR_ENC_GET(str1); int encidx; if (RB_INTEGER_TYPE_P(str2)) { 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); } encidx = rb_enc_to_index(enc); if (encidx == ENCINDEX_ASCII || encidx == ENCINDEX_US_ASCII) { /* 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 (encidx == ENCINDEX_US_ASCII && code > 127) { rb_enc_associate_index(str1, ENCINDEX_ASCII); 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;)I" VALUE;T;*To;;F; ;;;;I"String#prepend;F;[[@c0;[[@ ŠiÜ;T;;d;0;[;{;IC;"ÀPrepends each string in +other_strings+ to +self+ and returns +self+: s = 'foo' s.prepend('bar', 'baz') # => "barbazfoo" s # => "barbazfoo" Related: String#concat. ;T;[o;= ;3I" overload;F;40;;d;50;)I"prepend(*other_strings);T;IC;";T; @Ñ“;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Ñ“;[;I"@return [String];T;0;6i;[[I"*other_strings;T0; @Ñ“;[;I"÷Prepends each string in +other_strings+ to +self+ and returns +self+: s = 'foo' s.prepend('bar', 'baz') # => "barbazfoo" s # => "barbazfoo" Related: String#concat. @overload prepend(*other_strings) @return [String];T;0; @Ñ“;!F;"o;#;$T;%iÐ;&iÙ;'@Õ‰;(I"‡static VALUE rb_str_prepend_multi(int argc, VALUE *argv, VALUE str) { str_modifiable(str); if (argc == 1) { rb_str_update(str, 0L, 0L, argv[0]); } else if (argc > 1) { int i; VALUE arg_str = rb_str_tmp_new(0); rb_enc_copy(arg_str, str); for (i = 0; i < argc; i++) { rb_str_append(arg_str, argv[i]); } rb_str_update(str, 0L, 0L, arg_str); } return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#crypt;F;[[I" salt;T0;[[@ Ši/&;T;: crypt;0;[;{;IC;"¦ Returns the string generated by calling crypt(3) standard library function with str and salt_str, in this order, as its arguments. Please do not use this method any longer. It is legacy; provided only for backward compatibility with ruby scripts in earlier days. It is bad to use in contemporary programs for several reasons: * Behaviour of C's crypt(3) depends on the OS it is run. The generated string lacks data portability. * On some OSes such as Mac OS, crypt(3) never fails (i.e. silently ends up in unexpected results). * On some OSes such as Mac OS, crypt(3) is not thread safe. * So-called "traditional" usage of crypt(3) is very very very weak. According to its manpage, Linux's traditional crypt(3) output has only 2**56 variations; too easy to brute force today. And this is the default behaviour. * In order to make things robust some OSes implement so-called "modular" usage. To go through, you have to do a complex build-up of the salt_str parameter, by hand. Failure in generation of a proper salt string tends not to yield any errors; typos in parameters are normally not detectable. * For instance, in the following example, the second invocation of String#crypt is wrong; it has a typo in "round=" (lacks "s"). However the call does not fail and something unexpected is generated. "foo".crypt("$5$rounds=1000$salt$") # OK, proper usage "foo".crypt("$5$round=1000$salt$") # Typo not detected * Even in the "modular" mode, some hash functions are considered archaic and no longer recommended at all; for instance module $1$ is officially abandoned by its author: see http://phk.freebsd.dk/sagas/md5crypt_eol.html . For another instance module $3$ is considered completely broken: see the manpage of FreeBSD. * On some OS such as Mac OS, there is no modular mode. Yet, as written above, crypt(3) on Mac OS never fails. This means even if you build up a proper salt string it generates a traditional DES hash anyways, and there is no way for you to be aware of. "foo".crypt("$5$rounds=1000$salt$") # => "$5fNPQMxC5j6." If for some reason you cannot migrate to other secure contemporary password hashing algorithms, install the string-crypt gem and require 'string/crypt' to continue using it. ;T;[o;= ;3I" overload;F;40;;;50;)I"crypt(salt_str);T;IC;";T; @ï“;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ï“;[;I"@return [String];T;0;6i;[[I" salt_str;T0; @ï“;[;I"Õ Returns the string generated by calling crypt(3) standard library function with str and salt_str, in this order, as its arguments. Please do not use this method any longer. It is legacy; provided only for backward compatibility with ruby scripts in earlier days. It is bad to use in contemporary programs for several reasons: * Behaviour of C's crypt(3) depends on the OS it is run. The generated string lacks data portability. * On some OSes such as Mac OS, crypt(3) never fails (i.e. silently ends up in unexpected results). * On some OSes such as Mac OS, crypt(3) is not thread safe. * So-called "traditional" usage of crypt(3) is very very very weak. According to its manpage, Linux's traditional crypt(3) output has only 2**56 variations; too easy to brute force today. And this is the default behaviour. * In order to make things robust some OSes implement so-called "modular" usage. To go through, you have to do a complex build-up of the salt_str parameter, by hand. Failure in generation of a proper salt string tends not to yield any errors; typos in parameters are normally not detectable. * For instance, in the following example, the second invocation of String#crypt is wrong; it has a typo in "round=" (lacks "s"). However the call does not fail and something unexpected is generated. "foo".crypt("$5$rounds=1000$salt$") # OK, proper usage "foo".crypt("$5$round=1000$salt$") # Typo not detected * Even in the "modular" mode, some hash functions are considered archaic and no longer recommended at all; for instance module $1$ is officially abandoned by its author: see http://phk.freebsd.dk/sagas/md5crypt_eol.html . For another instance module $3$ is considered completely broken: see the manpage of FreeBSD. * On some OS such as Mac OS, there is no modular mode. Yet, as written above, crypt(3) on Mac OS never fails. This means even if you build up a proper salt string it generates a traditional DES hash anyways, and there is no way for you to be aware of. "foo".crypt("$5$rounds=1000$salt$") # => "$5fNPQMxC5j6." If for some reason you cannot migrate to other secure contemporary password hashing algorithms, install the string-crypt gem and require 'string/crypt' to continue using it. @overload crypt(salt_str) @return [String];T;0; @ï“;!F;"o;#;$T;%ió%;&i,&;'@Õ‰;(I"Tstatic VALUE rb_str_crypt(VALUE str, VALUE salt) { #ifdef HAVE_CRYPT_R VALUE databuf; struct crypt_data *data; # define CRYPT_END() ALLOCV_END(databuf) #else extern char *crypt(const char *, const char *); # define CRYPT_END() (void)0 #endif 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) { goto short_salt; } 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 #ifdef HAVE_CRYPT_R data = ALLOCV(databuf, sizeof(struct crypt_data)); # ifdef HAVE_STRUCT_CRYPT_DATA_INITIALIZED data->initialized = 0; # endif res = crypt_r(s, saltp, data); #else res = crypt(s, saltp); #endif if (!res) { int err = errno; CRYPT_END(); rb_syserr_fail(err, "crypt"); } result = rb_str_new_cstr(res); CRYPT_END(); return result; short_salt: rb_raise(rb_eArgError, "salt too short (need >=2 bytes)"); UNREACHABLE_RETURN(Qundef); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#intern;F;[;[[I" symbol.c;TiG;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;= ;3I" overload;F;40;;Ž;50;)I"intern;T;IC;";T; @”;>0;!F;[;[;I";T;0;6i;[; @”o;= ;3I" overload;F;40;:to_sym;50;)I"to_sym;T;IC;";T; @”;>0;!F;[;[;I";T;0;6i;[; @”;[;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; @”;!F;"o;#;$T;%i3;&iC;'@Õ‰;(I"1VALUE rb_str_intern(VALUE str) { VALUE sym; #if USE_SYMBOL_GC rb_encoding *enc, *ascii; int type; #else ID id; #endif GLOBAL_SYMBOLS_ENTER(symbols); { sym = lookup_str_sym_with_lock(symbols, str); if (sym) { // ok } else { #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_dup(str); OBJ_FREEZE(str); } str = rb_fstring(str); type = rb_str_symname_type(str, IDSET_ATTRSET_FOR_INTERN); if (type < 0) type = ID_JUNK; sym = dsymbol_alloc(symbols, rb_cSymbol, str, enc, type); #else id = intern_str(str, 0); sym = ID2SYM(id); #endif } } GLOBAL_SYMBOLS_LEAVE(); return sym; };T;)I" VALUE;T;*To;;F; ;;;;I"String#to_sym;F;[;[[@”iG;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;= ;3I" overload;F;40;;Ž;50;)I"intern;T;IC;";T; @-”;>0;!F;[;[;I";T;0;6i;[; @-”o;= ;3I" overload;F;40;;;50;)I"to_sym;T;IC;";T; @-”;>0;!F;[;[;I";T;0;6i;[; @-”;[;@)”;0; @-”;!F;"o;#;$T;%i3;&iC;'@Õ‰;(I"1VALUE rb_str_intern(VALUE str) { VALUE sym; #if USE_SYMBOL_GC rb_encoding *enc, *ascii; int type; #else ID id; #endif GLOBAL_SYMBOLS_ENTER(symbols); { sym = lookup_str_sym_with_lock(symbols, str); if (sym) { // ok } else { #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_dup(str); OBJ_FREEZE(str); } str = rb_fstring(str); type = rb_str_symname_type(str, IDSET_ATTRSET_FOR_INTERN); if (type < 0) type = ID_JUNK; sym = dsymbol_alloc(symbols, rb_cSymbol, str, enc, type); #else id = intern_str(str, 0); sym = ID2SYM(id); #endif } } GLOBAL_SYMBOLS_LEAVE(); return sym; };T;)I" VALUE;T;*To;;F; ;;;;I"String#ord;F;[;[[@ Šit&;T;:ord;0;[;{;IC;"VReturns the Integer ordinal of a one-character string. "a".ord #=> 97 ;T;[o;= ;3I" overload;F;40;;;50;)I"ord;T;IC;";T; @J”;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @J”;[;I"@return [Integer];T;0;6i;[; @J”;[;I"zReturns the Integer ordinal of a one-character string. "a".ord #=> 97 @overload ord @return [Integer];T;0; @J”;!F;"o;#;$T;%ik&;&iq&;'@Õ‰;(I"›static 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;)I"static VALUE;T;*To;;F; ;;;;I"String#include?;F;[[I"arg;T0;[[@ Ši_;T;;E;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;= ;3I" overload;F;40;;E;50;)I"include? other_str;T;IC;";T; @e”;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @e”;[;I"@return [Boolean];T;0;6i;[[I"other_str;T0; @e”;[;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; @e”;!F;"o;#;$T;%iS;&i\;6i;'@Õ‰;(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;)I"static VALUE;T;*To;;F; ;;;;I"String#start_with?;F;[[@c0;[[@ ŠiÍ';T;:start_with?;0;[;{;IC;"}Returns true if +str+ starts with one of the +prefixes+ given. Each of the +prefixes+ should be a String or a Regexp. "hello".start_with?("hell") #=> true "hello".start_with?(/H/i) #=> true # returns true if one of the prefixes matches. "hello".start_with?("heaven", "hell") #=> true "hello".start_with?("heaven", "paradise") #=> false;T;[o;= ;3I" overload;F;40;;‘;50;)I"start_with?([prefixes]+);T;IC;";T; @„”;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @„”;[;I"@return [Boolean];T;0;6i;[[I"[prefixes];T0; @„”;[;I"¶Returns true if +str+ starts with one of the +prefixes+ given. Each of the +prefixes+ should be a String or a Regexp. "hello".start_with?("hell") #=> true "hello".start_with?(/H/i) #=> 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; @„”;!F;"o;#;$T;%i¾';&iÊ';6i;'@Õ‰;(I"Ëstatic 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;= ;3I" overload;F;40;;’;50;)I"end_with?([suffixes]+);T;IC;";T; @¢”;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @¢”;[;I"@return [Boolean];T;0;6i;[[I"[suffixes];T0; @¢”;[;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; @¢”;!F;"o;#;$T;%iã';&ií';6i;'@Õ‰;(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;= ;3I" overload;F;40;;“;50;)I"scan(pattern);T;IC;";T; @À”;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @À”;[;I"@return [Array];T;0;6i;[[I"pattern;T0; @À”o;= ;3I" overload;F;40;;“;50;)I"scan(pattern);T;IC;";T; @À”;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" match;TI"...;T; @À”o;2 ;3I"return;F;4I";T;0;5[I"String;T; @À”;[;I")@yield [match, ...] @return [String];T;0;6i;[[I"pattern;T0; @À”;[;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; @À”;!F;"o;#;$T;%i…%;&i£%;'@Õ‰;(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, 0))) { last = prev; prev = start; rb_ary_push(ary, result); } if (last >= 0) rb_pat_search(pat, str, last, 1); else rb_backref_set(Qnil); return ary; } while (!NIL_P(result = scan_once(str, pat, &start, 1))) { 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;)I"static VALUE;T;*To;;F; ;;;;I"String#ljust;F;[[@c0;[[@ Ši&';T;: ljust;0;[;{;IC;"fIf 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;= ;3I" overload;F;40;;”;50;)I"ljust(integer, padstr=' ');T;IC;";T; @ô”;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ô”;[;I"@return [String];T;0;6i;[[I"integer;T0[I"padstr;TI"' ';T; @ô”;[;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; @ô”;!F;"o;#;$T;%i';&i#';'@Õ‰;(I"ustatic VALUE rb_str_ljust(int argc, VALUE *argv, VALUE str) { return rb_str_justify(argc, argv, str, 'l'); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#rjust;F;[[@c0;[[@ Ši:';T;: rjust;0;[;{;IC;"gIf 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;= ;3I" overload;F;40;;•;50;)I"rjust(integer, padstr=' ');T;IC;";T; @•;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @•;[;I"@return [String];T;0;6i;[[I"integer;T0[I"padstr;TI"' ';T; @•;[;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; @•;!F;"o;#;$T;%i-';&i7';'@Õ‰;(I"ustatic VALUE rb_str_rjust(int argc, VALUE *argv, VALUE str) { return rb_str_justify(argc, argv, str, 'r'); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#center;F;[[@c0;[[@ ŠiN';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;= ;3I" overload;F;40;;–;50;)I"center(width, padstr=' ');T;IC;";T; @6•;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @6•;[;I"@return [String];T;0;6i;[[I" width;T0[I"padstr;TI"' ';T; @6•;[;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; @6•;!F;"o;#;$T;%iA';&iK';'@Õ‰;(I"vstatic VALUE rb_str_center(int argc, VALUE *argv, VALUE str) { return rb_str_justify(argc, argv, str, 'c'); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#sub;F;[[@c0;[[@ Ši;T;:sub;0;[;{;IC;"2 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 backslash 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. Similarly, \&, \', \`, and \+ correspond to special variables, $&, $', $`, and $+, respectively. (See rdoc-ref:regexp.rdoc for details.) \0 is the same as \&. \\\\ is interpreted as an escape, i.e., a single backslash. Note that, 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. (See rdoc-ref:regexp.rdoc for details.) The value returned by the block will be substituted for the match on each call. "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?" Note that a string literal consumes backslashes. (See rdoc-ref:syntax/literals.rdoc for details about string literals.) Back-references are typically preceded by an additional backslash. For example, if you want to write a back-reference \& in +replacement+ with a double-quoted string literal, you need to write: "..\\\\&..". If you want to write a non-back-reference string \& in +replacement+, you need first to escape the backslash to prevent this method from interpreting it as a back-reference, and then you need to escape the backslashes again to prevent a string literal from consuming them: "..\\\\\\\\&..". You may want to use the block form to avoid a lot of backslashes. ;T;[o;= ;3I" overload;F;40;;—;50;)I"sub(pattern, replacement);T;IC;";T; @W•;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @W•;[;I"@return [String];T;0;6i;[[I"pattern;T0[I"replacement;T0; @W•o;= ;3I" overload;F;40;;—;50;)I"sub(pattern, hash);T;IC;";T; @W•;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @W•;[;I"@return [String];T;0;6i;[[I"pattern;T0[I" hash;T0; @W•o;= ;3I" overload;F;40;;—;50;)I"sub(pattern);T;IC;";T; @W•;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" match;T; @W•o;2 ;3I"return;F;4I";T;0;5[I"String;T; @W•;[;I"$@yield [match] @return [String];T;0;6i;[[I"pattern;T0; @W•;[;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 backslash 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. Similarly, \&, \', \`, and \+ correspond to special variables, $&, $', $`, and $+, respectively. (See rdoc-ref:regexp.rdoc for details.) \0 is the same as \&. \\\\ is interpreted as an escape, i.e., a single backslash. Note that, 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. (See rdoc-ref:regexp.rdoc for details.) The value returned by the block will be substituted for the match on each call. "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?" Note that a string literal consumes backslashes. (See rdoc-ref:syntax/literals.rdoc for details about string literals.) Back-references are typically preceded by an additional backslash. For example, if you want to write a back-reference \& in +replacement+ with a double-quoted string literal, you need to write: "..\\\\&..". If you want to write a non-back-reference string \& in +replacement+, you need first to escape the backslash to prevent this method from interpreting it as a back-reference, and then you need to escape the backslashes again to prevent a string literal from consuming them: "..\\\\\\\\&..". You may want to use the block form to avoid a lot of backslashes. @overload sub(pattern, replacement) @return [String] @overload sub(pattern, hash) @return [String] @overload sub(pattern) @yield [match] @return [String];T;0; @W•;!F;"o;#;$T;%iá;&i;'@Õ‰;(I"static VALUE rb_str_sub(int argc, VALUE *argv, VALUE str) { str = str_duplicate(rb_cString, str); rb_str_sub_bang(argc, argv, str); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#gsub;F;[[@c0;[[@ Šií;T;: gsub;0;[;{;IC;"| Returns a copy of str with 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 backslash 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. Similarly, \&, \', \`, and \+ correspond to special variables, $&, $', $`, and $+, respectively. (See rdoc-ref:regexp.rdoc for details.) \0 is the same as \&. \\\\ is interpreted as an escape, i.e., a single backslash. Note that, 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. (See rdoc-ref:regexp.rdoc for details.) The value returned by the block will be substituted for the match on each call. 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*" Note that a string literal consumes backslashes. (See rdoc-ref:syntax/literals.rdoc for details on string literals.) Back-references are typically preceded by an additional backslash. For example, if you want to write a back-reference \& in +replacement+ with a double-quoted string literal, you need to write: "..\\\\&..". If you want to write a non-back-reference string \& in +replacement+, you need first to escape the backslash to prevent this method from interpreting it as a back-reference, and then you need to escape the backslashes again to prevent a string literal from consuming them: "..\\\\\\\\&..". You may want to use the block form to avoid a lot of backslashes. ;T;[ o;= ;3I" overload;F;40;;˜;50;)I"gsub(pattern, replacement);T;IC;";T; @œ•;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @œ•;[;I"@return [String];T;0;6i;[[I"pattern;T0[I"replacement;T0; @œ•o;= ;3I" overload;F;40;;˜;50;)I"gsub(pattern, hash);T;IC;";T; @œ•;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @œ•;[;I"@return [String];T;0;6i;[[I"pattern;T0[I" hash;T0; @œ•o;= ;3I" overload;F;40;;˜;50;)I"gsub(pattern);T;IC;";T; @œ•;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" match;T; @œ•o;2 ;3I"return;F;4I";T;0;5[I"String;T; @œ•;[;I"$@yield [match] @return [String];T;0;6i;[[I"pattern;T0; @œ•o;= ;3I" overload;F;40;;˜;50;)I"gsub(pattern);T;IC;";T; @œ•;>0;!F;[;[;I";T;0;6i;[[I"pattern;T0; @œ•;[;I";Returns a copy of str with 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 backslash 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. Similarly, \&, \', \`, and \+ correspond to special variables, $&, $', $`, and $+, respectively. (See rdoc-ref:regexp.rdoc for details.) \0 is the same as \&. \\\\ is interpreted as an escape, i.e., a single backslash. Note that, 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. (See rdoc-ref:regexp.rdoc for details.) The value returned by the block will be substituted for the match on each call. 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*" Note that a string literal consumes backslashes. (See rdoc-ref:syntax/literals.rdoc for details on string literals.) Back-references are typically preceded by an additional backslash. For example, if you want to write a back-reference \& in +replacement+ with a double-quoted string literal, you need to write: "..\\\\&..". If you want to write a non-back-reference string \& in +replacement+, you need first to escape the backslash to prevent this method from interpreting it as a back-reference, and then you need to escape the backslashes again to prevent a string literal from consuming them: "..\\\\\\\\&..". You may want to use the block form to avoid a lot of backslashes. @overload gsub(pattern, replacement) @return [String] @overload gsub(pattern, hash) @return [String] @overload gsub(pattern) @yield [match] @return [String] @overload gsub(pattern);T;0; @œ•;!F;"o;#;$T;%i±;&ií;'@Õ‰;(I"lstatic VALUE rb_str_gsub(int argc, VALUE *argv, VALUE str) { return str_gsub(argc, argv, str, 0); };T;)I"static VALUE;T;*To;;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;= ;3I" overload;F;40;;™;50;)I" chop;T;IC;";T; @ë•;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ë•;[;I"@return [String];T;0;6i;[; @ë•;[;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; @ë•;!F;"o;#;$T;%i€#;&i#;'@Õ‰;(I"cstatic VALUE rb_str_chop(VALUE str) { return rb_str_subseq(str, 0, chopped_length(str)); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#chomp;F;[[@c0;[[@ ŠiM$;T;: chomp;0;[;{;IC;"?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" ;T;[o;= ;3I" overload;F;40;;š;50;)I"chomp(separator=$/);T;IC;";T; @–;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @–;[;I"@return [String];T;0;6i;[[I"separator;TI"$/;T; @–;[;I"rReturns 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; @–;!F;"o;#;$T;%i7$;&iJ$;'@Õ‰;(I"Ústatic VALUE rb_str_chomp(int argc, VALUE *argv, VALUE str) { VALUE rs = chomp_rs(argc, argv); if (NIL_P(rs)) return str_duplicate(rb_cString, str); return rb_str_subseq(str, 0, chompped_length(str, rs)); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#strip;F;[;[[@ ŠiC%;T;: strip;0;[;{;IC;"sReturns a copy of the receiver 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 #=> "" "hello".strip #=> "hello" ;T;[o;= ;3I" overload;F;40;;›;50;)I" strip;T;IC;";T; @%–;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @%–;[;I"@return [String];T;0;6i;[; @%–;[;I"˜Returns a copy of the receiver 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 #=> "" "hello".strip #=> "hello" @overload strip @return [String];T;0; @%–;!F;"o;#;$T;%i4%;&i@%;'@Õ‰;(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 str_duplicate(rb_cString, str); return rb_str_subseq(str, loffset, olen-loffset-roffset); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#lstrip;F;[;[[@ Ši¡$;T;:lstrip;0;[;{;IC;"ìReturns a copy of the receiver with leading whitespace removed. See also String#rstrip and String#strip. Refer to String#strip for the definition of whitespace. " hello ".lstrip #=> "hello " "hello".lstrip #=> "hello" ;T;[o;= ;3I" overload;F;40;;œ;50;)I"lstrip;T;IC;";T; @@–;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @@–;[;I"@return [String];T;0;6i;[; @@–;[;I"Returns a copy of the receiver with leading whitespace removed. See also String#rstrip and String#strip. Refer to String#strip for the definition of whitespace. " hello ".lstrip #=> "hello " "hello".lstrip #=> "hello" @overload lstrip @return [String];T;0; @@–;!F;"o;#;$T;%i”$;&iž$;'@Õ‰;(I"0static 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 str_duplicate(rb_cString, str); return rb_str_subseq(str, loffset, len - loffset); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#rstrip;F;[;[[@ Šiú$;T;:rstrip;0;[;{;IC;"íReturns a copy of the receiver with trailing whitespace removed. See also String#lstrip and String#strip. Refer to String#strip for the definition of whitespace. " hello ".rstrip #=> " hello" "hello".rstrip #=> "hello" ;T;[o;= ;3I" overload;F;40;;;50;)I"rstrip;T;IC;";T; @[–;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @[–;[;I"@return [String];T;0;6i;[; @[–;[;I"Returns a copy of the receiver with trailing whitespace removed. See also String#lstrip and String#strip. Refer to String#strip for the definition of whitespace. " hello ".rstrip #=> " hello" "hello".rstrip #=> "hello" @overload rstrip @return [String];T;0; @[–;!F;"o;#;$T;%ií$;&i÷$;'@Õ‰;(I"Sstatic 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 str_duplicate(rb_cString, str); return rb_str_subseq(str, 0, olen-roffset); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#delete_prefix;F;[[I"prefix;T0;[[@ ŠiG(;T;:delete_prefix;0;[;{;IC;"œReturns a copy of str with leading prefix deleted. "hello".delete_prefix("hel") #=> "lo" "hello".delete_prefix("llo") #=> "hello" ;T;[o;= ;3I" overload;F;40;;ž;50;)I"delete_prefix(prefix);T;IC;";T; @v–;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @v–;[;I"@return [String];T;0;6i;[[I"prefix;T0; @v–;[;I"ÑReturns a copy of str with leading prefix deleted. "hello".delete_prefix("hel") #=> "lo" "hello".delete_prefix("llo") #=> "hello" @overload delete_prefix(prefix) @return [String];T;0; @v–;!F;"o;#;$T;%i=(;&iD(;'@Õ‰;(I"static VALUE rb_str_delete_prefix(VALUE str, VALUE prefix) { long prefixlen; prefixlen = deleted_prefix_length(str, prefix); if (prefixlen <= 0) return str_duplicate(rb_cString, str); return rb_str_subseq(str, prefixlen, RSTRING_LEN(str) - prefixlen); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#delete_suffix;F;[[I"suffix;T0;[[@ Ši(;T;:delete_suffix;0;[;{;IC;"Returns a copy of str with trailing suffix deleted. "hello".delete_suffix("llo") #=> "he" "hello".delete_suffix("hel") #=> "hello" ;T;[o;= ;3I" overload;F;40;;Ÿ;50;)I"delete_suffix(suffix);T;IC;";T; @•–;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @•–;[;I"@return [String];T;0;6i;[[I"suffix;T0; @•–;[;I"ÒReturns a copy of str with trailing suffix deleted. "hello".delete_suffix("llo") #=> "he" "hello".delete_suffix("hel") #=> "hello" @overload delete_suffix(suffix) @return [String];T;0; @•–;!F;"o;#;$T;%i“(;&iš(;'@Õ‰;(I"static VALUE rb_str_delete_suffix(VALUE str, VALUE suffix) { long suffixlen; suffixlen = deleted_suffix_length(str, suffix); if (suffixlen <= 0) return str_duplicate(rb_cString, str); return rb_str_subseq(str, 0, RSTRING_LEN(str) - suffixlen); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#sub!;F;[[@c0;[[@ Šit;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;= ;3I" overload;F;40;; ;50;)I"sub!(pattern, replacement);T;IC;";T; @´–;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @´–;[;I"@return [String, nil];T;0;6i;[[I"pattern;T0[I"replacement;T0; @´–o;= ;3I" overload;F;40;; ;50;)I"sub!(pattern);T;IC;";T; @´–;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" match;T; @´–o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @´–;[;I")@yield [match] @return [String, nil];T;0;6i;[[I"pattern;T0; @´–;[;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; @´–;!F;"o;#;$T;%ii;&is;'@Õ‰;(I"ü static VALUE rb_str_sub_bang(int argc, VALUE *argv, VALUE str) { VALUE pat, repl, hash = Qnil; int iter = 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); } } 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); 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; 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); } rp = RSTRING_PTR(repl); memmove(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); return str; } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#gsub!;F;[[@c0;[[@ Š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;= ;3I" overload;F;40;;¡;50;)I" gsub!(pattern, replacement);T;IC;";T; @ê–;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @ê–;[;I"@return [String, nil];T;0;6i;[[I"pattern;T0[I"replacement;T0; @ê–o;= ;3I" overload;F;40;;¡;50;)I"gsub!(pattern, hash);T;IC;";T; @ê–;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @ê–;[;I"@return [String, nil];T;0;6i;[[I"pattern;T0[I" hash;T0; @ê–o;= ;3I" overload;F;40;;¡;50;)I"gsub!(pattern);T;IC;";T; @ê–;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" match;T; @ê–o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @ê–;[;I")@yield [match] @return [String, nil];T;0;6i;[[I"pattern;T0; @ê–o;= ;3I" overload;F;40;;¡;50;)I"gsub!(pattern);T;IC;";T; @ê–;>0;!F;[;[;I";T;0;6i;[[I"pattern;T0; @ê–;[;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; @ê–;!F;"o;#;$T;%iœ;&i©;'@Õ‰;(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;)I"static VALUE;T;*To;;F; ;;;;I"String#chop!;F;[;[[@ Šin#;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;= ;3I" overload;F;40;;¢;50;)I" chop!;T;IC;";T; @<—;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @<—;[;I"@return [String, nil];T;0;6i;[; @<—;[;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; @<—;!F;"o;#;$T;%ie#;&ik#;'@Õ‰;(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;)I"static VALUE;T;*To;;F; ;;;;I"String#chomp!;F;[[@c0;[[@ Š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;= ;3I" overload;F;40;;£;50;)I"chomp!(separator=$/);T;IC;";T; @X—;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @X—;[;I"@return [String, nil];T;0;6i;[[I"separator;TI"$/;T; @X—;[;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; @X—;!F;"o;#;$T;%i"$;&i($;'@Õ‰;(I"ÿstatic VALUE rb_str_chomp_bang(int argc, VALUE *argv, VALUE str) { VALUE rs; str_modifiable(str); if (RSTRING_LEN(str) == 0) return Qnil; rs = chomp_rs(argc, argv); if (NIL_P(rs)) return Qnil; return rb_str_chomp_string(str, rs); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#strip!;F;[;[[@ Ši%;T;:strip!;0;[;{;IC;"õRemoves leading and trailing whitespace from the receiver. Returns the altered receiver, or +nil+ if there was no change. Refer to String#strip for the definition of whitespace. " hello ".strip! #=> "hello" "hello".strip! #=> nil ;T;[o;= ;3I" overload;F;40;;¤;50;)I"strip!;T;IC;";T; @x—;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;TI"nil;T; @x—;[;I"@return [self, nil];T;0;6i;[; @x—;[;I"Removes leading and trailing whitespace from the receiver. Returns the altered receiver, or +nil+ if there was no change. Refer to String#strip for the definition of whitespace. " hello ".strip! #=> "hello" "hello".strip! #=> nil @overload strip! @return [self, nil];T;0; @x—;!F;"o;#;$T;%i %;&i%;'@Õ‰;(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;)I"static VALUE;T;*To;;F; ;;;;I"String#lstrip!;F;[;[[@ Ši{$;T;:lstrip!;0;[;{;IC;"6Removes leading whitespace from the receiver. Returns the altered receiver, or +nil+ if no change was made. See also String#rstrip! and String#strip!. Refer to String#strip for the definition of whitespace. " hello ".lstrip! #=> "hello " "hello ".lstrip! #=> nil "hello".lstrip! #=> nil ;T;[o;= ;3I" overload;F;40;;¥;50;)I"lstrip!;T;IC;";T; @”—;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;TI"nil;T; @”—;[;I"@return [self, nil];T;0;6i;[; @”—;[;I"`Removes leading whitespace from the receiver. Returns the altered receiver, or +nil+ if no change was made. See also String#rstrip! and String#strip!. Refer to String#strip for the definition of whitespace. " hello ".lstrip! #=> "hello " "hello ".lstrip! #=> nil "hello".lstrip! #=> nil @overload lstrip! @return [self, nil];T;0; @”—;!F;"o;#;$T;%il$;&ix$;'@Õ‰;(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;)I"static VALUE;T;*To;;F; ;;;;I"String#rstrip!;F;[;[[@ ŠiÕ$;T;:rstrip!;0;[;{;IC;"7Removes trailing whitespace from the receiver. Returns the altered receiver, or +nil+ if no change was made. See also String#lstrip! and String#strip!. Refer to String#strip for the definition of whitespace. " hello ".rstrip! #=> " hello" " hello".rstrip! #=> nil "hello".rstrip! #=> nil ;T;[o;= ;3I" overload;F;40;;¦;50;)I"rstrip!;T;IC;";T; @°—;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;TI"nil;T; @°—;[;I"@return [self, nil];T;0;6i;[; @°—;[;I"aRemoves trailing whitespace from the receiver. Returns the altered receiver, or +nil+ if no change was made. See also String#lstrip! and String#strip!. Refer to String#strip for the definition of whitespace. " hello ".rstrip! #=> " hello" " hello".rstrip! #=> nil "hello".rstrip! #=> nil @overload rstrip! @return [self, nil];T;0; @°—;!F;"o;#;$T;%iÆ$;&iÒ$;'@Õ‰;(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;)I"static VALUE;T;*To;;F; ;;;;I"String#delete_prefix!;F;[[I"prefix;T0;[[@ Ši1(;T;:delete_prefix!;0;[;{;IC;"ºDeletes leading prefix from str, returning nil if no change was made. "hello".delete_prefix!("hel") #=> "lo" "hello".delete_prefix!("llo") #=> nil ;T;[o;= ;3I" overload;F;40;;§;50;)I"delete_prefix!(prefix);T;IC;";T; @Ì—;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;TI"nil;T; @Ì—;[;I"@return [self, nil];T;0;6i;[[I"prefix;T0; @Ì—;[;I"óDeletes leading prefix from str, returning nil if no change was made. "hello".delete_prefix!("hel") #=> "lo" "hello".delete_prefix!("llo") #=> nil @overload delete_prefix!(prefix) @return [self, nil];T;0; @Ì—;!F;"o;#;$T;%i&(;&i.(;'@Õ‰;(I"ýstatic VALUE rb_str_delete_prefix_bang(VALUE str, VALUE prefix) { long prefixlen; str_modify_keep_cr(str); prefixlen = deleted_prefix_length(str, prefix); if (prefixlen <= 0) return Qnil; return rb_str_drop_bytes(str, prefixlen); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#delete_suffix!;F;[[I"suffix;T0;[[@ Ši(;T;:delete_suffix!;0;[;{;IC;"»Deletes trailing suffix from str, returning nil if no change was made. "hello".delete_suffix!("llo") #=> "he" "hello".delete_suffix!("hel") #=> nil ;T;[o;= ;3I" overload;F;40;;¨;50;)I"delete_suffix!(suffix);T;IC;";T; @ì—;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;TI"nil;T; @ì—;[;I"@return [self, nil];T;0;6i;[[I"suffix;T0; @ì—;[;I"ôDeletes trailing suffix from str, returning nil if no change was made. "hello".delete_suffix!("llo") #=> "he" "hello".delete_suffix!("hel") #=> nil @overload delete_suffix!(suffix) @return [self, nil];T;0; @ì—;!F;"o;#;$T;%it(;&i|(;'@Õ‰;(I"âstatic VALUE rb_str_delete_suffix_bang(VALUE str, VALUE suffix) { long olen, suffixlen, len; str_modifiable(str); suffixlen = deleted_suffix_length(str, suffix); if (suffixlen <= 0) return Qnil; olen = RSTRING_LEN(str); str_modify_keep_cr(str); len = olen - suffixlen; 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; };T;)I"static VALUE;T;*To;;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;= ;3I" overload;F;40;;©;50;)I"tr(from_str, to_str);T;IC;";T; @˜;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @˜;[;I"@return [String];T;0;6i;[[I" from_str;T0[I"to_str;T0; @˜;[;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; @˜;!F;"o;#;$T;%iž;&i¾;'@Õ‰;(I"—static VALUE rb_str_tr(VALUE str, VALUE src, VALUE repl) { str = str_duplicate(rb_cString, str); tr_trans(str, src, repl, 0); return str; };T;)I"static VALUE;T;*To;;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;= ;3I" overload;F;40;;ª;50;)I"tr_s(from_str, to_str);T;IC;";T; @/˜;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @/˜;[;I"@return [String];T;0;6i;[[I" from_str;T0[I"to_str;T0; @/˜;[;I"AProcesses 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; @/˜;!F;"o;#;$T;%iù;&i;'@Õ‰;(I"™static VALUE rb_str_tr_s(VALUE str, VALUE src, VALUE repl) { str = str_duplicate(rb_cString, str); tr_trans(str, src, repl, 1); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#delete;F;[[@c0;[[@ Šiu;T;;½;0;[;{;IC;"VReturns 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;= ;3I" overload;F;40;;½;50;)I"delete([other_str]+);T;IC;";T; @R˜;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @R˜;[;I"@return [String];T;0;6i;[[I"[other_str];T0; @R˜;[;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; @R˜;!F;"o;#;$T;%ig;&ir;'@Õ‰;(I"£static VALUE rb_str_delete(int argc, VALUE *argv, VALUE str) { str = str_duplicate(rb_cString, str); rb_str_delete_bang(argc, argv, str); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#squeeze;F;[[@c0;[[@ Š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;= ;3I" overload;F;40;;«;50;)I"squeeze([other_str]*);T;IC;";T; @p˜;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @p˜;[;I"@return [String];T;0;6i;[[I"[other_str];T0; @p˜;[;I"0Builds 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; @p˜;!F;"o;#;$T;%iÒ;&iÞ;'@Õ‰;(I"¥static VALUE rb_str_squeeze(int argc, VALUE *argv, VALUE str) { str = str_duplicate(rb_cString, str); rb_str_squeeze_bang(argc, argv, str); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#count;F;[[@c0;[[@ Ši*;T;;(;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;= ;3I" overload;F;40;;(;50;)I"count([other_str]+);T;IC;";T; @Ž˜;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ž˜;[;I"@return [Integer];T;0;6i;[[I"[other_str];T0; @Ž˜;[;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 [Integer];T;0; @Ž˜;!F;"o;#;$T;%i;&i';'@Õ‰;(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;= ;3I" overload;F;40;;¬;50;)I"tr!(from_str, to_str);T;IC;";T; @¬˜;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @¬˜;[;I"@return [String, nil];T;0;6i;[[I" from_str;T0[I"to_str;T0; @¬˜;[;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; @¬˜;!F;"o;#;$T;%iŽ;&i”;'@Õ‰;(I"nstatic VALUE rb_str_tr_bang(VALUE str, VALUE src, VALUE repl) { return tr_trans(str, src, repl, 0); };T;)I"static VALUE;T;*To;;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;= ;3I" overload;F;40;;;50;)I"tr_s!(from_str, to_str);T;IC;";T; @Ð˜;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @Ð˜;[;I"@return [String, nil];T;0;6i;[[I" from_str;T0[I"to_str;T0; @Ð˜;[;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; @Ð˜;!F;"o;#;$T;%iê;&iï;'@Õ‰;(I"pstatic VALUE rb_str_tr_s_bang(VALUE str, VALUE src, VALUE repl) { return tr_trans(str, src, repl, 1); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#delete!;F;[[@c0;[[@ Ši);T;:delete!;0;[;{;IC;"|Performs a delete operation in place, returning str, or nil if str was not modified. ;T;[o;= ;3I" overload;F;40;;®;50;)I"delete!([other_str]+);T;IC;";T; @ô˜;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @ô˜;[;I"@return [String, nil];T;0;6i;[[I"[other_str];T0; @ô˜;[;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; @ô˜;!F;"o;#;$T;%i!;&i&;'@Õ‰;(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;= ;3I" overload;F;40;;¯;50;)I"squeeze!([other_str]*);T;IC;";T; @™;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @™;[;I"@return [String, nil];T;0;6i;[[I"[other_str];T0; @™;[;I"¢Squeezes str in place, returning either str, or nil if no changes were made. @overload squeeze!([other_str]*) @return [String, nil];T;0; @™;!F;"o;#;$T;%i~;&iƒ;'@Õ‰;(I"¨static 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; unsigned 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 = *s) < 0x80) { if (c != save || (argc > 0 && !squeez[c])) { *t++ = save = c; } s++; } else { c = rb_enc_codepoint_len((char *)s, (char *)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((char *)t, TERM_LEN(str)); if ((char *)t - RSTRING_PTR(str) != RSTRING_LEN(str)) { STR_SET_LEN(str, (char *)t - RSTRING_PTR(str)); modify = 1; } if (modify) return str; return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#each_line;F;[[@c0;[[@ ŠiÈ!;T;;;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 +chomp+ is +true+, +separator+ will be removed from the end of each line. If no block is given, an enumerator is returned instead. "hello\nworld".each_line {|s| p s} # prints: # "hello\n" # "world" "hello\nworld".each_line('l') {|s| p s} # prints: # "hel" # "l" # "o\nworl" # "d" "hello\n\n\nworld".each_line('') {|s| p s} # prints # "hello\n\n" # "world" "hello\nworld".each_line(chomp: true) {|s| p s} # prints: # "hello" # "world" "hello\nworld".each_line('l', chomp: true) {|s| p s} # prints: # "he" # "" # "o\nwor" # "d" ;T;[o;= ;3I" overload;F;40;;;50;)I"*each_line(separator=$/, chomp: false);T;IC;";T; @2™;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"substr;T; @2™o;2 ;3I"return;F;4I";T;0;5[I"String;T; @2™;[;I"%@yield [substr] @return [String];T;0;6i;[[I"separator;TI"$/;T[I"chomp:;TI" false;T; @2™o;= ;3I" overload;F;40;;;50;)I"*each_line(separator=$/, chomp: false);T;IC;";T; @2™;>0;!F;[;[;I";T;0;6i;[[I"separator;TI"$/;T[I"chomp:;TI" false;T; @2™;[;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 +chomp+ is +true+, +separator+ will be removed from the end of each line. If no block is given, an enumerator is returned instead. "hello\nworld".each_line {|s| p s} # prints: # "hello\n" # "world" "hello\nworld".each_line('l') {|s| p s} # prints: # "hel" # "l" # "o\nworl" # "d" "hello\n\n\nworld".each_line('') {|s| p s} # prints # "hello\n\n" # "world" "hello\nworld".each_line(chomp: true) {|s| p s} # prints: # "hello" # "world" "hello\nworld".each_line('l', chomp: true) {|s| p s} # prints: # "he" # "" # "o\nwor" # "d" @overload each_line(separator=$/, chomp: false) @yield [substr] @return [String] @overload each_line(separator=$/, chomp: false);T;0; @2™;!F;"o;#;$T;%i™!;&iÆ!;'@Õ‰;(I"«static VALUE rb_str_each_line(int argc, VALUE *argv, VALUE str) { RETURN_SIZED_ENUMERATOR(str, argc, argv, 0); return rb_str_enumerate_lines(argc, argv, str, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#each_byte;F;[;[[@ Ši";T;;;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;= ;3I" overload;F;40;;;50;)I"each_byte;T;IC;";T; @g™;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"integer;T; @g™o;2 ;3I"return;F;4I";T;0;5[I"String;T; @g™;[;I"&@yield [integer] @return [String];T;0;6i;[; @g™o;= ;3I" overload;F;40;;;50;)I"each_byte;T;IC;";T; @g™;>0;!F;[;[;I";T;0;6i;[; @g™;[;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 [integer] @return [String] @overload each_byte;T;0; @g™;!F;"o;#;$T;%iý!;&i ";'@Õ‰;(I"–static VALUE rb_str_each_byte(VALUE str) { RETURN_SIZED_ENUMERATOR(str, 0, 0, rb_str_each_byte_size); return rb_str_enumerate_bytes(str, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#each_char;F;[;[[@ ŠiZ";T;;;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;= ;3I" overload;F;40;;;50;)I"each_char;T;IC;";T; @™;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" cstr;T; @™o;2 ;3I"return;F;4I";T;0;5[I"String;T; @™;[;I"#@yield [cstr] @return [String];T;0;6i;[; @™o;= ;3I" overload;F;40;;;50;)I"each_char;T;IC;";T; @™;>0;!F;[;[;I";T;0;6i;[; @™;[;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; @™;!F;"o;#;$T;%iK";&iX";'@Õ‰;(I"–static VALUE rb_str_each_char(VALUE str) { RETURN_SIZED_ENUMERATOR(str, 0, 0, rb_str_each_char_size); return rb_str_enumerate_chars(str, 0); };T;)I"static VALUE;T;*To;;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. For encodings other than UTF-8/UTF-16(BE|LE)/UTF-32(BE|LE), values are directly derived from the binary representation of each character. 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;= ;3I" overload;F;40;;°;50;)I"each_codepoint;T;IC;";T; @·™;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"integer;T; @·™o;2 ;3I"return;F;4I";T;0;5[I"String;T; @·™;[;I"&@yield [integer] @return [String];T;0;6i;[; @·™o;= ;3I" overload;F;40;;°;50;)I"each_codepoint;T;IC;";T; @·™;>0;!F;[;[;I";T;0;6i;[; @·™;[;I"Passes the Integer ordinal of each character in str, also known as a codepoint when applied to Unicode strings to the given block. For encodings other than UTF-8/UTF-16(BE|LE)/UTF-32(BE|LE), values are directly derived from the binary representation of each character. 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; @·™;!F;"o;#;$T;%i";&i¢";'@Õ‰;(I" static VALUE rb_str_each_codepoint(VALUE str) { RETURN_SIZED_ENUMERATOR(str, 0, 0, rb_str_each_char_size); return rb_str_enumerate_codepoints(str, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"!String#each_grapheme_cluster;F;[;[[@ Ši:#;T;:each_grapheme_cluster;0;[;{;IC;"MPasses each grapheme cluster in str to the given block, or returns an enumerator if no block is given. Unlike String#each_char, this enumerates by grapheme clusters defined by Unicode Standard Annex #29 http://unicode.org/reports/tr29/ "a\u0300".each_char.to_a.size #=> 2 "a\u0300".each_grapheme_cluster.to_a.size #=> 1 ;T;[o;= ;3I" overload;F;40;;±;50;)I"each_grapheme_cluster;T;IC;";T; @ß™;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" cstr;T; @ß™o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ß™;[;I"#@yield [cstr] @return [String];T;0;6i;[; @ß™o;= ;3I" overload;F;40;;±;50;)I"each_grapheme_cluster;T;IC;";T; @ß™;>0;!F;[;[;I";T;0;6i;[; @ß™;[;I"³Passes each grapheme cluster in str to the given block, or returns an enumerator if no block is given. Unlike String#each_char, this enumerates by grapheme clusters defined by Unicode Standard Annex #29 http://unicode.org/reports/tr29/ "a\u0300".each_char.to_a.size #=> 2 "a\u0300".each_grapheme_cluster.to_a.size #=> 1 @overload each_grapheme_cluster @yield [cstr] @return [String] @overload each_grapheme_cluster;T;0; @ß™;!F;"o;#;$T;%i+#;&i8#;'@Õ‰;(I"ºstatic VALUE rb_str_each_grapheme_cluster(VALUE str) { RETURN_SIZED_ENUMERATOR(str, 0, 0, rb_str_each_grapheme_cluster_size); return rb_str_enumerate_grapheme_clusters(str, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#sum;F;[[@c0;[[@ Ši‡&;T;;W;0;[;{;IC;""Returns a basic n-bit checksum of the characters in str, where n is the optional Integer 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;= ;3I" overload;F;40;;W;50;)I"sum(n=16);T;IC;";T; @š;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @š;[;I"@return [Integer];T;0;6i;[[I"n;TI"16;T; @š;[;I"LReturns a basic n-bit checksum of the characters in str, where n is the optional Integer 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; @š;!F;"o;#;$T;%i|&;&i„&;'@Õ‰;(I"þstatic VALUE rb_str_sum(int argc, VALUE *argv, VALUE str) { int bits = 16; char *ptr, *p, *pend; long len; VALUE sum = INT2FIX(0); unsigned long sum0 = 0; if (rb_check_arity(argc, 0, 1) && (bits = NUM2INT(argv[0])) < 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)< "r" Counts backward from the end of +self+ if +index+ is negative: 'foo'[-3] # => "f" Returns +nil+ if +index+ is out of range: 'foo'[3] # => nil 'foo'[-4] # => nil When the two \Integer arguments +start+ and +length+ are given, returns the substring of the given +length+ found in +self+ at offset +start+: 'foo'[0, 2] # => "fo" 'foo'[0, 0] # => "" Counts backward from the end of +self+ if +start+ is negative: 'foo'[-2, 2] # => "oo" Special case: returns a new empty \String if +start+ is equal to the length of +self+: 'foo'[3, 2] # => "" Returns +nil+ if +start+ is out of range: 'foo'[4, 2] # => nil 'foo'[-4, 2] # => nil Returns the trailing substring of +self+ if +length+ is large: 'foo'[1, 50] # => "oo" Returns +nil+ if +length+ is negative: 'foo'[0, -1] # => nil When the single \Range argument +range+ is given, derives +start+ and +length+ values from the given +range+, and returns values as above: - 'foo'[0..1] is equivalent to 'foo'[0, 2]. - 'foo'[0...1] is equivalent to 'foo'[0, 1]. When the \Regexp argument +regexp+ is given, and the +capture+ argument is 0, returns the first matching substring found in +self+, or +nil+ if none found: 'foo'[/o/] # => "o" 'foo'[/x/] # => nil s = 'hello there' s[/[aeiou](.)\1/] # => "ell" s[/[aeiou](.)\1/, 0] # => "ell" If argument +capture+ is given and not 0, it should be either an \Integer capture group index or a \String or \Symbol capture group name; the method call returns only the specified capture (see {Regexp Capturing}[Regexp.html#class-Regexp-label-Capturing]): s = 'hello there' s[/[aeiou](.)\1/, 1] # => "l" s[/(?[aeiou])(?[^aeiou])/, "non_vowel"] # => "l" s[/(?[aeiou])(?[^aeiou])/, :vowel] # => "e" If an invalid capture group index is given, +nil+ is returned. If an invalid capture group name is given, +IndexError+ is raised. When the single \String argument +substring+ is given, returns the substring from +self+ if found, otherwise +nil+: 'foo'['oo'] # => "oo" 'foo'['xx'] # => nil String#slice is an alias for String#[]. ;T;[ o;= ;3I" overload;F;40;;Â;50;)I"[](index);T;IC;";T; @&š;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @&š;[;I"@return [nil];T;0;6i;[[I" index;T0; @&šo;= ;3I" overload;F;40;;Â;50;)I"[](start, length);T;IC;";T; @&š;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @&š;[;I"@return [nil];T;0;6i;[[I" start;T0[I"length;T0; @&šo;= ;3I" overload;F;40;;Â;50;)I"[](range);T;IC;";T; @&š;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @&š;[;I"@return [nil];T;0;6i;[[I" range;T0; @&šo;= ;3I" overload;F;40;;Â;50;)I"[](regexp, capture = 0);T;IC;";T; @&š;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @&š;[;I"@return [nil];T;0;6i;[[I"regexp;T0[I"capture;TI"0;T; @&šo;= ;3I" overload;F;40;;Â;50;)I"[](substring);T;IC;";T; @&š;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @&š;[;I"@return [nil];T;0;6i;[[I"substring;T0; @&š;[;@Œ;0; @&š;!F;"o;#;$T;%ib;&iª;'@Õ‰;(I"vstatic 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]); } else { long beg = NUM2LONG(argv[0]); long len = NUM2LONG(argv[1]); return rb_str_substr(str, beg, len); } } rb_check_arity(argc, 1, 2); return rb_str_aref(str, argv[0]); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#slice!;F;[[@c0;[[@ ŠiÌ;T;;%;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;= ;3I" overload;F;40;;%;50;)I"slice!(integer);T;IC;";T; @„š;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @„š;[;I"@return [String, nil];T;0;6i;[[I"integer;T0; @„šo;= ;3I" overload;F;40;;%;50;)I"slice!(integer, integer);T;IC;";T; @„š;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @„š;[;I"@return [String, nil];T;0;6i;[[I"integer;T0[I"integer;T0; @„šo;= ;3I" overload;F;40;;%;50;)I"slice!(range);T;IC;";T; @„š;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @„š;[;I"@return [String, nil];T;0;6i;[[I" range;T0; @„šo;= ;3I" overload;F;40;;%;50;)I"slice!(regexp);T;IC;";T; @„š;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @„š;[;I"@return [String, nil];T;0;6i;[[I"regexp;T0; @„šo;= ;3I" overload;F;40;;%;50;)I"slice!(other_str);T;IC;";T; @„š;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @„š;[;I"@return [String, nil];T;0;6i;[[I"other_str;T0; @„š;[;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!(integer) @return [String, nil] @overload slice!(integer, integer) @return [String, nil] @overload slice!(range) @return [String, nil] @overload slice!(regexp) @return [String, nil] @overload slice!(other_str) @return [String, nil];T;0; @„š;!F;"o;#;$T;%i¹;&iÍ;'@Õ‰;(I"Wstatic VALUE rb_str_slice_bang(int argc, VALUE *argv, VALUE str) { VALUE result = Qnil; VALUE indx; long beg, len = 1; char *p; rb_check_arity(argc, 1, 2); str_modify_keep_cr(str); indx = argv[0]; if (RB_TYPE_P(indx, T_REGEXP)) { if (rb_reg_search(indx, str, 0, 0) < 0) return Qnil; VALUE match = rb_backref_get(); struct re_registers *regs = RMATCH_REGS(match); int nth = 0; if (argc > 1 && (nth = rb_reg_backref_number(match, argv[1])) < 0) { if ((nth += regs->num_regs) <= 0) return Qnil; } else if (nth >= regs->num_regs) return Qnil; beg = BEG(nth); len = END(nth) - beg; goto subseq; } else if (argc == 2) { beg = NUM2LONG(indx); len = NUM2LONG(argv[1]); goto num_index; } else if (FIXNUM_P(indx)) { beg = FIX2LONG(indx); if (!(p = rb_str_subpos(str, beg, &len))) return Qnil; if (!len) return Qnil; beg = p - RSTRING_PTR(str); goto subseq; } else if (RB_TYPE_P(indx, T_STRING)) { beg = rb_str_index(str, indx, 0); if (beg == -1) return Qnil; len = RSTRING_LEN(indx); result = str_duplicate(rb_cString, indx); goto squash; } else { switch (rb_range_beg_len(indx, &beg, &len, str_strlen(str, NULL), 0)) { case Qnil: return Qnil; case Qfalse: beg = NUM2LONG(indx); if (!(p = rb_str_subpos(str, beg, &len))) return Qnil; if (!len) return Qnil; beg = p - RSTRING_PTR(str); goto subseq; default: goto num_index; } } num_index: if (!(p = rb_str_subpos(str, beg, &len))) return Qnil; beg = p - RSTRING_PTR(str); subseq: result = rb_str_new(RSTRING_PTR(str)+beg, len); rb_enc_cr_str_copy_for_substr(result, str); squash: if (len > 0) { if (beg == 0) { rb_str_drop_bytes(str, len); } else { char *sptr = RSTRING_PTR(str); long slen = RSTRING_LEN(str); if (beg + len > slen) /* pathological check */ len = slen - beg; memmove(sptr + beg, sptr + beg + len, slen - (beg + len)); slen -= len; STR_SET_LEN(str, slen); TERM_FILL(&sptr[slen], TERM_LEN(str)); } } return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#partition;F;[[I"sep;T0;[[@ Šic';T;;6;0;[;{;IC;"eSearches 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"] ;T;[o;= ;3I" overload;F;40;;6;50;)I"partition(sep);T;IC;";T; @åš;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @åš;[;I"@return [Array];T;0;6i;[[I"sep;T0; @åšo;= ;3I" overload;F;40;;6;50;)I"partition(regexp);T;IC;";T; @åš;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @åš;[;I"@return [Array];T;0;6i;[[I"regexp;T0; @åš;[;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; @åš;!F;"o;#;$T;%iT';&ia';'@Õ‰;(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)) { if (rb_reg_search(sep, str, 0, 0) < 0) { goto failed; } VALUE match = rb_backref_get(); struct re_registers *regs = RMATCH_REGS(match); pos = BEG(0); sep = rb_str_subseq(str, pos, END(0) - pos); } 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))); failed: return rb_ary_new3(3, str_duplicate(rb_cString, str), str_new_empty_String(str), str_new_empty_String(str)); };T;)I"static VALUE;T;*To;;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"] The match from the end means starting at the possible last position, not the last of longest matches. "hello".rpartition(/l+/) #=> ["hel", "l", "o"] To partition at the last longest match, needs to combine with negative lookbehind. "hello".rpartition(/(? ["he", "ll", "o"] Or String#partition with negative lookforward. "hello".partition(/l+(?!.*l)/) #=> ["he", "ll", "o"] ;T;[o;= ;3I" overload;F;40;;²;50;)I"rpartition(sep);T;IC;";T; @›;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @›;[;I"@return [Array];T;0;6i;[[I"sep;T0; @›o;= ;3I" overload;F;40;;²;50;)I"rpartition(regexp);T;IC;";T; @›;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @›;[;I"@return [Array];T;0;6i;[[I"regexp;T0; @›;[;I"zSearches 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"] The match from the end means starting at the possible last position, not the last of longest matches. "hello".rpartition(/l+/) #=> ["hel", "l", "o"] To partition at the last longest match, needs to combine with negative lookbehind. "hello".rpartition(/(? ["he", "ll", "o"] Or String#partition with negative lookforward. "hello".partition(/l+(?!.*l)/) #=> ["he", "ll", "o"] @overload rpartition(sep) @return [Array] @overload rpartition(regexp) @return [Array];T;0; @›;!F;"o;#;$T;%i€';&i›';'@Õ‰;(I"}static VALUE rb_str_rpartition(VALUE str, VALUE sep) { long pos = RSTRING_LEN(str); sep = get_pat_quoted(sep, 0); if (RB_TYPE_P(sep, T_REGEXP)) { if (rb_reg_search(sep, str, pos, 1) < 0) { goto failed; } VALUE match = rb_backref_get(); struct re_registers *regs = RMATCH_REGS(match); pos = BEG(0); sep = rb_str_subseq(str, pos, END(0) - pos); } else { pos = rb_str_sublen(str, pos); pos = rb_str_rindex(str, sep, pos); if(pos < 0) { goto failed; } 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))); failed: return rb_ary_new3(3, str_new_empty_String(str), str_new_empty_String(str), str_duplicate(rb_cString, str)); };T;)I"static VALUE;T;*To;;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;= ;3I" overload;F;40;;³;50;)I" encoding;T;IC;";T; @A›;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Encoding;T; @A›;[;I"@return [Encoding];T;0;6i;[; @A›;[;I"oReturns the Encoding object that represents the encoding of obj. @overload encoding @return [Encoding];T;0; @A›;!F;"o;#;$T;%iª;&i®;'@Õ‰;(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;)I" VALUE;T;*To;;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;= ;3I" overload;F;40;;´;50;)I"force_encoding(encoding);T;IC;";T; @]›;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @]›;[;I"@return [String];T;0;6i;[[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 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;)I"static VALUE;T;*To;;F; ;;;;I" String#b;F;[;[[@ ŠiØ(;T;:b;0;[;{;IC;":Returns a copied string whose encoding is ASCII-8BIT. ;T;[o;= ;3I" overload;F;40;;µ;50;)I"b;T;IC;";T; @|›;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @|›;[;I"@return [String];T;0;6i;[; @|›;[;I"[Returns a copied string whose encoding is ASCII-8BIT. @overload b @return [String];T;0; @|›;!F;"o;#;$T;%iÑ(;&iÕ(;'@Õ‰;(I"«static VALUE rb_str_b(VALUE str) { VALUE str2 = str_alloc(rb_cString); str_replace_shared_without_enc(str2, str); ENC_CODERANGE_CLEAR(str2); return str2; };T;)I"static VALUE;T;*To;;F; ;;;;I"String#valid_encoding?;F;[;[[@ Šiì(;T;:valid_encoding?;0;[;{;IC;"õReturns true for a string which is 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;= ;3I" overload;F;40;;¶;50;)I"valid_encoding?;T;IC;";T; @—›;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @—›;[;I"@return [Boolean];T;0;6i;[; @—›;[;I"%Returns true for a string which is 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; @—›;!F;"o;#;$T;%iá(;&ié(;6i;'@Õ‰;(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;)I"static VALUE;T;*To;;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;= ;3I" overload;F;40;;·;50;)I"ascii_only?;T;IC;";T; @²›;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @²›;[;I"@return [Boolean];T;0;6i;[; @²›;[;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û(;6i;'@Õ‰;(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;)I"static VALUE;T;*To;;F; ;;;;I"String#unicode_normalize;F;[[@c0;[[@ Ši®*;T;:unicode_normalize;0;[;{;IC;"VUnicode Normalization---Returns a normalized form of +str+, using Unicode normalizations NFC, NFD, NFKC, or NFKD. The normalization form used is determined by +form+, which can be any of the four values +:nfc+, +:nfd+, +:nfkc+, or +:nfkd+. The default is +:nfc+. If the string is not in a Unicode Encoding, then an Exception is raised. In this context, 'Unicode Encoding' means any of UTF-8, UTF-16BE/LE, and UTF-32BE/LE, as well as GB18030, UCS_2BE, and UCS_4BE. Anything other than UTF-8 is implemented by converting to UTF-8, which makes it slower than UTF-8. "a\u0300".unicode_normalize #=> "\u00E0" "a\u0300".unicode_normalize(:nfc) #=> "\u00E0" "\u00E0".unicode_normalize(:nfd) #=> "a\u0300" "\xE0".force_encoding('ISO-8859-1').unicode_normalize(:nfd) #=> Encoding::CompatibilityError raised ;T;[o;= ;3I" overload;F;40;;¸;50;)I"!unicode_normalize(form=:nfc);T;IC;";T; @Í›;>0;!F;[;[;I";T;0;6i;[[I" form;TI" :nfc;T; @Í›;[;I"Unicode Normalization---Returns a normalized form of +str+, using Unicode normalizations NFC, NFD, NFKC, or NFKD. The normalization form used is determined by +form+, which can be any of the four values +:nfc+, +:nfd+, +:nfkc+, or +:nfkd+. The default is +:nfc+. If the string is not in a Unicode Encoding, then an Exception is raised. In this context, 'Unicode Encoding' means any of UTF-8, UTF-16BE/LE, and UTF-32BE/LE, as well as GB18030, UCS_2BE, and UCS_4BE. Anything other than UTF-8 is implemented by converting to UTF-8, which makes it slower than UTF-8. "a\u0300".unicode_normalize #=> "\u00E0" "a\u0300".unicode_normalize(:nfc) #=> "\u00E0" "\u00E0".unicode_normalize(:nfd) #=> "a\u0300" "\xE0".force_encoding('ISO-8859-1').unicode_normalize(:nfd) #=> Encoding::CompatibilityError raised @overload unicode_normalize(form=:nfc);T;0; @Í›;!F;"o;#;$T;%i˜*;&i«*;'@Õ‰;(I"static VALUE rb_str_unicode_normalize(int argc, VALUE *argv, VALUE str) { return unicode_normalize_common(argc, argv, str, id_normalize); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#unicode_normalize!;F;[[@c0;[[@ Ši»*;T;:unicode_normalize!;0;[;{;IC;"[Destructive version of String#unicode_normalize, doing Unicode normalization in place. ;T;[o;= ;3I" overload;F;40;;¹;50;)I""unicode_normalize!(form=:nfc);T;IC;";T; @ç›;>0;!F;[;[;I";T;0;6i;[[I" form;TI" :nfc;T; @ç›;[;I"€Destructive version of String#unicode_normalize, doing Unicode normalization in place. @overload unicode_normalize!(form=:nfc);T;0; @ç›;!F;"o;#;$T;%i´*;&i¸*;'@Õ‰;(I"©static VALUE rb_str_unicode_normalize_bang(int argc, VALUE *argv, VALUE str) { return rb_str_replace(str, unicode_normalize_common(argc, argv, str, id_normalize)); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#unicode_normalized?;F;[[@c0;[[@ ŠiÒ*;T;:unicode_normalized?;0;[;{;IC;"^Checks whether +str+ is in Unicode normalization form +form+, which can be any of the four values +:nfc+, +:nfd+, +:nfkc+, or +:nfkd+. The default is +:nfc+. If the string is not in a Unicode Encoding, then an Exception is raised. For details, see String#unicode_normalize. "a\u0300".unicode_normalized? #=> false "a\u0300".unicode_normalized?(:nfd) #=> true "\u00E0".unicode_normalized? #=> true "\u00E0".unicode_normalized?(:nfd) #=> false "\xE0".force_encoding('ISO-8859-1').unicode_normalized? #=> Encoding::CompatibilityError raised;T;[o;= ;3I" overload;F;40;;º;50;)I"#unicode_normalized?(form=:nfc);T;IC;";T; @œ;>0;!F;[;[;I";T;0;6i;[[I" form;TI" :nfc;T; @œo;2 ;3I"return;F;4@|;0;5[@~; @œ;[;I"‰Checks whether +str+ is in Unicode normalization form +form+, which can be any of the four values +:nfc+, +:nfd+, +:nfkc+, or +:nfkd+. The default is +:nfc+. If the string is not in a Unicode Encoding, then an Exception is raised. For details, see String#unicode_normalize. "a\u0300".unicode_normalized? #=> false "a\u0300".unicode_normalized?(:nfd) #=> true "\u00E0".unicode_normalized? #=> true "\u00E0".unicode_normalized?(:nfd) #=> false "\xE0".force_encoding('ISO-8859-1').unicode_normalized? #=> Encoding::CompatibilityError raised @overload unicode_normalized?(form=:nfc);T;0; @œ;!F;"o;#;$T;%iÁ*;&iÐ*;6i;'@Õ‰;(I"•static VALUE rb_str_unicode_normalized_p(int argc, VALUE *argv, VALUE str) { return unicode_normalize_common(argc, argv, str, id_normalized_p); };T;)I"static VALUE;T;*To;;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; @œ;'@Õ‰;(I"“static VALUE str2big_poweroftwo(VALUE str, VALUE vbase, VALUE badcheck) { return rb_str2big_poweroftwo(str, NUM2INT(vbase), RTEST(badcheck)); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#str2big_normal;F;[[I" vbase;T0[I" badcheck;T0;[[@'œi;T;:str2big_normal;0;[;{;IC;";T;[;[;@|;0; @/œ;'@Õ‰;(I"‹static VALUE str2big_normal(VALUE str, VALUE vbase, VALUE badcheck) { return rb_str2big_normal(str, NUM2INT(vbase), RTEST(badcheck)); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#str2big_karatsuba;F;[[I" vbase;T0[I" badcheck;T0;[[@'œi;T;:str2big_karatsuba;0;[;{;IC;";T;[;[;@|;0; @?œ;'@Õ‰;(I"‘static VALUE str2big_karatsuba(VALUE str, VALUE vbase, VALUE badcheck) { return rb_str2big_karatsuba(str, NUM2INT(vbase), RTEST(badcheck)); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#str2big_gmp;F;[[I" vbase;T0[I" badcheck;T0;[[@'œi;T;:str2big_gmp;0;[;{;IC;";T;[;[;@|;0; @Oœ;'@Õ‰;(I"…static VALUE str2big_gmp(VALUE str, VALUE vbase, VALUE badcheck) { return rb_str2big_gmp(str, NUM2INT(vbase), RTEST(badcheck)); };T;)I"static VALUE;T;*To;;F; ;;;;I"String#encode;F;[[@c0;[[I"transcode.c;TiC;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+ keyword arguments give details for conversion. The arguments are: :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;= ;3I" overload;F;40;;¿;50;)I" encode(encoding, **options);T;IC;";T; @_œ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @_œ;[;I"@return [String];T;0;6i;[[I" encoding;T0[I"**options;T0; @_œo;= ;3I" overload;F;40;;¿;50;)I"2encode(dst_encoding, src_encoding, **options);T;IC;";T; @_œ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @_œ;[;I"@return [String];T;0;6i;[[I"dst_encoding;T0[I"src_encoding;T0[I"**options;T0; @_œo;= ;3I" overload;F;40;;¿;50;)I"encode(**options);T;IC;";T; @_œ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @_œ;[;I"@return [String];T;0;6i;[[I"**options;T0; @_œ;[;I"O 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+ keyword arguments give details for conversion. The arguments are: :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;&iB;'@Õ‰;(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;)I"static VALUE;T;*To;;F; ;;;;I"String#encode!;F;[[@c0;[[@eœ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+ keyword arguments give details for conversion. See String#encode for details. Returns the string even if no changes were made. ;T;[o;= ;3I" overload;F;40;;À;50;)I"!encode!(encoding, **options);T;IC;";T; @¢œ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @¢œ;[;I"@return [String];T;0;6i;[[I" encoding;T0[I"**options;T0; @¢œo;= ;3I" overload;F;40;;À;50;)I"3encode!(dst_encoding, src_encoding, **options);T;IC;";T; @¢œ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @¢œ;[;I"@return [String];T;0;6i;[[I"dst_encoding;T0[I"src_encoding;T0[I"**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+ keyword arguments give 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 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;)I"static VALUE;T;*T;A@Õ‰;BIC;[;A@Õ‰;CIC;[@j‡;A@Õ‰;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ ŠiJ-;F;;º;;K;;;[;{;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;"o;#;$T;%i:-;&iD-;6i;'@;I"String;F;S@]o; ;IC;[@o;;F; ;;;;I"Float#arg;F;[;[[@t iæ;T;;B;0;[;{;IC;"6Returns 0 if the value is positive, pi otherwise. ;T;[o;= ;3I" overload;F;40;;B;50;)I"arg;T;IC;";T; @èœ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI" Float;T; @èœ;[;I"@return [ 0, Float];T;0;6i;[; @èœo;= ;3I" overload;F;40;;C;50;)I" angle;T;IC;";T; @èœ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI" Float;T; @èœ;[;I"@return [ 0, Float];T;0;6i;[; @èœo;= ;3I" overload;F;40;;D;50;)I" phase;T;IC;";T; @èœ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI" Float;T; @èœ;[;I"@return [ 0, Float];T;0;6i;[; @èœ;[;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 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;)I"static VALUE;T;*To;;F; ;;;;I"Float#angle;F;[;[[@t iæ;T;;C;0;[;{;IC;"6Returns 0 if the value is positive, pi otherwise. ;T;[o;= ;3I" overload;F;40;;B;50;)I"arg;T;IC;";T; @ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI" Float;T; @ ;[;I"@return [ 0, Float];T;0;6i;[; @ o;= ;3I" overload;F;40;;C;50;)I" angle;T;IC;";T; @ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI" Float;T; @ ;[;I"@return [ 0, Float];T;0;6i;[; @ o;= ;3I" overload;F;40;;D;50;)I" phase;T;IC;";T; @ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI" Float;T; @ ;[;I"@return [ 0, Float];T;0;6i;[; @ ;[;@;0; @ ;!F;"o;#;$T;%iÞ;&iæ;'@æœ;(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;)I"static VALUE;T;*To;;F; ;;;;I"Float#phase;F;[;[[@t iæ;T;;D;0;[;{;IC;"6Returns 0 if the value is positive, pi otherwise. ;T;[o;= ;3I" overload;F;40;;B;50;)I"arg;T;IC;";T; @W;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI" Float;T; @W;[;I"@return [ 0, Float];T;0;6i;[; @Wo;= ;3I" overload;F;40;;C;50;)I" angle;T;IC;";T; @W;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI" Float;T; @W;[;I"@return [ 0, Float];T;0;6i;[; @Wo;= ;3I" overload;F;40;;D;50;)I" phase;T;IC;";T; @W;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI" Float;T; @W;[;I"@return [ 0, Float];T;0;6i;[; @W;[;@;0; @W;!F;"o;#;$T;%iÞ;&iæ;'@æœ;(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;)I"static VALUE;T;*To;;F; ;;;;I"Float#numerator;F;[;[[@¨ i+;T;;H;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 See also Float#denominator. ;T;[o;= ;3I" overload;F;40;;H;50;)I"numerator;T;IC;";T; @Ž;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ž;[;I"@return [Integer];T;0;6i;[; @Ž;[;I"ûReturns the numerator. The result is machine dependent. n = 0.3.numerator #=> 5404319552844595 d = 0.3.denominator #=> 18014398509481984 n.fdiv(d) #=> 0.3 See also Float#denominator. @overload numerator @return [Integer];T;0; @Ž;!F;"o;#;$T;%i;&i);'@æœ;(I"½VALUE rb_float_numerator(VALUE self) { double d = RFLOAT_VALUE(self); VALUE r; if (isinf(d) || isnan(d)) return self; r = float_to_r(self); return nurat_numerator(r); };T;)I" VALUE;T;*To;;F; ;;;;I"Float#denominator;F;[;[[@¨ i?;T;;I;0;[;{;IC;"lReturns the denominator (always positive). The result is machine dependent. See also Float#numerator. ;T;[o;= ;3I" overload;F;40;;I;50;)I"denominator;T;IC;";T; @©;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @©;[;I"@return [Integer];T;0;6i;[; @©;[;I"“Returns the denominator (always positive). The result is machine dependent. See also Float#numerator. @overload denominator @return [Integer];T;0; @©;!F;"o;#;$T;%i6;&i=;'@æœ;(I"ÇVALUE rb_float_denominator(VALUE self) { double d = RFLOAT_VALUE(self); VALUE r; if (isinf(d) || isnan(d)) return INT2FIX(1); r = float_to_r(self); return nurat_denominator(r); };T;)I" VALUE;T;*To;;F; ;;;;I"Float#to_r;F;[;[[@¨ i ;T;;P;0;[;{;IC;"Returns the value as a rational. 2.0.to_r #=> (2/1) 2.5.to_r #=> (5/2) -0.75.to_r #=> (-3/4) 0.0.to_r #=> (0/1) 0.3.to_r #=> (5404319552844595/18014398509481984) 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. 0.3.to_r == 3/10r #=> false "0.3".to_r == 3/10r #=> true See also Float#rationalize. ;T;[o;= ;3I" overload;F;40;;P;50;)I" to_r;T;IC;";T; @Ä;>0;!F;[;[;I";T;0;6i;[; @Ä;[;I"¡Returns the value as a rational. 2.0.to_r #=> (2/1) 2.5.to_r #=> (5/2) -0.75.to_r #=> (-3/4) 0.0.to_r #=> (0/1) 0.3.to_r #=> (5404319552844595/18014398509481984) 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. 0.3.to_r == 3/10r #=> false "0.3".to_r == 3/10r #=> true See also Float#rationalize. @overload to_r;T;0; @Ä;!F;"o;#;$T;%iŒ;&i;'@æœ;(I"Þstatic VALUE float_to_r(VALUE self) { VALUE f; int n; float_decode_internal(self, &f, &n); #if FLT_RADIX == 2 if (n == 0) return rb_rational_new1(f); if (n > 0) return rb_rational_new1(rb_int_lshift(f, INT2FIX(n))); n = -n; return rb_rational_new2(f, rb_int_lshift(ONE, INT2FIX(n))); #else f = rb_int_mul(f, rb_int_pow(INT2FIX(FLT_RADIX), n)); if (RB_TYPE_P(f, T_RATIONAL)) return f; return rb_rational_new1(f); #endif };T;)I"static VALUE;T;*To;;F; ;;;;I"Float#rationalize;F;[[@c0;[[@¨ iõ;T;;Q;0;[;{;IC;"/Returns a simpler approximation of the value (flt-|eps| <= result <= flt+|eps|). If the optional argument +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 also Float#to_r. ;T;[o;= ;3I" overload;F;40;;Q;50;)I"rationalize([eps]);T;IC;";T; @Ú;>0;!F;[;[;I";T;0;6i;[[I" [eps];T0; @Ú;[;I"NReturns a simpler approximation of the value (flt-|eps| <= result <= flt+|eps|). If the optional argument +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 also Float#to_r. @overload rationalize([eps]);T;0; @Ú;!F;"o;#;$T;%iç;&iò;'@æœ;(I"¨static VALUE float_rationalize(int argc, VALUE *argv, VALUE self) { double d = RFLOAT_VALUE(self); VALUE rat; int neg = d < 0.0; if (neg) self = DBL2NUM(-d); if (rb_check_arity(argc, 0, 1)) { rat = rb_flt_rationalize_with_prec(self, argv[0]); } else { rat = rb_flt_rationalize(self); } if (neg) RATIONAL_SET_NUM(rat, rb_int_uminus(RRATIONAL(rat)->num)); return rat; };T;)I"static VALUE;T;*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â;'@æœ;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è;'@æœ;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ï;'@æœ;I"Float::DIG;F;~I"INT2FIX(DBL_DIG);To;{;[[@ïiø;F;:MIN_EXP;;};;;[;{;IC;"kThe smallest possible exponent value in a double-precision floating point. Usually defaults to -1021. ;T;[;[;I"lThe smallest possible exponent value in a double-precision floating point. Usually defaults to -1021. ;T;0; @ž;!F;"o;#;$T;%iò;&iö;'@æœ;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ý;'@æœ;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;'@æœ;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;'@æœ;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; @Gž;!F;"o;#;$T;%i;&i;'@æœ;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; @Sž;!F;"o;#;$T;%i;&i;'@æœ;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; @_ž;!F;"o;#;$T;%i;&i#;'@æœ;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; @kž;!F;"o;#;$T;%i&;&i';'@æœ;I"Float::INFINITY;F;~I"DBL2NUM(HUGE_VAL);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; @wž;!F;"o;#;$T;%i*;&i+;'@æœ;I"Float::NAN;F;~I"DBL2NUM(nan(""));To;;F; ;;;;I"Float#to_s;F;[;[[@ïi¬;T;;q;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;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @ƒž;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ƒž;[;I"@return [String];T;0;6i;[; @ƒž;[;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;[;[[@ïi0;F;;r;;K;[;{;@Šž;'@æœ;)I"static VALUE;T;(I"ýstatic 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)) { static const char minf[] = "-Infinity"; const int pos = (value > 0); /* skip "-" */ return rb_usascii_str_new(minf+pos, strlen(minf)-pos); } 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 { goto exp; } return s; 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©;'@æœ;(I"ýstatic 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)) { static const char minf[] = "-Infinity"; const int pos = (value > 0); /* skip "-" */ return rb_usascii_str_new(minf+pos, strlen(minf)-pos); } 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 { goto exp; } return s; 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;)@¢ž;*T@›žo;;F; ;;;;I"Float#coerce;F;[[I"y;T0;[[@ïi;T;;>;0;[;{;IC;"ÑReturns an array with both +numeric+ and +float+ represented as Float objects. This is achieved by converting +numeric+ to a Float. 1.2.coerce(3) #=> [3.0, 1.2] 2.5.coerce(1.1) #=> [1.1, 2.5] ;T;[o;= ;3I" overload;F;40;;>;50;)I"coerce(numeric);T;IC;";T; @¦ž;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @¦ž;[;I"@return [Array];T;0;6i;[[I"numeric;T0; @¦ž;[;I"ÿReturns an array with both +numeric+ and +float+ represented as Float objects. This is achieved by converting +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;'@æœ;(I"[static VALUE flo_coerce(VALUE x, VALUE y) { return rb_assoc_new(rb_Float(y), x); };T;)I"static VALUE;T;*To;;F; ;;;;I" Float#-@;F;[;[[@ïi;T;;9;0;[;{;IC;"Returns +float+, negated. ;T;[o;= ;3I" overload;F;40;;;50;)I"-float;T;IC;";T; @Åž;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @Åž;[;I"@return [Float];T;0;6i;[; @Åž;[;I"CReturns +float+, negated. @overload -float @return [Float];T;0; @Åž;!F;"o;#;$T;%i ;&i ;'@æœ;(I"QVALUE rb_float_uminus(VALUE flt) { return DBL2NUM(-RFLOAT_VALUE(flt)); };T;)I" VALUE;T;*To;;F; ;;;;I"Float#+;F;[[I"y;T0;[[@ïi;T;;&;0;[;{;IC;"AReturns a new Float which is the sum of +float+ and +other+. ;T;[o;= ;3I" overload;F;40;;&;50;)I" +(other);T;IC;";T; @àž;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @àž;[;I"@return [Float];T;0;6i;[[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;&i;'@æœ;(I"VALUE rb_float_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;)I" VALUE;T;*To;;F; ;;;;I"Float#-;F;[[I"y;T0;[[@ïi5;T;;;0;[;{;IC;"HReturns a new Float which is the difference of +float+ and +other+. ;T;[o;= ;3I" overload;F;40;;;50;)I" -(other);T;IC;";T; @ÿž;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @ÿž;[;I"@return [Float];T;0;6i;[[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;%i.;&i2;'@æœ;(I"€VALUE rb_float_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;)I" VALUE;T;*To;;F; ;;;;I"Float#*;F;[[I"y;T0;[[@ïiM;T;;';0;[;{;IC;"EReturns a new Float which is the product of +float+ and +other+. ;T;[o;= ;3I" overload;F;40;;';50;)I" *(other);T;IC;";T; @Ÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @Ÿ;[;I"@return [Float];T;0;6i;[[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;%iF;&iJ;'@æœ;(I"~VALUE rb_float_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;)I" VALUE;T;*To;;F; ;;;;I"Float#/;F;[[I"y;T0;[[@ïiƒ;T;;:;0;[;{;IC;"LReturns a new Float which is the result of dividing +float+ by +other+. ;T;[o;= ;3I" overload;F;40;;:;50;)I" /(other);T;IC;";T; @=Ÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @=Ÿ;[;I"@return [Float];T;0;6i;[[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;%i|;&i€;'@æœ;(I"»VALUE rb_float_div(VALUE x, VALUE y) { double num = RFLOAT_VALUE(x); double den; double ret; if (RB_TYPE_P(y, T_FIXNUM)) { den = FIX2LONG(y); } else if (RB_TYPE_P(y, T_BIGNUM)) { den = rb_big2dbl(y); } else if (RB_TYPE_P(y, T_FLOAT)) { den = RFLOAT_VALUE(y); } else { return rb_num_coerce_bin(x, y, '/'); } ret = double_div_double(num, den); return DBL2NUM(ret); };T;)I" VALUE;T;*To;;F; ;;;;I"Float#quo;F;[[I"y;T0;[[@ïi£;T;;;;0;[;{;IC;";Returns float / numeric, same as Float#/. ;T;[o;= ;3I" overload;F;40;;<;50;)I"fdiv(numeric);T;IC;";T; @\Ÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @\Ÿ;[;I"@return [Float];T;0;6i;[[I"numeric;T0; @\Ÿo;= ;3I" overload;F;40;;;;50;)I"quo(numeric);T;IC;";T; @\Ÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @\Ÿ;[;I"@return [Float];T;0;6i;[[I"numeric;T0; @\Ÿ;[;I"‹Returns float / numeric, same as Float#/. @overload fdiv(numeric) @return [Float] @overload quo(numeric) @return [Float];T;0; @\Ÿ;!F;"o;#;$T;%i›;&i¡;'@æœ;(I"Sstatic VALUE flo_quo(VALUE x, VALUE y) { return num_funcall1(x, '/', y); };T;)I"static VALUE;T;*To;;F; ;;;;I"Float#fdiv;F;[[I"y;T0;[[@ïi£;T;;<;0;[;{;IC;";Returns float / numeric, same as Float#/. ;T;[o;= ;3I" overload;F;40;;<;50;)I"fdiv(numeric);T;IC;";T; @ŠŸ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @ŠŸ;[;I"@return [Float];T;0;6i;[[I"numeric;T0; @ŠŸo;= ;3I" overload;F;40;;;;50;)I"quo(numeric);T;IC;";T; @ŠŸ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @ŠŸ;[;I"@return [Float];T;0;6i;[[I"numeric;T0; @ŠŸ;[;@†Ÿ;0; @ŠŸ;!F;"o;#;$T;%i›;&i¡;'@æœ;(I"Sstatic VALUE flo_quo(VALUE x, VALUE y) { return num_funcall1(x, '/', y); };T;)I"static VALUE;T;*To;;F; ;;;;I"Float#%;F;[[I"y;T0;[[@ïiç;T;;Û;0;[;{;IC;"žReturns the modulo after division of +float+ by +other+. 6543.21.modulo(137) #=> 104.21000000000004 6543.21.modulo(137.24) #=> 92.92999999999961 ;T;[o;= ;3I" overload;F;40;;Û;50;)I" %(other);T;IC;";T; @·Ÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @·Ÿ;[;I"@return [Float];T;0;6i;[[I" other;T0; @·Ÿo;= ;3I" overload;F;40;;Z;50;)I"modulo(other);T;IC;";T; @·Ÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @·Ÿ;[;I"@return [Float];T;0;6i;[[I" other;T0; @·Ÿ;[;I"ïReturns the modulo after division of +float+ by +other+. 6543.21.modulo(137) #=> 104.21000000000004 6543.21.modulo(137.24) #=> 92.92999999999961 @overload %(other) @return [Float] @overload modulo(other) @return [Float];T;0; @·Ÿ;!F;"o;#;$T;%iÜ;&iå;'@æœ;(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;)I"static VALUE;T;*To;;F; ;;;;I"Float#modulo;F;[[I"y;T0;[[@ïiç;T;;Z;0;[;{;IC;"žReturns the modulo after division of +float+ by +other+. 6543.21.modulo(137) #=> 104.21000000000004 6543.21.modulo(137.24) #=> 92.92999999999961 ;T;[o;= ;3I" overload;F;40;;Û;50;)I" %(other);T;IC;";T; @åŸ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @åŸ;[;I"@return [Float];T;0;6i;[[I" other;T0; @åŸo;= ;3I" overload;F;40;;Z;50;)I"modulo(other);T;IC;";T; @åŸ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @åŸ;[;I"@return [Float];T;0;6i;[[I" other;T0; @åŸ;[;@áŸ;0; @åŸ;!F;"o;#;$T;%iÜ;&iå;'@æœ;(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;)I"static VALUE;T;*To;;F; ;;;;I"Float#divmod;F;[[I"y;T0;[[@ïi;T;;Y;0;[;{;IC;"[See Numeric#divmod. 42.0.divmod(6) #=> [7, 0.0] 42.0.divmod(5) #=> [8, 2.0] ;T;[o;= ;3I" overload;F;40;;Y;50;)I"divmod(numeric);T;IC;";T; @ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ ;[;I"@return [Array];T;0;6i;[[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;'@æœ;(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;)I"static VALUE;T;*To;;F; ;;;;I" Float#**;F;[[I"y;T0;[[@ïi/;T;;=;0;[;{;IC;"ARaises +float+ to the power of +other+. 2.0**3 #=> 8.0 ;T;[o;= ;3I" overload;F;40;;=;50;)I"**(other);T;IC;";T; @1 ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @1 ;[;I"@return [Float];T;0;6i;[[I" other;T0; @1 ;[;I"iRaises +float+ to the power of +other+. 2.0**3 #=> 8.0 @overload **(other) @return [Float];T;0; @1 ;!F;"o;#;$T;%i&;&i,;'@æœ;(I"bVALUE rb_float_pow(VALUE x, VALUE y) { double dx, dy; if (y == INT2FIX(2)) { dx = RFLOAT_VALUE(x); return DBL2NUM(dx * dx); } else 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_dbl_complex_new_polar_pi(pow(-dx, dy), dy); } else { return rb_num_coerce_bin(x, y, idPow); } return DBL2NUM(pow(dx, dy)); };T;)I" VALUE;T;*To;;F; ;;;;I" Float#==;F;[;[;F;;`;;K;[;{;IC;";T;[;[;@|;0; @P ;'@æœ;*To;;F; ;;;;I"Float#===;F;[;[;F;;\;;K;[;{;IC;";T;[;[;@|;0; @Y ;'@æœ;*To;;F; ;;;;I"Float#<=>;F;[[I"y;T0;[[@ïiÐ;T;;c;0;[;{;IC;":Returns -1, 0, or +1 depending on whether +float+ is less than, equal to, or greater than +real+. This is the basis for the tests in the Comparable module. The result of NaN <=> NaN is undefined, so an implementation-dependent value is returned. +nil+ is returned if the two values are incomparable. ;T;[o;= ;3I" overload;F;40;;c;50;)I"<=>(real);T;IC;";T; @b ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[ I"-1;TI"0;TI"+1;TI"nil;T; @b ;[;I" @return [ -1, 0, +1, nil];T;0;6i;[[I" real;T0; @b ;[;I"nReturns -1, 0, or +1 depending on whether +float+ is less than, equal to, or greater than +real+. This is the basis for the tests in the Comparable module. The result of NaN <=> NaN is undefined, so an implementation-dependent value is returned. +nil+ is returned if the two values are incomparable. @overload <=>(real) @return [ -1, 0, +1, nil];T;0; @b ;!F;"o;#;$T;%iÂ;&iÍ;'@æœ;(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 LONG2FIX(-FIX2LONG(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;)I"static VALUE;T;*To;;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 an implementation-dependent value is returned. ;T;[o;= ;3I" overload;F;40;;;50;)I">(real);T;IC;";T; @„ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @„ ;[;I"@return [Boolean];T;0;6i;[[I" real;T0; @„ ;[;I"¿Returns +true+ if +float+ is greater than +real+. The result of NaN > NaN is undefined, so an implementation-dependent value is returned. @overload >(real) @return [Boolean];T;0; @„ ;!F;"o;#;$T;%iö;&iý;'@æœ;(I"QVALUE rb_float_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 -FIX2LONG(rel) > 0 ? Qtrue : Qfalse; return Qfalse; } else if (RB_TYPE_P(y, T_FLOAT)) { b = RFLOAT_VALUE(y); #if MSC_VERSION_BEFORE(1300) if (isnan(b)) return Qfalse; #endif } else { return rb_num_coerce_relop(x, y, '>'); } #if MSC_VERSION_BEFORE(1300) if (isnan(a)) return Qfalse; #endif return (a > b)?Qtrue:Qfalse; };T;)I" VALUE;T;*To;;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 an implementation-dependent value is returned. ;T;[o;= ;3I" overload;F;40;;‚;50;)I" >=(real);T;IC;";T; @£ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @£ ;[;I"@return [Boolean];T;0;6i;[[I" real;T0; @£ ;[;I"ÍReturns +true+ if +float+ is greater than or equal to +real+. The result of NaN >= NaN is undefined, so an implementation-dependent value is returned. @overload >=(real) @return [Boolean];T;0; @£ ;!F;"o;#;$T;%i;&i";'@æœ;(I"Vstatic 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 -FIX2LONG(rel) >= 0 ? Qtrue : Qfalse; return Qfalse; } else if (RB_TYPE_P(y, T_FLOAT)) { b = RFLOAT_VALUE(y); #if MSC_VERSION_BEFORE(1300) if (isnan(b)) return Qfalse; #endif } else { return rb_num_coerce_relop(x, y, idGE); } #if MSC_VERSION_BEFORE(1300) if (isnan(a)) return Qfalse; #endif return (a >= b)?Qtrue:Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Float#<;F;[[I"y;T0;[[@ïiJ;T;;;0;[;{;IC;"”Returns +true+ if +float+ is less than +real+. The result of NaN < NaN is undefined, so an implementation-dependent value is returned. ;T;[o;= ;3I" overload;F;40;;;50;)I"<(real);T;IC;";T; @Â ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Â ;[;I"@return [Boolean];T;0;6i;[[I" real;T0; @Â ;[;I"¼Returns +true+ if +float+ is less than +real+. The result of NaN < NaN is undefined, so an implementation-dependent value is returned. @overload <(real) @return [Boolean];T;0; @Â ;!F;"o;#;$T;%i@;&iG;'@æœ;(I"Sstatic 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 -FIX2LONG(rel) < 0 ? Qtrue : Qfalse; return Qfalse; } else if (RB_TYPE_P(y, T_FLOAT)) { b = RFLOAT_VALUE(y); #if MSC_VERSION_BEFORE(1300) if (isnan(b)) return Qfalse; #endif } else { return rb_num_coerce_relop(x, y, '<'); } #if MSC_VERSION_BEFORE(1300) if (isnan(a)) return Qfalse; #endif return (a < b)?Qtrue:Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I" Float#<=;F;[[I"y;T0;[[@ïio;T;;€;0;[;{;IC;"¡Returns +true+ if +float+ is less than or equal to +real+. The result of NaN <= NaN is undefined, so an implementation-dependent value is returned. ;T;[o;= ;3I" overload;F;40;;€;50;)I" <=(real);T;IC;";T; @á ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @á ;[;I"@return [Boolean];T;0;6i;[[I" real;T0; @á ;[;I"ÊReturns +true+ if +float+ is less than or equal to +real+. The result of NaN <= NaN is undefined, so an implementation-dependent value is returned. @overload <=(real) @return [Boolean];T;0; @á ;!F;"o;#;$T;%ie;&il;'@æœ;(I"Vstatic 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 -FIX2LONG(rel) <= 0 ? Qtrue : Qfalse; return Qfalse; } else if (RB_TYPE_P(y, T_FLOAT)) { b = RFLOAT_VALUE(y); #if MSC_VERSION_BEFORE(1300) if (isnan(b)) return Qfalse; #endif } else { return rb_num_coerce_relop(x, y, idLE); } #if MSC_VERSION_BEFORE(1300) if (isnan(a)) return Qfalse; #endif return (a <= b)?Qtrue:Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Float#eql?;F;[;[;F;;_;;K;[;{;IC;";T;[o;2 ;3I"return;F;4@|;0;5[@~; @¡;[;@|;0; @¡;6i;'@æœ;*To;;F; ;;;;I"Float#hash;F;[;[[@ïi¬;T;;b;0;[;{;IC;"?Returns a hash code for this float. See also Object#hash. ;T;[o;= ;3I" overload;F;40;;b;50;)I" hash;T;IC;";T; @¡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¡;[;I"@return [Integer];T;0;6i;[; @¡;[;I"dReturns a hash code for this float. See also Object#hash. @overload hash @return [Integer];T;0; @¡;!F;"o;#;$T;%i£;&i©;'@æœ;(I"Tstatic VALUE flo_hash(VALUE num) { return rb_dbl_hash(RFLOAT_VALUE(num)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Float#to_f;F;[;[[@ïi¯;T;;O;0;[;{;IC;"6Since +float+ is already a Float, returns +self+. ;T;[o;= ;3I" overload;F;40;;O;50;)I" to_f;T;IC;";T; @'¡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @'¡;[;I"@return [self];T;0;6i;[; @'¡;[;I"XSince +float+ is already a Float, returns +self+. @overload to_f @return [self];T;0; @'¡;!F;"o;#;$T;%i¨;&i¬;'@æœ;(I"9static VALUE flo_to_f(VALUE num) { return num; };T;)I"static VALUE;T;*To;;F; ;;;;I"Float#abs;F;[;[[@ïiÃ;T;;?;0;[;{;IC;"§Returns the absolute value of +float+. (-34.56).abs #=> 34.56 -34.56.abs #=> 34.56 34.56.abs #=> 34.56 Float#magnitude is an alias for Float#abs. ;T;[o;= ;3I" overload;F;40;;?;50;)I"abs;T;IC;";T; @B¡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @B¡;[;I"@return [Float];T;0;6i;[; @B¡o;= ;3I" overload;F;40;;@;50;)I"magnitude;T;IC;";T; @B¡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @B¡;[;I"@return [Float];T;0;6i;[; @B¡;[;I"ïReturns the absolute value of +float+. (-34.56).abs #=> 34.56 -34.56.abs #=> 34.56 34.56.abs #=> 34.56 Float#magnitude is an alias for Float#abs. @overload abs @return [Float] @overload magnitude @return [Float];T;0; @B¡;!F;"o;#;$T;%iµ;&iÁ;'@æœ;(I"iVALUE rb_float_abs(VALUE flt) { double val = fabs(RFLOAT_VALUE(flt)); return DBL2NUM(val); };T;)I" VALUE;T;*To;;F; ;;;;I"Float#magnitude;F;[;[[@ïiÃ;T;;@;0;[;{;IC;"§Returns the absolute value of +float+. (-34.56).abs #=> 34.56 -34.56.abs #=> 34.56 34.56.abs #=> 34.56 Float#magnitude is an alias for Float#abs. ;T;[o;= ;3I" overload;F;40;;?;50;)I"abs;T;IC;";T; @j¡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @j¡;[;I"@return [Float];T;0;6i;[; @j¡o;= ;3I" overload;F;40;;@;50;)I"magnitude;T;IC;";T; @j¡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @j¡;[;I"@return [Float];T;0;6i;[; @j¡;[;@f¡;0; @j¡;!F;"o;#;$T;%iµ;&iÁ;'@æœ;(I"iVALUE rb_float_abs(VALUE flt) { double val = fabs(RFLOAT_VALUE(flt)); return DBL2NUM(val); };T;)I" VALUE;T;*To;;F; ;;;;I"Float#zero?;F;[;[[@ïiÑ;T;;^;0;[;{;IC;"&Returns +true+ if +float+ is 0.0.;T;[o;= ;3I" overload;F;40;;^;50;)I" zero?;T;IC;";T; @‘¡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @‘¡;[;I"@return [Boolean];T;0;6i;[; @‘¡;[;I"LReturns +true+ if +float+ is 0.0. @overload zero? @return [Boolean];T;0; @‘¡;!F;"o;#;$T;%iÊ;&iÎ;6i;'@æœ;(I"Xstatic VALUE flo_zero_p(VALUE num) { return flo_iszero(num) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Float#to_i;F;[;[[@ïi] ;T;;–;0;[;{;IC;"ûReturns the +float+ truncated to an Integer. 1.2.to_i #=> 1 (-1.2).to_i #=> -1 Note that the limited precision of floating point arithmetic might lead to surprising results: (0.3 / 0.1).to_i #=> 2 (!) #to_int is an alias for #to_i. ;T;[o;= ;3I" overload;F;40;;–;50;)I" to_i;T;IC;";T; @¬¡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¬¡;[;I"@return [Integer];T;0;6i;[; @¬¡o;= ;3I" overload;F;40;;\;50;)I"to_int;T;IC;";T; @¬¡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¬¡;[;I"@return [Integer];T;0;6i;[; @¬¡;[;I"EReturns the +float+ truncated to an Integer. 1.2.to_i #=> 1 (-1.2).to_i #=> -1 Note that the limited precision of floating point arithmetic might lead to surprising results: (0.3 / 0.1).to_i #=> 2 (!) #to_int is an alias for #to_i. @overload to_i @return [Integer] @overload to_int @return [Integer];T;0; @¬¡;!F;"o;#;$T;%iK ;&i[ ;'@æœ;(I"static VALUE flo_to_i(VALUE num) { double f = RFLOAT_VALUE(num); if (f > 0.0) f = floor(f); if (f < 0.0) f = ceil(f); return dbl2ival(f); };T;)I"static VALUE;T;*To;;F; ;;;;I"Float#to_int;F;[;[[@ïi] ;T;;\;0;[;{;IC;"ûReturns the +float+ truncated to an Integer. 1.2.to_i #=> 1 (-1.2).to_i #=> -1 Note that the limited precision of floating point arithmetic might lead to surprising results: (0.3 / 0.1).to_i #=> 2 (!) #to_int is an alias for #to_i. ;T;[o;= ;3I" overload;F;40;;–;50;)I" to_i;T;IC;";T; @Ô¡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ô¡;[;I"@return [Integer];T;0;6i;[; @Ô¡o;= ;3I" overload;F;40;;\;50;)I"to_int;T;IC;";T; @Ô¡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ô¡;[;I"@return [Integer];T;0;6i;[; @Ô¡;[;@Ð¡;0; @Ô¡;!F;"o;#;$T;%iK ;&i[ ;'@æœ;(I"static VALUE flo_to_i(VALUE num) { double f = RFLOAT_VALUE(num); if (f > 0.0) f = floor(f); if (f < 0.0) f = ceil(f); return dbl2ival(f); };T;)I"static VALUE;T;*To;;F; ;;;;I"Float#floor;F;[[@c0;[[@ïiÎ;T;;`;0;[;{;IC;"àReturns the largest number less than or equal to +float+ with a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns a floating point number when +ndigits+ is positive, otherwise returns an integer. 1.2.floor #=> 1 2.0.floor #=> 2 (-1.2).floor #=> -2 (-2.0).floor #=> -2 1.234567.floor(2) #=> 1.23 1.234567.floor(3) #=> 1.234 1.234567.floor(4) #=> 1.2345 1.234567.floor(5) #=> 1.23456 34567.89.floor(-5) #=> 0 34567.89.floor(-4) #=> 30000 34567.89.floor(-3) #=> 34000 34567.89.floor(-2) #=> 34500 34567.89.floor(-1) #=> 34560 34567.89.floor(0) #=> 34567 34567.89.floor(1) #=> 34567.8 34567.89.floor(2) #=> 34567.89 34567.89.floor(3) #=> 34567.89 Note that the limited precision of floating point arithmetic might lead to surprising results: (0.3 / 0.1).floor #=> 2 (!) ;T;[o;= ;3I" overload;F;40;;`;50;)I"floor([ndigits]);T;IC;";T; @û¡;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI" Float;T; @û¡;[;I"@return [Integer, Float];T;0;6i;[[I"[ndigits];T0; @û¡;[;I"Returns the largest number less than or equal to +float+ with a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns a floating point number when +ndigits+ is positive, otherwise returns an integer. 1.2.floor #=> 1 2.0.floor #=> 2 (-1.2).floor #=> -2 (-2.0).floor #=> -2 1.234567.floor(2) #=> 1.23 1.234567.floor(3) #=> 1.234 1.234567.floor(4) #=> 1.2345 1.234567.floor(5) #=> 1.23456 34567.89.floor(-5) #=> 0 34567.89.floor(-4) #=> 30000 34567.89.floor(-3) #=> 34000 34567.89.floor(-2) #=> 34500 34567.89.floor(-1) #=> 34560 34567.89.floor(0) #=> 34567 34567.89.floor(1) #=> 34567.8 34567.89.floor(2) #=> 34567.89 34567.89.floor(3) #=> 34567.89 Note that the limited precision of floating point arithmetic might lead to surprising results: (0.3 / 0.1).floor #=> 2 (!) @overload floor([ndigits]) @return [Integer, Float];T;0; @û¡;!F;"o;#;$T;%i§;&iË;'@æœ;(I"Ãstatic VALUE flo_floor(int argc, VALUE *argv, VALUE num) { int ndigits = 0; if (rb_check_arity(argc, 0, 1)) { ndigits = NUM2INT(argv[0]); } return rb_float_floor(num, ndigits); };T;)I"static VALUE;T;*To;;F; ;;;;I"Float#ceil;F;[[@c0;[[@ïiÿ;T;;a;0;[;{;IC;"×Returns the smallest number greater than or equal to +float+ with a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns a floating point number when +ndigits+ is positive, otherwise returns an integer. 1.2.ceil #=> 2 2.0.ceil #=> 2 (-1.2).ceil #=> -1 (-2.0).ceil #=> -2 1.234567.ceil(2) #=> 1.24 1.234567.ceil(3) #=> 1.235 1.234567.ceil(4) #=> 1.2346 1.234567.ceil(5) #=> 1.23457 34567.89.ceil(-5) #=> 100000 34567.89.ceil(-4) #=> 40000 34567.89.ceil(-3) #=> 35000 34567.89.ceil(-2) #=> 34600 34567.89.ceil(-1) #=> 34570 34567.89.ceil(0) #=> 34568 34567.89.ceil(1) #=> 34567.9 34567.89.ceil(2) #=> 34567.89 34567.89.ceil(3) #=> 34567.89 Note that the limited precision of floating point arithmetic might lead to surprising results: (2.1 / 0.7).ceil #=> 4 (!) ;T;[o;= ;3I" overload;F;40;;a;50;)I"ceil([ndigits]);T;IC;";T; @¢;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI" Float;T; @¢;[;I"@return [Integer, Float];T;0;6i;[[I"[ndigits];T0; @¢;[;I"Returns the smallest number greater than or equal to +float+ with a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns a floating point number when +ndigits+ is positive, otherwise returns an integer. 1.2.ceil #=> 2 2.0.ceil #=> 2 (-1.2).ceil #=> -1 (-2.0).ceil #=> -2 1.234567.ceil(2) #=> 1.24 1.234567.ceil(3) #=> 1.235 1.234567.ceil(4) #=> 1.2346 1.234567.ceil(5) #=> 1.23457 34567.89.ceil(-5) #=> 100000 34567.89.ceil(-4) #=> 40000 34567.89.ceil(-3) #=> 35000 34567.89.ceil(-2) #=> 34600 34567.89.ceil(-1) #=> 34570 34567.89.ceil(0) #=> 34568 34567.89.ceil(1) #=> 34567.9 34567.89.ceil(2) #=> 34567.89 34567.89.ceil(3) #=> 34567.89 Note that the limited precision of floating point arithmetic might lead to surprising results: (2.1 / 0.7).ceil #=> 4 (!) @overload ceil([ndigits]) @return [Integer, Float];T;0; @¢;!F;"o;#;$T;%iØ;&iü;'@æœ;(I"Âstatic VALUE flo_ceil(int argc, VALUE *argv, VALUE num) { int ndigits = 0; if (rb_check_arity(argc, 0, 1)) { ndigits = NUM2INT(argv[0]); } return rb_float_ceil(num, ndigits); };T;)I"static VALUE;T;*To;;F; ;;;;I"Float#round;F;[[@c0;[[@ïi ;T;;b;0;[;{;IC;"ñReturns +float+ rounded to the nearest value with a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns a floating point number when +ndigits+ is positive, otherwise returns an integer. 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 If the optional +half+ keyword argument is given, numbers that are half-way between two possible rounded values will be rounded according to the specified tie-breaking +mode+: * :up or +nil+: round half away from zero (default) * :down: round half toward zero * :even: round half toward the nearest even number 2.5.round(half: :up) #=> 3 2.5.round(half: :down) #=> 2 2.5.round(half: :even) #=> 2 3.5.round(half: :up) #=> 4 3.5.round(half: :down) #=> 3 3.5.round(half: :even) #=> 4 (-2.5).round(half: :up) #=> -3 (-2.5).round(half: :down) #=> -2 (-2.5).round(half: :even) #=> -2 ;T;[o;= ;3I" overload;F;40;;b;50;)I"$round([ndigits] [, half: mode]);T;IC;";T; @9¢;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI" Float;T; @9¢;[;I"@return [Integer, Float];T;0;6i;[[I"[ndigits][, half:;TI" mode];T; @9¢;[;I"8Returns +float+ rounded to the nearest value with a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns a floating point number when +ndigits+ is positive, otherwise returns an integer. 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 If the optional +half+ keyword argument is given, numbers that are half-way between two possible rounded values will be rounded according to the specified tie-breaking +mode+: * :up or +nil+: round half away from zero (default) * :down: round half toward zero * :even: round half toward the nearest even number 2.5.round(half: :up) #=> 3 2.5.round(half: :down) #=> 2 2.5.round(half: :even) #=> 2 3.5.round(half: :up) #=> 4 3.5.round(half: :down) #=> 3 3.5.round(half: :even) #=> 4 (-2.5).round(half: :up) #=> -3 (-2.5).round(half: :down) #=> -2 (-2.5).round(half: :even) #=> -2 @overload round([ndigits] [, half: mode]) @return [Integer, Float];T;0; @9¢;!F;"o;#;$T;%iÏ;&i ;'@æœ;(I"rstatic VALUE flo_round(int argc, VALUE *argv, VALUE num) { double number, f, x; VALUE nd, opt; int ndigits = 0; enum ruby_num_rounding_mode mode; if (rb_scan_args(argc, argv, "01:", &nd, &opt)) { ndigits = NUM2INT(nd); } mode = rb_num_get_rounding_option(opt); number = RFLOAT_VALUE(num); if (number == 0.0) { return ndigits > 0 ? DBL2NUM(number) : INT2FIX(0); } if (ndigits < 0) { return rb_int_round(flo_to_i(num), ndigits, mode); } if (ndigits == 0) { x = ROUND_CALL(mode, round, (number, 1.0)); return dbl2ival(x); } if (isfinite(number)) { int binexp; frexp(number, &binexp); if (float_round_overflow(ndigits, binexp)) return num; if (float_round_underflow(ndigits, binexp)) return DBL2NUM(0); f = pow(10, ndigits); x = ROUND_CALL(mode, round, (number, f)); return DBL2NUM(x / f); } return num; };T;)I"static VALUE;T;*To;;F; ;;;;I"Float#truncate;F;[[@c0;[[@ïi ;T;;c;0;[;{;IC;"AReturns +float+ truncated (toward zero) to a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns a floating point number when +ndigits+ is positive, otherwise returns an integer. 2.8.truncate #=> 2 (-2.8).truncate #=> -2 1.234567.truncate(2) #=> 1.23 34567.89.truncate(-2) #=> 34500 Note that the limited precision of floating point arithmetic might lead to surprising results: (0.3 / 0.1).truncate #=> 2 (!) ;T;[o;= ;3I" overload;F;40;;c;50;)I"truncate([ndigits]);T;IC;";T; @Y¢;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI" Float;T; @Y¢;[;I"@return [Integer, Float];T;0;6i;[[I"[ndigits];T0; @Y¢;[;I"|Returns +float+ truncated (toward zero) to a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns a floating point number when +ndigits+ is positive, otherwise returns an integer. 2.8.truncate #=> 2 (-2.8).truncate #=> -2 1.234567.truncate(2) #=> 1.23 34567.89.truncate(-2) #=> 34500 Note that the limited precision of floating point arithmetic might lead to surprising results: (0.3 / 0.1).truncate #=> 2 (!) @overload truncate([ndigits]) @return [Integer, Float];T;0; @Y¢;!F;"o;#;$T;%ih ;&i} ;'@æœ;(I"³static VALUE flo_truncate(int argc, VALUE *argv, VALUE num) { if (signbit(RFLOAT_VALUE(num))) return flo_ceil(argc, argv, num); else return flo_floor(argc, argv, num); };T;)I"static VALUE;T;*To;;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;= ;3I" overload;F;40;;Í;50;)I" nan?;T;IC;";T; @x¢;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @x¢;[;I"@return [Boolean];T;0;6i;[; @x¢;[;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; @x¢;!F;"o;#;$T;%i×;&ià;6i;'@æœ;(I"~static VALUE flo_is_nan_p(VALUE num) { double value = RFLOAT_VALUE(num); return isnan(value) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Float#infinite?;F;[;[[@ïi÷;T;;K;0;[;{;IC;"ØReturns +nil+, -1, or 1 depending on whether the value is finite, -Infinity, or +Infinity. (0.0).infinite? #=> nil (-1.0/0.0).infinite? #=> -1 (+1.0/0.0).infinite? #=> 1;T;[o;= ;3I" overload;F;40;;K;50;)I"infinite?;T;IC;";T; @“¢;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"-1;TI"1;TI"nil;T; @“¢;[;I"@return [ -1, 1, nil];T;0;6i;[; @“¢;[;I"Returns +nil+, -1, or 1 depending on whether the value is finite, -Infinity, or +Infinity. (0.0).infinite? #=> nil (-1.0/0.0).infinite? #=> -1 (+1.0/0.0).infinite? #=> 1 @overload infinite? @return [ -1, 1, nil];T;0; @“¢;!F;"o;#;$T;%ië;&iô;6i;'@æœ;(I"§VALUE rb_flo_is_infinite_p(VALUE num) { double value = RFLOAT_VALUE(num); if (isinf(value)) { return INT2FIX( value < 0 ? -1 : 1 ); } return Qnil; };T;)I" VALUE;T;*To;;F; ;;;;I"Float#finite?;F;[;[[@ïi;T;;J;0;[;{;IC;"xReturns +true+ if +float+ is a valid IEEE floating point number, i.e. it is not infinite and Float#nan? is +false+.;T;[o;= ;3I" overload;F;40;;J;50;)I"finite?;T;IC;";T; @°¢;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @°¢;[;I"@return [Boolean];T;0;6i;[; @°¢;[;I"›Returns +true+ if +float+ is a valid IEEE floating point number, i.e. it is not infinite and Float#nan? is +false+. @overload finite? @return [Boolean];T;0; @°¢;!F;"o;#;$T;%i;&i;6i;'@æœ;(I"ãVALUE rb_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;)I" VALUE;T;*To;;F; ;;;;I"Float#next_float;F;[;[[@ïiX;T;:next_float;0;[;{;IC;"EReturns 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: 0.01.next_float #=> 0.010000000000000002 1.0.next_float #=> 1.0000000000000002 100.0.next_float #=> 100.00000000000001 0.01.next_float - 0.01 #=> 1.734723475976807e-18 1.0.next_float - 1.0 #=> 2.220446049250313e-16 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 } f #=> 9.99999999999998 # should be 10.0 in the ideal world. 10-f #=> 1.9539925233402755e-14 # the floating point error. 10.0.next_float-10 #=> 1.7763568394002505e-15 # 1 ulp (unit in the last place). (10-f)/(10.0.next_float-10) #=> 11.0 # the error is 11 ulp. (10-f)/(10*Float::EPSILON) #=> 8.8 # approximation of the above. "%a" % 10 #=> "0x1.4p+3" "%a" % f #=> "0x1.3fffffffffff5p+3" # the last hex digit is 5. 16 - 5 = 11 ulp. ;T;[o;= ;3I" overload;F;40;;Î;50;)I"next_float;T;IC;";T; @Ë¢;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @Ë¢;[;I"@return [Float];T;0;6i;[; @Ë¢;[;I"nReturns 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: 0.01.next_float #=> 0.010000000000000002 1.0.next_float #=> 1.0000000000000002 100.0.next_float #=> 100.00000000000001 0.01.next_float - 0.01 #=> 1.734723475976807e-18 1.0.next_float - 1.0 #=> 2.220446049250313e-16 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 } f #=> 9.99999999999998 # should be 10.0 in the ideal world. 10-f #=> 1.9539925233402755e-14 # the floating point error. 10.0.next_float-10 #=> 1.7763568394002505e-15 # 1 ulp (unit in the last place). (10-f)/(10.0.next_float-10) #=> 11.0 # the error is 11 ulp. (10-f)/(10*Float::EPSILON) #=> 8.8 # approximation of the above. "%a" % 10 #=> "0x1.4p+3" "%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$;&iV;'@æœ;(I"Vstatic VALUE flo_next_float(VALUE vx) { return flo_nextafter(vx, HUGE_VAL); };T;)I"static VALUE;T;*To;;F; ;;;;I"Float#prev_float;F;[;[[@ïiˆ;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: 0.01.prev_float #=> 0.009999999999999998 1.0.prev_float #=> 0.9999999999999999 100.0.prev_float #=> 99.99999999999999 0.01 - 0.01.prev_float #=> 1.734723475976807e-18 1.0 - 1.0.prev_float #=> 1.1102230246251565e-16 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;= ;3I" overload;F;40;;Ï;50;)I"prev_float;T;IC;";T; @æ¢;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @æ¢;[;I"@return [Float];T;0;6i;[; @æ¢;[;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: 0.01.prev_float #=> 0.009999999999999998 1.0.prev_float #=> 0.9999999999999999 100.0.prev_float #=> 99.99999999999999 0.01 - 0.01.prev_float #=> 1.734723475976807e-18 1.0 - 1.0.prev_float #=> 1.1102230246251565e-16 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; @æ¢;!F;"o;#;$T;%i^;&i†;'@æœ;(I"Wstatic VALUE flo_prev_float(VALUE vx) { return flo_nextafter(vx, -HUGE_VAL); };T;)I"static VALUE;T;*To;;F; ;;;;I"Float#positive?;F;[;[[@ïi ;T;;d;0;[;{;IC;"1Returns +true+ if +float+ is greater than 0.;T;[o;= ;3I" overload;F;40;;d;50;)I"positive?;T;IC;";T; @£;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @£;[;I"@return [Boolean];T;0;6i;[; @£;[;I"[Returns +true+ if +float+ is greater than 0. @overload positive? @return [Boolean];T;0; @£;!F;"o;#;$T;%iˆ ;&iŒ ;6i;'@æœ;(I"vstatic VALUE flo_positive_p(VALUE num) { double f = RFLOAT_VALUE(num); return f > 0.0 ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Float#negative?;F;[;[[@ïi ;T;;e;0;[;{;IC;".Returns +true+ if +float+ is less than 0.;T;[o;= ;3I" overload;F;40;;e;50;)I"negative?;T;IC;";T; @£;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @£;[;I"@return [Boolean];T;0;6i;[; @£;[;I"XReturns +true+ if +float+ is less than 0. @overload negative? @return [Boolean];T;0; @£;!F;"o;#;$T;%i– ;&iš ;6i;'@æœ;(I"vstatic VALUE flo_negative_p(VALUE num) { double f = RFLOAT_VALUE(num); return f < 0.0 ? Qtrue : Qfalse; };T;)I"static VALUE;T;*T;A@æœ;BIC;[;A@æœ;CIC;[;A@æœ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@›ž;q;I[;[[@ïiŠ[@ïiÙ;T;: Float;;K;;;[;{;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: - https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html - https://github.com/rdp/ruby_tutorials_core/wiki/Ruby-Talk-FAQ#floats_imprecise - https://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: - https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html - https://github.com/rdp/ruby_tutorials_core/wiki/Ruby-Talk-FAQ#floats_imprecise - https://en.wikipedia.org/wiki/Floating_point#Accuracy_problems ;T;0; @æœ;!F;"o;#;$T;%iŠ;&i–;6i;'@;I" Float;F;S@<@j‡o; ;IC;[o;;F; ;;;;I"Encoding#to_s;F;[;[[@F›iG;T;;q;0;[;{;IC;"OReturns the name of the encoding. Encoding::UTF_8.name #=> "UTF-8" ;T;[o;= ;3I" overload;F;40;;Ñ;50;)I" name;T;IC;";T; @K£;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @K£;[;I"@return [String];T;0;6i;[; @K£o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @K£;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @K£;[;I"@return [String];T;0;6i;[; @K£;[;I"Returns the name of the encoding. Encoding::UTF_8.name #=> "UTF-8" @overload name @return [String] @overload to_s @return [String];T;0; @K£;!F;"o;#;$T;%i>;&iF;'@I£;(I"qstatic VALUE enc_name(VALUE self) { return rb_fstring_cstr(rb_enc_name((rb_encoding*)DATA_PTR(self))); };T;)I"static VALUE;T;*To;;F; ;;;;I"Encoding#inspect;F;[;[[@F›i,;T;;r;0;[;{;IC;"¾Returns a string which represents the encoding for programmers. Encoding::UTF_8.inspect #=> "#" Encoding::ISO_2022_JP.inspect #=> "#" ;T;[o;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @s£;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @s£;[;I"@return [String];T;0;6i;[; @s£;[;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; @s£;!F;"o;#;$T;%i#;&i*;'@I£;(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)" : ""), rb_enc_autoload_p(enc) ? " (autoload)" : ""); };T;)I"static VALUE;T;*To;;F; ;;;;I"Encoding#name;F;[;[[@F›iG;T;;Ñ;0;[;{;IC;"OReturns the name of the encoding. Encoding::UTF_8.name #=> "UTF-8" ;T;[o;= ;3I" overload;F;40;;Ñ;50;)I" name;T;IC;";T; @Ž£;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Ž£;[;I"@return [String];T;0;6i;[; @Ž£o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @Ž£;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Ž£;[;I"@return [String];T;0;6i;[; @Ž£;[;@o£;0; @Ž£;!F;"o;#;$T;%i>;&iF;'@I£;(I"qstatic VALUE enc_name(VALUE self) { return rb_fstring_cstr(rb_enc_name((rb_encoding*)DATA_PTR(self))); };T;)I"static VALUE;T;*To;;F; ;;;;I"Encoding#names;F;[;[[@F›ia;T;: names;0;[;{;IC;"‘Returns the list of name and aliases of the encoding. Encoding::WINDOWS_31J.names #=> ["Windows-31J", "CP932", "csWindows31J", "SJIS", "PCK"] ;T;[o;= ;3I" overload;F;40;;Ñ;50;)I" names;T;IC;";T; @µ£;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @µ£;[;I"@return [Array];T;0;6i;[; @µ£;[;I"µReturns the list of name and aliases of the encoding. Encoding::WINDOWS_31J.names #=> ["Windows-31J", "CP932", "csWindows31J", "SJIS", "PCK"] @overload names @return [Array];T;0; @µ£;!F;"o;#;$T;%iY;&i_;'@I£;(I"static VALUE enc_names(VALUE self) { VALUE args[2]; args[0] = (VALUE)rb_to_encoding_index(self); args[1] = rb_ary_new2(0); GLOBAL_ENC_TABLE_EVAL(enc_table, st_foreach(enc_table->names, enc_names_i, (st_data_t)args)); return args[1]; };T;)I"static VALUE;T;*To;;F; ;;;;I"Encoding#dummy?;F;[;[[@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;= ;3I" overload;F;40;;Ò;50;)I"dummy?;T;IC;";T; @Ð£;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Ð£;[;I"@return [Boolean];T;0;6i;[; @Ð£;[;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; @Ð£;!F;"o;#;$T;%i‰;&i”;6i;'@I£;(I"istatic VALUE enc_dummy_p(VALUE enc) { return ENC_DUMMY_P(must_encoding(enc)) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Encoding#ascii_compatible?;F;[;[[@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;= ;3I" overload;F;40;;Ó;50;)I"ascii_compatible?;T;IC;";T; @ë£;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ë£;[;I"@return [Boolean];T;0;6i;[; @ë£;[;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; @ë£;!F;"o;#;$T;%iœ;&i¤;6i;'@I£;(I"{static VALUE enc_ascii_compatible_p(VALUE enc) { return rb_enc_asciicompat(must_encoding(enc)) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Encoding#replicate;F;[[I" name;T0;[[@F›i8;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;= ;3I" overload;F;40;;Ô;50;)I"replicate(name);T;IC;";T; @¤;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Encoding;T; @¤;[;I"@return [Encoding];T;0;6i;[[I" name;T0; @¤;[;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; @¤;!F;"o;#;$T;%i/;&i6;'@I£;(I"Óstatic VALUE enc_replicate_m(VALUE encoding, VALUE name) { int idx = rb_enc_replicate(name_for_encoding(&name), rb_to_encoding(encoding)); RB_GC_GUARD(name); return rb_enc_from_encoding_index(idx); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Encoding.list;F;[;[[@F›i;T;;²;0;[;{;IC;"KReturns the list of loaded encodings. Encoding.list #=> [#, #, #] Encoding.find("US-ASCII") #=> # Encoding.list #=> [#, #, #, #] ;T;[o;= ;3I" overload;F;40;;²;50;)I" list;T;IC;";T; @%¤;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @%¤;[;I"@return [Array];T;0;6i;[; @%¤;[;I"oReturns the list of loaded encodings. Encoding.list #=> [#, #, #] Encoding.find("US-ASCII") #=> # Encoding.list #=> [#, #, #, #] @overload list @return [Array];T;0; @%¤;!F;"o;#;$T;%io;&i;'@I£;(I"static VALUE enc_list(VALUE klass) { VALUE ary = rb_ary_new2(0); RB_VM_LOCK_ENTER(); { rb_ary_replace(ary, rb_default_encoding_list); rb_ary_concat(ary, rb_additional_encoding_list); } RB_VM_LOCK_LEAVE(); return ary; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Encoding.name_list;F;[;[[@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;= ;3I" overload;F;40;;Õ;50;)I"name_list;T;IC;";T; @@¤;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @@¤;[;I"@return [Array];T;0;6i;[; @@¤;[;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; @@¤;!F;"o;#;$T;%iO;&iZ;'@I£;(I"$static VALUE rb_enc_name_list(VALUE klass) { VALUE ary; GLOBAL_ENC_TABLE_ENTER(enc_table); { ary = rb_ary_new2(enc_table->names->num_entries); st_foreach(enc_table->names, rb_enc_name_list_i, (st_data_t)ary); } GLOBAL_ENC_TABLE_LEAVE(); return ary; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Encoding.aliases;F;[;[[@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-1968"=>"US-ASCII", "SJIS"=>"Windows-31J", "eucJP"=>"EUC-JP", "CP932"=>"Windows-31J"} ;T;[o;= ;3I" overload;F;40;;Ö;50;)I"aliases;T;IC;";T; @[¤;>0;!F;[;[;I";T;0;6i;[; @[¤;[;I" Returns the hash of available encoding alias and original encoding name. Encoding.aliases #=> {"BINARY"=>"ASCII-8BIT", "ASCII"=>"US-ASCII", "ANSI_X3.4-1968"=>"US-ASCII", "SJIS"=>"Windows-31J", "eucJP"=>"EUC-JP", "CP932"=>"Windows-31J"} @overload aliases;T;0; @[¤;!F;"o;#;$T;%iƒ;&i‹;'@I£;(I""static VALUE rb_enc_aliases(VALUE klass) { VALUE aliases[2]; aliases[0] = rb_hash_new(); aliases[1] = rb_ary_new(); GLOBAL_ENC_TABLE_EVAL(enc_table, st_foreach(enc_table->names, rb_enc_aliases_enc_i, (st_data_t)aliases)); return aliases[0]; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Encoding.find;F;[[I"enc;T0;[[@F›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;= ;3I" overload;F;40;;);50;)I"find(string);T;IC;";T; @q¤;>0;!F;[;[;I";T;0;6i;[[I"string;T0; @q¤;[;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; @q¤;!F;"o;#;$T;%i;&i£;'@I£;(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;)I"static VALUE;T;*To;;F; ;F;;;I"Encoding.compatible?;F;[[I" str1;T0[I" str2;T0;[[@F›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;= ;3I" overload;F;40;;×;50;)I"compatible?(obj1, obj2);T;IC;";T; @‹¤;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @‹¤;[;I"@return [nil];T;0;6i;[[I" obj1;T0[I" obj2;T0; @‹¤;[;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; @‹¤;!F;"o;#;$T;%i±;&iÇ;6i;'@I£;(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;)I"static VALUE;T;*To;;F; ;;;;I"Encoding#_dump;F;[[@c0;[[@F›iß;T;;î;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @®¤;!F;"o;#;$T;%iÞ;&iÞ;'@I£;(I"|static VALUE enc_dump(int argc, VALUE *argv, VALUE self) { rb_check_arity(argc, 0, 1); return enc_name(self); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Encoding._load;F;[[I"str;T0;[[@F›iç;T;: _load;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @½¤;!F;"o;#;$T;%iæ;&iæ;'@I£;(I"Fstatic VALUE enc_load(VALUE klass, VALUE str) { return str; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Encoding.default_external;F;[;[[@F›iž;T;:default_external;0;[;{;IC;"¯Returns 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, if default_internal is not nil. The default external encoding is initialized by the -E option. If -E isn't set, it is initialized to UTF-8 on Windows and the locale on other operating systems. ;T;[o;= ;3I" overload;F;40;;Ù;50;)I"default_external;T;IC;";T; @Í¤;>0;!F;[;[;I";T;0;6i;[; @Í¤;[;I"ÌReturns 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, if default_internal is not nil. The default external encoding is initialized by the -E option. If -E isn't set, it is initialized to UTF-8 on Windows and the locale on other operating systems. @overload default_external;T;0; @Í¤;!F;"o;#;$T;%i‚;&i›;'@I£;(I"]static VALUE get_default_external(VALUE klass) { return rb_enc_default_external(); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Encoding.default_external=;F;[[I" encoding;T0;[[@F›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;= ;3I" overload;F;40;;Ú;50;)I"default_external=(enc);T;IC;";T; @ã¤;>0;!F;[;[;I";T;0;6i;[[I"enc;T0; @ã¤;[;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; @ã¤;!F;"o;#;$T;%i®;&i¸;'@I£;(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;)I"static VALUE;T;*To;;F; ;F;;;I"Encoding.default_internal;F;[;[[@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 script encoding (__ENCODING__), not default_internal, is used as the encoding of created strings. Encoding::default_internal is initialized with -E option or nil otherwise. ;T;[o;= ;3I" overload;F;40;;Û;50;)I"default_internal;T;IC;";T; @ý¤;>0;!F;[;[;I";T;0;6i;[; @ý¤;[;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 script encoding (__ENCODING__), not default_internal, is used as the encoding of created strings. Encoding::default_internal is initialized with -E option or nil otherwise. @overload default_internal;T;0; @ý¤;!F;"o;#;$T;%iÕ;&iî;'@I£;(I"]static VALUE get_default_internal(VALUE klass) { return rb_enc_default_internal(); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Encoding.default_internal=;F;[[I" encoding;T0;[[@F›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;= ;3I" overload;F;40;;Ü;50;)I"default_internal=(enc);T;IC;";T; @¥;>0;!F;[;[;I";T;0;6i;[[I"enc;T0; @¥;[;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; @¥;!F;"o;#;$T;%iþ;&i;'@I£;(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;)I"static VALUE;T;*To;;F; ;F;;;I"Encoding.locale_charmap;F;[;[[I"localeinit.c;Ti_;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;= ;3I" overload;F;40;;Ý;50;)I"locale_charmap;T;IC;";T; @-¥;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @-¥;[;I"@return [String];T;0;6i;[; @-¥;[;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; @-¥;!F;"o;#;$T;%iF;&i];'@I£;(I"¯VALUE rb_locale_charmap(VALUE klass) { #if NO_LOCALE_CHARMAP return rb_usascii_str_new_cstr("US-ASCII"); #else return locale_charmap(rb_usascii_str_new_cstr); #endif };T;)I" VALUE;T;*To; ;IC;[;A@I¥;BIC;[;A@I¥;CIC;[;A@I¥;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷i/ [@÷i;T;:CompatibilityError;;K;;;[;{;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; @I¥;!F;"o;#;$T;%i/ ;&i2 ;'o;L;M0;N0;O0;: Encoding;'@;Q@I£;R0;I"!Encoding::CompatibilityError;F;So; ;IC;[;A@^¥;BIC;[;A@^¥;CIC;[;A@^¥;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷i) [@÷i;T;:EncodingError;;K;;;[;{;IC;"9EncodingError is the base class for encoding errors. ;T;[;[;I"; EncodingError is the base class for encoding errors. ;T;0; @^¥;!F;"o;#;$T;%i) ;&i+ ;'@;I"EncodingError;F;S@ìo; ;IC;[#o;;F; ;F;;;I"-Encoding::Converter.asciicompat_encoding;T;[[I"arg;T0;[[@eœ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;= ;3I" overload;F;40;:-Encoding::Converter.asciicompat_encoding;50;)I"5Encoding::Converter.asciicompat_encoding(string);T;IC;";T; @t¥;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Encoding;TI"nil;T; @t¥;[;I"@return [Encoding, nil];T;0;6i;[[I"string;T0; @t¥o;= ;3I" overload;F;40;;â;50;)I"7Encoding::Converter.asciicompat_encoding(encoding);T;IC;";T; @t¥;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Encoding;TI"nil;T; @t¥;[;I"@return [Encoding, nil];T;0;6i;[[I" encoding;T0; @t¥;[;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; @t¥;!F;"o;#;$T;%iœ;&i;'@r¥;(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;)I"static VALUE;T;*To;;F; ;F;;;I"(Encoding::Converter.search_convpath;T;[[@c0;[[@eœiO;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;= ;3I" overload;F;40;:(Encoding::Converter.search_convpath;50;)I"OEncoding::Converter.search_convpath(source_encoding, destination_encoding);T;IC;";T; @¤¥;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @¤¥;[;I"@return [Array];T;0;6i;[[I"source_encoding;T0[I"destination_encoding;T0; @¤¥o;= ;3I" overload;F;40;;ä;50;)I"TEncoding::Converter.search_convpath(source_encoding, destination_encoding, opt);T;IC;";T; @¤¥;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @¤¥;[;I"@return [Array];T;0;6i;[[I"source_encoding;T0[I"destination_encoding;T0[I"opt;T0; @¤¥;[;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) @return [Array] @overload Encoding::Converter.search_convpath(source_encoding, destination_encoding, opt) @return [Array];T;0; @¤¥;!F;"o;#;$T;%i6;&iN;'@r¥;(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)) { VALUE exc = rb_econv_open_exc(sname, dname, ecflags); RB_GC_GUARD(snamev); RB_GC_GUARD(dnamev); rb_exc_raise(exc); } 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;)I"static VALUE;T;*To;;F; ;;;;I"#Encoding::Converter#initialize;T;[[@c0;[[@eœiH ;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 an 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 an 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;= ;3I" overload;F;40;:Encoding::Converter.new;50;)I"CEncoding::Converter.new(source_encoding, destination_encoding);T;IC;";T; @×¥;>0;!F;[;[;I";T;0;6i;[[I"source_encoding;T0[I"destination_encoding;T0; @×¥o;= ;3I" overload;F;40;;å;50;)I"HEncoding::Converter.new(source_encoding, destination_encoding, opt);T;IC;";T; @×¥;>0;!F;[;[;I";T;0;6i;[[I"source_encoding;T0[I"destination_encoding;T0[I"opt;T0; @×¥o;= ;3I" overload;F;40;;å;50;)I"&Encoding::Converter.new(convpath);T;IC;";T; @×¥;>0;!F;[;[;I";T;0;6i;[[I" convpath;T0; @×¥;[;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 an 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 an 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; @×¥;!F;"o;#;$T;%iÞ;&iE ;'@r¥;(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;)I"static VALUE;T;*To;;F; ;;;;I" Encoding::Converter#inspect;T;[;[[@eœiƒ ;T;;r;0;[;{;IC;"¤Returns a printable version of ec ec = Encoding::Converter.new("iso-8859-1", "utf-8") puts ec.inspect #=> # ;T;[o;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @ ¦;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ ¦;[;I"@return [String];T;0;6i;[; @ ¦;[;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; @ ¦;!F;"o;#;$T;%iy ;&i ;'@r¥;(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;)I"static VALUE;T;*To;;F; ;;;;I"!Encoding::Converter#convpath;T;[;[[@eœ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;= ;3I" overload;F;40;;æ;50;)I" convpath;T;IC;";T; @%¦;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @%¦;[;I"@return [Array];T;0;6i;[; @%¦;[;I"oReturns 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 @return [Array];T;0; @%¦;!F;"o;#;$T;%iÁ ;&iÕ ;'@r¥;(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;)I"static VALUE;T;*To;;F; ;;;;I"(Encoding::Converter#source_encoding;T;[;[[@eœi© ;T;:source_encoding;0;[;{;IC;"7Returns the source encoding as an Encoding object. ;T;[o;= ;3I" overload;F;40;;ç;50;)I"source_encoding;T;IC;";T; @@¦;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Encoding;T; @@¦;[;I"@return [Encoding];T;0;6i;[; @@¦;[;I"hReturns the source encoding as an Encoding object. @overload source_encoding @return [Encoding];T;0; @@¦;!F;"o;#;$T;%i£ ;&i§ ;'@r¥;(I"Ãstatic VALUE econv_source_encoding(VALUE self) { rb_econv_t *ec = check_econv(self); if (!ec->source_encoding) return Qnil; return rb_enc_from_encoding(ec->source_encoding); };T;)I"static VALUE;T;*To;;F; ;;;;I"-Encoding::Converter#destination_encoding;T;[;[[@eœi¸ ;T;:destination_encoding;0;[;{;IC;"0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Encoding;T; @[¦;[;I"@return [Encoding];T;0;6i;[; @[¦;[;I"rReturns the destination encoding as an Encoding object. @overload destination_encoding @return [Encoding];T;0; @[¦;!F;"o;#;$T;%i² ;&i¶ ;'@r¥;(I"Òstatic VALUE econv_destination_encoding(VALUE self) { rb_econv_t *ec = check_econv(self); if (!ec->destination_encoding) return Qnil; return rb_enc_from_encoding(ec->destination_encoding); };T;)I"static VALUE;T;*To;;F; ;;;;I"*Encoding::Converter#primitive_convert;T;[[@c0;[[@eœi;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;= ;3I" overload;F;40;;é;50;)I"9primitive_convert(source_buffer, destination_buffer);T;IC;";T; @v¦;>0;!F;[;[;I";T;0;6i;[[I"source_buffer;T0[I"destination_buffer;T0; @v¦o;= ;3I" overload;F;40;;é;50;)I"Qprimitive_convert(source_buffer, destination_buffer, destination_byteoffset);T;IC;";T; @v¦;>0;!F;[;[;I";T;0;6i;[[I"source_buffer;T0[I"destination_buffer;T0[I"destination_byteoffset;T0; @v¦o;= ;3I" overload;F;40;;é;50;)I"gprimitive_convert(source_buffer, destination_buffer, destination_byteoffset, destination_bytesize);T;IC;";T; @v¦;>0;!F;[;[;I";T;0;6i;[ [I"source_buffer;T0[I"destination_buffer;T0[I"destination_byteoffset;T0[I"destination_bytesize;T0; @v¦o;= ;3I" overload;F;40;;é;50;)I"lprimitive_convert(source_buffer, destination_buffer, destination_byteoffset, destination_bytesize, opt);T;IC;";T; @v¦;>0;!F;[;[;I";T;0;6i;[ [I"source_buffer;T0[I"destination_buffer;T0[I"destination_byteoffset;T0[I"destination_bytesize;T0[I"opt;T0; @v¦;[;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; @v¦;!F;"o;#;$T;%i!;&i|;'@r¥;(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)) { 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;)I"static VALUE;T;*To;;F; ;;;;I" Encoding::Converter#convert;T;[[I"source_string;T0;[[@eœ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;= ;3I" overload;F;40;;ê;50;)I"convert(source_string);T;IC;";T; @Á¦;>0;!F;[;[;I";T;0;6i;[[I"source_string;T0; @Á¦;[;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; @Á¦;!F;"o;#;$T;%iî;&i ;'@r¥;(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;)I"static VALUE;T;*To;;F; ;;;;I"Encoding::Converter#finish;T;[;[[@eœiB;T;;<;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;= ;3I" overload;F;40;;<;50;)I"finish;T;IC;";T; @Û¦;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Û¦;[;I"@return [String];T;0;6i;[; @Û¦;[;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; @Û¦;!F;"o;#;$T;%i7;&i@;'@r¥;(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;)I"static VALUE;T;*To;;F; ;;;;I"*Encoding::Converter#primitive_errinfo;T;[;[[@eœ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;= ;3I" overload;F;40;;ë;50;)I"primitive_errinfo;T;IC;";T; @ö¦;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ö¦;[;I"@return [Array];T;0;6i;[; @ö¦;[;I"Aprimitive_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; @ö¦;!F;"o;#;$T;%ic;&i¬;'@r¥;(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;)I"static VALUE;T;*To;;F; ;;;;I"&Encoding::Converter#insert_output;T;[[I"string;T0;[[@eœ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;= ;3I" overload;F;40;;ì;50;)I"insert_output(string);T;IC;";T; @§;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @§;[;I"@return [nil];T;0;6i;[[I"string;T0; @§;[;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; @§;!F;"o;#;$T;%iÈ;&iæ;'@r¥;(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;)I"static VALUE;T;*To;;F; ;;;;I" Encoding::Converter#putback;T;[[@c0;[[@eœi;T;:putback;0;[;{;IC;"Û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;[o;= ;3I" overload;F;40;;í;50;)I"putback;T;IC;";T; @0§;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @0§;[;I"@return [String];T;0;6i;[; @0§o;= ;3I" overload;F;40;;í;50;)I"putback(max_numbytes);T;IC;";T; @0§;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @0§;[;I"@return [String];T;0;6i;[[I"max_numbytes;T0; @0§;[;I"6Put 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 @overload putback @return [String] @overload putback(max_numbytes) @return [String];T;0; @0§;!F;"o;#;$T;%iý;&i;'@r¥;(I"istatic VALUE econv_putback(int argc, VALUE *argv, VALUE self) { rb_econv_t *ec = check_econv(self); int n; int putbackable; VALUE str, max; if (!rb_check_arity(argc, 0, 1) || NIL_P(max = argv[0])) { 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;)I"static VALUE;T;*To;;F; ;;;;I"#Encoding::Converter#last_error;T;[;[[@eœiE;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;= ;3I" overload;F;40;;î;50;)I"last_error;T;IC;";T; @[§;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Exception;TI"nil;T; @[§;[;I"@return [Exception, nil];T;0;6i;[; @[§;[;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; @[§;!F;"o;#;$T;%i1;&iC;'@r¥;(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;)I"static VALUE;T;*To;;F; ;;;;I"$Encoding::Converter#replacement;T;[;[[@eœi];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;= ;3I" overload;F;40;;ï;50;)I"replacement;T;IC;";T; @w§;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @w§;[;I"@return [String];T;0;6i;[; @w§;[;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; @w§;!F;"o;#;$T;%iQ;&i[;'@r¥;(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;)I"static VALUE;T;*To;;F; ;;;;I"%Encoding::Converter#replacement=;T;[[I"arg;T0;[[@eœiw;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;= ;3I" overload;F;40;;ð;50;)I"replacement=(string);T;IC;";T; @’§;>0;!F;[;[;I";T;0;6i;[[I"string;T0; @’§;[;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; @’§;!F;"o;#;$T;%im;⁢'@r¥;(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;)I"static VALUE;T;*To;;F; ;;;;I"Encoding::Converter#==;T;[[I" other;T0;[[@eœiï ;T;;`;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;`;50;)I"==(other);T;IC;";T; @¬§;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @¬§;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @¬§;[;I"- @overload ==(other) @return [Boolean];T;0; @¬§;!F;"o;#;$T;%ië ;&ií ;'@r¥;(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;)I"static VALUE;T;*To;{;[[@eœi;F;:INVALID_MASK;;};;;[;{;IC;"$Mask for invalid byte sequences ;T;[;[;I"& Mask for invalid byte sequences ;T;0; @Ë§;!F;"o;#;$T;%i‹;&i;'@r¥;I"&Encoding::Converter::INVALID_MASK;T;~I" INT2FIX(ECONV_INVALID_MASK);To;{;[[@eœi•;F;:INVALID_REPLACE;;};;;[;{;IC;"#Replace invalid byte sequences ;T;[;[;I"% Replace invalid byte sequences ;T;0; @×§;!F;"o;#;$T;%i‘;&i“;'@r¥;I")Encoding::Converter::INVALID_REPLACE;T;~I"#INT2FIX(ECONV_INVALID_REPLACE);To;{;[[@eœ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; @ã§;!F;"o;#;$T;%i—;&iš;'@r¥;I"$Encoding::Converter::UNDEF_MASK;T;~I"INT2FIX(ECONV_UNDEF_MASK);To;{;[[@eœ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; @ï§;!F;"o;#;$T;%iž;&i ;'@r¥;I"'Encoding::Converter::UNDEF_REPLACE;T;~I"!INT2FIX(ECONV_UNDEF_REPLACE);To;{;[[@eœ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; @û§;!F;"o;#;$T;%i¤;&i¨;'@r¥;I"+Encoding::Converter::UNDEF_HEX_CHARREF;T;~I"%INT2FIX(ECONV_UNDEF_HEX_CHARREF);To;{;[[@eœ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; @¨;!F;"o;#;$T;%i¬;&i¯;'@r¥;I"'Encoding::Converter::PARTIAL_INPUT;T;~I"!INT2FIX(ECONV_PARTIAL_INPUT);To;{;[[@eœ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; @¨;!F;"o;#;$T;%i³;&i¶;'@r¥;I"&Encoding::Converter::AFTER_OUTPUT;T;~I" INT2FIX(ECONV_AFTER_OUTPUT);To;{;[[@eœ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; @¨;!F;"o;#;$T;%iº;&i¼;'@r¥;I"5Encoding::Converter::UNIVERSAL_NEWLINE_DECORATOR;T;~I"/INT2FIX(ECONV_UNIVERSAL_NEWLINE_DECORATOR);To;{;[[@eœiÄ;F;:CRLF_NEWLINE_DECORATOR;;};;;[;{;IC;"(Decorator for converting LF to CRLF ;T;[;[;I"* Decorator for converting LF to CRLF ;T;0; @+¨;!F;"o;#;$T;%iÀ;&iÂ;'@r¥;I"0Encoding::Converter::CRLF_NEWLINE_DECORATOR;T;~I"*INT2FIX(ECONV_CRLF_NEWLINE_DECORATOR);To;{;[[@eœiÊ;F;:CR_NEWLINE_DECORATOR;;};;;[;{;IC;"&Decorator for converting LF to CR ;T;[;[;I"( Decorator for converting LF to CR ;T;0; @7¨;!F;"o;#;$T;%iÆ;&iÈ;'@r¥;I".Encoding::Converter::CR_NEWLINE_DECORATOR;T;~I"(INT2FIX(ECONV_CR_NEWLINE_DECORATOR);To;{;[[@eœiÐ;F;:XML_TEXT_DECORATOR;;};;;[;{;IC;"Escape as XML CharData ;T;[;[;I" Escape as XML CharData ;T;0; @C¨;!F;"o;#;$T;%iÌ;&iÎ;'@r¥;I",Encoding::Converter::XML_TEXT_DECORATOR;T;~I"&INT2FIX(ECONV_XML_TEXT_DECORATOR);To;{;[[@eœiÖ;F;:XML_ATTR_CONTENT_DECORATOR;;};;;[;{;IC;"Escape as XML AttValue ;T;[;[;I" Escape as XML AttValue ;T;0; @O¨;!F;"o;#;$T;%iÒ;&iÔ;'@r¥;I"4Encoding::Converter::XML_ATTR_CONTENT_DECORATOR;T;~I".INT2FIX(ECONV_XML_ATTR_CONTENT_DECORATOR);To;{;[[@eœiÜ;F;:XML_ATTR_QUOTE_DECORATOR;;};;;[;{;IC;"Escape as XML AttValue ;T;[;[;I" Escape as XML AttValue ;T;0; @[¨;!F;"o;#;$T;%iØ;&iÚ;'@r¥;I"2Encoding::Converter::XML_ATTR_QUOTE_DECORATOR;T;~I",INT2FIX(ECONV_XML_ATTR_QUOTE_DECORATOR);T;A@r¥;BIC;[;A@r¥;CIC;[;A@r¥;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@eœid[@eœiw;T;:Converter;;K;;;[;{;IC;"Encoding conversion class.;T;[;[;I"! Encoding conversion class. ;T;0; @r¥;!F;"o;#;$T;%id;&if;6i;'o;L;M0;N0;O0;;ß;'@;Q@I£;R0;I"Encoding::Converter;T;S@]o; ;IC;[ o;;F; ;;;;I"0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @|¨;[;I"@return [String];T;0;6i;[; @|¨;[;I"fReturns the source encoding name as a string. @overload source_encoding_name @return [String];T;0; @|¨;!F;"o;#;$T;%i ;&i¤;'@z¨;(I"}static VALUE ecerr_source_encoding_name(VALUE self) { return rb_attr_get(self, rb_intern("source_encoding_name")); };T;)I"static VALUE;T;*To;;F; ;;;;I"AEncoding::UndefinedConversionError#destination_encoding_name;F;[;[[@eœiÌ;T;:destination_encoding_name;0;[;{;IC;"7Returns the destination encoding name as a string. ;T;[o;= ;3I" overload;F;40;;;50;)I"destination_encoding_name;T;IC;";T; @—¨;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @—¨;[;I"@return [String];T;0;6i;[; @—¨;[;I"pReturns the destination encoding name as a string. @overload destination_encoding_name @return [String];T;0; @—¨;!F;"o;#;$T;%iÆ;&iÊ;'@z¨;(I"‚static VALUE ecerr_destination_encoding_name(VALUE self) { return rb_attr_get(self, rb_intern("destination_encoding_name")); };T;)I"static VALUE;T;*To;;F; ;;;;I"7Encoding::UndefinedConversionError#source_encoding;F;[;[[@eœiÀ;T;;ç;0;[;{;IC;"oReturns 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 ;T;[o;= ;3I" overload;F;40;;ç;50;)I"source_encoding;T;IC;";T; @²¨;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Encoding;T; @²¨;[;I"@return [Encoding];T;0;6i;[; @²¨;[;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; @²¨;!F;"o;#;$T;%i¬;&i¾;'@z¨;(I"sstatic VALUE ecerr_source_encoding(VALUE self) { return rb_attr_get(self, rb_intern("source_encoding")); };T;)I"static VALUE;T;*To;;F; ;;;;I"0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Í¨;[;I"@return [String];T;0;6i;[; @Í¨;[;I"pReturns the destination encoding as an encoding object. @overload destination_encoding @return [String];T;0; @Í¨;!F;"o;#;$T;%iÒ;&iÖ;'@z¨;(I"}static VALUE ecerr_destination_encoding(VALUE self) { return rb_attr_get(self, rb_intern("destination_encoding")); };T;)I"static VALUE;T;*To;;F; ;;;;I"2Encoding::UndefinedConversionError#error_char;F;[;[[@eœií;T;:error_char;0;[;{;IC;"3Returns 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 ;T;[o;= ;3I" overload;F;40;;;50;)I"error_char;T;IC;";T; @è¨;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @è¨;[;I"@return [String];T;0;6i;[; @è¨;[;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; @è¨;!F;"o;#;$T;%iÞ;&ië;'@z¨;(I"istatic VALUE ecerr_error_char(VALUE self) { return rb_attr_get(self, rb_intern("error_char")); };T;)I"static VALUE;T;*T;A@z¨;BIC;[;A@z¨;CIC;[;A@z¨;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@eœi2[@eœip;T;:UndefinedConversionError;;K;;;[;{;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; @z¨;!F;"o;#;$T;%i2;&i5;6i;'o;L;M0;N0;O0;;ß;'@;Q@I£;R0;I"'Encoding::UndefinedConversionError;F;S@^¥o; ;IC;[o;;F; ;;;;I"0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @©;[;I"@return [String];T;0;6i;[; @©;[;@“¨;0; @©;!F;"o;#;$T;%i ;&i¤;'@©;(I"}static VALUE ecerr_source_encoding_name(VALUE self) { return rb_attr_get(self, rb_intern("source_encoding_name")); };T;)I"static VALUE;T;*To;;F; ;;;;I"AEncoding::InvalidByteSequenceError#destination_encoding_name;F;[;[[@eœiÌ;T;;;0;[;{;IC;"7Returns the destination encoding name as a string. ;T;[o;= ;3I" overload;F;40;;;50;)I"destination_encoding_name;T;IC;";T; @2©;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @2©;[;I"@return [String];T;0;6i;[; @2©;[;@®¨;0; @2©;!F;"o;#;$T;%iÆ;&iÊ;'@©;(I"‚static VALUE ecerr_destination_encoding_name(VALUE self) { return rb_attr_get(self, rb_intern("destination_encoding_name")); };T;)I"static VALUE;T;*To;;F; ;;;;I"7Encoding::InvalidByteSequenceError#source_encoding;F;[;[[@eœiÀ;T;;ç;0;[;{;IC;"oReturns 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 ;T;[o;= ;3I" overload;F;40;;ç;50;)I"source_encoding;T;IC;";T; @L©;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Encoding;T; @L©;[;I"@return [Encoding];T;0;6i;[; @L©;[;@É¨;0; @L©;!F;"o;#;$T;%i¬;&i¾;'@©;(I"sstatic VALUE ecerr_source_encoding(VALUE self) { return rb_attr_get(self, rb_intern("source_encoding")); };T;)I"static VALUE;T;*To;;F; ;;;;I"0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @f©;[;I"@return [String];T;0;6i;[; @f©;[;@ä¨;0; @f©;!F;"o;#;$T;%iÒ;&iÖ;'@©;(I"}static VALUE ecerr_destination_encoding(VALUE self) { return rb_attr_get(self, rb_intern("destination_encoding")); };T;)I"static VALUE;T;*To;;F; ;;;;I"3Encoding::InvalidByteSequenceError#error_bytes;F;[;[[@eœi;T;:error_bytes;0;[;{;IC;"•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 ;T;[o;= ;3I" overload;F;40;;;50;)I"error_bytes;T;IC;";T; @€©;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @€©;[;I"@return [String];T;0;6i;[; @€©;[;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; @€©;!F;"o;#;$T;%ió;&i;'@©;(I"kstatic VALUE ecerr_error_bytes(VALUE self) { return rb_attr_get(self, rb_intern("error_bytes")); };T;)I"static VALUE;T;*To;;F; ;;;;I"7Encoding::InvalidByteSequenceError#readagain_bytes;F;[;[[@eœi;T;:readagain_bytes;0;[;{;IC;"WReturns the bytes to be read again when Encoding::InvalidByteSequenceError occurs. ;T;[o;= ;3I" overload;F;40;;;50;)I"readagain_bytes;T;IC;";T; @›©;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @›©;[;I"@return [String];T;0;6i;[; @›©;[;I"Returns the bytes to be read again when Encoding::InvalidByteSequenceError occurs. @overload readagain_bytes @return [String];T;0; @›©;!F;"o;#;$T;%i;&i;'@©;(I"sstatic VALUE ecerr_readagain_bytes(VALUE self) { return rb_attr_get(self, rb_intern("readagain_bytes")); };T;)I"static VALUE;T;*To;;F; ;;;;I"9Encoding::InvalidByteSequenceError#incomplete_input?;F;[;[[@eœ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;= ;3I" overload;F;40;;;50;)I"incomplete_input?;T;IC;";T; @¶©;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @¶©;[;I"@return [Boolean];T;0;6i;[; @¶©;[;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; @¶©;!F;"o;#;$T;%i;&i*;6i;'@©;(I"ustatic VALUE ecerr_incomplete_input(VALUE self) { return rb_attr_get(self, rb_intern("incomplete_input")); };T;)I"static VALUE;T;*T;A@©;BIC;[;A@©;CIC;[;A@©;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@eœi9[@eœiq;T;:InvalidByteSequenceError;;K;;;[;{;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; @©;!F;"o;#;$T;%i9;&i=;6i;'o;L;M0;N0;O0;;ß;'@;Q@I£;R0;I"'Encoding::InvalidByteSequenceError;F;S@^¥o; ;IC;[;A@ä©;BIC;[;A@ä©;CIC;[;A@ä©;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@eœiA[@eœir;T;:ConverterNotFoundError;;K;;;[;{;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; @ä©;!F;"o;#;$T;%iA;&iD;'o;L;M0;N0;O0;;ß;'@;Q@I£;R0;I"%Encoding::ConverterNotFoundError;F;S@^¥;A@I£;BIC;[;A@I£;CIC;[;A@I£;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@F›ik;F;;ß;;K;;;[;{;IC;"qAn 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"sAn 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; @I£;!F;"o;#;$T;%iœ;&ib;6i;'@;I" Encoding;F;S@]o; ;IC;[ o;;F; ;;;;I"Monitor#try_enter;F;[;[[I"ext/monitor/monitor.c;Ti@;T;:try_enter;0;[;{;IC;";T;[;[;@|;0; @ª;'@ ª;(I"Rstatic VALUE monitor_try_enter(VALUE monitor) { struct rb_monitor *mc = monitor_ptr(monitor); if (!mc_owner_p(mc)) { if (!rb_mutex_trylock(mc->mutex)) { return Qfalse; } RB_OBJ_WRITE(monitor, &mc->owner, rb_fiber_current()); mc->count = 0; } mc->count += 1; return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"Monitor#enter;F;[;[[@ªiP;T;: enter;0;[;{;IC;";T;[;[;@|;0; @ª;'@ ª;(I"static VALUE monitor_enter(VALUE monitor) { struct rb_monitor *mc = monitor_ptr(monitor); if (!mc_owner_p(mc)) { rb_mutex_lock(mc->mutex); RB_OBJ_WRITE(monitor, &mc->owner, rb_fiber_current()); mc->count = 0; } mc->count++; return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Monitor#exit;F;[;[[@ªig;T;;±;0;[;{;IC;";T;[;[;@|;0; @%ª;'@ ª;(I"fstatic VALUE monitor_exit(VALUE monitor) { monitor_check_owner(monitor); struct rb_monitor *mc = monitor_ptr(monitor); if (mc->count <= 0) rb_bug("monitor_exit: count:%d\n", (int)mc->count); mc->count--; if (mc->count == 0) { RB_OBJ_WRITE(monitor, &mc->owner, Qnil); rb_mutex_unlock(mc->mutex); } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Monitor#synchronize;F;[;[[@ªiÄ;T;:synchronize;0;[;{;IC;";T;[;[;@|;0; @1ª;'@ ª;(I"Ÿstatic VALUE monitor_synchronize(VALUE monitor) { monitor_enter(monitor); return rb_ensure(monitor_sync_body, monitor, monitor_sync_ensure, monitor); };T;)I"static VALUE;T;*To;;F; ;;;;I"Monitor#mon_locked?;F;[;[[@ªix;T;:mon_locked?;0;[;{;IC;"&internal methods for MonitorMixin;T;[o;2 ;3I"return;F;4@|;0;5[@~; @=ª;[;I"&internal methods for MonitorMixin;T;0; @=ª;!F;"o;#;$T;%iÚ;&iÚ;6i;'@ ª;(I"‹static VALUE monitor_locked_p(VALUE monitor) { struct rb_monitor *mc = monitor_ptr(monitor); return rb_mutex_locked_p(mc->mutex); };T;)I"static VALUE;T;*To;;F; ;;;;I"Monitor#mon_check_owner;F;[;[[@ªi];T;:mon_check_owner;0;[;{;IC;";T;[;[;@|;0; @Nª;'@ ª;(I"Õstatic VALUE monitor_check_owner(VALUE monitor) { struct rb_monitor *mc = monitor_ptr(monitor); if (!mc_owner_p(mc)) { rb_raise(rb_eThreadError, "current fiber not owner"); } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Monitor#mon_owned?;F;[;[[@ªi;T;:mon_owned?;0;[;{;IC;";T;[o;2 ;3I"return;F;4@|;0;5[@~; @Zª;[;@|;0; @Zª;6i;'@ ª;(I"¯static VALUE monitor_owned_p(VALUE monitor) { struct rb_monitor *mc = monitor_ptr(monitor); return (rb_mutex_locked_p(mc->mutex) && mc_owner_p(mc)) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Monitor#wait_for_cond;F;[[I" cond;T0[I"timeout;T0;[[@ªi©;T;:wait_for_cond;0;[;{;IC;";internal methods for MonitorMixin::ConditionalVariable ;T;[;[;I";internal methods for MonitorMixin::ConditionalVariable;T;0; @iª;!F;"o;#;$T;%iß;&iß;'@ ª;(I"kstatic VALUE monitor_wait_for_cond(VALUE monitor, VALUE cond, VALUE timeout) { VALUE count = monitor_exit_for_cond(monitor); struct wait_for_cond_data data = { monitor, cond, timeout, count, }; return rb_ensure(monitor_wait_for_cond_body, (VALUE)&data, monitor_enter_for_cond, (VALUE)&data); };T;)I"static VALUE;T;*T;A@ ª;BIC;[;A@ ª;CIC;[;A@ ª;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ªiÒ;F;:Monitor;;K;;;[;{;IC;";T;[;[;@|;0; @ ª;6i;'@;I"Monitor;F;S@]@¡o; ;IC;[ o;;F; ;;;Ï;I"Class#inherited;F;[[I"_y;T0;[[@Ìiz;T;:inherited;0;[;{;IC;"Ncall-seq: inherited(subclass) Callback invoked whenever a subclass of the current class is created. Example: class Foo def self.inherited(subclass) puts "New subclass: #{subclass}" end end class Bar < Foo end class Baz < Bar end produces: New subclass: Bar New subclass: Baz ;T;[;[;I"P call-seq: inherited(subclass) Callback invoked whenever a subclass of the current class is created. Example: class Foo def self.inherited(subclass) puts "New subclass: #{subclass}" end end class Bar < Foo end class Baz < Bar end produces: New subclass: Bar New subclass: Baz ;T;0; @Œª;!F;"o;#;$T;%i‹;&i£;'@Šª;(I"Rstatic VALUE rb_obj_dummy1(VALUE _x, VALUE _y) { return rb_obj_dummy(); };T;)I"static VALUE;T;*To;;F; ;;;;I"Class#allocate;F;[;[[@Ìiå;T;: allocate;0;[;{;IC;"rAllocates space for a new object of class's class and does not call initialize on the new instance. The returned object must be an instance of class. klass = Class.new do def initialize(*args) @initialized = true end def initialized? @initialized || false end end klass.allocate.initialized? #=> false ;T;[o;= ;3I" overload;F;40;;;50;)I"allocate();T;IC;";T; @œª;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @œª;[;I"@return [Object];T;0;6i;[; @œª;[;I"Allocates space for a new object of class's class and does not call initialize on the new instance. The returned object must be an instance of class. klass = Class.new do def initialize(*args) @initialized = true end def initialized? @initialized || false end end klass.allocate.initialized? #=> false @overload allocate() @return [Object];T;0; @œª;!F;"o;#;$T;%iÏ;&iâ;'@Šª;(I"Lstatic VALUE rb_class_alloc_m(VALUE klass) { rb_alloc_func_t allocator = class_get_alloc_func(klass); if (!rb_obj_respond_to(klass, rb_intern("allocate"), 1)) { rb_raise(rb_eTypeError, "calling %"PRIsVALUE".allocate is prohibited", klass); } return class_call_alloc_func(allocator, klass); };T;)I"static VALUE;T;*To;;F; ;;;;I"Class#new;F;[[@c0;[[@Ìi8;T;;î;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;= ;3I" overload;F;40;;î;50;)I"new(args, ...);T;IC;";T; @·ª;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @·ª;[;I"@return [Object];T;0;6i;[[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-;&i5;'@Šª;(I"ÖVALUE rb_class_new_instance_pass_kw(int argc, const VALUE *argv, VALUE klass) { VALUE obj; obj = rb_class_alloc(klass); rb_obj_call_init_kw(obj, argc, argv, RB_PASS_CALLED_KEYWORDS); return obj; };T;)I" VALUE;T;*To;;F; ;;;;I"Class#initialize;F;[[@c0;[[@Ìiª;T;;Ð;0;[;{;IC;"}Creates a new anonymous (unnamed) class with the given superclass (or Object if no parameter is given). You can give a class a name by assigning the class object to a constant. If a block is given, it is passed the class object, and the block is evaluated in the context of this class like #class_eval. fred = Class.new do def meth1 "hello" end def meth2 "bye" end end a = fred.new #=> #<#:0x100376b98> a.meth1 #=> "hello" a.meth2 #=> "bye" Assign the class to a constant (name starting uppercase) if you want to treat it like a regular class. ;T;[o;= ;3I" overload;F;40;;î;50;)I"new(super_class=Object);T;IC;";T; @×ª;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Class;T; @×ª;[;I"@return [Class];T;0;6i;[[I"super_class;TI"Object;T; @×ªo;= ;3I" overload;F;40;;î;50;)I"new(super_class=Object);T;IC;";T; @×ª;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"mod;T; @×ªo;2 ;3I"return;F;4I";T;0;5[I" Class;T; @×ª;[;I"!@yield [mod] @return [Class];T;0;6i;[[I"super_class;TI"Object;T; @×ª;[;I"öCreates a new anonymous (unnamed) class with the given superclass (or Object if no parameter is given). You can give a class a name by assigning the class object to a constant. If a block is given, it is passed the class object, and the block is evaluated in the context of this class like #class_eval. fred = Class.new do def meth1 "hello" end def meth2 "bye" end end a = fred.new #=> #<#:0x100376b98> a.meth1 #=> "hello" a.meth2 #=> "bye" Assign the class to a constant (name starting uppercase) if you want to treat it like a regular class. @overload new(super_class=Object) @return [Class] @overload new(super_class=Object) @yield [mod] @return [Class];T;0; @×ª;!F;"o;#;$T;%iŒ;&i©;'@Šª;(I"“static VALUE rb_class_initialize(int argc, VALUE *argv, VALUE klass) { VALUE super; if (RCLASS_SUPER(klass) != 0 || klass == rb_cBasicObject) { rb_raise(rb_eTypeError, "already initialized class"); } if (rb_check_arity(argc, 0, 1) == 0) { super = rb_cObject; } else { super = argv[0]; rb_check_inheritable(super); if (super != rb_cBasicObject && !RCLASS_SUPER(super)) { rb_raise(rb_eTypeError, "can't inherit uninitialized class"); } } RCLASS_SET_SUPER(klass, super); rb_make_metaclass(klass, RBASIC(super)->klass); rb_class_inherited(super, klass); rb_mod_initialize(klass); return klass; };T;)I"static VALUE;T;*To;;F; ;;;;I"Class#superclass;F;[;[[@Ìi‚;T;:superclass;0;[;{;IC;"fReturns the superclass of class, or nil. File.superclass #=> IO IO.superclass #=> Object Object.superclass #=> BasicObject class Foo; end class Bar < Foo; end Bar.superclass #=> Foo Returns nil when the given class does not have a parent class: BasicObject.superclass #=> nil ;T;[o;= ;3I" overload;F;40;;;50;)I"superclass;T;IC;";T; @«;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @«;[;I"@return [nil];T;0;6i;[; @«;[;I"Returns the superclass of class, or nil. File.superclass #=> IO IO.superclass #=> Object Object.superclass #=> BasicObject class Foo; end class Bar < Foo; end Bar.superclass #=> Foo Returns nil when the given class does not have a parent class: BasicObject.superclass #=> nil @overload superclass @return [nil];T;0; @«;!F;"o;#;$T;%ig;&ix;'@Šª;(I"LVALUE rb_class_superclass(VALUE klass) { VALUE super = RCLASS_SUPER(klass); if (!super) { if (klass == rb_cBasicObject) return Qnil; rb_raise(rb_eTypeError, "uninitialized class"); } while (RB_TYPE_P(super, T_ICLASS)) { super = RCLASS_SUPER(super); } if (!super) { return Qnil; } return super; };T;)I" VALUE;T;*T;A@Šª;BIC;[;A@Šª;CIC;[;A@Šª;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@Ìiì[@i’[@Ìi‘;T;: Class;;K;;;[;{;IC;"MClasses in Ruby are first-class objects---each is an instance of class Class. Typically, you create a new class by using: class Name # some code describing the class behavior end When a new class is created, an object of type Class is initialized and assigned to a global constant (Name in this case). When Name.new is called to create a new object, the #new method in Class is run by default. This can be demonstrated by overriding #new in Class: class Class alias old_new new def new(*args) print "Creating a new ", self.name, "\n" old_new(*args) end end class Name end n = Name.new produces: Creating a new Name Classes, modules, and objects are interrelated. In the diagram that follows, the vertical arrows represent inheritance, and the parentheses metaclasses. All metaclasses are instances of the class `Class'. +---------+ +-... | | | BasicObject-----|-->(BasicObject)-------|-... ^ | ^ | | | | | Object---------|----->(Object)---------|-... ^ | ^ | | | | | +-------+ | +--------+ | | | | | | | | Module-|---------|--->(Module)-|-... | ^ | | ^ | | | | | | | | Class-|---------|---->(Class)-|-... | ^ | | ^ | | +---+ | +----+ | | obj--->OtherClass---------->(OtherClass)-----------...;T;[;[;I"P Classes in Ruby are first-class objects---each is an instance of class Class. Typically, you create a new class by using: class Name # some code describing the class behavior end When a new class is created, an object of type Class is initialized and assigned to a global constant (Name in this case). When Name.new is called to create a new object, the #new method in Class is run by default. This can be demonstrated by overriding #new in Class: class Class alias old_new new def new(*args) print "Creating a new ", self.name, "\n" old_new(*args) end end class Name end n = Name.new produces: Creating a new Name Classes, modules, and objects are interrelated. In the diagram that follows, the vertical arrows represent inheritance, and the parentheses metaclasses. All metaclasses are instances of the class `Class'. +---------+ +-... | | | BasicObject-----|-->(BasicObject)-------|-... ^ | ^ | | | | | Object---------|----->(Object)---------|-... ^ | ^ | | | | | +-------+ | +--------+ | | | | | | | | Module-|---------|--->(Module)-|-... | ^ | | ^ | | | | | | | | Class-|---------|---->(Class)-|-... | ^ | | ^ | | +---+ | +----+ | | obj--->OtherClass---------->(OtherClass)-----------... ;T;0; @Šª;!F;"o;#;$T;%iì;&i%;6i;'@;I" Class;F;S@ªHo; ;IC;[o; ;IC;[ o;;F; ;;;Ï;I""Racc::Parser#_racc_do_parse_c;F;[[I"arg;T0[I" sysdebug;T0;[[I"ext/racc/cparse/cparse.c;Tiñ;T;:_racc_do_parse_c;0;[;{;IC;";T;[;[;@|;0; @=«;'@;«;(I"Østatic VALUE racc_cparse(VALUE parser, VALUE arg, VALUE sysdebug) { VALUE vparams; struct cparse_params *v; vparams = TypedData_Make_Struct(CparseParams, struct cparse_params, &cparse_params_type, v); D_puts("starting cparse"); v->sys_debug = RTEST(sysdebug); vparams = initialize_params(vparams, parser, arg, Qnil, Qnil); v->lex_is_iterator = FALSE; parse_main(v, Qnil, Qnil, 0); RB_GC_GUARD(vparams); return v->retval; };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"!Racc::Parser#_racc_yyparse_c;F;[ [I" lexer;T0[I"lexmid;T0[I"arg;T0[I" sysdebug;T0;[[@F«i;T;:_racc_yyparse_c;0;[;{;IC;";T;[;[;@|;0; @N«;'@;«;(I"²static VALUE racc_yyparse(VALUE parser, VALUE lexer, VALUE lexmid, VALUE arg, VALUE sysdebug) { VALUE vparams; struct cparse_params *v; vparams = TypedData_Make_Struct(CparseParams, struct cparse_params, &cparse_params_type, v); v->sys_debug = RTEST(sysdebug); D_puts("start C yyparse"); vparams = initialize_params(vparams, parser, arg, lexer, lexmid); v->lex_is_iterator = TRUE; D_puts("params initialized"); parse_main(v, Qnil, Qnil, 0); call_lexer(v); if (!v->fin) { rb_raise(rb_eArgError, "%s() is finished before EndOfToken", rb_id2name(v->lexmid)); } RB_GC_GUARD(vparams); return v->retval; };T;)I"static VALUE;T;*To;{;[[@F«iG;F;: Racc_Runtime_Core_Version_C;;};;;[;{;IC;";T;[;[;@|;0; @b«;'@;«;I".Racc::Parser::Racc_Runtime_Core_Version_C;F;~I"rb_str_new2(RACC_VERSION);To;{;[[@F«iI;F;:Racc_Runtime_Core_Id_C;;};;;[;{;IC;";T;[;[;@|;0; @l«;'@;«;I")Racc::Parser::Racc_Runtime_Core_Id_C;F;~I"Prb_str_new2("$originalId: cparse.c,v 1.8 2006/07/06 11:39:46 aamine Exp $");T;A@;«;BIC;[;A@;«;CIC;[;A@;«;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@F«iC;F;:Parser;;K;;;[;{;IC;";T;[;[;@|;0; @;«;'@9«;I"Racc::Parser;F;S@]o; ;IC;[;A@…«;BIC;[;A@…«;CIC;[;A@…«;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@F«iL;F;:CparseParams;;K;;;[;{;IC;";T;[;[;@|;0; @…«;'@9«;I"Racc::CparseParams;F;S@];A@9«;BIC;[;A@9«;CIC;[;A@9«;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@F«iB;F;: Racc;;K;;;[;{;IC;";T;[;[;@|;0; @9«;'@;I" Racc;Fo; ;IC;[o;;F; ;;;;I"MatchData#initialize_copy;F;[[I" orig;T0;[[I" re.c;Ti#;T;;g;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @§«;!F;"o;#;$T;%i";&i";'@¥«;(I"static VALUE match_init_copy(VALUE obj, VALUE orig) { struct rmatch *rm; if (!OBJ_INIT_COPY(obj, orig)) return obj; RMATCH(obj)->str = RMATCH(orig)->str; RMATCH(obj)->regexp = RMATCH(orig)->regexp; rm = RMATCH(obj)->rmatch; if (rb_reg_region_copy(&rm->regs, RMATCH_REGS(orig))) rb_memerror(); if (RMATCH(orig)->rmatch->char_offset_num_allocated) { if (rm->char_offset_num_allocated < rm->regs.num_regs) { REALLOC_N(rm->char_offset, struct rmatch_offset, rm->regs.num_regs); rm->char_offset_num_allocated = rm->regs.num_regs; } MEMCPY(rm->char_offset, RMATCH(orig)->rmatch->char_offset, struct rmatch_offset, rm->regs.num_regs); RB_GC_GUARD(orig); } return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"MatchData#regexp;F;[;[[@®«iI;T;:regexp;0;[;{;IC;"MReturns the regexp. m = /a.*b/.match("abc") m.regexp #=> /a.*b/ ;T;[o;= ;3I" overload;F;40;;;50;)I"regexp;T;IC;";T; @¸«;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Regexp;T; @¸«;[;I"@return [Regexp];T;0;6i;[; @¸«;[;I"sReturns the regexp. m = /a.*b/.match("abc") m.regexp #=> /a.*b/ @overload regexp @return [Regexp];T;0; @¸«;!F;"o;#;$T;%i?;&iF;'@¥«;(I"!static VALUE match_regexp(VALUE match) { VALUE regexp; match_check(match); regexp = RMATCH(match)->regexp; if (NIL_P(regexp)) { VALUE str = rb_reg_nth_match(0, match); regexp = rb_reg_regcomp(rb_reg_quote(str)); RMATCH(match)->regexp = regexp; } return regexp; };T;)I"static VALUE;T;*To;;F; ;;;;I"MatchData#names;F;[;[[@®«ie;T;;Ñ;0;[;{;IC;",Returns a list of names of captures as an array of strings. It is same as mtch.regexp.names. /(?.)(?.)(?.)/.match("hoge").names #=> ["foo", "bar", "baz"] m = /(?.)(?.)?/.match("a") #=> # m.names #=> ["x", "y"] ;T;[o;= ;3I" overload;F;40;;Ñ;50;)I" names;T;IC;";T; @Ó«;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @Ó«;[;I"@return [Array];T;0;6i;[; @Ó«;[;I"PReturns a list of names of captures as an array of strings. It is same as mtch.regexp.names. /(?.)(?.)(?.)/.match("hoge").names #=> ["foo", "bar", "baz"] m = /(?.)(?.)?/.match("a") #=> # m.names #=> ["x", "y"] @overload names @return [Array];T;0; @Ó«;!F;"o;#;$T;%iW;&ib;'@¥«;(I"³static VALUE match_names(VALUE match) { match_check(match); if (NIL_P(RMATCH(match)->regexp)) return rb_ary_new_capa(0); return rb_reg_names(RMATCH(match)->regexp); };T;)I"static VALUE;T;*To;;F; ;;;;I"MatchData#size;F;[;[[@®«iz;T;;¯;0;[;{;IC;"†Returns the number of elements in the match array. m = /(.)(.)(\d+)(\d)/.match("THX1138.") m.length #=> 5 m.size #=> 5 ;T;[o;= ;3I" overload;F;40;;°;50;)I"length;T;IC;";T; @î«;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @î«;[;I"@return [Integer];T;0;6i;[; @î«o;= ;3I" overload;F;40;;¯;50;)I" size;T;IC;";T; @î«;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @î«;[;I"@return [Integer];T;0;6i;[; @î«;[;I"ÐReturns the number of elements in the match array. m = /(.)(.)(\d+)(\d)/.match("THX1138.") m.length #=> 5 m.size #=> 5 @overload length @return [Integer] @overload size @return [Integer];T;0; @î«;!F;"o;#;$T;%in;&ix;'@¥«;(I"wstatic VALUE match_size(VALUE match) { match_check(match); return INT2FIX(RMATCH_REGS(match)->num_regs); };T;)I"static VALUE;T;*To;;F; ;;;;I"MatchData#length;F;[;[[@®«iz;T;;°;0;[;{;IC;"†Returns the number of elements in the match array. m = /(.)(.)(\d+)(\d)/.match("THX1138.") m.length #=> 5 m.size #=> 5 ;T;[o;= ;3I" overload;F;40;;°;50;)I"length;T;IC;";T; @¬;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¬;[;I"@return [Integer];T;0;6i;[; @¬o;= ;3I" overload;F;40;;¯;50;)I" size;T;IC;";T; @¬;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¬;[;I"@return [Integer];T;0;6i;[; @¬;[;@¬;0; @¬;!F;"o;#;$T;%in;&ix;'@¥«;(I"wstatic VALUE match_size(VALUE match) { match_check(match); return INT2FIX(RMATCH_REGS(match)->num_regs); };T;)I"static VALUE;T;*To;;F; ;;;;I"MatchData#offset;F;[[I"n;T0;[[@®«i¾;T;:offset;0;[;{;IC;"{Returns a two-element array containing the beginning and ending offsets of the nth match. n can be a string or symbol to reference a named capture. m = /(.)(.)(\d+)(\d)/.match("THX1138.") m.offset(0) #=> [1, 7] m.offset(4) #=> [6, 7] m = /(?.)(.)(?.)/.match("hoge") p m.offset(:foo) #=> [0, 1] p m.offset(:bar) #=> [2, 3] ;T;[o;= ;3I" overload;F;40;;;50;)I"offset(n);T;IC;";T; @=¬;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @=¬;[;I"@return [Array];T;0;6i;[[I"n;T0; @=¬;[;I"¤Returns a two-element array containing the beginning and ending offsets of the nth match. n can be a string or symbol to reference a named capture. m = /(.)(.)(\d+)(\d)/.match("THX1138.") m.offset(0) #=> [1, 7] m.offset(4) #=> [6, 7] m = /(?.)(.)(?.)/.match("hoge") p m.offset(:foo) #=> [0, 1] p m.offset(:bar) #=> [2, 3] @overload offset(n) @return [Array];T;0; @=¬;!F;"o;#;$T;%i¬;&i»;'@¥«;(I"æstatic VALUE match_offset(VALUE match, VALUE n) { int i = match_backref_number(match, n); struct re_registers *regs = RMATCH_REGS(match); match_check(match); if (i < 0 || regs->num_regs <= i) rb_raise(rb_eIndexError, "index %d out of matches", i); if (BEG(i) < 0) return rb_assoc_new(Qnil, Qnil); update_char_offset(match); return rb_assoc_new(INT2FIX(RMATCH(match)->rmatch->char_offset[i].beg), INT2FIX(RMATCH(match)->rmatch->char_offset[i].end)); };T;)I"static VALUE;T;*To;;F; ;;;;I"MatchData#begin;F;[[I"n;T0;[[@®«iâ;T;;%;0;[;{;IC;"bReturns the offset of the start of the nth element of the match array in the string. n can be a string or symbol to reference a named capture. m = /(.)(.)(\d+)(\d)/.match("THX1138.") m.begin(0) #=> 1 m.begin(2) #=> 2 m = /(?.)(.)(?.)/.match("hoge") p m.begin(:foo) #=> 0 p m.begin(:bar) #=> 2 ;T;[o;= ;3I" overload;F;40;;%;50;)I" begin(n);T;IC;";T; @\¬;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @\¬;[;I"@return [Integer];T;0;6i;[[I"n;T0; @\¬;[;I"‹Returns the offset of the start of the nth element of the match array in the string. n can be a string or symbol to reference a named capture. m = /(.)(.)(\d+)(\d)/.match("THX1138.") m.begin(0) #=> 1 m.begin(2) #=> 2 m = /(?.)(.)(?.)/.match("hoge") p m.begin(:foo) #=> 0 p m.begin(:bar) #=> 2 @overload begin(n) @return [Integer];T;0; @\¬;!F;"o;#;$T;%iÑ;&iß;'@¥«;(I"Œstatic VALUE match_begin(VALUE match, VALUE n) { int i = match_backref_number(match, n); struct re_registers *regs = RMATCH_REGS(match); match_check(match); if (i < 0 || regs->num_regs <= i) rb_raise(rb_eIndexError, "index %d out of matches", i); if (BEG(i) < 0) return Qnil; update_char_offset(match); return INT2FIX(RMATCH(match)->rmatch->char_offset[i].beg); };T;)I"static VALUE;T;*To;;F; ;;;;I"MatchData#end;F;[[I"n;T0;[[@®«i;T;;&;0;[;{;IC;"„Returns the offset of the character immediately following the end of the nth element of the match array in the string. n can be a string or symbol to reference a named capture. m = /(.)(.)(\d+)(\d)/.match("THX1138.") m.end(0) #=> 7 m.end(2) #=> 3 m = /(?.)(.)(?.)/.match("hoge") p m.end(:foo) #=> 1 p m.end(:bar) #=> 3 ;T;[o;= ;3I" overload;F;40;;&;50;)I"end(n);T;IC;";T; @{¬;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @{¬;[;I"@return [Integer];T;0;6i;[[I"n;T0; @{¬;[;I"«Returns the offset of the character immediately following the end of the nth element of the match array in the string. n can be a string or symbol to reference a named capture. m = /(.)(.)(\d+)(\d)/.match("THX1138.") m.end(0) #=> 7 m.end(2) #=> 3 m = /(?.)(.)(?.)/.match("hoge") p m.end(:foo) #=> 1 p m.end(:bar) #=> 3 @overload end(n) @return [Integer];T;0; @{¬;!F;"o;#;$T;%iô;&i;'@¥«;(I"Šstatic VALUE match_end(VALUE match, VALUE n) { int i = match_backref_number(match, n); struct re_registers *regs = RMATCH_REGS(match); match_check(match); if (i < 0 || regs->num_regs <= i) rb_raise(rb_eIndexError, "index %d out of matches", i); if (BEG(i) < 0) return Qnil; update_char_offset(match); return INT2FIX(RMATCH(match)->rmatch->char_offset[i].end); };T;)I"static VALUE;T;*To;;F; ;;;;I"MatchData#to_a;F;[;[[@®«ik;T;;!;0;[;{;IC;"ûReturns the array of matches. m = /(.)(.)(\d+)(\d)/.match("THX1138.") m.to_a #=> ["HX1138", "H", "X", "113", "8"] Because to_a is called when expanding *variable, there's a useful assignment shortcut for extracting matched fields. This is slightly slower than accessing the fields directly (as an intermediate array is generated). all,f1,f2,f3 = * /(.)(.)(\d+)(\d)/.match("THX1138.") all #=> "HX1138" f1 #=> "H" f2 #=> "X" f3 #=> "113" ;T;[o;= ;3I" overload;F;40;;!;50;)I" to_a;T;IC;";T; @š¬;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @š¬;[;I"@return [Array];T;0;6i;[; @š¬;[;I"Returns the array of matches. m = /(.)(.)(\d+)(\d)/.match("THX1138.") m.to_a #=> ["HX1138", "H", "X", "113", "8"] Because to_a is called when expanding *variable, there's a useful assignment shortcut for extracting matched fields. This is slightly slower than accessing the fields directly (as an intermediate array is generated). all,f1,f2,f3 = * /(.)(.)(\d+)(\d)/.match("THX1138.") all #=> "HX1138" f1 #=> "H" f2 #=> "X" f3 #=> "113" @overload to_a @return [Array];T;0; @š¬;!F;"o;#;$T;%iU;&ih;'@¥«;(I"Ostatic VALUE match_to_a(VALUE match) { return match_array(match, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"MatchData#[];F;[[@c0;[[@®«iã;T;;Â;0;[;{;IC;"çMatch Reference -- MatchData acts as an array, and may be accessed using the normal array indexing techniques. mtch[0] is equivalent to the special variable $&, and returns the entire matched string. mtch[1], mtch[2], and so on return the values of the matched backreferences (portions of the pattern between parentheses). m = /(.)(.)(\d+)(\d)/.match("THX1138.") m #=> # m[0] #=> "HX1138" m[1, 2] #=> ["H", "X"] m[1..3] #=> ["H", "X", "113"] m[-3, 2] #=> ["X", "113"] m = /(?a+)b/.match("ccaaab") m #=> # m["foo"] #=> "aaa" m[:foo] #=> "aaa" ;T;[ o;= ;3I" overload;F;40;;Â;50;)I" [](i);T;IC;";T; @µ¬;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @µ¬;[;I"@return [String, nil];T;0;6i;[[I"i;T0; @µ¬o;= ;3I" overload;F;40;;Â;50;)I"[](start, length);T;IC;";T; @µ¬;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @µ¬;[;I"@return [Array];T;0;6i;[[I" start;T0[I"length;T0; @µ¬o;= ;3I" overload;F;40;;Â;50;)I"[](range);T;IC;";T; @µ¬;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @µ¬;[;I"@return [Array];T;0;6i;[[I" range;T0; @µ¬o;= ;3I" overload;F;40;;Â;50;)I" [](name);T;IC;";T; @µ¬;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @µ¬;[;I"@return [String, nil];T;0;6i;[[I" name;T0; @µ¬;[;I"Match Reference -- MatchData acts as an array, and may be accessed using the normal array indexing techniques. mtch[0] is equivalent to the special variable $&, and returns the entire matched string. mtch[1], mtch[2], and so on return the values of the matched backreferences (portions of the pattern between parentheses). m = /(.)(.)(\d+)(\d)/.match("THX1138.") m #=> # m[0] #=> "HX1138" m[1, 2] #=> ["H", "X"] m[1..3] #=> ["H", "X", "113"] m[-3, 2] #=> ["X", "113"] m = /(?a+)b/.match("ccaaab") m #=> # m["foo"] #=> "aaa" m[:foo] #=> "aaa" @overload [](i) @return [String, nil] @overload [](start, length) @return [Array] @overload [](range) @return [Array] @overload [](name) @return [String, nil];T;0; @µ¬;!F;"o;#;$T;%iÈ;&iã;'@¥«;(I"xstatic VALUE match_aref(int argc, VALUE *argv, VALUE match) { VALUE idx, length; match_check(match); rb_scan_args(argc, argv, "11", &idx, &length); if (NIL_P(length)) { if (FIXNUM_P(idx)) { return rb_reg_nth_match(FIX2INT(idx), match); } else { int num = namev_to_backref_number(RMATCH_REGS(match), RMATCH(match)->regexp, idx); if (num >= 0) { return rb_reg_nth_match(num, match); } else { return match_ary_aref(match, idx, Qnil); } } } else { long beg = NUM2LONG(idx); long len = NUM2LONG(length); long num_regs = RMATCH_REGS(match)->num_regs; if (len < 0) { return Qnil; } if (beg < 0) { beg += num_regs; if (beg < 0) return Qnil; } else if (beg > num_regs) { return Qnil; } else if (beg+len > num_regs) { len = num_regs - beg; } return match_ary_subseq(match, beg, len, Qnil); } };T;)I"static VALUE;T;*To;;F; ;;;;I"MatchData#captures;F;[;[[@®«i~;T;: captures;0;[;{;IC;"ÐReturns the array of captures; equivalent to mtch.to_a[1..-1]. f1,f2,f3,f4 = /(.)(.)(\d+)(\d)/.match("THX1138.").captures f1 #=> "H" f2 #=> "X" f3 #=> "113" f4 #=> "8" ;T;[o;= ;3I" overload;F;40;;;50;)I" captures;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @;[;I"@return [Array];T;0;6i;[; @;[;I"÷Returns the array of captures; equivalent to mtch.to_a[1..-1]. f1,f2,f3,f4 = /(.)(.)(\d+)(\d)/.match("THX1138.").captures f1 #=> "H" f2 #=> "X" f3 #=> "113" f4 #=> "8" @overload captures @return [Array];T;0; @;!F;"o;#;$T;%ir;&i|;'@¥«;(I"Sstatic VALUE match_captures(VALUE match) { return match_array(match, 1); };T;)I"static VALUE;T;*To;;F; ;;;;I"MatchData#named_captures;F;[;[[@®«i;T;:named_captures;0;[;{;IC;"êReturns a Hash using named capture. A key of the hash is a name of the named captures. A value of the hash is a string of last successful capture of corresponding group. m = /(?.)(?.)/.match("01") m.named_captures #=> {"a" => "0", "b" => "1"} m = /(?.)(?.)?/.match("0") m.named_captures #=> {"a" => "0", "b" => nil} m = /(?.)(?.)/.match("01") m.named_captures #=> {"a" => "1"} m = /(?x)|(?y)/.match("x") m.named_captures #=> {"a" => "x"} ;T;[o;= ;3I" overload;F;40;;;50;)I"named_captures;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @;[;I"@return [Hash];T;0;6i;[; @;[;I"Returns a Hash using named capture. A key of the hash is a name of the named captures. A value of the hash is a string of last successful capture of corresponding group. m = /(?.)(?.)/.match("01") m.named_captures #=> {"a" => "0", "b" => "1"} m = /(?.)(?.)?/.match("0") m.named_captures #=> {"a" => "0", "b" => nil} m = /(?.)(?.)/.match("01") m.named_captures #=> {"a" => "1"} m = /(?x)|(?y)/.match("x") m.named_captures #=> {"a" => "x"} @overload named_captures @return [Hash];T;0; @;!F;"o;#;$T;%ij;&i~;'@¥«;(I"fstatic VALUE match_named_captures(VALUE match) { VALUE hash; struct MEMO *memo; match_check(match); if (NIL_P(RMATCH(match)->regexp)) return rb_hash_new(); hash = rb_hash_new(); memo = MEMO_NEW(hash, match, 0); onig_foreach_name(RREGEXP(RMATCH(match)->regexp)->ptr, match_named_captures_iter, (void*)memo); return hash; };T;)I"static VALUE;T;*To;;F; ;;;;I"MatchData#values_at;F;[[@c0;[[@®«i;T;;º;0;[;{;IC;"³Uses each index to access the matching values, returning an array of the corresponding matches. m = /(.)(.)(\d+)(\d)/.match("THX1138: The Movie") m.to_a #=> ["HX1138", "H", "X", "113", "8"] m.values_at(0, 2, -2) #=> ["HX1138", "X", "113"] m = /(?\d+) *(?[+\-*\/]) *(?\d+)/.match("1 + 2") m.to_a #=> ["1 + 2", "1", "+", "2"] m.values_at(:a, :b, :op) #=> ["1", "2", "+"] ;T;[o;= ;3I" overload;F;40;;º;50;)I"values_at(index, ...);T;IC;";T; @:;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @:;[;I"@return [Array];T;0;6i;[[I" index;T0[I"...;T0; @:;[;I"çUses each index to access the matching values, returning an array of the corresponding matches. m = /(.)(.)(\d+)(\d)/.match("THX1138: The Movie") m.to_a #=> ["HX1138", "H", "X", "113", "8"] m.values_at(0, 2, -2) #=> ["HX1138", "X", "113"] m = /(?\d+) *(?[+\-*\/]) *(?\d+)/.match("1 + 2") m.to_a #=> ["1 + 2", "1", "+", "2"] m.values_at(:a, :b, :op) #=> ["1", "2", "+"] @overload values_at(index, ...) @return [Array];T;0; @:;!F;"o;#;$T;%i;&i;'@¥«;(I"(static VALUE match_values_at(int argc, VALUE *argv, VALUE match) { VALUE result; int i; match_check(match); result = rb_ary_new2(argc); for (i=0; iregexp, argv[i]); if (num >= 0) { rb_ary_push(result, rb_reg_nth_match(num, match)); } else { match_ary_aref(match, argv[i], result); } } } return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"MatchData#pre_match;F;[;[[@®«iç;T;:pre_match;0;[;{;IC;"½Returns the portion of the original string before the current match. Equivalent to the special variable $`. m = /(.)(.)(\d+)(\d)/.match("THX1138.") m.pre_match #=> "T" ;T;[o;= ;3I" overload;F;40;;;50;)I"pre_match;T;IC;";T; @Z;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Z;[;I"@return [String];T;0;6i;[; @Z;[;I"æReturns the portion of the original string before the current match. Equivalent to the special variable $`. m = /(.)(.)(\d+)(\d)/.match("THX1138.") m.pre_match #=> "T" @overload pre_match @return [String];T;0; @Z;!F;"o;#;$T;%iÜ;&iä;'@¥«;(I"VALUE rb_reg_match_pre(VALUE match) { VALUE str; struct re_registers *regs; if (NIL_P(match)) return Qnil; match_check(match); regs = RMATCH_REGS(match); if (BEG(0) == -1) return Qnil; str = rb_str_subseq(RMATCH(match)->str, 0, BEG(0)); return str; };T;)I" VALUE;T;*To;;F; ;;;;I"MatchData#post_match;F;[;[[@®«i;T;:post_match;0;[;{;IC;"ÑReturns the portion of the original string after the current match. Equivalent to the special variable $'. m = /(.)(.)(\d+)(\d)/.match("THX1138: The Movie") m.post_match #=> ": The Movie" ;T;[o;= ;3I" overload;F;40;; ;50;)I"post_match;T;IC;";T; @u;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @u;[;I"@return [String];T;0;6i;[; @u;[;I"ûReturns the portion of the original string after the current match. Equivalent to the special variable $'. m = /(.)(.)(\d+)(\d)/.match("THX1138: The Movie") m.post_match #=> ": The Movie" @overload post_match @return [String];T;0; @u;!F;"o;#;$T;%iö;&iþ;'@¥«;(I"]VALUE rb_reg_match_post(VALUE match) { VALUE str; long pos; struct re_registers *regs; if (NIL_P(match)) return Qnil; match_check(match); regs = RMATCH_REGS(match); if (BEG(0) == -1) return Qnil; str = RMATCH(match)->str; pos = END(0); str = rb_str_subseq(str, pos, RSTRING_LEN(str) - pos); return str; };T;)I" VALUE;T;*To;;F; ;;;;I"MatchData#to_s;F;[;[[@®«iD;T;;q;0;[;{;IC;"lReturns the entire matched string. m = /(.)(.)(\d+)(\d)/.match("THX1138.") m.to_s #=> "HX1138" ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @;[;I"@return [String];T;0;6i;[; @;[;I"‹Returns the entire matched string. m = /(.)(.)(\d+)(\d)/.match("THX1138.") m.to_s #=> "HX1138" @overload to_s @return [String];T;0; @;!F;"o;#;$T;%i:;&iA;'@¥«;(I"¦static VALUE match_to_s(VALUE match) { VALUE str = rb_reg_last_match(match); match_check(match); if (NIL_P(str)) str = rb_str_new(0,0); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"MatchData#inspect;F;[;[[@®«iË;T;;r;0;[;{;IC;"ˆReturns a printable version of mtch. puts /.$/.match("foo").inspect #=> # puts /(.)(.)(.)/.match("foo").inspect #=> # puts /(.)(.)?(.)/.match("fo").inspect #=> # puts /(?.)(?.)(?.)/.match("hoge").inspect #=> # ;T;[o;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @«;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @«;[;I"@return [String];T;0;6i;[; @«;[;I"°Returns a printable version of mtch. puts /.$/.match("foo").inspect #=> # puts /(.)(.)(.)/.match("foo").inspect #=> # puts /(.)(.)?(.)/.match("fo").inspect #=> # puts /(?.)(?.)(?.)/.match("hoge").inspect #=> # @overload inspect @return [String];T;0; @«;!F;"o;#;$T;%i·;&iÈ;'@¥«;(I"Tstatic VALUE match_inspect(VALUE match) { VALUE cname = rb_class_path(rb_obj_class(match)); VALUE str; int i; struct re_registers *regs = RMATCH_REGS(match); int num_regs = regs->num_regs; struct backref_name_tag *names; VALUE regexp = RMATCH(match)->regexp; if (regexp == 0) { return rb_sprintf("#<%"PRIsVALUE":%p>", cname, (void*)match); } else if (NIL_P(regexp)) { return rb_sprintf("#<%"PRIsVALUE": %"PRIsVALUE">", cname, rb_reg_nth_match(0, match)); } names = ALLOCA_N(struct backref_name_tag, num_regs); MEMZERO(names, struct backref_name_tag, num_regs); onig_foreach_name(RREGEXP_PTR(regexp), match_inspect_name_iter, names); str = rb_str_buf_new2("#<"); rb_str_append(str, cname); for (i = 0; i < num_regs; i++) { VALUE v; rb_str_buf_cat2(str, " "); if (0 < i) { if (names[i].name) rb_str_buf_cat(str, (const char *)names[i].name, names[i].len); else { rb_str_catf(str, "%d", i); } rb_str_buf_cat2(str, ":"); } v = rb_reg_nth_match(i, match); if (v == Qnil) rb_str_buf_cat2(str, "nil"); else rb_str_buf_append(str, rb_str_inspect(v)); } rb_str_buf_cat2(str, ">"); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"MatchData#string;F;[;[[@®«i;T;:string;0;[;{;IC;"Returns a frozen copy of the string passed in to match. m = /(.)(.)(\d+)(\d)/.match("THX1138.") m.string #=> "THX1138." ;T;[o;= ;3I" overload;F;40;;!;50;)I"string;T;IC;";T; @Æ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Æ;[;I"@return [String];T;0;6i;[; @Æ;[;I"³Returns a frozen copy of the string passed in to match. m = /(.)(.)(\d+)(\d)/.match("THX1138.") m.string #=> "THX1138." @overload string @return [String];T;0; @Æ;!F;"o;#;$T;%i“;&iš;'@¥«;(I"zstatic VALUE match_string(VALUE match) { match_check(match); return RMATCH(match)->str; /* str is frozen */ };T;)I"static VALUE;T;*To;;F; ;;;;I"MatchData#hash;F;[;[[@®«iø;T;;b;0;[;{;IC;"vProduce a hash based on the target string, regexp and matched positions of this matchdata. See also Object#hash. ;T;[o;= ;3I" overload;F;40;;b;50;)I" hash;T;IC;";T; @á;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @á;[;I"@return [Integer];T;0;6i;[; @á;[;I"–Produce a hash based on the target string, regexp and matched positions of this matchdata. See also Object#hash. @overload hash @return [Integer];T;0; @á;!F;"o;#;$T;%iî;&iõ;'@¥«;(I"Vstatic VALUE match_hash(VALUE match) { const struct re_registers *regs; st_index_t hashval; match_check(match); hashval = rb_hash_start(rb_str_hash(RMATCH(match)->str)); hashval = rb_hash_uint(hashval, reg_hash(match_regexp(match))); regs = RMATCH_REGS(match); hashval = rb_hash_uint(hashval, regs->num_regs); hashval = rb_hash_uint(hashval, rb_memhash(regs->beg, regs->num_regs * sizeof(*regs->beg))); hashval = rb_hash_uint(hashval, rb_memhash(regs->end, regs->num_regs * sizeof(*regs->end))); hashval = rb_hash_end(hashval); return ST2FIX(hashval); };T;)I"static VALUE;T;*To;;F; ;;;;I"MatchData#eql?;F;[[I"match2;T0;[[@®«i;T;;_;0;[;{;IC;"pEquality---Two matchdata are equal if their target strings, patterns, and matched positions are identical.;T;[o;= ;3I" overload;F;40;;`;50;)I"==(mtch2);T;IC;";T; @ü;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ü;[;I"@return [Boolean];T;0;6i;[[I" mtch2;T0; @üo;= ;3I" overload;F;40;;_;50;)I"eql?(mtch2);T;IC;";T; @ü;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ü;[;I"@return [Boolean];T;0;6i;[[I" mtch2;T0; @ü;[;I"À Equality---Two matchdata are equal if their target strings, patterns, and matched positions are identical. @overload ==(mtch2) @return [Boolean] @overload eql?(mtch2) @return [Boolean];T;0; @ü;!F;"o;#;$T;%i ;&i;6i;'@¥«;(I"ûstatic VALUE match_equal(VALUE match1, VALUE match2) { const struct re_registers *regs1, *regs2; if (match1 == match2) return Qtrue; if (!RB_TYPE_P(match2, T_MATCH)) return Qfalse; if (!RMATCH(match1)->regexp || !RMATCH(match2)->regexp) return Qfalse; if (!rb_str_equal(RMATCH(match1)->str, RMATCH(match2)->str)) return Qfalse; if (!rb_reg_equal(match_regexp(match1), match_regexp(match2))) return Qfalse; regs1 = RMATCH_REGS(match1); regs2 = RMATCH_REGS(match2); if (regs1->num_regs != regs2->num_regs) return Qfalse; if (memcmp(regs1->beg, regs2->beg, regs1->num_regs * sizeof(*regs1->beg))) return Qfalse; if (memcmp(regs1->end, regs2->end, regs1->num_regs * sizeof(*regs1->end))) return Qfalse; return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"MatchData#==;F;[[I"match2;T0;[[@®«i;T;;`;0;[;{;IC;"pEquality---Two matchdata are equal if their target strings, patterns, and matched positions are identical. ;T;[o;= ;3I" overload;F;40;;`;50;)I"==(mtch2);T;IC;";T; @*®;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @*®;[;I"@return [Boolean];T;0;6i;[[I" mtch2;T0; @*®o;= ;3I" overload;F;40;;_;50;)I"eql?(mtch2);T;IC;";T; @*®;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @*®;[;I"@return [Boolean];T;0;6i;[[I" mtch2;T0; @*®;[;@&®;0; @*®;!F;"o;#;$T;%i ;&i;'@¥«;(I"ûstatic VALUE match_equal(VALUE match1, VALUE match2) { const struct re_registers *regs1, *regs2; if (match1 == match2) return Qtrue; if (!RB_TYPE_P(match2, T_MATCH)) return Qfalse; if (!RMATCH(match1)->regexp || !RMATCH(match2)->regexp) return Qfalse; if (!rb_str_equal(RMATCH(match1)->str, RMATCH(match2)->str)) return Qfalse; if (!rb_reg_equal(match_regexp(match1), match_regexp(match2))) return Qfalse; regs1 = RMATCH_REGS(match1); regs2 = RMATCH_REGS(match2); if (regs1->num_regs != regs2->num_regs) return Qfalse; if (memcmp(regs1->beg, regs2->beg, regs1->num_regs * sizeof(*regs1->beg))) return Qfalse; if (memcmp(regs1->end, regs2->end, regs1->num_regs * sizeof(*regs1->end))) return Qfalse; return Qtrue; };T;)I"static VALUE;T;*T;A@¥«;BIC;[;A@¥«;CIC;[;A@¥«;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@®«i{[@®«i÷;T;:MatchData;;K;;;[;{;IC;"…MatchData encapsulates the result of matching a Regexp against string. It is returned by Regexp#match and String#match, and also stored in a global variable returned by Regexp.last_match. Usage: url = 'https://docs.ruby-lang.org/en/2.5.0/MatchData.html' m = url.match(/(\d\.?)+/) # => # m.string # => "https://docs.ruby-lang.org/en/2.5.0/MatchData.html" m.regexp # => /(\d\.?)+/ # entire matched substring: m[0] # => "2.5.0" # Working with unnamed captures m = url.match(%r{([^/]+)/([^/]+)\.html$}) m.captures # => ["2.5.0", "MatchData"] m[1] # => "2.5.0" m.values_at(1, 2) # => ["2.5.0", "MatchData"] # Working with named captures m = url.match(%r{(?[^/]+)/(?[^/]+)\.html$}) m.captures # => ["2.5.0", "MatchData"] m.named_captures # => {"version"=>"2.5.0", "module"=>"MatchData"} m[:version] # => "2.5.0" m.values_at(:version, :module) # => ["2.5.0", "MatchData"] # Numerical indexes are working, too m[1] # => "2.5.0" m.values_at(1, 2) # => ["2.5.0", "MatchData"] == Global variables equivalence Parts of last MatchData (returned by Regexp.last_match) are also aliased as global variables: * $~ is Regexp.last_match; * $& is Regexp.last_match[ 0 ]; * $1, $2, and so on are Regexp.last_match[ i ] (captures by number); * $` is Regexp.last_match.pre_match; * $' is Regexp.last_match.post_match; * $+ is Regexp.last_match[ -1 ] (the last capture). See also "Special global variables" section in Regexp documentation.;T;[;[;I"‡ MatchData encapsulates the result of matching a Regexp against string. It is returned by Regexp#match and String#match, and also stored in a global variable returned by Regexp.last_match. Usage: url = 'https://docs.ruby-lang.org/en/2.5.0/MatchData.html' m = url.match(/(\d\.?)+/) # => # m.string # => "https://docs.ruby-lang.org/en/2.5.0/MatchData.html" m.regexp # => /(\d\.?)+/ # entire matched substring: m[0] # => "2.5.0" # Working with unnamed captures m = url.match(%r{([^/]+)/([^/]+)\.html$}) m.captures # => ["2.5.0", "MatchData"] m[1] # => "2.5.0" m.values_at(1, 2) # => ["2.5.0", "MatchData"] # Working with named captures m = url.match(%r{(?[^/]+)/(?[^/]+)\.html$}) m.captures # => ["2.5.0", "MatchData"] m.named_captures # => {"version"=>"2.5.0", "module"=>"MatchData"} m[:version] # => "2.5.0" m.values_at(:version, :module) # => ["2.5.0", "MatchData"] # Numerical indexes are working, too m[1] # => "2.5.0" m.values_at(1, 2) # => ["2.5.0", "MatchData"] == Global variables equivalence Parts of last MatchData (returned by Regexp.last_match) are also aliased as global variables: * $~ is Regexp.last_match; * $& is Regexp.last_match[ 0 ]; * $1, $2, and so on are Regexp.last_match[ i ] (captures by number); * $` is Regexp.last_match.pre_match; * $' is Regexp.last_match.post_match; * $+ is Regexp.last_match[ -1 ] (the last capture). See also "Special global variables" section in Regexp documentation. ;T;0; @¥«;!F;"o;#;$T;%i{;&i¨;6i;'@;I"MatchData;F;S@]o; ;IC;[;A@i®;BIC;[;A@i®;CIC;[;A@i®;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@®«iŸ[@®«i¹;T;:RegexpError;;K;;;[;{;IC;"¤Raised when given an invalid regexp expression. Regexp.new("?") raises the exception: RegexpError: target of repeat operator is not specified: /?/ ;T;[;[;I"¦ Raised when given an invalid regexp expression. Regexp.new("?") raises the exception: RegexpError: target of repeat operator is not specified: /?/ ;T;0; @i®;!F;"o;#;$T;%iŸ;&i§;'@;I"RegexpError;F;So;L;M0;N0;O0;;ë;'@;Q@ì;R;Fo; ;IC;[#o;;F; ;F;;;I"Regexp.compile;F;[;[;F;:compile;;K;[;{;IC;"Alias for Regexp.new ;T;[;[;I" Alias for Regexp.new ;T;0; @€®;!F;"o;#;$T;%iL ;&iN ;'@~®;*To;;F; ;F;;;I"Regexp.quote;F;[[I"str;T0;[[@®«i;T;: quote;0;[;{;IC;"Escapes any characters that would have special meaning in a regular expression. Returns a new escaped string with the same or compatible encoding. For any string, Regexp.new(Regexp.escape(str))=~str will be true. Regexp.escape('\*?{}.') #=> \\\*\?\{\}\. ;T;[o;= ;3I" overload;F;40;:escape;50;)I"escape(str);T;IC;";T; @‹®;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @‹®;[;I"@return [String];T;0;6i;[[I"str;T0; @‹®o;= ;3I" overload;F;40;;%;50;)I"quote(str);T;IC;";T; @‹®;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @‹®;[;I"@return [String];T;0;6i;[[I"str;T0; @‹®;[;I"rEscapes any characters that would have special meaning in a regular expression. Returns a new escaped string with the same or compatible encoding. For any string, Regexp.new(Regexp.escape(str))=~str will be true. Regexp.escape('\*?{}.') #=> \\\*\?\{\}\. @overload escape(str) @return [String] @overload quote(str) @return [String];T;0; @‹®;!F;"o;#;$T;%iô ;&i;'@~®;(I"istatic VALUE rb_reg_s_quote(VALUE c, VALUE str) { return rb_reg_quote(reg_operand(str, TRUE)); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Regexp.escape;F;[[I"str;T0;[[@®«i;T;;&;0;[;{;IC;"Escapes any characters that would have special meaning in a regular expression. Returns a new escaped string with the same or compatible encoding. For any string, Regexp.new(Regexp.escape(str))=~str will be true. Regexp.escape('\*?{}.') #=> \\\*\?\{\}\. ;T;[o;= ;3I" overload;F;40;;&;50;)I"escape(str);T;IC;";T; @¹®;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @¹®;[;I"@return [String];T;0;6i;[[I"str;T0; @¹®o;= ;3I" overload;F;40;;%;50;)I"quote(str);T;IC;";T; @¹®;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @¹®;[;I"@return [String];T;0;6i;[[I"str;T0; @¹®;[;@µ®;0; @¹®;!F;"o;#;$T;%iô ;&i;'@~®;(I"istatic VALUE rb_reg_s_quote(VALUE c, VALUE str) { return rb_reg_quote(reg_operand(str, TRUE)); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Regexp.union;F;[[I" args;T0;[[@®«i¹;T;;;0;[;{;IC;"(Return a Regexp object that is the union of the given patterns, i.e., will match any of its parts. The patterns can be Regexp objects, in which case their options will be preserved, or Strings. If no patterns are given, returns /(?!)/. The behavior is unspecified if any given pattern contains capture. Regexp.union #=> /(?!)/ Regexp.union("penzance") #=> /penzance/ Regexp.union("a+b*c") #=> /a\+b\*c/ Regexp.union("skiing", "sledding") #=> /skiing|sledding/ Regexp.union(["skiing", "sledding"]) #=> /skiing|sledding/ Regexp.union(/dogs/, /cats/i) #=> /(?-mix:dogs)|(?i-mx:cats)/ Note: the arguments for ::union will try to be converted into a regular expression literal via #to_regexp. ;T;[o;= ;3I" overload;F;40;;;50;)I"union(pat1, pat2, ...);T;IC;";T; @æ®;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Regexp;T; @æ®;[;I"@return [Regexp];T;0;6i;[[I" pat1;T0[I" pat2;T0[I"...;T0; @æ®o;= ;3I" overload;F;40;;;50;)I"union(pats_ary);T;IC;";T; @æ®;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Regexp;T; @æ®;[;I"@return [Regexp];T;0;6i;[[I" pats_ary;T0; @æ®;[;I"‹Return a Regexp object that is the union of the given patterns, i.e., will match any of its parts. The patterns can be Regexp objects, in which case their options will be preserved, or Strings. If no patterns are given, returns /(?!)/. The behavior is unspecified if any given pattern contains capture. Regexp.union #=> /(?!)/ Regexp.union("penzance") #=> /penzance/ Regexp.union("a+b*c") #=> /a\+b\*c/ Regexp.union("skiing", "sledding") #=> /skiing|sledding/ Regexp.union(["skiing", "sledding"]) #=> /skiing|sledding/ Regexp.union(/dogs/, /cats/i) #=> /(?-mix:dogs)|(?i-mx:cats)/ Note: the arguments for ::union will try to be converted into a regular expression literal via #to_regexp. @overload union(pat1, pat2, ...) @return [Regexp] @overload union(pats_ary) @return [Regexp];T;0; @æ®;!F;"o;#;$T;%i£;&i¸;'@~®;(I"þstatic VALUE rb_reg_s_union_m(VALUE self, VALUE args) { VALUE v; if (RARRAY_LEN(args) == 1 && !NIL_P(v = rb_check_array_type(rb_ary_entry(args, 0)))) { return rb_reg_s_union(self, v); } return rb_reg_s_union(self, args); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Regexp.last_match;F;[[@c0;[[@®«iŒ;T;:last_match;0;[;{;IC;"RThe first form returns the MatchData object generated by the last successful pattern match. Equivalent to reading the special global variable $~ (see Special global variables in Regexp for details). The second form returns the nth field in this MatchData object. _n_ can be a string or symbol to reference a named capture. Note that the last_match is local to the thread and method scope of the method that did the pattern match. /c(.)t/ =~ 'cat' #=> 0 Regexp.last_match #=> # Regexp.last_match(0) #=> "cat" Regexp.last_match(1) #=> "a" Regexp.last_match(2) #=> nil /(?\w+)\s*=\s*(?\w+)/ =~ "var = val" Regexp.last_match #=> # Regexp.last_match(:lhs) #=> "var" Regexp.last_match(:rhs) #=> "val" ;T;[o;= ;3I" overload;F;40;;';50;)I"last_match;T;IC;";T; @¯;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"MatchData;T; @¯;[;I"@return [MatchData];T;0;6i;[; @¯o;= ;3I" overload;F;40;;';50;)I"last_match(n);T;IC;";T; @¯;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @¯;[;I"@return [String];T;0;6i;[[I"n;T0; @¯;[;I"ªThe first form returns the MatchData object generated by the last successful pattern match. Equivalent to reading the special global variable $~ (see Special global variables in Regexp for details). The second form returns the nth field in this MatchData object. _n_ can be a string or symbol to reference a named capture. Note that the last_match is local to the thread and method scope of the method that did the pattern match. /c(.)t/ =~ 'cat' #=> 0 Regexp.last_match #=> # Regexp.last_match(0) #=> "cat" Regexp.last_match(1) #=> "a" Regexp.last_match(2) #=> nil /(?\w+)\s*=\s*(?\w+)/ =~ "var = val" Regexp.last_match #=> # Regexp.last_match(:lhs) #=> "var" Regexp.last_match(:rhs) #=> "val" @overload last_match @return [MatchData] @overload last_match(n) @return [String];T;0; @¯;!F;"o;#;$T;%ip;&iŠ;'@~®;(I"Dstatic VALUE rb_reg_s_last_match(int argc, VALUE *argv, VALUE _) { if (rb_check_arity(argc, 0, 1) == 1) { VALUE match = rb_backref_get(); int n; if (NIL_P(match)) return Qnil; n = match_backref_number(match, argv[0]); return rb_reg_nth_match(n, match); } return match_getter(); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Regexp.try_convert;F;[[I"re;T0;[[@®«i+;T;;¤;0;[;{;IC;"xTry to convert obj into a Regexp, using to_regexp method. Returns converted regexp or nil if obj cannot be converted for any reason. Regexp.try_convert(/re/) #=> /re/ Regexp.try_convert("re") #=> nil o = Object.new Regexp.try_convert(o) #=> nil def o.to_regexp() /foo/ end Regexp.try_convert(o) #=> /foo/ ;T;[o;= ;3I" overload;F;40;;¤;50;)I"try_convert(obj);T;IC;";T; @C¯;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @C¯;[;I"@return [nil];T;0;6i;[[I"obj;T0; @C¯;[;I"¦Try to convert obj into a Regexp, using to_regexp method. Returns converted regexp or nil if obj cannot be converted for any reason. Regexp.try_convert(/re/) #=> /re/ Regexp.try_convert("re") #=> nil o = Object.new Regexp.try_convert(o) #=> nil def o.to_regexp() /foo/ end Regexp.try_convert(o) #=> /foo/ @overload try_convert(obj) @return [nil];T;0; @C¯;!F;"o;#;$T;%i;&i);'@~®;(I"fstatic VALUE rb_reg_s_try_convert(VALUE dummy, VALUE re) { return rb_check_regexp_type(re); };T;)I"static VALUE;T;*To;;F; ;;;;I"Regexp#initialize;F;[[@c0;[[@®«ih ;T;;Ð;0;[;{;IC;"¥Constructs a new regular expression from +pattern+, which can be either a String or a Regexp (in which case that regexp's options are propagated), and new options may not be specified (a change as of Ruby 1.8). If +options+ is an Integer, it should be one or more of the constants Regexp::EXTENDED, Regexp::IGNORECASE, and Regexp::MULTILINE, or-ed together. Otherwise, if +options+ is not +nil+ or +false+, the regexp will be case insensitive. r1 = Regexp.new('^a-z+:\\s+\w+') #=> /^a-z+:\s+\w+/ r2 = Regexp.new('cat', true) #=> /cat/i r3 = Regexp.new(r2) #=> /cat/i r4 = Regexp.new('dog', Regexp::EXTENDED | Regexp::IGNORECASE) #=> /dog/ix ;T;[ o;= ;3I" overload;F;40;;î;50;)I"new(string, [options]);T;IC;";T; @b¯;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Regexp;T; @b¯;[;I"@return [Regexp];T;0;6i;[[I"string;T0[I"[options];T0; @b¯o;= ;3I" overload;F;40;;î;50;)I"new(regexp);T;IC;";T; @b¯;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Regexp;T; @b¯;[;I"@return [Regexp];T;0;6i;[[I"regexp;T0; @b¯o;= ;3I" overload;F;40;;$;50;)I"compile(string, [options]);T;IC;";T; @b¯;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Regexp;T; @b¯;[;I"@return [Regexp];T;0;6i;[[I"string;T0[I"[options];T0; @b¯o;= ;3I" overload;F;40;;$;50;)I"compile(regexp);T;IC;";T; @b¯;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Regexp;T; @b¯;[;I"@return [Regexp];T;0;6i;[[I"regexp;T0; @b¯;[;I"iConstructs a new regular expression from +pattern+, which can be either a String or a Regexp (in which case that regexp's options are propagated), and new options may not be specified (a change as of Ruby 1.8). If +options+ is an Integer, it should be one or more of the constants Regexp::EXTENDED, Regexp::IGNORECASE, and Regexp::MULTILINE, or-ed together. Otherwise, if +options+ is not +nil+ or +false+, the regexp will be case insensitive. r1 = Regexp.new('^a-z+:\\s+\w+') #=> /^a-z+:\s+\w+/ r2 = Regexp.new('cat', true) #=> /cat/i r3 = Regexp.new(r2) #=> /cat/i r4 = Regexp.new('dog', Regexp::EXTENDED | Regexp::IGNORECASE) #=> /dog/ix @overload new(string, [options]) @return [Regexp] @overload new(regexp) @return [Regexp] @overload compile(string, [options]) @return [Regexp] @overload compile(regexp) @return [Regexp];T;0; @b¯;!F;"o;#;$T;%iR ;&ih ;'@~®;(I"ñstatic VALUE rb_reg_initialize_m(int argc, VALUE *argv, VALUE self) { int flags = 0; VALUE str; rb_encoding *enc = 0; rb_check_arity(argc, 1, 3); if (RB_TYPE_P(argv[0], T_REGEXP)) { VALUE re = argv[0]; if (argc > 1) { rb_warn("flags ignored"); } rb_reg_check(re); flags = rb_reg_options(re); str = RREGEXP_SRC(re); } else { if (argc >= 2) { if (FIXNUM_P(argv[1])) flags = FIX2INT(argv[1]); else if (RTEST(argv[1])) flags = ONIG_OPTION_IGNORECASE; } if (argc == 3 && !NIL_P(argv[2])) { char *kcode = StringValuePtr(argv[2]); if (kcode[0] == 'n' || kcode[0] == 'N') { enc = rb_ascii8bit_encoding(); flags |= ARG_ENCODING_NONE; } else { rb_category_warn(RB_WARN_CATEGORY_DEPRECATED, "encoding option is ignored - %s", kcode); } } str = StringValue(argv[0]); } if (enc && rb_enc_get(str) != enc) rb_reg_init_str_enc(self, str, enc, flags); else rb_reg_init_str(self, str, flags); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"Regexp#initialize_copy;F;[[I"re;T0;[[@®«iÅ;T;;g;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @±¯;!F;"o;#;$T;%iÄ;&iÄ;'@~®;(I"Ãstatic VALUE rb_reg_init_copy(VALUE copy, VALUE re) { if (!OBJ_INIT_COPY(copy, re)) return copy; rb_reg_check(re); return rb_reg_init_str(copy, RREGEXP_SRC(re), rb_reg_options(re)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Regexp#hash;F;[;[[@®«i¼;T;;b;0;[;{;IC;"dProduce a hash based on the text and options of this regular expression. See also Object#hash. ;T;[o;= ;3I" overload;F;40;;b;50;)I" hash;T;IC;";T; @Á¯;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Á¯;[;I"@return [Integer];T;0;6i;[; @Á¯;[;I"„Produce a hash based on the text and options of this regular expression. See also Object#hash. @overload hash @return [Integer];T;0; @Á¯;!F;"o;#;$T;%i³;&i¹;'@~®;(I"nstatic VALUE rb_reg_hash(VALUE re) { st_index_t hashval = reg_hash(re); return ST2FIX(hashval); };T;)I"static VALUE;T;*To;;F; ;;;;I"Regexp#eql?;F;[[I"re2;T0;[[@®«iÞ;T;;_;0;[;{;IC;"Equality---Two regexps are equal if their patterns are identical, they have the same character set code, and their casefold? values are the same. /abc/ == /abc/x #=> false /abc/ == /abc/i #=> false /abc/ == /abc/u #=> false /abc/u == /abc/n #=> false;T;[o;= ;3I" overload;F;40;;`;50;)I"==(other_rxp);T;IC;";T; @Ü¯;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Ü¯;[;I"@return [Boolean];T;0;6i;[[I"other_rxp;T0; @Ü¯o;= ;3I" overload;F;40;;_;50;)I"eql?(other_rxp);T;IC;";T; @Ü¯;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Ü¯;[;I"@return [Boolean];T;0;6i;[[I"other_rxp;T0; @Ü¯;[;I"{Equality---Two regexps are equal if their patterns are identical, they have the same character set code, and their casefold? values are the same. /abc/ == /abc/x #=> false /abc/ == /abc/i #=> false /abc/ == /abc/u #=> false /abc/u == /abc/n #=> false @overload ==(other_rxp) @return [Boolean] @overload eql?(other_rxp) @return [Boolean];T;0; @Ü¯;!F;"o;#;$T;%iÏ;&iÜ;6i;'@~®;(I"Tstatic VALUE rb_reg_equal(VALUE re1, VALUE re2) { if (re1 == re2) return Qtrue; if (!RB_TYPE_P(re2, T_REGEXP)) return Qfalse; rb_reg_check(re1); rb_reg_check(re2); if (FL_TEST(re1, KCODE_FIXED) != FL_TEST(re2, KCODE_FIXED)) return Qfalse; if (RREGEXP_PTR(re1)->options != RREGEXP_PTR(re2)->options) return Qfalse; if (RREGEXP_SRC_LEN(re1) != RREGEXP_SRC_LEN(re2)) return Qfalse; if (ENCODING_GET(re1) != ENCODING_GET(re2)) return Qfalse; if (memcmp(RREGEXP_SRC_PTR(re1), RREGEXP_SRC_PTR(re2), RREGEXP_SRC_LEN(re1)) == 0) { return Qtrue; } return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Regexp#==;F;[[I"re2;T0;[[@®«iÞ;T;;`;0;[;{;IC;"Equality---Two regexps are equal if their patterns are identical, they have the same character set code, and their casefold? values are the same. /abc/ == /abc/x #=> false /abc/ == /abc/i #=> false /abc/ == /abc/u #=> false /abc/u == /abc/n #=> false ;T;[o;= ;3I" overload;F;40;;`;50;)I"==(other_rxp);T;IC;";T; @ °;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ °;[;I"@return [Boolean];T;0;6i;[[I"other_rxp;T0; @ °o;= ;3I" overload;F;40;;_;50;)I"eql?(other_rxp);T;IC;";T; @ °;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ °;[;I"@return [Boolean];T;0;6i;[[I"other_rxp;T0; @ °;[;@°;0; @ °;!F;"o;#;$T;%iÏ;&iÜ;'@~®;(I"Tstatic VALUE rb_reg_equal(VALUE re1, VALUE re2) { if (re1 == re2) return Qtrue; if (!RB_TYPE_P(re2, T_REGEXP)) return Qfalse; rb_reg_check(re1); rb_reg_check(re2); if (FL_TEST(re1, KCODE_FIXED) != FL_TEST(re2, KCODE_FIXED)) return Qfalse; if (RREGEXP_PTR(re1)->options != RREGEXP_PTR(re2)->options) return Qfalse; if (RREGEXP_SRC_LEN(re1) != RREGEXP_SRC_LEN(re2)) return Qfalse; if (ENCODING_GET(re1) != ENCODING_GET(re2)) return Qfalse; if (memcmp(RREGEXP_SRC_PTR(re1), RREGEXP_SRC_PTR(re2), RREGEXP_SRC_LEN(re1)) == 0) { return Qtrue; } return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Regexp#=~;F;[[I"str;T0;[[@®«iy;T;;];0;[;{;IC;"òMatch---Matches rxp against str. /at/ =~ "input data" #=> 7 /ax/ =~ "input data" #=> nil If =~ is used with a regexp literal with named captures, captured strings (or nil) is assigned to local variables named by the capture names. /(?\w+)\s*=\s*(?\w+)/ =~ " x = y " p lhs #=> "x" p rhs #=> "y" If it is not matched, nil is assigned for the variables. /(?\w+)\s*=\s*(?\w+)/ =~ " x = " p lhs #=> nil p rhs #=> nil This assignment is implemented in the Ruby parser. The parser detects 'regexp-literal =~ expression' for the assignment. The regexp must be a literal without interpolation and placed at left hand side. The assignment does not occur if the regexp is not a literal. re = /(?\w+)\s*=\s*(?\w+)/ re =~ " x = y " p lhs # undefined local variable p rhs # undefined local variable A regexp interpolation, #{}, also disables the assignment. rhs_pat = /(?\w+)/ /(?\w+)\s*=\s*#{rhs_pat}/ =~ "x = y" p lhs # undefined local variable The assignment does not occur if the regexp is placed at the right hand side. " x = y " =~ /(?\w+)\s*=\s*(?\w+)/ p lhs, rhs # undefined local variable ;T;[o;= ;3I" overload;F;40;;];50;)I"=~(str);T;IC;";T; @7°;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @7°;[;I"@return [Integer, nil];T;0;6i;[[I"str;T0; @7°;[;I" Match---Matches rxp against str. /at/ =~ "input data" #=> 7 /ax/ =~ "input data" #=> nil If =~ is used with a regexp literal with named captures, captured strings (or nil) is assigned to local variables named by the capture names. /(?\w+)\s*=\s*(?\w+)/ =~ " x = y " p lhs #=> "x" p rhs #=> "y" If it is not matched, nil is assigned for the variables. /(?\w+)\s*=\s*(?\w+)/ =~ " x = " p lhs #=> nil p rhs #=> nil This assignment is implemented in the Ruby parser. The parser detects 'regexp-literal =~ expression' for the assignment. The regexp must be a literal without interpolation and placed at left hand side. The assignment does not occur if the regexp is not a literal. re = /(?\w+)\s*=\s*(?\w+)/ re =~ " x = y " p lhs # undefined local variable p rhs # undefined local variable A regexp interpolation, #{}, also disables the assignment. rhs_pat = /(?\w+)/ /(?\w+)\s*=\s*#{rhs_pat}/ =~ "x = y" p lhs # undefined local variable The assignment does not occur if the regexp is placed at the right hand side. " x = y " =~ /(?\w+)\s*=\s*(?\w+)/ p lhs, rhs # undefined local variable @overload =~(str) @return [Integer, nil];T;0; @7°;!F;"o;#;$T;%iI;&iv;'@~®;(I"·VALUE rb_reg_match(VALUE re, VALUE str) { long pos = reg_match_pos(re, &str, 0, NULL); if (pos < 0) return Qnil; pos = rb_str_sublen(str, pos); return LONG2FIX(pos); };T;)I" VALUE;T;*To;;F; ;;;;I"Regexp#===;F;[[I"str;T0;[[@®«i—;T;;\;0;[;{;IC;"‡Case Equality---Used in case statements. a = "HELLO" case a when /\A[a-z]*\z/; print "Lower case\n" when /\A[A-Z]*\z/; print "Upper case\n" else; print "Mixed case\n" end #=> "Upper case" Following a regular expression literal with the #=== operator allows you to compare against a String. /^[a-z]*$/ === "HELLO" #=> false /^[A-Z]*$/ === "HELLO" #=> true ;T;[o;= ;3I" overload;F;40;;\;50;)I" ===(str);T;IC;";T; @W°;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @W°;[;I"@return [Boolean];T;0;6i;[[I"str;T0; @W°;[;I"°Case Equality---Used in case statements. a = "HELLO" case a when /\A[a-z]*\z/; print "Lower case\n" when /\A[A-Z]*\z/; print "Upper case\n" else; print "Mixed case\n" end #=> "Upper case" Following a regular expression literal with the #=== operator allows you to compare against a String. /^[a-z]*$/ === "HELLO" #=> false /^[A-Z]*$/ === "HELLO" #=> true @overload ===(str) @return [Boolean];T;0; @W°;!F;"o;#;$T;%i‚;&i”;'@~®;(I"VALUE rb_reg_eqq(VALUE re, VALUE str) { long start; str = reg_operand(str, FALSE); if (NIL_P(str)) { rb_backref_set(Qnil); return Qfalse; } start = rb_reg_search(re, str, 0, 0); if (start < 0) { return Qfalse; } return Qtrue; };T;)I" VALUE;T;*To;;F; ;;;;I" Regexp#~;F;[;[[@®«i´;T;:~;0;[;{;IC;"˜Match---Matches rxp against the contents of $_. Equivalent to rxp =~ $_. $_ = "input data" ~ /at/ #=> 7 ;T;[o;= ;3I" overload;F;40;;(;50;)I" ~ rxp;T;IC;";T; @v°;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @v°;[;I"@return [Integer, nil];T;0;6i;[[I"rxp;T0; @v°;[;I"ÃMatch---Matches rxp against the contents of $_. Equivalent to rxp =~ $_. $_ = "input data" ~ /at/ #=> 7 @overload ~ rxp @return [Integer, nil];T;0; @v°;!F;"o;#;$T;%i©;&i±;'@~®;(I"@VALUE rb_reg_match2(VALUE re) { long start; VALUE line = rb_lastline_get(); if (!RB_TYPE_P(line, T_STRING)) { rb_backref_set(Qnil); return Qnil; } start = rb_reg_search(re, line, 0, 0); if (start < 0) { return Qnil; } start = rb_str_sublen(line, start); return LONG2FIX(start); };T;)I" VALUE;T;*To;;F; ;;;;I"Regexp#match;F;[[@c0;[[@®«iè;T;;n;0;[;{;IC;"³Returns a MatchData object describing the match, or nil if there was no match. This is equivalent to retrieving the value of the special variable $~ following a normal match. If the second parameter is present, it specifies the position in the string to begin the search. /(.)(.)(.)/.match("abc")[2] #=> "b" /(.)(.)/.match("abc", 1)[2] #=> "c" If a block is given, invoke the block with MatchData if match succeed, so that you can write /M(.*)/.match("Matz") do |m| puts m[0] puts m[1] end instead of if m = /M(.*)/.match("Matz") puts m[0] puts m[1] end The return value is a value from block execution in this case. ;T;[o;= ;3I" overload;F;40;;n;50;)I"match(str, pos=0);T;IC;";T; @”°;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"MatchData;TI"nil;T; @”°;[;I"@return [MatchData, nil];T;0;6i;[[I"str;T0[I"pos;TI"0;T; @”°o;= ;3I" overload;F;40;;n;50;)I"match(str, pos=0);T;IC;";T; @”°;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" match;T; @”°o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @”°;[;I"$@yield [match] @return [Object];T;0;6i;[[I"str;T0[I"pos;TI"0;T; @”°;[;I",Returns a MatchData object describing the match, or nil if there was no match. This is equivalent to retrieving the value of the special variable $~ following a normal match. If the second parameter is present, it specifies the position in the string to begin the search. /(.)(.)(.)/.match("abc")[2] #=> "b" /(.)(.)/.match("abc", 1)[2] #=> "c" If a block is given, invoke the block with MatchData if match succeed, so that you can write /M(.*)/.match("Matz") do |m| puts m[0] puts m[1] end instead of if m = /M(.*)/.match("Matz") puts m[0] puts m[1] end The return value is a value from block execution in this case. @overload match(str, pos=0) @return [MatchData, nil] @overload match(str, pos=0) @yield [match] @return [Object];T;0; @”°;!F;"o;#;$T;%iÈ;&iç;'@~®;(I"Þstatic VALUE rb_reg_match_m(int argc, VALUE *argv, VALUE re) { VALUE result = Qnil, str, initpos; long pos; if (rb_scan_args(argc, argv, "11", &str, &initpos) == 2) { pos = NUM2LONG(initpos); } else { pos = 0; } pos = reg_match_pos(re, &str, pos, &result); if (pos < 0) { rb_backref_set(Qnil); return Qnil; } rb_match_busy(result); if (!NIL_P(result) && rb_block_given_p()) { return rb_yield(result); } return result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Regexp#match?;F;[[@c0;[[@®«i ;T;;o;0;[;{;IC;"ˆReturns a true or false indicates whether the regexp is matched or not without updating $~ and other related variables. If the second parameter is present, it specifies the position in the string to begin the search. /R.../.match?("Ruby") #=> true /R.../.match?("Ruby", 1) #=> false /P.../.match?("Ruby") #=> false $& #=> nil;T;[o;= ;3I" overload;F;40;;o;50;)I"match?(str);T;IC;";T; @Í°;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Í°;[;I"@return [Boolean];T;0;6i;[[I"str;T0; @Í°o;= ;3I" overload;F;40;;o;50;)I"match?(str,pos);T;IC;";T; @Í°;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Í°;[;I"@return [Boolean];T;0;6i;[[I"str;T0[I"pos;T0; @Í°;[;I"âReturns a true or false indicates whether the regexp is matched or not without updating $~ and other related variables. If the second parameter is present, it specifies the position in the string to begin the search. /R.../.match?("Ruby") #=> true /R.../.match?("Ruby", 1) #=> false /P.../.match?("Ruby") #=> false $& #=> nil @overload match?(str) @return [Boolean] @overload match?(str,pos) @return [Boolean];T;0; @Í°;!F;"o;#;$T;%i ;&i ;6i;'@~®;(I"¶static VALUE rb_reg_match_m_p(int argc, VALUE *argv, VALUE re) { long pos = rb_check_arity(argc, 1, 2) > 1 ? NUM2LONG(argv[1]) : 0; return rb_reg_match_p(re, argv[0], pos); };T;)I"static VALUE;T;*To;;F; ;;;;I"Regexp#to_s;F;[;[[@®«i";T;;q;0;[;{;IC;"ÏReturns a string containing the regular expression and its options (using the (?opts:source) notation. This string can be fed back in to Regexp::new to a regular expression with the same semantics as the original. (However, Regexp#== may not return true when comparing the two, as the source of the regular expression itself may differ, as the example shows). Regexp#inspect produces a generally more readable version of rxp. r1 = /ab+c/ix #=> /ab+c/ix s1 = r1.to_s #=> "(?ix-m:ab+c)" r2 = Regexp.new(s1) #=> /(?ix-m:ab+c)/ r1 == r2 #=> false r1.source #=> "ab+c" r2.source #=> "(?ix-m:ab+c)" ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @ü°;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ü°;[;I"@return [String];T;0;6i;[; @ü°;[;I"óReturns a string containing the regular expression and its options (using the (?opts:source) notation. This string can be fed back in to Regexp::new to a regular expression with the same semantics as the original. (However, Regexp#== may not return true when comparing the two, as the source of the regular expression itself may differ, as the example shows). Regexp#inspect produces a generally more readable version of rxp. r1 = /ab+c/ix #=> /ab+c/ix s1 = r1.to_s #=> "(?ix-m:ab+c)" r2 = Regexp.new(s1) #=> /(?ix-m:ab+c)/ r1 == r2 #=> false r1.source #=> "ab+c" r2.source #=> "(?ix-m:ab+c)" @overload to_s @return [String];T;0; @ü°;!F;"o;#;$T;%i;&i;'@~®;(I"Ustatic VALUE rb_reg_to_s(VALUE re) { return rb_reg_str_with_term(re, '/'); };T;)I"static VALUE;T;*To;;F; ;;;;I"Regexp#inspect;F;[;[[@®«i;T;;r;0;[;{;IC;"ÞProduce a nicely formatted string-version of _rxp_. Perhaps surprisingly, #inspect actually produces the more natural version of the string than #to_s. /ab+c/ix.inspect #=> "/ab+c/ix" ;T;[o;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @±;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @±;[;I"@return [String];T;0;6i;[; @±;[;I"Produce a nicely formatted string-version of _rxp_. Perhaps surprisingly, #inspect actually produces the more natural version of the string than #to_s. /ab+c/ix.inspect #=> "/ab+c/ix" @overload inspect @return [String];T;0; @±;!F;"o;#;$T;%i÷;&i;'@~®;(I"Ýstatic VALUE rb_reg_inspect(VALUE re) { if (!RREGEXP_PTR(re) || !RREGEXP_SRC(re) || !RREGEXP_SRC_PTR(re)) { return rb_any_to_s(re); } return rb_reg_desc(RREGEXP_SRC_PTR(re), RREGEXP_SRC_LEN(re), re); };T;)I"static VALUE;T;*To;;F; ;;;;I"Regexp#source;F;[;[[@®«ií;T;:source;0;[;{;IC;"ŸReturns the original string of the pattern. /ab+c/ix.source #=> "ab+c" Note that escape sequences are retained as is. /\x20\+/.source #=> "\\x20\\+" ;T;[o;= ;3I" overload;F;40;;);50;)I"source;T;IC;";T; @2±;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @2±;[;I"@return [String];T;0;6i;[; @2±;[;I"ÆReturns the original string of the pattern. /ab+c/ix.source #=> "ab+c" Note that escape sequences are retained as is. /\x20\+/.source #=> "\\x20\\+" @overload source @return [String];T;0; @2±;!F;"o;#;$T;%iß;&iê;'@~®;(I"…static VALUE rb_reg_source(VALUE re) { VALUE str; rb_reg_check(re); str = rb_str_dup(RREGEXP_SRC(re)); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"Regexp#casefold?;F;[;[[@®«iÓ;T;:casefold?;0;[;{;IC;"¡Returns the value of the case-insensitive flag. /a/.casefold? #=> false /a/i.casefold? #=> true /(?i:a)/.casefold? #=> false;T;[o;= ;3I" overload;F;40;;*;50;)I"casefold?;T;IC;";T; @M±;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @M±;[;I"@return [Boolean];T;0;6i;[; @M±;[;I"ËReturns the value of the case-insensitive flag. /a/.casefold? #=> false /a/i.casefold? #=> true /(?i:a)/.casefold? #=> false @overload casefold? @return [Boolean];T;0; @M±;!F;"o;#;$T;%iÈ;&iÐ;6i;'@~®;(I"žstatic VALUE rb_reg_casefold_p(VALUE re) { rb_reg_check(re); if (RREGEXP_PTR(re)->options & ONIG_OPTION_IGNORECASE) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Regexp#options;F;[;[[@®«ió;T;:options;0;[;{;IC;"±Returns the set of bits corresponding to the options used when creating this Regexp (see Regexp::new for details. Note that additional bits may be set in the returned options: these are used internally by the regular expression code. These extra bits are ignored if the options are passed to Regexp::new. Regexp::IGNORECASE #=> 1 Regexp::EXTENDED #=> 2 Regexp::MULTILINE #=> 4 /cat/.options #=> 0 /cat/ix.options #=> 3 Regexp.new('cat', true).options #=> 1 /\xa1\xa2/e.options #=> 16 r = /cat/ix Regexp.new(r.source, r.options) #=> /cat/ix ;T;[o;= ;3I" overload;F;40;;+;50;)I"options;T;IC;";T; @h±;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @h±;[;I"@return [Integer];T;0;6i;[; @h±;[;I"ÙReturns the set of bits corresponding to the options used when creating this Regexp (see Regexp::new for details. Note that additional bits may be set in the returned options: these are used internally by the regular expression code. These extra bits are ignored if the options are passed to Regexp::new. Regexp::IGNORECASE #=> 1 Regexp::EXTENDED #=> 2 Regexp::MULTILINE #=> 4 /cat/.options #=> 0 /cat/ix.options #=> 3 Regexp.new('cat', true).options #=> 1 /\xa1\xa2/e.options #=> 16 r = /cat/ix Regexp.new(r.source, r.options) #=> /cat/ix @overload options @return [Integer];T;0; @h±;!F;"o;#;$T;%iÜ;&ið;'@~®;(I"sstatic VALUE rb_reg_options_m(VALUE re) { int options = rb_reg_options(re); return INT2NUM(options); };T;)I"static VALUE;T;*To;;F; ;;;;I"Regexp#encoding;F;[;[[@F›i±;T;;³;0;[;{;IC;"EReturns the Encoding object that represents the encoding of obj. ;T;[o;= ;3I" overload;F;40;;³;50;)I" encoding;T;IC;";T; @ƒ±;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Encoding;T; @ƒ±;[;I"@return [Encoding];T;0;6i;[; @ƒ±;[;@Y›;0; @ƒ±;!F;"o;#;$T;%iª;&i®;'@~®;(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;)I" VALUE;T;*To;;F; ;;;;I"Regexp#fixed_encoding?;F;[;[[@®«iu;T;:fixed_encoding?;0;[;{;IC;"'Returns false if rxp is applicable to a string with any ASCII compatible encoding. Returns true otherwise. r = /a/ r.fixed_encoding? #=> false r =~ "\u{6666} a" #=> 2 r =~ "\xa1\xa2 a".force_encoding("euc-jp") #=> 2 r =~ "abc".force_encoding("euc-jp") #=> 0 r = /a/u r.fixed_encoding? #=> true r.encoding #=> # r =~ "\u{6666} a" #=> 2 r =~ "\xa1\xa2".force_encoding("euc-jp") #=> Encoding::CompatibilityError r =~ "abc".force_encoding("euc-jp") #=> 0 r = /\u{6666}/ r.fixed_encoding? #=> true r.encoding #=> # r =~ "\u{6666} a" #=> 0 r =~ "\xa1\xa2".force_encoding("euc-jp") #=> Encoding::CompatibilityError r =~ "abc".force_encoding("euc-jp") #=> nil;T;[o;= ;3I" overload;F;40;;,;50;)I"fixed_encoding?;T;IC;";T; @±;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @±;[;I"@return [Boolean];T;0;6i;[; @±;[;I"WReturns false if rxp is applicable to a string with any ASCII compatible encoding. Returns true otherwise. r = /a/ r.fixed_encoding? #=> false r =~ "\u{6666} a" #=> 2 r =~ "\xa1\xa2 a".force_encoding("euc-jp") #=> 2 r =~ "abc".force_encoding("euc-jp") #=> 0 r = /a/u r.fixed_encoding? #=> true r.encoding #=> # r =~ "\u{6666} a" #=> 2 r =~ "\xa1\xa2".force_encoding("euc-jp") #=> Encoding::CompatibilityError r =~ "abc".force_encoding("euc-jp") #=> 0 r = /\u{6666}/ r.fixed_encoding? #=> true r.encoding #=> # r =~ "\u{6666} a" #=> 0 r =~ "\xa1\xa2".force_encoding("euc-jp") #=> Encoding::CompatibilityError r =~ "abc".force_encoding("euc-jp") #=> nil @overload fixed_encoding? @return [Boolean];T;0; @±;!F;"o;#;$T;%iX;&ir;6i;'@~®;(I"Šstatic VALUE rb_reg_fixed_encoding_p(VALUE re) { if (FL_TEST(re, KCODE_FIXED)) return Qtrue; else return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Regexp#names;F;[;[[@®«i;T;;Ñ;0;[;{;IC;"ÑReturns a list of names of captures as an array of strings. /(?.)(?.)(?.)/.names #=> ["foo", "bar", "baz"] /(?.)(?.)/.names #=> ["foo"] /(.)(.)/.names #=> [] ;T;[o;= ;3I" overload;F;40;;Ñ;50;)I" names;T;IC;";T; @¸±;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @¸±;[;I"@return [Array];T;0;6i;[; @¸±;[;I"õReturns a list of names of captures as an array of strings. /(?.)(?.)(?.)/.names #=> ["foo", "bar", "baz"] /(?.)(?.)/.names #=> ["foo"] /(.)(.)/.names #=> [] @overload names @return [Array];T;0; @¸±;!F;"o;#;$T;%i;&i;'@~®;(I"âstatic VALUE rb_reg_names(VALUE re) { VALUE ary; rb_reg_check(re); ary = rb_ary_new_capa(onig_number_of_names(RREGEXP_PTR(re))); onig_foreach_name(RREGEXP_PTR(re), reg_names_iter, (void*)ary); return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Regexp#named_captures;F;[;[[@®«iC;T;;;0;[;{;IC;"ÂReturns a hash representing information about named captures of rxp. A key of the hash is a name of the named captures. A value of the hash is an array which is list of indexes of corresponding named captures. /(?.)(?.)/.named_captures #=> {"foo"=>[1], "bar"=>[2]} /(?.)(?.)/.named_captures #=> {"foo"=>[1, 2]} If there are no named captures, an empty hash is returned. /(.)(.)/.named_captures #=> {} ;T;[o;= ;3I" overload;F;40;;;50;)I"named_captures;T;IC;";T; @Ó±;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @Ó±;[;I"@return [Hash];T;0;6i;[; @Ó±;[;I"îReturns a hash representing information about named captures of rxp. A key of the hash is a name of the named captures. A value of the hash is an array which is list of indexes of corresponding named captures. /(?.)(?.)/.named_captures #=> {"foo"=>[1], "bar"=>[2]} /(?.)(?.)/.named_captures #=> {"foo"=>[1, 2]} If there are no named captures, an empty hash is returned. /(.)(.)/.named_captures #=> {} @overload named_captures @return [Hash];T;0; @Ó±;!F;"o;#;$T;%i-;&i@;'@~®;(I"þstatic VALUE rb_reg_named_captures(VALUE re) { regex_t *reg = (rb_reg_check(re), RREGEXP_PTR(re)); VALUE hash = rb_hash_new_with_size(onig_number_of_names(reg)); onig_foreach_name(reg, reg_named_captures_iter, (void*)hash); return hash; };T;)I"static VALUE;T;*To;{;[[@®«ië;F;:IGNORECASE;;};;;[;{;IC;"&see Regexp.options and Regexp.new ;T;[;[;I"&see Regexp.options and Regexp.new;T;0; @î±;!F;"o;#;$T;%iê;&iê;'@~®;I"Regexp::IGNORECASE;F;~I"$INT2FIX(ONIG_OPTION_IGNORECASE);To;{;[[@®«ií;F;: EXTENDED;;};;;[;{;IC;"&see Regexp.options and Regexp.new ;T;[;[;I"&see Regexp.options and Regexp.new;T;0; @ú±;!F;"o;#;$T;%iì;&iì;'@~®;I"Regexp::EXTENDED;F;~I" INT2FIX(ONIG_OPTION_EXTEND);To;{;[[@®«iï;F;:MULTILINE;;};;;[;{;IC;"&see Regexp.options and Regexp.new ;T;[;[;I"&see Regexp.options and Regexp.new;T;0; @²;!F;"o;#;$T;%iî;&iî;'@~®;I"Regexp::MULTILINE;F;~I"#INT2FIX(ONIG_OPTION_MULTILINE);To;{;[[@®«iñ;F;:FIXEDENCODING;;};;;[;{;IC;"&see Regexp.options and Regexp.new ;T;[;[;I"&see Regexp.options and Regexp.new;T;0; @²;!F;"o;#;$T;%ið;&ið;'@~®;I"Regexp::FIXEDENCODING;F;~I" INT2FIX(ARG_ENCODING_FIXED);To;{;[[@®«ió;F;:NOENCODING;;};;;[;{;IC;"&see Regexp.options and Regexp.new ;T;[;[;I"&see Regexp.options and Regexp.new;T;0; @²;!F;"o;#;$T;%iò;&iò;'@~®;I"Regexp::NOENCODING;F;~I"INT2FIX(ARG_ENCODING_NONE);T;A@~®;BIC;[;A@~®;CIC;[;A@~®;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@®«i«[@®«iÍ;T;:Regexp;;K;;;[;{;IC;"àA Regexp holds a regular expression, used to match a pattern against strings. Regexps are created using the /.../ and %r{...} literals, and by the Regexp::new constructor. :include: doc/regexp.rdoc;T;[;[;I"â A Regexp holds a regular expression, used to match a pattern against strings. Regexps are created using the /.../ and %r{...} literals, and by the Regexp::new constructor. :include: doc/regexp.rdoc ;T;0; @~®;!F;"o;#;$T;%i«;&i²;6i;'@;I"Regexp;F;S@]o; ;IC;[#o; ;IC;[o;;F; ;F;;;I"Syslog::Constants.included;F;[[I"target;T0;[[I"ext/syslog/syslog.c;TiŒ;T;;y;0;[;{;IC;";T;[;[;@|;0; @@²;'@>²;(I"}static VALUE mSyslogMacros_included(VALUE mod, VALUE target) { rb_extend_object(target, mSyslogMacros); return mod; };T;)I"Astatic VALUE mSyslogMacros_included(VALUE mod, VALUE target);T;*T;A@>²;BIC;[;A@>²;CIC;[o; ;IC;[;A@Q²;BIC;[;A@Q²;CIC;[;A@Q²;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@G²i§;F;:Option;;K;;;[;{;IC;";T;[;[;@|;0; @Q²;'@<²;I"Syslog::Option;Fo; ;IC;[;A@b²;BIC;[;A@b²;CIC;[;A@b²;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@G²i¨;F;: Facility;;K;;;[;{;IC;";T;[;[;@|;0; @b²;'@<²;I"Syslog::Facility;Fo; ;IC;[;A@s²;BIC;[;A@s²;CIC;[;A@s²;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@G²i©;F;: Level;;K;;;[;{;IC;";T;[;[;@|;0; @s²;'@<²;I"Syslog::Level;F;A@>²;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@G²i¥;F;:Constants;;K;;;[;{;IC;";T;[;[;@|;0; @>²;'@<²;I"Syslog::Constants;F@Q²@b²@s²o; ;IC;[o;;F; ;;;;I"Syslog::Macros#LOG_MASK;F;[;[;F;: LOG_MASK;;K;[;{;IC;"Syslog macros ;T;[;[;I"Syslog macros;T;0; @“²;!F;"o;#;$T;%i?;&i?;'@‘²;*To;;F; ;;;;I"Syslog::Macros#LOG_UPTO;F;[[I"pri;T0;[[@G²i‡;T;: LOG_UPTO;0;[;{;IC;"[Generates a mask value for priority levels at or below the level specified. See #mask= ;T;[o;= ;3I" overload;F;40;;8;50;)I"LOG_UPTO(priority_level);T;IC;";T; @ž²;>0;!F;[;[;I";T;0;6i;[[I"priority_level;T0; @ž²;[;I"{Generates a mask value for priority levels at or below the level specified. See #mask= @overload LOG_UPTO(priority_level);T;0; @ž²;!F;"o;#;$T;%i;&i…;'@‘²;(I"nstatic VALUE mSyslogMacros_LOG_UPTO(VALUE mod, VALUE pri) { return INT2FIX(LOG_UPTO(NUM2INT(pri))); };T;)I">static VALUE mSyslogMacros_LOG_UPTO(VALUE mod, VALUE pri);T;*To;;F; ;F;;;I"Syslog::Macros.included;F;[[I"target;T0;[[@G²iŒ;T;;y;0;[;{;IC;";T;[;[;@|;0; @¸²;'@‘²;(I"}static VALUE mSyslogMacros_included(VALUE mod, VALUE target) { rb_extend_object(target, mSyslogMacros); return mod; };T;)I"Astatic VALUE mSyslogMacros_included(VALUE mod, VALUE target);T;*T;A@‘²;BIC;[;A@‘²;CIC;[;A@‘²;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@G²iª;F;:Macros;;K;;;[;{;IC;";T;[;[;@|;0; @‘²;6i;'@<²;I"Syslog::Macros;Fo;;F; ;;;Ï;I"Syslog#open;F;[[@c0;[[@G²i–;T;;Ÿ;0;[;{;IC;"t:yields: syslog Open the syslog facility. Raises a runtime exception if it is already open. Can be called with or without a code block. If called with a block, the Syslog object created is passed to the block. If the syslog is already open, raises a RuntimeError. +ident+ is a String which identifies the calling program. +options+ is the logical OR of any of the following: LOG_CONS:: If there is an error while sending to the system logger, write directly to the console instead. LOG_NDELAY:: Open the connection now, rather than waiting for the first message to be written. LOG_NOWAIT:: Don't wait for any child processes created while logging messages. (Has no effect on Linux.) LOG_ODELAY:: Opposite of LOG_NDELAY; wait until a message is sent before opening the connection. (This is the default.) LOG_PERROR:: Print the message to stderr as well as sending it to syslog. (Not in POSIX.1-2001.) LOG_PID:: Include the current process ID with each message. +facility+ describes the type of program opening the syslog, and is the logical OR of any of the following which are defined for the host OS: LOG_AUTH:: Security or authorization. Deprecated, use LOG_AUTHPRIV instead. LOG_AUTHPRIV:: Security or authorization messages which should be kept private. LOG_CONSOLE:: System console message. LOG_CRON:: System task scheduler (cron or at). LOG_DAEMON:: A system daemon which has no facility value of its own. LOG_FTP:: An FTP server. LOG_KERN:: A kernel message (not sendable by user processes, so not of much use to Ruby, but listed here for completeness). LOG_LPR:: Line printer subsystem. LOG_MAIL:: Mail delivery or transport subsystem. LOG_NEWS:: Usenet news system. LOG_NTP:: Network Time Protocol server. LOG_SECURITY:: General security message. LOG_SYSLOG:: Messages generated internally by syslog. LOG_USER:: Generic user-level message. LOG_UUCP:: UUCP subsystem. LOG_LOCAL0 to LOG_LOCAL7:: Locally-defined facilities. Example: Syslog.open("webrick", Syslog::LOG_PID, Syslog::LOG_DAEMON | Syslog::LOG_LOCAL3) ;T; @Õ²;>0;!F;[o;= ;3I" overload;F;40;;Ÿ;50;)I"#open(ident, options, facility);T;IC;";T; @Õ²;>0;!F;[;[;I";T;0;6i;[[I" ident;T0[I"options;T0[I" facility;T0; @Õ²;[;I"ž:yields: syslog Open the syslog facility. Raises a runtime exception if it is already open. Can be called with or without a code block. If called with a block, the Syslog object created is passed to the block. If the syslog is already open, raises a RuntimeError. +ident+ is a String which identifies the calling program. +options+ is the logical OR of any of the following: LOG_CONS:: If there is an error while sending to the system logger, write directly to the console instead. LOG_NDELAY:: Open the connection now, rather than waiting for the first message to be written. LOG_NOWAIT:: Don't wait for any child processes created while logging messages. (Has no effect on Linux.) LOG_ODELAY:: Opposite of LOG_NDELAY; wait until a message is sent before opening the connection. (This is the default.) LOG_PERROR:: Print the message to stderr as well as sending it to syslog. (Not in POSIX.1-2001.) LOG_PID:: Include the current process ID with each message. +facility+ describes the type of program opening the syslog, and is the logical OR of any of the following which are defined for the host OS: LOG_AUTH:: Security or authorization. Deprecated, use LOG_AUTHPRIV instead. LOG_AUTHPRIV:: Security or authorization messages which should be kept private. LOG_CONSOLE:: System console message. LOG_CRON:: System task scheduler (cron or at). LOG_DAEMON:: A system daemon which has no facility value of its own. LOG_FTP:: An FTP server. LOG_KERN:: A kernel message (not sendable by user processes, so not of much use to Ruby, but listed here for completeness). LOG_LPR:: Line printer subsystem. LOG_MAIL:: Mail delivery or transport subsystem. LOG_NEWS:: Usenet news system. LOG_NTP:: Network Time Protocol server. LOG_SECURITY:: General security message. LOG_SYSLOG:: Messages generated internally by syslog. LOG_USER:: Generic user-level message. LOG_UUCP:: UUCP subsystem. LOG_LOCAL0 to LOG_LOCAL7:: Locally-defined facilities. Example: Syslog.open("webrick", Syslog::LOG_PID, Syslog::LOG_DAEMON | Syslog::LOG_LOCAL3) @overload open(ident, options, facility) ;T;0;'@<²;(I"ˆstatic VALUE mSyslog_open(int argc, VALUE *argv, VALUE self) { VALUE ident, opt, fac; const char *ident_ptr; if (syslog_opened) { rb_raise(rb_eRuntimeError, "syslog already open"); } rb_scan_args(argc, argv, "03", &ident, &opt, &fac); if (NIL_P(ident)) { ident = rb_gv_get("$0"); } ident_ptr = StringValueCStr(ident); syslog_ident = strdup(ident_ptr); if (NIL_P(opt)) { syslog_options = LOG_PID | LOG_CONS; } else { syslog_options = NUM2INT(opt); } if (NIL_P(fac)) { syslog_facility = LOG_USER; } else { syslog_facility = NUM2INT(fac); } openlog(syslog_ident, syslog_options, syslog_facility); syslog_opened = 1; setlogmask(syslog_mask = setlogmask(0)); /* be like File.new.open {...} */ if (rb_block_given_p()) { rb_ensure(rb_yield, self, mSyslog_close, self); } return self; };T;)I"Astatic VALUE mSyslog_open(int argc, VALUE *argv, VALUE self);T;*To;;T; ;F;;;I"Syslog.open;F;@×²;@Ù²;T;;Ÿ;0;@Û²;{;IC;"t:yields: syslog Open the syslog facility. Raises a runtime exception if it is already open. Can be called with or without a code block. If called with a block, the Syslog object created is passed to the block. If the syslog is already open, raises a RuntimeError. +ident+ is a String which identifies the calling program. +options+ is the logical OR of any of the following: LOG_CONS:: If there is an error while sending to the system logger, write directly to the console instead. LOG_NDELAY:: Open the connection now, rather than waiting for the first message to be written. LOG_NOWAIT:: Don't wait for any child processes created while logging messages. (Has no effect on Linux.) LOG_ODELAY:: Opposite of LOG_NDELAY; wait until a message is sent before opening the connection. (This is the default.) LOG_PERROR:: Print the message to stderr as well as sending it to syslog. (Not in POSIX.1-2001.) LOG_PID:: Include the current process ID with each message. +facility+ describes the type of program opening the syslog, and is the logical OR of any of the following which are defined for the host OS: LOG_AUTH:: Security or authorization. Deprecated, use LOG_AUTHPRIV instead. LOG_AUTHPRIV:: Security or authorization messages which should be kept private. LOG_CONSOLE:: System console message. LOG_CRON:: System task scheduler (cron or at). LOG_DAEMON:: A system daemon which has no facility value of its own. LOG_FTP:: An FTP server. LOG_KERN:: A kernel message (not sendable by user processes, so not of much use to Ruby, but listed here for completeness). LOG_LPR:: Line printer subsystem. LOG_MAIL:: Mail delivery or transport subsystem. LOG_NEWS:: Usenet news system. LOG_NTP:: Network Time Protocol server. LOG_SECURITY:: General security message. LOG_SYSLOG:: Messages generated internally by syslog. LOG_USER:: Generic user-level message. LOG_UUCP:: UUCP subsystem. LOG_LOCAL0 to LOG_LOCAL7:: Locally-defined facilities. Example: Syslog.open("webrick", Syslog::LOG_PID, Syslog::LOG_DAEMON | Syslog::LOG_LOCAL3);T;[o;= ;3I" overload;F;40;;Ÿ;50;)I"#open(ident, options, facility);T;IC;";T; @ñ²;>0;!F;[;[;I";T;0;6i;[[I" ident;T0[I"options;T0[I" facility;T0; @ñ²;[;I" :yields: syslog Open the syslog facility. Raises a runtime exception if it is already open. Can be called with or without a code block. If called with a block, the Syslog object created is passed to the block. If the syslog is already open, raises a RuntimeError. +ident+ is a String which identifies the calling program. +options+ is the logical OR of any of the following: LOG_CONS:: If there is an error while sending to the system logger, write directly to the console instead. LOG_NDELAY:: Open the connection now, rather than waiting for the first message to be written. LOG_NOWAIT:: Don't wait for any child processes created while logging messages. (Has no effect on Linux.) LOG_ODELAY:: Opposite of LOG_NDELAY; wait until a message is sent before opening the connection. (This is the default.) LOG_PERROR:: Print the message to stderr as well as sending it to syslog. (Not in POSIX.1-2001.) LOG_PID:: Include the current process ID with each message. +facility+ describes the type of program opening the syslog, and is the logical OR of any of the following which are defined for the host OS: LOG_AUTH:: Security or authorization. Deprecated, use LOG_AUTHPRIV instead. LOG_AUTHPRIV:: Security or authorization messages which should be kept private. LOG_CONSOLE:: System console message. LOG_CRON:: System task scheduler (cron or at). LOG_DAEMON:: A system daemon which has no facility value of its own. LOG_FTP:: An FTP server. LOG_KERN:: A kernel message (not sendable by user processes, so not of much use to Ruby, but listed here for completeness). LOG_LPR:: Line printer subsystem. LOG_MAIL:: Mail delivery or transport subsystem. LOG_NEWS:: Usenet news system. LOG_NTP:: Network Time Protocol server. LOG_SECURITY:: General security message. LOG_SYSLOG:: Messages generated internally by syslog. LOG_USER:: Generic user-level message. LOG_UUCP:: UUCP subsystem. LOG_LOCAL0 to LOG_LOCAL7:: Locally-defined facilities. Example: Syslog.open("webrick", Syslog::LOG_PID, Syslog::LOG_DAEMON | Syslog::LOG_LOCAL3) @overload open(ident, options, facility);T;0; @ñ²;!F;"o;#;$T;%iM;&i”;6i;'@<²;(@ï²;)@ð²;*To;;F; ;;;Ï;I"Syslog#reopen;F;[[@c0;[[@G²iÊ;T;:reopen;0;[;{;IC;"`:yields: syslog Closes and then reopens the syslog. Arguments are the same as for open(). ;T; @³;>0;!F;[o;= ;3I" overload;F;40;;:;50;)I"%reopen(ident, options, facility);T;IC;";T; @³;>0;!F;[;[;I";T;0;6i;[[I" ident;T0[I"options;T0[I" facility;T0; @³;[;I"‡:yields: syslog Closes and then reopens the syslog. Arguments are the same as for open(). @overload reopen(ident, options, facility) ;T;0;'@<²;(I"‡static VALUE mSyslog_reopen(int argc, VALUE *argv, VALUE self) { mSyslog_close(self); return mSyslog_open(argc, argv, self); };T;)I"Cstatic VALUE mSyslog_reopen(int argc, VALUE *argv, VALUE self);T;*To;;T; ;F;;;I"Syslog.reopen;F;@ ³;@³;T;;:;0;@ ³;{;IC;"`:yields: syslog Closes and then reopens the syslog. Arguments are the same as for open().;T;[o;= ;3I" overload;F;40;;:;50;)I"%reopen(ident, options, facility);T;IC;";T; @#³;>0;!F;[;[;I";T;0;6i;[[I" ident;T0[I"options;T0[I" facility;T0; @#³;[;I"ˆ:yields: syslog Closes and then reopens the syslog. Arguments are the same as for open(). @overload reopen(ident, options, facility);T;0; @#³;!F;"o;#;$T;%iÁ;&iÈ;6i;'@<²;(@!³;)@"³;*To;;F; ;;;Ï;I"Syslog#open!;F;[[@c0;[[@G²iÊ;T;: open!;0;[;{;IC;"`:yields: syslog Closes and then reopens the syslog. Arguments are the same as for open(). ;T; @9³;>0;!F;[o;= ;3I" overload;F;40;;:;50;)I"%reopen(ident, options, facility);T;IC;";T; @9³;>0;!F;[;[;I";T;0;6i;[[I" ident;T0[I"options;T0[I" facility;T0; @9³;[;I"‡:yields: syslog Closes and then reopens the syslog. Arguments are the same as for open(). @overload reopen(ident, options, facility) ;T;0;'@<²;(I"‡static VALUE mSyslog_reopen(int argc, VALUE *argv, VALUE self) { mSyslog_close(self); return mSyslog_open(argc, argv, self); };T;)I"Cstatic VALUE mSyslog_reopen(int argc, VALUE *argv, VALUE self);T;*To;;T; ;F;;;I"Syslog.open!;F;@;³;@=³;T;;;;0;@?³;{;IC;"`:yields: syslog Closes and then reopens the syslog. Arguments are the same as for open().;T;[o;= ;3I" overload;F;40;;:;50;)I"%reopen(ident, options, facility);T;IC;";T; @U³;>0;!F;[;[;I";T;0;6i;[[I" ident;T0[I"options;T0[I" facility;T0; @U³;[;@7³;0; @U³;!F;"o;#;$T;%iÁ;&iÈ;6i;'@<²;(@S³;)@T³;*To;;F; ;;;Ï;I"Syslog#opened?;F;[;[[@G²iÖ;T;:opened?;0;[;{;IC;"(Returns true if the syslog is open. ;T; @j³;>0;!F;[o;= ;3I" overload;F;40;;<;50;)I"opened?;T;IC;";T; @j³;>0;!F;[;[;I";T;0;6i;[; @j³o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @j³;[;I"NReturns true if the syslog is open. @overload opened? @return [Boolean] ;T;0;'@<²;(I"[static VALUE mSyslog_isopen(VALUE self) { return syslog_opened ? Qtrue : Qfalse; };T;)I",static VALUE mSyslog_isopen(VALUE self);T;*To;;T; ;F;;;I"Syslog.opened?;F;@l³;@m³;T;;<;0;@o³;{;IC;"(Returns true if the syslog is open.;T;[o;= ;3I" overload;F;40;;<;50;)I"opened?;T;IC;";T; @„³;>0;!F;[;[;I";T;0;6i;[; @„³o;2 ;3I"return;F;4@|;0;5[@~; @„³;[;I"0;!F;[;[;I"@Returns the identity string used in the last call to open();T;0;'@<²;(I"lstatic VALUE mSyslog_ident(VALUE self) { return syslog_opened ? rb_str_new2(syslog_ident) : Qnil; };T;)I"+static VALUE mSyslog_ident(VALUE self);T;*To;;T; ;F;;;I"Syslog.ident;F;@™³;@š³;T;;=;0;@œ³;{;IC;"@Returns the identity string used in the last call to open();T;[;[;I"AReturns the identity string used in the last call to open() ;T;0; @¤³;!F;"o;#;$T;%iÛ;&iÜ;6i;'@<²;(@¢³;)@£³;*To;;F; ;;;Ï;I"Syslog#options;F;[;[[@G²iä;T;;+;0;[;{;IC;"@Returns the options bitmask used in the last call to open() ;T; @¬³;>0;!F;[;[;I"@Returns the options bitmask used in the last call to open();T;0;'@<²;(I"lstatic VALUE mSyslog_options(VALUE self) { return syslog_opened ? INT2NUM(syslog_options) : Qnil; };T;)I"-static VALUE mSyslog_options(VALUE self);T;*To;;T; ;F;;;I"Syslog.options;F;@®³;@¯³;T;;+;0;@±³;{;IC;"@Returns the options bitmask used in the last call to open();T;[;[;I"AReturns the options bitmask used in the last call to open() ;T;0; @¹³;!F;"o;#;$T;%iâ;&iã;6i;'@<²;(@·³;)@¸³;*To;;F; ;;;Ï;I"Syslog#facility;F;[;[[@G²ië;T;: facility;0;[;{;IC;"@Returns the facility number used in the last call to open() ;T; @Á³;>0;!F;[;[;I"@Returns the facility number used in the last call to open();T;0;'@<²;(I"nstatic VALUE mSyslog_facility(VALUE self) { return syslog_opened ? INT2NUM(syslog_facility) : Qnil; };T;)I".static VALUE mSyslog_facility(VALUE self);T;*To;;T; ;F;;;I"Syslog.facility;F;@Ã³;@Ä³;T;;>;0;@Æ³;{;IC;"@Returns the facility number used in the last call to open();T;[;[;I"AReturns the facility number used in the last call to open() ;T;0; @Î³;!F;"o;#;$T;%ié;&iê;6i;'@<²;(@Ì³;)@Í³;*To;;F; ;;;Ï;I"Syslog#log;F;[[@c0;[[@G²i,;T;:log;0;[;{;IC;"Log a message with the specified priority. Example: Syslog.log(Syslog::LOG_CRIT, "Out of disk space") Syslog.log(Syslog::LOG_CRIT, "User %s logged in", ENV['USER']) The priority levels, in descending order, are: LOG_EMERG:: System is unusable LOG_ALERT:: Action needs to be taken immediately LOG_CRIT:: A critical condition has occurred LOG_ERR:: An error occurred LOG_WARNING:: Warning of a possible problem LOG_NOTICE:: A normal but significant condition occurred LOG_INFO:: Informational message LOG_DEBUG:: Debugging information Each priority level also has a shortcut method that logs with it's named priority. As an example, the two following statements would produce the same result: Syslog.log(Syslog::LOG_ALERT, "Out of memory") Syslog.alert("Out of memory") ;T; @Ö³;>0;!F;[o;= ;3I" overload;F;40;;?;50;)I"/log(priority, format_string, *format_args);T;IC;";T; @Ö³;>0;!F;[;[;I";T;0;6i;[[I" priority;T0[I"format_string;T0[I"*format_args;T0; @Ö³;[;I"SLog a message with the specified priority. Example: Syslog.log(Syslog::LOG_CRIT, "Out of disk space") Syslog.log(Syslog::LOG_CRIT, "User %s logged in", ENV['USER']) The priority levels, in descending order, are: LOG_EMERG:: System is unusable LOG_ALERT:: Action needs to be taken immediately LOG_CRIT:: A critical condition has occurred LOG_ERR:: An error occurred LOG_WARNING:: Warning of a possible problem LOG_NOTICE:: A normal but significant condition occurred LOG_INFO:: Informational message LOG_DEBUG:: Debugging information Each priority level also has a shortcut method that logs with it's named priority. As an example, the two following statements would produce the same result: Syslog.log(Syslog::LOG_ALERT, "Out of memory") Syslog.alert("Out of memory") @overload log(priority, format_string, *format_args) ;T;0;'@<²;(I"Sstatic VALUE mSyslog_log(int argc, VALUE *argv, VALUE self) { VALUE pri; rb_check_arity(argc, 2, UNLIMITED_ARGUMENTS); argc--; pri = *argv++; if (!FIXNUM_P(pri)) { rb_raise(rb_eTypeError, "type mismatch: %"PRIsVALUE" given", rb_obj_class(pri)); } syslog_write(FIX2INT(pri), argc, argv); return self; };T;)I"@static VALUE mSyslog_log(int argc, VALUE *argv, VALUE self);T;*To;;T; ;F;;;I"Syslog.log;F;@Ø³;@Ú³;T;;?;0;@Ü³;{;IC;"Log a message with the specified priority. Example: Syslog.log(Syslog::LOG_CRIT, "Out of disk space") Syslog.log(Syslog::LOG_CRIT, "User %s logged in", ENV['USER']) The priority levels, in descending order, are: LOG_EMERG:: System is unusable LOG_ALERT:: Action needs to be taken immediately LOG_CRIT:: A critical condition has occurred LOG_ERR:: An error occurred LOG_WARNING:: Warning of a possible problem LOG_NOTICE:: A normal but significant condition occurred LOG_INFO:: Informational message LOG_DEBUG:: Debugging information Each priority level also has a shortcut method that logs with it's named priority. As an example, the two following statements would produce the same result: Syslog.log(Syslog::LOG_ALERT, "Out of memory") Syslog.alert("Out of memory");T;[o;= ;3I" overload;F;40;;?;50;)I"/log(priority, format_string, *format_args);T;IC;";T; @ò³;>0;!F;[;[;I";T;0;6i;[[I" priority;T0[I"format_string;T0[I"*format_args;T0; @ò³;[;I"ULog a message with the specified priority. Example: Syslog.log(Syslog::LOG_CRIT, "Out of disk space") Syslog.log(Syslog::LOG_CRIT, "User %s logged in", ENV['USER']) The priority levels, in descending order, are: LOG_EMERG:: System is unusable LOG_ALERT:: Action needs to be taken immediately LOG_CRIT:: A critical condition has occurred LOG_ERR:: An error occurred LOG_WARNING:: Warning of a possible problem LOG_NOTICE:: A normal but significant condition occurred LOG_INFO:: Informational message LOG_DEBUG:: Debugging information Each priority level also has a shortcut method that logs with it's named priority. As an example, the two following statements would produce the same result: Syslog.log(Syslog::LOG_ALERT, "Out of memory") Syslog.alert("Out of memory") @overload log(priority, format_string, *format_args);T;0; @ò³;!F;"o;#;$T;%i;&i*;6i;'@<²;(@ð³;)@ñ³;*To;;F; ;;;Ï;I"Syslog#close;F;[;[[@G²i=;T;;:;0;[;{;IC;"NCloses the syslog facility. Raises a runtime exception if it is not open. ;T; @´;>0;!F;[;[;I"NCloses the syslog facility. Raises a runtime exception if it is not open.;T;0;'@<²;(I"1static VALUE mSyslog_close(VALUE self) { if (!syslog_opened) { rb_raise(rb_eRuntimeError, "syslog not opened"); } closelog(); xfree((void *)syslog_ident); syslog_ident = NULL; syslog_options = syslog_facility = syslog_mask = -1; syslog_opened = 0; return Qnil; };T;)I"+static VALUE mSyslog_close(VALUE self);T;*To;;T; ;F;;;I"Syslog.close;F;@ ´;@´;T;;:;0;@ ´;{;IC;"NCloses the syslog facility. Raises a runtime exception if it is not open.;T;[;[;I"OCloses the syslog facility. Raises a runtime exception if it is not open. ;T;0; @´;!F;"o;#;$T;%i:;&i<;6i;'@<²;(@´;)@´;*To;;F; ;;;Ï;I"Syslog#mask;F;[;[[@G²ió;T;: mask;0;[;{;IC;"aReturns the log priority mask in effect. The mask is not reset by opening or closing syslog. ;T; @´;>0;!F;[;[;I"aReturns the log priority mask in effect. The mask is not reset by opening or closing syslog.;T;0;'@<²;(I"jstatic VALUE mSyslog_get_mask(VALUE self) { return syslog_opened ? INT2NUM(syslog_mask) : Qnil; };T;)I".static VALUE mSyslog_get_mask(VALUE self);T;*To;;T; ;F;;;I"Syslog.mask;F;@´;@ ´;T;;@;0;@"´;{;IC;"aReturns the log priority mask in effect. The mask is not reset by opening or closing syslog.;T;[;[;I"bReturns the log priority mask in effect. The mask is not reset by opening or closing syslog. ;T;0; @*´;!F;"o;#;$T;%ið;&iò;6i;'@<²;(@(´;)@)´;*To;;F; ;;;Ï;I"Syslog#mask=;F;[[I" mask;T0;[[@G²i;T;: mask=;0;[;{;IC;"”Sets the log priority mask. A method LOG_UPTO is defined to make it easier to set mask values. Example: Syslog.mask = Syslog::LOG_UPTO(Syslog::LOG_ERR) Alternatively, specific priorities can be selected and added together using binary OR. Example: Syslog.mask = Syslog::LOG_MASK(Syslog::LOG_ERR) | Syslog::LOG_MASK(Syslog::LOG_CRIT) The priority mask persists through calls to open() and close(). ;T; @2´;>0;!F;[o;= ;3I" overload;F;40;;A;50;)I"mask=(priority_mask);T;IC;";T; @2´;>0;!F;[;[;I";T;0;6i;[[I"priority_mask;T0; @2´;[;I"´Sets the log priority mask. A method LOG_UPTO is defined to make it easier to set mask values. Example: Syslog.mask = Syslog::LOG_UPTO(Syslog::LOG_ERR) Alternatively, specific priorities can be selected and added together using binary OR. Example: Syslog.mask = Syslog::LOG_MASK(Syslog::LOG_ERR) | Syslog::LOG_MASK(Syslog::LOG_CRIT) The priority mask persists through calls to open() and close(). @overload mask=(priority_mask) ;T;0;'@<²;(I"éstatic VALUE mSyslog_set_mask(VALUE self, VALUE mask) { if (!syslog_opened) { rb_raise(rb_eRuntimeError, "must open syslog before setting log mask"); } setlogmask(syslog_mask = NUM2INT(mask)); return mask; };T;)I":static VALUE mSyslog_set_mask(VALUE self, VALUE mask);T;*To;;T; ;F;;;I"Syslog.mask=;F;@4´;@7´;T;;A;0;@9´;{;IC;"”Sets the log priority mask. A method LOG_UPTO is defined to make it easier to set mask values. Example: Syslog.mask = Syslog::LOG_UPTO(Syslog::LOG_ERR) Alternatively, specific priorities can be selected and added together using binary OR. Example: Syslog.mask = Syslog::LOG_MASK(Syslog::LOG_ERR) | Syslog::LOG_MASK(Syslog::LOG_CRIT) The priority mask persists through calls to open() and close().;T;[o;= ;3I" overload;F;40;;A;50;)I"mask=(priority_mask);T;IC;";T; @K´;>0;!F;[;[;I";T;0;6i;[[I"priority_mask;T0; @K´;[;I"µSets the log priority mask. A method LOG_UPTO is defined to make it easier to set mask values. Example: Syslog.mask = Syslog::LOG_UPTO(Syslog::LOG_ERR) Alternatively, specific priorities can be selected and added together using binary OR. Example: Syslog.mask = Syslog::LOG_MASK(Syslog::LOG_ERR) | Syslog::LOG_MASK(Syslog::LOG_CRIT) The priority mask persists through calls to open() and close(). @overload mask=(priority_mask);T;0; @K´;!F;"o;#;$T;%iø;&i;6i;'@<²;(@I´;)@J´;*To;;F; ;F;;;I"Syslog.inspect;F;[;[[@G²i@;T;;r;0;[;{;IC;">Returns an inspect() string summarizing the object state. ;T;[;[;I"?Returns an inspect() string summarizing the object state. ;T;0; @]´;!F;"o;#;$T;%i>;&i?;'@<²;(I"rstatic VALUE mSyslog_inspect(VALUE self) { Check_Type(self, T_MODULE); if (!syslog_opened) return rb_sprintf("<#%"PRIsVALUE": opened=false>", self); return rb_sprintf("<#%"PRIsVALUE": opened=true, ident=\"%s\", options=%d, facility=%d, mask=%d>", self, syslog_ident, syslog_options, syslog_facility, syslog_mask); };T;)I"-static VALUE mSyslog_inspect(VALUE self);T;*To;;F; ;;;Ï;I"Syslog#instance;F;[;[[@G²iQ;T;;;0;[;{;IC;".Returns self, for backward compatibility. ;T; @k´;>0;!F;[;[;I".Returns self, for backward compatibility.;T;0;'@<²;(I"Cstatic VALUE mSyslog_instance(VALUE self) { return self; };T;)I".static VALUE mSyslog_instance(VALUE self);T;*To;;T; ;F;;;I"Syslog.instance;F;@m´;@n´;T;;;0;@p´;{;IC;".Returns self, for backward compatibility.;T;[;[;I"/Returns self, for backward compatibility. ;T;0; @x´;!F;"o;#;$T;%iO;&iP;6i;'@<²;(@v´;)@w´;*T;A@<²;BIC;[;A@<²;CIC;[;A@<²;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@G²i£;F;:Syslog;;K;;;[;{;IC;";T;[;[;@|;0; @<²;6i;'@;I"Syslog;Fo; ;IC;[Yo;;F; ;;;;I"Pathname#initialize;F;[[I"arg;T0;[[@˜ id;T;;Ð;0;[;{;IC;"–Create a Pathname object from the given String (or String-like object). If +path+ contains a NULL character (\0), an ArgumentError is raised. ;T;[;[;I"—Create a Pathname object from the given String (or String-like object). If +path+ contains a NULL character (\0), an ArgumentError is raised. ;T;0; @‘´;!F;"o;#;$T;%i`;&ib;'@´;(I"Üstatic VALUE path_initialize(VALUE self, VALUE arg) { VALUE str; if (RB_TYPE_P(arg, T_STRING)) { str = arg; } else { str = rb_check_funcall(arg, id_to_path, 0, NULL); if (str == Qundef) str = arg; StringValue(str); } if (memchr(RSTRING_PTR(str), '\0', RSTRING_LEN(str))) rb_raise(rb_eArgError, "pathname contains null byte"); str = rb_obj_dup(str); set_strpath(self, str); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#freeze;F;[;[[@˜ i|;T;;p;0;[;{;IC;"/Freezes this Pathname. See Object.freeze. ;T;[o;= ;3I" overload;F;40;;p;50;)I"freeze;T;IC;";T; @¡´;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @¡´;[;I"@return [Object];T;0;6i;[; @¡´;[;I"UFreezes this Pathname. See Object.freeze. @overload freeze @return [Object];T;0; @¡´;!F;"o;#;$T;%iy;&i;'@´;(I"}static VALUE path_freeze(VALUE self) { rb_call_super(0, 0); rb_str_freeze(get_strpath(self)); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#taint;F;[;[[@˜ iŠ;T;;j;0;[;{;IC;"RReturns pathname. This method is deprecated and will be removed in Ruby 3.2. ;T;[o;= ;3I" overload;F;40;;j;50;)I" taint;T;IC;";T; @¼´;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @¼´;[;I"@return [Object];T;0;6i;[; @¼´;[;I"wReturns pathname. This method is deprecated and will be removed in Ruby 3.2. @overload taint @return [Object];T;0; @¼´;!F;"o;#;$T;%i„;&iˆ;'@´;(I"†static VALUE path_taint(VALUE self) { rb_warn("Pathname#taint is deprecated and will be removed in Ruby 3.2."); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#untaint;F;[;[[@˜ i—;T;;l;0;[;{;IC;"RReturns pathname. This method is deprecated and will be removed in Ruby 3.2. ;T;[o;= ;3I" overload;F;40;;l;50;)I"untaint;T;IC;";T; @×´;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @×´;[;I"@return [Object];T;0;6i;[; @×´;[;I"yReturns pathname. This method is deprecated and will be removed in Ruby 3.2. @overload untaint @return [Object];T;0; @×´;!F;"o;#;$T;%i‘;&i•;'@´;(I"Šstatic VALUE path_untaint(VALUE self) { rb_warn("Pathname#untaint is deprecated and will be removed in Ruby 3.2."); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#==;F;[[I" other;T0;[[@˜ i£;T;;`;0;[;{;IC;"¬Compare this pathname with +other+. The comparison is string-based. Be aware that two different paths (foo.txt and ./foo.txt) can refer to the same file. ;T;[;[;I"Compare this pathname with +other+. The comparison is string-based. Be aware that two different paths (foo.txt and ./foo.txt) can refer to the same file. ;T;0; @ò´;!F;"o;#;$T;%iž;&i¡;'@´;(I"¹static VALUE path_eq(VALUE self, VALUE other) { if (!rb_obj_is_kind_of(other, rb_cPathname)) return Qfalse; return rb_str_equal(get_strpath(self), get_strpath(other)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#===;F;[[I" other;T0;[[@˜ i£;T;;\;0;[;{;IC;"¬Compare this pathname with +other+. The comparison is string-based. Be aware that two different paths (foo.txt and ./foo.txt) can refer to the same file. ;T;[;[;@þ´;0; @µ;!F;"o;#;$T;%iž;&i¡;'@´;(I"¹static VALUE path_eq(VALUE self, VALUE other) { if (!rb_obj_is_kind_of(other, rb_cPathname)) return Qfalse; return rb_str_equal(get_strpath(self), get_strpath(other)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#eql?;F;[[I" other;T0;[[@˜ i£;T;;_;0;[;{;IC;"¬Compare this pathname with +other+. The comparison is string-based. Be aware that two different paths (foo.txt and ./foo.txt) can refer to the same file.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @µ;[;@þ´;0; @µ;!F;"o;#;$T;%iž;&i¡;6i;'@´;(I"¹static VALUE path_eq(VALUE self, VALUE other) { if (!rb_obj_is_kind_of(other, rb_cPathname)) return Qfalse; return rb_str_equal(get_strpath(self), get_strpath(other)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#<=>;F;[[I" other;T0;[[@˜ i¹;T;;c;0;[;{;IC;"¡Provides a case-sensitive comparison operator for pathnames. Pathname.new('/usr') <=> Pathname.new('/usr/bin') #=> -1 Pathname.new('/usr/bin') <=> Pathname.new('/usr/bin') #=> 0 Pathname.new('/usr/bin') <=> Pathname.new('/USR/BIN') #=> 1 It will return +-1+, +0+ or +1+ depending on the value of the left argument relative to the right argument. Or it will return +nil+ if the arguments are not comparable. ;T;[;[;I"¢Provides a case-sensitive comparison operator for pathnames. Pathname.new('/usr') <=> Pathname.new('/usr/bin') #=> -1 Pathname.new('/usr/bin') <=> Pathname.new('/usr/bin') #=> 0 Pathname.new('/usr/bin') <=> Pathname.new('/USR/BIN') #=> 1 It will return +-1+, +0+ or +1+ depending on the value of the left argument relative to the right argument. Or it will return +nil+ if the arguments are not comparable. ;T;0; @#µ;!F;"o;#;$T;%i«;&i·;'@´;(I"#static VALUE path_cmp(VALUE self, VALUE other) { VALUE s1, s2; char *p1, *p2; char *e1, *e2; if (!rb_obj_is_kind_of(other, rb_cPathname)) return Qnil; s1 = get_strpath(self); s2 = get_strpath(other); p1 = RSTRING_PTR(s1); p2 = RSTRING_PTR(s2); e1 = p1 + RSTRING_LEN(s1); e2 = p2 + RSTRING_LEN(s2); while (p1 < e1 && p2 < e2) { int c1, c2; c1 = (unsigned char)*p1++; c2 = (unsigned char)*p2++; if (c1 == '/') c1 = '\0'; if (c2 == '/') c2 = '\0'; if (c1 != c2) { if (c1 < c2) return INT2FIX(-1); else return INT2FIX(1); } } if (p1 < e1) return INT2FIX(1); if (p2 < e2) return INT2FIX(-1); return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#hash;F;[;[[@˜ ià;T;;b;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @3µ;!F;"o;#;$T;%iß;&iß;'@´;(I"^static VALUE path_hash(VALUE self) { return ST2FIX(rb_str_hash(get_strpath(self))); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#to_s;F;[;[[@˜ iï;T;;q;0;[;{;IC;"mReturn the path as a String. to_path is implemented so Pathname objects are usable with File.open, etc. ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @Aµ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Aµ;[;I"@return [String];T;0;6i;[; @Aµo;= ;3I" overload;F;40;:to_path;50;)I"to_path;T;IC;";T; @Aµ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Aµ;[;I"@return [String];T;0;6i;[; @Aµ;[;I"±Return the path as a String. to_path is implemented so Pathname objects are usable with File.open, etc. @overload to_s @return [String] @overload to_path @return [String];T;0; @Aµ;!F;"o;#;$T;%iæ;&iî;'@´;(I"Ustatic VALUE path_to_s(VALUE self) { return rb_obj_dup(get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#to_path;F;[;[[@˜ iï;T;;C;0;[;{;IC;"mReturn the path as a String. to_path is implemented so Pathname objects are usable with File.open, etc. ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @iµ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @iµ;[;I"@return [String];T;0;6i;[; @iµo;= ;3I" overload;F;40;;C;50;)I"to_path;T;IC;";T; @iµ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @iµ;[;I"@return [String];T;0;6i;[; @iµ;[;@eµ;0; @iµ;!F;"o;#;$T;%iæ;&iî;'@´;(I"Ustatic VALUE path_to_s(VALUE self) { return rb_obj_dup(get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#inspect;F;[;[[@˜ iö;T;;r;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @µ;!F;"o;#;$T;%iõ;&iõ;'@´;(I"static VALUE path_inspect(VALUE self) { const char *c = rb_obj_classname(self); VALUE str = get_strpath(self); return rb_sprintf("#<%s:%"PRIsVALUE">", c, str); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#sub;F;[[@c0;[[@˜ i;T;;—;0;[;{;IC;"˜Return a pathname which is substituted by String#sub. path1 = Pathname.new('/usr/bin/perl') path1.sub('perl', 'ruby') #=> # ;T;[;[;I"™Return a pathname which is substituted by String#sub. path1 = Pathname.new('/usr/bin/perl') path1.sub('perl', 'ruby') #=> # ;T;0; @žµ;!F;"o;#;$T;%iþ;&i;'@´;(I"Dstatic VALUE path_sub(int argc, VALUE *argv, VALUE self) { VALUE str = get_strpath(self); if (rb_block_given_p()) { str = rb_block_call(str, id_sub, argc, argv, 0, 0); } else { str = rb_funcallv(str, id_sub, argc, argv); } return rb_class_new_instance(1, &str, rb_obj_class(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#sub_ext;F;[[I" repl;T0;[[@˜ i;T;:sub_ext;0;[;{;IC;"ÏReturn a pathname with +repl+ added as a suffix to the basename. If self has no extension part, +repl+ is appended. Pathname.new('/usr/bin/shutdown').sub_ext('.rb') #=> # ;T;[;[;I"ÐReturn a pathname with +repl+ added as a suffix to the basename. If self has no extension part, +repl+ is appended. Pathname.new('/usr/bin/shutdown').sub_ext('.rb') #=> # ;T;0; @µ;!F;"o;#;$T;%i;&i;'@´;(I"2static VALUE path_sub_ext(VALUE self, VALUE repl) { VALUE str = get_strpath(self); VALUE str2; long extlen; const char *ext; const char *p; StringValue(repl); p = RSTRING_PTR(str); extlen = RSTRING_LEN(str); ext = ruby_enc_find_extname(p, &extlen, rb_enc_get(str)); if (ext == NULL) { ext = p + RSTRING_LEN(str); } else if (extlen <= 1) { ext += extlen; } str2 = rb_str_subseq(str, 0, ext-p); rb_str_append(str2, repl); return rb_class_new_instance(1, &str2, rb_obj_class(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#realpath;F;[[@c0;[[@˜ i?;T;: realpath;0;[;{;IC;"ÊReturns the real (absolute) pathname for +self+ in the actual filesystem. Does not contain symlinks or useless dots, +..+ and +.+. All components of the pathname must exist when this method is called. ;T;[;[;I"ÌReturns the real (absolute) pathname for +self+ in the actual filesystem. Does not contain symlinks or useless dots, +..+ and +.+. All components of the pathname must exist when this method is called. ;T;0; @½µ;!F;"o;#;$T;%i5;&i=;'@´;(I"static VALUE path_realpath(int argc, VALUE *argv, VALUE self) { VALUE basedir, str; rb_scan_args(argc, argv, "01", &basedir); str = rb_funcall(rb_cFile, id_realpath, 2, get_strpath(self), basedir); return rb_class_new_instance(1, &str, rb_obj_class(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#realdirpath;F;[[@c0;[[@˜ iO;T;:realdirpath;0;[;{;IC;"¿Returns the real (absolute) pathname of +self+ in the actual filesystem. Does not contain symlinks or useless dots, +..+ and +.+. The last component of the real pathname can be nonexistent. ;T;[;[;I"ÀReturns the real (absolute) pathname of +self+ in the actual filesystem. Does not contain symlinks or useless dots, +..+ and +.+. The last component of the real pathname can be nonexistent. ;T;0; @Ìµ;!F;"o;#;$T;%iH;&iM;'@´;(I"static VALUE path_realdirpath(int argc, VALUE *argv, VALUE self) { VALUE basedir, str; rb_scan_args(argc, argv, "01", &basedir); str = rb_funcall(rb_cFile, id_realdirpath, 2, get_strpath(self), basedir); return rb_class_new_instance(1, &str, rb_obj_class(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#each_line;F;[[@c0;[[@˜ ib;T;;;0;[;{;IC;"MIterates over each line in the file and yields a String object for each. ;T;[ o;= ;3I" overload;F;40;;;50;)I"each_line;T;IC;";T; @Ûµ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" line;T; @Ûµ;[;I"@yield [line];T;0;6i;[; @Ûµo;= ;3I" overload;F;40;;;50;)I"$each_line(sep=$/ [, open_args]);T;IC;";T; @Ûµ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" line;T; @Ûµo;2 ;3I"return;F;4I";T;0;5[I"nil;T; @Ûµ;[;I" @yield [line] @return [nil];T;0;6i;[[I"sep;TI"$/[, open_args];T; @Ûµo;= ;3I" overload;F;40;;;50;)I"#each_line(limit [, open_args]);T;IC;";T; @Ûµ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" line;T; @Ûµo;2 ;3I"return;F;4I";T;0;5[I"nil;T; @Ûµ;[;I" @yield [line] @return [nil];T;0;6i;[[I"limit[, open_args];T0; @Ûµo;= ;3I" overload;F;40;;;50;)I"(each_line(sep, limit [, open_args]);T;IC;";T; @Ûµ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" line;T; @Ûµo;2 ;3I"return;F;4I";T;0;5[I"nil;T; @Ûµ;[;I" @yield [line] @return [nil];T;0;6i;[[I"sep;T0[I"limit[, open_args];T0; @Ûµo;= ;3I" overload;F;40;;;50;)I"each_line(...);T;IC;";T; @Ûµ;>0;!F;[;[;I";T;0;6i;[[I"...;T0; @Ûµ;[;I"hIterates over each line in the file and yields a String object for each. @overload each_line @yield [line] @overload each_line(sep=$/ [, open_args]) @yield [line] @return [nil] @overload each_line(limit [, open_args]) @yield [line] @return [nil] @overload each_line(sep, limit [, open_args]) @yield [line] @return [nil] @overload each_line(...);T;0; @Ûµ;!F;"o;#;$T;%iX;&if;'@´;(I"·static VALUE path_each_line(int argc, VALUE *argv, VALUE self) { VALUE args[4]; int n; args[0] = get_strpath(self); n = rb_scan_args(argc, argv, "03", &args[1], &args[2], &args[3]); if (rb_block_given_p()) { return rb_block_call_kw(rb_cFile, id_foreach, 1+n, args, 0, 0, RB_PASS_CALLED_KEYWORDS); } else { return rb_funcallv_kw(rb_cFile, id_foreach, 1+n, args, RB_PASS_CALLED_KEYWORDS); } };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#read;F;[[@c0;[[@˜ i|;T;;è;0;[;{;IC;"YReturns all data from the file, or the first +N+ bytes if specified. See File.read. ;T;[o;= ;3I" overload;F;40;;è;50;)I"read([length [, offset]]);T;IC;";T; @@¶;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @@¶;[;I"@return [String];T;0;6i;[[I"[length [, offset]];T0; @@¶o;= ;3I" overload;F;40;;è;50;)I")read([length [, offset]], open_args);T;IC;";T; @@¶;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @@¶;[;I"@return [String];T;0;6i;[[I"[length [, offset]];T0[I"open_args;T0; @@¶;[;I"ÐReturns all data from the file, or the first +N+ bytes if specified. See File.read. @overload read([length [, offset]]) @return [String] @overload read([length [, offset]], open_args) @return [String];T;0; @@¶;!F;"o;#;$T;%ir;&i{;'@´;(I"static VALUE path_read(int argc, VALUE *argv, VALUE self) { VALUE args[4]; int n; args[0] = get_strpath(self); n = rb_scan_args(argc, argv, "03", &args[1], &args[2], &args[3]); return rb_funcallv_kw(rb_cFile, id_read, 1+n, args, RB_PASS_CALLED_KEYWORDS); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#binread;F;[[@c0;[[@˜ i;T;:binread;0;[;{;IC;"[Returns all the bytes from the file, or the first +N+ if specified. See File.binread. ;T;[o;= ;3I" overload;F;40;;G;50;)I"!binread([length [, offset]]);T;IC;";T; @o¶;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @o¶;[;I"@return [String];T;0;6i;[[I"[length [, offset]];T0; @o¶;[;I"“Returns all the bytes from the file, or the first +N+ if specified. See File.binread. @overload binread([length [, offset]]) @return [String];T;0; @o¶;!F;"o;#;$T;%i‡;&iŽ;'@´;(I"õstatic VALUE path_binread(int argc, VALUE *argv, VALUE self) { VALUE args[3]; int n; args[0] = get_strpath(self); n = rb_scan_args(argc, argv, "02", &args[1], &args[2]); return rb_funcallv(rb_cFile, id_binread, 1+n, args); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#readlines;F;[[@c0;[[@˜ iÐ;T;;§;0;[;{;IC;">Returns all the lines from the file. See File.readlines. ;T;[o;= ;3I" overload;F;40;;§;50;)I"$readlines(sep=$/ [, open_args]);T;IC;";T; @¶;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @¶;[;I"@return [Array];T;0;6i;[[I"sep;TI"$/[, open_args];T; @¶o;= ;3I" overload;F;40;;§;50;)I"#readlines(limit [, open_args]);T;IC;";T; @¶;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @¶;[;I"@return [Array];T;0;6i;[[I"limit[, open_args];T0; @¶o;= ;3I" overload;F;40;;§;50;)I"(readlines(sep, limit [, open_args]);T;IC;";T; @¶;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @¶;[;I"@return [Array];T;0;6i;[[I"sep;T0[I"limit[, open_args];T0; @¶;[;I"óReturns all the lines from the file. See File.readlines. @overload readlines(sep=$/ [, open_args]) @return [Array] @overload readlines(limit [, open_args]) @return [Array] @overload readlines(sep, limit [, open_args]) @return [Array];T;0; @¶;!F;"o;#;$T;%iÅ;&iÐ;'@´;(I"static VALUE path_readlines(int argc, VALUE *argv, VALUE self) { VALUE args[4]; int n; args[0] = get_strpath(self); n = rb_scan_args(argc, argv, "03", &args[1], &args[2], &args[3]); return rb_funcallv_kw(rb_cFile, id_readlines, 1+n, args, RB_PASS_CALLED_KEYWORDS); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#write;F;[[@c0;[[@˜ i¥;T;;é;0;[;{;IC;"4Writes +contents+ to the file. See File.write. ;T;[o;= ;3I" overload;F;40;;é;50;)I"write(string, [offset] );T;IC;";T; @Ì¶;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Fixnum;T; @Ì¶;[;I"@return [Fixnum];T;0;6i;[[I"string;T0[I" [offset];T0; @Ì¶o;= ;3I" overload;F;40;;é;50;)I"(write(string, [offset], open_args );T;IC;";T; @Ì¶;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Fixnum;T; @Ì¶;[;I"@return [Fixnum];T;0;6i;[[I"string;T0[I" [offset];T0[I"open_args;T0; @Ì¶;[;I"©Writes +contents+ to the file. See File.write. @overload write(string, [offset] ) @return [Fixnum] @overload write(string, [offset], open_args ) @return [Fixnum];T;0; @Ì¶;!F;"o;#;$T;%i›;&i¤;'@´;(I"static VALUE path_write(int argc, VALUE *argv, VALUE self) { VALUE args[4]; int n; args[0] = get_strpath(self); n = rb_scan_args(argc, argv, "03", &args[1], &args[2], &args[3]); return rb_funcallv_kw(rb_cFile, id_write, 1+n, args, RB_PASS_CALLED_KEYWORDS); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#binwrite;F;[[@c0;[[@˜ iº;T;: binwrite;0;[;{;IC;"RWrites +contents+ to the file, opening it in binary mode. See File.binwrite. ;T;[o;= ;3I" overload;F;40;;H;50;)I" binwrite(string, [offset] );T;IC;";T; @ÿ¶;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Fixnum;T; @ÿ¶;[;I"@return [Fixnum];T;0;6i;[[I"string;T0[I" [offset];T0; @ÿ¶o;= ;3I" overload;F;40;;H;50;)I"+binwrite(string, [offset], open_args );T;IC;";T; @ÿ¶;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Fixnum;T; @ÿ¶;[;I"@return [Fixnum];T;0;6i;[[I"string;T0[I" [offset];T0[I"open_args;T0; @ÿ¶;[;I"ÍWrites +contents+ to the file, opening it in binary mode. See File.binwrite. @overload binwrite(string, [offset] ) @return [Fixnum] @overload binwrite(string, [offset], open_args ) @return [Fixnum];T;0; @ÿ¶;!F;"o;#;$T;%i°;&i¹;'@´;(I"static VALUE path_binwrite(int argc, VALUE *argv, VALUE self) { VALUE args[4]; int n; args[0] = get_strpath(self); n = rb_scan_args(argc, argv, "03", &args[1], &args[2], &args[3]); return rb_funcallv_kw(rb_cFile, id_binwrite, 1+n, args, RB_PASS_CALLED_KEYWORDS); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#sysopen;F;[[@c0;[[@˜ iâ;T;:sysopen;0;[;{;IC;"See IO.sysopen. ;T;[o;= ;3I" overload;F;40;;I;50;)I"sysopen([mode, [perm]]);T;IC;";T; @2·;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Fixnum;T; @2·;[;I"@return [Fixnum];T;0;6i;[[I"[mode, [perm]];T0; @2·;[;I"LSee IO.sysopen. @overload sysopen([mode, [perm]]) @return [Fixnum];T;0; @2·;!F;"o;#;$T;%iÛ;&ià;'@´;(I"óstatic VALUE path_sysopen(int argc, VALUE *argv, VALUE self) { VALUE args[3]; int n; args[0] = get_strpath(self); n = rb_scan_args(argc, argv, "02", &args[1], &args[2]); return rb_funcallv(rb_cIO, id_sysopen, 1+n, args); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#atime;F;[;[[@˜ iõ;T;: atime;0;[;{;IC;"@Returns the last access time for the file. See File.atime. ;T;[o;= ;3I" overload;F;40;;;50;)I" ->(time);T;IC;";T; @P·;>0;!F;[;[;I";T;0;6i;[; @P·;[;I"UReturns the last access time for the file. See File.atime. @overload ->(time);T;0; @P·;!F;"o;#;$T;%ií;&iò;'@´;(I"mstatic VALUE path_atime(VALUE self) { return rb_funcall(rb_cFile, id_atime, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#birthtime;F;[;[[@˜ i;T;:birthtime;0;[;{;IC;"}Returns the birth time for the file. If the platform doesn't have birthtime, raises NotImplementedError. See File.birthtime. ;T;[o;= ;3I" overload;F;40;;;50;)I" ->(time);T;IC;";T; @f·;>0;!F;[;[;I";T;0;6i;[; @f·;[;I"’Returns the birth time for the file. If the platform doesn't have birthtime, raises NotImplementedError. See File.birthtime. @overload ->(time);T;0; @f·;!F;"o;#;$T;%iü;&i;'@´;(I"ustatic VALUE path_birthtime(VALUE self) { return rb_funcall(rb_cFile, id_birthtime, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#ctime;F;[;[[@˜ i;T;: ctime;0;[;{;IC;"eReturns the last change time, using directory information, not the file itself. See File.ctime. ;T;[o;= ;3I" overload;F;40;;;50;)I" ->(time);T;IC;";T; @|·;>0;!F;[;[;I";T;0;6i;[; @|·;[;I"zReturns the last change time, using directory information, not the file itself. See File.ctime. @overload ->(time);T;0; @|·;!F;"o;#;$T;%i;&i;'@´;(I"mstatic VALUE path_ctime(VALUE self) { return rb_funcall(rb_cFile, id_ctime, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#mtime;F;[;[[@˜ i%;T;;ü;0;[;{;IC;"AReturns the last modified time of the file. See File.mtime. ;T;[o;= ;3I" overload;F;40;;;50;)I" ->(time);T;IC;";T; @’·;>0;!F;[;[;I";T;0;6i;[; @’·;[;I"VReturns the last modified time of the file. See File.mtime. @overload ->(time);T;0; @’·;!F;"o;#;$T;%i;&i";'@´;(I"mstatic VALUE path_mtime(VALUE self) { return rb_funcall(rb_cFile, id_mtime, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#chmod;F;[[I" mode;T0;[[@˜ i3;T;: chmod;0;[;{;IC;"/Changes file permissions. See File.chmod. ;T;[o;= ;3I" overload;F;40;;M;50;)I"chmod(mode_int) -> integer;T;IC;";T; @¨·;>0;!F;[;[;I";T;0;6i;[[I" mode_int;T0; @¨·;[;I"VChanges file permissions. See File.chmod. @overload chmod(mode_int) -> integer;T;0; @¨·;!F;"o;#;$T;%i+;&i0;'@´;(I"static VALUE path_chmod(VALUE self, VALUE mode) { return rb_funcall(rb_cFile, id_chmod, 2, mode, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#lchmod;F;[[I" mode;T0;[[@˜ iA;T;:lchmod;0;[;{;IC;"RSame as Pathname.chmod, but does not follow symbolic links. See File.lchmod. ;T;[o;= ;3I" overload;F;40;;N;50;)I" lchmod(mode_int) -> integer;T;IC;";T; @Â·;>0;!F;[;[;I";T;0;6i;[[I" mode_int;T0; @Â·;[;I"zSame as Pathname.chmod, but does not follow symbolic links. See File.lchmod. @overload lchmod(mode_int) -> integer;T;0; @Â·;!F;"o;#;$T;%i9;&i>;'@´;(I"|static VALUE path_lchmod(VALUE self, VALUE mode) { return rb_funcall(rb_cFile, id_lchmod, 2, mode, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#chown;F;[[I" owner;T0[I" group;T0;[[@˜ iO;T;: chown;0;[;{;IC;"9Change owner and group of the file. See File.chown. ;T;[o;= ;3I" overload;F;40;;O;50;)I"+chown(owner_int, group_int) -> integer;T;IC;";T; @Ü·;>0;!F;[;[;I";T;0;6i;[[I"owner_int;T0[I"group_int;T0; @Ü·;[;I"lChange owner and group of the file. See File.chown. @overload chown(owner_int, group_int) -> integer;T;0; @Ü·;!F;"o;#;$T;%iG;&iL;'@´;(I"static VALUE path_chown(VALUE self, VALUE owner, VALUE group) { return rb_funcall(rb_cFile, id_chown, 3, owner, group, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#lchown;F;[[I" owner;T0[I" group;T0;[[@˜ i];T;:lchown;0;[;{;IC;"RSame as Pathname.chown, but does not follow symbolic links. See File.lchown. ;T;[o;= ;3I" overload;F;40;;P;50;)I",lchown(owner_int, group_int) -> integer;T;IC;";T; @ú·;>0;!F;[;[;I";T;0;6i;[[I"owner_int;T0[I"group_int;T0; @ú·;[;I"Same as Pathname.chown, but does not follow symbolic links. See File.lchown. @overload lchown(owner_int, group_int) -> integer;T;0; @ú·;!F;"o;#;$T;%iU;&iZ;'@´;(I"’static VALUE path_lchown(VALUE self, VALUE owner, VALUE group) { return rb_funcall(rb_cFile, id_lchown, 3, owner, group, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#fnmatch;F;[[@c0;[[@˜ il;T;:fnmatch;0;[;{;IC;"PReturn +true+ if the receiver matches the given pattern. See File.fnmatch. ;T;[o;= ;3I" overload;F;40;;Q;50;)I"fnmatch(pattern, [flags]);T;IC;";T; @¸;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @¸;[;I"@return [Boolean];T;0;6i;[[I"pattern;T0[I"[flags];T0; @¸o;= ;3I" overload;F;40;: fnmatch?;50;)I"fnmatch?(pattern, [flags]);T;IC;";T; @¸;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @¸;[;I"@return [Boolean];T;0;6i;[[I"pattern;T0[I"[flags];T0; @¸;[;I"¾Return +true+ if the receiver matches the given pattern. See File.fnmatch. @overload fnmatch(pattern, [flags]) @return [Boolean] @overload fnmatch?(pattern, [flags]) @return [Boolean];T;0; @¸;!F;"o;#;$T;%ic;&ik;'@´;(I"Pstatic VALUE path_fnmatch(int argc, VALUE *argv, VALUE self) { VALUE str = get_strpath(self); VALUE pattern, flags; if (rb_scan_args(argc, argv, "11", &pattern, &flags) == 1) return rb_funcall(rb_cFile, id_fnmatch, 2, pattern, str); else return rb_funcall(rb_cFile, id_fnmatch, 3, pattern, str, flags); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#fnmatch?;F;[[@c0;[[@˜ il;T;;R;0;[;{;IC;"PReturn +true+ if the receiver matches the given pattern. See File.fnmatch.;T;[o;= ;3I" overload;F;40;;Q;50;)I"fnmatch(pattern, [flags]);T;IC;";T; @I¸;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @I¸;[;I"@return [Boolean];T;0;6i;[[I"pattern;T0[I"[flags];T0; @I¸o;= ;3I" overload;F;40;;R;50;)I"fnmatch?(pattern, [flags]);T;IC;";T; @I¸;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @I¸;[;I"@return [Boolean];T;0;6i;[[I"pattern;T0[I"[flags];T0; @I¸;[;@E¸;0; @I¸;!F;"o;#;$T;%ic;&ik;6i;'@´;(I"Pstatic VALUE path_fnmatch(int argc, VALUE *argv, VALUE self) { VALUE str = get_strpath(self); VALUE pattern, flags; if (rb_scan_args(argc, argv, "11", &pattern, &flags) == 1) return rb_funcall(rb_cFile, id_fnmatch, 2, pattern, str); else return rb_funcall(rb_cFile, id_fnmatch, 3, pattern, str, flags); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#ftype;F;[;[[@˜ i;T;: ftype;0;[;{;IC;"HReturns "type" of file ("file", "directory", etc). See File.ftype. ;T;[o;= ;3I" overload;F;40;;;50;)I"->(string);T;IC;";T; @y¸;>0;!F;[;[;I";T;0;6i;[; @y¸;[;I"_Returns "type" of file ("file", "directory", etc). See File.ftype. @overload ->(string);T;0; @y¸;!F;"o;#;$T;%iw;&i|;'@´;(I"mstatic VALUE path_ftype(VALUE self) { return rb_funcall(rb_cFile, id_ftype, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#make_link;F;[[I"old;T0;[[@˜ i;T;:make_link;0;[;{;IC;"7Creates a hard link at _pathname_. See File.link. ;T;[o;= ;3I" overload;F;40;;T;50;)I"make_link(old);T;IC;";T; @¸;>0;!F;[;[;I";T;0;6i;[[I"old;T0; @¸;[;I"RCreates a hard link at _pathname_. See File.link. @overload make_link(old);T;0; @¸;!F;"o;#;$T;%i…;&iŠ;'@´;(I"{static VALUE path_make_link(VALUE self, VALUE old) { return rb_funcall(rb_cFile, id_link, 2, old, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#open;F;[[@c0;[[@˜ iŸ;T;;Ÿ;0;[;{;IC;";Opens the file for reading or writing. See File.open. ;T;[ o;= ;3I" overload;F;40;;Ÿ;50;)I"open();T;IC;";T; @©¸;>0;!F;[;[;I";T;0;6i;[; @©¸o;= ;3I" overload;F;40;;Ÿ;50;)I"open(mode="r" [, opt]);T;IC;";T; @©¸;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" File;T; @©¸;[;I"@return [File];T;0;6i;[[I" mode;TI""r"[, opt];T; @©¸o;= ;3I" overload;F;40;;Ÿ;50;)I""open([mode [, perm]] [, opt]);T;IC;";T; @©¸;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" File;T; @©¸;[;I"@return [File];T;0;6i;[[I"[mode [, perm]][, opt];T0; @©¸o;= ;3I" overload;F;40;;Ÿ;50;)I"open(mode="r" [, opt]);T;IC;";T; @©¸;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" file;T; @©¸o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @©¸;[;I"#@yield [file] @return [Object];T;0;6i;[[I" mode;TI""r"[, opt];T; @©¸o;= ;3I" overload;F;40;;Ÿ;50;)I""open([mode [, perm]] [, opt]);T;IC;";T; @©¸;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" file;T; @©¸o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @©¸;[;I"#@yield [file] @return [Object];T;0;6i;[[I"[mode [, perm]][, opt];T0; @©¸;[;I"COpens the file for reading or writing. See File.open. @overload open() @overload open(mode="r" [, opt]) @return [File] @overload open([mode [, perm]] [, opt]) @return [File] @overload open(mode="r" [, opt]) @yield [file] @return [Object] @overload open([mode [, perm]] [, opt]) @yield [file] @return [Object];T;0; @©¸;!F;"o;#;$T;%i“;&i¢;'@´;(I"¬static VALUE path_open(int argc, VALUE *argv, VALUE self) { VALUE args[4]; int n; args[0] = get_strpath(self); n = rb_scan_args(argc, argv, "03", &args[1], &args[2], &args[3]); if (rb_block_given_p()) { return rb_block_call_kw(rb_cFile, id_open, 1+n, args, 0, 0, RB_PASS_CALLED_KEYWORDS); } else { return rb_funcallv_kw(rb_cFile, id_open, 1+n, args, RB_PASS_CALLED_KEYWORDS); } };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#readlink;F;[;[[@˜ i´;T;: readlink;0;[;{;IC;",Read symbolic link. See File.readlink. ;T;[;[;I"-Read symbolic link. See File.readlink. ;T;0; @¹;!F;"o;#;$T;%i¯;&i²;'@´;(I"»static VALUE path_readlink(VALUE self) { VALUE str; str = rb_funcall(rb_cFile, id_readlink, 1, get_strpath(self)); return rb_class_new_instance(1, &str, rb_obj_class(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#rename;F;[[I"to;T0;[[@˜ iÁ;T;:rename;0;[;{;IC;"'Rename the file. See File.rename. ;T;[;[;I"(Rename the file. See File.rename. ;T;0; @¹;!F;"o;#;$T;%i¼;&i¿;'@´;(I"}static VALUE path_rename(VALUE self, VALUE to) { return rb_funcall(rb_cFile, id_rename, 2, get_strpath(self), to); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#stat;F;[;[[@˜ iÌ;T;: stat;0;[;{;IC;"1Returns a File::Stat object. See File.stat. ;T;[;[;I"2Returns a File::Stat object. See File.stat. ;T;0; @&¹;!F;"o;#;$T;%iÇ;&iÊ;'@´;(I"kstatic VALUE path_stat(VALUE self) { return rb_funcall(rb_cFile, id_stat, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#lstat;F;[;[[@˜ iÕ;T;: lstat;0;[;{;IC;"See File.lstat. ;T;[;[;I"See File.lstat. ;T;0; @4¹;!F;"o;#;$T;%iÒ;&iÓ;'@´;(I"mstatic VALUE path_lstat(VALUE self) { return rb_funcall(rb_cFile, id_lstat, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#make_symlink;F;[[I"old;T0;[[@˜ iã;T;:make_symlink;0;[;{;IC;"0Creates a symbolic link. See File.symlink. ;T;[o;= ;3I" overload;F;40;;Y;50;)I"make_symlink(old);T;IC;";T; @B¹;>0;!F;[;[;I";T;0;6i;[[I"old;T0; @B¹;[;I"NCreates a symbolic link. See File.symlink. @overload make_symlink(old);T;0; @B¹;!F;"o;#;$T;%iÛ;&ià;'@´;(I"static VALUE path_make_symlink(VALUE self, VALUE old) { return rb_funcall(rb_cFile, id_symlink, 2, old, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#truncate;F;[[I"length;T0;[[@˜ iî;T;;c;0;[;{;IC;">Truncates the file to +length+ bytes. See File.truncate. ;T;[;[;I"?Truncates the file to +length+ bytes. See File.truncate. ;T;0; @\¹;!F;"o;#;$T;%ié;&iì;'@´;(I"„static VALUE path_truncate(VALUE self, VALUE length) { return rb_funcall(rb_cFile, id_truncate, 2, get_strpath(self), length); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#utime;F;[[I" atime;T0[I" mtime;T0;[[@˜ iù;T;: utime;0;[;{;IC;"KUpdate the access and modification times of the file. See File.utime. ;T;[;[;I"LUpdate the access and modification times of the file. See File.utime. ;T;0; @l¹;!F;"o;#;$T;%iô;&i÷;'@´;(I"static VALUE path_utime(VALUE self, VALUE atime, VALUE mtime) { return rb_funcall(rb_cFile, id_utime, 3, atime, mtime, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#basename;F;[[@c0;[[@˜ i;T;: basename;0;[;{;IC;"@Returns the last component of the path. See File.basename. ;T;[;[;I"AReturns the last component of the path. See File.basename. ;T;0; @~¹;!F;"o;#;$T;%iÿ;&i;'@´;(I"hstatic VALUE path_basename(int argc, VALUE *argv, VALUE self) { VALUE str = get_strpath(self); VALUE fext; if (rb_scan_args(argc, argv, "01", &fext) == 0) str = rb_funcall(rb_cFile, id_basename, 1, str); else str = rb_funcall(rb_cFile, id_basename, 2, str, fext); return rb_class_new_instance(1, &str, rb_obj_class(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#dirname;F;[;[[@˜ i;T;:dirname;0;[;{;IC;"GReturns all but the last component of the path. See File.dirname. ;T;[;[;I"HReturns all but the last component of the path. See File.dirname. ;T;0; @¹;!F;"o;#;$T;%i;&i;'@´;(I"¿static VALUE path_dirname(VALUE self) { VALUE str = get_strpath(self); str = rb_funcall(rb_cFile, id_dirname, 1, str); return rb_class_new_instance(1, &str, rb_obj_class(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#extname;F;[;[[@˜ i";T;:extname;0;[;{;IC;"5Returns the file's extension. See File.extname. ;T;[;[;I"6Returns the file's extension. See File.extname. ;T;0; @›¹;!F;"o;#;$T;%i;&i ;'@´;(I"static VALUE path_extname(VALUE self) { VALUE str = get_strpath(self); return rb_funcall(rb_cFile, id_extname, 1, str); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#expand_path;F;[[@c0;[[@˜ i.;T;:expand_path;0;[;{;IC;"CReturns the absolute path for the file. See File.expand_path. ;T;[;[;I"DReturns the absolute path for the file. See File.expand_path. ;T;0; @©¹;!F;"o;#;$T;%i);&i,;'@´;(I"tstatic VALUE path_expand_path(int argc, VALUE *argv, VALUE self) { VALUE str = get_strpath(self); VALUE dname; if (rb_scan_args(argc, argv, "01", &dname) == 0) str = rb_funcall(rb_cFile, id_expand_path, 1, str); else str = rb_funcall(rb_cFile, id_expand_path, 2, str, dname); return rb_class_new_instance(1, &str, rb_obj_class(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#split;F;[;[[@˜ i?;T;;‡;0;[;{;IC;"IReturns the #dirname and the #basename in an Array. See File.split. ;T;[;[;I"JReturns the #dirname and the #basename in an Array. See File.split. ;T;0; @¸¹;!F;"o;#;$T;%i:;&i=;'@´;(I"Çstatic VALUE path_split(VALUE self) { VALUE str = get_strpath(self); VALUE ary, dirname, basename; ary = rb_funcall(rb_cFile, id_split, 1, str); ary = rb_check_array_type(ary); dirname = rb_ary_entry(ary, 0); basename = rb_ary_entry(ary, 1); dirname = rb_class_new_instance(1, &dirname, rb_obj_class(self)); basename = rb_class_new_instance(1, &basename, rb_obj_class(self)); return rb_ary_new3(2, dirname, basename); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#blockdev?;F;[;[[@˜ iP;T;:blockdev?;0;[;{;IC;"See FileTest.blockdev?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @Æ¹;[;I"See FileTest.blockdev?. ;T;0; @Æ¹;!F;"o;#;$T;%iM;&iN;6i;'@´;(I"{static VALUE path_blockdev_p(VALUE self) { return rb_funcall(rb_mFileTest, id_blockdev_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#chardev?;F;[;[[@˜ iY;T;: chardev?;0;[;{;IC;"See FileTest.chardev?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @×¹;[;I"See FileTest.chardev?. ;T;0; @×¹;!F;"o;#;$T;%iV;&iW;6i;'@´;(I"ystatic VALUE path_chardev_p(VALUE self) { return rb_funcall(rb_mFileTest, id_chardev_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#executable?;F;[;[[@˜ ib;T;:executable?;0;[;{;IC;"See FileTest.executable?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @è¹;[;I"See FileTest.executable?. ;T;0; @è¹;!F;"o;#;$T;%i_;&i`;6i;'@´;(I"static VALUE path_executable_p(VALUE self) { return rb_funcall(rb_mFileTest, id_executable_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#executable_real?;F;[;[[@˜ ik;T;:executable_real?;0;[;{;IC;"#See FileTest.executable_real?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @ù¹;[;I"$See FileTest.executable_real?. ;T;0; @ù¹;!F;"o;#;$T;%ih;ⅈ6i;'@´;(I"„static VALUE path_executable_real_p(VALUE self) { return rb_funcall(rb_mFileTest, id_executable_real_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#exist?;F;[;[[@˜ it;T;:exist?;0;[;{;IC;"See FileTest.exist?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @ º;[;I"See FileTest.exist?. ;T;0; @ º;!F;"o;#;$T;%iq;&ir;6i;'@´;(I"ustatic VALUE path_exist_p(VALUE self) { return rb_funcall(rb_mFileTest, id_exist_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#grpowned?;F;[;[[@˜ i};T;:grpowned?;0;[;{;IC;"See FileTest.grpowned?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @º;[;I"See FileTest.grpowned?. ;T;0; @º;!F;"o;#;$T;%iz;&i{;6i;'@´;(I"{static VALUE path_grpowned_p(VALUE self) { return rb_funcall(rb_mFileTest, id_grpowned_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#directory?;F;[;[[@˜ i†;T;:directory?;0;[;{;IC;"See FileTest.directory?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @,º;[;I"See FileTest.directory?. ;T;0; @,º;!F;"o;#;$T;%iƒ;&i„;6i;'@´;(I"}static VALUE path_directory_p(VALUE self) { return rb_funcall(rb_mFileTest, id_directory_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#file?;F;[;[[@˜ i;T;: file?;0;[;{;IC;"See FileTest.file?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @=º;[;I"See FileTest.file?. ;T;0; @=º;!F;"o;#;$T;%iŒ;&i;6i;'@´;(I"sstatic VALUE path_file_p(VALUE self) { return rb_funcall(rb_mFileTest, id_file_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#pipe?;F;[;[[@˜ i˜;T;: pipe?;0;[;{;IC;"See FileTest.pipe?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @Nº;[;I"See FileTest.pipe?. ;T;0; @Nº;!F;"o;#;$T;%i•;&i–;6i;'@´;(I"sstatic VALUE path_pipe_p(VALUE self) { return rb_funcall(rb_mFileTest, id_pipe_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#socket?;F;[;[[@˜ i¡;T;:socket?;0;[;{;IC;"See FileTest.socket?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @_º;[;I"See FileTest.socket?. ;T;0; @_º;!F;"o;#;$T;%iž;&iŸ;6i;'@´;(I"wstatic VALUE path_socket_p(VALUE self) { return rb_funcall(rb_mFileTest, id_socket_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#owned?;F;[;[[@˜ iª;T;:owned?;0;[;{;IC;"See FileTest.owned?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @pº;[;I"See FileTest.owned?. ;T;0; @pº;!F;"o;#;$T;%i§;&i¨;6i;'@´;(I"ustatic VALUE path_owned_p(VALUE self) { return rb_funcall(rb_mFileTest, id_owned_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#readable?;F;[;[[@˜ i³;T;:readable?;0;[;{;IC;"See FileTest.readable?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @º;[;I"See FileTest.readable?. ;T;0; @º;!F;"o;#;$T;%i°;&i±;6i;'@´;(I"{static VALUE path_readable_p(VALUE self) { return rb_funcall(rb_mFileTest, id_readable_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#world_readable?;F;[;[[@˜ i¼;T;:world_readable?;0;[;{;IC;""See FileTest.world_readable?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @’º;[;I"#See FileTest.world_readable?. ;T;0; @’º;!F;"o;#;$T;%i¹;&iº;6i;'@´;(I"‚static VALUE path_world_readable_p(VALUE self) { return rb_funcall(rb_mFileTest, id_world_readable_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#readable_real?;F;[;[[@˜ iÅ;T;:readable_real?;0;[;{;IC;"!See FileTest.readable_real?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @£º;[;I""See FileTest.readable_real?. ;T;0; @£º;!F;"o;#;$T;%iÂ;&iÃ;6i;'@´;(I"€static VALUE path_readable_real_p(VALUE self) { return rb_funcall(rb_mFileTest, id_readable_real_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#setuid?;F;[;[[@˜ iÎ;T;:setuid?;0;[;{;IC;"See FileTest.setuid?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @´º;[;I"See FileTest.setuid?. ;T;0; @´º;!F;"o;#;$T;%iË;&iÌ;6i;'@´;(I"wstatic VALUE path_setuid_p(VALUE self) { return rb_funcall(rb_mFileTest, id_setuid_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#setgid?;F;[;[[@˜ i×;T;:setgid?;0;[;{;IC;"See FileTest.setgid?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @Åº;[;I"See FileTest.setgid?. ;T;0; @Åº;!F;"o;#;$T;%iÔ;&iÕ;6i;'@´;(I"wstatic VALUE path_setgid_p(VALUE self) { return rb_funcall(rb_mFileTest, id_setgid_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#size;F;[;[[@˜ ià;T;;¯;0;[;{;IC;"See FileTest.size. ;T;[;[;I"See FileTest.size. ;T;0; @Öº;!F;"o;#;$T;%iÝ;&iÞ;'@´;(I"ostatic VALUE path_size(VALUE self) { return rb_funcall(rb_mFileTest, id_size, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#size?;F;[;[[@˜ ié;T;: size?;0;[;{;IC;"See FileTest.size?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @äº;[;I"See FileTest.size?. ;T;0; @äº;!F;"o;#;$T;%iæ;&iç;6i;'@´;(I"sstatic VALUE path_size_p(VALUE self) { return rb_funcall(rb_mFileTest, id_size_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#sticky?;F;[;[[@˜ iò;T;:sticky?;0;[;{;IC;"See FileTest.sticky?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @õº;[;I"See FileTest.sticky?. ;T;0; @õº;!F;"o;#;$T;%iï;&ið;6i;'@´;(I"wstatic VALUE path_sticky_p(VALUE self) { return rb_funcall(rb_mFileTest, id_sticky_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#symlink?;F;[;[[@˜ iû;T;: symlink?;0;[;{;IC;"See FileTest.symlink?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @»;[;I"See FileTest.symlink?. ;T;0; @»;!F;"o;#;$T;%iø;&iù;6i;'@´;(I"ystatic VALUE path_symlink_p(VALUE self) { return rb_funcall(rb_mFileTest, id_symlink_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#writable?;F;[;[[@˜ i;T;:writable?;0;[;{;IC;"See FileTest.writable?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @»;[;I"See FileTest.writable?. ;T;0; @»;!F;"o;#;$T;%i;&i;6i;'@´;(I"{static VALUE path_writable_p(VALUE self) { return rb_funcall(rb_mFileTest, id_writable_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#world_writable?;F;[;[[@˜ i ;T;:world_writable?;0;[;{;IC;""See FileTest.world_writable?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @(»;[;I"#See FileTest.world_writable?. ;T;0; @(»;!F;"o;#;$T;%i ;&i;6i;'@´;(I"‚static VALUE path_world_writable_p(VALUE self) { return rb_funcall(rb_mFileTest, id_world_writable_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#writable_real?;F;[;[[@˜ i;T;:writable_real?;0;[;{;IC;"!See FileTest.writable_real?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @9»;[;I""See FileTest.writable_real?. ;T;0; @9»;!F;"o;#;$T;%i;&i;6i;'@´;(I"€static VALUE path_writable_real_p(VALUE self) { return rb_funcall(rb_mFileTest, id_writable_real_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#zero?;F;[;[[@˜ i;T;;^;0;[;{;IC;"See FileTest.zero?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @J»;[;I"See FileTest.zero?. ;T;0; @J»;!F;"o;#;$T;%i;&i;6i;'@´;(I"sstatic VALUE path_zero_p(VALUE self) { return rb_funcall(rb_mFileTest, id_zero_p, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#empty?;F;[;[[@˜ i*;T;;±;0;[;{;IC;"BTests the file is empty. See Dir#empty? and FileTest.empty?.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @[»;[;I"CTests the file is empty. See Dir#empty? and FileTest.empty?. ;T;0; @[»;!F;"o;#;$T;%i%;&i(;6i;'@´;(I"static VALUE path_empty_p(VALUE self) { VALUE path = get_strpath(self); if (RTEST(rb_funcall(rb_mFileTest, id_directory_p, 1, path))) return rb_funcall(rb_cDir, id_empty_p, 1, path); else return rb_funcall(rb_mFileTest, id_empty_p, 1, path); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Pathname.glob;F;[[@c0;[[@˜ iC;T;: glob;0;[;{;IC;"‡Returns or yields Pathname objects. Pathname.glob("lib/i*.rb") #=> [#, #] See Dir.glob. ;T;[;[;I"ˆReturns or yields Pathname objects. Pathname.glob("lib/i*.rb") #=> [#, #] See Dir.glob. ;T;0; @l»;!F;"o;#;$T;%i;;&iA;'@´;(I"Ðstatic VALUE path_s_glob(int argc, VALUE *argv, VALUE klass) { VALUE args[3]; int n; n = rb_scan_args(argc, argv, "12", &args[0], &args[1], &args[2]); if (rb_block_given_p()) { return rb_block_call_kw(rb_cDir, id_glob, n, args, s_glob_i, klass, RB_PASS_CALLED_KEYWORDS); } else { VALUE ary; long i; ary = rb_funcallv_kw(rb_cDir, id_glob, n, args, RB_PASS_CALLED_KEYWORDS); ary = rb_convert_type(ary, T_ARRAY, "Array", "to_ary"); for (i = 0; i < RARRAY_LEN(ary); i++) { VALUE elt = RARRAY_AREF(ary, i); elt = rb_class_new_instance(1, &elt, klass); rb_ary_store(ary, i, elt); } return ary; } };T;)I"static VALUE;T;*To;;F; ;F;;;I"Pathname.getwd;F;[;[[@˜ i“;T;: getwd;0;[;{;IC;"Returns the current working directory as a Pathname. Pathname.getwd #=> # See Dir.getwd. ;T;[;[;I"‚Returns the current working directory as a Pathname. Pathname.getwd #=> # See Dir.getwd. ;T;0; @{»;!F;"o;#;$T;%i‹;&i‘;'@´;(I"—static VALUE path_s_getwd(VALUE klass) { VALUE str; str = rb_funcall(rb_cDir, id_getwd, 0); return rb_class_new_instance(1, &str, klass); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Pathname.pwd;F;[;[[@˜ i“;T;:pwd;0;[;{;IC;"Returns the current working directory as a Pathname. Pathname.getwd #=> # See Dir.getwd. ;T;[;[;@…»;0; @‰»;!F;"o;#;$T;%i‹;&i‘;'@´;(I"—static VALUE path_s_getwd(VALUE klass) { VALUE str; str = rb_funcall(rb_cDir, id_getwd, 0); return rb_class_new_instance(1, &str, klass); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#glob;F;[[@c0;[[@˜ ik;T;;u;0;[;{;IC;"àReturns or yields Pathname objects. Pathname("ruby-2.4.2").glob("R*.md") #=> [#, #] See Dir.glob. This method uses the +base+ keyword argument of Dir.glob. ;T;[;[;I"áReturns or yields Pathname objects. Pathname("ruby-2.4.2").glob("R*.md") #=> [#, #] See Dir.glob. This method uses the +base+ keyword argument of Dir.glob. ;T;0; @–»;!F;"o;#;$T;%ib;ⅈ'@´;(I"@static VALUE path_glob(int argc, VALUE *argv, VALUE self) { VALUE args[3]; int n; n = rb_scan_args(argc, argv, "11", &args[0], &args[1]); if (n == 1) args[1] = INT2FIX(0); args[2] = rb_hash_new(); rb_hash_aset(args[2], ID2SYM(id_base), get_strpath(self)); n = 3; if (rb_block_given_p()) { return rb_block_call_kw(rb_cDir, id_glob, n, args, glob_i, self, RB_PASS_KEYWORDS); } else { VALUE ary; long i; ary = rb_funcallv_kw(rb_cDir, id_glob, n, args, RB_PASS_KEYWORDS); ary = rb_convert_type(ary, T_ARRAY, "Array", "to_ary"); for (i = 0; i < RARRAY_LEN(ary); i++) { VALUE elt = RARRAY_AREF(ary, i); elt = rb_funcall(self, '+', 1, elt); rb_ary_store(ary, i, elt); } return ary; } };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#entries;F;[;[[@˜ iµ;T;;";0;[;{;IC;"ÌReturn the entries (files and subdirectories) in the directory, each as a Pathname object. The results contains just the names in the directory, without any trailing slashes or recursive look-up. pp Pathname.new('/usr/local').entries #=> [#, # #, # #, # #, # #, # #, # #, # #, # #, # #, # #] The result may contain the current directory # and the parent directory #. If you don't want +.+ and +..+ and want directories, consider Pathname#children. ;T;[;[;I"ÍReturn the entries (files and subdirectories) in the directory, each as a Pathname object. The results contains just the names in the directory, without any trailing slashes or recursive look-up. pp Pathname.new('/usr/local').entries #=> [#, # #, # #, # #, # #, # #, # #, # #, # #, # #, # #] The result may contain the current directory # and the parent directory #. If you don't want +.+ and +..+ and want directories, consider Pathname#children. ;T;0; @¥»;!F;"o;#;$T;%i›;&i³;'@´;(I"¸static VALUE path_entries(VALUE self) { VALUE klass, str, ary; long i; klass = rb_obj_class(self); str = get_strpath(self); ary = rb_funcall(rb_cDir, id_entries, 1, str); ary = rb_convert_type(ary, T_ARRAY, "Array", "to_ary"); for (i = 0; i < RARRAY_LEN(ary); i++) { VALUE elt = RARRAY_AREF(ary, i); elt = rb_class_new_instance(1, &elt, klass); rb_ary_store(ary, i, elt); } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#mkdir;F;[[@c0;[[@˜ iË;T;: mkdir;0;[;{;IC;"5Create the referenced directory. See Dir.mkdir. ;T;[;[;I"6Create the referenced directory. See Dir.mkdir. ;T;0; @³»;!F;"o;#;$T;%iÆ;&iÉ;'@´;(I"#static VALUE path_mkdir(int argc, VALUE *argv, VALUE self) { VALUE str = get_strpath(self); VALUE vmode; if (rb_scan_args(argc, argv, "01", &vmode) == 0) return rb_funcall(rb_cDir, id_mkdir, 1, str); else return rb_funcall(rb_cDir, id_mkdir, 2, str, vmode); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#rmdir;F;[;[[@˜ iÛ;T;: rmdir;0;[;{;IC;"5Remove the referenced directory. See Dir.rmdir. ;T;[;[;I"6Remove the referenced directory. See Dir.rmdir. ;T;0; @Â»;!F;"o;#;$T;%iÖ;&iÙ;'@´;(I"lstatic VALUE path_rmdir(VALUE self) { return rb_funcall(rb_cDir, id_rmdir, 1, get_strpath(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#opendir;F;[;[[@˜ iæ;T;:opendir;0;[;{;IC;"3Opens the referenced directory. See Dir.open. ;T;[;[;I"4Opens the referenced directory. See Dir.open. ;T;0; @Ð»;!F;"o;#;$T;%iá;&iä;'@´;(I"™static VALUE path_opendir(VALUE self) { VALUE args[1]; args[0] = get_strpath(self); return rb_block_call(rb_cDir, id_open, 1, args, 0, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#each_entry;F;[;[[@˜ iù;T;;H;0;[;{;IC;"vIterates over the entries (files and subdirectories) in the directory, yielding a Pathname object for each entry. ;T;[;[;I"wIterates over the entries (files and subdirectories) in the directory, yielding a Pathname object for each entry. ;T;0; @Þ»;!F;"o;#;$T;%iõ;&i÷;'@´;(I"»static VALUE path_each_entry(VALUE self) { VALUE args[1]; args[0] = get_strpath(self); return rb_block_call(rb_cDir, id_foreach, 1, args, each_entry_i, rb_obj_class(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#unlink;F;[;[[@˜ i;T;:unlink;0;[;{;IC;"dRemoves a file or directory, using File.unlink if +self+ is a file, or Dir.unlink as necessary. ;T;[;[;I"eRemoves a file or directory, using File.unlink if +self+ is a file, or Dir.unlink as necessary. ;T;0; @ì»;!F;"o;#;$T;%i;&i;'@´;(I"Ùstatic VALUE path_unlink(VALUE self) { VALUE eENOTDIR = rb_const_get_at(rb_mErrno, id_ENOTDIR); VALUE str = get_strpath(self); return rb_rescue2(unlink_body, str, unlink_rescue, str, eENOTDIR, (VALUE)0); };T;)I"static VALUE;T;*To;;F; ;;;;I"Pathname#delete;F;[;[[@˜ i;T;;½;0;[;{;IC;"dRemoves a file or directory, using File.unlink if +self+ is a file, or Dir.unlink as necessary. ;T;[;[;@ö»;0; @ú»;!F;"o;#;$T;%i;&i;'@´;(I"Ùstatic VALUE path_unlink(VALUE self) { VALUE eENOTDIR = rb_const_get_at(rb_mErrno, id_ENOTDIR); VALUE str = get_strpath(self); return rb_rescue2(unlink_body, str, unlink_rescue, str, eENOTDIR, (VALUE)0); };T;)I"static VALUE;T;*T;A@´;BIC;[;A@´;CIC;[;A@´;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@˜ iñ;F;;›;;K;;;[;{;IC;";T;[;[;@|;0; @´;6i;'@;I" Pathname;F;S@]o; ;IC;[o; ;IC;[5o;;F; ;;;;I"%Enumerator::Lazy#_enumerable_map;F;[;[[@ëiÊ;F;:_enumerable_map;;K;[;{;IC;";T;[;[;@|;0; @¼;'@¼;)I"def _enumerable_map;To;;F; ;;;;I")Enumerator::Lazy#_enumerable_collect;F;[;[[@ëiË;F;:_enumerable_collect;;K;[;{;IC;";T;[;[;@|;0; @%¼;'@¼;)I"def _enumerable_collect;To;;F; ;;;;I"*Enumerator::Lazy#_enumerable_flat_map;F;[;[[@ëiÌ;F;:_enumerable_flat_map;;K;[;{;IC;";T;[;[;@|;0; @0¼;'@¼;)I"def _enumerable_flat_map;To;;F; ;;;;I"0Enumerator::Lazy#_enumerable_collect_concat;F;[;[[@ëiÍ;F;:_enumerable_collect_concat;;K;[;{;IC;";T;[;[;@|;0; @;¼;'@¼;)I"#def _enumerable_collect_concat;To;;F; ;;;;I"(Enumerator::Lazy#_enumerable_select;F;[;[[@ëiÎ;F;:_enumerable_select;;K;[;{;IC;";T;[;[;@|;0; @F¼;'@¼;)I"def _enumerable_select;To;;F; ;;;;I"*Enumerator::Lazy#_enumerable_find_all;F;[;[[@ëiÏ;F;:_enumerable_find_all;;K;[;{;IC;";T;[;[;@|;0; @Q¼;'@¼;)I"def _enumerable_find_all;To;;F; ;;;;I"(Enumerator::Lazy#_enumerable_filter;F;[;[[@ëiÐ;F;:_enumerable_filter;;K;[;{;IC;";T;[;[;@|;0; @\¼;'@¼;)I"def _enumerable_filter;To;;F; ;;;;I",Enumerator::Lazy#_enumerable_filter_map;F;[;[[@ëiÑ;F;:_enumerable_filter_map;;K;[;{;IC;";T;[;[;@|;0; @g¼;'@¼;)I"def _enumerable_filter_map;To;;F; ;;;;I"(Enumerator::Lazy#_enumerable_reject;F;[;[[@ëiÒ;F;:_enumerable_reject;;K;[;{;IC;";T;[;[;@|;0; @r¼;'@¼;)I"def _enumerable_reject;To;;F; ;;;;I"&Enumerator::Lazy#_enumerable_grep;F;[;[[@ëiÓ;F;:_enumerable_grep;;K;[;{;IC;";T;[;[;@|;0; @}¼;'@¼;)I"def _enumerable_grep;To;;F; ;;;;I"(Enumerator::Lazy#_enumerable_grep_v;F;[;[[@ëiÔ;F;:_enumerable_grep_v;;K;[;{;IC;";T;[;[;@|;0; @ˆ¼;'@¼;)I"def _enumerable_grep_v;To;;F; ;;;;I"%Enumerator::Lazy#_enumerable_zip;F;[;[[@ëiÕ;F;:_enumerable_zip;;K;[;{;IC;";T;[;[;@|;0; @“¼;'@¼;)I"def _enumerable_zip;To;;F; ;;;;I"&Enumerator::Lazy#_enumerable_take;F;[;[[@ëiÖ;F;:_enumerable_take;;K;[;{;IC;";T;[;[;@|;0; @ž¼;'@¼;)I"def _enumerable_take;To;;F; ;;;;I",Enumerator::Lazy#_enumerable_take_while;F;[;[[@ëi×;F;:_enumerable_take_while;;K;[;{;IC;";T;[;[;@|;0; @©¼;'@¼;)I"def _enumerable_take_while;To;;F; ;;;;I"&Enumerator::Lazy#_enumerable_drop;F;[;[[@ëiØ;F;:_enumerable_drop;;K;[;{;IC;";T;[;[;@|;0; @´¼;'@¼;)I"def _enumerable_drop;To;;F; ;;;;I",Enumerator::Lazy#_enumerable_drop_while;F;[;[[@ëiÙ;F;:_enumerable_drop_while;;K;[;{;IC;";T;[;[;@|;0; @¿¼;'@¼;)I"def _enumerable_drop_while;To;;F; ;;;;I"&Enumerator::Lazy#_enumerable_uniq;F;[;[[@ëiÚ;F;:_enumerable_uniq;;K;[;{;IC;";T;[;[;@|;0; @Ê¼;'@¼;)I"def _enumerable_uniq;To;;F; ;;;Ï;I",Enumerator::Lazy#_enumerable_with_index;F;[[@c0;[[@ëi;T;:_enumerable_with_index;0;[;{;IC;"ÚIterates the given block for each element with an index, which starts from +offset+. If no block is given, returns a new Enumerator that includes the index, starting from +offset+ +offset+:: the starting index to use ;T;[o;= ;3I" overload;F;40;:with_index;50;)I"with_index(offset = 0);T;IC;";T; @Õ¼;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"(*args);TI"idx;T; @Õ¼;[;I"@yield [(*args), idx];T;0;6i;[[I"offset;TI"0;T; @Õ¼o;= ;3I" overload;F;40;;Ž;50;)I"with_index(offset = 0);T;IC;";T; @Õ¼;>0;!F;[;[;I";T;0;6i;[[I"offset;TI"0;T; @Õ¼;[;I"7Iterates the given block for each element with an index, which starts from +offset+. If no block is given, returns a new Enumerator that includes the index, starting from +offset+ +offset+:: the starting index to use @overload with_index(offset = 0) @yield [(*args), idx] @overload with_index(offset = 0);T;0; @Õ¼;!F;"o;#;$T;%i;&i‹;'@¼;(I"fstatic VALUE enumerator_with_index(int argc, VALUE *argv, VALUE obj) { VALUE memo; rb_check_arity(argc, 0, 1); RETURN_SIZED_ENUMERATOR(obj, argc, argv, enumerator_enum_size); memo = (!argc || NIL_P(memo = argv[0])) ? INT2FIX(0) : rb_to_int(memo); return enumerator_block_call(obj, enumerator_with_index_i, (VALUE)MEMO_NEW(memo, 0, 0)); };T;)I"static VALUE;T;*To;;F; ;;;;I" Enumerator::Lazy#initialize;F;[[@c0;[[@ëiä;T;;Ð;0;[;{;IC;"úCreates a new Lazy enumerator. When the enumerator is actually enumerated (e.g. by calling #force), +obj+ will be enumerated and each value passed to the given block. The block can yield values back using +yielder+. For example, to create a "filter+map" enumerator: def filter_map(sequence) Lazy.new(sequence) do |yielder, *values| result = yield *values yielder << result if result end end filter_map(1..Float::INFINITY) {|i| i*i if i.even?}.first(5) #=> [4, 16, 36, 64, 100] ;T;[o;= ;3I" overload;F;40;;î;50;)I"new(obj, size=nil);T;IC;";T; @½;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"yielder;TI"*values;T; @½;[;I"@yield [yielder, *values];T;0;6i;[[I"obj;T0[I" size;TI"nil;T; @½;[;I"5Creates a new Lazy enumerator. When the enumerator is actually enumerated (e.g. by calling #force), +obj+ will be enumerated and each value passed to the given block. The block can yield values back using +yielder+. For example, to create a "filter+map" enumerator: def filter_map(sequence) Lazy.new(sequence) do |yielder, *values| result = yield *values yielder << result if result end end filter_map(1..Float::INFINITY) {|i| i*i if i.even?}.first(5) #=> [4, 16, 36, 64, 100] @overload new(obj, size=nil) @yield [yielder, *values];T;0; @½;!F;"o;#;$T;%iÑ;&iâ;'@¼;(I"6static VALUE lazy_initialize(int argc, VALUE *argv, VALUE self) { VALUE obj, size = Qnil; VALUE generator; rb_check_arity(argc, 1, 2); if (!rb_block_given_p()) { rb_raise(rb_eArgError, "tried to call lazy new without a block"); } obj = argv[0]; if (argc > 1) { size = argv[1]; } generator = generator_allocate(rb_cGenerator); rb_block_call(generator, id_initialize, 0, 0, lazy_init_block_i, obj); enumerator_init(self, generator, sym_each, 0, 0, 0, size, 0); rb_ivar_set(self, id_receiver, obj); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Lazy#to_enum;F;[[@c0;[[@ëi;T;;X;0;[;{;IC;"^Similar to Object#to_enum, except it returns a lazy enumerator. This makes it easy to define Enumerable methods that will naturally remain lazy if called from a lazy enumerator. For example, continuing from the example in Object#to_enum: # See Object#to_enum for the definition of repeat r = 1..Float::INFINITY r.repeat(2).first(5) # => [1, 1, 2, 2, 3] r.repeat(2).class # => Enumerator r.repeat(2).map{|n| n ** 2}.first(5) # => endless loop! # works naturally on lazy enumerator: r.lazy.repeat(2).class # => Enumerator::Lazy r.lazy.repeat(2).map{|n| n ** 2}.first(5) # => [1, 1, 4, 4, 9] ;T;[ o;= ;3I" overload;F;40;;X;50;)I"#to_enum(method = :each, *args);T;IC;";T; @"½;>0;!F;[;[;I";T;0;6i;[[I"method;TI" :each;T[I" *args;T0; @"½o;= ;3I" overload;F;40;;Y;50;)I"$enum_for(method = :each, *args);T;IC;";T; @"½;>0;!F;[;[;I";T;0;6i;[[I"method;TI" :each;T[I" *args;T0; @"½o;= ;3I" overload;F;40;;X;50;)I"#to_enum(method = :each, *args);T;IC;";T; @"½;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" *args;T; @"½;[;I"@yield [*args];T;0;6i;[[I"method;TI" :each;T[I" *args;T0; @"½o;= ;3I" overload;F;40;;Y;50;)I"$enum_for(method = :each, *args);T;IC;";T; @"½;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" *args;T; @"½;[;I"@yield [*args];T;0;6i;[[I"method;TI" :each;T[I" *args;T0; @"½;[;I"(Similar to Object#to_enum, except it returns a lazy enumerator. This makes it easy to define Enumerable methods that will naturally remain lazy if called from a lazy enumerator. For example, continuing from the example in Object#to_enum: # See Object#to_enum for the definition of repeat r = 1..Float::INFINITY r.repeat(2).first(5) # => [1, 1, 2, 2, 3] r.repeat(2).class # => Enumerator r.repeat(2).map{|n| n ** 2}.first(5) # => endless loop! # works naturally on lazy enumerator: r.lazy.repeat(2).class # => Enumerator::Lazy r.lazy.repeat(2).map{|n| n ** 2}.first(5) # => [1, 1, 4, 4, 9] @overload to_enum(method = :each, *args) @overload enum_for(method = :each, *args) @overload to_enum(method = :each, *args) @yield [*args] @overload enum_for(method = :each, *args) @yield [*args];T;0; @"½;!F;"o;#;$T;%iv;&i‹;'@¼;(I"¾static VALUE lazy_to_enum(int argc, VALUE *argv, VALUE self) { VALUE lazy, meth = sym_each, super_meth; if (argc > 0) { --argc; meth = *argv++; } if (RTEST((super_meth = rb_hash_aref(lazy_use_super_method, meth)))) { meth = super_meth; } lazy = lazy_to_enum_i(self, meth, argc, argv, 0, rb_keyword_given_p()); if (rb_block_given_p()) { enumerator_ptr(lazy)->size = rb_block_proc(); } return lazy; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Lazy#enum_for;F;[[@c0;[[@ëi;T;;Y;0;[;{;IC;"^Similar to Object#to_enum, except it returns a lazy enumerator. This makes it easy to define Enumerable methods that will naturally remain lazy if called from a lazy enumerator. For example, continuing from the example in Object#to_enum: # See Object#to_enum for the definition of repeat r = 1..Float::INFINITY r.repeat(2).first(5) # => [1, 1, 2, 2, 3] r.repeat(2).class # => Enumerator r.repeat(2).map{|n| n ** 2}.first(5) # => endless loop! # works naturally on lazy enumerator: r.lazy.repeat(2).class # => Enumerator::Lazy r.lazy.repeat(2).map{|n| n ** 2}.first(5) # => [1, 1, 4, 4, 9] ;T;[ o;= ;3I" overload;F;40;;X;50;)I"#to_enum(method = :each, *args);T;IC;";T; @o½;>0;!F;[;[;I";T;0;6i;[[I"method;TI" :each;T[I" *args;T0; @o½o;= ;3I" overload;F;40;;Y;50;)I"$enum_for(method = :each, *args);T;IC;";T; @o½;>0;!F;[;[;I";T;0;6i;[[I"method;TI" :each;T[I" *args;T0; @o½o;= ;3I" overload;F;40;;X;50;)I"#to_enum(method = :each, *args);T;IC;";T; @o½;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" *args;T; @o½;[;I"@yield [*args];T;0;6i;[[I"method;TI" :each;T[I" *args;T0; @o½o;= ;3I" overload;F;40;;Y;50;)I"$enum_for(method = :each, *args);T;IC;";T; @o½;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" *args;T; @o½;[;I"@yield [*args];T;0;6i;[[I"method;TI" :each;T[I" *args;T0; @o½;[;@k½;0; @o½;!F;"o;#;$T;%iv;&i‹;'@¼;(I"¾static VALUE lazy_to_enum(int argc, VALUE *argv, VALUE self) { VALUE lazy, meth = sym_each, super_meth; if (argc > 0) { --argc; meth = *argv++; } if (RTEST((super_meth = rb_hash_aref(lazy_use_super_method, meth)))) { meth = super_meth; } lazy = lazy_to_enum_i(self, meth, argc, argv, 0, rb_keyword_given_p()); if (rb_block_given_p()) { enumerator_ptr(lazy)->size = rb_block_proc(); } return lazy; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Lazy#eager;F;[;[[@ëi;T;: eager;0;[;{;IC;"FReturns a non-lazy Enumerator converted from the lazy enumerator. ;T;[o;= ;3I" overload;F;40;;;50;)I" eager;T;IC;";T; @»½;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Enumerator;T; @»½;[;I"@return [Enumerator];T;0;6i;[; @»½;[;I"oReturns a non-lazy Enumerator converted from the lazy enumerator. @overload eager @return [Enumerator];T;0; @»½;!F;"o;#;$T;%i¦;&iª;'@¼;(I"³static VALUE lazy_eager(VALUE self) { return enumerator_init(enumerator_allocate(rb_cEnumerator), self, sym_each, 0, 0, lazy_eager_size, Qnil, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Lazy#map;F;[;[[@ëié;T;;1;0;[;{;IC;"õLike Enumerable#map, but chains operation to be lazy-evaluated. (1..Float::INFINITY).lazy.map {|i| i**2 } #=> #:map> (1..Float::INFINITY).lazy.map {|i| i**2 }.first(3) #=> [1, 4, 9] ;T;[o;= ;3I" overload;F;40;;0;50;)I"collect;T;IC;";T; @Ö½;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @Ö½;[;I"@yield [obj];T;0;6i;[; @Ö½o;= ;3I" overload;F;40;;1;50;)I"map;T;IC;";T; @Ö½;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @Ö½;[;I"@yield [obj];T;0;6i;[; @Ö½;[;I"5Like Enumerable#map, but chains operation to be lazy-evaluated. (1..Float::INFINITY).lazy.map {|i| i**2 } #=> #:map> (1..Float::INFINITY).lazy.map {|i| i**2 }.first(3) #=> [1, 4, 9] @overload collect @yield [obj] @overload map @yield [obj];T;0; @Ö½;!F;"o;#;$T;%iÜ;&iç;'@¼;(I"Ñstatic VALUE lazy_map(VALUE obj) { if (!rb_block_given_p()) { rb_raise(rb_eArgError, "tried to call lazy map without a block"); } return lazy_add_method(obj, 0, 0, Qnil, Qnil, &lazy_map_funcs); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Lazy#collect;F;[;[[@ëié;T;;0;0;[;{;IC;"õLike Enumerable#map, but chains operation to be lazy-evaluated. (1..Float::INFINITY).lazy.map {|i| i**2 } #=> #:map> (1..Float::INFINITY).lazy.map {|i| i**2 }.first(3) #=> [1, 4, 9] ;T;[o;= ;3I" overload;F;40;;0;50;)I"collect;T;IC;";T; @þ½;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @þ½;[;I"@yield [obj];T;0;6i;[; @þ½o;= ;3I" overload;F;40;;1;50;)I"map;T;IC;";T; @þ½;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @þ½;[;I"@yield [obj];T;0;6i;[; @þ½;[;@ú½;0; @þ½;!F;"o;#;$T;%iÜ;&iç;'@¼;(I"Ñstatic VALUE lazy_map(VALUE obj) { if (!rb_block_given_p()) { rb_raise(rb_eArgError, "tried to call lazy map without a block"); } return lazy_add_method(obj, 0, 0, Qnil, Qnil, &lazy_map_funcs); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Lazy#flat_map;F;[;[[@ëi>;T;;2;0;[;{;IC;":Returns a new lazy enumerator with the concatenated results of running +block+ once for every element in the lazy enumerator. ["foo", "bar"].lazy.flat_map {|i| i.each_char.lazy}.force #=> ["f", "o", "o", "b", "a", "r"] A value +x+ returned by +block+ is decomposed if either of the following conditions is true: * +x+ responds to both each and force, which means that +x+ is a lazy enumerator. * +x+ is an array or responds to to_ary. Otherwise, +x+ is contained as-is in the return value. [{a:1}, {b:2}].lazy.flat_map {|i| i}.force #=> [{:a=>1}, {:b=>2}] ;T;[o;= ;3I" overload;F;40;;3;50;)I"collect_concat;T;IC;";T; @%¾;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @%¾;[;I"@yield [obj];T;0;6i;[; @%¾o;= ;3I" overload;F;40;;2;50;)I" flat_map;T;IC;";T; @%¾;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @%¾;[;I"@yield [obj];T;0;6i;[; @%¾;[;I"†Returns a new lazy enumerator with the concatenated results of running +block+ once for every element in the lazy enumerator. ["foo", "bar"].lazy.flat_map {|i| i.each_char.lazy}.force #=> ["f", "o", "o", "b", "a", "r"] A value +x+ returned by +block+ is decomposed if either of the following conditions is true: * +x+ responds to both each and force, which means that +x+ is a lazy enumerator. * +x+ is an array or responds to to_ary. Otherwise, +x+ is contained as-is in the return value. [{a:1}, {b:2}].lazy.flat_map {|i| i}.force #=> [{:a=>1}, {:b=>2}] @overload collect_concat @yield [obj] @overload flat_map @yield [obj];T;0; @%¾;!F;"o;#;$T;%i';&i=;'@¼;(I"àstatic VALUE lazy_flat_map(VALUE obj) { if (!rb_block_given_p()) { rb_raise(rb_eArgError, "tried to call lazy flat_map without a block"); } return lazy_add_method(obj, 0, 0, Qnil, Qnil, &lazy_flat_map_funcs); };T;)I"static VALUE;T;*To;;F; ;;;;I"$Enumerator::Lazy#collect_concat;F;[;[[@ëi>;T;;3;0;[;{;IC;":Returns a new lazy enumerator with the concatenated results of running +block+ once for every element in the lazy enumerator. ["foo", "bar"].lazy.flat_map {|i| i.each_char.lazy}.force #=> ["f", "o", "o", "b", "a", "r"] A value +x+ returned by +block+ is decomposed if either of the following conditions is true: * +x+ responds to both each and force, which means that +x+ is a lazy enumerator. * +x+ is an array or responds to to_ary. Otherwise, +x+ is contained as-is in the return value. [{a:1}, {b:2}].lazy.flat_map {|i| i}.force #=> [{:a=>1}, {:b=>2}] ;T;[o;= ;3I" overload;F;40;;3;50;)I"collect_concat;T;IC;";T; @M¾;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @M¾;[;I"@yield [obj];T;0;6i;[; @M¾o;= ;3I" overload;F;40;;2;50;)I" flat_map;T;IC;";T; @M¾;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @M¾;[;I"@yield [obj];T;0;6i;[; @M¾;[;@I¾;0; @M¾;!F;"o;#;$T;%i';&i=;'@¼;(I"àstatic VALUE lazy_flat_map(VALUE obj) { if (!rb_block_given_p()) { rb_raise(rb_eArgError, "tried to call lazy flat_map without a block"); } return lazy_add_method(obj, 0, 0, Qnil, Qnil, &lazy_flat_map_funcs); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Lazy#select;F;[;[[@ëi\;T;;¦;0;[;{;IC;"GLike Enumerable#select, but chains operation to be lazy-evaluated. ;T;[o;= ;3I" overload;F;40;;,;50;)I" find_all;T;IC;";T; @t¾;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @t¾;[;I"@yield [obj];T;0;6i;[; @t¾o;= ;3I" overload;F;40;;¦;50;)I"select;T;IC;";T; @t¾;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @t¾;[;I"@yield [obj];T;0;6i;[; @t¾o;= ;3I" overload;F;40;;-;50;)I"filter;T;IC;";T; @t¾;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @t¾;[;I"@yield [obj];T;0;6i;[; @t¾;[;I"¦Like Enumerable#select, but chains operation to be lazy-evaluated. @overload find_all @yield [obj] @overload select @yield [obj] @overload filter @yield [obj];T;0; @t¾;!F;"o;#;$T;%iT;&i\;'@¼;(I"Ústatic VALUE lazy_select(VALUE obj) { if (!rb_block_given_p()) { rb_raise(rb_eArgError, "tried to call lazy select without a block"); } return lazy_add_method(obj, 0, 0, Qnil, Qnil, &lazy_select_funcs); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Lazy#find_all;F;[;[[@ëi\;T;;,;0;[;{;IC;"GLike Enumerable#select, but chains operation to be lazy-evaluated. ;T;[o;= ;3I" overload;F;40;;,;50;)I" find_all;T;IC;";T; @©¾;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @©¾;[;I"@yield [obj];T;0;6i;[; @©¾o;= ;3I" overload;F;40;;¦;50;)I"select;T;IC;";T; @©¾;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @©¾;[;I"@yield [obj];T;0;6i;[; @©¾o;= ;3I" overload;F;40;;-;50;)I"filter;T;IC;";T; @©¾;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @©¾;[;I"@yield [obj];T;0;6i;[; @©¾;[;@¥¾;0; @©¾;!F;"o;#;$T;%iT;&i\;'@¼;(I"Ústatic VALUE lazy_select(VALUE obj) { if (!rb_block_given_p()) { rb_raise(rb_eArgError, "tried to call lazy select without a block"); } return lazy_add_method(obj, 0, 0, Qnil, Qnil, &lazy_select_funcs); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Lazy#filter;F;[;[[@ëi\;T;;-;0;[;{;IC;"GLike Enumerable#select, but chains operation to be lazy-evaluated. ;T;[o;= ;3I" overload;F;40;;,;50;)I" find_all;T;IC;";T; @Ý¾;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @Ý¾;[;I"@yield [obj];T;0;6i;[; @Ý¾o;= ;3I" overload;F;40;;¦;50;)I"select;T;IC;";T; @Ý¾;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @Ý¾;[;I"@yield [obj];T;0;6i;[; @Ý¾o;= ;3I" overload;F;40;;-;50;)I"filter;T;IC;";T; @Ý¾;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @Ý¾;[;I"@yield [obj];T;0;6i;[; @Ý¾;[;@¥¾;0; @Ý¾;!F;"o;#;$T;%iT;&i\;'@¼;(I"Ústatic VALUE lazy_select(VALUE obj) { if (!rb_block_given_p()) { rb_raise(rb_eArgError, "tried to call lazy select without a block"); } return lazy_add_method(obj, 0, 0, Qnil, Qnil, &lazy_select_funcs); };T;)I"static VALUE;T;*To;;F; ;;;;I" Enumerator::Lazy#filter_map;F;[;[[@ëi~;T;;.;0;[;{;IC;"šLike Enumerable#filter_map, but chains operation to be lazy-evaluated. (1..).lazy.filter_map { |i| i * 2 if i.even? }.first(5) #=> [4, 8, 12, 16, 20] ;T;[o;= ;3I" overload;F;40;;.;50;)I"filter_map;T;IC;";T; @¿;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @¿;[;I"@yield [obj];T;0;6i;[; @¿;[;I"ÀLike Enumerable#filter_map, but chains operation to be lazy-evaluated. (1..).lazy.filter_map { |i| i * 2 if i.even? }.first(5) #=> [4, 8, 12, 16, 20] @overload filter_map @yield [obj];T;0; @¿;!F;"o;#;$T;%it;&i{;'@¼;(I"ístatic VALUE lazy_filter_map(VALUE obj) { if (!rb_block_given_p()) { rb_raise(rb_eArgError, "tried to call lazy filter_map without a block"); } return lazy_add_method(obj, 0, 0, Qnil, Qnil, &lazy_filter_map_funcs); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Lazy#reject;F;[;[[@ëi›;T;;/;0;[;{;IC;"GLike Enumerable#reject, but chains operation to be lazy-evaluated. ;T;[o;= ;3I" overload;F;40;;/;50;)I"reject;T;IC;";T; @,¿;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @,¿;[;I"@yield [obj];T;0;6i;[; @,¿;[;I"iLike Enumerable#reject, but chains operation to be lazy-evaluated. @overload reject @yield [obj];T;0; @,¿;!F;"o;#;$T;%i”;&i˜;'@¼;(I"Ústatic VALUE lazy_reject(VALUE obj) { if (!rb_block_given_p()) { rb_raise(rb_eArgError, "tried to call lazy reject without a block"); } return lazy_add_method(obj, 0, 0, Qnil, Qnil, &lazy_reject_funcs); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Lazy#grep;F;[[I"pattern;T0;[[@ëiÌ;T;;&;0;[;{;IC;"ELike Enumerable#grep, but chains operation to be lazy-evaluated. ;T;[o;= ;3I" overload;F;40;;&;50;)I"grep(pattern);T;IC;";T; @G¿;>0;!F;[;[;I";T;0;6i;[[I"pattern;T0; @G¿o;= ;3I" overload;F;40;;&;50;)I"grep(pattern);T;IC;";T; @G¿;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @G¿;[;I"@yield [obj];T;0;6i;[[I"pattern;T0; @G¿;[;I"Like Enumerable#grep, but chains operation to be lazy-evaluated. @overload grep(pattern) @overload grep(pattern) @yield [obj];T;0; @G¿;!F;"o;#;$T;%iÄ;&iÉ;'@¼;(I"ìstatic VALUE lazy_grep(VALUE obj, VALUE pattern) { const lazyenum_funcs *const funcs = rb_block_given_p() ? &lazy_grep_iter_funcs : &lazy_grep_funcs; return lazy_add_method(obj, 0, 0, pattern, rb_ary_new3(1, pattern), funcs); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Lazy#grep_v;F;[[I"pattern;T0;[[@ëiû;T;;';0;[;{;IC;"GLike Enumerable#grep_v, but chains operation to be lazy-evaluated. ;T;[o;= ;3I" overload;F;40;;';50;)I"grep_v(pattern);T;IC;";T; @p¿;>0;!F;[;[;I";T;0;6i;[[I"pattern;T0; @p¿o;= ;3I" overload;F;40;;';50;)I"grep_v(pattern);T;IC;";T; @p¿;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @p¿;[;I"@yield [obj];T;0;6i;[[I"pattern;T0; @p¿;[;I"‡Like Enumerable#grep_v, but chains operation to be lazy-evaluated. @overload grep_v(pattern) @overload grep_v(pattern) @yield [obj];T;0; @p¿;!F;"o;#;$T;%ió;&iø;'@¼;(I"ùstatic VALUE lazy_grep_v(VALUE obj, VALUE pattern) { const lazyenum_funcs *const funcs = rb_block_given_p() ? &lazy_grep_v_iter_funcs : &lazy_grep_v_funcs; return lazy_add_method(obj, 0, 0, pattern, rb_ary_new3(1, pattern), funcs); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Lazy#zip;F;[[@c0;[[@ëiL ;T;;L;0;[;{;IC;"‡Like Enumerable#zip, but chains operation to be lazy-evaluated. However, if a block is given to zip, values are enumerated immediately. ;T;[o;= ;3I" overload;F;40;;L;50;)I"zip(arg, ...);T;IC;";T; @™¿;>0;!F;[;[;I";T;0;6i;[[I"arg;T0[I"...;T0; @™¿o;= ;3I" overload;F;40;;L;50;)I"zip(arg, ...);T;IC;";T; @™¿;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"arr;T; @™¿o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @™¿;[;I"@yield [arr] @return [nil];T;0;6i;[[I"arg;T0[I"...;T0; @™¿;[;I"ØLike Enumerable#zip, but chains operation to be lazy-evaluated. However, if a block is given to zip, values are enumerated immediately. @overload zip(arg, ...) @overload zip(arg, ...) @yield [arr] @return [nil];T;0; @™¿;!F;"o;#;$T;%iD ;&iK ;'@¼;(I"¿static VALUE lazy_zip(int argc, VALUE *argv, VALUE obj) { VALUE ary, v; long i; const lazyenum_funcs *funcs = &lazy_zip_funcs[1]; if (rb_block_given_p()) { return rb_call_super(argc, argv); } ary = rb_ary_new2(argc); for (i = 0; i < argc; i++) { v = rb_check_array_type(argv[i]); if (NIL_P(v)) { for (; i < argc; i++) { if (!rb_respond_to(argv[i], id_each)) { rb_raise(rb_eTypeError, "wrong argument type %"PRIsVALUE" (must respond to :each)", rb_obj_class(argv[i])); } } ary = rb_ary_new4(argc, argv); funcs = &lazy_zip_funcs[0]; break; } rb_ary_push(ary, v); } return lazy_add_method(obj, 0, 0, ary, ary, funcs); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Lazy#take;F;[[I"n;T0;[[@ëi• ;T;;M;0;[;{;IC;"ELike Enumerable#take, but chains operation to be lazy-evaluated. ;T;[o;= ;3I" overload;F;40;;M;50;)I"take(n);T;IC;";T; @Ê¿;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @Ê¿;[;I"YLike Enumerable#take, but chains operation to be lazy-evaluated. @overload take(n);T;0; @Ê¿;!F;"o;#;$T;%iŽ ;&i‘ ;'@¼;(I"~static VALUE lazy_take(VALUE obj, VALUE n) { long len = NUM2LONG(n); int argc = 0; VALUE argv[2]; if (len < 0) { rb_raise(rb_eArgError, "attempt to take negative size"); } if (len == 0) { argv[0] = sym_cycle; argv[1] = INT2NUM(0); argc = 2; } return lazy_add_method(obj, argc, argv, n, rb_ary_new3(1, n), &lazy_take_funcs); };T;)I"static VALUE;T;*To;;F; ;;;;I" Enumerator::Lazy#take_while;F;[;[[@ëi¿ ;T;;N;0;[;{;IC;"KLike Enumerable#take_while, but chains operation to be lazy-evaluated. ;T;[o;= ;3I" overload;F;40;;N;50;)I"take_while;T;IC;";T; @ä¿;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @ä¿;[;I"@yield [obj];T;0;6i;[; @ä¿;[;I"qLike Enumerable#take_while, but chains operation to be lazy-evaluated. @overload take_while @yield [obj];T;0; @ä¿;!F;"o;#;$T;%i¸ ;&i¼ ;'@¼;(I"æstatic VALUE lazy_take_while(VALUE obj) { if (!rb_block_given_p()) { rb_raise(rb_eArgError, "tried to call lazy take_while without a block"); } return lazy_add_method(obj, 0, 0, Qnil, Qnil, &lazy_take_while_funcs); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Lazy#drop;F;[[I"n;T0;[[@ëiõ ;T;;O;0;[;{;IC;"ELike Enumerable#drop, but chains operation to be lazy-evaluated. ;T;[o;= ;3I" overload;F;40;;O;50;)I"drop(n);T;IC;";T; @ÿ¿;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @ÿ¿;[;I"YLike Enumerable#drop, but chains operation to be lazy-evaluated. @overload drop(n);T;0; @ÿ¿;!F;"o;#;$T;%iî ;&iñ ;'@¼;(I"-static VALUE lazy_drop(VALUE obj, VALUE n) { long len = NUM2LONG(n); VALUE argv[2]; argv[0] = sym_each; argv[1] = n; if (len < 0) { rb_raise(rb_eArgError, "attempt to drop negative size"); } return lazy_add_method(obj, 2, argv, n, rb_ary_new3(1, n), &lazy_drop_funcs); };T;)I"static VALUE;T;*To;;F; ;;;;I" Enumerator::Lazy#drop_while;F;[;[[@ëi! ;T;;P;0;[;{;IC;"KLike Enumerable#drop_while, but chains operation to be lazy-evaluated. ;T;[o;= ;3I" overload;F;40;;P;50;)I"drop_while;T;IC;";T; @À;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"obj;T; @À;[;I"@yield [obj];T;0;6i;[; @À;[;I"qLike Enumerable#drop_while, but chains operation to be lazy-evaluated. @overload drop_while @yield [obj];T;0; @À;!F;"o;#;$T;%i ;&i ;'@¼;(I"èstatic VALUE lazy_drop_while(VALUE obj) { if (!rb_block_given_p()) { rb_raise(rb_eArgError, "tried to call lazy drop_while without a block"); } return lazy_add_method(obj, 0, 0, Qfalse, Qnil, &lazy_drop_while_funcs); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Lazy#lazy;F;[;[[@ëiâ ;T;; ;0;[;{;IC;"Returns self. ;T;[o;= ;3I" overload;F;40;; ;50;)I" lazy;T;IC;";T; @4À;>0;!F;[;[;I";T;0;6i;[; @4À;[;I"#Returns self. @overload lazy;T;0; @4À;!F;"o;#;$T;%iÛ ;&iÞ ;'@¼;(I":static VALUE lazy_lazy(VALUE obj) { return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Lazy#chunk;F;[;[[@ëiÕ [@ëi¦ ;T;;R;0;[;{;IC;"FLike Enumerable#chunk, but chains operation to be lazy-evaluated. ;T;[o;= ;3I" overload;F;40;;R;50;)I" chunk;T;IC;";T; @JÀ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"elt;T; @JÀ;[;I"@yield [elt];T;0;6i;[; @JÀ;[;I"gLike Enumerable#chunk, but chains operation to be lazy-evaluated. @overload chunk @yield [elt];T;0; @JÀ;!F;"o;#;$T;%i ;&i¤ ;'@¼;(I"zstatic VALUE lazy_super(int argc, VALUE *argv, VALUE lazy) { return enumerable_lazy(rb_call_super(argc, argv)); };T;)I"static VALUE;T;*To;;F; ;;;;I""Enumerator::Lazy#slice_before;F;[;[[@ëiÕ [@ëiÆ ;T;;S;0;[;{;IC;"MLike Enumerable#slice_before, but chains operation to be lazy-evaluated. ;T;[o;= ;3I" overload;F;40;;S;50;)I"slice_before(pattern);T;IC;";T; @fÀ;>0;!F;[;[;I";T;0;6i;[[I"pattern;T0; @fÀo;= ;3I" overload;F;40;;S;50;)I"slice_before;T;IC;";T; @fÀ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"elt;T; @fÀ;[;I"@yield [elt];T;0;6i;[; @fÀ;[;I"Like Enumerable#slice_before, but chains operation to be lazy-evaluated. @overload slice_before(pattern) @overload slice_before @yield [elt];T;0; @fÀ;!F;"o;#;$T;%i¿ ;&iÄ ;'@¼;(I"zstatic VALUE lazy_super(int argc, VALUE *argv, VALUE lazy) { return enumerable_lazy(rb_call_super(argc, argv)); };T;)I"static VALUE;T;*To;;F; ;;;;I"!Enumerator::Lazy#slice_after;F;[;[[@ëiÕ [@ëi» ;T;;T;0;[;{;IC;"LLike Enumerable#slice_after, but chains operation to be lazy-evaluated. ;T;[o;= ;3I" overload;F;40;;T;50;)I"slice_after(pattern);T;IC;";T; @ŒÀ;>0;!F;[;[;I";T;0;6i;[[I"pattern;T0; @ŒÀo;= ;3I" overload;F;40;;T;50;)I"slice_after;T;IC;";T; @ŒÀ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"elt;T; @ŒÀ;[;I"@yield [elt];T;0;6i;[; @ŒÀ;[;I"Like Enumerable#slice_after, but chains operation to be lazy-evaluated. @overload slice_after(pattern) @overload slice_after @yield [elt];T;0; @ŒÀ;!F;"o;#;$T;%i´ ;&i¹ ;'@¼;(I"zstatic VALUE lazy_super(int argc, VALUE *argv, VALUE lazy) { return enumerable_lazy(rb_call_super(argc, argv)); };T;)I"static VALUE;T;*To;;F; ;;;;I" Enumerator::Lazy#slice_when;F;[;[[@ëiÕ [@ëiÐ ;T;;U;0;[;{;IC;"KLike Enumerable#slice_when, but chains operation to be lazy-evaluated. ;T;[o;= ;3I" overload;F;40;;U;50;)I"slice_when;T;IC;";T; @²À;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"elt_before;TI"elt_after;T; @²À;[;I"#@yield [elt_before, elt_after];T;0;6i;[; @²À;[;I"~Like Enumerable#slice_when, but chains operation to be lazy-evaluated. @overload slice_when @yield [elt_before, elt_after];T;0; @²À;!F;"o;#;$T;%iÊ ;&iÎ ;'@¼;(I"zstatic VALUE lazy_super(int argc, VALUE *argv, VALUE lazy) { return enumerable_lazy(rb_call_super(argc, argv)); };T;)I"static VALUE;T;*To;;F; ;;;;I"!Enumerator::Lazy#chunk_while;F;[;[[@ëiÕ [@ëi° ;T;;V;0;[;{;IC;"LLike Enumerable#chunk_while, but chains operation to be lazy-evaluated. ;T;[o;= ;3I" overload;F;40;;V;50;)I"chunk_while;T;IC;";T; @ÏÀ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"elt_before;TI"elt_after;T; @ÏÀ;[;I"#@yield [elt_before, elt_after];T;0;6i;[; @ÏÀ;[;I"€Like Enumerable#chunk_while, but chains operation to be lazy-evaluated. @overload chunk_while @yield [elt_before, elt_after];T;0; @ÏÀ;!F;"o;#;$T;%iª ;&i® ;'@¼;(I"zstatic VALUE lazy_super(int argc, VALUE *argv, VALUE lazy) { return enumerable_lazy(rb_call_super(argc, argv)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Lazy#uniq;F;[;[[@ëiX ;T;;X;0;[;{;IC;"ELike Enumerable#uniq, but chains operation to be lazy-evaluated. ;T;[o;= ;3I" overload;F;40;;X;50;)I" uniq;T;IC;";T; @ìÀ;>0;!F;[;[;I";T;0;6i;[; @ìÀo;= ;3I" overload;F;40;;X;50;)I" uniq;T;IC;";T; @ìÀ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" item;T; @ìÀ;[;I"@yield [item];T;0;6i;[; @ìÀ;[;I"uLike Enumerable#uniq, but chains operation to be lazy-evaluated. @overload uniq @overload uniq @yield [item];T;0; @ìÀ;!F;"o;#;$T;%iP ;&iU ;'@¼;(I"Îstatic VALUE lazy_uniq(VALUE obj) { const lazyenum_funcs *const funcs = rb_block_given_p() ? &lazy_uniq_iter_funcs : &lazy_uniq_funcs; return lazy_add_method(obj, 0, 0, Qnil, Qnil, funcs); };T;)I"static VALUE;T;*To;;F; ;;;;I" Enumerator::Lazy#with_index;F;[[@c0;[[@ëi’ ;T;;Ž;0;[;{;IC;"cIf a block is given, iterates the given block for each element with an index, which starts from +offset+, and returns a lazy enumerator that yields the same values (without the index). If a block is not given, returns a new lazy enumerator that includes the index, starting from +offset+. +offset+:: the starting index to use See Enumerator#with_index. ;T;[o;= ;3I" overload;F;40;;Ž;50;)I"with_index(offset = 0);T;IC;";T; @Á;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"(*args);TI"idx;T; @Á;[;I"@yield [(*args), idx];T;0;6i;[[I"offset;TI"0;T; @Áo;= ;3I" overload;F;40;;Ž;50;)I"with_index(offset = 0);T;IC;";T; @Á;>0;!F;[;[;I";T;0;6i;[[I"offset;TI"0;T; @Á;[;I"¿If a block is given, iterates the given block for each element with an index, which starts from +offset+, and returns a lazy enumerator that yields the same values (without the index). If a block is not given, returns a new lazy enumerator that includes the index, starting from +offset+. +offset+:: the starting index to use See Enumerator#with_index. @overload with_index(offset = 0) @yield [(*args), idx] @overload with_index(offset = 0);T;0; @Á;!F;"o;#;$T;%i‚ ;&i ;'@¼;(I"static VALUE lazy_with_index(int argc, VALUE *argv, VALUE obj) { VALUE memo; rb_scan_args(argc, argv, "01", &memo); if (NIL_P(memo)) memo = LONG2NUM(0); return lazy_add_method(obj, 0, 0, memo, rb_ary_new_from_values(1, &memo), &lazy_with_index_funcs); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Lazy#to_a;F;[;[[@ëi;T;;!;0;[;{;IC;"@Expands +lazy+ enumerator to an array. See Enumerable#to_a. ;T;[o;= ;3I" overload;F;40;;!;50;)I" to_a;T;IC;";T; @:Á;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @:Á;[;I"@return [Array];T;0;6i;[; @:Áo;= ;3I" overload;F;40;: force;50;)I" force;T;IC;";T; @:Á;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @:Á;[;I"@return [Array];T;0;6i;[; @:Á;[;I"€Expands +lazy+ enumerator to an array. See Enumerable#to_a. @overload to_a @return [Array] @overload force @return [Array];T;0; o;;F; ;;;;I"Enumerator::Lazy#force;F;[;[[@ëi*;F;;;;K;[;{;@AÁ;'@¼;)I"'static VALUE lazy_to_a(VALUE self);T;(I"+static VALUE lazy_to_a(VALUE self) { };T;!F;"o;#;$T;%iû;&i;'@¼;(I"+static VALUE lazy_to_a(VALUE self) { };T;)@fÁ;*T@_Á;A@¼;BIC;[;A@¼;CIC;[;A@¼;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@¼;1@%¼;0@0¼;2@;¼;3@F¼;¦@Q¼;,@\¼;-@g¼;.@r¼;/@}¼;&@ˆ¼;'@“¼;L@ž¼;M@©¼;N@´¼;O@¿¼;P@Ê¼;X@_Á;!;I[;[[@ëi‹[@ëiÇ;T;: Lazy;;K;;;[;{;IC;"óEnumerator::Lazy is a special type of Enumerator, that allows constructing chains of operations without evaluating them immediately, and evaluating values on as-needed basis. In order to do so it redefines most of Enumerable methods so that they just construct another lazy enumerator. Enumerator::Lazy can be constructed from any Enumerable with the Enumerable#lazy method. lazy = (1..Float::INFINITY).lazy.select(&:odd?).drop(10).take_while { |i| i < 30 } # => #:select>:drop(10)>:take_while> The real enumeration is performed when any non-redefined Enumerable method is called, like Enumerable#first or Enumerable#to_a (the latter is aliased as #force for more semantic code): lazy.first(2) #=> [21, 23] lazy.force #=> [21, 23, 25, 27, 29] Note that most Enumerable methods that could be called with or without a block, on Enumerator::Lazy will always require a block: [1, 2, 3].map #=> # [1, 2, 3].lazy.map # ArgumentError: tried to call lazy map without a block This class allows idiomatic calculations on long or infinite sequences, as well as chaining of calculations without constructing intermediate arrays. Example for working with a slowly calculated sequence: require 'open-uri' # This will fetch all URLs before selecting # necessary data URLS.map { |u| JSON.parse(open(u).read) } .select { |data| data.key?('stats') } .first(5) # This will fetch URLs one-by-one, only till # there is enough data to satisfy the condition URLS.lazy.map { |u| JSON.parse(open(u).read) } .select { |data| data.key?('stats') } .first(5) Ending a chain with ".eager" generates a non-lazy enumerator, which is suitable for returning or passing to another method that expects a normal enumerator. def active_items groups .lazy .flat_map(&:items) .reject(&:disabled) .eager end # This works lazily; if a checked item is found, it stops # iteration and does not look into remaining groups. first_checked = active_items.find(&:checked) # This returns an array of items like a normal enumerator does. all_checked = active_items.select(&:checked);T;[;[;I"ö Enumerator::Lazy is a special type of Enumerator, that allows constructing chains of operations without evaluating them immediately, and evaluating values on as-needed basis. In order to do so it redefines most of Enumerable methods so that they just construct another lazy enumerator. Enumerator::Lazy can be constructed from any Enumerable with the Enumerable#lazy method. lazy = (1..Float::INFINITY).lazy.select(&:odd?).drop(10).take_while { |i| i < 30 } # => #:select>:drop(10)>:take_while> The real enumeration is performed when any non-redefined Enumerable method is called, like Enumerable#first or Enumerable#to_a (the latter is aliased as #force for more semantic code): lazy.first(2) #=> [21, 23] lazy.force #=> [21, 23, 25, 27, 29] Note that most Enumerable methods that could be called with or without a block, on Enumerator::Lazy will always require a block: [1, 2, 3].map #=> # [1, 2, 3].lazy.map # ArgumentError: tried to call lazy map without a block This class allows idiomatic calculations on long or infinite sequences, as well as chaining of calculations without constructing intermediate arrays. Example for working with a slowly calculated sequence: require 'open-uri' # This will fetch all URLs before selecting # necessary data URLS.map { |u| JSON.parse(open(u).read) } .select { |data| data.key?('stats') } .first(5) # This will fetch URLs one-by-one, only till # there is enough data to satisfy the condition URLS.lazy.map { |u| JSON.parse(open(u).read) } .select { |data| data.key?('stats') } .first(5) Ending a chain with ".eager" generates a non-lazy enumerator, which is suitable for returning or passing to another method that expects a normal enumerator. def active_items groups .lazy .flat_map(&:items) .reject(&:disabled) .eager end # This works lazily; if a checked item is found, it stops # iteration and does not look into remaining groups. first_checked = active_items.find(&:checked) # This returns an array of items like a normal enumerator does. all_checked = active_items.select(&:checked) ;T;0; @¼;!F;"o;#;$T;%i‹;&iÍ;6i;'o;L;M0;N0;O0;:Enumerator;'@;Q@¼;R0;I"Enumerator::Lazy;F;S@¼o; ;IC;[o;;F; ;;;;I"!Enumerator::Chain#initialize;F;[[I" enums;T0;[[@ëi#;T;;Ð;0;[;{;IC;"ÁGenerates a new enumerator object that iterates over the elements of given enumerable objects in sequence. e = Enumerator::Chain.new(1..3, [4, 5]) e.to_a #=> [1, 2, 3, 4, 5] e.size #=> 5 ;T;[o;= ;3I" overload;F;40;:Enumerator::Chain.new;50;)I""Enumerator::Chain.new(*enums);T;IC;";T; @Á;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Enumerator;T; @Á;[;I"@return [Enumerator];T;0;6i;[[I"*enums;T0; @Á;[;I"Generates a new enumerator object that iterates over the elements of given enumerable objects in sequence. e = Enumerator::Chain.new(1..3, [4, 5]) e.to_a #=> [1, 2, 3, 4, 5] e.size #=> 5 @overload Enumerator::Chain.new(*enums) @return [Enumerator];T;0; @Á;!F;"o;#;$T;%i;&i!;'@}Á;(I"Kstatic VALUE enum_chain_initialize(VALUE obj, VALUE enums) { struct enum_chain *ptr; rb_check_frozen(obj); TypedData_Get_Struct(obj, struct enum_chain, &enum_chain_data_type, ptr); if (!ptr) rb_raise(rb_eArgError, "unallocated chain"); ptr->enums = rb_obj_freeze(enums); ptr->pos = -1; return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"&Enumerator::Chain#initialize_copy;F;[[I" orig;T0;[[@ëi4;T;;g;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @žÁ;!F;"o;#;$T;%i3;&i3;'@}Á;(I"Šstatic VALUE enum_chain_init_copy(VALUE obj, VALUE orig) { struct enum_chain *ptr0, *ptr1; if (!OBJ_INIT_COPY(obj, orig)) return obj; ptr0 = enum_chain_ptr(orig); TypedData_Get_Struct(obj, struct enum_chain, &enum_chain_data_type, ptr1); if (!ptr1) rb_raise(rb_eArgError, "unallocated chain"); ptr1->enums = ptr0->enums; ptr1->pos = ptr0->pos; return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Chain#each;F;[[@c0;[[@ëiƒ;T;;;0;[;{;IC;"Iterates over the elements of the first enumerable by calling the "each" method on it with the given arguments, then proceeds to the following enumerables in sequence until all of the enumerables are exhausted. If no block is given, returns an enumerator. ;T;[o;= ;3I" overload;F;40;;;50;)I"each(*args);T;IC;";T; @®Á;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"...;T; @®Áo;2 ;3I"return;F;4I";T;0;5[I"Object;T; @®Á;[;I""@yield [...] @return [Object];T;0;6i;[[I" *args;T0; @®Áo;= ;3I" overload;F;40;;;50;)I"each(*args);T;IC;";T; @®Á;>0;!F;[;[;I";T;0;6i;[[I" *args;T0; @®Á;[;I"PIterates over the elements of the first enumerable by calling the "each" method on it with the given arguments, then proceeds to the following enumerables in sequence until all of the enumerables are exhausted. If no block is given, returns an enumerator. @overload each(*args) @yield [...] @return [Object] @overload each(*args);T;0; @®Á;!F;"o;#;$T;%iw;&i‚;'@}Á;(I"ûstatic VALUE enum_chain_each(int argc, VALUE *argv, VALUE obj) { VALUE enums, block; struct enum_chain *objptr; long i; RETURN_SIZED_ENUMERATOR(obj, argc, argv, argc > 0 ? enum_chain_enum_no_size : enum_chain_enum_size); objptr = enum_chain_ptr(obj); enums = objptr->enums; block = rb_block_proc(); for (i = 0; i < RARRAY_LEN(enums); i++) { objptr->pos = i; rb_funcall_with_block(RARRAY_AREF(enums, i), id_each, argc, argv, block); } return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Chain#size;F;[;[[@ëie;T;;¯;0;[;{;IC;"âReturns the total size of the enumerator chain calculated by summing up the size of each enumerable in the chain. If any of the enumerables reports its size as nil or Float::INFINITY, that value is returned as the total size. ;T;[o;= ;3I" overload;F;40;;¯;50;)I" size;T;IC;";T; @ÛÁ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"Float::INFINITY;TI"nil;T; @ÛÁ;[;I"-@return [Integer, Float::INFINITY, nil];T;0;6i;[; @ÛÁ;[;I"Returns the total size of the enumerator chain calculated by summing up the size of each enumerable in the chain. If any of the enumerables reports its size as nil or Float::INFINITY, that value is returned as the total size. @overload size @return [Integer, Float::INFINITY, nil];T;0; @ÛÁ;!F;"o;#;$T;%i\;⁣'@}Á;(I"nstatic VALUE enum_chain_size(VALUE obj) { return enum_chain_total_size(enum_chain_ptr(obj)->enums); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Chain#rewind;F;[;[[@ëi ;T;;;0;[;{;IC;"§Rewinds the enumerator chain by calling the "rewind" method on each enumerable in reverse order. Each call is performed only if the enumerable responds to the method. ;T;[o;= ;3I" overload;F;40;;;50;)I"rewind;T;IC;";T; @øÁ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @øÁ;[;I"@return [Object];T;0;6i;[; @øÁ;[;I"ÍRewinds the enumerator chain by calling the "rewind" method on each enumerable in reverse order. Each call is performed only if the enumerable responds to the method. @overload rewind @return [Object];T;0; @øÁ;!F;"o;#;$T;%i˜;&iž;'@}Á;(I"9static VALUE enum_chain_rewind(VALUE obj) { struct enum_chain *objptr = enum_chain_ptr(obj); VALUE enums = objptr->enums; long i; for (i = objptr->pos; 0 <= i && i < RARRAY_LEN(enums); objptr->pos = --i) { rb_check_funcall(RARRAY_AREF(enums, i), id_rewind, 0, 0); } return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Chain#inspect;F;[;[[@ëiÇ;T;;r;0;[;{;IC;"9Returns a printable version of the enumerator chain. ;T;[o;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @Â;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Â;[;I"@return [String];T;0;6i;[; @Â;[;I"`Returns a printable version of the enumerator chain. @overload inspect @return [String];T;0; @Â;!F;"o;#;$T;%iÁ;&iÅ;'@}Á;(I"mstatic VALUE enum_chain_inspect(VALUE obj) { return rb_exec_recursive(inspect_enum_chain, obj, 0); };T;)I"static VALUE;T;*T;A@}Á;BIC;[;A@}Á;CIC;[;A@}Á;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ëiÓ[@ëiF;T;: Chain;;K;;;[;{;IC;"ÄEnumerator::Chain is a subclass of Enumerator, which represents a chain of enumerables that works as a single enumerator. This type of objects can be created by Enumerable#chain and Enumerator#+.;T;[;[;I"Æ Enumerator::Chain is a subclass of Enumerator, which represents a chain of enumerables that works as a single enumerator. This type of objects can be created by Enumerable#chain and Enumerator#+. ;T;0; @}Á;!F;"o;#;$T;%iÓ;&iÙ;6i;'o;L;M0;N0;O0;;’;'@;Q@¼;R0;I"Enumerator::Chain;F;S@¼o; ;IC;[o;;F; ;;;;I")Enumerator::ArithmeticSequence#begin;F;[;[;F;;%;;K;[;{;IC;";T;[;[;@|;0; @CÂ;'@AÂ;*To;;F; ;;;;I"'Enumerator::ArithmeticSequence#end;F;[;[;F;;&;;K;[;{;IC;";T;[;[;@|;0; @LÂ;'@AÂ;*To;;F; ;;;;I"0Enumerator::ArithmeticSequence#exclude_end?;F;[;[;F;;Þ;;K;[;{;IC;";T;[o;2 ;3I"return;F;4@|;0;5[@~; @UÂ;[;@|;0; @UÂ;6i;'@AÂ;*To;;F; ;;;;I"(Enumerator::ArithmeticSequence#step;F;[;[;F;;Ú;;K;[;{;IC;";T;[;[;@|;0; @aÂ;'@AÂ;*To;;F; ;;;;I")Enumerator::ArithmeticSequence#first;F;[[@c0;[[@ëi ;T;;9;0;[;{;IC;"aReturns the first number in this arithmetic sequence, or an array of the first +n+ elements. ;T;[o;= ;3I" overload;F;40;;9;50;)I" first;T;IC;";T; @jÂ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;TI"nil;T; @jÂ;[;I"@return [Numeric, nil];T;0;6i;[; @jÂo;= ;3I" overload;F;40;;9;50;)I" first(n);T;IC;";T; @jÂ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @jÂ;[;I"@return [Array];T;0;6i;[[I"n;T0; @jÂ;[;I"¬Returns the first number in this arithmetic sequence, or an array of the first +n+ elements. @overload first @return [Numeric, nil] @overload first(n) @return [Array];T;0; @jÂ;!F;"o;#;$T;%iy ;&i€ ;'@AÂ;(I"%static VALUE arith_seq_first(int argc, VALUE *argv, VALUE self) { VALUE b, e, s, ary; long n; int x; rb_check_arity(argc, 0, 1); b = arith_seq_begin(self); e = arith_seq_end(self); s = arith_seq_step(self); if (argc == 0) { if (NIL_P(b)) { return Qnil; } if (!NIL_P(e)) { VALUE zero = INT2FIX(0); int r = rb_cmpint(rb_num_coerce_cmp(s, zero, idCmp), s, zero); if (r > 0 && RTEST(rb_funcall(b, '>', 1, e))) { return Qnil; } if (r < 0 && RTEST(rb_funcall(b, '<', 1, e))) { return Qnil; } } return b; } // TODO: the following code should be extracted as arith_seq_take n = NUM2LONG(argv[0]); if (n < 0) { rb_raise(rb_eArgError, "attempt to take negative size"); } if (n == 0) { return rb_ary_new_capa(0); } x = arith_seq_exclude_end_p(self); if (FIXNUM_P(b) && NIL_P(e) && FIXNUM_P(s)) { long i = FIX2LONG(b), unit = FIX2LONG(s); ary = rb_ary_new_capa(n); while (n > 0 && FIXABLE(i)) { rb_ary_push(ary, LONG2FIX(i)); i += unit; // FIXABLE + FIXABLE never overflow; --n; } if (n > 0) { b = LONG2NUM(i); while (n > 0) { rb_ary_push(ary, b); b = rb_big_plus(b, s); --n; } } return ary; } else if (FIXNUM_P(b) && FIXNUM_P(e) && FIXNUM_P(s)) { long i = FIX2LONG(b); long end = FIX2LONG(e); long unit = FIX2LONG(s); long len; if (unit >= 0) { if (!x) end += 1; len = end - i; if (len < 0) len = 0; ary = rb_ary_new_capa((n < len) ? n : len); while (n > 0 && i < end) { rb_ary_push(ary, LONG2FIX(i)); if (i + unit < i) break; i += unit; --n; } } else { if (!x) end -= 1; len = i - end; if (len < 0) len = 0; ary = rb_ary_new_capa((n < len) ? n : len); while (n > 0 && i > end) { rb_ary_push(ary, LONG2FIX(i)); if (i + unit > i) break; i += unit; --n; } } return ary; } else if (RB_FLOAT_TYPE_P(b) || RB_FLOAT_TYPE_P(e) || RB_FLOAT_TYPE_P(s)) { /* generate values like ruby_float_step */ double unit = NUM2DBL(s); double beg = NUM2DBL(b); double end = NIL_P(e) ? (unit < 0 ? -1 : 1)*HUGE_VAL : NUM2DBL(e); double len = ruby_float_step_size(beg, end, unit, x); long i; if (n > len) n = (long)len; if (isinf(unit)) { if (len > 0) { ary = rb_ary_new_capa(1); rb_ary_push(ary, DBL2NUM(beg)); } else { ary = rb_ary_new_capa(0); } } else if (unit == 0) { VALUE val = DBL2NUM(beg); ary = rb_ary_new_capa(n); for (i = 0; i < len; ++i) { rb_ary_push(ary, val); } } else { ary = rb_ary_new_capa(n); for (i = 0; i < n; ++i) { double d = i*unit+beg; if (unit >= 0 ? end < d : d < end) d = end; rb_ary_push(ary, DBL2NUM(d)); } } return ary; } return rb_call_super(argc, argv); };T;)I"static VALUE;T;*To;;F; ;;;;I"(Enumerator::ArithmeticSequence#last;F;[[@c0;[[@ëic;T;;Ý;0;[;{;IC;"_Returns the last number in this arithmetic sequence, or an array of the last +n+ elements. ;T;[o;= ;3I" overload;F;40;;Ý;50;)I" last;T;IC;";T; @–Â;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;TI"nil;T; @–Â;[;I"@return [Numeric, nil];T;0;6i;[; @–Âo;= ;3I" overload;F;40;;Ý;50;)I"last(n);T;IC;";T; @–Â;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @–Â;[;I"@return [Array];T;0;6i;[[I"n;T0; @–Â;[;I"¨Returns the last number in this arithmetic sequence, or an array of the last +n+ elements. @overload last @return [Numeric, nil] @overload last(n) @return [Array];T;0; @–Â;!F;"o;#;$T;%i[;&ib;'@AÂ;(I"Qstatic VALUE arith_seq_last(int argc, VALUE *argv, VALUE self) { VALUE b, e, s, len_1, len, last, nv, ary; int last_is_adjusted; long n; e = arith_seq_end(self); if (NIL_P(e)) { rb_raise(rb_eRangeError, "cannot get the last element of endless arithmetic sequence"); } b = arith_seq_begin(self); s = arith_seq_step(self); len_1 = num_idiv(num_minus(e, b), s); if (rb_num_negative_int_p(len_1)) { if (argc == 0) { return Qnil; } return rb_ary_new_capa(0); } last = num_plus(b, num_mul(s, len_1)); if ((last_is_adjusted = arith_seq_exclude_end_p(self) && rb_equal(last, e))) { last = num_minus(last, s); } if (argc == 0) { return last; } if (last_is_adjusted) { len = len_1; } else { len = rb_int_plus(len_1, INT2FIX(1)); } rb_scan_args(argc, argv, "1", &nv); if (!RB_INTEGER_TYPE_P(nv)) { nv = rb_to_int(nv); } if (RTEST(rb_int_gt(nv, len))) { nv = len; } n = NUM2LONG(nv); if (n < 0) { rb_raise(rb_eArgError, "negative array size"); } ary = rb_ary_new_capa(n); b = rb_int_minus(last, rb_int_mul(s, nv)); while (n) { b = rb_int_plus(b, s); rb_ary_push(ary, b); --n; } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"+Enumerator::ArithmeticSequence#inspect;F;[;[[@ëi¨;T;;r;0;[;{;IC;":Convert this arithmetic sequence to a printable form. ;T;[o;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @ÂÂ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ÂÂ;[;I"@return [String];T;0;6i;[; @ÂÂ;[;I"aConvert this arithmetic sequence to a printable form. @overload inspect @return [String];T;0; @ÂÂ;!F;"o;#;$T;%i¢;&i¦;'@AÂ;(I"ôstatic VALUE arith_seq_inspect(VALUE self) { struct enumerator *e; VALUE eobj, str, eargs; int range_p; TypedData_Get_Struct(self, struct enumerator, &enumerator_data_type, e); eobj = rb_attr_get(self, id_receiver); if (NIL_P(eobj)) { eobj = e->obj; } range_p = RTEST(rb_obj_is_kind_of(eobj, rb_cRange)); str = rb_sprintf("(%s%"PRIsVALUE"%s.", range_p ? "(" : "", eobj, range_p ? ")" : ""); rb_str_buf_append(str, rb_id2str(e->meth)); eargs = rb_attr_get(eobj, id_arguments); if (NIL_P(eargs)) { eargs = e->args; } if (eargs != Qfalse) { long argc = RARRAY_LEN(eargs); const VALUE *argv = RARRAY_CONST_PTR(eargs); /* WB: no new reference */ if (argc > 0) { VALUE kwds = Qnil; rb_str_buf_cat2(str, "("); if (RB_TYPE_P(argv[argc-1], T_HASH)) { int all_key = TRUE; rb_hash_foreach(argv[argc-1], key_symbol_p, (VALUE)&all_key); if (all_key) kwds = argv[--argc]; } while (argc--) { VALUE arg = *argv++; rb_str_append(str, rb_inspect(arg)); rb_str_buf_cat2(str, ", "); } if (!NIL_P(kwds)) { rb_hash_foreach(kwds, kwd_append, str); } rb_str_set_len(str, RSTRING_LEN(str)-2); /* drop the last ", " */ rb_str_buf_cat2(str, ")"); } } rb_str_buf_cat2(str, ")"); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"&Enumerator::ArithmeticSequence#==;F;[[I" other;T0;[[@ëiè;T;;`;0;[;{;IC;"‰Returns true only if +obj+ is an Enumerator::ArithmeticSequence, has equivalent begin, end, step, and exclude_end? settings. ;T;[o;= ;3I" overload;F;40;;`;50;)I"==(obj);T;IC;";T; @ÝÂ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ÝÂ;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @ÝÂ;[;I"±Returns true only if +obj+ is an Enumerator::ArithmeticSequence, has equivalent begin, end, step, and exclude_end? settings. @overload ==(obj) @return [Boolean];T;0; @ÝÂ;!F;"o;#;$T;%iá;&iæ;'@AÂ;(I")static VALUE arith_seq_eq(VALUE self, VALUE other) { if (!RTEST(rb_obj_is_kind_of(other, rb_cArithSeq))) { return Qfalse; } if (!rb_equal(arith_seq_begin(self), arith_seq_begin(other))) { return Qfalse; } if (!rb_equal(arith_seq_end(self), arith_seq_end(other))) { return Qfalse; } if (!rb_equal(arith_seq_step(self), arith_seq_step(other))) { return Qfalse; } if (arith_seq_exclude_end_p(self) != arith_seq_exclude_end_p(other)) { return Qfalse; } return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"'Enumerator::ArithmeticSequence#===;F;[[I" other;T0;[[@ëiè;T;;\;0;[;{;IC;"‰Returns true only if +obj+ is an Enumerator::ArithmeticSequence, has equivalent begin, end, step, and exclude_end? settings. ;T;[o;= ;3I" overload;F;40;;`;50;)I"==(obj);T;IC;";T; @üÂ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @üÂ;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @üÂ;[;@øÂ;0; @üÂ;!F;"o;#;$T;%iá;&iæ;'@AÂ;(I")static VALUE arith_seq_eq(VALUE self, VALUE other) { if (!RTEST(rb_obj_is_kind_of(other, rb_cArithSeq))) { return Qfalse; } if (!rb_equal(arith_seq_begin(self), arith_seq_begin(other))) { return Qfalse; } if (!rb_equal(arith_seq_end(self), arith_seq_end(other))) { return Qfalse; } if (!rb_equal(arith_seq_step(self), arith_seq_step(other))) { return Qfalse; } if (arith_seq_exclude_end_p(self) != arith_seq_exclude_end_p(other)) { return Qfalse; } return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"(Enumerator::ArithmeticSequence#eql?;F;[[I" other;T0;[[@ëiè;T;;_;0;[;{;IC;"‰Returns true only if +obj+ is an Enumerator::ArithmeticSequence, has equivalent begin, end, step, and exclude_end? settings.;T;[o;= ;3I" overload;F;40;;`;50;)I"==(obj);T;IC;";T; @Ã;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Ã;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @Ã;[;@øÂ;0; @Ã;!F;"o;#;$T;%iá;&iæ;6i;'@AÂ;(I")static VALUE arith_seq_eq(VALUE self, VALUE other) { if (!RTEST(rb_obj_is_kind_of(other, rb_cArithSeq))) { return Qfalse; } if (!rb_equal(arith_seq_begin(self), arith_seq_begin(other))) { return Qfalse; } if (!rb_equal(arith_seq_end(self), arith_seq_end(other))) { return Qfalse; } if (!rb_equal(arith_seq_step(self), arith_seq_step(other))) { return Qfalse; } if (arith_seq_exclude_end_p(self) != arith_seq_exclude_end_p(other)) { return Qfalse; } return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"(Enumerator::ArithmeticSequence#hash;F;[;[[@ëi;T;;b;0;[;{;IC;"¹Compute a hash-value for this arithmetic sequence. Two arithmetic sequences with same begin, end, step, and exclude_end? values will generate the same hash-value. See also Object#hash. ;T;[o;= ;3I" overload;F;40;;b;50;)I" hash;T;IC;";T; @8Ã;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @8Ã;[;I"@return [Integer];T;0;6i;[; @8Ã;[;I"ÞCompute a hash-value for this arithmetic sequence. Two arithmetic sequences with same begin, end, step, and exclude_end? values will generate the same hash-value. See also Object#hash. @overload hash @return [Integer];T;0; @8Ã;!F;"o;#;$T;%i;&i ;'@AÂ;(I"¸static VALUE arith_seq_hash(VALUE self) { st_index_t hash; VALUE v; hash = rb_hash_start(arith_seq_exclude_end_p(self)); v = rb_hash(arith_seq_begin(self)); hash = rb_hash_uint(hash, NUM2LONG(v)); v = rb_hash(arith_seq_end(self)); hash = rb_hash_uint(hash, NUM2LONG(v)); v = rb_hash(arith_seq_step(self)); hash = rb_hash_uint(hash, NUM2LONG(v)); hash = rb_hash_end(hash); return ST2FIX(hash); };T;)I"static VALUE;T;*To;;F; ;;;;I"(Enumerator::ArithmeticSequence#each;F;[;[[@ëi,;T;;;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I" each;T;IC;";T; @SÃ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"i;T; @SÃ;[;I"@yield [i];T;0;6i;[; @SÃo;= ;3I" overload;F;40;;;50;)I" each;T;IC;";T; @SÃ;>0;!F;[;[;I";T;0;6i;[; @SÃ;[;I"0 @overload each @yield [i] @overload each;T;0; @SÃ;!F;"o;#;$T;%i';&i*;'@AÂ;(I"#static VALUE arith_seq_each(VALUE self) { VALUE c, e, s, len_1, last; int x; if (!rb_block_given_p()) return self; c = arith_seq_begin(self); e = arith_seq_end(self); s = arith_seq_step(self); x = arith_seq_exclude_end_p(self); if (!RB_TYPE_P(s, T_COMPLEX) && ruby_float_step(c, e, s, x, TRUE)) { return self; } if (NIL_P(e)) { while (1) { rb_yield(c); c = rb_int_plus(c, s); } return self; } if (rb_equal(s, INT2FIX(0))) { while (1) { rb_yield(c); } return self; } len_1 = num_idiv(num_minus(e, c), s); last = num_plus(c, num_mul(s, len_1)); if (x && rb_equal(last, e)) { last = num_minus(last, s); } if (rb_num_negative_int_p(s)) { while (NUM_GE(c, last)) { rb_yield(c); c = num_plus(c, s); } } else { while (NUM_GE(last, c)) { rb_yield(c); c = num_plus(c, s); } } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"(Enumerator::ArithmeticSequence#size;F;[;[[@ëik;T;;¯;0;[;{;IC;"|Returns the number of elements in this arithmetic sequence if it is a finite sequence. Otherwise, returns nil. ;T;[o;= ;3I" overload;F;40;;¯;50;)I" size;T;IC;";T; @vÃ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;TI"nil;T; @vÃ;[;I"@return [Numeric, nil];T;0;6i;[; @vÃ;[;I"¦Returns the number of elements in this arithmetic sequence if it is a finite sequence. Otherwise, returns nil. @overload size @return [Numeric, nil];T;0; @vÃ;!F;"o;#;$T;%id;&ii;'@AÂ;(I"static VALUE arith_seq_size(VALUE self) { VALUE b, e, s, len_1, len, last; int x; b = arith_seq_begin(self); e = arith_seq_end(self); s = arith_seq_step(self); x = arith_seq_exclude_end_p(self); if (RB_FLOAT_TYPE_P(b) || RB_FLOAT_TYPE_P(e) || RB_FLOAT_TYPE_P(s)) { double ee, n; if (NIL_P(e)) { if (rb_num_negative_int_p(s)) { ee = -HUGE_VAL; } else { ee = HUGE_VAL; } } else { ee = NUM2DBL(e); } n = ruby_float_step_size(NUM2DBL(b), ee, NUM2DBL(s), x); if (isinf(n)) return DBL2NUM(n); if (POSFIXABLE(n)) return LONG2FIX((long)n); return rb_dbl2big(n); } if (NIL_P(e)) { return DBL2NUM(HUGE_VAL); } if (!rb_obj_is_kind_of(s, rb_cNumeric)) { s = rb_to_int(s); } if (rb_equal(s, INT2FIX(0))) { return DBL2NUM(HUGE_VAL); } len_1 = rb_int_idiv(rb_int_minus(e, b), s); if (rb_num_negative_int_p(len_1)) { return INT2FIX(0); } last = rb_int_plus(b, rb_int_mul(s, len_1)); if (x && rb_equal(last, e)) { len = len_1; } else { len = rb_int_plus(len_1, INT2FIX(1)); } return len; };T;)I"static VALUE;T;*To;;F; ;F;;;I"/Enumerator::ArithmeticSequence.__extract__;F;[[I"obj;T0;[[I"+ext/-test-/arith_seq/extract/extract.c;Ti;T;:__extract__;0;[;{;IC;";T;[;[;@|;0; @’Ã;'@AÂ;(I"´static VALUE arith_seq_s_extract(VALUE mod, VALUE obj) { rb_arithmetic_sequence_components_t x; VALUE ret; int r; r = rb_arithmetic_sequence_extract(obj, &x); ret = rb_ary_new2(5); rb_ary_store(ret, 0, r ? x.begin : Qnil); rb_ary_store(ret, 1, r ? x.end : Qnil); rb_ary_store(ret, 2, r ? x.step : Qnil); rb_ary_store(ret, 3, r ? INT2FIX(x.exclude_end) : Qnil); rb_ary_store(ret, 4, INT2FIX(r)); return ret; };T;)I"static VALUE;T;*T;A@AÂ;BIC;[;A@AÂ;CIC;[;A@AÂ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ëiò[@ëiP;T;:ArithmeticSequence;;K;;;[;{;IC;"+Enumerator::ArithmeticSequence is a subclass of Enumerator, that is a representation of sequences of numbers with common difference. Instances of this class can be generated by the Range#step and Numeric#step methods. The class can be used for slicing Array (see Array#slice) or custom collections.;T;[;[;I"- Enumerator::ArithmeticSequence is a subclass of Enumerator, that is a representation of sequences of numbers with common difference. Instances of this class can be generated by the Range#step and Numeric#step methods. The class can be used for slicing Array (see Array#slice) or custom collections. ;T;0; @AÂ;!F;"o;#;$T;%iò;&iú;6i;'o;L;M0;N0;O0;;’;'@;Q@¼;R0;I"#Enumerator::ArithmeticSequence;F;S@¼o;;F; ;;;;I"Enumerator#initialize;F;[[@c0;[[@ëiÑ;T;;Ð;0;[;{;IC;"ACreates a new Enumerator object, which can be used as an Enumerable. Iteration is defined by the given block, in which a "yielder" object, given as block parameter, can be used to yield a value by calling the +yield+ method (aliased as <<): fib = Enumerator.new do |y| a = b = 1 loop do y << a a, b = b, a + b end end fib.take(10) # => [1, 1, 2, 3, 5, 8, 13, 21, 34, 55] The optional parameter can be used to specify how to calculate the size in a lazy fashion (see Enumerator#size). It can either be a value or a callable object. ;T;[o;= ;3I" overload;F;40;;î;50;)I"new(size = nil);T;IC;";T; @´Ã;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"yielder;T; @´Ã;[;I"@yield [yielder];T;0;6i;[[I" size;TI"nil;T; @´Ã;[;I"pCreates a new Enumerator object, which can be used as an Enumerable. Iteration is defined by the given block, in which a "yielder" object, given as block parameter, can be used to yield a value by calling the +yield+ method (aliased as <<): fib = Enumerator.new do |y| a = b = 1 loop do y << a a, b = b, a + b end end fib.take(10) # => [1, 1, 2, 3, 5, 8, 13, 21, 34, 55] The optional parameter can be used to specify how to calculate the size in a lazy fashion (see Enumerator#size). It can either be a value or a callable object. @overload new(size = nil) @yield [yielder];T;0; @´Ã;!F;"o;#;$T;%i¸;&iÏ;'@¼;(I"qstatic VALUE enumerator_initialize(int argc, VALUE *argv, VALUE obj) { VALUE iter = rb_block_proc(); VALUE recv = generator_init(generator_allocate(rb_cGenerator), iter); VALUE arg0 = rb_check_arity(argc, 0, 1) ? argv[0] : Qnil; VALUE size = convert_to_feasible_size_value(arg0); return enumerator_init(obj, recv, sym_each, 0, 0, 0, size, false); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator#initialize_copy;F;[[I" orig;T0;[[@ëiÝ;T;;g;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @ÓÃ;!F;"o;#;$T;%iÜ;&iÜ;'@¼;(I"¼static VALUE enumerator_init_copy(VALUE obj, VALUE orig) { struct enumerator *ptr0, *ptr1; if (!OBJ_INIT_COPY(obj, orig)) return obj; ptr0 = enumerator_ptr(orig); if (ptr0->fib) { /* Fibers cannot be copied */ rb_raise(rb_eTypeError, "can't copy execution context"); } TypedData_Get_Struct(obj, struct enumerator, &enumerator_data_type, ptr1); if (!ptr1) { rb_raise(rb_eArgError, "unallocated enumerator"); } ptr1->obj = ptr0->obj; ptr1->meth = ptr0->meth; ptr1->args = ptr0->args; ptr1->fib = 0; ptr1->lookahead = Qundef; ptr1->feedvalue = Qundef; ptr1->size = ptr0->size; ptr1->size_fn = ptr0->size_fn; return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator#each;F;[[@c0;[[@ëiR;T;;;0;[;{;IC;">Iterates over the block according to how this Enumerator was constructed. If no block and no arguments are given, returns self. === Examples "Hello, world!".scan(/\w+/) #=> ["Hello", "world"] "Hello, world!".to_enum(:scan, /\w+/).to_a #=> ["Hello", "world"] "Hello, world!".to_enum(:scan).each(/\w+/).to_a #=> ["Hello", "world"] obj = Object.new def obj.each_arg(a, b=:b, *rest) yield a yield b yield rest :method_returned end enum = obj.to_enum :each_arg, :a, :x enum.each.to_a #=> [:a, :x, []] enum.each.equal?(enum) #=> true enum.each { |elm| elm } #=> :method_returned enum.each(:y, :z).to_a #=> [:a, :x, [:y, :z]] enum.each(:y, :z).equal?(enum) #=> false enum.each(:y, :z) { |elm| elm } #=> :method_returned ;T;[ o;= ;3I" overload;F;40;;;50;)I" each;T;IC;";T; @ãÃ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"elm;T; @ãÃo;2 ;3I"return;F;4I";T;0;5[I"Object;T; @ãÃ;[;I""@yield [elm] @return [Object];T;0;6i;[; @ãÃo;= ;3I" overload;F;40;;;50;)I" each;T;IC;";T; @ãÃ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Enumerator;T; @ãÃ;[;I"@return [Enumerator];T;0;6i;[; @ãÃo;= ;3I" overload;F;40;;;50;)I"each(*appending_args);T;IC;";T; @ãÃ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"elm;T; @ãÃo;2 ;3I"return;F;4I";T;0;5[I"Object;T; @ãÃ;[;I""@yield [elm] @return [Object];T;0;6i;[[I"*appending_args;T0; @ãÃo;= ;3I" overload;F;40;;;50;)I"each(*appending_args);T;IC;";T; @ãÃ;>0;!F;[;[;I";T;0;6i;[[I"*appending_args;T0; @ãÃ;[;I"úIterates over the block according to how this Enumerator was constructed. If no block and no arguments are given, returns self. === Examples "Hello, world!".scan(/\w+/) #=> ["Hello", "world"] "Hello, world!".to_enum(:scan, /\w+/).to_a #=> ["Hello", "world"] "Hello, world!".to_enum(:scan).each(/\w+/).to_a #=> ["Hello", "world"] obj = Object.new def obj.each_arg(a, b=:b, *rest) yield a yield b yield rest :method_returned end enum = obj.to_enum :each_arg, :a, :x enum.each.to_a #=> [:a, :x, []] enum.each.equal?(enum) #=> true enum.each { |elm| elm } #=> :method_returned enum.each(:y, :z).to_a #=> [:a, :x, [:y, :z]] enum.each(:y, :z).equal?(enum) #=> false enum.each(:y, :z) { |elm| elm } #=> :method_returned @overload each @yield [elm] @return [Object] @overload each @return [Enumerator] @overload each(*appending_args) @yield [elm] @return [Object] @overload each(*appending_args);T;0; @ãÃ;!F;"o;#;$T;%i.;&iT;'@¼;(I"?static VALUE enumerator_each(int argc, VALUE *argv, VALUE obj) { if (argc > 0) { struct enumerator *e = enumerator_ptr(obj = rb_obj_dup(obj)); VALUE args = e->args; if (args) { #if SIZEOF_INT < SIZEOF_LONG /* check int range overflow */ rb_long2int(RARRAY_LEN(args) + argc); #endif args = rb_ary_dup(args); rb_ary_cat(args, argv, argc); } else { args = rb_ary_new4(argc, argv); } e->args = args; e->size = Qnil; e->size_fn = 0; } if (!rb_block_given_p()) return obj; return enumerator_block_call(obj, 0, obj); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator#each_with_index;F;[;[[@ëi¢;T;;F;0;[;{;IC;"Same as Enumerator#with_index(0), i.e. there is no starting offset. If no block is given, a new Enumerator is returned that includes the index. ;T;[o;= ;3I" overload;F;40;;F;50;)I"each_with_index;T;IC;";T; @/Ä;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"(*args);TI"idx;T; @/Ä;[;I"@yield [(*args), idx];T;0;6i;[; @/Äo;= ;3I" overload;F;40;;F;50;)I"each_with_index;T;IC;";T; @/Ä;>0;!F;[;[;I";T;0;6i;[; @/Ä;[;I"ßSame as Enumerator#with_index(0), i.e. there is no starting offset. If no block is given, a new Enumerator is returned that includes the index. @overload each_with_index @yield [(*args), idx] @overload each_with_index;T;0; @/Ä;!F;"o;#;$T;%i˜;&i ;'@¼;(I"kstatic VALUE enumerator_each_with_index(VALUE obj) { return enumerator_with_index(0, NULL, obj); };T;)I"static VALUE;T;*To;;F; ;;;;I" Enumerator#each_with_object;F;[[I" memo;T0;[[@ëiÎ;T;;K;0;[;{;IC;"˜Iterates the given block for each element with an arbitrary object, +obj+, and returns +obj+ If no block is given, returns a new Enumerator. === Example to_three = Enumerator.new do |y| 3.times do |x| y << x end end to_three_with_string = to_three.with_object("foo") to_three_with_string.each do |x,string| puts "#{string}: #{x}" end # => foo: 0 # => foo: 1 # => foo: 2 ;T;[ o;= ;3I" overload;F;40;;K;50;)I"each_with_object(obj);T;IC;";T; @SÄ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"(*args);TI"obj;T; @SÄ;[;I"@yield [(*args), obj];T;0;6i;[[I"obj;T0; @SÄo;= ;3I" overload;F;40;;K;50;)I"each_with_object(obj);T;IC;";T; @SÄ;>0;!F;[;[;I";T;0;6i;[[I"obj;T0; @SÄo;= ;3I" overload;F;40;:with_object;50;)I"with_object(obj);T;IC;";T; @SÄ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"(*args);TI"obj;T; @SÄ;[;I"@yield [(*args), obj];T;0;6i;[[I"obj;T0; @SÄo;= ;3I" overload;F;40;;—;50;)I"with_object(obj);T;IC;";T; @SÄ;>0;!F;[;[;I";T;0;6i;[[I"obj;T0; @SÄ;[;I"@Iterates the given block for each element with an arbitrary object, +obj+, and returns +obj+ If no block is given, returns a new Enumerator. === Example to_three = Enumerator.new do |y| 3.times do |x| y << x end end to_three_with_string = to_three.with_object("foo") to_three_with_string.each do |x,string| puts "#{string}: #{x}" end # => foo: 0 # => foo: 1 # => foo: 2 @overload each_with_object(obj) @yield [(*args), obj] @overload each_with_object(obj) @overload with_object(obj) @yield [(*args), obj] @overload with_object(obj);T;0; @SÄ;!F;"o;#;$T;%i±;&iÍ;'@¼;(I"Òstatic VALUE enumerator_with_object(VALUE obj, VALUE memo) { RETURN_SIZED_ENUMERATOR(obj, 1, &memo, enumerator_enum_size); enumerator_block_call(obj, enumerator_with_object_i, memo); return memo; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator#with_index;F;[[@c0;[[@ëi;T;;Ž;0;[;{;IC;"ÚIterates the given block for each element with an index, which starts from +offset+. If no block is given, returns a new Enumerator that includes the index, starting from +offset+ +offset+:: the starting index to use ;T;[o;= ;3I" overload;F;40;;Ž;50;)I"with_index(offset = 0);T;IC;";T; @—Ä;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"(*args);TI"idx;T; @—Ä;[;I"@yield [(*args), idx];T;0;6i;[[I"offset;TI"0;T; @—Äo;= ;3I" overload;F;40;;Ž;50;)I"with_index(offset = 0);T;IC;";T; @—Ä;>0;!F;[;[;I";T;0;6i;[[I"offset;TI"0;T; @—Ä;[;@ü¼;0; @—Ä;!F;"o;#;$T;%i;&i‹;'@¼;(I"fstatic VALUE enumerator_with_index(int argc, VALUE *argv, VALUE obj) { VALUE memo; rb_check_arity(argc, 0, 1); RETURN_SIZED_ENUMERATOR(obj, argc, argv, enumerator_enum_size); memo = (!argc || NIL_P(memo = argv[0])) ? INT2FIX(0) : rb_to_int(memo); return enumerator_block_call(obj, enumerator_with_index_i, (VALUE)MEMO_NEW(memo, 0, 0)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator#with_object;F;[[I" memo;T0;[[@ëiÎ;T;;—;0;[;{;IC;"˜Iterates the given block for each element with an arbitrary object, +obj+, and returns +obj+ If no block is given, returns a new Enumerator. === Example to_three = Enumerator.new do |y| 3.times do |x| y << x end end to_three_with_string = to_three.with_object("foo") to_three_with_string.each do |x,string| puts "#{string}: #{x}" end # => foo: 0 # => foo: 1 # => foo: 2 ;T;[ o;= ;3I" overload;F;40;;K;50;)I"each_with_object(obj);T;IC;";T; @ÁÄ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"(*args);TI"obj;T; @ÁÄ;[;I"@yield [(*args), obj];T;0;6i;[[I"obj;T0; @ÁÄo;= ;3I" overload;F;40;;K;50;)I"each_with_object(obj);T;IC;";T; @ÁÄ;>0;!F;[;[;I";T;0;6i;[[I"obj;T0; @ÁÄo;= ;3I" overload;F;40;;—;50;)I"with_object(obj);T;IC;";T; @ÁÄ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"(*args);TI"obj;T; @ÁÄ;[;I"@yield [(*args), obj];T;0;6i;[[I"obj;T0; @ÁÄo;= ;3I" overload;F;40;;—;50;)I"with_object(obj);T;IC;";T; @ÁÄ;>0;!F;[;[;I";T;0;6i;[[I"obj;T0; @ÁÄ;[;@“Ä;0; @ÁÄ;!F;"o;#;$T;%i±;&iÍ;'@¼;(I"Òstatic VALUE enumerator_with_object(VALUE obj, VALUE memo) { RETURN_SIZED_ENUMERATOR(obj, 1, &memo, enumerator_enum_size); enumerator_block_call(obj, enumerator_with_object_i, memo); return memo; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator#next_values;F;[;[[@ëiA;T;:next_values;0;[;{;IC;"UReturns the next object as an array in the enumerator, and move the internal position forward. When the position reached at the end, StopIteration is raised. See class-level notes about external iterators. This method can be used to distinguish yield and yield nil. === Example o = Object.new def o.each yield yield 1 yield 1, 2 yield nil yield [1, 2] end e = o.to_enum p e.next_values p e.next_values p e.next_values p e.next_values p e.next_values e = o.to_enum p e.next p e.next p e.next p e.next p e.next ## yield args next_values next # yield [] nil # yield 1 [1] 1 # yield 1, 2 [1, 2] [1, 2] # yield nil [nil] nil # yield [1, 2] [[1, 2]] [1, 2] ;T;[o;= ;3I" overload;F;40;;˜;50;)I"next_values;T;IC;";T; @Å;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @Å;[;I"@return [Array];T;0;6i;[; @Å;[;I"€Returns the next object as an array in the enumerator, and move the internal position forward. When the position reached at the end, StopIteration is raised. See class-level notes about external iterators. This method can be used to distinguish yield and yield nil. === Example o = Object.new def o.each yield yield 1 yield 1, 2 yield nil yield [1, 2] end e = o.to_enum p e.next_values p e.next_values p e.next_values p e.next_values p e.next_values e = o.to_enum p e.next p e.next p e.next p e.next p e.next ## yield args next_values next # yield [] nil # yield 1 [1] 1 # yield 1, 2 [1, 2] [1, 2] # yield nil [nil] nil # yield [1, 2] [[1, 2]] [1, 2] @overload next_values @return [Array];T;0; @Å;!F;"o;#;$T;%i;&i>;'@¼;(I"static VALUE enumerator_next_values(VALUE obj) { struct enumerator *e = enumerator_ptr(obj); VALUE vs; if (e->lookahead != Qundef) { vs = e->lookahead; e->lookahead = Qundef; return vs; } return get_next_values(obj, e); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator#peek_values;F;[;[[@ëi¨;T;:peek_values;0;[;{;IC;" Returns the next object as an array, similar to Enumerator#next_values, but doesn't move the internal position forward. If the position is already at the end, StopIteration is raised. See class-level notes about external iterators. === Example o = Object.new def o.each yield yield 1 yield 1, 2 end e = o.to_enum p e.peek_values #=> [] e.next p e.peek_values #=> [1] p e.peek_values #=> [1] e.next p e.peek_values #=> [1, 2] e.next p e.peek_values # raises StopIteration ;T;[o;= ;3I" overload;F;40;;™;50;)I"peek_values;T;IC;";T; @Å;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @Å;[;I"@return [Array];T;0;6i;[; @Å;[;I"8Returns the next object as an array, similar to Enumerator#next_values, but doesn't move the internal position forward. If the position is already at the end, StopIteration is raised. See class-level notes about external iterators. === Example o = Object.new def o.each yield yield 1 yield 1, 2 end e = o.to_enum p e.peek_values #=> [] e.next p e.peek_values #=> [1] p e.peek_values #=> [1] e.next p e.peek_values #=> [1, 2] e.next p e.peek_values # raises StopIteration @overload peek_values @return [Array];T;0; @Å;!F;"o;#;$T;%iŠ;&i¥;'@¼;(I"mstatic VALUE enumerator_peek_values_m(VALUE obj) { return rb_ary_dup(enumerator_peek_values(obj)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator#next;F;[;[[@ëix;T;;r;0;[;{;IC;"KReturns the next object in the enumerator, and move the internal position forward. When the position reached at the end, StopIteration is raised. === Example a = [1,2,3] e = a.to_enum p e.next #=> 1 p e.next #=> 2 p e.next #=> 3 p e.next #raises StopIteration See class-level notes about external iterators. ;T;[o;= ;3I" overload;F;40;;r;50;)I" next;T;IC;";T; @:Å;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @:Å;[;I"@return [Object];T;0;6i;[; @:Å;[;I"pReturns the next object in the enumerator, and move the internal position forward. When the position reached at the end, StopIteration is raised. === Example a = [1,2,3] e = a.to_enum p e.next #=> 1 p e.next #=> 2 p e.next #=> 3 p e.next #raises StopIteration See class-level notes about external iterators. @overload next @return [Object];T;0; @:Å;!F;"o;#;$T;%id;&iu;'@¼;(I"vstatic VALUE enumerator_next(VALUE obj) { VALUE vs = enumerator_next_values(obj); return ary2sv(vs, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator#peek;F;[;[[@ëiÆ;T;: peek;0;[;{;IC;"Returns the next object in the enumerator, but doesn't move the internal position forward. If the position is already at the end, StopIteration is raised. See class-level notes about external iterators. === Example a = [1,2,3] e = a.to_enum p e.next #=> 1 p e.peek #=> 2 p e.peek #=> 2 p e.peek #=> 2 p e.next #=> 2 p e.next #=> 3 p e.peek #raises StopIteration ;T;[o;= ;3I" overload;F;40;;š;50;)I" peek;T;IC;";T; @UÅ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @UÅ;[;I"@return [Object];T;0;6i;[; @UÅ;[;I"²Returns the next object in the enumerator, but doesn't move the internal position forward. If the position is already at the end, StopIteration is raised. See class-level notes about external iterators. === Example a = [1,2,3] e = a.to_enum p e.next #=> 1 p e.peek #=> 2 p e.peek #=> 2 p e.peek #=> 2 p e.next #=> 2 p e.next #=> 3 p e.peek #raises StopIteration @overload peek @return [Object];T;0; @UÅ;!F;"o;#;$T;%i®;&iÃ;'@¼;(I"vstatic VALUE enumerator_peek(VALUE obj) { VALUE vs = enumerator_peek_values(obj); return ary2sv(vs, 1); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator#feed;F;[[I"v;T0;[[@ëiû;T;: feed;0;[;{;IC;"BSets the value to be returned by the next yield inside +e+. If the value is not set, the yield returns nil. This value is cleared after being yielded. # Array#map passes the array's elements to "yield" and collects the # results of "yield" as an array. # Following example shows that "next" returns the passed elements and # values passed to "feed" are collected as an array which can be # obtained by StopIteration#result. e = [1,2,3].map p e.next #=> 1 e.feed "a" p e.next #=> 2 e.feed "b" p e.next #=> 3 e.feed "c" begin e.next rescue StopIteration p $!.result #=> ["a", "b", "c"] end o = Object.new def o.each x = yield # (2) blocks p x # (5) => "foo" x = yield # (6) blocks p x # (8) => nil x = yield # (9) blocks p x # not reached w/o another e.next end e = o.to_enum e.next # (1) e.feed "foo" # (3) e.next # (4) e.next # (7) # (10) ;T;[o;= ;3I" overload;F;40;:obj;50;)I"obj;T;IC;";T; @pÅ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @pÅ;[;I"@return [nil];T;0;6i;[; @pÅ;[;I"bSets the value to be returned by the next yield inside +e+. If the value is not set, the yield returns nil. This value is cleared after being yielded. # Array#map passes the array's elements to "yield" and collects the # results of "yield" as an array. # Following example shows that "next" returns the passed elements and # values passed to "feed" are collected as an array which can be # obtained by StopIteration#result. e = [1,2,3].map p e.next #=> 1 e.feed "a" p e.next #=> 2 e.feed "b" p e.next #=> 3 e.feed "c" begin e.next rescue StopIteration p $!.result #=> ["a", "b", "c"] end o = Object.new def o.each x = yield # (2) blocks p x # (5) => "foo" x = yield # (6) blocks p x # (8) => nil x = yield # (9) blocks p x # not reached w/o another e.next end e = o.to_enum e.next # (1) e.feed "foo" # (3) e.next # (4) e.next # (7) # (10) @overload obj @return [nil];T;0; @pÅ;!F;"o;#;$T;%iÍ;&iø;'@¼;(I"éstatic VALUE enumerator_feed(VALUE obj, VALUE v) { struct enumerator *e = enumerator_ptr(obj); if (e->feedvalue != Qundef) { rb_raise(rb_eTypeError, "feed value already set"); } e->feedvalue = v; return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator#rewind;F;[;[[@ëi;T;;;0;[;{;IC;"|Rewinds the enumeration sequence to the beginning. If the enclosed object responds to a "rewind" method, it is called. ;T;[o;= ;3I" overload;F;40;;;50;)I"rewind;T;IC;";T; @Å;>0;!F;[;[;I";T;0;6i;[; @Å;[;I"ŠRewinds the enumeration sequence to the beginning. If the enclosed object responds to a "rewind" method, it is called. @overload rewind;T;0; @Å;!F;"o;#;$T;%i;&i ;'@¼;(I"static VALUE enumerator_rewind(VALUE obj) { struct enumerator *e = enumerator_ptr(obj); rb_check_funcall(e->obj, id_rewind, 0, 0); e->fib = 0; e->dst = Qnil; e->lookahead = Qundef; e->feedvalue = Qundef; e->stop_exc = Qfalse; return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator#inspect;F;[;[[@ëi¤;T;;r;0;[;{;IC;"-Creates a printable version of e. ;T;[o;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @£Å;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @£Å;[;I"@return [String];T;0;6i;[; @£Å;[;I"TCreates a printable version of e. @overload inspect @return [String];T;0; @£Å;!F;"o;#;$T;%i;&i¡;'@¼;(I"mstatic VALUE enumerator_inspect(VALUE obj) { return rb_exec_recursive(inspect_enumerator, obj, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator#size;F;[;[[@ëiµ;T;;¯;0;[;{;IC;"ÆReturns the size of the enumerator, or +nil+ if it can't be calculated lazily. (1..100).to_a.permutation(4).size # => 94109400 loop.size # => Float::INFINITY (1..100).drop_while.size # => nil ;T;[o;= ;3I" overload;F;40;;¯;50;)I" size;T;IC;";T; @¾Å;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"Float::INFINITY;TI"nil;T; @¾Å;[;I"-@return [Integer, Float::INFINITY, nil];T;0;6i;[; @¾Å;[;I"Returns the size of the enumerator, or +nil+ if it can't be calculated lazily. (1..100).to_a.permutation(4).size # => 94109400 loop.size # => Float::INFINITY (1..100).drop_while.size # => nil @overload size @return [Integer, Float::INFINITY, nil];T;0; @¾Å;!F;"o;#;$T;%iª;&i²;'@¼;(I"‰static VALUE enumerator_size(VALUE obj) { struct enumerator *e = enumerator_ptr(obj); int argc = 0; const VALUE *argv = NULL; VALUE size; if (e->procs) { struct generator *g = generator_ptr(e->obj); VALUE receiver = rb_check_funcall(g->obj, id_size, 0, 0); long i = 0; for (i = 0; i < RARRAY_LEN(e->procs); i++) { VALUE proc = RARRAY_AREF(e->procs, i); struct proc_entry *entry = proc_entry_ptr(proc); lazyenum_size_func *size_fn = entry->fn->size; if (!size_fn) { return Qnil; } receiver = (*size_fn)(proc, receiver); } return receiver; } if (e->size_fn) { return (*e->size_fn)(e->obj, e->args, obj); } if (e->args) { argc = (int)RARRAY_LEN(e->args); argv = RARRAY_CONST_PTR(e->args); } size = rb_check_funcall_kw(e->size, id_call, argc, argv, e->kw_splat); if (size != Qundef) return size; return e->size; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator#+;F;[[I" eobj;T0;[[@ëiê;T;;&;0;[;{;IC;"ŒReturns an enumerator object generated from this enumerator and a given enumerable. e = (1..3).each + [4, 5] e.to_a #=> [1, 2, 3, 4, 5] ;T;[o;= ;3I" overload;F;40;;&;50;)I"+(enum);T;IC;";T; @ÛÅ;>0;!F;[;[;I";T;0;6i;[[I" enum;T0; @ÛÅ;[;I" Returns an enumerator object generated from this enumerator and a given enumerable. e = (1..3).each + [4, 5] e.to_a #=> [1, 2, 3, 4, 5] @overload +(enum);T;0; @ÛÅ;!F;"o;#;$T;%ià;&iç;'@¼;(I"»static VALUE enumerator_plus(VALUE obj, VALUE eobj) { VALUE enums = rb_ary_new_from_args(2, obj, eobj); return enum_chain_initialize(enum_chain_allocate(rb_cEnumChain), enums); };T;)I"static VALUE;T;*To; ;IC;[o;;F; ;;;;I"%Enumerator::Generator#initialize;F;[[@c0;[[@ëiµ;T;;Ð;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @÷Å;!F;"o;#;$T;%i´;&i´;'@õÅ;(I"Ôstatic VALUE generator_initialize(int argc, VALUE *argv, VALUE obj) { VALUE proc; if (argc == 0) { rb_need_block(); proc = rb_block_proc(); } else { rb_scan_args(argc, argv, "1", &proc); if (!rb_obj_is_proc(proc)) rb_raise(rb_eTypeError, "wrong argument type %"PRIsVALUE" (expected Proc)", rb_obj_class(proc)); if (rb_block_given_p()) { rb_warn("given block not used"); } } return generator_init(obj, proc); };T;)I"static VALUE;T;*To;;F; ;;;;I"*Enumerator::Generator#initialize_copy;F;[[I" orig;T0;[[@ëiÐ;T;;g;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @Æ;!F;"o;#;$T;%iÏ;&iÏ;'@õÅ;(I"vstatic VALUE generator_init_copy(VALUE obj, VALUE orig) { struct generator *ptr0, *ptr1; if (!OBJ_INIT_COPY(obj, orig)) return obj; ptr0 = generator_ptr(orig); TypedData_Get_Struct(obj, struct generator, &generator_data_type, ptr1); if (!ptr1) { rb_raise(rb_eArgError, "unallocated generator"); } ptr1->proc = ptr0->proc; return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Generator#each;F;[[@c0;[[@ëiå;T;;;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @Æ;!F;"o;#;$T;%iä;&iä;'@õÅ;(I"@static VALUE generator_each(int argc, VALUE *argv, VALUE obj) { struct generator *ptr = generator_ptr(obj); VALUE args = rb_ary_new2(argc + 1); rb_ary_push(args, yielder_new()); if (argc > 0) { rb_ary_cat(args, argv, argc); } return rb_proc_call_kw(ptr->proc, args, RB_PASS_CALLED_KEYWORDS); };T;)I"static VALUE;T;*T;A@õÅ;BIC;[;A@õÅ;CIC;[@(;A@õÅ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ëi0;F;:Generator;;K;;;[;{;IC;";T;[;[;@|;0; @õÅ;6i;'@¼;I"Enumerator::Generator;F;S@]o; ;IC;[ o;;F; ;;;;I"#Enumerator::Yielder#initialize;F;[;[[@ëi(;T;;Ð;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @6Æ;!F;"o;#;$T;%i';&i';'@4Æ;(I"xstatic VALUE yielder_initialize(VALUE obj) { rb_need_block(); return yielder_init(obj, rb_block_proc()); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Yielder#yield;F;[[I" args;T0;[[@ëi1;T;: yield;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @DÆ;!F;"o;#;$T;%i0;&i0;'@4Æ;(I"¨static VALUE yielder_yield(VALUE obj, VALUE args) { struct yielder *ptr = yielder_ptr(obj); return rb_proc_call_kw(ptr->proc, args, RB_PASS_CALLED_KEYWORDS); };T;)I"static VALUE;T;*To;;F; ;;;;I"Enumerator::Yielder#<<;F;[[I"arg;T0;[[@ëi:;T;;Ý;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @TÆ;!F;"o;#;$T;%i9;&i9;'@4Æ;(I"®static VALUE yielder_yield_push(VALUE obj, VALUE arg) { struct yielder *ptr = yielder_ptr(obj); rb_proc_call_with_block(ptr->proc, 1, &arg, Qnil); return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I" Enumerator::Yielder#to_proc;F;[;[[@ëiP;T;;¨;0;[;{;IC;"#Returns a Proc object that takes arguments and yields them. This method is implemented so that a Yielder object can be directly passed to another method as a block argument. enum = Enumerator.new { |y| Dir.glob("*.rb") { |file| File.open(file) { |f| f.each_line(&y) } } } ;T;[;[;I"$Returns a Proc object that takes arguments and yields them. This method is implemented so that a Yielder object can be directly passed to another method as a block argument. enum = Enumerator.new { |y| Dir.glob("*.rb") { |file| File.open(file) { |f| f.each_line(&y) } } } ;T;0; @dÆ;!F;"o;#;$T;%iD;&iN;'@4Æ;(I"‹static VALUE yielder_to_proc(VALUE obj) { VALUE method = rb_obj_method(obj, sym_yield); return rb_funcall(method, idTo_proc, 0); };T;)I"static VALUE;T;*T;A@4Æ;BIC;[;A@4Æ;CIC;[;A@4Æ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ëi8;F;:Yielder;;K;;;[;{;IC;";T;[;[;@|;0; @4Æ;6i;'@¼;I"Enumerator::Yielder;F;S@]o; ;IC;[o;;F; ;;;;I"Enumerator::Producer#each;F;[;[[@ëi’;T;;;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @ƒÆ;!F;"o;#;$T;%i‘;&i‘;'@Æ;(I"§static VALUE producer_each(VALUE obj) { rb_need_block(); return rb_rescue2(producer_each_i, obj, producer_each_stop, (VALUE)0, rb_eStopIteration, (VALUE)0); };T;)I"static VALUE;T;*T;A@Æ;BIC;[;A@Æ;CIC;[;A@Æ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ëi@;F;: Producer;;K;;;[;{;IC;";T;[;[;@|;0; @Æ;6i;'@¼;I"Enumerator::Producer;F;S@]o;;F; ;F;;;I"Enumerator.produce;F;[[@c0;[[@ëiÃ;T;:produce;0;[;{;IC;"ÙCreates an infinite enumerator from any block, just called over and over. The result of the previous iteration is passed to the next one. If +initial+ is provided, it is passed to the first iteration, and becomes the first element of the enumerator; if it is not provided, the first iteration receives +nil+, and its result becomes the first element of the iterator. Raising StopIteration from the block stops an iteration. Enumerator.produce(1, &:succ) # => enumerator of 1, 2, 3, 4, .... Enumerator.produce { rand(10) } # => infinite random number sequence ancestors = Enumerator.produce(node) { |prev| node = prev.parent or raise StopIteration } enclosing_section = ancestors.find { |n| n.type == :section } Using ::produce together with Enumerable methods like Enumerable#detect, Enumerable#slice_after, Enumerable#take_while can provide Enumerator-based alternatives for +while+ and +until+ cycles: # Find next Tuesday require "date" Enumerator.produce(Date.today, &:succ).detect(&:tuesday?) # Simple lexer: require "strscan" scanner = StringScanner.new("7+38/6") PATTERN = %r{\d+|[-/+*]} Enumerator.produce { scanner.scan(PATTERN) }.slice_after { scanner.eos? }.first # => ["7", "+", "38", "/", "6"] ;T;[o;= ;3I" overload;F;40;;¡;50;)I"produce(initial = nil);T;IC;";T; @ Æ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" prev;T; @ Æ;[;I"@yield [prev];T;0;6i;[[I"initial;TI"nil;T; @ Æ;[;I"Creates an infinite enumerator from any block, just called over and over. The result of the previous iteration is passed to the next one. If +initial+ is provided, it is passed to the first iteration, and becomes the first element of the enumerator; if it is not provided, the first iteration receives +nil+, and its result becomes the first element of the iterator. Raising StopIteration from the block stops an iteration. Enumerator.produce(1, &:succ) # => enumerator of 1, 2, 3, 4, .... Enumerator.produce { rand(10) } # => infinite random number sequence ancestors = Enumerator.produce(node) { |prev| node = prev.parent or raise StopIteration } enclosing_section = ancestors.find { |n| n.type == :section } Using ::produce together with Enumerable methods like Enumerable#detect, Enumerable#slice_after, Enumerable#take_while can provide Enumerator-based alternatives for +while+ and +until+ cycles: # Find next Tuesday require "date" Enumerator.produce(Date.today, &:succ).detect(&:tuesday?) # Simple lexer: require "strscan" scanner = StringScanner.new("7+38/6") PATTERN = %r{\d+|[-/+*]} Enumerator.produce { scanner.scan(PATTERN) }.slice_after { scanner.eos? }.first # => ["7", "+", "38", "/", "6"] @overload produce(initial = nil) @yield [prev];T;0; @ Æ;!F;"o;#;$T;%i ;&iÁ;'@¼;(I"¾static VALUE enumerator_s_produce(int argc, VALUE *argv, VALUE klass) { VALUE init, producer; if (!rb_block_given_p()) rb_raise(rb_eArgError, "no block given"); if (rb_scan_args(argc, argv, "01", &init) == 0) { init = Qundef; } producer = producer_init(producer_allocate(rb_cEnumProducer), init, rb_block_proc()); return rb_enumeratorize_with_size_kw(producer, sym_each, 0, 0, producer_size, RB_NO_KEYWORDS); };T;)I"static VALUE;T;*T;A@¼;BIC;[;A@¼;CIC;[o;L;M0;N0;O0;;;'@;Q@(;R0;A@¼;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ëi%[@ëi°;T;;’;;K;;;[;{;IC;"\ A class which allows both internal and external iteration. An Enumerator can be created by the following methods. - Object#to_enum - Object#enum_for - Enumerator.new Most methods have two forms: a block form where the contents are evaluated for each item in the enumeration, and a non-block form which returns a new Enumerator wrapping the iteration. enumerator = %w(one two three).each puts enumerator.class # => Enumerator enumerator.each_with_object("foo") do |item, obj| puts "#{obj}: #{item}" end # foo: one # foo: two # foo: three enum_with_obj = enumerator.each_with_object("foo") puts enum_with_obj.class # => Enumerator enum_with_obj.each do |item, obj| puts "#{obj}: #{item}" end # foo: one # foo: two # foo: three This allows you to chain Enumerators together. For example, you can map a list's elements to strings containing the index and the element as a string via: puts %w[foo bar baz].map.with_index { |w, i| "#{i}:#{w}" } # => ["0:foo", "1:bar", "2:baz"] An Enumerator can also be used as an external iterator. For example, Enumerator#next returns the next value of the iterator or raises StopIteration if the Enumerator is at the end. e = [1,2,3].each # returns an enumerator object. puts e.next # => 1 puts e.next # => 2 puts e.next # => 3 puts e.next # raises StopIteration Note that enumeration sequence by +next+, +next_values+, +peek+ and +peek_values+ do not affect other non-external enumeration methods, unless the underlying iteration method itself has side-effect, e.g. IO#each_line. Moreover, implementation typically uses fibers so performance could be slower and exception stacktraces different than expected. You can use this to implement an internal iterator as follows: def ext_each(e) while true begin vs = e.next_values rescue StopIteration return $!.result end y = yield(*vs) e.feed y end end o = Object.new def o.each puts yield puts yield(1) puts yield(1, 2) 3 end # use o.each as an internal iterator directly. puts o.each {|*x| puts x; [:b, *x] } # => [], [:b], [1], [:b, 1], [1, 2], [:b, 1, 2], 3 # convert o.each to an external iterator for # implementing an internal iterator. puts ext_each(o.to_enum) {|*x| puts x; [:b, *x] } # => [], [:b], [1], [:b, 1], [1, 2], [:b, 1, 2], 3;T;[;[;I"_ A class which allows both internal and external iteration. An Enumerator can be created by the following methods. - Object#to_enum - Object#enum_for - Enumerator.new Most methods have two forms: a block form where the contents are evaluated for each item in the enumeration, and a non-block form which returns a new Enumerator wrapping the iteration. enumerator = %w(one two three).each puts enumerator.class # => Enumerator enumerator.each_with_object("foo") do |item, obj| puts "#{obj}: #{item}" end # foo: one # foo: two # foo: three enum_with_obj = enumerator.each_with_object("foo") puts enum_with_obj.class # => Enumerator enum_with_obj.each do |item, obj| puts "#{obj}: #{item}" end # foo: one # foo: two # foo: three This allows you to chain Enumerators together. For example, you can map a list's elements to strings containing the index and the element as a string via: puts %w[foo bar baz].map.with_index { |w, i| "#{i}:#{w}" } # => ["0:foo", "1:bar", "2:baz"] An Enumerator can also be used as an external iterator. For example, Enumerator#next returns the next value of the iterator or raises StopIteration if the Enumerator is at the end. e = [1,2,3].each # returns an enumerator object. puts e.next # => 1 puts e.next # => 2 puts e.next # => 3 puts e.next # raises StopIteration Note that enumeration sequence by +next+, +next_values+, +peek+ and +peek_values+ do not affect other non-external enumeration methods, unless the underlying iteration method itself has side-effect, e.g. IO#each_line. Moreover, implementation typically uses fibers so performance could be slower and exception stacktraces different than expected. You can use this to implement an internal iterator as follows: def ext_each(e) while true begin vs = e.next_values rescue StopIteration return $!.result end y = yield(*vs) e.feed y end end o = Object.new def o.each puts yield puts yield(1) puts yield(1, 2) 3 end # use o.each as an internal iterator directly. puts o.each {|*x| puts x; [:b, *x] } # => [], [:b], [1], [:b, 1], [1, 2], [:b, 1, 2], 3 # convert o.each to an external iterator for # implementing an internal iterator. puts ext_each(o.to_enum) {|*x| puts x; [:b, *x] } # => [], [:b], [1], [:b, 1], [1, 2], [:b, 1, 2], 3 ;T;0; @¼;!F;"o;#;$T;%i%;&i{;6i;'@;I"Enumerator;F;S@]o; ;IC;[o;;F; ;;;;I"StopIteration#result;F;[;[[@ëi;T;:result;0;[;{;IC;"]Returns the return value of the iterator. o = Object.new def o.each yield 1 yield 2 yield 3 100 end e = o.to_enum puts e.next #=> 1 puts e.next #=> 2 puts e.next #=> 3 begin e.next rescue StopIteration => ex puts ex.result #=> 100 end ;T;[o;= ;3I" overload;F;40;;¢;50;)I"result;T;IC;";T; @ÔÆ;>0;!F;[;[;I";T;0;6i;[; @ÔÆ;[;I"qReturns the return value of the iterator. o = Object.new def o.each yield 1 yield 2 yield 3 100 end e = o.to_enum puts e.next #=> 1 puts e.next #=> 2 puts e.next #=> 3 begin e.next rescue StopIteration => ex puts ex.result #=> 100 end @overload result;T;0; @ÔÆ;!F;"o;#;$T;%iû ;&i;'@ÒÆ;(I"Vstatic VALUE stop_result(VALUE self) { return rb_attr_get(self, id_result); };T;)I"static VALUE;T;*T;A@ÒÆ;BIC;[;A@ÒÆ;CIC;[;A@ÒÆ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ëiè [@ëi,;T;:StopIteration;;K;;;[;{;IC;"ÜRaised to stop the iteration, in particular by Enumerator#next. It is rescued by Kernel#loop. loop do puts "Hello" raise StopIteration puts "World" end puts "Done!" produces: Hello Done!;T;[;[;I"Þ Raised to stop the iteration, in particular by Enumerator#next. It is rescued by Kernel#loop. loop do puts "Hello" raise StopIteration puts "World" end puts "Done!" produces: Hello Done! ;T;0; @ÒÆ;!F;"o;#;$T;%iè ;&i÷ ;6i;'@;I"StopIteration;F;So;L;M0;N0;O0;:IndexError;'@;Qo; ;IC;[;A@ýÆ;BIC;[;A@ýÆ;CIC;[;A@ýÆ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷i~ [@÷iï ;T;;¤;;K;;;[;{;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; @ýÆ;!F;"o;#;$T;%i~ ;&i† ;'@;I"IndexError;F;S@ì;R;F@(o; ;IC;[o; ;IC;[ o;;F; ;;;;I"CGI::Escape#escapeHTML;F;[[I"str;T0;[[I"ext/cgi/escape/escape.c;Ti1;T;:escapeHTML;0;[;{;IC;"!Returns HTML-escaped string. ;T;[o;= ;3I" overload;F;40;;¥;50;)I"escapeHTML(string);T;IC;";T; @Ç;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Ç;[;I"@return [String];T;0;6i;[[I"string;T0; @Ç;[;I"TReturns HTML-escaped string. @overload escapeHTML(string) @return [String];T;0; @Ç;!F;"o;#;$T;%i*;&i/;'@Ç;(I"Õstatic VALUE cgiesc_escape_html(VALUE self, VALUE str) { StringValue(str); if (rb_enc_str_asciicompat_p(str)) { return optimized_escape_html(str); } else { return rb_call_super(1, &str); } };T;)I"static VALUE;T;*To;;F; ;;;;I"CGI::Escape#unescapeHTML;F;[[I"str;T0;[[@ÇiE;T;:unescapeHTML;0;[;{;IC;"#Returns HTML-unescaped string. ;T;[o;= ;3I" overload;F;40;;¦;50;)I"unescapeHTML(string);T;IC;";T; @5Ç;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @5Ç;[;I"@return [String];T;0;6i;[[I"string;T0; @5Ç;[;I"XReturns HTML-unescaped string. @overload unescapeHTML(string) @return [String];T;0; @5Ç;!F;"o;#;$T;%i>;&iC;'@Ç;(I"Ùstatic VALUE cgiesc_unescape_html(VALUE self, VALUE str) { StringValue(str); if (rb_enc_str_asciicompat_p(str)) { return optimized_unescape_html(str); } else { return rb_call_super(1, &str); } };T;)I"static VALUE;T;*To;;F; ;;;;I"CGI::Escape#escape;F;[[I"str;T0;[[@ÇiY;T;;&;0;[;{;IC;" Returns URL-escaped string. ;T;[o;= ;3I" overload;F;40;;&;50;)I"escape(string);T;IC;";T; @TÇ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @TÇ;[;I"@return [String];T;0;6i;[[I"string;T0; @TÇ;[;I"OReturns URL-escaped string. @overload escape(string) @return [String];T;0; @TÇ;!F;"o;#;$T;%iR;&iW;'@Ç;(I"Ëstatic VALUE cgiesc_escape(VALUE self, VALUE str) { StringValue(str); if (rb_enc_str_asciicompat_p(str)) { return optimized_escape(str); } else { return rb_call_super(1, &str); } };T;)I"static VALUE;T;*To;;F; ;;;;I"CGI::Escape#unescape;F;[[@c0;[[@Çiu;T;: unescape;0;[;{;IC;""Returns URL-unescaped string. ;T;[o;= ;3I" overload;F;40;;§;50;)I"0unescape(string, encoding=@@accept_charset);T;IC;";T; @sÇ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @sÇ;[;I"@return [String];T;0;6i;[[I"string;T0[I" encoding;TI"@@accept_charset;T; @sÇ;[;I"nReturns URL-unescaped string. @overload unescape(string, encoding=@@accept_charset) @return [String];T;0; @sÇ;!F;"o;#;$T;%in;&is;'@Ç;(I"Nstatic VALUE cgiesc_unescape(int argc, VALUE *argv, VALUE self) { VALUE str = (rb_check_arity(argc, 1, 2), argv[0]); StringValue(str); if (rb_enc_str_asciicompat_p(str)) { VALUE enc = accept_charset(argc-1, argv+1, self); return optimized_unescape(str, enc); } else { return rb_call_super(argc, argv); } };T;)I"static VALUE;T;*T;A@Ç;BIC;[;A@Ç;CIC;[;A@Ç;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@Çi”;F;:Escape;;K;;;[;{;IC;";T;[;[;@|;0; @Ç;6i;'@Ç;I"CGI::Escape;Fo; ;IC;[;A@£Ç;BIC;[;A@£Ç;CIC;[;A@£Ç;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@Çi•;F;: Util;;K;;;[;{;IC;";T;[;[;@|;0; @£Ç;'@Ç;I"CGI::Util;F;A@Ç;BIC;[;A@Ç;CIC;[;A@Ç;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@Çi“;F;:CGI;;K;;;[;{;IC;";T;[;[;@|;0; @Ç;'@;I"CGI;F;S@]o; ;IC;[.o; ;IC;[;A@ÅÇ;BIC;[;A@ÅÇ;CIC;[;A@ÅÇ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[I" ext/openssl/ossl_x509attr.c;Ti5[I"ext/openssl/ossl_hmac.c;TiK[I"ext/openssl/ossl_config.c;TiS[I"ext/openssl/ossl_engine.c;Ti[I"ext/openssl/ossl_pkey.c;TiA[I" ext/openssl/ossl_x509cert.c;TiË[I"#ext/openssl/ossl_ssl_session.c;Ti9[I"ext/openssl/ossl_rand.c;Ti´[I"ext/openssl/ossl_x509ext.c;TiÈ[I"ext/openssl/ossl_cipher.c;TiQ[I"ext/openssl/ossl_ssl.c;TiÏ [I"ext/openssl/ossl.c;Ti²[I" ext/openssl/ossl_x509name.c;Ti[I"ext/openssl/ossl_x509crl.c;Tiý[I"ext/openssl/ossl_kdf.c;Tið[I"ext/openssl/ossl_ocsp.c;Ti§[I"ext/openssl/ossl_pkcs7.c;Ti [I"ext/openssl/ossl_x509req.c;Ti[I"ext/openssl/ossl_pkcs12.c;Tiî[I"ext/openssl/ossl_digest.c;Ti>[I"!ext/openssl/ossl_x509store.c;Ti[I"#ext/openssl/ossl_x509revoked.c;Ti[I"ext/openssl/ossl_bn.c;Ti€[I"ext/openssl/ossl_asn1.c;Tiq[I"ext/openssl/ossl_ns_spki.c;Ti[I"ext/openssl/ossl_pkey_ec.c;Ti”;F;:OpenSSLError;;K;;;[;{;IC;";T;[;[;@|;0; @ÅÇ;'@ÃÇ;I"OpenSSL::OpenSSLError;F;S@ìo; ;IC;[o; ;IC;[;A@È;BIC;[;A@È;CIC;[;A@È;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ÐÇi9;F;:AttributeError;;K;;;[;{;IC;";T;[;[;@|;0; @È;'@ È;I""OpenSSL::X509::AttributeError;F;S@ÅÇo; ;IC;[o;;F; ;;;;I"(OpenSSL::X509::Attribute#initialize;F;[[@c0;[[@ÐÇij;T;;Ð;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;î;50;)I"new(oid [, value]);T;IC;";T; @È;>0;!F;[;[;I";T;0;6i;[[I"oid[, value];T0; @È;[;I"" @overload new(oid [, value]);T;0; @È;!F;"o;#;$T;%if;&ig;'@È;(I"bstatic VALUE ossl_x509attr_initialize(int argc, VALUE *argv, VALUE self) { VALUE oid, value; X509_ATTRIBUTE *attr, *x; const unsigned char *p; GetX509Attr(self, attr); if(rb_scan_args(argc, argv, "11", &oid, &value) == 1){ oid = ossl_to_der_if_possible(oid); StringValue(oid); p = (unsigned char *)RSTRING_PTR(oid); x = d2i_X509_ATTRIBUTE(&attr, &p, RSTRING_LEN(oid)); DATA_PTR(self) = attr; if(!x){ ossl_raise(eX509AttrError, NULL); } return self; } rb_funcall(self, rb_intern("oid="), 1, oid); rb_funcall(self, rb_intern("value="), 1, value); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"-OpenSSL::X509::Attribute#initialize_copy;F;[[I" other;T0;[[@ÐÇi~;T;;g;0;[;{;IC;";T;[;[;@|;0; @7È;'@È;(I"Ÿstatic VALUE ossl_x509attr_initialize_copy(VALUE self, VALUE other) { X509_ATTRIBUTE *attr, *attr_other, *attr_new; rb_check_frozen(self); GetX509Attr(self, attr); GetX509Attr(other, attr_other); attr_new = X509_ATTRIBUTE_dup(attr_other); if (!attr_new) ossl_raise(eX509AttrError, "X509_ATTRIBUTE_dup"); SetX509Attr(self, attr_new); X509_ATTRIBUTE_free(attr); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::X509::Attribute#oid=;F;[[I"oid;T0;[[@ÐÇi•;T;: oid=;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"oid=(string);T;IC;";T; @EÈ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @EÈ;[;I"@return [String];T;0;6i;[[I"string;T0; @EÈ;[;I"/ @overload oid=(string) @return [String];T;0; @EÈ;!F;"o;#;$T;%i‘;&i“;'@È;(I"¹static VALUE ossl_x509attr_set_oid(VALUE self, VALUE oid) { X509_ATTRIBUTE *attr; ASN1_OBJECT *obj; char *s; GetX509Attr(self, attr); s = StringValueCStr(oid); obj = OBJ_txt2obj(s, 0); if(!obj) ossl_raise(eX509AttrError, NULL); if (!X509_ATTRIBUTE_set1_object(attr, obj)) { ASN1_OBJECT_free(obj); ossl_raise(eX509AttrError, "X509_ATTRIBUTE_set1_object"); } ASN1_OBJECT_free(obj); return oid; };T;)I"static VALUE;T;*To;;F; ;;;;I"!OpenSSL::X509::Attribute#oid;F;[;[[@ÐÇi;T;:oid;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;®;50;)I"oid;T;IC;";T; @dÈ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @dÈ;[;I"@return [String];T;0;6i;[; @dÈ;[;I"& @overload oid @return [String];T;0; @dÈ;!F;"o;#;$T;%i©;&i«;'@È;(I"Ïstatic VALUE ossl_x509attr_get_oid(VALUE self) { X509_ATTRIBUTE *attr; ASN1_OBJECT *oid; BIO *out; VALUE ret; int nid; GetX509Attr(self, attr); oid = X509_ATTRIBUTE_get0_object(attr); if ((nid = OBJ_obj2nid(oid)) != NID_undef) ret = rb_str_new2(OBJ_nid2sn(nid)); else{ if (!(out = BIO_new(BIO_s_mem()))) ossl_raise(eX509AttrError, NULL); i2a_ASN1_OBJECT(out, oid); ret = ossl_membio2str(out); } return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"$OpenSSL::X509::Attribute#value=;F;[[I" value;T0;[[@ÐÇiÈ;T;:value=;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;¯;50;)I"value=(asn1);T;IC;";T; @È;>0;!F;[;[;I";T;0;6i;[[I" asn1;T0; @È;[;I" @overload value=(asn1);T;0; @È;!F;"o;#;$T;%iÄ;&iÅ;'@È;(I"©static VALUE ossl_x509attr_set_value(VALUE self, VALUE value) { X509_ATTRIBUTE *attr; VALUE asn1_value; int i, asn1_tag; OSSL_Check_Kind(value, cASN1Data); asn1_tag = NUM2INT(rb_attr_get(value, rb_intern("@tag"))); asn1_value = rb_attr_get(value, rb_intern("@value")); if (asn1_tag != V_ASN1_SET) ossl_raise(eASN1Error, "argument must be ASN1::Set"); if (!RB_TYPE_P(asn1_value, T_ARRAY)) ossl_raise(eASN1Error, "ASN1::Set has non-array value"); GetX509Attr(self, attr); if (X509_ATTRIBUTE_count(attr)) { /* populated, reset first */ ASN1_OBJECT *obj = X509_ATTRIBUTE_get0_object(attr); X509_ATTRIBUTE *new_attr = X509_ATTRIBUTE_create_by_OBJ(NULL, obj, 0, NULL, -1); if (!new_attr) ossl_raise(eX509AttrError, NULL); SetX509Attr(self, new_attr); X509_ATTRIBUTE_free(attr); attr = new_attr; } for (i = 0; i < RARRAY_LEN(asn1_value); i++) { ASN1_TYPE *a1type = ossl_asn1_get_asn1type(RARRAY_AREF(asn1_value, i)); if (!X509_ATTRIBUTE_set1_data(attr, ASN1_TYPE_get(a1type), a1type->value.ptr, -1)) { ASN1_TYPE_free(a1type); ossl_raise(eX509AttrError, NULL); } ASN1_TYPE_free(a1type); } return value; };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::X509::Attribute#value;F;[;[[@ÐÇió;T;;¾;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;¾;50;)I" value;T;IC;";T; @™È;>0;!F;[;[;I";T;0;6i;[; @™È;[;I" @overload value;T;0; @™È;!F;"o;#;$T;%iï;&ið;'@È;(I"hstatic VALUE ossl_x509attr_get_value(VALUE self) { X509_ATTRIBUTE *attr; STACK_OF(ASN1_TYPE) *sk; VALUE str; int i, count, len; unsigned char *p; GetX509Attr(self, attr); /* there is no X509_ATTRIBUTE_get0_set() :( */ if (!(sk = sk_ASN1_TYPE_new_null())) ossl_raise(eX509AttrError, "sk_new"); count = X509_ATTRIBUTE_count(attr); for (i = 0; i < count; i++) sk_ASN1_TYPE_push(sk, X509_ATTRIBUTE_get0_type(attr, i)); if ((len = i2d_ASN1_SET_ANY(sk, NULL)) <= 0) { sk_ASN1_TYPE_free(sk); ossl_raise(eX509AttrError, NULL); } str = rb_str_new(0, len); p = (unsigned char *)RSTRING_PTR(str); if (i2d_ASN1_SET_ANY(sk, &p) <= 0) { sk_ASN1_TYPE_free(sk); ossl_raise(eX509AttrError, NULL); } ossl_str_adjust(str, p); sk_ASN1_TYPE_free(sk); return rb_funcall(mASN1, rb_intern("decode"), 1, str); };T;)I"static VALUE;T;*To;;F; ;;;;I"$OpenSSL::X509::Attribute#to_der;F;[;[[@ÐÇi;T;:to_der;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;°;50;)I"to_der;T;IC;";T; @¯È;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @¯È;[;I"@return [String];T;0;6i;[; @¯È;[;I") @overload to_der @return [String];T;0; @¯È;!F;"o;#;$T;%i;&i;'@È;(I"¶static VALUE ossl_x509attr_to_der(VALUE self) { X509_ATTRIBUTE *attr; VALUE str; int len; unsigned char *p; GetX509Attr(self, attr); if((len = i2d_X509_ATTRIBUTE(attr, NULL)) <= 0) ossl_raise(eX509AttrError, NULL); str = rb_str_new(0, len); p = (unsigned char *)RSTRING_PTR(str); if(i2d_X509_ATTRIBUTE(attr, &p) <= 0) ossl_raise(eX509AttrError, NULL); ossl_str_adjust(str, p); return str; };T;)I"static VALUE;T;*T;A@È;BIC;[;A@È;CIC;[;A@È;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ÐÇi;;F;:Attribute;;K;;;[;{;IC;";T;[;[;@|;0; @È;6i;'@ È;I"OpenSSL::X509::Attribute;F;S@]o; ;IC;[;A@ÙÈ;BIC;[;A@ÙÈ;CIC;[;A@ÙÈ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ÚÇiÏ;F;:CertificateError;;K;;;[;{;IC;";T;[;[;@|;0; @ÙÈ;'@ È;I"$OpenSSL::X509::CertificateError;F;S@ÅÇo; ;IC;["o;;F; ;;;;I"*OpenSSL::X509::Certificate#initialize;F;[[@c0;[[@ÚÇiw;T;;Ð;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;î;50;)I"new;T;IC;";T; @ìÈ;>0;!F;[;[;I";T;0;6i;[; @ìÈo;= ;3I" overload;F;40;;î;50;)I"new(string);T;IC;";T; @ìÈ;>0;!F;[;[;I";T;0;6i;[[I"string;T0; @ìÈ;[;I") @overload new @overload new(string);T;0; @ìÈ;!F;"o;#;$T;%ir;⁢'@êÈ;(I"8static VALUE ossl_x509_initialize(int argc, VALUE *argv, VALUE self) { BIO *in; X509 *x509, *x = DATA_PTR(self); VALUE arg; if (rb_scan_args(argc, argv, "01", &arg) == 0) { /* create just empty X509Cert */ return self; } arg = ossl_to_der_if_possible(arg); in = ossl_obj2bio(&arg); x509 = PEM_read_bio_X509(in, &x, NULL, NULL); DATA_PTR(self) = x; if (!x509) { OSSL_BIO_reset(in); x509 = d2i_X509_bio(in, &x); DATA_PTR(self) = x; } BIO_free(in); if (!x509) ossl_raise(eX509CertError, NULL); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"/OpenSSL::X509::Certificate#initialize_copy;F;[[I" other;T0;[[@ÚÇiŒ;T;;g;0;[;{;IC;";T;[;[;@|;0; @ É;'@êÈ;(I"Hstatic VALUE ossl_x509_copy(VALUE self, VALUE other) { X509 *a, *b, *x509; rb_check_frozen(self); if (self == other) return self; GetX509(self, a); GetX509(other, b); x509 = X509_dup(b); if (!x509) ossl_raise(eX509CertError, NULL); DATA_PTR(self) = x509; X509_free(a); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::X509::Certificate#to_der;F;[;[[@ÚÇi¤;T;;°;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;°;50;)I"to_der;T;IC;";T; @É;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @É;[;I"@return [String];T;0;6i;[; @É;[;I") @overload to_der @return [String];T;0; @É;!F;"o;#;$T;%i ;&i¢;'@êÈ;(I"“static VALUE ossl_x509_to_der(VALUE self) { X509 *x509; VALUE str; long len; unsigned char *p; GetX509(self, x509); if ((len = i2d_X509(x509, NULL)) <= 0) ossl_raise(eX509CertError, NULL); str = rb_str_new(0, len); p = (unsigned char *)RSTRING_PTR(str); if (i2d_X509(x509, &p) <= 0) ossl_raise(eX509CertError, NULL); ossl_str_adjust(str, p); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::X509::Certificate#to_pem;F;[;[[@ÚÇi¼;T;:to_pem;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;³;50;)I"to_pem;T;IC;";T; @6É;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @6É;[;I"@return [String];T;0;6i;[; @6É;[;I") @overload to_pem @return [String];T;0; o;;F; ;;;;I"$OpenSSL::X509::Certificate#to_s;F;[;[[@ÚÇi5;F;;q;;K;[;{;@=É;'@êÈ;)I"static VALUE;T;(I"Ystatic VALUE ossl_x509_to_pem(VALUE self) { X509 *x509; BIO *out; VALUE str; GetX509(self, x509); out = BIO_new(BIO_s_mem()); if (!out) ossl_raise(eX509CertError, NULL); if (!PEM_write_bio_X509(out, x509)) { BIO_free(out); ossl_raise(eX509CertError, NULL); } str = ossl_membio2str(out); return str; };T;!F;"o;#;$T;%i¸;&iº;'@êÈ;(I"Ystatic VALUE ossl_x509_to_pem(VALUE self) { X509 *x509; BIO *out; VALUE str; GetX509(self, x509); out = BIO_new(BIO_s_mem()); if (!out) ossl_raise(eX509CertError, NULL); if (!PEM_write_bio_X509(out, x509)) { BIO_free(out); ossl_raise(eX509CertError, NULL); } str = ossl_membio2str(out); return str; };T;)@UÉ;*T@NÉo;;F; ;;;;I"'OpenSSL::X509::Certificate#to_text;F;[;[[@ÚÇiÔ;T;:to_text;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;´;50;)I"to_text;T;IC;";T; @YÉ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @YÉ;[;I"@return [String];T;0;6i;[; @YÉ;[;I"* @overload to_text @return [String];T;0; @YÉ;!F;"o;#;$T;%iÐ;&iÒ;'@êÈ;(I"Sstatic VALUE ossl_x509_to_text(VALUE self) { X509 *x509; BIO *out; VALUE str; GetX509(self, x509); out = BIO_new(BIO_s_mem()); if (!out) ossl_raise(eX509CertError, NULL); if (!X509_print(out, x509)) { BIO_free(out); ossl_raise(eX509CertError, NULL); } str = ossl_membio2str(out); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::X509::Certificate#version;F;[;[[@ÚÇi;T;:version;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;µ;50;)I"version;T;IC;";T; @tÉ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @tÉ;[;I"@return [Integer];T;0;6i;[; @tÉ;[;I"+ @overload version @return [Integer];T;0; @tÉ;!F;"o;#;$T;%iÿ;&i;'@êÈ;(I"Šstatic VALUE ossl_x509_get_version(VALUE self) { X509 *x509; GetX509(self, x509); return LONG2NUM(X509_get_version(x509)); };T;)I"static VALUE;T;*To;;F; ;;;;I"(OpenSSL::X509::Certificate#version=;F;[[I"version;T0;[[@ÚÇi;T;: version=;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;¶;50;)I"version=(integer);T;IC;";T; @É;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @É;[;I"@return [Integer];T;0;6i;[[I"integer;T0; @É;[;I"5 @overload version=(integer) @return [Integer];T;0; @É;!F;"o;#;$T;%i ;&i;'@êÈ;(I"Dstatic VALUE ossl_x509_set_version(VALUE self, VALUE version) { X509 *x509; long ver; if ((ver = NUM2LONG(version)) < 0) { ossl_raise(eX509CertError, "version must be >= 0!"); } GetX509(self, x509); if (!X509_set_version(x509, ver)) { ossl_raise(eX509CertError, NULL); } return version; };T;)I"static VALUE;T;*To;;F; ;;;;I"3OpenSSL::X509::Certificate#signature_algorithm;F;[;[[@ÚÇiC;T;:signature_algorithm;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;·;50;)I"signature_algorithm;T;IC;";T; @®É;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @®É;[;I"@return [String];T;0;6i;[; @®É;[;I"6 @overload signature_algorithm @return [String];T;0; @®É;!F;"o;#;$T;%i?;&iA;'@êÈ;(I"ˆstatic VALUE ossl_x509_get_signature_algorithm(VALUE self) { X509 *x509; BIO *out; VALUE str; GetX509(self, x509); out = BIO_new(BIO_s_mem()); if (!out) ossl_raise(eX509CertError, NULL); if (!i2a_ASN1_OBJECT(out, X509_get0_tbs_sigalg(x509)->algorithm)) { BIO_free(out); ossl_raise(eX509CertError, NULL); } str = ossl_membio2str(out); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::X509::Certificate#serial;F;[;[[@ÚÇi&;T;:serial;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;¸;50;)I"serial;T;IC;";T; @ÉÉ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ÉÉ;[;I"@return [Integer];T;0;6i;[; @ÉÉ;[;I"* @overload serial @return [Integer];T;0; @ÉÉ;!F;"o;#;$T;%i";&i$;'@êÈ;(I"˜static VALUE ossl_x509_get_serial(VALUE self) { X509 *x509; GetX509(self, x509); return asn1integer_to_num(X509_get_serialNumber(x509)); };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::X509::Certificate#serial=;F;[[I"num;T0;[[@ÚÇi4;T;:serial=;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;¹;50;)I"serial=(integer);T;IC;";T; @äÉ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @äÉ;[;I"@return [Integer];T;0;6i;[[I"integer;T0; @äÉ;[;I"4 @overload serial=(integer) @return [Integer];T;0; @äÉ;!F;"o;#;$T;%i0;&i2;'@êÈ;(I"Îstatic VALUE ossl_x509_set_serial(VALUE self, VALUE num) { X509 *x509; GetX509(self, x509); X509_set_serialNumber(x509, num_to_asn1integer(num, X509_get_serialNumber(x509))); return num; };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::X509::Certificate#subject;F;[;[[@ÚÇi[;T;:subject;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;º;50;)I"subject;T;IC;";T; @Ê;>0;!F;[;[;I";T;0;6i;[; @Ê;[;I" @overload subject;T;0; @Ê;!F;"o;#;$T;%iW;&iX;'@êÈ;(I"static VALUE ossl_x509_get_subject(VALUE self) { X509 *x509; X509_NAME *name; GetX509(self, x509); if (!(name = X509_get_subject_name(x509))) { /* NO DUP - don't free! */ ossl_raise(eX509CertError, NULL); } return ossl_x509name_new(name); };T;)I"static VALUE;T;*To;;F; ;;;;I"(OpenSSL::X509::Certificate#subject=;F;[[I"subject;T0;[[@ÚÇim;T;: subject=;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;»;50;)I"subject=(name);T;IC;";T; @Ê;>0;!F;[;[;I";T;0;6i;[[I" name;T0; @Ê;[;I" @overload subject=(name);T;0; @Ê;!F;"o;#;$T;%ii;&ij;'@êÈ;(I"ústatic VALUE ossl_x509_set_subject(VALUE self, VALUE subject) { X509 *x509; GetX509(self, x509); if (!X509_set_subject_name(x509, GetX509NamePtr(subject))) { /* DUPs name */ ossl_raise(eX509CertError, NULL); } return subject; };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::X509::Certificate#issuer;F;[;[[@ÚÇi~;T;:issuer;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;¼;50;)I"issuer;T;IC;";T; @3Ê;>0;!F;[;[;I";T;0;6i;[; @3Ê;[;I" @overload issuer;T;0; @3Ê;!F;"o;#;$T;%iz;&i{;'@êÈ;(I"static VALUE ossl_x509_get_issuer(VALUE self) { X509 *x509; X509_NAME *name; GetX509(self, x509); if(!(name = X509_get_issuer_name(x509))) { /* NO DUP - don't free! */ ossl_raise(eX509CertError, NULL); } return ossl_x509name_new(name); };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::X509::Certificate#issuer=;F;[[I"issuer;T0;[[@ÚÇi;T;:issuer=;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;½;50;)I"issuer=(name);T;IC;";T; @IÊ;>0;!F;[;[;I";T;0;6i;[[I" name;T0; @IÊ;[;I" @overload issuer=(name);T;0; @IÊ;!F;"o;#;$T;%iŒ;&i;'@êÈ;(I"õstatic VALUE ossl_x509_set_issuer(VALUE self, VALUE issuer) { X509 *x509; GetX509(self, x509); if (!X509_set_issuer_name(x509, GetX509NamePtr(issuer))) { /* DUPs name */ ossl_raise(eX509CertError, NULL); } return issuer; };T;)I"static VALUE;T;*To;;F; ;;;;I"*OpenSSL::X509::Certificate#not_before;F;[;[[@ÚÇi¡;T;:not_before;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;¾;50;)I"not_before;T;IC;";T; @cÊ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Time;T; @cÊ;[;I"@return [Time];T;0;6i;[; @cÊ;[;I"+ @overload not_before @return [Time];T;0; @cÊ;!F;"o;#;$T;%i;&iŸ;'@êÈ;(I"static VALUE ossl_x509_get_not_before(VALUE self) { X509 *x509; const ASN1_TIME *asn1time; GetX509(self, x509); if (!(asn1time = X509_get0_notBefore(x509))) { ossl_raise(eX509CertError, NULL); } return asn1time_to_time(asn1time); };T;)I"static VALUE;T;*To;;F; ;;;;I"+OpenSSL::X509::Certificate#not_before=;F;[[I" time;T0;[[@ÚÇi³;T;:not_before=;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;¿;50;)I"not_before=(time);T;IC;";T; @~Ê;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Time;T; @~Ê;[;I"@return [Time];T;0;6i;[[I" time;T0; @~Ê;[;I"2 @overload not_before=(time) @return [Time];T;0; @~Ê;!F;"o;#;$T;%i¯;&i±;'@êÈ;(I"jstatic VALUE ossl_x509_set_not_before(VALUE self, VALUE time) { X509 *x509; ASN1_TIME *asn1time; GetX509(self, x509); asn1time = ossl_x509_time_adjust(NULL, time); if (!X509_set1_notBefore(x509, asn1time)) { ASN1_TIME_free(asn1time); ossl_raise(eX509CertError, "X509_set_notBefore"); } ASN1_TIME_free(asn1time); return time; };T;)I"static VALUE;T;*To;;F; ;;;;I")OpenSSL::X509::Certificate#not_after;F;[;[[@ÚÇiÈ;T;:not_after;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;À;50;)I"not_after;T;IC;";T; @Ê;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Time;T; @Ê;[;I"@return [Time];T;0;6i;[; @Ê;[;I"* @overload not_after @return [Time];T;0; @Ê;!F;"o;#;$T;%iÄ;&iÆ;'@êÈ;(I"static VALUE ossl_x509_get_not_after(VALUE self) { X509 *x509; const ASN1_TIME *asn1time; GetX509(self, x509); if (!(asn1time = X509_get0_notAfter(x509))) { ossl_raise(eX509CertError, NULL); } return asn1time_to_time(asn1time); };T;)I"static VALUE;T;*To;;F; ;;;;I"*OpenSSL::X509::Certificate#not_after=;F;[[I" time;T0;[[@ÚÇiÚ;T;:not_after=;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;Á;50;)I"not_after=(time);T;IC;";T; @¸Ê;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Time;T; @¸Ê;[;I"@return [Time];T;0;6i;[[I" time;T0; @¸Ê;[;I"1 @overload not_after=(time) @return [Time];T;0; @¸Ê;!F;"o;#;$T;%iÖ;&iØ;'@êÈ;(I"gstatic VALUE ossl_x509_set_not_after(VALUE self, VALUE time) { X509 *x509; ASN1_TIME *asn1time; GetX509(self, x509); asn1time = ossl_x509_time_adjust(NULL, time); if (!X509_set1_notAfter(x509, asn1time)) { ASN1_TIME_free(asn1time); ossl_raise(eX509CertError, "X509_set_notAfter"); } ASN1_TIME_free(asn1time); return time; };T;)I"static VALUE;T;*To;;F; ;;;;I"*OpenSSL::X509::Certificate#public_key;F;[;[[@ÚÇiï;T;:public_key;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;Â;50;)I"public_key;T;IC;";T; @×Ê;>0;!F;[;[;I";T;0;6i;[; @×Ê;[;I" @overload public_key;T;0; @×Ê;!F;"o;#;$T;%ië;&iì;'@êÈ;(I"static VALUE ossl_x509_get_public_key(VALUE self) { X509 *x509; EVP_PKEY *pkey; GetX509(self, x509); if (!(pkey = X509_get_pubkey(x509))) { /* adds an reference */ ossl_raise(eX509CertError, NULL); } return ossl_pkey_new(pkey); /* NO DUP - OK */ };T;)I"static VALUE;T;*To;;F; ;;;;I"+OpenSSL::X509::Certificate#public_key=;F;[[I"key;T0;[[@ÚÇi;T;:public_key=;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;Ã;50;)I"public_key=(key);T;IC;";T; @íÊ;>0;!F;[;[;I";T;0;6i;[[I"key;T0; @íÊ;[;I" @overload public_key=(key);T;0; @íÊ;!F;"o;#;$T;%iý;&iþ;'@êÈ;(I"&static VALUE ossl_x509_set_public_key(VALUE self, VALUE key) { X509 *x509; EVP_PKEY *pkey; GetX509(self, x509); pkey = GetPKeyPtr(key); ossl_pkey_check_public_key(pkey); if (!X509_set_pubkey(x509, pkey)) ossl_raise(eX509CertError, "X509_set_pubkey"); return key; };T;)I"static VALUE;T;*To;;F; ;;;;I"$OpenSSL::X509::Certificate#sign;F;[[I"key;T0[I"digest;T0;[[@ÚÇi;T;: sign;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;Ä;50;)I"sign(key, digest);T;IC;";T; @Ë;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @Ë;[;I"@return [self];T;0;6i;[[I"key;T0[I"digest;T0; @Ë;[;I"2 @overload sign(key, digest) @return [self];T;0; @Ë;!F;"o;#;$T;%i;&i;'@êÈ;(I"Zstatic VALUE ossl_x509_sign(VALUE self, VALUE key, VALUE digest) { X509 *x509; EVP_PKEY *pkey; const EVP_MD *md; pkey = GetPrivPKeyPtr(key); /* NO NEED TO DUP */ md = ossl_evp_get_digestbyname(digest); GetX509(self, x509); if (!X509_sign(x509, pkey, md)) { ossl_raise(eX509CertError, NULL); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::X509::Certificate#verify;F;[[I"key;T0;[[@ÚÇi+;T;:verify;0;[;{;IC;"vVerifies the signature of the certificate, with the public key _key_. _key_ must be an instance of OpenSSL::PKey. ;T;[o;= ;3I" overload;F;40;;Å;50;)I"verify(key);T;IC;";T; @*Ë;>0;!F;[;[;I";T;0;6i;[[I"key;T0; @*Ë;[;I"‰Verifies the signature of the certificate, with the public key _key_. _key_ must be an instance of OpenSSL::PKey. @overload verify(key);T;0; @*Ë;!F;"o;#;$T;%i$;&i(;'@êÈ;(I"gstatic VALUE ossl_x509_verify(VALUE self, VALUE key) { X509 *x509; EVP_PKEY *pkey; GetX509(self, x509); pkey = GetPKeyPtr(key); ossl_pkey_check_public_key(pkey); switch (X509_verify(x509, pkey)) { case 1: return Qtrue; case 0: ossl_clear_error(); return Qfalse; default: ossl_raise(eX509CertError, NULL); } };T;)I"static VALUE;T;*To;;F; ;;;;I"1OpenSSL::X509::Certificate#check_private_key;F;[[I"key;T0;[[@ÚÇiF;T;:check_private_key;0;[;{;IC;"wReturns +true+ if _key_ is the corresponding private key to the Subject Public Key Information, +false+ otherwise. ;T;[o;= ;3I" overload;F;40;;Æ;50;)I"check_private_key(key);T;IC;";T; @DË;>0;!F;[;[;I";T;0;6i;[[I"key;T0; @DË;[;I"•Returns +true+ if _key_ is the corresponding private key to the Subject Public Key Information, +false+ otherwise. @overload check_private_key(key);T;0; @DË;!F;"o;#;$T;%i?;&iC;'@êÈ;(I"Sstatic VALUE ossl_x509_check_private_key(VALUE self, VALUE key) { X509 *x509; EVP_PKEY *pkey; /* not needed private key, but should be */ pkey = GetPrivPKeyPtr(key); /* NO NEED TO DUP */ GetX509(self, x509); if (!X509_check_private_key(x509, pkey)) { ossl_clear_error(); return Qfalse; } return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"*OpenSSL::X509::Certificate#extensions;F;[;[[@ÚÇi[;T;:extensions;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;Ç;50;)I"extensions;T;IC;";T; @^Ë;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @^Ë;[;I"@return [Array];T;0;6i;[; @^Ë;[;I", @overload extensions @return [Array];T;0; @^Ë;!F;"o;#;$T;%iW;&iY;'@êÈ;(I"¦static VALUE ossl_x509_get_extensions(VALUE self) { X509 *x509; int count, i; X509_EXTENSION *ext; VALUE ary; GetX509(self, x509); count = X509_get_ext_count(x509); if (count < 0) { return rb_ary_new(); } ary = rb_ary_new2(count); for (i=0; i0;!F;[;[;I";T;0;6i;[[I"extension;T0; @‰Ë;[;I"( @overload add_extension(extension);T;0; @‰Ë;!F;"o;#;$T;%iŽ;&i;'@êÈ;(I"-static VALUE ossl_x509_add_extension(VALUE self, VALUE extension) { X509 *x509; X509_EXTENSION *ext; GetX509(self, x509); ext = GetX509ExtPtr(extension); if (!X509_add_ext(x509, ext, -1)) { /* DUPs ext - FREE it */ ossl_raise(eX509CertError, NULL); } return extension; };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::X509::Certificate#inspect;F;[;[[@ÚÇi¡;T;;r;0;[;{;IC;";T;[;[;@|;0; @£Ë;'@êÈ;(I"¼static VALUE ossl_x509_inspect(VALUE self) { return rb_sprintf("#<%"PRIsVALUE": subject=%+"PRIsVALUE", " "issuer=%+"PRIsVALUE", serial=%+"PRIsVALUE", " "not_before=%+"PRIsVALUE", not_after=%+"PRIsVALUE">", rb_obj_class(self), ossl_x509_get_subject(self), ossl_x509_get_issuer(self), ossl_x509_get_serial(self), ossl_x509_get_not_before(self), ossl_x509_get_not_after(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::X509::Certificate#==;F;[[I" other;T0;[[@ÚÇi¶;T;;`;0;[;{;IC;"|Compares the two certificates. Note that this takes into account all fields, not just the issuer name and the serial number. ;T;[o;= ;3I" overload;F;40;;`;50;)I"==(cert2);T;IC;";T; @¯Ë;>0;!F;[;[;I";T;0;6i;[[I" cert2;T0; @¯Ë;[;I"’Compares the two certificates. Note that this takes into account all fields, not just the issuer name and the serial number. @overload ==(cert2);T;0; @¯Ë;!F;"o;#;$T;%i¯;&i³;'@êÈ;(I"ástatic VALUE ossl_x509_eq(VALUE self, VALUE other) { X509 *a, *b; GetX509(self, a); if (!rb_obj_is_kind_of(other, cX509Cert)) return Qfalse; GetX509(other, b); return !X509_cmp(a, b) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*T;A@êÈ;BIC;[;A@êÈ;CIC;[;A@êÈ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@NÉ;³;I[;[[@ÚÇiÑ[@ÚÇi-;T;:Certificate;;K;;;[;{;IC;"_Implementation of an X.509 certificate as specified in RFC 5280. Provides access to a certificate's attributes and allows certificates to be read from a string, but also supports the creation of new certificates from scratch. === Reading a certificate from a file Certificate is capable of handling DER-encoded certificates and certificates encoded in OpenSSL's PEM format. raw = File.read "cert.cer" # DER- or PEM-encoded certificate = OpenSSL::X509::Certificate.new raw === Saving a certificate to a file A certificate may be encoded in DER format cert = ... File.open("cert.cer", "wb") { |f| f.print cert.to_der } or in PEM format cert = ... File.open("cert.pem", "wb") { |f| f.print cert.to_pem } X.509 certificates are associated with a private/public key pair, typically a RSA, DSA or ECC key (see also OpenSSL::PKey::RSA, OpenSSL::PKey::DSA and OpenSSL::PKey::EC), the public key itself is stored within the certificate and can be accessed in form of an OpenSSL::PKey. Certificates are typically used to be able to associate some form of identity with a key pair, for example web servers serving pages over HTTPs use certificates to authenticate themselves to the user. The public key infrastructure (PKI) model relies on trusted certificate authorities ("root CAs") that issue these certificates, so that end users need to base their trust just on a selected few authorities that themselves again vouch for subordinate CAs issuing their certificates to end users. The OpenSSL::X509 module provides the tools to set up an independent PKI, similar to scenarios where the 'openssl' command line tool is used for issuing certificates in a private PKI. === Creating a root CA certificate and an end-entity certificate First, we need to create a "self-signed" root certificate. To do so, we need to generate a key first. Please note that the choice of "1" as a serial number is considered a security flaw for real certificates. Secure choices are integers in the two-digit byte range and ideally not sequential but secure random numbers, steps omitted here to keep the example concise. root_key = OpenSSL::PKey::RSA.new 2048 # the CA's public/private key root_ca = OpenSSL::X509::Certificate.new root_ca.version = 2 # cf. RFC 5280 - to make it a "v3" certificate root_ca.serial = 1 root_ca.subject = OpenSSL::X509::Name.parse "/DC=org/DC=ruby-lang/CN=Ruby CA" root_ca.issuer = root_ca.subject # root CA's are "self-signed" root_ca.public_key = root_key.public_key root_ca.not_before = Time.now root_ca.not_after = root_ca.not_before + 2 * 365 * 24 * 60 * 60 # 2 years validity ef = OpenSSL::X509::ExtensionFactory.new ef.subject_certificate = root_ca ef.issuer_certificate = root_ca root_ca.add_extension(ef.create_extension("basicConstraints","CA:TRUE",true)) root_ca.add_extension(ef.create_extension("keyUsage","keyCertSign, cRLSign", true)) root_ca.add_extension(ef.create_extension("subjectKeyIdentifier","hash",false)) root_ca.add_extension(ef.create_extension("authorityKeyIdentifier","keyid:always",false)) root_ca.sign(root_key, OpenSSL::Digest.new('SHA256')) The next step is to create the end-entity certificate using the root CA certificate. key = OpenSSL::PKey::RSA.new 2048 cert = OpenSSL::X509::Certificate.new cert.version = 2 cert.serial = 2 cert.subject = OpenSSL::X509::Name.parse "/DC=org/DC=ruby-lang/CN=Ruby certificate" cert.issuer = root_ca.subject # root CA is the issuer cert.public_key = key.public_key cert.not_before = Time.now cert.not_after = cert.not_before + 1 * 365 * 24 * 60 * 60 # 1 years validity ef = OpenSSL::X509::ExtensionFactory.new ef.subject_certificate = cert ef.issuer_certificate = root_ca cert.add_extension(ef.create_extension("keyUsage","digitalSignature", true)) cert.add_extension(ef.create_extension("subjectKeyIdentifier","hash",false)) cert.sign(root_key, OpenSSL::Digest.new('SHA256')) ;T;[;[;I"b Implementation of an X.509 certificate as specified in RFC 5280. Provides access to a certificate's attributes and allows certificates to be read from a string, but also supports the creation of new certificates from scratch. === Reading a certificate from a file Certificate is capable of handling DER-encoded certificates and certificates encoded in OpenSSL's PEM format. raw = File.read "cert.cer" # DER- or PEM-encoded certificate = OpenSSL::X509::Certificate.new raw === Saving a certificate to a file A certificate may be encoded in DER format cert = ... File.open("cert.cer", "wb") { |f| f.print cert.to_der } or in PEM format cert = ... File.open("cert.pem", "wb") { |f| f.print cert.to_pem } X.509 certificates are associated with a private/public key pair, typically a RSA, DSA or ECC key (see also OpenSSL::PKey::RSA, OpenSSL::PKey::DSA and OpenSSL::PKey::EC), the public key itself is stored within the certificate and can be accessed in form of an OpenSSL::PKey. Certificates are typically used to be able to associate some form of identity with a key pair, for example web servers serving pages over HTTPs use certificates to authenticate themselves to the user. The public key infrastructure (PKI) model relies on trusted certificate authorities ("root CAs") that issue these certificates, so that end users need to base their trust just on a selected few authorities that themselves again vouch for subordinate CAs issuing their certificates to end users. The OpenSSL::X509 module provides the tools to set up an independent PKI, similar to scenarios where the 'openssl' command line tool is used for issuing certificates in a private PKI. === Creating a root CA certificate and an end-entity certificate First, we need to create a "self-signed" root certificate. To do so, we need to generate a key first. Please note that the choice of "1" as a serial number is considered a security flaw for real certificates. Secure choices are integers in the two-digit byte range and ideally not sequential but secure random numbers, steps omitted here to keep the example concise. root_key = OpenSSL::PKey::RSA.new 2048 # the CA's public/private key root_ca = OpenSSL::X509::Certificate.new root_ca.version = 2 # cf. RFC 5280 - to make it a "v3" certificate root_ca.serial = 1 root_ca.subject = OpenSSL::X509::Name.parse "/DC=org/DC=ruby-lang/CN=Ruby CA" root_ca.issuer = root_ca.subject # root CA's are "self-signed" root_ca.public_key = root_key.public_key root_ca.not_before = Time.now root_ca.not_after = root_ca.not_before + 2 * 365 * 24 * 60 * 60 # 2 years validity ef = OpenSSL::X509::ExtensionFactory.new ef.subject_certificate = root_ca ef.issuer_certificate = root_ca root_ca.add_extension(ef.create_extension("basicConstraints","CA:TRUE",true)) root_ca.add_extension(ef.create_extension("keyUsage","keyCertSign, cRLSign", true)) root_ca.add_extension(ef.create_extension("subjectKeyIdentifier","hash",false)) root_ca.add_extension(ef.create_extension("authorityKeyIdentifier","keyid:always",false)) root_ca.sign(root_key, OpenSSL::Digest.new('SHA256')) The next step is to create the end-entity certificate using the root CA certificate. key = OpenSSL::PKey::RSA.new 2048 cert = OpenSSL::X509::Certificate.new cert.version = 2 cert.serial = 2 cert.subject = OpenSSL::X509::Name.parse "/DC=org/DC=ruby-lang/CN=Ruby certificate" cert.issuer = root_ca.subject # root CA is the issuer cert.public_key = key.public_key cert.not_before = Time.now cert.not_after = cert.not_before + 1 * 365 * 24 * 60 * 60 # 1 years validity ef = OpenSSL::X509::ExtensionFactory.new ef.subject_certificate = cert ef.issuer_certificate = root_ca cert.add_extension(ef.create_extension("keyUsage","digitalSignature", true)) cert.add_extension(ef.create_extension("subjectKeyIdentifier","hash",false)) cert.sign(root_key, OpenSSL::Digest.new('SHA256')) ;T;0; @êÈ;!F;"o;#;$T;%iÑ;&i+;'@ È;I"OpenSSL::X509::Certificate;F;S@]o; ;IC;[;A@ÛË;BIC;[;A@ÛË;CIC;[;A@ÛË;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@àÇiÌ;F;:ExtensionError;;K;;;[;{;IC;";T;[;[;@|;0; @ÛË;'@ È;I""OpenSSL::X509::ExtensionError;F;S@ÅÇo; ;IC;[o;;F; ;;;;I"/OpenSSL::X509::ExtensionFactory#initialize;F;[[@c0;[[@àÇi®;T;;Ð;0;[;{;IC;";T;[;[;@|;0; @îË;'@ìË;(I"wstatic VALUE ossl_x509extfactory_initialize(int argc, VALUE *argv, VALUE self) { /*X509V3_CTX *ctx;*/ VALUE issuer_cert, subject_cert, subject_req, crl; /*GetX509ExtFactory(self, ctx);*/ rb_scan_args(argc, argv, "04", &issuer_cert, &subject_cert, &subject_req, &crl); if (!NIL_P(issuer_cert)) ossl_x509extfactory_set_issuer_cert(self, issuer_cert); if (!NIL_P(subject_cert)) ossl_x509extfactory_set_subject_cert(self, subject_cert); if (!NIL_P(subject_req)) ossl_x509extfactory_set_subject_req(self, subject_req); if (!NIL_P(crl)) ossl_x509extfactory_set_crl(self, crl); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"8OpenSSL::X509::ExtensionFactory#issuer_certificate=;F;[[I" cert;T0;[[@àÇi~;T;:issuer_certificate=;0;[;{;IC;";T;[;[;@|;0; @ûË;'@ìË;(I" static VALUE ossl_x509extfactory_set_issuer_cert(VALUE self, VALUE cert) { X509V3_CTX *ctx; GetX509ExtFactory(self, ctx); rb_iv_set(self, "@issuer_certificate", cert); ctx->issuer_cert = GetX509CertPtr(cert); /* NO DUP NEEDED */ return cert; };T;)I"static VALUE;T;*To;;F; ;;;;I"9OpenSSL::X509::ExtensionFactory#subject_certificate=;F;[[I" cert;T0;[[@àÇiŠ;T;:subject_certificate=;0;[;{;IC;";T;[;[;@|;0; @ Ì;'@ìË;(I"static VALUE ossl_x509extfactory_set_subject_cert(VALUE self, VALUE cert) { X509V3_CTX *ctx; GetX509ExtFactory(self, ctx); rb_iv_set(self, "@subject_certificate", cert); ctx->subject_cert = GetX509CertPtr(cert); /* NO DUP NEEDED */ return cert; };T;)I"static VALUE;T;*To;;F; ;;;;I"5OpenSSL::X509::ExtensionFactory#subject_request=;F;[[I"req;T0;[[@àÇi–;T;:subject_request=;0;[;{;IC;";T;[;[;@|;0; @Ì;'@ìË;(I"static VALUE ossl_x509extfactory_set_subject_req(VALUE self, VALUE req) { X509V3_CTX *ctx; GetX509ExtFactory(self, ctx); rb_iv_set(self, "@subject_request", req); ctx->subject_req = GetX509ReqPtr(req); /* NO DUP NEEDED */ return req; };T;)I"static VALUE;T;*To;;F; ;;;;I")OpenSSL::X509::ExtensionFactory#crl=;F;[[I"crl;T0;[[@àÇi¢;T;: crl=;0;[;{;IC;";T;[;[;@|;0; @%Ì;'@ìË;(I"åstatic VALUE ossl_x509extfactory_set_crl(VALUE self, VALUE crl) { X509V3_CTX *ctx; GetX509ExtFactory(self, ctx); rb_iv_set(self, "@crl", crl); ctx->crl = GetX509CRLPtr(crl); /* NO DUP NEEDED */ return crl; };T;)I"static VALUE;T;*To;;F; ;;;;I"/OpenSSL::X509::ExtensionFactory#create_ext;F;[[@c0;[[@àÇiË;T;:create_ext;0;[;{;IC;"QCreates a new X509::Extension with passed values. See also x509v3_config(5). ;T;[o;= ;3I" overload;F;40;;Ð;50;)I"4create_ext(ln_or_sn, "value", critical = false);T;IC;";T; @3Ì;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"X509::Extension;T; @3Ì;[;I"@return [X509::Extension];T;0;6i;[[I" ln_or_sn;T0[""value"0[I" critical;TI" false;T; @3Ìo;= ;3I" overload;F;40;;Ð;50;)I"+create_ext(ln_or_sn, "critical,value");T;IC;";T; @3Ì;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"X509::Extension;T; @3Ì;[;I"@return [X509::Extension];T;0;6i;[[I" ln_or_sn;T0[""critical,value"0; @3Ì;[;I"ñCreates a new X509::Extension with passed values. See also x509v3_config(5). @overload create_ext(ln_or_sn, "value", critical = false) @return [X509::Extension] @overload create_ext(ln_or_sn, "critical,value") @return [X509::Extension];T;0; @3Ì;!F;"o;#;$T;%iÄ;&iÊ;'@ìË;(I"Zstatic VALUE ossl_x509extfactory_create_ext(int argc, VALUE *argv, VALUE self) { X509V3_CTX *ctx; X509_EXTENSION *ext; VALUE oid, value, critical, valstr, obj; int nid; VALUE rconf; CONF *conf; rb_scan_args(argc, argv, "21", &oid, &value, &critical); StringValueCStr(oid); StringValue(value); if(NIL_P(critical)) critical = Qfalse; nid = OBJ_ln2nid(RSTRING_PTR(oid)); if(!nid) nid = OBJ_sn2nid(RSTRING_PTR(oid)); if(!nid) ossl_raise(eX509ExtError, "unknown OID `%"PRIsVALUE"'", oid); valstr = rb_str_new2(RTEST(critical) ? "critical," : ""); rb_str_append(valstr, value); StringValueCStr(valstr); GetX509ExtFactory(self, ctx); obj = NewX509Ext(cX509Ext); rconf = rb_iv_get(self, "@config"); conf = NIL_P(rconf) ? NULL : DupConfigPtr(rconf); X509V3_set_nconf(ctx, conf); ext = X509V3_EXT_nconf_nid(conf, ctx, nid, RSTRING_PTR(valstr)); X509V3_set_ctx_nodb(ctx); NCONF_free(conf); if (!ext){ ossl_raise(eX509ExtError, "%"PRIsVALUE" = %"PRIsVALUE, oid, valstr); } SetX509Ext(obj, ext); return obj; };T;)I"static VALUE;T;*T;A@ìË;BIC;[;A@ìË;CIC;[;A@ìË;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@àÇiÎ;F;:ExtensionFactory;;K;;;[;{;IC;";T;[;[;@|;0; @ìË;6i;'@ È;I"$OpenSSL::X509::ExtensionFactory;F;S@]o; ;IC;[o;;F; ;;;;I"(OpenSSL::X509::Extension#initialize;F;[[@c0;[[@àÇi;T;;Ð;0;[;{;IC;"áCreates an X509 extension. The extension may be created from _der_ data or from an extension _oid_ and _value_. The _oid_ may be either an OID or an extension name. If _critical_ is +true+ the extension is marked critical. ;T;[o;= ;3I" overload;F;40;:!OpenSSL::X509::Extension.new;50;)I"&OpenSSL::X509::Extension.new(der);T;IC;";T; @xÌ;>0;!F;[;[;I";T;0;6i;[[I"der;T0; @xÌo;= ;3I" overload;F;40;;Ò;50;)I"-OpenSSL::X509::Extension.new(oid, value);T;IC;";T; @xÌ;>0;!F;[;[;I";T;0;6i;[[I"oid;T0[I" value;T0; @xÌo;= ;3I" overload;F;40;;Ò;50;)I"7OpenSSL::X509::Extension.new(oid, value, critical);T;IC;";T; @xÌ;>0;!F;[;[;I";T;0;6i;[[I"oid;T0[I" value;T0[I" critical;T0; @xÌ;[;I"Creates an X509 extension. The extension may be created from _der_ data or from an extension _oid_ and _value_. The _oid_ may be either an OID or an extension name. If _critical_ is +true+ the extension is marked critical. @overload OpenSSL::X509::Extension.new(der) @overload OpenSSL::X509::Extension.new(oid, value) @overload OpenSSL::X509::Extension.new(oid, value, critical);T;0; @xÌ;!F;"o;#;$T;%i;&i ;'@vÌ;(I"´static VALUE ossl_x509ext_initialize(int argc, VALUE *argv, VALUE self) { VALUE oid, value, critical; const unsigned char *p; X509_EXTENSION *ext, *x; GetX509Ext(self, ext); if(rb_scan_args(argc, argv, "12", &oid, &value, &critical) == 1){ oid = ossl_to_der_if_possible(oid); StringValue(oid); p = (unsigned char *)RSTRING_PTR(oid); x = d2i_X509_EXTENSION(&ext, &p, RSTRING_LEN(oid)); DATA_PTR(self) = ext; if(!x) ossl_raise(eX509ExtError, NULL); return self; } rb_funcall(self, rb_intern("oid="), 1, oid); rb_funcall(self, rb_intern("value="), 1, value); if(argc > 2) rb_funcall(self, rb_intern("critical="), 1, critical); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"-OpenSSL::X509::Extension#initialize_copy;F;[[I" other;T0;[[@àÇi);T;;g;0;[;{;IC;";T;[;[;@|;0; @«Ì;'@vÌ;(I"static VALUE ossl_x509ext_initialize_copy(VALUE self, VALUE other) { X509_EXTENSION *ext, *ext_other, *ext_new; rb_check_frozen(self); GetX509Ext(self, ext); GetX509Ext(other, ext_other); ext_new = X509_EXTENSION_dup(ext_other); if (!ext_new) ossl_raise(eX509ExtError, "X509_EXTENSION_dup"); SetX509Ext(self, ext_new); X509_EXTENSION_free(ext); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::X509::Extension#oid=;F;[[I"oid;T0;[[@àÇi<;T;;;0;[;{;IC;";T;[;[;@|;0; @¹Ì;'@vÌ;(I"£static VALUE ossl_x509ext_set_oid(VALUE self, VALUE oid) { X509_EXTENSION *ext; ASN1_OBJECT *obj; GetX509Ext(self, ext); obj = OBJ_txt2obj(StringValueCStr(oid), 0); if (!obj) ossl_raise(eX509ExtError, "OBJ_txt2obj"); if (!X509_EXTENSION_set_object(ext, obj)) { ASN1_OBJECT_free(obj); ossl_raise(eX509ExtError, "X509_EXTENSION_set_object"); } ASN1_OBJECT_free(obj); return oid; };T;)I"static VALUE;T;*To;;F; ;;;;I"$OpenSSL::X509::Extension#value=;F;[[I" data;T0;[[@àÇiO;T;;¯;0;[;{;IC;";T;[;[;@|;0; @ÇÌ;'@vÌ;(I"¸static VALUE ossl_x509ext_set_value(VALUE self, VALUE data) { X509_EXTENSION *ext; ASN1_OCTET_STRING *asn1s; GetX509Ext(self, ext); data = ossl_to_der_if_possible(data); StringValue(data); asn1s = X509_EXTENSION_get_data(ext); if (!ASN1_OCTET_STRING_set(asn1s, (unsigned char *)RSTRING_PTR(data), RSTRING_LENINT(data))) { ossl_raise(eX509ExtError, "ASN1_OCTET_STRING_set"); } return data; };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::X509::Extension#critical=;F;[[I" flag;T0;[[@àÇib;T;:critical=;0;[;{;IC;";T;[;[;@|;0; @ÕÌ;'@vÌ;(I"Ästatic VALUE ossl_x509ext_set_critical(VALUE self, VALUE flag) { X509_EXTENSION *ext; GetX509Ext(self, ext); X509_EXTENSION_set_critical(ext, RTEST(flag) ? 1 : 0); return flag; };T;)I"static VALUE;T;*To;;F; ;;;;I"!OpenSSL::X509::Extension#oid;F;[;[[@àÇim;T;;®;0;[;{;IC;";T;[;[;@|;0; @ãÌ;'@vÌ;(I"Òstatic VALUE ossl_x509ext_get_oid(VALUE obj) { X509_EXTENSION *ext; ASN1_OBJECT *extobj; BIO *out; VALUE ret; int nid; GetX509Ext(obj, ext); extobj = X509_EXTENSION_get_object(ext); if ((nid = OBJ_obj2nid(extobj)) != NID_undef) ret = rb_str_new2(OBJ_nid2sn(nid)); else{ if (!(out = BIO_new(BIO_s_mem()))) ossl_raise(eX509ExtError, NULL); i2a_ASN1_OBJECT(out, extobj); ret = ossl_membio2str(out); } return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::X509::Extension#value;F;[;[[@àÇi„;T;;¾;0;[;{;IC;";T;[;[;@|;0; @ïÌ;'@vÌ;(I"nstatic VALUE ossl_x509ext_get_value(VALUE obj) { X509_EXTENSION *ext; BIO *out; VALUE ret; GetX509Ext(obj, ext); if (!(out = BIO_new(BIO_s_mem()))) ossl_raise(eX509ExtError, NULL); if (!X509V3_EXT_print(out, ext, 0, 0)) ASN1_STRING_print(out, (ASN1_STRING *)X509_EXTENSION_get_data(ext)); ret = ossl_membio2str(out); return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::X509::Extension#value_der;F;[;[[@àÇi•;T;:value_der;0;[;{;IC;";T;[;[;@|;0; @ûÌ;'@vÌ;(I"$static VALUE ossl_x509ext_get_value_der(VALUE obj) { X509_EXTENSION *ext; ASN1_OCTET_STRING *value; GetX509Ext(obj, ext); if ((value = X509_EXTENSION_get_data(ext)) == NULL) ossl_raise(eX509ExtError, NULL); return rb_str_new((const char *)value->data, value->length); };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::X509::Extension#critical?;F;[;[[@àÇi¢;T;:critical?;0;[;{;IC;";T;[o;2 ;3I"return;F;4@|;0;5[@~; @Í;[;@|;0; @Í;6i;'@vÌ;(I"§static VALUE ossl_x509ext_get_critical(VALUE obj) { X509_EXTENSION *ext; GetX509Ext(obj, ext); return X509_EXTENSION_get_critical(ext) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"$OpenSSL::X509::Extension#to_der;F;[;[[@àÇi«;T;;°;0;[;{;IC;";T;[;[;@|;0; @Í;'@vÌ;(I"¬static VALUE ossl_x509ext_to_der(VALUE obj) { X509_EXTENSION *ext; unsigned char *p; long len; VALUE str; GetX509Ext(obj, ext); if((len = i2d_X509_EXTENSION(ext, NULL)) <= 0) ossl_raise(eX509ExtError, NULL); str = rb_str_new(0, len); p = (unsigned char *)RSTRING_PTR(str); if(i2d_X509_EXTENSION(ext, &p) < 0) ossl_raise(eX509ExtError, NULL); ossl_str_adjust(str, p); return str; };T;)I"static VALUE;T;*T;A@vÌ;BIC;[;A@vÌ;CIC;[;A@vÌ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@àÇiß;F;:Extension;;K;;;[;{;IC;";T;[;[;@|;0; @vÌ;6i;'@ È;I"OpenSSL::X509::Extension;F;S@]o; ;IC;[o;;F; ;;;;I"#OpenSSL::X509::Name#initialize;F;[[@c0;[[@èÇi‘;T;;Ð;0;[;{;IC;"oCreates a new Name. A name may be created from a DER encoded string _der_, an Array representing a _distinguished_name_ or a _distinguished_name_ along with a _template_. name = OpenSSL::X509::Name.new [['CN', 'nobody'], ['DC', 'example']] name = OpenSSL::X509::Name.new name.to_der See add_entry for a description of the _distinguished_name_ Array's contents ;T;[ o;= ;3I" overload;F;40;:X509::Name.new;50;)I"X509::Name.new;T;IC;";T; @3Í;>0;!F;[;[;I";T;0;6i;[; @3Ío;= ;3I" overload;F;40;;×;50;)I"X509::Name.new(der);T;IC;";T; @3Í;>0;!F;[;[;I";T;0;6i;[[I"der;T0; @3Ío;= ;3I" overload;F;40;;×;50;)I"'X509::Name.new(distinguished_name);T;IC;";T; @3Í;>0;!F;[;[;I";T;0;6i;[[I"distinguished_name;T0; @3Ío;= ;3I" overload;F;40;;×;50;)I"1X509::Name.new(distinguished_name, template);T;IC;";T; @3Í;>0;!F;[;[;I";T;0;6i;[[I"distinguished_name;T0[I" template;T0; @3Í;[;I"Creates a new Name. A name may be created from a DER encoded string _der_, an Array representing a _distinguished_name_ or a _distinguished_name_ along with a _template_. name = OpenSSL::X509::Name.new [['CN', 'nobody'], ['DC', 'example']] name = OpenSSL::X509::Name.new name.to_der See add_entry for a description of the _distinguished_name_ Array's contents @overload X509::Name.new @overload X509::Name.new(der) @overload X509::Name.new(distinguished_name) @overload X509::Name.new(distinguished_name, template);T;0; @3Í;!F;"o;#;$T;%i};&iŽ;'@1Í;(I"Gstatic VALUE ossl_x509name_initialize(int argc, VALUE *argv, VALUE self) { X509_NAME *name; VALUE arg, template; GetX509Name(self, name); if (rb_scan_args(argc, argv, "02", &arg, &template) == 0) { return self; } else { VALUE tmp = rb_check_array_type(arg); if (!NIL_P(tmp)) { VALUE args; if(NIL_P(template)) template = OBJECT_TYPE_TEMPLATE; args = rb_ary_new3(2, self, template); rb_block_call(tmp, rb_intern("each"), 0, 0, ossl_x509name_init_i, args); } else{ const unsigned char *p; VALUE str = ossl_to_der_if_possible(arg); X509_NAME *x; StringValue(str); p = (unsigned char *)RSTRING_PTR(str); x = d2i_X509_NAME(&name, &p, RSTRING_LEN(str)); DATA_PTR(self) = name; if(!x){ ossl_raise(eX509NameError, NULL); } } } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"(OpenSSL::X509::Name#initialize_copy;F;[[I" other;T0;[[@èÇi´;T;;g;0;[;{;IC;";T;[;[;@|;0; @jÍ;'@1Í;(I"‹static VALUE ossl_x509name_initialize_copy(VALUE self, VALUE other) { X509_NAME *name, *name_other, *name_new; rb_check_frozen(self); GetX509Name(self, name); GetX509Name(other, name_other); name_new = X509_NAME_dup(name_other); if (!name_new) ossl_raise(eX509NameError, "X509_NAME_dup"); SetX509Name(self, name_new); X509_NAME_free(name); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::X509::Name#add_entry;F;[[@c0;[[@èÇiÚ;T;:add_entry;0;[;{;IC;" Adds a new entry with the given _oid_ and _value_ to this name. The _oid_ is an object identifier defined in ASN.1. Some common OIDs are: C:: Country Name CN:: Common Name DC:: Domain Component O:: Organization Name OU:: Organizational Unit Name ST:: State or Province Name The optional keyword parameters _loc_ and _set_ specify where to insert the new attribute. Refer to the manpage of X509_NAME_add_entry(3) for details. _loc_ defaults to -1 and _set_ defaults to 0. This appends a single-valued RDN to the end. ;T;[o;= ;3I" overload;F;40;;Ø;50;)I"4add_entry(oid, value [, type], loc: -1, set: 0);T;IC;";T; @xÍ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @xÍ;[;I"@return [self];T;0;6i;[ [I"oid;T0[I"value[, type];T0[I" loc:;TI"-1;T[I" set:;TI"0;T; @xÍ;[;I"VAdds a new entry with the given _oid_ and _value_ to this name. The _oid_ is an object identifier defined in ASN.1. Some common OIDs are: C:: Country Name CN:: Common Name DC:: Domain Component O:: Organization Name OU:: Organizational Unit Name ST:: State or Province Name The optional keyword parameters _loc_ and _set_ specify where to insert the new attribute. Refer to the manpage of X509_NAME_add_entry(3) for details. _loc_ defaults to -1 and _set_ defaults to 0. This appends a single-valued RDN to the end. @overload add_entry(oid, value [, type], loc: -1, set: 0) @return [self];T;0; @xÍ;!F;"o;#;$T;%iÇ;&iØ;'@1Í;(I"µstatic VALUE ossl_x509name_add_entry(int argc, VALUE *argv, VALUE self) { X509_NAME *name; VALUE oid, value, type, opts, kwargs[2]; static ID kwargs_ids[2]; const char *oid_name; int loc = -1, set = 0; if (!kwargs_ids[0]) { kwargs_ids[0] = rb_intern_const("loc"); kwargs_ids[1] = rb_intern_const("set"); } rb_scan_args(argc, argv, "21:", &oid, &value, &type, &opts); rb_get_kwargs(opts, kwargs_ids, 0, 2, kwargs); oid_name = StringValueCStr(oid); StringValue(value); if(NIL_P(type)) type = rb_aref(OBJECT_TYPE_TEMPLATE, oid); if (kwargs[0] != Qundef) loc = NUM2INT(kwargs[0]); if (kwargs[1] != Qundef) set = NUM2INT(kwargs[1]); GetX509Name(self, name); if (!X509_NAME_add_entry_by_txt(name, oid_name, NUM2INT(type), (unsigned char *)RSTRING_PTR(value), RSTRING_LENINT(value), loc, set)) ossl_raise(eX509NameError, "X509_NAME_add_entry_by_txt"); return self; };T;)I"static;T;*To;;F; ;;;;I"OpenSSL::X509::Name#to_s;F;[[@c0;[[@èÇi(;T;;q;0;[;{;IC;" Returns a String representation of the Distinguished Name. _format_ is one of: * OpenSSL::X509::Name::COMPAT * OpenSSL::X509::Name::RFC2253 * OpenSSL::X509::Name::ONELINE * OpenSSL::X509::Name::MULTILINE If _format_ is omitted, the largely broken and traditional OpenSSL format is used. ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @žÍ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @žÍ;[;I"@return [String];T;0;6i;[; @žÍo;= ;3I" overload;F;40;;q;50;)I"to_s(format);T;IC;";T; @žÍ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @žÍ;[;I"@return [String];T;0;6i;[[I"format;T0; @žÍ;[;I"nReturns a String representation of the Distinguished Name. _format_ is one of: * OpenSSL::X509::Name::COMPAT * OpenSSL::X509::Name::RFC2253 * OpenSSL::X509::Name::ONELINE * OpenSSL::X509::Name::MULTILINE If _format_ is omitted, the largely broken and traditional OpenSSL format is used. @overload to_s @return [String] @overload to_s(format) @return [String];T;0; @žÍ;!F;"o;#;$T;%i;&i';'@1Í;(I" static VALUE ossl_x509name_to_s(int argc, VALUE *argv, VALUE self) { rb_check_arity(argc, 0, 1); /* name.to_s(nil) was allowed */ if (!argc || NIL_P(argv[0])) return ossl_x509name_to_s_old(self); else return x509name_print(self, NUM2ULONG(argv[0])); };T;)I"static VALUE;T;*To;;F; ;;;;I" OpenSSL::X509::Name#to_utf8;F;[;[[@èÇi:;T;:to_utf8;0;[;{;IC;"|Returns an UTF-8 representation of the distinguished name, as specified in {RFC 2253}[https://www.ietf.org/rfc/rfc2253.txt]. ;T;[o;= ;3I" overload;F;40;;Ù;50;)I"to_utf8;T;IC;";T; @ÉÍ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ÉÍ;[;I"@return [String];T;0;6i;[; @ÉÍ;[;I"£Returns an UTF-8 representation of the distinguished name, as specified in {RFC 2253}[https://www.ietf.org/rfc/rfc2253.txt]. @overload to_utf8 @return [String];T;0; @ÉÍ;!F;"o;#;$T;%i3;&i8;'@1Í;(I"Æstatic VALUE ossl_x509name_to_utf8(VALUE self) { VALUE str = x509name_print(self, XN_FLAG_RFC2253 & ~ASN1_STRFLGS_ESC_MSB); rb_enc_associate_index(str, rb_utf8_encindex()); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I" OpenSSL::X509::Name#inspect;F;[;[[@èÇiC;T;;r;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @äÍ;!F;"o;#;$T;%iB;&iB;'@1Í;(I"·static VALUE ossl_x509name_inspect(VALUE self) { return rb_enc_sprintf(rb_utf8_encoding(), "#<%"PRIsVALUE" %"PRIsVALUE">", rb_obj_class(self), ossl_x509name_to_utf8(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::X509::Name#to_a;F;[;[[@èÇiQ;T;;!;0;[;{;IC;"\Returns an Array representation of the distinguished name suitable for passing to ::new ;T;[o;= ;3I" overload;F;40;;!;50;)I" to_a;T;IC;";T; @òÍ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @òÍ;[;I"@return [Array];T;0;6i;[; @òÍ;[;I"Returns an Array representation of the distinguished name suitable for passing to ::new @overload to_a @return [Array];T;0; @òÍ;!F;"o;#;$T;%iJ;&iO;'@1Í;(I"static VALUE ossl_x509name_to_a(VALUE self) { X509_NAME *name; X509_NAME_ENTRY *entry; int i,entries,nid; char long_name[512]; const char *short_name; VALUE ary, vname, ret; ASN1_STRING *value; GetX509Name(self, name); entries = X509_NAME_entry_count(name); if (entries < 0) { OSSL_Debug("name entries < 0!"); return rb_ary_new(); } ret = rb_ary_new2(entries); for (i=0; itype)); rb_ary_push(ret, ary); } return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::X509::Name#cmp;F;[[I" other;T0;[[@èÇi;T;:cmp;0;[;{;IC;"ÐCompares this Name with _other_ and returns +0+ if they are the same and +-1+ or ++1+ if they are greater or less than each other respectively. Returns +nil+ if they are not comparable (i.e. different types). ;T;[o;= ;3I" overload;F;40;;Ú;50;)I"cmp(other);T;IC;";T; @ Î;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"-1 | 0 | 1 | nil;T; @ Î;[;I"@return [-1 | 0 | 1 | nil];T;0;6i;[[I" other;T0; @ Îo;= ;3I" overload;F;40;;c;50;)I"<=>(other);T;IC;";T; @ Î;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"-1 | 0 | 1 | nil;T; @ Î;[;I"@return [-1 | 0 | 1 | nil];T;0;6i;[[I" other;T0; @ Î;[;I"6Compares this Name with _other_ and returns +0+ if they are the same and +-1+ or ++1+ if they are greater or less than each other respectively. Returns +nil+ if they are not comparable (i.e. different types). @overload cmp(other) @return [-1 | 0 | 1 | nil] @overload <=>(other) @return [-1 | 0 | 1 | nil];T;0; o;;F; ;;;;I"OpenSSL::X509::Name#<=>;F;[;[[@èÇi;F;;c;;K;[;{;@Î;'@1Í;)I"static VALUE;T;(I"static VALUE ossl_x509name_cmp(VALUE self, VALUE other) { int result; if (!rb_obj_is_kind_of(other, cX509Name)) return Qnil; result = ossl_x509name_cmp0(self, other); if (result < 0) return INT2FIX(-1); if (result > 0) return INT2FIX(1); return INT2FIX(0); };T;!F;"o;#;$T;%i„;&iŒ;'@1Í;(I"static VALUE ossl_x509name_cmp(VALUE self, VALUE other) { int result; if (!rb_obj_is_kind_of(other, cX509Name)) return Qnil; result = ossl_x509name_cmp0(self, other); if (result < 0) return INT2FIX(-1); if (result > 0) return INT2FIX(1); return INT2FIX(0); };T;)@?Î;*T@8Îo;;F; ;;;;I"OpenSSL::X509::Name#eql?;F;[[I" other;T0;[[@èÇi¢;T;;_;0;[;{;IC;"CReturns true if _name_ and _other_ refer to the same hash key.;T;[o;= ;3I" overload;F;40;;_;50;)I"eql?(other);T;IC;";T; @CÎ;>0;!F;[;[;I";T;0;6i;[[I" other;T0; @CÎo;2 ;3I"return;F;4@|;0;5[@~; @CÎ;[;I"[Returns true if _name_ and _other_ refer to the same hash key. @overload eql?(other);T;0; @CÎ;!F;"o;#;$T;%iœ;&iŸ;6i;'@1Í;(I"¼static VALUE ossl_x509name_eql(VALUE self, VALUE other) { if (!rb_obj_is_kind_of(other, cX509Name)) return Qfalse; return ossl_x509name_cmp0(self, other) == 0 ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::X509::Name#hash;F;[;[[@èÇi²;T;;b;0;[;{;IC;"ZThe hash value returned is suitable for use as a certificate's filename in a CA path. ;T;[o;= ;3I" overload;F;40;;b;50;)I" hash;T;IC;";T; @`Î;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @`Î;[;I"@return [Integer];T;0;6i;[; @`Î;[;I"The hash value returned is suitable for use as a certificate's filename in a CA path. @overload hash @return [Integer];T;0; @`Î;!F;"o;#;$T;%i«;&i°;'@1Í;(I"¹static VALUE ossl_x509name_hash(VALUE self) { X509_NAME *name; unsigned long hash; GetX509Name(self, name); hash = X509_NAME_hash(name); return ULONG2NUM(hash); };T;)I"static VALUE;T;*To;;F; ;;;;I"!OpenSSL::X509::Name#hash_old;F;[;[[@èÇiÅ;T;: hash_old;0;[;{;IC;"5Returns an MD5 based hash used in OpenSSL 0.9.X. ;T;[o;= ;3I" overload;F;40;;Û;50;)I" hash_old;T;IC;";T; @{Î;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @{Î;[;I"@return [Integer];T;0;6i;[; @{Î;[;I"^Returns an MD5 based hash used in OpenSSL 0.9.X. @overload hash_old @return [Integer];T;0; @{Î;!F;"o;#;$T;%i¿;&iÃ;'@1Í;(I"Ástatic VALUE ossl_x509name_hash_old(VALUE self) { X509_NAME *name; unsigned long hash; GetX509Name(self, name); hash = X509_NAME_hash_old(name); return ULONG2NUM(hash); };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::X509::Name#to_der;F;[;[[@èÇiØ;T;;°;0;[;{;IC;"&Converts the name to DER encoding ;T;[o;= ;3I" overload;F;40;;°;50;)I"to_der;T;IC;";T; @–Î;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @–Î;[;I"@return [String];T;0;6i;[; @–Î;[;I"LConverts the name to DER encoding @overload to_der @return [String];T;0; @–Î;!F;"o;#;$T;%iÒ;&iÖ;'@1Í;(I"¨static VALUE ossl_x509name_to_der(VALUE self) { X509_NAME *name; VALUE str; long len; unsigned char *p; GetX509Name(self, name); if((len = i2d_X509_NAME(name, NULL)) <= 0) ossl_raise(eX509NameError, NULL); str = rb_str_new(0, len); p = (unsigned char *)RSTRING_PTR(str); if(i2d_X509_NAME(name, &p) <= 0) ossl_raise(eX509NameError, NULL); ossl_str_adjust(str, p); return str; };T;)I"static VALUE;T;*To;{;[[@èÇi";F;:DEFAULT_OBJECT_TYPE;;};;;[;{;IC;".The default object type for name entries. ;T;[;[;I"/The default object type for name entries. ;T;0; @±Î;!F;"o;#;$T;%i;&i ;'@1Í;I"-OpenSSL::X509::Name::DEFAULT_OBJECT_TYPE;F;~I"utf8str;To;{;[[@èÇi0;F;:OBJECT_TYPE_TEMPLATE;;};;;[;{;IC;"7The default object type template for name entries. ;T;[;[;I"8The default object type template for name entries. ;T;0; @½Î;!F;"o;#;$T;%i-;&i.;'@1Í;I".OpenSSL::X509::Name::OBJECT_TYPE_TEMPLATE;F;~I" hash;To;{;[[@èÇi8;F;:COMPAT;;};;;[;{;IC;"bA flag for #to_s. Breaks the name returned into multiple lines if longer than 80 characters. ;T;[;[;I"cA flag for #to_s. Breaks the name returned into multiple lines if longer than 80 characters. ;T;0; @ÉÎ;!F;"o;#;$T;%i2;&i6;'@1Í;I" OpenSSL::X509::Name::COMPAT;F;~I"ULONG2NUM(XN_FLAG_COMPAT);To;{;[[@èÇi?;F;:RFC2253;;};;;[;{;IC;"7A flag for #to_s. Returns an RFC2253 format name. ;T;[;[;I"8A flag for #to_s. Returns an RFC2253 format name. ;T;0; @ÕÎ;!F;"o;#;$T;%i:;&i=;'@1Í;I"!OpenSSL::X509::Name::RFC2253;F;~I"ULONG2NUM(XN_FLAG_RFC2253);To;{;[[@èÇiF;F;:ONELINE;;};;;[;{;IC;"DA flag for #to_s. Returns a more readable format than RFC2253. ;T;[;[;I"EA flag for #to_s. Returns a more readable format than RFC2253. ;T;0; @áÎ;!F;"o;#;$T;%iA;&iD;'@1Í;I"!OpenSSL::X509::Name::ONELINE;F;~I"ULONG2NUM(XN_FLAG_ONELINE);To;{;[[@èÇiM;F;;/;;};;;[;{;IC;"3A flag for #to_s. Returns a multiline format. ;T;[;[;I"4A flag for #to_s. Returns a multiline format. ;T;0; @íÎ;!F;"o;#;$T;%iH;&iK;'@1Í;I"#OpenSSL::X509::Name::MULTILINE;F;~I"!ULONG2NUM(XN_FLAG_MULTILINE);T;A@1Í;BIC;[;A@1Í;CIC;[@j‡;A@1Í;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@8Î;Ú;I[;[[@èÇiì[@èÇi;T;: Name;;K;;;[;{;IC;"VAn X.509 name represents a hostname, email address or other entity associated with a public key. You can create a Name by parsing a distinguished name String or by supplying the distinguished name as an Array. name = OpenSSL::X509::Name.parse '/CN=nobody/DC=example' name = OpenSSL::X509::Name.new [['CN', 'nobody'], ['DC', 'example']];T;[;[;I"X An X.509 name represents a hostname, email address or other entity associated with a public key. You can create a Name by parsing a distinguished name String or by supplying the distinguished name as an Array. name = OpenSSL::X509::Name.parse '/CN=nobody/DC=example' name = OpenSSL::X509::Name.new [['CN', 'nobody'], ['DC', 'example']] ;T;0; @1Í;!F;"o;#;$T;%iì;&iö;6i;'o;L;M@;NI"OpenSSL::X509;T;: X509;'@ÃÇ;Q@ È;O0;R0;I"OpenSSL::X509::Name;F;S@]o; ;IC;[;A@ Ï;BIC;[;A@ Ï;CIC;[;A@ Ï;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@èÇi;F;:NameError;;K;;;[;{;IC;";T;[;[;@|;0; @ Ï;'@ È;I"OpenSSL::X509::NameError;F;S@ÅÇo; ;IC;[;A@Ï;BIC;[;A@Ï;CIC;[;A@Ï;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@êÇi;F;: CRLError;;K;;;[;{;IC;";T;[;[;@|;0; @Ï;'@ È;I"OpenSSL::X509::CRLError;F;S@ÅÇo; ;IC;[o;;F; ;;;;I""OpenSSL::X509::CRL#initialize;F;[[@c0;[[@êÇia;T;;Ð;0;[;{;IC;";T;[;[;@|;0; @1Ï;'@/Ï;(I"static VALUE ossl_x509crl_initialize(int argc, VALUE *argv, VALUE self) { BIO *in; X509_CRL *crl, *x = DATA_PTR(self); VALUE arg; if (rb_scan_args(argc, argv, "01", &arg) == 0) { return self; } arg = ossl_to_der_if_possible(arg); in = ossl_obj2bio(&arg); crl = PEM_read_bio_X509_CRL(in, &x, NULL, NULL); DATA_PTR(self) = x; if (!crl) { OSSL_BIO_reset(in); crl = d2i_X509_CRL_bio(in, &x); DATA_PTR(self) = x; } BIO_free(in); if (!crl) ossl_raise(eX509CRLError, NULL); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::X509::CRL#initialize_copy;F;[[I" other;T0;[[@êÇiz;T;;g;0;[;{;IC;";T;[;[;@|;0; @>Ï;'@/Ï;(I"Wstatic VALUE ossl_x509crl_copy(VALUE self, VALUE other) { X509_CRL *a, *b, *crl; rb_check_frozen(self); if (self == other) return self; GetX509CRL(self, a); GetX509CRL(other, b); if (!(crl = X509_CRL_dup(b))) { ossl_raise(eX509CRLError, NULL); } X509_CRL_free(a); DATA_PTR(self) = crl; return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::X509::CRL#version;F;[;[[@êÇi‡;T;;µ;0;[;{;IC;";T;[;[;@|;0; @LÏ;'@/Ï;(I"²static VALUE ossl_x509crl_get_version(VALUE self) { X509_CRL *crl; long ver; GetX509CRL(self, crl); ver = X509_CRL_get_version(crl); return LONG2NUM(ver); };T;)I"static VALUE;T;*To;;F; ;;;;I" OpenSSL::X509::CRL#version=;F;[[I"version;T0;[[@êÇi“;T;;¶;0;[;{;IC;";T;[;[;@|;0; @XÏ;'@/Ï;(I"Mstatic VALUE ossl_x509crl_set_version(VALUE self, VALUE version) { X509_CRL *crl; long ver; if ((ver = NUM2LONG(version)) < 0) { ossl_raise(eX509CRLError, "version must be >= 0!"); } GetX509CRL(self, crl); if (!X509_CRL_set_version(crl, ver)) { ossl_raise(eX509CRLError, NULL); } return version; };T;)I"static VALUE;T;*To;;F; ;;;;I"+OpenSSL::X509::CRL#signature_algorithm;F;[;[[@êÇi¤;T;;·;0;[;{;IC;";T;[;[;@|;0; @fÏ;'@/Ï;(I"£static VALUE ossl_x509crl_get_signature_algorithm(VALUE self) { X509_CRL *crl; const X509_ALGOR *alg; BIO *out; GetX509CRL(self, crl); if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eX509CRLError, NULL); } X509_CRL_get0_signature(crl, NULL, &alg); if (!i2a_ASN1_OBJECT(out, alg->algorithm)) { BIO_free(out); ossl_raise(eX509CRLError, NULL); } return ossl_membio2str(out); };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::X509::CRL#issuer;F;[;[[@êÇi¸;T;;¼;0;[;{;IC;";T;[;[;@|;0; @rÏ;'@/Ï;(I"¶static VALUE ossl_x509crl_get_issuer(VALUE self) { X509_CRL *crl; GetX509CRL(self, crl); return ossl_x509name_new(X509_CRL_get_issuer(crl)); /* NO DUP - don't free */ };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::X509::CRL#issuer=;F;[[I"issuer;T0;[[@êÇiÂ;T;;½;0;[;{;IC;"NO DUP - don't free ;T;[;[;I"NO DUP - don't free;T;0; @~Ï;!F;"o;#;$T;%i¿;&i¿;'@/Ï;(I"ÿstatic VALUE ossl_x509crl_set_issuer(VALUE self, VALUE issuer) { X509_CRL *crl; GetX509CRL(self, crl); if (!X509_CRL_set_issuer_name(crl, GetX509NamePtr(issuer))) { /* DUPs name */ ossl_raise(eX509CRLError, NULL); } return issuer; };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::X509::CRL#last_update;F;[;[[@êÇiÏ;T;:last_update;0;[;{;IC;";T;[;[;@|;0; @ŽÏ;'@/Ï;(I"îstatic VALUE ossl_x509crl_get_last_update(VALUE self) { X509_CRL *crl; const ASN1_TIME *time; GetX509CRL(self, crl); time = X509_CRL_get0_lastUpdate(crl); if (!time) return Qnil; return asn1time_to_time(time); };T;)I"static VALUE;T;*To;;F; ;;;;I"$OpenSSL::X509::CRL#last_update=;F;[[I" time;T0;[[@êÇiÝ;T;:last_update=;0;[;{;IC;";T;[;[;@|;0; @šÏ;'@/Ï;(I"{static VALUE ossl_x509crl_set_last_update(VALUE self, VALUE time) { X509_CRL *crl; ASN1_TIME *asn1time; GetX509CRL(self, crl); asn1time = ossl_x509_time_adjust(NULL, time); if (!X509_CRL_set1_lastUpdate(crl, asn1time)) { ASN1_TIME_free(asn1time); ossl_raise(eX509CRLError, "X509_CRL_set_lastUpdate"); } ASN1_TIME_free(asn1time); return time; };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::X509::CRL#next_update;F;[;[[@êÇiî;T;:next_update;0;[;{;IC;";T;[;[;@|;0; @¨Ï;'@/Ï;(I"îstatic VALUE ossl_x509crl_get_next_update(VALUE self) { X509_CRL *crl; const ASN1_TIME *time; GetX509CRL(self, crl); time = X509_CRL_get0_nextUpdate(crl); if (!time) return Qnil; return asn1time_to_time(time); };T;)I"static VALUE;T;*To;;F; ;;;;I"$OpenSSL::X509::CRL#next_update=;F;[[I" time;T0;[[@êÇiü;T;:next_update=;0;[;{;IC;";T;[;[;@|;0; @´Ï;'@/Ï;(I"{static VALUE ossl_x509crl_set_next_update(VALUE self, VALUE time) { X509_CRL *crl; ASN1_TIME *asn1time; GetX509CRL(self, crl); asn1time = ossl_x509_time_adjust(NULL, time); if (!X509_CRL_set1_nextUpdate(crl, asn1time)) { ASN1_TIME_free(asn1time); ossl_raise(eX509CRLError, "X509_CRL_set_nextUpdate"); } ASN1_TIME_free(asn1time); return time; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::X509::CRL#revoked;F;[;[[@êÇi ;T;:revoked;0;[;{;IC;";T;[;[;@|;0; @ÂÏ;'@/Ï;(I"static VALUE ossl_x509crl_get_revoked(VALUE self) { X509_CRL *crl; int i, num; X509_REVOKED *rev; VALUE ary, revoked; GetX509CRL(self, crl); num = sk_X509_REVOKED_num(X509_CRL_get_REVOKED(crl)); if (num < 0) { OSSL_Debug("num < 0???"); return rb_ary_new(); } ary = rb_ary_new2(num); for(i=0; istatic VALUE ossl_x509crl_to_text(VALUE self) { X509_CRL *crl; BIO *out; GetX509CRL(self, crl); if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eX509CRLError, NULL); } if (!X509_CRL_print(out, crl)) { BIO_free(out); ossl_raise(eX509CRLError, NULL); } return ossl_membio2str(out); };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::X509::CRL#extensions;F;[;[[@êÇi³;T;;Ç;0;[;{;IC;"7Gets X509v3 extensions as array of X509Ext objects ;T;[;[;I"8Gets X509v3 extensions as array of X509Ext objects ;T;0; @4Ð;!F;"o;#;$T;%i°;&i±;'@/Ï;(I"Ñstatic VALUE ossl_x509crl_get_extensions(VALUE self) { X509_CRL *crl; int count, i; X509_EXTENSION *ext; VALUE ary; GetX509CRL(self, crl); count = X509_CRL_get_ext_count(crl); if (count < 0) { OSSL_Debug("count < 0???"); return rb_ary_new(); } ary = rb_ary_new2(count); for (i=0; istatic VALUE ossl_x509req_to_text(VALUE self) { X509_REQ *req; BIO *out; GetX509Req(self, req); if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eX509ReqError, NULL); } if (!X509_REQ_print(out, req)) { BIO_free(out); ossl_raise(eX509ReqError, NULL); } return ossl_membio2str(out); };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::X509::Request#version;F;[;[[@òÇiÅ;T;;µ;0;[;{;IC;";T;[;[;@|;0; @ÉÐ;'@€Ð;(I"¾static VALUE ossl_x509req_get_version(VALUE self) { X509_REQ *req; long version; GetX509Req(self, req); version = X509_REQ_get_version(req); return LONG2NUM(version); };T;)I"static VALUE;T;*To;;F; ;;;;I"$OpenSSL::X509::Request#version=;F;[[I"version;T0;[[@òÇiÑ;T;;¶;0;[;{;IC;";T;[;[;@|;0; @ÕÐ;'@€Ð;(I"_static VALUE ossl_x509req_set_version(VALUE self, VALUE version) { X509_REQ *req; long ver; if ((ver = NUM2LONG(version)) < 0) { ossl_raise(eX509ReqError, "version must be >= 0!"); } GetX509Req(self, req); if (!X509_REQ_set_version(req, ver)) { ossl_raise(eX509ReqError, "X509_REQ_set_version"); } return version; };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::X509::Request#subject;F;[;[[@òÇiâ;T;;º;0;[;{;IC;";T;[;[;@|;0; @ãÐ;'@€Ð;(I"static VALUE ossl_x509req_get_subject(VALUE self) { X509_REQ *req; X509_NAME *name; GetX509Req(self, req); if (!(name = X509_REQ_get_subject_name(req))) { /* NO DUP - don't free */ ossl_raise(eX509ReqError, NULL); } return ossl_x509name_new(name); };T;)I"static VALUE;T;*To;;F; ;;;;I"$OpenSSL::X509::Request#subject=;F;[[I"subject;T0;[[@òÇið;T;;»;0;[;{;IC;";T;[;[;@|;0; @ïÐ;'@€Ð;(I"static VALUE ossl_x509req_set_subject(VALUE self, VALUE subject) { X509_REQ *req; GetX509Req(self, req); /* DUPs name */ if (!X509_REQ_set_subject_name(req, GetX509NamePtr(subject))) { ossl_raise(eX509ReqError, NULL); } return subject; };T;)I"static VALUE;T;*To;;F; ;;;;I"/OpenSSL::X509::Request#signature_algorithm;F;[;[[@òÇiþ;T;;·;0;[;{;IC;";T;[;[;@|;0; @ýÐ;'@€Ð;(I"¤static VALUE ossl_x509req_get_signature_algorithm(VALUE self) { X509_REQ *req; const X509_ALGOR *alg; BIO *out; GetX509Req(self, req); if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eX509ReqError, NULL); } X509_REQ_get0_signature(req, NULL, &alg); if (!i2a_ASN1_OBJECT(out, alg->algorithm)) { BIO_free(out); ossl_raise(eX509ReqError, NULL); } return ossl_membio2str(out); };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::X509::Request#public_key;F;[;[[@òÇi;T;;Â;0;[;{;IC;";T;[;[;@|;0; @ Ñ;'@€Ð;(I"static VALUE ossl_x509req_get_public_key(VALUE self) { X509_REQ *req; EVP_PKEY *pkey; GetX509Req(self, req); if (!(pkey = X509_REQ_get_pubkey(req))) { /* adds reference */ ossl_raise(eX509ReqError, NULL); } return ossl_pkey_new(pkey); /* NO DUP - OK */ };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::X509::Request#public_key=;F;[[I"key;T0;[[@òÇi!;T;;Ã;0;[;{;IC;"NO DUP - OK ;T;[;[;I"NO DUP - OK;T;0; @Ñ;!F;"o;#;$T;%i;&i;'@€Ð;(I"4static VALUE ossl_x509req_set_public_key(VALUE self, VALUE key) { X509_REQ *req; EVP_PKEY *pkey; GetX509Req(self, req); pkey = GetPKeyPtr(key); ossl_pkey_check_public_key(pkey); if (!X509_REQ_set_pubkey(req, pkey)) ossl_raise(eX509ReqError, "X509_REQ_set_pubkey"); return key; };T;)I"static VALUE;T;*To;;F; ;;;;I" OpenSSL::X509::Request#sign;F;[[I"key;T0[I"digest;T0;[[@òÇi/;T;;Ä;0;[;{;IC;";T;[;[;@|;0; @%Ñ;'@€Ð;(I"dstatic VALUE ossl_x509req_sign(VALUE self, VALUE key, VALUE digest) { X509_REQ *req; EVP_PKEY *pkey; const EVP_MD *md; GetX509Req(self, req); pkey = GetPrivPKeyPtr(key); /* NO NEED TO DUP */ md = ossl_evp_get_digestbyname(digest); if (!X509_REQ_sign(req, pkey, md)) { ossl_raise(eX509ReqError, NULL); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::X509::Request#verify;F;[[I"key;T0;[[@òÇiC;T;;Å;0;[;{;IC;"MChecks that cert signature is made with PRIVversion of this PUBLIC 'key' ;T;[;[;I"NChecks that cert signature is made with PRIVversion of this PUBLIC 'key' ;T;0; @5Ñ;!F;"o;#;$T;%i@;&iA;'@€Ð;(I"qstatic VALUE ossl_x509req_verify(VALUE self, VALUE key) { X509_REQ *req; EVP_PKEY *pkey; GetX509Req(self, req); pkey = GetPKeyPtr(key); ossl_pkey_check_public_key(pkey); switch (X509_REQ_verify(req, pkey)) { case 1: return Qtrue; case 0: ossl_clear_error(); return Qfalse; default: ossl_raise(eX509ReqError, NULL); } };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::X509::Request#attributes;F;[;[[@òÇiW;T;:attributes;0;[;{;IC;";T;[;[;@|;0; @EÑ;'@€Ð;(I"½static VALUE ossl_x509req_get_attributes(VALUE self) { X509_REQ *req; int count, i; X509_ATTRIBUTE *attr; VALUE ary; GetX509Req(self, req); count = X509_REQ_get_attr_count(req); if (count < 0) { OSSL_Debug("count < 0???"); return rb_ary_new(); } ary = rb_ary_new2(count); for (i=0; i0;!F;[;[;I";T;0;6i;[; @Ñ;[;I";Creates a new X509::Store. @overload X509::Store.new;T;0; @Ñ;!F;"o;#;$T;%i¿;&iÂ;'@Ñ;(I"Žstatic VALUE ossl_x509store_initialize(int argc, VALUE *argv, VALUE self) { X509_STORE *store; /* BUG: This method takes any number of arguments but appears to ignore them. */ GetX509Store(self, store); #if !defined(HAVE_OPAQUE_OPENSSL) /* [Bug #405] [Bug #1678] [Bug #3000]; already fixed? */ store->ex_data.sk = NULL; #endif X509_STORE_set_verify_cb(store, x509store_verify_cb); ossl_x509store_set_vfy_cb(self, Qnil); /* last verification status */ rb_iv_set(self, "@error", Qnil); rb_iv_set(self, "@error_string", Qnil); rb_iv_set(self, "@chain", Qnil); rb_iv_set(self, "@time", Qnil); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"*OpenSSL::X509::Store#verify_callback=;F;[[I"cb;T0;[[@øÇi²;T;:verify_callback=;0;[;{;IC;"(General callback for OpenSSL verify ;T;[;[;I")General callback for OpenSSL verify ;T;0; @¦Ñ;!F;"o;#;$T;%i¯;&i°;'@Ñ;(I"ûstatic VALUE ossl_x509store_set_vfy_cb(VALUE self, VALUE cb) { X509_STORE *store; GetX509Store(self, store); X509_STORE_set_ex_data(store, store_ex_verify_cb_idx, (void *)cb); rb_iv_set(self, "@verify_callback", cb); return cb; };T;)I"static VALUE;T;*To;;F; ;;;;I" OpenSSL::X509::Store#flags=;F;[[I" flags;T0;[[@øÇiã;T;:flags=;0;[;{;IC;"Sets _flags_ to the Store. _flags_ consists of zero or more of the constants defined in with name V_FLAG_* or'ed together. ;T;[o;= ;3I" overload;F;40;;õ;50;)I"flags=(flags);T;IC;";T; @¶Ñ;>0;!F;[;[;I";T;0;6i;[[I" flags;T0; @¶Ñ;[;I"”Sets _flags_ to the Store. _flags_ consists of zero or more of the constants defined in with name V_FLAG_* or'ed together. @overload flags=(flags);T;0; @¶Ñ;!F;"o;#;$T;%iÜ;&ià;'@Ñ;(I"Îstatic VALUE ossl_x509store_set_flags(VALUE self, VALUE flags) { X509_STORE *store; long f = NUM2LONG(flags); GetX509Store(self, store); X509_STORE_set_flags(store, f); return flags; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::X509::Store#purpose=;F;[[I"purpose;T0;[[@øÇi;T;: purpose=;0;[;{;IC;"ÅSets the store's purpose to _purpose_. If specified, the verifications on the store will check every untrusted certificate's extensions are consistent with the purpose. The purpose is specified by constants: * X509::PURPOSE_SSL_CLIENT * X509::PURPOSE_SSL_SERVER * X509::PURPOSE_NS_SSL_SERVER * X509::PURPOSE_SMIME_SIGN * X509::PURPOSE_SMIME_ENCRYPT * X509::PURPOSE_CRL_SIGN * X509::PURPOSE_ANY * X509::PURPOSE_OCSP_HELPER * X509::PURPOSE_TIMESTAMP_SIGN ;T;[o;= ;3I" overload;F;40;;ö;50;)I"purpose=(purpose);T;IC;";T; @ÐÑ;>0;!F;[;[;I";T;0;6i;[[I"purpose;T0; @ÐÑ;[;I"ãSets the store's purpose to _purpose_. If specified, the verifications on the store will check every untrusted certificate's extensions are consistent with the purpose. The purpose is specified by constants: * X509::PURPOSE_SSL_CLIENT * X509::PURPOSE_SSL_SERVER * X509::PURPOSE_NS_SSL_SERVER * X509::PURPOSE_SMIME_SIGN * X509::PURPOSE_SMIME_ENCRYPT * X509::PURPOSE_CRL_SIGN * X509::PURPOSE_ANY * X509::PURPOSE_OCSP_HELPER * X509::PURPOSE_TIMESTAMP_SIGN @overload purpose=(purpose);T;0; @ÐÑ;!F;"o;#;$T;%iï;&iþ;'@Ñ;(I"Östatic VALUE ossl_x509store_set_purpose(VALUE self, VALUE purpose) { X509_STORE *store; int p = NUM2INT(purpose); GetX509Store(self, store); X509_STORE_set_purpose(store, p); return purpose; };T;)I"static VALUE;T;*To;;F; ;;;;I" OpenSSL::X509::Store#trust=;F;[[I" trust;T0;[[@øÇi;T;:trust=;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;÷;50;)I"trust=(trust);T;IC;";T; @êÑ;>0;!F;[;[;I";T;0;6i;[[I" trust;T0; @êÑ;[;I" @overload trust=(trust);T;0; @êÑ;!F;"o;#;$T;%i ;&i;'@Ñ;(I"Ìstatic VALUE ossl_x509store_set_trust(VALUE self, VALUE trust) { X509_STORE *store; int t = NUM2INT(trust); GetX509Store(self, store); X509_STORE_set_trust(store, t); return trust; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::X509::Store#time=;F;[[I" time;T0;[[@øÇi#;T;: time=;0;[;{;IC;"/Sets the time to be used in verifications. ;T;[o;= ;3I" overload;F;40;;ø;50;)I"time=(time);T;IC;";T; @Ò;>0;!F;[;[;I";T;0;6i;[[I" time;T0; @Ò;[;I"GSets the time to be used in verifications. @overload time=(time);T;0; @Ò;!F;"o;#;$T;%i;&i ;'@Ñ;(I"zstatic VALUE ossl_x509store_set_time(VALUE self, VALUE time) { rb_iv_set(self, "@time", time); return time; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::X509::Store#add_path;F;[[I"dir;T0;[[@øÇiU;T;: add_path;0;[;{;IC;">Adds _path_ as the hash dir to be looked up by the store. ;T;[o;= ;3I" overload;F;40;;ù;50;)I"add_path(path);T;IC;";T; @Ò;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @Ò;[;I"@return [self];T;0;6i;[[I" path;T0; @Ò;[;I"jAdds _path_ as the hash dir to be looked up by the store. @overload add_path(path) @return [self];T;0; @Ò;!F;"o;#;$T;%iO;&iS;'@Ñ;(I"âstatic VALUE ossl_x509store_add_path(VALUE self, VALUE dir) { X509_STORE *store; X509_LOOKUP *lookup; char *path = NULL; if(dir != Qnil){ path = StringValueCStr(dir); } GetX509Store(self, store); lookup = X509_STORE_add_lookup(store, X509_LOOKUP_hash_dir()); if(lookup == NULL) ossl_raise(eX509StoreError, NULL); if(X509_LOOKUP_add_dir(lookup, path, X509_FILETYPE_PEM) != 1){ ossl_raise(eX509StoreError, NULL); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::X509::Store#add_file;F;[[I" file;T0;[[@øÇi2;T;: add_file;0;[;{;IC;"Adds the certificates in _file_ to the certificate store. _file_ is the path to the file, and the file contains one or more certificates in PEM format concatenated together. ;T;[o;= ;3I" overload;F;40;;ú;50;)I"add_file(file);T;IC;";T; @=Ò;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @=Ò;[;I"@return [self];T;0;6i;[[I" file;T0; @=Ò;[;I"ÙAdds the certificates in _file_ to the certificate store. _file_ is the path to the file, and the file contains one or more certificates in PEM format concatenated together. @overload add_file(file) @return [self];T;0; @=Ò;!F;"o;#;$T;%i*;&i0;'@Ñ;(I"‰static VALUE ossl_x509store_add_file(VALUE self, VALUE file) { X509_STORE *store; X509_LOOKUP *lookup; char *path = NULL; if(file != Qnil){ path = StringValueCStr(file); } GetX509Store(self, store); lookup = X509_STORE_add_lookup(store, X509_LOOKUP_file()); if(lookup == NULL) ossl_raise(eX509StoreError, NULL); if(X509_LOOKUP_load_file(lookup, path, X509_FILETYPE_PEM) != 1){ ossl_raise(eX509StoreError, NULL); } #if OPENSSL_VERSION_NUMBER < 0x10101000 || defined(LIBRESSL_VERSION_NUMBER) /* * X509_load_cert_crl_file() which is called from X509_LOOKUP_load_file() * did not check the return value of X509_STORE_add_{cert,crl}(), leaking * "cert already in hash table" errors on the error queue, if duplicate * certificates are found. This will be fixed by OpenSSL 1.1.1. */ ossl_clear_error(); #endif return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"+OpenSSL::X509::Store#set_default_paths;F;[;[[@øÇit;T;:set_default_paths;0;[;{;IC;"æConfigures _store_ to look up CA certificates from the system default certificate store as needed basis. The location of the store can usually be determined by: * OpenSSL::X509::DEFAULT_CERT_FILE * OpenSSL::X509::DEFAULT_CERT_DIR ;T;[o;= ;3I" overload;F;40;;û;50;)I"set_default_paths;T;IC;";T; @\Ò;>0;!F;[;[;I";T;0;6i;[; @\Ò;[;I"Configures _store_ to look up CA certificates from the system default certificate store as needed basis. The location of the store can usually be determined by: * OpenSSL::X509::DEFAULT_CERT_FILE * OpenSSL::X509::DEFAULT_CERT_DIR @overload set_default_paths;T;0; @\Ò;!F;"o;#;$T;%ii;&iq;'@Ñ;(I"êstatic VALUE ossl_x509store_set_default_paths(VALUE self) { X509_STORE *store; GetX509Store(self, store); if (X509_STORE_set_default_paths(store) != 1){ ossl_raise(eX509StoreError, NULL); } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::X509::Store#add_cert;F;[[I"arg;T0;[[@øÇi‡;T;: add_cert;0;[;{;IC;"IAdds the OpenSSL::X509::Certificate _cert_ to the certificate store. ;T;[o;= ;3I" overload;F;40;;ü;50;)I"add_cert(cert);T;IC;";T; @rÒ;>0;!F;[;[;I";T;0;6i;[[I" cert;T0; @rÒ;[;I"dAdds the OpenSSL::X509::Certificate _cert_ to the certificate store. @overload add_cert(cert);T;0; @rÒ;!F;"o;#;$T;%i;&i„;'@Ñ;(I".static VALUE ossl_x509store_add_cert(VALUE self, VALUE arg) { X509_STORE *store; X509 *cert; cert = GetX509CertPtr(arg); /* NO NEED TO DUP */ GetX509Store(self, store); if (X509_STORE_add_cert(store, cert) != 1){ ossl_raise(eX509StoreError, NULL); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"!OpenSSL::X509::Store#add_crl;F;[[I"arg;T0;[[@øÇiœ;T;:add_crl;0;[;{;IC;"4Adds the OpenSSL::X509::CRL _crl_ to the store. ;T;[o;= ;3I" overload;F;40;;ý;50;)I"add_crl(crl);T;IC;";T; @ŒÒ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @ŒÒ;[;I"@return [self];T;0;6i;[[I"crl;T0; @ŒÒ;[;I"^Adds the OpenSSL::X509::CRL _crl_ to the store. @overload add_crl(crl) @return [self];T;0; @ŒÒ;!F;"o;#;$T;%i–;&iš;'@Ñ;(I",static VALUE ossl_x509store_add_crl(VALUE self, VALUE arg) { X509_STORE *store; X509_CRL *crl; crl = GetX509CRLPtr(arg); /* NO NEED TO DUP */ GetX509Store(self, store); if (X509_STORE_add_crl(store, crl) != 1){ ossl_raise(eX509StoreError, NULL); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I" OpenSSL::X509::Store#verify;F;[[@c0;[[@øÇi¾;T;;Å;0;[;{;IC;"¬Performs a certificate verification on the OpenSSL::X509::Certificate _cert_. _chain_ can be an array of OpenSSL::X509::Certificate that is used to construct the certificate chain. If a block is given, it overrides the callback set by #verify_callback=. After finishing the verification, the error information can be retrieved by #error, #error_string, and the resulting complete certificate chain can be retrieved by #chain. ;T;[o;= ;3I" overload;F;40;;Å;50;)I"verify(cert, chain = nil);T;IC;";T; @«Ò;>0;!F;[;[;I";T;0;6i;[[I" cert;T0[I" chain;TI"nil;T; @«Ò;[;I"ÒPerforms a certificate verification on the OpenSSL::X509::Certificate _cert_. _chain_ can be an array of OpenSSL::X509::Certificate that is used to construct the certificate chain. If a block is given, it overrides the callback set by #verify_callback=. After finishing the verification, the error information can be retrieved by #error, #error_string, and the resulting complete certificate chain can be retrieved by #chain. @overload verify(cert, chain = nil);T;0; @«Ò;!F;"o;#;$T;%i¯;&i»;'@Ñ;(I"›static VALUE ossl_x509store_verify(int argc, VALUE *argv, VALUE self) { VALUE cert, chain; VALUE ctx, proc, result; rb_scan_args(argc, argv, "11", &cert, &chain); ctx = rb_funcall(cX509StoreContext, rb_intern("new"), 3, self, cert, chain); proc = rb_block_given_p() ? rb_block_proc() : rb_iv_get(self, "@verify_callback"); rb_iv_set(ctx, "@verify_callback", proc); result = rb_funcall(ctx, rb_intern("verify"), 0); rb_iv_set(self, "@error", ossl_x509stctx_get_err(ctx)); rb_iv_set(self, "@error_string", ossl_x509stctx_get_err_string(ctx)); rb_iv_set(self, "@chain", ossl_x509stctx_get_chain(ctx)); return result; };T;)I"static VALUE;T;*T;A@Ñ;BIC;[;A@Ñ;CIC;[;A@Ñ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@øÇi([@øÇiK;T;: Store;;K;;;[;{;IC;"fThe X509 certificate store holds trusted CA certificates used to verify peer certificates. The easiest way to create a useful certificate store is: cert_store = OpenSSL::X509::Store.new cert_store.set_default_paths This will use your system's built-in certificates. If your system does not have a default set of certificates you can obtain a set extracted from Mozilla CA certificate store by cURL maintainers here: https://curl.haxx.se/docs/caextract.html (You may wish to use the firefox-db2pem.sh script to extract the certificates from a local install to avoid man-in-the-middle attacks.) After downloading or generating a cacert.pem from the above link you can create a certificate store from the pem file like this: cert_store = OpenSSL::X509::Store.new cert_store.add_file 'cacert.pem' The certificate store can be used with an SSLSocket like this: ssl_context = OpenSSL::SSL::SSLContext.new ssl_context.verify_mode = OpenSSL::SSL::VERIFY_PEER ssl_context.cert_store = cert_store tcp_socket = TCPSocket.open 'example.com', 443 ssl_socket = OpenSSL::SSL::SSLSocket.new tcp_socket, ssl_context ;T;[;[;I"h The X509 certificate store holds trusted CA certificates used to verify peer certificates. The easiest way to create a useful certificate store is: cert_store = OpenSSL::X509::Store.new cert_store.set_default_paths This will use your system's built-in certificates. If your system does not have a default set of certificates you can obtain a set extracted from Mozilla CA certificate store by cURL maintainers here: https://curl.haxx.se/docs/caextract.html (You may wish to use the firefox-db2pem.sh script to extract the certificates from a local install to avoid man-in-the-middle attacks.) After downloading or generating a cacert.pem from the above link you can create a certificate store from the pem file like this: cert_store = OpenSSL::X509::Store.new cert_store.add_file 'cacert.pem' The certificate store can be used with an SSLSocket like this: ssl_context = OpenSSL::SSL::SSLContext.new ssl_context.verify_mode = OpenSSL::SSL::VERIFY_PEER ssl_context.cert_store = cert_store tcp_socket = TCPSocket.open 'example.com', 443 ssl_socket = OpenSSL::SSL::SSLSocket.new tcp_socket, ssl_context ;T;0; @Ñ;!F;"o;#;$T;%i(;&iH;'@ È;I"OpenSSL::X509::Store;F;S@]o; ;IC;[o;;F; ;;;;I"+OpenSSL::X509::StoreContext#initialize;F;[[@c0;[[@øÇi;T;;Ð;0;[;{;IC;"OSets up a StoreContext for a verification of the X.509 certificate _cert_. ;T;[o;= ;3I" overload;F;40;;î;50;)I",new(store, cert = nil, untrusted = nil);T;IC;";T; @ÛÒ;>0;!F;[;[;I";T;0;6i;[[I" store;T0[I" cert;TI"nil;T[I"untrusted;TI"nil;T; @ÛÒ;[;I"~Sets up a StoreContext for a verification of the X.509 certificate _cert_. @overload new(store, cert = nil, untrusted = nil);T;0; @ÛÒ;!F;"o;#;$T;%i;&i;'@ÙÒ;(I"ýstatic VALUE ossl_x509stctx_initialize(int argc, VALUE *argv, VALUE self) { VALUE store, cert, chain, t; X509_STORE_CTX *ctx; X509_STORE *x509st; X509 *x509 = NULL; STACK_OF(X509) *x509s = NULL; int state; rb_scan_args(argc, argv, "12", &store, &cert, &chain); GetX509StCtx(self, ctx); GetX509Store(store, x509st); if (!NIL_P(cert)) x509 = DupX509CertPtr(cert); /* NEED TO DUP */ if (!NIL_P(chain)) { x509s = ossl_protect_x509_ary2sk(chain, &state); if (state) { X509_free(x509); rb_jump_tag(state); } } if (X509_STORE_CTX_init(ctx, x509st, x509, x509s) != 1){ X509_free(x509); sk_X509_pop_free(x509s, X509_free); ossl_raise(eX509StoreError, "X509_STORE_CTX_init"); } if (!NIL_P(t = rb_iv_get(store, "@time"))) ossl_x509stctx_set_time(self, t); rb_iv_set(self, "@verify_callback", rb_iv_get(store, "@verify_callback")); rb_iv_set(self, "@cert", cert); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::X509::StoreContext#verify;F;[;[[@øÇi;;T;;Å;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;Å;50;)I"verify;T;IC;";T; @úÒ;>0;!F;[;[;I";T;0;6i;[; @úÒ;[;I" @overload verify;T;0; @úÒ;!F;"o;#;$T;%i7;&i8;'@ÙÒ;(I"‹static VALUE ossl_x509stctx_verify(VALUE self) { X509_STORE_CTX *ctx; GetX509StCtx(self, ctx); X509_STORE_CTX_set_ex_data(ctx, stctx_ex_verify_cb_idx, (void *)rb_iv_get(self, "@verify_callback")); switch (X509_verify_cert(ctx)) { case 1: return Qtrue; case 0: ossl_clear_error(); return Qfalse; default: ossl_raise(eX509CertError, NULL); } };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::X509::StoreContext#chain;F;[;[[@øÇiS;T;;;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I" chain;T;IC;";T; @Ó;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Array of X509::Certificate;T; @Ó;[;I")@return [Array of X509::Certificate];T;0;6i;[; @Ó;[;I"< @overload chain @return [Array of X509::Certificate];T;0; @Ó;!F;"o;#;$T;%iO;&iQ;'@ÙÒ;(I"static VALUE ossl_x509stctx_get_chain(VALUE self) { X509_STORE_CTX *ctx; STACK_OF(X509) *chain; X509 *x509; int i, num; VALUE ary; GetX509StCtx(self, ctx); if((chain = X509_STORE_CTX_get0_chain(ctx)) == NULL){ return Qnil; } if((num = sk_X509_num(chain)) < 0){ OSSL_Debug("certs in chain < 0???"); return rb_ary_new(); } ary = rb_ary_new2(num); for(i = 0; i < num; i++) { x509 = sk_X509_value(chain, i); rb_ary_push(ary, ossl_x509_new(x509)); } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::X509::StoreContext#error;F;[;[[@øÇiq;T;: error;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;ÿ;50;)I" error;T;IC;";T; @+Ó;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @+Ó;[;I"@return [Integer];T;0;6i;[; @+Ó;[;I") @overload error @return [Integer];T;0; @+Ó;!F;"o;#;$T;%im;&io;'@ÙÒ;(I"žstatic VALUE ossl_x509stctx_get_err(VALUE self) { X509_STORE_CTX *ctx; GetX509StCtx(self, ctx); return INT2NUM(X509_STORE_CTX_get_error(ctx)); };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::X509::StoreContext#error=;F;[[I"err;T0;[[@øÇi;T;:error=;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"error=(error_code);T;IC;";T; @FÓ;>0;!F;[;[;I";T;0;6i;[[I"error_code;T0; @FÓ;[;I"" @overload error=(error_code);T;0; @FÓ;!F;"o;#;$T;%i{;&i|;'@ÙÒ;(I"¹static VALUE ossl_x509stctx_set_error(VALUE self, VALUE err) { X509_STORE_CTX *ctx; GetX509StCtx(self, ctx); X509_STORE_CTX_set_error(ctx, NUM2INT(err)); return err; };T;)I"static VALUE;T;*To;;F; ;;;;I"-OpenSSL::X509::StoreContext#error_string;F;[;[[@øÇi;T;:error_string;0;[;{;IC;"RReturns the error string corresponding to the error code retrieved by #error. ;T;[o;= ;3I" overload;F;40;;;50;)I"error_string;T;IC;";T; @`Ó;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @`Ó;[;I"@return [String];T;0;6i;[; @`Ó;[;I"~Returns the error string corresponding to the error code retrieved by #error. @overload error_string @return [String];T;0; @`Ó;!F;"o;#;$T;%iŠ;&iŽ;'@ÙÒ;(I"åstatic VALUE ossl_x509stctx_get_err_string(VALUE self) { X509_STORE_CTX *ctx; long err; GetX509StCtx(self, ctx); err = X509_STORE_CTX_get_error(ctx); return rb_str_new2(X509_verify_cert_error_string(err)); };T;)I"static VALUE;T;*To;;F; ;;;;I",OpenSSL::X509::StoreContext#error_depth;F;[;[[@øÇi ;T;:error_depth;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"error_depth;T;IC;";T; @{Ó;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @{Ó;[;I"@return [Integer];T;0;6i;[; @{Ó;[;I"/ @overload error_depth @return [Integer];T;0; @{Ó;!F;"o;#;$T;%iœ;&iž;'@ÙÒ;(I"ªstatic VALUE ossl_x509stctx_get_err_depth(VALUE self) { X509_STORE_CTX *ctx; GetX509StCtx(self, ctx); return INT2NUM(X509_STORE_CTX_get_error_depth(ctx)); };T;)I"static VALUE;T;*To;;F; ;;;;I"-OpenSSL::X509::StoreContext#current_cert;F;[;[[@øÇi®;T;:current_cert;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"current_cert;T;IC;";T; @–Ó;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"X509::Certificate;T; @–Ó;[;I" @return [X509::Certificate];T;0;6i;[; @–Ó;[;I": @overload current_cert @return [X509::Certificate];T;0; @–Ó;!F;"o;#;$T;%iª;&i¬;'@ÙÒ;(I"±static VALUE ossl_x509stctx_get_curr_cert(VALUE self) { X509_STORE_CTX *ctx; GetX509StCtx(self, ctx); return ossl_x509_new(X509_STORE_CTX_get_current_cert(ctx)); };T;)I"static VALUE;T;*To;;F; ;;;;I",OpenSSL::X509::StoreContext#current_crl;F;[;[[@øÇi¼;T;:current_crl;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"current_crl;T;IC;";T; @±Ó;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"X509::CRL;T; @±Ó;[;I"@return [X509::CRL];T;0;6i;[; @±Ó;[;I"1 @overload current_crl @return [X509::CRL];T;0; @±Ó;!F;"o;#;$T;%i¸;&iº;'@ÙÒ;(I"ñstatic VALUE ossl_x509stctx_get_curr_crl(VALUE self) { X509_STORE_CTX *ctx; X509_CRL *crl; GetX509StCtx(self, ctx); crl = X509_STORE_CTX_get0_current_crl(ctx); if (!crl) return Qnil; return ossl_x509crl_new(crl); };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::X509::StoreContext#flags=;F;[[I" flags;T0;[[@øÇiÐ;T;;õ;0;[;{;IC;"BSets the verification flags to the context. See Store#flags=. ;T;[o;= ;3I" overload;F;40;;õ;50;)I"flags=(flags);T;IC;";T; @ÌÓ;>0;!F;[;[;I";T;0;6i;[[I" flags;T0; @ÌÓ;[;I"\Sets the verification flags to the context. See Store#flags=. @overload flags=(flags);T;0; @ÌÓ;!F;"o;#;$T;%iÊ;&iÍ;'@ÙÒ;(I"Östatic VALUE ossl_x509stctx_set_flags(VALUE self, VALUE flags) { X509_STORE_CTX *store; long f = NUM2LONG(flags); GetX509StCtx(self, store); X509_STORE_CTX_set_flags(store, f); return flags; };T;)I"static VALUE;T;*To;;F; ;;;;I")OpenSSL::X509::StoreContext#purpose=;F;[[I"purpose;T0;[[@øÇiâ;T;;ö;0;[;{;IC;"9Sets the purpose of the context. See Store#purpose=. ;T;[o;= ;3I" overload;F;40;;ö;50;)I"purpose=(purpose);T;IC;";T; @æÓ;>0;!F;[;[;I";T;0;6i;[[I"purpose;T0; @æÓ;[;I"WSets the purpose of the context. See Store#purpose=. @overload purpose=(purpose);T;0; @æÓ;!F;"o;#;$T;%iÜ;&iß;'@ÙÒ;(I"Þstatic VALUE ossl_x509stctx_set_purpose(VALUE self, VALUE purpose) { X509_STORE_CTX *store; int p = NUM2INT(purpose); GetX509StCtx(self, store); X509_STORE_CTX_set_purpose(store, p); return purpose; };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::X509::StoreContext#trust=;F;[[I" trust;T0;[[@øÇiò;T;;÷;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;÷;50;)I"trust=(trust);T;IC;";T; @Ô;>0;!F;[;[;I";T;0;6i;[[I" trust;T0; @Ô;[;I" @overload trust=(trust);T;0; @Ô;!F;"o;#;$T;%iî;&iï;'@ÙÒ;(I"Ôstatic VALUE ossl_x509stctx_set_trust(VALUE self, VALUE trust) { X509_STORE_CTX *store; int t = NUM2INT(trust); GetX509StCtx(self, store); X509_STORE_CTX_set_trust(store, t); return trust; };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::X509::StoreContext#time=;F;[[I" time;T0;[[@øÇi;T;;ø;0;[;{;IC;"RSets the time used in the verification. If not set, the current time is used. ;T;[o;= ;3I" overload;F;40;;ø;50;)I"time=(time);T;IC;";T; @Ô;>0;!F;[;[;I";T;0;6i;[[I" time;T0; @Ô;[;I"jSets the time used in the verification. If not set, the current time is used. @overload time=(time);T;0; @Ô;!F;"o;#;$T;%iþ;&i;'@ÙÒ;(I"çstatic VALUE ossl_x509stctx_set_time(VALUE self, VALUE time) { X509_STORE_CTX *store; long t; t = NUM2LONG(rb_Integer(time)); GetX509StCtx(self, store); X509_STORE_CTX_set_time(store, 0, t); return time; };T;)I"static VALUE;T;*T;A@ÙÒ;BIC;[;A@ÙÒ;CIC;[;A@ÙÒ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@øÇip[@øÇiv;T;:StoreContext;;K;;;[;{;IC;"`A StoreContext is used while validating a single certificate and holds the status involved. ;T;[;[;I"b A StoreContext is used while validating a single certificate and holds the status involved. ;T;0; @ÙÒ;!F;"o;#;$T;%ip;&is;'@ È;I" OpenSSL::X509::StoreContext;F;S@]o; ;IC;[;A@FÔ;BIC;[;A@FÔ;CIC;[;A@FÔ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@úÇi;F;:RevokedError;;K;;;[;{;IC;";T;[;[;@|;0; @FÔ;'@ È;I" OpenSSL::X509::RevokedError;F;S@ÅÇo; ;IC;[o;;F; ;;;;I"&OpenSSL::X509::Revoked#initialize;F;[[@c0;[[@úÇij;T;;Ð;0;[;{;IC;";T;[;[;@|;0; @YÔ;'@WÔ;(I"ustatic VALUE ossl_x509revoked_initialize(int argc, VALUE *argv, VALUE self) { /* EMPTY */ return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"+OpenSSL::X509::Revoked#initialize_copy;F;[[I" other;T0;[[@úÇiq;T;;g;0;[;{;IC;";T;[;[;@|;0; @fÔ;'@WÔ;(I"Œstatic VALUE ossl_x509revoked_initialize_copy(VALUE self, VALUE other) { X509_REVOKED *rev, *rev_other, *rev_new; rb_check_frozen(self); GetX509Rev(self, rev); GetX509Rev(other, rev_other); rev_new = X509_REVOKED_dup(rev_other); if (!rev_new) ossl_raise(eX509RevError, "X509_REVOKED_dup"); SetX509Rev(self, rev_new); X509_REVOKED_free(rev); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::X509::Revoked#serial;F;[;[[@úÇi;T;;¸;0;[;{;IC;";T;[;[;@|;0; @tÔ;'@WÔ;(I"°static VALUE ossl_x509revoked_get_serial(VALUE self) { X509_REVOKED *rev; GetX509Rev(self, rev); return asn1integer_to_num(X509_REVOKED_get0_serialNumber(rev)); };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::X509::Revoked#serial=;F;[[I"num;T0;[[@úÇi‰;T;;¹;0;[;{;IC;";T;[;[;@|;0; @€Ô;'@WÔ;(I"‡static VALUE ossl_x509revoked_set_serial(VALUE self, VALUE num) { X509_REVOKED *rev; ASN1_INTEGER *asn1int; GetX509Rev(self, rev); asn1int = num_to_asn1integer(num, NULL); if (!X509_REVOKED_set_serialNumber(rev, asn1int)) { ASN1_INTEGER_free(asn1int); ossl_raise(eX509RevError, "X509_REVOKED_set_serialNumber"); } ASN1_INTEGER_free(asn1int); return num; };T;)I"static VALUE;T;*To;;F; ;;;;I" OpenSSL::X509::Revoked#time;F;[;[[@úÇiš;T;: time;0;[;{;IC;";T;[;[;@|;0; @ŽÔ;'@WÔ;(I"÷static VALUE ossl_x509revoked_get_time(VALUE self) { X509_REVOKED *rev; const ASN1_TIME *time; GetX509Rev(self, rev); time = X509_REVOKED_get0_revocationDate(rev); if (!time) return Qnil; return asn1time_to_time(time); };T;)I"static VALUE;T;*To;;F; ;;;;I"!OpenSSL::X509::Revoked#time=;F;[[I" time;T0;[[@úÇi¨;T;;ø;0;[;{;IC;";T;[;[;@|;0; @šÔ;'@WÔ;(I"‹static VALUE ossl_x509revoked_set_time(VALUE self, VALUE time) { X509_REVOKED *rev; ASN1_TIME *asn1time; GetX509Rev(self, rev); asn1time = ossl_x509_time_adjust(NULL, time); if (!X509_REVOKED_set_revocationDate(rev, asn1time)) { ASN1_TIME_free(asn1time); ossl_raise(eX509RevError, "X509_REVOKED_set_revocationDate"); } ASN1_TIME_free(asn1time); return time; };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::X509::Revoked#extensions;F;[;[[@úÇi»;T;;Ç;0;[;{;IC;"7Gets X509v3 extensions as array of X509Ext objects ;T;[;[;I"8Gets X509v3 extensions as array of X509Ext objects ;T;0; @¨Ô;!F;"o;#;$T;%i¸;&i¹;'@WÔ;(I"Æstatic VALUE ossl_x509revoked_get_extensions(VALUE self) { X509_REVOKED *rev; int count, i; X509_EXTENSION *ext; VALUE ary; GetX509Rev(self, rev); count = X509_REVOKED_get_ext_count(rev); if (count < 0) { OSSL_Debug("count < 0???"); return rb_ary_new(); } ary = rb_ary_new2(count); for (i=0; i "\xDE|\x9B\x85\xB8\xB7\x8A\xA6\xBC\x8Az6\xF7\n\x90p\x1C\x9D\xB4\xD9" ;T;[o;= ;3I" overload;F;40;; ;50;)I"digest(digest, key, data);T;IC;";T; @Õ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aString;T; @Õ;[;I"@return [aString];T;0;6i;[[I"digest;T0[I"key;T0[I" data;T0; @Õ;[;I"ÌReturns the authentication code as a binary string. The _digest_ parameter specifies the digest algorithm to use. This may be a String representing the algorithm name or an instance of OpenSSL::Digest. === Example key = 'key' data = 'The quick brown fox jumps over the lazy dog' hmac = OpenSSL::HMAC.digest('sha1', key, data) #=> "\xDE|\x9B\x85\xB8\xB7\x8A\xA6\xBC\x8Az6\xF7\n\x90p\x1C\x9D\xB4\xD9" @overload digest(digest, key, data) @return [aString];T;0; @Õ;!F;"o;#;$T;%iý;&i;'@Õ;(I"šstatic VALUE ossl_hmac_s_digest(VALUE klass, VALUE digest, VALUE key, VALUE data) { unsigned char *buf; unsigned int buf_len; StringValue(key); StringValue(data); buf = HMAC(ossl_evp_get_digestbyname(digest), RSTRING_PTR(key), RSTRING_LENINT(key), (unsigned char *)RSTRING_PTR(data), RSTRING_LEN(data), NULL, &buf_len); return rb_str_new((const char *)buf, buf_len); };T;)I"static VALUE;T;*To;;F; ;F;;;I"OpenSSL::HMAC.hexdigest;F;[[I"digest;T0[I"key;T0[I" data;T0;[[@ÒÇi.;T;:hexdigest;0;[;{;IC;"Returns the authentication code as a hex-encoded string. The _digest_ parameter specifies the digest algorithm to use. This may be a String representing the algorithm name or an instance of OpenSSL::Digest. === Example key = 'key' data = 'The quick brown fox jumps over the lazy dog' hmac = OpenSSL::HMAC.hexdigest('sha1', key, data) #=> "de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9" ;T;[o;= ;3I" overload;F;40;;;50;)I"!hexdigest(digest, key, data);T;IC;";T; @AÕ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aString;T; @AÕ;[;I"@return [aString];T;0;6i;[[I"digest;T0[I"key;T0[I" data;T0; @AÕ;[;I"½Returns the authentication code as a hex-encoded string. The _digest_ parameter specifies the digest algorithm to use. This may be a String representing the algorithm name or an instance of OpenSSL::Digest. === Example key = 'key' data = 'The quick brown fox jumps over the lazy dog' hmac = OpenSSL::HMAC.hexdigest('sha1', key, data) #=> "de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9" @overload hexdigest(digest, key, data) @return [aString];T;0; @AÕ;!F;"o;#;$T;%i;&i,;'@Õ;(I"static VALUE ossl_hmac_s_hexdigest(VALUE klass, VALUE digest, VALUE key, VALUE data) { unsigned char buf[EVP_MAX_MD_SIZE]; unsigned int buf_len; VALUE ret; StringValue(key); StringValue(data); if (!HMAC(ossl_evp_get_digestbyname(digest), RSTRING_PTR(key), RSTRING_LENINT(key), (unsigned char *)RSTRING_PTR(data), RSTRING_LEN(data), buf, &buf_len)) ossl_raise(eHMACError, "HMAC"); ret = rb_str_new(NULL, buf_len * 2); ossl_bin2hex(buf, RSTRING_PTR(ret), buf_len); return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::HMAC#initialize;F;[[I"key;T0[I"digest;T0;[[@ÒÇid;T;;Ð;0;[;{;IC;"ÐReturns an instance of OpenSSL::HMAC set with the key and digest algorithm to be used. The instance represents the initial state of the message authentication code before any data has been processed. To process data with it, use the instance method #update with your data as an argument. === Example key = 'key' digest = OpenSSL::Digest.new('sha1') instance = OpenSSL::HMAC.new(key, digest) #=> f42bb0eeb018ebbd4597ae7213711ec60760843f instance.class #=> OpenSSL::HMAC === A note about comparisons Two instances can be securely compared with #== in constant time: other_instance = OpenSSL::HMAC.new('key', OpenSSL::Digest.new('sha1')) #=> f42bb0eeb018ebbd4597ae7213711ec60760843f instance == other_instance #=> true ;T;[o;= ;3I" overload;F;40;;î;50;)I"new(key, digest);T;IC;";T; @hÕ;>0;!F;[;[;I";T;0;6i;[[I"key;T0[I"digest;T0; @hÕ;[;I"îReturns an instance of OpenSSL::HMAC set with the key and digest algorithm to be used. The instance represents the initial state of the message authentication code before any data has been processed. To process data with it, use the instance method #update with your data as an argument. === Example key = 'key' digest = OpenSSL::Digest.new('sha1') instance = OpenSSL::HMAC.new(key, digest) #=> f42bb0eeb018ebbd4597ae7213711ec60760843f instance.class #=> OpenSSL::HMAC === A note about comparisons Two instances can be securely compared with #== in constant time: other_instance = OpenSSL::HMAC.new('key', OpenSSL::Digest.new('sha1')) #=> f42bb0eeb018ebbd4597ae7213711ec60760843f instance == other_instance #=> true @overload new(key, digest);T;0; @hÕ;!F;"o;#;$T;%iG;&ia;'@Õ;(I"static VALUE ossl_hmac_initialize(VALUE self, VALUE key, VALUE digest) { HMAC_CTX *ctx; StringValue(key); GetHMAC(self, ctx); HMAC_Init_ex(ctx, RSTRING_PTR(key), RSTRING_LENINT(key), ossl_evp_get_digestbyname(digest), NULL); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::HMAC#initialize_copy;F;[[I" other;T0;[[@ÒÇiq;T;;g;0;[;{;IC;";T;[;[;@|;0; @†Õ;'@Õ;(I"'static VALUE ossl_hmac_copy(VALUE self, VALUE other) { HMAC_CTX *ctx1, *ctx2; rb_check_frozen(self); if (self == other) return self; GetHMAC(self, ctx1); GetHMAC(other, ctx2); if (!HMAC_CTX_copy(ctx1, ctx2)) ossl_raise(eHMACError, "HMAC_CTX_copy"); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::HMAC#reset;F;[;[[@ÒÇiò;T;;;;0;[;{;IC;"‘Returns _hmac_ as it was when it was first initialized, with all processed data cleared from it. === Example data = "The quick brown fox jumps over the lazy dog" instance = OpenSSL::HMAC.new('key', OpenSSL::Digest.new('sha1')) #=> f42bb0eeb018ebbd4597ae7213711ec60760843f instance.update(data) #=> de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9 instance.reset #=> f42bb0eeb018ebbd4597ae7213711ec60760843f ;T;[o;= ;3I" overload;F;40;;;;50;)I" reset;T;IC;";T; @”Õ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @”Õ;[;I"@return [self];T;0;6i;[; @”Õ;[;I"µReturns _hmac_ as it was when it was first initialized, with all processed data cleared from it. === Example data = "The quick brown fox jumps over the lazy dog" instance = OpenSSL::HMAC.new('key', OpenSSL::Digest.new('sha1')) #=> f42bb0eeb018ebbd4597ae7213711ec60760843f instance.update(data) #=> de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9 instance.reset #=> f42bb0eeb018ebbd4597ae7213711ec60760843f @overload reset @return [self];T;0; @”Õ;!F;"o;#;$T;%iß;&ið;'@Õ;(I"–static VALUE ossl_hmac_reset(VALUE self) { HMAC_CTX *ctx; GetHMAC(self, ctx); HMAC_Init_ex(ctx, NULL, 0, NULL, NULL); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::HMAC#update;F;[[I" data;T0;[[@ÒÇiŽ;T;;Ç;0;[;{;IC;"cReturns _hmac_ updated with the message to be authenticated. Can be called repeatedly with chunks of the message. === Example first_chunk = 'The quick brown fox jumps ' second_chunk = 'over the lazy dog' instance.update(first_chunk) #=> 5b9a8038a65d571076d97fe783989e52278a492a instance.update(second_chunk) #=> de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9 ;T;[o;= ;3I" overload;F;40;;Ç;50;)I"update(string);T;IC;";T; @¯Õ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @¯Õ;[;I"@return [self];T;0;6i;[[I"string;T0; @¯Õ;[;I"Returns _hmac_ updated with the message to be authenticated. Can be called repeatedly with chunks of the message. === Example first_chunk = 'The quick brown fox jumps ' second_chunk = 'over the lazy dog' instance.update(first_chunk) #=> 5b9a8038a65d571076d97fe783989e52278a492a instance.update(second_chunk) #=> de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9 @overload update(string) @return [self];T;0; o;;F; ;;;;I"OpenSSL::HMAC#<<;F;[;[[@ÒÇiw;F;;Ý;;K;[;{;@¸Õ;'@Õ;)I"static VALUE;T;(I"Ûstatic VALUE ossl_hmac_update(VALUE self, VALUE data) { HMAC_CTX *ctx; StringValue(data); GetHMAC(self, ctx); HMAC_Update(ctx, (unsigned char *)RSTRING_PTR(data), RSTRING_LEN(data)); return self; };T;!F;"o;#;$T;%i|;&iŒ;'@Õ;(I"Ûstatic VALUE ossl_hmac_update(VALUE self, VALUE data) { HMAC_CTX *ctx; StringValue(data); GetHMAC(self, ctx); HMAC_Update(ctx, (unsigned char *)RSTRING_PTR(data), RSTRING_LEN(data)); return self; };T;)@ÒÕ;*T@ËÕo;;F; ;;;;I"OpenSSL::HMAC#digest;F;[;[[@ÒÇi¸;T;; ;0;[;{;IC;"Returns the authentication code an instance represents as a binary string. === Example instance = OpenSSL::HMAC.new('key', OpenSSL::Digest.new('sha1')) #=> f42bb0eeb018ebbd4597ae7213711ec60760843f instance.digest #=> "\xF4+\xB0\xEE\xB0\x18\xEB\xBDE\x97\xAEr\x13q\x1E\xC6\a`\x84?" ;T;[o;= ;3I" overload;F;40;; ;50;)I"digest;T;IC;";T; @ÖÕ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ÖÕ;[;I"@return [String];T;0;6i;[; @ÖÕ;[;I">Returns the authentication code an instance represents as a binary string. === Example instance = OpenSSL::HMAC.new('key', OpenSSL::Digest.new('sha1')) #=> f42bb0eeb018ebbd4597ae7213711ec60760843f instance.digest #=> "\xF4+\xB0\xEE\xB0\x18\xEB\xBDE\x97\xAEr\x13q\x1E\xC6\a`\x84?" @overload digest @return [String];T;0; @ÖÕ;!F;"o;#;$T;%i¬;&i¶;'@Õ;(I"Lstatic VALUE ossl_hmac_digest(VALUE self) { HMAC_CTX *ctx; unsigned int buf_len; VALUE ret; GetHMAC(self, ctx); ret = rb_str_new(NULL, EVP_MAX_MD_SIZE); hmac_final(ctx, (unsigned char *)RSTRING_PTR(ret), &buf_len); assert(buf_len <= EVP_MAX_MD_SIZE); rb_str_set_len(ret, buf_len); return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::HMAC#hexdigest;F;[;[[@ÒÇiÏ;T;;;0;[;{;IC;"TReturns the authentication code an instance represents as a hex-encoded string. ;T;[o;= ;3I" overload;F;40;;;50;)I"hexdigest;T;IC;";T; @ñÕ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ñÕ;[;I"@return [String];T;0;6i;[; @ñÕ;[;I"}Returns the authentication code an instance represents as a hex-encoded string. @overload hexdigest @return [String];T;0; o;;F; ;;;;I"OpenSSL::HMAC#to_s;F;[;[[@ÒÇi{;F;;q;;K;[;{;@øÕ;'@Õ;)I"static VALUE;T;(I"=static VALUE ossl_hmac_hexdigest(VALUE self) { HMAC_CTX *ctx; unsigned char buf[EVP_MAX_MD_SIZE]; unsigned int buf_len; VALUE ret; GetHMAC(self, ctx); hmac_final(ctx, buf, &buf_len); ret = rb_str_new(NULL, buf_len * 2); ossl_bin2hex(buf, RSTRING_PTR(ret), buf_len); return ret; };T;!F;"o;#;$T;%iÈ;&iÍ;'@Õ;(I"=static VALUE ossl_hmac_hexdigest(VALUE self) { HMAC_CTX *ctx; unsigned char buf[EVP_MAX_MD_SIZE]; unsigned int buf_len; VALUE ret; GetHMAC(self, ctx); hmac_final(ctx, buf, &buf_len); ret = rb_str_new(NULL, buf_len * 2); ossl_bin2hex(buf, RSTRING_PTR(ret), buf_len); return ret; };T;)@Ö;*To;;F; ;;;;I"OpenSSL::HMAC#inspect;F;[;[[@ÒÇiz;F;;r;;K;[;{;@øÕ;'@Õ;)@Ö;(I"=static VALUE ossl_hmac_hexdigest(VALUE self) { HMAC_CTX *ctx; unsigned char buf[EVP_MAX_MD_SIZE]; unsigned int buf_len; VALUE ret; GetHMAC(self, ctx); hmac_final(ctx, buf, &buf_len); ret = rb_str_new(NULL, buf_len * 2); ossl_bin2hex(buf, RSTRING_PTR(ret), buf_len); return ret; };T@ Ö;A@Õ;BIC;[;A@Õ;CIC;[;A@Õ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@ËÕ;Ç@Ö;@ Ö;;I[;[[@ÒÇiN[@ÒÇil;T;: HMAC;;K;;;[;{;IC;"OpenSSL::HMAC allows computing Hash-based Message Authentication Code (HMAC). It is a type of message authentication code (MAC) involving a hash function in combination with a key. HMAC can be used to verify the integrity of a message as well as the authenticity. OpenSSL::HMAC has a similar interface to OpenSSL::Digest. === HMAC-SHA256 using one-shot interface key = "key" data = "message-to-be-authenticated" mac = OpenSSL::HMAC.hexdigest("SHA256", key, data) #=> "cddb0db23f469c8bf072b21fd837149bd6ace9ab771cceef14c9e517cc93282e" === HMAC-SHA256 using incremental interface data1 = File.read("file1") data2 = File.read("file2") key = "key" digest = OpenSSL::Digest.new('SHA256') hmac = OpenSSL::HMAC.new(key, digest) hmac << data1 hmac << data2 mac = hmac.digest ;T;[;[;I" OpenSSL::HMAC allows computing Hash-based Message Authentication Code (HMAC). It is a type of message authentication code (MAC) involving a hash function in combination with a key. HMAC can be used to verify the integrity of a message as well as the authenticity. OpenSSL::HMAC has a similar interface to OpenSSL::Digest. === HMAC-SHA256 using one-shot interface key = "key" data = "message-to-be-authenticated" mac = OpenSSL::HMAC.hexdigest("SHA256", key, data) #=> "cddb0db23f469c8bf072b21fd837149bd6ace9ab771cceef14c9e517cc93282e" === HMAC-SHA256 using incremental interface data1 = File.read("file1") data2 = File.read("file2") key = "key" digest = OpenSSL::Digest.new('SHA256') hmac = OpenSSL::HMAC.new(key, digest) hmac << data1 hmac << data2 mac = hmac.digest ;T;0; @Õ;!F;"o;#;$T;%iN;&ig;'@ÃÇ;I"OpenSSL::HMAC;F;S@]o; ;IC;[;A@.Ö;BIC;[;A@.Ö;CIC;[;A@.Ö;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ÔÇi[@ÔÇiV;T;:ConfigError;;K;;;[;{;IC;"fGeneral error for openssl library configuration files. Including formatting, parsing errors, etc. ;T;[;[;I"h General error for openssl library configuration files. Including formatting, parsing errors, etc. ;T;0; @.Ö;!F;"o;#;$T;%i;&i;'o;L;M0;N0;O0;:OpenSSL;'@;Q@ÃÇ;R0;I"OpenSSL::ConfigError;F;S@ÅÇo; ;IC;[o;{;[[@ÔÇiZ;F;:DEFAULT_CONFIG_FILE;;};;;[;{;IC;"6The default system configuration file for openssl;T;[;[;I"8 The default system configuration file for openssl ;T;0; @EÖ;'@CÖ;I")OpenSSL::Config::DEFAULT_CONFIG_FILE;F;~I"%rb_str_new2(default_config_file);T;A@CÖ;BIC;[;A@CÖ;CIC;[;A@CÖ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ÔÇiW;F;:Config;;K;;;[;{;IC;";T;[;[;@|;0; @CÖ;6i;'@ÃÇ;I"OpenSSL::Config;F;S@]o; ;IC;[o; ;IC;[o;;F; ;;;;I"#OpenSSL::PKey::PKey#initialize;F;[;[[@ØÇi%;T;;Ð;0;[;{;IC;"qBecause PKey is an abstract class, actually calling this method explicitly will raise a NotImplementedError. ;T;[o;= ;3I" overload;F;40;;î;50;)I"new;T;IC;";T; @cÖ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @cÖ;[;I"@return [self];T;0;6i;[; @cÖ;[;I"Because PKey is an abstract class, actually calling this method explicitly will raise a NotImplementedError. @overload new @return [self];T;0; @cÖ;!F;"o;#;$T;%i;&i#;'@aÖ;(I"Èstatic VALUE ossl_pkey_initialize(VALUE self) { if (rb_obj_is_instance_of(self, cPKey)) { ossl_raise(rb_eTypeError, "OpenSSL::PKey::PKey can't be instantiated directly"); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKey::PKey#oid;F;[;[[@ØÇi4;T;;®;0;[;{;IC;">Returns the short name of the OID associated with _pkey_. ;T;[o;= ;3I" overload;F;40;;®;50;)I"oid;T;IC;";T; @~Ö;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @~Ö;[;I"@return [String];T;0;6i;[; @~Ö;[;I"aReturns the short name of the OID associated with _pkey_. @overload oid @return [String];T;0; @~Ö;!F;"o;#;$T;%i.;&i2;'@aÖ;(I"¯static VALUE ossl_pkey_oid(VALUE self) { EVP_PKEY *pkey; int nid; GetPKey(self, pkey); nid = EVP_PKEY_id(pkey); return rb_str_new_cstr(OBJ_nid2sn(nid)); };T;)I"static VALUE;T;*To;;F; ;;;;I" OpenSSL::PKey::PKey#inspect;F;[;[[@ØÇiE;T;;r;0;[;{;IC;"1Returns a string describing the PKey object. ;T;[o;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @™Ö;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @™Ö;[;I"@return [String];T;0;6i;[; @™Ö;[;I"XReturns a string describing the PKey object. @overload inspect @return [String];T;0; @™Ö;!F;"o;#;$T;%i?;&iC;'@aÖ;(I"$static VALUE ossl_pkey_inspect(VALUE self) { EVP_PKEY *pkey; int nid; GetPKey(self, pkey); nid = EVP_PKEY_id(pkey); return rb_sprintf("#<%"PRIsVALUE":%p oid=%s>", rb_class_name(CLASS_OF(self)), (void *)self, OBJ_nid2sn(nid)); };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::PKey::PKey#private_to_der;F;[[@c0;[[@ØÇiƒ;T;:private_to_der;0;[;{;IC;"Serializes the private key to DER-encoded PKCS #8 format. If called without arguments, unencrypted PKCS #8 PrivateKeyInfo format is used. If called with a cipher name and a password, PKCS #8 EncryptedPrivateKeyInfo format with PBES2 encryption scheme is used. ;T;[o;= ;3I" overload;F;40;;;50;)I"private_to_der;T;IC;";T; @´Ö;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @´Ö;[;I"@return [String];T;0;6i;[; @´Öo;= ;3I" overload;F;40;;;50;)I"%private_to_der(cipher, password);T;IC;";T; @´Ö;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @´Ö;[;I"@return [String];T;0;6i;[[I"cipher;T0[I" password;T0; @´Ö;[;I"oSerializes the private key to DER-encoded PKCS #8 format. If called without arguments, unencrypted PKCS #8 PrivateKeyInfo format is used. If called with a cipher name and a password, PKCS #8 EncryptedPrivateKeyInfo format with PBES2 encryption scheme is used. @overload private_to_der @return [String] @overload private_to_der(cipher, password) @return [String];T;0; @´Ö;!F;"o;#;$T;%iy;&i‚;'@aÖ;(I"}static VALUE ossl_pkey_private_to_der(int argc, VALUE *argv, VALUE self) { return do_pkcs8_export(argc, argv, self, 1); };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::PKey::PKey#private_to_pem;F;[[@c0;[[@ØÇi‘;T;:private_to_pem;0;[;{;IC;"dSerializes the private key to PEM-encoded PKCS #8 format. See #private_to_der for more details. ;T;[o;= ;3I" overload;F;40;;;50;)I"private_to_pem;T;IC;";T; @áÖ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @áÖ;[;I"@return [String];T;0;6i;[; @áÖo;= ;3I" overload;F;40;;;50;)I"%private_to_pem(cipher, password);T;IC;";T; @áÖ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @áÖ;[;I"@return [String];T;0;6i;[[I"cipher;T0[I" password;T0; @áÖ;[;I"ËSerializes the private key to PEM-encoded PKCS #8 format. See #private_to_der for more details. @overload private_to_pem @return [String] @overload private_to_pem(cipher, password) @return [String];T;0; @áÖ;!F;"o;#;$T;%i‰;&i;'@aÖ;(I"}static VALUE ossl_pkey_private_to_pem(int argc, VALUE *argv, VALUE self) { return do_pkcs8_export(argc, argv, self, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::PKey::PKey#public_to_der;F;[;[[@ØÇi¶;T;:public_to_der;0;[;{;IC;"PSerializes the public key to DER-encoded X.509 SubjectPublicKeyInfo format. ;T;[o;= ;3I" overload;F;40;;;50;)I"public_to_der;T;IC;";T; @×;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @×;[;I"@return [String];T;0;6i;[; @×;[;I"}Serializes the public key to DER-encoded X.509 SubjectPublicKeyInfo format. @overload public_to_der @return [String];T;0; @×;!F;"o;#;$T;%i°;&i´;'@aÖ;(I"]static VALUE ossl_pkey_public_to_der(VALUE self) { return do_spki_export(self, 1); };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::PKey::PKey#public_to_pem;F;[;[[@ØÇiÂ;T;:public_to_pem;0;[;{;IC;"PSerializes the public key to PEM-encoded X.509 SubjectPublicKeyInfo format. ;T;[o;= ;3I" overload;F;40;;;50;)I"public_to_pem;T;IC;";T; @)×;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @)×;[;I"@return [String];T;0;6i;[; @)×;[;I"}Serializes the public key to PEM-encoded X.509 SubjectPublicKeyInfo format. @overload public_to_pem @return [String];T;0; @)×;!F;"o;#;$T;%i¼;&iÀ;'@aÖ;(I"]static VALUE ossl_pkey_public_to_pem(VALUE self) { return do_spki_export(self, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKey::PKey#sign;F;[[I"digest;T0[I" data;T0;[[@ØÇiÙ;T;;Ä;0;[;{;IC;"éTo sign the String _data_, _digest_, an instance of OpenSSL::Digest, must be provided. The return value is again a String containing the signature. A PKeyError is raised should errors occur. Any previous state of the Digest instance is irrelevant to the signature outcome, the digest instance is reset to its initial state during the operation. == Example data = 'Sign me!' digest = OpenSSL::Digest.new('SHA256') pkey = OpenSSL::PKey::RSA.new(2048) signature = pkey.sign(digest, data) ;T;[o;= ;3I" overload;F;40;;Ä;50;)I"sign(digest, data);T;IC;";T; @D×;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @D×;[;I"@return [String];T;0;6i;[[I"digest;T0[I" data;T0; @D×;[;I"To sign the String _data_, _digest_, an instance of OpenSSL::Digest, must be provided. The return value is again a String containing the signature. A PKeyError is raised should errors occur. Any previous state of the Digest instance is irrelevant to the signature outcome, the digest instance is reset to its initial state during the operation. == Example data = 'Sign me!' digest = OpenSSL::Digest.new('SHA256') pkey = OpenSSL::PKey::RSA.new(2048) signature = pkey.sign(digest, data) @overload sign(digest, data) @return [String];T;0; @D×;!F;"o;#;$T;%iÈ;&i×;'@aÖ;(I"„static VALUE ossl_pkey_sign(VALUE self, VALUE digest, VALUE data) { EVP_PKEY *pkey; const EVP_MD *md; EVP_MD_CTX *ctx; unsigned int buf_len; VALUE str; int result; pkey = GetPrivPKeyPtr(self); md = ossl_evp_get_digestbyname(digest); StringValue(data); str = rb_str_new(0, EVP_PKEY_size(pkey)); ctx = EVP_MD_CTX_new(); if (!ctx) ossl_raise(ePKeyError, "EVP_MD_CTX_new"); if (!EVP_SignInit_ex(ctx, md, NULL)) { EVP_MD_CTX_free(ctx); ossl_raise(ePKeyError, "EVP_SignInit_ex"); } if (!EVP_SignUpdate(ctx, RSTRING_PTR(data), RSTRING_LEN(data))) { EVP_MD_CTX_free(ctx); ossl_raise(ePKeyError, "EVP_SignUpdate"); } result = EVP_SignFinal(ctx, (unsigned char *)RSTRING_PTR(str), &buf_len, pkey); EVP_MD_CTX_free(ctx); if (!result) ossl_raise(ePKeyError, "EVP_SignFinal"); rb_str_set_len(str, buf_len); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKey::PKey#verify;F;[[I"digest;T0[I"sig;T0[I" data;T0;[[@ØÇi;T;;Å;0;[;{;IC;"—To verify the String _signature_, _digest_, an instance of OpenSSL::Digest, must be provided to re-compute the message digest of the original _data_, also a String. The return value is +true+ if the signature is valid, +false+ otherwise. A PKeyError is raised should errors occur. Any previous state of the Digest instance is irrelevant to the validation outcome, the digest instance is reset to its initial state during the operation. == Example data = 'Sign me!' digest = OpenSSL::Digest.new('SHA256') pkey = OpenSSL::PKey::RSA.new(2048) signature = pkey.sign(digest, data) pub_key = pkey.public_key puts pub_key.verify(digest, signature, data) # => true ;T;[o;= ;3I" overload;F;40;;Å;50;)I"$verify(digest, signature, data);T;IC;";T; @g×;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @g×;[;I"@return [String];T;0;6i;[[I"digest;T0[I"signature;T0[I" data;T0; @g×;[;I"ÖTo verify the String _signature_, _digest_, an instance of OpenSSL::Digest, must be provided to re-compute the message digest of the original _data_, also a String. The return value is +true+ if the signature is valid, +false+ otherwise. A PKeyError is raised should errors occur. Any previous state of the Digest instance is irrelevant to the validation outcome, the digest instance is reset to its initial state during the operation. == Example data = 'Sign me!' digest = OpenSSL::Digest.new('SHA256') pkey = OpenSSL::PKey::RSA.new(2048) signature = pkey.sign(digest, data) pub_key = pkey.public_key puts pub_key.verify(digest, signature, data) # => true @overload verify(digest, signature, data) @return [String];T;0; @g×;!F;"o;#;$T;%iü;&i;'@aÖ;(I"Óstatic VALUE ossl_pkey_verify(VALUE self, VALUE digest, VALUE sig, VALUE data) { EVP_PKEY *pkey; const EVP_MD *md; EVP_MD_CTX *ctx; int siglen, result; GetPKey(self, pkey); ossl_pkey_check_public_key(pkey); md = ossl_evp_get_digestbyname(digest); StringValue(sig); siglen = RSTRING_LENINT(sig); StringValue(data); ctx = EVP_MD_CTX_new(); if (!ctx) ossl_raise(ePKeyError, "EVP_MD_CTX_new"); if (!EVP_VerifyInit_ex(ctx, md, NULL)) { EVP_MD_CTX_free(ctx); ossl_raise(ePKeyError, "EVP_VerifyInit_ex"); } if (!EVP_VerifyUpdate(ctx, RSTRING_PTR(data), RSTRING_LEN(data))) { EVP_MD_CTX_free(ctx); ossl_raise(ePKeyError, "EVP_VerifyUpdate"); } result = EVP_VerifyFinal(ctx, (unsigned char *)RSTRING_PTR(sig), siglen, pkey); EVP_MD_CTX_free(ctx); switch (result) { case 0: ossl_clear_error(); return Qfalse; case 1: return Qtrue; default: ossl_raise(ePKeyError, "EVP_VerifyFinal"); } };T;)I"static VALUE;T;*T;A@aÖ;BIC;[;A@aÖ;CIC;[;A@aÖ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ØÇi[I"ext/openssl/ossl_pkey_dh.c;TiD[@ØÇiˆ[I" ext/openssl/ossl_pkey_dsa.c;Tie[@Èi“[I" ext/openssl/ossl_pkey_rsa.c;Ti|;T;: PKey;;K;;;[;{;IC;"×An abstract class that bundles signature creation (PKey#sign) and validation (PKey#verify) that is common to all implementations except OpenSSL::PKey::DH * OpenSSL::PKey::RSA * OpenSSL::PKey::DSA * OpenSSL::PKey::EC ;T;[;[;I"Ù An abstract class that bundles signature creation (PKey#sign) and validation (PKey#verify) that is common to all implementations except OpenSSL::PKey::DH * OpenSSL::PKey::RSA * OpenSSL::PKey::DSA * OpenSSL::PKey::EC ;T;0; @aÖ;!F;"o;#;$T;%i;&i†;'@_Ö;I"OpenSSL::PKey::PKey;F;S@]o; ;IC;[;A@§×;BIC;[;A@§×;CIC;[;A@§×;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ØÇiy[@˜×iE[@ØÇi}[@›×if[@Èi•[@ž×i};T;:PKeyError;;K;;;[;{;IC;">Raised when errors occur during PKey#sign or PKey#verify. ;T;[;[;I"@ Raised when errors occur during PKey#sign or PKey#verify. ;T;0; @§×;!F;"o;#;$T;%iy;&i{;'@_Ö;I"OpenSSL::PKey::PKeyError;F;S@ÅÇo; ;IC;[;A@¿×;BIC;[;A@¿×;CIC;[;A@¿×;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@˜×iH[@˜×iN;T;:DHError;;K;;;[;{;IC;"©Generic exception that is raised if an operation on a DH PKey fails unexpectedly or in case an instantiation of an instance of DH fails due to non-conformant input data. ;T;[;[;I"« Generic exception that is raised if an operation on a DH PKey fails unexpectedly or in case an instantiation of an instance of DH fails due to non-conformant input data. ;T;0; @¿×;!F;"o;#;$T;%iH;&iL;'@_Ö;I"OpenSSL::PKey::DHError;F;S@§×o; ;IC;[o;;F; ;F;;;I"OpenSSL::PKey::DH.generate;F;[[@c0;[[@˜×i;T;: generate;0;[;{;IC;"Creates a new DH instance from scratch by generating the private and public components alike. === Parameters * _size_ is an integer representing the desired key size. Keys smaller than 1024 bits should be considered insecure. * _generator_ is a small number > 1, typically 2 or 5. ;T;[o;= ;3I" overload;F;40;;;50;)I"!generate(size [, generator]);T;IC;";T; @Õ×;>0;!F;[;[;I";T;0;6i;[[I"size[, generator];T0; @Õ×;[;I"CCreates a new DH instance from scratch by generating the private and public components alike. === Parameters * _size_ is an integer representing the desired key size. Keys smaller than 1024 bits should be considered insecure. * _generator_ is a small number > 1, typically 2 or 5. @overload generate(size [, generator]);T;0; @Õ×;!F;"o;#;$T;%i‘;&iš;'@Ó×;(I"xstatic VALUE ossl_dh_s_generate(int argc, VALUE *argv, VALUE klass) { DH *dh ; int g = 2; VALUE size, gen, obj; if (rb_scan_args(argc, argv, "11", &size, &gen) == 2) { g = NUM2INT(gen); } dh = dh_generate(NUM2INT(size), g); obj = dh_instance(klass, dh); if (obj == Qfalse) { DH_free(dh); ossl_raise(eDHError, NULL); } return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"!OpenSSL::PKey::DH#initialize;F;[[@c0;[[@˜×iÊ;T;;Ð;0;[;{;IC;"(Either generates a DH instance from scratch or by reading already existing DH parameters from _string_. Note that when reading a DH instance from data that was encoded from a DH instance by using DH#to_pem or DH#to_der the result will *not* contain a public/private key pair yet. This needs to be generated using DH#generate_key! first. === Parameters * _size_ is an integer representing the desired key size. Keys smaller than 1024 bits should be considered insecure. * _generator_ is a small number > 1, typically 2 or 5. * _string_ contains the DER or PEM encoded key. === Examples DH.new # -> dh DH.new(1024) # -> dh DH.new(1024, 5) # -> dh #Reading DH parameters dh = DH.new(File.read('parameters.pem')) # -> dh, but no public/private key yet dh.generate_key! # -> dh with public and private key ;T;[o;= ;3I" overload;F;40;;î;50;)I"new;T;IC;";T; @î×;>0;!F;[;[;I";T;0;6i;[; @î×o;= ;3I" overload;F;40;;î;50;)I"new(string);T;IC;";T; @î×;>0;!F;[;[;I";T;0;6i;[[I"string;T0; @î×o;= ;3I" overload;F;40;;î;50;)I"new(size [, generator]);T;IC;";T; @î×;>0;!F;[;[;I";T;0;6i;[[I"size[, generator];T0; @î×;[;I"pEither generates a DH instance from scratch or by reading already existing DH parameters from _string_. Note that when reading a DH instance from data that was encoded from a DH instance by using DH#to_pem or DH#to_der the result will *not* contain a public/private key pair yet. This needs to be generated using DH#generate_key! first. === Parameters * _size_ is an integer representing the desired key size. Keys smaller than 1024 bits should be considered insecure. * _generator_ is a small number > 1, typically 2 or 5. * _string_ contains the DER or PEM encoded key. === Examples DH.new # -> dh DH.new(1024) # -> dh DH.new(1024, 5) # -> dh #Reading DH parameters dh = DH.new(File.read('parameters.pem')) # -> dh, but no public/private key yet dh.generate_key! # -> dh with public and private key @overload new @overload new(string) @overload new(size [, generator]);T;0; @î×;!F;"o;#;$T;%i±;&iÇ;'@Ó×;(I"+static VALUE ossl_dh_initialize(int argc, VALUE *argv, VALUE self) { EVP_PKEY *pkey; DH *dh; int g = 2; BIO *in; VALUE arg, gen; GetPKey(self, pkey); if(rb_scan_args(argc, argv, "02", &arg, &gen) == 0) { dh = DH_new(); } else if (RB_INTEGER_TYPE_P(arg)) { if (!NIL_P(gen)) { g = NUM2INT(gen); } if (!(dh = dh_generate(NUM2INT(arg), g))) { ossl_raise(eDHError, NULL); } } else { arg = ossl_to_der_if_possible(arg); in = ossl_obj2bio(&arg); dh = PEM_read_bio_DHparams(in, NULL, NULL, NULL); if (!dh){ OSSL_BIO_reset(in); dh = d2i_DHparams_bio(in, NULL); } BIO_free(in); if (!dh) { ossl_raise(eDHError, NULL); } } if (!EVP_PKEY_assign_DH(pkey, dh)) { DH_free(dh); ossl_raise(eDHError, NULL); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::PKey::DH#initialize_copy;F;[[I" other;T0;[[@˜×ió;T;;g;0;[;{;IC;";T;[;[;@|;0; @Ø;'@Ó×;(I"Ìstatic VALUE ossl_dh_initialize_copy(VALUE self, VALUE other) { EVP_PKEY *pkey; DH *dh, *dh_other; const BIGNUM *pub, *priv; GetPKey(self, pkey); if (EVP_PKEY_base_id(pkey) != EVP_PKEY_NONE) ossl_raise(eDHError, "DH already initialized"); GetDH(other, dh_other); dh = DHparams_dup(dh_other); if (!dh) ossl_raise(eDHError, "DHparams_dup"); EVP_PKEY_assign_DH(pkey, dh); DH_get0_key(dh_other, &pub, &priv); if (pub) { BIGNUM *pub2 = BN_dup(pub); BIGNUM *priv2 = BN_dup(priv); if (!pub2 || (priv && !priv2)) { BN_clear_free(pub2); BN_clear_free(priv2); ossl_raise(eDHError, "BN_dup"); } DH_set0_key(dh, pub2, priv2); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKey::DH#public?;F;[;[[@˜×i;T;:public?;0;[;{;IC;"Indicates whether this DH instance has a public key associated with it or not. The public key may be retrieved with DH#pub_key.;T;[o;= ;3I" overload;F;40;;;50;)I"public?;T;IC;";T; @'Ø;>0;!F;[;[;I";T;0;6i;[; @'Øo;2 ;3I"return;F;4@|;0;5[@~; @'Ø;[;I"“Indicates whether this DH instance has a public key associated with it or not. The public key may be retrieved with DH#pub_key. @overload public?;T;0; @'Ø;!F;"o;#;$T;%i;&i;6i;'@Ó×;(I"§static VALUE ossl_dh_is_public(VALUE self) { DH *dh; const BIGNUM *bn; GetDH(self, dh); DH_get0_key(dh, &bn, NULL); return bn ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKey::DH#private?;F;[;[[@˜×i.;T;: private?;0;[;{;IC;"‚Indicates whether this DH instance has a private key associated with it or not. The private key may be retrieved with DH#priv_key.;T;[o;= ;3I" overload;F;40;;;50;)I" private?;T;IC;";T; @@Ø;>0;!F;[;[;I";T;0;6i;[; @@Øo;2 ;3I"return;F;4@|;0;5[@~; @@Ø;[;I"—Indicates whether this DH instance has a private key associated with it or not. The private key may be retrieved with DH#priv_key. @overload private?;T;0; @@Ø;!F;"o;#;$T;%i';&i+;6i;'@Ó×;(I" static VALUE ossl_dh_is_private(VALUE self) { DH *dh; const BIGNUM *bn; GetDH(self, dh); DH_get0_key(dh, NULL, &bn); #if !defined(OPENSSL_NO_ENGINE) return (bn || DH_get0_engine(dh)) ? Qtrue : Qfalse; #else return bn ? Qtrue : Qfalse; #endif };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKey::DH#to_text;F;[;[[@˜×iž;T;;´;0;[;{;IC;"yPrints all parameters of key to buffer INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don't use :-)) (I's up to you) ;T;[o;= ;3I" overload;F;40;;´;50;)I"to_text;T;IC;";T; @YØ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aString;T; @YØ;[;I"@return [aString];T;0;6i;[; @YØ;[;I"œPrints all parameters of key to buffer INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don't use :-)) (I's up to you) @overload to_text @return [aString];T;0; @YØ;!F;"o;#;$T;%i–;&iœ;'@Ó×;(I"?static VALUE ossl_dh_to_text(VALUE self) { DH *dh; BIO *out; VALUE str; GetDH(self, dh); if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eDHError, NULL); } if (!DHparams_print(out, dh)) { BIO_free(out); ossl_raise(eDHError, NULL); } str = ossl_membio2str(out); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKey::DH#export;F;[;[[@˜×iH;T;:export;0;[;{;IC;"§Encodes this DH to its PEM encoding. Note that any existing per-session public/private keys will *not* get encoded, just the Diffie-Hellman parameters will be encoded. ;T;[o;= ;3I" overload;F;40;;;50;)I"export;T;IC;";T; @tØ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aString;T; @tØ;[;I"@return [aString];T;0;6i;[; @tØo;= ;3I" overload;F;40;;³;50;)I"to_pem;T;IC;";T; @tØ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aString;T; @tØ;[;I"@return [aString];T;0;6i;[; @tØo;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @tØ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aString;T; @tØ;[;I"@return [aString];T;0;6i;[; @tØ;[;I"Encodes this DH to its PEM encoding. Note that any existing per-session public/private keys will *not* get encoded, just the Diffie-Hellman parameters will be encoded. @overload export @return [aString] @overload to_pem @return [aString] @overload to_s @return [aString];T;0; o;;F; ;;;;I"OpenSSL::PKey::DH#to_s;F;[;[[@˜×is;F;;q;;K;[;{;@{Ø;'@Ó×;)I"static VALUE;T;(I"Fstatic VALUE ossl_dh_export(VALUE self) { DH *dh; BIO *out; VALUE str; GetDH(self, dh); if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eDHError, NULL); } if (!PEM_write_bio_DHparams(out, dh)) { BIO_free(out); ossl_raise(eDHError, NULL); } str = ossl_membio2str(out); return str; };T;!F;"o;#;$T;%i>;&iH;'@Ó×;(I"Fstatic VALUE ossl_dh_export(VALUE self) { DH *dh; BIO *out; VALUE str; GetDH(self, dh); if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eDHError, NULL); } if (!PEM_write_bio_DHparams(out, dh)) { BIO_free(out); ossl_raise(eDHError, NULL); } str = ossl_membio2str(out); return str; };T;)@Ø;*To;;F; ;;;;I"OpenSSL::PKey::DH#to_pem;F;[;[[@˜×ir;F;;³;;K;[;{;@{Ø;'@Ó×;)@Ø;(I"Fstatic VALUE ossl_dh_export(VALUE self) { DH *dh; BIO *out; VALUE str; GetDH(self, dh); if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eDHError, NULL); } if (!PEM_write_bio_DHparams(out, dh)) { BIO_free(out); ossl_raise(eDHError, NULL); } str = ossl_membio2str(out); return str; };T@¦Øo;;F; ;;;;I"OpenSSL::PKey::DH#to_der;F;[;[[@˜×ie;T;;°;0;[;{;IC;"§Encodes this DH to its DER encoding. Note that any existing per-session public/private keys will *not* get encoded, just the Diffie-Hellman parameters will be encoded. ;T;[o;= ;3I" overload;F;40;;°;50;)I"to_der;T;IC;";T; @¹Ø;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aString;T; @¹Ø;[;I"@return [aString];T;0;6i;[; @¹Ø;[;I"ÏEncodes this DH to its DER encoding. Note that any existing per-session public/private keys will *not* get encoded, just the Diffie-Hellman parameters will be encoded. @overload to_der @return [aString];T;0; @¹Ø;!F;"o;#;$T;%i\;⁣'@Ó×;(I"~static VALUE ossl_dh_to_der(VALUE self) { DH *dh; unsigned char *p; long len; VALUE str; GetDH(self, dh); if((len = i2d_DHparams(dh, NULL)) <= 0) ossl_raise(eDHError, NULL); str = rb_str_new(0, len); p = (unsigned char *)RSTRING_PTR(str); if(i2d_DHparams(dh, &p) < 0) ossl_raise(eDHError, NULL); ossl_str_adjust(str, p); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"!OpenSSL::PKey::DH#public_key;F;[;[[@˜×iÇ;T;;Â;0;[;{;IC;"€Returns a new DH instance that carries just the public information, i.e. the prime _p_ and the generator _g_, but no public/private key yet. Such a pair may be generated using DH#generate_key!. The "public key" needed for a key exchange with DH#compute_key is considered as per-session information and may be retrieved with DH#pub_key once a key pair has been generated. If the current instance already contains private information (and thus a valid public/private key pair), this information will no longer be present in the new instance generated by DH#public_key. This feature is helpful for publishing the Diffie-Hellman parameters without leaking any of the private per-session information. === Example dh = OpenSSL::PKey::DH.new(2048) # has public and private key set public_key = dh.public_key # contains only prime and generator parameters = public_key.to_der # it's safe to publish this ;T;[o;= ;3I" overload;F;40;;Â;50;)I"public_key;T;IC;";T; @ÔØ;>0;!F;[;[;I";T;0;6i;[; @ÔØ;[;I"—Returns a new DH instance that carries just the public information, i.e. the prime _p_ and the generator _g_, but no public/private key yet. Such a pair may be generated using DH#generate_key!. The "public key" needed for a key exchange with DH#compute_key is considered as per-session information and may be retrieved with DH#pub_key once a key pair has been generated. If the current instance already contains private information (and thus a valid public/private key pair), this information will no longer be present in the new instance generated by DH#public_key. This feature is helpful for publishing the Diffie-Hellman parameters without leaking any of the private per-session information. === Example dh = OpenSSL::PKey::DH.new(2048) # has public and private key set public_key = dh.public_key # contains only prime and generator parameters = public_key.to_der # it's safe to publish this @overload public_key;T;0; @ÔØ;!F;"o;#;$T;%i²;&iÄ;'@Ó×;(I"Dstatic VALUE ossl_dh_to_public_key(VALUE self) { DH *orig_dh, *dh; VALUE obj; GetDH(self, orig_dh); dh = DHparams_dup(orig_dh); /* err check perfomed by dh_instance */ obj = dh_instance(rb_obj_class(self), dh); if (obj == Qfalse) { DH_free(dh); ossl_raise(eDHError, NULL); } return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"!OpenSSL::PKey::DH#params_ok?;F;[;[[@˜×ià;T;:params_ok?;0;[;{;IC;"¶Validates the Diffie-Hellman parameters associated with this instance. It checks whether a safe prime and a suitable generator are used. If this is not the case, +false+ is returned.;T;[o;= ;3I" overload;F;40;;;50;)I"params_ok?;T;IC;";T; @êØ;>0;!F;[;[;I";T;0;6i;[; @êØo;2 ;3I"return;F;4@|;0;5[@~; @êØ;[;I"ÍValidates the Diffie-Hellman parameters associated with this instance. It checks whether a safe prime and a suitable generator are used. If this is not the case, +false+ is returned. @overload params_ok?;T;0; @êØ;!F;"o;#;$T;%iØ;&iÝ;6i;'@Ó×;(I"Âstatic VALUE ossl_dh_check_params(VALUE self) { DH *dh; int codes; GetDH(self, dh); if (!DH_check(dh, &codes)) { return Qfalse; } return codes == 0 ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"$OpenSSL::PKey::DH#generate_key!;F;[;[[@˜×iþ;T;:generate_key!;0;[;{;IC;"ßGenerates a private and public key unless a private key already exists. If this DH instance was generated from public DH parameters (e.g. by encoding the result of DH#public_key), then this method needs to be called first in order to generate the per-session keys before performing the actual key exchange. === Example dh = OpenSSL::PKey::DH.new(2048) public_key = dh.public_key #contains no private/public key yet public_key.generate_key! puts public_key.private? # => true ;T;[o;= ;3I" overload;F;40;;;50;)I"generate_key!;T;IC;";T; @Ù;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @Ù;[;I"@return [self];T;0;6i;[; @Ù;[;I" Generates a private and public key unless a private key already exists. If this DH instance was generated from public DH parameters (e.g. by encoding the result of DH#public_key), then this method needs to be called first in order to generate the per-session keys before performing the actual key exchange. === Example dh = OpenSSL::PKey::DH.new(2048) public_key = dh.public_key #contains no private/public key yet public_key.generate_key! puts public_key.private? # => true @overload generate_key! @return [self];T;0; @Ù;!F;"o;#;$T;%iî;&iü;'@Ó×;(I"³static VALUE ossl_dh_generate_key(VALUE self) { DH *dh; GetDH(self, dh); if (!DH_generate_key(dh)) ossl_raise(eDHError, "Failed to generate key"); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::PKey::DH#compute_key;F;[[I"pub;T0;[[@˜×i;T;:compute_key;0;[;{;IC;"Returns a String containing a shared secret computed from the other party's public value. See DH_compute_key() for further information. === Parameters * _pub_bn_ is a OpenSSL::BN, *not* the DH instance returned by DH#public_key as that contains the DH parameters only. ;T;[o;= ;3I" overload;F;40;;;50;)I"compute_key(pub_bn);T;IC;";T; @Ù;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aString;T; @Ù;[;I"@return [aString];T;0;6i;[[I"pub_bn;T0; @Ù;[;I"BReturns a String containing a shared secret computed from the other party's public value. See DH_compute_key() for further information. === Parameters * _pub_bn_ is a OpenSSL::BN, *not* the DH instance returned by DH#public_key as that contains the DH parameters only. @overload compute_key(pub_bn) @return [aString];T;0; @Ù;!F;"o;#;$T;%i ;&i;'@Ó×;(I"ôstatic VALUE ossl_dh_compute_key(VALUE self, VALUE pub) { DH *dh; const BIGNUM *pub_key, *dh_p; VALUE str; int len; GetDH(self, dh); DH_get0_pqg(dh, &dh_p, NULL, NULL); if (!dh_p) ossl_raise(eDHError, "incomplete DH"); pub_key = GetBNPtr(pub); len = DH_size(dh); str = rb_str_new(0, len); if ((len = DH_compute_key((unsigned char *)RSTRING_PTR(str), pub_key, dh)) < 0) { ossl_raise(eDHError, NULL); } rb_str_set_len(str, len); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKey::DH#set_pqg;F;[;[;F;:set_pqg;;K;[;{;IC;"+Sets _p_, _q_, _g_ to the DH instance. ;T;[o;= ;3I" overload;F;40;;;50;)I"set_pqg(p, q, g);T;IC;";T; @=Ù;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @=Ù;[;I"@return [self];T;0;6i;[[I"p;T0[I"q;T0[I"g;T0; @=Ù;[;I"YSets _p_, _q_, _g_ to the DH instance. @overload set_pqg(p, q, g) @return [self];T;0; @=Ù;!F;"o;#;$T;%i+;&i/;'@Ó×;*To;;F; ;;;;I"OpenSSL::PKey::DH#set_key;F;[;[;F;:set_key;;K;[;{;IC;"PSets _pub_key_ and _priv_key_ for the DH instance. _priv_key_ may be +nil+. ;T;[o;= ;3I" overload;F;40;; ;50;)I"set_key(pub_key, priv_key);T;IC;";T; @[Ù;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @[Ù;[;I"@return [self];T;0;6i;[[I"pub_key;T0[I" priv_key;T0; @[Ù;[;I"ƒSets _pub_key_ and _priv_key_ for the DH instance. _priv_key_ may be +nil+. @overload set_key(pub_key, priv_key) @return [self];T;0; @[Ù;!F;"o;#;$T;%i3;&i7;'@Ó×;*To;;F; ;;;;I"OpenSSL::PKey::DH#params;F;[;[[@˜×i;T;;ß;0;[;{;IC;"{Stores all parameters of key to the hash INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don't use :-)) (I's up to you) ;T;[o;= ;3I" overload;F;40;;ß;50;)I"params;T;IC;";T; @wÙ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @wÙ;[;I"@return [Hash];T;0;6i;[; @wÙ;[;I"šStores all parameters of key to the hash INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don't use :-)) (I's up to you) @overload params @return [Hash];T;0; @wÙ;!F;"o;#;$T;%iy;&i;'@Ó×;(I"Gstatic VALUE ossl_dh_get_params(VALUE self) { DH *dh; VALUE hash; const BIGNUM *p, *q, *g, *pub_key, *priv_key; GetDH(self, dh); DH_get0_pqg(dh, &p, &q, &g); DH_get0_key(dh, &pub_key, &priv_key); hash = rb_hash_new(); rb_hash_aset(hash, rb_str_new2("p"), ossl_bn_new(p)); rb_hash_aset(hash, rb_str_new2("q"), ossl_bn_new(q)); rb_hash_aset(hash, rb_str_new2("g"), ossl_bn_new(g)); rb_hash_aset(hash, rb_str_new2("pub_key"), ossl_bn_new(pub_key)); rb_hash_aset(hash, rb_str_new2("priv_key"), ossl_bn_new(priv_key)); return hash; };T;)I"static VALUE;T;*T;A@Ó×;BIC;[;A@Ó×;CIC;[;A@Ó×;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@±Ø;@¦Ø;;I[;[[@˜×iO[@˜×ij;T;:DH;;K;;;[;{;IC;"„An implementation of the Diffie-Hellman key exchange protocol based on discrete logarithms in finite fields, the same basis that DSA is built on. === Accessor methods for the Diffie-Hellman parameters DH#p:: The prime (an OpenSSL::BN) of the Diffie-Hellman parameters. DH#g:: The generator (an OpenSSL::BN) g of the Diffie-Hellman parameters. DH#pub_key:: The per-session public key (an OpenSSL::BN) matching the private key. This needs to be passed to DH#compute_key. DH#priv_key:: The per-session private key, an OpenSSL::BN. === Example of a key exchange dh1 = OpenSSL::PKey::DH.new(2048) der = dh1.public_key.to_der #you may send this publicly to the participating party dh2 = OpenSSL::PKey::DH.new(der) dh2.generate_key! #generate the per-session key pair symm_key1 = dh1.compute_key(dh2.pub_key) symm_key2 = dh2.compute_key(dh1.pub_key) puts symm_key1 == symm_key2 # => true ;T;[;[;I"† An implementation of the Diffie-Hellman key exchange protocol based on discrete logarithms in finite fields, the same basis that DSA is built on. === Accessor methods for the Diffie-Hellman parameters DH#p:: The prime (an OpenSSL::BN) of the Diffie-Hellman parameters. DH#g:: The generator (an OpenSSL::BN) g of the Diffie-Hellman parameters. DH#pub_key:: The per-session public key (an OpenSSL::BN) matching the private key. This needs to be passed to DH#compute_key. DH#priv_key:: The per-session private key, an OpenSSL::BN. === Example of a key exchange dh1 = OpenSSL::PKey::DH.new(2048) der = dh1.public_key.to_der #you may send this publicly to the participating party dh2 = OpenSSL::PKey::DH.new(der) dh2.generate_key! #generate the per-session key pair symm_key1 = dh1.compute_key(dh2.pub_key) symm_key2 = dh2.compute_key(dh1.pub_key) puts symm_key1 == symm_key2 # => true ;T;0; @Ó×;!F;"o;#;$T;%iO;&ih;'@_Ö;I"OpenSSL::PKey::DH;F;S@aÖo;;F; ;;;Ï;I"OpenSSL::PKey#read;F;[[@c0;[[@ØÇiŸ;T;;è;0;[;{;IC;"Reads a DER or PEM encoded string from _string_ or _io_ and returns an instance of the appropriate PKey class. === Parameters * _string+ is a DER- or PEM-encoded string containing an arbitrary private or public key. * _io_ is an instance of IO containing a DER- or PEM-encoded arbitrary private or public key. * _pwd_ is an optional password in case _string_ or _io_ is an encrypted PEM resource. ;T; @¤Ù;>0;!F;[o;= ;3I" overload;F;40;:OpenSSL::PKey.read;50;)I"(OpenSSL::PKey.read(string [, pwd ]);T;IC;";T; @¤Ù;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" PKey;T; @¤Ù;[;I"@return [PKey];T;0;6i;[[I"string[, pwd ];T0; @¤Ùo;= ;3I" overload;F;40;;";50;)I"$OpenSSL::PKey.read(io [, pwd ]);T;IC;";T; @¤Ù;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" PKey;T; @¤Ù;[;I"@return [PKey];T;0;6i;[[I"io[, pwd ];T0; @¤Ù;[;I"Reads a DER or PEM encoded string from _string_ or _io_ and returns an instance of the appropriate PKey class. === Parameters * _string+ is a DER- or PEM-encoded string containing an arbitrary private or public key. * _io_ is an instance of IO containing a DER- or PEM-encoded arbitrary private or public key. * _pwd_ is an optional password in case _string_ or _io_ is an encrypted PEM resource. @overload OpenSSL::PKey.read(string [, pwd ]) @return [PKey] @overload OpenSSL::PKey.read(io [, pwd ]) @return [PKey];T;0;'@_Ö;(I"›static VALUE ossl_pkey_new_from_data(int argc, VALUE *argv, VALUE self) { EVP_PKEY *pkey; BIO *bio; VALUE data, pass; rb_scan_args(argc, argv, "11", &data, &pass); pass = ossl_pem_passwd_value(pass); bio = ossl_obj2bio(&data); if ((pkey = d2i_PrivateKey_bio(bio, NULL))) goto ok; OSSL_BIO_reset(bio); if ((pkey = d2i_PKCS8PrivateKey_bio(bio, NULL, ossl_pem_passwd_cb, (void *)pass))) goto ok; OSSL_BIO_reset(bio); if ((pkey = d2i_PUBKEY_bio(bio, NULL))) goto ok; OSSL_BIO_reset(bio); /* PEM_read_bio_PrivateKey() also parses PKCS #8 formats */ if ((pkey = PEM_read_bio_PrivateKey(bio, NULL, ossl_pem_passwd_cb, (void *)pass))) goto ok; OSSL_BIO_reset(bio); if ((pkey = PEM_read_bio_PUBKEY(bio, NULL, NULL, NULL))) goto ok; BIO_free(bio); ossl_raise(ePKeyError, "Could not parse PKey"); ok: BIO_free(bio); return ossl_pkey_new(pkey); };T;)I"static VALUE;T;*To;;T; ;F;;;I"OpenSSL::PKey.read;F;@¦Ù;@¨Ù;T;;è;0;@ªÙ;{;IC;"Reads a DER or PEM encoded string from _string_ or _io_ and returns an instance of the appropriate PKey class. === Parameters * _string+ is a DER- or PEM-encoded string containing an arbitrary private or public key. * _io_ is an instance of IO containing a DER- or PEM-encoded arbitrary private or public key. * _pwd_ is an optional password in case _string_ or _io_ is an encrypted PEM resource.;T;[o;= ;3I" overload;F;40;;";50;)I"(OpenSSL::PKey.read(string [, pwd ]);T;IC;";T; @ÐÙ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" PKey;T; @ÐÙ;[;I"@return [PKey];T;0;6i;[[I"string[, pwd ];T0; @ÐÙo;= ;3I" overload;F;40;;";50;)I"$OpenSSL::PKey.read(io [, pwd ]);T;IC;";T; @ÐÙ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" PKey;T; @ÐÙ;[;I"@return [PKey];T;0;6i;[[I"io[, pwd ];T0; @ÐÙ;[;I"Reads a DER or PEM encoded string from _string_ or _io_ and returns an instance of the appropriate PKey class. === Parameters * _string+ is a DER- or PEM-encoded string containing an arbitrary private or public key. * _io_ is an instance of IO containing a DER- or PEM-encoded arbitrary private or public key. * _pwd_ is an optional password in case _string_ or _io_ is an encrypted PEM resource. @overload OpenSSL::PKey.read(string [, pwd ]) @return [PKey] @overload OpenSSL::PKey.read(io [, pwd ]) @return [PKey];T;0; @ÐÙ;!F;"o;#;$T;%i;&iž;6i;'@_Ö;(@ÎÙ;)@ÏÙ;*To; ;IC;[;A@öÙ;BIC;[;A@öÙ;CIC;[;A@öÙ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@›×ii[@›×io;T;: DSAError;;K;;;[;{;IC;"«Generic exception that is raised if an operation on a DSA PKey fails unexpectedly or in case an instantiation of an instance of DSA fails due to non-conformant input data. ;T;[;[;I" Generic exception that is raised if an operation on a DSA PKey fails unexpectedly or in case an instantiation of an instance of DSA fails due to non-conformant input data. ;T;0; @öÙ;!F;"o;#;$T;%ii;&im;'@_Ö;I"OpenSSL::PKey::DSAError;F;S@§×o; ;IC;[o;;F; ;F;;;I" OpenSSL::PKey::DSA.generate;F;[[I" size;T0;[[@›×i²;T;;;0;[;{;IC;"šCreates a new DSA instance by generating a private/public key pair from scratch. === Parameters * _size_ is an integer representing the desired key size. ;T;[o;= ;3I" overload;F;40;;;50;)I"generate(size);T;IC;";T; @Ú;>0;!F;[;[;I";T;0;6i;[[I" size;T0; @Ú;[;I"¶Creates a new DSA instance by generating a private/public key pair from scratch. === Parameters * _size_ is an integer representing the desired key size. @overload generate(size);T;0; @Ú;!F;"o;#;$T;%i§;&i¯;'@ Ú;(I"static VALUE ossl_dsa_s_generate(VALUE klass, VALUE size) { DSA *dsa = dsa_generate(NUM2INT(size)); /* err handled by dsa_instance */ VALUE obj = dsa_instance(klass, dsa); if (obj == Qfalse) { DSA_free(dsa); ossl_raise(eDSAError, NULL); } return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::PKey::DSA#initialize;F;[[@c0;[[@›×iÔ;T;;Ð;0;[;{;IC;"Creates a new DSA instance by reading an existing key from _string_. === Parameters * _size_ is an integer representing the desired key size. * _string_ contains a DER or PEM encoded key. * _pass_ is a string that contains an optional password. === Examples DSA.new -> dsa DSA.new(1024) -> dsa DSA.new(File.read('dsa.pem')) -> dsa DSA.new(File.read('dsa.pem'), 'mypassword') -> dsa ;T;[o;= ;3I" overload;F;40;;î;50;)I"new;T;IC;";T; @&Ú;>0;!F;[;[;I";T;0;6i;[; @&Úo;= ;3I" overload;F;40;;î;50;)I"new(size);T;IC;";T; @&Ú;>0;!F;[;[;I";T;0;6i;[[I" size;T0; @&Úo;= ;3I" overload;F;40;;î;50;)I"new(string [, pass]);T;IC;";T; @&Ú;>0;!F;[;[;I";T;0;6i;[[I"string[, pass];T0; @&Ú;[;I"ÃCreates a new DSA instance by reading an existing key from _string_. === Parameters * _size_ is an integer representing the desired key size. * _string_ contains a DER or PEM encoded key. * _pass_ is a string that contains an optional password. === Examples DSA.new -> dsa DSA.new(1024) -> dsa DSA.new(File.read('dsa.pem')) -> dsa DSA.new(File.read('dsa.pem'), 'mypassword') -> dsa @overload new @overload new(size) @overload new(string [, pass]);T;0; @&Ú;!F;"o;#;$T;%iÀ;&iÑ;'@ Ú;(I"Wstatic VALUE ossl_dsa_initialize(int argc, VALUE *argv, VALUE self) { EVP_PKEY *pkey; DSA *dsa; BIO *in; VALUE arg, pass; GetPKey(self, pkey); if(rb_scan_args(argc, argv, "02", &arg, &pass) == 0) { dsa = DSA_new(); } else if (RB_INTEGER_TYPE_P(arg)) { if (!(dsa = dsa_generate(NUM2INT(arg)))) { ossl_raise(eDSAError, NULL); } } else { pass = ossl_pem_passwd_value(pass); arg = ossl_to_der_if_possible(arg); in = ossl_obj2bio(&arg); dsa = PEM_read_bio_DSAPrivateKey(in, NULL, ossl_pem_passwd_cb, (void *)pass); if (!dsa) { OSSL_BIO_reset(in); dsa = PEM_read_bio_DSA_PUBKEY(in, NULL, NULL, NULL); } if (!dsa) { OSSL_BIO_reset(in); dsa = d2i_DSAPrivateKey_bio(in, NULL); } if (!dsa) { OSSL_BIO_reset(in); dsa = d2i_DSA_PUBKEY_bio(in, NULL); } if (!dsa) { OSSL_BIO_reset(in); #define PEM_read_bio_DSAPublicKey(bp,x,cb,u) (DSA *)PEM_ASN1_read_bio( \ (d2i_of_void *)d2i_DSAPublicKey, PEM_STRING_DSA_PUBLIC, (bp), (void **)(x), (cb), (u)) dsa = PEM_read_bio_DSAPublicKey(in, NULL, NULL, NULL); #undef PEM_read_bio_DSAPublicKey } BIO_free(in); if (!dsa) { ossl_clear_error(); ossl_raise(eDSAError, "Neither PUB key nor PRIV key"); } } if (!EVP_PKEY_assign_DSA(pkey, dsa)) { DSA_free(dsa); ossl_raise(eDSAError, NULL); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::PKey::DSA#initialize_copy;F;[[I" other;T0;[[@›×i;T;;g;0;[;{;IC;";T;[;[;@|;0; @QÚ;'@ Ú;(I"ßstatic VALUE ossl_dsa_initialize_copy(VALUE self, VALUE other) { EVP_PKEY *pkey; DSA *dsa, *dsa_new; GetPKey(self, pkey); if (EVP_PKEY_base_id(pkey) != EVP_PKEY_NONE) ossl_raise(eDSAError, "DSA already initialized"); GetDSA(other, dsa); dsa_new = ASN1_dup((i2d_of_void *)i2d_DSAPrivateKey, (d2i_of_void *)d2i_DSAPrivateKey, (char *)dsa); if (!dsa_new) ossl_raise(eDSAError, "ASN1_dup"); EVP_PKEY_assign_DSA(pkey, dsa_new); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKey::DSA#public?;F;[;[[@›×i&;T;;;0;[;{;IC;"„Indicates whether this DSA instance has a public key associated with it or not. The public key may be retrieved with DSA#public_key.;T;[o;= ;3I" overload;F;40;;;50;)I"public?;T;IC;";T; @_Ú;>0;!F;[;[;I";T;0;6i;[; @_Úo;2 ;3I"return;F;4@|;0;5[@~; @_Ú;[;I"˜Indicates whether this DSA instance has a public key associated with it or not. The public key may be retrieved with DSA#public_key. @overload public?;T;0; @_Ú;!F;"o;#;$T;%i;&i#;6i;'@ Ú;(I"®static VALUE ossl_dsa_is_public(VALUE self) { DSA *dsa; const BIGNUM *bn; GetDSA(self, dsa); DSA_get0_key(dsa, &bn, NULL); return bn ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I" OpenSSL::PKey::DSA#private?;F;[;[[@›×i9;T;;;0;[;{;IC;"‡Indicates whether this DSA instance has a private key associated with it or not. The private key may be retrieved with DSA#private_key.;T;[o;= ;3I" overload;F;40;;;50;)I" private?;T;IC;";T; @xÚ;>0;!F;[;[;I";T;0;6i;[; @xÚo;2 ;3I"return;F;4@|;0;5[@~; @xÚ;[;I"œIndicates whether this DSA instance has a private key associated with it or not. The private key may be retrieved with DSA#private_key. @overload private?;T;0; @xÚ;!F;"o;#;$T;%i2;&i6;6i;'@ Ú;(I"‹static VALUE ossl_dsa_is_private(VALUE self) { DSA *dsa; GetDSA(self, dsa); return DSA_PRIVATE(self, dsa) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKey::DSA#to_text;F;[;[[@›×i¼;T;;´;0;[;{;IC;"yPrints all parameters of key to buffer INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don't use :-)) (I's up to you) ;T;[o;= ;3I" overload;F;40;;´;50;)I"to_text;T;IC;";T; @‘Ú;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aString;T; @‘Ú;[;I"@return [aString];T;0;6i;[; @‘Ú;[;I"œPrints all parameters of key to buffer INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don't use :-)) (I's up to you) @overload to_text @return [aString];T;0; @‘Ú;!F;"o;#;$T;%i´;&iº;'@ Ú;(I"Vstatic VALUE ossl_dsa_to_text(VALUE self) { DSA *dsa; BIO *out; VALUE str; GetDSA(self, dsa); if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eDSAError, NULL); } if (!DSA_print(out, dsa, 0)) { /* offset = 0 */ BIO_free(out); ossl_raise(eDSAError, NULL); } str = ossl_membio2str(out); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKey::DSA#export;F;[[@c0;[[@›×iT;T;;;0;[;{;IC;"ÚEncodes this DSA to its PEM encoding. === Parameters * _cipher_ is an OpenSSL::Cipher. * _password_ is a string containing your password. === Examples DSA.to_pem -> aString DSA.to_pem(cipher, 'mypassword') -> aString ;T;[o;= ;3I" overload;F;40;;;50;)I"export([cipher, password]);T;IC;";T; @¬Ú;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aString;T; @¬Ú;[;I"@return [aString];T;0;6i;[[I"[cipher, password];T0; @¬Úo;= ;3I" overload;F;40;;³;50;)I"to_pem([cipher, password]);T;IC;";T; @¬Ú;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aString;T; @¬Ú;[;I"@return [aString];T;0;6i;[[I"[cipher, password];T0; @¬Úo;= ;3I" overload;F;40;;q;50;)I"to_s([cipher, password]);T;IC;";T; @¬Ú;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aString;T; @¬Ú;[;I"@return [aString];T;0;6i;[[I"[cipher, password];T0; @¬Ú;[;I"†Encodes this DSA to its PEM encoding. === Parameters * _cipher_ is an OpenSSL::Cipher. * _password_ is a string containing your password. === Examples DSA.to_pem -> aString DSA.to_pem(cipher, 'mypassword') -> aString @overload export([cipher, password]) @return [aString] @overload to_pem([cipher, password]) @return [aString] @overload to_s([cipher, password]) @return [aString];T;0; o;;F; ;;;;I"OpenSSL::PKey::DSA#to_s;F;[;[[@›×i‚;F;;q;;K;[;{;@´Ú;'@ Ú;)I"static VALUE;T;(I"static VALUE ossl_dsa_export(int argc, VALUE *argv, VALUE self) { DSA *dsa; BIO *out; const EVP_CIPHER *ciph = NULL; VALUE cipher, pass, str; GetDSA(self, dsa); rb_scan_args(argc, argv, "02", &cipher, &pass); if (!NIL_P(cipher)) { ciph = ossl_evp_get_cipherbyname(cipher); pass = ossl_pem_passwd_value(pass); } if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eDSAError, NULL); } if (DSA_HAS_PRIVATE(dsa)) { if (!PEM_write_bio_DSAPrivateKey(out, dsa, ciph, NULL, 0, ossl_pem_passwd_cb, (void *)pass)){ BIO_free(out); ossl_raise(eDSAError, NULL); } } else { if (!PEM_write_bio_DSA_PUBKEY(out, dsa)) { BIO_free(out); ossl_raise(eDSAError, NULL); } } str = ossl_membio2str(out); return str; };T;!F;"o;#;$T;%iC;&iT;'@ Ú;(I"static VALUE ossl_dsa_export(int argc, VALUE *argv, VALUE self) { DSA *dsa; BIO *out; const EVP_CIPHER *ciph = NULL; VALUE cipher, pass, str; GetDSA(self, dsa); rb_scan_args(argc, argv, "02", &cipher, &pass); if (!NIL_P(cipher)) { ciph = ossl_evp_get_cipherbyname(cipher); pass = ossl_pem_passwd_value(pass); } if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eDSAError, NULL); } if (DSA_HAS_PRIVATE(dsa)) { if (!PEM_write_bio_DSAPrivateKey(out, dsa, ciph, NULL, 0, ossl_pem_passwd_cb, (void *)pass)){ BIO_free(out); ossl_raise(eDSAError, NULL); } } else { if (!PEM_write_bio_DSA_PUBKEY(out, dsa)) { BIO_free(out); ossl_raise(eDSAError, NULL); } } str = ossl_membio2str(out); return str; };T;)@ìÚ;*To;;F; ;;;;I"OpenSSL::PKey::DSA#to_pem;F;[;[[@›×i;F;;³;;K;[;{;@´Ú;'@ Ú;)@ìÚ;(I"static VALUE ossl_dsa_export(int argc, VALUE *argv, VALUE self) { DSA *dsa; BIO *out; const EVP_CIPHER *ciph = NULL; VALUE cipher, pass, str; GetDSA(self, dsa); rb_scan_args(argc, argv, "02", &cipher, &pass); if (!NIL_P(cipher)) { ciph = ossl_evp_get_cipherbyname(cipher); pass = ossl_pem_passwd_value(pass); } if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eDSAError, NULL); } if (DSA_HAS_PRIVATE(dsa)) { if (!PEM_write_bio_DSAPrivateKey(out, dsa, ciph, NULL, 0, ossl_pem_passwd_cb, (void *)pass)){ BIO_free(out); ossl_raise(eDSAError, NULL); } } else { if (!PEM_write_bio_DSA_PUBKEY(out, dsa)) { BIO_free(out); ossl_raise(eDSAError, NULL); } } str = ossl_membio2str(out); return str; };T@åÚo;;F; ;;;;I"OpenSSL::PKey::DSA#to_der;F;[;[[@›×i};T;;°;0;[;{;IC;"*Encodes this DSA to its DER encoding. ;T;[o;= ;3I" overload;F;40;;°;50;)I"to_der;T;IC;";T; @øÚ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aString;T; @øÚ;[;I"@return [aString];T;0;6i;[; @øÚ;[;I"REncodes this DSA to its DER encoding. @overload to_der @return [aString];T;0; @øÚ;!F;"o;#;$T;%iv;&i{;'@ Ú;(I"/static VALUE ossl_dsa_to_der(VALUE self) { DSA *dsa; int (*i2d_func)(DSA *, unsigned char **); unsigned char *p; long len; VALUE str; GetDSA(self, dsa); if(DSA_HAS_PRIVATE(dsa)) i2d_func = (int (*)(DSA *,unsigned char **))i2d_DSAPrivateKey; else i2d_func = i2d_DSA_PUBKEY; if((len = i2d_func(dsa, NULL)) <= 0) ossl_raise(eDSAError, NULL); str = rb_str_new(0, len); p = (unsigned char *)RSTRING_PTR(str); if(i2d_func(dsa, &p) < 0) ossl_raise(eDSAError, NULL); ossl_str_adjust(str, p); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::PKey::DSA#public_key;F;[;[[@›×iá;T;;Â;0;[;{;IC;"ôReturns a new DSA instance that carries just the public key information. If the current instance has also private key information, this will no longer be present in the new instance. This feature is helpful for publishing the public key information without leaking any of the private information. === Example dsa = OpenSSL::PKey::DSA.new(2048) # has public and private information pub_key = dsa.public_key # has only the public part available pub_key_der = pub_key.to_der # it's safe to publish this ;T;[o;= ;3I" overload;F;40;;Â;50;)I"public_key;T;IC;";T; @Û;>0;!F;[;[;I";T;0;6i;[; @Û;[;I" Returns a new DSA instance that carries just the public key information. If the current instance has also private key information, this will no longer be present in the new instance. This feature is helpful for publishing the public key information without leaking any of the private information. === Example dsa = OpenSSL::PKey::DSA.new(2048) # has public and private information pub_key = dsa.public_key # has only the public part available pub_key_der = pub_key.to_der # it's safe to publish this @overload public_key;T;0; @Û;!F;"o;#;$T;%iÐ;&iÞ;'@ Ú;(I" static VALUE ossl_dsa_to_public_key(VALUE self) { EVP_PKEY *pkey; DSA *dsa; VALUE obj; GetPKeyDSA(self, pkey); /* err check performed by dsa_instance */ #define DSAPublicKey_dup(dsa) (DSA *)ASN1_dup( \ (i2d_of_void *)i2d_DSAPublicKey, (d2i_of_void *)d2i_DSAPublicKey, (char *)(dsa)) dsa = DSAPublicKey_dup(EVP_PKEY_get0_DSA(pkey)); #undef DSAPublicKey_dup obj = dsa_instance(rb_obj_class(self), dsa); if (obj == Qfalse) { DSA_free(dsa); ossl_raise(eDSAError, NULL); } return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKey::DSA#syssign;F;[[I" data;T0;[[@›×i ;T;:syssign;0;[;{;IC;"¶Computes and returns the DSA signature of _string_, where _string_ is expected to be an already-computed message digest of the original input data. The signature is issued using the private key of this DSA instance. === Parameters * _string_ is a message digest of the original input data to be signed. === Example dsa = OpenSSL::PKey::DSA.new(2048) doc = "Sign me" digest = OpenSSL::Digest.digest('SHA1', doc) sig = dsa.syssign(digest) ;T;[o;= ;3I" overload;F;40;;$;50;)I"syssign(string);T;IC;";T; @)Û;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aString;T; @)Û;[;I"@return [aString];T;0;6i;[[I"string;T0; @)Û;[;I"èComputes and returns the DSA signature of _string_, where _string_ is expected to be an already-computed message digest of the original input data. The signature is issued using the private key of this DSA instance. === Parameters * _string_ is a message digest of the original input data to be signed. === Example dsa = OpenSSL::PKey::DSA.new(2048) doc = "Sign me" digest = OpenSSL::Digest.digest('SHA1', doc) sig = dsa.syssign(digest) @overload syssign(string) @return [aString];T;0; @)Û;!F;"o;#;$T;%iö;&i;'@ Ú;(I"“static VALUE ossl_dsa_sign(VALUE self, VALUE data) { DSA *dsa; const BIGNUM *dsa_q; unsigned int buf_len; VALUE str; GetDSA(self, dsa); DSA_get0_pqg(dsa, NULL, &dsa_q, NULL); if (!dsa_q) ossl_raise(eDSAError, "incomplete DSA"); if (!DSA_PRIVATE(self, dsa)) ossl_raise(eDSAError, "Private DSA key needed!"); StringValue(data); str = rb_str_new(0, DSA_size(dsa)); if (!DSA_sign(0, (unsigned char *)RSTRING_PTR(data), RSTRING_LENINT(data), (unsigned char *)RSTRING_PTR(str), &buf_len, dsa)) { /* type is ignored (0) */ ossl_raise(eDSAError, NULL); } rb_str_set_len(str, buf_len); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"!OpenSSL::PKey::DSA#sysverify;F;[[I"digest;T0[I"sig;T0;[[@›×i6;T;:sysverify;0;[;{;IC;"ºVerifies whether the signature is valid given the message digest input. It does so by validating _sig_ using the public key of this DSA instance. === Parameters * _digest_ is a message digest of the original input data to be signed * _sig_ is a DSA signature value === Example dsa = OpenSSL::PKey::DSA.new(2048) doc = "Sign me" digest = OpenSSL::Digest.digest('SHA1', doc) sig = dsa.syssign(digest) puts dsa.sysverify(digest, sig) # => true ;T;[o;= ;3I" overload;F;40;;%;50;)I"sysverify(digest, sig);T;IC;";T; @HÛ;>0;!F;[;[;I";T;0;6i;[[I"digest;T0[I"sig;T0; @HÛ;[;I"ÞVerifies whether the signature is valid given the message digest input. It does so by validating _sig_ using the public key of this DSA instance. === Parameters * _digest_ is a message digest of the original input data to be signed * _sig_ is a DSA signature value === Example dsa = OpenSSL::PKey::DSA.new(2048) doc = "Sign me" digest = OpenSSL::Digest.digest('SHA1', doc) sig = dsa.syssign(digest) puts dsa.sysverify(digest, sig) # => true @overload sysverify(digest, sig);T;0; @HÛ;!F;"o;#;$T;%i#;&i3;'@ Ú;(I"Ùstatic VALUE ossl_dsa_verify(VALUE self, VALUE digest, VALUE sig) { DSA *dsa; int ret; GetDSA(self, dsa); StringValue(digest); StringValue(sig); /* type is ignored (0) */ ret = DSA_verify(0, (unsigned char *)RSTRING_PTR(digest), RSTRING_LENINT(digest), (unsigned char *)RSTRING_PTR(sig), RSTRING_LENINT(sig), dsa); if (ret < 0) { ossl_raise(eDSAError, NULL); } else if (ret == 1) { return Qtrue; } return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKey::DSA#set_pqg;F;[;[;F;;;;K;[;{;IC;",Sets _p_, _q_, _g_ to the DSA instance. ;T;[o;= ;3I" overload;F;40;;;50;)I"set_pqg(p, q, g);T;IC;";T; @fÛ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @fÛ;[;I"@return [self];T;0;6i;[[I"p;T0[I"q;T0[I"g;T0; @fÛ;[;I"ZSets _p_, _q_, _g_ to the DSA instance. @overload set_pqg(p, q, g) @return [self];T;0; @fÛ;!F;"o;#;$T;%iL;&iP;'@ Ú;*To;;F; ;;;;I"OpenSSL::PKey::DSA#set_key;F;[;[;F;; ;;K;[;{;IC;"QSets _pub_key_ and _priv_key_ for the DSA instance. _priv_key_ may be +nil+. ;T;[o;= ;3I" overload;F;40;; ;50;)I"set_key(pub_key, priv_key);T;IC;";T; @„Û;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @„Û;[;I"@return [self];T;0;6i;[[I"pub_key;T0[I" priv_key;T0; @„Û;[;I"„Sets _pub_key_ and _priv_key_ for the DSA instance. _priv_key_ may be +nil+. @overload set_key(pub_key, priv_key) @return [self];T;0; @„Û;!F;"o;#;$T;%iT;&iX;'@ Ú;*To;;F; ;;;;I"OpenSSL::PKey::DSA#params;F;[;[[@›×iŸ;T;;ß;0;[;{;IC;"{Stores all parameters of key to the hash INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don't use :-)) (I's up to you) ;T;[o;= ;3I" overload;F;40;;ß;50;)I"params;T;IC;";T; @ Û;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @ Û;[;I"@return [Hash];T;0;6i;[; @ Û;[;I"šStores all parameters of key to the hash INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don't use :-)) (I's up to you) @overload params @return [Hash];T;0; @ Û;!F;"o;#;$T;%i—;&i;'@ Ú;(I"Pstatic VALUE ossl_dsa_get_params(VALUE self) { DSA *dsa; VALUE hash; const BIGNUM *p, *q, *g, *pub_key, *priv_key; GetDSA(self, dsa); DSA_get0_pqg(dsa, &p, &q, &g); DSA_get0_key(dsa, &pub_key, &priv_key); hash = rb_hash_new(); rb_hash_aset(hash, rb_str_new2("p"), ossl_bn_new(p)); rb_hash_aset(hash, rb_str_new2("q"), ossl_bn_new(q)); rb_hash_aset(hash, rb_str_new2("g"), ossl_bn_new(g)); rb_hash_aset(hash, rb_str_new2("pub_key"), ossl_bn_new(pub_key)); rb_hash_aset(hash, rb_str_new2("priv_key"), ossl_bn_new(priv_key)); return hash; };T;)I"static VALUE;T;*T;A@ Ú;BIC;[;A@ Ú;CIC;[;A@ Ú;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@ðÚ;@åÚ;;I[;[[@›×iq[@›×iw;T;:DSA;;K;;;[;{;IC;"—DSA, the Digital Signature Algorithm, is specified in NIST's FIPS 186-3. It is an asymmetric public key algorithm that may be used similar to e.g. RSA. ;T;[;[;I"™ DSA, the Digital Signature Algorithm, is specified in NIST's FIPS 186-3. It is an asymmetric public key algorithm that may be used similar to e.g. RSA. ;T;0; @ Ú;!F;"o;#;$T;%iq;&iu;'@_Ö;I"OpenSSL::PKey::DSA;F;S@aÖo; ;IC;[;A@ÍÛ;BIC;[;A@ÍÛ;CIC;[;A@ÍÛ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@Èi˜;F;:ECError;;K;;;[;{;IC;";T;[;[;@|;0; @ÍÛ;'@_Ö;I"OpenSSL::PKey::ECError;F;S@§×o; ;IC;[!o; ;IC;[o; ;IC;[;A@âÛ;BIC;[;A@âÛ;CIC;[;A@âÛ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@Èi¬;F;;ê;;K;;;[;{;IC;";T;[;[;@|;0; @âÛ;'@àÛ;I"$OpenSSL::PKey::EC::Group::Error;F;S@ÅÇo;;F; ;;;;I"(OpenSSL::PKey::EC::Group#initialize;F;[[@c0;[[@ÈiÖ;T;;Ð;0;[;{;IC;"Creates a new EC::Group object. _ec_method_ is a symbol that represents an EC_METHOD. Currently the following are supported: * :GFp_simple * :GFp_mont * :GFp_nist * :GF2m_simple If the first argument is :GFp or :GF2m, creates a new curve with given parameters. ;T;[ o;= ;3I" overload;F;40;:!OpenSSL::PKey::EC::Group.new;50;)I"+OpenSSL::PKey::EC::Group.new(ec_group);T;IC;";T; @óÛ;>0;!F;[;[;I";T;0;6i;[[I" ec_group;T0; @óÛo;= ;3I" overload;F;40;;(;50;)I"5OpenSSL::PKey::EC::Group.new(pem_or_der_encoded);T;IC;";T; @óÛ;>0;!F;[;[;I";T;0;6i;[[I"pem_or_der_encoded;T0; @óÛo;= ;3I" overload;F;40;;(;50;)I",OpenSSL::PKey::EC::Group.new(ec_method);T;IC;";T; @óÛ;>0;!F;[;[;I";T;0;6i;[[I"ec_method;T0; @óÛo;= ;3I" overload;F;40;;(;50;)I"EOpenSSL::PKey::EC::Group.new(:GFp, bignum_p, bignum_a, bignum_b);T;IC;";T; @óÛ;>0;!F;[;[;I";T;0;6i;[ [I":;TI"GFp;T[I" bignum_p;T0[I" bignum_a;T0[I" bignum_b;T0; @óÛo;= ;3I" overload;F;40;;(;50;)I"FOpenSSL::PKey::EC::Group.new(:GF2m, bignum_p, bignum_a, bignum_b);T;IC;";T; @óÛ;>0;!F;[;[;I";T;0;6i;[ [I":;TI" GF2m;T[I" bignum_p;T0[I" bignum_a;T0[I" bignum_b;T0; @óÛ;[;I">Creates a new EC::Group object. _ec_method_ is a symbol that represents an EC_METHOD. Currently the following are supported: * :GFp_simple * :GFp_mont * :GFp_nist * :GF2m_simple If the first argument is :GFp or :GF2m, creates a new curve with given parameters. @overload OpenSSL::PKey::EC::Group.new(ec_group) @overload OpenSSL::PKey::EC::Group.new(pem_or_der_encoded) @overload OpenSSL::PKey::EC::Group.new(ec_method) @overload OpenSSL::PKey::EC::Group.new(:GFp, bignum_p, bignum_a, bignum_b) @overload OpenSSL::PKey::EC::Group.new(:GF2m, bignum_p, bignum_a, bignum_b);T;0; @óÛ;!F;"o;#;$T;%iÁ;&iÓ;'@àÛ;(I"Ò static VALUE ossl_ec_group_initialize(int argc, VALUE *argv, VALUE self) { VALUE arg1, arg2, arg3, arg4; EC_GROUP *group; TypedData_Get_Struct(self, EC_GROUP, &ossl_ec_group_type, group); if (group) ossl_raise(rb_eRuntimeError, "EC_GROUP is already initialized"); switch (rb_scan_args(argc, argv, "13", &arg1, &arg2, &arg3, &arg4)) { case 1: if (SYMBOL_P(arg1)) { const EC_METHOD *method = NULL; ID id = SYM2ID(arg1); if (id == s_GFp_simple) { method = EC_GFp_simple_method(); } else if (id == s_GFp_mont) { method = EC_GFp_mont_method(); } else if (id == s_GFp_nist) { method = EC_GFp_nist_method(); #if !defined(OPENSSL_NO_EC2M) } else if (id == s_GF2m_simple) { method = EC_GF2m_simple_method(); #endif } if (method) { if ((group = EC_GROUP_new(method)) == NULL) ossl_raise(eEC_GROUP, "EC_GROUP_new"); } else { ossl_raise(rb_eArgError, "unknown symbol, must be :GFp_simple, :GFp_mont, :GFp_nist or :GF2m_simple"); } } else if (rb_obj_is_kind_of(arg1, cEC_GROUP)) { const EC_GROUP *arg1_group; GetECGroup(arg1, arg1_group); if ((group = EC_GROUP_dup(arg1_group)) == NULL) ossl_raise(eEC_GROUP, "EC_GROUP_dup"); } else { BIO *in = ossl_obj2bio(&arg1); group = PEM_read_bio_ECPKParameters(in, NULL, NULL, NULL); if (!group) { OSSL_BIO_reset(in); group = d2i_ECPKParameters_bio(in, NULL); } BIO_free(in); if (!group) { const char *name = StringValueCStr(arg1); int nid = OBJ_sn2nid(name); ossl_clear_error(); /* ignore errors in d2i_ECPKParameters_bio() */ if (nid == NID_undef) ossl_raise(eEC_GROUP, "unknown curve name (%"PRIsVALUE")", arg1); group = EC_GROUP_new_by_curve_name(nid); if (group == NULL) ossl_raise(eEC_GROUP, "unable to create curve (%"PRIsVALUE")", arg1); EC_GROUP_set_asn1_flag(group, OPENSSL_EC_NAMED_CURVE); EC_GROUP_set_point_conversion_form(group, POINT_CONVERSION_UNCOMPRESSED); } } break; case 4: if (SYMBOL_P(arg1)) { ID id = SYM2ID(arg1); EC_GROUP *(*new_curve)(const BIGNUM *, const BIGNUM *, const BIGNUM *, BN_CTX *) = NULL; const BIGNUM *p = GetBNPtr(arg2); const BIGNUM *a = GetBNPtr(arg3); const BIGNUM *b = GetBNPtr(arg4); if (id == s_GFp) { new_curve = EC_GROUP_new_curve_GFp; #if !defined(OPENSSL_NO_EC2M) } else if (id == s_GF2m) { new_curve = EC_GROUP_new_curve_GF2m; #endif } else { ossl_raise(rb_eArgError, "unknown symbol, must be :GFp or :GF2m"); } if ((group = new_curve(p, a, b, ossl_bn_ctx)) == NULL) ossl_raise(eEC_GROUP, "EC_GROUP_new_by_GF*"); } else { ossl_raise(rb_eArgError, "unknown argument, must be :GFp or :GF2m"); } break; default: ossl_raise(rb_eArgError, "wrong number of arguments"); } if (group == NULL) ossl_raise(eEC_GROUP, ""); RTYPEDDATA_DATA(self) = group; return self; };T;)I"Mstatic VALUE ossl_ec_group_initialize(int argc, VALUE *argv, VALUE self);T;*To;;F; ;;;;I"-OpenSSL::PKey::EC::Group#initialize_copy;F;[[I" other;T0;[[@Èi>;T;;g;0;[;{;IC;";T;[;[;@|;0; @BÜ;'@àÛ;(I"¸static VALUE ossl_ec_group_initialize_copy(VALUE self, VALUE other) { EC_GROUP *group, *group_new; TypedData_Get_Struct(self, EC_GROUP, &ossl_ec_group_type, group_new); if (group_new) ossl_raise(eEC_GROUP, "EC::Group already initialized"); GetECGroup(other, group); group_new = EC_GROUP_dup(group); if (!group_new) ossl_raise(eEC_GROUP, "EC_GROUP_dup"); RTYPEDDATA_DATA(self) = group_new; return self; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::PKey::EC::Group#eql?;F;[[I"b;T0;[[@ÈiX;T;;_;0;[;{;IC;"iReturns +true+ if the two groups use the same curve and have the same parameters, +false+ otherwise.;T;[o;= ;3I" overload;F;40;;_;50;)I"eql?(group2);T;IC;";T; @PÜ;>0;!F;[;[;I";T;0;6i;[[I"group2;T0; @PÜo;= ;3I" overload;F;40;;`;50;)I"==(group2);T;IC;";T; @PÜ;>0;!F;[;[;I";T;0;6i;[[I"group2;T0; @PÜo;2 ;3I"return;F;4@|;0;5[@~; @PÜ;[;I"’Returns +true+ if the two groups use the same curve and have the same parameters, +false+ otherwise. @overload eql?(group2) @overload ==(group2);T;0; o;;F; ;;;;I" OpenSSL::PKey::EC::Group#==;F;[;[[@Èiê;F;;`;;K;[;{;@YÜ;'@àÛ;)I"5static VALUE ossl_ec_group_eql(VALUE a, VALUE b);T;(I"ústatic VALUE ossl_ec_group_eql(VALUE a, VALUE b) { EC_GROUP *group1 = NULL, *group2 = NULL; GetECGroup(a, group1); GetECGroup(b, group2); if (EC_GROUP_cmp(group1, group2, ossl_bn_ctx) == 1) return Qfalse; return Qtrue; };T;!F;"o;#;$T;%iP;&iU;6i;'@àÛ;(I"ústatic VALUE ossl_ec_group_eql(VALUE a, VALUE b) { EC_GROUP *group1 = NULL, *group2 = NULL; GetECGroup(a, group1); GetECGroup(b, group2); if (EC_GROUP_cmp(group1, group2, ossl_bn_ctx) == 1) return Qfalse; return Qtrue; };T;)@{Ü;*T@tÜo;;F; ;;;;I"'OpenSSL::PKey::EC::Group#generator;F;[;[[@Èim;T;:generator;0;[;{;IC;"eReturns the generator of the group. See the OpenSSL documentation for EC_GROUP_get0_generator() ;T;[o;= ;3I" overload;F;40;;);50;)I"generator;T;IC;";T; @Ü;>0;!F;[;[;I";T;0;6i;[; @Ü;[;I"{Returns the generator of the group. See the OpenSSL documentation for EC_GROUP_get0_generator() @overload generator;T;0; @Ü;!F;"o;#;$T;%ie;&ij;'@àÛ;(I"static VALUE ossl_ec_group_get_generator(VALUE self) { EC_GROUP *group; const EC_POINT *generator; GetECGroup(self, group); generator = EC_GROUP_get0_generator(group); if (!generator) return Qnil; return ec_point_new(generator, group); };T;)I"9static VALUE ossl_ec_group_get_generator(VALUE self);T;*To;;F; ;;;;I"+OpenSSL::PKey::EC::Group#set_generator;F;[[I"generator;T0[I" order;T0[I" cofactor;T0;[[@Èiƒ;T;:set_generator;0;[;{;IC;"¾Sets the curve parameters. _generator_ must be an instance of EC::Point that is on the curve. _order_ and _cofactor_ are integers. See the OpenSSL documentation for EC_GROUP_set_generator() ;T;[o;= ;3I" overload;F;40;;*;50;)I".set_generator(generator, order, cofactor);T;IC;";T; @•Ü;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @•Ü;[;I"@return [self];T;0;6i;[[I"generator;T0[I" order;T0[I" cofactor;T0; @•Ü;[;I"Sets the curve parameters. _generator_ must be an instance of EC::Point that is on the curve. _order_ and _cofactor_ are integers. See the OpenSSL documentation for EC_GROUP_set_generator() @overload set_generator(generator, order, cofactor) @return [self];T;0; @•Ü;!F;"o;#;$T;%iz;&i;'@àÛ;(I"³static VALUE ossl_ec_group_set_generator(VALUE self, VALUE generator, VALUE order, VALUE cofactor) { EC_GROUP *group = NULL; const EC_POINT *point; const BIGNUM *o, *co; GetECGroup(self, group); GetECPoint(generator, point); o = GetBNPtr(order); co = GetBNPtr(cofactor); if (EC_GROUP_set_generator(group, point, o, co) != 1) ossl_raise(eEC_GROUP, "EC_GROUP_set_generator"); return self; };T;)I"gstatic VALUE ossl_ec_group_set_generator(VALUE self, VALUE generator, VALUE order, VALUE cofactor);T;*To;;F; ;;;;I"#OpenSSL::PKey::EC::Group#order;F;[;[[@Èiœ;T;: order;0;[;{;IC;"\Returns the order of the group. See the OpenSSL documentation for EC_GROUP_get_order() ;T;[o;= ;3I" overload;F;40;:get_order;50;)I"get_order;T;IC;";T; @¼Ü;>0;!F;[;[;I";T;0;6i;[; @¼Ü;[;I"rReturns the order of the group. See the OpenSSL documentation for EC_GROUP_get_order() @overload get_order;T;0; @¼Ü;!F;"o;#;$T;%i”;&i™;'@àÛ;(I"Ostatic VALUE ossl_ec_group_get_order(VALUE self) { VALUE bn_obj; BIGNUM *bn; EC_GROUP *group = NULL; GetECGroup(self, group); bn_obj = ossl_bn_new(NULL); bn = GetBNPtr(bn_obj); if (EC_GROUP_get_order(group, bn, ossl_bn_ctx) != 1) ossl_raise(eEC_GROUP, "EC_GROUP_get_order"); return bn_obj; };T;)I"5static VALUE ossl_ec_group_get_order(VALUE self);T;*To;;F; ;;;;I"&OpenSSL::PKey::EC::Group#cofactor;F;[;[[@Èiµ;T;: cofactor;0;[;{;IC;"bReturns the cofactor of the group. See the OpenSSL documentation for EC_GROUP_get_cofactor() ;T;[o;= ;3I" overload;F;40;:get_cofactor;50;)I"get_cofactor;T;IC;";T; @ÒÜ;>0;!F;[;[;I";T;0;6i;[; @ÒÜ;[;I"{Returns the cofactor of the group. See the OpenSSL documentation for EC_GROUP_get_cofactor() @overload get_cofactor;T;0; @ÒÜ;!F;"o;#;$T;%i;&i²;'@àÛ;(I"Xstatic VALUE ossl_ec_group_get_cofactor(VALUE self) { VALUE bn_obj; BIGNUM *bn; EC_GROUP *group = NULL; GetECGroup(self, group); bn_obj = ossl_bn_new(NULL); bn = GetBNPtr(bn_obj); if (EC_GROUP_get_cofactor(group, bn, ossl_bn_ctx) != 1) ossl_raise(eEC_GROUP, "EC_GROUP_get_cofactor"); return bn_obj; };T;)I"8static VALUE ossl_ec_group_get_cofactor(VALUE self);T;*To;;F; ;;;;I"(OpenSSL::PKey::EC::Group#curve_name;F;[;[[@ÈiÎ;T;:curve_name;0;[;{;IC;"^Returns the curve name (sn). See the OpenSSL documentation for EC_GROUP_get_curve_name() ;T;[o;= ;3I" overload;F;40;;/;50;)I"curve_name;T;IC;";T; @èÜ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @èÜ;[;I"@return [String];T;0;6i;[; @èÜ;[;I"ƒReturns the curve name (sn). See the OpenSSL documentation for EC_GROUP_get_curve_name() @overload curve_name @return [String];T;0; @èÜ;!F;"o;#;$T;%iÆ;&iÌ;'@àÛ;(I"=static VALUE ossl_ec_group_get_curve_name(VALUE self) { EC_GROUP *group = NULL; int nid; GetECGroup(self, group); if (group == NULL) return Qnil; nid = EC_GROUP_get_curve_name(group); /* BUG: an nid or asn1 object should be returned, maybe. */ return rb_str_new2(OBJ_nid2sn(nid)); };T;)I":static VALUE ossl_ec_group_get_curve_name(VALUE self);T;*To;;F; ;;;;I"'OpenSSL::PKey::EC::Group#asn1_flag;F;[;[[@Èi ;T;:asn1_flag;0;[;{;IC;"?Returns the flags set on the group. See also #asn1_flag=. ;T;[o;= ;3I" overload;F;40;;0;50;)I"asn1_flag;T;IC;";T; @Ý;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ý;[;I"@return [Integer];T;0;6i;[; @Ý;[;I"iReturns the flags set on the group. See also #asn1_flag=. @overload asn1_flag @return [Integer];T;0; @Ý;!F;"o;#;$T;%i;&i;'@àÛ;(I"Åstatic VALUE ossl_ec_group_get_asn1_flag(VALUE self) { EC_GROUP *group = NULL; int flag; GetECGroup(self, group); flag = EC_GROUP_get_asn1_flag(group); return INT2NUM(flag); };T;)I"9static VALUE ossl_ec_group_get_asn1_flag(VALUE self);T;*To;;F; ;;;;I"(OpenSSL::PKey::EC::Group#asn1_flag=;F;[[I"flag_v;T0;[[@Èi#;T;:asn1_flag=;0;[;{;IC;"Sets flags on the group. The flag value is used to determine how to encode the group: encode explicit parameters or named curve using an OID. The flag value can be either of: * EC::NAMED_CURVE * EC::EXPLICIT_CURVE See the OpenSSL documentation for EC_GROUP_set_asn1_flag(). ;T;[o;= ;3I" overload;F;40;;1;50;)I"asn1_flag=(flags);T;IC;";T; @Ý;>0;!F;[;[;I";T;0;6i;[[I" flags;T0; @Ý;[;I"2Sets flags on the group. The flag value is used to determine how to encode the group: encode explicit parameters or named curve using an OID. The flag value can be either of: * EC::NAMED_CURVE * EC::EXPLICIT_CURVE See the OpenSSL documentation for EC_GROUP_set_asn1_flag(). @overload asn1_flag=(flags);T;0; @Ý;!F;"o;#;$T;%i;&i ;'@àÛ;(I"Èstatic VALUE ossl_ec_group_set_asn1_flag(VALUE self, VALUE flag_v) { EC_GROUP *group = NULL; GetECGroup(self, group); EC_GROUP_set_asn1_flag(group, NUM2INT(flag_v)); return flag_v; };T;)I"Gstatic VALUE ossl_ec_group_set_asn1_flag(VALUE self, VALUE flag_v);T;*To;;F; ;;;;I"3OpenSSL::PKey::EC::Group#point_conversion_form;F;[;[[@Èi5;T;:point_conversion_form;0;[;{;IC;"`Returns the form how EC::Point data is encoded as ASN.1. See also #point_conversion_form=. ;T;[o;= ;3I" overload;F;40;;2;50;)I"point_conversion_form;T;IC;";T; @8Ý;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Symbol;T; @8Ý;[;I"@return [Symbol];T;0;6i;[; @8Ý;[;I"Returns the form how EC::Point data is encoded as ASN.1. See also #point_conversion_form=. @overload point_conversion_form @return [Symbol];T;0; @8Ý;!F;"o;#;$T;%i-;&i3;'@àÛ;(I"Lstatic VALUE ossl_ec_group_get_point_conversion_form(VALUE self) { EC_GROUP *group = NULL; point_conversion_form_t form; VALUE ret; GetECGroup(self, group); form = EC_GROUP_get_point_conversion_form(group); switch (form) { case POINT_CONVERSION_UNCOMPRESSED: ret = ID_uncompressed; break; case POINT_CONVERSION_COMPRESSED: ret = ID_compressed; break; case POINT_CONVERSION_HYBRID: ret = ID_hybrid; break; default: ossl_raise(eEC_GROUP, "unsupported point conversion form: %d, this module should be updated", form); } return ID2SYM(ret); };T;)I"Estatic VALUE ossl_ec_group_get_point_conversion_form(VALUE self);T;*To;;F; ;;;;I"4OpenSSL::PKey::EC::Group#point_conversion_form=;F;[[I"form_v;T0;[[@Èik;T;:point_conversion_form=;0;[;{;IC;"ôSets the form how EC::Point data is encoded as ASN.1 as defined in X9.62. _format_ can be one of these: +:compressed+:: Encoded as z||x, where z is an octet indicating which solution of the equation y is. z will be 0x02 or 0x03. +:uncompressed+:: Encoded as z||x||y, where z is an octet 0x04. +:hybrid+:: Encodes as z||x||y, where z is an octet indicating which solution of the equation y is. z will be 0x06 or 0x07. See the OpenSSL documentation for EC_GROUP_set_point_conversion_form() ;T;[o;= ;3I" overload;F;40;;3;50;)I"!point_conversion_form=(form);T;IC;";T; @SÝ;>0;!F;[;[;I";T;0;6i;[[I" form;T0; @SÝ;[;I"Sets the form how EC::Point data is encoded as ASN.1 as defined in X9.62. _format_ can be one of these: +:compressed+:: Encoded as z||x, where z is an octet indicating which solution of the equation y is. z will be 0x02 or 0x03. +:uncompressed+:: Encoded as z||x||y, where z is an octet 0x04. +:hybrid+:: Encodes as z||x||y, where z is an octet indicating which solution of the equation y is. z will be 0x06 or 0x07. See the OpenSSL documentation for EC_GROUP_set_point_conversion_form() @overload point_conversion_form=(form);T;0; @SÝ;!F;"o;#;$T;%iX;&ih;'@àÛ;(I"(static VALUE ossl_ec_group_set_point_conversion_form(VALUE self, VALUE form_v) { EC_GROUP *group; point_conversion_form_t form; GetECGroup(self, group); form = parse_point_conversion_form_symbol(form_v); EC_GROUP_set_point_conversion_form(group, form); return form_v; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::PKey::EC::Group#seed;F;[;[[@Èi;T;: seed;0;[;{;IC;";See the OpenSSL documentation for EC_GROUP_get0_seed() ;T;[o;= ;3I" overload;F;40;;4;50;)I" seed;T;IC;";T; @mÝ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @mÝ;[;I"@return [String, nil];T;0;6i;[; @mÝ;[;I"dSee the OpenSSL documentation for EC_GROUP_get0_seed() @overload seed @return [String, nil];T;0; @mÝ;!F;"o;#;$T;%iy;&i};'@àÛ;(I"'static VALUE ossl_ec_group_get_seed(VALUE self) { EC_GROUP *group = NULL; size_t seed_len; GetECGroup(self, group); seed_len = EC_GROUP_get_seed_len(group); if (seed_len == 0) return Qnil; return rb_str_new((const char *)EC_GROUP_get0_seed(group), seed_len); };T;)I"4static VALUE ossl_ec_group_get_seed(VALUE self);T;*To;;F; ;;;;I"#OpenSSL::PKey::EC::Group#seed=;F;[[I" seed;T0;[[@Èi“;T;: seed=;0;[;{;IC;":See the OpenSSL documentation for EC_GROUP_set_seed() ;T;[o;= ;3I" overload;F;40;;5;50;)I"seed=(seed);T;IC;";T; @‰Ý;>0;!F;[;[;I";T;0;6i;[[I" seed;T0; @‰Ý;[;I"RSee the OpenSSL documentation for EC_GROUP_set_seed() @overload seed=(seed);T;0; @‰Ý;!F;"o;#;$T;%i;&i;'@àÛ;(I"Mstatic VALUE ossl_ec_group_set_seed(VALUE self, VALUE seed) { EC_GROUP *group = NULL; GetECGroup(self, group); StringValue(seed); if (EC_GROUP_set_seed(group, (unsigned char *)RSTRING_PTR(seed), RSTRING_LEN(seed)) != (size_t)RSTRING_LEN(seed)) ossl_raise(eEC_GROUP, "EC_GROUP_set_seed"); return seed; };T;)I"@static VALUE ossl_ec_group_set_seed(VALUE self, VALUE seed);T;*To;;F; ;;;;I"$OpenSSL::PKey::EC::Group#degree;F;[;[[@Èi¨;T;:degree;0;[;{;IC;"0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @£Ý;[;I"@return [Integer];T;0;6i;[; @£Ý;[;I"cSee the OpenSSL documentation for EC_GROUP_get_degree() @overload degree @return [Integer];T;0; @£Ý;!F;"o;#;$T;%i¢;&i¦;'@àÛ;(I" static VALUE ossl_ec_group_get_degree(VALUE self) { EC_GROUP *group = NULL; GetECGroup(self, group); return INT2NUM(EC_GROUP_get_degree(group)); };T;)I"6static VALUE ossl_ec_group_get_degree(VALUE self);T;*To;;F; ;;;;I"$OpenSSL::PKey::EC::Group#to_pem;F;[;[[@ÈiÙ;T;;³;0;[;{;IC;"ESee the OpenSSL documentation for PEM_write_bio_ECPKParameters() ;T;[o;= ;3I" overload;F;40;;³;50;)I"to_pem;T;IC;";T; @¾Ý;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @¾Ý;[;I"@return [String];T;0;6i;[; @¾Ý;[;I"l See the OpenSSL documentation for PEM_write_bio_ECPKParameters() @overload to_pem @return [String];T;0; @¾Ý;!F;"o;#;$T;%iÓ;&i×;'@àÛ;(I"lstatic VALUE ossl_ec_group_to_pem(VALUE self) { return ossl_ec_group_to_string(self, EXPORT_PEM); };T;)I"2static VALUE ossl_ec_group_to_pem(VALUE self);T;*To;;F; ;;;;I"$OpenSSL::PKey::EC::Group#to_der;F;[;[[@Èiä;T;;°;0;[;{;IC;"?See the OpenSSL documentation for i2d_ECPKParameters_bio() ;T;[o;= ;3I" overload;F;40;;°;50;)I"to_der;T;IC;";T; @ÙÝ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ÙÝ;[;I"@return [String];T;0;6i;[; @ÙÝ;[;I"eSee the OpenSSL documentation for i2d_ECPKParameters_bio() @overload to_der @return [String];T;0; @ÙÝ;!F;"o;#;$T;%iÞ;&iâ;'@àÛ;(I"lstatic VALUE ossl_ec_group_to_der(VALUE self) { return ossl_ec_group_to_string(self, EXPORT_DER); };T;)I"2static VALUE ossl_ec_group_to_der(VALUE self);T;*To;;F; ;;;;I"%OpenSSL::PKey::EC::Group#to_text;F;[;[[@Èiï;T;;´;0;[;{;IC;"=See the OpenSSL documentation for ECPKParameters_print() ;T;[o;= ;3I" overload;F;40;;´;50;)I"to_text;T;IC;";T; @ôÝ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ôÝ;[;I"@return [String];T;0;6i;[; @ôÝ;[;I"dSee the OpenSSL documentation for ECPKParameters_print() @overload to_text @return [String];T;0; @ôÝ;!F;"o;#;$T;%ié;&ií;'@àÛ;(I"vstatic VALUE ossl_ec_group_to_text(VALUE self) { EC_GROUP *group; BIO *out; VALUE str; GetECGroup(self, group); if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eEC_GROUP, "BIO_new(BIO_s_mem())"); } if (!ECPKParameters_print(out, group, 0)) { BIO_free(out); ossl_raise(eEC_GROUP, NULL); } str = ossl_membio2str(out); return str; };T;)I"3static VALUE ossl_ec_group_to_text(VALUE self);T;*T;A@àÛ;BIC;[;A@àÛ;CIC;[;A@àÛ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@tÜ;_;I[;[[@Èiª;F;: Group;;K;;;[;{;IC;";T;[;[;@|;0; @àÛ;6i;'@ÞÛ;I"OpenSSL::PKey::EC::Group;F;S@]o; ;IC;[o; ;IC;[;A@ Þ;BIC;[;A@ Þ;CIC;[;A@ Þ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@Èi;F;;ê;;K;;;[;{;IC;";T;[;[;@|;0; @ Þ;'@Þ;I"$OpenSSL::PKey::EC::Point::Error;F;S@ÅÇo;;F; ;;;;I"(OpenSSL::PKey::EC::Point#initialize;F;[[@c0;[[@Èi7;T;;Ð;0;[;{;IC;"Creates a new instance of OpenSSL::PKey::EC::Point. If the only argument is an instance of EC::Point, a copy is returned. Otherwise, creates a point that belongs to _group_. _encoded_point_ is the octet string representation of the point. This must be either a String or an OpenSSL::BN. ;T;[o;= ;3I" overload;F;40;:!OpenSSL::PKey::EC::Point.new;50;)I"(OpenSSL::PKey::EC::Point.new(point);T;IC;";T; @1Þ;>0;!F;[;[;I";T;0;6i;[[I" point;T0; @1Þo;= ;3I" overload;F;40;;8;50;)I":OpenSSL::PKey::EC::Point.new(group [, encoded_point]);T;IC;";T; @1Þ;>0;!F;[;[;I";T;0;6i;[[I"group[, encoded_point];T0; @1Þ;[;I"Creates a new instance of OpenSSL::PKey::EC::Point. If the only argument is an instance of EC::Point, a copy is returned. Otherwise, creates a point that belongs to _group_. _encoded_point_ is the octet string representation of the point. This must be either a String or an OpenSSL::BN. @overload OpenSSL::PKey::EC::Point.new(point) @overload OpenSSL::PKey::EC::Point.new(group [, encoded_point]);T;0; @1Þ;!F;"o;#;$T;%i+;&i4;'@Þ;(I"static VALUE ossl_ec_point_initialize(int argc, VALUE *argv, VALUE self) { EC_POINT *point; VALUE group_v, arg2; const EC_GROUP *group; TypedData_Get_Struct(self, EC_POINT, &ossl_ec_point_type, point); if (point) rb_raise(eEC_POINT, "EC_POINT already initialized"); rb_scan_args(argc, argv, "11", &group_v, &arg2); if (rb_obj_is_kind_of(group_v, cEC_POINT)) { if (argc != 1) rb_raise(rb_eArgError, "invalid second argument"); return ossl_ec_point_initialize_copy(self, group_v); } GetECGroup(group_v, group); if (argc == 1) { point = EC_POINT_new(group); if (!point) ossl_raise(eEC_POINT, "EC_POINT_new"); } else { if (rb_obj_is_kind_of(arg2, cBN)) { point = EC_POINT_bn2point(group, GetBNPtr(arg2), NULL, ossl_bn_ctx); if (!point) ossl_raise(eEC_POINT, "EC_POINT_bn2point"); } else { StringValue(arg2); point = EC_POINT_new(group); if (!point) ossl_raise(eEC_POINT, "EC_POINT_new"); if (!EC_POINT_oct2point(group, point, (unsigned char *)RSTRING_PTR(arg2), RSTRING_LEN(arg2), ossl_bn_ctx)) { EC_POINT_free(point); ossl_raise(eEC_POINT, "EC_POINT_oct2point"); } } } RTYPEDDATA_DATA(self) = point; rb_ivar_set(self, id_i_group, group_v); return self; };T;)I"Mstatic VALUE ossl_ec_point_initialize(int argc, VALUE *argv, VALUE self);T;*To;;F; ;;;;I"-OpenSSL::PKey::EC::Point#initialize_copy;F;[[I" other;T0;[[@Èih;T;;g;0;[;{;IC;";T;[;[;@|;0; @TÞ;'@Þ;(I"nstatic VALUE ossl_ec_point_initialize_copy(VALUE self, VALUE other) { EC_POINT *point, *point_new; EC_GROUP *group; VALUE group_v; TypedData_Get_Struct(self, EC_POINT, &ossl_ec_point_type, point_new); if (point_new) ossl_raise(eEC_POINT, "EC::Point already initialized"); GetECPoint(other, point); group_v = rb_obj_dup(rb_attr_get(other, id_i_group)); GetECGroup(group_v, group); point_new = EC_POINT_dup(point, group); if (!point_new) ossl_raise(eEC_POINT, "EC_POINT_dup"); RTYPEDDATA_DATA(self) = point_new; rb_ivar_set(self, id_i_group, group_v); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::PKey::EC::Point#eql?;F;[[I"b;T0;[[@Èi…;T;;_;0;[;{;IC;";T;[o;= ;3I" overload;F;40;;_;50;)I"eql?(point2);T;IC;";T; @bÞ;>0;!F;[;[;I";T;0;6i;[[I"point2;T0; @bÞo;= ;3I" overload;F;40;;`;50;)I"==(point2);T;IC;";T; @bÞ;>0;!F;[;[;I";T;0;6i;[[I"point2;T0; @bÞo;2 ;3I"return;F;4@|;0;5[@~; @bÞ;[;I"1 @overload eql?(point2) @overload ==(point2);T;0; o;;F; ;;;;I" OpenSSL::PKey::EC::Point#==;F;[;[[@Èi;F;;`;;K;[;{;@kÞ;'@Þ;)I"5static VALUE ossl_ec_point_eql(VALUE a, VALUE b);T;(I"ãstatic VALUE ossl_ec_point_eql(VALUE a, VALUE b) { EC_POINT *point1, *point2; VALUE group_v1 = rb_attr_get(a, id_i_group); VALUE group_v2 = rb_attr_get(b, id_i_group); const EC_GROUP *group; if (ossl_ec_group_eql(group_v1, group_v2) == Qfalse) return Qfalse; GetECPoint(a, point1); GetECPoint(b, point2); GetECGroup(group_v1, group); if (EC_POINT_cmp(group, point1, point2, ossl_bn_ctx) == 1) return Qfalse; return Qtrue; };T;!F;"o;#;$T;%i€;&i‚;6i;'@Þ;(I"ãstatic VALUE ossl_ec_point_eql(VALUE a, VALUE b) { EC_POINT *point1, *point2; VALUE group_v1 = rb_attr_get(a, id_i_group); VALUE group_v2 = rb_attr_get(b, id_i_group); const EC_GROUP *group; if (ossl_ec_group_eql(group_v1, group_v2) == Qfalse) return Qfalse; GetECPoint(a, point1); GetECPoint(b, point2); GetECGroup(group_v1, group); if (EC_POINT_cmp(group, point1, point2, ossl_bn_ctx) == 1) return Qfalse; return Qtrue; };T;)@Þ;*T@†Þo;;F; ;;;;I"'OpenSSL::PKey::EC::Point#infinity?;F;[;[[@Èi;T;:infinity?;0;[;{;IC;";T;[o;= ;3I" overload;F;40;;9;50;)I"infinity?;T;IC;";T; @‘Þ;>0;!F;[;[;I";T;0;6i;[; @‘Þo;2 ;3I"return;F;4@|;0;5[@~; @‘Þ;[;I" @overload infinity?;T;0; @‘Þ;!F;"o;#;$T;%i™;&iš;6i;'@Þ;(I"kstatic VALUE ossl_ec_point_is_at_infinity(VALUE self) { EC_POINT *point; const EC_GROUP *group; GetECPoint(self, point); GetECPointGroup(self, group); switch (EC_POINT_is_at_infinity(group, point)) { case 1: return Qtrue; case 0: return Qfalse; default: ossl_raise(cEC_POINT, "EC_POINT_is_at_infinity"); } UNREACHABLE; };T;)I":static VALUE ossl_ec_point_is_at_infinity(VALUE self);T;*To;;F; ;;;;I"'OpenSSL::PKey::EC::Point#on_curve?;F;[;[[@Èi²;T;:on_curve?;0;[;{;IC;";T;[o;= ;3I" overload;F;40;;:;50;)I"on_curve?;T;IC;";T; @ªÞ;>0;!F;[;[;I";T;0;6i;[; @ªÞo;2 ;3I"return;F;4@|;0;5[@~; @ªÞ;[;I" @overload on_curve?;T;0; @ªÞ;!F;"o;#;$T;%i®;&i¯;6i;'@Þ;(I"ostatic VALUE ossl_ec_point_is_on_curve(VALUE self) { EC_POINT *point; const EC_GROUP *group; GetECPoint(self, point); GetECPointGroup(self, group); switch (EC_POINT_is_on_curve(group, point, ossl_bn_ctx)) { case 1: return Qtrue; case 0: return Qfalse; default: ossl_raise(cEC_POINT, "EC_POINT_is_on_curve"); } UNREACHABLE; };T;)I"7static VALUE ossl_ec_point_is_on_curve(VALUE self);T;*To;;F; ;;;;I"*OpenSSL::PKey::EC::Point#make_affine!;F;[;[[@ÈiÇ;T;:make_affine!;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;;50;)I"make_affine!;T;IC;";T; @ÃÞ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @ÃÞ;[;I"@return [self];T;0;6i;[; @ÃÞ;[;I"- @overload make_affine! @return [self];T;0; @ÃÞ;!F;"o;#;$T;%iÃ;&iÅ;'@Þ;(I".static VALUE ossl_ec_point_make_affine(VALUE self) { EC_POINT *point; const EC_GROUP *group; GetECPoint(self, point); GetECPointGroup(self, group); if (EC_POINT_make_affine(group, point, ossl_bn_ctx) != 1) ossl_raise(cEC_POINT, "EC_POINT_make_affine"); return self; };T;)I"7static VALUE ossl_ec_point_make_affine(VALUE self);T;*To;;F; ;;;;I"%OpenSSL::PKey::EC::Point#invert!;F;[;[[@ÈiÙ;T;:invert!;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;<;50;)I"invert!;T;IC;";T; @ÞÞ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @ÞÞ;[;I"@return [self];T;0;6i;[; @ÞÞ;[;I"( @overload invert! @return [self];T;0; @ÞÞ;!F;"o;#;$T;%iÕ;&i×;'@Þ;(I"static VALUE ossl_ec_point_invert(VALUE self) { EC_POINT *point; const EC_GROUP *group; GetECPoint(self, point); GetECPointGroup(self, group); if (EC_POINT_invert(group, point, ossl_bn_ctx) != 1) ossl_raise(cEC_POINT, "EC_POINT_invert"); return self; };T;)I"2static VALUE ossl_ec_point_invert(VALUE self);T;*To;;F; ;;;;I".OpenSSL::PKey::EC::Point#set_to_infinity!;F;[;[[@Èië;T;:set_to_infinity!;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;=;50;)I"set_to_infinity!;T;IC;";T; @ùÞ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @ùÞ;[;I"@return [self];T;0;6i;[; @ùÞ;[;I"1 @overload set_to_infinity! @return [self];T;0; @ùÞ;!F;"o;#;$T;%iç;&ié;'@Þ;(I"-static VALUE ossl_ec_point_set_to_infinity(VALUE self) { EC_POINT *point; const EC_GROUP *group; GetECPoint(self, point); GetECPointGroup(self, group); if (EC_POINT_set_to_infinity(group, point) != 1) ossl_raise(cEC_POINT, "EC_POINT_set_to_infinity"); return self; };T;)I";static VALUE ossl_ec_point_set_to_infinity(VALUE self);T;*To;;F; ;;;;I"-OpenSSL::PKey::EC::Point#to_octet_string;F;[[I"conversion_form;T0;[[@Èi;T;:to_octet_string;0;[;{;IC;"ÁReturns the octet string representation of the elliptic curve point. _conversion_form_ specifies how the point is converted. Possible values are: - +:compressed+ - +:uncompressed+ - +:hybrid+ ;T;[o;= ;3I" overload;F;40;;>;50;)I"%to_octet_string(conversion_form);T;IC;";T; @ß;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ß;[;I"@return [String];T;0;6i;[[I"conversion_form;T0; @ß;[;I"Returns the octet string representation of the elliptic curve point. _conversion_form_ specifies how the point is converted. Possible values are: - +:compressed+ - +:uncompressed+ - +:hybrid+ @overload to_octet_string(conversion_form) @return [String];T;0; @ß;!F;"o;#;$T;%iù;&i;'@Þ;(I" static VALUE ossl_ec_point_to_octet_string(VALUE self, VALUE conversion_form) { EC_POINT *point; const EC_GROUP *group; point_conversion_form_t form; VALUE str; size_t len; GetECPoint(self, point); GetECPointGroup(self, group); form = parse_point_conversion_form_symbol(conversion_form); len = EC_POINT_point2oct(group, point, form, NULL, 0, ossl_bn_ctx); if (!len) ossl_raise(eEC_POINT, "EC_POINT_point2oct"); str = rb_str_new(NULL, (long)len); if (!EC_POINT_point2oct(group, point, form, (unsigned char *)RSTRING_PTR(str), len, ossl_bn_ctx)) ossl_raise(eEC_POINT, "EC_POINT_point2oct"); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"!OpenSSL::PKey::EC::Point#add;F;[[I" other;T0;[[@Èi#;T;:add;0;[;{;IC;",Performs elliptic curve point addition. ;T;[o;= ;3I" overload;F;40;;?;50;)I"add(point);T;IC;";T; @3ß;>0;!F;[;[;I";T;0;6i;[[I" point;T0; @3ß;[;I"CPerforms elliptic curve point addition. @overload add(point);T;0; @3ß;!F;"o;#;$T;%i;&i ;'@Þ;(I"[static VALUE ossl_ec_point_add(VALUE self, VALUE other) { EC_POINT *point_self, *point_other, *point_result; const EC_GROUP *group; VALUE group_v = rb_attr_get(self, id_i_group); VALUE result; GetECPoint(self, point_self); GetECPoint(other, point_other); GetECGroup(group_v, group); result = rb_obj_alloc(cEC_POINT); ossl_ec_point_initialize(1, &group_v, result); GetECPoint(result, point_result); if (EC_POINT_add(group, point_result, point_self, point_other, ossl_bn_ctx) != 1) { ossl_raise(eEC_POINT, "EC_POINT_add"); } return result; };T;)I"bn1 * point + bn2 * G, where +G+ is the generator of the group of _point_. _bn2_ may be omitted, and in that case, the result is just bn1 * point. The second form calculates bns[0] * point + bns[1] * points[0] + ... + bns[-1] * points[-1] + bn2 * G. _bn2_ may be omitted. _bns_ must be an array of OpenSSL::BN. _points_ must be an array of OpenSSL::PKey::EC::Point. Please note that points[0] is not multiplied by bns[0], but bns[1]. ;T;[o;= ;3I" overload;F;40;;@;50;)I"mul(bn1 [, bn2]);T;IC;";T; @Mß;>0;!F;[;[;I";T;0;6i;[[I"bn1[, bn2];T0; @Mßo;= ;3I" overload;F;40;;@;50;)I"mul(bns, points [, bn2]);T;IC;";T; @Mß;>0;!F;[;[;I";T;0;6i;[[I"bns;T0[I"points[, bn2];T0; @Mß;[;I"qPerforms elliptic curve point multiplication. The first form calculates bn1 * point + bn2 * G, where +G+ is the generator of the group of _point_. _bn2_ may be omitted, and in that case, the result is just bn1 * point. The second form calculates bns[0] * point + bns[1] * points[0] + ... + bns[-1] * points[-1] + bn2 * G. _bn2_ may be omitted. _bns_ must be an array of OpenSSL::BN. _points_ must be an array of OpenSSL::PKey::EC::Point. Please note that points[0] is not multiplied by bns[0], but bns[1]. @overload mul(bn1 [, bn2]) @overload mul(bns, points [, bn2]);T;0; @Mß;!F;"o;#;$T;%i9;&iG;'@Þ;(I"Xstatic VALUE ossl_ec_point_mul(int argc, VALUE *argv, VALUE self) { EC_POINT *point_self, *point_result; const EC_GROUP *group; VALUE group_v = rb_attr_get(self, id_i_group); VALUE arg1, arg2, arg3, result; const BIGNUM *bn_g = NULL; GetECPoint(self, point_self); GetECGroup(group_v, group); result = rb_obj_alloc(cEC_POINT); ossl_ec_point_initialize(1, &group_v, result); GetECPoint(result, point_result); rb_scan_args(argc, argv, "12", &arg1, &arg2, &arg3); if (!RB_TYPE_P(arg1, T_ARRAY)) { BIGNUM *bn = GetBNPtr(arg1); if (!NIL_P(arg2)) bn_g = GetBNPtr(arg2); if (EC_POINT_mul(group, point_result, bn_g, point_self, bn, ossl_bn_ctx) != 1) ossl_raise(eEC_POINT, NULL); } else { /* * bignums | arg1[0] | arg1[1] | arg1[2] | ... * points | self | arg2[0] | arg2[1] | ... */ long i, num; VALUE bns_tmp, tmp_p, tmp_b; const EC_POINT **points; const BIGNUM **bignums; Check_Type(arg1, T_ARRAY); Check_Type(arg2, T_ARRAY); if (RARRAY_LEN(arg1) != RARRAY_LEN(arg2) + 1) /* arg2 must be 1 larger */ ossl_raise(rb_eArgError, "bns must be 1 longer than points; see the documentation"); num = RARRAY_LEN(arg1); bns_tmp = rb_ary_tmp_new(num); bignums = ALLOCV_N(const BIGNUM *, tmp_b, num); for (i = 0; i < num; i++) { VALUE item = RARRAY_AREF(arg1, i); bignums[i] = GetBNPtr(item); rb_ary_push(bns_tmp, item); } points = ALLOCV_N(const EC_POINT *, tmp_p, num); points[0] = point_self; /* self */ for (i = 0; i < num - 1; i++) GetECPoint(RARRAY_AREF(arg2, i), points[i + 1]); if (!NIL_P(arg3)) bn_g = GetBNPtr(arg3); if (EC_POINTs_mul(group, point_result, bn_g, num, points, bignums, ossl_bn_ctx) != 1) { ALLOCV_END(tmp_b); ALLOCV_END(tmp_p); ossl_raise(eEC_POINT, NULL); } ALLOCV_END(tmp_b); ALLOCV_END(tmp_p); } return result; };T;)I"Fstatic VALUE ossl_ec_point_mul(int argc, VALUE *argv, VALUE self);T;*T;A@Þ;BIC;[;A@Þ;CIC;[;A@Þ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@†Þ;_;I[;[[@Èi«;F;: Point;;K;;;[;{;IC;";T;[;[;@|;0; @Þ;6i;'@ÞÛ;I"OpenSSL::PKey::EC::Point;F;S@]o;{;[[@Èiº;F;:NAMED_CURVE;;};;;[;{;IC;";T;[;[;@|;0; @ß;'@ÞÛ;I"#OpenSSL::PKey::EC::NAMED_CURVE;F;~I"$INT2NUM(OPENSSL_EC_NAMED_CURVE);To;{;[[@Èi¼;F;:EXPLICIT_CURVE;;};;;[;{;IC;";T;[;[;@|;0; @‹ß;'@ÞÛ;I"&OpenSSL::PKey::EC::EXPLICIT_CURVE;F;~I"'INT2NUM(OPENSSL_EC_EXPLICIT_CURVE);To;;F; ;F;;;I"%OpenSSL::PKey::EC.builtin_curves;F;[;[[@Èiæ;T;:builtin_curves;0;[;{;IC;"“Obtains a list of all predefined curves by the OpenSSL. Curve names are returned as sn. See the OpenSSL documentation for EC_get_builtin_curves(). ;T;[o;= ;3I" overload;F;40;;D;50;)I"builtin_curves;T;IC;";T; @•ß;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @•ß;[;I"@return [Array];T;0;6i;[; @•ß;[;I"ÀObtains a list of all predefined curves by the OpenSSL. Curve names are returned as sn. See the OpenSSL documentation for EC_get_builtin_curves(). @overload builtin_curves @return [Array];T;0; @•ß;!F;"o;#;$T;%iÝ;&iä;'@ÞÛ;(I"÷static VALUE ossl_s_builtin_curves(VALUE self) { EC_builtin_curve *curves = NULL; int n; int crv_len = rb_long2int(EC_get_builtin_curves(NULL, 0)); VALUE ary, ret; curves = ALLOCA_N(EC_builtin_curve, crv_len); if (curves == NULL) return Qnil; if (!EC_get_builtin_curves(curves, crv_len)) ossl_raise(rb_eRuntimeError, "EC_get_builtin_curves"); ret = rb_ary_new2(crv_len); for (n = 0; n < crv_len; n++) { const char *sname = OBJ_nid2sn(curves[n].nid); const char *comment = curves[n].comment; ary = rb_ary_new2(2); rb_ary_push(ary, rb_str_new2(sname)); rb_ary_push(ary, comment ? rb_str_new2(comment) : Qnil); rb_ary_push(ret, ary); } return ret; };T;)I"3static VALUE ossl_s_builtin_curves(VALUE self);T;*To;;F; ;F;;;I"OpenSSL::PKey::EC.generate;F;[[I"arg;T0;[[@Èi–;T;;;0;[;{;IC;"HCreates a new EC instance with a new random private and public key. ;T;[o;= ;3I" overload;F;40;;;50;)I"generate(ec_group);T;IC;";T; @°ß;>0;!F;[;[;I";T;0;6i;[[I" ec_group;T0; @°ßo;= ;3I" overload;F;40;;;50;)I"generate(string);T;IC;";T; @°ß;>0;!F;[;[;I";T;0;6i;[[I"string;T0; @°ß;[;I"}Creates a new EC instance with a new random private and public key. @overload generate(ec_group) @overload generate(string);T;0; @°ß;!F;"o;#;$T;%i;&i“;'@ÞÛ;(I"Wstatic VALUE ossl_ec_key_s_generate(VALUE klass, VALUE arg) { EC_KEY *ec; VALUE obj; ec = ec_key_new_from_group(arg); obj = ec_instance(klass, ec); if (obj == Qfalse) { EC_KEY_free(ec); ossl_raise(eECError, NULL); } if (!EC_KEY_generate_key(ec)) ossl_raise(eECError, "EC_KEY_generate_key"); return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"!OpenSSL::PKey::EC#initialize;F;[[@c0;[[@Èiµ;T;;Ð;0;[;{;IC;"2Creates a new EC object from given arguments. ;T;[o;= ;3I" overload;F;40;:OpenSSL::PKey::EC.new;50;)I"OpenSSL::PKey::EC.new;T;IC;";T; @Ôß;>0;!F;[;[;I";T;0;6i;[; @Ôßo;= ;3I" overload;F;40;;E;50;)I""OpenSSL::PKey::EC.new(ec_key);T;IC;";T; @Ôß;>0;!F;[;[;I";T;0;6i;[[I"ec_key;T0; @Ôßo;= ;3I" overload;F;40;;E;50;)I"$OpenSSL::PKey::EC.new(ec_group);T;IC;";T; @Ôß;>0;!F;[;[;I";T;0;6i;[[I" ec_group;T0; @Ôßo;= ;3I" overload;F;40;;E;50;)I"'OpenSSL::PKey::EC.new("secp112r1");T;IC;";T; @Ôß;>0;!F;[;[;I";T;0;6i;[[""secp112r1"0; @Ôßo;= ;3I" overload;F;40;;E;50;)I".OpenSSL::PKey::EC.new(pem_string [, pwd]);T;IC;";T; @Ôß;>0;!F;[;[;I";T;0;6i;[[I"pem_string[, pwd];T0; @Ôßo;= ;3I" overload;F;40;;E;50;)I"&OpenSSL::PKey::EC.new(der_string);T;IC;";T; @Ôß;>0;!F;[;[;I";T;0;6i;[[I"der_string;T0; @Ôß;[;I".Creates a new EC object from given arguments. @overload OpenSSL::PKey::EC.new @overload OpenSSL::PKey::EC.new(ec_key) @overload OpenSSL::PKey::EC.new(ec_group) @overload OpenSSL::PKey::EC.new("secp112r1") @overload OpenSSL::PKey::EC.new(pem_string [, pwd]) @overload OpenSSL::PKey::EC.new(der_string);T;0; @Ôß;!F;"o;#;$T;%iª;&i²;'@ÞÛ;(I"9static VALUE ossl_ec_key_initialize(int argc, VALUE *argv, VALUE self) { EVP_PKEY *pkey; EC_KEY *ec; VALUE arg, pass; GetPKey(self, pkey); if (EVP_PKEY_base_id(pkey) != EVP_PKEY_NONE) ossl_raise(eECError, "EC_KEY already initialized"); rb_scan_args(argc, argv, "02", &arg, &pass); if (NIL_P(arg)) { if (!(ec = EC_KEY_new())) ossl_raise(eECError, NULL); } else if (rb_obj_is_kind_of(arg, cEC)) { EC_KEY *other_ec = NULL; GetEC(arg, other_ec); if (!(ec = EC_KEY_dup(other_ec))) ossl_raise(eECError, NULL); } else if (rb_obj_is_kind_of(arg, cEC_GROUP)) { ec = ec_key_new_from_group(arg); } else { BIO *in; pass = ossl_pem_passwd_value(pass); in = ossl_obj2bio(&arg); ec = PEM_read_bio_ECPrivateKey(in, NULL, ossl_pem_passwd_cb, (void *)pass); if (!ec) { OSSL_BIO_reset(in); ec = PEM_read_bio_EC_PUBKEY(in, NULL, ossl_pem_passwd_cb, (void *)pass); } if (!ec) { OSSL_BIO_reset(in); ec = d2i_ECPrivateKey_bio(in, NULL); } if (!ec) { OSSL_BIO_reset(in); ec = d2i_EC_PUBKEY_bio(in, NULL); } BIO_free(in); if (!ec) { ossl_clear_error(); ec = ec_key_new_from_group(arg); } } if (!EVP_PKEY_assign_EC_KEY(pkey, ec)) { EC_KEY_free(ec); ossl_raise(eECError, "EVP_PKEY_assign_EC_KEY"); } return self; };T;)I"Kstatic VALUE ossl_ec_key_initialize(int argc, VALUE *argv, VALUE self);T;*To;;F; ;;;;I"&OpenSSL::PKey::EC#initialize_copy;F;[[I" other;T0;[[@Èiï;T;;g;0;[;{;IC;";T;[;[;@|;0; @à;'@ÞÛ;(I"èstatic VALUE ossl_ec_key_initialize_copy(VALUE self, VALUE other) { EVP_PKEY *pkey; EC_KEY *ec, *ec_new; GetPKey(self, pkey); if (EVP_PKEY_base_id(pkey) != EVP_PKEY_NONE) ossl_raise(eECError, "EC already initialized"); GetEC(other, ec); ec_new = EC_KEY_dup(ec); if (!ec_new) ossl_raise(eECError, "EC_KEY_dup"); if (!EVP_PKEY_assign_EC_KEY(pkey, ec_new)) { EC_KEY_free(ec_new); ossl_raise(eECError, "EVP_PKEY_assign_EC_KEY"); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKey::EC#group;F;[;[[@Èi;T;;Ð;0;[;{;IC;"oReturns the EC::Group that the key is associated with. Modifying the returned group does not affect _key_. ;T;[o;= ;3I" overload;F;40;;Ð;50;)I" group;T;IC;";T; @+à;>0;!F;[;[;I";T;0;6i;[; @+à;[;I"|Returns the EC::Group that the key is associated with. Modifying the returned group does not affect _key_. @overload group;T;0; @+à;!F;"o;#;$T;%i;&i ;'@ÞÛ;(I"Õstatic VALUE ossl_ec_key_get_group(VALUE self) { EC_KEY *ec; const EC_GROUP *group; GetEC(self, ec); group = EC_KEY_get0_group(ec); if (!group) return Qnil; return ec_group_new(group); };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKey::EC#group=;F;[[I"group_v;T0;[[@Èi!;T;:group=;0;[;{;IC;"–Sets the EC::Group for the key. The group structure is internally copied so modification to _group_ after assigning to a key has no effect on the key. ;T;[o;= ;3I" overload;F;40;;F;50;)I"group=(group);T;IC;";T; @Aà;>0;!F;[;[;I";T;0;6i;[[I" group;T0; @Aà;[;I"°Sets the EC::Group for the key. The group structure is internally copied so modification to _group_ after assigning to a key has no effect on the key. @overload group=(group);T;0; @Aà;!F;"o;#;$T;%i;&i;'@ÞÛ;(I"static VALUE ossl_ec_key_set_group(VALUE self, VALUE group_v) { EC_KEY *ec; EC_GROUP *group; GetEC(self, ec); GetECGroup(group_v, group); if (EC_KEY_set_group(ec, group) != 1) ossl_raise(eECError, "EC_KEY_set_group"); return group_v; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::PKey::EC#private_key;F;[;[[@Èi6;T;:private_key;0;[;{;IC;"@See the OpenSSL documentation for EC_KEY_get0_private_key() ;T;[o;= ;3I" overload;F;40;;G;50;)I"private_key;T;IC;";T; @[à;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"OpenSSL::BN;T; @[à;[;I"@return [OpenSSL::BN];T;0;6i;[; @[à;[;I"pSee the OpenSSL documentation for EC_KEY_get0_private_key() @overload private_key @return [OpenSSL::BN];T;0; @[à;!F;"o;#;$T;%i0;&i4;'@ÞÛ;(I"Ústatic VALUE ossl_ec_key_get_private_key(VALUE self) { EC_KEY *ec; const BIGNUM *bn; GetEC(self, ec); if ((bn = EC_KEY_get0_private_key(ec)) == NULL) return Qnil; return ossl_bn_new(bn); };T;)I"9static VALUE ossl_ec_key_get_private_key(VALUE self);T;*To;;F; ;;;;I"#OpenSSL::PKey::EC#private_key=;F;[[I"private_key;T0;[[@ÈiH;T;:private_key=;0;[;{;IC;"?See the OpenSSL documentation for EC_KEY_set_private_key() ;T;[o;= ;3I" overload;F;40;;H;50;)I"private_key=(openssl_bn);T;IC;";T; @và;>0;!F;[;[;I";T;0;6i;[[I"openssl_bn;T0; @và;[;I"dSee the OpenSSL documentation for EC_KEY_set_private_key() @overload private_key=(openssl_bn);T;0; @và;!F;"o;#;$T;%iB;&iE;'@ÞÛ;(I"®static VALUE ossl_ec_key_set_private_key(VALUE self, VALUE private_key) { EC_KEY *ec; BIGNUM *bn = NULL; GetEC(self, ec); if (!NIL_P(private_key)) bn = GetBNPtr(private_key); switch (EC_KEY_set_private_key(ec, bn)) { case 1: break; case 0: if (bn == NULL) break; default: ossl_raise(eECError, "EC_KEY_set_private_key"); } return private_key; };T;)I"Lstatic VALUE ossl_ec_key_set_private_key(VALUE self, VALUE private_key);T;*To;;F; ;;;;I"!OpenSSL::PKey::EC#public_key;F;[;[[@Èid;T;;Â;0;[;{;IC;"?See the OpenSSL documentation for EC_KEY_get0_public_key() ;T;[o;= ;3I" overload;F;40;;Â;50;)I"public_key;T;IC;";T; @à;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"OpenSSL::PKey::EC::Point;T; @à;[;I"'@return [OpenSSL::PKey::EC::Point];T;0;6i;[; @à;[;I"{See the OpenSSL documentation for EC_KEY_get0_public_key() @overload public_key @return [OpenSSL::PKey::EC::Point];T;0; @à;!F;"o;#;$T;%i^;&ib;'@ÞÛ;(I"ûstatic VALUE ossl_ec_key_get_public_key(VALUE self) { EC_KEY *ec; const EC_POINT *point; GetEC(self, ec); if ((point = EC_KEY_get0_public_key(ec)) == NULL) return Qnil; return ec_point_new(point, EC_KEY_get0_group(ec)); };T;)I"8static VALUE ossl_ec_key_get_public_key(VALUE self);T;*To;;F; ;;;;I""OpenSSL::PKey::EC#public_key=;F;[[I"public_key;T0;[[@Èiv;T;;Ã;0;[;{;IC;">See the OpenSSL documentation for EC_KEY_set_public_key() ;T;[o;= ;3I" overload;F;40;;Ã;50;)I"public_key=(ec_point);T;IC;";T; @«à;>0;!F;[;[;I";T;0;6i;[[I" ec_point;T0; @«à;[;I"`See the OpenSSL documentation for EC_KEY_set_public_key() @overload public_key=(ec_point);T;0; @«à;!F;"o;#;$T;%ip;&is;'@ÞÛ;(I"¶static VALUE ossl_ec_key_set_public_key(VALUE self, VALUE public_key) { EC_KEY *ec; EC_POINT *point = NULL; GetEC(self, ec); if (!NIL_P(public_key)) GetECPoint(public_key, point); switch (EC_KEY_set_public_key(ec, point)) { case 1: break; case 0: if (point == NULL) break; default: ossl_raise(eECError, "EC_KEY_set_public_key"); } return public_key; };T;)I"Jstatic VALUE ossl_ec_key_set_public_key(VALUE self, VALUE public_key);T;*To;;F; ;;;;I"OpenSSL::PKey::EC#private?;F;[;[[@Èi£;T;;;0;[;{;IC;"sReturns whether this EC instance has a private key. The private key (BN) can be retrieved with EC#private_key.;T;[o;= ;3I" overload;F;40;;;50;)I" private?;T;IC;";T; @Åà;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Åà;[;I"@return [Boolean];T;0;6i;[; @Åà;[;I"—Returns whether this EC instance has a private key. The private key (BN) can be retrieved with EC#private_key. @overload private? @return [Boolean];T;0; o;;F; ;;;;I"#OpenSSL::PKey::EC#private_key?;F;[;[[@ÈiÎ;F;:private_key?;;K;[;{;@Ìà;'@ÞÛ;)I"4static VALUE ossl_ec_key_is_private(VALUE self);T;(I"“static VALUE ossl_ec_key_is_private(VALUE self) { EC_KEY *ec; GetEC(self, ec); return EC_KEY_get0_private_key(ec) ? Qtrue : Qfalse; };T;!F;"o;#;$T;%iœ;&i¡;6i;'@ÞÛ;(I"“static VALUE ossl_ec_key_is_private(VALUE self) { EC_KEY *ec; GetEC(self, ec); return EC_KEY_get0_private_key(ec) ? Qtrue : Qfalse; };T;)@äà;*To;;F; ;;;;I"OpenSSL::PKey::EC#public?;F;[;[[@Èi“;T;;;0;[;{;IC;"wReturns whether this EC instance has a public key. The public key (EC::Point) can be retrieved with EC#public_key.;T;[o;= ;3I" overload;F;40;;;50;)I"public?;T;IC;";T; @èà;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @èà;[;I"@return [Boolean];T;0;6i;[; @èà;[;I"šReturns whether this EC instance has a public key. The public key (EC::Point) can be retrieved with EC#public_key. @overload public? @return [Boolean];T;0; o;;F; ;;;;I""OpenSSL::PKey::EC#public_key?;F;[;[[@ÈiÏ;F;:public_key?;;K;[;{;@ïà;'@ÞÛ;)I"3static VALUE ossl_ec_key_is_public(VALUE self);T;(I"‘static VALUE ossl_ec_key_is_public(VALUE self) { EC_KEY *ec; GetEC(self, ec); return EC_KEY_get0_public_key(ec) ? Qtrue : Qfalse; };T;!F;"o;#;$T;%iŒ;&i‘;6i;'@ÞÛ;(I"‘static VALUE ossl_ec_key_is_public(VALUE self) { EC_KEY *ec; GetEC(self, ec); return EC_KEY_get0_public_key(ec) ? Qtrue : Qfalse; };T;)@á;*T@Ýà@áo;;F; ;;;;I"$OpenSSL::PKey::EC#generate_key!;F;[;[[@Èi+;T;;;0;[;{;IC;"ýGenerates a new random private and public key. See also the OpenSSL documentation for EC_KEY_generate_key() === Example ec = OpenSSL::PKey::EC.new("prime256v1") p ec.private_key # => nil ec.generate_key! p ec.private_key # => # ;T;[o;= ;3I" overload;F;40;;;50;)I"generate_key!;T;IC;";T; @á;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @á;[;I"@return [self];T;0;6i;[; @á;[;I"(Generates a new random private and public key. See also the OpenSSL documentation for EC_KEY_generate_key() === Example ec = OpenSSL::PKey::EC.new("prime256v1") p ec.private_key # => nil ec.generate_key! p ec.private_key # => # @overload generate_key! @return [self];T;0; o;;F; ;;;;I"#OpenSSL::PKey::EC#generate_key;F;[;[[@ÈiØ;F;:generate_key;;K;[;{;@á;'@ÞÛ;)I"6static VALUE ossl_ec_key_generate_key(VALUE self);T;(I"Ástatic VALUE ossl_ec_key_generate_key(VALUE self) { EC_KEY *ec; GetEC(self, ec); if (EC_KEY_generate_key(ec) != 1) ossl_raise(eECError, "EC_KEY_generate_key"); return self; };T;!F;"o;#;$T;%i;&i);'@ÞÛ;(I"Ástatic VALUE ossl_ec_key_generate_key(VALUE self) { EC_KEY *ec; GetEC(self, ec); if (EC_KEY_generate_key(ec) != 1) ossl_raise(eECError, "EC_KEY_generate_key"); return self; };T;)@*á;*T@#áo;;F; ;;;;I" OpenSSL::PKey::EC#check_key;F;[;[[@Èi>;T;:check_key;0;[;{;IC;"eRaises an exception if the key is invalid. See the OpenSSL documentation for EC_KEY_check_key() ;T;[o;= ;3I" overload;F;40;;L;50;)I"check_key;T;IC;";T; @.á;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" true;T; @.á;[;I"@return [true];T;0;6i;[; @.á;[;I"‡Raises an exception if the key is invalid. See the OpenSSL documentation for EC_KEY_check_key() @overload check_key @return [true];T;0; @.á;!F;"o;#;$T;%i6;&i<;'@ÞÛ;(I"¹static VALUE ossl_ec_key_check_key(VALUE self) { EC_KEY *ec; GetEC(self, ec); if (EC_KEY_check_key(ec) != 1) ossl_raise(eECError, "EC_KEY_check_key"); return Qtrue; };T;)I"3static VALUE ossl_ec_key_check_key(VALUE self);T;*To;;F; ;;;;I"%OpenSSL::PKey::EC#dh_compute_key;F;[[I"pubkey;T0;[[@ÈiO;T;:dh_compute_key;0;[;{;IC;"9See the OpenSSL documentation for ECDH_compute_key() ;T;[o;= ;3I" overload;F;40;;M;50;)I"dh_compute_key(pubkey);T;IC;";T; @Iá;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Iá;[;I"@return [String];T;0;6i;[[I"pubkey;T0; @Iá;[;I"oSee the OpenSSL documentation for ECDH_compute_key() @overload dh_compute_key(pubkey) @return [String];T;0; @Iá;!F;"o;#;$T;%iI;&iM;'@ÞÛ;(I"static VALUE ossl_ec_key_dh_compute_key(VALUE self, VALUE pubkey) { EC_KEY *ec; EC_POINT *point; int buf_len; VALUE str; GetEC(self, ec); GetECPoint(pubkey, point); /* BUG: need a way to figure out the maximum string size */ buf_len = 1024; str = rb_str_new(0, buf_len); /* BUG: take KDF as a block */ buf_len = ECDH_compute_key(RSTRING_PTR(str), buf_len, point, ec, NULL); if (buf_len < 0) ossl_raise(eECError, "ECDH_compute_key"); rb_str_resize(str, buf_len); return str; };T;)I"Fstatic VALUE ossl_ec_key_dh_compute_key(VALUE self, VALUE pubkey);T;*To;;F; ;;;;I"$OpenSSL::PKey::EC#dsa_sign_asn1;F;[[I" data;T0;[[@Èin;T;:dsa_sign_asn1;0;[;{;IC;"3See the OpenSSL documentation for ECDSA_sign() ;T;[o;= ;3I" overload;F;40;;N;50;)I"dsa_sign_asn1(data);T;IC;";T; @há;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @há;[;I"@return [String];T;0;6i;[[I" data;T0; @há;[;I"fSee the OpenSSL documentation for ECDSA_sign() @overload dsa_sign_asn1(data) @return [String];T;0; @há;!F;"o;#;$T;%ih;&il;'@ÞÛ;(I"static VALUE ossl_ec_key_dsa_sign_asn1(VALUE self, VALUE data) { EC_KEY *ec; unsigned int buf_len; VALUE str; GetEC(self, ec); StringValue(data); if (EC_KEY_get0_private_key(ec) == NULL) ossl_raise(eECError, "Private EC key needed!"); str = rb_str_new(0, ECDSA_size(ec)); if (ECDSA_sign(0, (unsigned char *) RSTRING_PTR(data), RSTRING_LENINT(data), (unsigned char *) RSTRING_PTR(str), &buf_len, ec) != 1) ossl_raise(eECError, "ECDSA_sign"); rb_str_set_len(str, buf_len); return str; };T;)I"Cstatic VALUE ossl_ec_key_dsa_sign_asn1(VALUE self, VALUE data);T;*To;;F; ;;;;I"&OpenSSL::PKey::EC#dsa_verify_asn1;F;[[I" data;T0[I"sig;T0;[[@Èiˆ;T;:dsa_verify_asn1;0;[;{;IC;"5See the OpenSSL documentation for ECDSA_verify() ;T;[o;= ;3I" overload;F;40;;O;50;)I"dsa_verify_asn1(data, sig);T;IC;";T; @‡á;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @‡á;[;I"@return [Boolean];T;0;6i;[[I" data;T0[I"sig;T0; @‡á;[;I"pSee the OpenSSL documentation for ECDSA_verify() @overload dsa_verify_asn1(data, sig) @return [Boolean];T;0; @‡á;!F;"o;#;$T;%i‚;&i†;'@ÞÛ;(I"Ýstatic VALUE ossl_ec_key_dsa_verify_asn1(VALUE self, VALUE data, VALUE sig) { EC_KEY *ec; GetEC(self, ec); StringValue(data); StringValue(sig); switch (ECDSA_verify(0, (unsigned char *)RSTRING_PTR(data), RSTRING_LENINT(data), (unsigned char *)RSTRING_PTR(sig), RSTRING_LENINT(sig), ec)) { case 1: return Qtrue; case 0: return Qfalse; default: ossl_raise(eECError, "ECDSA_verify"); } };T;)I"Pstatic VALUE ossl_ec_key_dsa_verify_asn1(VALUE self, VALUE data, VALUE sig);T;*To;;F; ;;;;I"OpenSSL::PKey::EC#export;F;[[@c0;[[@Èiò;T;;;0;[;{;IC;"Outputs the EC key in PEM encoding. If _cipher_ and _pass_phrase_ are given they will be used to encrypt the key. _cipher_ must be an OpenSSL::Cipher instance. Note that encryption will only be effective for a private key, public keys will always be encoded in plain text. ;T;[o;= ;3I" overload;F;40;;;50;)I""export([cipher, pass_phrase]);T;IC;";T; @ªá;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ªá;[;I"@return [String];T;0;6i;[[I"[cipher, pass_phrase];T0; @ªáo;= ;3I" overload;F;40;;³;50;)I""to_pem([cipher, pass_phrase]);T;IC;";T; @ªá;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ªá;[;I"@return [String];T;0;6i;[[I"[cipher, pass_phrase];T0; @ªá;[;I"ŠOutputs the EC key in PEM encoding. If _cipher_ and _pass_phrase_ are given they will be used to encrypt the key. _cipher_ must be an OpenSSL::Cipher instance. Note that encryption will only be effective for a private key, public keys will always be encoded in plain text. @overload export([cipher, pass_phrase]) @return [String] @overload to_pem([cipher, pass_phrase]) @return [String];T;0; o;;F; ;;;;I"OpenSSL::PKey::EC#to_pem;F;[;[[@Èiá;F;;³;;K;[;{;@²á;'@ÞÛ;)I"Gstatic VALUE ossl_ec_key_export(int argc, VALUE *argv, VALUE self);T;(I"Ústatic VALUE ossl_ec_key_export(int argc, VALUE *argv, VALUE self) { VALUE cipher, passwd; rb_scan_args(argc, argv, "02", &cipher, &passwd); return ossl_ec_key_to_string(self, cipher, passwd, EXPORT_PEM); };T;!F;"o;#;$T;%iè;&iñ;'@ÞÛ;(I"Ústatic VALUE ossl_ec_key_export(int argc, VALUE *argv, VALUE self) { VALUE cipher, passwd; rb_scan_args(argc, argv, "02", &cipher, &passwd); return ossl_ec_key_to_string(self, cipher, passwd, EXPORT_PEM); };T;)@Ûá;*T@Ôáo;;F; ;;;;I"OpenSSL::PKey::EC#to_der;F;[;[[@Èiÿ;T;;°;0;[;{;IC;"=See the OpenSSL documentation for i2d_ECPrivateKey_bio() ;T;[o;= ;3I" overload;F;40;;°;50;)I"to_der;T;IC;";T; @ßá;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ßá;[;I"@return [String];T;0;6i;[; @ßá;[;I"cSee the OpenSSL documentation for i2d_ECPrivateKey_bio() @overload to_der @return [String];T;0; @ßá;!F;"o;#;$T;%iù;&iý;'@ÞÛ;(I"tstatic VALUE ossl_ec_key_to_der(VALUE self) { return ossl_ec_key_to_string(self, Qnil, Qnil, EXPORT_DER); };T;)I"0static VALUE ossl_ec_key_to_der(VALUE self);T;*To;;F; ;;;;I"OpenSSL::PKey::EC#to_text;F;[;[[@Èi ;T;;´;0;[;{;IC;"5See the OpenSSL documentation for EC_KEY_print() ;T;[o;= ;3I" overload;F;40;;´;50;)I"to_text;T;IC;";T; @úá;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @úá;[;I"@return [String];T;0;6i;[; @úá;[;I"\See the OpenSSL documentation for EC_KEY_print() @overload to_text @return [String];T;0; @úá;!F;"o;#;$T;%i;&i;'@ÞÛ;(I"dstatic VALUE ossl_ec_key_to_text(VALUE self) { EC_KEY *ec; BIO *out; VALUE str; GetEC(self, ec); if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eECError, "BIO_new(BIO_s_mem())"); } if (!EC_KEY_print(out, ec, 0)) { BIO_free(out); ossl_raise(eECError, "EC_KEY_print"); } str = ossl_membio2str(out); return str; };T;)I"1static VALUE ossl_ec_key_to_text(VALUE self);T;*T;A@ÞÛ;BIC;[;A@ÞÛ;CIC;[;A@ÞÛ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{ @Ýà;@á;@#á;@Ôá;;I[;[[@Èiš[@Èi©;T;:EC;;K;;;[;{;IC;"¶OpenSSL::PKey::EC provides access to Elliptic Curve Digital Signature Algorithm (ECDSA) and Elliptic Curve Diffie-Hellman (ECDH). === Key exchange ec1 = OpenSSL::PKey::EC.generate("prime256v1") ec2 = OpenSSL::PKey::EC.generate("prime256v1") # ec1 and ec2 have own private key respectively shared_key1 = ec1.dh_compute_key(ec2.public_key) shared_key2 = ec2.dh_compute_key(ec1.public_key) p shared_key1 == shared_key2 #=> true ;T;[;[;I"¸ OpenSSL::PKey::EC provides access to Elliptic Curve Digital Signature Algorithm (ECDSA) and Elliptic Curve Diffie-Hellman (ECDH). === Key exchange ec1 = OpenSSL::PKey::EC.generate("prime256v1") ec2 = OpenSSL::PKey::EC.generate("prime256v1") # ec1 and ec2 have own private key respectively shared_key1 = ec1.dh_compute_key(ec2.public_key) shared_key2 = ec2.dh_compute_key(ec1.public_key) p shared_key1 == shared_key2 #=> true ;T;0; @ÞÛ;!F;"o;#;$T;%iš;&i¦;'@_Ö;I"OpenSSL::PKey::EC;F;S@aÖo; ;IC;[;A@'â;BIC;[;A@'â;CIC;[;A@'â;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ž×i€[@ž×i†;T;: RSAError;;K;;;[;{;IC;"¬Generic exception that is raised if an operation on an RSA PKey fails unexpectedly or in case an instantiation of an instance of RSA fails due to non-conformant input data. ;T;[;[;I"® Generic exception that is raised if an operation on an RSA PKey fails unexpectedly or in case an instantiation of an instance of RSA fails due to non-conformant input data. ;T;0; @'â;!F;"o;#;$T;%i€;&i„;'@_Ö;I"OpenSSL::PKey::RSAError;F;S@§×o; ;IC;[o;;F; ;F;;;I" OpenSSL::PKey::RSA.generate;F;[[@c0;[[@ž×i³;T;;;0;[;{;IC;"ÀGenerates an RSA keypair. _size_ is an integer representing the desired key size. Keys smaller than 1024 should be considered insecure. _exponent_ is an odd number normally 3, 17, or 65537. ;T;[o;= ;3I" overload;F;40;;;50;)I"generate(size);T;IC;";T; @=â;>0;!F;[;[;I";T;0;6i;[[I" size;T0; @=âo;= ;3I" overload;F;40;;;50;)I"generate(size, exponent);T;IC;";T; @=â;>0;!F;[;[;I";T;0;6i;[[I" size;T0[I" exponent;T0; @=â;[;I"þGenerates an RSA keypair. _size_ is an integer representing the desired key size. Keys smaller than 1024 should be considered insecure. _exponent_ is an odd number normally 3, 17, or 65537. @overload generate(size) @overload generate(size, exponent);T;0; @=â;!F;"o;#;$T;%iª;&i°;'@;â;(I"òstatic VALUE ossl_rsa_s_generate(int argc, VALUE *argv, VALUE klass) { /* why does this method exist? why can't initialize take an optional exponent? */ RSA *rsa; VALUE size, exp; VALUE obj; rb_scan_args(argc, argv, "11", &size, &exp); rsa = rsa_generate(NUM2INT(size), NIL_P(exp) ? RSA_F4 : NUM2ULONG(exp)); /* err handled by rsa_instance */ obj = rsa_instance(klass, rsa); if (obj == Qfalse) { RSA_free(rsa); ossl_raise(eRSAError, NULL); } return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::PKey::RSA#initialize;F;[[@c0;[[@ž×iÜ;T;;Ð;0;[;{;IC;"ûGenerates or loads an RSA keypair. If an integer _key_size_ is given it represents the desired key size. Keys less than 1024 bits should be considered insecure. A key can instead be loaded from an _encoded_key_ which must be PEM or DER encoded. A _pass_phrase_ can be used to decrypt the key. If none is given OpenSSL will prompt for the pass phrase. = Examples OpenSSL::PKey::RSA.new 2048 OpenSSL::PKey::RSA.new File.read 'rsa.pem' OpenSSL::PKey::RSA.new File.read('rsa.pem'), 'my pass phrase' ;T;[o;= ;3I" overload;F;40;;î;50;)I"new(key_size);T;IC;";T; @bâ;>0;!F;[;[;I";T;0;6i;[[I" key_size;T0; @bâo;= ;3I" overload;F;40;;î;50;)I"new(encoded_key);T;IC;";T; @bâ;>0;!F;[;[;I";T;0;6i;[[I"encoded_key;T0; @bâo;= ;3I" overload;F;40;;î;50;)I""new(encoded_key, pass_phrase);T;IC;";T; @bâ;>0;!F;[;[;I";T;0;6i;[[I"encoded_key;T0[I"pass_phrase;T0; @bâ;[;I"XGenerates or loads an RSA keypair. If an integer _key_size_ is given it represents the desired key size. Keys less than 1024 bits should be considered insecure. A key can instead be loaded from an _encoded_key_ which must be PEM or DER encoded. A _pass_phrase_ can be used to decrypt the key. If none is given OpenSSL will prompt for the pass phrase. = Examples OpenSSL::PKey::RSA.new 2048 OpenSSL::PKey::RSA.new File.read 'rsa.pem' OpenSSL::PKey::RSA.new File.read('rsa.pem'), 'my pass phrase' @overload new(key_size) @overload new(encoded_key) @overload new(encoded_key, pass_phrase);T;0; @bâ;!F;"o;#;$T;%iÈ;&iÙ;'@;â;(I"ëstatic VALUE ossl_rsa_initialize(int argc, VALUE *argv, VALUE self) { EVP_PKEY *pkey; RSA *rsa; BIO *in; VALUE arg, pass; GetPKey(self, pkey); if(rb_scan_args(argc, argv, "02", &arg, &pass) == 0) { rsa = RSA_new(); } else if (RB_INTEGER_TYPE_P(arg)) { rsa = rsa_generate(NUM2INT(arg), NIL_P(pass) ? RSA_F4 : NUM2ULONG(pass)); if (!rsa) ossl_raise(eRSAError, NULL); } else { pass = ossl_pem_passwd_value(pass); arg = ossl_to_der_if_possible(arg); in = ossl_obj2bio(&arg); rsa = PEM_read_bio_RSAPrivateKey(in, NULL, ossl_pem_passwd_cb, (void *)pass); if (!rsa) { OSSL_BIO_reset(in); rsa = PEM_read_bio_RSA_PUBKEY(in, NULL, NULL, NULL); } if (!rsa) { OSSL_BIO_reset(in); rsa = d2i_RSAPrivateKey_bio(in, NULL); } if (!rsa) { OSSL_BIO_reset(in); rsa = d2i_RSA_PUBKEY_bio(in, NULL); } if (!rsa) { OSSL_BIO_reset(in); rsa = PEM_read_bio_RSAPublicKey(in, NULL, NULL, NULL); } if (!rsa) { OSSL_BIO_reset(in); rsa = d2i_RSAPublicKey_bio(in, NULL); } BIO_free(in); if (!rsa) { ossl_raise(eRSAError, "Neither PUB key nor PRIV key"); } } if (!EVP_PKEY_assign_RSA(pkey, rsa)) { RSA_free(rsa); ossl_raise(eRSAError, NULL); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::PKey::RSA#initialize_copy;F;[[I" other;T0;[[@ž×i;T;;g;0;[;{;IC;";T;[;[;@|;0; @‘â;'@;â;(I"ßstatic VALUE ossl_rsa_initialize_copy(VALUE self, VALUE other) { EVP_PKEY *pkey; RSA *rsa, *rsa_new; GetPKey(self, pkey); if (EVP_PKEY_base_id(pkey) != EVP_PKEY_NONE) ossl_raise(eRSAError, "RSA already initialized"); GetRSA(other, rsa); rsa_new = ASN1_dup((i2d_of_void *)i2d_RSAPrivateKey, (d2i_of_void *)d2i_RSAPrivateKey, (char *)rsa); if (!rsa_new) ossl_raise(eRSAError, "ASN1_dup"); EVP_PKEY_assign_RSA(pkey, rsa_new); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKey::RSA#public?;F;[;[[@ž×i-;T;;;0;[;{;IC;"TThe return value is always +true+ since every private key is also a public key.;T;[o;= ;3I" overload;F;40;;;50;)I"public?;T;IC;";T; @Ÿâ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" true;T; @Ÿâ;[;I"@return [true];T;0;6i;[; @Ÿâ;[;I"yThe return value is always +true+ since every private key is also a public key. @overload public? @return [true];T;0; @Ÿâ;!F;"o;#;$T;%i&;&i+;6i;'@;â;(I"¸static VALUE ossl_rsa_is_public(VALUE self) { RSA *rsa; GetRSA(self, rsa); /* * This method should check for n and e. BUG. */ (void)rsa; return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I" OpenSSL::PKey::RSA#private?;F;[;[[@ž×i@;T;;;0;[;{;IC;"-Does this keypair contain a private key?;T;[o;= ;3I" overload;F;40;;;50;)I" private?;T;IC;";T; @ºâ;>0;!F;[;[;I";T;0;6i;[; @ºâo;2 ;3I"return;F;4@|;0;5[@~; @ºâ;[;I"BDoes this keypair contain a private key? @overload private?;T;0; @ºâ;!F;"o;#;$T;%i:;&i=;6i;'@;â;(I"‹static VALUE ossl_rsa_is_private(VALUE self) { RSA *rsa; GetRSA(self, rsa); return RSA_PRIVATE(self, rsa) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKey::RSA#to_text;F;[;[[@ž×i;T;;´;0;[;{;IC;"ŒTHIS METHOD IS INSECURE, PRIVATE INFORMATION CAN LEAK OUT!!! Dumps all parameters of a keypair to a String Don't use :-)) (It's up to you) ;T;[o;= ;3I" overload;F;40;;´;50;)I"to_text;T;IC;";T; @Óâ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Óâ;[;I"@return [String];T;0;6i;[; @Óâ;[;I"³THIS METHOD IS INSECURE, PRIVATE INFORMATION CAN LEAK OUT!!! Dumps all parameters of a keypair to a String Don't use :-)) (It's up to you) @overload to_text @return [String];T;0; @Óâ;!F;"o;#;$T;%i;&i ;'@;â;(I"Vstatic VALUE ossl_rsa_to_text(VALUE self) { RSA *rsa; BIO *out; VALUE str; GetRSA(self, rsa); if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eRSAError, NULL); } if (!RSA_print(out, rsa, 0)) { /* offset = 0 */ BIO_free(out); ossl_raise(eRSAError, NULL); } str = ossl_membio2str(out); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKey::RSA#export;F;[[@c0;[[@ž×iT;T;;;0;[;{;IC;"£Outputs this keypair in PEM encoding. If _cipher_ and _pass_phrase_ are given they will be used to encrypt the key. _cipher_ must be an OpenSSL::Cipher instance. ;T;[o;= ;3I" overload;F;40;;;50;)I""export([cipher, pass_phrase]);T;IC;";T; @îâ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"PEM-format String;T; @îâ;[;I" @return [PEM-format String];T;0;6i;[[I"[cipher, pass_phrase];T0; @îâo;= ;3I" overload;F;40;;³;50;)I""to_pem([cipher, pass_phrase]);T;IC;";T; @îâ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"PEM-format String;T; @îâ;[;I" @return [PEM-format String];T;0;6i;[[I"[cipher, pass_phrase];T0; @îâo;= ;3I" overload;F;40;;q;50;)I" to_s([cipher, pass_phrase]);T;IC;";T; @îâ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"PEM-format String;T; @îâ;[;I" @return [PEM-format String];T;0;6i;[[I"[cipher, pass_phrase];T0; @îâ;[;I"uOutputs this keypair in PEM encoding. If _cipher_ and _pass_phrase_ are given they will be used to encrypt the key. _cipher_ must be an OpenSSL::Cipher instance. @overload export([cipher, pass_phrase]) @return [PEM-format String] @overload to_pem([cipher, pass_phrase]) @return [PEM-format String] @overload to_s([cipher, pass_phrase]) @return [PEM-format String];T;0; o;;F; ;;;;I"OpenSSL::PKey::RSA#to_s;F;[;[[@ž×i;F;;q;;K;[;{;@öâ;'@;â;)I"static VALUE;T;(I"Þstatic VALUE ossl_rsa_export(int argc, VALUE *argv, VALUE self) { RSA *rsa; const BIGNUM *n, *e, *d, *p, *q, *dmp1, *dmq1, *iqmp; BIO *out; const EVP_CIPHER *ciph = NULL; VALUE cipher, pass, str; GetRSA(self, rsa); rb_scan_args(argc, argv, "02", &cipher, &pass); if (!NIL_P(cipher)) { ciph = ossl_evp_get_cipherbyname(cipher); pass = ossl_pem_passwd_value(pass); } if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eRSAError, NULL); } RSA_get0_key(rsa, &n, &e, &d); RSA_get0_factors(rsa, &p, &q); RSA_get0_crt_params(rsa, &dmp1, &dmq1, &iqmp); if (n && e && d && p && q && dmp1 && dmq1 && iqmp) { if (!PEM_write_bio_RSAPrivateKey(out, rsa, ciph, NULL, 0, ossl_pem_passwd_cb, (void *)pass)) { BIO_free(out); ossl_raise(eRSAError, NULL); } } else { if (!PEM_write_bio_RSA_PUBKEY(out, rsa)) { BIO_free(out); ossl_raise(eRSAError, NULL); } } str = ossl_membio2str(out); return str; };T;!F;"o;#;$T;%iJ;&iT;'@;â;(I"Þstatic VALUE ossl_rsa_export(int argc, VALUE *argv, VALUE self) { RSA *rsa; const BIGNUM *n, *e, *d, *p, *q, *dmp1, *dmq1, *iqmp; BIO *out; const EVP_CIPHER *ciph = NULL; VALUE cipher, pass, str; GetRSA(self, rsa); rb_scan_args(argc, argv, "02", &cipher, &pass); if (!NIL_P(cipher)) { ciph = ossl_evp_get_cipherbyname(cipher); pass = ossl_pem_passwd_value(pass); } if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eRSAError, NULL); } RSA_get0_key(rsa, &n, &e, &d); RSA_get0_factors(rsa, &p, &q); RSA_get0_crt_params(rsa, &dmp1, &dmq1, &iqmp); if (n && e && d && p && q && dmp1 && dmq1 && iqmp) { if (!PEM_write_bio_RSAPrivateKey(out, rsa, ciph, NULL, 0, ossl_pem_passwd_cb, (void *)pass)) { BIO_free(out); ossl_raise(eRSAError, NULL); } } else { if (!PEM_write_bio_RSA_PUBKEY(out, rsa)) { BIO_free(out); ossl_raise(eRSAError, NULL); } } str = ossl_membio2str(out); return str; };T;)@.ã;*To;;F; ;;;;I"OpenSSL::PKey::RSA#to_pem;F;[;[[@ž×iœ;F;;³;;K;[;{;@öâ;'@;â;)@.ã;(I"Þstatic VALUE ossl_rsa_export(int argc, VALUE *argv, VALUE self) { RSA *rsa; const BIGNUM *n, *e, *d, *p, *q, *dmp1, *dmq1, *iqmp; BIO *out; const EVP_CIPHER *ciph = NULL; VALUE cipher, pass, str; GetRSA(self, rsa); rb_scan_args(argc, argv, "02", &cipher, &pass); if (!NIL_P(cipher)) { ciph = ossl_evp_get_cipherbyname(cipher); pass = ossl_pem_passwd_value(pass); } if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eRSAError, NULL); } RSA_get0_key(rsa, &n, &e, &d); RSA_get0_factors(rsa, &p, &q); RSA_get0_crt_params(rsa, &dmp1, &dmq1, &iqmp); if (n && e && d && p && q && dmp1 && dmq1 && iqmp) { if (!PEM_write_bio_RSAPrivateKey(out, rsa, ciph, NULL, 0, ossl_pem_passwd_cb, (void *)pass)) { BIO_free(out); ossl_raise(eRSAError, NULL); } } else { if (!PEM_write_bio_RSA_PUBKEY(out, rsa)) { BIO_free(out); ossl_raise(eRSAError, NULL); } } str = ossl_membio2str(out); return str; };T@'ão;;F; ;;;;I"OpenSSL::PKey::RSA#to_der;F;[;[[@ž×i‚;T;;°;0;[;{;IC;"*Outputs this keypair in DER encoding. ;T;[o;= ;3I" overload;F;40;;°;50;)I"to_der;T;IC;";T; @:ã;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"DER-format String;T; @:ã;[;I" @return [DER-format String];T;0;6i;[; @:ã;[;I"[Outputs this keypair in DER encoding. @overload to_der @return [DER-format String];T;0; @:ã;!F;"o;#;$T;%i|;&i€;'@;â;(I"static VALUE ossl_rsa_to_der(VALUE self) { RSA *rsa; const BIGNUM *n, *e, *d, *p, *q, *dmp1, *dmq1, *iqmp; int (*i2d_func)(const RSA *, unsigned char **); unsigned char *ptr; long len; VALUE str; GetRSA(self, rsa); RSA_get0_key(rsa, &n, &e, &d); RSA_get0_factors(rsa, &p, &q); RSA_get0_crt_params(rsa, &dmp1, &dmq1, &iqmp); if (n && e && d && p && q && dmp1 && dmq1 && iqmp) i2d_func = i2d_RSAPrivateKey; else i2d_func = (int (*)(const RSA *, unsigned char **))i2d_RSA_PUBKEY; if((len = i2d_func(rsa, NULL)) <= 0) ossl_raise(eRSAError, NULL); str = rb_str_new(0, len); ptr = (unsigned char *)RSTRING_PTR(str); if(i2d_func(rsa, &ptr) < 0) ossl_raise(eRSAError, NULL); ossl_str_adjust(str, ptr); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::PKey::RSA#public_key;F;[;[[@ž×i);T;;Â;0;[;{;IC;"KMakes new RSA instance containing the public key from the private key. ;T;[o;= ;3I" overload;F;40;;Â;50;)I"public_key;T;IC;";T; @Uã;>0;!F;[;[;I";T;0;6i;[; @Uã;[;I"bMakes new RSA instance containing the public key from the private key. @overload public_key;T;0; @Uã;!F;"o;#;$T;%i#;&i&;'@;â;(I"rstatic VALUE ossl_rsa_to_public_key(VALUE self) { EVP_PKEY *pkey; RSA *rsa; VALUE obj; GetPKeyRSA(self, pkey); /* err check performed by rsa_instance */ rsa = RSAPublicKey_dup(EVP_PKEY_get0_RSA(pkey)); obj = rsa_instance(rb_obj_class(self), rsa); if (obj == Qfalse) { RSA_free(rsa); ossl_raise(eRSAError, NULL); } return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::PKey::RSA#public_encrypt;F;[[@c0;[[@ž×i§;T;:public_encrypt;0;[;{;IC;"Encrypt _string_ with the public key. _padding_ defaults to PKCS1_PADDING. The encrypted string output can be decrypted using #private_decrypt. ;T;[o;= ;3I" overload;F;40;;R;50;)I"public_encrypt(string);T;IC;";T; @kã;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @kã;[;I"@return [String];T;0;6i;[[I"string;T0; @kão;= ;3I" overload;F;40;;R;50;)I"$public_encrypt(string, padding);T;IC;";T; @kã;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @kã;[;I"@return [String];T;0;6i;[[I"string;T0[I"padding;T0; @kã;[;I"Encrypt _string_ with the public key. _padding_ defaults to PKCS1_PADDING. The encrypted string output can be decrypted using #private_decrypt. @overload public_encrypt(string) @return [String] @overload public_encrypt(string, padding) @return [String];T;0; @kã;!F;"o;#;$T;%iŸ;&i¦;'@;â;(I"Òstatic VALUE ossl_rsa_public_encrypt(int argc, VALUE *argv, VALUE self) { RSA *rsa; const BIGNUM *rsa_n; int buf_len, pad; VALUE str, buffer, padding; GetRSA(self, rsa); RSA_get0_key(rsa, &rsa_n, NULL, NULL); if (!rsa_n) ossl_raise(eRSAError, "incomplete RSA"); rb_scan_args(argc, argv, "11", &buffer, &padding); pad = (argc == 1) ? RSA_PKCS1_PADDING : NUM2INT(padding); StringValue(buffer); str = rb_str_new(0, RSA_size(rsa)); buf_len = RSA_public_encrypt(RSTRING_LENINT(buffer), (unsigned char *)RSTRING_PTR(buffer), (unsigned char *)RSTRING_PTR(str), rsa, pad); if (buf_len < 0) ossl_raise(eRSAError, NULL); rb_str_set_len(str, buf_len); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::PKey::RSA#public_decrypt;F;[[@c0;[[@ž×iÇ;T;:public_decrypt;0;[;{;IC;"{Decrypt _string_, which has been encrypted with the private key, with the public key. _padding_ defaults to PKCS1_PADDING. ;T;[o;= ;3I" overload;F;40;;S;50;)I"public_decrypt(string);T;IC;";T; @šã;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @šã;[;I"@return [String];T;0;6i;[[I"string;T0; @šão;= ;3I" overload;F;40;;S;50;)I"$public_decrypt(string, padding);T;IC;";T; @šã;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @šã;[;I"@return [String];T;0;6i;[[I"string;T0[I"padding;T0; @šã;[;I"îDecrypt _string_, which has been encrypted with the private key, with the public key. _padding_ defaults to PKCS1_PADDING. @overload public_decrypt(string) @return [String] @overload public_decrypt(string, padding) @return [String];T;0; @šã;!F;"o;#;$T;%i¿;&iÆ;'@;â;(I"Òstatic VALUE ossl_rsa_public_decrypt(int argc, VALUE *argv, VALUE self) { RSA *rsa; const BIGNUM *rsa_n; int buf_len, pad; VALUE str, buffer, padding; GetRSA(self, rsa); RSA_get0_key(rsa, &rsa_n, NULL, NULL); if (!rsa_n) ossl_raise(eRSAError, "incomplete RSA"); rb_scan_args(argc, argv, "11", &buffer, &padding); pad = (argc == 1) ? RSA_PKCS1_PADDING : NUM2INT(padding); StringValue(buffer); str = rb_str_new(0, RSA_size(rsa)); buf_len = RSA_public_decrypt(RSTRING_LENINT(buffer), (unsigned char *)RSTRING_PTR(buffer), (unsigned char *)RSTRING_PTR(str), rsa, pad); if (buf_len < 0) ossl_raise(eRSAError, NULL); rb_str_set_len(str, buf_len); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::PKey::RSA#private_encrypt;F;[[@c0;[[@ž×iç;T;:private_encrypt;0;[;{;IC;"Encrypt _string_ with the private key. _padding_ defaults to PKCS1_PADDING. The encrypted string output can be decrypted using #public_decrypt. ;T;[o;= ;3I" overload;F;40;;T;50;)I"private_encrypt(string);T;IC;";T; @Éã;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Éã;[;I"@return [String];T;0;6i;[[I"string;T0; @Éão;= ;3I" overload;F;40;;T;50;)I"%private_encrypt(string, padding);T;IC;";T; @Éã;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Éã;[;I"@return [String];T;0;6i;[[I"string;T0[I"padding;T0; @Éã;[;I"Encrypt _string_ with the private key. _padding_ defaults to PKCS1_PADDING. The encrypted string output can be decrypted using #public_decrypt. @overload private_encrypt(string) @return [String] @overload private_encrypt(string, padding) @return [String];T;0; @Éã;!F;"o;#;$T;%iß;&iæ;'@;â;(I"%static VALUE ossl_rsa_private_encrypt(int argc, VALUE *argv, VALUE self) { RSA *rsa; const BIGNUM *rsa_n; int buf_len, pad; VALUE str, buffer, padding; GetRSA(self, rsa); RSA_get0_key(rsa, &rsa_n, NULL, NULL); if (!rsa_n) ossl_raise(eRSAError, "incomplete RSA"); if (!RSA_PRIVATE(self, rsa)) ossl_raise(eRSAError, "private key needed."); rb_scan_args(argc, argv, "11", &buffer, &padding); pad = (argc == 1) ? RSA_PKCS1_PADDING : NUM2INT(padding); StringValue(buffer); str = rb_str_new(0, RSA_size(rsa)); buf_len = RSA_private_encrypt(RSTRING_LENINT(buffer), (unsigned char *)RSTRING_PTR(buffer), (unsigned char *)RSTRING_PTR(str), rsa, pad); if (buf_len < 0) ossl_raise(eRSAError, NULL); rb_str_set_len(str, buf_len); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::PKey::RSA#private_decrypt;F;[[@c0;[[@ž×i ;T;:private_decrypt;0;[;{;IC;"{Decrypt _string_, which has been encrypted with the public key, with the private key. _padding_ defaults to PKCS1_PADDING. ;T;[o;= ;3I" overload;F;40;;U;50;)I"private_decrypt(string);T;IC;";T; @øã;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @øã;[;I"@return [String];T;0;6i;[[I"string;T0; @øão;= ;3I" overload;F;40;;U;50;)I"%private_decrypt(string, padding);T;IC;";T; @øã;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @øã;[;I"@return [String];T;0;6i;[[I"string;T0[I"padding;T0; @øã;[;I"ðDecrypt _string_, which has been encrypted with the public key, with the private key. _padding_ defaults to PKCS1_PADDING. @overload private_decrypt(string) @return [String] @overload private_decrypt(string, padding) @return [String];T;0; @øã;!F;"o;#;$T;%i;&i;'@;â;(I"%static VALUE ossl_rsa_private_decrypt(int argc, VALUE *argv, VALUE self) { RSA *rsa; const BIGNUM *rsa_n; int buf_len, pad; VALUE str, buffer, padding; GetRSA(self, rsa); RSA_get0_key(rsa, &rsa_n, NULL, NULL); if (!rsa_n) ossl_raise(eRSAError, "incomplete RSA"); if (!RSA_PRIVATE(self, rsa)) ossl_raise(eRSAError, "private key needed."); rb_scan_args(argc, argv, "11", &buffer, &padding); pad = (argc == 1) ? RSA_PKCS1_PADDING : NUM2INT(padding); StringValue(buffer); str = rb_str_new(0, RSA_size(rsa)); buf_len = RSA_private_decrypt(RSTRING_LENINT(buffer), (unsigned char *)RSTRING_PTR(buffer), (unsigned char *)RSTRING_PTR(str), rsa, pad); if (buf_len < 0) ossl_raise(eRSAError, NULL); rb_str_set_len(str, buf_len); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I" OpenSSL::PKey::RSA#sign_pss;F;[[@c0;[[@ž×iD;T;: sign_pss;0;[;{;IC;"åSigns _data_ using the Probabilistic Signature Scheme (RSA-PSS) and returns the calculated signature. RSAError will be raised if an error occurs. See #verify_pss for the verification operation. === Parameters _digest_:: A String containing the message digest algorithm name. _data_:: A String. The data to be signed. _salt_length_:: The length in octets of the salt. Two special values are reserved: +:digest+ means the digest length, and +:max+ means the maximum possible length for the combination of the private key and the selected message digest algorithm. _mgf1_hash_:: The hash algorithm used in MGF1 (the currently supported mask generation function (MGF)). === Example data = "Sign me!" pkey = OpenSSL::PKey::RSA.new(2048) signature = pkey.sign_pss("SHA256", data, salt_length: :max, mgf1_hash: "SHA256") pub_key = pkey.public_key puts pub_key.verify_pss("SHA256", signature, data, salt_length: :auto, mgf1_hash: "SHA256") # => true ;T;[o;= ;3I" overload;F;40;;V;50;)I"5sign_pss(digest, data, salt_length:, mgf1_hash:);T;IC;";T; @'ä;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @'ä;[;I"@return [String];T;0;6i;[ [I"digest;T0[I" data;T0[I"salt_length:;TI";T[I"mgf1_hash:;TI";T; @'ä;[;I"5Signs _data_ using the Probabilistic Signature Scheme (RSA-PSS) and returns the calculated signature. RSAError will be raised if an error occurs. See #verify_pss for the verification operation. === Parameters _digest_:: A String containing the message digest algorithm name. _data_:: A String. The data to be signed. _salt_length_:: The length in octets of the salt. Two special values are reserved: +:digest+ means the digest length, and +:max+ means the maximum possible length for the combination of the private key and the selected message digest algorithm. _mgf1_hash_:: The hash algorithm used in MGF1 (the currently supported mask generation function (MGF)). === Example data = "Sign me!" pkey = OpenSSL::PKey::RSA.new(2048) signature = pkey.sign_pss("SHA256", data, salt_length: :max, mgf1_hash: "SHA256") pub_key = pkey.public_key puts pub_key.verify_pss("SHA256", signature, data, salt_length: :auto, mgf1_hash: "SHA256") # => true @overload sign_pss(digest, data, salt_length:, mgf1_hash:) @return [String];T;0; @'ä;!F;"o;#;$T;%i#;&iB;'@;â;(I"Ýstatic VALUE ossl_rsa_sign_pss(int argc, VALUE *argv, VALUE self) { VALUE digest, data, options, kwargs[2], signature; static ID kwargs_ids[2]; EVP_PKEY *pkey; EVP_PKEY_CTX *pkey_ctx; const EVP_MD *md, *mgf1md; EVP_MD_CTX *md_ctx; size_t buf_len; int salt_len; if (!kwargs_ids[0]) { kwargs_ids[0] = rb_intern_const("salt_length"); kwargs_ids[1] = rb_intern_const("mgf1_hash"); } rb_scan_args(argc, argv, "2:", &digest, &data, &options); rb_get_kwargs(options, kwargs_ids, 2, 0, kwargs); if (kwargs[0] == ID2SYM(rb_intern("max"))) salt_len = -2; /* RSA_PSS_SALTLEN_MAX_SIGN */ else if (kwargs[0] == ID2SYM(rb_intern("digest"))) salt_len = -1; /* RSA_PSS_SALTLEN_DIGEST */ else salt_len = NUM2INT(kwargs[0]); mgf1md = ossl_evp_get_digestbyname(kwargs[1]); pkey = GetPrivPKeyPtr(self); buf_len = EVP_PKEY_size(pkey); md = ossl_evp_get_digestbyname(digest); StringValue(data); signature = rb_str_new(NULL, (long)buf_len); md_ctx = EVP_MD_CTX_new(); if (!md_ctx) goto err; if (EVP_DigestSignInit(md_ctx, &pkey_ctx, md, NULL, pkey) != 1) goto err; if (EVP_PKEY_CTX_set_rsa_padding(pkey_ctx, RSA_PKCS1_PSS_PADDING) != 1) goto err; if (EVP_PKEY_CTX_set_rsa_pss_saltlen(pkey_ctx, salt_len) != 1) goto err; if (EVP_PKEY_CTX_set_rsa_mgf1_md(pkey_ctx, mgf1md) != 1) goto err; if (EVP_DigestSignUpdate(md_ctx, RSTRING_PTR(data), RSTRING_LEN(data)) != 1) goto err; if (EVP_DigestSignFinal(md_ctx, (unsigned char *)RSTRING_PTR(signature), &buf_len) != 1) goto err; rb_str_set_len(signature, (long)buf_len); EVP_MD_CTX_free(md_ctx); return signature; err: EVP_MD_CTX_free(md_ctx); ossl_raise(eRSAError, NULL); };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::PKey::RSA#verify_pss;F;[[@c0;[[@ž×i›;T;:verify_pss;0;[;{;IC;"sVerifies _data_ using the Probabilistic Signature Scheme (RSA-PSS). The return value is +true+ if the signature is valid, +false+ otherwise. RSAError will be raised if an error occurs. See #sign_pss for the signing operation and an example code. === Parameters _digest_:: A String containing the message digest algorithm name. _data_:: A String. The data to be signed. _salt_length_:: The length in octets of the salt. Two special values are reserved: +:digest+ means the digest length, and +:auto+ means automatically determining the length based on the signature. _mgf1_hash_:: The hash algorithm used in MGF1. ;T;[o;= ;3I" overload;F;40;;W;50;)I"Bverify_pss(digest, signature, data, salt_length:, mgf1_hash:);T;IC;";T; @Mä;>0;!F;[;[;I";T;0;6i;[ [I"digest;T0[I"signature;T0[I" data;T0[I"salt_length:;TI";T[I"mgf1_hash:;TI";T; @Mä;[;I"½Verifies _data_ using the Probabilistic Signature Scheme (RSA-PSS). The return value is +true+ if the signature is valid, +false+ otherwise. RSAError will be raised if an error occurs. See #sign_pss for the signing operation and an example code. === Parameters _digest_:: A String containing the message digest algorithm name. _data_:: A String. The data to be signed. _salt_length_:: The length in octets of the salt. Two special values are reserved: +:digest+ means the digest length, and +:auto+ means automatically determining the length based on the signature. _mgf1_hash_:: The hash algorithm used in MGF1. @overload verify_pss(digest, signature, data, salt_length:, mgf1_hash:);T;0; @Mä;!F;"o;#;$T;%i„;&i˜;'@;â;(I"static VALUE ossl_rsa_verify_pss(int argc, VALUE *argv, VALUE self) { VALUE digest, signature, data, options, kwargs[2]; static ID kwargs_ids[2]; EVP_PKEY *pkey; EVP_PKEY_CTX *pkey_ctx; const EVP_MD *md, *mgf1md; EVP_MD_CTX *md_ctx; int result, salt_len; if (!kwargs_ids[0]) { kwargs_ids[0] = rb_intern_const("salt_length"); kwargs_ids[1] = rb_intern_const("mgf1_hash"); } rb_scan_args(argc, argv, "3:", &digest, &signature, &data, &options); rb_get_kwargs(options, kwargs_ids, 2, 0, kwargs); if (kwargs[0] == ID2SYM(rb_intern("auto"))) salt_len = -2; /* RSA_PSS_SALTLEN_AUTO */ else if (kwargs[0] == ID2SYM(rb_intern("digest"))) salt_len = -1; /* RSA_PSS_SALTLEN_DIGEST */ else salt_len = NUM2INT(kwargs[0]); mgf1md = ossl_evp_get_digestbyname(kwargs[1]); GetPKey(self, pkey); md = ossl_evp_get_digestbyname(digest); StringValue(signature); StringValue(data); md_ctx = EVP_MD_CTX_new(); if (!md_ctx) goto err; if (EVP_DigestVerifyInit(md_ctx, &pkey_ctx, md, NULL, pkey) != 1) goto err; if (EVP_PKEY_CTX_set_rsa_padding(pkey_ctx, RSA_PKCS1_PSS_PADDING) != 1) goto err; if (EVP_PKEY_CTX_set_rsa_pss_saltlen(pkey_ctx, salt_len) != 1) goto err; if (EVP_PKEY_CTX_set_rsa_mgf1_md(pkey_ctx, mgf1md) != 1) goto err; if (EVP_DigestVerifyUpdate(md_ctx, RSTRING_PTR(data), RSTRING_LEN(data)) != 1) goto err; result = EVP_DigestVerifyFinal(md_ctx, (unsigned char *)RSTRING_PTR(signature), RSTRING_LEN(signature)); switch (result) { case 0: ossl_clear_error(); EVP_MD_CTX_free(md_ctx); return Qfalse; case 1: EVP_MD_CTX_free(md_ctx); return Qtrue; default: goto err; } err: EVP_MD_CTX_free(md_ctx); ossl_raise(eRSAError, NULL); };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKey::RSA#set_key;F;[;[;F;; ;;K;[;{;IC;"-Sets _n_, _e_, _d_ for the RSA instance. ;T;[o;= ;3I" overload;F;40;; ;50;)I"set_key(n, e, d);T;IC;";T; @pä;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @pä;[;I"@return [self];T;0;6i;[[I"n;T0[I"e;T0[I"d;T0; @pä;[;I"[Sets _n_, _e_, _d_ for the RSA instance. @overload set_key(n, e, d) @return [self];T;0; @pä;!F;"o;#;$T;%iW;&i[;'@;â;*To;;F; ;;;;I"#OpenSSL::PKey::RSA#set_factors;F;[;[;F;:set_factors;;K;[;{;IC;"(Sets _p_, _q_ for the RSA instance. ;T;[o;= ;3I" overload;F;40;;X;50;)I"set_factors(p, q);T;IC;";T; @Žä;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @Žä;[;I"@return [self];T;0;6i;[[I"p;T0[I"q;T0; @Žä;[;I"WSets _p_, _q_ for the RSA instance. @overload set_factors(p, q) @return [self];T;0; @Žä;!F;"o;#;$T;%i_;⁣'@;â;*To;;F; ;;;;I"&OpenSSL::PKey::RSA#set_crt_params;F;[;[;F;:set_crt_params;;K;[;{;IC;"ŸSets _dmp1_, _dmq1_, _iqmp_ for the RSA instance. They are calculated by d mod (p - 1), d mod (q - 1) and q^(-1) mod p respectively. ;T;[o;= ;3I" overload;F;40;;Y;50;)I"%set_crt_params(dmp1, dmq1, iqmp);T;IC;";T; @ªä;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @ªä;[;I"@return [self];T;0;6i;[[I" dmp1;T0[I" dmq1;T0[I" iqmp;T0; @ªä;[;I"ÝSets _dmp1_, _dmq1_, _iqmp_ for the RSA instance. They are calculated by d mod (p - 1), d mod (q - 1) and q^(-1) mod p respectively. @overload set_crt_params(dmp1, dmq1, iqmp) @return [self];T;0; @ªä;!F;"o;#;$T;%ig;&im;'@;â;*To;;F; ;;;;I"OpenSSL::PKey::RSA#params;F;[;[[@ž×iì;T;;ß;0;[;{;IC;"ÌTHIS METHOD IS INSECURE, PRIVATE INFORMATION CAN LEAK OUT!!! Stores all parameters of key to the hash. The hash has keys 'n', 'e', 'd', 'p', 'q', 'dmp1', 'dmq1', 'iqmp'. Don't use :-)) (It's up to you) ;T;[o;= ;3I" overload;F;40;;ß;50;)I"params;T;IC;";T; @Èä;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @Èä;[;I"@return [Hash];T;0;6i;[; @Èä;[;I"ðTHIS METHOD IS INSECURE, PRIVATE INFORMATION CAN LEAK OUT!!! Stores all parameters of key to the hash. The hash has keys 'n', 'e', 'd', 'p', 'q', 'dmp1', 'dmq1', 'iqmp'. Don't use :-)) (It's up to you) @overload params @return [Hash];T;0; @Èä;!F;"o;#;$T;%iá;&iê;'@;â;(I"(static VALUE ossl_rsa_get_params(VALUE self) { RSA *rsa; VALUE hash; const BIGNUM *n, *e, *d, *p, *q, *dmp1, *dmq1, *iqmp; GetRSA(self, rsa); RSA_get0_key(rsa, &n, &e, &d); RSA_get0_factors(rsa, &p, &q); RSA_get0_crt_params(rsa, &dmp1, &dmq1, &iqmp); hash = rb_hash_new(); rb_hash_aset(hash, rb_str_new2("n"), ossl_bn_new(n)); rb_hash_aset(hash, rb_str_new2("e"), ossl_bn_new(e)); rb_hash_aset(hash, rb_str_new2("d"), ossl_bn_new(d)); rb_hash_aset(hash, rb_str_new2("p"), ossl_bn_new(p)); rb_hash_aset(hash, rb_str_new2("q"), ossl_bn_new(q)); rb_hash_aset(hash, rb_str_new2("dmp1"), ossl_bn_new(dmp1)); rb_hash_aset(hash, rb_str_new2("dmq1"), ossl_bn_new(dmq1)); rb_hash_aset(hash, rb_str_new2("iqmp"), ossl_bn_new(iqmp)); return hash; };T;)I"static VALUE;T;*T;A@;â;BIC;[;A@;â;CIC;[;A@;â;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@2ã;@'ã;;I[;[[@ž×iˆ[@ž×i’;T;:RSA;;K;;;[;{;IC;"¾RSA is an asymmetric public key algorithm that has been formalized in RFC 3447. It is in widespread use in public key infrastructures (PKI) where certificates (cf. OpenSSL::X509::Certificate) often are issued on the basis of a public/private RSA key pair. RSA is used in a wide field of applications such as secure (symmetric) key exchange, e.g. when establishing a secure TLS/SSL connection. It is also used in various digital signature schemes. ;T;[;[;I"À RSA is an asymmetric public key algorithm that has been formalized in RFC 3447. It is in widespread use in public key infrastructures (PKI) where certificates (cf. OpenSSL::X509::Certificate) often are issued on the basis of a public/private RSA key pair. RSA is used in a wide field of applications such as secure (symmetric) key exchange, e.g. when establishing a secure TLS/SSL connection. It is also used in various digital signature schemes. ;T;0; @;â;!F;"o;#;$T;%iˆ;&i;'@_Ö;I"OpenSSL::PKey::RSA;F;S@aÖ;A@_Ö;BIC;[;A@_Ö;CIC;[;A@_Ö;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ØÇiD[@˜×iC[@ØÇiw[@›×id[@Èi’[@ž×i{;T;;;;K;;;[;{;IC;"€ == Asymmetric Public Key Algorithms Asymmetric public key algorithms solve the problem of establishing and sharing secret keys to en-/decrypt messages. The key in such an algorithm consists of two parts: a public key that may be distributed to others and a private key that needs to remain secret. Messages encrypted with a public key can only be decrypted by recipients that are in possession of the associated private key. Since public key algorithms are considerably slower than symmetric key algorithms (cf. OpenSSL::Cipher) they are often used to establish a symmetric key shared between two parties that are in possession of each other's public key. Asymmetric algorithms offer a lot of nice features that are used in a lot of different areas. A very common application is the creation and validation of digital signatures. To sign a document, the signatory generally uses a message digest algorithm (cf. OpenSSL::Digest) to compute a digest of the document that is then encrypted (i.e. signed) using the private key. Anyone in possession of the public key may then verify the signature by computing the message digest of the original document on their own, decrypting the signature using the signatory's public key and comparing the result to the message digest they previously computed. The signature is valid if and only if the decrypted signature is equal to this message digest. The PKey module offers support for three popular public/private key algorithms: * RSA (OpenSSL::PKey::RSA) * DSA (OpenSSL::PKey::DSA) * Elliptic Curve Cryptography (OpenSSL::PKey::EC) Each of these implementations is in fact a sub-class of the abstract PKey class which offers the interface for supporting digital signatures in the form of PKey#sign and PKey#verify. == Diffie-Hellman Key Exchange Finally PKey also features OpenSSL::PKey::DH, an implementation of the Diffie-Hellman key exchange protocol based on discrete logarithms in finite fields, the same basis that DSA is built on. The Diffie-Hellman protocol can be used to exchange (symmetric) keys over insecure channels without needing any prior joint knowledge between the participating parties. As the security of DH demands relatively long "public keys" (i.e. the part that is overtly transmitted between participants) DH tends to be quite slow. If security or speed is your primary concern, OpenSSL::PKey::EC offers another implementation of the Diffie-Hellman protocol.;T;[;[;I"ƒ == Asymmetric Public Key Algorithms Asymmetric public key algorithms solve the problem of establishing and sharing secret keys to en-/decrypt messages. The key in such an algorithm consists of two parts: a public key that may be distributed to others and a private key that needs to remain secret. Messages encrypted with a public key can only be decrypted by recipients that are in possession of the associated private key. Since public key algorithms are considerably slower than symmetric key algorithms (cf. OpenSSL::Cipher) they are often used to establish a symmetric key shared between two parties that are in possession of each other's public key. Asymmetric algorithms offer a lot of nice features that are used in a lot of different areas. A very common application is the creation and validation of digital signatures. To sign a document, the signatory generally uses a message digest algorithm (cf. OpenSSL::Digest) to compute a digest of the document that is then encrypted (i.e. signed) using the private key. Anyone in possession of the public key may then verify the signature by computing the message digest of the original document on their own, decrypting the signature using the signatory's public key and comparing the result to the message digest they previously computed. The signature is valid if and only if the decrypted signature is equal to this message digest. The PKey module offers support for three popular public/private key algorithms: * RSA (OpenSSL::PKey::RSA) * DSA (OpenSSL::PKey::DSA) * Elliptic Curve Cryptography (OpenSSL::PKey::EC) Each of these implementations is in fact a sub-class of the abstract PKey class which offers the interface for supporting digital signatures in the form of PKey#sign and PKey#verify. == Diffie-Hellman Key Exchange Finally PKey also features OpenSSL::PKey::DH, an implementation of the Diffie-Hellman key exchange protocol based on discrete logarithms in finite fields, the same basis that DSA is built on. The Diffie-Hellman protocol can be used to exchange (symmetric) keys over insecure channels without needing any prior joint knowledge between the participating parties. As the security of DH demands relatively long "public keys" (i.e. the part that is overtly transmitted between participants) DH tends to be quite slow. If security or speed is your primary concern, OpenSSL::PKey::EC offers another implementation of the Diffie-Hellman protocol. ;T;0; @_Ö;!F;"o;#;$T;%iD;&iu;6i;'@ÃÇ;I"OpenSSL::PKey;Fo; ;IC;[o; ;IC;[;A@ å;BIC;[;A@ å;CIC;[;A@ å;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ÖÇi-[@ÖÇi;T;:EngineError;;K;;;[;{;IC;"EThis is the generic exception for OpenSSL::Engine related errors ;T;[;[;I"G This is the generic exception for OpenSSL::Engine related errors ;T;0; @ å;!F;"o;#;$T;%i-;&i/;'o;L;M@;NI"OpenSSL::Engine;T;:Engine;'o;L;M0;N0;O0;;;'@;Q@ÃÇ;R0;Q@å;O0;R0;I"!OpenSSL::Engine::EngineError;F;S@ÅÇo;;F; ;F;;;I"OpenSSL::Engine.load;F;[[@c0;[[@ÖÇib;T;;Œ;0;[;{;IC;"äThis method loads engines. If _name_ is nil, then all builtin engines are loaded. Otherwise, the given _name_, as a String, is loaded if available to your runtime, and returns true. If _name_ is not found, then nil is returned. ;T;[o;= ;3I" overload;F;40;:OpenSSL::Engine.load;50;)I"%OpenSSL::Engine.load(name = nil);T;IC;";T; @$å;>0;!F;[;[;I";T;0;6i;[[I" name;TI"nil;T; @$å;[;I"This method loads engines. If _name_ is nil, then all builtin engines are loaded. Otherwise, the given _name_, as a String, is loaded if available to your runtime, and returns true. If _name_ is not found, then nil is returned. @overload OpenSSL::Engine.load(name = nil);T;0; @$å;!F;"o;#;$T;%iX;&i_;'@å;(I" static VALUE ossl_engine_s_load(int argc, VALUE *argv, VALUE klass) { VALUE name; rb_scan_args(argc, argv, "01", &name); if(NIL_P(name)){ ENGINE_load_builtin_engines(); return Qtrue; } StringValueCStr(name); #if HAVE_ENGINE_LOAD_DYNAMIC OSSL_ENGINE_LOAD_IF_MATCH(dynamic, DYNAMIC); #endif #ifndef OPENSSL_NO_STATIC_ENGINE #if HAVE_ENGINE_LOAD_4758CCA OSSL_ENGINE_LOAD_IF_MATCH(4758cca, 4758CCA); #endif #if HAVE_ENGINE_LOAD_AEP OSSL_ENGINE_LOAD_IF_MATCH(aep, AEP); #endif #if HAVE_ENGINE_LOAD_ATALLA OSSL_ENGINE_LOAD_IF_MATCH(atalla, ATALLA); #endif #if HAVE_ENGINE_LOAD_CHIL OSSL_ENGINE_LOAD_IF_MATCH(chil, CHIL); #endif #if HAVE_ENGINE_LOAD_CSWIFT OSSL_ENGINE_LOAD_IF_MATCH(cswift, CSWIFT); #endif #if HAVE_ENGINE_LOAD_NURON OSSL_ENGINE_LOAD_IF_MATCH(nuron, NURON); #endif #if HAVE_ENGINE_LOAD_SUREWARE OSSL_ENGINE_LOAD_IF_MATCH(sureware, SUREWARE); #endif #if HAVE_ENGINE_LOAD_UBSEC OSSL_ENGINE_LOAD_IF_MATCH(ubsec, UBSEC); #endif #if HAVE_ENGINE_LOAD_PADLOCK OSSL_ENGINE_LOAD_IF_MATCH(padlock, PADLOCK); #endif #if HAVE_ENGINE_LOAD_CAPI OSSL_ENGINE_LOAD_IF_MATCH(capi, CAPI); #endif #if HAVE_ENGINE_LOAD_GMP OSSL_ENGINE_LOAD_IF_MATCH(gmp, GMP); #endif #if HAVE_ENGINE_LOAD_GOST OSSL_ENGINE_LOAD_IF_MATCH(gost, GOST); #endif #endif #if HAVE_ENGINE_LOAD_CRYPTODEV OSSL_ENGINE_LOAD_IF_MATCH(cryptodev, CRYPTODEV); #endif OSSL_ENGINE_LOAD_IF_MATCH(openssl, OPENSSL); rb_warning("no such builtin loader for `%"PRIsVALUE"'", name); return Qnil; };T;)I"static VALUE;T;*To;;F; ;F;;;I"OpenSSL::Engine.cleanup;F;[;[[@ÖÇi¢;T;:cleanup;0;[;{;IC;"ÇIt is only necessary to run cleanup when engines are loaded via OpenSSL::Engine.load. However, running cleanup before exit is recommended. Note that this is needed and works only in OpenSSL < 1.1.0. ;T;[o;= ;3I" overload;F;40;:OpenSSL::Engine.cleanup;50;)I"OpenSSL::Engine.cleanup;T;IC;";T; @>å;>0;!F;[;[;I";T;0;6i;[; @>å;[;I"ëIt is only necessary to run cleanup when engines are loaded via OpenSSL::Engine.load. However, running cleanup before exit is recommended. Note that this is needed and works only in OpenSSL < 1.1.0. @overload OpenSSL::Engine.cleanup;T;0; @>å;!F;"o;#;$T;%i™;&iŸ;'@å;(I"¬static VALUE ossl_engine_s_cleanup(VALUE self) { #if defined(LIBRESSL_VERSION_NUMBER) || OPENSSL_VERSION_NUMBER < 0x10100000 ENGINE_cleanup(); #endif return Qnil; };T;)I"static VALUE;T;*To;;F; ;F;;;I"OpenSSL::Engine.engines;F;[;[[@ÖÇi±;T;:engines;0;[;{;IC;"2Returns an array of currently loaded engines. ;T;[o;= ;3I" overload;F;40;:OpenSSL::Engine.engines;50;)I"OpenSSL::Engine.engines;T;IC;";T; @Tå;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @Tå;[;I"@return [Array];T;0;6i;[; @Tå;[;I"hReturns an array of currently loaded engines. @overload OpenSSL::Engine.engines @return [Array];T;0; @Tå;!F;"o;#;$T;%i«;&i¯;'@å;(I"Ôstatic VALUE ossl_engine_s_engines(VALUE klass) { ENGINE *e; VALUE ary, obj; ary = rb_ary_new(); for(e = ENGINE_get_first(); e; e = ENGINE_get_next(e)){ obj = NewEngine(klass); /* Need a ref count of two here because of ENGINE_free being * called internally by OpenSSL when moving to the next ENGINE * and by us when releasing the ENGINE reference */ ENGINE_up_ref(e); SetEngine(obj, e); rb_ary_push(ary, obj); } return ary; };T;)I"static VALUE;T;*To;;F; ;F;;;I"OpenSSL::Engine.by_id;F;[[I"id;T0;[[@ÖÇiÐ;T;: by_id;0;[;{;IC;"ÛFetches the engine as specified by the _id_ String. OpenSSL::Engine.by_id("openssl") => # See OpenSSL::Engine.engines for the currently loaded engines. ;T;[o;= ;3I" overload;F;40;:OpenSSL::Engine.by_id;50;)I" OpenSSL::Engine.by_id(name);T;IC;";T; @oå;>0;!F;[;[;I";T;0;6i;[[I" name;T0; @oå;[;I"Fetches the engine as specified by the _id_ String. OpenSSL::Engine.by_id("openssl") => # See OpenSSL::Engine.engines for the currently loaded engines. @overload OpenSSL::Engine.by_id(name);T;0; @oå;!F;"o;#;$T;%iÅ;&iÍ;'@å;(I"static VALUE ossl_engine_s_by_id(VALUE klass, VALUE id) { ENGINE *e; VALUE obj; StringValueCStr(id); ossl_engine_s_load(1, &id, klass); obj = NewEngine(klass); if(!(e = ENGINE_by_id(RSTRING_PTR(id)))) ossl_raise(eEngineError, NULL); SetEngine(obj, e); if(rb_block_given_p()) rb_yield(obj); if(!ENGINE_init(e)) ossl_raise(eEngineError, NULL); ENGINE_ctrl(e, ENGINE_CTRL_SET_PASSWORD_CALLBACK, 0, NULL, (void(*)(void))ossl_pem_passwd_cb); ossl_clear_error(); return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Engine#id;F;[;[[@ÖÇiñ;T;:id;0;[;{;IC;"žGets the id for this engine. OpenSSL::Engine.load OpenSSL::Engine.engines #=> [#, ...] OpenSSL::Engine.engines.first.id #=> "rsax" ;T;[o;= ;3I" overload;F;40;;d;50;)I"id;T;IC;";T; @‰å;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @‰å;[;I"@return [String];T;0;6i;[; @‰å;[;I"ÀGets the id for this engine. OpenSSL::Engine.load OpenSSL::Engine.engines #=> [#, ...] OpenSSL::Engine.engines.first.id #=> "rsax" @overload id @return [String];T;0; @‰å;!F;"o;#;$T;%iæ;&iï;'@å;(I"€static VALUE ossl_engine_get_id(VALUE self) { ENGINE *e; GetEngine(self, e); return rb_str_new2(ENGINE_get_id(e)); };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Engine#name;F;[;[[@ÖÇi;T;;Ñ;0;[;{;IC;"¼Get the descriptive name for this engine. OpenSSL::Engine.load OpenSSL::Engine.engines #=> [#, ...] OpenSSL::Engine.engines.first.name #=> "RSAX engine support" ;T;[o;= ;3I" overload;F;40;;Ñ;50;)I" name;T;IC;";T; @¤å;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @¤å;[;I"@return [String];T;0;6i;[; @¤å;[;I"áGet the descriptive name for this engine. OpenSSL::Engine.load OpenSSL::Engine.engines #=> [#, ...] OpenSSL::Engine.engines.first.name #=> "RSAX engine support" @overload name @return [String];T;0; @¤å;!F;"o;#;$T;%iù;&i;'@å;(I"„static VALUE ossl_engine_get_name(VALUE self) { ENGINE *e; GetEngine(self, e); return rb_str_new2(ENGINE_get_name(e)); };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Engine#finish;F;[;[[@ÖÇi;T;;<;0;[;{;IC;"xReleases all internal structural references for this engine. May raise an EngineError if the engine is unavailable ;T;[o;= ;3I" overload;F;40;;<;50;)I"finish;T;IC;";T; @¿å;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @¿å;[;I"@return [nil];T;0;6i;[; @¿å;[;I"–Releases all internal structural references for this engine. May raise an EngineError if the engine is unavailable @overload finish @return [nil];T;0; @¿å;!F;"o;#;$T;%i ;&i;'@å;(I"£static VALUE ossl_engine_finish(VALUE self) { ENGINE *e; GetEngine(self, e); if(!ENGINE_finish(e)) ossl_raise(eEngineError, NULL); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Engine#cipher;F;[[I" name;T0;[[@ÖÇi/;T;:cipher;0;[;{;IC;"AReturns a new instance of OpenSSL::Cipher by _name_, if it is available in this engine. An EngineError will be raised if the cipher is unavailable. e = OpenSSL::Engine.by_id("openssl") => # e.cipher("RC4") => # ;T;[o;= ;3I" overload;F;40;;e;50;)I"cipher(name);T;IC;";T; @Úå;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"OpenSSL::Cipher;T; @Úå;[;I"@return [OpenSSL::Cipher];T;0;6i;[[I" name;T0; @Úå;[;I"wReturns a new instance of OpenSSL::Cipher by _name_, if it is available in this engine. An EngineError will be raised if the cipher is unavailable. e = OpenSSL::Engine.by_id("openssl") => # e.cipher("RC4") => # @overload cipher(name) @return [OpenSSL::Cipher];T;0; @Úå;!F;"o;#;$T;%i ;&i-;'@å;(I"±static VALUE ossl_engine_get_cipher(VALUE self, VALUE name) { ENGINE *e; const EVP_CIPHER *ciph, *tmp; int nid; tmp = EVP_get_cipherbyname(StringValueCStr(name)); if(!tmp) ossl_raise(eEngineError, "no such cipher `%"PRIsVALUE"'", name); nid = EVP_CIPHER_nid(tmp); GetEngine(self, e); ciph = ENGINE_get_cipher(e, nid); if(!ciph) ossl_raise(eEngineError, NULL); return ossl_cipher_new(ciph); };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Engine#digest;F;[[I" name;T0;[[@ÖÇiO;T;; ;0;[;{;IC;"zReturns a new instance of OpenSSL::Digest by _name_. Will raise an EngineError if the digest is unavailable. e = OpenSSL::Engine.by_id("openssl") #=> # e.digest("SHA1") #=> # e.digest("zomg") #=> OpenSSL::Engine::EngineError: no such digest `zomg' ;T;[o;= ;3I" overload;F;40;; ;50;)I"digest(name);T;IC;";T; @ùå;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"OpenSSL::Digest;T; @ùå;[;I"@return [OpenSSL::Digest];T;0;6i;[[I" name;T0; @ùå;[;I"¯Returns a new instance of OpenSSL::Digest by _name_. Will raise an EngineError if the digest is unavailable. e = OpenSSL::Engine.by_id("openssl") #=> # e.digest("SHA1") #=> # e.digest("zomg") #=> OpenSSL::Engine::EngineError: no such digest `zomg' @overload digest(name) @return [OpenSSL::Digest];T;0; @ùå;!F;"o;#;$T;%i@;&iM;'@å;(I"¡static VALUE ossl_engine_get_digest(VALUE self, VALUE name) { ENGINE *e; const EVP_MD *md, *tmp; int nid; tmp = EVP_get_digestbyname(StringValueCStr(name)); if(!tmp) ossl_raise(eEngineError, "no such digest `%"PRIsVALUE"'", name); nid = EVP_MD_nid(tmp); GetEngine(self, e); md = ENGINE_get_digest(e, nid); if(!md) ossl_raise(eEngineError, NULL); return ossl_digest_new(md); };T;)I"static VALUE;T;*To;;F; ;;;;I"%OpenSSL::Engine#load_private_key;F;[[@c0;[[@ÖÇii;T;:load_private_key;0;[;{;IC;"~Loads the given private key identified by _id_ and _data_. An EngineError is raised of the OpenSSL::PKey is unavailable. ;T;[o;= ;3I" overload;F;40;;f;50;)I"+load_private_key(id = nil, data = nil);T;IC;";T; @æ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"OpenSSL::PKey;T; @æ;[;I"@return [OpenSSL::PKey];T;0;6i;[[I"id;TI"nil;T[I" data;TI"nil;T; @æ;[;I"ÇLoads the given private key identified by _id_ and _data_. An EngineError is raised of the OpenSSL::PKey is unavailable. @overload load_private_key(id = nil, data = nil) @return [OpenSSL::PKey];T;0; @æ;!F;"o;#;$T;%i`;&ig;'@å;(I" static VALUE ossl_engine_load_privkey(int argc, VALUE *argv, VALUE self) { ENGINE *e; EVP_PKEY *pkey; VALUE id, data, obj; char *sid, *sdata; rb_scan_args(argc, argv, "02", &id, &data); sid = NIL_P(id) ? NULL : StringValueCStr(id); sdata = NIL_P(data) ? NULL : StringValueCStr(data); GetEngine(self, e); pkey = ENGINE_load_private_key(e, sid, NULL, sdata); if (!pkey) ossl_raise(eEngineError, NULL); obj = ossl_pkey_new(pkey); OSSL_PKEY_SET_PRIVATE(obj); return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"$OpenSSL::Engine#load_public_key;F;[[@c0;[[@ÖÇi†;T;:load_public_key;0;[;{;IC;"}Loads the given public key identified by _id_ and _data_. An EngineError is raised of the OpenSSL::PKey is unavailable. ;T;[o;= ;3I" overload;F;40;;g;50;)I"*load_public_key(id = nil, data = nil);T;IC;";T; @:æ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"OpenSSL::PKey;T; @:æ;[;I"@return [OpenSSL::PKey];T;0;6i;[[I"id;TI"nil;T[I" data;TI"nil;T; @:æ;[;I"ÅLoads the given public key identified by _id_ and _data_. An EngineError is raised of the OpenSSL::PKey is unavailable. @overload load_public_key(id = nil, data = nil) @return [OpenSSL::PKey];T;0; @:æ;!F;"o;#;$T;%i};&i„;'@å;(I"Ôstatic VALUE ossl_engine_load_pubkey(int argc, VALUE *argv, VALUE self) { ENGINE *e; EVP_PKEY *pkey; VALUE id, data; char *sid, *sdata; rb_scan_args(argc, argv, "02", &id, &data); sid = NIL_P(id) ? NULL : StringValueCStr(id); sdata = NIL_P(data) ? NULL : StringValueCStr(data); GetEngine(self, e); pkey = ENGINE_load_public_key(e, sid, NULL, sdata); if (!pkey) ossl_raise(eEngineError, NULL); return ossl_pkey_new(pkey); };T;)I"static VALUE;T;*To;;F; ;;;;I" OpenSSL::Engine#set_default;F;[[I" flag;T0;[[@ÖÇi¨;T;:set_default;0;[;{;IC;"Set the defaults for this engine with the given _flag_. These flags are used to control combinations of algorithm methods. _flag_ can be one of the following, other flags are available depending on your OS. [All flags] 0xFFFF [No flags] 0x0000 See also ;T;[o;= ;3I" overload;F;40;;h;50;)I"set_default(flag);T;IC;";T; @\æ;>0;!F;[;[;I";T;0;6i;[[I" flag;T0; @\æ;[;I"2Set the defaults for this engine with the given _flag_. These flags are used to control combinations of algorithm methods. _flag_ can be one of the following, other flags are available depending on your OS. [All flags] 0xFFFF [No flags] 0x0000 See also @overload set_default(flag);T;0; @\æ;!F;"o;#;$T;%i˜;&i¥;'@å;(I"´static VALUE ossl_engine_set_default(VALUE self, VALUE flag) { ENGINE *e; int f = NUM2INT(flag); GetEngine(self, e); ENGINE_set_default(e, f); return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Engine#ctrl_cmd;F;[[@c0;[[@ÖÇi¼;T;: ctrl_cmd;0;[;{;IC;"[Sends the given _command_ to this engine. Raises an EngineError if the command fails. ;T;[o;= ;3I" overload;F;40;;i;50;)I"#ctrl_cmd(command, value = nil);T;IC;";T; @væ;>0;!F;[;[;I";T;0;6i;[[I"command;T0[I" value;TI"nil;T; @væ;[;I"Sends the given _command_ to this engine. Raises an EngineError if the command fails. @overload ctrl_cmd(command, value = nil);T;0; @væ;!F;"o;#;$T;%i´;&i¹;'@å;(I"nstatic VALUE ossl_engine_ctrl_cmd(int argc, VALUE *argv, VALUE self) { ENGINE *e; VALUE cmd, val; int ret; GetEngine(self, e); rb_scan_args(argc, argv, "11", &cmd, &val); ret = ENGINE_ctrl_cmd_string(e, StringValueCStr(cmd), NIL_P(val) ? NULL : StringValueCStr(val), 0); if (!ret) ossl_raise(eEngineError, NULL); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Engine#cmds;F;[;[[@ÖÇiÞ;T;: cmds;0;[;{;IC;"CReturns an array of command definitions for the current engine ;T;[o;= ;3I" overload;F;40;;j;50;)I" cmds;T;IC;";T; @’æ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @’æ;[;I"@return [Array];T;0;6i;[; @’æ;[;I"fReturns an array of command definitions for the current engine @overload cmds @return [Array];T;0; @’æ;!F;"o;#;$T;%iØ;&iÜ;'@å;(I"÷static VALUE ossl_engine_get_cmds(VALUE self) { ENGINE *e; const ENGINE_CMD_DEFN *defn, *p; VALUE ary, tmp; GetEngine(self, e); ary = rb_ary_new(); if ((defn = ENGINE_get_cmd_defns(e)) != NULL){ for (p = defn; p->cmd_num > 0; p++){ tmp = rb_ary_new(); rb_ary_push(tmp, rb_str_new2(p->cmd_name)); rb_ary_push(tmp, rb_str_new2(p->cmd_desc)); rb_ary_push(tmp, ossl_engine_cmd_flag_to_name(p->cmd_flags)); rb_ary_push(ary, tmp); } } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Engine#inspect;F;[;[[@ÖÇiú;T;;r;0;[;{;IC;"Pretty prints this engine. ;T;[o;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @æ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @æ;[;I"@return [String];T;0;6i;[; @æ;[;I"FPretty prints this engine. @overload inspect @return [String];T;0; @æ;!F;"o;#;$T;%iô;&iø;'@å;(I"Ústatic VALUE ossl_engine_inspect(VALUE self) { ENGINE *e; GetEngine(self, e); return rb_sprintf("#<%"PRIsVALUE" id=\"%s\" name=\"%s\">", rb_obj_class(self), ENGINE_get_id(e), ENGINE_get_name(e)); };T;)I"static VALUE;T;*T;A@å;BIC;[;A@å;CIC;[;A@å;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ÖÇi%[@ÖÇi;T;;\;;K;;;[;{;IC;"ŒThis class is the access to openssl's ENGINE cryptographic module implementation. See also, https://www.openssl.org/docs/crypto/engine.html;T;[;[;I"Ž This class is the access to openssl's ENGINE cryptographic module implementation. See also, https://www.openssl.org/docs/crypto/engine.html ;T;0; @å;!F;"o;#;$T;%i%;&i*;6i;'@"å;I"OpenSSL::Engine;F;S@]o; ;IC;[=o; ;IC;[o; ;IC;[;A@Þæ;BIC;[;A@Þæ;CIC;[;A@Þæ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ÜÇi<;F;:SessionError;;K;;;[;{;IC;";T;[;[;@|;0; @Þæ;'@Üæ;I"(OpenSSL::SSL::Session::SessionError;F;S@ÅÇo;;F; ;;;;I"%OpenSSL::SSL::Session#initialize;F;[[I" arg1;T0;[[@ÜÇi*;T;;Ð;0;[;{;IC;"ZCreates a new Session object from an instance of SSLSocket or DER/PEM encoded String. ;T;[o;= ;3I" overload;F;40;;î;50;)I"new(ssl_socket);T;IC;";T; @ïæ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Session;T; @ïæ;[;I"@return [Session];T;0;6i;[[I"ssl_socket;T0; @ïæo;= ;3I" overload;F;40;;î;50;)I"new(string);T;IC;";T; @ïæ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Session;T; @ïæ;[;I"@return [Session];T;0;6i;[[I"string;T0; @ïæ;[;I"¯Creates a new Session object from an instance of SSLSocket or DER/PEM encoded String. @overload new(ssl_socket) @return [Session] @overload new(string) @return [Session];T;0; @ïæ;!F;"o;#;$T;%i";&i);'@Üæ;(I"static VALUE ossl_ssl_session_initialize(VALUE self, VALUE arg1) { SSL_SESSION *ctx = NULL; if (RDATA(self)->data) ossl_raise(eSSLSession, "SSL Session already initialized"); if (rb_obj_is_instance_of(arg1, cSSLSocket)) { SSL *ssl; GetSSL(arg1, ssl); if ((ctx = SSL_get1_session(ssl)) == NULL) ossl_raise(eSSLSession, "no session available"); } else { BIO *in = ossl_obj2bio(&arg1); ctx = PEM_read_bio_SSL_SESSION(in, NULL, NULL, NULL); if (!ctx) { OSSL_BIO_reset(in); ctx = d2i_SSL_SESSION_bio(in, NULL); } BIO_free(in); if (!ctx) ossl_raise(rb_eArgError, "unknown type"); } /* should not happen */ if (ctx == NULL) ossl_raise(eSSLSession, "ctx not set - internal error"); RDATA(self)->data = ctx; return self; };T;)I"Estatic VALUE ossl_ssl_session_initialize(VALUE self, VALUE arg1);T;*To;;F; ;;;;I"*OpenSSL::SSL::Session#initialize_copy;F;[[I" other;T0;[[@ÜÇiQ;T;;g;0;[;{;IC;";T;[;[;@|;0; @ç;'@Üæ;(I"æstatic VALUE ossl_ssl_session_initialize_copy(VALUE self, VALUE other) { SSL_SESSION *sess, *sess_other, *sess_new; rb_check_frozen(self); sess = RTYPEDDATA_DATA(self); /* XXX */ GetSSLSession(other, sess_other); sess_new = ASN1_dup((i2d_of_void *)i2d_SSL_SESSION, (d2i_of_void *)d2i_SSL_SESSION, (char *)sess_other); if (!sess_new) ossl_raise(eSSLSession, "ASN1_dup"); RTYPEDDATA_DATA(self) = sess_new; SSL_SESSION_free(sess); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::SSL::Session#==;F;[[I" val2;T0;[[@ÜÇi{;T;;`;0;[;{;IC;"CReturns +true+ if the two Session is the same, +false+ if not. ;T;[o;= ;3I" overload;F;40;;`;50;)I"==(session2);T;IC;";T; @+ç;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @+ç;[;I"@return [Boolean];T;0;6i;[[I" session2;T0; @+ç;[;I"pReturns +true+ if the two Session is the same, +false+ if not. @overload ==(session2) @return [Boolean];T;0; @+ç;!F;"o;#;$T;%iu;&iy;'@Üæ;(I"òstatic VALUE ossl_ssl_session_eq(VALUE val1, VALUE val2) { SSL_SESSION *ctx1, *ctx2; GetSSLSession(val1, ctx1); GetSSLSession(val2, ctx2); switch (ossl_SSL_SESSION_cmp(ctx1, ctx2)) { case 0: return Qtrue; default: return Qfalse; } };T;)I"=static VALUE ossl_ssl_session_eq(VALUE val1, VALUE val2);T;*To;;F; ;;;;I"OpenSSL::SSL::Session#time;F;[;[[@ÜÇi‰;T;;;0;[;{;IC;";Returns the time at which the session was established. ;T;[o;= ;3I" overload;F;40;;;50;)I" time;T;IC;";T; @Jç;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Time;T; @Jç;[;I"@return [Time];T;0;6i;[; @Jç;[;I"]Returns the time at which the session was established. @overload time @return [Time];T;0; @Jç;!F;"o;#;$T;%iƒ;&i‡;'@Üæ;(I"ûstatic VALUE ossl_ssl_session_get_time(VALUE self) { SSL_SESSION *ctx; long t; GetSSLSession(self, ctx); t = SSL_SESSION_get_time(ctx); if (t == 0) return Qnil; return rb_funcall(rb_cTime, rb_intern("at"), 1, LONG2NUM(t)); };T;)I"static VALUE;T;*To;;F; ;;;;I" OpenSSL::SSL::Session#time=;F;[[I"time_v;T0;[[@ÜÇi³;T;;ø;0;[;{;IC;"CSets start time of the session. Time resolution is in seconds. ;T;[o;= ;3I" overload;F;40;;ø;50;)I"time=(time);T;IC;";T; @eç;>0;!F;[;[;I";T;0;6i;[[I" time;T0; @eço;= ;3I" overload;F;40;;ø;50;)I"time=(integer);T;IC;";T; @eç;>0;!F;[;[;I";T;0;6i;[[I"integer;T0; @eç;[;I"uSets start time of the session. Time resolution is in seconds. @overload time=(time) @overload time=(integer);T;0; @eç;!F;"o;#;$T;%i«;&i°;'@Üæ;(I"Cstatic VALUE ossl_ssl_session_set_time(VALUE self, VALUE time_v) { SSL_SESSION *ctx; long t; GetSSLSession(self, ctx); if (rb_obj_is_instance_of(time_v, rb_cTime)) { time_v = rb_funcall(time_v, rb_intern("to_i"), 0); } t = NUM2LONG(time_v); SSL_SESSION_set_time(ctx, t); return ossl_ssl_session_get_time(self); };T;)I"Estatic VALUE ossl_ssl_session_set_time(VALUE self, VALUE time_v);T;*To;;F; ;;;;I""OpenSSL::SSL::Session#timeout;F;[;[[@ÜÇiŸ;T;:timeout;0;[;{;IC;"YReturns the timeout value set for the session, in seconds from the established time. ;T;[o;= ;3I" overload;F;40;;l;50;)I"timeout;T;IC;";T; @‰ç;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @‰ç;[;I"@return [Integer];T;0;6i;[; @‰ç;[;I"}Returns the timeout value set for the session, in seconds from the established time. @overload timeout @return [Integer];T;0; @‰ç;!F;"o;#;$T;%i—;&i;'@Üæ;(I"¹static VALUE ossl_ssl_session_get_timeout(VALUE self) { SSL_SESSION *ctx; long t; GetSSLSession(self, ctx); t = SSL_SESSION_get_timeout(ctx); return LONG2NUM(t); };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::SSL::Session#timeout=;F;[[I"time_v;T0;[[@ÜÇiÇ;T;: timeout=;0;[;{;IC;"8Sets how long until the session expires in seconds. ;T;[o;= ;3I" overload;F;40;;m;50;)I"timeout=(integer);T;IC;";T; @¤ç;>0;!F;[;[;I";T;0;6i;[[I"integer;T0; @¤ç;[;I"VSets how long until the session expires in seconds. @overload timeout=(integer);T;0; @¤ç;!F;"o;#;$T;%iÁ;&iÄ;'@Üæ;(I"ästatic VALUE ossl_ssl_session_set_timeout(VALUE self, VALUE time_v) { SSL_SESSION *ctx; long t; GetSSLSession(self, ctx); t = NUM2LONG(time_v); SSL_SESSION_set_timeout(ctx, t); return ossl_ssl_session_get_timeout(self); };T;)I"Hstatic VALUE ossl_ssl_session_set_timeout(VALUE self, VALUE time_v);T;*To;;F; ;;;;I"OpenSSL::SSL::Session#id;F;[;[[@ÜÇiØ;T;;d;0;[;{;IC;"Returns the Session ID. ;T;[o;= ;3I" overload;F;40;;d;50;)I"id;T;IC;";T; @¾ç;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @¾ç;[;I"@return [String];T;0;6i;[; @¾ç;[;I">Returns the Session ID. @overload id @return [String];T;0; @¾ç;!F;"o;#;$T;%iÒ;&iÖ;'@Üæ;(I"åstatic VALUE ossl_ssl_session_get_id(VALUE self) { SSL_SESSION *ctx; const unsigned char *p = NULL; unsigned int i = 0; GetSSLSession(self, ctx); p = SSL_SESSION_get_id(ctx, &i); return rb_str_new((const char *) p, i); };T;)I"5static VALUE ossl_ssl_session_get_id(VALUE self);T;*To;;F; ;;;;I"!OpenSSL::SSL::Session#to_der;F;[;[[@ÜÇië;T;;°;0;[;{;IC;"EReturns an ASN1 encoded String that contains the Session object. ;T;[o;= ;3I" overload;F;40;;°;50;)I"to_der;T;IC;";T; @Ùç;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Ùç;[;I"@return [String];T;0;6i;[; @Ùç;[;I"kReturns an ASN1 encoded String that contains the Session object. @overload to_der @return [String];T;0; @Ùç;!F;"o;#;$T;%iå;&ié;'@Üæ;(I"wstatic VALUE ossl_ssl_session_to_der(VALUE self) { SSL_SESSION *ctx; unsigned char *p; int len; VALUE str; GetSSLSession(self, ctx); len = i2d_SSL_SESSION(ctx, NULL); if (len <= 0) { ossl_raise(eSSLSession, "i2d_SSL_SESSION"); } str = rb_str_new(0, len); p = (unsigned char *)RSTRING_PTR(str); i2d_SSL_SESSION(ctx, &p); ossl_str_adjust(str, p); return str; };T;)I"5static VALUE ossl_ssl_session_to_der(VALUE self);T;*To;;F; ;;;;I"!OpenSSL::SSL::Session#to_pem;F;[;[[@ÜÇi;T;;³;0;[;{;IC;"CReturns a PEM encoded String that contains the Session object. ;T;[o;= ;3I" overload;F;40;;³;50;)I"to_pem;T;IC;";T; @ôç;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ôç;[;I"@return [String];T;0;6i;[; @ôç;[;I"iReturns a PEM encoded String that contains the Session object. @overload to_pem @return [String];T;0; @ôç;!F;"o;#;$T;%iÿ;&i;'@Üæ;(I"Vstatic VALUE ossl_ssl_session_to_pem(VALUE self) { SSL_SESSION *ctx; BIO *out; GetSSLSession(self, ctx); if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eSSLSession, "BIO_s_mem()"); } if (!PEM_write_bio_SSL_SESSION(out, ctx)) { BIO_free(out); ossl_raise(eSSLSession, "SSL_SESSION_print()"); } return ossl_membio2str(out); };T;)I"5static VALUE ossl_ssl_session_to_pem(VALUE self);T;*To;;F; ;;;;I""OpenSSL::SSL::Session#to_text;F;[;[[@ÜÇi ;T;;´;0;[;{;IC;"MShows everything in the Session object. This is for diagnostic purposes. ;T;[o;= ;3I" overload;F;40;;´;50;)I"to_text;T;IC;";T; @è;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @è;[;I"@return [String];T;0;6i;[; @è;[;I"tShows everything in the Session object. This is for diagnostic purposes. @overload to_text @return [String];T;0; @è;!F;"o;#;$T;%i;&i;'@Üæ;(I"Nstatic VALUE ossl_ssl_session_to_text(VALUE self) { SSL_SESSION *ctx; BIO *out; GetSSLSession(self, ctx); if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eSSLSession, "BIO_s_mem()"); } if (!SSL_SESSION_print(out, ctx)) { BIO_free(out); ossl_raise(eSSLSession, "SSL_SESSION_print()"); } return ossl_membio2str(out); };T;)I"6static VALUE ossl_ssl_session_to_text(VALUE self);T;*T;A@Üæ;BIC;[;A@Üæ;CIC;[;A@Üæ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ÜÇi;;F;:Session;;K;;;[;{;IC;";T;[;[;@|;0; @Üæ;6i;'@Úæ;I"OpenSSL::SSL::Session;F;S@]o; ;IC;[;A@9è;BIC;[;A@9è;CIC;[;A@9è;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@äÇiù [@äÇiý ;T;: SSLError;;K;;;[;{;IC;" Generic error class raised by SSLSocket and SSLContext. ;T;0; @9è;!F;"o;#;$T;%iù ;&iû ;'@Úæ;I"OpenSSL::SSL::SSLError;F;S@ÅÇo; ;IC;[;A@Mè;BIC;[;A@Mè;CIC;[o; ;IC;[;A@Qè;BIC;[;A@Qè;CIC;[;A@Qè;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@iK4[@äÇiÐ ;F;:WaitReadable;;K;;;[;{;IC;";T;[;[;@|;0; @Qè;'o; ;IC;[—o;{;[[@iF4;F;: READABLE;;};;;[;{;IC;";T;[;[;@|;0; @dè;'@bè;I"IO::READABLE;F;~I"INT2NUM(RUBY_IO_READABLE);To;{;[[@iG4;F;: WRITABLE;;};;;[;{;IC;";T;[;[;@|;0; @nè;'@bè;I"IO::WRITABLE;F;~I"INT2NUM(RUBY_IO_WRITABLE);To;{;[[@iH4;F;: PRIORITY;;};;;[;{;IC;";T;[;[;@|;0; @xè;'@bè;I"IO::PRIORITY;F;~I"INT2NUM(RUBY_IO_PRIORITY);T@Qèo; ;IC;[;A@‚è;BIC;[;A@‚è;CIC;[;A@‚è;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@iM4[@äÇiÑ ;F;:WaitWritable;;K;;;[;{;IC;";T;[;[;@|;0; @‚è;'@bè;I"IO::WaitWritable;Fo; ;IC;[;A@”è;BIC;[;A@”è;CIC;[@Qè;A@”è;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@iO4;F;:EAGAINWaitReadable;;K;;;[;{;IC;";T;[;[;@|;0; @”è;'@bè;I"IO::EAGAINWaitReadable;F;So;L;M0;N0;O0;:EAGAIN;'@;Q0;R;Fo; ;IC;[;A@¦è;BIC;[;A@¦è;CIC;[@‚è;A@¦è;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@iR4;F;:EAGAINWaitWritable;;K;;;[;{;IC;";T;[;[;@|;0; @¦è;'@bè;I"IO::EAGAINWaitWritable;F;So;L;M0;N0;O0;;v;'@;Q0;R;Fo; ;IC;[;A@¸è;BIC;[;A@¸è;CIC;[@Qè;A@¸è;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@i]4;F;:EWOULDBLOCKWaitReadable;;K;;;[;{;IC;";T;[;[;@|;0; @¸è;'@bè;I" IO::EWOULDBLOCKWaitReadable;F;So;L;M0;N0;O0;:EWOULDBLOCK;'@;Q0;R;Fo; ;IC;[;A@Êè;BIC;[;A@Êè;CIC;[@‚è;A@Êè;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@i`4;F;:EWOULDBLOCKWaitWritable;;K;;;[;{;IC;";T;[;[;@|;0; @Êè;'@bè;I" IO::EWOULDBLOCKWaitWritable;F;So;L;M0;N0;O0;;y;'@;Q0;R;Fo; ;IC;[;A@Üè;BIC;[;A@Üè;CIC;[@Qè;A@Üè;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@id4;F;:EINPROGRESSWaitReadable;;K;;;[;{;IC;";T;[;[;@|;0; @Üè;'@bè;I" IO::EINPROGRESSWaitReadable;F;So;L;M0;N0;O0;:EINPROGRESS;'@;Q0;R;Fo; ;IC;[;A@îè;BIC;[;A@îè;CIC;[@‚è;A@îè;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ig4;F;:EINPROGRESSWaitWritable;;K;;;[;{;IC;";T;[;[;@|;0; @îè;'@bè;I" IO::EINPROGRESSWaitWritable;F;So;L;M0;N0;O0;;|;'@;Q0;R;Fo;;F; ;F;;;I"IO.new;F;[[@c0;[[@iŽ!;T;;î;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @é;!F;"o;#;$T;%i!;&i!;'@bè;(I"Estatic VALUE rb_io_s_new(int argc, VALUE *argv, VALUE klass) { if (rb_block_given_p()) { VALUE cname = rb_obj_as_string(klass); rb_warn("%"PRIsVALUE"::new() does not take block; use %"PRIsVALUE"::open() instead", cname, cname); } return rb_class_new_instance_kw(argc, argv, klass, RB_PASS_CALLED_KEYWORDS); };T;)I"static VALUE;T;*To;;F; ;F;;;I"IO.open;F;[[@c0;[[@i;T;;Ÿ;0;[;{;IC;"Ëcall-seq: IO.open(fd, mode="r" [, opt]) -> io IO.open(fd, mode="r" [, opt]) {|io| block } -> obj With no associated block, IO.open is a synonym for IO.new. If the optional code block is given, it will be passed +io+ as an argument, and the IO object will automatically be closed when the block terminates. In this instance, IO.open returns the value of the block. See IO.new for a description of the +fd+, +mode+ and +opt+ parameters. ;T;[;[;I"Í call-seq: IO.open(fd, mode="r" [, opt]) -> io IO.open(fd, mode="r" [, opt]) {|io| block } -> obj With no associated block, IO.open is a synonym for IO.new. If the optional code block is given, it will be passed +io+ as an argument, and the IO object will automatically be closed when the block terminates. In this instance, IO.open returns the value of the block. See IO.new for a description of the +fd+, +mode+ and +opt+ parameters. ;T;0; @é;!F;"o;#;$T;%iò;&iý;'@bè;(I"ústatic VALUE rb_io_s_open(int argc, VALUE *argv, VALUE klass) { VALUE io = rb_class_new_instance_kw(argc, argv, klass, RB_PASS_CALLED_KEYWORDS); if (rb_block_given_p()) { return rb_ensure(rb_yield, io, io_close, io); } return io; };T;)I"static VALUE;T;*To;;F; ;F;;;I"IO.sysopen;F;[[@c0;[[@i;T;;I;0;[;{;IC;"tOpens the given path, returning the underlying file descriptor as a Integer. IO.sysopen("testfile") #=> 3 ;T;[o;= ;3I" overload;F;40;;I;50;)I""sysopen(path, [mode, [perm]]);T;IC;";T; @é;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @é;[;I"@return [Integer];T;0;6i;[[I" path;T0[I"[mode, [perm]];T0; @é;[;I"Opens the given path, returning the underlying file descriptor as a Integer. IO.sysopen("testfile") #=> 3 @overload sysopen(path, [mode, [perm]]) @return [Integer];T;0; @é;!F;"o;#;$T;%i ;&i;'@bè;(I"¬static VALUE rb_io_s_sysopen(int argc, VALUE *argv, VALUE _) { VALUE fname, vmode, vperm; VALUE intmode; int oflags, fd; mode_t perm; rb_scan_args(argc, argv, "12", &fname, &vmode, &vperm); FilePathValue(fname); if (NIL_P(vmode)) oflags = O_RDONLY; else if (!NIL_P(intmode = rb_check_to_integer(vmode, "to_int"))) oflags = NUM2INT(intmode); else { SafeStringValue(vmode); oflags = rb_io_modestr_oflags(StringValueCStr(vmode)); } if (NIL_P(vperm)) perm = 0666; else perm = NUM2MODET(vperm); RB_GC_GUARD(fname) = rb_str_new4(fname); fd = rb_sysopen(fname, oflags, perm); return INT2NUM(fd); };T;)I"static VALUE;T;*To;;F; ;F;;;I"IO.for_fd;F;[[@c0;[[@i£!;T;:for_fd;0;[;{;IC;"Synonym for IO.new. ;T;[o;= ;3I" overload;F;40;;~;50;)I"for_fd(fd, mode [, opt]);T;IC;";T; @>é;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"IO;T; @>é;[;I"@return [IO];T;0;6i;[[I"fd;T0[I"mode[, opt];T0; @>é;[;I"MSynonym for IO.new. @overload for_fd(fd, mode [, opt]) @return [IO];T;0; @>é;!F;"o;#;$T;%i›!;&i !;'@bè;(I"œstatic VALUE rb_io_s_for_fd(int argc, VALUE *argv, VALUE klass) { VALUE io = rb_obj_alloc(klass); rb_io_initialize(argc, argv, io); return io; };T;)I"static VALUE;T;*To;;F; ;F;;;I" IO.popen;F;[[@c0;[[@ii;T;: popen;0;[;{;IC;"ERuns the specified command as a subprocess; the subprocess's standard input and output will be connected to the returned IO object. The PID of the started process can be obtained by IO#pid method. _cmd_ is a string or an array as follows. cmd: "-" : fork commandline : command line string which is passed to a shell [env, cmdname, arg1, ..., opts] : command name and zero or more arguments (no shell) [env, [cmdname, argv0], arg1, ..., opts] : command name, argv[0] and zero or more arguments (no shell) (env and opts are optional.) If _cmd_ is a +String+ ``-'', then a new instance of Ruby is started as the subprocess. If cmd is an +Array+ of +String+, then it will be used as the subprocess's +argv+ bypassing a shell. The array can contain a hash at first for environments and a hash at last for options similar to #spawn. The default mode for the new file object is ``r'', but mode may be set to any of the modes listed in the description for class IO. The last argument opt qualifies mode. # set IO encoding IO.popen("nkf -e filename", :external_encoding=>"EUC-JP") {|nkf_io| euc_jp_string = nkf_io.read } # merge standard output and standard error using # spawn option. See the document of Kernel.spawn. IO.popen(["ls", "/", :err=>[:child, :out]]) {|ls_io| ls_result_with_error = ls_io.read } # spawn options can be mixed with IO options IO.popen(["ls", "/"], :err=>[:child, :out]) {|ls_io| ls_result_with_error = ls_io.read } Raises exceptions which IO.pipe and Kernel.spawn raise. If a block is given, Ruby will run the command as a child connected to Ruby with a pipe. Ruby's end of the pipe will be passed as a parameter to the block. At the end of block, Ruby closes the pipe and sets $?. In this case IO.popen returns the value of the block. If a block is given with a _cmd_ of ``-'', the block will be run in two separate processes: once in the parent, and once in a child. The parent process will be passed the pipe object as a parameter to the block, the child version of the block will be passed +nil+, and the child's standard in and standard out will be connected to the parent through the pipe. Not available on all platforms. f = IO.popen("uname") p f.readlines f.close puts "Parent is #{Process.pid}" IO.popen("date") {|f| puts f.gets } IO.popen("-") {|f| $stderr.puts "#{Process.pid} is here, f is #{f.inspect}"} p $? IO.popen(%w"sed -e s|^|| -e s&$&;zot;&", "r+") {|f| f.puts "bar"; f.close_write; puts f.gets } produces: ["Linux\n"] Parent is 21346 Thu Jan 15 22:41:19 JST 2009 21346 is here, f is # 21352 is here, f is nil # bar;zot; ;T;[o;= ;3I" overload;F;40;;;50;)I"(popen([env,] cmd, mode="r" [, opt]);T;IC;";T; @^é;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"IO;T; @^é;[;I"@return [IO];T;0;6i;[[I"[env,];T0[I" mode;TI""r"[, opt];T; @^éo;= ;3I" overload;F;40;;;50;)I"(popen([env,] cmd, mode="r" [, opt]);T;IC;";T; @^é;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"io;T; @^éo;2 ;3I"return;F;4I";T;0;5[I"Object;T; @^é;[;I"!@yield [io] @return [Object];T;0;6i;[[I"[env,];T0[I" mode;TI""r"[, opt];T; @^é;[;I"ÓRuns the specified command as a subprocess; the subprocess's standard input and output will be connected to the returned IO object. The PID of the started process can be obtained by IO#pid method. _cmd_ is a string or an array as follows. cmd: "-" : fork commandline : command line string which is passed to a shell [env, cmdname, arg1, ..., opts] : command name and zero or more arguments (no shell) [env, [cmdname, argv0], arg1, ..., opts] : command name, argv[0] and zero or more arguments (no shell) (env and opts are optional.) If _cmd_ is a +String+ ``-'', then a new instance of Ruby is started as the subprocess. If cmd is an +Array+ of +String+, then it will be used as the subprocess's +argv+ bypassing a shell. The array can contain a hash at first for environments and a hash at last for options similar to #spawn. The default mode for the new file object is ``r'', but mode may be set to any of the modes listed in the description for class IO. The last argument opt qualifies mode. # set IO encoding IO.popen("nkf -e filename", :external_encoding=>"EUC-JP") {|nkf_io| euc_jp_string = nkf_io.read } # merge standard output and standard error using # spawn option. See the document of Kernel.spawn. IO.popen(["ls", "/", :err=>[:child, :out]]) {|ls_io| ls_result_with_error = ls_io.read } # spawn options can be mixed with IO options IO.popen(["ls", "/"], :err=>[:child, :out]) {|ls_io| ls_result_with_error = ls_io.read } Raises exceptions which IO.pipe and Kernel.spawn raise. If a block is given, Ruby will run the command as a child connected to Ruby with a pipe. Ruby's end of the pipe will be passed as a parameter to the block. At the end of block, Ruby closes the pipe and sets $?. In this case IO.popen returns the value of the block. If a block is given with a _cmd_ of ``-'', the block will be run in two separate processes: once in the parent, and once in a child. The parent process will be passed the pipe object as a parameter to the block, the child version of the block will be passed +nil+, and the child's standard in and standard out will be connected to the parent through the pipe. Not available on all platforms. f = IO.popen("uname") p f.readlines f.close puts "Parent is #{Process.pid}" IO.popen("date") {|f| puts f.gets } IO.popen("-") {|f| $stderr.puts "#{Process.pid} is here, f is #{f.inspect}"} p $? IO.popen(%w"sed -e s|^|| -e s&$&;zot;&", "r+") {|f| f.puts "bar"; f.close_write; puts f.gets } produces: ["Linux\n"] Parent is 21346 Thu Jan 15 22:41:19 JST 2009 21346 is here, f is # 21352 is here, f is nil # bar;zot; @overload popen([env,] cmd, mode="r" [, opt]) @return [IO] @overload popen([env,] cmd, mode="r" [, opt]) @yield [io] @return [Object];T;0; @^é;!F;"o;#;$T;%i;&ih;'@bè;(I"static VALUE rb_io_s_popen(int argc, VALUE *argv, VALUE klass) { VALUE pname, pmode = Qnil, opt = Qnil, env = Qnil; if (argc > 1 && !NIL_P(opt = rb_check_hash_type(argv[argc-1]))) --argc; if (argc > 1 && !NIL_P(env = rb_check_hash_type(argv[0]))) --argc, ++argv; switch (argc) { case 2: pmode = argv[1]; case 1: pname = argv[0]; break; default: { int ex = !NIL_P(opt); rb_error_arity(argc + ex, 1 + ex, 2 + ex); } } return popen_finish(rb_io_popen(pname, pmode, env, opt), klass); };T;)I"static VALUE;T;*To;;F; ;F;;;I"IO.foreach;F;[[@c0;[[@i‡);T;:foreach;0;[;{;IC;"éExecutes the block for every line in the named I/O port, where lines are separated by sep. If no block is given, an enumerator is returned instead. IO.foreach("testfile") {|x| print "GOT ", x } produces: GOT This is line one GOT This is line two GOT This is line three GOT And so on... If the last argument is a hash, it's the keyword argument to open. See IO.readlines for details about getline_args. And see also IO.read for details about open_args. ;T;[ o;= ;3I" overload;F;40;;€;50;)I"6foreach(name, sep=$/ [, getline_args, open_args]);T;IC;";T; @–é;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" line;T; @–éo;2 ;3I"return;F;4I";T;0;5[I"nil;T; @–é;[;I" @yield [line] @return [nil];T;0;6i;[[I" name;T0[I"sep;TI""$/[, getline_args, open_args];T; @–éo;= ;3I" overload;F;40;;€;50;)I"5foreach(name, limit [, getline_args, open_args]);T;IC;";T; @–é;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" line;T; @–éo;2 ;3I"return;F;4I";T;0;5[I"nil;T; @–é;[;I" @yield [line] @return [nil];T;0;6i;[[I" name;T0[I"%limit[, getline_args, open_args];T0; @–éo;= ;3I" overload;F;40;;€;50;)I":foreach(name, sep, limit [, getline_args, open_args]);T;IC;";T; @–é;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" line;T; @–éo;2 ;3I"return;F;4I";T;0;5[I"nil;T; @–é;[;I" @yield [line] @return [nil];T;0;6i;[[I" name;T0[I"sep;T0[I"%limit[, getline_args, open_args];T0; @–éo;= ;3I" overload;F;40;;€;50;)I"foreach(...);T;IC;";T; @–é;>0;!F;[;[;I";T;0;6i;[[I"...;T0; @–é;[;I"Executes the block for every line in the named I/O port, where lines are separated by sep. If no block is given, an enumerator is returned instead. IO.foreach("testfile") {|x| print "GOT ", x } produces: GOT This is line one GOT This is line two GOT This is line three GOT And so on... If the last argument is a hash, it's the keyword argument to open. See IO.readlines for details about getline_args. And see also IO.read for details about open_args. @overload foreach(name, sep=$/ [, getline_args, open_args]) @yield [line] @return [nil] @overload foreach(name, limit [, getline_args, open_args]) @yield [line] @return [nil] @overload foreach(name, sep, limit [, getline_args, open_args]) @yield [line] @return [nil] @overload foreach(...);T;0; @–é;!F;"o;#;$T;%il);&i‰);'@bè;(I"Qstatic VALUE rb_io_s_foreach(int argc, VALUE *argv, VALUE self) { VALUE opt; int orig_argc = argc; struct foreach_arg arg; struct getline_arg garg; argc = rb_scan_args(argc, argv, "13:", NULL, NULL, NULL, NULL, &opt); RETURN_ENUMERATOR(self, orig_argc, argv); extract_getline_args(argc-1, argv+1, &garg); open_key_args(self, argc, argv, opt, &arg); if (NIL_P(arg.io)) return Qnil; extract_getline_opts(opt, &garg); check_getline_args(&garg.rs, &garg.limit, garg.io = arg.io); return rb_ensure(io_s_foreach, (VALUE)&garg, rb_io_close, arg.io); };T;)I"static VALUE;T;*To;;F; ;F;;;I"IO.readlines;F;[[@c0;[[@i¾);T;;§;0;[;{;IC;"ˆReads the entire file specified by name as individual lines, and returns those lines in an array. Lines are separated by sep. a = IO.readlines("testfile") a[0] #=> "This is line one\n" b = IO.readlines("testfile", chomp: true) b[0] #=> "This is line one" If the last argument is a hash, it's the keyword argument to open. === Options for getline The options hash accepts the following keys: :chomp:: When the optional +chomp+ keyword argument has a true value, \n, \r, and \r\n will be removed from the end of each line. See also IO.read for details about open_args. ;T;[o;= ;3I" overload;F;40;;§;50;)I"8readlines(name, sep=$/ [, getline_args, open_args]);T;IC;";T; @ôé;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ôé;[;I"@return [Array];T;0;6i;[[I" name;T0[I"sep;TI""$/[, getline_args, open_args];T; @ôéo;= ;3I" overload;F;40;;§;50;)I"7readlines(name, limit [, getline_args, open_args]);T;IC;";T; @ôé;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ôé;[;I"@return [Array];T;0;6i;[[I" name;T0[I"%limit[, getline_args, open_args];T0; @ôéo;= ;3I" overload;F;40;;§;50;)I"0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ôé;[;I"@return [Array];T;0;6i;[[I" name;T0[I"sep;T0[I"%limit[, getline_args, open_args];T0; @ôé;[;I"}Reads the entire file specified by name as individual lines, and returns those lines in an array. Lines are separated by sep. a = IO.readlines("testfile") a[0] #=> "This is line one\n" b = IO.readlines("testfile", chomp: true) b[0] #=> "This is line one" If the last argument is a hash, it's the keyword argument to open. === Options for getline The options hash accepts the following keys: :chomp:: When the optional +chomp+ keyword argument has a true value, \n, \r, and \r\n will be removed from the end of each line. See also IO.read for details about open_args. @overload readlines(name, sep=$/ [, getline_args, open_args]) @return [Array] @overload readlines(name, limit [, getline_args, open_args]) @return [Array] @overload readlines(name, sep, limit [, getline_args, open_args]) @return [Array];T;0; @ôé;!F;"o;#;$T;%i );&i½);'@bè;(I" static VALUE rb_io_s_readlines(int argc, VALUE *argv, VALUE io) { VALUE opt; struct foreach_arg arg; struct getline_arg garg; argc = rb_scan_args(argc, argv, "13:", NULL, NULL, NULL, NULL, &opt); extract_getline_args(argc-1, argv+1, &garg); open_key_args(io, argc, argv, opt, &arg); if (NIL_P(arg.io)) return Qnil; extract_getline_opts(opt, &garg); check_getline_args(&garg.rs, &garg.limit, garg.io = arg.io); return rb_ensure(io_s_readlines, (VALUE)&garg, rb_io_close, arg.io); };T;)I"static VALUE;T;*To;;F; ;F;;;I"IO.read;F;[[@c0;[[@i *;T;;è;0;[;{;IC;"·Opens the file, optionally seeks to the given +offset+, then returns +length+ bytes (defaulting to the rest of the file). #read ensures the file is closed before returning. If +name+ starts with a pipe character ("|"), a subprocess is created in the same way as Kernel#open, and its output is returned. === Options The options hash accepts the following keys: :encoding:: string or encoding Specifies the encoding of the read string. +:encoding+ will be ignored if +length+ is specified. See Encoding.aliases for possible encodings. :mode:: string or integer Specifies the mode argument for open(). It must start with an "r", otherwise it will cause an error. See IO.new for the list of possible modes. :open_args:: array Specifies arguments for open() as an array. This key can not be used in combination with either +:encoding+ or +:mode+. Examples: IO.read("testfile") #=> "This is line one\nThis is line two\nThis is line three\nAnd so on...\n" IO.read("testfile", 20) #=> "This is line one\nThi" IO.read("testfile", 20, 10) #=> "ne one\nThis is line " IO.read("binfile", mode: "rb") #=> "\xF7\x00\x00\x0E\x12" ;T;[o;= ;3I" overload;F;40;;è;50;)I"-read(name, [length [, offset]] [, opt] );T;IC;";T; @9ê;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @9ê;[;I"@return [String];T;0;6i;[[I" name;T0[I"[length [, offset]][, opt];T0; @9ê;[;I"ÿOpens the file, optionally seeks to the given +offset+, then returns +length+ bytes (defaulting to the rest of the file). #read ensures the file is closed before returning. If +name+ starts with a pipe character ("|"), a subprocess is created in the same way as Kernel#open, and its output is returned. === Options The options hash accepts the following keys: :encoding:: string or encoding Specifies the encoding of the read string. +:encoding+ will be ignored if +length+ is specified. See Encoding.aliases for possible encodings. :mode:: string or integer Specifies the mode argument for open(). It must start with an "r", otherwise it will cause an error. See IO.new for the list of possible modes. :open_args:: array Specifies arguments for open() as an array. This key can not be used in combination with either +:encoding+ or +:mode+. Examples: IO.read("testfile") #=> "This is line one\nThis is line two\nThis is line three\nAnd so on...\n" IO.read("testfile", 20) #=> "This is line one\nThi" IO.read("testfile", 20, 10) #=> "ne one\nThis is line " IO.read("binfile", mode: "rb") #=> "\xF7\x00\x00\x0E\x12" @overload read(name, [length [, offset]] [, opt] ) @return [String];T;0; @9ê;!F;"o;#;$T;%iã);&i *;'@bè;(I"ystatic VALUE rb_io_s_read(int argc, VALUE *argv, VALUE io) { VALUE opt, offset; struct foreach_arg arg; argc = rb_scan_args(argc, argv, "13:", NULL, NULL, &offset, NULL, &opt); open_key_args(io, argc, argv, opt, &arg); if (NIL_P(arg.io)) return Qnil; if (!NIL_P(offset)) { struct seek_arg sarg; int state = 0; sarg.io = arg.io; sarg.offset = offset; sarg.mode = SEEK_SET; rb_protect(seek_before_access, (VALUE)&sarg, &state); if (state) { rb_io_close(arg.io); rb_jump_tag(state); } if (arg.argc == 2) arg.argc = 1; } return rb_ensure(io_s_read, (VALUE)&arg, rb_io_close, arg.io); };T;)I"static VALUE;T;*To;;F; ;F;;;I"IO.binread;F;[[@c0;[[@i4*;T;;G;0;[;{;IC;"áOpens the file, optionally seeks to the given offset, then returns length bytes (defaulting to the rest of the file). #binread ensures the file is closed before returning. The open mode would be "rb:ASCII-8BIT". IO.binread("testfile") #=> "This is line one\nThis is line two\nThis is line three\nAnd so on...\n" IO.binread("testfile", 20) #=> "This is line one\nThi" IO.binread("testfile", 20, 10) #=> "ne one\nThis is line " ;T;[o;= ;3I" overload;F;40;;G;50;)I"(binread(name, [length [, offset]] );T;IC;";T; @Yê;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Yê;[;I"@return [String];T;0;6i;[[I" name;T0[I"[length [, offset]];T0; @Yê;[;I"$Opens the file, optionally seeks to the given offset, then returns length bytes (defaulting to the rest of the file). #binread ensures the file is closed before returning. The open mode would be "rb:ASCII-8BIT". IO.binread("testfile") #=> "This is line one\nThis is line two\nThis is line three\nAnd so on...\n" IO.binread("testfile", 20) #=> "This is line one\nThi" IO.binread("testfile", 20, 10) #=> "ne one\nThis is line " @overload binread(name, [length [, offset]] ) @return [String];T;0; @Yê;!F;"o;#;$T;%i&*;&i1*;'@bè;(I"ˆstatic VALUE rb_io_s_binread(int argc, VALUE *argv, VALUE io) { VALUE offset; struct foreach_arg arg; enum { fmode = FMODE_READABLE|FMODE_BINMODE, oflags = O_RDONLY #ifdef O_BINARY |O_BINARY #endif }; convconfig_t convconfig = {NULL, NULL, 0, Qnil}; rb_scan_args(argc, argv, "12", NULL, NULL, &offset); FilePathValue(argv[0]); convconfig.enc = rb_ascii8bit_encoding(); arg.io = rb_io_open_generic(io, argv[0], oflags, fmode, &convconfig, 0); if (NIL_P(arg.io)) return Qnil; arg.argv = argv+1; arg.argc = (argc > 1) ? 1 : 0; if (!NIL_P(offset)) { struct seek_arg sarg; int state = 0; sarg.io = arg.io; sarg.offset = offset; sarg.mode = SEEK_SET; rb_protect(seek_before_access, (VALUE)&sarg, &state); if (state) { rb_io_close(arg.io); rb_jump_tag(state); } } return rb_ensure(io_s_read, (VALUE)&arg, rb_io_close, arg.io); };T;)I"static VALUE;T;*To;;F; ;F;;;I" IO.write;F;[[@c0;[[@iº*;T;;é;0;[;{;IC;"sOpens the file, optionally seeks to the given offset, writes string, then returns the length written. #write ensures the file is closed before returning. If offset is not given in write mode, the file is truncated. Otherwise, it is not truncated. IO.write("testfile", "0123456789", 20) #=> 10 # File could contain: "This is line one\nThi0123456789two\nThis is line three\nAnd so on...\n" IO.write("testfile", "0123456789") #=> 10 # File would now read: "0123456789" If the last argument is a hash, it specifies options for the internal open(). It accepts the following keys: :encoding:: string or encoding Specifies the encoding of the read string. See Encoding.aliases for possible encodings. :mode:: string or integer Specifies the mode argument for open(). It must start with "w", "a", or "r+", otherwise it will cause an error. See IO.new for the list of possible modes. :perm:: integer Specifies the perm argument for open(). :open_args:: array Specifies arguments for open() as an array. This key can not be used in combination with other keys. ;T;[o;= ;3I" overload;F;40;;é;50;)I"#write(name, string [, offset]);T;IC;";T; @yê;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @yê;[;I"@return [Integer];T;0;6i;[[I" name;T0[I"string[, offset];T0; @yêo;= ;3I" overload;F;40;;é;50;)I"+write(name, string [, offset] [, opt]);T;IC;";T; @yê;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @yê;[;I"@return [Integer];T;0;6i;[[I" name;T0[I"string[, offset][, opt];T0; @yê;[;I"÷Opens the file, optionally seeks to the given offset, writes string, then returns the length written. #write ensures the file is closed before returning. If offset is not given in write mode, the file is truncated. Otherwise, it is not truncated. IO.write("testfile", "0123456789", 20) #=> 10 # File could contain: "This is line one\nThi0123456789two\nThis is line three\nAnd so on...\n" IO.write("testfile", "0123456789") #=> 10 # File would now read: "0123456789" If the last argument is a hash, it specifies options for the internal open(). It accepts the following keys: :encoding:: string or encoding Specifies the encoding of the read string. See Encoding.aliases for possible encodings. :mode:: string or integer Specifies the mode argument for open(). It must start with "w", "a", or "r+", otherwise it will cause an error. See IO.new for the list of possible modes. :perm:: integer Specifies the perm argument for open(). :open_args:: array Specifies arguments for open() as an array. This key can not be used in combination with other keys. @overload write(name, string [, offset]) @return [Integer] @overload write(name, string [, offset] [, opt]) @return [Integer];T;0; @yê;!F;"o;#;$T;%i*;&i¸*;'@bè;(I"nstatic VALUE rb_io_s_write(int argc, VALUE *argv, VALUE io) { return io_s_write(argc, argv, io, 0); };T;)I"static VALUE;T;*To;;F; ;F;;;I"IO.binwrite;F;[[@c0;[[@iÉ*;T;;H;0;[;{;IC;"tSame as IO.write except opening the file in binary mode and ASCII-8BIT encoding ("wb:ASCII-8BIT"). ;T;[o;= ;3I" overload;F;40;;H;50;)I"&binwrite(name, string, [offset] );T;IC;";T; @ªê;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ªê;[;I"@return [Integer];T;0;6i;[[I" name;T0[I"string;T0[I" [offset];T0; @ªêo;= ;3I" overload;F;40;;H;50;)I"1binwrite(name, string, [offset], open_args );T;IC;";T; @ªê;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ªê;[;I"@return [Integer];T;0;6i;[ [I" name;T0[I"string;T0[I" [offset];T0[I"open_args;T0; @ªê;[;I"üSame as IO.write except opening the file in binary mode and ASCII-8BIT encoding ("wb:ASCII-8BIT"). @overload binwrite(name, string, [offset] ) @return [Integer] @overload binwrite(name, string, [offset], open_args ) @return [Integer];T;0; @ªê;!F;"o;#;$T;%iÀ*;&iÇ*;'@bè;(I"qstatic VALUE rb_io_s_binwrite(int argc, VALUE *argv, VALUE io) { return io_s_write(argc, argv, io, 1); };T;)I"static VALUE;T;*To;;F; ;F;;;I"IO.select;F;[[@c0;[[@i&;T;;¦;0;[;{;IC;"É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 block. 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 are 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;= ;3I" overload;F;40;;¦;50;)I"Cselect(read_array [, write_array [, error_array [, timeout]]]);T;IC;";T; @áê;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;TI"nil;T; @áê;[;I"@return [Array, nil];T;0;6i;[[I":read_array[, write_array [, error_array [, timeout]]];T0; @áê;[;@t;0; @áê;!F;"o;#;$T;%iˆ%;&i&;'@bè;(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;)I"static VALUE;T;*To;;F; ;F;;;I"IO.pipe;F;[[@c0;[[@iè(;T;: pipe;0;[;{;IC;"0IO.pipe(...) {|read_io, write_io| ... } Creates a pair of pipe endpoints (connected to each other) and returns them as a two-element array of IO objects: [ read_io, write_io ]. If a block is given, the block is called and returns the value of the block. read_io and write_io are sent to the block as arguments. If read_io and write_io are not closed when the block exits, they are closed. i.e. closing read_io and/or write_io doesn't cause an error. Not available on all platforms. If an encoding (encoding name or encoding object) is specified as an optional argument, read string from pipe is tagged with the encoding specified. If the argument is a colon separated two encoding names "A:B", the read string is converted from encoding A (external encoding) to encoding B (internal encoding), then tagged with B. If two optional arguments are specified, those must be encoding objects or encoding names, and the first one is the external encoding, and the second one is the internal encoding. If the external encoding and the internal encoding is specified, optional hash argument specify the conversion option. In the example below, the two processes close the ends of the pipe that they are not using. This is not just a cosmetic nicety. The read end of a pipe will not generate an end of file condition if there are any writers with the pipe still open. In the case of the parent process, the rd.read will never return if it does not first issue a wr.close. rd, wr = IO.pipe if fork wr.close puts "Parent got: <#{rd.read}>" rd.close Process.wait else rd.close puts "Sending message to parent" wr.write "Hi Dad" wr.close end produces: Sending message to parent Parent got: ;T;[ o;= ;3I" overload;F;40;;;50;)I" pipe;T;IC;";T; @ÿê;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ÿê;[;I"@return [Array];T;0;6i;[; @ÿêo;= ;3I" overload;F;40;;;50;)I"pipe(ext_enc);T;IC;";T; @ÿê;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ÿê;[;I"@return [Array];T;0;6i;[[I"ext_enc;T0; @ÿêo;= ;3I" overload;F;40;;;50;)I"$pipe("ext_enc:int_enc" [, opt]);T;IC;";T; @ÿê;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ÿê;[;I"@return [Array];T;0;6i;[[""ext_enc:"int_enc"[, opt]; @ÿêo;= ;3I" overload;F;40;;;50;)I"#pipe(ext_enc, int_enc [, opt]);T;IC;";T; @ÿê;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ÿê;[;I"@return [Array];T;0;6i;[[I"ext_enc;T0[I"int_enc[, opt];T0; @ÿê;[;I"÷ IO.pipe(...) {|read_io, write_io| ... } Creates a pair of pipe endpoints (connected to each other) and returns them as a two-element array of IO objects: [ read_io, write_io ]. If a block is given, the block is called and returns the value of the block. read_io and write_io are sent to the block as arguments. If read_io and write_io are not closed when the block exits, they are closed. i.e. closing read_io and/or write_io doesn't cause an error. Not available on all platforms. If an encoding (encoding name or encoding object) is specified as an optional argument, read string from pipe is tagged with the encoding specified. If the argument is a colon separated two encoding names "A:B", the read string is converted from encoding A (external encoding) to encoding B (internal encoding), then tagged with B. If two optional arguments are specified, those must be encoding objects or encoding names, and the first one is the external encoding, and the second one is the internal encoding. If the external encoding and the internal encoding is specified, optional hash argument specify the conversion option. In the example below, the two processes close the ends of the pipe that they are not using. This is not just a cosmetic nicety. The read end of a pipe will not generate an end of file condition if there are any writers with the pipe still open. In the case of the parent process, the rd.read will never return if it does not first issue a wr.close. rd, wr = IO.pipe if fork wr.close puts "Parent got: <#{rd.read}>" rd.close Process.wait else rd.close puts "Sending message to parent" wr.write "Hi Dad" wr.close end produces: Sending message to parent Parent got: @overload pipe @return [Array] @overload pipe(ext_enc) @return [Array] @overload pipe("ext_enc:int_enc" [, opt]) @return [Array] @overload pipe(ext_enc, int_enc [, opt]) @return [Array];T;0; @ÿê;!F;"o;#;$T;%i¬(;&iè(;'@bè;(I"ýstatic VALUE rb_io_s_pipe(int argc, VALUE *argv, VALUE klass) { int pipes[2], state; VALUE r, w, args[3], v1, v2; VALUE opt; rb_io_t *fptr, *fptr2; struct io_encoding_set_args ies_args; int fmode = 0; VALUE ret; argc = rb_scan_args(argc, argv, "02:", &v1, &v2, &opt); if (rb_pipe(pipes) < 0) rb_sys_fail(0); args[0] = klass; args[1] = INT2NUM(pipes[0]); args[2] = INT2FIX(O_RDONLY); r = rb_protect(io_new_instance, (VALUE)args, &state); if (state) { close(pipes[0]); close(pipes[1]); rb_jump_tag(state); } GetOpenFile(r, fptr); ies_args.fptr = fptr; ies_args.v1 = v1; ies_args.v2 = v2; ies_args.opt = opt; rb_protect(io_encoding_set_v, (VALUE)&ies_args, &state); if (state) { close(pipes[1]); io_close(r); rb_jump_tag(state); } args[1] = INT2NUM(pipes[1]); args[2] = INT2FIX(O_WRONLY); w = rb_protect(io_new_instance, (VALUE)args, &state); if (state) { close(pipes[1]); if (!NIL_P(r)) rb_io_close(r); rb_jump_tag(state); } GetOpenFile(w, fptr2); rb_io_synchronized(fptr2); extract_binmode(opt, &fmode); if ((fmode & FMODE_BINMODE) && v1 == Qnil) { rb_io_ascii8bit_binmode(r); rb_io_ascii8bit_binmode(w); } #if DEFAULT_TEXTMODE if ((fptr->mode & FMODE_TEXTMODE) && (fmode & FMODE_BINMODE)) { fptr->mode &= ~FMODE_TEXTMODE; setmode(fptr->fd, O_BINARY); } #if defined(RUBY_TEST_CRLF_ENVIRONMENT) || defined(_WIN32) if (fptr->encs.ecflags & ECONV_DEFAULT_NEWLINE_DECORATOR) { fptr->encs.ecflags |= ECONV_UNIVERSAL_NEWLINE_DECORATOR; } #endif #endif fptr->mode |= fmode; #if DEFAULT_TEXTMODE if ((fptr2->mode & FMODE_TEXTMODE) && (fmode & FMODE_BINMODE)) { fptr2->mode &= ~FMODE_TEXTMODE; setmode(fptr2->fd, O_BINARY); } #endif fptr2->mode |= fmode; ret = rb_assoc_new(r, w); if (rb_block_given_p()) { VALUE rw[2]; rw[0] = r; rw[1] = w; return rb_ensure(rb_yield, ret, pipe_pair_close, (VALUE)rw); } return ret; };T;)I"static VALUE;T;*To;;F; ;F;;;I"IO.try_convert;F;[[I"io;T0;[[@iM;T;;¤;0;[;{;IC;"œTry to convert obj into an IO, using to_io method. Returns converted IO or +nil+ if obj cannot be converted for any reason. IO.try_convert(STDOUT) #=> STDOUT IO.try_convert("STDOUT") #=> nil require 'zlib' f = open("/tmp/zz.gz") #=> # z = Zlib::GzipReader.open(f) #=> # IO.try_convert(z) #=> # ;T;[o;= ;3I" overload;F;40;;¤;50;)I"try_convert(obj);T;IC;";T; @Kë;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"IO;TI"nil;T; @Kë;[;I"@return [IO, nil];T;0;6i;[[I"obj;T0; @Kë;[;I"ÎTry to convert obj into an IO, using to_io method. Returns converted IO or +nil+ if obj cannot be converted for any reason. IO.try_convert(STDOUT) #=> STDOUT IO.try_convert("STDOUT") #=> nil require 'zlib' f = open("/tmp/zz.gz") #=> # z = Zlib::GzipReader.open(f) #=> # IO.try_convert(z) #=> # @overload try_convert(obj) @return [IO, nil];T;0; @Kë;!F;"o;#;$T;%i<;&iK;'@bè;(I"_static VALUE rb_io_s_try_convert(VALUE dummy, VALUE io) { return rb_io_check_io(io); };T;)I"static VALUE;T;*To;;F; ;F;;;I"IO.copy_stream;F;[[@c0;[[@iw.;T;:copy_stream;0;[;{;IC;"UIO.copy_stream copies src to dst. src and dst is either a filename or an IO-like object. IO-like object for src should have #readpartial or #read method. IO-like object for dst should have #write method. (Specialized mechanisms, such as sendfile system call, may be used on appropriate situation.) This method returns the number of bytes copied. If optional arguments are not given, the start position of the copy is the beginning of the filename or the current file offset of the IO. The end position of the copy is the end of file. If copy_length is given, No more than copy_length bytes are copied. If src_offset is given, it specifies the start position of the copy. When src_offset is specified and src is an IO, IO.copy_stream doesn't move the current file offset. ;T;[o;= ;3I" overload;F;40;;‚;50;)I"copy_stream(src, dst);T;IC;";T; @kë;>0;!F;[;[;I";T;0;6i;[[I"src;T0[I"dst;T0; @këo;= ;3I" overload;F;40;;‚;50;)I"'copy_stream(src, dst, copy_length);T;IC;";T; @kë;>0;!F;[;[;I";T;0;6i;[[I"src;T0[I"dst;T0[I"copy_length;T0; @këo;= ;3I" overload;F;40;;‚;50;)I"3copy_stream(src, dst, copy_length, src_offset);T;IC;";T; @kë;>0;!F;[;[;I";T;0;6i;[ [I"src;T0[I"dst;T0[I"copy_length;T0[I"src_offset;T0; @kë;[;I"ÞIO.copy_stream copies src to dst. src and dst is either a filename or an IO-like object. IO-like object for src should have #readpartial or #read method. IO-like object for dst should have #write method. (Specialized mechanisms, such as sendfile system call, may be used on appropriate situation.) This method returns the number of bytes copied. If optional arguments are not given, the start position of the copy is the beginning of the filename or the current file offset of the IO. The end position of the copy is the end of file. If copy_length is given, No more than copy_length bytes are copied. If src_offset is given, it specifies the start position of the copy. When src_offset is specified and src is an IO, IO.copy_stream doesn't move the current file offset. @overload copy_stream(src, dst) @overload copy_stream(src, dst, copy_length) @overload copy_stream(src, dst, copy_length, src_offset);T;0; @kë;!F;"o;#;$T;%iW.;&it.;'@bè;(I"‚static VALUE rb_io_s_copy_stream(int argc, VALUE *argv, VALUE io) { VALUE src, dst, length, src_offset; struct copy_stream_struct st; MEMZERO(&st, struct copy_stream_struct, 1); rb_scan_args(argc, argv, "22", &src, &dst, &length, &src_offset); st.src = src; st.dst = dst; if (NIL_P(length)) st.copy_length = (off_t)-1; else st.copy_length = NUM2OFFT(length); if (NIL_P(src_offset)) st.src_offset = (off_t)-1; else st.src_offset = NUM2OFFT(src_offset); rb_ensure(copy_stream_body, (VALUE)&st, copy_stream_finalize, (VALUE)&st); return OFFT2NUM(st.total); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#initialize;F;[[@c0;[[@iÿ ;T;;Ð;0;[;{;IC;"ÿReturns a new IO object (a stream) for the given integer file descriptor +fd+ and +mode+ string. +opt+ may be used to specify parts of +mode+ in a more readable fashion. See also IO.sysopen and IO.for_fd. IO.new is called by various File and IO opening methods such as IO::open, Kernel#open, and File::open. === Open Mode When +mode+ is an integer it must be combination of the modes defined in File::Constants (+File::RDONLY+, File::WRONLY|File::CREAT). See the open(2) man page for more information. When +mode+ is a string it must be in one of the following forms: fmode fmode ":" ext_enc fmode ":" ext_enc ":" int_enc fmode ":" "BOM|UTF-*" +fmode+ is an IO open mode string, +ext_enc+ is the external encoding for the IO and +int_enc+ is the internal encoding. ==== IO Open Mode Ruby allows the following open modes: "r" Read-only, starts at beginning of file (default mode). "r+" Read-write, starts at beginning of file. "w" Write-only, truncates existing file to zero length or creates a new file for writing. "w+" Read-write, truncates existing file to zero length or creates a new file for reading and writing. "a" Write-only, each write call appends data at end of file. Creates a new file for writing if file does not exist. "a+" Read-write, each write call appends data at end of file. Creates a new file for reading and writing if file does not exist. The following modes must be used separately, and along with one or more of the modes seen above. "b" Binary file mode Suppresses EOL <-> CRLF conversion on Windows. And sets external encoding to ASCII-8BIT unless explicitly specified. "t" Text file mode The exclusive access mode ("x") can be used together with "w" to ensure the file is created. Errno::EEXIST is raised when it already exists. It may not be supported with all kinds of streams (e.g. pipes). When the open mode of original IO is read only, the mode cannot be changed to be writable. Similarly, the open mode cannot be changed from write only to readable. When such a change is attempted the error is raised in different locations according to the platform. === IO Encoding When +ext_enc+ is specified, strings read will be tagged by the encoding when reading, and strings output will be converted to the specified encoding when writing. When +ext_enc+ and +int_enc+ are specified read strings will be converted from +ext_enc+ to +int_enc+ upon input, and written strings will be converted from +int_enc+ to +ext_enc+ upon output. See Encoding for further details of transcoding on input and output. If "BOM|UTF-8", "BOM|UTF-16LE" or "BOM|UTF16-BE" are used, Ruby checks for a Unicode BOM in the input document to help determine the encoding. For UTF-16 encodings the file open mode must be binary. When present, the BOM is stripped and the external encoding from the BOM is used. When the BOM is missing the given Unicode encoding is used as +ext_enc+. (The BOM-set encoding option is case insensitive, so "bom|utf-8" is also valid.) === Options +opt+ can be used instead of +mode+ for improved readability. The following keys are supported: :mode :: Same as +mode+ parameter :flags :: Specifies file open flags as integer. If +mode+ parameter is given, this parameter will be bitwise-ORed. :\external_encoding :: External encoding for the IO. :\internal_encoding :: Internal encoding for the IO. "-" is a synonym for the default internal encoding. If the value is +nil+ no conversion occurs. :encoding :: Specifies external and internal encodings as "extern:intern". :textmode :: If the value is truth value, same as "t" in argument +mode+. :binmode :: If the value is truth value, same as "b" in argument +mode+. :autoclose :: If the value is +false+, the +fd+ will be kept open after this IO instance gets finalized. Also, +opt+ can have same keys in String#encode for controlling conversion between the external encoding and the internal encoding. === Example 1 fd = IO.sysopen("/dev/tty", "w") a = IO.new(fd,"w") $stderr.puts "Hello" a.puts "World" Produces: Hello World === Example 2 require 'fcntl' fd = STDERR.fcntl(Fcntl::F_DUPFD) io = IO.new(fd, mode: 'w:UTF-16LE', cr_newline: true) io.puts "Hello, World!" fd = STDERR.fcntl(Fcntl::F_DUPFD) io = IO.new(fd, mode: 'w', cr_newline: true, external_encoding: Encoding::UTF_16LE) io.puts "Hello, World!" Both of above print "Hello, World!" in UTF-16LE to standard error output with converting EOL generated by #puts to CR. ;T;[o;= ;3I" overload;F;40;;î;50;)I"new(fd [, mode] [, opt]);T;IC;";T; @¤ë;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"IO;T; @¤ë;[;I"@return [IO];T;0;6i;[[I"fd[, mode][, opt];T0; @¤ë;[;I"3Returns a new IO object (a stream) for the given integer file descriptor +fd+ and +mode+ string. +opt+ may be used to specify parts of +mode+ in a more readable fashion. See also IO.sysopen and IO.for_fd. IO.new is called by various File and IO opening methods such as IO::open, Kernel#open, and File::open. === Open Mode When +mode+ is an integer it must be combination of the modes defined in File::Constants (+File::RDONLY+, File::WRONLY|File::CREAT). See the open(2) man page for more information. When +mode+ is a string it must be in one of the following forms: fmode fmode ":" ext_enc fmode ":" ext_enc ":" int_enc fmode ":" "BOM|UTF-*" +fmode+ is an IO open mode string, +ext_enc+ is the external encoding for the IO and +int_enc+ is the internal encoding. ==== IO Open Mode Ruby allows the following open modes: "r" Read-only, starts at beginning of file (default mode). "r+" Read-write, starts at beginning of file. "w" Write-only, truncates existing file to zero length or creates a new file for writing. "w+" Read-write, truncates existing file to zero length or creates a new file for reading and writing. "a" Write-only, each write call appends data at end of file. Creates a new file for writing if file does not exist. "a+" Read-write, each write call appends data at end of file. Creates a new file for reading and writing if file does not exist. The following modes must be used separately, and along with one or more of the modes seen above. "b" Binary file mode Suppresses EOL <-> CRLF conversion on Windows. And sets external encoding to ASCII-8BIT unless explicitly specified. "t" Text file mode The exclusive access mode ("x") can be used together with "w" to ensure the file is created. Errno::EEXIST is raised when it already exists. It may not be supported with all kinds of streams (e.g. pipes). When the open mode of original IO is read only, the mode cannot be changed to be writable. Similarly, the open mode cannot be changed from write only to readable. When such a change is attempted the error is raised in different locations according to the platform. === IO Encoding When +ext_enc+ is specified, strings read will be tagged by the encoding when reading, and strings output will be converted to the specified encoding when writing. When +ext_enc+ and +int_enc+ are specified read strings will be converted from +ext_enc+ to +int_enc+ upon input, and written strings will be converted from +int_enc+ to +ext_enc+ upon output. See Encoding for further details of transcoding on input and output. If "BOM|UTF-8", "BOM|UTF-16LE" or "BOM|UTF16-BE" are used, Ruby checks for a Unicode BOM in the input document to help determine the encoding. For UTF-16 encodings the file open mode must be binary. When present, the BOM is stripped and the external encoding from the BOM is used. When the BOM is missing the given Unicode encoding is used as +ext_enc+. (The BOM-set encoding option is case insensitive, so "bom|utf-8" is also valid.) === Options +opt+ can be used instead of +mode+ for improved readability. The following keys are supported: :mode :: Same as +mode+ parameter :flags :: Specifies file open flags as integer. If +mode+ parameter is given, this parameter will be bitwise-ORed. :\external_encoding :: External encoding for the IO. :\internal_encoding :: Internal encoding for the IO. "-" is a synonym for the default internal encoding. If the value is +nil+ no conversion occurs. :encoding :: Specifies external and internal encodings as "extern:intern". :textmode :: If the value is truth value, same as "t" in argument +mode+. :binmode :: If the value is truth value, same as "b" in argument +mode+. :autoclose :: If the value is +false+, the +fd+ will be kept open after this IO instance gets finalized. Also, +opt+ can have same keys in String#encode for controlling conversion between the external encoding and the internal encoding. === Example 1 fd = IO.sysopen("/dev/tty", "w") a = IO.new(fd,"w") $stderr.puts "Hello" a.puts "World" Produces: Hello World === Example 2 require 'fcntl' fd = STDERR.fcntl(Fcntl::F_DUPFD) io = IO.new(fd, mode: 'w:UTF-16LE', cr_newline: true) io.puts "Hello, World!" fd = STDERR.fcntl(Fcntl::F_DUPFD) io = IO.new(fd, mode: 'w', cr_newline: true, external_encoding: Encoding::UTF_16LE) io.puts "Hello, World!" Both of above print "Hello, World!" in UTF-16LE to standard error output with converting EOL generated by #puts to CR. @overload new(fd [, mode] [, opt]) @return [IO];T;0; @¤ë;!F;"o;#;$T;%if ;&iü ;'@bè;(I"*static VALUE rb_io_initialize(int argc, VALUE *argv, VALUE io) { VALUE fnum, vmode; rb_io_t *fp; int fd, fmode, oflags = O_RDONLY; convconfig_t convconfig; VALUE opt; #if defined(HAVE_FCNTL) && defined(F_GETFL) int ofmode; #else struct stat st; #endif argc = rb_scan_args(argc, argv, "11:", &fnum, &vmode, &opt); rb_io_extract_modeenc(&vmode, 0, opt, &oflags, &fmode, &convconfig); fd = NUM2INT(fnum); if (rb_reserved_fd_p(fd)) { rb_raise(rb_eArgError, "The given fd is not accessible because RubyVM reserves it"); } #if defined(HAVE_FCNTL) && defined(F_GETFL) oflags = fcntl(fd, F_GETFL); if (oflags == -1) rb_sys_fail(0); #else if (fstat(fd, &st) < 0) rb_sys_fail(0); #endif rb_update_max_fd(fd); #if defined(HAVE_FCNTL) && defined(F_GETFL) ofmode = rb_io_oflags_fmode(oflags); if (NIL_P(vmode)) { fmode = ofmode; } else if ((~ofmode & fmode) & FMODE_READWRITE) { VALUE error = INT2FIX(EINVAL); rb_exc_raise(rb_class_new_instance(1, &error, rb_eSystemCallError)); } #endif if (!NIL_P(opt) && rb_hash_aref(opt, sym_autoclose) == Qfalse) { fmode |= FMODE_PREP; } MakeOpenFile(io, fp); fp->self = io; fp->fd = fd; fp->mode = fmode; fp->encs = convconfig; clear_codeconv(fp); io_check_tty(fp); if (fileno(stdin) == fd) fp->stdio_file = stdin; else if (fileno(stdout) == fd) fp->stdio_file = stdout; else if (fileno(stderr) == fd) fp->stdio_file = stderr; if (fmode & FMODE_SETENC_BY_BOM) io_set_encoding_by_bom(io); return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#initialize_copy;F;[[I"io;T0;[[@i®;T;;g;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @Âë;!F;"o;#;$T;%i;&i;'@bè;(I"Ñstatic VALUE rb_io_init_copy(VALUE dest, VALUE io) { rb_io_t *fptr, *orig; int fd; VALUE write_io; off_t pos; io = rb_io_get_io(io); if (!OBJ_INIT_COPY(dest, io)) return dest; GetOpenFile(io, orig); MakeOpenFile(dest, fptr); rb_io_flush(io); /* copy rb_io_t structure */ fptr->mode = orig->mode & ~FMODE_PREP; fptr->encs = orig->encs; fptr->pid = orig->pid; fptr->lineno = orig->lineno; if (!NIL_P(orig->pathv)) fptr->pathv = orig->pathv; fptr_copy_finalizer(fptr, orig); fd = ruby_dup(orig->fd); fptr->fd = fd; pos = io_tell(orig); if (0 <= pos) io_seek(fptr, pos, SEEK_SET); if (fptr->mode & FMODE_BINMODE) { rb_io_binmode(dest); } write_io = GetWriteIO(io); if (io != write_io) { write_io = rb_obj_dup(write_io); fptr->tied_io_for_writing = write_io; rb_ivar_set(dest, rb_intern("@tied_io_for_writing"), write_io); } return dest; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#reopen;F;[[@c0;[[@iU;T;;:;0;[;{;IC;"±Reassociates ios with the I/O stream given in other_IO or to a new stream opened on path. This may dynamically change the actual class of this stream. The +mode+ and +opt+ parameters accept the same values as IO.open. f1 = File.new("testfile") f2 = File.new("testfile") f2.readlines[0] #=> "This is line one\n" f2.reopen(f1) #=> # f2.readlines[0] #=> "This is line one\n" ;T;[o;= ;3I" overload;F;40;;:;50;)I"reopen(other_IO);T;IC;";T; @Òë;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"IO;T; @Òë;[;I"@return [IO];T;0;6i;[[I" other_IO;T0; @Òëo;= ;3I" overload;F;40;;:;50;)I"reopen(path, mode [, opt]);T;IC;";T; @Òë;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"IO;T; @Òë;[;I"@return [IO];T;0;6i;[[I" path;T0[I"mode[, opt];T0; @Òë;[;I"Reassociates ios with the I/O stream given in other_IO or to a new stream opened on path. This may dynamically change the actual class of this stream. The +mode+ and +opt+ parameters accept the same values as IO.open. f1 = File.new("testfile") f2 = File.new("testfile") f2.readlines[0] #=> "This is line one\n" f2.reopen(f1) #=> # f2.readlines[0] #=> "This is line one\n" @overload reopen(other_IO) @return [IO] @overload reopen(path, mode [, opt]) @return [IO];T;0; @Òë;!F;"o;#;$T;%iD;&iS;'@bè;(I"À static VALUE rb_io_reopen(int argc, VALUE *argv, VALUE file) { VALUE fname, nmode, opt; int oflags; rb_io_t *fptr; if (rb_scan_args(argc, argv, "11:", &fname, &nmode, &opt) == 1) { VALUE tmp = rb_io_check_io(fname); if (!NIL_P(tmp)) { return io_reopen(file, tmp); } } FilePathValue(fname); rb_io_taint_check(file); fptr = RFILE(file)->fptr; if (!fptr) { fptr = RFILE(file)->fptr = ZALLOC(rb_io_t); } if (!NIL_P(nmode) || !NIL_P(opt)) { int fmode; convconfig_t convconfig; rb_io_extract_modeenc(&nmode, 0, opt, &oflags, &fmode, &convconfig); if (IS_PREP_STDIO(fptr) && ((fptr->mode & FMODE_READWRITE) & (fmode & FMODE_READWRITE)) != (fptr->mode & FMODE_READWRITE)) { rb_raise(rb_eArgError, "%s can't change access mode from \"%s\" to \"%s\"", PREP_STDIO_NAME(fptr), rb_io_fmode_modestr(fptr->mode), rb_io_fmode_modestr(fmode)); } fptr->mode = fmode; fptr->encs = convconfig; } else { oflags = rb_io_fmode_oflags(fptr->mode); } fptr->pathv = fname; if (fptr->fd < 0) { fptr->fd = rb_sysopen(fptr->pathv, oflags, 0666); fptr->stdio_file = 0; return file; } if (fptr->mode & FMODE_WRITABLE) { if (io_fflush(fptr) < 0) rb_sys_fail_on_write(fptr); } fptr->rbuf.off = fptr->rbuf.len = 0; if (fptr->stdio_file) { int e = rb_freopen(rb_str_encode_ospath(fptr->pathv), rb_io_oflags_modestr(oflags), fptr->stdio_file); if (e) rb_syserr_fail_path(e, fptr->pathv); fptr->fd = fileno(fptr->stdio_file); rb_fd_fix_cloexec(fptr->fd); #ifdef USE_SETVBUF if (setvbuf(fptr->stdio_file, NULL, _IOFBF, 0) != 0) rb_warn("setvbuf() can't be honoured for %"PRIsVALUE, fptr->pathv); #endif if (fptr->stdio_file == stderr) { if (setvbuf(fptr->stdio_file, NULL, _IONBF, BUFSIZ) != 0) rb_warn("setvbuf() can't be honoured for %"PRIsVALUE, fptr->pathv); } else if (fptr->stdio_file == stdout && isatty(fptr->fd)) { if (setvbuf(fptr->stdio_file, NULL, _IOLBF, BUFSIZ) != 0) rb_warn("setvbuf() can't be honoured for %"PRIsVALUE, fptr->pathv); } } else { int tmpfd = rb_sysopen(fptr->pathv, oflags, 0666); int err = 0; if (rb_cloexec_dup2(tmpfd, fptr->fd) < 0) err = errno; (void)close(tmpfd); if (err) { rb_syserr_fail_path(err, fptr->pathv); } } return file; };T;)I"static VALUE;T;*To;;F; ;;;;I" IO#print;F;[[@c0;[[@i';T;;¡;0;[;{;IC;"&Writes the given object(s) to ios. Returns +nil+. The stream must be opened for writing. Each given object that isn't a string will be converted by calling its to_s method. When called without arguments, prints the contents of $_. If the output field separator ($,) is not +nil+, it is inserted between objects. If the output record separator ($\\) is not +nil+, it is appended to the output. $stdout.print("This is ", 100, " percent.\n") produces: This is 100 percent. ;T;[o;= ;3I" overload;F;40;;¡;50;)I" print;T;IC;";T; @ì;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @ì;[;I"@return [nil];T;0;6i;[; @ìo;= ;3I" overload;F;40;;¡;50;)I"print(obj, ...);T;IC;";T; @ì;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @ì;[;I"@return [nil];T;0;6i;[[I"obj;T0[I"...;T0; @ì;[;I"rWrites the given object(s) to ios. Returns +nil+. The stream must be opened for writing. Each given object that isn't a string will be converted by calling its to_s method. When called without arguments, prints the contents of $_. If the output field separator ($,) is not +nil+, it is inserted between objects. If the output record separator ($\\) is not +nil+, it is appended to the output. $stdout.print("This is ", 100, " percent.\n") produces: This is 100 percent. @overload print @return [nil] @overload print(obj, ...) @return [nil];T;0; @ì;!F;"o;#;$T;%i;&i%;'@bè;(I"KVALUE rb_io_print(int argc, const VALUE *argv, VALUE out) { int i; VALUE line; /* if no argument given, print `$_' */ if (argc == 0) { argc = 1; line = rb_lastline_get(); argv = &line; } if (argc > 1 && !NIL_P(rb_output_fs)) { rb_category_warn(RB_WARN_CATEGORY_DEPRECATED, "$, is set to non-nil value"); } for (i=0; i0) { rb_io_write(out, rb_output_fs); } rb_io_write(out, argv[i]); } if (argc > 0 && !NIL_P(rb_output_rs)) { rb_io_write(out, rb_output_rs); } return Qnil; };T;)I" VALUE;T;*To;;F; ;;;;I"IO#putc;F;[[I"ch;T0;[[@ir;T;;¢;0;[;{;IC;"If obj is Numeric, write the character whose code is the least-significant byte of obj. If obj is String, write the first character of obj to ios. Otherwise, raise TypeError. $stdout.putc "A" $stdout.putc 65 produces: AA ;T;[o;= ;3I" overload;F;40;;¢;50;)I"putc(obj);T;IC;";T; @.ì;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @.ì;[;I"@return [Object];T;0;6i;[[I"obj;T0; @.ì;[;I"AIf obj is Numeric, write the character whose code is the least-significant byte of obj. If obj is String, write the first character of obj to ios. Otherwise, raise TypeError. $stdout.putc "A" $stdout.putc 65 produces: AA @overload putc(obj) @return [Object];T;0; @.ì;!F;"o;#;$T;%ia;&io;'@bè;(I"òstatic VALUE rb_io_putc(VALUE io, VALUE ch) { VALUE str; if (RB_TYPE_P(ch, T_STRING)) { str = rb_str_substr(ch, 0, 1); } else { char c = NUM2CHR(ch); str = rb_str_new(&c, 1); } rb_io_write(io, str); return ch; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#puts;F;[[@c0;[[@iÖ;T;;£;0;[;{;IC;"UWrites the given object(s) to ios. Writes a newline after any that do not already end with a newline sequence. Returns +nil+. The stream must be opened for writing. If called with an array argument, writes each element on a new line. Each given object that isn't a string or array will be converted by calling its +to_s+ method. If called without arguments, outputs a single newline. $stdout.puts("this", "is", ["a", "test"]) produces: this is a test Note that +puts+ always uses newlines and is not affected by the output record separator ($\\). ;T;[o;= ;3I" overload;F;40;;£;50;)I"puts(obj, ...);T;IC;";T; @Mì;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @Mì;[;I"@return [nil];T;0;6i;[[I"obj;T0[I"...;T0; @Mì;[;I"€Writes the given object(s) to ios. Writes a newline after any that do not already end with a newline sequence. Returns +nil+. The stream must be opened for writing. If called with an array argument, writes each element on a new line. Each given object that isn't a string or array will be converted by calling its +to_s+ method. If called without arguments, outputs a single newline. $stdout.puts("this", "is", ["a", "test"]) produces: this is a test Note that +puts+ always uses newlines and is not affected by the output record separator ($\\). @overload puts(obj, ...) @return [nil];T;0; @Mì;!F;"o;#;$T;%i»;&iÓ;'@bè;(I"ŠVALUE rb_io_puts(int argc, const VALUE *argv, VALUE out) { int i, n; VALUE line, args[2]; /* if no argument given, print newline. */ if (argc == 0) { rb_io_write(out, rb_default_rs); return Qnil; } for (i=0; iios, converting parameters under control of the format string. See Kernel#sprintf for details. ;T;[o;= ;3I" overload;F;40;; ;50;)I"'printf(format_string [, obj, ...]);T;IC;";T; @mì;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @mì;[;I"@return [nil];T;0;6i;[[I"format_string[, obj, ...];T0; @mì;[;I"¼Formats and writes to ios, converting parameters under control of the format string. See Kernel#sprintf for details. @overload printf(format_string [, obj, ...]) @return [nil];T;0; @mì;!F;"o;#;$T;%iØ;&iÝ;'@bè;(I"VALUE rb_io_printf(int argc, const VALUE *argv, VALUE out) { rb_io_write(out, rb_f_sprintf(argc, argv)); return Qnil; };T;)I" VALUE;T;*To;;F; ;;;;I"IO#each;F;[[@c0;[[@is;T;;;0;[;{;IC;"Ôios.each_line(sep=$/ [, getline_args]) {|line| block } -> ios ios.each_line(limit [, getline_args]) {|line| block } -> ios ios.each_line(sep, limit [, getline_args]) {|line| block } -> ios ios.each_line(...) -> an_enumerator Executes the block for every line in ios, where lines are separated by sep. ios must be opened for reading or an IOError will be raised. If no block is given, an enumerator is returned instead. f = File.new("testfile") f.each {|line| puts "#{f.lineno}: #{line}" } produces: 1: This is line one 2: This is line two 3: This is line three 4: And so on... See IO.readlines for details about getline_args. ;T;[ o;= ;3I" overload;F;40;;;50;)I""each(sep=$/ [, getline_args]);T;IC;";T; @‹ì;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" line;T; @‹ìo;2 ;3I"return;F;4I";T;0;5[I"IO;T; @‹ì;[;I"@yield [line] @return [IO];T;0;6i;[[I"sep;TI"$/[, getline_args];T; @‹ìo;= ;3I" overload;F;40;;;50;)I"!each(limit [, getline_args]);T;IC;";T; @‹ì;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" line;T; @‹ìo;2 ;3I"return;F;4I";T;0;5[I"IO;T; @‹ì;[;I"@yield [line] @return [IO];T;0;6i;[[I"limit[, getline_args];T0; @‹ìo;= ;3I" overload;F;40;;;50;)I"&each(sep, limit [, getline_args]);T;IC;";T; @‹ì;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" line;T; @‹ìo;2 ;3I"return;F;4I";T;0;5[I"IO;T; @‹ì;[;I"@yield [line] @return [IO];T;0;6i;[[I"sep;T0[I"limit[, getline_args];T0; @‹ìo;= ;3I" overload;F;40;;;50;)I"each(...);T;IC;";T; @‹ì;>0;!F;[;[;I";T;0;6i;[[I"...;T0; @‹ì;[;I"Å ios.each_line(sep=$/ [, getline_args]) {|line| block } -> ios ios.each_line(limit [, getline_args]) {|line| block } -> ios ios.each_line(sep, limit [, getline_args]) {|line| block } -> ios ios.each_line(...) -> an_enumerator Executes the block for every line in ios, where lines are separated by sep. ios must be opened for reading or an IOError will be raised. If no block is given, an enumerator is returned instead. f = File.new("testfile") f.each {|line| puts "#{f.lineno}: #{line}" } produces: 1: This is line one 2: This is line two 3: This is line three 4: And so on... See IO.readlines for details about getline_args. @overload each(sep=$/ [, getline_args]) @yield [line] @return [IO] @overload each(limit [, getline_args]) @yield [line] @return [IO] @overload each(sep, limit [, getline_args]) @yield [line] @return [IO] @overload each(...);T;0; @‹ì;!F;"o;#;$T;%iT;&iu;'@bè;(I"static VALUE rb_io_each_line(int argc, VALUE *argv, VALUE io) { VALUE str; struct getline_arg args; RETURN_ENUMERATOR(io, argc, argv); prepare_getline_args(argc, argv, &args, io); if (args.limit == 0) rb_raise(rb_eArgError, "invalid limit: 0 for each_line"); while (!NIL_P(str = rb_io_getline_1(args.rs, args.limit, args.chomp, io))) { rb_yield(str); } return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#each_line;F;[[@c0;[[@is;T;;;0;[;{;IC;"Ôios.each_line(sep=$/ [, getline_args]) {|line| block } -> ios ios.each_line(limit [, getline_args]) {|line| block } -> ios ios.each_line(sep, limit [, getline_args]) {|line| block } -> ios ios.each_line(...) -> an_enumerator Executes the block for every line in ios, where lines are separated by sep. ios must be opened for reading or an IOError will be raised. If no block is given, an enumerator is returned instead. f = File.new("testfile") f.each {|line| puts "#{f.lineno}: #{line}" } produces: 1: This is line one 2: This is line two 3: This is line three 4: And so on... See IO.readlines for details about getline_args. ;T;[ o;= ;3I" overload;F;40;;;50;)I""each(sep=$/ [, getline_args]);T;IC;";T; @ãì;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" line;T; @ãìo;2 ;3I"return;F;4I";T;0;5[I"IO;T; @ãì;[;I"@yield [line] @return [IO];T;0;6i;[[I"sep;TI"$/[, getline_args];T; @ãìo;= ;3I" overload;F;40;;;50;)I"!each(limit [, getline_args]);T;IC;";T; @ãì;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" line;T; @ãìo;2 ;3I"return;F;4I";T;0;5[I"IO;T; @ãì;[;I"@yield [line] @return [IO];T;0;6i;[[I"limit[, getline_args];T0; @ãìo;= ;3I" overload;F;40;;;50;)I"&each(sep, limit [, getline_args]);T;IC;";T; @ãì;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" line;T; @ãìo;2 ;3I"return;F;4I";T;0;5[I"IO;T; @ãì;[;I"@yield [line] @return [IO];T;0;6i;[[I"sep;T0[I"limit[, getline_args];T0; @ãìo;= ;3I" overload;F;40;;;50;)I"each(...);T;IC;";T; @ãì;>0;!F;[;[;I";T;0;6i;[[I"...;T0; @ãì;[;@ßì;0; @ãì;!F;"o;#;$T;%iT;&iu;'@bè;(I"static VALUE rb_io_each_line(int argc, VALUE *argv, VALUE io) { VALUE str; struct getline_arg args; RETURN_ENUMERATOR(io, argc, argv); prepare_getline_args(argc, argv, &args, io); if (args.limit == 0) rb_raise(rb_eArgError, "invalid limit: 0 for each_line"); while (!NIL_P(str = rb_io_getline_1(args.rs, args.limit, args.chomp, io))) { rb_yield(str); } return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#each_byte;F;[;[[@i”;T;;;0;[;{;IC;"vCalls the given block once for each byte (0..255) in ios, passing the byte as an argument. The stream must be opened for reading or an IOError will be raised. If no block is given, an enumerator is returned instead. f = File.new("testfile") checksum = 0 f.each_byte {|x| checksum ^= x } #=> # checksum #=> 12 ;T;[o;= ;3I" overload;F;40;;;50;)I"each_byte;T;IC;";T; @:í;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" byte;T; @:ío;2 ;3I"return;F;4I";T;0;5[I"IO;T; @:í;[;I"@yield [byte] @return [IO];T;0;6i;[; @:ío;= ;3I" overload;F;40;;;50;)I"each_byte;T;IC;";T; @:í;>0;!F;[;[;I";T;0;6i;[; @:í;[;I"¿Calls the given block once for each byte (0..255) in ios, passing the byte as an argument. The stream must be opened for reading or an IOError will be raised. If no block is given, an enumerator is returned instead. f = File.new("testfile") checksum = 0 f.each_byte {|x| checksum ^= x } #=> # checksum #=> 12 @overload each_byte @yield [byte] @return [IO] @overload each_byte;T;0; @:í;!F;"o;#;$T;%iƒ;&i’;'@bè;(I"Žstatic VALUE rb_io_each_byte(VALUE io) { rb_io_t *fptr; RETURN_ENUMERATOR(io, 0, 0); GetOpenFile(io, fptr); do { while (fptr->rbuf.len > 0) { char *p = fptr->rbuf.ptr + fptr->rbuf.off++; fptr->rbuf.len--; rb_yield(INT2FIX(*p & 0xff)); rb_io_check_byte_readable(fptr); errno = 0; } READ_CHECK(fptr); } while (io_fillbuf(fptr) >= 0); return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#each_char;F;[;[[@i#;T;;;0;[;{;IC;"9Calls the given block once for each character in ios, passing the character as an argument. The stream must be opened for reading or an IOError will be raised. If no block is given, an enumerator is returned instead. f = File.new("testfile") f.each_char {|c| print c, ' ' } #=> # ;T;[o;= ;3I" overload;F;40;;;50;)I"each_char;T;IC;";T; @bí;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"c;T; @bío;2 ;3I"return;F;4I";T;0;5[I"IO;T; @bí;[;I"@yield [c] @return [IO];T;0;6i;[; @bío;= ;3I" overload;F;40;;;50;)I"each_char;T;IC;";T; @bí;>0;!F;[;[;I";T;0;6i;[; @bí;[;I"Calls the given block once for each character in ios, passing the character as an argument. The stream must be opened for reading or an IOError will be raised. If no block is given, an enumerator is returned instead. f = File.new("testfile") f.each_char {|c| print c, ' ' } #=> # @overload each_char @yield [c] @return [IO] @overload each_char;T;0; @bí;!F;"o;#;$T;%i;&i!;'@bè;(I"Sstatic VALUE rb_io_each_char(VALUE io) { rb_io_t *fptr; rb_encoding *enc; VALUE c; RETURN_ENUMERATOR(io, 0, 0); GetOpenFile(io, fptr); rb_io_check_char_readable(fptr); enc = io_input_encoding(fptr); READ_CHECK(fptr); while (!NIL_P(c = io_getc(fptr, enc))) { rb_yield(c); } return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#each_codepoint;F;[;[[@iE;T;;°;0;[;{;IC;"ßPasses the Integer ordinal of each character in ios, passing the codepoint as an argument. The stream must be opened for reading or an IOError will be raised. If no block is given, an enumerator is returned instead. ;T;[ o;= ;3I" overload;F;40;;°;50;)I"each_codepoint;T;IC;";T; @Ší;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"c;T; @Šío;2 ;3I"return;F;4I";T;0;5[I"IO;T; @Ší;[;I"@yield [c] @return [IO];T;0;6i;[; @Šío;= ;3I" overload;F;40;;‹;50;)I"codepoints;T;IC;";T; @Ší;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"c;T; @Šío;2 ;3I"return;F;4I";T;0;5[I"IO;T; @Ší;[;I"@yield [c] @return [IO];T;0;6i;[; @Šío;= ;3I" overload;F;40;;°;50;)I"each_codepoint;T;IC;";T; @Ší;>0;!F;[;[;I";T;0;6i;[; @Šío;= ;3I" overload;F;40;;‹;50;)I"codepoints;T;IC;";T; @Ší;>0;!F;[;[;I";T;0;6i;[; @Ší;[;I"vPasses the Integer ordinal of each character in ios, passing the codepoint as an argument. The stream must be opened for reading or an IOError will be raised. If no block is given, an enumerator is returned instead. @overload each_codepoint @yield [c] @return [IO] @overload codepoints @yield [c] @return [IO] @overload each_codepoint @overload codepoints;T;0; @Ší;!F;"o;#;$T;%i6;&iE;'@bè;(I"$static VALUE rb_io_each_codepoint(VALUE io) { rb_io_t *fptr; rb_encoding *enc; unsigned int c; int r, n; RETURN_ENUMERATOR(io, 0, 0); GetOpenFile(io, fptr); rb_io_check_char_readable(fptr); READ_CHECK(fptr); if (NEED_READCONV(fptr)) { SET_BINARY_MODE(fptr); r = 1; /* no invalid char yet */ for (;;) { make_readconv(fptr, 0); for (;;) { if (fptr->cbuf.len) { if (fptr->encs.enc) r = rb_enc_precise_mbclen(fptr->cbuf.ptr+fptr->cbuf.off, fptr->cbuf.ptr+fptr->cbuf.off+fptr->cbuf.len, fptr->encs.enc); else r = ONIGENC_CONSTRUCT_MBCLEN_CHARFOUND(1); if (!MBCLEN_NEEDMORE_P(r)) break; if (fptr->cbuf.len == fptr->cbuf.capa) { rb_raise(rb_eIOError, "too long character"); } } if (more_char(fptr) == MORE_CHAR_FINISHED) { clear_readconv(fptr); if (!MBCLEN_CHARFOUND_P(r)) { enc = fptr->encs.enc; goto invalid; } return io; } } if (MBCLEN_INVALID_P(r)) { enc = fptr->encs.enc; goto invalid; } n = MBCLEN_CHARFOUND_LEN(r); if (fptr->encs.enc) { c = rb_enc_codepoint(fptr->cbuf.ptr+fptr->cbuf.off, fptr->cbuf.ptr+fptr->cbuf.off+fptr->cbuf.len, fptr->encs.enc); } else { c = (unsigned char)fptr->cbuf.ptr[fptr->cbuf.off]; } fptr->cbuf.off += n; fptr->cbuf.len -= n; rb_yield(UINT2NUM(c)); rb_io_check_byte_readable(fptr); } } NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr); enc = io_input_encoding(fptr); while (io_fillbuf(fptr) >= 0) { r = rb_enc_precise_mbclen(fptr->rbuf.ptr+fptr->rbuf.off, fptr->rbuf.ptr+fptr->rbuf.off+fptr->rbuf.len, enc); if (MBCLEN_CHARFOUND_P(r) && (n = MBCLEN_CHARFOUND_LEN(r)) <= fptr->rbuf.len) { c = rb_enc_codepoint(fptr->rbuf.ptr+fptr->rbuf.off, fptr->rbuf.ptr+fptr->rbuf.off+fptr->rbuf.len, enc); fptr->rbuf.off += n; fptr->rbuf.len -= n; rb_yield(UINT2NUM(c)); } else if (MBCLEN_INVALID_P(r)) { goto invalid; } else if (MBCLEN_NEEDMORE_P(r)) { char cbuf[8], *p = cbuf; int more = MBCLEN_NEEDMORE_LEN(r); if (more > numberof(cbuf)) goto invalid; more += n = fptr->rbuf.len; if (more > numberof(cbuf)) goto invalid; while ((n = (int)read_buffered_data(p, more, fptr)) > 0 && (p += n, (more -= n) > 0)) { if (io_fillbuf(fptr) < 0) goto invalid; if ((n = fptr->rbuf.len) > more) n = more; } r = rb_enc_precise_mbclen(cbuf, p, enc); if (!MBCLEN_CHARFOUND_P(r)) goto invalid; c = rb_enc_codepoint(cbuf, p, enc); rb_yield(UINT2NUM(c)); } else { continue; } rb_io_check_byte_readable(fptr); } return io; invalid: rb_raise(rb_eArgError, "invalid byte sequence in %s", rb_enc_name(enc)); UNREACHABLE_RETURN(Qundef); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#syswrite;F;[[I"str;T0;[[@iT;T;: syswrite;0;[;{;IC;""Writes the given string to ios using a low-level write. Returns the number of bytes written. Do not mix with other methods that write to ios or you may get unpredictable results. Raises SystemCallError on error. f = File.new("out", "w") f.syswrite("ABCDEF") #=> 6 ;T;[o;= ;3I" overload;F;40;;ƒ;50;)I"syswrite(string);T;IC;";T; @Ìí;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ìí;[;I"@return [Integer];T;0;6i;[[I"string;T0; @Ìí;[;I"SWrites the given string to ios using a low-level write. Returns the number of bytes written. Do not mix with other methods that write to ios or you may get unpredictable results. Raises SystemCallError on error. f = File.new("out", "w") f.syswrite("ABCDEF") #=> 6 @overload syswrite(string) @return [Integer];T;0; @Ìí;!F;"o;#;$T;%iG;&iQ;'@bè;(I"Gstatic VALUE rb_io_syswrite(VALUE io, VALUE str) { VALUE tmp; rb_io_t *fptr; long n, len; const char *ptr; if (!RB_TYPE_P(str, T_STRING)) str = rb_obj_as_string(str); io = GetWriteIO(io); GetOpenFile(io, fptr); rb_io_check_writable(fptr); if (fptr->wbuf.len) { rb_warn("syswrite for buffered IO"); } tmp = rb_str_tmp_frozen_acquire(str); RSTRING_GETMEM(tmp, ptr, len); n = rb_write_internal(fptr->fd, ptr, len); if (n < 0) rb_sys_fail_path(fptr->pathv); rb_str_tmp_frozen_release(str, tmp); return LONG2FIX(n); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#sysread;F;[[@c0;[[@iƒ;T;:sysread;0;[;{;IC;"Reads maxlen bytes from ios using a low-level read and returns them as a string. Do not mix with other methods that read from ios or you may get unpredictable results. If the optional _outbuf_ argument is present, it must reference a String, which will receive the data. The _outbuf_ will contain only the received data after the method call even if it is not empty at the beginning. Raises SystemCallError on error and EOFError at end of file. f = File.new("testfile") f.sysread(16) #=> "This is line one" ;T;[o;= ;3I" overload;F;40;;„;50;)I"sysread(maxlen[, outbuf]);T;IC;";T; @ëí;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ëí;[;I"@return [String];T;0;6i;[[I"maxlen[, outbuf];T0; @ëí;[;I"XReads maxlen bytes from ios using a low-level read and returns them as a string. Do not mix with other methods that read from ios or you may get unpredictable results. If the optional _outbuf_ argument is present, it must reference a String, which will receive the data. The _outbuf_ will contain only the received data after the method call even if it is not empty at the beginning. Raises SystemCallError on error and EOFError at end of file. f = File.new("testfile") f.sysread(16) #=> "This is line one" @overload sysread(maxlen[, outbuf]) @return [String];T;0; @ëí;!F;"o;#;$T;%ip;&i€;'@bè;(I"èstatic VALUE rb_io_sysread(int argc, VALUE *argv, VALUE io) { VALUE len, str; rb_io_t *fptr; long n, ilen; struct io_internal_read_struct iis; int shrinkable; rb_scan_args(argc, argv, "11", &len, &str); ilen = NUM2LONG(len); shrinkable = io_setstrbuf(&str, ilen); if (ilen == 0) return str; GetOpenFile(io, fptr); rb_io_check_byte_readable(fptr); if (READ_DATA_BUFFERED(fptr)) { rb_raise(rb_eIOError, "sysread for buffered IO"); } /* * FIXME: removing rb_thread_wait_fd() here changes sysread semantics * on non-blocking IOs. However, it's still currently possible * for sysread to raise Errno::EAGAIN if another thread read()s * the IO after we return from rb_thread_wait_fd() but before * we call read() */ rb_thread_wait_fd(fptr->fd); rb_io_check_closed(fptr); io_setstrbuf(&str, ilen); iis.fd = fptr->fd; iis.nonblock = 1; /* for historical reasons, maybe (see above) */ iis.buf = RSTRING_PTR(str); iis.capa = ilen; n = read_internal_locktmp(str, &iis); if (n < 0) { rb_sys_fail_path(fptr->pathv); } io_set_read_length(str, n, shrinkable); if (n == 0 && ilen > 0) { rb_eof_error(); } return str; };T;)I"static VALUE;T;*To;;F; ;;;;I" IO#pread;F;[[@c0;[[@iä;T;: pread;0;[;{;IC;"Reads maxlen bytes from ios using the pread system call and returns them as a string without modifying the underlying descriptor offset. This is advantageous compared to combining IO#seek and IO#read in that it is atomic, allowing multiple threads/process to share the same IO object for reading the file at various locations. This bypasses any userspace buffering of the IO layer. If the optional outbuf argument is present, it must reference a String, which will receive the data. Raises SystemCallError on error, EOFError at end of file and NotImplementedError if platform does not implement the system call. File.write("testfile", "This is line one\nThis is line two\n") File.open("testfile") do |f| p f.read # => "This is line one\nThis is line two\n" p f.pread(12, 0) # => "This is line" p f.pread(9, 8) # => "line one\n" end ;T;[o;= ;3I" overload;F;40;;…;50;)I"$pread(maxlen, offset[, outbuf]);T;IC;";T; @ î;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ î;[;I"@return [String];T;0;6i;[[I"maxlen;T0[I"offset[, outbuf];T0; @ î;[;I"¾Reads maxlen bytes from ios using the pread system call and returns them as a string without modifying the underlying descriptor offset. This is advantageous compared to combining IO#seek and IO#read in that it is atomic, allowing multiple threads/process to share the same IO object for reading the file at various locations. This bypasses any userspace buffering of the IO layer. If the optional outbuf argument is present, it must reference a String, which will receive the data. Raises SystemCallError on error, EOFError at end of file and NotImplementedError if platform does not implement the system call. File.write("testfile", "This is line one\nThis is line two\n") File.open("testfile") do |f| p f.read # => "This is line one\nThis is line two\n" p f.pread(12, 0) # => "This is line" p f.pread(9, 8) # => "line one\n" end @overload pread(maxlen, offset[, outbuf]) @return [String];T;0; @ î;!F;"o;#;$T;%iÎ;&iâ;'@bè;(I"?static VALUE rb_io_pread(int argc, VALUE *argv, VALUE io) { VALUE len, offset, str; rb_io_t *fptr; ssize_t n; struct prdwr_internal_arg arg; int shrinkable; rb_scan_args(argc, argv, "21", &len, &offset, &str); arg.count = NUM2SIZET(len); arg.offset = NUM2OFFT(offset); shrinkable = io_setstrbuf(&str, (long)arg.count); if (arg.count == 0) return str; arg.buf = RSTRING_PTR(str); GetOpenFile(io, fptr); rb_io_check_byte_readable(fptr); arg.fd = fptr->fd; rb_io_check_closed(fptr); rb_str_locktmp(str); n = (ssize_t)rb_ensure(pread_internal_call, (VALUE)&arg, rb_str_unlocktmp, str); if (n < 0) { rb_sys_fail_path(fptr->pathv); } io_set_read_length(str, n, shrinkable); if (n == 0 && arg.count > 0) { rb_eof_error(); } return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#pwrite;F;[[I"str;T0[I"offset;T0;[[@i(;T;:pwrite;0;[;{;IC;"WWrites the given string to ios at offset using pwrite() system call. This is advantageous to combining IO#seek and IO#write in that it is atomic, allowing multiple threads/process to share the same IO object for reading the file at various locations. This bypasses any userspace buffering of the IO layer. Returns the number of bytes written. Raises SystemCallError on error and NotImplementedError if platform does not implement the system call. File.open("out", "w") do |f| f.pwrite("ABCDEF", 3) #=> 6 end File.read("out") #=> "\u0000\u0000\u0000ABCDEF" ;T;[o;= ;3I" overload;F;40;;†;50;)I"pwrite(string, offset);T;IC;";T; @)î;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @)î;[;I"@return [Integer];T;0;6i;[[I"string;T0[I"offset;T0; @)î;[;I"ŽWrites the given string to ios at offset using pwrite() system call. This is advantageous to combining IO#seek and IO#write in that it is atomic, allowing multiple threads/process to share the same IO object for reading the file at various locations. This bypasses any userspace buffering of the IO layer. Returns the number of bytes written. Raises SystemCallError on error and NotImplementedError if platform does not implement the system call. File.open("out", "w") do |f| f.pwrite("ABCDEF", 3) #=> 6 end File.read("out") #=> "\u0000\u0000\u0000ABCDEF" @overload pwrite(string, offset) @return [Integer];T;0; @)î;!F;"o;#;$T;%i;&i&;'@bè;(I"£static VALUE rb_io_pwrite(VALUE io, VALUE str, VALUE offset) { rb_io_t *fptr; ssize_t n; struct prdwr_internal_arg arg; VALUE tmp; if (!RB_TYPE_P(str, T_STRING)) str = rb_obj_as_string(str); arg.offset = NUM2OFFT(offset); io = GetWriteIO(io); GetOpenFile(io, fptr); rb_io_check_writable(fptr); arg.fd = fptr->fd; tmp = rb_str_tmp_frozen_acquire(str); arg.buf = RSTRING_PTR(tmp); arg.count = (size_t)RSTRING_LEN(tmp); n = (ssize_t)rb_thread_io_blocking_region(internal_pwrite_func, &arg, fptr->fd); if (n < 0) rb_sys_fail_path(fptr->pathv); rb_str_tmp_frozen_release(str, tmp); return SSIZET2NUM(n); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#fileno;F;[;[[@i¤ ;T;:fileno;0;[;{;IC;"‚Returns an integer representing the numeric file descriptor for ios. $stdin.fileno #=> 0 $stdout.fileno #=> 1 ;T;[o;= ;3I" overload;F;40;;‡;50;)I"fileno;T;IC;";T; @Lî;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Lî;[;I"@return [Integer];T;0;6i;[; @Lîo;= ;3I" overload;F;40;;–;50;)I" to_i;T;IC;";T; @Lî;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Lî;[;I"@return [Integer];T;0;6i;[; @Lî;[;I"ÌReturns an integer representing the numeric file descriptor for ios. $stdin.fileno #=> 0 $stdout.fileno #=> 1 @overload fileno @return [Integer] @overload to_i @return [Integer];T;0; o;;F; ;;;;I"IO#to_i;F;[;[[@i¥4;F;;–;;K;[;{;@Sî;'@bè;)I"static VALUE;T;(I"¢static VALUE rb_io_fileno(VALUE io) { rb_io_t *fptr = RFILE(io)->fptr; int fd; rb_io_check_closed(fptr); fd = fptr->fd; return INT2FIX(fd); };T;!F;"o;#;$T;%i˜ ;&i¢ ;'@bè;(I"¢static VALUE rb_io_fileno(VALUE io) { rb_io_t *fptr = RFILE(io)->fptr; int fd; rb_io_check_closed(fptr); fd = fptr->fd; return INT2FIX(fd); };T;)@xî;*T@qîo;;F; ;;;;I" IO#to_io;F;[;[[@iû ;T;;ú;0;[;{;IC;"Returns ios. ;T;[o;= ;3I" overload;F;40;;ú;50;)I" to_io;T;IC;";T; @|î;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"IO;T; @|î;[;I"@return [IO];T;0;6i;[; @|î;[;I";Returns ios. @overload to_io @return [IO];T;0; @|î;!F;"o;#;$T;%iô ;&iø ;'@bè;(I":static VALUE rb_io_to_io(VALUE io) { return io; };T;)I"static VALUE;T;*To;;F; ;;;;I" IO#fsync;F;[;[[@iR ;T;: fsync;0;[;{;IC;"fImmediately writes all buffered data in ios to disk. Note that #fsync differs from using IO#sync=. The latter ensures that data is flushed from Ruby's buffers, but does not guarantee that the underlying operating system actually writes it to disk. NotImplementedError is raised if the underlying operating system does not support fsync(2). ;T;[o;= ;3I" overload;F;40;;ˆ;50;)I" fsync;T;IC;";T; @—î;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI"nil;T; @—î;[;I"@return [0, nil];T;0;6i;[; @—î;[;I"‹Immediately writes all buffered data in ios to disk. Note that #fsync differs from using IO#sync=. The latter ensures that data is flushed from Ruby's buffers, but does not guarantee that the underlying operating system actually writes it to disk. NotImplementedError is raised if the underlying operating system does not support fsync(2). @overload fsync @return [0, nil];T;0; @—î;!F;"o;#;$T;%iE ;&iO ;'@bè;(I"3static VALUE rb_io_fsync(VALUE io) { rb_io_t *fptr; io = GetWriteIO(io); GetOpenFile(io, fptr); if (io_fflush(fptr) < 0) rb_sys_fail_on_write(fptr); if ((int)rb_thread_io_blocking_region(nogvl_fsync, fptr, fptr->fd) < 0) rb_sys_fail_path(fptr->pathv); return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#fdatasync;F;[;[[@iƒ ;T;:fdatasync;0;[;{;IC;"ÏImmediately writes all buffered data in ios to disk. If the underlying operating system does not support fdatasync(2), IO#fsync is called instead (which might raise a NotImplementedError). ;T;[o;= ;3I" overload;F;40;;‰;50;)I"fdatasync;T;IC;";T; @³î;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI"nil;T; @³î;[;I"@return [0, nil];T;0;6i;[; @³î;[;I"øImmediately writes all buffered data in ios to disk. If the underlying operating system does not support fdatasync(2), IO#fsync is called instead (which might raise a NotImplementedError). @overload fdatasync @return [0, nil];T;0; @³î;!F;"o;#;$T;%ix ;&i€ ;'@bè;(I"Kstatic VALUE rb_io_fdatasync(VALUE io) { rb_io_t *fptr; io = GetWriteIO(io); GetOpenFile(io, fptr); if (io_fflush(fptr) < 0) rb_sys_fail_on_write(fptr); if ((int)rb_thread_io_blocking_region(nogvl_fdatasync, fptr, fptr->fd) == 0) return INT2FIX(0); /* fall back */ return rb_io_fsync(io); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#sync;F;[;[[@i ;T;;ä;0;[;{;IC;"ýReturns the current ``sync mode'' of ios. When sync mode is true, all output is immediately flushed to the underlying operating system and is not buffered by Ruby internally. See also IO#fsync. f = File.new("testfile") f.sync #=> false ;T;[o;= ;3I" overload;F;40;;ä;50;)I" sync;T;IC;";T; @Ïî;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Ïî;[;I"@return [Boolean];T;0;6i;[; @Ïî;[;I""Returns the current ``sync mode'' of ios. When sync mode is true, all output is immediately flushed to the underlying operating system and is not buffered by Ruby internally. See also IO#fsync. f = File.new("testfile") f.sync #=> false @overload sync @return [Boolean];T;0; @Ïî;!F;"o;#;$T;%i ;&i ;'@bè;(I"¤static VALUE rb_io_sync(VALUE io) { rb_io_t *fptr; io = GetWriteIO(io); GetOpenFile(io, fptr); return (fptr->mode & FMODE_SYNC) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I" IO#sync=;F;[[I" sync;T0;[[@ic ;T;;;0;[;{;IC;";T;[;[;@|;0; @êî;'@bè;(I"bstatic VALUE rb_io_set_sync(VALUE io, VALUE sync) { rb_notimplement(); UNREACHABLE; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#lineno;F;[;[[@ié;T;;;0;[;{;IC;">Returns the current line number in ios. The stream must be opened for reading. #lineno counts the number of times #gets is called rather than the number of newlines encountered. The two values will differ if #gets is called with a separator other than newline. Methods that use $/ like #each, #lines and #readline will also increment #lineno. See also the $. variable. f = File.new("testfile") f.lineno #=> 0 f.gets #=> "This is line one\n" f.lineno #=> 1 f.gets #=> "This is line two\n" f.lineno #=> 2 ;T;[o;= ;3I" overload;F;40;;;50;)I"lineno;T;IC;";T; @øî;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @øî;[;I"@return [Integer];T;0;6i;[; @øî;[;I"eReturns the current line number in ios. The stream must be opened for reading. #lineno counts the number of times #gets is called rather than the number of newlines encountered. The two values will differ if #gets is called with a separator other than newline. Methods that use $/ like #each, #lines and #readline will also increment #lineno. See also the $. variable. f = File.new("testfile") f.lineno #=> 0 f.gets #=> "This is line one\n" f.lineno #=> 1 f.gets #=> "This is line two\n" f.lineno #=> 2 @overload lineno @return [Integer];T;0; @øî;!F;"o;#;$T;%iÓ;&iæ;'@bè;(I"static VALUE rb_io_lineno(VALUE io) { rb_io_t *fptr; GetOpenFile(io, fptr); rb_io_check_char_readable(fptr); return INT2NUM(fptr->lineno); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#lineno=;F;[[I"lineno;T0;[[@i;T;;;0;[;{;IC;"ØManually sets the current line number to the given value. $. is updated only on the next read. f = File.new("testfile") f.gets #=> "This is line one\n" $. #=> 1 f.lineno = 1000 f.lineno #=> 1000 $. #=> 1 # lineno of last read f.gets #=> "This is line two\n" $. #=> 1001 # lineno of last read ;T;[o;= ;3I" overload;F;40;;;50;)I"lineno=(integer);T;IC;";T; @ï;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ï;[;I"@return [Integer];T;0;6i;[[I"integer;T0; @ï;[;I" Manually sets the current line number to the given value. $. is updated only on the next read. f = File.new("testfile") f.gets #=> "This is line one\n" $. #=> 1 f.lineno = 1000 f.lineno #=> 1000 $. #=> 1 # lineno of last read f.gets #=> "This is line two\n" $. #=> 1001 # lineno of last read @overload lineno=(integer) @return [Integer];T;0; @ï;!F;"o;#;$T;%ió;&i;'@bè;(I"Ästatic VALUE rb_io_set_lineno(VALUE io, VALUE lineno) { rb_io_t *fptr; GetOpenFile(io, fptr); rb_io_check_char_readable(fptr); fptr->lineno = NUM2INT(lineno); return lineno; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#readlines;F;[[@c0;[[@i=;T;;§;0;[;{;IC;"oReads all of the lines in ios, and returns them in an array. Lines are separated by the optional sep. If sep is +nil+, the rest of the stream is returned as a single record. If the first argument is an integer, or an optional second argument is given, the returning string would not be longer than the given value in bytes. The stream must be opened for reading or an IOError will be raised. f = File.new("testfile") f.readlines[0] #=> "This is line one\n" f = File.new("testfile", chomp: true) f.readlines[0] #=> "This is line one" See IO.readlines for details about getline_args. ;T;[o;= ;3I" overload;F;40;;§;50;)I"'readlines(sep=$/ [, getline_args]);T;IC;";T; @2ï;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @2ï;[;I"@return [Array];T;0;6i;[[I"sep;TI"$/[, getline_args];T; @2ïo;= ;3I" overload;F;40;;§;50;)I"&readlines(limit [, getline_args]);T;IC;";T; @2ï;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @2ï;[;I"@return [Array];T;0;6i;[[I"limit[, getline_args];T0; @2ïo;= ;3I" overload;F;40;;§;50;)I"+readlines(sep, limit [, getline_args]);T;IC;";T; @2ï;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @2ï;[;I"@return [Array];T;0;6i;[[I"sep;T0[I"limit[, getline_args];T0; @2ï;[;I"1Reads all of the lines in ios, and returns them in an array. Lines are separated by the optional sep. If sep is +nil+, the rest of the stream is returned as a single record. If the first argument is an integer, or an optional second argument is given, the returning string would not be longer than the given value in bytes. The stream must be opened for reading or an IOError will be raised. f = File.new("testfile") f.readlines[0] #=> "This is line one\n" f = File.new("testfile", chomp: true) f.readlines[0] #=> "This is line one" See IO.readlines for details about getline_args. @overload readlines(sep=$/ [, getline_args]) @return [Array] @overload readlines(limit [, getline_args]) @return [Array] @overload readlines(sep, limit [, getline_args]) @return [Array];T;0; @2ï;!F;"o;#;$T;%i%;&i<;'@bè;(I"´static VALUE rb_io_readlines(int argc, VALUE *argv, VALUE io) { struct getline_arg args; prepare_getline_args(argc, argv, &args, io); return io_readlines(&args, io); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#readpartial;F;[[@c0;[[@i;T;;;0;[;{;IC;"v Reads at most maxlen bytes from the I/O stream. It blocks only if ios has no data immediately available. It doesn't block if some data available. If the optional _outbuf_ argument is present, it must reference a String, which will receive the data. The _outbuf_ will contain only the received data after the method call even if it is not empty at the beginning. It raises EOFError on end of file. readpartial is designed for streams such as pipe, socket, tty, etc. It blocks only when no data immediately available. This means that it blocks only when following all conditions hold. * the byte buffer in the IO object is empty. * the content of the stream is empty. * the stream is not reached to EOF. When readpartial blocks, it waits data or EOF on the stream. If some data is reached, readpartial returns with the data. If EOF is reached, readpartial raises EOFError. When readpartial doesn't blocks, it returns or raises immediately. If the byte buffer is not empty, it returns the data in the buffer. Otherwise if the stream has some content, it returns the data in the stream. Otherwise if the stream is reached to EOF, it raises EOFError. r, w = IO.pipe # buffer pipe content w << "abc" # "" "abc". r.readpartial(4096) #=> "abc" "" "" r.readpartial(4096) # blocks because buffer and pipe is empty. r, w = IO.pipe # buffer pipe content w << "abc" # "" "abc" w.close # "" "abc" EOF r.readpartial(4096) #=> "abc" "" EOF r.readpartial(4096) # raises EOFError r, w = IO.pipe # buffer pipe content w << "abc\ndef\n" # "" "abc\ndef\n" r.gets #=> "abc\n" "def\n" "" w << "ghi\n" # "def\n" "ghi\n" r.readpartial(4096) #=> "def\n" "" "ghi\n" r.readpartial(4096) #=> "ghi\n" "" "" Note that readpartial behaves similar to sysread. The differences are: * If the byte buffer is not empty, read from the byte buffer instead of "sysread for buffered IO (IOError)". * It doesn't cause Errno::EWOULDBLOCK and Errno::EINTR. When readpartial meets EWOULDBLOCK and EINTR by read system call, readpartial retry the system call. The latter means that readpartial is nonblocking-flag insensitive. It blocks on the situation IO#sysread causes Errno::EWOULDBLOCK as if the fd is blocking mode. ;T;[o;= ;3I" overload;F;40;;;50;)I"readpartial(maxlen);T;IC;";T; @qï;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @qï;[;I"@return [String];T;0;6i;[[I"maxlen;T0; @qïo;= ;3I" overload;F;40;;;50;)I" readpartial(maxlen, outbuf);T;IC;";T; @qï;>0;!F;[;[;I";T;0;6i;[[I"maxlen;T0[I"outbuf;T0; @qï;[;I"Ð Reads at most maxlen bytes from the I/O stream. It blocks only if ios has no data immediately available. It doesn't block if some data available. If the optional _outbuf_ argument is present, it must reference a String, which will receive the data. The _outbuf_ will contain only the received data after the method call even if it is not empty at the beginning. It raises EOFError on end of file. readpartial is designed for streams such as pipe, socket, tty, etc. It blocks only when no data immediately available. This means that it blocks only when following all conditions hold. * the byte buffer in the IO object is empty. * the content of the stream is empty. * the stream is not reached to EOF. When readpartial blocks, it waits data or EOF on the stream. If some data is reached, readpartial returns with the data. If EOF is reached, readpartial raises EOFError. When readpartial doesn't blocks, it returns or raises immediately. If the byte buffer is not empty, it returns the data in the buffer. Otherwise if the stream has some content, it returns the data in the stream. Otherwise if the stream is reached to EOF, it raises EOFError. r, w = IO.pipe # buffer pipe content w << "abc" # "" "abc". r.readpartial(4096) #=> "abc" "" "" r.readpartial(4096) # blocks because buffer and pipe is empty. r, w = IO.pipe # buffer pipe content w << "abc" # "" "abc" w.close # "" "abc" EOF r.readpartial(4096) #=> "abc" "" EOF r.readpartial(4096) # raises EOFError r, w = IO.pipe # buffer pipe content w << "abc\ndef\n" # "" "abc\ndef\n" r.gets #=> "abc\n" "def\n" "" w << "ghi\n" # "def\n" "ghi\n" r.readpartial(4096) #=> "def\n" "" "ghi\n" r.readpartial(4096) #=> "ghi\n" "" "" Note that readpartial behaves similar to sysread. The differences are: * If the byte buffer is not empty, read from the byte buffer instead of "sysread for buffered IO (IOError)". * It doesn't cause Errno::EWOULDBLOCK and Errno::EINTR. When readpartial meets EWOULDBLOCK and EINTR by read system call, readpartial retry the system call. The latter means that readpartial is nonblocking-flag insensitive. It blocks on the situation IO#sysread causes Errno::EWOULDBLOCK as if the fd is blocking mode. @overload readpartial(maxlen) @return [String] @overload readpartial(maxlen, outbuf);T;0; @qï;!F;"o;#;$T;%iÓ;&i;'@bè;(I"¾static VALUE io_readpartial(int argc, VALUE *argv, VALUE io) { VALUE ret; ret = io_getpartial(argc, argv, io, Qnil, 0); if (NIL_P(ret)) rb_eof_error(); return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#read;F;[[@c0;[[@iÆ;T;;è;0;[;{;IC;"«Reads _length_ bytes from the I/O stream. _length_ must be a non-negative integer or +nil+. If _length_ is a positive integer, +read+ tries to read _length_ bytes without any conversion (binary mode). It returns +nil+ if an EOF is encountered before anything can be read. Fewer than _length_ bytes are returned if an EOF is encountered during the read. In the case of an integer _length_, the resulting string is always in ASCII-8BIT encoding. If _length_ is omitted or is +nil+, it reads until EOF and the encoding conversion is applied, if applicable. A string is returned even if EOF is encountered before any data is read. If _length_ is zero, it returns an empty string (""). If the optional _outbuf_ argument is present, it must reference a String, which will receive the data. The _outbuf_ will contain only the received data after the method call even if it is not empty at the beginning. When this method is called at end of file, it returns +nil+ or "", depending on _length_: +read+, read(nil), and read(0) return "", read(positive_integer) returns +nil+. f = File.new("testfile") f.read(16) #=> "This is line one" # read whole file open("file") do |f| data = f.read # This returns a string even if the file is empty. # ... end # iterate over fixed length records open("fixed-record-file") do |f| while record = f.read(256) # ... end end # iterate over variable length records, # each record is prefixed by its 32-bit length open("variable-record-file") do |f| while len = f.read(4) len = len.unpack("N")[0] # 32-bit length record = f.read(len) # This returns a string even if len is 0. end end Note that this method behaves like the fread() function in C. This means it retries to invoke read(2) system calls to read data with the specified length (or until EOF). This behavior is preserved even if ios is in non-blocking mode. (This method is non-blocking flag insensitive as other methods.) If you need the behavior like a single read(2) system call, consider #readpartial, #read_nonblock, and #sysread. ;T;[o;= ;3I" overload;F;40;;è;50;)I"read([length [, outbuf]]);T;IC;";T; @›ï;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @›ï;[;I"@return [String, nil];T;0;6i;[[I"[length [, outbuf]];T0; @›ï;[;I"éReads _length_ bytes from the I/O stream. _length_ must be a non-negative integer or +nil+. If _length_ is a positive integer, +read+ tries to read _length_ bytes without any conversion (binary mode). It returns +nil+ if an EOF is encountered before anything can be read. Fewer than _length_ bytes are returned if an EOF is encountered during the read. In the case of an integer _length_, the resulting string is always in ASCII-8BIT encoding. If _length_ is omitted or is +nil+, it reads until EOF and the encoding conversion is applied, if applicable. A string is returned even if EOF is encountered before any data is read. If _length_ is zero, it returns an empty string (""). If the optional _outbuf_ argument is present, it must reference a String, which will receive the data. The _outbuf_ will contain only the received data after the method call even if it is not empty at the beginning. When this method is called at end of file, it returns +nil+ or "", depending on _length_: +read+, read(nil), and read(0) return "", read(positive_integer) returns +nil+. f = File.new("testfile") f.read(16) #=> "This is line one" # read whole file open("file") do |f| data = f.read # This returns a string even if the file is empty. # ... end # iterate over fixed length records open("fixed-record-file") do |f| while record = f.read(256) # ... end end # iterate over variable length records, # each record is prefixed by its 32-bit length open("variable-record-file") do |f| while len = f.read(4) len = len.unpack("N")[0] # 32-bit length record = f.read(len) # This returns a string even if len is 0. end end Note that this method behaves like the fread() function in C. This means it retries to invoke read(2) system calls to read data with the specified length (or until EOF). This behavior is preserved even if ios is in non-blocking mode. (This method is non-blocking flag insensitive as other methods.) If you need the behavior like a single read(2) system call, consider #readpartial, #read_nonblock, and #sysread. @overload read([length [, outbuf]]) @return [String, nil];T;0; @›ï;!F;"o;#;$T;%iƒ;&iÃ;'@bè;(I"bstatic VALUE io_read(int argc, VALUE *argv, VALUE io) { rb_io_t *fptr; long n, len; VALUE length, str; int shrinkable; #if defined(RUBY_TEST_CRLF_ENVIRONMENT) || defined(_WIN32) int previous_mode; #endif rb_scan_args(argc, argv, "02", &length, &str); if (NIL_P(length)) { GetOpenFile(io, fptr); rb_io_check_char_readable(fptr); return read_all(fptr, remain_size(fptr), str); } len = NUM2LONG(length); if (len < 0) { rb_raise(rb_eArgError, "negative length %ld given", len); } shrinkable = io_setstrbuf(&str,len); GetOpenFile(io, fptr); rb_io_check_byte_readable(fptr); if (len == 0) { io_set_read_length(str, 0, shrinkable); return str; } READ_CHECK(fptr); #if defined(RUBY_TEST_CRLF_ENVIRONMENT) || defined(_WIN32) previous_mode = set_binary_mode_with_seek_cur(fptr); #endif n = io_fread(str, 0, len, fptr); io_set_read_length(str, n, shrinkable); #if defined(RUBY_TEST_CRLF_ENVIRONMENT) || defined(_WIN32) if (previous_mode == O_TEXT) { setmode(fptr->fd, O_TEXT); } #endif if (n == 0) return Qnil; return str; };T;)I"static VALUE;T;*To;;F; ;;;;I" IO#write;F;[[@c0;[[@i”;T;;é;0;[;{;IC;"uWrites the given strings to ios. The stream must be opened for writing. Arguments that are not a string will be converted to a string using to_s. Returns the number of bytes written in total. count = $stdout.write("This is", " a test\n") puts "That was #{count} bytes of data" produces: This is a test That was 15 bytes of data ;T;[o;= ;3I" overload;F;40;;é;50;)I"write(string, ...);T;IC;";T; @ºï;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ºï;[;I"@return [Integer];T;0;6i;[[I"string;T0[I"...;T0; @ºï;[;I"¨Writes the given strings to ios. The stream must be opened for writing. Arguments that are not a string will be converted to a string using to_s. Returns the number of bytes written in total. count = $stdout.write("This is", " a test\n") puts "That was #{count} bytes of data" produces: This is a test That was 15 bytes of data @overload write(string, ...) @return [Integer];T;0; @ºï;!F;"o;#;$T;%i‚;&i‘;'@bè;(I"¿static VALUE io_write_m(int argc, VALUE *argv, VALUE io) { if (argc != 1) { return io_writev(argc, argv, io); } else { VALUE str = argv[0]; return io_write(io, str, 0); } };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#gets;F;[[@c0;[[@iÈ;T;;¤;0;[;{;IC;"xReads the next ``line'' from the I/O stream; lines are separated by sep. A separator of +nil+ reads the entire contents, and a zero-length separator reads the input a paragraph at a time (two successive newlines in the input separate paragraphs). The stream must be opened for reading or an IOError will be raised. The line read in will be returned and also assigned to $_. Returns +nil+ if called at end of file. 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. File.new("testfile").gets #=> "This is line one\n" $_ #=> "This is line one\n" File.new("testfile").gets(4)#=> "This" If IO contains multibyte characters byte then gets(1) returns character entirely: # Russian characters take 2 bytes File.write("testfile", "\u{442 435 441 442}") File.open("testfile") {|f|f.gets(1)} #=> "\u0442" File.open("testfile") {|f|f.gets(2)} #=> "\u0442" File.open("testfile") {|f|f.gets(3)} #=> "\u0442\u0435" File.open("testfile") {|f|f.gets(4)} #=> "\u0442\u0435" ;T;[o;= ;3I" overload;F;40;;¤;50;)I""gets(sep=$/ [, getline_args]);T;IC;";T; @Úï;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @Úï;[;I"@return [String, nil];T;0;6i;[[I"sep;TI"$/[, getline_args];T; @Úïo;= ;3I" overload;F;40;;¤;50;)I"!gets(limit [, getline_args]);T;IC;";T; @Úï;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @Úï;[;I"@return [String, nil];T;0;6i;[[I"limit[, getline_args];T0; @Úïo;= ;3I" overload;F;40;;¤;50;)I"&gets(sep, limit [, getline_args]);T;IC;";T; @Úï;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @Úï;[;I"@return [String, nil];T;0;6i;[[I"sep;T0[I"limit[, getline_args];T0; @Úï;[;I"=Reads the next ``line'' from the I/O stream; lines are separated by sep. A separator of +nil+ reads the entire contents, and a zero-length separator reads the input a paragraph at a time (two successive newlines in the input separate paragraphs). The stream must be opened for reading or an IOError will be raised. The line read in will be returned and also assigned to $_. Returns +nil+ if called at end of file. 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. File.new("testfile").gets #=> "This is line one\n" $_ #=> "This is line one\n" File.new("testfile").gets(4)#=> "This" If IO contains multibyte characters byte then gets(1) returns character entirely: # Russian characters take 2 bytes File.write("testfile", "\u{442 435 441 442}") File.open("testfile") {|f|f.gets(1)} #=> "\u0442" File.open("testfile") {|f|f.gets(2)} #=> "\u0442" File.open("testfile") {|f|f.gets(3)} #=> "\u0442\u0435" File.open("testfile") {|f|f.gets(4)} #=> "\u0442\u0435" @overload gets(sep=$/ [, getline_args]) @return [String, nil] @overload gets(limit [, getline_args]) @return [String, nil] @overload gets(sep, limit [, getline_args]) @return [String, nil];T;0; @Úï;!F;"o;#;$T;%i§;&iÇ;'@bè;(I"¢static VALUE rb_io_gets_m(int argc, VALUE *argv, VALUE io) { VALUE str; str = rb_io_getline(argc, argv, io); rb_lastline_set(str); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#readline;F;[[@c0;[[@i;T;;¥;0;[;{;IC;"IReads a line as with IO#gets, but raises an EOFError on end of file. ;T;[o;= ;3I" overload;F;40;;¥;50;)I"&readline(sep=$/ [, getline_args]);T;IC;";T; @ð;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ð;[;I"@return [String];T;0;6i;[[I"sep;TI"$/[, getline_args];T; @ðo;= ;3I" overload;F;40;;¥;50;)I"%readline(limit [, getline_args]);T;IC;";T; @ð;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ð;[;I"@return [String];T;0;6i;[[I"limit[, getline_args];T0; @ðo;= ;3I" overload;F;40;;¥;50;)I"*readline(sep, limit [, getline_args]);T;IC;";T; @ð;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ð;[;I"@return [String];T;0;6i;[[I"sep;T0[I"limit[, getline_args];T0; @ð;[;I"Reads a line as with IO#gets, but raises an EOFError on end of file. @overload readline(sep=$/ [, getline_args]) @return [String] @overload readline(limit [, getline_args]) @return [String] @overload readline(sep, limit [, getline_args]) @return [String];T;0; @ð;!F;"o;#;$T;%i;&i;'@bè;(I"¯static VALUE rb_io_readline(int argc, VALUE *argv, VALUE io) { VALUE line = rb_io_gets_m(argc, argv, io); if (NIL_P(line)) { rb_eof_error(); } return line; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#getc;F;[;[[@i¹;T;;;0;[;{;IC;"œReads a one-character string from ios. Returns +nil+ if called at end of file. f = File.new("testfile") f.getc #=> "h" f.getc #=> "e" ;T;[o;= ;3I" overload;F;40;;;50;)I" getc;T;IC;";T; @[ð;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @[ð;[;I"@return [String, nil];T;0;6i;[; @[ð;[;I"ÅReads a one-character string from ios. Returns +nil+ if called at end of file. f = File.new("testfile") f.getc #=> "h" f.getc #=> "e" @overload getc @return [String, nil];T;0; @[ð;!F;"o;#;$T;%i;&i¶;'@bè;(I"èstatic VALUE rb_io_getc(VALUE io) { rb_io_t *fptr; rb_encoding *enc; GetOpenFile(io, fptr); rb_io_check_char_readable(fptr); enc = io_input_encoding(fptr); READ_CHECK(fptr); return io_getc(fptr, enc); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#getbyte;F;[;[[@iê;T;;;0;[;{;IC;"¦Gets the next 8-bit byte (0..255) from ios. Returns +nil+ if called at end of file. f = File.new("testfile") f.getbyte #=> 84 f.getbyte #=> 104 ;T;[o;= ;3I" overload;F;40;;;50;)I"getbyte;T;IC;";T; @wð;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @wð;[;I"@return [Integer, nil];T;0;6i;[; @wð;[;I"ÓGets the next 8-bit byte (0..255) from ios. Returns +nil+ if called at end of file. f = File.new("testfile") f.getbyte #=> 84 f.getbyte #=> 104 @overload getbyte @return [Integer, nil];T;0; @wð;!F;"o;#;$T;%iÞ;&iç;'@bè;(I"\VALUE rb_io_getbyte(VALUE io) { rb_io_t *fptr; int c; GetOpenFile(io, fptr); rb_io_check_byte_readable(fptr); READ_CHECK(fptr); VALUE r_stdout = rb_ractor_stdout(); if (fptr->fd == 0 && (fptr->mode & FMODE_TTY) && RB_TYPE_P(r_stdout, T_FILE)) { rb_io_t *ofp; GetOpenFile(r_stdout, ofp); if (ofp->mode & FMODE_TTY) { rb_io_flush(r_stdout); } } if (io_fillbuf(fptr) < 0) { return Qnil; } fptr->rbuf.off++; fptr->rbuf.len--; c = (unsigned char)fptr->rbuf.ptr[fptr->rbuf.off-1]; return INT2FIX(c & 0xff); };T;)I" VALUE;T;*To;;F; ;;;;I"IO#readchar;F;[;[[@iÓ;T;;;0;[;{;IC;"ŸReads a one-character string from ios. Raises an EOFError on end of file. f = File.new("testfile") f.readchar #=> "h" f.readchar #=> "e" ;T;[o;= ;3I" overload;F;40;;;50;)I" readchar;T;IC;";T; @“ð;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @“ð;[;I"@return [String];T;0;6i;[; @“ð;[;I"ÇReads a one-character string from ios. Raises an EOFError on end of file. f = File.new("testfile") f.readchar #=> "h" f.readchar #=> "e" @overload readchar @return [String];T;0; @“ð;!F;"o;#;$T;%iÇ;&iÐ;'@bè;(I"static VALUE rb_io_readchar(VALUE io) { VALUE c = rb_io_getc(io); if (NIL_P(c)) { rb_eof_error(); } return c; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#readbyte;F;[;[[@i;T;;;0;[;{;IC;"LReads a byte as with IO#getbyte, but raises an EOFError on end of file. ;T;[o;= ;3I" overload;F;40;;;50;)I" readbyte;T;IC;";T; @®ð;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @®ð;[;I"@return [Integer];T;0;6i;[; @®ð;[;I"uReads a byte as with IO#getbyte, but raises an EOFError on end of file. @overload readbyte @return [Integer];T;0; @®ð;!F;"o;#;$T;%i;&i ;'@bè;(I"„static VALUE rb_io_readbyte(VALUE io) { VALUE c = rb_io_getbyte(io); if (NIL_P(c)) { rb_eof_error(); } return c; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#ungetbyte;F;[[I"b;T0;[[@i(;T;;;0;[;{;IC;"öPushes back bytes (passed as a parameter) onto ios, such that a subsequent buffered read will return it. Only one byte may be pushed back before a subsequent read operation (that is, you will be able to read only the last of several bytes that have been pushed back). Has no effect with unbuffered reads (such as IO#sysread). f = File.new("testfile") #=> # b = f.getbyte #=> 0x38 f.ungetbyte(b) #=> nil f.getbyte #=> 0x38 ;T;[o;= ;3I" overload;F;40;;;50;)I"ungetbyte(string);T;IC;";T; @Éð;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @Éð;[;I"@return [nil];T;0;6i;[[I"string;T0; @Éðo;= ;3I" overload;F;40;;;50;)I"ungetbyte(integer);T;IC;";T; @Éð;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @Éð;[;I"@return [nil];T;0;6i;[[I"integer;T0; @Éð;[;I"QPushes back bytes (passed as a parameter) onto ios, such that a subsequent buffered read will return it. Only one byte may be pushed back before a subsequent read operation (that is, you will be able to read only the last of several bytes that have been pushed back). Has no effect with unbuffered reads (such as IO#sysread). f = File.new("testfile") #=> # b = f.getbyte #=> 0x38 f.ungetbyte(b) #=> nil f.getbyte #=> 0x38 @overload ungetbyte(string) @return [nil] @overload ungetbyte(integer) @return [nil];T;0; @Éð;!F;"o;#;$T;%i;&i&;'@bè;(I"âVALUE rb_io_ungetbyte(VALUE io, VALUE b) { rb_io_t *fptr; GetOpenFile(io, fptr); rb_io_check_byte_readable(fptr); switch (TYPE(b)) { case T_NIL: return Qnil; case T_FIXNUM: case T_BIGNUM: ; VALUE v = rb_int_modulo(b, INT2FIX(256)); unsigned char c = NUM2INT(v) & 0xFF; b = rb_str_new((const char *)&c, 1); break; default: SafeStringValue(b); } io_ungetbyte(b, fptr); return Qnil; };T;)I" VALUE;T;*To;;F; ;;;;I"IO#ungetc;F;[[I"c;T0;[[@iO;T;;;0;[;{;IC;"Pushes back one character (passed as a parameter) onto ios, such that a subsequent buffered character read will return it. Only one character may be pushed back before a subsequent read operation (that is, you will be able to read only the last of several characters that have been pushed back). Has no effect with unbuffered reads (such as IO#sysread). f = File.new("testfile") #=> # c = f.getc #=> "8" f.ungetc(c) #=> nil f.getc #=> "8" ;T;[o;= ;3I" overload;F;40;;;50;)I"ungetc(string);T;IC;";T; @÷ð;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @÷ð;[;I"@return [nil];T;0;6i;[[I"string;T0; @÷ð;[;I";Pushes back one character (passed as a parameter) onto ios, such that a subsequent buffered character read will return it. Only one character may be pushed back before a subsequent read operation (that is, you will be able to read only the last of several characters that have been pushed back). Has no effect with unbuffered reads (such as IO#sysread). f = File.new("testfile") #=> # c = f.getc #=> "8" f.ungetc(c) #=> nil f.getc #=> "8" @overload ungetc(string) @return [nil];T;0; @÷ð;!F;"o;#;$T;%i?;&iL;'@bè;(I"ÍVALUE rb_io_ungetc(VALUE io, VALUE c) { rb_io_t *fptr; long len; GetOpenFile(io, fptr); rb_io_check_char_readable(fptr); if (FIXNUM_P(c)) { c = rb_enc_uint_chr(FIX2UINT(c), io_read_encoding(fptr)); } else if (RB_TYPE_P(c, T_BIGNUM)) { c = rb_enc_uint_chr(NUM2UINT(c), io_read_encoding(fptr)); } else { SafeStringValue(c); } if (NEED_READCONV(fptr)) { SET_BINARY_MODE(fptr); len = RSTRING_LEN(c); #if SIZEOF_LONG > SIZEOF_INT if (len > INT_MAX) rb_raise(rb_eIOError, "ungetc failed"); #endif make_readconv(fptr, (int)len); if (fptr->cbuf.capa - fptr->cbuf.len < len) rb_raise(rb_eIOError, "ungetc failed"); if (fptr->cbuf.off < len) { MEMMOVE(fptr->cbuf.ptr+fptr->cbuf.capa-fptr->cbuf.len, fptr->cbuf.ptr+fptr->cbuf.off, char, fptr->cbuf.len); fptr->cbuf.off = fptr->cbuf.capa-fptr->cbuf.len; } fptr->cbuf.off -= (int)len; fptr->cbuf.len += (int)len; MEMMOVE(fptr->cbuf.ptr+fptr->cbuf.off, RSTRING_PTR(c), char, len); } else { NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr); io_ungetbyte(c, fptr); } return Qnil; };T;)I" VALUE;T;*To;;F; ;;;;I" IO#<<;F;[[I"str;T0;[[@iÇ;T;;Ý;0;[;{;IC;"¿String Output---Writes obj to ios. obj will be converted to a string using to_s. $stdout << "Hello " << "world!\n" produces: Hello world! ;T;[o;= ;3I" overload;F;40;;Ý;50;)I"<<(obj);T;IC;";T; @ñ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"IO;T; @ñ;[;I"@return [IO];T;0;6i;[[I"obj;T0; @ñ;[;I"âString Output---Writes obj to ios. obj will be converted to a string using to_s. $stdout << "Hello " << "world!\n" produces: Hello world! @overload <<(obj) @return [IO];T;0; @ñ;!F;"o;#;$T;%i·;&iÃ;'@bè;(I"YVALUE rb_io_addstr(VALUE io, VALUE str) { rb_io_write(io, str); return io; };T;)I" VALUE;T;*To;;F; ;;;;I" IO#flush;F;[;[[@i;T;;Þ;0;[;{;IC;"ùFlushes any buffered data within ios to the underlying operating system (note that this is Ruby internal buffering only; the OS may buffer the data as well). $stdout.print "no newline" $stdout.flush produces: no newline ;T;[o;= ;3I" overload;F;40;;Þ;50;)I" flush;T;IC;";T; @5ñ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"IO;T; @5ñ;[;I"@return [IO];T;0;6i;[; @5ñ;[;I"Flushes any buffered data within ios to the underlying operating system (note that this is Ruby internal buffering only; the OS may buffer the data as well). $stdout.print "no newline" $stdout.flush produces: no newline @overload flush @return [IO];T;0; @5ñ;!F;"o;#;$T;%ió;&i;'@bè;(I"GVALUE rb_io_flush(VALUE io) { return rb_io_flush_raw(io, 1); };T;)I" VALUE;T;*To;;F; ;;;;I"IO#tell;F;[;[[@i;T;;;0;[;{;IC;"Returns the current offset (in bytes) of ios. f = File.new("testfile") f.pos #=> 0 f.gets #=> "This is line one\n" f.pos #=> 17 ;T;[o;= ;3I" overload;F;40;;;50;)I"pos;T;IC;";T; @Pñ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Pñ;[;I"@return [Integer];T;0;6i;[; @Pño;= ;3I" overload;F;40;;;50;)I" tell;T;IC;";T; @Pñ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Pñ;[;I"@return [Integer];T;0;6i;[; @Pñ;[;I"äReturns the current offset (in bytes) of ios. f = File.new("testfile") f.pos #=> 0 f.gets #=> "This is line one\n" f.pos #=> 17 @overload pos @return [Integer] @overload tell @return [Integer];T;0; @Pñ;!F;"o;#;$T;%i ;&i;'@bè;(I"êstatic VALUE rb_io_tell(VALUE io) { rb_io_t *fptr; off_t pos; GetOpenFile(io, fptr); pos = io_tell(fptr); if (pos < 0 && errno) rb_sys_fail_path(fptr->pathv); pos -= fptr->rbuf.len; return OFFT2NUM(pos); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#seek;F;[[@c0;[[@iZ;T;: seek;0;[;{;IC;"Seeks to a given offset anInteger in the stream according to the value of whence: :CUR or IO::SEEK_CUR | Seeks to _amount_ plus current position ----------------------+-------------------------------------------------- :END or IO::SEEK_END | Seeks to _amount_ plus end of stream (you | probably want a negative value for _amount_) ----------------------+-------------------------------------------------- :SET or IO::SEEK_SET | Seeks to the absolute location given by _amount_ Example: f = File.new("testfile") f.seek(-13, IO::SEEK_END) #=> 0 f.readline #=> "And so on...\n" ;T;[o;= ;3I" overload;F;40;;Š;50;)I"&seek(amount, whence=IO::SEEK_SET);T;IC;";T; @xñ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @xñ;[;I"@return [0];T;0;6i;[[I"amount;T0[I"whence;TI"IO::SEEK_SET;T; @xñ;[;I"ÌSeeks to a given offset anInteger in the stream according to the value of whence: :CUR or IO::SEEK_CUR | Seeks to _amount_ plus current position ----------------------+-------------------------------------------------- :END or IO::SEEK_END | Seeks to _amount_ plus end of stream (you | probably want a negative value for _amount_) ----------------------+-------------------------------------------------- :SET or IO::SEEK_SET | Seeks to the absolute location given by _amount_ Example: f = File.new("testfile") f.seek(-13, IO::SEEK_END) #=> 0 f.readline #=> "And so on...\n" @overload seek(amount, whence=IO::SEEK_SET) @return [0];T;0; @xñ;!F;"o;#;$T;%iE;&iW;'@bè;(I"static VALUE rb_io_seek_m(int argc, VALUE *argv, VALUE io) { VALUE offset, ptrname; int whence = SEEK_SET; if (rb_scan_args(argc, argv, "11", &offset, &ptrname) == 2) { whence = interpret_seek_whence(ptrname); } return rb_io_seek(io, offset, whence); };T;)I"static VALUE;T;*To;{;[[@iÂ4;F;: SEEK_SET;;};;;[;{;IC;"(Set I/O position from the beginning ;T;[;[;I"(Set I/O position from the beginning;T;0; @™ñ;!F;"o;#;$T;%iÁ4;&iÁ4;'@bè;I"IO::SEEK_SET;F;~I"INT2FIX(SEEK_SET);To;{;[[@iÄ4;F;: SEEK_CUR;;};;;[;{;IC;"/Set I/O position from the current position ;T;[;[;I"/Set I/O position from the current position;T;0; @¥ñ;!F;"o;#;$T;%iÃ4;&iÃ4;'@bè;I"IO::SEEK_CUR;F;~I"INT2FIX(SEEK_CUR);To;{;[[@iÆ4;F;: SEEK_END;;};;;[;{;IC;""Set I/O position from the end ;T;[;[;I""Set I/O position from the end;T;0; @±ñ;!F;"o;#;$T;%iÅ4;&iÅ4;'@bè;I"IO::SEEK_END;F;~I"INT2FIX(SEEK_END);To;{;[[@iÉ4;F;:SEEK_DATA;;};;;[;{;IC;":Set I/O position to the next location containing data ;T;[;[;I":Set I/O position to the next location containing data;T;0; @½ñ;!F;"o;#;$T;%iÈ4;&iÈ4;'@bè;I"IO::SEEK_DATA;F;~I"INT2FIX(SEEK_DATA);To;{;[[@iÍ4;F;:SEEK_HOLE;;};;;[;{;IC;"&Set I/O position to the next hole ;T;[;[;I"&Set I/O position to the next hole;T;0; @Éñ;!F;"o;#;$T;%iÌ4;&iÌ4;'@bè;I"IO::SEEK_HOLE;F;~I"INT2FIX(SEEK_HOLE);To;;F; ;;;;I"IO#rewind;F;[;[[@i”;T;;;0;[;{;IC;"3Positions ios to the beginning of input, resetting #lineno to zero. f = File.new("testfile") f.readline #=> "This is line one\n" f.rewind #=> 0 f.lineno #=> 0 f.readline #=> "This is line one\n" Note that it cannot be used with streams such as pipes, ttys, and sockets. ;T;[o;= ;3I" overload;F;40;;;50;)I"rewind;T;IC;";T; @Õñ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @Õñ;[;I"@return [0];T;0;6i;[; @Õñ;[;I"TPositions ios to the beginning of input, resetting #lineno to zero. f = File.new("testfile") f.readline #=> "This is line one\n" f.rewind #=> 0 f.lineno #=> 0 f.readline #=> "This is line one\n" Note that it cannot be used with streams such as pipes, ttys, and sockets. @overload rewind @return [0];T;0; @Õñ;!F;"o;#;$T;%i„;&i‘;'@bè;(I"Lstatic VALUE rb_io_rewind(VALUE io) { rb_io_t *fptr; GetOpenFile(io, fptr); if (io_seek(fptr, 0L, 0) < 0 && errno) rb_sys_fail_path(fptr->pathv); if (io == ARGF.current_file) { ARGF.lineno -= fptr->lineno; } fptr->lineno = 0; if (fptr->readconv) { clear_readconv(fptr); } return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#pos;F;[;[[@i;T;;;0;[;{;IC;"Returns the current offset (in bytes) of ios. f = File.new("testfile") f.pos #=> 0 f.gets #=> "This is line one\n" f.pos #=> 17 ;T;[o;= ;3I" overload;F;40;;;50;)I"pos;T;IC;";T; @ðñ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ðñ;[;I"@return [Integer];T;0;6i;[; @ðño;= ;3I" overload;F;40;;;50;)I" tell;T;IC;";T; @ðñ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ðñ;[;I"@return [Integer];T;0;6i;[; @ðñ;[;@tñ;0; @ðñ;!F;"o;#;$T;%i ;&i;'@bè;(I"êstatic VALUE rb_io_tell(VALUE io) { rb_io_t *fptr; off_t pos; GetOpenFile(io, fptr); pos = io_tell(fptr); if (pos < 0 && errno) rb_sys_fail_path(fptr->pathv); pos -= fptr->rbuf.len; return OFFT2NUM(pos); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#pos=;F;[[I"offset;T0;[[@it;T;: pos=;0;[;{;IC;"ÞSeeks to the given position (in bytes) in ios. It is not guaranteed that seeking to the right position when ios is textmode. f = File.new("testfile") f.pos = 17 f.gets #=> "This is line two\n" ;T;[o;= ;3I" overload;F;40;;;50;)I"pos=(integer);T;IC;";T; @ò;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ò;[;I"@return [Integer];T;0;6i;[[I"integer;T0; @ò;[;I"Seeks to the given position (in bytes) in ios. It is not guaranteed that seeking to the right position when ios is textmode. f = File.new("testfile") f.pos = 17 f.gets #=> "This is line two\n" @overload pos=(integer) @return [Integer];T;0; @ò;!F;"o;#;$T;%ig;&iq;'@bè;(I"static VALUE rb_io_set_pos(VALUE io, VALUE offset) { rb_io_t *fptr; off_t pos; pos = NUM2OFFT(offset); GetOpenFile(io, fptr); pos = io_seek(fptr, pos, SEEK_SET); if (pos < 0 && errno) rb_sys_fail_path(fptr->pathv); return OFFT2NUM(pos); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#eof;F;[;[[@iù;T;; ;0;[;{;IC;"Returns true if ios is at end of file that means there are no more data to read. The stream must be opened for reading or an IOError will be raised. f = File.new("testfile") dummy = f.readlines f.eof #=> true If ios is a stream such as pipe or socket, IO#eof? blocks until the other end sends some data or closes it. r, w = IO.pipe Thread.new { sleep 1; w.close } r.eof? #=> true after 1 second blocking r, w = IO.pipe Thread.new { sleep 1; w.puts "a" } r.eof? #=> false after 1 second blocking r, w = IO.pipe r.eof? # blocks forever Note that IO#eof? reads data to the input byte buffer. So IO#sysread may not behave as you intend with IO#eof?, unless you call IO#rewind first (which is not available for some streams). ;T;[o;= ;3I" overload;F;40;; ;50;)I"eof;T;IC;";T; @6ò;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @6ò;[;I"@return [Boolean];T;0;6i;[; @6òo;= ;3I" overload;F;40;;;50;)I" eof?;T;IC;";T; @6ò;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @6ò;[;I"@return [Boolean];T;0;6i;[; @6ò;[;I"VReturns true if ios is at end of file that means there are no more data to read. The stream must be opened for reading or an IOError will be raised. f = File.new("testfile") dummy = f.readlines f.eof #=> true If ios is a stream such as pipe or socket, IO#eof? blocks until the other end sends some data or closes it. r, w = IO.pipe Thread.new { sleep 1; w.close } r.eof? #=> true after 1 second blocking r, w = IO.pipe Thread.new { sleep 1; w.puts "a" } r.eof? #=> false after 1 second blocking r, w = IO.pipe r.eof? # blocks forever Note that IO#eof? reads data to the input byte buffer. So IO#sysread may not behave as you intend with IO#eof?, unless you call IO#rewind first (which is not available for some streams). @overload eof @return [Boolean] @overload eof? @return [Boolean];T;0; @6ò;!F;"o;#;$T;%iØ;&i÷;'@bè;(I"èVALUE rb_io_eof(VALUE io) { rb_io_t *fptr; GetOpenFile(io, fptr); rb_io_check_char_readable(fptr); if (READ_CHAR_PENDING(fptr)) return Qfalse; if (READ_DATA_PENDING(fptr)) return Qfalse; READ_CHECK(fptr); #if defined(RUBY_TEST_CRLF_ENVIRONMENT) || defined(_WIN32) if (!NEED_READCONV(fptr) && NEED_NEWLINE_DECORATOR_ON_READ(fptr)) { return eof(fptr->fd) ? Qtrue : Qfalse; } #endif if (io_fillbuf(fptr) < 0) { return Qtrue; } return Qfalse; };T;)I" VALUE;T;*To;;F; ;;;;I"IO#eof?;F;[;[[@iù;T;;;0;[;{;IC;"Returns true if ios is at end of file that means there are no more data to read. The stream must be opened for reading or an IOError will be raised. f = File.new("testfile") dummy = f.readlines f.eof #=> true If ios is a stream such as pipe or socket, IO#eof? blocks until the other end sends some data or closes it. r, w = IO.pipe Thread.new { sleep 1; w.close } r.eof? #=> true after 1 second blocking r, w = IO.pipe Thread.new { sleep 1; w.puts "a" } r.eof? #=> false after 1 second blocking r, w = IO.pipe r.eof? # blocks forever Note that IO#eof? reads data to the input byte buffer. So IO#sysread may not behave as you intend with IO#eof?, unless you call IO#rewind first (which is not available for some streams).;T;[o;= ;3I" overload;F;40;; ;50;)I"eof;T;IC;";T; @^ò;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @^ò;[;I"@return [Boolean];T;0;6i;[; @^òo;= ;3I" overload;F;40;;;50;)I" eof?;T;IC;";T; @^ò;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @^ò;[;I"@return [Boolean];T;0;6i;[; @^ò;[;@Zò;0; @^ò;!F;"o;#;$T;%iØ;&i÷;6i;'@bè;(I"èVALUE rb_io_eof(VALUE io) { rb_io_t *fptr; GetOpenFile(io, fptr); rb_io_check_char_readable(fptr); if (READ_CHAR_PENDING(fptr)) return Qfalse; if (READ_DATA_PENDING(fptr)) return Qfalse; READ_CHECK(fptr); #if defined(RUBY_TEST_CRLF_ENVIRONMENT) || defined(_WIN32) if (!NEED_READCONV(fptr) && NEED_NEWLINE_DECORATOR_ON_READ(fptr)) { return eof(fptr->fd) ? Qtrue : Qfalse; } #endif if (io_fillbuf(fptr) < 0) { return Qtrue; } return Qfalse; };T;)I" VALUE;T;*To;;F; ;;;;I"IO#close_on_exec?;F;[;[[@i¡;T;:close_on_exec?;0;[;{;IC;"Returns true if ios will be closed on exec. f = open("/dev/null") f.close_on_exec? #=> false f.close_on_exec = true f.close_on_exec? #=> true f.close_on_exec = false f.close_on_exec? #=> false;T;[o;= ;3I" overload;F;40;;‘;50;)I"close_on_exec?;T;IC;";T; @…ò;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @…ò;[;I"@return [Boolean];T;0;6i;[; @…ò;[;I"HReturns true if ios will be closed on exec. f = open("/dev/null") f.close_on_exec? #=> false f.close_on_exec = true f.close_on_exec? #=> true f.close_on_exec = false f.close_on_exec? #=> false @overload close_on_exec? @return [Boolean];T;0; @…ò;!F;"o;#;$T;%i“;&iž;6i;'@bè;(I"astatic VALUE rb_io_close_on_exec_p(VALUE io) { rb_io_t *fptr; VALUE write_io; int fd, ret; write_io = GetWriteIO(io); if (io != write_io) { GetOpenFile(write_io, fptr); if (fptr && 0 <= (fd = fptr->fd)) { if ((ret = fcntl(fd, F_GETFD)) == -1) rb_sys_fail_path(fptr->pathv); if (!(ret & FD_CLOEXEC)) return Qfalse; } } GetOpenFile(io, fptr); if (fptr && 0 <= (fd = fptr->fd)) { if ((ret = fcntl(fd, F_GETFD)) == -1) rb_sys_fail_path(fptr->pathv); if (!(ret & FD_CLOEXEC)) return Qfalse; } return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#close_on_exec=;F;[[I"arg;T0;[[@iÑ;T;:close_on_exec=;0;[;{;IC;"FSets a close-on-exec flag. f = open("/dev/null") f.close_on_exec = true system("cat", "/proc/self/fd/#{f.fileno}") # cat: /proc/self/fd/3: No such file or directory f.closed? #=> false Ruby sets close-on-exec flags of all file descriptors by default since Ruby 2.0.0. So you don't need to set by yourself. Also, unsetting a close-on-exec flag can cause file descriptor leak if another thread use fork() and exec() (via system() method for example). If you really needs file descriptor inheritance to child process, use spawn()'s argument such as fd=>fd. ;T;[o;= ;3I" overload;F;40;;’;50;)I"close_on_exec=(bool);T;IC;";T; @ ò;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ ò;[;I"@return [Boolean];T;0;6i;[[I" bool;T0; @ ò;[;I"{Sets a close-on-exec flag. f = open("/dev/null") f.close_on_exec = true system("cat", "/proc/self/fd/#{f.fileno}") # cat: /proc/self/fd/3: No such file or directory f.closed? #=> false Ruby sets close-on-exec flags of all file descriptors by default since Ruby 2.0.0. So you don't need to set by yourself. Also, unsetting a close-on-exec flag can cause file descriptor leak if another thread use fork() and exec() (via system() method for example). If you really needs file descriptor inheritance to child process, use spawn()'s argument such as fd=>fd. @overload close_on_exec=(bool) @return [Boolean];T;0; @ ò;!F;"o;#;$T;%i½;&iÎ;'@bè;(I"Üstatic VALUE rb_io_set_close_on_exec(VALUE io, VALUE arg) { int flag = RTEST(arg) ? FD_CLOEXEC : 0; rb_io_t *fptr; VALUE write_io; int fd, ret; write_io = GetWriteIO(io); if (io != write_io) { GetOpenFile(write_io, fptr); if (fptr && 0 <= (fd = fptr->fd)) { if ((ret = fcntl(fptr->fd, F_GETFD)) == -1) rb_sys_fail_path(fptr->pathv); if ((ret & FD_CLOEXEC) != flag) { ret = (ret & ~FD_CLOEXEC) | flag; ret = fcntl(fd, F_SETFD, ret); if (ret != 0) rb_sys_fail_path(fptr->pathv); } } } GetOpenFile(io, fptr); if (fptr && 0 <= (fd = fptr->fd)) { if ((ret = fcntl(fd, F_GETFD)) == -1) rb_sys_fail_path(fptr->pathv); if ((ret & FD_CLOEXEC) != flag) { ret = (ret & ~FD_CLOEXEC) | flag; ret = fcntl(fd, F_SETFD, ret); if (ret != 0) rb_sys_fail_path(fptr->pathv); } } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I" IO#close;F;[;[[@i];T;;:;0;[;{;IC;"šCloses ios and flushes any pending writes to the operating system. The stream is unavailable for any further data operations; an IOError is raised if such an attempt is made. I/O streams are automatically closed when they are claimed by the garbage collector. If ios is opened by IO.popen, #close sets $?. Calling this method on closed IO object is just ignored since Ruby 2.3. ;T;[o;= ;3I" overload;F;40;;:;50;)I" close;T;IC;";T; @¿ò;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @¿ò;[;I"@return [nil];T;0;6i;[; @¿ò;[;I"¼Closes ios and flushes any pending writes to the operating system. The stream is unavailable for any further data operations; an IOError is raised if such an attempt is made. I/O streams are automatically closed when they are claimed by the garbage collector. If ios is opened by IO.popen, #close sets $?. Calling this method on closed IO object is just ignored since Ruby 2.3. @overload close @return [nil];T;0; @¿ò;!F;"o;#;$T;%iN;&iZ;'@bè;(I"©static VALUE rb_io_close_m(VALUE io) { rb_io_t *fptr = rb_io_get_fptr(io); if (fptr->fd < 0) { return Qnil; } rb_io_close(io); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#closed?;F;[;[[@i™;T;;8;0;[;{;IC;"mReturns true if ios is completely closed (for duplex streams, both reader and writer), false otherwise. f = File.new("testfile") f.close #=> nil f.closed? #=> true f = IO.popen("/bin/sh","r+") f.close_write #=> nil f.closed? #=> false f.close_read #=> nil f.closed? #=> true;T;[o;= ;3I" overload;F;40;;8;50;)I"closed?;T;IC;";T; @Úò;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Úò;[;I"@return [Boolean];T;0;6i;[; @Úò;[;I"•Returns true if ios is completely closed (for duplex streams, both reader and writer), false otherwise. f = File.new("testfile") f.close #=> nil f.closed? #=> true f = IO.popen("/bin/sh","r+") f.close_write #=> nil f.closed? #=> false f.close_read #=> nil f.closed? #=> true @overload closed? @return [Boolean];T;0; @Úò;!F;"o;#;$T;%i†;&i•;6i;'@bè;(I"tstatic VALUE rb_io_closed(VALUE io) { rb_io_t *fptr; VALUE write_io; rb_io_t *write_fptr; write_io = GetWriteIO(io); if (io != write_io) { write_fptr = RFILE(write_io)->fptr; if (write_fptr && 0 <= write_fptr->fd) { return Qfalse; } } fptr = rb_io_get_fptr(io); return 0 <= fptr->fd ? Qfalse : Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#close_read;F;[;[[@iÀ;T;:close_read;0;[;{;IC;"˜Closes the read end of a duplex I/O stream (i.e., one that contains both a read and a write stream, such as a pipe). Will raise an IOError if the stream is not duplexed. f = IO.popen("/bin/sh","r+") f.close_read f.readlines produces: prog.rb:3:in `readlines': not opened for reading (IOError) from prog.rb:3 Calling this method on closed IO object is just ignored since Ruby 2.3. ;T;[o;= ;3I" overload;F;40;;“;50;)I"close_read;T;IC;";T; @õò;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @õò;[;I"@return [nil];T;0;6i;[; @õò;[;I"¿Closes the read end of a duplex I/O stream (i.e., one that contains both a read and a write stream, such as a pipe). Will raise an IOError if the stream is not duplexed. f = IO.popen("/bin/sh","r+") f.close_read f.readlines produces: prog.rb:3:in `readlines': not opened for reading (IOError) from prog.rb:3 Calling this method on closed IO object is just ignored since Ruby 2.3. @overload close_read @return [nil];T;0; @õò;!F;"o;#;$T;%i¬;&i½;'@bè;(I"cstatic VALUE rb_io_close_read(VALUE io) { rb_io_t *fptr; VALUE write_io; fptr = rb_io_get_fptr(rb_io_taint_check(io)); if (fptr->fd < 0) return Qnil; if (is_socket(fptr->fd, fptr->pathv)) { #ifndef SHUT_RD # define SHUT_RD 0 #endif if (shutdown(fptr->fd, SHUT_RD) < 0) rb_sys_fail_path(fptr->pathv); fptr->mode &= ~FMODE_READABLE; if (!(fptr->mode & FMODE_WRITABLE)) return rb_io_close(io); return Qnil; } write_io = GetWriteIO(io); if (io != write_io) { rb_io_t *wfptr; wfptr = rb_io_get_fptr(rb_io_taint_check(write_io)); wfptr->pid = fptr->pid; fptr->pid = 0; RFILE(io)->fptr = wfptr; /* bind to write_io temporarily to get rid of memory/fd leak */ fptr->tied_io_for_writing = 0; RFILE(write_io)->fptr = fptr; rb_io_fptr_cleanup(fptr, FALSE); /* should not finalize fptr because another thread may be reading it */ return Qnil; } if ((fptr->mode & (FMODE_DUPLEX|FMODE_WRITABLE)) == FMODE_WRITABLE) { rb_raise(rb_eIOError, "closing non-duplex IO for reading"); } return rb_io_close(io); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#close_write;F;[;[[@iþ;T;:close_write;0;[;{;IC;"ºCloses the write end of a duplex I/O stream (i.e., one that contains both a read and a write stream, such as a pipe). Will raise an IOError if the stream is not duplexed. f = IO.popen("/bin/sh","r+") f.close_write f.print "nowhere" produces: prog.rb:3:in `write': not opened for writing (IOError) from prog.rb:3:in `print' from prog.rb:3 Calling this method on closed IO object is just ignored since Ruby 2.3. ;T;[o;= ;3I" overload;F;40;;”;50;)I"close_write;T;IC;";T; @ó;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @ó;[;I"@return [nil];T;0;6i;[; @ó;[;I"âCloses the write end of a duplex I/O stream (i.e., one that contains both a read and a write stream, such as a pipe). Will raise an IOError if the stream is not duplexed. f = IO.popen("/bin/sh","r+") f.close_write f.print "nowhere" produces: prog.rb:3:in `write': not opened for writing (IOError) from prog.rb:3:in `print' from prog.rb:3 Calling this method on closed IO object is just ignored since Ruby 2.3. @overload close_write @return [nil];T;0; @ó;!F;"o;#;$T;%ié;&iû;'@bè;(I"7static VALUE rb_io_close_write(VALUE io) { rb_io_t *fptr; VALUE write_io; write_io = GetWriteIO(io); fptr = rb_io_get_fptr(rb_io_taint_check(write_io)); if (fptr->fd < 0) return Qnil; if (is_socket(fptr->fd, fptr->pathv)) { #ifndef SHUT_WR # define SHUT_WR 1 #endif if (shutdown(fptr->fd, SHUT_WR) < 0) rb_sys_fail_path(fptr->pathv); fptr->mode &= ~FMODE_WRITABLE; if (!(fptr->mode & FMODE_READABLE)) return rb_io_close(write_io); return Qnil; } if ((fptr->mode & (FMODE_DUPLEX|FMODE_READABLE)) == FMODE_READABLE) { rb_raise(rb_eIOError, "closing non-duplex IO for writing"); } if (io != write_io) { fptr = rb_io_get_fptr(rb_io_taint_check(io)); fptr->tied_io_for_writing = 0; } rb_io_close(write_io); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#isatty;F;[;[[@i‡;T;:isatty;0;[;{;IC;"ÉReturns true if ios is associated with a terminal device (tty), false otherwise. File.new("testfile").isatty #=> false File.new("/dev/tty").isatty #=> true ;T;[o;= ;3I" overload;F;40;;•;50;)I"isatty;T;IC;";T; @+ó;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @+ó;[;I"@return [Boolean];T;0;6i;[; @+óo;= ;3I" overload;F;40;: tty?;50;)I" tty?;T;IC;";T; @+ó;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @+ó;[;I"@return [Boolean];T;0;6i;[; @+ó;[;I"Returns true if ios is associated with a terminal device (tty), false otherwise. File.new("testfile").isatty #=> false File.new("/dev/tty").isatty #=> true @overload isatty @return [Boolean] @overload tty? @return [Boolean];T;0; @+ó;!F;"o;#;$T;%i{;&i…;'@bè;(I"—static VALUE rb_io_isatty(VALUE io) { rb_io_t *fptr; GetOpenFile(io, fptr); if (isatty(fptr->fd) == 0) return Qfalse; return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#tty?;F;[;[[@i‡;T;;–;0;[;{;IC;"ÉReturns true if ios is associated with a terminal device (tty), false otherwise. File.new("testfile").isatty #=> false File.new("/dev/tty").isatty #=> true;T;[o;= ;3I" overload;F;40;;•;50;)I"isatty;T;IC;";T; @Só;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Só;[;I"@return [Boolean];T;0;6i;[; @Sóo;= ;3I" overload;F;40;;–;50;)I" tty?;T;IC;";T; @Só;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Só;[;I"@return [Boolean];T;0;6i;[; @Só;[;@Oó;0; @Só;!F;"o;#;$T;%i{;&i…;6i;'@bè;(I"—static VALUE rb_io_isatty(VALUE io) { rb_io_t *fptr; GetOpenFile(io, fptr); if (isatty(fptr->fd) == 0) return Qfalse; return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#binmode;F;[;[[@i;T;:binmode;0;[;{;IC;"ËPuts ios into binary mode. Once a stream is in binary mode, it cannot be reset to nonbinary mode. - newline conversion disabled - encoding conversion disabled - content is treated as ASCII-8BIT ;T;[o;= ;3I" overload;F;40;;—;50;)I"binmode;T;IC;";T; @zó;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"IO;T; @zó;[;I"@return [IO];T;0;6i;[; @zó;[;I"îPuts ios into binary mode. Once a stream is in binary mode, it cannot be reset to nonbinary mode. - newline conversion disabled - encoding conversion disabled - content is treated as ASCII-8BIT @overload binmode @return [IO];T;0; @zó;!F;"o;#;$T;%i;&iŠ;'@bè;(I"Òstatic VALUE rb_io_binmode_m(VALUE io) { VALUE write_io; rb_io_ascii8bit_binmode(io); write_io = GetWriteIO(io); if (write_io != io) rb_io_ascii8bit_binmode(write_io); return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#binmode?;F;[;[[@i ;T;: binmode?;0;[;{;IC;":Returns true if ios is binmode.;T;[o;= ;3I" overload;F;40;;˜;50;)I" binmode?;T;IC;";T; @•ó;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @•ó;[;I"@return [Boolean];T;0;6i;[; @•ó;[;I"cReturns true if ios is binmode. @overload binmode? @return [Boolean];T;0; @•ó;!F;"o;#;$T;%iš;&iž;6i;'@bè;(I"static VALUE rb_io_binmode_p(VALUE io) { rb_io_t *fptr; GetOpenFile(io, fptr); return fptr->mode & FMODE_BINMODE ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#sysseek;F;[[@c0;[[@i,;T;:sysseek;0;[;{;IC;"Seeks to a given offset in the stream according to the value of whence (see IO#seek for values of whence). Returns the new offset into the file. f = File.new("testfile") f.sysseek(-13, IO::SEEK_END) #=> 53 f.sysread(10) #=> "And so on." ;T;[o;= ;3I" overload;F;40;;™;50;)I")sysseek(offset, whence=IO::SEEK_SET);T;IC;";T; @°ó;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @°ó;[;I"@return [Integer];T;0;6i;[[I"offset;T0[I"whence;TI"IO::SEEK_SET;T; @°ó;[;I"cSeeks to a given offset in the stream according to the value of whence (see IO#seek for values of whence). Returns the new offset into the file. f = File.new("testfile") f.sysseek(-13, IO::SEEK_END) #=> 53 f.sysread(10) #=> "And so on." @overload sysseek(offset, whence=IO::SEEK_SET) @return [Integer];T;0; @°ó;!F;"o;#;$T;%i;&i);'@bè;(I"Õstatic VALUE rb_io_sysseek(int argc, VALUE *argv, VALUE io) { VALUE offset, ptrname; int whence = SEEK_SET; rb_io_t *fptr; off_t pos; if (rb_scan_args(argc, argv, "11", &offset, &ptrname) == 2) { whence = interpret_seek_whence(ptrname); } pos = NUM2OFFT(offset); GetOpenFile(io, fptr); if ((fptr->mode & FMODE_READABLE) && (READ_DATA_BUFFERED(fptr) || READ_CHAR_PENDING(fptr))) { rb_raise(rb_eIOError, "sysseek for buffered IO"); } if ((fptr->mode & FMODE_WRITABLE) && fptr->wbuf.len) { rb_warn("sysseek for buffered IO"); } errno = 0; pos = lseek(fptr->fd, pos, whence); if (pos < 0 && errno) rb_sys_fail_path(fptr->pathv); return OFFT2NUM(pos); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#advise;F;[[@c0;[[@ip%;T;:advise;0;[;{;IC;";Announce an intention to access data from the current file in a specific pattern. On platforms that do not support the posix_fadvise(2) system call, this method is a no-op. _advice_ is one of the following symbols: :normal:: No advice to give; the default assumption for an open file. :sequential:: The data will be accessed sequentially with lower offsets read before higher ones. :random:: The data will be accessed in random order. :willneed:: The data will be accessed in the near future. :dontneed:: The data will not be accessed in the near future. :noreuse:: The data will only be accessed once. The semantics of a piece of advice are platform-dependent. See man 2 posix_fadvise for details. "data" means the region of the current file that begins at _offset_ and extends for _len_ bytes. If _len_ is 0, the region ends at the last byte of the file. By default, both _offset_ and _len_ are 0, meaning that the advice applies to the entire file. If an error occurs, one of the following exceptions will be raised: IOError:: The IO stream is closed. Errno::EBADF:: The file descriptor of the current file is invalid. Errno::EINVAL:: An invalid value for _advice_ was given. Errno::ESPIPE:: The file descriptor of the current file refers to a FIFO or pipe. (Linux raises Errno::EINVAL in this case). TypeError:: Either _advice_ was not a Symbol, or one of the other arguments was not an Integer. RangeError:: One of the arguments given was too big/small. This list is not exhaustive; other Errno:: exceptions are also possible. ;T;[o;= ;3I" overload;F;40;;š;50;)I"$advise(advice, offset=0, len=0);T;IC;";T; @Ñó;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @Ñó;[;I"@return [nil];T;0;6i;[[I"advice;T0[I"offset;TI"0;T[I"len;TI"0;T; @Ñó;[;I"wAnnounce an intention to access data from the current file in a specific pattern. On platforms that do not support the posix_fadvise(2) system call, this method is a no-op. _advice_ is one of the following symbols: :normal:: No advice to give; the default assumption for an open file. :sequential:: The data will be accessed sequentially with lower offsets read before higher ones. :random:: The data will be accessed in random order. :willneed:: The data will be accessed in the near future. :dontneed:: The data will not be accessed in the near future. :noreuse:: The data will only be accessed once. The semantics of a piece of advice are platform-dependent. See man 2 posix_fadvise for details. "data" means the region of the current file that begins at _offset_ and extends for _len_ bytes. If _len_ is 0, the region ends at the last byte of the file. By default, both _offset_ and _len_ are 0, meaning that the advice applies to the entire file. If an error occurs, one of the following exceptions will be raised: IOError:: The IO stream is closed. Errno::EBADF:: The file descriptor of the current file is invalid. Errno::EINVAL:: An invalid value for _advice_ was given. Errno::ESPIPE:: The file descriptor of the current file refers to a FIFO or pipe. (Linux raises Errno::EINVAL in this case). TypeError:: Either _advice_ was not a Symbol, or one of the other arguments was not an Integer. RangeError:: One of the arguments given was too big/small. This list is not exhaustive; other Errno:: exceptions are also possible. @overload advise(advice, offset=0, len=0) @return [nil];T;0; @Ñó;!F;"o;#;$T;%iF%;&in%;'@bè;(I"static VALUE rb_io_advise(int argc, VALUE *argv, VALUE io) { VALUE advice, offset, len; off_t off, l; rb_io_t *fptr; rb_scan_args(argc, argv, "12", &advice, &offset, &len); advice_arg_check(advice); io = GetWriteIO(io); GetOpenFile(io, fptr); off = NIL_P(offset) ? 0 : NUM2OFFT(offset); l = NIL_P(len) ? 0 : NUM2OFFT(len); #ifdef HAVE_POSIX_FADVISE return do_io_advise(fptr, advice, off, l); #else ((void)off, (void)l); /* Ignore all hint */ return Qnil; #endif };T;)I"static VALUE;T;*To;;F; ;;;;I" IO#ioctl;F;[[@c0;[[@i\';T;: ioctl;0;[;{;IC;"[Provides a mechanism for issuing low-level commands to control or query I/O devices. Arguments and results are platform dependent. If arg is a number, its value is passed directly. If it is a string, it is interpreted as a binary sequence of bytes. On Unix platforms, see ioctl(2) for details. Not implemented on all platforms. ;T;[o;= ;3I" overload;F;40;;›;50;)I"ioctl(integer_cmd, arg);T;IC;";T; @õó;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @õó;[;I"@return [Integer];T;0;6i;[[I"integer_cmd;T0[I"arg;T0; @õó;[;I"“Provides a mechanism for issuing low-level commands to control or query I/O devices. Arguments and results are platform dependent. If arg is a number, its value is passed directly. If it is a string, it is interpreted as a binary sequence of bytes. On Unix platforms, see ioctl(2) for details. Not implemented on all platforms. @overload ioctl(integer_cmd, arg) @return [Integer];T;0; @õó;!F;"o;#;$T;%iP';&iY';'@bè;(I"¥static VALUE rb_io_ioctl(int argc, VALUE *argv, VALUE io) { VALUE req, arg; rb_scan_args(argc, argv, "11", &req, &arg); return rb_ioctl(io, req, arg); };T;)I"static VALUE;T;*To;;F; ;;;;I" IO#fcntl;F;[[@c0;[[@iº';T;: fcntl;0;[;{;IC;"¢Provides a mechanism for issuing low-level commands to control or query file-oriented I/O streams. Arguments and results are platform dependent. If arg is a number, its value is passed directly. If it is a string, it is interpreted as a binary sequence of bytes (Array#pack might be a useful way to build this string). On Unix platforms, see fcntl(2) for details. Not implemented on all platforms. ;T;[o;= ;3I" overload;F;40;;œ;50;)I"fcntl(integer_cmd, arg);T;IC;";T; @ô;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ô;[;I"@return [Integer];T;0;6i;[[I"integer_cmd;T0[I"arg;T0; @ô;[;I"ÚProvides a mechanism for issuing low-level commands to control or query file-oriented I/O streams. Arguments and results are platform dependent. If arg is a number, its value is passed directly. If it is a string, it is interpreted as a binary sequence of bytes (Array#pack might be a useful way to build this string). On Unix platforms, see fcntl(2) for details. Not implemented on all platforms. @overload fcntl(integer_cmd, arg) @return [Integer];T;0; @ô;!F;"o;#;$T;%i';&i·';'@bè;(I"¥static VALUE rb_io_fcntl(int argc, VALUE *argv, VALUE io) { VALUE req, arg; rb_scan_args(argc, argv, "11", &req, &arg); return rb_fcntl(io, req, arg); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#pid;F;[;[[@iÄ ;T;;—;0;[;{;IC;"KReturns the process ID of a child process associated with ios. This will be set by IO.popen. pipe = IO.popen("-") if pipe $stderr.puts "In parent, child pid is #{pipe.pid}" else $stderr.puts "In child, pid is #{$$}" end produces: In child, pid is 26209 In parent, child pid is 26209 ;T;[o;= ;3I" overload;F;40;;—;50;)I"pid;T;IC;";T; @5ô;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @5ô;[;I"@return [Integer];T;0;6i;[; @5ô;[;I"oReturns the process ID of a child process associated with ios. This will be set by IO.popen. pipe = IO.popen("-") if pipe $stderr.puts "In parent, child pid is #{pipe.pid}" else $stderr.puts "In child, pid is #{$$}" end produces: In child, pid is 26209 In parent, child pid is 26209 @overload pid @return [Integer];T;0; @5ô;!F;"o;#;$T;%i° ;&iÁ ;'@bè;(I"•static VALUE rb_io_pid(VALUE io) { rb_io_t *fptr; GetOpenFile(io, fptr); if (!fptr->pid) return Qnil; return PIDT2NUM(fptr->pid); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#inspect;F;[;[[@i× ;T;;r;0;[;{;IC;"/Return a string describing this IO object. ;T;[o;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @Pô;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Pô;[;I"@return [String];T;0;6i;[; @Pô;[;I"VReturn a string describing this IO object. @overload inspect @return [String];T;0; @Pô;!F;"o;#;$T;%iÐ ;&iÔ ;'@bè;(I"´static VALUE rb_io_inspect(VALUE obj) { rb_io_t *fptr; VALUE result; static const char closed[] = " (closed)"; fptr = RFILE(obj)->fptr; if (!fptr) return rb_any_to_s(obj); result = rb_str_new_cstr("#<"); rb_str_append(result, rb_class_name(CLASS_OF(obj))); rb_str_cat2(result, ":"); if (NIL_P(fptr->pathv)) { if (fptr->fd < 0) { rb_str_cat(result, closed+1, strlen(closed)-1); } else { rb_str_catf(result, "fd %d", fptr->fd); } } else { rb_str_append(result, fptr->pathv); if (fptr->fd < 0) { rb_str_cat(result, closed, strlen(closed)); } } return rb_str_cat2(result, ">"); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#external_encoding;F;[;[[@i›.;T;;;0;[;{;IC;"‹Returns the Encoding object that represents the encoding of the file. If _io_ is in write mode and no encoding is specified, returns +nil+. ;T;[o;= ;3I" overload;F;40;;;50;)I"external_encoding;T;IC;";T; @kô;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Encoding;T; @kô;[;I"@return [Encoding];T;0;6i;[; @kô;[;I"¾Returns the Encoding object that represents the encoding of the file. If _io_ is in write mode and no encoding is specified, returns +nil+. @overload external_encoding @return [Encoding];T;0; @kô;!F;"o;#;$T;%i“.;&i˜.;'@bè;(I"lstatic VALUE rb_io_external_encoding(VALUE io) { rb_io_t *fptr; GetOpenFile(io, fptr); if (fptr->encs.enc2) { return rb_enc_from_encoding(fptr->encs.enc2); } if (fptr->mode & FMODE_WRITABLE) { if (fptr->encs.enc) return rb_enc_from_encoding(fptr->encs.enc); return Qnil; } return rb_enc_from_encoding(io_read_encoding(fptr)); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#internal_encoding;F;[;[[@i´.;T;:internal_encoding;0;[;{;IC;"fReturns the Encoding of the internal string if conversion is specified. Otherwise returns +nil+. ;T;[o;= ;3I" overload;F;40;;;50;)I"internal_encoding;T;IC;";T; @†ô;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Encoding;T; @†ô;[;I"@return [Encoding];T;0;6i;[; @†ô;[;I"”Returns the Encoding of the internal string if conversion is specified. Otherwise returns +nil+. @overload internal_encoding @return [Encoding];T;0; @†ô;!F;"o;#;$T;%i¬.;&i±.;'@bè;(I"Ástatic VALUE rb_io_internal_encoding(VALUE io) { rb_io_t *fptr; GetOpenFile(io, fptr); if (!fptr->encs.enc2) return Qnil; return rb_enc_from_encoding(io_read_encoding(fptr)); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#set_encoding;F;[[@c0;[[@iÑ.;T;:set_encoding;0;[;{;IC;"2If single argument is specified, read string from io is tagged with the encoding specified. If encoding is a colon separated two encoding names "A:B", the read string is converted from encoding A (external encoding) to encoding B (internal encoding), then tagged with B. If two arguments are specified, those must be encoding objects or encoding names, and the first one is the external encoding, and the second one is the internal encoding. If the external encoding and the internal encoding is specified, optional hash argument specify the conversion option. ;T;[ o;= ;3I" overload;F;40;;ž;50;)I"set_encoding(ext_enc);T;IC;";T; @¡ô;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"IO;T; @¡ô;[;I"@return [IO];T;0;6i;[[I"ext_enc;T0; @¡ôo;= ;3I" overload;F;40;;ž;50;)I"$set_encoding("ext_enc:int_enc");T;IC;";T; @¡ô;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"IO;T; @¡ô;[;I"@return [IO];T;0;6i;[[""ext_enc:" int_enc"; @¡ôo;= ;3I" overload;F;40;;ž;50;)I"#set_encoding(ext_enc, int_enc);T;IC;";T; @¡ô;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"IO;T; @¡ô;[;I"@return [IO];T;0;6i;[[I"ext_enc;T0[I"int_enc;T0; @¡ôo;= ;3I" overload;F;40;;ž;50;)I")set_encoding("ext_enc:int_enc", opt);T;IC;";T; @¡ô;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"IO;T; @¡ô;[;I"@return [IO];T;0;6i;[[""ext_enc:" int_enc"[I"opt;T0; @¡ôo;= ;3I" overload;F;40;;ž;50;)I"(set_encoding(ext_enc, int_enc, opt);T;IC;";T; @¡ô;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"IO;T; @¡ô;[;I"@return [IO];T;0;6i;[[I"ext_enc;T0[I"int_enc;T0[I"opt;T0; @¡ô;[;I"OIf single argument is specified, read string from io is tagged with the encoding specified. If encoding is a colon separated two encoding names "A:B", the read string is converted from encoding A (external encoding) to encoding B (internal encoding), then tagged with B. If two arguments are specified, those must be encoding objects or encoding names, and the first one is the external encoding, and the second one is the internal encoding. If the external encoding and the internal encoding is specified, optional hash argument specify the conversion option. @overload set_encoding(ext_enc) @return [IO] @overload set_encoding("ext_enc:int_enc") @return [IO] @overload set_encoding(ext_enc, int_enc) @return [IO] @overload set_encoding("ext_enc:int_enc", opt) @return [IO] @overload set_encoding(ext_enc, int_enc, opt) @return [IO];T;0; @¡ô;!F;"o;#;$T;%i¾.;&iÒ.;'@bè;(I"cstatic VALUE rb_io_set_encoding(int argc, VALUE *argv, VALUE io) { rb_io_t *fptr; VALUE v1, v2, opt; if (!RB_TYPE_P(io, T_FILE)) { return rb_funcallv(io, id_set_encoding, argc, argv); } argc = rb_scan_args(argc, argv, "11:", &v1, &v2, &opt); GetOpenFile(io, fptr); io_encoding_set(fptr, v1, v2, opt); return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#set_encoding_by_bom;F;[;[[@iM!;T;:set_encoding_by_bom;0;[;{;IC;"ÎChecks if +ios+ starts with a BOM, and then consumes it and sets the external encoding. Returns the result encoding if found, or nil. If +ios+ is not binmode or its encoding has been set already, an exception will be raised. File.write("bom.txt", "\u{FEFF}abc") ios = File.open("bom.txt", "rb") ios.set_encoding_by_bom #=> # File.write("nobom.txt", "abc") ios = File.open("nobom.txt", "rb") ios.set_encoding_by_bom #=> nil ;T;[o;= ;3I" overload;F;40;;Ÿ;50;)I"set_encoding_by_bom;T;IC;";T; @õ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Encoding;TI"nil;T; @õ;[;I"@return [Encoding, nil];T;0;6i;[; @õ;[;I"Checks if +ios+ starts with a BOM, and then consumes it and sets the external encoding. Returns the result encoding if found, or nil. If +ios+ is not binmode or its encoding has been set already, an exception will be raised. File.write("bom.txt", "\u{FEFF}abc") ios = File.open("bom.txt", "rb") ios.set_encoding_by_bom #=> # File.write("nobom.txt", "abc") ios = File.open("nobom.txt", "rb") ios.set_encoding_by_bom #=> nil @overload set_encoding_by_bom @return [Encoding, nil];T;0; @õ;!F;"o;#;$T;%i;!;&iJ!;'@bè;(I"bstatic VALUE rb_io_set_encoding_by_bom(VALUE io) { rb_io_t *fptr; GetOpenFile(io, fptr); if (!(fptr->mode & FMODE_BINMODE)) { rb_raise(rb_eArgError, "ASCII incompatible encoding needs binmode"); } if (fptr->encs.enc2) { rb_raise(rb_eArgError, "encoding conversion is set"); } else if (fptr->encs.enc && fptr->encs.enc != rb_ascii8bit_encoding()) { rb_raise(rb_eArgError, "encoding is set to %s already", rb_enc_name(fptr->encs.enc)); } if (!io_set_encoding_by_bom(io)) return Qnil; return rb_enc_from_encoding(fptr->encs.enc); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#autoclose?;F;[;[[@i³!;T;:autoclose?;0;[;{;IC;"~Returns +true+ if the underlying file descriptor of _ios_ will be closed automatically at its finalization, otherwise +false+.;T;[o;= ;3I" overload;F;40;; ;50;)I"autoclose?;T;IC;";T; @!õ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @!õ;[;I"@return [Boolean];T;0;6i;[; @!õ;[;I"©Returns +true+ if the underlying file descriptor of _ios_ will be closed automatically at its finalization, otherwise +false+. @overload autoclose? @return [Boolean];T;0; @!õ;!F;"o;#;$T;%i«!;&i°!;6i;'@bè;(I"¦static VALUE rb_io_autoclose_p(VALUE io) { rb_io_t *fptr = RFILE(io)->fptr; rb_io_check_closed(fptr); return (fptr->mode & FMODE_PREP) ? Qfalse : Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#autoclose=;F;[[I"autoclose;T0;[[@iÌ!;T;:autoclose=;0;[;{;IC;"ãSets auto-close flag. f = open("/dev/null") IO.for_fd(f.fileno) # ... f.gets # may cause Errno::EBADF f = open("/dev/null") IO.for_fd(f.fileno).autoclose = false # ... f.gets # won't cause Errno::EBADF ;T;[o;= ;3I" overload;F;40;;¡;50;)I"autoclose=(bool);T;IC;";T; @<õ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @<õ;[;I"@return [Boolean];T;0;6i;[[I" bool;T0; @<õ;[;I"Sets auto-close flag. f = open("/dev/null") IO.for_fd(f.fileno) # ... f.gets # may cause Errno::EBADF f = open("/dev/null") IO.for_fd(f.fileno).autoclose = false # ... f.gets # won't cause Errno::EBADF @overload autoclose=(bool) @return [Boolean];T;0; @<õ;!F;"o;#;$T;%i»!;&iÉ!;'@bè;(I"Þstatic VALUE rb_io_set_autoclose(VALUE io, VALUE autoclose) { rb_io_t *fptr; GetOpenFile(io, fptr); if (!RTEST(autoclose)) fptr->mode |= FMODE_PREP; else fptr->mode &= ~FMODE_PREP; return autoclose; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#pathconf;F;[[I"arg;T0;[[I"ext/etc/etc.c;Ti¢;T;: pathconf;0;[;{;IC;"YReturns pathname configuration variable using fpathconf(). _name_ should be a constant under Etc which begins with PC_. The return value is an integer or nil. nil means indefinite limit. (fpathconf() returns -1 but errno is not set.) require 'etc' IO.pipe {|r, w| p w.pathconf(Etc::PC_PIPE_BUF) #=> 4096 } ;T;[;[;I"[Returns pathname configuration variable using fpathconf(). _name_ should be a constant under Etc which begins with PC_. The return value is an integer or nil. nil means indefinite limit. (fpathconf() returns -1 but errno is not set.) require 'etc' IO.pipe {|r, w| p w.pathconf(Etc::PC_PIPE_BUF) #=> 4096 } ;T;0; @[õ;!F;"o;#;$T;%i”;&i ;'@bè;(I"bstatic VALUE io_pathconf(VALUE io, VALUE arg) { int name; long ret; rb_io_t *fptr; name = NUM2INT(arg); GetOpenFile(io, fptr); errno = 0; ret = fpathconf(fptr->fd, name); if (ret == -1) { if (errno == 0) /* no limit */ return Qnil; rb_sys_fail("fpathconf"); } return LONG2NUM(ret); };T;)I"static VALUE;T;*To;;F; ;F;;;I"IO.thread_fd_close;F;[[I"fd;T0;[[I"1ext/-test-/thread_fd_close/thread_fd_close.c;Ti;T;:thread_fd_close;0;[;{;IC;";T;[;[;@|;0; @lõ;'@bè;(I"pstatic VALUE thread_fd_close(VALUE ign, VALUE fd) { rb_thread_fd_close(NUM2INT(fd)); return Qnil; };T;)I"static VALUE;T;*To;;F; ;F;;;I"IO.wait_for_single_fd;F;[[I"fd;T0[I"events;T0[I"timeout;T0;[[@ûi ;T;:wait_for_single_fd;0;[;{;IC;";T;[;[;@|;0; @{õ;'@bè;(I"{static VALUE wait_for_single_fd(VALUE ign, VALUE fd, VALUE events, VALUE timeout) { struct timeval tv; struct timeval *tvp = NULL; int rc; if (!NIL_P(timeout)) { tv = rb_time_timeval(timeout); tvp = &tv; } rc = rb_wait_for_single_fd(NUM2INT(fd), NUM2INT(events), tvp); if (rc == -1) rb_sys_fail("rb_wait_for_single_fd"); return INT2NUM(rc); };T;)I"static VALUE;T;*To;;F; ;F;;;I"IO.kqueue_test_wait;F;[;[[@ûi ;T;:kqueue_test_wait;0;[;{;IC;";T;[;[;@|;0; @õ;'@bè;(I"ªstatic VALUE kqueue_test_wait(VALUE klass) { int kqfd = -1; int p[2] = { -1, -1 }; struct timeval tv = { 0, 0 }; const struct timespec ts = { 1, 0 }; struct kevent kev; const char *msg; VALUE ret = Qfalse; int e = 0; int n; msg = "pipe"; if (rb_cloexec_pipe(p) < 0) goto err; msg = "kqueue"; kqfd = kqueue(); if (kqfd < 0) goto err; n = rb_wait_for_single_fd(kqfd, RB_WAITFD_IN, &tv); if (n != 0) { msg = "spurious wakeup"; errno = 0; goto err; } msg = "write"; if (write(p[1], "", 1) < 0) goto err; EV_SET(&kev, p[0], EVFILT_READ, EV_ADD, 0, 0, 0); msg = "kevent"; n = kevent(kqfd, &kev, 1, &kev, 1, &ts); if (n < 0) goto err; msg = NULL; if (n == 1) { n = rb_wait_for_single_fd(kqfd, RB_WAITFD_IN, &tv); ret = INT2NUM(n); } else { rb_warn("kevent did not return readiness"); } err: if (msg) e = errno; if (p[0] >= 0) close(p[0]); if (p[1] >= 0) close(p[1]); if (kqfd >= 0) close(kqfd); if (msg) { if (e) rb_syserr_fail(e, msg); rb_raise(rb_eRuntimeError, "%s", msg); } return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#console_info;F;[;[[I")ext/-test-/win32/console/attribute.c;Ti;T;:console_info;0;[;{;IC;";T;[;[;@|;0; @™õ;'@bè;(I"¶static VALUE console_info(VALUE io) { HANDLE h = io_handle(io); CONSOLE_SCREEN_BUFFER_INFO csbi; if (!GetConsoleScreenBufferInfo(h, &csbi)) rb_syserr_fail(rb_w32_map_errno(GetLastError()), "not console"); return rb_struct_new(rb_cConsoleScreenBufferInfo, INT2FIX(csbi.dwSize.X), INT2FIX(csbi.dwSize.Y), INT2FIX(csbi.dwCursorPosition.X), INT2FIX(csbi.dwCursorPosition.Y), INT2FIX(csbi.wAttributes)); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#console_attribute;F;[[I" attr;T0;[[@žõi$;T;:console_attribute;0;[;{;IC;";T;[;[;@|;0; @¦õ;'@bè;(I"¡static VALUE console_set_attribute(VALUE io, VALUE attr) { HANDLE h = io_handle(io); SetConsoleTextAttribute(h, (WORD)NUM2INT(attr)); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#raw;F;[[@c0;[[I"ext/io/console/console.c;Ti†;T;:raw;0;[;{;IC;"ZYields +self+ within raw mode, and returns the result of the block. STDIN.raw(&:gets) will read and return a line without echo back and line editing. The parameter +min+ specifies the minimum number of bytes that should be received when a read operation is performed. (default: 1) The parameter +time+ specifies the timeout in _seconds_ with a precision of 1/10 of a second. (default: 0) If the parameter +intr+ is +true+, enables break, interrupt, quit, and suspend special characters. Refer to the manual page of termios for further details. You must require 'io/console' to use this method. ;T;[o;= ;3I" overload;F;40;;¨;50;)I"(raw(min: nil, time: nil, intr: nil);T;IC;";T; @´õ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"io;T; @´õ;[;I"@yield [io];T;0;6i;[[I" min:;TI"nil;T[I" time:;TI"nil;T[I" intr:;TI"nil;T; @´õ;[;I"˜Yields +self+ within raw mode, and returns the result of the block. STDIN.raw(&:gets) will read and return a line without echo back and line editing. The parameter +min+ specifies the minimum number of bytes that should be received when a read operation is performed. (default: 1) The parameter +time+ specifies the timeout in _seconds_ with a precision of 1/10 of a second. (default: 0) If the parameter +intr+ is +true+, enables break, interrupt, quit, and suspend special characters. Refer to the manual page of termios for further details. You must require 'io/console' to use this method. @overload raw(min: nil, time: nil, intr: nil) @yield [io];T;0; @´õ;!F;"o;#;$T;%io;&i„;'@bè;(I"½static VALUE console_raw(int argc, VALUE *argv, VALUE io) { rawmode_arg_t opts, *optp = rawmode_opt(&argc, argv, 0, 0, &opts); return ttymode(io, rb_yield, io, set_rawmode, optp); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#raw!;F;[[@c0;[[@ºõi™;T;: raw!;0;[;{;IC;"ÊEnables raw mode, and returns +io+. If the terminal mode needs to be back, use io.raw { ... }. See IO#raw for details on the parameters. You must require 'io/console' to use this method. ;T;[o;= ;3I" overload;F;40;;©;50;)I")raw!(min: nil, time: nil, intr: nil);T;IC;";T; @Úõ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"IO;T; @Úõ;[;I"@return [IO];T;0;6i;[[I" min:;TI"nil;T[I" time:;TI"nil;T[I" intr:;TI"nil;T; @Úõ;[;I" Enables raw mode, and returns +io+. If the terminal mode needs to be back, use io.raw { ... }. See IO#raw for details on the parameters. You must require 'io/console' to use this method. @overload raw!(min: nil, time: nil, intr: nil) @return [IO];T;0; @Úõ;!F;"o;#;$T;%i;&i—;'@bè;(I"tstatic VALUE console_set_raw(int argc, VALUE *argv, VALUE io) { conmode t; rb_io_t *fptr; int fd; rawmode_arg_t opts, *optp = rawmode_opt(&argc, argv, 0, 0, &opts); GetOpenFile(io, fptr); fd = GetReadFD(fptr); if (!getattr(fd, &t)) sys_fail_fptr(fptr); set_rawmode(&t, optp); if (!setattr(fd, &t)) sys_fail_fptr(fptr); return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#cooked;F;[;[[@ºõiµ;T;:cooked;0;[;{;IC;"ªYields +self+ within cooked mode. STDIN.cooked(&:gets) will read and return a line with echo back and line editing. You must require 'io/console' to use this method. ;T;[o;= ;3I" overload;F;40;;ª;50;)I"cooked;T;IC;";T; @ÿõ;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"io;T; @ÿõ;[;I"@yield [io];T;0;6i;[; @ÿõ;[;I"ËYields +self+ within cooked mode. STDIN.cooked(&:gets) will read and return a line with echo back and line editing. You must require 'io/console' to use this method. @overload cooked @yield [io];T;0; @ÿõ;!F;"o;#;$T;%i©;&i³;'@bè;(I"jstatic VALUE console_cooked(VALUE io) { return ttymode(io, rb_yield, io, set_cookedmode, NULL); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#cooked!;F;[;[[@ºõiÅ;T;:cooked!;0;[;{;IC;"†Enables cooked mode. If the terminal mode needs to be back, use io.cooked { ... }. You must require 'io/console' to use this method. ;T;[o;= ;3I" overload;F;40;;«;50;)I"cooked!;T;IC;";T; @ö;>0;!F;[;[;I";T;0;6i;[; @ö;[;I"šEnables cooked mode. If the terminal mode needs to be back, use io.cooked { ... }. You must require 'io/console' to use this method. @overload cooked!;T;0; @ö;!F;"o;#;$T;%i»;&iÂ;'@bè;(I"static VALUE console_set_cooked(VALUE io) { conmode t; rb_io_t *fptr; int fd; GetOpenFile(io, fptr); fd = GetReadFD(fptr); if (!getattr(fd, &t)) sys_fail_fptr(fptr); set_cookedmode(&t, NULL); if (!setattr(fd, &t)) sys_fail_fptr(fptr); return io; };T;)I"static VALUE;T;*To;;F; ;;;;I" IO#getch;F;[[@c0;[[@ºõiû;T;: getch;0;[;{;IC;"ˆReads and returns a character in raw mode. See IO#raw for details on the parameters. You must require 'io/console' to use this method. ;T;[o;= ;3I" overload;F;40;;¬;50;)I"*getch(min: nil, time: nil, intr: nil);T;IC;";T; @0ö;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @0ö;[;I"@return [String];T;0;6i;[[I" min:;TI"nil;T[I" time:;TI"nil;T[I" intr:;TI"nil;T; @0ö;[;I"ÍReads and returns a character in raw mode. See IO#raw for details on the parameters. You must require 'io/console' to use this method. @overload getch(min: nil, time: nil, intr: nil) @return [String];T;0; @0ö;!F;"o;#;$T;%iñ;&iù;'@bè;(I"0static VALUE console_getch(int argc, VALUE *argv, VALUE io) { rawmode_arg_t opts, *optp = rawmode_opt(&argc, argv, 0, 0, &opts); #ifndef _WIN32 return ttymode(io, getc_call, io, set_rawmode, optp); #else rb_io_t *fptr; VALUE str; wint_t c; int len; char buf[8]; wint_t wbuf[2]; # ifndef HAVE_RB_IO_WAIT struct timeval *to = NULL, tv; # else VALUE timeout = Qnil; # endif GetOpenFile(io, fptr); if (optp) { if (optp->vtime) { # ifndef HAVE_RB_IO_WAIT to = &tv; # else struct timeval tv; # endif tv.tv_sec = optp->vtime / 10; tv.tv_usec = (optp->vtime % 10) * 100000; # ifdef HAVE_RB_IO_WAIT timeout = rb_scheduler_timeout(&tv); # endif } switch (optp->vmin) { case 1: /* default */ break; case 0: /* return nil when timed out */ if (optp->vtime) break; /* fallthru */ default: rb_warning("min option larger than 1 ignored"); } if (optp->intr) { # ifndef HAVE_RB_IO_WAIT int w = rb_wait_for_single_fd(fptr->fd, RB_WAITFD_IN, to); if (w < 0) rb_eof_error(); if (!(w & RB_WAITFD_IN)) return Qnil; # else VALUE result = rb_io_wait(io, RUBY_IO_READABLE, timeout); if (result == Qfalse) return Qnil; # endif } else if (optp->vtime) { rb_warning("Non-zero vtime option ignored if intr flag is unset"); } } len = (int)(VALUE)rb_thread_call_without_gvl(nogvl_getch, wbuf, RUBY_UBF_IO, 0); switch (len) { case 0: return Qnil; case 2: buf[0] = (char)wbuf[0]; c = wbuf[1]; len = 1; do { buf[len++] = (unsigned char)c; } while ((c >>= CHAR_BIT) && len < (int)sizeof(buf)); return rb_str_new(buf, len); default: c = wbuf[0]; len = rb_uv_to_utf8(buf, c); str = rb_utf8_str_new(buf, len); return rb_str_conv_enc(str, NULL, rb_default_external_encoding()); } #endif };T;)I"static VALUE;T;*To;;F; ;;;;I" IO#echo=;F;[[I"f;T0;[[@ºõid;T;: echo=;0;[;{;IC;"¦Enables/disables echo back. On some platforms, all combinations of this flags and raw/cooked mode may not be valid. You must require 'io/console' to use this method. ;T;[o;= ;3I" overload;F;40;;;50;)I"echo=(flag);T;IC;";T; @Uö;>0;!F;[;[;I";T;0;6i;[[I" flag;T0; @Uö;[;I"¾Enables/disables echo back. On some platforms, all combinations of this flags and raw/cooked mode may not be valid. You must require 'io/console' to use this method. @overload echo=(flag);T;0; @Uö;!F;"o;#;$T;%iZ;&ia;'@bè;(I"Lstatic VALUE console_set_echo(VALUE io, VALUE f) { conmode t; rb_io_t *fptr; int fd; GetOpenFile(io, fptr); fd = GetReadFD(fptr); if (!getattr(fd, &t)) sys_fail_fptr(fptr); if (RTEST(f)) set_echo(&t, NULL); else set_noecho(&t, NULL); if (!setattr(fd, &t)) sys_fail_fptr(fptr); return io; };T;)I"static VALUE;T;*To;;F; ;;;;I" IO#echo?;F;[;[[@ºõi~;T;: echo?;0;[;{;IC;"_Returns +true+ if echo back is enabled. You must require 'io/console' to use this method.;T;[o;= ;3I" overload;F;40;;®;50;)I" echo?;T;IC;";T; @oö;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @oö;[;I"@return [Boolean];T;0;6i;[; @oö;[;I"€Returns +true+ if echo back is enabled. You must require 'io/console' to use this method. @overload echo? @return [Boolean];T;0; @oö;!F;"o;#;$T;%iv;&i|;6i;'@bè;(I"ästatic VALUE console_echo_p(VALUE io) { conmode t; rb_io_t *fptr; int fd; GetOpenFile(io, fptr); fd = GetReadFD(fptr); if (!getattr(fd, &t)) sys_fail_fptr(fptr); return echo_p(&t) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#console_mode;F;[;[[@ºõiÒ;T;:console_mode;0;[;{;IC;"kReturns a data represents the current console mode. You must require 'io/console' to use this method. ;T;[o;= ;3I" overload;F;40;;¯;50;)I"console_mode;T;IC;";T; @Šö;>0;!F;[;[;I";T;0;6i;[; @Šö;[;I"Returns a data represents the current console mode. You must require 'io/console' to use this method. @overload console_mode;T;0; @Šö;!F;"o;#;$T;%iÊ;&iÏ;'@bè;(I"èstatic VALUE console_conmode_get(VALUE io) { conmode t; rb_io_t *fptr; int fd; GetOpenFile(io, fptr); fd = GetReadFD(fptr); if (!getattr(fd, &t)) sys_fail_fptr(fptr); return conmode_new(cConmode, &t); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#console_mode=;F;[[I" mode;T0;[[@ºõiè;T;:console_mode=;0;[;{;IC;"XSets the console mode to +mode+. You must require 'io/console' to use this method. ;T;[o;= ;3I" overload;F;40;;°;50;)I"console_mode=(mode);T;IC;";T; @ ö;>0;!F;[;[;I";T;0;6i;[[I" mode;T0; @ ö;[;I"xSets the console mode to +mode+. You must require 'io/console' to use this method. @overload console_mode=(mode);T;0; @ ö;!F;"o;#;$T;%ià;&iå;'@bè;(I"*static VALUE console_conmode_set(VALUE io, VALUE mode) { conmode *t, r; rb_io_t *fptr; int fd; TypedData_Get_Struct(mode, conmode, &conmode_type, t); r = *t; GetOpenFile(io, fptr); fd = GetReadFD(fptr); if (!setattr(fd, &r)) sys_fail_fptr(fptr); return mode; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#noecho;F;[;[[@ºõiT;T;:noecho;0;[;{;IC;"¢Yields +self+ with disabling echo back. STDIN.noecho(&:gets) will read and return a line without echo back. You must require 'io/console' to use this method. ;T;[o;= ;3I" overload;F;40;;±;50;)I"noecho;T;IC;";T; @ºö;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"io;T; @ºö;[;I"@yield [io];T;0;6i;[; @ºö;[;I"ÃYields +self+ with disabling echo back. STDIN.noecho(&:gets) will read and return a line without echo back. You must require 'io/console' to use this method. @overload noecho @yield [io];T;0; @ºö;!F;"o;#;$T;%iH;&iR;'@bè;(I"fstatic VALUE console_noecho(VALUE io) { return ttymode(io, rb_yield, io, set_noecho, NULL); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#winsize;F;[;[[@ºõi;T;:winsize;0;[;{;IC;"MReturns console size. You must require 'io/console' to use this method. ;T;[o;= ;3I" overload;F;40;;²;50;)I"winsize;T;IC;";T; @Õö;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @Õö;[;I"@return [Array];T;0;6i;[; @Õö;[;I"sReturns console size. You must require 'io/console' to use this method. @overload winsize @return [Array];T;0; @Õö;!F;"o;#;$T;%i;&i;'@bè;(I"static VALUE console_winsize(VALUE io) { rb_io_t *fptr; int fd; rb_console_size_t ws; GetOpenFile(io, fptr); fd = GetWriteFD(fptr); if (!getwinsize(fd, &ws)) sys_fail_fptr(fptr); return rb_assoc_new(INT2NUM(winsize_row(&ws)), INT2NUM(winsize_col(&ws))); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#winsize=;F;[[I" size;T0;[[@ºõi*;T;: winsize=;0;[;{;IC;"ŽTries to set console size. The effect depends on the platform and the running environment. You must require 'io/console' to use this method. ;T;[;[;I"‘ Tries to set console size. The effect depends on the platform and the running environment. You must require 'io/console' to use this method. ;T;0; @ðö;!F;"o;#;$T;%i!;&i';'@bè;(I"Çstatic VALUE console_set_winsize(VALUE io, VALUE size) { rb_io_t *fptr; rb_console_size_t ws; #if defined _WIN32 HANDLE wh; int newrow, newcol; BOOL ret; #endif VALUE row, col, xpixel, ypixel; const VALUE *sz; int fd; long sizelen; GetOpenFile(io, fptr); size = rb_Array(size); if ((sizelen = RARRAY_LEN(size)) != 2 && sizelen != 4) { rb_raise(rb_eArgError, "wrong number of arguments (given %ld, expected 2 or 4)", sizelen); } sz = RARRAY_CONST_PTR(size); row = sz[0], col = sz[1], xpixel = ypixel = Qnil; if (sizelen == 4) xpixel = sz[2], ypixel = sz[3]; fd = GetWriteFD(fptr); #if defined TIOCSWINSZ ws.ws_row = ws.ws_col = ws.ws_xpixel = ws.ws_ypixel = 0; #define SET(m) ws.ws_##m = NIL_P(m) ? 0 : (unsigned short)NUM2UINT(m) SET(row); SET(col); SET(xpixel); SET(ypixel); #undef SET if (!setwinsize(fd, &ws)) sys_fail_fptr(fptr); #elif defined _WIN32 wh = (HANDLE)rb_w32_get_osfhandle(fd); #define SET(m) new##m = NIL_P(m) ? 0 : (unsigned short)NUM2UINT(m) SET(row); SET(col); #undef SET if (!NIL_P(xpixel)) (void)NUM2UINT(xpixel); if (!NIL_P(ypixel)) (void)NUM2UINT(ypixel); if (!GetConsoleScreenBufferInfo(wh, &ws)) { rb_syserr_fail(LAST_ERROR, "GetConsoleScreenBufferInfo"); } ws.dwSize.X = newcol; ret = SetConsoleScreenBufferSize(wh, ws.dwSize); ws.srWindow.Left = 0; ws.srWindow.Top = 0; ws.srWindow.Right = newcol-1; ws.srWindow.Bottom = newrow-1; if (!SetConsoleWindowInfo(wh, TRUE, &ws.srWindow)) { rb_syserr_fail(LAST_ERROR, "SetConsoleWindowInfo"); } /* retry when shrinking buffer after shrunk window */ if (!ret && !SetConsoleScreenBufferSize(wh, ws.dwSize)) { rb_syserr_fail(LAST_ERROR, "SetConsoleScreenBufferInfo"); } /* remove scrollbar if possible */ if (!SetConsoleWindowInfo(wh, TRUE, &ws.srWindow)) { rb_syserr_fail(LAST_ERROR, "SetConsoleWindowInfo"); } #endif return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#iflush;F;[;[[@ºõiŽ;T;:iflush;0;[;{;IC;"WFlushes input buffer in kernel. You must require 'io/console' to use this method. ;T;[o;= ;3I" overload;F;40;;´;50;)I"iflush;T;IC;";T; @÷;>0;!F;[;[;I";T;0;6i;[; @÷;[;I"jFlushes input buffer in kernel. You must require 'io/console' to use this method. @overload iflush;T;0; @÷;!F;"o;#;$T;%i†;&i‹;'@bè;(I" static VALUE console_iflush(VALUE io) { rb_io_t *fptr; int fd; GetOpenFile(io, fptr); fd = GetReadFD(fptr); #if defined HAVE_TERMIOS_H || defined HAVE_TERMIO_H if (tcflush(fd, TCIFLUSH)) sys_fail_fptr(fptr); #endif (void)fd; return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#oflush;F;[;[[@ºõi¥;T;:oflush;0;[;{;IC;"XFlushes output buffer in kernel. You must require 'io/console' to use this method. ;T;[o;= ;3I" overload;F;40;;µ;50;)I"oflush;T;IC;";T; @÷;>0;!F;[;[;I";T;0;6i;[; @÷;[;I"kFlushes output buffer in kernel. You must require 'io/console' to use this method. @overload oflush;T;0; @÷;!F;"o;#;$T;%i;&i¢;'@bè;(I"static VALUE console_oflush(VALUE io) { rb_io_t *fptr; int fd; GetOpenFile(io, fptr); fd = GetWriteFD(fptr); #if defined HAVE_TERMIOS_H || defined HAVE_TERMIO_H if (tcflush(fd, TCOFLUSH)) sys_fail_fptr(fptr); #endif (void)fd; return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#ioflush;F;[;[[@ºõi¼;T;:ioflush;0;[;{;IC;"cFlushes input and output buffers in kernel. You must require 'io/console' to use this method. ;T;[o;= ;3I" overload;F;40;;¶;50;)I"ioflush;T;IC;";T; @,÷;>0;!F;[;[;I";T;0;6i;[; @,÷;[;I"wFlushes input and output buffers in kernel. You must require 'io/console' to use this method. @overload ioflush;T;0; @,÷;!F;"o;#;$T;%i´;&i¹;'@bè;(I"østatic VALUE console_ioflush(VALUE io) { rb_io_t *fptr; #if defined HAVE_TERMIOS_H || defined HAVE_TERMIO_H int fd1, fd2; #endif GetOpenFile(io, fptr); #if defined HAVE_TERMIOS_H || defined HAVE_TERMIO_H fd1 = GetReadFD(fptr); fd2 = GetWriteFD(fptr); if (fd2 != -1 && fd1 != fd2) { if (tcflush(fd1, TCIFLUSH)) sys_fail_fptr(fptr); if (tcflush(fd2, TCOFLUSH)) sys_fail_fptr(fptr); } else { if (tcflush(fd1, TCIOFLUSH)) sys_fail_fptr(fptr); } #endif return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#beep;F;[;[[@ºõiÓ;T;: beep;0;[;{;IC;";T;[;[;@|;0; @B÷;'@bè;(I"ÿstatic VALUE console_beep(VALUE io) { rb_io_t *fptr; int fd; GetOpenFile(io, fptr); fd = GetWriteFD(fptr); #ifdef _WIN32 (void)fd; MessageBeep(0); #else if (write(fd, "\a", 1) < 0) sys_fail_fptr(fptr); #endif return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#goto;F;[[I"y;T0[I"x;T0;[[@ºõi);T;: goto;0;[;{;IC;";T;[;[;@|;0; @N÷;'@bè;(I"–static VALUE console_goto(VALUE io, VALUE y, VALUE x) { rb_io_write(io, rb_sprintf("\x1b[%d;%dH", NUM2UINT(y)+1, NUM2UINT(x)+1)); return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#cursor;F;[;[[@ºõi;T;:cursor;0;[;{;IC;";T;[;[;@|;0; @^÷;'@bè;(I"°static VALUE console_cursor_pos(VALUE io) { static const struct query_args query = {"\033[6n", 0}; VALUE resp = console_vt_response(0, 0, io, &query); VALUE row, column, term; unsigned int r, c; if (!RB_TYPE_P(resp, T_ARRAY) || RARRAY_LEN(resp) != 3) return Qnil; term = RARRAY_AREF(resp, 2); if (!RB_TYPE_P(term, T_STRING) || RSTRING_LEN(term) != 1) return Qnil; if (RSTRING_PTR(term)[0] != 'R') return Qnil; row = RARRAY_AREF(resp, 0); column = RARRAY_AREF(resp, 1); rb_ary_resize(resp, 2); r = NUM2UINT(row) - 1; c = NUM2UINT(column) - 1; RARRAY_ASET(resp, 0, INT2NUM(r)); RARRAY_ASET(resp, 1, INT2NUM(c)); return resp; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#cursor=;F;[[I" cpos;T0;[[@ºõia;T;:cursor=;0;[;{;IC;";T;[;[;@|;0; @j÷;'@bè;(I"static VALUE console_cursor_set(VALUE io, VALUE cpos) { cpos = rb_convert_type(cpos, T_ARRAY, "Array", "to_ary"); if (RARRAY_LEN(cpos) != 2) rb_raise(rb_eArgError, "expected 2D coordinate"); return console_goto(io, RARRAY_AREF(cpos, 0), RARRAY_AREF(cpos, 1)); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#cursor_up;F;[[I"val;T0;[[@ºõii;T;:cursor_up;0;[;{;IC;";T;[;[;@|;0; @x÷;'@bè;(I"kstatic VALUE console_cursor_up(VALUE io, VALUE val) { return console_move(io, -NUM2INT(val), 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#cursor_down;F;[[I"val;T0;[[@ºõio;T;:cursor_down;0;[;{;IC;";T;[;[;@|;0; @†÷;'@bè;(I"mstatic VALUE console_cursor_down(VALUE io, VALUE val) { return console_move(io, +NUM2INT(val), 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#cursor_left;F;[[I"val;T0;[[@ºõiu;T;:cursor_left;0;[;{;IC;";T;[;[;@|;0; @”÷;'@bè;(I"mstatic VALUE console_cursor_left(VALUE io, VALUE val) { return console_move(io, 0, -NUM2INT(val)); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#cursor_right;F;[[I"val;T0;[[@ºõi{;T;:cursor_right;0;[;{;IC;";T;[;[;@|;0; @¢÷;'@bè;(I"nstatic VALUE console_cursor_right(VALUE io, VALUE val) { return console_move(io, 0, +NUM2INT(val)); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#goto_column;F;[[I"val;T0;[[@ºõi=;T;:goto_column;0;[;{;IC;";T;[;[;@|;0; @°÷;'@bè;(I"†static VALUE console_goto_column(VALUE io, VALUE val) { rb_io_write(io, rb_sprintf("\x1b[%dG", NUM2UINT(val)+1)); return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#erase_line;F;[[I"val;T0;[[@ºõiD;T;:erase_line;0;[;{;IC;";T;[;[;@|;0; @¾÷;'@bè;(I"®static VALUE console_erase_line(VALUE io, VALUE val) { int mode = mode_in_range(val, 2, "line erase"); rb_io_write(io, rb_sprintf("\x1b[%dK", mode)); return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#erase_screen;F;[[I"val;T0;[[@ºõiL;T;:erase_screen;0;[;{;IC;";T;[;[;@|;0; @Ì÷;'@bè;(I"²static VALUE console_erase_screen(VALUE io, VALUE val) { int mode = mode_in_range(val, 3, "screen erase"); rb_io_write(io, rb_sprintf("\x1b[%dJ", mode)); return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#scroll_forward;F;[[I"val;T0;[[@ºõi;T;:scroll_forward;0;[;{;IC;";T;[;[;@|;0; @Ú÷;'@bè;(I"ostatic VALUE console_scroll_forward(VALUE io, VALUE val) { return console_scroll(io, +NUM2INT(val)); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#scroll_backward;F;[[I"val;T0;[[@ºõi‡;T;:scroll_backward;0;[;{;IC;";T;[;[;@|;0; @è÷;'@bè;(I"pstatic VALUE console_scroll_backward(VALUE io, VALUE val) { return console_scroll(io, -NUM2INT(val)); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#clear_screen;F;[;[[@ºõi;T;:clear_screen;0;[;{;IC;";T;[;[;@|;0; @ö÷;'@bè;(I"–static VALUE console_clear_screen(VALUE io) { console_erase_screen(io, INT2FIX(2)); console_goto(io, INT2FIX(0), INT2FIX(0)); return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#pressed?;F;[[I"k;T0;[[@ºõi¯;T;: pressed?;0;[;{;IC;";T;[o;2 ;3I"return;F;4@|;0;5[@~; @ø;[;@|;0; @ø;6i;'@bè;(I"ûstatic VALUE console_key_pressed_p(VALUE io, VALUE k) { int vk = -1; if (FIXNUM_P(k)) { vk = NUM2UINT(k); } else { const struct vktable *t; const char *kn; if (SYMBOL_P(k)) { k = rb_sym2str(k); kn = RSTRING_PTR(k); } else { kn = StringValuePtr(k); } t = console_win32_vk(kn, RSTRING_LEN(k)); if (!t || (vk = (short)t->vk) == -1) { rb_raise(rb_eArgError, "unknown virtual key code: % "PRIsVALUE, k); } } return GetKeyState(vk) & 0x80 ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#check_winsize_changed;F;[;[[@ºõio;T;:check_winsize_changed;0;[;{;IC;";T;[;[;@|;0; @ø;'@bè;(I" static VALUE console_check_winsize_changed(VALUE io) { rb_io_t *fptr; HANDLE h; DWORD num; GetOpenFile(io, fptr); h = (HANDLE)rb_w32_get_osfhandle(GetReadFD(fptr)); while (GetNumberOfConsoleInputEvents(h, &num) && num > 0) { INPUT_RECORD rec; if (ReadConsoleInput(h, &rec, 1, &num)) { if (rec.EventType == WINDOW_BUFFER_SIZE_EVENT) { rb_yield(Qnil); } } } return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#getpass;F;[[@c0;[[@ºõi/;T;:getpass;0;[;{;IC;"ïReads and returns a line without echo back. Prints +prompt+ unless it is +nil+. The newline character that terminates the read line is removed from the returned string, see String#chomp!. You must require 'io/console' to use this method. ;T;[o;= ;3I" overload;F;40;;Ç;50;)I"getpass(prompt=nil);T;IC;";T; @ø;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ø;[;I"@return [String];T;0;6i;[[I"prompt;TI"nil;T; @ø;[;I""Reads and returns a line without echo back. Prints +prompt+ unless it is +nil+. The newline character that terminates the read line is removed from the returned string, see String#chomp!. You must require 'io/console' to use this method. @overload getpass(prompt=nil) @return [String];T;0; @ø;!F;"o;#;$T;%i";&i-;'@bè;(I"=static VALUE console_getpass(int argc, VALUE *argv, VALUE io) { VALUE str, wio; rb_check_arity(argc, 0, 1); wio = rb_io_get_write_io(io); if (wio == io && io == rb_stdin) wio = rb_stderr; prompt(argc, argv, wio); str = rb_ensure(getpass_call, io, puts_call, wio); return str_chomp(str); };T;)I"static VALUE;T;*To;;F; ;F;;;I"IO.console;F;[[@c0;[[@ºõi¢;T;:console;0;[;{;IC;"ãReturns an File instance opened console. If +sym+ is given, it will be sent to the opened console with +args+ and the result will be returned instead of the console IO itself. You must require 'io/console' to use this method. ;T;[o;= ;3I" overload;F;40;;È;50;)I"console;T;IC;";T; @>ø;>0;!F;[o;2 ;3I"return;F;4I"];T;0;5[I"#ø;[;I"@return [#];T;0;6i;[; @>øo;= ;3I" overload;F;40;;È;50;)I"console(sym, *args);T;IC;";T; @>ø;>0;!F;[;[;I";T;0;6i;[[I"sym;T0[I" *args;T0; @>ø;[;I"2Returns an File instance opened console. If +sym+ is given, it will be sent to the opened console with +args+ and the result will be returned instead of the console IO itself. You must require 'io/console' to use this method. @overload console @return [#] @overload console(sym, *args);T;0; @>ø;!F;"o;#;$T;%i•;&i ;'@bè;(I"5static VALUE console_dev(int argc, VALUE *argv, VALUE klass) { VALUE con = 0; rb_io_t *fptr; VALUE sym = 0; rb_check_arity(argc, 0, UNLIMITED_ARGUMENTS); if (argc) { Check_Type(sym = argv[0], T_SYMBOL); } if (klass == rb_cIO) klass = rb_cFile; if (rb_const_defined(klass, id_console)) { con = rb_const_get(klass, id_console); if (!RB_TYPE_P(con, T_FILE) || (!(fptr = RFILE(con)->fptr) || GetReadFD(fptr) == -1)) { rb_const_remove(klass, id_console); con = 0; } } if (sym) { if (sym == ID2SYM(id_close) && argc == 1) { if (con) { rb_io_close(con); rb_const_remove(klass, id_console); con = 0; } return Qnil; } } if (!con) { VALUE args[2]; #if defined HAVE_TERMIOS_H || defined HAVE_TERMIO_H || defined HAVE_SGTTY_H # define CONSOLE_DEVICE "/dev/tty" #elif defined _WIN32 # define CONSOLE_DEVICE "con$" # define CONSOLE_DEVICE_FOR_READING "conin$" # define CONSOLE_DEVICE_FOR_WRITING "conout$" #endif #ifndef CONSOLE_DEVICE_FOR_READING # define CONSOLE_DEVICE_FOR_READING CONSOLE_DEVICE #endif #ifdef CONSOLE_DEVICE_FOR_WRITING VALUE out; rb_io_t *ofptr; #endif int fd; #ifdef CONSOLE_DEVICE_FOR_WRITING fd = rb_cloexec_open(CONSOLE_DEVICE_FOR_WRITING, O_RDWR, 0); if (fd < 0) return Qnil; rb_update_max_fd(fd); args[1] = INT2FIX(O_WRONLY); args[0] = INT2NUM(fd); out = rb_class_new_instance(2, args, klass); #endif fd = rb_cloexec_open(CONSOLE_DEVICE_FOR_READING, O_RDWR, 0); if (fd < 0) { #ifdef CONSOLE_DEVICE_FOR_WRITING rb_io_close(out); #endif return Qnil; } rb_update_max_fd(fd); args[1] = INT2FIX(O_RDWR); args[0] = INT2NUM(fd); con = rb_class_new_instance(2, args, klass); GetOpenFile(con, fptr); fptr->pathv = rb_obj_freeze(rb_str_new2(CONSOLE_DEVICE)); #ifdef CONSOLE_DEVICE_FOR_WRITING GetOpenFile(out, ofptr); ofptr->pathv = fptr->pathv; fptr->tied_io_for_writing = out; ofptr->mode |= FMODE_SYNC; #endif fptr->mode |= FMODE_SYNC; rb_const_set(klass, id_console, con); } if (sym) { return rb_f_send(argc, argv, con); } return con; };T;)I"static VALUE;T;*To; ;IC;[ o;;F; ;;;;I"IO::generic_readable#getch;F;[[@c0;[[@ºõiü;T;;¬;0;[;{;IC;"See IO#getch. ;T;[o;= ;3I" overload;F;40;;¬;50;)I"*getch(min: nil, time: nil, intr: nil);T;IC;";T; @hø;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @hø;[;I"@return [String];T;0;6i;[[I" min:;TI"nil;T[I" time:;TI"nil;T[I" intr:;TI"nil;T; @hø;[;I"WSee IO#getch. @overload getch(min: nil, time: nil, intr: nil) @return [String];T;0; @hø;!F;"o;#;$T;%iö;&iú;'@fø;(I"pstatic VALUE io_getch(int argc, VALUE *argv, VALUE io) { return rb_funcallv(io, id_getc, argc, argv); };T;)I"static VALUE;T;*To;;F; ;;;;I"!IO::generic_readable#getpass;F;[[@c0;[[@ºõiB;T;;Ç;0;[;{;IC;"See IO#getpass. ;T;[o;= ;3I" overload;F;40;;Ç;50;)I"getpass(prompt=nil);T;IC;";T; @ø;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ø;[;I"@return [String];T;0;6i;[[I"prompt;TI"nil;T; @ø;[;I"GSee IO#getpass. @overload getpass(prompt=nil) @return [String];T;0; @ø;!F;"o;#;$T;%i<;&i@;'@fø;(I"àstatic VALUE io_getpass(int argc, VALUE *argv, VALUE io) { VALUE str; rb_check_arity(argc, 0, 1); prompt(argc, argv, io); str = str_chomp(rb_funcallv(io, id_gets, 0, 0)); puts_call(io); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I""IO::generic_readable#readchar;F;[;[[I"ext/stringio/stringio.c;Tiö;T;;;0;[;{;IC;"See IO#readchar. ;T;[o;= ;3I" overload;F;40;;;50;)I" readchar;T;IC;";T; @¬ø;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @¬ø;[;I"@return [String];T;0;6i;[; @¬ø;[;I"=See IO#readchar. @overload readchar @return [String];T;0; @¬ø;!F;"o;#;$T;%ið;&iô;'@fø;(I"•static VALUE strio_readchar(VALUE self) { VALUE c = rb_funcallv(self, rb_intern("getc"), 0, 0); if (NIL_P(c)) rb_eof_error(); return c; };T;)I"static VALUE;T;*To;;F; ;;;;I""IO::generic_readable#readbyte;F;[;[[@±øi;T;;;0;[;{;IC;"See IO#readbyte. ;T;[o;= ;3I" overload;F;40;;;50;)I" readbyte;T;IC;";T; @Èø;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Fixnum;T; @Èø;[;I"@return [Fixnum];T;0;6i;[; @Èø;[;I"=See IO#readbyte. @overload readbyte @return [Fixnum];T;0; @Èø;!F;"o;#;$T;%iþ;&i;'@fø;(I"˜static VALUE strio_readbyte(VALUE self) { VALUE c = rb_funcallv(self, rb_intern("getbyte"), 0, 0); if (NIL_P(c)) rb_eof_error(); return c; };T;)I"static VALUE;T;*To;;F; ;;;;I""IO::generic_readable#readline;F;[[@c0;[[@±øi ;T;;¥;0;[;{;IC;"See IO#readline. ;T;[o;= ;3I" overload;F;40;;¥;50;)I"#readline(sep=$/, chomp: false);T;IC;";T; @ãø;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ãø;[;I"@return [String];T;0;6i;[[I"sep;TI"$/;T[I"chomp:;TI" false;T; @ãøo;= ;3I" overload;F;40;;¥;50;)I""readline(limit, chomp: false);T;IC;";T; @ãø;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @ãø;[;I"@return [String, nil];T;0;6i;[[I" limit;T0[I"chomp:;TI" false;T; @ãøo;= ;3I" overload;F;40;;¥;50;)I"'readline(sep, limit, chomp: false);T;IC;";T; @ãø;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @ãø;[;I"@return [String, nil];T;0;6i;[[I"sep;T0[I" limit;T0[I"chomp:;TI" false;T; @ãø;[;I"ÓSee IO#readline. @overload readline(sep=$/, chomp: false) @return [String] @overload readline(limit, chomp: false) @return [String, nil] @overload readline(sep, limit, chomp: false) @return [String, nil];T;0; @ãø;!F;"o;#;$T;%i;&i ;'@fø;(I"×static VALUE strio_readline(int argc, VALUE *argv, VALUE self) { VALUE line = rb_funcallv_kw(self, rb_intern("gets"), argc, argv, RB_PASS_CALLED_KEYWORDS); if (NIL_P(line)) rb_eof_error(); return line; };T;)I"static VALUE;T;*To;;F; ;;;;I"!IO::generic_readable#sysread;F;[[@c0;[[@±øi;T;;„;0;[;{;IC;"uSimilar to #read, but raises +EOFError+ at end of string instead of returning +nil+, as well as IO#sysread does. ;T;[o;= ;3I" overload;F;40;;„;50;)I"sysread(integer[, outbuf]);T;IC;";T; @-ù;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @-ù;[;I"@return [String];T;0;6i;[[I"integer[, outbuf];T0; @-ùo;= ;3I" overload;F;40;;;50;)I"#readpartial(integer[, outbuf]);T;IC;";T; @-ù;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @-ù;[;I"@return [String];T;0;6i;[[I"integer[, outbuf];T0; @-ù;[;I"æSimilar to #read, but raises +EOFError+ at end of string instead of returning +nil+, as well as IO#sysread does. @overload sysread(integer[, outbuf]) @return [String] @overload readpartial(integer[, outbuf]) @return [String];T;0; @-ù;!F;"o;#;$T;%i;&i;'@fø;(I"Üstatic VALUE strio_sysread(int argc, VALUE *argv, VALUE self) { VALUE val = rb_funcallv_kw(self, rb_intern("read"), argc, argv, RB_PASS_CALLED_KEYWORDS); if (NIL_P(val)) { rb_eof_error(); } return val; };T;)I"static VALUE;T;*To;;F; ;;;;I"%IO::generic_readable#readpartial;F;[[@c0;[[@±øi;T;;;0;[;{;IC;"uSimilar to #read, but raises +EOFError+ at end of string instead of returning +nil+, as well as IO#sysread does. ;T;[o;= ;3I" overload;F;40;;„;50;)I"sysread(integer[, outbuf]);T;IC;";T; @Zù;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Zù;[;I"@return [String];T;0;6i;[[I"integer[, outbuf];T0; @Zùo;= ;3I" overload;F;40;;;50;)I"#readpartial(integer[, outbuf]);T;IC;";T; @Zù;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Zù;[;I"@return [String];T;0;6i;[[I"integer[, outbuf];T0; @Zù;[;@Vù;0; @Zù;!F;"o;#;$T;%i;&i;'@fø;(I"Üstatic VALUE strio_sysread(int argc, VALUE *argv, VALUE self) { VALUE val = rb_funcallv_kw(self, rb_intern("read"), argc, argv, RB_PASS_CALLED_KEYWORDS); if (NIL_P(val)) { rb_eof_error(); } return val; };T;)I"static VALUE;T;*To;;F; ;;;;I"'IO::generic_readable#read_nonblock;F;[[@c0;[[@±øi-;T;:read_nonblock;0;[;{;IC;"pSimilar to #read, but raises +EOFError+ at end of string unless the +exception: false+ option is passed in. ;T;[o;= ;3I" overload;F;40;;É;50;)I".read_nonblock(integer[, outbuf [, opts]]);T;IC;";T; @†ù;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @†ù;[;I"@return [String];T;0;6i;[[I"integer[, outbuf [, opts]];T0; @†ù;[;I"´Similar to #read, but raises +EOFError+ at end of string unless the +exception: false+ option is passed in. @overload read_nonblock(integer[, outbuf [, opts]]) @return [String];T;0; @†ù;!F;"o;#;$T;%i&;&i+;'@fø;(I"›static VALUE strio_read_nonblock(int argc, VALUE *argv, VALUE self) { VALUE opts = Qnil, val; rb_scan_args(argc, argv, "11:", NULL, NULL, &opts); if (!NIL_P(opts)) { argc--; } val = strio_read(argc, argv, self); if (NIL_P(val)) { if (!NIL_P(opts) && rb_hash_lookup2(opts, sym_exception, Qundef) == Qfalse) return Qnil; else rb_eof_error(); } return val; };T;)I"static VALUE;T;*T;A@fø;BIC;[;A@fø;CIC;[;A@fø;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ºõi[@±øi5;F;:generic_readable;;K;;;[;{;IC;";T;[;[;@|;0; @fø;6i;'@bè;I"IO::generic_readable;Fo; ;IC;[ o;;F; ;;;;I"$IO::ConsoleMode#initialize_copy;F;[[I" obj2;T0;[[@ºõi¡;T;;g;0;[;{;IC;";T;[;[;@|;0; @¶ù;'@´ù;(I"Ëstatic VALUE conmode_init_copy(VALUE obj, VALUE obj2) { conmode *t = rb_check_typeddata(obj, &conmode_type); conmode *t2 = rb_check_typeddata(obj2, &conmode_type); *t = *t2; return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO::ConsoleMode#echo=;F;[[I"f;T0;[[@ºõiª;T;;;0;[;{;IC;";T;[;[;@|;0; @Äù;'@´ù;(I"Ãstatic VALUE conmode_set_echo(VALUE obj, VALUE f) { conmode *t = rb_check_typeddata(obj, &conmode_type); if (RTEST(f)) set_echo(t, NULL); else set_noecho(t, NULL); return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO::ConsoleMode#raw!;F;[[@c0;[[@ºõiµ;T;;©;0;[;{;IC;";T;[;[;@|;0; @Òù;'@´ù;(I"ístatic VALUE conmode_set_raw(int argc, VALUE *argv, VALUE obj) { conmode *t = rb_check_typeddata(obj, &conmode_type); rawmode_arg_t opts, *optp = rawmode_opt(&argc, argv, 0, 0, &opts); set_rawmode(t, optp); return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO::ConsoleMode#raw;F;[[@c0;[[@ºõi¿;T;;¨;0;[;{;IC;";T;[;[;@|;0; @ßù;'@´ù;(I"!static VALUE conmode_raw_new(int argc, VALUE *argv, VALUE obj) { conmode *r = rb_check_typeddata(obj, &conmode_type); conmode t = *r; rawmode_arg_t opts, *optp = rawmode_opt(&argc, argv, 0, 0, &opts); set_rawmode(&t, optp); return conmode_new(rb_obj_class(obj), &t); };T;)I"static VALUE;T;*T;A@´ù;BIC;[;A@´ù;CIC;[;A@´ù;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ºõi•;F;:ConsoleMode;;K;;;[;{;IC;";T;[;[;@|;0; @´ù;'@bè;I"IO::ConsoleMode;F;S@]o;;F; ;;;;I" IO#nread;F;[;[[I"ext/io/wait/wait.c;Ti8;T;: nread;0;[;{;IC;"iReturns number of bytes that can be read without blocking. Returns zero if no information available. ;T;[o;= ;3I" overload;F;40;;Ì;50;)I" nread;T;IC;";T; @ûù;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ûù;[;I"@return [Integer];T;0;6i;[; @ûù;[;I"ŠReturns number of bytes that can be read without blocking. Returns zero if no information available. @overload nread @return [Integer];T;0; @ûù;!F;"o;#;$T;%i0;&i5;'@bè;(I"Œstatic VALUE io_nread(VALUE io) { rb_io_t *fptr = NULL; ioctl_arg n; GetOpenFile(io, fptr); rb_io_check_readable(fptr); int len = rb_io_read_pending(fptr); if (len > 0) return INT2FIX(len); if (!FIONREAD_POSSIBLE_P(fptr->fd)) return INT2FIX(0); if (ioctl(fptr->fd, FIONREAD, &n)) return INT2FIX(0); if (n > 0) return ioctl_arg2num(n); return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#ready?;F;[;[[@úib;T;:ready?;0;[;{;IC;"DReturns +true+ if input available without blocking, or +false+.;T;[o;= ;3I" overload;F;40;;Í;50;)I"ready?;T;IC;";T; @ú;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ú;[;I"@return [Boolean];T;0;6i;[; @ú;[;I"kReturns +true+ if input available without blocking, or +false+. @overload ready? @return [Boolean];T;0; @ú;!F;"o;#;$T;%i[;&i_;6i;'@bè;(I"ästatic VALUE io_ready_p(VALUE io) { rb_io_t *fptr; GetOpenFile(io, fptr); rb_io_check_readable(fptr); if (rb_io_read_pending(fptr)) return Qtrue; return io_wait_event(io, RUBY_IO_READABLE, RB_INT2NUM(0)); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#wait;F;[[@c0;[[@úiä;T;;’;0;[;{;IC;"bWaits until the IO becomes ready for the specified events and returns the subset of events that become ready, or +false+ when times out. The events can be a bit mask of +IO::READABLE+, +IO::WRITABLE+ or +IO::PRIORITY+. Returns +true+ immediately when buffered data is available. Optional parameter +mode+ is one of +:read+, +:write+, or +:read_write+. ;T;[o;= ;3I" overload;F;40;;’;50;)I"wait(events, timeout);T;IC;";T; @2ú;>0;!F;[;[;I";T;0;6i;[[I"events;T0[I"timeout;T0; @2úo;= ;3I" overload;F;40;;’;50;)I"&wait(timeout = nil, mode = :read);T;IC;";T; @2ú;>0;!F;[;[;I";T;0;6i;[[I"timeout;TI"nil;T[I" mode;TI" :read;T; @2ú;[;I"°Waits until the IO becomes ready for the specified events and returns the subset of events that become ready, or +false+ when times out. The events can be a bit mask of +IO::READABLE+, +IO::WRITABLE+ or +IO::PRIORITY+. Returns +true+ immediately when buffered data is available. Optional parameter +mode+ is one of +:read+, +:write+, or +:read_write+. @overload wait(events, timeout) @overload wait(timeout = nil, mode = :read);T;0; @2ú;!F;"o;#;$T;%iÓ;&ià;'@bè;(I"Ostatic VALUE io_wait(int argc, VALUE *argv, VALUE io) { VALUE timeout = Qundef; rb_io_event_t events = 0; if (argc != 2 || (RB_SYMBOL_P(argv[0]) || RB_SYMBOL_P(argv[1]))) { for (int i = 0; i < argc; i += 1) { if (RB_SYMBOL_P(argv[i])) { events |= wait_mode_sym(argv[i]); } else if (timeout == Qundef) { rb_time_interval(timeout = argv[i]); } else { rb_raise(rb_eArgError, "timeout given more than once"); } } if (timeout == Qundef) timeout = Qnil; } else /* argc == 2 */ { events = RB_NUM2UINT(argv[0]); timeout = argv[1]; } if (events == 0) { events = RUBY_IO_READABLE; } if (events & RUBY_IO_READABLE) { rb_io_t *fptr = NULL; RB_IO_POINTER(io, fptr); if (rb_io_read_pending(fptr)) { return Qtrue; } } return io_wait_event(io, events, timeout); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#wait_readable;F;[[@c0;[[@úix;T;:wait_readable;0;[;{;IC;"…Waits until IO is readable and returns +true+, or +false+ when times out. Returns +true+ immediately when buffered data is available. ;T;[o;= ;3I" overload;F;40;;Î;50;)I"wait_readable;T;IC;";T; @[ú;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @[ú;[;I"@return [Boolean];T;0;6i;[; @[úo;= ;3I" overload;F;40;;Î;50;)I"wait_readable(timeout);T;IC;";T; @[ú;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @[ú;[;I"@return [Boolean];T;0;6i;[[I"timeout;T0; @[ú;[;I"èWaits until IO is readable and returns +true+, or +false+ when times out. Returns +true+ immediately when buffered data is available. @overload wait_readable @return [Boolean] @overload wait_readable(timeout) @return [Boolean];T;0; @[ú;!F;"o;#;$T;%in;&iv;'@bè;(I"Xstatic VALUE io_wait_readable(int argc, VALUE *argv, VALUE io) { rb_io_t *fptr = NULL; RB_IO_POINTER(io, fptr); rb_io_check_readable(fptr); if (rb_io_read_pending(fptr)) return Qtrue; rb_check_arity(argc, 0, 1); VALUE timeout = (argc == 1 ? argv[0] : Qnil); return io_wait_event(io, RUBY_IO_READABLE, timeout); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#wait_writable;F;[[@c0;[[@úi‹;T;:wait_writable;0;[;{;IC;"MWaits until IO is writable and returns +true+ or +false+ when times out. ;T;[o;= ;3I" overload;F;40;;Ï;50;)I"wait_writable;T;IC;";T; @†ú;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @†ú;[;I"@return [Boolean];T;0;6i;[; @†úo;= ;3I" overload;F;40;;Ï;50;)I"wait_writable(timeout);T;IC;";T; @†ú;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @†ú;[;I"@return [Boolean];T;0;6i;[[I"timeout;T0; @†ú;[;I"«Waits until IO is writable and returns +true+ or +false+ when times out. @overload wait_writable @return [Boolean] @overload wait_writable(timeout) @return [Boolean];T;0; @†ú;!F;"o;#;$T;%iƒ;&iŠ;'@bè;(I"'static VALUE io_wait_writable(int argc, VALUE *argv, VALUE io) { rb_io_t *fptr = NULL; RB_IO_POINTER(io, fptr); rb_io_check_writable(fptr); rb_check_arity(argc, 0, 1); VALUE timeout = (argc == 1 ? argv[0] : Qnil); return io_wait_event(io, RUBY_IO_WRITABLE, timeout); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#wait_priority;F;[[@c0;[[@úi¡;T;:wait_priority;0;[;{;IC;"MWaits until IO is priority and returns +true+ or +false+ when times out. ;T;[o;= ;3I" overload;F;40;;Ð;50;)I"wait_priority;T;IC;";T; @±ú;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @±ú;[;I"@return [Boolean];T;0;6i;[; @±úo;= ;3I" overload;F;40;;Ð;50;)I"wait_priority(timeout);T;IC;";T; @±ú;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @±ú;[;I"@return [Boolean];T;0;6i;[[I"timeout;T0; @±ú;[;I"«Waits until IO is priority and returns +true+ or +false+ when times out. @overload wait_priority @return [Boolean] @overload wait_priority(timeout) @return [Boolean];T;0; @±ú;!F;"o;#;$T;%i™;&i ;'@bè;(I"Vstatic VALUE io_wait_priority(int argc, VALUE *argv, VALUE io) { rb_io_t *fptr = NULL; RB_IO_POINTER(io, fptr); rb_io_check_readable(fptr); if (rb_io_read_pending(fptr)) return Qtrue; rb_check_arity(argc, 0, 1); VALUE timeout = argc == 1 ? argv[0] : Qnil; return io_wait_event(io, RUBY_IO_PRIORITY, timeout); };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#nonblock?;F;[;[[I"ext/io/nonblock/nonblock.c;Ti,;T;:nonblock?;0;[;{;IC;"0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Üú;[;I"@return [Boolean];T;0;6i;[; @Üú;[;I"fReturns +true+ if an IO object is in non-blocking mode. @overload nonblock? @return [Boolean];T;0; @Üú;!F;"o;#;$T;%i&;&i*;6i;'@bè;(I"¬static VALUE rb_io_nonblock_p(VALUE io) { rb_io_t *fptr; GetOpenFile(io, fptr); if (io_nonblock_mode(fptr->fd) & O_NONBLOCK) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#nonblock=;F;[[I"nb;T0;[[@áúiS;T;:nonblock=;0;[;{;IC;"eEnables non-blocking mode on a stream when set to +true+, and blocking mode when set to +false+. ;T;[o;= ;3I" overload;F;40;;Ò;50;)I"nonblock=(boolean);T;IC;";T; @øú;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @øú;[;I"@return [Boolean];T;0;6i;[[I"boolean;T0; @øú;[;I"“Enables non-blocking mode on a stream when set to +true+, and blocking mode when set to +false+. @overload nonblock=(boolean) @return [Boolean];T;0; @øú;!F;"o;#;$T;%iL;&iQ;'@bè;(I"îstatic VALUE rb_io_nonblock_set(VALUE io, VALUE nb) { rb_io_t *fptr; GetOpenFile(io, fptr); if (RTEST(nb)) rb_io_set_nonblock(fptr); else io_nonblock_set(fptr->fd, io_nonblock_mode(fptr->fd), RTEST(nb)); return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"IO#nonblock;F;[[@c0;[[@áúir;T;: nonblock;0;[;{;IC;"©Yields +self+ in non-blocking mode. When +false+ is given as an argument, +self+ is yielded in blocking mode. The original mode is restored after the block is executed. ;T;[o;= ;3I" overload;F;40;;Ó;50;)I" nonblock;T;IC;";T; @û;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"io;T; @ûo;2 ;3I"return;F;4I";T;0;5[I"IO;T; @û;[;I"@yield [io] @return [IO];T;0;6i;[; @ûo;= ;3I" overload;F;40;;Ó;50;)I"nonblock(boolean);T;IC;";T; @û;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"io;T; @ûo;2 ;3I"return;F;4I";T;0;5[I"IO;T; @û;[;I"@yield [io] @return [IO];T;0;6i;[[I"boolean;T0; @û;[;I"Yields +self+ in non-blocking mode. When +false+ is given as an argument, +self+ is yielded in blocking mode. The original mode is restored after the block is executed. @overload nonblock @yield [io] @return [IO] @overload nonblock(boolean) @yield [io] @return [IO];T;0; @û;!F;"o;#;$T;%ih;&is;'@bè;(I"Òstatic VALUE rb_io_nonblock_block(int argc, VALUE *argv, VALUE io) { int nb = 1; rb_io_t *fptr; int f, restore[2]; GetOpenFile(io, fptr); if (argc > 0) { VALUE v; rb_scan_args(argc, argv, "01", &v); nb = RTEST(v); } f = io_nonblock_mode(fptr->fd); restore[0] = fptr->fd; restore[1] = f; if (!io_nonblock_set(fptr->fd, f, nb)) return rb_yield(io); return rb_ensure(rb_yield, io, io_nonblock_restore, (VALUE)restore); };T;)I"static VALUE;T;*To; ;IC;[o;;F; ;;;;I"IO::generic_writable#<<;F;[;[;F;;Ý;;K;[;{;IC;";T;[;[;@|;0; @Nû;'@Lû;*To;;F; ;;;;I"IO::generic_writable#print;F;[;[;F;;¡;;K;[;{;IC;";T;[;[;@|;0; @Wû;'@Lû;*To;;F; ;;;;I" IO::generic_writable#printf;F;[;[;F;; ;;K;[;{;IC;";T;[;[;@|;0; @`û;'@Lû;*To;;F; ;;;;I"IO::generic_writable#puts;F;[;[;F;;£;;K;[;{;IC;";T;[;[;@|;0; @iû;'@Lû;*To;;F; ;;;;I""IO::generic_writable#syswrite;F;[;[;F;;ƒ;;K;[;{;IC;";T;[;[;@|;0; @rû;'@Lû;*To;;F; ;;;;I"(IO::generic_writable#write_nonblock;F;[[@c0;[[@±øiF;T;:write_nonblock;0;[;{;IC;";T;[;[;@|;0; @{û;'@Lû;(I"²static VALUE strio_syswrite_nonblock(int argc, VALUE *argv, VALUE self) { VALUE str; rb_scan_args(argc, argv, "10:", &str, NULL); return strio_syswrite(self, str); };T;)I"static VALUE;T;*T;A@Lû;BIC;[;A@Lû;CIC;[;A@Lû;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@±øi?;F;:generic_writable;;K;;;[;{;IC;";T;[;[;@|;0; @Lû;'@bè;I"IO::generic_writable;Fo;;F; ;;;;I"IO#stat;F;[;[[@ci];T;;W;0;[;{;IC;"çReturns status information for ios as an object of type File::Stat. f = File.new("testfile") s = f.stat "%o" % s.mode #=> "100644" s.blksize #=> 4096 s.atime #=> Wed Apr 09 08:53:54 CDT 2003 ;T;[o;= ;3I" overload;F;40;;W;50;)I" stat;T;IC;";T; @—û;>0;!F;[;[;I";T;0;6i;[; @—û;[;I"ùReturns status information for ios as an object of type File::Stat. f = File.new("testfile") s = f.stat "%o" % s.mode #=> "100644" s.blksize #=> 4096 s.atime #=> Wed Apr 09 08:53:54 CDT 2003 @overload stat;T;0; @—û;!F;"o;#;$T;%iN;&iY;'@bè;(I"Óstatic VALUE rb_io_stat(VALUE obj) { rb_io_t *fptr; struct stat st; GetOpenFile(obj, fptr); if (fstat(fptr->fd, &st) == -1) { rb_sys_fail_path(fptr->pathv); } return rb_stat_new(&st); };T;)I"static VALUE;T;*T;A@bè;BIC;[;A@bè;CIC;[@(o; ;IC;[o;{;[[@ciç;F;:RDONLY;;};;;[;{;IC;"open for reading only ;T;[;[;I"open for reading only;T;0; @±û;!F;"o;#;$T;%iæ;&iæ;'@¯û;I"File::Constants::RDONLY;F;~I"INT2FIX(O_RDONLY);To;{;[[@cié;F;:WRONLY;;};;;[;{;IC;"open for writing only ;T;[;[;I"open for writing only;T;0; @½û;!F;"o;#;$T;%iè;&iè;'@¯û;I"File::Constants::WRONLY;F;~I"INT2FIX(O_WRONLY);To;{;[[@cië;F;: RDWR;;};;;[;{;IC;"!open for reading and writing ;T;[;[;I"!open for reading and writing;T;0; @Éû;!F;"o;#;$T;%iê;&iê;'@¯û;I"File::Constants::RDWR;F;~I"INT2FIX(O_RDWR);To;{;[[@cií;F;:APPEND;;};;;[;{;IC;"append on each write ;T;[;[;I"append on each write;T;0; @Õû;!F;"o;#;$T;%iì;&iì;'@¯û;I"File::Constants::APPEND;F;~I"INT2FIX(O_APPEND);To;{;[[@ciï;F;: CREAT;;};;;[;{;IC;"%create file if it does not exist ;T;[;[;I"%create file if it does not exist;T;0; @áû;!F;"o;#;$T;%iî;&iî;'@¯û;I"File::Constants::CREAT;F;~I"INT2FIX(O_CREAT);To;{;[[@ciñ;F;: EXCL;;};;;[;{;IC;"'error if CREAT and the file exists ;T;[;[;I"'error if CREAT and the file exists;T;0; @íû;!F;"o;#;$T;%ið;&ið;'@¯û;I"File::Constants::EXCL;F;~I"INT2FIX(O_EXCL);To;{;[[@ci÷;F;: NONBLOCK;;};;;[;{;IC;"9do not block on open or for data to become available ;T;[;[;I"9do not block on open or for data to become available;T;0; @ùû;!F;"o;#;$T;%iö;&iö;'@¯û;I"File::Constants::NONBLOCK;F;~I"INT2FIX(O_NONBLOCK);To;{;[[@ciú;F;: TRUNC;;};;;[;{;IC;"truncate size to 0 ;T;[;[;I"truncate size to 0;T;0; @ü;!F;"o;#;$T;%iù;&iù;'@¯û;I"File::Constants::TRUNC;F;~I"INT2FIX(O_TRUNC);To;{;[[@ciý;F;:NOCTTY;;};;;[;{;IC;":not to make opened IO the controlling terminal device ;T;[;[;I":not to make opened IO the controlling terminal device;T;0; @ü;!F;"o;#;$T;%iü;&iü;'@¯û;I"File::Constants::NOCTTY;F;~I"INT2FIX(O_NOCTTY);To;{;[[@ci;F;;j;;};;;[;{;IC;"!disable line code conversion ;T;[;[;I"!disable line code conversion;T;0; @ü;!F;"o;#;$T;%i;&i;'@¯û;I"File::Constants::BINARY;F;~I"INT2FIX(O_BINARY);To;{;[[@ci;F;:SHARE_DELETE;;};;;[;{;IC;"can delete opened file ;T;[;[;I"can delete opened file;T;0; @)ü;!F;"o;#;$T;%i;&i;'@¯û;I""File::Constants::SHARE_DELETE;F;~I"INT2FIX(O_SHARE_DELETE);To;{;[[@ci;F;: SYNC;;};;;[;{;IC;".any write operation perform synchronously ;T;[;[;I".any write operation perform synchronously;T;0; @5ü;!F;"o;#;$T;%i ;&i ;'@¯û;I"File::Constants::SYNC;F;~I"INT2FIX(O_SYNC);To;{;[[@ci;F;: DSYNC;;};;;[;{;IC;"Dany write operation perform synchronously except some meta data ;T;[;[;I"Dany write operation perform synchronously except some meta data;T;0; @Aü;!F;"o;#;$T;%i;&i;'@¯û;I"File::Constants::DSYNC;F;~I"INT2FIX(O_DSYNC);To;{;[[@ci;F;: RSYNC;;};;;[;{;IC;"Gany read operation perform synchronously. used with SYNC or DSYNC. ;T;[;[;I"Gany read operation perform synchronously. used with SYNC or DSYNC.;T;0; @Mü;!F;"o;#;$T;%i;&i;'@¯û;I"File::Constants::RSYNC;F;~I"INT2FIX(O_RSYNC);To;{;[[@ci;F;: NOFOLLOW;;};;;[;{;IC;"FreeBSD, Linux ;T;[;[;I"FreeBSD, Linux;T;0; @Yü;!F;"o;#;$T;%i;&i;'@¯û;I"File::Constants::NOFOLLOW;F;~I"INT2FIX(O_NOFOLLOW);To;{;[[@ci;F;:NOATIME;;};;;[;{;IC;" Linux ;T;[;[;I" Linux;T;0; @eü;!F;"o;#;$T;%i;&i;'@¯û;I"File::Constants::NOATIME;F;~I"INT2FIX(O_NOATIME);To;{;[[@ci;F;:DIRECT;;};;;[;{;IC;"DTry to minimize cache effects of the I/O to and from this file. ;T;[;[;I"DTry to minimize cache effects of the I/O to and from this file.;T;0; @qü;!F;"o;#;$T;%i;&i;'@¯û;I"File::Constants::DIRECT;F;~I"INT2FIX(O_DIRECT);To;{;[[@ci#;F;:TMPFILE;;};;;[;{;IC;"%Create an unnamed temporary file ;T;[;[;I"%Create an unnamed temporary file;T;0; @}ü;!F;"o;#;$T;%i";&i";'@¯û;I"File::Constants::TMPFILE;F;~I"INT2FIX(O_TMPFILE);To;{;[[@ci';F;:LOCK_SH;;};;;[;{;IC;" shared lock. see File#flock ;T;[;[;I" shared lock. see File#flock;T;0; @‰ü;!F;"o;#;$T;%i&;&i&;'@¯û;I"File::Constants::LOCK_SH;F;~I"INT2FIX(LOCK_SH);To;{;[[@ci);F;:LOCK_EX;;};;;[;{;IC;"#exclusive lock. see File#flock ;T;[;[;I"#exclusive lock. see File#flock;T;0; @•ü;!F;"o;#;$T;%i(;&i(;'@¯û;I"File::Constants::LOCK_EX;F;~I"INT2FIX(LOCK_EX);To;{;[[@ci+;F;:LOCK_UN;;};;;[;{;IC;"unlock. see File#flock ;T;[;[;I"unlock. see File#flock;T;0; @¡ü;!F;"o;#;$T;%i*;&i*;'@¯û;I"File::Constants::LOCK_UN;F;~I"INT2FIX(LOCK_UN);To;{;[[@ci-;F;:LOCK_NB;;};;;[;{;IC;"Dnon-blocking lock. used with LOCK_SH or LOCK_EX. see File#flock ;T;[;[;I"Dnon-blocking lock. used with LOCK_SH or LOCK_EX. see File#flock;T;0; @ü;!F;"o;#;$T;%i,;&i,;'@¯û;I"File::Constants::LOCK_NB;F;~I"INT2FIX(LOCK_NB);To;{;[[@ci0;F;: NULL;;};;;[;{;IC;"Name of the null device ;T;[;[;I"Name of the null device;T;0; @¹ü;!F;"o;#;$T;%i/;&i/;'@¯û;I"File::Constants::NULL;F;~I"&rb_fstring_cstr(ruby_null_device);T;A@¯û;BIC;[;A@¯û;CIC;[;A@¯û;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ciÖ[@ciã;T;;6;;K;;;[;{;IC;"^File::Constants provides file-related constants. All possible file constants are listed in the documentation but they may not all be present on your platform. If the underlying platform doesn't define a constant the corresponding Ruby constant is not defined. Your platform documentations (e.g. man open(2)) may describe more detailed information. ;T;[;[;I"` File::Constants provides file-related constants. All possible file constants are listed in the documentation but they may not all be present on your platform. If the underlying platform doesn't define a constant the corresponding Ruby constant is not defined. Your platform documentations (e.g. man open(2)) may describe more detailed information. ;T;0; @¯û;!F;"o;#;$T;%iÖ;&ià;'o; ;IC;[Wo;;F; ;F;;;I"File.open;F;[[@c0;[[@i;T;;Ÿ;0;[;{;IC;"Ëcall-seq: IO.open(fd, mode="r" [, opt]) -> io IO.open(fd, mode="r" [, opt]) {|io| block } -> obj With no associated block, IO.open is a synonym for IO.new. If the optional code block is given, it will be passed +io+ as an argument, and the IO object will automatically be closed when the block terminates. In this instance, IO.open returns the value of the block. See IO.new for a description of the +fd+, +mode+ and +opt+ parameters. ;T;[;[;@é;0; @Øü;!F;"o;#;$T;%iò;&iý;'@Öü;(I"ústatic VALUE rb_io_s_open(int argc, VALUE *argv, VALUE klass) { VALUE io = rb_class_new_instance_kw(argc, argv, klass, RB_PASS_CALLED_KEYWORDS); if (rb_block_given_p()) { return rb_ensure(rb_yield, io, io_close, io); } return io; };T;)I"static VALUE;T;*To;;F; ;;;;I"File#initialize;F;[[@c0;[[@iz!;T;;Ð;0;[;{;IC;"~Opens the file named by +filename+ according to the given +mode+ and returns a new File object. See IO.new for a description of +mode+ and +opt+. If a file is being created, permission bits may be given in +perm+. These mode and permission bits are platform dependent; on Unix systems, see open(2) and chmod(2) man pages for details. The new File object is buffered mode (or non-sync mode), unless +filename+ is a tty. See IO#flush, IO#fsync, IO#fdatasync, and IO#sync= about sync mode. === Examples f = File.new("testfile", "r") f = File.new("newfile", "w+") f = File.new("newfile", File::CREAT|File::TRUNC|File::RDWR, 0644) ;T;[o;= ;3I" overload;F;40;;î;50;)I"$new(filename, mode="r" [, opt]);T;IC;";T; @æü;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" File;T; @æü;[;I"@return [File];T;0;6i;[[I" filename;T0[I" mode;TI""r"[, opt];T; @æüo;= ;3I" overload;F;40;;î;50;)I",new(filename [, mode [, perm]] [, opt]);T;IC;";T; @æü;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" File;T; @æü;[;I"@return [File];T;0;6i;[[I"%filename[, mode [, perm]][, opt];T0; @æü;[;I"þOpens the file named by +filename+ according to the given +mode+ and returns a new File object. See IO.new for a description of +mode+ and +opt+. If a file is being created, permission bits may be given in +perm+. These mode and permission bits are platform dependent; on Unix systems, see open(2) and chmod(2) man pages for details. The new File object is buffered mode (or non-sync mode), unless +filename+ is a tty. See IO#flush, IO#fsync, IO#fdatasync, and IO#sync= about sync mode. === Examples f = File.new("testfile", "r") f = File.new("newfile", "w+") f = File.new("newfile", File::CREAT|File::TRUNC|File::RDWR, 0644) @overload new(filename, mode="r" [, opt]) @return [File] @overload new(filename [, mode [, perm]] [, opt]) @return [File];T;0; @æü;!F;"o;#;$T;%ia!;&ix!;'@Öü;(I"ostatic VALUE rb_file_initialize(int argc, VALUE *argv, VALUE io) { if (RFILE(io)->fptr) { rb_raise(rb_eRuntimeError, "reinitializing File"); } if (0 < argc && argc < 3) { VALUE fd = rb_check_to_int(argv[0]); if (!NIL_P(fd)) { argv[0] = fd; return rb_io_initialize(argc, argv, io); } } rb_open_file(argc, argv, io); return io; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.fnmatch;F;[[@c0;[[I" dir.c;TiÇ;T;;Q;0;[;{;IC;"«Returns true if +path+ matches against +pattern+. The pattern is not a regular expression; instead it follows rules similar to shell filename globbing. It may contain the following metacharacters: *:: Matches any file. Can be restricted by other values in the glob. Equivalent to / .* /x in regexp. *:: Matches all files regular files c*:: Matches all files beginning with c *c:: Matches all files ending with c \*c*:: Matches all files that have c in them (including at the beginning or end). To match hidden files (that start with a . set the File::FNM_DOTMATCH flag. **:: Matches directories recursively or files expansively. ?:: Matches any one character. Equivalent to /.{1}/ in regexp. [set]:: Matches any one character in +set+. Behaves exactly like character sets in Regexp, including set negation ([^a-z]). \ :: Escapes the next metacharacter. {a,b}:: Matches pattern a and pattern b if File::FNM_EXTGLOB flag is enabled. Behaves like a Regexp union ((?:a|b)). +flags+ is a bitwise OR of the FNM_XXX constants. The same glob pattern and flags are used by Dir::glob. Examples: File.fnmatch('cat', 'cat') #=> true # match entire string File.fnmatch('cat', 'category') #=> false # only match partial string File.fnmatch('c{at,ub}s', 'cats') #=> false # { } isn't supported by default File.fnmatch('c{at,ub}s', 'cats', File::FNM_EXTGLOB) #=> true # { } is supported on FNM_EXTGLOB File.fnmatch('c?t', 'cat') #=> true # '?' match only 1 character File.fnmatch('c??t', 'cat') #=> false # ditto File.fnmatch('c*', 'cats') #=> true # '*' match 0 or more characters File.fnmatch('c*t', 'c/a/b/t') #=> true # ditto File.fnmatch('ca[a-z]', 'cat') #=> true # inclusive bracket expression File.fnmatch('ca[^t]', 'cat') #=> false # exclusive bracket expression ('^' or '!') File.fnmatch('cat', 'CAT') #=> false # case sensitive File.fnmatch('cat', 'CAT', File::FNM_CASEFOLD) #=> true # case insensitive File.fnmatch('cat', 'CAT', File::FNM_SYSCASE) #=> true or false # depends on the system default File.fnmatch('?', '/', File::FNM_PATHNAME) #=> false # wildcard doesn't match '/' on FNM_PATHNAME File.fnmatch('*', '/', File::FNM_PATHNAME) #=> false # ditto File.fnmatch('[/]', '/', File::FNM_PATHNAME) #=> false # ditto File.fnmatch('\?', '?') #=> true # escaped wildcard becomes ordinary File.fnmatch('\a', 'a') #=> true # escaped ordinary remains ordinary File.fnmatch('\a', '\a', File::FNM_NOESCAPE) #=> true # FNM_NOESCAPE makes '\' ordinary File.fnmatch('[\?]', '?') #=> true # can escape inside bracket expression File.fnmatch('*', '.profile') #=> false # wildcard doesn't match leading File.fnmatch('*', '.profile', File::FNM_DOTMATCH) #=> true # period by default. File.fnmatch('.*', '.profile') #=> true rbfiles = '**' '/' '*.rb' # you don't have to do like this. just write in single string. File.fnmatch(rbfiles, 'main.rb') #=> false File.fnmatch(rbfiles, './main.rb') #=> false File.fnmatch(rbfiles, 'lib/song.rb') #=> true File.fnmatch('**.rb', 'main.rb') #=> true File.fnmatch('**.rb', './main.rb') #=> false File.fnmatch('**.rb', 'lib/song.rb') #=> true File.fnmatch('*', 'dave/.profile') #=> true pattern = '*' '/' '*' File.fnmatch(pattern, 'dave/.profile', File::FNM_PATHNAME) #=> false File.fnmatch(pattern, 'dave/.profile', File::FNM_PATHNAME | File::FNM_DOTMATCH) #=> true pattern = '**' '/' 'foo' File.fnmatch(pattern, 'a/b/c/foo', File::FNM_PATHNAME) #=> true File.fnmatch(pattern, '/a/b/c/foo', File::FNM_PATHNAME) #=> true File.fnmatch(pattern, 'c:/a/b/c/foo', File::FNM_PATHNAME) #=> true File.fnmatch(pattern, 'a/.b/c/foo', File::FNM_PATHNAME) #=> false File.fnmatch(pattern, 'a/.b/c/foo', File::FNM_PATHNAME | File::FNM_DOTMATCH) #=> true ;T;[o;= ;3I" overload;F;40;;Q;50;)I"&fnmatch( pattern, path, [flags] );T;IC;";T; @ý;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ý;[;I"@return [Boolean];T;0;6i;[[I"pattern;T0[I" path;T0[I"[flags];T0; @ýo;= ;3I" overload;F;40;;R;50;)I"'fnmatch?( pattern, path, [flags] );T;IC;";T; @ý;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ý;[;I"@return [Boolean];T;0;6i;[[I"pattern;T0[I" path;T0[I"[flags];T0; @ý;[;I".Returns true if +path+ matches against +pattern+. The pattern is not a regular expression; instead it follows rules similar to shell filename globbing. It may contain the following metacharacters: *:: Matches any file. Can be restricted by other values in the glob. Equivalent to / .* /x in regexp. *:: Matches all files regular files c*:: Matches all files beginning with c *c:: Matches all files ending with c \*c*:: Matches all files that have c in them (including at the beginning or end). To match hidden files (that start with a . set the File::FNM_DOTMATCH flag. **:: Matches directories recursively or files expansively. ?:: Matches any one character. Equivalent to /.{1}/ in regexp. [set]:: Matches any one character in +set+. Behaves exactly like character sets in Regexp, including set negation ([^a-z]). \ :: Escapes the next metacharacter. {a,b}:: Matches pattern a and pattern b if File::FNM_EXTGLOB flag is enabled. Behaves like a Regexp union ((?:a|b)). +flags+ is a bitwise OR of the FNM_XXX constants. The same glob pattern and flags are used by Dir::glob. Examples: File.fnmatch('cat', 'cat') #=> true # match entire string File.fnmatch('cat', 'category') #=> false # only match partial string File.fnmatch('c{at,ub}s', 'cats') #=> false # { } isn't supported by default File.fnmatch('c{at,ub}s', 'cats', File::FNM_EXTGLOB) #=> true # { } is supported on FNM_EXTGLOB File.fnmatch('c?t', 'cat') #=> true # '?' match only 1 character File.fnmatch('c??t', 'cat') #=> false # ditto File.fnmatch('c*', 'cats') #=> true # '*' match 0 or more characters File.fnmatch('c*t', 'c/a/b/t') #=> true # ditto File.fnmatch('ca[a-z]', 'cat') #=> true # inclusive bracket expression File.fnmatch('ca[^t]', 'cat') #=> false # exclusive bracket expression ('^' or '!') File.fnmatch('cat', 'CAT') #=> false # case sensitive File.fnmatch('cat', 'CAT', File::FNM_CASEFOLD) #=> true # case insensitive File.fnmatch('cat', 'CAT', File::FNM_SYSCASE) #=> true or false # depends on the system default File.fnmatch('?', '/', File::FNM_PATHNAME) #=> false # wildcard doesn't match '/' on FNM_PATHNAME File.fnmatch('*', '/', File::FNM_PATHNAME) #=> false # ditto File.fnmatch('[/]', '/', File::FNM_PATHNAME) #=> false # ditto File.fnmatch('\?', '?') #=> true # escaped wildcard becomes ordinary File.fnmatch('\a', 'a') #=> true # escaped ordinary remains ordinary File.fnmatch('\a', '\a', File::FNM_NOESCAPE) #=> true # FNM_NOESCAPE makes '\' ordinary File.fnmatch('[\?]', '?') #=> true # can escape inside bracket expression File.fnmatch('*', '.profile') #=> false # wildcard doesn't match leading File.fnmatch('*', '.profile', File::FNM_DOTMATCH) #=> true # period by default. File.fnmatch('.*', '.profile') #=> true rbfiles = '**' '/' '*.rb' # you don't have to do like this. just write in single string. File.fnmatch(rbfiles, 'main.rb') #=> false File.fnmatch(rbfiles, './main.rb') #=> false File.fnmatch(rbfiles, 'lib/song.rb') #=> true File.fnmatch('**.rb', 'main.rb') #=> true File.fnmatch('**.rb', './main.rb') #=> false File.fnmatch('**.rb', 'lib/song.rb') #=> true File.fnmatch('*', 'dave/.profile') #=> true pattern = '*' '/' '*' File.fnmatch(pattern, 'dave/.profile', File::FNM_PATHNAME) #=> false File.fnmatch(pattern, 'dave/.profile', File::FNM_PATHNAME | File::FNM_DOTMATCH) #=> true pattern = '**' '/' 'foo' File.fnmatch(pattern, 'a/b/c/foo', File::FNM_PATHNAME) #=> true File.fnmatch(pattern, '/a/b/c/foo', File::FNM_PATHNAME) #=> true File.fnmatch(pattern, 'c:/a/b/c/foo', File::FNM_PATHNAME) #=> true File.fnmatch(pattern, 'a/.b/c/foo', File::FNM_PATHNAME) #=> false File.fnmatch(pattern, 'a/.b/c/foo', File::FNM_PATHNAME | File::FNM_DOTMATCH) #=> true @overload fnmatch( pattern, path, [flags] ) @return [Boolean] @overload fnmatch?( pattern, path, [flags] ) @return [Boolean];T;0; @ý;!F;"o;#;$T;%ii;&iÆ;'@Öü;(I"static VALUE file_s_fnmatch(int argc, VALUE *argv, VALUE obj) { VALUE pattern, path; VALUE rflags; int flags; if (rb_scan_args(argc, argv, "21", &pattern, &path, &rflags) == 3) flags = NUM2INT(rflags); else flags = 0; StringValueCStr(pattern); FilePathStringValue(path); if (flags & FNM_EXTGLOB) { struct brace_args args; args.value = path; args.flags = flags; if (ruby_brace_expand(RSTRING_PTR(pattern), flags, fnmatch_brace, (VALUE)&args, rb_enc_get(pattern), pattern) > 0) return Qtrue; } else { rb_encoding *enc = rb_enc_compatible(pattern, path); if (!enc) return Qfalse; if (fnmatch(RSTRING_PTR(pattern), enc, RSTRING_PTR(path), flags) == 0) return Qtrue; } RB_GC_GUARD(pattern); return Qfalse; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.fnmatch?;F;[[@c0;[[@ýiÇ;T;;R;0;[;{;IC;"«Returns true if +path+ matches against +pattern+. The pattern is not a regular expression; instead it follows rules similar to shell filename globbing. It may contain the following metacharacters: *:: Matches any file. Can be restricted by other values in the glob. Equivalent to / .* /x in regexp. *:: Matches all files regular files c*:: Matches all files beginning with c *c:: Matches all files ending with c \*c*:: Matches all files that have c in them (including at the beginning or end). To match hidden files (that start with a . set the File::FNM_DOTMATCH flag. **:: Matches directories recursively or files expansively. ?:: Matches any one character. Equivalent to /.{1}/ in regexp. [set]:: Matches any one character in +set+. Behaves exactly like character sets in Regexp, including set negation ([^a-z]). \ :: Escapes the next metacharacter. {a,b}:: Matches pattern a and pattern b if File::FNM_EXTGLOB flag is enabled. Behaves like a Regexp union ((?:a|b)). +flags+ is a bitwise OR of the FNM_XXX constants. The same glob pattern and flags are used by Dir::glob. Examples: File.fnmatch('cat', 'cat') #=> true # match entire string File.fnmatch('cat', 'category') #=> false # only match partial string File.fnmatch('c{at,ub}s', 'cats') #=> false # { } isn't supported by default File.fnmatch('c{at,ub}s', 'cats', File::FNM_EXTGLOB) #=> true # { } is supported on FNM_EXTGLOB File.fnmatch('c?t', 'cat') #=> true # '?' match only 1 character File.fnmatch('c??t', 'cat') #=> false # ditto File.fnmatch('c*', 'cats') #=> true # '*' match 0 or more characters File.fnmatch('c*t', 'c/a/b/t') #=> true # ditto File.fnmatch('ca[a-z]', 'cat') #=> true # inclusive bracket expression File.fnmatch('ca[^t]', 'cat') #=> false # exclusive bracket expression ('^' or '!') File.fnmatch('cat', 'CAT') #=> false # case sensitive File.fnmatch('cat', 'CAT', File::FNM_CASEFOLD) #=> true # case insensitive File.fnmatch('cat', 'CAT', File::FNM_SYSCASE) #=> true or false # depends on the system default File.fnmatch('?', '/', File::FNM_PATHNAME) #=> false # wildcard doesn't match '/' on FNM_PATHNAME File.fnmatch('*', '/', File::FNM_PATHNAME) #=> false # ditto File.fnmatch('[/]', '/', File::FNM_PATHNAME) #=> false # ditto File.fnmatch('\?', '?') #=> true # escaped wildcard becomes ordinary File.fnmatch('\a', 'a') #=> true # escaped ordinary remains ordinary File.fnmatch('\a', '\a', File::FNM_NOESCAPE) #=> true # FNM_NOESCAPE makes '\' ordinary File.fnmatch('[\?]', '?') #=> true # can escape inside bracket expression File.fnmatch('*', '.profile') #=> false # wildcard doesn't match leading File.fnmatch('*', '.profile', File::FNM_DOTMATCH) #=> true # period by default. File.fnmatch('.*', '.profile') #=> true rbfiles = '**' '/' '*.rb' # you don't have to do like this. just write in single string. File.fnmatch(rbfiles, 'main.rb') #=> false File.fnmatch(rbfiles, './main.rb') #=> false File.fnmatch(rbfiles, 'lib/song.rb') #=> true File.fnmatch('**.rb', 'main.rb') #=> true File.fnmatch('**.rb', './main.rb') #=> false File.fnmatch('**.rb', 'lib/song.rb') #=> true File.fnmatch('*', 'dave/.profile') #=> true pattern = '*' '/' '*' File.fnmatch(pattern, 'dave/.profile', File::FNM_PATHNAME) #=> false File.fnmatch(pattern, 'dave/.profile', File::FNM_PATHNAME | File::FNM_DOTMATCH) #=> true pattern = '**' '/' 'foo' File.fnmatch(pattern, 'a/b/c/foo', File::FNM_PATHNAME) #=> true File.fnmatch(pattern, '/a/b/c/foo', File::FNM_PATHNAME) #=> true File.fnmatch(pattern, 'c:/a/b/c/foo', File::FNM_PATHNAME) #=> true File.fnmatch(pattern, 'a/.b/c/foo', File::FNM_PATHNAME) #=> false File.fnmatch(pattern, 'a/.b/c/foo', File::FNM_PATHNAME | File::FNM_DOTMATCH) #=> true;T;[o;= ;3I" overload;F;40;;Q;50;)I"&fnmatch( pattern, path, [flags] );T;IC;";T; @Lý;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Lý;[;I"@return [Boolean];T;0;6i;[[I"pattern;T0[I" path;T0[I"[flags];T0; @Lýo;= ;3I" overload;F;40;;R;50;)I"'fnmatch?( pattern, path, [flags] );T;IC;";T; @Lý;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Lý;[;I"@return [Boolean];T;0;6i;[[I"pattern;T0[I" path;T0[I"[flags];T0; @Lý;[;@Hý;0; @Lý;!F;"o;#;$T;%ii;&iÆ;6i;'@Öü;(I"static VALUE file_s_fnmatch(int argc, VALUE *argv, VALUE obj) { VALUE pattern, path; VALUE rflags; int flags; if (rb_scan_args(argc, argv, "21", &pattern, &path, &rflags) == 3) flags = NUM2INT(rflags); else flags = 0; StringValueCStr(pattern); FilePathStringValue(path); if (flags & FNM_EXTGLOB) { struct brace_args args; args.value = path; args.flags = flags; if (ruby_brace_expand(RSTRING_PTR(pattern), flags, fnmatch_brace, (VALUE)&args, rb_enc_get(pattern), pattern) > 0) return Qtrue; } else { rb_encoding *enc = rb_enc_compatible(pattern, path); if (!enc) return Qfalse; if (fnmatch(RSTRING_PTR(pattern), enc, RSTRING_PTR(path), flags) == 0) return Qtrue; } RB_GC_GUARD(pattern); return Qfalse; };T;)I"static VALUE;T;*To; ;IC;[2o;;F; ;;;;I"File::Stat#initialize;T;[[I" fname;T0;[[@ci…;T;;Ð;0;[;{;IC;"iCreate a File::Stat object for the given file name (raising an exception if the file doesn't exist). ;T;[o;= ;3I" overload;F;40;:File::Stat.new;50;)I"File::Stat.new(file_name);T;IC;";T; @‚ý;>0;!F;[;[;I";T;0;6i;[[I"file_name;T0; @‚ý;[;I"ŠCreate a File::Stat object for the given file name (raising an exception if the file doesn't exist). @overload File::Stat.new(file_name);T;0; @‚ý;!F;"o;#;$T;%i|;&i€;'@€ý;(I"‹static VALUE rb_stat_init(VALUE obj, VALUE fname) { struct stat st, *nst; FilePathValue(fname); fname = rb_str_encode_ospath(fname); if (STAT(StringValueCStr(fname), &st) == -1) { rb_sys_fail_path(fname); } if (DATA_PTR(obj)) { xfree(DATA_PTR(obj)); DATA_PTR(obj) = NULL; } nst = ALLOC(struct stat); *nst = st; DATA_PTR(obj) = nst; return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#initialize_copy;T;[[I" orig;T0;[[@ci›;T;;g;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @œý;!F;"o;#;$T;%iš;&iš;'@€ý;(I"Zstatic VALUE rb_stat_init_copy(VALUE copy, VALUE orig) { struct stat *nst; if (!OBJ_INIT_COPY(copy, orig)) return copy; if (DATA_PTR(copy)) { xfree(DATA_PTR(copy)); DATA_PTR(copy) = 0; } if (DATA_PTR(orig)) { nst = ALLOC(struct stat); *nst = *(struct stat*)DATA_PTR(orig); DATA_PTR(copy) = nst; } return copy; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#<=>;T;[[I" other;T0;[[@ciB;T;;c;0;[;{;IC;"ïCompares File::Stat objects by comparing their respective modification times. +nil+ is returned if +other_stat+ is not a File::Stat object f1 = File.new("f1", "w") sleep 1 f2 = File.new("f2", "w") f1.stat <=> f2.stat #=> -1 ;T;[o;= ;3I" overload;F;40;;c;50;)I"<=>(other_stat);T;IC;";T; @¬ý;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[ I"-1;TI"0;TI"1;TI"nil;T; @¬ý;[;I"@return [-1, 0, 1, nil];T;0;6i;[[I"other_stat;T0; @¬ý;[;I"'Compares File::Stat objects by comparing their respective modification times. +nil+ is returned if +other_stat+ is not a File::Stat object f1 = File.new("f1", "w") sleep 1 f2 = File.new("f2", "w") f1.stat <=> f2.stat #=> -1 @overload <=>(other_stat) @return [-1, 0, 1, nil];T;0; @¬ý;!F;"o;#;$T;%i3;&i?;'@€ý;(I"$static VALUE rb_stat_cmp(VALUE self, VALUE other) { if (rb_obj_is_kind_of(other, rb_obj_class(self))) { struct timespec ts1 = stat_mtimespec(get_stat(self)); struct timespec ts2 = stat_mtimespec(get_stat(other)); if (ts1.tv_sec == ts2.tv_sec) { if (ts1.tv_nsec == ts2.tv_nsec) return INT2FIX(0); if (ts1.tv_nsec < ts2.tv_nsec) return INT2FIX(-1); return INT2FIX(1); } if (ts1.tv_sec < ts2.tv_sec) return INT2FIX(-1); return INT2FIX(1); } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#dev;T;[;[[@cii;T;:dev;0;[;{;IC;"uReturns an integer representing the device on which stat resides. File.stat("testfile").dev #=> 774 ;T;[o;= ;3I" overload;F;40;;í;50;)I"dev;T;IC;";T; @Îý;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Îý;[;I"@return [Integer];T;0;6i;[; @Îý;[;I"”Returns an integer representing the device on which stat resides. File.stat("testfile").dev #=> 774 @overload dev @return [Integer];T;0; @Îý;!F;"o;#;$T;%i_;&if;'@€ý;(I"Zstatic VALUE rb_stat_dev(VALUE self) { return DEVT2NUM(get_stat(self)->st_dev); };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#dev_major;T;[;[[@ciz;T;:dev_major;0;[;{;IC;" Returns the major part of File_Stat#dev or nil. File.stat("/dev/fd1").dev_major #=> 2 File.stat("/dev/tty").dev_major #=> 5 ;T;[o;= ;3I" overload;F;40;;î;50;)I"dev_major;T;IC;";T; @éý;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @éý;[;I"@return [Integer];T;0;6i;[; @éý;[;I"ÊReturns the major part of File_Stat#dev or nil. File.stat("/dev/fd1").dev_major #=> 2 File.stat("/dev/tty").dev_major #=> 5 @overload dev_major @return [Integer];T;0; @éý;!F;"o;#;$T;%io;&iw;'@€ý;(I"“static VALUE rb_stat_dev_major(VALUE self) { #if defined(major) return UINT2NUM(major(get_stat(self)->st_dev)); #else return Qnil; #endif };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#dev_minor;T;[;[[@ci;T;:dev_minor;0;[;{;IC;" Returns the minor part of File_Stat#dev or nil. File.stat("/dev/fd1").dev_minor #=> 1 File.stat("/dev/tty").dev_minor #=> 0 ;T;[o;= ;3I" overload;F;40;;ï;50;)I"dev_minor;T;IC;";T; @þ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @þ;[;I"@return [Integer];T;0;6i;[; @þ;[;I"ÊReturns the minor part of File_Stat#dev or nil. File.stat("/dev/fd1").dev_minor #=> 1 File.stat("/dev/tty").dev_minor #=> 0 @overload dev_minor @return [Integer];T;0; @þ;!F;"o;#;$T;%i„;&iŒ;'@€ý;(I"“static VALUE rb_stat_dev_minor(VALUE self) { #if defined(minor) return UINT2NUM(minor(get_stat(self)->st_dev)); #else return Qnil; #endif };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#ino;T;[;[[@ci£;T;:ino;0;[;{;IC;"ZReturns the inode number for stat. File.stat("testfile").ino #=> 1083669 ;T;[o;= ;3I" overload;F;40;;ð;50;)I"ino;T;IC;";T; @þ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @þ;[;I"@return [Integer];T;0;6i;[; @þ;[;I"Returns the inode number for stat. File.stat("testfile").ino #=> 1083669 @overload ino @return [Integer];T;0; @þ;!F;"o;#;$T;%i™;&i ;'@€ý;(I"ûstatic VALUE rb_stat_ino(VALUE self) { #ifdef HAVE_STRUCT_STAT_ST_INOHIGH /* assume INTEGER_PACK_LSWORD_FIRST and st_inohigh is just next of st_ino */ return rb_integer_unpack(&get_stat(self)->st_ino, 2, SIZEOF_STRUCT_STAT_ST_INO, 0, INTEGER_PACK_LSWORD_FIRST|INTEGER_PACK_NATIVE_BYTE_ORDER| INTEGER_PACK_2COMP); #elif SIZEOF_STRUCT_STAT_ST_INO > SIZEOF_LONG return ULL2NUM(get_stat(self)->st_ino); #else return ULONG2NUM(get_stat(self)->st_ino); #endif };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#mode;T;[;[[@ciÀ;T;: mode;0;[;{;IC;"Returns an integer representing the permission bits of stat. The meaning of the bits is platform dependent; on Unix systems, see stat(2). File.chmod(0644, "testfile") #=> 1 s = File.stat("testfile") sprintf("%o", s.mode) #=> "100644" ;T;[o;= ;3I" overload;F;40;;ñ;50;)I" mode;T;IC;";T; @:þ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @:þ;[;I"@return [Integer];T;0;6i;[; @:þ;[;I"7Returns an integer representing the permission bits of stat. The meaning of the bits is platform dependent; on Unix systems, see stat(2). File.chmod(0644, "testfile") #=> 1 s = File.stat("testfile") sprintf("%o", s.mode) #=> "100644" @overload mode @return [Integer];T;0; @:þ;!F;"o;#;$T;%i³;&i½;'@€ý;(I"estatic VALUE rb_stat_mode(VALUE self) { return UINT2NUM(ST2UINT(get_stat(self)->st_mode)); };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#nlink;T;[;[[@ciÒ;T;: nlink;0;[;{;IC;"ÄReturns the number of hard links to stat. File.stat("testfile").nlink #=> 1 File.link("testfile", "testfile.bak") #=> 0 File.stat("testfile").nlink #=> 2 ;T;[o;= ;3I" overload;F;40;;ò;50;)I" nlink;T;IC;";T; @Uþ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Uþ;[;I"@return [Integer];T;0;6i;[; @Uþ;[;I"ëReturns the number of hard links to stat. File.stat("testfile").nlink #=> 1 File.link("testfile", "testfile.bak") #=> 0 File.stat("testfile").nlink #=> 2 @overload nlink @return [Integer];T;0; @Uþ;!F;"o;#;$T;%iÆ;&iÏ;'@€ý;(I"Bstatic VALUE rb_stat_nlink(VALUE self) { /* struct stat::st_nlink is nlink_t in POSIX. Not the case for Windows. */ const struct stat *ptr = get_stat(self); if (sizeof(ptr->st_nlink) <= sizeof(int)) { return UINT2NUM((unsigned)ptr->st_nlink); } else if (sizeof(ptr->st_nlink) == sizeof(long)) { return ULONG2NUM((unsigned long)ptr->st_nlink); } else if (sizeof(ptr->st_nlink) == sizeof(LONG_LONG)) { return ULL2NUM((unsigned LONG_LONG)ptr->st_nlink); } else { rb_bug(":FIXME: don't know what to do"); } };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#uid;T;[;[[@cið;T;;þ;0;[;{;IC;"eReturns the numeric user id of the owner of stat. File.stat("testfile").uid #=> 501 ;T;[o;= ;3I" overload;F;40;;þ;50;)I"uid;T;IC;";T; @pþ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @pþ;[;I"@return [Integer];T;0;6i;[; @pþ;[;I"…Returns the numeric user id of the owner of stat. File.stat("testfile").uid #=> 501 @overload uid @return [Integer];T;0; @pþ;!F;"o;#;$T;%iæ;&ií;'@€ý;(I"Zstatic VALUE rb_stat_uid(VALUE self) { return UIDT2NUM(get_stat(self)->st_uid); };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#gid;T;[;[[@ci;T;;;0;[;{;IC;"fReturns the numeric group id of the owner of stat. File.stat("testfile").gid #=> 500 ;T;[o;= ;3I" overload;F;40;;;50;)I"gid;T;IC;";T; @‹þ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @‹þ;[;I"@return [Integer];T;0;6i;[; @‹þ;[;I"†Returns the numeric group id of the owner of stat. File.stat("testfile").gid #=> 500 @overload gid @return [Integer];T;0; @‹þ;!F;"o;#;$T;%iö;&iý;'@€ý;(I"Zstatic VALUE rb_stat_gid(VALUE self) { return GIDT2NUM(get_stat(self)->st_gid); };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#rdev;T;[;[[@ci;T;: rdev;0;[;{;IC;"îReturns an integer representing the device type on which stat resides. Returns nil if the operating system doesn't support this feature. File.stat("/dev/fd1").rdev #=> 513 File.stat("/dev/tty").rdev #=> 1280 ;T;[o;= ;3I" overload;F;40;;ó;50;)I" rdev;T;IC;";T; @¦þ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @¦þ;[;I"@return [Integer, nil];T;0;6i;[; @¦þ;[;I"Returns an integer representing the device type on which stat resides. Returns nil if the operating system doesn't support this feature. File.stat("/dev/fd1").rdev #=> 513 File.stat("/dev/tty").rdev #=> 1280 @overload rdev @return [Integer, nil];T;0; @¦þ;!F;"o;#;$T;%i;&i;'@€ý;(I"•static VALUE rb_stat_rdev(VALUE self) { #ifdef HAVE_STRUCT_STAT_ST_RDEV return DEVT2NUM(get_stat(self)->st_rdev); #else return Qnil; #endif };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#rdev_major;T;[;[[@ci';T;:rdev_major;0;[;{;IC;"£Returns the major part of File_Stat#rdev or nil. File.stat("/dev/fd1").rdev_major #=> 2 File.stat("/dev/tty").rdev_major #=> 5 ;T;[o;= ;3I" overload;F;40;;ô;50;)I"rdev_major;T;IC;";T; @Âþ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Âþ;[;I"@return [Integer];T;0;6i;[; @Âþ;[;I"ÎReturns the major part of File_Stat#rdev or nil. File.stat("/dev/fd1").rdev_major #=> 2 File.stat("/dev/tty").rdev_major #=> 5 @overload rdev_major @return [Integer];T;0; @Âþ;!F;"o;#;$T;%i;&i$;'@€ý;(I"ºstatic VALUE rb_stat_rdev_major(VALUE self) { #if defined(HAVE_STRUCT_STAT_ST_RDEV) && defined(major) return UINT2NUM(major(get_stat(self)->st_rdev)); #else return Qnil; #endif };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#rdev_minor;T;[;[[@ci<;T;:rdev_minor;0;[;{;IC;"£Returns the minor part of File_Stat#rdev or nil. File.stat("/dev/fd1").rdev_minor #=> 1 File.stat("/dev/tty").rdev_minor #=> 0 ;T;[o;= ;3I" overload;F;40;;õ;50;)I"rdev_minor;T;IC;";T; @Ýþ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ýþ;[;I"@return [Integer];T;0;6i;[; @Ýþ;[;I"ÎReturns the minor part of File_Stat#rdev or nil. File.stat("/dev/fd1").rdev_minor #=> 1 File.stat("/dev/tty").rdev_minor #=> 0 @overload rdev_minor @return [Integer];T;0; @Ýþ;!F;"o;#;$T;%i1;&i9;'@€ý;(I"ºstatic VALUE rb_stat_rdev_minor(VALUE self) { #if defined(HAVE_STRUCT_STAT_ST_RDEV) && defined(minor) return UINT2NUM(minor(get_stat(self)->st_rdev)); #else return Qnil; #endif };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#size;T;[;[[@ciO;T;;¯;0;[;{;IC;"VReturns the size of stat in bytes. File.stat("testfile").size #=> 66 ;T;[o;= ;3I" overload;F;40;;¯;50;)I" size;T;IC;";T; @øþ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @øþ;[;I"@return [Integer];T;0;6i;[; @øþ;[;I"{Returns the size of stat in bytes. File.stat("testfile").size #=> 66 @overload size @return [Integer];T;0; @øþ;!F;"o;#;$T;%iF;&iL;'@€ý;(I"\static VALUE rb_stat_size(VALUE self) { return OFFT2NUM(get_stat(self)->st_size); };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#blksize;T;[;[[@ci`;T;:blksize;0;[;{;IC;"¨Returns the native file system's block size. Will return nil on platforms that don't support this information. File.stat("testfile").blksize #=> 4096 ;T;[o;= ;3I" overload;F;40;;ö;50;)I"blksize;T;IC;";T; @ÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @ÿ;[;I"@return [Integer, nil];T;0;6i;[; @ÿ;[;I"ÖReturns the native file system's block size. Will return nil on platforms that don't support this information. File.stat("testfile").blksize #=> 4096 @overload blksize @return [Integer, nil];T;0; @ÿ;!F;"o;#;$T;%iU;&i];'@€ý;(I"Ÿstatic VALUE rb_stat_blksize(VALUE self) { #ifdef HAVE_STRUCT_STAT_ST_BLKSIZE return ULONG2NUM(get_stat(self)->st_blksize); #else return Qnil; #endif };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#blocks;T;[;[[@ciu;T;:blocks;0;[;{;IC;"»Returns the number of native file system blocks allocated for this file, or nil if the operating system doesn't support this feature. File.stat("testfile").blocks #=> 2 ;T;[o;= ;3I" overload;F;40;;÷;50;)I"blocks;T;IC;";T; @/ÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @/ÿ;[;I"@return [Integer, nil];T;0;6i;[; @/ÿ;[;I"çReturns the number of native file system blocks allocated for this file, or nil if the operating system doesn't support this feature. File.stat("testfile").blocks #=> 2 @overload blocks @return [Integer, nil];T;0; @/ÿ;!F;"o;#;$T;%ij;&ir;'@€ý;(I" static VALUE rb_stat_blocks(VALUE self) { #ifdef HAVE_STRUCT_STAT_ST_BLOCKS # if SIZEOF_STRUCT_STAT_ST_BLOCKS > SIZEOF_LONG return ULL2NUM(get_stat(self)->st_blocks); # else return ULONG2NUM(get_stat(self)->st_blocks); # endif #else return Qnil; #endif };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#atime;T;[;[[@ciæ;T;;J;0;[;{;IC;"‰Returns the last access time for this file as an object of class Time. File.stat("testfile").atime #=> Wed Dec 31 18:00:00 CST 1969 ;T;[o;= ;3I" overload;F;40;;J;50;)I" atime;T;IC;";T; @Kÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Time;T; @Kÿ;[;I"@return [Time];T;0;6i;[; @Kÿ;[;I"Returns the last access time for this file as an object of class Time. File.stat("testfile").atime #=> Wed Dec 31 18:00:00 CST 1969 @overload atime @return [Time];T;0; @Kÿ;!F;"o;#;$T;%iÛ;&iã;'@€ý;(I"Vstatic VALUE rb_stat_atime(VALUE self) { return stat_atime(get_stat(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#mtime;T;[;[[@ciö;T;;ü;0;[;{;IC;"uReturns the modification time of stat. File.stat("testfile").mtime #=> Wed Apr 09 08:53:14 CDT 2003 ;T;[o;= ;3I" overload;F;40;;ü;50;)I" mtime;T;IC;";T; @fÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" aTime;T; @fÿ;[;I"@return [ aTime];T;0;6i;[; @fÿ;[;I"–Returns the modification time of stat. File.stat("testfile").mtime #=> Wed Apr 09 08:53:14 CDT 2003 @overload mtime @return [ aTime];T;0; @fÿ;!F;"o;#;$T;%iì;&ió;'@€ý;(I"Vstatic VALUE rb_stat_mtime(VALUE self) { return stat_mtime(get_stat(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#ctime;T;[;[[@ci ;T;;L;0;[;{;IC;"Returns the change time for stat (that is, the time directory information about the file was changed, not the file itself). Note that on Windows (NTFS), returns creation time (birth time). File.stat("testfile").ctime #=> Wed Apr 09 08:53:14 CDT 2003 ;T;[o;= ;3I" overload;F;40;;L;50;)I" ctime;T;IC;";T; @ÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" aTime;T; @ÿ;[;I"@return [ aTime];T;0;6i;[; @ÿ;[;I"-Returns the change time for stat (that is, the time directory information about the file was changed, not the file itself). Note that on Windows (NTFS), returns creation time (birth time). File.stat("testfile").ctime #=> Wed Apr 09 08:53:14 CDT 2003 @overload ctime @return [ aTime];T;0; @ÿ;!F;"o;#;$T;%iü;&i;'@€ý;(I"Vstatic VALUE rb_stat_ctime(VALUE self) { return stat_ctime(get_stat(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#birthtime;T;[;[[@ci';T;;K;0;[;{;IC;"Returns the birth time for stat. If the platform doesn't have birthtime, raises NotImplementedError. File.write("testfile", "foo") sleep 10 File.write("testfile", "bar") sleep 10 File.chmod(0644, "testfile") sleep 10 File.read("testfile") File.stat("testfile").birthtime #=> 2014-02-24 11:19:17 +0900 File.stat("testfile").mtime #=> 2014-02-24 11:19:27 +0900 File.stat("testfile").ctime #=> 2014-02-24 11:19:37 +0900 File.stat("testfile").atime #=> 2014-02-24 11:19:47 +0900 ;T;[o;= ;3I" overload;F;40;;K;50;)I"birthtime;T;IC;";T; @œÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" aTime;T; @œÿ;[;I"@return [ aTime];T;0;6i;[; @œÿ;[;I"BReturns the birth time for stat. If the platform doesn't have birthtime, raises NotImplementedError. File.write("testfile", "foo") sleep 10 File.write("testfile", "bar") sleep 10 File.chmod(0644, "testfile") sleep 10 File.read("testfile") File.stat("testfile").birthtime #=> 2014-02-24 11:19:17 +0900 File.stat("testfile").mtime #=> 2014-02-24 11:19:27 +0900 File.stat("testfile").ctime #=> 2014-02-24 11:19:37 +0900 File.stat("testfile").atime #=> 2014-02-24 11:19:47 +0900 @overload birthtime @return [ aTime];T;0; @œÿ;!F;"o;#;$T;%i;&i$;'@€ý;(I"^static VALUE rb_stat_birthtime(VALUE self) { return stat_birthtime(get_stat(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#inspect;T;[;[[@ci?;T;;r;0;[;{;IC;"¦Produce a nicely formatted description of stat. File.stat("/etc/passwd").inspect #=> "#" ;T;[o;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @·ÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @·ÿ;[;I"@return [String];T;0;6i;[; @·ÿ;[;I"ÍProduce a nicely formatted description of stat. File.stat("/etc/passwd").inspect #=> "#" @overload inspect @return [String];T;0; @·ÿ;!F;"o;#;$T;%i0;&i<;'@€ý;(I"ªstatic VALUE rb_stat_inspect(VALUE self) { VALUE str; size_t i; static const struct { const char *name; VALUE (*func)(VALUE); } member[] = { {"dev", rb_stat_dev}, {"ino", rb_stat_ino}, {"mode", rb_stat_mode}, {"nlink", rb_stat_nlink}, {"uid", rb_stat_uid}, {"gid", rb_stat_gid}, {"rdev", rb_stat_rdev}, {"size", rb_stat_size}, {"blksize", rb_stat_blksize}, {"blocks", rb_stat_blocks}, {"atime", rb_stat_atime}, {"mtime", rb_stat_mtime}, {"ctime", rb_stat_ctime}, #if defined(HAVE_STRUCT_STAT_ST_BIRTHTIMESPEC) {"birthtime", rb_stat_birthtime}, #endif }; struct stat* st; TypedData_Get_Struct(self, struct stat, &stat_data_type, st); if (!st) { return rb_sprintf("#<%s: uninitialized>", rb_obj_classname(self)); } str = rb_str_buf_new2("#<"); rb_str_buf_cat2(str, rb_obj_classname(self)); rb_str_buf_cat2(str, " "); for (i = 0; i < sizeof(member)/sizeof(member[0]); i++) { VALUE v; if (i > 0) { rb_str_buf_cat2(str, ", "); } rb_str_buf_cat2(str, member[i].name); rb_str_buf_cat2(str, "="); v = (*member[i].func)(self); if (i == 2) { /* mode */ rb_str_catf(str, "0%lo", (unsigned long)NUM2ULONG(v)); } else if (i == 0 || i == 6) { /* dev/rdev */ rb_str_catf(str, "0x%"PRI_DEVT_PREFIX"x", NUM2DEVT(v)); } else { rb_str_append(str, rb_inspect(v)); } } rb_str_buf_cat2(str, ">"); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#ftype;T;[;[[@ci¼;T;;S;0;[;{;IC;"RIdentifies the type of stat. The return string is one of: ``file'', ``directory'', ``characterSpecial'', ``blockSpecial'', ``fifo'', ``link'', ``socket'', or ``unknown''. File.stat("/dev/tty").ftype #=> "characterSpecial" ;T;[o;= ;3I" overload;F;40;;S;50;)I" ftype;T;IC;";T; @Òÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Òÿ;[;I"@return [String];T;0;6i;[; @Òÿ;[;I"xIdentifies the type of stat. The return string is one of: ``file'', ``directory'', ``characterSpecial'', ``blockSpecial'', ``fifo'', ``link'', ``socket'', or ``unknown''. File.stat("/dev/tty").ftype #=> "characterSpecial" @overload ftype @return [String];T;0; @Òÿ;!F;"o;#;$T;%i®;&i¹;'@€ý;(I"Wstatic VALUE rb_stat_ftype(VALUE obj) { return rb_file_ftype(get_stat(obj)); };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#directory?;T;[;[[@ciÍ;T;;e;0;[;{;IC;"¶Returns true if stat is a directory, false otherwise. File.stat("testfile").directory? #=> false File.stat(".").directory? #=> true;T;[o;= ;3I" overload;F;40;;e;50;)I"directory?;T;IC;";T; @íÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @íÿ;[;I"@return [Boolean];T;0;6i;[; @íÿ;[;I"áReturns true if stat is a directory, false otherwise. File.stat("testfile").directory? #=> false File.stat(".").directory? #=> true @overload directory? @return [Boolean];T;0; @íÿ;!F;"o;#;$T;%iÂ;&iÊ;6i;'@€ý;(I"tstatic VALUE rb_stat_d(VALUE obj) { if (S_ISDIR(get_stat(obj)->st_mode)) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#readable?;T;[;[[@ciz;T;;j;0;[;{;IC;"Returns true if stat is readable by the effective user id of this process. File.stat("testfile").readable? #=> true;T;[o;= ;3I" overload;F;40;;j;50;)I"readable?;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @;[;I"@return [Boolean];T;0;6i;[; @;[;I"¸Returns true if stat is readable by the effective user id of this process. File.stat("testfile").readable? #=> true @overload readable? @return [Boolean];T;0; @;!F;"o;#;$T;%io;&iw;6i;'@€ý;(I"«static VALUE rb_stat_r(VALUE obj) { struct stat *st = get_stat(obj); #ifdef USE_GETEUID if (geteuid() == 0) return Qtrue; #endif #ifdef S_IRUSR if (rb_stat_owned(obj)) return st->st_mode & S_IRUSR ? Qtrue : Qfalse; #endif #ifdef S_IRGRP if (rb_stat_grpowned(obj)) return st->st_mode & S_IRGRP ? Qtrue : Qfalse; #endif #ifdef S_IROTH if (!(st->st_mode & S_IROTH)) return Qfalse; #endif return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#readable_real?;T;[;[[@ci›;T;;l;0;[;{;IC;"Returns true if stat is readable by the real user id of this process. File.stat("testfile").readable_real? #=> true;T;[o;= ;3I" overload;F;40;;l;50;)I"readable_real?;T;IC;";T; @#;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @#;[;I"@return [Boolean];T;0;6i;[; @#;[;I"½Returns true if stat is readable by the real user id of this process. File.stat("testfile").readable_real? #=> true @overload readable_real? @return [Boolean];T;0; @#;!F;"o;#;$T;%i;&i˜;6i;'@€ý;(I"¼static VALUE rb_stat_R(VALUE obj) { struct stat *st = get_stat(obj); #ifdef USE_GETEUID if (getuid() == 0) return Qtrue; #endif #ifdef S_IRUSR if (rb_stat_rowned(obj)) return st->st_mode & S_IRUSR ? Qtrue : Qfalse; #endif #ifdef S_IRGRP if (rb_group_member(get_stat(obj)->st_gid)) return st->st_mode & S_IRGRP ? Qtrue : Qfalse; #endif #ifdef S_IROTH if (!(st->st_mode & S_IROTH)) return Qfalse; #endif return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#world_readable?;T;[;[[@ci¾;T;;k;0;[;{;IC;"KIf stat is readable by others, returns an integer representing the file permission bits of stat. Returns nil otherwise. The meaning of the bits is platform dependent; on Unix systems, see stat(2). m = File.stat("/etc/passwd").world_readable? #=> 420 sprintf("%o", m) #=> "644";T;[o;= ;3I" overload;F;40;;k;50;)I"world_readable?;T;IC;";T; @>;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @>;[;I"@return [Integer, nil];T;0;6i;[; @>;[;I"€If stat is readable by others, returns an integer representing the file permission bits of stat. Returns nil otherwise. The meaning of the bits is platform dependent; on Unix systems, see stat(2). m = File.stat("/etc/passwd").world_readable? #=> 420 sprintf("%o", m) #=> "644" @overload world_readable? @return [Integer, nil];T;0; @>;!F;"o;#;$T;%i±;&i»;6i;'@€ý;(I"ñstatic VALUE rb_stat_wr(VALUE obj) { #ifdef S_IROTH struct stat *st = get_stat(obj); if ((st->st_mode & (S_IROTH)) == S_IROTH) { return UINT2NUM(st->st_mode & (S_IRUGO|S_IWUGO|S_IXUGO)); } else { return Qnil; } #endif };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#writable?;T;[;[[@ci×;T;;r;0;[;{;IC;"Returns true if stat is writable by the effective user id of this process. File.stat("testfile").writable? #=> true;T;[o;= ;3I" overload;F;40;;r;50;)I"writable?;T;IC;";T; @Z;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Z;[;I"@return [Boolean];T;0;6i;[; @Z;[;I"¸Returns true if stat is writable by the effective user id of this process. File.stat("testfile").writable? #=> true @overload writable? @return [Boolean];T;0; @Z;!F;"o;#;$T;%iÌ;&iÔ;6i;'@€ý;(I"«static VALUE rb_stat_w(VALUE obj) { struct stat *st = get_stat(obj); #ifdef USE_GETEUID if (geteuid() == 0) return Qtrue; #endif #ifdef S_IWUSR if (rb_stat_owned(obj)) return st->st_mode & S_IWUSR ? Qtrue : Qfalse; #endif #ifdef S_IWGRP if (rb_stat_grpowned(obj)) return st->st_mode & S_IWGRP ? Qtrue : Qfalse; #endif #ifdef S_IWOTH if (!(st->st_mode & S_IWOTH)) return Qfalse; #endif return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#writable_real?;T;[;[[@ciø;T;;t;0;[;{;IC;"Returns true if stat is writable by the real user id of this process. File.stat("testfile").writable_real? #=> true;T;[o;= ;3I" overload;F;40;;t;50;)I"writable_real?;T;IC;";T; @u;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @u;[;I"@return [Boolean];T;0;6i;[; @u;[;I"½Returns true if stat is writable by the real user id of this process. File.stat("testfile").writable_real? #=> true @overload writable_real? @return [Boolean];T;0; @u;!F;"o;#;$T;%ií;&iõ;6i;'@€ý;(I"¼static VALUE rb_stat_W(VALUE obj) { struct stat *st = get_stat(obj); #ifdef USE_GETEUID if (getuid() == 0) return Qtrue; #endif #ifdef S_IWUSR if (rb_stat_rowned(obj)) return st->st_mode & S_IWUSR ? Qtrue : Qfalse; #endif #ifdef S_IWGRP if (rb_group_member(get_stat(obj)->st_gid)) return st->st_mode & S_IWGRP ? Qtrue : Qfalse; #endif #ifdef S_IWOTH if (!(st->st_mode & S_IWOTH)) return Qfalse; #endif return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#world_writable?;T;[;[[@ci;T;;s;0;[;{;IC;"GIf stat is writable by others, returns an integer representing the file permission bits of stat. Returns nil otherwise. The meaning of the bits is platform dependent; on Unix systems, see stat(2). m = File.stat("/tmp").world_writable? #=> 511 sprintf("%o", m) #=> "777";T;[o;= ;3I" overload;F;40;;s;50;)I"world_writable?;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @;[;I"@return [Integer, nil];T;0;6i;[; @;[;I"|If stat is writable by others, returns an integer representing the file permission bits of stat. Returns nil otherwise. The meaning of the bits is platform dependent; on Unix systems, see stat(2). m = File.stat("/tmp").world_writable? #=> 511 sprintf("%o", m) #=> "777" @overload world_writable? @return [Integer, nil];T;0; @;!F;"o;#;$T;%i;&i;6i;'@€ý;(I"ñstatic VALUE rb_stat_ww(VALUE obj) { #ifdef S_IROTH struct stat *st = get_stat(obj); if ((st->st_mode & (S_IWOTH)) == S_IWOTH) { return UINT2NUM(st->st_mode & (S_IRUGO|S_IWUGO|S_IXUGO)); } else { return Qnil; } #endif };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#executable?;T;[;[[@ci6;T;;a;0;[;{;IC;"ÿReturns true if stat is executable or if the operating system doesn't distinguish executable files from nonexecutable files. The tests are made using the effective owner of the process. File.stat("testfile").executable? #=> false;T;[o;= ;3I" overload;F;40;;a;50;)I"executable?;T;IC;";T; @¬;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @¬;[;I"@return [Boolean];T;0;6i;[; @¬;[;I",Returns true if stat is executable or if the operating system doesn't distinguish executable files from nonexecutable files. The tests are made using the effective owner of the process. File.stat("testfile").executable? #=> false @overload executable? @return [Boolean];T;0; @¬;!F;"o;#;$T;%i);&i3;6i;'@€ý;(I"Õstatic VALUE rb_stat_x(VALUE obj) { struct stat *st = get_stat(obj); #ifdef USE_GETEUID if (geteuid() == 0) { return st->st_mode & S_IXUGO ? Qtrue : Qfalse; } #endif #ifdef S_IXUSR if (rb_stat_owned(obj)) return st->st_mode & S_IXUSR ? Qtrue : Qfalse; #endif #ifdef S_IXGRP if (rb_stat_grpowned(obj)) return st->st_mode & S_IXGRP ? Qtrue : Qfalse; #endif #ifdef S_IXOTH if (!(st->st_mode & S_IXOTH)) return Qfalse; #endif return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I" File::Stat#executable_real?;T;[;[[@ciV;T;;b;0;[;{;IC;"USame as executable?, but tests using the real owner of the process.;T;[o;= ;3I" overload;F;40;;b;50;)I"executable_real?;T;IC;";T; @Ç;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Ç;[;I"@return [Boolean];T;0;6i;[; @Ç;[;I"Same as executable?, but tests using the real owner of the process. @overload executable_real? @return [Boolean];T;0; @Ç;!F;"o;#;$T;%iN;&iS;6i;'@€ý;(I"æstatic VALUE rb_stat_X(VALUE obj) { struct stat *st = get_stat(obj); #ifdef USE_GETEUID if (getuid() == 0) { return st->st_mode & S_IXUGO ? Qtrue : Qfalse; } #endif #ifdef S_IXUSR if (rb_stat_rowned(obj)) return st->st_mode & S_IXUSR ? Qtrue : Qfalse; #endif #ifdef S_IXGRP if (rb_group_member(get_stat(obj)->st_gid)) return st->st_mode & S_IXGRP ? Qtrue : Qfalse; #endif #ifdef S_IXOTH if (!(st->st_mode & S_IXOTH)) return Qfalse; #endif return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#file?;T;[;[[@ciy;T;;f;0;[;{;IC;"ŽReturns true if stat is a regular file (not a device file, pipe, socket, etc.). File.stat("testfile").file? #=> true;T;[o;= ;3I" overload;F;40;;f;50;)I" file?;T;IC;";T; @â;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @â;[;I"@return [Boolean];T;0;6i;[; @â;[;I"µReturns true if stat is a regular file (not a device file, pipe, socket, etc.). File.stat("testfile").file? #=> true @overload file? @return [Boolean];T;0; @â;!F;"o;#;$T;%in;&iv;6i;'@€ý;(I"tstatic VALUE rb_stat_f(VALUE obj) { if (S_ISREG(get_stat(obj)->st_mode)) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#zero?;T;[;[[@ci‹;T;;^;0;[;{;IC;"‰Returns true if stat is a zero-length file; false otherwise. File.stat("testfile").zero? #=> false;T;[o;= ;3I" overload;F;40;;^;50;)I" zero?;T;IC;";T; @ý;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ý;[;I"@return [Boolean];T;0;6i;[; @ý;[;I"°Returns true if stat is a zero-length file; false otherwise. File.stat("testfile").zero? #=> false @overload zero? @return [Boolean];T;0; @ý;!F;"o;#;$T;%i€;&iˆ;6i;'@€ý;(I"pstatic VALUE rb_stat_z(VALUE obj) { if (get_stat(obj)->st_size == 0) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#size?;T;[;[[@ciœ;T;;o;0;[;{;IC;"VReturns the size of stat in bytes. File.stat("testfile").size #=> 66;T;[o;= ;3I" overload;F;40;;¯;50;)I" size;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @;[;I"@return [Integer];T;0;6i;[; @;[;I"|Returns the size of stat in bytes. File.stat("testfile").size #=> 66 @overload size @return [Integer];T;0; @;!F;"o;#;$T;%i’;&i™;6i;'@€ý;(I"Šstatic VALUE rb_stat_s(VALUE obj) { off_t size = get_stat(obj)->st_size; if (size == 0) return Qnil; return OFFT2NUM(size); };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#owned?;T;[;[[@ciL;T;;i;0;[;{;IC;"ÈReturns true if the effective user id of the process is the same as the owner of stat. File.stat("testfile").owned? #=> true File.stat("/etc/passwd").owned? #=> false;T;[o;= ;3I" overload;F;40;;i;50;)I"owned?;T;IC;";T; @3;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @3;[;I"@return [Boolean];T;0;6i;[; @3;[;I"ðReturns true if the effective user id of the process is the same as the owner of stat. File.stat("testfile").owned? #=> true File.stat("/etc/passwd").owned? #=> false @overload owned? @return [Boolean];T;0; @3;!F;"o;#;$T;%i@;&iI;6i;'@€ý;(I"{static VALUE rb_stat_owned(VALUE obj) { if (get_stat(obj)->st_uid == geteuid()) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#grpowned?;T;[;[[@cif;T;;d;0;[;{;IC;"ðReturns true if the effective group id of the process is the same as the group id of stat. On Windows NT, returns false. File.stat("testfile").grpowned? #=> true File.stat("/etc/passwd").grpowned? #=> false;T;[o;= ;3I" overload;F;40;;d;50;)I"grpowned?;T;IC;";T; @N;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @N;[;I"@return [Boolean];T;0;6i;[; @N;[;I"Returns true if the effective group id of the process is the same as the group id of stat. On Windows NT, returns false. File.stat("testfile").grpowned? #=> true File.stat("/etc/passwd").grpowned? #=> false @overload grpowned? @return [Boolean];T;0; @N;!F;"o;#;$T;%iZ;⁣6i;'@€ý;(I"“static VALUE rb_stat_grpowned(VALUE obj) { #ifndef _WIN32 if (rb_group_member(get_stat(obj)->st_gid)) return Qtrue; #endif return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#pipe?;T;[;[[@ciÜ;T;;g;0;[;{;IC;"~Returns true if the operating system supports pipes and stat is a pipe; false otherwise.;T;[o;= ;3I" overload;F;40;;g;50;)I" pipe?;T;IC;";T; @i;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @i;[;I"@return [Boolean];T;0;6i;[; @i;[;I"ŸReturns true if the operating system supports pipes and stat is a pipe; false otherwise. @overload pipe? @return [Boolean];T;0; @i;!F;"o;#;$T;%iÔ;&iÙ;6i;'@€ý;(I"‡static VALUE rb_stat_p(VALUE obj) { #ifdef S_IFIFO if (S_ISFIFO(get_stat(obj)->st_mode)) return Qtrue; #endif return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#symlink?;T;[;[[@ciö;T;;q;0;[;{;IC;"©Returns true if stat is a symbolic link, false if it isn't or if the operating system doesn't support this feature. As File::stat automatically follows symbolic links, #symlink? will always be false for an object returned by File::stat. File.symlink("testfile", "alink") #=> 0 File.stat("alink").symlink? #=> false File.lstat("alink").symlink? #=> true;T;[o;= ;3I" overload;F;40;;q;50;)I" symlink?;T;IC;";T; @„;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @„;[;I"@return [Boolean];T;0;6i;[; @„;[;I"ÓReturns true if stat is a symbolic link, false if it isn't or if the operating system doesn't support this feature. As File::stat automatically follows symbolic links, #symlink? will always be false for an object returned by File::stat. File.symlink("testfile", "alink") #=> 0 File.stat("alink").symlink? #=> false File.lstat("alink").symlink? #=> true @overload symlink? @return [Boolean];T;0; @„;!F;"o;#;$T;%iæ;&ió;6i;'@€ý;(I"…static VALUE rb_stat_l(VALUE obj) { #ifdef S_ISLNK if (S_ISLNK(get_stat(obj)->st_mode)) return Qtrue; #endif return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#socket?;T;[;[[@ci;T;;h;0;[;{;IC;"»Returns true if stat is a socket, false if it isn't or if the operating system doesn't support this feature. File.stat("testfile").socket? #=> false;T;[o;= ;3I" overload;F;40;;h;50;)I"socket?;T;IC;";T; @Ÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Ÿ;[;I"@return [Boolean];T;0;6i;[; @Ÿ;[;I"äReturns true if stat is a socket, false if it isn't or if the operating system doesn't support this feature. File.stat("testfile").socket? #=> false @overload socket? @return [Boolean];T;0; @Ÿ;!F;"o;#;$T;%iÿ;&i;6i;'@€ý;(I"ˆstatic VALUE rb_stat_S(VALUE obj) { #ifdef S_ISSOCK if (S_ISSOCK(get_stat(obj)->st_mode)) return Qtrue; #endif return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#blockdev?;T;[;[[@ci";T;;_;0;[;{;IC;"ðReturns true if the file is a block device, false if it isn't or if the operating system doesn't support this feature. File.stat("testfile").blockdev? #=> false File.stat("/dev/hda1").blockdev? #=> true;T;[o;= ;3I" overload;F;40;;_;50;)I"blockdev?;T;IC;";T; @º;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @º;[;I"@return [Boolean];T;0;6i;[; @º;[;I"Returns true if the file is a block device, false if it isn't or if the operating system doesn't support this feature. File.stat("testfile").blockdev? #=> false File.stat("/dev/hda1").blockdev? #=> true @overload blockdev? @return [Boolean];T;0; @º;!F;"o;#;$T;%i;&i;6i;'@€ý;(I"†static VALUE rb_stat_b(VALUE obj) { #ifdef S_ISBLK if (S_ISBLK(get_stat(obj)->st_mode)) return Qtrue; #endif return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#chardev?;T;[;[[@ci8;T;;`;0;[;{;IC;"ÂReturns true if the file is a character device, false if it isn't or if the operating system doesn't support this feature. File.stat("/dev/tty").chardev? #=> true;T;[o;= ;3I" overload;F;40;;`;50;)I" chardev?;T;IC;";T; @Õ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Õ;[;I"@return [Boolean];T;0;6i;[; @Õ;[;I"ìReturns true if the file is a character device, false if it isn't or if the operating system doesn't support this feature. File.stat("/dev/tty").chardev? #=> true @overload chardev? @return [Boolean];T;0; @Õ;!F;"o;#;$T;%i,;&i5;6i;'@€ý;(I"ustatic VALUE rb_stat_c(VALUE obj) { if (S_ISCHR(get_stat(obj)->st_mode)) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#setuid?;T;[;[[@ci°;T;;m;0;[;{;IC;"ÖReturns true if stat has the set-user-id permission bit set, false if it doesn't or if the operating system doesn't support this feature. File.stat("/bin/su").setuid? #=> true;T;[o;= ;3I" overload;F;40;;m;50;)I"setuid?;T;IC;";T; @ð;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ð;[;I"@return [Boolean];T;0;6i;[; @ð;[;I"þReturns true if stat has the set-user-id permission bit set, false if it doesn't or if the operating system doesn't support this feature. File.stat("/bin/su").setuid? #=> true @overload setuid? @return [Boolean];T;0; @ð;!F;"o;#;$T;%i¥;&i;6i;'@€ý;(I"‰static VALUE rb_stat_suid(VALUE obj) { #ifdef S_ISUID if (get_stat(obj)->st_mode & S_ISUID) return Qtrue; #endif return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#setgid?;T;[;[[@ciÅ;T;;n;0;[;{;IC;"ÝReturns true if stat has the set-group-id permission bit set, false if it doesn't or if the operating system doesn't support this feature. File.stat("/usr/sbin/lpc").setgid? #=> true;T;[o;= ;3I" overload;F;40;;n;50;)I"setgid?;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @;[;I"@return [Boolean];T;0;6i;[; @;[;I"Returns true if stat has the set-group-id permission bit set, false if it doesn't or if the operating system doesn't support this feature. File.stat("/usr/sbin/lpc").setgid? #=> true @overload setgid? @return [Boolean];T;0; @;!F;"o;#;$T;%i¹;&iÂ;6i;'@€ý;(I"‰static VALUE rb_stat_sgid(VALUE obj) { #ifdef S_ISGID if (get_stat(obj)->st_mode & S_ISGID) return Qtrue; #endif return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"File::Stat#sticky?;T;[;[[@ciÚ;T;;p;0;[;{;IC;"ÈReturns true if stat has its sticky bit set, false if it doesn't or if the operating system doesn't support this feature. File.stat("testfile").sticky? #=> false;T;[o;= ;3I" overload;F;40;;p;50;)I"sticky?;T;IC;";T; @&;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @&;[;I"@return [Boolean];T;0;6i;[; @&;[;I"ñReturns true if stat has its sticky bit set, false if it doesn't or if the operating system doesn't support this feature. File.stat("testfile").sticky? #=> false @overload sticky? @return [Boolean];T;0; @&;!F;"o;#;$T;%iÎ;&i×;6i;'@€ý;(I"‹static VALUE rb_stat_sticky(VALUE obj) { #ifdef S_ISVTX if (get_stat(obj)->st_mode & S_ISVTX) return Qtrue; #endif return Qfalse; };T;)I"static VALUE;T;*T;A@€ý;BIC;[;A@€ý;CIC;[@j‡;A@€ý;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@cij[@ci6;T;: Stat;;K;;;[;{;IC;"´Objects of class File::Stat encapsulate common status information for File objects. The information is recorded at the moment the File::Stat object is created; changes made to the file after that point will not be reflected. File::Stat objects are returned by IO#stat, File::stat, File#lstat, and File::lstat. Many of these methods return platform-specific values, and not all values are meaningful on all systems. See also Kernel#test.;T;[;[;I"¶ Objects of class File::Stat encapsulate common status information for File objects. The information is recorded at the moment the File::Stat object is created; changes made to the file after that point will not be reflected. File::Stat objects are returned by IO#stat, File::stat, File#lstat, and File::lstat. Many of these methods return platform-specific values, and not all values are meaningful on all systems. See also Kernel#test. ;T;0; @€ý;!F;"o;#;$T;%ij;&ir;6i;'o;L;M0;N0;O0;: File;'@;Q@Öü;R0;I"File::Stat;T;S@]o;;F; ;F;;;I"File.directory?;F;[;[[@ýi ;T;;e;0;[;{;IC;"^Returns true if the named file is a directory, false otherwise.;T;[o;= ;3I" overload;F;40;;c;50;)I"exist?(file_name);T;IC;";T; @T;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @T;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @T;[;I"ŒReturns true if the named file is a directory, false otherwise. @overload exist?(file_name) @return [Boolean];T;0; @T;!F;"o;#;$T;%i ;&i ;6i;'@Öü;(I"(VALUE rb_file_directory_p(void) { };T;)I" VALUE;T;*To;;F; ;F;;;I"File.exist?;F;[[I" fname;T0;[[@ci;T;;c;0;[;{;IC;"›Return true if the named file exists. _file_name_ can be an IO object. "file exists" means that stat() or fstat() system call is successful.;T;[o;= ;3I" overload;F;40;;c;50;)I"exist?(file_name);T;IC;";T; @q;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @q;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @q;[;I"ÍReturn true if the named file exists. _file_name_ can be an IO object. "file exists" means that stat() or fstat() system call is successful. @overload exist?(file_name) @return [Boolean];T;0; @q;!F;"o;#;$T;%i;&i;6i;'@Öü;(I"static VALUE rb_file_exist_p(VALUE obj, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; return Qtrue; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.exists?;F;[[I" fname;T0;[[@ci';T;:exists?;0;[;{;IC;":nodoc:;T;[o;2 ;3I"return;F;4@|;0;5[@~; @;[;I":nodoc:;T;0; @;!F;"o;#;$T;%i&;&i&;6i;'@Öü;(I"“static VALUE rb_file_exists_p(VALUE obj, VALUE fname) { const char *s = "FileTest#exist?"; if (obj == rb_mFileTest) { s = "FileTest.exist?"; } else if (obj == rb_cFile || (RB_TYPE_P(obj, T_CLASS) && RTEST(rb_class_inherited_p(obj, rb_cFile)))) { s = "File.exist?"; } rb_warn_deprecated("%.*ss?", s, (int)(strlen(s)-1), s); return rb_file_exist_p(obj, fname); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.readable?;F;[[I" fname;T0;[[@ciB;T;;j;0;[;{;IC;"Returns true if the named file is readable by the effective user and group id of this process. See eaccess(3). Note that some OS-level security features may cause this to return true even though the file is not readable by the effective user/group.;T;[o;= ;3I" overload;F;40;;j;50;)I"readable?(file_name);T;IC;";T; @£;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @£;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @£;[;I";Returns true if the named file is readable by the effective user and group id of this process. See eaccess(3). Note that some OS-level security features may cause this to return true even though the file is not readable by the effective user/group. @overload readable?(file_name) @return [Boolean];T;0; @£;!F;"o;#;$T;%i7;&i?;6i;'@Öü;(I"static VALUE rb_file_readable_p(VALUE obj, VALUE fname) { if (rb_eaccess(fname, R_OK) < 0) return Qfalse; return Qtrue; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.readable_real?;F;[[I" fname;T0;[[@ciT;T;;l;0;[;{;IC;"ûReturns true if the named file is readable by the real user and group id of this process. See access(3). Note that some OS-level security features may cause this to return true even though the file is not readable by the real user/group.;T;[o;= ;3I" overload;F;40;;l;50;)I"readable_real?(file_name);T;IC;";T; @Â;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Â;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @Â;[;I"5Returns true if the named file is readable by the real user and group id of this process. See access(3). Note that some OS-level security features may cause this to return true even though the file is not readable by the real user/group. @overload readable_real?(file_name) @return [Boolean];T;0; @Â;!F;"o;#;$T;%iI;&iQ;6i;'@Öü;(I"…static VALUE rb_file_readable_real_p(VALUE obj, VALUE fname) { if (rb_access(fname, R_OK) < 0) return Qfalse; return Qtrue; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.world_readable?;F;[[I" fname;T0;[[@cis;T;;k;0;[;{;IC;"œIf file_name is readable by others, returns an integer representing the file permission bits of file_name. Returns nil otherwise. The meaning of the bits is platform dependent; on Unix systems, see stat(2). _file_name_ can be an IO object. File.world_readable?("/etc/passwd") #=> 420 m = File.world_readable?("/etc/passwd") sprintf("%o", m) #=> "644";T;[o;= ;3I" overload;F;40;;k;50;)I"world_readable?(file_name);T;IC;";T; @á;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @á;[;I"@return [Integer, nil];T;0;6i;[[I"file_name;T0; @á;[;I"ÜIf file_name is readable by others, returns an integer representing the file permission bits of file_name. Returns nil otherwise. The meaning of the bits is platform dependent; on Unix systems, see stat(2). _file_name_ can be an IO object. File.world_readable?("/etc/passwd") #=> 420 m = File.world_readable?("/etc/passwd") sprintf("%o", m) #=> "644" @overload world_readable?(file_name) @return [Integer, nil];T;0; @á;!F;"o;#;$T;%ic;&ip;6i;'@Öü;(I"static VALUE rb_file_world_readable_p(VALUE obj, VALUE fname) { #ifdef S_IROTH struct stat st; if (rb_stat(fname, &st) < 0) return Qnil; if ((st.st_mode & (S_IROTH)) == S_IROTH) { return UINT2NUM(st.st_mode & (S_IRUGO|S_IWUGO|S_IXUGO)); } #endif return Qnil; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.writable?;F;[[I" fname;T0;[[@ciŒ;T;;r;0;[;{;IC;"Returns true if the named file is writable by the effective user and group id of this process. See eaccess(3). Note that some OS-level security features may cause this to return true even though the file is not writable by the effective user/group.;T;[o;= ;3I" overload;F;40;;r;50;)I"writable?(file_name);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @;[;I";Returns true if the named file is writable by the effective user and group id of this process. See eaccess(3). Note that some OS-level security features may cause this to return true even though the file is not writable by the effective user/group. @overload writable?(file_name) @return [Boolean];T;0; @;!F;"o;#;$T;%i;&i‰;6i;'@Öü;(I"static VALUE rb_file_writable_p(VALUE obj, VALUE fname) { if (rb_eaccess(fname, W_OK) < 0) return Qfalse; return Qtrue; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.writable_real?;F;[[I" fname;T0;[[@ciž;T;;t;0;[;{;IC;"ûReturns true if the named file is writable by the real user and group id of this process. See access(3). Note that some OS-level security features may cause this to return true even though the file is not writable by the real user/group.;T;[o;= ;3I" overload;F;40;;t;50;)I"writable_real?(file_name);T;IC;";T; @ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ ;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @ ;[;I"5Returns true if the named file is writable by the real user and group id of this process. See access(3). Note that some OS-level security features may cause this to return true even though the file is not writable by the real user/group. @overload writable_real?(file_name) @return [Boolean];T;0; @ ;!F;"o;#;$T;%i“;&i›;6i;'@Öü;(I"…static VALUE rb_file_writable_real_p(VALUE obj, VALUE fname) { if (rb_access(fname, W_OK) < 0) return Qfalse; return Qtrue; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.world_writable?;F;[[I" fname;T0;[[@ciµ;T;;s;0;[;{;IC;"If file_name is writable by others, returns an integer representing the file permission bits of file_name. Returns nil otherwise. The meaning of the bits is platform dependent; on Unix systems, see stat(2). _file_name_ can be an IO object. File.world_writable?("/tmp") #=> 511 m = File.world_writable?("/tmp") sprintf("%o", m) #=> "777";T;[o;= ;3I" overload;F;40;;s;50;)I"world_writable?(file_name);T;IC;";T; @?;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @?;[;I"@return [Integer, nil];T;0;6i;[[I"file_name;T0; @?;[;I"ÏIf file_name is writable by others, returns an integer representing the file permission bits of file_name. Returns nil otherwise. The meaning of the bits is platform dependent; on Unix systems, see stat(2). _file_name_ can be an IO object. File.world_writable?("/tmp") #=> 511 m = File.world_writable?("/tmp") sprintf("%o", m) #=> "777" @overload world_writable?(file_name) @return [Integer, nil];T;0; @?;!F;"o;#;$T;%i¥;&i²;6i;'@Öü;(I"static VALUE rb_file_world_writable_p(VALUE obj, VALUE fname) { #ifdef S_IWOTH struct stat st; if (rb_stat(fname, &st) < 0) return Qnil; if ((st.st_mode & (S_IWOTH)) == S_IWOTH) { return UINT2NUM(st.st_mode & (S_IRUGO|S_IWUGO|S_IXUGO)); } #endif return Qnil; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.executable?;F;[[I" fname;T0;[[@ciÒ;T;;a;0;[;{;IC;"´Returns true if the named file is executable by the effective user and group id of this process. See eaccess(3). Windows does not support execute permissions separately from read permissions. On Windows, a file is only considered executable if it ends in .bat, .cmd, .com, or .exe. Note that some OS-level security features may cause this to return true even though the file is not executable by the effective user/group.;T;[o;= ;3I" overload;F;40;;a;50;)I"executable?(file_name);T;IC;";T; @_;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @_;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @_;[;I"ëReturns true if the named file is executable by the effective user and group id of this process. See eaccess(3). Windows does not support execute permissions separately from read permissions. On Windows, a file is only considered executable if it ends in .bat, .cmd, .com, or .exe. Note that some OS-level security features may cause this to return true even though the file is not executable by the effective user/group. @overload executable?(file_name) @return [Boolean];T;0; @_;!F;"o;#;$T;%iÃ;&iÏ;6i;'@Öü;(I"ƒstatic VALUE rb_file_executable_p(VALUE obj, VALUE fname) { if (rb_eaccess(fname, X_OK) < 0) return Qfalse; return Qtrue; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.executable_real?;F;[[I" fname;T0;[[@ciè;T;;b;0;[;{;IC;"©Returns true if the named file is executable by the real user and group id of this process. See access(3). Windows does not support execute permissions separately from read permissions. On Windows, a file is only considered executable if it ends in .bat, .cmd, .com, or .exe. Note that some OS-level security features may cause this to return true even though the file is not executable by the real user/group.;T;[o;= ;3I" overload;F;40;;b;50;)I" executable_real?(file_name);T;IC;";T; @~;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @~;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @~;[;I"åReturns true if the named file is executable by the real user and group id of this process. See access(3). Windows does not support execute permissions separately from read permissions. On Windows, a file is only considered executable if it ends in .bat, .cmd, .com, or .exe. Note that some OS-level security features may cause this to return true even though the file is not executable by the real user/group. @overload executable_real?(file_name) @return [Boolean];T;0; @~;!F;"o;#;$T;%iÙ;&iå;6i;'@Öü;(I"‡static VALUE rb_file_executable_real_p(VALUE obj, VALUE fname) { if (rb_access(fname, X_OK) < 0) return Qfalse; return Qtrue; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.file?;F;[[I" fname;T0;[[@ciÿ;T;;f;0;[;{;IC;"ÔReturns +true+ if the named +file+ exists and is a regular file. +file+ can be an IO object. If the +file+ argument is a symbolic link, it will resolve the symbolic link and use the file referenced by the link.;T;[o;= ;3I" overload;F;40;;f;50;)I"file?(file);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @;[;I"@return [Boolean];T;0;6i;[[I" file;T0; @;[;I"Returns +true+ if the named +file+ exists and is a regular file. +file+ can be an IO object. If the +file+ argument is a symbolic link, it will resolve the symbolic link and use the file referenced by the link. @overload file?(file) @return [Boolean];T;0; @;!F;"o;#;$T;%ió;&iü;6i;'@Öü;(I"ºstatic VALUE rb_file_file_p(VALUE obj, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (S_ISREG(st.st_mode)) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.zero?;F;[[I" fname;T0;[[@ci;T;;^;0;[;{;IC;"nReturns true if the named file exists and has a zero size. _file_name_ can be an IO object.;T;[o;= ;3I" overload;F;40;;^;50;)I"zero?(file_name);T;IC;";T; @¼;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @¼;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @¼;[;I"šReturns true if the named file exists and has a zero size. _file_name_ can be an IO object. @overload zero?(file_name) @return [Boolean];T;0; @¼;!F;"o;#;$T;%i ;&i;6i;'@Öü;(I"¶static VALUE rb_file_zero_p(VALUE obj, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (st.st_size == 0) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.empty?;F;[[I" fname;T0;[[@ci;T;;±;0;[;{;IC;"nReturns true if the named file exists and has a zero size. _file_name_ can be an IO object.;T;[o;= ;3I" overload;F;40;;^;50;)I"zero?(file_name);T;IC;";T; @Û;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Û;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @Û;[;@×;0; @Û;!F;"o;#;$T;%i ;&i;6i;'@Öü;(I"¶static VALUE rb_file_zero_p(VALUE obj, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (st.st_size == 0) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.size?;F;[[I" fname;T0;[[@ci';T;;o;0;[;{;IC;"~Returns +nil+ if +file_name+ doesn't exist or has zero size, the size of the file otherwise. _file_name_ can be an IO object.;T;[o;= ;3I" overload;F;40;;o;50;)I"size?(file_name);T;IC;";T; @ù;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI"nil;T; @ù;[;I"@return [Integer, nil];T;0;6i;[[I"file_name;T0; @ù;[;I"´Returns +nil+ if +file_name+ doesn't exist or has zero size, the size of the file otherwise. _file_name_ can be an IO object. @overload size?(file_name) @return [Integer, nil];T;0; @ù;!F;"o;#;$T;%i;&i$;6i;'@Öü;(I"Ástatic VALUE rb_file_size_p(VALUE obj, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) return Qnil; if (st.st_size == 0) return Qnil; return OFFT2NUM(st.st_size); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.size;F;[[I" fname;T0;[[@ciÙ;T;;¯;0;[;{;IC;"RReturns the size of file_name. _file_name_ can be an IO object. ;T;[o;= ;3I" overload;F;40;;¯;50;)I"size(file_name);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @;[;I"@return [Integer];T;0;6i;[[I"file_name;T0; @;[;I"}Returns the size of file_name. _file_name_ can be an IO object. @overload size(file_name) @return [Integer];T;0; @;!F;"o;#;$T;%iÐ;&iÖ;'@Öü;(I"ßstatic VALUE rb_file_s_size(VALUE klass, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) { int e = errno; FilePathValue(fname); rb_syserr_fail_path(e, fname); } return OFFT2NUM(st.st_size); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.owned?;F;[[I" fname;T0;[[@ci<;T;;i;0;[;{;IC;"ŸReturns true if the named file exists and the effective used id of the calling process is the owner of the file. _file_name_ can be an IO object.;T;[o;= ;3I" overload;F;40;;i;50;)I"owned?(file_name);T;IC;";T; @8;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @8;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @8;[;I"ÑReturns true if the named file exists and the effective used id of the calling process is the owner of the file. _file_name_ can be an IO object. @overload owned?(file_name) @return [Boolean];T;0; @8;!F;"o;#;$T;%i1;&i9;6i;'@Öü;(I"¾static VALUE rb_file_owned_p(VALUE obj, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (st.st_uid == geteuid()) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.grpowned?;F;[[I" fname;T0;[[@ci[;T;;d;0;[;{;IC;"ÇReturns true if the named file exists and the effective group id of the calling process is the owner of the file. Returns false on Windows. _file_name_ can be an IO object.;T;[o;= ;3I" overload;F;40;;d;50;)I"grpowned?(file_name);T;IC;";T; @W;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @W;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @W;[;I"üReturns true if the named file exists and the effective group id of the calling process is the owner of the file. Returns false on Windows. _file_name_ can be an IO object. @overload grpowned?(file_name) @return [Boolean];T;0; @W;!F;"o;#;$T;%iP;&iX;6i;'@Öü;(I"Ûstatic VALUE rb_file_grpowned_p(VALUE obj, VALUE fname) { #ifndef _WIN32 struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (rb_group_member(st.st_gid)) return Qtrue; #endif return Qfalse; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.pipe?;F;[[I" fname;T0;[[@ci„;T;;g;0;[;{;IC;"]Returns true if the named file is a pipe. _file_name_ can be an IO object.;T;[o;= ;3I" overload;F;40;;g;50;)I"pipe?(file_name);T;IC;";T; @v;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @v;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @v;[;I"‰Returns true if the named file is a pipe. _file_name_ can be an IO object. @overload pipe?(file_name) @return [Boolean];T;0; @v;!F;"o;#;$T;%i{;&i;6i;'@Öü;(I"#static VALUE rb_file_pipe_p(VALUE obj, VALUE fname) { #ifdef S_IFIFO # ifndef S_ISFIFO # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO) # endif struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (S_ISFIFO(st.st_mode)) return Qtrue; #endif return Qfalse; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.symlink?;F;[[I" fname;T0;[[@ciœ;T;;q;0;[;{;IC;"DReturns true if the named file is a symbolic link.;T;[o;= ;3I" overload;F;40;;q;50;)I"symlink?(file_name);T;IC;";T; @•;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @•;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @•;[;I"xReturns true if the named file is a symbolic link. @overload symlink?(file_name) @return [Boolean];T;0; @•;!F;"o;#;$T;%i•;&i™;6i;'@Öü;(I"Bstatic VALUE rb_file_symlink_p(VALUE obj, VALUE fname) { #ifndef S_ISLNK # ifdef _S_ISLNK # define S_ISLNK(m) _S_ISLNK(m) # else # ifdef _S_IFLNK # define S_ISLNK(m) (((m) & S_IFMT) == _S_IFLNK) # else # ifdef S_IFLNK # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK) # endif # endif # endif #endif #ifdef S_ISLNK struct stat st; FilePathValue(fname); fname = rb_str_encode_ospath(fname); if (lstat_without_gvl(StringValueCStr(fname), &st) < 0) return Qfalse; if (S_ISLNK(st.st_mode)) return Qtrue; #endif return Qfalse; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.socket?;F;[[I" fname;T0;[[@ciÂ;T;;h;0;[;{;IC;"_Returns true if the named file is a socket. _file_name_ can be an IO object.;T;[o;= ;3I" overload;F;40;;h;50;)I"socket?(file_name);T;IC;";T; @´;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @´;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @´;[;I"Returns true if the named file is a socket. _file_name_ can be an IO object. @overload socket?(file_name) @return [Boolean];T;0; @´;!F;"o;#;$T;%i¹;&i¿;6i;'@Öü;(I"ïstatic VALUE rb_file_socket_p(VALUE obj, VALUE fname) { #ifndef S_ISSOCK # ifdef _S_ISSOCK # define S_ISSOCK(m) _S_ISSOCK(m) # else # ifdef _S_IFSOCK # define S_ISSOCK(m) (((m) & S_IFMT) == _S_IFSOCK) # else # ifdef S_IFSOCK # define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK) # endif # endif # endif #endif #ifdef S_ISSOCK struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (S_ISSOCK(st.st_mode)) return Qtrue; #endif return Qfalse; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.blockdev?;F;[[I" fname;T0;[[@ciæ;T;;_;0;[;{;IC;"eReturns true if the named file is a block device. _file_name_ can be an IO object.;T;[o;= ;3I" overload;F;40;;_;50;)I"blockdev?(file_name);T;IC;";T; @Ó;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Ó;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @Ó;[;I"•Returns true if the named file is a block device. _file_name_ can be an IO object. @overload blockdev?(file_name) @return [Boolean];T;0; @Ó;!F;"o;#;$T;%iÝ;&iã;6i;'@Öü;(I"ostatic VALUE rb_file_blockdev_p(VALUE obj, VALUE fname) { #ifndef S_ISBLK # ifdef S_IFBLK # define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK) # else # define S_ISBLK(m) (0) /* anytime false */ # endif #endif #ifdef S_ISBLK struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (S_ISBLK(st.st_mode)) return Qtrue; #endif return Qfalse; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.chardev?;F;[[I" fname;T0;[[@ci;T;;`;0;[;{;IC;"iReturns true if the named file is a character device. _file_name_ can be an IO object.;T;[o;= ;3I" overload;F;40;;`;50;)I"chardev?(file_name);T;IC;";T; @ò;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ò;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @ò;[;I"˜Returns true if the named file is a character device. _file_name_ can be an IO object. @overload chardev?(file_name) @return [Boolean];T;0; @ò;!F;"o;#;$T;%iû;&i;6i;'@Öü;(I"static VALUE rb_file_chardev_p(VALUE obj, VALUE fname) { #ifndef S_ISCHR # define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR) #endif struct stat st; if (rb_stat(fname, &st) < 0) return Qfalse; if (S_ISCHR(st.st_mode)) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.setuid?;F;[[I" fname;T0;[[@ci|;T;;m;0;[;{;IC;"jReturns true if the named file has the setuid bit set. _file_name_ can be an IO object.;T;[o;= ;3I" overload;F;40;;m;50;)I"setuid?(file_name);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @;[;I"˜Returns true if the named file has the setuid bit set. _file_name_ can be an IO object. @overload setuid?(file_name) @return [Boolean];T;0; @;!F;"o;#;$T;%is;&iy;6i;'@Öü;(I"static VALUE rb_file_suid_p(VALUE obj, VALUE fname) { #ifdef S_ISUID return check3rdbyte(fname, S_ISUID); #else return Qfalse; #endif };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.setgid?;F;[[I" fname;T0;[[@ci;T;;n;0;[;{;IC;"jReturns true if the named file has the setgid bit set. _file_name_ can be an IO object.;T;[o;= ;3I" overload;F;40;;n;50;)I"setgid?(file_name);T;IC;";T; @0;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @0;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @0;[;I"˜Returns true if the named file has the setgid bit set. _file_name_ can be an IO object. @overload setgid?(file_name) @return [Boolean];T;0; @0;!F;"o;#;$T;%i†;&iŒ;6i;'@Öü;(I"static VALUE rb_file_sgid_p(VALUE obj, VALUE fname) { #ifdef S_ISGID return check3rdbyte(fname, S_ISGID); #else return Qfalse; #endif };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.sticky?;F;[[I" fname;T0;[[@ci¢;T;;p;0;[;{;IC;"jReturns true if the named file has the sticky bit set. _file_name_ can be an IO object.;T;[o;= ;3I" overload;F;40;;p;50;)I"sticky?(file_name);T;IC;";T; @O;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @O;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @O;[;I"˜Returns true if the named file has the sticky bit set. _file_name_ can be an IO object. @overload sticky?(file_name) @return [Boolean];T;0; @O;!F;"o;#;$T;%i™;&iŸ;6i;'@Öü;(I"‘static VALUE rb_file_sticky_p(VALUE obj, VALUE fname) { #ifdef S_ISVTX return check3rdbyte(fname, S_ISVTX); #else return Qfalse; #endif };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.identical?;F;[[I"fname1;T0[I"fname2;T0;[[@ci¿;T;:identical?;0;[;{;IC;"®Returns true if the named files are identical. _file_1_ and _file_2_ can be an IO object. open("a", "w") {} p File.identical?("a", "a") #=> true p File.identical?("a", "./a") #=> true File.link("a", "b") p File.identical?("a", "b") #=> true File.symlink("a", "c") p File.identical?("a", "c") #=> true open("d", "w") {} p File.identical?("a", "d") #=> false;T;[o;= ;3I" overload;F;40;;û;50;)I"identical?(file_1, file_2);T;IC;";T; @n;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @n;[;I"@return [Boolean];T;0;6i;[[I"file_1;T0[I"file_2;T0; @n;[;I"éReturns true if the named files are identical. _file_1_ and _file_2_ can be an IO object. open("a", "w") {} p File.identical?("a", "a") #=> true p File.identical?("a", "./a") #=> true File.link("a", "b") p File.identical?("a", "b") #=> true File.symlink("a", "c") p File.identical?("a", "c") #=> true open("d", "w") {} p File.identical?("a", "d") #=> false @overload identical?(file_1, file_2) @return [Boolean];T;0; @n;!F;"o;#;$T;%i¬;&i¼;6i;'@Öü;(I"Æstatic VALUE rb_file_identical_p(VALUE obj, VALUE fname1, VALUE fname2) { #ifndef _WIN32 struct stat st1, st2; if (rb_stat(fname1, &st1) < 0) return Qfalse; if (rb_stat(fname2, &st2) < 0) return Qfalse; if (st1.st_dev != st2.st_dev) return Qfalse; if (st1.st_ino != st2.st_ino) return Qfalse; return Qtrue; #else extern VALUE rb_w32_file_identical_p(VALUE, VALUE); return rb_w32_file_identical_p(fname1, fname2); #endif };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.stat;F;[[I" fname;T0;[[@ciA;T;;W;0;[;{;IC;"ƒReturns a File::Stat object for the named file (see File::Stat). File.stat("testfile").mtime #=> Tue Apr 08 12:58:04 CDT 2003 ;T;[o;= ;3I" overload;F;40;;W;50;)I"stat(file_name);T;IC;";T; @‘;>0;!F;[;[;I";T;0;6i;[[I"file_name;T0; @‘;[;I" Returns a File::Stat object for the named file (see File::Stat). File.stat("testfile").mtime #=> Tue Apr 08 12:58:04 CDT 2003 @overload stat(file_name);T;0; @‘;!F;"o;#;$T;%i7;&i=;'@Öü;(I"static VALUE rb_file_s_stat(VALUE klass, VALUE fname) { struct stat st; FilePathValue(fname); fname = rb_str_encode_ospath(fname); if (stat_without_gvl(RSTRING_PTR(fname), &st) < 0) { rb_sys_fail_path(fname); } return rb_stat_new(&st); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.lstat;F;[[I" fname;T0;[[@ci;T;;X;0;[;{;IC;"+Same as File::stat, but does not follow the last symbolic link. Instead, reports on the link itself. File.symlink("testfile", "link2test") #=> 0 File.stat("testfile").size #=> 66 File.lstat("link2test").size #=> 8 File.stat("link2test").size #=> 66 ;T;[o;= ;3I" overload;F;40;;X;50;)I"lstat(file_name);T;IC;";T; @«;>0;!F;[;[;I";T;0;6i;[[I"file_name;T0; @«;[;I"ISame as File::stat, but does not follow the last symbolic link. Instead, reports on the link itself. File.symlink("testfile", "link2test") #=> 0 File.stat("testfile").size #=> 66 File.lstat("link2test").size #=> 8 File.stat("link2test").size #=> 66 @overload lstat(file_name);T;0; @«;!F;"o;#;$T;%i;&i‰;'@Öü;(I"Wstatic VALUE rb_file_s_lstat(VALUE klass, VALUE fname) { #ifdef HAVE_LSTAT struct stat st; FilePathValue(fname); fname = rb_str_encode_ospath(fname); if (lstat_without_gvl(StringValueCStr(fname), &st) == -1) { rb_sys_fail_path(fname); } return rb_stat_new(&st); #else return rb_file_s_stat(klass, fname); #endif };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.ftype;F;[[I" fname;T0;[[@ci ;T;;S;0;[;{;IC;"ºIdentifies the type of the named file; the return string is one of ``file'', ``directory'', ``characterSpecial'', ``blockSpecial'', ``fifo'', ``link'', ``socket'', or ``unknown''. File.ftype("testfile") #=> "file" File.ftype("/dev/tty") #=> "characterSpecial" File.ftype("/tmp/.X11-unix/X0") #=> "socket" ;T;[o;= ;3I" overload;F;40;;S;50;)I"ftype(file_name);T;IC;";T; @Å;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Å;[;I"@return [String];T;0;6i;[[I"file_name;T0; @Å;[;I"êIdentifies the type of the named file; the return string is one of ``file'', ``directory'', ``characterSpecial'', ``blockSpecial'', ``fifo'', ``link'', ``socket'', or ``unknown''. File.ftype("testfile") #=> "file" File.ftype("/dev/tty") #=> "characterSpecial" File.ftype("/tmp/.X11-unix/X0") #=> "socket" @overload ftype(file_name) @return [String];T;0; @Å;!F;"o;#;$T;%i ;&i ;'@Öü;(I"static VALUE rb_file_s_ftype(VALUE klass, VALUE fname) { struct stat st; FilePathValue(fname); fname = rb_str_encode_ospath(fname); if (lstat_without_gvl(StringValueCStr(fname), &st) == -1) { rb_sys_fail_path(fname); } return rb_file_ftype(&st); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.atime;F;[[I" fname;T0;[[@ci8 ;T;;J;0;[;{;IC;"¡Returns the last access time for the named file as a Time object. _file_name_ can be an IO object. File.atime("testfile") #=> Wed Apr 09 08:51:48 CDT 2003 ;T;[o;= ;3I" overload;F;40;;J;50;)I"atime(file_name);T;IC;";T; @ä;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Time;T; @ä;[;I"@return [Time];T;0;6i;[[I"file_name;T0; @ä;[;I"ÐReturns the last access time for the named file as a Time object. _file_name_ can be an IO object. File.atime("testfile") #=> Wed Apr 09 08:51:48 CDT 2003 @overload atime(file_name) @return [Time];T;0; @ä;!F;"o;#;$T;%i, ;&i5 ;'@Öü;(I"Ûstatic VALUE rb_file_s_atime(VALUE klass, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) { int e = errno; FilePathValue(fname); rb_syserr_fail_path(e, fname); } return stat_atime(&st); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.mtime;F;[[I" fname;T0;[[@cii ;T;;ü;0;[;{;IC;"¢Returns the modification time for the named file as a Time object. _file_name_ can be an IO object. File.mtime("testfile") #=> Tue Apr 08 12:58:04 CDT 2003 ;T;[o;= ;3I" overload;F;40;;ü;50;)I"mtime(file_name);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Time;T; @;[;I"@return [Time];T;0;6i;[[I"file_name;T0; @;[;I"ÑReturns the modification time for the named file as a Time object. _file_name_ can be an IO object. File.mtime("testfile") #=> Tue Apr 08 12:58:04 CDT 2003 @overload mtime(file_name) @return [Time];T;0; @;!F;"o;#;$T;%i] ;&if ;'@Öü;(I"Ûstatic VALUE rb_file_s_mtime(VALUE klass, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) { int e = errno; FilePathValue(fname); rb_syserr_fail_path(e, fname); } return stat_mtime(&st); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.ctime;F;[[I" fname;T0;[[@ci ;T;;L;0;[;{;IC;"'Returns the change time for the named file (the time at which directory information about the file was changed, not the file itself). _file_name_ can be an IO object. Note that on Windows (NTFS), returns creation time (birth time). File.ctime("testfile") #=> Wed Apr 09 08:53:13 CDT 2003 ;T;[o;= ;3I" overload;F;40;;L;50;)I"ctime(file_name);T;IC;";T; @";>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Time;T; @";[;I"@return [Time];T;0;6i;[[I"file_name;T0; @";[;I"VReturns the change time for the named file (the time at which directory information about the file was changed, not the file itself). _file_name_ can be an IO object. Note that on Windows (NTFS), returns creation time (birth time). File.ctime("testfile") #=> Wed Apr 09 08:53:13 CDT 2003 @overload ctime(file_name) @return [Time];T;0; @";!F;"o;#;$T;%i ;&iš ;'@Öü;(I"Ûstatic VALUE rb_file_s_ctime(VALUE klass, VALUE fname) { struct stat st; if (rb_stat(fname, &st) < 0) { int e = errno; FilePathValue(fname); rb_syserr_fail_path(e, fname); } return stat_ctime(&st); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.birthtime;F;[[I" fname;T0;[[@ciÓ ;T;;K;0;[;{;IC;";T;[;[;@|;0; @A;'@Öü;(I"RUBY_FUNC_EXPORTED VALUE rb_file_s_birthtime(VALUE klass, VALUE fname) { statx_data st; if (rb_statx(fname, &st, STATX_BTIME) < 0) { int e = errno; FilePathValue(fname); rb_syserr_fail_path(e, fname); } return statx_birthtime(&st, fname); };T;)I"RUBY_FUNC_EXPORTED VALUE;T;*To;;F; ;F;;;I"File.utime;F;[[@c0;[[@ciª;T;;Z;0;[;{;IC;"Sets the access and modification times of each named file to the first two arguments. If a file is a symlink, this method acts upon its referent rather than the link itself; for the inverse behavior see File.lutime. Returns the number of file names in the argument list. ;T;[o;= ;3I" overload;F;40;;Z;50;)I"(utime(atime, mtime, file_name, ...);T;IC;";T; @O;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @O;[;I"@return [Integer];T;0;6i;[ [I" atime;T0[I" mtime;T0[I"file_name;T0[I"...;T0; @O;[;I"RSets the access and modification times of each named file to the first two arguments. If a file is a symlink, this method acts upon its referent rather than the link itself; for the inverse behavior see File.lutime. Returns the number of file names in the argument list. @overload utime(atime, mtime, file_name, ...) @return [Integer];T;0; @O;!F;"o;#;$T;%iŸ;&i§;'@Öü;(I"ustatic VALUE rb_file_s_utime(int argc, VALUE *argv, VALUE _) { return utime_internal_i(argc, argv, FALSE); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.chmod;F;[[@c0;[[@ci- ;T;;M;0;[;{;IC;"AChanges permission bits on the named file(s) to the bit pattern represented by mode_int. Actual effects are operating system dependent (see the beginning of this section). On Unix systems, see chmod(2) for details. Returns the number of files processed. File.chmod(0644, "testfile", "out") #=> 2 ;T;[o;= ;3I" overload;F;40;;M;50;)I"%chmod(mode_int, file_name, ... );T;IC;";T; @s;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @s;[;I"@return [Integer];T;0;6i;[[I" mode_int;T0[I"file_name;T0[I"...;T0; @s;[;I"‚Changes permission bits on the named file(s) to the bit pattern represented by mode_int. Actual effects are operating system dependent (see the beginning of this section). On Unix systems, see chmod(2) for details. Returns the number of files processed. File.chmod(0644, "testfile", "out") #=> 2 @overload chmod(mode_int, file_name, ... ) @return [Integer];T;0; @s;!F;"o;#;$T;%i ;&i* ;'@Öü;(I"Àstatic VALUE rb_file_s_chmod(int argc, VALUE *argv, VALUE _) { mode_t mode; apply2args(1); mode = NUM2MODET(*argv++); return apply2files(chmod_internal, argc, argv, &mode); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.chown;F;[[@c0;[[@ci° ;T;;O;0;[;{;IC;"ˆChanges the owner and group of the named file(s) to the given numeric owner and group id's. Only a process with superuser privileges may change the owner of a file. The current owner of a file may change the file's group to any group to which the owner belongs. A nil or -1 owner or group id is ignored. Returns the number of files processed. File.chown(nil, 100, "testfile") ;T;[o;= ;3I" overload;F;40;;O;50;)I"0chown(owner_int, group_int, file_name, ...);T;IC;";T; @•;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @•;[;I"@return [Integer];T;0;6i;[ [I"owner_int;T0[I"group_int;T0[I"file_name;T0[I"...;T0; @•;[;I"ÕChanges the owner and group of the named file(s) to the given numeric owner and group id's. Only a process with superuser privileges may change the owner of a file. The current owner of a file may change the file's group to any group to which the owner belongs. A nil or -1 owner or group id is ignored. Returns the number of files processed. File.chown(nil, 100, "testfile") @overload chown(owner_int, group_int, file_name, ...) @return [Integer];T;0; @•;!F;"o;#;$T;%i¡ ;&i ;'@Öü;(I"ìstatic VALUE rb_file_s_chown(int argc, VALUE *argv, VALUE _) { struct chown_args arg; apply2args(2); arg.owner = to_uid(*argv++); arg.group = to_gid(*argv++); return apply2files(chown_internal, argc, argv, &arg); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.lchmod;F;[[@c0;[[@ciu ;T;;N;0;[;{;IC;"µEquivalent to File::chmod, but does not follow symbolic links (so it will change the permissions associated with the link, not the file referenced by the link). Often not available. ;T;[o;= ;3I" overload;F;40;;N;50;)I"%lchmod(mode_int, file_name, ...);T;IC;";T; @¹;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¹;[;I"@return [Integer];T;0;6i;[[I" mode_int;T0[I"file_name;T0[I"...;T0; @¹;[;I"÷Equivalent to File::chmod, but does not follow symbolic links (so it will change the permissions associated with the link, not the file referenced by the link). Often not available. @overload lchmod(mode_int, file_name, ...) @return [Integer];T;0; @¹;!F;"o;#;$T;%ik ;&ir ;'@Öü;(I"Âstatic VALUE rb_file_s_lchmod(int argc, VALUE *argv, VALUE _) { mode_t mode; apply2args(1); mode = NUM2MODET(*argv++); return apply2files(lchmod_internal, argc, argv, &mode); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.lchown;F;[[@c0;[[@ciø ;T;;P;0;[;{;IC;"ÝEquivalent to File::chown, but does not follow symbolic links (so it will change the owner associated with the link, not the file referenced by the link). Often not available. Returns number of files in the argument list. ;T;[o;= ;3I" overload;F;40;;P;50;)I"/lchown(owner_int, group_int, file_name,..);T;IC;";T; @Û;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Û;[;I"@return [Integer];T;0;6i;[ [I"owner_int;T0[I"group_int;T0[I"file_name;T0[I"..;T0; @Û;[;I")Equivalent to File::chown, but does not follow symbolic links (so it will change the owner associated with the link, not the file referenced by the link). Often not available. Returns number of files in the argument list. @overload lchown(owner_int, group_int, file_name,..) @return [Integer];T;0; @Û;!F;"o;#;$T;%ií ;&iõ ;'@Öü;(I"îstatic VALUE rb_file_s_lchown(int argc, VALUE *argv, VALUE _) { struct chown_args arg; apply2args(2); arg.owner = to_uid(*argv++); arg.group = to_gid(*argv++); return apply2files(lchown_internal, argc, argv, &arg); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.lutime;F;[[@c0;[[@ci½;T;:lutime;0;[;{;IC;"Sets the access and modification times of each named file to the first two arguments. If a file is a symlink, this method acts upon the link itself as opposed to its referent; for the inverse behavior, see File.utime. Returns the number of file names in the argument list. ;T;[o;= ;3I" overload;F;40;;ü;50;)I")lutime(atime, mtime, file_name, ...);T;IC;";T; @ÿ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ÿ;[;I"@return [Integer];T;0;6i;[ [I" atime;T0[I" mtime;T0[I"file_name;T0[I"...;T0; @ÿ;[;I"USets the access and modification times of each named file to the first two arguments. If a file is a symlink, this method acts upon the link itself as opposed to its referent; for the inverse behavior, see File.utime. Returns the number of file names in the argument list. @overload lutime(atime, mtime, file_name, ...) @return [Integer];T;0; @ÿ;!F;"o;#;$T;%i²;&iº;'@Öü;(I"ustatic VALUE rb_file_s_lutime(int argc, VALUE *argv, VALUE _) { return utime_internal_i(argc, argv, TRUE); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.link;F;[[I" from;T0[I"to;T0;[[@ció;T;: link;0;[;{;IC;"+Creates a new name for an existing file using a hard link. Will not overwrite new_name if it already exists (raising a subclass of SystemCallError). Not available on all platforms. File.link("testfile", ".testfile") #=> 0 IO.readlines(".testfile")[0] #=> "This is line one\n" ;T;[o;= ;3I" overload;F;40;;ý;50;)I"link(old_name, new_name);T;IC;";T; @#;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @#;[;I"@return [0];T;0;6i;[[I" old_name;T0[I" new_name;T0; @#;[;I"^Creates a new name for an existing file using a hard link. Will not overwrite new_name if it already exists (raising a subclass of SystemCallError). Not available on all platforms. File.link("testfile", ".testfile") #=> 0 IO.readlines(".testfile")[0] #=> "This is line one\n" @overload link(old_name, new_name) @return [0];T;0; @#;!F;"o;#;$T;%iç;&ið;'@Öü;(I"0static VALUE rb_file_s_link(VALUE klass, VALUE from, VALUE to) { FilePathValue(from); FilePathValue(to); from = rb_str_encode_ospath(from); to = rb_str_encode_ospath(to); if (link(StringValueCStr(from), StringValueCStr(to)) < 0) { sys_fail2(from, to); } return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.symlink;F;[[I" from;T0[I"to;T0;[[@ci;T;:symlink;0;[;{;IC;"ÚCreates a symbolic link called new_name for the existing file old_name. Raises a NotImplemented exception on platforms that do not support symbolic links. File.symlink("testfile", "link2test") #=> 0 ;T;[o;= ;3I" overload;F;40;;þ;50;)I" symlink(old_name, new_name);T;IC;";T; @F;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @F;[;I"@return [0];T;0;6i;[[I" old_name;T0[I" new_name;T0; @F;[;I"Creates a symbolic link called new_name for the existing file old_name. Raises a NotImplemented exception on platforms that do not support symbolic links. File.symlink("testfile", "link2test") #=> 0 @overload symlink(old_name, new_name) @return [0];T;0; @F;!F;"o;#;$T;%i;&i;'@Öü;(I"6static VALUE rb_file_s_symlink(VALUE klass, VALUE from, VALUE to) { FilePathValue(from); FilePathValue(to); from = rb_str_encode_ospath(from); to = rb_str_encode_ospath(to); if (symlink(StringValueCStr(from), StringValueCStr(to)) < 0) { sys_fail2(from, to); } return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.readlink;F;[[I" path;T0;[[@ci.;T;;U;0;[;{;IC;"ÆReturns the name of the file referenced by the given link. Not available on all platforms. File.symlink("testfile", "link2test") #=> 0 File.readlink("link2test") #=> "testfile" ;T;[o;= ;3I" overload;F;40;;U;50;)I"readlink(link_name);T;IC;";T; @i;>0;!F;[;[;I";T;0;6i;[[I"link_name;T0; @i;[;I"æReturns the name of the file referenced by the given link. Not available on all platforms. File.symlink("testfile", "link2test") #=> 0 File.readlink("link2test") #=> "testfile" @overload readlink(link_name);T;0; @i;!F;"o;#;$T;%i#;&i*;'@Öü;(I"ystatic VALUE rb_file_s_readlink(VALUE klass, VALUE path) { return rb_readlink(path, rb_filesystem_encoding()); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.unlink;F;[[@c0;[[@ci‡;T;;{;0;[;{;IC;"aDeletes the named files, returning the number of names passed as arguments. Raises an exception on any error. Since the underlying implementation relies on the unlink(2) system call, the type of exception raised depends on its error type (see https://linux.die.net/man/2/unlink) and has the form of e.g. Errno::ENOENT. See also Dir::rmdir. ;T;[o;= ;3I" overload;F;40;;½;50;)I"delete(file_name, ...);T;IC;";T; @ƒ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ƒ;[;I"@return [Integer];T;0;6i;[[I"file_name;T0[I"...;T0; @ƒo;= ;3I" overload;F;40;;{;50;)I"unlink(file_name, ...);T;IC;";T; @ƒ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ƒ;[;I"@return [Integer];T;0;6i;[[I"file_name;T0[I"...;T0; @ƒ;[;I"ÍDeletes the named files, returning the number of names passed as arguments. Raises an exception on any error. Since the underlying implementation relies on the unlink(2) system call, the type of exception raised depends on its error type (see https://linux.die.net/man/2/unlink) and has the form of e.g. Errno::ENOENT. See also Dir::rmdir. @overload delete(file_name, ...) @return [Integer] @overload unlink(file_name, ...) @return [Integer];T;0; @ƒ;!F;"o;#;$T;%iw;&i…;'@Öü;(I"}static VALUE rb_file_s_unlink(int argc, VALUE *argv, VALUE klass) { return apply2files(unlink_internal, argc, argv, 0); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.delete;F;[[@c0;[[@ci‡;T;;½;0;[;{;IC;"aDeletes the named files, returning the number of names passed as arguments. Raises an exception on any error. Since the underlying implementation relies on the unlink(2) system call, the type of exception raised depends on its error type (see https://linux.die.net/man/2/unlink) and has the form of e.g. Errno::ENOENT. See also Dir::rmdir. ;T;[o;= ;3I" overload;F;40;;½;50;)I"delete(file_name, ...);T;IC;";T; @´;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @´;[;I"@return [Integer];T;0;6i;[[I"file_name;T0[I"...;T0; @´o;= ;3I" overload;F;40;;{;50;)I"unlink(file_name, ...);T;IC;";T; @´;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @´;[;I"@return [Integer];T;0;6i;[[I"file_name;T0[I"...;T0; @´;[;@°;0; @´;!F;"o;#;$T;%iw;&i…;'@Öü;(I"}static VALUE rb_file_s_unlink(int argc, VALUE *argv, VALUE klass) { return apply2files(unlink_internal, argc, argv, 0); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.rename;F;[[I" from;T0[I"to;T0;[[@ci¤;T;;V;0;[;{;IC;"Renames the given file to the new name. Raises a SystemCallError if the file cannot be renamed. File.rename("afile", "afile.bak") #=> 0 ;T;[o;= ;3I" overload;F;40;;V;50;)I"rename(old_name, new_name);T;IC;";T; @ä;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @ä;[;I"@return [0];T;0;6i;[[I" old_name;T0[I" new_name;T0; @ä;[;I"ÂRenames the given file to the new name. Raises a SystemCallError if the file cannot be renamed. File.rename("afile", "afile.bak") #=> 0 @overload rename(old_name, new_name) @return [0];T;0; @ä;!F;"o;#;$T;%iš;&i¡;'@Öü;(I"¬static VALUE rb_file_s_rename(VALUE klass, VALUE from, VALUE to) { struct rename_args ra; VALUE f, t; FilePathValue(from); FilePathValue(to); f = rb_str_encode_ospath(from); t = rb_str_encode_ospath(to); ra.src = StringValueCStr(f); ra.dst = StringValueCStr(t); #if defined __CYGWIN__ errno = 0; #endif if ((int)(VALUE)rb_thread_call_without_gvl(no_gvl_rename, &ra, RUBY_UBF_IO, 0) < 0) { int e = errno; #if defined DOSISH switch (e) { case EEXIST: if (chmod(ra.dst, 0666) == 0 && unlink(ra.dst) == 0 && rename(ra.src, ra.dst) == 0) return INT2FIX(0); } #endif syserr_fail2(e, from, to); } return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.umask;F;[[@c0;[[@ciÔ;T;: umask;0;[;{;IC;"VReturns the current umask value for this process. If the optional argument is given, set the umask to that value and return the previous value. Umask values are subtracted from the default permissions, so a umask of 0222 would make a file read-only for everyone. File.umask(0006) #=> 18 File.umask #=> 6 ;T;[o;= ;3I" overload;F;40;;ÿ;50;)I"umask();T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @;[;I"@return [Integer];T;0;6i;[; @o;= ;3I" overload;F;40;;ÿ;50;)I"umask(integer);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @;[;I"@return [Integer];T;0;6i;[[I"integer;T0; @;[;I"«Returns the current umask value for this process. If the optional argument is given, set the umask to that value and return the previous value. Umask values are subtracted from the default permissions, so a umask of 0222 would make a file read-only for everyone. File.umask(0006) #=> 18 File.umask #=> 6 @overload umask() @return [Integer] @overload umask(integer) @return [Integer];T;0; @;!F;"o;#;$T;%iÅ;&iÒ;'@Öü;(I"Astatic VALUE rb_file_s_umask(int argc, VALUE *argv, VALUE _) { mode_t omask = 0; switch (argc) { case 0: omask = umask(0); umask(omask); break; case 1: omask = umask(NUM2MODET(argv[0])); break; default: rb_error_arity(argc, 0, 1); } return MODET2NUM(omask); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.truncate;F;[[I" path;T0[I"len;T0;[[@ciÂ;T;;c;0;[;{;IC;"Truncates the file file_name to be at most integer bytes long. Not available on all platforms. f = File.new("out", "w") f.write("1234567890") #=> 10 f.close #=> nil File.truncate("out", 5) #=> 0 File.size("out") #=> 5 ;T;[o;= ;3I" overload;F;40;;c;50;)I"!truncate(file_name, integer);T;IC;";T; @2;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @2;[;I"@return [0];T;0;6i;[[I"file_name;T0[I"integer;T0; @2;[;I"PTruncates the file file_name to be at most integer bytes long. Not available on all platforms. f = File.new("out", "w") f.write("1234567890") #=> 10 f.close #=> nil File.truncate("out", 5) #=> 0 File.size("out") #=> 5 @overload truncate(file_name, integer) @return [0];T;0; @2;!F;"o;#;$T;%i³;&i¿;'@Öü;(I"œstatic VALUE rb_file_s_truncate(VALUE klass, VALUE path, VALUE len) { struct truncate_arg ta; int r; ta.pos = NUM2POS(len); FilePathValue(path); path = rb_str_encode_ospath(path); ta.path = StringValueCStr(path); r = (int)(VALUE)rb_thread_call_without_gvl(nogvl_truncate, &ta, RUBY_UBF_IO, NULL); if (r < 0) rb_sys_fail_path(path); return INT2FIX(0); #undef NUM2POS };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.mkfifo;F;[[@c0;[[@ci;T;:mkfifo;0;[;{;IC;"ÍCreates a FIFO special file with name _file_name_. _mode_ specifies the FIFO's permissions. It is modified by the process's umask in the usual way: the permissions of the created file are (mode & ~umask). ;T;[o;= ;3I" overload;F;40;;;50;)I"!mkfifo(file_name, mode=0666);T;IC;";T; @U;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @U;[;I"@return [0];T;0;6i;[[I"file_name;T0[I" mode;TI" 0666;T; @U;[;I"Creates a FIFO special file with name _file_name_. _mode_ specifies the FIFO's permissions. It is modified by the process's umask in the usual way: the permissions of the created file are (mode & ~umask). @overload mkfifo(file_name, mode=0666) @return [0];T;0; @U;!F;"o;#;$T;%iö;&iý;'@Öü;(I"Ístatic VALUE rb_file_s_mkfifo(int argc, VALUE *argv, VALUE _) { VALUE path; struct mkfifo_arg ma; ma.mode = 0666; rb_check_arity(argc, 1, 2); if (argc > 1) { ma.mode = NUM2MODET(argv[1]); } path = argv[0]; FilePathValue(path); path = rb_str_encode_ospath(path); ma.path = RSTRING_PTR(path); if (rb_thread_call_without_gvl(nogvl_mkfifo, &ma, RUBY_UBF_IO, 0)) { rb_sys_fail_path(path); } return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.expand_path;F;[[I"*;T0[I"_;T0;[[@ci6;T;;^;0;[;{;IC;"õConverts a pathname to an absolute pathname. Relative paths are referenced from the current working directory of the process unless +dir_string+ is given, in which case it will be used as the starting point. The given pathname may start with a ``~'', which expands to the process owner's home directory (the environment variable +HOME+ must be set correctly). ``~user'' expands to the named user's home directory. File.expand_path("~oracle/bin") #=> "/home/oracle/bin" A simple example of using +dir_string+ is as follows. File.expand_path("ruby", "/usr/bin") #=> "/usr/bin/ruby" A more complex example which also resolves parent directory is as follows. Suppose we are in bin/mygem and want the absolute path of lib/mygem.rb. File.expand_path("../../lib/mygem.rb", __FILE__) #=> ".../path/to/project/lib/mygem.rb" So first it resolves the parent of __FILE__, that is bin/, then go to the parent, the root of the project and appends +lib/mygem.rb+. ;T;[o;= ;3I" overload;F;40;;^;50;)I"+expand_path(file_name [, dir_string] );T;IC;";T; @v;>0;!F;[;[;I";T;0;6i;[[I"file_name[, dir_string];T0; @v;[;I"(Converts a pathname to an absolute pathname. Relative paths are referenced from the current working directory of the process unless +dir_string+ is given, in which case it will be used as the starting point. The given pathname may start with a ``~'', which expands to the process owner's home directory (the environment variable +HOME+ must be set correctly). ``~user'' expands to the named user's home directory. File.expand_path("~oracle/bin") #=> "/home/oracle/bin" A simple example of using +dir_string+ is as follows. File.expand_path("ruby", "/usr/bin") #=> "/usr/bin/ruby" A more complex example which also resolves parent directory is as follows. Suppose we are in bin/mygem and want the absolute path of lib/mygem.rb. File.expand_path("../../lib/mygem.rb", __FILE__) #=> ".../path/to/project/lib/mygem.rb" So first it resolves the parent of __FILE__, that is bin/, then go to the parent, the root of the project and appends +lib/mygem.rb+. @overload expand_path(file_name [, dir_string] );T;0; @v;!F;"o;#;$T;%i;&i2;'@Öü;(I"lstatic VALUE s_expand_path(int c, const VALUE * v, VALUE _) { return rb_file_s_expand_path(c, v); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.absolute_path;F;[[I"*;T0[I"_;T0;[[@ciW;T;;Ö;0;[;{;IC;"—Converts a pathname to an absolute pathname. Relative paths are referenced from the current working directory of the process unless dir_string is given, in which case it will be used as the starting point. If the given pathname starts with a ``~'' it is NOT expanded, it is treated as a normal directory name. File.absolute_path("~oracle/bin") #=> "/~oracle/bin" ;T;[o;= ;3I" overload;F;40;;Ö;50;)I"-absolute_path(file_name [, dir_string] );T;IC;";T; @’;>0;!F;[;[;I";T;0;6i;[[I"file_name[, dir_string];T0; @’;[;I"ÌConverts a pathname to an absolute pathname. Relative paths are referenced from the current working directory of the process unless dir_string is given, in which case it will be used as the starting point. If the given pathname starts with a ``~'' it is NOT expanded, it is treated as a normal directory name. File.absolute_path("~oracle/bin") #=> "/~oracle/bin" @overload absolute_path(file_name [, dir_string] );T;0; @’;!F;"o;#;$T;%iJ;&iS;'@Öü;(I"pstatic VALUE s_absolute_path(int c, const VALUE * v, VALUE _) { return rb_file_s_absolute_path(c, v); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.absolute_path?;F;[[I" fname;T0;[[@cig;T;:absolute_path?;0;[;{;IC;"Returns true if +file_name+ is an absolute path, and false otherwise. File.absolute_path?("c:/foo") #=> false (on Linux), true (on Windows);T;[o;= ;3I" overload;F;40;;;50;)I"absolute_path?(file_name);T;IC;";T; @®;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @®;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @®;[;I"çReturns true if +file_name+ is an absolute path, and false otherwise. File.absolute_path?("c:/foo") #=> false (on Linux), true (on Windows) @overload absolute_path?(file_name) @return [Boolean];T;0; @®;!F;"o;#;$T;%i];&id;6i;'@Öü;(I"´static VALUE s_absolute_path_p(VALUE klass, VALUE fname) { VALUE path = rb_get_path(fname); if (!rb_is_absolute_path(RSTRING_PTR(path))) return Qfalse; return Qtrue; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.realpath;F;[[@c0;[[@ciª;T;;E;0;[;{;IC;"?Returns the real (absolute) pathname of _pathname_ in the actual filesystem not containing symlinks or useless dots. If _dir_string_ is given, it is used as a base directory for interpreting relative pathname instead of the current directory. All components of the pathname must exist when this method is called. ;T;[o;= ;3I" overload;F;40;;E;50;)I"&realpath(pathname [, dir_string]);T;IC;";T; @Í;>0;!F;[;[;I";T;0;6i;[[I"pathname[, dir_string];T0; @Í;[;I"n Returns the real (absolute) pathname of _pathname_ in the actual filesystem not containing symlinks or useless dots. If _dir_string_ is given, it is used as a base directory for interpreting relative pathname instead of the current directory. All components of the pathname must exist when this method is called. @overload realpath(pathname [, dir_string]);T;0; @Í;!F;"o;#;$T;%i;&i§;'@Öü;(I"ôstatic VALUE rb_file_s_realpath(int argc, VALUE *argv, VALUE klass) { VALUE basedir = (rb_check_arity(argc, 1, 2) > 1) ? argv[1] : Qnil; VALUE path = argv[0]; FilePathValue(path); return rb_realpath_internal(basedir, path, 1); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.realdirpath;F;[[@c0;[[@ci¿;T;;F;0;[;{;IC;"HReturns the real (absolute) pathname of _pathname_ in the actual filesystem. The real pathname doesn't contain symlinks or useless dots. If _dir_string_ is given, it is used as a base directory for interpreting relative pathname instead of the current directory. The last component of the real pathname can be nonexistent. ;T;[o;= ;3I" overload;F;40;;F;50;)I")realdirpath(pathname [, dir_string]);T;IC;";T; @æ;>0;!F;[;[;I";T;0;6i;[[I"pathname[, dir_string];T0; @æ;[;I"z Returns the real (absolute) pathname of _pathname_ in the actual filesystem. The real pathname doesn't contain symlinks or useless dots. If _dir_string_ is given, it is used as a base directory for interpreting relative pathname instead of the current directory. The last component of the real pathname can be nonexistent. @overload realdirpath(pathname [, dir_string]);T;0; @æ;!F;"o;#;$T;%i³;&i¼;'@Öü;(I"÷static VALUE rb_file_s_realdirpath(int argc, VALUE *argv, VALUE klass) { VALUE basedir = (rb_check_arity(argc, 1, 2) > 1) ? argv[1] : Qnil; VALUE path = argv[0]; FilePathValue(path); return rb_realpath_internal(basedir, path, 0); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.basename;F;[[@c0;[[@ci<;T;;[;0;[;{;IC;"PReturns the last component of the filename given in file_name (after first stripping trailing separators), which can be formed using both File::SEPARATOR and File::ALT_SEPARATOR as the separator when File::ALT_SEPARATOR is not nil. If suffix is given and present at the end of file_name, it is removed. If suffix is ".*", any extension will be removed. File.basename("/home/gumby/work/ruby.rb") #=> "ruby.rb" File.basename("/home/gumby/work/ruby.rb", ".rb") #=> "ruby" File.basename("/home/gumby/work/ruby.rb", ".*") #=> "ruby" ;T;[o;= ;3I" overload;F;40;;[;50;)I"$basename(file_name [, suffix] );T;IC;";T; @ÿ;>0;!F;[;[;I";T;0;6i;[[I"file_name[, suffix];T0; @ÿ;[;I"|Returns the last component of the filename given in file_name (after first stripping trailing separators), which can be formed using both File::SEPARATOR and File::ALT_SEPARATOR as the separator when File::ALT_SEPARATOR is not nil. If suffix is given and present at the end of file_name, it is removed. If suffix is ".*", any extension will be removed. File.basename("/home/gumby/work/ruby.rb") #=> "ruby.rb" File.basename("/home/gumby/work/ruby.rb", ".rb") #=> "ruby" File.basename("/home/gumby/work/ruby.rb", ".*") #=> "ruby" @overload basename(file_name [, suffix] );T;0; @ÿ;!F;"o;#;$T;%i+;&i8;'@Öü;(I"êstatic VALUE rb_file_s_basename(int argc, VALUE *argv, VALUE _) { VALUE fname, fext, basename; const char *name, *p; long f, n; rb_encoding *enc; fext = Qnil; if (rb_check_arity(argc, 1, 2) == 2) { fext = argv[1]; StringValue(fext); enc = check_path_encoding(fext); } fname = argv[0]; FilePathStringValue(fname); if (NIL_P(fext) || !(enc = rb_enc_compatible(fname, fext))) { enc = rb_enc_get(fname); fext = Qnil; } if ((n = RSTRING_LEN(fname)) == 0 || !*(name = RSTRING_PTR(fname))) return rb_str_new_shared(fname); p = ruby_enc_find_basename(name, &f, &n, enc); if (n >= 0) { if (NIL_P(fext)) { f = n; } else { const char *fp; fp = StringValueCStr(fext); if (!(f = rmext(p, f, n, fp, RSTRING_LEN(fext), enc))) { f = n; } RB_GC_GUARD(fext); } if (f == RSTRING_LEN(fname)) return rb_str_new_shared(fname); } basename = rb_str_new(p, f); rb_enc_copy(basename, fname); return basename; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.dirname;F;[[I" fname;T0;[[@ciu;T;;\;0;[;{;IC;"XReturns all components of the filename given in file_name except the last one (after first stripping trailing separators). The filename can be formed using both File::SEPARATOR and File::ALT_SEPARATOR as the separator when File::ALT_SEPARATOR is not nil. File.dirname("/home/gumby/work/ruby.rb") #=> "/home/gumby/work" ;T;[o;= ;3I" overload;F;40;;\;50;)I"dirname(file_name);T;IC;";T; @ ;>0;!F;[;[;I";T;0;6i;[[I"file_name;T0; @ ;[;I"wReturns all components of the filename given in file_name except the last one (after first stripping trailing separators). The filename can be formed using both File::SEPARATOR and File::ALT_SEPARATOR as the separator when File::ALT_SEPARATOR is not nil. File.dirname("/home/gumby/work/ruby.rb") #=> "/home/gumby/work" @overload dirname(file_name);T;0; @ ;!F;"o;#;$T;%ih;&iq;'@Öü;(I"dstatic VALUE rb_file_s_dirname(VALUE klass, VALUE fname) { return rb_file_dirname(fname); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.extname;F;[[I" fname;T0;[[@ci;T;;];0;[;{;IC;"ÉReturns the extension (the portion of file name in +path+ starting from the last period). If +path+ is a dotfile, or starts with a period, then the starting dot is not dealt with the start of the extension. An empty string will also be returned when the period is the last character in +path+. On Windows, trailing dots are truncated. File.extname("test.rb") #=> ".rb" File.extname("a/b/d/test.rb") #=> ".rb" File.extname(".a/b/d/test.rb") #=> ".rb" File.extname("foo.") #=> "" on Windows File.extname("foo.") #=> "." on non-Windows File.extname("test") #=> "" File.extname(".profile") #=> "" File.extname(".profile.sh") #=> ".sh" ;T;[o;= ;3I" overload;F;40;;];50;)I"extname(path);T;IC;";T; @2 ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @2 ;[;I"@return [String];T;0;6i;[[I" path;T0; @2 ;[;I"÷Returns the extension (the portion of file name in +path+ starting from the last period). If +path+ is a dotfile, or starts with a period, then the starting dot is not dealt with the start of the extension. An empty string will also be returned when the period is the last character in +path+. On Windows, trailing dots are truncated. File.extname("test.rb") #=> ".rb" File.extname("a/b/d/test.rb") #=> ".rb" File.extname(".a/b/d/test.rb") #=> ".rb" File.extname("foo.") #=> "" on Windows File.extname("foo.") #=> "." on non-Windows File.extname("test") #=> "" File.extname(".profile") #=> "" File.extname(".profile.sh") #=> ".sh" @overload extname(path) @return [String];T;0; @2 ;!F;"o;#;$T;%iæ;&iý;'@Öü;(I"¢static VALUE rb_file_s_extname(VALUE klass, VALUE fname) { const char *name, *e; long len; VALUE extname; FilePathStringValue(fname); name = StringValueCStr(fname); len = RSTRING_LEN(fname); e = ruby_enc_find_extname(name, &len, rb_enc_get(fname)); if (len < 1) return rb_str_new(0, 0); extname = rb_str_subseq(fname, e - name, len); /* keep the dot, too! */ return extname; };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.path;F;[[I" fname;T0;[[@ci;T;;Õ;0;[;{;IC;"Returns the string representation of the path File.path("/dev/null") #=> "/dev/null" File.path(Pathname.new("/tmp")) #=> "/tmp" ;T;[o;= ;3I" overload;F;40;;Õ;50;)I"path(path);T;IC;";T; @Q ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Q ;[;I"@return [String];T;0;6i;[[I" path;T0; @Q ;[;I"ºReturns the string representation of the path File.path("/dev/null") #=> "/dev/null" File.path(Pathname.new("/tmp")) #=> "/tmp" @overload path(path) @return [String];T;0; @Q ;!F;"o;#;$T;%i;&i;'@Öü;(I"]static VALUE rb_file_s_path(VALUE klass, VALUE fname) { return rb_get_path(fname); };T;)I"static VALUE;T;*To;{;[[@ci¸;F;:Separator;;};;;[;{;IC;"&separates directory parts in path ;T;[;[;I"&separates directory parts in path;T;0; @p ;!F;"o;#;$T;%i·;&i·;'@Öü;I"File::Separator;F;~I"separator;To;{;[[@ciº;F;:SEPARATOR;;};;;[;{;IC;"&separates directory parts in path ;T;[;[;I"&separates directory parts in path;T;0; @| ;!F;"o;#;$T;%i¹;&i¹;'@Öü;I"File::SEPARATOR;F;~I"separator;To;;F; ;F;;;I"File.split;F;[[I" path;T0;[[@ci-;T;;‡;0;[;{;IC;"ÚSplits the given string into a directory and a file component and returns them in a two-element array. See also File::dirname and File::basename. File.split("/home/gumby/.profile") #=> ["/home/gumby", ".profile"] ;T;[o;= ;3I" overload;F;40;;‡;50;)I"split(file_name);T;IC;";T; @ˆ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ˆ ;[;I"@return [Array];T;0;6i;[[I"file_name;T0; @ˆ ;[;I" Splits the given string into a directory and a file component and returns them in a two-element array. See also File::dirname and File::basename. File.split("/home/gumby/.profile") #=> ["/home/gumby", ".profile"] @overload split(file_name) @return [Array];T;0; @ˆ ;!F;"o;#;$T;%i";&i*;'@Öü;(I"Ïstatic VALUE rb_file_s_split(VALUE klass, VALUE path) { FilePathStringValue(path); /* get rid of converting twice */ return rb_assoc_new(rb_file_dirname(path), rb_file_s_basename(1,&path,Qundef)); };T;)I"static VALUE;T;*To;;F; ;F;;;I"File.join;F;[[I" args;T0;[[@ciˆ;T;;½;0;[;{;IC;"‡Returns a new string formed by joining the strings using "/". File.join("usr", "mail", "gumby") #=> "usr/mail/gumby" ;T;[o;= ;3I" overload;F;40;;½;50;)I"join(string, ...);T;IC;";T; @§ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @§ ;[;I"@return [String];T;0;6i;[[I"string;T0[I"...;T0; @§ ;[;I"¹Returns a new string formed by joining the strings using "/". File.join("usr", "mail", "gumby") #=> "usr/mail/gumby" @overload join(string, ...) @return [String];T;0; @§ ;!F;"o;#;$T;%i};&i…;'@Öü;(I"\static VALUE rb_file_s_join(VALUE klass, VALUE args) { return rb_file_join(args); };T;)I"static VALUE;T;*To;{;[[@ciÀ[@ciÂ;F;:ALT_SEPARATOR;;};;;[;{;IC;",platform specific alternative separator ;T;[;[;I",platform specific alternative separator;T;0; @È ;!F;"o;#;$T;%i¿;&i¿;'@Öü;I"File::ALT_SEPARATOR;F;~I" Qnil;To;{;[[@ciÅ;F;:PATH_SEPARATOR;;};;;[;{;IC;"path list separator ;T;[;[;I"path list separator;T;0; @Õ ;!F;"o;#;$T;%iÄ;&iÄ;'@Öü;I"File::PATH_SEPARATOR;F;~I"rb_fstring_cstr(PATH_SEP);To;;F; ;;;;I"File#lstat;F;[;[[@ci¬;T;;X;0;[;{;IC;"ESame as IO#stat, but does not follow the last symbolic link. Instead, reports on the link itself. File.symlink("testfile", "link2test") #=> 0 File.stat("testfile").size #=> 66 f = File.new("link2test") f.lstat.size #=> 8 f.stat.size #=> 66 ;T;[o;= ;3I" overload;F;40;;X;50;)I" lstat;T;IC;";T; @á ;>0;!F;[;[;I";T;0;6i;[; @á ;[;I"WSame as IO#stat, but does not follow the last symbolic link. Instead, reports on the link itself. File.symlink("testfile", "link2test") #=> 0 File.stat("testfile").size #=> 66 f = File.new("link2test") f.lstat.size #=> 8 f.stat.size #=> 66 @overload lstat;T;0; @á ;!F;"o;#;$T;%iž;&i¨;'@Öü;(I"static VALUE rb_file_lstat(VALUE obj) { #ifdef HAVE_LSTAT rb_io_t *fptr; struct stat st; VALUE path; GetOpenFile(obj, fptr); if (NIL_P(fptr->pathv)) return Qnil; path = rb_str_encode_ospath(fptr->pathv); if (lstat_without_gvl(RSTRING_PTR(path), &st) == -1) { rb_sys_fail_path(fptr->pathv); } return rb_stat_new(&st); #else return rb_io_stat(obj); #endif };T;)I"static VALUE;T;*To;;F; ;;;;I"File#atime;F;[;[[@ciP ;T;;J;0;[;{;IC;"®Returns the last access time (a Time object) for file, or epoch if file has not been accessed. File.new("testfile").atime #=> Wed Dec 31 18:00:00 CST 1969 ;T;[o;= ;3I" overload;F;40;;J;50;)I" atime;T;IC;";T; @÷ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Time;T; @÷ ;[;I"@return [Time];T;0;6i;[; @÷ ;[;I"ÒReturns the last access time (a Time object) for file, or epoch if file has not been accessed. File.new("testfile").atime #=> Wed Dec 31 18:00:00 CST 1969 @overload atime @return [Time];T;0; @÷ ;!F;"o;#;$T;%iE ;&iM ;'@Öü;(I"Õstatic VALUE rb_file_atime(VALUE obj) { rb_io_t *fptr; struct stat st; GetOpenFile(obj, fptr); if (fstat(fptr->fd, &st) == -1) { rb_sys_fail_path(fptr->pathv); } return stat_atime(&st); };T;)I"static VALUE;T;*To;;F; ;;;;I"File#mtime;F;[;[[@ci€ ;T;;ü;0;[;{;IC;"uReturns the modification time for file. File.new("testfile").mtime #=> Wed Apr 09 08:53:14 CDT 2003 ;T;[o;= ;3I" overload;F;40;;ü;50;)I" mtime;T;IC;";T; @ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Time;T; @ ;[;I"@return [Time];T;0;6i;[; @ ;[;I"”Returns the modification time for file. File.new("testfile").mtime #=> Wed Apr 09 08:53:14 CDT 2003 @overload mtime @return [Time];T;0; @ ;!F;"o;#;$T;%iv ;&i} ;'@Öü;(I"Õstatic VALUE rb_file_mtime(VALUE obj) { rb_io_t *fptr; struct stat st; GetOpenFile(obj, fptr); if (fstat(fptr->fd, &st) == -1) { rb_sys_fail_path(fptr->pathv); } return stat_mtime(&st); };T;)I"static VALUE;T;*To;;F; ;;;;I"File#ctime;F;[;[[@ci· ;T;;L;0;[;{;IC;"Returns the change time for file (that is, the time directory information about the file was changed, not the file itself). Note that on Windows (NTFS), returns creation time (birth time). File.new("testfile").ctime #=> Wed Apr 09 08:53:14 CDT 2003 ;T;[o;= ;3I" overload;F;40;;L;50;)I" ctime;T;IC;";T; @- ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Time;T; @- ;[;I"@return [Time];T;0;6i;[; @- ;[;I"*Returns the change time for file (that is, the time directory information about the file was changed, not the file itself). Note that on Windows (NTFS), returns creation time (birth time). File.new("testfile").ctime #=> Wed Apr 09 08:53:14 CDT 2003 @overload ctime @return [Time];T;0; @- ;!F;"o;#;$T;%iª ;&i´ ;'@Öü;(I"Õstatic VALUE rb_file_ctime(VALUE obj) { rb_io_t *fptr; struct stat st; GetOpenFile(obj, fptr); if (fstat(fptr->fd, &st) == -1) { rb_sys_fail_path(fptr->pathv); } return stat_ctime(&st); };T;)I"static VALUE;T;*To;;F; ;;;;I"File#birthtime;F;[;[[@cið ;T;;K;0;[;{;IC;"²Returns the birth time for file. File.new("testfile").birthtime #=> Wed Apr 09 08:53:14 CDT 2003 If the platform doesn't have birthtime, raises NotImplementedError. ;T;[o;= ;3I" overload;F;40;;K;50;)I"birthtime;T;IC;";T; @H ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Time;T; @H ;[;I"@return [Time];T;0;6i;[; @H ;[;I"ÚReturns the birth time for file. File.new("testfile").birthtime #=> Wed Apr 09 08:53:14 CDT 2003 If the platform doesn't have birthtime, raises NotImplementedError. @overload birthtime @return [Time];T;0; @H ;!F;"o;#;$T;%iä ;&ií ;'@Öü;(I"static VALUE rb_file_birthtime(VALUE obj) { rb_io_t *fptr; statx_data st; GetOpenFile(obj, fptr); if (fstatx_without_gvl(fptr->fd, &st, STATX_BTIME) == -1) { rb_sys_fail_path(fptr->pathv); } return statx_birthtime(&st, fptr->pathv); };T;)I"static VALUE;T;*To;;F; ;;;;I"File#size;F;[;[[@ci ;T;;¯;0;[;{;IC;"UReturns the size of file in bytes. File.new("testfile").size #=> 66 ;T;[o;= ;3I" overload;F;40;;¯;50;)I" size;T;IC;";T; @c ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @c ;[;I"@return [Integer];T;0;6i;[; @c ;[;I"{Returns the size of file in bytes. File.new("testfile").size #=> 66 @overload size @return [Integer];T;0; @c ;!F;"o;#;$T;%i ;&i ;'@Öü;(I" static VALUE rb_file_size(VALUE obj) { rb_io_t *fptr; struct stat st; GetOpenFile(obj, fptr); if (fptr->mode & FMODE_WRITABLE) { rb_io_flush_raw(obj, 0); } if (fstat(fptr->fd, &st) == -1) { rb_sys_fail_path(fptr->pathv); } return OFFT2NUM(st.st_size); };T;)I"static VALUE;T;*To;;F; ;;;;I"File#chmod;F;[[I" vmode;T0;[[@ciE ;T;;M;0;[;{;IC;"Changes permission bits on file to the bit pattern represented by mode_int. Actual effects are platform dependent; on Unix systems, see chmod(2) for details. Follows symbolic links. Also see File#lchmod. f = File.new("out", "w"); f.chmod(0644) #=> 0 ;T;[o;= ;3I" overload;F;40;;M;50;)I"chmod(mode_int);T;IC;";T; @~ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @~ ;[;I"@return [0];T;0;6i;[[I" mode_int;T0; @~ ;[;I"GChanges permission bits on file to the bit pattern represented by mode_int. Actual effects are platform dependent; on Unix systems, see chmod(2) for details. Follows symbolic links. Also see File#lchmod. f = File.new("out", "w"); f.chmod(0644) #=> 0 @overload chmod(mode_int) @return [0];T;0; @~ ;!F;"o;#;$T;%i8 ;&iB ;'@Öü;(I"Šstatic VALUE rb_file_chmod(VALUE obj, VALUE vmode) { rb_io_t *fptr; mode_t mode; #if !defined HAVE_FCHMOD || !HAVE_FCHMOD VALUE path; #endif mode = NUM2MODET(vmode); GetOpenFile(obj, fptr); #ifdef HAVE_FCHMOD if (fchmod(fptr->fd, mode) == -1) { if (HAVE_FCHMOD || errno != ENOSYS) rb_sys_fail_path(fptr->pathv); } else { if (!HAVE_FCHMOD) return INT2FIX(0); } #endif #if !defined HAVE_FCHMOD || !HAVE_FCHMOD if (NIL_P(fptr->pathv)) return Qnil; path = rb_str_encode_ospath(fptr->pathv); if (chmod(RSTRING_PTR(path), mode) == -1) rb_sys_fail_path(fptr->pathv); #endif return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;;;;I"File#chown;F;[[I" owner;T0[I" group;T0;[[@ciË ;T;;O;0;[;{;IC;"ŽChanges the owner and group of file to the given numeric owner and group id's. Only a process with superuser privileges may change the owner of a file. The current owner of a file may change the file's group to any group to which the owner belongs. A nil or -1 owner or group id is ignored. Follows symbolic links. See also File#lchown. File.new("testfile").chown(502, 1000) ;T;[o;= ;3I" overload;F;40;;O;50;)I"!chown(owner_int, group_int );T;IC;";T; @ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @ ;[;I"@return [0];T;0;6i;[[I"owner_int;T0[I"group_int;T0; @ ;[;I"ÆChanges the owner and group of file to the given numeric owner and group id's. Only a process with superuser privileges may change the owner of a file. The current owner of a file may change the file's group to any group to which the owner belongs. A nil or -1 owner or group id is ignored. Follows symbolic links. See also File#lchown. File.new("testfile").chown(502, 1000) @overload chown(owner_int, group_int ) @return [0];T;0; @ ;!F;"o;#;$T;%i¼ ;&iÈ ;'@Öü;(I"static VALUE rb_file_chown(VALUE obj, VALUE owner, VALUE group) { rb_io_t *fptr; rb_uid_t o; rb_gid_t g; #ifndef HAVE_FCHOWN VALUE path; #endif o = to_uid(owner); g = to_gid(group); GetOpenFile(obj, fptr); #ifndef HAVE_FCHOWN if (NIL_P(fptr->pathv)) return Qnil; path = rb_str_encode_ospath(fptr->pathv); if (chown(RSTRING_PTR(path), o, g) == -1) rb_sys_fail_path(fptr->pathv); #else if (fchown(fptr->fd, o, g) == -1) rb_sys_fail_path(fptr->pathv); #endif return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;;;;I"File#truncate;F;[[I"len;T0;[[@ciþ;T;;c;0;[;{;IC;"+Truncates file to at most integer bytes. The file must be opened for writing. Not available on all platforms. f = File.new("out", "w") f.syswrite("1234567890") #=> 10 f.truncate(5) #=> 0 f.close() #=> nil File.size("out") #=> 5 ;T;[o;= ;3I" overload;F;40;;c;50;)I"truncate(integer);T;IC;";T; @À ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @À ;[;I"@return [0];T;0;6i;[[I"integer;T0; @À ;[;I"WTruncates file to at most integer bytes. The file must be opened for writing. Not available on all platforms. f = File.new("out", "w") f.syswrite("1234567890") #=> 10 f.truncate(5) #=> 0 f.close() #=> nil File.size("out") #=> 5 @overload truncate(integer) @return [0];T;0; @À ;!F;"o;#;$T;%ið;&iû;'@Öü;(I"Îstatic VALUE rb_file_truncate(VALUE obj, VALUE len) { rb_io_t *fptr; struct ftruncate_arg fa; fa.pos = NUM2POS(len); GetOpenFile(obj, fptr); if (!(fptr->mode & FMODE_WRITABLE)) { rb_raise(rb_eIOError, "not opened for writing"); } rb_io_flush_raw(obj, 0); fa.fd = fptr->fd; if ((int)rb_thread_io_blocking_region(nogvl_ftruncate, &fa, fa.fd) < 0) { rb_sys_fail_path(fptr->pathv); } return INT2FIX(0); #undef NUM2POS };T;)I"static VALUE;T;*To;;F; ;;;;I"File#flock;F;[[I"operation;T0;[[@cic;T;: flock;0;[;{;IC;"Locks or unlocks a file according to locking_constant (a logical or of the values in the table below). Returns false if File::LOCK_NB is specified and the operation would otherwise have blocked. Not available on all platforms. Locking constants (in class File): LOCK_EX | Exclusive lock. Only one process may hold an | exclusive lock for a given file at a time. ----------+------------------------------------------------ LOCK_NB | Don't block when locking. May be combined | with other lock options using logical or. ----------+------------------------------------------------ LOCK_SH | Shared lock. Multiple processes may each hold a | shared lock for a given file at the same time. ----------+------------------------------------------------ LOCK_UN | Unlock. Example: # update a counter using write lock # don't use "w" because it truncates the file before lock. File.open("counter", File::RDWR|File::CREAT, 0644) {|f| f.flock(File::LOCK_EX) value = f.read.to_i + 1 f.rewind f.write("#{value}\n") f.flush f.truncate(f.pos) } # read the counter using read lock File.open("counter", "r") {|f| f.flock(File::LOCK_SH) p f.read } ;T;[o;= ;3I" overload;F;40;;;50;)I"flock(locking_constant);T;IC;";T; @ß ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI" false;T; @ß ;[;I"@return [0, false];T;0;6i;[[I"locking_constant;T0; @ß ;[;I"ELocks or unlocks a file according to locking_constant (a logical or of the values in the table below). Returns false if File::LOCK_NB is specified and the operation would otherwise have blocked. Not available on all platforms. Locking constants (in class File): LOCK_EX | Exclusive lock. Only one process may hold an | exclusive lock for a given file at a time. ----------+------------------------------------------------ LOCK_NB | Don't block when locking. May be combined | with other lock options using logical or. ----------+------------------------------------------------ LOCK_SH | Shared lock. Multiple processes may each hold a | shared lock for a given file at the same time. ----------+------------------------------------------------ LOCK_UN | Unlock. Example: # update a counter using write lock # don't use "w" because it truncates the file before lock. File.open("counter", File::RDWR|File::CREAT, 0644) {|f| f.flock(File::LOCK_EX) value = f.read.to_i + 1 f.rewind f.write("#{value}\n") f.flush f.truncate(f.pos) } # read the counter using read lock File.open("counter", "r") {|f| f.flock(File::LOCK_SH) p f.read } @overload flock(locking_constant) @return [0, false];T;0; @ß ;!F;"o;#;$T;%i7;&i`;'@Öü;(I"Ustatic VALUE rb_file_flock(VALUE obj, VALUE operation) { rb_io_t *fptr; int op[2], op1; struct timeval time; op[1] = op1 = NUM2INT(operation); GetOpenFile(obj, fptr); op[0] = fptr->fd; if (fptr->mode & FMODE_WRITABLE) { rb_io_flush_raw(obj, 0); } while ((int)rb_thread_io_blocking_region(rb_thread_flock, op, fptr->fd) < 0) { int e = errno; switch (e) { case EAGAIN: case EACCES: #if defined(EWOULDBLOCK) && EWOULDBLOCK != EAGAIN case EWOULDBLOCK: #endif if (op1 & LOCK_NB) return Qfalse; time.tv_sec = 0; time.tv_usec = 100 * 1000; /* 0.1 sec */ rb_thread_wait_for(time); rb_io_check_closed(fptr); continue; case EINTR: #if defined(ERESTART) case ERESTART: #endif break; default: rb_syserr_fail_path(e, fptr->pathv); } } return INT2FIX(0); };T;)I"static VALUE;T;*T@¯ûo;;F; ;;;;I"File#path;F;[;[[@ciù;T;;Õ;0;[;{;IC;"åReturns the pathname used to create file as a string. Does not normalize the name. The pathname may not point to the file corresponding to file. For instance, the pathname becomes void when the file has been moved or deleted. This method raises IOError for a file created using File::Constants::TMPFILE because they don't have a pathname. File.new("testfile").path #=> "testfile" File.new("/tmp/../tmp/xxx", "w").path #=> "/tmp/../tmp/xxx" ;T;[o;= ;3I" overload;F;40;;Õ;50;)I" path;T;IC;";T; @ÿ ;>0;!F;[;[;I";T;0;6i;[; @ÿ o;= ;3I" overload;F;40;;C;50;)I"to_path;T;IC;";T; @ÿ ;>0;!F;[;[;I";T;0;6i;[; @ÿ ;[;I" Returns the pathname used to create file as a string. Does not normalize the name. The pathname may not point to the file corresponding to file. For instance, the pathname becomes void when the file has been moved or deleted. This method raises IOError for a file created using File::Constants::TMPFILE because they don't have a pathname. File.new("testfile").path #=> "testfile" File.new("/tmp/../tmp/xxx", "w").path #=> "/tmp/../tmp/xxx" @overload path @overload to_path;T;0; @ÿ ;!F;"o;#;$T;%iå;&iõ;'@Öü;(I"static VALUE rb_file_path(VALUE obj) { rb_io_t *fptr; fptr = RFILE(rb_io_taint_check(obj))->fptr; rb_io_check_initialized(fptr); if (NIL_P(fptr->pathv)) { rb_raise(rb_eIOError, "File is unnamed (TMPFILE?)"); } return rb_str_dup(fptr->pathv); };T;)I"static VALUE;T;*To;;F; ;;;;I"File#to_path;F;[;[[@ciù;T;;C;0;[;{;IC;"åReturns the pathname used to create file as a string. Does not normalize the name. The pathname may not point to the file corresponding to file. For instance, the pathname becomes void when the file has been moved or deleted. This method raises IOError for a file created using File::Constants::TMPFILE because they don't have a pathname. File.new("testfile").path #=> "testfile" File.new("/tmp/../tmp/xxx", "w").path #=> "/tmp/../tmp/xxx" ;T;[o;= ;3I" overload;F;40;;Õ;50;)I" path;T;IC;";T; @;>0;!F;[;[;I";T;0;6i;[; @o;= ;3I" overload;F;40;;C;50;)I"to_path;T;IC;";T; @;>0;!F;[;[;I";T;0;6i;[; @;[;@;0; @;!F;"o;#;$T;%iå;&iõ;'@Öü;(I"static VALUE rb_file_path(VALUE obj) { rb_io_t *fptr; fptr = RFILE(rb_io_taint_check(obj))->fptr; rb_io_check_initialized(fptr); if (NIL_P(fptr->pathv)) { rb_raise(rb_eIOError, "File is unnamed (TMPFILE?)"); } return rb_str_dup(fptr->pathv); };T;)I"static VALUE;T;*T;A@Öü;BIC;[;A@Öü;CIC;[;A@Öü;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@cip;F;;ù;;K;;;[;{;IC;"áA File is an abstraction of any file object accessible by the program and is closely associated with class IO. File includes the methods of module FileTest as class methods, allowing you to write (for example) File.exist?("foo"). In the description of File methods, permission bits are a platform-specific set of bits that indicate permissions of a file. On Unix-based systems, permissions are viewed as a set of three octets, for the owner, the group, and the rest of the world. For each of these entities, permissions may be set to read, write, or execute the file: The permission bits 0644 (in octal) would thus be interpreted as read/write for owner, and read-only for group and other. Higher-order bits may also be used to indicate the type of file (plain, directory, pipe, socket, and so on) and various other special features. If the permissions are for a directory, the meaning of the execute bit changes; when set the directory can be searched. On non-Posix operating systems, there may be only the ability to make a file read-only or read-write. In this case, the remaining permission bits will be synthesized to resemble typical values. For instance, on Windows NT the default permission bits are 0644, which means read/write for owner, read-only for all others. The only change that can be made is to make the file read-only, which is reported as 0444. Various constants for the methods in File can be found in File::Constants.;T;[;[;I"âA File is an abstraction of any file object accessible by the program and is closely associated with class IO. File includes the methods of module FileTest as class methods, allowing you to write (for example) File.exist?("foo"). In the description of File methods, permission bits are a platform-specific set of bits that indicate permissions of a file. On Unix-based systems, permissions are viewed as a set of three octets, for the owner, the group, and the rest of the world. For each of these entities, permissions may be set to read, write, or execute the file: The permission bits 0644 (in octal) would thus be interpreted as read/write for owner, and read-only for group and other. Higher-order bits may also be used to indicate the type of file (plain, directory, pipe, socket, and so on) and various other special features. If the permissions are for a directory, the meaning of the execute bit changes; when set the directory can be searched. On non-Posix operating systems, there may be only the ability to make a file read-only or read-write. In this case, the remaining permission bits will be synthesized to resemble typical values. For instance, on Windows NT the default permission bits are 0644, which means read/write for owner, read-only for all others. The only change that can be made is to make the file read-only, which is reported as 0444. Various constants for the methods in File can be found in File::Constants. ;T;0; @Öü;!F;"o;#;$T;%iE;⁣6i;'@;I" File;F;S@bè;I"File::Constants;F;A@bè;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@qî;‡;I[;[[@iC4;F;:IO;;K;;;[;{;IC;"é The IO class is the basis for all input and output in Ruby. An I/O stream may be duplexed (that is, bidirectional), and so may use more than one native operating system stream. Many of the examples in this section use the File class, the only standard subclass of IO. The two classes are closely associated. Like the File class, the Socket library subclasses from IO (such as TCPSocket or UDPSocket). The Kernel#open method can create an IO (or File) object for these types of arguments: * A plain string represents a filename suitable for the underlying operating system. * A string starting with "|" indicates a subprocess. The remainder of the string following the "|" is invoked as a process with appropriate input/output channels connected to it. * A string equal to "|-" will create another Ruby instance as a subprocess. The IO may be opened with different file modes (read-only, write-only) and encodings for proper conversion. See IO.new for these options. See Kernel#open for details of the various command formats described above. IO.popen, the Open3 library, or Process#spawn may also be used to communicate with subprocesses through an IO. Ruby will convert pathnames between different operating system conventions if possible. For instance, on a Windows system the filename "/gumby/ruby/test.rb" will be opened as "\gumby\ruby\test.rb". When specifying a Windows-style filename in a Ruby string, remember to escape the backslashes: "C:\\gumby\\ruby\\test.rb" Our examples here will use the Unix-style forward slashes; File::ALT_SEPARATOR can be used to get the platform-specific separator character. The global constant ARGF (also accessible as $<) provides an IO-like stream which allows access to all files mentioned on the command line (or STDIN if no files are mentioned). ARGF#path and its alias ARGF#filename are provided to access the name of the file currently being read. == io/console The io/console extension provides methods for interacting with the console. The console can be accessed from IO.console or the standard input/output/error IO objects. Requiring io/console adds the following methods: * IO::console * IO#raw * IO#raw! * IO#cooked * IO#cooked! * IO#getch * IO#echo= * IO#echo? * IO#noecho * IO#winsize * IO#winsize= * IO#iflush * IO#ioflush * IO#oflush Example: require 'io/console' rows, columns = $stdout.winsize puts "Your screen is #{columns} wide and #{rows} tall";T;[;[;I"ê The IO class is the basis for all input and output in Ruby. An I/O stream may be duplexed (that is, bidirectional), and so may use more than one native operating system stream. Many of the examples in this section use the File class, the only standard subclass of IO. The two classes are closely associated. Like the File class, the Socket library subclasses from IO (such as TCPSocket or UDPSocket). The Kernel#open method can create an IO (or File) object for these types of arguments: * A plain string represents a filename suitable for the underlying operating system. * A string starting with "|" indicates a subprocess. The remainder of the string following the "|" is invoked as a process with appropriate input/output channels connected to it. * A string equal to "|-" will create another Ruby instance as a subprocess. The IO may be opened with different file modes (read-only, write-only) and encodings for proper conversion. See IO.new for these options. See Kernel#open for details of the various command formats described above. IO.popen, the Open3 library, or Process#spawn may also be used to communicate with subprocesses through an IO. Ruby will convert pathnames between different operating system conventions if possible. For instance, on a Windows system the filename "/gumby/ruby/test.rb" will be opened as "\gumby\ruby\test.rb". When specifying a Windows-style filename in a Ruby string, remember to escape the backslashes: "C:\\gumby\\ruby\\test.rb" Our examples here will use the Unix-style forward slashes; File::ALT_SEPARATOR can be used to get the platform-specific separator character. The global constant ARGF (also accessible as $<) provides an IO-like stream which allows access to all files mentioned on the command line (or STDIN if no files are mentioned). ARGF#path and its alias ARGF#filename are provided to access the name of the file currently being read. == io/console The io/console extension provides methods for interacting with the console. The console can be accessed from IO.console or the standard input/output/error IO objects. Requiring io/console adds the following methods: * IO::console * IO#raw * IO#raw! * IO#cooked * IO#cooked! * IO#getch * IO#echo= * IO#echo? * IO#noecho * IO#winsize * IO#winsize= * IO#iflush * IO#ioflush * IO#oflush Example: require 'io/console' rows, columns = $stdout.winsize puts "Your screen is #{columns} wide and #{rows} tall" ;T;0; @bè;!F;"o;#;$T;%iÇ3;&i4;6i;'@;I"IO;F;S@];I"IO::WaitReadable;F;A@Mè;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@äÇiþ ;F;:SSLErrorWaitReadable;;K;;;[;{;IC;";T;[;[;@|;0; @Mè;'@Úæ;I"'OpenSSL::SSL::SSLErrorWaitReadable;F;S@9èo; ;IC;[;A@i;BIC;[;A@i;CIC;[@‚è;A@i;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@äÇi ;F;:SSLErrorWaitWritable;;K;;;[;{;IC;";T;[;[;@|;0; @i;'@Úæ;I"'OpenSSL::SSL::SSLErrorWaitWritable;F;S@9èo; ;IC;[#o;;F; ;;;;I")OpenSSL::SSL::SSLContext#ssl_timeout;F;[;[[@äÇiÿ ;F;:ssl_timeout;;K;[;{;IC;";T;[;[;@|;0; @|;'@z;)I"def ssl_timeout;To;;F; ;;;;I"*OpenSSL::SSL::SSLContext#ssl_timeout=;F;[;[[@äÇi;F;:ssl_timeout=;;K;[;{;IC;";T;[;[;@|;0; @‡;'@z;)I"def ssl_timeout=;To;;F; ;;;Ï;I"6OpenSSL::SSL::SSLContext#set_minmax_proto_version;F;[[I" min_v;T0[I" max_v;T0;[[@äÇi¥;T;:set_minmax_proto_version;0;[;{;IC;"cSets the minimum and maximum supported protocol versions. See #min_version= and #max_version=. ;T;[o;= ;3I" overload;F;40;;;50;)I"'set_minmax_proto_version(min, max);T;IC;";T; @’;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @’;[;I"@return [nil];T;0;6i;[[I"min;T0[I"max;T0; @’;[;I"Sets the minimum and maximum supported protocol versions. See #min_version= and #max_version=. @overload set_minmax_proto_version(min, max) @return [nil];T;0; @’;!F;"o;#;$T;%iž;&i£;'@z;(I"âstatic VALUE ossl_sslctx_set_minmax_proto_version(VALUE self, VALUE min_v, VALUE max_v) { SSL_CTX *ctx; int min, max; GetSSLCTX(self, ctx); min = parse_proto_version(min_v); max = parse_proto_version(max_v); #ifdef HAVE_SSL_CTX_SET_MIN_PROTO_VERSION if (!SSL_CTX_set_min_proto_version(ctx, min)) ossl_raise(eSSLError, "SSL_CTX_set_min_proto_version"); if (!SSL_CTX_set_max_proto_version(ctx, max)) ossl_raise(eSSLError, "SSL_CTX_set_max_proto_version"); #else { unsigned long sum = 0, opts = 0; int i; static const struct { int ver; unsigned long opts; } options_map[] = { { SSL2_VERSION, SSL_OP_NO_SSLv2 }, { SSL3_VERSION, SSL_OP_NO_SSLv3 }, { TLS1_VERSION, SSL_OP_NO_TLSv1 }, { TLS1_1_VERSION, SSL_OP_NO_TLSv1_1 }, { TLS1_2_VERSION, SSL_OP_NO_TLSv1_2 }, # if defined(TLS1_3_VERSION) { TLS1_3_VERSION, SSL_OP_NO_TLSv1_3 }, # endif }; for (i = 0; i < numberof(options_map); i++) { sum |= options_map[i].opts; if ((min && min > options_map[i].ver) || (max && max < options_map[i].ver)) { opts |= options_map[i].opts; } } SSL_CTX_clear_options(ctx, sum); SSL_CTX_set_options(ctx, opts); } #endif return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"%OpenSSL::SSL::SSLContext#ciphers;F;[;[[@äÇií;T;:ciphers;0;[;{;IC;";The list of cipher suites configured for this context. ;T;[o;= ;3I" overload;F;40;; ;50;)I"ciphers;T;IC;";T; @µ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @µ;[;I"@return [Array];T;0;6i;[; @µ;[;I"aThe list of cipher suites configured for this context. @overload ciphers @return [Array];T;0; @µ;!F;"o;#;$T;%iç;&ië;'@z;(I"ûstatic VALUE ossl_sslctx_get_ciphers(VALUE self) { SSL_CTX *ctx; STACK_OF(SSL_CIPHER) *ciphers; const SSL_CIPHER *cipher; VALUE ary; int i, num; GetSSLCTX(self, ctx); ciphers = SSL_CTX_get_ciphers(ctx); if (!ciphers) return rb_ary_new(); num = sk_SSL_CIPHER_num(ciphers); ary = rb_ary_new2(num); for(i = 0; i < num; i++){ cipher = sk_SSL_CIPHER_value(ciphers, i); rb_ary_push(ary, ossl_ssl_cipher_to_ary(cipher)); } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::SSL::SSLContext#ciphers=;F;[[I"v;T0;[[@äÇi;T;: ciphers=;0;[;{;IC;"5ctx.ciphers = [name, ...] ctx.ciphers = [[name, version, bits, alg_bits], ...] Sets the list of available cipher suites for this context. Note in a server context some ciphers require the appropriate certificates. For example, an RSA cipher suite can only be chosen when an RSA certificate is available. ;T;[;[;I": ctx.ciphers = [name, ...] ctx.ciphers = [[name, version, bits, alg_bits], ...] Sets the list of available cipher suites for this context. Note in a server context some ciphers require the appropriate certificates. For example, an RSA cipher suite can only be chosen when an RSA certificate is available. ;T;0; @Ð;!F;"o;#;$T;%i;&i;'@z;(I"static VALUE ossl_sslctx_set_ciphers(VALUE self, VALUE v) { SSL_CTX *ctx; VALUE str, elem; int i; rb_check_frozen(self); if (NIL_P(v)) return v; else if (RB_TYPE_P(v, T_ARRAY)) { str = rb_str_new(0, 0); for (i = 0; i < RARRAY_LEN(v); i++) { elem = rb_ary_entry(v, i); if (RB_TYPE_P(elem, T_ARRAY)) elem = rb_ary_entry(elem, 0); elem = rb_String(elem); rb_str_append(str, elem); if (i < RARRAY_LEN(v)-1) rb_str_cat2(str, ":"); } } else { str = v; StringValue(str); } GetSSLCTX(self, ctx); if (!SSL_CTX_set_cipher_list(ctx, StringValueCStr(str))) { ossl_raise(eSSLError, "SSL_CTX_set_cipher_list"); } return v; };T;)I"static VALUE;T;*To;;F; ;;;;I"*OpenSSL::SSL::SSLContext#ecdh_curves=;F;[[I"arg;T0;[[@äÇiJ;T;:ecdh_curves=;0;[;{;IC;"#Sets the list of "supported elliptic curves" for this context. For a TLS client, the list is directly used in the Supported Elliptic Curves Extension. For a server, the list is used by OpenSSL to determine the set of shared curves. OpenSSL will pick the most appropriate one from it. Note that this works differently with old OpenSSL (<= 1.0.1). Only one curve can be set, and this has no effect for TLS clients. === Example ctx1 = OpenSSL::SSL::SSLContext.new ctx1.ecdh_curves = "X25519:P-256:P-224" svr = OpenSSL::SSL::SSLServer.new(tcp_svr, ctx1) Thread.new { svr.accept } ctx2 = OpenSSL::SSL::SSLContext.new ctx2.ecdh_curves = "P-256" cli = OpenSSL::SSL::SSLSocket.new(tcp_sock, ctx2) cli.connect p cli.tmp_key.group.curve_name # => "prime256v1" (is an alias for NIST P-256) ;T;[o;= ;3I" overload;F;40;;;50;)I"ecdh_curves=(curve_list);T;IC;";T; @à;>0;!F;[;[;I";T;0;6i;[[I"curve_list;T0; @à;[;I"HSets the list of "supported elliptic curves" for this context. For a TLS client, the list is directly used in the Supported Elliptic Curves Extension. For a server, the list is used by OpenSSL to determine the set of shared curves. OpenSSL will pick the most appropriate one from it. Note that this works differently with old OpenSSL (<= 1.0.1). Only one curve can be set, and this has no effect for TLS clients. === Example ctx1 = OpenSSL::SSL::SSLContext.new ctx1.ecdh_curves = "X25519:P-256:P-224" svr = OpenSSL::SSL::SSLServer.new(tcp_svr, ctx1) Thread.new { svr.accept } ctx2 = OpenSSL::SSL::SSLContext.new ctx2.ecdh_curves = "P-256" cli = OpenSSL::SSL::SSLSocket.new(tcp_sock, ctx2) cli.connect p cli.tmp_key.group.curve_name # => "prime256v1" (is an alias for NIST P-256) @overload ecdh_curves=(curve_list);T;0; @à;!F;"o;#;$T;%i/;&iG;'@z;(I"´static VALUE ossl_sslctx_set_ecdh_curves(VALUE self, VALUE arg) { SSL_CTX *ctx; rb_check_frozen(self); GetSSLCTX(self, ctx); StringValueCStr(arg); #if defined(HAVE_SSL_CTX_SET1_CURVES_LIST) if (!SSL_CTX_set1_curves_list(ctx, RSTRING_PTR(arg))) ossl_raise(eSSLError, NULL); #else /* OpenSSL does not have SSL_CTX_set1_curves_list()... Fallback to * SSL_CTX_set_tmp_ecdh(). So only the first curve is used. */ { VALUE curve, splitted; EC_KEY *ec; int nid; splitted = rb_str_split(arg, ":"); if (!RARRAY_LEN(splitted)) ossl_raise(eSSLError, "invalid input format"); curve = RARRAY_AREF(splitted, 0); StringValueCStr(curve); /* SSL_CTX_set1_curves_list() accepts NIST names */ nid = EC_curve_nist2nid(RSTRING_PTR(curve)); if (nid == NID_undef) nid = OBJ_txt2nid(RSTRING_PTR(curve)); if (nid == NID_undef) ossl_raise(eSSLError, "unknown curve name"); ec = EC_KEY_new_by_curve_name(nid); if (!ec) ossl_raise(eSSLError, NULL); EC_KEY_set_asn1_flag(ec, OPENSSL_EC_NAMED_CURVE); if (!SSL_CTX_set_tmp_ecdh(ctx, ec)) { EC_KEY_free(ec); ossl_raise(eSSLError, "SSL_CTX_set_tmp_ecdh"); } EC_KEY_free(ec); # if defined(HAVE_SSL_CTX_SET_ECDH_AUTO) /* tmp_ecdh and ecdh_auto conflict. tmp_ecdh is ignored when ecdh_auto * is enabled. So disable ecdh_auto. */ if (!SSL_CTX_set_ecdh_auto(ctx, 0)) ossl_raise(eSSLError, "SSL_CTX_set_ecdh_auto"); # endif } #endif return arg; };T;)I"static VALUE;T;*To;;F; ;;;;I",OpenSSL::SSL::SSLContext#security_level;F;[;[[@äÇi‹;T;:security_level;0;[;{;IC;"dReturns the security level for the context. See also OpenSSL::SSL::SSLContext#security_level=. ;T;[o;= ;3I" overload;F;40;;;50;)I"security_level;T;IC;";T; @ú;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ú;[;I"@return [Integer];T;0;6i;[; @ú;[;I"ŽReturns the security level for the context. See also OpenSSL::SSL::SSLContext#security_level=. @overload security_level @return [Integer];T;0; @ú;!F;"o;#;$T;%iƒ;&i‰;'@z;(I"þstatic VALUE ossl_sslctx_get_security_level(VALUE self) { SSL_CTX *ctx; GetSSLCTX(self, ctx); #if defined(HAVE_SSL_CTX_GET_SECURITY_LEVEL) return INT2NUM(SSL_CTX_get_security_level(ctx)); #else (void)ctx; return INT2FIX(0); #endif };T;)I"static VALUE;T;*To;;F; ;;;;I"-OpenSSL::SSL::SSLContext#security_level=;F;[[I" value;T0;[[@äÇi;T;:security_level=;0;[;{;IC;"ûSets the security level for the context. OpenSSL limits parameters according to the level. The "parameters" include: ciphersuites, curves, key sizes, certificate signature algorithms, protocol version and so on. For example, level 1 rejects parameters offering below 80 bits of security, such as ciphersuites using MD5 for the MAC or RSA keys shorter than 1024 bits. Note that attempts to set such parameters with insufficient security are also blocked. You need to lower the level first. This feature is not supported in OpenSSL < 1.1.0, and setting the level to other than 0 will raise NotImplementedError. Level 0 means everything is permitted, the same behavior as previous versions of OpenSSL. See the manpage of SSL_CTX_set_security_level(3) for details. ;T;[o;= ;3I" overload;F;40;;;50;)I"security_level=(integer);T;IC;";T; @;>0;!F;[;[;I";T;0;6i;[[I"integer;T0; @;[;I" Sets the security level for the context. OpenSSL limits parameters according to the level. The "parameters" include: ciphersuites, curves, key sizes, certificate signature algorithms, protocol version and so on. For example, level 1 rejects parameters offering below 80 bits of security, such as ciphersuites using MD5 for the MAC or RSA keys shorter than 1024 bits. Note that attempts to set such parameters with insufficient security are also blocked. You need to lower the level first. This feature is not supported in OpenSSL < 1.1.0, and setting the level to other than 0 will raise NotImplementedError. Level 0 means everything is permitted, the same behavior as previous versions of OpenSSL. See the manpage of SSL_CTX_set_security_level(3) for details. @overload security_level=(integer);T;0; @;!F;"o;#;$T;%iš;&iª;'@z;(I"»static VALUE ossl_sslctx_set_security_level(VALUE self, VALUE value) { SSL_CTX *ctx; rb_check_frozen(self); GetSSLCTX(self, ctx); #if defined(HAVE_SSL_CTX_GET_SECURITY_LEVEL) SSL_CTX_set_security_level(ctx, NUM2INT(value)); #else (void)ctx; if (NUM2INT(value) != 0) ossl_raise(rb_eNotImpError, "setting security level to other than 0 is " "not supported in this version of OpenSSL"); #endif return value; };T;)I"static VALUE;T;*To;;F; ;;;;I"2OpenSSL::SSL::SSLContext#enable_fallback_scsv;F;[;[[@äÇiÉ;T;:enable_fallback_scsv;0;[;{;IC;"?Activate TLS_FALLBACK_SCSV for this context. See RFC 7507. ;T;[o;= ;3I" overload;F;40;;;50;)I"enable_fallback_scsv();T;IC;";T; @/;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @/;[;I"@return [nil];T;0;6i;[; @/;[;I"rActivate TLS_FALLBACK_SCSV for this context. See RFC 7507. @overload enable_fallback_scsv() @return [nil];T;0; @/;!F;"o;#;$T;%iÂ;&iÇ;'@z;(I"´static VALUE ossl_sslctx_enable_fallback_scsv(VALUE self) { SSL_CTX *ctx; GetSSLCTX(self, ctx); SSL_CTX_set_mode(ctx, SSL_MODE_SEND_FALLBACK_SCSV); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"-OpenSSL::SSL::SSLContext#add_certificate;F;[[@c0;[[@äÇiü;T;:add_certificate;0;[;{;IC;"Adds a certificate to the context. _pkey_ must be a corresponding private key with _certificate_. Multiple certificates with different public key type can be added by repeated calls of this method, and OpenSSL will choose the most appropriate certificate during the handshake. #cert=, #key=, and #extra_chain_cert= are old accessor methods for setting certificate and internally call this method. === Parameters _certificate_:: A certificate. An instance of OpenSSL::X509::Certificate. _pkey_:: The private key for _certificate_. An instance of OpenSSL::PKey::PKey. _extra_certs_:: Optional. An array of OpenSSL::X509::Certificate. When sending a certificate chain, the certificates specified by this are sent following _certificate_, in the order in the array. === Example rsa_cert = OpenSSL::X509::Certificate.new(...) rsa_pkey = OpenSSL::PKey.read(...) ca_intermediate_cert = OpenSSL::X509::Certificate.new(...) ctx.add_certificate(rsa_cert, rsa_pkey, [ca_intermediate_cert]) ecdsa_cert = ... ecdsa_pkey = ... another_ca_cert = ... ctx.add_certificate(ecdsa_cert, ecdsa_pkey, [another_ca_cert]) === Note OpenSSL before the version 1.0.2 could handle only one extra chain across all key types. Calling this method discards the chain set previously. ;T;[o;= ;3I" overload;F;40;;;50;)I"7add_certificate(certiticate, pkey [, extra_certs]);T;IC;";T; @J;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @J;[;I"@return [self];T;0;6i;[[I"certiticate;T0[I"pkey[, extra_certs];T0; @J;[;I"RAdds a certificate to the context. _pkey_ must be a corresponding private key with _certificate_. Multiple certificates with different public key type can be added by repeated calls of this method, and OpenSSL will choose the most appropriate certificate during the handshake. #cert=, #key=, and #extra_chain_cert= are old accessor methods for setting certificate and internally call this method. === Parameters _certificate_:: A certificate. An instance of OpenSSL::X509::Certificate. _pkey_:: The private key for _certificate_. An instance of OpenSSL::PKey::PKey. _extra_certs_:: Optional. An array of OpenSSL::X509::Certificate. When sending a certificate chain, the certificates specified by this are sent following _certificate_, in the order in the array. === Example rsa_cert = OpenSSL::X509::Certificate.new(...) rsa_pkey = OpenSSL::PKey.read(...) ca_intermediate_cert = OpenSSL::X509::Certificate.new(...) ctx.add_certificate(rsa_cert, rsa_pkey, [ca_intermediate_cert]) ecdsa_cert = ... ecdsa_pkey = ... another_ca_cert = ... ctx.add_certificate(ecdsa_cert, ecdsa_pkey, [another_ca_cert]) === Note OpenSSL before the version 1.0.2 could handle only one extra chain across all key types. Calling this method discards the chain set previously. @overload add_certificate(certiticate, pkey [, extra_certs]) @return [self];T;0; @J;!F;"o;#;$T;%iÕ;&iú;'@z;(I"Fstatic VALUE ossl_sslctx_add_certificate(int argc, VALUE *argv, VALUE self) { VALUE cert, key, extra_chain_ary; SSL_CTX *ctx; X509 *x509; STACK_OF(X509) *extra_chain = NULL; EVP_PKEY *pkey, *pub_pkey; GetSSLCTX(self, ctx); rb_scan_args(argc, argv, "21", &cert, &key, &extra_chain_ary); rb_check_frozen(self); x509 = GetX509CertPtr(cert); pkey = GetPrivPKeyPtr(key); /* * The reference counter is bumped, and decremented immediately. * X509_get0_pubkey() is only available in OpenSSL >= 1.1.0. */ pub_pkey = X509_get_pubkey(x509); EVP_PKEY_free(pub_pkey); if (!pub_pkey) rb_raise(rb_eArgError, "certificate does not contain public key"); if (EVP_PKEY_cmp(pub_pkey, pkey) != 1) rb_raise(rb_eArgError, "public key mismatch"); if (argc >= 3) extra_chain = ossl_x509_ary2sk(extra_chain_ary); if (!SSL_CTX_use_certificate(ctx, x509)) { sk_X509_pop_free(extra_chain, X509_free); ossl_raise(eSSLError, "SSL_CTX_use_certificate"); } if (!SSL_CTX_use_PrivateKey(ctx, pkey)) { sk_X509_pop_free(extra_chain, X509_free); ossl_raise(eSSLError, "SSL_CTX_use_PrivateKey"); } if (extra_chain) { #if OPENSSL_VERSION_NUMBER >= 0x10002000 && !defined(LIBRESSL_VERSION_NUMBER) if (!SSL_CTX_set0_chain(ctx, extra_chain)) { sk_X509_pop_free(extra_chain, X509_free); ossl_raise(eSSLError, "SSL_CTX_set0_chain"); } #else STACK_OF(X509) *orig_extra_chain; X509 *x509_tmp; /* First, clear the existing chain */ SSL_CTX_get_extra_chain_certs(ctx, &orig_extra_chain); if (orig_extra_chain && sk_X509_num(orig_extra_chain)) { rb_warning("SSL_CTX_set0_chain() is not available; " \ "clearing previously set certificate chain"); SSL_CTX_clear_extra_chain_certs(ctx); } while ((x509_tmp = sk_X509_shift(extra_chain))) { /* Transfers ownership */ if (!SSL_CTX_add_extra_chain_cert(ctx, x509_tmp)) { X509_free(x509_tmp); sk_X509_pop_free(extra_chain, X509_free); ossl_raise(eSSLError, "SSL_CTX_add_extra_chain_cert"); } } sk_X509_free(extra_chain); #endif } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::SSL::SSLContext#setup;F;[;[[@äÇi;T;: setup;0;[;{;IC;"µThis method is called automatically when a new SSLSocket is created. However, it is not thread-safe and must be called before creating SSLSocket objects in a multi-threaded program. ;T;[o;= ;3I" overload;F;40;;;50;)I" setup;T;IC;";T; @j;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Qtrue #firstt time;T; @j;[;I"!@return [Qtrue # first time];T;0;6i;[; @jo;= ;3I" overload;F;40;;;50;)I" setup;T;IC;";T; @j;>0;!F;[;[;I";T;0;6i;[; @j;[;I"öThis method is called automatically when a new SSLSocket is created. However, it is not thread-safe and must be called before creating SSLSocket objects in a multi-threaded program. @overload setup @return [Qtrue # first time] @overload setup;T;0; o;;F; ;;;;I"$OpenSSL::SSL::SSLContext#freeze;F;[;[[@äÇi;F;;p;;K;[;{;@q;'@z;)I"static VALUE;T;(I"static VALUE ossl_sslctx_setup(VALUE self) { SSL_CTX *ctx; X509 *cert = NULL, *client_ca = NULL; EVP_PKEY *key = NULL; char *ca_path = NULL, *ca_file = NULL; int verify_mode; long i; VALUE val; if(OBJ_FROZEN(self)) return Qnil; GetSSLCTX(self, ctx); #if !defined(OPENSSL_NO_DH) SSL_CTX_set_tmp_dh_callback(ctx, ossl_tmp_dh_callback); #endif #if !defined(OPENSSL_NO_EC) /* We added SSLContext#tmp_ecdh_callback= in Ruby 2.3.0, * but SSL_CTX_set_tmp_ecdh_callback() was removed in OpenSSL 1.1.0. */ if (RTEST(rb_attr_get(self, id_i_tmp_ecdh_callback))) { # if defined(HAVE_SSL_CTX_SET_TMP_ECDH_CALLBACK) rb_warn("#tmp_ecdh_callback= is deprecated; use #ecdh_curves= instead"); SSL_CTX_set_tmp_ecdh_callback(ctx, ossl_tmp_ecdh_callback); # if defined(HAVE_SSL_CTX_SET_ECDH_AUTO) /* tmp_ecdh_callback and ecdh_auto conflict; OpenSSL ignores * tmp_ecdh_callback. So disable ecdh_auto. */ if (!SSL_CTX_set_ecdh_auto(ctx, 0)) ossl_raise(eSSLError, "SSL_CTX_set_ecdh_auto"); # endif # else ossl_raise(eSSLError, "OpenSSL does not support tmp_ecdh_callback; " "use #ecdh_curves= instead"); # endif } #endif /* OPENSSL_NO_EC */ #ifdef HAVE_SSL_CTX_SET_POST_HANDSHAKE_AUTH SSL_CTX_set_post_handshake_auth(ctx, 1); #endif val = rb_attr_get(self, id_i_cert_store); if (!NIL_P(val)) { X509_STORE *store = GetX509StorePtr(val); /* NO NEED TO DUP */ SSL_CTX_set_cert_store(ctx, store); #if !defined(HAVE_X509_STORE_UP_REF) /* * WORKAROUND: * X509_STORE can count references, but * X509_STORE_free() doesn't care it. * So we won't increment it but mark it by ex_data. */ SSL_CTX_set_ex_data(ctx, ossl_sslctx_ex_store_p, ctx); #else /* Fixed in OpenSSL 1.0.2; bff9ce4db38b (master), 5b4b9ce976fc (1.0.2) */ X509_STORE_up_ref(store); #endif } val = rb_attr_get(self, id_i_extra_chain_cert); if(!NIL_P(val)){ rb_block_call(val, rb_intern("each"), 0, 0, ossl_sslctx_add_extra_chain_cert_i, self); } /* private key may be bundled in certificate file. */ val = rb_attr_get(self, id_i_cert); cert = NIL_P(val) ? NULL : GetX509CertPtr(val); /* NO DUP NEEDED */ val = rb_attr_get(self, id_i_key); key = NIL_P(val) ? NULL : GetPrivPKeyPtr(val); /* NO DUP NEEDED */ if (cert && key) { if (!SSL_CTX_use_certificate(ctx, cert)) { /* Adds a ref => Safe to FREE */ ossl_raise(eSSLError, "SSL_CTX_use_certificate"); } if (!SSL_CTX_use_PrivateKey(ctx, key)) { /* Adds a ref => Safe to FREE */ ossl_raise(eSSLError, "SSL_CTX_use_PrivateKey"); } if (!SSL_CTX_check_private_key(ctx)) { ossl_raise(eSSLError, "SSL_CTX_check_private_key"); } } val = rb_attr_get(self, id_i_client_ca); if(!NIL_P(val)){ if (RB_TYPE_P(val, T_ARRAY)) { for(i = 0; i < RARRAY_LEN(val); i++){ client_ca = GetX509CertPtr(RARRAY_AREF(val, i)); if (!SSL_CTX_add_client_CA(ctx, client_ca)){ /* Copies X509_NAME => FREE it. */ ossl_raise(eSSLError, "SSL_CTX_add_client_CA"); } } } else{ client_ca = GetX509CertPtr(val); /* NO DUP NEEDED. */ if (!SSL_CTX_add_client_CA(ctx, client_ca)){ /* Copies X509_NAME => FREE it. */ ossl_raise(eSSLError, "SSL_CTX_add_client_CA"); } } } val = rb_attr_get(self, id_i_ca_file); ca_file = NIL_P(val) ? NULL : StringValueCStr(val); val = rb_attr_get(self, id_i_ca_path); ca_path = NIL_P(val) ? NULL : StringValueCStr(val); if(ca_file || ca_path){ if (!SSL_CTX_load_verify_locations(ctx, ca_file, ca_path)) rb_warning("can't set verify locations"); } val = rb_attr_get(self, id_i_verify_mode); verify_mode = NIL_P(val) ? SSL_VERIFY_NONE : NUM2INT(val); SSL_CTX_set_verify(ctx, verify_mode, ossl_ssl_verify_callback); if (RTEST(rb_attr_get(self, id_i_client_cert_cb))) SSL_CTX_set_client_cert_cb(ctx, ossl_client_cert_cb); val = rb_attr_get(self, id_i_timeout); if(!NIL_P(val)) SSL_CTX_set_timeout(ctx, NUM2LONG(val)); val = rb_attr_get(self, id_i_verify_depth); if(!NIL_P(val)) SSL_CTX_set_verify_depth(ctx, NUM2INT(val)); #ifndef OPENSSL_NO_NEXTPROTONEG val = rb_attr_get(self, id_i_npn_protocols); if (!NIL_P(val)) { VALUE encoded = ssl_encode_npn_protocols(val); rb_ivar_set(self, id_npn_protocols_encoded, encoded); SSL_CTX_set_next_protos_advertised_cb(ctx, ssl_npn_advertise_cb, (void *)self); OSSL_Debug("SSL NPN advertise callback added"); } if (RTEST(rb_attr_get(self, id_i_npn_select_cb))) { SSL_CTX_set_next_proto_select_cb(ctx, ssl_npn_select_cb, (void *) self); OSSL_Debug("SSL NPN select callback added"); } #endif #ifdef HAVE_SSL_CTX_SET_ALPN_SELECT_CB val = rb_attr_get(self, id_i_alpn_protocols); if (!NIL_P(val)) { VALUE rprotos = ssl_encode_npn_protocols(val); /* returns 0 on success */ if (SSL_CTX_set_alpn_protos(ctx, (unsigned char *)RSTRING_PTR(rprotos), RSTRING_LENINT(rprotos))) ossl_raise(eSSLError, "SSL_CTX_set_alpn_protos"); OSSL_Debug("SSL ALPN values added"); } if (RTEST(rb_attr_get(self, id_i_alpn_select_cb))) { SSL_CTX_set_alpn_select_cb(ctx, ssl_alpn_select_cb, (void *) self); OSSL_Debug("SSL ALPN select callback added"); } #endif rb_obj_freeze(self); val = rb_attr_get(self, id_i_session_id_context); if (!NIL_P(val)){ StringValue(val); if (!SSL_CTX_set_session_id_context(ctx, (unsigned char *)RSTRING_PTR(val), RSTRING_LENINT(val))){ ossl_raise(eSSLError, "SSL_CTX_set_session_id_context"); } } if (RTEST(rb_attr_get(self, id_i_session_get_cb))) { SSL_CTX_sess_set_get_cb(ctx, ossl_sslctx_session_get_cb); OSSL_Debug("SSL SESSION get callback added"); } if (RTEST(rb_attr_get(self, id_i_session_new_cb))) { SSL_CTX_sess_set_new_cb(ctx, ossl_sslctx_session_new_cb); OSSL_Debug("SSL SESSION new callback added"); } if (RTEST(rb_attr_get(self, id_i_session_remove_cb))) { SSL_CTX_sess_set_remove_cb(ctx, ossl_sslctx_session_remove_cb); OSSL_Debug("SSL SESSION remove callback added"); } val = rb_attr_get(self, id_i_servername_cb); if (!NIL_P(val)) { SSL_CTX_set_tlsext_servername_callback(ctx, ssl_servername_cb); OSSL_Debug("SSL TLSEXT servername callback added"); } return Qtrue; };T;!F;"o;#;$T;%i;&i;'@z;(I"static VALUE ossl_sslctx_setup(VALUE self) { SSL_CTX *ctx; X509 *cert = NULL, *client_ca = NULL; EVP_PKEY *key = NULL; char *ca_path = NULL, *ca_file = NULL; int verify_mode; long i; VALUE val; if(OBJ_FROZEN(self)) return Qnil; GetSSLCTX(self, ctx); #if !defined(OPENSSL_NO_DH) SSL_CTX_set_tmp_dh_callback(ctx, ossl_tmp_dh_callback); #endif #if !defined(OPENSSL_NO_EC) /* We added SSLContext#tmp_ecdh_callback= in Ruby 2.3.0, * but SSL_CTX_set_tmp_ecdh_callback() was removed in OpenSSL 1.1.0. */ if (RTEST(rb_attr_get(self, id_i_tmp_ecdh_callback))) { # if defined(HAVE_SSL_CTX_SET_TMP_ECDH_CALLBACK) rb_warn("#tmp_ecdh_callback= is deprecated; use #ecdh_curves= instead"); SSL_CTX_set_tmp_ecdh_callback(ctx, ossl_tmp_ecdh_callback); # if defined(HAVE_SSL_CTX_SET_ECDH_AUTO) /* tmp_ecdh_callback and ecdh_auto conflict; OpenSSL ignores * tmp_ecdh_callback. So disable ecdh_auto. */ if (!SSL_CTX_set_ecdh_auto(ctx, 0)) ossl_raise(eSSLError, "SSL_CTX_set_ecdh_auto"); # endif # else ossl_raise(eSSLError, "OpenSSL does not support tmp_ecdh_callback; " "use #ecdh_curves= instead"); # endif } #endif /* OPENSSL_NO_EC */ #ifdef HAVE_SSL_CTX_SET_POST_HANDSHAKE_AUTH SSL_CTX_set_post_handshake_auth(ctx, 1); #endif val = rb_attr_get(self, id_i_cert_store); if (!NIL_P(val)) { X509_STORE *store = GetX509StorePtr(val); /* NO NEED TO DUP */ SSL_CTX_set_cert_store(ctx, store); #if !defined(HAVE_X509_STORE_UP_REF) /* * WORKAROUND: * X509_STORE can count references, but * X509_STORE_free() doesn't care it. * So we won't increment it but mark it by ex_data. */ SSL_CTX_set_ex_data(ctx, ossl_sslctx_ex_store_p, ctx); #else /* Fixed in OpenSSL 1.0.2; bff9ce4db38b (master), 5b4b9ce976fc (1.0.2) */ X509_STORE_up_ref(store); #endif } val = rb_attr_get(self, id_i_extra_chain_cert); if(!NIL_P(val)){ rb_block_call(val, rb_intern("each"), 0, 0, ossl_sslctx_add_extra_chain_cert_i, self); } /* private key may be bundled in certificate file. */ val = rb_attr_get(self, id_i_cert); cert = NIL_P(val) ? NULL : GetX509CertPtr(val); /* NO DUP NEEDED */ val = rb_attr_get(self, id_i_key); key = NIL_P(val) ? NULL : GetPrivPKeyPtr(val); /* NO DUP NEEDED */ if (cert && key) { if (!SSL_CTX_use_certificate(ctx, cert)) { /* Adds a ref => Safe to FREE */ ossl_raise(eSSLError, "SSL_CTX_use_certificate"); } if (!SSL_CTX_use_PrivateKey(ctx, key)) { /* Adds a ref => Safe to FREE */ ossl_raise(eSSLError, "SSL_CTX_use_PrivateKey"); } if (!SSL_CTX_check_private_key(ctx)) { ossl_raise(eSSLError, "SSL_CTX_check_private_key"); } } val = rb_attr_get(self, id_i_client_ca); if(!NIL_P(val)){ if (RB_TYPE_P(val, T_ARRAY)) { for(i = 0; i < RARRAY_LEN(val); i++){ client_ca = GetX509CertPtr(RARRAY_AREF(val, i)); if (!SSL_CTX_add_client_CA(ctx, client_ca)){ /* Copies X509_NAME => FREE it. */ ossl_raise(eSSLError, "SSL_CTX_add_client_CA"); } } } else{ client_ca = GetX509CertPtr(val); /* NO DUP NEEDED. */ if (!SSL_CTX_add_client_CA(ctx, client_ca)){ /* Copies X509_NAME => FREE it. */ ossl_raise(eSSLError, "SSL_CTX_add_client_CA"); } } } val = rb_attr_get(self, id_i_ca_file); ca_file = NIL_P(val) ? NULL : StringValueCStr(val); val = rb_attr_get(self, id_i_ca_path); ca_path = NIL_P(val) ? NULL : StringValueCStr(val); if(ca_file || ca_path){ if (!SSL_CTX_load_verify_locations(ctx, ca_file, ca_path)) rb_warning("can't set verify locations"); } val = rb_attr_get(self, id_i_verify_mode); verify_mode = NIL_P(val) ? SSL_VERIFY_NONE : NUM2INT(val); SSL_CTX_set_verify(ctx, verify_mode, ossl_ssl_verify_callback); if (RTEST(rb_attr_get(self, id_i_client_cert_cb))) SSL_CTX_set_client_cert_cb(ctx, ossl_client_cert_cb); val = rb_attr_get(self, id_i_timeout); if(!NIL_P(val)) SSL_CTX_set_timeout(ctx, NUM2LONG(val)); val = rb_attr_get(self, id_i_verify_depth); if(!NIL_P(val)) SSL_CTX_set_verify_depth(ctx, NUM2INT(val)); #ifndef OPENSSL_NO_NEXTPROTONEG val = rb_attr_get(self, id_i_npn_protocols); if (!NIL_P(val)) { VALUE encoded = ssl_encode_npn_protocols(val); rb_ivar_set(self, id_npn_protocols_encoded, encoded); SSL_CTX_set_next_protos_advertised_cb(ctx, ssl_npn_advertise_cb, (void *)self); OSSL_Debug("SSL NPN advertise callback added"); } if (RTEST(rb_attr_get(self, id_i_npn_select_cb))) { SSL_CTX_set_next_proto_select_cb(ctx, ssl_npn_select_cb, (void *) self); OSSL_Debug("SSL NPN select callback added"); } #endif #ifdef HAVE_SSL_CTX_SET_ALPN_SELECT_CB val = rb_attr_get(self, id_i_alpn_protocols); if (!NIL_P(val)) { VALUE rprotos = ssl_encode_npn_protocols(val); /* returns 0 on success */ if (SSL_CTX_set_alpn_protos(ctx, (unsigned char *)RSTRING_PTR(rprotos), RSTRING_LENINT(rprotos))) ossl_raise(eSSLError, "SSL_CTX_set_alpn_protos"); OSSL_Debug("SSL ALPN values added"); } if (RTEST(rb_attr_get(self, id_i_alpn_select_cb))) { SSL_CTX_set_alpn_select_cb(ctx, ssl_alpn_select_cb, (void *) self); OSSL_Debug("SSL ALPN select callback added"); } #endif rb_obj_freeze(self); val = rb_attr_get(self, id_i_session_id_context); if (!NIL_P(val)){ StringValue(val); if (!SSL_CTX_set_session_id_context(ctx, (unsigned char *)RSTRING_PTR(val), RSTRING_LENINT(val))){ ossl_raise(eSSLError, "SSL_CTX_set_session_id_context"); } } if (RTEST(rb_attr_get(self, id_i_session_get_cb))) { SSL_CTX_sess_set_get_cb(ctx, ossl_sslctx_session_get_cb); OSSL_Debug("SSL SESSION get callback added"); } if (RTEST(rb_attr_get(self, id_i_session_new_cb))) { SSL_CTX_sess_set_new_cb(ctx, ossl_sslctx_session_new_cb); OSSL_Debug("SSL SESSION new callback added"); } if (RTEST(rb_attr_get(self, id_i_session_remove_cb))) { SSL_CTX_sess_set_remove_cb(ctx, ossl_sslctx_session_remove_cb); OSSL_Debug("SSL SESSION remove callback added"); } val = rb_attr_get(self, id_i_servername_cb); if (!NIL_P(val)) { SSL_CTX_set_tlsext_servername_callback(ctx, ssl_servername_cb); OSSL_Debug("SSL TLSEXT servername callback added"); } return Qtrue; };T;)@‘;*T@Šo;{;[[@äÇi;F;:SESSION_CACHE_OFF;;};;;[;{;IC;",No session caching for client or server ;T;[;[;I"-No session caching for client or server ;T;0; @•;!F;"o;#;$T;%i;&i;'@z;I"0OpenSSL::SSL::SSLContext::SESSION_CACHE_OFF;F;~I"!LONG2NUM(SSL_SESS_CACHE_OFF);To;{;[[@äÇi;F;:SESSION_CACHE_CLIENT;;};;;[;{;IC;"+doesn't actually do anything in 0.9.8e ;T;[;[;I"+doesn't actually do anything in 0.9.8e;T;0; @¡;!F;"o;#;$T;%i;&i;'@z;I"3OpenSSL::SSL::SSLContext::SESSION_CACHE_CLIENT;F;~I"$LONG2NUM(SSL_SESS_CACHE_CLIENT);To;{;[[@äÇi;F;:SESSION_CACHE_SERVER;;};;;[;{;IC;"3Server sessions are added to the session cache ;T;[;[;I"4Server sessions are added to the session cache ;T;0; @;!F;"o;#;$T;%i;&i;'@z;I"3OpenSSL::SSL::SSLContext::SESSION_CACHE_SERVER;F;~I"$LONG2NUM(SSL_SESS_CACHE_SERVER);To;{;[[@äÇi";F;:SESSION_CACHE_BOTH;;};;;[;{;IC;"-no different than CACHE_SERVER in 0.9.8e ;T;[;[;I"-no different than CACHE_SERVER in 0.9.8e;T;0; @¹;!F;"o;#;$T;%i";&i";'@z;I"1OpenSSL::SSL::SSLContext::SESSION_CACHE_BOTH;F;~I""LONG2NUM(SSL_SESS_CACHE_BOTH);To;{;[[@äÇi*;F;: SESSION_CACHE_NO_AUTO_CLEAR;;};;;[;{;IC;"áNormally the session cache is checked for expired sessions every 255 connections. Since this may lead to a delay that cannot be controlled, the automatic flushing may be disabled and #flush_sessions can be called explicitly. ;T;[;[;I"âNormally the session cache is checked for expired sessions every 255 connections. Since this may lead to a delay that cannot be controlled, the automatic flushing may be disabled and #flush_sessions can be called explicitly. ;T;0; @Å;!F;"o;#;$T;%i$;&i(;'@z;I":OpenSSL::SSL::SSLContext::SESSION_CACHE_NO_AUTO_CLEAR;F;~I"+LONG2NUM(SSL_SESS_CACHE_NO_AUTO_CLEAR);To;{;[[@äÇi2;F;:%SESSION_CACHE_NO_INTERNAL_LOOKUP;;};;;[;{;IC;"|Always perform external lookups of sessions even if they are in the internal cache. This flag has no effect on clients ;T;[;[;I"}Always perform external lookups of sessions even if they are in the internal cache. This flag has no effect on clients ;T;0; @Ñ;!F;"o;#;$T;%i,;&i0;'@z;I"?OpenSSL::SSL::SSLContext::SESSION_CACHE_NO_INTERNAL_LOOKUP;F;~I"0LONG2NUM(SSL_SESS_CACHE_NO_INTERNAL_LOOKUP);To;{;[[@äÇi7;F;:$SESSION_CACHE_NO_INTERNAL_STORE;;};;;[;{;IC;">Never automatically store sessions in the internal store. ;T;[;[;I"?Never automatically store sessions in the internal store. ;T;0; @Ý;!F;"o;#;$T;%i4;&i5;'@z;I">OpenSSL::SSL::SSLContext::SESSION_CACHE_NO_INTERNAL_STORE;F;~I"/LONG2NUM(SSL_SESS_CACHE_NO_INTERNAL_STORE);To;{;[[@äÇi=;F;:SESSION_CACHE_NO_INTERNAL;;};;;[;{;IC;"WEnables both SESSION_CACHE_NO_INTERNAL_LOOKUP and SESSION_CACHE_NO_INTERNAL_STORE. ;T;[;[;I"XEnables both SESSION_CACHE_NO_INTERNAL_LOOKUP and SESSION_CACHE_NO_INTERNAL_STORE. ;T;0; @é;!F;"o;#;$T;%i9;&i;;'@z;I"8OpenSSL::SSL::SSLContext::SESSION_CACHE_NO_INTERNAL;F;~I")LONG2NUM(SSL_SESS_CACHE_NO_INTERNAL);To;;F; ;;;;I")OpenSSL::SSL::SSLContext#session_add;F;[[I"arg;T0;[[@äÇiG;T;:session_add;0;[;{;IC;")Adds _session_ to the session cache. ;T;[o;= ;3I" overload;F;40;;;50;)I"session_add(session);T;IC;";T; @õ;>0;!F;[;[;I";T;0;6i;[[I"session;T0; @õ;[;I"JAdds _session_ to the session cache. @overload session_add(session);T;0; @õ;!F;"o;#;$T;%iA;&iD;'@z;(I"ãstatic VALUE ossl_sslctx_session_add(VALUE self, VALUE arg) { SSL_CTX *ctx; SSL_SESSION *sess; GetSSLCTX(self, ctx); GetSSLSession(arg, sess); return SSL_CTX_add_session(ctx, sess) == 1 ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I",OpenSSL::SSL::SSLContext#session_remove;F;[[I"arg;T0;[[@äÇiY;T;:session_remove;0;[;{;IC;".Removes _session_ from the session cache. ;T;[o;= ;3I" overload;F;40;;;50;)I"session_remove(session);T;IC;";T; @ ;>0;!F;[;[;I";T;0;6i;[[I"session;T0; @ ;[;I"RRemoves _session_ from the session cache. @overload session_remove(session);T;0; @ ;!F;"o;#;$T;%iS;&iV;'@z;(I"éstatic VALUE ossl_sslctx_session_remove(VALUE self, VALUE arg) { SSL_CTX *ctx; SSL_SESSION *sess; GetSSLCTX(self, ctx); GetSSLSession(arg, sess); return SSL_CTX_remove_session(ctx, sess) == 1 ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"0OpenSSL::SSL::SSLContext#session_cache_mode;F;[;[[@äÇik;T;:session_cache_mode;0;[;{;IC;"$The current session cache mode. ;T;[o;= ;3I" overload;F;40;;;50;)I"session_cache_mode;T;IC;";T; @) ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @) ;[;I"@return [Integer];T;0;6i;[; @) ;[;I"WThe current session cache mode. @overload session_cache_mode @return [Integer];T;0; @) ;!F;"o;#;$T;%ie;&ii;'@z;(I"§static VALUE ossl_sslctx_get_session_cache_mode(VALUE self) { SSL_CTX *ctx; GetSSLCTX(self, ctx); return LONG2NUM(SSL_CTX_get_session_cache_mode(ctx)); };T;)I"static VALUE;T;*To;;F; ;;;;I"1OpenSSL::SSL::SSLContext#session_cache_mode=;F;[[I"arg;T0;[[@äÇi};T;:session_cache_mode=;0;[;{;IC;"—Sets the SSL session cache mode. Bitwise-or together the desired SESSION_CACHE_* constants to set. See SSL_CTX_set_session_cache_mode(3) for details. ;T;[o;= ;3I" overload;F;40;; ;50;)I"!session_cache_mode=(integer);T;IC;";T; @D ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @D ;[;I"@return [Integer];T;0;6i;[[I"integer;T0; @D ;[;I"ÔSets the SSL session cache mode. Bitwise-or together the desired SESSION_CACHE_* constants to set. See SSL_CTX_set_session_cache_mode(3) for details. @overload session_cache_mode=(integer) @return [Integer];T;0; @D ;!F;"o;#;$T;%iu;&i{;'@z;(I"Ástatic VALUE ossl_sslctx_set_session_cache_mode(VALUE self, VALUE arg) { SSL_CTX *ctx; GetSSLCTX(self, ctx); SSL_CTX_set_session_cache_mode(ctx, NUM2LONG(arg)); return arg; };T;)I"static VALUE;T;*To;;F; ;;;;I"0OpenSSL::SSL::SSLContext#session_cache_size;F;[;[[@äÇi;T;:session_cache_size;0;[;{;IC;"`Returns the current session cache size. Zero is used to represent an unlimited cache size. ;T;[o;= ;3I" overload;F;40;;!;50;)I"session_cache_size;T;IC;";T; @c ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @c ;[;I"@return [Integer];T;0;6i;[; @c ;[;I"ŽReturns the current session cache size. Zero is used to represent an unlimited cache size. @overload session_cache_size @return [Integer];T;0; @c ;!F;"o;#;$T;%i‰;&iŽ;'@z;(I"¤static VALUE ossl_sslctx_get_session_cache_size(VALUE self) { SSL_CTX *ctx; GetSSLCTX(self, ctx); return LONG2NUM(SSL_CTX_sess_get_cache_size(ctx)); };T;)I"static VALUE;T;*To;;F; ;;;;I"1OpenSSL::SSL::SSLContext#session_cache_size=;F;[[I"arg;T0;[[@äÇi¡;T;:session_cache_size=;0;[;{;IC;"ŠSets the session cache size. Returns the previously valid session cache size. Zero is used to represent an unlimited session cache size. ;T;[o;= ;3I" overload;F;40;;";50;)I"!session_cache_size=(integer);T;IC;";T; @~ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @~ ;[;I"@return [Integer];T;0;6i;[[I"integer;T0; @~ ;[;I"ÇSets the session cache size. Returns the previously valid session cache size. Zero is used to represent an unlimited session cache size. @overload session_cache_size=(integer) @return [Integer];T;0; @~ ;!F;"o;#;$T;%iš;&iŸ;'@z;(I"¾static VALUE ossl_sslctx_set_session_cache_size(VALUE self, VALUE arg) { SSL_CTX *ctx; GetSSLCTX(self, ctx); SSL_CTX_sess_set_cache_size(ctx, NUM2LONG(arg)); return arg; };T;)I"static VALUE;T;*To;;F; ;;;;I"1OpenSSL::SSL::SSLContext#session_cache_stats;F;[;[[@äÇiÃ;T;:session_cache_stats;0;[;{;IC;"¹Returns a Hash containing the following keys: :accept:: Number of started SSL/TLS handshakes in server mode :accept_good:: Number of established SSL/TLS sessions in server mode :accept_renegotiate:: Number of start renegotiations in server mode :cache_full:: Number of sessions that were removed due to cache overflow :cache_hits:: Number of successfully reused connections :cache_misses:: Number of sessions proposed by clients that were not found in the cache :cache_num:: Number of sessions in the internal session cache :cb_hits:: Number of sessions retrieved from the external cache in server mode :connect:: Number of started SSL/TLS handshakes in client mode :connect_good:: Number of established SSL/TLS sessions in client mode :connect_renegotiate:: Number of start renegotiations in client mode :timeouts:: Number of sessions proposed by clients that were found in the cache but had expired due to timeouts ;T;[o;= ;3I" overload;F;40;;#;50;)I"session_cache_stats;T;IC;";T; @ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @ ;[;I"@return [Hash];T;0;6i;[; @ ;[;I"êReturns a Hash containing the following keys: :accept:: Number of started SSL/TLS handshakes in server mode :accept_good:: Number of established SSL/TLS sessions in server mode :accept_renegotiate:: Number of start renegotiations in server mode :cache_full:: Number of sessions that were removed due to cache overflow :cache_hits:: Number of successfully reused connections :cache_misses:: Number of sessions proposed by clients that were not found in the cache :cache_num:: Number of sessions in the internal session cache :cb_hits:: Number of sessions retrieved from the external cache in server mode :connect:: Number of started SSL/TLS handshakes in client mode :connect_good:: Number of established SSL/TLS sessions in client mode :connect_renegotiate:: Number of start renegotiations in client mode :timeouts:: Number of sessions proposed by clients that were found in the cache but had expired due to timeouts @overload session_cache_stats @return [Hash];T;0; @ ;!F;"o;#;$T;%i;&iÁ;'@z;(I"9static VALUE ossl_sslctx_get_session_cache_stats(VALUE self) { SSL_CTX *ctx; VALUE hash; GetSSLCTX(self, ctx); hash = rb_hash_new(); rb_hash_aset(hash, ID2SYM(rb_intern("cache_num")), LONG2NUM(SSL_CTX_sess_number(ctx))); rb_hash_aset(hash, ID2SYM(rb_intern("connect")), LONG2NUM(SSL_CTX_sess_connect(ctx))); rb_hash_aset(hash, ID2SYM(rb_intern("connect_good")), LONG2NUM(SSL_CTX_sess_connect_good(ctx))); rb_hash_aset(hash, ID2SYM(rb_intern("connect_renegotiate")), LONG2NUM(SSL_CTX_sess_connect_renegotiate(ctx))); rb_hash_aset(hash, ID2SYM(rb_intern("accept")), LONG2NUM(SSL_CTX_sess_accept(ctx))); rb_hash_aset(hash, ID2SYM(rb_intern("accept_good")), LONG2NUM(SSL_CTX_sess_accept_good(ctx))); rb_hash_aset(hash, ID2SYM(rb_intern("accept_renegotiate")), LONG2NUM(SSL_CTX_sess_accept_renegotiate(ctx))); rb_hash_aset(hash, ID2SYM(rb_intern("cache_hits")), LONG2NUM(SSL_CTX_sess_hits(ctx))); rb_hash_aset(hash, ID2SYM(rb_intern("cb_hits")), LONG2NUM(SSL_CTX_sess_cb_hits(ctx))); rb_hash_aset(hash, ID2SYM(rb_intern("cache_misses")), LONG2NUM(SSL_CTX_sess_misses(ctx))); rb_hash_aset(hash, ID2SYM(rb_intern("cache_full")), LONG2NUM(SSL_CTX_sess_cache_full(ctx))); rb_hash_aset(hash, ID2SYM(rb_intern("timeouts")), LONG2NUM(SSL_CTX_sess_timeouts(ctx))); return hash; };T;)I"static VALUE;T;*To;;F; ;;;;I",OpenSSL::SSL::SSLContext#flush_sessions;F;[[@c0;[[@äÇiã;T;:flush_sessions;0;[;{;IC;"HRemoves sessions in the internal cache that have expired at _time_. ;T;[o;= ;3I" overload;F;40;;$;50;)I"flush_sessions(time);T;IC;";T; @¸ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @¸ ;[;I"@return [self];T;0;6i;[[I" time;T0; @¸ ;[;I"zRemoves sessions in the internal cache that have expired at _time_. @overload flush_sessions(time) @return [self];T;0; @¸ ;!F;"o;#;$T;%iÝ;&iá;'@z;(I"ýstatic VALUE ossl_sslctx_flush_sessions(int argc, VALUE *argv, VALUE self) { VALUE arg1; SSL_CTX *ctx; time_t tm = 0; rb_scan_args(argc, argv, "01", &arg1); GetSSLCTX(self, ctx); if (NIL_P(arg1)) { tm = time(0); } else if (rb_obj_is_instance_of(arg1, rb_cTime)) { tm = NUM2LONG(rb_funcall(arg1, rb_intern("to_i"), 0)); } else { ossl_raise(rb_eArgError, "arg must be Time or nil"); } SSL_CTX_flush_sessions(ctx, (long)tm); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"%OpenSSL::SSL::SSLContext#options;F;[;[[@äÇið;T;;+;0;[;{;IC;""Gets various OpenSSL options. ;T;[;[;I"#Gets various OpenSSL options. ;T;0; @Ö ;!F;"o;#;$T;%ií;&iî;'@z;(I"static VALUE ossl_sslctx_get_options(VALUE self) { SSL_CTX *ctx; GetSSLCTX(self, ctx); /* * Do explicit cast because SSL_CTX_get_options() returned (signed) long in * OpenSSL before 1.1.0. */ return ULONG2NUM((unsigned long)SSL_CTX_get_options(ctx)); };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::SSL::SSLContext#options=;F;[[I"options;T0;[[@äÇiÿ;T;: options=;0;[;{;IC;""Sets various OpenSSL options. ;T;[;[;I"#Sets various OpenSSL options. ;T;0; @ä ;!F;"o;#;$T;%iü;&iý;'@z;(I"\static VALUE ossl_sslctx_set_options(VALUE self, VALUE options) { SSL_CTX *ctx; rb_check_frozen(self); GetSSLCTX(self, ctx); SSL_CTX_clear_options(ctx, SSL_CTX_get_options(ctx)); if (NIL_P(options)) { SSL_CTX_set_options(ctx, SSL_OP_ALL); } else { SSL_CTX_set_options(ctx, NUM2ULONG(options)); } return self; };T;)I"static VALUE;T;*T;A@z;BIC;[;A@z;CIC;[;A@z;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@|;l@‡;m@Š;;I[;[[@äÇi [@äÇi ;T;:SSLContext;;K;;;[;{;IC;" An SSLContext is used to set various options regarding certificates, algorithms, verification, session caching, etc. The SSLContext is used to create an SSLSocket. All attributes must be set before creating an SSLSocket as the SSLContext will be frozen afterward. ;T;[;[;I" An SSLContext is used to set various options regarding certificates, algorithms, verification, session caching, etc. The SSLContext is used to create an SSLSocket. All attributes must be set before creating an SSLSocket as the SSLContext will be frozen afterward. ;T;0; @z;!F;"o;#;$T;%i ;&i ;'@Úæ;I"OpenSSL::SSL::SSLContext;F;S@]o; ;IC;[ o;;F; ;;;;I"'OpenSSL::SSL::SSLSocket#initialize;F;[[@c0;[[@ƒi*[@äÇi2;T;;Ð;0;[;{;IC;"Creates a new SSL socket from _io_ which must be a real IO object (not an IO-like object that responds to read/write). If _ctx_ is provided the SSL Sockets initial params will be taken from the context. The OpenSSL::Buffering module provides additional IO methods. This method will freeze the SSLContext if one is provided; however, session management is still allowed in the frozen SSLContext. ;T;[o;= ;3I" overload;F;40;;î;50;)I"new(io);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aSSLSocket;T; @;[;I"@return [aSSLSocket];T;0;6i;[[I"io;T0; @o;= ;3I" overload;F;40;;î;50;)I"new(io, ctx);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aSSLSocket;T; @;[;I"@return [aSSLSocket];T;0;6i;[[I"io;T0[I"ctx;T0; @;[;I"æCreates a new SSL socket from _io_ which must be a real IO object (not an IO-like object that responds to read/write). If _ctx_ is provided the SSL Sockets initial params will be taken from the context. The OpenSSL::Buffering module provides additional IO methods. This method will freeze the SSLContext if one is provided; however, session management is still allowed in the frozen SSLContext. @overload new(io) @return [aSSLSocket] @overload new(io, ctx) @return [aSSLSocket];T;0; @;!F;"o;#;$T;%i";&i1;'@;(I"‡VALUE rb_f_notimplement(int argc, const VALUE *argv, VALUE obj, VALUE marker) { rb_notimplement(); UNREACHABLE_RETURN(Qnil); };T;)I" VALUE;T;*To;;F; ;;;;I"$OpenSSL::SSL::SSLSocket#connect;F;[;[[@äÇiÚ;T;:connect;0;[;{;IC;"Initiates an SSL/TLS handshake with a server. The handshake may be started after unencrypted data has been sent over the socket. ;T;[o;= ;3I" overload;F;40;;';50;)I"connect;T;IC;";T; @8;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @8;[;I"@return [self];T;0;6i;[; @8;[;I"¦Initiates an SSL/TLS handshake with a server. The handshake may be started after unencrypted data has been sent over the socket. @overload connect @return [self];T;0; @8;!F;"o;#;$T;%iÓ;&iØ;'@;(I"static VALUE ossl_ssl_connect(VALUE self) { ossl_ssl_setup(self); return ossl_start_ssl(self, SSL_connect, "SSL_connect", Qfalse); };T;)I"static VALUE;T;*To;;F; ;;;;I"-OpenSSL::SSL::SSLSocket#connect_nonblock;F;[[@c0;[[@äÇiø;T;:connect_nonblock;0;[;{;IC;"çInitiates the SSL/TLS handshake as a client in non-blocking manner. # emulates blocking connect begin ssl.connect_nonblock rescue IO::WaitReadable IO.select([s2]) retry rescue IO::WaitWritable IO.select(nil, [s2]) retry end By specifying a keyword argument _exception_ to +false+, you can indicate that connect_nonblock should not raise an IO::WaitReadable or IO::WaitWritable exception, but return the symbol +:wait_readable+ or +:wait_writable+ instead. ;T;[o;= ;3I" overload;F;40;;(;50;)I" connect_nonblock([options]);T;IC;";T; @S;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @S;[;I"@return [self];T;0;6i;[[I"[options];T0; @S;[;I" Initiates the SSL/TLS handshake as a client in non-blocking manner. # emulates blocking connect begin ssl.connect_nonblock rescue IO::WaitReadable IO.select([s2]) retry rescue IO::WaitWritable IO.select(nil, [s2]) retry end By specifying a keyword argument _exception_ to +false+, you can indicate that connect_nonblock should not raise an IO::WaitReadable or IO::WaitWritable exception, but return the symbol +:wait_readable+ or +:wait_writable+ instead. @overload connect_nonblock([options]) @return [self];T;0; @S;!F;"o;#;$T;%iâ;&iö;'@;(I"çstatic VALUE ossl_ssl_connect_nonblock(int argc, VALUE *argv, VALUE self) { VALUE opts; rb_scan_args(argc, argv, "0:", &opts); ossl_ssl_setup(self); return ossl_start_ssl(self, SSL_connect, "SSL_connect", opts); };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::SSL::SSLSocket#accept;F;[;[[@äÇi ;T;:accept;0;[;{;IC;"‡Waits for a SSL/TLS client to initiate a handshake. The handshake may be started after unencrypted data has been sent over the socket. ;T;[o;= ;3I" overload;F;40;;);50;)I"accept;T;IC;";T; @q;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @q;[;I"@return [self];T;0;6i;[; @q;[;I"«Waits for a SSL/TLS client to initiate a handshake. The handshake may be started after unencrypted data has been sent over the socket. @overload accept @return [self];T;0; @q;!F;"o;#;$T;%i;&i;'@;(I"Šstatic VALUE ossl_ssl_accept(VALUE self) { ossl_ssl_setup(self); return ossl_start_ssl(self, SSL_accept, "SSL_accept", Qfalse); };T;)I"static VALUE;T;*To;;F; ;;;;I",OpenSSL::SSL::SSLSocket#accept_nonblock;F;[[@c0;[[@äÇi(;T;:accept_nonblock;0;[;{;IC;"äInitiates the SSL/TLS handshake as a server in non-blocking manner. # emulates blocking accept begin ssl.accept_nonblock rescue IO::WaitReadable IO.select([s2]) retry rescue IO::WaitWritable IO.select(nil, [s2]) retry end By specifying a keyword argument _exception_ to +false+, you can indicate that accept_nonblock should not raise an IO::WaitReadable or IO::WaitWritable exception, but return the symbol +:wait_readable+ or +:wait_writable+ instead. ;T;[o;= ;3I" overload;F;40;;*;50;)I"accept_nonblock([options]);T;IC;";T; @Œ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @Œ;[;I"@return [self];T;0;6i;[[I"[options];T0; @Œ;[;I"Initiates the SSL/TLS handshake as a server in non-blocking manner. # emulates blocking accept begin ssl.accept_nonblock rescue IO::WaitReadable IO.select([s2]) retry rescue IO::WaitWritable IO.select(nil, [s2]) retry end By specifying a keyword argument _exception_ to +false+, you can indicate that accept_nonblock should not raise an IO::WaitReadable or IO::WaitWritable exception, but return the symbol +:wait_readable+ or +:wait_writable+ instead. @overload accept_nonblock([options]) @return [self];T;0; @Œ;!F;"o;#;$T;%i;&i&;'@;(I"ästatic VALUE ossl_ssl_accept_nonblock(int argc, VALUE *argv, VALUE self) { VALUE opts; rb_scan_args(argc, argv, "0:", &opts); ossl_ssl_setup(self); return ossl_start_ssl(self, SSL_accept, "SSL_accept", opts); };T;)I"static VALUE;T;*To;;F; ;;;;I"$OpenSSL::SSL::SSLSocket#sysread;F;[[@c0;[[@äÇi©;T;;„;0;[;{;IC;"}Reads _length_ bytes from the SSL connection. If a pre-allocated _buffer_ is provided the data will be written into it. ;T;[o;= ;3I" overload;F;40;;„;50;)I"sysread(length);T;IC;";T; @ª;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ª;[;I"@return [String];T;0;6i;[[I"length;T0; @ªo;= ;3I" overload;F;40;;„;50;)I"sysread(length, buffer);T;IC;";T; @ª;>0;!F;[;[;I";T;0;6i;[[I"length;T0[I"buffer;T0; @ª;[;I"ÉReads _length_ bytes from the SSL connection. If a pre-allocated _buffer_ is provided the data will be written into it. @overload sysread(length) @return [String] @overload sysread(length, buffer);T;0; @ª;!F;"o;#;$T;%i¡;&i§;'@;(I"~static VALUE ossl_ssl_read(int argc, VALUE *argv, VALUE self) { return ossl_ssl_read_internal(argc, argv, self, 0); };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"-OpenSSL::SSL::SSLSocket#sysread_nonblock;F;[[@c0;[[@äÇi¼;T;:sysread_nonblock;0;[;{;IC;"UA non-blocking version of #sysread. Raises an SSLError if reading would block. If "exception: false" is passed, this method returns a symbol of :wait_readable, :wait_writable, or nil, rather than raising an exception. Reads _length_ bytes from the SSL connection. If a pre-allocated _buffer_ is provided the data will be written into it. ;T;[o;= ;3I" overload;F;40;;+;50;)I"sysread_nonblock(length);T;IC;";T; @Ô;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Ô;[;I"@return [String];T;0;6i;[[I"length;T0; @Ôo;= ;3I" overload;F;40;;+;50;)I"%sysread_nonblock(length, buffer);T;IC;";T; @Ô;>0;!F;[;[;I";T;0;6i;[[I"length;T0[I"buffer;T0; @Ôo;= ;3I" overload;F;40;;+;50;)I"/sysread_nonblock(length[, buffer [, opts]);T;IC;";T; @Ô;>0;!F;[;[;I";T;0;6i;[[I"length[, buffer [, opts]);T0; @Ô;[;I"íA non-blocking version of #sysread. Raises an SSLError if reading would block. If "exception: false" is passed, this method returns a symbol of :wait_readable, :wait_writable, or nil, rather than raising an exception. Reads _length_ bytes from the SSL connection. If a pre-allocated _buffer_ is provided the data will be written into it. @overload sysread_nonblock(length) @return [String] @overload sysread_nonblock(length, buffer) @overload sysread_nonblock(length[, buffer [, opts]);T;0; @Ô;!F;"o;#;$T;%i¯;&iº;'@;(I"‚static VALUE ossl_ssl_read_nonblock(int argc, VALUE *argv, VALUE self) { return ossl_ssl_read_internal(argc, argv, self, 1); };T;)I"static VALUE;T;*To;;F; ;;;;I"%OpenSSL::SSL::SSLSocket#syswrite;F;[[I"str;T0;[[@äÇi;T;;ƒ;0;[;{;IC;"+Writes _string_ to the SSL connection. ;T;[o;= ;3I" overload;F;40;;ƒ;50;)I"syswrite(string);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @;[;I"@return [Integer];T;0;6i;[[I"string;T0; @;[;I"\Writes _string_ to the SSL connection. @overload syswrite(string) @return [Integer];T;0; @;!F;"o;#;$T;%i;&i;'@;(I"rstatic VALUE ossl_ssl_write(VALUE self, VALUE str) { return ossl_ssl_write_internal(self, str, Qfalse); };T;)I"static VALUE;T;*To;;F; ;;;Ï;I".OpenSSL::SSL::SSLSocket#syswrite_nonblock;F;[[@c0;[[@äÇi";T;:syswrite_nonblock;0;[;{;IC;"pWrites _string_ to the SSL connection in a non-blocking manner. Raises an SSLError if writing would block. ;T;[o;= ;3I" overload;F;40;;,;50;)I"syswrite_nonblock(string);T;IC;";T; @';>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @';[;I"@return [Integer];T;0;6i;[[I"string;T0; @';[;I"¥Writes _string_ to the SSL connection in a non-blocking manner. Raises an SSLError if writing would block. @overload syswrite_nonblock(string) @return [Integer];T;0; @';!F;"o;#;$T;%i;&i ;'@;(I"Èstatic VALUE ossl_ssl_write_nonblock(int argc, VALUE *argv, VALUE self) { VALUE str, opts; rb_scan_args(argc, argv, "1:", &str, &opts); return ossl_ssl_write_internal(self, str, opts); };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"!OpenSSL::SSL::SSLSocket#stop;F;[;[[@äÇi3;T;;°;0;[;{;IC;"[Sends "close notify" to the peer and tries to shut down the SSL connection gracefully. ;T;[o;= ;3I" overload;F;40;;°;50;)I" stop;T;IC;";T; @E;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @E;[;I"@return [nil];T;0;6i;[; @E;[;I"|Sends "close notify" to the peer and tries to shut down the SSL connection gracefully. @overload stop @return [nil];T;0; @E;!F;"o;#;$T;%i,;&i1;'@;(I"•static VALUE ossl_ssl_stop(VALUE self) { SSL *ssl; int ret; GetSSL(self, ssl); if (!ssl_started(ssl)) return Qnil; ret = SSL_shutdown(ssl); if (ret == 1) /* Have already received close_notify */ return Qnil; if (ret == 0) /* Sent close_notify, but we don't wait for reply */ return Qnil; /* * XXX: Something happened. Possibly it failed because the underlying socket * is not writable/readable, since it is in non-blocking mode. We should do * some proper error handling using SSL_get_error() and maybe retry, but we * can't block here. Give up for now. */ ossl_clear_error(); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"!OpenSSL::SSL::SSLSocket#cert;F;[;[[@äÇiR;T;: cert;0;[;{;IC;"3The X509 certificate for this socket endpoint. ;T;[o;= ;3I" overload;F;40;;-;50;)I" cert;T;IC;";T; @`;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @`;[;I"@return [nil];T;0;6i;[; @`;[;I"TThe X509 certificate for this socket endpoint. @overload cert @return [nil];T;0; @`;!F;"o;#;$T;%iL;&iP;'@;(I"Nstatic VALUE ossl_ssl_get_cert(VALUE self) { SSL *ssl; X509 *cert = NULL; GetSSL(self, ssl); /* * Is this OpenSSL bug? Should add a ref? * TODO: Ask for. */ cert = SSL_get_certificate(ssl); /* NO DUPs => DON'T FREE. */ if (!cert) { return Qnil; } return ossl_x509_new(cert); };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::SSL::SSLSocket#peer_cert;F;[;[[@äÇil;T;:peer_cert;0;[;{;IC;"1The X509 certificate for this socket's peer. ;T;[o;= ;3I" overload;F;40;;.;50;)I"peer_cert;T;IC;";T; @{;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @{;[;I"@return [nil];T;0;6i;[; @{;[;I"WThe X509 certificate for this socket's peer. @overload peer_cert @return [nil];T;0; @{;!F;"o;#;$T;%if;&ij;'@;(I">static VALUE ossl_ssl_get_peer_cert(VALUE self) { SSL *ssl; X509 *cert = NULL; VALUE obj; GetSSL(self, ssl); cert = SSL_get_peer_certificate(ssl); /* Adds a ref => Safe to FREE. */ if (!cert) { return Qnil; } obj = ossl_x509_new(cert); X509_free(cert); return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I",OpenSSL::SSL::SSLSocket#peer_cert_chain;F;[;[[@äÇi†;T;:peer_cert_chain;0;[;{;IC;"7The X509 certificate chain for this socket's peer. ;T;[o;= ;3I" overload;F;40;;/;50;)I"peer_cert_chain;T;IC;";T; @–;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;TI"nil;T; @–;[;I"@return [Array, nil];T;0;6i;[; @–;[;I"jThe X509 certificate chain for this socket's peer. @overload peer_cert_chain @return [Array, nil];T;0; @–;!F;"o;#;$T;%i€;&i„;'@;(I"©static VALUE ossl_ssl_get_peer_cert_chain(VALUE self) { SSL *ssl; STACK_OF(X509) *chain; X509 *cert; VALUE ary; int i, num; GetSSL(self, ssl); chain = SSL_get_peer_cert_chain(ssl); if(!chain) return Qnil; num = sk_X509_num(chain); ary = rb_ary_new2(num); for (i = 0; i < num; i++){ cert = sk_X509_value(chain, i); rb_ary_push(ary, ossl_x509_new(cert)); } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"(OpenSSL::SSL::SSLSocket#ssl_version;F;[;[[@äÇi¤;T;:ssl_version;0;[;{;IC;"uReturns a String representing the SSL/TLS version that was negotiated for the connection, for example "TLSv1.2". ;T;[o;= ;3I" overload;F;40;;0;50;)I"ssl_version;T;IC;";T; @²;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @²;[;I"@return [String];T;0;6i;[; @²;[;I"›Returns a String representing the SSL/TLS version that was negotiated for the connection, for example "TLSv1.2". @overload ssl_version @return [String];T;0; @²;!F;"o;#;$T;%i;&i¢;'@;(I"†static VALUE ossl_ssl_get_version(VALUE self) { SSL *ssl; GetSSL(self, ssl); return rb_str_new2(SSL_get_version(ssl)); };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::SSL::SSLSocket#cipher;F;[;[[@äÇiµ;T;;e;0;[;{;IC;"nReturns the cipher suite actually used in the current session, or nil if no session has been established. ;T;[o;= ;3I" overload;F;40;;e;50;)I"cipher;T;IC;";T; @Í;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;TI" Array;T; @Í;[;I"@return [nil, Array];T;0;6i;[; @Í;[;I"“Returns the cipher suite actually used in the current session, or nil if no session has been established. @overload cipher @return [nil, Array];T;0; @Í;!F;"o;#;$T;%i®;&i³;'@;(I"Ùstatic VALUE ossl_ssl_get_cipher(VALUE self) { SSL *ssl; const SSL_CIPHER *cipher; GetSSL(self, ssl); cipher = SSL_get_current_cipher(ssl); return cipher ? ossl_ssl_cipher_to_ary(cipher) : Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::SSL::SSLSocket#state;F;[;[[@äÇiÇ;T;: state;0;[;{;IC;"YA description of the current connection state. This is for diagnostic purposes only. ;T;[o;= ;3I" overload;F;40;;1;50;)I" state;T;IC;";T; @é;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @é;[;I"@return [String];T;0;6i;[; @é;[;I"~A description of the current connection state. This is for diagnostic purposes only. @overload state @return [String];T;0; @é;!F;"o;#;$T;%iÀ;&iÅ;'@;(I"static VALUE ossl_ssl_get_state(VALUE self) { SSL *ssl; VALUE ret; GetSSL(self, ssl); ret = rb_str_new2(SSL_state_string(ssl)); if (ruby_verbose) { rb_str_cat2(ret, ": "); rb_str_cat2(ret, SSL_state_string_long(ssl)); } return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"$OpenSSL::SSL::SSLSocket#pending;F;[;[[@äÇiÝ;T;:pending;0;[;{;IC;"DThe number of bytes that are immediately available for reading. ;T;[o;= ;3I" overload;F;40;;2;50;)I"pending;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @;[;I"@return [Integer];T;0;6i;[; @;[;I"lThe number of bytes that are immediately available for reading. @overload pending @return [Integer];T;0; @;!F;"o;#;$T;%i×;&iÛ;'@;(I"static VALUE ossl_ssl_pending(VALUE self) { SSL *ssl; GetSSL(self, ssl); return INT2NUM(SSL_pending(ssl)); };T;)I"static VALUE;T;*To;;F; ;;;;I",OpenSSL::SSL::SSLSocket#session_reused?;F;[;[[@äÇií;T;:session_reused?;0;[;{;IC;"LReturns +true+ if a reused session was negotiated during the handshake.;T;[o;= ;3I" overload;F;40;;3;50;)I"session_reused?;T;IC;";T; @;>0;!F;[;[;I";T;0;6i;[; @o;2 ;3I"return;F;4@|;0;5[@~; @;[;I"hReturns +true+ if a reused session was negotiated during the handshake. @overload session_reused?;T;0; @;!F;"o;#;$T;%iç;&iê;6i;'@;(I"static VALUE ossl_ssl_session_reused(VALUE self) { SSL *ssl; GetSSL(self, ssl); return SSL_session_reused(ssl) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"%OpenSSL::SSL::SSLSocket#session=;F;[[I" arg1;T0;[[@äÇiý;T;: session=;0;[;{;IC;"DSets the Session to be used when the connection is established. ;T;[o;= ;3I" overload;F;40;;4;50;)I"session=(session);T;IC;";T; @8;>0;!F;[;[;I";T;0;6i;[[I"session;T0; @8;[;I"bSets the Session to be used when the connection is established. @overload session=(session);T;0; @8;!F;"o;#;$T;%i÷;&iú;'@;(I"static VALUE ossl_ssl_set_session(VALUE self, VALUE arg1) { SSL *ssl; SSL_SESSION *sess; GetSSL(self, ssl); GetSSLSession(arg1, sess); if (SSL_set_session(ssl, sess) != 1) ossl_raise(eSSLError, "SSL_set_session"); return arg1; };T;)I"static VALUE;T;*To;;F; ;;;;I"*OpenSSL::SSL::SSLSocket#verify_result;F;[;[[@äÇi0 ;T;:verify_result;0;[;{;IC;"¨Returns the result of the peer certificates verification. See verify(1) for error values and descriptions. If no peer certificate was presented X509_V_OK is returned. ;T;[o;= ;3I" overload;F;40;;5;50;)I"verify_result;T;IC;";T; @R;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @R;[;I"@return [Integer];T;0;6i;[; @R;[;I"ÖReturns the result of the peer certificates verification. See verify(1) for error values and descriptions. If no peer certificate was presented X509_V_OK is returned. @overload verify_result @return [Integer];T;0; @R;!F;"o;#;$T;%i' ;&i. ;'@;(I"static VALUE ossl_ssl_get_verify_result(VALUE self) { SSL *ssl; GetSSL(self, ssl); return LONG2NUM(SSL_get_verify_result(ssl)); };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::SSL::SSLSocket#client_ca;F;[;[[@äÇiw ;T;:client_ca;0;[;{;IC;"EReturns the list of client CAs. Please note that in contrast to SSLContext#client_ca= no array of X509::Certificate is returned but X509::Name instances of the CA's subject distinguished name. In server mode, returns the list set by SSLContext#client_ca=. In client mode, returns the list of client CAs sent from the server. ;T;[o;= ;3I" overload;F;40;;6;50;)I"client_ca;T;IC;";T; @m;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @m;[;I"@return [Array];T;0;6i;[; @m;[;I"mReturns the list of client CAs. Please note that in contrast to SSLContext#client_ca= no array of X509::Certificate is returned but X509::Name instances of the CA's subject distinguished name. In server mode, returns the list set by SSLContext#client_ca=. In client mode, returns the list of client CAs sent from the server. @overload client_ca @return [Array];T;0; @m;!F;"o;#;$T;%il ;&iu ;'@;(I"Çstatic VALUE ossl_ssl_get_client_ca_list(VALUE self) { SSL *ssl; STACK_OF(X509_NAME) *ca; GetSSL(self, ssl); ca = SSL_get_client_CA_list(ssl); return ossl_x509name_sk2ary(ca); };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::SSL::SSLSocket#hostname=;F;[[I"arg;T0;[[@äÇi ;T;:hostname=;0;[;{;IC;"ZSets the server hostname used for SNI. This needs to be set before SSLSocket#connect. ;T;[o;= ;3I" overload;F;40;;7;50;)I"hostname=(hostname);T;IC;";T; @ˆ;>0;!F;[;[;I";T;0;6i;[[I" hostname;T0; @ˆ;[;I"zSets the server hostname used for SNI. This needs to be set before SSLSocket#connect. @overload hostname=(hostname);T;0; @ˆ;!F;"o;#;$T;%i ;&i ;'@;(I"estatic VALUE ossl_ssl_set_hostname(VALUE self, VALUE arg) { SSL *ssl; char *hostname = NULL; GetSSL(self, ssl); if (!NIL_P(arg)) hostname = StringValueCStr(arg); if (!SSL_set_tlsext_host_name(ssl, hostname)) ossl_raise(eSSLError, NULL); /* for SSLSocket#hostname */ rb_ivar_set(self, id_i_hostname, arg); return arg; };T;)I"static VALUE;T;*To;;F; ;;;;I"-OpenSSL::SSL::SSLSocket#finished_message;F;[;[[@äÇiA ;T;:finished_message;0;[;{;IC;"-Returns the last *Finished* message sent ;T;[o;= ;3I" overload;F;40;;8;50;)I"finished_message;T;IC;";T; @¢;>0;!F;[;[;I";T;0;6i;[; @¢;[;I"KReturns the last *Finished* message sent @overload finished_message;T;0; @¢;!F;"o;#;$T;%i: ;&i> ;'@;(I":static VALUE ossl_ssl_get_finished(VALUE self) { SSL *ssl; char sizer[1], *buf; size_t len; GetSSL(self, ssl); len = SSL_get_finished(ssl, sizer, 0); if (len == 0) return Qnil; buf = ALLOCA_N(char, len); SSL_get_finished(ssl, buf, len); return rb_str_new(buf, len); };T;)I"static VALUE;T;*To;;F; ;;;;I"2OpenSSL::SSL::SSLSocket#peer_finished_message;F;[;[[@äÇiZ ;T;:peer_finished_message;0;[;{;IC;"1Returns the last *Finished* message received ;T;[o;= ;3I" overload;F;40;;9;50;)I"peer_finished_message;T;IC;";T; @¸;>0;!F;[;[;I";T;0;6i;[; @¸;[;I"TReturns the last *Finished* message received @overload peer_finished_message;T;0; @¸;!F;"o;#;$T;%iS ;&iW ;'@;(I"Istatic VALUE ossl_ssl_get_peer_finished(VALUE self) { SSL *ssl; char sizer[1], *buf; size_t len; GetSSL(self, ssl); len = SSL_get_peer_finished(ssl, sizer, 0); if (len == 0) return Qnil; buf = ALLOCA_N(char, len); SSL_get_peer_finished(ssl, buf, len); return rb_str_new(buf, len); };T;)I"static VALUE;T;*To;;F; ;;;;I"$OpenSSL::SSL::SSLSocket#tmp_key;F;[;[[@äÇi¼ ;T;:tmp_key;0;[;{;IC;"FReturns the ephemeral key used in case of forward secrecy cipher. ;T;[o;= ;3I" overload;F;40;;:;50;)I"tmp_key;T;IC;";T; @Î;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" PKey;TI"nil;T; @Î;[;I"@return [PKey, nil];T;0;6i;[; @Î;[;I"pReturns the ephemeral key used in case of forward secrecy cipher. @overload tmp_key @return [PKey, nil];T;0; @Î;!F;"o;#;$T;%i¶ ;&iº ;'@;(I"¿static VALUE ossl_ssl_tmp_key(VALUE self) { SSL *ssl; EVP_PKEY *key; GetSSL(self, ssl); if (!SSL_get_server_tmp_key(ssl, &key)) return Qnil; return ossl_pkey_new(key); };T;)I"static VALUE;T;*To;;F; ;;;;I"*OpenSSL::SSL::SSLSocket#alpn_protocol;F;[;[[@äÇi¤ ;T;:alpn_protocol;0;[;{;IC;"cReturns the ALPN protocol string that was finally selected by the server during the handshake. ;T;[o;= ;3I" overload;F;40;;;;50;)I"alpn_protocol;T;IC;";T; @ê;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String | nil;T; @ê;[;I"@return [String | nil];T;0;6i;[; @ê;[;I"‘Returns the ALPN protocol string that was finally selected by the server during the handshake. @overload alpn_protocol @return [String | nil];T;0; @ê;!F;"o;#;$T;%i ;&i¢ ;'@;(I"static VALUE ossl_ssl_alpn_protocol(VALUE self) { SSL *ssl; const unsigned char *out; unsigned int outlen; GetSSL(self, ssl); SSL_get0_alpn_selected(ssl, &out, &outlen); if (!outlen) return Qnil; else return rb_str_new((const char *) out, outlen); };T;)I"static VALUE;T;*To;;F; ;;;;I")OpenSSL::SSL::SSLSocket#npn_protocol;F;[;[[@äÇi‹ ;T;:npn_protocol;0;[;{;IC;"^Returns the protocol string that was finally selected by the client during the handshake. ;T;[o;= ;3I" overload;F;40;;<;50;)I"npn_protocol;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String | nil;T; @;[;I"@return [String | nil];T;0;6i;[; @;[;I"‹Returns the protocol string that was finally selected by the client during the handshake. @overload npn_protocol @return [String | nil];T;0; @;!F;"o;#;$T;%i„ ;&i‰ ;'@;(I" static VALUE ossl_ssl_npn_protocol(VALUE self) { SSL *ssl; const unsigned char *out; unsigned int outlen; GetSSL(self, ssl); SSL_get0_next_proto_negotiated(ssl, &out, &outlen); if (!outlen) return Qnil; else return rb_str_new((const char *) out, outlen); };T;)I"static VALUE;T;*T;A@;BIC;[;A@;CIC;[;A@;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@äÇiM;F;:SSLSocket;;K;;;[;{;IC;";T;[;[;@|;0; @;6i;'@Úæ;I"OpenSSL::SSL::SSLSocket;F;S@]o;{;[[@äÇiz;F;:VERIFY_NONE;;};;;[;{;IC;";T;[;[;@|;0; @/;'@Úæ;I"OpenSSL::SSL::VERIFY_NONE;F;~I"INT2NUM(SSL_VERIFY_NONE);To;{;[[@äÇi{;F;:VERIFY_PEER;;};;;[;{;IC;";T;[;[;@|;0; @9;'@Úæ;I"OpenSSL::SSL::VERIFY_PEER;F;~I"INT2NUM(SSL_VERIFY_PEER);To;{;[[@äÇi|;F;: VERIFY_FAIL_IF_NO_PEER_CERT;;};;;[;{;IC;";T;[;[;@|;0; @C;'@Úæ;I".OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT;F;~I"-INT2NUM(SSL_VERIFY_FAIL_IF_NO_PEER_CERT);To;{;[[@äÇi};F;:VERIFY_CLIENT_ONCE;;};;;[;{;IC;";T;[;[;@|;0; @M;'@Úæ;I"%OpenSSL::SSL::VERIFY_CLIENT_ONCE;F;~I"$INT2NUM(SSL_VERIFY_CLIENT_ONCE);To;{;[[@äÇi;F;:OP_ALL;;};;;[;{;IC;";T;[;[;@|;0; @W;'@Úæ;I"OpenSSL::SSL::OP_ALL;F;~I"ULONG2NUM(SSL_OP_ALL);To;{;[[@äÇi€;F;:OP_LEGACY_SERVER_CONNECT;;};;;[;{;IC;";T;[;[;@|;0; @a;'@Úæ;I"+OpenSSL::SSL::OP_LEGACY_SERVER_CONNECT;F;~I",ULONG2NUM(SSL_OP_LEGACY_SERVER_CONNECT);To;{;[[@äÇi‚;F;:OP_TLSEXT_PADDING;;};;;[;{;IC;";T;[;[;@|;0; @k;'@Úæ;I"$OpenSSL::SSL::OP_TLSEXT_PADDING;F;~I"%ULONG2NUM(SSL_OP_TLSEXT_PADDING);To;{;[[@äÇi…;F;:OP_SAFARI_ECDHE_ECDSA_BUG;;};;;[;{;IC;";T;[;[;@|;0; @u;'@Úæ;I",OpenSSL::SSL::OP_SAFARI_ECDHE_ECDSA_BUG;F;~I"-ULONG2NUM(SSL_OP_SAFARI_ECDHE_ECDSA_BUG);To;{;[[@äÇiˆ;F;:OP_ALLOW_NO_DHE_KEX;;};;;[;{;IC;";T;[;[;@|;0; @;'@Úæ;I"&OpenSSL::SSL::OP_ALLOW_NO_DHE_KEX;F;~I"'ULONG2NUM(SSL_OP_ALLOW_NO_DHE_KEX);To;{;[[@äÇiŠ;F;:#OP_DONT_INSERT_EMPTY_FRAGMENTS;;};;;[;{;IC;";T;[;[;@|;0; @‰;'@Úæ;I"1OpenSSL::SSL::OP_DONT_INSERT_EMPTY_FRAGMENTS;F;~I"2ULONG2NUM(SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS);To;{;[[@äÇi‹;F;:OP_NO_TICKET;;};;;[;{;IC;";T;[;[;@|;0; @“;'@Úæ;I"OpenSSL::SSL::OP_NO_TICKET;F;~I" ULONG2NUM(SSL_OP_NO_TICKET);To;{;[[@äÇiŒ;F;:.OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION;;};;;[;{;IC;";T;[;[;@|;0; @;'@Úæ;I"0;!F;[o;= ;3I" overload;F;40;;4;50;)I"seed(str);T;IC;";T; @w;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @w;[;I"@return [String];T;0;6i;[[I"str;T0; @w;[;I"n::seed is equivalent to ::add where _entropy_ is length of _str_. @overload seed(str) @return [String];T;0;'@d;(I"“static VALUE ossl_rand_seed(VALUE self, VALUE str) { StringValue(str); RAND_seed(RSTRING_PTR(str), RSTRING_LENINT(str)); return str; };T;)I"static VALUE;T;*To;;T; ;F;;;I"OpenSSL::Random.seed;F;@y;@|;T;;4;0;@~;{;IC;"F::seed is equivalent to ::add where _entropy_ is length of _str_.;T;[o;= ;3I" overload;F;40;;4;50;)I"seed(str);T;IC;";T; @•;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @•;[;I"@return [String];T;0;6i;[[I"str;T0; @•;[;I"o::seed is equivalent to ::add where _entropy_ is length of _str_. @overload seed(str) @return [String];T;0; @•;!F;"o;#;$T;%i;&i;6i;'@d;(@“;)@”;*To;;F; ;;;Ï;I"OpenSSL::Random#random_add;F;[[I"str;T0[I"entropy;T0;[[@ÞÇi9;T;:random_add;0;[;{;IC;"Mixes the bytes from _str_ into the Pseudo Random Number Generator(PRNG) state. Thus, if the data from _str_ are unpredictable to an adversary, this increases the uncertainty about the state and makes the PRNG output less predictable. The _entropy_ argument is (the lower bound of) an estimate of how much randomness is contained in _str_, measured in bytes. === Example pid = $$ now = Time.now ary = [now.to_i, now.nsec, 1000, pid] OpenSSL::Random.add(ary.join, 0.0) OpenSSL::Random.seed(ary.join) ;T; @¬;>0;!F;[o;= ;3I" overload;F;40;;?;50;)I"add(str, entropy);T;IC;";T; @¬;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @¬;[;I"@return [self];T;0;6i;[[I"str;T0[I"entropy;T0; @¬;[;I".Mixes the bytes from _str_ into the Pseudo Random Number Generator(PRNG) state. Thus, if the data from _str_ are unpredictable to an adversary, this increases the uncertainty about the state and makes the PRNG output less predictable. The _entropy_ argument is (the lower bound of) an estimate of how much randomness is contained in _str_, measured in bytes. === Example pid = $$ now = Time.now ary = [now.to_i, now.nsec, 1000, pid] OpenSSL::Random.add(ary.join, 0.0) OpenSSL::Random.seed(ary.join) @overload add(str, entropy) @return [self];T;0;'@d;(I"³static VALUE ossl_rand_add(VALUE self, VALUE str, VALUE entropy) { StringValue(str); RAND_add(RSTRING_PTR(str), RSTRING_LENINT(str), NUM2DBL(entropy)); return self; };T;)I"static VALUE;T;*To;;T; ;F;;;I"OpenSSL::Random.random_add;F;@®;@³;T;;r;0;@µ;{;IC;"Mixes the bytes from _str_ into the Pseudo Random Number Generator(PRNG) state. Thus, if the data from _str_ are unpredictable to an adversary, this increases the uncertainty about the state and makes the PRNG output less predictable. The _entropy_ argument is (the lower bound of) an estimate of how much randomness is contained in _str_, measured in bytes. === Example pid = $$ now = Time.now ary = [now.to_i, now.nsec, 1000, pid] OpenSSL::Random.add(ary.join, 0.0) OpenSSL::Random.seed(ary.join);T;[o;= ;3I" overload;F;40;;?;50;)I"add(str, entropy);T;IC;";T; @Î;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @Î;[;I"@return [self];T;0;6i;[[I"str;T0[I"entropy;T0; @Î;[;I"/Mixes the bytes from _str_ into the Pseudo Random Number Generator(PRNG) state. Thus, if the data from _str_ are unpredictable to an adversary, this increases the uncertainty about the state and makes the PRNG output less predictable. The _entropy_ argument is (the lower bound of) an estimate of how much randomness is contained in _str_, measured in bytes. === Example pid = $$ now = Time.now ary = [now.to_i, now.nsec, 1000, pid] OpenSSL::Random.add(ary.join, 0.0) OpenSSL::Random.seed(ary.join) @overload add(str, entropy) @return [self];T;0; @Î;!F;"o;#;$T;%i#;&i7;6i;'@d;(@Ì;)@Í;*To;;F; ;;;Ï;I"%OpenSSL::Random#load_random_file;F;[[I" filename;T0;[[@ÞÇiH;T;:load_random_file;0;[;{;IC;";Reads bytes from _filename_ and adds them to the PRNG. ;T; @ç;>0;!F;[o;= ;3I" overload;F;40;;s;50;)I"load_random_file(filename);T;IC;";T; @ç;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" true;T; @ç;[;I"@return [true];T;0;6i;[[I" filename;T0; @ç;[;I"rReads bytes from _filename_ and adds them to the PRNG. @overload load_random_file(filename) @return [true];T;0;'@d;(I"²static VALUE ossl_rand_load_file(VALUE self, VALUE filename) { if(!RAND_load_file(StringValueCStr(filename), -1)) { ossl_raise(eRandomError, NULL); } return Qtrue; };T;)I"static VALUE;T;*To;;T; ;F;;;I"%OpenSSL::Random.load_random_file;F;@é;@ì;T;;s;0;@î;{;IC;";Reads bytes from _filename_ and adds them to the PRNG.;T;[o;= ;3I" overload;F;40;;s;50;)I"load_random_file(filename);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" true;T; @;[;I"@return [true];T;0;6i;[[I" filename;T0; @;[;I"sReads bytes from _filename_ and adds them to the PRNG. @overload load_random_file(filename) @return [true];T;0; @;!F;"o;#;$T;%iB;&iF;6i;'@d;(@;)@;*To;;F; ;;;Ï;I"&OpenSSL::Random#write_random_file;F;[[I" filename;T0;[[@ÞÇiY;T;:write_random_file;0;[;{;IC;"£Writes a number of random generated bytes (currently 1024) to _filename_ which can be used to initialize the PRNG by calling ::load_random_file in a later session. ;T; @;>0;!F;[o;= ;3I" overload;F;40;;t;50;)I" write_random_file(filename);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" true;T; @;[;I"@return [true];T;0;6i;[[I" filename;T0; @;[;I"ÛWrites a number of random generated bytes (currently 1024) to _filename_ which can be used to initialize the PRNG by calling ::load_random_file in a later session. @overload write_random_file(filename) @return [true];T;0;'@d;(I"¶static VALUE ossl_rand_write_file(VALUE self, VALUE filename) { if (RAND_write_file(StringValueCStr(filename)) == -1) { ossl_raise(eRandomError, NULL); } return Qtrue; };T;)I"static VALUE;T;*To;;T; ;F;;;I"&OpenSSL::Random.write_random_file;F;@;@!;T;;t;0;@#;{;IC;"£Writes a number of random generated bytes (currently 1024) to _filename_ which can be used to initialize the PRNG by calling ::load_random_file in a later session.;T;[o;= ;3I" overload;F;40;;t;50;)I" write_random_file(filename);T;IC;";T; @:;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" true;T; @:;[;I"@return [true];T;0;6i;[[I" filename;T0; @:;[;I"ÜWrites a number of random generated bytes (currently 1024) to _filename_ which can be used to initialize the PRNG by calling ::load_random_file in a later session. @overload write_random_file(filename) @return [true];T;0; @:;!F;"o;#;$T;%iQ;&iW;6i;'@d;(@8;)@9;*To;;F; ;;;Ï;I"!OpenSSL::Random#random_bytes;F;[[I"len;T0;[[@ÞÇin;T;:random_bytes;0;[;{;IC;"µrandom_bytes(length) -> string Generates a String with _length_ number of cryptographically strong pseudo-random bytes. === Example OpenSSL::Random.random_bytes(12) #=> "..." ;T; @Q;>0;!F;[;[;I"µrandom_bytes(length) -> string Generates a String with _length_ number of cryptographically strong pseudo-random bytes. === Example OpenSSL::Random.random_bytes(12) #=> "...";T;0;'@d;(I"pstatic VALUE ossl_rand_bytes(VALUE self, VALUE len) { VALUE str; int n = NUM2INT(len); int ret; str = rb_str_new(0, n); ret = RAND_bytes((unsigned char *)RSTRING_PTR(str), n); if (ret == 0) { ossl_raise(eRandomError, "RAND_bytes"); } else if (ret == -1) { ossl_raise(eRandomError, "RAND_bytes is not supported"); } return str; };T;)I"static VALUE;T;*To;;T; ;F;;;I"!OpenSSL::Random.random_bytes;F;@S;@V;T;;u;0;@X;{;IC;"µrandom_bytes(length) -> string Generates a String with _length_ number of cryptographically strong pseudo-random bytes. === Example OpenSSL::Random.random_bytes(12) #=> "...";T;[;[;I"·random_bytes(length) -> string Generates a String with _length_ number of cryptographically strong pseudo-random bytes. === Example OpenSSL::Random.random_bytes(12) #=> "..." ;T;0; @`;!F;"o;#;$T;%ib;&il;6i;'@d;(@^;)@_;*To;;F; ;;;Ï;I"OpenSSL::Random#egd;F;[[I" filename;T0;[[@ÞÇi‚;T;:egd;0;[;{;IC;":Same as ::egd_bytes but queries 255 bytes by default. ;T; @h;>0;!F;[o;= ;3I" overload;F;40;;v;50;)I"egd(filename);T;IC;";T; @h;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" true;T; @h;[;I"@return [true];T;0;6i;[[I" filename;T0; @h;[;I"dSame as ::egd_bytes but queries 255 bytes by default. @overload egd(filename) @return [true];T;0;'@d;(I"¨static VALUE ossl_rand_egd(VALUE self, VALUE filename) { if (RAND_egd(StringValueCStr(filename)) == -1) { ossl_raise(eRandomError, NULL); } return Qtrue; };T;)I"static VALUE;T;*To;;T; ;F;;;I"OpenSSL::Random.egd;F;@j;@m;T;;v;0;@o;{;IC;":Same as ::egd_bytes but queries 255 bytes by default.;T;[o;= ;3I" overload;F;40;;v;50;)I"egd(filename);T;IC;";T; @†;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" true;T; @†;[;I"@return [true];T;0;6i;[[I" filename;T0; @†;[;I"eSame as ::egd_bytes but queries 255 bytes by default. @overload egd(filename) @return [true];T;0; @†;!F;"o;#;$T;%i|;&i€;6i;'@d;(@„;)@…;*To;;F; ;;;Ï;I"OpenSSL::Random#egd_bytes;F;[[I" filename;T0[I"len;T0;[[@ÞÇi”;T;:egd_bytes;0;[;{;IC;" Queries the entropy gathering daemon EGD on socket path given by _filename_. Fetches _length_ number of bytes and uses ::add to seed the OpenSSL built-in PRNG. ;T; @;>0;!F;[o;= ;3I" overload;F;40;;w;50;)I" egd_bytes(filename, length);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" true;T; @;[;I"@return [true];T;0;6i;[[I" filename;T0[I"length;T0; @;[;I"ØQueries the entropy gathering daemon EGD on socket path given by _filename_. Fetches _length_ number of bytes and uses ::add to seed the OpenSSL built-in PRNG. @overload egd_bytes(filename, length) @return [true];T;0;'@d;(I"Ýstatic VALUE ossl_rand_egd_bytes(VALUE self, VALUE filename, VALUE len) { int n = NUM2INT(len); if (RAND_egd_bytes(StringValueCStr(filename), n) == -1) { ossl_raise(eRandomError, NULL); } return Qtrue; };T;)I"static VALUE;T;*To;;T; ;F;;;I"OpenSSL::Random.egd_bytes;F;@Ÿ;@¤;T;;w;0;@¦;{;IC;" Queries the entropy gathering daemon EGD on socket path given by _filename_. Fetches _length_ number of bytes and uses ::add to seed the OpenSSL built-in PRNG.;T;[o;= ;3I" overload;F;40;;w;50;)I" egd_bytes(filename, length);T;IC;";T; @¿;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" true;T; @¿;[;I"@return [true];T;0;6i;[[I" filename;T0[I"length;T0; @¿;[;I"ÙQueries the entropy gathering daemon EGD on socket path given by _filename_. Fetches _length_ number of bytes and uses ::add to seed the OpenSSL built-in PRNG. @overload egd_bytes(filename, length) @return [true];T;0; @¿;!F;"o;#;$T;%i‹;&i’;6i;'@d;(@½;)@¾;*To;;F; ;;;Ï;I"OpenSSL::Random#status?;F;[;[[@ÞÇi¦;T;:status?;0;[;{;IC;"SReturn +true+ if the PRNG has been seeded with enough data, +false+ otherwise. ;T; @Ø;>0;!F;[o;= ;3I" overload;F;40;;x;50;)I"status?;T;IC;";T; @Ø;>0;!F;[;[;I";T;0;6i;[; @Øo;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Ø;[;I"yReturn +true+ if the PRNG has been seeded with enough data, +false+ otherwise. @overload status? @return [Boolean] ;T;0;'@d;(I"]static VALUE ossl_rand_status(VALUE self) { return RAND_status() ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;T; ;F;;;I"OpenSSL::Random.status?;F;@Ú;@Û;T;;x;0;@Ý;{;IC;"SReturn +true+ if the PRNG has been seeded with enough data, +false+ otherwise.;T;[o;= ;3I" overload;F;40;;x;50;)I"status?;T;IC;";T; @ò;>0;!F;[;[;I";T;0;6i;[; @òo;2 ;3I"return;F;4@|;0;5[@~; @ò;[;I"gReturn +true+ if the PRNG has been seeded with enough data, +false+ otherwise. @overload status?;T;0; @ò;!F;"o;#;$T;%i ;&i£;6i;'@d;(@ð;)@ñ;*T;A@d;BIC;[;A@d;CIC;[;A@d;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ÞÇi·;F;:Random;;K;;;[;{;IC;";T;[;[;@|;0; @d;6i;'@ÃÇ;I"OpenSSL::Random;Fo; ;IC;[o; ;IC;[;A@;BIC;[;A@;CIC;[;A@;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@âÇi;F;:CipherError;;K;;;[;{;IC;";T;[;[;@|;0; @;'@;I"!OpenSSL::Cipher::CipherError;F;S@ÅÇo;;F; ;;;;I"$OpenSSL::Cipher#initialize_copy;F;[[I" other;T0;[[@âÇi…;T;;g;0;[;{;IC;";T;[;[;@|;0; @';'@;(I"istatic VALUE ossl_cipher_copy(VALUE self, VALUE other) { EVP_CIPHER_CTX *ctx1, *ctx2; rb_check_frozen(self); if (self == other) return self; GetCipherInit(self, ctx1); if (!ctx1) { AllocCipher(self, ctx1); } GetCipher(other, ctx2); if (EVP_CIPHER_CTX_copy(ctx1, ctx2) != 1) ossl_raise(eCipherError, NULL); return self; };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"OpenSSL::Cipher#ciphers;F;[;[[@âÇi¥;T;; ;0;[;{;IC;"0;!F;[o;= ;3I" overload;F;40;:OpenSSL::Cipher.ciphers;50;)I"OpenSSL::Cipher.ciphers;T;IC;";T; @5;>0;!F;[;[;I";T;0;6i;[; @5;[;I"_Returns the names of all available ciphers in an array. @overload OpenSSL::Cipher.ciphers ;T;0;'@;(I"static VALUE ossl_s_ciphers(VALUE self) { VALUE ary; ary = rb_ary_new(); OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_CIPHER_METH, (void(*)(const OBJ_NAME*,void*))add_cipher_name_to_ary, (void*)ary); return ary; };T;)I"static VALUE;T;*To;;T; ;F;;;I"OpenSSL::Cipher.ciphers;F;@7;@8;T;; ;0;@:;{;IC;"0;!F;[;[;I";T;0;6i;[; @J;[;I"`Returns the names of all available ciphers in an array. @overload OpenSSL::Cipher.ciphers;T;0; @J;!F;"o;#;$T;%iŸ;&i¢;6i;'@;(@H;)@I;*To;;F; ;;;;I"OpenSSL::Cipher#initialize;F;[[I"str;T0;[[@âÇit;T;;Ð;0;[;{;IC;"ˆThe string must contain a valid cipher name like "AES-256-CBC". A list of cipher names is available by calling OpenSSL::Cipher.ciphers. ;T;[o;= ;3I" overload;F;40;;î;50;)I"new(string);T;IC;";T; @Z;>0;!F;[;[;I";T;0;6i;[[I"string;T0; @Z;[;I" The string must contain a valid cipher name like "AES-256-CBC". A list of cipher names is available by calling OpenSSL::Cipher.ciphers. @overload new(string);T;0; @Z;!F;"o;#;$T;%il;&iq;'@;(I"5static VALUE ossl_cipher_initialize(VALUE self, VALUE str) { EVP_CIPHER_CTX *ctx; const EVP_CIPHER *cipher; char *name; name = StringValueCStr(str); GetCipherInit(self, ctx); if (ctx) { ossl_raise(rb_eRuntimeError, "Cipher already initialized!"); } AllocCipher(self, ctx); if (!(cipher = EVP_get_cipherbyname(name))) { ossl_raise(rb_eRuntimeError, "unsupported cipher algorithm (%"PRIsVALUE")", str); } if (EVP_CipherInit_ex(ctx, cipher, NULL, NULL, NULL, -1) != 1) ossl_raise(eCipherError, NULL); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Cipher#reset;F;[;[[@âÇi»;T;;;;0;[;{;IC;"ÚFully resets the internal state of the Cipher. By using this, the same Cipher instance may be used several times for encryption or decryption tasks. Internally calls EVP_CipherInit_ex(ctx, NULL, NULL, NULL, NULL, -1). ;T;[o;= ;3I" overload;F;40;;;;50;)I" reset;T;IC;";T; @t;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @t;[;I"@return [self];T;0;6i;[; @t;[;I"ýFully resets the internal state of the Cipher. By using this, the same Cipher instance may be used several times for encryption or decryption tasks. Internally calls EVP_CipherInit_ex(ctx, NULL, NULL, NULL, NULL, -1). @overload reset @return [self];T;0; @t;!F;"o;#;$T;%i²;&i¹;'@;(I"Östatic VALUE ossl_cipher_reset(VALUE self) { EVP_CIPHER_CTX *ctx; GetCipher(self, ctx); if (EVP_CipherInit_ex(ctx, NULL, NULL, NULL, NULL, -1) != 1) ossl_raise(eCipherError, NULL); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Cipher#encrypt;F;[[@c0;[[@âÇi;T;:encrypt;0;[;{;IC;"Initializes the Cipher for encryption. Make sure to call Cipher#encrypt or Cipher#decrypt before using any of the following methods: * [#key=, #iv=, #random_key, #random_iv, #pkcs5_keyivgen] Internally calls EVP_CipherInit_ex(ctx, NULL, NULL, NULL, NULL, 1). ;T;[o;= ;3I" overload;F;40;;|;50;)I"encrypt;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @;[;I"@return [self];T;0;6i;[; @;[;I")Initializes the Cipher for encryption. Make sure to call Cipher#encrypt or Cipher#decrypt before using any of the following methods: * [#key=, #iv=, #random_key, #random_iv, #pkcs5_keyivgen] Internally calls EVP_CipherInit_ex(ctx, NULL, NULL, NULL, NULL, 1). @overload encrypt @return [self];T;0; @;!F;"o;#;$T;%iõ;&iÿ;'@;(I"~static VALUE ossl_cipher_encrypt(int argc, VALUE *argv, VALUE self) { return ossl_cipher_init(argc, argv, self, 1); };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Cipher#decrypt;F;[[@c0;[[@âÇi;T;:decrypt;0;[;{;IC;"Initializes the Cipher for decryption. Make sure to call Cipher#encrypt or Cipher#decrypt before using any of the following methods: * [#key=, #iv=, #random_key, #random_iv, #pkcs5_keyivgen] Internally calls EVP_CipherInit_ex(ctx, NULL, NULL, NULL, NULL, 0). ;T;[o;= ;3I" overload;F;40;;};50;)I"decrypt;T;IC;";T; @«;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @«;[;I"@return [self];T;0;6i;[; @«;[;I")Initializes the Cipher for decryption. Make sure to call Cipher#encrypt or Cipher#decrypt before using any of the following methods: * [#key=, #iv=, #random_key, #random_iv, #pkcs5_keyivgen] Internally calls EVP_CipherInit_ex(ctx, NULL, NULL, NULL, NULL, 0). @overload decrypt @return [self];T;0; @«;!F;"o;#;$T;%i;&i;'@;(I"~static VALUE ossl_cipher_decrypt(int argc, VALUE *argv, VALUE self) { return ossl_cipher_init(argc, argv, self, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::Cipher#pkcs5_keyivgen;F;[[@c0;[[@âÇi-;T;:pkcs5_keyivgen;0;[;{;IC;"CGenerates and sets the key/IV based on a password. *WARNING*: This method is only PKCS5 v1.5 compliant when using RC2, RC4-40, or DES with MD5 or SHA1. Using anything else (like AES) will generate the key/iv using an OpenSSL specific method. This method is deprecated and should no longer be used. Use a PKCS5 v2 key generation method from OpenSSL::PKCS5 instead. === Parameters * _salt_ must be an 8 byte string if provided. * _iterations_ is an integer with a default of 2048. * _digest_ is a Digest object that defaults to 'MD5' A minimum of 1000 iterations is recommended. ;T;[o;= ;3I" overload;F;40;;~;50;)I"Hpkcs5_keyivgen(pass, salt = nil, iterations = 2048, digest = "MD5");T;IC;";T; @Ç;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @Ç;[;I"@return [nil];T;0;6i;[ [I" pass;T0[I" salt;TI"nil;T[I"iterations;TI" 2048;T[I"digest;TI" "MD5";T; @Ç;[;I"¤Generates and sets the key/IV based on a password. *WARNING*: This method is only PKCS5 v1.5 compliant when using RC2, RC4-40, or DES with MD5 or SHA1. Using anything else (like AES) will generate the key/iv using an OpenSSL specific method. This method is deprecated and should no longer be used. Use a PKCS5 v2 key generation method from OpenSSL::PKCS5 instead. === Parameters * _salt_ must be an 8 byte string if provided. * _iterations_ is an integer with a default of 2048. * _digest_ is a Digest object that defaults to 'MD5' A minimum of 1000 iterations is recommended. @overload pkcs5_keyivgen(pass, salt = nil, iterations = 2048, digest = "MD5") @return [nil];T;0; @Ç;!F;"o;#;$T;%i;&i+;'@;(I"’static VALUE ossl_cipher_pkcs5_keyivgen(int argc, VALUE *argv, VALUE self) { EVP_CIPHER_CTX *ctx; const EVP_MD *digest; VALUE vpass, vsalt, viter, vdigest; unsigned char key[EVP_MAX_KEY_LENGTH], iv[EVP_MAX_IV_LENGTH], *salt = NULL; int iter; rb_scan_args(argc, argv, "13", &vpass, &vsalt, &viter, &vdigest); StringValue(vpass); if(!NIL_P(vsalt)){ StringValue(vsalt); if(RSTRING_LEN(vsalt) != PKCS5_SALT_LEN) ossl_raise(eCipherError, "salt must be an 8-octet string"); salt = (unsigned char *)RSTRING_PTR(vsalt); } iter = NIL_P(viter) ? 2048 : NUM2INT(viter); if (iter <= 0) rb_raise(rb_eArgError, "iterations must be a positive integer"); digest = NIL_P(vdigest) ? EVP_md5() : ossl_evp_get_digestbyname(vdigest); GetCipher(self, ctx); EVP_BytesToKey(EVP_CIPHER_CTX_cipher(ctx), digest, salt, (unsigned char *)RSTRING_PTR(vpass), RSTRING_LENINT(vpass), iter, key, iv); if (EVP_CipherInit_ex(ctx, NULL, NULL, key, iv, -1) != 1) ossl_raise(eCipherError, NULL); OPENSSL_cleanse(key, sizeof key); OPENSSL_cleanse(iv, sizeof iv); rb_ivar_set(self, id_key_set, Qtrue); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Cipher#update;F;[[@c0;[[@âÇit;T;;Ç;0;[;{;IC;"^Encrypts data in a streaming fashion. Hand consecutive blocks of data to the #update method in order to encrypt it. Returns the encrypted data chunk. When done, the output of Cipher#final should be additionally added to the result. If _buffer_ is given, the encryption/decryption result will be written to it. _buffer_ will be resized automatically. ;T;[o;= ;3I" overload;F;40;;Ç;50;)I"update(data [, buffer]);T;IC;";T; @î;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @î;[;I"@return [String];T;0;6i;[[I"data[, buffer];T0; @î;[;I"•Encrypts data in a streaming fashion. Hand consecutive blocks of data to the #update method in order to encrypt it. Returns the encrypted data chunk. When done, the output of Cipher#final should be additionally added to the result. If _buffer_ is given, the encryption/decryption result will be written to it. _buffer_ will be resized automatically. @overload update(data [, buffer]) @return [String];T;0; @î;!F;"o;#;$T;%ih;&ir;'@;(I"static VALUE ossl_cipher_update(int argc, VALUE *argv, VALUE self) { EVP_CIPHER_CTX *ctx; unsigned char *in; long in_len, out_len; VALUE data, str; rb_scan_args(argc, argv, "11", &data, &str); if (!RTEST(rb_attr_get(self, id_key_set))) ossl_raise(eCipherError, "key not set"); StringValue(data); in = (unsigned char *)RSTRING_PTR(data); if ((in_len = RSTRING_LEN(data)) == 0) ossl_raise(rb_eArgError, "data must not be empty"); GetCipher(self, ctx); out_len = in_len+EVP_CIPHER_CTX_block_size(ctx); if (out_len <= 0) { ossl_raise(rb_eRangeError, "data too big to make output buffer: %ld bytes", in_len); } if (NIL_P(str)) { str = rb_str_new(0, out_len); } else { StringValue(str); rb_str_resize(str, out_len); } if (!ossl_cipher_update_long(ctx, (unsigned char *)RSTRING_PTR(str), &out_len, in, in_len)) ossl_raise(eCipherError, NULL); assert(out_len < RSTRING_LEN(str)); rb_str_set_len(str, out_len); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Cipher#final;F;[;[[@âÇi©;T;: final;0;[;{;IC;"Returns the remaining data held in the cipher object. Further calls to Cipher#update or Cipher#final will return garbage. This call should always be made as the last call of an encryption or decryption operation, after having fed the entire plaintext or ciphertext to the Cipher instance. If an authenticated cipher was used, a CipherError is raised if the tag could not be authenticated successfully. Only call this method after setting the authentication tag and passing the entire contents of the ciphertext into the cipher. ;T;[o;= ;3I" overload;F;40;;;50;)I" final;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @;[;I"@return [String];T;0;6i;[; @;[;I"5Returns the remaining data held in the cipher object. Further calls to Cipher#update or Cipher#final will return garbage. This call should always be made as the last call of an encryption or decryption operation, after having fed the entire plaintext or ciphertext to the Cipher instance. If an authenticated cipher was used, a CipherError is raised if the tag could not be authenticated successfully. Only call this method after setting the authentication tag and passing the entire contents of the ciphertext into the cipher. @overload final @return [String];T;0; @;!F;"o;#;$T;%i›;&i§;'@;(I"‡static VALUE ossl_cipher_final(VALUE self) { EVP_CIPHER_CTX *ctx; int out_len; VALUE str; GetCipher(self, ctx); str = rb_str_new(0, EVP_CIPHER_CTX_block_size(ctx)); if (!EVP_CipherFinal_ex(ctx, (unsigned char *)RSTRING_PTR(str), &out_len)) ossl_raise(eCipherError, NULL); assert(out_len <= RSTRING_LEN(str)); rb_str_set_len(str, out_len); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Cipher#name;F;[;[[@âÇiÁ;T;;Ñ;0;[;{;IC;"^Returns the name of the cipher which may differ slightly from the original name provided. ;T;[o;= ;3I" overload;F;40;;Ñ;50;)I" name;T;IC;";T; @';>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @';[;I"@return [String];T;0;6i;[; @';[;I"}Returns the name of the cipher which may differ slightly from the original name provided. @overload name @return [String];T;0; @';!F;"o;#;$T;%iº;&i¿;'@;(I"§static VALUE ossl_cipher_name(VALUE self) { EVP_CIPHER_CTX *ctx; GetCipher(self, ctx); return rb_str_new2(EVP_CIPHER_name(EVP_CIPHER_CTX_cipher(ctx))); };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Cipher#key=;F;[[I"key;T0;[[@âÇiÖ;T;: key=;0;[;{;IC;"[Sets the cipher key. To generate a key, you should either use a secure random byte string or, if the key is to be derived from a password, you should rely on PBKDF2 functionality provided by OpenSSL::PKCS5. To generate a secure random-based key, Cipher#random_key may be used. Only call this method after calling Cipher#encrypt or Cipher#decrypt. ;T;[o;= ;3I" overload;F;40;;€;50;)I"key=(string);T;IC;";T; @B;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @B;[;I"@return [String];T;0;6i;[[I"string;T0; @B;[;I"‡Sets the cipher key. To generate a key, you should either use a secure random byte string or, if the key is to be derived from a password, you should rely on PBKDF2 functionality provided by OpenSSL::PKCS5. To generate a secure random-based key, Cipher#random_key may be used. Only call this method after calling Cipher#encrypt or Cipher#decrypt. @overload key=(string) @return [String];T;0; @B;!F;"o;#;$T;%iË;&iÔ;'@;(I"âstatic VALUE ossl_cipher_set_key(VALUE self, VALUE key) { EVP_CIPHER_CTX *ctx; int key_len; StringValue(key); GetCipher(self, ctx); key_len = EVP_CIPHER_CTX_key_length(ctx); if (RSTRING_LEN(key) != key_len) ossl_raise(rb_eArgError, "key must be %d bytes", key_len); if (EVP_CipherInit_ex(ctx, NULL, NULL, (unsigned char *)RSTRING_PTR(key), NULL, -1) != 1) ossl_raise(eCipherError, NULL); rb_ivar_set(self, id_key_set, Qtrue); return key; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Cipher#auth_data=;F;[[I" data;T0;[[@âÇi0;T;:auth_data=;0;[;{;IC;"Sets the cipher's additional authenticated data. This field must be set when using AEAD cipher modes such as GCM or CCM. If no associated data shall be used, this method must *still* be called with a value of "". The contents of this field should be non-sensitive data which will be added to the ciphertext to generate the authentication tag which validates the contents of the ciphertext. The AAD must be set prior to encryption or decryption. In encryption mode, it must be set after calling Cipher#encrypt and setting Cipher#key= and Cipher#iv=. When decrypting, the authenticated data must be set after key, iv and especially *after* the authentication tag has been set. I.e. set it only after calling Cipher#decrypt, Cipher#key=, Cipher#iv= and Cipher#auth_tag= first. ;T;[o;= ;3I" overload;F;40;;;50;)I"auth_data=(string);T;IC;";T; @a;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @a;[;I"@return [String];T;0;6i;[[I"string;T0; @a;[;I"8Sets the cipher's additional authenticated data. This field must be set when using AEAD cipher modes such as GCM or CCM. If no associated data shall be used, this method must *still* be called with a value of "". The contents of this field should be non-sensitive data which will be added to the ciphertext to generate the authentication tag which validates the contents of the ciphertext. The AAD must be set prior to encryption or decryption. In encryption mode, it must be set after calling Cipher#encrypt and setting Cipher#key= and Cipher#iv=. When decrypting, the authenticated data must be set after key, iv and especially *after* the authentication tag has been set. I.e. set it only after calling Cipher#decrypt, Cipher#key=, Cipher#iv= and Cipher#auth_tag= first. @overload auth_data=(string) @return [String];T;0; @a;!F;"o;#;$T;%i;&i.;'@;(I"Istatic VALUE ossl_cipher_set_auth_data(VALUE self, VALUE data) { EVP_CIPHER_CTX *ctx; unsigned char *in; long in_len, out_len; StringValue(data); in = (unsigned char *) RSTRING_PTR(data); in_len = RSTRING_LEN(data); GetCipher(self, ctx); if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_FLAG_AEAD_CIPHER)) ossl_raise(eCipherError, "AEAD not supported by this cipher"); if (!ossl_cipher_update_long(ctx, NULL, &out_len, in, in_len)) ossl_raise(eCipherError, "couldn't set additional authenticated data"); return data; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Cipher#auth_tag=;F;[[I" vtag;T0;[[@âÇi{;T;:auth_tag=;0;[;{;IC;"›Sets the authentication tag to verify the integrity of the ciphertext. This can be called only when the cipher supports AE. The tag must be set after calling Cipher#decrypt, Cipher#key= and Cipher#iv=, but before calling Cipher#final. After all decryption is performed, the tag is verified automatically in the call to Cipher#final. For OCB mode, the tag length must be supplied with #auth_tag_len= beforehand. ;T;[o;= ;3I" overload;F;40;;‚;50;)I"auth_tag=(string);T;IC;";T; @€;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @€;[;I"@return [String];T;0;6i;[[I"string;T0; @€;[;I"ÌSets the authentication tag to verify the integrity of the ciphertext. This can be called only when the cipher supports AE. The tag must be set after calling Cipher#decrypt, Cipher#key= and Cipher#iv=, but before calling Cipher#final. After all decryption is performed, the tag is verified automatically in the call to Cipher#final. For OCB mode, the tag length must be supplied with #auth_tag_len= beforehand. @overload auth_tag=(string) @return [String];T;0; @€;!F;"o;#;$T;%in;&iy;'@;(I"0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Ÿ;[;I"@return [String];T;0;6i;[[I"tag_len;TI"16;T; @Ÿ;[;I"Gets the authentication tag generated by Authenticated Encryption Cipher modes (GCM for example). This tag may be stored along with the ciphertext, then set on the decryption cipher to authenticate the contents of the ciphertext against changes. If the optional integer parameter _tag_len_ is given, the returned tag will be _tag_len_ bytes long. If the parameter is omitted, the default length of 16 bytes or the length previously set by #auth_tag_len= will be used. For maximum security, the longest possible should be chosen. The tag may only be retrieved after calling Cipher#final. @overload auth_tag(tag_len = 16) @return [String];T;0; @Ÿ;!F;"o;#;$T;%iF;&iS;'@;(I"×static VALUE ossl_cipher_get_auth_tag(int argc, VALUE *argv, VALUE self) { VALUE vtag_len, ret; EVP_CIPHER_CTX *ctx; int tag_len = 16; rb_scan_args(argc, argv, "01", &vtag_len); if (NIL_P(vtag_len)) vtag_len = rb_attr_get(self, id_auth_tag_len); if (!NIL_P(vtag_len)) tag_len = NUM2INT(vtag_len); GetCipher(self, ctx); if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_FLAG_AEAD_CIPHER)) ossl_raise(eCipherError, "authentication tag not supported by this cipher"); ret = rb_str_new(NULL, tag_len); if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_GET_TAG, tag_len, RSTRING_PTR(ret))) ossl_raise(eCipherError, "retrieving the authentication tag failed"); return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::Cipher#auth_tag_len=;F;[[I" vlen;T0;[[@âÇi›;T;:auth_tag_len=;0;[;{;IC;".Sets the length of the authentication tag to be generated or to be given for AEAD ciphers that requires it as in input parameter. Note that not all AEAD ciphers support this method. In OCB mode, the length must be supplied both when encrypting and when decrypting, and must be before specifying an IV. ;T;[o;= ;3I" overload;F;40;;„;50;)I"auth_tag_len=(Integer);T;IC;";T; @¾;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¾;[;I"@return [Integer];T;0;6i;[[I"Integer;T0; @¾;[;I"eSets the length of the authentication tag to be generated or to be given for AEAD ciphers that requires it as in input parameter. Note that not all AEAD ciphers support this method. In OCB mode, the length must be supplied both when encrypting and when decrypting, and must be before specifying an IV. @overload auth_tag_len=(Integer) @return [Integer];T;0; @¾;!F;"o;#;$T;%i;&i™;'@;(I"$static VALUE ossl_cipher_set_auth_tag_len(VALUE self, VALUE vlen) { int tag_len = NUM2INT(vlen); EVP_CIPHER_CTX *ctx; GetCipher(self, ctx); if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_FLAG_AEAD_CIPHER)) ossl_raise(eCipherError, "AEAD not supported by this cipher"); if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_TAG, tag_len, NULL)) ossl_raise(eCipherError, "unable to set authentication tag length"); /* for #auth_tag */ rb_ivar_set(self, id_auth_tag_len, INT2NUM(tag_len)); return vlen; };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::Cipher#authenticated?;F;[;[[@âÇi;T;:authenticated?;0;[;{;IC;"RIndicated whether this Cipher instance uses an Authenticated Encryption mode.;T;[o;= ;3I" overload;F;40;;…;50;)I"authenticated?;T;IC;";T; @Ý;>0;!F;[;[;I";T;0;6i;[; @Ýo;2 ;3I"return;F;4@|;0;5[@~; @Ý;[;I"mIndicated whether this Cipher instance uses an Authenticated Encryption mode. @overload authenticated?;T;0; @Ý;!F;"o;#;$T;%i ;&i;6i;'@;(I"Östatic VALUE ossl_cipher_is_authenticated(VALUE self) { EVP_CIPHER_CTX *ctx; GetCipher(self, ctx); return (EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_FLAG_AEAD_CIPHER) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Cipher#key_len=;F;[[I"key_length;T0;[[@âÇiØ;T;: key_len=;0;[;{;IC;";Sets the key length of the cipher. If the cipher is a fixed length cipher then attempting to set the key length to any value other than the fixed value is an error. Under normal circumstances you do not need to call this method (and probably shouldn't). See EVP_CIPHER_CTX_set_key_length for further information. ;T;[o;= ;3I" overload;F;40;;†;50;)I"key_len=(integer);T;IC;";T; @ö;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ö;[;I"@return [Integer];T;0;6i;[[I"integer;T0; @ö;[;I"mSets the key length of the cipher. If the cipher is a fixed length cipher then attempting to set the key length to any value other than the fixed value is an error. Under normal circumstances you do not need to call this method (and probably shouldn't). See EVP_CIPHER_CTX_set_key_length for further information. @overload key_len=(integer) @return [Integer];T;0; @ö;!F;"o;#;$T;%iÌ;&iÖ;'@;(I"static VALUE ossl_cipher_set_key_length(VALUE self, VALUE key_length) { int len = NUM2INT(key_length); EVP_CIPHER_CTX *ctx; GetCipher(self, ctx); if (EVP_CIPHER_CTX_set_key_length(ctx, len) != 1) ossl_raise(eCipherError, NULL); return key_length; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Cipher#key_len;F;[;[[@âÇi;T;:key_len;0;[;{;IC;"3Returns the key length in bytes of the Cipher. ;T;[o;= ;3I" overload;F;40;;‡;50;)I"key_len;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @;[;I"@return [Integer];T;0;6i;[; @;[;I"[Returns the key length in bytes of the Cipher. @overload key_len @return [Integer];T;0; @;!F;"o;#;$T;%iû;&iÿ;'@;(I"œstatic VALUE ossl_cipher_key_length(VALUE self) { EVP_CIPHER_CTX *ctx; GetCipher(self, ctx); return INT2NUM(EVP_CIPHER_CTX_key_length(ctx)); };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Cipher#iv=;F;[[I"iv;T0;[[@âÇi÷;T;:iv=;0;[;{;IC;"’Sets the cipher IV. Please note that since you should never be using ECB mode, an IV is always explicitly required and should be set prior to encryption. The IV itself can be safely transmitted in public, but it should be unpredictable to prevent certain kinds of attacks. You may use Cipher#random_iv to create a secure random IV. Only call this method after calling Cipher#encrypt or Cipher#decrypt. ;T;[o;= ;3I" overload;F;40;;ˆ;50;)I"iv=(string);T;IC;";T; @0;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @0;[;I"@return [String];T;0;6i;[[I"string;T0; @0;[;I"½Sets the cipher IV. Please note that since you should never be using ECB mode, an IV is always explicitly required and should be set prior to encryption. The IV itself can be safely transmitted in public, but it should be unpredictable to prevent certain kinds of attacks. You may use Cipher#random_iv to create a secure random IV. Only call this method after calling Cipher#encrypt or Cipher#decrypt. @overload iv=(string) @return [String];T;0; @0;!F;"o;#;$T;%ië;&iõ;'@;(I"Gstatic VALUE ossl_cipher_set_iv(VALUE self, VALUE iv) { EVP_CIPHER_CTX *ctx; int iv_len = 0; StringValue(iv); GetCipher(self, ctx); if (EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_FLAG_AEAD_CIPHER) iv_len = (int)(VALUE)EVP_CIPHER_CTX_get_app_data(ctx); if (!iv_len) iv_len = EVP_CIPHER_CTX_iv_length(ctx); if (RSTRING_LEN(iv) != iv_len) ossl_raise(rb_eArgError, "iv must be %d bytes", iv_len); if (EVP_CipherInit_ex(ctx, NULL, NULL, NULL, (unsigned char *)RSTRING_PTR(iv), -1) != 1) ossl_raise(eCipherError, NULL); return iv; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Cipher#iv_len=;F;[[I"iv_length;T0;[[@âÇi¶;T;:iv_len=;0;[;{;IC;"ÇSets the IV/nonce length of the Cipher. Normally block ciphers don't allow changing the IV length, but some make use of IV for 'nonce'. You may need this for interoperability with other applications. ;T;[o;= ;3I" overload;F;40;;‰;50;)I"iv_len=(integer);T;IC;";T; @O;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @O;[;I"@return [Integer];T;0;6i;[[I"integer;T0; @O;[;I"øSets the IV/nonce length of the Cipher. Normally block ciphers don't allow changing the IV length, but some make use of IV for 'nonce'. You may need this for interoperability with other applications. @overload iv_len=(integer) @return [Integer];T;0; @O;!F;"o;#;$T;%i®;&i´;'@;(I"¦static VALUE ossl_cipher_set_iv_length(VALUE self, VALUE iv_length) { int len = NUM2INT(iv_length); EVP_CIPHER_CTX *ctx; GetCipher(self, ctx); if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_FLAG_AEAD_CIPHER)) ossl_raise(eCipherError, "cipher does not support AEAD"); if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_IVLEN, len, NULL)) ossl_raise(eCipherError, "unable to set IV length"); /* * EVP_CIPHER_CTX_iv_length() returns the default length. So we need to save * the length somewhere. Luckily currently we aren't using app_data. */ EVP_CIPHER_CTX_set_app_data(ctx, (void *)(VALUE)len); return iv_length; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Cipher#iv_len;F;[;[[@âÇi;T;:iv_len;0;[;{;IC;"DReturns the expected length in bytes for an IV for this Cipher. ;T;[o;= ;3I" overload;F;40;;Š;50;)I"iv_len;T;IC;";T; @n;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @n;[;I"@return [Integer];T;0;6i;[; @n;[;I"kReturns the expected length in bytes for an IV for this Cipher. @overload iv_len @return [Integer];T;0; @n;!F;"o;#;$T;%i;&i;'@;(I"Lstatic VALUE ossl_cipher_iv_length(VALUE self) { EVP_CIPHER_CTX *ctx; int len = 0; GetCipher(self, ctx); if (EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_FLAG_AEAD_CIPHER) len = (int)(VALUE)EVP_CIPHER_CTX_get_app_data(ctx); if (!len) len = EVP_CIPHER_CTX_iv_length(ctx); return INT2NUM(len); };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Cipher#block_size;F;[;[[@âÇi&;T;:block_size;0;[;{;IC;"NReturns the size in bytes of the blocks on which this Cipher operates on. ;T;[o;= ;3I" overload;F;40;;‹;50;)I"block_size;T;IC;";T; @‰;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @‰;[;I"@return [Integer];T;0;6i;[; @‰;[;I"yReturns the size in bytes of the blocks on which this Cipher operates on. @overload block_size @return [Integer];T;0; @‰;!F;"o;#;$T;%i ;&i$;'@;(I"œstatic VALUE ossl_cipher_block_size(VALUE self) { EVP_CIPHER_CTX *ctx; GetCipher(self, ctx); return INT2NUM(EVP_CIPHER_CTX_block_size(ctx)); };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::Cipher#padding=;F;[[I"padding;T0;[[@âÇiï;T;: padding=;0;[;{;IC;"ƒEnables or disables padding. By default encryption operations are padded using standard block padding and the padding is checked and removed when decrypting. If the pad parameter is zero then no padding is performed, the total amount of data encrypted or decrypted must then be a multiple of the block size or an error will occur. See EVP_CIPHER_CTX_set_padding for further information. ;T;[o;= ;3I" overload;F;40;;Œ;50;)I"padding=(integer);T;IC;";T; @¤;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¤;[;I"@return [Integer];T;0;6i;[[I"integer;T0; @¤;[;I"µEnables or disables padding. By default encryption operations are padded using standard block padding and the padding is checked and removed when decrypting. If the pad parameter is zero then no padding is performed, the total amount of data encrypted or decrypted must then be a multiple of the block size or an error will occur. See EVP_CIPHER_CTX_set_padding for further information. @overload padding=(integer) @return [Integer];T;0; @¤;!F;"o;#;$T;%iå;&ií;'@;(I"ÿstatic VALUE ossl_cipher_set_padding(VALUE self, VALUE padding) { EVP_CIPHER_CTX *ctx; int pad = NUM2INT(padding); GetCipher(self, ctx); if (EVP_CIPHER_CTX_set_padding(ctx, pad) != 1) ossl_raise(eCipherError, NULL); return padding; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::Cipher#ccm_data_len=;F;[[I" data_len;T0;[[@âÇi:;T;:ccm_data_len=;0;[;{;IC;"úSets the length of the plaintext / ciphertext message that will be processed in CCM mode. Make sure to call this method after #key= and #iv= have been set, and before #auth_data=. Only call this method after calling Cipher#encrypt or Cipher#decrypt. ;T;[o;= ;3I" overload;F;40;;;50;)I"ccm_data_len=(integer);T;IC;";T; @Ã;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ã;[;I"@return [Integer];T;0;6i;[[I"integer;T0; @Ã;[;I"1Sets the length of the plaintext / ciphertext message that will be processed in CCM mode. Make sure to call this method after #key= and #iv= have been set, and before #auth_data=. Only call this method after calling Cipher#encrypt or Cipher#decrypt. @overload ccm_data_len=(integer) @return [Integer];T;0; @Ã;!F;"o;#;$T;%i0;&i8;'@;(I"7static VALUE ossl_cipher_set_ccm_data_len(VALUE self, VALUE data_len) { int in_len, out_len; EVP_CIPHER_CTX *ctx; in_len = NUM2INT(data_len); GetCipher(self, ctx); if (EVP_CipherUpdate(ctx, NULL, &out_len, NULL, in_len) != 1) ossl_raise(eCipherError, NULL); return data_len; };T;)I"static VALUE;T;*T;A@;BIC;[;A@;CIC;[;A@;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@âÇiT[@âÇi;T;:Cipher;;K;;;[;{;IC;"ÏProvides symmetric algorithms for encryption and decryption. The algorithms that are available depend on the particular version of OpenSSL that is installed. === Listing all supported algorithms A list of supported algorithms can be obtained by puts OpenSSL::Cipher.ciphers === Instantiating a Cipher There are several ways to create a Cipher instance. Generally, a Cipher algorithm is categorized by its name, the key length in bits and the cipher mode to be used. The most generic way to create a Cipher is the following cipher = OpenSSL::Cipher.new('--') That is, a string consisting of the hyphenated concatenation of the individual components name, key length and mode. Either all uppercase or all lowercase strings may be used, for example: cipher = OpenSSL::Cipher.new('AES-128-CBC') === Choosing either encryption or decryption mode Encryption and decryption are often very similar operations for symmetric algorithms, this is reflected by not having to choose different classes for either operation, both can be done using the same class. Still, after obtaining a Cipher instance, we need to tell the instance what it is that we intend to do with it, so we need to call either cipher.encrypt or cipher.decrypt on the Cipher instance. This should be the first call after creating the instance, otherwise configuration that has already been set could get lost in the process. === Choosing a key Symmetric encryption requires a key that is the same for the encrypting and for the decrypting party and after initial key establishment should be kept as private information. There are a lot of ways to create insecure keys, the most notable is to simply take a password as the key without processing the password further. A simple and secure way to create a key for a particular Cipher is cipher = OpenSSL::Cipher.new('AES-256-CFB') cipher.encrypt key = cipher.random_key # also sets the generated key on the Cipher If you absolutely need to use passwords as encryption keys, you should use Password-Based Key Derivation Function 2 (PBKDF2) by generating the key with the help of the functionality provided by OpenSSL::PKCS5.pbkdf2_hmac_sha1 or OpenSSL::PKCS5.pbkdf2_hmac. Although there is Cipher#pkcs5_keyivgen, its use is deprecated and it should only be used in legacy applications because it does not use the newer PKCS#5 v2 algorithms. === Choosing an IV The cipher modes CBC, CFB, OFB and CTR all need an "initialization vector", or short, IV. ECB mode is the only mode that does not require an IV, but there is almost no legitimate use case for this mode because of the fact that it does not sufficiently hide plaintext patterns. Therefore You should never use ECB mode unless you are absolutely sure that you absolutely need it Because of this, you will end up with a mode that explicitly requires an IV in any case. Although the IV can be seen as public information, i.e. it may be transmitted in public once generated, it should still stay unpredictable to prevent certain kinds of attacks. Therefore, ideally Always create a secure random IV for every encryption of your Cipher A new, random IV should be created for every encryption of data. Think of the IV as a nonce (number used once) - it's public but random and unpredictable. A secure random IV can be created as follows cipher = ... cipher.encrypt key = cipher.random_key iv = cipher.random_iv # also sets the generated IV on the Cipher Although the key is generally a random value, too, it is a bad choice as an IV. There are elaborate ways how an attacker can take advantage of such an IV. As a general rule of thumb, exposing the key directly or indirectly should be avoided at all cost and exceptions only be made with good reason. === Calling Cipher#final ECB (which should not be used) and CBC are both block-based modes. This means that unlike for the other streaming-based modes, they operate on fixed-size blocks of data, and therefore they require a "finalization" step to produce or correctly decrypt the last block of data by appropriately handling some form of padding. Therefore it is essential to add the output of OpenSSL::Cipher#final to your encryption/decryption buffer or you will end up with decryption errors or truncated data. Although this is not really necessary for streaming-mode ciphers, it is still recommended to apply the same pattern of adding the output of Cipher#final there as well - it also enables you to switch between modes more easily in the future. === Encrypting and decrypting some data data = "Very, very confidential data" cipher = OpenSSL::Cipher.new('AES-128-CBC') cipher.encrypt key = cipher.random_key iv = cipher.random_iv encrypted = cipher.update(data) + cipher.final ... decipher = OpenSSL::Cipher.new('AES-128-CBC') decipher.decrypt decipher.key = key decipher.iv = iv plain = decipher.update(encrypted) + decipher.final puts data == plain #=> true === Authenticated Encryption and Associated Data (AEAD) If the OpenSSL version used supports it, an Authenticated Encryption mode (such as GCM or CCM) should always be preferred over any unauthenticated mode. Currently, OpenSSL supports AE only in combination with Associated Data (AEAD) where additional associated data is included in the encryption process to compute a tag at the end of the encryption. This tag will also be used in the decryption process and by verifying its validity, the authenticity of a given ciphertext is established. This is superior to unauthenticated modes in that it allows to detect if somebody effectively changed the ciphertext after it had been encrypted. This prevents malicious modifications of the ciphertext that could otherwise be exploited to modify ciphertexts in ways beneficial to potential attackers. An associated data is used where there is additional information, such as headers or some metadata, that must be also authenticated but not necessarily need to be encrypted. If no associated data is needed for encryption and later decryption, the OpenSSL library still requires a value to be set - "" may be used in case none is available. An example using the GCM (Galois/Counter Mode). You have 16 bytes _key_, 12 bytes (96 bits) _nonce_ and the associated data _auth_data_. Be sure not to reuse the _key_ and _nonce_ pair. Reusing an nonce ruins the security guarantees of GCM mode. cipher = OpenSSL::Cipher.new('AES-128-GCM').encrypt cipher.key = key cipher.iv = nonce cipher.auth_data = auth_data encrypted = cipher.update(data) + cipher.final tag = cipher.auth_tag # produces 16 bytes tag by default Now you are the receiver. You know the _key_ and have received _nonce_, _auth_data_, _encrypted_ and _tag_ through an untrusted network. Note that GCM accepts an arbitrary length tag between 1 and 16 bytes. You may additionally need to check that the received tag has the correct length, or you allow attackers to forge a valid single byte tag for the tampered ciphertext with a probability of 1/256. raise "tag is truncated!" unless tag.bytesize == 16 decipher = OpenSSL::Cipher.new('AES-128-GCM').decrypt decipher.key = key decipher.iv = nonce decipher.auth_tag = tag decipher.auth_data = auth_data decrypted = decipher.update(encrypted) + decipher.final puts data == decrypted #=> true ;T;[;[;I"Ñ Provides symmetric algorithms for encryption and decryption. The algorithms that are available depend on the particular version of OpenSSL that is installed. === Listing all supported algorithms A list of supported algorithms can be obtained by puts OpenSSL::Cipher.ciphers === Instantiating a Cipher There are several ways to create a Cipher instance. Generally, a Cipher algorithm is categorized by its name, the key length in bits and the cipher mode to be used. The most generic way to create a Cipher is the following cipher = OpenSSL::Cipher.new('--') That is, a string consisting of the hyphenated concatenation of the individual components name, key length and mode. Either all uppercase or all lowercase strings may be used, for example: cipher = OpenSSL::Cipher.new('AES-128-CBC') === Choosing either encryption or decryption mode Encryption and decryption are often very similar operations for symmetric algorithms, this is reflected by not having to choose different classes for either operation, both can be done using the same class. Still, after obtaining a Cipher instance, we need to tell the instance what it is that we intend to do with it, so we need to call either cipher.encrypt or cipher.decrypt on the Cipher instance. This should be the first call after creating the instance, otherwise configuration that has already been set could get lost in the process. === Choosing a key Symmetric encryption requires a key that is the same for the encrypting and for the decrypting party and after initial key establishment should be kept as private information. There are a lot of ways to create insecure keys, the most notable is to simply take a password as the key without processing the password further. A simple and secure way to create a key for a particular Cipher is cipher = OpenSSL::Cipher.new('AES-256-CFB') cipher.encrypt key = cipher.random_key # also sets the generated key on the Cipher If you absolutely need to use passwords as encryption keys, you should use Password-Based Key Derivation Function 2 (PBKDF2) by generating the key with the help of the functionality provided by OpenSSL::PKCS5.pbkdf2_hmac_sha1 or OpenSSL::PKCS5.pbkdf2_hmac. Although there is Cipher#pkcs5_keyivgen, its use is deprecated and it should only be used in legacy applications because it does not use the newer PKCS#5 v2 algorithms. === Choosing an IV The cipher modes CBC, CFB, OFB and CTR all need an "initialization vector", or short, IV. ECB mode is the only mode that does not require an IV, but there is almost no legitimate use case for this mode because of the fact that it does not sufficiently hide plaintext patterns. Therefore You should never use ECB mode unless you are absolutely sure that you absolutely need it Because of this, you will end up with a mode that explicitly requires an IV in any case. Although the IV can be seen as public information, i.e. it may be transmitted in public once generated, it should still stay unpredictable to prevent certain kinds of attacks. Therefore, ideally Always create a secure random IV for every encryption of your Cipher A new, random IV should be created for every encryption of data. Think of the IV as a nonce (number used once) - it's public but random and unpredictable. A secure random IV can be created as follows cipher = ... cipher.encrypt key = cipher.random_key iv = cipher.random_iv # also sets the generated IV on the Cipher Although the key is generally a random value, too, it is a bad choice as an IV. There are elaborate ways how an attacker can take advantage of such an IV. As a general rule of thumb, exposing the key directly or indirectly should be avoided at all cost and exceptions only be made with good reason. === Calling Cipher#final ECB (which should not be used) and CBC are both block-based modes. This means that unlike for the other streaming-based modes, they operate on fixed-size blocks of data, and therefore they require a "finalization" step to produce or correctly decrypt the last block of data by appropriately handling some form of padding. Therefore it is essential to add the output of OpenSSL::Cipher#final to your encryption/decryption buffer or you will end up with decryption errors or truncated data. Although this is not really necessary for streaming-mode ciphers, it is still recommended to apply the same pattern of adding the output of Cipher#final there as well - it also enables you to switch between modes more easily in the future. === Encrypting and decrypting some data data = "Very, very confidential data" cipher = OpenSSL::Cipher.new('AES-128-CBC') cipher.encrypt key = cipher.random_key iv = cipher.random_iv encrypted = cipher.update(data) + cipher.final ... decipher = OpenSSL::Cipher.new('AES-128-CBC') decipher.decrypt decipher.key = key decipher.iv = iv plain = decipher.update(encrypted) + decipher.final puts data == plain #=> true === Authenticated Encryption and Associated Data (AEAD) If the OpenSSL version used supports it, an Authenticated Encryption mode (such as GCM or CCM) should always be preferred over any unauthenticated mode. Currently, OpenSSL supports AE only in combination with Associated Data (AEAD) where additional associated data is included in the encryption process to compute a tag at the end of the encryption. This tag will also be used in the decryption process and by verifying its validity, the authenticity of a given ciphertext is established. This is superior to unauthenticated modes in that it allows to detect if somebody effectively changed the ciphertext after it had been encrypted. This prevents malicious modifications of the ciphertext that could otherwise be exploited to modify ciphertexts in ways beneficial to potential attackers. An associated data is used where there is additional information, such as headers or some metadata, that must be also authenticated but not necessarily need to be encrypted. If no associated data is needed for encryption and later decryption, the OpenSSL library still requires a value to be set - "" may be used in case none is available. An example using the GCM (Galois/Counter Mode). You have 16 bytes _key_, 12 bytes (96 bits) _nonce_ and the associated data _auth_data_. Be sure not to reuse the _key_ and _nonce_ pair. Reusing an nonce ruins the security guarantees of GCM mode. cipher = OpenSSL::Cipher.new('AES-128-GCM').encrypt cipher.key = key cipher.iv = nonce cipher.auth_data = auth_data encrypted = cipher.update(data) + cipher.final tag = cipher.auth_tag # produces 16 bytes tag by default Now you are the receiver. You know the _key_ and have received _nonce_, _auth_data_, _encrypted_ and _tag_ through an untrusted network. Note that GCM accepts an arbitrary length tag between 1 and 16 bytes. You may additionally need to check that the received tag has the correct length, or you allow attackers to forge a valid single byte tag for the tampered ciphertext with a probability of 1/256. raise "tag is truncated!" unless tag.bytesize == 16 decipher = OpenSSL::Cipher.new('AES-128-GCM').decrypt decipher.key = key decipher.iv = nonce decipher.auth_tag = tag decipher.auth_data = auth_data decrypted = decipher.update(encrypted) + decipher.final puts data == decrypted #=> true ;T;0; @;!F;"o;#;$T;%iT;&i;'@ÃÇ;I"OpenSSL::Cipher;F;S@]o; ;IC;[o;{;[[@äÇi© ;F;:HAVE_TLSEXT_HOST_NAME;;};;;[;{;IC;";T;[;[;@|;0; @ö;'@ô;I".OpenSSL::ExtConfig::HAVE_TLSEXT_HOST_NAME;F;~I" Qtrue;To;{;[[@äÇiO[@äÇiR;F;:OPENSSL_NO_SOCK;;};;;[;{;IC;";T;[;[;@|;0; @;'@ô;I"(OpenSSL::ExtConfig::OPENSSL_NO_SOCK;F;~I"Qfalse;T;A@ô;BIC;[;A@ô;CIC;[;A@ô;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@äÇiï [@äÇi÷ ;T;:ExtConfig;;K;;;[;{;IC;"0This module contains configuration information about the SSL extension, for example if socket support is enabled, or the host name TLS extension is enabled. Constants in this module will always be defined, but contain +true+ or +false+ values depending on the configuration of your OpenSSL installation. ;T;[;[;I"2 This module contains configuration information about the SSL extension, for example if socket support is enabled, or the host name TLS extension is enabled. Constants in this module will always be defined, but contain +true+ or +false+ values depending on the configuration of your OpenSSL installation. ;T;0; @ô;!F;"o;#;$T;%iï ;&iõ ;'@ÃÇ;I"OpenSSL::ExtConfig;Fo;;F; ;F;;;I"(OpenSSL.fixed_length_secure_compare;F;[[I" str1;T0[I" str2;T0;[[@æÇim;T;: fixed_length_secure_compare;0;[;{;IC;"þConstant time memory comparison for fixed length strings, such as results of HMAC calculations. Returns +true+ if the strings are identical, +false+ if they are of the same length but not identical. If the length is different, +ArgumentError+ is raised. ;T;[o;= ;3I" overload;F;40;;’;50;)I"0fixed_length_secure_compare(string, string);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @;[;I"@return [Boolean];T;0;6i;[[I"string;T0[I"string;T0; @;[;I"JConstant time memory comparison for fixed length strings, such as results of HMAC calculations. Returns +true+ if the strings are identical, +false+ if they are of the same length but not identical. If the length is different, +ArgumentError+ is raised. @overload fixed_length_secure_compare(string, string) @return [Boolean];T;0; @;!F;"o;#;$T;%ib;&ik;'@ÃÇ;(I"static VALUE ossl_crypto_fixed_length_secure_compare(VALUE dummy, VALUE str1, VALUE str2) { const unsigned char *p1 = (const unsigned char *)StringValuePtr(str1); const unsigned char *p2 = (const unsigned char *)StringValuePtr(str2); long len1 = RSTRING_LEN(str1); long len2 = RSTRING_LEN(str2); if (len1 != len2) { ossl_raise(rb_eArgError, "inputs must be of equal length"); } switch (CRYPTO_memcmp(p1, p2, len1)) { case 0: return Qtrue; default: return Qfalse; } };T;)I"static VALUE;T;*To;{;[[@æÇi;F;:OPENSSL_VERSION;;};;;[;{;IC;"AVersion of OpenSSL the ruby OpenSSL extension was built with ;T;[;[;I"BVersion of OpenSSL the ruby OpenSSL extension was built with ;T;0; @@;!F;"o;#;$T;%iŒ;&i;'@ÃÇ;I"OpenSSL::OPENSSL_VERSION;F;~I"&rb_str_new2(OPENSSL_VERSION_TEXT);To;{;[[@æÇi•[@æÇi—;F;:OPENSSL_LIBRARY_VERSION;;};;;[;{;IC;";T;[;[;@|;0; @L;'@ÃÇ;I"%OpenSSL::OPENSSL_LIBRARY_VERSION;F;~I"0rb_str_new2(SSLeay_version(SSLEAY_VERSION));To;{;[[@æÇiž;F;:OPENSSL_VERSION_NUMBER;;};;;[;{;IC;"RVersion number of OpenSSL the ruby OpenSSL extension was built with (base 16) ;T;[;[;I"SVersion number of OpenSSL the ruby OpenSSL extension was built with (base 16) ;T;0; @W;!F;"o;#;$T;%iš;&iœ;'@ÃÇ;I"$OpenSSL::OPENSSL_VERSION_NUMBER;F;~I"$INT2NUM(OPENSSL_VERSION_NUMBER);To;{;[[@æÇi£;F;:OPENSSL_FIPS;;};;;[;{;IC;";T;[;[;@|;0; @c;'@ÃÇ;I"OpenSSL::OPENSSL_FIPS;F;~I">#ifdef OPENSSL_FIPS Qtrue #else Qfalse #endif;To;;F; ;;;Ï;I"OpenSSL#fips_mode;F;[;[[@æÇi”;T;:fips_mode;0;[;{;IC;" ;T; @m;>0;!F;[o;= ;3I" overload;F;40;;—;50;)I"fips_mode;T;IC;";T; @m;>0;!F;[;[;I";T;0;6i;[; @m;[;I"@overload fips_mode ;T;0;'@ÃÇ;(I"·static VALUE ossl_fips_mode_get(VALUE self) { #ifdef OPENSSL_FIPS VALUE enabled; enabled = FIPS_mode() ? Qtrue : Qfalse; return enabled; #else return Qfalse; #endif };T;)I"static VALUE;T;*To;;T; ;F;;;I"OpenSSL.fips_mode;F;@o;@p;T;;—;0;@r;{;IC;";T;[o;= ;3I" overload;F;40;;—;50;)I"fips_mode;T;IC;";T; @‚;>0;!F;[;[;I";T;0;6i;[; @‚;[;I" @overload fips_mode;T;0; @‚;!F;"o;#;$T;%i;&i‘;6i;'@ÃÇ;(@€;)@;*To;;F; ;;;Ï;I"OpenSSL#fips_mode=;F;[[I"enabled;T0;[[@æÇi;T;:fips_mode=;0;[;{;IC;"(Turns FIPS mode on or off. Turning on FIPS mode will obviously only have an effect for FIPS-capable installations of the OpenSSL library. Trying to do so otherwise will result in an error. === Examples OpenSSL.fips_mode = true # turn FIPS mode on OpenSSL.fips_mode = false # and off again ;T; @’;>0;!F;[o;= ;3I" overload;F;40;;˜;50;)I"fips_mode=(boolean);T;IC;";T; @’;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @’;[;I"@return [Boolean];T;0;6i;[[I"boolean;T0; @’;[;I"[Turns FIPS mode on or off. Turning on FIPS mode will obviously only have an effect for FIPS-capable installations of the OpenSSL library. Trying to do so otherwise will result in an error. === Examples OpenSSL.fips_mode = true # turn FIPS mode on OpenSSL.fips_mode = false # and off again @overload fips_mode=(boolean) @return [Boolean];T;0;'@ÃÇ;(I",static VALUE ossl_fips_mode_set(VALUE self, VALUE enabled) { #ifdef OPENSSL_FIPS if (RTEST(enabled)) { int mode = FIPS_mode(); if(!mode && !FIPS_mode_set(1)) /* turning on twice leads to an error */ ossl_raise(eOSSLError, "Turning on FIPS mode failed"); } else { if(!FIPS_mode_set(0)) /* turning off twice is OK */ ossl_raise(eOSSLError, "Turning off FIPS mode failed"); } return enabled; #else if (RTEST(enabled)) ossl_raise(eOSSLError, "This version of OpenSSL does not support FIPS mode"); return enabled; #endif };T;)I"static VALUE;T;*To;;T; ;F;;;I"OpenSSL.fips_mode=;F;@”;@—;T;;˜;0;@™;{;IC;"(Turns FIPS mode on or off. Turning on FIPS mode will obviously only have an effect for FIPS-capable installations of the OpenSSL library. Trying to do so otherwise will result in an error. === Examples OpenSSL.fips_mode = true # turn FIPS mode on OpenSSL.fips_mode = false # and off again;T;[o;= ;3I" overload;F;40;;˜;50;)I"fips_mode=(boolean);T;IC;";T; @°;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @°;[;I"@return [Boolean];T;0;6i;[[I"boolean;T0; @°;[;I"\Turns FIPS mode on or off. Turning on FIPS mode will obviously only have an effect for FIPS-capable installations of the OpenSSL library. Trying to do so otherwise will result in an error. === Examples OpenSSL.fips_mode = true # turn FIPS mode on OpenSSL.fips_mode = false # and off again @overload fips_mode=(boolean) @return [Boolean];T;0; @°;!F;"o;#;$T;%i¡;&i«;6i;'@ÃÇ;(@®;)@¯;*To;;F; ;;;Ï;I"OpenSSL#debug;F;[;[[@æÇi{;T;: debug;0;[;{;IC;" ;T; @Ç;>0;!F;[o;= ;3I" overload;F;40;;™;50;)I" debug;T;IC;";T; @Ç;>0;!F;[;[;I";T;0;6i;[; @Ç;[;I"@overload debug ;T;0;'@ÃÇ;(I"Bstatic VALUE ossl_debug_get(VALUE self) { return dOSSL; };T;)I"static VALUE;T;*To;;T; ;F;;;I"OpenSSL.debug;F;@É;@Ê;T;;™;0;@Ì;{;IC;";T;[o;= ;3I" overload;F;40;;™;50;)I" debug;T;IC;";T; @Ü;>0;!F;[;[;I";T;0;6i;[; @Ü;[;I" @overload debug;T;0; @Ü;!F;"o;#;$T;%iw;&ix;6i;'@ÃÇ;(@Ú;)@Û;*To;;F; ;;;Ï;I"OpenSSL#debug=;F;[[I"val;T0;[[@æÇiˆ;T;:debug=;0;[;{;IC;"wTurns on or off debug mode. With debug mode, all erros added to the OpenSSL error queue will be printed to stderr. ;T; @ì;>0;!F;[o;= ;3I" overload;F;40;;š;50;)I"debug=(boolean);T;IC;";T; @ì;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ì;[;I"@return [Boolean];T;0;6i;[[I"boolean;T0; @ì;[;I"¡Turns on or off debug mode. With debug mode, all erros added to the OpenSSL error queue will be printed to stderr. @overload debug=(boolean) @return [Boolean];T;0;'@ÃÇ;(I"ustatic VALUE ossl_debug_set(VALUE self, VALUE val) { dOSSL = RTEST(val) ? Qtrue : Qfalse; return val; };T;)I"static VALUE;T;*To;;T; ;F;;;I"OpenSSL.debug=;F;@î;@ñ;T;;š;0;@ó;{;IC;"wTurns on or off debug mode. With debug mode, all erros added to the OpenSSL error queue will be printed to stderr.;T;[o;= ;3I" overload;F;40;;š;50;)I"debug=(boolean);T;IC;";T; @ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ ;[;I"@return [Boolean];T;0;6i;[[I"boolean;T0; @ ;[;I"¢Turns on or off debug mode. With debug mode, all erros added to the OpenSSL error queue will be printed to stderr. @overload debug=(boolean) @return [Boolean];T;0; @ ;!F;"o;#;$T;%i;&i†;6i;'@ÃÇ;(@;)@ ;*To;;F; ;;;Ï;I"OpenSSL#errors;F;[;[[@æÇiT;T;:errors;0;[;{;IC;"|See any remaining errors held in queue. Any errors you see here are probably due to a bug in Ruby's OpenSSL implementation. ;T; @!;>0;!F;[o;= ;3I" overload;F;40;;›;50;)I"errors;T;IC;";T; @!;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @!;[;I"@return [Array];T;0;6i;[; @!;[;I" See any remaining errors held in queue. Any errors you see here are probably due to a bug in Ruby's OpenSSL implementation. @overload errors @return [Array];T;0;'@ÃÇ;(I"×VALUE ossl_get_errors(VALUE _) { VALUE ary; long e; ary = rb_ary_new(); while ((e = ERR_get_error()) != 0){ rb_ary_push(ary, rb_str_new2(ERR_error_string(e, NULL))); } return ary; };T;)I" VALUE;T;*To;;T; ;F;;;I"OpenSSL.errors;F;@#;@$;T;;›;0;@&;{;IC;"|See any remaining errors held in queue. Any errors you see here are probably due to a bug in Ruby's OpenSSL implementation.;T;[o;= ;3I" overload;F;40;;›;50;)I"errors;T;IC;";T; @;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @;;[;I"@return [Array];T;0;6i;[; @;;[;I"¡See any remaining errors held in queue. Any errors you see here are probably due to a bug in Ruby's OpenSSL implementation. @overload errors @return [Array];T;0; @;;!F;"o;#;$T;%iK;&iR;6i;'@ÃÇ;(@9;)@:;*To;;F; ;;;Ï;I"OpenSSL#mem_check_start;F;[;[[@æÇiÐ;T;:mem_check_start;0;[;{;IC;"ÐCalls CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON). Starts tracking memory allocations. See also OpenSSL.print_mem_leaks. This is available only when built with a capable OpenSSL and --enable-debug configure option. ;T; @P;>0;!F;[o;= ;3I" overload;F;40;;œ;50;)I"mem_check_start;T;IC;";T; @P;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @P;[;I"@return [nil];T;0;6i;[; @P;[;I"ûCalls CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON). Starts tracking memory allocations. See also OpenSSL.print_mem_leaks. This is available only when built with a capable OpenSSL and --enable-debug configure option. @overload mem_check_start @return [nil];T;0;'@ÃÇ;(I"fstatic VALUE mem_check_start(VALUE self) { CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON); return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"OpenSSL.mem_check_start;F;@R;@S;T;;œ;0;@U;{;IC;"ÐCalls CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON). Starts tracking memory allocations. See also OpenSSL.print_mem_leaks. This is available only when built with a capable OpenSSL and --enable-debug configure option.;T;[o;= ;3I" overload;F;40;;œ;50;)I"mem_check_start;T;IC;";T; @j;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @j;[;I"@return [nil];T;0;6i;[; @j;[;I"üCalls CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON). Starts tracking memory allocations. See also OpenSSL.print_mem_leaks. This is available only when built with a capable OpenSSL and --enable-debug configure option. @overload mem_check_start @return [nil];T;0; @j;!F;"o;#;$T;%iÆ;&iÎ;6i;'@ÃÇ;(@h;)@i;*To;;F; ;;;Ï;I"OpenSSL#print_mem_leaks;F;[;[[@æÇií;T;:print_mem_leaks;0;[;{;IC;"For debugging the Ruby/OpenSSL library. Calls CRYPTO_mem_leaks_fp(stderr). Prints detected memory leaks to standard error. This cleans the global state up thus you cannot use any methods of the library after calling this. Returns +true+ if leaks detected, +false+ otherwise. This is available only when built with a capable OpenSSL and --enable-debug configure option. === Example OpenSSL.mem_check_start NOT_GCED = OpenSSL::PKey::RSA.new(256) END { GC.start OpenSSL.print_mem_leaks # will print the leakage } ;T; @;>0;!F;[o;= ;3I" overload;F;40;;;50;)I"print_mem_leaks;T;IC;";T; @;>0;!F;[;[;I";T;0;6i;[; @;[;I",For debugging the Ruby/OpenSSL library. Calls CRYPTO_mem_leaks_fp(stderr). Prints detected memory leaks to standard error. This cleans the global state up thus you cannot use any methods of the library after calling this. Returns +true+ if leaks detected, +false+ otherwise. This is available only when built with a capable OpenSSL and --enable-debug configure option. === Example OpenSSL.mem_check_start NOT_GCED = OpenSSL::PKey::RSA.new(256) END { GC.start OpenSSL.print_mem_leaks # will print the leakage } @overload print_mem_leaks ;T;0;'@ÃÇ;(I"Ýstatic VALUE print_mem_leaks(VALUE self) { #if OPENSSL_VERSION_NUMBER >= 0x10100000 int ret; #endif #ifndef HAVE_RB_EXT_RACTOR_SAFE // for Ruby 2.x void ossl_bn_ctx_free(void); // ossl_bn.c ossl_bn_ctx_free(); #endif #if OPENSSL_VERSION_NUMBER >= 0x10100000 ret = CRYPTO_mem_leaks_fp(stderr); if (ret < 0) ossl_raise(eOSSLError, "CRYPTO_mem_leaks_fp"); return ret ? Qfalse : Qtrue; #else CRYPTO_mem_leaks_fp(stderr); return Qnil; #endif };T;)I"static VALUE;T;*To;;T; ;F;;;I"OpenSSL.print_mem_leaks;F;@;@‚;T;;;0;@„;{;IC;"For debugging the Ruby/OpenSSL library. Calls CRYPTO_mem_leaks_fp(stderr). Prints detected memory leaks to standard error. This cleans the global state up thus you cannot use any methods of the library after calling this. Returns +true+ if leaks detected, +false+ otherwise. This is available only when built with a capable OpenSSL and --enable-debug configure option. === Example OpenSSL.mem_check_start NOT_GCED = OpenSSL::PKey::RSA.new(256) END { GC.start OpenSSL.print_mem_leaks # will print the leakage };T;[o;= ;3I" overload;F;40;;;50;)I"print_mem_leaks;T;IC;";T; @”;>0;!F;[;[;I";T;0;6i;[; @”;[;I"-For debugging the Ruby/OpenSSL library. Calls CRYPTO_mem_leaks_fp(stderr). Prints detected memory leaks to standard error. This cleans the global state up thus you cannot use any methods of the library after calling this. Returns +true+ if leaks detected, +false+ otherwise. This is available only when built with a capable OpenSSL and --enable-debug configure option. === Example OpenSSL.mem_check_start NOT_GCED = OpenSSL::PKey::RSA.new(256) END { GC.start OpenSSL.print_mem_leaks # will print the leakage } @overload print_mem_leaks;T;0; @”;!F;"o;#;$T;%i×;&iê;6i;'@ÃÇ;(@’;)@“;*To; ;IC;[o; ;IC;[;A@¦;BIC;[;A@¦;CIC;[;A@¦;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ìÇi&;F;: KDFError;;K;;;[;{;IC;";T;[;[;@|;0; @¦;'@¤;I"OpenSSL::KDF::KDFError;F;S@ÅÇo;;F; ;;;Ï;I"OpenSSL::KDF#pbkdf2_hmac;F;[[@c0;[[@ìÇi*;T;:pbkdf2_hmac;0;[;{;IC;"(PKCS #5 PBKDF2 (Password-Based Key Derivation Function 2) in combination with HMAC. Takes _pass_, _salt_ and _iterations_, and then derives a key of _length_ bytes. For more information about PBKDF2, see RFC 2898 Section 5.2 (https://tools.ietf.org/html/rfc2898#section-5.2). === Parameters pass :: The passphrase. salt :: The salt. Salts prevent attacks based on dictionaries of common passwords and attacks based on rainbow tables. It is a public value that can be safely stored along with the password (e.g. if the derived value is used for password storage). iterations :: The iteration count. This provides the ability to tune the algorithm. It is better to use the highest count possible for the maximum resistance to brute-force attacks. length :: The desired length of the derived key in octets. hash :: The hash algorithm used with HMAC for the PRF. May be a String representing the algorithm name, or an instance of OpenSSL::Digest. ;T; @·;>0;!F;[o;= ;3I" overload;F;40;;Ÿ;50;)I":pbkdf2_hmac(pass, salt:, iterations:, length:, hash:);T;IC;";T; @·;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aString;T; @·;[;I"@return [aString];T;0;6i;[ [I" pass;T0[I" salt:;TI";T[I"iterations:;TI";T[I"length:;TI";T[I" hash:;TI";T; @·;[;I"}PKCS #5 PBKDF2 (Password-Based Key Derivation Function 2) in combination with HMAC. Takes _pass_, _salt_ and _iterations_, and then derives a key of _length_ bytes. For more information about PBKDF2, see RFC 2898 Section 5.2 (https://tools.ietf.org/html/rfc2898#section-5.2). === Parameters pass :: The passphrase. salt :: The salt. Salts prevent attacks based on dictionaries of common passwords and attacks based on rainbow tables. It is a public value that can be safely stored along with the password (e.g. if the derived value is used for password storage). iterations :: The iteration count. This provides the ability to tune the algorithm. It is better to use the highest count possible for the maximum resistance to brute-force attacks. length :: The desired length of the derived key in octets. hash :: The hash algorithm used with HMAC for the PRF. May be a String representing the algorithm name, or an instance of OpenSSL::Digest. @overload pbkdf2_hmac(pass, salt:, iterations:, length:, hash:) @return [aString];T;0;'@¤;(I"°static VALUE kdf_pbkdf2_hmac(int argc, VALUE *argv, VALUE self) { VALUE pass, salt, opts, kwargs[4], str; static ID kwargs_ids[4]; int iters, len; const EVP_MD *md; if (!kwargs_ids[0]) { kwargs_ids[0] = rb_intern_const("salt"); kwargs_ids[1] = rb_intern_const("iterations"); kwargs_ids[2] = rb_intern_const("length"); kwargs_ids[3] = rb_intern_const("hash"); } rb_scan_args(argc, argv, "1:", &pass, &opts); rb_get_kwargs(opts, kwargs_ids, 4, 0, kwargs); StringValue(pass); salt = StringValue(kwargs[0]); iters = NUM2INT(kwargs[1]); len = NUM2INT(kwargs[2]); md = ossl_evp_get_digestbyname(kwargs[3]); str = rb_str_new(0, len); if (!PKCS5_PBKDF2_HMAC(RSTRING_PTR(pass), RSTRING_LENINT(pass), (unsigned char *)RSTRING_PTR(salt), RSTRING_LENINT(salt), iters, md, len, (unsigned char *)RSTRING_PTR(str))) ossl_raise(eKDF, "PKCS5_PBKDF2_HMAC"); return str; };T;)I"static VALUE;T;*To;;T; ;F;;;I"OpenSSL::KDF.pbkdf2_hmac;F;@¹;@»;T;;Ÿ;0;@½;{;IC;"(PKCS #5 PBKDF2 (Password-Based Key Derivation Function 2) in combination with HMAC. Takes _pass_, _salt_ and _iterations_, and then derives a key of _length_ bytes. For more information about PBKDF2, see RFC 2898 Section 5.2 (https://tools.ietf.org/html/rfc2898#section-5.2). === Parameters pass :: The passphrase. salt :: The salt. Salts prevent attacks based on dictionaries of common passwords and attacks based on rainbow tables. It is a public value that can be safely stored along with the password (e.g. if the derived value is used for password storage). iterations :: The iteration count. This provides the ability to tune the algorithm. It is better to use the highest count possible for the maximum resistance to brute-force attacks. length :: The desired length of the derived key in octets. hash :: The hash algorithm used with HMAC for the PRF. May be a String representing the algorithm name, or an instance of OpenSSL::Digest.;T;[o;= ;3I" overload;F;40;;Ÿ;50;)I":pbkdf2_hmac(pass, salt:, iterations:, length:, hash:);T;IC;";T; @à;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aString;T; @à;[;I"@return [aString];T;0;6i;[ [I" pass;T0[I" salt:;TI";T[I"iterations:;TI";T[I"length:;TI";T[I" hash:;TI";T; @à;[;I"~PKCS #5 PBKDF2 (Password-Based Key Derivation Function 2) in combination with HMAC. Takes _pass_, _salt_ and _iterations_, and then derives a key of _length_ bytes. For more information about PBKDF2, see RFC 2898 Section 5.2 (https://tools.ietf.org/html/rfc2898#section-5.2). === Parameters pass :: The passphrase. salt :: The salt. Salts prevent attacks based on dictionaries of common passwords and attacks based on rainbow tables. It is a public value that can be safely stored along with the password (e.g. if the derived value is used for password storage). iterations :: The iteration count. This provides the ability to tune the algorithm. It is better to use the highest count possible for the maximum resistance to brute-force attacks. length :: The desired length of the derived key in octets. hash :: The hash algorithm used with HMAC for the PRF. May be a String representing the algorithm name, or an instance of OpenSSL::Digest. @overload pbkdf2_hmac(pass, salt:, iterations:, length:, hash:) @return [aString];T;0; @à;!F;"o;#;$T;%i;&i(;6i;'@¤;(@Þ;)@ß;*To;;F; ;;;Ï;I"OpenSSL::KDF#scrypt;F;[[@c0;[[@ìÇil;T;:scrypt;0;[;{;IC;"úDerives a key from _pass_ using given parameters with the scrypt password-based key derivation function. The result can be used for password storage. scrypt is designed to be memory-hard and more secure against brute-force attacks using custom hardwares than alternative KDFs such as PBKDF2 or bcrypt. The keyword arguments _N_, _r_ and _p_ can be used to tune scrypt. RFC 7914 (published on 2016-08, https://tools.ietf.org/html/rfc7914#section-2) states that using values r=8 and p=1 appears to yield good results. See RFC 7914 (https://tools.ietf.org/html/rfc7914) for more information. === Parameters pass :: Passphrase. salt :: Salt. N :: CPU/memory cost parameter. This must be a power of 2. r :: Block size parameter. p :: Parallelization parameter. length :: Length in octets of the derived key. === Example pass = "password" salt = SecureRandom.random_bytes(16) dk = OpenSSL::KDF.scrypt(pass, salt: salt, N: 2**14, r: 8, p: 1, length: 32) p dk #=> "\xDA\xE4\xE2...\x7F\xA1\x01T" ;T; @;>0;!F;[o;= ;3I" overload;F;40;; ;50;)I"-scrypt(pass, salt:, N:, r:, p:, length:);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aString;T; @;[;I"@return [aString];T;0;6i;[ [I" pass;T0[I" salt:;TI";T[I"N:;TI",r:;T[I"p:;TI";T[I"length:;TI";T; @;[;I"BDerives a key from _pass_ using given parameters with the scrypt password-based key derivation function. The result can be used for password storage. scrypt is designed to be memory-hard and more secure against brute-force attacks using custom hardwares than alternative KDFs such as PBKDF2 or bcrypt. The keyword arguments _N_, _r_ and _p_ can be used to tune scrypt. RFC 7914 (published on 2016-08, https://tools.ietf.org/html/rfc7914#section-2) states that using values r=8 and p=1 appears to yield good results. See RFC 7914 (https://tools.ietf.org/html/rfc7914) for more information. === Parameters pass :: Passphrase. salt :: Salt. N :: CPU/memory cost parameter. This must be a power of 2. r :: Block size parameter. p :: Parallelization parameter. length :: Length in octets of the derived key. === Example pass = "password" salt = SecureRandom.random_bytes(16) dk = OpenSSL::KDF.scrypt(pass, salt: salt, N: 2**14, r: 8, p: 1, length: 32) p dk #=> "\xDA\xE4\xE2...\x7F\xA1\x01T" @overload scrypt(pass, salt:, N:, r:, p:, length:) @return [aString];T;0;'@¤;(I"Ìstatic VALUE kdf_scrypt(int argc, VALUE *argv, VALUE self) { VALUE pass, salt, opts, kwargs[5], str; static ID kwargs_ids[5]; size_t len; uint64_t N, r, p, maxmem; if (!kwargs_ids[0]) { kwargs_ids[0] = rb_intern_const("salt"); kwargs_ids[1] = rb_intern_const("N"); kwargs_ids[2] = rb_intern_const("r"); kwargs_ids[3] = rb_intern_const("p"); kwargs_ids[4] = rb_intern_const("length"); } rb_scan_args(argc, argv, "1:", &pass, &opts); rb_get_kwargs(opts, kwargs_ids, 5, 0, kwargs); StringValue(pass); salt = StringValue(kwargs[0]); N = NUM2UINT64T(kwargs[1]); r = NUM2UINT64T(kwargs[2]); p = NUM2UINT64T(kwargs[3]); len = NUM2LONG(kwargs[4]); /* * OpenSSL uses 32MB by default (if zero is specified), which is too small. * Let's not limit memory consumption but just let malloc() fail inside * OpenSSL. The amount is controllable by other parameters. */ maxmem = SIZE_MAX; str = rb_str_new(0, len); if (!EVP_PBE_scrypt(RSTRING_PTR(pass), RSTRING_LEN(pass), (unsigned char *)RSTRING_PTR(salt), RSTRING_LEN(salt), N, r, p, maxmem, (unsigned char *)RSTRING_PTR(str), len)) ossl_raise(eKDF, "EVP_PBE_scrypt"); return str; };T;)I"static VALUE;T;*To;;T; ;F;;;I"OpenSSL::KDF.scrypt;F;@;@;T;; ;0;@ ;{;IC;"úDerives a key from _pass_ using given parameters with the scrypt password-based key derivation function. The result can be used for password storage. scrypt is designed to be memory-hard and more secure against brute-force attacks using custom hardwares than alternative KDFs such as PBKDF2 or bcrypt. The keyword arguments _N_, _r_ and _p_ can be used to tune scrypt. RFC 7914 (published on 2016-08, https://tools.ietf.org/html/rfc7914#section-2) states that using values r=8 and p=1 appears to yield good results. See RFC 7914 (https://tools.ietf.org/html/rfc7914) for more information. === Parameters pass :: Passphrase. salt :: Salt. N :: CPU/memory cost parameter. This must be a power of 2. r :: Block size parameter. p :: Parallelization parameter. length :: Length in octets of the derived key. === Example pass = "password" salt = SecureRandom.random_bytes(16) dk = OpenSSL::KDF.scrypt(pass, salt: salt, N: 2**14, r: 8, p: 1, length: 32) p dk #=> "\xDA\xE4\xE2...\x7F\xA1\x01T";T;[o;= ;3I" overload;F;40;; ;50;)I"-scrypt(pass, salt:, N:, r:, p:, length:);T;IC;";T; @,;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"aString;T; @,;[;I"@return [aString];T;0;6i;[ [I" pass;T0[I" salt:;TI";T[I"N:;TI",r:;T[I"p:;TI";T[I"length:;TI";T; @,;[;I"CDerives a key from _pass_ using given parameters with the scrypt password-based key derivation function. The result can be used for password storage. scrypt is designed to be memory-hard and more secure against brute-force attacks using custom hardwares than alternative KDFs such as PBKDF2 or bcrypt. The keyword arguments _N_, _r_ and _p_ can be used to tune scrypt. RFC 7914 (published on 2016-08, https://tools.ietf.org/html/rfc7914#section-2) states that using values r=8 and p=1 appears to yield good results. See RFC 7914 (https://tools.ietf.org/html/rfc7914) for more information. === Parameters pass :: Passphrase. salt :: Salt. N :: CPU/memory cost parameter. This must be a power of 2. r :: Block size parameter. p :: Parallelization parameter. length :: Length in octets of the derived key. === Example pass = "password" salt = SecureRandom.random_bytes(16) dk = OpenSSL::KDF.scrypt(pass, salt: salt, N: 2**14, r: 8, p: 1, length: 32) p dk #=> "\xDA\xE4\xE2...\x7F\xA1\x01T" @overload scrypt(pass, salt:, N:, r:, p:, length:) @return [aString];T;0; @,;!F;"o;#;$T;%iL;&ij;6i;'@¤;(@*;)@+;*To;;F; ;;;Ï;I"OpenSSL::KDF#hkdf;F;[[@c0;[[@ìÇi§;T;: hkdf;0;[;{;IC;"ËHMAC-based Extract-and-Expand Key Derivation Function (HKDF) as specified in {RFC 5869}[https://tools.ietf.org/html/rfc5869]. New in OpenSSL 1.1.0. === Parameters _ikm_:: The input keying material. _salt_:: The salt. _info_:: The context and application specific information. _length_:: The output length in octets. Must be <= 255 * HashLen, where HashLen is the length of the hash function output in octets. _hash_:: The hash function. ;T; @O;>0;!F;[o;= ;3I" overload;F;40;;¡;50;)I",hkdf(ikm, salt:, info:, length:, hash:);T;IC;";T; @O;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @O;[;I"@return [String];T;0;6i;[ [I"ikm;T0[I" salt:;TI";T[I" info:;TI";T[I"length:;TI";T[I" hash:;TI";T; @O;[;I"HMAC-based Extract-and-Expand Key Derivation Function (HKDF) as specified in {RFC 5869}[https://tools.ietf.org/html/rfc5869]. New in OpenSSL 1.1.0. === Parameters _ikm_:: The input keying material. _salt_:: The salt. _info_:: The context and application specific information. _length_:: The output length in octets. Must be <= 255 * HashLen, where HashLen is the length of the hash function output in octets. _hash_:: The hash function. @overload hkdf(ikm, salt:, info:, length:, hash:) @return [String];T;0;'@¤;(I"static VALUE kdf_hkdf(int argc, VALUE *argv, VALUE self) { VALUE ikm, salt, info, opts, kwargs[4], str; static ID kwargs_ids[4]; int saltlen, ikmlen, infolen; size_t len; const EVP_MD *md; EVP_PKEY_CTX *pctx; if (!kwargs_ids[0]) { kwargs_ids[0] = rb_intern_const("salt"); kwargs_ids[1] = rb_intern_const("info"); kwargs_ids[2] = rb_intern_const("length"); kwargs_ids[3] = rb_intern_const("hash"); } rb_scan_args(argc, argv, "1:", &ikm, &opts); rb_get_kwargs(opts, kwargs_ids, 4, 0, kwargs); StringValue(ikm); ikmlen = RSTRING_LENINT(ikm); salt = StringValue(kwargs[0]); saltlen = RSTRING_LENINT(salt); info = StringValue(kwargs[1]); infolen = RSTRING_LENINT(info); len = (size_t)NUM2LONG(kwargs[2]); if (len > LONG_MAX) rb_raise(rb_eArgError, "length must be non-negative"); md = ossl_evp_get_digestbyname(kwargs[3]); str = rb_str_new(NULL, (long)len); pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_HKDF, NULL); if (!pctx) ossl_raise(eKDF, "EVP_PKEY_CTX_new_id"); if (EVP_PKEY_derive_init(pctx) <= 0) { EVP_PKEY_CTX_free(pctx); ossl_raise(eKDF, "EVP_PKEY_derive_init"); } if (EVP_PKEY_CTX_set_hkdf_md(pctx, md) <= 0) { EVP_PKEY_CTX_free(pctx); ossl_raise(eKDF, "EVP_PKEY_CTX_set_hkdf_md"); } if (EVP_PKEY_CTX_set1_hkdf_salt(pctx, (unsigned char *)RSTRING_PTR(salt), saltlen) <= 0) { EVP_PKEY_CTX_free(pctx); ossl_raise(eKDF, "EVP_PKEY_CTX_set_hkdf_salt"); } if (EVP_PKEY_CTX_set1_hkdf_key(pctx, (unsigned char *)RSTRING_PTR(ikm), ikmlen) <= 0) { EVP_PKEY_CTX_free(pctx); ossl_raise(eKDF, "EVP_PKEY_CTX_set_hkdf_key"); } if (EVP_PKEY_CTX_add1_hkdf_info(pctx, (unsigned char *)RSTRING_PTR(info), infolen) <= 0) { EVP_PKEY_CTX_free(pctx); ossl_raise(eKDF, "EVP_PKEY_CTX_set_hkdf_info"); } if (EVP_PKEY_derive(pctx, (unsigned char *)RSTRING_PTR(str), &len) <= 0) { EVP_PKEY_CTX_free(pctx); ossl_raise(eKDF, "EVP_PKEY_derive"); } rb_str_set_len(str, (long)len); EVP_PKEY_CTX_free(pctx); return str; };T;)I"static VALUE;T;*To;;T; ;F;;;I"OpenSSL::KDF.hkdf;F;@Q;@S;T;;¡;0;@U;{;IC;"ËHMAC-based Extract-and-Expand Key Derivation Function (HKDF) as specified in {RFC 5869}[https://tools.ietf.org/html/rfc5869]. New in OpenSSL 1.1.0. === Parameters _ikm_:: The input keying material. _salt_:: The salt. _info_:: The context and application specific information. _length_:: The output length in octets. Must be <= 255 * HashLen, where HashLen is the length of the hash function output in octets. _hash_:: The hash function.;T;[o;= ;3I" overload;F;40;;¡;50;)I",hkdf(ikm, salt:, info:, length:, hash:);T;IC;";T; @x;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @x;[;I"@return [String];T;0;6i;[ [I"ikm;T0[I" salt:;TI";T[I" info:;TI";T[I"length:;TI";T[I" hash:;TI";T; @x;[;I"HMAC-based Extract-and-Expand Key Derivation Function (HKDF) as specified in {RFC 5869}[https://tools.ietf.org/html/rfc5869]. New in OpenSSL 1.1.0. === Parameters _ikm_:: The input keying material. _salt_:: The salt. _info_:: The context and application specific information. _length_:: The output length in octets. Must be <= 255 * HashLen, where HashLen is the length of the hash function output in octets. _hash_:: The hash function. @overload hkdf(ikm, salt:, info:, length:, hash:) @return [String];T;0; @x;!F;"o;#;$T;%i‘;&i¥;6i;'@¤;(@v;)@w;*T;A@¤;BIC;[;A@¤;CIC;[;A@¤;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ìÇió[@ìÇi";T;:KDF;;K;;;[;{;IC;"ÍProvides functionality of various KDFs (key derivation function). KDF is typically used for securely deriving arbitrary length symmetric keys to be used with an OpenSSL::Cipher from passwords. Another use case is for storing passwords: Due to the ability to tweak the effort of computation by increasing the iteration count, computation can be slowed down artificially in order to render possible attacks infeasible. Currently, OpenSSL::KDF provides implementations for the following KDF: * PKCS #5 PBKDF2 (Password-Based Key Derivation Function 2) in combination with HMAC * scrypt * HKDF == Examples === Generating a 128 bit key for a Cipher (e.g. AES) pass = "secret" salt = OpenSSL::Random.random_bytes(16) iter = 20_000 key_len = 16 key = OpenSSL::KDF.pbkdf2_hmac(pass, salt: salt, iterations: iter, length: key_len, hash: "sha1") === Storing Passwords pass = "secret" # store this with the generated value salt = OpenSSL::Random.random_bytes(16) iter = 20_000 hash = OpenSSL::Digest.new('SHA256') len = hash.digest_length # the final value to be stored value = OpenSSL::KDF.pbkdf2_hmac(pass, salt: salt, iterations: iter, length: len, hash: hash) == Important Note on Checking Passwords When comparing passwords provided by the user with previously stored values, a common mistake made is comparing the two values using "==". Typically, "==" short-circuits on evaluation, and is therefore vulnerable to timing attacks. The proper way is to use a method that always takes the same amount of time when comparing two values, thus not leaking any information to potential attackers. To do this, use +OpenSSL.fixed_length_secure_compare+. ;T;[;[;I"Ï Provides functionality of various KDFs (key derivation function). KDF is typically used for securely deriving arbitrary length symmetric keys to be used with an OpenSSL::Cipher from passwords. Another use case is for storing passwords: Due to the ability to tweak the effort of computation by increasing the iteration count, computation can be slowed down artificially in order to render possible attacks infeasible. Currently, OpenSSL::KDF provides implementations for the following KDF: * PKCS #5 PBKDF2 (Password-Based Key Derivation Function 2) in combination with HMAC * scrypt * HKDF == Examples === Generating a 128 bit key for a Cipher (e.g. AES) pass = "secret" salt = OpenSSL::Random.random_bytes(16) iter = 20_000 key_len = 16 key = OpenSSL::KDF.pbkdf2_hmac(pass, salt: salt, iterations: iter, length: key_len, hash: "sha1") === Storing Passwords pass = "secret" # store this with the generated value salt = OpenSSL::Random.random_bytes(16) iter = 20_000 hash = OpenSSL::Digest.new('SHA256') len = hash.digest_length # the final value to be stored value = OpenSSL::KDF.pbkdf2_hmac(pass, salt: salt, iterations: iter, length: len, hash: hash) == Important Note on Checking Passwords When comparing passwords provided by the user with previously stored values, a common mistake made is comparing the two values using "==". Typically, "==" short-circuits on evaluation, and is therefore vulnerable to timing attacks. The proper way is to use a method that always takes the same amount of time when comparing two values, thus not leaking any information to potential attackers. To do this, use +OpenSSL.fixed_length_secure_compare+. ;T;0; @¤;!F;"o;#;$T;%ió;&i;'@ÃÇ;I"OpenSSL::KDF;Fo; ;IC;[+o; ;IC;[;A@¯;BIC;[;A@¯;CIC;[;A@¯;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@îÇi;F;:OCSPError;;K;;;[;{;IC;";T;[;[;@|;0; @¯;'@;I"OpenSSL::OCSP::OCSPError;F;S@ÅÇo; ;IC;[o;;F; ;;;;I"+OpenSSL::OCSP::Request#initialize_copy;F;[[I" other;T0;[[@îÇi°;T;;g;0;[;{;IC;";T;[;[;@|;0; @Â;'@À;(I"—static VALUE ossl_ocspreq_initialize_copy(VALUE self, VALUE other) { OCSP_REQUEST *req, *req_old, *req_new; rb_check_frozen(self); GetOCSPReq(self, req_old); GetOCSPReq(other, req); req_new = ASN1_item_dup(ASN1_ITEM_rptr(OCSP_REQUEST), req); if (!req_new) ossl_raise(eOCSPError, "ASN1_item_dup"); SetOCSPReq(self, req_new); OCSP_REQUEST_free(req_old); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::OCSP::Request#initialize;F;[[@c0;[[@îÇiÌ;T;;Ð;0;[;{;IC;"lCreates a new OpenSSL::OCSP::Request. The request may be created empty or from a _request_der_ string. ;T;[o;= ;3I" overload;F;40;:OpenSSL::OCSP::Request.new;50;)I"OpenSSL::OCSP::Request.new;T;IC;";T; @Ð;>0;!F;[;[;I";T;0;6i;[; @Ðo;= ;3I" overload;F;40;;¤;50;)I",OpenSSL::OCSP::Request.new(request_der);T;IC;";T; @Ð;>0;!F;[;[;I";T;0;6i;[[I"request_der;T0; @Ð;[;I"ÀCreates a new OpenSSL::OCSP::Request. The request may be created empty or from a _request_der_ string. @overload OpenSSL::OCSP::Request.new @overload OpenSSL::OCSP::Request.new(request_der);T;0; @Ð;!F;"o;#;$T;%iÃ;&iÈ;'@À;(I"static VALUE ossl_ocspreq_initialize(int argc, VALUE *argv, VALUE self) { VALUE arg; OCSP_REQUEST *req, *req_new; const unsigned char *p; rb_scan_args(argc, argv, "01", &arg); if(!NIL_P(arg)){ GetOCSPReq(self, req); arg = ossl_to_der_if_possible(arg); StringValue(arg); p = (unsigned char *)RSTRING_PTR(arg); req_new = d2i_OCSP_REQUEST(NULL, &p, RSTRING_LEN(arg)); if (!req_new) ossl_raise(eOCSPError, "d2i_OCSP_REQUEST"); SetOCSPReq(self, req_new); OCSP_REQUEST_free(req); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"%OpenSSL::OCSP::Request#add_nonce;F;[[@c0;[[@îÇiî;T;:add_nonce;0;[;{;IC;"ªAdds a _nonce_ to the OCSP request. If no nonce is given a random one will be generated. The nonce is used to prevent replay attacks but some servers do not support it. ;T;[o;= ;3I" overload;F;40;;¥;50;)I"add_nonce(nonce = nil);T;IC;";T; @ñ;>0;!F;[;[;I";T;0;6i;[[I" nonce;TI"nil;T; @ñ;[;I"ÍAdds a _nonce_ to the OCSP request. If no nonce is given a random one will be generated. The nonce is used to prevent replay attacks but some servers do not support it. @overload add_nonce(nonce = nil);T;0; @ñ;!F;"o;#;$T;%iã;&iê;'@À;(I"ßstatic VALUE ossl_ocspreq_add_nonce(int argc, VALUE *argv, VALUE self) { OCSP_REQUEST *req; VALUE val; int ret; rb_scan_args(argc, argv, "01", &val); if(NIL_P(val)) { GetOCSPReq(self, req); ret = OCSP_request_add1_nonce(req, NULL, -1); } else{ StringValue(val); GetOCSPReq(self, req); ret = OCSP_request_add1_nonce(req, (unsigned char *)RSTRING_PTR(val), RSTRING_LENINT(val)); } if(!ret) ossl_raise(eOCSPError, NULL); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::OCSP::Request#check_nonce;F;[[I"basic_resp;T0;[[@îÇi;T;:check_nonce;0;[;{;IC;"ÆChecks the nonce validity for this request and _response_. The return value is one of the following: -1 :: nonce in request only. 0 :: nonces both present and not equal. 1 :: nonces present and equal. 2 :: nonces both absent. 3 :: nonce present in response only. For most responses, clients can check _result_ > 0. If a responder doesn't handle nonces result.nonzero? may be necessary. A result of 0 is always an error. ;T;[o;= ;3I" overload;F;40;;¦;50;)I"check_nonce(response);T;IC;";T; @;>0;!F;[;[;I";T;0;6i;[[I" response;T0; @;[;I"èChecks the nonce validity for this request and _response_. The return value is one of the following: -1 :: nonce in request only. 0 :: nonces both present and not equal. 1 :: nonces present and equal. 2 :: nonces both absent. 3 :: nonce present in response only. For most responses, clients can check _result_ > 0. If a responder doesn't handle nonces result.nonzero? may be necessary. A result of 0 is always an error. @overload check_nonce(response);T;0; @;!F;"o;#;$T;%i;&i;'@À;(I"static VALUE ossl_ocspreq_check_nonce(VALUE self, VALUE basic_resp) { OCSP_REQUEST *req; OCSP_BASICRESP *bs; int res; GetOCSPReq(self, req); GetOCSPBasicRes(basic_resp, bs); res = OCSP_check_nonce(req, bs); return INT2NUM(res); };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::OCSP::Request#add_certid;F;[[I"certid;T0;[[@îÇi,;T;:add_certid;0;[;{;IC;"*Adds _certificate_id_ to the request. ;T;[o;= ;3I" overload;F;40;;§;50;)I"add_certid(certificate_id);T;IC;";T; @%;>0;!F;[;[;I";T;0;6i;[[I"certificate_id;T0; @%;[;I"QAdds _certificate_id_ to the request. @overload add_certid(certificate_id);T;0; @%;!F;"o;#;$T;%i%;&i(;'@À;(I"šstatic VALUE ossl_ocspreq_add_certid(VALUE self, VALUE certid) { OCSP_REQUEST *req; OCSP_CERTID *id, *id_new; GetOCSPReq(self, req); GetOCSPCertId(certid, id); if (!(id_new = OCSP_CERTID_dup(id))) ossl_raise(eOCSPError, "OCSP_CERTID_dup"); if (!OCSP_request_add0_id(req, id_new)) { OCSP_CERTID_free(id_new); ossl_raise(eOCSPError, "OCSP_request_add0_id"); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::OCSP::Request#certid;F;[;[[@îÇiF;T;:certid;0;[;{;IC;"1Returns all certificate IDs in this request. ;T;[o;= ;3I" overload;F;40;;¨;50;)I"certid;T;IC;";T; @?;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @?;[;I"@return [Array];T;0;6i;[; @?;[;I"VReturns all certificate IDs in this request. @overload certid @return [Array];T;0; @?;!F;"o;#;$T;%i?;&iC;'@À;(I"static VALUE ossl_ocspreq_get_certid(VALUE self) { OCSP_REQUEST *req; OCSP_ONEREQ *one; OCSP_CERTID *id; VALUE ary, tmp; int i, count; GetOCSPReq(self, req); count = OCSP_request_onereq_count(req); ary = (count > 0) ? rb_ary_new() : Qnil; for(i = 0; i < count; i++){ one = OCSP_request_onereq_get0(req, i); tmp = NewOCSPCertId(cOCSPCertId); if(!(id = OCSP_CERTID_dup(OCSP_onereq_get0_id(one)))) ossl_raise(eOCSPError, NULL); SetOCSPCertId(tmp, id); rb_ary_push(ary, tmp); } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::OCSP::Request#signed?;F;[;[[@îÇiÑ;T;:signed?;0;[;{;IC;"‘Returns +true+ if the request is signed, +false+ otherwise. Note that the validity of the signature is *not* checked. Use #verify to verify that.;T;[o;= ;3I" overload;F;40;;©;50;)I"signed?;T;IC;";T; @Z;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Z;[;I"@return [Boolean];T;0;6i;[; @Z;[;I"¹Returns +true+ if the request is signed, +false+ otherwise. Note that the validity of the signature is *not* checked. Use #verify to verify that. @overload signed? @return [Boolean];T;0; @Z;!F;"o;#;$T;%iÊ;&iÏ;6i;'@À;(I"žstatic VALUE ossl_ocspreq_signed_p(VALUE self) { OCSP_REQUEST *req; GetOCSPReq(self, req); return OCSP_request_is_signed(req) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I" OpenSSL::OCSP::Request#sign;F;[[@c0;[[@îÇin;T;;Ä;0;[;{;IC;"Signs this OCSP request using _cert_, _key_ and optional _digest_. If _digest_ is not specified, SHA-1 is used. _certs_ is an optional Array of additional certificates which are included in the request in addition to the signer certificate. Note that if _certs_ is +nil+ or not given, flag OpenSSL::OCSP::NOCERTS is enabled. Pass an empty array to include only the signer certificate. _flags_ is a bitwise OR of the following constants: OpenSSL::OCSP::NOCERTS:: Don't include any certificates in the request. _certs_ will be ignored. ;T;[o;= ;3I" overload;F;40;;Ä;50;)I":sign(cert, key, certs = nil, flags = 0, digest = nil);T;IC;";T; @u;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @u;[;I"@return [self];T;0;6i;[ [I" cert;T0[I"key;T0[I" certs;TI"nil;T[I" flags;TI"0;T[I"digest;TI"nil;T; @u;[;I"lSigns this OCSP request using _cert_, _key_ and optional _digest_. If _digest_ is not specified, SHA-1 is used. _certs_ is an optional Array of additional certificates which are included in the request in addition to the signer certificate. Note that if _certs_ is +nil+ or not given, flag OpenSSL::OCSP::NOCERTS is enabled. Pass an empty array to include only the signer certificate. _flags_ is a bitwise OR of the following constants: OpenSSL::OCSP::NOCERTS:: Don't include any certificates in the request. _certs_ will be ignored. @overload sign(cert, key, certs = nil, flags = 0, digest = nil) @return [self];T;0; @u;!F;"o;#;$T;%i^;&il;'@À;(I"dstatic VALUE ossl_ocspreq_sign(int argc, VALUE *argv, VALUE self) { VALUE signer_cert, signer_key, certs, flags, digest; OCSP_REQUEST *req; X509 *signer; EVP_PKEY *key; STACK_OF(X509) *x509s = NULL; unsigned long flg = 0; const EVP_MD *md; int ret; rb_scan_args(argc, argv, "23", &signer_cert, &signer_key, &certs, &flags, &digest); GetOCSPReq(self, req); signer = GetX509CertPtr(signer_cert); key = GetPrivPKeyPtr(signer_key); if (!NIL_P(flags)) flg = NUM2INT(flags); if (NIL_P(digest)) md = EVP_sha1(); else md = ossl_evp_get_digestbyname(digest); if (NIL_P(certs)) flg |= OCSP_NOCERTS; else x509s = ossl_x509_ary2sk(certs); ret = OCSP_request_sign(req, signer, key, md, x509s, flg); sk_X509_pop_free(x509s, X509_free); if (!ret) ossl_raise(eOCSPError, NULL); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::OCSP::Request#verify;F;[[@c0;[[@îÇiœ;T;;Å;0;[;{;IC;"$Verifies this request using the given _certificates_ and _store_. _certificates_ is an array of OpenSSL::X509::Certificate, _store_ is an OpenSSL::X509::Store. Note that +false+ is returned if the request does not have a signature. Use #signed? to check whether the request is signed or not. ;T;[o;= ;3I" overload;F;40;;Å;50;)I"+verify(certificates, store, flags = 0);T;IC;";T; @ž;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ž;[;I"@return [Boolean];T;0;6i;[[I"certificates;T0[I" store;T0[I" flags;TI"0;T; @ž;[;I"kVerifies this request using the given _certificates_ and _store_. _certificates_ is an array of OpenSSL::X509::Certificate, _store_ is an OpenSSL::X509::Store. Note that +false+ is returned if the request does not have a signature. Use #signed? to check whether the request is signed or not. @overload verify(certificates, store, flags = 0) @return [Boolean];T;0; @ž;!F;"o;#;$T;%i;&i™;'@À;(I"Jstatic VALUE ossl_ocspreq_verify(int argc, VALUE *argv, VALUE self) { VALUE certs, store, flags; OCSP_REQUEST *req; STACK_OF(X509) *x509s; X509_STORE *x509st; int flg, result; rb_scan_args(argc, argv, "21", &certs, &store, &flags); GetOCSPReq(self, req); x509st = GetX509StorePtr(store); flg = NIL_P(flags) ? 0 : NUM2INT(flags); x509s = ossl_x509_ary2sk(certs); result = OCSP_request_verify(req, x509s, x509st, flg); sk_X509_pop_free(x509s, X509_free); if (result <= 0) ossl_clear_error(); return result > 0 ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::OCSP::Request#to_der;F;[;[[@îÇi¶;T;;°;0;[;{;IC;"1Returns this request as a DER-encoded string ;T;[;[;I"2Returns this request as a DER-encoded string ;T;0; @Á;!F;"o;#;$T;%i²;&i³;'@À;(I"£static VALUE ossl_ocspreq_to_der(VALUE self) { OCSP_REQUEST *req; VALUE str; unsigned char *p; long len; GetOCSPReq(self, req); if((len = i2d_OCSP_REQUEST(req, NULL)) <= 0) ossl_raise(eOCSPError, NULL); str = rb_str_new(0, len); p = (unsigned char *)RSTRING_PTR(str); if(i2d_OCSP_REQUEST(req, &p) <= 0) ossl_raise(eOCSPError, NULL); ossl_str_adjust(str, p); return str; };T;)I"static VALUE;T;*T;A@À;BIC;[;A@À;CIC;[;A@À;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@îÇi ;F;;ñ;;K;;;[;{;IC;";T;[;[;@|;0; @À;6i;'@;I"OpenSSL::OCSP::Request;F;S@]o; ;IC;[o;;F; ;F;;;I"#OpenSSL::OCSP::Response.create;F;[[I"status;T0[I"basic_resp;T0;[[@îÇiä;T;:create;0;[;{;IC;"KCreates an OpenSSL::OCSP::Response from _status_ and _basic_response_. ;T;[o;= ;3I" overload;F;40;:#OpenSSL::OCSP::Response.create;50;)I"AOpenSSL::OCSP::Response.create(status, basic_response = nil);T;IC;";T; @à;>0;!F;[;[;I";T;0;6i;[[I"status;T0[I"basic_response;TI"nil;T; @à;[;I"Creates an OpenSSL::OCSP::Response from _status_ and _basic_response_. @overload OpenSSL::OCSP::Response.create(status, basic_response = nil);T;0; @à;!F;"o;#;$T;%iÞ;&iá;'@Þ;(I"ªstatic VALUE ossl_ocspres_s_create(VALUE klass, VALUE status, VALUE basic_resp) { OCSP_BASICRESP *bs; OCSP_RESPONSE *res; VALUE obj; int st = NUM2INT(status); if(NIL_P(basic_resp)) bs = NULL; else GetOCSPBasicRes(basic_resp, bs); /* NO NEED TO DUP */ obj = NewOCSPRes(klass); if(!(res = OCSP_response_create(st, bs))) ossl_raise(eOCSPError, NULL); SetOCSPRes(obj, res); return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I",OpenSSL::OCSP::Response#initialize_copy;F;[[I" other;T0;[[@îÇi;T;;g;0;[;{;IC;";T;[;[;@|;0; @ÿ;'@Þ;(I"šstatic VALUE ossl_ocspres_initialize_copy(VALUE self, VALUE other) { OCSP_RESPONSE *res, *res_old, *res_new; rb_check_frozen(self); GetOCSPRes(self, res_old); GetOCSPRes(other, res); res_new = ASN1_item_dup(ASN1_ITEM_rptr(OCSP_RESPONSE), res); if (!res_new) ossl_raise(eOCSPError, "ASN1_item_dup"); SetOCSPRes(self, res_new); OCSP_RESPONSE_free(res_old); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::OCSP::Response#initialize;F;[[@c0;[[@îÇi ;T;;Ð;0;[;{;IC;"oCreates a new OpenSSL::OCSP::Response. The response may be created empty or from a _response_der_ string. ;T;[o;= ;3I" overload;F;40;: OpenSSL::OCSP::Response.new;50;)I" OpenSSL::OCSP::Response.new;T;IC;";T; @ ;>0;!F;[;[;I";T;0;6i;[; @ o;= ;3I" overload;F;40;;¬;50;)I".OpenSSL::OCSP::Response.new(response_der);T;IC;";T; @ ;>0;!F;[;[;I";T;0;6i;[[I"response_der;T0; @ ;[;I"ÆCreates a new OpenSSL::OCSP::Response. The response may be created empty or from a _response_der_ string. @overload OpenSSL::OCSP::Response.new @overload OpenSSL::OCSP::Response.new(response_der);T;0; @ ;!F;"o;#;$T;%i;&i;'@Þ;(I"static VALUE ossl_ocspres_initialize(int argc, VALUE *argv, VALUE self) { VALUE arg; OCSP_RESPONSE *res, *res_new; const unsigned char *p; rb_scan_args(argc, argv, "01", &arg); if(!NIL_P(arg)){ GetOCSPRes(self, res); arg = ossl_to_der_if_possible(arg); StringValue(arg); p = (unsigned char *)RSTRING_PTR(arg); res_new = d2i_OCSP_RESPONSE(NULL, &p, RSTRING_LEN(arg)); if (!res_new) ossl_raise(eOCSPError, "d2i_OCSP_RESPONSE"); SetOCSPRes(self, res_new); OCSP_RESPONSE_free(res); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::OCSP::Response#status;F;[;[[@îÇi>;T;;É;0;[;{;IC;"(Returns the status of the response. ;T;[o;= ;3I" overload;F;40;;É;50;)I"status;T;IC;";T; @.;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @.;[;I"@return [Integer];T;0;6i;[; @.;[;I"OReturns the status of the response. @overload status @return [Integer];T;0; @.;!F;"o;#;$T;%i7;&i;;'@Þ;(I"static VALUE ossl_ocspres_status(VALUE self) { OCSP_RESPONSE *res; int st; GetOCSPRes(self, res); st = OCSP_response_status(res); return INT2NUM(st); };T;)I"static VALUE;T;*To;;F; ;;;;I"*OpenSSL::OCSP::Response#status_string;F;[;[[@îÇiQ;T;:status_string;0;[;{;IC;".Returns a status string for the response. ;T;[o;= ;3I" overload;F;40;;;50;)I"status_string;T;IC;";T; @I;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @I;[;I"@return [String];T;0;6i;[; @I;[;I"[Returns a status string for the response. @overload status_string @return [String];T;0; @I;!F;"o;#;$T;%iJ;&iN;'@Þ;(I"Òstatic VALUE ossl_ocspres_status_string(VALUE self) { OCSP_RESPONSE *res; int st; GetOCSPRes(self, res); st = OCSP_response_status(res); return rb_str_new2(OCSP_response_status_str(st)); };T;)I"static VALUE;T;*To;;F; ;;;;I""OpenSSL::OCSP::Response#basic;F;[;[[@îÇid;T;: basic;0;[;{;IC;".Returns a BasicResponse for this response ;T;[o;= ;3I" overload;F;40;;®;50;)I" basic;T;IC;";T; @d;>0;!F;[;[;I";T;0;6i;[; @d;[;I"@Returns a BasicResponse for this response @overload basic;T;0; @d;!F;"o;#;$T;%i];&i`;'@Þ;(I"#static VALUE ossl_ocspres_get_basic(VALUE self) { OCSP_RESPONSE *res; OCSP_BASICRESP *bs; VALUE ret; GetOCSPRes(self, res); ret = NewOCSPBasicRes(cOCSPBasicRes); if(!(bs = OCSP_response_get1_basic(res))) return Qnil; SetOCSPBasicRes(ret, bs); return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::OCSP::Response#to_der;F;[;[[@îÇi{;T;;°;0;[;{;IC;"3Returns this response as a DER-encoded string. ;T;[o;= ;3I" overload;F;40;;°;50;)I"to_der;T;IC;";T; @z;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @z;[;I"@return [String];T;0;6i;[; @z;[;I"YReturns this response as a DER-encoded string. @overload to_der @return [String];T;0; @z;!F;"o;#;$T;%it;&ix;'@Þ;(I"¦static VALUE ossl_ocspres_to_der(VALUE self) { OCSP_RESPONSE *res; VALUE str; long len; unsigned char *p; GetOCSPRes(self, res); if((len = i2d_OCSP_RESPONSE(res, NULL)) <= 0) ossl_raise(eOCSPError, NULL); str = rb_str_new(0, len); p = (unsigned char *)RSTRING_PTR(str); if(i2d_OCSP_RESPONSE(res, &p) <= 0) ossl_raise(eOCSPError, NULL); ossl_str_adjust(str, p); return str; };T;)I"static VALUE;T;*T;A@Þ;BIC;[;A@Þ;CIC;[;A@Þ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@îÇi2;F;: Response;;K;;;[;{;IC;";T;[;[;@|;0; @Þ;6i;'@;I"OpenSSL::OCSP::Response;F;S@]o; ;IC;[o;;F; ;;;;I"1OpenSSL::OCSP::BasicResponse#initialize_copy;F;[[I" other;T0;[[@îÇi ;T;;g;0;[;{;IC;";T;[;[;@|;0; @¦;'@¤;(I"£static VALUE ossl_ocspbres_initialize_copy(VALUE self, VALUE other) { OCSP_BASICRESP *bs, *bs_old, *bs_new; rb_check_frozen(self); GetOCSPBasicRes(self, bs_old); GetOCSPBasicRes(other, bs); bs_new = ASN1_item_dup(ASN1_ITEM_rptr(OCSP_BASICRESP), bs); if (!bs_new) ossl_raise(eOCSPError, "ASN1_item_dup"); SetOCSPBasicRes(self, bs_new); OCSP_BASICRESP_free(bs_old); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I",OpenSSL::OCSP::BasicResponse#initialize;F;[[@c0;[[@îÇi»;T;;Ð;0;[;{;IC;"XCreates a new BasicResponse. If _der_string_ is given, decodes _der_string_ as DER. ;T;[o;= ;3I" overload;F;40;:%OpenSSL::OCSP::BasicResponse.new;50;)I"7OpenSSL::OCSP::BasicResponse.new(der_string = nil);T;IC;";T; @´;>0;!F;[;[;I";T;0;6i;[[I"der_string;TI"nil;T; @´;[;I"’Creates a new BasicResponse. If _der_string_ is given, decodes _der_string_ as DER. @overload OpenSSL::OCSP::BasicResponse.new(der_string = nil);T;0; @´;!F;"o;#;$T;%i³;&i·;'@¤;(I"*static VALUE ossl_ocspbres_initialize(int argc, VALUE *argv, VALUE self) { VALUE arg; OCSP_BASICRESP *res, *res_new; const unsigned char *p; rb_scan_args(argc, argv, "01", &arg); if (!NIL_P(arg)) { GetOCSPBasicRes(self, res); arg = ossl_to_der_if_possible(arg); StringValue(arg); p = (unsigned char *)RSTRING_PTR(arg); res_new = d2i_OCSP_BASICRESP(NULL, &p, RSTRING_LEN(arg)); if (!res_new) ossl_raise(eOCSPError, "d2i_OCSP_BASICRESP"); SetOCSPBasicRes(self, res_new); OCSP_BASICRESP_free(res); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I",OpenSSL::OCSP::BasicResponse#copy_nonce;F;[[I"request;T0;[[@îÇiÚ;T;:copy_nonce;0;[;{;IC;"`Copies the nonce from _request_ into this response. Returns 1 on success and 0 on failure. ;T;[o;= ;3I" overload;F;40;;±;50;)I"copy_nonce(request);T;IC;";T; @Î;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Î;[;I"@return [Integer];T;0;6i;[[I"request;T0; @Î;[;I"Copies the nonce from _request_ into this response. Returns 1 on success and 0 on failure. @overload copy_nonce(request) @return [Integer];T;0; @Î;!F;"o;#;$T;%iÒ;&i×;'@¤;(I"üstatic VALUE ossl_ocspbres_copy_nonce(VALUE self, VALUE request) { OCSP_BASICRESP *bs; OCSP_REQUEST *req; int ret; GetOCSPBasicRes(self, bs); GetOCSPReq(request, req); ret = OCSP_copy_nonce(bs, req); return INT2NUM(ret); };T;)I"static VALUE;T;*To;;F; ;;;;I"+OpenSSL::OCSP::BasicResponse#add_nonce;F;[[@c0;[[@îÇið;T;;¥;0;[;{;IC;"[Adds _nonce_ to this response. If no nonce was provided a random nonce will be added. ;T;[o;= ;3I" overload;F;40;;¥;50;)I"add_nonce(nonce = nil);T;IC;";T; @í;>0;!F;[;[;I";T;0;6i;[[I" nonce;TI"nil;T; @í;[;I"~Adds _nonce_ to this response. If no nonce was provided a random nonce will be added. @overload add_nonce(nonce = nil);T;0; @í;!F;"o;#;$T;%iè;&iì;'@¤;(I"ãstatic VALUE ossl_ocspbres_add_nonce(int argc, VALUE *argv, VALUE self) { OCSP_BASICRESP *bs; VALUE val; int ret; rb_scan_args(argc, argv, "01", &val); if(NIL_P(val)) { GetOCSPBasicRes(self, bs); ret = OCSP_basic_add1_nonce(bs, NULL, -1); } else{ StringValue(val); GetOCSPBasicRes(self, bs); ret = OCSP_basic_add1_nonce(bs, (unsigned char *)RSTRING_PTR(val), RSTRING_LENINT(val)); } if(!ret) ossl_raise(eOCSPError, NULL); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I",OpenSSL::OCSP::BasicResponse#add_status;F;[[I"cid;T0[I"status;T0[I"reason;T0[I"revtime;T0[I"thisupd;T0[I"nextupd;T0[I"ext;T0;[[@îÇi1;T;:add_status;0;[;{;IC;"ûAdds a certificate status for _certificate_id_. _status_ is the status, and must be one of these: - OpenSSL::OCSP::V_CERTSTATUS_GOOD - OpenSSL::OCSP::V_CERTSTATUS_REVOKED - OpenSSL::OCSP::V_CERTSTATUS_UNKNOWN _reason_ and _revocation_time_ can be given only when _status_ is OpenSSL::OCSP::V_CERTSTATUS_REVOKED. _reason_ describes the reason for the revocation, and must be one of OpenSSL::OCSP::REVOKED_STATUS_* constants. _revocation_time_ is the time when the certificate is revoked. _this_update_ and _next_update_ indicate the time at which ths status is verified to be correct and the time at or before which newer information will be available, respectively. _next_update_ is optional. _extensions_ is an Array of OpenSSL::X509::Extension to be included in the SingleResponse. This is also optional. Note that the times, _revocation_time_, _this_update_ and _next_update_ can be specified in either of Integer or Time object. If they are Integer, it is treated as the relative seconds from the current time. ;T;[o;= ;3I" overload;F;40;;²;50;)I"fadd_status(certificate_id, status, reason, revocation_time, this_update, next_update, extensions);T;IC;";T; @;>0;!F;[;[;I";T;0;6i;[[I"certificate_id;T0[I"status;T0[I"reason;T0[I"revocation_time;T0[I"this_update;T0[I"next_update;T0[I"extensions;T0; @;[;I"iAdds a certificate status for _certificate_id_. _status_ is the status, and must be one of these: - OpenSSL::OCSP::V_CERTSTATUS_GOOD - OpenSSL::OCSP::V_CERTSTATUS_REVOKED - OpenSSL::OCSP::V_CERTSTATUS_UNKNOWN _reason_ and _revocation_time_ can be given only when _status_ is OpenSSL::OCSP::V_CERTSTATUS_REVOKED. _reason_ describes the reason for the revocation, and must be one of OpenSSL::OCSP::REVOKED_STATUS_* constants. _revocation_time_ is the time when the certificate is revoked. _this_update_ and _next_update_ indicate the time at which ths status is verified to be correct and the time at or before which newer information will be available, respectively. _next_update_ is optional. _extensions_ is an Array of OpenSSL::X509::Extension to be included in the SingleResponse. This is also optional. Note that the times, _revocation_time_, _this_update_ and _next_update_ can be specified in either of Integer or Time object. If they are Integer, it is treated as the relative seconds from the current time. @overload add_status(certificate_id, status, reason, revocation_time, this_update, next_update, extensions);T;0; @;!F;"o;#;$T;%i;&i.;'@¤;(I"Ustatic VALUE ossl_ocspbres_add_status(VALUE self, VALUE cid, VALUE status, VALUE reason, VALUE revtime, VALUE thisupd, VALUE nextupd, VALUE ext) { OCSP_BASICRESP *bs; OCSP_SINGLERESP *single; OCSP_CERTID *id; ASN1_TIME *ths = NULL, *nxt = NULL, *rev = NULL; int st, rsn = 0, error = 0, rstatus = 0; long i; VALUE tmp; GetOCSPBasicRes(self, bs); GetOCSPCertId(cid, id); st = NUM2INT(status); if (!NIL_P(ext)) { /* All ext's members must be X509::Extension */ ext = rb_check_array_type(ext); for (i = 0; i < RARRAY_LEN(ext); i++) OSSL_Check_Kind(RARRAY_AREF(ext, i), cX509Ext); } if (st == V_OCSP_CERTSTATUS_REVOKED) { rsn = NUM2INT(reason); tmp = rb_protect(add_status_convert_time, revtime, &rstatus); if (rstatus) goto err; rev = (ASN1_TIME *)tmp; } tmp = rb_protect(add_status_convert_time, thisupd, &rstatus); if (rstatus) goto err; ths = (ASN1_TIME *)tmp; if (!NIL_P(nextupd)) { tmp = rb_protect(add_status_convert_time, nextupd, &rstatus); if (rstatus) goto err; nxt = (ASN1_TIME *)tmp; } if(!(single = OCSP_basic_add1_status(bs, id, st, rsn, rev, ths, nxt))){ error = 1; goto err; } if(!NIL_P(ext)){ X509_EXTENSION *x509ext; for(i = 0; i < RARRAY_LEN(ext); i++){ x509ext = GetX509ExtPtr(RARRAY_AREF(ext, i)); if(!OCSP_SINGLERESP_add_ext(single, x509ext, -1)){ error = 1; goto err; } } } err: ASN1_TIME_free(ths); ASN1_TIME_free(nxt); ASN1_TIME_free(rev); if(error) ossl_raise(eOCSPError, NULL); if(rstatus) rb_jump_tag(rstatus); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"(OpenSSL::OCSP::BasicResponse#status;F;[;[[@îÇi;T;;É;0;[;{;IC;"€Returns an Array of statuses for this response. Each status contains a CertificateId, the status (0 for good, 1 for revoked, 2 for unknown), the reason for the status, the revocation time, the time of this update, the time for the next update and a list of OpenSSL::X509::Extension. This should be superseded by BasicResponse#responses and #find_response that return SingleResponse. ;T;[o;= ;3I" overload;F;40;;É;50;)I"status;T;IC;";T; @9;>0;!F;[;[;I";T;0;6i;[; @9;[;I"“Returns an Array of statuses for this response. Each status contains a CertificateId, the status (0 for good, 1 for revoked, 2 for unknown), the reason for the status, the revocation time, the time of this update, the time for the next update and a list of OpenSSL::X509::Extension. This should be superseded by BasicResponse#responses and #find_response that return SingleResponse. @overload status;T;0; @9;!F;"o;#;$T;%is;&i|;'@¤;(I"@static VALUE ossl_ocspbres_get_status(VALUE self) { OCSP_BASICRESP *bs; OCSP_SINGLERESP *single; OCSP_CERTID *cid; ASN1_TIME *revtime, *thisupd, *nextupd; int status, reason; X509_EXTENSION *x509ext; VALUE ret, ary, ext; int count, ext_count, i, j; GetOCSPBasicRes(self, bs); ret = rb_ary_new(); count = OCSP_resp_count(bs); for(i = 0; i < count; i++){ single = OCSP_resp_get0(bs, i); if(!single) continue; revtime = thisupd = nextupd = NULL; status = OCSP_single_get0_status(single, &reason, &revtime, &thisupd, &nextupd); if(status < 0) continue; if(!(cid = OCSP_CERTID_dup((OCSP_CERTID *)OCSP_SINGLERESP_get0_id(single)))) /* FIXME */ ossl_raise(eOCSPError, NULL); ary = rb_ary_new(); rb_ary_push(ary, ossl_ocspcertid_new(cid)); rb_ary_push(ary, INT2NUM(status)); rb_ary_push(ary, INT2NUM(reason)); rb_ary_push(ary, revtime ? asn1time_to_time(revtime) : Qnil); rb_ary_push(ary, thisupd ? asn1time_to_time(thisupd) : Qnil); rb_ary_push(ary, nextupd ? asn1time_to_time(nextupd) : Qnil); ext = rb_ary_new(); ext_count = OCSP_SINGLERESP_get_ext_count(single); for(j = 0; j < ext_count; j++){ x509ext = OCSP_SINGLERESP_get_ext(single, j); rb_ary_push(ext, ossl_x509ext_new(x509ext)); } rb_ary_push(ary, ext); rb_ary_push(ret, ary); } return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"+OpenSSL::OCSP::BasicResponse#responses;F;[;[[@îÇiµ;T;:responses;0;[;{;IC;"?Returns an Array of SingleResponse for this BasicResponse. ;T;[o;= ;3I" overload;F;40;;³;50;)I"responses;T;IC;";T; @O;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Array of SingleResponse;T; @O;[;I"&@return [Array of SingleResponse];T;0;6i;[; @O;[;I"yReturns an Array of SingleResponse for this BasicResponse. @overload responses @return [Array of SingleResponse];T;0; @O;!F;"o;#;$T;%i®;&i²;'@¤;(I"þstatic VALUE ossl_ocspbres_get_responses(VALUE self) { OCSP_BASICRESP *bs; VALUE ret; int count, i; GetOCSPBasicRes(self, bs); count = OCSP_resp_count(bs); ret = rb_ary_new2(count); for (i = 0; i < count; i++) { OCSP_SINGLERESP *sres, *sres_new; sres = OCSP_resp_get0(bs, i); sres_new = ASN1_item_dup(ASN1_ITEM_rptr(OCSP_SINGLERESP), sres); if (!sres_new) ossl_raise(eOCSPError, "ASN1_item_dup"); rb_ary_push(ret, ossl_ocspsres_new(sres_new)); } return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"/OpenSSL::OCSP::BasicResponse#find_response;F;[[I"target;T0;[[@îÇiÖ;T;:find_response;0;[;{;IC;"}Returns a SingleResponse whose CertId matches with _certificate_id_, or +nil+ if this BasicResponse does not contain it. ;T;[o;= ;3I" overload;F;40;;´;50;)I""find_response(certificate_id);T;IC;";T; @j;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"SingleResponse | nil;T; @j;[;I"#@return [SingleResponse | nil];T;0;6i;[[I"certificate_id;T0; @j;[;I"ÃReturns a SingleResponse whose CertId matches with _certificate_id_, or +nil+ if this BasicResponse does not contain it. @overload find_response(certificate_id) @return [SingleResponse | nil];T;0; @j;!F;"o;#;$T;%iÏ;&iÔ;'@¤;(I"ðstatic VALUE ossl_ocspbres_find_response(VALUE self, VALUE target) { OCSP_BASICRESP *bs; OCSP_SINGLERESP *sres, *sres_new; OCSP_CERTID *id; int n; GetOCSPCertId(target, id); GetOCSPBasicRes(self, bs); if ((n = OCSP_resp_find(bs, id, -1)) == -1) return Qnil; sres = OCSP_resp_get0(bs, n); sres_new = ASN1_item_dup(ASN1_ITEM_rptr(OCSP_SINGLERESP), sres); if (!sres_new) ossl_raise(eOCSPError, "ASN1_item_dup"); return ossl_ocspsres_new(sres_new); };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::OCSP::BasicResponse#sign;F;[[@c0;[[@îÇiù;T;;Ä;0;[;{;IC;"MSigns this OCSP response using the _cert_, _key_ and optional _digest_. This behaves in the similar way as OpenSSL::OCSP::Request#sign. _flags_ can include: OpenSSL::OCSP::NOCERTS:: don't include certificates OpenSSL::OCSP::NOTIME:: don't set producedAt OpenSSL::OCSP::RESPID_KEY:: use signer's public key hash as responderID ;T;[o;= ;3I" overload;F;40;;Ä;50;)I":sign(cert, key, certs = nil, flags = 0, digest = nil);T;IC;";T; @‰;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @‰;[;I"@return [self];T;0;6i;[ [I" cert;T0[I"key;T0[I" certs;TI"nil;T[I" flags;TI"0;T[I"digest;TI"nil;T; @‰;[;I" Signs this OCSP response using the _cert_, _key_ and optional _digest_. This behaves in the similar way as OpenSSL::OCSP::Request#sign. _flags_ can include: OpenSSL::OCSP::NOCERTS:: don't include certificates OpenSSL::OCSP::NOTIME:: don't set producedAt OpenSSL::OCSP::RESPID_KEY:: use signer's public key hash as responderID @overload sign(cert, key, certs = nil, flags = 0, digest = nil) @return [self];T;0; @‰;!F;"o;#;$T;%iì;&iö;'@¤;(I"gstatic VALUE ossl_ocspbres_sign(int argc, VALUE *argv, VALUE self) { VALUE signer_cert, signer_key, certs, flags, digest; OCSP_BASICRESP *bs; X509 *signer; EVP_PKEY *key; STACK_OF(X509) *x509s = NULL; unsigned long flg = 0; const EVP_MD *md; int ret; rb_scan_args(argc, argv, "23", &signer_cert, &signer_key, &certs, &flags, &digest); GetOCSPBasicRes(self, bs); signer = GetX509CertPtr(signer_cert); key = GetPrivPKeyPtr(signer_key); if (!NIL_P(flags)) flg = NUM2INT(flags); if (NIL_P(digest)) md = EVP_sha1(); else md = ossl_evp_get_digestbyname(digest); if (NIL_P(certs)) flg |= OCSP_NOCERTS; else x509s = ossl_x509_ary2sk(certs); ret = OCSP_basic_sign(bs, signer, key, md, x509s, flg); sk_X509_pop_free(x509s, X509_free); if (!ret) ossl_raise(eOCSPError, NULL); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"(OpenSSL::OCSP::BasicResponse#verify;F;[[@c0;[[@îÇi";T;;Å;0;[;{;IC;"’Verifies the signature of the response using the given _certificates_ and _store_. This works in the similar way as OpenSSL::OCSP::Request#verify. ;T;[o;= ;3I" overload;F;40;;Å;50;)I"+verify(certificates, store, flags = 0);T;IC;";T; @²;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @²;[;I"@return [Boolean];T;0;6i;[[I"certificates;T0[I" store;T0[I" flags;TI"0;T; @²;[;I"ÙVerifies the signature of the response using the given _certificates_ and _store_. This works in the similar way as OpenSSL::OCSP::Request#verify. @overload verify(certificates, store, flags = 0) @return [Boolean];T;0; @²;!F;"o;#;$T;%i;&i ;'@¤;(I"¤static VALUE ossl_ocspbres_verify(int argc, VALUE *argv, VALUE self) { VALUE certs, store, flags; OCSP_BASICRESP *bs; STACK_OF(X509) *x509s; X509_STORE *x509st; int flg, result; rb_scan_args(argc, argv, "21", &certs, &store, &flags); GetOCSPBasicRes(self, bs); x509st = GetX509StorePtr(store); flg = NIL_P(flags) ? 0 : NUM2INT(flags); x509s = ossl_x509_ary2sk(certs); #if (OPENSSL_VERSION_NUMBER < 0x1000202fL) || defined(LIBRESSL_VERSION_NUMBER) /* * OpenSSL had a bug that it doesn't use the certificates in x509s for * verifying the chain. This can be a problem when the response is signed by * a certificate issued by an intermediate CA. * * root_ca * | * intermediate_ca * |-------------| * end_entity ocsp_signer * * When the certificate hierarchy is like this, and the response contains * only ocsp_signer certificate, the following code wrongly fails. * * store = OpenSSL::X509::Store.new; store.add_cert(root_ca) * basic_response.verify([intermediate_ca], store) * * So add the certificates in x509s to the embedded certificates list first. * * This is fixed in OpenSSL 0.9.8zg, 1.0.0s, 1.0.1n, 1.0.2b. But it still * exists in LibreSSL 2.1.10, 2.2.9, 2.3.6, 2.4.1. */ if (!(flg & (OCSP_NOCHAIN | OCSP_NOVERIFY)) && sk_X509_num(x509s) && sk_X509_num(bs->certs)) { int i; bs = ASN1_item_dup(ASN1_ITEM_rptr(OCSP_BASICRESP), bs); if (!bs) { sk_X509_pop_free(x509s, X509_free); ossl_raise(eOCSPError, "ASN1_item_dup"); } for (i = 0; i < sk_X509_num(x509s); i++) { if (!OCSP_basic_add1_cert(bs, sk_X509_value(x509s, i))) { sk_X509_pop_free(x509s, X509_free); OCSP_BASICRESP_free(bs); ossl_raise(eOCSPError, "OCSP_basic_add1_cert"); } } result = OCSP_basic_verify(bs, x509s, x509st, flg); OCSP_BASICRESP_free(bs); } else { result = OCSP_basic_verify(bs, x509s, x509st, flg); } #else result = OCSP_basic_verify(bs, x509s, x509st, flg); #endif sk_X509_pop_free(x509s, X509_free); if (result <= 0) ossl_clear_error(); return result > 0 ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"(OpenSSL::OCSP::BasicResponse#to_der;F;[;[[@îÇin;T;;°;0;[;{;IC;";Encodes this basic response into a DER-encoded string. ;T;[o;= ;3I" overload;F;40;;°;50;)I"to_der;T;IC;";T; @Õ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Õ;[;I"@return [String];T;0;6i;[; @Õ;[;I"aEncodes this basic response into a DER-encoded string. @overload to_der @return [String];T;0; @Õ;!F;"o;#;$T;%ih;&il;'@¤;(I"±static VALUE ossl_ocspbres_to_der(VALUE self) { OCSP_BASICRESP *res; VALUE str; long len; unsigned char *p; GetOCSPBasicRes(self, res); if ((len = i2d_OCSP_BASICRESP(res, NULL)) <= 0) ossl_raise(eOCSPError, NULL); str = rb_str_new(0, len); p = (unsigned char *)RSTRING_PTR(str); if (i2d_OCSP_BASICRESP(res, &p) <= 0) ossl_raise(eOCSPError, NULL); ossl_str_adjust(str, p); return str; };T;)I"static VALUE;T;*T;A@¤;BIC;[;A@¤;CIC;[;A@¤;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@îÇiB;F;:BasicResponse;;K;;;[;{;IC;";T;[;[;@|;0; @¤;6i;'@;I"!OpenSSL::OCSP::BasicResponse;F;S@]o; ;IC;[o;;F; ;;;;I"2OpenSSL::OCSP::SingleResponse#initialize_copy;F;[[I" other;T0;[[@îÇi¸;T;;g;0;[;{;IC;";T;[;[;@|;0; @;'@ÿ;(I"½static VALUE ossl_ocspsres_initialize_copy(VALUE self, VALUE other) { OCSP_SINGLERESP *sres, *sres_old, *sres_new; rb_check_frozen(self); GetOCSPSingleRes(self, sres_old); GetOCSPSingleRes(other, sres); sres_new = ASN1_item_dup(ASN1_ITEM_rptr(OCSP_SINGLERESP), sres); if (!sres_new) ossl_raise(eOCSPError, "ASN1_item_dup"); SetOCSPSingleRes(self, sres_new); OCSP_SINGLERESP_free(sres_old); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"-OpenSSL::OCSP::SingleResponse#initialize;F;[[I"arg;T0;[[@îÇi¤;T;;Ð;0;[;{;IC;"4Creates a new SingleResponse from _der_string_. ;T;[o;= ;3I" overload;F;40;:&OpenSSL::OCSP::SingleResponse.new;50;)I"2OpenSSL::OCSP::SingleResponse.new(der_string);T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"SingleResponse;T; @;[;I"@return [SingleResponse];T;0;6i;[[I"der_string;T0; @;[;I"„Creates a new SingleResponse from _der_string_. @overload OpenSSL::OCSP::SingleResponse.new(der_string) @return [SingleResponse];T;0; @;!F;"o;#;$T;%iž;&i¢;'@ÿ;(I"âstatic VALUE ossl_ocspsres_initialize(VALUE self, VALUE arg) { OCSP_SINGLERESP *res, *res_new; const unsigned char *p; arg = ossl_to_der_if_possible(arg); StringValue(arg); GetOCSPSingleRes(self, res); p = (unsigned char*)RSTRING_PTR(arg); res_new = d2i_OCSP_SINGLERESP(NULL, &p, RSTRING_LEN(arg)); if (!res_new) ossl_raise(eOCSPError, "d2i_OCSP_SINGLERESP"); SetOCSPSingleRes(self, res_new); OCSP_SINGLERESP_free(res); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"1OpenSSL::OCSP::SingleResponse#check_validity;F;[[@c0;[[@îÇiÛ;T;:check_validity;0;[;{;IC;"Checks the validity of thisUpdate and nextUpdate fields of this SingleResponse. This checks the current time is within the range thisUpdate to nextUpdate. It is possible that the OCSP request takes a few seconds or the time is not accurate. To avoid rejecting a valid response, this method allows the times to be within _nsec_ seconds of the current time. Some responders don't set the nextUpdate field. This may cause a very old response to be considered valid. The _maxsec_ parameter can be used to limit the age of responses. ;T;[o;= ;3I" overload;F;40;;·;50;)I"*check_validity(nsec = 0, maxsec = -1);T;IC;";T; @.;>0;!F;[;[;I";T;0;6i;[[I" nsec;TI"0;T[I"maxsec;TI"-1;T; @.;[;I"DChecks the validity of thisUpdate and nextUpdate fields of this SingleResponse. This checks the current time is within the range thisUpdate to nextUpdate. It is possible that the OCSP request takes a few seconds or the time is not accurate. To avoid rejecting a valid response, this method allows the times to be within _nsec_ seconds of the current time. Some responders don't set the nextUpdate field. This may cause a very old response to be considered valid. The _maxsec_ parameter can be used to limit the age of responses. @overload check_validity(nsec = 0, maxsec = -1);T;0; @.;!F;"o;#;$T;%iË;&iØ;'@ÿ;(I"Ùstatic VALUE ossl_ocspsres_check_validity(int argc, VALUE *argv, VALUE self) { OCSP_SINGLERESP *sres; ASN1_GENERALIZEDTIME *this_update, *next_update; VALUE nsec_v, maxsec_v; int nsec, maxsec, status, ret; rb_scan_args(argc, argv, "02", &nsec_v, &maxsec_v); nsec = NIL_P(nsec_v) ? 0 : NUM2INT(nsec_v); maxsec = NIL_P(maxsec_v) ? -1 : NUM2INT(maxsec_v); GetOCSPSingleRes(self, sres); status = OCSP_single_get0_status(sres, NULL, NULL, &this_update, &next_update); if (status < 0) ossl_raise(eOCSPError, "OCSP_single_get0_status"); ret = OCSP_check_validity(this_update, next_update, nsec, maxsec); if (ret) return Qtrue; else { ossl_clear_error(); return Qfalse; } };T;)I"static VALUE;T;*To;;F; ;;;;I")OpenSSL::OCSP::SingleResponse#certid;F;[;[[@îÇiü;T;;¨;0;[;{;IC;"@Returns the CertificateId for which this SingleResponse is. ;T;[o;= ;3I" overload;F;40;;¨;50;)I"certid;T;IC;";T; @K;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"CertificateId;T; @K;[;I"@return [CertificateId];T;0;6i;[; @K;[;I"mReturns the CertificateId for which this SingleResponse is. @overload certid @return [CertificateId];T;0; @K;!F;"o;#;$T;%iö;&iú;'@ÿ;(I"static VALUE ossl_ocspsres_get_certid(VALUE self) { OCSP_SINGLERESP *sres; OCSP_CERTID *id; GetOCSPSingleRes(self, sres); id = OCSP_CERTID_dup((OCSP_CERTID *)OCSP_SINGLERESP_get0_id(sres)); /* FIXME */ return ossl_ocspcertid_new(id); };T;)I"static VALUE;T;*To;;F; ;;;;I".OpenSSL::OCSP::SingleResponse#cert_status;F;[;[[@îÇi;T;:cert_status;0;[;{;IC;"/Returns the status of the certificate identified by the certid. The return value may be one of these constant: - V_CERTSTATUS_GOOD - V_CERTSTATUS_REVOKED - V_CERTSTATUS_UNKNOWN When the status is V_CERTSTATUS_REVOKED, the time at which the certificate was revoked can be retrieved by #revocation_time. ;T;[o;= ;3I" overload;F;40;;¸;50;)I"cert_status;T;IC;";T; @f;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @f;[;I"@return [Integer];T;0;6i;[; @f;[;I"[Returns the status of the certificate identified by the certid. The return value may be one of these constant: - V_CERTSTATUS_GOOD - V_CERTSTATUS_REVOKED - V_CERTSTATUS_UNKNOWN When the status is V_CERTSTATUS_REVOKED, the time at which the certificate was revoked can be retrieved by #revocation_time. @overload cert_status @return [Integer];T;0; @f;!F;"o;#;$T;%i;&i;'@ÿ;(I"1static VALUE ossl_ocspsres_get_cert_status(VALUE self) { OCSP_SINGLERESP *sres; int status; GetOCSPSingleRes(self, sres); status = OCSP_single_get0_status(sres, NULL, NULL, NULL, NULL); if (status < 0) ossl_raise(eOCSPError, "OCSP_single_get0_status"); return INT2NUM(status); };T;)I"static VALUE;T;*To;;F; ;;;;I".OpenSSL::OCSP::SingleResponse#this_update;F;[;[[@îÇi(;T;:this_update;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;¹;50;)I"this_update;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Time;T; @;[;I"@return [Time];T;0;6i;[; @;[;I", @overload this_update @return [Time];T;0; @;!F;"o;#;$T;%i$;&i&;'@ÿ;(I"vstatic VALUE ossl_ocspsres_get_this_update(VALUE self) { OCSP_SINGLERESP *sres; int status; ASN1_GENERALIZEDTIME *time; GetOCSPSingleRes(self, sres); status = OCSP_single_get0_status(sres, NULL, NULL, &time, NULL); if (status < 0) ossl_raise(eOCSPError, "OCSP_single_get0_status"); if (!time) return Qnil; return asn1time_to_time(time); };T;)I"static VALUE;T;*To;;F; ;;;;I".OpenSSL::OCSP::SingleResponse#next_update;F;[;[[@îÇi=;T;;ç;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;ç;50;)I"next_update;T;IC;";T; @œ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Time | nil;T; @œ;[;I"@return [Time | nil];T;0;6i;[; @œ;[;I"2 @overload next_update @return [Time | nil];T;0; @œ;!F;"o;#;$T;%i9;&i;;'@ÿ;(I"vstatic VALUE ossl_ocspsres_get_next_update(VALUE self) { OCSP_SINGLERESP *sres; int status; ASN1_GENERALIZEDTIME *time; GetOCSPSingleRes(self, sres); status = OCSP_single_get0_status(sres, NULL, NULL, NULL, &time); if (status < 0) ossl_raise(eOCSPError, "OCSP_single_get0_status"); if (!time) return Qnil; return asn1time_to_time(time); };T;)I"static VALUE;T;*To;;F; ;;;;I"2OpenSSL::OCSP::SingleResponse#revocation_time;F;[;[[@îÇiR;T;:revocation_time;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;º;50;)I"revocation_time;T;IC;";T; @·;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Time | nil;T; @·;[;I"@return [Time | nil];T;0;6i;[; @·;[;I"6 @overload revocation_time @return [Time | nil];T;0; @·;!F;"o;#;$T;%iN;&iP;'@ÿ;(I"Þstatic VALUE ossl_ocspsres_get_revocation_time(VALUE self) { OCSP_SINGLERESP *sres; int status; ASN1_GENERALIZEDTIME *time; GetOCSPSingleRes(self, sres); status = OCSP_single_get0_status(sres, NULL, &time, NULL, NULL); if (status < 0) ossl_raise(eOCSPError, "OCSP_single_get0_status"); if (status != V_OCSP_CERTSTATUS_REVOKED) ossl_raise(eOCSPError, "certificate is not revoked"); if (!time) return Qnil; return asn1time_to_time(time); };T;)I"static VALUE;T;*To;;F; ;;;;I"4OpenSSL::OCSP::SingleResponse#revocation_reason;F;[;[[@îÇii;T;:revocation_reason;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;»;50;)I"revocation_reason;T;IC;";T; @Ò;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer | nil;T; @Ò;[;I"@return [Integer | nil];T;0;6i;[; @Ò;[;I"; @overload revocation_reason @return [Integer | nil];T;0; @Ò;!F;"o;#;$T;%ie;&ig;'@ÿ;(I"¦static VALUE ossl_ocspsres_get_revocation_reason(VALUE self) { OCSP_SINGLERESP *sres; int status, reason; GetOCSPSingleRes(self, sres); status = OCSP_single_get0_status(sres, &reason, NULL, NULL, NULL); if (status < 0) ossl_raise(eOCSPError, "OCSP_single_get0_status"); if (status != V_OCSP_CERTSTATUS_REVOKED) ossl_raise(eOCSPError, "certificate is not revoked"); return INT2NUM(reason); };T;)I"static VALUE;T;*To;;F; ;;;;I"-OpenSSL::OCSP::SingleResponse#extensions;F;[;[[@îÇi};T;;Ç;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;Ç;50;)I"extensions;T;IC;";T; @í;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Array of X509::Extension;T; @í;[;I"'@return [Array of X509::Extension];T;0;6i;[; @í;[;I"? @overload extensions @return [Array of X509::Extension];T;0; @í;!F;"o;#;$T;%iy;&i{;'@ÿ;(I"œstatic VALUE ossl_ocspsres_get_extensions(VALUE self) { OCSP_SINGLERESP *sres; X509_EXTENSION *ext; int count, i; VALUE ary; GetOCSPSingleRes(self, sres); count = OCSP_SINGLERESP_get_ext_count(sres); ary = rb_ary_new2(count); for (i = 0; i < count; i++) { ext = OCSP_SINGLERESP_get_ext(sres, i); rb_ary_push(ary, ossl_x509ext_new(ext)); /* will dup */ } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I")OpenSSL::OCSP::SingleResponse#to_der;F;[;[[@îÇi—;T;;°;0;[;{;IC;";Encodes this SingleResponse into a DER-encoded string. ;T;[o;= ;3I" overload;F;40;;°;50;)I"to_der;T;IC;";T; @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @;[;I"@return [String];T;0;6i;[; @;[;I"aEncodes this SingleResponse into a DER-encoded string. @overload to_der @return [String];T;0; @;!F;"o;#;$T;%i‘;&i•;'@ÿ;(I"¹static VALUE ossl_ocspsres_to_der(VALUE self) { OCSP_SINGLERESP *sres; VALUE str; long len; unsigned char *p; GetOCSPSingleRes(self, sres); if ((len = i2d_OCSP_SINGLERESP(sres, NULL)) <= 0) ossl_raise(eOCSPError, NULL); str = rb_str_new(0, len); p = (unsigned char *)RSTRING_PTR(str); if (i2d_OCSP_SINGLERESP(sres, &p) <= 0) ossl_raise(eOCSPError, NULL); ossl_str_adjust(str, p); return str; };T;)I"static VALUE;T;*T;A@ÿ;BIC;[;A@ÿ;CIC;[;A@ÿ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@îÇiU;F;:SingleResponse;;K;;;[;{;IC;";T;[;[;@|;0; @ÿ;6i;'@;I""OpenSSL::OCSP::SingleResponse;F;S@]o; ;IC;[o;;F; ;;;;I"1OpenSSL::OCSP::CertificateId#initialize_copy;F;[[I" other;T0;[[@îÇi½;T;;g;0;[;{;IC;";T;[;[;@|;0; @4;'@2;(I"„static VALUE ossl_ocspcid_initialize_copy(VALUE self, VALUE other) { OCSP_CERTID *cid, *cid_old, *cid_new; rb_check_frozen(self); GetOCSPCertId(self, cid_old); GetOCSPCertId(other, cid); cid_new = OCSP_CERTID_dup(cid); if (!cid_new) ossl_raise(eOCSPError, "OCSP_CERTID_dup"); SetOCSPCertId(self, cid_new); OCSP_CERTID_free(cid_old); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I",OpenSSL::OCSP::CertificateId#initialize;F;[[@c0;[[@îÇiÞ;T;;Ð;0;[;{;IC;"lCreates a new OpenSSL::OCSP::CertificateId for the given _subject_ and _issuer_ X509 certificates. The _digest_ is a digest algorithm that is used to compute the hash values. This defaults to SHA-1. If only one argument is given, decodes it as DER representation of a certificate ID or generates certificate ID from the object that responds to the to_der method. ;T;[o;= ;3I" overload;F;40;:%OpenSSL::OCSP::CertificateId.new;50;)I"DOpenSSL::OCSP::CertificateId.new(subject, issuer, digest = nil);T;IC;";T; @B;>0;!F;[;[;I";T;0;6i;[[I"subject;T0[I"issuer;T0[I"digest;TI"nil;T; @Bo;= ;3I" overload;F;40;;½;50;)I"1OpenSSL::OCSP::CertificateId.new(der_string);T;IC;";T; @B;>0;!F;[;[;I";T;0;6i;[[I"der_string;T0; @Bo;= ;3I" overload;F;40;;½;50;)I"*OpenSSL::OCSP::CertificateId.new(obj);T;IC;";T; @B;>0;!F;[;[;I";T;0;6i;[[I"obj;T0; @B;[;I"Creates a new OpenSSL::OCSP::CertificateId for the given _subject_ and _issuer_ X509 certificates. The _digest_ is a digest algorithm that is used to compute the hash values. This defaults to SHA-1. If only one argument is given, decodes it as DER representation of a certificate ID or generates certificate ID from the object that responds to the to_der method. @overload OpenSSL::OCSP::CertificateId.new(subject, issuer, digest = nil) @overload OpenSSL::OCSP::CertificateId.new(der_string) @overload OpenSSL::OCSP::CertificateId.new(obj);T;0; @B;!F;"o;#;$T;%iÐ;&iÛ;'@2;(I"—static VALUE ossl_ocspcid_initialize(int argc, VALUE *argv, VALUE self) { OCSP_CERTID *id, *newid; VALUE subject, issuer, digest; GetOCSPCertId(self, id); if (rb_scan_args(argc, argv, "12", &subject, &issuer, &digest) == 1) { VALUE arg; const unsigned char *p; arg = ossl_to_der_if_possible(subject); StringValue(arg); p = (unsigned char *)RSTRING_PTR(arg); newid = d2i_OCSP_CERTID(NULL, &p, RSTRING_LEN(arg)); if (!newid) ossl_raise(eOCSPError, "d2i_OCSP_CERTID"); } else { X509 *x509s, *x509i; const EVP_MD *md; x509s = GetX509CertPtr(subject); /* NO NEED TO DUP */ x509i = GetX509CertPtr(issuer); /* NO NEED TO DUP */ md = !NIL_P(digest) ? ossl_evp_get_digestbyname(digest) : NULL; newid = OCSP_cert_to_id(md, x509s, x509i); if (!newid) ossl_raise(eOCSPError, "OCSP_cert_to_id"); } SetOCSPCertId(self, newid); OCSP_CERTID_free(id); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"%OpenSSL::OCSP::CertificateId#cmp;F;[[I" other;T0;[[@îÇi ;T;;Ú;0;[;{;IC;"WCompares this certificate id with _other_ and returns +true+ if they are the same. ;T;[o;= ;3I" overload;F;40;;Ú;50;)I"cmp(other);T;IC;";T; @t;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @t;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @t;[;I"}Compares this certificate id with _other_ and returns +true+ if they are the same. @overload cmp(other) @return [Boolean];T;0; @t;!F;"o;#;$T;%i;&i;'@2;(I"ñstatic VALUE ossl_ocspcid_cmp(VALUE self, VALUE other) { OCSP_CERTID *id, *id2; int result; GetOCSPCertId(self, id); GetOCSPCertId(other, id2); result = OCSP_id_cmp(id, id2); return (result == 0) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I",OpenSSL::OCSP::CertificateId#cmp_issuer;F;[[I" other;T0;[[@îÇi;T;:cmp_issuer;0;[;{;IC;"`Compares this certificate id's issuer with _other_ and returns +true+ if they are the same. ;T;[o;= ;3I" overload;F;40;;¾;50;)I"cmp_issuer(other);T;IC;";T; @“;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @“;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @“;[;I"Compares this certificate id's issuer with _other_ and returns +true+ if they are the same. @overload cmp_issuer(other) @return [Boolean];T;0; @“;!F;"o;#;$T;%i;&i;'@2;(I"ÿstatic VALUE ossl_ocspcid_cmp_issuer(VALUE self, VALUE other) { OCSP_CERTID *id, *id2; int result; GetOCSPCertId(self, id); GetOCSPCertId(other, id2); result = OCSP_id_issuer_cmp(id, id2); return (result == 0) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"(OpenSSL::OCSP::CertificateId#serial;F;[;[[@îÇi3;T;;¸;0;[;{;IC;"VReturns the serial number of the certificate for which status is being requested. ;T;[o;= ;3I" overload;F;40;;¸;50;)I"serial;T;IC;";T; @²;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @²;[;I"@return [Integer];T;0;6i;[; @²;[;I"}Returns the serial number of the certificate for which status is being requested. @overload serial @return [Integer];T;0; @²;!F;"o;#;$T;%i,;&i1;'@2;(I"ßstatic VALUE ossl_ocspcid_get_serial(VALUE self) { OCSP_CERTID *id; ASN1_INTEGER *serial; GetOCSPCertId(self, id); OCSP_id_get0_info(NULL, NULL, NULL, &serial, id); return asn1integer_to_num(serial); };T;)I"static VALUE;T;*To;;F; ;;;;I"2OpenSSL::OCSP::CertificateId#issuer_name_hash;F;[;[[@îÇiF;T;:issuer_name_hash;0;[;{;IC;"Returns the issuerNameHash of this certificate ID, the hash of the issuer's distinguished name calculated with the hashAlgorithm. ;T;[o;= ;3I" overload;F;40;;¿;50;)I"issuer_name_hash;T;IC;";T; @Í;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Í;[;I"@return [String];T;0;6i;[; @Í;[;I"±Returns the issuerNameHash of this certificate ID, the hash of the issuer's distinguished name calculated with the hashAlgorithm. @overload issuer_name_hash @return [String];T;0; @Í;!F;"o;#;$T;%i?;&iD;'@2;(I"hstatic VALUE ossl_ocspcid_get_issuer_name_hash(VALUE self) { OCSP_CERTID *id; ASN1_OCTET_STRING *name_hash; VALUE ret; GetOCSPCertId(self, id); OCSP_id_get0_info(&name_hash, NULL, NULL, NULL, id); ret = rb_str_new(NULL, name_hash->length * 2); ossl_bin2hex(name_hash->data, RSTRING_PTR(ret), name_hash->length); return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"1OpenSSL::OCSP::CertificateId#issuer_key_hash;F;[;[[@îÇi];T;:issuer_key_hash;0;[;{;IC;"[Returns the issuerKeyHash of this certificate ID, the hash of the issuer's public key. ;T;[o;= ;3I" overload;F;40;;À;50;)I"issuer_key_hash;T;IC;";T; @è;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @è;[;I"@return [String];T;0;6i;[; @è;[;I"…Returns the issuerKeyHash of this certificate ID, the hash of the issuer's public key. @overload issuer_key_hash @return [String];T;0; @è;!F;"o;#;$T;%iV;&i[;'@2;(I"bstatic VALUE ossl_ocspcid_get_issuer_key_hash(VALUE self) { OCSP_CERTID *id; ASN1_OCTET_STRING *key_hash; VALUE ret; GetOCSPCertId(self, id); OCSP_id_get0_info(NULL, NULL, &key_hash, NULL, id); ret = rb_str_new(NULL, key_hash->length * 2); ossl_bin2hex(key_hash->data, RSTRING_PTR(ret), key_hash->length); return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"0OpenSSL::OCSP::CertificateId#hash_algorithm;F;[;[[@îÇit;T;:hash_algorithm;0;[;{;IC;"wReturns the ln (long name) of the hash algorithm used to generate the issuerNameHash and the issuerKeyHash values. ;T;[o;= ;3I" overload;F;40;;Á;50;)I"hash_algorithm;T;IC;";T; @ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ ;[;I"@return [String];T;0;6i;[; @ ;[;I" Returns the ln (long name) of the hash algorithm used to generate the issuerNameHash and the issuerKeyHash values. @overload hash_algorithm @return [String];T;0; @ ;!F;"o;#;$T;%im;&ir;'@2;(I"œstatic VALUE ossl_ocspcid_get_hash_algorithm(VALUE self) { OCSP_CERTID *id; ASN1_OBJECT *oid; BIO *out; GetOCSPCertId(self, id); OCSP_id_get0_info(NULL, &oid, NULL, NULL, id); if (!(out = BIO_new(BIO_s_mem()))) ossl_raise(eOCSPError, "BIO_new"); if (!i2a_ASN1_OBJECT(out, oid)) { BIO_free(out); ossl_raise(eOCSPError, "i2a_ASN1_OBJECT"); } return ossl_membio2str(out); };T;)I"static VALUE;T;*To;;F; ;;;;I"(OpenSSL::OCSP::CertificateId#to_der;F;[;[[@îÇiŽ;T;;°;0;[;{;IC;"CEncodes this certificate identifier into a DER-encoded string. ;T;[o;= ;3I" overload;F;40;;°;50;)I"to_der;T;IC;";T; @ ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ ;[;I"@return [String];T;0;6i;[; @ ;[;I"iEncodes this certificate identifier into a DER-encoded string. @overload to_der @return [String];T;0; @ ;!F;"o;#;$T;%iˆ;&iŒ;'@2;(I"¡static VALUE ossl_ocspcid_to_der(VALUE self) { OCSP_CERTID *id; VALUE str; long len; unsigned char *p; GetOCSPCertId(self, id); if ((len = i2d_OCSP_CERTID(id, NULL)) <= 0) ossl_raise(eOCSPError, NULL); str = rb_str_new(0, len); p = (unsigned char *)RSTRING_PTR(str); if (i2d_OCSP_CERTID(id, &p) <= 0) ossl_raise(eOCSPError, NULL); ossl_str_adjust(str, p); return str; };T;)I"static VALUE;T;*T;A@2;BIC;[;A@2;CIC;[;A@2;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@îÇih;F;:CertificateId;;K;;;[;{;IC;";T;[;[;@|;0; @2;6i;'@;I"!OpenSSL::OCSP::CertificateId;F;S@]o;{;[[@îÇiu;F;:"RESPONSE_STATUS_INTERNALERROR;;};;;[;{;IC;"Internal error in issuer ;T;[;[;I"Internal error in issuer;T;0; @H ;!F;"o;#;$T;%it;⁢'@;I"1OpenSSL::OCSP::RESPONSE_STATUS_INTERNALERROR;F;~I"0INT2NUM(OCSP_RESPONSE_STATUS_INTERNALERROR);To;{;[[@îÇix;F;:%RESPONSE_STATUS_MALFORMEDREQUEST;;};;;[;{;IC;"!Illegal confirmation request ;T;[;[;I"!Illegal confirmation request;T;0; @T ;!F;"o;#;$T;%iw;&iw;'@;I"4OpenSSL::OCSP::RESPONSE_STATUS_MALFORMEDREQUEST;F;~I"3INT2NUM(OCSP_RESPONSE_STATUS_MALFORMEDREQUEST);To;{;[[@îÇi{;F;:REVOKED_STATUS_NOSTATUS;;};;;[;{;IC;"6The certificate was revoked for an unknown reason ;T;[;[;I"6The certificate was revoked for an unknown reason;T;0; @` ;!F;"o;#;$T;%iz;&iz;'@;I"+OpenSSL::OCSP::REVOKED_STATUS_NOSTATUS;F;~I"*INT2NUM(OCSP_REVOKED_STATUS_NOSTATUS);To;{;[[@îÇi~;F;: RESPONSE_STATUS_SIGREQUIRED;;};;;[;{;IC;"+You must sign the request and resubmit ;T;[;[;I"+You must sign the request and resubmit;T;0; @l ;!F;"o;#;$T;%i};&i};'@;I"/OpenSSL::OCSP::RESPONSE_STATUS_SIGREQUIRED;F;~I".INT2NUM(OCSP_RESPONSE_STATUS_SIGREQUIRED);To;{;[[@îÇi;F;:RESPONSE_STATUS_SUCCESSFUL;;};;;[;{;IC;"%Response has valid confirmations ;T;[;[;I"%Response has valid confirmations;T;0; @x ;!F;"o;#;$T;%i€;&i€;'@;I".OpenSSL::OCSP::RESPONSE_STATUS_SUCCESSFUL;F;~I"-INT2NUM(OCSP_RESPONSE_STATUS_SUCCESSFUL);To;{;[[@îÇi„;F;:RESPONSE_STATUS_TRYLATER;;};;;[;{;IC;"Try again later ;T;[;[;I"Try again later;T;0; @„ ;!F;"o;#;$T;%iƒ;&iƒ;'@;I",OpenSSL::OCSP::RESPONSE_STATUS_TRYLATER;F;~I"+INT2NUM(OCSP_RESPONSE_STATUS_TRYLATER);To;{;[[@îÇi‡;F;:&REVOKED_STATUS_AFFILIATIONCHANGED;;};;;[;{;IC;"@The certificate subject's name or other information changed ;T;[;[;I"@The certificate subject's name or other information changed;T;0; @ ;!F;"o;#;$T;%i†;&i†;'@;I"5OpenSSL::OCSP::REVOKED_STATUS_AFFILIATIONCHANGED;F;~I"4INT2NUM(OCSP_REVOKED_STATUS_AFFILIATIONCHANGED);To;{;[[@îÇiŠ;F;: REVOKED_STATUS_CACOMPROMISE;;};;;[;{;IC;"0;!F;[;[;I";T;0;6i;[[I"string;T0; @ê!;[;I"" @overload read_smime(string);T;0; @ê!;!F;"o;#;$T;%i;&i®;'@×!;(I"Óstatic VALUE ossl_pkcs7_s_read_smime(VALUE klass, VALUE arg) { BIO *in, *out; PKCS7 *pkcs7; VALUE ret, data; ret = NewPKCS7(cPKCS7); in = ossl_obj2bio(&arg); out = NULL; pkcs7 = SMIME_read_PKCS7(in, &out); BIO_free(in); if(!pkcs7) ossl_raise(ePKCS7Error, NULL); data = out ? ossl_membio2str(out) : Qnil; SetPKCS7(ret, pkcs7); ossl_pkcs7_set_data(ret, data); ossl_pkcs7_set_err_string(ret, Qnil); return ret; };T;)I"static VALUE;T;*To;;F; ;F;;;I"OpenSSL::PKCS7.write_smime;F;[[@c0;[[@ðÇiÊ;T;:write_smime;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;æ;50;)I"*write_smime(pkcs7 [, data [, flags]]);T;IC;";T; @";>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @";[;I"@return [String];T;0;6i;[[I"pkcs7[, data [, flags]];T0; @";[;I"H @overload write_smime(pkcs7 [, data [, flags]]) @return [String];T;0; @";!F;"o;#;$T;%iÆ;&iÈ;'@×!;(I"static VALUE ossl_pkcs7_s_write_smime(int argc, VALUE *argv, VALUE klass) { VALUE pkcs7, data, flags; BIO *out, *in; PKCS7 *p7; VALUE str; int flg; rb_scan_args(argc, argv, "12", &pkcs7, &data, &flags); flg = NIL_P(flags) ? 0 : NUM2INT(flags); if(NIL_P(data)) data = ossl_pkcs7_get_data(pkcs7); GetPKCS7(pkcs7, p7); if(!NIL_P(data) && PKCS7_is_detached(p7)) flg |= PKCS7_DETACHED; in = NIL_P(data) ? NULL : ossl_obj2bio(&data); if(!(out = BIO_new(BIO_s_mem()))){ BIO_free(in); ossl_raise(ePKCS7Error, NULL); } if(!SMIME_write_PKCS7(out, p7, in, flg)){ BIO_free(out); BIO_free(in); ossl_raise(ePKCS7Error, NULL); } BIO_free(in); str = ossl_membio2str(out); return str; };T;)I"static VALUE;T;*To;;F; ;F;;;I"OpenSSL::PKCS7.sign;F;[[@c0;[[@ðÇií;T;;Ä;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;Ä;50;)I"/sign(cert, key, data, [, certs [, flags]]);T;IC;";T; @"";>0;!F;[;[;I";T;0;6i;[ [I" cert;T0[I"key;T0[I" data;T0[I"[, certs [, flags]];T0; @"";[;I": @overload sign(cert, key, data, [, certs [, flags]]);T;0; @"";!F;"o;#;$T;%ié;&iê;'@×!;(I"ûstatic VALUE ossl_pkcs7_s_sign(int argc, VALUE *argv, VALUE klass) { VALUE cert, key, data, certs, flags; X509 *x509; EVP_PKEY *pkey; BIO *in; STACK_OF(X509) *x509s; int flg, status = 0; PKCS7 *pkcs7; VALUE ret; rb_scan_args(argc, argv, "32", &cert, &key, &data, &certs, &flags); x509 = GetX509CertPtr(cert); /* NO NEED TO DUP */ pkey = GetPrivPKeyPtr(key); /* NO NEED TO DUP */ flg = NIL_P(flags) ? 0 : NUM2INT(flags); ret = NewPKCS7(cPKCS7); in = ossl_obj2bio(&data); if(NIL_P(certs)) x509s = NULL; else{ x509s = ossl_protect_x509_ary2sk(certs, &status); if(status){ BIO_free(in); rb_jump_tag(status); } } if(!(pkcs7 = PKCS7_sign(x509, pkey, x509s, in, flg))){ BIO_free(in); sk_X509_pop_free(x509s, X509_free); ossl_raise(ePKCS7Error, NULL); } SetPKCS7(ret, pkcs7); ossl_pkcs7_set_data(ret, data); ossl_pkcs7_set_err_string(ret, Qnil); BIO_free(in); sk_X509_pop_free(x509s, X509_free); return ret; };T;)I"static VALUE;T;*To;;F; ;F;;;I"OpenSSL::PKCS7.encrypt;F;[[@c0;[[@ðÇi;T;;|;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;|;50;)I"/encrypt(certs, data, [, cipher [, flags]]);T;IC;";T; @A";>0;!F;[;[;I";T;0;6i;[[I" certs;T0[I" data;T0[I"[, cipher [, flags]];T0; @A";[;I": @overload encrypt(certs, data, [, cipher [, flags]]);T;0; @A";!F;"o;#;$T;%i;&i;'@×!;(I"¡static VALUE ossl_pkcs7_s_encrypt(int argc, VALUE *argv, VALUE klass) { VALUE certs, data, cipher, flags; STACK_OF(X509) *x509s; BIO *in; const EVP_CIPHER *ciph; int flg, status = 0; VALUE ret; PKCS7 *p7; rb_scan_args(argc, argv, "22", &certs, &data, &cipher, &flags); if(NIL_P(cipher)){ #if !defined(OPENSSL_NO_RC2) ciph = EVP_rc2_40_cbc(); #elif !defined(OPENSSL_NO_DES) ciph = EVP_des_ede3_cbc(); #elif !defined(OPENSSL_NO_RC2) ciph = EVP_rc2_40_cbc(); #elif !defined(OPENSSL_NO_AES) ciph = EVP_EVP_aes_128_cbc(); #else ossl_raise(ePKCS7Error, "Must specify cipher"); #endif } else ciph = ossl_evp_get_cipherbyname(cipher); flg = NIL_P(flags) ? 0 : NUM2INT(flags); ret = NewPKCS7(cPKCS7); in = ossl_obj2bio(&data); x509s = ossl_protect_x509_ary2sk(certs, &status); if(status){ BIO_free(in); rb_jump_tag(status); } if(!(p7 = PKCS7_encrypt(x509s, in, (EVP_CIPHER*)ciph, flg))){ BIO_free(in); sk_X509_pop_free(x509s, X509_free); ossl_raise(ePKCS7Error, NULL); } BIO_free(in); SetPKCS7(ret, p7); ossl_pkcs7_set_data(ret, data); sk_X509_pop_free(x509s, X509_free); return ret; };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::PKCS7#initialize_copy;F;[[I" other;T0;[[@ðÇi};T;;g;0;[;{;IC;";T;[;[;@|;0; @^";'@×!;(I"Wstatic VALUE ossl_pkcs7_copy(VALUE self, VALUE other) { PKCS7 *a, *b, *pkcs7; rb_check_frozen(self); if (self == other) return self; GetPKCS7(self, a); GetPKCS7(other, b); pkcs7 = PKCS7_dup(b); if (!pkcs7) { ossl_raise(ePKCS7Error, NULL); } DATA_PTR(self) = pkcs7; PKCS7_free(a); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKCS7#initialize;F;[[@c0;[[@ðÇi_;T;;Ð;0;[;{;IC;"2Many methods in this class aren't documented. ;T;[o;= ;3I" overload;F;40;;î;50;)I"new;T;IC;";T; @l";>0;!F;[;[;I";T;0;6i;[; @l"o;= ;3I" overload;F;40;;î;50;)I"new(string);T;IC;";T; @l";>0;!F;[;[;I";T;0;6i;[[I"string;T0; @l";[;I"XMany methods in this class aren't documented. @overload new @overload new(string);T;0; @l";!F;"o;#;$T;%iX;&i\;'@×!;(I"·static VALUE ossl_pkcs7_initialize(int argc, VALUE *argv, VALUE self) { PKCS7 *p7, *pkcs = DATA_PTR(self); BIO *in; VALUE arg; if(rb_scan_args(argc, argv, "01", &arg) == 0) return self; arg = ossl_to_der_if_possible(arg); in = ossl_obj2bio(&arg); p7 = PEM_read_bio_PKCS7(in, &pkcs, NULL, NULL); if (!p7) { OSSL_BIO_reset(in); p7 = d2i_PKCS7_bio(in, &pkcs); if (!p7) { BIO_free(in); PKCS7_free(pkcs); DATA_PTR(self) = NULL; ossl_raise(rb_eArgError, "Could not parse the PKCS7"); } } DATA_PTR(self) = pkcs; BIO_free(in); ossl_pkcs7_set_data(self, Qnil); ossl_pkcs7_set_err_string(self, Qnil); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKCS7#type=;F;[[I" type;T0;[[@ðÇiº;T;: type=;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;ç;50;)I"type=(type);T;IC;";T; @";>0;!F;[;[;I";T;0;6i;[[I" type;T0; @";[;I" @overload type=(type);T;0; @";!F;"o;#;$T;%i¶;&i·;'@×!;(I"Ïstatic VALUE ossl_pkcs7_set_type(VALUE self, VALUE type) { PKCS7 *p7; GetPKCS7(self, p7); if(!PKCS7_set_type(p7, ossl_pkcs7_sym2typeid(type))) ossl_raise(ePKCS7Error, NULL); return type; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKCS7#type;F;[;[[@ðÇiÊ;T;;;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I" type;T;IC;";T; @§";>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @§";[;I"@return [String, nil];T;0;6i;[; @§";[;I", @overload type @return [String, nil];T;0; @§";!F;"o;#;$T;%iÆ;&iÈ;'@×!;(I"çstatic VALUE ossl_pkcs7_get_type(VALUE self) { PKCS7 *p7; GetPKCS7(self, p7); if(PKCS7_type_is_signed(p7)) return ID2SYM(rb_intern("signed")); if(PKCS7_type_is_encrypted(p7)) return ID2SYM(rb_intern("encrypted")); if(PKCS7_type_is_enveloped(p7)) return ID2SYM(rb_intern("enveloped")); if(PKCS7_type_is_signedAndEnveloped(p7)) return ID2SYM(rb_intern("signedAndEnveloped")); if(PKCS7_type_is_data(p7)) return ID2SYM(rb_intern("data")); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKCS7#detached=;F;[[I" flag;T0;[[@ðÇiÝ;T;:detached=;0;[;{;IC;";T;[;[;@|;0; @Ã";'@×!;(I"-static VALUE ossl_pkcs7_set_detached(VALUE self, VALUE flag) { PKCS7 *p7; GetPKCS7(self, p7); if(flag != Qtrue && flag != Qfalse) ossl_raise(ePKCS7Error, "must specify a boolean"); if(!PKCS7_set_detached(p7, flag == Qtrue ? 1 : 0)) ossl_raise(ePKCS7Error, NULL); return flag; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKCS7#detached;F;[;[[@ðÇië;T;: detached;0;[;{;IC;";T;[;[;@|;0; @Ñ";'@×!;(I"static VALUE ossl_pkcs7_get_detached(VALUE self) { PKCS7 *p7; GetPKCS7(self, p7); return PKCS7_get_detached(p7) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKCS7#detached?;F;[;[[@ðÇió;T;:detached?;0;[;{;IC;";T;[o;2 ;3I"return;F;4@|;0;5[@~; @Ý";[;@|;0; @Ý";6i;'@×!;(I"Œstatic VALUE ossl_pkcs7_detached_p(VALUE self) { PKCS7 *p7; GetPKCS7(self, p7); return PKCS7_is_detached(p7) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKCS7#cipher=;F;[[I"cipher;T0;[[@ðÇiû;T;:cipher=;0;[;{;IC;";T;[;[;@|;0; @ì";'@×!;(I"ïstatic VALUE ossl_pkcs7_set_cipher(VALUE self, VALUE cipher) { PKCS7 *pkcs7; GetPKCS7(self, pkcs7); if (!PKCS7_set_cipher(pkcs7, ossl_evp_get_cipherbyname(cipher))) { ossl_raise(ePKCS7Error, NULL); } return cipher; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKCS7#add_signer;F;[[I"signer;T0;[[@ðÇi;T;:add_signer;0;[;{;IC;";T;[;[;@|;0; @ú";'@×!;(I"ðstatic VALUE ossl_pkcs7_add_signer(VALUE self, VALUE signer) { PKCS7 *pkcs7; PKCS7_SIGNER_INFO *p7si; p7si = DupPKCS7SignerPtr(signer); /* NEED TO DUP */ GetPKCS7(self, pkcs7); if (!PKCS7_add_signer(pkcs7, p7si)) { PKCS7_SIGNER_INFO_free(p7si); ossl_raise(ePKCS7Error, "Could not add signer."); } if (PKCS7_type_is_signed(pkcs7)){ PKCS7_add_signed_attribute(p7si, NID_pkcs9_contentType, V_ASN1_OBJECT, OBJ_nid2obj(NID_pkcs7_data)); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKCS7#signers;F;[;[[@ðÇi;T;:signers;0;[;{;IC;";T;[;[;@|;0; @#;'@×!;(I"Wstatic VALUE ossl_pkcs7_get_signer(VALUE self) { PKCS7 *pkcs7; STACK_OF(PKCS7_SIGNER_INFO) *sk; PKCS7_SIGNER_INFO *si; int num, i; VALUE ary; GetPKCS7(self, pkcs7); if (!(sk = PKCS7_get_signer_info(pkcs7))) { OSSL_Debug("OpenSSL::PKCS7#get_signer_info == NULL!"); return rb_ary_new(); } if ((num = sk_PKCS7_SIGNER_INFO_num(sk)) < 0) { ossl_raise(ePKCS7Error, "Negative number of signers!"); } ary = rb_ary_new2(num); for (i=0; id.enveloped->recipientinfo; else if (PKCS7_type_is_signedAndEnveloped(pkcs7)) sk = pkcs7->d.signed_and_enveloped->recipientinfo; else sk = NULL; if (!sk) return rb_ary_new(); if ((num = sk_PKCS7_RECIP_INFO_num(sk)) < 0) { ossl_raise(ePKCS7Error, "Negative number of recipient!"); } ary = rb_ary_new2(num); for (i=0; iissuer_and_serial->issuer); };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::PKCS7::SignerInfo#serial;F;[;[[@ðÇi ;T;;¸;0;[;{;IC;";T;[;[;@|;0; @î#;'@Î#;(I"¯static VALUE ossl_pkcs7si_get_serial(VALUE self) { PKCS7_SIGNER_INFO *p7si; GetPKCS7si(self, p7si); return asn1integer_to_num(p7si->issuer_and_serial->serial); };T;)I"static VALUE;T;*To;;F; ;;;;I"+OpenSSL::PKCS7::SignerInfo#signed_time;F;[;[[@ðÇiª;T;:signed_time;0;[;{;IC;";T;[;[;@|;0; @ú#;'@Î#;(I"Àstatic VALUE ossl_pkcs7si_get_signed_time(VALUE self) { PKCS7_SIGNER_INFO *p7si; ASN1_TYPE *asn1obj; GetPKCS7si(self, p7si); if (!(asn1obj = PKCS7_get_signed_attribute(p7si, NID_pkcs9_signingTime))) { ossl_raise(ePKCS7Error, NULL); } if (asn1obj->type == V_ASN1_UTCTIME) { return asn1time_to_time(asn1obj->value.utctime); } /* * OR * ossl_raise(ePKCS7Error, "..."); * ? */ return Qnil; };T;)I"static VALUE;T;*T;A@Î#;BIC;[;A@Î#;CIC;[;A@Î#;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ðÇi/;F;:SignerInfo;;K;;;[;{;IC;";T;[;[;@|;0; @Î#;'@×!;I"OpenSSL::PKCS7::SignerInfo;F;S@]o;{;[[@ðÇi0;F;:Signer;;};;;[;{;IC;";T;[;[;@|;0; @$;'@×!;I"OpenSSL::PKCS7::Signer;F;~I"cPKCS7Signer;To; ;IC;[ o;;F; ;;;;I"-OpenSSL::PKCS7::RecipientInfo#initialize;F;[[I" cert;T0;[[@ðÇiÓ;T;;Ð;0;[;{;IC;";T;[;[;@|;0; @!$;'@$;(I"$static VALUE ossl_pkcs7ri_initialize(VALUE self, VALUE cert) { PKCS7_RECIP_INFO *p7ri; X509 *x509; x509 = GetX509CertPtr(cert); /* NO NEED TO DUP */ GetPKCS7ri(self, p7ri); if (!PKCS7_RECIP_INFO_set(p7ri, x509)) { ossl_raise(ePKCS7Error, NULL); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I")OpenSSL::PKCS7::RecipientInfo#issuer;F;[;[[@ðÇiâ;T;;¼;0;[;{;IC;";T;[;[;@|;0; @/$;'@$;(I"static VALUE ossl_pkcs7ri_get_issuer(VALUE self) { PKCS7_RECIP_INFO *p7ri; GetPKCS7ri(self, p7ri); return ossl_x509name_new(p7ri->issuer_and_serial->issuer); };T;)I"static VALUE;T;*To;;F; ;;;;I")OpenSSL::PKCS7::RecipientInfo#serial;F;[;[[@ðÇiì;T;;¸;0;[;{;IC;";T;[;[;@|;0; @;$;'@$;(I"®static VALUE ossl_pkcs7ri_get_serial(VALUE self) { PKCS7_RECIP_INFO *p7ri; GetPKCS7ri(self, p7ri); return asn1integer_to_num(p7ri->issuer_and_serial->serial); };T;)I"static VALUE;T;*To;;F; ;;;;I"*OpenSSL::PKCS7::RecipientInfo#enc_key;F;[;[[@ðÇiö;T;:enc_key;0;[;{;IC;";T;[;[;@|;0; @G$;'@$;(I"™static VALUE ossl_pkcs7ri_get_enc_key(VALUE self) { PKCS7_RECIP_INFO *p7ri; GetPKCS7ri(self, p7ri); return asn1str_to_str(p7ri->enc_key); };T;)I"static VALUE;T;*T;A@$;BIC;[;A@$;CIC;[;A@$;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ðÇi7;F;:RecipientInfo;;K;;;[;{;IC;";T;[;[;@|;0; @$;'@×!;I""OpenSSL::PKCS7::RecipientInfo;F;S@];A@×!;BIC;[;A@×!;CIC;[;A@×!;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@Š#;ô@¸#;³;I[;[[@ðÇi;F;: PKCS7;;K;;;[;{;IC;";T;[;[;@|;0; @×!;6i;'@ÃÇ;I"OpenSSL::PKCS7;F;S@]o; ;IC;[;A@q$;BIC;[;A@q$;CIC;[;A@q$;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[I"ext/openssl/ossl_ts.c;Tiÿ;T;:Timestamp;;K;;;[;{;IC;"ÝProvides classes and methods to request, create and validate {RFC3161-compliant}[http://www.ietf.org/rfc/rfc3161.txt] timestamps. Request may be used to either create requests from scratch or to parse existing requests that again can be used to request timestamps from a timestamp server, e.g. via the net/http. The resulting timestamp response may be parsed using Response. Please note that Response is read-only and immutable. To create a Response, an instance of Factory as well as a valid Request are needed. ===Create a Response: #Assumes ts.p12 is a PKCS#12-compatible file with a private key #and a certificate that has an extended key usage of 'timeStamping' p12 = OpenSSL::PKCS12.new(File.open('ts.p12', 'rb'), 'pwd') md = OpenSSL::Digest.new('SHA1') hash = md.digest(data) #some binary data to be timestamped req = OpenSSL::Timestamp::Request.new req.algorithm = 'SHA1' req.message_imprint = hash req.policy_id = "1.2.3.4.5" req.nonce = 42 fac = OpenSSL::Timestamp::Factory.new fac.gen_time = Time.now fac.serial_number = 1 timestamp = fac.create_timestamp(p12.key, p12.certificate, req) ===Verify a timestamp response: #Assume we have a timestamp token in a file called ts.der ts = OpenSSL::Timestamp::Response.new(File.open('ts.der', 'rb') #Assume we have the Request for this token in a file called req.der req = OpenSSL::Timestamp::Request.new(File.open('req.der', 'rb') # Assume the associated root CA certificate is contained in a # DER-encoded file named root.cer root = OpenSSL::X509::Certificate.new(File.open('root.cer', 'rb') # get the necessary intermediate certificates, available in # DER-encoded form in inter1.cer and inter2.cer inter1 = OpenSSL::X509::Certificate.new(File.open('inter1.cer', 'rb') inter2 = OpenSSL::X509::Certificate.new(File.open('inter2.cer', 'rb') ts.verify(req, root, inter1, inter2) -> ts or raises an exception if validation fails ;T;[;[;I"ßProvides classes and methods to request, create and validate {RFC3161-compliant}[http://www.ietf.org/rfc/rfc3161.txt] timestamps. Request may be used to either create requests from scratch or to parse existing requests that again can be used to request timestamps from a timestamp server, e.g. via the net/http. The resulting timestamp response may be parsed using Response. Please note that Response is read-only and immutable. To create a Response, an instance of Factory as well as a valid Request are needed. ===Create a Response: #Assumes ts.p12 is a PKCS#12-compatible file with a private key #and a certificate that has an extended key usage of 'timeStamping' p12 = OpenSSL::PKCS12.new(File.open('ts.p12', 'rb'), 'pwd') md = OpenSSL::Digest.new('SHA1') hash = md.digest(data) #some binary data to be timestamped req = OpenSSL::Timestamp::Request.new req.algorithm = 'SHA1' req.message_imprint = hash req.policy_id = "1.2.3.4.5" req.nonce = 42 fac = OpenSSL::Timestamp::Factory.new fac.gen_time = Time.now fac.serial_number = 1 timestamp = fac.create_timestamp(p12.key, p12.certificate, req) ===Verify a timestamp response: #Assume we have a timestamp token in a file called ts.der ts = OpenSSL::Timestamp::Response.new(File.open('ts.der', 'rb') #Assume we have the Request for this token in a file called req.der req = OpenSSL::Timestamp::Request.new(File.open('req.der', 'rb') # Assume the associated root CA certificate is contained in a # DER-encoded file named root.cer root = OpenSSL::X509::Certificate.new(File.open('root.cer', 'rb') # get the necessary intermediate certificates, available in # DER-encoded form in inter1.cer and inter2.cer inter1 = OpenSSL::X509::Certificate.new(File.open('inter1.cer', 'rb') inter2 = OpenSSL::X509::Certificate.new(File.open('inter2.cer', 'rb') ts.verify(req, root, inter1, inter2) -> ts or raises an exception if validation fails ;T;0; @q$;!F;"o;#;$T;%iÿ;&i';'o;L;M0;N0;O0;;;'@;Q@ÃÇ;R0;I"OpenSSL::Timestamp;F;So;L;M0;N0;O0;;T;'@;Q@];R0o; ;IC;[ o; ;IC;[;A@‰$;BIC;[;A@‰$;CIC;[;A@‰$;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ôÇi÷;F;:PKCS12Error;;K;;;[;{;IC;";T;[;[;@|;0; @‰$;'@‡$;I"!OpenSSL::PKCS12::PKCS12Error;F;S@ÅÇo;;F; ;F;;;I"OpenSSL::PKCS12.create;F;[[@c0;[[@ôÇim;T;;ª;0;[;{;IC;"[=== Parameters * _pass_ - string * _name_ - A string describing the key. * _key_ - Any PKey. * _cert_ - A X509::Certificate. * The public_key portion of the certificate must contain a valid public key. * The not_before and not_after fields must be filled in. * _ca_ - An optional array of X509::Certificate's. * _key_pbe_ - string * _cert_pbe_ - string * _key_iter_ - integer * _mac_iter_ - integer * _keytype_ - An integer representing an MSIE specific extension. Any optional arguments may be supplied as +nil+ to preserve the OpenSSL defaults. See the OpenSSL documentation for PKCS12_create(). ;T;[o;= ;3I" overload;F;40;;ª;50;)I"icreate(pass, name, key, cert [, ca, [, key_pbe [, cert_pbe [, key_iter [, mac_iter [, keytype]]]]]]);T;IC;";T; @š$;>0;!F;[;[;I";T;0;6i;[ [I" pass;T0[I" name;T0[I"key;T0[I"Ocert[, ca, [, key_pbe [, cert_pbe [, key_iter [, mac_iter [, keytype]]]]]];T0; @š$;[;I"Ì=== Parameters * _pass_ - string * _name_ - A string describing the key. * _key_ - Any PKey. * _cert_ - A X509::Certificate. * The public_key portion of the certificate must contain a valid public key. * The not_before and not_after fields must be filled in. * _ca_ - An optional array of X509::Certificate's. * _key_pbe_ - string * _cert_pbe_ - string * _key_iter_ - integer * _mac_iter_ - integer * _keytype_ - An integer representing an MSIE specific extension. Any optional arguments may be supplied as +nil+ to preserve the OpenSSL defaults. See the OpenSSL documentation for PKCS12_create(). @overload create(pass, name, key, cert [, ca, [, key_pbe [, cert_pbe [, key_iter [, mac_iter [, keytype]]]]]]);T;0; @š$;!F;"o;#;$T;%iW;&ij;'@‡$;(I"¤static VALUE ossl_pkcs12_s_create(int argc, VALUE *argv, VALUE self) { VALUE pass, name, pkey, cert, ca, key_nid, cert_nid, key_iter, mac_iter, keytype; VALUE obj; char *passphrase, *friendlyname; EVP_PKEY *key; X509 *x509; STACK_OF(X509) *x509s; int nkey = 0, ncert = 0, kiter = 0, miter = 0, ktype = 0; PKCS12 *p12; rb_scan_args(argc, argv, "46", &pass, &name, &pkey, &cert, &ca, &key_nid, &cert_nid, &key_iter, &mac_iter, &keytype); passphrase = NIL_P(pass) ? NULL : StringValueCStr(pass); friendlyname = NIL_P(name) ? NULL : StringValueCStr(name); key = GetPKeyPtr(pkey); x509 = GetX509CertPtr(cert); /* TODO: make a VALUE to nid function */ if (!NIL_P(key_nid)) { if ((nkey = OBJ_txt2nid(StringValueCStr(key_nid))) == NID_undef) ossl_raise(rb_eArgError, "Unknown PBE algorithm %"PRIsVALUE, key_nid); } if (!NIL_P(cert_nid)) { if ((ncert = OBJ_txt2nid(StringValueCStr(cert_nid))) == NID_undef) ossl_raise(rb_eArgError, "Unknown PBE algorithm %"PRIsVALUE, cert_nid); } if (!NIL_P(key_iter)) kiter = NUM2INT(key_iter); if (!NIL_P(mac_iter)) miter = NUM2INT(mac_iter); if (!NIL_P(keytype)) ktype = NUM2INT(keytype); obj = NewPKCS12(cPKCS12); x509s = NIL_P(ca) ? NULL : ossl_x509_ary2sk(ca); p12 = PKCS12_create(passphrase, friendlyname, key, x509, x509s, nkey, ncert, kiter, miter, ktype); sk_X509_pop_free(x509s, X509_free); if(!p12) ossl_raise(ePKCS12Error, NULL); SetPKCS12(obj, p12); ossl_pkcs12_set_key(obj, pkey); ossl_pkcs12_set_cert(obj, cert); ossl_pkcs12_set_ca_certs(obj, ca); return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"$OpenSSL::PKCS12#initialize_copy;F;[[I" other;T0;[[@ôÇiD;T;;g;0;[;{;IC;";T;[;[;@|;0; @¹$;'@‡$;(I"Ÿstatic VALUE ossl_pkcs12_initialize_copy(VALUE self, VALUE other) { PKCS12 *p12, *p12_old, *p12_new; rb_check_frozen(self); GetPKCS12(self, p12_old); GetPKCS12(other, p12); p12_new = ASN1_dup((i2d_of_void *)i2d_PKCS12, (d2i_of_void *)d2i_PKCS12, (char *)p12); if (!p12_new) ossl_raise(ePKCS12Error, "ASN1_dup"); SetPKCS12(self, p12_new); PKCS12_free(p12_old); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKCS12#initialize;F;[[@c0;[[@ôÇi¢;T;;Ð;0;[;{;IC;"T=== Parameters * _str_ - Must be a DER encoded PKCS12 string. * _pass_ - string ;T;[o;= ;3I" overload;F;40;;î;50;)I"new;T;IC;";T; @Ç$;>0;!F;[;[;I";T;0;6i;[; @Ç$o;= ;3I" overload;F;40;;î;50;)I" new(str);T;IC;";T; @Ç$;>0;!F;[;[;I";T;0;6i;[[I"str;T0; @Ç$o;= ;3I" overload;F;40;;î;50;)I"new(str, pass);T;IC;";T; @Ç$;>0;!F;[;[;I";T;0;6i;[[I"str;T0[I" pass;T0; @Ç$;[;I"‹=== Parameters * _str_ - Must be a DER encoded PKCS12 string. * _pass_ - string @overload new @overload new(str) @overload new(str, pass);T;0; @Ç$;!F;"o;#;$T;%i˜;&iŸ;'@‡$;(I"Wstatic VALUE ossl_pkcs12_initialize(int argc, VALUE *argv, VALUE self) { BIO *in; VALUE arg, pass, pkey, cert, ca; char *passphrase; EVP_PKEY *key; X509 *x509; STACK_OF(X509) *x509s = NULL; int st = 0; PKCS12 *pkcs = DATA_PTR(self); if(rb_scan_args(argc, argv, "02", &arg, &pass) == 0) return self; passphrase = NIL_P(pass) ? NULL : StringValueCStr(pass); in = ossl_obj2bio(&arg); d2i_PKCS12_bio(in, &pkcs); DATA_PTR(self) = pkcs; BIO_free(in); pkey = cert = ca = Qnil; /* OpenSSL's bug; PKCS12_parse() puts errors even if it succeeds. * Fixed in OpenSSL 1.0.0t, 1.0.1p, 1.0.2d */ ERR_set_mark(); if(!PKCS12_parse(pkcs, passphrase, &key, &x509, &x509s)) ossl_raise(ePKCS12Error, "PKCS12_parse"); ERR_pop_to_mark(); if (key) { pkey = rb_protect((VALUE (*)(VALUE))ossl_pkey_new, (VALUE)key, &st); if (st) goto err; } if (x509) { cert = rb_protect((VALUE (*)(VALUE))ossl_x509_new, (VALUE)x509, &st); if (st) goto err; } if (x509s) { ca = rb_protect((VALUE (*)(VALUE))ossl_x509_sk2ary, (VALUE)x509s, &st); if (st) goto err; } err: X509_free(x509); sk_X509_pop_free(x509s, X509_free); ossl_pkcs12_set_key(self, pkey); ossl_pkcs12_set_cert(self, cert); ossl_pkcs12_set_ca_certs(self, ca); if(st) rb_jump_tag(st); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::PKCS12#to_der;F;[;[[@ôÇiÔ;T;;°;0;[;{;IC;";T;[;[;@|;0; @ô$;'@‡$;(I"“static VALUE ossl_pkcs12_to_der(VALUE self) { PKCS12 *p12; VALUE str; long len; unsigned char *p; GetPKCS12(self, p12); if((len = i2d_PKCS12(p12, NULL)) <= 0) ossl_raise(ePKCS12Error, NULL); str = rb_str_new(0, len); p = (unsigned char *)RSTRING_PTR(str); if(i2d_PKCS12(p12, &p) <= 0) ossl_raise(ePKCS12Error, NULL); ossl_str_adjust(str, p); return str; };T;)I"static VALUE;T;*T;A@‡$;BIC;[;A@‡$;CIC;[;A@‡$;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ôÇiö;F;:PKCS12;;K;;;[;{;IC;";T;[;[;@|;0; @‡$;6i;'@ÃÇ;I"OpenSSL::PKCS12;F;S@]o; ;IC;[;A@%;BIC;[;A@%;CIC;[;A@%;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@üÇi9[@üÇi‰;T;:BNError;;K;;;[;{;IC;"3Generic Error for all of OpenSSL::BN (big num) ;T;[;[;I"5 Generic Error for all of OpenSSL::BN (big num) ;T;0; @%;!F;"o;#;$T;%i9;&i;;'o;L;M0;N0;O0;;;'@;Q@ÃÇ;R0;I"OpenSSL::BNError;F;S@ÅÇo; ;IC;[9o;;F; ;;;;I"OpenSSL::BN#initialize;F;[[@c0;[[@üÇié;T;;Ð;0;[;{;IC;"+Construct a new OpenSSL BIGNUM object. ;T;[ o;= ;3I" overload;F;40;:OpenSSL::BN.new;50;)I"OpenSSL::BN.new(bn);T;IC;";T; @&%;>0;!F;[;[;I";T;0;6i;[[I"bn;T0; @&%o;= ;3I" overload;F;40;;;50;)I"OpenSSL::BN.new(integer);T;IC;";T; @&%;>0;!F;[;[;I";T;0;6i;[[I"integer;T0; @&%o;= ;3I" overload;F;40;;;50;)I"OpenSSL::BN.new(string);T;IC;";T; @&%;>0;!F;[;[;I";T;0;6i;[[I"string;T0; @&%o;= ;3I" overload;F;40;;;50;)I"-OpenSSL::BN.new(string, 0 | 2 | 10 | 16);T;IC;";T; @&%;>0;!F;[;[;I";T;0;6i;[[I"string;T0[I"0|2|10|16;T0; @&%;[;I"¾Construct a new OpenSSL BIGNUM object. @overload OpenSSL::BN.new(bn) @overload OpenSSL::BN.new(integer) @overload OpenSSL::BN.new(string) @overload OpenSSL::BN.new(string, 0 | 2 | 10 | 16);T;0; @&%;!F;"o;#;$T;%ià;&iæ;'@$%;(I"static VALUE ossl_bn_initialize(int argc, VALUE *argv, VALUE self) { BIGNUM *bn; VALUE str, bs; int base = 10; char *ptr; if (rb_scan_args(argc, argv, "11", &str, &bs) == 2) { base = NUM2INT(bs); } if (NIL_P(str)) { ossl_raise(rb_eArgError, "invalid argument"); } if (RB_INTEGER_TYPE_P(str)) { GetBN(self, bn); integer_to_bnptr(str, bn); return self; } if (RTEST(rb_obj_is_kind_of(str, cBN))) { BIGNUM *other; GetBN(self, bn); GetBN(str, other); /* Safe - we checked kind_of? above */ if (!BN_copy(bn, other)) { ossl_raise(eBNError, NULL); } return self; } GetBN(self, bn); switch (base) { case 0: ptr = StringValuePtr(str); if (!BN_mpi2bn((unsigned char *)ptr, RSTRING_LENINT(str), bn)) { ossl_raise(eBNError, NULL); } break; case 2: ptr = StringValuePtr(str); if (!BN_bin2bn((unsigned char *)ptr, RSTRING_LENINT(str), bn)) { ossl_raise(eBNError, NULL); } break; case 10: if (!BN_dec2bn(&bn, StringValueCStr(str))) { ossl_raise(eBNError, NULL); } break; case 16: if (!BN_hex2bn(&bn, StringValueCStr(str))) { ossl_raise(eBNError, NULL); } break; default: ossl_raise(rb_eArgError, "invalid radix %d", base); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I" OpenSSL::BN#initialize_copy;F;[;[;F;;g;;K;[;{;IC;";T;[;[;@|;0; @_%;'@$%;*To;;F; ;;;;I"OpenSSL::BN#copy;F;[;[;F;: copy;;K;[;{;IC;";T;[;[;@|;0; @h%;'@$%;*To;;F; ;;;;I"OpenSSL::BN#num_bytes;F;[;[;F;:num_bytes;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"num_bytes;T;IC;";T; @q%;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @q%;[;I"@return [Integer];T;0;6i;[; @q%;[;I"- @overload num_bytes @return [Integer];T;0; @q%;!F;"o;#;$T;%i„;&i†;'@$%;*To;;F; ;;;;I"OpenSSL::BN#num_bits;F;[;[;F;: num_bits;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I" num_bits;T;IC;";T; @‰%;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @‰%;[;I"@return [Integer];T;0;6i;[; @‰%;[;I", @overload num_bits @return [Integer];T;0; @‰%;!F;"o;#;$T;%i‹;&i;'@$%;*To;;F; ;;;;I"OpenSSL::BN#+@;F;[;[[@üÇi¨;T;;W;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;&;50;)I"+bn;T;IC;";T; @¡%;>0;!F;[;[;I";T;0;6i;[; @¡%;[;I" @overload +bn;T;0; @¡%;!F;"o;#;$T;%i¤;&i¥;'@$%;(I"@static VALUE ossl_bn_uplus(VALUE self) { return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::BN#-@;F;[;[[@üÇi²;T;;9;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"-bn;T;IC;";T; @·%;>0;!F;[;[;I";T;0;6i;[; @·%;[;I" @overload -bn;T;0; @·%;!F;"o;#;$T;%i®;&i¯;'@$%;(I"static VALUE ossl_bn_uminus(VALUE self) { VALUE obj; BIGNUM *bn1, *bn2; GetBN(self, bn1); obj = NewBN(cBN); bn2 = BN_dup(bn1); if (!bn2) ossl_raise(eBNError, "BN_dup"); SetBN(obj, bn2); BN_set_negative(bn2, !BN_is_negative(bn2)); return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::BN#+;F;[;[;F;;&;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;&;50;)I"+(bn2);T;IC;";T; @Í%;>0;!F;[;[;I";T;0;6i;[[I"bn2;T0; @Í%;[;I" @overload +(bn2);T;0; @Í%;!F;"o;#;$T;%iê;&ië;'@$%;*To;;F; ;;;;I"OpenSSL::BN#-;F;[;[;F;;;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"-(bn2);T;IC;";T; @â%;>0;!F;[;[;I";T;0;6i;[[I"bn2;T0; @â%;[;I" @overload -(bn2);T;0; @â%;!F;"o;#;$T;%iñ;&iò;'@$%;*To;;F; ;;;;I"OpenSSL::BN#*;F;[;[;F;;';;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;';50;)I"*(bn2);T;IC;";T; @÷%;>0;!F;[;[;I";T;0;6i;[[I"bn2;T0; @÷%;[;I" @overload *(bn2);T;0; @÷%;!F;"o;#;$T;%i;&i;'@$%;*To;;F; ;;;;I"OpenSSL::BN#sqr;F;[;[;F;:sqr;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"sqr;T;IC;";T; @&;>0;!F;[;[;I";T;0;6i;[; @&;[;I" @overload sqr;T;0; @&;!F;"o;#;$T;%iÐ;&iÑ;'@$%;*To;;F; ;;;;I"OpenSSL::BN#/;F;[[I" other;T0;[[@üÇiE;T;;:;0;[;{;IC;"&Division of OpenSSL::BN instances ;T;[o;= ;3I" overload;F;40;;:;50;)I"/(bn2);T;IC;";T; @&;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @&;[;I"@return [Array];T;0;6i;[[I"bn2;T0; @&;[;I"KDivision of OpenSSL::BN instances @overload /(bn2) @return [Array];T;0; @&;!F;"o;#;$T;%i?;&iC;'@$%;(I">static VALUE ossl_bn_div(VALUE self, VALUE other) { BIGNUM *bn1, *bn2 = GetBNPtr(other), *r1, *r2; VALUE klass, obj1, obj2; GetBN(self, bn1); klass = rb_obj_class(self); obj1 = NewBN(klass); obj2 = NewBN(klass); if (!(r1 = BN_new())) { ossl_raise(eBNError, NULL); } if (!(r2 = BN_new())) { BN_free(r1); ossl_raise(eBNError, NULL); } if (!BN_div(r1, r2, bn1, bn2, ossl_bn_ctx)) { BN_free(r1); BN_free(r2); ossl_raise(eBNError, NULL); } SetBN(obj1, r1); SetBN(obj2, r2); return rb_ary_new3(2, obj1, obj2); };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::BN#%;F;[;[;F;;Û;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;Û;50;)I"%(bn2);T;IC;";T; @>&;>0;!F;[;[;I";T;0;6i;[[I"bn2;T0; @>&;[;I" @overload %(bn2);T;0; @>&;!F;"o;#;$T;%i;&i;'@$%;*To;;F; ;;;;I"OpenSSL::BN#mod_add;F;[;[;F;:mod_add;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"mod_add(bn1, bn2);T;IC;";T; @S&;>0;!F;[;[;I";T;0;6i;[[I"bn1;T0[I"bn2;T0; @S&;[;I"! @overload mod_add(bn1, bn2);T;0; @S&;!F;"o;#;$T;%iv;&iw;'@$%;*To;;F; ;;;;I"OpenSSL::BN#mod_sub;F;[;[;F;:mod_sub;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"mod_sub(bn1, bn2);T;IC;";T; @j&;>0;!F;[;[;I";T;0;6i;[[I"bn1;T0[I"bn2;T0; @j&;[;I"! @overload mod_sub(bn1, bn2);T;0; @j&;!F;"o;#;$T;%i};&i~;'@$%;*To;;F; ;;;;I"OpenSSL::BN#mod_mul;F;[;[;F;:mod_mul;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"mod_mul(bn1, bn2);T;IC;";T; @&;>0;!F;[;[;I";T;0;6i;[[I"bn1;T0[I"bn2;T0; @&;[;I"! @overload mod_mul(bn1, bn2);T;0; @&;!F;"o;#;$T;%i„;&i…;'@$%;*To;;F; ;;;;I"OpenSSL::BN#mod_sqr;F;[;[;F;:mod_sqr;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"mod_sqr(bn2);T;IC;";T; @˜&;>0;!F;[;[;I";T;0;6i;[[I"bn2;T0; @˜&;[;I" @overload mod_sqr(bn2);T;0; @˜&;!F;"o;#;$T;%i';&i(;'@$%;*To;;F; ;;;;I"OpenSSL::BN#**;F;[;[;F;;=;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;=;50;)I"**(bn2);T;IC;";T; @&;>0;!F;[;[;I";T;0;6i;[[I"bn2;T0; @&;[;I" @overload **(bn2);T;0; @&;!F;"o;#;$T;%i;&i;'@$%;*To;;F; ;;;;I"OpenSSL::BN#mod_exp;F;[;[;F;:mod_exp;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;; ;50;)I"mod_exp(bn1, bn2);T;IC;";T; @Â&;>0;!F;[;[;I";T;0;6i;[[I"bn1;T0[I"bn2;T0; @Â&;[;I"! @overload mod_exp(bn1, bn2);T;0; @Â&;!F;"o;#;$T;%i‹;&iŒ;'@$%;*To;;F; ;;;;I"OpenSSL::BN#gcd;F;[;[;F;:gcd;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;; ;50;)I" gcd(bn2);T;IC;";T; @Ù&;>0;!F;[;[;I";T;0;6i;[[I"bn2;T0; @Ù&;[;I" @overload gcd(bn2);T;0; @Ù&;!F;"o;#;$T;%i ;&i!;'@$%;*To;;F; ;;;;I"OpenSSL::BN#cmp;F;[;[;F;;Ú;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;Ú;50;)I" cmp(bn2);T;IC;";T; @î&;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @î&;[;I"@return [Integer];T;0;6i;[[I"bn2;T0; @î&;[;I", @overload cmp(bn2) @return [Integer];T;0; o;;F; ;;;;I"OpenSSL::BN#<=>;F;[;[[@üÇi³;F;;c;;K;[;{;@ô&;'@$%;)0;(I";F;!F;"o;#;$T;%iÌ;&iÎ;'@$%;*T@'o;;F; ;;;;I"OpenSSL::BN#ucmp;F;[;[;F;: ucmp;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"ucmp(bn2);T;IC;";T; @';>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @';[;I"@return [Integer];T;0;6i;[[I"bn2;T0; @';[;I"- @overload ucmp(bn2) @return [Integer];T;0; @';!F;"o;#;$T;%iØ;&iÚ;'@$%;*To;;F; ;;;;I"OpenSSL::BN#eql?;F;[[I" other;T0;[[@üÇiÿ;T;;_;0;[;{;IC;"°Returns true only if obj is a OpenSSL::BN with the same value as bn. Contrast this with OpenSSL::BN#==, which performs type conversions.;T;[o;= ;3I" overload;F;40;;_;50;)I"eql?(obj);T;IC;";T; @*';>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @*';[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @*';[;I"ÚReturns true only if obj is a OpenSSL::BN with the same value as bn. Contrast this with OpenSSL::BN#==, which performs type conversions. @overload eql?(obj) @return [Boolean];T;0; @*';!F;"o;#;$T;%i÷;&iý;6i;'@$%;(I"ástatic VALUE ossl_bn_eql(VALUE self, VALUE other) { BIGNUM *bn1, *bn2; if (!rb_obj_is_kind_of(other, cBN)) return Qfalse; GetBN(self, bn1); GetBN(other, bn2); return BN_cmp(bn1, bn2) ? Qfalse : Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::BN#hash;F;[;[[@üÇi;T;;b;0;[;{;IC;"@Returns a hash code for this object. See also Object#hash. ;T;[o;= ;3I" overload;F;40;;b;50;)I" hash;T;IC;";T; @I';>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @I';[;I"@return [Integer];T;0;6i;[; @I';[;I"eReturns a hash code for this object. See also Object#hash. @overload hash @return [Integer];T;0; @I';!F;"o;#;$T;%i;&i;'@$%;(I"sstatic VALUE ossl_bn_hash(VALUE self) { BIGNUM *bn; VALUE tmp, hash; unsigned char *buf; int len; GetBN(self, bn); len = BN_num_bytes(bn); buf = ALLOCV(tmp, len); if (BN_bn2bin(bn, buf) != len) { ALLOCV_END(tmp); ossl_raise(eBNError, "BN_bn2bin"); } hash = ST2FIX(rb_memhash(buf, len)); ALLOCV_END(tmp); return hash; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::BN#==;F;[;[;F;;`;;K;[;{;IC;";T;[;[;@|;0; o;;F; ;;;;I"OpenSSL::BN#===;F;[;[[@üÇi¸;F;;\;;K;[;{;@j';'@$%;)0;(I";F;'@$%;*T@m'o;;F; ;;;;I"OpenSSL::BN#zero?;F;[;[;F;;^;;K;[;{;IC;";T;[o;= ;3I" overload;F;40;;^;50;)I" zero?;T;IC;";T; @u';>0;!F;[;[;I";T;0;6i;[; @u'o;2 ;3I"return;F;4@|;0;5[@~; @u';[;I" @overload zero?;T;0; @u';!F;"o;#;$T;%i™;&iš;6i;'@$%;*To;;F; ;;;;I"OpenSSL::BN#one?;F;[;[;F;;<;;K;[;{;IC;";T;[o;= ;3I" overload;F;40;;<;50;)I" one?;T;IC;";T; @‹';>0;!F;[;[;I";T;0;6i;[; @‹'o;2 ;3I"return;F;4@|;0;5[@~; @‹';[;I" @overload one?;T;0; @‹';!F;"o;#;$T;%i ;&i¡;6i;'@$%;*To;;F; ;;;;I"OpenSSL::BN#odd?;F;[;[;F;: odd?;;K;[;{;IC;";T;[o;= ;3I" overload;F;40;;;50;)I" odd?;T;IC;";T; @¡';>0;!F;[;[;I";T;0;6i;[; @¡'o;2 ;3I"return;F;4@|;0;5[@~; @¡';[;I" @overload odd?;T;0; @¡';!F;"o;#;$T;%i§;&i¨;6i;'@$%;*To;;F; ;;;;I"OpenSSL::BN#negative?;F;[;[;F;;e;;K;[;{;IC;";T;[o;2 ;3I"return;F;4@|;0;5[@~; @·';[;@|;0; @·';6i;'@$%;*To;;F; ;F;;;I"OpenSSL::BN.rand;F;[;[;F;;¾;;K;[;{;IC;"*BN.rand(bits [, fill [, odd]]) -> aBN ;T;[;[;I"- BN.rand(bits [, fill [, odd]]) -> aBN ;T;0; @Ã';!F;"o;#;$T;%i!;&i";'@$%;*To;;F; ;F;;;I"OpenSSL::BN.pseudo_rand;F;[;[;F;:pseudo_rand;;K;[;{;IC;"1BN.pseudo_rand(bits [, fill [, odd]]) -> aBN ;T;[;[;I"4 BN.pseudo_rand(bits [, fill [, odd]]) -> aBN ;T;0; @Î';!F;"o;#;$T;%i';&i(;'@$%;*To;;F; ;F;;;I"OpenSSL::BN.rand_range;F;[;[;F;:rand_range;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"rand_range(range);T;IC;";T; @Ù';>0;!F;[;[;I";T;0;6i;[[I" range;T0; @Ù';[;I"" @overload rand_range(range);T;0; @Ù';!F;"o;#;$T;%i>;&i@;'@$%;*To;;F; ;F;;;I""OpenSSL::BN.pseudo_rand_range;F;[;[;F;:pseudo_rand_range;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"pseudo_rand_range(range);T;IC;";T; @î';>0;!F;[;[;I";T;0;6i;[[I" range;T0; @î';[;I") @overload pseudo_rand_range(range);T;0; @î';!F;"o;#;$T;%iF;&iH;'@$%;*To;;F; ;F;;;I"OpenSSL::BN.generate_prime;F;[;[;F;:generate_prime;;K;[;{;IC;";T;[;[;@|;0; @(;'@$%;*To;;F; ;;;;I"OpenSSL::BN#prime?;F;[[@c0;[[@üÇi6;T;:prime?;0;[;{;IC;"õPerforms a Miller-Rabin probabilistic primality test with _checks_ iterations. If _checks_ is not specified, a number of iterations is used that yields a false positive rate of at most 2^-80 for random input. === Parameters * _checks_ - integer;T;[o;= ;3I" overload;F;40;;;50;)I"prime?;T;IC;";T; @(;>0;!F;[;[;I";T;0;6i;[; @(o;= ;3I" overload;F;40;;;50;)I"prime?(checks);T;IC;";T; @(;>0;!F;[;[;I";T;0;6i;[[I"checks;T0; @(o;2 ;3I"return;F;4@|;0;5[@~; @(;[;I"!Performs a Miller-Rabin probabilistic primality test with _checks_ iterations. If _checks_ is not specified, a number of iterations is used that yields a false positive rate of at most 2^-80 for random input. === Parameters * _checks_ - integer @overload prime? @overload prime?(checks);T;0; @(;!F;"o;#;$T;%i*;&i3;6i;'@$%;(I"Çstatic VALUE ossl_bn_is_prime(int argc, VALUE *argv, VALUE self) { BIGNUM *bn; VALUE vchecks; int checks = BN_prime_checks; if (rb_scan_args(argc, argv, "01", &vchecks) == 1) { checks = NUM2INT(vchecks); } GetBN(self, bn); switch (BN_is_prime_ex(bn, checks, ossl_bn_ctx, NULL)) { case 1: return Qtrue; case 0: return Qfalse; default: ossl_raise(eBNError, NULL); } /* not reachable */ return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I" OpenSSL::BN#prime_fasttest?;F;[[@c0;[[@üÇiZ;T;:prime_fasttest?;0;[;{;IC;"¿Performs a Miller-Rabin primality test. This is same as #prime? except this first attempts trial divisions with some small primes. === Parameters * _checks_ - integer * _trial_div_ - boolean;T;[ o;= ;3I" overload;F;40;;;50;)I"prime_fasttest?;T;IC;";T; @0(;>0;!F;[;[;I";T;0;6i;[; @0(o;= ;3I" overload;F;40;;;50;)I"prime_fasttest?(checks);T;IC;";T; @0(;>0;!F;[;[;I";T;0;6i;[[I"checks;T0; @0(o;= ;3I" overload;F;40;;;50;)I"'prime_fasttest?(checks, trial_div);T;IC;";T; @0(;>0;!F;[;[;I";T;0;6i;[[I"checks;T0[I"trial_div;T0; @0(o;2 ;3I"return;F;4@|;0;5[@~; @0(;[;I"*Performs a Miller-Rabin primality test. This is same as #prime? except this first attempts trial divisions with some small primes. === Parameters * _checks_ - integer * _trial_div_ - boolean @overload prime_fasttest? @overload prime_fasttest?(checks) @overload prime_fasttest?(checks, trial_div);T;0; @0(;!F;"o;#;$T;%iM;&iW;6i;'@$%;(I"static VALUE ossl_bn_is_prime_fasttest(int argc, VALUE *argv, VALUE self) { BIGNUM *bn; VALUE vchecks, vtrivdiv; int checks = BN_prime_checks, do_trial_division = 1; rb_scan_args(argc, argv, "02", &vchecks, &vtrivdiv); if (!NIL_P(vchecks)) { checks = NUM2INT(vchecks); } GetBN(self, bn); /* handle true/false */ if (vtrivdiv == Qfalse) { do_trial_division = 0; } switch (BN_is_prime_fasttest_ex(bn, checks, ossl_bn_ctx, do_trial_division, NULL)) { case 1: return Qtrue; case 0: return Qfalse; default: ossl_raise(eBNError, NULL); } /* not reachable */ return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::BN#set_bit!;F;[;[;F;: set_bit!;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"set_bit!(bit);T;IC;";T; @`(;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @`(;[;I"@return [self];T;0;6i;[[I"bit;T0; @`(;[;I". @overload set_bit!(bit) @return [self];T;0; @`(;!F;"o;#;$T;%iž;&i ;'@$%;*To;;F; ;;;;I"OpenSSL::BN#clear_bit!;F;[;[;F;:clear_bit!;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"clear_bit!(bit);T;IC;";T; @z(;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @z(;[;I"@return [self];T;0;6i;[[I"bit;T0; @z(;[;I"0 @overload clear_bit!(bit) @return [self];T;0; @z(;!F;"o;#;$T;%i¥;&i§;'@$%;*To;;F; ;;;;I"OpenSSL::BN#bit_set?;F;[;[;F;: bit_set?;;K;[;{;IC;";T;[o;2 ;3I"return;F;4@|;0;5[@~; @”(;[;@|;0; @”(;6i;'@$%;*To;;F; ;;;;I"OpenSSL::BN#mask_bits!;F;[;[;F;:mask_bits!;;K;[;{;IC;";T;[;[;@|;0; @ (;'@$%;*To;;F; ;;;;I"OpenSSL::BN#<<;F;[;[;F;;Ý;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;Ý;50;)I" <<(bits);T;IC;";T; @©(;>0;!F;[;[;I";T;0;6i;[[I" bits;T0; @©(;[;I" @overload <<(bits);T;0; @©(;!F;"o;#;$T;%iÜ;&iÝ;'@$%;*To;;F; ;;;;I"OpenSSL::BN#>>;F;[;[;F;;•;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;•;50;)I" >>(bits);T;IC;";T; @¾(;>0;!F;[;[;I";T;0;6i;[[I" bits;T0; @¾(;[;I" @overload >>(bits);T;0; @¾(;!F;"o;#;$T;%iã;&iä;'@$%;*To;;F; ;;;;I"OpenSSL::BN#lshift!;F;[;[;F;:lshift!;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"lshift!(bits);T;IC;";T; @Ó(;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @Ó(;[;I"@return [self];T;0;6i;[[I" bits;T0; @Ó(;[;I". @overload lshift!(bits) @return [self];T;0; @Ó(;!F;"o;#;$T;%i÷;&iù;'@$%;*To;;F; ;;;;I"OpenSSL::BN#rshift!;F;[;[;F;:rshift!;;K;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;;50;)I"rshift!(bits);T;IC;";T; @í(;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @í(;[;I"@return [self];T;0;6i;[[I" bits;T0; @í(;[;I". @overload rshift!(bits) @return [self];T;0; @í(;!F;"o;#;$T;%iþ;&i;'@$%;*To;;F; ;;;;I"OpenSSL::BN#to_s;F;[[@c0;[[@üÇi6;T;;q;0;[;{;IC;"s=== Parameters * _base_ - Integer Valid values: * 0 - MPI * 2 - binary * 10 - the default * 16 - hex ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @);>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @);[;I"@return [String];T;0;6i;[; @)o;= ;3I" overload;F;40;;q;50;)I"to_s(base);T;IC;";T; @);>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @);[;I"@return [String];T;0;6i;[[I" base;T0; @);[;I"º=== Parameters * _base_ - Integer Valid values: * 0 - MPI * 2 - binary * 10 - the default * 16 - hex @overload to_s @return [String] @overload to_s(base) @return [String];T;0; @);!F;"o;#;$T;%i);&i5;'@$%;(I"¿static VALUE ossl_bn_to_s(int argc, VALUE *argv, VALUE self) { BIGNUM *bn; VALUE str, bs; int base = 10, len; char *buf; if (rb_scan_args(argc, argv, "01", &bs) == 1) { base = NUM2INT(bs); } GetBN(self, bn); switch (base) { case 0: len = BN_bn2mpi(bn, NULL); str = rb_str_new(0, len); if (BN_bn2mpi(bn, (unsigned char *)RSTRING_PTR(str)) != len) ossl_raise(eBNError, NULL); break; case 2: len = BN_num_bytes(bn); str = rb_str_new(0, len); if (BN_bn2bin(bn, (unsigned char *)RSTRING_PTR(str)) != len) ossl_raise(eBNError, NULL); break; case 10: if (!(buf = BN_bn2dec(bn))) ossl_raise(eBNError, NULL); str = ossl_buf2str(buf, rb_long2int(strlen(buf))); break; case 16: if (!(buf = BN_bn2hex(bn))) ossl_raise(eBNError, NULL); str = ossl_buf2str(buf, rb_long2int(strlen(buf))); break; default: ossl_raise(rb_eArgError, "invalid radix %d", base); } return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::BN#to_i;F;[;[[@üÇib;T;;–;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;–;50;)I" to_i;T;IC;";T; @2);>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @2);[;I"@return [Integer];T;0;6i;[; @2);[;I"( @overload to_i @return [Integer];T;0; o;;F; ;;;;I"OpenSSL::BN#to_int;F;[;[[@üÇiç;F;;\;;K;[;{;@9);'@$%;)I"static VALUE;T;(I"static VALUE ossl_bn_to_i(VALUE self) { BIGNUM *bn; char *txt; VALUE num; GetBN(self, bn); if (!(txt = BN_bn2hex(bn))) { ossl_raise(eBNError, NULL); } num = rb_cstr_to_inum(txt, 16, Qtrue); OPENSSL_free(txt); return num; };T;!F;"o;#;$T;%i^;&i`;'@$%;(I"static VALUE ossl_bn_to_i(VALUE self) { BIGNUM *bn; char *txt; VALUE num; GetBN(self, bn); if (!(txt = BN_bn2hex(bn))) { ossl_raise(eBNError, NULL); } num = rb_cstr_to_inum(txt, 16, Qtrue); OPENSSL_free(txt); return num; };T;)@Q);*T@J)o;;F; ;;;;I"OpenSSL::BN#to_bn;F;[;[[@üÇit;T;: to_bn;0;[;{;IC;";T;[;[;@|;0; @U);'@$%;(I"@static VALUE ossl_bn_to_bn(VALUE self) { return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::BN#coerce;F;[[I" other;T0;[[@üÇiz;T;;>;0;[;{;IC;";T;[;[;@|;0; @a);'@$%;(I"‚static VALUE ossl_bn_coerce(VALUE self, VALUE other) { switch(TYPE(other)) { case T_STRING: self = ossl_bn_to_s(0, NULL, self); break; case T_FIXNUM: case T_BIGNUM: self = ossl_bn_to_i(self); break; default: if (!RTEST(rb_obj_is_kind_of(other, cBN))) { ossl_raise(rb_eTypeError, "Don't know how to coerce"); } } return rb_assoc_new(other, self); };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::BN#mod_inverse;F;[;[;F;:mod_inverse;;K;[;{;IC;">TODO: But how to: from_bin, from_mpi? PACK? to_bin to_mpi ;T;[;[;I"?TODO: But how to: from_bin, from_mpi? PACK? to_bin to_mpi ;T;0; @o);!F;"o;#;$T;%ië;&iï;'@$%;*T;A@$%;BIC;[;A@$%;CIC;[;A@$%;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@';Ú@m';`@J);–;I[;[[@üÇi‹;F;:BN;;K;;;[;{;IC;";T;[;[;@|;0; @$%;6i;'@ÃÇ;I"OpenSSL::BN;F;S@]o; ;IC;[o; ;IC;[;A@‹);BIC;[;A@‹);CIC;[;A@‹);DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@þÇiÿ[@þÇi;T;:ASN1Error;;K;;;[;{;IC;"\Generic error class for all errors raised in ASN1 and any of the classes defined in it. ;T;[;[;I"^ Generic error class for all errors raised in ASN1 and any of the classes defined in it. ;T;0; @‹);!F;"o;#;$T;%iÿ;&i;'@‰);I"OpenSSL::ASN1::ASN1Error;F;S@ÅÇo;;F; ;;;Ï;I"OpenSSL::ASN1#traverse;F;[[I"obj;T0;[[@þÇi¸;T;: traverse;0;[;{;IC;"[If a block is given, it prints out each of the elements encountered. Block parameters are (in that order): * depth: The recursion depth, plus one with each constructed value being encountered (Integer) * offset: Current byte offset (Integer) * header length: Combined length in bytes of the Tag and Length headers. (Integer) * length: The overall remaining length of the entire data (Integer) * constructed: Whether this value is constructed or not (Boolean) * tag_class: Current tag class (Symbol) * tag: The current tag number (Integer) == Example der = File.binread('asn1data.der') OpenSSL::ASN1.traverse(der) do | depth, offset, header_len, length, constructed, tag_class, tag| puts "Depth: #{depth} Offset: #{offset} Length: #{length}" puts "Header length: #{header_len} Tag: #{tag} Tag class: #{tag_class} Constructed: #{constructed}" end ;T; @Ÿ);>0;!F;[o;= ;3I" overload;F;40;:OpenSSL::ASN1.traverse;50;)I"!OpenSSL::ASN1.traverse(asn1);T;IC;";T; @Ÿ);>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @Ÿ);[;I"@return [nil];T;0;6i;[[I" asn1;T0; @Ÿ);[;I"“If a block is given, it prints out each of the elements encountered. Block parameters are (in that order): * depth: The recursion depth, plus one with each constructed value being encountered (Integer) * offset: Current byte offset (Integer) * header length: Combined length in bytes of the Tag and Length headers. (Integer) * length: The overall remaining length of the entire data (Integer) * constructed: Whether this value is constructed or not (Boolean) * tag_class: Current tag class (Symbol) * tag: The current tag number (Integer) == Example der = File.binread('asn1data.der') OpenSSL::ASN1.traverse(der) do | depth, offset, header_len, length, constructed, tag_class, tag| puts "Depth: #{depth} Offset: #{offset} Length: #{length}" puts "Header length: #{header_len} Tag: #{tag} Tag class: #{tag_class} Constructed: #{constructed}" end @overload OpenSSL::ASN1.traverse(asn1) @return [nil];T;0;'@‰);(I"®static VALUE ossl_asn1_traverse(VALUE self, VALUE obj) { unsigned char *p; VALUE tmp; long len, read = 0, offset = 0; obj = ossl_to_der_if_possible(obj); tmp = rb_str_new4(StringValue(obj)); p = (unsigned char *)RSTRING_PTR(tmp); len = RSTRING_LEN(tmp); ossl_asn1_decode0(&p, len, &offset, 0, 1, &read); RB_GC_GUARD(tmp); int_ossl_decode_sanity_check(len, read, offset); return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"OpenSSL::ASN1.traverse;F;@¡);@¤);T;;;0;@¦);{;IC;"[If a block is given, it prints out each of the elements encountered. Block parameters are (in that order): * depth: The recursion depth, plus one with each constructed value being encountered (Integer) * offset: Current byte offset (Integer) * header length: Combined length in bytes of the Tag and Length headers. (Integer) * length: The overall remaining length of the entire data (Integer) * constructed: Whether this value is constructed or not (Boolean) * tag_class: Current tag class (Symbol) * tag: The current tag number (Integer) == Example der = File.binread('asn1data.der') OpenSSL::ASN1.traverse(der) do | depth, offset, header_len, length, constructed, tag_class, tag| puts "Depth: #{depth} Offset: #{offset} Length: #{length}" puts "Header length: #{header_len} Tag: #{tag} Tag class: #{tag_class} Constructed: #{constructed}" end;T;[o;= ;3I" overload;F;40;;;50;)I"!OpenSSL::ASN1.traverse(asn1);T;IC;";T; @½);>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @½);[;I"@return [nil];T;0;6i;[[I" asn1;T0; @½);[;I"”If a block is given, it prints out each of the elements encountered. Block parameters are (in that order): * depth: The recursion depth, plus one with each constructed value being encountered (Integer) * offset: Current byte offset (Integer) * header length: Combined length in bytes of the Tag and Length headers. (Integer) * length: The overall remaining length of the entire data (Integer) * constructed: Whether this value is constructed or not (Boolean) * tag_class: Current tag class (Symbol) * tag: The current tag number (Integer) == Example der = File.binread('asn1data.der') OpenSSL::ASN1.traverse(der) do | depth, offset, header_len, length, constructed, tag_class, tag| puts "Depth: #{depth} Offset: #{offset} Length: #{length}" puts "Header length: #{header_len} Tag: #{tag} Tag class: #{tag_class} Constructed: #{constructed}" end @overload OpenSSL::ASN1.traverse(asn1) @return [nil];T;0; @½);!F;"o;#;$T;%i£;&i¶;6i;'@‰);(@»);)@¼);*To;;F; ;;;Ï;I"OpenSSL::ASN1#decode;F;[[I"obj;T0;[[@þÇiÕ;T;:decode;0;[;{;IC;" Decodes a BER- or DER-encoded value and creates an ASN1Data instance. _der_ may be a String or any object that features a +.to_der+ method transforming it into a BER-/DER-encoded String+ == Example der = File.binread('asn1data') asn1 = OpenSSL::ASN1.decode(der) ;T; @Ô);>0;!F;[o;= ;3I" overload;F;40;:OpenSSL::ASN1.decode;50;)I"OpenSSL::ASN1.decode(der);T;IC;";T; @Ô);>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" ASN1Data;T; @Ô);[;I"@return [ASN1Data];T;0;6i;[[I"der;T0; @Ô);[;I"DDecodes a BER- or DER-encoded value and creates an ASN1Data instance. _der_ may be a String or any object that features a +.to_der+ method transforming it into a BER-/DER-encoded String+ == Example der = File.binread('asn1data') asn1 = OpenSSL::ASN1.decode(der) @overload OpenSSL::ASN1.decode(der) @return [ASN1Data];T;0;'@‰);(I"Àstatic VALUE ossl_asn1_decode(VALUE self, VALUE obj) { VALUE ret; unsigned char *p; VALUE tmp; long len, read = 0, offset = 0; obj = ossl_to_der_if_possible(obj); tmp = rb_str_new4(StringValue(obj)); p = (unsigned char *)RSTRING_PTR(tmp); len = RSTRING_LEN(tmp); ret = ossl_asn1_decode0(&p, len, &offset, 0, 0, &read); RB_GC_GUARD(tmp); int_ossl_decode_sanity_check(len, read, offset); return ret; };T;)I"static VALUE;T;*To;;T; ;F;;;I"OpenSSL::ASN1.decode;F;@Ö);@Ù);T;;;0;@Û);{;IC;" Decodes a BER- or DER-encoded value and creates an ASN1Data instance. _der_ may be a String or any object that features a +.to_der+ method transforming it into a BER-/DER-encoded String+ == Example der = File.binread('asn1data') asn1 = OpenSSL::ASN1.decode(der);T;[o;= ;3I" overload;F;40;; ;50;)I"OpenSSL::ASN1.decode(der);T;IC;";T; @ò);>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" ASN1Data;T; @ò);[;I"@return [ASN1Data];T;0;6i;[[I"der;T0; @ò);[;I"EDecodes a BER- or DER-encoded value and creates an ASN1Data instance. _der_ may be a String or any object that features a +.to_der+ method transforming it into a BER-/DER-encoded String+ == Example der = File.binread('asn1data') asn1 = OpenSSL::ASN1.decode(der) @overload OpenSSL::ASN1.decode(der) @return [ASN1Data];T;0; @ò);!F;"o;#;$T;%iÉ;&iÓ;6i;'@‰);(@ð);)@ñ);*To;;F; ;;;Ï;I"OpenSSL::ASN1#decode_all;F;[[I"obj;T0;[[@þÇiô;T;:decode_all;0;[;{;IC;">Similar to #decode with the difference that #decode expects one distinct value represented in _der_. #decode_all on the contrary decodes a sequence of sequential BER/DER values lined up in _der_ and returns them as an array. == Example ders = File.binread('asn1data_seq') asn1_ary = OpenSSL::ASN1.decode_all(ders) ;T; @ *;>0;!F;[o;= ;3I" overload;F;40;:OpenSSL::ASN1.decode_all;50;)I""OpenSSL::ASN1.decode_all(der);T;IC;";T; @ *;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Array of ASN1Data;T; @ *;[;I" @return [Array of ASN1Data];T;0;6i;[[I"der;T0; @ *;[;I"…Similar to #decode with the difference that #decode expects one distinct value represented in _der_. #decode_all on the contrary decodes a sequence of sequential BER/DER values lined up in _der_ and returns them as an array. == Example ders = File.binread('asn1data_seq') asn1_ary = OpenSSL::ASN1.decode_all(ders) @overload OpenSSL::ASN1.decode_all(der) @return [Array of ASN1Data];T;0;'@‰);(I"{static VALUE ossl_asn1_decode_all(VALUE self, VALUE obj) { VALUE ary, val; unsigned char *p; long len, tmp_len = 0, read = 0, offset = 0; VALUE tmp; obj = ossl_to_der_if_possible(obj); tmp = rb_str_new4(StringValue(obj)); p = (unsigned char *)RSTRING_PTR(tmp); len = RSTRING_LEN(tmp); tmp_len = len; ary = rb_ary_new(); while (tmp_len > 0) { long tmp_read = 0; val = ossl_asn1_decode0(&p, tmp_len, &offset, 0, 0, &tmp_read); rb_ary_push(ary, val); read += tmp_read; tmp_len -= tmp_read; } RB_GC_GUARD(tmp); int_ossl_decode_sanity_check(len, read, offset); return ary; };T;)I"static VALUE;T;*To;;T; ;F;;;I"OpenSSL::ASN1.decode_all;F;@*;@*;T;;!;0;@*;{;IC;">Similar to #decode with the difference that #decode expects one distinct value represented in _der_. #decode_all on the contrary decodes a sequence of sequential BER/DER values lined up in _der_ and returns them as an array. == Example ders = File.binread('asn1data_seq') asn1_ary = OpenSSL::ASN1.decode_all(ders);T;[o;= ;3I" overload;F;40;;";50;)I""OpenSSL::ASN1.decode_all(der);T;IC;";T; @'*;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Array of ASN1Data;T; @'*;[;I" @return [Array of ASN1Data];T;0;6i;[[I"der;T0; @'*;[;I"†Similar to #decode with the difference that #decode expects one distinct value represented in _der_. #decode_all on the contrary decodes a sequence of sequential BER/DER values lined up in _der_ and returns them as an array. == Example ders = File.binread('asn1data_seq') asn1_ary = OpenSSL::ASN1.decode_all(ders) @overload OpenSSL::ASN1.decode_all(der) @return [Array of ASN1Data];T;0; @'*;!F;"o;#;$T;%iç;&iò;6i;'@‰);(@%*;)@&*;*To;{;[[@þÇi ;F;:UNIVERSAL_TAG_NAME;;};;;[;{;IC;"0Array storing tag names at the tag's index. ;T;[;[;I"1Array storing tag names at the tag's index. ;T;0; @>*;!F;"o;#;$T;%i ;&i;'@‰);I"&OpenSSL::ASN1::UNIVERSAL_TAG_NAME;F;~I"ary;To; ;IC;[ o;;F; ;;;;I",OpenSSL::ASN1::ASN1Data#infinite_length;F;[;[[@þÇi;F;:infinite_length;;K;[;{;IC;";T;[;[;@|;0; @L*;'@J*;)I"def infinite_length;To;;F; ;;;;I"-OpenSSL::ASN1::ASN1Data#infinite_length=;F;[;[[@þÇiŽ;F;:infinite_length=;;K;[;{;IC;";T;[;[;@|;0; @W*;'@J*;)I"def infinite_length=;To;;F; ;;;;I"'OpenSSL::ASN1::ASN1Data#initialize;F;[[I" value;T0[I"tag;T0[I"tag_class;T0;[[@þÇi„;T;;Ð;0;[;{;IC;"È_value_: Please have a look at Constructive and Primitive to see how Ruby types are mapped to ASN.1 types and vice versa. _tag_: An Integer indicating the tag number. _tag_class_: A Symbol indicating the tag class. Please cf. ASN1 for possible values. == Example asn1_int = OpenSSL::ASN1Data.new(42, 2, :UNIVERSAL) # => Same as OpenSSL::ASN1::Integer.new(42) tagged_int = OpenSSL::ASN1Data.new(42, 0, :CONTEXT_SPECIFIC) # implicitly 0-tagged INTEGER ;T;[o;= ;3I" overload;F;40;: OpenSSL::ASN1::ASN1Data.new;50;)I"7OpenSSL::ASN1::ASN1Data.new(value, tag, tag_class);T;IC;";T; @b*;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" ASN1Data;T; @b*;[;I"@return [ASN1Data];T;0;6i;[[I" value;T0[I"tag;T0[I"tag_class;T0; @b*;[;I"_value_: Please have a look at Constructive and Primitive to see how Ruby types are mapped to ASN.1 types and vice versa. _tag_: An Integer indicating the tag number. _tag_class_: A Symbol indicating the tag class. Please cf. ASN1 for possible values. == Example asn1_int = OpenSSL::ASN1Data.new(42, 2, :UNIVERSAL) # => Same as OpenSSL::ASN1::Integer.new(42) tagged_int = OpenSSL::ASN1Data.new(42, 0, :CONTEXT_SPECIFIC) # implicitly 0-tagged INTEGER @overload OpenSSL::ASN1::ASN1Data.new(value, tag, tag_class) @return [ASN1Data];T;0; @b*;!F;"o;#;$T;%it;&i‚;'@J*;(I"dstatic VALUE ossl_asn1data_initialize(VALUE self, VALUE value, VALUE tag, VALUE tag_class) { if(!SYMBOL_P(tag_class)) ossl_raise(eASN1Error, "invalid tag class"); ossl_asn1_set_tag(self, tag); ossl_asn1_set_value(self, value); ossl_asn1_set_tag_class(self, tag_class); ossl_asn1_set_indefinite_length(self, Qfalse); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::ASN1::ASN1Data#to_der;F;[;[[@þÇiË;T;;°;0;[;{;IC;"Encodes this ASN1Data into a DER-encoded String value. The result is DER-encoded except for the possibility of indefinite length forms. Indefinite length forms are not allowed in strict DER, so strictly speaking the result of such an encoding would be a BER-encoding. ;T;[o;= ;3I" overload;F;40;;°;50;)I"to_der;T;IC;";T; @‰*;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"DER-encoded String;T; @‰*;[;I"!@return [DER-encoded String];T;0;6i;[; @‰*;[;I"=Encodes this ASN1Data into a DER-encoded String value. The result is DER-encoded except for the possibility of indefinite length forms. Indefinite length forms are not allowed in strict DER, so strictly speaking the result of such an encoding would be a BER-encoding. @overload to_der @return [DER-encoded String];T;0; @‰*;!F;"o;#;$T;%iÂ;&iÉ;'@J*;(I"„static VALUE ossl_asn1data_to_der(VALUE self) { VALUE value = ossl_asn1_get_value(self); if (rb_obj_is_kind_of(value, rb_cArray)) return ossl_asn1cons_to_der(self); else { if (RTEST(ossl_asn1_get_indefinite_length(self))) ossl_raise(eASN1Error, "indefinite length form cannot be used " \ "with primitive encoding"); return ossl_asn1prim_to_der(self); } };T;)I"static VALUE;T;*T;A@J*;BIC;[;A@J*;CIC;[;A@J*;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@L*:indefinite_length@W*:indefinite_length=;I[;[[@þÇi[@þÇik;T;: ASN1Data;;K;;;[;{;IC;"ºThe top-level class representing any ASN.1 object. When parsed by ASN1.decode, tagged values are always represented by an instance of ASN1Data. == The role of ASN1Data for parsing tagged values When encoding an ASN.1 type it is inherently clear what original type (e.g. INTEGER, OCTET STRING etc.) this value has, regardless of its tagging. But opposed to the time an ASN.1 type is to be encoded, when parsing them it is not possible to deduce the "real type" of tagged values. This is why tagged values are generally parsed into ASN1Data instances, but with a different outcome for implicit and explicit tagging. === Example of a parsed implicitly tagged value An implicitly 1-tagged INTEGER value will be parsed as an ASN1Data with * _tag_ equal to 1 * _tag_class_ equal to +:CONTEXT_SPECIFIC+ * _value_ equal to a String that carries the raw encoding of the INTEGER. This implies that a subsequent decoding step is required to completely decode implicitly tagged values. === Example of a parsed explicitly tagged value An explicitly 1-tagged INTEGER value will be parsed as an ASN1Data with * _tag_ equal to 1 * _tag_class_ equal to +:CONTEXT_SPECIFIC+ * _value_ equal to an Array with one single element, an instance of OpenSSL::ASN1::Integer, i.e. the inner element is the non-tagged primitive value, and the tagging is represented in the outer ASN1Data == Example - Decoding an implicitly tagged INTEGER int = OpenSSL::ASN1::Integer.new(1, 0, :IMPLICIT) # implicit 0-tagged seq = OpenSSL::ASN1::Sequence.new( [int] ) der = seq.to_der asn1 = OpenSSL::ASN1.decode(der) # pp asn1 => #]> raw_int = asn1.value[0] # manually rewrite tag and tag class to make it an UNIVERSAL value raw_int.tag = OpenSSL::ASN1::INTEGER raw_int.tag_class = :UNIVERSAL int2 = OpenSSL::ASN1.decode(raw_int) puts int2.value # => 1 == Example - Decoding an explicitly tagged INTEGER int = OpenSSL::ASN1::Integer.new(1, 0, :EXPLICIT) # explicit 0-tagged seq = OpenSSL::ASN1::Sequence.new( [int] ) der = seq.to_der asn1 = OpenSSL::ASN1.decode(der) # pp asn1 => #]>]> int2 = asn1.value[0].value[0] puts int2.value # => 1 ;T;[;[;I"¼ The top-level class representing any ASN.1 object. When parsed by ASN1.decode, tagged values are always represented by an instance of ASN1Data. == The role of ASN1Data for parsing tagged values When encoding an ASN.1 type it is inherently clear what original type (e.g. INTEGER, OCTET STRING etc.) this value has, regardless of its tagging. But opposed to the time an ASN.1 type is to be encoded, when parsing them it is not possible to deduce the "real type" of tagged values. This is why tagged values are generally parsed into ASN1Data instances, but with a different outcome for implicit and explicit tagging. === Example of a parsed implicitly tagged value An implicitly 1-tagged INTEGER value will be parsed as an ASN1Data with * _tag_ equal to 1 * _tag_class_ equal to +:CONTEXT_SPECIFIC+ * _value_ equal to a String that carries the raw encoding of the INTEGER. This implies that a subsequent decoding step is required to completely decode implicitly tagged values. === Example of a parsed explicitly tagged value An explicitly 1-tagged INTEGER value will be parsed as an ASN1Data with * _tag_ equal to 1 * _tag_class_ equal to +:CONTEXT_SPECIFIC+ * _value_ equal to an Array with one single element, an instance of OpenSSL::ASN1::Integer, i.e. the inner element is the non-tagged primitive value, and the tagging is represented in the outer ASN1Data == Example - Decoding an implicitly tagged INTEGER int = OpenSSL::ASN1::Integer.new(1, 0, :IMPLICIT) # implicit 0-tagged seq = OpenSSL::ASN1::Sequence.new( [int] ) der = seq.to_der asn1 = OpenSSL::ASN1.decode(der) # pp asn1 => #]> raw_int = asn1.value[0] # manually rewrite tag and tag class to make it an UNIVERSAL value raw_int.tag = OpenSSL::ASN1::INTEGER raw_int.tag_class = :UNIVERSAL int2 = OpenSSL::ASN1.decode(raw_int) puts int2.value # => 1 == Example - Decoding an explicitly tagged INTEGER int = OpenSSL::ASN1::Integer.new(1, 0, :EXPLICIT) # explicit 0-tagged seq = OpenSSL::ASN1::Sequence.new( [int] ) der = seq.to_der asn1 = OpenSSL::ASN1.decode(der) # pp asn1 => #]>]> int2 = asn1.value[0].value[0] puts int2.value # => 1 ;T;0; @J*;!F;"o;#;$T;%i;&ii;'@‰);I"OpenSSL::ASN1::ASN1Data;F;S@]o; ;IC;[o;;F; ;;;;I"(OpenSSL::ASN1::Primitive#initialize;F;[[@c0;[[@þÇi%;T;;Ð;0;[;{;IC;"Ù_value_: is mandatory. _tag_: optional, may be specified for tagged values. If no _tag_ is specified, the UNIVERSAL tag corresponding to the Primitive sub-class is used by default. _tagging_: may be used as an encoding hint to encode a value either explicitly or implicitly, see ASN1 for possible values. _tag_class_: if _tag_ and _tagging_ are +nil+ then this is set to +:UNIVERSAL+ by default. If either _tag_ or _tagging_ are set then +:CONTEXT_SPECIFIC+ is used as the default. For possible values please cf. ASN1. == Example int = OpenSSL::ASN1::Integer.new(42) zero_tagged_int = OpenSSL::ASN1::Integer.new(42, 0, :IMPLICIT) private_explicit_zero_tagged_int = OpenSSL::ASN1::Integer.new(42, 0, :EXPLICIT, :PRIVATE) ;T;[o;= ;3I" overload;F;40;:!OpenSSL::ASN1::Primitive.new;50;)I"EOpenSSL::ASN1::Primitive.new(value [, tag, tagging, tag_class ]);T;IC;";T; @¸*;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Primitive;T; @¸*;[;I"@return [Primitive];T;0;6i;[[I"&value[, tag, tagging, tag_class ];T0; @¸*;[;I"<_value_: is mandatory. _tag_: optional, may be specified for tagged values. If no _tag_ is specified, the UNIVERSAL tag corresponding to the Primitive sub-class is used by default. _tagging_: may be used as an encoding hint to encode a value either explicitly or implicitly, see ASN1 for possible values. _tag_class_: if _tag_ and _tagging_ are +nil+ then this is set to +:UNIVERSAL+ by default. If either _tag_ or _tagging_ are set then +:CONTEXT_SPECIFIC+ is used as the default. For possible values please cf. ASN1. == Example int = OpenSSL::ASN1::Integer.new(42) zero_tagged_int = OpenSSL::ASN1::Integer.new(42, 0, :IMPLICIT) private_explicit_zero_tagged_int = OpenSSL::ASN1::Integer.new(42, 0, :EXPLICIT, :PRIVATE) @overload OpenSSL::ASN1::Primitive.new(value [, tag, tagging, tag_class ]) @return [Primitive];T;0; @¸*;!F;"o;#;$T;%i;&i#;'@¶*;(I"=static VALUE ossl_asn1_initialize(int argc, VALUE *argv, VALUE self) { VALUE value, tag, tagging, tag_class; int default_tag; rb_scan_args(argc, argv, "13", &value, &tag, &tagging, &tag_class); default_tag = ossl_asn1_default_tag(self); if (default_tag == -1 || argc > 1) { if(NIL_P(tag)) ossl_raise(eASN1Error, "must specify tag number"); if(!NIL_P(tagging) && !SYMBOL_P(tagging)) ossl_raise(eASN1Error, "invalid tagging method"); if(NIL_P(tag_class)) { if (NIL_P(tagging)) tag_class = sym_UNIVERSAL; else tag_class = sym_CONTEXT_SPECIFIC; } if(!SYMBOL_P(tag_class)) ossl_raise(eASN1Error, "invalid tag class"); } else{ tag = INT2NUM(default_tag); tagging = Qnil; tag_class = sym_UNIVERSAL; } ossl_asn1_set_tag(self, tag); ossl_asn1_set_value(self, value); ossl_asn1_set_tagging(self, tagging); ossl_asn1_set_tag_class(self, tag_class); ossl_asn1_set_indefinite_length(self, Qfalse); if (default_tag == V_ASN1_BIT_STRING) rb_ivar_set(self, sivUNUSED_BITS, INT2FIX(0)); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"$OpenSSL::ASN1::Primitive#to_der;F;[;[[@þÇig;T;;°;0;[;{;IC;"%See ASN1Data#to_der for details. ;T;[o;= ;3I" overload;F;40;;°;50;)I"to_der;T;IC;";T; @Ö*;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"DER-encoded String;T; @Ö*;[;I"!@return [DER-encoded String];T;0;6i;[; @Ö*;[;I"WSee ASN1Data#to_der for details. @overload to_der @return [DER-encoded String];T;0; @Ö*;!F;"o;#;$T;%ia;&ie;'@¶*;(I"static VALUE ossl_asn1prim_to_der(VALUE self) { ASN1_TYPE *asn1; long alllen, bodylen; unsigned char *p0, *p1; int j, tag, tc, state; VALUE str; if (ossl_asn1_default_tag(self) == -1) { str = ossl_asn1_get_value(self); return to_der_internal(self, 0, 0, StringValue(str)); } asn1 = ossl_asn1_get_asn1type(self); alllen = i2d_ASN1_TYPE(asn1, NULL); if (alllen < 0) { ASN1_TYPE_free(asn1); ossl_raise(eASN1Error, "i2d_ASN1_TYPE"); } str = ossl_str_new(NULL, alllen, &state); if (state) { ASN1_TYPE_free(asn1); rb_jump_tag(state); } p0 = p1 = (unsigned char *)RSTRING_PTR(str); i2d_ASN1_TYPE(asn1, &p0); ASN1_TYPE_free(asn1); assert(p0 - p1 == alllen); /* Strip header since to_der_internal() wants only the payload */ j = ASN1_get_object((const unsigned char **)&p1, &bodylen, &tag, &tc, alllen); if (j & 0x80) ossl_raise(eASN1Error, "ASN1_get_object"); /* should not happen */ return to_der_internal(self, 0, 0, rb_str_drop_bytes(str, alllen - bodylen)); };T;)I"static VALUE;T;*T;A@¶*;BIC;[;A@¶*;CIC;[;A@¶*;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@þÇi’[@þÇiÒ;T;:Primitive;;K;;;[;{;IC;"Ç The parent class for all primitive encodings. Attributes are the same as for ASN1Data, with the addition of _tagging_. Primitive values can never be encoded with indefinite length form, thus it is not possible to set the _indefinite_length_ attribute for Primitive and its sub-classes. == Primitive sub-classes and their mapping to Ruby classes * OpenSSL::ASN1::EndOfContent <=> _value_ is always +nil+ * OpenSSL::ASN1::Boolean <=> _value_ is +true+ or +false+ * OpenSSL::ASN1::Integer <=> _value_ is an OpenSSL::BN * OpenSSL::ASN1::BitString <=> _value_ is a String * OpenSSL::ASN1::OctetString <=> _value_ is a String * OpenSSL::ASN1::Null <=> _value_ is always +nil+ * OpenSSL::ASN1::Object <=> _value_ is a String * OpenSSL::ASN1::Enumerated <=> _value_ is an OpenSSL::BN * OpenSSL::ASN1::UTF8String <=> _value_ is a String * OpenSSL::ASN1::NumericString <=> _value_ is a String * OpenSSL::ASN1::PrintableString <=> _value_ is a String * OpenSSL::ASN1::T61String <=> _value_ is a String * OpenSSL::ASN1::VideotexString <=> _value_ is a String * OpenSSL::ASN1::IA5String <=> _value_ is a String * OpenSSL::ASN1::UTCTime <=> _value_ is a Time * OpenSSL::ASN1::GeneralizedTime <=> _value_ is a Time * OpenSSL::ASN1::GraphicString <=> _value_ is a String * OpenSSL::ASN1::ISO64String <=> _value_ is a String * OpenSSL::ASN1::GeneralString <=> _value_ is a String * OpenSSL::ASN1::UniversalString <=> _value_ is a String * OpenSSL::ASN1::BMPString <=> _value_ is a String == OpenSSL::ASN1::BitString === Additional attributes _unused_bits_: if the underlying BIT STRING's length is a multiple of 8 then _unused_bits_ is 0. Otherwise _unused_bits_ indicates the number of bits that are to be ignored in the final octet of the BitString's _value_. == OpenSSL::ASN1::ObjectId NOTE: While OpenSSL::ASN1::ObjectId.new will allocate a new ObjectId, it is not typically allocated this way, but rather that are received from parsed ASN1 encodings. === Additional attributes * _sn_: the short name as defined in . * _ln_: the long name as defined in . * _oid_: the object identifier as a String, e.g. "1.2.3.4.5" * _short_name_: alias for _sn_. * _long_name_: alias for _ln_. == Examples With the Exception of OpenSSL::ASN1::EndOfContent, each Primitive class constructor takes at least one parameter, the _value_. === Creating EndOfContent eoc = OpenSSL::ASN1::EndOfContent.new === Creating any other Primitive prim = .new(value) # being one of the sub-classes except EndOfContent prim_zero_tagged_implicit = .new(value, 0, :IMPLICIT) prim_zero_tagged_explicit = .new(value, 0, :EXPLICIT) ;T;[;[;I"É The parent class for all primitive encodings. Attributes are the same as for ASN1Data, with the addition of _tagging_. Primitive values can never be encoded with indefinite length form, thus it is not possible to set the _indefinite_length_ attribute for Primitive and its sub-classes. == Primitive sub-classes and their mapping to Ruby classes * OpenSSL::ASN1::EndOfContent <=> _value_ is always +nil+ * OpenSSL::ASN1::Boolean <=> _value_ is +true+ or +false+ * OpenSSL::ASN1::Integer <=> _value_ is an OpenSSL::BN * OpenSSL::ASN1::BitString <=> _value_ is a String * OpenSSL::ASN1::OctetString <=> _value_ is a String * OpenSSL::ASN1::Null <=> _value_ is always +nil+ * OpenSSL::ASN1::Object <=> _value_ is a String * OpenSSL::ASN1::Enumerated <=> _value_ is an OpenSSL::BN * OpenSSL::ASN1::UTF8String <=> _value_ is a String * OpenSSL::ASN1::NumericString <=> _value_ is a String * OpenSSL::ASN1::PrintableString <=> _value_ is a String * OpenSSL::ASN1::T61String <=> _value_ is a String * OpenSSL::ASN1::VideotexString <=> _value_ is a String * OpenSSL::ASN1::IA5String <=> _value_ is a String * OpenSSL::ASN1::UTCTime <=> _value_ is a Time * OpenSSL::ASN1::GeneralizedTime <=> _value_ is a Time * OpenSSL::ASN1::GraphicString <=> _value_ is a String * OpenSSL::ASN1::ISO64String <=> _value_ is a String * OpenSSL::ASN1::GeneralString <=> _value_ is a String * OpenSSL::ASN1::UniversalString <=> _value_ is a String * OpenSSL::ASN1::BMPString <=> _value_ is a String == OpenSSL::ASN1::BitString === Additional attributes _unused_bits_: if the underlying BIT STRING's length is a multiple of 8 then _unused_bits_ is 0. Otherwise _unused_bits_ indicates the number of bits that are to be ignored in the final octet of the BitString's _value_. == OpenSSL::ASN1::ObjectId NOTE: While OpenSSL::ASN1::ObjectId.new will allocate a new ObjectId, it is not typically allocated this way, but rather that are received from parsed ASN1 encodings. === Additional attributes * _sn_: the short name as defined in . * _ln_: the long name as defined in . * _oid_: the object identifier as a String, e.g. "1.2.3.4.5" * _short_name_: alias for _sn_. * _long_name_: alias for _ln_. == Examples With the Exception of OpenSSL::ASN1::EndOfContent, each Primitive class constructor takes at least one parameter, the _value_. === Creating EndOfContent eoc = OpenSSL::ASN1::EndOfContent.new === Creating any other Primitive prim = .new(value) # being one of the sub-classes except EndOfContent prim_zero_tagged_implicit = .new(value, 0, :IMPLICIT) prim_zero_tagged_explicit = .new(value, 0, :EXPLICIT) ;T;0; @¶*;!F;"o;#;$T;%i’;&iÐ;'@‰);I"OpenSSL::ASN1::Primitive;F;S@J*o; ;IC;[o;;F; ;;;;I"+OpenSSL::ASN1::Constructive#initialize;F;[[@c0;[[@þÇi%;T;;Ð;0;[;{;IC;"Ù_value_: is mandatory. _tag_: optional, may be specified for tagged values. If no _tag_ is specified, the UNIVERSAL tag corresponding to the Primitive sub-class is used by default. _tagging_: may be used as an encoding hint to encode a value either explicitly or implicitly, see ASN1 for possible values. _tag_class_: if _tag_ and _tagging_ are +nil+ then this is set to +:UNIVERSAL+ by default. If either _tag_ or _tagging_ are set then +:CONTEXT_SPECIFIC+ is used as the default. For possible values please cf. ASN1. == Example int = OpenSSL::ASN1::Integer.new(42) zero_tagged_int = OpenSSL::ASN1::Integer.new(42, 0, :IMPLICIT) private_explicit_zero_tagged_int = OpenSSL::ASN1::Integer.new(42, 0, :EXPLICIT, :PRIVATE) ;T;[o;= ;3I" overload;F;40;;*;50;)I"EOpenSSL::ASN1::Primitive.new(value [, tag, tagging, tag_class ]);T;IC;";T; @+;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Primitive;T; @+;[;I"@return [Primitive];T;0;6i;[[I"&value[, tag, tagging, tag_class ];T0; @+;[;@Ò*;0; @+;!F;"o;#;$T;%i;&i#;'@+;(I"=static VALUE ossl_asn1_initialize(int argc, VALUE *argv, VALUE self) { VALUE value, tag, tagging, tag_class; int default_tag; rb_scan_args(argc, argv, "13", &value, &tag, &tagging, &tag_class); default_tag = ossl_asn1_default_tag(self); if (default_tag == -1 || argc > 1) { if(NIL_P(tag)) ossl_raise(eASN1Error, "must specify tag number"); if(!NIL_P(tagging) && !SYMBOL_P(tagging)) ossl_raise(eASN1Error, "invalid tagging method"); if(NIL_P(tag_class)) { if (NIL_P(tagging)) tag_class = sym_UNIVERSAL; else tag_class = sym_CONTEXT_SPECIFIC; } if(!SYMBOL_P(tag_class)) ossl_raise(eASN1Error, "invalid tag class"); } else{ tag = INT2NUM(default_tag); tagging = Qnil; tag_class = sym_UNIVERSAL; } ossl_asn1_set_tag(self, tag); ossl_asn1_set_value(self, value); ossl_asn1_set_tagging(self, tagging); ossl_asn1_set_tag_class(self, tag_class); ossl_asn1_set_indefinite_length(self, Qfalse); if (default_tag == V_ASN1_BIT_STRING) rb_ivar_set(self, sivUNUSED_BITS, INT2FIX(0)); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::ASN1::Constructive#to_der;F;[;[[@þÇi“;T;;°;0;[;{;IC;"%See ASN1Data#to_der for details. ;T;[o;= ;3I" overload;F;40;;°;50;)I"to_der;T;IC;";T; @"+;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"DER-encoded String;T; @"+;[;I"!@return [DER-encoded String];T;0;6i;[; @"+;[;I"WSee ASN1Data#to_der for details. @overload to_der @return [DER-encoded String];T;0; @"+;!F;"o;#;$T;%i;&i‘;'@+;(I"static VALUE ossl_asn1cons_to_der(VALUE self) { VALUE ary, str; long i; int indef_len; indef_len = RTEST(ossl_asn1_get_indefinite_length(self)); ary = rb_convert_type(ossl_asn1_get_value(self), T_ARRAY, "Array", "to_a"); str = rb_str_new(NULL, 0); for (i = 0; i < RARRAY_LEN(ary); i++) { VALUE item = RARRAY_AREF(ary, i); if (indef_len && rb_obj_is_kind_of(item, cASN1EndOfContent)) { if (i != RARRAY_LEN(ary) - 1) ossl_raise(eASN1Error, "illegal EOC octets in value"); /* * EOC is not really part of the content, but we required to add one * at the end in the past. */ break; } item = ossl_to_der_if_possible(item); StringValue(item); rb_str_append(str, item); } return to_der_internal(self, 1, indef_len, str); };T;)I"static VALUE;T;*To;;F; ;;;;I"%OpenSSL::ASN1::Constructive#each;F;[;[[@þÇiÀ;T;;;0;[;{;IC;"ÑCalls the given block once for each element in self, passing that element as parameter _asn1_. If no block is given, an enumerator is returned instead. == Example asn1_ary.each do |asn1| puts asn1 end ;T;[o;= ;3I" overload;F;40;;;50;)I" each;T;IC;";T; @=+;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" asn1;T; @=+;[;I"@yield [asn1];T;0;6i;[; @=+;[;I"òCalls the given block once for each element in self, passing that element as parameter _asn1_. If no block is given, an enumerator is returned instead. == Example asn1_ary.each do |asn1| puts asn1 end @overload each @yield [asn1];T;0; @=+;!F;"o;#;$T;%i³;&i¾;'@+;(I"„static VALUE ossl_asn1cons_each(VALUE self) { rb_block_call(ossl_asn1_get_value(self), id_each, 0, 0, 0, 0); return self; };T;)I"static VALUE;T;*T;A@+;BIC;[;A@+;CIC;[@(;A@+;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@þÇiß[@þÇiú;T;:Constructive;;K;;;[;{;IC;"pThe parent class for all constructed encodings. The _value_ attribute of a Constructive is always an Array. Attributes are the same as for ASN1Data, with the addition of _tagging_. == SET and SEQUENCE Most constructed encodings come in the form of a SET or a SEQUENCE. These encodings are represented by one of the two sub-classes of Constructive: * OpenSSL::ASN1::Set * OpenSSL::ASN1::Sequence Please note that tagged sequences and sets are still parsed as instances of ASN1Data. Find further details on tagged values there. === Example - constructing a SEQUENCE int = OpenSSL::ASN1::Integer.new(1) str = OpenSSL::ASN1::PrintableString.new('abc') sequence = OpenSSL::ASN1::Sequence.new( [ int, str ] ) === Example - constructing a SET int = OpenSSL::ASN1::Integer.new(1) str = OpenSSL::ASN1::PrintableString.new('abc') set = OpenSSL::ASN1::Set.new( [ int, str ] ) ;T;[;[;I"r The parent class for all constructed encodings. The _value_ attribute of a Constructive is always an Array. Attributes are the same as for ASN1Data, with the addition of _tagging_. == SET and SEQUENCE Most constructed encodings come in the form of a SET or a SEQUENCE. These encodings are represented by one of the two sub-classes of Constructive: * OpenSSL::ASN1::Set * OpenSSL::ASN1::Sequence Please note that tagged sequences and sets are still parsed as instances of ASN1Data. Find further details on tagged values there. === Example - constructing a SEQUENCE int = OpenSSL::ASN1::Integer.new(1) str = OpenSSL::ASN1::PrintableString.new('abc') sequence = OpenSSL::ASN1::Sequence.new( [ int, str ] ) === Example - constructing a SET int = OpenSSL::ASN1::Integer.new(1) str = OpenSSL::ASN1::PrintableString.new('abc') set = OpenSSL::ASN1::Set.new( [ int, str ] ) ;T;0; @+;!F;"o;#;$T;%iß;&iø;'@‰);I" OpenSSL::ASN1::Constructive;F;S@J*o; ;IC;[o;;F; ;F;;;I"%OpenSSL::ASN1::ObjectId.register;F;[[I"oid;T0[I"sn;T0[I"ln;T0;[[@þÇiÓ;T;: register;0;[;{;IC;"êThis adds a new ObjectId to the internal tables. Where _object_id_ is the numerical form, _short_name_ is the short name, and _long_name_ is the long name. Returns +true+ if successful. Raises an OpenSSL::ASN1::ASN1Error if it fails. ;T;[o;= ;3I" overload;F;40;:%OpenSSL::ASN1::ObjectId.register;50;)I"GOpenSSL::ASN1::ObjectId.register(object_id, short_name, long_name);T;IC;";T; @l+;>0;!F;[;[;I";T;0;6i;[[I"object_id;T0[I"short_name;T0[I"long_name;T0; @l+;[;I":This adds a new ObjectId to the internal tables. Where _object_id_ is the numerical form, _short_name_ is the short name, and _long_name_ is the long name. Returns +true+ if successful. Raises an OpenSSL::ASN1::ASN1Error if it fails. @overload OpenSSL::ASN1::ObjectId.register(object_id, short_name, long_name);T;0; @l+;!F;"o;#;$T;%iÈ;&iÐ;'@j+;(I"static VALUE ossl_asn1obj_s_register(VALUE self, VALUE oid, VALUE sn, VALUE ln) { StringValueCStr(oid); StringValueCStr(sn); StringValueCStr(ln); if(!OBJ_create(RSTRING_PTR(oid), RSTRING_PTR(sn), RSTRING_PTR(ln))) ossl_raise(eASN1Error, NULL); return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"OpenSSL::ASN1::ObjectId#sn;F;[;[[@þÇiç;T;:sn;0;[;{;IC;"GThe short name of the ObjectId, as defined in . ;T;[o;= ;3I" overload;F;40;;/;50;)I"sn;T;IC;";T; @Ž+;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Ž+;[;I"@return [String];T;0;6i;[; @Ž+o;= ;3I" overload;F;40;:short_name;50;)I"short_name;T;IC;";T; @Ž+;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Ž+;[;I"@return [String];T;0;6i;[; @Ž+;[;I"ŒThe short name of the ObjectId, as defined in . @overload sn @return [String] @overload short_name @return [String];T;0; o;;F; ;;;;I"'OpenSSL::ASN1::ObjectId#short_name;F;[;[[@þÇi3;F;;0;;K;[;{;@•+;'@j+;)I"static VALUE;T;(I"ôstatic VALUE ossl_asn1obj_get_sn(VALUE self) { VALUE val, ret = Qnil; int nid; val = ossl_asn1_get_value(self); if ((nid = OBJ_txt2nid(StringValueCStr(val))) != NID_undef) ret = rb_str_new2(OBJ_nid2sn(nid)); return ret; };T;!F;"o;#;$T;%ià;&iæ;'@j+;(I"ôstatic VALUE ossl_asn1obj_get_sn(VALUE self) { VALUE val, ret = Qnil; int nid; val = ossl_asn1_get_value(self); if ((nid = OBJ_txt2nid(StringValueCStr(val))) != NID_undef) ret = rb_str_new2(OBJ_nid2sn(nid)); return ret; };T;)@º+;*To;;F; ;;;;I"OpenSSL::ASN1::ObjectId#ln;F;[;[[@þÇiû;T;:ln;0;[;{;IC;"FThe long name of the ObjectId, as defined in . ;T;[o;= ;3I" overload;F;40;;1;50;)I"ln;T;IC;";T; @¾+;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @¾+;[;I"@return [String];T;0;6i;[; @¾+o;= ;3I" overload;F;40;:long_name;50;)I"long_name;T;IC;";T; @¾+;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @¾+;[;I"@return [String];T;0;6i;[; @¾+;[;I"ŠThe long name of the ObjectId, as defined in . @overload ln @return [String] @overload long_name @return [String];T;0; o;;F; ;;;;I"&OpenSSL::ASN1::ObjectId#long_name;F;[;[[@þÇi4;F;;2;;K;[;{;@Å+;'@j+;)I"static VALUE;T;(I"ôstatic VALUE ossl_asn1obj_get_ln(VALUE self) { VALUE val, ret = Qnil; int nid; val = ossl_asn1_get_value(self); if ((nid = OBJ_txt2nid(StringValueCStr(val))) != NID_undef) ret = rb_str_new2(OBJ_nid2ln(nid)); return ret; };T;!F;"o;#;$T;%iô;&iú;'@j+;(I"ôstatic VALUE ossl_asn1obj_get_ln(VALUE self) { VALUE val, ret = Qnil; int nid; val = ossl_asn1_get_value(self); if ((nid = OBJ_txt2nid(StringValueCStr(val))) != NID_undef) ret = rb_str_new2(OBJ_nid2ln(nid)); return ret; };T;)@ê+;*To;;F; ;;;;I" OpenSSL::ASN1::ObjectId#oid;F;[;[[@þÇi=;T;;®;0;[;{;IC;"^Returns a String representing the Object Identifier in the dot notation, e.g. "1.2.3.4.5" ;T;[o;= ;3I" overload;F;40;;®;50;)I"oid;T;IC;";T; @î+;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @î+;[;I"@return [String];T;0;6i;[; @î+;[;I"|Returns a String representing the Object Identifier in the dot notation, e.g. "1.2.3.4.5" @overload oid @return [String];T;0; @î+;!F;"o;#;$T;%i6;&i;;'@j+;(I"/static VALUE ossl_asn1obj_get_oid(VALUE self) { VALUE str; ASN1_OBJECT *a1obj; int state; a1obj = obj_to_asn1obj(ossl_asn1_get_value(self)); str = rb_protect(asn1obj_get_oid_i, (VALUE)a1obj, &state); ASN1_OBJECT_free(a1obj); if (state) rb_jump_tag(state); return str; };T;)I"static VALUE;T;*T@³+@ã+o;;F; ;;;;I"OpenSSL::ASN1::ObjectId#==;F;[[I" other;T0;[[@þÇi;T;;`;0;[;{;IC;"7Returns +true+ if _other_oid_ is the same as _oid_ ;T;[o;= ;3I" overload;F;40;;`;50;)I"==(other_oid);T;IC;";T; @ ,;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ ,;[;I"@return [Boolean];T;0;6i;[[I"other_oid;T0; @ ,;[;I"eReturns +true+ if _other_oid_ is the same as _oid_ @overload ==(other_oid) @return [Boolean];T;0; @ ,;!F;"o;#;$T;%i;&i;'@j+;(I"Üstatic VALUE ossl_asn1obj_eq(VALUE self, VALUE other) { VALUE valSelf, valOther; int nidSelf, nidOther; valSelf = ossl_asn1_get_value(self); valOther = ossl_asn1_get_value(other); if ((nidSelf = OBJ_txt2nid(StringValueCStr(valSelf))) == NID_undef) ossl_raise(eASN1Error, "OBJ_txt2nid"); if ((nidOther = OBJ_txt2nid(StringValueCStr(valOther))) == NID_undef) ossl_raise(eASN1Error, "OBJ_txt2nid"); return nidSelf == nidOther ? Qtrue : Qfalse; };T;)I"static VALUE;T;*T;A@j+;BIC;[;A@j+;CIC;[;A@j+;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@³+;/@ã+;1;I[;[[@þÇi([@þÇi-;T;: ObjectId;;K;;;[;{;IC;"9Represents the primitive object id for OpenSSL::ASN1 ;T;[;[;I"; Represents the primitive object id for OpenSSL::ASN1 ;T;0; @j+;!F;"o;#;$T;%i(;&i*;'@‰);I"OpenSSL::ASN1::ObjectId;F;S@¶*;A@‰);BIC;[;A@‰);CIC;[;A@‰);DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@þÇi‚[@þÇiý;T;: ASN1;;K;;;[;{;IC;"îAbstract Syntax Notation One (or ASN.1) is a notation syntax to describe data structures and is defined in ITU-T X.680. ASN.1 itself does not mandate any encoding or parsing rules, but usually ASN.1 data structures are encoded using the Distinguished Encoding Rules (DER) or less often the Basic Encoding Rules (BER) described in ITU-T X.690. DER and BER encodings are binary Tag-Length-Value (TLV) encodings that are quite concise compared to other popular data description formats such as XML, JSON etc. ASN.1 data structures are very common in cryptographic applications, e.g. X.509 public key certificates or certificate revocation lists (CRLs) are all defined in ASN.1 and DER-encoded. ASN.1, DER and BER are the building blocks of applied cryptography. The ASN1 module provides the necessary classes that allow generation of ASN.1 data structures and the methods to encode them using a DER encoding. The decode method allows parsing arbitrary BER-/DER-encoded data to a Ruby object that can then be modified and re-encoded at will. == ASN.1 class hierarchy The base class representing ASN.1 structures is ASN1Data. ASN1Data offers attributes to read and set the _tag_, the _tag_class_ and finally the _value_ of a particular ASN.1 item. Upon parsing, any tagged values (implicit or explicit) will be represented by ASN1Data instances because their "real type" can only be determined using out-of-band information from the ASN.1 type declaration. Since this information is normally known when encoding a type, all sub-classes of ASN1Data offer an additional attribute _tagging_ that allows to encode a value implicitly (+:IMPLICIT+) or explicitly (+:EXPLICIT+). === Constructive Constructive is, as its name implies, the base class for all constructed encodings, i.e. those that consist of several values, opposed to "primitive" encodings with just one single value. The value of an Constructive is always an Array. ==== ASN1::Set and ASN1::Sequence The most common constructive encodings are SETs and SEQUENCEs, which is why there are two sub-classes of Constructive representing each of them. === Primitive This is the super class of all primitive values. Primitive itself is not used when parsing ASN.1 data, all values are either instances of a corresponding sub-class of Primitive or they are instances of ASN1Data if the value was tagged implicitly or explicitly. Please cf. Primitive documentation for details on sub-classes and their respective mappings of ASN.1 data types to Ruby objects. == Possible values for _tagging_ When constructing an ASN1Data object the ASN.1 type definition may require certain elements to be either implicitly or explicitly tagged. This can be achieved by setting the _tagging_ attribute manually for sub-classes of ASN1Data. Use the symbol +:IMPLICIT+ for implicit tagging and +:EXPLICIT+ if the element requires explicit tagging. == Possible values for _tag_class_ It is possible to create arbitrary ASN1Data objects that also support a PRIVATE or APPLICATION tag class. Possible values for the _tag_class_ attribute are: * +:UNIVERSAL+ (the default for untagged values) * +:CONTEXT_SPECIFIC+ (the default for tagged values) * +:APPLICATION+ * +:PRIVATE+ == Tag constants There is a constant defined for each universal tag: * OpenSSL::ASN1::EOC (0) * OpenSSL::ASN1::BOOLEAN (1) * OpenSSL::ASN1::INTEGER (2) * OpenSSL::ASN1::BIT_STRING (3) * OpenSSL::ASN1::OCTET_STRING (4) * OpenSSL::ASN1::NULL (5) * OpenSSL::ASN1::OBJECT (6) * OpenSSL::ASN1::ENUMERATED (10) * OpenSSL::ASN1::UTF8STRING (12) * OpenSSL::ASN1::SEQUENCE (16) * OpenSSL::ASN1::SET (17) * OpenSSL::ASN1::NUMERICSTRING (18) * OpenSSL::ASN1::PRINTABLESTRING (19) * OpenSSL::ASN1::T61STRING (20) * OpenSSL::ASN1::VIDEOTEXSTRING (21) * OpenSSL::ASN1::IA5STRING (22) * OpenSSL::ASN1::UTCTIME (23) * OpenSSL::ASN1::GENERALIZEDTIME (24) * OpenSSL::ASN1::GRAPHICSTRING (25) * OpenSSL::ASN1::ISO64STRING (26) * OpenSSL::ASN1::GENERALSTRING (27) * OpenSSL::ASN1::UNIVERSALSTRING (28) * OpenSSL::ASN1::BMPSTRING (30) == UNIVERSAL_TAG_NAME constant An Array that stores the name of a given tag number. These names are the same as the name of the tag constant that is additionally defined, e.g. UNIVERSAL_TAG_NAME[2] = "INTEGER" and OpenSSL::ASN1::INTEGER = 2. == Example usage === Decoding and viewing a DER-encoded file require 'openssl' require 'pp' der = File.binread('data.der') asn1 = OpenSSL::ASN1.decode(der) pp der === Creating an ASN.1 structure and DER-encoding it require 'openssl' version = OpenSSL::ASN1::Integer.new(1) # Explicitly 0-tagged implies context-specific tag class serial = OpenSSL::ASN1::Integer.new(12345, 0, :EXPLICIT, :CONTEXT_SPECIFIC) name = OpenSSL::ASN1::PrintableString.new('Data 1') sequence = OpenSSL::ASN1::Sequence.new( [ version, serial, name ] ) der = sequence.to_der;T;[;[;I"ð Abstract Syntax Notation One (or ASN.1) is a notation syntax to describe data structures and is defined in ITU-T X.680. ASN.1 itself does not mandate any encoding or parsing rules, but usually ASN.1 data structures are encoded using the Distinguished Encoding Rules (DER) or less often the Basic Encoding Rules (BER) described in ITU-T X.690. DER and BER encodings are binary Tag-Length-Value (TLV) encodings that are quite concise compared to other popular data description formats such as XML, JSON etc. ASN.1 data structures are very common in cryptographic applications, e.g. X.509 public key certificates or certificate revocation lists (CRLs) are all defined in ASN.1 and DER-encoded. ASN.1, DER and BER are the building blocks of applied cryptography. The ASN1 module provides the necessary classes that allow generation of ASN.1 data structures and the methods to encode them using a DER encoding. The decode method allows parsing arbitrary BER-/DER-encoded data to a Ruby object that can then be modified and re-encoded at will. == ASN.1 class hierarchy The base class representing ASN.1 structures is ASN1Data. ASN1Data offers attributes to read and set the _tag_, the _tag_class_ and finally the _value_ of a particular ASN.1 item. Upon parsing, any tagged values (implicit or explicit) will be represented by ASN1Data instances because their "real type" can only be determined using out-of-band information from the ASN.1 type declaration. Since this information is normally known when encoding a type, all sub-classes of ASN1Data offer an additional attribute _tagging_ that allows to encode a value implicitly (+:IMPLICIT+) or explicitly (+:EXPLICIT+). === Constructive Constructive is, as its name implies, the base class for all constructed encodings, i.e. those that consist of several values, opposed to "primitive" encodings with just one single value. The value of an Constructive is always an Array. ==== ASN1::Set and ASN1::Sequence The most common constructive encodings are SETs and SEQUENCEs, which is why there are two sub-classes of Constructive representing each of them. === Primitive This is the super class of all primitive values. Primitive itself is not used when parsing ASN.1 data, all values are either instances of a corresponding sub-class of Primitive or they are instances of ASN1Data if the value was tagged implicitly or explicitly. Please cf. Primitive documentation for details on sub-classes and their respective mappings of ASN.1 data types to Ruby objects. == Possible values for _tagging_ When constructing an ASN1Data object the ASN.1 type definition may require certain elements to be either implicitly or explicitly tagged. This can be achieved by setting the _tagging_ attribute manually for sub-classes of ASN1Data. Use the symbol +:IMPLICIT+ for implicit tagging and +:EXPLICIT+ if the element requires explicit tagging. == Possible values for _tag_class_ It is possible to create arbitrary ASN1Data objects that also support a PRIVATE or APPLICATION tag class. Possible values for the _tag_class_ attribute are: * +:UNIVERSAL+ (the default for untagged values) * +:CONTEXT_SPECIFIC+ (the default for tagged values) * +:APPLICATION+ * +:PRIVATE+ == Tag constants There is a constant defined for each universal tag: * OpenSSL::ASN1::EOC (0) * OpenSSL::ASN1::BOOLEAN (1) * OpenSSL::ASN1::INTEGER (2) * OpenSSL::ASN1::BIT_STRING (3) * OpenSSL::ASN1::OCTET_STRING (4) * OpenSSL::ASN1::NULL (5) * OpenSSL::ASN1::OBJECT (6) * OpenSSL::ASN1::ENUMERATED (10) * OpenSSL::ASN1::UTF8STRING (12) * OpenSSL::ASN1::SEQUENCE (16) * OpenSSL::ASN1::SET (17) * OpenSSL::ASN1::NUMERICSTRING (18) * OpenSSL::ASN1::PRINTABLESTRING (19) * OpenSSL::ASN1::T61STRING (20) * OpenSSL::ASN1::VIDEOTEXSTRING (21) * OpenSSL::ASN1::IA5STRING (22) * OpenSSL::ASN1::UTCTIME (23) * OpenSSL::ASN1::GENERALIZEDTIME (24) * OpenSSL::ASN1::GRAPHICSTRING (25) * OpenSSL::ASN1::ISO64STRING (26) * OpenSSL::ASN1::GENERALSTRING (27) * OpenSSL::ASN1::UNIVERSALSTRING (28) * OpenSSL::ASN1::BMPSTRING (30) == UNIVERSAL_TAG_NAME constant An Array that stores the name of a given tag number. These names are the same as the name of the tag constant that is additionally defined, e.g. UNIVERSAL_TAG_NAME[2] = "INTEGER" and OpenSSL::ASN1::INTEGER = 2. == Example usage === Decoding and viewing a DER-encoded file require 'openssl' require 'pp' der = File.binread('data.der') asn1 = OpenSSL::ASN1.decode(der) pp der === Creating an ASN.1 structure and DER-encoding it require 'openssl' version = OpenSSL::ASN1::Integer.new(1) # Explicitly 0-tagged implies context-specific tag class serial = OpenSSL::ASN1::Integer.new(12345, 0, :EXPLICIT, :CONTEXT_SPECIFIC) name = OpenSSL::ASN1::PrintableString.new('Data 1') sequence = OpenSSL::ASN1::Sequence.new( [ version, serial, name ] ) der = sequence.to_der ;T;0; @‰);!F;"o;#;$T;%i‚;&iú;6i;'@ÃÇ;I"OpenSSL::ASN1;Fo; ;IC;[o; ;IC;[;A@N,;BIC;[;A@N,;CIC;[;A@N,;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@öÇi–;T;:DigestError;;K;;;[;{;IC;"YGeneric Exception class that is raised if an error occurs during a Digest operation. ;T;[;[;I"[ Generic Exception class that is raised if an error occurs during a Digest operation. ;T;0; @N,;!F;"o;#;$T;%i–;&i™;'o;L;M@;NI"OpenSSL::Digest;T;:Digest;'o;L;M0;N0;O0;;;'@;Q@ÃÇ;R0;Q@L,;O0;R0;I"!OpenSSL::Digest::DigestError;F;So;L;M0;N0;O0;;T;'@;Q@];R0;A@L,;BIC;[;A@L,;CIC;[;A@L,;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@öÇiA;T;;6;;K;;;[;{;IC;".OpenSSL::Digest allows you to compute message digests (sometimes interchangeably called "hashes") of arbitrary data that are cryptographically secure, i.e. a Digest implements a secure one-way function. One-way functions offer some useful properties. E.g. given two distinct inputs the probability that both yield the same output is highly unlikely. Combined with the fact that every message digest algorithm has a fixed-length output of just a few bytes, digests are often used to create unique identifiers for arbitrary data. A common example is the creation of a unique id for binary documents that are stored in a database. Another useful characteristic of one-way functions (and thus the name) is that given a digest there is no indication about the original data that produced it, i.e. the only way to identify the original input is to "brute-force" through every possible combination of inputs. These characteristics make one-way functions also ideal companions for public key signature algorithms: instead of signing an entire document, first a hash of the document is produced with a considerably faster message digest algorithm and only the few bytes of its output need to be signed using the slower public key algorithm. To validate the integrity of a signed document, it suffices to re-compute the hash and verify that it is equal to that in the signature. You can get a list of all digest algorithms supported on your system by running this command in your terminal: openssl list -digest-algorithms Among the OpenSSL 1.1.1 supported message digest algorithms are: * SHA224, SHA256, SHA384, SHA512, SHA512-224 and SHA512-256 * SHA3-224, SHA3-256, SHA3-384 and SHA3-512 * BLAKE2s256 and BLAKE2b512 Each of these algorithms can be instantiated using the name: digest = OpenSSL::Digest.new('SHA256') "Breaking" a message digest algorithm means defying its one-way function characteristics, i.e. producing a collision or finding a way to get to the original data by means that are more efficient than brute-forcing etc. Most of the supported digest algorithms can be considered broken in this sense, even the very popular MD5 and SHA1 algorithms. Should security be your highest concern, then you should probably rely on SHA224, SHA256, SHA384 or SHA512. === Hashing a file data = File.read('document') sha256 = OpenSSL::Digest.new('SHA256') digest = sha256.digest(data) === Hashing several pieces of data at once data1 = File.read('file1') data2 = File.read('file2') data3 = File.read('file3') sha256 = OpenSSL::Digest.new('SHA256') sha256 << data1 sha256 << data2 sha256 << data3 digest = sha256.digest === Reuse a Digest instance data1 = File.read('file1') sha256 = OpenSSL::Digest.new('SHA256') digest1 = sha256.digest(data1) data2 = File.read('file2') sha256.reset digest2 = sha256.digest(data2);T;[;[;I"1 OpenSSL::Digest allows you to compute message digests (sometimes interchangeably called "hashes") of arbitrary data that are cryptographically secure, i.e. a Digest implements a secure one-way function. One-way functions offer some useful properties. E.g. given two distinct inputs the probability that both yield the same output is highly unlikely. Combined with the fact that every message digest algorithm has a fixed-length output of just a few bytes, digests are often used to create unique identifiers for arbitrary data. A common example is the creation of a unique id for binary documents that are stored in a database. Another useful characteristic of one-way functions (and thus the name) is that given a digest there is no indication about the original data that produced it, i.e. the only way to identify the original input is to "brute-force" through every possible combination of inputs. These characteristics make one-way functions also ideal companions for public key signature algorithms: instead of signing an entire document, first a hash of the document is produced with a considerably faster message digest algorithm and only the few bytes of its output need to be signed using the slower public key algorithm. To validate the integrity of a signed document, it suffices to re-compute the hash and verify that it is equal to that in the signature. You can get a list of all digest algorithms supported on your system by running this command in your terminal: openssl list -digest-algorithms Among the OpenSSL 1.1.1 supported message digest algorithms are: * SHA224, SHA256, SHA384, SHA512, SHA512-224 and SHA512-256 * SHA3-224, SHA3-256, SHA3-384 and SHA3-512 * BLAKE2s256 and BLAKE2b512 Each of these algorithms can be instantiated using the name: digest = OpenSSL::Digest.new('SHA256') "Breaking" a message digest algorithm means defying its one-way function characteristics, i.e. producing a collision or finding a way to get to the original data by means that are more efficient than brute-forcing etc. Most of the supported digest algorithms can be considered broken in this sense, even the very popular MD5 and SHA1 algorithms. Should security be your highest concern, then you should probably rely on SHA224, SHA256, SHA384 or SHA512. === Hashing a file data = File.read('document') sha256 = OpenSSL::Digest.new('SHA256') digest = sha256.digest(data) === Hashing several pieces of data at once data1 = File.read('file1') data2 = File.read('file2') data3 = File.read('file3') sha256 = OpenSSL::Digest.new('SHA256') sha256 << data1 sha256 << data2 sha256 << data3 digest = sha256.digest === Reuse a Digest instance data1 = File.read('file1') sha256 = OpenSSL::Digest.new('SHA256') digest1 = sha256.digest(data1) data2 = File.read('file2') sha256.reset digest2 = sha256.digest(data2) ;T;0; @L,;!F;"o;#;$T;%iA;&i;6i;'@b,;I"OpenSSL::Digest;F;So;L;M0;N0;O0;;T;'@;Q@];R0o; ;IC;[o; ;IC;[;A@y,;BIC;[;A@y,;CIC;[;A@y,;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@Èit[@Èi„;T;:SPKIError;;K;;;[;{;IC;"}Generic Exception class that is raised if an error occurs during an operation on an instance of OpenSSL::Netscape::SPKI. ;T;[;[;I" Generic Exception class that is raised if an error occurs during an operation on an instance of OpenSSL::Netscape::SPKI. ;T;0; @y,;!F;"o;#;$T;%it;&iw;'o;L;M@;NI"OpenSSL::Netscape;T;: Netscape;'o;L;M0;N0;O0;;;'@;Q@ÃÇ;R0;Q@w,;O0;R0;I"!OpenSSL::Netscape::SPKIError;F;S@ÅÇo; ;IC;[o;;F; ;;;;I"'OpenSSL::Netscape::SPKI#initialize;T;[[@c0;[[@ÈiS;T;;Ð;0;[;{;IC;"T=== Parameters * _request_ - optional raw request, either in PEM or DER format. ;T;[o;= ;3I" overload;F;40;;î;50;)I"new([request]);T;IC;";T; @’,;>0;!F;[;[;I";T;0;6i;[[I"[request];T0; @’,;[;I"o=== Parameters * _request_ - optional raw request, either in PEM or DER format. @overload new([request]);T;0; @’,;!F;"o;#;$T;%iL;&iP;'@,;(I"Rstatic VALUE ossl_spki_initialize(int argc, VALUE *argv, VALUE self) { NETSCAPE_SPKI *spki; VALUE buffer; const unsigned char *p; if (rb_scan_args(argc, argv, "01", &buffer) == 0) { return self; } StringValue(buffer); if (!(spki = NETSCAPE_SPKI_b64_decode(RSTRING_PTR(buffer), RSTRING_LENINT(buffer)))) { ossl_clear_error(); p = (unsigned char *)RSTRING_PTR(buffer); if (!(spki = d2i_NETSCAPE_SPKI(NULL, &p, RSTRING_LEN(buffer)))) { ossl_raise(eSPKIError, NULL); } } NETSCAPE_SPKI_free(DATA_PTR(self)); SetSPKI(self, spki); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::Netscape::SPKI#to_der;T;[;[[@Èiq;T;;°;0;[;{;IC;"+Returns the DER encoding of this SPKI. ;T;[o;= ;3I" overload;F;40;;°;50;)I"to_der;T;IC;";T; @«,;>0;!F;[;[;I";T;0;6i;[; @«,;[;I">Returns the DER encoding of this SPKI. @overload to_der;T;0; @«,;!F;"o;#;$T;%ik;∈'@,;(I"¼static VALUE ossl_spki_to_der(VALUE self) { NETSCAPE_SPKI *spki; VALUE str; long len; unsigned char *p; GetSPKI(self, spki); if ((len = i2d_NETSCAPE_SPKI(spki, NULL)) <= 0) ossl_raise(eX509CertError, NULL); str = rb_str_new(0, len); p = (unsigned char *)RSTRING_PTR(str); if (i2d_NETSCAPE_SPKI(spki, &p) <= 0) ossl_raise(eX509CertError, NULL); ossl_str_adjust(str, p); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::Netscape::SPKI#to_pem;T;[;[[@Èi†;T;;³;0;[;{;IC;"+Returns the PEM encoding of this SPKI. ;T;[o;= ;3I" overload;F;40;;³;50;)I"to_pem;T;IC;";T; @Á,;>0;!F;[;[;I";T;0;6i;[; @Á,;[;I">Returns the PEM encoding of this SPKI. @overload to_pem;T;0; o;;F; ;;;;I"!OpenSSL::Netscape::SPKI#to_s;T;[;[[@Èi;F;;q;;K;[;{;@È,;'@,;)I"static VALUE;T;(I""static VALUE ossl_spki_to_pem(VALUE self) { NETSCAPE_SPKI *spki; char *data; VALUE str; GetSPKI(self, spki); if (!(data = NETSCAPE_SPKI_b64_encode(spki))) { ossl_raise(eSPKIError, NULL); } str = ossl_buf2str(data, rb_long2int(strlen(data))); return str; };T;!F;"o;#;$T;%i€;&iƒ;'@,;(I""static VALUE ossl_spki_to_pem(VALUE self) { NETSCAPE_SPKI *spki; char *data; VALUE str; GetSPKI(self, spki); if (!(data = NETSCAPE_SPKI_b64_encode(spki))) { ossl_raise(eSPKIError, NULL); } str = ossl_buf2str(data, rb_long2int(strlen(data))); return str; };T;)@Û,;*T@Ô,o;;F; ;;;;I"$OpenSSL::Netscape::SPKI#to_text;T;[;[[@Èi;T;;´;0;[;{;IC;"RReturns a textual representation of this SPKI, useful for debugging purposes. ;T;[o;= ;3I" overload;F;40;;´;50;)I"to_text;T;IC;";T; @ß,;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ß,;[;I"@return [String];T;0;6i;[; @ß,;[;I"yReturns a textual representation of this SPKI, useful for debugging purposes. @overload to_text @return [String];T;0; @ß,;!F;"o;#;$T;%i–;&i›;'@,;(I"=static VALUE ossl_spki_print(VALUE self) { NETSCAPE_SPKI *spki; BIO *out; GetSPKI(self, spki); if (!(out = BIO_new(BIO_s_mem()))) { ossl_raise(eSPKIError, NULL); } if (!NETSCAPE_SPKI_print(out, spki)) { BIO_free(out); ossl_raise(eSPKIError, NULL); } return ossl_membio2str(out); };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::Netscape::SPKI#public_key;T;[;[[@Èi¶;T;;Â;0;[;{;IC;"SReturns the public key associated with the SPKI, an instance of OpenSSL::PKey. ;T;[o;= ;3I" overload;F;40;;Â;50;)I"public_key;T;IC;";T; @ú,;>0;!F;[;[;I";T;0;6i;[; @ú,;[;I"jReturns the public key associated with the SPKI, an instance of OpenSSL::PKey. @overload public_key;T;0; @ú,;!F;"o;#;$T;%i¯;&i³;'@,;(I" static VALUE ossl_spki_get_public_key(VALUE self) { NETSCAPE_SPKI *spki; EVP_PKEY *pkey; GetSPKI(self, spki); if (!(pkey = NETSCAPE_SPKI_get_pubkey(spki))) { /* adds an reference */ ossl_raise(eSPKIError, NULL); } return ossl_pkey_new(pkey); /* NO DUP - OK */ };T;)I"static VALUE;T;*To;;F; ;;;;I"(OpenSSL::Netscape::SPKI#public_key=;T;[[I"key;T0;[[@ÈiÏ;T;;Ã;0;[;{;IC;"ð=== Parameters * _pub_ - the public key to be set for this instance Sets the public key to be associated with the SPKI, an instance of OpenSSL::PKey. This should be the public key corresponding to the private key used for signing the SPKI. ;T;[o;= ;3I" overload;F;40;;Ã;50;)I"public_key=(pub);T;IC;";T; @-;>0;!F;[;[;I";T;0;6i;[[I"pub;T0; @-;[;I" === Parameters * _pub_ - the public key to be set for this instance Sets the public key to be associated with the SPKI, an instance of OpenSSL::PKey. This should be the public key corresponding to the private key used for signing the SPKI. @overload public_key=(pub);T;0; @-;!F;"o;#;$T;%iÄ;&iÌ;'@,;(I"=static VALUE ossl_spki_set_public_key(VALUE self, VALUE key) { NETSCAPE_SPKI *spki; EVP_PKEY *pkey; GetSPKI(self, spki); pkey = GetPKeyPtr(key); ossl_pkey_check_public_key(pkey); if (!NETSCAPE_SPKI_set_pubkey(spki, pkey)) ossl_raise(eSPKIError, "NETSCAPE_SPKI_set_pubkey"); return key; };T;)I"static VALUE;T;*To;;F; ;;;;I"!OpenSSL::Netscape::SPKI#sign;T;[[I"key;T0[I"digest;T0;[[@Èi;T;;Ä;0;[;{;IC;"o=== Parameters * _key_ - the private key to be used for signing this instance * _digest_ - the digest to be used for signing this instance To sign an SPKI, the private key corresponding to the public key set for this instance should be used, in addition to a digest algorithm in the form of an OpenSSL::Digest. The private key should be an instance of OpenSSL::PKey. ;T;[o;= ;3I" overload;F;40;;Ä;50;)I"sign(key, digest);T;IC;";T; @*-;>0;!F;[;[;I";T;0;6i;[[I"key;T0[I"digest;T0; @*-;[;I"=== Parameters * _key_ - the private key to be used for signing this instance * _digest_ - the digest to be used for signing this instance To sign an SPKI, the private key corresponding to the public key set for this instance should be used, in addition to a digest algorithm in the form of an OpenSSL::Digest. The private key should be an instance of OpenSSL::PKey. @overload sign(key, digest);T;0; @*-;!F;"o;#;$T;%i;&i;'@,;(I"hstatic VALUE ossl_spki_sign(VALUE self, VALUE key, VALUE digest) { NETSCAPE_SPKI *spki; EVP_PKEY *pkey; const EVP_MD *md; pkey = GetPrivPKeyPtr(key); /* NO NEED TO DUP */ md = ossl_evp_get_digestbyname(digest); GetSPKI(self, spki); if (!NETSCAPE_SPKI_sign(spki, pkey, md)) { ossl_raise(eSPKIError, NULL); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"#OpenSSL::Netscape::SPKI#verify;T;[[I"key;T0;[[@Èi3;T;;Å;0;[;{;IC;"Ý=== Parameters * _key_ - the public key to be used for verifying the SPKI signature Returns +true+ if the signature is valid, +false+ otherwise. To verify an SPKI, the public key contained within the SPKI should be used. ;T;[o;= ;3I" overload;F;40;;Å;50;)I"verify(key);T;IC;";T; @H-;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @H-;[;I"@return [Boolean];T;0;6i;[[I"key;T0; @H-;[;I" === Parameters * _key_ - the public key to be used for verifying the SPKI signature Returns +true+ if the signature is valid, +false+ otherwise. To verify an SPKI, the public key contained within the SPKI should be used. @overload verify(key) @return [Boolean];T;0; @H-;!F;"o;#;$T;%i);&i1;'@,;(I"‡static VALUE ossl_spki_verify(VALUE self, VALUE key) { NETSCAPE_SPKI *spki; EVP_PKEY *pkey; GetSPKI(self, spki); pkey = GetPKeyPtr(key); ossl_pkey_check_public_key(pkey); switch (NETSCAPE_SPKI_verify(spki, pkey)) { case 0: ossl_clear_error(); return Qfalse; case 1: return Qtrue; default: ossl_raise(eSPKIError, "NETSCAPE_SPKI_verify"); } };T;)I"static VALUE;T;*To;;F; ;;;;I"&OpenSSL::Netscape::SPKI#challenge;T;[;[[@Èiã;T;:challenge;0;[;{;IC;"0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @g-;[;I"@return [String];T;0;6i;[; @g-;[;I"eReturns the challenge string associated with this SPKI. @overload challenge @return [String];T;0; @g-;!F;"o;#;$T;%iÝ;&iá;'@,;(I"Istatic VALUE ossl_spki_get_challenge(VALUE self) { NETSCAPE_SPKI *spki; GetSPKI(self, spki); if (spki->spkac->challenge->length <= 0) { OSSL_Debug("Challenge.length <= 0?"); return rb_str_new(0, 0); } return rb_str_new((const char *)spki->spkac->challenge->data, spki->spkac->challenge->length); };T;)I"static VALUE;T;*To;;F; ;;;;I"'OpenSSL::Netscape::SPKI#challenge=;T;[[I"str;T0;[[@Èiü;T;:challenge=;0;[;{;IC;"°=== Parameters * _str_ - the challenge string to be set for this instance Sets the challenge to be associated with the SPKI. May be used by the server, e.g. to prevent replay. ;T;[o;= ;3I" overload;F;40;;:;50;)I"challenge=(str);T;IC;";T; @‚-;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @‚-;[;I"@return [String];T;0;6i;[[I"str;T0; @‚-;[;I"ß=== Parameters * _str_ - the challenge string to be set for this instance Sets the challenge to be associated with the SPKI. May be used by the server, e.g. to prevent replay. @overload challenge=(str) @return [String];T;0; @‚-;!F;"o;#;$T;%iò;&iú;'@,;(I"static VALUE ossl_spki_set_challenge(VALUE self, VALUE str) { NETSCAPE_SPKI *spki; StringValue(str); GetSPKI(self, spki); if (!ASN1_STRING_set(spki->spkac->challenge, RSTRING_PTR(str), RSTRING_LENINT(str))) { ossl_raise(eSPKIError, NULL); } return str; };T;)I"static VALUE;T;*T;A@,;BIC;[;A@,;CIC;[;A@,;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@Ô,;³;I[;[[@ÈiG[@Èi†;T;: SPKI;;K;;;[;{;IC;"9A Simple Public Key Infrastructure implementation (pronounced "spooky"). The structure is defined as PublicKeyAndChallenge ::= SEQUENCE { spki SubjectPublicKeyInfo, challenge IA5STRING } SignedPublicKeyAndChallenge ::= SEQUENCE { publicKeyAndChallenge PublicKeyAndChallenge, signatureAlgorithm AlgorithmIdentifier, signature BIT STRING } where the definitions of SubjectPublicKeyInfo and AlgorithmIdentifier can be found in RFC5280. SPKI is typically used in browsers for generating a public/private key pair and a subsequent certificate request, using the HTML element. == Examples === Creating an SPKI key = OpenSSL::PKey::RSA.new 2048 spki = OpenSSL::Netscape::SPKI.new spki.challenge = "RandomChallenge" spki.public_key = key.public_key spki.sign(key, OpenSSL::Digest.new('SHA256')) #send a request containing this to a server generating a certificate === Verifying an SPKI request request = #... spki = OpenSSL::Netscape::SPKI.new request unless spki.verify(spki.public_key) # signature is invalid end #proceed;T;[;[;I"; A Simple Public Key Infrastructure implementation (pronounced "spooky"). The structure is defined as PublicKeyAndChallenge ::= SEQUENCE { spki SubjectPublicKeyInfo, challenge IA5STRING } SignedPublicKeyAndChallenge ::= SEQUENCE { publicKeyAndChallenge PublicKeyAndChallenge, signatureAlgorithm AlgorithmIdentifier, signature BIT STRING } where the definitions of SubjectPublicKeyInfo and AlgorithmIdentifier can be found in RFC5280. SPKI is typically used in browsers for generating a public/private key pair and a subsequent certificate request, using the HTML element. == Examples === Creating an SPKI key = OpenSSL::PKey::RSA.new 2048 spki = OpenSSL::Netscape::SPKI.new spki.challenge = "RandomChallenge" spki.public_key = key.public_key spki.sign(key, OpenSSL::Digest.new('SHA256')) #send a request containing this to a server generating a certificate === Verifying an SPKI request request = #... spki = OpenSSL::Netscape::SPKI.new request unless spki.verify(spki.public_key) # signature is invalid end #proceed ;T;0; @,;!F;"o;#;$T;%iG;ⅈ6i;'o;L;M@;NI"OpenSSL::Netscape;T;;8;'@Ž,;Q@w,;O0;R0;I"OpenSSL::Netscape::SPKI;T;S@];A@w,;BIC;[;A@w,;CIC;[;A@w,;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@Èil[@Èi‚;T;;8;;K;;;[;{;IC;"ñOpenSSL::Netscape is a namespace for SPKI (Simple Public Key Infrastructure) which implements Signed Public Key and Challenge. See {RFC 2692}[http://tools.ietf.org/html/rfc2692] and {RFC 2693}[http://tools.ietf.org/html/rfc2692] for details.;T;[;[;I"ó OpenSSL::Netscape is a namespace for SPKI (Simple Public Key Infrastructure) which implements Signed Public Key and Challenge. See {RFC 2692}[http://tools.ietf.org/html/rfc2692] and {RFC 2693}[http://tools.ietf.org/html/rfc2692] for details. ;T;0; @w,;!F;"o;#;$T;%il;&iq;6i;'@Ž,;I"OpenSSL::Netscape;F;A@ÃÇ;BIC;[;A@ÃÇ;CIC;[;A@ÃÇ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[ [@ÐÇi4[@ÒÇiJ[@ÔÇiR[@ÖÇi [@ØÇi@[@ÚÇiÊ[@ÜÇi7[@ÞÇi³[@àÇiÇ[@âÇiP[@äÇiÎ [@æÇiˆ[@èÇi[@êÇiü[@ýÔi&[@ìÇiï[@îÇi¦[@ðÇi[@òÇiœ[@|$iä[@ôÇií[@öÇi=[@øÇi[@úÇi[@üÇi[@þÇip[@Èi~;F;;;;K;;;[;{;IC;";T;[;[;@|;0; @ÃÇ;6i;'@;I"OpenSSL;Fo; ;IC;[$o;;F; ;;;;I"Rational#numerator;F;[;[[@¨ i?;T;;H;0;[;{;IC;"°Returns the numerator. Rational(7).numerator #=> 7 Rational(7, 1).numerator #=> 7 Rational(9, -4).numerator #=> -9 Rational(-2, -10).numerator #=> 1 ;T;[o;= ;3I" overload;F;40;;H;50;)I"numerator;T;IC;";T; @ò-;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ò-;[;I"@return [Integer];T;0;6i;[; @ò-;[;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;"o;#;$T;%i4;&i=;'@ð-;(I"Zstatic VALUE nurat_numerator(VALUE self) { get_dat1(self); return dat->num; };T;)I"static VALUE;T;*To;;F; ;;;;I"Rational#denominator;F;[;[[@¨ iQ;T;;I;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 ;T;[o;= ;3I" overload;F;40;;I;50;)I"denominator;T;IC;";T; @ .;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ .;[;I"@return [Integer];T;0;6i;[; @ .;[;I"Returns the denominator (always positive). Rational(7).denominator #=> 1 Rational(7, 1).denominator #=> 1 Rational(9, -4).denominator #=> 4 Rational(-2, -10).denominator #=> 5 @overload denominator @return [Integer];T;0; @ .;!F;"o;#;$T;%iF;&iO;'@ð-;(I"\static VALUE nurat_denominator(VALUE self) { get_dat1(self); return dat->den; };T;)I"static VALUE;T;*To;;F; ;;;;I"Rational#-@;F;[;[[@¨ i^;T;;9;0;[;{;IC;"Negates +rat+. ;T;[o;= ;3I" overload;F;40;;;50;)I" -rat;T;IC;";T; @(.;>0;!F;[;[;I";T;0;6i;[; @(.;[;I"$Negates +rat+. @overload -rat;T;0; @(.;!F;"o;#;$T;%iX;&i[;'@ð-;(I"ÞVALUE rb_rational_uminus(VALUE self) { const int unused = (assert(RB_TYPE_P(self, T_RATIONAL)), 0); get_dat1(self); (void)unused; return f_rational_new2(CLASS_OF(self), rb_int_uminus(dat->num), dat->den); };T;)I" VALUE;T;*To;;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) #=> (901/1) Rational(-2, 9) + Rational(-9, 2) #=> (-85/18) Rational(9, 8) + 4 #=> (41/8) Rational(20, 9) + 9.8 #=> 12.022222222222222 ;T;[o;= ;3I" overload;F;40;;&;50;)I"+(numeric);T;IC;";T; @>.;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @>.;[;I"@return [Numeric];T;0;6i;[[I"numeric;T0; @>.;[;I"APerforms addition. Rational(2, 3) + Rational(2, 3) #=> (4/3) Rational(900) + Rational(1) #=> (901/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; @>.;!F;"o;#;$T;%iÃ;&iÍ;'@ð-;(I"\VALUE rb_rational_plus(VALUE self, VALUE other) { if (RB_INTEGER_TYPE_P(other)) { { get_dat1(self); return f_rational_new_no_reduce2(CLASS_OF(self), rb_int_plus(dat->num, rb_int_mul(other, dat->den)), dat->den); } } else if (RB_FLOAT_TYPE_P(other)) { return DBL2NUM(nurat_to_double(self) + RFLOAT_VALUE(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;)I" VALUE;T;*To;;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;= ;3I" overload;F;40;;;50;)I"-(numeric);T;IC;";T; @].;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @].;[;I"@return [Numeric];T;0;6i;[[I"numeric;T0; @].;[;I"DPerforms 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"^VALUE rb_rational_minus(VALUE self, VALUE other) { if (RB_INTEGER_TYPE_P(other)) { { get_dat1(self); return f_rational_new_no_reduce2(CLASS_OF(self), rb_int_minus(dat->num, rb_int_mul(other, dat->den)), dat->den); } } else if (RB_FLOAT_TYPE_P(other)) { return DBL2NUM(nurat_to_double(self) - RFLOAT_VALUE(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;)I" VALUE;T;*To;;F; ;;;;I"Rational#*;F;[[I" other;T0;[[@¨ iX;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;= ;3I" overload;F;40;;';50;)I"*(numeric);T;IC;";T; @|.;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @|.;[;I"@return [Numeric];T;0;6i;[[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;%iL;&iV;'@ð-;(I"!VALUE rb_rational_mul(VALUE self, VALUE other) { if (RB_INTEGER_TYPE_P(other)) { { get_dat1(self); return f_muldiv(self, dat->num, dat->den, other, ONE, '*'); } } else if (RB_FLOAT_TYPE_P(other)) { return DBL2NUM(nurat_to_double(self) * RFLOAT_VALUE(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;)I" VALUE;T;*To;;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;= ;3I" overload;F;40;;:;50;)I"/(numeric);T;IC;";T; @›.;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @›.;[;I"@return [Numeric];T;0;6i;[[I"numeric;T0; @›.o;= ;3I" overload;F;40;;;;50;)I"quo(numeric);T;IC;";T; @›.;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @›.;[;I"@return [Numeric];T;0;6i;[[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;%iu;&i;'@ð-;(I"VALUE rb_rational_div(VALUE self, VALUE other) { if (RB_INTEGER_TYPE_P(other)) { if (f_zero_p(other)) rb_num_zerodiv(); { get_dat1(self); return f_muldiv(self, dat->num, dat->den, other, ONE, '/'); } } else if (RB_FLOAT_TYPE_P(other)) { VALUE v = nurat_to_f(self); return rb_flo_div_flo(v, other); } else if (RB_TYPE_P(other, T_RATIONAL)) { if (f_zero_p(other)) rb_num_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;)I" VALUE;T;*To;;F; ;;;;I"Rational#quo;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;= ;3I" overload;F;40;;:;50;)I"/(numeric);T;IC;";T; @É.;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @É.;[;I"@return [Numeric];T;0;6i;[[I"numeric;T0; @É.o;= ;3I" overload;F;40;;;;50;)I"quo(numeric);T;IC;";T; @É.;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @É.;[;I"@return [Numeric];T;0;6i;[[I"numeric;T0; @É.;[;@Å.;0; @É.;!F;"o;#;$T;%iu;&i;'@ð-;(I"VALUE rb_rational_div(VALUE self, VALUE other) { if (RB_INTEGER_TYPE_P(other)) { if (f_zero_p(other)) rb_num_zerodiv(); { get_dat1(self); return f_muldiv(self, dat->num, dat->den, other, ONE, '/'); } } else if (RB_FLOAT_TYPE_P(other)) { VALUE v = nurat_to_f(self); return rb_flo_div_flo(v, other); } else if (RB_TYPE_P(other, T_RATIONAL)) { if (f_zero_p(other)) rb_num_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;)I" VALUE;T;*To;;F; ;;;;I"Rational#fdiv;F;[[I" other;T0;[[@¨ i²;T;;<;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;= ;3I" overload;F;40;;<;50;)I"fdiv(numeric);T;IC;";T; @ö.;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @ö.;[;I"@return [Float];T;0;6i;[[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 nurat_fdiv(VALUE self, VALUE other) { VALUE div; if (f_zero_p(other)) return rb_rational_div(self, rb_float_new(0.0)); if (FIXNUM_P(other) && other == LONG2FIX(1)) return nurat_to_f(self); div = rb_rational_div(self, other); if (RB_TYPE_P(div, T_RATIONAL)) return nurat_to_f(div); if (RB_FLOAT_TYPE_P(div)) return div; return rb_funcall(div, idTo_f, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"Rational#**;F;[;[;F;;=;;K;[;{;IC;";T;[;[;@|;0; @/;'@ð-;*To;;F; ;;;;I"Rational#<=>;F;[[I" other;T0;[[@¨ i.;T;;c;0;[;{;IC;"«Returns -1, 0, or +1 depending on whether +rational+ is less than, equal to, or greater than +numeric+. +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 Rational(1, 3) <=> "0.3" #=> nil ;T;[o;= ;3I" overload;F;40;;c;50;)I"<=>(numeric);T;IC;";T; @/;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[ I"-1;TI"0;TI"+1;TI"nil;T; @/;[;I" @return [ -1, 0, +1, nil];T;0;6i;[[I"numeric;T0; @/;[;I"âReturns -1, 0, or +1 depending on whether +rational+ is less than, equal to, or greater than +numeric+. +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 Rational(1, 3) <=> "0.3" #=> nil @overload <=>(numeric) @return [ -1, 0, +1, nil];T;0; @/;!F;"o;#;$T;%i;&i,;'@ð-;(I"ÂVALUE rb_rational_cmp(VALUE self, VALUE other) { switch (TYPE(other)) { case T_FIXNUM: case T_BIGNUM: { get_dat1(self); if (dat->den == LONG2FIX(1)) return rb_int_cmp(dat->num, other); /* c14n */ other = f_rational_new_bang1(CLASS_OF(self), other); /* FALLTHROUGH */ } case 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 = rb_int_mul(adat->num, bdat->den); num2 = rb_int_mul(bdat->num, adat->den); } return rb_int_cmp(rb_int_minus(num1, num2), ZERO); } case T_FLOAT: return rb_dbl_cmp(nurat_to_double(self), RFLOAT_VALUE(other)); default: return rb_num_coerce_cmp(self, other, rb_intern("<=>")); } };T;)I" VALUE;T;*To;;F; ;;;;I"Rational#==;F;[[I" other;T0;[[@¨ ic;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;= ;3I" overload;F;40;;`;50;)I"==(object);T;IC;";T; @@/;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @@/;[;I"@return [Boolean];T;0;6i;[[I"object;T0; @@/;[;I"RReturns +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; @@/;!F;"o;#;$T;%iW;&ia;'@ð-;(I" static VALUE nurat_eqeq_p(VALUE self, VALUE other) { if (RB_INTEGER_TYPE_P(other)) { get_dat1(self); if (RB_INTEGER_TYPE_P(dat->num) && RB_INTEGER_TYPE_P(dat->den)) { if (INT_ZERO_P(dat->num) && INT_ZERO_P(other)) return Qtrue; if (!FIXNUM_P(dat->den)) return Qfalse; if (FIX2LONG(dat->den) != 1) return Qfalse; return rb_int_equal(dat->num, other); } else { const double d = nurat_to_double(self); return f_boolcast(FIXNUM_ZERO_P(rb_dbl_cmp(d, NUM2DBL(other)))); } } else if (RB_FLOAT_TYPE_P(other)) { const double d = nurat_to_double(self); return f_boolcast(FIXNUM_ZERO_P(rb_dbl_cmp(d, RFLOAT_VALUE(other)))); } else if (RB_TYPE_P(other, T_RATIONAL)) { { get_dat2(self, other); if (INT_ZERO_P(adat->num) && INT_ZERO_P(bdat->num)) return Qtrue; return f_boolcast(rb_int_equal(adat->num, bdat->num) && rb_int_equal(adat->den, bdat->den)); } } else { return rb_equal(other, self); } };T;)I"static VALUE;T;*To;;F; ;;;;I"Rational#coerce;F;[[I" other;T0;[[@¨ i;T;;>;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @_/;!F;"o;#;$T;%iŒ;&iŒ;'@ð-;(I"¼static VALUE nurat_coerce(VALUE self, VALUE other) { if (RB_INTEGER_TYPE_P(other)) { return rb_assoc_new(f_rational_new_bang1(CLASS_OF(self), other), self); } else if (RB_FLOAT_TYPE_P(other)) { return rb_assoc_new(other, nurat_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(other, rb_Complex(self, INT2FIX(0))); other = RCOMPLEX(other)->real; if (RB_FLOAT_TYPE_P(other)) { other = float_to_r(other); RBASIC_SET_CLASS(other, CLASS_OF(self)); } else { other = f_rational_new_bang1(CLASS_OF(self), other); } return rb_assoc_new(other, self); } rb_raise(rb_eTypeError, "%s can't be coerced into %s", rb_obj_classname(other), rb_obj_classname(self)); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Rational#positive?;F;[;[[@¨ i²;T;;d;0;[;{;IC;"/Returns +true+ if +rat+ is greater than 0.;T;[o;= ;3I" overload;F;40;;d;50;)I"positive?;T;IC;";T; @o/;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @o/;[;I"@return [Boolean];T;0;6i;[; @o/;[;I"YReturns +true+ if +rat+ is greater than 0. @overload positive? @return [Boolean];T;0; @o/;!F;"o;#;$T;%i¬;&i°;6i;'@ð-;(I"wstatic VALUE nurat_positive_p(VALUE self) { get_dat1(self); return f_boolcast(INT_POSITIVE_P(dat->num)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Rational#negative?;F;[;[[@¨ i¿;T;;e;0;[;{;IC;",Returns +true+ if +rat+ is less than 0.;T;[o;= ;3I" overload;F;40;;e;50;)I"negative?;T;IC;";T; @Š/;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Š/;[;I"@return [Boolean];T;0;6i;[; @Š/;[;I"VReturns +true+ if +rat+ is less than 0. @overload negative? @return [Boolean];T;0; @Š/;!F;"o;#;$T;%i¹;&i½;6i;'@ð-;(I"wstatic VALUE nurat_negative_p(VALUE self) { get_dat1(self); return f_boolcast(INT_NEGATIVE_P(dat->num)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Rational#abs;F;[;[[@¨ iÓ;T;;?;0;[;{;IC;"Returns the absolute value of +rat+. (1/2r).abs #=> (1/2) (-1/2r).abs #=> (1/2) Rational#magnitude is an alias for Rational#abs. ;T;[o;= ;3I" overload;F;40;;?;50;)I"abs;T;IC;";T; @¥/;>0;!F;[;[;I";T;0;6i;[; @¥/o;= ;3I" overload;F;40;;@;50;)I"magnitude;T;IC;";T; @¥/;>0;!F;[;[;I";T;0;6i;[; @¥/;[;I"±Returns the absolute value of +rat+. (1/2r).abs #=> (1/2) (-1/2r).abs #=> (1/2) Rational#magnitude is an alias for Rational#abs. @overload abs @overload magnitude;T;0; @¥/;!F;"o;#;$T;%iÆ;&iÏ;'@ð-;(I"õVALUE rb_rational_abs(VALUE self) { get_dat1(self); if (INT_NEGATIVE_P(dat->num)) { VALUE num = rb_int_abs(dat->num); return nurat_s_canonicalize_internal_no_reduce(CLASS_OF(self), num, dat->den); } return self; };T;)I" VALUE;T;*To;;F; ;;;;I"Rational#magnitude;F;[;[[@¨ iÓ;T;;@;0;[;{;IC;"Returns the absolute value of +rat+. (1/2r).abs #=> (1/2) (-1/2r).abs #=> (1/2) Rational#magnitude is an alias for Rational#abs. ;T;[o;= ;3I" overload;F;40;;?;50;)I"abs;T;IC;";T; @Ã/;>0;!F;[;[;I";T;0;6i;[; @Ã/o;= ;3I" overload;F;40;;@;50;)I"magnitude;T;IC;";T; @Ã/;>0;!F;[;[;I";T;0;6i;[; @Ã/;[;@¿/;0; @Ã/;!F;"o;#;$T;%iÆ;&iÏ;'@ð-;(I"õVALUE rb_rational_abs(VALUE self) { get_dat1(self); if (INT_NEGATIVE_P(dat->num)) { VALUE num = rb_int_abs(dat->num); return nurat_s_canonicalize_internal_no_reduce(CLASS_OF(self), num, dat->den); } return self; };T;)I" VALUE;T;*To;;F; ;;;;I"Rational#floor;F;[[@c0;[[@¨ i—;T;;`;0;[;{;IC;"‚Returns the largest number less than or equal to +rat+ with a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns a rational when +ndigits+ is positive, otherwise returns an integer. Rational(3).floor #=> 3 Rational(2, 3).floor #=> 0 Rational(-3, 2).floor #=> -2 # decimal - 1 2 3 . 4 5 6 # ^ ^ ^ ^ ^ ^ # precision -3 -2 -1 0 +1 +2 Rational('-123.456').floor(+1).to_f #=> -123.5 Rational('-123.456').floor(-1) #=> -130 ;T;[o;= ;3I" overload;F;40;;`;50;)I"floor([ndigits]);T;IC;";T; @à/;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @à/;[;I"@return [Integer];T;0;6i;[[I"[ndigits];T0; @à/;[;I"³Returns the largest number less than or equal to +rat+ with a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns a rational when +ndigits+ is positive, otherwise returns an integer. Rational(3).floor #=> 3 Rational(2, 3).floor #=> 0 Rational(-3, 2).floor #=> -2 # decimal - 1 2 3 . 4 5 6 # ^ ^ ^ ^ ^ ^ # precision -3 -2 -1 0 +1 +2 Rational('-123.456').floor(+1).to_f #=> -123.5 Rational('-123.456').floor(-1) #=> -130 @overload floor([ndigits]) @return [Integer];T;0; @à/;!F;"o;#;$T;%i;&i•;'@ð-;(I"{static VALUE nurat_floor_n(int argc, VALUE *argv, VALUE self) { return f_round_common(argc, argv, self, nurat_floor); };T;)I"static VALUE;T;*To;;F; ;;;;I"Rational#ceil;F;[[@c0;[[@¨ iµ;T;;a;0;[;{;IC;"Returns the smallest number greater than or equal to +rat+ with a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns a rational when +ndigits+ is positive, otherwise returns an integer. 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 Rational('-123.456').ceil(+1).to_f #=> -123.4 Rational('-123.456').ceil(-1) #=> -120 ;T;[o;= ;3I" overload;F;40;;a;50;)I"ceil([ndigits]);T;IC;";T; @þ/;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @þ/;[;I"@return [Integer];T;0;6i;[[I"[ndigits];T0; @þ/;[;I"±Returns the smallest number greater than or equal to +rat+ with a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns a rational when +ndigits+ is positive, otherwise returns an integer. 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 Rational('-123.456').ceil(+1).to_f #=> -123.4 Rational('-123.456').ceil(-1) #=> -120 @overload ceil([ndigits]) @return [Integer];T;0; @þ/;!F;"o;#;$T;%i;&i³;'@ð-;(I"~static VALUE nurat_ceil_n(int argc, VALUE *argv, VALUE self) { return f_round_common(argc, argv, self, nurat_ceil); };T;)I"static VALUE;T;*To;;F; ;;;;I"Rational#truncate;F;[[@c0;[[@¨ iÓ;T;;c;0;[;{;IC;"~Returns +rat+ truncated (toward zero) to a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns a rational when +ndigits+ is positive, otherwise returns an integer. 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 Rational('-123.456').truncate(+1).to_f #=> -123.4 Rational('-123.456').truncate(-1) #=> -120 ;T;[o;= ;3I" overload;F;40;;c;50;)I"truncate([ndigits]);T;IC;";T; @0;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @0;[;I"@return [Integer];T;0;6i;[[I"[ndigits];T0; @0;[;I"²Returns +rat+ truncated (toward zero) to a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns a rational when +ndigits+ is positive, otherwise returns an integer. 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 Rational('-123.456').truncate(+1).to_f #=> -123.4 Rational('-123.456').truncate(-1) #=> -120 @overload truncate([ndigits]) @return [Integer];T;0; @0;!F;"o;#;$T;%i»;&iÑ;'@ð-;(I"static VALUE nurat_truncate_n(int argc, VALUE *argv, VALUE self) { return f_round_common(argc, argv, self, nurat_truncate); };T;)I"static VALUE;T;*To;;F; ;;;;I"Rational#round;F;[[@c0;[[@¨ iþ;T;;b;0;[;{;IC;"®Returns +rat+ rounded to the nearest value with a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns a rational when +ndigits+ is positive, otherwise returns an integer. 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 Rational('-123.456').round(+1).to_f #=> -123.5 Rational('-123.456').round(-1) #=> -120 The optional +half+ keyword argument is available similar to Float#round. Rational(25, 100).round(1, half: :up) #=> (3/10) Rational(25, 100).round(1, half: :down) #=> (1/5) Rational(25, 100).round(1, half: :even) #=> (1/5) Rational(35, 100).round(1, half: :up) #=> (2/5) Rational(35, 100).round(1, half: :down) #=> (3/10) Rational(35, 100).round(1, half: :even) #=> (2/5) Rational(-25, 100).round(1, half: :up) #=> (-3/10) Rational(-25, 100).round(1, half: :down) #=> (-1/5) Rational(-25, 100).round(1, half: :even) #=> (-1/5) ;T;[o;= ;3I" overload;F;40;;b;50;)I"$round([ndigits] [, half: mode]);T;IC;";T; @:0;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @:0;[;I"@return [Integer];T;0;6i;[[I"[ndigits][, half:;TI" mode];T; @:0;[;I"îReturns +rat+ rounded to the nearest value with a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns a rational when +ndigits+ is positive, otherwise returns an integer. 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 Rational('-123.456').round(+1).to_f #=> -123.5 Rational('-123.456').round(-1) #=> -120 The optional +half+ keyword argument is available similar to Float#round. Rational(25, 100).round(1, half: :up) #=> (3/10) Rational(25, 100).round(1, half: :down) #=> (1/5) Rational(25, 100).round(1, half: :even) #=> (1/5) Rational(35, 100).round(1, half: :up) #=> (2/5) Rational(35, 100).round(1, half: :down) #=> (3/10) Rational(35, 100).round(1, half: :even) #=> (2/5) Rational(-25, 100).round(1, half: :up) #=> (-3/10) Rational(-25, 100).round(1, half: :down) #=> (-1/5) Rational(-25, 100).round(1, half: :even) #=> (-1/5) @overload round([ndigits] [, half: mode]) @return [Integer];T;0; @:0;!F;"o;#;$T;%iÙ;&iü;'@ð-;(I"Pstatic VALUE nurat_round_n(int argc, VALUE *argv, VALUE self) { VALUE opt; enum ruby_num_rounding_mode mode = ( argc = rb_scan_args(argc, argv, "*:", NULL, &opt), rb_num_get_rounding_option(opt)); VALUE (*round_func)(VALUE) = ROUND_FUNC(mode, nurat_round); return f_round_common(argc, argv, self, round_func); };T;)I"static VALUE;T;*To;;F; ;;;;I"Rational#to_i;F;[;[[@¨ iú;T;;–;0;[;{;IC;"ñReturns the truncated value as an integer. Equivalent to Rational#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(-31, 2).to_i #=> -15 ;T;[o;= ;3I" overload;F;40;;–;50;)I" to_i;T;IC;";T; @Y0;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Y0;[;I"@return [Integer];T;0;6i;[; @Y0;[;I"Returns the truncated value as an integer. Equivalent to Rational#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(-31, 2).to_i #=> -15 @overload to_i @return [Integer];T;0; @Y0;!F;"o;#;$T;%iì;&iø;'@ð-;(I"Ôstatic VALUE nurat_truncate(VALUE self) { get_dat1(self); if (INT_NEGATIVE_P(dat->num)) return rb_int_uminus(rb_int_idiv(rb_int_uminus(dat->num), dat->den)); return rb_int_idiv(dat->num, dat->den); };T;)I"static VALUE;T;*To;;F; ;;;;I"Rational#to_f;F;[;[[@¨ i;T;;O;0;[;{;IC;"³Returns 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;= ;3I" overload;F;40;;O;50;)I" to_f;T;IC;";T; @t0;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @t0;[;I"@return [Float];T;0;6i;[; @t0;[;I"ÖReturns 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; @t0;!F;"o;#;$T;%i;&i;'@ð-;(I"Wstatic VALUE nurat_to_f(VALUE self) { return DBL2NUM(nurat_to_double(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Rational#to_r;F;[;[[@¨ i-;T;;P;0;[;{;IC;"ZReturns self. Rational(2).to_r #=> (2/1) Rational(-8, 6).to_r #=> (-4/3) ;T;[o;= ;3I" overload;F;40;;P;50;)I" to_r;T;IC;";T; @0;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @0;[;I"@return [self];T;0;6i;[; @0;[;I"|Returns self. Rational(2).to_r #=> (2/1) Rational(-8, 6).to_r #=> (-4/3) @overload to_r @return [self];T;0; @0;!F;"o;#;$T;%i$;&i+;'@ð-;(I"=static VALUE nurat_to_r(VALUE self) { return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"Rational#rationalize;F;[[@c0;[[@¨ i³;T;;Q;0;[;{;IC;"DReturns 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;= ;3I" overload;F;40;;Q;50;)I"rationalize;T;IC;";T; @ª0;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @ª0;[;I"@return [self];T;0;6i;[; @ª0o;= ;3I" overload;F;40;;Q;50;)I"rationalize(eps);T;IC;";T; @ª0;>0;!F;[;[;I";T;0;6i;[[I"eps;T0; @ª0;[;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; @ª0;!F;"o;#;$T;%i¥;&i±;'@ð-;(I"Þstatic VALUE nurat_rationalize(int argc, VALUE *argv, VALUE self) { VALUE e, a, b, p, q; VALUE rat = self; get_dat1(self); if (rb_check_arity(argc, 0, 1) == 0) return self; e = f_abs(argv[0]); if (INT_NEGATIVE_P(dat->num)) { rat = f_rational_new2(RBASIC_CLASS(self), rb_int_uminus(dat->num), dat->den); } a = FIXNUM_ZERO_P(e) ? rat : rb_rational_minus(rat, e); b = FIXNUM_ZERO_P(e) ? rat : rb_rational_plus(rat, e); if (f_eqeq_p(a, b)) return self; nurat_rationalize_internal(a, b, &p, &q); if (rat != self) { RATIONAL_SET_NUM(rat, rb_int_uminus(p)); RATIONAL_SET_DEN(rat, q); return rat; } return f_rational_new2(CLASS_OF(self), p, q); };T;)I"static VALUE;T;*To;;F; ;;;;I"Rational#hash;F;[;[[@¨ iâ;T;;b;0;[;{;IC;";T;[;[;@|;0; @Ð0;'@ð-;(I"Wstatic VALUE nurat_hash(VALUE self) { return ST2FIX(rb_rational_hash(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Rational#to_s;F;[;[[@¨ i;T;;q;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;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @Ü0;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Ü0;[;I"@return [String];T;0;6i;[; @Ü0;[;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; @Ü0;!F;"o;#;$T;%iö;&iþ;'@ð-;(I"Ostatic VALUE nurat_to_s(VALUE self) { return f_format(self, f_to_s); };T;)I"static VALUE;T;*To;;F; ;;;;I"Rational#inspect;F;[;[[@¨ i;T;;r;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;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @÷0;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @÷0;[;I"@return [String];T;0;6i;[; @÷0;[;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; @÷0;!F;"o;#;$T;%i;&i;'@ð-;(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;)I"static VALUE;T;*To;;F; ;;;Ï;I"Rational#marshal_dump;F;[;[[@¨ i7;T;;L;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @1;!F;"o;#;$T;%i6;&i6;'@ð-;(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;)I"static VALUE;T;*To; ;IC;[o;;F; ;;;Ï;I"&Rational::compatible#marshal_load;F;[[I"a;T0;[[@¨ iC;T;;M;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @"1;!F;"o;#;$T;%iB;&iB;'@ 1;(I"ýstatic VALUE nurat_marshal_load(VALUE self, VALUE a) { VALUE num, den; rb_check_frozen(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)); num = RARRAY_AREF(a, 0); den = RARRAY_AREF(a, 1); nurat_int_check(num); nurat_int_check(den); nurat_canonicalize(&num, &den); rb_ivar_set(self, id_i_num, num); rb_ivar_set(self, id_i_den, den); return self; };T;)I"static VALUE;T;*T;A@ 1;BIC;[;A@ 1;CIC;[;A@ 1;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@¨ iú ;F;;N;;K;;;[;{;IC;";T;[;[;@|;0; @ 1;6i;'@ð-;I"Rational::compatible;F;S@]o;;F; ;F;;;I"Rational.raw;F;[[I"x;T0[I"y;T0;[[I"ext/-test-/rational/rat.c;Ti%;T;;¨;0;[;{;IC;";T;[;[;@|;0; @A1;'@ð-;(I"estatic VALUE s_rational_raw(VALUE klass, VALUE x, VALUE y) { return rb_rational_raw(x, y); };T;)I"static VALUE;T;*T;A@ð-;BIC;[;A@ð-;CIC;[;A@ð-;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@¨ iË ;F;;œ;;K;;;[;{;IC;"|A rational number can be represented as a pair of integer numbers: a/b (b>0), where a is the numerator and b is the denominator. Integer a equals rational a/1 mathematically. In Ruby, you can create rational objects with the Kernel#Rational, to_r, or rationalize methods or by suffixing +r+ to a literal. The return values will be irreducible fractions. 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 objects 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 programs 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 includes an inexact component (numerical value or operation), it 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"}A rational number can be represented as a pair of integer numbers: a/b (b>0), where a is the numerator and b is the denominator. Integer a equals rational a/1 mathematically. In Ruby, you can create rational objects with the Kernel#Rational, to_r, or rationalize methods or by suffixing +r+ to a literal. The return values will be irreducible fractions. 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 objects 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 programs 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 includes an inexact component (numerical value or operation), it 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;S@<o; ;IC;[^o;;F; ;;;;I"Integer#gcd;F;[[I" other;T0;[[@¨ in;T;; ;0;[;{;IC;"Returns the greatest common divisor of the two integers. The result is always positive. 0.gcd(x) and x.gcd(0) return x.abs. 36.gcd(60) #=> 12 2.gcd(2) #=> 2 3.gcd(-7) #=> 1 ((1<<31)-1).gcd((1<<61)-1) #=> 1 ;T;[o;= ;3I" overload;F;40;; ;50;)I"gcd(other_int);T;IC;";T; @e1;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @e1;[;I"@return [Integer];T;0;6i;[[I"other_int;T0; @e1;[;I"@Returns the greatest common divisor of the two integers. The result is always positive. 0.gcd(x) and x.gcd(0) return x.abs. 36.gcd(60) #=> 12 2.gcd(2) #=> 2 3.gcd(-7) #=> 1 ((1<<31)-1).gcd((1<<61)-1) #=> 1 @overload gcd(other_int) @return [Integer];T;0; @e1;!F;"o;#;$T;%ib;&il;'@c1;(I"qVALUE rb_gcd(VALUE self, VALUE other) { other = nurat_int_value(other); return f_gcd(self, other); };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#lcm;F;[[I" other;T0;[[@¨ i;T;:lcm;0;[;{;IC;"+Returns the least common multiple of the two integers. The result is always positive. 0.lcm(x) and x.lcm(0) return zero. 36.lcm(60) #=> 180 2.lcm(2) #=> 2 3.lcm(-7) #=> 21 ((1<<31)-1).lcm((1<<61)-1) #=> 4951760154835678088235319297 ;T;[o;= ;3I" overload;F;40;;<;50;)I"lcm(other_int);T;IC;";T; @„1;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @„1;[;I"@return [Integer];T;0;6i;[[I"other_int;T0; @„1;[;I"ZReturns the least common multiple of the two integers. The result is always positive. 0.lcm(x) and x.lcm(0) return zero. 36.lcm(60) #=> 180 2.lcm(2) #=> 2 3.lcm(-7) #=> 21 ((1<<31)-1).lcm((1<<61)-1) #=> 4951760154835678088235319297 @overload lcm(other_int) @return [Integer];T;0; @„1;!F;"o;#;$T;%iu;&i;'@c1;(I"qVALUE rb_lcm(VALUE self, VALUE other) { other = nurat_int_value(other); return f_lcm(self, other); };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#gcdlcm;F;[[I" other;T0;[[@¨ i”;T;:gcdlcm;0;[;{;IC;"DReturns an array with the greatest common divisor and the least common multiple of the two integers, [gcd, lcm]. 36.gcdlcm(60) #=> [12, 180] 2.gcdlcm(2) #=> [2, 2] 3.gcdlcm(-7) #=> [1, 21] ((1<<31)-1).gcdlcm((1<<61)-1) #=> [1, 4951760154835678088235319297] ;T;[o;= ;3I" overload;F;40;;=;50;)I"gcdlcm(other_int);T;IC;";T; @£1;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @£1;[;I"@return [Array];T;0;6i;[[I"other_int;T0; @£1;[;I"tReturns an array with the greatest common divisor and the least common multiple of the two integers, [gcd, lcm]. 36.gcdlcm(60) #=> [12, 180] 2.gcdlcm(2) #=> [2, 2] 3.gcdlcm(-7) #=> [1, 21] ((1<<31)-1).gcdlcm((1<<61)-1) #=> [1, 4951760154835678088235319297] @overload gcdlcm(other_int) @return [Array];T;0; @£1;!F;"o;#;$T;%iˆ;&i’;'@c1;(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;)I" VALUE;T;*To;;F; ;;;;I"Integer#numerator;F;[;[[@¨ i ;T;;H;0;[;{;IC;"Returns self. ;T;[o;= ;3I" overload;F;40;;H;50;)I"numerator;T;IC;";T; @Â1;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @Â1;[;I"@return [self];T;0;6i;[; @Â1;[;I"9Returns self. @overload numerator @return [self];T;0; @Â1;!F;"o;#;$T;%i;&i;'@c1;(I"Dstatic VALUE integer_numerator(VALUE self) { return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#denominator;F;[;[[@¨ i;T;;I;0;[;{;IC;"Returns 1. ;T;[o;= ;3I" overload;F;40;;I;50;)I"denominator;T;IC;";T; @Ý1;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"1;T; @Ý1;[;I"@return [ 1];T;0;6i;[; @Ý1;[;I"6Returns 1. @overload denominator @return [ 1];T;0; @Ý1;!F;"o;#;$T;%i;&i;'@c1;(I"Lstatic VALUE integer_denominator(VALUE self) { return INT2FIX(1); };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#to_r;F;[;[[@¨ im;T;;P;0;[;{;IC;"oReturns the value as a rational. 1.to_r #=> (1/1) (1<<64).to_r #=> (18446744073709551616/1) ;T;[o;= ;3I" overload;F;40;;P;50;)I" to_r;T;IC;";T; @ø1;>0;!F;[;[;I";T;0;6i;[; @ø1;[;I"{Returns the value as a rational. 1.to_r #=> (1/1) (1<<64).to_r #=> (18446744073709551616/1) @overload to_r;T;0; @ø1;!F;"o;#;$T;%id;&ij;'@c1;(I"Qstatic VALUE integer_to_r(VALUE self) { return rb_rational_new1(self); };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#rationalize;F;[[@c0;[[@¨ iz;T;;Q;0;[;{;IC;"UReturns the value as a rational. The optional argument +eps+ is always ignored. ;T;[o;= ;3I" overload;F;40;;Q;50;)I"rationalize([eps]);T;IC;";T; @2;>0;!F;[;[;I";T;0;6i;[[I" [eps];T0; @2;[;I"tReturns the value as a rational. The optional argument +eps+ is always ignored. @overload rationalize([eps]);T;0; @2;!F;"o;#;$T;%is;&iw;'@c1;(I"†static VALUE integer_rationalize(int argc, VALUE *argv, VALUE self) { rb_check_arity(argc, 0, 1); return integer_to_r(self); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Integer.sqrt;F;[[I"num;T0;[[@ïië;T;: sqrt;0;[;{;IC;"ÒReturns the integer square root of the non-negative integer +n+, i.e. the largest non-negative integer less than or equal to the square root of +n+. Integer.sqrt(0) #=> 0 Integer.sqrt(1) #=> 1 Integer.sqrt(24) #=> 4 Integer.sqrt(25) #=> 5 Integer.sqrt(10**400) #=> 10**200 Equivalent to Math.sqrt(n).floor, except that the result of the latter code may differ from the true value due to the limited precision of floating point arithmetic. Integer.sqrt(10**46) #=> 100000000000000000000000 Math.sqrt(10**46).floor #=> 99999999999999991611392 (!) If +n+ is not an Integer, it is converted to an Integer first. If +n+ is negative, a Math::DomainError is raised. ;T;[o;= ;3I" overload;F;40;;>;50;)I"sqrt(n);T;IC;";T; @'2;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @'2;[;I"@return [Integer];T;0;6i;[[I"n;T0; @'2;[;I"úReturns the integer square root of the non-negative integer +n+, i.e. the largest non-negative integer less than or equal to the square root of +n+. Integer.sqrt(0) #=> 0 Integer.sqrt(1) #=> 1 Integer.sqrt(24) #=> 4 Integer.sqrt(25) #=> 5 Integer.sqrt(10**400) #=> 10**200 Equivalent to Math.sqrt(n).floor, except that the result of the latter code may differ from the true value due to the limited precision of floating point arithmetic. Integer.sqrt(10**46) #=> 100000000000000000000000 Math.sqrt(10**46).floor #=> 99999999999999991611392 (!) If +n+ is not an Integer, it is converted to an Integer first. If +n+ is negative, a Math::DomainError is raised. @overload sqrt(n) @return [Integer];T;0; @'2;!F;"o;#;$T;%iÑ;&iç;'@c1;(I"qstatic VALUE rb_int_s_isqrt(VALUE self, VALUE num) { unsigned long n, sq; num = rb_to_int(num); if (FIXNUM_P(num)) { if (FIXNUM_NEGATIVE_P(num)) { domain_error("isqrt"); } n = FIX2ULONG(num); sq = rb_ulong_isqrt(n); return LONG2FIX(sq); } else { size_t biglen; if (RBIGNUM_NEGATIVE_P(num)) { domain_error("isqrt"); } biglen = BIGNUM_LEN(num); if (biglen == 0) return INT2FIX(0); #if SIZEOF_BDIGIT <= SIZEOF_LONG /* short-circuit */ if (biglen == 1) { n = BIGNUM_DIGITS(num)[0]; sq = rb_ulong_isqrt(n); return ULONG2NUM(sq); } #endif return rb_big_isqrt(num); } };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#to_s;F;[[@c0;[[@ïiÐ ;T;;q;0;[;{;IC;"\Returns a string containing the place-value representation of +int+ with radix +base+ (between 2 and 36). 12345.to_s #=> "12345" 12345.to_s(2) #=> "11000000111001" 12345.to_s(8) #=> "30071" 12345.to_s(10) #=> "12345" 12345.to_s(16) #=> "3039" 12345.to_s(36) #=> "9ix" 78546939656932.to_s(36) #=> "rubyrules" ;T;[o;= ;3I" overload;F;40;;q;50;)I"to_s(base=10);T;IC;";T; @F2;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @F2;[;I"@return [String];T;0;6i;[[I" base;TI"10;T; @F2;[;I"‰Returns a string containing the place-value representation of +int+ with radix +base+ (between 2 and 36). 12345.to_s #=> "12345" 12345.to_s(2) #=> "11000000111001" 12345.to_s(8) #=> "30071" 12345.to_s(10) #=> "12345" 12345.to_s(16) #=> "3039" 12345.to_s(36) #=> "9ix" 78546939656932.to_s(36) #=> "rubyrules" @overload to_s(base=10) @return [String];T;0; o;;F; ;;;;I"Integer#inspect;F;[;[[@ïi£;F;;r;;K;[;{;@N2;'@c1;)I"static VALUE;T;(I"»static VALUE int_to_s(int argc, VALUE *argv, VALUE x) { int base; if (rb_check_arity(argc, 0, 1)) base = NUM2INT(argv[0]); else base = 10; return rb_int2str(x, base); };T;!F;"o;#;$T;%i• ;&i¢ ;'@c1;(I"»static VALUE int_to_s(int argc, VALUE *argv, VALUE x) { int base; if (rb_check_arity(argc, 0, 1)) base = NUM2INT(argv[0]); else base = 10; return rb_int2str(x, base); };T;)@i2;*T@b2o;;F; ;;;;I"Integer#allbits?;F;[[I" mask;T0;[[@ïiÕ;T;: allbits?;0;[;{;IC;"EReturns +true+ if all bits of +int+ & +mask+ are 1.;T;[o;= ;3I" overload;F;40;;?;50;)I"allbits?(mask);T;IC;";T; @m2;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @m2;[;I"@return [Boolean];T;0;6i;[[I" mask;T0; @m2;[;I"tReturns +true+ if all bits of +int+ & +mask+ are 1. @overload allbits?(mask) @return [Boolean];T;0; @m2;!F;"o;#;$T;%iÎ;&iÒ;6i;'@c1;(I"‡static VALUE int_allbits_p(VALUE num, VALUE mask) { mask = rb_to_int(mask); return rb_int_equal(rb_int_and(num, mask), mask); };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#anybits?;F;[[I" mask;T0;[[@ïiã;T;: anybits?;0;[;{;IC;"EReturns +true+ if any bits of +int+ & +mask+ are 1.;T;[o;= ;3I" overload;F;40;;@;50;)I"anybits?(mask);T;IC;";T; @Œ2;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Œ2;[;I"@return [Boolean];T;0;6i;[[I" mask;T0; @Œ2;[;I"tReturns +true+ if any bits of +int+ & +mask+ are 1. @overload anybits?(mask) @return [Boolean];T;0; @Œ2;!F;"o;#;$T;%iÜ;&ià;6i;'@c1;(I"static VALUE int_anybits_p(VALUE num, VALUE mask) { mask = rb_to_int(mask); return int_zero_p(rb_int_and(num, mask)) ? Qfalse : Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#nobits?;F;[[I" mask;T0;[[@ïiñ;T;:nobits?;0;[;{;IC;"DReturns +true+ if no bits of +int+ & +mask+ are 1.;T;[o;= ;3I" overload;F;40;;A;50;)I"nobits?(mask);T;IC;";T; @«2;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @«2;[;I"@return [Boolean];T;0;6i;[[I" mask;T0; @«2;[;I"rReturns +true+ if no bits of +int+ & +mask+ are 1. @overload nobits?(mask) @return [Boolean];T;0; @«2;!F;"o;#;$T;%iê;&iî;6i;'@c1;(I"~static VALUE int_nobits_p(VALUE num, VALUE mask) { mask = rb_to_int(mask); return int_zero_p(rb_int_and(num, mask)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#upto;F;[[I"to;T0;[[@ïi;T;;t;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. 5.upto(10) {|i| print i, " " } #=> 5 6 7 8 9 10 ;T;[o;= ;3I" overload;F;40;;t;50;)I"upto(limit);T;IC;";T; @Ê2;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"i;T; @Ê2o;2 ;3I"return;F;4I";T;0;5[I" self;T; @Ê2;[;I"@yield [i] @return [self];T;0;6i;[[I" limit;T0; @Ê2o;= ;3I" overload;F;40;;t;50;)I"upto(limit);T;IC;";T; @Ê2;>0;!F;[;[;I";T;0;6i;[[I" limit;T0; @Ê2;[;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. 5.upto(10) {|i| print i, " " } #=> 5 6 7 8 9 10 @overload upto(limit) @yield [i] @return [self] @overload upto(limit);T;0; @Ê2;!F;"o;#;$T;%i‰;&i”;'@c1;(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)); } ensure_cmp(c, i, to); } return from; };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#downto;F;[[I"to;T0;[[@ïiË;T;:downto;0;[;{;IC;"úIterates the given block, passing in 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, ".. " } puts "Liftoff!" #=> "5.. 4.. 3.. 2.. 1.. Liftoff!" ;T;[o;= ;3I" overload;F;40;;B;50;)I"downto(limit);T;IC;";T; @ø2;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"i;T; @ø2o;2 ;3I"return;F;4I";T;0;5[I" self;T; @ø2;[;I"@yield [i] @return [self];T;0;6i;[[I" limit;T0; @ø2o;= ;3I" overload;F;40;;B;50;)I"downto(limit);T;IC;";T; @ø2;>0;!F;[;[;I";T;0;6i;[[I" limit;T0; @ø2;[;I"JIterates the given block, passing in 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, ".. " } puts "Liftoff!" #=> "5.. 4.. 3.. 2.. 1.. Liftoff!" @overload downto(limit) @yield [i] @return [self] @overload downto(limit);T;0; @ø2;!F;"o;#;$T;%iµ;&iÂ;'@c1;(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;)I"static VALUE;T;*To;;F; ;;;;I"Integer#times;F;[;[[@ïiý;T;;;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 {|i| print i, " " } #=> 0 1 2 3 4 ;T;[o;= ;3I" overload;F;40;;;50;)I" times;T;IC;";T; @&3;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"i;T; @&3o;2 ;3I"return;F;4I";T;0;5[I" self;T; @&3;[;I"@yield [i] @return [self];T;0;6i;[; @&3o;= ;3I" overload;F;40;;;50;)I" times;T;IC;";T; @&3;>0;!F;[;[;I";T;0;6i;[; @&3;[;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 {|i| print i, " " } #=> 0 1 2 3 4 @overload times @yield [i] @return [self] @overload times;T;0; @&3;!F;"o;#;$T;%iã;&iî;'@c1;(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; iint+1. 1.next #=> 2 (-1).next #=> 0 1.succ #=> 2 (-1).succ #=> 0 ;T;[o;= ;3I" overload;F;40;;r;50;)I" next;T;IC;";T; @N3;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @N3;[;I"@return [Integer];T;0;6i;[; @N3o;= ;3I" overload;F;40;;p;50;)I" succ;T;IC;";T; @N3;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @N3;[;I"@return [Integer];T;0;6i;[; @N3;[;I"êReturns the successor of +int+, i.e. the Integer equal to int+1. 1.next #=> 2 (-1).next #=> 0 1.succ #=> 2 (-1).succ #=> 0 @overload next @return [Integer] @overload succ @return [Integer];T;0; @N3;!F;"o;#;$T;%iø;&i ;'@c1;*To;;F; ;;;;I"Integer#next;F;[;[;F;;r;;K;[;{;IC;"¢Returns the successor of +int+, i.e. the Integer equal to int+1. 1.next #=> 2 (-1).next #=> 0 1.succ #=> 2 (-1).succ #=> 0 ;T;[o;= ;3I" overload;F;40;;r;50;)I" next;T;IC;";T; @s3;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @s3;[;I"@return [Integer];T;0;6i;[; @s3o;= ;3I" overload;F;40;;p;50;)I" succ;T;IC;";T; @s3;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @s3;[;I"@return [Integer];T;0;6i;[; @s3;[;@q3;0; @s3;!F;"o;#;$T;%iø;&i ;'@c1;*To;;F; ;;;;I"Integer#pred;F;[;[;F;: pred;;K;[;{;IC;";T;[;[;@|;0; @—3;'@c1;*To;;F; ;;;;I"Integer#chr;F;[[@c0;[[@ïiT ;T;;u;0;[;{;IC;"¼Returns a string containing the character represented by the +int+'s value according to +encoding+. 65.chr #=> "A" 230.chr #=> "\xE6" 255.chr(Encoding::UTF_8) #=> "\u00FF" ;T;[o;= ;3I" overload;F;40;;u;50;)I"chr([encoding]);T;IC;";T; @ 3;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ 3;[;I"@return [String];T;0;6i;[[I"[encoding];T0; @ 3;[;I"ëReturns a string containing the character represented by the +int+'s value according to +encoding+. 65.chr #=> "A" 230.chr #=> "\xE6" 255.chr(Encoding::UTF_8) #=> "\u00FF" @overload chr([encoding]) @return [String];T;0; @ 3;!F;"o;#;$T;%i1 ;&i: ;'@c1;(I"Qstatic 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, "%u 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_error_arity(argc, 0, 1); } enc = rb_to_encoding(argv[0]); if (!enc) enc = rb_ascii8bit_encoding(); decode: return rb_enc_uint_chr(i, enc); };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#to_f;F;[;[[@ïi;T;;O;0;[;{;IC;"YConverts +int+ to a Float. If +int+ doesn't fit in a Float, the result is infinity. ;T;[o;= ;3I" overload;F;40;;O;50;)I" to_f;T;IC;";T; @¾3;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @¾3;[;I"@return [Float];T;0;6i;[; @¾3;[;I"|Converts +int+ to a Float. If +int+ doesn't fit in a Float, the result is infinity. @overload to_f @return [Float];T;0; @¾3;!F;"o;#;$T;%i¤;&i©;'@c1;(I"8static VALUE int_to_f(VALUE num) { double val; if (FIXNUM_P(num)) { val = (double)FIX2LONG(num); } else if (RB_TYPE_P(num, T_BIGNUM)) { val = rb_big2dbl(num); } else { rb_raise(rb_eNotImpError, "Unknown subclass for to_f: %s", rb_obj_classname(num)); } return DBL2NUM(val); };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#floor;F;[[@c0;[[@ïiY;T;;`;0;[;{;IC;"ŽReturns the largest number less than or equal to +int+ with a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns +self+ when +ndigits+ is zero or positive. 1.floor #=> 1 1.floor(2) #=> 1 18.floor(-1) #=> 10 (-18).floor(-1) #=> -20 ;T;[o;= ;3I" overload;F;40;;`;50;)I"floor([ndigits]);T;IC;";T; @Ù3;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI" Float;T; @Ù3;[;I"@return [Integer, Float];T;0;6i;[[I"[ndigits];T0; @Ù3;[;I"ÆReturns the largest number less than or equal to +int+ with a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns +self+ when +ndigits+ is zero or positive. 1.floor #=> 1 1.floor(2) #=> 1 18.floor(-1) #=> 10 (-18).floor(-1) #=> -20 @overload floor([ndigits]) @return [Integer, Float];T;0; @Ù3;!F;"o;#;$T;%iF;&iU;'@c1;(I"ñstatic VALUE int_floor(int argc, VALUE* argv, VALUE num) { int ndigits; if (!rb_check_arity(argc, 0, 1)) return num; ndigits = NUM2INT(argv[0]); if (ndigits >= 0) { return num; } return rb_int_floor(num, ndigits); };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#ceil;F;[[@c0;[[@ïiy;T;;a;0;[;{;IC;"ŽReturns the smallest number greater than or equal to +int+ with a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns +self+ when +ndigits+ is zero or positive. 1.ceil #=> 1 1.ceil(2) #=> 1 18.ceil(-1) #=> 20 (-18).ceil(-1) #=> -10 ;T;[o;= ;3I" overload;F;40;;a;50;)I"ceil([ndigits]);T;IC;";T; @ø3;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI" Float;T; @ø3;[;I"@return [Integer, Float];T;0;6i;[[I"[ndigits];T0; @ø3;[;I"ÅReturns the smallest number greater than or equal to +int+ with a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns +self+ when +ndigits+ is zero or positive. 1.ceil #=> 1 1.ceil(2) #=> 1 18.ceil(-1) #=> 20 (-18).ceil(-1) #=> -10 @overload ceil([ndigits]) @return [Integer, Float];T;0; @ø3;!F;"o;#;$T;%if;&iu;'@c1;(I"ïstatic VALUE int_ceil(int argc, VALUE* argv, VALUE num) { int ndigits; if (!rb_check_arity(argc, 0, 1)) return num; ndigits = NUM2INT(argv[0]); if (ndigits >= 0) { return num; } return rb_int_ceil(num, ndigits); };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#truncate;F;[[@c0;[[@ïi™;T;;c;0;[;{;IC;"‡Returns +int+ truncated (toward zero) to a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns +self+ when +ndigits+ is zero or positive. 1.truncate #=> 1 1.truncate(2) #=> 1 18.truncate(-1) #=> 10 (-18).truncate(-1) #=> -10 ;T;[o;= ;3I" overload;F;40;;c;50;)I"truncate([ndigits]);T;IC;";T; @4;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI" Float;T; @4;[;I"@return [Integer, Float];T;0;6i;[[I"[ndigits];T0; @4;[;I"ÂReturns +int+ truncated (toward zero) to a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns +self+ when +ndigits+ is zero or positive. 1.truncate #=> 1 1.truncate(2) #=> 1 18.truncate(-1) #=> 10 (-18).truncate(-1) #=> -10 @overload truncate([ndigits]) @return [Integer, Float];T;0; @4;!F;"o;#;$T;%i†;&i•;'@c1;(I"÷static VALUE int_truncate(int argc, VALUE* argv, VALUE num) { int ndigits; if (!rb_check_arity(argc, 0, 1)) return num; ndigits = NUM2INT(argv[0]); if (ndigits >= 0) { return num; } return rb_int_truncate(num, ndigits); };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#round;F;[[@c0;[[@ïi6;T;;b;0;[;{;IC;"0Returns +int+ rounded to the nearest value with a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns +self+ when +ndigits+ is zero or positive. 1.round #=> 1 1.round(2) #=> 1 15.round(-1) #=> 20 (-15).round(-1) #=> -20 The optional +half+ keyword argument is available similar to Float#round. 25.round(-1, half: :up) #=> 30 25.round(-1, half: :down) #=> 20 25.round(-1, half: :even) #=> 20 35.round(-1, half: :up) #=> 40 35.round(-1, half: :down) #=> 30 35.round(-1, half: :even) #=> 40 (-25).round(-1, half: :up) #=> -30 (-25).round(-1, half: :down) #=> -20 (-25).round(-1, half: :even) #=> -20 ;T;[o;= ;3I" overload;F;40;;b;50;)I"$round([ndigits] [, half: mode]);T;IC;";T; @64;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;TI" Float;T; @64;[;I"@return [Integer, Float];T;0;6i;[[I"[ndigits][, half:;TI" mode];T; @64;[;I"wReturns +int+ rounded to the nearest value with a precision of +ndigits+ decimal digits (default: 0). When the precision is negative, the returned value is an integer with at least ndigits.abs trailing zeros. Returns +self+ when +ndigits+ is zero or positive. 1.round #=> 1 1.round(2) #=> 1 15.round(-1) #=> 20 (-15).round(-1) #=> -20 The optional +half+ keyword argument is available similar to Float#round. 25.round(-1, half: :up) #=> 30 25.round(-1, half: :down) #=> 20 25.round(-1, half: :even) #=> 20 35.round(-1, half: :up) #=> 40 35.round(-1, half: :down) #=> 30 35.round(-1, half: :even) #=> 40 (-25).round(-1, half: :up) #=> -30 (-25).round(-1, half: :down) #=> -20 (-25).round(-1, half: :even) #=> -20 @overload round([ndigits] [, half: mode]) @return [Integer, Float];T;0; @64;!F;"o;#;$T;%i;&i2;'@c1;(I"Ostatic VALUE int_round(int argc, VALUE* argv, VALUE num) { int ndigits; int mode; VALUE nd, opt; if (!rb_scan_args(argc, argv, "01:", &nd, &opt)) return num; ndigits = NUM2INT(nd); mode = rb_num_get_rounding_option(opt); if (ndigits >= 0) { return num; } return rb_int_round(num, ndigits, mode); };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#<=>;F;[[I"y;T0;[[@ïic;T;;c;0;[;{;IC;"áComparison---Returns -1, 0, or +1 depending on whether +int+ is less than, equal to, or greater than +numeric+. This is the basis for the tests in the Comparable module. +nil+ is returned if the two values are incomparable. ;T;[o;= ;3I" overload;F;40;;c;50;)I"<=>(numeric);T;IC;";T; @V4;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[ I"-1;TI"0;TI"+1;TI"nil;T; @V4;[;I" @return [ -1, 0, +1, nil];T;0;6i;[[I"numeric;T0; @V4;[;I"Comparison---Returns -1, 0, or +1 depending on whether +int+ is less than, equal to, or greater than +numeric+. This is the basis for the tests in the Comparable module. +nil+ is returned if the two values are incomparable. @overload <=>(numeric) @return [ -1, 0, +1, nil];T;0; @V4;!F;"o;#;$T;%i>;&iG;'@c1;(I"VALUE rb_int_cmp(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return fix_cmp(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_cmp(x, y); } else { rb_raise(rb_eNotImpError, "need to define `<=>' in %s", rb_obj_classname(x)); } };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#+;F;[[I"y;T0;[[@ïi;T;;&;0;[;{;IC;"\Performs addition: the class of the resulting object depends on the class of +numeric+. ;T;[o;= ;3I" overload;F;40;;&;50;)I"+(numeric);T;IC;";T; @x4;>0;!F;[;[;I";T;0;6i;[[I"numeric;T0; @x4;[;I"sPerforms addition: the class of the resulting object depends on the class of +numeric+. @overload +(numeric);T;0; @x4;!F;"o;#;$T;%ié ;&ií ;'@c1;(I"ÍVALUE rb_int_plus(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return fix_plus(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_plus(x, y); } return rb_num_coerce_bin(x, y, '+'); };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#-;F;[[I"y;T0;[[@ïi3;T;;;0;[;{;IC;"_Performs subtraction: the class of the resulting object depends on the class of +numeric+. ;T;[o;= ;3I" overload;F;40;;;50;)I"-(numeric);T;IC;";T; @’4;>0;!F;[;[;I";T;0;6i;[[I"numeric;T0; @’4;[;I"vPerforms subtraction: the class of the resulting object depends on the class of +numeric+. @overload -(numeric);T;0; @’4;!F;"o;#;$T;%i;&i;'@c1;(I"ÐVALUE rb_int_minus(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return fix_minus(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_minus(x, y); } return rb_num_coerce_bin(x, y, '-'); };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#*;F;[[I"y;T0;[[@ïie;T;;';0;[;{;IC;"bPerforms multiplication: the class of the resulting object depends on the class of +numeric+. ;T;[o;= ;3I" overload;F;40;;';50;)I"*(numeric);T;IC;";T; @¬4;>0;!F;[;[;I";T;0;6i;[[I"numeric;T0; @¬4;[;I"yPerforms multiplication: the class of the resulting object depends on the class of +numeric+. @overload *(numeric);T;0; @¬4;!F;"o;#;$T;%iD;&iH;'@c1;(I"ÊVALUE rb_int_mul(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return fix_mul(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_mul(x, y); } return rb_num_coerce_bin(x, y, '*'); };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#/;F;[[I"y;T0;[[@ïiÚ;T;;:;0;[;{;IC;"\Performs division: the class of the resulting object depends on the class of +numeric+. ;T;[o;= ;3I" overload;F;40;;:;50;)I"/(numeric);T;IC;";T; @Æ4;>0;!F;[;[;I";T;0;6i;[[I"numeric;T0; @Æ4;[;I"sPerforms division: the class of the resulting object depends on the class of +numeric+. @overload /(numeric);T;0; @Æ4;!F;"o;#;$T;%i¬;&i°;'@c1;(I"²VALUE rb_int_div(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return fix_div(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_div(x, y); } return Qnil; };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#div;F;[[I"y;T0;[[@ïiõ;T;;X;0;[;{;IC;"ZPerforms integer division: returns the integer result of dividing +int+ by +numeric+. ;T;[o;= ;3I" overload;F;40;;X;50;)I"div(numeric);T;IC;";T; @à4;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @à4;[;I"@return [Integer];T;0;6i;[[I"numeric;T0; @à4;[;I"‚Performs integer division: returns the integer result of dividing +int+ by +numeric+. @overload div(numeric) @return [Integer];T;0; @à4;!F;"o;#;$T;%iæ;&ië;'@c1;(I"¾VALUE rb_int_idiv(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return fix_idiv(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_idiv(x, y); } return num_div(x, y); };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#%;F;[[I"y;T0;[[@ïi ;T;;Û;0;[;{;IC;"LReturns +int+ modulo +other+. See Numeric#divmod for more information. ;T;[o;= ;3I" overload;F;40;;Û;50;)I" %(other);T;IC;";T; @ÿ4;>0;!F;[;[;I";T;0;6i;[[I" other;T0; @ÿ4o;= ;3I" overload;F;40;;Z;50;)I"modulo(other);T;IC;";T; @ÿ4;>0;!F;[;[;I";T;0;6i;[[I" other;T0; @ÿ4;[;I"yReturns +int+ modulo +other+. See Numeric#divmod for more information. @overload %(other) @overload modulo(other);T;0; @ÿ4;!F;"o;#;$T;%i;&i;'@c1;(I"ÄVALUE rb_int_modulo(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return fix_mod(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_modulo(x, y); } return num_modulo(x, y); };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#modulo;F;[[I"y;T0;[[@ïi ;T;;Z;0;[;{;IC;"LReturns +int+ modulo +other+. See Numeric#divmod for more information. ;T;[o;= ;3I" overload;F;40;;Û;50;)I" %(other);T;IC;";T; @#5;>0;!F;[;[;I";T;0;6i;[[I" other;T0; @#5o;= ;3I" overload;F;40;;Z;50;)I"modulo(other);T;IC;";T; @#5;>0;!F;[;[;I";T;0;6i;[[I" other;T0; @#5;[;@5;0; @#5;!F;"o;#;$T;%i;&i;'@c1;(I"ÄVALUE rb_int_modulo(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return fix_mod(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_modulo(x, y); } return num_modulo(x, y); };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#remainder;F;[[I"y;T0;[[@ïi=;T;;[;0;[;{;IC;""Returns the remainder after dividing +int+ by +numeric+. x.remainder(y) means x-y*(x/y).truncate. 5.remainder(3) #=> 2 -5.remainder(3) #=> -2 5.remainder(-3) #=> 2 -5.remainder(-3) #=> -2 5.remainder(1.5) #=> 0.5 See Numeric#divmod. ;T;[o;= ;3I" overload;F;40;;[;50;)I"remainder(numeric);T;IC;";T; @F5;>0;!F;[;[;I";T;0;6i;[[I"numeric;T0; @F5;[;I"AReturns the remainder after dividing +int+ by +numeric+. x.remainder(y) means x-y*(x/y).truncate. 5.remainder(3) #=> 2 -5.remainder(3) #=> -2 5.remainder(-3) #=> 2 -5.remainder(-3) #=> -2 5.remainder(1.5) #=> 0.5 See Numeric#divmod. @overload remainder(numeric);T;0; @F5;!F;"o;#;$T;%i,;&i9;'@c1;(I"Èstatic VALUE int_remainder(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return num_remainder(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_remainder(x, y); } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#divmod;F;[[I"y;T0;[[@ïim;T;;Y;0;[;{;IC;"See Numeric#divmod. ;T;[o;= ;3I" overload;F;40;;Y;50;)I"divmod(numeric);T;IC;";T; @`5;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @`5;[;I"@return [Array];T;0;6i;[[I"numeric;T0; @`5;[;I"FSee Numeric#divmod. @overload divmod(numeric) @return [Array];T;0; @`5;!F;"o;#;$T;%iI;&iM;'@c1;(I"»VALUE rb_int_divmod(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return fix_divmod(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_divmod(x, y); } return Qnil; };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#fdiv;F;[[I"y;T0;[[@ïi£;T;;<;0;[;{;IC;"ØReturns the floating point result of dividing +int+ by +numeric+. 654321.fdiv(13731) #=> 47.652829364212366 654321.fdiv(13731.24) #=> 47.65199646936475 -654321.fdiv(13731) #=> -47.652829364212366 ;T;[o;= ;3I" overload;F;40;;<;50;)I"fdiv(numeric);T;IC;";T; @5;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @5;[;I"@return [Float];T;0;6i;[[I"numeric;T0; @5;[;I"Returns the floating point result of dividing +int+ by +numeric+. 654321.fdiv(13731) #=> 47.652829364212366 654321.fdiv(13731.24) #=> 47.65199646936475 -654321.fdiv(13731) #=> -47.652829364212366 @overload fdiv(numeric) @return [Float];T;0; @5;!F;"o;#;$T;%i—;&iŸ;'@c1;(I"VALUE rb_int_fdiv(VALUE x, VALUE y) { if (RB_INTEGER_TYPE_P(x)) { return DBL2NUM(rb_int_fdiv_double(x, y)); } return Qnil; };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#**;F;[[I"y;T0;[[@ïi÷;T;;=;0;[;{;IC;"™Raises +int+ to the power of +numeric+, which may be negative or fractional. The result may be an Integer, a Float, a Rational, or a complex number. 2 ** 3 #=> 8 2 ** -1 #=> (1/2) 2 ** 0.5 #=> 1.4142135623730951 (-1) ** 0.5 #=> (0.0+1.0i) 123456789 ** 2 #=> 15241578750190521 123456789 ** 1.2 #=> 5126464716.0993185 123456789 ** -2 #=> (1/15241578750190521) ;T;[o;= ;3I" overload;F;40;;=;50;)I"**(numeric);T;IC;";T; @ž5;>0;!F;[;[;I";T;0;6i;[[I"numeric;T0; @ž5;[;I"±Raises +int+ to the power of +numeric+, which may be negative or fractional. The result may be an Integer, a Float, a Rational, or a complex number. 2 ** 3 #=> 8 2 ** -1 #=> (1/2) 2 ** 0.5 #=> 1.4142135623730951 (-1) ** 0.5 #=> (0.0+1.0i) 123456789 ** 2 #=> 15241578750190521 123456789 ** 1.2 #=> 5126464716.0993185 123456789 ** -2 #=> (1/15241578750190521) @overload **(numeric);T;0; @ž5;!F;"o;#;$T;%iy;&i‡;'@c1;(I"²VALUE rb_int_pow(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return fix_pow(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_pow(x, y); } return Qnil; };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#pow;F;[[I"*;T0[I" const;T0;[[@)iÃ;T;:pow;0;[;{;IC;"Returns (modular) exponentiation as: a.pow(b) #=> same as a**b a.pow(b, m) #=> same as (a**b) % m, but avoids huge temporary values ;T;[o;= ;3I" overload;F;40;;D;50;)I"pow(numeric);T;IC;";T; @¸5;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @¸5;[;I"@return [Numeric];T;0;6i;[[I"numeric;T0; @¸5o;= ;3I" overload;F;40;;D;50;)I"pow(integer, integer);T;IC;";T; @¸5;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¸5;[;I"@return [Integer];T;0;6i;[[I"integer;T0[I"integer;T0; @¸5;[;I"îReturns (modular) exponentiation as: a.pow(b) #=> same as a**b a.pow(b, m) #=> same as (a**b) % m, but avoids huge temporary values @overload pow(numeric) @return [Numeric] @overload pow(integer, integer) @return [Integer];T;0; @¸5;!F;"o;#;$T;%i¸;&iÁ;'@c1;(I"&VALUE rb_int_powm(int const argc, VALUE * const argv, VALUE const num) { rb_check_arity(argc, 1, 2); if (argc == 1) { return rb_int_pow(num, argv[0]); } else { VALUE const a = num; VALUE const b = argv[0]; VALUE m = argv[1]; int nega_flg = 0; if ( ! RB_INTEGER_TYPE_P(b)) { rb_raise(rb_eTypeError, "Integer#pow() 2nd argument not allowed unless a 1st argument is integer"); } if (rb_int_negative_p(b)) { rb_raise(rb_eRangeError, "Integer#pow() 1st argument cannot be negative when 2nd argument specified"); } if (!RB_INTEGER_TYPE_P(m)) { rb_raise(rb_eTypeError, "Integer#pow() 2nd argument not allowed unless all arguments are integers"); } if (rb_int_negative_p(m)) { m = rb_int_uminus(m); nega_flg = 1; } if (FIXNUM_P(m)) { long const half_val = (long)HALF_LONG_MSB; long const mm = FIX2LONG(m); if (!mm) rb_num_zerodiv(); if (mm == 1) return INT2FIX(0); if (mm <= half_val) { return int_pow_tmp1(rb_int_modulo(a, m), b, mm, nega_flg); } else { return int_pow_tmp2(rb_int_modulo(a, m), b, mm, nega_flg); } } else { if (rb_bigzero_p(m)) rb_num_zerodiv(); if (bignorm(m) == INT2FIX(1)) return INT2FIX(0); return int_pow_tmp3(rb_int_modulo(a, m), b, m, nega_flg); } } UNREACHABLE_RETURN(Qnil); };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#===;F;[[I"y;T0;[[@ïi2;T;;\;0;[;{;IC;";T;[;[;@|;0; @ê5;'@c1;(I"µVALUE rb_int_equal(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return fix_equal(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_eq(x, y); } return Qnil; };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#==;F;[[I"y;T0;[[@ïi2;T;;`;0;[;{;IC;"Returns +true+ if +int+ equals +other+ numerically. Contrast this with Integer#eql?, which requires +other+ to be an Integer. 1 == 2 #=> false 1 == 1.0 #=> true ;T;[o;= ;3I" overload;F;40;;`;50;)I"==(other);T;IC;";T; @ø5;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ø5;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @ø5;[;I"×Returns +true+ if +int+ equals +other+ numerically. Contrast this with Integer#eql?, which requires +other+ to be an Integer. 1 == 2 #=> false 1 == 1.0 #=> true @overload ==(other) @return [Boolean];T;0; @ø5;!F;"o;#;$T;%i;&i;'@c1;(I"µVALUE rb_int_equal(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return fix_equal(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_eq(x, y); } return Qnil; };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#>;F;[[I"y;T0;[[@ïi‹;T;;;0;[;{;IC;"IReturns +true+ if the value of +int+ is greater than that of +real+. ;T;[o;= ;3I" overload;F;40;;;50;)I">(real);T;IC;";T; @6;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @6;[;I"@return [Boolean];T;0;6i;[[I" real;T0; @6;[;I"qReturns +true+ if the value of +int+ is greater than that of +real+. @overload >(real) @return [Boolean];T;0; @6;!F;"o;#;$T;%iq;&iu;'@c1;(I"¯VALUE rb_int_gt(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return fix_gt(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_gt(x, y); } return Qnil; };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#>=;F;[[I"y;T0;[[@ïi³;T;;‚;0;[;{;IC;"UReturns +true+ if the value of +int+ is greater than or equal to that of +real+. ;T;[o;= ;3I" overload;F;40;;‚;50;)I" >=(real);T;IC;";T; @66;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @66;[;I"@return [Boolean];T;0;6i;[[I" real;T0; @66;[;I"~Returns +true+ if the value of +int+ is greater than or equal to that of +real+. @overload >=(real) @return [Boolean];T;0; @66;!F;"o;#;$T;%i—;&iœ;'@c1;(I"¯VALUE rb_int_ge(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return fix_ge(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_ge(x, y); } return Qnil; };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#<;F;[[I"y;T0;[[@ïiÙ;T;;;0;[;{;IC;"FReturns +true+ if the value of +int+ is less than that of +real+. ;T;[o;= ;3I" overload;F;40;;;50;)I"<(real);T;IC;";T; @U6;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @U6;[;I"@return [Boolean];T;0;6i;[[I" real;T0; @U6;[;I"nReturns +true+ if the value of +int+ is less than that of +real+. @overload <(real) @return [Boolean];T;0; @U6;!F;"o;#;$T;%i¿;&iÃ;'@c1;(I"³static VALUE int_lt(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return fix_lt(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_lt(x, y); } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#<=;F;[[I"y;T0;[[@ïi;T;;€;0;[;{;IC;"RReturns +true+ if the value of +int+ is less than or equal to that of +real+. ;T;[o;= ;3I" overload;F;40;;€;50;)I" <=(real);T;IC;";T; @t6;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @t6;[;I"@return [Boolean];T;0;6i;[[I" real;T0; @t6;[;I"{Returns +true+ if the value of +int+ is less than or equal to that of +real+. @overload <=(real) @return [Boolean];T;0; @t6;!F;"o;#;$T;%iå;&iê;'@c1;(I"³static VALUE int_le(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return fix_le(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_le(x, y); } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#&;F;[[I"y;T0;[[@ïiS;T;;”;0;[;{;IC;"Bitwise AND. ;T;[o;= ;3I" overload;F;40;;”;50;)I"&(other_int);T;IC;";T; @“6;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @“6;[;I"@return [Integer];T;0;6i;[[I"other_int;T0; @“6;[;I">Bitwise AND. @overload &(other_int) @return [Integer];T;0; @“6;!F;"o;#;$T;%i<;&i@;'@c1;(I"²VALUE rb_int_and(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return fix_and(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_and(x, y); } return Qnil; };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#|;F;[[I"y;T0;[[@ïiv;T;;(;0;[;{;IC;"Bitwise OR. ;T;[o;= ;3I" overload;F;40;;(;50;)I"|(other_int);T;IC;";T; @²6;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @²6;[;I"@return [Integer];T;0;6i;[[I"other_int;T0; @²6;[;I"=Bitwise OR. @overload |(other_int) @return [Integer];T;0; @²6;!F;"o;#;$T;%i_;⁣'@c1;(I"³static VALUE int_or(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return fix_or(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_or(x, y); } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#^;F;[[I"y;T0;[[@ïi™;T;;i;0;[;{;IC;"Bitwise EXCLUSIVE OR. ;T;[o;= ;3I" overload;F;40;;i;50;)I"^(other_int);T;IC;";T; @Ñ6;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ñ6;[;I"@return [Integer];T;0;6i;[[I"other_int;T0; @Ñ6;[;I"GBitwise EXCLUSIVE OR. @overload ^(other_int) @return [Integer];T;0; @Ñ6;!F;"o;#;$T;%i‚;&i†;'@c1;(I"¶static VALUE int_xor(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return fix_xor(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_xor(x, y); } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#[];F;[[I"*;T0[I" const;T0;[[@ïi˜;T;;Â;0;[;{;IC;"ÊBit Reference---Returns the nth bit in the binary representation of +int+, where int[0] is the least significant bit. a = 0b11001100101010 30.downto(0) {|n| print a[n] } #=> 0000000000000000011001100101010 a = 9**15 50.downto(0) {|n| print a[n] } #=> 000101110110100000111000011110010100111100010111001 In principle, n[i] is equivalent to (n >> i) & 1. Thus, any negative index always returns zero: p 255[-1] #=> 0 Range operations n[i, len] and n[i..j] are naturally extended. * n[i, len] equals to (n >> i) & ((1 << len) - 1). * n[i..j] equals to (n >> i) & ((1 << (j - i + 1)) - 1). * n[i...j] equals to (n >> i) & ((1 << (j - i)) - 1). * n[i..] equals to (n >> i). * n[..j] is zero if n & ((1 << (j + 1)) - 1) is zero. Otherwise, raises an ArgumentError. * n[...j] is zero if n & ((1 << j) - 1) is zero. Otherwise, raises an ArgumentError. Note that range operation may exhaust memory. For example, -1[0, 1000000000000] will raise NoMemoryError. ;T;[o;= ;3I" overload;F;40;;Â;50;)I" [](n);T;IC;";T; @ð6;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;TI"1;T; @ð6;[;I"@return [0, 1];T;0;6i;[[I"n;T0; @ð6o;= ;3I" overload;F;40;;Â;50;)I" [](n, m);T;IC;";T; @ð6;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @ð6;[;I"@return [Numeric];T;0;6i;[[I"n;T0[I"m;T0; @ð6o;= ;3I" overload;F;40;;Â;50;)I"[](range);T;IC;";T; @ð6;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @ð6;[;I"@return [Numeric];T;0;6i;[[I" range;T0; @ð6;[;I"=Bit Reference---Returns the nth bit in the binary representation of +int+, where int[0] is the least significant bit. a = 0b11001100101010 30.downto(0) {|n| print a[n] } #=> 0000000000000000011001100101010 a = 9**15 50.downto(0) {|n| print a[n] } #=> 000101110110100000111000011110010100111100010111001 In principle, n[i] is equivalent to (n >> i) & 1. Thus, any negative index always returns zero: p 255[-1] #=> 0 Range operations n[i, len] and n[i..j] are naturally extended. * n[i, len] equals to (n >> i) & ((1 << len) - 1). * n[i..j] equals to (n >> i) & ((1 << (j - i + 1)) - 1). * n[i...j] equals to (n >> i) & ((1 << (j - i)) - 1). * n[i..] equals to (n >> i). * n[..j] is zero if n & ((1 << (j + 1)) - 1) is zero. Otherwise, raises an ArgumentError. * n[...j] is zero if n & ((1 << j) - 1) is zero. Otherwise, raises an ArgumentError. Note that range operation may exhaust memory. For example, -1[0, 1000000000000] will raise NoMemoryError. @overload [](n) @return [0, 1] @overload [](n, m) @return [Numeric] @overload [](range) @return [Numeric];T;0; @ð6;!F;"o;#;$T;%ir;&i–;'@c1;(I"ðstatic VALUE int_aref(int const argc, VALUE * const argv, VALUE const num) { rb_check_arity(argc, 1, 2); if (argc == 2) { return int_aref2(num, argv[0], argv[1]); } return int_aref1(num, argv[0]); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#<<;F;[[I"y;T0;[[@ïiÈ;T;;Ý;0;[;{;IC;"SReturns +int+ shifted left +count+ positions, or right if +count+ is negative. ;T;[o;= ;3I" overload;F;40;;Ý;50;)I"<<(count);T;IC;";T; @27;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @27;[;I"@return [Integer];T;0;6i;[[I" count;T0; @27;[;I"}Returns +int+ shifted left +count+ positions, or right if +count+ is negative. @overload <<(count) @return [Integer];T;0; @27;!F;"o;#;$T;%i¥;&iª;'@c1;(I"¾VALUE rb_int_lshift(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return rb_fix_lshift(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_lshift(x, y); } return Qnil; };T;)I" VALUE;T;*To;;F; ;;;;I"Integer#>>;F;[[I"y;T0;[[@ïiø;T;;•;0;[;{;IC;"SReturns +int+ shifted right +count+ positions, or left if +count+ is negative. ;T;[o;= ;3I" overload;F;40;;•;50;)I">>(count);T;IC;";T; @Q7;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Q7;[;I"@return [Integer];T;0;6i;[[I" count;T0; @Q7;[;I"}Returns +int+ shifted right +count+ positions, or left if +count+ is negative. @overload >>(count) @return [Integer];T;0; @Q7;!F;"o;#;$T;%iÔ;&iÙ;'@c1;(I"Åstatic VALUE rb_int_rshift(VALUE x, VALUE y) { if (FIXNUM_P(x)) { return rb_fix_rshift(x, y); } else if (RB_TYPE_P(x, T_BIGNUM)) { return rb_big_rshift(x, y); } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#size;F;[;[[@ïiû;T;;¯;0;[;{;IC;"Returns the number of bytes in the machine representation of +int+ (machine dependent). 1.size #=> 8 -1.size #=> 8 2147483647.size #=> 8 (256**10 - 1).size #=> 10 (256**20 - 1).size #=> 20 (256**40 - 1).size #=> 40 ;T;[o;= ;3I" overload;F;40;;¯;50;)I" size;T;IC;";T; @p7;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @p7;[;I"@return [Integer];T;0;6i;[; @p7;[;I"4Returns the number of bytes in the machine representation of +int+ (machine dependent). 1.size #=> 8 -1.size #=> 8 2147483647.size #=> 8 (256**10 - 1).size #=> 10 (256**20 - 1).size #=> 20 (256**40 - 1).size #=> 40 @overload size @return [Integer];T;0; @p7;!F;"o;#;$T;%iå;&iñ;'@c1;(I"¶static VALUE int_size(VALUE num) { if (FIXNUM_P(num)) { return fix_size(num); } else if (RB_TYPE_P(num, T_BIGNUM)) { return rb_big_size_m(num); } return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#digits;F;[[@c0;[[@ïig;T;:digits;0;[;{;IC;"ŠReturns the digits of +int+'s place-value representation with radix +base+ (default: 10). The digits are returned as an array with the least significant digit as the first array element. +base+ must be greater than or equal to 2. 12345.digits #=> [5, 4, 3, 2, 1] 12345.digits(7) #=> [4, 6, 6, 0, 5] 12345.digits(100) #=> [45, 23, 1] -12345.digits(7) #=> Math::DomainError ;T;[o;= ;3I" overload;F;40;;E;50;)I"digits;T;IC;";T; @‹7;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @‹7;[;I"@return [Array];T;0;6i;[; @‹7o;= ;3I" overload;F;40;;E;50;)I"digits(base);T;IC;";T; @‹7;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @‹7;[;I"@return [Array];T;0;6i;[[I" base;T0; @‹7;[;I"ØReturns the digits of +int+'s place-value representation with radix +base+ (default: 10). The digits are returned as an array with the least significant digit as the first array element. +base+ must be greater than or equal to 2. 12345.digits #=> [5, 4, 3, 2, 1] 12345.digits(7) #=> [4, 6, 6, 0, 5] 12345.digits(100) #=> [45, 23, 1] -12345.digits(7) #=> Math::DomainError @overload digits @return [Array] @overload digits(base) @return [Array];T;0; @‹7;!F;"o;#;$T;%i;&i-;'@c1;(I"Çstatic VALUE rb_int_digits(int argc, VALUE *argv, VALUE num) { VALUE base_value; long base; if (rb_num_negative_p(num)) rb_raise(rb_eMathDomainError, "out of domain"); if (rb_check_arity(argc, 0, 1)) { base_value = rb_to_int(argv[0]); if (!RB_INTEGER_TYPE_P(base_value)) rb_raise(rb_eTypeError, "wrong argument type %s (expected Integer)", rb_obj_classname(argv[0])); if (RB_TYPE_P(base_value, T_BIGNUM)) return rb_int_digits_bigbase(num, base_value); base = FIX2LONG(base_value); if (base < 0) rb_raise(rb_eArgError, "negative radix"); else if (base < 2) rb_raise(rb_eArgError, "invalid radix %ld", base); } else base = 10; if (FIXNUM_P(num)) return rb_fix_digits(num, base); else if (RB_TYPE_P(num, T_BIGNUM)) return rb_int_digits_bigbase(num, LONG2FIX(base)); return Qnil; };T;)I"static VALUE;T;*To;;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; @¶7;'@c1;(I"sstatic VALUE divrem_normal(VALUE x, VALUE y) { return rb_big_norm(rb_big_divrem_normal(big(x), big(y))); };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#big_divrem_gmp;F;[[I"y;T0;[[@½7i;T;:big_divrem_gmp;0;[;{;IC;";T;[;[;@|;0; @Å7;'@c1;(I"mstatic VALUE divrem_gmp(VALUE x, VALUE y) { return rb_big_norm(rb_big_divrem_gmp(big(x), big(y))); };T;)I"static VALUE;T;*To;{;[[I"ext/-test-/bignum/mul.c;Ti>;F;:SIZEOF_BDIGIT;;};;;[;{;IC;";T;[;[;@|;0; @Ó7;'@c1;I"Integer::SIZEOF_BDIGIT;F;~I"INT2NUM(SIZEOF_BDIGIT);To;{;[[@Ö7i?;F;:BITSPERDIG;;};;;[;{;IC;";T;[;[;@|;0; @Þ7;'@c1;I"Integer::BITSPERDIG;F;~I"&INT2NUM(SIZEOF_BDIGIT * CHAR_BIT);To;;F; ;;;;I"Integer#big_mul_normal;F;[[I"y;T0;[[@Ö7i;T;:big_mul_normal;0;[;{;IC;";T;[;[;@|;0; @è7;'@c1;(I"mstatic VALUE mul_normal(VALUE x, VALUE y) { return rb_big_norm(rb_big_mul_normal(big(x), big(y))); };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#big_sq_fast;F;[;[[@Ö7i;T;:big_sq_fast;0;[;{;IC;";T;[;[;@|;0; @ö7;'@c1;(I"Vstatic VALUE sq_fast(VALUE x) { return rb_big_norm(rb_big_sq_fast(big(x))); };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#big_mul_balance;F;[[I"y;T0;[[@Ö7i;T;:big_mul_balance;0;[;{;IC;";T;[;[;@|;0; @8;'@c1;(I"ostatic VALUE mul_balance(VALUE x, VALUE y) { return rb_big_norm(rb_big_mul_balance(big(x), big(y))); };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#big_mul_karatsuba;F;[[I"y;T0;[[@Ö7i%;T;:big_mul_karatsuba;0;[;{;IC;";T;[;[;@|;0; @8;'@c1;(I"sstatic VALUE mul_karatsuba(VALUE x, VALUE y) { return rb_big_norm(rb_big_mul_karatsuba(big(x), big(y))); };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#big_mul_toom3;F;[[I"y;T0;[[@Ö7i+;T;:big_mul_toom3;0;[;{;IC;";T;[;[;@|;0; @8;'@c1;(I"kstatic VALUE mul_toom3(VALUE x, VALUE y) { return rb_big_norm(rb_big_mul_toom3(big(x), big(y))); };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#big_mul_gmp;F;[[I"y;T0;[[@Ö7i2;T;:big_mul_gmp;0;[;{;IC;";T;[;[;@|;0; @,8;'@c1;(I"gstatic VALUE mul_gmp(VALUE x, VALUE y) { return rb_big_norm(rb_big_mul_gmp(big(x), big(y))); };T;)I"static VALUE;T;*To;;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; @:8;'@c1;(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;)I"static VALUE;T;*To;;F; ;;;;I"Integer#test_pack;F;[ [I"numwords_arg;T0[I"wordsize_arg;T0[I" nails;T0[I" flags;T0;[[@I8i;T;:test_pack;0;[;{;IC;";T;[;[;@|;0; @Q8;'@c1;(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;)I"static VALUE;T;*To;;F; ;F;;;I"Integer.test_unpack;F;[ [I"buf;T0[I" numwords;T0[I" wordsize;T0[I" nails;T0[I" flags;T0;[[@I8i*;T;:test_unpack;0;[;{;IC;";T;[;[;@|;0; @e8;'@c1;(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;)I"static VALUE;T;*To;{;[[@I8iN;F;:INTEGER_PACK_MSWORD_FIRST;;};;;[;{;IC;";T;[;[;@|;0; @{8;'@c1;I"'Integer::INTEGER_PACK_MSWORD_FIRST;F;~I"'INT2NUM(INTEGER_PACK_MSWORD_FIRST);To;{;[[@I8iO;F;:INTEGER_PACK_LSWORD_FIRST;;};;;[;{;IC;";T;[;[;@|;0; @…8;'@c1;I"'Integer::INTEGER_PACK_LSWORD_FIRST;F;~I"'INT2NUM(INTEGER_PACK_LSWORD_FIRST);To;{;[[@I8iP;F;:INTEGER_PACK_MSBYTE_FIRST;;};;;[;{;IC;";T;[;[;@|;0; @8;'@c1;I"'Integer::INTEGER_PACK_MSBYTE_FIRST;F;~I"'INT2NUM(INTEGER_PACK_MSBYTE_FIRST);To;{;[[@I8iQ;F;:INTEGER_PACK_LSBYTE_FIRST;;};;;[;{;IC;";T;[;[;@|;0; @™8;'@c1;I"'Integer::INTEGER_PACK_LSBYTE_FIRST;F;~I"'INT2NUM(INTEGER_PACK_LSBYTE_FIRST);To;{;[[@I8iR;F;:#INTEGER_PACK_NATIVE_BYTE_ORDER;;};;;[;{;IC;";T;[;[;@|;0; @£8;'@c1;I",Integer::INTEGER_PACK_NATIVE_BYTE_ORDER;F;~I",INT2NUM(INTEGER_PACK_NATIVE_BYTE_ORDER);To;{;[[@I8iS;F;:INTEGER_PACK_2COMP;;};;;[;{;IC;";T;[;[;@|;0; @8;'@c1;I" Integer::INTEGER_PACK_2COMP;F;~I" INT2NUM(INTEGER_PACK_2COMP);To;{;[[@I8iT;F;:INTEGER_PACK_LITTLE_ENDIAN;;};;;[;{;IC;";T;[;[;@|;0; @·8;'@c1;I"(Integer::INTEGER_PACK_LITTLE_ENDIAN;F;~I"(INT2NUM(INTEGER_PACK_LITTLE_ENDIAN);To;{;[[@I8iU;F;:INTEGER_PACK_BIG_ENDIAN;;};;;[;{;IC;";T;[;[;@|;0; @Á8;'@c1;I"%Integer::INTEGER_PACK_BIG_ENDIAN;F;~I"%INT2NUM(INTEGER_PACK_BIG_ENDIAN);To;{;[[@I8iV;F;:INTEGER_PACK_FORCE_BIGNUM;;};;;[;{;IC;";T;[;[;@|;0; @Ë8;'@c1;I"'Integer::INTEGER_PACK_FORCE_BIGNUM;F;~I"'INT2NUM(INTEGER_PACK_FORCE_BIGNUM);To;{;[[@I8iW;F;:INTEGER_PACK_NEGATIVE;;};;;[;{;IC;";T;[;[;@|;0; @Õ8;'@c1;I"#Integer::INTEGER_PACK_NEGATIVE;F;~I"#INT2NUM(INTEGER_PACK_NEGATIVE);To;{;[[@I8iX;F;:.INTEGER_PACK_FORCE_GENERIC_IMPLEMENTATION;;};;;[;{;IC;";T;[;[;@|;0; @ß8;'@c1;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;[;[[@I8i4;T;:$test_numbits_2comp_without_sign;0;[;{;IC;";T;[;[;@|;0; @é8;'@c1;(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;)I"static VALUE;T;*To;;F; ;;;;I"*Integer#test_numbytes_2comp_with_sign;F;[;[[@I8i=;T;:"test_numbytes_2comp_with_sign;0;[;{;IC;";T;[;[;@|;0; @õ8;'@c1;(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;)I"static VALUE;T;*To;;F; ;;;;I"Integer#big2str_generic;F;[[I" vbase;T0;[[I" ext/-test-/bignum/big2str.c;Ti;T;:big2str_generic;0;[;{;IC;";T;[;[;@|;0; @9;'@c1;(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;)I"static VALUE;T;*To;;F; ;;;;I"Integer#big2str_poweroftwo;F;[[I" vbase;T0;[[@9i;T;:big2str_poweroftwo;0;[;{;IC;";T;[;[;@|;0; @9;'@c1;(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;)I"static VALUE;T;*To;;F; ;;;;I"Integer#big2str_gmp;F;[[I" vbase;T0;[[@9i(;T;:big2str_gmp;0;[;{;IC;";T;[;[;@|;0; @9;'@c1;(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;)I"static VALUE;T;*To;;F; ;;;;I"Integer#gcd_normal;F;[[I"y;T0;[[@J1i;T;:gcd_normal;0;[;{;IC;";T;[;[;@|;0; @,9;'@c1;(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;)I"static VALUE;T;*To;;F; ;;;;I"Integer#gcd_gmp;F;[[I"y;T0;[[@J1i;T;:gcd_gmp;0;[;{;IC;";T;[;[;@|;0; @:9;'@c1;(I"cstatic VALUE gcd_gmp(VALUE x, VALUE y) { return rb_big_norm(rb_gcd_gmp(big(x), big(y))); };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#bignum?;F;[;[[I""ext/-test-/integer/core_ext.c;Ti;T;:bignum?;0;[;{;IC;";T;[o;2 ;3I"return;F;4@|;0;5[@~; @H9;[;@|;0; @H9;6i;'@c1;(I"estatic VALUE int_bignum_p(VALUE self) { return RB_TYPE_P(self, T_BIGNUM) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#fixnum?;F;[;[[@M9i;T;:fixnum?;0;[;{;IC;";T;[o;2 ;3I"return;F;4@|;0;5[@~; @X9;[;@|;0; @X9;6i;'@c1;(I"Zstatic VALUE int_fixnum_p(VALUE self) { return FIXNUM_P(self) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#to_bignum;F;[;[[@M9i;T;:to_bignum;0;[;{;IC;";T;[;[;@|;0; @g9;'@c1;(I"wstatic VALUE rb_int_to_bignum(VALUE x) { if (FIXNUM_P(x)) x = rb_int2big(FIX2LONG(x)); return x; };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#positive_pow;F;[[I"y;T0;[[@M9i;T;:positive_pow;0;[;{;IC;";T;[;[;@|;0; @s9;'@c1;(I"ostatic VALUE positive_pow(VALUE x, VALUE y) { return rb_int_positive_pow(NUM2LONG(x), NUM2ULONG(y)); };T;)I"static VALUE;T;*To;;F; ;;;;I"Integer#coerce;F;[[I"y;T0;[[@)iY;T;;>;0;[;{;IC;"Returns an array with both a +numeric+ and a +big+ represented as Bignum objects. This is achieved by converting +numeric+ to a Bignum. A TypeError is raised if the +numeric+ is not a Fixnum or Bignum type. (0x3FFFFFFFFFFFFFFF+1).coerce(42) #=> [42, 4611686018427387904] ;T;[o;= ;3I" overload;F;40;;>;50;)I"coerce(numeric);T;IC;";T; @9;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @9;[;I"@return [Array];T;0;6i;[[I"numeric;T0; @9;[;I"EReturns an array with both a +numeric+ and a +big+ represented as Bignum objects. This is achieved by converting +numeric+ to a Bignum. A TypeError is raised if the +numeric+ is not a Fixnum or Bignum type. (0x3FFFFFFFFFFFFFFF+1).coerce(42) #=> [42, 4611686018427387904] @overload coerce(numeric) @return [Array];T;0; @9;!F;"o;#;$T;%iK;&iV;'@c1;(I"ßstatic VALUE rb_int_coerce(VALUE x, VALUE y) { if (RB_INTEGER_TYPE_P(y)) { return rb_assoc_new(y, x); } else { x = rb_Float(x); y = rb_Float(y); return rb_assoc_new(y, x); } };T;)I"static VALUE;T;*To;{;[[@)i;F;:GMP_VERSION;;};;;[;{;IC;"The version of loaded GMP. ;T;[;[;I"The version of loaded GMP.;T;0; @ 9;!F;"o;#;$T;%i;&i;'@c1;I"Integer::GMP_VERSION;F;~I"&rb_sprintf("GMP %s", gmp_version);T;A@c1;BIC;[;A@c1;CIC;[;A@c1;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@b2;q;I[;[[@ïi¡[@ïi;T;;¹;;K;;;[;{;IC;"Ä****************************************************************** Holds Integer values. You cannot add a singleton method to an Integer object, any attempt to do so will raise a TypeError.;T;[;[;I"Æ****************************************************************** Holds Integer values. You cannot add a singleton method to an Integer object, any attempt to do so will raise a TypeError. ;T;0; @c1;!F;"o;#;$T;%i¡;&i§;6i;'@;I"Integer;F;S@<o; ;IC;[o;;F; ;;;;I"Continuation#call;F;[[@c0;[[@Ý is;T;: call;0;[;{;IC;"Invokes the continuation. The program continues from the end of the #callcc block. If no arguments are given, the original #callcc returns +nil+. If one argument is given, #callcc returns it. Otherwise, an array containing args is returned. callcc {|cont| cont.call } #=> nil callcc {|cont| cont.call 1 } #=> 1 callcc {|cont| cont.call 1, 2, 3 } #=> [1, 2, 3] ;T;[o;= ;3I" overload;F;40;;j;50;)I"call(args, ...);T;IC;";T; @À9;>0;!F;[;[;I";T;0;6i;[[I" args;T0[I"...;T0; @À9o;= ;3I" overload;F;40;;Â;50;)I"[](args, ...);T;IC;";T; @À9;>0;!F;[;[;I";T;0;6i;[[I" args;T0[I"...;T0; @À9;[;I"ÃInvokes the continuation. The program continues from the end of the #callcc block. If no arguments are given, the original #callcc returns +nil+. If one argument is given, #callcc returns it. Otherwise, an array containing args is returned. callcc {|cont| cont.call } #=> nil callcc {|cont| cont.call 1 } #=> 1 callcc {|cont| cont.call 1, 2, 3 } #=> [1, 2, 3] @overload call(args, ...) @overload [](args, ...);T;0; @À9;!F;"o;#;$T;%id;&io;'@¾9;(I"Estatic VALUE rb_cont_call(int argc, VALUE *argv, VALUE contval) { rb_context_t *cont = cont_ptr(contval); rb_thread_t *th = GET_THREAD(); if (cont_thread_value(cont) != th->self) { rb_raise(rb_eRuntimeError, "continuation called across threads"); } if (cont->saved_ec.protect_tag != th->ec->protect_tag) { rb_raise(rb_eRuntimeError, "continuation called across stack rewinding barrier"); } if (cont->saved_ec.fiber_ptr) { if (th->ec->fiber_ptr != cont->saved_ec.fiber_ptr) { rb_raise(rb_eRuntimeError, "continuation called across fiber"); } } rollback_ensure_stack(contval, th->ec->ensure_list, cont->ensure_array); cont->argc = argc; cont->value = make_passing_arg(argc, argv); cont_restore_0(cont, &contval); UNREACHABLE_RETURN(Qnil); };T;)I"static VALUE;T;*To;;F; ;;;;I"Continuation#[];F;[[@c0;[[@Ý is;T;;Â;0;[;{;IC;"Invokes the continuation. The program continues from the end of the #callcc block. If no arguments are given, the original #callcc returns +nil+. If one argument is given, #callcc returns it. Otherwise, an array containing args is returned. callcc {|cont| cont.call } #=> nil callcc {|cont| cont.call 1 } #=> 1 callcc {|cont| cont.call 1, 2, 3 } #=> [1, 2, 3] ;T;[o;= ;3I" overload;F;40;;j;50;)I"call(args, ...);T;IC;";T; @ç9;>0;!F;[;[;I";T;0;6i;[[I" args;T0[I"...;T0; @ç9o;= ;3I" overload;F;40;;Â;50;)I"[](args, ...);T;IC;";T; @ç9;>0;!F;[;[;I";T;0;6i;[[I" args;T0[I"...;T0; @ç9;[;@ã9;0; @ç9;!F;"o;#;$T;%id;&io;'@¾9;(I"Estatic VALUE rb_cont_call(int argc, VALUE *argv, VALUE contval) { rb_context_t *cont = cont_ptr(contval); rb_thread_t *th = GET_THREAD(); if (cont_thread_value(cont) != th->self) { rb_raise(rb_eRuntimeError, "continuation called across threads"); } if (cont->saved_ec.protect_tag != th->ec->protect_tag) { rb_raise(rb_eRuntimeError, "continuation called across stack rewinding barrier"); } if (cont->saved_ec.fiber_ptr) { if (th->ec->fiber_ptr != cont->saved_ec.fiber_ptr) { rb_raise(rb_eRuntimeError, "continuation called across fiber"); } } rollback_ensure_stack(contval, th->ec->ensure_list, cont->ensure_array); cont->argc = argc; cont->value = make_passing_arg(argc, argv); cont_restore_0(cont, &contval); UNREACHABLE_RETURN(Qnil); };T;)I"static VALUE;T;*T;A@¾9;BIC;[;A@¾9;CIC;[;A@¾9;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@Ý i¦[@Ý i);T;:Continuation;;K;;;[;{;IC;";Continuation objects are generated by Kernel#callcc, after having +require+d continuation. They hold a return address and execution context, allowing a nonlocal return to the end of the #callcc block from anywhere within a program. Continuations are somewhat analogous to a structured version of C's setjmp/longjmp (although they contain more state, so you might consider them closer to threads). For instance: require "continuation" arr = [ "Freddie", "Herbie", "Ron", "Max", "Ringo" ] callcc{|cc| $cc = cc} puts(message = arr.shift) $cc.call unless message =~ /Max/ produces: Freddie Herbie Ron Max Also you can call callcc in other methods: require "continuation" def g arr = [ "Freddie", "Herbie", "Ron", "Max", "Ringo" ] cc = callcc { |cc| cc } puts arr.shift return cc, arr.size end def f c, size = g c.call(c) if size > 1 end f This (somewhat contrived) example allows the inner loop to abandon processing early: require "continuation" callcc {|cont| for i in 0..4 print "#{i}: " for j in i*5...(i+1)*5 cont.call() if j == 17 printf "%3d", j end end } puts produces: 0: 0 1 2 3 4 1: 5 6 7 8 9 2: 10 11 12 13 14 3: 15 16;T;[;[;I"= Continuation objects are generated by Kernel#callcc, after having +require+d continuation. They hold a return address and execution context, allowing a nonlocal return to the end of the #callcc block from anywhere within a program. Continuations are somewhat analogous to a structured version of C's setjmp/longjmp (although they contain more state, so you might consider them closer to threads). For instance: require "continuation" arr = [ "Freddie", "Herbie", "Ron", "Max", "Ringo" ] callcc{|cc| $cc = cc} puts(message = arr.shift) $cc.call unless message =~ /Max/ produces: Freddie Herbie Ron Max Also you can call callcc in other methods: require "continuation" def g arr = [ "Freddie", "Herbie", "Ron", "Max", "Ringo" ] cc = callcc { |cc| cc } puts arr.shift return cc, arr.size end def f c, size = g c.call(c) if size > 1 end f This (somewhat contrived) example allows the inner loop to abandon processing early: require "continuation" callcc {|cont| for i in 0..4 print "#{i}: " for j in i*5...(i+1)*5 cont.call() if j == 17 printf "%3d", j end end } puts produces: 0: 0 1 2 3 4 1: 5 6 7 8 9 2: 10 11 12 13 14 3: 15 16 ;T;0; @¾9;!F;"o;#;$T;%i¦;&iå;6i;'@;I"Continuation;F;S@]o; ;IC;[o; ;IC;[o;;F; ;;;;I"$Fiber::SchedulerInterface#close;F;[;[[@Ý ig;T;;:;0;[;{;IC;"ëCalled when the current thread exits. The scheduler is expected to implement this method in order to allow all waiting fibers to finalize their execution. The suggested pattern is to implement the main event loop in the #close method. ;T;[;[;I"î Called when the current thread exits. The scheduler is expected to implement this method in order to allow all waiting fibers to finalize their execution. The suggested pattern is to implement the main event loop in the #close method. ;T;0; @#:;!F;"o;#;$T;%i];⁣'@!:;(I"Dstatic VALUE rb_fiber_scheduler_interface_close(VALUE self) { };T;)I"static VALUE;T;*To;;F; ;;;;I"+Fiber::SchedulerInterface#process_wait;F;[;[[@Ý i~;T;:process_wait;0;[;{;IC;"šInvoked by Process::Status.wait in order to wait for a specified process. See that method description for arguments description. Suggested minimal implementation: Thread.new do Process::Status.wait(pid, flags) end.value This hook is optional: if it is not present in the current scheduler, Process::Status.wait will behave as a blocking method. Expected to returns a Process::Status instance. ;T;[o;= ;3I" overload;F;40;;l;50;)I"process_wait(pid, flags);T;IC;";T; @1:;>0;!F;[;[;I";T;0;6i;[[I"pid;T0[I" flags;T0; @1:;[;I"¿Invoked by Process::Status.wait in order to wait for a specified process. See that method description for arguments description. Suggested minimal implementation: Thread.new do Process::Status.wait(pid, flags) end.value This hook is optional: if it is not present in the current scheduler, Process::Status.wait will behave as a blocking method. Expected to returns a Process::Status instance. @overload process_wait(pid, flags);T;0; @1:;!F;"o;#;$T;%il;&i{;'@!:;(I"Kstatic VALUE rb_fiber_scheduler_interface_process_wait(VALUE self) { };T;)I"static VALUE;T;*To;;F; ;;;;I"&Fiber::SchedulerInterface#io_wait;F;[;[[@Ý i–;T;:io_wait;0;[;{;IC;"HInvoked by IO#wait, IO#wait_readable, IO#wait_writable to ask whether the specified descriptor is ready for specified events within the specified +timeout+. +events+ is a bit mask of IO::READABLE, IO::WRITABLE, and IO::PRIORITY. Suggested implementation should register which Fiber is waiting for which resources and immediately calling Fiber.yield to pass control to other fibers. Then, in the #close method, the scheduler might dispatch all the I/O resources to fibers waiting for it. Expected to return the subset of events that are ready immediately. ;T;[o;= ;3I" overload;F;40;;m;50;)I"!io_wait(io, events, timeout);T;IC;";T; @K:;>0;!F;[;[;I";T;0;6i;[[I"io;T0[I"events;T0[I"timeout;T0; @K:;[;I"rInvoked by IO#wait, IO#wait_readable, IO#wait_writable to ask whether the specified descriptor is ready for specified events within the specified +timeout+. +events+ is a bit mask of IO::READABLE, IO::WRITABLE, and IO::PRIORITY. Suggested implementation should register which Fiber is waiting for which resources and immediately calling Fiber.yield to pass control to other fibers. Then, in the #close method, the scheduler might dispatch all the I/O resources to fibers waiting for it. Expected to return the subset of events that are ready immediately. @overload io_wait(io, events, timeout);T;0; @K:;!F;"o;#;$T;%iƒ;&i“;'@!:;(I"Fstatic VALUE rb_fiber_scheduler_interface_io_wait(VALUE self) { };T;)I"static VALUE;T;*To;;F; ;;;;I"+Fiber::SchedulerInterface#kernel_sleep;F;[;[[@Ý i¦;T;:kernel_sleep;0;[;{;IC;"AInvoked by Kernel#sleep and Mutex#sleep and is expected to provide an implementation of sleeping in a non-blocking way. Implementation might register the current fiber in some list of "what fiber waits till what moment", call Fiber.yield to pass control, and then in #close resume the fibers whose wait period have ended. ;T;[o;= ;3I" overload;F;40;;n;50;)I"!kernel_sleep(duration = nil);T;IC;";T; @g:;>0;!F;[;[;I";T;0;6i;[[I" duration;TI"nil;T; @g:;[;I"kInvoked by Kernel#sleep and Mutex#sleep and is expected to provide an implementation of sleeping in a non-blocking way. Implementation might register the current fiber in some list of "what fiber waits till what moment", call Fiber.yield to pass control, and then in #close resume the fibers whose wait period have ended. @overload kernel_sleep(duration = nil);T;0; @g:;!F;"o;#;$T;%i›;&i£;'@!:;(I"Kstatic VALUE rb_fiber_scheduler_interface_kernel_sleep(VALUE self) { };T;)I"static VALUE;T;*To;;F; ;;;;I"$Fiber::SchedulerInterface#block;F;[;[[@Ý i¹;T;: block;0;[;{;IC;"yInvoked by methods like Thread.join, and by Mutex, to signify that current Fiber is blocked till further notice (e.g. #unblock) or till +timeout+ will pass. +blocker+ is what we are waiting on, informational only (for debugging and logging). There are no guarantees about its value. Expected to return boolean, specifying whether the blocking operation was successful or not. ;T;[o;= ;3I" overload;F;40;;o;50;)I""block(blocker, timeout = nil);T;IC;";T; @€:;>0;!F;[;[;I";T;0;6i;[[I"blocker;T0[I"timeout;TI"nil;T; @€:;[;I"£Invoked by methods like Thread.join, and by Mutex, to signify that current Fiber is blocked till further notice (e.g. #unblock) or till +timeout+ will pass. +blocker+ is what we are waiting on, informational only (for debugging and logging). There are no guarantees about its value. Expected to return boolean, specifying whether the blocking operation was successful or not. @overload block(blocker, timeout = nil);T;0; @€:;!F;"o;#;$T;%i«;&i¶;'@!:;(I"Dstatic VALUE rb_fiber_scheduler_interface_block(VALUE self) { };T;)I"static VALUE;T;*To;;F; ;;;;I"&Fiber::SchedulerInterface#unblock;F;[;[[@Ý iË;T;:unblock;0;[;{;IC;"Invoked to wake up Fiber previously blocked with #block (for example, Mutex#lock calls #block and Mutex#unlock calls #unblock). The scheduler should use the +fiber+ parameter to understand which fiber is unblocked. +blocker+ is what was awaited for, but it is informational only (for debugging and logging), and it is not guaranteed to be the same value as the +blocker+ for #block. ;T;[o;= ;3I" overload;F;40;;p;50;)I"unblock(blocker, fiber);T;IC;";T; @›:;>0;!F;[;[;I";T;0;6i;[[I"blocker;T0[I" fiber;T0; @›:;[;I"¤Invoked to wake up Fiber previously blocked with #block (for example, Mutex#lock calls #block and Mutex#unlock calls #unblock). The scheduler should use the +fiber+ parameter to understand which fiber is unblocked. +blocker+ is what was awaited for, but it is informational only (for debugging and logging), and it is not guaranteed to be the same value as the +blocker+ for #block. @overload unblock(blocker, fiber);T;0; @›:;!F;"o;#;$T;%i¾;&iÈ;'@!:;(I"Fstatic VALUE rb_fiber_scheduler_interface_unblock(VALUE self) { };T;)I"static VALUE;T;*To;;F; ;;;;I"$Fiber::SchedulerInterface#fiber;F;[;[[@Ý iÝ;T;: fiber;0;[;{;IC;""Implementation of the Fiber.schedule. The method is expected to immediately run passed block of code in a separate non-blocking fiber, and to return that Fiber. Minimal suggested implementation is: def fiber(&block) Fiber.new(blocking: false, &block).tap(&:resume) end ;T;[o;= ;3I" overload;F;40;;q;50;)I"fiber(&block);T;IC;";T; @µ:;>0;!F;[;[;I";T;0;6i;[[I"&block;T0; @µ:;[;I"expected to immediately run passed block of code in a separate non-blocking fiber, and to return that Fiber. Minimal suggested implementation is: def fiber(&block) Fiber.new(blocking: false, &block).tap(&:resume) end @overload fiber(&block);T;0; @µ:;!F;"o;#;$T;%iÐ;&iÚ;'@!:;(I"Dstatic VALUE rb_fiber_scheduler_interface_fiber(VALUE self) { };T;)I"static VALUE;T;*T;A@!:;BIC;[;A@!:;CIC;[;A@!:;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@Ý i*[@Ý i;T;:SchedulerInterface;;K;;;[;{;IC;"nThis is not an existing class, but documentation of the interface that Scheduler object should comply in order to be used as Fiber.scheduler and handle non-blocking fibers. See also the "Non-blocking fibers" section in Fiber class docs for explanations of some concepts. Scheduler's behavior and usage are expected to be as follows: * When the execution in the non-blocking Fiber reaches some blocking operation (like sleep, wait for a process, or a non-ready I/O), it calls some of the scheduler's hook methods, listed below. * Scheduler somehow registers what the current fiber is waited for, and yields control to other fibers with Fiber.yield (so the fiber would be suspended while expecting its wait to end, and other fibers in the same thread can perform) * At the end of the current thread execution, the scheduler's method #close is called * The scheduler runs into a wait loop, checking all the blocked fibers (which it has registered on hook calls) and resuming them when the awaited resource is ready (I/O ready, sleep time passed). A typical implementation would probably rely for this closing loop on a gem like EventMachine[https://github.com/eventmachine/eventmachine] or Async[https://github.com/socketry/async]. This way concurrent execution will be achieved in a way that is transparent for every individual Fiber's code. Hook methods are: * #io_wait * #process_wait * #kernel_sleep * #block and #unblock * (the list is expanded as Ruby developers make more methods having non-blocking calls) When not specified otherwise, the hook implementations are mandatory: if they are not implemented, the methods trying to call hook will fail. To provide backward compatibility, in the future hooks will be optional (if they are not implemented, due to the scheduler being created for the older Ruby version, the code which needs this hook will not fail, and will just behave in a blocking fashion). It is also strongly suggested that the scheduler implement the #fiber method, which is delegated to by Fiber.schedule. Sample _toy_ implementation of the scheduler can be found in Ruby's code, in test/fiber/scheduler.rb;T;[;[;I"q This is not an existing class, but documentation of the interface that Scheduler object should comply in order to be used as Fiber.scheduler and handle non-blocking fibers. See also the "Non-blocking fibers" section in Fiber class docs for explanations of some concepts. Scheduler's behavior and usage are expected to be as follows: * When the execution in the non-blocking Fiber reaches some blocking operation (like sleep, wait for a process, or a non-ready I/O), it calls some of the scheduler's hook methods, listed below. * Scheduler somehow registers what the current fiber is waited for, and yields control to other fibers with Fiber.yield (so the fiber would be suspended while expecting its wait to end, and other fibers in the same thread can perform) * At the end of the current thread execution, the scheduler's method #close is called * The scheduler runs into a wait loop, checking all the blocked fibers (which it has registered on hook calls) and resuming them when the awaited resource is ready (I/O ready, sleep time passed). A typical implementation would probably rely for this closing loop on a gem like EventMachine[https://github.com/eventmachine/eventmachine] or Async[https://github.com/socketry/async]. This way concurrent execution will be achieved in a way that is transparent for every individual Fiber's code. Hook methods are: * #io_wait * #process_wait * #kernel_sleep * #block and #unblock * (the list is expanded as Ruby developers make more methods having non-blocking calls) When not specified otherwise, the hook implementations are mandatory: if they are not implemented, the methods trying to call hook will fail. To provide backward compatibility, in the future hooks will be optional (if they are not implemented, due to the scheduler being created for the older Ruby version, the code which needs this hook will not fail, and will just behave in a blocking fashion). It is also strongly suggested that the scheduler implement the #fiber method, which is delegated to by Fiber.schedule. Sample _toy_ implementation of the scheduler can be found in Ruby's code, in test/fiber/scheduler.rb ;T;0; @!:;!F;"o;#;$T;%i*;&iX;6i;'o;L;M0;N0;O0;: Fiber;'@;Q@:;R0;I"Fiber::SchedulerInterface;F;S@]o;;F; ;F;;;I"Fiber.yield;F;[[@c0;[[@Ý i— ;T;;ž;0;[;{;IC;"$Yields control back to the context that resumed the fiber, passing along any arguments that were passed to it. The fiber will resume processing at this point when #resume is called next. Any arguments passed to the next #resume will be the value that this Fiber.yield expression evaluates to. ;T;[o;= ;3I" overload;F;40;;ž;50;)I"yield(args, ...);T;IC;";T; @à:;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @à:;[;I"@return [Object];T;0;6i;[[I" args;T0[I"...;T0; @à:;[;I"TYields control back to the context that resumed the fiber, passing along any arguments that were passed to it. The fiber will resume processing at this point when #resume is called next. Any arguments passed to the next #resume will be the value that this Fiber.yield expression evaluates to. @overload yield(args, ...) @return [Object];T;0; @à:;!F;"o;#;$T;%i ;&i• ;'@:;(I"…static VALUE rb_fiber_s_yield(int argc, VALUE *argv, VALUE klass) { return rb_fiber_yield_kw(argc, argv, rb_keyword_given_p()); };T;)I"static VALUE;T;*To;;F; ;;;;I"Fiber#initialize;F;[[@c0;[[@Ý ig;T;;Ð;0;[;{;IC;"§Creates new Fiber. Initially, fiber is not running, but can be resumed with #resume. Arguments to the first #resume call would be passed to the block: f = Fiber.new do |initial| current = initial loop do puts "current: #{current.inspect}" current = Fiber.yield end end f.resume(100) # prints: current: 100 f.resume(1, 2, 3) # prints: current: [1, 2, 3] f.resume # prints: current: nil # ... and so on ... if blocking: false is passed to the Fiber.new, _and_ current thread has Fiber.scheduler defined, the Fiber becomes non-blocking (see "Non-blocking fibers" section in class docs). ;T;[o;= ;3I" overload;F;40;;î;50;)I"new(blocking: false);T;IC;";T; @;;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" *args;T; @;;[;I"@yield [*args];T;0;6i;[[I"blocking:;TI" false;T; @;;[;I"ÙCreates new Fiber. Initially, fiber is not running, but can be resumed with #resume. Arguments to the first #resume call would be passed to the block: f = Fiber.new do |initial| current = initial loop do puts "current: #{current.inspect}" current = Fiber.yield end end f.resume(100) # prints: current: 100 f.resume(1, 2, 3) # prints: current: [1, 2, 3] f.resume # prints: current: nil # ... and so on ... if blocking: false is passed to the Fiber.new, _and_ current thread has Fiber.scheduler defined, the Fiber becomes non-blocking (see "Non-blocking fibers" section in class docs). @overload new(blocking: false) @yield [*args];T;0; @;;!F;"o;#;$T;%iP;&ie;'@:;(I"’static VALUE rb_fiber_initialize(int argc, VALUE* argv, VALUE self) { return rb_fiber_initialize_kw(argc, argv, self, rb_keyword_given_p()); };T;)I"static VALUE;T;*To;;F; ;;;;I"Fiber#blocking?;F;[;[[@Ý i ;T;:blocking?;0;[;{;IC;"pReturns +true+ if +fiber+ is blocking and +false+ otherwise. Fiber is non-blocking if it was created via passing blocking: false to Fiber.new, or via Fiber.schedule. Note, that even if the method returns +false+, Fiber behaves differently only if Fiber.scheduler is set in the current thread. See the "Non-blocking fibers" section in class docs for details.;T;[o;= ;3I" overload;F;40;;t;50;)I"blocking?;T;IC;";T; @;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @;;[;I"@return [Boolean];T;0;6i;[; @;;[;I"›Returns +true+ if +fiber+ is blocking and +false+ otherwise. Fiber is non-blocking if it was created via passing blocking: false to Fiber.new, or via Fiber.schedule. Note, that even if the method returns +false+, Fiber behaves differently only if Fiber.scheduler is set in the current thread. See the "Non-blocking fibers" section in class docs for details. @overload blocking? @return [Boolean];T;0; @;;!F;"o;#;$T;%i ;&i ;6i;'@:;(I"nVALUE rb_fiber_blocking_p(VALUE fiber) { return (fiber_ptr(fiber)->blocking == 0) ? Qfalse : Qtrue; };T;)I" VALUE;T;*To;;F; ;;;;I"Fiber#resume;F;[[@c0;[[@Ý i« ;T;:resume;0;[;{;IC;"ôResumes the fiber from the point at which the last Fiber.yield was called, or starts running it if it is the first call to #resume. Arguments passed to resume will be the value of the Fiber.yield expression or will be passed as block parameters to the fiber's block if this is the first #resume. Alternatively, when resume is called it evaluates to the arguments passed to the next Fiber.yield statement inside the fiber's block or to the block value if it runs to completion without any Fiber.yield ;T;[o;= ;3I" overload;F;40;;u;50;)I"resume(args, ...);T;IC;";T; @:;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @:;;[;I"@return [Object];T;0;6i;[[I" args;T0[I"...;T0; @:;;[;I"%Resumes the fiber from the point at which the last Fiber.yield was called, or starts running it if it is the first call to #resume. Arguments passed to resume will be the value of the Fiber.yield expression or will be passed as block parameters to the fiber's block if this is the first #resume. Alternatively, when resume is called it evaluates to the arguments passed to the next Fiber.yield statement inside the fiber's block or to the block value if it runs to completion without any Fiber.yield @overload resume(args, ...) @return [Object];T;0; @:;;!F;"o;#;$T;%iœ ;&i© ;'@:;(I"Žstatic VALUE rb_fiber_m_resume(int argc, VALUE *argv, VALUE fiber) { return rb_fiber_resume_kw(fiber, argc, argv, rb_keyword_given_p()); };T;)I"static VALUE;T;*To;;F; ;;;;I"Fiber#raise;F;[[@c0;[[@Ý iÈ ;T;;’;0;[;{;IC;"5Raises an exception in the fiber at the point at which the last +Fiber.yield+ was called. If the fiber has not been started or has already run to completion, raises +FiberError+. If the fiber is yielding, it is resumed. If it is transferring, it is transferred into. But if it is resuming, raises +FiberError+. With no arguments, raises a +RuntimeError+. 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. ;T;[o;= ;3I" overload;F;40;;’;50;)I" raise;T;IC;";T; @Z;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @Z;;[;I"@return [Object];T;0;6i;[; @Z;o;= ;3I" overload;F;40;;’;50;)I"raise(string);T;IC;";T; @Z;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @Z;;[;I"@return [Object];T;0;6i;[[I"string;T0; @Z;o;= ;3I" overload;F;40;;’;50;)I"*raise(exception [, string [, array]]);T;IC;";T; @Z;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @Z;;[;I"@return [Object];T;0;6i;[[I""exception[, string [, array]];T0; @Z;;[;I"ÈRaises an exception in the fiber at the point at which the last +Fiber.yield+ was called. If the fiber has not been started or has already run to completion, raises +FiberError+. If the fiber is yielding, it is resumed. If it is transferring, it is transferred into. But if it is resuming, raises +FiberError+. With no arguments, raises a +RuntimeError+. 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. @overload raise @return [Object] @overload raise(string) @return [Object] @overload raise(exception [, string [, array]]) @return [Object];T;0; @Z;;!F;"o;#;$T;%i³ ;&iÈ ;'@:;(I"static VALUE rb_fiber_raise(int argc, VALUE *argv, VALUE fiber_value) { rb_fiber_t *fiber = fiber_ptr(fiber_value); VALUE exc = rb_make_exception(argc, argv); if (RTEST(fiber->resuming_fiber)) { rb_raise(rb_eFiberError, "attempt to raise a resuming fiber"); } else if (FIBER_SUSPENDED_P(fiber) && !fiber->yielding) { return rb_fiber_transfer_kw(fiber_value, -1, &exc, RB_NO_KEYWORDS); } else { return rb_fiber_resume_kw(fiber_value, -1, &exc, RB_NO_KEYWORDS); } };T;)I"static VALUE;T;*To;;F; ;;;;I"Fiber#backtrace;F;[[@c0;[[@Ý i ;T;;ñ;0;[;{;IC;"ÙReturns the current execution stack of the fiber. +start+, +count+ and +end+ allow to select only parts of the backtrace. def level3 Fiber.yield end def level2 level3 end def level1 level2 end f = Fiber.new { level1 } # It is empty before the fiber started f.backtrace #=> [] f.resume f.backtrace #=> ["test.rb:2:in `yield'", "test.rb:2:in `level3'", "test.rb:6:in `level2'", "test.rb:10:in `level1'", "test.rb:13:in `block in

'"] p f.backtrace(1) # start from the item 1 #=> ["test.rb:2:in `level3'", "test.rb:6:in `level2'", "test.rb:10:in `level1'", "test.rb:13:in `block in

'"] p f.backtrace(2, 2) # start from item 2, take 2 #=> ["test.rb:6:in `level2'", "test.rb:10:in `level1'"] p f.backtrace(1..3) # take items from 1 to 3 #=> ["test.rb:2:in `level3'", "test.rb:6:in `level2'", "test.rb:10:in `level1'"] f.resume # It is nil after the fiber is finished f.backtrace #=> nil @overload backtrace @return [Array] @overload backtrace(start) @return [Array] @overload backtrace(start, count) @return [Array] @overload backtrace(start..end) @return [Array];T;0; @”;;!F;"o;#;$T;%iØ ;&i ;'@:;(I"‘static VALUE rb_fiber_backtrace(int argc, VALUE *argv, VALUE fiber) { return rb_vm_backtrace(argc, argv, &fiber_ptr(fiber)->cont.saved_ec); };T;)I"static VALUE;T;*To;;F; ;;;;I"Fiber#backtrace_locations;F;[[@c0;[[@Ý i ;T;;ò;0;[;{;IC;" Like #backtrace, but returns each line of the execution stack as a Thread::Backtrace::Location. Accepts the same arguments as #backtrace. f = Fiber.new { Fiber.yield } f.resume loc = f.backtrace_locations.first loc.label #=> "yield" loc.path #=> "test.rb" loc.lineno #=> 1 ;T;[ o;= ;3I" overload;F;40;;ò;50;)I"backtrace_locations;T;IC;";T; @ß;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ß;;[;I"@return [Array];T;0;6i;[; @ß;o;= ;3I" overload;F;40;;ò;50;)I"backtrace_locations(start);T;IC;";T; @ß;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ß;;[;I"@return [Array];T;0;6i;[[I" start;T0; @ß;o;= ;3I" overload;F;40;;ò;50;)I"&backtrace_locations(start, count);T;IC;";T; @ß;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ß;;[;I"@return [Array];T;0;6i;[[I" start;T0[I" count;T0; @ß;o;= ;3I" overload;F;40;;ò;50;)I"$backtrace_locations(start..end);T;IC;";T; @ß;;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ß;;[;I"@return [Array];T;0;6i;[[I"start..end;T0; @ß;;[;I"Like #backtrace, but returns each line of the execution stack as a Thread::Backtrace::Location. Accepts the same arguments as #backtrace. f = Fiber.new { Fiber.yield } f.resume loc = f.backtrace_locations.first loc.label #=> "yield" loc.path #=> "test.rb" loc.lineno #=> 1 @overload backtrace_locations @return [Array] @overload backtrace_locations(start) @return [Array] @overload backtrace_locations(start, count) @return [Array] @overload backtrace_locations(start..end) @return [Array];T;0; @ß;;!F;"o;#;$T;%i ;&i ;'@:;(I"¥static VALUE rb_fiber_backtrace_locations(int argc, VALUE *argv, VALUE fiber) { return rb_vm_backtrace_locations(argc, argv, &fiber_ptr(fiber)->cont.saved_ec); };T;)I"static VALUE;T;*To;;F; ;;;;I"Fiber#to_s;F;[;[[@Ý i³ ;T;;q;0;[;{;IC;"&Returns fiber information string. ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @*<;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @*<;[;I"@return [String];T;0;6i;[; @*<;[;I"KReturns fiber information string. @overload to_s @return [String];T;0; o;;F; ;;;;I"Fiber#inspect;F;[;[[@Ý i ;F;;r;;K;[;{;@1<;'@:;)I"static VALUE;T;(I"ýstatic VALUE fiber_to_s(VALUE fiber_value) { const rb_fiber_t *fiber = fiber_ptr(fiber_value); const rb_proc_t *proc; char status_info[0x20]; if (RTEST(fiber->resuming_fiber)) { snprintf(status_info, 0x20, " (%s by resuming)", fiber_status_name(fiber->status)); } else { snprintf(status_info, 0x20, " (%s)", fiber_status_name(fiber->status)); } if (!rb_obj_is_proc(fiber->first_proc)) { VALUE str = rb_any_to_s(fiber_value); strlcat(status_info, ">", sizeof(status_info)); rb_str_set_len(str, RSTRING_LEN(str)-1); rb_str_cat_cstr(str, status_info); return str; } GetProcPtr(fiber->first_proc, proc); return rb_block_to_s(fiber_value, &proc->block, status_info); };T;!F;"o;#;$T;%i« ;&i° ;'@:;(I"ýstatic VALUE fiber_to_s(VALUE fiber_value) { const rb_fiber_t *fiber = fiber_ptr(fiber_value); const rb_proc_t *proc; char status_info[0x20]; if (RTEST(fiber->resuming_fiber)) { snprintf(status_info, 0x20, " (%s by resuming)", fiber_status_name(fiber->status)); } else { snprintf(status_info, 0x20, " (%s)", fiber_status_name(fiber->status)); } if (!rb_obj_is_proc(fiber->first_proc)) { VALUE str = rb_any_to_s(fiber_value); strlcat(status_info, ">", sizeof(status_info)); rb_str_set_len(str, RSTRING_LEN(str)-1); rb_str_cat_cstr(str, status_info); return str; } GetProcPtr(fiber->first_proc, proc); return rb_block_to_s(fiber_value, &proc->block, status_info); };T;)@I<;*T@Bblocking: false to Fiber.new, or via Fiber.schedule. If the current Fiber is blocking, the method, unlike usual predicate methods, returns a *number* of blocking fibers currently running (TBD: always 1?). Note, that even if the method returns +false+, Fiber behaves differently only if Fiber.scheduler is set in the current thread. See the "Non-blocking fibers" section in class docs for details.;T;[o;= ;3I" overload;F;40;;t;50;)I"blocking?;T;IC;";T; @M<;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" false;TI"Numeric;T; @M<;[;I"@return [false, Numeric];T;0;6i;[; @M<;[;I"4Returns +false+ if the current fiber is non-blocking. Fiber is non-blocking if it was created via passing blocking: false to Fiber.new, or via Fiber.schedule. If the current Fiber is blocking, the method, unlike usual predicate methods, returns a *number* of blocking fibers currently running (TBD: always 1?). Note, that even if the method returns +false+, Fiber behaves differently only if Fiber.scheduler is set in the current thread. See the "Non-blocking fibers" section in class docs for details. @overload blocking? @return [false, Numeric];T;0; @M<;!F;"o;#;$T;%i ;&i. ;6i;'@:;(I"Óstatic VALUE rb_f_fiber_blocking_p(VALUE klass) { rb_thread_t *thread = GET_THREAD(); unsigned blocking = thread->blocking; if (blocking == 0) return Qfalse; return INT2NUM(blocking); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Fiber.scheduler;F;[;[[@Ý i»;T;:scheduler;0;[;{;IC;"Fiber scheduler, set in the current thread with Fiber.set_scheduler. If the scheduler is +nil+ (which is the default), non-blocking fibers behavior is the same as blocking. (see "Non-blocking fibers" section in class docs for details about the scheduler concept). ;T;[o;= ;3I" overload;F;40;;v;50;)I"scheduler;T;IC;";T; @i<;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;TI"nil;T; @i<;[;I"@return [Object, nil];T;0;6i;[; @i<;[;I"6Fiber scheduler, set in the current thread with Fiber.set_scheduler. If the scheduler is +nil+ (which is the default), non-blocking fibers behavior is the same as blocking. (see "Non-blocking fibers" section in class docs for details about the scheduler concept). @overload scheduler @return [Object, nil];T;0; @i<;!F;"o;#;$T;%i²;&i¹;'@:;(I"Tstatic VALUE rb_fiber_scheduler(VALUE klass) { return rb_scheduler_get(); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Fiber.set_scheduler;F;[[I"scheduler;T0;[[@Ý iÑ;T;:set_scheduler;0;[;{;IC;"4Sets Fiber scheduler for the current thread. If the scheduler is set, non-blocking fibers (created by Fiber.new with blocking: false, or by Fiber.schedule) call that scheduler's hook methods on potentially blocking operations, and the current thread will call scheduler's +close+ method on finalization (allowing the scheduler to properly manage all non-finished fibers). +scheduler+ can be an object of any class corresponding to Fiber::SchedulerInterface. Its implementation is up to the user. See also the "Non-blocking fibers" section in class docs. ;T;[o;= ;3I" overload;F;40;;w;50;)I"set_scheduler(scheduler);T;IC;";T; @…<;>0;!F;[;[;I";T;0;6i;[[I"scheduler;T0; @…<;[;I"ZSets Fiber scheduler for the current thread. If the scheduler is set, non-blocking fibers (created by Fiber.new with blocking: false, or by Fiber.schedule) call that scheduler's hook methods on potentially blocking operations, and the current thread will call scheduler's +close+ method on finalization (allowing the scheduler to properly manage all non-finished fibers). +scheduler+ can be an object of any class corresponding to Fiber::SchedulerInterface. Its implementation is up to the user. See also the "Non-blocking fibers" section in class docs. @overload set_scheduler(scheduler);T;0; @…<;!F;"o;#;$T;%iÁ;&iÎ;'@:;(I"æstatic VALUE rb_fiber_set_scheduler(VALUE klass, VALUE scheduler) { // if (rb_scheduler_get() != Qnil) { // rb_raise(rb_eFiberError, "Scheduler is already defined!"); // } return rb_scheduler_set(scheduler); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Fiber.schedule;F;[[@c0;[[@Ý i¬;T;: schedule;0;[;{;IC;"GThe method is expected to immediately run the provided block of code in a separate non-blocking fiber. puts "Go to sleep!" Fiber.set_scheduler(MyScheduler.new) Fiber.schedule do puts "Going to sleep" sleep(1) puts "I slept well" end puts "Wakey-wakey, sleepyhead" Assuming MyScheduler is properly implemented, this program will produce: Go to sleep! Going to sleep Wakey-wakey, sleepyhead ...1 sec pause here... I slept well ...e.g. on the first blocking operation inside the Fiber (sleep(1)), the control is yielded at the outside code (main fiber), and at the end of the execution, the scheduler takes care of properly resuming all the blocked fibers. Note that the behavior described above is how the method is expected to behave, actual behavior is up to the current scheduler's implementation of Fiber::SchedulerInterface#fiber method. Ruby doesn't enforce this method to behave in any particular way. If the scheduler is not set, the method raises RuntimeError (No scheduler is available!). ;T;[o;= ;3I" overload;F;40;;x;50;)I" schedule;T;IC;";T; @Ÿ<;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" *args;T; @Ÿ<;[;I"@yield [*args];T;0;6i;[; @Ÿ<;[;I"nThe method is expected to immediately run the provided block of code in a separate non-blocking fiber. puts "Go to sleep!" Fiber.set_scheduler(MyScheduler.new) Fiber.schedule do puts "Going to sleep" sleep(1) puts "I slept well" end puts "Wakey-wakey, sleepyhead" Assuming MyScheduler is properly implemented, this program will produce: Go to sleep! Going to sleep Wakey-wakey, sleepyhead ...1 sec pause here... I slept well ...e.g. on the first blocking operation inside the Fiber (sleep(1)), the control is yielded at the outside code (main fiber), and at the end of the execution, the scheduler takes care of properly resuming all the blocked fibers. Note that the behavior described above is how the method is expected to behave, actual behavior is up to the current scheduler's implementation of Fiber::SchedulerInterface#fiber method. Ruby doesn't enforce this method to behave in any particular way. If the scheduler is not set, the method raises RuntimeError (No scheduler is available!). @overload schedule @yield [*args];T;0; @Ÿ<;!F;"o;#;$T;%iƒ;&iª;'@:;(I"~static VALUE rb_f_fiber(int argc, VALUE *argv, VALUE obj) { return rb_f_fiber_kw(argc, argv, rb_keyword_given_p()); };T;)I"static VALUE;T;*To;;F; ;;;;I"Fiber#transfer;F;[[@c0;[[@Ý iz ;T;: transfer;0;[;{;IC;"ÊTransfer control to another fiber, resuming it from where it last stopped or starting it if it was not resumed before. The calling fiber will be suspended much like in a call to Fiber.yield. You need to require 'fiber' before using this method. The fiber which receives the transfer call is treats it much like a resume call. Arguments passed to transfer are treated like those passed to resume. The two style of control passing to and from fiber (one is #resume and Fiber::yield, another is #transfer to and from fiber) can't be freely mixed. * If the Fiber's lifecycle had started with transfer, it will never be able to yield or be resumed control passing, only finish or transfer back. (It still can resume other fibers that are allowed to be resumed.) * If the Fiber's lifecycle had started with resume, it can yield or transfer to another Fiber, but can receive control back only the way compatible with the way it was given away: if it had transferred, it only can be transferred back, and if it had yielded, it only can be resumed back. After that, it again can transfer or yield. If those rules are broken FiberError is raised. For an individual Fiber design, yield/resume is more easy to use style (the Fiber just gives away control, it doesn't need to think about who the control is given to), while transfer is more flexible for complex cases, allowing to build arbitrary graphs of Fibers dependent on each other. Example: require 'fiber' manager = nil # For local var to be visible inside worker block # This fiber would be started with transfer # It can't yield, and can't be resumed worker = Fiber.new { |work| puts "Worker: starts" puts "Worker: Performed #{work.inspect}, transferring back" # Fiber.yield # this would raise FiberError: attempt to yield on a not resumed fiber # manager.resume # this would raise FiberError: attempt to resume a resumed fiber (double resume) manager.transfer(work.capitalize) } # This fiber would be started with resume # It can yield or transfer, and can be transferred # back or resumed manager = Fiber.new { puts "Manager: starts" puts "Manager: transferring 'something' to worker" result = worker.transfer('something') puts "Manager: worker returned #{result.inspect}" # worker.resume # this would raise FiberError: attempt to resume a transferring fiber Fiber.yield # this is OK, the fiber transferred from and to, now it can yield puts "Manager: finished" } puts "Starting the manager" manager.resume puts "Resuming the manager" # manager.transfer # this would raise FiberError: attempt to transfer to a yielding fiber manager.resume produces Starting the manager Manager: starts Manager: transferring 'something' to worker Worker: starts Worker: Performed "something", transferring back Manager: worker returned "Something" Resuming the manager Manager: finished ;T;[o;= ;3I" overload;F;40;;y;50;)I"transfer(args, ...);T;IC;";T; @»<;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @»<;[;I"@return [Object];T;0;6i;[[I" args;T0[I"...;T0; @»<;[;I"þTransfer control to another fiber, resuming it from where it last stopped or starting it if it was not resumed before. The calling fiber will be suspended much like in a call to Fiber.yield. You need to require 'fiber' before using this method. The fiber which receives the transfer call is treats it much like a resume call. Arguments passed to transfer are treated like those passed to resume. The two style of control passing to and from fiber (one is #resume and Fiber::yield, another is #transfer to and from fiber) can't be freely mixed. * If the Fiber's lifecycle had started with transfer, it will never be able to yield or be resumed control passing, only finish or transfer back. (It still can resume other fibers that are allowed to be resumed.) * If the Fiber's lifecycle had started with resume, it can yield or transfer to another Fiber, but can receive control back only the way compatible with the way it was given away: if it had transferred, it only can be transferred back, and if it had yielded, it only can be resumed back. After that, it again can transfer or yield. If those rules are broken FiberError is raised. For an individual Fiber design, yield/resume is more easy to use style (the Fiber just gives away control, it doesn't need to think about who the control is given to), while transfer is more flexible for complex cases, allowing to build arbitrary graphs of Fibers dependent on each other. Example: require 'fiber' manager = nil # For local var to be visible inside worker block # This fiber would be started with transfer # It can't yield, and can't be resumed worker = Fiber.new { |work| puts "Worker: starts" puts "Worker: Performed #{work.inspect}, transferring back" # Fiber.yield # this would raise FiberError: attempt to yield on a not resumed fiber # manager.resume # this would raise FiberError: attempt to resume a resumed fiber (double resume) manager.transfer(work.capitalize) } # This fiber would be started with resume # It can yield or transfer, and can be transferred # back or resumed manager = Fiber.new { puts "Manager: starts" puts "Manager: transferring 'something' to worker" result = worker.transfer('something') puts "Manager: worker returned #{result.inspect}" # worker.resume # this would raise FiberError: attempt to resume a transferring fiber Fiber.yield # this is OK, the fiber transferred from and to, now it can yield puts "Manager: finished" } puts "Starting the manager" manager.resume puts "Resuming the manager" # manager.transfer # this would raise FiberError: attempt to transfer to a yielding fiber manager.resume produces Starting the manager Manager: starts Manager: transferring 'something' to worker Worker: starts Worker: Performed "something", transferring back Manager: worker returned "Something" Resuming the manager Manager: finished @overload transfer(args, ...) @return [Object];T;0; @»<;!F;"o;#;$T;%i% ;&ix ;'@:;(I"žstatic VALUE rb_fiber_m_transfer(int argc, VALUE *argv, VALUE fiber_value) { return rb_fiber_transfer_kw(fiber_value, argc, argv, rb_keyword_given_p()); };T;)I"static VALUE;T;*To;;F; ;;;;I"Fiber#alive?;F;[;[[@Ý i– ;T;;Î;0;[;{;IC;"ÙReturns true if the fiber can still be resumed (or transferred to). After finishing execution of the fiber block this method will always return false. You need to require 'fiber' before using this method.;T;[o;= ;3I" overload;F;40;;Î;50;)I"alive?;T;IC;";T; @Û<;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Û<;[;I"@return [Boolean];T;0;6i;[; @Û<;[;I"Returns true if the fiber can still be resumed (or transferred to). After finishing execution of the fiber block this method will always return false. You need to require 'fiber' before using this method. @overload alive? @return [Boolean];T;0; @Û<;!F;"o;#;$T;%i ;&i” ;6i;'@:;(I"zVALUE rb_fiber_alive_p(VALUE fiber_value) { return FIBER_TERMINATED_P(fiber_ptr(fiber_value)) ? Qfalse : Qtrue; };T;)I" VALUE;T;*To;;F; ;F;;;I"Fiber.current;F;[;[[@Ý i¥ ;T;;¯;0;[;{;IC;"¶Returns the current fiber. You need to require 'fiber' before using this method. If you are not running in the context of a fiber this method will return the root fiber. ;T;[o;= ;3I" overload;F;40;;¯;50;)I"current();T;IC;";T; @ö<;>0;!F;[;[;I";T;0;6i;[; @ö<;[;I"ÌReturns the current fiber. You need to require 'fiber' before using this method. If you are not running in the context of a fiber this method will return the root fiber. @overload current();T;0; @ö<;!F;"o;#;$T;%i ;&i¢ ;'@:;(I"Tstatic VALUE rb_fiber_s_current(VALUE klass) { return rb_fiber_current(); };T;)I"static VALUE;T;*T;A@:;BIC;[;A@:;CIC;[;A@:;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@B<;q;I[;[[@Ý i‘[@Ý iþ;T;;s;;K;;;[;{;IC;"r Fibers are primitives for implementing light weight cooperative concurrency in Ruby. Basically they are a means of creating code blocks that can be paused and resumed, much like threads. The main difference is that they are never preempted and that the scheduling must be done by the programmer and not the VM. As opposed to other stackless light weight concurrency models, each fiber comes with a stack. This enables the fiber to be paused from deeply nested function calls within the fiber block. See the ruby(1) manpage to configure the size of the fiber stack(s). When a fiber is created it will not run automatically. Rather it must be explicitly asked to run using the Fiber#resume method. The code running inside the fiber can give up control by calling Fiber.yield in which case it yields control back to caller (the caller of the Fiber#resume). Upon yielding or termination the Fiber returns the value of the last executed expression For instance: fiber = Fiber.new do Fiber.yield 1 2 end puts fiber.resume puts fiber.resume puts fiber.resume produces 1 2 FiberError: dead fiber called The Fiber#resume method accepts an arbitrary number of parameters, if it is the first call to #resume then they will be passed as block arguments. Otherwise they will be the return value of the call to Fiber.yield Example: fiber = Fiber.new do |first| second = Fiber.yield first + 2 end puts fiber.resume 10 puts fiber.resume 1_000_000 puts fiber.resume "The fiber will be dead before I can cause trouble" produces 12 1000000 FiberError: dead fiber called == Non-blocking Fibers Since Ruby 3.0, the concept of non-blocking fiber was introduced. Non-blocking fiber, when reaching any potentially blocking operation (like sleep, wait for another process, wait for I/O data to be ready), instead of just freezing itself and all execution in the thread, yields control to other fibers, and allows the scheduler to handle waiting and waking (resuming) the fiber when it can proceed. For Fiber to behave as non-blocking, it should be created in Fiber.new with blocking: false (which is the default now), and Fiber.scheduler should be set with Fiber.set_scheduler. If Fiber.scheduler is not set in the current thread, blocking and non-blocking fiber's behavior is identical. Ruby doesn't provide a scheduler class: it is expected to be implemented by the user and correspond to Fiber::SchedulerInterface. There is also Fiber.schedule method, which is expected to immediately perform passed block in a non-blocking manner (but its actual implementation is up to the scheduler).;T;[;[;I"v Fibers are primitives for implementing light weight cooperative concurrency in Ruby. Basically they are a means of creating code blocks that can be paused and resumed, much like threads. The main difference is that they are never preempted and that the scheduling must be done by the programmer and not the VM. As opposed to other stackless light weight concurrency models, each fiber comes with a stack. This enables the fiber to be paused from deeply nested function calls within the fiber block. See the ruby(1) manpage to configure the size of the fiber stack(s). When a fiber is created it will not run automatically. Rather it must be explicitly asked to run using the Fiber#resume method. The code running inside the fiber can give up control by calling Fiber.yield in which case it yields control back to caller (the caller of the Fiber#resume). Upon yielding or termination the Fiber returns the value of the last executed expression For instance: fiber = Fiber.new do Fiber.yield 1 2 end puts fiber.resume puts fiber.resume puts fiber.resume produces 1 2 FiberError: dead fiber called The Fiber#resume method accepts an arbitrary number of parameters, if it is the first call to #resume then they will be passed as block arguments. Otherwise they will be the return value of the call to Fiber.yield Example: fiber = Fiber.new do |first| second = Fiber.yield first + 2 end puts fiber.resume 10 puts fiber.resume 1_000_000 puts fiber.resume "The fiber will be dead before I can cause trouble" produces 12 1000000 FiberError: dead fiber called == Non-blocking Fibers Since Ruby 3.0, the concept of non-blocking fiber was introduced. Non-blocking fiber, when reaching any potentially blocking operation (like sleep, wait for another process, wait for I/O data to be ready), instead of just freezing itself and all execution in the thread, yields control to other fibers, and allows the scheduler to handle waiting and waking (resuming) the fiber when it can proceed. For Fiber to behave as non-blocking, it should be created in Fiber.new with blocking: false (which is the default now), and Fiber.scheduler should be set with Fiber.set_scheduler. If Fiber.scheduler is not set in the current thread, blocking and non-blocking fiber's behavior is identical. Ruby doesn't provide a scheduler class: it is expected to be implemented by the user and correspond to Fiber::SchedulerInterface. There is also Fiber.schedule method, which is expected to immediately perform passed block in a non-blocking manner (but its actual implementation is up to the scheduler). ;T;0; @:;!F;"o;#;$T;%i‘;&iâ;6i;'@;I" Fiber;F;S@]o; ;IC;[;A@=;BIC;[;A@=;CIC;[;A@=;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@Ý i[@Ý i;T;:FiberError;;K;;;[;{;IC;""Raised when an invalid operation is attempted on a Fiber, in particular when attempting to call/resume a dead fiber, attempting to yield from the root fiber, or calling a fiber across threads. fiber = Fiber.new{} fiber.resume #=> nil fiber.resume #=> FiberError: dead fiber called ;T;[;[;I"$ Raised when an invalid operation is attempted on a Fiber, in particular when attempting to call/resume a dead fiber, attempting to yield from the root fiber, or calling a fiber across threads. fiber = Fiber.new{} fiber.resume #=> nil fiber.resume #=> FiberError: dead fiber called ;T;0; @=;!F;"o;#;$T;%i;&i&;'@;I"FiberError;F;So;L;M0;N0;O0;;ë;'@;Q@ì;R;Fo; ;IC;[o;;F; ;;;;I"Pool#initialize;F;[[@c0;[[@Ý iÿ ;T;;Ð;0;[;{;IC;";T;[;[;@|;0; @5=;'@3=;(I"-static VALUE rb_fiber_pool_initialize(int argc, VALUE* argv, VALUE self) { rb_thread_t *th = GET_THREAD(); VALUE size = Qnil, count = Qnil, vm_stack_size = Qnil; struct fiber_pool * fiber_pool = NULL; // Maybe these should be keyword arguments. rb_scan_args(argc, argv, "03", &size, &count, &vm_stack_size); if (NIL_P(size)) { size = INT2NUM(th->vm->default_params.fiber_machine_stack_size); } if (NIL_P(count)) { count = INT2NUM(128); } if (NIL_P(vm_stack_size)) { vm_stack_size = INT2NUM(th->vm->default_params.fiber_vm_stack_size); } TypedData_Get_Struct(self, struct fiber_pool, &FiberPoolDataType, fiber_pool); fiber_pool_initialize(fiber_pool, NUM2SIZET(size), NUM2SIZET(count), NUM2SIZET(vm_stack_size)); return self; };T;)I"static VALUE;T;*T;A@3=;BIC;[;A@3=;CIC;[;A@3=;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@Ý i;F;: Pool;;K;;;[;{;IC;";T;[;[;@|;0; @3=;'@;I" Pool;F;S@:o; ;IC;[;A@Q=;BIC;[;A@Q=;CIC;[;A@Q=;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@i{3[@i'4;T;:IOError;;K;;;[;{;IC;"›Raised when an IO operation fails. File.open("/etc/hosts") {|f| f << "example"} #=> IOError: not opened for writing File.open("/etc/hosts") {|f| f.close; f.read } #=> IOError: closed stream Note that some IO failures raise SystemCallErrors and these are not subclasses of IOError: File.open("does/not/exist") #=> Errno::ENOENT: No such file or directory - does/not/exist ;T;[;[;I" Raised when an IO operation fails. File.open("/etc/hosts") {|f| f << "example"} #=> IOError: not opened for writing File.open("/etc/hosts") {|f| f.close; f.read } #=> IOError: closed stream Note that some IO failures raise SystemCallErrors and these are not subclasses of IOError: File.open("does/not/exist") #=> Errno::ENOENT: No such file or directory - does/not/exist ;T;0; @Q=;!F;"o;#;$T;%i{3;&i‰3;'@;I"IOError;F;So;L;M0;N0;O0;;ë;'@;Q@ì;R;Fo; ;IC;[;A@f=;BIC;[;A@f=;CIC;[;A@f=;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@i3[@i(4;T;: EOFError;;K;;;[;{;IC;"YRaised by some IO operations when reaching the end of file. Many IO methods exist in two forms, one that returns +nil+ when the end of file is reached, the other raises +EOFError+. +EOFError+ is a subclass of +IOError+. file = File.open("/etc/hosts") file.read file.gets #=> nil file.readline #=> EOFError: end of file reached ;T;[;[;I"[ Raised by some IO operations when reaching the end of file. Many IO methods exist in two forms, one that returns +nil+ when the end of file is reached, the other raises +EOFError+. +EOFError+ is a subclass of +IOError+. file = File.open("/etc/hosts") file.read file.gets #=> nil file.readline #=> EOFError: end of file reached ;T;0; @f=;!F;"o;#;$T;%i3;&iš3;'@;I" EOFError;F;S@Q=@bè@Öüo;{;[[@i5;F;: STDIN;;};;;[;{;IC;"Holds the original stdin ;T;[;[;I"Holds the original stdin;T;0; @z=;!F;"o;#;$T;%i5;&i5;'@;I" STDIN;F;~I" rb_stdin;To;{;[[@i 5;F;:STDOUT;;};;;[;{;IC;"Holds the original stdout ;T;[;[;I"Holds the original stdout;T;0; @†=;!F;"o;#;$T;%i5;&i5;'@;I"STDOUT;F;~I"rb_stdout;To;{;[[@i5;F;:STDERR;;};;;[;{;IC;"Holds the original stderr ;T;[;[;I"Holds the original stderr;T;0; @’=;!F;"o;#;$T;%i 5;&i 5;'@;I"STDERR;F;~I"rb_stderr;To;{;[[@i]5;F;: ARGF;;};;;[;{;IC;"9$ ruby argf.rb --verbose file1 file2 ARGV #=> ["--verbose", "file1", "file2"] option = ARGV.shift #=> "--verbose" ARGV #=> ["file1", "file2"] You can now use +ARGF+ to work with a concatenation of each of these named files. For instance, +ARGF.read+ will return the contents of _file1_ followed by the contents of _file2_. After a file in +ARGV+ has been read +ARGF+ removes it from the Array. Thus, after all files have been read +ARGV+ will be empty. You can manipulate +ARGV+ yourself to control what +ARGF+ operates on. If you remove a file from +ARGV+, it is ignored by +ARGF+; if you add files to +ARGV+, they are treated as if they were named on the command line. For example: ARGV.replace ["file1"] ARGF.readlines # Returns the contents of file1 as an Array ARGV #=> [] ARGV.replace ["file2", "file3"] ARGF.read # Returns the contents of file2 and file3 If +ARGV+ is empty, +ARGF+ acts as if it contained STDIN, i.e. the data piped to your script. For example: $ echo "glark" | ruby -e 'p ARGF.read' "glark\n";T;[;[;I":$ ruby argf.rb --verbose file1 file2 ARGV #=> ["--verbose", "file1", "file2"] option = ARGV.shift #=> "--verbose" ARGV #=> ["file1", "file2"] You can now use +ARGF+ to work with a concatenation of each of these named files. For instance, +ARGF.read+ will return the contents of _file1_ followed by the contents of _file2_. After a file in +ARGV+ has been read +ARGF+ removes it from the Array. Thus, after all files have been read +ARGV+ will be empty. You can manipulate +ARGV+ yourself to control what +ARGF+ operates on. If you remove a file from +ARGV+, it is ignored by +ARGF+; if you add files to +ARGV+, they are treated as if they were named on the command line. For example: ARGV.replace ["file1"] ARGF.readlines # Returns the contents of file1 as an Array ARGV #=> [] ARGV.replace ["file2", "file3"] ARGF.read # Returns the contents of file2 and file3 If +ARGV+ is empty, +ARGF+ acts as if it contained STDIN, i.e. the data piped to your script. For example: $ echo "glark" | ruby -e 'p ARGF.read' "glark\n" ;T;0; @ž=;'@;I" ARGF;F;~I";+ARGF+ is a stream designed for use in scripts that process files given as command-line arguments or passed in via STDIN. The arguments passed to your script are stored in the +ARGV+ Array, one argument per element. +ARGF+ assumes that any arguments that aren't filenames have been removed from +ARGV+. For example;To; ;IC;[o;;F; ;;;Ï;I"Signal#trap;F;[[@c0;[[@ in;T;;ª;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; @«=;>0;!F;[o;= ;3I" overload;F;40;;ª;50;)I"trap( signal, command );T;IC;";T; @«=;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @«=;[;I"@return [Object];T;0;6i;[[I"signal;T0[I"command;T0; @«=o;= ;3I" overload;F;40;;ª;50;)I"trap( signal );T;IC;";T; @«=;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I";T; @«=o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @«=;[;I" @yield [ ] @return [Object];T;0;6i;[[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;'@©=;(I"ïstatic VALUE sig_trap(int argc, VALUE *argv, VALUE _) { 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 (rb_obj_is_proc(cmd) && !rb_ractor_main_p() && !rb_ractor_shareable_p(cmd)) { cmd = rb_proc_isolate(cmd); } return trap(sig, func, cmd); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Signal.trap;F;@=;@¯=;T;;ª;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;= ;3I" overload;F;40;;ª;50;)I"trap( signal, command );T;IC;";T; @Þ=;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @Þ=;[;I"@return [Object];T;0;6i;[[I"signal;T0[I"command;T0; @Þ=o;= ;3I" overload;F;40;;ª;50;)I"trap( signal );T;IC;";T; @Þ=;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I";T; @Þ=o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @Þ=;[;I" @yield [ ] @return [Object];T;0;6i;[[I"signal;T0; @Þ=;[;@C ;0; @Þ=;!F;"o;#;$T;%iO;&in;6i;'@©=;(@Ü=;)@Ý=;*To;;F; ;;;Ï;I"Signal#list;F;[;[[@ iš;T;;²;0;[;{;IC;"ïReturns a list of signal names mapped to the corresponding underlying signal numbers. Signal.list #=> {"EXIT"=>0, "HUP"=>1, "INT"=>2, "QUIT"=>3, "ILL"=>4, "TRAP"=>5, "IOT"=>6, "ABRT"=>6, "FPE"=>8, "KILL"=>9, "BUS"=>7, "SEGV"=>11, "SYS"=>31, "PIPE"=>13, "ALRM"=>14, "TERM"=>15, "URG"=>23, "STOP"=>19, "TSTP"=>20, "CONT"=>18, "CHLD"=>17, "CLD"=>17, "TTIN"=>21, "TTOU"=>22, "IO"=>29, "XCPU"=>24, "XFSZ"=>25, "VTALRM"=>26, "PROF"=>27, "WINCH"=>28, "USR1"=>10, "USR2"=>12, "PWR"=>30, "POLL"=>29} ;T; @ >;>0;!F;[o;= ;3I" overload;F;40;;²;50;)I" list;T;IC;";T; @ >;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @ >;[;I"@return [Hash];T;0;6i;[; @ >;[;I"Returns a list of signal names mapped to the corresponding underlying signal numbers. Signal.list #=> {"EXIT"=>0, "HUP"=>1, "INT"=>2, "QUIT"=>3, "ILL"=>4, "TRAP"=>5, "IOT"=>6, "ABRT"=>6, "FPE"=>8, "KILL"=>9, "BUS"=>7, "SEGV"=>11, "SYS"=>31, "PIPE"=>13, "ALRM"=>14, "TERM"=>15, "URG"=>23, "STOP"=>19, "TSTP"=>20, "CONT"=>18, "CHLD"=>17, "CLD"=>17, "TTIN"=>21, "TTOU"=>22, "IO"=>29, "XCPU"=>24, "XFSZ"=>25, "VTALRM"=>26, "PROF"=>27, "WINCH"=>28, "USR1"=>10, "USR2"=>12, "PWR"=>30, "POLL"=>29} @overload list @return [Hash];T;0;'@©=;(I"Østatic VALUE sig_list(VALUE _) { VALUE h = rb_hash_new(); const struct signals *sigs; FOREACH_SIGNAL(sigs, 0) { rb_hash_aset(h, rb_fstring_cstr(sigs->signm), INT2FIX(sigs->signo)); } return h; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Signal.list;F;@>;@ >;T;;²;0;@>;{;IC;"ïReturns a list of signal names mapped to the corresponding underlying signal numbers. Signal.list #=> {"EXIT"=>0, "HUP"=>1, "INT"=>2, "QUIT"=>3, "ILL"=>4, "TRAP"=>5, "IOT"=>6, "ABRT"=>6, "FPE"=>8, "KILL"=>9, "BUS"=>7, "SEGV"=>11, "SYS"=>31, "PIPE"=>13, "ALRM"=>14, "TERM"=>15, "URG"=>23, "STOP"=>19, "TSTP"=>20, "CONT"=>18, "CHLD"=>17, "CLD"=>17, "TTIN"=>21, "TTOU"=>22, "IO"=>29, "XCPU"=>24, "XFSZ"=>25, "VTALRM"=>26, "PROF"=>27, "WINCH"=>28, "USR1"=>10, "USR2"=>12, "PWR"=>30, "POLL"=>29};T;[o;= ;3I" overload;F;40;;²;50;)I" list;T;IC;";T; @$>;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @$>;[;I"@return [Hash];T;0;6i;[; @$>;[;I"Returns a list of signal names mapped to the corresponding underlying signal numbers. Signal.list #=> {"EXIT"=>0, "HUP"=>1, "INT"=>2, "QUIT"=>3, "ILL"=>4, "TRAP"=>5, "IOT"=>6, "ABRT"=>6, "FPE"=>8, "KILL"=>9, "BUS"=>7, "SEGV"=>11, "SYS"=>31, "PIPE"=>13, "ALRM"=>14, "TERM"=>15, "URG"=>23, "STOP"=>19, "TSTP"=>20, "CONT"=>18, "CHLD"=>17, "CLD"=>17, "TTIN"=>21, "TTOU"=>22, "IO"=>29, "XCPU"=>24, "XFSZ"=>25, "VTALRM"=>26, "PROF"=>27, "WINCH"=>28, "USR1"=>10, "USR2"=>12, "PWR"=>30, "POLL"=>29} @overload list @return [Hash];T;0; @$>;!F;"o;#;$T;%i‘;&i˜;6i;'@©=;(@">;)@#>;*To;;F; ;;;Ï;I"Signal#signame;F;[[I" signo;T0;[[@ i3;T;:signame;0;[;{;IC;"ÖConvert signal number to signal name. Returns +nil+ if the signo is an invalid signal number. Signal.trap("INT") { |signo| puts Signal.signame(signo) } Process.kill("INT", 0) produces: INT ;T; @9>;>0;!F;[o;= ;3I" overload;F;40;;‚;50;)I"signame(signo);T;IC;";T; @9>;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @9>;[;I"@return [String, nil];T;0;6i;[[I" signo;T0; @9>;[;I"Convert signal number to signal name. Returns +nil+ if the signo is an invalid signal number. Signal.trap("INT") { |signo| puts Signal.signame(signo) } Process.kill("INT", 0) produces: INT @overload signame(signo) @return [String, nil];T;0;'@©=;(I"°static VALUE sig_signame(VALUE recv, VALUE signo) { const char *signame = signo2signm(NUM2INT(signo)); if (!signame) return Qnil; return rb_str_new_cstr(signame); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Signal.signame;F;@;>;@>>;T;;‚;0;@@>;{;IC;"ÖConvert signal number to signal name. Returns +nil+ if the signo is an invalid signal number. Signal.trap("INT") { |signo| puts Signal.signame(signo) } Process.kill("INT", 0) produces: INT;T;[o;= ;3I" overload;F;40;;‚;50;)I"signame(signo);T;IC;";T; @X>;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @X>;[;I"@return [String, nil];T;0;6i;[[I" signo;T0; @X>;[;I" Convert signal number to signal name. Returns +nil+ if the signo is an invalid signal number. Signal.trap("INT") { |signo| puts Signal.signame(signo) } Process.kill("INT", 0) produces: INT @overload signame(signo) @return [String, nil];T;0; @X>;!F;"o;#;$T;%i%;&i1;6i;'@©=;(@V>;)@W>;*T;A@©=;BIC;[;A@©=;CIC;[;A@©=;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ i ;F;:Signal;;K;;;[;{;IC;";T;[;[;@|;0; @©=;6i;'@;I"Signal;Fo; ;IC;[ o;;F; ;;;;I"ThreadGroup#list;F;[;[[@80i";T;;²;0;[;{;IC;"‰Returns an array of all existing Thread objects that belong to this group. ThreadGroup::Default.list #=> [#] ;T;[o;= ;3I" overload;F;40;;²;50;)I" list;T;IC;";T; @>;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @>;[;I"@return [Array];T;0;6i;[; @>;[;I"¬Returns an array of all existing Thread objects that belong to this group. ThreadGroup::Default.list #=> [#] @overload list @return [Array];T;0; @>;!F;"o;#;$T;%i;&i;'@>;(I"static VALUE thgroup_list(VALUE group) { VALUE ary = rb_ary_new(); rb_thread_t *th = 0; rb_ractor_t *r = GET_RACTOR(); list_for_each(&r->threads.set, th, lt_node) { if (th->thgroup == group) { rb_ary_push(ary, th->self); } } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"ThreadGroup#enclose;F;[;[[@80iB;T;:enclose;0;[;{;IC;"ªPrevents threads from being added to or removed from the receiving ThreadGroup. New threads can still be started in an enclosed ThreadGroup. ThreadGroup::Default.enclose #=> # thr = Thread.new { Thread.stop } #=> # tg = ThreadGroup.new #=> # tg.add thr #=> ThreadError: can't move from the enclosed thread group ;T;[o;= ;3I" overload;F;40;;„;50;)I"enclose;T;IC;";T; @œ>;>0;!F;[;[;I";T;0;6i;[; @œ>;[;I"¾Prevents threads from being added to or removed from the receiving ThreadGroup. New threads can still be started in an enclosed ThreadGroup. ThreadGroup::Default.enclose #=> # thr = Thread.new { Thread.stop } #=> # tg = ThreadGroup.new #=> # tg.add thr #=> ThreadError: can't move from the enclosed thread group @overload enclose;T;0; @œ>;!F;"o;#;$T;%i2;&i>;'@>;(I"¾static VALUE thgroup_enclose(VALUE group) { struct thgroup *data; TypedData_Get_Struct(group, struct thgroup, &thgroup_data_type, data); data->enclosed = 1; return group; };T;)I"static VALUE;T;*To;;F; ;;;;I"ThreadGroup#enclosed?;F;[;[[@80iU;T;:enclosed?;0;[;{;IC;"MReturns +true+ if the +thgrp+ is enclosed. See also ThreadGroup#enclose.;T;[o;= ;3I" overload;F;40;;…;50;)I"enclosed?;T;IC;";T; @²>;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @²>;[;I"@return [Boolean];T;0;6i;[; @²>;[;I"wReturns +true+ if the +thgrp+ is enclosed. See also ThreadGroup#enclose. @overload enclosed? @return [Boolean];T;0; @²>;!F;"o;#;$T;%iN;&iR;6i;'@>;(I"Ðstatic VALUE thgroup_enclosed_p(VALUE group) { struct thgroup *data; TypedData_Get_Struct(group, struct thgroup, &thgroup_data_type, data); if (data->enclosed) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"ThreadGroup#add;F;[[I"thread;T0;[[@80i{;T;;?;0;[;{;IC;"sAdds the given +thread+ to this group, removing it from any other group to which it may have previously been a member. puts "Initial group is #{ThreadGroup::Default.list}" tg = ThreadGroup.new t1 = Thread.new { sleep } t2 = Thread.new { sleep } puts "t1 is #{t1}" puts "t2 is #{t2}" tg.add(t1) puts "Initial group now #{ThreadGroup::Default.list}" puts "tg group now #{tg.list}" This will produce: Initial group is # t1 is # t2 is # Initial group now ## tg group now # ;T;[o;= ;3I" overload;F;40;;?;50;)I"add(thread);T;IC;";T; @Í>;>0;!F;[;[;I";T;0;6i;[[I"thread;T0; @Í>;[;I"‹Adds the given +thread+ to this group, removing it from any other group to which it may have previously been a member. puts "Initial group is #{ThreadGroup::Default.list}" tg = ThreadGroup.new t1 = Thread.new { sleep } t2 = Thread.new { sleep } puts "t1 is #{t1}" puts "t2 is #{t2}" tg.add(t1) puts "Initial group now #{ThreadGroup::Default.list}" puts "tg group now #{tg.list}" This will produce: Initial group is # t1 is # t2 is # Initial group now ## tg group now # @overload add(thread);T;0; @Í>;!F;"o;#;$T;%ia;&iw;'@>;(I"Cstatic VALUE thgroup_add(VALUE group, VALUE thread) { rb_thread_t *target_th = rb_thread_ptr(thread); struct thgroup *data; if (OBJ_FROZEN(group)) { rb_raise(rb_eThreadError, "can't move to the frozen thread group"); } TypedData_Get_Struct(group, struct thgroup, &thgroup_data_type, data); if (data->enclosed) { rb_raise(rb_eThreadError, "can't move to the enclosed thread group"); } if (!target_th->thgroup) { return Qnil; } if (OBJ_FROZEN(target_th->thgroup)) { rb_raise(rb_eThreadError, "can't move from the frozen thread group"); } TypedData_Get_Struct(target_th->thgroup, struct thgroup, &thgroup_data_type, data); if (data->enclosed) { rb_raise(rb_eThreadError, "can't move from the enclosed thread group"); } target_th->thgroup = group; return group; };T;)I"static VALUE;T;*To;{;[[@80i¢;F;:Default;;};;;[;{;IC;"\The default ThreadGroup created when Ruby starts; all Threads belong to it by default.;T;[;[;I"_ The default ThreadGroup created when Ruby starts; all Threads belong to it by default. ;T;0; @ç>;'@>;I"ThreadGroup::Default;F;~I"th->thgroup;T;A@>;BIC;[;A@>;CIC;[;A@>;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@80iù[@80i™;T;:ThreadGroup;;K;;;[;{;IC;"=ThreadGroup provides a means of keeping track of a number of threads as a group. A given Thread object can only belong to one ThreadGroup at a time; adding a thread to a new group will remove it from any previous group. Newly created threads belong to the same group as the thread from which they were created.;T;[;[;I"@ ThreadGroup provides a means of keeping track of a number of threads as a group. A given Thread object can only belong to one ThreadGroup at a time; adding a thread to a new group will remove it from any previous group. Newly created threads belong to the same group as the thread from which they were created. ;T;0; @>;!F;"o;#;$T;%iù;&i;6i;'@;I"ThreadGroup;F;S@]o; ;IC;[;A@?;BIC;[;A@?;CIC;[;A@?;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@80iA[@80i¦;T;:ThreadError;;K;;;[;{;IC;"óRaised when an invalid operation is attempted on a thread. For example, when no other thread has been started: Thread.stop This will raises the following exception: ThreadError: stopping only thread note: use sleep to stop forever ;T;[;[;I"õ Raised when an invalid operation is attempted on a thread. For example, when no other thread has been started: Thread.stop This will raises the following exception: ThreadError: stopping only thread note: use sleep to stop forever ;T;0; @?;!F;"o;#;$T;%iA;&iL;'@;I"ThreadError;F;So;L;M0;N0;O0;;ë;'@;Q@ì;R;Fo; ;IC;[,o;{;[[I"parse.c;TiïS[I"ext/ripper/ripper.c;TiT;F;:Version;;};;;[;{;IC;"version of Ripper ;T;[;[;I"version of Ripper;T;0; @?;!F;"o;#;$T;%iT;&iT;'@?;I"Ripper::Version;F;~I"(rb_usascii_str_new2(RIPPER_VERSION);To;;F; ;;;;I"Ripper#initialize;F;[[@c0;[[@?iüR[@ ?i)S;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;= ;3I" overload;F;40;;î;50;)I",new(src, filename="(ripper)", lineno=1);T;IC;";T; @*?;>0;!F;[;[;I";T;0;6i;[[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;%iS;&i&S;'@?;(I"˜static VALUE ripper_initialize(int argc, VALUE *argv, VALUE self) { struct parser_params *p; VALUE src, fname, lineno; TypedData_Get_Struct(self, struct parser_params, &parser_data_type, p); rb_scan_args(argc, argv, "12", &src, &fname, &lineno); if (RB_TYPE_P(src, T_FILE)) { p->lex.gets = ripper_lex_io_get; } else if (rb_respond_to(src, id_gets)) { p->lex.gets = ripper_lex_get_generic; } else { StringValue(src); p->lex.gets = lex_get_str; } p->lex.input = src; p->eofp = 0; if (NIL_P(fname)) { fname = STR_NEW2("(ripper)"); OBJ_FREEZE(fname); } else { StringValueCStr(fname); fname = rb_str_new_frozen(fname); } parser_initialize(p); p->ruby_sourcefile_string = fname; p->ruby_sourcefile = RSTRING_PTR(fname); p->ruby_sourceline = NIL_P(lineno) ? 0 : NUM2INT(lineno) - 1; return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"Ripper#parse;F;[;[[@?i?S[@ ?ilS;T;: parse;0;[;{;IC;"0;!F;[;[;I";T;0;6i;[; @J?;[;I"NStart parsing and returns the value of the root action. @overload parse;T;0; @J?;!F;"o;#;$T;%ifS;&iiS;'@?;(I"ƒstatic VALUE ripper_parse(VALUE self) { struct parser_params *p; TypedData_Get_Struct(self, struct parser_params, &parser_data_type, p); if (!ripper_initialized_p(p)) { rb_raise(rb_eArgError, "method called for uninitialized object"); } if (!NIL_P(p->parsing_thread)) { if (p->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"); } p->parsing_thread = rb_thread_current(); rb_ensure(ripper_parse0, self, ripper_ensure, self); return p->result; };T;)I"static VALUE;T;*To;;F; ;;;;I"Ripper#column;F;[;[[@?i[S[@ ?iˆS;T;:column;0;[;{;IC;"MReturn column number of current parsing line. This number starts from 0. ;T;[o;= ;3I" overload;F;40;;‹;50;)I"column;T;IC;";T; @a?;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @a?;[;I"@return [Integer];T;0;6i;[; @a?;[;I"tReturn column number of current parsing line. This number starts from 0. @overload column @return [Integer];T;0; @a?;!F;"o;#;$T;%iS;&i†S;'@?;(I"„static VALUE ripper_column(VALUE self) { struct parser_params *p; long col; TypedData_Get_Struct(self, struct parser_params, &parser_data_type, p); if (!ripper_initialized_p(p)) { rb_raise(rb_eArgError, "method called for uninitialized object"); } if (NIL_P(p->parsing_thread)) return Qnil; col = p->lex.ptok - p->lex.pbeg; return LONG2NUM(col); };T;)I"static VALUE;T;*To;;F; ;;;;I"Ripper#filename;F;[;[[@?ipS[@ ?iS;T;: filename;0;[;{;IC;"%Return current parsing filename. ;T;[o;= ;3I" overload;F;40;;Œ;50;)I" filename;T;IC;";T; @}?;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @}?;[;I"@return [String];T;0;6i;[; @}?;[;I"MReturn current parsing filename. @overload filename @return [String];T;0; @}?;!F;"o;#;$T;%i—S;&i›S;'@?;(I"0static VALUE ripper_filename(VALUE self) { struct parser_params *p; TypedData_Get_Struct(self, struct parser_params, &parser_data_type, p); if (!ripper_initialized_p(p)) { rb_raise(rb_eArgError, "method called for uninitialized object"); } return p->ruby_sourcefile_string; };T;)I"static VALUE;T;*To;;F; ;;;;I"Ripper#lineno;F;[;[[@?iƒS[@ ?i°S;T;;;0;[;{;IC;"KReturn line number of current parsing line. This number starts from 1. ;T;[o;= ;3I" overload;F;40;;;50;)I"lineno;T;IC;";T; @™?;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @™?;[;I"@return [Integer];T;0;6i;[; @™?;[;I"rReturn line number of current parsing line. This number starts from 1. @overload lineno @return [Integer];T;0; @™?;!F;"o;#;$T;%i©S;&i®S;'@?;(I"_static VALUE ripper_lineno(VALUE self) { struct parser_params *p; TypedData_Get_Struct(self, struct parser_params, &parser_data_type, p); if (!ripper_initialized_p(p)) { rb_raise(rb_eArgError, "method called for uninitialized object"); } if (NIL_P(p->parsing_thread)) return Qnil; return INT2NUM(p->ruby_sourceline); };T;)I"static VALUE;T;*To;;F; ;;;;I"Ripper#state;F;[;[[@?i–S[@ ?iÃS;T;;1;0;[;{;IC;"+Return scanner state of current token. ;T;[o;= ;3I" overload;F;40;;1;50;)I" state;T;IC;";T; @µ?;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @µ?;[;I"@return [Integer];T;0;6i;[; @µ?;[;I"QReturn scanner state of current token. @overload state @return [Integer];T;0; @µ?;!F;"o;#;$T;%i½S;&iÁS;'@?;(I"Qstatic VALUE ripper_state(VALUE self) { struct parser_params *p; TypedData_Get_Struct(self, struct parser_params, &parser_data_type, p); if (!ripper_initialized_p(p)) { rb_raise(rb_eArgError, "method called for uninitialized object"); } if (NIL_P(p->parsing_thread)) return Qnil; return INT2NUM(p->lex.state); };T;)I"static VALUE;T;*To;;F; ;;;;I"Ripper#token;F;[;[[@?i©S[@ ?iÖS;T;: token;0;[;{;IC;"%Return the current token string. ;T;[o;= ;3I" overload;F;40;;;50;)I" token;T;IC;";T; @Ñ?;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Ñ?;[;I"@return [String];T;0;6i;[; @Ñ?;[;I"JReturn the current token string. @overload token @return [String];T;0; @Ñ?;!F;"o;#;$T;%iÐS;&iÔS;'@?;(I"Èstatic VALUE ripper_token(VALUE self) { struct parser_params *p; long pos, len; TypedData_Get_Struct(self, struct parser_params, &parser_data_type, p); if (!ripper_initialized_p(p)) { rb_raise(rb_eArgError, "method called for uninitialized object"); } if (NIL_P(p->parsing_thread)) return Qnil; pos = p->lex.ptok - p->lex.pbeg; len = p->lex.pcur - p->lex.ptok; return rb_str_subseq(p->lex.lastline, pos, len); };T;)I"static VALUE;T;*To;;F; ;;;;I"Ripper#end_seen?;F;[;[[@?i9Q[@ ?ifQ;T;:end_seen?;0;[;{;IC;"9Return true if parsed source ended by +\_\_END\_\_+.;T;[o;= ;3I" overload;F;40;;Ž;50;)I"end_seen?;T;IC;";T; @í?;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @í?;[;I"@return [Boolean];T;0;6i;[; @í?;[;I"cReturn true if parsed source ended by +\_\_END\_\_+. @overload end_seen? @return [Boolean];T;0; @í?;!F;"o;#;$T;%i`Q;&idQ;6i;'@?;(I"ÊVALUE rb_parser_end_seen_p(VALUE vparser) { struct parser_params *p; TypedData_Get_Struct(vparser, struct parser_params, &parser_data_type, p); return p->ruby__end__seen ? Qtrue : Qfalse; };T;)I" VALUE;T;*To;;F; ;;;;I"Ripper#encoding;F;[;[[@?iHQ[@ ?iuQ;T;;³;0;[;{;IC;"#Return encoding of the source. ;T;[o;= ;3I" overload;F;40;;³;50;)I" encoding;T;IC;";T; @ @;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Encoding;T; @ @;[;I"@return [Encoding];T;0;6i;[; @ @;[;I"MReturn encoding of the source. @overload encoding @return [Encoding];T;0; @ @;!F;"o;#;$T;%ioQ;&isQ;'@?;(I"ÁVALUE rb_parser_encoding(VALUE vparser) { struct parser_params *p; TypedData_Get_Struct(vparser, struct parser_params, &parser_data_type, p); return rb_enc_from_encoding(p->enc); };T;)I" VALUE;T;*To;;F; ;;;;I"Ripper#yydebug;F;[;[[@?iXQ[@ ?i…Q;T;:yydebug;0;[;{;IC;"Get yydebug. ;T;[o;= ;3I" overload;F;40;;;50;)I"yydebug;T;IC;";T; @%@;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @%@;[;I"@return [Boolean];T;0;6i;[; @%@;[;I"9Get yydebug. @overload yydebug @return [Boolean];T;0; @%@;!F;"o;#;$T;%iQ;&iƒQ;'@?;(I"»VALUE rb_parser_get_yydebug(VALUE self) { struct parser_params *p; TypedData_Get_Struct(self, struct parser_params, &parser_data_type, p); return p->debug ? Qtrue : Qfalse; };T;)I" VALUE;T;*To;;F; ;;;;I"Ripper#yydebug=;F;[[I" flag;T0;[[@?ihQ[@ ?i•Q;T;: yydebug=;0;[;{;IC;"Set yydebug. ;T;[o;= ;3I" overload;F;40;;;50;)I"yydebug=(flag);T;IC;";T; @A@;>0;!F;[;[;I";T;0;6i;[[I" flag;T0; @A@;[;I",Set yydebug. @overload yydebug=(flag);T;0; @A@;!F;"o;#;$T;%iQ;&i’Q;'@?;(I"ÎVALUE rb_parser_set_yydebug(VALUE self, VALUE flag) { struct parser_params *p; TypedData_Get_Struct(self, struct parser_params, &parser_data_type, p); p->debug = RTEST(flag); return flag; };T;)I" VALUE;T;*To;;F; ;;;;I"Ripper#debug_output;F;[;[[@?ixQ[@ ?i¥Q;T;:debug_output;0;[;{;IC;"Get debug output. ;T;[o;= ;3I" overload;F;40;;‘;50;)I"debug_output;T;IC;";T; @\@;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @\@;[;I"@return [Object];T;0;6i;[; @\@;[;I"BGet debug output. @overload debug_output @return [Object];T;0; @\@;!F;"o;#;$T;%iŸQ;&i£Q;'@?;(I"¶VALUE rb_parser_get_debug_output(VALUE self) { struct parser_params *p; TypedData_Get_Struct(self, struct parser_params, &parser_data_type, p); return p->debug_output; };T;)I" VALUE;T;*To;;F; ;;;;I"Ripper#debug_output=;F;[[I"output;T0;[[@?i‡Q[@ ?i´Q;T;:debug_output=;0;[;{;IC;"Set debug output. ;T;[o;= ;3I" overload;F;40;;’;50;)I"debug_output=(obj);T;IC;";T; @x@;>0;!F;[;[;I";T;0;6i;[[I"obj;T0; @x@;[;I"5Set debug output. @overload debug_output=(obj);T;0; @x@;!F;"o;#;$T;%i®Q;&i±Q;'@?;(I"ÍVALUE rb_parser_set_debug_output(VALUE self, VALUE output) { struct parser_params *p; TypedData_Get_Struct(self, struct parser_params, &parser_data_type, p); return p->debug_output = output; };T;)I" VALUE;T;*To;;F; ;;;;I"Ripper#error?;F;[;[[@?i)Q[@ ?iVQ;T;:error?;0;[;{;IC;"-Return true if parsed source has errors.;T;[o;= ;3I" overload;F;40;;“;50;)I"error?;T;IC;";T; @“@;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @“@;[;I"@return [Boolean];T;0;6i;[; @“@;[;I"TReturn true if parsed source has errors. @overload error? @return [Boolean];T;0; @“@;!F;"o;#;$T;%iPQ;&iTQ;6i;'@?;(I"Ãstatic VALUE ripper_error_p(VALUE vparser) { struct parser_params *p; TypedData_Get_Struct(vparser, struct parser_params, &parser_data_type, p); return p->error_p ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Ripper#assert_Qundef;F;[[I"obj;T0[I"msg;T0;[[@?i»S[@ ?ièS;T;:assert_Qundef;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @¯@;!F;"o;#;$T;%içS;&içS;'@?;(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;)I"static VALUE;T;*To;;F; ;;;;I"Ripper#rawVALUE;F;[[I"obj;T0;[[@?iÆS[@ ?ióS;T;: rawVALUE;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @Â@;!F;"o;#;$T;%iòS;&iòS;'@?;(I"Tstatic VALUE ripper_value(VALUE self, VALUE obj) { return ULONG2NUM(obj); };T;)I"static VALUE;T;*To;;F; ;;;;I"Ripper#validate_object;F;[[I"x;T0;[[@?iER[@ ?irR;T;:validate_object;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @Ó@;!F;"o;#;$T;%iqR;&iqR;'@?;(I"vstatic 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; 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: break; case T_NODE: if (nd_type((NODE *)x) != NODE_RIPPER) { rb_raise(rb_eArgError, "NODE given: %p", (void *)x); } x = ((NODE *)x)->nd_rval; break; default: rb_raise(rb_eArgError, "wrong type of ruby object: %p (%s)", (void *)x, rb_obj_classname(x)); } if (!RBASIC_CLASS(x)) { rb_raise(rb_eArgError, "hidden ruby object: %p (%s)", (void *)x, rb_builtin_type_name(TYPE(x))); } return x; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Ripper.dedent_string;F;[[I" input;T0[I" width;T0;[[@?i|;[@ ?i©;;T;:dedent_string;0;[;{;IC;"USE OF RIPPER LIBRARY ONLY. Strips up to +width+ leading whitespaces from +input+, and returns the stripped column width. ;T;[o;= ;3I" overload;F;40;;—;50;)I" dedent_string(input, width);T;IC;";T; @ä@;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ä@;[;I"@return [Integer];T;0;6i;[[I" input;T0[I" width;T0; @ä@;[;I"¶USE OF RIPPER LIBRARY ONLY. Strips up to +width+ leading whitespaces from +input+, and returns the stripped column width. @overload dedent_string(input, width) @return [Integer];T;0; @ä@;!F;"o;#;$T;%i ;;&i§;;'@?;(I"Ïstatic VALUE parser_dedent_string(VALUE self, VALUE input, VALUE width) { int wid, col; StringValue(input); wid = NUM2UINT(width); col = dedent_string(input, wid); return INT2NUM(col); };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Ripper#dedent_string;F;[[I" input;T0[I" width;T0;[[@?i|;[@ ?i©;;T;;—;0;[;{;IC;"USE OF RIPPER LIBRARY ONLY. Strips up to +width+ leading whitespaces from +input+, and returns the stripped column width. ;T;[o;= ;3I" overload;F;40;;—;50;)I" dedent_string(input, width);T;IC;";T; @A;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @A;[;I"@return [Integer];T;0;6i;[[I" input;T0[I" width;T0; @A;[;@A;0; @A;!F;"o;#;$T;%i ;;&i§;;'@?;(I"Ïstatic VALUE parser_dedent_string(VALUE self, VALUE input, VALUE width) { int wid, col; StringValue(input); wid = NUM2UINT(width); col = dedent_string(input, wid); return INT2NUM(col); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Ripper.lex_state_name;F;[[I" state;T0;[[@?iÓS[@ ?iT;T;:lex_state_name;0;[;{;IC;"2Returns a string representation of lex_state. ;T;[o;= ;3I" overload;F;40;;˜;50;)I"lex_state_name(integer);T;IC;";T; @+A;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @+A;[;I"@return [String];T;0;6i;[[I"integer;T0; @+A;[;I"iReturns a string representation of lex_state. @overload lex_state_name(integer) @return [String];T;0; @+A;!F;"o;#;$T;%iúS;&iþS;'@?;(I"ystatic VALUE ripper_lex_state_name(VALUE self, VALUE state) { return rb_parser_lex_state_name(NUM2INT(state)); };T;)I"static VALUE;T;*To;{;[[@ ?i8T;F;: EXPR_BEG;;};;;[;{;IC;"#ignore newline, +/- is a sign. ;T;[;[;I"#ignore newline, +/- is a sign.;T;0; @KA;!F;"o;#;$T;%i7T;&i7T;'@?;I"Ripper::EXPR_BEG;F;~I"INT2NUM(EXPR_BEG);To;{;[[@ ?i:T;F;: EXPR_END;;};;;[;{;IC;"-newline significant, +/- is an operator. ;T;[;[;I"-newline significant, +/- is an operator.;T;0; @WA;!F;"o;#;$T;%i9T;&i9T;'@?;I"Ripper::EXPR_END;F;~I"INT2NUM(EXPR_END);To;{;[[@ ?iT;F;:EXPR_ENDFN;;};;;[;{;IC;"ditto, and unbound braces. ;T;[;[;I"ditto, and unbound braces.;T;0; @oA;!F;"o;#;$T;%i=T;&i=T;'@?;I"Ripper::EXPR_ENDFN;F;~I"INT2NUM(EXPR_ENDFN);To;{;[[@ ?i@T;F;: EXPR_ARG;;};;;[;{;IC;"-newline significant, +/- is an operator. ;T;[;[;I"-newline significant, +/- is an operator.;T;0; @{A;!F;"o;#;$T;%i?T;&i?T;'@?;I"Ripper::EXPR_ARG;F;~I"INT2NUM(EXPR_ARG);To;{;[[@ ?iBT;F;:EXPR_CMDARG;;};;;[;{;IC;"-newline significant, +/- is an operator. ;T;[;[;I"-newline significant, +/- is an operator.;T;0; @‡A;!F;"o;#;$T;%iAT;&iAT;'@?;I"Ripper::EXPR_CMDARG;F;~I"INT2NUM(EXPR_CMDARG);To;{;[[@ ?iDT;F;: EXPR_MID;;};;;[;{;IC;"-newline significant, +/- is an operator. ;T;[;[;I"-newline significant, +/- is an operator.;T;0; @“A;!F;"o;#;$T;%iCT;&iCT;'@?;I"Ripper::EXPR_MID;F;~I"INT2NUM(EXPR_MID);To;{;[[@ ?iFT;F;:EXPR_FNAME;;};;;[;{;IC;"'ignore newline, no reserved words. ;T;[;[;I"'ignore newline, no reserved words.;T;0; @ŸA;!F;"o;#;$T;%iET;&iET;'@?;I"Ripper::EXPR_FNAME;F;~I"INT2NUM(EXPR_FNAME);To;{;[[@ ?iHT;F;: EXPR_DOT;;};;;[;{;IC;":', no reserved words. ;T;[;[;I":', no reserved words.;T;0; @«A;!F;"o;#;$T;%iGT;&iGT;'@?;I"Ripper::EXPR_DOT;F;~I"right after `.' or `;To;{;[[@ ?iJT;F;:EXPR_CLASS;;};;;[;{;IC;"/immediate after `class', no here document. ;T;[;[;I"/immediate after `class', no here document.;T;0; @·A;!F;"o;#;$T;%iIT;&iIT;'@?;I"Ripper::EXPR_CLASS;F;~I"INT2NUM(EXPR_CLASS);To;{;[[@ ?iLT;F;:EXPR_LABEL;;};;;[;{;IC;" flag bit, label is allowed. ;T;[;[;I" flag bit, label is allowed.;T;0; @ÃA;!F;"o;#;$T;%iKT;&iKT;'@?;I"Ripper::EXPR_LABEL;F;~I"INT2NUM(EXPR_LABEL);To;{;[[@ ?iNT;F;:EXPR_LABELED;;};;;[;{;IC;""flag bit, just after a label. ;T;[;[;I""flag bit, just after a label.;T;0; @ÏA;!F;"o;#;$T;%iMT;&iMT;'@?;I"Ripper::EXPR_LABELED;F;~I"INT2NUM(EXPR_LABELED);To;{;[[@ ?iPT;F;:EXPR_FITEM;;};;;[;{;IC;"symbol literal as FNAME. ;T;[;[;I"symbol literal as FNAME.;T;0; @ÛA;!F;"o;#;$T;%iOT;&iOT;'@?;I"Ripper::EXPR_FITEM;F;~I"INT2NUM(EXPR_FITEM);To;{;[[@ ?iRT;F;:EXPR_VALUE;;};;;[;{;IC;"equals to +EXPR_BEG+ ;T;[;[;I"equals to +EXPR_BEG+;T;0; @çA;!F;"o;#;$T;%iQT;&iQT;'@?;I"Ripper::EXPR_VALUE;F;~I"INT2NUM(EXPR_VALUE);To;{;[[@ ?iTT;F;:EXPR_BEG_ANY;;};;;[;{;IC;":equals to (EXPR_BEG | EXPR_MID | EXPR_CLASS) ;T;[;[;I":equals to (EXPR_BEG | EXPR_MID | EXPR_CLASS);T;0; @óA;!F;"o;#;$T;%iST;&iST;'@?;I"Ripper::EXPR_BEG_ANY;F;~I"INT2NUM(EXPR_BEG_ANY);To;{;[[@ ?iVT;F;:EXPR_ARG_ANY;;};;;[;{;IC;"0equals to (EXPR_ARG | EXPR_CMDARG) ;T;[;[;I"0equals to (EXPR_ARG | EXPR_CMDARG);T;0; @ÿA;!F;"o;#;$T;%iUT;&iUT;'@?;I"Ripper::EXPR_ARG_ANY;F;~I"INT2NUM(EXPR_ARG_ANY);To;{;[[@ ?iXT;F;:EXPR_END_ANY;;};;;[;{;IC;"=equals to (EXPR_END | EXPR_ENDARG | EXPR_ENDFN) ;T;[;[;I"=equals to (EXPR_END | EXPR_ENDARG | EXPR_ENDFN);T;0; @B;!F;"o;#;$T;%iWT;&iWT;'@?;I"Ripper::EXPR_END_ANY;F;~I"INT2NUM(EXPR_END_ANY);To;{;[[@ ?iZT;F;:EXPR_NONE;;};;;[;{;IC;"equals to +0+ ;T;[;[;I"equals to +0+;T;0; @B;!F;"o;#;$T;%iYT;&iYT;'@?;I"Ripper::EXPR_NONE;F;~I"INT2NUM(EXPR_NONE);T;A@?;BIC;[;A@?;CIC;[;A@?;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@?iíS[@ ?iT;F;:Ripper;;K;;;[;{;IC;";T;[;[;@|;0; @?;6i;'@;I"Ripper;F;S@]o;{;[[@?iT[@ ?igT;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; @3B;!F;"o;#;$T;%ibT;&ieT;'@;I"SCRIPT_LINES__;F;~I" Qnil;To; ;IC;[o;;F; ;F;;;I"RubyVM.each_builtin;F;[;[[I"mini_builtin.c;TiE;T;:each_builtin;0;[;{;IC;";T;[;[;@|;0; @BB;'@@B;(I"xstatic VALUE each_builtin(VALUE self) { st_foreach(loaded_builtin_table, each_builtin_i, 0); return Qnil; };T;)I"static VALUE;T;*To;;F; ;F;;;I"RubyVM.stat;F;[[@c0;[[@.7iç;T;;W;0;[;{;IC;"ZReturns a Hash containing implementation-dependent counters inside the VM. This hash includes information about method/constant cache serials: { :global_constant_state=>481, :class_serial=>9029 } The contents of the hash are implementation specific and may be changed in the future. This method is only expected to work on C Ruby. ;T;[o;= ;3I" overload;F;40;;W;50;)I" stat;T;IC;";T; @OB;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @OB;[;I"@return [Hash];T;0;6i;[; @OBo;= ;3I" overload;F;40;;W;50;)I"stat(hsh);T;IC;";T; @OB;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Hash;T; @OB;[;I"@return [Hash];T;0;6i;[[I"hsh;T0; @OBo;= ;3I" overload;F;40;;W;50;)I"stat(Symbol);T;IC;";T; @OB;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @OB;[;I"@return [Numeric];T;0;6i;[[I"Symbol;T0; @OB;[;I"ÌReturns a Hash containing implementation-dependent counters inside the VM. This hash includes information about method/constant cache serials: { :global_constant_state=>481, :class_serial=>9029 } The contents of the hash are implementation specific and may be changed in the future. This method is only expected to work on C Ruby. @overload stat @return [Hash] @overload stat(hsh) @return [Hash] @overload stat(Symbol) @return [Numeric];T;0; @OB;!F;"o;#;$T;%iÒ;&iæ;'@@B;(I" static VALUE vm_stat(int argc, VALUE *argv, VALUE self) { static VALUE sym_global_constant_state, sym_class_serial; VALUE arg = Qnil; VALUE hash = Qnil, key = Qnil; if (rb_check_arity(argc, 0, 1) == 1) { arg = argv[0]; if (SYMBOL_P(arg)) key = arg; else if (RB_TYPE_P(arg, T_HASH)) hash = arg; else rb_raise(rb_eTypeError, "non-hash or symbol given"); } else { hash = rb_hash_new(); } if (sym_global_constant_state == 0) { #define S(s) sym_##s = ID2SYM(rb_intern_const(#s)) S(global_constant_state); S(class_serial); #undef S } #define SET(name, attr) \ if (key == sym_##name) \ return SERIALT2NUM(attr); \ else if (hash != Qnil) \ rb_hash_aset(hash, sym_##name, SERIALT2NUM(attr)); SET(global_constant_state, ruby_vm_global_constant_state); SET(class_serial, ruby_vm_class_serial); #undef SET if (!NIL_P(key)) { /* matched key should return above */ rb_raise(rb_eArgError, "unknown key: %"PRIsVALUE, rb_sym2str(key)); } return hash; };T;)I"static VALUE;T;*To;;F; ;F;;;I" RubyVM.reset_debug_counters;F;[;[[I"debug_counter.c;Ti;T;:reset_debug_counters;0;[;{;IC;";T;[;[;@|;0; @‰B;'@@B;(I"rVALUE rb_debug_counter_reset(RB_UNUSED_VAR(VALUE klass)) { ruby_debug_counter_reset(); return Qnil; };T;)I" VALUE;T;*To;;F; ;F;;;I"RubyVM.show_debug_counters;F;[;[[@ŽBiw;T;:show_debug_counters;0;[;{;IC;";T;[;[;@|;0; @–B;'@@B;(I"²VALUE rb_debug_counter_show(RB_UNUSED_VAR(VALUE klass)) { rb_debug_counter_show_results("show_debug_counters"); ruby_debug_counter_show_at_exit(FALSE); return Qnil; };T;)I" VALUE;T;*To; ;IC;[o;;F; ;F;;;I"RubyVM::MJIT.enabled?;F;[;[[@.7i›;T;: enabled?;0;[;{;IC;"#Returns true if JIT is enabled;T;[o;2 ;3I"return;F;4@|;0;5[@~; @¤B;[;I"#Returns true if JIT is enabled;T;0; @¤B;!F;"o;#;$T;%iš;&iš;6i;'@¢B;(I"Wstatic VALUE mjit_enabled_p(VALUE _) { return mjit_enabled ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;F;;;I"RubyVM::MJIT.pause;F;[;[[@.7i¡;T;: pause;0;[;{;IC;";T;[;[;@|;0; @µB;'@¢B;(I"Ÿstatic VALUE mjit_pause_m(int argc, VALUE *argv, RB_UNUSED_VAR(VALUE self)) { VALUE options = Qnil; VALUE wait = Qtrue; rb_scan_args(argc, argv, "0:", &options); if (!NIL_P(options)) { static ID keyword_ids[1]; if (!keyword_ids[0]) keyword_ids[0] = rb_intern("wait"); rb_get_kwargs(options, keyword_ids, 0, 1, &wait); } return mjit_pause(RTEST(wait)); };T;)I"static VALUE;T;*To;;F; ;F;;;I"RubyVM::MJIT.resume;F;[;[[@.7i²;T;;u;0;[;{;IC;";T;[;[;@|;0; @ÁB;'@¢B;(I"Fstatic VALUE mjit_resume_m(VALUE _) { return mjit_resume(); };T;)I"static VALUE;T;*T;A@¢B;BIC;[;A@¢B;CIC;[;A@¢B;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@.7iD ;F;: MJIT;;K;;;[;{;IC;";T;[;[;@|;0; @¢B;6i;'@@B;I"RubyVM::MJIT;Fo;;F; ;F;;;I"%RubyVM.USAGE_ANALYSIS_INSN_START;F;[;[[@.7iß;T;:USAGE_ANALYSIS_INSN_START;0;[;{;IC;";T;[;[;@|;0; @ÜB;'@@B;(I"8static VALUE usage_analysis_insn_start(VALUE self);;T;)I"8static VALUE usage_analysis_insn_start(VALUE self);;T;*To;;F; ;F;;;I"(RubyVM.USAGE_ANALYSIS_OPERAND_START;F;[;[[@.7ià;T;:!USAGE_ANALYSIS_OPERAND_START;0;[;{;IC;";T;[;[;@|;0; @èB;'@@B;(I";static VALUE usage_analysis_operand_start(VALUE self);;T;)I";static VALUE usage_analysis_operand_start(VALUE self);;T;*To;;F; ;F;;;I")RubyVM.USAGE_ANALYSIS_REGISTER_START;F;[;[[@.7iá;T;:"USAGE_ANALYSIS_REGISTER_START;0;[;{;IC;";T;[;[;@|;0; @ôB;'@@B;(I"static VALUE usage_analysis_register_running(VALUE self);;T;)I">static VALUE usage_analysis_register_running(VALUE self);;T;*To;;F; ;F;;;I"%RubyVM.USAGE_ANALYSIS_INSN_CLEAR;F;[;[[@.7iè;T;:USAGE_ANALYSIS_INSN_CLEAR;0;[;{;IC;";T;[;[;@|;0; @HC;'@@B;(I"8static VALUE usage_analysis_insn_clear(VALUE self);;T;)I"8static VALUE usage_analysis_insn_clear(VALUE self);;T;*To;;F; ;F;;;I"(RubyVM.USAGE_ANALYSIS_OPERAND_CLEAR;F;[;[[@.7ié;T;:!USAGE_ANALYSIS_OPERAND_CLEAR;0;[;{;IC;";T;[;[;@|;0; @TC;'@@B;(I";static VALUE usage_analysis_operand_clear(VALUE self);;T;)I";static VALUE usage_analysis_operand_clear(VALUE self);;T;*To;;F; ;F;;;I")RubyVM.USAGE_ANALYSIS_REGISTER_CLEAR;F;[;[[@.7iê;T;:"USAGE_ANALYSIS_REGISTER_CLEAR;0;[;{;IC;";T;[;[;@|;0; @`C;'@@B;(I" #define MAX_NATIVE_TRACE 1024 static void *trace[MAX_NATIVE_TRACE]; int n = (int)backtrace(trace, MAX_NATIVE_TRACE); char **syms = backtrace_symbols(trace, n); int i; if (syms == 0) { rb_memerror(); } for (i=0; ibody; VALUE klass = rb_class_name(rb_obj_class(self)); if (!body->location.label) { return rb_sprintf("#<%"PRIsVALUE": uninitialized>", klass); } else { return rb_sprintf("<%"PRIsVALUE":%"PRIsVALUE"@%"PRIsVALUE":%d>", klass, body->location.label, rb_iseq_path(iseq), FIX2INT(rb_iseq_first_lineno(iseq))); } };T;)I"static VALUE;T;*To;;F; ;;;;I"'RubyVM::InstructionSequence#disasm;T;[;[[@Di8 ;T;:disasm;0;[;{;IC;"ˆReturns the instruction sequence as a +String+ in human readable form. puts RubyVM::InstructionSequence.compile('1 + 2').disasm Produces: == disasm: @>========== 0000 trace 1 ( 1) 0002 putobject 1 0004 putobject 2 0006 opt_plus 0008 leave ;T;[o;= ;3I" overload;F;40;;È;50;)I"disasm;T;IC;";T; @D;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @D;[;I"@return [String];T;0;6i;[; @Do;= ;3I" overload;F;40;:disassemble;50;)I"disassemble;T;IC;";T; @D;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @D;[;I"@return [String];T;0;6i;[; @D;[;I"×Returns the instruction sequence as a +String+ in human readable form. puts RubyVM::InstructionSequence.compile('1 + 2').disasm Produces: == disasm: @>========== 0000 trace 1 ( 1) 0002 putobject 1 0004 putobject 2 0006 opt_plus 0008 leave @overload disasm @return [String] @overload disassemble @return [String];T;0; @D;!F;"o;#;$T;%i& ;&i7 ;'@ïC;(I"\static VALUE iseqw_disasm(VALUE self) { return rb_iseq_disasm(iseqw_check(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I",RubyVM::InstructionSequence#disassemble;T;[;[[@Di8 ;T;;É;0;[;{;IC;"ˆReturns the instruction sequence as a +String+ in human readable form. puts RubyVM::InstructionSequence.compile('1 + 2').disasm Produces: == disasm: @>========== 0000 trace 1 ( 1) 0002 putobject 1 0004 putobject 2 0006 opt_plus 0008 leave ;T;[o;= ;3I" overload;F;40;;È;50;)I"disasm;T;IC;";T; @6D;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @6D;[;I"@return [String];T;0;6i;[; @6Do;= ;3I" overload;F;40;;É;50;)I"disassemble;T;IC;";T; @6D;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @6D;[;I"@return [String];T;0;6i;[; @6D;[;@2D;0; @6D;!F;"o;#;$T;%i& ;&i7 ;'@ïC;(I"\static VALUE iseqw_disasm(VALUE self) { return rb_iseq_disasm(iseqw_check(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"%RubyVM::InstructionSequence#to_a;T;[;[[@Dix;T;;!;0;[;{;IC;"õReturns an Array with 14 elements representing the instruction sequence with the following data: [magic] A string identifying the data format. Always +YARVInstructionSequence/SimpleDataFormat+. [major_version] The major version of the instruction sequence. [minor_version] The minor version of the instruction sequence. [format_type] A number identifying the data format. Always 1. [misc] A hash containing: [+:arg_size+] the total number of arguments taken by the method or the block (0 if _iseq_ doesn't represent a method or block) [+:local_size+] the number of local variables + 1 [+:stack_max+] used in calculating the stack depth at which a SystemStackError is thrown. [#label] The name of the context (block, method, class, module, etc.) that this instruction sequence belongs to.

if it's at the top level, if it was evaluated from a string. [#path] The relative path to the Ruby file where the instruction sequence was loaded from. if the iseq was evaluated from a string. [#absolute_path] The absolute path to the Ruby file where the instruction sequence was loaded from. +nil+ if the iseq was evaluated from a string. [#first_lineno] The number of the first source line where the instruction sequence was loaded from. [type] The type of the instruction sequence. Valid values are +:top+, +:method+, +:block+, +:class+, +:rescue+, +:ensure+, +:eval+, +:main+, and +plain+. [locals] An array containing the names of all arguments and local variables as symbols. [params] An Hash object containing parameter information. More info about these values can be found in +vm_core.h+. [catch_table] A list of exceptions and control flow operators (rescue, next, redo, break, etc.). [bytecode] An array of arrays containing the instruction names and operands that make up the body of the instruction sequence. Note that this format is MRI specific and version dependent. @overload to_a @return [Array];T;0; @]D;!F;"o;#;$T;%i';&iv;'@ïC;(I"~static VALUE iseqw_to_a(VALUE self) { const rb_iseq_t *iseq = iseqw_check(self); return iseq_data_to_ary(iseq); };T;)I"static VALUE;T;*To;;F; ;;;;I"%RubyVM::InstructionSequence#eval;T;[;[[@Di;T;;Å;0;[;{;IC;"|Evaluates the instruction sequence and returns the result. RubyVM::InstructionSequence.compile("1 + 2").eval #=> 3 ;T;[o;= ;3I" overload;F;40;;Å;50;)I" eval;T;IC;";T; @xD;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @xD;[;I"@return [Object];T;0;6i;[; @xD;[;I"›Evaluates the instruction sequence and returns the result. RubyVM::InstructionSequence.compile("1 + 2").eval #=> 3 @overload eval @return [Object];T;0; @xD;!F;"o;#;$T;%i‡;&i;'@ïC;(I"Xstatic VALUE iseqw_eval(VALUE self) { return rb_iseq_eval(iseqw_check(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"*RubyVM::InstructionSequence#to_binary;T;[[@c0;[[@DiO ;T;:to_binary;0;[;{;IC;"Returns serialized iseq binary format data as a String object. A corresponding iseq object is created by RubyVM::InstructionSequence.load_from_binary() method. String extra_data will be saved with binary data. You can access this data with RubyVM::InstructionSequence.load_from_binary_extra_data(binary). Note that the translated binary data is not portable. You can not move this binary data to another machine. You can not use the binary data which is created by another version/another architecture of Ruby. ;T;[o;= ;3I" overload;F;40;;Ê;50;)I" to_binary(extra_data = nil);T;IC;";T; @“D;>0;!F;[;[;I";T;0;6i;[[I"extra_data;TI"nil;T; @“D;[;I"(Returns serialized iseq binary format data as a String object. A corresponding iseq object is created by RubyVM::InstructionSequence.load_from_binary() method. String extra_data will be saved with binary data. You can access this data with RubyVM::InstructionSequence.load_from_binary_extra_data(binary). Note that the translated binary data is not portable. You can not move this binary data to another machine. You can not use the binary data which is created by another version/another architecture of Ruby. @overload to_binary(extra_data = nil);T;0; @“D;!F;"o;#;$T;%i> ;&iL ;'@ïC;(I"¶static VALUE iseqw_to_binary(int argc, VALUE *argv, VALUE self) { VALUE opt = !rb_check_arity(argc, 0, 1) ? Qnil : argv[0]; return rb_iseq_ibf_dump(iseqw_check(self), opt); };T;)I"static VALUE;T;*To;;F; ;F;;;I"1RubyVM::InstructionSequence.load_from_binary;T;[[I"str;T0;[[@Dic ;T;:load_from_binary;0;[;{;IC;"5Load an iseq object from binary format String object created by RubyVM::InstructionSequence.to_binary. This loader does not have a verifier, so that loading broken/modified binary causes critical problem. You should not load binary data provided by others. You should use binary data translated by yourself. ;T;[o;= ;3I" overload;F;40;:1RubyVM::InstructionSequence.load_from_binary;50;)I"9RubyVM::InstructionSequence.load_from_binary(binary);T;IC;";T; @D;>0;!F;[;[;I";T;0;6i;[[I"binary;T0; @D;[;I"vLoad an iseq object from binary format String object created by RubyVM::InstructionSequence.to_binary. This loader does not have a verifier, so that loading broken/modified binary causes critical problem. You should not load binary data provided by others. You should use binary data translated by yourself. @overload RubyVM::InstructionSequence.load_from_binary(binary);T;0; @D;!F;"o;#;$T;%iV ;&i` ;'@ïC;(I"rstatic VALUE iseqw_s_load_from_binary(VALUE self, VALUE str) { return iseqw_new(rb_iseq_ibf_load(str)); };T;)I"static VALUE;T;*To;;F; ;F;;;I"0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @ÇD;[;I"@return [String];T;0;6i;[[I"binary;T0; @ÇD;[;I"–Load extra data embed into binary format String object. @overload RubyVM::InstructionSequence.load_from_binary_extra_data(binary) @return [String];T;0; @ÇD;!F;"o;#;$T;%ii ;&im ;'@ïC;(I"}static VALUE iseqw_s_load_from_binary_extra_data(VALUE self, VALUE str) { return rb_iseq_ibf_load_extra_data(str); };T;)I"static VALUE;T;*To;;F; ;;;;I"%RubyVM::InstructionSequence#path;T;[;[[@DiÂ;T;;Õ;0;[;{;IC;"ÐReturns the path of this instruction sequence. if the iseq was evaluated from a string. For example, using irb: iseq = RubyVM::InstructionSequence.compile('num = 1 + 2') #=> @> iseq.path #=> "" Using ::compile_file: # /tmp/method.rb def hello puts "hello, world" end # in irb > iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb') > iseq.path #=> /tmp/method.rb ;T;[;[;I"ÑReturns the path of this instruction sequence. if the iseq was evaluated from a string. For example, using irb: iseq = RubyVM::InstructionSequence.compile('num = 1 + 2') #=> @> iseq.path #=> "" Using ::compile_file: # /tmp/method.rb def hello puts "hello, world" end # in irb > iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb') > iseq.path #=> /tmp/method.rb ;T;0; @æD;!F;"o;#;$T;%i«;&iÀ;'@ïC;(I"Xstatic VALUE iseqw_path(VALUE self) { return rb_iseq_path(iseqw_check(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I".RubyVM::InstructionSequence#absolute_path;T;[;[[@DiØ;T;;Ö;0;[;{;IC;"6Returns the absolute path of this instruction sequence. +nil+ if the iseq was evaluated from a string. For example, using ::compile_file: # /tmp/method.rb def hello puts "hello, world" end # in irb > iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb') > iseq.absolute_path #=> /tmp/method.rb ;T;[;[;I"7Returns the absolute path of this instruction sequence. +nil+ if the iseq was evaluated from a string. For example, using ::compile_file: # /tmp/method.rb def hello puts "hello, world" end # in irb > iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb') > iseq.absolute_path #=> /tmp/method.rb ;T;0; @ôD;!F;"o;#;$T;%iÈ;&iÖ;'@ïC;(I"estatic VALUE iseqw_absolute_path(VALUE self) { return rb_iseq_realpath(iseqw_check(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"&RubyVM::InstructionSequence#label;T;[;[[@Diõ;T;;Ó;0;[;{;IC;"óReturns the label of this instruction sequence.

if it's at the top level, if it was evaluated from a string. For example, using irb: iseq = RubyVM::InstructionSequence.compile('num = 1 + 2') #=> @> iseq.label #=> "" Using ::compile_file: # /tmp/method.rb def hello puts "hello, world" end # in irb > iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb') > iseq.label #=>

;T;[;[;I"ôReturns the label of this instruction sequence.

;T;0; @E;!F;"o;#;$T;%iÞ;&iô;'@ïC;(I"Zstatic VALUE iseqw_label(VALUE self) { return rb_iseq_label(iseqw_check(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"+RubyVM::InstructionSequence#base_label;T;[;[[@Di;T;;Ô;0;[;{;IC;"˜Returns the base label of this instruction sequence. For example, using irb: iseq = RubyVM::InstructionSequence.compile('num = 1 + 2') #=> @> iseq.base_label #=> "" Using ::compile_file: # /tmp/method.rb def hello puts "hello, world" end # in irb > iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb') > iseq.base_label #=>

;T;[;[;I"™Returns the base label of this instruction sequence. For example, using irb: iseq = RubyVM::InstructionSequence.compile('num = 1 + 2') #=> @> iseq.base_label #=> "" Using ::compile_file: # /tmp/method.rb def hello puts "hello, world" end # in irb > iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb') > iseq.base_label #=>

;T;0; @E;!F;"o;#;$T;%iû;&i;'@ïC;(I"dstatic VALUE iseqw_base_label(VALUE self) { return rb_iseq_base_label(iseqw_check(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"-RubyVM::InstructionSequence#first_lineno;T;[;[[@Di;T;:first_lineno;0;[;{;IC;"ÿReturns the number of the first source line where the instruction sequence was loaded from. For example, using irb: iseq = RubyVM::InstructionSequence.compile('num = 1 + 2') #=> @> iseq.first_lineno #=> 1 ;T;[;[;I"Returns the number of the first source line where the instruction sequence was loaded from. For example, using irb: iseq = RubyVM::InstructionSequence.compile('num = 1 + 2') #=> @> iseq.first_lineno #=> 1 ;T;0; @E;!F;"o;#;$T;%i;&i;'@ïC;(I"hstatic VALUE iseqw_first_lineno(VALUE self) { return rb_iseq_first_lineno(iseqw_check(self)); };T;)I"static VALUE;T;*To;;F; ;;;;I"-RubyVM::InstructionSequence#trace_points;T;[;[[@Di› ;T;:trace_points;0;[;{;IC;"cReturn trace points in the instruction sequence. Return an array of [line, event_symbol] pair. ;T;[o;= ;3I" overload;F;40;;Ð;50;)I"trace_points;T;IC;";T; @,E;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @,E;[;I"@return [Array];T;0;6i;[; @,E;[;I"‰Return trace points in the instruction sequence. Return an array of [line, event_symbol] pair. @overload trace_points @return [Array];T;0; @,E;!F;"o;#;$T;%i” ;&i™ ;'@ïC;(I"¶static VALUE iseqw_trace_points(VALUE self) { const rb_iseq_t *iseq = iseqw_check(self); const struct rb_iseq_constant_body *const body = iseq->body; unsigned int i; VALUE ary = rb_ary_new(); for (i=0; iinsns_info.size; i++) { const struct iseq_insn_info_entry *entry = &body->insns_info.body[i]; if (entry->events) { push_event_info(iseq, entry->events, entry->line_no, ary); } } return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"+RubyVM::InstructionSequence#each_child;T;[;[[@Di~ ;T;:each_child;0;[;{;IC;"ŽIterate all direct child instruction sequences. Iteration order is implementation/version defined so that people should not rely on the order. ;T;[o;= ;3I" overload;F;40;;Ñ;50;)I"each_child;T;IC;";T; @GE;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I"child_iseq;T; @GE;[;I"@yield [child_iseq];T;0;6i;[; @GE;[;I"»Iterate all direct child instruction sequences. Iteration order is implementation/version defined so that people should not rely on the order. @overload each_child @yield [child_iseq];T;0; @GE;!F;"o;#;$T;%iv ;&i| ;'@ïC;(I"©static VALUE iseqw_each_child(VALUE self) { const rb_iseq_t *iseq = iseqw_check(self); iseq_iterate_children(iseq, yield_each_children, NULL); return self; };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"-RubyVM::InstructionSequence#marshal_dump;T;[;[;F;;L;;K;[;{;IC;";T;[;[;@|;0; @bE;'@ïC;*To;;F; ;;;Ï;I"-RubyVM::InstructionSequence#marshal_load;T;[;[;F;;M;;K;[;{;IC;";T;[;[;@|;0; @kE;'@ïC;*To;;F; ;F;;;I"%RubyVM::InstructionSequence.load;T;[[@c0;[[@Diÿ;T;;Œ;0;[;{;IC;":nodoc: ;T;[;[;I" :nodoc: ;T;0; @tE;!F;"o;#;$T;%iü;&iý;'@ïC;(I"±static VALUE iseq_s_load(int argc, VALUE *argv, VALUE self) { VALUE data, opt=Qnil; rb_scan_args(argc, argv, "11", &data, &opt); return iseq_load(data, NULL, opt); };T;)I"static VALUE;T;*To;;F; ;F;;;I"(RubyVM::InstructionSequence.compile;T;[[@c0;[[@Diç;T;;$;0;[;{;IC;".Takes +source+, a String of Ruby code and compiles it to an InstructionSequence. Optionally takes +file+, +path+, and +line+ which describe the file path, real path and first line number of the ruby code in +source+ which are metadata attached to the returned +iseq+. +file+ is used for `__FILE__` and exception backtrace. +path+ is used for +require_relative+ base. It is recommended these should be the same full path. +options+, which can be +true+, +false+ or a +Hash+, is used to modify the default behavior of the Ruby iseq compiler. For details regarding valid compile options see ::compile_option=. RubyVM::InstructionSequence.compile("a = 1 + 2") #=> @> path = "test.rb" RubyVM::InstructionSequence.compile(File.read(path), path, File.expand_path(path)) #=> @test.rb:1> path = File.expand_path("test.rb") RubyVM::InstructionSequence.compile(File.read(path), path, path) #=> @/absolute/path/to/test.rb:1> ;T;[o;= ;3I" overload;F;40;;$;50;)I"7compile(source[, file[, path[, line[, options]]]]);T;IC;";T; @ƒE;>0;!F;[;[;I";T;0;6i;[[I".source[, file[, path[, line[, options]]]];T0; @ƒEo;= ;3I" overload;F;40;;î;50;)I"3new(source[, file[, path[, line[, options]]]]);T;IC;";T; @ƒE;>0;!F;[;[;I";T;0;6i;[[I".source[, file[, path[, line[, options]]]];T0; @ƒE;[;I"§Takes +source+, a String of Ruby code and compiles it to an InstructionSequence. Optionally takes +file+, +path+, and +line+ which describe the file path, real path and first line number of the ruby code in +source+ which are metadata attached to the returned +iseq+. +file+ is used for `__FILE__` and exception backtrace. +path+ is used for +require_relative+ base. It is recommended these should be the same full path. +options+, which can be +true+, +false+ or a +Hash+, is used to modify the default behavior of the Ruby iseq compiler. For details regarding valid compile options see ::compile_option=. RubyVM::InstructionSequence.compile("a = 1 + 2") #=> @> path = "test.rb" RubyVM::InstructionSequence.compile(File.read(path), path, File.expand_path(path)) #=> @test.rb:1> path = File.expand_path("test.rb") RubyVM::InstructionSequence.compile(File.read(path), path, path) #=> @/absolute/path/to/test.rb:1> @overload compile(source[, file[, path[, line[, options]]]]) @overload new(source[, file[, path[, line[, options]]]]);T;0; @ƒE;!F;"o;#;$T;%iÆ;&iä;'@ïC;(I"´static VALUE iseqw_s_compile(int argc, VALUE *argv, VALUE self) { VALUE src, file = Qnil, path = Qnil, line = INT2FIX(1), opt = Qnil; int i; i = rb_scan_args(argc, argv, "1*:", &src, NULL, &opt); if (i > 4+NIL_P(opt)) rb_error_arity(argc, 1, 5); switch (i) { case 5: opt = argv[--i]; case 4: line = argv[--i]; case 3: path = argv[--i]; case 2: file = argv[--i]; } if (NIL_P(file)) file = rb_fstring_lit(""); if (NIL_P(path)) path = file; if (NIL_P(line)) line = INT2FIX(1); Check_Type(path, T_STRING); Check_Type(file, T_STRING); return iseqw_new(rb_iseq_compile_with_option(src, file, path, line, opt)); };T;)I"static VALUE;T;*To;;F; ;F;;;I"$RubyVM::InstructionSequence.new;T;[[@c0;[[@Diç;T;;î;0;[;{;IC;".Takes +source+, a String of Ruby code and compiles it to an InstructionSequence. Optionally takes +file+, +path+, and +line+ which describe the file path, real path and first line number of the ruby code in +source+ which are metadata attached to the returned +iseq+. +file+ is used for `__FILE__` and exception backtrace. +path+ is used for +require_relative+ base. It is recommended these should be the same full path. +options+, which can be +true+, +false+ or a +Hash+, is used to modify the default behavior of the Ruby iseq compiler. For details regarding valid compile options see ::compile_option=. RubyVM::InstructionSequence.compile("a = 1 + 2") #=> @> path = "test.rb" RubyVM::InstructionSequence.compile(File.read(path), path, File.expand_path(path)) #=> @test.rb:1> path = File.expand_path("test.rb") RubyVM::InstructionSequence.compile(File.read(path), path, path) #=> @/absolute/path/to/test.rb:1> ;T;[o;= ;3I" overload;F;40;;$;50;)I"7compile(source[, file[, path[, line[, options]]]]);T;IC;";T; @¦E;>0;!F;[;[;I";T;0;6i;[[I".source[, file[, path[, line[, options]]]];T0; @¦Eo;= ;3I" overload;F;40;;î;50;)I"3new(source[, file[, path[, line[, options]]]]);T;IC;";T; @¦E;>0;!F;[;[;I";T;0;6i;[[I".source[, file[, path[, line[, options]]]];T0; @¦E;[;@¢E;0; @¦E;!F;"o;#;$T;%iÆ;&iä;'@ïC;(I"´static VALUE iseqw_s_compile(int argc, VALUE *argv, VALUE self) { VALUE src, file = Qnil, path = Qnil, line = INT2FIX(1), opt = Qnil; int i; i = rb_scan_args(argc, argv, "1*:", &src, NULL, &opt); if (i > 4+NIL_P(opt)) rb_error_arity(argc, 1, 5); switch (i) { case 5: opt = argv[--i]; case 4: line = argv[--i]; case 3: path = argv[--i]; case 2: file = argv[--i]; } if (NIL_P(file)) file = rb_fstring_lit(""); if (NIL_P(path)) path = file; if (NIL_P(line)) line = INT2FIX(1); Check_Type(path, T_STRING); Check_Type(file, T_STRING); return iseqw_new(rb_iseq_compile_with_option(src, file, path, line, opt)); };T;)I"static VALUE;T;*To;;F; ;F;;;I"-RubyVM::InstructionSequence.compile_file;T;[[@c0;[[@Di;T;:compile_file;0;[;{;IC;"9Takes +file+, a String with the location of a Ruby source file, reads, parses and compiles the file, and returns +iseq+, the compiled InstructionSequence with source location metadata set. Optionally takes +options+, which can be +true+, +false+ or a +Hash+, to modify the default behavior of the Ruby iseq compiler. For details regarding valid compile options see ::compile_option=. # /tmp/hello.rb puts "Hello, world!" # elsewhere RubyVM::InstructionSequence.compile_file("/tmp/hello.rb") #=> @/tmp/hello.rb> ;T;[o;= ;3I" overload;F;40;;Ò;50;)I""compile_file(file[, options]);T;IC;";T; @ÈE;>0;!F;[;[;I";T;0;6i;[[I"file[, options];T0; @ÈE;[;I"cTakes +file+, a String with the location of a Ruby source file, reads, parses and compiles the file, and returns +iseq+, the compiled InstructionSequence with source location metadata set. Optionally takes +options+, which can be +true+, +false+ or a +Hash+, to modify the default behavior of the Ruby iseq compiler. For details regarding valid compile options see ::compile_option=. # /tmp/hello.rb puts "Hello, world!" # elsewhere RubyVM::InstructionSequence.compile_file("/tmp/hello.rb") #=> @/tmp/hello.rb> @overload compile_file(file[, options]);T;0; @ÈE;!F;"o;#;$T;%i;&i;'@ïC;(I"*static VALUE iseqw_s_compile_file(int argc, VALUE *argv, VALUE self) { VALUE file, line = INT2FIX(1), opt = Qnil; VALUE parser, f, exc = Qnil, ret; rb_ast_t *ast; rb_compile_option_t option; int i; i = rb_scan_args(argc, argv, "1*:", &file, NULL, &opt); if (i > 1+NIL_P(opt)) rb_error_arity(argc, 1, 2); switch (i) { case 2: opt = argv[--i]; } FilePathValue(file); file = rb_fstring(file); /* rb_io_t->pathv gets frozen anyways */ f = rb_file_open_str(file, "r"); parser = rb_parser_new(); rb_parser_set_context(parser, NULL, FALSE); ast = (rb_ast_t *)rb_parser_load_file(parser, file); if (!ast->body.root) exc = GET_EC()->errinfo; rb_io_close(f); if (!ast->body.root) { rb_ast_dispose(ast); rb_exc_raise(exc); } make_compile_option(&option, opt); ret = iseqw_new(rb_iseq_new_with_opt(&ast->body, rb_fstring_lit("

"), file, rb_realpath_internal(Qnil, file, 1), line, NULL, 0, ISEQ_TYPE_TOP, &option)); rb_ast_dispose(ast); return ret; };T;)I"static VALUE;T;*To;;F; ;F;;;I"/RubyVM::InstructionSequence.compile_option;T;[;[[@Dil;T;:compile_option;0;[;{;IC;"}Returns a hash of default options used by the Ruby iseq compiler. For details, see InstructionSequence.compile_option=. ;T;[o;= ;3I" overload;F;40;;Ó;50;)I"compile_option;T;IC;";T; @áE;>0;!F;[;[;I";T;0;6i;[; @áE;[;I"“Returns a hash of default options used by the Ruby iseq compiler. For details, see InstructionSequence.compile_option=. @overload compile_option;T;0; @áE;!F;"o;#;$T;%id;&ii;'@ïC;(I"{static VALUE iseqw_s_compile_option_get(VALUE self) { return make_compile_option_value(&COMPILE_OPTION_DEFAULT); };T;)I"static VALUE;T;*To;;F; ;F;;;I"0RubyVM::InstructionSequence.compile_option=;T;[[I"opt;T0;[[@Di[;T;:compile_option=;0;[;{;IC;"oSets the default values for various optimizations in the Ruby iseq compiler. Possible values for +options+ include +true+, which enables all options, +false+ which disables all options, and +nil+ which leaves all options unchanged. You can also pass a +Hash+ of +options+ that you want to change, any options not present in the hash will be left unchanged. Possible option names (which are keys in +options+) which can be set to +true+ or +false+ include: * +:inline_const_cache+ * +:instructions_unification+ * +:operands_unification+ * +:peephole_optimization+ * +:specialized_instruction+ * +:stack_caching+ * +:tailcall_optimization+ Additionally, +:debug_level+ can be set to an integer. These default options can be overwritten for a single run of the iseq compiler by passing any of the above values as the +options+ parameter to ::new, ::compile and ::compile_file. ;T;[o;= ;3I" overload;F;40;;Ô;50;)I"compile_option=(options);T;IC;";T; @÷E;>0;!F;[;[;I";T;0;6i;[[I"options;T0; @÷E;[;I"”Sets the default values for various optimizations in the Ruby iseq compiler. Possible values for +options+ include +true+, which enables all options, +false+ which disables all options, and +nil+ which leaves all options unchanged. You can also pass a +Hash+ of +options+ that you want to change, any options not present in the hash will be left unchanged. Possible option names (which are keys in +options+) which can be set to +true+ or +false+ include: * +:inline_const_cache+ * +:instructions_unification+ * +:operands_unification+ * +:peephole_optimization+ * +:specialized_instruction+ * +:stack_caching+ * +:tailcall_optimization+ Additionally, +:debug_level+ can be set to an integer. These default options can be overwritten for a single run of the iseq compiler by passing any of the above values as the +options+ parameter to ::new, ::compile and ::compile_file. @overload compile_option=(options);T;0; @÷E;!F;"o;#;$T;%i<;&iX;'@ïC;(I"¾static VALUE iseqw_s_compile_option_set(VALUE self, VALUE opt) { rb_compile_option_t option; make_compile_option(&option, opt); COMPILE_OPTION_DEFAULT = option; return opt; };T;)I"static VALUE;T;*To;;F; ;F;;;I"'RubyVM::InstructionSequence.disasm;T;[[I" body;T0;[[@Di ;T;;È;0;[;{;IC;"»Takes +body+, a Method or Proc object, and returns a String with the human readable instructions for +body+. For a Method object: # /tmp/method.rb def hello puts "hello, world" end puts RubyVM::InstructionSequence.disasm(method(:hello)) Produces: == disasm: ============ 0000 trace 8 ( 1) 0002 trace 1 ( 2) 0004 putself 0005 putstring "hello, world" 0007 send :puts, 1, nil, 8, 0013 trace 16 ( 3) 0015 leave ( 2) For a Proc: # /tmp/proc.rb p = proc { num = 1 + 2 } puts RubyVM::InstructionSequence.disasm(p) Produces: == disasm: @/tmp/proc.rb>=== == catch table | catch type: redo st: 0000 ed: 0012 sp: 0000 cont: 0000 | catch type: next st: 0000 ed: 0012 sp: 0000 cont: 0012 |------------------------------------------------------------------------ local table (size: 2, argc: 0 [opts: 0, rest: -1, post: 0, block: -1] s1) [ 2] num 0000 trace 1 ( 1) 0002 putobject 1 0004 putobject 2 0006 opt_plus 0008 dup 0009 setlocal num, 0 0012 leave ;T;[o;= ;3I" overload;F;40;;È;50;)I"disasm(body);T;IC;";T; @F;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @F;[;I"@return [String];T;0;6i;[[I" body;T0; @Fo;= ;3I" overload;F;40;;É;50;)I"disassemble(body);T;IC;";T; @F;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @F;[;I"@return [String];T;0;6i;[[I" body;T0; @F;[;I"Takes +body+, a Method or Proc object, and returns a String with the human readable instructions for +body+. For a Method object: # /tmp/method.rb def hello puts "hello, world" end puts RubyVM::InstructionSequence.disasm(method(:hello)) Produces: == disasm: ============ 0000 trace 8 ( 1) 0002 trace 1 ( 2) 0004 putself 0005 putstring "hello, world" 0007 send :puts, 1, nil, 8, 0013 trace 16 ( 3) 0015 leave ( 2) For a Proc: # /tmp/proc.rb p = proc { num = 1 + 2 } puts RubyVM::InstructionSequence.disasm(p) Produces: == disasm: @/tmp/proc.rb>=== == catch table | catch type: redo st: 0000 ed: 0012 sp: 0000 cont: 0000 | catch type: next st: 0000 ed: 0012 sp: 0000 cont: 0012 |------------------------------------------------------------------------ local table (size: 2, argc: 0 [opts: 0, rest: -1, post: 0, block: -1] s1) [ 2] num 0000 trace 1 ( 1) 0002 putobject 1 0004 putobject 2 0006 opt_plus 0008 dup 0009 setlocal num, 0 0012 leave @overload disasm(body) @return [String] @overload disassemble(body) @return [String];T;0; @F;!F;"o;#;$T;%iå ;&i ;'@ïC;(I"¨static VALUE iseqw_s_disasm(VALUE klass, VALUE body) { VALUE iseqw = iseqw_s_of(klass, body); return NIL_P(iseqw) ? Qnil : rb_iseq_disasm(iseqw_check(iseqw)); };T;)I"static VALUE;T;*To;;F; ;F;;;I",RubyVM::InstructionSequence.disassemble;T;[[I" body;T0;[[@Di ;T;;É;0;[;{;IC;"»Takes +body+, a Method or Proc object, and returns a String with the human readable instructions for +body+. For a Method object: # /tmp/method.rb def hello puts "hello, world" end puts RubyVM::InstructionSequence.disasm(method(:hello)) Produces: == disasm: ============ 0000 trace 8 ( 1) 0002 trace 1 ( 2) 0004 putself 0005 putstring "hello, world" 0007 send :puts, 1, nil, 8, 0013 trace 16 ( 3) 0015 leave ( 2) For a Proc: # /tmp/proc.rb p = proc { num = 1 + 2 } puts RubyVM::InstructionSequence.disasm(p) Produces: == disasm: @/tmp/proc.rb>=== == catch table | catch type: redo st: 0000 ed: 0012 sp: 0000 cont: 0000 | catch type: next st: 0000 ed: 0012 sp: 0000 cont: 0012 |------------------------------------------------------------------------ local table (size: 2, argc: 0 [opts: 0, rest: -1, post: 0, block: -1] s1) [ 2] num 0000 trace 1 ( 1) 0002 putobject 1 0004 putobject 2 0006 opt_plus 0008 dup 0009 setlocal num, 0 0012 leave ;T;[o;= ;3I" overload;F;40;;È;50;)I"disasm(body);T;IC;";T; @?F;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @?F;[;I"@return [String];T;0;6i;[[I" body;T0; @?Fo;= ;3I" overload;F;40;;É;50;)I"disassemble(body);T;IC;";T; @?F;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @?F;[;I"@return [String];T;0;6i;[[I" body;T0; @?F;[;@;F;0; @?F;!F;"o;#;$T;%iå ;&i ;'@ïC;(I"¨static VALUE iseqw_s_disasm(VALUE klass, VALUE body) { VALUE iseqw = iseqw_s_of(klass, body); return NIL_P(iseqw) ? Qnil : rb_iseq_disasm(iseqw_check(iseqw)); };T;)I"static VALUE;T;*To;;F; ;F;;;I"#RubyVM::InstructionSequence.of;T;[[I" body;T0;[[@DiÏ ;T;:of;0;[;{;IC;"Returns the instruction sequence containing the given proc or method. For example, using irb: # a proc > p = proc { num = 1 + 2 } > RubyVM::InstructionSequence.of(p) > #=> # for a method > def foo(bar); puts bar; end > RubyVM::InstructionSequence.of(method(:foo)) > #=> Using ::compile_file: # /tmp/iseq_of.rb def hello puts "hello, world" end $a_global_proc = proc { str = 'a' + 'b' } # in irb > require '/tmp/iseq_of.rb' # first the method hello > RubyVM::InstructionSequence.of(method(:hello)) > #=> # # then the global proc > RubyVM::InstructionSequence.of($a_global_proc) > #=> # ;T;[;[;I"Returns the instruction sequence containing the given proc or method. For example, using irb: # a proc > p = proc { num = 1 + 2 } > RubyVM::InstructionSequence.of(p) > #=> # for a method > def foo(bar); puts bar; end > RubyVM::InstructionSequence.of(method(:foo)) > #=> Using ::compile_file: # /tmp/iseq_of.rb def hello puts "hello, world" end $a_global_proc = proc { str = 'a' + 'b' } # in irb > require '/tmp/iseq_of.rb' # first the method hello > RubyVM::InstructionSequence.of(method(:hello)) > #=> # # then the global proc > RubyVM::InstructionSequence.of($a_global_proc) > #=> # ;T;0; @lF;!F;"o;#;$T;%i¬ ;&iÍ ;'@ïC;(I"Ìstatic VALUE iseqw_s_of(VALUE klass, VALUE body) { const rb_iseq_t *iseq = NULL; if (rb_obj_is_proc(body)) { iseq = vm_proc_iseq(body); if (!rb_obj_is_iseq((VALUE)iseq)) { iseq = NULL; } } else if (rb_obj_is_method(body)) { iseq = rb_method_iseq(body); } else if (rb_typeddata_is_instance_of(body, &iseqw_data_type)) { return body; } return iseq ? iseqw_new(iseq) : Qnil; };T;)I"static VALUE;T;*T;A@ïC;BIC;[;A@ïC;CIC;[;A@ïC;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@Diü [@Di;T;:InstructionSequence;;K;;;[;{;IC;"The InstructionSequence class represents a compiled sequence of instructions for the Virtual Machine used in MRI. Not all implementations of Ruby may implement this class, and for the implementations that implement it, the methods defined and behavior of the methods can change in any version. With it, you can get a handle to the instructions that make up a method or a proc, compile strings of Ruby code down to VM instructions, and disassemble instruction sequences to strings for easy inspection. It is mostly useful if you want to learn how YARV works, but it also lets you control various settings for the Ruby iseq compiler. You can find the source for the VM instructions in +insns.def+ in the Ruby source. The instruction sequence results will almost certainly change as Ruby changes, so example output in this documentation may be different from what you see. Of course, this class is MRI specific.;T;[;[;I"’ The InstructionSequence class represents a compiled sequence of instructions for the Virtual Machine used in MRI. Not all implementations of Ruby may implement this class, and for the implementations that implement it, the methods defined and behavior of the methods can change in any version. With it, you can get a handle to the instructions that make up a method or a proc, compile strings of Ruby code down to VM instructions, and disassemble instruction sequences to strings for easy inspection. It is mostly useful if you want to learn how YARV works, but it also lets you control various settings for the Ruby iseq compiler. You can find the source for the VM instructions in +insns.def+ in the Ruby source. The instruction sequence results will almost certainly change as Ruby changes, so example output in this documentation may be different from what you see. Of course, this class is MRI specific. ;T;0; @ïC;!F;"o;#;$T;%iü ;&i;6i;'o;L;M0;N0;O0;:RubyVM;'@;Q@@B;R0;I" RubyVM::InstructionSequence;T;S@];A@@B;BIC;[;A@@B;CIC;[;A@@B;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@.7i [@.7i ;T;;×;;K;;;[;{;IC;"eThe RubyVM module only exists on MRI. +RubyVM+ is not defined in other Ruby implementations such as JRuby and TruffleRuby. The RubyVM module provides some access to MRI internals. This module is for very limited purposes, such as debugging, prototyping, and research. Normal users must not use it. This module is not portable between Ruby implementations.;T;[;[;I"g The RubyVM module only exists on MRI. +RubyVM+ is not defined in other Ruby implementations such as JRuby and TruffleRuby. The RubyVM module provides some access to MRI internals. This module is for very limited purposes, such as debugging, prototyping, and research. Normal users must not use it. This module is not portable between Ruby implementations. ;T;0; @@B;!F;"o;#;$T;%i ;&i ;6i;'@;I"RubyVM;F;S@]o;{;[[@.7iY;F;:TOPLEVEL_BINDING;;};;;[;{;IC;"'The Binding of the top level scope ;T;[;[;I"(The Binding of the top level scope ;T;0; @¡F;!F;"o;#;$T;%iV;&iW;'@;I"TOPLEVEL_BINDING;F;~I"rb_binding_new();To; ;IC;[]o;;F; ;F;;;I"!BigDecimal.interpret_loosely;F;[[I"str;T0;[[@yiL;T;:interpret_loosely;0;[;{;IC;";T;[;[;@|;0; @¯F;'@F;(I"@static VALUE BigDecimal_s_interpret_loosely(VALUE klass, VALUE str) { ENTER(1); char const *c_str; Real *pv; c_str = StringValueCStr(str); GUARD_OBJ(pv, VpAlloc(0, c_str, 0, 1)); pv->obj = TypedData_Wrap_Struct(klass, &BigDecimal_data_type, pv); RB_OBJ_FREEZE(pv->obj); return pv->obj; };T;)I"static VALUE;T;*To;;F; ;F;;;I"BigDecimal.mode;F;[[@c0;[[@yi®;T;;ñ;0;[;{;IC;"EBigDecimal.mode(mode, value) Controls handling of arithmetic exceptions and rounding. If no value is supplied, the current value is returned. Six values of the mode parameter control the handling of arithmetic exceptions: BigDecimal::EXCEPTION_NaN BigDecimal::EXCEPTION_INFINITY BigDecimal::EXCEPTION_UNDERFLOW BigDecimal::EXCEPTION_OVERFLOW BigDecimal::EXCEPTION_ZERODIVIDE BigDecimal::EXCEPTION_ALL For each mode parameter above, if the value set is false, computation continues after an arithmetic exception of the appropriate type. When computation continues, results are as follows: EXCEPTION_NaN:: NaN EXCEPTION_INFINITY:: +Infinity or -Infinity EXCEPTION_UNDERFLOW:: 0 EXCEPTION_OVERFLOW:: +Infinity or -Infinity EXCEPTION_ZERODIVIDE:: +Infinity or -Infinity One value of the mode parameter controls the rounding of numeric values: BigDecimal::ROUND_MODE. The values it can take are: ROUND_UP, :up:: round away from zero ROUND_DOWN, :down, :truncate:: round towards zero (truncate) ROUND_HALF_UP, :half_up, :default:: round towards the nearest neighbor, unless both neighbors are equidistant, in which case round away from zero. (default) ROUND_HALF_DOWN, :half_down:: round towards the nearest neighbor, unless both neighbors are equidistant, in which case round towards zero. ROUND_HALF_EVEN, :half_even, :banker:: round towards the nearest neighbor, unless both neighbors are equidistant, in which case round towards the even neighbor (Banker's rounding) ROUND_CEILING, :ceiling, :ceil:: round towards positive infinity (ceil) ROUND_FLOOR, :floor:: round towards negative infinity (floor) ;T;[;[;I"HBigDecimal.mode(mode, value) Controls handling of arithmetic exceptions and rounding. If no value is supplied, the current value is returned. Six values of the mode parameter control the handling of arithmetic exceptions: BigDecimal::EXCEPTION_NaN BigDecimal::EXCEPTION_INFINITY BigDecimal::EXCEPTION_UNDERFLOW BigDecimal::EXCEPTION_OVERFLOW BigDecimal::EXCEPTION_ZERODIVIDE BigDecimal::EXCEPTION_ALL For each mode parameter above, if the value set is false, computation continues after an arithmetic exception of the appropriate type. When computation continues, results are as follows: EXCEPTION_NaN:: NaN EXCEPTION_INFINITY:: +Infinity or -Infinity EXCEPTION_UNDERFLOW:: 0 EXCEPTION_OVERFLOW:: +Infinity or -Infinity EXCEPTION_ZERODIVIDE:: +Infinity or -Infinity One value of the mode parameter controls the rounding of numeric values: BigDecimal::ROUND_MODE. The values it can take are: ROUND_UP, :up:: round away from zero ROUND_DOWN, :down, :truncate:: round towards zero (truncate) ROUND_HALF_UP, :half_up, :default:: round towards the nearest neighbor, unless both neighbors are equidistant, in which case round away from zero. (default) ROUND_HALF_DOWN, :half_down:: round towards the nearest neighbor, unless both neighbors are equidistant, in which case round towards zero. ROUND_HALF_EVEN, :half_even, :banker:: round towards the nearest neighbor, unless both neighbors are equidistant, in which case round towards the even neighbor (Banker's rounding) ROUND_CEILING, :ceiling, :ceil:: round towards positive infinity (ceil) ROUND_FLOOR, :floor:: round towards negative infinity (floor) ;T;0; @½F;!F;"o;#;$T;%iˆ;&i;'@F;(I"static VALUE BigDecimal_mode(int argc, VALUE *argv, VALUE self) { VALUE which; VALUE val; unsigned long f,fo; rb_scan_args(argc, argv, "11", &which, &val); f = (unsigned long)NUM2INT(which); if (f & VP_EXCEPTION_ALL) { /* Exception mode setting */ fo = VpGetException(); if (val == Qnil) return INT2FIX(fo); if (val != Qfalse && val!=Qtrue) { rb_raise(rb_eArgError, "second argument must be true or false"); return Qnil; /* Not reached */ } if (f & VP_EXCEPTION_INFINITY) { VpSetException((unsigned short)((val == Qtrue) ? (fo | VP_EXCEPTION_INFINITY) : (fo & (~VP_EXCEPTION_INFINITY)))); } fo = VpGetException(); if (f & VP_EXCEPTION_NaN) { VpSetException((unsigned short)((val == Qtrue) ? (fo | VP_EXCEPTION_NaN) : (fo & (~VP_EXCEPTION_NaN)))); } fo = VpGetException(); if (f & VP_EXCEPTION_UNDERFLOW) { VpSetException((unsigned short)((val == Qtrue) ? (fo | VP_EXCEPTION_UNDERFLOW) : (fo & (~VP_EXCEPTION_UNDERFLOW)))); } fo = VpGetException(); if(f & VP_EXCEPTION_ZERODIVIDE) { VpSetException((unsigned short)((val == Qtrue) ? (fo | VP_EXCEPTION_ZERODIVIDE) : (fo & (~VP_EXCEPTION_ZERODIVIDE)))); } fo = VpGetException(); return INT2FIX(fo); } if (VP_ROUND_MODE == f) { /* Rounding mode setting */ unsigned short sw; fo = VpGetRoundMode(); if (NIL_P(val)) return INT2FIX(fo); sw = check_rounding_mode(val); fo = VpSetRoundMode(sw); return INT2FIX(fo); } rb_raise(rb_eTypeError, "first argument for BigDecimal.mode invalid"); return Qnil; };T;)I"static VALUE;T;*To;;F; ;F;;;I"BigDecimal.limit;F;[[@c0;[[@yif;T;: limit;0;[;{;IC;"BigDecimal.limit(digits) Limit the number of significant digits in newly created BigDecimal numbers to the specified value. Rounding is performed as necessary, as specified by BigDecimal.mode. A limit of 0, the default, means no upper limit. The limit specified by this method takes less priority over any limit specified to instance methods such as ceil, floor, truncate, or round. ;T;[;[;I"ƒBigDecimal.limit(digits) Limit the number of significant digits in newly created BigDecimal numbers to the specified value. Rounding is performed as necessary, as specified by BigDecimal.mode. A limit of 0, the default, means no upper limit. The limit specified by this method takes less priority over any limit specified to instance methods such as ceil, floor, truncate, or round. ;T;0; @ÌF;!F;"o;#;$T;%iZ;&ie;'@F;(I"pstatic VALUE BigDecimal_limit(int argc, VALUE *argv, VALUE self) { VALUE nFig; VALUE nCur = SIZET2NUM(VpGetPrecLimit()); if (rb_scan_args(argc, argv, "01", &nFig) == 1) { int nf; if (NIL_P(nFig)) return nCur; nf = NUM2INT(nFig); if (nf < 0) { rb_raise(rb_eArgError, "argument must be positive"); } VpSetPrecLimit(nf); } return nCur; };T;)I"static VALUE;T;*To;;F; ;F;;;I"BigDecimal.double_fig;F;[;[[@yi];T;:double_fig;0;[;{;IC;"¬BigDecimal.double_fig The BigDecimal.double_fig class method returns the number of digits a Float number is allowed to have. The result depends upon the CPU and OS in use. ;T;[;[;I"®BigDecimal.double_fig The BigDecimal.double_fig class method returns the number of digits a Float number is allowed to have. The result depends upon the CPU and OS in use. ;T;0; @ÛF;!F;"o;#;$T;%iV;&i\;'@F;(I"Wstatic VALUE BigDecimal_double_fig(VALUE self) { return INT2FIX(VpDblFig()); };T;)I"static VALUE;T;*To;;F; ;F;;;I"BigDecimal._load;F;[[I"str;T0;[[@yi;T;;Ø;0;[;{;IC;"QInternal method used to provide marshalling support. See the Marshal module. ;T;[;[;I"RInternal method used to provide marshalling support. See the Marshal module. ;T;0; @éF;!F;"o;#;$T;%i;&i;'@F;(I"¹static VALUE BigDecimal_load(VALUE self, VALUE str) { ENTER(2); Real *pv; unsigned char *pch; unsigned char ch; unsigned long m=0; pch = (unsigned char *)StringValueCStr(str); /* First get max prec */ while((*pch) != (unsigned char)'\0' && (ch = *pch++) != (unsigned char)':') { if(!ISDIGIT(ch)) { rb_raise(rb_eTypeError, "load failed: invalid character in the marshaled string"); } m = m*10 + (unsigned long)(ch-'0'); } if (m > VpBaseFig()) m -= VpBaseFig(); GUARD_OBJ(pv, VpNewRbClass(m, (char *)pch, self)); m /= VpBaseFig(); if (m && pv->MaxPrec > m) { pv->MaxPrec = m+1; } return ToValue(pv); };T;)I"static VALUE;T;*To;;F; ;F;;;I"#BigDecimal.save_exception_mode;F;[;[[@yi¡;T;:save_exception_mode;0;[;{;IC;"–Execute the provided block, but preserve the exception mode BigDecimal.save_exception_mode do BigDecimal.mode(BigDecimal::EXCEPTION_OVERFLOW, false) BigDecimal.mode(BigDecimal::EXCEPTION_NaN, false) BigDecimal(BigDecimal('Infinity')) BigDecimal(BigDecimal('-Infinity')) BigDecimal(BigDecimal('NaN')) end For use with the BigDecimal::EXCEPTION_* See BigDecimal.mode ;T;[o;= ;3I" overload;F;40;;Ü;50;)I"save_exception_mode;T;IC;";T; @ùF;>0;!F;[o;2 ;3I" yield;F;4I"[];T;0;50; @ùF;[;I"@yield [];T;0;6i;[; @ùF;[;I"ÂExecute the provided block, but preserve the exception mode BigDecimal.save_exception_mode do BigDecimal.mode(BigDecimal::EXCEPTION_OVERFLOW, false) BigDecimal.mode(BigDecimal::EXCEPTION_NaN, false) BigDecimal(BigDecimal('Infinity')) BigDecimal(BigDecimal('-Infinity')) BigDecimal(BigDecimal('NaN')) end For use with the BigDecimal::EXCEPTION_* See BigDecimal.mode @overload save_exception_mode @yield [];T;0; @ùF;!F;"o;#;$T;%i;&i ;'@F;(I"static VALUE BigDecimal_save_exception_mode(VALUE self) { unsigned short const exception_mode = VpGetException(); int state; VALUE ret = rb_protect(rb_yield, Qnil, &state); VpSetException(exception_mode); if (state) rb_jump_tag(state); return ret; };T;)I"static VALUE;T;*To;;F; ;F;;;I""BigDecimal.save_rounding_mode;F;[;[[@yiº;T;:save_rounding_mode;0;[;{;IC;" Execute the provided block, but preserve the rounding mode BigDecimal.save_rounding_mode do BigDecimal.mode(BigDecimal::ROUND_MODE, :up) puts BigDecimal.mode(BigDecimal::ROUND_MODE) end For use with the BigDecimal::ROUND_* See BigDecimal.mode ;T;[o;= ;3I" overload;F;40;;Ý;50;)I"save_rounding_mode;T;IC;";T; @G;>0;!F;[o;2 ;3I" yield;F;4I"[];T;0;50; @G;[;I"@yield [];T;0;6i;[; @G;[;I"4Execute the provided block, but preserve the rounding mode BigDecimal.save_rounding_mode do BigDecimal.mode(BigDecimal::ROUND_MODE, :up) puts BigDecimal.mode(BigDecimal::ROUND_MODE) end For use with the BigDecimal::ROUND_* See BigDecimal.mode @overload save_rounding_mode @yield [];T;0; @G;!F;"o;#;$T;%i¬;&i¹;'@F;(I"static VALUE BigDecimal_save_rounding_mode(VALUE self) { unsigned short const round_mode = VpGetRoundMode(); int state; VALUE ret = rb_protect(rb_yield, Qnil, &state); VpSetRoundMode(round_mode); if (state) rb_jump_tag(state); return ret; };T;)I"static VALUE;T;*To;;F; ;F;;;I"BigDecimal.save_limit;F;[;[[@yiÓ;T;:save_limit;0;[;{;IC;"óExecute the provided block, but preserve the precision limit BigDecimal.limit(100) puts BigDecimal.limit BigDecimal.save_limit do BigDecimal.limit(200) puts BigDecimal.limit end puts BigDecimal.limit ;T;[o;= ;3I" overload;F;40;;Þ;50;)I"save_limit;T;IC;";T; @+G;>0;!F;[o;2 ;3I" yield;F;4I"[];T;0;50; @+G;[;I"@yield [];T;0;6i;[; @+G;[;I"Execute the provided block, but preserve the precision limit BigDecimal.limit(100) puts BigDecimal.limit BigDecimal.save_limit do BigDecimal.limit(200) puts BigDecimal.limit end puts BigDecimal.limit @overload save_limit @yield [];T;0; @+G;!F;"o;#;$T;%iÅ;&iÒ;'@F;(I"îstatic VALUE BigDecimal_save_limit(VALUE self) { size_t const limit = VpGetPrecLimit(); int state; VALUE ret = rb_protect(rb_yield, Qnil, &state); VpSetPrecLimit(limit); if (state) rb_jump_tag(state); return ret; };T;)I"static VALUE;T;*To;{;[[@yi© ;F;;h;;};;;[;{;IC;"&The version of bigdecimal library ;T;[;[;I"'The version of bigdecimal library ;T;0; @DG;!F;"o;#;$T;%i¦ ;&i§ ;'@F;I"BigDecimal::VERSION;F;~I")rb_str_new2(RUBY_BIGDECIMAL_VERSION);To;{;[[@yi² ;F;: BASE;;};;;[;{;IC;"Base value used in internal calculations. On a 32 bit system, BASE is 10000, indicating that calculation is done in groups of 4 digits. (If it were larger, BASE**2 wouldn't fit in 32 bits, so you couldn't guarantee that two groups could always be multiplied together without overflow.) ;T;[;[;I"Base value used in internal calculations. On a 32 bit system, BASE is 10000, indicating that calculation is done in groups of 4 digits. (If it were larger, BASE**2 wouldn't fit in 32 bits, so you couldn't guarantee that two groups could always be multiplied together without overflow.) ;T;0; @PG;!F;"o;#;$T;%i« ;&i° ;'@F;I"BigDecimal::BASE;F;~I"'INT2FIX((SIGNED_VALUE)VpBaseVal());To;{;[[@yiº ;F;:EXCEPTION_ALL;;};;;[;{;IC;"tDetermines whether overflow, underflow or zero divide result in an exception being thrown. See BigDecimal.mode. ;T;[;[;I"uDetermines whether overflow, underflow or zero divide result in an exception being thrown. See BigDecimal.mode. ;T;0; @\G;!F;"o;#;$T;%i¶ ;&i¸ ;'@F;I"BigDecimal::EXCEPTION_ALL;F;~I" 0xff;To;{;[[@yiÀ ;F;:EXCEPTION_NaN;;};;;[;{;IC;"iDetermines what happens when the result of a computation is not a number (NaN). See BigDecimal.mode. ;T;[;[;I"jDetermines what happens when the result of a computation is not a number (NaN). See BigDecimal.mode. ;T;0; @hG;!F;"o;#;$T;%i¼ ;&i¾ ;'@F;I"BigDecimal::EXCEPTION_NaN;F;~I" 0x02;To;{;[[@yiÆ ;F;:EXCEPTION_INFINITY;;};;;[;{;IC;"`Determines what happens when the result of a computation is infinity. See BigDecimal.mode. ;T;[;[;I"aDetermines what happens when the result of a computation is infinity. See BigDecimal.mode. ;T;0; @tG;!F;"o;#;$T;%iÂ ;&iÄ ;'@F;I"#BigDecimal::EXCEPTION_INFINITY;F;~I" 0x01;To;{;[[@yiÌ ;F;:EXCEPTION_UNDERFLOW;;};;;[;{;IC;"…Determines what happens when the result of a computation is an underflow (a result too small to be represented). See BigDecimal.mode. ;T;[;[;I"†Determines what happens when the result of a computation is an underflow (a result too small to be represented). See BigDecimal.mode. ;T;0; @€G;!F;"o;#;$T;%iÈ ;&iÊ ;'@F;I"$BigDecimal::EXCEPTION_UNDERFLOW;F;~I" 0x04;To;{;[[@yiÒ ;F;:EXCEPTION_OVERFLOW;;};;;[;{;IC;"„Determines what happens when the result of a computation is an overflow (a result too large to be represented). See BigDecimal.mode. ;T;[;[;I"…Determines what happens when the result of a computation is an overflow (a result too large to be represented). See BigDecimal.mode. ;T;0; @ŒG;!F;"o;#;$T;%iÎ ;&iÐ ;'@F;I"#BigDecimal::EXCEPTION_OVERFLOW;F;~I" 0x01;To;{;[[@yiØ ;F;:EXCEPTION_ZERODIVIDE;;};;;[;{;IC;"WDetermines what happens when a division by zero is performed. See BigDecimal.mode. ;T;[;[;I"XDetermines what happens when a division by zero is performed. See BigDecimal.mode. ;T;0; @˜G;!F;"o;#;$T;%iÔ ;&iÖ ;'@F;I"%BigDecimal::EXCEPTION_ZERODIVIDE;F;~I" 0x10;To;{;[[@yiß ;F;:ROUND_MODE;;};;;[;{;IC;"‹Determines what happens when a result must be rounded in order to fit in the appropriate number of significant digits. See BigDecimal.mode. ;T;[;[;I"ŒDetermines what happens when a result must be rounded in order to fit in the appropriate number of significant digits. See BigDecimal.mode. ;T;0; @¤G;!F;"o;#;$T;%iÚ ;&iÝ ;'@F;I"BigDecimal::ROUND_MODE;F;~I" 0x100;To;{;[[@yiä ;F;: ROUND_UP;;};;;[;{;IC;"QIndicates that values should be rounded away from zero. See BigDecimal.mode. ;T;[;[;I"RIndicates that values should be rounded away from zero. See BigDecimal.mode. ;T;0; @°G;!F;"o;#;$T;%iá ;&iã ;'@F;I"BigDecimal::ROUND_UP;F;~I"1;To;{;[[@yié ;F;:ROUND_DOWN;;};;;[;{;IC;"OIndicates that values should be rounded towards zero. See BigDecimal.mode. ;T;[;[;I"PIndicates that values should be rounded towards zero. See BigDecimal.mode. ;T;0; @¼G;!F;"o;#;$T;%iæ ;&iè ;'@F;I"BigDecimal::ROUND_DOWN;F;~I"2;To;{;[[@yií ;F;:ROUND_HALF_UP;;};;;[;{;IC;"_Indicates that digits >= 5 should be rounded up, others rounded down. See BigDecimal.mode. ;T;[;[;I"_Indicates that digits >= 5 should be rounded up, others rounded down. See BigDecimal.mode.;T;0; @ÈG;!F;"o;#;$T;%ië ;&iì ;'@F;I"BigDecimal::ROUND_HALF_UP;F;~I"3;To;{;[[@yiò ;F;:ROUND_HALF_DOWN;;};;;[;{;IC;"_Indicates that digits >= 6 should be rounded up, others rounded down. See BigDecimal.mode. ;T;[;[;I"`Indicates that digits >= 6 should be rounded up, others rounded down. See BigDecimal.mode. ;T;0; @ÔG;!F;"o;#;$T;%iï ;&iñ ;'@F;I" BigDecimal::ROUND_HALF_DOWN;F;~I"4;To;{;[[@yiô ;F;:ROUND_CEILING;;};;;[;{;IC;"2Round towards +Infinity. See BigDecimal.mode. ;T;[;[;I"2Round towards +Infinity. See BigDecimal.mode.;T;0; @àG;!F;"o;#;$T;%ió ;&ió ;'@F;I"BigDecimal::ROUND_CEILING;F;~I"5;To;{;[[@yi÷ ;F;:ROUND_FLOOR;;};;;[;{;IC;"2Round towards -Infinity. See BigDecimal.mode. ;T;[;[;I"2Round towards -Infinity. See BigDecimal.mode.;T;0; @ìG;!F;"o;#;$T;%iö ;&iö ;'@F;I"BigDecimal::ROUND_FLOOR;F;~I"6;To;{;[[@yiú ;F;:ROUND_HALF_EVEN;;};;;[;{;IC;":Round towards the even neighbor. See BigDecimal.mode. ;T;[;[;I":Round towards the even neighbor. See BigDecimal.mode.;T;0; @øG;!F;"o;#;$T;%iù ;&iù ;'@F;I" BigDecimal::ROUND_HALF_EVEN;F;~I"7;To;{;[[@yiý ;F;: SIGN_NaN;;};;;[;{;IC;"AIndicates that a value is not a number. See BigDecimal.sign. ;T;[;[;I"AIndicates that a value is not a number. See BigDecimal.sign.;T;0; @H;!F;"o;#;$T;%iü ;&iü ;'@F;I"BigDecimal::SIGN_NaN;F;~I"0;To;{;[[@yi;F;:SIGN_POSITIVE_ZERO;;};;;[;{;IC;"7Indicates that a value is +0. See BigDecimal.sign. ;T;[;[;I"7Indicates that a value is +0. See BigDecimal.sign.;T;0; @H;!F;"o;#;$T;%iÿ ;&iÿ ;'@F;I"#BigDecimal::SIGN_POSITIVE_ZERO;F;~I"1;To;{;[[@yi;F;:SIGN_NEGATIVE_ZERO;;};;;[;{;IC;"7Indicates that a value is -0. See BigDecimal.sign. ;T;[;[;I"7Indicates that a value is -0. See BigDecimal.sign.;T;0; @H;!F;"o;#;$T;%i;&i;'@F;I"#BigDecimal::SIGN_NEGATIVE_ZERO;F;~I"-1;To;{;[[@yi;F;:SIGN_POSITIVE_FINITE;;};;;[;{;IC;"HIndicates that a value is positive and finite. See BigDecimal.sign. ;T;[;[;I"HIndicates that a value is positive and finite. See BigDecimal.sign.;T;0; @(H;!F;"o;#;$T;%i;&i;'@F;I"%BigDecimal::SIGN_POSITIVE_FINITE;F;~I"2;To;{;[[@yi ;F;:SIGN_NEGATIVE_FINITE;;};;;[;{;IC;"HIndicates that a value is negative and finite. See BigDecimal.sign. ;T;[;[;I"HIndicates that a value is negative and finite. See BigDecimal.sign.;T;0; @4H;!F;"o;#;$T;%i;&i;'@F;I"%BigDecimal::SIGN_NEGATIVE_FINITE;F;~I"-2;To;{;[[@yi;F;:SIGN_POSITIVE_INFINITE;;};;;[;{;IC;"JIndicates that a value is positive and infinite. See BigDecimal.sign. ;T;[;[;I"JIndicates that a value is positive and infinite. See BigDecimal.sign.;T;0; @@H;!F;"o;#;$T;%i;&i;'@F;I"'BigDecimal::SIGN_POSITIVE_INFINITE;F;~I"3;To;{;[[@yi;F;:SIGN_NEGATIVE_INFINITE;;};;;[;{;IC;"JIndicates that a value is negative and infinite. See BigDecimal.sign. ;T;[;[;I"JIndicates that a value is negative and infinite. See BigDecimal.sign.;T;0; @LH;!F;"o;#;$T;%i;&i;'@F;I"'BigDecimal::SIGN_NEGATIVE_INFINITE;F;~I"-3;To;{;[[@yi;F;;Ë;;};;;[;{;IC;"Positive infinity value. ;T;[;[;I"Positive infinity value.;T;0; @XH;!F;"o;#;$T;%i;&i;'@F;I"BigDecimal::INFINITY;F;~I"*f_BigDecimal(1, &arg, rb_cBigDecimal);To;{;[[@yi;F;;Ì;;};;;[;{;IC;"'Not a Number' value. ;T;[;[;I"'Not a Number' value.;T;0; @dH;!F;"o;#;$T;%i;&i;'@F;I"BigDecimal::NAN;F;~I"*f_BigDecimal(1, &arg, rb_cBigDecimal);To;;F; ;;;;I"BigDecimal#precs;F;[;[[@yiq;T;: precs;0;[;{;IC;"ŽReturns an Array of two Integer values that represent platform-dependent internal storage properties. This method is deprecated and will be removed in the future. Instead, use BigDecimal#n_significant_digits for obtaining the number of significant digits in scientific notation, and BigDecimal#precision for obtaining the number of digits in decimal notation. BigDecimal('5').precs #=> [9, 18] ;T;[o;= ;3I" overload;F;40;;õ;50;)I" precs;T;IC;";T; @pH;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @pH;[;I"@return [Array];T;0;6i;[; @pH;[;I"²Returns an Array of two Integer values that represent platform-dependent internal storage properties. This method is deprecated and will be removed in the future. Instead, use BigDecimal#n_significant_digits for obtaining the number of significant digits in scientific notation, and BigDecimal#precision for obtaining the number of digits in decimal notation. BigDecimal('5').precs #=> [9, 18] @overload precs @return [Array];T;0; @pH;!F;"o;#;$T;%ic;&io;'@F;(I"ºstatic VALUE BigDecimal_prec(VALUE self) { ENTER(1); Real *p; VALUE obj; rb_category_warn(RB_WARN_CATEGORY_DEPRECATED, "BigDecimal#precs is deprecated and will be removed in the future; " "use BigDecimal#precision instead."); GUARD_OBJ(p, GetVpValue(self, 1)); obj = rb_assoc_new(SIZET2NUM(p->Prec*VpBaseFig()), SIZET2NUM(p->MaxPrec*VpBaseFig())); return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#precision;F;[;[[@yi’;T;:precision;0;[;{;IC;"VReturns the number of decimal digits in this number. Example: BigDecimal("0").precision # => 0 BigDecimal("1").precision # => 1 BigDecimal("-1e20").precision # => 21 BigDecimal("1e-20").precision # => 20 BigDecimal("Infinity").precision # => 0 BigDecimal("-Infinity").precision # => 0 BigDecimal("NaN").precision # => 0 ;T;[o;= ;3I" overload;F;40;;ö;50;)I"precision;T;IC;";T; @‹H;>0;!F;[;[;I";T;0;6i;[; @‹H;[;I"lReturns the number of decimal digits in this number. Example: BigDecimal("0").precision # => 0 BigDecimal("1").precision # => 1 BigDecimal("-1e20").precision # => 21 BigDecimal("1e-20").precision # => 20 BigDecimal("Infinity").precision # => 0 BigDecimal("-Infinity").precision # => 0 BigDecimal("NaN").precision # => 0 @overload precision;T;0; @‹H;!F;"o;#;$T;%i‚;&i;'@F;(I"Ystatic VALUE BigDecimal_precision(VALUE self) { ENTER(1); Real *p; GUARD_OBJ(p, GetVpValue(self, 1)); /* * The most significant digit is frac[0], and the least significant digit is frac[Prec-1]. * When the exponent is zero, the decimal point is located just before frac[0]. * When the exponent is negative, the decimal point moves to leftward. * Conversely, when the exponent is positive, the decimal point moves to rightward. * * | frac[0] frac[1] frac[2] . frac[3] frac[4] ... frac[Prec-1] * |------------------------> exponent == 3 */ ssize_t ex = p->exponent; ssize_t precision = 0; if (ex < 0) { precision = (-ex + 1) * BASE_FIG; /* 1 is for p->frac[0] */ ex = 0; } else if (p->Prec > 0) { BDIGIT x = p->frac[0]; for (precision = 0; x > 0; x /= 10) { ++precision; } } if (ex > (ssize_t)p->Prec) { precision += (ex - 1) * BASE_FIG; } else if (p->Prec > 0) { ssize_t n = (ssize_t)p->Prec - 1; while (n > 0 && p->frac[n] == 0) --n; precision += n * BASE_FIG; if (ex < (ssize_t)p->Prec) { BDIGIT x = p->frac[n]; for (; x > 0 && x % 10 == 0; x /= 10) { --precision; } } } return SSIZET2NUM(precision); };T;)I"static VALUE;T;*To;;F; ;;;;I"$BigDecimal#n_significant_digits;F;[;[[@yiÅ;T;:n_significant_digits;0;[;{;IC;";T;[;[;@|;0; @¡H;'@F;(I"ùstatic VALUE BigDecimal_n_significant_digits(VALUE self) { ENTER(1); Real *p; GUARD_OBJ(p, GetVpValue(self, 1)); ssize_t n = p->Prec; while (n > 0 && p->frac[n-1] == 0) --n; if (n <= 0) { return INT2FIX(0); } int nlz, ntz; BDIGIT x = p->frac[0]; for (nlz = BASE_FIG; x > 0; x /= 10) --nlz; x = p->frac[n-1]; for (ntz = 0; x > 0 && x % 10 == 0; x /= 10) ++ntz; ssize_t n_digits = BASE_FIG * n - nlz - ntz; return SSIZET2NUM(n_digits); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#add;F;[[I"b;T0[I"n;T0;[[@yi×;T;;?;0;[;{;IC;"call-seq: add(value, digits) Add the specified value. e.g. c = a.add(b,n) c = a + b digits:: If specified and less than the number of significant digits of the result, the result is rounded to that number of digits, according to BigDecimal.mode. ;T;[;[;I" call-seq: add(value, digits) Add the specified value. e.g. c = a.add(b,n) c = a + b digits:: If specified and less than the number of significant digits of the result, the result is rounded to that number of digits, according to BigDecimal.mode. ;T;0; @H;!F;"o;#;$T;%i;&i;'@F;(I"€static VALUE BigDecimal_add2(VALUE self, VALUE b, VALUE n) { ENTER(2); Real *cv; SIGNED_VALUE mx = GetPrecisionInt(n); if (mx == 0) return BigDecimal_add(self, b); else { size_t pl = VpSetPrecLimit(0); VALUE c = BigDecimal_add(self, b); VpSetPrecLimit(pl); GUARD_OBJ(cv, GetVpValue(c, 1)); VpLeftRound(cv, VpGetRoundMode(), mx); return ToValue(cv); } };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#sub;F;[[I"b;T0[I"n;T0;[[@yiõ;T;;—;0;[;{;IC;"sub(value, digits) -> bigdecimal Subtract the specified value. e.g. c = a.sub(b,n) digits:: If specified and less than the number of significant digits of the result, the result is rounded to that number of digits, according to BigDecimal.mode. ;T;[;[;I"sub(value, digits) -> bigdecimal Subtract the specified value. e.g. c = a.sub(b,n) digits:: If specified and less than the number of significant digits of the result, the result is rounded to that number of digits, according to BigDecimal.mode. ;T;0; @¿H;!F;"o;#;$T;%iè;&iô;'@F;(I"€static VALUE BigDecimal_sub2(VALUE self, VALUE b, VALUE n) { ENTER(2); Real *cv; SIGNED_VALUE mx = GetPrecisionInt(n); if (mx == 0) return BigDecimal_sub(self, b); else { size_t pl = VpSetPrecLimit(0); VALUE c = BigDecimal_sub(self, b); VpSetPrecLimit(pl); GUARD_OBJ(cv, GetVpValue(c, 1)); VpLeftRound(cv, VpGetRoundMode(), mx); return ToValue(cv); } };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#mult;F;[[I"b;T0[I"n;T0;[[@yi;T;: mult;0;[;{;IC;"call-seq: mult(value, digits) Multiply by the specified value. e.g. c = a.mult(b,n) c = a * b digits:: If specified and less than the number of significant digits of the result, the result is rounded to that number of digits, according to BigDecimal.mode. ;T;[;[;I" call-seq: mult(value, digits) Multiply by the specified value. e.g. c = a.mult(b,n) c = a * b digits:: If specified and less than the number of significant digits of the result, the result is rounded to that number of digits, according to BigDecimal.mode. ;T;0; @ÑH;!F;"o;#;$T;%iQ;&i];'@F;(I"ƒstatic VALUE BigDecimal_mult2(VALUE self, VALUE b, VALUE n) { ENTER(2); Real *cv; SIGNED_VALUE mx = GetPrecisionInt(n); if (mx == 0) return BigDecimal_mult(self, b); else { size_t pl = VpSetPrecLimit(0); VALUE c = BigDecimal_mult(self, b); VpSetPrecLimit(pl); GUARD_OBJ(cv, GetVpValue(c, 1)); VpLeftRound(cv, VpGetRoundMode(), mx); return ToValue(cv); } };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#div;F;[[@c0;[[@yiÍ;T;;X;0;[;{;IC;"×call-seq: div(value, digits) -> bigdecimal or integer Divide by the specified value. digits:: If specified and less than the number of significant digits of the result, the result is rounded to that number of digits, according to BigDecimal.mode. If digits is 0, the result is the same as for the / operator or #quo. If digits is not specified, the result is an integer, by analogy with Float#div; see also BigDecimal#divmod. Examples: a = BigDecimal("4") b = BigDecimal("3") a.div(b, 3) # => 0.133e1 a.div(b, 0) # => 0.1333333333333333333e1 a / b # => 0.1333333333333333333e1 a.quo(b) # => 0.1333333333333333333e1 a.div(b) # => 1 ;T;[;[;I"Ù call-seq: div(value, digits) -> bigdecimal or integer Divide by the specified value. digits:: If specified and less than the number of significant digits of the result, the result is rounded to that number of digits, according to BigDecimal.mode. If digits is 0, the result is the same as for the / operator or #quo. If digits is not specified, the result is an integer, by analogy with Float#div; see also BigDecimal#divmod. Examples: a = BigDecimal("4") b = BigDecimal("3") a.div(b, 3) # => 0.133e1 a.div(b, 0) # => 0.1333333333333333333e1 a / b # => 0.1333333333333333333e1 a.quo(b) # => 0.1333333333333333333e1 a.div(b) # => 1 ;T;0; @ãH;!F;"o;#;$T;%i®;&iÊ;'@F;(I"¨static VALUE BigDecimal_div3(int argc, VALUE *argv, VALUE self) { VALUE b,n; rb_scan_args(argc, argv, "11", &b, &n); return BigDecimal_div2(self, b, n); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#hash;F;[;[[@yiç;T;;b;0;[;{;IC;"{Creates a hash for this BigDecimal. Two BigDecimals with equal sign, fractional part and exponent have the same hash. ;T;[o;= ;3I" overload;F;40;;b;50;)I" hash;T;IC;";T; @òH;>0;!F;[;[;I";T;0;6i;[; @òH;[;I"‡Creates a hash for this BigDecimal. Two BigDecimals with equal sign, fractional part and exponent have the same hash. @overload hash;T;0; @òH;!F;"o;#;$T;%iß;&iå;'@F;(I"‰static VALUE BigDecimal_hash(VALUE self) { ENTER(1); Real *p; st_index_t hash; GUARD_OBJ(p, GetVpValue(self, 1)); hash = (st_index_t)p->sign; /* hash!=2: the case for 0(1),NaN(0) or +-Infinity(3) is sign itself */ if(hash == 2 || hash == (st_index_t)-2) { hash ^= rb_memhash(p->frac, sizeof(BDIGIT)*p->Prec); hash += p->exponent; } return ST2FIX(hash); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#to_s;F;[[@c0;[[@yi_;T;;q;0;[;{;IC;"xto_s(s) Converts the value to a string. The default format looks like 0.xxxxEnn. The optional parameter s consists of either an integer; or an optional '+' or ' ', followed by an optional number, followed by an optional 'E' or 'F'. If there is a '+' at the start of s, positive values are returned with a leading '+'. A space at the start of s returns positive values with a leading space. If s contains a number, a space is inserted after each group of that many fractional digits. If s ends with an 'E', engineering notation (0.xxxxEnn) is used. If s ends with an 'F', conventional floating point notation is used. Examples: BigDecimal('-123.45678901234567890').to_s('5F') #=> '-123.45678 90123 45678 9' BigDecimal('123.45678901234567890').to_s('+8F') #=> '+123.45678901 23456789' BigDecimal('123.45678901234567890').to_s(' F') #=> ' 123.4567890123456789' ;T;[;[;I"zto_s(s) Converts the value to a string. The default format looks like 0.xxxxEnn. The optional parameter s consists of either an integer; or an optional '+' or ' ', followed by an optional number, followed by an optional 'E' or 'F'. If there is a '+' at the start of s, positive values are returned with a leading '+'. A space at the start of s returns positive values with a leading space. If s contains a number, a space is inserted after each group of that many fractional digits. If s ends with an 'E', engineering notation (0.xxxxEnn) is used. If s ends with an 'F', conventional floating point notation is used. Examples: BigDecimal('-123.45678901234567890').to_s('5F') #=> '-123.45678 90123 45678 9' BigDecimal('123.45678901234567890').to_s('+8F') #=> '+123.45678901 23456789' BigDecimal('123.45678901234567890').to_s(' F') #=> ' 123.4567890123456789' ;T;0; @I;!F;"o;#;$T;%i>;&i^;'@F;(I"Jstatic VALUE BigDecimal_to_s(int argc, VALUE *argv, VALUE self) { ENTER(5); int fmt = 0; /* 0: E format, 1: F format */ int fPlus = 0; /* 0: default, 1: set ' ' before digits, 2: set '+' before digits. */ Real *vp; volatile VALUE str; char *psz; char ch; size_t nc, mc = 0; SIGNED_VALUE m; VALUE f; GUARD_OBJ(vp, GetVpValue(self, 1)); if (rb_scan_args(argc, argv, "01", &f) == 1) { if (RB_TYPE_P(f, T_STRING)) { psz = StringValueCStr(f); if (*psz == ' ') { fPlus = 1; psz++; } else if (*psz == '+') { fPlus = 2; psz++; } while ((ch = *psz++) != 0) { if (ISSPACE(ch)) { continue; } if (!ISDIGIT(ch)) { if (ch == 'F' || ch == 'f') { fmt = 1; /* F format */ } break; } mc = mc*10 + ch - '0'; } } else { m = NUM2INT(f); if (m <= 0) { rb_raise(rb_eArgError, "argument must be positive"); } mc = (size_t)m; } } if (fmt) { nc = VpNumOfChars(vp, "F"); } else { nc = VpNumOfChars(vp, "E"); } if (mc > 0) { nc += (nc + mc - 1) / mc + 1; } str = rb_usascii_str_new(0, nc); psz = RSTRING_PTR(str); if (fmt) { VpToFString(vp, psz, mc, fPlus); } else { VpToString (vp, psz, mc, fPlus); } rb_str_resize(str, strlen(psz)); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#to_i;F;[;[[@yiZ;T;;–;0;[;{;IC;"eReturns the value as an Integer. If the BigDecimal is infinity or NaN, raises FloatDomainError. ;T;[;[;I"fReturns the value as an Integer. If the BigDecimal is infinity or NaN, raises FloatDomainError. ;T;0; @I;!F;"o;#;$T;%iV;&iY;'@F;(I"static VALUE BigDecimal_to_i(VALUE self) { ENTER(5); ssize_t e, nf; Real *p; GUARD_OBJ(p, GetVpValue(self, 1)); BigDecimal_check_num(p); e = VpExponent10(p); if (e <= 0) return INT2FIX(0); nf = VpBaseFig(); if (e <= nf) { return LONG2NUM((long)(VpGetSign(p) * (BDIGIT_DBL_SIGNED)p->frac[0])); } else { VALUE a = BigDecimal_split(self); VALUE digits = RARRAY_AREF(a, 1); VALUE numerator = rb_funcall(digits, rb_intern("to_i"), 0); VALUE ret; ssize_t dpower = e - (ssize_t)RSTRING_LEN(digits); if (BIGDECIMAL_NEGATIVE_P(p)) { numerator = rb_funcall(numerator, '*', 1, INT2FIX(-1)); } if (dpower < 0) { ret = rb_funcall(numerator, rb_intern("div"), 1, rb_funcall(INT2FIX(10), rb_intern("**"), 1, INT2FIX(-dpower))); } else { ret = rb_funcall(numerator, '*', 1, rb_funcall(INT2FIX(10), rb_intern("**"), 1, INT2FIX(dpower))); } if (RB_TYPE_P(ret, T_FLOAT)) { rb_raise(rb_eFloatDomainError, "Infinity"); } return ret; } };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#to_int;F;[;[[@yiZ;T;;\;0;[;{;IC;"eReturns the value as an Integer. If the BigDecimal is infinity or NaN, raises FloatDomainError. ;T;[;[;@!I;0; @%I;!F;"o;#;$T;%iV;&iY;'@F;(I"static VALUE BigDecimal_to_i(VALUE self) { ENTER(5); ssize_t e, nf; Real *p; GUARD_OBJ(p, GetVpValue(self, 1)); BigDecimal_check_num(p); e = VpExponent10(p); if (e <= 0) return INT2FIX(0); nf = VpBaseFig(); if (e <= nf) { return LONG2NUM((long)(VpGetSign(p) * (BDIGIT_DBL_SIGNED)p->frac[0])); } else { VALUE a = BigDecimal_split(self); VALUE digits = RARRAY_AREF(a, 1); VALUE numerator = rb_funcall(digits, rb_intern("to_i"), 0); VALUE ret; ssize_t dpower = e - (ssize_t)RSTRING_LEN(digits); if (BIGDECIMAL_NEGATIVE_P(p)) { numerator = rb_funcall(numerator, '*', 1, INT2FIX(-1)); } if (dpower < 0) { ret = rb_funcall(numerator, rb_intern("div"), 1, rb_funcall(INT2FIX(10), rb_intern("**"), 1, INT2FIX(-dpower))); } else { ret = rb_funcall(numerator, '*', 1, rb_funcall(INT2FIX(10), rb_intern("**"), 1, INT2FIX(dpower))); } if (RB_TYPE_P(ret, T_FLOAT)) { rb_raise(rb_eFloatDomainError, "Infinity"); } return ret; } };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#to_r;F;[;[[@yi¸;T;;P;0;[;{;IC;")Converts a BigDecimal to a Rational. ;T;[;[;I"*Converts a BigDecimal to a Rational. ;T;0; @2I;!F;"o;#;$T;%i¶;&i·;'@F;(I"$static VALUE BigDecimal_to_r(VALUE self) { Real *p; ssize_t sign, power, denomi_power; VALUE a, digits, numerator; p = GetVpValue(self, 1); BigDecimal_check_num(p); sign = VpGetSign(p); power = VpExponent10(p); a = BigDecimal_split(self); digits = RARRAY_AREF(a, 1); denomi_power = power - RSTRING_LEN(digits); numerator = rb_funcall(digits, rb_intern("to_i"), 0); if (sign < 0) { numerator = rb_funcall(numerator, '*', 1, INT2FIX(-1)); } if (denomi_power < 0) { return rb_Rational(numerator, rb_funcall(INT2FIX(10), rb_intern("**"), 1, INT2FIX(-denomi_power))); } else { return rb_Rational1(rb_funcall(numerator, '*', 1, rb_funcall(INT2FIX(10), rb_intern("**"), 1, INT2FIX(denomi_power)))); } };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#split;F;[;[[@yi¾;T;;‡;0;[;{;IC;"gSplits a BigDecimal number into four parts, returned as an array of values. The first value represents the sign of the BigDecimal, and is -1 or 1, or 0 if the BigDecimal is Not a Number. The second value is a string representing the significant digits of the BigDecimal, with no leading zeros. The third value is the base used for arithmetic (currently always 10) as an Integer. The fourth value is an Integer exponent. If the BigDecimal can be represented as 0.xxxxxx*10**n, then xxxxxx is the string of significant digits with no leading zeros, and n is the exponent. From these values, you can translate a BigDecimal to a float as follows: sign, significant_digits, base, exponent = a.split f = sign * "0.#{significant_digits}".to_f * (base ** exponent) (Note that the to_f method is provided as a more convenient way to translate a BigDecimal to a Float.) ;T;[;[;I"hSplits a BigDecimal number into four parts, returned as an array of values. The first value represents the sign of the BigDecimal, and is -1 or 1, or 0 if the BigDecimal is Not a Number. The second value is a string representing the significant digits of the BigDecimal, with no leading zeros. The third value is the base used for arithmetic (currently always 10) as an Integer. The fourth value is an Integer exponent. If the BigDecimal can be represented as 0.xxxxxx*10**n, then xxxxxx is the string of significant digits with no leading zeros, and n is the exponent. From these values, you can translate a BigDecimal to a float as follows: sign, significant_digits, base, exponent = a.split f = sign * "0.#{significant_digits}".to_f * (base ** exponent) (Note that the to_f method is provided as a more convenient way to translate a BigDecimal to a Float.) ;T;0; @@I;!F;"o;#;$T;%i¦;&i½;'@F;(I"µstatic VALUE BigDecimal_split(VALUE self) { ENTER(5); Real *vp; VALUE obj,str; ssize_t e, s; char *psz1; GUARD_OBJ(vp, GetVpValue(self, 1)); str = rb_str_new(0, VpNumOfChars(vp, "E")); psz1 = RSTRING_PTR(str); VpSzMantissa(vp, psz1); s = 1; if(psz1[0] == '-') { size_t len = strlen(psz1 + 1); memmove(psz1, psz1 + 1, len); psz1[len] = '\0'; s = -1; } if (psz1[0] == 'N') s = 0; /* NaN */ e = VpExponent10(vp); obj = rb_ary_new2(4); rb_ary_push(obj, INT2FIX(s)); rb_ary_push(obj, str); rb_str_resize(str, strlen(psz1)); rb_ary_push(obj, INT2FIX(10)); rb_ary_push(obj, SSIZET2NUM(e)); return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#+;F;[[I"r;T0;[[@yi;T;;&;0;[;{;IC;"call-seq: add(value, digits) Add the specified value. e.g. c = a.add(b,n) c = a + b digits:: If specified and less than the number of significant digits of the result, the result is rounded to that number of digits, according to BigDecimal.mode. ;T;[;[;@»H;0; @NI;!F;"o;#;$T;%i;&i;'@F;(I"1static VALUE BigDecimal_add(VALUE self, VALUE r) { ENTER(5); Real *c, *a, *b; size_t mx; GUARD_OBJ(a, GetVpValue(self, 1)); if (RB_TYPE_P(r, T_FLOAT)) { b = GetVpValueWithPrec(r, DBLE_FIG, 1); } else if (RB_TYPE_P(r, T_RATIONAL)) { b = GetVpValueWithPrec(r, a->Prec*VpBaseFig(), 1); } else { b = GetVpValue(r, 0); } if (!b) return DoSomeOne(self,r,'+'); SAVE(b); if (VpIsNaN(b)) return b->obj; if (VpIsNaN(a)) return a->obj; mx = GetAddSubPrec(a, b); if (mx == (size_t)-1L) { GUARD_OBJ(c,VpCreateRbObject(VpBaseFig() + 1, "0")); VpAddSub(c, a, b, 1); } else { GUARD_OBJ(c, VpCreateRbObject(mx * (VpBaseFig() + 1), "0")); if(!mx) { VpSetInf(c, VpGetSign(a)); } else { VpAddSub(c, a, b, 1); } } return ToValue(c); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#-;F;[[I"r;T0;[[@yiY;T;;;0;[;{;IC;"ea - b -> bigdecimal Subtract the specified value. e.g. c = a - b The precision of the result value depends on the type of +b+. If +b+ is a Float, the precision of the result is Float::DIG+1. If +b+ is a BigDecimal, the precision of the result is +b+'s precision of internal representation from platform. So, it's return value is platform dependent. ;T;[;[;I"ha - b -> bigdecimal Subtract the specified value. e.g. c = a - b The precision of the result value depends on the type of +b+. If +b+ is a Float, the precision of the result is Float::DIG+1. If +b+ is a BigDecimal, the precision of the result is +b+'s precision of internal representation from platform. So, it's return value is platform dependent. ;T;0; @]I;!F;"o;#;$T;%iH;&iX;'@F;(I".static VALUE BigDecimal_sub(VALUE self, VALUE r) { ENTER(5); Real *c, *a, *b; size_t mx; GUARD_OBJ(a, GetVpValue(self,1)); if (RB_TYPE_P(r, T_FLOAT)) { b = GetVpValueWithPrec(r, DBLE_FIG, 1); } else if (RB_TYPE_P(r, T_RATIONAL)) { b = GetVpValueWithPrec(r, a->Prec*VpBaseFig(), 1); } else { b = GetVpValue(r,0); } if (!b) return DoSomeOne(self,r,'-'); SAVE(b); if (VpIsNaN(b)) return b->obj; if (VpIsNaN(a)) return a->obj; mx = GetAddSubPrec(a,b); if (mx == (size_t)-1L) { GUARD_OBJ(c,VpCreateRbObject(VpBaseFig() + 1, "0")); VpAddSub(c, a, b, -1); } else { GUARD_OBJ(c,VpCreateRbObject(mx *(VpBaseFig() + 1), "0")); if (!mx) { VpSetInf(c,VpGetSign(a)); } else { VpAddSub(c, a, b, -1); } } return ToValue(c); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#+@;F;[;[[@yi;T;;W;0;[;{;IC;"2Return self. +BigDecimal('5') #=> 0.5e1 ;T;[o;= ;3I" overload;F;40;;&;50;)I"+big_decimal;T;IC;";T; @mI;>0;!F;[;[;I";T;0;6i;[; @mI;[;I"KReturn self. +BigDecimal('5') #=> 0.5e1 @overload +big_decimal;T;0; @mI;!F;"o;#;$T;%iÿ;&i;'@F;(I"Cstatic VALUE BigDecimal_uplus(VALUE self) { return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#-@;F;[;[[@yiF;T;;9;0;[;{;IC;"AReturn the negation of self. -BigDecimal('5') #=> -0.5e1 ;T;[o;= ;3I" overload;F;40;;;50;)I"-big_decimal;T;IC;";T; @ƒI;>0;!F;[;[;I";T;0;6i;[; @ƒI;[;I"ZReturn the negation of self. -BigDecimal('5') #=> -0.5e1 @overload -big_decimal;T;0; @ƒI;!F;"o;#;$T;%i=;&iB;'@F;(I"ãstatic VALUE BigDecimal_neg(VALUE self) { ENTER(5); Real *c, *a; GUARD_OBJ(a, GetVpValue(self, 1)); GUARD_OBJ(c, VpCreateRbObject(a->Prec *(VpBaseFig() + 1), "0")); VpAsgn(c, a, -1); return ToValue(c); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#*;F;[[I"r;T0;[[@yi`;T;;';0;[;{;IC;"call-seq: mult(value, digits) Multiply by the specified value. e.g. c = a.mult(b,n) c = a * b digits:: If specified and less than the number of significant digits of the result, the result is rounded to that number of digits, according to BigDecimal.mode. ;T;[;[;@ßH;0; @™I;!F;"o;#;$T;%iQ;&i];'@F;(I"3static VALUE BigDecimal_mult(VALUE self, VALUE r) { ENTER(5); Real *c, *a, *b; size_t mx; GUARD_OBJ(a, GetVpValue(self, 1)); if (RB_TYPE_P(r, T_FLOAT)) { b = GetVpValueWithPrec(r, DBLE_FIG, 1); } else if (RB_TYPE_P(r, T_RATIONAL)) { b = GetVpValueWithPrec(r, a->Prec*VpBaseFig(), 1); } else { b = GetVpValue(r,0); } if (!b) return DoSomeOne(self, r, '*'); SAVE(b); mx = a->Prec + b->Prec; GUARD_OBJ(c, VpCreateRbObject(mx *(VpBaseFig() + 1), "0")); VpMult(c, a, b); return ToValue(c); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#/;F;[;[[@yi¥;T;;:;0;[;{;IC;")For c = self/r: with round operation ;T;[;[;I")For c = self/r: with round operation;T;0; @¨I;!F;"o;#;$T;%i§;&i§;'@F;(I"astatic VALUE BigDecimal_div(VALUE self, VALUE r) /* For c = self/r: with round operation */ { ENTER(5); Real *c=NULL, *res=NULL, *div = NULL; r = BigDecimal_divide(&c, &res, &div, self, r); if (!NIL_P(r)) return r; /* coerced by other */ SAVE(c); SAVE(res); SAVE(div); /* a/b = c + r/b */ /* c xxxxx r 00000yyyyy ==> (y/b)*BASE >= HALF_BASE */ /* Round */ if (VpHasVal(div)) { /* frac[0] must be zero for NaN,INF,Zero */ VpInternalRound(c, 0, c->frac[c->Prec-1], (BDIGIT)(VpBaseVal() * (BDIGIT_DBL)res->frac[0] / div->frac[0])); } return ToValue(c); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#quo;F;[;[[@yi¥;T;;;;0;[;{;IC;")For c = self/r: with round operation ;T;[;[;@²I;0; @¶I;!F;"o;#;$T;%i§;&i§;'@F;(I"astatic VALUE BigDecimal_div(VALUE self, VALUE r) /* For c = self/r: with round operation */ { ENTER(5); Real *c=NULL, *res=NULL, *div = NULL; r = BigDecimal_divide(&c, &res, &div, self, r); if (!NIL_P(r)) return r; /* coerced by other */ SAVE(c); SAVE(res); SAVE(div); /* a/b = c + r/b */ /* c xxxxx r 00000yyyyy ==> (y/b)*BASE >= HALF_BASE */ /* Round */ if (VpHasVal(div)) { /* frac[0] must be zero for NaN,INF,Zero */ VpInternalRound(c, 0, c->frac[c->Prec-1], (BDIGIT)(VpBaseVal() * (BDIGIT_DBL)res->frac[0] / div->frac[0])); } return ToValue(c); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#%;F;[;[[@yi;T;;Û;0;[;{;IC;"&%: a%b = a - (a.to_f/b).floor * b ;T;[;[;I"&%: a%b = a - (a.to_f/b).floor * b;T;0; @ÃI;!F;"o;#;$T;%i;&i;'@F;(I"static VALUE BigDecimal_mod(VALUE self, VALUE r) /* %: a%b = a - (a.to_f/b).floor * b */ { ENTER(3); Real *div = NULL, *mod = NULL; if (BigDecimal_DoDivmod(self, r, &div, &mod)) { SAVE(div); SAVE(mod); return ToValue(mod); } return DoSomeOne(self, r, '%'); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#modulo;F;[;[[@yi;T;;Z;0;[;{;IC;"&%: a%b = a - (a.to_f/b).floor * b ;T;[;[;@ÍI;0; @ÑI;!F;"o;#;$T;%i;&i;'@F;(I"static VALUE BigDecimal_mod(VALUE self, VALUE r) /* %: a%b = a - (a.to_f/b).floor * b */ { ENTER(3); Real *div = NULL, *mod = NULL; if (BigDecimal_DoDivmod(self, r, &div, &mod)) { SAVE(div); SAVE(mod); return ToValue(mod); } return DoSomeOne(self, r, '%'); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#remainder;F;[;[[@yiW;T;;[;0;[;{;IC;"remainder ;T;[;[;I"remainder;T;0; @ÞI;!F;"o;#;$T;%iX;&iX;'@F;(I"Ôstatic VALUE BigDecimal_remainder(VALUE self, VALUE r) /* remainder */ { VALUE f; Real *d, *rv = 0; f = BigDecimal_divremain(self, r, &d, &rv); if (!NIL_P(f)) return f; return ToValue(rv); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#divmod;F;[[I"r;T0;[[@yiw;T;;Y;0;[;{;IC;"divmod(value) Divides by the specified value, and returns the quotient and modulus as BigDecimal numbers. The quotient is rounded towards negative infinity. For example: require 'bigdecimal' a = BigDecimal("42") b = BigDecimal("9") q, m = a.divmod(b) c = q * b + m a == c #=> true The quotient q is (a/b).floor, and the modulus is the amount that must be added to q * b to get a. ;T;[;[;I"’divmod(value) Divides by the specified value, and returns the quotient and modulus as BigDecimal numbers. The quotient is rounded towards negative infinity. For example: require 'bigdecimal' a = BigDecimal("42") b = BigDecimal("9") q, m = a.divmod(b) c = q * b + m a == c #=> true The quotient q is (a/b).floor, and the modulus is the amount that must be added to q * b to get a. ;T;0; @ìI;!F;"o;#;$T;%ia;&iv;'@F;(I"static VALUE BigDecimal_divmod(VALUE self, VALUE r) { ENTER(5); Real *div = NULL, *mod = NULL; if (BigDecimal_DoDivmod(self, r, &div, &mod)) { SAVE(div); SAVE(mod); return rb_assoc_new(ToValue(div), ToValue(mod)); } return DoSomeOne(self,r,rb_intern("divmod")); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#clone;F;[;[[@yiŠ ;T;;U;0;[;{;IC;";T;[;[;@|;0; @üI;'@F;(I"Astatic VALUE BigDecimal_clone(VALUE self) { return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#dup;F;[;[[@yiŠ ;T;;e;0;[;{;IC;";T;[;[;@|;0; @J;'@F;(I"Astatic VALUE BigDecimal_clone(VALUE self) { return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#to_f;F;[;[[@yi‰;T;;O;0;[;{;IC;"¥Returns a new Float object having approximately the same value as the BigDecimal number. Normal accuracy limits and built-in errors of binary Float arithmetic apply. ;T;[;[;I"¦Returns a new Float object having approximately the same value as the BigDecimal number. Normal accuracy limits and built-in errors of binary Float arithmetic apply. ;T;0; @J;!F;"o;#;$T;%i…;&iˆ;'@F;(I"'static VALUE BigDecimal_to_f(VALUE self) { ENTER(1); Real *p; double d; SIGNED_VALUE e; char *buf; volatile VALUE str; GUARD_OBJ(p, GetVpValue(self, 1)); if (VpVtoD(&d, &e, p) != 1) return rb_float_new(d); if (e > (SIGNED_VALUE)(DBL_MAX_10_EXP+BASE_FIG)) goto overflow; if (e < (SIGNED_VALUE)(DBL_MIN_10_EXP-BASE_FIG)) goto underflow; str = rb_str_new(0, VpNumOfChars(p, "E")); buf = RSTRING_PTR(str); VpToString(p, buf, 0, 0); errno = 0; d = strtod(buf, 0); if (errno == ERANGE) { if (d == 0.0) goto underflow; if (fabs(d) >= HUGE_VAL) goto overflow; } return rb_float_new(d); overflow: VpException(VP_EXCEPTION_OVERFLOW, "BigDecimal to Float conversion", 0); if (BIGDECIMAL_NEGATIVE_P(p)) return rb_float_new(VpGetDoubleNegInf()); else return rb_float_new(VpGetDoublePosInf()); underflow: VpException(VP_EXCEPTION_UNDERFLOW, "BigDecimal to Float conversion", 0); if (BIGDECIMAL_NEGATIVE_P(p)) return rb_float_new(-0.0); else return rb_float_new(0.0); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#abs;F;[;[[@yi";T;;?;0;[;{;IC;"vReturns the absolute value, as a BigDecimal. BigDecimal('5').abs #=> 0.5e1 BigDecimal('-3').abs #=> 0.3e1 ;T;[o;= ;3I" overload;F;40;;?;50;)I"abs;T;IC;";T; @"J;>0;!F;[;[;I";T;0;6i;[; @"J;[;I"Returns the absolute value, as a BigDecimal. BigDecimal('5').abs #=> 0.5e1 BigDecimal('-3').abs #=> 0.3e1 @overload abs;T;0; @"J;!F;"o;#;$T;%i;&i;'@F;(I"static VALUE BigDecimal_abs(VALUE self) { ENTER(5); Real *c, *a; size_t mx; GUARD_OBJ(a, GetVpValue(self, 1)); mx = a->Prec *(VpBaseFig() + 1); GUARD_OBJ(c, VpCreateRbObject(mx, "0")); VpAsgn(c, a, 1); VpChangeSign(c, 1); return ToValue(c); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#sqrt;F;[[I" nFig;T0;[[@yi8;T;;>;0;[;{;IC;"^sqrt(n) Returns the square root of the value. Result has at least n significant digits. ;T;[;[;I"`sqrt(n) Returns the square root of the value. Result has at least n significant digits. ;T;0; @8J;!F;"o;#;$T;%i1;&i7;'@F;(I"^static VALUE BigDecimal_sqrt(VALUE self, VALUE nFig) { ENTER(5); Real *c, *a; size_t mx, n; GUARD_OBJ(a, GetVpValue(self, 1)); mx = a->Prec * (VpBaseFig() + 1); n = GetPrecisionInt(nFig) + VpDblFig() + BASE_FIG; if (mx <= n) mx = n; GUARD_OBJ(c, VpCreateRbObject(mx, "0")); VpSqrt(c, a); return ToValue(c); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#fix;F;[;[[@yiK;T;:fix;0;[;{;IC;"Prec *(VpBaseFig() + 1); GUARD_OBJ(c, VpCreateRbObject(mx, "0")); VpActiveRound(c, a, VP_ROUND_DOWN, 0); /* 0: round off */ return ToValue(c); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#round;F;[[@c0;[[@yir;T;;b;0;[;{;IC;"+round(n, mode) Round to the nearest integer (by default), returning the result as a BigDecimal if n is specified, or as an Integer if it isn't. BigDecimal('3.14159').round #=> 3 BigDecimal('8.7').round #=> 9 BigDecimal('-9.9').round #=> -10 BigDecimal('3.14159').round(2).class.name #=> "BigDecimal" BigDecimal('3.14159').round.class.name #=> "Integer" If n is specified and positive, the fractional part of the result has no more than that many digits. If n is specified and negative, at least that many digits to the left of the decimal point will be 0 in the result, and return value will be an Integer. BigDecimal('3.14159').round(3) #=> 3.142 BigDecimal('13345.234').round(-2) #=> 13300 The value of the optional mode argument can be used to determine how rounding is performed; see BigDecimal.mode. ;T;[;[;I"-round(n, mode) Round to the nearest integer (by default), returning the result as a BigDecimal if n is specified, or as an Integer if it isn't. BigDecimal('3.14159').round #=> 3 BigDecimal('8.7').round #=> 9 BigDecimal('-9.9').round #=> -10 BigDecimal('3.14159').round(2).class.name #=> "BigDecimal" BigDecimal('3.14159').round.class.name #=> "Integer" If n is specified and positive, the fractional part of the result has no more than that many digits. If n is specified and negative, at least that many digits to the left of the decimal point will be 0 in the result, and return value will be an Integer. BigDecimal('3.14159').round(3) #=> 3.142 BigDecimal('13345.234').round(-2) #=> 13300 The value of the optional mode argument can be used to determine how rounding is performed; see BigDecimal.mode. ;T;0; @VJ;!F;"o;#;$T;%iY;&iq;'@F;(I",static VALUE BigDecimal_round(int argc, VALUE *argv, VALUE self) { ENTER(5); Real *c, *a; int iLoc = 0; VALUE vLoc; VALUE vRound; int round_to_int = 0; size_t mx, pl; unsigned short sw = VpGetRoundMode(); switch (rb_scan_args(argc, argv, "02", &vLoc, &vRound)) { case 0: iLoc = 0; round_to_int = 1; break; case 1: if (RB_TYPE_P(vLoc, T_HASH)) { sw = check_rounding_mode_option(vLoc); } else { iLoc = NUM2INT(vLoc); if (iLoc < 1) round_to_int = 1; } break; case 2: iLoc = NUM2INT(vLoc); if (RB_TYPE_P(vRound, T_HASH)) { sw = check_rounding_mode_option(vRound); } else { sw = check_rounding_mode(vRound); } break; default: break; } pl = VpSetPrecLimit(0); GUARD_OBJ(a, GetVpValue(self, 1)); mx = a->Prec * (VpBaseFig() + 1); GUARD_OBJ(c, VpCreateRbObject(mx, "0")); VpSetPrecLimit(pl); VpActiveRound(c, a, sw, iLoc); if (round_to_int) { return BigDecimal_to_i(ToValue(c)); } return ToValue(c); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#frac;F;[;[[@yiÖ;T;: frac;0;[;{;IC;"?Return the fractional part of the number, as a BigDecimal. ;T;[;[;I"@Return the fractional part of the number, as a BigDecimal. ;T;0; @eJ;!F;"o;#;$T;%iÔ;&iÕ;'@F;(I"þstatic VALUE BigDecimal_frac(VALUE self) { ENTER(5); Real *c, *a; size_t mx; GUARD_OBJ(a, GetVpValue(self, 1)); mx = a->Prec * (VpBaseFig() + 1); GUARD_OBJ(c, VpCreateRbObject(mx, "0")); VpFrac(c, a); return ToValue(c); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#floor;F;[[@c0;[[@yiõ;T;;`;0;[;{;IC;"Ífloor(n) Return the largest integer less than or equal to the value, as a BigDecimal. BigDecimal('3.14159').floor #=> 3 BigDecimal('-9.1').floor #=> -10 If n is specified and positive, the fractional part of the result has no more than that many digits. If n is specified and negative, at least that many digits to the left of the decimal point will be 0 in the result. BigDecimal('3.14159').floor(3) #=> 3.141 BigDecimal('13345.234').floor(-2) #=> 13300.0 ;T;[;[;I"Ïfloor(n) Return the largest integer less than or equal to the value, as a BigDecimal. BigDecimal('3.14159').floor #=> 3 BigDecimal('-9.1').floor #=> -10 If n is specified and positive, the fractional part of the result has no more than that many digits. If n is specified and negative, at least that many digits to the left of the decimal point will be 0 in the result. BigDecimal('3.14159').floor(3) #=> 3.141 BigDecimal('13345.234').floor(-2) #=> 13300.0 ;T;0; @sJ;!F;"o;#;$T;%iä;&iô;'@F;(I"ustatic VALUE BigDecimal_floor(int argc, VALUE *argv, VALUE self) { ENTER(5); Real *c, *a; int iLoc; VALUE vLoc; size_t mx, pl = VpSetPrecLimit(0); if (rb_scan_args(argc, argv, "01", &vLoc)==0) { iLoc = 0; } else { iLoc = NUM2INT(vLoc); } GUARD_OBJ(a, GetVpValue(self, 1)); mx = a->Prec * (VpBaseFig() + 1); GUARD_OBJ(c, VpCreateRbObject(mx, "0")); VpSetPrecLimit(pl); VpActiveRound(c, a, VP_ROUND_FLOOR, iLoc); #ifdef BIGDECIMAL_DEBUG VPrint(stderr, "floor: c=%\n", c); #endif if (argc == 0) { return BigDecimal_to_i(ToValue(c)); } return ToValue(c); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#ceil;F;[[@c0;[[@yi$;T;;a;0;[;{;IC;"Ëceil(n) Return the smallest integer greater than or equal to the value, as a BigDecimal. BigDecimal('3.14159').ceil #=> 4 BigDecimal('-9.1').ceil #=> -9 If n is specified and positive, the fractional part of the result has no more than that many digits. If n is specified and negative, at least that many digits to the left of the decimal point will be 0 in the result. BigDecimal('3.14159').ceil(3) #=> 3.142 BigDecimal('13345.234').ceil(-2) #=> 13400.0 ;T;[;[;I"Íceil(n) Return the smallest integer greater than or equal to the value, as a BigDecimal. BigDecimal('3.14159').ceil #=> 4 BigDecimal('-9.1').ceil #=> -9 If n is specified and positive, the fractional part of the result has no more than that many digits. If n is specified and negative, at least that many digits to the left of the decimal point will be 0 in the result. BigDecimal('3.14159').ceil(3) #=> 3.142 BigDecimal('13345.234').ceil(-2) #=> 13400.0 ;T;0; @‚J;!F;"o;#;$T;%i;&i#;'@F;(I"+static VALUE BigDecimal_ceil(int argc, VALUE *argv, VALUE self) { ENTER(5); Real *c, *a; int iLoc; VALUE vLoc; size_t mx, pl = VpSetPrecLimit(0); if (rb_scan_args(argc, argv, "01", &vLoc) == 0) { iLoc = 0; } else { iLoc = NUM2INT(vLoc); } GUARD_OBJ(a, GetVpValue(self, 1)); mx = a->Prec * (VpBaseFig() + 1); GUARD_OBJ(c, VpCreateRbObject(mx, "0")); VpSetPrecLimit(pl); VpActiveRound(c, a, VP_ROUND_CEIL, iLoc); if (argc == 0) { return BigDecimal_to_i(ToValue(c)); } return ToValue(c); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#power;F;[[@c0;[[@yi~ ;T;: power;0;[;{;IC;"‰power(n) power(n, prec) Returns the value raised to the power of n. Note that n must be an Integer. Also available as the operator **. ;T;[;[;I"‹power(n) power(n, prec) Returns the value raised to the power of n. Note that n must be an Integer. Also available as the operator **. ;T;0; @‘J;!F;"o;#;$T;%it ;&i} ;'@F;(I"Ãstatic VALUE BigDecimal_power(int argc, VALUE*argv, VALUE self) { ENTER(5); VALUE vexp, prec; Real* exp = NULL; Real *x, *y; ssize_t mp, ma, n; SIGNED_VALUE int_exp; double d; rb_scan_args(argc, argv, "11", &vexp, &prec); GUARD_OBJ(x, GetVpValue(self, 1)); n = NIL_P(prec) ? (ssize_t)(x->Prec*VpBaseFig()) : NUM2SSIZET(prec); if (VpIsNaN(x)) { y = VpCreateRbObject(n, "0"); RB_GC_GUARD(y->obj); VpSetNaN(y); return ToValue(y); } retry: switch (TYPE(vexp)) { case T_FIXNUM: break; case T_BIGNUM: break; case T_FLOAT: d = RFLOAT_VALUE(vexp); if (d == round(d)) { if (FIXABLE(d)) { vexp = LONG2FIX((long)d); } else { vexp = rb_dbl2big(d); } goto retry; } if (NIL_P(prec)) { n += DBLE_FIG; } exp = GetVpValueWithPrec(vexp, DBLE_FIG, 1); break; case T_RATIONAL: if (is_zero(rb_rational_num(vexp))) { if (is_positive(vexp)) { vexp = INT2FIX(0); goto retry; } } else if (is_one(rb_rational_den(vexp))) { vexp = rb_rational_num(vexp); goto retry; } exp = GetVpValueWithPrec(vexp, n, 1); if (NIL_P(prec)) { n += n; } break; case T_DATA: if (is_kind_of_BigDecimal(vexp)) { VALUE zero = INT2FIX(0); VALUE rounded = BigDecimal_round(1, &zero, vexp); if (RTEST(BigDecimal_eq(vexp, rounded))) { vexp = BigDecimal_to_i(vexp); goto retry; } if (NIL_P(prec)) { GUARD_OBJ(y, GetVpValue(vexp, 1)); n += y->Prec*VpBaseFig(); } exp = DATA_PTR(vexp); break; } /* fall through */ default: rb_raise(rb_eTypeError, "wrong argument type %"PRIsVALUE" (expected scalar Numeric)", RB_OBJ_CLASSNAME(vexp)); } if (VpIsZero(x)) { if (is_negative(vexp)) { y = VpCreateRbObject(n, "#0"); RB_GC_GUARD(y->obj); if (BIGDECIMAL_NEGATIVE_P(x)) { if (is_integer(vexp)) { if (is_even(vexp)) { /* (-0) ** (-even_integer) -> Infinity */ VpSetPosInf(y); } else { /* (-0) ** (-odd_integer) -> -Infinity */ VpSetNegInf(y); } } else { /* (-0) ** (-non_integer) -> Infinity */ VpSetPosInf(y); } } else { /* (+0) ** (-num) -> Infinity */ VpSetPosInf(y); } return ToValue(y); } else if (is_zero(vexp)) { return ToValue(VpCreateRbObject(n, "1")); } else { return ToValue(VpCreateRbObject(n, "0")); } } if (is_zero(vexp)) { return ToValue(VpCreateRbObject(n, "1")); } else if (is_one(vexp)) { return self; } if (VpIsInf(x)) { if (is_negative(vexp)) { if (BIGDECIMAL_NEGATIVE_P(x)) { if (is_integer(vexp)) { if (is_even(vexp)) { /* (-Infinity) ** (-even_integer) -> +0 */ return ToValue(VpCreateRbObject(n, "0")); } else { /* (-Infinity) ** (-odd_integer) -> -0 */ return ToValue(VpCreateRbObject(n, "-0")); } } else { /* (-Infinity) ** (-non_integer) -> -0 */ return ToValue(VpCreateRbObject(n, "-0")); } } else { return ToValue(VpCreateRbObject(n, "0")); } } else { y = VpCreateRbObject(n, "0"); if (BIGDECIMAL_NEGATIVE_P(x)) { if (is_integer(vexp)) { if (is_even(vexp)) { VpSetPosInf(y); } else { VpSetNegInf(y); } } else { /* TODO: support complex */ rb_raise(rb_eMathDomainError, "a non-integral exponent for a negative base"); } } else { VpSetPosInf(y); } return ToValue(y); } } if (exp != NULL) { return rmpd_power_by_big_decimal(x, exp, n); } else if (RB_TYPE_P(vexp, T_BIGNUM)) { VALUE abs_value = BigDecimal_abs(self); if (is_one(abs_value)) { return ToValue(VpCreateRbObject(n, "1")); } else if (RTEST(rb_funcall(abs_value, '<', 1, INT2FIX(1)))) { if (is_negative(vexp)) { y = VpCreateRbObject(n, "0"); if (is_even(vexp)) { VpSetInf(y, VpGetSign(x)); } else { VpSetInf(y, -VpGetSign(x)); } return ToValue(y); } else if (BIGDECIMAL_NEGATIVE_P(x) && is_even(vexp)) { return ToValue(VpCreateRbObject(n, "-0")); } else { return ToValue(VpCreateRbObject(n, "0")); } } else { if (is_positive(vexp)) { y = VpCreateRbObject(n, "0"); if (is_even(vexp)) { VpSetInf(y, VpGetSign(x)); } else { VpSetInf(y, -VpGetSign(x)); } return ToValue(y); } else if (BIGDECIMAL_NEGATIVE_P(x) && is_even(vexp)) { return ToValue(VpCreateRbObject(n, "-0")); } else { return ToValue(VpCreateRbObject(n, "0")); } } } int_exp = FIX2LONG(vexp); ma = int_exp; if (ma < 0) ma = -ma; if (ma == 0) ma = 1; if (VpIsDef(x)) { mp = x->Prec * (VpBaseFig() + 1); GUARD_OBJ(y, VpCreateRbObject(mp * (ma + 1), "0")); } else { GUARD_OBJ(y, VpCreateRbObject(1, "0")); } VpPower(y, x, int_exp); if (!NIL_P(prec) && VpIsDef(y)) { VpMidRound(y, VpGetRoundMode(), n); } return ToValue(y); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#**;F;[[I"exp;T0;[[@yit ;T;;=;0;[;{;IC;"GReturns the value raised to the power of n. See BigDecimal#power. ;T;[o;= ;3I" overload;F;40;;=;50;)I" **(n);T;IC;";T; @ J;>0;!F;[;[;I";T;0;6i;[[I"n;T0; @ J;[;I"YReturns the value raised to the power of n. See BigDecimal#power. @overload **(n);T;0; @ J;!F;"o;#;$T;%im ;&ir ;'@F;(I"lstatic VALUE BigDecimal_power_op(VALUE self, VALUE exp) { return BigDecimal_power(1, &exp, self); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#<=>;F;[[I"r;T0;[[@yió;T;;c;0;[;{;IC;"NThe comparison operator. a <=> b is 0 if a == b, 1 if a > b, -1 if a < b. ;T;[;[;I"OThe comparison operator. a <=> b is 0 if a == b, 1 if a > b, -1 if a < b. ;T;0; @ºJ;!F;"o;#;$T;%ið;&iò;'@F;(I"bstatic VALUE BigDecimal_comp(VALUE self, VALUE r) { return BigDecimalCmp(self, r, '*'); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#==;F;[[I"r;T0;[[@yi;T;;`;0;[;{;IC;"òTests for value equality; returns true if the values are equal. The == and === operators and the eql? method have the same implementation for BigDecimal. Values may be coerced to perform the comparison: BigDecimal('1.0') == 1.0 #=> true ;T;[;[;I"óTests for value equality; returns true if the values are equal. The == and === operators and the eql? method have the same implementation for BigDecimal. Values may be coerced to perform the comparison: BigDecimal('1.0') == 1.0 #=> true ;T;0; @ÊJ;!F;"o;#;$T;%iù;&i;'@F;(I"`static VALUE BigDecimal_eq(VALUE self, VALUE r) { return BigDecimalCmp(self, r, '='); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#===;F;[[I"r;T0;[[@yi;T;;\;0;[;{;IC;"òTests for value equality; returns true if the values are equal. The == and === operators and the eql? method have the same implementation for BigDecimal. Values may be coerced to perform the comparison: BigDecimal('1.0') == 1.0 #=> true ;T;[;[;@ÖJ;0; @ÚJ;!F;"o;#;$T;%iù;&i;'@F;(I"`static VALUE BigDecimal_eq(VALUE self, VALUE r) { return BigDecimalCmp(self, r, '='); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#eql?;F;[[I"r;T0;[[@yi;T;;_;0;[;{;IC;"òTests for value equality; returns true if the values are equal. The == and === operators and the eql? method have the same implementation for BigDecimal. Values may be coerced to perform the comparison: BigDecimal('1.0') == 1.0 #=> true;T;[o;2 ;3I"return;F;4@|;0;5[@~; @éJ;[;@ÖJ;0; @éJ;!F;"o;#;$T;%iù;&i;6i;'@F;(I"`static VALUE BigDecimal_eq(VALUE self, VALUE r) { return BigDecimalCmp(self, r, '='); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#<;F;[[I"r;T0;[[@yi;T;;;0;[;{;IC;"{a < b Returns true if a is less than b. Values may be coerced to perform the comparison (see ==, BigDecimal#coerce). ;T;[;[;I"}a < b Returns true if a is less than b. Values may be coerced to perform the comparison (see ==, BigDecimal#coerce). ;T;0; @ûJ;!F;"o;#;$T;%i ;&i;'@F;(I"`static VALUE BigDecimal_lt(VALUE self, VALUE r) { return BigDecimalCmp(self, r, '<'); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#<=;F;[[I"r;T0;[[@yi;T;;€;0;[;{;IC;"ƒa <= b Returns true if a is less than or equal to b. Values may be coerced to perform the comparison (see ==, BigDecimal#coerce). ;T;[;[;I"…a <= b Returns true if a is less than or equal to b. Values may be coerced to perform the comparison (see ==, BigDecimal#coerce). ;T;0; @K;!F;"o;#;$T;%i;&i;'@F;(I"`static VALUE BigDecimal_le(VALUE self, VALUE r) { return BigDecimalCmp(self, r, 'L'); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#>;F;[[I"r;T0;[[@yi*;T;;;0;[;{;IC;"~a > b Returns true if a is greater than b. Values may be coerced to perform the comparison (see ==, BigDecimal#coerce). ;T;[;[;I"{a > b Returns true if a is greater than b. Values may be coerced to perform the comparison (see ==, BigDecimal#coerce). ;T;0; @K;!F;"o;#;$T;%i#;&i);'@F;(I"`static VALUE BigDecimal_gt(VALUE self, VALUE r) { return BigDecimalCmp(self, r, '>'); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#>=;F;[[I"r;T0;[[@yi7;T;;‚;0;[;{;IC;"…a >= b Returns true if a is greater than or equal to b. Values may be coerced to perform the comparison (see ==, BigDecimal#coerce) ;T;[;[;I"‡a >= b Returns true if a is greater than or equal to b. Values may be coerced to perform the comparison (see ==, BigDecimal#coerce) ;T;0; @+K;!F;"o;#;$T;%i0;&i6;'@F;(I"`static VALUE BigDecimal_ge(VALUE self, VALUE r) { return BigDecimalCmp(self, r, 'G'); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#zero?;F;[;[[@yiá;T;;^;0;[;{;IC;"'Returns True if the value is zero.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @;K;[;I"'Returns True if the value is zero.;T;0; @;K;!F;"o;#;$T;%ià;&ià;6i;'@F;(I"}static VALUE BigDecimal_zero(VALUE self) { Real *a = GetVpValue(self, 1); return VpIsZero(a) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#nonzero?;F;[;[[@yié;T;;_;0;[;{;IC;":Returns self if the value is non-zero, nil otherwise.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @LK;[;I":Returns self if the value is non-zero, nil otherwise.;T;0; @LK;!F;"o;#;$T;%iè;&iè;6i;'@F;(I"}static VALUE BigDecimal_nonzero(VALUE self) { Real *a = GetVpValue(self, 1); return VpIsZero(a) ? Qnil : self; };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#coerce;F;[[I" other;T0;[[@yiæ;T;;>;0;[;{;IC;"ÉThe coerce method provides support for Ruby type coercion. It is not enabled by default. This means that binary operations like + * / or - can often be performed on a BigDecimal and an object of another type, if the other object can be coerced into a BigDecimal value. e.g. a = BigDecimal("1.0") b = a / 2.0 #=> 0.5 Note that coercing a String to a BigDecimal is not supported by default; it requires a special compile-time option when building Ruby. ;T;[;[;I"ÊThe coerce method provides support for Ruby type coercion. It is not enabled by default. This means that binary operations like + * / or - can often be performed on a BigDecimal and an object of another type, if the other object can be coerced into a BigDecimal value. e.g. a = BigDecimal("1.0") b = a / 2.0 #=> 0.5 Note that coercing a String to a BigDecimal is not supported by default; it requires a special compile-time option when building Ruby. ;T;0; @]K;!F;"o;#;$T;%iØ;&iå;'@F;(I"÷static VALUE BigDecimal_coerce(VALUE self, VALUE other) { ENTER(2); VALUE obj; Real *b; if (RB_TYPE_P(other, T_FLOAT)) { GUARD_OBJ(b, GetVpValueWithPrec(other, DBLE_FIG, 1)); obj = rb_assoc_new(ToValue(b), self); } else { if (RB_TYPE_P(other, T_RATIONAL)) { Real* pv = DATA_PTR(self); GUARD_OBJ(b, GetVpValueWithPrec(other, pv->Prec*VpBaseFig(), 1)); } else { GUARD_OBJ(b, GetVpValue(other, 1)); } obj = rb_assoc_new(b->obj, self); } return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#inspect;F;[;[[@yiï;T;;r;0;[;{;IC;"gReturns a string representation of self. BigDecimal("1234.5678").inspect #=> "0.12345678e4" ;T;[;[;I"hReturns a string representation of self. BigDecimal("1234.5678").inspect #=> "0.12345678e4" ;T;0; @mK;!F;"o;#;$T;%iê;&iî;'@F;(I"Gstatic VALUE BigDecimal_inspect(VALUE self) { ENTER(5); Real *vp; volatile VALUE str; size_t nc; GUARD_OBJ(vp, GetVpValue(self, 1)); nc = VpNumOfChars(vp, "E"); str = rb_str_new(0, nc); VpToString(vp, RSTRING_PTR(str), 0, 0); rb_str_resize(str, strlen(RSTRING_PTR(str))); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#exponent;F;[;[[@yiã;T;: exponent;0;[;{;IC;"ÃReturns the exponent of the BigDecimal number, as an Integer. If the number can be represented as 0.xxxxxx*10**n where xxxxxx is a string of digits with no leading zeros, then n is the exponent. ;T;[;[;I"ÄReturns the exponent of the BigDecimal number, as an Integer. If the number can be represented as 0.xxxxxx*10**n where xxxxxx is a string of digits with no leading zeros, then n is the exponent. ;T;0; @{K;!F;"o;#;$T;%iÞ;&iâ;'@F;(I"}static VALUE BigDecimal_exponent(VALUE self) { ssize_t e = VpExponent10(GetVpValue(self, 1)); return SSIZET2NUM(e); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#sign;F;[;[[@yiˆ;T;;Ä;0;[;{;IC;"'Returns the sign of the value. Returns a positive value if > 0, a negative value if < 0, and a zero if == 0. The specific value returned indicates the type and sign of the BigDecimal, as follows: BigDecimal::SIGN_NaN:: value is Not a Number BigDecimal::SIGN_POSITIVE_ZERO:: value is +0 BigDecimal::SIGN_NEGATIVE_ZERO:: value is -0 BigDecimal::SIGN_POSITIVE_INFINITE:: value is +Infinity BigDecimal::SIGN_NEGATIVE_INFINITE:: value is -Infinity BigDecimal::SIGN_POSITIVE_FINITE:: value is positive BigDecimal::SIGN_NEGATIVE_FINITE:: value is negative ;T;[;[;I"(Returns the sign of the value. Returns a positive value if > 0, a negative value if < 0, and a zero if == 0. The specific value returned indicates the type and sign of the BigDecimal, as follows: BigDecimal::SIGN_NaN:: value is Not a Number BigDecimal::SIGN_POSITIVE_ZERO:: value is +0 BigDecimal::SIGN_NEGATIVE_ZERO:: value is -0 BigDecimal::SIGN_POSITIVE_INFINITE:: value is +Infinity BigDecimal::SIGN_NEGATIVE_INFINITE:: value is -Infinity BigDecimal::SIGN_POSITIVE_FINITE:: value is positive BigDecimal::SIGN_NEGATIVE_FINITE:: value is negative ;T;0; @‰K;!F;"o;#;$T;%ix;&i‡;'@F;(I"zstatic VALUE BigDecimal_sign(VALUE self) { /* sign */ int s = GetVpValue(self, 1)->sign; return INT2FIX(s); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#nan?;F;[;[[@yi(;T;;Í;0;[;{;IC;"/Returns True if the value is Not a Number.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @—K;[;I"/Returns True if the value is Not a Number.;T;0; @—K;!F;"o;#;$T;%i';&i';6i;'@F;(I"†static VALUE BigDecimal_IsNaN(VALUE self) { Real *p = GetVpValue(self, 1); if (VpIsNaN(p)) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#infinite?;F;[;[[@yi3;T;;K;0;[;{;IC;"^Returns nil, -1, or +1 depending on whether the value is finite, -Infinity, or +Infinity.;T;[o;2 ;3I"return;F;4@|;0;5[@~; @¨K;[;I"_Returns nil, -1, or +1 depending on whether the value is finite, -Infinity, or +Infinity. ;T;0; @¨K;!F;"o;#;$T;%i0;&i2;6i;'@F;(I"»static VALUE BigDecimal_IsInfinite(VALUE self) { Real *p = GetVpValue(self, 1); if (VpIsPosInf(p)) return INT2FIX(1); if (VpIsNegInf(p)) return INT2FIX(-1); return Qnil; };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#finite?;F;[;[[@yi=;T;;J;0;[;{;IC;"?Returns True if the value is finite (not NaN or infinite).;T;[o;2 ;3I"return;F;4@|;0;5[@~; @¹K;[;I"?Returns True if the value is finite (not NaN or infinite).;T;0; @¹K;!F;"o;#;$T;%i<;&i<;6i;'@F;(I"«static VALUE BigDecimal_IsFinite(VALUE self) { Real *p = GetVpValue(self, 1); if (VpIsNaN(p)) return Qfalse; if (VpIsInf(p)) return Qfalse; return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#truncate;F;[[@c0;[[@yi¹;T;;c;0;[;{;IC;"truncate(n) Truncate to the nearest integer (by default), returning the result as a BigDecimal. BigDecimal('3.14159').truncate #=> 3 BigDecimal('8.7').truncate #=> 8 BigDecimal('-9.9').truncate #=> -9 If n is specified and positive, the fractional part of the result has no more than that many digits. If n is specified and negative, at least that many digits to the left of the decimal point will be 0 in the result. BigDecimal('3.14159').truncate(3) #=> 3.141 BigDecimal('13345.234').truncate(-2) #=> 13300.0 ;T;[;[;I"truncate(n) Truncate to the nearest integer (by default), returning the result as a BigDecimal. BigDecimal('3.14159').truncate #=> 3 BigDecimal('8.7').truncate #=> 8 BigDecimal('-9.9').truncate #=> -9 If n is specified and positive, the fractional part of the result has no more than that many digits. If n is specified and negative, at least that many digits to the left of the decimal point will be 0 in the result. BigDecimal('3.14159').truncate(3) #=> 3.141 BigDecimal('13345.234').truncate(-2) #=> 13300.0 ;T;0; @ÊK;!F;"o;#;$T;%i¦;&i¸;'@F;(I"Estatic VALUE BigDecimal_truncate(int argc, VALUE *argv, VALUE self) { ENTER(5); Real *c, *a; int iLoc; VALUE vLoc; size_t mx, pl = VpSetPrecLimit(0); if (rb_scan_args(argc, argv, "01", &vLoc) == 0) { iLoc = 0; } else { iLoc = NUM2INT(vLoc); } GUARD_OBJ(a, GetVpValue(self, 1)); mx = a->Prec * (VpBaseFig() + 1); GUARD_OBJ(c, VpCreateRbObject(mx, "0")); VpSetPrecLimit(pl); VpActiveRound(c, a, VP_ROUND_DOWN, iLoc); /* 0: truncate */ if (argc == 0) { return BigDecimal_to_i(ToValue(c)); } return ToValue(c); };T;)I"static VALUE;T;*To;;F; ;;;;I"BigDecimal#_dump;F;[[@c0;[[@yi;T;;î;0;[;{;IC;"°Method used to provide marshalling support. inf = BigDecimal('Infinity') #=> Infinity BigDecimal._load(inf._dump) #=> Infinity See the Marshal module. ;T;[o;= ;3I" overload;F;40;;î;50;)I" _dump;T;IC;";T; @ÙK;>0;!F;[;[;I";T;0;6i;[; @ÙK;[;I"ÂMethod used to provide marshalling support. inf = BigDecimal('Infinity') #=> Infinity BigDecimal._load(inf._dump) #=> Infinity See the Marshal module. @overload _dump;T;0; @ÙK;!F;"o;#;$T;%iø;&i;'@F;(I"Üstatic VALUE BigDecimal_dump(int argc, VALUE *argv, VALUE self) { ENTER(5); Real *vp; char *psz; VALUE dummy; volatile VALUE dump; rb_scan_args(argc, argv, "01", &dummy); GUARD_OBJ(vp,GetVpValue(self, 1)); dump = rb_str_new(0, VpNumOfChars(vp, "E")+50); psz = RSTRING_PTR(dump); sprintf(psz, "%"PRIuSIZE":", VpMaxPrec(vp)*VpBaseFig()); VpToString(vp, psz+strlen(psz), 0, 0); rb_str_resize(dump, strlen(psz)); return dump; };T;)I"static VALUE;T;*T;A@F;BIC;[;A@F;CIC;[;A@F;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@yi [@yi ;T;;¶;;K;;;[;{;IC;"ÏBigDecimal provides arbitrary-precision floating point decimal arithmetic. == Introduction Ruby provides built-in support for arbitrary precision integer arithmetic. For example: 42**13 #=> 1265437718438866624512 BigDecimal provides similar support for very large or very accurate floating point numbers. Decimal arithmetic is also useful for general calculation, because it provides the correct answers people expect--whereas normal binary floating point arithmetic often introduces subtle errors because of the conversion between base 10 and base 2. For example, try: sum = 0 10_000.times do sum = sum + 0.0001 end print sum #=> 0.9999999999999062 and contrast with the output from: require 'bigdecimal' sum = BigDecimal("0") 10_000.times do sum = sum + BigDecimal("0.0001") end print sum #=> 0.1E1 Similarly: (BigDecimal("1.2") - BigDecimal("1.0")) == BigDecimal("0.2") #=> true (1.2 - 1.0) == 0.2 #=> false == Special features of accurate decimal arithmetic Because BigDecimal is more accurate than normal binary floating point arithmetic, it requires some special values. === Infinity BigDecimal sometimes needs to return infinity, for example if you divide a value by zero. BigDecimal("1.0") / BigDecimal("0.0") #=> Infinity BigDecimal("-1.0") / BigDecimal("0.0") #=> -Infinity You can represent infinite numbers to BigDecimal using the strings 'Infinity', '+Infinity' and '-Infinity' (case-sensitive) === Not a Number When a computation results in an undefined value, the special value +NaN+ (for 'not a number') is returned. Example: BigDecimal("0.0") / BigDecimal("0.0") #=> NaN You can also create undefined values. NaN is never considered to be the same as any other value, even NaN itself: n = BigDecimal('NaN') n == 0.0 #=> false n == n #=> false === Positive and negative zero If a computation results in a value which is too small to be represented as a BigDecimal within the currently specified limits of precision, zero must be returned. If the value which is too small to be represented is negative, a BigDecimal value of negative zero is returned. BigDecimal("1.0") / BigDecimal("-Infinity") #=> -0.0 If the value is positive, a value of positive zero is returned. BigDecimal("1.0") / BigDecimal("Infinity") #=> 0.0 (See BigDecimal.mode for how to specify limits of precision.) Note that +-0.0+ and +0.0+ are considered to be the same for the purposes of comparison. Note also that in mathematics, there is no particular concept of negative or positive zero; true mathematical zero has no sign. == bigdecimal/util When you require +bigdecimal/util+, the #to_d method will be available on BigDecimal and the native Integer, Float, Rational, and String classes: require 'bigdecimal/util' 42.to_d # => 0.42e2 0.5.to_d # => 0.5e0 (2/3r).to_d(3) # => 0.667e0 "0.5".to_d # => 0.5e0 == License Copyright (C) 2002 by Shigeo Kobayashi . BigDecimal is released under the Ruby and 2-clause BSD licenses. See LICENSE.txt for details. Maintained by mrkn and ruby-core members. Documented by zzak , mathew , and many other contributors.;T;[;[;I"ÐBigDecimal provides arbitrary-precision floating point decimal arithmetic. == Introduction Ruby provides built-in support for arbitrary precision integer arithmetic. For example: 42**13 #=> 1265437718438866624512 BigDecimal provides similar support for very large or very accurate floating point numbers. Decimal arithmetic is also useful for general calculation, because it provides the correct answers people expect--whereas normal binary floating point arithmetic often introduces subtle errors because of the conversion between base 10 and base 2. For example, try: sum = 0 10_000.times do sum = sum + 0.0001 end print sum #=> 0.9999999999999062 and contrast with the output from: require 'bigdecimal' sum = BigDecimal("0") 10_000.times do sum = sum + BigDecimal("0.0001") end print sum #=> 0.1E1 Similarly: (BigDecimal("1.2") - BigDecimal("1.0")) == BigDecimal("0.2") #=> true (1.2 - 1.0) == 0.2 #=> false == Special features of accurate decimal arithmetic Because BigDecimal is more accurate than normal binary floating point arithmetic, it requires some special values. === Infinity BigDecimal sometimes needs to return infinity, for example if you divide a value by zero. BigDecimal("1.0") / BigDecimal("0.0") #=> Infinity BigDecimal("-1.0") / BigDecimal("0.0") #=> -Infinity You can represent infinite numbers to BigDecimal using the strings 'Infinity', '+Infinity' and '-Infinity' (case-sensitive) === Not a Number When a computation results in an undefined value, the special value +NaN+ (for 'not a number') is returned. Example: BigDecimal("0.0") / BigDecimal("0.0") #=> NaN You can also create undefined values. NaN is never considered to be the same as any other value, even NaN itself: n = BigDecimal('NaN') n == 0.0 #=> false n == n #=> false === Positive and negative zero If a computation results in a value which is too small to be represented as a BigDecimal within the currently specified limits of precision, zero must be returned. If the value which is too small to be represented is negative, a BigDecimal value of negative zero is returned. BigDecimal("1.0") / BigDecimal("-Infinity") #=> -0.0 If the value is positive, a value of positive zero is returned. BigDecimal("1.0") / BigDecimal("Infinity") #=> 0.0 (See BigDecimal.mode for how to specify limits of precision.) Note that +-0.0+ and +0.0+ are considered to be the same for the purposes of comparison. Note also that in mathematics, there is no particular concept of negative or positive zero; true mathematical zero has no sign. == bigdecimal/util When you require +bigdecimal/util+, the #to_d method will be available on BigDecimal and the native Integer, Float, Rational, and String classes: require 'bigdecimal/util' 42.to_d # => 0.42e2 0.5.to_d # => 0.5e0 (2/3r).to_d(3) # => 0.667e0 "0.5".to_d # => 0.5e0 == License Copyright (C) 2002 by Shigeo Kobayashi . BigDecimal is released under the Ruby and 2-clause BSD licenses. See LICENSE.txt for details. Maintained by mrkn and ruby-core members. Documented by zzak , mathew , and many other contributors. ;T;0; @F;!F;"o;#;$T;%i ;&i} ;6i;'@;I"BigDecimal;F;S@<o; ;IC;[o;;F; ;F;;;I"BigMath.exp;F;[[I"x;T0[I" vprec;T0;[[@yiè;T;:exp;0;[;{;IC;" BigMath.exp(decimal, numeric) -> BigDecimal Computes the value of e (the base of natural logarithms) raised to the power of +decimal+, to the specified number of digits of precision. If +decimal+ is infinity, returns Infinity. If +decimal+ is NaN, returns NaN. ;T;[;[;I"BigMath.exp(decimal, numeric) -> BigDecimal Computes the value of e (the base of natural logarithms) raised to the power of +decimal+, to the specified number of digits of precision. If +decimal+ is infinity, returns Infinity. If +decimal+ is NaN, returns NaN. ;T;0; @L;!F;"o;#;$T;%iÞ;&iç;'@L;(I"þ static VALUE BigMath_s_exp(VALUE klass, VALUE x, VALUE vprec) { ssize_t prec, n, i; Real* vx = NULL; VALUE one, d, y; int negative = 0; int infinite = 0; int nan = 0; double flo; prec = NUM2SSIZET(vprec); if (prec <= 0) { rb_raise(rb_eArgError, "Zero or negative precision for exp"); } /* TODO: the following switch statement is almost same as one in the * BigDecimalCmp function. */ switch (TYPE(x)) { case T_DATA: if (!is_kind_of_BigDecimal(x)) break; vx = DATA_PTR(x); negative = BIGDECIMAL_NEGATIVE_P(vx); infinite = VpIsPosInf(vx) || VpIsNegInf(vx); nan = VpIsNaN(vx); break; case T_FIXNUM: /* fall through */ case T_BIGNUM: vx = GetVpValue(x, 0); break; case T_FLOAT: flo = RFLOAT_VALUE(x); negative = flo < 0; infinite = isinf(flo); nan = isnan(flo); if (!infinite && !nan) { vx = GetVpValueWithPrec(x, DBLE_FIG, 0); } break; case T_RATIONAL: vx = GetVpValueWithPrec(x, prec, 0); break; default: break; } if (infinite) { if (negative) { return ToValue(GetVpValueWithPrec(INT2FIX(0), prec, 1)); } else { Real* vy; vy = VpCreateRbObject(prec, "#0"); VpSetInf(vy, VP_SIGN_POSITIVE_INFINITE); RB_GC_GUARD(vy->obj); return ToValue(vy); } } else if (nan) { Real* vy; vy = VpCreateRbObject(prec, "#0"); VpSetNaN(vy); RB_GC_GUARD(vy->obj); return ToValue(vy); } else if (vx == NULL) { cannot_be_coerced_into_BigDecimal(rb_eArgError, x); } x = vx->obj; n = prec + rmpd_double_figures(); negative = BIGDECIMAL_NEGATIVE_P(vx); if (negative) { VALUE x_zero = INT2NUM(1); VALUE x_copy = f_BigDecimal(1, &x_zero, klass); x = BigDecimal_initialize_copy(x_copy, x); vx = DATA_PTR(x); VpSetSign(vx, 1); } one = ToValue(VpCreateRbObject(1, "1")); y = one; d = y; i = 1; while (!VpIsZero((Real*)DATA_PTR(d))) { SIGNED_VALUE const ey = VpExponent10(DATA_PTR(y)); SIGNED_VALUE const ed = VpExponent10(DATA_PTR(d)); ssize_t m = n - vabs(ey - ed); rb_thread_check_ints(); if (m <= 0) { break; } else if ((size_t)m < rmpd_double_figures()) { m = rmpd_double_figures(); } d = BigDecimal_mult(d, x); /* d <- d * x */ d = BigDecimal_div2(d, SSIZET2NUM(i), SSIZET2NUM(m)); /* d <- d / i */ y = BigDecimal_add(y, d); /* y <- y + d */ ++i; /* i <- i + 1 */ } if (negative) { return BigDecimal_div2(one, y, vprec); } else { vprec = SSIZET2NUM(prec - VpExponent10(DATA_PTR(y))); return BigDecimal_round(1, &vprec, y); } RB_GC_GUARD(one); RB_GC_GUARD(x); RB_GC_GUARD(y); RB_GC_GUARD(d); };T;)I"static VALUE;T;*To;;F; ;F;;;I"BigMath.log;F;[[I"x;T0[I" vprec;T0;[[@yio;T;;?;0;[;{;IC;",BigMath.log(decimal, numeric) -> BigDecimal Computes the natural logarithm of +decimal+ to the specified number of digits of precision, +numeric+. If +decimal+ is zero or negative, raises Math::DomainError. If +decimal+ is positive infinity, returns Infinity. If +decimal+ is NaN, returns NaN. ;T;[;[;I".BigMath.log(decimal, numeric) -> BigDecimal Computes the natural logarithm of +decimal+ to the specified number of digits of precision, +numeric+. If +decimal+ is zero or negative, raises Math::DomainError. If +decimal+ is positive infinity, returns Infinity. If +decimal+ is NaN, returns NaN. ;T;0; @L;!F;"o;#;$T;%ic;&in;'@L;(I"Ö static VALUE BigMath_s_log(VALUE klass, VALUE x, VALUE vprec) { ssize_t prec, n, i; SIGNED_VALUE expo; Real* vx = NULL; VALUE vn, one, two, w, x2, y, d; int zero = 0; int negative = 0; int infinite = 0; int nan = 0; double flo; long fix; if (!is_integer(vprec)) { rb_raise(rb_eArgError, "precision must be an Integer"); } prec = NUM2SSIZET(vprec); if (prec <= 0) { rb_raise(rb_eArgError, "Zero or negative precision for exp"); } /* TODO: the following switch statement is almost same as one in the * BigDecimalCmp function. */ switch (TYPE(x)) { case T_DATA: if (!is_kind_of_BigDecimal(x)) break; vx = DATA_PTR(x); zero = VpIsZero(vx); negative = BIGDECIMAL_NEGATIVE_P(vx); infinite = VpIsPosInf(vx) || VpIsNegInf(vx); nan = VpIsNaN(vx); break; case T_FIXNUM: fix = FIX2LONG(x); zero = fix == 0; negative = fix < 0; goto get_vp_value; case T_BIGNUM: i = FIX2INT(rb_big_cmp(x, INT2FIX(0))); zero = i == 0; negative = i < 0; get_vp_value: if (zero || negative) break; vx = GetVpValue(x, 0); break; case T_FLOAT: flo = RFLOAT_VALUE(x); zero = flo == 0; negative = flo < 0; infinite = isinf(flo); nan = isnan(flo); if (!zero && !negative && !infinite && !nan) { vx = GetVpValueWithPrec(x, DBLE_FIG, 1); } break; case T_RATIONAL: zero = RRATIONAL_ZERO_P(x); negative = RRATIONAL_NEGATIVE_P(x); if (zero || negative) break; vx = GetVpValueWithPrec(x, prec, 1); break; case T_COMPLEX: rb_raise(rb_eMathDomainError, "Complex argument for BigMath.log"); default: break; } if (infinite && !negative) { Real* vy; vy = VpCreateRbObject(prec, "#0"); RB_GC_GUARD(vy->obj); VpSetInf(vy, VP_SIGN_POSITIVE_INFINITE); return ToValue(vy); } else if (nan) { Real* vy; vy = VpCreateRbObject(prec, "#0"); RB_GC_GUARD(vy->obj); VpSetNaN(vy); return ToValue(vy); } else if (zero || negative) { rb_raise(rb_eMathDomainError, "Zero or negative argument for log"); } else if (vx == NULL) { cannot_be_coerced_into_BigDecimal(rb_eArgError, x); } x = ToValue(vx); RB_GC_GUARD(one) = ToValue(VpCreateRbObject(1, "1")); RB_GC_GUARD(two) = ToValue(VpCreateRbObject(1, "2")); n = prec + rmpd_double_figures(); RB_GC_GUARD(vn) = SSIZET2NUM(n); expo = VpExponent10(vx); if (expo < 0 || expo >= 3) { char buf[DECIMAL_SIZE_OF_BITS(SIZEOF_VALUE * CHAR_BIT) + 4]; snprintf(buf, sizeof(buf), "1E%"PRIdVALUE, -expo); x = BigDecimal_mult2(x, ToValue(VpCreateRbObject(1, buf)), vn); } else { expo = 0; } w = BigDecimal_sub(x, one); x = BigDecimal_div2(w, BigDecimal_add(x, one), vn); RB_GC_GUARD(x2) = BigDecimal_mult2(x, x, vn); RB_GC_GUARD(y) = x; RB_GC_GUARD(d) = y; i = 1; while (!VpIsZero((Real*)DATA_PTR(d))) { SIGNED_VALUE const ey = VpExponent10(DATA_PTR(y)); SIGNED_VALUE const ed = VpExponent10(DATA_PTR(d)); ssize_t m = n - vabs(ey - ed); if (m <= 0) { break; } else if ((size_t)m < rmpd_double_figures()) { m = rmpd_double_figures(); } x = BigDecimal_mult2(x2, x, vn); i += 2; d = BigDecimal_div2(x, SSIZET2NUM(i), SSIZET2NUM(m)); y = BigDecimal_add(y, d); } y = BigDecimal_mult(y, two); if (expo != 0) { VALUE log10, vexpo, dy; log10 = BigMath_s_log(klass, INT2FIX(10), vprec); vexpo = ToValue(GetVpValue(SSIZET2NUM(expo), 1)); dy = BigDecimal_mult(log10, vexpo); y = BigDecimal_add(y, dy); } return y; };T;)I"static VALUE;T;*T;A@L;BIC;[;A@L;CIC;[;A@L;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@yiS;F;:BigMath;;K;;;[;{;IC;";T;[;[;@|;0; @L;6i;'@;I"BigMath;Fo; ;IC;[o;;F; ;;;;I"TrueClass#to_s;F;[;[[@Ìi;T;;q;0;[;{;IC;">The string representation of true is "true". ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @9L;>0;!F;[;[;I";T;0;6i;[; @9L;[;I"OThe string representation of true is "true". @overload to_s;T;0; o;;F; ;;;;I"TrueClass#inspect;F;[;[[@Ìi<;F;;r;;K;[;{;@@L;'@7L;)I"static VALUE;T;(I"Istatic VALUE true_to_s(VALUE obj) { return rb_cTrueClass_to_s; };T;!F;"o;#;$T;%iˆ;&i‹;'@7L;(I"Istatic VALUE true_to_s(VALUE obj) { return rb_cTrueClass_to_s; };T;)@SL;*T@LLo;;F; ;;;;I"TrueClass#&;F;[[I" obj2;T0;[[@Ìiž;T;;”;0;[;{;IC;"{And---Returns false if obj is nil or false, true otherwise. ;T;[o;= ;3I" overload;F;40;;”;50;)I"&(obj);T;IC;";T; @WL;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @WL;[;I"@return [Boolean];T;0;6i;[[I"obj;T0; @WL;[;I"And---Returns false if obj is nil or false, true otherwise. @overload &(obj) @return [Boolean];T;0; @WL;!F;"o;#;$T;%i–;&i›;'@7L;(I"Zstatic VALUE true_and(VALUE obj, VALUE obj2) { return RTEST(obj2)?Qtrue:Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"TrueClass#|;F;[[I" obj2;T0;[[@Ìi´;T;;(;0;[;{;IC;"éOr---Returns true. As obj is an argument to a method call, it is always evaluated; there is no short-circuit evaluation in this case. true | puts("or") true || puts("logical or") produces: or ;T;[o;= ;3I" overload;F;40;;(;50;)I"|(obj);T;IC;";T; @vL;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" true;T; @vL;[;I"@return [true];T;0;6i;[[I"obj;T0; @vL;[;I" Or---Returns true. As obj is an argument to a method call, it is always evaluated; there is no short-circuit evaluation in this case. true | puts("or") true || puts("logical or") produces: or @overload |(obj) @return [true];T;0; @vL;!F;"o;#;$T;%i¤;&i±;'@7L;(I"Fstatic VALUE true_or(VALUE obj, VALUE obj2) { return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"TrueClass#^;F;[[I" obj2;T0;[[@ÌiÄ;T;;i;0;[;{;IC;"Exclusive Or---Returns true if obj is nil or false, false otherwise. ;T;[o;= ;3I" overload;F;40;;i;50;)I"^(obj);T;IC;";T; @•L;>0;!F;[;[;I";T;0;6i;[[I"obj;T0; @•L;[;I"’Exclusive Or---Returns true if obj is nil or false, false otherwise. @overload ^(obj);T;0; @•L;!F;"o;#;$T;%i»;&iÀ;'@7L;(I"Zstatic VALUE true_xor(VALUE obj, VALUE obj2) { return RTEST(obj2)?Qfalse:Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"TrueClass#===;F;[;[;F;;\;;K;[;{;IC;";T;[;[;@|;0; @¯L;'@7L;*T;A@7L;BIC;[;A@7L;CIC;[;A@7L;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@LL;q;I[;[[@Ìi~[@Ìi8;T;:TrueClass;;K;;;[;{;IC;"2********************************************************************* The global value true is the only instance of class TrueClass and represents a logically true value in boolean expressions. The class provides operators allowing true to be used in logical expressions.;T;[;[;I"3********************************************************************* The global value true is the only instance of class TrueClass and represents a logically true value in boolean expressions. The class provides operators allowing true to be used in logical expressions. ;T;0; @7L;!F;"o;#;$T;%i~;&i„;6i;'@;I"TrueClass;F;S@]o; ;IC;[o;;F; ;;;;I"FalseClass#to_s;F;[;[[@ÌiÜ;T;;q;0;[;{;IC;"@The string representation of false is "false". ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @ÌL;>0;!F;[;[;I";T;0;6i;[; @ÌL;[;I"QThe string representation of false is "false". @overload to_s;T;0; o;;F; ;;;;I"FalseClass#inspect;F;[;[[@ÌiH;F;;r;;K;[;{;@ÓL;'@ÊL;)I"static VALUE;T;(I"Kstatic VALUE false_to_s(VALUE obj) { return rb_cFalseClass_to_s; };T;!F;"o;#;$T;%iÕ;&iØ;'@ÊL;(I"Kstatic VALUE false_to_s(VALUE obj) { return rb_cFalseClass_to_s; };T;)@æL;*T@ßLo;;F; ;;;;I"FalseClass#&;F;[[I" obj2;T0;[[@Ìiì;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;= ;3I" overload;F;40;;”;50;)I"&(obj);T;IC;";T; @êL;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" false;T; @êL;[;I"@return [false];T;0;6i;[[I"obj;T0; @êLo;= ;3I" overload;F;40;;”;50;)I"&(obj);T;IC;";T; @êL;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" false;T; @êL;[;I"@return [false];T;0;6i;[[I"obj;T0; @êL;[;@‰‰;0; @êL;!F;"o;#;$T;%iâ;&iê;'@ÊL;(I"Istatic VALUE false_and(VALUE obj, VALUE obj2) { return Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"FalseClass#|;F;[;[;F;;(;;K;[;{;IC;";T;[;[;@|;0; @M;'@ÊL;*To;;F; ;;;;I"FalseClass#^;F;[;[;F;;i;;K;[;{;IC;";T;[;[;@|;0; @ M;'@ÊL;*To;;F; ;;;;I"FalseClass#===;F;[;[;F;;\;;K;[;{;IC;";T;[;[;@|;0; @)M;'@ÊL;*T;A@ÊL;BIC;[;A@ÊL;CIC;[;A@ÊL;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{@ßL;q;I[;[[@ÌiË[@ÌiD;T;:FalseClass;;K;;;[;{;IC;"õThe global value false is the only instance of class FalseClass and represents a logically false value in boolean expressions. The class provides operators allowing false to participate correctly in logical expressions.;T;[;[;I"ø The global value false is the only instance of class FalseClass and represents a logically false value in boolean expressions. The class provides operators allowing false to participate correctly in logical expressions. ;T;0; @ÊL;!F;"o;#;$T;%iË;&iÑ;6i;'@;I"FalseClass;F;S@]o; ;IC;[.o;{;[[@bõiO;F;;h;;};;;[;{;IC;";T;[;[;@|;0; @FM;'@DM;I"Etc::VERSION;F;~I"&rb_str_new_cstr(RUBY_ETC_VERSION);To;;F; ;;;Ï;I"Etc#getlogin;F;[;[[@bõif;T;: getlogin;0;[;{;IC;"Ggetlogin -> String Returns the short user name of the currently logged in user. Unfortunately, it is often rather easy to fool ::getlogin. Avoid ::getlogin for security-related purposes. If ::getlogin fails, try ::getpwuid. See the unix manpage for getpwuid(3) for more detail. e.g. Etc.getlogin -> 'guest' ;T; @PM;>0;!F;[;[;I"Ggetlogin -> String Returns the short user name of the currently logged in user. Unfortunately, it is often rather easy to fool ::getlogin. Avoid ::getlogin for security-related purposes. If ::getlogin fails, try ::getpwuid. See the unix manpage for getpwuid(3) for more detail. e.g. Etc.getlogin -> 'guest';T;0;'@DM;(I"™static VALUE etc_getlogin(VALUE obj) { char *login; #ifdef HAVE_GETLOGIN login = getlogin(); if (!login) login = getenv("USER"); #else login = getenv("USER"); #endif if (login) { #ifdef _WIN32 rb_encoding *extenc = rb_utf8_encoding(); #else rb_encoding *extenc = rb_locale_encoding(); #endif return rb_external_str_new_with_enc(login, strlen(login), extenc); } return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Etc.getlogin;F;@RM;@SM;T;;;0;@UM;{;IC;"Ggetlogin -> String Returns the short user name of the currently logged in user. Unfortunately, it is often rather easy to fool ::getlogin. Avoid ::getlogin for security-related purposes. If ::getlogin fails, try ::getpwuid. See the unix manpage for getpwuid(3) for more detail. e.g. Etc.getlogin -> 'guest';T;[;[;I"Igetlogin -> String Returns the short user name of the currently logged in user. Unfortunately, it is often rather easy to fool ::getlogin. Avoid ::getlogin for security-related purposes. If ::getlogin fails, try ::getpwuid. See the unix manpage for getpwuid(3) for more detail. e.g. Etc.getlogin -> 'guest' ;T;0; @]M;!F;"o;#;$T;%iW;&ie;6i;'@DM;(@[M;)@\M;*To;;F; ;;;Ï;I"Etc#getpwuid;F;[[@c0;[[@bõiÏ;T;: getpwuid;0;[;{;IC;"½getpwuid(uid) -> Passwd Returns the /etc/passwd information for the user with the given integer +uid+. The information is returned as a Passwd struct. If +uid+ is omitted, the value from Passwd[:uid] is returned instead. See the unix manpage for getpwuid(3) for more detail. === Example: Etc.getpwuid(0) #=> # ;T; @eM;>0;!F;[;[;I"½getpwuid(uid) -> Passwd Returns the /etc/passwd information for the user with the given integer +uid+. The information is returned as a Passwd struct. If +uid+ is omitted, the value from Passwd[:uid] is returned instead. See the unix manpage for getpwuid(3) for more detail. === Example: Etc.getpwuid(0) #=> #;T;0;'@DM;(I"§static VALUE etc_getpwuid(int argc, VALUE *argv, VALUE obj) { #if defined(HAVE_GETPWENT) VALUE id; rb_uid_t uid; struct passwd *pwd; if (rb_scan_args(argc, argv, "01", &id) == 1) { uid = NUM2UIDT(id); } else { uid = getuid(); } pwd = getpwuid(uid); if (pwd == 0) rb_raise(rb_eArgError, "can't find user for %d", (int)uid); return setup_passwd(pwd); #else return Qnil; #endif };T;)I"static VALUE;T;*To;;T; ;F;;;I"Etc.getpwuid;F;@gM;@iM;T;;;0;@kM;{;IC;"½getpwuid(uid) -> Passwd Returns the /etc/passwd information for the user with the given integer +uid+. The information is returned as a Passwd struct. If +uid+ is omitted, the value from Passwd[:uid] is returned instead. See the unix manpage for getpwuid(3) for more detail. === Example: Etc.getpwuid(0) #=> #;T;[;[;I"¿getpwuid(uid) -> Passwd Returns the /etc/passwd information for the user with the given integer +uid+. The information is returned as a Passwd struct. If +uid+ is omitted, the value from Passwd[:uid] is returned instead. See the unix manpage for getpwuid(3) for more detail. === Example: Etc.getpwuid(0) #=> # ;T;0; @sM;!F;"o;#;$T;%i¾;&iÎ;6i;'@DM;(@qM;)@rM;*To;;F; ;;;Ï;I"Etc#getpwnam;F;[[I"nam;T0;[[@bõiô;T;: getpwnam;0;[;{;IC;"ngetpwnam(name) -> Passwd Returns the /etc/passwd information for the user with specified login +name+. The information is returned as a Passwd struct. See the unix manpage for getpwnam(3) for more detail. === Example: Etc.getpwnam('root') #=> # ;T; @{M;>0;!F;[;[;I"ngetpwnam(name) -> Passwd Returns the /etc/passwd information for the user with specified login +name+. The information is returned as a Passwd struct. See the unix manpage for getpwnam(3) for more detail. === Example: Etc.getpwnam('root') #=> #;T;0;'@DM;(I"/static VALUE etc_getpwnam(VALUE obj, VALUE nam) { #ifdef HAVE_GETPWENT struct passwd *pwd; const char *p = StringValueCStr(nam); pwd = getpwnam(p); if (pwd == 0) rb_raise(rb_eArgError, "can't find user for %"PRIsVALUE, nam); return setup_passwd(pwd); #else return Qnil; #endif };T;)I"static VALUE;T;*To;;T; ;F;;;I"Etc.getpwnam;F;@}M;@€M;T;;;0;@‚M;{;IC;"ngetpwnam(name) -> Passwd Returns the /etc/passwd information for the user with specified login +name+. The information is returned as a Passwd struct. See the unix manpage for getpwnam(3) for more detail. === Example: Etc.getpwnam('root') #=> #;T;[;[;I"pgetpwnam(name) -> Passwd Returns the /etc/passwd information for the user with specified login +name+. The information is returned as a Passwd struct. See the unix manpage for getpwnam(3) for more detail. === Example: Etc.getpwnam('root') #=> # ;T;0; @ŠM;!F;"o;#;$T;%iå;&ió;6i;'@DM;(@ˆM;)@‰M;*To;;F; ;;;Ï;I"Etc#setpwent;F;[;[[@bõin;T;: setpwent;0;[;{;IC;"Resets the process of reading the /etc/passwd file, so that the next call to ::getpwent will return the first entry again. ;T; @’M;>0;!F;[;[;I"Resets the process of reading the /etc/passwd file, so that the next call to ::getpwent will return the first entry again.;T;0;'@DM;(I"jstatic VALUE etc_setpwent(VALUE obj) { #ifdef HAVE_GETPWENT setpwent(); #endif return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Etc.setpwent;F;@”M;@•M;T;;;0;@—M;{;IC;"Resets the process of reading the /etc/passwd file, so that the next call to ::getpwent will return the first entry again.;T;[;[;I"{Resets the process of reading the /etc/passwd file, so that the next call to ::getpwent will return the first entry again. ;T;0; @ŸM;!F;"o;#;$T;%ik;&im;6i;'@DM;(@M;)@žM;*To;;F; ;;;Ï;I"Etc#endpwent;F;[;[[@bõiz;T;: endpwent;0;[;{;IC;"jEnds the process of scanning through the /etc/passwd file begun with ::getpwent, and closes the file. ;T; @§M;>0;!F;[;[;I"jEnds the process of scanning through the /etc/passwd file begun with ::getpwent, and closes the file.;T;0;'@DM;(I"jstatic VALUE etc_endpwent(VALUE obj) { #ifdef HAVE_GETPWENT endpwent(); #endif return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Etc.endpwent;F;@©M;@ªM;T;;;0;@¬M;{;IC;"jEnds the process of scanning through the /etc/passwd file begun with ::getpwent, and closes the file.;T;[;[;I"kEnds the process of scanning through the /etc/passwd file begun with ::getpwent, and closes the file. ;T;0; @´M;!F;"o;#;$T;%iw;&iy;6i;'@DM;(@²M;)@³M;*To;;F; ;;;Ï;I"Etc#getpwent;F;[;[[@bõiŽ;T;: getpwent;0;[;{;IC;"CReturns an entry from the /etc/passwd file. The first time it is called it opens the file and returns the first entry; each successive call returns the next entry, or +nil+ if the end of the file has been reached. To close the file when processing is complete, call ::endpwent. Each entry is returned as a Passwd struct. ;T; @¼M;>0;!F;[;[;I"CReturns an entry from the /etc/passwd file. The first time it is called it opens the file and returns the first entry; each successive call returns the next entry, or +nil+ if the end of the file has been reached. To close the file when processing is complete, call ::endpwent. Each entry is returned as a Passwd struct.;T;0;'@DM;(I"¯static VALUE etc_getpwent(VALUE obj) { #ifdef HAVE_GETPWENT struct passwd *pw; if ((pw = getpwent()) != 0) { return setup_passwd(pw); } #endif return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Etc.getpwent;F;@¾M;@¿M;T;;;0;@ÁM;{;IC;"CReturns an entry from the /etc/passwd file. The first time it is called it opens the file and returns the first entry; each successive call returns the next entry, or +nil+ if the end of the file has been reached. To close the file when processing is complete, call ::endpwent. Each entry is returned as a Passwd struct.;T;[;[;I"EReturns an entry from the /etc/passwd file. The first time it is called it opens the file and returns the first entry; each successive call returns the next entry, or +nil+ if the end of the file has been reached. To close the file when processing is complete, call ::endpwent. Each entry is returned as a Passwd struct. ;T;0; @ÉM;!F;"o;#;$T;%iƒ;&i;6i;'@DM;(@ÇM;)@ÈM;*To;;F; ;;;Ï;I"Etc#passwd;F;[;[[@bõi9;T;:passwd;0;[;{;IC;"OEtc.passwd { |struct| block } -> Passwd Etc.passwd -> Passwd Provides a convenient Ruby iterator which executes a block for each entry in the /etc/passwd file. The code block is passed an Passwd struct. See ::getpwent above for details. Example: require 'etc' Etc.passwd {|u| puts u.name + " = " + u.gecos } ;T; @ÑM;>0;!F;[;[;I"OEtc.passwd { |struct| block } -> Passwd Etc.passwd -> Passwd Provides a convenient Ruby iterator which executes a block for each entry in the /etc/passwd file. The code block is passed an Passwd struct. See ::getpwent above for details. Example: require 'etc' Etc.passwd {|u| puts u.name + " = " + u.gecos };T;0;'@DM;(I"æstatic VALUE etc_passwd(VALUE obj) { #ifdef HAVE_GETPWENT struct passwd *pw; if (rb_block_given_p()) { each_passwd(); } else if ((pw = getpwent()) != 0) { return setup_passwd(pw); } #endif return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Etc.passwd;F;@ÓM;@ÔM;T;;;0;@ÖM;{;IC;"OEtc.passwd { |struct| block } -> Passwd Etc.passwd -> Passwd Provides a convenient Ruby iterator which executes a block for each entry in the /etc/passwd file. The code block is passed an Passwd struct. See ::getpwent above for details. Example: require 'etc' Etc.passwd {|u| puts u.name + " = " + u.gecos };T;[;[;I"REtc.passwd { |struct| block } -> Passwd Etc.passwd -> Passwd Provides a convenient Ruby iterator which executes a block for each entry in the /etc/passwd file. The code block is passed an Passwd struct. See ::getpwent above for details. Example: require 'etc' Etc.passwd {|u| puts u.name + " = " + u.gecos } ;T;0; @ÞM;!F;"o;#;$T;%i%;&i8;6i;'@DM;(@ÜM;)@ÝM;*To;;F; ;;;Ï;I"Etc#getgrgid;F;[[@c0;[[@bõiÂ;T;: getgrgid;0;[;{;IC;"bgetgrgid(group_id) -> Group Returns information about the group with specified integer +group_id+, as found in /etc/group. The information is returned as a Group struct. See the unix manpage for getgrgid(3) for more detail. === Example: Etc.getgrgid(100) #=> # ;T; @æM;>0;!F;[;[;I"bgetgrgid(group_id) -> Group Returns information about the group with specified integer +group_id+, as found in /etc/group. The information is returned as a Group struct. See the unix manpage for getgrgid(3) for more detail. === Example: Etc.getgrgid(100) #=> #;T;0;'@DM;(I"static VALUE etc_getgrgid(int argc, VALUE *argv, VALUE obj) { #ifdef HAVE_GETGRENT VALUE id; gid_t gid; struct group *grp; if (rb_scan_args(argc, argv, "01", &id) == 1) { gid = NUM2GIDT(id); } else { gid = getgid(); } grp = getgrgid(gid); if (grp == 0) rb_raise(rb_eArgError, "can't find group for %d", (int)gid); return setup_group(grp); #else return Qnil; #endif };T;)I"static VALUE;T;*To;;T; ;F;;;I"Etc.getgrgid;F;@èM;@êM;T;;;0;@ìM;{;IC;"bgetgrgid(group_id) -> Group Returns information about the group with specified integer +group_id+, as found in /etc/group. The information is returned as a Group struct. See the unix manpage for getgrgid(3) for more detail. === Example: Etc.getgrgid(100) #=> #;T;[;[;I"egetgrgid(group_id) -> Group Returns information about the group with specified integer +group_id+, as found in /etc/group. The information is returned as a Group struct. See the unix manpage for getgrgid(3) for more detail. === Example: Etc.getgrgid(100) #=> # ;T;0; @ôM;!F;"o;#;$T;%i²;&iÁ;6i;'@DM;(@òM;)@óM;*To;;F; ;;;Ï;I"Etc#getgrnam;F;[[I"nam;T0;[[@bõiè;T;: getgrnam;0;[;{;IC;"Vgetgrnam(name) -> Group Returns information about the group with specified +name+, as found in /etc/group. The information is returned as a Group struct. See the unix manpage for getgrnam(3) for more detail. === Example: Etc.getgrnam('users') #=> # ;T; @üM;>0;!F;[;[;I"Vgetgrnam(name) -> Group Returns information about the group with specified +name+, as found in /etc/group. The information is returned as a Group struct. See the unix manpage for getgrnam(3) for more detail. === Example: Etc.getgrnam('users') #=> #;T;0;'@DM;(I".static VALUE etc_getgrnam(VALUE obj, VALUE nam) { #ifdef HAVE_GETGRENT struct group *grp; const char *p = StringValueCStr(nam); grp = getgrnam(p); if (grp == 0) rb_raise(rb_eArgError, "can't find group for %"PRIsVALUE, nam); return setup_group(grp); #else return Qnil; #endif };T;)I"static VALUE;T;*To;;T; ;F;;;I"Etc.getgrnam;F;@þM;@N;T;; ;0;@N;{;IC;"Vgetgrnam(name) -> Group Returns information about the group with specified +name+, as found in /etc/group. The information is returned as a Group struct. See the unix manpage for getgrnam(3) for more detail. === Example: Etc.getgrnam('users') #=> #;T;[;[;I"Ygetgrnam(name) -> Group Returns information about the group with specified +name+, as found in /etc/group. The information is returned as a Group struct. See the unix manpage for getgrnam(3) for more detail. === Example: Etc.getgrnam('users') #=> # ;T;0; @N;!F;"o;#;$T;%iØ;&iç;6i;'@DM;(@ N;)@ N;*To;;F; ;;;Ï;I"Etc#group;F;[;[[@bõi*;T;;Ð;0;[;{;IC;"Provides a convenient Ruby iterator which executes a block for each entry in the /etc/group file. The code block is passed an Group struct. See ::getgrent above for details. Example: require 'etc' Etc.group {|g| puts g.name + ": " + g.mem.join(', ') } ;T; @N;>0;!F;[;[;I"Provides a convenient Ruby iterator which executes a block for each entry in the /etc/group file. The code block is passed an Group struct. See ::getgrent above for details. Example: require 'etc' Etc.group {|g| puts g.name + ": " + g.mem.join(', ') };T;0;'@DM;(I"åstatic VALUE etc_group(VALUE obj) { #ifdef HAVE_GETGRENT struct group *grp; if (rb_block_given_p()) { each_group(); } else if ((grp = getgrent()) != 0) { return setup_group(grp); } #endif return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Etc.group;F;@N;@N;T;;Ð;0;@N;{;IC;"Provides a convenient Ruby iterator which executes a block for each entry in the /etc/group file. The code block is passed an Group struct. See ::getgrent above for details. Example: require 'etc' Etc.group {|g| puts g.name + ": " + g.mem.join(', ') };T;[;[;I"Provides a convenient Ruby iterator which executes a block for each entry in the /etc/group file. The code block is passed an Group struct. See ::getgrent above for details. Example: require 'etc' Etc.group {|g| puts g.name + ": " + g.mem.join(', ') } ;T;0; @ N;!F;"o;#;$T;%i;&i);6i;'@DM;(@N;)@N;*To;;F; ;;;Ï;I"Etc#setgrent;F;[;[[@bõi];T;: setgrent;0;[;{;IC;"~Resets the process of reading the /etc/group file, so that the next call to ::getgrent will return the first entry again. ;T; @(N;>0;!F;[;[;I"~Resets the process of reading the /etc/group file, so that the next call to ::getgrent will return the first entry again.;T;0;'@DM;(I"jstatic VALUE etc_setgrent(VALUE obj) { #ifdef HAVE_GETGRENT setgrent(); #endif return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Etc.setgrent;F;@*N;@+N;T;; ;0;@-N;{;IC;"~Resets the process of reading the /etc/group file, so that the next call to ::getgrent will return the first entry again.;T;[;[;I"Resets the process of reading the /etc/group file, so that the next call to ::getgrent will return the first entry again. ;T;0; @5N;!F;"o;#;$T;%iZ;&i\;6i;'@DM;(@3N;)@4N;*To;;F; ;;;Ï;I"Etc#endgrent;F;[;[[@bõii;T;: endgrent;0;[;{;IC;"gEnds the process of scanning through the /etc/group file begun by ::getgrent, and closes the file. ;T; @=N;>0;!F;[;[;I"gEnds the process of scanning through the /etc/group file begun by ::getgrent, and closes the file.;T;0;'@DM;(I"jstatic VALUE etc_endgrent(VALUE obj) { #ifdef HAVE_GETGRENT endgrent(); #endif return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Etc.endgrent;F;@?N;@@N;T;;;0;@BN;{;IC;"gEnds the process of scanning through the /etc/group file begun by ::getgrent, and closes the file.;T;[;[;I"hEnds the process of scanning through the /etc/group file begun by ::getgrent, and closes the file. ;T;0; @JN;!F;"o;#;$T;%if;&ih;6i;'@DM;(@HN;)@IN;*To;;F; ;;;Ï;I"Etc#getgrent;F;[;[[@bõi|;T;: getgrent;0;[;{;IC;"@Returns an entry from the /etc/group file. The first time it is called it opens the file and returns the first entry; each successive call returns the next entry, or +nil+ if the end of the file has been reached. To close the file when processing is complete, call ::endgrent. Each entry is returned as a Group struct ;T; @RN;>0;!F;[;[;I"@Returns an entry from the /etc/group file. The first time it is called it opens the file and returns the first entry; each successive call returns the next entry, or +nil+ if the end of the file has been reached. To close the file when processing is complete, call ::endgrent. Each entry is returned as a Group struct;T;0;'@DM;(I"static VALUE etc_getgrent(VALUE obj) { #ifdef HAVE_GETGRENT struct group *gr; if ((gr = getgrent()) != 0) { return setup_group(gr); } #endif return Qnil; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Etc.getgrent;F;@TN;@UN;T;;;0;@WN;{;IC;"@Returns an entry from the /etc/group file. The first time it is called it opens the file and returns the first entry; each successive call returns the next entry, or +nil+ if the end of the file has been reached. To close the file when processing is complete, call ::endgrent. Each entry is returned as a Group struct;T;[;[;I"AReturns an entry from the /etc/group file. The first time it is called it opens the file and returns the first entry; each successive call returns the next entry, or +nil+ if the end of the file has been reached. To close the file when processing is complete, call ::endgrent. Each entry is returned as a Group struct ;T;0; @_N;!F;"o;#;$T;%ir;&i{;6i;'@DM;(@]N;)@^N;*To;;F; ;;;Ï;I"Etc#sysconfdir;F;[;[[@bõi™;T;:sysconfdir;0;[;{;IC;"8Returns system configuration directory. This is typically "/etc", but is modified by the prefix used when Ruby was compiled. For example, if Ruby is built and installed in /usr/local, returns "/usr/local/etc" on other platforms than Windows. On Windows, this always returns the directory provided by the system. ;T; @gN;>0;!F;[;[;I"8Returns system configuration directory. This is typically "/etc", but is modified by the prefix used when Ruby was compiled. For example, if Ruby is built and installed in /usr/local, returns "/usr/local/etc" on other platforms than Windows. On Windows, this always returns the directory provided by the system.;T;0;'@DM;(I"°static VALUE etc_sysconfdir(VALUE obj) { #ifdef _WIN32 return rb_w32_special_folder(CSIDL_COMMON_APPDATA); #else return rb_filesystem_str_new_cstr(SYSCONFDIR); #endif };T;)I"static VALUE;T;*To;;T; ;F;;;I"Etc.sysconfdir;F;@iN;@jN;T;; ;0;@lN;{;IC;"8Returns system configuration directory. This is typically "/etc", but is modified by the prefix used when Ruby was compiled. For example, if Ruby is built and installed in /usr/local, returns "/usr/local/etc" on other platforms than Windows. On Windows, this always returns the directory provided by the system.;T;[;[;I"9Returns system configuration directory. This is typically "/etc", but is modified by the prefix used when Ruby was compiled. For example, if Ruby is built and installed in /usr/local, returns "/usr/local/etc" on other platforms than Windows. On Windows, this always returns the directory provided by the system. ;T;0; @tN;!F;"o;#;$T;%i‘;&i—;6i;'@DM;(@rN;)@sN;*To;;F; ;;;Ï;I"Etc#systmpdir;F;[;[[@bõi¦;T;:systmpdir;0;[;{;IC;":Returns system temporary directory; typically "/tmp". ;T; @|N;>0;!F;[;[;I":Returns system temporary directory; typically "/tmp".;T;0;'@DM;(I"åstatic VALUE etc_systmpdir(VALUE _) { VALUE tmpdir; #ifdef _WIN32 WCHAR path[_MAX_PATH]; UINT len = rb_w32_system_tmpdir(path, numberof(path)); if (!len) return Qnil; tmpdir = rb_w32_conv_from_wchar(path, rb_filesystem_encoding()); #else const char default_tmp[] = "/tmp"; const char *tmpstr = default_tmp; size_t tmplen = strlen(default_tmp); # if defined _CS_DARWIN_USER_TEMP_DIR #ifndef MAXPATHLEN #define MAXPATHLEN 1024 #endif char path[MAXPATHLEN]; size_t len; len = confstr(_CS_DARWIN_USER_TEMP_DIR, path, sizeof(path)); if (len > 0) { tmpstr = path; tmplen = len - 1; if (len > sizeof(path)) tmpstr = 0; } # endif tmpdir = rb_filesystem_str_new(tmpstr, tmplen); # if defined _CS_DARWIN_USER_TEMP_DIR if (!tmpstr) { confstr(_CS_DARWIN_USER_TEMP_DIR, RSTRING_PTR(tmpdir), len); } # endif #endif #ifndef RB_PASS_KEYWORDS /* untaint on Ruby < 2.7 */ FL_UNSET(tmpdir, FL_TAINT); #endif return tmpdir; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Etc.systmpdir;F;@~N;@N;T;;;0;@N;{;IC;":Returns system temporary directory; typically "/tmp".;T;[;[;I";Returns system temporary directory; typically "/tmp". ;T;0; @‰N;!F;"o;#;$T;%i£;&i¤;6i;'@DM;(@‡N;)@ˆN;*To;;F; ;;;Ï;I"Etc#uname;F;[;[[@bõiâ;T;: uname;0;[;{;IC;"ŒReturns the system information obtained by uname system call. The return value is a hash which has 5 keys at least: :sysname, :nodename, :release, :version, :machine Example: require 'etc' require 'pp' pp Etc.uname #=> {:sysname=>"Linux", # :nodename=>"boron", # :release=>"2.6.18-6-xen-686", # :version=>"#1 SMP Thu Nov 5 19:54:42 UTC 2009", # :machine=>"i686"} ;T; @‘N;>0;!F;[;[;I"ŒReturns the system information obtained by uname system call. The return value is a hash which has 5 keys at least: :sysname, :nodename, :release, :version, :machine Example: require 'etc' require 'pp' pp Etc.uname #=> {:sysname=>"Linux", # :nodename=>"boron", # :release=>"2.6.18-6-xen-686", # :version=>"#1 SMP Thu Nov 5 19:54:42 UTC 2009", # :machine=>"i686"};T;0;'@DM;(I"Ú static VALUE etc_uname(VALUE obj) { #ifdef _WIN32 OSVERSIONINFOW v; SYSTEM_INFO s; const char *sysname, *mach; VALUE result, release, version; VALUE vbuf, nodename = Qnil; DWORD len = 0; WCHAR *buf; v.dwOSVersionInfoSize = sizeof(v); if (!GetVersionExW(&v)) rb_sys_fail("GetVersionEx"); result = rb_hash_new(); switch (v.dwPlatformId) { case VER_PLATFORM_WIN32s: sysname = "Win32s"; break; case VER_PLATFORM_WIN32_NT: sysname = "Windows_NT"; break; case VER_PLATFORM_WIN32_WINDOWS: default: sysname = "Windows"; break; } rb_hash_aset(result, ID2SYM(rb_intern("sysname")), rb_str_new_cstr(sysname)); release = rb_sprintf("%lu.%lu.%lu", v.dwMajorVersion, v.dwMinorVersion, v.dwBuildNumber); rb_hash_aset(result, ID2SYM(rb_intern("release")), release); version = rb_sprintf("%s Version %"PRIsVALUE": %"PRIsVALUE, sysname, release, rb_w32_conv_from_wchar(v.szCSDVersion, rb_utf8_encoding())); rb_hash_aset(result, ID2SYM(rb_intern("version")), version); # if defined _MSC_VER && _MSC_VER < 1300 # define GET_COMPUTER_NAME(ptr, plen) GetComputerNameW(ptr, plen) # else # define GET_COMPUTER_NAME(ptr, plen) GetComputerNameExW(ComputerNameDnsFullyQualified, ptr, plen) # endif GET_COMPUTER_NAME(NULL, &len); buf = ALLOCV_N(WCHAR, vbuf, len); if (GET_COMPUTER_NAME(buf, &len)) { nodename = rb_w32_conv_from_wchar(buf, rb_utf8_encoding()); } ALLOCV_END(vbuf); if (NIL_P(nodename)) nodename = rb_str_new(0, 0); rb_hash_aset(result, ID2SYM(rb_intern("nodename")), nodename); # ifndef PROCESSOR_ARCHITECTURE_AMD64 # define PROCESSOR_ARCHITECTURE_AMD64 9 # endif # ifndef PROCESSOR_ARCHITECTURE_INTEL # define PROCESSOR_ARCHITECTURE_INTEL 0 # endif GetSystemInfo(&s); switch (s.wProcessorArchitecture) { case PROCESSOR_ARCHITECTURE_AMD64: mach = "x64"; break; case PROCESSOR_ARCHITECTURE_ARM: mach = "ARM"; break; case PROCESSOR_ARCHITECTURE_INTEL: mach = "x86"; break; default: mach = "unknown"; break; } rb_hash_aset(result, ID2SYM(rb_intern("machine")), rb_str_new_cstr(mach)); #else struct utsname u; int ret; VALUE result; ret = uname(&u); if (ret == -1) rb_sys_fail("uname"); result = rb_hash_new(); rb_hash_aset(result, ID2SYM(rb_intern("sysname")), rb_str_new_cstr(u.sysname)); rb_hash_aset(result, ID2SYM(rb_intern("nodename")), rb_str_new_cstr(u.nodename)); rb_hash_aset(result, ID2SYM(rb_intern("release")), rb_str_new_cstr(u.release)); rb_hash_aset(result, ID2SYM(rb_intern("version")), rb_str_new_cstr(u.version)); rb_hash_aset(result, ID2SYM(rb_intern("machine")), rb_str_new_cstr(u.machine)); #endif return result; };T;)I"static VALUE;T;*To;;T; ;F;;;I"Etc.uname;F;@“N;@”N;T;;;0;@–N;{;IC;"ŒReturns the system information obtained by uname system call. The return value is a hash which has 5 keys at least: :sysname, :nodename, :release, :version, :machine Example: require 'etc' require 'pp' pp Etc.uname #=> {:sysname=>"Linux", # :nodename=>"boron", # :release=>"2.6.18-6-xen-686", # :version=>"#1 SMP Thu Nov 5 19:54:42 UTC 2009", # :machine=>"i686"};T;[;[;I"ŽReturns the system information obtained by uname system call. The return value is a hash which has 5 keys at least: :sysname, :nodename, :release, :version, :machine Example: require 'etc' require 'pp' pp Etc.uname #=> {:sysname=>"Linux", # :nodename=>"boron", # :release=>"2.6.18-6-xen-686", # :version=>"#1 SMP Thu Nov 5 19:54:42 UTC 2009", # :machine=>"i686"} ;T;0; @žN;!F;"o;#;$T;%iÏ;&ià;6i;'@DM;(@œN;)@N;*To;;F; ;;;Ï;I"Etc#sysconf;F;[[I"arg;T0;[[@bõiO;T;:sysconf;0;[;{;IC;"ZReturns system configuration variable using sysconf(). _name_ should be a constant under Etc which begins with SC_. The return value is an integer or nil. nil means indefinite limit. (sysconf() returns -1 but errno is not set.) Etc.sysconf(Etc::SC_ARG_MAX) #=> 2097152 Etc.sysconf(Etc::SC_LOGIN_NAME_MAX) #=> 256 ;T; @¦N;>0;!F;[;[;I"ZReturns system configuration variable using sysconf(). _name_ should be a constant under Etc which begins with SC_. The return value is an integer or nil. nil means indefinite limit. (sysconf() returns -1 but errno is not set.) Etc.sysconf(Etc::SC_ARG_MAX) #=> 2097152 Etc.sysconf(Etc::SC_LOGIN_NAME_MAX) #=> 256;T;0;'@DM;(I"&static VALUE etc_sysconf(VALUE obj, VALUE arg) { int name; long ret; name = NUM2INT(arg); errno = 0; ret = sysconf(name); if (ret == -1) { if (errno == 0) /* no limit */ return Qnil; rb_sys_fail("sysconf"); } return LONG2NUM(ret); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Etc.sysconf;F;@¨N;@«N;T;;;0;@N;{;IC;"ZReturns system configuration variable using sysconf(). _name_ should be a constant under Etc which begins with SC_. The return value is an integer or nil. nil means indefinite limit. (sysconf() returns -1 but errno is not set.) Etc.sysconf(Etc::SC_ARG_MAX) #=> 2097152 Etc.sysconf(Etc::SC_LOGIN_NAME_MAX) #=> 256;T;[;[;I"\Returns system configuration variable using sysconf(). _name_ should be a constant under Etc which begins with SC_. The return value is an integer or nil. nil means indefinite limit. (sysconf() returns -1 but errno is not set.) Etc.sysconf(Etc::SC_ARG_MAX) #=> 2097152 Etc.sysconf(Etc::SC_LOGIN_NAME_MAX) #=> 256 ;T;0; @µN;!F;"o;#;$T;%iC;&iM;6i;'@DM;(@³N;)@´N;*To;;F; ;;;Ï;I"Etc#confstr;F;[[I"arg;T0;[[@bõit;T;:confstr;0;[;{;IC;"ÂReturns system configuration variable using confstr(). _name_ should be a constant under Etc which begins with CS_. The return value is a string or nil. nil means no configuration-defined value. (confstr() returns 0 but errno is not set.) Etc.confstr(Etc::CS_PATH) #=> "/bin:/usr/bin" # GNU/Linux Etc.confstr(Etc::CS_GNU_LIBC_VERSION) #=> "glibc 2.18" Etc.confstr(Etc::CS_GNU_LIBPTHREAD_VERSION) #=> "NPTL 2.18" ;T; @½N;>0;!F;[;[;I"ÂReturns system configuration variable using confstr(). _name_ should be a constant under Etc which begins with CS_. The return value is a string or nil. nil means no configuration-defined value. (confstr() returns 0 but errno is not set.) Etc.confstr(Etc::CS_PATH) #=> "/bin:/usr/bin" # GNU/Linux Etc.confstr(Etc::CS_GNU_LIBC_VERSION) #=> "glibc 2.18" Etc.confstr(Etc::CS_GNU_LIBPTHREAD_VERSION) #=> "NPTL 2.18";T;0;'@DM;(I"¨static VALUE etc_confstr(VALUE obj, VALUE arg) { int name; char localbuf[128], *buf = localbuf; size_t bufsize = sizeof(localbuf), ret; VALUE tmp; name = NUM2INT(arg); errno = 0; ret = confstr(name, buf, bufsize); if (bufsize < ret) { bufsize = ret; buf = ALLOCV_N(char, tmp, bufsize); errno = 0; ret = confstr(name, buf, bufsize); } if (bufsize < ret) rb_bug("required buffer size for confstr() changed dynamically."); if (ret == 0) { if (errno == 0) /* no configuration-defined value */ return Qnil; rb_sys_fail("confstr"); } return rb_str_new_cstr(buf); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Etc.confstr;F;@¿N;@ÂN;T;;;0;@ÄN;{;IC;"ÂReturns system configuration variable using confstr(). _name_ should be a constant under Etc which begins with CS_. The return value is a string or nil. nil means no configuration-defined value. (confstr() returns 0 but errno is not set.) Etc.confstr(Etc::CS_PATH) #=> "/bin:/usr/bin" # GNU/Linux Etc.confstr(Etc::CS_GNU_LIBC_VERSION) #=> "glibc 2.18" Etc.confstr(Etc::CS_GNU_LIBPTHREAD_VERSION) #=> "NPTL 2.18";T;[;[;I"ÄReturns system configuration variable using confstr(). _name_ should be a constant under Etc which begins with CS_. The return value is a string or nil. nil means no configuration-defined value. (confstr() returns 0 but errno is not set.) Etc.confstr(Etc::CS_PATH) #=> "/bin:/usr/bin" # GNU/Linux Etc.confstr(Etc::CS_GNU_LIBC_VERSION) #=> "glibc 2.18" Etc.confstr(Etc::CS_GNU_LIBPTHREAD_VERSION) #=> "NPTL 2.18" ;T;0; @ÌN;!F;"o;#;$T;%ie;&ir;6i;'@DM;(@ÊN;)@ËN;*To;;F; ;;;Ï;I"Etc#nprocessors;F;[;[[@bõi;T;:nprocessors;0;[;{;IC;"\Returns the number of online processors. The result is intended as the number of processes to use all available processors. This method is implemented using: - sched_getaffinity(): Linux - sysconf(_SC_NPROCESSORS_ONLN): GNU/Linux, NetBSD, FreeBSD, OpenBSD, DragonFly BSD, OpenIndiana, Mac OS X, AIX Example: require 'etc' p Etc.nprocessors #=> 4 The result might be smaller number than physical cpus especially when ruby process is bound to specific cpus. This is intended for getting better parallel processing. Example: (Linux) linux$ taskset 0x3 ./ruby -retc -e "p Etc.nprocessors" #=> 2 ;T; @ÔN;>0;!F;[;[;I"\Returns the number of online processors. The result is intended as the number of processes to use all available processors. This method is implemented using: - sched_getaffinity(): Linux - sysconf(_SC_NPROCESSORS_ONLN): GNU/Linux, NetBSD, FreeBSD, OpenBSD, DragonFly BSD, OpenIndiana, Mac OS X, AIX Example: require 'etc' p Etc.nprocessors #=> 4 The result might be smaller number than physical cpus especially when ruby process is bound to specific cpus. This is intended for getting better parallel processing. Example: (Linux) linux$ taskset 0x3 ./ruby -retc -e "p Etc.nprocessors" #=> 2;T;0;'@DM;(I",static VALUE etc_nprocessors(VALUE obj) { long ret; #if !defined(_WIN32) #if defined(HAVE_SCHED_GETAFFINITY) && defined(CPU_ALLOC) int ncpus; ncpus = etc_nprocessors_affin(); if (ncpus != -1) { return INT2NUM(ncpus); } /* fallback to _SC_NPROCESSORS_ONLN */ #endif errno = 0; ret = sysconf(_SC_NPROCESSORS_ONLN); if (ret == -1) { rb_sys_fail("sysconf(_SC_NPROCESSORS_ONLN)"); } #else SYSTEM_INFO si; GetSystemInfo(&si); ret = (long)si.dwNumberOfProcessors; #endif return LONG2NUM(ret); };T;)I"static VALUE;T;*To;;T; ;F;;;I"Etc.nprocessors;F;@ÖN;@×N;T;;;0;@ÙN;{;IC;"\Returns the number of online processors. The result is intended as the number of processes to use all available processors. This method is implemented using: - sched_getaffinity(): Linux - sysconf(_SC_NPROCESSORS_ONLN): GNU/Linux, NetBSD, FreeBSD, OpenBSD, DragonFly BSD, OpenIndiana, Mac OS X, AIX Example: require 'etc' p Etc.nprocessors #=> 4 The result might be smaller number than physical cpus especially when ruby process is bound to specific cpus. This is intended for getting better parallel processing. Example: (Linux) linux$ taskset 0x3 ./ruby -retc -e "p Etc.nprocessors" #=> 2;T;[;[;I"^Returns the number of online processors. The result is intended as the number of processes to use all available processors. This method is implemented using: - sched_getaffinity(): Linux - sysconf(_SC_NPROCESSORS_ONLN): GNU/Linux, NetBSD, FreeBSD, OpenBSD, DragonFly BSD, OpenIndiana, Mac OS X, AIX Example: require 'etc' p Etc.nprocessors #=> 4 The result might be smaller number than physical cpus especially when ruby process is bound to specific cpus. This is intended for getting better parallel processing. Example: (Linux) linux$ taskset 0x3 ./ruby -retc -e "p Etc.nprocessors" #=> 2 ;T;0; @áN;!F;"o;#;$T;%ió;&i ;6i;'@DM;(@ßN;)@àN;*To;{;[[@bõi°;F;:Passwd;;};;;[;{;IC;"ÃPasswd Passwd is a Struct that contains the following members: name:: contains the short login name of the user as a String. passwd:: contains the encrypted password of the user as a String. an 'x' is returned if shadow passwords are in use. An '*' is returned if the user cannot log in using a password. uid:: contains the integer user ID (uid) of the user. gid:: contains the integer group ID (gid) of the user's primary group. dir:: contains the path to the home directory of the user as a String. shell:: contains the path to the login shell of the user as a String. === The following members below are optional, and must be compiled with special flags: gecos:: contains a longer String description of the user, such as a full name. Some Unix systems provide structured information in the gecos field, but this is system-dependent. must be compiled with +HAVE_STRUCT_PASSWD_PW_GECOS+ change:: password change time(integer) must be compiled with +HAVE_STRUCT_PASSWD_PW_CHANGE+ quota:: quota value(integer) must be compiled with +HAVE_STRUCT_PASSWD_PW_QUOTA+ age:: password age(integer) must be compiled with +HAVE_STRUCT_PASSWD_PW_AGE+ class:: user access class(string) must be compiled with +HAVE_STRUCT_PASSWD_PW_CLASS+ comment:: comment(string) must be compiled with +HAVE_STRUCT_PASSWD_PW_COMMENT+ expire:: account expiration time(integer) must be compiled with +HAVE_STRUCT_PASSWD_PW_EXPIRE+ ;T;[;[;I"ÄPasswd Passwd is a Struct that contains the following members: name:: contains the short login name of the user as a String. passwd:: contains the encrypted password of the user as a String. an 'x' is returned if shadow passwords are in use. An '*' is returned if the user cannot log in using a password. uid:: contains the integer user ID (uid) of the user. gid:: contains the integer group ID (gid) of the user's primary group. dir:: contains the path to the home directory of the user as a String. shell:: contains the path to the login shell of the user as a String. === The following members below are optional, and must be compiled with special flags: gecos:: contains a longer String description of the user, such as a full name. Some Unix systems provide structured information in the gecos field, but this is system-dependent. must be compiled with +HAVE_STRUCT_PASSWD_PW_GECOS+ change:: password change time(integer) must be compiled with +HAVE_STRUCT_PASSWD_PW_CHANGE+ quota:: quota value(integer) must be compiled with +HAVE_STRUCT_PASSWD_PW_QUOTA+ age:: password age(integer) must be compiled with +HAVE_STRUCT_PASSWD_PW_AGE+ class:: user access class(string) must be compiled with +HAVE_STRUCT_PASSWD_PW_CLASS+ comment:: comment(string) must be compiled with +HAVE_STRUCT_PASSWD_PW_COMMENT+ expire:: account expiration time(integer) must be compiled with +HAVE_STRUCT_PASSWD_PW_EXPIRE+ ;T;0; @éN;!F;"o;#;$T;%i‰;&i¯;'@DM;I"Etc::Passwd;F;~I"Define-const;To;{;[[@bõiÓ;F;;7;;};;;[;{;IC;"pGroup Group is a Struct that is only available when compiled with +HAVE_GETGRENT+. The struct contains the following members: name:: contains the name of the group as a String. passwd:: contains the encrypted password as a String. An 'x' is returned if password access to the group is not available; an empty string is returned if no password is needed to obtain membership of the group. Must be compiled with +HAVE_STRUCT_GROUP_GR_PASSWD+. gid:: contains the group's numeric ID as an integer. mem:: is an Array of Strings containing the short login names of the members of the group. ;T;[;[;I"qGroup Group is a Struct that is only available when compiled with +HAVE_GETGRENT+. The struct contains the following members: name:: contains the name of the group as a String. passwd:: contains the encrypted password as a String. An 'x' is returned if password access to the group is not available; an empty string is returned if no password is needed to obtain membership of the group. Must be compiled with +HAVE_STRUCT_GROUP_GR_PASSWD+. gid:: contains the group's numeric ID as an integer. mem:: is an Array of Strings containing the short login names of the members of the group. ;T;0; @õN;!F;"o;#;$T;%i¾;&iÒ;'@DM;I"Etc::Group;F;~I"Define-const;T;A@DM;BIC;[;A@DM;CIC;[;A@DM;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@bõiN;F;:Etc;;K;;;[;{;IC;";T;[;[;@|;0; @DM;6i;'@;I"Etc;Fo; ;IC;[;A@O;BIC;[;A@O;CIC;[;A@O;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ïi[@ïiu;T;:ZeroDivisionError;;K;;;[;{;IC;"Raised when attempting to divide an integer by 0. 42 / 0 #=> ZeroDivisionError: divided by 0 Note that only division by an exact 0 will raise the exception: 42 / 0.0 #=> Float::INFINITY 42 / -0.0 #=> -Float::INFINITY 0 / 0.0 #=> NaN ;T;[;[;I" Raised when attempting to divide an integer by 0. 42 / 0 #=> ZeroDivisionError: divided by 0 Note that only division by an exact 0 will raise the exception: 42 / 0.0 #=> Float::INFINITY 42 / -0.0 #=> -Float::INFINITY 0 / 0.0 #=> NaN ;T;0; @O;!F;"o;#;$T;%i;&i;'@;I"ZeroDivisionError;F;So;L;M0;N0;O0;;ë;'@;Q@ì;R;Fo; ;IC;[;A@%O;BIC;[;A@%O;CIC;[;A@%O;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ïi[@ïiv;T;:FloatDomainError;;K;;;[;{;IC;"ÃRaised when attempting to convert special float values (in particular +Infinity+ or +NaN+) to numerical classes which don't support them. Float::INFINITY.to_r #=> FloatDomainError: Infinity ;T;[;[;I"Å Raised when attempting to convert special float values (in particular +Infinity+ or +NaN+) to numerical classes which don't support them. Float::INFINITY.to_r #=> FloatDomainError: Infinity ;T;0; @%O;!F;"o;#;$T;%i;&i;'@;I"FloatDomainError;F;So;L;M0;N0;O0;:RangeError;'@;Qo; ;IC;[;A@:O;BIC;[;A@:O;CIC;[;A@:O;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷i– [@÷iô ;T;;;;K;;;[;{;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; @:O;!F;"o;#;$T;%i– ;&iž ;'@;I"RangeError;F;S@ì;R;Fo; ;IC;[ o;;F; ;;;;I"Mutex#initialize;F;[;[[I"thread_sync.c;Tiª;T;;Ð;0;[;{;IC;"Creates a new Mutex ;T;[o;= ;3I" overload;F;40;;î;50;)I"new;T;IC;";T; @PO;>0;!F;[;[;I";T;0;6i;[; @PO;[;I"(Creates a new Mutex @overload new;T;0; @PO;!F;"o;#;$T;%i¤;&i§;'@NO;(I"Cstatic VALUE mutex_initialize(VALUE self) { return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"Mutex#locked?;F;[;[[@UOi¼;T;:locked?;0;[;{;IC;"BReturns +true+ if this lock is currently held by some thread.;T;[o;= ;3I" overload;F;40;;;50;)I"locked?;T;IC;";T; @gO;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @gO;[;I"@return [Boolean];T;0;6i;[; @gO;[;I"jReturns +true+ if this lock is currently held by some thread. @overload locked? @return [Boolean];T;0; @gO;!F;"o;#;$T;%i¶;&iº;6i;'@NO;(I"{VALUE rb_mutex_locked_p(VALUE self) { rb_mutex_t *mutex = mutex_ptr(self); return mutex->fiber ? Qtrue : Qfalse; };T;)I" VALUE;T;*To;;F; ;;;;I"Mutex#try_lock;F;[;[[@UOië;T;: try_lock;0;[;{;IC;"aAttempts to obtain the lock and returns immediately. Returns +true+ if the lock was granted. ;T;[o;= ;3I" overload;F;40;;;50;)I" try_lock;T;IC;";T; @‚O;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @‚O;[;I"@return [Boolean];T;0;6i;[; @‚O;[;I"…Attempts to obtain the lock and returns immediately. Returns +true+ if the lock was granted. @overload try_lock @return [Boolean];T;0; @‚O;!F;"o;#;$T;%iä;&ié;'@NO;(I"VALUE rb_mutex_trylock(VALUE self) { rb_mutex_t *mutex = mutex_ptr(self); if (mutex->fiber == 0) { rb_fiber_t *fiber = GET_EC()->fiber_ptr; rb_thread_t *th = GET_THREAD(); mutex->fiber = fiber; mutex_locked(th, self); return Qtrue; } return Qfalse; };T;)I" VALUE;T;*To;;F; ;;;;I"Mutex#lock;F;[;[[@UOi‘;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;= ;3I" overload;F;40;;;50;)I" lock;T;IC;";T; @O;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @O;[;I"@return [self];T;0;6i;[; @O;[;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; @O;!F;"o;#;$T;%iŠ;&i;'@NO;(I"KVALUE rb_mutex_lock(VALUE self) { return do_mutex_lock(self, 1); };T;)I" VALUE;T;*To;;F; ;;;;I"Mutex#unlock;F;[;[[@UOiÙ;T;:unlock;0;[;{;IC;"\Releases the lock. Raises +ThreadError+ if +mutex+ wasn't locked by the current thread. ;T;[o;= ;3I" overload;F;40;;;50;)I"unlock;T;IC;";T; @¸O;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" self;T; @¸O;[;I"@return [self];T;0;6i;[; @¸O;[;I"{Releases the lock. Raises +ThreadError+ if +mutex+ wasn't locked by the current thread. @overload unlock @return [self];T;0; @¸O;!F;"o;#;$T;%iÒ;&i×;'@NO;(I"VALUE rb_mutex_unlock(VALUE self) { const char *err; rb_mutex_t *mutex = mutex_ptr(self); rb_thread_t *th = GET_THREAD(); err = rb_mutex_unlock_th(mutex, th, GET_EC()->fiber_ptr); if (err) rb_raise(rb_eThreadError, "%s", err); return self; };T;)I" VALUE;T;*To;;F; ;;;;I"Mutex#sleep;F;[[@c0;[[@UOiD;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;= ;3I" overload;F;40;;°;50;)I"sleep(timeout = nil);T;IC;";T; @ÓO;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @ÓO;[;I"@return [Numeric];T;0;6i;[[I"timeout;TI"nil;T; @ÓO;[;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; @ÓO;!F;"o;#;$T;%i6;&iB;'@NO;(I"¸static VALUE mutex_sleep(int argc, VALUE *argv, VALUE self) { VALUE timeout; timeout = rb_check_arity(argc, 0, 1) ? argv[0] : Qnil; return rb_mutex_sleep(self, timeout); };T;)I"static VALUE;T;*To;;F; ;;;;I"Mutex#synchronize;F;[;[[@UOic;T;; ;0;[;{;IC;"tObtains a lock, runs the block, and releases the lock when the block completes. See the example under +Mutex+. ;T;[o;= ;3I" overload;F;40;; ;50;)I"synchronize;T;IC;";T; @òO;>0;!F;[o;2 ;3I" yield;F;4I"[];T;0;50; @òO;[;I"@yield [];T;0;6i;[; @òO;[;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; @òO;!F;"o;#;$T;%i\;&ia;'@NO;(I"Ístatic VALUE rb_mutex_synchronize_m(VALUE self) { if (!rb_block_given_p()) { rb_raise(rb_eThreadError, "must be called with a block"); } return rb_mutex_synchronize(self, rb_yield, Qundef); };T;)I"static VALUE;T;*To;;F; ;;;;I"Mutex#owned?;F;[;[[@UOi;T;;i;0;[;{;IC;"EReturns +true+ if this lock is currently held by current thread.;T;[o;= ;3I" overload;F;40;;i;50;)I"owned?;T;IC;";T; @P;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @P;[;I"@return [Boolean];T;0;6i;[; @P;[;I"lReturns +true+ if this lock is currently held by current thread. @overload owned? @return [Boolean];T;0; @P;!F;"o;#;$T;%i—;&i›;6i;'@NO;(I"¥VALUE rb_mutex_owned_p(VALUE self) { rb_fiber_t *fiber = GET_EC()->fiber_ptr; rb_mutex_t *mutex = mutex_ptr(self); return mutex_owned_p(fiber, mutex); };T;)I" VALUE;T;*T;A@NO;BIC;[;A@NO;CIC;[;A@NO;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@UOiG[@UOi ;T;: Mutex;;K;;;[;{;IC;"OMutex implements a simple semaphore that can be used to coordinate access to shared data from multiple concurrent threads. Example: semaphore = Mutex.new a = Thread.new { semaphore.synchronize { # access shared resource } } b = Thread.new { semaphore.synchronize { # access shared resource } };T;[;[;I"R Mutex implements a simple semaphore that can be used to coordinate access to shared data from multiple concurrent threads. Example: semaphore = Mutex.new a = Thread.new { semaphore.synchronize { # access shared resource } } b = Thread.new { semaphore.synchronize { # access shared resource } } ;T;0; @NO;!F;"o;#;$T;%iG;&i[;6i;'@;I" Mutex;F;S@]o; ;IC;[;A@8P;BIC;[;A@8P;CIC;[;A@8P;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@UOi[@UOi#;T;:ClosedQueueError;;K;;;[;{;IC;"vThe exception class which will be raised when pushing into a closed Queue. See Queue#close and SizedQueue#close. ;T;[;[;I"x The exception class which will be raised when pushing into a closed Queue. See Queue#close and SizedQueue#close. ;T;0; @8P;!F;"o;#;$T;%i;&i;'@;I"ClosedQueueError;F;S@ÒÆo; ;IC;[o;;F; ;;;;I"Queue#initialize;F;[;[[@UOiM;T;;Ð;0;[;{;IC;""Creates a new queue instance. ;T;[;[;I"$ Creates a new queue instance. ;T;0; @NP;!F;"o;#;$T;%iG;&iI;'@LP;(I"¿static VALUE rb_queue_initialize(VALUE self) { struct rb_queue *q = queue_ptr(self); RB_OBJ_WRITE(self, &q->que, ary_buf_new()); list_head_init(queue_waitq(q)); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"Queue#marshal_dump;F;[;[[@UOiö;T;;L;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @\P;!F;"o;#;$T;%iõ;&iõ;'@LP;(I"static VALUE undumpable(VALUE obj) { rb_raise(rb_eTypeError, "can't dump %"PRIsVALUE, rb_obj_class(obj)); UNREACHABLE_RETURN(Qnil); };T;)I"static VALUE;T;*To;;F; ;;;;I"Queue#close;F;[;[[@UOi‚;T;;:;0;[;{;IC;"¨Closes the queue. A closed queue cannot be re-opened. After the call to close completes, the following are true: - +closed?+ will return true - +close+ will be ignored. - calling enq/push/<< will raise a +ClosedQueueError+. - when +empty?+ is false, calling deq/pop/shift will return an object from the queue as usual. - when +empty?+ is true, deq(false) will not suspend the thread and will return nil. deq(true) will raise a +ThreadError+. ClosedQueueError is inherited from StopIteration, so that you can break loop block. Example: q = Queue.new Thread.new{ while e = q.deq # wait for nil to break loop # ... end } q.close ;T;[o;= ;3I" overload;F;40;;:;50;)I" close;T;IC;";T; @jP;>0;!F;[;[;I";T;0;6i;[; @jP;[;I"ºCloses the queue. A closed queue cannot be re-opened. After the call to close completes, the following are true: - +closed?+ will return true - +close+ will be ignored. - calling enq/push/<< will raise a +ClosedQueueError+. - when +empty?+ is false, calling deq/pop/shift will return an object from the queue as usual. - when +empty?+ is true, deq(false) will not suspend the thread and will return nil. deq(true) will raise a +ThreadError+. ClosedQueueError is inherited from StopIteration, so that you can break loop block. Example: q = Queue.new Thread.new{ while e = q.deq # wait for nil to break loop # ... end } q.close @overload close;T;0; @jP;!F;"o;#;$T;%ia;&i};'@LP;(I"Êstatic VALUE rb_queue_close(VALUE self) { struct rb_queue *q = queue_ptr(self); if (!queue_closed_p(self)) { FL_SET(self, QUEUE_CLOSED); wakeup_all(queue_waitq(q)); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"Queue#closed?;F;[;[[@UOi—;T;;8;0;[;{;IC;"+Returns +true+ if the queue is closed.;T;[o;= ;3I" overload;F;40;;8;50;)I"closed?;T;IC;";T; @€P;>0;!F;[;[;I";T;0;6i;[; @€Po;2 ;3I"return;F;4@|;0;5[@~; @€P;[;I"?Returns +true+ if the queue is closed. @overload closed?;T;0; @€P;!F;"o;#;$T;%i;&i“;6i;'@LP;(I"estatic VALUE rb_queue_closed_p(VALUE self) { return queue_closed_p(self) ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Queue#push;F;[[I"obj;T0;[[@UOi§;T;;;0;[;{;IC;",Pushes the given +object+ to the queue. ;T;[o;= ;3I" overload;F;40;;;50;)I"push(object);T;IC;";T; @™P;>0;!F;[;[;I";T;0;6i;[[I"object;T0; @™Po;= ;3I" overload;F;40;:enq;50;)I"enq(object);T;IC;";T; @™P;>0;!F;[;[;I";T;0;6i;[[I"object;T0; @™Po;= ;3I" overload;F;40;;Ý;50;)I"<<(object);T;IC;";T; @™P;>0;!F;[;[;I";T;0;6i;[[I"object;T0; @™P;[;I"pPushes the given +object+ to the queue. @overload push(object) @overload enq(object) @overload <<(object);T;0; o;;F; ;;;;I" Queue#<<;F;[;[[@UOi2;F;;Ý;;K;[;{;@¢P;'@LP;)I"static VALUE;T;(I"pstatic VALUE rb_queue_push(VALUE self, VALUE obj) { return queue_do_push(self, queue_ptr(self), obj); };T;!F;"o;#;$T;%i;&i¢;'@LP;(I"pstatic VALUE rb_queue_push(VALUE self, VALUE obj) { return queue_do_push(self, queue_ptr(self), obj); };T;)@ËP;*To;;F; ;;;;I"Queue#pop;F;[[@c0;[[@UOi;T;;;0;[;{;IC;"ÌRetrieves data from the queue. If the queue is empty, the calling thread is suspended until data is pushed onto the queue. If +non_block+ is true, the thread isn't suspended, and +ThreadError+ is raised. ;T;[o;= ;3I" overload;F;40;;;50;)I"pop(non_block=false);T;IC;";T; @ÏP;>0;!F;[;[;I";T;0;6i;[[I"non_block;TI" false;T; @ÏPo;= ;3I" overload;F;40;:deq;50;)I"deq(non_block=false);T;IC;";T; @ÏP;>0;!F;[;[;I";T;0;6i;[[I"non_block;TI" false;T; @ÏPo;= ;3I" overload;F;40;;¼;50;)I"shift(non_block=false);T;IC;";T; @ÏP;>0;!F;[;[;I";T;0;6i;[[I"non_block;TI" false;T; @ÏP;[;I"-Retrieves data from the queue. If the queue is empty, the calling thread is suspended until data is pushed onto the queue. If +non_block+ is true, the thread isn't suspended, and +ThreadError+ is raised. @overload pop(non_block=false) @overload deq(non_block=false) @overload shift(non_block=false);T;0; o;;F; ;;;;I"Queue#shift;F;[;[[@UOi4;F;;¼;;K;[;{;@×P;'@LP;)I"static VALUE;T;(I"¹static VALUE rb_queue_pop(int argc, VALUE *argv, VALUE self) { int should_block = queue_pop_should_block(argc, argv); return queue_do_pop(self, queue_ptr(self), should_block); };T;!F;"o;#;$T;%i;&i ;'@LP;(I"¹static VALUE rb_queue_pop(int argc, VALUE *argv, VALUE self) { int should_block = queue_pop_should_block(argc, argv); return queue_do_pop(self, queue_ptr(self), should_block); };T;)@Q;*To;;F; ;;;;I"Queue#empty?;F;[;[[@UOi ;T;;±;0;[;{;IC;"*Returns +true+ if the queue is empty.;T;[o;= ;3I" overload;F;40;;±;50;)I"empty?;T;IC;";T; @Q;>0;!F;[;[;I";T;0;6i;[; @Qo;2 ;3I"return;F;4@|;0;5[@~; @Q;[;I"=Returns +true+ if the queue is empty. @overload empty?;T;0; @Q;!F;"o;#;$T;%i;&i;6i;'@LP;(I"xstatic VALUE rb_queue_empty_p(VALUE self) { return queue_length(self, queue_ptr(self)) == 0 ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"Queue#clear;F;[;[[@UOi,;T;;Å;0;[;{;IC;"(Removes all objects from the queue. ;T;[;[;I"* Removes all objects from the queue. ;T;0; @ Q;!F;"o;#;$T;%i&;&i(;'@LP;(I"”static VALUE rb_queue_clear(VALUE self) { struct rb_queue *q = queue_ptr(self); rb_ary_clear(check_array(self, q->que)); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"Queue#length;F;[;[[@UOi>;T;;°;0;[;{;IC;"%Returns the length of the queue. ;T;[o;= ;3I" overload;F;40;;°;50;)I"length;T;IC;";T; @.Q;>0;!F;[;[;I";T;0;6i;[; @.Qo;= ;3I" overload;F;40;;¯;50;)I" size;T;IC;";T; @.Q;>0;!F;[;[;I";T;0;6i;[; @.Q;[;I"GReturns the length of the queue. @overload length @overload size;T;0; o;;F; ;;;;I"Queue#size;F;[;[[@UOi5;F;;¯;;K;[;{;@5Q;'@LP;)I"static VALUE;T;(I"kstatic VALUE rb_queue_length(VALUE self) { return LONG2NUM(queue_length(self, queue_ptr(self))); };T;!F;"o;#;$T;%i5;&i9;'@LP;(I"kstatic VALUE rb_queue_length(VALUE self) { return LONG2NUM(queue_length(self, queue_ptr(self))); };T;)@PQ;*To;;F; ;;;;I"Queue#num_waiting;F;[;[[@UOiJ;T;:num_waiting;0;[;{;IC;"8Returns the number of threads waiting on the queue. ;T;[;[;I": Returns the number of threads waiting on the queue. ;T;0; @TQ;!F;"o;#;$T;%iD;&iF;'@LP;(I"€static VALUE rb_queue_num_waiting(VALUE self) { struct rb_queue *q = queue_ptr(self); return INT2NUM(q->num_waiting); };T;)I"static VALUE;T;*To;;F; ;;;;I"Queue#enq;F;[;[[@UOi1;F;;;;K;[;{;@¢P;'@LP;)@ËP;(I"pstatic VALUE rb_queue_push(VALUE self, VALUE obj) { return queue_do_push(self, queue_ptr(self), obj); };T@ÄPo;;F; ;;;;I"Queue#deq;F;[;[[@UOi3;F;;;;K;[;{;@×P;'@LP;)@Q;(I"¹static VALUE rb_queue_pop(int argc, VALUE *argv, VALUE self) { int should_block = queue_pop_should_block(argc, argv); return queue_do_pop(self, queue_ptr(self), should_block); };T@üP@IQ;A@LP;BIC;[;A@LP;CIC;[;A@LP;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{ @bQ;@ÄP;@jQ;@üP;@IQ;°;I[;[[@UOi$[@UOi;T;: Queue;;K;;;[;{;IC;"—The Queue class implements multi-producer, multi-consumer queues. It is especially useful in threaded programming when information must be exchanged safely between multiple threads. The Queue class implements all the required locking semantics. The class implements FIFO type of queue. In a FIFO queue, the first tasks added are the first retrieved. Example: queue = Queue.new producer = Thread.new do 5.times do |i| sleep rand(i) # simulate expense queue << i puts "#{i} produced" end end consumer = Thread.new do 5.times do |i| value = queue.pop sleep rand(i/2) # simulate expense puts "consumed #{value}" end end consumer.join;T;[;[;I"š The Queue class implements multi-producer, multi-consumer queues. It is especially useful in threaded programming when information must be exchanged safely between multiple threads. The Queue class implements all the required locking semantics. The class implements FIFO type of queue. In a FIFO queue, the first tasks added are the first retrieved. Example: queue = Queue.new producer = Thread.new do 5.times do |i| sleep rand(i) # simulate expense queue << i puts "#{i} produced" end end consumer = Thread.new do 5.times do |i| value = queue.pop sleep rand(i/2) # simulate expense puts "consumed #{value}" end end consumer.join ;T;0; @LP;!F;"o;#;$T;%i$;&iC;6i;'@;I" Queue;F;S@]o; ;IC;[o;;F; ;;;;I"SizedQueue#initialize;F;[[I" vmax;T0;[[@UOib;T;;Ð;0;[;{;IC;"?Creates a fixed-length queue with a maximum size of +max+. ;T;[o;= ;3I" overload;F;40;;î;50;)I" new(max);T;IC;";T; @†Q;>0;!F;[;[;I";T;0;6i;[[I"max;T0; @†Q;[;I"TCreates a fixed-length queue with a maximum size of +max+. @overload new(max);T;0; @†Q;!F;"o;#;$T;%i[;&i^;'@„Q;(I"static VALUE rb_szqueue_initialize(VALUE self, VALUE vmax) { long max; struct rb_szqueue *sq = szqueue_ptr(self); max = NUM2LONG(vmax); if (max <= 0) { rb_raise(rb_eArgError, "queue size must be positive"); } RB_OBJ_WRITE(self, &sq->q.que, ary_buf_new()); list_head_init(szqueue_waitq(sq)); list_head_init(szqueue_pushq(sq)); sq->max = max; return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"SizedQueue#close;F;[;[[@UOi;T;;:;0;[;{;IC;"¾Similar to Queue#close. The difference is behavior with waiting enqueuing threads. If there are waiting enqueuing threads, they are interrupted by raising ClosedQueueError('queue closed'). ;T;[o;= ;3I" overload;F;40;;:;50;)I" close;T;IC;";T; @ Q;>0;!F;[;[;I";T;0;6i;[; @ Q;[;I"ÐSimilar to Queue#close. The difference is behavior with waiting enqueuing threads. If there are waiting enqueuing threads, they are interrupted by raising ClosedQueueError('queue closed'). @overload close;T;0; @ Q;!F;"o;#;$T;%iu;&i};'@„Q;(I"ïstatic VALUE rb_szqueue_close(VALUE self) { if (!queue_closed_p(self)) { struct rb_szqueue *sq = szqueue_ptr(self); FL_SET(self, QUEUE_CLOSED); wakeup_all(szqueue_waitq(sq)); wakeup_all(szqueue_pushq(sq)); } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"SizedQueue#max;F;[;[[@UOi”;T;;?;0;[;{;IC;"+Returns the maximum size of the queue. ;T;[;[;I"- Returns the maximum size of the queue. ;T;0; @¶Q;!F;"o;#;$T;%iŽ;&i;'@„Q;(I"astatic VALUE rb_szqueue_max_get(VALUE self) { return LONG2NUM(szqueue_ptr(self)->max); };T;)I"static VALUE;T;*To;;F; ;;;;I"SizedQueue#max=;F;[[I" vmax;T0;[[@UOi¡;T;: max=;0;[;{;IC;">Sets the maximum size of the queue to the given +number+. ;T;[o;= ;3I" overload;F;40;;";50;)I"max=(number);T;IC;";T; @ÄQ;>0;!F;[;[;I";T;0;6i;[[I"number;T0; @ÄQ;[;I"WSets the maximum size of the queue to the given +number+. @overload max=(number);T;0; @ÄQ;!F;"o;#;$T;%iš;&i;'@„Q;(I"sstatic VALUE rb_szqueue_max_set(VALUE self, VALUE vmax) { long max = NUM2LONG(vmax); long diff = 0; struct rb_szqueue *sq = szqueue_ptr(self); if (max <= 0) { rb_raise(rb_eArgError, "queue size must be positive"); } if (max > sq->max) { diff = max - sq->max; } sq->max = max; sync_wakeup(szqueue_pushq(sq), diff); return vmax; };T;)I"static VALUE;T;*To;;F; ;;;;I"SizedQueue#push;F;[[@c0;[[@UOiÌ;T;;;0;[;{;IC;"ÙPushes +object+ to the queue. If there is no space left in the queue, waits until space becomes available, unless +non_block+ is true. If +non_block+ is true, the thread isn't suspended, and +ThreadError+ is raised. ;T;[o;= ;3I" overload;F;40;;;50;)I""push(object, non_block=false);T;IC;";T; @ÞQ;>0;!F;[;[;I";T;0;6i;[[I"object;T0[I"non_block;TI" false;T; @ÞQo;= ;3I" overload;F;40;;;50;)I"!enq(object, non_block=false);T;IC;";T; @ÞQ;>0;!F;[;[;I";T;0;6i;[[I"object;T0[I"non_block;TI" false;T; @ÞQo;= ;3I" overload;F;40;;Ý;50;)I"<<(object);T;IC;";T; @ÞQ;>0;!F;[;[;I";T;0;6i;[[I"object;T0; @ÞQ;[;I"?Pushes +object+ to the queue. If there is no space left in the queue, waits until space becomes available, unless +non_block+ is true. If +non_block+ is true, the thread isn't suspended, and +ThreadError+ is raised. @overload push(object, non_block=false) @overload enq(object, non_block=false) @overload <<(object);T;0; o;;F; ;;;;I"SizedQueue#<<;F;[;[[@UOiF;F;;Ý;;K;[;{;@æQ;'@„Q;)I"static VALUE;T;(I"ùstatic VALUE rb_szqueue_push(int argc, VALUE *argv, VALUE self) { struct rb_szqueue *sq = szqueue_ptr(self); int should_block = szqueue_push_should_block(argc, argv); while (queue_length(self, &sq->q) >= sq->max) { if (!should_block) { rb_raise(rb_eThreadError, "queue full"); } else if (queue_closed_p(self)) { break; } else { rb_execution_context_t *ec = GET_EC(); COROUTINE_STACK_LOCAL(struct queue_waiter, qw); struct list_head *pushq = szqueue_pushq(sq); qw->w.self = self; qw->w.th = ec->thread_ptr; qw->w.fiber = ec->fiber_ptr; qw->as.sq = sq; list_add_tail(pushq, &qw->w.node); sq->num_waiting_push++; rb_ensure(queue_sleep, self, szqueue_sleep_done, (VALUE)qw); } } if (queue_closed_p(self)) { raise_closed_queue_error(self); } return queue_do_push(self, &sq->q, argv[0]); };T;!F;"o;#;$T;%i¾;&iÇ;'@„Q;(I"ùstatic VALUE rb_szqueue_push(int argc, VALUE *argv, VALUE self) { struct rb_szqueue *sq = szqueue_ptr(self); int should_block = szqueue_push_should_block(argc, argv); while (queue_length(self, &sq->q) >= sq->max) { if (!should_block) { rb_raise(rb_eThreadError, "queue full"); } else if (queue_closed_p(self)) { break; } else { rb_execution_context_t *ec = GET_EC(); COROUTINE_STACK_LOCAL(struct queue_waiter, qw); struct list_head *pushq = szqueue_pushq(sq); qw->w.self = self; qw->w.th = ec->thread_ptr; qw->w.fiber = ec->fiber_ptr; qw->as.sq = sq; list_add_tail(pushq, &qw->w.node); sq->num_waiting_push++; rb_ensure(queue_sleep, self, szqueue_sleep_done, (VALUE)qw); } } if (queue_closed_p(self)) { raise_closed_queue_error(self); } return queue_do_push(self, &sq->q, argv[0]); };T;)@R;*To;;F; ;;;;I"SizedQueue#pop;F;[[@c0;[[@UOi;T;;;0;[;{;IC;"ÌRetrieves data from the queue. If the queue is empty, the calling thread is suspended until data is pushed onto the queue. If +non_block+ is true, the thread isn't suspended, and +ThreadError+ is raised. ;T;[o;= ;3I" overload;F;40;;;50;)I"pop(non_block=false);T;IC;";T; @R;>0;!F;[;[;I";T;0;6i;[[I"non_block;TI" false;T; @Ro;= ;3I" overload;F;40;;;50;)I"deq(non_block=false);T;IC;";T; @R;>0;!F;[;[;I";T;0;6i;[[I"non_block;TI" false;T; @Ro;= ;3I" overload;F;40;;¼;50;)I"shift(non_block=false);T;IC;";T; @R;>0;!F;[;[;I";T;0;6i;[[I"non_block;TI" false;T; @R;[;I"-Retrieves data from the queue. If the queue is empty, the calling thread is suspended until data is pushed onto the queue. If +non_block+ is true, the thread isn't suspended, and +ThreadError+ is raised. @overload pop(non_block=false) @overload deq(non_block=false) @overload shift(non_block=false);T;0; o;;F; ;;;;I"SizedQueue#shift;F;[;[[@UOiH;F;;¼;;K;[;{;@!R;'@„Q;)I"static VALUE;T;(I"¬static VALUE rb_szqueue_pop(int argc, VALUE *argv, VALUE self) { int should_block = queue_pop_should_block(argc, argv); return szqueue_do_pop(self, should_block); };T;!F;"o;#;$T;%iþ;&i;'@„Q;(I"¬static VALUE rb_szqueue_pop(int argc, VALUE *argv, VALUE self) { int should_block = queue_pop_should_block(argc, argv); return szqueue_do_pop(self, should_block); };T;)@MR;*To;;F; ;;;;I"SizedQueue#empty?;F;[;[[@UOiI;T;;±;0;[;{;IC;"*Returns +true+ if the queue is empty.;T;[o;= ;3I" overload;F;40;;±;50;)I"empty?;T;IC;";T; @QR;>0;!F;[;[;I";T;0;6i;[; @QRo;2 ;3I"return;F;4@|;0;5[@~; @QR;[;I"=Returns +true+ if the queue is empty. @overload empty?;T;0; @QR;!F;"o;#;$T;%iB;&iE;6i;'@„Q;(I"œstatic VALUE rb_szqueue_empty_p(VALUE self) { struct rb_szqueue *sq = szqueue_ptr(self); return queue_length(self, &sq->q) == 0 ? Qtrue : Qfalse; };T;)I"static VALUE;T;*To;;F; ;;;;I"SizedQueue#clear;F;[;[[@UOi;T;;Å;0;[;{;IC;"(Removes all objects from the queue. ;T;[;[;I"* Removes all objects from the queue. ;T;0; @jR;!F;"o;#;$T;%i;&i;'@„Q;(I"Ástatic VALUE rb_szqueue_clear(VALUE self) { struct rb_szqueue *sq = szqueue_ptr(self); rb_ary_clear(check_array(self, sq->q.que)); wakeup_all(szqueue_pushq(sq)); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"SizedQueue#length;F;[;[[@UOi,;T;;°;0;[;{;IC;"%Returns the length of the queue. ;T;[o;= ;3I" overload;F;40;;°;50;)I"length;T;IC;";T; @xR;>0;!F;[;[;I";T;0;6i;[; @xRo;= ;3I" overload;F;40;;¯;50;)I" size;T;IC;";T; @xR;>0;!F;[;[;I";T;0;6i;[; @xR;[;I"GReturns the length of the queue. @overload length @overload size;T;0; o;;F; ;;;;I"SizedQueue#size;F;[;[[@UOiI;F;;¯;;K;[;{;@R;'@„Q;)I"static VALUE;T;(I"static VALUE rb_szqueue_length(VALUE self) { struct rb_szqueue *sq = szqueue_ptr(self); return LONG2NUM(queue_length(self, &sq->q)); };T;!F;"o;#;$T;%i#;&i';'@„Q;(I"static VALUE rb_szqueue_length(VALUE self) { struct rb_szqueue *sq = szqueue_ptr(self); return LONG2NUM(queue_length(self, &sq->q)); };T;)@šR;*To;;F; ;;;;I"SizedQueue#num_waiting;F;[;[[@UOi:;T;; ;0;[;{;IC;"8Returns the number of threads waiting on the queue. ;T;[;[;I": Returns the number of threads waiting on the queue. ;T;0; @žR;!F;"o;#;$T;%i4;&i6;'@„Q;(I"¡static VALUE rb_szqueue_num_waiting(VALUE self) { struct rb_szqueue *sq = szqueue_ptr(self); return INT2NUM(sq->q.num_waiting + sq->num_waiting_push); };T;)I"static VALUE;T;*To;;F; ;;;;I"SizedQueue#enq;F;[;[[@UOiE;F;;;;K;[;{;@æQ;'@„Q;)@R;(I"ùstatic VALUE rb_szqueue_push(int argc, VALUE *argv, VALUE self) { struct rb_szqueue *sq = szqueue_ptr(self); int should_block = szqueue_push_should_block(argc, argv); while (queue_length(self, &sq->q) >= sq->max) { if (!should_block) { rb_raise(rb_eThreadError, "queue full"); } else if (queue_closed_p(self)) { break; } else { rb_execution_context_t *ec = GET_EC(); COROUTINE_STACK_LOCAL(struct queue_waiter, qw); struct list_head *pushq = szqueue_pushq(sq); qw->w.self = self; qw->w.th = ec->thread_ptr; qw->w.fiber = ec->fiber_ptr; qw->as.sq = sq; list_add_tail(pushq, &qw->w.node); sq->num_waiting_push++; rb_ensure(queue_sleep, self, szqueue_sleep_done, (VALUE)qw); } } if (queue_closed_p(self)) { raise_closed_queue_error(self); } return queue_do_push(self, &sq->q, argv[0]); };T@Ro;;F; ;;;;I"SizedQueue#deq;F;[;[[@UOiG;F;;;;K;[;{;@!R;'@„Q;)@MR;(I"¬static VALUE rb_szqueue_pop(int argc, VALUE *argv, VALUE self) { int should_block = queue_pop_should_block(argc, argv); return szqueue_do_pop(self, should_block); };T@FR@“R;A@„Q;BIC;[;A@„Q;CIC;[;A@„Q;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{ @¬R;@R;@´R;@FR;@“R;°;I[;[[@UOiR[@UOi ;T;:SizedQueue;;K;;;[;{;IC;"©This class represents queues of specified size capacity. The push operation may be blocked if the capacity is full. See Queue for an example of how a SizedQueue works.;T;[;[;I"« This class represents queues of specified size capacity. The push operation may be blocked if the capacity is full. See Queue for an example of how a SizedQueue works. ;T;0; @„Q;!F;"o;#;$T;%iR;&iW;6i;'@;I"SizedQueue;F;S@]o; ;IC;[ o;;F; ;;;;I"!ConditionVariable#initialize;F;[;[[@UOi£;T;;Ð;0;[;{;IC;"/Creates a new condition variable instance. ;T;[;[;I"1 Creates a new condition variable instance. ;T;0; @ÐR;!F;"o;#;$T;%i;&iŸ;'@ÎR;(I"’static VALUE rb_condvar_initialize(VALUE self) { struct rb_condvar *cv = condvar_ptr(self); list_head_init(&cv->waitq); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"#ConditionVariable#marshal_dump;F;[;[[@UOiö;T;;L;0;[;{;IC;":nodoc: ;T;[;[;@fP;0; @ÞR;!F;"o;#;$T;%iõ;&iõ;'@ÎR;(I"static VALUE undumpable(VALUE obj) { rb_raise(rb_eTypeError, "can't dump %"PRIsVALUE, rb_obj_class(obj)); UNREACHABLE_RETURN(Qnil); };T;)I"static VALUE;T;*To;;F; ;;;;I"ConditionVariable#wait;F;[[@c0;[[@UOiÃ;T;;’;0;[;{;IC;"¿Releases the lock held in +mutex+ and waits; reacquires the lock on wakeup. If +timeout+ is given, this method returns after +timeout+ seconds passed, even if no other thread doesn't signal. ;T;[o;= ;3I" overload;F;40;;’;50;)I"wait(mutex, timeout=nil);T;IC;";T; @ëR;>0;!F;[;[;I";T;0;6i;[[I" mutex;T0[I"timeout;TI"nil;T; @ëR;[;I"äReleases the lock held in +mutex+ and waits; reacquires the lock on wakeup. If +timeout+ is given, this method returns after +timeout+ seconds passed, even if no other thread doesn't signal. @overload wait(mutex, timeout=nil);T;0; @ëR;!F;"o;#;$T;%i¹;&i¿;'@ÎR;(I"static VALUE rb_condvar_wait(int argc, VALUE *argv, VALUE self) { rb_execution_context_t *ec = GET_EC(); struct rb_condvar *cv = condvar_ptr(self); struct sleep_call args; rb_scan_args(argc, argv, "11", &args.mutex, &args.timeout); COROUTINE_STACK_LOCAL(struct sync_waiter, w); w->self = args.mutex; w->th = ec->thread_ptr; w->fiber = ec->fiber_ptr; list_add_tail(&cv->waitq, &w->node); rb_ensure(do_sleep, (VALUE)&args, delete_from_waitq, (VALUE)w); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"ConditionVariable#signal;F;[;[[@UOiÞ;T;:signal;0;[;{;IC;"=Wakes up the first thread in line waiting for this lock. ;T;[;[;I"? Wakes up the first thread in line waiting for this lock. ;T;0; @S;!F;"o;#;$T;%iØ;&iÚ;'@ÎR;(I"Šstatic VALUE rb_condvar_signal(VALUE self) { struct rb_condvar *cv = condvar_ptr(self); wakeup_one(&cv->waitq); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I" ConditionVariable#broadcast;F;[;[[@UOiì;T;:broadcast;0;[;{;IC;"0Wakes up all threads waiting for this lock. ;T;[;[;I"2 Wakes up all threads waiting for this lock. ;T;0; @S;!F;"o;#;$T;%iæ;&iè;'@ÎR;(I"static VALUE rb_condvar_broadcast(VALUE self) { struct rb_condvar *cv = condvar_ptr(self); wakeup_all(&cv->waitq); return self; };T;)I"static VALUE;T;*T;A@ÎR;BIC;[;A@ÎR;CIC;[;A@ÎR;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@UOiX[@UOi;T;:ConditionVariable;;K;;;[;{;IC;"ïConditionVariable objects augment class Mutex. Using condition variables, it is possible to suspend while in the middle of a critical section until a resource becomes available. Example: mutex = Mutex.new resource = ConditionVariable.new a = Thread.new { mutex.synchronize { # Thread 'a' now needs the resource resource.wait(mutex) # 'a' can now have the resource } } b = Thread.new { mutex.synchronize { # Thread 'b' has finished using the resource resource.signal } };T;[;[;I"ñ ConditionVariable objects augment class Mutex. Using condition variables, it is possible to suspend while in the middle of a critical section until a resource becomes available. Example: mutex = Mutex.new resource = ConditionVariable.new a = Thread.new { mutex.synchronize { # Thread 'a' now needs the resource resource.wait(mutex) # 'a' can now have the resource } } b = Thread.new { mutex.synchronize { # Thread 'b' has finished using the resource resource.signal } } ;T;0; @ÎR;!F;"o;#;$T;%iX;&ip;6i;'@;I"ConditionVariable;F;S@]o; ;IC;[ o;;F; ;F;;;I"Warning.[];F;[[I" category;T0;[[@÷iÌ;T;;Â;0;[;{;IC;"5Returns the flag to show the warning messages for +category+. Supported categories are: +:deprecated+ :: deprecation warnings * assignment of non-nil value to $, and $; * keyword arguments * proc/lambda without block etc. +:experimental+ :: experimental features * Pattern matching ;T;[o;= ;3I" overload;F;40;;Â;50;)I"[](category);T;IC;";T; @7S;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @7S;[;I"@return [Boolean];T;0;6i;[[I" category;T0; @7S;[;I"bReturns the flag to show the warning messages for +category+. Supported categories are: +:deprecated+ :: deprecation warnings * assignment of non-nil value to $, and $; * keyword arguments * proc/lambda without block etc. +:experimental+ :: experimental features * Pattern matching @overload [](category) @return [Boolean];T;0; @7S;!F;"o;#;$T;%i»;&iÉ;'@5S;(I"Ûstatic VALUE rb_warning_s_aref(VALUE mod, VALUE category) { rb_warning_category_t cat = rb_warning_category_from_name(category); if (rb_warning_category_enabled_p(cat)) return Qtrue; return Qfalse; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Warning.[]=;F;[[I" category;T0[I" flag;T0;[[@÷iÝ;T;;Ã;0;[;{;IC;"NSets the warning flags for +category+. See Warning.[] for the categories. ;T;[o;= ;3I" overload;F;40;;Ã;50;)I"[]=(category);T;IC;";T; @VS;>0;!F;[;[;I";T;0;6i;[[I" category;T0; @VS;[;I"hSets the warning flags for +category+. See Warning.[] for the categories. @overload []=(category);T;0; @VS;!F;"o;#;$T;%iÕ;&iÙ;'@5S;(I"Ostatic VALUE rb_warning_s_aset(VALUE mod, VALUE category, VALUE flag) { unsigned int mask = rb_warning_category_mask(category); unsigned int disabled = warning_disabled_categories; if (!RTEST(flag)) disabled |= mask; else disabled &= ~mask; warning_disabled_categories = disabled; return flag; };T;)I"static VALUE;T;*To;;F; ;;;;I"Warning#warn;F;[[@c0;[[@÷iõ;T;: warn;0;[;{;IC;"×Writes warning message +msg+ to $stderr. This method is called by Ruby for all emitted warnings. A +category+ may be included with the warning. See the documentation of the Warning module for how to customize this. ;T;[o;= ;3I" overload;F;40;;';50;)I"warn(msg, category: nil);T;IC;";T; @rS;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @rS;[;I"@return [nil];T;0;6i;[[I"msg;T0[I"category:;TI"nil;T; @rS;[;I"Writes warning message +msg+ to $stderr. This method is called by Ruby for all emitted warnings. A +category+ may be included with the warning. See the documentation of the Warning module for how to customize this. @overload warn(msg, category: nil) @return [nil];T;0; @rS;!F;"o;#;$T;%iê;&iò;'@5S;(I"static VALUE rb_warning_s_warn(int argc, VALUE *argv, VALUE mod) { VALUE str; VALUE opt; VALUE category = Qnil; rb_scan_args(argc, argv, "1:", &str, &opt); if (!NIL_P(opt)) rb_get_kwargs(opt, &id_category, 0, 1, &category); Check_Type(str, T_STRING); rb_must_asciicompat(str); if (!NIL_P(category)) { rb_warning_category_t cat = rb_warning_category_from_name(category); if (!rb_warning_category_enabled_p(cat)) return Qnil; } rb_write_error_str(str); return Qnil; };T;)I"static VALUE;T;*To; ;IC;[o;;F; ;;;;I"Warning::buffer#write;F;[[@c0;[[@÷i;T;;é;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @•S;!F;"o;#;$T;%i;&i;'@“S;(I"static VALUE warning_write(int argc, VALUE *argv, VALUE buf) { while (argc-- > 0) { rb_str_append(buf, *argv++); } return buf; };T;)I"static VALUE;T;*T;A@“S;BIC;[;A@“S;CIC;[;A@“S;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷i*;F;:buffer;;K;;;[;{;IC;";T;[;[;@|;0; @“S;6i;'@5S;I"Warning::buffer;F;S@Õ‰;A@5S;BIC;[;A@5S;CIC;[;A@5S;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷i [@÷i#;T;:Warning;;K;;;[;{;IC;"!The Warning module contains a single method named #warn, and the module extends itself, making Warning.warn available. Warning.warn is called for all warnings issued by Ruby. By default, warnings are printed to $stderr. Changing the behavior of Warning.warn is useful to customize how warnings are handled by Ruby, for instance by filtering some warnings, and/or outputting warnings somewhere other than $stderr. If you want to change the behavior of Warning.warn you should use +Warning.extend(MyNewModuleWithWarnMethod)+ and you can use `super` to get the default behavior of printing the warning to $stderr. Example: module MyWarningFilter def warn(message, category: nil, **kwargs) if /some warning I want to ignore/.matches?(message) # ignore else super end end end Warning.extend MyWarningFilter You should never redefine Warning#warn (the instance method), as that will then no longer provide a way to use the default behavior. The +warning+ gem provides convenient ways to customize Warning.warn.;T;[;[;I"# The Warning module contains a single method named #warn, and the module extends itself, making Warning.warn available. Warning.warn is called for all warnings issued by Ruby. By default, warnings are printed to $stderr. Changing the behavior of Warning.warn is useful to customize how warnings are handled by Ruby, for instance by filtering some warnings, and/or outputting warnings somewhere other than $stderr. If you want to change the behavior of Warning.warn you should use +Warning.extend(MyNewModuleWithWarnMethod)+ and you can use `super` to get the default behavior of printing the warning to $stderr. Example: module MyWarningFilter def warn(message, category: nil, **kwargs) if /some warning I want to ignore/.matches?(message) # ignore else super end end end Warning.extend MyWarningFilter You should never redefine Warning#warn (the instance method), as that will then no longer provide a way to use the default behavior. The +warning+ gem provides convenient ways to customize Warning.warn. ;T;0; @5S;!F;"o;#;$T;%i ;&i';6i;'@;I"Warning;Fo; ;IC;[;A@ÅS;BIC;[;A@ÅS;CIC;[;A@ÅS;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷id[@÷i!;T;: Errno;;K;;;[;{;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; @ÅS;!F;"o;#;$T;%id;&i~;'@;I" Errno;F@ìo; ;IC;[o;;F; ;;;;I"SystemExit#initialize;F;[[@c0;[[@÷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;= ;3I" overload;F;40;;î;50;)I"new;T;IC;";T; @ÛS;>0;!F;[;[;I";T;0;6i;[; @ÛSo;= ;3I" overload;F;40;;î;50;)I"new(status);T;IC;";T; @ÛS;>0;!F;[;[;I";T;0;6i;[[I"status;T0; @ÛSo;= ;3I" overload;F;40;;î;50;)I"new(status, msg);T;IC;";T; @ÛS;>0;!F;[;[;I";T;0;6i;[[I"status;T0[I"msg;T0; @ÛSo;= ;3I" overload;F;40;;î;50;)I" new(msg);T;IC;";T; @ÛS;>0;!F;[;[;I";T;0;6i;[[I"msg;T0; @ÛS;[;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; @ÛS;!F;"o;#;$T;%iê;&iò;'@ÙS;(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;)I"static VALUE;T;*To;;F; ;;;;I"SystemExit#status;F;[;[[@÷i(;T;;É;0;[;{;IC;">Return the status value associated with this system exit. ;T;[o;= ;3I" overload;F;40;;É;50;)I"status;T;IC;";T; @T;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @T;[;I"@return [Integer];T;0;6i;[; @T;[;I"eReturn the status value associated with this system exit. @overload status @return [Integer];T;0; @T;!F;"o;#;$T;%i!;&i%;'@ÙS;(I"Tstatic VALUE exit_status(VALUE exc) { return rb_attr_get(exc, id_status); };T;)I"static VALUE;T;*To;;F; ;;;;I"SystemExit#success?;F;[;[[@÷i6;T;;ž;0;[;{;IC;":Returns +true+ if exiting successful, +false+ if not.;T;[o;= ;3I" overload;F;40;;ž;50;)I" success?;T;IC;";T; @-T;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @-T;[;I"@return [Boolean];T;0;6i;[; @-T;[;I"cReturns +true+ if exiting successful, +false+ if not. @overload success? @return [Boolean];T;0; @-T;!F;"o;#;$T;%i/;&i3;6i;'@ÙS;(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;)I"static VALUE;T;*T;A@ÙS;BIC;[;A@ÙS;CIC;[;A@ÙS;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷i, [@÷iã ;T;:SystemExit;;K;;;[;{;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; @ÙS;!F;"o;#;$T;%i, ;&i. ;6i;'@;I"SystemExit;F;S@o; ;IC;[o;;F; ;;;;I"SignalException#initialize;T;[[@c0;[[@ iV;T;;Ð;0;[;{;IC;"XConstruct a new SignalException object. +sig_name+ should be a known signal name. ;T;[o;= ;3I" overload;F;40;;î;50;)I"new(sig_name);T;IC;";T; @\T;>0;!F;[;[;I";T;0;6i;[[I" sig_name;T0; @\To;= ;3I" overload;F;40;;î;50;)I"new(sig_number [, name]);T;IC;";T; @\T;>0;!F;[;[;I";T;0;6i;[[I"sig_number[, name];T0; @\T;[;I"‘ Construct a new SignalException object. +sig_name+ should be a known signal name. @overload new(sig_name) @overload new(sig_number [, name]);T;0; @\T;!F;"o;#;$T;%iM;&iR;'o;L;M0;N0;O0;:SignalException;'@;Q@ZT;R0;(I"static VALUE esignal_init(int argc, VALUE *argv, VALUE self) { int argnum = 1; VALUE sig = Qnil; int signo; if (argc > 0) { sig = rb_check_to_integer(argv[0], "to_int"); if (!NIL_P(sig)) argnum = 2; else sig = argv[0]; } rb_check_arity(argc, 1, argnum); if (argnum == 2) { signo = NUM2INT(sig); if (signo < 0 || signo > NSIG) { rb_raise(rb_eArgError, "invalid signal number (%d)", signo); } if (argc > 1) { sig = argv[1]; } else { sig = rb_signo2signm(signo); } } else { int prefix; signo = signm2signo(&sig, FALSE, FALSE, &prefix); if (prefix != signame_prefix_len) { sig = rb_str_append(rb_str_new_cstr("SIG"), sig); } } rb_call_super(1, &sig); rb_ivar_set(self, id_signo, INT2NUM(signo)); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"SignalException#signo;F;[;[[@ iƒ;T;: signo;0;[;{;IC;"Returns a signal number. ;T;[o;= ;3I" overload;F;40;;-;50;)I" signo;T;IC;";T; @€T;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @€T;[;I"@return [Numeric];T;0;6i;[; @€T;[;I"D Returns a signal number. @overload signo @return [Numeric];T;0; @€T;!F;"o;#;$T;%i|;&i€;'@ZT;(I"Wstatic VALUE esignal_signo(VALUE self) { return rb_ivar_get(self, id_signo); };T;)I"static VALUE;T;*T;A@ZT;BIC;[;A@ZT;CIC;[;A@ZT;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷i2 [@÷ié ;T;;,;;K;;;[;{;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; @ZT;!F;"o;#;$T;%i2 ;&i? ;6i;'@;I"SignalException;F;S@o; ;IC;[o;;F; ;;;;I"Interrupt#initialize;F;[[@c0;[[@ iŠ;T;;Ð;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @¯T;!F;"o;#;$T;%i‰;&i‰;'@T;(I"Óstatic VALUE interrupt_init(int argc, VALUE *argv, VALUE self) { VALUE args[2]; args[0] = INT2FIX(SIGINT); args[1] = rb_check_arity(argc, 0, 1) ? argv[0] : Qnil; return rb_call_super(2, args); };T;)I"static VALUE;T;*T;A@T;BIC;[;A@T;CIC;[;A@T;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷iC [@÷iê ;T;:Interrupt;;K;;;[;{;IC;"Raised when the interrupt signal is received, typically because the user has pressed 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 when the interrupt signal is received, typically because the user has pressed 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; @T;!F;"o;#;$T;%iC ;&iV ;6i;'@;I"Interrupt;F;S@ZTo; ;IC;[;A@ÐT;BIC;[;A@ÐT;CIC;[;A@ÐT;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷iZ [@÷ií ;T;:TypeError;;K;;;[;{;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; @ÐT;!F;"o;#;$T;%iZ ;&ic ;'@;I"TypeError;F;S@ìo; ;IC;[;A@äT;BIC;[;A@äT;CIC;[;A@äT;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷ig [@÷iî ;T;:ArgumentError;;K;;;[;{;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; @äT;!F;"o;#;$T;%ig ;&iz ;'@;I"ArgumentError;F;S@ì@ýÆo; ;IC;[o;;F; ;;;;I"KeyError#initialize;F;[[@c0;[[@÷i9;T;;Ð;0;[;{;IC;"SConstruct a new +KeyError+ exception with the given message, receiver and key. ;T;[o;= ;3I" overload;F;40;;î;50;)I".new(message=nil, receiver: nil, key: nil);T;IC;";T; @úT;>0;!F;[;[;I";T;0;6i;[[I"message;TI"nil;T[I"receiver:;TI"nil;T[I" key:;TI"nil;T; @úT;[;I"„Construct a new +KeyError+ exception with the given message, receiver and key. @overload new(message=nil, receiver: nil, key: nil);T;0; @úT;!F;"o;#;$T;%i1;&i5;'@øT;(I"static VALUE key_err_initialize(int argc, VALUE *argv, VALUE self) { VALUE options; rb_call_super(rb_scan_args(argc, argv, "01:", NULL, &options), argv); if (!NIL_P(options)) { ID keywords[2]; VALUE values[numberof(keywords)]; int i; keywords[0] = id_receiver; keywords[1] = id_key; rb_get_kwargs(options, keywords, 0, numberof(values), values); for (i = 0; i < numberof(values); ++i) { if (values[i] != Qundef) { rb_ivar_set(self, keywords[i], values[i]); } } } return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"KeyError#receiver;F;[;[[@÷i;T;: receiver;0;[;{;IC;"AReturn the receiver associated with this KeyError exception. ;T;[o;= ;3I" overload;F;40;;1;50;)I" receiver;T;IC;";T; @U;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @U;[;I"@return [Object];T;0;6i;[; @U;[;I"iReturn the receiver associated with this KeyError exception. @overload receiver @return [Object];T;0; @U;!F;"o;#;$T;%i;&i;'@øT;(I"Ñstatic VALUE key_err_receiver(VALUE self) { VALUE recv; recv = rb_ivar_lookup(self, id_receiver, Qundef); if (recv != Qundef) return recv; rb_raise(rb_eArgError, "no receiver is available"); };T;)I"static VALUE;T;*To;;F; ;;;;I"KeyError#key;F;[;[[@÷i;T;;®;0;[;{;IC;"3Return the key caused this KeyError exception. ;T;[o;= ;3I" overload;F;40;;®;50;)I"key;T;IC;";T; @5U;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @5U;[;I"@return [Object];T;0;6i;[; @5U;[;I"VReturn the key caused this KeyError exception. @overload key @return [Object];T;0; @5U;!F;"o;#;$T;%i;&i;'@øT;(I"¾static VALUE key_err_key(VALUE self) { VALUE key; key = rb_ivar_lookup(self, id_key, Qundef); if (key != Qundef) return key; rb_raise(rb_eArgError, "no key is available"); };T;)I"static VALUE;T;*T;A@øT;BIC;[;A@øT;CIC;[;A@øT;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷iŠ [@÷ið ;T;: KeyError;;K;;;[;{;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; @øT;!F;"o;#;$T;%iŠ ;&i’ ;6i;'@;I" KeyError;F;S@ýÆ@:Oo; ;IC;[;A@bU;BIC;[;A@bU;CIC;[;A@bU;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷i¢ [@÷iö ;T;:ScriptError;;K;;;[;{;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; @bU;!F;"o;#;$T;%i¢ ;&i© ;'@;I"ScriptError;F;S@o; ;IC;[o;;F; ;;;;I"SyntaxError#initialize;F;[[@c0;[[@÷iX;T;;Ð;0;[;{;IC;"'Construct a SyntaxError exception. ;T;[o;= ;3I" overload;F;40;;î;50;)I"new([msg]);T;IC;";T; @xU;>0;!F;[;[;I";T;0;6i;[[I" [msg];T0; @xU;[;I">Construct a SyntaxError exception. @overload new([msg]);T;0; @xU;!F;"o;#;$T;%iQ;&iT;'@vU;(I"ßstatic VALUE syntax_error_initialize(int argc, VALUE *argv, VALUE self) { VALUE mesg; if (argc == 0) { mesg = rb_fstring_lit("compile error"); argc = 1; argv = &mesg; } return rb_call_super(argc, argv); };T;)I"static VALUE;T;*T;A@vU;BIC;[;A@vU;CIC;[;A@vU;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷i [@÷i÷ ;T;:SyntaxError;;K;;;[;{;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; @vU;!F;"o;#;$T;%i ;&iµ ;6i;'@;I"SyntaxError;F;S@bUo; ;IC;[;A@£U;BIC;[;A@£U;CIC;[;A@£U;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷i¹ [@÷iú ;T;:LoadError;;K;;;[;{;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; @£U;!F;"o;#;$T;%i¹ ;&iÂ ;'@;I"LoadError;F;S@bUo; ;IC;[;A@·U;BIC;[;A@·U;CIC;[;A@·U;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷iÆ [@÷iþ ;T;:NotImplementedError;;K;;;[;{;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; @·U;!F;"o;#;$T;%iÆ ;&iÎ ;'@;I"NotImplementedError;F;S@bUo; ;IC;[ o; ;IC;[ o;;F; ;;;;I"'NameError::message#initialize_copy;F;[[I" obj2;T0;[[@÷iV;T;;g;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @ÏU;!F;"o;#;$T;%iU;&iU;'@ÍU;(I"rstatic VALUE name_err_mesg_init_copy(VALUE obj1, VALUE obj2) { VALUE *ptr1, *ptr2; if (obj1 == obj2) return obj1; rb_obj_init_copy(obj1, obj2); TypedData_Get_Struct(obj1, VALUE, &name_err_mesg_data_type, ptr1); TypedData_Get_Struct(obj2, VALUE, &name_err_mesg_data_type, ptr2); MEMCPY(ptr1, ptr2, VALUE, NAME_ERR_MESG_COUNT); return obj1; };T;)I"static VALUE;T;*To;;F; ;;;;I"NameError::message#==;F;[[I" obj2;T0;[[@÷ie;T;;`;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @ßU;!F;"o;#;$T;%id;&id;'@ÍU;(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 0 && RSTRING_PTR(d)[0] == '#'); break; } if (!singleton) { s = FAKE_CSTR(&s_str, ":"); c = rb_class_name(CLASS_OF(obj)); } else { c = s = FAKE_CSTR(&s_str, ""); } args[0] = 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;)I"static VALUE;T;*To;;F; ;;;;I"NameError::message#_dump;F;[[I" limit;T0;[[@÷i½;T;;î;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @ýU;!F;"o;#;$T;%i¼;&i¼;'@ÍU;(I"fstatic VALUE name_err_mesg_dump(VALUE obj, VALUE limit) { return name_err_mesg_to_str(obj); };T;)I"static VALUE;T;*To;;F; ;F;;;I"NameError::message._load;F;[[I"str;T0;[[@÷iÄ;T;;Ø;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @ V;!F;"o;#;$T;%iÃ;&iÃ;'@ÍU;(I"Pstatic VALUE name_err_mesg_load(VALUE klass, VALUE str) { return str; };T;)I"static VALUE;T;*T;A@ÍU;BIC;[;A@ÍU;CIC;[;A@ÍU;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷i= [@÷i;T;;ï;;K;;;[;{;IC;":nodoc:;T;[;[;I" :nodoc: ;T;0; @ÍU;!F;"o;#;$T;%i= ;&i> ;6i;'o;L;M0;N0;O0;;ã;'@;Q@ËU;R0;I"NameError::message;F;S@]o;;F; ;;;;I"NameError#initialize;F;[[@c0;[[@÷i§;T;;Ð;0;[;{;IC;"‘Construct a new NameError exception. If given the name parameter may subsequently be examined using the NameError#name method. receiver parameter allows to pass object in context of which the error happened. Example: [1, 2, 3].method(:rject) # NameError with name "rject" and receiver: Array [1, 2, 3].singleton_method(:rject) # NameError with name "rject" and receiver: [1, 2, 3] ;T;[o;= ;3I" overload;F;40;;î;50;)I"*new(msg=nil, name=nil, receiver: nil);T;IC;";T; @0V;>0;!F;[;[;I";T;0;6i;[[I"msg;TI"nil;T[I" name;TI"nil;T[I"receiver:;TI"nil;T; @0V;[;I"ÃConstruct a new NameError exception. If given the name parameter may subsequently be examined using the NameError#name method. receiver parameter allows to pass object in context of which the error happened. Example: [1, 2, 3].method(:rject) # NameError with name "rject" and receiver: Array [1, 2, 3].singleton_method(:rject) # NameError with name "rject" and receiver: [1, 2, 3] @overload new(msg=nil, name=nil, receiver: nil);T;0; @0V;!F;"o;#;$T;%iš;&i£;'@ËU;(I"ºstatic VALUE name_err_initialize(int argc, VALUE *argv, VALUE self) { ID keywords[1]; VALUE values[numberof(keywords)], name, options; argc = rb_scan_args(argc, argv, "*:", NULL, &options); keywords[0] = id_receiver; rb_get_kwargs(options, keywords, 0, numberof(values), values); name = (argc > 1) ? argv[--argc] : Qnil; rb_call_super(argc, argv); name_err_init_attr(self, values[0], name); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"NameError#name;F;[;[[@÷iÍ;T;;Ñ;0;[;{;IC;">Return the name associated with this NameError exception. ;T;[o;= ;3I" overload;F;40;;Ñ;50;)I" name;T;IC;";T; @PV;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @PV;[;I"@return [String, nil];T;0;6i;[; @PV;[;I"gReturn the name associated with this NameError exception. @overload name @return [String, nil];T;0; @PV;!F;"o;#;$T;%iÆ;&iÊ;'@ËU;(I"Vstatic VALUE name_err_name(VALUE self) { return rb_attr_get(self, id_name); };T;)I"static VALUE;T;*To;;F; ;;;;I"NameError#receiver;F;[;[[@÷iÑ;T;;1;0;[;{;IC;"BReturn the receiver associated with this NameError exception. ;T;[o;= ;3I" overload;F;40;;1;50;)I" receiver;T;IC;";T; @lV;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @lV;[;I"@return [Object];T;0;6i;[; @lV;[;I"jReturn the receiver associated with this NameError exception. @overload receiver @return [Object];T;0; @lV;!F;"o;#;$T;%iÊ;&iÎ;'@ËU;(I"ˆstatic VALUE name_err_receiver(VALUE self) { VALUE *ptr, recv, mesg; recv = rb_ivar_lookup(self, id_recv, 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;)I"static VALUE;T;*To;;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;= ;3I" overload;F;40;;Æ;50;)I"local_variables;T;IC;";T; @‡V;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @‡V;[;I"@return [Array];T;0;6i;[; @‡V;[;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; @‡V;!F;"o;#;$T;%iÓ;&iÚ;'@ËU;(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;)I"static VALUE;T;*T;A@ËU;BIC;[;A@ËU;CIC;[;A@ËU;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷iÒ [@÷i;T;;ã;;K;;;[;{;IC;"CRaised 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: Integer.const_set :answer, 42 raises the exception: NameError: wrong constant name answer;T;[;[;I"E 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: Integer.const_set :answer, 42 raises the exception: NameError: wrong constant name answer ;T;0; @ËU;!F;"o;#;$T;%iÒ ;&iâ ;6i;'@;I"NameError;F;S@ìo; ;IC;[o;;F; ;;;;I"NoMethodError#initialize;F;[[@c0;[[@÷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. If private argument were passed, it designates method was attempted to call in private context, and can be accessed with #private_call? method. receiver argument stores an object whose method was called. ;T;[o;= ;3I" overload;F;40;;î;50;)I"Cnew(msg=nil, name=nil, args=nil, private=false, receiver: nil);T;IC;";T; @¶V;>0;!F;[;[;I";T;0;6i;[ [I"msg;TI"nil;T[I" name;TI"nil;T[I" args;TI"nil;T[I"private;TI" false;T[I"receiver:;TI"nil;T; @¶V;[;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. If private argument were passed, it designates method was attempted to call in private context, and can be accessed with #private_call? method. receiver argument stores an object whose method was called. @overload new(msg=nil, name=nil, args=nil, private=false, receiver: nil);T;0; @¶V;!F;"o;#;$T;%ió;&iÿ;'@´V;(I"static VALUE nometh_err_initialize(int argc, VALUE *argv, VALUE self) { int priv; VALUE args, options; argc = rb_scan_args(argc, argv, "*:", NULL, &options); priv = (argc > 3) && (--argc, RTEST(argv[argc])); args = (argc > 2) ? argv[--argc] : Qnil; if (!NIL_P(options)) argv[argc++] = options; rb_call_super_kw(argc, argv, RB_PASS_CALLED_KEYWORDS); return nometh_err_init_attr(self, args, priv); };T;)I"static VALUE;T;*To;;F; ;;;;I"NoMethodError#args;F;[;[[@÷ié;T;: args;0;[;{;IC;"NReturn the arguments passed in as the third parameter to the constructor. ;T;[o;= ;3I" overload;F;40;;7;50;)I" args;T;IC;";T; @ÜV;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @ÜV;[;I"@return [Object];T;0;6i;[; @ÜV;[;I"rReturn the arguments passed in as the third parameter to the constructor. @overload args @return [Object];T;0; @ÜV;!F;"o;#;$T;%iá;&iæ;'@´V;(I"Xstatic VALUE nometh_err_args(VALUE self) { return rb_attr_get(self, id_args); };T;)I"static VALUE;T;*To;;F; ;;;;I" NoMethodError#private_call?;F;[;[[@÷iö;T;:private_call?;0;[;{;IC;"0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @÷V;[;I"@return [Boolean];T;0;6i;[; @÷V;[;I"jReturn true if the caused method was called as private. @overload private_call? @return [Boolean];T;0; @÷V;!F;"o;#;$T;%iï;&ió;6i;'@´V;(I"lstatic VALUE nometh_err_private_call_p(VALUE self) { return rb_attr_get(self, id_private_call_p); };T;)I"static VALUE;T;*T;A@´V;BIC;[;A@´V;CIC;[;A@´V;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷iæ [@÷i;T;:NoMethodError;;K;;;[;{;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; @´V;!F;"o;#;$T;%iæ ;&iï ;6i;'@;I"NoMethodError;F;S@ËUo; ;IC;[o;;F; ;;;;I"FrozenError#initialize;F;[[@c0;[[@÷iX;T;;Ð;0;[;{;IC;"æConstruct a new FrozenError exception. If given the receiver parameter may subsequently be examined using the FrozenError#receiver method. a = [].freeze raise FrozenError.new("can't modify frozen array", receiver: a) ;T;[o;= ;3I" overload;F;40;;î;50;)I" new(msg=nil, receiver: nil);T;IC;";T; @&W;>0;!F;[;[;I";T;0;6i;[[I"msg;TI"nil;T[I"receiver:;TI"nil;T; @&W;[;I"Construct a new FrozenError exception. If given the receiver parameter may subsequently be examined using the FrozenError#receiver method. a = [].freeze raise FrozenError.new("can't modify frozen array", receiver: a) @overload new(msg=nil, receiver: nil);T;0; @&W;!F;"o;#;$T;%iL;&iT;'@$W;(I"~static VALUE frozen_err_initialize(int argc, VALUE *argv, VALUE self) { ID keywords[1]; VALUE values[numberof(keywords)], options; argc = rb_scan_args(argc, argv, "*:", NULL, &options); keywords[0] = id_receiver; rb_get_kwargs(options, keywords, 0, numberof(values), values); rb_call_super(argc, argv); err_init_recv(self, values[0]); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"FrozenError#receiver;F;[;[;F;;1;;K;[;{;IC;"DReturn the receiver associated with this FrozenError exception. ;T;[o;= ;3I" overload;F;40;;1;50;)I" receiver;T;IC;";T; @CW;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @CW;[;I"@return [Object];T;0;6i;[; @CW;[;I"lReturn the receiver associated with this FrozenError exception. @overload receiver @return [Object];T;0; @CW;!F;"o;#;$T;%if;&ij;'@$W;*T;A@$W;BIC;[;A@$W;CIC;[;A@$W;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷ió [@÷i;T;:FrozenError;;K;;;[;{;IC;"ŸRaised when there is an attempt to modify a frozen object. [1, 2, 3].freeze << 4 raises the exception: FrozenError: can't modify frozen Array;T;[;[;I"¡ Raised when there is an attempt to modify a frozen object. [1, 2, 3].freeze << 4 raises the exception: FrozenError: can't modify frozen Array ;T;0; @$W;!F;"o;#;$T;%ió ;&iû ;6i;'@;I"FrozenError;F;So; ;IC;[;A@mW;BIC;[;A@mW;CIC;[;A@mW;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷iÿ [@÷i;T;:RuntimeError;;K;;;[;{;IC;"×A generic error class raised when an invalid operation is attempted. 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. Kernel#raise will raise a RuntimeError if no Exception class is specified. raise "ouch" raises the exception: RuntimeError: ouch ;T;0; @mW;!F;"o;#;$T;%iÿ ;&i ;'@;I"RuntimeError;F;S@ì@mWo; ;IC;[;A@W;BIC;[;A@W;CIC;[;A@W;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷i [@÷i;T;:SecurityError;;K;;;[;{;IC;"%No longer used by internal code. ;T;[;[;I"' No longer used by internal code. ;T;0; @W;!F;"o;#;$T;%i ;&i ;'@;I"SecurityError;F;S@o; ;IC;[;A@•W;BIC;[;A@•W;CIC;[;A@•W;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷i [@÷i;T;:NoMemoryError;;K;;;[;{;IC;")Raised when memory allocation fails. ;T;[;[;I"+ Raised when memory allocation fails. ;T;0; @•W;!F;"o;#;$T;%i ;&i ;'@;I"NoMemoryError;F;S@o; ;IC;[o;;F; ;;;;I"SystemCallError#initialize;F;[[@c0;[[@÷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;= ;3I" overload;F;40;;î;50;)I"new(msg, errno);T;IC;";T; @«W;>0;!F;[;[;I";T;0;6i;[[I"msg;T0[I" errno;T0; @«W;[;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; @«W;!F;"o;#;$T;%i´;&iº;'@©W;(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); } mesg = errmsg; rb_call_super(1, &mesg); rb_ivar_set(self, id_errno, error); return self; };T;)I"static VALUE;T;*To;;F; ;;;;I"SystemCallError#errno;F;[;[[@÷ió;T;: errno;0;[;{;IC;"0Return this SystemCallError's error number. ;T;[o;= ;3I" overload;F;40;;>;50;)I" errno;T;IC;";T; @ÆW;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ÆW;[;I"@return [Integer];T;0;6i;[; @ÆW;[;I"VReturn this SystemCallError's error number. @overload errno @return [Integer];T;0; @ÆW;!F;"o;#;$T;%iì;&ið;'@©W;(I"Vstatic VALUE syserr_errno(VALUE self) { return rb_attr_get(self, id_errno); };T;)I"static VALUE;T;*To;;F; ;F;;;I"SystemCallError.===;F;[[I"exc;T0;[[@÷i ;T;;\;0;[;{;IC;"{Return +true+ if the receiver is a generic +SystemCallError+, or if the error numbers +self+ and _other_ are the same. ;T;[o;= ;3I" overload;F;40;;\;50;)I"===(other);T;IC;";T; @áW;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @áW;[;I"@return [Boolean];T;0;6i;[[I" other;T0; @áW;[;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; @áW;!F;"o;#;$T;%iù;&iþ;'@©W;(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;)I"static VALUE;T;*T;A@©W;BIC;[;A@©W;CIC;[;A@©W;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷i [@÷i;T;:SystemCallError;;K;;;[;{;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; @©W;!F;"o;#;$T;%i ;&i% ;6i;'@;I"SystemCallError;F;S@ì@^¥o; ;IC;[;A@X;BIC;[;A@X;CIC;[;A@X;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷i6 [@÷iè ;T;: fatal;;K;;;[;{;IC;"`fatal is an Exception that is raised when Ruby has encountered a fatal error and must exit. ;T;[;[;I"b fatal is an Exception that is raised when Ruby has encountered a fatal error and must exit. ;T;0; @X;!F;"o;#;$T;%i6 ;&i9 ;'@;I" fatal;F;S@@o; ;IC;[;A@&X;BIC;[;A@&X;CIC;[;A@&X;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷i;F;:NoMatchingPatternError;;K;;;[;{;IC;";T;[;[;@|;0; @&X;'@;I"NoMatchingPatternError;F;S@ìo; ;IC;[o;;F; ;;;;I"Random#initialize_copy;F;[[I" orig;T0;[[@yiÀ;T;;g;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @9X;!F;"o;#;$T;%i¿;&i¿;'@7X;(I"Istatic VALUE rand_mt_copy(VALUE obj, VALUE orig) { rb_random_mt_t *rnd1, *rnd2; struct MT *mt; if (!OBJ_INIT_COPY(obj, orig)) return obj; rnd1 = get_rnd_mt(obj); rnd2 = get_rnd_mt(orig); mt = &rnd1->mt; *rnd1 = *rnd2; mt->next = mt->state + numberof(mt->state) - mt->left + 1; return obj; };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Random#marshal_dump;F;[;[[@yiø;T;;L;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @IX;!F;"o;#;$T;%i÷;&i÷;'@7X;(I" static VALUE rand_mt_dump(VALUE obj) { rb_random_mt_t *rnd = rb_check_typeddata(obj, &random_mt_type); VALUE dump = rb_ary_new2(3); rb_ary_push(dump, mt_state(&rnd->mt)); rb_ary_push(dump, INT2FIX(rnd->mt.left)); rb_ary_push(dump, rnd->base.seed); return dump; };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Random#marshal_load;F;[[I" dump;T0;[[@yi;T;;M;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @WX;!F;"o;#;$T;%i;&i;'@7X;(I"½static VALUE rand_mt_load(VALUE obj, VALUE dump) { rb_random_mt_t *rnd = rb_check_typeddata(obj, &random_mt_type); struct MT *mt = &rnd->mt; VALUE state, left = INT2FIX(1), seed = INT2FIX(0); unsigned long x; rb_check_copyable(obj, dump); Check_Type(dump, T_ARRAY); switch (RARRAY_LEN(dump)) { case 3: seed = RARRAY_AREF(dump, 2); case 2: left = RARRAY_AREF(dump, 1); case 1: state = RARRAY_AREF(dump, 0); break; default: rb_raise(rb_eArgError, "wrong dump data"); } rb_integer_pack(state, mt->state, numberof(mt->state), sizeof(*mt->state), 0, INTEGER_PACK_LSWORD_FIRST|INTEGER_PACK_NATIVE_BYTE_ORDER); x = NUM2ULONG(left); if (x > numberof(mt->state)) { rb_raise(rb_eArgError, "wrong value"); } mt->left = (unsigned int)x; mt->next = mt->state + numberof(mt->state) - x + 1; rnd->base.seed = rb_to_int(seed); return obj; };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Random#state;F;[;[[@yiÚ;T;;1;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @gX;!F;"o;#;$T;%iÙ;&iÙ;'@7X;(I"xstatic VALUE rand_mt_state(VALUE obj) { rb_random_mt_t *rnd = get_rnd_mt(obj); return mt_state(&rnd->mt); };T;)I"static VALUE;T;*To;;F; ;;;Ï;I"Random#left;F;[;[[@yié;T;: left;0;[;{;IC;":nodoc: ;T;[;[;I":nodoc:;T;0; @uX;!F;"o;#;$T;%iè;&iè;'@7X;(I"zstatic VALUE rand_mt_left(VALUE obj) { rb_random_mt_t *rnd = get_rnd_mt(obj); return INT2FIX(rnd->mt.left); };T;)I"static VALUE;T;*To;;F; ;;;;I"Random#==;F;[[I" other;T0;[[@yiå;T;;`;0;[;{;IC;"lReturns true if the two generators have the same internal state, otherwise false. Equivalent generators will return the same sequence of pseudo-random numbers. Two generators will generally have the same state only if they were initialized with the same seed Random.new == Random.new # => false Random.new(1234) == Random.new(1234) # => true and have the same invocation history. prng1 = Random.new(1234) prng2 = Random.new(1234) prng1 == prng2 # => true prng1.rand # => 0.1915194503788923 prng1 == prng2 # => false prng2.rand # => 0.1915194503788923 prng1 == prng2 # => true ;T;[o;= ;3I" overload;F;40;;`;50;)I"==(prng2);T;IC;";T; @ƒX;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @ƒX;[;I"@return [Boolean];T;0;6i;[[I" prng2;T0; @ƒX;[;I"–Returns true if the two generators have the same internal state, otherwise false. Equivalent generators will return the same sequence of pseudo-random numbers. Two generators will generally have the same state only if they were initialized with the same seed Random.new == Random.new # => false Random.new(1234) == Random.new(1234) # => true and have the same invocation history. prng1 = Random.new(1234) prng2 = Random.new(1234) prng1 == prng2 # => true prng1.rand # => 0.1915194503788923 prng1 == prng2 # => false prng2.rand # => 0.1915194503788923 prng1 == prng2 # => true @overload ==(prng2) @return [Boolean];T;0; @ƒX;!F;"o;#;$T;%iÍ;&iã;'@7X;(I"Ùstatic VALUE rand_mt_equal(VALUE self, VALUE other) { rb_random_mt_t *r1, *r2; if (rb_obj_class(self) != rb_obj_class(other)) return Qfalse; r1 = get_rnd_mt(self); r2 = get_rnd_mt(other); if (memcmp(r1->mt.state, r2->mt.state, sizeof(r1->mt.state))) return Qfalse; if ((r1->mt.next - r1->mt.state) != (r2->mt.next - r2->mt.state)) return Qfalse; if (r1->mt.left != r2->mt.left) return Qfalse; return rb_equal(r1->base.seed, r2->base.seed); };T;)I"static VALUE;T;*To;;F; ;;;;I"Random#initialize;F;[[@c0;[[@yi;T;;Ð;0;[;{;IC;"ÄCreates a new PRNG using +seed+ to set the initial state. If +seed+ is omitted, the generator is initialized with Random.new_seed. See Random.srand for more information on the use of seed values. ;T;[o;= ;3I" overload;F;40;;î;50;)I" new(seed = Random.new_seed);T;IC;";T; @¢X;>0;!F;[;[;I";T;0;6i;[[I" seed;TI"Random.new_seed;T; @¢X;[;I"ìCreates a new PRNG using +seed+ to set the initial state. If +seed+ is omitted, the generator is initialized with Random.new_seed. See Random.srand for more information on the use of seed values. @overload new(seed = Random.new_seed);T;0; @¢X;!F;"o;#;$T;%i„;&iŠ;'@7X;(I"static VALUE random_init(int argc, VALUE *argv, VALUE obj) { rb_random_t *rnd = try_get_rnd(obj); const rb_random_interface_t *rng = rb_rand_if(obj); if (!rng) { rb_raise(rb_eTypeError, "undefined random interface: %s", RTYPEDDATA_TYPE(obj)->wrap_struct_name); } argc = rb_check_arity(argc, 0, 1); rb_check_frozen(obj); if (argc == 0) { rnd->seed = rand_init_default(rng, rnd); } else { rnd->seed = rand_init(rng, rnd, rb_to_int(argv[0])); } return obj; };T;)I"static VALUE;T;*To;;F; ;;;;I"Random#rand;F;[[@c0;[[@yi”;T;;¾;0;[;{;IC;"‡When +max+ is an Integer, +rand+ returns a random integer greater than or equal to zero and less than +max+. Unlike Kernel.rand, when +max+ is a negative integer or zero, +rand+ raises an ArgumentError. prng = Random.new prng.rand(100) # => 42 When +max+ is a Float, +rand+ returns a random floating point number between 0.0 and +max+, including 0.0 and excluding +max+. prng.rand(1.5) # => 1.4600282860034115 When +max+ is a Range, +rand+ returns a random number where range.member?(number) == true. prng.rand(5..9) # => one of [5, 6, 7, 8, 9] prng.rand(5...9) # => one of [5, 6, 7, 8] prng.rand(5.0..9.0) # => between 5.0 and 9.0, including 9.0 prng.rand(5.0...9.0) # => between 5.0 and 9.0, excluding 9.0 Both the beginning and ending values of the range must respond to subtract (-) and add (+)methods, or rand will raise an ArgumentError. ;T;[o;= ;3I" overload;F;40;;¾;50;)I" rand;T;IC;";T; @¼X;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @¼X;[;I"@return [Float];T;0;6i;[; @¼Xo;= ;3I" overload;F;40;;¾;50;)I"rand(max);T;IC;";T; @¼X;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @¼X;[;I"@return [Numeric];T;0;6i;[[I"max;T0; @¼X;[;I"ÒWhen +max+ is an Integer, +rand+ returns a random integer greater than or equal to zero and less than +max+. Unlike Kernel.rand, when +max+ is a negative integer or zero, +rand+ raises an ArgumentError. prng = Random.new prng.rand(100) # => 42 When +max+ is a Float, +rand+ returns a random floating point number between 0.0 and +max+, including 0.0 and excluding +max+. prng.rand(1.5) # => 1.4600282860034115 When +max+ is a Range, +rand+ returns a random number where range.member?(number) == true. prng.rand(5..9) # => one of [5, 6, 7, 8, 9] prng.rand(5...9) # => one of [5, 6, 7, 8] prng.rand(5.0..9.0) # => between 5.0 and 9.0, including 9.0 prng.rand(5.0...9.0) # => between 5.0 and 9.0, excluding 9.0 Both the beginning and ending values of the range must respond to subtract (-) and add (+)methods, or rand will raise an ArgumentError. @overload rand @return [Float] @overload rand(max) @return [Numeric];T;0; @¼X;!F;"o;#;$T;%iw;&i“;'@7X;(I"¬static VALUE random_rand(int argc, VALUE *argv, VALUE obj) { VALUE v = rand_random(argc, argv, obj, try_get_rnd(obj)); check_random_number(v, argv); return v; };T;)I"static VALUE;T;*To;;F; ;;;;I"Random#bytes;F;[[I"len;T0;[[@yi–;T;;‰;0;[;{;IC;"¯Returns a random binary string containing +size+ bytes. random_string = Random.new.bytes(10) # => "\xD7:R\xAB?\x83\xCE\xFAkO" random_string.size # => 10 ;T;[o;= ;3I" overload;F;40;;‰;50;)I"bytes(size);T;IC;";T; @çX;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @çX;[;I"@return [String];T;0;6i;[[I" size;T0; @çX;[;I"ÚReturns a random binary string containing +size+ bytes. random_string = Random.new.bytes(10) # => "\xD7:R\xAB?\x83\xCE\xFAkO" random_string.size # => 10 @overload bytes(size) @return [String];T;0; @çX;!F;"o;#;$T;%iŽ;&i•;'@7X;(I"£static VALUE random_bytes(VALUE obj, VALUE len) { rb_random_t *rnd = try_get_rnd(obj); return rand_bytes(rb_rand_if(obj), rnd, NUM2LONG(rb_to_int(len))); };T;)I"static VALUE;T;*To;;F; ;;;;I"Random#seed;F;[;[[@yi¹;T;;4;0;[;{;IC;"PReturns the seed value used to initialize the generator. This may be used to initialize another generator with the same state at a later time, causing it to produce the same sequence of numbers. prng1 = Random.new(1234) prng1.seed #=> 1234 prng1.rand(100) #=> 47 prng2 = Random.new(prng1.seed) prng2.rand(100) #=> 47 ;T;[o;= ;3I" overload;F;40;;4;50;)I" seed;T;IC;";T; @Y;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Y;[;I"@return [Integer];T;0;6i;[; @Y;[;I"uReturns the seed value used to initialize the generator. This may be used to initialize another generator with the same state at a later time, causing it to produce the same sequence of numbers. prng1 = Random.new(1234) prng1.seed #=> 1234 prng1.rand(100) #=> 47 prng2 = Random.new(prng1.seed) prng2.rand(100) #=> 47 @overload seed @return [Integer];T;0; @Y;!F;"o;#;$T;%i«;&i¸;'@7X;(I"Ostatic VALUE random_get_seed(VALUE obj) { return get_rnd(obj)->seed; };T;)I"static VALUE;T;*To;{;[[@yiÀ;F;:DEFAULT;;};;;[;{;IC;";T;[;[;@|;0; @!Y;'@7X;I"Random::DEFAULT;F;~I"rb_cRandom;To;;F; ;F;;;I"Random.srand;F;[[@c0;[[@yiY;T;;½;0;[;{;IC;"hSeeds the system pseudo-random number generator, 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;= ;3I" overload;F;40;;½;50;)I"$srand(number = Random.new_seed);T;IC;";T; @+Y;>0;!F;[;[;I";T;0;6i;[[I"number;TI"Random.new_seed;T; @+Y;[;@Š;0; @+Y;!F;"o;#;$T;%iB;&iU;'@7X;(I"ystatic VALUE rb_f_srand(int argc, VALUE *argv, VALUE obj) { VALUE seed, old; rb_random_mt_t *r = rand_mt_start(default_rand()); if (rb_check_arity(argc, 0, 1) == 0) { seed = random_seed(obj); } else { seed = rb_to_int(argv[0]); } old = r->base.seed; rand_init(&random_mt_if, &r->base, seed); r->base.seed = seed; return old; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Random.rand;F;[[@c0;[[@yi);T;;¾;0;[;{;IC;" ;T;[o;= ;3I" overload;F;40;;¾;50;)I" rand;T;IC;";T; @DY;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @DY;[;I"@return [Float];T;0;6i;[; @DYo;= ;3I" overload;F;40;;¾;50;)I"rand(max);T;IC;";T; @DY;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @DY;[;I"@return [Numeric];T;0;6i;[[I"max;T0; @DY;[;I"N @overload rand @return [Float] @overload rand(max) @return [Numeric];T;0; @DY;!F;"o;#;$T;%i#;&i';'@7X;(I"¹static VALUE random_s_rand(int argc, VALUE *argv, VALUE obj) { VALUE v = rand_random(argc, argv, Qnil, rand_start(default_rand())); check_random_number(v, argv); return v; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Random.bytes;F;[[I"len;T0;[[@yiÄ;T;;‰;0;[;{;IC;"eReturns a random binary string. The argument +size+ specifies the length of the returned string. ;T;[o;= ;3I" overload;F;40;;‰;50;)I"bytes(size);T;IC;";T; @oY;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @oY;[;I"@return [String];T;0;6i;[[I" size;T0; @oY;[;I"‹Returns a random binary string. The argument +size+ specifies the length of the returned string. @overload bytes(size) @return [String];T;0; @oY;!F;"o;#;$T;%i¾;&iÃ;'@7X;(I"static VALUE random_s_bytes(VALUE obj, VALUE len) { rb_random_t *rnd = rand_start(default_rand()); return rand_bytes(&random_mt_if, rnd, NUM2LONG(rb_to_int(len))); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Random.seed;F;[;[[@yiË;T;;4;0;[;{;IC;";T;[;[;@|;0; @ŽY;'@7X;(I"}static VALUE random_s_seed(VALUE obj) { rb_random_mt_t *rnd = rand_mt_start(default_rand()); return rnd->base.seed; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Random.new_seed;F;[;[[@yi†;T;: new_seed;0;[;{;IC;"«Returns an arbitrary seed value. This is used by Random.new when no seed value is specified as an argument. Random.new_seed #=> 115032730400174366788466674494640623225 ;T;[o;= ;3I" overload;F;40;;D;50;)I" new_seed;T;IC;";T; @šY;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @šY;[;I"@return [Integer];T;0;6i;[; @šY;[;I"ÔReturns an arbitrary seed value. This is used by Random.new when no seed value is specified as an argument. Random.new_seed #=> 115032730400174366788466674494640623225 @overload new_seed @return [Integer];T;0; @šY;!F;"o;#;$T;%i~;&i…;'@7X;(I"ªstatic VALUE random_seed(VALUE _) { VALUE v; with_random_seed(DEFAULT_SEED_CNT, 1) { v = make_seed_value(seedbuf, DEFAULT_SEED_CNT); } return v; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Random.urandom;F;[[I" size;T0;[[@yi ;T;:urandom;0;[;{;IC;"Returns a string, using platform providing features. Returned value is expected to be a cryptographically secure pseudo-random number in binary form. This method raises a RuntimeError if the feature provided by platform failed to prepare the result. In 2017, Linux manpage random(7) writes that "no cryptographic primitive available today can hope to promise more than 256 bits of security". So it might be questionable to pass size > 32 to this method. Random.urandom(8) #=> "\x78\x41\xBA\xAF\x7D\xEA\xD8\xEA" ;T;[o;= ;3I" overload;F;40;;E;50;)I"urandom(size);T;IC;";T; @µY;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @µY;[;I"@return [String];T;0;6i;[[I" size;T0; @µY;[;I"1Returns a string, using platform providing features. Returned value is expected to be a cryptographically secure pseudo-random number in binary form. This method raises a RuntimeError if the feature provided by platform failed to prepare the result. In 2017, Linux manpage random(7) writes that "no cryptographic primitive available today can hope to promise more than 256 bits of security". So it might be questionable to pass size > 32 to this method. Random.urandom(8) #=> "\x78\x41\xBA\xAF\x7D\xEA\xD8\xEA" @overload urandom(size) @return [String];T;0; @µY;!F;"o;#;$T;%i;&iŸ;'@7X;(I"static VALUE random_raw_seed(VALUE self, VALUE size) { long n = NUM2ULONG(size); VALUE buf = rb_str_new(0, n); if (n == 0) return buf; if (fill_random_bytes(RSTRING_PTR(buf), n, TRUE)) rb_raise(rb_eRuntimeError, "failed to get urandom"); return buf; };T;)I"static VALUE;T;*To; ;IC;[o;;F; ;;;;I"$Random::Formatter#random_number;F;[[@c0;[[@yiÃ;T;:random_number;0;[;{;IC;"NGenerates formatted random number from raw random bytes. See Random#rand. ;T;[ o;= ;3I" overload;F;40;;F;50;)I"random_number;T;IC;";T; @ÖY;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @ÖY;[;I"@return [Float];T;0;6i;[; @ÖYo;= ;3I" overload;F;40;;F;50;)I"random_number(max);T;IC;";T; @ÖY;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @ÖY;[;I"@return [Numeric];T;0;6i;[[I"max;T0; @ÖYo;= ;3I" overload;F;40;;¾;50;)I" rand;T;IC;";T; @ÖY;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @ÖY;[;I"@return [Float];T;0;6i;[; @ÖYo;= ;3I" overload;F;40;;¾;50;)I"rand(max);T;IC;";T; @ÖY;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @ÖY;[;I"@return [Numeric];T;0;6i;[[I"max;T0; @ÖY;[;I"ïGenerates formatted random number from raw random bytes. See Random#rand. @overload random_number @return [Float] @overload random_number(max) @return [Numeric] @overload rand @return [Float] @overload rand(max) @return [Numeric];T;0; @ÖY;!F;"o;#;$T;%i¹;&iÄ;'@ÔY;(I"static VALUE rand_random_number(int argc, VALUE *argv, VALUE obj) { rb_random_t *rnd = try_get_rnd(obj); VALUE v = rand_random(argc, argv, obj, rnd); if (NIL_P(v)) v = rand_random(0, 0, obj, rnd); else if (!v) invalid_argument(argv[0]); return v; };T;)I"static VALUE;T;*To;;F; ;;;;I"Random::Formatter#rand;F;[[@c0;[[@yiÃ;T;;¾;0;[;{;IC;"NGenerates formatted random number from raw random bytes. See Random#rand. ;T;[ o;= ;3I" overload;F;40;;F;50;)I"random_number;T;IC;";T; @Z;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @Z;[;I"@return [Float];T;0;6i;[; @Zo;= ;3I" overload;F;40;;F;50;)I"random_number(max);T;IC;";T; @Z;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @Z;[;I"@return [Numeric];T;0;6i;[[I"max;T0; @Zo;= ;3I" overload;F;40;;¾;50;)I" rand;T;IC;";T; @Z;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Float;T; @Z;[;I"@return [Float];T;0;6i;[; @Zo;= ;3I" overload;F;40;;¾;50;)I"rand(max);T;IC;";T; @Z;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Numeric;T; @Z;[;I"@return [Numeric];T;0;6i;[[I"max;T0; @Z;[;@Z;0; @Z;!F;"o;#;$T;%i¹;&iÄ;'@ÔY;(I"static VALUE rand_random_number(int argc, VALUE *argv, VALUE obj) { rb_random_t *rnd = try_get_rnd(obj); VALUE v = rand_random(argc, argv, obj, rnd); if (NIL_P(v)) v = rand_random(0, 0, obj, rnd); else if (!v) invalid_argument(argv[0]); return v; };T;)I"static VALUE;T;*T;A@ÔY;BIC;[;A@ÔY;CIC;[;A@ÔY;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@yiÎ;F;:Formatter;;K;;;[;{;IC;";T;[;[;@|;0; @ÔY;6i;'@7X;I"Random::Formatter;F;A@7X;BIC;[;A@7X;CIC;[;A@7X;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@yi‡;T;;y;;K;;;[;{;IC;"øRandom provides an interface to Ruby's pseudo-random number generator, or PRNG. The PRNG produces a deterministic sequence of bits which approximate true randomness. The sequence may be represented by integers, floats, or binary strings. The generator may be initialized with either a system-generated or user-supplied seed value by using Random.srand. The class method Random.rand provides the base functionality of Kernel.rand along with better handling of floating point values. These are both interfaces to the Ruby system PRNG. Random.new will create a new PRNG with a state independent of the Ruby system PRNG, allowing multiple generators with different seed values or sequence positions to exist simultaneously. Random objects can be marshaled, allowing sequences to be saved and resumed. PRNGs are currently implemented as a modified Mersenne Twister with a period of 2**19937-1. As this algorithm is _not_ for cryptographical use, you must use SecureRandom for security purpose, instead of this PRNG.;T;[;[;I"ú Random provides an interface to Ruby's pseudo-random number generator, or PRNG. The PRNG produces a deterministic sequence of bits which approximate true randomness. The sequence may be represented by integers, floats, or binary strings. The generator may be initialized with either a system-generated or user-supplied seed value by using Random.srand. The class method Random.rand provides the base functionality of Kernel.rand along with better handling of floating point values. These are both interfaces to the Ruby system PRNG. Random.new will create a new PRNG with a state independent of the Ruby system PRNG, allowing multiple generators with different seed values or sequence positions to exist simultaneously. Random objects can be marshaled, allowing sequences to be saved and resumed. PRNGs are currently implemented as a modified Mersenne Twister with a period of 2**19937-1. As this algorithm is _not_ for cryptographical use, you must use SecureRandom for security purpose, instead of this PRNG. ;T;0; @7X;!F;"o;#;$T;%i‡;&iœ;6i;'@;I"Random;F;S0o; ;IC;[#o;;F; ;F;;;I"Dir.foreach;F;[[@c0;[[@ýi¸;T;;€;0;[;{;IC;".Calls the block once for each entry in the named directory, passing the filename of each entry as a parameter to the block. If no block is given, an enumerator is returned instead. Dir.foreach("testdir") {|x| puts "Got #{x}" } produces: Got . Got .. Got config.h Got main.rb ;T;[ o;= ;3I" overload;F;40;;€;50;)I"foreach( dirname );T;IC;";T; @…Z;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" filename;T; @…Zo;2 ;3I"return;F;4I";T;0;5[I"nil;T; @…Z;[;I"&@yield [ filename ] @return [nil];T;0;6i;[[I"dirname;T0; @…Zo;= ;3I" overload;F;40;;€;50;)I"&foreach( dirname, encoding: enc );T;IC;";T; @…Z;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" filename;T; @…Zo;2 ;3I"return;F;4I";T;0;5[I"nil;T; @…Z;[;I"&@yield [ filename ] @return [nil];T;0;6i;[[I"dirname;T0[I"encoding:;TI"enc;T; @…Zo;= ;3I" overload;F;40;;€;50;)I"foreach( dirname );T;IC;";T; @…Z;>0;!F;[;[;I";T;0;6i;[[I"dirname;T0; @…Zo;= ;3I" overload;F;40;;€;50;)I"&foreach( dirname, encoding: enc );T;IC;";T; @…Z;>0;!F;[;[;I";T;0;6i;[[I"dirname;T0[I"encoding:;TI"enc;T; @…Z;[;I"Calls the block once for each entry in the named directory, passing the filename of each entry as a parameter to the block. If no block is given, an enumerator is returned instead. Dir.foreach("testdir") {|x| puts "Got #{x}" } produces: Got . Got .. Got config.h Got main.rb @overload foreach( dirname ) @yield [ filename ] @return [nil] @overload foreach( dirname, encoding: enc ) @yield [ filename ] @return [nil] @overload foreach( dirname ) @overload foreach( dirname, encoding: enc );T;0; @…Z;!F;"o;#;$T;%i¢;&i¹;'@ƒZ;(I"×static VALUE dir_foreach(int argc, VALUE *argv, VALUE io) { VALUE dir; RETURN_ENUMERATOR(io, argc, argv); dir = dir_open_dir(argc, argv); rb_ensure(dir_each, dir, dir_close, dir); return Qnil; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Dir.entries;F;[[@c0;[[@ýiÚ;T;;";0;[;{;IC;"ZReturns an array containing all of the filenames in the given directory. Will raise a SystemCallError if the named directory doesn't exist. The optional encoding keyword argument specifies the encoding of the directory. If not specified, the filesystem encoding is used. Dir.entries("testdir") #=> [".", "..", "config.h", "main.rb"] ;T;[o;= ;3I" overload;F;40;;";50;)I"entries( dirname );T;IC;";T; @ÖZ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ÖZ;[;I"@return [Array];T;0;6i;[[I"dirname;T0; @ÖZo;= ;3I" overload;F;40;;";50;)I"&entries( dirname, encoding: enc );T;IC;";T; @ÖZ;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @ÖZ;[;I"@return [Array];T;0;6i;[[I"dirname;T0[I"encoding:;TI"enc;T; @ÖZ;[;I"ÊReturns an array containing all of the filenames in the given directory. Will raise a SystemCallError if the named directory doesn't exist. The optional encoding keyword argument specifies the encoding of the directory. If not specified, the filesystem encoding is used. Dir.entries("testdir") #=> [".", "..", "config.h", "main.rb"] @overload entries( dirname ) @return [Array] @overload entries( dirname, encoding: enc ) @return [Array];T;0; @ÖZ;!F;"o;#;$T;%iË;&iÙ;'@ƒZ;(I"©static VALUE dir_entries(int argc, VALUE *argv, VALUE io) { VALUE dir; dir = dir_open_dir(argc, argv); return rb_ensure(dir_collect, dir, dir_close, dir); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Dir.each_child;F;[[@c0;[[@ýiþ;T;;Ñ;0;[;{;IC;"6Calls the block once for each entry except for "." and ".." in the named directory, passing the filename of each entry as a parameter to the block. If no block is given, an enumerator is returned instead. Dir.each_child("testdir") {|x| puts "Got #{x}" } produces: Got config.h Got main.rb ;T;[ o;= ;3I" overload;F;40;;Ñ;50;)I"each_child( dirname );T;IC;";T; @[;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" filename;T; @[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @[;[;I"&@yield [ filename ] @return [nil];T;0;6i;[[I"dirname;T0; @[o;= ;3I" overload;F;40;;Ñ;50;)I")each_child( dirname, encoding: enc );T;IC;";T; @[;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" filename;T; @[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @[;[;I"&@yield [ filename ] @return [nil];T;0;6i;[[I"dirname;T0[I"encoding:;TI"enc;T; @[o;= ;3I" overload;F;40;;Ñ;50;)I"each_child( dirname );T;IC;";T; @[;>0;!F;[;[;I";T;0;6i;[[I"dirname;T0; @[o;= ;3I" overload;F;40;;Ñ;50;)I")each_child( dirname, encoding: enc );T;IC;";T; @[;>0;!F;[;[;I";T;0;6i;[[I"dirname;T0[I"encoding:;TI"enc;T; @[;[;I"#Calls the block once for each entry except for "." and ".." in the named directory, passing the filename of each entry as a parameter to the block. If no block is given, an enumerator is returned instead. Dir.each_child("testdir") {|x| puts "Got #{x}" } produces: Got config.h Got main.rb @overload each_child( dirname ) @yield [ filename ] @return [nil] @overload each_child( dirname, encoding: enc ) @yield [ filename ] @return [nil] @overload each_child( dirname ) @overload each_child( dirname, encoding: enc );T;0; @[;!F;"o;#;$T;%ié;&iÿ;'@ƒZ;(I"âstatic VALUE dir_s_each_child(int argc, VALUE *argv, VALUE io) { VALUE dir; RETURN_ENUMERATOR(io, argc, argv); dir = dir_open_dir(argc, argv); rb_ensure(dir_each_child, dir, dir_close, dir); return Qnil; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Dir.children;F;[[@c0;[[@ýiF;T;: children;0;[;{;IC;"hReturns an array containing all of the filenames except for "." and ".." in the given directory. Will raise a SystemCallError if the named directory doesn't exist. The optional encoding keyword argument specifies the encoding of the directory. If not specified, the filesystem encoding is used. Dir.children("testdir") #=> ["config.h", "main.rb"] ;T;[o;= ;3I" overload;F;40;;H;50;)I"children( dirname );T;IC;";T; @W[;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @W[;[;I"@return [Array];T;0;6i;[[I"dirname;T0; @W[o;= ;3I" overload;F;40;;H;50;)I"'children( dirname, encoding: enc );T;IC;";T; @W[;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @W[;[;I"@return [Array];T;0;6i;[[I"dirname;T0[I"encoding:;TI"enc;T; @W[;[;I"ÚReturns an array containing all of the filenames except for "." and ".." in the given directory. Will raise a SystemCallError if the named directory doesn't exist. The optional encoding keyword argument specifies the encoding of the directory. If not specified, the filesystem encoding is used. Dir.children("testdir") #=> ["config.h", "main.rb"] @overload children( dirname ) @return [Array] @overload children( dirname, encoding: enc ) @return [Array];T;0; @W[;!F;"o;#;$T;%i7;&iE;'@ƒZ;(I"µstatic VALUE dir_s_children(int argc, VALUE *argv, VALUE io) { VALUE dir; dir = dir_open_dir(argc, argv); return rb_ensure(dir_collect_children, dir, dir_close, dir); };T;)I"static VALUE;T;*To;;F; ;;;;I"Dir#fileno;F;[;[[@ýi—;T;;‡;0;[;{;IC;"üReturns the file descriptor used in dir. d = Dir.new("..") d.fileno #=> 8 This method uses dirfd() function defined by POSIX 2008. NotImplementedError is raised on other platforms, such as Windows, which doesn't provide the function. ;T;[o;= ;3I" overload;F;40;;‡;50;)I"fileno;T;IC;";T; @‡[;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @‡[;[;I"@return [Integer];T;0;6i;[; @‡[;[;I"$Returns the file descriptor used in dir. d = Dir.new("..") d.fileno #=> 8 This method uses dirfd() function defined by POSIX 2008. NotImplementedError is raised on other platforms, such as Windows, which doesn't provide the function. @overload fileno @return [Integer];T;0; @‡[;!F;"o;#;$T;%i‰;&i•;'@ƒZ;(I"Ástatic VALUE dir_fileno(VALUE dir) { struct dir_data *dirp; int fd; GetDIR(dir, dirp); fd = dirfd(dirp->dir); if (fd == -1) rb_sys_fail("dirfd"); return INT2NUM(fd); };T;)I"static VALUE;T;*To;;F; ;;;;I" Dir#path;F;[;[[@ýi±;T;;Õ;0;[;{;IC;"pReturns the path parameter passed to dir's constructor. d = Dir.new("..") d.path #=> ".." ;T;[o;= ;3I" overload;F;40;;Õ;50;)I" path;T;IC;";T; @¢[;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @¢[;[;I"@return [String, nil];T;0;6i;[; @¢[o;= ;3I" overload;F;40;;C;50;)I"to_path;T;IC;";T; @¢[;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @¢[;[;I"@return [String, nil];T;0;6i;[; @¢[;[;I"¾Returns the path parameter passed to dir's constructor. d = Dir.new("..") d.path #=> ".." @overload path @return [String, nil] @overload to_path @return [String, nil];T;0; @¢[;!F;"o;#;$T;%i§;&i°;'@ƒZ;(I"Ñstatic VALUE dir_path(VALUE dir) { struct dir_data *dirp; TypedData_Get_Struct(dir, struct dir_data, &dir_data_type, dirp); if (NIL_P(dirp->path)) return Qnil; return rb_str_dup(dirp->path); };T;)I"static VALUE;T;*To;;F; ;;;;I"Dir#to_path;F;[;[[@ýi±;T;;C;0;[;{;IC;"pReturns the path parameter passed to dir's constructor. d = Dir.new("..") d.path #=> ".." ;T;[o;= ;3I" overload;F;40;;Õ;50;)I" path;T;IC;";T; @Ì[;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @Ì[;[;I"@return [String, nil];T;0;6i;[; @Ì[o;= ;3I" overload;F;40;;C;50;)I"to_path;T;IC;";T; @Ì[;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @Ì[;[;I"@return [String, nil];T;0;6i;[; @Ì[;[;@È[;0; @Ì[;!F;"o;#;$T;%i§;&i°;'@ƒZ;(I"Ñstatic VALUE dir_path(VALUE dir) { struct dir_data *dirp; TypedData_Get_Struct(dir, struct dir_data, &dir_data_type, dirp); if (NIL_P(dirp->path)) return Qnil; return rb_str_dup(dirp->path); };T;)I"static VALUE;T;*To;;F; ;;;;I"Dir#inspect;F;[;[[@ýij;T;;r;0;[;{;IC;"0Return a string describing this Dir object. ;T;[o;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @õ[;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @õ[;[;I"@return [String];T;0;6i;[; @õ[;[;I"WReturn a string describing this Dir object. @overload inspect @return [String];T;0; @õ[;!F;"o;#;$T;%id;&ih;'@ƒZ;(I"static VALUE dir_inspect(VALUE dir) { struct dir_data *dirp; TypedData_Get_Struct(dir, struct dir_data, &dir_data_type, dirp); if (!NIL_P(dirp->path)) { VALUE str = rb_str_new_cstr("#<"); rb_str_append(str, rb_class_name(CLASS_OF(dir))); rb_str_cat2(str, ":"); rb_str_append(str, dirp->path); rb_str_cat2(str, ">"); return str; } return rb_funcallv(dir, idTo_s, 0, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I" Dir#read;F;[;[[@ýið;T;;è;0;[;{;IC;"ÔReads the next entry from dir and returns it as a string. Returns nil at the end of the stream. d = Dir.new("testdir") d.read #=> "." d.read #=> ".." d.read #=> "config.h" ;T;[o;= ;3I" overload;F;40;;è;50;)I" read;T;IC;";T; @\;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;TI"nil;T; @\;[;I"@return [String, nil];T;0;6i;[; @\;[;I"ýReads the next entry from dir and returns it as a string. Returns nil at the end of the stream. d = Dir.new("testdir") d.read #=> "." d.read #=> ".." d.read #=> "config.h" @overload read @return [String, nil];T;0; @\;!F;"o;#;$T;%iä;&iî;'@ƒZ;(I"kstatic VALUE dir_read(VALUE dir) { struct dir_data *dirp; struct dirent *dp; GetDIR(dir, dirp); errno = 0; if ((dp = READDIR(dirp->dir, dirp->enc)) != NULL) { return rb_external_str_new_with_enc(dp->d_name, NAMLEN(dp), dirp->enc); } else { int e = errno; if (e != 0) rb_syserr_fail(e, 0); return Qnil; /* end of stream */ } };T;)I"static VALUE;T;*To;;F; ;;;;I" Dir#each;F;[;[[@ýi;T;;;0;[;{;IC;"4Calls the block once for each entry in this directory, passing the filename of each entry as a parameter to the block. If no block is given, an enumerator is returned instead. d = Dir.new("testdir") d.each {|x| puts "Got #{x}" } produces: Got . Got .. Got config.h Got main.rb ;T;[o;= ;3I" overload;F;40;;;50;)I" each;T;IC;";T; @,\;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" filename;T; @,\o;2 ;3I"return;F;4I";T;0;5[I"Dir;T; @,\;[;I"$@yield [filename] @return [Dir];T;0;6i;[; @,\o;= ;3I" overload;F;40;;;50;)I" each;T;IC;";T; @,\;>0;!F;[;[;I";T;0;6i;[; @,\;[;I"xCalls the block once for each entry in this directory, passing the filename of each entry as a parameter to the block. If no block is given, an enumerator is returned instead. d = Dir.new("testdir") d.each {|x| puts "Got #{x}" } produces: Got . Got .. Got config.h Got main.rb @overload each @yield [filename] @return [Dir] @overload each;T;0; @,\;!F;"o;#;$T;%i ;&i;'@ƒZ;(I"~static VALUE dir_each(VALUE dir) { RETURN_ENUMERATOR(dir, 0, 0); return dir_each_entry(dir, dir_yield, Qnil, FALSE); };T;)I"static VALUE;T;*To;;F; ;;;;I"Dir#each_child;F;[;[[@ýi;T;;Ñ;0;[;{;IC;"?Calls the block once for each entry except for "." and ".." in this directory, passing the filename of each entry as a parameter to the block. If no block is given, an enumerator is returned instead. d = Dir.new("testdir") d.each_child {|x| puts "Got #{x}" } produces: Got config.h Got main.rb ;T;[o;= ;3I" overload;F;40;;Ñ;50;)I"each_child;T;IC;";T; @T\;>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" filename;T; @T\o;2 ;3I"return;F;4I";T;0;5[I"Dir;T; @T\;[;I"&@yield [ filename ] @return [Dir];T;0;6i;[; @T\o;= ;3I" overload;F;40;;Ñ;50;)I"each_child;T;IC;";T; @T\;>0;!F;[;[;I";T;0;6i;[; @T\;[;I"’Calls the block once for each entry except for "." and ".." in this directory, passing the filename of each entry as a parameter to the block. If no block is given, an enumerator is returned instead. d = Dir.new("testdir") d.each_child {|x| puts "Got #{x}" } produces: Got config.h Got main.rb @overload each_child @yield [ filename ] @return [Dir] @overload each_child;T;0; @T\;!F;"o;#;$T;%i ;&i;'@ƒZ;(I"…static VALUE dir_each_child_m(VALUE dir) { RETURN_ENUMERATOR(dir, 0, 0); return dir_each_entry(dir, dir_yield, Qnil, TRUE); };T;)I"static VALUE;T;*To;;F; ;;;;I"Dir#children;F;[;[[@ýi/;T;;H;0;[;{;IC;"¢Returns an array containing all of the filenames except for "." and ".." in this directory. d = Dir.new("testdir") d.children #=> ["config.h", "main.rb"] ;T;[o;= ;3I" overload;F;40;;H;50;)I" children;T;IC;";T; @|\;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @|\;[;I"@return [Array];T;0;6i;[; @|\;[;I"ÊReturns an array containing all of the filenames except for "." and ".." in this directory. d = Dir.new("testdir") d.children #=> ["config.h", "main.rb"] @overload children @return [Array];T;0; @|\;!F;"o;#;$T;%i$;&i-;'@ƒZ;(I"static VALUE dir_collect_children(VALUE dir) { VALUE ary = rb_ary_new(); dir_each_entry(dir, rb_ary_push, ary, TRUE); return ary; };T;)I"static VALUE;T;*To;;F; ;;;;I"Dir#rewind;F;[;[[@ýi ;T;;;0;[;{;IC;"—Repositions dir to the first entry. d = Dir.new("testdir") d.read #=> "." d.rewind #=> # d.read #=> "." ;T;[o;= ;3I" overload;F;40;;;50;)I"rewind;T;IC;";T; @—\;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Dir;T; @—\;[;I"@return [Dir];T;0;6i;[; @—\;[;I"ºRepositions dir to the first entry. d = Dir.new("testdir") d.read #=> "." d.rewind #=> # d.read #=> "." @overload rewind @return [Dir];T;0; @—\;!F;"o;#;$T;%i•;&iž;'@ƒZ;(I"ƒstatic VALUE dir_rewind(VALUE dir) { struct dir_data *dirp; GetDIR(dir, dirp); rewinddir(dirp->dir); return dir; };T;)I"static VALUE;T;*To;;F; ;;;;I" Dir#tell;F;[;[[@ýiR;T;;;0;[;{;IC;"”Returns the current position in dir. See also Dir#seek. d = Dir.new("testdir") d.tell #=> 0 d.read #=> "." d.tell #=> 12 ;T;[o;= ;3I" overload;F;40;;;50;)I"pos;T;IC;";T; @²\;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @²\;[;I"@return [Integer];T;0;6i;[; @²\o;= ;3I" overload;F;40;;;50;)I" tell;T;IC;";T; @²\;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @²\;[;I"@return [Integer];T;0;6i;[; @²\;[;I"ÛReturns the current position in dir. See also Dir#seek. d = Dir.new("testdir") d.tell #=> 0 d.read #=> "." d.tell #=> 12 @overload pos @return [Integer] @overload tell @return [Integer];T;0; @²\;!F;"o;#;$T;%iF;&iQ;'@ƒZ;(I" static VALUE dir_tell(VALUE dir) { struct dir_data *dirp; long pos; GetDIR(dir, dirp); pos = telldir(dirp->dir); return rb_int2inum(pos); };T;)I"static VALUE;T;*To;;F; ;;;;I" Dir#seek;F;[[I"pos;T0;[[@ýio;T;;Š;0;[;{;IC;"ZSeeks to a particular location in dir. integer must be a value returned by Dir#tell. d = Dir.new("testdir") #=> # d.read #=> "." i = d.tell #=> 12 d.read #=> ".." d.seek(i) #=> # d.read #=> ".." ;T;[o;= ;3I" overload;F;40;;Š;50;)I"seek( integer );T;IC;";T; @Ú\;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Dir;T; @Ú\;[;I"@return [Dir];T;0;6i;[[I"integer;T0; @Ú\;[;I"†Seeks to a particular location in dir. integer must be a value returned by Dir#tell. d = Dir.new("testdir") #=> # d.read #=> "." i = d.tell #=> 12 d.read #=> ".." d.seek(i) #=> # d.read #=> ".." @overload seek( integer ) @return [Dir];T;0; @Ú\;!F;"o;#;$T;%ia;&im;'@ƒZ;(I"©static VALUE dir_seek(VALUE dir, VALUE pos) { struct dir_data *dirp; long p = NUM2LONG(pos); GetDIR(dir, dirp); seekdir(dirp->dir, p); return dir; };T;)I"static VALUE;T;*To;;F; ;;;;I"Dir#pos;F;[;[[@ýiR;T;;;0;[;{;IC;"”Returns the current position in dir. See also Dir#seek. d = Dir.new("testdir") d.tell #=> 0 d.read #=> "." d.tell #=> 12 ;T;[o;= ;3I" overload;F;40;;;50;)I"pos;T;IC;";T; @ù\;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ù\;[;I"@return [Integer];T;0;6i;[; @ù\o;= ;3I" overload;F;40;;;50;)I" tell;T;IC;";T; @ù\;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ù\;[;I"@return [Integer];T;0;6i;[; @ù\;[;@Ö\;0; @ù\;!F;"o;#;$T;%iF;&iQ;'@ƒZ;(I" static VALUE dir_tell(VALUE dir) { struct dir_data *dirp; long pos; GetDIR(dir, dirp); pos = telldir(dirp->dir); return rb_int2inum(pos); };T;)I"static VALUE;T;*To;;F; ;;;;I" Dir#pos=;F;[[I"pos;T0;[[@ýi‹;T;;;0;[;{;IC;" Synonym for Dir#seek, but returns the position parameter. d = Dir.new("testdir") #=> # d.read #=> "." i = d.pos #=> 12 d.read #=> ".." d.pos = i #=> 12 d.read #=> ".." ;T;[o;= ;3I" overload;F;40;;;50;)I"pos=(integer);T;IC;";T; @ ];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ ];[;I"@return [Integer];T;0;6i;[[I"integer;T0; @ ];[;I"NSynonym for Dir#seek, but returns the position parameter. d = Dir.new("testdir") #=> # d.read #=> "." i = d.pos #=> 12 d.read #=> ".." d.pos = i #=> 12 d.read #=> ".." @overload pos=(integer) @return [Integer];T;0; @ ];!F;"o;#;$T;%i~;&i‰;'@ƒZ;(I"_static VALUE dir_set_pos(VALUE dir, VALUE pos) { dir_seek(dir, pos); return pos; };T;)I"static VALUE;T;*To;;F; ;;;;I"Dir#close;F;[;[[@ýi´;T;;:;0;[;{;IC;"Closes the directory stream. Calling this method on closed Dir object is ignored since Ruby 2.3. d = Dir.new("testdir") d.close #=> nil ;T;[o;= ;3I" overload;F;40;;:;50;)I" close;T;IC;";T; @?];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"nil;T; @?];[;I"@return [nil];T;0;6i;[; @?];[;I"²Closes the directory stream. Calling this method on closed Dir object is ignored since Ruby 2.3. d = Dir.new("testdir") d.close #=> nil @overload close @return [nil];T;0; @?];!F;"o;#;$T;%iª;&i²;'@ƒZ;(I"¼static VALUE dir_close(VALUE dir) { struct dir_data *dirp; dirp = dir_get(dir); if (!dirp->dir) return Qnil; closedir(dirp->dir); dirp->dir = NULL; return Qnil; };T;)I"static VALUE;T;*To;;F; ;F;;;I"Dir.chdir;F;[[@c0;[[@ýi;T;: chdir;0;[;{;IC;"wChanges the current working directory of the process to the given string. When called without an argument, changes the directory to the value of the environment variable HOME, or LOGDIR. SystemCallError (probably Errno::ENOENT) if the target directory does not exist. If a block is given, it is passed the name of the new current directory, and the block is executed with that as the current directory. The original working directory is restored when the block exits. The return value of chdir is the value of the block. chdir blocks can be nested, but in a multi-threaded program an error will be raised if a thread attempts to open a chdir block while another thread has one open or a call to chdir without a block occurs inside a block passed to chdir (even in the same thread). Dir.chdir("/var/spool/mail") puts Dir.pwd Dir.chdir("/tmp") do puts Dir.pwd Dir.chdir("/usr") do puts Dir.pwd end puts Dir.pwd end puts Dir.pwd produces: /var/spool/mail /tmp /usr /tmp /var/spool/mail ;T;[o;= ;3I" overload;F;40;;I;50;)I"chdir( [ string] );T;IC;";T; @Z];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @Z];[;I"@return [0];T;0;6i;[[I"[ string];T0; @Z]o;= ;3I" overload;F;40;;I;50;)I"chdir( [ string] );T;IC;";T; @Z];>0;!F;[o;2 ;3I" yield;F;4I";T;0;5[I" path;T; @Z]o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @Z];[;I"%@yield [ path ] @return [Object];T;0;6i;[[I"[ string];T0; @Z];[;I"æChanges the current working directory of the process to the given string. When called without an argument, changes the directory to the value of the environment variable HOME, or LOGDIR. SystemCallError (probably Errno::ENOENT) if the target directory does not exist. If a block is given, it is passed the name of the new current directory, and the block is executed with that as the current directory. The original working directory is restored when the block exits. The return value of chdir is the value of the block. chdir blocks can be nested, but in a multi-threaded program an error will be raised if a thread attempts to open a chdir block while another thread has one open or a call to chdir without a block occurs inside a block passed to chdir (even in the same thread). Dir.chdir("/var/spool/mail") puts Dir.pwd Dir.chdir("/tmp") do puts Dir.pwd Dir.chdir("/usr") do puts Dir.pwd end puts Dir.pwd end puts Dir.pwd produces: /var/spool/mail /tmp /usr /tmp /var/spool/mail @overload chdir( [ string] ) @return [0] @overload chdir( [ string] ) @yield [ path ] @return [Object];T;0; @Z];!F;"o;#;$T;%iñ;&i;'@ƒZ;(I"Astatic VALUE dir_s_chdir(int argc, VALUE *argv, VALUE obj) { VALUE path = Qnil; if (rb_check_arity(argc, 0, 1) == 1) { path = rb_str_encode_ospath(rb_get_path(argv[0])); } else { const char *dist = getenv("HOME"); if (!dist) { dist = getenv("LOGDIR"); if (!dist) rb_raise(rb_eArgError, "HOME/LOGDIR not set"); } path = rb_str_new2(dist); } if (chdir_blocking > 0) { if (rb_thread_current() != chdir_thread) rb_raise(rb_eRuntimeError, "conflicting chdir during another chdir block"); if (!rb_block_given_p()) rb_warn("conflicting chdir during another chdir block"); } if (rb_block_given_p()) { struct chdir_data args; args.old_path = rb_str_encode_ospath(rb_dir_getwd()); args.new_path = path; args.done = FALSE; return rb_ensure(chdir_yield, (VALUE)&args, chdir_restore, (VALUE)&args); } else { char *p = RSTRING_PTR(path); int r = (int)(VALUE)rb_thread_call_without_gvl(nogvl_chdir, p, RUBY_UBF_IO, 0); if (r < 0) rb_sys_fail_path(path); } return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Dir.getwd;F;[;[[@ýi};T;;v;0;[;{;IC;"°Returns the path to the current working directory of this process as a string. Dir.chdir("/tmp") #=> 0 Dir.getwd #=> "/tmp" Dir.pwd #=> "/tmp" ;T;[o;= ;3I" overload;F;40;;v;50;)I" getwd;T;IC;";T; @Œ];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Œ];[;I"@return [String];T;0;6i;[; @Œ]o;= ;3I" overload;F;40;;w;50;)I"pwd;T;IC;";T; @Œ];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Œ];[;I"@return [String];T;0;6i;[; @Œ];[;I"öReturns the path to the current working directory of this process as a string. Dir.chdir("/tmp") #=> 0 Dir.getwd #=> "/tmp" Dir.pwd #=> "/tmp" @overload getwd @return [String] @overload pwd @return [String];T;0; @Œ];!F;"o;#;$T;%iq;&i|;'@ƒZ;(I"Gstatic VALUE dir_s_getwd(VALUE dir) { return rb_dir_getwd(); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Dir.pwd;F;[;[[@ýi};T;;w;0;[;{;IC;"°Returns the path to the current working directory of this process as a string. Dir.chdir("/tmp") #=> 0 Dir.getwd #=> "/tmp" Dir.pwd #=> "/tmp" ;T;[o;= ;3I" overload;F;40;;v;50;)I" getwd;T;IC;";T; @´];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @´];[;I"@return [String];T;0;6i;[; @´]o;= ;3I" overload;F;40;;w;50;)I"pwd;T;IC;";T; @´];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @´];[;I"@return [String];T;0;6i;[; @´];[;@°];0; @´];!F;"o;#;$T;%iq;&i|;'@ƒZ;(I"Gstatic VALUE dir_s_getwd(VALUE dir) { return rb_dir_getwd(); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Dir.chroot;F;[[I" path;T0;[[@ýi¡;T;:chroot;0;[;{;IC;"ÄChanges this process's idea of the file system root. Only a privileged process may make this call. Not available on all platforms. On Unix systems, see chroot(2) for more information. ;T;[o;= ;3I" overload;F;40;;J;50;)I"chroot( string );T;IC;";T; @Û];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @Û];[;I"@return [0];T;0;6i;[[I"string;T0; @Û];[;I"ïChanges this process's idea of the file system root. Only a privileged process may make this call. Not available on all platforms. On Unix systems, see chroot(2) for more information. @overload chroot( string ) @return [0];T;0; @Û];!F;"o;#;$T;%i˜;&iŸ;'@ƒZ;(I"®static VALUE dir_s_chroot(VALUE dir, VALUE path) { path = check_dirname(path); if (chroot(RSTRING_PTR(path)) == -1) rb_sys_fail_path(path); return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Dir.mkdir;F;[[@c0;[[@ýiÉ;T;;x;0;[;{;IC;"‡Makes a new directory named by string, with permissions specified by the optional parameter anInteger. The permissions may be modified by the value of File::umask, and are ignored on NT. Raises a SystemCallError if the directory cannot be created. See also the discussion of permissions in the class documentation for File. Dir.mkdir(File.join(Dir.home, ".foo"), 0700) #=> 0 ;T;[o;= ;3I" overload;F;40;;x;50;)I" mkdir( string [, integer] );T;IC;";T; @ú];>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @ú];[;I"@return [0];T;0;6i;[[I"string[, integer];T0; @ú];[;I"¾Makes a new directory named by string, with permissions specified by the optional parameter anInteger. The permissions may be modified by the value of File::umask, and are ignored on NT. Raises a SystemCallError if the directory cannot be created. See also the discussion of permissions in the class documentation for File. Dir.mkdir(File.join(Dir.home, ".foo"), 0700) #=> 0 @overload mkdir( string [, integer] ) @return [0];T;0; @ú];!F;"o;#;$T;%i»;&iÇ;'@ƒZ;(I"Ìstatic VALUE dir_s_mkdir(int argc, VALUE *argv, VALUE obj) { struct mkdir_arg m; VALUE path, vmode; int r; if (rb_scan_args(argc, argv, "11", &path, &vmode) == 2) { m.mode = NUM2MODET(vmode); } else { m.mode = 0777; } path = check_dirname(path); m.path = RSTRING_PTR(path); r = (int)(VALUE)rb_thread_call_without_gvl(nogvl_mkdir, &m, RUBY_UBF_IO, 0); if (r < 0) rb_sys_fail_path(path); return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Dir.rmdir;F;[[I"dir;T0;[[@ýiñ;T;;y;0;[;{;IC;"dDeletes the named directory. Raises a subclass of SystemCallError if the directory isn't empty. ;T;[o;= ;3I" overload;F;40;;½;50;)I"delete( string );T;IC;";T; @^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @^;[;I"@return [0];T;0;6i;[[I"string;T0; @^o;= ;3I" overload;F;40;;y;50;)I"rmdir( string );T;IC;";T; @^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @^;[;I"@return [0];T;0;6i;[[I"string;T0; @^o;= ;3I" overload;F;40;;{;50;)I"unlink( string );T;IC;";T; @^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @^;[;I"@return [0];T;0;6i;[[I"string;T0; @^;[;I"ÛDeletes the named directory. Raises a subclass of SystemCallError if the directory isn't empty. @overload delete( string ) @return [0] @overload rmdir( string ) @return [0] @overload unlink( string ) @return [0];T;0; @^;!F;"o;#;$T;%iè;&iñ;'@ƒZ;(I" static VALUE dir_s_rmdir(VALUE obj, VALUE dir) { const char *p; int r; dir = check_dirname(dir); p = RSTRING_PTR(dir); r = (int)(VALUE)rb_thread_call_without_gvl(nogvl_rmdir, (void *)p, RUBY_UBF_IO, 0); if (r < 0) rb_sys_fail_path(dir); return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Dir.delete;F;[[I"dir;T0;[[@ýiñ;T;;½;0;[;{;IC;"dDeletes the named directory. Raises a subclass of SystemCallError if the directory isn't empty. ;T;[o;= ;3I" overload;F;40;;½;50;)I"delete( string );T;IC;";T; @U^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @U^;[;I"@return [0];T;0;6i;[[I"string;T0; @U^o;= ;3I" overload;F;40;;y;50;)I"rmdir( string );T;IC;";T; @U^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @U^;[;I"@return [0];T;0;6i;[[I"string;T0; @U^o;= ;3I" overload;F;40;;{;50;)I"unlink( string );T;IC;";T; @U^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @U^;[;I"@return [0];T;0;6i;[[I"string;T0; @U^;[;@Q^;0; @U^;!F;"o;#;$T;%iè;&iñ;'@ƒZ;(I" static VALUE dir_s_rmdir(VALUE obj, VALUE dir) { const char *p; int r; dir = check_dirname(dir); p = RSTRING_PTR(dir); r = (int)(VALUE)rb_thread_call_without_gvl(nogvl_rmdir, (void *)p, RUBY_UBF_IO, 0); if (r < 0) rb_sys_fail_path(dir); return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Dir.unlink;F;[[I"dir;T0;[[@ýiñ;T;;{;0;[;{;IC;"dDeletes the named directory. Raises a subclass of SystemCallError if the directory isn't empty. ;T;[o;= ;3I" overload;F;40;;½;50;)I"delete( string );T;IC;";T; @‘^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @‘^;[;I"@return [0];T;0;6i;[[I"string;T0; @‘^o;= ;3I" overload;F;40;;y;50;)I"rmdir( string );T;IC;";T; @‘^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @‘^;[;I"@return [0];T;0;6i;[[I"string;T0; @‘^o;= ;3I" overload;F;40;;{;50;)I"unlink( string );T;IC;";T; @‘^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"0;T; @‘^;[;I"@return [0];T;0;6i;[[I"string;T0; @‘^;[;@Q^;0; @‘^;!F;"o;#;$T;%iè;&iñ;'@ƒZ;(I" static VALUE dir_s_rmdir(VALUE obj, VALUE dir) { const char *p; int r; dir = check_dirname(dir); p = RSTRING_PTR(dir); r = (int)(VALUE)rb_thread_call_without_gvl(nogvl_rmdir, (void *)p, RUBY_UBF_IO, 0); if (r < 0) rb_sys_fail_path(dir); return INT2FIX(0); };T;)I"static VALUE;T;*To;;F; ;F;;;I" Dir.home;F;[[@c0;[[@ýiò;T;: home;0;[;{;IC;"OReturns the home directory of the current user or the named user if given. ;T;[o;= ;3I" overload;F;40;;K;50;)I"home();T;IC;";T; @Í^;>0;!F;[;[;I";T;0;6i;[; @Í^o;= ;3I" overload;F;40;;K;50;)I"home("root");T;IC;";T; @Í^;>0;!F;[;[;I";T;0;6i;[[""root"0; @Í^;[;I"yReturns the home directory of the current user or the named user if given. @overload home() @overload home("root");T;0; @Í^;!F;"o;#;$T;%iê;&iï;'@ƒZ;(I"static VALUE dir_s_home(int argc, VALUE *argv, VALUE obj) { VALUE user; const char *u = 0; rb_check_arity(argc, 0, 1); user = (argc > 0) ? argv[0] : Qnil; if (!NIL_P(user)) { SafeStringValue(user); rb_must_asciicompat(user); u = StringValueCStr(user); if (*u) { return rb_home_dir_of(user, rb_str_new(0, 0)); } } return rb_default_home_dir(rb_str_new(0, 0)); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Dir.exist?;F;[;[[@ýi ;T;;c;0;[;{;IC;"^Returns true if the named file is a directory, false otherwise.;T;[o;= ;3I" overload;F;40;;c;50;)I"exist?(file_name);T;IC;";T; @î^;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @î^;[;I"@return [Boolean];T;0;6i;[[I"file_name;T0; @î^;[;@m;0; @î^;!F;"o;#;$T;%i ;&i ;6i;'@ƒZ;(I"(VALUE rb_file_directory_p(void) { };T;)I" VALUE;T;*To;;F; ;F;;;I"Dir.exists?;F;[[I" fname;T0;[[@ýi ;T;;ú;0;[;{;IC;":nodoc:;T;[o;2 ;3I"return;F;4@|;0;5[@~; @ _;[;I":nodoc:;T;0; @ _;!F;"o;#;$T;%i ;&i ;6i;'@ƒZ;(I"™static VALUE rb_dir_exists_p(VALUE obj, VALUE fname) { rb_warn_deprecated("Dir.exists?", "Dir.exist?"); return rb_file_directory_p(obj, fname); };T;)I"static VALUE;T;*To;;F; ;F;;;I"Dir.empty?;F;[[I"dirname;T0;[[@ýiD ;T;;±;0;[;{;IC;"|Returns true if the named file is an empty directory, false if it is not a directory or non-empty.;T;[o;= ;3I" overload;F;40;;±;50;)I"empty?(path_name);T;IC;";T; @_;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @_;[;I"@return [Boolean];T;0;6i;[[I"path_name;T0; @_;[;I"®Returns true if the named file is an empty directory, false if it is not a directory or non-empty. @overload empty?(path_name) @return [Boolean];T;0; @_;!F;"o;#;$T;%i= ;&iB ;6i;'@ƒZ;(I"pstatic VALUE rb_dir_s_empty_p(VALUE obj, VALUE dirname) { VALUE result, orig; const char *path; enum {false_on_notdir = 1}; FilePathValue(dirname); orig = rb_str_dup_frozen(dirname); dirname = rb_str_encode_ospath(dirname); dirname = rb_str_dup_frozen(dirname); path = RSTRING_PTR(dirname); #if defined HAVE_GETATTRLIST && defined ATTR_DIR_ENTRYCOUNT { u_int32_t attrbuf[SIZEUP32(fsobj_tag_t)]; struct attrlist al = {ATTR_BIT_MAP_COUNT, 0, ATTR_CMN_OBJTAG,}; if (getattrlist(path, &al, attrbuf, sizeof(attrbuf), 0) != 0) rb_sys_fail_path(orig); if (*(const fsobj_tag_t *)(attrbuf+1) == VT_HFS) { al.commonattr = 0; al.dirattr = ATTR_DIR_ENTRYCOUNT; if (getattrlist(path, &al, attrbuf, sizeof(attrbuf), 0) == 0) { if (attrbuf[0] >= 2 * sizeof(u_int32_t)) return attrbuf[1] ? Qfalse : Qtrue; if (false_on_notdir) return Qfalse; } rb_sys_fail_path(orig); } } #endif result = (VALUE)rb_thread_call_without_gvl(nogvl_dir_empty_p, (void *)path, RUBY_UBF_IO, 0); if (result == Qundef) { rb_sys_fail_path(orig); } return result; };T;)I"static VALUE;T;*T;A@ƒZ;BIC;[;A@ƒZ;CIC;[@(;A@ƒZ;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@ýiy ;F;:Dir;;K;;;[;{;IC;"‚Objects of class Dir are directory streams representing directories in the underlying file system. They provide a variety of ways to list directories and their contents. See also File. The directory used in these examples contains the two regular files (config.h and main.rb), the parent directory (..), and the directory itself (.). ;T;[;[;I"ƒObjects of class Dir are directory streams representing directories in the underlying file system. They provide a variety of ways to list directories and their contents. See also File. The directory used in these examples contains the two regular files (config.h and main.rb), the parent directory (..), and the directory itself (.). ;T;0; @ƒZ;!F;"o;#;$T;%il ;&it ;'@;I"Dir;F;S@]o; ;IC;[o; ;IC;[o; ;IC;[;A@Q_;BIC;[;A@Q_;CIC;[;A@Q_;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[I" ext/psych/psych_yaml_tree.c;Ti[I"ext/psych/psych_to_ruby.c;Ti&;F;:Visitor;;K;;;[;{;IC;";T;[;[;@|;0; @Q_;'@O_;I"Psych::Visitors::Visitor;F;S@]o; ;IC;[;A@e_;BIC;[;A@e_;CIC;[;A@e_;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@\_i;F;: YAMLTree;;K;;;[;{;IC;";T;[;[;@|;0; @e_;'@O_;I"Psych::Visitors::YAMLTree;F;S@Q_o; ;IC;[o;;F; ;;;Ï;I",Psych::Visitors::ToRuby#build_exception;F;[[I" klass;T0[I" mesg;T0;[[@^_i;T;:build_exception;0;[;{;IC;"9Create an exception with class +klass+ and +message+ ;T;[o;= ;3I" overload;F;40;;O;50;)I"$build_exception(klass, message);T;IC;";T; @x_;>0;!F;[;[;I";T;0;6i;[[I" klass;T0[I"message;T0; @x_;[;I"eCreate an exception with class +klass+ and +message+ @overload build_exception(klass, message);T;0; @x_;!F;"o;#;$T;%i ;&i ;'@v_;(I"˜static VALUE build_exception(VALUE self, VALUE klass, VALUE mesg) { VALUE e = rb_obj_alloc(klass); rb_iv_set(e, "mesg", mesg); return e; };T;)I"Fstatic VALUE build_exception(VALUE self, VALUE klass, VALUE mesg);T;*T;A@v_;BIC;[;A@v_;CIC;[;A@v_;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@^_i';F;:ToRuby;;K;;;[;{;IC;";T;[;[;@|;0; @v_;6i;'@O_;I"Psych::Visitors::ToRuby;F;S@Q_;A@O_;BIC;[;A@O_;CIC;[;A@O_;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@\_i [@^_i%;F;: Visitors;;K;;;[;{;IC;";T;[;[;@|;0; @O_;'@M_;I"Psych::Visitors;Fo; ;IC;[;A@µ_;BIC;[;A@µ_;CIC;[;A@µ_;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[I"ext/psych/psych_emitter.c;Ti;F;:Handler;;K;;;[;{;IC;";T;[;[;@|;0; @µ_;'@M_;I"Psych::Handler;F;S@]o; ;IC;[o;;F; ;;;;I"Psych::Emitter#initialize;F;[[@c0;[[@À_iO;T;;Ð;0;[;{;IC;"5Create a new Psych::Emitter that writes to +io+. ;T;[o;= ;3I" overload;F;40;:Psych::Emitter.new;50;)I">Psych::Emitter.new(io, options = Psych::Emitter::OPTIONS);T;IC;";T; @É_;>0;!F;[;[;I";T;0;6i;[[I"io;T0[I"options;TI"Psych::Emitter::OPTIONS;T; @É_;[;I"{Create a new Psych::Emitter that writes to +io+. @overload Psych::Emitter.new(io, options = Psych::Emitter::OPTIONS);T;0; @É_;!F;"o;#;$T;%iK;&iN;'@Ç_;(I"static VALUE initialize(int argc, VALUE *argv, VALUE self) { yaml_emitter_t * emitter; VALUE io, options; VALUE line_width; VALUE indent; VALUE canonical; TypedData_Get_Struct(self, yaml_emitter_t, &psych_emitter_type, emitter); if (rb_scan_args(argc, argv, "11", &io, &options) == 2) { line_width = rb_funcall(options, id_line_width, 0); indent = rb_funcall(options, id_indentation, 0); canonical = rb_funcall(options, id_canonical, 0); yaml_emitter_set_width(emitter, NUM2INT(line_width)); yaml_emitter_set_indent(emitter, NUM2INT(indent)); yaml_emitter_set_canonical(emitter, Qtrue == canonical ? 1 : 0); } rb_ivar_set(self, id_io, io); yaml_emitter_set_output(emitter, writer, (void *)self); return self; };T;)I"?static VALUE initialize(int argc, VALUE *argv, VALUE self);T;*To;;F; ;;;;I" Psych::Emitter#start_stream;F;[[I" encoding;T0;[[@À_io;T;:start_stream;0;[;{;IC;"MStart a stream emission with +encoding+ See Psych::Handler#start_stream ;T;[o;= ;3I" overload;F;40;;T;50;)I"start_stream(encoding);T;IC;";T; @å_;>0;!F;[;[;I";T;0;6i;[[I" encoding;T0; @å_;[;I"pStart a stream emission with +encoding+ See Psych::Handler#start_stream @overload start_stream(encoding);T;0; @å_;!F;"o;#;$T;%ii;∈'@Ç_;(I"dstatic VALUE start_stream(VALUE self, VALUE encoding) { yaml_emitter_t * emitter; yaml_event_t event; TypedData_Get_Struct(self, yaml_emitter_t, &psych_emitter_type, emitter); Check_Type(encoding, T_FIXNUM); yaml_stream_start_event_initialize(&event, (yaml_encoding_t)NUM2INT(encoding)); emit(emitter, &event); return self; };T;)I":static VALUE start_stream(VALUE self, VALUE encoding);T;*To;;F; ;;;;I"Psych::Emitter#end_stream;F;[;[[@À_i~;T;:end_stream;0;[;{;IC;"9End a stream emission See Psych::Handler#end_stream ;T;[o;= ;3I" overload;F;40;;U;50;)I"end_stream;T;IC;";T; @ÿ_;>0;!F;[;[;I";T;0;6i;[; @ÿ_;[;I"PEnd a stream emission See Psych::Handler#end_stream @overload end_stream;T;0; @ÿ_;!F;"o;#;$T;%i};&i};'@Ç_;(I"static VALUE end_stream(VALUE self) { yaml_emitter_t * emitter; yaml_event_t event; TypedData_Get_Struct(self, yaml_emitter_t, &psych_emitter_type, emitter); yaml_stream_end_event_initialize(&event); emit(emitter, &event); return self; };T;)I"(static VALUE end_stream(VALUE self);T;*To;;F; ;;;;I""Psych::Emitter#start_document;F;[[I"version;T0[I" tags;T0[I"imp;T0;[[@À_i’;T;:start_document;0;[;{;IC;"wStart a document emission with YAML +version+, +tags+, and an +implicit+ start. See Psych::Handler#start_document ;T;[o;= ;3I" overload;F;40;;V;50;)I",start_document(version, tags, implicit);T;IC;";T; @`;>0;!F;[;[;I";T;0;6i;[[I"version;T0[I" tags;T0[I" implicit;T0; @`;[;I"¦Start a document emission with YAML +version+, +tags+, and an +implicit+ start. See Psych::Handler#start_document @overload start_document(version, tags, implicit);T;0; @`;!F;"o;#;$T;%i‹;&i‘;'@Ç_;(I"©static VALUE start_document(VALUE self, VALUE version, VALUE tags, VALUE imp) { yaml_emitter_t * emitter; yaml_tag_directive_t * head = NULL; yaml_tag_directive_t * tail = NULL; yaml_event_t event; yaml_version_directive_t version_directive; TypedData_Get_Struct(self, yaml_emitter_t, &psych_emitter_type, emitter); Check_Type(version, T_ARRAY); if(RARRAY_LEN(version) > 0) { VALUE major = rb_ary_entry(version, (long)0); VALUE minor = rb_ary_entry(version, (long)1); version_directive.major = NUM2INT(major); version_directive.minor = NUM2INT(minor); } if(RTEST(tags)) { long i = 0; long len; rb_encoding * encoding = rb_utf8_encoding(); Check_Type(tags, T_ARRAY); len = RARRAY_LEN(tags); head = xcalloc((size_t)len, sizeof(yaml_tag_directive_t)); tail = head; for(i = 0; i < len && i < RARRAY_LEN(tags); i++) { VALUE tuple = RARRAY_AREF(tags, i); VALUE name; VALUE value; Check_Type(tuple, T_ARRAY); if(RARRAY_LEN(tuple) < 2) { xfree(head); rb_raise(rb_eRuntimeError, "tag tuple must be of length 2"); } name = RARRAY_AREF(tuple, 0); value = RARRAY_AREF(tuple, 1); StringValue(name); StringValue(value); name = rb_str_export_to_enc(name, encoding); value = rb_str_export_to_enc(value, encoding); tail->handle = (yaml_char_t *)StringValueCStr(name); tail->prefix = (yaml_char_t *)StringValueCStr(value); tail++; } } yaml_document_start_event_initialize( &event, (RARRAY_LEN(version) > 0) ? &version_directive : NULL, head, tail, imp ? 1 : 0 ); emit(emitter, &event); if(head) xfree(head); return self; };T;)I"Rstatic VALUE start_document(VALUE self, VALUE version, VALUE tags, VALUE imp);T;*To;;F; ;;;;I" Psych::Emitter#end_document;F;[[I"imp;T0;[[@À_iß;T;:end_document;0;[;{;IC;"XEnd a document emission with an +implicit+ ending. See Psych::Handler#end_document ;T;[o;= ;3I" overload;F;40;;W;50;)I"end_document(implicit);T;IC;";T; @7`;>0;!F;[;[;I";T;0;6i;[[I" implicit;T0; @7`;[;I"{End a document emission with an +implicit+ ending. See Psych::Handler#end_document @overload end_document(implicit);T;0; @7`;!F;"o;#;$T;%iÙ;&iÞ;'@Ç_;(I"$static VALUE end_document(VALUE self, VALUE imp) { yaml_emitter_t * emitter; yaml_event_t event; TypedData_Get_Struct(self, yaml_emitter_t, &psych_emitter_type, emitter); yaml_document_end_event_initialize(&event, imp ? 1 : 0); emit(emitter, &event); return self; };T;)I"5static VALUE end_document(VALUE self, VALUE imp);T;*To;;F; ;;;;I"Psych::Emitter#scalar;F;[[I" value;T0[I"anchor;T0[I"tag;T0[I" plain;T0[I"quoted;T0[I" style;T0;[[@À_ió;T;:scalar;0;[;{;IC;"{Emit a scalar with +value+, +anchor+, +tag+, and a +plain+ or +quoted+ string type with +style+. See Psych::Handler#scalar ;T;[o;= ;3I" overload;F;40;;X;50;)I"5scalar(value, anchor, tag, plain, quoted, style);T;IC;";T; @Q`;>0;!F;[;[;I";T;0;6i;[[I" value;T0[I"anchor;T0[I"tag;T0[I" plain;T0[I"quoted;T0[I" style;T0; @Q`;[;I"¸Emit a scalar with +value+, +anchor+, +tag+, and a +plain+ or +quoted+ string type with +style+. See Psych::Handler#scalar @overload scalar(value, anchor, tag, plain, quoted, style);T;0; @Q`;!F;"o;#;$T;%iì;&iò;'@Ç_;(I"ðstatic VALUE scalar( VALUE self, VALUE value, VALUE anchor, VALUE tag, VALUE plain, VALUE quoted, VALUE style ) { yaml_emitter_t * emitter; yaml_event_t event; rb_encoding *encoding; TypedData_Get_Struct(self, yaml_emitter_t, &psych_emitter_type, emitter); Check_Type(value, T_STRING); encoding = rb_utf8_encoding(); value = rb_str_export_to_enc(value, encoding); if(!NIL_P(anchor)) { Check_Type(anchor, T_STRING); anchor = rb_str_export_to_enc(anchor, encoding); } if(!NIL_P(tag)) { Check_Type(tag, T_STRING); tag = rb_str_export_to_enc(tag, encoding); } yaml_scalar_event_initialize( &event, (yaml_char_t *)(NIL_P(anchor) ? NULL : StringValueCStr(anchor)), (yaml_char_t *)(NIL_P(tag) ? NULL : StringValueCStr(tag)), (yaml_char_t*)StringValuePtr(value), (int)RSTRING_LEN(value), plain ? 1 : 0, quoted ? 1 : 0, (yaml_scalar_style_t)NUM2INT(style) ); emit(emitter, &event); return self; };T;)I"static VALUE scalar(;T;*To;;F; ;;;;I""Psych::Emitter#start_sequence;F;[ [I"anchor;T0[I"tag;T0[I" implicit;T0[I" style;T0;[[@À_i(;T;:start_sequence;0;[;{;IC;"‹Start emitting a sequence with +anchor+, a +tag+, +implicit+ sequence start and end, along with +style+. See Psych::Handler#start_sequence ;T;[o;= ;3I" overload;F;40;;Y;50;)I"1start_sequence(anchor, tag, implicit, style);T;IC;";T; @`;>0;!F;[;[;I";T;0;6i;[ [I"anchor;T0[I"tag;T0[I" implicit;T0[I" style;T0; @`;[;I"ÄStart emitting a sequence with +anchor+, a +tag+, +implicit+ sequence start and end, along with +style+. See Psych::Handler#start_sequence @overload start_sequence(anchor, tag, implicit, style);T;0; @`;!F;"o;#;$T;%i!;&i';'@Ç_;(I",static VALUE start_sequence( VALUE self, VALUE anchor, VALUE tag, VALUE implicit, VALUE style ) { yaml_emitter_t * emitter; yaml_event_t event; rb_encoding * encoding = rb_utf8_encoding(); if(!NIL_P(anchor)) { Check_Type(anchor, T_STRING); anchor = rb_str_export_to_enc(anchor, encoding); } if(!NIL_P(tag)) { Check_Type(tag, T_STRING); tag = rb_str_export_to_enc(tag, encoding); } TypedData_Get_Struct(self, yaml_emitter_t, &psych_emitter_type, emitter); yaml_sequence_start_event_initialize( &event, (yaml_char_t *)(NIL_P(anchor) ? NULL : StringValueCStr(anchor)), (yaml_char_t *)(NIL_P(tag) ? NULL : StringValueCStr(tag)), implicit ? 1 : 0, (yaml_sequence_style_t)NUM2INT(style) ); emit(emitter, &event); return self; };T;)I"!static VALUE start_sequence(;T;*To;;F; ;;;;I" Psych::Emitter#end_sequence;F;[;[[@À_iS;T;:end_sequence;0;[;{;IC;"0;!F;[;[;I";T;0;6i;[; @¥`;[;I"UEnd sequence emission. See Psych::Handler#end_sequence @overload end_sequence;T;0; @¥`;!F;"o;#;$T;%iM;&iR;'@Ç_;(I"static VALUE end_sequence(VALUE self) { yaml_emitter_t * emitter; yaml_event_t event; TypedData_Get_Struct(self, yaml_emitter_t, &psych_emitter_type, emitter); yaml_sequence_end_event_initialize(&event); emit(emitter, &event); return self; };T;)I"*static VALUE end_sequence(VALUE self);T;*To;;F; ;;;;I"!Psych::Emitter#start_mapping;F;[ [I"anchor;T0[I"tag;T0[I" implicit;T0[I" style;T0;[[@À_ig;T;:start_mapping;0;[;{;IC;"{Start emitting a YAML map with +anchor+, +tag+, an +implicit+ start and end, and +style+. See Psych::Handler#start_mapping ;T;[o;= ;3I" overload;F;40;;[;50;)I"0start_mapping(anchor, tag, implicit, style);T;IC;";T; @»`;>0;!F;[;[;I";T;0;6i;[ [I"anchor;T0[I"tag;T0[I" implicit;T0[I" style;T0; @»`;[;I"³Start emitting a YAML map with +anchor+, +tag+, an +implicit+ start and end, and +style+. See Psych::Handler#start_mapping @overload start_mapping(anchor, tag, implicit, style);T;0; @»`;!F;"o;#;$T;%i`;&if;'@Ç_;(I"6static VALUE start_mapping( VALUE self, VALUE anchor, VALUE tag, VALUE implicit, VALUE style ) { yaml_emitter_t * emitter; yaml_event_t event; rb_encoding *encoding; TypedData_Get_Struct(self, yaml_emitter_t, &psych_emitter_type, emitter); encoding = rb_utf8_encoding(); if(!NIL_P(anchor)) { Check_Type(anchor, T_STRING); anchor = rb_str_export_to_enc(anchor, encoding); } if(!NIL_P(tag)) { Check_Type(tag, T_STRING); tag = rb_str_export_to_enc(tag, encoding); } yaml_mapping_start_event_initialize( &event, (yaml_char_t *)(NIL_P(anchor) ? NULL : StringValueCStr(anchor)), (yaml_char_t *)(NIL_P(tag) ? NULL : StringValueCStr(tag)), implicit ? 1 : 0, (yaml_mapping_style_t)NUM2INT(style) ); emit(emitter, &event); return self; };T;)I" static VALUE start_mapping(;T;*To;;F; ;;;;I"Psych::Emitter#end_mapping;F;[;[[@À_i“;T;:end_mapping;0;[;{;IC;"?Emit the end of a mapping. See Psych::Handler#end_mapping ;T;[o;= ;3I" overload;F;40;;\;50;)I"end_mapping;T;IC;";T; @á`;>0;!F;[;[;I";T;0;6i;[; @á`;[;I"WEmit the end of a mapping. See Psych::Handler#end_mapping @overload end_mapping;T;0; @á`;!F;"o;#;$T;%i;&i’;'@Ç_;(I" static VALUE end_mapping(VALUE self) { yaml_emitter_t * emitter; yaml_event_t event; TypedData_Get_Struct(self, yaml_emitter_t, &psych_emitter_type, emitter); yaml_mapping_end_event_initialize(&event); emit(emitter, &event); return self; };T;)I")static VALUE end_mapping(VALUE self);T;*To;;F; ;;;;I"Psych::Emitter#alias;F;[[I"anchor;T0;[[@À_i¦;T;: alias;0;[;{;IC;";Emit an alias with +anchor+. See Psych::Handler#alias ;T;[o;= ;3I" overload;F;40;;];50;)I"alias(anchor);T;IC;";T; @÷`;>0;!F;[;[;I";T;0;6i;[[I"anchor;T0; @÷`;[;I"UEmit an alias with +anchor+. See Psych::Handler#alias @overload alias(anchor);T;0; @÷`;!F;"o;#;$T;%i ;&i¥;'@Ç_;(I"Ùstatic VALUE alias(VALUE self, VALUE anchor) { yaml_emitter_t * emitter; yaml_event_t event; TypedData_Get_Struct(self, yaml_emitter_t, &psych_emitter_type, emitter); if(!NIL_P(anchor)) { Check_Type(anchor, T_STRING); anchor = rb_str_export_to_enc(anchor, rb_utf8_encoding()); } yaml_alias_event_initialize( &event, (yaml_char_t *)(NIL_P(anchor) ? NULL : StringValueCStr(anchor)) ); emit(emitter, &event); return self; };T;)I"1static VALUE alias(VALUE self, VALUE anchor);T;*To;;F; ;;;;I"Psych::Emitter#canonical;F;[;[[@À_iÍ;T;:canonical;0;[;{;IC;",Get the output style, canonical or not. ;T;[o;= ;3I" overload;F;40;;^;50;)I"canonical;T;IC;";T; @a;>0;!F;[;[;I";T;0;6i;[; @a;[;I"BGet the output style, canonical or not. @overload canonical;T;0; @a;!F;"o;#;$T;%iÉ;&iÌ;'@Ç_;(I"Êstatic VALUE canonical(VALUE self) { yaml_emitter_t * emitter; TypedData_Get_Struct(self, yaml_emitter_t, &psych_emitter_type, emitter); return (emitter->canonical == 0) ? Qfalse : Qtrue; };T;)I"'static VALUE canonical(VALUE self);T;*To;;F; ;;;;I"Psych::Emitter#canonical=;F;[[I" style;T0;[[@À_i¿;T;:canonical=;0;[;{;IC;"/Set the output style to canonical, or not. ;T;[o;= ;3I" overload;F;40;;_;50;)I"canonical=(true);T;IC;";T; @'a;>0;!F;[;[;I";T;0;6i;[[I" true;T0; @'a;[;I"LSet the output style to canonical, or not. @overload canonical=(true);T;0; @'a;!F;"o;#;$T;%i»;&i¾;'@Ç_;(I"østatic VALUE set_canonical(VALUE self, VALUE style) { yaml_emitter_t * emitter; TypedData_Get_Struct(self, yaml_emitter_t, &psych_emitter_type, emitter); yaml_emitter_set_canonical(emitter, Qtrue == style ? 1 : 0); return style; };T;)I"8static VALUE set_canonical(VALUE self, VALUE style);T;*To;;F; ;;;;I"Psych::Emitter#indentation;F;[;[[@À_iè;T;:indentation;0;[;{;IC;"Get the indentation level. ;T;[o;= ;3I" overload;F;40;;`;50;)I"indentation;T;IC;";T; @Aa;>0;!F;[;[;I";T;0;6i;[; @Aa;[;I"7Get the indentation level. @overload indentation;T;0; @Aa;!F;"o;#;$T;%iä;&iç;'@Ç_;(I"¿static VALUE indentation(VALUE self) { yaml_emitter_t * emitter; TypedData_Get_Struct(self, yaml_emitter_t, &psych_emitter_type, emitter); return INT2NUM(emitter->best_indent); };T;)I")static VALUE indentation(VALUE self);T;*To;;F; ;;;;I" Psych::Emitter#indentation=;F;[[I" level;T0;[[@À_iÚ;T;:indentation=;0;[;{;IC;"^Set the indentation level to +level+. The level must be less than 10 and greater than 1. ;T;[o;= ;3I" overload;F;40;;a;50;)I"indentation=(level);T;IC;";T; @Wa;>0;!F;[;[;I";T;0;6i;[[I" level;T0; @Wa;[;I"~Set the indentation level to +level+. The level must be less than 10 and greater than 1. @overload indentation=(level);T;0; @Wa;!F;"o;#;$T;%iÕ;&iÙ;'@Ç_;(I"ïstatic VALUE set_indentation(VALUE self, VALUE level) { yaml_emitter_t * emitter; TypedData_Get_Struct(self, yaml_emitter_t, &psych_emitter_type, emitter); yaml_emitter_set_indent(emitter, NUM2INT(level)); return level; };T;)I":static VALUE set_indentation(VALUE self, VALUE level);T;*To;;F; ;;;;I"Psych::Emitter#line_width;F;[;[[@À_iô;T;:line_width;0;[;{;IC;""Get the preferred line width. ;T;[o;= ;3I" overload;F;40;;b;50;)I"line_width;T;IC;";T; @qa;>0;!F;[;[;I";T;0;6i;[; @qa;[;I"9Get the preferred line width. @overload line_width;T;0; @qa;!F;"o;#;$T;%ið;&ió;'@Ç_;(I"½static VALUE line_width(VALUE self) { yaml_emitter_t * emitter; TypedData_Get_Struct(self, yaml_emitter_t, &psych_emitter_type, emitter); return INT2NUM(emitter->best_width); };T;)I"(static VALUE line_width(VALUE self);T;*To;;F; ;;;;I"Psych::Emitter#line_width=;F;[[I" width;T0;[[@À_i;T;:line_width=;0;[;{;IC;",Set the preferred line with to +width+. ;T;[o;= ;3I" overload;F;40;;c;50;)I"line_width=(width);T;IC;";T; @‡a;>0;!F;[;[;I";T;0;6i;[[I" width;T0; @‡a;[;I"KSet the preferred line with to +width+. @overload line_width=(width);T;0; @‡a;!F;"o;#;$T;%iü;&iÿ;'@Ç_;(I"ístatic VALUE set_line_width(VALUE self, VALUE width) { yaml_emitter_t * emitter; TypedData_Get_Struct(self, yaml_emitter_t, &psych_emitter_type, emitter); yaml_emitter_set_width(emitter, NUM2INT(width)); return width; };T;)I"9static VALUE set_line_width(VALUE self, VALUE width);T;*T;A@Ç_;BIC;[;A@Ç_;CIC;[;A@Ç_;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@À_i;F;:Emitter;;K;;;[;{;IC;";T;[;[;@|;0; @Ç_;6i;'@M_;I"Psych::Emitter;F;S@µ_o;;F; ;F;;;I"Psych.libyaml_version;F;[;[[I"ext/psych/psych.c;Ti;T;:libyaml_version;0;[;{;IC;".Returns the version of libyaml being used ;T;[o;= ;3I" overload;F;40;;e;50;)I"libyaml_version;T;IC;";T; @°a;>0;!F;[;[;I";T;0;6i;[; @°a;[;I"JReturns the version of libyaml being used @overload libyaml_version;T;0; @°a;!F;"o;#;$T;%i;&i;'@M_;(I"static VALUE libyaml_version(VALUE module) { int major, minor, patch; VALUE list[3]; yaml_get_version(&major, &minor, &patch); list[0] = INT2NUM(major); list[1] = INT2NUM(minor); list[2] = INT2NUM(patch); return rb_ary_new4((long)3, list); };T;)I"/static VALUE libyaml_version(VALUE module);T;*To; ;IC;[o;;F; ;;;Ï;I""Psych::ClassLoader#path2class;F;[[I" path;T0;[[@^_i;T;:path2class;0;[;{;IC;"%Convert +path+ string to a class ;T;[o;= ;3I" overload;F;40;;f;50;)I"path2class(path);T;IC;";T; @Éa;>0;!F;[;[;I";T;0;6i;[[I" path;T0; @Éa;[;I"BConvert +path+ string to a class @overload path2class(path);T;0; @Éa;!F;"o;#;$T;%i;&i;'@Ça;(I"[static VALUE path2class(VALUE self, VALUE path) { return rb_path_to_class(path); };T;)I"4static VALUE path2class(VALUE self, VALUE path);T;*T;A@Ça;BIC;[;A@Ça;CIC;[;A@Ça;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@^_i#;F;:ClassLoader;;K;;;[;{;IC;";T;[;[;@|;0; @Ça;6i;'@M_;I"Psych::ClassLoader;F;S@]o; ;IC;[o;{;[[I"ext/psych/psych_parser.c;Ti$;F;:ANY;;};;;[;{;IC;"'Let the parser choose the encoding ;T;[;[;I"'Let the parser choose the encoding;T;0; @ôa;!F;"o;#;$T;%i#;&i#;'@òa;I"Psych::Parser::ANY;F;~I"Any encoding;To;{;[[@÷ai';F;: UTF8;;};;;[;{;IC;"UTF-8 Encoding ;T;[;[;I"UTF-8 Encoding;T;0; @b;!F;"o;#;$T;%i&;&i&;'@òa;I"Psych::Parser::UTF8;F;~I" INT2NUM(YAML_UTF8_ENCODING);To;{;[[@÷ai*;F;:UTF16LE;;};;;[;{;IC;" UTF-16-LE Encoding with BOM ;T;[;[;I" UTF-16-LE Encoding with BOM;T;0; @ b;!F;"o;#;$T;%i);&i);'@òa;I"Psych::Parser::UTF16LE;F;~I"#INT2NUM(YAML_UTF16LE_ENCODING);To;{;[[@÷ai-;F;:UTF16BE;;};;;[;{;IC;" UTF-16-BE Encoding with BOM ;T;[;[;I" UTF-16-BE Encoding with BOM;T;0; @b;!F;"o;#;$T;%i,;&i,;'@òa;I"Psych::Parser::UTF16BE;F;~I"#INT2NUM(YAML_UTF16BE_ENCODING);To;;F; ;;;;I"Psych::Parser#parse;F;[[@c0;[[@÷aiý;T;;Š;0;[;{;IC;"›Parse the YAML document contained in +yaml+. Events will be called on the handler set on the parser instance. See Psych::Parser and Psych::Parser#handler ;T;[o;= ;3I" overload;F;40;;Š;50;)I"parse(yaml);T;IC;";T; @%b;>0;!F;[;[;I";T;0;6i;[[I" yaml;T0; @%b;[;I"³Parse the YAML document contained in +yaml+. Events will be called on the handler set on the parser instance. See Psych::Parser and Psych::Parser#handler @overload parse(yaml);T;0; @%b;!F;"o;#;$T;%iô;&iú;'@òa;(I"Ìstatic VALUE parse(int argc, VALUE *argv, VALUE self) { VALUE yaml, path; yaml_parser_t * parser; yaml_event_t event; int done = 0; int state = 0; int parser_encoding = YAML_ANY_ENCODING; int encoding = rb_utf8_encindex(); rb_encoding * internal_enc = rb_default_internal_encoding(); VALUE handler = rb_iv_get(self, "@handler"); if (rb_scan_args(argc, argv, "11", &yaml, &path) == 1) { if(rb_respond_to(yaml, id_path)) path = rb_funcall(yaml, id_path, 0); else path = rb_str_new2(""); } TypedData_Get_Struct(self, yaml_parser_t, &psych_parser_type, parser); yaml_parser_delete(parser); yaml_parser_initialize(parser); if (rb_respond_to(yaml, id_read)) { yaml = transcode_io(yaml, &parser_encoding); yaml_parser_set_encoding(parser, parser_encoding); yaml_parser_set_input(parser, io_reader, (void *)yaml); } else { StringValue(yaml); yaml = transcode_string(yaml, &parser_encoding); yaml_parser_set_encoding(parser, parser_encoding); yaml_parser_set_input_string( parser, (const unsigned char *)RSTRING_PTR(yaml), (size_t)RSTRING_LEN(yaml) ); } while(!done) { VALUE event_args[5]; VALUE start_line, start_column, end_line, end_column; if(!yaml_parser_parse(parser, &event)) { VALUE exception; exception = make_exception(parser, path); yaml_parser_delete(parser); yaml_parser_initialize(parser); rb_exc_raise(exception); } start_line = SIZET2NUM(event.start_mark.line); start_column = SIZET2NUM(event.start_mark.column); end_line = SIZET2NUM(event.end_mark.line); end_column = SIZET2NUM(event.end_mark.column); event_args[0] = handler; event_args[1] = start_line; event_args[2] = start_column; event_args[3] = end_line; event_args[4] = end_column; rb_protect(protected_event_location, (VALUE)event_args, &state); switch(event.type) { case YAML_STREAM_START_EVENT: { VALUE args[2]; args[0] = handler; args[1] = INT2NUM(event.data.stream_start.encoding); rb_protect(protected_start_stream, (VALUE)args, &state); } break; case YAML_DOCUMENT_START_EVENT: { VALUE args[4]; /* Get a list of tag directives (if any) */ VALUE tag_directives = rb_ary_new(); /* Grab the document version */ VALUE version = event.data.document_start.version_directive ? rb_ary_new3( (long)2, INT2NUM(event.data.document_start.version_directive->major), INT2NUM(event.data.document_start.version_directive->minor) ) : rb_ary_new(); if(event.data.document_start.tag_directives.start) { yaml_tag_directive_t *start = event.data.document_start.tag_directives.start; yaml_tag_directive_t *end = event.data.document_start.tag_directives.end; for(; start != end; start++) { VALUE handle = Qnil; VALUE prefix = Qnil; if(start->handle) { handle = rb_str_new2((const char *)start->handle); PSYCH_TRANSCODE(handle, encoding, internal_enc); } if(start->prefix) { prefix = rb_str_new2((const char *)start->prefix); PSYCH_TRANSCODE(prefix, encoding, internal_enc); } rb_ary_push(tag_directives, rb_ary_new3((long)2, handle, prefix)); } } args[0] = handler; args[1] = version; args[2] = tag_directives; args[3] = event.data.document_start.implicit == 1 ? Qtrue : Qfalse; rb_protect(protected_start_document, (VALUE)args, &state); } break; case YAML_DOCUMENT_END_EVENT: { VALUE args[2]; args[0] = handler; args[1] = event.data.document_end.implicit == 1 ? Qtrue : Qfalse; rb_protect(protected_end_document, (VALUE)args, &state); } break; case YAML_ALIAS_EVENT: { VALUE args[2]; VALUE alias = Qnil; if(event.data.alias.anchor) { alias = rb_str_new2((const char *)event.data.alias.anchor); PSYCH_TRANSCODE(alias, encoding, internal_enc); } args[0] = handler; args[1] = alias; rb_protect(protected_alias, (VALUE)args, &state); } break; case YAML_SCALAR_EVENT: { VALUE args[7]; VALUE anchor = Qnil; VALUE tag = Qnil; VALUE plain_implicit, quoted_implicit, style; VALUE val = rb_str_new( (const char *)event.data.scalar.value, (long)event.data.scalar.length ); PSYCH_TRANSCODE(val, encoding, internal_enc); if(event.data.scalar.anchor) { anchor = rb_str_new2((const char *)event.data.scalar.anchor); PSYCH_TRANSCODE(anchor, encoding, internal_enc); } if(event.data.scalar.tag) { tag = rb_str_new2((const char *)event.data.scalar.tag); PSYCH_TRANSCODE(tag, encoding, internal_enc); } plain_implicit = event.data.scalar.plain_implicit == 0 ? Qfalse : Qtrue; quoted_implicit = event.data.scalar.quoted_implicit == 0 ? Qfalse : Qtrue; style = INT2NUM(event.data.scalar.style); args[0] = handler; args[1] = val; args[2] = anchor; args[3] = tag; args[4] = plain_implicit; args[5] = quoted_implicit; args[6] = style; rb_protect(protected_scalar, (VALUE)args, &state); } break; case YAML_SEQUENCE_START_EVENT: { VALUE args[5]; VALUE anchor = Qnil; VALUE tag = Qnil; VALUE implicit, style; if(event.data.sequence_start.anchor) { anchor = rb_str_new2((const char *)event.data.sequence_start.anchor); PSYCH_TRANSCODE(anchor, encoding, internal_enc); } tag = Qnil; if(event.data.sequence_start.tag) { tag = rb_str_new2((const char *)event.data.sequence_start.tag); PSYCH_TRANSCODE(tag, encoding, internal_enc); } implicit = event.data.sequence_start.implicit == 0 ? Qfalse : Qtrue; style = INT2NUM(event.data.sequence_start.style); args[0] = handler; args[1] = anchor; args[2] = tag; args[3] = implicit; args[4] = style; rb_protect(protected_start_sequence, (VALUE)args, &state); } break; case YAML_SEQUENCE_END_EVENT: rb_protect(protected_end_sequence, handler, &state); break; case YAML_MAPPING_START_EVENT: { VALUE args[5]; VALUE anchor = Qnil; VALUE tag = Qnil; VALUE implicit, style; if(event.data.mapping_start.anchor) { anchor = rb_str_new2((const char *)event.data.mapping_start.anchor); PSYCH_TRANSCODE(anchor, encoding, internal_enc); } if(event.data.mapping_start.tag) { tag = rb_str_new2((const char *)event.data.mapping_start.tag); PSYCH_TRANSCODE(tag, encoding, internal_enc); } implicit = event.data.mapping_start.implicit == 0 ? Qfalse : Qtrue; style = INT2NUM(event.data.mapping_start.style); args[0] = handler; args[1] = anchor; args[2] = tag; args[3] = implicit; args[4] = style; rb_protect(protected_start_mapping, (VALUE)args, &state); } break; case YAML_MAPPING_END_EVENT: rb_protect(protected_end_mapping, handler, &state); break; case YAML_NO_EVENT: rb_protect(protected_empty, handler, &state); break; case YAML_STREAM_END_EVENT: rb_protect(protected_end_stream, handler, &state); done = 1; break; } yaml_event_delete(&event); if (state) rb_jump_tag(state); } return self; };T;)I":static VALUE parse(int argc, VALUE *argv, VALUE self);T;*To;;F; ;;;;I"Psych::Parser#mark;F;[;[[@÷ai ;T;: mark;0;[;{;IC;"\Returns a Psych::Parser::Mark object that contains line, column, and index information. ;T;[;[;I"_ Returns a Psych::Parser::Mark object that contains line, column, and index information. ;T;0; @>b;!F;"o;#;$T;%i;&i;'@òa;(I"´static VALUE mark(VALUE self) { VALUE mark_klass; VALUE args[3]; yaml_parser_t * parser; TypedData_Get_Struct(self, yaml_parser_t, &psych_parser_type, parser); mark_klass = rb_const_get_at(cPsychParser, rb_intern("Mark")); args[0] = SIZET2NUM(parser->mark.index); args[1] = SIZET2NUM(parser->mark.line); args[2] = SIZET2NUM(parser->mark.column); return rb_class_new_instance(3, args, mark_klass); };T;)I""static VALUE mark(VALUE self);T;*T;A@òa;BIC;[;A@òa;CIC;[;A@òa;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@÷ai ;F;;;;K;;;[;{;IC;";T;[;[;@|;0; @òa;6i;'@M_;I"Psych::Parser;F;S@];A@M_;BIC;[;A@M_;CIC;[;A@M_;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[ [@\_i[@À_i [@µai![@^_i"[@÷ai;F;: Psych;;K;;;[;{;IC;";T;[;[;@|;0; @M_;6i;'@;I" Psych;Fo; ;IC;[o;;F; ;;;;I"Method#==;F;[[I" other;T0;[[@iÝ;T;;`;0;[;{;IC;"¬Two method objects are equal if they are bound to the same object and refer to the same method definition and the classes defining the methods are the same class or module. ;T;[o;= ;3I" overload;F;40;;_;50;)I"eql?(other_meth);T;IC;";T; @pb;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @pb;[;I"@return [Boolean];T;0;6i;[[I"other_meth;T0; @pbo;= ;3I" overload;F;40;;`;50;)I"==(other_meth);T;IC;";T; @pb;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @pb;[;I"@return [Boolean];T;0;6i;[[I"other_meth;T0; @pb;[;I" Two method objects are equal if they are bound to the same object and refer to the same method definition and the classes defining the methods are the same class or module. @overload eql?(other_meth) @return [Boolean] @overload ==(other_meth) @return [Boolean];T;0; @pb;!F;"o;#;$T;%iÓ;&iÛ;'@nb;(I"jstatic VALUE method_eq(VALUE method, VALUE other) { struct METHOD *m1, *m2; VALUE klass1, klass2; if (!rb_obj_is_method(other)) return Qfalse; if (CLASS_OF(method) != CLASS_OF(other)) return Qfalse; Check_TypedStruct(method, &method_data_type); m1 = (struct METHOD *)DATA_PTR(method); m2 = (struct METHOD *)DATA_PTR(other); klass1 = method_entry_defined_class(m1->me); klass2 = method_entry_defined_class(m2->me); if (!rb_method_entry_eq(m1->me, m2->me) || klass1 != klass2 || m1->klass != m2->klass || m1->recv != m2->recv) { return Qfalse; } return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#eql?;F;[[I" other;T0;[[@iÝ;T;;_;0;[;{;IC;"¬Two method objects are equal if they are bound to the same object and refer to the same method definition and the classes defining the methods are the same class or module.;T;[o;= ;3I" overload;F;40;;_;50;)I"eql?(other_meth);T;IC;";T; @žb;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @žb;[;I"@return [Boolean];T;0;6i;[[I"other_meth;T0; @žbo;= ;3I" overload;F;40;;`;50;)I"==(other_meth);T;IC;";T; @žb;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @žb;[;I"@return [Boolean];T;0;6i;[[I"other_meth;T0; @žb;[;@šb;0; @žb;!F;"o;#;$T;%iÓ;&iÛ;6i;'@nb;(I"jstatic VALUE method_eq(VALUE method, VALUE other) { struct METHOD *m1, *m2; VALUE klass1, klass2; if (!rb_obj_is_method(other)) return Qfalse; if (CLASS_OF(method) != CLASS_OF(other)) return Qfalse; Check_TypedStruct(method, &method_data_type); m1 = (struct METHOD *)DATA_PTR(method); m2 = (struct METHOD *)DATA_PTR(other); klass1 = method_entry_defined_class(m1->me); klass2 = method_entry_defined_class(m2->me); if (!rb_method_entry_eq(m1->me, m2->me) || klass1 != klass2 || m1->klass != m2->klass || m1->recv != m2->recv) { return Qfalse; } return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#hash;F;[;[[@i;T;;b;0;[;{;IC;"TReturns a hash value corresponding to the method object. See also Object#hash. ;T;[o;= ;3I" overload;F;40;;b;50;)I" hash;T;IC;";T; @Ëb;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ëb;[;I"@return [Integer];T;0;6i;[; @Ëb;[;I"yReturns a hash value corresponding to the method object. See also Object#hash. @overload hash @return [Integer];T;0; @Ëb;!F;"o;#;$T;%iù;&iÿ;'@nb;(I"2static VALUE method_hash(VALUE method) { struct METHOD *m; st_index_t hash; TypedData_Get_Struct(method, struct METHOD, &method_data_type, m); hash = rb_hash_start((st_index_t)m->recv); hash = rb_hash_method_entry(hash, m->me); hash = rb_hash_end(hash); return ST2FIX(hash); };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#clone;F;[;[[@i ;T;;U;0;[;{;IC;"£Returns a clone of this method. class A def foo return "bar" end end m = A.new.method(:foo) m.call # => "bar" n = m.clone.call # => "bar" ;T;[o;= ;3I" overload;F;40;;U;50;)I" clone;T;IC;";T; @æb;>0;!F;[;[;I";T;0;6i;[; @æb;[;I"µReturns a clone of this method. class A def foo return "bar" end end m = A.new.method(:foo) m.call # => "bar" n = m.clone.call # => "bar" @overload clone;T;0; @æb;!F;"o;#;$T;%i ;&i ;'@nb;(I"static VALUE method_clone(VALUE self) { VALUE clone; struct METHOD *orig, *data; TypedData_Get_Struct(self, struct METHOD, &method_data_type, orig); clone = TypedData_Make_Struct(CLASS_OF(self), struct METHOD, &method_data_type, data); CLONESETUP(clone, self); RB_OBJ_WRITE(clone, &data->recv, orig->recv); RB_OBJ_WRITE(clone, &data->klass, orig->klass); RB_OBJ_WRITE(clone, &data->iclass, orig->iclass); RB_OBJ_WRITE(clone, &data->me, rb_method_entry_clone(orig->me)); return clone; };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#call;F;[[@c0;[[@iO ;T;;j;0;[;{;IC;"ŸInvokes the meth with the specified arguments, returning the method's return value. m = 12.method("+") m.call(3) #=> 15 m.call(20) #=> 32 ;T;[o;= ;3I" overload;F;40;;j;50;)I"call(args, ...);T;IC;";T; @üb;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @üb;[;I"@return [Object];T;0;6i;[[I" args;T0[I"...;T0; @üb;[;I"ÎInvokes the meth with the specified arguments, returning the method's return value. m = 12.method("+") m.call(3) #=> 15 m.call(20) #=> 32 @overload call(args, ...) @return [Object];T;0; @üb;!F;"o;#;$T;%iC ;&iL ;'@nb;(I"ùstatic VALUE rb_method_call_pass_called_kw(int argc, const VALUE *argv, VALUE method) { VALUE procval = rb_block_given_p() ? rb_block_proc() : Qnil; return rb_method_call_with_block_kw(argc, argv, method, procval, RB_PASS_CALLED_KEYWORDS); };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#===;F;[[@c0;[[@iO ;T;;\;0;[;{;IC;"ŸInvokes the meth with the specified arguments, returning the method's return value. m = 12.method("+") m.call(3) #=> 15 m.call(20) #=> 32 ;T;[o;= ;3I" overload;F;40;;j;50;)I"call(args, ...);T;IC;";T; @c;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @c;[;I"@return [Object];T;0;6i;[[I" args;T0[I"...;T0; @c;[;@c;0; @c;!F;"o;#;$T;%iC ;&iL ;'@nb;(I"ùstatic VALUE rb_method_call_pass_called_kw(int argc, const VALUE *argv, VALUE method) { VALUE procval = rb_block_given_p() ? rb_block_proc() : Qnil; return rb_method_call_with_block_kw(argc, argv, method, procval, RB_PASS_CALLED_KEYWORDS); };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#curry;F;[[@c0;[[@iž ;T;: curry;0;[;{;IC;"PReturns a curried proc based on the method. When the proc is called with a number of arguments that is lower than the method's arity, then another curried proc is returned. Only when enough arguments have been supplied to satisfy the method signature, will the method actually be called. The optional arity argument should be supplied when currying methods with variable arguments to determine how many arguments are needed before the method is called. def foo(a,b,c) [a, b, c] end proc = self.method(:foo).curry proc2 = proc.call(1, 2) #=> # proc2.call(3) #=> [1,2,3] def vararg(*args) args end proc = self.method(:vararg).curry(4) proc2 = proc.call(:x) #=> # proc3 = proc2.call(:y, :z) #=> # proc3.call(:a) #=> [:x, :y, :z, :a] ;T;[o;= ;3I" overload;F;40;;n;50;)I" curry;T;IC;";T; @;c;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Proc;T; @;c;[;I"@return [Proc];T;0;6i;[; @;co;= ;3I" overload;F;40;;n;50;)I"curry(arity);T;IC;";T; @;c;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Proc;T; @;c;[;I"@return [Proc];T;0;6i;[[I" arity;T0; @;c;[;I"›Returns a curried proc based on the method. When the proc is called with a number of arguments that is lower than the method's arity, then another curried proc is returned. Only when enough arguments have been supplied to satisfy the method signature, will the method actually be called. The optional arity argument should be supplied when currying methods with variable arguments to determine how many arguments are needed before the method is called. def foo(a,b,c) [a, b, c] end proc = self.method(:foo).curry proc2 = proc.call(1, 2) #=> # proc2.call(3) #=> [1,2,3] def vararg(*args) args end proc = self.method(:vararg).curry(4) proc2 = proc.call(:x) #=> # proc3 = proc2.call(:y, :z) #=> # proc3.call(:a) #=> [:x, :y, :z, :a] @overload curry @return [Proc] @overload curry(arity) @return [Proc];T;0; @;c;!F;"o;#;$T;%i~ ;&iœ ;'@nb;(I"™static VALUE rb_method_curry(int argc, const VALUE *argv, VALUE self) { VALUE proc = method_to_proc(self); return proc_curry(argc, argv, proc); };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#<<;F;[[I"g;T0;[[@i:;T;;Ý;0;[;{;IC;"3Returns a proc that is the composition of this method and the given g. The returned proc takes a variable number of arguments, calls g with them then calls this method with the result. def f(x) x * x end f = self.method(:f) g = proc {|x| x + x } p (f << g).call(2) #=> 16 ;T;[o;= ;3I" overload;F;40;;Ý;50;)I" <<(g);T;IC;";T; @fc;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Proc;T; @fc;[;I"@return [Proc];T;0;6i;[[I"g;T0; @fc;[;I"VReturns a proc that is the composition of this method and the given g. The returned proc takes a variable number of arguments, calls g with them then calls this method with the result. def f(x) x * x end f = self.method(:f) g = proc {|x| x + x } p (f << g).call(2) #=> 16 @overload <<(g) @return [Proc];T;0; @fc;!F;"o;#;$T;%i*;&i8;'@nb;(I"¢static VALUE rb_method_compose_to_left(VALUE self, VALUE g) { g = to_callable(g); self = method_to_proc(self); return proc_compose_to_left(self, g); };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#>>;F;[[I"g;T0;[[@iR;T;;•;0;[;{;IC;"2Returns a proc that is the composition of this method and the given g. The returned proc takes a variable number of arguments, calls this method with them then calls g with the result. def f(x) x * x end f = self.method(:f) g = proc {|x| x + x } p (f >> g).call(2) #=> 8 ;T;[o;= ;3I" overload;F;40;;•;50;)I" >>(g);T;IC;";T; @…c;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Proc;T; @…c;[;I"@return [Proc];T;0;6i;[[I"g;T0; @…c;[;I"UReturns a proc that is the composition of this method and the given g. The returned proc takes a variable number of arguments, calls this method with them then calls g with the result. def f(x) x * x end f = self.method(:f) g = proc {|x| x + x } p (f >> g).call(2) #=> 8 @overload >>(g) @return [Proc];T;0; @…c;!F;"o;#;$T;%iB;&iP;'@nb;(I"¤static VALUE rb_method_compose_to_right(VALUE self, VALUE g) { g = to_callable(g); self = method_to_proc(self); return proc_compose_to_right(self, g); };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#[];F;[[@c0;[[@iO ;T;;Â;0;[;{;IC;"ŸInvokes the meth with the specified arguments, returning the method's return value. m = 12.method("+") m.call(3) #=> 15 m.call(20) #=> 32 ;T;[o;= ;3I" overload;F;40;;j;50;)I"call(args, ...);T;IC;";T; @¤c;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @¤c;[;I"@return [Object];T;0;6i;[[I" args;T0[I"...;T0; @¤c;[;@c;0; @¤c;!F;"o;#;$T;%iC ;&iL ;'@nb;(I"ùstatic VALUE rb_method_call_pass_called_kw(int argc, const VALUE *argv, VALUE method) { VALUE procval = rb_block_given_p() ? rb_block_proc() : Qnil; return rb_method_call_with_block_kw(argc, argv, method, procval, RB_PASS_CALLED_KEYWORDS); };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#arity;F;[;[[@i ;T;: arity;0;[;{;IC;"Returns an indication of the number of arguments accepted by a method. Returns a nonnegative integer for methods that take a fixed number of arguments. For Ruby methods that take a variable number of arguments, returns -n-1, where n is the number of required arguments. Keyword arguments will be considered as a single additional argument, that argument being mandatory if any keyword argument is mandatory. For methods written in C, returns -1 if the call takes a variable number of arguments. class C def one; end def two(a); end def three(*a); end def four(a, b); end def five(a, b, *c); end def six(a, b, *c, &d); end def seven(a, b, x:0); end def eight(x:, y:); end def nine(x:, y:, **z); end def ten(*a, x:, y:); end end c = C.new c.method(:one).arity #=> 0 c.method(:two).arity #=> 1 c.method(:three).arity #=> -1 c.method(:four).arity #=> 2 c.method(:five).arity #=> -3 c.method(:six).arity #=> -3 c.method(:seven).arity #=> -3 c.method(:eight).arity #=> 1 c.method(:nine).arity #=> 1 c.method(:ten).arity #=> -2 "cat".method(:size).arity #=> 0 "cat".method(:replace).arity #=> 1 "cat".method(:squeeze).arity #=> -1 "cat".method(:count).arity #=> -1 ;T;[o;= ;3I" overload;F;40;;o;50;)I" arity;T;IC;";T; @Ãc;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @Ãc;[;I"@return [Integer];T;0;6i;[; @Ãc;[;I"EReturns an indication of the number of arguments accepted by a method. Returns a nonnegative integer for methods that take a fixed number of arguments. For Ruby methods that take a variable number of arguments, returns -n-1, where n is the number of required arguments. Keyword arguments will be considered as a single additional argument, that argument being mandatory if any keyword argument is mandatory. For methods written in C, returns -1 if the call takes a variable number of arguments. class C def one; end def two(a); end def three(*a); end def four(a, b); end def five(a, b, *c); end def six(a, b, *c, &d); end def seven(a, b, x:0); end def eight(x:, y:); end def nine(x:, y:, **z); end def ten(*a, x:, y:); end end c = C.new c.method(:one).arity #=> 0 c.method(:two).arity #=> 1 c.method(:three).arity #=> -1 c.method(:four).arity #=> 2 c.method(:five).arity #=> -3 c.method(:six).arity #=> -3 c.method(:seven).arity #=> -3 c.method(:eight).arity #=> 1 c.method(:nine).arity #=> 1 c.method(:ten).arity #=> -2 "cat".method(:size).arity #=> 0 "cat".method(:replace).arity #=> 1 "cat".method(:squeeze).arity #=> -1 "cat".method(:count).arity #=> -1 @overload arity @return [Integer];T;0; @Ãc;!F;"o;#;$T;%i‚ ;&iª ;'@nb;(I"kstatic VALUE method_arity_m(VALUE method) { int n = method_arity(method); return INT2FIX(n); };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#inspect;F;[;[[@i‡;T;;r;0;[;{;IC;"2Returns a human-readable description of the underlying method. "cat".method(:count).inspect #=> "#" (1..3).method(:map).inspect #=> "#" In the latter case, the method description includes the "owner" of the original method (+Enumerable+ module, which is included into +Range+). +inspect+ also provides, when possible, method argument names (call sequence) and source location. require 'net/http' Net::HTTP.method(:get).inspect #=> "#/lib/ruby/2.7.0/net/http.rb:457>" ... in argument definition means argument is optional (has some default value). For methods defined in C (language core and extensions), location and argument names can't be extracted, and only generic information is provided in form of * (any number of arguments) or _ (some positional argument). "cat".method(:count).inspect #=> "#" "cat".method(:+).inspect #=> "#"" ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @Þc;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Þc;[;I"@return [String];T;0;6i;[; @Þco;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @Þc;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @Þc;[;I"@return [String];T;0;6i;[; @Þc;[;I"|Returns a human-readable description of the underlying method. "cat".method(:count).inspect #=> "#" (1..3).method(:map).inspect #=> "#" In the latter case, the method description includes the "owner" of the original method (+Enumerable+ module, which is included into +Range+). +inspect+ also provides, when possible, method argument names (call sequence) and source location. require 'net/http' Net::HTTP.method(:get).inspect #=> "#/lib/ruby/2.7.0/net/http.rb:457>" ... in argument definition means argument is optional (has some default value). For methods defined in C (language core and extensions), location and argument names can't be extracted, and only generic information is provided in form of * (any number of arguments) or _ (some positional argument). "cat".method(:count).inspect #=> "#" "cat".method(:+).inspect #=> "#"" @overload to_s @return [String] @overload inspect @return [String];T;0; @Þc;!F;"o;#;$T;%if;&i…;'@nb;(I"Ästatic VALUE method_inspect(VALUE method) { struct METHOD *data; VALUE str; const char *sharp = "#"; VALUE mklass; VALUE defined_class; TypedData_Get_Struct(method, struct METHOD, &method_data_type, data); str = rb_sprintf("#<% "PRIsVALUE": ", rb_obj_class(method)); mklass = data->iclass; if (!mklass) mklass = data->klass; if (RB_TYPE_P(mklass, T_ICLASS)) { /* TODO: I'm not sure why mklass is T_ICLASS. * UnboundMethod#bind() can set it as T_ICLASS at convert_umethod_to_method_components() * but not sure it is needed. */ mklass = RBASIC_CLASS(mklass); } if (data->me->def->type == VM_METHOD_TYPE_ALIAS) { defined_class = data->me->def->body.alias.original_me->owner; } else { defined_class = method_entry_defined_class(data->me); } if (RB_TYPE_P(defined_class, T_ICLASS)) { defined_class = RBASIC_CLASS(defined_class); } if (FL_TEST(mklass, FL_SINGLETON)) { VALUE v = rb_ivar_get(mklass, attached); if (data->recv == Qundef) { rb_str_buf_append(str, rb_inspect(mklass)); } else if (data->recv == v) { rb_str_buf_append(str, rb_inspect(v)); sharp = "."; } else { rb_str_buf_append(str, rb_inspect(data->recv)); rb_str_buf_cat2(str, "("); rb_str_buf_append(str, rb_inspect(v)); rb_str_buf_cat2(str, ")"); sharp = "."; } } else { mklass = data->klass; if (FL_TEST(mklass, FL_SINGLETON)) { VALUE v = rb_ivar_get(mklass, attached); if (!(RB_TYPE_P(v, T_CLASS) || RB_TYPE_P(v, T_MODULE))) { do { mklass = RCLASS_SUPER(mklass); } while (RB_TYPE_P(mklass, T_ICLASS)); } } rb_str_buf_append(str, rb_inspect(mklass)); if (defined_class != mklass) { rb_str_catf(str, "(% "PRIsVALUE")", defined_class); } } rb_str_buf_cat2(str, sharp); rb_str_append(str, rb_id2str(data->me->called_id)); if (data->me->called_id != data->me->def->original_id) { rb_str_catf(str, "(%"PRIsVALUE")", rb_id2str(data->me->def->original_id)); } if (data->me->def->type == VM_METHOD_TYPE_NOTIMPLEMENTED) { rb_str_buf_cat2(str, " (not-implemented)"); } // parameter information { VALUE params = rb_method_parameters(method); VALUE pair, name, kind; const VALUE req = ID2SYM(rb_intern("req")); const VALUE opt = ID2SYM(rb_intern("opt")); const VALUE keyreq = ID2SYM(rb_intern("keyreq")); const VALUE key = ID2SYM(rb_intern("key")); const VALUE rest = ID2SYM(rb_intern("rest")); const VALUE keyrest = ID2SYM(rb_intern("keyrest")); const VALUE block = ID2SYM(rb_intern("block")); const VALUE nokey = ID2SYM(rb_intern("nokey")); int forwarding = 0; rb_str_buf_cat2(str, "("); for (int i = 0; i < RARRAY_LEN(params); i++) { pair = RARRAY_AREF(params, i); kind = RARRAY_AREF(pair, 0); name = RARRAY_AREF(pair, 1); // FIXME: in tests it turns out that kind, name = [:req] produces name to be false. Why?.. if (NIL_P(name) || name == Qfalse) { // FIXME: can it be reduced to switch/case? if (kind == req || kind == opt) { name = rb_str_new2("_"); } else if (kind == rest || kind == keyrest) { name = rb_str_new2(""); } else if (kind == block) { name = rb_str_new2("block"); } else if (kind == nokey) { name = rb_str_new2("nil"); } } if (kind == req) { rb_str_catf(str, "%"PRIsVALUE, name); } else if (kind == opt) { rb_str_catf(str, "%"PRIsVALUE"=...", name); } else if (kind == keyreq) { rb_str_catf(str, "%"PRIsVALUE":", name); } else if (kind == key) { rb_str_catf(str, "%"PRIsVALUE": ...", name); } else if (kind == rest) { if (name == ID2SYM('*')) { forwarding = 1; rb_str_cat_cstr(str, "..."); } else { rb_str_catf(str, "*%"PRIsVALUE, name); } } else if (kind == keyrest) { rb_str_catf(str, "**%"PRIsVALUE, name); } else if (kind == block) { if (name == ID2SYM('&')) { if (forwarding) { rb_str_set_len(str, RSTRING_LEN(str) - 2); } else { rb_str_cat_cstr(str, "..."); } } else { rb_str_catf(str, "&%"PRIsVALUE, name); } } else if (kind == nokey) { rb_str_buf_cat2(str, "**nil"); } if (i < RARRAY_LEN(params) - 1) { rb_str_buf_cat2(str, ", "); } } rb_str_buf_cat2(str, ")"); } { // source location VALUE loc = rb_method_location(method); if (!NIL_P(loc)) { rb_str_catf(str, " %"PRIsVALUE":%"PRIsVALUE, RARRAY_AREF(loc, 0), RARRAY_AREF(loc, 1)); } } rb_str_buf_cat2(str, ">"); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#to_s;F;[;[[@i‡;T;;q;0;[;{;IC;"2Returns a human-readable description of the underlying method. "cat".method(:count).inspect #=> "#" (1..3).method(:map).inspect #=> "#" In the latter case, the method description includes the "owner" of the original method (+Enumerable+ module, which is included into +Range+). +inspect+ also provides, when possible, method argument names (call sequence) and source location. require 'net/http' Net::HTTP.method(:get).inspect #=> "#/lib/ruby/2.7.0/net/http.rb:457>" ... in argument definition means argument is optional (has some default value). For methods defined in C (language core and extensions), location and argument names can't be extracted, and only generic information is provided in form of * (any number of arguments) or _ (some positional argument). "cat".method(:count).inspect #=> "#" "cat".method(:+).inspect #=> "#"" ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @d;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @d;[;I"@return [String];T;0;6i;[; @do;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @d;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @d;[;I"@return [String];T;0;6i;[; @d;[;@d;0; @d;!F;"o;#;$T;%if;&i…;'@nb;(I"Ästatic VALUE method_inspect(VALUE method) { struct METHOD *data; VALUE str; const char *sharp = "#"; VALUE mklass; VALUE defined_class; TypedData_Get_Struct(method, struct METHOD, &method_data_type, data); str = rb_sprintf("#<% "PRIsVALUE": ", rb_obj_class(method)); mklass = data->iclass; if (!mklass) mklass = data->klass; if (RB_TYPE_P(mklass, T_ICLASS)) { /* TODO: I'm not sure why mklass is T_ICLASS. * UnboundMethod#bind() can set it as T_ICLASS at convert_umethod_to_method_components() * but not sure it is needed. */ mklass = RBASIC_CLASS(mklass); } if (data->me->def->type == VM_METHOD_TYPE_ALIAS) { defined_class = data->me->def->body.alias.original_me->owner; } else { defined_class = method_entry_defined_class(data->me); } if (RB_TYPE_P(defined_class, T_ICLASS)) { defined_class = RBASIC_CLASS(defined_class); } if (FL_TEST(mklass, FL_SINGLETON)) { VALUE v = rb_ivar_get(mklass, attached); if (data->recv == Qundef) { rb_str_buf_append(str, rb_inspect(mklass)); } else if (data->recv == v) { rb_str_buf_append(str, rb_inspect(v)); sharp = "."; } else { rb_str_buf_append(str, rb_inspect(data->recv)); rb_str_buf_cat2(str, "("); rb_str_buf_append(str, rb_inspect(v)); rb_str_buf_cat2(str, ")"); sharp = "."; } } else { mklass = data->klass; if (FL_TEST(mklass, FL_SINGLETON)) { VALUE v = rb_ivar_get(mklass, attached); if (!(RB_TYPE_P(v, T_CLASS) || RB_TYPE_P(v, T_MODULE))) { do { mklass = RCLASS_SUPER(mklass); } while (RB_TYPE_P(mklass, T_ICLASS)); } } rb_str_buf_append(str, rb_inspect(mklass)); if (defined_class != mklass) { rb_str_catf(str, "(% "PRIsVALUE")", defined_class); } } rb_str_buf_cat2(str, sharp); rb_str_append(str, rb_id2str(data->me->called_id)); if (data->me->called_id != data->me->def->original_id) { rb_str_catf(str, "(%"PRIsVALUE")", rb_id2str(data->me->def->original_id)); } if (data->me->def->type == VM_METHOD_TYPE_NOTIMPLEMENTED) { rb_str_buf_cat2(str, " (not-implemented)"); } // parameter information { VALUE params = rb_method_parameters(method); VALUE pair, name, kind; const VALUE req = ID2SYM(rb_intern("req")); const VALUE opt = ID2SYM(rb_intern("opt")); const VALUE keyreq = ID2SYM(rb_intern("keyreq")); const VALUE key = ID2SYM(rb_intern("key")); const VALUE rest = ID2SYM(rb_intern("rest")); const VALUE keyrest = ID2SYM(rb_intern("keyrest")); const VALUE block = ID2SYM(rb_intern("block")); const VALUE nokey = ID2SYM(rb_intern("nokey")); int forwarding = 0; rb_str_buf_cat2(str, "("); for (int i = 0; i < RARRAY_LEN(params); i++) { pair = RARRAY_AREF(params, i); kind = RARRAY_AREF(pair, 0); name = RARRAY_AREF(pair, 1); // FIXME: in tests it turns out that kind, name = [:req] produces name to be false. Why?.. if (NIL_P(name) || name == Qfalse) { // FIXME: can it be reduced to switch/case? if (kind == req || kind == opt) { name = rb_str_new2("_"); } else if (kind == rest || kind == keyrest) { name = rb_str_new2(""); } else if (kind == block) { name = rb_str_new2("block"); } else if (kind == nokey) { name = rb_str_new2("nil"); } } if (kind == req) { rb_str_catf(str, "%"PRIsVALUE, name); } else if (kind == opt) { rb_str_catf(str, "%"PRIsVALUE"=...", name); } else if (kind == keyreq) { rb_str_catf(str, "%"PRIsVALUE":", name); } else if (kind == key) { rb_str_catf(str, "%"PRIsVALUE": ...", name); } else if (kind == rest) { if (name == ID2SYM('*')) { forwarding = 1; rb_str_cat_cstr(str, "..."); } else { rb_str_catf(str, "*%"PRIsVALUE, name); } } else if (kind == keyrest) { rb_str_catf(str, "**%"PRIsVALUE, name); } else if (kind == block) { if (name == ID2SYM('&')) { if (forwarding) { rb_str_set_len(str, RSTRING_LEN(str) - 2); } else { rb_str_cat_cstr(str, "..."); } } else { rb_str_catf(str, "&%"PRIsVALUE, name); } } else if (kind == nokey) { rb_str_buf_cat2(str, "**nil"); } if (i < RARRAY_LEN(params) - 1) { rb_str_buf_cat2(str, ", "); } } rb_str_buf_cat2(str, ")"); } { // source location VALUE loc = rb_method_location(method); if (!NIL_P(loc)) { rb_str_catf(str, " %"PRIsVALUE":%"PRIsVALUE, RARRAY_AREF(loc, 0), RARRAY_AREF(loc, 1)); } } rb_str_buf_cat2(str, ">"); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#to_proc;F;[;[[@iX;T;;¨;0;[;{;IC;"8Returns a Proc object corresponding to this method. ;T;[o;= ;3I" overload;F;40;;¨;50;)I"to_proc;T;IC;";T; @-d;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Proc;T; @-d;[;I"@return [Proc];T;0;6i;[; @-d;[;I"]Returns a Proc object corresponding to this method. @overload to_proc @return [Proc];T;0; @-d;!F;"o;#;$T;%iQ;&iU;'@nb;(I"rstatic VALUE method_to_proc(VALUE method) { VALUE procval; rb_proc_t *proc; /* * class Method * def to_proc * lambda{|*args| * self.call(*args) * } * end * end */ procval = rb_iterate(mlambda, 0, bmcall, method); GetProcPtr(procval, proc); proc->is_from_method = 1; return procval; };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#receiver;F;[;[[@i3;T;;1;0;[;{;IC;"_Returns the bound receiver of the method object. (1..3).method(:map).receiver # => 1..3 ;T;[o;= ;3I" overload;F;40;;1;50;)I" receiver;T;IC;";T; @Hd;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Object;T; @Hd;[;I"@return [Object];T;0;6i;[; @Hd;[;I"‚Returns the bound receiver of the method object. (1..3).method(:map).receiver # => 1..3 @overload receiver @return [Object];T;0; @Hd;!F;"o;#;$T;%i*;&i0;'@nb;(I"£static VALUE method_receiver(VALUE obj) { struct METHOD *data; TypedData_Get_Struct(obj, struct METHOD, &method_data_type, data); return data->recv; };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#name;F;[;[[@iC;T;;Ñ;0;[;{;IC;"$Returns the name of the method. ;T;[o;= ;3I" overload;F;40;;Ñ;50;)I" name;T;IC;";T; @cd;>0;!F;[;[;I";T;0;6i;[; @cd;[;I"5Returns the name of the method. @overload name;T;0; @cd;!F;"o;#;$T;%i<;&i?;'@nb;(I"°static VALUE method_name(VALUE obj) { struct METHOD *data; TypedData_Get_Struct(obj, struct METHOD, &method_data_type, data); return ID2SYM(data->me->called_id); };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#original_name;F;[;[[@iY;T;:original_name;0;[;{;IC;"ŽReturns the original name of the method. class C def foo; end alias bar foo end C.instance_method(:bar).original_name # => :foo ;T;[o;= ;3I" overload;F;40;;p;50;)I"original_name;T;IC;";T; @yd;>0;!F;[;[;I";T;0;6i;[; @yd;[;I"¨Returns the original name of the method. class C def foo; end alias bar foo end C.instance_method(:bar).original_name # => :foo @overload original_name;T;0; @yd;!F;"o;#;$T;%iL;&iU;'@nb;(I"Àstatic VALUE method_original_name(VALUE obj) { struct METHOD *data; TypedData_Get_Struct(obj, struct METHOD, &method_data_type, data); return ID2SYM(data->me->def->original_id); };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#owner;F;[;[[@il;T;: owner;0;[;{;IC;"Returns the class or module that defines the method. See also Method#receiver. (1..3).method(:map).owner #=> Enumerable ;T;[o;= ;3I" overload;F;40;;q;50;)I" owner;T;IC;";T; @d;>0;!F;[;[;I";T;0;6i;[; @d;[;I"ŒReturns the class or module that defines the method. See also Method#receiver. (1..3).method(:map).owner #=> Enumerable @overload owner;T;0; @d;!F;"o;#;$T;%ib;&ih;'@nb;(I"¤static VALUE method_owner(VALUE obj) { struct METHOD *data; TypedData_Get_Struct(obj, struct METHOD, &method_data_type, data); return data->me->owner; };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#unbind;F;[;[[@i;T;:unbind;0;[;{;IC;"ŸDissociates meth from its current receiver. The resulting UnboundMethod can subsequently be bound to a new object of the same class (see UnboundMethod). ;T;[o;= ;3I" overload;F;40;;r;50;)I"unbind;T;IC;";T; @¥d;>0;!F;[;[;I";T;0;6i;[; @¥d;[;I"²Dissociates meth from its current receiver. The resulting UnboundMethod can subsequently be bound to a new object of the same class (see UnboundMethod). @overload unbind;T;0; @¥d;!F;"o;#;$T;%i;&i;'@nb;(I"þstatic VALUE method_unbind(VALUE obj) { VALUE method; struct METHOD *orig, *data; TypedData_Get_Struct(obj, struct METHOD, &method_data_type, orig); method = TypedData_Make_Struct(rb_cUnboundMethod, struct METHOD, &method_data_type, data); RB_OBJ_WRITE(method, &data->recv, Qundef); RB_OBJ_WRITE(method, &data->klass, orig->klass); RB_OBJ_WRITE(method, &data->iclass, orig->iclass); RB_OBJ_WRITE(method, &data->me, rb_method_entry_clone(orig->me)); return method; };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#source_location;F;[;[[@iC;T;:source_location;0;[;{;IC;"„Returns the Ruby source filename and line number containing this method or nil if this method was not defined in Ruby (i.e. native). ;T;[o;= ;3I" overload;F;40;;s;50;)I"source_location;T;IC;";T; @»d;>0;!F;[o;2 ;3I"return;F;4I"];T;0;5[I" Array;TI"Integer;T; @»d;[;I"@return [Array, Integer]];T;0;6i;[; @»d;[;I"½Returns the Ruby source filename and line number containing this method or nil if this method was not defined in Ruby (i.e. native). @overload source_location @return [Array, Integer]];T;0; @»d;!F;"o;#;$T;%i;;&i@;'@nb;(I"fVALUE rb_method_location(VALUE method) { return method_def_location(rb_method_def(method)); };T;)I" VALUE;T;*To;;F; ;;;;I"Method#parameters;F;[;[[@i\;T;:parameters;0;[;{;IC;"ÔReturns the parameter information of this method. def foo(bar); end method(:foo).parameters #=> [[:req, :bar]] def foo(bar, baz, bat, &blk); end method(:foo).parameters #=> [[:req, :bar], [:req, :baz], [:req, :bat], [:block, :blk]] def foo(bar, *args); end method(:foo).parameters #=> [[:req, :bar], [:rest, :args]] def foo(bar, baz, *args, &blk); end method(:foo).parameters #=> [[:req, :bar], [:req, :baz], [:rest, :args], [:block, :blk]] ;T;[o;= ;3I" overload;F;40;;t;50;)I"parameters;T;IC;";T; @×d;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I" Array;T; @×d;[;I"@return [Array];T;0;6i;[; @×d;[;I"ýReturns the parameter information of this method. def foo(bar); end method(:foo).parameters #=> [[:req, :bar]] def foo(bar, baz, bat, &blk); end method(:foo).parameters #=> [[:req, :bar], [:req, :baz], [:req, :bat], [:block, :blk]] def foo(bar, *args); end method(:foo).parameters #=> [[:req, :bar], [:rest, :args]] def foo(bar, baz, *args, &blk); end method(:foo).parameters #=> [[:req, :bar], [:req, :baz], [:rest, :args], [:block, :blk]] @overload parameters @return [Array];T;0; @×d;!F;"o;#;$T;%iI;&iY;'@nb;(I"Ûstatic VALUE rb_method_parameters(VALUE method) { const rb_iseq_t *iseq = rb_method_iseq(method); if (!iseq) { return rb_unnamed_parameters(method_arity(method)); } return rb_iseq_parameters(iseq, 0); };T;)I"static VALUE;T;*To;;F; ;;;;I"Method#super_method;F;[;[[@iw;T;:super_method;0;[;{;IC;"xReturns a Method of superclass which would be called when super is used or nil if there is no method on superclass. ;T;[o;= ;3I" overload;F;40;;u;50;)I"super_method;T;IC;";T; @òd;>0;!F;[;[;I";T;0;6i;[; @òd;[;I"ŒReturns a Method of superclass which would be called when super is used or nil if there is no method on superclass. @overload super_method;T;0; @òd;!F;"o;#;$T;%io;&is;'@nb;(I"Ôstatic VALUE method_super_method(VALUE method) { const struct METHOD *data; VALUE super_class, iclass; ID mid; const rb_method_entry_t *me; TypedData_Get_Struct(method, struct METHOD, &method_data_type, data); iclass = data->iclass; if (!iclass) return Qnil; if (data->me->def->type == VM_METHOD_TYPE_ALIAS && data->me->defined_class) { super_class = RCLASS_SUPER(rb_find_defined_class_by_owner(data->me->defined_class, data->me->def->body.alias.original_me->owner)); mid = data->me->def->body.alias.original_me->def->original_id; } else { super_class = RCLASS_SUPER(RCLASS_ORIGIN(iclass)); mid = data->me->def->original_id; } if (!super_class) return Qnil; me = (rb_method_entry_t *)rb_callable_method_entry_with_refinements(super_class, mid, &iclass); if (!me) return Qnil; return mnew_internal(me, me->owner, iclass, data->recv, mid, rb_obj_class(method), FALSE, FALSE); };T;)I"static VALUE;T;*T;A@nb;BIC;[;A@nb;CIC;[;A@nb;DIC;E{;FIC;E{;GT;IC;E{;GT;GT;H{;I[;[[@i·[@i#;T;:Method;;K;;;[;{;IC;"`******************************************************************** Method objects are created by Object#method, and are associated with a particular object (not just with a class). They may be used to invoke the method within the object, and as a block associated with an iterator. They may also be unbound from one object (creating an UnboundMethod) and bound to another. class Thing def square(n) n*n end end thing = Thing.new meth = thing.method(:square) meth.call(9) #=> 81 [ 1, 2, 3 ].collect(&meth) #=> [1, 4, 9] [ 1, 2, 3 ].each(&method(:puts)) #=> prints 1, 2, 3 require 'date' %w[2017-03-01 2017-03-02].collect(&Date.method(:parse)) #=> [#, #];T;[;[;I"a******************************************************************** Method objects are created by Object#method, and are associated with a particular object (not just with a class). They may be used to invoke the method within the object, and as a block associated with an iterator. They may also be unbound from one object (creating an UnboundMethod) and bound to another. class Thing def square(n) n*n end end thing = Thing.new meth = thing.method(:square) meth.call(9) #=> 81 [ 1, 2, 3 ].collect(&meth) #=> [1, 4, 9] [ 1, 2, 3 ].each(&method(:puts)) #=> prints 1, 2, 3 require 'date' %w[2017-03-01 2017-03-02].collect(&Date.method(:parse)) #=> [#, #] ;T;0; @nb;!F;"o;#;$T;%i·;&iÐ;6i;'@;I"Method;F;S@]o; ;IC;[o;;F; ;;;;I"UnboundMethod#==;F;[[I" other;T0;[[@iÝ;T;;`;0;[;{;IC;"¬Two method objects are equal if they are bound to the same object and refer to the same method definition and the classes defining the methods are the same class or module. ;T;[o;= ;3I" overload;F;40;;_;50;)I"eql?(other_meth);T;IC;";T; @e;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @e;[;I"@return [Boolean];T;0;6i;[[I"other_meth;T0; @eo;= ;3I" overload;F;40;;`;50;)I"==(other_meth);T;IC;";T; @e;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @e;[;I"@return [Boolean];T;0;6i;[[I"other_meth;T0; @e;[;@šb;0; @e;!F;"o;#;$T;%iÓ;&iÛ;'@e;(I"jstatic VALUE method_eq(VALUE method, VALUE other) { struct METHOD *m1, *m2; VALUE klass1, klass2; if (!rb_obj_is_method(other)) return Qfalse; if (CLASS_OF(method) != CLASS_OF(other)) return Qfalse; Check_TypedStruct(method, &method_data_type); m1 = (struct METHOD *)DATA_PTR(method); m2 = (struct METHOD *)DATA_PTR(other); klass1 = method_entry_defined_class(m1->me); klass2 = method_entry_defined_class(m2->me); if (!rb_method_entry_eq(m1->me, m2->me) || klass1 != klass2 || m1->klass != m2->klass || m1->recv != m2->recv) { return Qfalse; } return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"UnboundMethod#eql?;F;[[I" other;T0;[[@iÝ;T;;_;0;[;{;IC;"¬Two method objects are equal if they are bound to the same object and refer to the same method definition and the classes defining the methods are the same class or module.;T;[o;= ;3I" overload;F;40;;_;50;)I"eql?(other_meth);T;IC;";T; @Ie;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Ie;[;I"@return [Boolean];T;0;6i;[[I"other_meth;T0; @Ieo;= ;3I" overload;F;40;;`;50;)I"==(other_meth);T;IC;";T; @Ie;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Boolean;T; @Ie;[;I"@return [Boolean];T;0;6i;[[I"other_meth;T0; @Ie;[;@šb;0; @Ie;!F;"o;#;$T;%iÓ;&iÛ;6i;'@e;(I"jstatic VALUE method_eq(VALUE method, VALUE other) { struct METHOD *m1, *m2; VALUE klass1, klass2; if (!rb_obj_is_method(other)) return Qfalse; if (CLASS_OF(method) != CLASS_OF(other)) return Qfalse; Check_TypedStruct(method, &method_data_type); m1 = (struct METHOD *)DATA_PTR(method); m2 = (struct METHOD *)DATA_PTR(other); klass1 = method_entry_defined_class(m1->me); klass2 = method_entry_defined_class(m2->me); if (!rb_method_entry_eq(m1->me, m2->me) || klass1 != klass2 || m1->klass != m2->klass || m1->recv != m2->recv) { return Qfalse; } return Qtrue; };T;)I"static VALUE;T;*To;;F; ;;;;I"UnboundMethod#hash;F;[;[[@i;T;;b;0;[;{;IC;"TReturns a hash value corresponding to the method object. See also Object#hash. ;T;[o;= ;3I" overload;F;40;;b;50;)I" hash;T;IC;";T; @ve;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @ve;[;I"@return [Integer];T;0;6i;[; @ve;[;@âb;0; @ve;!F;"o;#;$T;%iù;&iÿ;'@e;(I"2static VALUE method_hash(VALUE method) { struct METHOD *m; st_index_t hash; TypedData_Get_Struct(method, struct METHOD, &method_data_type, m); hash = rb_hash_start((st_index_t)m->recv); hash = rb_hash_method_entry(hash, m->me); hash = rb_hash_end(hash); return ST2FIX(hash); };T;)I"static VALUE;T;*To;;F; ;;;;I"UnboundMethod#clone;F;[;[[@i ;T;;U;0;[;{;IC;"£Returns a clone of this method. class A def foo return "bar" end end m = A.new.method(:foo) m.call # => "bar" n = m.clone.call # => "bar" ;T;[o;= ;3I" overload;F;40;;U;50;)I" clone;T;IC;";T; @e;>0;!F;[;[;I";T;0;6i;[; @e;[;@øb;0; @e;!F;"o;#;$T;%i ;&i ;'@e;(I"static VALUE method_clone(VALUE self) { VALUE clone; struct METHOD *orig, *data; TypedData_Get_Struct(self, struct METHOD, &method_data_type, orig); clone = TypedData_Make_Struct(CLASS_OF(self), struct METHOD, &method_data_type, data); CLONESETUP(clone, self); RB_OBJ_WRITE(clone, &data->recv, orig->recv); RB_OBJ_WRITE(clone, &data->klass, orig->klass); RB_OBJ_WRITE(clone, &data->iclass, orig->iclass); RB_OBJ_WRITE(clone, &data->me, rb_method_entry_clone(orig->me)); return clone; };T;)I"static VALUE;T;*To;;F; ;;;;I"UnboundMethod#arity;F;[;[[@i ;T;;o;0;[;{;IC;"Returns an indication of the number of arguments accepted by a method. Returns a nonnegative integer for methods that take a fixed number of arguments. For Ruby methods that take a variable number of arguments, returns -n-1, where n is the number of required arguments. Keyword arguments will be considered as a single additional argument, that argument being mandatory if any keyword argument is mandatory. For methods written in C, returns -1 if the call takes a variable number of arguments. class C def one; end def two(a); end def three(*a); end def four(a, b); end def five(a, b, *c); end def six(a, b, *c, &d); end def seven(a, b, x:0); end def eight(x:, y:); end def nine(x:, y:, **z); end def ten(*a, x:, y:); end end c = C.new c.method(:one).arity #=> 0 c.method(:two).arity #=> 1 c.method(:three).arity #=> -1 c.method(:four).arity #=> 2 c.method(:five).arity #=> -3 c.method(:six).arity #=> -3 c.method(:seven).arity #=> -3 c.method(:eight).arity #=> 1 c.method(:nine).arity #=> 1 c.method(:ten).arity #=> -2 "cat".method(:size).arity #=> 0 "cat".method(:replace).arity #=> 1 "cat".method(:squeeze).arity #=> -1 "cat".method(:count).arity #=> -1 ;T;[o;= ;3I" overload;F;40;;o;50;)I" arity;T;IC;";T; @¥e;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"Integer;T; @¥e;[;I"@return [Integer];T;0;6i;[; @¥e;[;@Úc;0; @¥e;!F;"o;#;$T;%i‚ ;&iª ;'@e;(I"kstatic VALUE method_arity_m(VALUE method) { int n = method_arity(method); return INT2FIX(n); };T;)I"static VALUE;T;*To;;F; ;;;;I"UnboundMethod#inspect;F;[;[[@i‡;T;;r;0;[;{;IC;"2Returns a human-readable description of the underlying method. "cat".method(:count).inspect #=> "#" (1..3).method(:map).inspect #=> "#" In the latter case, the method description includes the "owner" of the original method (+Enumerable+ module, which is included into +Range+). +inspect+ also provides, when possible, method argument names (call sequence) and source location. require 'net/http' Net::HTTP.method(:get).inspect #=> "#/lib/ruby/2.7.0/net/http.rb:457>" ... in argument definition means argument is optional (has some default value). For methods defined in C (language core and extensions), location and argument names can't be extracted, and only generic information is provided in form of * (any number of arguments) or _ (some positional argument). "cat".method(:count).inspect #=> "#" "cat".method(:+).inspect #=> "#"" ;T;[o;= ;3I" overload;F;40;;q;50;)I" to_s;T;IC;";T; @¿e;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @¿e;[;I"@return [String];T;0;6i;[; @¿eo;= ;3I" overload;F;40;;r;50;)I"inspect;T;IC;";T; @¿e;>0;!F;[o;2 ;3I"return;F;4I";T;0;5[I"String;T; @¿e;[;I"@return [String];T;0;6i;[; @¿e;[;@d;0; @¿e;!F;"o;#;$T;%if;&i…;'@e;(I"Ästatic VALUE method_inspect(VALUE method) { struct METHOD *data; VALUE str; const char *sharp = "#"; VALUE mklass; VALUE defined_class; TypedData_Get_Struct(method, struct METHOD, &method_data_type, data); str = rb_sprintf("#<% "PRIsVALUE": ", rb_obj_class(method)); mklass = data->iclass; if (!mklass) mklass = data->klass; if (RB_TYPE_P(mklass, T_ICLASS)) { /* TODO: I'm not sure why mklass is T_ICLASS. * UnboundMethod#bind() can set it as T_ICLASS at convert_umethod_to_method_components() * but not sure it is needed. */ mklass = RBASIC_CLASS(mklass); } if (data->me->def->type == VM_METHOD_TYPE_ALIAS) { defined_class = data->me->def->body.alias.original_me->owner; } else { defined_class = method_entry_defined_class(data->me); } if (RB_TYPE_P(defined_class, T_ICLASS)) { defined_class = RBASIC_CLASS(defined_class); } if (FL_TEST(mklass, FL_SINGLETON)) { VALUE v = rb_ivar_get(mklass, attached); if (data->recv == Qundef) { rb_str_buf_append(str, rb_inspect(mklass)); } else if (data->recv == v) { rb_str_buf_append(str, rb_inspect(v)); sharp = "."; } else { rb_str_buf_append(str, rb_inspect(data->recv)); rb_str_buf_cat2(str, "("); rb_str_buf_append(str, rb_inspect(v)); rb_str_buf_cat2(str, ")"); sharp = "."; } } else { mklass = data->klass; if (FL_TEST(mklass, FL_SINGLETON)) { VALUE v = rb_ivar_get(mklass, attached); if (!(RB_TYPE_P(v, T_CLASS) || RB_TYPE_P(v, T_MODULE))) { do { mklass = RCLASS_SUPER(mklass); } while (RB_TYPE_P(mklass, T_ICLASS)); } } rb_str_buf_append(str, rb_inspect(mklass)); if (defined_class != mklass) { rb_str_catf(str, "(% "PRIsVALUE")", defined_class); } } rb_str_buf_cat2(str, sharp); rb_str_append(str, rb_id2str(data->me->called_id)); if (data->me->called_id != data->me->def->original_id) { rb_str_catf(str, "(%"PRIsVALUE")", rb_id2str(data->me->def->original_id)); } if (data->me->def->type == VM_METHOD_TYPE_NOTIMPLEMENTED) { rb_str_buf_cat2(str, " (not-implemented)"); } // parameter information { VALUE params = rb_method_parameters(method); VALUE pair, name, kind; const VALUE req = ID2SYM(rb_intern("req")); const VALUE opt = ID2SYM(rb_intern("opt")); const VALUE keyreq = ID2SYM(rb_intern("keyreq")); const VALUE key = ID2SYM(rb_intern("key")); const VALUE rest = ID2SYM(rb_intern("rest")); const VALUE keyrest = ID2SYM(rb_intern("keyrest")); const VALUE block = ID2SYM(rb_intern("block")); const VALUE nokey = ID2SYM(rb_intern("nokey")); int forwarding = 0; rb_str_buf_cat2(str, "("); for (int i = 0; i < RARRAY_LEN(params); i++) { pair = RARRAY_AREF(params, i); kind = RARRAY_AREF(pair, 0); name = RARRAY_AREF(pair, 1); // FIXME: in tests it turns out that kind, name = [:req] produces name to be false. Why?.. if (NIL_P(name) || name == Qfalse) { // FIXME: can it be reduced to switch/case? if (kind == req || kind == opt) { name = rb_str_new2("_"); } else if (kind == rest || kind == keyrest) { name = rb_str_new2(""); } else if (kind == block) { name = rb_str_new2("block"); } else if (kind == nokey) { name = rb_str_new2("nil"); } } if (kind == req) { rb_str_catf(str, "%"PRIsVALUE, name); } else if (kind == opt) { rb_str_catf(str, "%"PRIsVALUE"=...", name); } else if (kind == keyreq) { rb_str_catf(str, "%"PRIsVALUE":", name); } else if (kind == key) { rb_str_catf(str, "%"PRIsVALUE": ...", name); } else if (kind == rest) { if (name == ID2SYM('*')) { forwarding = 1; rb_str_cat_cstr(str, "..."); } else { rb_str_catf(str, "*%"PRIsVALUE, name); } } else if (kind == keyrest) { rb_str_catf(str, "**%"PRIsVALUE, name); } else if (kind == block) { if (name == ID2SYM('&')) { if (forwarding) { rb_str_set_len(str, RSTRING_LEN(str) - 2); } else { rb_str_cat_cstr(str, "..."); } } else { rb_str_catf(str, "&%"PRIsVALUE, name); } } else if (kind == nokey) { rb_str_buf_cat2(str, "**nil"); } if (i < RARRAY_LEN(params) - 1) { rb_str_buf_cat2(str, ", "); } } rb_str_buf_cat2(str, ")"); } { // source location VALUE loc = rb_method_location(method); if (!NIL_P(loc)) { rb_str_catf(str, " %"PRIsVALUE":%"PRIsVALUE, RARRAY_AREF(loc, 0), RARRAY_AREF(loc, 1)); } } rb_str_buf_cat2(str, ">"); return str; };T;)I"static VALUE;T;*To;;F; ;;;;I"UnboundMethod#to_s;F;[;[[@i‡;T;;q;0;[;{;IC;"2Returns a human-readable description of the underlying method. "cat".method(:count).inspect #=> "#" (1..3).method(:map).inspect #=> "#" In the latter case, the method description includes the "owner" of the original method (+Enumerable+ module, which is included into +Range+). +inspect+ also provides, when possible, method argument names (call sequence) and source location. require 'net/http' Net::HTTP.method(:get).inspect #=> "#/lib/ruby/2.7.0/net/http.rb:457>" ... in argument definition means argument is optional (has some default value). For methods defined in C (language core and extensions), location and argument names can't be extracted, and only generic information is provided in form of * (any number of arguments) or _ (some positional argument). "cat".method(:count).inspect #=> "#" "cat".method(:+).inspect #=> "#