1#ifndef INTERNAL_STRING_H
2#define INTERNAL_STRING_H
11#include "ruby/internal/config.h"
13#include "internal/compilers.h"
18#define STR_SHARED FL_USER0
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
24enum ruby_rstring_private_flags {
25 RSTRING_CHILLED = STR_CHILLED,
29# undef rb_fstring_cstr
35VALUE rb_fstring_cstr(
const char *str);
37int rb_str_buf_cat_escaped_char(
VALUE result,
unsigned int c,
int unicode_p);
38int rb_str_symname_p(
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);
45VALUE rb_str_cat_conv_enc_opts(
VALUE newstr,
long ofs,
const char *ptr,
long len,
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);
54int rb_ascii8bit_appendable_encoding_index(
rb_encoding *enc,
unsigned int code);
58VALUE rb_str_tmp_frozen_no_embed_acquire(
VALUE str);
59void rb_str_make_embedded(
VALUE);
61size_t rb_str_size_as_embedded(
VALUE);
62bool rb_str_reembeddable_p(
VALUE);
68void rb_warn_unchilled_literal(
VALUE str);
69void rb_warn_unchilled_symbol_to_s(
VALUE str);
71static inline bool STR_EMBED_P(
VALUE str);
72static inline bool STR_SHARED_P(
VALUE str);
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);
79RUBY_SYMBOL_EXPORT_BEGIN
82void rb_str_tmp_frozen_release(
VALUE str,
VALUE tmp);
86VALUE 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();
92VALUE rb_str_concat_literals(
size_t num,
const VALUE *strary);
94VALUE rb_id_quote_unprintable(
ID);
95VALUE rb_sym_proc_call(
ID mid,
int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_proc);
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)
109 return rb_str_quote_unprintable(v);
115 return rb_id_quote_unprintable(i);
119STR_EMBED_P(
VALUE str)
125STR_SHARED_P(
VALUE str)
127 return FL_ALL_RAW(str, STR_NOEMBED | STR_SHARED);
131CHILLED_STRING_P(
VALUE obj)
137CHILLED_STRING_MUTATED(
VALUE str)
141 switch (chilled_reason) {
142 case STR_CHILLED_SYMBOL_TO_S:
143 rb_warn_unchilled_symbol_to_s(str);
145 case STR_CHILLED_LITERAL:
146 rb_warn_unchilled_literal(str);
149 rb_bug(
"RString was chilled for multiple reasons");
154is_ascii_string(
VALUE str)
160is_broken_string(
VALUE str)
166at_char_boundary(
const char *s,
const char *p,
const char *e,
rb_encoding *enc)
172at_char_right_boundary(
const char *s,
const char *p,
const char *e,
rb_encoding *enc)
183rb_str_eql_internal(
const VALUE str1,
const VALUE str2)
185 const long len = RSTRING_LEN(str1);
186 const char *ptr1, *ptr2;
188 if (
len != RSTRING_LEN(str2))
return Qfalse;
190 if ((ptr1 = RSTRING_PTR(str1)) == (ptr2 = RSTRING_PTR(str2)))
192 if (memcmp(ptr1, ptr2,
len) == 0)
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))
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
static VALUE RB_FL_TEST_RAW(VALUE obj, VALUE flags)
This is an implementation detail of RB_FL_TEST().
#define ENC_CODERANGE_7BIT
Old name of RUBY_ENC_CODERANGE_7BIT.
#define FL_UNSET_RAW
Old name of RB_FL_UNSET_RAW.
#define T_STRING
Old name of RUBY_T_STRING.
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
#define Qtrue
Old name of RUBY_Qtrue.
#define Qfalse
Old name of RUBY_Qfalse.
#define ENC_CODERANGE_BROKEN
Old name of RUBY_ENC_CODERANGE_BROKEN.
#define FL_ALL_RAW
Old name of RB_FL_ALL_RAW.
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.
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.
int rb_enc_str_coderange(VALUE str)
Scans the passed string to collect its code range.
int rb_str_comparable(VALUE str1, VALUE str2)
Checks if two strings are comparable each other or not.
int len
Length of the buffer.
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.