Ruby: include/ruby/internal/encoding/encoding.h Source File

Ruby 3.2.5p208 (2024-07-26 revision 31d0f1a2e7dbfb60731d1f05b868e1d578cda493)

encoding.h
Go to the documentation of this file.
1#ifndef RUBY_INTERNAL_ENCODING_ENCODING_H /*-*-C++-*-vi:se ft=cpp:*/
2#define RUBY_INTERNAL_ENCODING_ENCODING_H
24#include "ruby/oniguruma.h"
25#include "ruby/internal/attr/const.h"
26#include "ruby/internal/attr/deprecated.h"
27#include "ruby/internal/attr/noalias.h"
28#include "ruby/internal/attr/pure.h"
29#include "ruby/internal/attr/returns_nonnull.h"
30#include "ruby/internal/dllexport.h"
31#include "ruby/internal/value.h"
32#include "ruby/internal/core/rbasic.h"
33#include "ruby/internal/fl_type.h"
34
35 RBIMPL_SYMBOL_EXPORT_BEGIN()
36
37
42 RUBY_EXTERN VALUE rb_cEncoding;
43
50enum ruby_encoding_consts {
51
53 RUBY_ENCODING_INLINE_MAX = 127,
54
56 RUBY_ENCODING_SHIFT = (RUBY_FL_USHIFT+10),
57
59 RUBY_ENCODING_MASK = (RUBY_ENCODING_INLINE_MAX<<RUBY_ENCODING_SHIFT
60 /* RUBY_FL_USER10..RUBY_FL_USER16 */),
61
63 RUBY_ENCODING_MAXNAMELEN = 42
64};
65
66#define ENCODING_INLINE_MAX RUBY_ENCODING_INLINE_MAX
67#define ENCODING_SHIFT RUBY_ENCODING_SHIFT
68#define ENCODING_MASK RUBY_ENCODING_MASK
79static inline void
80RB_ENCODING_SET_INLINED(VALUE obj, int encindex)
81{
82 VALUE f = /* upcast */ encindex;
83
84 f <<= RUBY_ENCODING_SHIFT;
85 RB_FL_UNSET_RAW(obj, RUBY_ENCODING_MASK);
86 RB_FL_SET_RAW(obj, f);
87}
88
97static inline int
98RB_ENCODING_GET_INLINED(VALUE obj)
99{
100 VALUE ret = RB_FL_TEST_RAW(obj, RUBY_ENCODING_MASK) >> RUBY_ENCODING_SHIFT;
101
102 return RBIMPL_CAST((int)ret);
103}
104
105#define ENCODING_SET_INLINED(obj,i) RB_ENCODING_SET_INLINED(obj,i)
106#define ENCODING_SET(obj,i) RB_ENCODING_SET(obj,i)
107#define ENCODING_GET_INLINED(obj) RB_ENCODING_GET_INLINED(obj)
108#define ENCODING_GET(obj) RB_ENCODING_GET(obj)
109#define ENCODING_IS_ASCII8BIT(obj) RB_ENCODING_IS_ASCII8BIT(obj)
110#define ENCODING_MAXNAMELEN RUBY_ENCODING_MAXNAMELEN
116 typedef const OnigEncodingType rb_encoding;
117
118 RBIMPL_ATTR_NOALIAS()
139int rb_char_to_option_kcode(int c, int *option, int *kcode);
140
156int rb_enc_replicate(const char *name, rb_encoding *src);
157
169int rb_define_dummy_encoding(const char *name);
170
171 RBIMPL_ATTR_PURE()
179int rb_enc_dummy_p(rb_encoding *enc);
180
181 RBIMPL_ATTR_PURE()
191int rb_enc_to_index(rb_encoding *enc);
192
200int rb_enc_get_index(VALUE obj);
201
210static inline int
211RB_ENCODING_GET(VALUE obj)
212{
213 int encindex = RB_ENCODING_GET_INLINED(obj);
214
215 if (encindex == RUBY_ENCODING_INLINE_MAX) {
216 return rb_enc_get_index(obj);
217 }
218 else {
219 return encindex;
220 }
221}
222
233void rb_enc_set_index(VALUE obj, int encindex);
234
236static inline void
237RB_ENCODING_SET(VALUE obj, int encindex)
238{
239 rb_enc_set_index(obj, encindex);
240}
241
253static inline void
254RB_ENCODING_CODERANGE_SET(VALUE obj, int encindex, enum ruby_coderange_type cr)
255{
256 RB_ENCODING_SET(obj, encindex);
257 RB_ENC_CODERANGE_SET(obj, cr);
258}
259
260 RBIMPL_ATTR_PURE()
268int rb_enc_capable(VALUE obj);
269
278int rb_enc_find_index(const char *name);
279
293int rb_enc_alias(const char *alias, const char *orig);
294
303int rb_to_encoding_index(VALUE obj);
304
314 rb_encoding *rb_to_encoding(VALUE obj);
315
324 rb_encoding *rb_find_encoding(VALUE obj);
325
333 rb_encoding *rb_enc_get(VALUE obj);
334
347 rb_encoding *rb_enc_compatible(VALUE str1, VALUE str2);
348
359 rb_encoding *rb_enc_check(VALUE str1,VALUE str2);
360
375 VALUE rb_enc_associate_index(VALUE obj, int encindex);
376
388 VALUE rb_enc_associate(VALUE obj, rb_encoding *enc);
389
403void rb_enc_copy(VALUE dst, VALUE src);
404
405
414 rb_encoding *rb_enc_from_index(int idx);
415
424 rb_encoding *rb_enc_find(const char *name);
425
432static inline const char *
433rb_enc_name(rb_encoding *enc)
434{
435 return enc->name;
436}
437
447static inline int
448rb_enc_mbminlen(rb_encoding *enc)
449{
450 return enc->min_enc_len;
451}
452
462static inline int
463rb_enc_mbmaxlen(rb_encoding *enc)
464{
465 return enc->max_enc_len;
466}
467
484int rb_enc_mbclen(const char *p, const char *e, rb_encoding *enc);
485
502int rb_enc_fast_mbclen(const char *p, const char *e, rb_encoding *enc);
503
530int rb_enc_precise_mbclen(const char *p, const char *e, rb_encoding *enc);
531
532#define MBCLEN_CHARFOUND_P(ret) ONIGENC_MBCLEN_CHARFOUND_P(ret)
533#define MBCLEN_CHARFOUND_LEN(ret) ONIGENC_MBCLEN_CHARFOUND_LEN(ret)
534#define MBCLEN_INVALID_P(ret) ONIGENC_MBCLEN_INVALID_P(ret)
535#define MBCLEN_NEEDMORE_P(ret) ONIGENC_MBCLEN_NEEDMORE_P(ret)
536#define MBCLEN_NEEDMORE_LEN(ret) ONIGENC_MBCLEN_NEEDMORE_LEN(ret)
552int rb_enc_ascget(const char *p, const char *e, int *len, rb_encoding *enc);
553
566unsigned int rb_enc_codepoint_len(const char *p, const char *e, int *len, rb_encoding *enc);
567
586static inline unsigned int
587rb_enc_codepoint(const char *p, const char *e, rb_encoding *enc)
588{
589 return rb_enc_codepoint_len(p, e, 0, enc);
590 /* ^^^
591 * This can be `NULL` in C, `nullptr` in C++, and `0` for both.
592 * We choose the most portable one here.
593 */
594}
595
596
606static inline OnigCodePoint
607rb_enc_mbc_to_codepoint(const char *p, const char *e, rb_encoding *enc)
608{
609 const OnigUChar *up = RBIMPL_CAST((const OnigUChar *)p);
610 const OnigUChar *ue = RBIMPL_CAST((const OnigUChar *)e);
611
612 return ONIGENC_MBC_TO_CODE(enc, up, ue);
613}
614
624int rb_enc_codelen(int code, rb_encoding *enc);
625
634static inline int
635rb_enc_code_to_mbclen(int c, rb_encoding *enc)
636{
637 OnigCodePoint uc = RBIMPL_CAST((OnigCodePoint)c);
638
639 return ONIGENC_CODE_TO_MBCLEN(enc, uc);
640}
641
658static inline int
659rb_enc_mbcput(unsigned int c, void *buf, rb_encoding *enc)
660{
661 OnigCodePoint uc = RBIMPL_CAST((OnigCodePoint)c);
662 OnigUChar *ubuf = RBIMPL_CAST((OnigUChar *)buf);
663
664 return ONIGENC_CODE_TO_MBC(enc, uc, ubuf);
665}
666
677static inline char *
678rb_enc_prev_char(const char *s, const char *p, const char *e, rb_encoding *enc)
679{
680 const OnigUChar *us = RBIMPL_CAST((const OnigUChar *)s);
681 const OnigUChar *up = RBIMPL_CAST((const OnigUChar *)p);
682 const OnigUChar *ue = RBIMPL_CAST((const OnigUChar *)e);
683 OnigUChar *ur = onigenc_get_prev_char_head(enc, us, up, ue);
684
685 return RBIMPL_CAST((char *)ur);
686}
687
698static inline char *
699rb_enc_left_char_head(const char *s, const char *p, const char *e, rb_encoding *enc)
700{
701 const OnigUChar *us = RBIMPL_CAST((const OnigUChar *)s);
702 const OnigUChar *up = RBIMPL_CAST((const OnigUChar *)p);
703 const OnigUChar *ue = RBIMPL_CAST((const OnigUChar *)e);
704 OnigUChar *ur = onigenc_get_left_adjust_char_head(enc, us, up, ue);
705
706 return RBIMPL_CAST((char *)ur);
707}
708
719static inline char *
720rb_enc_right_char_head(const char *s, const char *p, const char *e, rb_encoding *enc)
721{
722 const OnigUChar *us = RBIMPL_CAST((const OnigUChar *)s);
723 const OnigUChar *up = RBIMPL_CAST((const OnigUChar *)p);
724 const OnigUChar *ue = RBIMPL_CAST((const OnigUChar *)e);
725 OnigUChar *ur = onigenc_get_right_adjust_char_head(enc, us, up, ue);
726
727 return RBIMPL_CAST((char *)ur);
728}
729
741static inline char *
742rb_enc_step_back(const char *s, const char *p, const char *e, int n, rb_encoding *enc)
743{
744 const OnigUChar *us = RBIMPL_CAST((const OnigUChar *)s);
745 const OnigUChar *up = RBIMPL_CAST((const OnigUChar *)p);
746 const OnigUChar *ue = RBIMPL_CAST((const OnigUChar *)e);
747 const OnigUChar *ur = onigenc_step_back(enc, us, up, ue, n);
748
749 return RBIMPL_CAST((char *)ur);
750}
751
762static inline int
763rb_enc_asciicompat_inline(rb_encoding *enc)
764{
765 return rb_enc_mbminlen(enc)==1 && !rb_enc_dummy_p(enc);
766}
767
783static inline bool
784rb_enc_asciicompat(rb_encoding *enc)
785{
786 if (rb_enc_mbminlen(enc) != 1) {
787 return false;
788 }
789 else if (rb_enc_dummy_p(enc)) {
790 return false;
791 }
792 else {
793 return true;
794 }
795}
796
804static inline bool
805rb_enc_str_asciicompat_p(VALUE str)
806{
807 rb_encoding *enc = rb_enc_get(str);
808
809 return rb_enc_asciicompat(enc);
810}
811
820 VALUE rb_enc_from_encoding(rb_encoding *enc);
821
822 RBIMPL_ATTR_PURE()
837int rb_enc_unicode_p(rb_encoding *enc);
838
839 RBIMPL_ATTR_RETURNS_NONNULL()
849 rb_encoding *rb_ascii8bit_encoding(void);
850
851 RBIMPL_ATTR_RETURNS_NONNULL()
861 rb_encoding *rb_utf8_encoding(void);
862
863 RBIMPL_ATTR_RETURNS_NONNULL()
873 rb_encoding *rb_usascii_encoding(void);
874
887 rb_encoding *rb_locale_encoding(void);
888
898 rb_encoding *rb_filesystem_encoding(void);
899
907 rb_encoding *rb_default_external_encoding(void);
908
916 rb_encoding *rb_default_internal_encoding(void);
917
918#ifndef rb_ascii8bit_encindex
919 RBIMPL_ATTR_CONST()
930int rb_ascii8bit_encindex(void);
931#endif
932
942static inline bool
943RB_ENCODING_IS_ASCII8BIT(VALUE obj)
944{
945 return RB_ENCODING_GET_INLINED(obj) == rb_ascii8bit_encindex();
946}
947
948#ifndef rb_utf8_encindex
949 RBIMPL_ATTR_CONST()
956int rb_utf8_encindex(void);
957#endif
958
959#ifndef rb_usascii_encindex
960 RBIMPL_ATTR_CONST()
967int rb_usascii_encindex(void);
968#endif
969
976int rb_locale_encindex(void);
977
984int rb_filesystem_encindex(void);
985
993 VALUE rb_enc_default_external(void);
994
1002 VALUE rb_enc_default_internal(void);
1003
1013void rb_enc_set_default_external(VALUE encoding);
1014
1024void rb_enc_set_default_internal(VALUE encoding);
1025
1035 VALUE rb_locale_charmap(VALUE klass);
1036
1037 RBIMPL_SYMBOL_EXPORT_END()
1038
1039
1040#define RB_ENCODING_GET RB_ENCODING_GET
1041#define RB_ENCODING_GET_INLINED RB_ENCODING_GET_INLINED
1042#define RB_ENCODING_IS_ASCII8BIT RB_ENCODING_IS_ASCII8BIT
1043#define RB_ENCODING_SET RB_ENCODING_SET
1044#define RB_ENCODING_SET_INLINED RB_ENCODING_SET_INLINED
1045#define rb_enc_asciicompat rb_enc_asciicompat
1046#define rb_enc_code_to_mbclen rb_enc_code_to_mbclen
1047#define rb_enc_codepoint rb_enc_codepoint
1048#define rb_enc_left_char_head rb_enc_left_char_head
1049#define rb_enc_mbc_to_codepoint rb_enc_mbc_to_codepoint
1050#define rb_enc_mbcput rb_enc_mbcput
1051#define rb_enc_mbmaxlen rb_enc_mbmaxlen
1052#define rb_enc_mbminlen rb_enc_mbminlen
1053#define rb_enc_name rb_enc_name
1054#define rb_enc_prev_char rb_enc_prev_char
1055#define rb_enc_right_char_head rb_enc_right_char_head
1056#define rb_enc_step_back rb_enc_step_back
1057#define rb_enc_str_asciicompat_p rb_enc_str_asciicompat_p
1060#endif /* RUBY_INTERNAL_ENCODING_ENCODING_H */
ruby_coderange_type
ruby_coderange_type
What rb_enc_str_coderange() returns.
Definition coderange.h:33
RB_ENC_CODERANGE_SET
static void RB_ENC_CODERANGE_SET(VALUE obj, enum ruby_coderange_type cr)
Destructively modifies the passed object so that its (inline) code range is the passed one.
Definition coderange.h:129
const.h
Defines RBIMPL_ATTR_CONST.
RBIMPL_ATTR_CONST
#define RBIMPL_ATTR_CONST()
Wraps (or simulates) __attribute__((const))
Definition const.h:36
deprecated.h
Defines RBIMPL_ATTR_DEPRECATED.
dllexport.h
Tweaking visibility of C variables/functions.
RUBY_EXTERN
#define RUBY_EXTERN
Declaration of externally visible global variables.
Definition dllexport.h:47
RBIMPL_SYMBOL_EXPORT_END
#define RBIMPL_SYMBOL_EXPORT_END()
Counterpart of RBIMPL_SYMBOL_EXPORT_BEGIN.
Definition dllexport.h:106
RBIMPL_SYMBOL_EXPORT_BEGIN
#define RBIMPL_SYMBOL_EXPORT_BEGIN()
Shortcut macro equivalent to RUBY_SYMBOL_EXPORT_BEGIN extern "C" {.
Definition dllexport.h:97
fl_type.h
Defines enum ruby_fl_type.
RUBY_FL_USHIFT
@ RUBY_FL_USHIFT
Number of bits in ruby_fl_type that are not open to users.
Definition fl_type.h:167
RB_FL_TEST_RAW
static VALUE RB_FL_TEST_RAW(VALUE obj, VALUE flags)
This is an implenentation detail of RB_FL_TEST().
Definition fl_type.h:501
RB_FL_SET_RAW
static void RB_FL_SET_RAW(VALUE obj, VALUE flags)
This is an implenentation detail of RB_FL_SET().
Definition fl_type.h:638
RB_FL_UNSET_RAW
static void RB_FL_UNSET_RAW(VALUE obj, VALUE flags)
This is an implenentation detail of RB_FL_UNSET().
Definition fl_type.h:698
rb_cEncoding
VALUE rb_cEncoding
Encoding class.
Definition encoding.c:57
rb_enc_dummy_p
int rb_enc_dummy_p(rb_encoding *enc)
Queries if the passed encoding is dummy.
Definition encoding.c:179
rb_enc_precise_mbclen
int rb_enc_precise_mbclen(const char *p, const char *e, rb_encoding *enc)
Queries the number of bytes of the character at the passed pointer.
Definition encoding.c:1188
rb_enc_get_index
int rb_enc_get_index(VALUE obj)
Queries the index of the encoding of the passed object, if any.
Definition encoding.c:933
rb_to_encoding_index
int rb_to_encoding_index(VALUE obj)
Obtains a encoding index from a wider range of objects (than rb_enc_find_index()).
Definition encoding.c:243
rb_filesystem_encindex
int rb_filesystem_encindex(void)
Identical to rb_filesystem_encoding(), except it returns the encoding's index instead of the encoding...
Definition encoding.c:1525
rb_enc_associate
VALUE rb_enc_associate(VALUE obj, rb_encoding *enc)
Identical to rb_enc_associate_index(), except it takes an encoding itself instead of its index.
Definition encoding.c:1020
rb_utf8_encoding
rb_encoding * rb_utf8_encoding(void)
Queries the encoding that represents UTF-8.
Definition encoding.c:1471
RB_ENCODING_SET_INLINED
static void RB_ENCODING_SET_INLINED(VALUE obj, int encindex)
Destructively assigns the passed encoding to the passed object.
Definition encoding.h:80
rb_ascii8bit_encoding
rb_encoding * rb_ascii8bit_encoding(void)
Queries the encoding that represents ASCII-8BIT a.k.a.
Definition encoding.c:1459
RB_ENCODING_IS_ASCII8BIT
static bool RB_ENCODING_IS_ASCII8BIT(VALUE obj)
Queries if the passed object is in ascii 8bit (== binary) encoding.
Definition encoding.h:943
rb_enc_codelen
int rb_enc_codelen(int code, rb_encoding *enc)
Queries the number of bytes requested to represent the passed code point using the passed encoding.
Definition encoding.c:1238
rb_to_encoding
rb_encoding * rb_to_encoding(VALUE obj)
Identical to rb_find_encoding(), except it raises an exception instead of returning NULL.
Definition encoding.c:305
rb_encoding
const OnigEncodingType rb_encoding
The type of encoding.
Definition encoding.h:116
rb_filesystem_encoding
rb_encoding * rb_filesystem_encoding(void)
Queries the "filesystem" encoding.
Definition encoding.c:1533
rb_enc_name
static const char * rb_enc_name(rb_encoding *enc)
Queries the (canonical) name of the passed encoding.
Definition encoding.h:433
rb_default_internal_encoding
rb_encoding * rb_default_internal_encoding(void)
Queries the "default internal" encoding.
Definition encoding.c:1672
rb_enc_copy
void rb_enc_copy(VALUE dst, VALUE src)
Destructively copies the encoding of the latter object to that of former one.
Definition encoding.c:1146
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:699
rb_utf8_encindex
int rb_utf8_encindex(void)
Identical to rb_utf8_encoding(), except it returns the encoding's index instead of the encoding itsel...
Definition encoding.c:1477
rb_enc_fast_mbclen
int rb_enc_fast_mbclen(const char *p, const char *e, rb_encoding *enc)
Identical to rb_enc_mbclen() unless the character at p overruns e.
Definition encoding.c:1170
RB_ENCODING_GET
static int RB_ENCODING_GET(VALUE obj)
Just another name of rb_enc_get_index.
Definition encoding.h:211
rb_enc_get
rb_encoding * rb_enc_get(VALUE obj)
Identical to rb_enc_get_index(), except the return type.
Definition encoding.c:1026
rb_enc_from_index
rb_encoding * rb_enc_from_index(int idx)
Identical to rb_find_encoding(), except it takes an encoding index instead of a Ruby object.
Definition encoding.c:384
rb_ascii8bit_encindex
int rb_ascii8bit_encindex(void)
Identical to rb_ascii8bit_encoding(), except it returns the encoding's index instead of the encoding ...
Definition encoding.c:1465
rb_enc_codepoint_len
unsigned int rb_enc_codepoint_len(const char *p, const char *e, int *len, rb_encoding *enc)
Queries the code point of character pointed by the passed pointer.
Definition encoding.c:1224
rb_enc_unicode_p
int rb_enc_unicode_p(rb_encoding *enc)
Queries if the passed encoding is either one of UTF-8/16/32.
Definition encoding.c:651
rb_enc_prev_char
static char * rb_enc_prev_char(const char *s, const char *p, const char *e, rb_encoding *enc)
Queries the previous (left) character.
Definition encoding.h:678
rb_enc_to_index
int rb_enc_to_index(rb_encoding *enc)
Queries the index of the encoding.
Definition encoding.c:173
rb_enc_set_index
void rb_enc_set_index(VALUE obj, int encindex)
Destructively assigns an encoding (via its index) to an object.
Definition encoding.c:984
rb_locale_charmap
VALUE rb_locale_charmap(VALUE klass)
Returns a platform-depended "charmap" of the current locale.
Definition localeinit.c:91
rb_enc_set_default_internal
void rb_enc_set_default_internal(VALUE encoding)
Destructively assigns the passed encoding as the default internal encoding.
Definition encoding.c:1722
rb_enc_default_external
VALUE rb_enc_default_external(void)
Identical to rb_default_external_encoding(), except it returns the Ruby-level counterpart instance of...
Definition encoding.c:1599
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:720
rb_enc_find
rb_encoding * rb_enc_find(const char *name)
Identical to rb_find_encoding(), except it takes a C's string instead of Ruby's.
Definition encoding.c:872
rb_enc_from_encoding
VALUE rb_enc_from_encoding(rb_encoding *enc)
Queries the Ruby-level counterpart instance of rb_cEncoding that corresponds to the passed encoding.
Definition encoding.c:164
rb_find_encoding
rb_encoding * rb_find_encoding(VALUE obj)
Identical to rb_to_encoding_index(), except the return type.
Definition encoding.c:312
rb_enc_asciicompat
static bool rb_enc_asciicompat(rb_encoding *enc)
Queries if the passed encoding is in some sense compatible with ASCII.
Definition encoding.h:784
rb_define_dummy_encoding
int rb_define_dummy_encoding(const char *name)
Creates a new "dummy" encoding.
Definition encoding.c:579
rb_enc_codepoint
static unsigned int rb_enc_codepoint(const char *p, const char *e, rb_encoding *enc)
Queries the code point of character pointed by the passed pointer.
Definition encoding.h:587
rb_enc_mbcput
static int rb_enc_mbcput(unsigned int c, void *buf, rb_encoding *enc)
Identical to rb_enc_uint_chr(), except it writes back to the passed buffer instead of allocating one.
Definition encoding.h:659
rb_default_external_encoding
rb_encoding * rb_default_external_encoding(void)
Queries the "default external" encoding.
Definition encoding.c:1585
rb_locale_encindex
int rb_locale_encindex(void)
Identical to rb_locale_encoding(), except it returns the encoding's index instead of the encoding its...
Definition encoding.c:1497
rb_char_to_option_kcode
int rb_char_to_option_kcode(int c, int *option, int *kcode)
Converts a character option to its encoding.
Definition re.c:331
rb_enc_mbmaxlen
static int rb_enc_mbmaxlen(rb_encoding *enc)
Queries the maximum number of bytes that the passed encoding needs to represent a character.
Definition encoding.h:463
rb_enc_check
rb_encoding * rb_enc_check(VALUE str1, VALUE str2)
Identical to rb_enc_compatible(), except it raises an exception instead of returning NULL.
Definition encoding.c:1051
rb_enc_mbclen
int rb_enc_mbclen(const char *p, const char *e, rb_encoding *enc)
Queries the number of bytes of the character at the passed pointer.
Definition encoding.c:1176
RB_ENCODING_SET
static void RB_ENCODING_SET(VALUE obj, int encindex)
Just another name of rb_enc_set_index.
Definition encoding.h:237
rb_enc_capable
int rb_enc_capable(VALUE obj)
Queries if the passed object can have its encoding.
Definition encoding.c:897
RB_ENCODING_CODERANGE_SET
static void RB_ENCODING_CODERANGE_SET(VALUE obj, int encindex, enum ruby_coderange_type cr)
This is RB_ENCODING_SET + RB_ENC_CODERANGE_SET combo.
Definition encoding.h:254
rb_enc_default_internal
VALUE rb_enc_default_internal(void)
Identical to rb_default_internal_encoding(), except it returns the Ruby-level counterpart instance of...
Definition encoding.c:1681
rb_enc_associate_index
VALUE rb_enc_associate_index(VALUE obj, int encindex)
Identical to rb_enc_set_index(), except it additionally does contents fix-up depending on the passed ...
Definition encoding.c:992
rb_enc_compatible
rb_encoding * rb_enc_compatible(VALUE str1, VALUE str2)
Look for the "common" encoding between the two.
Definition encoding.c:1130
rb_enc_replicate
int rb_enc_replicate(const char *name, rb_encoding *src)
Creates a new encoding, using the passed one as a template.
Definition encoding.c:509
RB_ENCODING_GET_INLINED
static int RB_ENCODING_GET_INLINED(VALUE obj)
Queries the encoding of the passed object.
Definition encoding.h:98
rb_locale_encoding
rb_encoding * rb_locale_encoding(void)
Queries the encoding that represents the current locale.
Definition encoding.c:1519
rb_enc_mbc_to_codepoint
static OnigCodePoint rb_enc_mbc_to_codepoint(const char *p, const char *e, rb_encoding *enc)
Identical to rb_enc_codepoint(), except it assumes the passed character is not broken.
Definition encoding.h:607
rb_usascii_encoding
rb_encoding * rb_usascii_encoding(void)
Queries the encoding that represents US-ASCII.
Definition encoding.c:1483
rb_enc_set_default_external
void rb_enc_set_default_external(VALUE encoding)
Destructively assigns the passed encoding as the default external encoding.
Definition encoding.c:1639
rb_enc_find_index
int rb_enc_find_index(const char *name)
Queries the index of the encoding.
Definition encoding.c:837
rb_enc_mbminlen
static int rb_enc_mbminlen(rb_encoding *enc)
Queries the minimum number of bytes that the passed encoding needs to represent a character.
Definition encoding.h:448
rb_enc_alias
int rb_enc_alias(const char *alias, const char *orig)
Registers an "alias" name.
Definition encoding.c:683
rb_enc_code_to_mbclen
static int rb_enc_code_to_mbclen(int c, rb_encoding *enc)
Identical to rb_enc_codelen(), except it returns 0 for invalid code points.
Definition encoding.h:635
rb_enc_step_back
static char * rb_enc_step_back(const char *s, const char *p, const char *e, int n, rb_encoding *enc)
Scans the string backwards for n characters.
Definition encoding.h:742
rb_enc_ascget
int rb_enc_ascget(const char *p, const char *e, int *len, rb_encoding *enc)
Queries the code point of character pointed by the passed pointer.
Definition encoding.c:1200
rb_enc_str_asciicompat_p
static bool rb_enc_str_asciicompat_p(VALUE str)
Queries if the passed string is in an ASCII-compatible encoding.
Definition encoding.h:805
rb_usascii_encindex
int rb_usascii_encindex(void)
Identical to rb_usascii_encoding(), except it returns the encoding's index instead of the encoding it...
Definition encoding.c:1489
noalias.h
Defines RBIMPL_ATTR_NOALIAS.
RBIMPL_ATTR_NOALIAS
#define RBIMPL_ATTR_NOALIAS()
Wraps (or simulates) __declspec((noalias))
Definition noalias.h:66
pure.h
Defines RBIMPL_ATTR_PURE.
RBIMPL_ATTR_PURE
#define RBIMPL_ATTR_PURE()
Wraps (or simulates) __attribute__((pure))
Definition pure.h:33
rbasic.h
Defines struct RBasic.
returns_nonnull.h
Defines RBIMPL_ATTR_RETURNS_NONNULL.
RBIMPL_ATTR_RETURNS_NONNULL
#define RBIMPL_ATTR_RETURNS_NONNULL()
Wraps (or simulates) __attribute__((returns_nonnull))
Definition returns_nonnull.h:34
OnigEncodingTypeST
Definition onigmo.h:160
value.h
Defines VALUE and ID.
VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40