Ruby: include/ruby/internal/symbol.h Source File

Ruby 3.2.5p208 (2024-07-26 revision 31d0f1a2e7dbfb60731d1f05b868e1d578cda493)

symbol.h
Go to the documentation of this file.
1#ifndef RBIMPL_SYMBOL_H /*-*-C++-*-vi:se ft=cpp:*/
2#define RBIMPL_SYMBOL_H
23#include "ruby/internal/config.h"
24
25#ifdef STDC_HEADERS
26# include <stddef.h>
27#endif
28
29#ifdef HAVE_STRING_H
30# include <string.h>
31#endif
32
33#include "ruby/internal/attr/noalias.h"
34#include "ruby/internal/attr/nonnull.h"
35#include "ruby/internal/attr/pure.h"
36#include "ruby/internal/cast.h"
37#include "ruby/internal/constant_p.h"
38#include "ruby/internal/dllexport.h"
39#include "ruby/internal/has/builtin.h"
40#include "ruby/internal/value.h"
41
42#define RB_ID2SYM rb_id2sym
43#define RB_SYM2ID rb_sym2id
44#define ID2SYM RB_ID2SYM
45#define SYM2ID RB_SYM2ID
46#define CONST_ID_CACHE RUBY_CONST_ID_CACHE
47#define CONST_ID RUBY_CONST_ID
50#define rb_intern_const rb_intern_const
53 RBIMPL_SYMBOL_EXPORT_BEGIN()
54
55
62 ID rb_sym2id(VALUE obj);
63
71 VALUE rb_id2sym(ID id);
72
73 RBIMPL_ATTR_NONNULL(())
85 ID rb_intern(const char *name);
86
101 ID rb_intern2(const char *name, long len);
102
118 ID rb_intern_str(VALUE str);
119
129const char *rb_id2name(ID id);
130
131 RBIMPL_ATTR_NONNULL(())
174 ID rb_check_id(volatile VALUE *namep);
175
186 ID rb_to_id(VALUE str);
187
201 VALUE rb_id2str(ID id);
202
211 VALUE rb_sym2str(VALUE id);
212
228 VALUE rb_to_symbol(VALUE name);
229
230 RBIMPL_ATTR_NONNULL(())
252 VALUE rb_check_symbol(volatile VALUE *namep);
253 RBIMPL_SYMBOL_EXPORT_END()
254
255 RBIMPL_ATTR_PURE()
256 RBIMPL_ATTR_NONNULL(())
275static inline ID
276rb_intern_const(const char *str)
277{
278 size_t len = strlen(str);
279 return rb_intern2(str, RBIMPL_CAST((long)len));
280}
281
282 RBIMPL_ATTR_NOALIAS()
283 RBIMPL_ATTR_NONNULL(())
289static inline ID
290rbimpl_intern_const(ID *ptr, const char *str)
291{
292 while (! *ptr) {
293 *ptr = rb_intern_const(str);
294 }
295
296 return *ptr;
297}
298
303#define RUBY_CONST_ID_CACHE(result, str) \
304 { \
305 static ID rb_intern_id_cache; \
306 rbimpl_intern_const(&rb_intern_id_cache, (str)); \
307 result rb_intern_id_cache; \
308 }
309
314#define RUBY_CONST_ID(var, str) \
315 do { \
316 static ID rbimpl_id; \
317 (var) = rbimpl_intern_const(&rbimpl_id, (str)); \
318 } while (0)
319
320#if defined(HAVE_STMT_AND_DECL_IN_EXPR)
321/* __builtin_constant_p and statement expression is available
322 * since gcc-2.7.2.3 at least. */
323#define rb_intern(str) \
324 (RBIMPL_CONSTANT_P(str) ? \
325 __extension__ ({ \
326 static ID rbimpl_id; \
327 rbimpl_intern_const(&rbimpl_id, (str)); \
328 }) : \
329 (rb_intern)(str))
330#endif
331
332#endif /* RBIMPL_SYMBOL_H */
constant_p.h
Defines RBIMPL_CONSTANT_P.
dllexport.h
Tweaking visibility of C variables/functions.
RBIMPL_SYMBOL_EXPORT_END
#define RBIMPL_SYMBOL_EXPORT_END()
Counterpart of RBIMPL_SYMBOL_EXPORT_BEGIN.
Definition dllexport.h:106
RBIMPL_SYMBOL_EXPORT_BEGIN
#define RBIMPL_SYMBOL_EXPORT_BEGIN()
Shortcut macro equivalent to RUBY_SYMBOL_EXPORT_BEGIN extern "C" {.
Definition dllexport.h:97
builtin.h
Defines RBIMPL_HAS_BUILTIN.
rb_intern2
ID rb_intern2(const char *name, long len)
Identical to rb_intern(), except it additionally takes the length of the string.
Definition symbol.c:789
rb_check_symbol
VALUE rb_check_symbol(volatile VALUE *namep)
Identical to rb_check_id(), except it returns an instance of rb_cSymbol instead.
Definition symbol.c:1140
rb_intern_const
static ID rb_intern_const(const char *str)
This is a "tiny optimisation" over rb_intern().
Definition symbol.h:276
rb_id2sym
VALUE rb_id2sym(ID id)
Allocates an instance of rb_cSymbol that has the given id.
Definition symbol.c:924
rb_check_id
ID rb_check_id(volatile VALUE *namep)
Detects if the given name is already interned or not.
Definition symbol.c:1085
rb_intern
ID rb_intern(const char *name)
Finds or creates a symbol of the given name.
Definition symbol.c:796
rb_sym2str
VALUE rb_sym2str(VALUE id)
Identical to rb_id2str(), except it takes an instance of rb_cSymbol rather than an ID.
Definition symbol.c:943
rb_to_symbol
VALUE rb_to_symbol(VALUE name)
Identical to rb_intern_str(), except it generates a dynamic symbol if necessary.
Definition string.c:11924
rb_sym2id
ID rb_sym2id(VALUE obj)
Converts an instance of rb_cSymbol into an ID.
Definition symbol.c:890
rb_to_id
ID rb_to_id(VALUE str)
Identical to rb_intern(), except it takes an instance of rb_cString.
Definition string.c:11914
rb_id2name
const char * rb_id2name(ID id)
Retrieves the name mapped to the given id.
Definition symbol.c:960
rb_intern_str
ID rb_intern_str(VALUE str)
Identical to rb_intern(), except it takes an instance of rb_cString.
Definition symbol.c:802
noalias.h
Defines RBIMPL_ATTR_NOALIAS.
RBIMPL_ATTR_NOALIAS
#define RBIMPL_ATTR_NOALIAS()
Wraps (or simulates) __declspec((noalias))
Definition noalias.h:66
nonnull.h
Defines RBIMPL_ATTR_NONNULL.
RBIMPL_ATTR_NONNULL
#define RBIMPL_ATTR_NONNULL(list)
Wraps (or simulates) __attribute__((nonnull))
Definition nonnull.h:30
pure.h
Defines RBIMPL_ATTR_PURE.
RBIMPL_ATTR_PURE
#define RBIMPL_ATTR_PURE()
Wraps (or simulates) __attribute__((pure))
Definition pure.h:33
value.h
Defines VALUE and ID.
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