2000-05-01 13:42:38 +04:00
|
|
|
/**********************************************************************
|
1998-01-16 15:13:05 +03:00
|
|
|
|
|
|
|
struct.c -
|
|
|
|
|
|
|
|
$Author$
|
|
|
|
created at: Tue Mar 22 18:44:30 JST 1995
|
|
|
|
|
* encoding.c: provide basic features for M17N.
* parse.y: encoding aware parsing.
* parse.y (pragma_encoding): encoding specification pragma.
* parse.y (rb_intern3): encoding specified symbols.
* string.c (rb_str_length): length based on characters.
for older behavior, bytesize method added.
* string.c (rb_str_index_m): index based on characters. rindex as
well.
* string.c (succ_char): encoding aware succeeding string.
* string.c (rb_str_reverse): reverse based on characters.
* string.c (rb_str_inspect): encoding aware string description.
* string.c (rb_str_upcase_bang): encoding aware case conversion.
downcase, capitalize, swapcase as well.
* string.c (rb_str_tr_bang): tr based on characters. delete,
squeeze, tr_s, count as well.
* string.c (rb_str_split_m): split based on characters.
* string.c (rb_str_each_line): encoding aware each_line.
* string.c (rb_str_each_char): added. iteration based on
characters.
* string.c (rb_str_strip_bang): encoding aware whitespace
stripping. lstrip, rstrip as well.
* string.c (rb_str_justify): encoding aware justifying (ljust,
rjust, center).
* string.c (str_encoding): get encoding attribute from a string.
* re.c (rb_reg_initialize): encoding aware regular expression
* sprintf.c (rb_str_format): formatting (i.e. length count) based
on characters.
* io.c (rb_io_getc): getc to return one-character string.
for older behavior, getbyte method added.
* ext/stringio/stringio.c (strio_getc): ditto.
* io.c (rb_io_ungetc): allow pushing arbitrary string at the
current reading point.
* ext/stringio/stringio.c (strio_ungetc): ditto.
* ext/strscan/strscan.c: encoding support.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@13261 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2007-08-25 07:29:39 +04:00
|
|
|
Copyright (C) 1993-2007 Yukihiro Matsumoto
|
2000-05-01 13:42:38 +04:00
|
|
|
|
|
|
|
**********************************************************************/
|
1998-01-16 15:13:05 +03:00
|
|
|
|
2015-06-30 23:45:44 +03:00
|
|
|
#include "id.h"
|
2019-12-04 11:16:30 +03:00
|
|
|
#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"
|
2018-10-31 01:03:42 +03:00
|
|
|
#include "transient_heap.h"
|
2019-12-04 11:16:30 +03:00
|
|
|
#include "vm_core.h"
|
2020-06-15 04:00:12 +03:00
|
|
|
#include "builtin.h"
|
2015-06-30 23:45:44 +03:00
|
|
|
|
|
|
|
/* only for struct[:field] access */
|
2015-07-01 11:16:48 +03:00
|
|
|
enum {
|
2015-07-01 11:17:02 +03:00
|
|
|
AREF_HASH_UNIT = 5,
|
2015-07-01 11:16:48 +03:00
|
|
|
AREF_HASH_THRESHOLD = 10
|
|
|
|
};
|
2014-12-09 18:43:49 +03:00
|
|
|
|
2022-09-30 12:23:19 +03:00
|
|
|
/* Note: Data is a stricter version of the Struct: no attr writers & no
|
|
|
|
hash-alike/array-alike behavior. It shares most of the implementation
|
|
|
|
on the C level, but is unrelated on the Ruby level. */
|
1999-01-20 07:59:39 +03:00
|
|
|
VALUE rb_cStruct;
|
2022-09-30 12:23:19 +03:00
|
|
|
static VALUE rb_cData;
|
2017-12-12 11:12:43 +03:00
|
|
|
static ID id_members, id_back_members, id_keyword_init;
|
1998-01-16 15:13:05 +03:00
|
|
|
|
* bignum.c: changed `foo _((boo))' to `foo(boo)`. [ruby-dev:27056]
* defines.h, dir.c, dln.h, enumerator.c, env.h, error.c, eval.c, file.c,
gc.c, hash.c, inits.c, intern.h, io.c, lex.c, marshal.c, missing.h,
node.h, numeric.c, pack.c, process.c, re.h, ruby.c, ruby.h, rubyio.h,
rubysig.h, signal.c, sprintf.c, st.h, string.c, struct.c, time.c,
util.c, util.h, variable.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9155 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-14 10:32:32 +04:00
|
|
|
static VALUE struct_alloc(VALUE);
|
1999-08-13 09:45:20 +04:00
|
|
|
|
2009-05-19 08:58:36 +04:00
|
|
|
static inline VALUE
|
|
|
|
struct_ivar_get(VALUE c, ID id)
|
1999-08-13 09:45:20 +04:00
|
|
|
{
|
2015-06-23 00:50:31 +03:00
|
|
|
VALUE orig = c;
|
|
|
|
VALUE ivar = rb_attr_get(c, id);
|
|
|
|
|
|
|
|
if (!NIL_P(ivar))
|
|
|
|
return ivar;
|
|
|
|
|
1999-08-13 09:45:20 +04:00
|
|
|
for (;;) {
|
2022-05-26 21:54:15 +03:00
|
|
|
c = rb_class_superclass(c);
|
2022-11-30 23:04:31 +03:00
|
|
|
if (c == rb_cStruct || c == rb_cData || !RTEST(c))
|
2022-05-26 21:54:15 +03:00
|
|
|
return Qnil;
|
|
|
|
RUBY_ASSERT(RB_TYPE_P(c, T_CLASS));
|
|
|
|
ivar = rb_attr_get(c, id);
|
|
|
|
if (!NIL_P(ivar)) {
|
|
|
|
return rb_ivar_set(orig, id, ivar);
|
|
|
|
}
|
1999-08-13 09:45:20 +04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-01-05 14:44:31 +03:00
|
|
|
VALUE
|
|
|
|
rb_struct_s_keyword_init(VALUE klass)
|
|
|
|
{
|
|
|
|
return struct_ivar_get(klass, id_keyword_init);
|
|
|
|
}
|
|
|
|
|
2004-09-27 08:46:54 +04:00
|
|
|
VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_s_members(VALUE klass)
|
2004-09-24 20:58:51 +04:00
|
|
|
{
|
2009-05-19 08:58:36 +04:00
|
|
|
VALUE members = struct_ivar_get(klass, id_members);
|
2004-09-24 20:58:51 +04:00
|
|
|
|
|
|
|
if (NIL_P(members)) {
|
2007-09-07 21:47:56 +04:00
|
|
|
rb_raise(rb_eTypeError, "uninitialized struct");
|
2004-09-24 20:58:51 +04:00
|
|
|
}
|
2011-09-29 15:07:45 +04:00
|
|
|
if (!RB_TYPE_P(members, T_ARRAY)) {
|
2007-09-08 05:08:23 +04:00
|
|
|
rb_raise(rb_eTypeError, "corrupted struct");
|
|
|
|
}
|
2004-09-24 20:58:51 +04:00
|
|
|
return members;
|
|
|
|
}
|
|
|
|
|
2004-09-27 08:46:54 +04:00
|
|
|
VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_members(VALUE s)
|
2004-09-24 09:53:43 +04:00
|
|
|
{
|
2004-09-27 08:46:54 +04:00
|
|
|
VALUE members = rb_struct_s_members(rb_obj_class(s));
|
2004-09-24 09:53:43 +04:00
|
|
|
|
2006-09-02 18:42:08 +04:00
|
|
|
if (RSTRUCT_LEN(s) != RARRAY_LEN(members)) {
|
2005-09-24 04:17:43 +04:00
|
|
|
rb_raise(rb_eTypeError, "struct size differs (%ld required %ld given)",
|
2006-09-02 18:42:08 +04:00
|
|
|
RARRAY_LEN(members), RSTRUCT_LEN(s));
|
2004-09-24 09:53:43 +04:00
|
|
|
}
|
|
|
|
return members;
|
|
|
|
}
|
|
|
|
|
2015-06-30 23:45:44 +03:00
|
|
|
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)
|
|
|
|
{
|
2015-07-01 11:17:02 +03:00
|
|
|
/* (((prev/2) * AREF_HASH_UNIT + 1) & (mask/2)) * 2 */
|
|
|
|
return (prev * AREF_HASH_UNIT + 2) & mask;
|
2015-06-30 23:45:44 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
static VALUE
|
2015-07-01 03:30:38 +03:00
|
|
|
struct_set_members(VALUE klass, VALUE /* frozen hidden array */ members)
|
2015-06-30 23:45:44 +03:00
|
|
|
{
|
|
|
|
VALUE back;
|
2015-07-01 03:30:38 +03:00
|
|
|
const long members_length = RARRAY_LEN(members);
|
2015-06-30 23:45:44 +03:00
|
|
|
|
2015-07-01 03:30:38 +03:00
|
|
|
if (members_length <= AREF_HASH_THRESHOLD) {
|
2015-06-30 23:45:44 +03:00
|
|
|
back = members;
|
2015-07-01 03:30:38 +03:00
|
|
|
}
|
|
|
|
else {
|
2015-06-30 23:45:44 +03:00
|
|
|
long i, j, mask = 64;
|
|
|
|
VALUE name;
|
|
|
|
|
2015-07-01 11:17:02 +03:00
|
|
|
while (mask < members_length * AREF_HASH_UNIT) mask *= 2;
|
2015-06-30 23:45:44 +03:00
|
|
|
|
2022-07-25 17:40:45 +03:00
|
|
|
back = rb_ary_hidden_new(mask + 1);
|
2015-07-01 03:30:38 +03:00
|
|
|
rb_ary_store(back, mask, INT2FIX(members_length));
|
2015-06-30 23:45:44 +03:00
|
|
|
mask -= 2; /* mask = (2**k-1)*2 */
|
|
|
|
|
2015-07-01 03:30:38 +03:00
|
|
|
for (i=0; i < members_length; i++) {
|
2015-06-30 23:45:44 +03:00
|
|
|
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);
|
|
|
|
}
|
|
|
|
}
|
2015-07-01 03:30:38 +03:00
|
|
|
OBJ_FREEZE_RAW(back);
|
2015-06-30 23:45:44 +03:00
|
|
|
}
|
|
|
|
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);
|
2015-07-01 03:28:49 +03:00
|
|
|
long j, mask;
|
2015-06-30 23:45:44 +03:00
|
|
|
|
|
|
|
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");
|
|
|
|
}
|
|
|
|
|
2015-07-01 03:28:49 +03:00
|
|
|
mask = RARRAY_LEN(back);
|
2015-06-30 23:45:44 +03:00
|
|
|
|
|
|
|
if (mask <= AREF_HASH_THRESHOLD) {
|
2015-07-01 03:30:38 +03:00
|
|
|
if (UNLIKELY(RSTRUCT_LEN(s) != mask)) {
|
2015-06-30 23:45:44 +03:00
|
|
|
rb_raise(rb_eTypeError,
|
2015-07-01 03:28:49 +03:00
|
|
|
"struct size differs (%ld required %ld given)",
|
2015-06-30 23:45:44 +03:00
|
|
|
mask, RSTRUCT_LEN(s));
|
|
|
|
}
|
|
|
|
for (j = 0; j < mask; j++) {
|
2018-10-29 21:00:14 +03:00
|
|
|
if (RARRAY_AREF(back, j) == name)
|
2015-07-01 03:28:49 +03:00
|
|
|
return (int)j;
|
2015-06-30 23:45:44 +03:00
|
|
|
}
|
|
|
|
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 (;;) {
|
2018-10-29 21:00:02 +03:00
|
|
|
VALUE e = RARRAY_AREF(back, j);
|
2018-10-29 21:00:14 +03:00
|
|
|
if (e == name)
|
|
|
|
return FIX2INT(RARRAY_AREF(back, j + 1));
|
2018-10-29 21:00:02 +03:00
|
|
|
if (!RTEST(e)) {
|
2015-06-30 23:45:44 +03:00
|
|
|
return -1;
|
|
|
|
}
|
|
|
|
j = struct_member_pos_probe(j, mask);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-12-16 00:59:33 +03:00
|
|
|
/*
|
|
|
|
* call-seq:
|
|
|
|
* StructClass::members -> array_of_symbols
|
|
|
|
*
|
2021-12-25 04:33:49 +03:00
|
|
|
* Returns the member names of the Struct descendant as an array:
|
2021-12-16 00:59:33 +03:00
|
|
|
*
|
|
|
|
* Customer = Struct.new(:name, :address, :zip)
|
|
|
|
* Customer.members # => [:name, :address, :zip]
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
1999-01-20 07:59:39 +03:00
|
|
|
static VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_s_members_m(VALUE klass)
|
1999-01-20 07:59:39 +03:00
|
|
|
{
|
2012-05-21 19:47:03 +04:00
|
|
|
VALUE members = rb_struct_s_members(klass);
|
1998-01-16 15:13:05 +03:00
|
|
|
|
2012-05-21 19:47:03 +04:00
|
|
|
return rb_ary_dup(members);
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
|
|
|
|
2003-12-28 23:47:56 +03:00
|
|
|
/*
|
|
|
|
* call-seq:
|
2021-09-24 01:21:40 +03:00
|
|
|
* members -> array_of_symbols
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2021-09-24 01:21:40 +03:00
|
|
|
* Returns the member names from +self+ as an array:
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2003-12-28 23:47:56 +03:00
|
|
|
* Customer = Struct.new(:name, :address, :zip)
|
2021-09-24 01:21:40 +03:00
|
|
|
* Customer.new.members # => [:name, :address, :zip]
|
2021-09-24 18:35:19 +03:00
|
|
|
*
|
|
|
|
* Related: #to_a.
|
2003-12-28 23:47:56 +03:00
|
|
|
*/
|
|
|
|
|
1998-01-16 15:13:05 +03:00
|
|
|
static VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_members_m(VALUE obj)
|
1998-01-16 15:13:05 +03:00
|
|
|
{
|
2004-09-27 08:46:54 +04:00
|
|
|
return rb_struct_s_members_m(rb_obj_class(obj));
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_getmember(VALUE obj, ID id)
|
1998-01-16 15:13:05 +03:00
|
|
|
{
|
2015-06-30 23:45:44 +03:00
|
|
|
VALUE slot = ID2SYM(id);
|
|
|
|
int i = struct_member_pos(obj, slot);
|
|
|
|
if (i != -1) {
|
|
|
|
return RSTRUCT_GET(obj, i);
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
2015-10-28 09:24:12 +03:00
|
|
|
rb_name_err_raise("`%1$s' is not a struct member", obj, ID2SYM(id));
|
2012-04-14 04:36:26 +04:00
|
|
|
|
2018-07-24 08:38:07 +03:00
|
|
|
UNREACHABLE_RETURN(Qnil);
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
|
|
|
|
2001-08-06 07:08:57 +04:00
|
|
|
static void
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_modify(VALUE s)
|
2001-08-06 07:08:57 +04:00
|
|
|
{
|
* array.c, gc.c, hash.c, object.c, string.c, struct.c,
transcode.c, variable.c, vm.c, vm_insnhelper.c, vm_method.c:
replace calls to rb_error_frozen() with rb_check_frozen(). a
patch from Run Paint Run Run at [ruby-core:32014]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@29583 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2010-10-24 12:14:05 +04:00
|
|
|
rb_check_frozen(s);
|
2001-08-06 07:08:57 +04:00
|
|
|
}
|
|
|
|
|
1998-01-16 15:13:05 +03:00
|
|
|
static VALUE
|
2013-04-13 05:20:34 +04:00
|
|
|
anonymous_struct(VALUE klass)
|
1998-01-16 15:13:05 +03:00
|
|
|
{
|
2013-04-13 05:20:34 +04:00
|
|
|
VALUE nstr;
|
|
|
|
|
|
|
|
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? */
|
1998-01-16 15:13:05 +03:00
|
|
|
ID id;
|
2013-04-13 05:20:34 +04:00
|
|
|
name = rb_str_to_str(name);
|
|
|
|
if (!rb_is_const_name(name)) {
|
2015-10-28 09:24:12 +03:00
|
|
|
rb_name_err_raise("identifier %1$s needs to be constant",
|
|
|
|
super, name);
|
2013-04-13 05:20:34 +04:00
|
|
|
}
|
|
|
|
id = rb_to_id(name);
|
|
|
|
if (rb_const_defined_at(super, id)) {
|
2013-10-27 19:52:39 +04:00
|
|
|
rb_warn("redefining constant %"PRIsVALUE"::%"PRIsVALUE, super, name);
|
2013-04-13 05:20:34 +04:00
|
|
|
rb_mod_remove_const(super, ID2SYM(id));
|
|
|
|
}
|
|
|
|
return rb_define_class_id_under(super, id, super);
|
|
|
|
}
|
|
|
|
|
2020-06-15 04:00:12 +03:00
|
|
|
NORETURN(static void invalid_struct_pos(VALUE s, VALUE idx));
|
|
|
|
|
2014-12-09 18:43:49 +03:00
|
|
|
static void
|
|
|
|
define_aref_method(VALUE nstr, VALUE name, VALUE off)
|
|
|
|
{
|
2021-11-18 05:01:31 +03:00
|
|
|
rb_add_method_optimized(nstr, SYM2ID(name), OPTIMIZED_METHOD_TYPE_STRUCT_AREF, FIX2UINT(off), METHOD_VISI_PUBLIC);
|
2014-12-09 18:43:49 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
static void
|
|
|
|
define_aset_method(VALUE nstr, VALUE name, VALUE off)
|
|
|
|
{
|
2021-11-18 05:01:31 +03:00
|
|
|
rb_add_method_optimized(nstr, SYM2ID(name), OPTIMIZED_METHOD_TYPE_STRUCT_ASET, FIX2UINT(off), METHOD_VISI_PUBLIC);
|
2014-12-09 18:43:49 +03:00
|
|
|
}
|
|
|
|
|
2017-12-12 18:03:45 +03:00
|
|
|
static VALUE
|
|
|
|
rb_struct_s_inspect(VALUE klass)
|
|
|
|
{
|
|
|
|
VALUE inspect = rb_class_name(klass);
|
2018-01-05 14:44:31 +03:00
|
|
|
if (RTEST(rb_struct_s_keyword_init(klass))) {
|
2017-12-12 18:03:45 +03:00
|
|
|
rb_str_cat_cstr(inspect, "(keyword_init: true)");
|
|
|
|
}
|
|
|
|
return inspect;
|
|
|
|
}
|
|
|
|
|
2022-09-30 12:23:19 +03:00
|
|
|
static VALUE
|
|
|
|
rb_data_s_new(int argc, const VALUE *argv, VALUE klass)
|
|
|
|
{
|
|
|
|
if (rb_keyword_given_p()) {
|
|
|
|
if (argc > 1 || !RB_TYPE_P(argv[0], T_HASH)) {
|
|
|
|
rb_error_arity(argc, 0, 0);
|
|
|
|
}
|
|
|
|
return rb_class_new_instance_pass_kw(argc, argv, klass);
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
VALUE members = struct_ivar_get(klass, id_members);
|
|
|
|
int num_members = RARRAY_LENINT(members);
|
|
|
|
|
|
|
|
rb_check_arity(argc, 0, num_members);
|
|
|
|
VALUE arg_hash = rb_hash_new_with_size(argc);
|
|
|
|
for (long i=0; i<argc; i++) {
|
|
|
|
VALUE k = rb_ary_entry(members, i), v = argv[i];
|
|
|
|
rb_hash_aset(arg_hash, k, v);
|
|
|
|
}
|
|
|
|
return rb_class_new_instance_kw(1, &arg_hash, klass, RB_PASS_KEYWORDS);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-12-16 00:59:33 +03:00
|
|
|
#if 0 /* for RDoc */
|
|
|
|
|
2021-07-15 12:14:27 +03:00
|
|
|
/*
|
|
|
|
* call-seq:
|
2021-12-16 00:59:33 +03:00
|
|
|
* StructClass::keyword_init? -> true or falsy value
|
2021-07-15 12:14:27 +03:00
|
|
|
*
|
2021-12-16 00:59:33 +03:00
|
|
|
* Returns +true+ if the class was initialized with <tt>keyword_init: true</tt>.
|
|
|
|
* Otherwise returns +nil+ or +false+.
|
2021-07-15 12:14:27 +03:00
|
|
|
*
|
|
|
|
* Examples:
|
|
|
|
* Foo = Struct.new(:a)
|
2021-07-15 15:33:39 +03:00
|
|
|
* Foo.keyword_init? # => nil
|
2021-07-15 12:14:27 +03:00
|
|
|
* Bar = Struct.new(:a, keyword_init: true)
|
|
|
|
* Bar.keyword_init? # => true
|
2021-07-15 15:33:39 +03:00
|
|
|
* Baz = Struct.new(:a, keyword_init: false)
|
|
|
|
* Baz.keyword_init? # => false
|
2021-07-15 12:14:27 +03:00
|
|
|
*/
|
2021-12-16 00:59:33 +03:00
|
|
|
static VALUE
|
|
|
|
rb_struct_s_keyword_init_p(VALUE obj)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
#endif
|
2021-07-15 15:33:39 +03:00
|
|
|
|
|
|
|
#define rb_struct_s_keyword_init_p rb_struct_s_keyword_init
|
2021-07-15 12:14:27 +03:00
|
|
|
|
2013-04-13 05:20:34 +04:00
|
|
|
static VALUE
|
2020-05-08 06:58:19 +03:00
|
|
|
setup_struct(VALUE nstr, VALUE members)
|
2013-04-13 05:20:34 +04:00
|
|
|
{
|
* array.c (rb_ary_{times, shuffle_bang, sample}): reducing macro
calls inside of the loop by keeping pointers in local
variables. a patch from Masahiro Kanai (CanI) in [ruby-dev:39406].
It was found and fixed at Security and Programming camp 2009.
* string.c (rb_str_{times, split_m}): ditto.
* struct.c (rb_struct_{getmember, set, aref_id, aset_id}, {make,
inspect}_struct, recursive_{equal, hash, eql}): ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@25237 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2009-10-05 18:35:39 +04:00
|
|
|
long i, len;
|
1998-01-16 15:13:05 +03:00
|
|
|
|
2015-06-30 23:45:44 +03:00
|
|
|
members = struct_set_members(nstr, members);
|
1998-01-16 15:13:05 +03:00
|
|
|
|
2002-12-20 11:33:17 +03:00
|
|
|
rb_define_alloc_func(nstr, struct_alloc);
|
2020-05-08 06:58:19 +03:00
|
|
|
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);
|
2004-09-27 08:46:54 +04:00
|
|
|
rb_define_singleton_method(nstr, "members", rb_struct_s_members_m, 0);
|
2017-12-12 18:03:45 +03:00
|
|
|
rb_define_singleton_method(nstr, "inspect", rb_struct_s_inspect, 0);
|
2021-07-15 12:14:27 +03:00
|
|
|
rb_define_singleton_method(nstr, "keyword_init?", rb_struct_s_keyword_init_p, 0);
|
|
|
|
|
* array.c (rb_ary_{times, shuffle_bang, sample}): reducing macro
calls inside of the loop by keeping pointers in local
variables. a patch from Masahiro Kanai (CanI) in [ruby-dev:39406].
It was found and fixed at Security and Programming camp 2009.
* string.c (rb_str_{times, split_m}): ditto.
* struct.c (rb_struct_{getmember, set, aref_id, aset_id}, {make,
inspect}_struct, recursive_{equal, hash, eql}): ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@25237 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2009-10-05 18:35:39 +04:00
|
|
|
len = RARRAY_LEN(members);
|
|
|
|
for (i=0; i< len; i++) {
|
2018-10-05 02:33:03 +03:00
|
|
|
VALUE sym = RARRAY_AREF(members, i);
|
2018-10-05 02:33:05 +03:00
|
|
|
ID id = SYM2ID(sym);
|
2014-12-09 18:43:49 +03:00
|
|
|
VALUE off = LONG2NUM(i);
|
|
|
|
|
2021-11-18 05:01:31 +03:00
|
|
|
define_aref_method(nstr, sym, off);
|
|
|
|
define_aset_method(nstr, ID2SYM(rb_id_attrset(id)), off);
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
return nstr;
|
|
|
|
}
|
|
|
|
|
2022-09-30 12:23:19 +03:00
|
|
|
static VALUE
|
|
|
|
setup_data(VALUE subclass, VALUE members)
|
|
|
|
{
|
|
|
|
long i, len;
|
|
|
|
|
|
|
|
members = struct_set_members(subclass, members);
|
|
|
|
|
|
|
|
rb_define_alloc_func(subclass, struct_alloc);
|
2022-10-03 17:28:01 +03:00
|
|
|
VALUE sclass = rb_singleton_class(subclass);
|
|
|
|
rb_undef_method(sclass, "define");
|
|
|
|
rb_define_method(sclass, "new", rb_data_s_new, -1);
|
|
|
|
rb_define_method(sclass, "[]", rb_data_s_new, -1);
|
|
|
|
rb_define_method(sclass, "members", rb_struct_s_members_m, 0);
|
|
|
|
rb_define_method(sclass, "inspect", rb_struct_s_inspect, 0); // FIXME: just a separate method?..
|
2022-09-30 12:23:19 +03:00
|
|
|
|
|
|
|
len = RARRAY_LEN(members);
|
|
|
|
for (i=0; i< len; i++) {
|
|
|
|
VALUE sym = RARRAY_AREF(members, i);
|
|
|
|
VALUE off = LONG2NUM(i);
|
|
|
|
|
|
|
|
define_aref_method(subclass, sym, off);
|
|
|
|
}
|
|
|
|
|
|
|
|
return subclass;
|
|
|
|
}
|
|
|
|
|
2007-11-23 07:35:53 +03:00
|
|
|
VALUE
|
2007-11-23 10:00:50 +03:00
|
|
|
rb_struct_alloc_noinit(VALUE klass)
|
|
|
|
{
|
|
|
|
return struct_alloc(klass);
|
|
|
|
}
|
|
|
|
|
2016-04-16 03:59:42 +03:00
|
|
|
static VALUE
|
|
|
|
struct_make_members_list(va_list ar)
|
|
|
|
{
|
|
|
|
char *mem;
|
2016-04-16 04:00:13 +03:00
|
|
|
VALUE ary, list = rb_ident_hash_new();
|
|
|
|
RBASIC_CLEAR_CLASS(list);
|
2016-04-16 03:59:42 +03:00
|
|
|
while ((mem = va_arg(ar, char*)) != 0) {
|
|
|
|
VALUE sym = rb_sym_intern_ascii_cstr(mem);
|
2023-02-03 18:21:33 +03:00
|
|
|
if (RTEST(rb_hash_has_key(list, sym))) {
|
2016-04-16 04:00:13 +03:00
|
|
|
rb_raise(rb_eArgError, "duplicate member: %s", mem);
|
|
|
|
}
|
2023-02-03 18:21:33 +03:00
|
|
|
rb_hash_aset(list, sym, Qtrue);
|
2016-04-16 03:59:42 +03:00
|
|
|
}
|
2016-04-16 04:00:13 +03:00
|
|
|
ary = rb_hash_keys(list);
|
|
|
|
RBASIC_CLEAR_CLASS(ary);
|
2016-04-16 03:59:42 +03:00
|
|
|
OBJ_FREEZE_RAW(ary);
|
|
|
|
return ary;
|
|
|
|
}
|
|
|
|
|
2013-08-29 13:12:25 +04:00
|
|
|
static VALUE
|
|
|
|
struct_define_without_accessor(VALUE outer, const char *class_name, VALUE super, rb_alloc_func_t alloc, VALUE members)
|
2007-11-23 07:35:53 +03:00
|
|
|
{
|
|
|
|
VALUE klass;
|
2013-08-29 13:12:25 +04:00
|
|
|
|
|
|
|
if (class_name) {
|
|
|
|
if (outer) {
|
|
|
|
klass = rb_define_class_under(outer, class_name, super);
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
klass = rb_define_class(class_name, super);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
klass = anonymous_struct(super);
|
|
|
|
}
|
|
|
|
|
2015-06-30 23:45:44 +03:00
|
|
|
struct_set_members(klass, members);
|
2013-08-29 13:12:25 +04:00
|
|
|
|
|
|
|
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, ...)
|
|
|
|
{
|
2007-11-23 07:35:53 +03:00
|
|
|
va_list ar;
|
|
|
|
VALUE members;
|
|
|
|
|
2007-11-23 10:15:17 +03:00
|
|
|
va_start(ar, alloc);
|
2016-04-16 03:59:42 +03:00
|
|
|
members = struct_make_members_list(ar);
|
2007-11-23 07:35:53 +03:00
|
|
|
va_end(ar);
|
|
|
|
|
2013-08-29 13:12:25 +04:00
|
|
|
return struct_define_without_accessor(outer, class_name, super, alloc, members);
|
|
|
|
}
|
2007-11-23 07:35:53 +03:00
|
|
|
|
2013-08-29 13:12:25 +04:00
|
|
|
VALUE
|
|
|
|
rb_struct_define_without_accessor(const char *class_name, VALUE super, rb_alloc_func_t alloc, ...)
|
|
|
|
{
|
|
|
|
va_list ar;
|
|
|
|
VALUE members;
|
2007-11-23 07:35:53 +03:00
|
|
|
|
2013-08-29 13:12:25 +04:00
|
|
|
va_start(ar, alloc);
|
2016-04-16 03:59:42 +03:00
|
|
|
members = struct_make_members_list(ar);
|
2013-08-29 13:12:25 +04:00
|
|
|
va_end(ar);
|
2007-11-23 07:35:53 +03:00
|
|
|
|
2013-08-29 13:12:25 +04:00
|
|
|
return struct_define_without_accessor(0, class_name, super, alloc, members);
|
2007-11-23 07:35:53 +03:00
|
|
|
}
|
|
|
|
|
1998-01-16 15:13:05 +03:00
|
|
|
VALUE
|
1999-08-13 09:45:20 +04:00
|
|
|
rb_struct_define(const char *name, ...)
|
1998-01-16 15:13:05 +03:00
|
|
|
{
|
|
|
|
va_list ar;
|
2013-04-13 05:20:34 +04:00
|
|
|
VALUE st, ary;
|
1998-01-16 15:13:05 +03:00
|
|
|
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
va_start(ar, name);
|
2016-04-16 03:59:42 +03:00
|
|
|
ary = struct_make_members_list(ar);
|
1998-01-16 15:13:05 +03:00
|
|
|
va_end(ar);
|
|
|
|
|
2013-04-13 05:20:34 +04:00
|
|
|
if (!name) st = anonymous_struct(rb_cStruct);
|
|
|
|
else st = new_struct(rb_str_new2(name), rb_cStruct);
|
2020-05-08 06:58:19 +03:00
|
|
|
return setup_struct(st, ary);
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
|
|
|
|
2013-08-03 04:31:02 +04:00
|
|
|
VALUE
|
|
|
|
rb_struct_define_under(VALUE outer, const char *name, ...)
|
|
|
|
{
|
|
|
|
va_list ar;
|
|
|
|
VALUE ary;
|
|
|
|
|
|
|
|
va_start(ar, name);
|
2016-04-16 03:59:42 +03:00
|
|
|
ary = struct_make_members_list(ar);
|
2013-08-03 04:31:02 +04:00
|
|
|
va_end(ar);
|
|
|
|
|
2020-05-08 06:58:19 +03:00
|
|
|
return setup_struct(rb_define_class_under(outer, name, rb_cStruct), ary);
|
2013-08-03 04:31:02 +04:00
|
|
|
}
|
|
|
|
|
2003-12-28 23:47:56 +03:00
|
|
|
/*
|
|
|
|
* call-seq:
|
2023-02-04 01:26:39 +03:00
|
|
|
* Struct.new(*member_names, keyword_init: nil){|Struct_subclass| ... } -> Struct_subclass
|
|
|
|
* Struct.new(class_name, *member_names, keyword_init: nil){|Struct_subclass| ... } -> Struct_subclass
|
2021-09-24 01:21:40 +03:00
|
|
|
* 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+.
|
2022-12-21 22:23:14 +03:00
|
|
|
* - May have initialization via ordinary arguments, or via keyword arguments
|
2021-09-24 01:21:40 +03:00
|
|
|
*
|
|
|
|
* 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
|
|
|
|
*
|
2022-12-21 22:23:14 +03:00
|
|
|
* # Initialization with keyword arguments:
|
|
|
|
* Foo.new(foo: 0) # => #<struct Struct::Foo foo=0, bar=nil>
|
|
|
|
* Foo.new(foo: 0, bar: 1) # => #<struct Struct::Foo foo=0, bar=1>
|
|
|
|
* Foo.new(foo: 0, bar: 1, baz: 2)
|
|
|
|
* # Raises ArgumentError: unknown keywords: baz
|
|
|
|
*
|
2021-09-24 01:21:40 +03:00
|
|
|
* - \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
|
2022-12-21 22:23:14 +03:00
|
|
|
* can be both positional and keyword arguments.
|
|
|
|
*
|
|
|
|
* Optional keyword argument <tt>keyword_init:</tt> allows to force only one
|
|
|
|
* type of arguments to be accepted:
|
|
|
|
*
|
|
|
|
* KeywordsOnly = Struct.new(:foo, :bar, keyword_init: true)
|
|
|
|
* KeywordsOnly.new(bar: 1, foo: 0)
|
|
|
|
* # => #<struct KeywordsOnly foo=0, bar=1>
|
|
|
|
* KeywordsOnly.new(0, 1)
|
|
|
|
* # Raises ArgumentError: wrong number of arguments
|
|
|
|
*
|
|
|
|
* PositionalOnly = Struct.new(:foo, :bar, keyword_init: false)
|
|
|
|
* PositionalOnly.new(0, 1)
|
|
|
|
* # => #<struct PositionalOnly foo=0, bar=1>
|
|
|
|
* PositionalOnly.new(bar: 1, foo: 0)
|
|
|
|
* # => #<struct PositionalOnly foo={:foo=>1, :bar=>2}, bar=nil>
|
|
|
|
* # Note that no error is raised, but arguments treated as one hash value
|
|
|
|
*
|
|
|
|
* # Same as not providing keyword_init:
|
|
|
|
* Any = Struct.new(:foo, :bar, keyword_init: nil)
|
|
|
|
* Any.new(foo: 1, bar: 2)
|
|
|
|
* # => #<struct Any foo=1, bar=2>
|
|
|
|
* Any.new(1, 2)
|
|
|
|
* # => #<struct Any foo=1, bar=2>
|
2003-12-28 23:47:56 +03:00
|
|
|
*/
|
|
|
|
|
1998-01-16 15:13:05 +03:00
|
|
|
static VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_s_def(int argc, VALUE *argv, VALUE klass)
|
1998-01-16 15:13:05 +03:00
|
|
|
{
|
2023-03-23 23:44:04 +03:00
|
|
|
VALUE name = Qnil, rest, keyword_init = Qnil;
|
1999-08-13 09:45:20 +04:00
|
|
|
long i;
|
1999-01-20 07:59:39 +03:00
|
|
|
VALUE st;
|
2022-03-17 12:54:49 +03:00
|
|
|
VALUE opt;
|
1998-01-16 15:13:05 +03:00
|
|
|
|
2023-03-23 23:44:04 +03:00
|
|
|
argc = rb_scan_args(argc, argv, "0*:", NULL, &opt);
|
|
|
|
if (argc >= 1 && !SYMBOL_P(argv[0])) {
|
|
|
|
name = argv[0];
|
2013-04-13 05:20:34 +04:00
|
|
|
--argc;
|
|
|
|
++argv;
|
|
|
|
}
|
2017-12-12 11:12:43 +03:00
|
|
|
|
2022-03-17 12:54:49 +03:00
|
|
|
if (!NIL_P(opt)) {
|
2017-12-12 11:12:43 +03:00
|
|
|
static ID keyword_ids[1];
|
|
|
|
|
|
|
|
if (!keyword_ids[0]) {
|
|
|
|
keyword_ids[0] = rb_intern("keyword_init");
|
|
|
|
}
|
2022-03-17 12:54:49 +03:00
|
|
|
rb_get_kwargs(opt, keyword_ids, 0, 1, &keyword_init);
|
2022-11-15 07:24:08 +03:00
|
|
|
if (UNDEF_P(keyword_init)) {
|
2021-01-17 12:35:54 +03:00
|
|
|
keyword_init = Qnil;
|
2019-09-04 00:02:24 +03:00
|
|
|
}
|
2021-07-15 15:30:15 +03:00
|
|
|
else if (RTEST(keyword_init)) {
|
|
|
|
keyword_init = Qtrue;
|
|
|
|
}
|
2017-12-12 11:12:43 +03:00
|
|
|
}
|
|
|
|
|
2016-04-16 04:00:13 +03:00
|
|
|
rest = rb_ident_hash_new();
|
|
|
|
RBASIC_CLEAR_CLASS(rest);
|
2013-04-13 05:20:34 +04:00
|
|
|
for (i=0; i<argc; i++) {
|
2016-04-16 04:00:13 +03:00
|
|
|
VALUE mem = rb_to_symbol(argv[i]);
|
2019-07-05 20:01:06 +03:00
|
|
|
if (rb_is_attrset_sym(mem)) {
|
|
|
|
rb_raise(rb_eArgError, "invalid struct member: %"PRIsVALUE, mem);
|
|
|
|
}
|
2023-02-03 18:21:33 +03:00
|
|
|
if (RTEST(rb_hash_has_key(rest, mem))) {
|
2016-04-16 04:00:13 +03:00
|
|
|
rb_raise(rb_eArgError, "duplicate member: %"PRIsVALUE, mem);
|
|
|
|
}
|
2023-02-03 18:21:33 +03:00
|
|
|
rb_hash_aset(rest, mem, Qtrue);
|
2013-04-13 05:20:34 +04:00
|
|
|
}
|
2016-04-16 04:00:13 +03:00
|
|
|
rest = rb_hash_keys(rest);
|
|
|
|
RBASIC_CLEAR_CLASS(rest);
|
2015-07-01 03:30:38 +03:00
|
|
|
OBJ_FREEZE_RAW(rest);
|
2013-04-13 05:20:34 +04:00
|
|
|
if (NIL_P(name)) {
|
|
|
|
st = anonymous_struct(klass);
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
st = new_struct(name, klass);
|
2008-05-05 14:52:44 +04:00
|
|
|
}
|
2020-05-08 06:58:19 +03:00
|
|
|
setup_struct(st, rest);
|
2017-12-12 11:12:43 +03:00
|
|
|
rb_ivar_set(st, id_keyword_init, keyword_init);
|
2004-03-10 10:05:19 +03:00
|
|
|
if (rb_block_given_p()) {
|
2019-09-29 23:15:04 +03:00
|
|
|
rb_mod_module_eval(0, 0, st);
|
2004-03-10 10:05:19 +03:00
|
|
|
}
|
1999-01-20 07:59:39 +03:00
|
|
|
|
|
|
|
return st;
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
|
|
|
|
2009-05-20 14:41:46 +04:00
|
|
|
static long
|
2008-06-27 16:56:45 +04:00
|
|
|
num_members(VALUE klass)
|
|
|
|
{
|
|
|
|
VALUE members;
|
2009-05-19 08:58:36 +04:00
|
|
|
members = struct_ivar_get(klass, id_members);
|
2011-09-29 15:07:45 +04:00
|
|
|
if (!RB_TYPE_P(members, T_ARRAY)) {
|
2008-06-27 16:56:45 +04:00
|
|
|
rb_raise(rb_eTypeError, "broken members");
|
|
|
|
}
|
|
|
|
return RARRAY_LEN(members);
|
|
|
|
}
|
|
|
|
|
2003-12-28 23:47:56 +03:00
|
|
|
/*
|
|
|
|
*/
|
|
|
|
|
2017-12-12 11:12:43 +03:00
|
|
|
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) {
|
2021-10-03 16:34:45 +03:00
|
|
|
if (NIL_P(args->unknown_keywords)) {
|
2017-12-12 11:12:43 +03:00
|
|
|
args->unknown_keywords = rb_ary_new();
|
|
|
|
}
|
|
|
|
rb_ary_push(args->unknown_keywords, key);
|
2017-12-12 18:12:05 +03:00
|
|
|
}
|
|
|
|
else {
|
2017-12-12 11:12:43 +03:00
|
|
|
rb_struct_modify(args->self);
|
|
|
|
RSTRUCT_SET(args->self, i, val);
|
|
|
|
}
|
|
|
|
return ST_CONTINUE;
|
|
|
|
}
|
|
|
|
|
2008-11-10 03:51:14 +03:00
|
|
|
static VALUE
|
2013-11-08 06:37:47 +04:00
|
|
|
rb_struct_initialize_m(int argc, const VALUE *argv, VALUE self)
|
1998-01-16 15:13:05 +03:00
|
|
|
{
|
2001-08-20 08:29:58 +04:00
|
|
|
VALUE klass = rb_obj_class(self);
|
2001-08-06 07:08:57 +04:00
|
|
|
rb_struct_modify(self);
|
2021-01-17 12:35:54 +03:00
|
|
|
long n = num_members(klass);
|
|
|
|
if (argc == 0) {
|
|
|
|
rb_mem_clear((VALUE *)RSTRUCT_CONST_PTR(self), n);
|
|
|
|
return Qnil;
|
|
|
|
}
|
|
|
|
|
2021-12-26 16:39:48 +03:00
|
|
|
bool keyword_init = false;
|
|
|
|
switch (rb_struct_s_keyword_init(klass)) {
|
|
|
|
default:
|
2019-10-30 03:08:01 +03:00
|
|
|
if (argc > 1 || !RB_TYPE_P(argv[0], T_HASH)) {
|
2022-10-01 10:18:03 +03:00
|
|
|
rb_error_arity(argc, 0, 0);
|
2017-12-12 11:12:43 +03:00
|
|
|
}
|
2021-12-26 16:39:48 +03:00
|
|
|
keyword_init = true;
|
|
|
|
break;
|
|
|
|
case Qfalse:
|
|
|
|
break;
|
|
|
|
case Qnil:
|
|
|
|
if (argc > 1 || !RB_TYPE_P(argv[0], T_HASH)) {
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
keyword_init = rb_keyword_given_p();
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
if (keyword_init) {
|
|
|
|
struct struct_hash_set_arg arg;
|
2017-12-12 11:12:43 +03:00
|
|
|
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(", "))));
|
|
|
|
}
|
2017-12-12 18:12:05 +03:00
|
|
|
}
|
|
|
|
else {
|
2017-12-12 11:12:43 +03:00
|
|
|
if (n < argc) {
|
|
|
|
rb_raise(rb_eArgError, "struct size differs");
|
|
|
|
}
|
2021-01-17 12:35:54 +03:00
|
|
|
for (long i=0; i<argc; i++) {
|
2017-12-12 11:12:43 +03:00
|
|
|
RSTRUCT_SET(self, i, argv[i]);
|
|
|
|
}
|
|
|
|
if (n > argc) {
|
|
|
|
rb_mem_clear((VALUE *)RSTRUCT_CONST_PTR(self)+argc, n-argc);
|
|
|
|
}
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
1999-08-13 09:45:20 +04:00
|
|
|
return Qnil;
|
|
|
|
}
|
|
|
|
|
2008-11-10 03:51:14 +03:00
|
|
|
VALUE
|
|
|
|
rb_struct_initialize(VALUE self, VALUE values)
|
|
|
|
{
|
2020-05-08 15:19:39 +03:00
|
|
|
rb_struct_initialize_m(RARRAY_LENINT(values), RARRAY_CONST_PTR(values), self);
|
2022-12-01 16:50:25 +03:00
|
|
|
if (rb_obj_is_kind_of(self, rb_cData)) OBJ_FREEZE_RAW(self);
|
2020-05-08 15:19:39 +03:00
|
|
|
RB_GC_GUARD(values);
|
|
|
|
return Qnil;
|
2008-11-10 03:51:14 +03:00
|
|
|
}
|
|
|
|
|
2018-10-31 01:03:42 +03:00
|
|
|
static VALUE *
|
|
|
|
struct_heap_alloc(VALUE st, size_t len)
|
|
|
|
{
|
|
|
|
VALUE *ptr = rb_transient_heap_alloc((VALUE)st, sizeof(VALUE) * len);
|
|
|
|
|
|
|
|
if (ptr) {
|
2018-11-01 11:53:44 +03:00
|
|
|
RSTRUCT_TRANSIENT_SET(st);
|
2018-10-31 01:03:42 +03:00
|
|
|
return ptr;
|
|
|
|
}
|
|
|
|
else {
|
2018-11-01 11:53:44 +03:00
|
|
|
RSTRUCT_TRANSIENT_UNSET(st);
|
2018-10-31 01:03:42 +03:00
|
|
|
return ALLOC_N(VALUE, len);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-11-01 11:53:44 +03:00
|
|
|
#if USE_TRANSIENT_HEAP
|
2018-10-31 01:03:42 +03:00
|
|
|
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;
|
|
|
|
}
|
|
|
|
}
|
2018-11-01 11:53:44 +03:00
|
|
|
#endif
|
2018-10-31 01:03:42 +03:00
|
|
|
|
1999-08-13 09:45:20 +04:00
|
|
|
static VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
struct_alloc(VALUE klass)
|
1999-08-13 09:45:20 +04:00
|
|
|
{
|
|
|
|
long n;
|
2023-02-17 18:51:16 +03:00
|
|
|
NEWOBJ_OF(st, struct RStruct, klass, T_STRUCT | (RGENGC_WB_PROTECTED_STRUCT ? FL_WB_PROTECTED : 0), sizeof(struct RStruct), 0);
|
1999-08-13 09:45:20 +04:00
|
|
|
|
2008-06-27 16:56:45 +04:00
|
|
|
n = num_members(klass);
|
1999-08-13 09:45:20 +04:00
|
|
|
|
2006-02-05 17:40:01 +03:00
|
|
|
if (0 < n && n <= RSTRUCT_EMBED_LEN_MAX) {
|
|
|
|
RBASIC(st)->flags &= ~RSTRUCT_EMBED_LEN_MASK;
|
|
|
|
RBASIC(st)->flags |= n << RSTRUCT_EMBED_LEN_SHIFT;
|
2013-06-21 15:22:18 +04:00
|
|
|
rb_mem_clear((VALUE *)st->as.ary, n);
|
2006-02-05 17:40:01 +03:00
|
|
|
}
|
|
|
|
else {
|
2018-10-31 01:03:42 +03:00
|
|
|
st->as.heap.ptr = struct_heap_alloc((VALUE)st, n);
|
|
|
|
rb_mem_clear((VALUE *)st->as.heap.ptr, n);
|
|
|
|
st->as.heap.len = n;
|
2006-02-05 17:40:01 +03:00
|
|
|
}
|
1999-08-13 09:45:20 +04:00
|
|
|
|
|
|
|
return (VALUE)st;
|
|
|
|
}
|
|
|
|
|
|
|
|
VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_alloc(VALUE klass, VALUE values)
|
1999-08-13 09:45:20 +04:00
|
|
|
{
|
2014-03-20 08:06:27 +04:00
|
|
|
return rb_class_new_instance(RARRAY_LENINT(values), RARRAY_CONST_PTR(values), klass);
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
VALUE
|
1999-01-20 07:59:39 +03:00
|
|
|
rb_struct_new(VALUE klass, ...)
|
1998-01-16 15:13:05 +03:00
|
|
|
{
|
2021-11-18 05:01:31 +03:00
|
|
|
VALUE tmpargs[16], *mem = tmpargs;
|
2009-05-20 20:43:41 +04:00
|
|
|
int size, i;
|
1998-01-16 15:13:05 +03:00
|
|
|
va_list args;
|
|
|
|
|
2009-05-20 20:43:41 +04:00
|
|
|
size = rb_long2int(num_members(klass));
|
2009-05-20 14:41:46 +04:00
|
|
|
if (size > numberof(tmpargs)) {
|
2022-07-25 17:40:45 +03:00
|
|
|
tmpargs[0] = rb_ary_hidden_new(size);
|
2009-05-20 14:41:46 +04:00
|
|
|
mem = RARRAY_PTR(tmpargs[0]);
|
|
|
|
}
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
va_start(args, klass);
|
1999-01-20 07:59:39 +03:00
|
|
|
for (i=0; i<size; i++) {
|
1999-08-13 09:45:20 +04:00
|
|
|
mem[i] = va_arg(args, VALUE);
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
|
|
|
va_end(args);
|
|
|
|
|
2001-10-03 11:19:19 +04:00
|
|
|
return rb_class_new_instance(size, mem, klass);
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
|
|
|
|
2013-06-26 17:43:22 +04:00
|
|
|
static VALUE
|
|
|
|
struct_enum_size(VALUE s, VALUE args, VALUE eobj)
|
|
|
|
{
|
|
|
|
return rb_struct_size(s);
|
|
|
|
}
|
|
|
|
|
2003-12-28 23:47:56 +03:00
|
|
|
/*
|
|
|
|
* call-seq:
|
2021-09-24 18:35:19 +03:00
|
|
|
* each {|value| ... } -> self
|
|
|
|
* each -> enumerator
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2021-09-24 18:35:19 +03:00
|
|
|
* Calls the given block with the value of each member; returns +self+:
|
2010-05-13 09:49:55 +04:00
|
|
|
*
|
2021-09-24 18:35:19 +03:00
|
|
|
* Customer = Struct.new(:name, :address, :zip)
|
|
|
|
* joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
|
|
|
|
* joe.each {|value| p value }
|
|
|
|
*
|
|
|
|
* Output:
|
|
|
|
*
|
|
|
|
* "Joe Smith"
|
|
|
|
* "123 Maple, Anytown NC"
|
|
|
|
* 12345
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2021-09-24 18:35:19 +03:00
|
|
|
* Returns an Enumerator if no block is given.
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2021-09-24 18:35:19 +03:00
|
|
|
* Related: #each_pair.
|
2003-12-28 23:47:56 +03:00
|
|
|
*/
|
|
|
|
|
1998-01-16 15:13:05 +03:00
|
|
|
static VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_each(VALUE s)
|
1998-01-16 15:13:05 +03:00
|
|
|
{
|
1999-08-13 09:45:20 +04:00
|
|
|
long i;
|
1998-01-16 15:13:05 +03:00
|
|
|
|
2013-06-26 17:43:22 +04:00
|
|
|
RETURN_SIZED_ENUMERATOR(s, 0, 0, struct_enum_size);
|
2006-02-05 17:40:01 +03:00
|
|
|
for (i=0; i<RSTRUCT_LEN(s); i++) {
|
2013-06-21 15:22:18 +04:00
|
|
|
rb_yield(RSTRUCT_GET(s, i));
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
1999-08-13 09:45:20 +04:00
|
|
|
return s;
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
|
|
|
|
2003-12-28 23:47:56 +03:00
|
|
|
/*
|
|
|
|
* call-seq:
|
2021-09-24 18:35:19 +03:00
|
|
|
* each_pair {|(name, value)| ... } -> self
|
|
|
|
* each_pair -> enumerator
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2021-09-24 18:35:19 +03:00
|
|
|
* Calls the given block with each member name/value pair; returns +self+:
|
2010-05-13 09:49:55 +04:00
|
|
|
*
|
2021-09-24 18:35:19 +03:00
|
|
|
* 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}" }
|
|
|
|
*
|
|
|
|
* Output:
|
|
|
|
*
|
|
|
|
* "name => Joe Smith"
|
|
|
|
* "address => 123 Maple, Anytown NC"
|
|
|
|
* "zip => 12345"
|
|
|
|
*
|
|
|
|
* Returns an Enumerator if no block is given.
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2021-09-24 18:35:19 +03:00
|
|
|
* Related: #each.
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2003-12-28 23:47:56 +03:00
|
|
|
*/
|
|
|
|
|
2002-04-10 12:45:26 +04:00
|
|
|
static VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_each_pair(VALUE s)
|
2002-04-10 12:45:26 +04:00
|
|
|
{
|
2004-09-24 09:53:43 +04:00
|
|
|
VALUE members;
|
2002-04-10 12:45:26 +04:00
|
|
|
long i;
|
|
|
|
|
2013-06-26 17:43:22 +04:00
|
|
|
RETURN_SIZED_ENUMERATOR(s, 0, 0, struct_enum_size);
|
2004-09-27 08:46:54 +04:00
|
|
|
members = rb_struct_members(s);
|
2020-03-16 17:03:22 +03:00
|
|
|
if (rb_block_pair_yield_optimizable()) {
|
2017-10-02 10:51:27 +03:00
|
|
|
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));
|
|
|
|
}
|
2002-04-10 12:45:26 +04:00
|
|
|
}
|
|
|
|
return s;
|
|
|
|
}
|
|
|
|
|
1998-01-16 15:13:05 +03:00
|
|
|
static VALUE
|
2022-09-30 12:23:19 +03:00
|
|
|
inspect_struct(VALUE s, VALUE prefix, int recur)
|
1998-01-16 15:13:05 +03:00
|
|
|
{
|
2014-08-21 08:39:28 +04:00
|
|
|
VALUE cname = rb_class_path(rb_obj_class(s));
|
2022-09-30 12:23:19 +03:00
|
|
|
VALUE members;
|
|
|
|
VALUE str = prefix;
|
* array.c (rb_ary_{times, shuffle_bang, sample}): reducing macro
calls inside of the loop by keeping pointers in local
variables. a patch from Masahiro Kanai (CanI) in [ruby-dev:39406].
It was found and fixed at Security and Programming camp 2009.
* string.c (rb_str_{times, split_m}): ditto.
* struct.c (rb_struct_{getmember, set, aref_id, aset_id}, {make,
inspect}_struct, recursive_{equal, hash, eql}): ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@25237 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2009-10-05 18:35:39 +04:00
|
|
|
long i, len;
|
2009-08-12 10:32:21 +04:00
|
|
|
char first = RSTRING_PTR(cname)[0];
|
1998-01-16 15:13:05 +03:00
|
|
|
|
2009-08-12 10:32:21 +04:00
|
|
|
if (recur || first != '#') {
|
|
|
|
rb_str_append(str, cname);
|
|
|
|
}
|
* array.c: replace rb_protect_inspect() and rb_inspecting_p() by
rb_exec_recursive() in eval.c.
* eval.c (rb_exec_recursive): new function.
* array.c (rb_ary_join): use rb_exec_recursive().
* array.c (rb_ary_inspect, rb_ary_hash): ditto.
* file.c (rb_file_join): ditto.
* hash.c (rb_hash_inspect, rb_hash_to_s, rb_hash_hash): ditto.
* io.c (rb_io_puts): ditto.
* object.c (rb_obj_inspect): ditto
* struct.c (rb_struct_inspect): ditto.
* lib/set.rb (SortedSet::setup): a hack to shut up warning.
[ruby-talk:132866]
* lib/time.rb (Time::strptime): add new function. inspired by
[ruby-talk:132815].
* lib/parsedate.rb (ParseDate::strptime): ditto.
* regparse.c: move st_*_strend() functions from st.c. fixed some
potential memory leaks.
* exception error messages updated. [ruby-core:04497]
* ext/socket/socket.c (Init_socket): add bunch of Socket
constants. Patch from Sam Roberts <sroberts@uniserve.com>.
[ruby-core:04409]
* array.c (rb_ary_s_create): no need for negative argc check.
[ruby-core:04463]
* array.c (rb_ary_unshift_m): ditto.
* lib/xmlrpc/parser.rb (XMLRPC::FaultException): make it subclass
of StandardError class, not Exception class. [ruby-core:04429]
* parse.y (fcall_gen): lvar(arg) will be evaluated as
lvar.call(arg) when lvar is a defined local variable. [new]
* object.c (rb_class_initialize): call inherited method before
calling initializing block.
* eval.c (rb_thread_start_1): initialize newly pushed frame.
* lib/open3.rb (Open3::popen3): $? should not be EXIT_FAILURE.
fixed: [ruby-core:04444]
* eval.c (is_defined): NODE_IASGN is an assignment.
* ext/readline/readline.c (Readline.readline): use rl_outstream
and rl_instream. [ruby-dev:25699]
* ext/etc/etc.c (Init_etc): sGroup needs HAVE_ST_GR_PASSWD check
[ruby-dev:25675]
* misc/ruby-mode.el: [ruby-core:04415]
* lib/rdoc/generators/html_generator.rb: [ruby-core:04412]
* lib/rdoc/generators/ri_generator.rb: ditto.
* struct.c (make_struct): fixed: [ruby-core:04402]
* ext/curses/curses.c (window_color_set): [ruby-core:04393]
* ext/socket/socket.c (Init_socket): SO_REUSEPORT added.
[ruby-talk:130092]
* object.c: [ruby-doc:818]
* parse.y (open_args): fix too verbose warnings for the space
before argument parentheses. [ruby-dev:25492]
* parse.y (parser_yylex): ditto.
* parse.y (parser_yylex): the first expression in the parentheses
should not be a command. [ruby-dev:25492]
* lib/irb/context.rb (IRB::Context::initialize): [ruby-core:04330]
* object.c (Init_Object): remove Object#type. [ruby-core:04335]
* st.c (st_foreach): report success/failure by return value.
[ruby-Bugs-1396]
* parse.y: forgot to initialize parser struct. [ruby-dev:25492]
* parse.y (parser_yylex): no tLABEL on EXPR_BEG.
[ruby-talk:127711]
* document updates - [ruby-core:04296], [ruby-core:04301],
[ruby-core:04302], [ruby-core:04307]
* dir.c (rb_push_glob): should work for NUL delimited patterns.
* dir.c (rb_glob2): should aware of offset in the pattern.
* string.c (rb_str_new4): should propagate taintedness.
* env.h: rename member names in struct FRAME; last_func -> callee,
orig_func -> this_func, last_class -> this_class.
* struct.c (rb_struct_set): use original method name, not callee
name, to retrieve member slot. [ruby-core:04268]
* time.c (time_strftime): protect from format modification from GC
finalizers.
* object.c (Init_Object): remove rb_obj_id_obsolete()
* eval.c (rb_mod_define_method): incomplete subclass check.
[ruby-dev:25464]
* gc.c (rb_data_object_alloc): klass may be NULL.
[ruby-list:40498]
* bignum.c (rb_big_rand): should return positive random number.
[ruby-dev:25401]
* bignum.c (rb_big_rand): do not use rb_big_modulo to generate
random bignums. [ruby-dev:25396]
* variable.c (rb_autoload): [ruby-dev:25373]
* eval.c (svalue_to_avalue): [ruby-dev:25366]
* string.c (rb_str_justify): [ruby-dev:25367]
* io.c (rb_f_select): [ruby-dev:25312]
* ext/socket/socket.c (sock_s_getservbyport): [ruby-talk:124072]
* struct.c (make_struct): [ruby-dev:25249]
* dir.c (dir_open_dir): new function. [ruby-dev:25242]
* io.c (rb_f_open): add type check for return value from to_open.
* lib/pstore.rb (PStore#transaction): Use the empty content when a
file is not found. [ruby-dev:24561]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@8068 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-03-04 09:47:45 +03:00
|
|
|
if (recur) {
|
2009-08-12 10:32:21 +04:00
|
|
|
return rb_str_cat2(str, ":...>");
|
* array.c: replace rb_protect_inspect() and rb_inspecting_p() by
rb_exec_recursive() in eval.c.
* eval.c (rb_exec_recursive): new function.
* array.c (rb_ary_join): use rb_exec_recursive().
* array.c (rb_ary_inspect, rb_ary_hash): ditto.
* file.c (rb_file_join): ditto.
* hash.c (rb_hash_inspect, rb_hash_to_s, rb_hash_hash): ditto.
* io.c (rb_io_puts): ditto.
* object.c (rb_obj_inspect): ditto
* struct.c (rb_struct_inspect): ditto.
* lib/set.rb (SortedSet::setup): a hack to shut up warning.
[ruby-talk:132866]
* lib/time.rb (Time::strptime): add new function. inspired by
[ruby-talk:132815].
* lib/parsedate.rb (ParseDate::strptime): ditto.
* regparse.c: move st_*_strend() functions from st.c. fixed some
potential memory leaks.
* exception error messages updated. [ruby-core:04497]
* ext/socket/socket.c (Init_socket): add bunch of Socket
constants. Patch from Sam Roberts <sroberts@uniserve.com>.
[ruby-core:04409]
* array.c (rb_ary_s_create): no need for negative argc check.
[ruby-core:04463]
* array.c (rb_ary_unshift_m): ditto.
* lib/xmlrpc/parser.rb (XMLRPC::FaultException): make it subclass
of StandardError class, not Exception class. [ruby-core:04429]
* parse.y (fcall_gen): lvar(arg) will be evaluated as
lvar.call(arg) when lvar is a defined local variable. [new]
* object.c (rb_class_initialize): call inherited method before
calling initializing block.
* eval.c (rb_thread_start_1): initialize newly pushed frame.
* lib/open3.rb (Open3::popen3): $? should not be EXIT_FAILURE.
fixed: [ruby-core:04444]
* eval.c (is_defined): NODE_IASGN is an assignment.
* ext/readline/readline.c (Readline.readline): use rl_outstream
and rl_instream. [ruby-dev:25699]
* ext/etc/etc.c (Init_etc): sGroup needs HAVE_ST_GR_PASSWD check
[ruby-dev:25675]
* misc/ruby-mode.el: [ruby-core:04415]
* lib/rdoc/generators/html_generator.rb: [ruby-core:04412]
* lib/rdoc/generators/ri_generator.rb: ditto.
* struct.c (make_struct): fixed: [ruby-core:04402]
* ext/curses/curses.c (window_color_set): [ruby-core:04393]
* ext/socket/socket.c (Init_socket): SO_REUSEPORT added.
[ruby-talk:130092]
* object.c: [ruby-doc:818]
* parse.y (open_args): fix too verbose warnings for the space
before argument parentheses. [ruby-dev:25492]
* parse.y (parser_yylex): ditto.
* parse.y (parser_yylex): the first expression in the parentheses
should not be a command. [ruby-dev:25492]
* lib/irb/context.rb (IRB::Context::initialize): [ruby-core:04330]
* object.c (Init_Object): remove Object#type. [ruby-core:04335]
* st.c (st_foreach): report success/failure by return value.
[ruby-Bugs-1396]
* parse.y: forgot to initialize parser struct. [ruby-dev:25492]
* parse.y (parser_yylex): no tLABEL on EXPR_BEG.
[ruby-talk:127711]
* document updates - [ruby-core:04296], [ruby-core:04301],
[ruby-core:04302], [ruby-core:04307]
* dir.c (rb_push_glob): should work for NUL delimited patterns.
* dir.c (rb_glob2): should aware of offset in the pattern.
* string.c (rb_str_new4): should propagate taintedness.
* env.h: rename member names in struct FRAME; last_func -> callee,
orig_func -> this_func, last_class -> this_class.
* struct.c (rb_struct_set): use original method name, not callee
name, to retrieve member slot. [ruby-core:04268]
* time.c (time_strftime): protect from format modification from GC
finalizers.
* object.c (Init_Object): remove rb_obj_id_obsolete()
* eval.c (rb_mod_define_method): incomplete subclass check.
[ruby-dev:25464]
* gc.c (rb_data_object_alloc): klass may be NULL.
[ruby-list:40498]
* bignum.c (rb_big_rand): should return positive random number.
[ruby-dev:25401]
* bignum.c (rb_big_rand): do not use rb_big_modulo to generate
random bignums. [ruby-dev:25396]
* variable.c (rb_autoload): [ruby-dev:25373]
* eval.c (svalue_to_avalue): [ruby-dev:25366]
* string.c (rb_str_justify): [ruby-dev:25367]
* io.c (rb_f_select): [ruby-dev:25312]
* ext/socket/socket.c (sock_s_getservbyport): [ruby-talk:124072]
* struct.c (make_struct): [ruby-dev:25249]
* dir.c (dir_open_dir): new function. [ruby-dev:25242]
* io.c (rb_f_open): add type check for return value from to_open.
* lib/pstore.rb (PStore#transaction): Use the empty content when a
file is not found. [ruby-dev:24561]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@8068 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-03-04 09:47:45 +03:00
|
|
|
}
|
|
|
|
|
2004-09-27 08:46:54 +04:00
|
|
|
members = rb_struct_members(s);
|
* array.c (rb_ary_{times, shuffle_bang, sample}): reducing macro
calls inside of the loop by keeping pointers in local
variables. a patch from Masahiro Kanai (CanI) in [ruby-dev:39406].
It was found and fixed at Security and Programming camp 2009.
* string.c (rb_str_{times, split_m}): ditto.
* struct.c (rb_struct_{getmember, set, aref_id, aset_id}, {make,
inspect}_struct, recursive_{equal, hash, eql}): ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@25237 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2009-10-05 18:35:39 +04:00
|
|
|
len = RSTRUCT_LEN(s);
|
2013-06-21 15:22:18 +04:00
|
|
|
|
* array.c (rb_ary_{times, shuffle_bang, sample}): reducing macro
calls inside of the loop by keeping pointers in local
variables. a patch from Masahiro Kanai (CanI) in [ruby-dev:39406].
It was found and fixed at Security and Programming camp 2009.
* string.c (rb_str_{times, split_m}): ditto.
* struct.c (rb_struct_{getmember, set, aref_id, aset_id}, {make,
inspect}_struct, recursive_{equal, hash, eql}): ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@25237 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2009-10-05 18:35:39 +04:00
|
|
|
for (i=0; i<len; i++) {
|
2005-03-17 11:56:36 +03:00
|
|
|
VALUE slot;
|
|
|
|
ID id;
|
2022-07-21 19:23:58 +03:00
|
|
|
|
1998-01-16 15:13:05 +03:00
|
|
|
if (i > 0) {
|
2000-04-10 09:48:43 +04:00
|
|
|
rb_str_cat2(str, ", ");
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
2009-08-12 10:32:21 +04:00
|
|
|
else if (first != '#') {
|
|
|
|
rb_str_cat2(str, " ");
|
|
|
|
}
|
2013-06-21 15:22:18 +04:00
|
|
|
slot = RARRAY_AREF(members, i);
|
2005-03-17 11:56:36 +03:00
|
|
|
id = SYM2ID(slot);
|
2005-04-18 10:38:30 +04:00
|
|
|
if (rb_is_local_id(id) || rb_is_const_id(id)) {
|
2007-12-24 19:38:44 +03:00
|
|
|
rb_str_append(str, rb_id2str(id));
|
2005-03-17 11:56:36 +03:00
|
|
|
}
|
|
|
|
else {
|
|
|
|
rb_str_append(str, rb_inspect(slot));
|
|
|
|
}
|
2000-04-10 09:48:43 +04:00
|
|
|
rb_str_cat2(str, "=");
|
2013-06-21 15:22:18 +04:00
|
|
|
rb_str_append(str, rb_inspect(RSTRUCT_GET(s, i)));
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
2000-04-10 09:48:43 +04:00
|
|
|
rb_str_cat2(str, ">");
|
1998-01-16 15:13:05 +03:00
|
|
|
|
|
|
|
return str;
|
|
|
|
}
|
|
|
|
|
2003-12-28 23:47:56 +03:00
|
|
|
/*
|
2021-09-24 18:35:19 +03:00
|
|
|
* 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>"
|
|
|
|
*
|
2003-12-28 23:47:56 +03:00
|
|
|
*/
|
|
|
|
|
1998-01-16 15:13:05 +03:00
|
|
|
static VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_inspect(VALUE s)
|
1998-01-16 15:13:05 +03:00
|
|
|
{
|
2022-09-30 12:23:19 +03:00
|
|
|
return rb_exec_recursive(inspect_struct, s, rb_str_new2("#<struct "));
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
|
|
|
|
2003-12-28 23:47:56 +03:00
|
|
|
/*
|
|
|
|
* call-seq:
|
2021-09-24 18:35:19 +03:00
|
|
|
* to_a -> array
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2021-09-24 18:35:19 +03:00
|
|
|
* Returns the values in +self+ as an array:
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2021-09-24 18:35:19 +03:00
|
|
|
* 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]
|
|
|
|
*
|
|
|
|
* Related: #members.
|
2003-12-28 23:47:56 +03:00
|
|
|
*/
|
|
|
|
|
1998-01-16 15:13:05 +03:00
|
|
|
static VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_to_a(VALUE s)
|
1999-01-20 07:59:39 +03:00
|
|
|
{
|
* include/ruby/ruby.h: rename RARRAY_RAWPTR() to RARRAY_CONST_PTR().
RARRAY_RAWPTR(ary) returns (const VALUE *) type pointer and
usecase of this macro is not acquire raw pointer, but acquire
read-only pointer. So we rename to better name.
RSTRUCT_RAWPTR() is also renamed to RSTRUCT_CONST_PTR()
(I expect that nobody use it).
* array.c, compile.c, cont.c, enumerator.c, gc.c, proc.c, random.c,
string.c, struct.c, thread.c, vm_eval.c, vm_insnhelper.c:
catch up this change.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@43043 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-09-25 12:24:34 +04:00
|
|
|
return rb_ary_new4(RSTRUCT_LEN(s), RSTRUCT_CONST_PTR(s));
|
1999-01-20 07:59:39 +03:00
|
|
|
}
|
|
|
|
|
2012-04-24 07:46:55 +04:00
|
|
|
/*
|
|
|
|
* call-seq:
|
2021-09-24 18:35:19 +03:00
|
|
|
* to_h -> hash
|
|
|
|
* to_h {|name, value| ... } -> hash
|
2012-04-24 07:46:55 +04:00
|
|
|
*
|
2021-09-24 18:35:19 +03:00
|
|
|
* Returns a hash containing the name and value for each member:
|
2012-04-24 07:46:55 +04:00
|
|
|
*
|
2021-09-24 18:35:19 +03:00
|
|
|
* 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.
|
2018-12-23 06:43:45 +03:00
|
|
|
*
|
2012-04-24 07:46:55 +04:00
|
|
|
*/
|
|
|
|
|
|
|
|
static VALUE
|
|
|
|
rb_struct_to_h(VALUE s)
|
|
|
|
{
|
2017-10-01 07:26:25 +03:00
|
|
|
VALUE h = rb_hash_new_with_size(RSTRUCT_LEN(s));
|
2012-04-24 07:46:55 +04:00
|
|
|
VALUE members = rb_struct_members(s);
|
|
|
|
long i;
|
2018-09-20 18:06:56 +03:00
|
|
|
int block_given = rb_block_given_p();
|
2012-04-24 07:46:55 +04:00
|
|
|
|
|
|
|
for (i=0; i<RSTRUCT_LEN(s); i++) {
|
2018-09-20 18:06:56 +03:00
|
|
|
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);
|
2012-04-24 07:46:55 +04:00
|
|
|
}
|
|
|
|
return h;
|
|
|
|
}
|
|
|
|
|
2021-09-28 02:17:47 +03:00
|
|
|
/*
|
|
|
|
* 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}
|
|
|
|
*
|
|
|
|
*/
|
2019-11-08 05:37:07 +03:00
|
|
|
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));
|
|
|
|
|
|
|
|
}
|
2019-11-19 17:53:01 +03:00
|
|
|
if (RSTRUCT_LEN(s) < RARRAY_LEN(keys)) {
|
|
|
|
return rb_hash_new_with_size(0);
|
|
|
|
}
|
2019-11-08 05:37:07 +03:00
|
|
|
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) {
|
2019-11-19 17:53:01 +03:00
|
|
|
return h;
|
2019-11-08 05:37:07 +03:00
|
|
|
}
|
|
|
|
rb_hash_aset(h, key, RSTRUCT_GET(s, i));
|
|
|
|
}
|
|
|
|
return h;
|
|
|
|
}
|
|
|
|
|
2004-01-18 17:16:47 +03:00
|
|
|
/* :nodoc: */
|
2008-08-21 01:02:54 +04:00
|
|
|
VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_init_copy(VALUE copy, VALUE s)
|
1998-01-16 15:13:05 +03:00
|
|
|
{
|
2013-06-21 15:22:18 +04:00
|
|
|
long i, len;
|
|
|
|
|
2012-06-05 15:13:18 +04:00
|
|
|
if (!OBJ_INIT_COPY(copy, s)) return copy;
|
2007-07-12 12:03:18 +04:00
|
|
|
if (RSTRUCT_LEN(copy) != RSTRUCT_LEN(s)) {
|
|
|
|
rb_raise(rb_eTypeError, "struct size mismatch");
|
2006-02-05 17:40:01 +03:00
|
|
|
}
|
2013-06-21 15:22:18 +04:00
|
|
|
|
|
|
|
for (i=0, len=RSTRUCT_LEN(copy); i<len; i++) {
|
|
|
|
RSTRUCT_SET(copy, i, RSTRUCT_GET(s, i));
|
|
|
|
}
|
2000-01-05 07:41:21 +03:00
|
|
|
|
2002-09-03 09:20:14 +04:00
|
|
|
return copy;
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
|
|
|
|
2015-11-16 08:46:50 +03:00
|
|
|
static int
|
|
|
|
rb_struct_pos(VALUE s, VALUE *name)
|
1999-01-20 07:59:39 +03:00
|
|
|
{
|
2015-11-16 08:46:50 +03:00
|
|
|
long i;
|
|
|
|
VALUE idx = *name;
|
|
|
|
|
2021-09-02 06:15:21 +03:00
|
|
|
if (SYMBOL_P(idx)) {
|
2015-11-16 08:46:50 +03:00
|
|
|
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;
|
1999-01-20 07:59:39 +03:00
|
|
|
}
|
2015-11-16 08:46:50 +03:00
|
|
|
}
|
2012-04-14 04:36:26 +04:00
|
|
|
|
2015-11-16 08:46:50 +03:00
|
|
|
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);
|
|
|
|
}
|
1999-01-20 07:59:39 +03:00
|
|
|
}
|
|
|
|
|
2003-12-28 23:47:56 +03:00
|
|
|
/*
|
|
|
|
* call-seq:
|
2021-09-24 18:35:19 +03:00
|
|
|
* struct[name] -> object
|
|
|
|
* struct[n] -> object
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2021-09-24 18:35:19 +03:00
|
|
|
* Returns a value from +self+.
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2021-09-24 18:35:19 +03:00
|
|
|
* 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;
|
2022-02-06 18:44:40 +03:00
|
|
|
* see Array@Array+Indexes:
|
2021-09-24 18:35:19 +03:00
|
|
|
*
|
|
|
|
* joe[2] # => 12345
|
|
|
|
* joe[-2] # => "123 Maple, Anytown NC"
|
|
|
|
*
|
|
|
|
* Raises IndexError if +n+ is out of range.
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2003-12-28 23:47:56 +03:00
|
|
|
*/
|
|
|
|
|
1998-01-16 15:13:05 +03:00
|
|
|
VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_aref(VALUE s, VALUE idx)
|
1998-01-16 15:13:05 +03:00
|
|
|
{
|
2015-11-16 08:46:50 +03:00
|
|
|
int i = rb_struct_pos(s, &idx);
|
|
|
|
if (i < 0) invalid_struct_pos(s, idx);
|
2013-06-21 15:22:18 +04:00
|
|
|
return RSTRUCT_GET(s, i);
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
|
|
|
|
2003-12-28 23:47:56 +03:00
|
|
|
/*
|
|
|
|
* call-seq:
|
2021-09-24 18:35:19 +03:00
|
|
|
* struct[name] = value -> value
|
|
|
|
* struct[n] = value -> value
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2021-09-24 18:35:19 +03:00
|
|
|
* Assigns a value to a member.
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2021-09-24 18:35:19 +03:00
|
|
|
* 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.
|
|
|
|
*
|
|
|
|
* With integer argument +n+ given, assigns the given +value+
|
2021-10-24 18:55:45 +03:00
|
|
|
* to the +n+-th member if +n+ is in range;
|
2022-02-06 18:44:40 +03:00
|
|
|
* see Array@Array+Indexes:
|
2021-09-24 18:35:19 +03:00
|
|
|
*
|
|
|
|
* 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>
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2021-09-24 18:35:19 +03:00
|
|
|
* Raises IndexError if +n+ is out of range.
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2003-12-28 23:47:56 +03:00
|
|
|
*/
|
|
|
|
|
1998-01-16 15:13:05 +03:00
|
|
|
VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_aset(VALUE s, VALUE idx, VALUE val)
|
1998-01-16 15:13:05 +03:00
|
|
|
{
|
2015-11-16 08:46:50 +03:00
|
|
|
int i = rb_struct_pos(s, &idx);
|
|
|
|
if (i < 0) invalid_struct_pos(s, idx);
|
2001-08-06 07:08:57 +04:00
|
|
|
rb_struct_modify(s);
|
2013-06-21 15:22:18 +04:00
|
|
|
RSTRUCT_SET(s, i, val);
|
|
|
|
return val;
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
|
|
|
|
2015-11-16 12:21:56 +03:00
|
|
|
FUNC_MINIMIZED(VALUE rb_struct_lookup(VALUE s, VALUE idx));
|
|
|
|
NOINLINE(static VALUE rb_struct_lookup_default(VALUE s, VALUE idx, VALUE notfound));
|
|
|
|
|
|
|
|
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);
|
|
|
|
}
|
|
|
|
|
2003-07-03 15:02:53 +04:00
|
|
|
static VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
struct_entry(VALUE s, long n)
|
2003-07-03 15:02:53 +04:00
|
|
|
{
|
|
|
|
return rb_struct_aref(s, LONG2NUM(n));
|
|
|
|
}
|
|
|
|
|
2009-02-22 17:23:33 +03:00
|
|
|
/*
|
2013-06-12 02:17:02 +04:00
|
|
|
* call-seq:
|
2021-09-25 02:41:02 +03:00
|
|
|
* values_at(*integers) -> array
|
|
|
|
* values_at(integer_range) -> array
|
2013-06-12 02:17:02 +04:00
|
|
|
*
|
2021-09-25 02:41:02 +03:00
|
|
|
* Returns an array of values from +self+.
|
2013-06-12 02:17:02 +04:00
|
|
|
*
|
2021-09-25 02:41:02 +03:00
|
|
|
* 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;
|
2022-02-06 18:44:40 +03:00
|
|
|
* see Array@Array+Indexes.
|
2021-09-25 02:41:02 +03:00
|
|
|
*
|
|
|
|
* 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;
|
2022-02-06 18:44:40 +03:00
|
|
|
* see Array@Array+Indexes.
|
2013-06-12 02:17:02 +04:00
|
|
|
*
|
2003-12-28 23:47:56 +03:00
|
|
|
*/
|
|
|
|
|
2003-05-04 20:03:24 +04:00
|
|
|
static VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_values_at(int argc, VALUE *argv, VALUE s)
|
2003-05-04 20:03:24 +04:00
|
|
|
{
|
2006-02-05 17:40:01 +03:00
|
|
|
return rb_get_values_at(s, RSTRUCT_LEN(s), argc, argv, struct_entry);
|
2003-05-04 20:03:24 +04:00
|
|
|
}
|
2001-12-11 06:48:08 +03:00
|
|
|
|
2003-12-28 23:47:56 +03:00
|
|
|
/*
|
|
|
|
* call-seq:
|
2021-09-25 02:41:02 +03:00
|
|
|
* select {|value| ... } -> array
|
|
|
|
* select -> enumerator
|
|
|
|
*
|
|
|
|
* With a block given, returns an array of values from +self+
|
|
|
|
* for which the block returns a truthy value:
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2021-09-25 02:41:02 +03:00
|
|
|
* 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]
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2021-09-25 02:41:02 +03:00
|
|
|
* With no block given, returns an Enumerator.
|
2003-12-28 23:47:56 +03:00
|
|
|
*/
|
|
|
|
|
2001-12-11 06:48:08 +03:00
|
|
|
static VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_select(int argc, VALUE *argv, VALUE s)
|
2001-12-11 06:48:08 +03:00
|
|
|
{
|
2003-05-04 20:03:24 +04:00
|
|
|
VALUE result;
|
2001-12-11 06:48:08 +03:00
|
|
|
long i;
|
|
|
|
|
2012-03-15 01:10:34 +04:00
|
|
|
rb_check_arity(argc, 0, 0);
|
2013-06-26 17:43:22 +04:00
|
|
|
RETURN_SIZED_ENUMERATOR(s, 0, 0, struct_enum_size);
|
2003-05-04 20:03:24 +04:00
|
|
|
result = rb_ary_new();
|
2006-02-05 17:40:01 +03:00
|
|
|
for (i = 0; i < RSTRUCT_LEN(s); i++) {
|
2013-06-21 15:22:18 +04:00
|
|
|
if (RTEST(rb_yield(RSTRUCT_GET(s, i)))) {
|
|
|
|
rb_ary_push(result, RSTRUCT_GET(s, i));
|
2001-12-11 06:48:08 +03:00
|
|
|
}
|
|
|
|
}
|
2003-05-04 20:03:24 +04:00
|
|
|
|
2001-12-11 06:48:08 +03:00
|
|
|
return result;
|
|
|
|
}
|
|
|
|
|
2009-09-20 06:14:02 +04:00
|
|
|
static VALUE
|
|
|
|
recursive_equal(VALUE s, VALUE s2, int recur)
|
|
|
|
{
|
* array.c (rb_ary_{times, shuffle_bang, sample}): reducing macro
calls inside of the loop by keeping pointers in local
variables. a patch from Masahiro Kanai (CanI) in [ruby-dev:39406].
It was found and fixed at Security and Programming camp 2009.
* string.c (rb_str_{times, split_m}): ditto.
* struct.c (rb_struct_{getmember, set, aref_id, aset_id}, {make,
inspect}_struct, recursive_{equal, hash, eql}): ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@25237 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2009-10-05 18:35:39 +04:00
|
|
|
long i, len;
|
2009-09-20 06:14:02 +04:00
|
|
|
|
|
|
|
if (recur) return Qtrue; /* Subtle! */
|
* array.c (rb_ary_{times, shuffle_bang, sample}): reducing macro
calls inside of the loop by keeping pointers in local
variables. a patch from Masahiro Kanai (CanI) in [ruby-dev:39406].
It was found and fixed at Security and Programming camp 2009.
* string.c (rb_str_{times, split_m}): ditto.
* struct.c (rb_struct_{getmember, set, aref_id, aset_id}, {make,
inspect}_struct, recursive_{equal, hash, eql}): ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@25237 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2009-10-05 18:35:39 +04:00
|
|
|
len = RSTRUCT_LEN(s);
|
|
|
|
for (i=0; i<len; i++) {
|
2018-11-05 11:02:31 +03:00
|
|
|
if (!rb_equal(RSTRUCT_GET(s, i), RSTRUCT_GET(s2, i))) return Qfalse;
|
2009-09-20 06:14:02 +04:00
|
|
|
}
|
|
|
|
return Qtrue;
|
|
|
|
}
|
|
|
|
|
2021-09-25 02:41:02 +03:00
|
|
|
|
2003-12-28 23:47:56 +03:00
|
|
|
/*
|
|
|
|
* call-seq:
|
2021-09-25 02:41:02 +03:00
|
|
|
* self == other -> true or false
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2021-09-25 02:41:02 +03:00
|
|
|
* Returns +true+ if and only if the following are true; otherwise returns +false+:
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2021-09-25 02:41:02 +03:00
|
|
|
* - <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
|
2003-12-28 23:47:56 +03:00
|
|
|
*/
|
|
|
|
|
1998-01-16 15:13:05 +03:00
|
|
|
static VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_equal(VALUE s, VALUE s2)
|
1998-01-16 15:13:05 +03:00
|
|
|
{
|
2001-08-29 10:28:51 +04:00
|
|
|
if (s == s2) return Qtrue;
|
2011-09-29 15:07:45 +04:00
|
|
|
if (!RB_TYPE_P(s2, T_STRUCT)) return Qfalse;
|
2001-08-20 08:29:58 +04:00
|
|
|
if (rb_obj_class(s) != rb_obj_class(s2)) return Qfalse;
|
2006-02-05 17:40:01 +03:00
|
|
|
if (RSTRUCT_LEN(s) != RSTRUCT_LEN(s2)) {
|
1999-01-20 07:59:39 +03:00
|
|
|
rb_bug("inconsistent struct"); /* should never happen */
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
|
|
|
|
2009-09-20 06:14:02 +04:00
|
|
|
return rb_exec_recursive_paired(recursive_equal, s, s2, s2);
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|
|
|
|
|
2013-12-03 17:18:30 +04:00
|
|
|
/*
|
2021-09-25 02:41:02 +03:00
|
|
|
* call-seq:
|
|
|
|
* hash -> integer
|
2013-12-03 17:18:30 +04:00
|
|
|
*
|
2021-09-25 02:41:02 +03:00
|
|
|
* Returns the integer hash value for +self+.
|
2014-03-14 05:27:43 +04:00
|
|
|
*
|
2021-09-25 02:41:02 +03:00
|
|
|
* 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.
|
2013-12-03 17:18:30 +04:00
|
|
|
*/
|
|
|
|
|
2003-04-15 14:12:25 +04:00
|
|
|
static VALUE
|
2013-12-03 17:18:30 +04:00
|
|
|
rb_struct_hash(VALUE s)
|
2003-04-15 14:12:25 +04:00
|
|
|
{
|
* array.c (rb_ary_{times, shuffle_bang, sample}): reducing macro
calls inside of the loop by keeping pointers in local
variables. a patch from Masahiro Kanai (CanI) in [ruby-dev:39406].
It was found and fixed at Security and Programming camp 2009.
* string.c (rb_str_{times, split_m}): ditto.
* struct.c (rb_struct_{getmember, set, aref_id, aset_id}, {make,
inspect}_struct, recursive_{equal, hash, eql}): ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@25237 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2009-10-05 18:35:39 +04:00
|
|
|
long i, len;
|
2009-09-08 17:10:04 +04:00
|
|
|
st_index_t h;
|
2013-06-21 15:22:18 +04:00
|
|
|
VALUE n;
|
2003-04-15 14:12:25 +04:00
|
|
|
|
* string.c (rb_hash_uint32, rb_hash_uint, rb_hash_start, rb_hash_end),
include/ruby/intern.h: add Murmurhash API. [ruby-dev:37784]
* complex.c (nucomp_hash), array.c (rb_ary_hash), time.c (time_hash),
string.c (rb_str_hsah), object.c (rb_obj_hash), range.c
(range_hash), struct.c (rb_struct_hash), hash.c (rb_any_hash),
rational.c (nurat_hash): use Murmurhash. [ruby-dev:37784]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@22317 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2009-02-14 22:55:34 +03:00
|
|
|
h = rb_hash_start(rb_hash(rb_obj_class(s)));
|
2013-12-03 17:18:30 +04:00
|
|
|
len = RSTRUCT_LEN(s);
|
|
|
|
for (i = 0; i < len; i++) {
|
2018-11-05 11:02:31 +03:00
|
|
|
n = rb_hash(RSTRUCT_GET(s, i));
|
2013-12-03 17:18:30 +04:00
|
|
|
h = rb_hash_uint(h, NUM2LONG(n));
|
2003-04-15 14:12:25 +04:00
|
|
|
}
|
* string.c (rb_hash_uint32, rb_hash_uint, rb_hash_start, rb_hash_end),
include/ruby/intern.h: add Murmurhash API. [ruby-dev:37784]
* complex.c (nucomp_hash), array.c (rb_ary_hash), time.c (time_hash),
string.c (rb_str_hsah), object.c (rb_obj_hash), range.c
(range_hash), struct.c (rb_struct_hash), hash.c (rb_any_hash),
rational.c (nurat_hash): use Murmurhash. [ruby-dev:37784]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@22317 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2009-02-14 22:55:34 +03:00
|
|
|
h = rb_hash_end(h);
|
2019-04-08 08:06:43 +03:00
|
|
|
return ST2FIX(h);
|
2003-04-15 14:12:25 +04:00
|
|
|
}
|
|
|
|
|
2009-09-20 06:14:02 +04:00
|
|
|
static VALUE
|
|
|
|
recursive_eql(VALUE s, VALUE s2, int recur)
|
|
|
|
{
|
* array.c (rb_ary_{times, shuffle_bang, sample}): reducing macro
calls inside of the loop by keeping pointers in local
variables. a patch from Masahiro Kanai (CanI) in [ruby-dev:39406].
It was found and fixed at Security and Programming camp 2009.
* string.c (rb_str_{times, split_m}): ditto.
* struct.c (rb_struct_{getmember, set, aref_id, aset_id}, {make,
inspect}_struct, recursive_{equal, hash, eql}): ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@25237 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2009-10-05 18:35:39 +04:00
|
|
|
long i, len;
|
2009-09-20 06:14:02 +04:00
|
|
|
|
|
|
|
if (recur) return Qtrue; /* Subtle! */
|
* array.c (rb_ary_{times, shuffle_bang, sample}): reducing macro
calls inside of the loop by keeping pointers in local
variables. a patch from Masahiro Kanai (CanI) in [ruby-dev:39406].
It was found and fixed at Security and Programming camp 2009.
* string.c (rb_str_{times, split_m}): ditto.
* struct.c (rb_struct_{getmember, set, aref_id, aset_id}, {make,
inspect}_struct, recursive_{equal, hash, eql}): ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@25237 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2009-10-05 18:35:39 +04:00
|
|
|
len = RSTRUCT_LEN(s);
|
|
|
|
for (i=0; i<len; i++) {
|
2018-11-05 11:02:31 +03:00
|
|
|
if (!rb_eql(RSTRUCT_GET(s, i), RSTRUCT_GET(s2, i))) return Qfalse;
|
2009-09-20 06:14:02 +04:00
|
|
|
}
|
|
|
|
return Qtrue;
|
|
|
|
}
|
|
|
|
|
2003-12-28 23:47:56 +03:00
|
|
|
/*
|
2012-10-27 15:06:46 +04:00
|
|
|
* call-seq:
|
2021-09-25 02:41:02 +03:00
|
|
|
* eql?(other) -> true or false
|
|
|
|
*
|
|
|
|
* Returns +true+ if and only if the following are true; otherwise returns +false+:
|
|
|
|
*
|
|
|
|
* - <tt>other.class == self.class</tt>.
|
|
|
|
* - For each member name +name+, <tt>other.name.eql?(self.name)</tt>.
|
2003-12-28 23:47:56 +03:00
|
|
|
*
|
2022-04-13 17:42:46 +03:00
|
|
|
* 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
|
2021-09-25 02:41:02 +03:00
|
|
|
*
|
|
|
|
* Related: Object#==.
|
2003-12-28 23:47:56 +03:00
|
|
|
*/
|
|
|
|
|
2003-04-18 22:05:11 +04:00
|
|
|
static VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_eql(VALUE s, VALUE s2)
|
2003-04-18 22:05:11 +04:00
|
|
|
{
|
|
|
|
if (s == s2) return Qtrue;
|
2011-09-29 15:07:45 +04:00
|
|
|
if (!RB_TYPE_P(s2, T_STRUCT)) return Qfalse;
|
2003-04-18 22:05:11 +04:00
|
|
|
if (rb_obj_class(s) != rb_obj_class(s2)) return Qfalse;
|
2006-02-05 17:40:01 +03:00
|
|
|
if (RSTRUCT_LEN(s) != RSTRUCT_LEN(s2)) {
|
2003-04-18 22:05:11 +04:00
|
|
|
rb_bug("inconsistent struct"); /* should never happen */
|
|
|
|
}
|
|
|
|
|
2009-09-20 06:14:02 +04:00
|
|
|
return rb_exec_recursive_paired(recursive_eql, s, s2, s2);
|
2003-04-18 22:05:11 +04:00
|
|
|
}
|
|
|
|
|
2003-12-28 23:47:56 +03:00
|
|
|
/*
|
|
|
|
* call-seq:
|
2021-09-25 02:41:02 +03:00
|
|
|
* size -> integer
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2021-09-25 02:41:02 +03:00
|
|
|
* Returns the number of members.
|
2009-02-22 17:23:33 +03:00
|
|
|
*
|
2021-09-25 02:41:02 +03:00
|
|
|
* Customer = Struct.new(:name, :address, :zip)
|
|
|
|
* joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
|
|
|
|
* joe.size #=> 3
|
|
|
|
*
|
2003-12-28 23:47:56 +03:00
|
|
|
*/
|
|
|
|
|
2016-08-01 10:23:56 +03:00
|
|
|
VALUE
|
* array.c: moved to ANSI function style from K&R function style.
(used protoize on windows, so still K&R remains on #ifdef part of
other platforms. And `foo _((boo))' stuff is still there)
[ruby-dev:26975]
* bignum.c, class.c, compar.c, dir.c, dln.c, dmyext.c, enum.c,
enumerator.c, error.c, eval.c, file.c, gc.c, hash.c, inits.c,
io.c, main.c, marshal.c, math.c, numeric.c, object.c, pack.c,
prec.c, process.c, random.c, range.c, re.c, regcomp.c, regenc.c,
regerror.c, regexec.c, regparse.c, regparse.h, ruby.c, signal.c,
sprintf.c, st.c, string.c, struct.c, time.c, util.h, variable.c,
version.c: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9126 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2005-09-12 14:44:21 +04:00
|
|
|
rb_struct_size(VALUE s)
|
1999-12-07 12:25:55 +03:00
|
|
|
{
|
2006-02-05 17:40:01 +03:00
|
|
|
return LONG2FIX(RSTRUCT_LEN(s));
|
1999-12-07 12:25:55 +03:00
|
|
|
}
|
|
|
|
|
2015-11-17 05:25:28 +03:00
|
|
|
/*
|
|
|
|
* call-seq:
|
2021-09-25 02:41:02 +03:00
|
|
|
* dig(name, *identifiers) -> object
|
|
|
|
* dig(n, *identifiers) -> object
|
2015-11-17 05:25:28 +03:00
|
|
|
*
|
2021-09-25 02:41:02 +03:00
|
|
|
* 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+:
|
2015-11-17 05:25:28 +03:00
|
|
|
*
|
2017-03-01 22:59:03 +03:00
|
|
|
* Foo = Struct.new(:a)
|
|
|
|
* f = Foo.new(Foo.new({b: [1, 2, 3]}))
|
2020-08-13 21:16:27 +03:00
|
|
|
* 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
|
2021-09-25 02:41:02 +03:00
|
|
|
*
|
|
|
|
* 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
|
|
|
|
*
|
2015-11-17 05:25:28 +03:00
|
|
|
*/
|
|
|
|
|
2015-11-16 12:21:56 +03:00
|
|
|
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);
|
|
|
|
}
|
|
|
|
|
2022-09-30 12:23:19 +03:00
|
|
|
/*
|
|
|
|
* Document-class: Data
|
|
|
|
*
|
|
|
|
* \Class \Data provides a convenient way to define simple classes
|
|
|
|
* for value-alike objects.
|
|
|
|
*
|
|
|
|
* The simplest example of usage:
|
|
|
|
*
|
|
|
|
* Measure = Data.define(:amount, :unit)
|
|
|
|
*
|
|
|
|
* # Positional arguments constructor is provided
|
|
|
|
* distance = Measure.new(100, 'km')
|
|
|
|
* #=> #<data Measure amount=100, unit="km">
|
|
|
|
*
|
|
|
|
* # Keyword arguments constructor is provided
|
|
|
|
* weight = Measure.new(amount: 50, unit: 'kg')
|
|
|
|
* #=> #<data Measure amount=50, unit="kg">
|
|
|
|
*
|
|
|
|
* # Alternative form to construct an object:
|
|
|
|
* speed = Measure[10, 'mPh']
|
|
|
|
* #=> #<data Measure amount=10, unit="mPh">
|
|
|
|
*
|
|
|
|
* # Works with keyword arguments, too:
|
|
|
|
* area = Measure[amount: 1.5, unit: 'm^2']
|
|
|
|
* #=> #<data Measure amount=1.5, unit="m^2">
|
|
|
|
*
|
|
|
|
* # Argument accessors are provided:
|
|
|
|
* distance.amount #=> 100
|
|
|
|
* distance.unit #=> "km"
|
|
|
|
*
|
|
|
|
* Constructed object also has a reasonable definitions of #==
|
2023-03-08 06:26:26 +03:00
|
|
|
* operator, #to_h hash conversion, and #deconstruct / #deconstruct_keys
|
2022-09-30 12:23:19 +03:00
|
|
|
* to be used in pattern matching.
|
|
|
|
*
|
|
|
|
* ::define method accepts an optional block and evaluates it in
|
|
|
|
* the context of the newly defined class. That allows to define
|
|
|
|
* additional methods:
|
|
|
|
*
|
|
|
|
* Measure = Data.define(:amount, :unit) do
|
|
|
|
* def <=>(other)
|
|
|
|
* return unless other.is_a?(self.class) && other.unit == unit
|
|
|
|
* amount <=> other.amount
|
|
|
|
* end
|
|
|
|
*
|
|
|
|
* include Comparable
|
|
|
|
* end
|
|
|
|
*
|
|
|
|
* Measure[3, 'm'] < Measure[5, 'm'] #=> true
|
|
|
|
* Measure[3, 'm'] < Measure[5, 'kg']
|
|
|
|
* # comparison of Measure with Measure failed (ArgumentError)
|
|
|
|
*
|
|
|
|
* Data provides no member writers, or enumerators: it is meant
|
|
|
|
* to be a storage for immutable atomic values. But note that
|
|
|
|
* if some of data members is of a mutable class, Data does no additional
|
|
|
|
* immutability enforcement:
|
|
|
|
*
|
|
|
|
* Event = Data.define(:time, :weekdays)
|
|
|
|
* event = Event.new('18:00', %w[Tue Wed Fri])
|
|
|
|
* #=> #<data Event time="18:00", weekdays=["Tue", "Wed", "Fri"]>
|
|
|
|
*
|
|
|
|
* # There is no #time= or #weekdays= accessors, but changes are
|
|
|
|
* # still possible:
|
|
|
|
* event.weekdays << 'Sat'
|
|
|
|
* event
|
|
|
|
* #=> #<data Event time="18:00", weekdays=["Tue", "Wed", "Fri", "Sat"]>
|
|
|
|
*
|
|
|
|
* See also Struct, which is a similar concept, but has more
|
|
|
|
* container-alike API, allowing to change contents of the object
|
|
|
|
* and enumerate it.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* call-seq:
|
|
|
|
* define(*symbols) -> class
|
|
|
|
*
|
2022-12-28 15:51:33 +03:00
|
|
|
* Defines a new \Data class.
|
2022-09-30 12:23:19 +03:00
|
|
|
*
|
|
|
|
* measure = Data.define(:amount, :unit)
|
|
|
|
* #=> #<Class:0x00007f70c6868498>
|
|
|
|
* measure.new(1, 'km')
|
|
|
|
* #=> #<data amount=1, unit="km">
|
|
|
|
*
|
|
|
|
* # It you store the new class in the constant, it will
|
|
|
|
* # affect #inspect and will be more natural to use:
|
|
|
|
* Measure = Data.define(:amount, :unit)
|
|
|
|
* #=> Measure
|
|
|
|
* Measure.new(1, 'km')
|
|
|
|
* #=> #<data Measure amount=1, unit="km">
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* Note that member-less \Data is acceptable and might be a useful technique
|
|
|
|
* for defining several homogenous data classes, like
|
|
|
|
*
|
|
|
|
* class HTTPFetcher
|
|
|
|
* Response = Data.define(:body)
|
|
|
|
* NotFound = Data.define
|
|
|
|
* # ... implementation
|
|
|
|
* end
|
|
|
|
*
|
|
|
|
* Now, different kinds of responses from +HTTPFetcher+ would have consistent
|
|
|
|
* representation:
|
|
|
|
*
|
|
|
|
* #<data HTTPFetcher::Response body="<html...">
|
|
|
|
* #<data HTTPFetcher::NotFound>
|
|
|
|
*
|
|
|
|
* And are convenient to use in pattern matching:
|
|
|
|
*
|
|
|
|
* case fetcher.get(url)
|
|
|
|
* in HTTPFetcher::Response(body)
|
|
|
|
* # process body variable
|
|
|
|
* in HTTPFetcher::NotFound
|
|
|
|
* # handle not found case
|
|
|
|
* end
|
|
|
|
*/
|
|
|
|
|
|
|
|
static VALUE
|
|
|
|
rb_data_s_def(int argc, VALUE *argv, VALUE klass)
|
|
|
|
{
|
|
|
|
VALUE rest;
|
|
|
|
long i;
|
|
|
|
VALUE data_class;
|
|
|
|
|
|
|
|
rest = rb_ident_hash_new();
|
|
|
|
RBASIC_CLEAR_CLASS(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 data member: %"PRIsVALUE, mem);
|
|
|
|
}
|
2023-02-03 18:21:33 +03:00
|
|
|
if (RTEST(rb_hash_has_key(rest, mem))) {
|
2022-09-30 12:23:19 +03:00
|
|
|
rb_raise(rb_eArgError, "duplicate member: %"PRIsVALUE, mem);
|
|
|
|
}
|
2023-02-03 18:21:33 +03:00
|
|
|
rb_hash_aset(rest, mem, Qtrue);
|
2022-09-30 12:23:19 +03:00
|
|
|
}
|
|
|
|
rest = rb_hash_keys(rest);
|
|
|
|
RBASIC_CLEAR_CLASS(rest);
|
|
|
|
OBJ_FREEZE_RAW(rest);
|
|
|
|
data_class = anonymous_struct(klass);
|
|
|
|
setup_data(data_class, rest);
|
|
|
|
if (rb_block_given_p()) {
|
|
|
|
rb_mod_module_eval(0, 0, data_class);
|
|
|
|
}
|
|
|
|
|
|
|
|
return data_class;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* call-seq:
|
|
|
|
* DataClass::members -> array_of_symbols
|
|
|
|
*
|
|
|
|
* Returns an array of member names of the data class:
|
|
|
|
*
|
|
|
|
* Measure = Data.define(:amount, :unit)
|
|
|
|
* Measure.members # => [:amount, :unit]
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define rb_data_s_members_m rb_struct_s_members_m
|
|
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
* call-seq:
|
|
|
|
* new(*args) -> instance
|
|
|
|
* new(**kwargs) -> instance
|
|
|
|
* ::[](*args) -> instance
|
|
|
|
* ::[](**kwargs) -> instance
|
|
|
|
*
|
|
|
|
* Constructors for classes defined with ::define accept both positional and
|
|
|
|
* keyword arguments.
|
|
|
|
*
|
|
|
|
* Measure = Data.define(:amount, :unit)
|
|
|
|
*
|
|
|
|
* Measure.new(1, 'km')
|
|
|
|
* #=> #<data Measure amount=1, unit="km">
|
|
|
|
* Measure.new(amount: 1, unit: 'km')
|
|
|
|
* #=> #<data Measure amount=1, unit="km">
|
|
|
|
*
|
2023-02-28 21:05:30 +03:00
|
|
|
* # Alternative shorter initialization with []
|
2022-09-30 12:23:19 +03:00
|
|
|
* Measure[1, 'km']
|
|
|
|
* #=> #<data Measure amount=1, unit="km">
|
|
|
|
* Measure[amount: 1, unit: 'km']
|
|
|
|
* #=> #<data Measure amount=1, unit="km">
|
|
|
|
*
|
|
|
|
* All arguments are mandatory (unlike Struct), and converted to keyword arguments:
|
|
|
|
*
|
|
|
|
* Measure.new(amount: 1)
|
|
|
|
* # in `initialize': missing keyword: :unit (ArgumentError)
|
|
|
|
*
|
|
|
|
* Measure.new(1)
|
|
|
|
* # in `initialize': missing keyword: :unit (ArgumentError)
|
|
|
|
*
|
|
|
|
* Note that <tt>Measure#initialize</tt> always receives keyword arguments, and that
|
|
|
|
* mandatory arguments are checked in +initialize+, not in +new+. This can be
|
|
|
|
* important for redefining initialize in order to convert arguments or provide
|
|
|
|
* defaults:
|
|
|
|
*
|
|
|
|
* Measure = Data.define(:amount, :unit) do
|
|
|
|
* NONE = Data.define
|
|
|
|
*
|
|
|
|
* def initialize(amount:, unit: NONE.new)
|
|
|
|
* super(amount: Float(amount), unit:)
|
|
|
|
* end
|
|
|
|
* end
|
|
|
|
*
|
|
|
|
* Measure.new('10', 'km') # => #<data Measure amount=10.0, unit="km">
|
|
|
|
* Measure.new(10_000) # => #<data Measure amount=10000.0, unit=#<data NONE>>
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
static VALUE
|
|
|
|
rb_data_initialize_m(int argc, const VALUE *argv, VALUE self)
|
|
|
|
{
|
|
|
|
VALUE klass = rb_obj_class(self);
|
|
|
|
rb_struct_modify(self);
|
|
|
|
VALUE members = struct_ivar_get(klass, id_members);
|
|
|
|
size_t num_members = RARRAY_LEN(members);
|
|
|
|
|
2022-10-01 10:14:59 +03:00
|
|
|
if (argc == 0) {
|
|
|
|
if (num_members > 0) {
|
|
|
|
rb_exc_raise(rb_keyword_error_new("missing", members));
|
|
|
|
}
|
|
|
|
return Qnil;
|
|
|
|
}
|
2022-09-30 12:23:19 +03:00
|
|
|
if (argc > 1 || !RB_TYPE_P(argv[0], T_HASH)) {
|
2022-10-01 10:18:03 +03:00
|
|
|
rb_error_arity(argc, 0, 0);
|
2022-09-30 12:23:19 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
if (RHASH_SIZE(argv[0]) < num_members) {
|
|
|
|
VALUE missing = rb_ary_diff(members, rb_hash_keys(argv[0]));
|
|
|
|
rb_exc_raise(rb_keyword_error_new("missing", missing));
|
|
|
|
}
|
|
|
|
|
|
|
|
struct struct_hash_set_arg arg;
|
|
|
|
rb_mem_clear((VALUE *)RSTRUCT_CONST_PTR(self), num_members);
|
|
|
|
arg.self = self;
|
|
|
|
arg.unknown_keywords = Qnil;
|
|
|
|
rb_hash_foreach(argv[0], struct_hash_set_i, (VALUE)&arg);
|
2022-12-26 17:04:46 +03:00
|
|
|
// Freeze early before potentially raising, so that we don't leave an
|
|
|
|
// unfrozen copy on the heap, which could get exposed via ObjectSpace.
|
|
|
|
OBJ_FREEZE_RAW(self);
|
2022-09-30 12:23:19 +03:00
|
|
|
if (arg.unknown_keywords != Qnil) {
|
|
|
|
rb_exc_raise(rb_keyword_error_new("unknown", arg.unknown_keywords));
|
|
|
|
}
|
|
|
|
return Qnil;
|
|
|
|
}
|
|
|
|
|
2022-12-01 11:26:45 +03:00
|
|
|
/* :nodoc: */
|
|
|
|
static VALUE
|
|
|
|
rb_data_init_copy(VALUE copy, VALUE s)
|
|
|
|
{
|
|
|
|
copy = rb_struct_init_copy(copy, s);
|
|
|
|
RB_OBJ_FREEZE_RAW(copy);
|
|
|
|
return copy;
|
|
|
|
}
|
|
|
|
|
2022-12-22 03:27:38 +03:00
|
|
|
/*
|
|
|
|
* call-seq:
|
|
|
|
* with(**kwargs) -> instance
|
|
|
|
*
|
|
|
|
* Returns a shallow copy of +self+ --- the instance variables of
|
|
|
|
* +self+ are copied, but not the objects they reference.
|
|
|
|
*
|
|
|
|
* If the method is supplied any keyword arguments, the copy will
|
|
|
|
* be created with the respective field values updated to use the
|
|
|
|
* supplied keyword argument values. Note that it is an error to
|
|
|
|
* supply a keyword that the Data class does not have as a member.
|
|
|
|
*
|
|
|
|
* Point = Data.define(:x, :y)
|
|
|
|
*
|
|
|
|
* origin = Point.new(x: 0, y: 0)
|
|
|
|
*
|
|
|
|
* up = origin.with(x: 1)
|
|
|
|
* right = origin.with(y: 1)
|
|
|
|
* up_and_right = up.with(y: 1)
|
|
|
|
*
|
|
|
|
* p origin # #<data Point x=0, y=0>
|
|
|
|
* p up # #<data Point x=1, y=0>
|
|
|
|
* p right # #<data Point x=0, y=1>
|
|
|
|
* p up_and_right # #<data Point x=1, y=1>
|
|
|
|
*
|
|
|
|
* out = origin.with(z: 1) # ArgumentError: unknown keyword: :z
|
|
|
|
* some_point = origin.with(1, 2) # ArgumentError: expected keyword arguments, got positional arguments
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
static VALUE
|
|
|
|
rb_data_with(int argc, const VALUE *argv, VALUE self)
|
|
|
|
{
|
|
|
|
VALUE kwargs;
|
|
|
|
rb_scan_args(argc, argv, "0:", &kwargs);
|
|
|
|
if (NIL_P(kwargs)) {
|
|
|
|
return self;
|
|
|
|
}
|
|
|
|
|
2022-12-26 17:04:46 +03:00
|
|
|
VALUE h = rb_struct_to_h(self);
|
|
|
|
rb_hash_update_by(h, kwargs, NULL);
|
|
|
|
return rb_class_new_instance_kw(1, &h, rb_obj_class(self), TRUE);
|
2022-12-22 03:27:38 +03:00
|
|
|
}
|
|
|
|
|
2022-09-30 12:23:19 +03:00
|
|
|
/*
|
|
|
|
* call-seq:
|
|
|
|
* inspect -> string
|
|
|
|
* to_s -> string
|
|
|
|
*
|
|
|
|
* Returns a string representation of +self+:
|
|
|
|
*
|
|
|
|
* Measure = Data.define(:amount, :unit)
|
|
|
|
*
|
|
|
|
* distance = Measure[10, 'km']
|
|
|
|
*
|
|
|
|
* p distance # uses #inspect underneath
|
|
|
|
* #<data Measure amount=10, unit="km">
|
|
|
|
*
|
|
|
|
* puts distance # uses #to_s underneath, same representation
|
|
|
|
* #<data Measure amount=10, unit="km">
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
static VALUE
|
|
|
|
rb_data_inspect(VALUE s)
|
|
|
|
{
|
|
|
|
return rb_exec_recursive(inspect_struct, s, rb_str_new2("#<data "));
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* call-seq:
|
|
|
|
* self == other -> true or false
|
|
|
|
*
|
|
|
|
* Returns +true+ if +other+ is the same class as +self+, and all members are
|
|
|
|
* equal.
|
|
|
|
*
|
|
|
|
* Examples:
|
|
|
|
*
|
2022-10-06 20:13:17 +03:00
|
|
|
* Measure = Data.define(:amount, :unit)
|
2022-09-30 12:23:19 +03:00
|
|
|
*
|
|
|
|
* Measure[1, 'km'] == Measure[1, 'km'] #=> true
|
|
|
|
* Measure[1, 'km'] == Measure[2, 'km'] #=> false
|
|
|
|
* Measure[1, 'km'] == Measure[1, 'm'] #=> false
|
|
|
|
*
|
2022-10-06 20:13:17 +03:00
|
|
|
* Measurement = Data.define(:amount, :unit)
|
2022-09-30 12:23:19 +03:00
|
|
|
* # Even though Measurement and Measure have the same "shape"
|
|
|
|
* # their instances are never equal
|
|
|
|
* Measure[1, 'km'] == Measurement[1, 'km'] #=> false
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define rb_data_equal rb_struct_equal
|
|
|
|
|
|
|
|
/*
|
|
|
|
* call-seq:
|
|
|
|
* self.eql?(other) -> true or false
|
|
|
|
*
|
|
|
|
* Equality check that is used when two items of data are keys of a Hash.
|
|
|
|
*
|
|
|
|
* The subtle difference with #== is that members are also compared with their
|
|
|
|
* #eql? method, which might be important in some cases:
|
|
|
|
*
|
2022-10-06 20:13:17 +03:00
|
|
|
* Measure = Data.define(:amount, :unit)
|
2022-09-30 12:23:19 +03:00
|
|
|
*
|
|
|
|
* Measure[1, 'km'] == Measure[1.0, 'km'] #=> true, they are equal as values
|
|
|
|
* # ...but...
|
|
|
|
* Measure[1, 'km'].eql? Measure[1.0, 'km'] #=> false, they represent different hash keys
|
|
|
|
*
|
|
|
|
* See also Object#eql? for further explanations of the method usage.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define rb_data_eql rb_struct_eql
|
|
|
|
|
|
|
|
/*
|
|
|
|
* call-seq:
|
|
|
|
* hash -> integer
|
|
|
|
*
|
|
|
|
* Redefines Object#hash (used to distinguish objects as Hash keys) so that
|
|
|
|
* data objects of the same class with same content would have the same +hash+
|
|
|
|
* value, and represented the same Hash key.
|
|
|
|
*
|
|
|
|
* Measure = Data.define(:amount, :unit)
|
|
|
|
*
|
|
|
|
* Measure[1, 'km'].hash == Measure[1, 'km'].hash #=> true
|
|
|
|
* Measure[1, 'km'].hash == Measure[10, 'km'].hash #=> false
|
|
|
|
* Measure[1, 'km'].hash == Measure[1, 'm'].hash #=> false
|
|
|
|
* Measure[1, 'km'].hash == Measure[1.0, 'km'].hash #=> false
|
|
|
|
*
|
|
|
|
* # Structurally similar data class, but shouldn't be considered
|
|
|
|
* # the same hash key
|
|
|
|
* Measurement = Data.define(:amount, :unit)
|
|
|
|
*
|
|
|
|
* Measure[1, 'km'].hash == Measurement[1, 'km'].hash #=> false
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define rb_data_hash rb_struct_hash
|
|
|
|
|
|
|
|
/*
|
|
|
|
* call-seq:
|
|
|
|
* to_h -> hash
|
|
|
|
* to_h {|name, value| ... } -> hash
|
|
|
|
*
|
|
|
|
* Returns Hash representation of the data object.
|
|
|
|
*
|
|
|
|
* Measure = Data.define(:amount, :unit)
|
|
|
|
* distance = Measure[10, 'km']
|
|
|
|
*
|
|
|
|
* distance.to_h
|
|
|
|
* #=> {:amount=>10, :unit=>"km"}
|
|
|
|
*
|
|
|
|
* Like Enumerable#to_h, if the block is provided, it is expected to
|
|
|
|
* produce key-value pairs to construct a hash:
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* distance.to_h { |name, val| [name.to_s, val.to_s] }
|
|
|
|
* #=> {"amount"=>"10", "unit"=>"km"}
|
|
|
|
*
|
|
|
|
* Note that there is a useful symmetry between #to_h and #initialize:
|
|
|
|
*
|
|
|
|
* distance2 = Measure.new(**distance.to_h)
|
|
|
|
* #=> #<data Measure amount=10, unit="km">
|
|
|
|
* distance2 == distance
|
|
|
|
* #=> true
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define rb_data_to_h rb_struct_to_h
|
|
|
|
|
|
|
|
/*
|
|
|
|
* call-seq:
|
|
|
|
* members -> array_of_symbols
|
|
|
|
*
|
|
|
|
* Returns the member names from +self+ as an array:
|
|
|
|
*
|
|
|
|
* Measure = Data.define(:amount, :unit)
|
|
|
|
* distance = Measure[10, 'km']
|
|
|
|
*
|
|
|
|
* distance.members #=> [:amount, :unit]
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define rb_data_members_m rb_struct_members_m
|
|
|
|
|
|
|
|
/*
|
|
|
|
* call-seq:
|
|
|
|
* deconstruct -> array
|
|
|
|
*
|
|
|
|
* Returns the values in +self+ as an array, to use in pattern matching:
|
|
|
|
*
|
|
|
|
* Measure = Data.define(:amount, :unit)
|
|
|
|
*
|
|
|
|
* distance = Measure[10, 'km']
|
|
|
|
* distance.deconstruct #=> [10, "km"]
|
|
|
|
*
|
|
|
|
* # usage
|
|
|
|
* case distance
|
|
|
|
* in n, 'km' # calls #deconstruct underneath
|
|
|
|
* puts "It is #{n} kilometers away"
|
|
|
|
* else
|
|
|
|
* puts "Don't know how to handle it"
|
|
|
|
* end
|
|
|
|
* # prints "It is 10 kilometers away"
|
|
|
|
*
|
|
|
|
* Or, with checking the class, too:
|
|
|
|
*
|
|
|
|
* case distance
|
|
|
|
* in Measure(n, 'km')
|
|
|
|
* puts "It is #{n} kilometers away"
|
|
|
|
* # ...
|
|
|
|
* end
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define rb_data_deconstruct rb_struct_to_a
|
|
|
|
|
|
|
|
/*
|
|
|
|
* call-seq:
|
|
|
|
* deconstruct_keys(array_of_names_or_nil) -> hash
|
|
|
|
*
|
|
|
|
* Returns a hash of the name/value pairs, to use in pattern matching.
|
|
|
|
*
|
|
|
|
* Measure = Data.define(:amount, :unit)
|
|
|
|
*
|
|
|
|
* distance = Measure[10, 'km']
|
|
|
|
* distance.deconstruct_keys(nil) #=> {:amount=>10, :unit=>"km"}
|
|
|
|
* distance.deconstruct_keys([:amount]) #=> {:amount=>10}
|
|
|
|
*
|
|
|
|
* # usage
|
|
|
|
* case distance
|
|
|
|
* in amount:, unit: 'km' # calls #deconstruct_keys underneath
|
|
|
|
* puts "It is #{amount} kilometers away"
|
|
|
|
* else
|
|
|
|
* puts "Don't know how to handle it"
|
|
|
|
* end
|
|
|
|
* # prints "It is 10 kilometers away"
|
|
|
|
*
|
|
|
|
* Or, with checking the class, too:
|
|
|
|
*
|
|
|
|
* case distance
|
|
|
|
* in Measure(amount:, unit: 'km')
|
|
|
|
* puts "It is #{amount} kilometers away"
|
|
|
|
* # ...
|
|
|
|
* end
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define rb_data_deconstruct_keys rb_struct_deconstruct_keys
|
|
|
|
|
2003-12-28 23:47:56 +03:00
|
|
|
/*
|
2017-02-04 02:58:18 +03:00
|
|
|
* Document-class: Struct
|
|
|
|
*
|
2021-09-28 02:17:47 +03:00
|
|
|
* \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:
|
|
|
|
*
|
2022-02-06 18:30:11 +03:00
|
|
|
* - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
|
|
|
|
* - Includes {module Enumerable}[rdoc-ref:Enumerable@What-27s+Here],
|
2021-09-28 02:17:47 +03:00
|
|
|
* which provides dozens of additional methods.
|
|
|
|
*
|
2022-09-30 12:23:19 +03:00
|
|
|
* See also Data, which is a somewhat similar, but stricter concept for defining immutable
|
|
|
|
* value objects.
|
|
|
|
*
|
2021-09-28 02:17:47 +03:00
|
|
|
* Here, class \Struct provides methods that are useful for:
|
|
|
|
*
|
2022-02-06 18:37:06 +03:00
|
|
|
* - {Creating a Struct Subclass}[rdoc-ref:Struct@Methods+for+Creating+a+Struct+Subclass]
|
|
|
|
* - {Querying}[rdoc-ref:Struct@Methods+for+Querying]
|
|
|
|
* - {Comparing}[rdoc-ref:Struct@Methods+for+Comparing]
|
|
|
|
* - {Fetching}[rdoc-ref:Struct@Methods+for+Fetching]
|
|
|
|
* - {Assigning}[rdoc-ref:Struct@Methods+for+Assigning]
|
|
|
|
* - {Iterating}[rdoc-ref:Struct@Methods+for+Iterating]
|
|
|
|
* - {Converting}[rdoc-ref:Struct@Methods+for+Converting]
|
2021-09-28 02:17:47 +03:00
|
|
|
*
|
|
|
|
* === Methods for Creating a Struct Subclass
|
|
|
|
*
|
2022-03-30 21:46:24 +03:00
|
|
|
* - ::new: Returns a new subclass of \Struct.
|
2021-09-28 02:17:47 +03:00
|
|
|
*
|
|
|
|
* === Methods for Querying
|
|
|
|
*
|
2022-03-30 21:46:24 +03:00
|
|
|
* - #hash: Returns the integer hash code.
|
|
|
|
* - #length, #size: Returns the number of members.
|
2021-09-28 02:17:47 +03:00
|
|
|
*
|
|
|
|
* === Methods for Comparing
|
|
|
|
*
|
2022-03-30 21:46:24 +03:00
|
|
|
* - #==: 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.
|
2021-09-28 02:17:47 +03:00
|
|
|
*
|
|
|
|
* === Methods for Fetching
|
|
|
|
*
|
2022-03-30 21:46:24 +03:00
|
|
|
* - #[]: 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.
|
2021-09-28 02:17:47 +03:00
|
|
|
*
|
|
|
|
* === Methods for Assigning
|
|
|
|
*
|
2022-03-30 21:46:24 +03:00
|
|
|
* - #[]=: Assigns a given value to a given member name.
|
2013-06-12 02:17:02 +04:00
|
|
|
*
|
2021-09-28 02:17:47 +03:00
|
|
|
* === Methods for Iterating
|
2013-06-12 02:17:02 +04:00
|
|
|
*
|
2022-03-30 21:46:24 +03:00
|
|
|
* - #each: Calls a given block with each member name.
|
|
|
|
* - #each_pair: Calls a given block with each member name/value pair.
|
2013-06-12 02:17:02 +04:00
|
|
|
*
|
2021-09-28 02:17:47 +03:00
|
|
|
* === Methods for Converting
|
2013-06-12 02:17:02 +04:00
|
|
|
*
|
2022-03-30 21:46:24 +03:00
|
|
|
* - #inspect, #to_s: Returns a string representation of +self+.
|
|
|
|
* - #to_h: Returns a hash of the member name/value pairs in +self+.
|
2013-06-12 02:17:02 +04:00
|
|
|
*
|
2003-12-28 23:47:56 +03:00
|
|
|
*/
|
1998-01-16 15:13:05 +03:00
|
|
|
void
|
2014-07-03 07:38:10 +04:00
|
|
|
InitVM_Struct(void)
|
1998-01-16 15:13:05 +03:00
|
|
|
{
|
1999-01-20 07:59:39 +03:00
|
|
|
rb_cStruct = rb_define_class("Struct", rb_cObject);
|
|
|
|
rb_include_module(rb_cStruct, rb_mEnumerable);
|
1998-01-16 15:13:05 +03:00
|
|
|
|
2002-12-20 11:33:17 +03:00
|
|
|
rb_undef_alloc_func(rb_cStruct);
|
1999-01-20 07:59:39 +03:00
|
|
|
rb_define_singleton_method(rb_cStruct, "new", rb_struct_s_def, -1);
|
2021-12-16 00:59:33 +03:00
|
|
|
#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
|
1998-01-16 15:13:05 +03:00
|
|
|
|
2008-11-10 03:51:14 +03:00
|
|
|
rb_define_method(rb_cStruct, "initialize", rb_struct_initialize_m, -1);
|
2003-05-19 09:41:08 +04:00
|
|
|
rb_define_method(rb_cStruct, "initialize_copy", rb_struct_init_copy, 1);
|
1998-01-16 15:13:05 +03:00
|
|
|
|
1999-01-20 07:59:39 +03:00
|
|
|
rb_define_method(rb_cStruct, "==", rb_struct_equal, 1);
|
2003-04-18 22:05:11 +04:00
|
|
|
rb_define_method(rb_cStruct, "eql?", rb_struct_eql, 1);
|
2003-04-15 14:12:25 +04:00
|
|
|
rb_define_method(rb_cStruct, "hash", rb_struct_hash, 0);
|
1998-01-16 15:13:05 +03:00
|
|
|
|
1999-01-20 07:59:39 +03:00
|
|
|
rb_define_method(rb_cStruct, "inspect", rb_struct_inspect, 0);
|
2009-05-29 12:10:10 +04:00
|
|
|
rb_define_alias(rb_cStruct, "to_s", "inspect");
|
1999-01-20 07:59:39 +03:00
|
|
|
rb_define_method(rb_cStruct, "to_a", rb_struct_to_a, 0);
|
2012-04-24 07:46:55 +04:00
|
|
|
rb_define_method(rb_cStruct, "to_h", rb_struct_to_h, 0);
|
1999-01-20 07:59:39 +03:00
|
|
|
rb_define_method(rb_cStruct, "values", rb_struct_to_a, 0);
|
1999-12-07 12:25:55 +03:00
|
|
|
rb_define_method(rb_cStruct, "size", rb_struct_size, 0);
|
|
|
|
rb_define_method(rb_cStruct, "length", rb_struct_size, 0);
|
1998-01-16 15:13:05 +03:00
|
|
|
|
1999-01-20 07:59:39 +03:00
|
|
|
rb_define_method(rb_cStruct, "each", rb_struct_each, 0);
|
2002-04-10 12:45:26 +04:00
|
|
|
rb_define_method(rb_cStruct, "each_pair", rb_struct_each_pair, 0);
|
1999-01-20 07:59:39 +03:00
|
|
|
rb_define_method(rb_cStruct, "[]", rb_struct_aref, 1);
|
|
|
|
rb_define_method(rb_cStruct, "[]=", rb_struct_aset, 2);
|
2001-12-11 06:48:08 +03:00
|
|
|
rb_define_method(rb_cStruct, "select", rb_struct_select, -1);
|
2018-09-16 07:00:14 +03:00
|
|
|
rb_define_method(rb_cStruct, "filter", rb_struct_select, -1);
|
2003-05-04 20:03:24 +04:00
|
|
|
rb_define_method(rb_cStruct, "values_at", rb_struct_values_at, -1);
|
1998-01-16 15:13:05 +03:00
|
|
|
|
2004-09-27 08:46:54 +04:00
|
|
|
rb_define_method(rb_cStruct, "members", rb_struct_members_m, 0);
|
2015-11-16 12:21:56 +03:00
|
|
|
rb_define_method(rb_cStruct, "dig", rb_struct_dig, -1);
|
2019-04-17 09:48:05 +03:00
|
|
|
|
|
|
|
rb_define_method(rb_cStruct, "deconstruct", rb_struct_to_a, 0);
|
2019-11-08 05:37:07 +03:00
|
|
|
rb_define_method(rb_cStruct, "deconstruct_keys", rb_struct_deconstruct_keys, 1);
|
2022-09-30 12:23:19 +03:00
|
|
|
|
|
|
|
rb_cData = rb_define_class("Data", rb_cObject);
|
|
|
|
|
|
|
|
rb_undef_method(CLASS_OF(rb_cData), "new");
|
|
|
|
rb_undef_alloc_func(rb_cData);
|
|
|
|
rb_define_singleton_method(rb_cData, "define", rb_data_s_def, -1);
|
|
|
|
|
2022-10-01 09:36:01 +03:00
|
|
|
#if 0 /* for RDoc */
|
2022-09-30 12:23:19 +03:00
|
|
|
rb_define_singleton_method(rb_cData, "members", rb_data_s_members_m, 0);
|
2022-10-01 09:36:01 +03:00
|
|
|
#endif
|
2022-09-30 12:23:19 +03:00
|
|
|
|
|
|
|
rb_define_method(rb_cData, "initialize", rb_data_initialize_m, -1);
|
2022-12-01 11:26:45 +03:00
|
|
|
rb_define_method(rb_cData, "initialize_copy", rb_data_init_copy, 1);
|
2022-09-30 12:23:19 +03:00
|
|
|
|
|
|
|
rb_define_method(rb_cData, "==", rb_data_equal, 1);
|
|
|
|
rb_define_method(rb_cData, "eql?", rb_data_eql, 1);
|
|
|
|
rb_define_method(rb_cData, "hash", rb_data_hash, 0);
|
|
|
|
|
|
|
|
rb_define_method(rb_cData, "inspect", rb_data_inspect, 0);
|
|
|
|
rb_define_alias(rb_cData, "to_s", "inspect");
|
|
|
|
rb_define_method(rb_cData, "to_h", rb_data_to_h, 0);
|
|
|
|
|
|
|
|
rb_define_method(rb_cData, "members", rb_data_members_m, 0);
|
|
|
|
|
|
|
|
rb_define_method(rb_cData, "deconstruct", rb_data_deconstruct, 0);
|
|
|
|
rb_define_method(rb_cData, "deconstruct_keys", rb_data_deconstruct_keys, 1);
|
2022-12-22 03:27:38 +03:00
|
|
|
|
|
|
|
rb_define_method(rb_cData, "with", rb_data_with, -1);
|
2014-07-03 07:38:10 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
#undef rb_intern
|
|
|
|
void
|
|
|
|
Init_Struct(void)
|
|
|
|
{
|
2009-05-19 08:58:36 +04:00
|
|
|
id_members = rb_intern("__members__");
|
2015-06-30 23:45:44 +03:00
|
|
|
id_back_members = rb_intern("__members_back__");
|
2017-12-12 11:12:43 +03:00
|
|
|
id_keyword_init = rb_intern("__keyword_init__");
|
2014-07-03 07:38:10 +04:00
|
|
|
|
|
|
|
InitVM(Struct);
|
1998-01-16 15:13:05 +03:00
|
|
|
}
|