mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
534277fa7b
https://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html says: > GCC never returns 1 when you call the inline function with a string > constant or ... Because rb_str_new and familiy take string constants, it was a bad idea for them to contain RB_CONSTANT_P. We should instead do so in corresponding macros. [ruby-core:98212]
290 lines
9.8 KiB
C++
290 lines
9.8 KiB
C++
#ifndef RBIMPL_INTERN_STRING_H /*-*-C++-*-vi:se ft=cpp:*/
|
|
#define RBIMPL_INTERN_STRING_H
|
|
/**
|
|
* @file
|
|
* @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.
|
|
* @warning Symbols prefixed with either `RBIMPL` or `rbimpl` are
|
|
* implementation details. Don't take them as canon. They could
|
|
* rapidly appear then vanish. The name (path) of this header file
|
|
* is also an implementation detail. Do not expect it to persist
|
|
* at the place it is now. Developers are free to move it anywhere
|
|
* anytime at will.
|
|
* @note To ruby-core: remember that this header can be possibly
|
|
* recursively included from extension libraries written in C++.
|
|
* Do not expect for instance `__VA_ARGS__` is always available.
|
|
* We assume C99 for ruby itself but we don't assume languages of
|
|
* extension libraries. They could be written in C++98.
|
|
* @brief Public APIs related to ::rb_cString.
|
|
*/
|
|
#include "ruby/internal/config.h"
|
|
|
|
#ifdef STDC_HEADERS
|
|
# include <stddef.h>
|
|
#endif
|
|
|
|
#ifdef HAVE_STRING_H
|
|
# include <string.h>
|
|
#endif
|
|
|
|
#ifdef HAVE_STDINT_H
|
|
# include <stdint.h>
|
|
#endif
|
|
|
|
#include "ruby/internal/attr/nonnull.h"
|
|
#include "ruby/internal/attr/pure.h"
|
|
#include "ruby/internal/constant_p.h"
|
|
#include "ruby/internal/dllexport.h"
|
|
#include "ruby/internal/value.h"
|
|
#include "ruby/internal/variable.h" /* rb_gvar_setter_t */
|
|
#include "ruby/st.h" /* st_index_t */
|
|
|
|
RBIMPL_SYMBOL_EXPORT_BEGIN()
|
|
|
|
/* string.c */
|
|
VALUE rb_str_new(const char*, long);
|
|
VALUE rb_str_new_cstr(const char*);
|
|
VALUE rb_str_new_shared(VALUE);
|
|
VALUE rb_str_new_frozen(VALUE);
|
|
VALUE rb_str_new_with_class(VALUE, const char*, long);
|
|
VALUE rb_tainted_str_new_cstr(const char*);
|
|
VALUE rb_tainted_str_new(const char*, long);
|
|
VALUE rb_external_str_new(const char*, long);
|
|
VALUE rb_external_str_new_cstr(const char*);
|
|
VALUE rb_locale_str_new(const char*, long);
|
|
VALUE rb_locale_str_new_cstr(const char*);
|
|
VALUE rb_filesystem_str_new(const char*, long);
|
|
VALUE rb_filesystem_str_new_cstr(const char*);
|
|
VALUE rb_str_buf_new(long);
|
|
VALUE rb_str_buf_new_cstr(const char*);
|
|
VALUE rb_str_buf_new2(const char*);
|
|
VALUE rb_str_tmp_new(long);
|
|
VALUE rb_usascii_str_new(const char*, long);
|
|
VALUE rb_usascii_str_new_cstr(const char*);
|
|
VALUE rb_utf8_str_new(const char*, long);
|
|
VALUE rb_utf8_str_new_cstr(const char*);
|
|
VALUE rb_str_new_static(const char *, long);
|
|
VALUE rb_usascii_str_new_static(const char *, long);
|
|
VALUE rb_utf8_str_new_static(const char *, long);
|
|
void rb_str_free(VALUE);
|
|
void rb_str_shared_replace(VALUE, VALUE);
|
|
VALUE rb_str_buf_append(VALUE, VALUE);
|
|
VALUE rb_str_buf_cat(VALUE, const char*, long);
|
|
VALUE rb_str_buf_cat2(VALUE, const char*);
|
|
VALUE rb_str_buf_cat_ascii(VALUE, const char*);
|
|
VALUE rb_obj_as_string(VALUE);
|
|
VALUE rb_check_string_type(VALUE);
|
|
void rb_must_asciicompat(VALUE);
|
|
VALUE rb_str_dup(VALUE);
|
|
VALUE rb_str_resurrect(VALUE str);
|
|
VALUE rb_str_locktmp(VALUE);
|
|
VALUE rb_str_unlocktmp(VALUE);
|
|
VALUE rb_str_dup_frozen(VALUE);
|
|
#define rb_str_dup_frozen rb_str_new_frozen
|
|
VALUE rb_str_plus(VALUE, VALUE);
|
|
VALUE rb_str_times(VALUE, VALUE);
|
|
long rb_str_sublen(VALUE, long);
|
|
VALUE rb_str_substr(VALUE, long, long);
|
|
VALUE rb_str_subseq(VALUE, long, long);
|
|
char *rb_str_subpos(VALUE, long, long*);
|
|
void rb_str_modify(VALUE);
|
|
void rb_str_modify_expand(VALUE, long);
|
|
VALUE rb_str_freeze(VALUE);
|
|
void rb_str_set_len(VALUE, long);
|
|
VALUE rb_str_resize(VALUE, long);
|
|
VALUE rb_str_cat(VALUE, const char*, long);
|
|
VALUE rb_str_cat_cstr(VALUE, const char*);
|
|
VALUE rb_str_cat2(VALUE, const char*);
|
|
VALUE rb_str_append(VALUE, VALUE);
|
|
VALUE rb_str_concat(VALUE, VALUE);
|
|
st_index_t rb_memhash(const void *ptr, long len);
|
|
st_index_t rb_hash_start(st_index_t);
|
|
st_index_t rb_hash_uint32(st_index_t, uint32_t);
|
|
st_index_t rb_hash_uint(st_index_t, st_index_t);
|
|
st_index_t rb_hash_end(st_index_t);
|
|
#define rb_hash_uint32(h, i) st_hash_uint32((h), (i))
|
|
#define rb_hash_uint(h, i) st_hash_uint((h), (i))
|
|
#define rb_hash_end(h) st_hash_end(h)
|
|
st_index_t rb_str_hash(VALUE);
|
|
int rb_str_hash_cmp(VALUE,VALUE);
|
|
int rb_str_comparable(VALUE, VALUE);
|
|
int rb_str_cmp(VALUE, VALUE);
|
|
VALUE rb_str_equal(VALUE str1, VALUE str2);
|
|
VALUE rb_str_drop_bytes(VALUE, long);
|
|
void rb_str_update(VALUE, long, long, VALUE);
|
|
VALUE rb_str_replace(VALUE, VALUE);
|
|
VALUE rb_str_inspect(VALUE);
|
|
VALUE rb_str_dump(VALUE);
|
|
VALUE rb_str_split(VALUE, const char*);
|
|
rb_gvar_setter_t rb_str_setter;
|
|
VALUE rb_str_intern(VALUE);
|
|
VALUE rb_sym_to_s(VALUE);
|
|
long rb_str_strlen(VALUE);
|
|
VALUE rb_str_length(VALUE);
|
|
long rb_str_offset(VALUE, long);
|
|
RBIMPL_ATTR_PURE()
|
|
size_t rb_str_capacity(VALUE);
|
|
VALUE rb_str_ellipsize(VALUE, long);
|
|
VALUE rb_str_scrub(VALUE, VALUE);
|
|
VALUE rb_str_succ(VALUE);
|
|
|
|
RBIMPL_ATTR_NONNULL(())
|
|
static inline long
|
|
rbimpl_strlen(const char *str)
|
|
{
|
|
return RBIMPL_CAST((long)strlen(str));
|
|
}
|
|
|
|
static inline VALUE
|
|
rbimpl_str_new_cstr(const char *str)
|
|
{
|
|
long len = rbimpl_strlen(str);
|
|
return rb_str_new_static(str, len);
|
|
}
|
|
|
|
static inline VALUE
|
|
rbimpl_tainted_str_new_cstr(const char *str)
|
|
{
|
|
long len = rbimpl_strlen(str);
|
|
return rb_tainted_str_new(str, len);
|
|
}
|
|
|
|
static inline VALUE
|
|
rbimpl_usascii_str_new_cstr(const char *str)
|
|
{
|
|
long len = rbimpl_strlen(str);
|
|
return rb_usascii_str_new_static(str, len);
|
|
}
|
|
|
|
static inline VALUE
|
|
rbimpl_utf8_str_new_cstr(const char *str)
|
|
{
|
|
long len = rbimpl_strlen(str);
|
|
return rb_utf8_str_new_static(str, len);
|
|
}
|
|
|
|
static inline VALUE
|
|
rbimpl_external_str_new_cstr(const char *str)
|
|
{
|
|
long len = rbimpl_strlen(str);
|
|
return rb_external_str_new(str, len);
|
|
}
|
|
|
|
static inline VALUE
|
|
rbimpl_locale_str_new_cstr(const char *str)
|
|
{
|
|
long len = rbimpl_strlen(str);
|
|
return rb_locale_str_new(str, len);
|
|
}
|
|
|
|
static inline VALUE
|
|
rbimpl_str_buf_new_cstr(const char *str)
|
|
{
|
|
long len = rbimpl_strlen(str);
|
|
VALUE buf = rb_str_buf_new(len);
|
|
return rb_str_buf_cat(buf, str, len);
|
|
}
|
|
|
|
static inline VALUE
|
|
rbimpl_str_cat_cstr(VALUE buf, const char *str)
|
|
{
|
|
long len = rbimpl_strlen(str);
|
|
return rb_str_cat(buf, str, len);
|
|
}
|
|
|
|
static inline VALUE
|
|
rbimpl_exc_new_cstr(VALUE exc, const char *str)
|
|
{
|
|
long len = rbimpl_strlen(str);
|
|
return rb_exc_new(exc, str, len);
|
|
}
|
|
|
|
#define rb_str_new(str, len) \
|
|
((RBIMPL_CONSTANT_P(str) && \
|
|
RBIMPL_CONSTANT_P(len) ? \
|
|
rb_str_new_static : \
|
|
rb_str_new) ((str), (len)))
|
|
|
|
#define rb_str_new_cstr(str) \
|
|
((RBIMPL_CONSTANT_P(str) ? \
|
|
rbimpl_str_new_cstr : \
|
|
rb_str_new_cstr) (str))
|
|
|
|
#define rb_usascii_str_new(str, len) \
|
|
((RBIMPL_CONSTANT_P(str) && \
|
|
RBIMPL_CONSTANT_P(len) ? \
|
|
rb_usascii_str_new_static : \
|
|
rb_usascii_str_new) ((str), (len)))
|
|
|
|
#define rb_utf8_str_new(str, len) \
|
|
((RBIMPL_CONSTANT_P(str) && \
|
|
RBIMPL_CONSTANT_P(len) ? \
|
|
rb_utf8_str_new_static : \
|
|
rb_utf8_str_new) ((str), (len)))
|
|
|
|
#define rb_tainted_str_new_cstr(str) \
|
|
((RBIMPL_CONSTANT_P(str) ? \
|
|
rbimpl_tainted_str_new_cstr : \
|
|
rb_tainted_str_new_cstr) (str))
|
|
|
|
#define rb_usascii_str_new_cstr(str) \
|
|
((RBIMPL_CONSTANT_P(str) ? \
|
|
rbimpl_usascii_str_new_cstr : \
|
|
rb_usascii_str_new_cstr) (str))
|
|
|
|
#define rb_utf8_str_new_cstr(str) \
|
|
((RBIMPL_CONSTANT_P(str) ? \
|
|
rbimpl_utf8_str_new_cstr : \
|
|
rb_utf8_str_new_cstr) (str))
|
|
|
|
#define rb_external_str_new_cstr(str) \
|
|
((RBIMPL_CONSTANT_P(str) ? \
|
|
rbimpl_external_str_new_cstr : \
|
|
rb_external_str_new_cstr) (str))
|
|
|
|
#define rb_locale_str_new_cstr(str) \
|
|
((RBIMPL_CONSTANT_P(str) ? \
|
|
rbimpl_locale_str_new_cstr : \
|
|
rb_locale_str_new_cstr) (str))
|
|
|
|
#define rb_str_buf_new_cstr(str) \
|
|
((RBIMPL_CONSTANT_P(str) ? \
|
|
rbimpl_str_buf_new_cstr : \
|
|
rb_str_buf_new_cstr) (str))
|
|
|
|
#define rb_str_cat_cstr(buf, str) \
|
|
((RBIMPL_CONSTANT_P(str) ? \
|
|
rbimpl_str_cat_cstr : \
|
|
rb_str_cat_cstr) ((buf), (str)))
|
|
|
|
#define rb_exc_new_cstr(exc, str) \
|
|
((RBIMPL_CONSTANT_P(str) ? \
|
|
rbimpl_exc_new_cstr : \
|
|
rb_exc_new_cstr) ((exc), (str)))
|
|
|
|
#define rb_str_new2 rb_str_new_cstr
|
|
#define rb_str_new3 rb_str_new_shared
|
|
#define rb_str_new4 rb_str_new_frozen
|
|
#define rb_str_new5 rb_str_new_with_class
|
|
#define rb_tainted_str_new2 rb_tainted_str_new_cstr
|
|
#define rb_str_buf_new2 rb_str_buf_new_cstr
|
|
#define rb_usascii_str_new2 rb_usascii_str_new_cstr
|
|
#define rb_str_buf_cat rb_str_cat
|
|
#define rb_str_buf_cat2 rb_str_cat_cstr
|
|
#define rb_str_cat2 rb_str_cat_cstr
|
|
#define rb_strlen_lit(str) (sizeof(str "") - 1)
|
|
#define rb_str_new_lit(str) rb_str_new_static((str), rb_strlen_lit(str))
|
|
#define rb_usascii_str_new_lit(str) rb_usascii_str_new_static((str), rb_strlen_lit(str))
|
|
#define rb_utf8_str_new_lit(str) rb_utf8_str_new_static((str), rb_strlen_lit(str))
|
|
#define rb_enc_str_new_lit(str, enc) rb_enc_str_new_static((str), rb_strlen_lit(str), (enc))
|
|
#define rb_str_new_literal(str) rb_str_new_lit(str)
|
|
#define rb_usascii_str_new_literal(str) rb_usascii_str_new_lit(str)
|
|
#define rb_utf8_str_new_literal(str) rb_utf8_str_new_lit(str)
|
|
#define rb_enc_str_new_literal(str, enc) rb_enc_str_new_lit(str, enc)
|
|
|
|
RBIMPL_SYMBOL_EXPORT_END()
|
|
|
|
#endif /* RBIMPL_INTERN_STRING_H */
|