Ruby 4.0.7p0 (2026-09-15 revision 229531a6cfbf07e3caef30dbac24a2a3f3fed482)
struct.c
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;
52 RUBY_ASSERT(RB_TYPE_P(c, T_CLASS));
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 VALUE missing_keywords;
720 long missing_count;
721};
722
723static int rb_struct_pos(VALUE s, VALUE *name, bool name_only);
724static VALUE deconstruct_keys(VALUE s, VALUE keys, bool name_only);
725
726static int
727struct_hash_aset(VALUE key, VALUE val, struct struct_hash_set_arg *args, bool name_only)
728{
729 int i = rb_struct_pos(args->self, &key, name_only);
730 if (i < 0) {
731 if (NIL_P(args->unknown_keywords)) {
732 args->unknown_keywords = rb_ary_new();
733 }
734 rb_ary_push(args->unknown_keywords, key);
735 }
736 else {
737 rb_struct_modify(args->self);
738 RSTRUCT_SET(args->self, i, val);
739 }
740 return i;
741}
742
743static int
744struct_hash_set_i(VALUE key, VALUE val, VALUE arg)
745{
746 struct struct_hash_set_arg *args = (struct struct_hash_set_arg *)arg;
747 struct_hash_aset(key, val, args, false);
748 return ST_CONTINUE;
749}
750
751static VALUE
752rb_struct_initialize_m(int argc, const VALUE *argv, VALUE self)
753{
754 VALUE klass = rb_obj_class(self);
755 rb_struct_modify(self);
756 long n = num_members(klass);
757 if (argc == 0) {
758 rb_mem_clear((VALUE *)RSTRUCT_CONST_PTR(self), n);
759 return Qnil;
760 }
761
762 bool keyword_init = false;
763 switch (rb_struct_s_keyword_init(klass)) {
764 default:
765 if (argc > 1 || !RB_TYPE_P(argv[0], T_HASH)) {
766 rb_error_arity(argc, 0, 0);
767 }
768 keyword_init = true;
769 break;
770 case Qfalse:
771 break;
772 case Qnil:
773 if (argc > 1 || !RB_TYPE_P(argv[0], T_HASH)) {
774 break;
775 }
776 keyword_init = rb_keyword_given_p();
777 break;
778 }
779 if (keyword_init) {
780 struct struct_hash_set_arg arg = {
781 .self = self,
782 .unknown_keywords = Qnil,
783 };
784 rb_mem_clear((VALUE *)RSTRUCT_CONST_PTR(self), n);
785 rb_hash_foreach(argv[0], struct_hash_set_i, (VALUE)&arg);
786 if (UNLIKELY(!NIL_P(arg.unknown_keywords))) {
787 rb_raise(rb_eArgError, "unknown keywords: %s",
788 RSTRING_PTR(rb_ary_join(arg.unknown_keywords, rb_str_new2(", "))));
789 }
790 }
791 else {
792 if (n < argc) {
793 rb_raise(rb_eArgError, "struct size differs");
794 }
795 for (long i=0; i<argc; i++) {
796 RSTRUCT_SET(self, i, argv[i]);
797 }
798 if (n > argc) {
799 rb_mem_clear((VALUE *)RSTRUCT_CONST_PTR(self)+argc, n-argc);
800 }
801 }
802 return Qnil;
803}
804
805VALUE
807{
808 rb_struct_initialize_m(RARRAY_LENINT(values), RARRAY_CONST_PTR(values), self);
809 if (rb_obj_is_kind_of(self, rb_cData)) OBJ_FREEZE(self);
810 RB_GC_GUARD(values);
811 return Qnil;
812}
813
814static VALUE *
815struct_heap_alloc(VALUE st, size_t len)
816{
817 return ALLOC_N(VALUE, len);
818}
819
820static VALUE
821struct_alloc(VALUE klass)
822{
823 long n = num_members(klass);
824
826
827 if (n > 0) {
828 size_t embedded_size = offsetof(struct RStruct, as.ary) + (sizeof(VALUE) * n);
829 size_t embedded_with_ivar_size = embedded_size + sizeof(VALUE);
830
831 // We always check if `n+1` is embeddable, because JITs expect all instances of a given
832 // struct to be either always or never embedded.
833 if (rb_gc_size_allocatable_p(embedded_with_ivar_size)) {
834 // We set the `RSTRUCT_GEN_FIELDS` flag before calling `NEWOBJ_OF` in case a NEWOBJ tracepoint
835 // does attempt to write fields. We'll remove it later if no fields was written to.
836 flags |= RSTRUCT_GEN_FIELDS | (n << RSTRUCT_EMBED_LEN_SHIFT);
837
838 bool has_ivar = RCLASS_MAX_IV_COUNT(klass) > 0;
839 NEWOBJ_OF(st, struct RStruct, klass, flags, has_ivar ? embedded_with_ivar_size : embedded_size, 0);
840
841 rb_mem_clear((VALUE *)st->as.ary, n);
842
843 if (!rb_shape_obj_has_fields((VALUE)st) && has_ivar) {
844 FL_UNSET_RAW((VALUE)st, RSTRUCT_GEN_FIELDS);
845 RSTRUCT_SET_FIELDS_OBJ((VALUE)st, 0);
846 }
847
848 return (VALUE)st;
849 }
850 }
851
852 NEWOBJ_OF(st, struct RStruct, klass, flags, sizeof(struct RStruct), 0);
853
854 st->as.heap.ptr = NULL;
855 st->as.heap.fields_obj = 0;
856 st->as.heap.len = 0;
857
858 st->as.heap.ptr = struct_heap_alloc((VALUE)st, n);
859 rb_mem_clear((VALUE *)st->as.heap.ptr, n);
860 st->as.heap.len = n;
861
862 return (VALUE)st;
863}
864
865VALUE
867{
868 return rb_class_new_instance(RARRAY_LENINT(values), RARRAY_CONST_PTR(values), klass);
869}
870
871VALUE
873{
874 VALUE tmpargs[16], *mem = tmpargs;
875 int size, i;
876 va_list args;
877
878 size = rb_long2int(num_members(klass));
879 if (size > numberof(tmpargs)) {
880 tmpargs[0] = rb_ary_hidden_new(size);
881 mem = RARRAY_PTR(tmpargs[0]);
882 }
883 va_start(args, klass);
884 for (i=0; i<size; i++) {
885 mem[i] = va_arg(args, VALUE);
886 }
887 va_end(args);
888
889 return rb_class_new_instance(size, mem, klass);
890}
891
892static VALUE
893struct_enum_size(VALUE s, VALUE args, VALUE eobj)
894{
895 return rb_struct_size(s);
896}
897
898/*
899 * call-seq:
900 * each {|value| ... } -> self
901 * each -> enumerator
902 *
903 * Calls the given block with the value of each member; returns +self+:
904 *
905 * Customer = Struct.new(:name, :address, :zip)
906 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
907 * joe.each {|value| p value }
908 *
909 * Output:
910 *
911 * "Joe Smith"
912 * "123 Maple, Anytown NC"
913 * 12345
914 *
915 * Returns an Enumerator if no block is given.
916 *
917 * Related: #each_pair.
918 */
919
920static VALUE
921rb_struct_each(VALUE s)
922{
923 long i;
924
925 RETURN_SIZED_ENUMERATOR(s, 0, 0, struct_enum_size);
926 for (i=0; i<RSTRUCT_LEN(s); i++) {
927 rb_yield(RSTRUCT_GET(s, i));
928 }
929 return s;
930}
931
932/*
933 * call-seq:
934 * each_pair {|(name, value)| ... } -> self
935 * each_pair -> enumerator
936 *
937 * Calls the given block with each member name/value pair; returns +self+:
938 *
939 * Customer = Struct.new(:name, :address, :zip) # => Customer
940 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
941 * joe.each_pair {|(name, value)| p "#{name} => #{value}" }
942 *
943 * Output:
944 *
945 * "name => Joe Smith"
946 * "address => 123 Maple, Anytown NC"
947 * "zip => 12345"
948 *
949 * Returns an Enumerator if no block is given.
950 *
951 * Related: #each.
952 *
953 */
954
955static VALUE
956rb_struct_each_pair(VALUE s)
957{
958 VALUE members;
959 long i;
960
961 RETURN_SIZED_ENUMERATOR(s, 0, 0, struct_enum_size);
962 members = rb_struct_members(s);
963 if (rb_block_pair_yield_optimizable()) {
964 for (i=0; i<RSTRUCT_LEN(s); i++) {
965 VALUE key = rb_ary_entry(members, i);
966 VALUE value = RSTRUCT_GET(s, i);
967 rb_yield_values(2, key, value);
968 }
969 }
970 else {
971 for (i=0; i<RSTRUCT_LEN(s); i++) {
972 VALUE key = rb_ary_entry(members, i);
973 VALUE value = RSTRUCT_GET(s, i);
974 rb_yield(rb_assoc_new(key, value));
975 }
976 }
977 return s;
978}
979
980static VALUE
981inspect_struct(VALUE s, VALUE prefix, int recur)
982{
983 VALUE cname = rb_class_path(rb_obj_class(s));
984 VALUE members;
985 VALUE str = prefix;
986 long i, len;
987 char first = RSTRING_PTR(cname)[0];
988
989 if (recur || first != '#') {
990 rb_str_append(str, cname);
991 }
992 if (recur) {
993 return rb_str_cat2(str, ":...>");
994 }
995
996 members = rb_struct_members(s);
997 len = RSTRUCT_LEN(s);
998
999 for (i=0; i<len; i++) {
1000 VALUE slot;
1001 ID id;
1002
1003 if (i > 0) {
1004 rb_str_cat2(str, ", ");
1005 }
1006 else if (first != '#') {
1007 rb_str_cat2(str, " ");
1008 }
1009 slot = RARRAY_AREF(members, i);
1010 id = SYM2ID(slot);
1011 if (rb_is_local_id(id) || rb_is_const_id(id)) {
1012 rb_str_append(str, rb_id2str(id));
1013 }
1014 else {
1015 rb_str_append(str, rb_inspect(slot));
1016 }
1017 rb_str_cat2(str, "=");
1018 rb_str_append(str, rb_inspect(RSTRUCT_GET(s, i)));
1019 }
1020 rb_str_cat2(str, ">");
1021
1022 return str;
1023}
1024
1025/*
1026 * call-seq:
1027 * inspect -> string
1028 *
1029 * Returns a string representation of +self+:
1030 *
1031 * Customer = Struct.new(:name, :address, :zip) # => Customer
1032 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1033 * joe.inspect # => "#<struct Customer name=\"Joe Smith\", address=\"123 Maple, Anytown NC\", zip=12345>"
1034 *
1035 */
1036
1037static VALUE
1038rb_struct_inspect(VALUE s)
1039{
1040 return rb_exec_recursive(inspect_struct, s, rb_str_new2("#<struct "));
1041}
1042
1043/*
1044 * call-seq:
1045 * to_a -> array
1046 *
1047 * Returns the values in +self+ as an array:
1048 *
1049 * Customer = Struct.new(:name, :address, :zip)
1050 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1051 * joe.to_a # => ["Joe Smith", "123 Maple, Anytown NC", 12345]
1052 *
1053 * Related: #members.
1054 */
1055
1056static VALUE
1057rb_struct_to_a(VALUE s)
1058{
1059 return rb_ary_new4(RSTRUCT_LEN(s), RSTRUCT_CONST_PTR(s));
1060}
1061
1062/*
1063 * call-seq:
1064 * to_h -> hash
1065 * to_h {|name, value| ... } -> hash
1066 *
1067 * Returns a hash containing the name and value for each member:
1068 *
1069 * Customer = Struct.new(:name, :address, :zip)
1070 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1071 * h = joe.to_h
1072 * h # => {:name=>"Joe Smith", :address=>"123 Maple, Anytown NC", :zip=>12345}
1073 *
1074 * If a block is given, it is called with each name/value pair;
1075 * the block should return a 2-element array whose elements will become
1076 * a key/value pair in the returned hash:
1077 *
1078 * h = joe.to_h{|name, value| [name.upcase, value.to_s.upcase]}
1079 * h # => {:NAME=>"JOE SMITH", :ADDRESS=>"123 MAPLE, ANYTOWN NC", :ZIP=>"12345"}
1080 *
1081 * Raises ArgumentError if the block returns an inappropriate value.
1082 *
1083 */
1084
1085static VALUE
1086rb_struct_to_h(VALUE s)
1087{
1088 VALUE h = rb_hash_new_with_size(RSTRUCT_LEN(s));
1089 VALUE members = rb_struct_members(s);
1090 long i;
1091 int block_given = rb_block_given_p();
1092
1093 for (i=0; i<RSTRUCT_LEN(s); i++) {
1094 VALUE k = rb_ary_entry(members, i), v = RSTRUCT_GET(s, i);
1095 if (block_given)
1096 rb_hash_set_pair(h, rb_yield_values(2, k, v));
1097 else
1098 rb_hash_aset(h, k, v);
1099 }
1100 return h;
1101}
1102
1103/*
1104 * call-seq:
1105 * deconstruct_keys(array_of_names) -> hash
1106 *
1107 * Returns a hash of the name/value pairs for the given member names.
1108 *
1109 * Customer = Struct.new(:name, :address, :zip)
1110 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1111 * h = joe.deconstruct_keys([:zip, :address])
1112 * h # => {:zip=>12345, :address=>"123 Maple, Anytown NC"}
1113 *
1114 * Returns all names and values if +array_of_names+ is +nil+:
1115 *
1116 * h = joe.deconstruct_keys(nil)
1117 * h # => {:name=>"Joseph Smith, Jr.", :address=>"123 Maple, Anytown NC", :zip=>12345}
1118 *
1119 */
1120static VALUE
1121rb_struct_deconstruct_keys(VALUE s, VALUE keys)
1122{
1123 return deconstruct_keys(s, keys, false);
1124}
1125
1126static VALUE
1127deconstruct_keys(VALUE s, VALUE keys, bool name_only)
1128{
1129 VALUE h;
1130 long i;
1131
1132 if (NIL_P(keys)) {
1133 return rb_struct_to_h(s);
1134 }
1135 if (UNLIKELY(!RB_TYPE_P(keys, T_ARRAY))) {
1136 rb_raise(rb_eTypeError,
1137 "wrong argument type %"PRIsVALUE" (expected Array or nil)",
1138 rb_obj_class(keys));
1139
1140 }
1141 if (RSTRUCT_LEN(s) < RARRAY_LEN(keys)) {
1142 return rb_hash_new_with_size(0);
1143 }
1144 h = rb_hash_new_with_size(RARRAY_LEN(keys));
1145 for (i=0; i<RARRAY_LEN(keys); i++) {
1146 VALUE key = RARRAY_AREF(keys, i);
1147 int i = rb_struct_pos(s, &key, name_only);
1148 if (i < 0) {
1149 return h;
1150 }
1151 rb_hash_aset(h, key, RSTRUCT_GET(s, i));
1152 }
1153 return h;
1154}
1155
1156/* :nodoc: */
1157VALUE
1158rb_struct_init_copy(VALUE copy, VALUE s)
1159{
1160 long i, len;
1161
1162 if (!OBJ_INIT_COPY(copy, s)) return copy;
1163 if (RSTRUCT_LEN(copy) != RSTRUCT_LEN(s)) {
1164 rb_raise(rb_eTypeError, "struct size mismatch");
1165 }
1166
1167 for (i=0, len=RSTRUCT_LEN(copy); i<len; i++) {
1168 RSTRUCT_SET(copy, i, RSTRUCT_GET(s, i));
1169 }
1170
1171 return copy;
1172}
1173
1174static int
1175rb_struct_pos(VALUE s, VALUE *name, bool name_only)
1176{
1177 long i;
1178 VALUE idx = *name;
1179
1180 if (SYMBOL_P(idx)) {
1181 return struct_member_pos(s, idx);
1182 }
1183 else if (name_only || RB_TYPE_P(idx, T_STRING)) {
1184 idx = rb_check_symbol(name);
1185 if (NIL_P(idx)) return -1;
1186 return struct_member_pos(s, idx);
1187 }
1188 else {
1189 long len;
1190 i = NUM2LONG(idx);
1191 len = RSTRUCT_LEN(s);
1192 if (i < 0) {
1193 if (i + len < 0) {
1194 *name = LONG2FIX(i);
1195 return -1;
1196 }
1197 i += len;
1198 }
1199 else if (len <= i) {
1200 *name = LONG2FIX(i);
1201 return -1;
1202 }
1203 return (int)i;
1204 }
1205}
1206
1207static void
1208invalid_struct_pos(VALUE s, VALUE idx)
1209{
1210 if (FIXNUM_P(idx)) {
1211 long i = FIX2INT(idx), len = RSTRUCT_LEN(s);
1212 if (i < 0) {
1213 rb_raise(rb_eIndexError, "offset %ld too small for struct(size:%ld)",
1214 i, len);
1215 }
1216 else {
1217 rb_raise(rb_eIndexError, "offset %ld too large for struct(size:%ld)",
1218 i, len);
1219 }
1220 }
1221 else {
1222 rb_name_err_raise("no member '%1$s' in struct", s, idx);
1223 }
1224}
1225
1226/*
1227 * call-seq:
1228 * struct[name] -> object
1229 * struct[n] -> object
1230 *
1231 * Returns a value from +self+.
1232 *
1233 * With symbol or string argument +name+ given, returns the value for the named member:
1234 *
1235 * Customer = Struct.new(:name, :address, :zip)
1236 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1237 * joe[:zip] # => 12345
1238 *
1239 * Raises NameError if +name+ is not the name of a member.
1240 *
1241 * With integer argument +n+ given, returns <tt>self.values[n]</tt>
1242 * if +n+ is in range;
1243 * see Array@Array+Indexes:
1244 *
1245 * joe[2] # => 12345
1246 * joe[-2] # => "123 Maple, Anytown NC"
1247 *
1248 * Raises IndexError if +n+ is out of range.
1249 *
1250 */
1251
1252VALUE
1254{
1255 int i = rb_struct_pos(s, &idx, false);
1256 if (i < 0) invalid_struct_pos(s, idx);
1257 return RSTRUCT_GET(s, i);
1258}
1259
1260/*
1261 * call-seq:
1262 * struct[name] = value -> value
1263 * struct[n] = value -> value
1264 *
1265 * Assigns a value to a member.
1266 *
1267 * With symbol or string argument +name+ given, assigns the given +value+
1268 * to the named member; returns +value+:
1269 *
1270 * Customer = Struct.new(:name, :address, :zip)
1271 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1272 * joe[:zip] = 54321 # => 54321
1273 * joe # => #<struct Customer name="Joe Smith", address="123 Maple, Anytown NC", zip=54321>
1274 *
1275 * Raises NameError if +name+ is not the name of a member.
1276 *
1277 * With integer argument +n+ given, assigns the given +value+
1278 * to the +n+-th member if +n+ is in range;
1279 * see Array@Array+Indexes:
1280 *
1281 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1282 * joe[2] = 54321 # => 54321
1283 * joe[-3] = 'Joseph Smith' # => "Joseph Smith"
1284 * joe # => #<struct Customer name="Joseph Smith", address="123 Maple, Anytown NC", zip=54321>
1285 *
1286 * Raises IndexError if +n+ is out of range.
1287 *
1288 */
1289
1290VALUE
1292{
1293 int i = rb_struct_pos(s, &idx, false);
1294 if (i < 0) invalid_struct_pos(s, idx);
1295 rb_struct_modify(s);
1296 RSTRUCT_SET(s, i, val);
1297 return val;
1298}
1299
1300FUNC_MINIMIZED(VALUE rb_struct_lookup(VALUE s, VALUE idx));
1301NOINLINE(static VALUE rb_struct_lookup_default(VALUE s, VALUE idx, VALUE notfound, bool name_only));
1302
1303VALUE
1304rb_struct_lookup(VALUE s, VALUE idx)
1305{
1306 return rb_struct_lookup_default(s, idx, Qnil, false);
1307}
1308
1309static VALUE
1310rb_struct_lookup_default(VALUE s, VALUE idx, VALUE notfound, bool name_only)
1311{
1312 int i = rb_struct_pos(s, &idx, name_only);
1313 if (i < 0) return notfound;
1314 return RSTRUCT_GET(s, i);
1315}
1316
1317static VALUE
1318struct_entry(VALUE s, long n)
1319{
1320 return rb_struct_aref(s, LONG2NUM(n));
1321}
1322
1323/*
1324 * call-seq:
1325 * values_at(*integers) -> array
1326 * values_at(integer_range) -> array
1327 *
1328 * Returns an array of values from +self+.
1329 *
1330 * With integer arguments +integers+ given,
1331 * returns an array containing each value given by one of +integers+:
1332 *
1333 * Customer = Struct.new(:name, :address, :zip)
1334 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1335 * joe.values_at(0, 2) # => ["Joe Smith", 12345]
1336 * joe.values_at(2, 0) # => [12345, "Joe Smith"]
1337 * joe.values_at(2, 1, 0) # => [12345, "123 Maple, Anytown NC", "Joe Smith"]
1338 * joe.values_at(0, -3) # => ["Joe Smith", "Joe Smith"]
1339 *
1340 * Raises IndexError if any of +integers+ is out of range;
1341 * see Array@Array+Indexes.
1342 *
1343 * With integer range argument +integer_range+ given,
1344 * returns an array containing each value given by the elements of the range;
1345 * fills with +nil+ values for range elements larger than the structure:
1346 *
1347 * joe.values_at(0..2)
1348 * # => ["Joe Smith", "123 Maple, Anytown NC", 12345]
1349 * joe.values_at(-3..-1)
1350 * # => ["Joe Smith", "123 Maple, Anytown NC", 12345]
1351 * joe.values_at(1..4) # => ["123 Maple, Anytown NC", 12345, nil, nil]
1352 *
1353 * Raises RangeError if any element of the range is negative and out of range;
1354 * see Array@Array+Indexes.
1355 *
1356 */
1357
1358static VALUE
1359rb_struct_values_at(int argc, VALUE *argv, VALUE s)
1360{
1361 return rb_get_values_at(s, RSTRUCT_LEN(s), argc, argv, struct_entry);
1362}
1363
1364/*
1365 * call-seq:
1366 * select {|value| ... } -> array
1367 * select -> enumerator
1368 *
1369 * With a block given, returns an array of values from +self+
1370 * for which the block returns a truthy value:
1371 *
1372 * Customer = Struct.new(:name, :address, :zip)
1373 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1374 * a = joe.select {|value| value.is_a?(String) }
1375 * a # => ["Joe Smith", "123 Maple, Anytown NC"]
1376 * a = joe.select {|value| value.is_a?(Integer) }
1377 * a # => [12345]
1378 *
1379 * With no block given, returns an Enumerator.
1380 */
1381
1382static VALUE
1383rb_struct_select(int argc, VALUE *argv, VALUE s)
1384{
1385 VALUE result;
1386 long i;
1387
1388 rb_check_arity(argc, 0, 0);
1389 RETURN_SIZED_ENUMERATOR(s, 0, 0, struct_enum_size);
1390 result = rb_ary_new();
1391 for (i = 0; i < RSTRUCT_LEN(s); i++) {
1392 if (RTEST(rb_yield(RSTRUCT_GET(s, i)))) {
1393 rb_ary_push(result, RSTRUCT_GET(s, i));
1394 }
1395 }
1396
1397 return result;
1398}
1399
1400static VALUE
1401recursive_equal(VALUE s, VALUE s2, int recur)
1402{
1403 long i, len;
1404
1405 if (recur) return Qtrue; /* Subtle! */
1406 len = RSTRUCT_LEN(s);
1407 for (i=0; i<len; i++) {
1408 if (!rb_equal(RSTRUCT_GET(s, i), RSTRUCT_GET(s2, i))) return Qfalse;
1409 }
1410 return Qtrue;
1411}
1412
1413
1414/*
1415 * call-seq:
1416 * self == other -> true or false
1417 *
1418 * Returns +true+ if and only if the following are true; otherwise returns +false+:
1419 *
1420 * - <tt>other.class == self.class</tt>.
1421 * - For each member name +name+, <tt>other.name == self.name</tt>.
1422 *
1423 * Examples:
1424 *
1425 * Customer = Struct.new(:name, :address, :zip)
1426 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1427 * joe_jr = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1428 * joe_jr == joe # => true
1429 * joe_jr[:name] = 'Joe Smith, Jr.'
1430 * # => "Joe Smith, Jr."
1431 * joe_jr == joe # => false
1432 */
1433
1434static VALUE
1435rb_struct_equal(VALUE s, VALUE s2)
1436{
1437 if (s == s2) return Qtrue;
1438 if (!RB_TYPE_P(s2, T_STRUCT)) return Qfalse;
1439 if (rb_obj_class(s) != rb_obj_class(s2)) return Qfalse;
1440 if (RSTRUCT_LEN(s) != RSTRUCT_LEN(s2)) {
1441 rb_bug("inconsistent struct"); /* should never happen */
1442 }
1443
1444 return rb_exec_recursive_paired(recursive_equal, s, s2, s2);
1445}
1446
1447/*
1448 * call-seq:
1449 * hash -> integer
1450 *
1451 * Returns the integer hash value for +self+.
1452 *
1453 * Two structs of the same class and with the same content
1454 * will have the same hash code (and will compare using Struct#eql?):
1455 *
1456 * Customer = Struct.new(:name, :address, :zip)
1457 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1458 * joe_jr = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1459 * joe.hash == joe_jr.hash # => true
1460 * joe_jr[:name] = 'Joe Smith, Jr.'
1461 * joe.hash == joe_jr.hash # => false
1462 *
1463 * Related: Object#hash.
1464 */
1465
1466static VALUE
1467rb_struct_hash(VALUE s)
1468{
1469 long i, len;
1470 st_index_t h;
1471 VALUE n;
1472
1473 h = rb_hash_start(rb_hash(rb_obj_class(s)));
1474 len = RSTRUCT_LEN(s);
1475 for (i = 0; i < len; i++) {
1476 n = rb_hash(RSTRUCT_GET(s, i));
1477 h = rb_hash_uint(h, NUM2LONG(n));
1478 }
1479 h = rb_hash_end(h);
1480 return ST2FIX(h);
1481}
1482
1483static VALUE
1484recursive_eql(VALUE s, VALUE s2, int recur)
1485{
1486 long i, len;
1487
1488 if (recur) return Qtrue; /* Subtle! */
1489 len = RSTRUCT_LEN(s);
1490 for (i=0; i<len; i++) {
1491 if (!rb_eql(RSTRUCT_GET(s, i), RSTRUCT_GET(s2, i))) return Qfalse;
1492 }
1493 return Qtrue;
1494}
1495
1496/*
1497 * call-seq:
1498 * eql?(other) -> true or false
1499 *
1500 * Returns +true+ if and only if the following are true; otherwise returns +false+:
1501 *
1502 * - <tt>other.class == self.class</tt>.
1503 * - For each member name +name+, <tt>other.name.eql?(self.name)</tt>.
1504 *
1505 * Customer = Struct.new(:name, :address, :zip)
1506 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1507 * joe_jr = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1508 * joe_jr.eql?(joe) # => true
1509 * joe_jr[:name] = 'Joe Smith, Jr.'
1510 * joe_jr.eql?(joe) # => false
1511 *
1512 * Related: Object#==.
1513 */
1514
1515static VALUE
1516rb_struct_eql(VALUE s, VALUE s2)
1517{
1518 if (s == s2) return Qtrue;
1519 if (!RB_TYPE_P(s2, T_STRUCT)) return Qfalse;
1520 if (rb_obj_class(s) != rb_obj_class(s2)) return Qfalse;
1521 if (RSTRUCT_LEN(s) != RSTRUCT_LEN(s2)) {
1522 rb_bug("inconsistent struct"); /* should never happen */
1523 }
1524
1525 return rb_exec_recursive_paired(recursive_eql, s, s2, s2);
1526}
1527
1528/*
1529 * call-seq:
1530 * size -> integer
1531 *
1532 * Returns the number of members.
1533 *
1534 * Customer = Struct.new(:name, :address, :zip)
1535 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
1536 * joe.size #=> 3
1537 *
1538 */
1539
1540VALUE
1542{
1543 return LONG2FIX(RSTRUCT_LEN(s));
1544}
1545
1546/*
1547 * call-seq:
1548 * dig(name, *identifiers) -> object
1549 * dig(n, *identifiers) -> object
1550 *
1551 * Finds and returns an object among nested objects.
1552 * The nested objects may be instances of various classes.
1553 * See {Dig Methods}[rdoc-ref:dig_methods.rdoc].
1554 *
1555 *
1556 * Given symbol or string argument +name+,
1557 * returns the object that is specified by +name+ and +identifiers+:
1558 *
1559 * Foo = Struct.new(:a)
1560 * f = Foo.new(Foo.new({b: [1, 2, 3]}))
1561 * f.dig(:a) # => #<struct Foo a={:b=>[1, 2, 3]}>
1562 * f.dig(:a, :a) # => {:b=>[1, 2, 3]}
1563 * f.dig(:a, :a, :b) # => [1, 2, 3]
1564 * f.dig(:a, :a, :b, 0) # => 1
1565 * f.dig(:b, 0) # => nil
1566 *
1567 * Given integer argument +n+,
1568 * returns the object that is specified by +n+ and +identifiers+:
1569 *
1570 * f.dig(0) # => #<struct Foo a={:b=>[1, 2, 3]}>
1571 * f.dig(0, 0) # => {:b=>[1, 2, 3]}
1572 * f.dig(0, 0, :b) # => [1, 2, 3]
1573 * f.dig(0, 0, :b, 0) # => 1
1574 * f.dig(:b, 0) # => nil
1575 *
1576 */
1577
1578static VALUE
1579rb_struct_dig(int argc, VALUE *argv, VALUE self)
1580{
1581 rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS);
1582 self = rb_struct_lookup(self, *argv);
1583 if (!--argc) return self;
1584 ++argv;
1585 return rb_obj_dig(argc, argv, self, Qnil);
1586}
1587
1588/*
1589 * Document-class: Data
1590 *
1591 * Class \Data provides a convenient way to define simple classes
1592 * for value-alike objects.
1593 *
1594 * The simplest example of usage:
1595 *
1596 * Measure = Data.define(:amount, :unit)
1597 *
1598 * # Positional arguments constructor is provided
1599 * distance = Measure.new(100, 'km')
1600 * #=> #<data Measure amount=100, unit="km">
1601 *
1602 * # Keyword arguments constructor is provided
1603 * weight = Measure.new(amount: 50, unit: 'kg')
1604 * #=> #<data Measure amount=50, unit="kg">
1605 *
1606 * # Alternative form to construct an object:
1607 * speed = Measure[10, 'mPh']
1608 * #=> #<data Measure amount=10, unit="mPh">
1609 *
1610 * # Works with keyword arguments, too:
1611 * area = Measure[amount: 1.5, unit: 'm^2']
1612 * #=> #<data Measure amount=1.5, unit="m^2">
1613 *
1614 * # Argument accessors are provided:
1615 * distance.amount #=> 100
1616 * distance.unit #=> "km"
1617 *
1618 * Constructed object also has a reasonable definitions of #==
1619 * operator, #to_h hash conversion, and #deconstruct / #deconstruct_keys
1620 * to be used in pattern matching.
1621 *
1622 * ::define method accepts an optional block and evaluates it in
1623 * the context of the newly defined class. That allows to define
1624 * additional methods:
1625 *
1626 * Measure = Data.define(:amount, :unit) do
1627 * def <=>(other)
1628 * return unless other.is_a?(self.class) && other.unit == unit
1629 * amount <=> other.amount
1630 * end
1631 *
1632 * include Comparable
1633 * end
1634 *
1635 * Measure[3, 'm'] < Measure[5, 'm'] #=> true
1636 * Measure[3, 'm'] < Measure[5, 'kg']
1637 * # comparison of Measure with Measure failed (ArgumentError)
1638 *
1639 * Data provides no member writers, or enumerators: it is meant
1640 * to be a storage for immutable atomic values. But note that
1641 * if some of data members is of a mutable class, Data does no additional
1642 * immutability enforcement:
1643 *
1644 * Event = Data.define(:time, :weekdays)
1645 * event = Event.new('18:00', %w[Tue Wed Fri])
1646 * #=> #<data Event time="18:00", weekdays=["Tue", "Wed", "Fri"]>
1647 *
1648 * # There is no #time= or #weekdays= accessors, but changes are
1649 * # still possible:
1650 * event.weekdays << 'Sat'
1651 * event
1652 * #=> #<data Event time="18:00", weekdays=["Tue", "Wed", "Fri", "Sat"]>
1653 *
1654 * See also Struct, which is a similar concept, but has more
1655 * container-alike API, allowing to change contents of the object
1656 * and enumerate it.
1657 */
1658
1659/*
1660 * call-seq:
1661 * define(*symbols) -> class
1662 *
1663 * Defines a new \Data class.
1664 *
1665 * measure = Data.define(:amount, :unit)
1666 * #=> #<Class:0x00007f70c6868498>
1667 * measure.new(1, 'km')
1668 * #=> #<data amount=1, unit="km">
1669 *
1670 * # It you store the new class in the constant, it will
1671 * # affect #inspect and will be more natural to use:
1672 * Measure = Data.define(:amount, :unit)
1673 * #=> Measure
1674 * Measure.new(1, 'km')
1675 * #=> #<data Measure amount=1, unit="km">
1676 *
1677 *
1678 * Note that member-less \Data is acceptable and might be a useful technique
1679 * for defining several homogeneous data classes, like
1680 *
1681 * class HTTPFetcher
1682 * Response = Data.define(:body)
1683 * NotFound = Data.define
1684 * # ... implementation
1685 * end
1686 *
1687 * Now, different kinds of responses from +HTTPFetcher+ would have consistent
1688 * representation:
1689 *
1690 * #<data HTTPFetcher::Response body="<html...">
1691 * #<data HTTPFetcher::NotFound>
1692 *
1693 * And are convenient to use in pattern matching:
1694 *
1695 * case fetcher.get(url)
1696 * in HTTPFetcher::Response(body)
1697 * # process body variable
1698 * in HTTPFetcher::NotFound
1699 * # handle not found case
1700 * end
1701 */
1702
1703static VALUE
1704rb_data_s_def(int argc, VALUE *argv, VALUE klass)
1705{
1706 VALUE rest;
1707 long i;
1708 VALUE data_class;
1709
1710 rest = rb_ident_hash_new();
1711 RBASIC_CLEAR_CLASS(rest);
1712 for (i=0; i<argc; i++) {
1713 VALUE mem = rb_to_symbol(argv[i]);
1714 if (rb_is_attrset_sym(mem)) {
1715 rb_raise(rb_eArgError, "invalid data member: %"PRIsVALUE, mem);
1716 }
1717 if (RTEST(rb_hash_has_key(rest, mem))) {
1718 rb_raise(rb_eArgError, "duplicate member: %"PRIsVALUE, mem);
1719 }
1720 rb_hash_aset(rest, mem, Qtrue);
1721 }
1722 rest = rb_hash_keys(rest);
1723 RBASIC_CLEAR_CLASS(rest);
1724 OBJ_FREEZE(rest);
1725 data_class = anonymous_struct(klass);
1726 setup_data(data_class, rest);
1727 if (rb_block_given_p()) {
1728 rb_mod_module_eval(0, 0, data_class);
1729 }
1730
1731 return data_class;
1732}
1733
1734VALUE
1736{
1737 va_list ar;
1738 VALUE ary;
1739 va_start(ar, super);
1740 ary = struct_make_members_list(ar);
1741 va_end(ar);
1742 if (!super) super = rb_cData;
1743 VALUE klass = setup_data(anonymous_struct(super), ary);
1744 rb_vm_register_global_object(klass);
1745 return klass;
1746}
1747
1748static int
1749data_hash_set_i(VALUE key, VALUE val, VALUE arg)
1750{
1751 struct struct_hash_set_arg *args = (struct struct_hash_set_arg *)arg;
1752 int i = struct_hash_aset(key, val, args, true);
1753 if (i >= 0 && args->missing_count > 0) {
1754 VALUE k = RARRAY_AREF(args->missing_keywords, i);
1755 if (!NIL_P(k)) {
1756 RARRAY_ASET(args->missing_keywords, i, Qnil);
1757 args->missing_count--;
1758 }
1759 }
1760 return ST_CONTINUE;
1761}
1762
1763/*
1764 * call-seq:
1765 * DataClass::members -> array_of_symbols
1766 *
1767 * Returns an array of member names of the data class:
1768 *
1769 * Measure = Data.define(:amount, :unit)
1770 * Measure.members # => [:amount, :unit]
1771 *
1772 */
1773
1774#define rb_data_s_members_m rb_struct_s_members_m
1775
1776
1777/*
1778 * call-seq:
1779 * new(*args) -> instance
1780 * new(**kwargs) -> instance
1781 * ::[](*args) -> instance
1782 * ::[](**kwargs) -> instance
1783 *
1784 * Constructors for classes defined with ::define accept both positional and
1785 * keyword arguments.
1786 *
1787 * Measure = Data.define(:amount, :unit)
1788 *
1789 * Measure.new(1, 'km')
1790 * #=> #<data Measure amount=1, unit="km">
1791 * Measure.new(amount: 1, unit: 'km')
1792 * #=> #<data Measure amount=1, unit="km">
1793 *
1794 * # Alternative shorter initialization with []
1795 * Measure[1, 'km']
1796 * #=> #<data Measure amount=1, unit="km">
1797 * Measure[amount: 1, unit: 'km']
1798 * #=> #<data Measure amount=1, unit="km">
1799 *
1800 * All arguments are mandatory (unlike Struct), and converted to keyword arguments:
1801 *
1802 * Measure.new(amount: 1)
1803 * # in `initialize': missing keyword: :unit (ArgumentError)
1804 *
1805 * Measure.new(1)
1806 * # in `initialize': missing keyword: :unit (ArgumentError)
1807 *
1808 * Note that <tt>Measure#initialize</tt> always receives keyword arguments, and that
1809 * mandatory arguments are checked in +initialize+, not in +new+. This can be
1810 * important for redefining initialize in order to convert arguments or provide
1811 * defaults:
1812 *
1813 * Measure = Data.define(:amount, :unit)
1814 * class Measure
1815 * NONE = Data.define
1816 *
1817 * def initialize(amount:, unit: NONE.new)
1818 * super(amount: Float(amount), unit:)
1819 * end
1820 * end
1821 *
1822 * Measure.new('10', 'km') # => #<data Measure amount=10.0, unit="km">
1823 * Measure.new(10_000) # => #<data Measure amount=10000.0, unit=#<data Measure::NONE>>
1824 *
1825 */
1826
1827static VALUE
1828rb_data_initialize_m(int argc, const VALUE *argv, VALUE self)
1829{
1830 VALUE klass = rb_obj_class(self);
1831 rb_struct_modify(self);
1832 VALUE members = struct_ivar_get(klass, id_members);
1833 size_t num_members = RARRAY_LEN(members);
1834
1835 if (argc == 0) {
1836 if (num_members > 0) {
1837 rb_exc_raise(rb_keyword_error_new("missing", members));
1838 }
1839 OBJ_FREEZE(self);
1840 return Qnil;
1841 }
1842 if (argc > 1 || !RB_TYPE_P(argv[0], T_HASH)) {
1843 rb_error_arity(argc, 0, 0);
1844 }
1845
1846 VALUE missing = rb_ary_dup(members);
1847 RBASIC_CLEAR_CLASS(missing);
1848 struct struct_hash_set_arg arg = {
1849 .self = self,
1850 .unknown_keywords = Qnil,
1851 .missing_keywords = missing,
1852 .missing_count = (long)num_members,
1853 };
1854 rb_mem_clear((VALUE *)RSTRUCT_CONST_PTR(self), num_members);
1855 rb_hash_foreach(argv[0], data_hash_set_i, (VALUE)&arg);
1856 // Freeze early before potentially raising, so that we don't leave an
1857 // unfrozen copy on the heap, which could get exposed via ObjectSpace.
1858 OBJ_FREEZE(self);
1859 if (UNLIKELY(arg.missing_count > 0)) {
1860 rb_ary_compact_bang(missing);
1861 RUBY_ASSERT(RARRAY_LEN(missing) == arg.missing_count, "missing_count=%ld but %ld", arg.missing_count, RARRAY_LEN(missing));
1862 RBASIC_SET_CLASS_RAW(missing, rb_cArray);
1863 rb_exc_raise(rb_keyword_error_new("missing", missing));
1864 }
1865 VALUE unknown_keywords = arg.unknown_keywords;
1866 if (UNLIKELY(!NIL_P(unknown_keywords))) {
1867 RBASIC_SET_CLASS_RAW(unknown_keywords, rb_cArray);
1868 rb_exc_raise(rb_keyword_error_new("unknown", unknown_keywords));
1869 }
1870
1871 return Qnil;
1872}
1873
1874/* :nodoc: */
1875static VALUE
1876rb_data_init_copy(VALUE copy, VALUE s)
1877{
1878 copy = rb_struct_init_copy(copy, s);
1879 RB_OBJ_FREEZE(copy);
1880 return copy;
1881}
1882
1883/*
1884 * call-seq:
1885 * with(**kwargs) -> instance
1886 *
1887 * Returns a shallow copy of +self+ --- the instance variables of
1888 * +self+ are copied, but not the objects they reference.
1889 *
1890 * If the method is supplied any keyword arguments, the copy will
1891 * be created with the respective field values updated to use the
1892 * supplied keyword argument values. Note that it is an error to
1893 * supply a keyword that the Data class does not have as a member.
1894 *
1895 * Point = Data.define(:x, :y)
1896 *
1897 * origin = Point.new(x: 0, y: 0)
1898 *
1899 * up = origin.with(x: 1)
1900 * right = origin.with(y: 1)
1901 * up_and_right = up.with(y: 1)
1902 *
1903 * p origin # #<data Point x=0, y=0>
1904 * p up # #<data Point x=1, y=0>
1905 * p right # #<data Point x=0, y=1>
1906 * p up_and_right # #<data Point x=1, y=1>
1907 *
1908 * out = origin.with(z: 1) # ArgumentError: unknown keyword: :z
1909 * some_point = origin.with(1, 2) # ArgumentError: expected keyword arguments, got positional arguments
1910 *
1911 */
1912
1913static VALUE
1914rb_data_with(int argc, const VALUE *argv, VALUE self)
1915{
1916 VALUE kwargs;
1917 rb_scan_args(argc, argv, "0:", &kwargs);
1918 if (NIL_P(kwargs)) {
1919 return self;
1920 }
1921
1922 VALUE h = rb_struct_to_h(self);
1923 rb_hash_update_by(h, kwargs, 0);
1924 return rb_class_new_instance_kw(1, &h, rb_obj_class(self), TRUE);
1925}
1926
1927/*
1928 * call-seq:
1929 * inspect -> string
1930 * to_s -> string
1931 *
1932 * Returns a string representation of +self+:
1933 *
1934 * Measure = Data.define(:amount, :unit)
1935 *
1936 * distance = Measure[10, 'km']
1937 *
1938 * p distance # uses #inspect underneath
1939 * #<data Measure amount=10, unit="km">
1940 *
1941 * puts distance # uses #to_s underneath, same representation
1942 * #<data Measure amount=10, unit="km">
1943 *
1944 */
1945
1946static VALUE
1947rb_data_inspect(VALUE s)
1948{
1949 return rb_exec_recursive(inspect_struct, s, rb_str_new2("#<data "));
1950}
1951
1952/*
1953 * call-seq:
1954 * self == other -> true or false
1955 *
1956 * Returns +true+ if +other+ is the same class as +self+, and all members are
1957 * equal.
1958 *
1959 * Examples:
1960 *
1961 * Measure = Data.define(:amount, :unit)
1962 *
1963 * Measure[1, 'km'] == Measure[1, 'km'] #=> true
1964 * Measure[1, 'km'] == Measure[2, 'km'] #=> false
1965 * Measure[1, 'km'] == Measure[1, 'm'] #=> false
1966 *
1967 * Measurement = Data.define(:amount, :unit)
1968 * # Even though Measurement and Measure have the same "shape"
1969 * # their instances are never equal
1970 * Measure[1, 'km'] == Measurement[1, 'km'] #=> false
1971 */
1972
1973#define rb_data_equal rb_struct_equal
1974
1975/*
1976 * call-seq:
1977 * self.eql?(other) -> true or false
1978 *
1979 * Equality check that is used when two items of data are keys of a Hash.
1980 *
1981 * The subtle difference with #== is that members are also compared with their
1982 * #eql? method, which might be important in some cases:
1983 *
1984 * Measure = Data.define(:amount, :unit)
1985 *
1986 * Measure[1, 'km'] == Measure[1.0, 'km'] #=> true, they are equal as values
1987 * # ...but...
1988 * Measure[1, 'km'].eql? Measure[1.0, 'km'] #=> false, they represent different hash keys
1989 *
1990 * See also Object#eql? for further explanations of the method usage.
1991 */
1992
1993#define rb_data_eql rb_struct_eql
1994
1995/*
1996 * call-seq:
1997 * hash -> integer
1998 *
1999 * Redefines Object#hash (used to distinguish objects as Hash keys) so that
2000 * data objects of the same class with same content would have the same +hash+
2001 * value, and represented the same Hash key.
2002 *
2003 * Measure = Data.define(:amount, :unit)
2004 *
2005 * Measure[1, 'km'].hash == Measure[1, 'km'].hash #=> true
2006 * Measure[1, 'km'].hash == Measure[10, 'km'].hash #=> false
2007 * Measure[1, 'km'].hash == Measure[1, 'm'].hash #=> false
2008 * Measure[1, 'km'].hash == Measure[1.0, 'km'].hash #=> false
2009 *
2010 * # Structurally similar data class, but shouldn't be considered
2011 * # the same hash key
2012 * Measurement = Data.define(:amount, :unit)
2013 *
2014 * Measure[1, 'km'].hash == Measurement[1, 'km'].hash #=> false
2015 */
2016
2017#define rb_data_hash rb_struct_hash
2018
2019/*
2020 * call-seq:
2021 * to_h -> hash
2022 * to_h {|name, value| ... } -> hash
2023 *
2024 * Returns Hash representation of the data object.
2025 *
2026 * Measure = Data.define(:amount, :unit)
2027 * distance = Measure[10, 'km']
2028 *
2029 * distance.to_h
2030 * #=> {:amount=>10, :unit=>"km"}
2031 *
2032 * Like Enumerable#to_h, if the block is provided, it is expected to
2033 * produce key-value pairs to construct a hash:
2034 *
2035 *
2036 * distance.to_h { |name, val| [name.to_s, val.to_s] }
2037 * #=> {"amount"=>"10", "unit"=>"km"}
2038 *
2039 * Note that there is a useful symmetry between #to_h and #initialize:
2040 *
2041 * distance2 = Measure.new(**distance.to_h)
2042 * #=> #<data Measure amount=10, unit="km">
2043 * distance2 == distance
2044 * #=> true
2045 */
2046
2047#define rb_data_to_h rb_struct_to_h
2048
2049/*
2050 * call-seq:
2051 * members -> array_of_symbols
2052 *
2053 * Returns the member names from +self+ as an array:
2054 *
2055 * Measure = Data.define(:amount, :unit)
2056 * distance = Measure[10, 'km']
2057 *
2058 * distance.members #=> [:amount, :unit]
2059 *
2060 */
2061
2062#define rb_data_members_m rb_struct_members_m
2063
2064/*
2065 * call-seq:
2066 * deconstruct -> array
2067 *
2068 * Returns the values in +self+ as an array, to use in pattern matching:
2069 *
2070 * Measure = Data.define(:amount, :unit)
2071 *
2072 * distance = Measure[10, 'km']
2073 * distance.deconstruct #=> [10, "km"]
2074 *
2075 * # usage
2076 * case distance
2077 * in n, 'km' # calls #deconstruct underneath
2078 * puts "It is #{n} kilometers away"
2079 * else
2080 * puts "Don't know how to handle it"
2081 * end
2082 * # prints "It is 10 kilometers away"
2083 *
2084 * Or, with checking the class, too:
2085 *
2086 * case distance
2087 * in Measure(n, 'km')
2088 * puts "It is #{n} kilometers away"
2089 * # ...
2090 * end
2091 */
2092
2093#define rb_data_deconstruct rb_struct_to_a
2094
2095/*
2096 * call-seq:
2097 * deconstruct_keys(array_of_names_or_nil) -> hash
2098 *
2099 * Returns a hash of the name/value pairs, to use in pattern matching.
2100 *
2101 * Measure = Data.define(:amount, :unit)
2102 *
2103 * distance = Measure[10, 'km']
2104 * distance.deconstruct_keys(nil) #=> {:amount=>10, :unit=>"km"}
2105 * distance.deconstruct_keys([:amount]) #=> {:amount=>10}
2106 *
2107 * # usage
2108 * case distance
2109 * in amount:, unit: 'km' # calls #deconstruct_keys underneath
2110 * puts "It is #{amount} kilometers away"
2111 * else
2112 * puts "Don't know how to handle it"
2113 * end
2114 * # prints "It is 10 kilometers away"
2115 *
2116 * Or, with checking the class, too:
2117 *
2118 * case distance
2119 * in Measure(amount:, unit: 'km')
2120 * puts "It is #{amount} kilometers away"
2121 * # ...
2122 * end
2123 */
2124
2125static VALUE
2126rb_data_deconstruct_keys(VALUE s, VALUE keys)
2127{
2128 return deconstruct_keys(s, keys, true);
2129}
2130
2131/*
2132 * Document-class: Struct
2133 *
2134 * Class \Struct provides a convenient way to create a simple class
2135 * that can store and fetch values.
2136 *
2137 * This example creates a subclass of +Struct+, <tt>Struct::Customer</tt>;
2138 * the first argument, a string, is the name of the subclass;
2139 * the other arguments, symbols, determine the _members_ of the new subclass.
2140 *
2141 * Customer = Struct.new('Customer', :name, :address, :zip)
2142 * Customer.name # => "Struct::Customer"
2143 * Customer.class # => Class
2144 * Customer.superclass # => Struct
2145 *
2146 * Corresponding to each member are two methods, a writer and a reader,
2147 * that store and fetch values:
2148 *
2149 * methods = Customer.instance_methods false
2150 * methods # => [:zip, :address=, :zip=, :address, :name, :name=]
2151 *
2152 * An instance of the subclass may be created,
2153 * and its members assigned values, via method <tt>::new</tt>:
2154 *
2155 * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
2156 * joe # => #<struct Struct::Customer name="Joe Smith", address="123 Maple, Anytown NC", zip=12345>
2157 *
2158 * The member values may be managed thus:
2159 *
2160 * joe.name # => "Joe Smith"
2161 * joe.name = 'Joseph Smith'
2162 * joe.name # => "Joseph Smith"
2163 *
2164 * And thus; note that member name may be expressed as either a string or a symbol:
2165 *
2166 * joe[:name] # => "Joseph Smith"
2167 * joe[:name] = 'Joseph Smith, Jr.'
2168 * joe['name'] # => "Joseph Smith, Jr."
2169 *
2170 * See Struct::new.
2171 *
2172 * == What's Here
2173 *
2174 * First, what's elsewhere. Class \Struct:
2175 *
2176 * - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
2177 * - Includes {module Enumerable}[rdoc-ref:Enumerable@What-27s+Here],
2178 * which provides dozens of additional methods.
2179 *
2180 * See also Data, which is a somewhat similar, but stricter concept for defining immutable
2181 * value objects.
2182 *
2183 * Here, class \Struct provides methods that are useful for:
2184 *
2185 * - {Creating a Struct Subclass}[rdoc-ref:Struct@Methods+for+Creating+a+Struct+Subclass]
2186 * - {Querying}[rdoc-ref:Struct@Methods+for+Querying]
2187 * - {Comparing}[rdoc-ref:Struct@Methods+for+Comparing]
2188 * - {Fetching}[rdoc-ref:Struct@Methods+for+Fetching]
2189 * - {Assigning}[rdoc-ref:Struct@Methods+for+Assigning]
2190 * - {Iterating}[rdoc-ref:Struct@Methods+for+Iterating]
2191 * - {Converting}[rdoc-ref:Struct@Methods+for+Converting]
2192 *
2193 * === Methods for Creating a Struct Subclass
2194 *
2195 * - ::new: Returns a new subclass of \Struct.
2196 *
2197 * === Methods for Querying
2198 *
2199 * - #hash: Returns the integer hash code.
2200 * - #size (aliased as #length): Returns the number of members.
2201 *
2202 * === Methods for Comparing
2203 *
2204 * - #==: Returns whether a given object is equal to +self+, using <tt>==</tt>
2205 * to compare member values.
2206 * - #eql?: Returns whether a given object is equal to +self+,
2207 * using <tt>eql?</tt> to compare member values.
2208 *
2209 * === Methods for Fetching
2210 *
2211 * - #[]: Returns the value associated with a given member name.
2212 * - #to_a (aliased as #values, #deconstruct): Returns the member values in +self+ as an array.
2213 * - #deconstruct_keys: Returns a hash of the name/value pairs
2214 * for given member names.
2215 * - #dig: Returns the object in nested objects that is specified
2216 * by a given member name and additional arguments.
2217 * - #members: Returns an array of the member names.
2218 * - #select (aliased as #filter): Returns an array of member values from +self+,
2219 * as selected by the given block.
2220 * - #values_at: Returns an array containing values for given member names.
2221 *
2222 * === Methods for Assigning
2223 *
2224 * - #[]=: Assigns a given value to a given member name.
2225 *
2226 * === Methods for Iterating
2227 *
2228 * - #each: Calls a given block with each member name.
2229 * - #each_pair: Calls a given block with each member name/value pair.
2230 *
2231 * === Methods for Converting
2232 *
2233 * - #inspect (aliased as #to_s): Returns a string representation of +self+.
2234 * - #to_h: Returns a hash of the member name/value pairs in +self+.
2235 *
2236 */
2237void
2238InitVM_Struct(void)
2239{
2240 rb_cStruct = rb_define_class("Struct", rb_cObject);
2242
2244 rb_define_singleton_method(rb_cStruct, "new", rb_struct_s_def, -1);
2245#if 0 /* for RDoc */
2246 rb_define_singleton_method(rb_cStruct, "keyword_init?", rb_struct_s_keyword_init_p, 0);
2247 rb_define_singleton_method(rb_cStruct, "members", rb_struct_s_members_m, 0);
2248#endif
2249
2250 rb_define_method(rb_cStruct, "initialize", rb_struct_initialize_m, -1);
2251 rb_define_method(rb_cStruct, "initialize_copy", rb_struct_init_copy, 1);
2252
2253 rb_define_method(rb_cStruct, "==", rb_struct_equal, 1);
2254 rb_define_method(rb_cStruct, "eql?", rb_struct_eql, 1);
2255 rb_define_method(rb_cStruct, "hash", rb_struct_hash, 0);
2256
2257 rb_define_method(rb_cStruct, "inspect", rb_struct_inspect, 0);
2258 rb_define_alias(rb_cStruct, "to_s", "inspect");
2259 rb_define_method(rb_cStruct, "to_a", rb_struct_to_a, 0);
2260 rb_define_method(rb_cStruct, "to_h", rb_struct_to_h, 0);
2261 rb_define_method(rb_cStruct, "values", rb_struct_to_a, 0);
2264
2265 rb_define_method(rb_cStruct, "each", rb_struct_each, 0);
2266 rb_define_method(rb_cStruct, "each_pair", rb_struct_each_pair, 0);
2269 rb_define_method(rb_cStruct, "select", rb_struct_select, -1);
2270 rb_define_method(rb_cStruct, "filter", rb_struct_select, -1);
2271 rb_define_method(rb_cStruct, "values_at", rb_struct_values_at, -1);
2272
2273 rb_define_method(rb_cStruct, "members", rb_struct_members_m, 0);
2274 rb_define_method(rb_cStruct, "dig", rb_struct_dig, -1);
2275
2276 rb_define_method(rb_cStruct, "deconstruct", rb_struct_to_a, 0);
2277 rb_define_method(rb_cStruct, "deconstruct_keys", rb_struct_deconstruct_keys, 1);
2278
2279 rb_cData = rb_define_class("Data", rb_cObject);
2280
2281 rb_undef_method(CLASS_OF(rb_cData), "new");
2282 rb_undef_alloc_func(rb_cData);
2283 rb_define_singleton_method(rb_cData, "define", rb_data_s_def, -1);
2284
2285#if 0 /* for RDoc */
2286 rb_define_singleton_method(rb_cData, "members", rb_data_s_members_m, 0);
2287#endif
2288
2289 rb_define_method(rb_cData, "initialize", rb_data_initialize_m, -1);
2290 rb_define_method(rb_cData, "initialize_copy", rb_data_init_copy, 1);
2291
2292 rb_define_method(rb_cData, "==", rb_data_equal, 1);
2293 rb_define_method(rb_cData, "eql?", rb_data_eql, 1);
2294 rb_define_method(rb_cData, "hash", rb_data_hash, 0);
2295
2296 rb_define_method(rb_cData, "inspect", rb_data_inspect, 0);
2297 rb_define_alias(rb_cData, "to_s", "inspect");
2298 rb_define_method(rb_cData, "to_h", rb_data_to_h, 0);
2299
2300 rb_define_method(rb_cData, "members", rb_data_members_m, 0);
2301
2302 rb_define_method(rb_cData, "deconstruct", rb_data_deconstruct, 0);
2303 rb_define_method(rb_cData, "deconstruct_keys", rb_data_deconstruct_keys, 1);
2304
2305 rb_define_method(rb_cData, "with", rb_data_with, -1);
2306}
2307
2308#undef rb_intern
2309void
2310Init_Struct(void)
2311{
2312 id_members = rb_intern("__members__");
2313 id_back_members = rb_intern("__members_back__");
2314 id_keyword_init = rb_intern("__keyword_init__");
2315
2316 InitVM(Struct);
2317}
#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:1484
VALUE rb_class_new(VALUE super)
Creates a new, anonymous class.
Definition class.c:852
VALUE rb_singleton_class(VALUE obj)
Finds or creates the singleton class of the passed object.
Definition class.c:2817
VALUE rb_define_class_under(VALUE outer, const char *name, VALUE super)
Defines a class under the namespace of outer.
Definition class.c:1515
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:1554
VALUE rb_class_inherited(VALUE super, VALUE klass)
Calls Class::inherited.
Definition class.c:1475
void rb_define_alias(VALUE klass, const char *name1, const char *name2)
Defines an alias of a method.
Definition class.c:2860
void rb_undef_method(VALUE klass, const char *name)
Defines an undef of a method.
Definition class.c:2672
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:3150
int rb_keyword_given_p(void)
Determines if the current method is given a keyword argument.
Definition eval.c:1034
int rb_block_given_p(void)
Determines if the current method is given a block.
Definition eval.c:1021
int rb_get_kwargs(VALUE keyword_hash, const ID *table, int required, int optional, VALUE *values)
Keyword argument deconstructor.
Definition class.c:2939
#define rb_str_new2
Old name of rb_str_new_cstr.
Definition string.h:1676
#define FL_UNSET_RAW
Old name of RB_FL_UNSET_RAW.
Definition fl_type.h:133
#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:1684
#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:205
#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 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:664
VALUE rb_eTypeError
TypeError exception.
Definition error.c:1431
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:1433
VALUE rb_class_superclass(VALUE klass)
Queries the parent of the given class.
Definition object.c:2264
VALUE rb_cArray
Array class.
VALUE rb_class_new_instance(int argc, const VALUE *argv, VALUE klass)
Allocates, then initialises an instance of the given class.
Definition object.c:2249
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:2237
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:2226
int rb_eql(VALUE lhs, VALUE rhs)
Checks for equality of the passed objects, in terms of Object#eql?.
Definition object.c:189
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
Definition object.c:264
VALUE rb_inspect(VALUE obj)
Generates a human-readable textual representation of the given object.
Definition object.c:686
VALUE rb_equal(VALUE lhs, VALUE rhs)
This function is an optimised version of calling #==.
Definition object.c:176
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:923
#define RGENGC_WB_PROTECTED_STRUCT
This is a compile-time flag to enable/disable write barrier for struct RStruct.
Definition gc.h:468
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:208
#define UNLIMITED_ARGUMENTS
This macro is used in conjunction with rb_check_arity().
Definition error.h:35
int rb_is_const_id(ID id)
Classifies the given ID, then sees if it is a constant.
Definition symbol.c:1079
int rb_is_local_id(ID id)
Classifies the given ID, then sees if it is a local variable.
Definition symbol.c:1109
#define rb_hash_uint(h, i)
Just another name of st_hash_uint.
Definition string.h:943
#define rb_hash_end(h)
Just another name of st_hash_end.
Definition string.h:946
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:3799
st_index_t rb_hash_start(st_index_t i)
Starts a series of hashing.
Definition random.c:1776
#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:1657
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:872
VALUE rb_struct_initialize(VALUE self, VALUE values)
Mass-assigns a struct's fields.
Definition struct.c:806
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:866
VALUE rb_data_define(VALUE super,...)
Defines an anonymous data class.
Definition struct.c:1735
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.
Definition thread.c:5607
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,...
Definition thread.c:5618
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:2030
VALUE rb_mod_remove_const(VALUE space, VALUE name)
Resembles Module#remove_const.
Definition variable.c:3610
VALUE rb_class_name(VALUE obj)
Queries the name of the given object's class.
Definition variable.c:500
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:3843
VALUE rb_class_path(VALUE mod)
Identical to rb_mod_name(), except it returns #<Class: ...> style inspection for anonymous modules.
Definition variable.c:380
void rb_undef_alloc_func(VALUE klass)
Deletes the allocator function of a class.
Definition vm_method.c:1719
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:219
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:2414
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:1190
VALUE rb_to_symbol(VALUE name)
Identical to rb_intern_str(), except it generates a dynamic symbol if necessary.
Definition string.c:12674
ID rb_to_id(VALUE str)
Identical to rb_intern_str(), except it tries to convert the parameter object to an instance of rb_cS...
Definition string.c:12664
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:1395
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
#define RARRAY_LEN
Just another name of rb_array_len.
Definition rarray.h:51
#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
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:1779
VALUE rb_struct_aset(VALUE st, VALUE k, VALUE v)
Resembles Struct#[]=.
Definition struct.c:1291
VALUE rb_struct_size(VALUE st)
Returns the number of struct members.
Definition struct.c:1541
VALUE rb_struct_aref(VALUE st, VALUE k)
Resembles Struct#[].
Definition struct.c:1253
#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