14#include "internal/error.h"
15#include "internal/gc.h"
16#include "internal/hash.h"
17#include "internal/object.h"
18#include "internal/symbol.h"
19#include "internal/vm.h"
28# define USE_SYMBOL_GC 1
31# define SYMBOL_DEBUG 0
33#ifndef CHECK_ID_SERIAL
34# define CHECK_ID_SERIAL SYMBOL_DEBUG
37#define SYMBOL_PINNED_P(sym) (RSYMBOL(sym)->id&~ID_SCOPE_MASK)
39#define STATIC_SYM2ID(sym) RSHIFT((VALUE)(sym), RUBY_SPECIAL_SHIFT)
42static ID register_static_symid_str(
ID,
VALUE);
43#define REGISTER_SYMID(id, name) register_static_symid((id), (name), strlen(name), enc)
46#define is_identchar(p,e,enc) (ISALNUM((unsigned char)*(p)) || (*(p)) == '_' || !ISASCII(*(p)))
48#define op_tbl_count numberof(op_tbl)
49STATIC_ASSERT(op_tbl_name_size,
sizeof(op_tbl[0].name) == 3);
50#define op_tbl_len(i) (!op_tbl[i].name[1] ? 1 : !op_tbl[i].name[2] ? 2 : 3)
58 for (i =
'!'; i <=
'~'; ++i) {
61 register_static_symid(i, &c, 1, enc);
64 for (i = 0; i < op_tbl_count; ++i) {
65 register_static_symid(op_tbl[i].token, op_tbl[i].name, op_tbl_len(i), enc);
69static const int ID_ENTRY_UNIT = 512;
89 VALUE dsym_fstrs = rb_ident_hash_new();
90 symbols->dsymbol_fstr_hash = dsym_fstrs;
91 rb_gc_register_mark_object(dsym_fstrs);
94 symbols->str_sym = st_init_table_with_size(&symhash, 1000);
95 symbols->ids = rb_ary_hidden_new(0);
96 rb_gc_register_mark_object(symbols->ids);
104WARN_UNUSED_RESULT(
static ID lookup_str_id(
VALUE str));
106WARN_UNUSED_RESULT(
static VALUE lookup_str_sym(
const VALUE str));
107WARN_UNUSED_RESULT(
static VALUE lookup_id_str(
ID id));
108WARN_UNUSED_RESULT(
static ID intern_str(
VALUE str,
int mutable));
110#define GLOBAL_SYMBOLS_ENTER(symbols) rb_symbols_t *symbols = &ruby_global_symbols; RB_VM_LOCK_ENTER()
111#define GLOBAL_SYMBOLS_LEAVE() RB_VM_LOCK_LEAVE()
119 if (!is_notop_id(
id)) {
121 case tAREF:
case tASET:
124 rb_name_error(
id,
"cannot make operator ID :%"PRIsVALUE
" attrset",
130 case ID_LOCAL:
case ID_INSTANCE:
case ID_GLOBAL:
131 case ID_CONST:
case ID_CLASS:
case ID_JUNK:
137 if ((str = lookup_id_str(
id)) != 0) {
138 rb_name_error(
id,
"cannot make unknown type ID %d:%"PRIsVALUE
" attrset",
150 if (!(str = lookup_id_str(
id))) {
151 static const char id_types[][8] = {
161 rb_name_error(
id,
"cannot make anonymous %.*s ID %"PRIxVALUE
" attrset",
162 (
int)
sizeof(id_types[0]), id_types[scope], (
VALUE)
id);
166 sym = lookup_str_sym(str);
167 id = sym ?
rb_sym2id(sym) : intern_str(str, 1);
172is_special_global_name(
const char *m,
const char *e,
rb_encoding *enc)
176 if (m >= e)
return 0;
177 if (is_global_name_punct(*m)) {
180 else if (*m ==
'-') {
181 if (++m >= e)
return 0;
182 if (is_identchar(m, e, enc)) {
184 m += rb_enc_mbclen(m, e, enc);
192 }
while (m < e &&
ISDIGIT(*m));
194 return m == e ? mb + 1 : 0;
210rb_sym_constant_char_p(
const char *name,
long nlen,
rb_encoding *enc)
213 const char *end = name + nlen;
215 if (nlen < 1)
return FALSE;
217 c = rb_enc_precise_mbclen(name, end, enc);
221 if (ONIGENC_IS_UNICODE(enc)) {
222 static int ctype_titlecase = 0;
225 if (!ctype_titlecase) {
226 static const UChar cname[] =
"titlecaseletter";
227 static const UChar *
const end = cname +
sizeof(cname) - 1;
228 ctype_titlecase = ONIGENC_PROPERTY_NAME_TO_CTYPE(enc, cname, end);
234 OnigUChar fold[ONIGENC_GET_CASE_FOLD_CODES_MAX_NUM];
235 const OnigUChar *beg = (
const OnigUChar *)name;
236 int r = enc->mbc_case_fold(ONIGENC_CASE_FOLD,
237 &beg, (
const OnigUChar *)end,
239 if (r > 0 && (r != len || memcmp(fold, name, r)))
245#define IDSET_ATTRSET_FOR_SYNTAX ((1U<<ID_LOCAL)|(1U<<ID_CONST))
246#define IDSET_ATTRSET_FOR_INTERN (~(~0U<<(1<<ID_SCOPE_SHIFT)) & ~(1U<<ID_ATTRSET))
249 const enum { invalid, stophere, needmore, } kind;
250 const enum ruby_id_types type;
254#define t struct enc_synmane_type_leading_chars_tag
257enc_synmane_type_leading_chars(const char *name,
long len,
rb_encoding *enc,
int allowed_attrset)
259 const char *m = name;
260 const char *e = m + len;
263 return (t) { invalid, 0, 0, };
266 return (t) { invalid, 0, 0, };
268 else if ( len <= 0 ) {
269 return (t) { invalid, 0, 0, };
273 return (t) { invalid, 0, 0, };
276 if (is_special_global_name(++m, e, enc)) {
277 return (t) { stophere, ID_GLOBAL, len, };
280 return (t) { needmore, ID_GLOBAL, 1, };
285 default:
return (t) { needmore, ID_INSTANCE, 1, };
286 case '@':
return (t) { needmore, ID_CLASS, 2, };
291 default:
return (t) { stophere, ID_JUNK, 1, };
292 case '<':
return (t) { stophere, ID_JUNK, 2, };
295 default:
return (t) { stophere, ID_JUNK, 2, };
296 case '>':
return (t) { stophere, ID_JUNK, 3, };
302 default:
return (t) { stophere, ID_JUNK, 1, };
303 case '>':
case '=':
return (t) { stophere, ID_JUNK, 2, };
308 default:
return (t) { invalid, 0, 1, };
309 case '~':
return (t) { stophere, ID_JUNK, 2, };
312 default:
return (t) { stophere, ID_JUNK, 2, };
313 case '=':
return (t) { stophere, ID_JUNK, 3, };
319 default:
return (t) { stophere, ID_JUNK, 1, };
320 case '*':
return (t) { stophere, ID_JUNK, 2, };
325 default:
return (t) { stophere, ID_JUNK, 1, };
326 case '@':
return (t) { stophere, ID_JUNK, 2, };
329 case '|':
case '^':
case '&':
case '/':
case '%':
case '~':
case '`':
330 return (t) { stophere, ID_JUNK, 1, };
334 default:
return (t) { needmore, ID_JUNK, 0, };
337 default:
return (t) { stophere, ID_JUNK, 2, };
338 case '=':
return (t) { stophere, ID_JUNK, 3, };
344 case '=':
case '~':
return (t) { stophere, ID_JUNK, 2, };
346 if (allowed_attrset & (1U << ID_JUNK)) {
347 return (t) { needmore, ID_JUNK, 1, };
350 return (t) { stophere, ID_JUNK, 1, };
355 if (rb_sym_constant_char_p(name, len, enc)) {
356 return (t) { needmore, ID_CONST, 0, };
359 return (t) { needmore, ID_LOCAL, 0, };
366rb_enc_symname_type(
const char *name,
long len,
rb_encoding *enc,
unsigned int allowed_attrset)
369 enc_synmane_type_leading_chars(name, len, enc, allowed_attrset);
370 const char *m = name + f.nread;
371 const char *e = name + len;
372 int type = (int)f.type;
375 case invalid:
return -1;
376 case stophere:
break;
380 if (len > 1 && *(e-1) ==
'=') {
381 type = rb_enc_symname_type(name, len-1, enc, allowed_attrset);
382 if (allowed_attrset & (1U <<
type))
return ID_ATTRSET;
386 while (m < e && is_identchar(m, e, enc)) m += rb_enc_mbclen(m, e, enc);
390 if (
type == ID_GLOBAL ||
type == ID_CLASS ||
type == ID_INSTANCE)
return -1;
393 if (m + 1 < e || *m !=
'=')
break;
396 if (!(allowed_attrset & (1U <<
type)))
return -1;
403 return m == e ?
type : -1;
409 return rb_enc_symname_type(name, len, enc, IDSET_ATTRSET_FOR_SYNTAX) != -1;
413rb_str_symname_type(
VALUE name,
unsigned int allowed_attrset)
417 int type = rb_enc_symname_type(ptr, len, rb_enc_get(name), allowed_attrset);
426 size_t idx = num / ID_ENTRY_UNIT;
428 VALUE ary, ids = symbols->ids;
429 if (idx >= (
size_t)
RARRAY_LEN(ids) ||
NIL_P(ary = rb_ary_entry(ids, (
long)idx))) {
430 ary = rb_ary_hidden_new(ID_ENTRY_UNIT * ID_ENTRY_SIZE);
431 rb_ary_store(ids, (
long)idx, ary);
433 idx = (num % ID_ENTRY_UNIT) * ID_ENTRY_SIZE;
434 rb_ary_store(ary, (
long)idx + ID_ENTRY_STR, str);
435 rb_ary_store(ary, (
long)idx + ID_ENTRY_SYM, sym);
439get_id_serial_entry(rb_id_serial_t num,
ID id,
const enum id_entry_type t)
443 GLOBAL_SYMBOLS_ENTER(symbols);
445 if (num && num <= symbols->last_id) {
446 size_t idx = num / ID_ENTRY_UNIT;
447 VALUE ids = symbols->ids;
449 if (idx < (
size_t)
RARRAY_LEN(ids) && !
NIL_P(ary = rb_ary_entry(ids, (
long)idx))) {
450 long pos = (long)(num % ID_ENTRY_UNIT) * ID_ENTRY_SIZE;
451 result = rb_ary_entry(ary, pos + t);
460 if (t != ID_ENTRY_SYM)
461 sym = rb_ary_entry(ary, pos + ID_ENTRY_SYM);
463 if (STATIC_SYM2ID(sym) !=
id) result = 0;
466 if (RSYMBOL(sym)->
id !=
id) result = 0;
474 GLOBAL_SYMBOLS_LEAVE();
480get_id_entry(
ID id,
const enum id_entry_type t)
482 return get_id_serial_entry(rb_id_to_serial(
id),
id, t);
486rb_static_id_valid_p(
ID id)
488 return STATIC_ID2SYM(
id) == get_id_entry(
id, ID_ENTRY_SYM);
492rb_id_serial_to_id(rb_id_serial_t num)
494 if (is_notop_id((
ID)num)) {
495 VALUE sym = get_id_serial_entry(num, 0, ID_ENTRY_SYM);
496 if (sym)
return SYM2ID(sym);
497 return ((
ID)num << ID_SCOPE_SHIFT) | ID_INTERNAL | ID_STATIC_SYM;
506register_sym_update_callback(st_data_t *key, st_data_t *value, st_data_t arg,
int existing)
509 rb_fatal(
"symbol :% "PRIsVALUE
" is already registered with %"PRIxVALUE,
523 st_update(symbols->str_sym, (st_data_t)str,
524 register_sym_update_callback, (st_data_t)sym);
526 st_add_direct(symbols->str_sym, (st_data_t)str, (st_data_t)sym);
535 st_data_t str_data = (st_data_t)str;
536 if (!st_delete(symbols->str_sym, &str_data, NULL)) {
542register_static_symid(
ID id,
const char *name,
long len,
rb_encoding *enc)
545 return register_static_symid_str(
id, str);
549register_static_symid_str(
ID id,
VALUE str)
551 rb_id_serial_t num = rb_id_to_serial(
id);
552 VALUE sym = STATIC_ID2SYM(
id);
555 str = rb_fstring(str);
559 GLOBAL_SYMBOLS_ENTER(symbols)
561 register_sym(symbols, str, sym);
562 set_id_entry(symbols, num, str, sym);
564 GLOBAL_SYMBOLS_LEAVE();
570sym_check_asciionly(
VALUE str)
591must_be_dynamic_symbol(
VALUE x)
601 rb_bug(
"wrong argument: inappropriate Symbol (%p)", (
void *)x);
605 rb_bug(
"wrong argument type %s (expected Symbol)", rb_builtin_class_name(x));
619 rb_enc_set_index(dsym, rb_enc_to_index(enc));
622 RSYMBOL(dsym)->id =
type;
626 RSYMBOL(dsym)->hashval = RSHIFT((
long)hashval, 1);
627 register_sym(symbols, str, dsym);
628 rb_hash_aset(symbols->dsymbol_fstr_hash, str,
Qtrue);
629 RUBY_DTRACE_CREATE_HOOK(SYMBOL,
RSTRING_PTR(RSYMBOL(dsym)->fstr));
639 if (UNLIKELY(rb_objspace_garbage_object_p(sym))) {
640 const VALUE fstr = RSYMBOL(sym)->fstr;
641 const ID type = RSYMBOL(sym)->id & ID_SCOPE_MASK;
642 RSYMBOL(sym)->fstr = 0;
643 unregister_sym(symbols, fstr, sym);
644 return dsymbol_alloc(symbols,
rb_cSymbol, fstr, rb_enc_get(fstr),
type);
652lookup_str_id(
VALUE str)
657 GLOBAL_SYMBOLS_ENTER(symbols);
659 found = st_lookup(symbols->str_sym, (st_data_t)str, &sym_data);
661 GLOBAL_SYMBOLS_LEAVE();
667 return STATIC_SYM2ID(sym);
670 ID id = RSYMBOL(sym)->id;
671 if (
id & ~ID_SCOPE_MASK)
return id;
674 rb_bug(
"non-symbol object %s:%"PRIxVALUE
" for %"PRIsVALUE
" in symbol table",
675 rb_builtin_class_name(sym), sym, str);
685 if (st_lookup(symbols->str_sym, (st_data_t)str, &sym_data)) {
688 sym = dsymbol_check(symbols, sym);
698lookup_str_sym(
const VALUE str)
702 GLOBAL_SYMBOLS_ENTER(symbols);
704 sym = lookup_str_sym_with_lock(symbols, str);
706 GLOBAL_SYMBOLS_LEAVE();
714 return get_id_entry(
id, ID_ENTRY_STR);
722 VALUE str = rb_setup_fake_str(&fake_str, name,
len, enc);
724 sym = lookup_str_sym(str);
727 return intern_str(str, 1);
734 rb_id_serial_t next_serial = symbols->last_id + 1;
736 if (next_serial == 0) {
740 const size_t num = ++symbols->last_id;
741 id = num << ID_SCOPE_SHIFT;
751 GLOBAL_SYMBOLS_ENTER(symbols);
753 id = next_id_base_with_lock(symbols);
755 GLOBAL_SYMBOLS_LEAVE();
760intern_str(
VALUE str,
int mutable)
765 id = rb_str_symname_type(str, IDSET_ATTRSET_FOR_INTERN);
766 if (
id == (
ID)-1)
id = ID_JUNK;
767 if (sym_check_asciionly(str)) {
769 rb_enc_associate(str, rb_usascii_encoding());
771 if ((nid = next_id_base()) == (
ID)-1) {
778 return register_static_symid_str(
id, str);
797 VALUE sym = lookup_str_sym(str);
803 return intern_str(str, 0);
807rb_gc_free_dsymbol(
VALUE sym)
809 VALUE str = RSYMBOL(sym)->fstr;
812 RSYMBOL(sym)->fstr = 0;
814 GLOBAL_SYMBOLS_ENTER(symbols);
816 unregister_sym(symbols, str, sym);
817 rb_hash_delete_entry(symbols->dsymbol_fstr_hash, str);
819 GLOBAL_SYMBOLS_LEAVE();
853 GLOBAL_SYMBOLS_ENTER(symbols);
855 sym = lookup_str_sym_with_lock(symbols, str);
862 enc = rb_enc_get(str);
863 ascii = rb_usascii_encoding();
864 if (enc != ascii && sym_check_asciionly(str)) {
866 rb_enc_associate(str, ascii);
874 str = rb_fstring(str);
875 type = rb_str_symname_type(str, IDSET_ATTRSET_FOR_INTERN);
879 id = intern_str(str, 0);
884 GLOBAL_SYMBOLS_LEAVE();
893 id = STATIC_SYM2ID(sym);
896 GLOBAL_SYMBOLS_ENTER(symbols);
898 sym = dsymbol_check(symbols, sym);
899 id = RSYMBOL(sym)->id;
901 if (UNLIKELY(!(
id & ~ID_SCOPE_MASK))) {
902 VALUE fstr = RSYMBOL(sym)->fstr;
903 ID num = next_id_base_with_lock(symbols);
905 RSYMBOL(sym)->id =
id |= num;
908 set_id_entry(symbols, rb_id_to_serial(num), fstr, sym);
909 rb_hash_delete_entry(symbols->dsymbol_fstr_hash, fstr);
912 GLOBAL_SYMBOLS_LEAVE();
916 rb_builtin_class_name(sym));
925 if (!DYNAMIC_ID_P(x))
return STATIC_ID2SYM(x);
926 return get_id_entry(x, ID_ENTRY_SYM);
945 return RSYMBOL(sym)->fstr;
948 return rb_id2str(STATIC_SYM2ID(sym));
955 return lookup_id_str(
id);
961 VALUE str = rb_id2str(
id);
968rb_make_internal_id(
void)
970 return next_id_base() | ID_INTERNAL | ID_STATIC_SYM;
974rb_make_temporary_id(
size_t n)
976 const ID max_id = RB_ID_SERIAL_MAX & ~0xffff;
977 const ID id = max_id - (
ID)n;
978 if (
id <= ruby_global_symbols.last_id) {
981 return (
id << ID_SCOPE_SHIFT) | ID_STATIC_SYM | ID_INTERNAL;
985symbols_i(st_data_t key, st_data_t value, st_data_t arg)
991 rb_ary_push(
ary, sym);
997 else if (!SYMBOL_PINNED_P(sym) && rb_objspace_garbage_object_p(sym)) {
998 RSYMBOL(sym)->fstr = 0;
1002 rb_ary_push(
ary, sym);
1013 GLOBAL_SYMBOLS_ENTER(symbols);
1016 st_foreach(symbols->str_sym, symbols_i,
ary);
1018 GLOBAL_SYMBOLS_LEAVE();
1024rb_sym_immortal_count(
void)
1026 return (
size_t)ruby_global_symbols.last_id;
1032 return is_const_id(
id);
1038 return is_class_id(
id);
1044 return is_global_id(
id);
1050 return is_instance_id(
id);
1056 return is_attrset_id(
id);
1062 return is_local_id(
id);
1068 return is_junk_id(
id);
1072rb_is_const_sym(
VALUE sym)
1074 return is_const_sym(sym);
1078rb_is_attrset_sym(
VALUE sym)
1080 return is_attrset_sym(sym);
1087 VALUE name = *namep;
1090 return STATIC_SYM2ID(name);
1093 if (SYMBOL_PINNED_P(name)) {
1094 return RSYMBOL(name)->id;
1097 *namep = RSYMBOL(name)->fstr;
1111 sym_check_asciionly(name);
1113 return lookup_str_id(name);
1118rb_get_symbol_id(
VALUE name)
1121 return STATIC_SYM2ID(name);
1124 if (SYMBOL_PINNED_P(name)) {
1125 return RSYMBOL(name)->id;
1133 return lookup_str_id(name);
1143 VALUE name = *namep;
1149 if (!SYMBOL_PINNED_P(name)) {
1150 GLOBAL_SYMBOLS_ENTER(symbols);
1152 name = dsymbol_check(symbols, name);
1154 GLOBAL_SYMBOLS_LEAVE();
1170 sym_check_asciionly(name);
1172 if ((sym = lookup_str_sym(name)) != 0) {
1183 const VALUE name = rb_setup_fake_str(&fake_str,
ptr,
len, enc);
1185 sym_check_asciionly(name);
1187 return lookup_str_id(name);
1195 const VALUE name = rb_setup_fake_str(&fake_str,
ptr,
len, enc);
1197 sym_check_asciionly(name);
1199 if ((sym = lookup_str_sym(name)) != 0) {
1206#undef rb_sym_intern_ascii_cstr
1211FUNC_MINIMIZED(
VALUE rb_sym_intern_ascii(
const char *
ptr,
long len));
1212FUNC_MINIMIZED(
VALUE rb_sym_intern_ascii_cstr(
const char *
ptr));
1219 const VALUE name = rb_setup_fake_str(&fake_str,
ptr,
len, enc);
1224rb_sym_intern_ascii(
const char *
ptr,
long len)
1226 return rb_sym_intern(
ptr,
len, rb_usascii_encoding());
1230rb_sym_intern_ascii_cstr(
const char *
ptr)
1232 return rb_sym_intern_ascii(
ptr, strlen(
ptr));
1236rb_to_symbol_type(
VALUE obj)
1238 return rb_convert_type_with_id(obj,
T_SYMBOL,
"Symbol", idTo_sym);
1242rb_is_const_name(
VALUE name)
1244 return rb_str_symname_type(name, 0) == ID_CONST;
1248rb_is_class_name(
VALUE name)
1250 return rb_str_symname_type(name, 0) == ID_CLASS;
1254rb_is_instance_name(
VALUE name)
1256 return rb_str_symname_type(name, 0) == ID_INSTANCE;
1260rb_is_local_name(
VALUE name)
1262 return rb_str_symname_type(name, 0) == ID_LOCAL;
1265#include "id_table.c"
1266#include "symbol.rbinc"
#define RUBY_ASSERT_ALWAYS(expr)
A variant of RUBY_ASSERT that does not interface with RUBY_DEBUG.
static bool rb_enc_isupper(OnigCodePoint c, rb_encoding *enc)
Identical to rb_isupper(), except it additionally takes an encoding.
static bool rb_enc_isctype(OnigCodePoint c, OnigCtype t, rb_encoding *enc)
Queries if the passed code point is of passed character type in the passed encoding.
static bool rb_enc_islower(OnigCodePoint c, rb_encoding *enc)
Identical to rb_islower(), except it additionally takes an encoding.
#define ENC_CODERANGE_7BIT
Old name of RUBY_ENC_CODERANGE_7BIT.
#define T_STRING
Old name of RUBY_T_STRING.
#define ISUPPER
Old name of rb_isupper.
#define ID2SYM
Old name of RB_ID2SYM.
#define OBJ_FREEZE
Old name of RB_OBJ_FREEZE.
#define SYM2ID
Old name of RB_SYM2ID.
#define ISDIGIT
Old name of rb_isdigit.
#define STATIC_SYM_P
Old name of RB_STATIC_SYM_P.
#define MBCLEN_CHARFOUND_LEN(ret)
Old name of ONIGENC_MBCLEN_CHARFOUND_LEN.
#define ISALPHA
Old name of rb_isalpha.
#define ISASCII
Old name of rb_isascii.
#define Qtrue
Old name of RUBY_Qtrue.
#define DYNAMIC_SYM_P
Old name of RB_DYNAMIC_SYM_P.
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define ENC_CODERANGE_BROKEN
Old name of RUBY_ENC_CODERANGE_BROKEN.
#define NIL_P
Old name of RB_NIL_P.
#define MBCLEN_CHARFOUND_P(ret)
Old name of ONIGENC_MBCLEN_CHARFOUND_P.
#define FL_WB_PROTECTED
Old name of RUBY_FL_WB_PROTECTED.
#define T_SYMBOL
Old name of RUBY_T_SYMBOL.
#define rb_ary_new2
Old name of rb_ary_new_capa.
#define ISALNUM
Old name of rb_isalnum.
void rb_raise(VALUE exc, const char *fmt,...)
Exception entry point.
void rb_bug(const char *fmt,...)
Interpreter panic switch.
void rb_name_error(ID id, const char *fmt,...)
Raises an instance of rb_eNameError.
VALUE rb_eTypeError
TypeError exception.
void rb_name_error_str(VALUE str, const char *fmt,...)
Identical to rb_name_error(), except it takes a VALUE instead of ID.
void rb_fatal(const char *fmt,...)
Raises the unsung "fatal" exception.
VALUE rb_eRuntimeError
RuntimeError exception.
VALUE rb_eEncodingError
EncodingError exception.
VALUE rb_obj_hide(VALUE obj)
Make the object invisible from Ruby code.
VALUE rb_cSymbol
Sumbol class.
#define RB_OBJ_WRITE(old, slot, young)
Declaration of a "back" pointer.
static const char * rb_enc_name(rb_encoding *enc)
Queries the (canonical) name of the passed encoding.
static bool rb_enc_asciicompat(rb_encoding *enc)
Queries if the passed encoding is in some sense compatible with ASCII.
static OnigCodePoint rb_enc_mbc_to_codepoint(const char *p, const char *e, rb_encoding *enc)
Identical to rb_enc_codepoint(), except it assumes the passed character is not broken.
int rb_enc_str_coderange(VALUE str)
Scans the passed string to collect its code range.
VALUE rb_enc_str_new(const char *ptr, long len, rb_encoding *enc)
Identical to rb_enc_str_new(), except it additionally takes an encoding.
int rb_enc_symname_p(const char *str, rb_encoding *enc)
Identical to rb_symname_p(), except it additionally takes an encoding.
ID rb_intern3(const char *name, long len, rb_encoding *enc)
Identical to rb_intern2(), except it additionally takes an encoding.
VALUE rb_check_symbol_cstr(const char *ptr, long len, rb_encoding *enc)
Identical to rb_check_id_cstr(), except for the return type.
int rb_enc_symname2_p(const char *name, long len, rb_encoding *enc)
Identical to rb_enc_symname_p(), except it additionally takes the passed string's length.
ID rb_check_id_cstr(const char *ptr, long len, rb_encoding *enc)
Identical to rb_check_id(), except it takes a pointer to a memory region instead of Ruby's string.
VALUE rb_sym_all_symbols(void)
Collects every single bits of symbols that have ever interned in the entire history of the current pr...
int rb_is_global_id(ID id)
Classifies the given ID, then sees if it is a global variable.
int rb_is_instance_id(ID id)
Classifies the given ID, then sees if it is an instance variable.
int rb_is_const_id(ID id)
Classifies the given ID, then sees if it is a constant.
int rb_is_junk_id(ID)
Classifies the given ID, then sees if it is a junk ID.
int rb_symname_p(const char *str)
Sees if the passed C string constructs a valid syntactic symbol.
ID rb_id_attrset(ID id)
Calculates an ID of attribute writer.
int rb_is_class_id(ID id)
Classifies the given ID, then sees if it is a class variable.
int rb_is_attrset_id(ID id)
Classifies the given ID, then sees if it is an attribute writer.
int rb_is_local_id(ID id)
Classifies the given ID, then sees if it is a local variable.
int rb_str_hash_cmp(VALUE str1, VALUE str2)
Compares two strings.
VALUE rb_str_ellipsize(VALUE str, long len)
Shortens str and adds three dots, an ellipsis, if it is longer than len characters.
VALUE rb_str_dup(VALUE str)
Duplicates a string.
st_index_t rb_str_hash(VALUE str)
Calculates a hash value of a string.
VALUE rb_str_cat(VALUE dst, const char *src, long srclen)
Destructively appends the passed contents to the string.
VALUE rb_check_string_type(VALUE obj)
Try converting an object to its stringised representation using its to_str method,...
VALUE rb_str_intern(VALUE str)
Identical to rb_to_symbol(), except it assumes the receiver being an instance of RString.
ID rb_intern2(const char *name, long len)
Identical to rb_intern(), except it additionally takes the length of the string.
VALUE rb_check_symbol(volatile VALUE *namep)
Identical to rb_check_id(), except it returns an instance of rb_cSymbol instead.
VALUE rb_id2sym(ID id)
Allocates an instance of rb_cSymbol that has the given id.
ID rb_check_id(volatile VALUE *namep)
Detects if the given name is already interned or not.
ID rb_intern(const char *name)
Finds or creates a symbol of the given name.
VALUE rb_sym2str(VALUE id)
Identical to rb_id2str(), except it takes an instance of rb_cSymbol rather than an ID.
ID rb_sym2id(VALUE obj)
Converts an instance of rb_cSymbol into an ID.
const char * rb_id2name(ID id)
Retrieves the name mapped to the given id.
ID rb_intern_str(VALUE str)
Identical to rb_intern(), except it takes an instance of rb_cString.
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
VALUE type(ANYARGS)
ANYARGS-ed function type.
#define RARRAY_LEN
Just another name of rb_array_len.
#define StringValuePtr(v)
Identical to StringValue, except it returns a char*.
static long RSTRING_LEN(VALUE str)
Queries the length of the string.
static char * RSTRING_PTR(VALUE str)
Queries the contents pointer of the string.
@ RUBY_SPECIAL_SHIFT
Least significant 8 bits are reserved.
long len
Length of the string, not including terminating NUL character.
char ary[RSTRING_EMBED_LEN_MAX+1]
When a string is short enough, it uses this area to store the contents themselves.
char * ptr
Pointer to the contents of the string.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.