Ruby 3.0.5p211 (2022-11-24 revision ba5cf0f7c52d4d35cc6a173c89eda98ceffa2dcf)
symbol.h
Go to the documentation of this file.
1#ifndef RUBY_SYMBOL_H
2#define RUBY_SYMBOL_H 1
3/**********************************************************************
4
5 symbol.h -
6
7 $Author$
8 created at: Tue Jul 8 15:49:54 JST 2014
9
10 Copyright (C) 2014 Yukihiro Matsumoto
11
12**********************************************************************/
13
14#include "id.h"
15#include "ruby/encoding.h"
16
17#define DYNAMIC_ID_P(id) (!(id&ID_STATIC_SYM)&&id>tLAST_OP_ID)
18#define STATIC_ID2SYM(id) (((VALUE)(id)<<RUBY_SPECIAL_SHIFT)|SYMBOL_FLAG)
19
20#ifdef HAVE_BUILTIN___BUILTIN_CONSTANT_P
21#define rb_id2sym(id) \
22 RB_GNUC_EXTENSION_BLOCK(__builtin_constant_p(id) && !DYNAMIC_ID_P(id) ? \
23 STATIC_ID2SYM(id) : rb_id2sym(id))
24#endif
25
26struct RSymbol {
27 struct RBasic basic;
31};
32
33#define RSYMBOL(obj) ((struct RSymbol *)(obj))
34
35#define is_notop_id(id) ((id)>tLAST_OP_ID)
36#define is_local_id(id) (id_type(id)==ID_LOCAL)
37#define is_global_id(id) (id_type(id)==ID_GLOBAL)
38#define is_instance_id(id) (id_type(id)==ID_INSTANCE)
39#define is_attrset_id(id) ((id)==idASET||id_type(id)==ID_ATTRSET)
40#define is_const_id(id) (id_type(id)==ID_CONST)
41#define is_class_id(id) (id_type(id)==ID_CLASS)
42#define is_junk_id(id) (id_type(id)==ID_JUNK)
43
44static inline int
45id_type(ID id)
46{
47 if (is_notop_id(id)) {
48 return (int)(id&ID_SCOPE_MASK);
49 }
50 else {
51 return -1;
52 }
53}
54
56static const uint32_t RB_ID_SERIAL_MAX = /* 256M on LP32 */
57 UINT32_MAX >>
58 ((sizeof(ID)-sizeof(rb_id_serial_t))*CHAR_BIT < RUBY_ID_SCOPE_SHIFT ?
60
61typedef struct {
67
68static inline rb_id_serial_t
69rb_id_to_serial(ID id)
70{
71 if (is_notop_id(id)) {
72 return (rb_id_serial_t)(id >> ID_SCOPE_SHIFT);
73 }
74 else {
75 return (rb_id_serial_t)id;
76 }
77}
78
79static inline int
80sym_type(VALUE sym)
81{
82 ID id;
83 if (STATIC_SYM_P(sym)) {
84 id = RSHIFT(sym, RUBY_SPECIAL_SHIFT);
85 if (id<=tLAST_OP_ID) {
86 return -1;
87 }
88 }
89 else {
90 id = RSYMBOL(sym)->id;
91 }
92 return (int)(id&ID_SCOPE_MASK);
93}
94
95#define is_local_sym(sym) (sym_type(sym)==ID_LOCAL)
96#define is_global_sym(sym) (sym_type(sym)==ID_GLOBAL)
97#define is_instance_sym(sym) (sym_type(sym)==ID_INSTANCE)
98#define is_attrset_sym(sym) (sym_type(sym)==ID_ATTRSET)
99#define is_const_sym(sym) (sym_type(sym)==ID_CONST)
100#define is_class_sym(sym) (sym_type(sym)==ID_CLASS)
101#define is_junk_sym(sym) (sym_type(sym)==ID_JUNK)
102
103RUBY_FUNC_EXPORTED const unsigned int ruby_global_name_punct_bits[(0x7e - 0x20 + 31) / 32];
104
105static inline int
106is_global_name_punct(const int c)
107{
108 if (c <= 0x20 || 0x7e < c) return 0;
109 return (ruby_global_name_punct_bits[(c - 0x20) / 32] >> (c % 32)) & 1;
110}
111
112int rb_enc_symname_type(const char *name, long len, rb_encoding *enc, unsigned int allowed_attrset);
113
114RUBY_SYMBOL_EXPORT_BEGIN
115
116size_t rb_sym_immortal_count(void);
117
118RUBY_SYMBOL_EXPORT_END
119#endif
#define sym(name)
Definition: enumerator.c:4007
uint8_t len
Definition: escape.c:17
@ tLAST_OP_ID
Definition: id.h:286
#define ID_SCOPE_SHIFT
Definition: id.h:31
@ RUBY_ID_SCOPE_SHIFT
Definition: id.h:26
#define ID_SCOPE_MASK
Definition: id.h:32
#define CHAR_BIT
Definition: limits.h:44
const int id
Definition: nkf.c:209
const char * name
Definition: nkf.c:208
unsigned int uint32_t
Definition: sha2.h:101
@ RUBY_SPECIAL_SHIFT
#define STATIC_SYM_P
st_data_t st_index_t
Definition: st.h:50
Definition: rbasic.h:47
Definition: symbol.h:26
struct RBasic basic
Definition: symbol.h:27
st_index_t hashval
Definition: symbol.h:28
VALUE fstr
Definition: symbol.h:29
ID id
Definition: symbol.h:30
rb_id_serial_t last_id
Definition: symbol.h:62
VALUE ids
Definition: symbol.h:64
st_table * str_sym
Definition: symbol.h:63
VALUE dsymbol_fstr_hash
Definition: symbol.h:65
Definition: st.h:79
#define is_notop_id(id)
Definition: symbol.h:35
size_t rb_sym_immortal_count(void)
Definition: symbol.c:998
const unsigned int ruby_global_name_punct_bits[(0x7e - 0x20+31)/32]
Definition: symbol.h:103
int rb_enc_symname_type(const char *name, long len, rb_encoding *enc, unsigned int allowed_attrset)
Definition: symbol.c:365
uint32_t rb_id_serial_t
Definition: symbol.h:55
#define RSYMBOL(obj)
Definition: symbol.h:33
unsigned long VALUE
Definition: value.h:38
unsigned long ID
Definition: value.h:39