diff options
Diffstat (limited to 'variable.c')
| -rw-r--r-- | variable.c | 3311 |
1 files changed, 2632 insertions, 679 deletions
diff --git a/variable.c b/variable.c index 0edb280da2..bfb6fa2edd 100644 --- a/variable.c +++ b/variable.c @@ -1,520 +1,722 @@ -/************************************************ +/********************************************************************** variable.c - $Author$ - $Date$ created at: Tue Apr 19 23:55:15 JST 1994 -************************************************/ - -#include "ruby.h" -#include "env.h" -#include "node.h" -#include "st.h" + Copyright (C) 1993-2007 Yukihiro Matsumoto + Copyright (C) 2000 Network Applied Communication Laboratory, Inc. + Copyright (C) 2000 Information-technology Promotion Agency, Japan + +**********************************************************************/ + +#include "internal.h" +#include "ruby/st.h" +#include "ruby/util.h" +#include "id_table.h" +#include "constant.h" +#include "id.h" +#include "ccan/list/list.h" +#include "id_table.h" +#include "debug_counter.h" +#include "vm_core.h" + +struct rb_id_table *rb_global_tbl; +static ID autoload, classpath, tmp_classpath, classid; + +static void check_before_mod_set(VALUE, ID, VALUE, const char *); +static void setup_const_entry(rb_const_entry_t *, VALUE, VALUE, rb_const_flag_t); +static VALUE rb_const_search(VALUE klass, ID id, int exclude, int recurse, int visibility); +static st_table *generic_iv_tbl; +static st_table *generic_iv_tbl_compat; -#ifndef strdup -char *strdup(); -#endif +/* per-object */ +struct gen_ivtbl { + uint32_t numiv; + VALUE ivptr[1]; /* flexible array */ +}; -static st_table *rb_global_tbl; -st_table *rb_class_tbl; +struct ivar_update { + union { + st_table *iv_index_tbl; + struct gen_ivtbl *ivtbl; + } u; + st_data_t index; + int iv_extended; +}; void -Init_var_tables() +Init_var_tables(void) { - rb_global_tbl = st_init_numtable(); - rb_class_tbl = st_init_numtable(); + rb_global_tbl = rb_id_table_create(0); + generic_iv_tbl = st_init_numtable(); + autoload = rb_intern_const("__autoload__"); + /* __classpath__: fully qualified class path */ + classpath = rb_intern_const("__classpath__"); + /* __tmp_classpath__: temporary class path which contains anonymous names */ + tmp_classpath = rb_intern_const("__tmp_classpath__"); + /* __classid__: name given to class/module under an anonymous namespace */ + classid = rb_intern_const("__classid__"); } struct fc_result { - ID name; + ID name, preferred; VALUE klass; VALUE path; VALUE track; struct fc_result *prev; }; -static int -fc_i(key, value, res) - ID key; - VALUE value; - struct fc_result *res; -{ - VALUE path; - char *name; - - if (!rb_is_const_id(key)) return ST_CONTINUE; - - name = rb_id2name(key); - if (res->path) { - path = rb_str_dup(res->path); - rb_str_cat(path, "::", 2); - rb_str_cat(path, name, strlen(name)); - } - else { - path = rb_str_new2(name); - } - if (value == res->klass) { - res->name = key; - res->path = path; - return ST_STOP; +static VALUE +fc_path(struct fc_result *fc, ID name) +{ + VALUE path, tmp; + + path = rb_id2str(name); + while (fc) { + st_data_t n; + if (fc->track == rb_cObject) break; + if (RCLASS_IV_TBL(fc->track) && + st_lookup(RCLASS_IV_TBL(fc->track), (st_data_t)classpath, &n)) { + tmp = rb_str_dup((VALUE)n); + rb_str_cat2(tmp, "::"); + rb_str_append(tmp, path); + path = tmp; + break; + } + tmp = rb_str_dup(rb_id2str(fc->name)); + rb_str_cat2(tmp, "::"); + rb_str_append(tmp, path); + path = tmp; + fc = fc->prev; } - if (rb_obj_is_kind_of(value, rb_cModule)) { - struct fc_result arg; - struct fc_result *list; + OBJ_FREEZE(path); + return path; +} +static enum rb_id_table_iterator_result +fc_i(ID key, VALUE v, void *a) +{ + rb_const_entry_t *ce = (rb_const_entry_t *)v; + struct fc_result *res = a; + VALUE value = ce->value; + if (!rb_is_const_id(key)) return ID_TABLE_CONTINUE; - if (!RCLASS(value)->iv_tbl) return ST_CONTINUE; + if (value == res->klass && (!res->preferred || key == res->preferred)) { + res->path = fc_path(res, key); + return ID_TABLE_STOP; + } + if (RB_TYPE_P(value, T_MODULE) || RB_TYPE_P(value, T_CLASS)) { + if (!RCLASS_CONST_TBL(value)) return ID_TABLE_CONTINUE; + else { + struct fc_result arg; + struct fc_result *list; - list = res; - while (list) { - if (list->track == value) return ST_CONTINUE; - list = list->prev; - } + list = res; + while (list) { + if (list->track == value) return ID_TABLE_CONTINUE; + list = list->prev; + } - arg.name = 0; - arg.path = path; - arg.klass = res->klass; - arg.track = value; - arg.prev = res; - st_foreach(RCLASS(value)->iv_tbl, fc_i, &arg); - if (arg.name) { - res->name = arg.name; - res->path = arg.path; - return ST_STOP; + arg.name = key; + arg.preferred = res->preferred; + arg.path = 0; + arg.klass = res->klass; + arg.track = value; + arg.prev = res; + rb_id_table_foreach(RCLASS_CONST_TBL(value), fc_i, &arg); + if (arg.path) { + res->path = arg.path; + return ID_TABLE_STOP; + } } } - return ST_CONTINUE; + return ID_TABLE_CONTINUE; } +/** + * Traverse constant namespace and find +classpath+ for _klass_. If + * _preferred_ is not 0, choice the path whose base name is set to it. + * If +classpath+ is found, the hidden instance variable __classpath__ + * is set to the found path, and __tmp_classpath__ is removed. + * The path is frozen. + */ static VALUE -find_class_path(klass) - VALUE klass; +find_class_path(VALUE klass, ID preferred) { struct fc_result arg; + arg.preferred = preferred; arg.name = 0; arg.path = 0; arg.klass = klass; arg.track = rb_cObject; arg.prev = 0; - if (RCLASS(rb_cObject)->iv_tbl) { - st_foreach(RCLASS(rb_cObject)->iv_tbl, fc_i, &arg); + if (RCLASS_CONST_TBL(rb_cObject)) { + rb_id_table_foreach(RCLASS_CONST_TBL(rb_cObject), fc_i, &arg); } - if (arg.name == 0) { - st_foreach(rb_class_tbl, fc_i, &arg); - } - if (arg.name) { - st_insert(ROBJECT(klass)->iv_tbl,rb_intern("__classpath__"),arg.path); + if (arg.path) { + st_data_t tmp = tmp_classpath; + if (!RCLASS_IV_TBL(klass)) { + RCLASS_IV_TBL(klass) = st_init_numtable(); + } + rb_class_ivar_set(klass, classpath, arg.path); + + st_delete(RCLASS_IV_TBL(klass), &tmp, 0); return arg.path; } return Qnil; } +/** + * Returns +classpath+ of _klass_, if it is named, or +nil+ for + * anonymous +class+/+module+. The last part of named +classpath+ is + * never anonymous, but anonymous +class+/+module+ names may be + * contained. If the path is "permanent", that means it has no + * anonymous names, <code>*permanent</code> is set to 1. + */ static VALUE -classname(klass) - VALUE klass; +classname(VALUE klass, int *permanent) { VALUE path = Qnil; - ID classpath = rb_intern("__classpath__"); + st_data_t n; - while (TYPE(klass) == T_ICLASS || FL_TEST(klass, FL_SINGLETON)) { - klass = (VALUE)RCLASS(klass)->super; - } if (!klass) klass = rb_cObject; - if (!ROBJECT(klass)->iv_tbl) - ROBJECT(klass)->iv_tbl = st_init_numtable(); - else if (!st_lookup(ROBJECT(klass)->iv_tbl, classpath, &path)) { - ID classid = rb_intern("__classid__"); - - if (st_lookup(ROBJECT(klass)->iv_tbl, classid, &path)) { - path = rb_str_new2(rb_id2name(FIX2INT(path))); - st_insert(ROBJECT(klass)->iv_tbl, classpath, path); - st_delete(RCLASS(klass)->iv_tbl, &classid, 0); + *permanent = 1; + if (RCLASS_IV_TBL(klass)) { + if (!st_lookup(RCLASS_IV_TBL(klass), (st_data_t)classpath, &n)) { + ID cid = 0; + if (st_lookup(RCLASS_IV_TBL(klass), (st_data_t)classid, &n)) { + VALUE cname = (VALUE)n; + cid = rb_check_id(&cname); + if (cid) path = find_class_path(klass, cid); + } + if (NIL_P(path)) { + path = find_class_path(klass, (ID)0); + } + if (NIL_P(path)) { + if (!cid) { + return Qnil; + } + if (!st_lookup(RCLASS_IV_TBL(klass), (st_data_t)tmp_classpath, &n)) { + path = rb_id2str(cid); + return path; + } + *permanent = 0; + path = (VALUE)n; + return path; + } } - } - if (NIL_P(path)) { - path = find_class_path(klass); - if (NIL_P(path)) { - return 0; + else { + path = (VALUE)n; + } + if (!RB_TYPE_P(path, T_STRING)) { + rb_bug("class path is not set properly"); } return path; } - if (TYPE(path) != T_STRING) - rb_bug("class path is not set properly"); + return find_class_path(klass, (ID)0); +} + +/* + * call-seq: + * mod.name -> string + * + * Returns the name of the module <i>mod</i>. Returns nil for anonymous modules. + */ + +VALUE +rb_mod_name(VALUE mod) +{ + int permanent; + VALUE path = classname(mod, &permanent); + + if (!NIL_P(path)) return rb_str_dup(path); + return path; +} + +static VALUE +make_temporary_path(VALUE obj, VALUE klass) +{ + VALUE path; + switch (klass) { + case Qnil: + path = rb_sprintf("#<Class:%p>", (void*)obj); + break; + case Qfalse: + path = rb_sprintf("#<Module:%p>", (void*)obj); + break; + default: + path = rb_sprintf("#<%"PRIsVALUE":%p>", klass, (void*)obj); + break; + } + OBJ_FREEZE(path); + return path; +} + +typedef VALUE (*path_cache_func)(VALUE obj, VALUE name); + +static VALUE +rb_tmp_class_path(VALUE klass, int *permanent, path_cache_func cache_path) +{ + VALUE path = classname(klass, permanent); + st_data_t n = (st_data_t)path; + + if (!NIL_P(path)) { + return path; + } + if (RCLASS_IV_TBL(klass) && st_lookup(RCLASS_IV_TBL(klass), + (st_data_t)tmp_classpath, &n)) { + *permanent = 0; + return (VALUE)n; + } + else { + if (RB_TYPE_P(klass, T_MODULE)) { + if (rb_obj_class(klass) == rb_cModule) { + path = Qfalse; + } + else { + int perm; + path = rb_tmp_class_path(RBASIC(klass)->klass, &perm, cache_path); + } + } + *permanent = 0; + return cache_path(klass, path); + } +} + +static VALUE +ivar_cache(VALUE obj, VALUE name) +{ + return rb_ivar_set(obj, tmp_classpath, make_temporary_path(obj, name)); +} + +VALUE +rb_class_path(VALUE klass) +{ + int permanent; + VALUE path = rb_tmp_class_path(klass, &permanent, ivar_cache); + if (!NIL_P(path)) path = rb_str_dup(path); return path; } +static VALUE +null_cache(VALUE obj, VALUE name) +{ + return make_temporary_path(obj, name); +} + VALUE -rb_mod_name(mod) - VALUE mod; +rb_class_path_no_cache(VALUE klass) { - VALUE path = classname(mod); + int permanent; + VALUE path = rb_tmp_class_path(klass, &permanent, null_cache); + if (!NIL_P(path)) path = rb_str_dup(path); + return path; +} + +VALUE +rb_class_path_cached(VALUE klass) +{ + st_table *ivtbl; + st_data_t n; + + if (!RCLASS_EXT(klass)) return Qnil; + if (!(ivtbl = RCLASS_IV_TBL(klass))) return Qnil; + if (st_lookup(ivtbl, (st_data_t)classpath, &n)) return (VALUE)n; + if (st_lookup(ivtbl, (st_data_t)tmp_classpath, &n)) return (VALUE)n; + return Qnil; +} - if (path) return rb_str_dup(path); - return rb_str_new(0,0); +static VALUE +never_cache(VALUE obj, VALUE name) +{ + return name; } VALUE -rb_class_path(klass) - VALUE klass; +rb_search_class_path(VALUE klass) { - VALUE path = classname(klass); + int permanent; + return rb_tmp_class_path(klass, &permanent, never_cache); +} - if (path) return path; - else { - char buf[256]; - char *s = "Class"; +void +rb_set_class_path_string(VALUE klass, VALUE under, VALUE name) +{ + VALUE str; + ID pathid = classpath; - if (TYPE(klass) == T_MODULE) s = "Module"; - sprintf(buf, "#<%s 0lx%lx>", s, klass); - return rb_str_new2(buf); + if (under == rb_cObject) { + str = rb_str_new_frozen(name); + } + else { + int permanent; + str = rb_str_dup(rb_tmp_class_path(under, &permanent, ivar_cache)); + rb_str_cat2(str, "::"); + rb_str_append(str, name); + OBJ_FREEZE(str); + if (!permanent) { + pathid = tmp_classpath; + rb_ivar_set(klass, classid, rb_str_intern(name)); + } } + rb_ivar_set(klass, pathid, str); } void -rb_set_class_path(klass, under, name) - VALUE klass, under; - const char *name; +rb_set_class_path(VALUE klass, VALUE under, const char *name) { VALUE str; + ID pathid = classpath; if (under == rb_cObject) { str = rb_str_new2(name); } else { - str = rb_str_dup(rb_class_path(under)); - rb_str_cat(str, "::", 2); - rb_str_cat(str, name, strlen(name)); + int permanent; + str = rb_str_dup(rb_tmp_class_path(under, &permanent, ivar_cache)); + rb_str_cat2(str, "::"); + rb_str_cat2(str, name); + if (!permanent) { + pathid = tmp_classpath; + rb_ivar_set(klass, classid, rb_str_intern(rb_str_new_cstr(name))); + } } - rb_iv_set(klass, "__classpath__", str); + OBJ_FREEZE(str); + rb_ivar_set(klass, pathid, str); } VALUE -rb_path2class(path) - const char *path; +rb_path_to_class(VALUE pathname) { - if (path[0] == '#') { - rb_raise(rb_eArgError, "can't retrieve anonymous class %s", path); + rb_encoding *enc = rb_enc_get(pathname); + const char *pbeg, *pend, *p, *path = RSTRING_PTR(pathname); + ID id; + VALUE c = rb_cObject; + + if (!rb_enc_asciicompat(enc)) { + rb_raise(rb_eArgError, "invalid class path encoding (non ASCII)"); + } + pbeg = p = path; + pend = path + RSTRING_LEN(pathname); + if (path == pend || path[0] == '#') { + rb_raise(rb_eArgError, "can't retrieve anonymous class %"PRIsVALUE, + QUOTE(pathname)); + } + while (p < pend) { + while (p < pend && *p != ':') p++; + id = rb_check_id_cstr(pbeg, p-pbeg, enc); + if (p < pend && p[0] == ':') { + if ((size_t)(pend - p) < 2 || p[1] != ':') goto undefined_class; + p += 2; + pbeg = p; + } + if (!id) { + undefined_class: + rb_raise(rb_eArgError, "undefined class/module % "PRIsVALUE, + rb_str_subseq(pathname, 0, p-path)); + } + c = rb_const_search(c, id, TRUE, FALSE, FALSE); + if (c == Qundef) goto undefined_class; + if (!RB_TYPE_P(c, T_MODULE) && !RB_TYPE_P(c, T_CLASS)) { + rb_raise(rb_eTypeError, "%"PRIsVALUE" does not refer to class/module", + pathname); + } } - return rb_eval_string(path); -} + RB_GC_GUARD(pathname); -void -rb_name_class(klass, id) - VALUE klass; - ID id; -{ - rb_iv_set(klass, "__classid__", INT2FIX(id)); + return c; } -static st_table *autoload_tbl = 0; - -static void -rb_autoload_id(id, filename) - ID id; - const char *filename; +VALUE +rb_path2class(const char *path) { - if (!rb_is_const_id(id)) { - rb_raise(rb_eNameError, "autoload must be constant name", - rb_id2name(id)); - } - - if (!autoload_tbl) { - autoload_tbl = st_init_numtable(); - } - st_insert(autoload_tbl, id, strdup(filename)); + return rb_path_to_class(rb_str_new_cstr(path)); } void -rb_autoload(klass, filename) - const char *klass, *filename; +rb_name_class(VALUE klass, ID id) { - rb_autoload_id(rb_intern(klass), filename); + rb_ivar_set(klass, classid, ID2SYM(id)); } VALUE -rb_f_autoload(obj, klass, file) - VALUE obj, klass, file; +rb_class_name(VALUE klass) { - rb_autoload_id(rb_to_id(klass), STR2CSTR(file)); - return Qnil; + return rb_class_path(rb_class_real(klass)); } -char * -rb_class2name(klass) - VALUE klass; +const char * +rb_class2name(VALUE klass) { - if (klass == rb_cNilClass) return "nil"; - if (klass == rb_cTrueClass) return "true"; - if (klass == rb_cFalseClass) return "false"; - return RSTRING(rb_class_path(klass))->ptr; + int permanent; + VALUE path = rb_tmp_class_path(rb_class_real(klass), &permanent, ivar_cache); + if (NIL_P(path)) return NULL; + return RSTRING_PTR(path); +} + +const char * +rb_obj_classname(VALUE obj) +{ + return rb_class2name(CLASS_OF(obj)); } struct trace_var { int removed; - void (*func)(); - void *data; + void (*func)(VALUE arg, VALUE val); + VALUE data; struct trace_var *next; }; -struct global_entry { - ID id; - void *data; - VALUE (*getter)(); - void (*setter)(); - void (*marker)(); +struct rb_global_variable { + int counter; int block_trace; + void *data; + rb_gvar_getter_t *getter; + rb_gvar_setter_t *setter; + rb_gvar_marker_t *marker; struct trace_var *trace; }; -static VALUE undef_getter(); -static void undef_setter(); -static void undef_marker(); - -static VALUE val_getter(); -static void val_setter(); -static void val_marker(); - -static VALUE var_getter(); -static void var_setter(); -static void var_marker(); - -struct global_entry* -rb_global_entry(id) - ID id; +struct rb_global_entry* +rb_global_entry(ID id) { - struct global_entry *entry; + struct rb_global_entry *entry; + VALUE data; - if (!st_lookup(rb_global_tbl, id, &entry)) { - entry = ALLOC(struct global_entry); - st_add_direct(rb_global_tbl, id, entry); + if (!rb_id_table_lookup(rb_global_tbl, id, &data)) { + struct rb_global_variable *var; + entry = ALLOC(struct rb_global_entry); + var = ALLOC(struct rb_global_variable); entry->id = id; - entry->data = 0; - entry->getter = undef_getter; - entry->setter = undef_setter; - entry->marker = undef_marker; + entry->var = var; + var->counter = 1; + var->data = 0; + var->getter = rb_gvar_undef_getter; + var->setter = rb_gvar_undef_setter; + var->marker = rb_gvar_undef_marker; - entry->block_trace = 0; - entry->trace = 0; + var->block_trace = 0; + var->trace = 0; + rb_id_table_insert(rb_global_tbl, id, (VALUE)entry); + } + else { + entry = (struct rb_global_entry *)data; } return entry; } -static VALUE -undef_getter(id) - ID id; +VALUE +rb_gvar_undef_getter(ID id, void *data, struct rb_global_variable *var) { - if (ruby_verbose) { - rb_warning("global variable `%s' not initialized", rb_id2name(id)); - } + rb_warning("global variable `%"PRIsVALUE"' not initialized", QUOTE_ID(id)); + return Qnil; } -static void -undef_setter(val, id, data, entry) - VALUE val; - ID id; - void *data; - struct global_entry *entry; +void +rb_gvar_undef_setter(VALUE val, ID id, void *d, struct rb_global_variable *var) { - entry->getter = val_getter; - entry->setter = val_setter; - entry->marker = val_marker; + var->getter = rb_gvar_val_getter; + var->setter = rb_gvar_val_setter; + var->marker = rb_gvar_val_marker; - entry->data = (void*)val; + var->data = (void*)val; } -static void -undef_marker() +void +rb_gvar_undef_marker(VALUE *var) { } -static VALUE -val_getter(id, val) - ID id; - VALUE val; +VALUE +rb_gvar_val_getter(ID id, void *data, struct rb_global_variable *var) { - return val; + return (VALUE)data; } -static void -val_setter(val, id, data, entry) - VALUE val; - ID id; - void *data; - struct global_entry *entry; +void +rb_gvar_val_setter(VALUE val, ID id, void *data, struct rb_global_variable *var) { - entry->data = (void*)val; + var->data = (void*)val; } -static void -val_marker(data) - void *data; +void +rb_gvar_val_marker(VALUE *var) { + VALUE data = (VALUE)var; if (data) rb_gc_mark_maybe(data); } -static VALUE -var_getter(id, var) - ID id; - VALUE *var; +VALUE +rb_gvar_var_getter(ID id, void *data, struct rb_global_variable *gvar) { - if (!var || !*var) return Qnil; + VALUE *var = data; + if (!var) return Qnil; return *var; } -static void -var_setter(val, id, var) - VALUE val; - ID id; - VALUE *var; +void +rb_gvar_var_setter(VALUE val, ID id, void *data, struct rb_global_variable *g) { - *var = val; + *(VALUE *)data = val; } -static void -var_marker(var) - VALUE **var; +void +rb_gvar_var_marker(VALUE *var) { if (var) rb_gc_mark_maybe(*var); } -static void -readonly_setter(val, id, var) - VALUE val; - ID id; - void *var; +void +rb_gvar_readonly_setter(VALUE v, ID id, void *d, struct rb_global_variable *g) { - rb_raise(rb_eNameError, "can't set variable %s", rb_id2name(id)); + rb_name_error(id, "%"PRIsVALUE" is a read-only variable", QUOTE_ID(id)); } -static int -mark_global_entry(key, entry) - ID key; - struct global_entry *entry; +static enum rb_id_table_iterator_result +mark_global_entry(VALUE v, void *ignored) { + struct rb_global_entry *entry = (struct rb_global_entry *)v; struct trace_var *trace; + struct rb_global_variable *var = entry->var; - (*entry->marker)(entry->data); - trace = entry->trace; + (*var->marker)(var->data); + trace = var->trace; while (trace) { if (trace->data) rb_gc_mark_maybe(trace->data); trace = trace->next; } - return ST_CONTINUE; + return ID_TABLE_CONTINUE; } void -rb_gc_mark_global_tbl() +rb_gc_mark_global_tbl(void) { - st_foreach(rb_global_tbl, mark_global_entry, 0); + if (rb_global_tbl) + rb_id_table_foreach_values(rb_global_tbl, mark_global_entry, 0); } static ID -global_id(name) - const char *name; +global_id(const char *name) { ID id; if (name[0] == '$') id = rb_intern(name); else { - char *buf = ALLOCA_N(char, strlen(name)+2); + size_t len = strlen(name); + char *buf = ALLOCA_N(char, len+1); buf[0] = '$'; - strcpy(buf+1, name); - id = rb_intern(buf); + memcpy(buf+1, name, len); + id = rb_intern2(buf, len+1); } return id; } void -rb_define_hooked_variable(name, var, getter, setter) - const char *name; - VALUE *var; - VALUE (*getter)(); - void (*setter)(); +rb_define_hooked_variable( + const char *name, + VALUE *var, + VALUE (*getter)(ANYARGS), + void (*setter)(ANYARGS)) { - struct global_entry *entry; + volatile VALUE tmp = var ? *var : Qnil; ID id = global_id(name); + struct rb_global_variable *gvar = rb_global_entry(id)->var; - entry = rb_global_entry(id); - entry->data = (void*)var; - entry->getter = getter?getter:var_getter; - entry->setter = setter?setter:var_setter; - entry->marker = var_marker; + gvar->data = (void*)var; + gvar->getter = getter ? (rb_gvar_getter_t *)getter : rb_gvar_var_getter; + gvar->setter = setter ? (rb_gvar_setter_t *)setter : rb_gvar_var_setter; + gvar->marker = rb_gvar_var_marker; + + RB_GC_GUARD(tmp); } void -rb_define_variable(name, var) - const char *name; - VALUE *var; +rb_define_variable(const char *name, VALUE *var) { rb_define_hooked_variable(name, var, 0, 0); } void -rb_define_readonly_variable(name, var) - const char *name; - VALUE *var; +rb_define_readonly_variable(const char *name, const VALUE *var) { - rb_define_hooked_variable(name, var, 0, readonly_setter); + rb_define_hooked_variable(name, (VALUE *)var, 0, rb_gvar_readonly_setter); } void -rb_define_virtual_variable(name, getter, setter) - const char *name; - VALUE (*getter)(); - void (*setter)(); +rb_define_virtual_variable( + const char *name, + VALUE (*getter)(ANYARGS), + void (*setter)(ANYARGS)) { - if (!getter) getter = val_getter; - if (!setter) setter = readonly_setter; + if (!getter) getter = rb_gvar_val_getter; + if (!setter) setter = rb_gvar_readonly_setter; rb_define_hooked_variable(name, 0, getter, setter); } static void -rb_trace_eval(cmd, val) - VALUE cmd, val; -{ - rb_eval_cmd(cmd, rb_ary_new3(1, val)); -} +rb_trace_eval(VALUE cmd, VALUE val) +{ + rb_eval_cmd(cmd, rb_ary_new3(1, val), 0); +} + +/* + * call-seq: + * trace_var(symbol, cmd ) -> nil + * trace_var(symbol) {|val| block } -> nil + * + * Controls tracing of assignments to global variables. The parameter + * +symbol+ identifies the variable (as either a string name or a + * symbol identifier). _cmd_ (which may be a string or a + * +Proc+ object) or block is executed whenever the variable + * is assigned. The block or +Proc+ object receives the + * variable's new value as a parameter. Also see + * <code>Kernel::untrace_var</code>. + * + * trace_var :$_, proc {|v| puts "$_ is now '#{v}'" } + * $_ = "hello" + * $_ = ' there' + * + * <em>produces:</em> + * + * $_ is now 'hello' + * $_ is now ' there' + */ VALUE -rb_f_trace_var(argc, argv) - int argc; - VALUE *argv; +rb_f_trace_var(int argc, const VALUE *argv) { VALUE var, cmd; - ID id; - struct global_entry *entry; + struct rb_global_entry *entry; struct trace_var *trace; if (rb_scan_args(argc, argv, "11", &var, &cmd) == 1) { - cmd = rb_f_lambda(); + cmd = rb_block_proc(); } if (NIL_P(cmd)) { return rb_f_untrace_var(argc, argv); } - id = rb_to_id(var); - if (!st_lookup(rb_global_tbl, id, &entry)) { - rb_raise(rb_eNameError, "undefined global variable %s", - rb_id2name(id)); + entry = rb_global_entry(rb_to_id(var)); + if (OBJ_TAINTED(cmd)) { + rb_raise(rb_eSecurityError, "Insecure: tainted variable trace"); } trace = ALLOC(struct trace_var); - trace->next = entry->trace; + trace->next = entry->var->trace; trace->func = rb_trace_eval; - trace->data = (void*)cmd; + trace->data = cmd; trace->removed = 0; - entry->trace = trace; + entry->var->trace = trace; return Qnil; } static void -remove_trace(entry) - struct global_entry *entry; +remove_trace(struct rb_global_variable *var) { - struct trace_var *trace = entry->trace; + struct trace_var *trace = var->trace; struct trace_var t; struct trace_var *next; @@ -524,31 +726,44 @@ remove_trace(entry) next = trace->next; if (next->removed) { trace->next = next->next; - free(next); + xfree(next); + } + else { + trace = next; } - trace = next; } - entry->trace = t.next; + var->trace = t.next; } +/* + * call-seq: + * untrace_var(symbol [, cmd] ) -> array or nil + * + * Removes tracing for the specified command on the given global + * variable and returns +nil+. If no command is specified, + * removes all tracing for that variable and returns an array + * containing the commands actually removed. + */ + VALUE -rb_f_untrace_var(argc, argv) - int argc; - VALUE *argv; +rb_f_untrace_var(int argc, const VALUE *argv) { VALUE var, cmd; ID id; - struct global_entry *entry; + struct rb_global_entry *entry; struct trace_var *trace; + VALUE data; rb_scan_args(argc, argv, "11", &var, &cmd); - id = rb_to_id(var); - if (!st_lookup(rb_global_tbl, id, &entry)) { - rb_raise(rb_eNameError, "undefined global variable %s", - rb_id2name(id)); + id = rb_check_id(&var); + if (!id) { + rb_name_error_str(var, "undefined global variable %"PRIsVALUE"", QUOTE(var)); + } + if (!rb_id_table_lookup(rb_global_tbl, id, &data)) { + rb_name_error(id, "undefined global variable %"PRIsVALUE"", QUOTE_ID(id)); } - trace = entry->trace; + trace = (entry = (struct rb_global_entry *)data)->var->trace; if (NIL_P(cmd)) { VALUE ary = rb_ary_new(); @@ -558,16 +773,15 @@ rb_f_untrace_var(argc, argv) trace->removed = 1; trace = next; } - entry->trace = 0; - if (!entry->block_trace) remove_trace(entry); + if (!entry->var->block_trace) remove_trace(entry->var); return ary; } else { while (trace) { - if (trace->data == (void*)cmd) { + if (trace->data == cmd) { trace->removed = 1; - if (!entry->block_trace) remove_trace(entry); + if (!entry->var->block_trace) remove_trace(entry->var); return rb_ary_new3(1, cmd); } trace = trace->next; @@ -575,21 +789,21 @@ rb_f_untrace_var(argc, argv) } return Qnil; } + VALUE -rb_gvar_get(entry) - struct global_entry *entry; +rb_gvar_get(struct rb_global_entry *entry) { - return (*entry->getter)(entry->id, entry->data, entry); + struct rb_global_variable *var = entry->var; + return (*var->getter)(entry->id, var->data, var); } struct trace_data { struct trace_var *trace; VALUE val; }; - + static VALUE -trace_ev(data) - struct trace_data *data; +trace_ev(struct trace_data *data) { struct trace_var *trace = data->trace; @@ -597,273 +811,560 @@ trace_ev(data) (*trace->func)(trace->data, data->val); trace = trace->next; } - return Qnil; /* not reached */ + + return Qnil; } static VALUE -trace_en(entry) - struct global_entry *entry; +trace_en(struct rb_global_variable *var) { - entry->block_trace = 0; - remove_trace(entry); + var->block_trace = 0; + remove_trace(var); return Qnil; /* not reached */ } VALUE -rb_gvar_set(entry, val) - struct global_entry *entry; - VALUE val; +rb_gvar_set(struct rb_global_entry *entry, VALUE val) { struct trace_data trace; + struct rb_global_variable *var = entry->var; - if (rb_safe_level() >= 4) - rb_raise(rb_eSecurityError, "Insecure: can't change global variable value"); - (*entry->setter)(val, entry->id, entry->data, entry); + (*var->setter)(val, entry->id, var->data, var); - if (entry->trace && !entry->block_trace) { - entry->block_trace = 1; - trace.trace = entry->trace; + if (var->trace && !var->block_trace) { + var->block_trace = 1; + trace.trace = var->trace; trace.val = val; - rb_ensure(trace_ev, (VALUE)&trace, trace_en, (VALUE)entry); + rb_ensure(trace_ev, (VALUE)&trace, trace_en, (VALUE)var); } return val; } VALUE -rb_gvar_set2(name, val) - const char *name; - VALUE val; +rb_gv_set(const char *name, VALUE val) { - struct global_entry *entry; + struct rb_global_entry *entry; entry = rb_global_entry(global_id(name)); return rb_gvar_set(entry, val); } VALUE -rb_gvar_defined(entry) - struct global_entry *entry; +rb_gv_get(const char *name) { - if (entry->getter == undef_getter) return Qfalse; + struct rb_global_entry *entry; + + entry = rb_global_entry(global_id(name)); + return rb_gvar_get(entry); +} + +VALUE +rb_gvar_defined(struct rb_global_entry *entry) +{ + if (entry->var->getter == rb_gvar_undef_getter) return Qfalse; return Qtrue; } -static int -gvar_i(key, entry, ary) - ID key; - struct global_entry *entry; - VALUE ary; +static enum rb_id_table_iterator_result +gvar_i(ID key, VALUE val, void *a) { - rb_ary_push(ary, rb_str_new2(rb_id2name(key))); - return ST_CONTINUE; + VALUE ary = (VALUE)a; + rb_ary_push(ary, ID2SYM(key)); + return ID_TABLE_CONTINUE; } +/* + * call-seq: + * global_variables -> array + * + * Returns an array of the names of global variables. + * + * global_variables.grep /std/ #=> [:$stdin, :$stdout, :$stderr] + */ + VALUE -rb_f_global_variables() +rb_f_global_variables(void) { VALUE ary = rb_ary_new(); - char buf[4]; - char *s = "&`'+123456789"; - - st_foreach(rb_global_tbl, gvar_i, ary); - if (!NIL_P(rb_backref_get())) { - while (*s) { - sprintf(buf, "$%c", *s++); - rb_ary_push(ary, rb_str_new2(buf)); + VALUE sym, backref = rb_backref_get(); + + rb_id_table_foreach(rb_global_tbl, gvar_i, (void *)ary); + if (!NIL_P(backref)) { + char buf[2]; + int i, nmatch = rb_match_count(backref); + buf[0] = '$'; + for (i = 1; i <= nmatch; ++i) { + if (!rb_match_nth_defined(i, backref)) continue; + if (i < 10) { + /* probably reused, make static ID */ + buf[1] = (char)(i + '0'); + sym = ID2SYM(rb_intern2(buf, 2)); + } + else { + /* dynamic symbol */ + sym = rb_str_intern(rb_sprintf("$%d", i)); + } + rb_ary_push(ary, sym); } } return ary; } void -rb_alias_variable(name1, name2) - ID name1; - ID name2; +rb_alias_variable(ID name1, ID name2) { - struct global_entry *entry1, *entry2; + struct rb_global_entry *entry1, *entry2; + VALUE data1; - entry1 = rb_global_entry(name1); entry2 = rb_global_entry(name2); + if (!rb_id_table_lookup(rb_global_tbl, name1, &data1)) { + entry1 = ALLOC(struct rb_global_entry); + entry1->id = name1; + rb_id_table_insert(rb_global_tbl, name1, (VALUE)entry1); + } + else if ((entry1 = (struct rb_global_entry *)data1)->var != entry2->var) { + struct rb_global_variable *var = entry1->var; + if (var->block_trace) { + rb_raise(rb_eRuntimeError, "can't alias in tracer"); + } + var->counter--; + if (var->counter == 0) { + struct trace_var *trace = var->trace; + while (trace) { + struct trace_var *next = trace->next; + xfree(trace); + trace = next; + } + xfree(var); + } + } + else { + return; + } + entry2->var->counter++; + entry1->var = entry2->var; +} - entry1->data = entry2->data; - entry1->getter = entry2->getter; - entry1->setter = entry2->setter; - entry1->marker = entry2->marker; +static int +gen_ivtbl_get(VALUE obj, struct gen_ivtbl **ivtbl) +{ + st_data_t data; + + if (st_lookup(generic_iv_tbl, (st_data_t)obj, &data)) { + *ivtbl = (struct gen_ivtbl *)data; + return 1; + } + return 0; } -static int special_generic_ivar = 0; -static st_table *generic_iv_tbl; +static VALUE +generic_ivar_delete(VALUE obj, ID id, VALUE undef) +{ + struct gen_ivtbl *ivtbl; + + if (gen_ivtbl_get(obj, &ivtbl)) { + st_table *iv_index_tbl = RCLASS_IV_INDEX_TBL(rb_obj_class(obj)); + st_data_t index; + + if (st_lookup(iv_index_tbl, (st_data_t)id, &index)) { + if (index < ivtbl->numiv) { + VALUE ret = ivtbl->ivptr[index]; + + ivtbl->ivptr[index] = Qundef; + return ret == Qundef ? undef : ret; + } + } + } + return undef; +} static VALUE -generic_ivar_get(obj, id) - VALUE obj; - ID id; +generic_ivar_get(VALUE obj, ID id, VALUE undef) { - st_table *tbl; - VALUE val; + struct gen_ivtbl *ivtbl; + + if (gen_ivtbl_get(obj, &ivtbl)) { + st_table *iv_index_tbl = RCLASS_IV_INDEX_TBL(rb_obj_class(obj)); + st_data_t index; - if (!generic_iv_tbl) return Qnil; - if (!st_lookup(generic_iv_tbl, obj, &tbl)) return Qnil; - if (st_lookup(tbl, id, &val)) { - return val; + if (st_lookup(iv_index_tbl, (st_data_t)id, &index)) { + if (index < ivtbl->numiv) { + VALUE ret = ivtbl->ivptr[index]; + + return ret == Qundef ? undef : ret; + } + } } - return Qnil; + return undef; } -static void -generic_ivar_set(obj, id, val) - VALUE obj; - ID id; - VALUE val; +static size_t +gen_ivtbl_bytes(size_t n) { - st_table *tbl; - int special = Qfalse; + return sizeof(struct gen_ivtbl) + n * sizeof(VALUE) - sizeof(VALUE); +} + +static struct gen_ivtbl * +gen_ivtbl_resize(struct gen_ivtbl *old, uint32_t n) +{ + uint32_t len = old ? old->numiv : 0; + struct gen_ivtbl *ivtbl = xrealloc(old, gen_ivtbl_bytes(n)); - if (rb_special_const_p(obj)) { - special_generic_ivar = 1; - special = Qtrue; + ivtbl->numiv = n; + for (; len < n; len++) { + ivtbl->ivptr[len] = Qundef; } - if (!generic_iv_tbl) { - generic_iv_tbl = st_init_numtable(); + + return ivtbl; +} + +#if 0 +static struct gen_ivtbl * +gen_ivtbl_dup(const struct gen_ivtbl *orig) +{ + size_t s = gen_ivtbl_bytes(orig->numiv); + struct gen_ivtbl *ivtbl = xmalloc(s); + + memcpy(ivtbl, orig, s); + + return ivtbl; +} +#endif + +static uint32_t +iv_index_tbl_newsize(struct ivar_update *ivup) +{ + uint32_t index = (uint32_t)ivup->index; /* should not overflow */ + uint32_t newsize = (index+1) + (index+1)/4; /* (index+1)*1.25 */ + + if (!ivup->iv_extended && + ivup->u.iv_index_tbl->num_entries < (st_index_t)newsize) { + newsize = (uint32_t)ivup->u.iv_index_tbl->num_entries; } + return newsize; +} - if (!st_lookup(generic_iv_tbl, obj, &tbl)) { +static int +generic_ivar_update(st_data_t *k, st_data_t *v, st_data_t u, int existing) +{ + VALUE obj = (VALUE)*k; + struct ivar_update *ivup = (struct ivar_update *)u; + uint32_t newsize; + int ret = ST_CONTINUE; + struct gen_ivtbl *ivtbl; + + if (existing) { + ivtbl = (struct gen_ivtbl *)*v; + if (ivup->index >= ivtbl->numiv) { + goto resize; + } + ret = ST_STOP; + } + else { FL_SET(obj, FL_EXIVAR); - tbl = st_init_numtable(); - st_add_direct(generic_iv_tbl, obj, tbl); - st_add_direct(tbl, id, val); - return; + ivtbl = 0; +resize: + newsize = iv_index_tbl_newsize(ivup); + ivtbl = gen_ivtbl_resize(ivtbl, newsize); + *v = (st_data_t)ivtbl; } - st_insert(tbl, id, val); + ivup->u.ivtbl = ivtbl; + return ret; } static VALUE -generic_ivar_defined(obj, id) - VALUE obj; - ID id; +generic_ivar_defined(VALUE obj, ID id) { - st_table *tbl; - VALUE val; + struct gen_ivtbl *ivtbl; + st_table *iv_index_tbl = RCLASS_IV_INDEX_TBL(rb_obj_class(obj)); + st_data_t index; + + if (!iv_index_tbl) return Qfalse; + if (!st_lookup(iv_index_tbl, (st_data_t)id, &index)) return Qfalse; + if (!gen_ivtbl_get(obj, &ivtbl)) return Qfalse; - if (!generic_iv_tbl) return Qfalse; - if (!st_lookup(generic_iv_tbl, obj, &tbl)) return Qfalse; - if (st_lookup(tbl, id, &val)) { + if ((index < ivtbl->numiv) && (ivtbl->ivptr[index] != Qundef)) return Qtrue; - } + return Qfalse; } -static VALUE -generic_ivar_remove(obj, id) - VALUE obj; - ID id; +static int +generic_ivar_remove(VALUE obj, ID id, VALUE *valp) +{ + struct gen_ivtbl *ivtbl; + st_data_t key = (st_data_t)id; + st_data_t index; + st_table *iv_index_tbl = RCLASS_IV_INDEX_TBL(rb_obj_class(obj)); + + if (!iv_index_tbl) return 0; + if (!st_lookup(iv_index_tbl, key, &index)) return 0; + if (!gen_ivtbl_get(obj, &ivtbl)) return 0; + + if (index < ivtbl->numiv) { + if (ivtbl->ivptr[index] != Qundef) { + *valp = ivtbl->ivptr[index]; + ivtbl->ivptr[index] = Qundef; + return 1; + } + } + return 0; +} + +static void +gen_ivtbl_mark(const struct gen_ivtbl *ivtbl) { - st_table *tbl; - VALUE val; + uint32_t i; - if (!generic_iv_tbl) return Qnil; - if (!st_lookup(generic_iv_tbl, obj, &tbl)) return Qnil; - st_delete(tbl, &id, &val); - if (tbl->num_entries == 0) { - st_delete(generic_iv_tbl, &obj, &tbl); - st_free_table(tbl); + for (i = 0; i < ivtbl->numiv; i++) { + rb_gc_mark(ivtbl->ivptr[i]); } - return val; } -static int -givar_mark_i(key, value) - ID key; - VALUE value; +void +rb_mark_generic_ivar(VALUE obj) { - rb_gc_mark(value); - return ST_CONTINUE; + struct gen_ivtbl *ivtbl; + + if (gen_ivtbl_get(obj, &ivtbl)) { + gen_ivtbl_mark(ivtbl); + } } void -rb_mark_generic_ivar(obj) - VALUE obj; +rb_free_generic_ivar(VALUE obj) { - st_table *tbl; + st_data_t key = (st_data_t)obj; + struct gen_ivtbl *ivtbl; + + if (st_delete(generic_iv_tbl, &key, (st_data_t *)&ivtbl)) + xfree(ivtbl); + + if (generic_iv_tbl_compat) { + st_table *tbl; - if (st_lookup(generic_iv_tbl, obj, &tbl)) { - rb_mark_tbl(tbl); + if (st_delete(generic_iv_tbl_compat, &key, (st_data_t *)&tbl)) + st_free_table(tbl); } } -static int -givar_i(obj, tbl) - VALUE obj; - st_table *tbl; +RUBY_FUNC_EXPORTED size_t +rb_generic_ivar_memsize(VALUE obj) +{ + struct gen_ivtbl *ivtbl; + + if (gen_ivtbl_get(obj, &ivtbl)) + return gen_ivtbl_bytes(ivtbl->numiv); + return 0; +} + +static size_t +gen_ivtbl_count(const struct gen_ivtbl *ivtbl) { - if (rb_special_const_p(obj)) { - st_foreach(tbl, givar_mark_i, 0); + uint32_t i; + size_t n = 0; + + for (i = 0; i < ivtbl->numiv; i++) { + if (ivtbl->ivptr[i] != Qundef) { + n++; + } } - return ST_CONTINUE; + + return n; } -void -rb_mark_generic_ivar_tbl() +VALUE +rb_ivar_lookup(VALUE obj, ID id, VALUE undef) { - if (special_generic_ivar == 0) return; - if (!generic_iv_tbl) return; - st_foreach(generic_iv_tbl, givar_i, 0); + VALUE val, *ptr; + struct st_table *iv_index_tbl; + uint32_t len; + st_data_t index; + + if (SPECIAL_CONST_P(obj)) return undef; + switch (BUILTIN_TYPE(obj)) { + case T_OBJECT: + len = ROBJECT_NUMIV(obj); + ptr = ROBJECT_IVPTR(obj); + iv_index_tbl = ROBJECT_IV_INDEX_TBL(obj); + if (!iv_index_tbl) break; + if (!st_lookup(iv_index_tbl, (st_data_t)id, &index)) break; + if (len <= index) break; + val = ptr[index]; + if (val != Qundef) + return val; + break; + case T_CLASS: + case T_MODULE: + if (RCLASS_IV_TBL(obj) && + st_lookup(RCLASS_IV_TBL(obj), (st_data_t)id, &index)) + return (VALUE)index; + break; + default: + if (FL_TEST(obj, FL_EXIVAR)) + return generic_ivar_get(obj, id, undef); + break; + } + return undef; } -void -rb_free_generic_ivar(obj) - VALUE obj; +VALUE +rb_ivar_get(VALUE obj, ID id) { - st_table *tbl; + VALUE iv = rb_ivar_lookup(obj, id, Qundef); + RB_DEBUG_COUNTER_INC(ivar_get_base); - if (st_delete(generic_iv_tbl, &obj, &tbl)) - st_free_table(tbl); + if (iv == Qundef) { + if (RTEST(ruby_verbose)) + rb_warning("instance variable %"PRIsVALUE" not initialized", QUOTE_ID(id)); + iv = Qnil; + } + return iv; } VALUE -rb_ivar_get(obj, id) - VALUE obj; - ID id; +rb_attr_get(VALUE obj, ID id) { - VALUE val; + return rb_ivar_lookup(obj, id, Qnil); +} - if (!FL_TEST(obj, FL_TAINT) && rb_safe_level() >= 4) - rb_raise(rb_eSecurityError, "Insecure: can't access instance variable"); - switch (TYPE(obj)) { +static VALUE +rb_ivar_delete(VALUE obj, ID id, VALUE undef) +{ + VALUE val, *ptr; + struct st_table *iv_index_tbl; + uint32_t len; + st_data_t index; + + rb_check_frozen(obj); + switch (BUILTIN_TYPE(obj)) { case T_OBJECT: + len = ROBJECT_NUMIV(obj); + ptr = ROBJECT_IVPTR(obj); + iv_index_tbl = ROBJECT_IV_INDEX_TBL(obj); + if (!iv_index_tbl) break; + if (!st_lookup(iv_index_tbl, (st_data_t)id, &index)) break; + if (len <= index) break; + val = ptr[index]; + ptr[index] = Qundef; + if (val != Qundef) + return val; + break; case T_CLASS: case T_MODULE: - case T_FILE: - if (ROBJECT(obj)->iv_tbl && st_lookup(ROBJECT(obj)->iv_tbl, id, &val)) - return val; + if (RCLASS_IV_TBL(obj) && + st_delete(RCLASS_IV_TBL(obj), (st_data_t *)&id, &index)) + return (VALUE)index; break; default: - if (FL_TEST(obj, FL_EXIVAR) || rb_special_const_p(obj)) - return generic_ivar_get(obj, id); + if (FL_TEST(obj, FL_EXIVAR)) + return generic_ivar_delete(obj, id, undef); break; } - if (ruby_verbose) { - rb_warning("instance var %s not initialized", rb_id2name(id)); + return undef; +} + +VALUE +rb_attr_delete(VALUE obj, ID id) +{ + return rb_ivar_delete(obj, id, Qnil); +} + +static st_table * +iv_index_tbl_make(VALUE obj) +{ + VALUE klass = rb_obj_class(obj); + st_table *iv_index_tbl = RCLASS_IV_INDEX_TBL(klass); + + if (!iv_index_tbl) { + iv_index_tbl = RCLASS_IV_INDEX_TBL(klass) = st_init_numtable(); + } + + return iv_index_tbl; +} + +static void +iv_index_tbl_extend(struct ivar_update *ivup, ID id) +{ + if (st_lookup(ivup->u.iv_index_tbl, (st_data_t)id, &ivup->index)) { + return; } - return Qnil; + if (ivup->u.iv_index_tbl->num_entries >= INT_MAX) { + rb_raise(rb_eArgError, "too many instance variables"); + } + ivup->index = (st_data_t)ivup->u.iv_index_tbl->num_entries; + st_add_direct(ivup->u.iv_index_tbl, (st_data_t)id, ivup->index); + ivup->iv_extended = 1; +} + +static void +generic_ivar_set(VALUE obj, ID id, VALUE val) +{ + struct ivar_update ivup; + + ivup.iv_extended = 0; + ivup.u.iv_index_tbl = iv_index_tbl_make(obj); + iv_index_tbl_extend(&ivup, id); + st_update(generic_iv_tbl, (st_data_t)obj, generic_ivar_update, + (st_data_t)&ivup); + + ivup.u.ivtbl->ivptr[ivup.index] = val; + + RB_OBJ_WRITTEN(obj, Qundef, val); } VALUE -rb_ivar_set(obj, id, val) - VALUE obj; - ID id; - VALUE val; +rb_ivar_set(VALUE obj, ID id, VALUE val) { - if (!FL_TEST(obj, FL_TAINT) && rb_safe_level() >= 4) - rb_raise(rb_eSecurityError, "Insecure: can't modify instance variable"); - switch (TYPE(obj)) { + struct ivar_update ivup; + uint32_t i, len; + + RB_DEBUG_COUNTER_INC(ivar_set_base); + + rb_check_frozen(obj); + + switch (BUILTIN_TYPE(obj)) { case T_OBJECT: + ivup.iv_extended = 0; + ivup.u.iv_index_tbl = iv_index_tbl_make(obj); + iv_index_tbl_extend(&ivup, id); + len = ROBJECT_NUMIV(obj); + if (len <= ivup.index) { + VALUE *ptr = ROBJECT_IVPTR(obj); + if (ivup.index < ROBJECT_EMBED_LEN_MAX) { + RBASIC(obj)->flags |= ROBJECT_EMBED; + ptr = ROBJECT(obj)->as.ary; + for (i = 0; i < ROBJECT_EMBED_LEN_MAX; i++) { + ptr[i] = Qundef; + } + } + else { + VALUE *newptr; + uint32_t newsize = iv_index_tbl_newsize(&ivup); + + if (RBASIC(obj)->flags & ROBJECT_EMBED) { + newptr = ALLOC_N(VALUE, newsize); + MEMCPY(newptr, ptr, VALUE, len); + RBASIC(obj)->flags &= ~ROBJECT_EMBED; + ROBJECT(obj)->as.heap.ivptr = newptr; + } + else { + REALLOC_N(ROBJECT(obj)->as.heap.ivptr, VALUE, newsize); + newptr = ROBJECT(obj)->as.heap.ivptr; + } + for (; len < newsize; len++) + newptr[len] = Qundef; + ROBJECT(obj)->as.heap.numiv = newsize; + ROBJECT(obj)->as.heap.iv_index_tbl = ivup.u.iv_index_tbl; + } + } + RB_OBJ_WRITE(obj, &ROBJECT_IVPTR(obj)[ivup.index], val); + break; case T_CLASS: case T_MODULE: - case T_FILE: - if (!ROBJECT(obj)->iv_tbl) ROBJECT(obj)->iv_tbl = st_init_numtable(); - st_insert(ROBJECT(obj)->iv_tbl, id, val); - break; + if (!RCLASS_IV_TBL(obj)) RCLASS_IV_TBL(obj) = st_init_numtable(); + rb_class_ivar_set(obj, id, val); + break; default: generic_ivar_set(obj, id, val); break; @@ -872,348 +1373,1766 @@ rb_ivar_set(obj, id, val) } VALUE -rb_ivar_defined(obj, id) - VALUE obj; - ID id; +rb_ivar_defined(VALUE obj, ID id) { - switch (TYPE(obj)) { + VALUE val; + struct st_table *iv_index_tbl; + st_data_t index; + + if (SPECIAL_CONST_P(obj)) return Qfalse; + switch (BUILTIN_TYPE(obj)) { case T_OBJECT: + iv_index_tbl = ROBJECT_IV_INDEX_TBL(obj); + if (!iv_index_tbl) break; + if (!st_lookup(iv_index_tbl, (st_data_t)id, &index)) break; + if (ROBJECT_NUMIV(obj) <= index) break; + val = ROBJECT_IVPTR(obj)[index]; + if (val != Qundef) + return Qtrue; + break; case T_CLASS: case T_MODULE: - case T_FILE: - if (ROBJECT(obj)->iv_tbl && st_lookup(ROBJECT(obj)->iv_tbl, id, 0)) + if (RCLASS_IV_TBL(obj) && st_lookup(RCLASS_IV_TBL(obj), (st_data_t)id, 0)) return Qtrue; break; default: - if (FL_TEST(obj, FL_EXIVAR) || rb_special_const_p(obj)) + if (FL_TEST(obj, FL_EXIVAR)) return generic_ivar_defined(obj, id); break; } return Qfalse; } +struct obj_ivar_tag { + VALUE obj; + int (*func)(ID key, VALUE val, st_data_t arg); + st_data_t arg; +}; + static int -ivar_i(key, entry, ary) - ID key; - struct global_entry *entry; - VALUE ary; +obj_ivar_i(st_data_t key, st_data_t index, st_data_t arg) { - if (rb_is_instance_id(key)) { - rb_ary_push(ary, rb_str_new2(rb_id2name(key))); + struct obj_ivar_tag *data = (struct obj_ivar_tag *)arg; + if (index < ROBJECT_NUMIV(data->obj)) { + VALUE val = ROBJECT_IVPTR(data->obj)[index]; + if (val != Qundef) { + return (data->func)((ID)key, val, data->arg); + } } return ST_CONTINUE; } -VALUE -rb_obj_instance_variables(obj) +static void +obj_ivar_each(VALUE obj, int (*func)(ANYARGS), st_data_t arg) +{ + st_table *tbl; + struct obj_ivar_tag data; + + tbl = ROBJECT_IV_INDEX_TBL(obj); + if (!tbl) + return; + + data.obj = obj; + data.func = (int (*)(ID key, VALUE val, st_data_t arg))func; + data.arg = arg; + + st_foreach_safe(tbl, obj_ivar_i, (st_data_t)&data); +} + +struct gen_ivar_tag { + struct gen_ivtbl *ivtbl; + int (*func)(ID key, VALUE val, st_data_t arg); + st_data_t arg; +}; + +static int +gen_ivar_each_i(st_data_t key, st_data_t index, st_data_t data) +{ + struct gen_ivar_tag *arg = (struct gen_ivar_tag *)data; + + if (index < arg->ivtbl->numiv) { + VALUE val = arg->ivtbl->ivptr[index]; + if (val != Qundef) { + return (arg->func)((ID)key, val, arg->arg); + } + } + return ST_CONTINUE; +} + +static void +gen_ivar_each(VALUE obj, int (*func)(ANYARGS), st_data_t arg) +{ + struct gen_ivar_tag data; + st_table *iv_index_tbl = RCLASS_IV_INDEX_TBL(rb_obj_class(obj)); + + if (!iv_index_tbl) return; + if (!gen_ivtbl_get(obj, &data.ivtbl)) return; + + data.func = (int (*)(ID key, VALUE val, st_data_t arg))func; + data.arg = arg; + + st_foreach_safe(iv_index_tbl, gen_ivar_each_i, (st_data_t)&data); +} + +struct givar_copy { VALUE obj; + st_table *iv_index_tbl; + struct gen_ivtbl *ivtbl; +}; + +static int +gen_ivar_copy(ID id, VALUE val, st_data_t arg) { - VALUE ary; + struct givar_copy *c = (struct givar_copy *)arg; + struct ivar_update ivup; + + ivup.iv_extended = 0; + ivup.u.iv_index_tbl = c->iv_index_tbl; + iv_index_tbl_extend(&ivup, id); + if (ivup.index >= c->ivtbl->numiv) { + uint32_t newsize = iv_index_tbl_newsize(&ivup); + c->ivtbl = gen_ivtbl_resize(c->ivtbl, newsize); + } + c->ivtbl->ivptr[ivup.index] = val; + + RB_OBJ_WRITTEN(c->obj, Qundef, val); + + return ST_CONTINUE; +} + +void +rb_copy_generic_ivar(VALUE clone, VALUE obj) +{ + struct gen_ivtbl *ivtbl; + + rb_check_frozen(clone); + + if (!FL_TEST(obj, FL_EXIVAR)) { + clear: + if (FL_TEST(clone, FL_EXIVAR)) { + rb_free_generic_ivar(clone); + FL_UNSET(clone, FL_EXIVAR); + } + return; + } + if (gen_ivtbl_get(obj, &ivtbl)) { + struct givar_copy c; + uint32_t i; + + if (gen_ivtbl_count(ivtbl) == 0) + goto clear; + + if (gen_ivtbl_get(clone, &c.ivtbl)) { + for (i = 0; i < c.ivtbl->numiv; i++) + c.ivtbl->ivptr[i] = Qundef; + } + else { + c.ivtbl = gen_ivtbl_resize(0, ivtbl->numiv); + FL_SET(clone, FL_EXIVAR); + } - if (!FL_TEST(obj, FL_TAINT) && rb_safe_level() >= 4) - rb_raise(rb_eSecurityError, "Insecure: can't get metainfo"); - switch (TYPE(obj)) { + c.iv_index_tbl = iv_index_tbl_make(clone); + c.obj = clone; + gen_ivar_each(obj, gen_ivar_copy, (st_data_t)&c); + /* + * c.ivtbl may change in gen_ivar_copy due to realloc, + * no need to free + */ + st_insert(generic_iv_tbl, (st_data_t)clone, (st_data_t)c.ivtbl); + } +} + +void +rb_ivar_foreach(VALUE obj, int (*func)(ANYARGS), st_data_t arg) +{ + if (SPECIAL_CONST_P(obj)) return; + switch (BUILTIN_TYPE(obj)) { case T_OBJECT: + obj_ivar_each(obj, func, arg); + break; case T_CLASS: case T_MODULE: - case T_FILE: - ary = rb_ary_new(); - if (ROBJECT(obj)->iv_tbl) { - st_foreach(ROBJECT(obj)->iv_tbl, ivar_i, ary); + if (RCLASS_IV_TBL(obj)) { + st_foreach_safe(RCLASS_IV_TBL(obj), func, arg); } - return ary; + break; default: - if (!generic_iv_tbl) return Qnil; - if (FL_TEST(obj, FL_EXIVAR) || rb_special_const_p(obj)) { - st_table *tbl; - - if (st_lookup(generic_iv_tbl, obj, &tbl)) { - ary = rb_ary_new(); - st_foreach(tbl, ivar_i, ary); - return ary; + if (FL_TEST(obj, FL_EXIVAR)) { + gen_ivar_each(obj, func, arg); + } + break; + } +} + +st_index_t +rb_ivar_count(VALUE obj) +{ + st_table *tbl; + + if (SPECIAL_CONST_P(obj)) return 0; + + switch (BUILTIN_TYPE(obj)) { + case T_OBJECT: + if ((tbl = ROBJECT_IV_INDEX_TBL(obj)) != 0) { + st_index_t i, count, num = ROBJECT_NUMIV(obj); + const VALUE *const ivptr = ROBJECT_IVPTR(obj); + for (i = count = 0; i < num; ++i) { + if (ivptr[i] != Qundef) { + count++; + } } + return count; + } + break; + case T_CLASS: + case T_MODULE: + if ((tbl = RCLASS_IV_TBL(obj)) != 0) { + return tbl->num_entries; } + break; + default: + if (FL_TEST(obj, FL_EXIVAR)) { + struct gen_ivtbl *ivtbl; + + if (gen_ivtbl_get(obj, &ivtbl)) { + return gen_ivtbl_count(ivtbl); + } + } + break; } - return Qnil; + return 0; } +static int +ivar_i(st_data_t k, st_data_t v, st_data_t a) +{ + ID key = (ID)k; + VALUE ary = (VALUE)a; + + if (rb_is_instance_id(key)) { + rb_ary_push(ary, ID2SYM(key)); + } + return ST_CONTINUE; +} + +/* + * call-seq: + * obj.instance_variables -> array + * + * Returns an array of instance variable names for the receiver. Note + * that simply defining an accessor does not create the corresponding + * instance variable. + * + * class Fred + * attr_accessor :a1 + * def initialize + * @iv = 3 + * end + * end + * Fred.new.instance_variables #=> [:@iv] + */ + VALUE -rb_obj_remove_instance_variable(obj, name) - VALUE obj, name; +rb_obj_instance_variables(VALUE obj) +{ + VALUE ary; + + ary = rb_ary_new(); + rb_ivar_foreach(obj, ivar_i, ary); + return ary; +} + +#define rb_is_constant_id rb_is_const_id +#define rb_is_constant_name rb_is_const_name +#define id_for_var(obj, name, part, type) \ + id_for_var_message(obj, name, type, "`%1$s' is not allowed as "#part" "#type" variable name") +#define id_for_var_message(obj, name, type, message) \ + check_id_type(obj, &(name), rb_is_##type##_id, rb_is_##type##_name, message, strlen(message)) +static ID +check_id_type(VALUE obj, VALUE *pname, + int (*valid_id_p)(ID), int (*valid_name_p)(VALUE), + const char *message, size_t message_len) +{ + ID id = rb_check_id(pname); + VALUE name = *pname; + + if (id ? !valid_id_p(id) : !valid_name_p(name)) { + rb_name_err_raise_str(rb_fstring_new(message, message_len), + obj, name); + } + return id; +} + +/* + * call-seq: + * obj.remove_instance_variable(symbol) -> obj + * + * Removes the named instance variable from <i>obj</i>, returning that + * variable's value. + * + * class Dummy + * attr_reader :var + * def initialize + * @var = 99 + * end + * def remove + * remove_instance_variable(:@var) + * end + * end + * d = Dummy.new + * d.var #=> 99 + * d.remove #=> 99 + * d.var #=> nil + */ + +VALUE +rb_obj_remove_instance_variable(VALUE obj, VALUE name) { VALUE val = Qnil; - ID id = rb_to_id(name); + const ID id = id_for_var(obj, name, an, instance); + st_data_t n, v; + struct st_table *iv_index_tbl; + st_data_t index; - if (!FL_TEST(obj, FL_TAINT) && rb_safe_level() >= 4) - rb_raise(rb_eSecurityError, "Insecure: can't modify instance variable"); - if (!rb_is_instance_id(id)) { - rb_raise(rb_eNameError, "`%s' is not an instance variable", - rb_id2name(id)); + rb_check_frozen(obj); + if (!id) { + goto not_defined; } - switch (TYPE(obj)) { + switch (BUILTIN_TYPE(obj)) { case T_OBJECT: + iv_index_tbl = ROBJECT_IV_INDEX_TBL(obj); + if (!iv_index_tbl) break; + if (!st_lookup(iv_index_tbl, (st_data_t)id, &index)) break; + if (ROBJECT_NUMIV(obj) <= index) break; + val = ROBJECT_IVPTR(obj)[index]; + if (val != Qundef) { + ROBJECT_IVPTR(obj)[index] = Qundef; + return val; + } + break; case T_CLASS: case T_MODULE: - case T_FILE: - if (ROBJECT(obj)->iv_tbl) { - st_delete(ROBJECT(obj)->iv_tbl, &id, &val); + n = id; + if (RCLASS_IV_TBL(obj) && st_delete(RCLASS_IV_TBL(obj), &n, &v)) { + return (VALUE)v; } break; default: - if (FL_TEST(obj, FL_EXIVAR) || rb_special_const_p(obj)) - return generic_ivar_remove(obj, id); + if (FL_TEST(obj, FL_EXIVAR)) { + if (generic_ivar_remove(obj, id, &val)) { + return val; + } + } break; } - return val; + + not_defined: + rb_name_err_raise("instance variable %1$s not defined", + obj, name); + UNREACHABLE; +} + +NORETURN(static void uninitialized_constant(VALUE, VALUE)); +static void +uninitialized_constant(VALUE klass, VALUE name) +{ + if (klass && rb_class_real(klass) != rb_cObject) + rb_name_err_raise("uninitialized constant %2$s::%1$s", + klass, name); + else + rb_name_err_raise("uninitialized constant %1$s", + klass, name); } VALUE -rb_const_get_at(klass, id) - VALUE klass; - ID id; +rb_const_missing(VALUE klass, VALUE name) +{ + VALUE value = rb_funcallv(klass, rb_intern("const_missing"), 1, &name); + rb_vm_inc_const_missing_count(); + return value; +} + + +/* + * call-seq: + * mod.const_missing(sym) -> obj + * + * Invoked when a reference is made to an undefined constant in + * <i>mod</i>. It is passed a symbol for the undefined constant, and + * returns a value to be used for that constant. The + * following code is an example of the same: + * + * def Foo.const_missing(name) + * name # return the constant name as Symbol + * end + * + * Foo::UNDEFINED_CONST #=> :UNDEFINED_CONST: symbol returned + * + * In the next example when a reference is made to an undefined constant, + * it attempts to load a file whose name is the lowercase version of the + * constant (thus class <code>Fred</code> is assumed to be in file + * <code>fred.rb</code>). If found, it returns the loaded class. It + * therefore implements an autoload feature similar to Kernel#autoload and + * Module#autoload. + * + * def Object.const_missing(name) + * @looked_for ||= {} + * str_name = name.to_s + * raise "Class not found: #{name}" if @looked_for[str_name] + * @looked_for[str_name] = 1 + * file = str_name.downcase + * require file + * klass = const_get(name) + * return klass if klass + * raise "Class not found: #{name}" + * end + * + */ + +VALUE +rb_mod_const_missing(VALUE klass, VALUE name) +{ + rb_vm_pop_cfunc_frame(); + uninitialized_constant(klass, name); + + UNREACHABLE; +} + +static void +autoload_mark(void *ptr) +{ + rb_mark_tbl((st_table *)ptr); +} + +static void +autoload_free(void *ptr) +{ + st_free_table((st_table *)ptr); +} + +static size_t +autoload_memsize(const void *ptr) { + const st_table *tbl = ptr; + return st_memsize(tbl); +} + +static const rb_data_type_t autoload_data_type = { + "autoload", + {autoload_mark, autoload_free, autoload_memsize,}, + 0, 0, RUBY_TYPED_FREE_IMMEDIATELY +}; + +#define check_autoload_table(av) \ + (struct st_table *)rb_check_typeddata((av), &autoload_data_type) + +static VALUE +autoload_data(VALUE mod, ID id) +{ + struct st_table *tbl; + st_data_t val; + + if (!st_lookup(RCLASS_IV_TBL(mod), autoload, &val) || + !(tbl = check_autoload_table((VALUE)val)) || + !st_lookup(tbl, (st_data_t)id, &val)) { + return 0; + } + return (VALUE)val; +} + +/* always on stack, no need to mark */ +struct autoload_state { + struct autoload_data_i *ele; + VALUE mod; + VALUE result; + ID id; + VALUE thread; + union { + struct list_node node; + struct list_head head; + } waitq; +}; + +struct autoload_data_i { + VALUE feature; + int safe_level; + rb_const_flag_t flag; VALUE value; + struct autoload_state *state; /* points to on-stack struct */ + rb_serial_t fork_gen; +}; + +static void +autoload_i_mark(void *ptr) +{ + struct autoload_data_i *p = ptr; + rb_gc_mark(p->feature); + rb_gc_mark(p->value); +} + +static size_t +autoload_i_memsize(const void *ptr) +{ + return sizeof(struct autoload_data_i); +} - if (RCLASS(klass)->iv_tbl && st_lookup(RCLASS(klass)->iv_tbl, id, &value)) { - return value; +static const rb_data_type_t autoload_data_i_type = { + "autoload_i", + {autoload_i_mark, RUBY_TYPED_DEFAULT_FREE, autoload_i_memsize,}, + 0, 0, RUBY_TYPED_FREE_IMMEDIATELY +}; + +static struct autoload_data_i * +get_autoload_data(VALUE av) +{ + struct autoload_data_i *ele = rb_check_typeddata(av, &autoload_data_i_type); + + /* do not reach across stack for ->state after forking: */ + if (ele && ele->state && ele->fork_gen != GET_VM()->fork_gen) { + ele->state = 0; + ele->fork_gen = 0; } - if (klass == rb_cObject) { - return rb_const_get(klass, id); + return ele; +} + +RUBY_FUNC_EXPORTED void +rb_autoload(VALUE mod, ID id, const char *file) +{ + if (!file || !*file) { + rb_raise(rb_eArgError, "empty file name"); } - rb_raise(rb_eNameError, "uninitialized constant %s::%s", - RSTRING(rb_class_path(klass))->ptr, - rb_id2name(id)); - return Qnil; /* not reached */ + rb_autoload_str(mod, id, rb_fstring_cstr(file)); } +void +rb_autoload_str(VALUE mod, ID id, VALUE file) +{ + st_data_t av; + VALUE ad; + struct st_table *tbl; + struct autoload_data_i *ele; + rb_const_entry_t *ce; -VALUE -rb_const_get(klass, id) - VALUE klass; - ID id; + if (!rb_is_const_id(id)) { + rb_raise(rb_eNameError, "autoload must be constant name: %"PRIsVALUE"", + QUOTE_ID(id)); + } + + Check_Type(file, T_STRING); + if (!RSTRING_LEN(file)) { + rb_raise(rb_eArgError, "empty file name"); + } + + ce = rb_const_lookup(mod, id); + if (ce && ce->value != Qundef) { + return; + } + + rb_const_set(mod, id, Qundef); + tbl = RCLASS_IV_TBL(mod); + if (tbl && st_lookup(tbl, (st_data_t)autoload, &av)) { + tbl = check_autoload_table((VALUE)av); + } + else { + if (!tbl) tbl = RCLASS_IV_TBL(mod) = st_init_numtable(); + av = (st_data_t)TypedData_Wrap_Struct(0, &autoload_data_type, 0); + st_add_direct(tbl, (st_data_t)autoload, av); + RB_OBJ_WRITTEN(mod, Qnil, av); + DATA_PTR(av) = tbl = st_init_numtable(); + } + + ad = TypedData_Make_Struct(0, struct autoload_data_i, &autoload_data_i_type, ele); + if (OBJ_TAINTED(file)) { + file = rb_str_dup(file); + FL_UNSET(file, FL_TAINT); + } + ele->feature = rb_fstring(file); + ele->safe_level = rb_safe_level(); + ele->value = Qundef; + ele->state = 0; + ele->flag = CONST_PUBLIC; + st_insert(tbl, (st_data_t)id, (st_data_t)ad); +} + +static void +autoload_delete(VALUE mod, ID id) { - VALUE value; - VALUE tmp; + st_data_t val, load = 0, n = id; - tmp = klass; - while (tmp) { - if (RCLASS(tmp)->iv_tbl && st_lookup(RCLASS(tmp)->iv_tbl,id,&value)) { - return value; + if (st_lookup(RCLASS_IV_TBL(mod), (st_data_t)autoload, &val)) { + struct st_table *tbl = check_autoload_table((VALUE)val); + + st_delete(tbl, &n, &load); + + if (tbl->num_entries == 0) { + n = autoload; + st_delete(RCLASS_IV_TBL(mod), &n, &val); } - tmp = RCLASS(tmp)->super; - } - if (BUILTIN_TYPE(klass) == T_MODULE) { - return rb_const_get(rb_cObject, id); } +} - /* pre-defined class */ - if (st_lookup(rb_class_tbl, id, &value)) return value; +static VALUE +autoload_provided(VALUE arg) +{ + const char **p = (const char **)arg; + return rb_feature_provided(*p, p); +} + +static VALUE +reset_safe(VALUE safe) +{ + rb_set_safe_level_force((int)safe); + return safe; +} - /* autoload */ - if (autoload_tbl && st_lookup(autoload_tbl, id, 0)) { - char *modname; - VALUE module; +static VALUE +check_autoload_required(VALUE mod, ID id, const char **loadingpath) +{ + VALUE file, load; + struct autoload_data_i *ele; + const char *loading; + int safe; - st_delete(autoload_tbl, &id, &modname); - module = rb_str_new2(modname); - free(modname); - rb_f_require(Qnil, module); - return rb_const_get(klass, id); + if (!(load = autoload_data(mod, id)) || !(ele = get_autoload_data(load))) { + return 0; + } + file = ele->feature; + Check_Type(file, T_STRING); + if (!RSTRING_LEN(file) || !*RSTRING_PTR(file)) { + rb_raise(rb_eArgError, "empty file name"); } - /* Uninitialized constant */ - if (klass && klass != rb_cObject) - rb_raise(rb_eNameError, "uninitialized constant %s::%s", - RSTRING(rb_class_path(klass))->ptr, - rb_id2name(id)); - else { - rb_raise(rb_eNameError, "uninitialized constant %s",rb_id2name(id)); + /* + * if somebody else is autoloading, we MUST wait for them, since + * rb_provide_feature can provide a feature before autoload_const_set + * completes. We must wait until autoload_const_set finishes in + * the other thread. + */ + if (ele->state && ele->state->thread != rb_thread_current()) { + return load; } - return Qnil; /* not reached */ + + loading = RSTRING_PTR(file); + safe = rb_safe_level(); + rb_set_safe_level_force(0); + if (!rb_ensure(autoload_provided, (VALUE)&loading, reset_safe, (VALUE)safe)) { + return load; + } + if (loadingpath && loading) { + *loadingpath = loading; + return load; + } + return 0; +} + +int +rb_autoloading_value(VALUE mod, ID id, VALUE* value, rb_const_flag_t *flag) +{ + VALUE load; + struct autoload_data_i *ele; + + if (!(load = autoload_data(mod, id)) || !(ele = get_autoload_data(load))) { + return 0; + } + if (ele->state && ele->state->thread == rb_thread_current()) { + if (ele->value != Qundef) { + if (value) { + *value = ele->value; + } + if (flag) { + *flag = ele->flag; + } + return 1; + } + } + return 0; } static int -const_i(key, value, ary) - ID key; +autoload_defined_p(VALUE mod, ID id) +{ + rb_const_entry_t *ce = rb_const_lookup(mod, id); + + if (!ce || ce->value != Qundef) { + return 0; + } + return !rb_autoloading_value(mod, id, NULL, NULL); +} + +struct autoload_const_set_args { + VALUE mod; + ID id; VALUE value; - VALUE ary; + rb_const_flag_t flag; +}; + +static void const_tbl_update(struct autoload_const_set_args *); + +static VALUE +autoload_const_set(VALUE arg) { - if (rb_is_const_id(key)) { - VALUE kval = rb_str_new2(rb_id2name(key)); - if (!rb_ary_includes(ary, kval)) { - rb_ary_push(ary, kval); + struct autoload_const_set_args* args = (struct autoload_const_set_args *)arg; + VALUE klass = args->mod; + ID id = args->id; + check_before_mod_set(klass, id, args->value, "constant"); + const_tbl_update(args); + return 0; /* ignored */ +} + +static VALUE +autoload_require(VALUE arg) +{ + struct autoload_state *state = (struct autoload_state *)arg; + + /* this may release GVL and switch threads: */ + state->result = rb_funcall(rb_vm_top_self(), rb_intern("require"), 1, + state->ele->feature); + + return state->result; +} + +static VALUE +autoload_reset(VALUE arg) +{ + struct autoload_state *state = (struct autoload_state *)arg; + int need_wakeups = 0; + + if (state->ele->state == state) { + need_wakeups = 1; + state->ele->state = 0; + state->ele->fork_gen = 0; + } + + /* At the last, move a value defined in autoload to constant table */ + if (RTEST(state->result) && state->ele->value != Qundef) { + int safe_backup; + struct autoload_const_set_args args; + + args.mod = state->mod; + args.id = state->id; + args.value = state->ele->value; + args.flag = state->ele->flag; + safe_backup = rb_safe_level(); + rb_set_safe_level_force(state->ele->safe_level); + rb_ensure(autoload_const_set, (VALUE)&args, + reset_safe, (VALUE)safe_backup); + } + + /* wakeup any waiters we had */ + if (need_wakeups) { + struct autoload_state *cur = 0, *nxt; + + list_for_each_safe(&state->waitq.head, cur, nxt, waitq.node) { + VALUE th = cur->thread; + + cur->thread = Qfalse; + list_del_init(&cur->waitq.node); /* idempotent */ + + /* + * cur is stored on the stack of cur->waiting_th, + * do not touch cur after waking up waiting_th + */ + rb_thread_wakeup_alive(th); } } - return ST_CONTINUE; + + return 0; /* ignored */ +} + +static VALUE +autoload_sleep(VALUE arg) +{ + struct autoload_state *state = (struct autoload_state *)arg; + + /* + * autoload_reset in other thread will resume us and remove us + * from the waitq list + */ + do { + rb_thread_sleep_deadly(); + } while (state->thread != Qfalse); + + return Qfalse; +} + +static VALUE +autoload_sleep_done(VALUE arg) +{ + struct autoload_state *state = (struct autoload_state *)arg; + + if (state->thread != Qfalse && rb_thread_to_be_killed(state->thread)) { + list_del(&state->waitq.node); /* idempotent after list_del_init */ + } + + return Qfalse; } VALUE -rb_mod_remove_const(mod, name) - VALUE mod, name; +rb_autoload_load(VALUE mod, ID id) { - ID id = rb_to_id(name); - VALUE val; + VALUE load, result; + const char *loading = 0, *src; + struct autoload_data_i *ele; + struct autoload_state state; - if (!rb_is_const_id(id)) { - rb_raise(rb_eNameError, "`%s' is not constant", rb_id2name(id)); + if (!autoload_defined_p(mod, id)) return Qfalse; + load = check_autoload_required(mod, id, &loading); + if (!load) return Qfalse; + src = rb_sourcefile(); + if (src && loading && strcmp(src, loading) == 0) return Qfalse; + + /* set ele->state for a marker of autoloading thread */ + if (!(ele = get_autoload_data(load))) { + return Qfalse; } - if (RCLASS(mod)->iv_tbl && st_delete(ROBJECT(mod)->iv_tbl, &id, &val)) { - return val; + state.ele = ele; + state.mod = mod; + state.id = id; + state.thread = rb_thread_current(); + if (!ele->state) { + ele->state = &state; + ele->fork_gen = GET_VM()->fork_gen; + + /* + * autoload_reset will wake up any threads added to this + * iff the GVL is released during autoload_require + */ + list_head_init(&state.waitq.head); } - if (rb_const_defined_at(mod, id)) { - rb_raise(rb_eNameError, "cannot remove %s::%s", - rb_class2name(mod), rb_id2name(id)); + else if (state.thread == ele->state->thread) { + return Qfalse; } - rb_raise(rb_eNameError, "constant %s::%s not defined", - rb_class2name(mod), rb_id2name(id)); - return Qnil; /* not reached */ + else { + list_add_tail(&ele->state->waitq.head, &state.waitq.node); + + rb_ensure(autoload_sleep, (VALUE)&state, + autoload_sleep_done, (VALUE)&state); + } + + /* autoload_data_i can be deleted by another thread while require */ + result = rb_ensure(autoload_require, (VALUE)&state, + autoload_reset, (VALUE)&state); + + RB_GC_GUARD(load); + return result; } -static int -autoload_i(key, name, ary) - ID key; - const char *name; - VALUE ary; +VALUE +rb_autoload_p(VALUE mod, ID id) { - VALUE kval = rb_str_new2(rb_id2name(key)); - if (!rb_ary_includes(ary, kval)) { - rb_ary_push(ary, kval); + VALUE load; + struct autoload_data_i *ele; + + while (!autoload_defined_p(mod, id)) { + mod = RCLASS_SUPER(mod); + if (!mod) return Qnil; } - return ST_CONTINUE; + load = check_autoload_required(mod, id, 0); + if (!load) return Qnil; + return (ele = get_autoload_data(load)) ? ele->feature : Qnil; } -VALUE -rb_mod_const_at(mod, ary) - VALUE mod, ary; -{ - if (!FL_TEST(mod, FL_TAINT) && rb_safe_level() >= 4) - rb_raise(rb_eSecurityError, "Insecure: can't get metainfo"); - if (RCLASS(mod)->iv_tbl) { - st_foreach(RCLASS(mod)->iv_tbl, const_i, ary); - } - if ((VALUE)mod == rb_cObject) { - st_foreach(rb_class_tbl, const_i, ary); - if (autoload_tbl) { - st_foreach(autoload_tbl, autoload_i, ary); +void +rb_const_warn_if_deprecated(const rb_const_entry_t *ce, VALUE klass, ID id) +{ + if (RB_CONST_DEPRECATED_P(ce)) { + if (klass == rb_cObject) { + rb_warn("constant ::%"PRIsVALUE" is deprecated", QUOTE_ID(id)); + } + else { + rb_warn("constant %"PRIsVALUE"::%"PRIsVALUE" is deprecated", + rb_class_name(klass), QUOTE_ID(id)); } } - return ary; +} + +static VALUE +rb_const_get_0(VALUE klass, ID id, int exclude, int recurse, int visibility) +{ + VALUE c = rb_const_search(klass, id, exclude, recurse, visibility); + if (c != Qundef) return c; + return rb_const_missing(klass, ID2SYM(id)); +} + +static VALUE +rb_const_search(VALUE klass, ID id, int exclude, int recurse, int visibility) +{ + VALUE value, tmp, av; + rb_const_flag_t flag; + int mod_retry = 0; + + tmp = klass; + retry: + while (RTEST(tmp)) { + VALUE am = 0; + rb_const_entry_t *ce; + + while ((ce = rb_const_lookup(tmp, id))) { + if (visibility && RB_CONST_PRIVATE_P(ce)) { + if (BUILTIN_TYPE(tmp) == T_ICLASS) tmp = RBASIC(tmp)->klass; + rb_name_err_raise("private constant %2$s::%1$s referenced", + tmp, ID2SYM(id)); + } + rb_const_warn_if_deprecated(ce, tmp, id); + value = ce->value; + if (value == Qundef) { + if (am == tmp) break; + am = tmp; + if (rb_autoloading_value(tmp, id, &av, &flag)) return av; + rb_autoload_load(tmp, id); + continue; + } + if (exclude && tmp == rb_cObject && klass != rb_cObject) { +#if 0 + rb_warn("toplevel constant %"PRIsVALUE" referenced by %"PRIsVALUE"::%"PRIsVALUE"", + QUOTE_ID(id), rb_class_name(klass), QUOTE_ID(id)); +#else + return Qundef; +#endif + } + return value; + } + if (!recurse) break; + tmp = RCLASS_SUPER(tmp); + } + if (!exclude && !mod_retry && BUILTIN_TYPE(klass) == T_MODULE) { + mod_retry = 1; + tmp = rb_cObject; + goto retry; + } + + return Qundef; } VALUE -rb_mod_constants(mod) - VALUE mod; +rb_const_get_from(VALUE klass, ID id) { - return rb_mod_const_at(mod, rb_ary_new()); + return rb_const_get_0(klass, id, TRUE, TRUE, FALSE); } VALUE -rb_mod_const_of(mod, ary) - VALUE mod; +rb_const_get(VALUE klass, ID id) +{ + return rb_const_get_0(klass, id, FALSE, TRUE, FALSE); +} + +VALUE +rb_const_get_at(VALUE klass, ID id) +{ + return rb_const_get_0(klass, id, TRUE, FALSE, FALSE); +} + +VALUE +rb_public_const_get_from(VALUE klass, ID id) +{ + return rb_const_get_0(klass, id, TRUE, TRUE, TRUE); +} + +VALUE +rb_public_const_get(VALUE klass, ID id) +{ + return rb_const_get_0(klass, id, FALSE, TRUE, TRUE); +} + +VALUE +rb_public_const_get_at(VALUE klass, ID id) +{ + return rb_const_get_0(klass, id, TRUE, FALSE, TRUE); +} + +/* + * call-seq: + * remove_const(sym) -> obj + * + * Removes the definition of the given constant, returning that + * constant's previous value. If that constant referred to + * a module, this will not change that module's name and can lead + * to confusion. + */ + +VALUE +rb_mod_remove_const(VALUE mod, VALUE name) +{ + const ID id = id_for_var(mod, name, a, constant); + + if (!id) { + rb_name_err_raise("constant %2$s::%1$s not defined", + mod, name); + } + return rb_const_remove(mod, id); +} + +VALUE +rb_const_remove(VALUE mod, ID id) +{ + VALUE val; + rb_const_entry_t *ce; + + rb_check_frozen(mod); + ce = rb_const_lookup(mod, id); + if (!ce || !rb_id_table_delete(RCLASS_CONST_TBL(mod), id)) { + if (rb_const_defined_at(mod, id)) { + rb_name_err_raise("cannot remove %2$s::%1$s", + mod, ID2SYM(id)); + } + rb_name_err_raise("constant %2$s::%1$s not defined", + mod, ID2SYM(id)); + } + + rb_clear_constant_cache(); + + val = ce->value; + if (val == Qundef) { + autoload_delete(mod, id); + val = Qnil; + } + xfree(ce); + return val; +} + +static int +cv_i_update(st_data_t *k, st_data_t *v, st_data_t a, int existing) +{ + if (existing) return ST_STOP; + *v = a; + return ST_CONTINUE; +} + +static enum rb_id_table_iterator_result +sv_i(ID key, VALUE v, void *a) +{ + rb_const_entry_t *ce = (rb_const_entry_t *)v; + st_table *tbl = a; + + if (rb_is_const_id(key)) { + st_update(tbl, (st_data_t)key, cv_i_update, (st_data_t)ce); + } + return ID_TABLE_CONTINUE; +} + +static enum rb_id_table_iterator_result +rb_local_constants_i(ID const_name, VALUE const_value, void *ary) +{ + if (rb_is_const_id(const_name) && !RB_CONST_PRIVATE_P((rb_const_entry_t *)const_value)) { + rb_ary_push((VALUE)ary, ID2SYM(const_name)); + } + return ID_TABLE_CONTINUE; +} + +static VALUE +rb_local_constants(VALUE mod) +{ + struct rb_id_table *tbl = RCLASS_CONST_TBL(mod); VALUE ary; + + if (!tbl) return rb_ary_new2(0); + + ary = rb_ary_new2(rb_id_table_size(tbl)); + rb_id_table_foreach(tbl, rb_local_constants_i, (void *)ary); + return ary; +} + +void* +rb_mod_const_at(VALUE mod, void *data) { - rb_mod_const_at(mod, ary); + st_table *tbl = data; + if (!tbl) { + tbl = st_init_numtable(); + } + if (RCLASS_CONST_TBL(mod)) { + rb_id_table_foreach(RCLASS_CONST_TBL(mod), sv_i, tbl); + } + return tbl; +} + +void* +rb_mod_const_of(VALUE mod, void *data) +{ + VALUE tmp = mod; for (;;) { - mod = RCLASS(mod)->super; - if (!mod) break; - rb_mod_const_at(mod, ary); + data = rb_mod_const_at(tmp, data); + tmp = RCLASS_SUPER(tmp); + if (!tmp) break; + if (tmp == rb_cObject && mod != rb_cObject) break; } + return data; +} + +static int +list_i(st_data_t key, st_data_t value, VALUE ary) +{ + ID sym = (ID)key; + rb_const_entry_t *ce = (rb_const_entry_t *)value; + if (RB_CONST_PUBLIC_P(ce)) rb_ary_push(ary, ID2SYM(sym)); + return ST_CONTINUE; +} + +VALUE +rb_const_list(void *data) +{ + st_table *tbl = data; + VALUE ary; + + if (!tbl) return rb_ary_new2(0); + ary = rb_ary_new2(tbl->num_entries); + st_foreach_safe(tbl, list_i, ary); + st_free_table(tbl); + return ary; } -int -rb_const_defined_at(klass, id) - VALUE klass; - ID id; +/* + * call-seq: + * mod.constants(inherit=true) -> array + * + * Returns an array of the names of the constants accessible in + * <i>mod</i>. This includes the names of constants in any included + * modules (example at start of section), unless the <i>inherit</i> + * parameter is set to <code>false</code>. + * + * The implementation makes no guarantees about the order in which the + * constants are yielded. + * + * IO.constants.include?(:SYNC) #=> true + * IO.constants(false).include?(:SYNC) #=> false + * + * Also see <code>Module::const_defined?</code>. + */ + +VALUE +rb_mod_constants(int argc, const VALUE *argv, VALUE mod) { - if (RCLASS(klass)->iv_tbl && st_lookup(RCLASS(klass)->iv_tbl, id, 0)) { - return Qtrue; + VALUE inherit; + + if (argc == 0) { + inherit = Qtrue; } - if (klass == rb_cObject) { - return rb_const_defined(klass, id); + else { + rb_scan_args(argc, argv, "01", &inherit); + } + + if (RTEST(inherit)) { + return rb_const_list(rb_mod_const_of(mod, 0)); + } + else { + return rb_local_constants(mod); } - return Qfalse; +} + +static int +rb_const_defined_0(VALUE klass, ID id, int exclude, int recurse, int visibility) +{ + VALUE tmp; + int mod_retry = 0; + rb_const_entry_t *ce; + + tmp = klass; + retry: + while (tmp) { + if ((ce = rb_const_lookup(tmp, id))) { + if (visibility && RB_CONST_PRIVATE_P(ce)) { + return (int)Qfalse; + } + if (ce->value == Qundef && !check_autoload_required(tmp, id, 0) && + !rb_autoloading_value(tmp, id, NULL, NULL)) + return (int)Qfalse; + + if (exclude && tmp == rb_cObject && klass != rb_cObject) { + return (int)Qfalse; + } + + return (int)Qtrue; + } + if (!recurse) break; + tmp = RCLASS_SUPER(tmp); + } + if (!exclude && !mod_retry && BUILTIN_TYPE(klass) == T_MODULE) { + mod_retry = 1; + tmp = rb_cObject; + goto retry; + } + return (int)Qfalse; } int -rb_autoload_defined(id) - ID id; +rb_const_defined_from(VALUE klass, ID id) { - if (autoload_tbl && st_lookup(autoload_tbl, id, 0)) - return Qtrue; - return Qfalse; + return rb_const_defined_0(klass, id, TRUE, TRUE, FALSE); } int -rb_const_defined(klass, id) - VALUE klass; - ID id; +rb_const_defined(VALUE klass, ID id) { - VALUE tmp = klass; + return rb_const_defined_0(klass, id, FALSE, TRUE, FALSE); +} - while (tmp) { - if (RCLASS(tmp)->iv_tbl && st_lookup(RCLASS(tmp)->iv_tbl,id,0)) { - return Qtrue; +int +rb_const_defined_at(VALUE klass, ID id) +{ + return rb_const_defined_0(klass, id, TRUE, FALSE, FALSE); +} + +int +rb_public_const_defined_from(VALUE klass, ID id) +{ + return rb_const_defined_0(klass, id, TRUE, TRUE, TRUE); +} + +int +rb_public_const_defined(VALUE klass, ID id) +{ + return rb_const_defined_0(klass, id, FALSE, TRUE, TRUE); +} + +int +rb_public_const_defined_at(VALUE klass, ID id) +{ + return rb_const_defined_0(klass, id, TRUE, FALSE, TRUE); +} + +static void +check_before_mod_set(VALUE klass, ID id, VALUE val, const char *dest) +{ + rb_check_frozen(klass); +} + +void +rb_const_set(VALUE klass, ID id, VALUE val) +{ + rb_const_entry_t *ce; + struct rb_id_table *tbl = RCLASS_CONST_TBL(klass); + + if (NIL_P(klass)) { + rb_raise(rb_eTypeError, "no class/module to define constant %"PRIsVALUE"", + QUOTE_ID(id)); + } + + check_before_mod_set(klass, id, val, "constant"); + if (!tbl) { + RCLASS_CONST_TBL(klass) = tbl = rb_id_table_create(0); + rb_clear_constant_cache(); + ce = ZALLOC(rb_const_entry_t); + rb_id_table_insert(tbl, id, (VALUE)ce); + setup_const_entry(ce, klass, val, CONST_PUBLIC); + } + else { + struct autoload_const_set_args args; + args.mod = klass; + args.id = id; + args.value = val; + args.flag = CONST_PUBLIC; + const_tbl_update(&args); + } + /* + * Resolve and cache class name immediately to resolve ambiguity + * and avoid order-dependency on const_tbl + */ + if (rb_cObject && (RB_TYPE_P(val, T_MODULE) || RB_TYPE_P(val, T_CLASS))) { + if (NIL_P(rb_class_path_cached(val))) { + if (klass == rb_cObject) { + rb_ivar_set(val, classpath, rb_id2str(id)); + rb_name_class(val, id); + } + else { + VALUE path; + ID pathid; + st_data_t n; + st_table *ivtbl = RCLASS_IV_TBL(klass); + if (ivtbl && + (st_lookup(ivtbl, (st_data_t)(pathid = classpath), &n) || + st_lookup(ivtbl, (st_data_t)(pathid = tmp_classpath), &n))) { + path = rb_str_dup((VALUE)n); + rb_str_append(rb_str_cat2(path, "::"), rb_id2str(id)); + OBJ_FREEZE(path); + rb_ivar_set(val, pathid, path); + rb_name_class(val, id); + } + } } - tmp = RCLASS(tmp)->super; } - if (BUILTIN_TYPE(klass) == T_MODULE) { - return rb_const_defined(rb_cObject, id); +} + +static struct autoload_data_i * +current_autoload_data(VALUE mod, ID id) +{ + struct autoload_data_i *ele; + VALUE load = autoload_data(mod, id); + if (!load) return 0; + ele = get_autoload_data(load); + if (!ele) return 0; + /* for autoloading thread, keep the defined value to autoloading storage */ + if (ele->state && (ele->state->thread == rb_thread_current())) { + return ele; } - if (st_lookup(rb_class_tbl, id, 0)) - return Qtrue; - return rb_autoload_defined(id); + return 0; } -void -rb_const_set(klass, id, val) - VALUE klass; - ID id; - VALUE val; +static void +const_tbl_update(struct autoload_const_set_args *args) { - if (!FL_TEST(klass, FL_TAINT) && rb_safe_level() >= 4) - rb_raise(rb_eSecurityError, "Insecure: can't set constant"); - if (!RCLASS(klass)->iv_tbl) { - RCLASS(klass)->iv_tbl = st_init_numtable(); + VALUE value; + VALUE klass = args->mod; + VALUE val = args->value; + ID id = args->id; + struct rb_id_table *tbl = RCLASS_CONST_TBL(klass); + rb_const_flag_t visibility = args->flag; + rb_const_entry_t *ce; + + if (rb_id_table_lookup(tbl, id, &value)) { + ce = (rb_const_entry_t *)value; + if (ce->value == Qundef) { + struct autoload_data_i *ele = current_autoload_data(klass, id); + + if (ele) { + rb_clear_constant_cache(); + + ele->value = val; /* autoload_i is non-WB-protected */ + return; + } + /* otherwise, allow to override */ + autoload_delete(klass, id); + } + else { + VALUE name = QUOTE_ID(id); + visibility = ce->flag; + if (klass == rb_cObject) + rb_warn("already initialized constant %"PRIsVALUE"", name); + else + rb_warn("already initialized constant %"PRIsVALUE"::%"PRIsVALUE"", + rb_class_name(klass), name); + if (!NIL_P(ce->file) && ce->line) { + rb_compile_warn(RSTRING_PTR(ce->file), ce->line, + "previous definition of %"PRIsVALUE" was here", name); + } + } + rb_clear_constant_cache(); + setup_const_entry(ce, klass, val, visibility); } - else if (st_lookup(RCLASS(klass)->iv_tbl, id, 0)) { - rb_warn("already initialized constant %s", rb_id2name(id)); + else { + rb_clear_constant_cache(); + + ce = ZALLOC(rb_const_entry_t); + rb_id_table_insert(tbl, id, (VALUE)ce); + setup_const_entry(ce, klass, val, visibility); } +} - st_insert(RCLASS(klass)->iv_tbl, id, val); +static void +setup_const_entry(rb_const_entry_t *ce, VALUE klass, VALUE val, + rb_const_flag_t visibility) +{ + ce->flag = visibility; + RB_OBJ_WRITE(klass, &ce->value, val); + RB_OBJ_WRITE(klass, &ce->file, rb_source_location(&ce->line)); } void -rb_define_const(klass, name, val) - VALUE klass; - const char *name; - VALUE val; +rb_define_const(VALUE klass, const char *name, VALUE val) { ID id = rb_intern(name); - if (klass == rb_cObject) { - rb_secure(4); - } if (!rb_is_const_id(id)) { - rb_raise(rb_eNameError, "wrong constant name %s", name); + rb_warn("rb_define_const: invalid name `%s' for constant", name); } rb_const_set(klass, id, val); } void -rb_define_global_const(name, val) - const char *name; - VALUE val; +rb_define_global_const(const char *name, VALUE val) { rb_define_const(rb_cObject, name, val); } +static void +set_const_visibility(VALUE mod, int argc, const VALUE *argv, + rb_const_flag_t flag, rb_const_flag_t mask) +{ + int i; + rb_const_entry_t *ce; + ID id; + + rb_frozen_class_p(mod); + if (argc == 0) { + rb_warning("%"PRIsVALUE" with no argument is just ignored", + QUOTE_ID(rb_frame_callee())); + return; + } + + for (i = 0; i < argc; i++) { + VALUE val = argv[i]; + id = rb_check_id(&val); + if (!id) { + if (i > 0) { + rb_clear_constant_cache(); + } + + rb_name_err_raise("constant %2$s::%1$s not defined", + mod, val); + } + if ((ce = rb_const_lookup(mod, id))) { + ce->flag &= ~mask; + ce->flag |= flag; + if (ce->value == Qundef) { + struct autoload_data_i *ele = current_autoload_data(mod, id); + if (ele) { + ele->flag &= ~mask; + ele->flag |= flag; + } + } + } + else { + if (i > 0) { + rb_clear_constant_cache(); + } + rb_name_err_raise("constant %2$s::%1$s not defined", + mod, ID2SYM(id)); + } + } + rb_clear_constant_cache(); +} + +void +rb_deprecate_constant(VALUE mod, const char *name) +{ + rb_const_entry_t *ce; + ID id; + long len = strlen(name); + + rb_frozen_class_p(mod); + if (!(id = rb_check_id_cstr(name, len, NULL)) || + !(ce = rb_const_lookup(mod, id))) { + rb_name_err_raise("constant %2$s::%1$s not defined", + mod, rb_fstring_new(name, len)); + } + ce->flag |= CONST_DEPRECATED; +} + +/* + * call-seq: + * mod.private_constant(symbol, ...) => mod + * + * Makes a list of existing constants private. + */ + VALUE -rb_iv_get(obj, name) - VALUE obj; - const char *name; +rb_mod_private_constant(int argc, const VALUE *argv, VALUE obj) +{ + set_const_visibility(obj, argc, argv, CONST_PRIVATE, CONST_VISIBILITY_MASK); + return obj; +} + +/* + * call-seq: + * mod.public_constant(symbol, ...) => mod + * + * Makes a list of existing constants public. + */ + +VALUE +rb_mod_public_constant(int argc, const VALUE *argv, VALUE obj) +{ + set_const_visibility(obj, argc, argv, CONST_PUBLIC, CONST_VISIBILITY_MASK); + return obj; +} + +/* + * call-seq: + * mod.deprecate_constant(symbol, ...) => mod + * + * Makes a list of existing constants deprecated. + */ + +VALUE +rb_mod_deprecate_constant(int argc, const VALUE *argv, VALUE obj) +{ + set_const_visibility(obj, argc, argv, CONST_DEPRECATED, CONST_DEPRECATED); + return obj; +} + +static VALUE +original_module(VALUE c) +{ + if (RB_TYPE_P(c, T_ICLASS)) + return RBASIC(c)->klass; + return c; +} + +static int +cvar_lookup_at(VALUE klass, ID id, st_data_t *v) +{ + if (!RCLASS_IV_TBL(klass)) return 0; + return st_lookup(RCLASS_IV_TBL(klass), (st_data_t)id, v); +} + +static VALUE +cvar_front_klass(VALUE klass) +{ + if (FL_TEST(klass, FL_SINGLETON)) { + VALUE obj = rb_ivar_get(klass, id__attached__); + if (RB_TYPE_P(obj, T_MODULE) || RB_TYPE_P(obj, T_CLASS)) { + return obj; + } + } + return RCLASS_SUPER(klass); +} + +#define CVAR_FOREACH_ANCESTORS(klass, v, r) \ + for (klass = cvar_front_klass(klass); klass; klass = RCLASS_SUPER(klass)) { \ + if (cvar_lookup_at(klass, id, (v))) { \ + r; \ + } \ + } + +#define CVAR_LOOKUP(v,r) do {\ + if (cvar_lookup_at(klass, id, (v))) {r;}\ + CVAR_FOREACH_ANCESTORS(klass, v, r);\ +} while(0) + +void +rb_cvar_set(VALUE klass, ID id, VALUE val) +{ + VALUE tmp, front = 0, target = 0; + + tmp = klass; + CVAR_LOOKUP(0, {if (!front) front = klass; target = klass;}); + if (target) { + if (front && target != front) { + st_data_t did = id; + + if (RTEST(ruby_verbose)) { + rb_warning("class variable %"PRIsVALUE" of %"PRIsVALUE" is overtaken by %"PRIsVALUE"", + QUOTE_ID(id), rb_class_name(original_module(front)), + rb_class_name(original_module(target))); + } + if (BUILTIN_TYPE(front) == T_CLASS) { + st_delete(RCLASS_IV_TBL(front),&did,0); + } + } + } + else { + target = tmp; + } + + check_before_mod_set(target, id, val, "class variable"); + if (!RCLASS_IV_TBL(target)) { + RCLASS_IV_TBL(target) = st_init_numtable(); + } + + rb_class_ivar_set(target, id, val); +} + +VALUE +rb_cvar_get(VALUE klass, ID id) +{ + VALUE tmp, front = 0, target = 0; + st_data_t value; + + tmp = klass; + CVAR_LOOKUP(&value, {if (!front) front = klass; target = klass;}); + if (!target) { + rb_name_err_raise("uninitialized class variable %1$s in %2$s", + tmp, ID2SYM(id)); + } + if (front && target != front) { + st_data_t did = id; + + if (RTEST(ruby_verbose)) { + rb_warning("class variable %"PRIsVALUE" of %"PRIsVALUE" is overtaken by %"PRIsVALUE"", + QUOTE_ID(id), rb_class_name(original_module(front)), + rb_class_name(original_module(target))); + } + if (BUILTIN_TYPE(front) == T_CLASS) { + st_delete(RCLASS_IV_TBL(front),&did,0); + } + } + return (VALUE)value; +} + +VALUE +rb_cvar_defined(VALUE klass, ID id) +{ + if (!klass) return Qfalse; + CVAR_LOOKUP(0,return Qtrue); + return Qfalse; +} + +static ID +cv_intern(VALUE klass, const char *name) +{ + ID id = rb_intern(name); + if (!rb_is_class_id(id)) { + rb_name_err_raise("wrong class variable name %1$s", + klass, rb_str_new_cstr(name)); + } + return id; +} + +void +rb_cv_set(VALUE klass, const char *name, VALUE val) +{ + ID id = cv_intern(klass, name); + rb_cvar_set(klass, id, val); +} + +VALUE +rb_cv_get(VALUE klass, const char *name) +{ + ID id = cv_intern(klass, name); + return rb_cvar_get(klass, id); +} + +void +rb_define_class_variable(VALUE klass, const char *name, VALUE val) +{ + ID id = cv_intern(klass, name); + rb_cvar_set(klass, id, val); +} + +static int +cv_i(st_data_t k, st_data_t v, st_data_t a) +{ + ID key = (ID)k; + st_table *tbl = (st_table *)a; + + if (rb_is_class_id(key)) { + st_update(tbl, (st_data_t)key, cv_i_update, 0); + } + return ST_CONTINUE; +} + +static void* +mod_cvar_at(VALUE mod, void *data) +{ + st_table *tbl = data; + if (!tbl) { + tbl = st_init_numtable(); + } + if (RCLASS_IV_TBL(mod)) { + st_foreach_safe(RCLASS_IV_TBL(mod), cv_i, (st_data_t)tbl); + } + return tbl; +} + +static void* +mod_cvar_of(VALUE mod, void *data) +{ + VALUE tmp = mod; + for (;;) { + data = mod_cvar_at(tmp, data); + tmp = RCLASS_SUPER(tmp); + if (!tmp) break; + } + return data; +} + +static int +cv_list_i(st_data_t key, st_data_t value, VALUE ary) +{ + ID sym = (ID)key; + rb_ary_push(ary, ID2SYM(sym)); + return ST_CONTINUE; +} + +static VALUE +cvar_list(void *data) +{ + st_table *tbl = data; + VALUE ary; + + if (!tbl) return rb_ary_new2(0); + ary = rb_ary_new2(tbl->num_entries); + st_foreach_safe(tbl, cv_list_i, ary); + st_free_table(tbl); + + return ary; +} + +/* + * call-seq: + * mod.class_variables(inherit=true) -> array + * + * Returns an array of the names of class variables in <i>mod</i>. + * This includes the names of class variables in any included + * modules, unless the <i>inherit</i> parameter is set to + * <code>false</code>. + * + * class One + * @@var1 = 1 + * end + * class Two < One + * @@var2 = 2 + * end + * One.class_variables #=> [:@@var1] + * Two.class_variables #=> [:@@var2, :@@var1] + * Two.class_variables(false) #=> [:@@var2] + */ + +VALUE +rb_mod_class_variables(int argc, const VALUE *argv, VALUE mod) +{ + VALUE inherit; + st_table *tbl; + + if (argc == 0) { + inherit = Qtrue; + } + else { + rb_scan_args(argc, argv, "01", &inherit); + } + if (RTEST(inherit)) { + tbl = mod_cvar_of(mod, 0); + } + else { + tbl = mod_cvar_at(mod, 0); + } + return cvar_list(tbl); +} + +/* + * call-seq: + * remove_class_variable(sym) -> obj + * + * Removes the definition of the <i>sym</i>, returning that + * constant's value. + * + * class Dummy + * @@var = 99 + * puts @@var + * remove_class_variable(:@@var) + * p(defined? @@var) + * end + * + * <em>produces:</em> + * + * 99 + * nil + */ + +VALUE +rb_mod_remove_cvar(VALUE mod, VALUE name) +{ + const ID id = id_for_var_message(mod, name, class, "wrong class variable name %1$s"); + st_data_t val, n = id; + + if (!id) { + not_defined: + rb_name_err_raise("class variable %1$s not defined for %2$s", + mod, name); + } + rb_check_frozen(mod); + if (RCLASS_IV_TBL(mod) && st_delete(RCLASS_IV_TBL(mod), &n, &val)) { + return (VALUE)val; + } + if (rb_cvar_defined(mod, id)) { + rb_name_err_raise("cannot remove %1$s for %2$s", mod, ID2SYM(id)); + } + goto not_defined; +} + +VALUE +rb_iv_get(VALUE obj, const char *name) { ID id = rb_intern(name); @@ -1221,12 +3140,46 @@ rb_iv_get(obj, name) } VALUE -rb_iv_set(obj, name, val) - VALUE obj; - const char *name; - VALUE val; +rb_iv_set(VALUE obj, const char *name, VALUE val) { ID id = rb_intern(name); return rb_ivar_set(obj, id, val); } + +/* tbl = xx(obj); tbl[key] = value; */ +int +rb_class_ivar_set(VALUE obj, ID key, VALUE value) +{ + st_table *tbl = RCLASS_IV_TBL(obj); + int result = st_insert(tbl, (st_data_t)key, (st_data_t)value); + RB_OBJ_WRITTEN(obj, Qundef, value); + return result; +} + +static int +tbl_copy_i(st_data_t key, st_data_t value, st_data_t data) +{ + RB_OBJ_WRITTEN((VALUE)data, Qundef, (VALUE)value); + return ST_CONTINUE; +} + +st_table * +rb_st_copy(VALUE obj, struct st_table *orig_tbl) +{ + st_table *new_tbl = st_copy(orig_tbl); + st_foreach(new_tbl, tbl_copy_i, (st_data_t)obj); + return new_tbl; +} + +rb_const_entry_t * +rb_const_lookup(VALUE klass, ID id) +{ + struct rb_id_table *tbl = RCLASS_CONST_TBL(klass); + VALUE val; + + if (tbl && rb_id_table_lookup(tbl, id, &val)) { + return (rb_const_entry_t *)val; + } + return 0; +} |