Ruby: internal/string.h Source File

Ruby 4.0.5p0 (2026-05-20 revision 64336ffd0ee9e1f4c05891695a3d7b49cb709721)

string.h
1#ifndef INTERNAL_STRING_H /*-*-C-*-vi:se ft=c:*/
2#define INTERNAL_STRING_H
11#include "ruby/internal/config.h"
12#include <stddef.h> /* for size_t */
13#include "internal/compilers.h" /* for __has_builtin */
14#include "ruby/internal/stdbool.h" /* for bool */
15#include "ruby/encoding.h" /* for rb_encoding */
16#include "ruby/ruby.h" /* for VALUE */
17
18#define STR_SHARED FL_USER0 /* = ELTS_SHARED */
19#define STR_NOEMBED FL_USER1
20#define STR_CHILLED (FL_USER2 | FL_USER3)
21#define STR_CHILLED_LITERAL FL_USER2
22#define STR_CHILLED_SYMBOL_TO_S FL_USER3
23
24enum ruby_rstring_private_flags {
25 RSTRING_CHILLED = STR_CHILLED,
26};
27
28#ifdef rb_fstring_cstr
29# undef rb_fstring_cstr
30#endif
31
32/* string.c */
33 VALUE rb_str_dup_m(VALUE str);
34 VALUE rb_fstring(VALUE);
35 VALUE rb_fstring_cstr(const char *str);
36 VALUE rb_fstring_enc_new(const char *ptr, long len, rb_encoding *enc);
37int rb_str_buf_cat_escaped_char(VALUE result, unsigned int c, int unicode_p);
38int rb_str_symname_p(VALUE);
39 VALUE rb_str_quote_unprintable(VALUE);
40char *rb_str_fill_terminator(VALUE str, const int termlen);
41void rb_str_change_terminator_length(VALUE str, const int oldtermlen, const int termlen);
42 VALUE rb_str_locktmp_ensure(VALUE str, VALUE (*func)(VALUE), VALUE arg);
43 VALUE rb_str_chomp_string(VALUE str, VALUE chomp);
44 VALUE rb_external_str_with_enc(VALUE str, rb_encoding *eenc);
45 VALUE rb_str_cat_conv_enc_opts(VALUE newstr, long ofs, const char *ptr, long len,
46 rb_encoding *from, int ecflags, VALUE ecopts);
47 VALUE rb_enc_str_scrub(rb_encoding *enc, VALUE str, VALUE repl);
48 VALUE rb_str_escape(VALUE str);
49size_t rb_str_memsize(VALUE);
50char *rb_str_to_cstr(VALUE str);
51const char *ruby_escaped_char(int c);
52void rb_str_make_independent(VALUE str);
53int rb_enc_str_coderange_scan(VALUE str, rb_encoding *enc);
54int rb_ascii8bit_appendable_encoding_index(rb_encoding *enc, unsigned int code);
55 VALUE rb_str_include(VALUE str, VALUE arg);
56 VALUE rb_str_byte_substr(VALUE str, VALUE beg, VALUE len);
57 VALUE rb_str_substr_two_fixnums(VALUE str, VALUE beg, VALUE len, int empty);
58 VALUE rb_str_tmp_frozen_no_embed_acquire(VALUE str);
59void rb_str_make_embedded(VALUE);
60 VALUE rb_str_upto_each(VALUE, VALUE, int, int (*each)(VALUE, VALUE), VALUE);
61size_t rb_str_size_as_embedded(VALUE);
62bool rb_str_reembeddable_p(VALUE);
63 VALUE rb_str_upto_endless_each(VALUE, int (*each)(VALUE, VALUE), VALUE);
64 VALUE rb_str_with_debug_created_info(VALUE, VALUE, int);
65 VALUE rb_str_frozen_bare_string(VALUE);
66
67/* error.c */
68void rb_warn_unchilled_literal(VALUE str);
69void rb_warn_unchilled_symbol_to_s(VALUE str);
70
71static inline bool STR_EMBED_P(VALUE str);
72static inline bool STR_SHARED_P(VALUE str);
73static inline VALUE QUOTE(VALUE v);
74static inline VALUE QUOTE_ID(ID v);
75static inline bool is_ascii_string(VALUE str);
76static inline bool is_broken_string(VALUE str);
77static inline VALUE rb_str_eql_internal(const VALUE str1, const VALUE str2);
78
79RUBY_SYMBOL_EXPORT_BEGIN
80/* string.c (export) */
81 VALUE rb_str_tmp_frozen_acquire(VALUE str);
82void rb_str_tmp_frozen_release(VALUE str, VALUE tmp);
83 VALUE rb_setup_fake_str(struct RString *fake_str, const char *name, long len, rb_encoding *enc);
84RUBY_SYMBOL_EXPORT_END
85
86 VALUE rb_fstring_new(const char *ptr, long len);
87void rb_gc_free_fstring(VALUE obj);
88bool rb_obj_is_fstring_table(VALUE obj);
89void Init_fstring_table();
90 VALUE rb_obj_as_string_result(VALUE str, VALUE obj);
91 VALUE rb_str_opt_plus(VALUE x, VALUE y);
92 VALUE rb_str_concat_literals(size_t num, const VALUE *strary);
93 VALUE rb_str_eql(VALUE str1, VALUE str2);
94 VALUE rb_id_quote_unprintable(ID);
95 VALUE rb_sym_proc_call(ID mid, int argc, const VALUE *argv, int kw_splat, VALUE passed_proc);
96 VALUE rb_enc_literal_str(const char *ptr, long len, rb_encoding *enc);
97
98struct rb_execution_context_struct;
99 VALUE rb_ec_str_resurrect(struct rb_execution_context_struct *ec, VALUE str, bool chilled);
100
101#define rb_fstring_lit(str) rb_fstring_new((str), rb_strlen_lit(str))
102#define rb_fstring_literal(str) rb_fstring_lit(str)
103#define rb_fstring_enc_lit(str, enc) rb_fstring_enc_new((str), rb_strlen_lit(str), (enc))
104#define rb_fstring_enc_literal(str, enc) rb_fstring_enc_lit(str, enc)
105
106static inline VALUE
107QUOTE(VALUE v)
108{
109 return rb_str_quote_unprintable(v);
110}
111
112static inline VALUE
113QUOTE_ID(ID i)
114{
115 return rb_id_quote_unprintable(i);
116}
117
118static inline bool
119STR_EMBED_P(VALUE str)
120{
121 return ! FL_TEST_RAW(str, STR_NOEMBED);
122}
123
124static inline bool
125STR_SHARED_P(VALUE str)
126{
127 return FL_ALL_RAW(str, STR_NOEMBED | STR_SHARED);
128}
129
130static inline bool
131CHILLED_STRING_P(VALUE obj)
132{
133 return RB_TYPE_P(obj, T_STRING) && FL_TEST_RAW(obj, STR_CHILLED);
134}
135
136static inline void
137CHILLED_STRING_MUTATED(VALUE str)
138{
139 VALUE chilled_reason = RB_FL_TEST_RAW(str, STR_CHILLED);
140 FL_UNSET_RAW(str, STR_CHILLED);
141 switch (chilled_reason) {
142 case STR_CHILLED_SYMBOL_TO_S:
143 rb_warn_unchilled_symbol_to_s(str);
144 break;
145 case STR_CHILLED_LITERAL:
146 rb_warn_unchilled_literal(str);
147 break;
148 default:
149 rb_bug("RString was chilled for multiple reasons");
150 }
151}
152
153static inline bool
154is_ascii_string(VALUE str)
155{
156 return rb_enc_str_coderange(str) == ENC_CODERANGE_7BIT;
157}
158
159static inline bool
160is_broken_string(VALUE str)
161{
162 return rb_enc_str_coderange(str) == ENC_CODERANGE_BROKEN;
163}
164
165static inline bool
166at_char_boundary(const char *s, const char *p, const char *e, rb_encoding *enc)
167{
168 return rb_enc_left_char_head(s, p, e, enc) == p;
169}
170
171static inline bool
172at_char_right_boundary(const char *s, const char *p, const char *e, rb_encoding *enc)
173{
174 RUBY_ASSERT(s <= p);
175 RUBY_ASSERT(p <= e);
176
177 return rb_enc_right_char_head(s, p, e, enc) == p;
178}
179
180/* expect tail call optimization */
181// YJIT needs this function to never allocate and never raise
182static inline VALUE
183rb_str_eql_internal(const VALUE str1, const VALUE str2)
184{
185 const long len = RSTRING_LEN(str1);
186 const char *ptr1, *ptr2;
187
188 if (len != RSTRING_LEN(str2)) return Qfalse;
189 if (!rb_str_comparable(str1, str2)) return Qfalse;
190 if ((ptr1 = RSTRING_PTR(str1)) == (ptr2 = RSTRING_PTR(str2)))
191 return Qtrue;
192 if (memcmp(ptr1, ptr2, len) == 0)
193 return Qtrue;
194 return Qfalse;
195}
196
197#if __has_builtin(__builtin_constant_p)
198# define rb_fstring_cstr(str) \
199 (__builtin_constant_p(str) ? \
200 rb_fstring_new((str), (long)strlen(str)) : \
201 (rb_fstring_cstr)(str))
202#endif
203#endif /* INTERNAL_STRING_H */
RUBY_ASSERT
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
Definition assert.h:219
RB_FL_TEST_RAW
static VALUE RB_FL_TEST_RAW(VALUE obj, VALUE flags)
This is an implementation detail of RB_FL_TEST().
Definition fl_type.h:463
ENC_CODERANGE_7BIT
#define ENC_CODERANGE_7BIT
Old name of RUBY_ENC_CODERANGE_7BIT.
Definition coderange.h:180
FL_UNSET_RAW
#define FL_UNSET_RAW
Old name of RB_FL_UNSET_RAW.
Definition fl_type.h:133
T_STRING
#define T_STRING
Old name of RUBY_T_STRING.
Definition value_type.h:78
FL_TEST_RAW
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
Definition fl_type.h:131
Qtrue
#define Qtrue
Old name of RUBY_Qtrue.
Definition special_consts.h:61
Qfalse
#define Qfalse
Old name of RUBY_Qfalse.
Definition special_consts.h:59
ENC_CODERANGE_BROKEN
#define ENC_CODERANGE_BROKEN
Old name of RUBY_ENC_CODERANGE_BROKEN.
Definition coderange.h:182
FL_ALL_RAW
#define FL_ALL_RAW
Old name of RB_FL_ALL_RAW.
Definition fl_type.h:123
encoding.h
Encoding relates APIs.
rb_enc_left_char_head
static char * rb_enc_left_char_head(const char *s, const char *p, const char *e, rb_encoding *enc)
Queries the left boundary of a character.
Definition encoding.h:683
rb_enc_right_char_head
static char * rb_enc_right_char_head(const char *s, const char *p, const char *e, rb_encoding *enc)
Queries the right boundary of a character.
Definition encoding.h:704
rb_enc_str_coderange
int rb_enc_str_coderange(VALUE str)
Scans the passed string to collect its code range.
Definition string.c:947
rb_str_comparable
int rb_str_comparable(VALUE str1, VALUE str2)
Checks if two strings are comparable each other or not.
Definition string.c:4191
len
int len
Length of the buffer.
Definition io.h:8
ruby.h
stdbool.h
C99 shim for <stdbool.h>.
RString
Ruby's String.
Definition rstring.h:196
rb_execution_context_struct
Definition vm_core.h:1033
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
RB_TYPE_P
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
Definition value_type.h:376