Ruby 3.5.0dev (2025-08-07 revision ebb775be8d30e42da66597997bccf57c0d33f58d)
struct.c (ebb775be8d30e42da66597997bccf57c0d33f58d)
1/**********************************************************************
2
3 struct.c -
4
5 $Author$
6 created at: Tue Mar 22 18:44:30 JST 1995
7
8 Copyright (C) 1993-2007 Yukihiro Matsumoto
9
10**********************************************************************/
11
12#include "id.h"
13#include "internal.h"
14#include "internal/class.h"
15#include "internal/error.h"
16#include "internal/hash.h"
17#include "internal/object.h"
18#include "internal/proc.h"
19#include "internal/struct.h"
20#include "internal/symbol.h"
21#include "vm_core.h"
22#include "builtin.h"
23
24/* only for struct[:field] access */
25enum {
26 AREF_HASH_UNIT = 5,
27 AREF_HASH_THRESHOLD = 10
28};
29
30/* Note: Data is a stricter version of the Struct: no attr writers & no
31 hash-alike/array-alike behavior. It shares most of the implementation
32 on the C level, but is unrelated on the Ruby level. */
34static VALUE rb_cData;
35static ID id_members, id_back_members, id_keyword_init;
36
37static VALUE struct_alloc(VALUE);
38
39static inline VALUE
40struct_ivar_get(VALUE c, ID id)
41{
42 VALUE orig = c;
43 VALUE ivar = rb_attr_get(c, id);
44
45 if (!NIL_P(ivar))
46 return ivar;
47
48 for (;;) {
50 if (c == rb_cStruct || c == rb_cData || !RTEST(c))
51 return Qnil;
53 ivar = rb_attr_get(c, id);
54 if (!NIL_P(ivar)) {
55 if (!OBJ_FROZEN(orig)) rb_ivar_set(orig, id, ivar);
56 return ivar;
57 }
58 }
59}
60
62rb_struct_s_keyword_init(VALUE klass)
63{
64 return struct_ivar_get(klass, id_keyword_init);
65}
66
69{
70 VALUE members = struct_ivar_get(klass, id_members);
71
72 if (NIL_P(members)) {
73 rb_raise(rb_eTypeError, "uninitialized struct");
74 }
75 if (!RB_TYPE_P(members, T_ARRAY)) {
76 rb_raise(rb_eTypeError, "corrupted struct");
77 }
78 return members;
79}
80
83{
85
86 if (RSTRUCT_LEN(s) != RARRAY_LEN(members)) {
87 rb_raise(rb_eTypeError, "struct size differs (%ld required %ld given)",
88 RARRAY_LEN(members), RSTRUCT_LEN(s));
89 }
90 return members;
91}
92
93static long
94struct_member_pos_ideal(VALUE name, long mask)
95{
96 /* (id & (mask/2)) * 2 */
97 return (SYM2ID(name) >> (ID_SCOPE_SHIFT - 1)) & mask;
98}
99
100static long
101struct_member_pos_probe(long prev, long mask)
102{
103 /* (((prev/2) * AREF_HASH_UNIT + 1) & (mask/2)) * 2 */
104 return (prev * AREF_HASH_UNIT + 2) & mask;
105}
106
107static VALUE
108struct_set_members(VALUE klass, VALUE /* frozen hidden array */ members)
109{
110 VALUE back;
111 const long members_length = RARRAY_LEN(members);
112
113 if (members_length <= AREF_HASH_THRESHOLD) {
114 back = members;
115 }
116 else {
117 long i, j, mask = 64;
118 VALUE name;
119
120 while (mask < members_length * AREF_HASH_UNIT) mask *= 2;
121
122 back = rb_ary_hidden_new(mask + 1);
123 rb_ary_store(back, mask, INT2FIX(members_length));
124 mask -= 2; /* mask = (2**k-1)*2 */
125
126 for (i=0; i < members_length; i++) {
127 name = RARRAY_AREF(members, i);
128
129 j = struct_member_pos_ideal(name, mask);
130
131 for (;;) {
132 if (!RTEST(RARRAY_AREF(back, j))) {
133 rb_ary_store(back, j, name);
134 rb_ary_store(back, j + 1, INT2FIX(i));
135 break;
136 }
137 j = struct_member_pos_probe(j, mask);
138 }
139 }
140 OBJ_FREEZE(back);
141 }
142 rb_ivar_set(klass, id_members, members);
143 rb_ivar_set(klass, id_back_members, back);
144
145 return members;
146}
147
148static inline int
149struct_member_pos(VALUE s, VALUE name)
150{
151 VALUE back = struct_ivar_get(rb_obj_class(s), id_back_members);
152 long j, mask;
153
154 if (UNLIKELY(NIL_P(back))) {
155 rb_raise(rb_eTypeError, "uninitialized struct");
156 }
157 if (UNLIKELY(!RB_TYPE_P(back, T_ARRAY))) {
158 rb_raise(rb_eTypeError, "corrupted struct");
159 }
160
161 mask = RARRAY_LEN(back);
162
163 if (mask <= AREF_HASH_THRESHOLD) {
164 if (UNLIKELY(RSTRUCT_LEN(s) != mask)) {
165 rb_raise(rb_eTypeError,
166 "struct size differs (%ld required %ld given)",
167 mask, RSTRUCT_LEN(s));
168 }
169 for (j = 0; j < mask; j++) {
170 if (RARRAY_AREF(back, j) == name)
171 return (int)j;
172 }
173 return -1;
174 }
175
176 if (UNLIKELY(RSTRUCT_LEN(s) != FIX2INT(RARRAY_AREF(back, mask-1)))) {
177 rb_raise(rb_eTypeError, "struct size differs (%d required %ld given)",
178 FIX2INT(RARRAY_AREF(back, mask-1)), RSTRUCT_LEN(s));
179 }
180
181 mask -= 3;
182 j = struct_member_pos_ideal(name, mask);
183
184 for (;;) {
185 VALUE e = RARRAY_AREF(back, j);
186 if (e == name)
187 return FIX2INT(RARRAY_AREF(back, j + 1));
188 if (!RTEST(e)) {
189 return -1;
190 }
191 j = struct_member_pos_probe(j, mask);
192 }
193}
194
195/*
196 * call-seq:
197 * StructClass::members -> array_of_symbols
198 *
199 * Returns the member names of the Struct descendant as an array:
200 *
201 * Customer = Struct.new(:name, :address, :zip)
202 * Customer.members # => [:name, :address, :zip]
203 *
204 */
205
206static VALUE
207rb_struct_s_members_m(VALUE klass)
208{
209 VALUE members = rb_struct_s_members(klass);
210
211 return rb_ary_dup(members);
212}
213
214/*
215 * call-seq:
216 * members -> array_of_symbols
217 *
218 * Returns the member names from +self+ as an array:
219 *
220 * Customer = Struct.new(:name, :address, :zip)
221 * Customer.new.members # => [:name, :address, :zip]
222 *
223 * Related: #to_a.
224 */
225
226static VALUE
227rb_struct_members_m(VALUE obj)
228{
229 return rb_struct_s_members_m(rb_obj_class(obj));
230}
231
232VALUE
234{
235 VALUE slot = ID2SYM(id);
236 int i = struct_member_pos(obj, slot);
237 if (i != -1) {
238 return RSTRUCT_GET(obj, i);
239 }
240 rb_name_err_raise("'%1$s' is not a struct member", obj, ID2SYM(id));
241
243}
244
245static void
246rb_struct_modify(VALUE s)
247{
248 rb_check_frozen(s);
249}
250
251static VALUE
252anonymous_struct(VALUE klass)
253{
254 VALUE nstr;
255
256 nstr = rb_class_new(klass);
257 rb_make_metaclass(nstr, RBASIC(klass)->klass);
258 rb_class_inherited(klass, nstr);
259 return nstr;
260}
261
262static VALUE
263new_struct(VALUE name, VALUE super)
264{
265 /* old style: should we warn? */
266 ID id;
267 name = rb_str_to_str(name);
268 if (!rb_is_const_name(name)) {
269 rb_name_err_raise("identifier %1$s needs to be constant",
270 super, name);
271 }
272 id = rb_to_id(name);
273 if (rb_const_defined_at(super, id)) {
274 rb_warn("redefining constant %"PRIsVALUE"::%"PRIsVALUE, super, name);
275 rb_mod_remove_const(super, ID2SYM(id));
276 }
277 return rb_define_class_id_under_no_pin(super, id, super);
278}
279
280NORETURN(static void invalid_struct_pos(VALUE s, VALUE idx));
281
282static void
283define_aref_method(VALUE nstr, VALUE name, VALUE off)
284{
285 rb_add_method_optimized(nstr, SYM2ID(name), OPTIMIZED_METHOD_TYPE_STRUCT_AREF, FIX2UINT(off), METHOD_VISI_PUBLIC);
286}
287
288static void
289define_aset_method(VALUE nstr, VALUE name, VALUE off)
290{
291 rb_add_method_optimized(nstr, SYM2ID(name), OPTIMIZED_METHOD_TYPE_STRUCT_ASET, FIX2UINT(off), METHOD_VISI_PUBLIC);
292}
293
294static VALUE
295rb_struct_s_inspect(VALUE klass)
296{
297 VALUE inspect = rb_class_name(klass);
298 if (RTEST(rb_struct_s_keyword_init(klass))) {
299 rb_str_cat_cstr(inspect, "(keyword_init: true)");
300 }
301 return inspect;
302}
303
304static VALUE
305rb_data_s_new(int argc, const VALUE *argv, VALUE klass)
306{
307 if (rb_keyword_given_p()) {
308 if (argc > 1 || !RB_TYPE_P(argv[0], T_HASH)) {
309 rb_error_arity(argc, 0, 0);
310 }
311 return rb_class_new_instance_pass_kw(argc, argv, klass);
312 }
313 else {
314 VALUE members = struct_ivar_get(klass, id_members);
315 int num_members = RARRAY_LENINT(members);
316
317 rb_check_arity(argc, 0, num_members);
318 VALUE arg_hash = rb_hash_new_with_size(argc);
319 for (long i=0; i<argc; i++) {
320 VALUE k = rb_ary_entry(members, i), v = argv[i];
321 rb_hash_aset(arg_hash, k, v);
322 }
323 return rb_class_new_instance_kw(1, &arg_hash, klass, RB_PASS_KEYWORDS);
324 }
325}
326
327#if 0 /* for RDoc */
328
329/*
330 * call-seq:
331 * StructClass::keyword_init? -> true or falsy value
332 *
333 * Returns +true+ if the class was initialized with <tt>keyword_init: true</tt>.
334 * Otherwise returns +nil+ or +false+.
335 *
336 * Examples:
337 * Foo = Struct.new(:a)
338 * Foo.keyword_init? # => nil
339 * Bar = Struct.new(:a, keyword_init: true)
340 * Bar.keyword_init? # => true
341 * Baz = Struct.new(:a, keyword_init: false)
342 * Baz.keyword_init? # => false
343 */
344static VALUE
345rb_struct_s_keyword_init_p(VALUE obj)
346{
347}
348#endif
349
350#define rb_struct_s_keyword_init_p rb_struct_s_keyword_init
351
352static VALUE
353setup_struct(VALUE nstr, VALUE members)
354{
355 long i, len;
356
357 members = struct_set_members(nstr, members);
358
359 rb_define_alloc_func(nstr, struct_alloc);
362 rb_define_singleton_method(nstr, "members", rb_struct_s_members_m, 0);
363 rb_define_singleton_method(nstr, "inspect", rb_struct_s_inspect, 0);
364 rb_define_singleton_method(nstr, "keyword_init?", rb_struct_s_keyword_init_p, 0);
365
366 len = RARRAY_LEN(members);
367 for (i=0; i< len; i++) {
368 VALUE sym = RARRAY_AREF(members, i);
369 ID id = SYM2ID(sym);
370 VALUE off = LONG2NUM(i);
371
372 define_aref_method(nstr, sym, off);
373 define_aset_method(nstr, ID2SYM(rb_id_attrset(id)), off);
374 }
375
376 return nstr;
377}
378
379static VALUE
380setup_data(VALUE subclass, VALUE members)
381{
382 long i, len;
383
384 members = struct_set_members(subclass, members);
385
386 rb_define_alloc_func(subclass, struct_alloc);
387 VALUE sclass = rb_singleton_class(subclass);
388 rb_undef_method(sclass, "define");
389 rb_define_method(sclass, "new", rb_data_s_new, -1);
390 rb_define_method(sclass, "[]", rb_data_s_new, -1);
391 rb_define_method(sclass, "members", rb_struct_s_members_m, 0);
392 rb_define_method(sclass, "inspect", rb_struct_s_inspect, 0); // FIXME: just a separate method?..
393
394 len = RARRAY_LEN(members);
395 for (i=0; i< len; i++) {
396 VALUE sym = RARRAY_AREF(members, i);
397 VALUE off = LONG2NUM(i);
398
399 define_aref_method(subclass, sym, off);
400 }
401
402 return subclass;
403}
404
405VALUE
407{
408 return struct_alloc(klass);
409}
410
411static VALUE
412struct_make_members_list(va_list ar)
413{
414 char *mem;
415 VALUE ary, list = rb_ident_hash_new();
416 RBASIC_CLEAR_CLASS(list);
417 while ((mem = va_arg(ar, char*)) != 0) {
418 VALUE sym = rb_sym_intern_ascii_cstr(mem);
419 if (RTEST(rb_hash_has_key(list, sym))) {
420 rb_raise(rb_eArgError, "duplicate member: %s", mem);
421 }
422 rb_hash_aset(list, sym, Qtrue);
423 }
424 ary = rb_hash_keys(list);
425 RBASIC_CLEAR_CLASS(ary);
426 OBJ_FREEZE(ary);
427 return ary;
428}
429
430static VALUE
431struct_define_without_accessor(VALUE outer, const char *class_name, VALUE super, rb_alloc_func_t alloc, VALUE members)
432{
433 VALUE klass;
434
435 if (class_name) {
436 if (outer) {
437 klass = rb_define_class_under(outer, class_name, super);
438 }
439 else {
440 klass = rb_define_class(class_name, super);
441 }
442 }
443 else {
444 klass = anonymous_struct(super);
445 }
446
447 struct_set_members(klass, members);
448
449 if (alloc) {
450 rb_define_alloc_func(klass, alloc);
451 }
452 else {
453 rb_define_alloc_func(klass, struct_alloc);
454 }
455
456 return klass;
457}
458
459VALUE
460rb_struct_define_without_accessor_under(VALUE outer, const char *class_name, VALUE super, rb_alloc_func_t alloc, ...)
461{
462 va_list ar;
463 VALUE members;
464
465 va_start(ar, alloc);
466 members = struct_make_members_list(ar);
467 va_end(ar);
468
469 return struct_define_without_accessor(outer, class_name, super, alloc, members);
470}
471
472VALUE
473rb_struct_define_without_accessor(const char *class_name, VALUE super, rb_alloc_func_t alloc, ...)
474{
475 va_list ar;
476 VALUE members;
477
478 va_start(ar, alloc);
479 members = struct_make_members_list(ar);
480 va_end(ar);
481
482 return struct_define_without_accessor(0, class_name, super, alloc, members);
483}
484
485VALUE
486rb_struct_define(const char *name, ...)
487{
488 va_list ar;
489 VALUE st, ary;
490
491 va_start(ar, name);
492 ary = struct_make_members_list(ar);
493 va_end(ar);
494
495 if (!name) {
496 st = anonymous_struct(rb_cStruct);
497 }
498 else {
499 st = new_struct(rb_str_new2(name), rb_cStruct);
500 rb_vm_register_global_object(st);
501 }
502 return setup_struct(st, ary);
503}
504
505VALUE
506rb_struct_define_under(VALUE outer, const char *name, ...)
507{
508 va_list ar;
509 VALUE ary;
510
511 va_start(ar, name);
512 ary = struct_make_members_list(ar);
513 va_end(ar);
514
515 return setup_struct(rb_define_class_id_under(outer, rb_intern(name), rb_cStruct), ary);
516}
517
518/*
519 * call-seq:
520 * Struct.new(*member_names, keyword_init: nil){|Struct_subclass| ... } -> Struct_subclass
521 * Struct.new(class_name, *member_names, keyword_init: nil){|Struct_subclass| ... } -> Struct_subclass
522 * Struct_subclass.new(*member_names) -> Struct_subclass_instance
523 * Struct_subclass.new(**member_names) -> Struct_subclass_instance
524 *
525 * <tt>Struct.new</tt> returns a new subclass of +Struct+. The new subclass:
526 *
527 * - May be anonymous, or may have the name given by +class_name+.
528 * - May have members as given by +member_names+.
529 * - May have initialization via ordinary arguments, or via keyword arguments
530 *
531 * The new subclass has its own method <tt>::new</tt>; thus:
532 *
533 * Foo = Struct.new('Foo', :foo, :bar) # => Struct::Foo
534 * f = Foo.new(0, 1) # => #<struct Struct::Foo foo=0, bar=1>
535 *
536 * <b>Class Name</b>
537 *
538 * With string argument +class_name+,
539 * returns a new subclass of +Struct+ named <tt>Struct::<em>class_name</em></tt>:
540 *
541 * Foo = Struct.new('Foo', :foo, :bar) # => Struct::Foo
542 * Foo.name # => "Struct::Foo"
543 * Foo.superclass # => Struct
544 *
545 * Without string argument +class_name+,
546 * returns a new anonymous subclass of +Struct+:
547 *
548 * Struct.new(:foo, :bar).name # => nil
549 *
550 * <b>Block</b>
551 *
552 * With a block given, the created subclass is yielded to the block:
553 *
554 * Customer = Struct.new('Customer', :name, :address) do |new_class|
555 * p "The new subclass is #{new_class}"
556 * def greeting
557 * "Hello #{name} at #{address}"
558 * end
559 * end # => Struct::Customer
560 * dave = Customer.new('Dave', '123 Main')
561 * dave # => #<struct Struct::Customer name="Dave", address="123 Main">
562 * dave.greeting # => "Hello Dave at 123 Main"
563 *
564 * Output, from <tt>Struct.new</tt>:
565 *
566 * "The new subclass is Struct::Customer"
567 *
568 * <b>Member Names</b>
569 *
570 * Symbol arguments +member_names+
571 * determines the members of the new subclass:
572 *
573 * Struct.new(:foo, :bar).members # => [:foo, :bar]
574 * Struct.new('Foo', :foo, :bar).members # => [:foo, :bar]
575 *
576 * The new subclass has instance methods corresponding to +member_names+:
577 *
578 * Foo = Struct.new('Foo', :foo, :bar)
579 * Foo.instance_methods(false) # => [:foo, :bar, :foo=, :bar=]
580 * f = Foo.new # => #<struct Struct::Foo foo=nil, bar=nil>
581 * f.foo # => nil
582 * f.foo = 0 # => 0
583 * f.bar # => nil
584 * f.bar = 1 # => 1
585 * f # => #<struct Struct::Foo foo=0, bar=1>
586 *
587 * <b>Singleton Methods</b>
588 *
589 * A subclass returned by Struct.new has these singleton methods:
590 *
591 * - Method <tt>::new </tt> creates an instance of the subclass:
592 *
593 * Foo.new # => #<struct Struct::Foo foo=nil, bar=nil>
594 * Foo.new(0) # => #<struct Struct::Foo foo=0, bar=nil>
595 * Foo.new(0, 1) # => #<struct Struct::Foo foo=0, bar=1>
596 * Foo.new(0, 1, 2) # Raises ArgumentError: struct size differs
597 *
598 * # Initialization with keyword arguments:
599 * Foo.new(foo: 0) # => #<struct Struct::Foo foo=0, bar=nil>
600 * Foo.new(foo: 0, bar: 1) # => #<struct Struct::Foo foo=0, bar=1>
601 * Foo.new(foo: 0, bar: 1, baz: 2)
602 * # Raises ArgumentError: unknown keywords: baz
603 *
604 * - Method <tt>:inspect</tt> returns a string representation of the subclass:
605 *
606 * Foo.inspect
607 * # => "Struct::Foo"
608 *
609 * - Method <tt>::members</tt> returns an array of the member names:
610 *
611 * Foo.members # => [:foo, :bar]
612 *
613 * <b>Keyword Argument</b>
614 *
615 * By default, the arguments for initializing an instance of the new subclass
616 * can be both positional and keyword arguments.
617 *
618 * Optional keyword argument <tt>keyword_init:</tt> allows to force only one
619 * type of arguments to be accepted:
620 *
621 * KeywordsOnly = Struct.new(:foo, :bar, keyword_init: true)
622 * KeywordsOnly.new(bar: 1, foo: 0)
623 * # => #<struct KeywordsOnly foo=0, bar=1>
624 * KeywordsOnly.new(0, 1)
625 * # Raises ArgumentError: wrong number of arguments
626 *
627 * PositionalOnly = Struct.new(:foo, :bar, keyword_init: false)
628 * PositionalOnly.new(0, 1)
629 * # => #<struct PositionalOnly foo=0, bar=1>
630 * PositionalOnly.new(bar: 1, foo: 0)
631 * # => #<struct PositionalOnly foo={:foo=>1, :bar=>2}, bar=nil>
632 * # Note that no error is raised, but arguments treated as one hash value
633 *
634 * # Same as not providing keyword_init:
635 * Any = Struct.new(:foo, :bar, keyword_init: nil)
636 * Any.new(foo: 1, bar: 2)
637 * # => #<struct Any foo=1, bar=2>
638 * Any.new(1, 2)
639 * # => #<struct Any foo=1, bar=2>
640 */
641
642static VALUE
643rb_struct_s_def(int argc, VALUE *argv, VALUE klass)
644{
645 VALUE name = Qnil, rest, keyword_init = Qnil;
646 long i;
647 VALUE st;
648 VALUE opt;
649
650 argc = rb_scan_args(argc, argv, "0*:", NULL, &opt);
651 if (argc >= 1 && !SYMBOL_P(argv[0])) {
652 name = argv[0];
653 --argc;
654 ++argv;
655 }
656
657 if (!NIL_P(opt)) {
658 static ID keyword_ids[1];
659
660 if (!keyword_ids[0]) {
661 keyword_ids[0] = rb_intern("keyword_init");
662 }
663 rb_get_kwargs(opt, keyword_ids, 0, 1, &keyword_init);
664 if (UNDEF_P(keyword_init)) {
665 keyword_init = Qnil;
666 }
667 else if (RTEST(keyword_init)) {
668 keyword_init = Qtrue;
669 }
670 }
671
672 rest = rb_ident_hash_new();
673 RBASIC_CLEAR_CLASS(rest);
674 for (i=0; i<argc; i++) {
675 VALUE mem = rb_to_symbol(argv[i]);
676 if (rb_is_attrset_sym(mem)) {
677 rb_raise(rb_eArgError, "invalid struct member: %"PRIsVALUE, mem);
678 }
679 if (RTEST(rb_hash_has_key(rest, mem))) {
680 rb_raise(rb_eArgError, "duplicate member: %"PRIsVALUE, mem);
681 }
682 rb_hash_aset(rest, mem, Qtrue);
683 }
684 rest = rb_hash_keys(rest);
685 RBASIC_CLEAR_CLASS(rest);
686 OBJ_FREEZE(rest);
687 if (NIL_P(name)) {
688 st = anonymous_struct(klass);
689 }
690 else {
691 st = new_struct(name, klass);
692 }
693 setup_struct(st, rest);
694 rb_ivar_set(st, id_keyword_init, keyword_init);
695 if (rb_block_given_p()) {
696 rb_mod_module_eval(0, 0, st);
697 }
698
699 return st;
700}
701
702static long
703num_members(VALUE klass)
704{
705 VALUE members;
706 members = struct_ivar_get(klass, id_members);
707 if (!RB_TYPE_P(members, T_ARRAY)) {
708 rb_raise(rb_eTypeError, "broken members");
709 }
710 return RARRAY_LEN(members);
711}
712
713/*
714 */
715
717 VALUE self;
718 VALUE unknown_keywords;
719};
720
721static int rb_struct_pos(VALUE s, VALUE *name);
722
723static int
724struct_hash_set_i(VALUE key, VALUE val, VALUE arg)
725{
726 struct struct_hash_set_arg *args = (struct struct_hash_set_arg *)arg;
727 int i = rb_struct_pos(args->self, &key);
728 if (i < 0) {
729 if (NIL_P(args->unknown_keywords)) {
730 args->unknown_keywords = rb_ary_new();
731 }
732 rb_ary_push(args->unknown_keywords, key);
733 }
734 else {
735 rb_struct_modify(args->self);
736 RSTRUCT_SET(args->self, i, val);
737 }
738 return ST_CONTINUE;
739}
740
741static VALUE
742rb_struct_initialize_m(int argc, const VALUE *argv, VALUE self)
743{
744 VALUE klass = rb_obj_class(self);
745 rb_struct_modify(self);
746 long n = num_members(klass);
747 if (argc == 0) {
748 rb_mem_clear((VALUE *)RSTRUCT_CONST_PTR(self), n);
749 return Qnil;
750 }
751
752 bool keyword_init = false;
753 switch (rb_struct_s_keyword_init(klass)) {
754 default:
755 if (argc > 1 || !RB_TYPE_P(argv[0], T_HASH)) {
756 rb_error_arity(argc, 0, 0);
757 }
758 keyword_init = true;
759 break;
760 case Qfalse:
761 break;
762 case Qnil:
763 if (argc > 1 || !RB_TYPE_P(argv[0], T_HASH)) {
764 break;
765 }
766 keyword_init = rb_keyword_given_p();
767 break;
768 }
769 if (keyword_init) {
770 struct struct_hash_set_arg arg;
771 rb_mem_clear((VALUE *)RSTRUCT_CONST_PTR(self), n);
772 arg.self = self;
773 arg.unknown_keywords = Qnil;
774 rb_hash_foreach(argv[0], struct_hash_set_i, (VALUE)&arg);
775 if (arg.unknown_keywords != Qnil) {
776 rb_raise(rb_eArgError, "unknown keywords: %s",
777 RSTRING_PTR(rb_ary_join(arg.unknown_keywords, rb_str_new2(", "))));
778 }
779 }
780 else {
781 if (n < argc) {
782 rb_raise(rb_eArgError, "struct size differs");
783 }
784 for (long i=0; i<argc; i++) {
785 RSTRUCT_SET(self, i, argv[i]);
786 }
787 if (n > argc) {
788 rb_mem_clear((VALUE *)RSTRUCT_CONST_PTR(self)+argc, n-argc);
789 }
790 }
791 return Qnil;
792}
793
794VALUE
796{
797 rb_struct_initialize_m(RARRAY_LENINT(values), RARRAY_CONST_PTR(values), self);
798 if (rb_obj_is_kind_of(self, rb_cData)) OBJ_FREEZE(self);
799 RB_GC_GUARD(values);
800 return Qnil;
801}
802
803static VALUE *
804struct_heap_alloc(VALUE st, size_t len)
805{
806 return ALLOC_N(VALUE, len);
807}
808
809static VALUE
810struct_alloc(VALUE klass)
811{
812 long n = num_members(klass);
813 size_t embedded_size = offsetof(struct RStruct, as.ary) + (sizeof(VALUE) * n);
814 if (RCLASS_MAX_IV_COUNT(klass) > 0) {
815 embedded_size += sizeof(VALUE);
816 }
817
819
820 if (n > 0 && rb_gc_size_allocatable_p(embedded_size)) {
821 flags |= n << RSTRUCT_EMBED_LEN_SHIFT;
822
823 NEWOBJ_OF(st, struct RStruct, klass, flags, embedded_size, 0);
824 if (RCLASS_MAX_IV_COUNT(klass) == 0 && embedded_size == rb_gc_obj_slot_size((VALUE)st)) {
825 FL_SET_RAW((VALUE)st, RSTRUCT_GEN_FIELDS);
826 }
827 else {
828 RSTRUCT_SET_FIELDS_OBJ((VALUE)st, 0);
829 }
830 rb_mem_clear((VALUE *)st->as.ary, n);
831
832 return (VALUE)st;
833 }
834 else {
835 NEWOBJ_OF(st, struct RStruct, klass, flags, sizeof(struct RStruct), 0);
836
837 st->as.heap.ptr = struct_heap_alloc((VALUE)st, n);
838 rb_mem_clear((VALUE *)st->as.heap.ptr, n);
839 st->as.heap.len = n;
840
841 return (VALUE)st;
842 }
843}
844
845VALUE
847{
848 return rb_class_new_instance(RARRAY_LENINT(values), RARRAY_CONST_PTR(values), klass);
849}
850
851VALUE
853{
854 VALUE tmpargs[16], *mem = tmpargs;
855 int size, i;
856 va_list args;
857
858 size = rb_long2int(num_members(klass));
859 if (size > numberof(tmpargs)) {
860 tmpargs[0] = rb_ary_hidden_new(size);
861 mem = RARRAY_PTR(tmpargs[0]);
862 }
863 va_start(args, klass);
864 for (i=0; i<size; i++) {
865 mem[i] = va_arg(args, VALUE);
866 }
867 va_end(args);
868
869 return rb_class_new_instance(size, mem, klass);
870}
871
872static VALUE
873struct_enum_size(VALUE s, VALUE args, VALUE eobj)
874{
875 return rb_struct_size(s);
876}
877
878/*
879 * call-seq:
880 * each {|value| ... } -> self
881 * each -> enumerator
882 *
883 * Calls the given block with the value of each member; returns +self+:
884 *
885 * Customer = Struct.new(:name, :address, :zip)
886 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
887 * joe.each {|value| p value }
888 *
889 * Output:
890 *
891 * "Joe Smith"
892 * "123 Maple, Anytown NC"
893 * 12345
894 *
895 * Returns an Enumerator if no block is given.
896 *
897 * Related: #each_pair.
898 */
899
900static VALUE
901rb_struct_each(VALUE s)
902{
903 long i;
904
905 RETURN_SIZED_ENUMERATOR(s, 0, 0, struct_enum_size);
906 for (i=0; i<RSTRUCT_LEN(s); i++) {
907 rb_yield(RSTRUCT_GET(s, i));
908 }
909 return s;
910}
911
912/*
913 * call-seq:
914 * each_pair {|(name, value)| ... } -> self
915 * each_pair -> enumerator
916 *
917 * Calls the given block with each member name/value pair; returns +self+:
918 *
919 * Customer = Struct.new(:name, :address, :zip) # => Customer
920 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
921 * joe.each_pair {|(name, value)| p "#{name} => #{value}" }
922 *
923 * Output:
924 *
925 * "name => Joe Smith"
926 * "address => 123 Maple, Anytown NC"
927 * "zip => 12345"
928 *
929 * Returns an Enumerator if no block is given.
930 *
931 * Related: #each.
932 *
933 */
934
935static VALUE
936rb_struct_each_pair(VALUE s)
937{
938 VALUE members;
939 long i;
940
941 RETURN_SIZED_ENUMERATOR(s, 0, 0, struct_enum_size);
942 members = rb_struct_members(s);
943 if (rb_block_pair_yield_optimizable()) {
944 for (i=0; i<RSTRUCT_LEN(s); i++) {
945 VALUE key = rb_ary_entry(members, i);
946 VALUE value = RSTRUCT_GET(s, i);
947 rb_yield_values(2, key, value);
948 }
949 }
950 else {
951 for (i=0; i<RSTRUCT_LEN(s); i++) {
952 VALUE key = rb_ary_entry(members, i);
953 VALUE value = RSTRUCT_GET(s, i);
954 rb_yield(rb_assoc_new(key, value));
955 }
956 }
957 return s;
958}
959
960static VALUE
961inspect_struct(VALUE s, VALUE prefix, int recur)
962{
963 VALUE cname = rb_class_path(rb_obj_class(s));
964 VALUE members;
965 VALUE str = prefix;
966 long i, len;
967 char first = RSTRING_PTR(cname)[0];
968
969 if (recur || first != '#') {
970 rb_str_append(str, cname);
971 }
972 if (recur) {
973 return rb_str_cat2(str, ":...>");
974 }
975
976 members = rb_struct_members(s);
977 len = RSTRUCT_LEN(s);
978
979 for (i=0; i<len; i++) {
980 VALUE slot;
981 ID id;
982
983 if (i > 0) {
984 rb_str_cat2(str, ", ");
985 }
986 else if (first != '#') {
987 rb_str_cat2(str, " ");
988 }
989 slot = RARRAY_AREF(members, i);
990 id = SYM2ID(slot);
991 if (rb_is_local_id(id) || rb_is_const_id(id)) {
992 rb_str_append(str, rb_id2str(id));
993 }
994 else {
995 rb_str_append(str, rb_inspect(slot));
996 }
997 rb_str_cat2(str, "=");
998 rb_str_append(str, rb_inspect(RSTRUCT_GET(s, i)));
999 }
1000 rb_str_cat2(str, ">");
1001
1002 return str;
1003}
1004
1005/*
1006 * call-seq:
1007 * inspect -> string
1008 *
1009 * Returns a string representation of +self+:
1010 *
1011 * Customer = Struct.new(:name, :address, :zip) # => Customer
1012 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1013 * joe.inspect # => "#<struct Customer name=\"Joe Smith\", address=\"123 Maple, Anytown NC\", zip=12345>"
1014 *
1015 */
1016
1017static VALUE
1018rb_struct_inspect(VALUE s)
1019{
1020 return rb_exec_recursive(inspect_struct, s, rb_str_new2("#<struct "));
1021}
1022
1023/*
1024 * call-seq:
1025 * to_a -> array
1026 *
1027 * Returns the values in +self+ as an array:
1028 *
1029 * Customer = Struct.new(:name, :address, :zip)
1030 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1031 * joe.to_a # => ["Joe Smith", "123 Maple, Anytown NC", 12345]
1032 *
1033 * Related: #members.
1034 */
1035
1036static VALUE
1037rb_struct_to_a(VALUE s)
1038{
1039 return rb_ary_new4(RSTRUCT_LEN(s), RSTRUCT_CONST_PTR(s));
1040}
1041
1042/*
1043 * call-seq:
1044 * to_h -> hash
1045 * to_h {|name, value| ... } -> hash
1046 *
1047 * Returns a hash containing the name and value for each member:
1048 *
1049 * Customer = Struct.new(:name, :address, :zip)
1050 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1051 * h = joe.to_h
1052 * h # => {:name=>"Joe Smith", :address=>"123 Maple, Anytown NC", :zip=>12345}
1053 *
1054 * If a block is given, it is called with each name/value pair;
1055 * the block should return a 2-element array whose elements will become
1056 * a key/value pair in the returned hash:
1057 *
1058 * h = joe.to_h{|name, value| [name.upcase, value.to_s.upcase]}
1059 * h # => {:NAME=>"JOE SMITH", :ADDRESS=>"123 MAPLE, ANYTOWN NC", :ZIP=>"12345"}
1060 *
1061 * Raises ArgumentError if the block returns an inappropriate value.
1062 *
1063 */
1064
1065static VALUE
1066rb_struct_to_h(VALUE s)
1067{
1068 VALUE h = rb_hash_new_with_size(RSTRUCT_LEN(s));
1069 VALUE members = rb_struct_members(s);
1070 long i;
1071 int block_given = rb_block_given_p();
1072
1073 for (i=0; i<RSTRUCT_LEN(s); i++) {
1074 VALUE k = rb_ary_entry(members, i), v = RSTRUCT_GET(s, i);
1075 if (block_given)
1076 rb_hash_set_pair(h, rb_yield_values(2, k, v));
1077 else
1078 rb_hash_aset(h, k, v);
1079 }
1080 return h;
1081}
1082
1083/*
1084 * call-seq:
1085 * deconstruct_keys(array_of_names) -> hash
1086 *
1087 * Returns a hash of the name/value pairs for the given member names.
1088 *
1089 * Customer = Struct.new(:name, :address, :zip)
1090 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1091 * h = joe.deconstruct_keys([:zip, :address])
1092 * h # => {:zip=>12345, :address=>"123 Maple, Anytown NC"}
1093 *
1094 * Returns all names and values if +array_of_names+ is +nil+:
1095 *
1096 * h = joe.deconstruct_keys(nil)
1097 * h # => {:name=>"Joseph Smith, Jr.", :address=>"123 Maple, Anytown NC", :zip=>12345}
1098 *
1099 */
1100static VALUE
1101rb_struct_deconstruct_keys(VALUE s, VALUE keys)
1102{
1103 VALUE h;
1104 long i;
1105
1106 if (NIL_P(keys)) {
1107 return rb_struct_to_h(s);
1108 }
1109 if (UNLIKELY(!RB_TYPE_P(keys, T_ARRAY))) {
1110 rb_raise(rb_eTypeError,
1111 "wrong argument type %"PRIsVALUE" (expected Array or nil)",
1112 rb_obj_class(keys));
1113
1114 }
1115 if (RSTRUCT_LEN(s) < RARRAY_LEN(keys)) {
1116 return rb_hash_new_with_size(0);
1117 }
1118 h = rb_hash_new_with_size(RARRAY_LEN(keys));
1119 for (i=0; i<RARRAY_LEN(keys); i++) {
1120 VALUE key = RARRAY_AREF(keys, i);
1121 int i = rb_struct_pos(s, &key);
1122 if (i < 0) {
1123 return h;
1124 }
1125 rb_hash_aset(h, key, RSTRUCT_GET(s, i));
1126 }
1127 return h;
1128}
1129
1130/* :nodoc: */
1131VALUE
1132rb_struct_init_copy(VALUE copy, VALUE s)
1133{
1134 long i, len;
1135
1136 if (!OBJ_INIT_COPY(copy, s)) return copy;
1137 if (RSTRUCT_LEN(copy) != RSTRUCT_LEN(s)) {
1138 rb_raise(rb_eTypeError, "struct size mismatch");
1139 }
1140
1141 for (i=0, len=RSTRUCT_LEN(copy); i<len; i++) {
1142 RSTRUCT_SET(copy, i, RSTRUCT_GET(s, i));
1143 }
1144
1145 return copy;
1146}
1147
1148static int
1149rb_struct_pos(VALUE s, VALUE *name)
1150{
1151 long i;
1152 VALUE idx = *name;
1153
1154 if (SYMBOL_P(idx)) {
1155 return struct_member_pos(s, idx);
1156 }
1157 else if (RB_TYPE_P(idx, T_STRING)) {
1158 idx = rb_check_symbol(name);
1159 if (NIL_P(idx)) return -1;
1160 return struct_member_pos(s, idx);
1161 }
1162 else {
1163 long len;
1164 i = NUM2LONG(idx);
1165 len = RSTRUCT_LEN(s);
1166 if (i < 0) {
1167 if (i + len < 0) {
1168 *name = LONG2FIX(i);
1169 return -1;
1170 }
1171 i += len;
1172 }
1173 else if (len <= i) {
1174 *name = LONG2FIX(i);
1175 return -1;
1176 }
1177 return (int)i;
1178 }
1179}
1180
1181static void
1182invalid_struct_pos(VALUE s, VALUE idx)
1183{
1184 if (FIXNUM_P(idx)) {
1185 long i = FIX2INT(idx), len = RSTRUCT_LEN(s);
1186 if (i < 0) {
1187 rb_raise(rb_eIndexError, "offset %ld too small for struct(size:%ld)",
1188 i, len);
1189 }
1190 else {
1191 rb_raise(rb_eIndexError, "offset %ld too large for struct(size:%ld)",
1192 i, len);
1193 }
1194 }
1195 else {
1196 rb_name_err_raise("no member '%1$s' in struct", s, idx);
1197 }
1198}
1199
1200/*
1201 * call-seq:
1202 * struct[name] -> object
1203 * struct[n] -> object
1204 *
1205 * Returns a value from +self+.
1206 *
1207 * With symbol or string argument +name+ given, returns the value for the named member:
1208 *
1209 * Customer = Struct.new(:name, :address, :zip)
1210 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1211 * joe[:zip] # => 12345
1212 *
1213 * Raises NameError if +name+ is not the name of a member.
1214 *
1215 * With integer argument +n+ given, returns <tt>self.values[n]</tt>
1216 * if +n+ is in range;
1217 * see Array@Array+Indexes:
1218 *
1219 * joe[2] # => 12345
1220 * joe[-2] # => "123 Maple, Anytown NC"
1221 *
1222 * Raises IndexError if +n+ is out of range.
1223 *
1224 */
1225
1226VALUE
1228{
1229 int i = rb_struct_pos(s, &idx);
1230 if (i < 0) invalid_struct_pos(s, idx);
1231 return RSTRUCT_GET(s, i);
1232}
1233
1234/*
1235 * call-seq:
1236 * struct[name] = value -> value
1237 * struct[n] = value -> value
1238 *
1239 * Assigns a value to a member.
1240 *
1241 * With symbol or string argument +name+ given, assigns the given +value+
1242 * to the named member; returns +value+:
1243 *
1244 * Customer = Struct.new(:name, :address, :zip)
1245 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1246 * joe[:zip] = 54321 # => 54321
1247 * joe # => #<struct Customer name="Joe Smith", address="123 Maple, Anytown NC", zip=54321>
1248 *
1249 * Raises NameError if +name+ is not the name of a member.
1250 *
1251 * With integer argument +n+ given, assigns the given +value+
1252 * to the +n+-th member if +n+ is in range;
1253 * see Array@Array+Indexes:
1254 *
1255 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1256 * joe[2] = 54321 # => 54321
1257 * joe[-3] = 'Joseph Smith' # => "Joseph Smith"
1258 * joe # => #<struct Customer name="Joseph Smith", address="123 Maple, Anytown NC", zip=54321>
1259 *
1260 * Raises IndexError if +n+ is out of range.
1261 *
1262 */
1263
1264VALUE
1266{
1267 int i = rb_struct_pos(s, &idx);
1268 if (i < 0) invalid_struct_pos(s, idx);
1269 rb_struct_modify(s);
1270 RSTRUCT_SET(s, i, val);
1271 return val;
1272}
1273
1274FUNC_MINIMIZED(VALUE rb_struct_lookup(VALUE s, VALUE idx));
1275NOINLINE(static VALUE rb_struct_lookup_default(VALUE s, VALUE idx, VALUE notfound));
1276
1277VALUE
1278rb_struct_lookup(VALUE s, VALUE idx)
1279{
1280 return rb_struct_lookup_default(s, idx, Qnil);
1281}
1282
1283static VALUE
1284rb_struct_lookup_default(VALUE s, VALUE idx, VALUE notfound)
1285{
1286 int i = rb_struct_pos(s, &idx);
1287 if (i < 0) return notfound;
1288 return RSTRUCT_GET(s, i);
1289}
1290
1291static VALUE
1292struct_entry(VALUE s, long n)
1293{
1294 return rb_struct_aref(s, LONG2NUM(n));
1295}
1296
1297/*
1298 * call-seq:
1299 * values_at(*integers) -> array
1300 * values_at(integer_range) -> array
1301 *
1302 * Returns an array of values from +self+.
1303 *
1304 * With integer arguments +integers+ given,
1305 * returns an array containing each value given by one of +integers+:
1306 *
1307 * Customer = Struct.new(:name, :address, :zip)
1308 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1309 * joe.values_at(0, 2) # => ["Joe Smith", 12345]
1310 * joe.values_at(2, 0) # => [12345, "Joe Smith"]
1311 * joe.values_at(2, 1, 0) # => [12345, "123 Maple, Anytown NC", "Joe Smith"]
1312 * joe.values_at(0, -3) # => ["Joe Smith", "Joe Smith"]
1313 *
1314 * Raises IndexError if any of +integers+ is out of range;
1315 * see Array@Array+Indexes.
1316 *
1317 * With integer range argument +integer_range+ given,
1318 * returns an array containing each value given by the elements of the range;
1319 * fills with +nil+ values for range elements larger than the structure:
1320 *
1321 * joe.values_at(0..2)
1322 * # => ["Joe Smith", "123 Maple, Anytown NC", 12345]
1323 * joe.values_at(-3..-1)
1324 * # => ["Joe Smith", "123 Maple, Anytown NC", 12345]
1325 * joe.values_at(1..4) # => ["123 Maple, Anytown NC", 12345, nil, nil]
1326 *
1327 * Raises RangeError if any element of the range is negative and out of range;
1328 * see Array@Array+Indexes.
1329 *
1330 */
1331
1332static VALUE
1333rb_struct_values_at(int argc, VALUE *argv, VALUE s)
1334{
1335 return rb_get_values_at(s, RSTRUCT_LEN(s), argc, argv, struct_entry);
1336}
1337
1338/*
1339 * call-seq:
1340 * select {|value| ... } -> array
1341 * select -> enumerator
1342 *
1343 * With a block given, returns an array of values from +self+
1344 * for which the block returns a truthy value:
1345 *
1346 * Customer = Struct.new(:name, :address, :zip)
1347 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1348 * a = joe.select {|value| value.is_a?(String) }
1349 * a # => ["Joe Smith", "123 Maple, Anytown NC"]
1350 * a = joe.select {|value| value.is_a?(Integer) }
1351 * a # => [12345]
1352 *
1353 * With no block given, returns an Enumerator.
1354 */
1355
1356static VALUE
1357rb_struct_select(int argc, VALUE *argv, VALUE s)
1358{
1359 VALUE result;
1360 long i;
1361
1362 rb_check_arity(argc, 0, 0);
1363 RETURN_SIZED_ENUMERATOR(s, 0, 0, struct_enum_size);
1364 result = rb_ary_new();
1365 for (i = 0; i < RSTRUCT_LEN(s); i++) {
1366 if (RTEST(rb_yield(RSTRUCT_GET(s, i)))) {
1367 rb_ary_push(result, RSTRUCT_GET(s, i));
1368 }
1369 }
1370
1371 return result;
1372}
1373
1374static VALUE
1375recursive_equal(VALUE s, VALUE s2, int recur)
1376{
1377 long i, len;
1378
1379 if (recur) return Qtrue; /* Subtle! */
1380 len = RSTRUCT_LEN(s);
1381 for (i=0; i<len; i++) {
1382 if (!rb_equal(RSTRUCT_GET(s, i), RSTRUCT_GET(s2, i))) return Qfalse;
1383 }
1384 return Qtrue;
1385}
1386
1387
1388/*
1389 * call-seq:
1390 * self == other -> true or false
1391 *
1392 * Returns +true+ if and only if the following are true; otherwise returns +false+:
1393 *
1394 * - <tt>other.class == self.class</tt>.
1395 * - For each member name +name+, <tt>other.name == self.name</tt>.
1396 *
1397 * Examples:
1398 *
1399 * Customer = Struct.new(:name, :address, :zip)
1400 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1401 * joe_jr = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1402 * joe_jr == joe # => true
1403 * joe_jr[:name] = 'Joe Smith, Jr.'
1404 * # => "Joe Smith, Jr."
1405 * joe_jr == joe # => false
1406 */
1407
1408static VALUE
1409rb_struct_equal(VALUE s, VALUE s2)
1410{
1411 if (s == s2) return Qtrue;
1412 if (!RB_TYPE_P(s2, T_STRUCT)) return Qfalse;
1413 if (rb_obj_class(s) != rb_obj_class(s2)) return Qfalse;
1414 if (RSTRUCT_LEN(s) != RSTRUCT_LEN(s2)) {
1415 rb_bug("inconsistent struct"); /* should never happen */
1416 }
1417
1418 return rb_exec_recursive_paired(recursive_equal, s, s2, s2);
1419}
1420
1421/*
1422 * call-seq:
1423 * hash -> integer
1424 *
1425 * Returns the integer hash value for +self+.
1426 *
1427 * Two structs of the same class and with the same content
1428 * will have the same hash code (and will compare using Struct#eql?):
1429 *
1430 * Customer = Struct.new(:name, :address, :zip)
1431 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1432 * joe_jr = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1433 * joe.hash == joe_jr.hash # => true
1434 * joe_jr[:name] = 'Joe Smith, Jr.'
1435 * joe.hash == joe_jr.hash # => false
1436 *
1437 * Related: Object#hash.
1438 */
1439
1440static VALUE
1441rb_struct_hash(VALUE s)
1442{
1443 long i, len;
1444 st_index_t h;
1445 VALUE n;
1446
1447 h = rb_hash_start(rb_hash(rb_obj_class(s)));
1448 len = RSTRUCT_LEN(s);
1449 for (i = 0; i < len; i++) {
1450 n = rb_hash(RSTRUCT_GET(s, i));
1451 h = rb_hash_uint(h, NUM2LONG(n));
1452 }
1453 h = rb_hash_end(h);
1454 return ST2FIX(h);
1455}
1456
1457static VALUE
1458recursive_eql(VALUE s, VALUE s2, int recur)
1459{
1460 long i, len;
1461
1462 if (recur) return Qtrue; /* Subtle! */
1463 len = RSTRUCT_LEN(s);
1464 for (i=0; i<len; i++) {
1465 if (!rb_eql(RSTRUCT_GET(s, i), RSTRUCT_GET(s2, i))) return Qfalse;
1466 }
1467 return Qtrue;
1468}
1469
1470/*
1471 * call-seq:
1472 * eql?(other) -> true or false
1473 *
1474 * Returns +true+ if and only if the following are true; otherwise returns +false+:
1475 *
1476 * - <tt>other.class == self.class</tt>.
1477 * - For each member name +name+, <tt>other.name.eql?(self.name)</tt>.
1478 *
1479 * Customer = Struct.new(:name, :address, :zip)
1480 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1481 * joe_jr = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1482 * joe_jr.eql?(joe) # => true
1483 * joe_jr[:name] = 'Joe Smith, Jr.'
1484 * joe_jr.eql?(joe) # => false
1485 *
1486 * Related: Object#==.
1487 */
1488
1489static VALUE
1490rb_struct_eql(VALUE s, VALUE s2)
1491{
1492 if (s == s2) return Qtrue;
1493 if (!RB_TYPE_P(s2, T_STRUCT)) return Qfalse;
1494 if (rb_obj_class(s) != rb_obj_class(s2)) return Qfalse;
1495 if (RSTRUCT_LEN(s) != RSTRUCT_LEN(s2)) {
1496 rb_bug("inconsistent struct"); /* should never happen */
1497 }
1498
1499 return rb_exec_recursive_paired(recursive_eql, s, s2, s2);
1500}
1501
1502/*
1503 * call-seq:
1504 * size -> integer
1505 *
1506 * Returns the number of members.
1507 *
1508 * Customer = Struct.new(:name, :address, :zip)
1509 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1510 * joe.size #=> 3
1511 *
1512 */
1513
1514VALUE
1516{
1517 return LONG2FIX(RSTRUCT_LEN(s));
1518}
1519
1520/*
1521 * call-seq:
1522 * dig(name, *identifiers) -> object
1523 * dig(n, *identifiers) -> object
1524 *
1525 * Finds and returns an object among nested objects.
1526 * The nested objects may be instances of various classes.
1527 * See {Dig Methods}[rdoc-ref:dig_methods.rdoc].
1528 *
1529 *
1530 * Given symbol or string argument +name+,
1531 * returns the object that is specified by +name+ and +identifiers+:
1532 *
1533 * Foo = Struct.new(:a)
1534 * f = Foo.new(Foo.new({b: [1, 2, 3]}))
1535 * f.dig(:a) # => #<struct Foo a={:b=>[1, 2, 3]}>
1536 * f.dig(:a, :a) # => {:b=>[1, 2, 3]}
1537 * f.dig(:a, :a, :b) # => [1, 2, 3]
1538 * f.dig(:a, :a, :b, 0) # => 1
1539 * f.dig(:b, 0) # => nil
1540 *
1541 * Given integer argument +n+,
1542 * returns the object that is specified by +n+ and +identifiers+:
1543 *
1544 * f.dig(0) # => #<struct Foo a={:b=>[1, 2, 3]}>
1545 * f.dig(0, 0) # => {:b=>[1, 2, 3]}
1546 * f.dig(0, 0, :b) # => [1, 2, 3]
1547 * f.dig(0, 0, :b, 0) # => 1
1548 * f.dig(:b, 0) # => nil
1549 *
1550 */
1551
1552static VALUE
1553rb_struct_dig(int argc, VALUE *argv, VALUE self)
1554{
1556 self = rb_struct_lookup(self, *argv);
1557 if (!--argc) return self;
1558 ++argv;
1559 return rb_obj_dig(argc, argv, self, Qnil);
1560}
1561
1562/*
1563 * Document-class: Data
1564 *
1565 * Class \Data provides a convenient way to define simple classes
1566 * for value-alike objects.
1567 *
1568 * The simplest example of usage:
1569 *
1570 * Measure = Data.define(:amount, :unit)
1571 *
1572 * # Positional arguments constructor is provided
1573 * distance = Measure.new(100, 'km')
1574 * #=> #<data Measure amount=100, unit="km">
1575 *
1576 * # Keyword arguments constructor is provided
1577 * weight = Measure.new(amount: 50, unit: 'kg')
1578 * #=> #<data Measure amount=50, unit="kg">
1579 *
1580 * # Alternative form to construct an object:
1581 * speed = Measure[10, 'mPh']
1582 * #=> #<data Measure amount=10, unit="mPh">
1583 *
1584 * # Works with keyword arguments, too:
1585 * area = Measure[amount: 1.5, unit: 'm^2']
1586 * #=> #<data Measure amount=1.5, unit="m^2">
1587 *
1588 * # Argument accessors are provided:
1589 * distance.amount #=> 100
1590 * distance.unit #=> "km"
1591 *
1592 * Constructed object also has a reasonable definitions of #==
1593 * operator, #to_h hash conversion, and #deconstruct / #deconstruct_keys
1594 * to be used in pattern matching.
1595 *
1596 * ::define method accepts an optional block and evaluates it in
1597 * the context of the newly defined class. That allows to define
1598 * additional methods:
1599 *
1600 * Measure = Data.define(:amount, :unit) do
1601 * def <=>(other)
1602 * return unless other.is_a?(self.class) && other.unit == unit
1603 * amount <=> other.amount
1604 * end
1605 *
1606 * include Comparable
1607 * end
1608 *
1609 * Measure[3, 'm'] < Measure[5, 'm'] #=> true
1610 * Measure[3, 'm'] < Measure[5, 'kg']
1611 * # comparison of Measure with Measure failed (ArgumentError)
1612 *
1613 * Data provides no member writers, or enumerators: it is meant
1614 * to be a storage for immutable atomic values. But note that
1615 * if some of data members is of a mutable class, Data does no additional
1616 * immutability enforcement:
1617 *
1618 * Event = Data.define(:time, :weekdays)
1619 * event = Event.new('18:00', %w[Tue Wed Fri])
1620 * #=> #<data Event time="18:00", weekdays=["Tue", "Wed", "Fri"]>
1621 *
1622 * # There is no #time= or #weekdays= accessors, but changes are
1623 * # still possible:
1624 * event.weekdays << 'Sat'
1625 * event
1626 * #=> #<data Event time="18:00", weekdays=["Tue", "Wed", "Fri", "Sat"]>
1627 *
1628 * See also Struct, which is a similar concept, but has more
1629 * container-alike API, allowing to change contents of the object
1630 * and enumerate it.
1631 */
1632
1633/*
1634 * call-seq:
1635 * define(*symbols) -> class
1636 *
1637 * Defines a new \Data class.
1638 *
1639 * measure = Data.define(:amount, :unit)
1640 * #=> #<Class:0x00007f70c6868498>
1641 * measure.new(1, 'km')
1642 * #=> #<data amount=1, unit="km">
1643 *
1644 * # It you store the new class in the constant, it will
1645 * # affect #inspect and will be more natural to use:
1646 * Measure = Data.define(:amount, :unit)
1647 * #=> Measure
1648 * Measure.new(1, 'km')
1649 * #=> #<data Measure amount=1, unit="km">
1650 *
1651 *
1652 * Note that member-less \Data is acceptable and might be a useful technique
1653 * for defining several homogeneous data classes, like
1654 *
1655 * class HTTPFetcher
1656 * Response = Data.define(:body)
1657 * NotFound = Data.define
1658 * # ... implementation
1659 * end
1660 *
1661 * Now, different kinds of responses from +HTTPFetcher+ would have consistent
1662 * representation:
1663 *
1664 * #<data HTTPFetcher::Response body="<html...">
1665 * #<data HTTPFetcher::NotFound>
1666 *
1667 * And are convenient to use in pattern matching:
1668 *
1669 * case fetcher.get(url)
1670 * in HTTPFetcher::Response(body)
1671 * # process body variable
1672 * in HTTPFetcher::NotFound
1673 * # handle not found case
1674 * end
1675 */
1676
1677static VALUE
1678rb_data_s_def(int argc, VALUE *argv, VALUE klass)
1679{
1680 VALUE rest;
1681 long i;
1682 VALUE data_class;
1683
1684 rest = rb_ident_hash_new();
1685 RBASIC_CLEAR_CLASS(rest);
1686 for (i=0; i<argc; i++) {
1687 VALUE mem = rb_to_symbol(argv[i]);
1688 if (rb_is_attrset_sym(mem)) {
1689 rb_raise(rb_eArgError, "invalid data member: %"PRIsVALUE, mem);
1690 }
1691 if (RTEST(rb_hash_has_key(rest, mem))) {
1692 rb_raise(rb_eArgError, "duplicate member: %"PRIsVALUE, mem);
1693 }
1694 rb_hash_aset(rest, mem, Qtrue);
1695 }
1696 rest = rb_hash_keys(rest);
1697 RBASIC_CLEAR_CLASS(rest);
1698 OBJ_FREEZE(rest);
1699 data_class = anonymous_struct(klass);
1700 setup_data(data_class, rest);
1701 if (rb_block_given_p()) {
1702 rb_mod_module_eval(0, 0, data_class);
1703 }
1704
1705 return data_class;
1706}
1707
1708VALUE
1710{
1711 va_list ar;
1712 VALUE ary;
1713 va_start(ar, super);
1714 ary = struct_make_members_list(ar);
1715 va_end(ar);
1716 if (!super) super = rb_cData;
1717 VALUE klass = setup_data(anonymous_struct(super), ary);
1718 rb_vm_register_global_object(klass);
1719 return klass;
1720}
1721
1722/*
1723 * call-seq:
1724 * DataClass::members -> array_of_symbols
1725 *
1726 * Returns an array of member names of the data class:
1727 *
1728 * Measure = Data.define(:amount, :unit)
1729 * Measure.members # => [:amount, :unit]
1730 *
1731 */
1732
1733#define rb_data_s_members_m rb_struct_s_members_m
1734
1735
1736/*
1737 * call-seq:
1738 * new(*args) -> instance
1739 * new(**kwargs) -> instance
1740 * ::[](*args) -> instance
1741 * ::[](**kwargs) -> instance
1742 *
1743 * Constructors for classes defined with ::define accept both positional and
1744 * keyword arguments.
1745 *
1746 * Measure = Data.define(:amount, :unit)
1747 *
1748 * Measure.new(1, 'km')
1749 * #=> #<data Measure amount=1, unit="km">
1750 * Measure.new(amount: 1, unit: 'km')
1751 * #=> #<data Measure amount=1, unit="km">
1752 *
1753 * # Alternative shorter initialization with []
1754 * Measure[1, 'km']
1755 * #=> #<data Measure amount=1, unit="km">
1756 * Measure[amount: 1, unit: 'km']
1757 * #=> #<data Measure amount=1, unit="km">
1758 *
1759 * All arguments are mandatory (unlike Struct), and converted to keyword arguments:
1760 *
1761 * Measure.new(amount: 1)
1762 * # in `initialize': missing keyword: :unit (ArgumentError)
1763 *
1764 * Measure.new(1)
1765 * # in `initialize': missing keyword: :unit (ArgumentError)
1766 *
1767 * Note that <tt>Measure#initialize</tt> always receives keyword arguments, and that
1768 * mandatory arguments are checked in +initialize+, not in +new+. This can be
1769 * important for redefining initialize in order to convert arguments or provide
1770 * defaults:
1771 *
1772 * Measure = Data.define(:amount, :unit)
1773 * class Measure
1774 * NONE = Data.define
1775 *
1776 * def initialize(amount:, unit: NONE.new)
1777 * super(amount: Float(amount), unit:)
1778 * end
1779 * end
1780 *
1781 * Measure.new('10', 'km') # => #<data Measure amount=10.0, unit="km">
1782 * Measure.new(10_000) # => #<data Measure amount=10000.0, unit=#<data Measure::NONE>>
1783 *
1784 */
1785
1786static VALUE
1787rb_data_initialize_m(int argc, const VALUE *argv, VALUE self)
1788{
1789 VALUE klass = rb_obj_class(self);
1790 rb_struct_modify(self);
1791 VALUE members = struct_ivar_get(klass, id_members);
1792 size_t num_members = RARRAY_LEN(members);
1793
1794 if (argc == 0) {
1795 if (num_members > 0) {
1796 rb_exc_raise(rb_keyword_error_new("missing", members));
1797 }
1798 return Qnil;
1799 }
1800 if (argc > 1 || !RB_TYPE_P(argv[0], T_HASH)) {
1801 rb_error_arity(argc, 0, 0);
1802 }
1803
1804 if (RHASH_SIZE(argv[0]) < num_members) {
1805 VALUE missing = rb_ary_diff(members, rb_hash_keys(argv[0]));
1806 rb_exc_raise(rb_keyword_error_new("missing", missing));
1807 }
1808
1809 struct struct_hash_set_arg arg;
1810 rb_mem_clear((VALUE *)RSTRUCT_CONST_PTR(self), num_members);
1811 arg.self = self;
1812 arg.unknown_keywords = Qnil;
1813 rb_hash_foreach(argv[0], struct_hash_set_i, (VALUE)&arg);
1814 // Freeze early before potentially raising, so that we don't leave an
1815 // unfrozen copy on the heap, which could get exposed via ObjectSpace.
1816 OBJ_FREEZE(self);
1817 if (arg.unknown_keywords != Qnil) {
1818 rb_exc_raise(rb_keyword_error_new("unknown", arg.unknown_keywords));
1819 }
1820 return Qnil;
1821}
1822
1823/* :nodoc: */
1824static VALUE
1825rb_data_init_copy(VALUE copy, VALUE s)
1826{
1827 copy = rb_struct_init_copy(copy, s);
1828 RB_OBJ_FREEZE(copy);
1829 return copy;
1830}
1831
1832/*
1833 * call-seq:
1834 * with(**kwargs) -> instance
1835 *
1836 * Returns a shallow copy of +self+ --- the instance variables of
1837 * +self+ are copied, but not the objects they reference.
1838 *
1839 * If the method is supplied any keyword arguments, the copy will
1840 * be created with the respective field values updated to use the
1841 * supplied keyword argument values. Note that it is an error to
1842 * supply a keyword that the Data class does not have as a member.
1843 *
1844 * Point = Data.define(:x, :y)
1845 *
1846 * origin = Point.new(x: 0, y: 0)
1847 *
1848 * up = origin.with(x: 1)
1849 * right = origin.with(y: 1)
1850 * up_and_right = up.with(y: 1)
1851 *
1852 * p origin # #<data Point x=0, y=0>
1853 * p up # #<data Point x=1, y=0>
1854 * p right # #<data Point x=0, y=1>
1855 * p up_and_right # #<data Point x=1, y=1>
1856 *
1857 * out = origin.with(z: 1) # ArgumentError: unknown keyword: :z
1858 * some_point = origin.with(1, 2) # ArgumentError: expected keyword arguments, got positional arguments
1859 *
1860 */
1861
1862static VALUE
1863rb_data_with(int argc, const VALUE *argv, VALUE self)
1864{
1865 VALUE kwargs;
1866 rb_scan_args(argc, argv, "0:", &kwargs);
1867 if (NIL_P(kwargs)) {
1868 return self;
1869 }
1870
1871 VALUE h = rb_struct_to_h(self);
1872 rb_hash_update_by(h, kwargs, 0);
1873 return rb_class_new_instance_kw(1, &h, rb_obj_class(self), TRUE);
1874}
1875
1876/*
1877 * call-seq:
1878 * inspect -> string
1879 * to_s -> string
1880 *
1881 * Returns a string representation of +self+:
1882 *
1883 * Measure = Data.define(:amount, :unit)
1884 *
1885 * distance = Measure[10, 'km']
1886 *
1887 * p distance # uses #inspect underneath
1888 * #<data Measure amount=10, unit="km">
1889 *
1890 * puts distance # uses #to_s underneath, same representation
1891 * #<data Measure amount=10, unit="km">
1892 *
1893 */
1894
1895static VALUE
1896rb_data_inspect(VALUE s)
1897{
1898 return rb_exec_recursive(inspect_struct, s, rb_str_new2("#<data "));
1899}
1900
1901/*
1902 * call-seq:
1903 * self == other -> true or false
1904 *
1905 * Returns +true+ if +other+ is the same class as +self+, and all members are
1906 * equal.
1907 *
1908 * Examples:
1909 *
1910 * Measure = Data.define(:amount, :unit)
1911 *
1912 * Measure[1, 'km'] == Measure[1, 'km'] #=> true
1913 * Measure[1, 'km'] == Measure[2, 'km'] #=> false
1914 * Measure[1, 'km'] == Measure[1, 'm'] #=> false
1915 *
1916 * Measurement = Data.define(:amount, :unit)
1917 * # Even though Measurement and Measure have the same "shape"
1918 * # their instances are never equal
1919 * Measure[1, 'km'] == Measurement[1, 'km'] #=> false
1920 */
1921
1922#define rb_data_equal rb_struct_equal
1923
1924/*
1925 * call-seq:
1926 * self.eql?(other) -> true or false
1927 *
1928 * Equality check that is used when two items of data are keys of a Hash.
1929 *
1930 * The subtle difference with #== is that members are also compared with their
1931 * #eql? method, which might be important in some cases:
1932 *
1933 * Measure = Data.define(:amount, :unit)
1934 *
1935 * Measure[1, 'km'] == Measure[1.0, 'km'] #=> true, they are equal as values
1936 * # ...but...
1937 * Measure[1, 'km'].eql? Measure[1.0, 'km'] #=> false, they represent different hash keys
1938 *
1939 * See also Object#eql? for further explanations of the method usage.
1940 */
1941
1942#define rb_data_eql rb_struct_eql
1943
1944/*
1945 * call-seq:
1946 * hash -> integer
1947 *
1948 * Redefines Object#hash (used to distinguish objects as Hash keys) so that
1949 * data objects of the same class with same content would have the same +hash+
1950 * value, and represented the same Hash key.
1951 *
1952 * Measure = Data.define(:amount, :unit)
1953 *
1954 * Measure[1, 'km'].hash == Measure[1, 'km'].hash #=> true
1955 * Measure[1, 'km'].hash == Measure[10, 'km'].hash #=> false
1956 * Measure[1, 'km'].hash == Measure[1, 'm'].hash #=> false
1957 * Measure[1, 'km'].hash == Measure[1.0, 'km'].hash #=> false
1958 *
1959 * # Structurally similar data class, but shouldn't be considered
1960 * # the same hash key
1961 * Measurement = Data.define(:amount, :unit)
1962 *
1963 * Measure[1, 'km'].hash == Measurement[1, 'km'].hash #=> false
1964 */
1965
1966#define rb_data_hash rb_struct_hash
1967
1968/*
1969 * call-seq:
1970 * to_h -> hash
1971 * to_h {|name, value| ... } -> hash
1972 *
1973 * Returns Hash representation of the data object.
1974 *
1975 * Measure = Data.define(:amount, :unit)
1976 * distance = Measure[10, 'km']
1977 *
1978 * distance.to_h
1979 * #=> {:amount=>10, :unit=>"km"}
1980 *
1981 * Like Enumerable#to_h, if the block is provided, it is expected to
1982 * produce key-value pairs to construct a hash:
1983 *
1984 *
1985 * distance.to_h { |name, val| [name.to_s, val.to_s] }
1986 * #=> {"amount"=>"10", "unit"=>"km"}
1987 *
1988 * Note that there is a useful symmetry between #to_h and #initialize:
1989 *
1990 * distance2 = Measure.new(**distance.to_h)
1991 * #=> #<data Measure amount=10, unit="km">
1992 * distance2 == distance
1993 * #=> true
1994 */
1995
1996#define rb_data_to_h rb_struct_to_h
1997
1998/*
1999 * call-seq:
2000 * members -> array_of_symbols
2001 *
2002 * Returns the member names from +self+ as an array:
2003 *
2004 * Measure = Data.define(:amount, :unit)
2005 * distance = Measure[10, 'km']
2006 *
2007 * distance.members #=> [:amount, :unit]
2008 *
2009 */
2010
2011#define rb_data_members_m rb_struct_members_m
2012
2013/*
2014 * call-seq:
2015 * deconstruct -> array
2016 *
2017 * Returns the values in +self+ as an array, to use in pattern matching:
2018 *
2019 * Measure = Data.define(:amount, :unit)
2020 *
2021 * distance = Measure[10, 'km']
2022 * distance.deconstruct #=> [10, "km"]
2023 *
2024 * # usage
2025 * case distance
2026 * in n, 'km' # calls #deconstruct underneath
2027 * puts "It is #{n} kilometers away"
2028 * else
2029 * puts "Don't know how to handle it"
2030 * end
2031 * # prints "It is 10 kilometers away"
2032 *
2033 * Or, with checking the class, too:
2034 *
2035 * case distance
2036 * in Measure(n, 'km')
2037 * puts "It is #{n} kilometers away"
2038 * # ...
2039 * end
2040 */
2041
2042#define rb_data_deconstruct rb_struct_to_a
2043
2044/*
2045 * call-seq:
2046 * deconstruct_keys(array_of_names_or_nil) -> hash
2047 *
2048 * Returns a hash of the name/value pairs, to use in pattern matching.
2049 *
2050 * Measure = Data.define(:amount, :unit)
2051 *
2052 * distance = Measure[10, 'km']
2053 * distance.deconstruct_keys(nil) #=> {:amount=>10, :unit=>"km"}
2054 * distance.deconstruct_keys([:amount]) #=> {:amount=>10}
2055 *
2056 * # usage
2057 * case distance
2058 * in amount:, unit: 'km' # calls #deconstruct_keys underneath
2059 * puts "It is #{amount} kilometers away"
2060 * else
2061 * puts "Don't know how to handle it"
2062 * end
2063 * # prints "It is 10 kilometers away"
2064 *
2065 * Or, with checking the class, too:
2066 *
2067 * case distance
2068 * in Measure(amount:, unit: 'km')
2069 * puts "It is #{amount} kilometers away"
2070 * # ...
2071 * end
2072 */
2073
2074#define rb_data_deconstruct_keys rb_struct_deconstruct_keys
2075
2076/*
2077 * Document-class: Struct
2078 *
2079 * Class \Struct provides a convenient way to create a simple class
2080 * that can store and fetch values.
2081 *
2082 * This example creates a subclass of +Struct+, <tt>Struct::Customer</tt>;
2083 * the first argument, a string, is the name of the subclass;
2084 * the other arguments, symbols, determine the _members_ of the new subclass.
2085 *
2086 * Customer = Struct.new('Customer', :name, :address, :zip)
2087 * Customer.name # => "Struct::Customer"
2088 * Customer.class # => Class
2089 * Customer.superclass # => Struct
2090 *
2091 * Corresponding to each member are two methods, a writer and a reader,
2092 * that store and fetch values:
2093 *
2094 * methods = Customer.instance_methods false
2095 * methods # => [:zip, :address=, :zip=, :address, :name, :name=]
2096 *
2097 * An instance of the subclass may be created,
2098 * and its members assigned values, via method <tt>::new</tt>:
2099 *
2100 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
2101 * joe # => #<struct Struct::Customer name="Joe Smith", address="123 Maple, Anytown NC", zip=12345>
2102 *
2103 * The member values may be managed thus:
2104 *
2105 * joe.name # => "Joe Smith"
2106 * joe.name = 'Joseph Smith'
2107 * joe.name # => "Joseph Smith"
2108 *
2109 * And thus; note that member name may be expressed as either a string or a symbol:
2110 *
2111 * joe[:name] # => "Joseph Smith"
2112 * joe[:name] = 'Joseph Smith, Jr.'
2113 * joe['name'] # => "Joseph Smith, Jr."
2114 *
2115 * See Struct::new.
2116 *
2117 * == What's Here
2118 *
2119 * First, what's elsewhere. Class \Struct:
2120 *
2121 * - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
2122 * - Includes {module Enumerable}[rdoc-ref:Enumerable@What-27s+Here],
2123 * which provides dozens of additional methods.
2124 *
2125 * See also Data, which is a somewhat similar, but stricter concept for defining immutable
2126 * value objects.
2127 *
2128 * Here, class \Struct provides methods that are useful for:
2129 *
2130 * - {Creating a Struct Subclass}[rdoc-ref:Struct@Methods+for+Creating+a+Struct+Subclass]
2131 * - {Querying}[rdoc-ref:Struct@Methods+for+Querying]
2132 * - {Comparing}[rdoc-ref:Struct@Methods+for+Comparing]
2133 * - {Fetching}[rdoc-ref:Struct@Methods+for+Fetching]
2134 * - {Assigning}[rdoc-ref:Struct@Methods+for+Assigning]
2135 * - {Iterating}[rdoc-ref:Struct@Methods+for+Iterating]
2136 * - {Converting}[rdoc-ref:Struct@Methods+for+Converting]
2137 *
2138 * === Methods for Creating a Struct Subclass
2139 *
2140 * - ::new: Returns a new subclass of \Struct.
2141 *
2142 * === Methods for Querying
2143 *
2144 * - #hash: Returns the integer hash code.
2145 * - #size (aliased as #length): Returns the number of members.
2146 *
2147 * === Methods for Comparing
2148 *
2149 * - #==: Returns whether a given object is equal to +self+, using <tt>==</tt>
2150 * to compare member values.
2151 * - #eql?: Returns whether a given object is equal to +self+,
2152 * using <tt>eql?</tt> to compare member values.
2153 *
2154 * === Methods for Fetching
2155 *
2156 * - #[]: Returns the value associated with a given member name.
2157 * - #to_a (aliased as #values, #deconstruct): Returns the member values in +self+ as an array.
2158 * - #deconstruct_keys: Returns a hash of the name/value pairs
2159 * for given member names.
2160 * - #dig: Returns the object in nested objects that is specified
2161 * by a given member name and additional arguments.
2162 * - #members: Returns an array of the member names.
2163 * - #select (aliased as #filter): Returns an array of member values from +self+,
2164 * as selected by the given block.
2165 * - #values_at: Returns an array containing values for given member names.
2166 *
2167 * === Methods for Assigning
2168 *
2169 * - #[]=: Assigns a given value to a given member name.
2170 *
2171 * === Methods for Iterating
2172 *
2173 * - #each: Calls a given block with each member name.
2174 * - #each_pair: Calls a given block with each member name/value pair.
2175 *
2176 * === Methods for Converting
2177 *
2178 * - #inspect (aliased as #to_s): Returns a string representation of +self+.
2179 * - #to_h: Returns a hash of the member name/value pairs in +self+.
2180 *
2181 */
2182void
2183InitVM_Struct(void)
2184{
2185 rb_cStruct = rb_define_class("Struct", rb_cObject);
2187
2189 rb_define_singleton_method(rb_cStruct, "new", rb_struct_s_def, -1);
2190#if 0 /* for RDoc */
2191 rb_define_singleton_method(rb_cStruct, "keyword_init?", rb_struct_s_keyword_init_p, 0);
2192 rb_define_singleton_method(rb_cStruct, "members", rb_struct_s_members_m, 0);
2193#endif
2194
2195 rb_define_method(rb_cStruct, "initialize", rb_struct_initialize_m, -1);
2196 rb_define_method(rb_cStruct, "initialize_copy", rb_struct_init_copy, 1);
2197
2198 rb_define_method(rb_cStruct, "==", rb_struct_equal, 1);
2199 rb_define_method(rb_cStruct, "eql?", rb_struct_eql, 1);
2200 rb_define_method(rb_cStruct, "hash", rb_struct_hash, 0);
2201
2202 rb_define_method(rb_cStruct, "inspect", rb_struct_inspect, 0);
2203 rb_define_alias(rb_cStruct, "to_s", "inspect");
2204 rb_define_method(rb_cStruct, "to_a", rb_struct_to_a, 0);
2205 rb_define_method(rb_cStruct, "to_h", rb_struct_to_h, 0);
2206 rb_define_method(rb_cStruct, "values", rb_struct_to_a, 0);
2207 rb_define_method(rb_cStruct, "size", rb_struct_size, 0);
2208 rb_define_method(rb_cStruct, "length", rb_struct_size, 0);
2209
2210 rb_define_method(rb_cStruct, "each", rb_struct_each, 0);
2211 rb_define_method(rb_cStruct, "each_pair", rb_struct_each_pair, 0);
2212 rb_define_method(rb_cStruct, "[]", rb_struct_aref, 1);
2213 rb_define_method(rb_cStruct, "[]=", rb_struct_aset, 2);
2214 rb_define_method(rb_cStruct, "select", rb_struct_select, -1);
2215 rb_define_method(rb_cStruct, "filter", rb_struct_select, -1);
2216 rb_define_method(rb_cStruct, "values_at", rb_struct_values_at, -1);
2217
2218 rb_define_method(rb_cStruct, "members", rb_struct_members_m, 0);
2219 rb_define_method(rb_cStruct, "dig", rb_struct_dig, -1);
2220
2221 rb_define_method(rb_cStruct, "deconstruct", rb_struct_to_a, 0);
2222 rb_define_method(rb_cStruct, "deconstruct_keys", rb_struct_deconstruct_keys, 1);
2223
2224 rb_cData = rb_define_class("Data", rb_cObject);
2225
2226 rb_undef_method(CLASS_OF(rb_cData), "new");
2227 rb_undef_alloc_func(rb_cData);
2228 rb_define_singleton_method(rb_cData, "define", rb_data_s_def, -1);
2229
2230#if 0 /* for RDoc */
2231 rb_define_singleton_method(rb_cData, "members", rb_data_s_members_m, 0);
2232#endif
2233
2234 rb_define_method(rb_cData, "initialize", rb_data_initialize_m, -1);
2235 rb_define_method(rb_cData, "initialize_copy", rb_data_init_copy, 1);
2236
2237 rb_define_method(rb_cData, "==", rb_data_equal, 1);
2238 rb_define_method(rb_cData, "eql?", rb_data_eql, 1);
2239 rb_define_method(rb_cData, "hash", rb_data_hash, 0);
2240
2241 rb_define_method(rb_cData, "inspect", rb_data_inspect, 0);
2242 rb_define_alias(rb_cData, "to_s", "inspect");
2243 rb_define_method(rb_cData, "to_h", rb_data_to_h, 0);
2244
2245 rb_define_method(rb_cData, "members", rb_data_members_m, 0);
2246
2247 rb_define_method(rb_cData, "deconstruct", rb_data_deconstruct, 0);
2248 rb_define_method(rb_cData, "deconstruct_keys", rb_data_deconstruct_keys, 1);
2249
2250 rb_define_method(rb_cData, "with", rb_data_with, -1);
2251}
2252
2253#undef rb_intern
2254void
2255Init_Struct(void)
2256{
2257 id_members = rb_intern("__members__");
2258 id_back_members = rb_intern("__members_back__");
2259 id_keyword_init = rb_intern("__keyword_init__");
2260
2261 InitVM(Struct);
2262}
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
Definition assert.h:219
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
#define rb_define_singleton_method(klass, mid, func, arity)
Defines klass.mid.
#define RB_OBJ_FREEZE
Just another name of rb_obj_freeze_inline.
Definition fl_type.h:92
void rb_include_module(VALUE klass, VALUE module)
Includes a module to a class.
Definition class.c:1691
VALUE rb_define_class(const char *name, VALUE super)
Defines a top-level class.
Definition class.c:1474
VALUE rb_class_new(VALUE super)
Creates a new, anonymous class.
Definition class.c:855
VALUE rb_singleton_class(VALUE obj)
Finds or creates the singleton class of the passed object.
Definition class.c:2795
VALUE rb_define_class_under(VALUE outer, const char *name, VALUE super)
Defines a class under the namespace of outer.
Definition class.c:1510
VALUE rb_define_class_id_under(VALUE outer, ID id, VALUE super)
Identical to rb_define_class_under(), except it takes the name in ID instead of C's string.
Definition class.c:1549
VALUE rb_class_inherited(VALUE super, VALUE klass)
Calls Class::inherited.
Definition class.c:1465
void rb_define_alias(VALUE klass, const char *name1, const char *name2)
Defines an alias of a method.
Definition class.c:2843
void rb_undef_method(VALUE klass, const char *name)
Defines an undef of a method.
Definition class.c:2663
int rb_scan_args(int argc, const VALUE *argv, const char *fmt,...)
Retrieves argument from argc and argv to given VALUE references according to the format string.
Definition class.c:3133
int rb_keyword_given_p(void)
Determines if the current method is given a keyword argument.
Definition eval.c:1049
int rb_block_given_p(void)
Determines if the current method is given a block.
Definition eval.c:1036
int rb_get_kwargs(VALUE keyword_hash, const ID *table, int required, int optional, VALUE *values)
Keyword argument deconstructor.
Definition class.c:2922
#define rb_str_new2
Old name of rb_str_new_cstr.
Definition string.h:1675
#define OBJ_INIT_COPY(obj, orig)
Old name of RB_OBJ_INIT_COPY.
Definition object.h:41
#define T_STRING
Old name of RUBY_T_STRING.
Definition value_type.h:78
#define INT2FIX
Old name of RB_INT2FIX.
Definition long.h:48
#define OBJ_FROZEN
Old name of RB_OBJ_FROZEN.
Definition fl_type.h:136
#define rb_str_cat2
Old name of rb_str_cat_cstr.
Definition string.h:1683
#define ID2SYM
Old name of RB_ID2SYM.
Definition symbol.h:44
#define T_STRUCT
Old name of RUBY_T_STRUCT.
Definition value_type.h:79
#define OBJ_FREEZE
Old name of RB_OBJ_FREEZE.
Definition fl_type.h:134
#define UNREACHABLE_RETURN
Old name of RBIMPL_UNREACHABLE_RETURN.
Definition assume.h:29
#define SYM2ID
Old name of RB_SYM2ID.
Definition symbol.h:45
#define FIX2UINT
Old name of RB_FIX2UINT.
Definition int.h:42
#define CLASS_OF
Old name of rb_class_of.
Definition globals.h:206
#define rb_ary_new4
Old name of rb_ary_new_from_values.
Definition array.h:659
#define LONG2FIX
Old name of RB_INT2FIX.
Definition long.h:49
#define FIX2INT
Old name of RB_FIX2INT.
Definition int.h:41
#define T_HASH
Old name of RUBY_T_HASH.
Definition value_type.h:65
#define ALLOC_N
Old name of RB_ALLOC_N.
Definition memory.h:399
#define LONG2NUM
Old name of RB_LONG2NUM.
Definition long.h:50
#define Qtrue
Old name of RUBY_Qtrue.
#define ST2FIX
Old name of RB_ST2FIX.
Definition st_data_t.h:33
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define T_ARRAY
Old name of RUBY_T_ARRAY.
Definition value_type.h:56
#define NIL_P
Old name of RB_NIL_P.
#define FL_WB_PROTECTED
Old name of RUBY_FL_WB_PROTECTED.
Definition fl_type.h:59
#define T_CLASS
Old name of RUBY_T_CLASS.
Definition value_type.h:58
#define NUM2LONG
Old name of RB_NUM2LONG.
Definition long.h:51
#define FIXNUM_P
Old name of RB_FIXNUM_P.
#define FL_SET_RAW
Old name of RB_FL_SET_RAW.
Definition fl_type.h:129
#define SYMBOL_P
Old name of RB_SYMBOL_P.
Definition value_type.h:88
void rb_exc_raise(VALUE mesg)
Raises an exception in the current thread.
Definition eval.c:682
VALUE rb_eTypeError
TypeError exception.
Definition error.c:1430
void rb_warn(const char *fmt,...)
Identical to rb_warning(), except it reports unless $VERBOSE is nil.
Definition error.c:466
VALUE rb_eIndexError
IndexError exception.
Definition error.c:1432
VALUE rb_class_superclass(VALUE klass)
Queries the parent of the given class.
Definition object.c:2179
VALUE rb_class_new_instance(int argc, const VALUE *argv, VALUE klass)
Allocates, then initialises an instance of the given class.
Definition object.c:2164
VALUE rb_class_new_instance_kw(int argc, const VALUE *argv, VALUE klass, int kw_splat)
Identical to rb_class_new_instance(), except you can specify how to handle the last element of the gi...
Definition object.c:2152
VALUE rb_mEnumerable
Enumerable module.
Definition enum.c:27
VALUE rb_cStruct
Struct class.
Definition struct.c:33
VALUE rb_class_new_instance_pass_kw(int argc, const VALUE *argv, VALUE klass)
Identical to rb_class_new_instance(), except it passes the passed keywords if any to the #initialize ...
Definition object.c:2141
int rb_eql(VALUE lhs, VALUE rhs)
Checks for equality of the passed objects, in terms of Object#eql?.
Definition object.c:188
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
Definition object.c:243
VALUE rb_inspect(VALUE obj)
Generates a human-readable textual representation of the given object.
Definition object.c:655
VALUE rb_equal(VALUE lhs, VALUE rhs)
This function is an optimised version of calling #==.
Definition object.c:175
VALUE rb_obj_is_kind_of(VALUE obj, VALUE klass)
Queries if the given object is an instance (of possibly descendants) of the given class.
Definition object.c:878
#define RGENGC_WB_PROTECTED_STRUCT
This is a compile-time flag to enable/disable write barrier for struct RStruct.
Definition gc.h:468
Defines RBIMPL_HAS_BUILTIN.
VALUE rb_ary_dup(VALUE ary)
Duplicates an array.
VALUE rb_get_values_at(VALUE obj, long olen, int argc, const VALUE *argv, VALUE(*func)(VALUE obj, long oidx))
This was a generalisation of Array#values_at, Struct#values_at, and MatchData#values_at.
VALUE rb_ary_new(void)
Allocates a new, empty array.
VALUE rb_ary_hidden_new(long capa)
Allocates a hidden (no class) empty array.
VALUE rb_ary_push(VALUE ary, VALUE elem)
Special case of rb_ary_cat() that it adds only one element.
VALUE rb_ary_entry(VALUE ary, long off)
Queries an element of an array.
VALUE rb_assoc_new(VALUE car, VALUE cdr)
Identical to rb_ary_new_from_values(), except it expects exactly two parameters.
void rb_mem_clear(VALUE *buf, long len)
Fills the memory region with a series of RUBY_Qnil.
VALUE rb_ary_join(VALUE ary, VALUE sep)
Recursively stringises the elements of the passed array, flattens that result, then joins the sequenc...
void rb_ary_store(VALUE ary, long key, VALUE val)
Destructively stores the passed value to the passed array's passed index.
#define RETURN_SIZED_ENUMERATOR(obj, argc, argv, size_fn)
This roughly resembles return enum_for(__callee__) unless block_given?.
Definition enumerator.h:206
#define UNLIMITED_ARGUMENTS
This macro is used in conjunction with rb_check_arity().
Definition error.h:35
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
Definition error.h:284
int rb_is_const_id(ID id)
Classifies the given ID, then sees if it is a constant.
Definition symbol.c:1098
int rb_is_local_id(ID id)
Classifies the given ID, then sees if it is a local variable.
Definition symbol.c:1128
#define rb_hash_uint(h, i)
Just another name of st_hash_uint.
Definition string.h:942
#define rb_hash_end(h)
Just another name of st_hash_end.
Definition string.h:945
VALUE rb_str_append(VALUE dst, VALUE src)
Identical to rb_str_buf_append(), except it converts the right hand side before concatenating.
Definition string.c:3757
st_index_t rb_hash_start(st_index_t i)
Starts a series of hashing.
Definition random.c:1762
#define rb_str_cat_cstr(buf, str)
Identical to rb_str_cat(), except it assumes the passed pointer is a pointer to a C string.
Definition string.h:1656
VALUE rb_struct_define_without_accessor_under(VALUE outer, const char *class_name, VALUE super, rb_alloc_func_t alloc,...)
Identical to rb_struct_define_without_accessor(), except it defines the class under the specified nam...
Definition struct.c:460
VALUE rb_struct_define_under(VALUE space, const char *name,...)
Identical to rb_struct_define(), except it defines the class under the specified namespace instead of...
Definition struct.c:506
VALUE rb_struct_new(VALUE klass,...)
Creates an instance of the given struct.
Definition struct.c:852
VALUE rb_struct_initialize(VALUE self, VALUE values)
Mass-assigns a struct's fields.
Definition struct.c:795
VALUE rb_struct_define_without_accessor(const char *name, VALUE super, rb_alloc_func_t func,...)
Identical to rb_struct_define(), except it does not define accessor methods.
Definition struct.c:473
VALUE rb_struct_define(const char *name,...)
Defines a struct class.
Definition struct.c:486
VALUE rb_struct_alloc(VALUE klass, VALUE values)
Identical to rb_struct_new(), except it takes the field values as a Ruby array.
Definition struct.c:846
VALUE rb_data_define(VALUE super,...)
Defines an anonymous data class.
Definition struct.c:1709
VALUE rb_struct_alloc_noinit(VALUE klass)
Allocates an instance of the given class.
Definition struct.c:406
VALUE rb_struct_s_members(VALUE klass)
Queries the list of the names of the fields of the given struct class.
Definition struct.c:68
VALUE rb_struct_members(VALUE self)
Queries the list of the names of the fields of the class of the given struct object.
Definition struct.c:82
VALUE rb_struct_getmember(VALUE self, ID key)
Identical to rb_struct_aref(), except it takes ID instead of VALUE.
Definition struct.c:233
VALUE rb_exec_recursive(VALUE(*f)(VALUE g, VALUE h, int r), VALUE g, VALUE h)
"Recursion" API entry point.
VALUE rb_exec_recursive_paired(VALUE(*f)(VALUE g, VALUE h, int r), VALUE g, VALUE p, VALUE h)
Identical to rb_exec_recursive(), except it checks for the recursion on the ordered pair of { g,...
VALUE rb_ivar_set(VALUE obj, ID name, VALUE val)
Identical to rb_iv_set(), except it accepts the name as an ID instead of a C string.
Definition variable.c:2080
VALUE rb_mod_remove_const(VALUE space, VALUE name)
Resembles Module#remove_const.
Definition variable.c:3675
VALUE rb_class_name(VALUE obj)
Queries the name of the given object's class.
Definition variable.c:498
int rb_const_defined_at(VALUE space, ID name)
Identical to rb_const_defined(), except it doesn't look for parent classes.
Definition variable.c:3899
VALUE rb_class_path(VALUE mod)
Identical to rb_mod_name(), except it returns #<Class: ...> style inspection for anonymous modules.
Definition variable.c:379
VALUE(* rb_alloc_func_t)(VALUE klass)
This is the type of functions that ruby calls when trying to allocate an object.
Definition vm.h:216
void rb_undef_alloc_func(VALUE klass)
Deletes the allocator function of a class.
Definition vm_method.c:1591
VALUE rb_mod_module_eval(int argc, const VALUE *argv, VALUE mod)
Identical to rb_obj_instance_eval(), except it evaluates within the context of module.
Definition vm_eval.c:2392
void rb_define_alloc_func(VALUE klass, rb_alloc_func_t func)
Sets the allocator function of a class.
VALUE rb_check_symbol(volatile VALUE *namep)
Identical to rb_check_id(), except it returns an instance of rb_cSymbol instead.
Definition symbol.c:1209
VALUE rb_to_symbol(VALUE name)
Identical to rb_intern_str(), except it generates a dynamic symbol if necessary.
Definition string.c:12576
ID rb_to_id(VALUE str)
Definition string.c:12566
int off
Offset inside of ptr.
Definition io.h:5
int len
Length of the buffer.
Definition io.h:8
VALUE rb_yield_values(int n,...)
Identical to rb_yield(), except it takes variadic number of parameters and pass them to the block.
Definition vm_eval.c:1384
VALUE rb_yield(VALUE val)
Yields the block.
Definition vm_eval.c:1372
#define rb_long2int
Just another name of rb_long2int_inline.
Definition long.h:62
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
Definition memory.h:167
void rb_hash_foreach(VALUE q, int_type *w, VALUE e)
Iteration over the given hash.
#define RARRAY_LEN
Just another name of rb_array_len.
Definition rarray.h:51
static int RARRAY_LENINT(VALUE ary)
Identical to rb_array_len(), except it differs for the return type.
Definition rarray.h:281
static VALUE * RARRAY_PTR(VALUE ary)
Wild use of a C pointer.
Definition rarray.h:366
#define RARRAY_AREF(a, i)
Definition rarray.h:403
#define RARRAY_CONST_PTR
Just another name of rb_array_const_ptr.
Definition rarray.h:52
#define RBASIC(obj)
Convenient casting macro.
Definition rbasic.h:40
#define RHASH_SIZE(h)
Queries the size of the hash.
Definition rhash.h:69
VALUE rb_str_to_str(VALUE obj)
Identical to rb_check_string_type(), except it raises exceptions in case of conversion failures.
Definition string.c:1744
VALUE rb_struct_aset(VALUE st, VALUE k, VALUE v)
Resembles Struct#[]=.
Definition struct.c:1265
VALUE rb_struct_size(VALUE st)
Returns the number of struct members.
Definition struct.c:1515
VALUE rb_struct_aref(VALUE st, VALUE k)
Resembles Struct#[].
Definition struct.c:1227
#define InitVM(ext)
This macro is for internal use.
Definition ruby.h:231
#define RB_PASS_KEYWORDS
Pass keywords, final argument should be a hash of keywords.
Definition scan_args.h:72
#define RTEST
This is an old name of RB_TEST.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
Definition value.h:52
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
Definition value_type.h:376