148 lines
5.1 KiB
C
148 lines
5.1 KiB
C
#ifndef INTERNAL_STRING_H /*-*-C-*-vi:se ft=c:*/
|
|
#define INTERNAL_STRING_H
|
|
/**
|
|
* @author Ruby developers <ruby-core@ruby-lang.org>
|
|
* @copyright This file is a part of the programming language Ruby.
|
|
* Permission is hereby granted, to either redistribute and/or
|
|
* modify this file, provided that the conditions mentioned in the
|
|
* file COPYING are met. Consult the file for details.
|
|
* @brief Internal header for String.
|
|
*/
|
|
#include "ruby/internal/config.h"
|
|
#include <stddef.h> /* for size_t */
|
|
#include "internal/compilers.h" /* for __has_builtin */
|
|
#include "ruby/internal/stdbool.h" /* for bool */
|
|
#include "ruby/encoding.h" /* for rb_encoding */
|
|
#include "ruby/ruby.h" /* for VALUE */
|
|
|
|
#define STR_NOEMBED FL_USER1
|
|
#define STR_SHARED FL_USER2 /* = ELTS_SHARED */
|
|
|
|
#ifdef rb_fstring_cstr
|
|
# undef rb_fstring_cstr
|
|
#endif
|
|
|
|
/* string.c */
|
|
VALUE rb_fstring(VALUE);
|
|
VALUE rb_fstring_cstr(const char *str);
|
|
VALUE rb_fstring_enc_new(const char *ptr, long len, rb_encoding *enc);
|
|
int rb_str_buf_cat_escaped_char(VALUE result, unsigned int c, int unicode_p);
|
|
int rb_str_symname_p(VALUE);
|
|
VALUE rb_str_quote_unprintable(VALUE);
|
|
char *rb_str_fill_terminator(VALUE str, const int termlen);
|
|
void rb_str_change_terminator_length(VALUE str, const int oldtermlen, const int termlen);
|
|
VALUE rb_str_locktmp_ensure(VALUE str, VALUE (*func)(VALUE), VALUE arg);
|
|
VALUE rb_str_chomp_string(VALUE str, VALUE chomp);
|
|
VALUE rb_external_str_with_enc(VALUE str, rb_encoding *eenc);
|
|
VALUE rb_str_cat_conv_enc_opts(VALUE newstr, long ofs, const char *ptr, long len,
|
|
rb_encoding *from, int ecflags, VALUE ecopts);
|
|
VALUE rb_enc_str_scrub(rb_encoding *enc, VALUE str, VALUE repl);
|
|
VALUE rb_str_escape(VALUE str);
|
|
size_t rb_str_memsize(VALUE);
|
|
char *rb_str_to_cstr(VALUE str);
|
|
const char *ruby_escaped_char(int c);
|
|
void rb_str_make_independent(VALUE str);
|
|
int rb_enc_str_coderange_scan(VALUE str, rb_encoding *enc);
|
|
int rb_ascii8bit_appendable_encoding_index(rb_encoding *enc, unsigned int code);
|
|
VALUE rb_str_include(VALUE str, VALUE arg);
|
|
|
|
static inline bool STR_EMBED_P(VALUE str);
|
|
static inline bool STR_SHARED_P(VALUE str);
|
|
static inline VALUE QUOTE(VALUE v);
|
|
static inline VALUE QUOTE_ID(ID v);
|
|
static inline bool is_ascii_string(VALUE str);
|
|
static inline bool is_broken_string(VALUE str);
|
|
static inline VALUE rb_str_eql_internal(const VALUE str1, const VALUE str2);
|
|
|
|
RUBY_SYMBOL_EXPORT_BEGIN
|
|
/* string.c (export) */
|
|
VALUE rb_str_tmp_frozen_acquire(VALUE str);
|
|
void rb_str_tmp_frozen_release(VALUE str, VALUE tmp);
|
|
VALUE rb_setup_fake_str(struct RString *fake_str, const char *name, long len, rb_encoding *enc);
|
|
VALUE rb_str_upto_each(VALUE, VALUE, int, int (*each)(VALUE, VALUE), VALUE);
|
|
VALUE rb_str_upto_endless_each(VALUE, int (*each)(VALUE, VALUE), VALUE);
|
|
void rb_str_make_embedded(VALUE);
|
|
size_t rb_str_size_as_embedded(VALUE);
|
|
bool rb_str_reembeddable_p(VALUE);
|
|
void rb_str_update_shared_ary(VALUE str, VALUE old_root, VALUE new_root);
|
|
RUBY_SYMBOL_EXPORT_END
|
|
|
|
MJIT_SYMBOL_EXPORT_BEGIN
|
|
VALUE rb_fstring_new(const char *ptr, long len);
|
|
VALUE rb_obj_as_string_result(VALUE str, VALUE obj);
|
|
VALUE rb_str_opt_plus(VALUE x, VALUE y);
|
|
VALUE rb_str_concat_literals(size_t num, const VALUE *strary);
|
|
VALUE rb_str_eql(VALUE str1, VALUE str2);
|
|
VALUE rb_id_quote_unprintable(ID);
|
|
VALUE rb_sym_proc_call(ID mid, int argc, const VALUE *argv, int kw_splat, VALUE passed_proc);
|
|
|
|
struct rb_execution_context_struct;
|
|
VALUE rb_ec_str_resurrect(struct rb_execution_context_struct *ec, VALUE str);
|
|
MJIT_SYMBOL_EXPORT_END
|
|
|
|
#define rb_fstring_lit(str) rb_fstring_new((str), rb_strlen_lit(str))
|
|
#define rb_fstring_literal(str) rb_fstring_lit(str)
|
|
#define rb_fstring_enc_lit(str, enc) rb_fstring_enc_new((str), rb_strlen_lit(str), (enc))
|
|
#define rb_fstring_enc_literal(str, enc) rb_fstring_enc_lit(str, enc)
|
|
|
|
static inline VALUE
|
|
QUOTE(VALUE v)
|
|
{
|
|
return rb_str_quote_unprintable(v);
|
|
}
|
|
|
|
static inline VALUE
|
|
QUOTE_ID(ID i)
|
|
{
|
|
return rb_id_quote_unprintable(i);
|
|
}
|
|
|
|
static inline bool
|
|
STR_EMBED_P(VALUE str)
|
|
{
|
|
return ! FL_TEST_RAW(str, STR_NOEMBED);
|
|
}
|
|
|
|
static inline bool
|
|
STR_SHARED_P(VALUE str)
|
|
{
|
|
return FL_ALL_RAW(str, STR_NOEMBED | STR_SHARED);
|
|
}
|
|
|
|
static inline bool
|
|
is_ascii_string(VALUE str)
|
|
{
|
|
return rb_enc_str_coderange(str) == ENC_CODERANGE_7BIT;
|
|
}
|
|
|
|
static inline bool
|
|
is_broken_string(VALUE str)
|
|
{
|
|
return rb_enc_str_coderange(str) == ENC_CODERANGE_BROKEN;
|
|
}
|
|
|
|
/* expect tail call optimization */
|
|
// YJIT needs this function to never allocate and never raise
|
|
static inline VALUE
|
|
rb_str_eql_internal(const VALUE str1, const VALUE str2)
|
|
{
|
|
const long len = RSTRING_LEN(str1);
|
|
const char *ptr1, *ptr2;
|
|
|
|
if (len != RSTRING_LEN(str2)) return Qfalse;
|
|
if (!rb_str_comparable(str1, str2)) return Qfalse;
|
|
if ((ptr1 = RSTRING_PTR(str1)) == (ptr2 = RSTRING_PTR(str2)))
|
|
return Qtrue;
|
|
if (memcmp(ptr1, ptr2, len) == 0)
|
|
return Qtrue;
|
|
return Qfalse;
|
|
}
|
|
|
|
#if __has_builtin(__builtin_constant_p)
|
|
# define rb_fstring_cstr(str) \
|
|
(__builtin_constant_p(str) ? \
|
|
rb_fstring_new((str), (long)strlen(str)) : \
|
|
(rb_fstring_cstr)(str))
|
|
#endif
|
|
#endif /* INTERNAL_STRING_H */
|