Ruby: symbol.h Source File

Ruby 3.4.8p72 (2025-12-17 revision 995b59f66677d44767ce9faac6957e5543617ff9)

symbol.h
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
26 struct RSymbol {
27 struct RBasic basic;
28 st_index_t hashval;
29 VALUE fstr;
30 ID id;
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
55typedef uint32_t rb_id_serial_t;
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 ?
59 RUBY_ID_SCOPE_SHIFT : 0);
60
61 typedef struct {
62 rb_id_serial_t last_id;
63 st_table *str_sym;
64 VALUE ids;
65 VALUE dsymbol_fstr_hash;
66} rb_symbols_t;
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
103#ifndef RIPPER
104RUBY_FUNC_EXPORTED
105#else
106 RUBY_EXTERN
107#endif
108const uint_least32_t ruby_global_name_punct_bits[(0x7e - 0x20 + 31) / 32];
109
110static inline int
111is_global_name_punct(const int c)
112{
113 if (c <= 0x20 || 0x7e < c) return 0;
114 return (ruby_global_name_punct_bits[(c - 0x20) / 32] >> (c % 32)) & 1;
115}
116
117RUBY_SYMBOL_EXPORT_BEGIN
118
119int rb_enc_symname_type(const char *name, long len, rb_encoding *enc, unsigned int allowed_attrset);
120size_t rb_sym_immortal_count(void);
121
122RUBY_SYMBOL_EXPORT_END
123#endif
RUBY_EXTERN
#define RUBY_EXTERN
Declaration of externally visible global variables.
Definition dllexport.h:45
STATIC_SYM_P
#define STATIC_SYM_P
Old name of RB_STATIC_SYM_P.
Definition special_consts.h:57
encoding.h
Encoding relates APIs.
len
int len
Length of the buffer.
Definition io.h:8
RUBY_SPECIAL_SHIFT
@ RUBY_SPECIAL_SHIFT
Least significant 8 bits are reserved.
Definition special_consts.h:119
OnigEncodingTypeST
Definition onigmo.h:160
RBasic
Ruby object's base components.
Definition rbasic.h:63
RSymbol
Definition symbol.h:26
rb_symbols_t
Definition symbol.h:61
st_table
Definition st.h:79
ID
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
Definition value.h:52
VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40