summaryrefslogtreecommitdiff
path: root/struct.c
diff options
context:
space:
mode:
Diffstat (limited to 'struct.c')
-rw-r--r--struct.c1559
1 files changed, 1118 insertions, 441 deletions
diff --git a/struct.c b/struct.c
index f0307916b3..716bc7f4fd 100644
--- a/struct.c
+++ b/struct.c
@@ -9,30 +9,54 @@
**********************************************************************/
-#include "ruby/ruby.h"
+#include "id.h"
#include "internal.h"
+#include "internal/class.h"
+#include "internal/error.h"
+#include "internal/hash.h"
+#include "internal/object.h"
+#include "internal/proc.h"
+#include "internal/struct.h"
+#include "internal/symbol.h"
+#include "transient_heap.h"
+#include "vm_core.h"
+#include "builtin.h"
+
+/* only for struct[:field] access */
+enum {
+ AREF_HASH_UNIT = 5,
+ AREF_HASH_THRESHOLD = 10
+};
VALUE rb_cStruct;
-static ID id_members;
+static ID id_members, id_back_members, id_keyword_init;
static VALUE struct_alloc(VALUE);
static inline VALUE
struct_ivar_get(VALUE c, ID id)
{
+ VALUE orig = c;
+ VALUE ivar = rb_attr_get(c, id);
+
+ if (!NIL_P(ivar))
+ return ivar;
+
for (;;) {
- if (rb_ivar_defined(c, id))
- return rb_ivar_get(c, id);
c = RCLASS_SUPER(c);
if (c == 0 || c == rb_cStruct)
return Qnil;
+ ivar = rb_attr_get(c, id);
+ if (!NIL_P(ivar)) {
+ return rb_ivar_set(orig, id, ivar);
+ }
}
}
VALUE
-rb_struct_iv_get(VALUE c, const char *name)
+rb_struct_s_keyword_init(VALUE klass)
{
- return struct_ivar_get(c, rb_intern(name));
+ return struct_ivar_get(klass, id_keyword_init);
}
VALUE
@@ -61,6 +85,119 @@ rb_struct_members(VALUE s)
return members;
}
+static long
+struct_member_pos_ideal(VALUE name, long mask)
+{
+ /* (id & (mask/2)) * 2 */
+ return (SYM2ID(name) >> (ID_SCOPE_SHIFT - 1)) & mask;
+}
+
+static long
+struct_member_pos_probe(long prev, long mask)
+{
+ /* (((prev/2) * AREF_HASH_UNIT + 1) & (mask/2)) * 2 */
+ return (prev * AREF_HASH_UNIT + 2) & mask;
+}
+
+static VALUE
+struct_set_members(VALUE klass, VALUE /* frozen hidden array */ members)
+{
+ VALUE back;
+ const long members_length = RARRAY_LEN(members);
+
+ if (members_length <= AREF_HASH_THRESHOLD) {
+ back = members;
+ }
+ else {
+ long i, j, mask = 64;
+ VALUE name;
+
+ while (mask < members_length * AREF_HASH_UNIT) mask *= 2;
+
+ back = rb_ary_tmp_new(mask + 1);
+ rb_ary_store(back, mask, INT2FIX(members_length));
+ mask -= 2; /* mask = (2**k-1)*2 */
+
+ for (i=0; i < members_length; i++) {
+ name = RARRAY_AREF(members, i);
+
+ j = struct_member_pos_ideal(name, mask);
+
+ for (;;) {
+ if (!RTEST(RARRAY_AREF(back, j))) {
+ rb_ary_store(back, j, name);
+ rb_ary_store(back, j + 1, INT2FIX(i));
+ break;
+ }
+ j = struct_member_pos_probe(j, mask);
+ }
+ }
+ OBJ_FREEZE_RAW(back);
+ }
+ rb_ivar_set(klass, id_members, members);
+ rb_ivar_set(klass, id_back_members, back);
+
+ return members;
+}
+
+static inline int
+struct_member_pos(VALUE s, VALUE name)
+{
+ VALUE back = struct_ivar_get(rb_obj_class(s), id_back_members);
+ long j, mask;
+
+ if (UNLIKELY(NIL_P(back))) {
+ rb_raise(rb_eTypeError, "uninitialized struct");
+ }
+ if (UNLIKELY(!RB_TYPE_P(back, T_ARRAY))) {
+ rb_raise(rb_eTypeError, "corrupted struct");
+ }
+
+ mask = RARRAY_LEN(back);
+
+ if (mask <= AREF_HASH_THRESHOLD) {
+ if (UNLIKELY(RSTRUCT_LEN(s) != mask)) {
+ rb_raise(rb_eTypeError,
+ "struct size differs (%ld required %ld given)",
+ mask, RSTRUCT_LEN(s));
+ }
+ for (j = 0; j < mask; j++) {
+ if (RARRAY_AREF(back, j) == name)
+ return (int)j;
+ }
+ return -1;
+ }
+
+ if (UNLIKELY(RSTRUCT_LEN(s) != FIX2INT(RARRAY_AREF(back, mask-1)))) {
+ rb_raise(rb_eTypeError, "struct size differs (%d required %ld given)",
+ FIX2INT(RARRAY_AREF(back, mask-1)), RSTRUCT_LEN(s));
+ }
+
+ mask -= 3;
+ j = struct_member_pos_ideal(name, mask);
+
+ for (;;) {
+ VALUE e = RARRAY_AREF(back, j);
+ if (e == name)
+ return FIX2INT(RARRAY_AREF(back, j + 1));
+ if (!RTEST(e)) {
+ return -1;
+ }
+ j = struct_member_pos_probe(j, mask);
+ }
+}
+
+/*
+ * call-seq:
+ * StructClass::members -> array_of_symbols
+ *
+ * Returns the member names of the Struct descendant as an array:
+ *
+ * Customer = Struct.new(:name, :address, :zip)
+ * Customer.members # => [:name, :address, :zip]
+ *
+ */
+
static VALUE
rb_struct_s_members_m(VALUE klass)
{
@@ -71,14 +208,14 @@ rb_struct_s_members_m(VALUE klass)
/*
* call-seq:
- * struct.members -> array
+ * members -> array_of_symbols
*
- * Returns an array of symbols representing the names of the instance
- * variables.
+ * Returns the member names from +self+ as an array:
*
* Customer = Struct.new(:name, :address, :zip)
- * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
- * joe.members #=> [:name, :address, :zip]
+ * Customer.new.members # => [:name, :address, :zip]
+ *
+ * Related: #to_a.
*/
static VALUE
@@ -90,132 +227,122 @@ rb_struct_members_m(VALUE obj)
VALUE
rb_struct_getmember(VALUE obj, ID id)
{
- VALUE members, slot, *ptr, *ptr_members;
- long i, len;
-
- ptr = RSTRUCT_PTR(obj);
- members = rb_struct_members(obj);
- ptr_members = RARRAY_PTR(members);
- slot = ID2SYM(id);
- len = RARRAY_LEN(members);
- for (i=0; i<len; i++) {
- if (ptr_members[i] == slot) {
- return ptr[i];
- }
+ VALUE slot = ID2SYM(id);
+ int i = struct_member_pos(obj, slot);
+ if (i != -1) {
+ return RSTRUCT_GET(obj, i);
}
- rb_name_error(id, "%s is not struct member", rb_id2name(id));
+ rb_name_err_raise("`%1$s' is not a struct member", obj, ID2SYM(id));
- UNREACHABLE;
+ UNREACHABLE_RETURN(Qnil);
}
-static VALUE
-rb_struct_ref(VALUE obj)
-{
- return rb_struct_getmember(obj, rb_frame_this_func());
-}
-
-static VALUE rb_struct_ref0(VALUE obj) {return RSTRUCT_PTR(obj)[0];}
-static VALUE rb_struct_ref1(VALUE obj) {return RSTRUCT_PTR(obj)[1];}
-static VALUE rb_struct_ref2(VALUE obj) {return RSTRUCT_PTR(obj)[2];}
-static VALUE rb_struct_ref3(VALUE obj) {return RSTRUCT_PTR(obj)[3];}
-static VALUE rb_struct_ref4(VALUE obj) {return RSTRUCT_PTR(obj)[4];}
-static VALUE rb_struct_ref5(VALUE obj) {return RSTRUCT_PTR(obj)[5];}
-static VALUE rb_struct_ref6(VALUE obj) {return RSTRUCT_PTR(obj)[6];}
-static VALUE rb_struct_ref7(VALUE obj) {return RSTRUCT_PTR(obj)[7];}
-static VALUE rb_struct_ref8(VALUE obj) {return RSTRUCT_PTR(obj)[8];}
-static VALUE rb_struct_ref9(VALUE obj) {return RSTRUCT_PTR(obj)[9];}
-
-#define numberof(array) (int)(sizeof(array) / sizeof((array)[0]))
-#define N_REF_FUNC numberof(ref_func)
-
-static VALUE (*const ref_func[])(VALUE) = {
- rb_struct_ref0,
- rb_struct_ref1,
- rb_struct_ref2,
- rb_struct_ref3,
- rb_struct_ref4,
- rb_struct_ref5,
- rb_struct_ref6,
- rb_struct_ref7,
- rb_struct_ref8,
- rb_struct_ref9,
-};
-
static void
rb_struct_modify(VALUE s)
{
rb_check_frozen(s);
- rb_check_trusted(s);
}
static VALUE
-rb_struct_set(VALUE obj, VALUE val)
+anonymous_struct(VALUE klass)
{
- VALUE members, slot, *ptr, *ptr_members;
- long i, len;
+ VALUE nstr;
- members = rb_struct_members(obj);
- ptr_members = RARRAY_PTR(members);
- len = RARRAY_LEN(members);
- rb_struct_modify(obj);
- ptr = RSTRUCT_PTR(obj);
- for (i=0; i<len; i++) {
- slot = ptr_members[i];
- if (rb_id_attrset(SYM2ID(slot)) == rb_frame_this_func()) {
- return ptr[i] = val;
- }
+ nstr = rb_class_new(klass);
+ rb_make_metaclass(nstr, RBASIC(klass)->klass);
+ rb_class_inherited(klass, nstr);
+ return nstr;
+}
+
+static VALUE
+new_struct(VALUE name, VALUE super)
+{
+ /* old style: should we warn? */
+ ID id;
+ name = rb_str_to_str(name);
+ if (!rb_is_const_name(name)) {
+ rb_name_err_raise("identifier %1$s needs to be constant",
+ super, name);
+ }
+ id = rb_to_id(name);
+ if (rb_const_defined_at(super, id)) {
+ rb_warn("redefining constant %"PRIsVALUE"::%"PRIsVALUE, super, name);
+ rb_mod_remove_const(super, ID2SYM(id));
}
- rb_name_error(rb_frame_this_func(), "`%s' is not a struct member",
- rb_id2name(rb_frame_this_func()));
+ return rb_define_class_id_under(super, id, super);
+}
+
+NORETURN(static void invalid_struct_pos(VALUE s, VALUE idx));
+
+static void
+define_aref_method(VALUE nstr, VALUE name, VALUE off)
+{
+ rb_add_method_optimized(nstr, SYM2ID(name), OPTIMIZED_METHOD_TYPE_STRUCT_AREF, FIX2UINT(off), METHOD_VISI_PUBLIC);
+}
- UNREACHABLE;
+static void
+define_aset_method(VALUE nstr, VALUE name, VALUE off)
+{
+ rb_add_method_optimized(nstr, SYM2ID(name), OPTIMIZED_METHOD_TYPE_STRUCT_ASET, FIX2UINT(off), METHOD_VISI_PUBLIC);
}
static VALUE
-make_struct(VALUE name, VALUE members, VALUE klass)
+rb_struct_s_inspect(VALUE klass)
+{
+ VALUE inspect = rb_class_name(klass);
+ if (RTEST(rb_struct_s_keyword_init(klass))) {
+ rb_str_cat_cstr(inspect, "(keyword_init: true)");
+ }
+ return inspect;
+}
+
+#if 0 /* for RDoc */
+
+/*
+ * call-seq:
+ * StructClass::keyword_init? -> true or falsy value
+ *
+ * Returns +true+ if the class was initialized with <tt>keyword_init: true</tt>.
+ * Otherwise returns +nil+ or +false+.
+ *
+ * Examples:
+ * Foo = Struct.new(:a)
+ * Foo.keyword_init? # => nil
+ * Bar = Struct.new(:a, keyword_init: true)
+ * Bar.keyword_init? # => true
+ * Baz = Struct.new(:a, keyword_init: false)
+ * Baz.keyword_init? # => false
+ */
+static VALUE
+rb_struct_s_keyword_init_p(VALUE obj)
+{
+}
+#endif
+
+#define rb_struct_s_keyword_init_p rb_struct_s_keyword_init
+
+static VALUE
+setup_struct(VALUE nstr, VALUE members)
{
- VALUE nstr, *ptr_members;
- ID id;
long i, len;
- OBJ_FREEZE(members);
- if (NIL_P(name)) {
- nstr = rb_class_new(klass);
- rb_make_metaclass(nstr, RBASIC(klass)->klass);
- rb_class_inherited(klass, nstr);
- }
- else {
- /* old style: should we warn? */
- name = rb_str_to_str(name);
- id = rb_to_id(name);
- if (!rb_is_const_id(id)) {
- rb_name_error(id, "identifier %s needs to be constant", StringValuePtr(name));
- }
- if (rb_const_defined_at(klass, id)) {
- rb_warn("redefining constant Struct::%s", StringValuePtr(name));
- rb_mod_remove_const(klass, ID2SYM(id));
- }
- nstr = rb_define_class_id_under(klass, id, klass);
- }
- rb_ivar_set(nstr, id_members, members);
+ members = struct_set_members(nstr, members);
rb_define_alloc_func(nstr, struct_alloc);
- rb_define_singleton_method(nstr, "new", rb_class_new_instance, -1);
- rb_define_singleton_method(nstr, "[]", rb_class_new_instance, -1);
+ rb_define_singleton_method(nstr, "new", rb_class_new_instance_pass_kw, -1);
+ rb_define_singleton_method(nstr, "[]", rb_class_new_instance_pass_kw, -1);
rb_define_singleton_method(nstr, "members", rb_struct_s_members_m, 0);
- ptr_members = RARRAY_PTR(members);
+ rb_define_singleton_method(nstr, "inspect", rb_struct_s_inspect, 0);
+ rb_define_singleton_method(nstr, "keyword_init?", rb_struct_s_keyword_init_p, 0);
+
len = RARRAY_LEN(members);
for (i=0; i< len; i++) {
- ID id = SYM2ID(ptr_members[i]);
- if (rb_is_local_id(id) || rb_is_const_id(id)) {
- if (i < N_REF_FUNC) {
- rb_define_method_id(nstr, id, ref_func[i], 0);
- }
- else {
- rb_define_method_id(nstr, id, rb_struct_ref, 0);
- }
- rb_define_method_id(nstr, rb_id_attrset(id), rb_struct_set, 1);
- }
+ VALUE sym = RARRAY_AREF(members, i);
+ ID id = SYM2ID(sym);
+ VALUE off = LONG2NUM(i);
+
+ define_aref_method(nstr, sym, off);
+ define_aset_method(nstr, ID2SYM(rb_id_attrset(id)), off);
}
return nstr;
@@ -227,116 +354,282 @@ rb_struct_alloc_noinit(VALUE klass)
return struct_alloc(klass);
}
-VALUE
-rb_struct_define_without_accessor(const char *class_name, VALUE super, rb_alloc_func_t alloc, ...)
+static VALUE
+struct_make_members_list(va_list ar)
{
- VALUE klass;
- va_list ar;
- VALUE members;
- char *name;
+ char *mem;
+ VALUE ary, list = rb_ident_hash_new();
+ st_table *tbl = RHASH_TBL_RAW(list);
- members = rb_ary_new2(0);
- va_start(ar, alloc);
- while ((name = va_arg(ar, char*)) != NULL) {
- rb_ary_push(members, ID2SYM(rb_intern(name)));
+ RBASIC_CLEAR_CLASS(list);
+ OBJ_WB_UNPROTECT(list);
+ while ((mem = va_arg(ar, char*)) != 0) {
+ VALUE sym = rb_sym_intern_ascii_cstr(mem);
+ if (st_insert(tbl, sym, Qtrue)) {
+ rb_raise(rb_eArgError, "duplicate member: %s", mem);
+ }
}
- va_end(ar);
- OBJ_FREEZE(members);
+ ary = rb_hash_keys(list);
+ st_clear(tbl);
+ RBASIC_CLEAR_CLASS(ary);
+ OBJ_FREEZE_RAW(ary);
+ return ary;
+}
+
+static VALUE
+struct_define_without_accessor(VALUE outer, const char *class_name, VALUE super, rb_alloc_func_t alloc, VALUE members)
+{
+ VALUE klass;
if (class_name) {
- klass = rb_define_class(class_name, super);
+ if (outer) {
+ klass = rb_define_class_under(outer, class_name, super);
+ }
+ else {
+ klass = rb_define_class(class_name, super);
+ }
}
else {
- klass = rb_class_new(super);
- rb_make_metaclass(klass, RBASIC(super)->klass);
- rb_class_inherited(super, klass);
+ klass = anonymous_struct(super);
}
- rb_ivar_set(klass, id_members, members);
+ struct_set_members(klass, members);
- if (alloc)
- rb_define_alloc_func(klass, alloc);
- else
- rb_define_alloc_func(klass, struct_alloc);
+ if (alloc) {
+ rb_define_alloc_func(klass, alloc);
+ }
+ else {
+ rb_define_alloc_func(klass, struct_alloc);
+ }
return klass;
}
VALUE
+rb_struct_define_without_accessor_under(VALUE outer, const char *class_name, VALUE super, rb_alloc_func_t alloc, ...)
+{
+ va_list ar;
+ VALUE members;
+
+ va_start(ar, alloc);
+ members = struct_make_members_list(ar);
+ va_end(ar);
+
+ return struct_define_without_accessor(outer, class_name, super, alloc, members);
+}
+
+VALUE
+rb_struct_define_without_accessor(const char *class_name, VALUE super, rb_alloc_func_t alloc, ...)
+{
+ va_list ar;
+ VALUE members;
+
+ va_start(ar, alloc);
+ members = struct_make_members_list(ar);
+ va_end(ar);
+
+ return struct_define_without_accessor(0, class_name, super, alloc, members);
+}
+
+VALUE
rb_struct_define(const char *name, ...)
{
va_list ar;
- VALUE nm, ary;
- char *mem;
+ VALUE st, ary;
- if (!name) nm = Qnil;
- else nm = rb_str_new2(name);
- ary = rb_ary_new();
+ va_start(ar, name);
+ ary = struct_make_members_list(ar);
+ va_end(ar);
+
+ if (!name) st = anonymous_struct(rb_cStruct);
+ else st = new_struct(rb_str_new2(name), rb_cStruct);
+ return setup_struct(st, ary);
+}
+
+VALUE
+rb_struct_define_under(VALUE outer, const char *name, ...)
+{
+ va_list ar;
+ VALUE ary;
va_start(ar, name);
- while ((mem = va_arg(ar, char*)) != 0) {
- ID slot = rb_intern(mem);
- rb_ary_push(ary, ID2SYM(slot));
- }
+ ary = struct_make_members_list(ar);
va_end(ar);
- return make_struct(nm, ary, rb_cStruct);
+ return setup_struct(rb_define_class_under(outer, name, rb_cStruct), ary);
}
/*
* call-seq:
- * Struct.new( [aString] [, aSym]+> ) -> StructClass
- * StructClass.new(arg, ...) -> obj
- * StructClass[arg, ...] -> obj
- *
- * Creates a new class, named by <i>aString</i>, containing accessor
- * methods for the given symbols. If the name <i>aString</i> is
- * omitted, an anonymous structure class will be created. Otherwise,
- * the name of this struct will appear as a constant in class
- * <code>Struct</code>, so it must be unique for all
- * <code>Struct</code>s in the system and should start with a capital
- * letter. Assigning a structure class to a constant effectively gives
- * the class the name of the constant.
- *
- * <code>Struct::new</code> returns a new <code>Class</code> object,
- * which can then be used to create specific instances of the new
- * structure. The number of actual parameters must be
- * less than or equal to the number of attributes defined for this
- * class; unset parameters default to <code>nil</code>. Passing too many
- * parameters will raise an <code>ArgumentError</code>.
- *
- * The remaining methods listed in this section (class and instance)
- * are defined for this generated class.
- *
- * # Create a structure with a name in Struct
- * Struct.new("Customer", :name, :address) #=> Struct::Customer
- * Struct::Customer.new("Dave", "123 Main") #=> #<struct Struct::Customer name="Dave", address="123 Main">
- *
- * # Create a structure named by its constant
- * Customer = Struct.new(:name, :address) #=> Customer
- * Customer.new("Dave", "123 Main") #=> #<struct Customer name="Dave", address="123 Main">
+ * Struct.new(*member_names, keyword_init: false){|Struct_subclass| ... } -> Struct_subclass
+ * Struct.new(class_name, *member_names, keyword_init: false){|Struct_subclass| ... } -> Struct_subclass
+ * Struct_subclass.new(*member_names) -> Struct_subclass_instance
+ * Struct_subclass.new(**member_names) -> Struct_subclass_instance
+ *
+ * <tt>Struct.new</tt> returns a new subclass of +Struct+. The new subclass:
+ *
+ * - May be anonymous, or may have the name given by +class_name+.
+ * - May have members as given by +member_names+.
+ * - May have initialization via ordinary arguments (the default)
+ * or via keyword arguments (if <tt>keyword_init: true</tt> is given).
+ *
+ * The new subclass has its own method <tt>::new</tt>; thus:
+ *
+ * Foo = Struct.new('Foo', :foo, :bar) # => Struct::Foo
+ * f = Foo.new(0, 1) # => #<struct Struct::Foo foo=0, bar=1>
+ *
+ * <b>\Class Name</b>
+ *
+ * With string argument +class_name+,
+ * returns a new subclass of +Struct+ named <tt>Struct::<em>class_name</em></tt>:
+ *
+ * Foo = Struct.new('Foo', :foo, :bar) # => Struct::Foo
+ * Foo.name # => "Struct::Foo"
+ * Foo.superclass # => Struct
+ *
+ * Without string argument +class_name+,
+ * returns a new anonymous subclass of +Struct+:
+ *
+ * Struct.new(:foo, :bar).name # => nil
+ *
+ * <b>Block</b>
+ *
+ * With a block given, the created subclass is yielded to the block:
+ *
+ * Customer = Struct.new('Customer', :name, :address) do |new_class|
+ * p "The new subclass is #{new_class}"
+ * def greeting
+ * "Hello #{name} at #{address}"
+ * end
+ * end # => Struct::Customer
+ * dave = Customer.new('Dave', '123 Main')
+ * dave # => #<struct Struct::Customer name="Dave", address="123 Main">
+ * dave.greeting # => "Hello Dave at 123 Main"
+ *
+ * Output, from <tt>Struct.new</tt>:
+ *
+ * "The new subclass is Struct::Customer"
+ *
+ * <b>Member Names</b>
+ *
+ * \Symbol arguments +member_names+
+ * determines the members of the new subclass:
+ *
+ * Struct.new(:foo, :bar).members # => [:foo, :bar]
+ * Struct.new('Foo', :foo, :bar).members # => [:foo, :bar]
+ *
+ * The new subclass has instance methods corresponding to +member_names+:
+ *
+ * Foo = Struct.new('Foo', :foo, :bar)
+ * Foo.instance_methods(false) # => [:foo, :bar, :foo=, :bar=]
+ * f = Foo.new # => #<struct Struct::Foo foo=nil, bar=nil>
+ * f.foo # => nil
+ * f.foo = 0 # => 0
+ * f.bar # => nil
+ * f.bar = 1 # => 1
+ * f # => #<struct Struct::Foo foo=0, bar=1>
+ *
+ * <b>Singleton Methods</b>
+ *
+ * A subclass returned by Struct.new has these singleton methods:
+ *
+ * - \Method <tt>::new </tt> creates an instance of the subclass:
+ *
+ * Foo.new # => #<struct Struct::Foo foo=nil, bar=nil>
+ * Foo.new(0) # => #<struct Struct::Foo foo=0, bar=nil>
+ * Foo.new(0, 1) # => #<struct Struct::Foo foo=0, bar=1>
+ * Foo.new(0, 1, 2) # Raises ArgumentError: struct size differs
+ *
+ * \Method <tt>::[]</tt> is an alias for method <tt>::new</tt>.
+ *
+ * - \Method <tt>:inspect</tt> returns a string representation of the subclass:
+ *
+ * Foo.inspect
+ * # => "Struct::Foo"
+ *
+ * - \Method <tt>::members</tt> returns an array of the member names:
+ *
+ * Foo.members # => [:foo, :bar]
+ *
+ * <b>Keyword Argument</b>
+ *
+ * By default, the arguments for initializing an instance of the new subclass
+ * are ordinary arguments (not keyword arguments).
+ * With optional keyword argument <tt>keyword_init: true</tt>,
+ * the new subclass is initialized with keyword arguments:
+ *
+ * # Without keyword_init: true.
+ * Foo = Struct.new('Foo', :foo, :bar)
+ * Foo # => Struct::Foo
+ * Foo.new(0, 1) # => #<struct Struct::Foo foo=0, bar=1>
+ * # With keyword_init: true.
+ * Bar = Struct.new(:foo, :bar, keyword_init: true)
+ * Bar # => # => Bar(keyword_init: true)
+ * Bar.new(bar: 1, foo: 0) # => #<struct Bar foo=0, bar=1>
+ *
*/
static VALUE
rb_struct_s_def(int argc, VALUE *argv, VALUE klass)
{
- VALUE name, rest;
+ VALUE name, rest, keyword_init = Qnil;
long i;
VALUE st;
- ID id;
+ st_table *tbl;
- rb_scan_args(argc, argv, "1*", &name, &rest);
- if (!NIL_P(name) && SYMBOL_P(name)) {
- rb_ary_unshift(rest, name);
+ rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS);
+ name = argv[0];
+ if (SYMBOL_P(name)) {
name = Qnil;
}
- for (i=0; i<RARRAY_LEN(rest); i++) {
- id = rb_to_id(RARRAY_PTR(rest)[i]);
- RARRAY_PTR(rest)[i] = ID2SYM(id);
+ else {
+ --argc;
+ ++argv;
+ }
+
+ if (RB_TYPE_P(argv[argc-1], T_HASH)) {
+ static ID keyword_ids[1];
+
+ if (!keyword_ids[0]) {
+ keyword_ids[0] = rb_intern("keyword_init");
+ }
+ rb_get_kwargs(argv[argc-1], keyword_ids, 0, 1, &keyword_init);
+ if (keyword_init == Qundef) {
+ keyword_init = Qnil;
+ }
+ else if (RTEST(keyword_init)) {
+ keyword_init = Qtrue;
+ }
+ --argc;
+ }
+
+ rest = rb_ident_hash_new();
+ RBASIC_CLEAR_CLASS(rest);
+ OBJ_WB_UNPROTECT(rest);
+ tbl = RHASH_TBL_RAW(rest);
+ for (i=0; i<argc; i++) {
+ VALUE mem = rb_to_symbol(argv[i]);
+ if (rb_is_attrset_sym(mem)) {
+ rb_raise(rb_eArgError, "invalid struct member: %"PRIsVALUE, mem);
+ }
+ if (st_insert(tbl, mem, Qtrue)) {
+ rb_raise(rb_eArgError, "duplicate member: %"PRIsVALUE, mem);
+ }
+ }
+ rest = rb_hash_keys(rest);
+ st_clear(tbl);
+ RBASIC_CLEAR_CLASS(rest);
+ OBJ_FREEZE_RAW(rest);
+ if (NIL_P(name)) {
+ st = anonymous_struct(klass);
}
- st = make_struct(name, rest, klass);
+ else {
+ st = new_struct(name, klass);
+ }
+ setup_struct(st, rest);
+ rb_ivar_set(st, id_keyword_init, keyword_init);
if (rb_block_given_p()) {
- rb_mod_module_eval(0, 0, st);
+ rb_mod_module_eval(0, 0, st);
}
return st;
@@ -356,20 +649,71 @@ num_members(VALUE klass)
/*
*/
+struct struct_hash_set_arg {
+ VALUE self;
+ VALUE unknown_keywords;
+};
+
+static int rb_struct_pos(VALUE s, VALUE *name);
+
+static int
+struct_hash_set_i(VALUE key, VALUE val, VALUE arg)
+{
+ struct struct_hash_set_arg *args = (struct struct_hash_set_arg *)arg;
+ int i = rb_struct_pos(args->self, &key);
+ if (i < 0) {
+ if (NIL_P(args->unknown_keywords)) {
+ args->unknown_keywords = rb_ary_new();
+ }
+ rb_ary_push(args->unknown_keywords, key);
+ }
+ else {
+ rb_struct_modify(args->self);
+ RSTRUCT_SET(args->self, i, val);
+ }
+ return ST_CONTINUE;
+}
+
static VALUE
-rb_struct_initialize_m(int argc, VALUE *argv, VALUE self)
+rb_struct_initialize_m(int argc, const VALUE *argv, VALUE self)
{
VALUE klass = rb_obj_class(self);
- long n;
-
rb_struct_modify(self);
- n = num_members(klass);
- if (n < argc) {
- rb_raise(rb_eArgError, "struct size differs");
+ long n = num_members(klass);
+ if (argc == 0) {
+ rb_mem_clear((VALUE *)RSTRUCT_CONST_PTR(self), n);
+ return Qnil;
}
- MEMCPY(RSTRUCT_PTR(self), argv, VALUE, argc);
- if (n > argc) {
- rb_mem_clear(RSTRUCT_PTR(self)+argc, n-argc);
+
+ VALUE keyword_init = rb_struct_s_keyword_init(klass);
+ if (RTEST(keyword_init)) {
+ struct struct_hash_set_arg arg;
+ if (argc > 1 || !RB_TYPE_P(argv[0], T_HASH)) {
+ rb_raise(rb_eArgError, "wrong number of arguments (given %d, expected 0)", argc);
+ }
+ rb_mem_clear((VALUE *)RSTRUCT_CONST_PTR(self), n);
+ arg.self = self;
+ arg.unknown_keywords = Qnil;
+ rb_hash_foreach(argv[0], struct_hash_set_i, (VALUE)&arg);
+ if (arg.unknown_keywords != Qnil) {
+ rb_raise(rb_eArgError, "unknown keywords: %s",
+ RSTRING_PTR(rb_ary_join(arg.unknown_keywords, rb_str_new2(", "))));
+ }
+ }
+ else {
+ if (n < argc) {
+ rb_raise(rb_eArgError, "struct size differs");
+ }
+ if (NIL_P(keyword_init) && argc == 1 && RB_TYPE_P(argv[0], T_HASH) && rb_keyword_given_p()) {
+ rb_warn("Passing only keyword arguments to Struct#initialize will behave differently from Ruby 3.2. "\
+ "Please use a Hash literal like .new({k: v}) instead of .new(k: v).");
+ }
+ for (long i=0; i<argc; i++) {
+ RSTRUCT_SET(self, i, argv[i]);
+ }
+ if (n > argc) {
+ rb_mem_clear((VALUE *)RSTRUCT_CONST_PTR(self)+argc, n-argc);
+ }
}
return Qnil;
}
@@ -377,26 +721,65 @@ rb_struct_initialize_m(int argc, VALUE *argv, VALUE self)
VALUE
rb_struct_initialize(VALUE self, VALUE values)
{
- return rb_struct_initialize_m(RARRAY_LENINT(values), RARRAY_PTR(values), self);
+ rb_struct_initialize_m(RARRAY_LENINT(values), RARRAY_CONST_PTR(values), self);
+ RB_GC_GUARD(values);
+ return Qnil;
+}
+
+static VALUE *
+struct_heap_alloc(VALUE st, size_t len)
+{
+ VALUE *ptr = rb_transient_heap_alloc((VALUE)st, sizeof(VALUE) * len);
+
+ if (ptr) {
+ RSTRUCT_TRANSIENT_SET(st);
+ return ptr;
+ }
+ else {
+ RSTRUCT_TRANSIENT_UNSET(st);
+ return ALLOC_N(VALUE, len);
+ }
+}
+
+#if USE_TRANSIENT_HEAP
+void
+rb_struct_transient_heap_evacuate(VALUE obj, int promote)
+{
+ if (RSTRUCT_TRANSIENT_P(obj)) {
+ const VALUE *old_ptr = rb_struct_const_heap_ptr(obj);
+ VALUE *new_ptr;
+ long len = RSTRUCT_LEN(obj);
+
+ if (promote) {
+ new_ptr = ALLOC_N(VALUE, len);
+ FL_UNSET_RAW(obj, RSTRUCT_TRANSIENT_FLAG);
+ }
+ else {
+ new_ptr = struct_heap_alloc(obj, len);
+ }
+ MEMCPY(new_ptr, old_ptr, VALUE, len);
+ RSTRUCT(obj)->as.heap.ptr = new_ptr;
+ }
}
+#endif
static VALUE
struct_alloc(VALUE klass)
{
long n;
- NEWOBJ_OF(st, struct RStruct, klass, T_STRUCT);
+ NEWOBJ_OF(st, struct RStruct, klass, T_STRUCT | (RGENGC_WB_PROTECTED_STRUCT ? FL_WB_PROTECTED : 0));
n = num_members(klass);
if (0 < n && n <= RSTRUCT_EMBED_LEN_MAX) {
RBASIC(st)->flags &= ~RSTRUCT_EMBED_LEN_MASK;
RBASIC(st)->flags |= n << RSTRUCT_EMBED_LEN_SHIFT;
- rb_mem_clear(st->as.ary, n);
+ rb_mem_clear((VALUE *)st->as.ary, n);
}
else {
- st->as.heap.ptr = ALLOC_N(VALUE, n);
- rb_mem_clear(st->as.heap.ptr, n);
- st->as.heap.len = n;
+ st->as.heap.ptr = struct_heap_alloc((VALUE)st, n);
+ rb_mem_clear((VALUE *)st->as.heap.ptr, n);
+ st->as.heap.len = n;
}
return (VALUE)st;
@@ -405,13 +788,13 @@ struct_alloc(VALUE klass)
VALUE
rb_struct_alloc(VALUE klass, VALUE values)
{
- return rb_class_new_instance(RARRAY_LENINT(values), RARRAY_PTR(values), klass);
+ return rb_class_new_instance(RARRAY_LENINT(values), RARRAY_CONST_PTR(values), klass);
}
VALUE
rb_struct_new(VALUE klass, ...)
{
- VALUE tmpargs[N_REF_FUNC], *mem = tmpargs;
+ VALUE tmpargs[16], *mem = tmpargs;
int size, i;
va_list args;
@@ -429,25 +812,32 @@ rb_struct_new(VALUE klass, ...)
return rb_class_new_instance(size, mem, klass);
}
+static VALUE
+struct_enum_size(VALUE s, VALUE args, VALUE eobj)
+{
+ return rb_struct_size(s);
+}
+
/*
* call-seq:
- * struct.each {|obj| block } -> struct
- * struct.each -> an_enumerator
+ * each {|value| ... } -> self
+ * each -> enumerator
*
- * Calls <i>block</i> once for each instance variable, passing the
- * value as a parameter.
+ * Calls the given block with the value of each member; returns +self+:
*
- * If no block is given, an enumerator is returned instead.
+ * Customer = Struct.new(:name, :address, :zip)
+ * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * joe.each {|value| p value }
*
- * Customer = Struct.new(:name, :address, :zip)
- * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
- * joe.each {|x| puts(x) }
+ * Output:
*
- * <em>produces:</em>
+ * "Joe Smith"
+ * "123 Maple, Anytown NC"
+ * 12345
*
- * Joe Smith
- * 123 Maple, Anytown NC
- * 12345
+ * Returns an Enumerator if no block is given.
+ *
+ * Related: #each_pair.
*/
static VALUE
@@ -455,32 +845,34 @@ rb_struct_each(VALUE s)
{
long i;
- RETURN_ENUMERATOR(s, 0, 0);
+ RETURN_SIZED_ENUMERATOR(s, 0, 0, struct_enum_size);
for (i=0; i<RSTRUCT_LEN(s); i++) {
- rb_yield(RSTRUCT_PTR(s)[i]);
+ rb_yield(RSTRUCT_GET(s, i));
}
return s;
}
/*
* call-seq:
- * struct.each_pair {|sym, obj| block } -> struct
- * struct.each_pair -> an_enumerator
+ * each_pair {|(name, value)| ... } -> self
+ * each_pair -> enumerator
*
- * Calls <i>block</i> once for each instance variable, passing the name
- * (as a symbol) and the value as parameters.
+ * Calls the given block with each member name/value pair; returns +self+:
*
- * If no block is given, an enumerator is returned instead.
+ * Customer = Struct.new(:name, :address, :zip) # => Customer
+ * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * joe.each_pair {|(name, value)| p "#{name} => #{value}" }
*
- * Customer = Struct.new(:name, :address, :zip)
- * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
- * joe.each_pair {|name, value| puts("#{name} => #{value}") }
+ * Output:
*
- * <em>produces:</em>
+ * "name => Joe Smith"
+ * "address => 123 Maple, Anytown NC"
+ * "zip => 12345"
+ *
+ * Returns an Enumerator if no block is given.
+ *
+ * Related: #each.
*
- * name => Joe Smith
- * address => 123 Maple, Anytown NC
- * zip => 12345
*/
static VALUE
@@ -489,10 +881,21 @@ rb_struct_each_pair(VALUE s)
VALUE members;
long i;
- RETURN_ENUMERATOR(s, 0, 0);
+ RETURN_SIZED_ENUMERATOR(s, 0, 0, struct_enum_size);
members = rb_struct_members(s);
- for (i=0; i<RSTRUCT_LEN(s); i++) {
- rb_yield_values(2, rb_ary_entry(members, i), RSTRUCT_PTR(s)[i]);
+ if (rb_block_pair_yield_optimizable()) {
+ for (i=0; i<RSTRUCT_LEN(s); i++) {
+ VALUE key = rb_ary_entry(members, i);
+ VALUE value = RSTRUCT_GET(s, i);
+ rb_yield_values(2, key, value);
+ }
+ }
+ else {
+ for (i=0; i<RSTRUCT_LEN(s); i++) {
+ VALUE key = rb_ary_entry(members, i);
+ VALUE value = RSTRUCT_GET(s, i);
+ rb_yield(rb_assoc_new(key, value));
+ }
}
return s;
}
@@ -500,9 +903,8 @@ rb_struct_each_pair(VALUE s)
static VALUE
inspect_struct(VALUE s, VALUE dummy, int recur)
{
- VALUE cname = rb_class_name(rb_obj_class(s));
+ VALUE cname = rb_class_path(rb_obj_class(s));
VALUE members, str = rb_str_new2("#<struct ");
- VALUE *ptr, *ptr_members;
long i, len;
char first = RSTRING_PTR(cname)[0];
@@ -514,9 +916,8 @@ inspect_struct(VALUE s, VALUE dummy, int recur)
}
members = rb_struct_members(s);
- ptr_members = RARRAY_PTR(members);
- ptr = RSTRUCT_PTR(s);
len = RSTRUCT_LEN(s);
+
for (i=0; i<len; i++) {
VALUE slot;
ID id;
@@ -527,7 +928,7 @@ inspect_struct(VALUE s, VALUE dummy, int recur)
else if (first != '#') {
rb_str_cat2(str, " ");
}
- slot = ptr_members[i];
+ slot = RARRAY_AREF(members, i);
id = SYM2ID(slot);
if (rb_is_local_id(id) || rb_is_const_id(id)) {
rb_str_append(str, rb_id2str(id));
@@ -536,20 +937,25 @@ inspect_struct(VALUE s, VALUE dummy, int recur)
rb_str_append(str, rb_inspect(slot));
}
rb_str_cat2(str, "=");
- rb_str_append(str, rb_inspect(ptr[i]));
+ rb_str_append(str, rb_inspect(RSTRUCT_GET(s, i)));
}
rb_str_cat2(str, ">");
- OBJ_INFECT(str, s);
return str;
}
/*
- * call-seq:
- * struct.to_s -> string
- * struct.inspect -> string
+ * call-seq:
+ * inspect -> string
+ *
+ * Returns a string representation of +self+:
+ *
+ * Customer = Struct.new(:name, :address, :zip) # => Customer
+ * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * joe.inspect # => "#<struct Customer name=\"Joe Smith\", address=\"123 Maple, Anytown NC\", zip=12345>"
+ *
+ * Struct#to_s is an alias for Struct#inspect.
*
- * Describe the contents of this struct in a string.
*/
static VALUE
@@ -560,43 +966,109 @@ rb_struct_inspect(VALUE s)
/*
* call-seq:
- * struct.to_a -> array
- * struct.values -> array
+ * to_a -> array
*
- * Returns the values for this instance as an array.
+ * Returns the values in +self+ as an array:
*
- * Customer = Struct.new(:name, :address, :zip)
- * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
- * joe.to_a[1] #=> "123 Maple, Anytown NC"
+ * Customer = Struct.new(:name, :address, :zip)
+ * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * joe.to_a # => ["Joe Smith", "123 Maple, Anytown NC", 12345]
+ *
+ * Struct#values and Struct#deconstruct are aliases for Struct#to_a.
+ *
+ * Related: #members.
*/
static VALUE
rb_struct_to_a(VALUE s)
{
- return rb_ary_new4(RSTRUCT_LEN(s), RSTRUCT_PTR(s));
+ return rb_ary_new4(RSTRUCT_LEN(s), RSTRUCT_CONST_PTR(s));
}
/*
* call-seq:
- * struct.to_h -> hash
+ * to_h -> hash
+ * to_h {|name, value| ... } -> hash
*
- * Returns the values for this instance as a hash with keys
- * corresponding to the instance variable name.
+ * Returns a hash containing the name and value for each member:
+ *
+ * Customer = Struct.new(:name, :address, :zip)
+ * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * h = joe.to_h
+ * h # => {:name=>"Joe Smith", :address=>"123 Maple, Anytown NC", :zip=>12345}
+ *
+ * If a block is given, it is called with each name/value pair;
+ * the block should return a 2-element array whose elements will become
+ * a key/value pair in the returned hash:
+ *
+ * h = joe.to_h{|name, value| [name.upcase, value.to_s.upcase]}
+ * h # => {:NAME=>"JOE SMITH", :ADDRESS=>"123 MAPLE, ANYTOWN NC", :ZIP=>"12345"}
+ *
+ * Raises ArgumentError if the block returns an inappropriate value.
*
- * Customer = Struct.new(:name, :address, :zip)
- * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
- * joe.to_h[:address] #=> "123 Maple, Anytown NC"
*/
static VALUE
rb_struct_to_h(VALUE s)
{
- VALUE h = rb_hash_new();
+ VALUE h = rb_hash_new_with_size(RSTRUCT_LEN(s));
VALUE members = rb_struct_members(s);
long i;
+ int block_given = rb_block_given_p();
for (i=0; i<RSTRUCT_LEN(s); i++) {
- rb_hash_aset(h, rb_ary_entry(members, i), RSTRUCT_PTR(s)[i]);
+ VALUE k = rb_ary_entry(members, i), v = RSTRUCT_GET(s, i);
+ if (block_given)
+ rb_hash_set_pair(h, rb_yield_values(2, k, v));
+ else
+ rb_hash_aset(h, k, v);
+ }
+ return h;
+}
+
+/*
+ * call-seq:
+ * deconstruct_keys(array_of_names) -> hash
+ *
+ * Returns a hash of the name/value pairs for the given member names.
+ *
+ * Customer = Struct.new(:name, :address, :zip)
+ * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * h = joe.deconstruct_keys([:zip, :address])
+ * h # => {:zip=>12345, :address=>"123 Maple, Anytown NC"}
+ *
+ * Returns all names and values if +array_of_names+ is +nil+:
+ *
+ * h = joe.deconstruct_keys(nil)
+ * h # => {:name=>"Joseph Smith, Jr.", :address=>"123 Maple, Anytown NC", :zip=>12345}
+ *
+ */
+static VALUE
+rb_struct_deconstruct_keys(VALUE s, VALUE keys)
+{
+ VALUE h;
+ long i;
+
+ if (NIL_P(keys)) {
+ return rb_struct_to_h(s);
+ }
+ if (UNLIKELY(!RB_TYPE_P(keys, T_ARRAY))) {
+ rb_raise(rb_eTypeError,
+ "wrong argument type %"PRIsVALUE" (expected Array or nil)",
+ rb_obj_class(keys));
+
+ }
+ if (RSTRUCT_LEN(s) < RARRAY_LEN(keys)) {
+ return rb_hash_new_with_size(0);
+ }
+ h = rb_hash_new_with_size(RARRAY_LEN(keys));
+ for (i=0; i<RARRAY_LEN(keys); i++) {
+ VALUE key = RARRAY_AREF(keys, i);
+ int i = rb_struct_pos(s, &key);
+ if (i < 0) {
+ return h;
+ }
+ rb_hash_aset(h, key, RSTRUCT_GET(s, i));
}
return h;
}
@@ -605,142 +1077,161 @@ rb_struct_to_h(VALUE s)
VALUE
rb_struct_init_copy(VALUE copy, VALUE s)
{
+ long i, len;
+
if (!OBJ_INIT_COPY(copy, s)) return copy;
if (RSTRUCT_LEN(copy) != RSTRUCT_LEN(s)) {
rb_raise(rb_eTypeError, "struct size mismatch");
}
- MEMCPY(RSTRUCT_PTR(copy), RSTRUCT_PTR(s), VALUE, RSTRUCT_LEN(copy));
+
+ for (i=0, len=RSTRUCT_LEN(copy); i<len; i++) {
+ RSTRUCT_SET(copy, i, RSTRUCT_GET(s, i));
+ }
return copy;
}
-static VALUE
-rb_struct_aref_id(VALUE s, ID id)
+static int
+rb_struct_pos(VALUE s, VALUE *name)
{
- VALUE *ptr, members, *ptr_members;
- long i, len;
+ long i;
+ VALUE idx = *name;
- ptr = RSTRUCT_PTR(s);
- members = rb_struct_members(s);
- ptr_members = RARRAY_PTR(members);
- len = RARRAY_LEN(members);
- for (i=0; i<len; i++) {
- if (SYM2ID(ptr_members[i]) == id) {
- return ptr[i];
+ if (SYMBOL_P(idx)) {
+ return struct_member_pos(s, idx);
+ }
+ else if (RB_TYPE_P(idx, T_STRING)) {
+ idx = rb_check_symbol(name);
+ if (NIL_P(idx)) return -1;
+ return struct_member_pos(s, idx);
+ }
+ else {
+ long len;
+ i = NUM2LONG(idx);
+ len = RSTRUCT_LEN(s);
+ if (i < 0) {
+ if (i + len < 0) {
+ *name = LONG2FIX(i);
+ return -1;
+ }
+ i += len;
+ }
+ else if (len <= i) {
+ *name = LONG2FIX(i);
+ return -1;
}
+ return (int)i;
}
- rb_name_error(id, "no member '%s' in struct", rb_id2name(id));
+}
- UNREACHABLE;
+static void
+invalid_struct_pos(VALUE s, VALUE idx)
+{
+ if (FIXNUM_P(idx)) {
+ long i = FIX2INT(idx), len = RSTRUCT_LEN(s);
+ if (i < 0) {
+ rb_raise(rb_eIndexError, "offset %ld too small for struct(size:%ld)",
+ i, len);
+ }
+ else {
+ rb_raise(rb_eIndexError, "offset %ld too large for struct(size:%ld)",
+ i, len);
+ }
+ }
+ else {
+ rb_name_err_raise("no member '%1$s' in struct", s, idx);
+ }
}
/*
* call-seq:
- * struct[symbol] -> anObject
- * struct[fixnum] -> anObject
+ * struct[name] -> object
+ * struct[n] -> object
*
- * Attribute Reference---Returns the value of the instance variable
- * named by <i>symbol</i>, or indexed (0..length-1) by
- * <i>fixnum</i>. Will raise <code>NameError</code> if the named
- * variable does not exist, or <code>IndexError</code> if the index is
- * out of range.
+ * Returns a value from +self+.
*
- * Customer = Struct.new(:name, :address, :zip)
- * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * With symbol or string argument +name+ given, returns the value for the named member:
+ *
+ * Customer = Struct.new(:name, :address, :zip)
+ * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * joe[:zip] # => 12345
+ *
+ * Raises NameError if +name+ is not the name of a member.
+ *
+ * With integer argument +n+ given, returns <tt>self.values[n]</tt>
+ * if +n+ is in range;
+ * see {Array Indexes}[Array.html#class-Array-label-Array+Indexes]:
+ *
+ * joe[2] # => 12345
+ * joe[-2] # => "123 Maple, Anytown NC"
+ *
+ * Raises IndexError if +n+ is out of range.
*
- * joe["name"] #=> "Joe Smith"
- * joe[:name] #=> "Joe Smith"
- * joe[0] #=> "Joe Smith"
*/
VALUE
rb_struct_aref(VALUE s, VALUE idx)
{
- long i;
-
- if (RB_TYPE_P(idx, T_STRING) || RB_TYPE_P(idx, T_SYMBOL)) {
- return rb_struct_aref_id(s, rb_to_id(idx));
- }
-
- i = NUM2LONG(idx);
- if (i < 0) i = RSTRUCT_LEN(s) + i;
- if (i < 0)
- rb_raise(rb_eIndexError, "offset %ld too small for struct(size:%ld)",
- i, RSTRUCT_LEN(s));
- if (RSTRUCT_LEN(s) <= i)
- rb_raise(rb_eIndexError, "offset %ld too large for struct(size:%ld)",
- i, RSTRUCT_LEN(s));
- return RSTRUCT_PTR(s)[i];
-}
-
-static VALUE
-rb_struct_aset_id(VALUE s, ID id, VALUE val)
-{
- VALUE members, *ptr, *ptr_members;
- long i, len;
-
- members = rb_struct_members(s);
- len = RARRAY_LEN(members);
- rb_struct_modify(s);
- if (RSTRUCT_LEN(s) != len) {
- rb_raise(rb_eTypeError, "struct size differs (%ld required %ld given)",
- len, RSTRUCT_LEN(s));
- }
- ptr = RSTRUCT_PTR(s);
- ptr_members = RARRAY_PTR(members);
- for (i=0; i<len; i++) {
- if (SYM2ID(ptr_members[i]) == id) {
- ptr[i] = val;
- return val;
- }
- }
- rb_name_error(id, "no member '%s' in struct", rb_id2name(id));
-
- UNREACHABLE;
+ int i = rb_struct_pos(s, &idx);
+ if (i < 0) invalid_struct_pos(s, idx);
+ return RSTRUCT_GET(s, i);
}
/*
* call-seq:
- * struct[symbol] = obj -> obj
- * struct[fixnum] = obj -> obj
+ * struct[name] = value -> value
+ * struct[n] = value -> value
*
- * Attribute Assignment---Assigns to the instance variable named by
- * <i>symbol</i> or <i>fixnum</i> the value <i>obj</i> and
- * returns it. Will raise a <code>NameError</code> if the named
- * variable does not exist, or an <code>IndexError</code> if the index
- * is out of range.
+ * Assigns a value to a member.
*
- * Customer = Struct.new(:name, :address, :zip)
- * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * With symbol or string argument +name+ given, assigns the given +value+
+ * to the named member; returns +value+:
+ *
+ * Customer = Struct.new(:name, :address, :zip)
+ * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * joe[:zip] = 54321 # => 54321
+ * joe # => #<struct Customer name="Joe Smith", address="123 Maple, Anytown NC", zip=54321>
+ *
+ * Raises NameError if +name+ is not the name of a member.
*
- * joe["name"] = "Luke"
- * joe[:zip] = "90210"
+ * With integer argument +n+ given, assigns the given +value+
+ * to the +n+-th member if +n+ is in range;
+ * see {Array Indexes}[Array.html#class-Array-label-Array+Indexes]:
+ *
+ * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * joe[2] = 54321 # => 54321
+ * joe[-3] = 'Joseph Smith' # => "Joseph Smith"
+ * joe # => #<struct Customer name="Joseph Smith", address="123 Maple, Anytown NC", zip=54321>
+ *
+ * Raises IndexError if +n+ is out of range.
*
- * joe.name #=> "Luke"
- * joe.zip #=> "90210"
*/
VALUE
rb_struct_aset(VALUE s, VALUE idx, VALUE val)
{
- long i;
+ int i = rb_struct_pos(s, &idx);
+ if (i < 0) invalid_struct_pos(s, idx);
+ rb_struct_modify(s);
+ RSTRUCT_SET(s, i, val);
+ return val;
+}
- if (RB_TYPE_P(idx, T_STRING) || RB_TYPE_P(idx, T_SYMBOL)) {
- return rb_struct_aset_id(s, rb_to_id(idx), val);
- }
+FUNC_MINIMIZED(VALUE rb_struct_lookup(VALUE s, VALUE idx));
+NOINLINE(static VALUE rb_struct_lookup_default(VALUE s, VALUE idx, VALUE notfound));
- i = NUM2LONG(idx);
- if (i < 0) i = RSTRUCT_LEN(s) + i;
- if (i < 0) {
- rb_raise(rb_eIndexError, "offset %ld too small for struct(size:%ld)",
- i, RSTRUCT_LEN(s));
- }
- if (RSTRUCT_LEN(s) <= i) {
- rb_raise(rb_eIndexError, "offset %ld too large for struct(size:%ld)",
- i, RSTRUCT_LEN(s));
- }
- rb_struct_modify(s);
- return RSTRUCT_PTR(s)[i] = val;
+VALUE
+rb_struct_lookup(VALUE s, VALUE idx)
+{
+ return rb_struct_lookup_default(s, idx, Qnil);
+}
+
+static VALUE
+rb_struct_lookup_default(VALUE s, VALUE idx, VALUE notfound)
+{
+ int i = rb_struct_pos(s, &idx);
+ if (i < 0) return notfound;
+ return RSTRUCT_GET(s, i);
}
static VALUE
@@ -750,19 +1241,38 @@ struct_entry(VALUE s, long n)
}
/*
- * call-seq:
- * struct.values_at(selector,... ) -> an_array
- *
- * Returns an array containing the elements in
- * +self+ corresponding to the given selector(s). The selectors
- * may be either integer indices or ranges.
- * See also </code>.select<code>.
- *
- * a = %w{ a b c d e f }
- * a.values_at(1, 3, 5)
- * a.values_at(1, 3, 5, 7)
- * a.values_at(-1, -3, -5, -7)
- * a.values_at(1..3, 2...5)
+ * call-seq:
+ * values_at(*integers) -> array
+ * values_at(integer_range) -> array
+ *
+ * Returns an array of values from +self+.
+ *
+ * With integer arguments +integers+ given,
+ * returns an array containing each value given by one of +integers+:
+ *
+ * Customer = Struct.new(:name, :address, :zip)
+ * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * joe.values_at(0, 2) # => ["Joe Smith", 12345]
+ * joe.values_at(2, 0) # => [12345, "Joe Smith"]
+ * joe.values_at(2, 1, 0) # => [12345, "123 Maple, Anytown NC", "Joe Smith"]
+ * joe.values_at(0, -3) # => ["Joe Smith", "Joe Smith"]
+ *
+ * Raises IndexError if any of +integers+ is out of range;
+ * see {Array Indexes}[Array.html#class-Array-label-Array+Indexes].
+ *
+ * With integer range argument +integer_range+ given,
+ * returns an array containing each value given by the elements of the range;
+ * fills with +nil+ values for range elements larger than the structure:
+ *
+ * joe.values_at(0..2)
+ * # => ["Joe Smith", "123 Maple, Anytown NC", 12345]
+ * joe.values_at(-3..-1)
+ * # => ["Joe Smith", "123 Maple, Anytown NC", 12345]
+ * joe.values_at(1..4) # => ["123 Maple, Anytown NC", 12345, nil, nil]
+ *
+ * Raises RangeError if any element of the range is negative and out of range;
+ * see {Array Indexes}[Array.html#class-Array-label-Array+Indexes].
+ *
*/
static VALUE
@@ -773,17 +1283,22 @@ rb_struct_values_at(int argc, VALUE *argv, VALUE s)
/*
* call-seq:
- * struct.select {|i| block } -> array
- * struct.select -> an_enumerator
+ * select {|value| ... } -> array
+ * select -> enumerator
*
- * Invokes the block passing in successive elements from
- * <i>struct</i>, returning an array containing those elements
- * for which the block returns a true value (equivalent to
- * <code>Enumerable#select</code>).
+ * With a block given, returns an array of values from +self+
+ * for which the block returns a truthy value:
*
- * Lots = Struct.new(:a, :b, :c, :d, :e, :f)
- * l = Lots.new(11, 22, 33, 44, 55, 66)
- * l.select {|v| (v % 2).zero? } #=> [22, 44, 66]
+ * Customer = Struct.new(:name, :address, :zip)
+ * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * a = joe.select {|value| value.is_a?(String) }
+ * a # => ["Joe Smith", "123 Maple, Anytown NC"]
+ * a = joe.select {|value| value.is_a?(Integer) }
+ * a # => [12345]
+ *
+ * With no block given, returns an Enumerator.
+ *
+ * Struct#filter is an alias for Struct#select.
*/
static VALUE
@@ -793,11 +1308,11 @@ rb_struct_select(int argc, VALUE *argv, VALUE s)
long i;
rb_check_arity(argc, 0, 0);
- RETURN_ENUMERATOR(s, 0, 0);
+ RETURN_SIZED_ENUMERATOR(s, 0, 0, struct_enum_size);
result = rb_ary_new();
for (i = 0; i < RSTRUCT_LEN(s); i++) {
- if (RTEST(rb_yield(RSTRUCT_PTR(s)[i]))) {
- rb_ary_push(result, RSTRUCT_PTR(s)[i]);
+ if (RTEST(rb_yield(RSTRUCT_GET(s, i)))) {
+ rb_ary_push(result, RSTRUCT_GET(s, i));
}
}
@@ -807,34 +1322,35 @@ rb_struct_select(int argc, VALUE *argv, VALUE s)
static VALUE
recursive_equal(VALUE s, VALUE s2, int recur)
{
- VALUE *ptr, *ptr2;
long i, len;
if (recur) return Qtrue; /* Subtle! */
- ptr = RSTRUCT_PTR(s);
- ptr2 = RSTRUCT_PTR(s2);
len = RSTRUCT_LEN(s);
for (i=0; i<len; i++) {
- if (!rb_equal(ptr[i], ptr2[i])) return Qfalse;
+ if (!rb_equal(RSTRUCT_GET(s, i), RSTRUCT_GET(s2, i))) return Qfalse;
}
return Qtrue;
}
+
/*
* call-seq:
- * struct == other_struct -> true or false
+ * self == other -> true or false
*
- * Equality---Returns <code>true</code> if <i>other_struct</i> is
- * equal to this one: they must be of the same class as generated by
- * <code>Struct::new</code>, and the values of all instance variables
- * must be equal (according to <code>Object#==</code>).
+ * Returns +true+ if and only if the following are true; otherwise returns +false+:
*
- * Customer = Struct.new(:name, :address, :zip)
- * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
- * joejr = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
- * jane = Customer.new("Jane Doe", "456 Elm, Anytown NC", 12345)
- * joe == joejr #=> true
- * joe == jane #=> false
+ * - <tt>other.class == self.class</tt>.
+ * - For each member name +name+, <tt>other.name == self.name</tt>.
+ *
+ * Examples:
+ *
+ * Customer = Struct.new(:name, :address, :zip)
+ * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * joe_jr = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * joe_jr == joe # => true
+ * joe_jr[:name] = 'Joe Smith, Jr.'
+ * # => "Joe Smith, Jr."
+ * joe_jr == joe # => false
*/
static VALUE
@@ -850,61 +1366,72 @@ rb_struct_equal(VALUE s, VALUE s2)
return rb_exec_recursive_paired(recursive_equal, s, s2, s2);
}
+/*
+ * call-seq:
+ * hash -> integer
+ *
+ * Returns the integer hash value for +self+.
+ *
+ * Two structs of the same class and with the same content
+ * will have the same hash code (and will compare using Struct#eql?):
+ *
+ * Customer = Struct.new(:name, :address, :zip)
+ * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * joe_jr = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * joe.hash == joe_jr.hash # => true
+ * joe_jr[:name] = 'Joe Smith, Jr.'
+ * joe.hash == joe_jr.hash # => false
+ *
+ * Related: Object#hash.
+ */
+
static VALUE
-recursive_hash(VALUE s, VALUE dummy, int recur)
+rb_struct_hash(VALUE s)
{
long i, len;
st_index_t h;
- VALUE n, *ptr;
+ VALUE n;
h = rb_hash_start(rb_hash(rb_obj_class(s)));
- if (!recur) {
- ptr = RSTRUCT_PTR(s);
- len = RSTRUCT_LEN(s);
- for (i = 0; i < len; i++) {
- n = rb_hash(ptr[i]);
- h = rb_hash_uint(h, NUM2LONG(n));
- }
+ len = RSTRUCT_LEN(s);
+ for (i = 0; i < len; i++) {
+ n = rb_hash(RSTRUCT_GET(s, i));
+ h = rb_hash_uint(h, NUM2LONG(n));
}
h = rb_hash_end(h);
- return INT2FIX(h);
-}
-
-/*
- * call-seq:
- * struct.hash -> fixnum
- *
- * Return a hash value based on this struct's contents.
- */
-
-static VALUE
-rb_struct_hash(VALUE s)
-{
- return rb_exec_recursive_outer(recursive_hash, s, 0);
+ return ST2FIX(h);
}
static VALUE
recursive_eql(VALUE s, VALUE s2, int recur)
{
- VALUE *ptr, *ptr2;
long i, len;
if (recur) return Qtrue; /* Subtle! */
- ptr = RSTRUCT_PTR(s);
- ptr2 = RSTRUCT_PTR(s2);
len = RSTRUCT_LEN(s);
for (i=0; i<len; i++) {
- if (!rb_eql(ptr[i], ptr2[i])) return Qfalse;
+ if (!rb_eql(RSTRUCT_GET(s, i), RSTRUCT_GET(s2, i))) return Qfalse;
}
return Qtrue;
}
/*
* call-seq:
- * struct.eql?(other) -> true or false
+ * eql?(other) -> true or false
+ *
+ * Returns +true+ if and only if the following are true; otherwise returns +false+:
*
- * Two structures are equal if they are the same object, or if all their
- * fields are equal (using <code>eql?</code>).
+ * - <tt>other.class == self.class</tt>.
+ * - For each member name +name+, <tt>other.name.eql?(self.name)</tt>.
+ *
+ * Customer = Struct.new(:name, :address, :zip)
+ * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * joe_jr = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * joe_jr.eql?(joe) # => true
+ * joe_jr[:name] = 'Joe Smith, Jr.'
+ * joe_jr.eql?(joe) # => false
+ *
+ * Related: Object#==.
*/
static VALUE
@@ -922,45 +1449,180 @@ rb_struct_eql(VALUE s, VALUE s2)
/*
* call-seq:
- * struct.length -> fixnum
- * struct.size -> fixnum
+ * size -> integer
*
- * Returns the number of instance variables.
+ * Returns the number of members.
*
- * Customer = Struct.new(:name, :address, :zip)
- * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
- * joe.length #=> 3
+ * Customer = Struct.new(:name, :address, :zip)
+ * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * joe.size #=> 3
+ *
+ * Struct#length is an alias for Struct#size.
*/
-static VALUE
+VALUE
rb_struct_size(VALUE s)
{
return LONG2FIX(RSTRUCT_LEN(s));
}
/*
- * A <code>Struct</code> is a convenient way to bundle a number of
- * attributes together, using accessor methods, without having to write
- * an explicit class.
- *
- * The <code>Struct</code> class is a generator of specific classes,
- * each one of which is defined to hold a set of variables and their
- * accessors. In these examples, we'll call the generated class
- * ``<i>Customer</i>Class,'' and we'll show an example instance of that
- * class as ``<i>Customer</i>Inst.''
- *
- * In the descriptions that follow, the parameter <i>symbol</i> refers
- * to a symbol, which is either a quoted string or a
- * <code>Symbol</code> (such as <code>:name</code>).
+ * call-seq:
+ * dig(name, *identifiers) -> object
+ * dig(n, *identifiers) -> object
+ *
+ * Finds and returns an object among nested objects.
+ * The nested objects may be instances of various classes.
+ * See {Dig Methods}[rdoc-ref:dig_methods.rdoc].
+ *
+ *
+ * Given symbol or string argument +name+,
+ * returns the object that is specified by +name+ and +identifiers+:
+ *
+ * Foo = Struct.new(:a)
+ * f = Foo.new(Foo.new({b: [1, 2, 3]}))
+ * f.dig(:a) # => #<struct Foo a={:b=>[1, 2, 3]}>
+ * f.dig(:a, :a) # => {:b=>[1, 2, 3]}
+ * f.dig(:a, :a, :b) # => [1, 2, 3]
+ * f.dig(:a, :a, :b, 0) # => 1
+ * f.dig(:b, 0) # => nil
+ *
+ * Given integer argument +n+,
+ * returns the object that is specified by +n+ and +identifiers+:
+ *
+ * f.dig(0) # => #<struct Foo a={:b=>[1, 2, 3]}>
+ * f.dig(0, 0) # => {:b=>[1, 2, 3]}
+ * f.dig(0, 0, :b) # => [1, 2, 3]
+ * f.dig(0, 0, :b, 0) # => 1
+ * f.dig(:b, 0) # => nil
+ *
+ */
+
+static VALUE
+rb_struct_dig(int argc, VALUE *argv, VALUE self)
+{
+ rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS);
+ self = rb_struct_lookup(self, *argv);
+ if (!--argc) return self;
+ ++argv;
+ return rb_obj_dig(argc, argv, self, Qnil);
+}
+
+/*
+ * Document-class: Struct
+ *
+ * \Class \Struct provides a convenient way to create a simple class
+ * that can store and fetch values.
+ *
+ * This example creates a subclass of +Struct+, <tt>Struct::Customer</tt>;
+ * the first argument, a string, is the name of the subclass;
+ * the other arguments, symbols, determine the _members_ of the new subclass.
+ *
+ * Customer = Struct.new('Customer', :name, :address, :zip)
+ * Customer.name # => "Struct::Customer"
+ * Customer.class # => Class
+ * Customer.superclass # => Struct
+ *
+ * Corresponding to each member are two methods, a writer and a reader,
+ * that store and fetch values:
+ *
+ * methods = Customer.instance_methods false
+ * methods # => [:zip, :address=, :zip=, :address, :name, :name=]
+ *
+ * An instance of the subclass may be created,
+ * and its members assigned values, via method <tt>::new</tt>:
+ *
+ * joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
+ * joe # => #<struct Struct::Customer name="Joe Smith", address="123 Maple, Anytown NC", zip=12345>
+ *
+ * The member values may be managed thus:
+ *
+ * joe.name # => "Joe Smith"
+ * joe.name = 'Joseph Smith'
+ * joe.name # => "Joseph Smith"
+ *
+ * And thus; note that member name may be expressed as either a string or a symbol:
+ *
+ * joe[:name] # => "Joseph Smith"
+ * joe[:name] = 'Joseph Smith, Jr.'
+ * joe['name'] # => "Joseph Smith, Jr."
+ *
+ * See Struct::new.
+ *
+ * == What's Here
+ *
+ * First, what's elsewhere. \Class \Struct:
+ *
+ * - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
+ * - Includes {module Enumerable}[Enumerable.html#module-Enumerable-label-What-27s+Here],
+ * which provides dozens of additional methods.
+ *
+ * Here, class \Struct provides methods that are useful for:
+ *
+ * - {Creating a Struct Subclass}[#class-Struct-label-Methods+for+Creating+a+Struct+Subclass]
+ * - {Querying}[#class-Struct-label-Methods+for+Querying]
+ * - {Comparing}[#class-Struct-label-Methods+for+Comparing]
+ * - {Fetching}[#class-Struct-label-Methods+for+Fetching]
+ * - {Assigning}[#class-Struct-label-Methods+for+Assigning]
+ * - {Iterating}[#class-Struct-label-Methods+for+Iterating]
+ * - {Converting}[#class-Struct-label-Methods+for+Converting]
+ *
+ * === Methods for Creating a Struct Subclass
+ *
+ * ::new:: Returns a new subclass of \Struct.
+ *
+ * === Methods for Querying
+ *
+ * #hash:: Returns the integer hash code.
+ * #length, #size:: Returns the number of members.
+ *
+ * === Methods for Comparing
+ *
+ * {#==}[#method-i-3D-3D]:: Returns whether a given object is equal to +self+,
+ * using <tt>==</tt> to compare member values.
+ * #eql?:: Returns whether a given object is equal to +self+,
+ * using <tt>eql?</tt> to compare member values.
+ *
+ * === Methods for Fetching
+ *
+ * #[]:: Returns the value associated with a given member name.
+ * #to_a, #values, #deconstruct:: Returns the member values in +self+ as an array.
+ * #deconstruct_keys:: Returns a hash of the name/value pairs
+ * for given member names.
+ * #dig:: Returns the object in nested objects that is specified
+ * by a given member name and additional arguments.
+ * #members:: Returns an array of the member names.
+ * #select, #filter:: Returns an array of member values from +self+,
+ * as selected by the given block.
+ * #values_at:: Returns an array containing values for given member names.
+ *
+ * === Methods for Assigning
+ *
+ * #[]=:: Assigns a given value to a given member name.
+ *
+ * === Methods for Iterating
+ *
+ * #each:: Calls a given block with each member name.
+ * #each_pair:: Calls a given block with each member name/value pair.
+ *
+ * === Methods for Converting
+ *
+ * #inspect, #to_s:: Returns a string representation of +self+.
+ * #to_h:: Returns a hash of the member name/value pairs in +self+.
+ *
*/
void
-Init_Struct(void)
+InitVM_Struct(void)
{
rb_cStruct = rb_define_class("Struct", rb_cObject);
rb_include_module(rb_cStruct, rb_mEnumerable);
rb_undef_alloc_func(rb_cStruct);
rb_define_singleton_method(rb_cStruct, "new", rb_struct_s_def, -1);
+#if 0 /* for RDoc */
+ rb_define_singleton_method(rb_cStruct, "keyword_init?", rb_struct_s_keyword_init_p, 0);
+ rb_define_singleton_method(rb_cStruct, "members", rb_struct_s_members_m, 0);
+#endif
rb_define_method(rb_cStruct, "initialize", rb_struct_initialize_m, -1);
rb_define_method(rb_cStruct, "initialize_copy", rb_struct_init_copy, 1);
@@ -982,8 +1644,23 @@ Init_Struct(void)
rb_define_method(rb_cStruct, "[]", rb_struct_aref, 1);
rb_define_method(rb_cStruct, "[]=", rb_struct_aset, 2);
rb_define_method(rb_cStruct, "select", rb_struct_select, -1);
+ rb_define_method(rb_cStruct, "filter", rb_struct_select, -1);
rb_define_method(rb_cStruct, "values_at", rb_struct_values_at, -1);
rb_define_method(rb_cStruct, "members", rb_struct_members_m, 0);
+ rb_define_method(rb_cStruct, "dig", rb_struct_dig, -1);
+
+ rb_define_method(rb_cStruct, "deconstruct", rb_struct_to_a, 0);
+ rb_define_method(rb_cStruct, "deconstruct_keys", rb_struct_deconstruct_keys, 1);
+}
+
+#undef rb_intern
+void
+Init_Struct(void)
+{
id_members = rb_intern("__members__");
+ id_back_members = rb_intern("__members_back__");
+ id_keyword_init = rb_intern("__keyword_init__");
+
+ InitVM(Struct);
}