12 #ifndef RUBY_ENCODING_H
13 #define RUBY_ENCODING_H 1
15 #if defined(__cplusplus)
25 #if defined __GNUC__ && __GNUC__ >= 4
26 #pragma GCC visibility push(default)
29 #define ENCODING_INLINE_MAX 1023
30 #define ENCODING_SHIFT (FL_USHIFT+10)
31 #define ENCODING_MASK (((VALUE)ENCODING_INLINE_MAX)<<ENCODING_SHIFT)
33 #define ENCODING_SET_INLINED(obj,i) do {\
34 RBASIC(obj)->flags &= ~ENCODING_MASK;\
35 RBASIC(obj)->flags |= (VALUE)(i) << ENCODING_SHIFT;\
37 #define ENCODING_SET(obj,i) do {\
38 VALUE rb_encoding_set_obj = (obj); \
39 int encoding_set_enc_index = (i); \
40 if (encoding_set_enc_index < ENCODING_INLINE_MAX) \
41 ENCODING_SET_INLINED(rb_encoding_set_obj, encoding_set_enc_index); \
43 rb_enc_set_index(rb_encoding_set_obj, encoding_set_enc_index); \
46 #define ENCODING_GET_INLINED(obj) (int)((RBASIC(obj)->flags & ENCODING_MASK)>>ENCODING_SHIFT)
47 #define ENCODING_GET(obj) \
48 (ENCODING_GET_INLINED(obj) != ENCODING_INLINE_MAX ? \
49 ENCODING_GET_INLINED(obj) : \
50 rb_enc_get_index(obj))
52 #define ENCODING_IS_ASCII8BIT(obj) (ENCODING_GET_INLINED(obj) == 0)
54 #define ENCODING_MAXNAMELEN 42
56 #define ENC_CODERANGE_MASK ((int)(FL_USER8|FL_USER9))
57 #define ENC_CODERANGE_UNKNOWN 0
58 #define ENC_CODERANGE_7BIT ((int)FL_USER8)
59 #define ENC_CODERANGE_VALID ((int)FL_USER9)
60 #define ENC_CODERANGE_BROKEN ((int)(FL_USER8|FL_USER9))
61 #define ENC_CODERANGE(obj) ((int)RBASIC(obj)->flags & ENC_CODERANGE_MASK)
62 #define ENC_CODERANGE_ASCIIONLY(obj) (ENC_CODERANGE(obj) == ENC_CODERANGE_7BIT)
63 #define ENC_CODERANGE_SET(obj,cr) (RBASIC(obj)->flags = \
64 (RBASIC(obj)->flags & ~ENC_CODERANGE_MASK) | (cr))
65 #define ENC_CODERANGE_CLEAR(obj) ENC_CODERANGE_SET((obj),0)
68 #define ENC_CODERANGE_AND(a, b) \
69 ((a) == ENC_CODERANGE_7BIT ? (b) : \
70 (a) == ENC_CODERANGE_VALID ? ((b) == ENC_CODERANGE_7BIT ? ENC_CODERANGE_VALID : (b)) : \
71 ENC_CODERANGE_UNKNOWN)
73 #define ENCODING_CODERANGE_SET(obj, encindex, cr) \
75 VALUE rb_encoding_coderange_obj = (obj); \
76 ENCODING_SET(rb_encoding_coderange_obj, (encindex)); \
77 ENC_CODERANGE_SET(rb_encoding_coderange_obj, (cr)); \
86 #define rb_enc_to_index(enc) ((enc) ? ENC_TO_ENCINDEX(enc) : 0)
124 #define rb_enc_name(enc) (enc)->name
127 #define rb_enc_mbminlen(enc) (enc)->min_enc_len
128 #define rb_enc_mbmaxlen(enc) (enc)->max_enc_len
138 #define MBCLEN_CHARFOUND_P(ret) ONIGENC_MBCLEN_CHARFOUND_P(ret)
139 #define MBCLEN_CHARFOUND_LEN(ret) ONIGENC_MBCLEN_CHARFOUND_LEN(ret)
140 #define MBCLEN_INVALID_P(ret) ONIGENC_MBCLEN_INVALID_P(ret)
141 #define MBCLEN_NEEDMORE_P(ret) ONIGENC_MBCLEN_NEEDMORE_P(ret)
142 #define MBCLEN_NEEDMORE_LEN(ret) ONIGENC_MBCLEN_NEEDMORE_LEN(ret)
154 #define rb_enc_codepoint(p,e,enc) rb_enc_codepoint_len((p),(e),0,(enc))
155 #define rb_enc_mbc_to_codepoint(p, e, enc) ONIGENC_MBC_TO_CODE((enc),(UChar*)(p),(UChar*)(e))
161 #define rb_enc_mbcput(c,buf,enc) ONIGENC_CODE_TO_MBC((enc),(c),(UChar*)(buf))
164 #define rb_enc_prev_char(s,p,e,enc) ((char *)onigenc_get_prev_char_head((enc),(UChar*)(s),(UChar*)(p),(UChar*)(e)))
166 #define rb_enc_left_char_head(s,p,e,enc) ((char *)onigenc_get_left_adjust_char_head((enc),(UChar*)(s),(UChar*)(p),(UChar*)(e)))
167 #define rb_enc_right_char_head(s,p,e,enc) ((char *)onigenc_get_right_adjust_char_head((enc),(UChar*)(s),(UChar*)(p),(UChar*)(e)))
168 #define rb_enc_step_back(s,p,e,n,enc) ((char *)onigenc_step_back((enc),(UChar*)(s),(UChar*)(p),(UChar*)(e),(int)(n)))
171 #define rb_enc_is_newline(p,end,enc) ONIGENC_IS_MBC_NEWLINE((enc),(UChar*)(p),(UChar*)(end))
173 #define rb_enc_isctype(c,t,enc) ONIGENC_IS_CODE_CTYPE((enc),(c),(t))
174 #define rb_enc_isascii(c,enc) ONIGENC_IS_CODE_ASCII(c)
175 #define rb_enc_isalpha(c,enc) ONIGENC_IS_CODE_ALPHA((enc),(c))
176 #define rb_enc_islower(c,enc) ONIGENC_IS_CODE_LOWER((enc),(c))
177 #define rb_enc_isupper(c,enc) ONIGENC_IS_CODE_UPPER((enc),(c))
178 #define rb_enc_ispunct(c,enc) ONIGENC_IS_CODE_PUNCT((enc),(c))
179 #define rb_enc_isalnum(c,enc) ONIGENC_IS_CODE_ALNUM((enc),(c))
180 #define rb_enc_isprint(c,enc) ONIGENC_IS_CODE_PRINT((enc),(c))
181 #define rb_enc_isspace(c,enc) ONIGENC_IS_CODE_SPACE((enc),(c))
182 #define rb_enc_isdigit(c,enc) ONIGENC_IS_CODE_DIGIT((enc),(c))
184 #define rb_enc_asciicompat(enc) (rb_enc_mbminlen(enc)==1 && !rb_enc_dummy_p(enc))
196 #define rb_enc_str_asciicompat_p(str) rb_enc_asciicompat(rb_enc_get(str))
226 #define ENC_DUMMY_FLAG (1<<24)
227 #define ENC_INDEX_MASK (~(~0U<<24))
229 #define ENC_TO_ENCINDEX(enc) (int)((enc)->ruby_encoding_index & ENC_INDEX_MASK)
231 #define ENC_DUMMY_P(enc) ((enc)->ruby_encoding_index & ENC_DUMMY_FLAG)
232 #define ENC_SET_DUMMY(enc) ((enc)->ruby_encoding_index |= ENC_DUMMY_FLAG)
264 const unsigned char **source_buffer_ptr,
const unsigned char *source_buffer_end,
265 unsigned char **destination_buffer_ptr,
unsigned char *destination_buffer_end,
280 const unsigned char *str,
size_t len,
const char *str_encoding);
307 #define ECONV_ERROR_HANDLER_MASK 0x000000ff
309 #define ECONV_INVALID_MASK 0x0000000f
310 #define ECONV_INVALID_REPLACE 0x00000002
312 #define ECONV_UNDEF_MASK 0x000000f0
313 #define ECONV_UNDEF_REPLACE 0x00000020
314 #define ECONV_UNDEF_HEX_CHARREF 0x00000030
316 #define ECONV_DECORATOR_MASK 0x0000ff00
317 #define ECONV_NEWLINE_DECORATOR_MASK 0x00003f00
318 #define ECONV_NEWLINE_DECORATOR_READ_MASK 0x00000f00
319 #define ECONV_NEWLINE_DECORATOR_WRITE_MASK 0x00003000
321 #define ECONV_UNIVERSAL_NEWLINE_DECORATOR 0x00000100
322 #define ECONV_CRLF_NEWLINE_DECORATOR 0x00001000
323 #define ECONV_CR_NEWLINE_DECORATOR 0x00002000
324 #define ECONV_XML_TEXT_DECORATOR 0x00004000
325 #define ECONV_XML_ATTR_CONTENT_DECORATOR 0x00008000
327 #define ECONV_STATEFUL_DECORATOR_MASK 0x00f00000
328 #define ECONV_XML_ATTR_QUOTE_DECORATOR 0x00100000
330 #if defined(RUBY_TEST_CRLF_ENVIRONMENT) || defined(_WIN32)
331 #define ECONV_DEFAULT_NEWLINE_DECORATOR ECONV_CRLF_NEWLINE_DECORATOR
333 #define ECONV_DEFAULT_NEWLINE_DECORATOR 0
339 #define ECONV_PARTIAL_INPUT 0x00010000
340 #define ECONV_AFTER_OUTPUT 0x00020000
343 #if defined __GNUC__ && __GNUC__ >= 4
344 #pragma GCC visibility pop
347 #if defined(__cplusplus)
int rb_enc_replicate(const char *, rb_encoding *)
VALUE rb_econv_open_exc(const char *senc, const char *denc, int ecflags)
const char * rb_econv_asciicompat_encoding(const char *encname)
int rb_econv_set_replacement(rb_econv_t *ec, const unsigned char *str, size_t len, const char *encname)
RUBY_EXTERN VALUE rb_cEncoding
long rb_str_coderange_scan_restartable(const char *, const char *, rb_encoding *, int *)
int rb_enc_casefold(char *to, const char *p, const char *e, rb_encoding *enc)
rb_econv_t * rb_econv_open(const char *source_encoding, const char *destination_encoding, int ecflags)
OnigEncodingType rb_encoding
int rb_econv_decorate_at_last(rb_econv_t *ec, const char *decorator_name)
VALUE rb_econv_substr_convert(rb_econv_t *ec, VALUE src, long byteoff, long bytesize, int flags)
rb_encoding * rb_find_encoding(VALUE)
int rb_utf8_encindex(void)
ID rb_check_id_cstr(const char *ptr, long len, rb_encoding *enc)
VALUE rb_external_str_new_with_enc(const char *ptr, long len, rb_encoding *)
int rb_econv_prepare_opts(VALUE opthash, VALUE *ecopts)
void rb_econv_close(rb_econv_t *ec)
rb_encoding * rb_enc_from_index(int idx)
int rb_enc_symname2_p(const char *, long, rb_encoding *)
long rb_memsearch(const void *, long, const void *, long, rb_encoding *)
char * rb_enc_path_skip_prefix(const char *, const char *, rb_encoding *)
VALUE rb_locale_charmap(VALUE klass)
int rb_enc_tolower(int c, rb_encoding *enc)
int rb_enc_str_coderange(VALUE)
int rb_enc_codelen(int code, rb_encoding *enc)
rb_encoding * rb_enc_get(VALUE)
rb_encoding * rb_utf8_encoding(void)
VALUE rb_obj_encoding(VALUE)
ID rb_interned_id_p(const char *, long, rb_encoding *)
VALUE rb_enc_vsprintf(rb_encoding *, const char *, va_list)
void rb_enc_copy(VALUE dst, VALUE src)
void rb_enc_set_default_internal(VALUE encoding)
int rb_define_dummy_encoding(const char *)
void rb_enc_set_index(VALUE obj, int encindex)
int rb_econv_decorate_at_first(rb_econv_t *ec, const char *decorator_name)
VALUE rb_str_conv_enc_opts(VALUE str, rb_encoding *from, rb_encoding *to, int ecflags, VALUE ecopts)
int rb_enc_symname_p(const char *, rb_encoding *)
VALUE rb_enc_sprintf(rb_encoding *enc, const char *format,...)
char * rb_enc_nth(const char *, const char *, long, rb_encoding *)
ID rb_intern3(const char *, long, rb_encoding *)
VALUE rb_econv_str_append(rb_econv_t *ec, VALUE src, VALUE dst, int flags)
VALUE rb_econv_make_exception(rb_econv_t *ec)
void rb_econv_check_error(rb_econv_t *ec)
int rb_econv_insert_output(rb_econv_t *ec, const unsigned char *str, size_t len, const char *str_encoding)
VALUE rb_enc_associate_index(VALUE, int)
int rb_enc_find_index(const char *name)
const char * destination_encoding
rb_encoding * rb_default_external_encoding(void)
rb_encoding * rb_to_encoding(VALUE)
rb_econv_t * rb_econv_open_opts(const char *source_encoding, const char *destination_encoding, int ecflags, VALUE ecopts)
int rb_econv_has_convpath_p(const char *from_encoding, const char *to_encoding)
int rb_locale_encindex(void)
rb_encoding * rb_enc_find(const char *name)
VALUE rb_str_conv_enc(VALUE str, rb_encoding *from, rb_encoding *to)
int rb_ascii8bit_encindex(void)
int rb_enc_ascget(const char *p, const char *e, int *len, rb_encoding *enc)
char * rb_enc_path_next(const char *, const char *, rb_encoding *)
void rb_enc_raise(rb_encoding *enc, VALUE exc, const char *fmt,...)
#define rb_enc_codepoint(p, e, enc)
int rb_enc_mbclen(const char *p, const char *e, rb_encoding *enc)
rb_encoding * rb_usascii_encoding(void)
VALUE rb_enc_default_external(void)
const char * source_encoding
VALUE rb_enc_uint_chr(unsigned int code, rb_encoding *enc)
int rb_enc_precise_mbclen(const char *p, const char *e, rb_encoding *enc)
int rb_enc_unicode_p(rb_encoding *enc)
char * rb_enc_path_end(const char *, const char *, rb_encoding *)
VALUE rb_enc_associate(VALUE, rb_encoding *)
VALUE rb_econv_substr_append(rb_econv_t *ec, VALUE src, long byteoff, long bytesize, VALUE dst, int flags)
static int rb_enc_dummy_p(rb_encoding *enc)
rb_encoding * rb_enc_compatible(VALUE, VALUE)
VALUE rb_enc_from_encoding(rb_encoding *enc)
int rb_char_to_option_kcode(int c, int *option, int *kcode)
int rb_econv_putbackable(rb_econv_t *ec)
int rb_enc_get_index(VALUE obj)
unsigned int rb_enc_codepoint_len(const char *p, const char *e, int *len, rb_encoding *enc)
int rb_enc_fast_mbclen(const char *p, const char *e, rb_encoding *enc)
long rb_enc_strlen(const char *, const char *, rb_encoding *)
rb_econv_result_t rb_econv_convert(rb_econv_t *ec, const unsigned char **source_buffer_ptr, const unsigned char *source_buffer_end, unsigned char **destination_buffer_ptr, unsigned char *destination_buffer_end, int flags)
rb_encoding * rb_filesystem_encoding(void)
char * rb_enc_path_last_separator(const char *, const char *, rb_encoding *)
rb_encoding * rb_locale_encoding(void)
int rb_filesystem_encindex(void)
VALUE rb_enc_default_internal(void)
VALUE rb_str_export_to_enc(VALUE, rb_encoding *)
PRINTF_ARGS(VALUE rb_enc_sprintf(rb_encoding *, const char *,...), 2, 3)
int rb_enc_toupper(int c, rb_encoding *enc)
rb_encoding * rb_ascii8bit_encoding(void)
VALUE rb_enc_str_new(const char *, long, rb_encoding *)
rb_encoding * rb_default_internal_encoding(void)
const char * ruby_enc_find_extname(const char *name, long *len, rb_encoding *enc)
int rb_usascii_encindex(void)
int rb_to_encoding_index(VALUE)
const char * rb_econv_encoding_to_insert_output(rb_econv_t *ec)
VALUE rb_str_encode(VALUE str, VALUE to, int ecflags, VALUE ecopts)
void rb_enc_set_default_external(VALUE encoding)
int rb_enc_str_asciionly_p(VALUE)
const char * ruby_enc_find_basename(const char *name, long *baselen, long *alllen, rb_encoding *enc)
VALUE rb_enc_reg_new(const char *, long, rb_encoding *, int)
int rb_econv_prepare_options(VALUE opthash, VALUE *ecopts, int ecflags)
void rb_econv_binmode(rb_econv_t *ec)
void rb_econv_putback(rb_econv_t *ec, unsigned char *p, int n)
VALUE rb_econv_str_convert(rb_econv_t *ec, VALUE src, int flags)
VALUE rb_enc_str_buf_cat(VALUE str, const char *ptr, long len, rb_encoding *enc)
rb_encoding * rb_enc_check(VALUE, VALUE)