2 ** variable.c - mruby variables
4 ** See Copyright Notice in mruby.h
8 #include <mruby/array.h>
9 #include <mruby/class.h>
10 #include <mruby/proc.h>
11 #include <mruby/string.h>
12 #include <mruby/variable.h>
14 #ifndef MRB_IV_SEGMENT_SIZE
15 #define MRB_IV_SEGMENT_SIZE 4
18 typedef struct segment {
19 mrb_sym key[MRB_IV_SEGMENT_SIZE];
20 mrb_value val[MRB_IV_SEGMENT_SIZE];
24 /* Instance variable table structure */
25 typedef struct iv_tbl {
31 /* Creates the instance variable table. */
33 iv_new(mrb_state *mrb)
37 t = (iv_tbl*)mrb_malloc(mrb, sizeof(iv_tbl));
45 /* Set the value for the symbol in the instance variable table. */
47 iv_put(mrb_state *mrb, iv_tbl *t, mrb_sym sym, mrb_value val)
51 segment *matched_seg = NULL;
52 size_t matched_idx = 0;
55 if (t == NULL) return;
58 for (i=0; i<MRB_IV_SEGMENT_SIZE; i++) {
59 mrb_sym key = seg->key[i];
60 /* Found room in last segment after last_len */
61 if (!seg->next && i >= t->last_len) {
68 if (!matched_seg && key == 0) {
72 else if (key == sym) {
84 matched_seg->key[matched_idx] = sym;
85 matched_seg->val[matched_idx] = val;
89 seg = (segment*)mrb_malloc(mrb, sizeof(segment));
103 /* Get a value for a symbol from the instance variable table. */
105 iv_get(mrb_state *mrb, iv_tbl *t, mrb_sym sym, mrb_value *vp)
110 if (t == NULL) return FALSE;
113 for (i=0; i<MRB_IV_SEGMENT_SIZE; i++) {
114 mrb_sym key = seg->key[i];
116 if (!seg->next && i >= t->last_len) {
120 if (vp) *vp = seg->val[i];
129 /* Deletes the value for the symbol from the instance variable table. */
131 iv_del(mrb_state *mrb, iv_tbl *t, mrb_sym sym, mrb_value *vp)
136 if (t == NULL) return FALSE;
139 for (i=0; i<MRB_IV_SEGMENT_SIZE; i++) {
140 mrb_sym key = seg->key[i];
142 if (!seg->next && i >= t->last_len) {
148 if (vp) *vp = seg->val[i];
157 /* Iterates over the instance variable table. */
159 iv_foreach(mrb_state *mrb, iv_tbl *t, mrb_iv_foreach_func *func, void *p)
164 if (t == NULL) return;
167 for (i=0; i<MRB_IV_SEGMENT_SIZE; i++) {
168 mrb_sym key = seg->key[i];
170 /* no value in last segment after last_len */
171 if (!seg->next && i >= t->last_len) {
175 if ((*func)(mrb, key, seg->val[i], p) != 0) {
185 /* Get the size of the instance variable table. */
187 iv_size(mrb_state *mrb, iv_tbl *t)
192 if (t == NULL) return 0;
193 if (t->size > 0) return t->size;
196 if (seg->next == NULL) {
201 size += MRB_IV_SEGMENT_SIZE;
207 /* Copy the instance variable table. */
209 iv_copy(mrb_state *mrb, iv_tbl *t)
219 while (seg != NULL) {
220 for (i=0; i<MRB_IV_SEGMENT_SIZE; i++) {
221 mrb_sym key = seg->key[i];
222 mrb_value val = seg->val[i];
224 if ((seg->next == NULL) && (i >= t->last_len)) {
227 iv_put(mrb, t2, key, val);
234 /* Free memory of the instance variable table. */
236 iv_free(mrb_state *mrb, iv_tbl *t)
250 iv_mark_i(mrb_state *mrb, mrb_sym sym, mrb_value v, void *p)
252 mrb_gc_mark_value(mrb, v);
257 mark_tbl(mrb_state *mrb, iv_tbl *t)
259 iv_foreach(mrb, t, iv_mark_i, 0);
263 mrb_gc_mark_gv(mrb_state *mrb)
265 mark_tbl(mrb, mrb->globals);
269 mrb_gc_free_gv(mrb_state *mrb)
272 iv_free(mrb, mrb->globals);
276 mrb_gc_mark_iv(mrb_state *mrb, struct RObject *obj)
278 mark_tbl(mrb, obj->iv);
282 mrb_gc_mark_iv_size(mrb_state *mrb, struct RObject *obj)
284 return iv_size(mrb, obj->iv);
288 mrb_gc_free_iv(mrb_state *mrb, struct RObject *obj)
291 iv_free(mrb, obj->iv);
296 mrb_vm_special_get(mrb_state *mrb, mrb_sym i)
298 return mrb_fixnum_value(0);
302 mrb_vm_special_set(mrb_state *mrb, mrb_sym i, mrb_value v)
307 obj_iv_p(mrb_value obj)
309 switch (mrb_type(obj)) {
316 case MRB_TT_EXCEPTION:
324 mrb_obj_iv_get(mrb_state *mrb, struct RObject *obj, mrb_sym sym)
328 if (obj->iv && iv_get(mrb, obj->iv, sym, &v))
330 return mrb_nil_value();
334 mrb_iv_get(mrb_state *mrb, mrb_value obj, mrb_sym sym)
337 return mrb_obj_iv_get(mrb, mrb_obj_ptr(obj), sym);
339 return mrb_nil_value();
342 static inline void assign_class_name(mrb_state *mrb, struct RObject *obj, mrb_sym sym, mrb_value v);
345 mrb_obj_iv_set(mrb_state *mrb, struct RObject *obj, mrb_sym sym, mrb_value v)
349 if (MRB_FROZEN_P(obj)) {
350 mrb_raisef(mrb, E_FROZEN_ERROR, "can't modify frozen %S", mrb_obj_value(obj));
352 assign_class_name(mrb, obj, sym, v);
354 obj->iv = iv_new(mrb);
357 iv_put(mrb, t, sym, v);
358 mrb_write_barrier(mrb, (struct RBasic*)obj);
361 /* Iterates over the instance variable table. */
363 mrb_iv_foreach(mrb_state *mrb, mrb_value obj, mrb_iv_foreach_func *func, void *p)
365 if (!obj_iv_p(obj)) return;
366 iv_foreach(mrb, mrb_obj_ptr(obj)->iv, func, p);
369 static inline mrb_bool
370 namespace_p(enum mrb_vtype tt)
372 return tt == MRB_TT_CLASS || tt == MRB_TT_MODULE ? TRUE : FALSE;
376 assign_class_name(mrb_state *mrb, struct RObject *obj, mrb_sym sym, mrb_value v)
378 if (namespace_p(obj->tt) && namespace_p(mrb_type(v))) {
379 struct RObject *c = mrb_obj_ptr(v);
380 if (obj != c && ISUPPER(mrb_sym2name(mrb, sym)[0])) {
381 mrb_sym id_classname = mrb_intern_lit(mrb, "__classname__");
382 mrb_value o = mrb_obj_iv_get(mrb, c, id_classname);
385 mrb_sym id_outer = mrb_intern_lit(mrb, "__outer__");
386 o = mrb_obj_iv_get(mrb, c, id_outer);
389 if ((struct RClass *)obj == mrb->object_class) {
390 mrb_obj_iv_set(mrb, c, id_classname, mrb_symbol_value(sym));
393 mrb_obj_iv_set(mrb, c, id_outer, mrb_obj_value(obj));
402 mrb_iv_set(mrb_state *mrb, mrb_value obj, mrb_sym sym, mrb_value v)
405 mrb_obj_iv_set(mrb, mrb_obj_ptr(obj), sym, v);
408 mrb_raise(mrb, E_ARGUMENT_ERROR, "cannot set instance variable");
413 mrb_obj_iv_defined(mrb_state *mrb, struct RObject *obj, mrb_sym sym)
419 return iv_get(mrb, t, sym, NULL);
425 mrb_iv_defined(mrb_state *mrb, mrb_value obj, mrb_sym sym)
427 if (!obj_iv_p(obj)) return FALSE;
428 return mrb_obj_iv_defined(mrb, mrb_obj_ptr(obj), sym);
432 mrb_iv_name_sym_p(mrb_state *mrb, mrb_sym iv_name)
437 s = mrb_sym2name_len(mrb, iv_name, &len);
438 if (len < 2) return FALSE;
439 if (s[0] != '@') return FALSE;
440 if (ISDIGIT(s[1])) return FALSE;
441 return mrb_ident_p(s+1, len-1);
445 mrb_iv_name_sym_check(mrb_state *mrb, mrb_sym iv_name)
447 if (!mrb_iv_name_sym_p(mrb, iv_name)) {
448 mrb_name_error(mrb, iv_name, "'%S' is not allowed as an instance variable name", mrb_sym2str(mrb, iv_name));
453 mrb_iv_copy(mrb_state *mrb, mrb_value dest, mrb_value src)
455 struct RObject *d = mrb_obj_ptr(dest);
456 struct RObject *s = mrb_obj_ptr(src);
463 mrb_write_barrier(mrb, (struct RBasic*)d);
464 d->iv = iv_copy(mrb, s->iv);
469 inspect_i(mrb_state *mrb, mrb_sym sym, mrb_value v, void *p)
471 mrb_value str = *(mrb_value*)p;
475 char *sp = RSTRING_PTR(str);
477 /* need not to show internal data */
478 if (sp[0] == '-') { /* first element */
480 mrb_str_cat_lit(mrb, str, " ");
483 mrb_str_cat_lit(mrb, str, ", ");
485 s = mrb_sym2name_len(mrb, sym, &len);
486 mrb_str_cat(mrb, str, s, len);
487 mrb_str_cat_lit(mrb, str, "=");
488 if (mrb_type(v) == MRB_TT_OBJECT) {
489 ins = mrb_any_to_s(mrb, v);
492 ins = mrb_inspect(mrb, v);
494 mrb_str_cat_str(mrb, str, ins);
499 mrb_obj_iv_inspect(mrb_state *mrb, struct RObject *obj)
502 size_t len = iv_size(mrb, t);
505 const char *cn = mrb_obj_classname(mrb, mrb_obj_value(obj));
506 mrb_value str = mrb_str_new_capa(mrb, 30);
508 mrb_str_cat_lit(mrb, str, "-<");
509 mrb_str_cat_cstr(mrb, str, cn);
510 mrb_str_cat_lit(mrb, str, ":");
511 mrb_str_concat(mrb, str, mrb_ptr_to_str(mrb, obj));
513 iv_foreach(mrb, t, inspect_i, &str);
514 mrb_str_cat_lit(mrb, str, ">");
517 return mrb_any_to_s(mrb, mrb_obj_value(obj));
521 mrb_iv_remove(mrb_state *mrb, mrb_value obj, mrb_sym sym)
524 iv_tbl *t = mrb_obj_ptr(obj)->iv;
527 if (iv_del(mrb, t, sym, &val)) {
531 return mrb_undef_value();
535 iv_i(mrb_state *mrb, mrb_sym sym, mrb_value v, void *p)
541 ary = *(mrb_value*)p;
542 s = mrb_sym2name_len(mrb, sym, &len);
543 if (len > 1 && s[0] == '@' && s[1] != '@') {
544 mrb_ary_push(mrb, ary, mrb_symbol_value(sym));
552 * obj.instance_variables -> array
554 * Returns an array of instance variable names for the receiver. Note
555 * that simply defining an accessor does not create the corresponding
564 * Fred.new.instance_variables #=> [:@iv]
567 mrb_obj_instance_variables(mrb_state *mrb, mrb_value self)
571 ary = mrb_ary_new(mrb);
572 if (obj_iv_p(self)) {
573 iv_foreach(mrb, mrb_obj_ptr(self)->iv, iv_i, &ary);
579 cv_i(mrb_state *mrb, mrb_sym sym, mrb_value v, void *p)
585 ary = *(mrb_value*)p;
586 s = mrb_sym2name_len(mrb, sym, &len);
587 if (len > 2 && s[0] == '@' && s[1] == '@') {
588 mrb_ary_push(mrb, ary, mrb_symbol_value(sym));
596 * mod.class_variables -> array
598 * Returns an array of the names of class variables in <i>mod</i>.
606 * One.class_variables #=> [:@@var1]
607 * Two.class_variables #=> [:@@var2]
610 mrb_mod_class_variables(mrb_state *mrb, mrb_value mod)
615 ary = mrb_ary_new(mrb);
616 c = mrb_class_ptr(mod);
618 iv_foreach(mrb, c->iv, cv_i, &ary);
625 mrb_mod_cv_get(mrb_state *mrb, struct RClass *c, mrb_sym sym)
627 struct RClass * cls = c;
632 if (c->iv && iv_get(mrb, c->iv, sym, &v)) {
638 if (cls && cls->tt == MRB_TT_SCLASS) {
641 klass = mrb_obj_iv_get(mrb, (struct RObject *)cls,
642 mrb_intern_lit(mrb, "__attached__"));
643 c = mrb_class_ptr(klass);
644 if (c->tt == MRB_TT_CLASS || c->tt == MRB_TT_MODULE) {
647 if (c->iv && iv_get(mrb, c->iv, sym, &v)) {
655 mrb_name_error(mrb, sym, "uninitialized class variable %S in %S",
656 mrb_sym2str(mrb, sym), mrb_obj_value(cls));
658 return mrb_nil_value();
662 mrb_cv_get(mrb_state *mrb, mrb_value mod, mrb_sym sym)
664 return mrb_mod_cv_get(mrb, mrb_class_ptr(mod), sym);
668 mrb_mod_cv_set(mrb_state *mrb, struct RClass *c, mrb_sym sym, mrb_value v)
670 struct RClass * cls = c;
675 if (iv_get(mrb, t, sym, NULL)) {
676 iv_put(mrb, t, sym, v);
677 mrb_write_barrier(mrb, (struct RBasic*)c);
683 if (cls && cls->tt == MRB_TT_SCLASS) {
686 klass = mrb_obj_iv_get(mrb, (struct RObject*)cls,
687 mrb_intern_lit(mrb, "__attached__"));
688 switch (mrb_type(klass)) {
692 c = mrb_class_ptr(klass);
707 iv_put(mrb, c->iv, sym, v);
708 mrb_write_barrier(mrb, (struct RBasic*)c);
712 mrb_cv_set(mrb_state *mrb, mrb_value mod, mrb_sym sym, mrb_value v)
714 mrb_mod_cv_set(mrb, mrb_class_ptr(mod), sym, v);
718 mrb_mod_cv_defined(mrb_state *mrb, struct RClass * c, mrb_sym sym)
722 if (iv_get(mrb, t, sym, NULL)) return TRUE;
730 mrb_cv_defined(mrb_state *mrb, mrb_value mod, mrb_sym sym)
732 return mrb_mod_cv_defined(mrb, mrb_class_ptr(mod), sym);
736 mrb_vm_cv_get(mrb_state *mrb, mrb_sym sym)
740 c = MRB_PROC_TARGET_CLASS(mrb->c->ci->proc);
741 return mrb_mod_cv_get(mrb, c, sym);
745 mrb_vm_cv_set(mrb_state *mrb, mrb_sym sym, mrb_value v)
749 c = MRB_PROC_TARGET_CLASS(mrb->c->ci->proc);
750 mrb_mod_cv_set(mrb, c, sym, v);
754 mod_const_check(mrb_state *mrb, mrb_value mod)
756 switch (mrb_type(mod)) {
762 mrb_raise(mrb, E_TYPE_ERROR, "constant look-up for non class/module");
768 const_get(mrb_state *mrb, struct RClass *base, mrb_sym sym)
770 struct RClass *c = base;
772 mrb_bool retry = FALSE;
778 if (iv_get(mrb, c->iv, sym, &v))
783 if (!retry && base->tt == MRB_TT_MODULE) {
784 c = mrb->object_class;
788 name = mrb_symbol_value(sym);
789 return mrb_funcall_argv(mrb, mrb_obj_value(base), mrb_intern_lit(mrb, "const_missing"), 1, &name);
793 mrb_const_get(mrb_state *mrb, mrb_value mod, mrb_sym sym)
795 mod_const_check(mrb, mod);
796 return const_get(mrb, mrb_class_ptr(mod), sym);
800 mrb_vm_const_get(mrb_state *mrb, mrb_sym sym)
807 c = MRB_PROC_TARGET_CLASS(mrb->c->ci->proc);
808 if (iv_get(mrb, c->iv, sym, &v)) {
812 while (c2 && c2->tt == MRB_TT_SCLASS) {
815 if (!iv_get(mrb, c2->iv, mrb_intern_lit(mrb, "__attached__"), &klass)) {
819 c2 = mrb_class_ptr(klass);
821 if (c2 && (c2->tt == MRB_TT_CLASS || c2->tt == MRB_TT_MODULE)) c = c2;
822 mrb_assert(!MRB_PROC_CFUNC_P(mrb->c->ci->proc));
823 proc = mrb->c->ci->proc;
825 c2 = MRB_PROC_TARGET_CLASS(proc);
826 if (c2 && iv_get(mrb, c2->iv, sym, &v)) {
831 return const_get(mrb, c, sym);
835 mrb_const_set(mrb_state *mrb, mrb_value mod, mrb_sym sym, mrb_value v)
837 mod_const_check(mrb, mod);
838 if (mrb_type(v) == MRB_TT_CLASS || mrb_type(v) == MRB_TT_MODULE) {
839 mrb_class_name_class(mrb, mrb_class_ptr(mod), mrb_class_ptr(v), sym);
841 mrb_iv_set(mrb, mod, sym, v);
845 mrb_vm_const_set(mrb_state *mrb, mrb_sym sym, mrb_value v)
849 c = MRB_PROC_TARGET_CLASS(mrb->c->ci->proc);
850 mrb_obj_iv_set(mrb, (struct RObject*)c, sym, v);
854 mrb_const_remove(mrb_state *mrb, mrb_value mod, mrb_sym sym)
856 mod_const_check(mrb, mod);
857 mrb_iv_remove(mrb, mod, sym);
861 mrb_define_const(mrb_state *mrb, struct RClass *mod, const char *name, mrb_value v)
863 mrb_obj_iv_set(mrb, (struct RObject*)mod, mrb_intern_cstr(mrb, name), v);
867 mrb_define_global_const(mrb_state *mrb, const char *name, mrb_value val)
869 mrb_define_const(mrb, mrb->object_class, name, val);
873 const_i(mrb_state *mrb, mrb_sym sym, mrb_value v, void *p)
879 ary = *(mrb_value*)p;
880 s = mrb_sym2name_len(mrb, sym, &len);
881 if (len >= 1 && ISUPPER(s[0])) {
882 mrb_ary_push(mrb, ary, mrb_symbol_value(sym));
890 * mod.constants -> array
892 * Returns an array of all names of contants defined in the receiver.
895 mrb_mod_constants(mrb_state *mrb, mrb_value mod)
898 mrb_bool inherit = TRUE;
899 struct RClass *c = mrb_class_ptr(mod);
901 mrb_get_args(mrb, "|b", &inherit);
902 ary = mrb_ary_new(mrb);
904 iv_foreach(mrb, c->iv, const_i, &ary);
907 if (c == mrb->object_class) break;
913 mrb_gv_get(mrb_state *mrb, mrb_sym sym)
917 if (iv_get(mrb, mrb->globals, sym, &v))
919 return mrb_nil_value();
923 mrb_gv_set(mrb_state *mrb, mrb_sym sym, mrb_value v)
928 mrb->globals = iv_new(mrb);
931 iv_put(mrb, t, sym, v);
935 mrb_gv_remove(mrb_state *mrb, mrb_sym sym)
937 iv_del(mrb, mrb->globals, sym, NULL);
941 gv_i(mrb_state *mrb, mrb_sym sym, mrb_value v, void *p)
945 ary = *(mrb_value*)p;
946 mrb_ary_push(mrb, ary, mrb_symbol_value(sym));
954 * global_variables -> array
956 * Returns an array of the names of global variables.
958 * global_variables.grep /std/ #=> [:$stdin, :$stdout, :$stderr]
961 mrb_f_global_variables(mrb_state *mrb, mrb_value self)
963 iv_tbl *t = mrb->globals;
964 mrb_value ary = mrb_ary_new(mrb);
968 iv_foreach(mrb, t, gv_i, &ary);
971 for (i = 1; i <= 9; ++i) {
972 buf[1] = (char)(i + '0');
973 mrb_ary_push(mrb, ary, mrb_symbol_value(mrb_intern(mrb, buf, 2)));
979 mrb_const_defined_0(mrb_state *mrb, mrb_value mod, mrb_sym id, mrb_bool exclude, mrb_bool recurse)
981 struct RClass *klass = mrb_class_ptr(mod);
983 mrb_bool mod_retry = FALSE;
988 if (iv_get(mrb, tmp->iv, id, NULL)) {
991 if (!recurse && (klass != mrb->object_class)) break;
994 if (!exclude && !mod_retry && (klass->tt == MRB_TT_MODULE)) {
996 tmp = mrb->object_class;
1003 mrb_const_defined(mrb_state *mrb, mrb_value mod, mrb_sym id)
1005 return mrb_const_defined_0(mrb, mod, id, TRUE, TRUE);
1009 mrb_const_defined_at(mrb_state *mrb, mrb_value mod, mrb_sym id)
1011 return mrb_const_defined_0(mrb, mod, id, TRUE, FALSE);
1015 mrb_attr_get(mrb_state *mrb, mrb_value obj, mrb_sym id)
1017 return mrb_iv_get(mrb, obj, id);
1026 csym_i(mrb_state *mrb, mrb_sym sym, mrb_value v, void *p)
1028 struct csym_arg *a = (struct csym_arg*)p;
1029 struct RClass *c = a->c;
1031 if (mrb_type(v) == c->tt && mrb_class_ptr(v) == c) {
1033 return 1; /* stop iteration */
1039 find_class_sym(mrb_state *mrb, struct RClass *outer, struct RClass *c)
1041 struct csym_arg arg;
1043 if (!outer) return 0;
1044 if (outer == c) return 0;
1047 iv_foreach(mrb, outer->iv, csym_i, &arg);
1051 static struct RClass*
1052 outer_class(mrb_state *mrb, struct RClass *c)
1056 ov = mrb_obj_iv_get(mrb, (struct RObject*)c, mrb_intern_lit(mrb, "__outer__"));
1057 if (mrb_nil_p(ov)) return NULL;
1058 switch (mrb_type(ov)) {
1061 return mrb_class_ptr(ov);
1069 detect_outer_loop(mrb_state *mrb, struct RClass *c)
1071 struct RClass *t = c; /* tortoise */
1072 struct RClass *h = c; /* hare */
1075 if (h == NULL) return FALSE;
1076 h = outer_class(mrb, h);
1077 if (h == NULL) return FALSE;
1078 h = outer_class(mrb, h);
1079 t = outer_class(mrb, t);
1080 if (t == h) return TRUE;
1085 mrb_class_find_path(mrb_state *mrb, struct RClass *c)
1087 struct RClass *outer;
1093 if (detect_outer_loop(mrb, c)) return mrb_nil_value();
1094 outer = outer_class(mrb, c);
1095 if (outer == NULL) return mrb_nil_value();
1096 name = find_class_sym(mrb, outer, c);
1097 if (name == 0) return mrb_nil_value();
1098 str = mrb_class_name(mrb, outer);
1099 path = mrb_str_new_capa(mrb, 40);
1100 mrb_str_cat_cstr(mrb, path, str);
1101 mrb_str_cat_cstr(mrb, path, "::");
1103 str = mrb_sym2name_len(mrb, name, &len);
1104 mrb_str_cat(mrb, path, str, len);
1105 if (RSTRING_PTR(path)[0] != '#') {
1106 iv_del(mrb, c->iv, mrb_intern_lit(mrb, "__outer__"), NULL);
1107 iv_put(mrb, c->iv, mrb_intern_lit(mrb, "__classname__"), path);
1108 mrb_field_write_barrier_value(mrb, (struct RBasic*)c, path);
1113 #define identchar(c) (ISALNUM(c) || (c) == '_' || !ISASCII(c))
1116 mrb_ident_p(const char *s, mrb_int len)
1118 for (mrb_int i = 0; i < len; i++) {
1119 if (!identchar(s[i])) return FALSE;