Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

376 lines (325 sloc) 10.564 kb
/*
* MacRuby implementation of Ruby 1.9 String.
*
* This file is covered by the Ruby license. See COPYING for more details.
*
* Copyright (C) 2007-2010, Apple Inc. All rights reserved.
* Copyright (C) 1993-2007 Yukihiro Matsumoto
* Copyright (C) 2000 Network Applied Communication Laboratory, Inc.
* Copyright (C) 2000 Information-technology Promotion Agency, Japan
*/
#ifndef __ENCODING_H_
#define __ENCODING_H_
#if defined(__cplusplus)
extern "C" {
#endif
#if defined(__cplusplus)
# include "unicode/unistr.h"
#else
# include "unicode/ustring.h"
#endif
#if __LITTLE_ENDIAN__
#define ENCODING_UTF16_NATIVE ENCODING_UTF16LE
#define ENCODING_UTF32_NATIVE ENCODING_UTF32LE
#define ENCODING_UTF16_NON_NATIVE ENCODING_UTF16BE
#define ENCODING_UTF32_NON_NATIVE ENCODING_UTF32BE
#else
#define ENCODING_UTF16_NATIVE ENCODING_UTF16BE
#define ENCODING_UTF32_NATIVE ENCODING_UTF32BE
#define ENCODING_UTF16_NON_NATIVE ENCODING_UTF16LE
#define ENCODING_UTF32_NON_NATIVE ENCODING_UTF32LE
#endif
#define NATIVE_UTF16_ENC(encoding) \
((encoding) == rb_encodings[ENCODING_UTF16_NATIVE])
#define NON_NATIVE_UTF16_ENC(encoding) \
((encoding) == rb_encodings[ENCODING_UTF16_NON_NATIVE])
#define UTF16_ENC(encoding) \
(NATIVE_UTF16_ENC(encoding) || NON_NATIVE_UTF16_ENC(encoding))
#define NATIVE_UTF32_ENC(encoding) \
((encoding) == rb_encodings[ENCODING_UTF32_NATIVE])
#define NON_NATIVE_UTF32_ENC(encoding) \
((encoding) == rb_encodings[ENCODING_UTF32_NON_NATIVE])
#define UTF32_ENC(encoding) \
(NATIVE_UTF32_ENC(encoding) || NON_NATIVE_UTF32_ENC(encoding))
#define BINARY_ENC(encoding) ((encoding) == rb_encodings[ENCODING_BINARY])
typedef uint8_t str_flag_t;
typedef struct {
struct RBasic basic;
struct rb_encoding *encoding;
long capacity_in_bytes;
long length_in_bytes;
union {
char *bytes;
UChar *uchars;
} data;
str_flag_t flags;
} rb_str_t;
#define RSTR(x) ((rb_str_t *)x)
static inline bool
rb_klass_is_rstr(VALUE klass)
{
do {
if (klass == rb_cRubyString) {
return true;
}
if (klass == rb_cNSString) {
return false;
}
klass = RCLASS_SUPER(klass);
}
while (klass != 0);
return false;
}
#define IS_RSTR(x) (rb_klass_is_rstr(*(VALUE *)x))
static inline void
rstr_modify(VALUE str)
{
const long mask = RBASIC(str)->flags;
if ((mask & FL_FREEZE) == FL_FREEZE) {
rb_raise(rb_eRuntimeError, "can't modify frozen/immutable string");
}
if ((mask & FL_TAINT) == FL_TAINT) {
if (rb_safe_level() >= 4) {
rb_raise(rb_eSecurityError, "Insecure: can't modify string");
}
}
}
static inline void
rstr_frozen_check(VALUE str)
{
const long mask = RBASIC(str)->flags;
if ((mask & FL_FREEZE) == FL_FREEZE) {
rb_raise(rb_eRuntimeError, "string frozen");
}
}
typedef struct {
long start_offset_in_bytes;
long end_offset_in_bytes;
} character_boundaries_t;
typedef struct {
void (*update_flags)(rb_str_t *);
void (*make_data_binary)(rb_str_t *);
bool (*try_making_data_uchars)(rb_str_t *);
long (*length)(rb_str_t *, bool);
long (*bytesize)(rb_str_t *);
character_boundaries_t (*get_character_boundaries)(rb_str_t *, long, bool);
long (*offset_in_bytes_to_index)(rb_str_t *, long, bool);
void (*transcode_to_utf16)(struct rb_encoding *, rb_str_t *, long *, UChar **, long *);
void (*transcode_from_utf16)(struct rb_encoding *, UChar *, long, long *, char **, long *);
} encoding_methods_t;
typedef struct rb_encoding {
struct RBasic basic;
unsigned int index;
const char *public_name;
const char **aliases;
unsigned int aliases_count;
unsigned char min_char_size;
bool single_byte_encoding : 1;
bool ascii_compatible : 1;
encoding_methods_t methods;
void *private_data;
} rb_encoding_t;
#define RENC(x) ((rb_encoding_t *)(x))
enum {
ENCODING_BINARY = 0,
ENCODING_ASCII,
ENCODING_UTF8,
ENCODING_UTF16BE,
ENCODING_UTF16LE,
ENCODING_UTF32BE,
ENCODING_UTF32LE,
ENCODING_ISO8859_1,
ENCODING_MACROMAN,
ENCODING_MACCYRILLIC,
ENCODING_BIG5,
ENCODING_EUCJP,
ENCODING_SJIS,
//ENCODING_CP932,
ENCODINGS_COUNT
};
extern rb_encoding_t *rb_encodings[ENCODINGS_COUNT];
#define STRING_HAS_SUPPLEMENTARY 0x020
#define STRING_HAS_SUPPLEMENTARY_SET 0x010
#define STRING_ASCII_ONLY_SET 0x010
#define STRING_ASCII_ONLY 0x008
#define STRING_VALID_ENCODING_SET 0x004
#define STRING_VALID_ENCODING 0x002
#define STRING_STORED_IN_UCHARS 0x001
#define STRING_REQUIRED_FLAGS STRING_STORED_IN_UCHARS
#define BYTES_TO_UCHARS(len) ((len) / sizeof(UChar))
#define UCHARS_TO_BYTES(len) ((len) * sizeof(UChar))
#define ODD_NUMBER(x) ((x) & 0x1)
static inline long
div_round_up(long a, long b)
{
return ((a) + (b - 1)) / b;
}
void str_update_flags(rb_str_t *self);
static inline void
str_unset_facultative_flags(rb_str_t *self)
{
self->flags &= ~STRING_HAS_SUPPLEMENTARY_SET & ~STRING_ASCII_ONLY_SET
& ~STRING_VALID_ENCODING_SET;
}
static inline bool
str_known_to_have_an_invalid_encoding(rb_str_t *self)
{
return (self->flags & (STRING_VALID_ENCODING_SET
| STRING_VALID_ENCODING)) == STRING_VALID_ENCODING_SET;
}
static inline bool
str_known_not_to_have_any_supplementary(rb_str_t *self)
{
return (self->flags & (STRING_HAS_SUPPLEMENTARY_SET
| STRING_HAS_SUPPLEMENTARY)) == STRING_HAS_SUPPLEMENTARY_SET;
}
static inline bool
str_check_flag_and_update_if_needed(rb_str_t *self, str_flag_t flag_set,
str_flag_t flag)
{
if (!(self->flags & flag_set)) {
str_update_flags(self);
assert(self->flags & flag_set);
}
return self->flags & flag;
}
static inline bool
str_is_valid_encoding(rb_str_t *self)
{
return str_check_flag_and_update_if_needed(self, STRING_VALID_ENCODING_SET,
STRING_VALID_ENCODING);
}
static inline bool
str_is_ascii_only(rb_str_t *self)
{
return str_check_flag_and_update_if_needed(self, STRING_ASCII_ONLY_SET,
STRING_ASCII_ONLY);
}
static inline bool
str_is_ruby_ascii_only(rb_str_t *self)
{
// for MRI, a string in a non-ASCII-compatible encoding (like UTF-16)
// containing only ASCII characters is not "ASCII only" though for us it
// is internally
if (!self->encoding->ascii_compatible) {
return false;
}
return str_is_ascii_only(self);
}
static inline bool
str_is_stored_in_uchars(rb_str_t *self)
{
return self->flags & STRING_STORED_IN_UCHARS;
}
static inline void
str_negate_stored_in_uchars(rb_str_t *self)
{
self->flags ^= STRING_STORED_IN_UCHARS;
}
static inline void
str_set_stored_in_uchars(rb_str_t *self, bool status)
{
if (status) {
self->flags |= STRING_STORED_IN_UCHARS;
}
else {
self->flags &= ~STRING_STORED_IN_UCHARS;
}
}
static inline void
str_set_facultative_flag(rb_str_t *self, bool status, str_flag_t flag_set,
str_flag_t flag)
{
if (status) {
self->flags = self->flags | flag_set | flag;
}
else {
self->flags = (self->flags | flag_set) & ~flag;
}
}
static inline void
str_set_has_supplementary(rb_str_t *self, bool status)
{
str_set_facultative_flag(self, status, STRING_HAS_SUPPLEMENTARY_SET,
STRING_HAS_SUPPLEMENTARY);
}
static inline void
str_set_ascii_only(rb_str_t *self, bool status)
{
str_set_facultative_flag(self, status, STRING_ASCII_ONLY_SET,
STRING_ASCII_ONLY);
}
static inline void
str_set_valid_encoding(rb_str_t *self, bool status)
{
str_set_facultative_flag(self, status, STRING_VALID_ENCODING_SET,
STRING_VALID_ENCODING);
}
typedef enum {
TRANSCODE_BEHAVIOR_RAISE_EXCEPTION,
TRANSCODE_BEHAVIOR_REPLACE_WITH_STRING,
TRANSCODE_BEHAVIOR_REPLACE_WITH_XML_TEXT,
TRANSCODE_BEHAVIOR_REPLACE_WITH_XML_ATTR
} transcode_behavior_t;
typedef enum {
ECONV_INVALID_MASK = 1,
ECONV_INVALID_REPLACE = 1 << 1,
ECONV_UNDEF_MASK = 1 << 2,
ECONV_UNDEF_REPLACE = 1 << 3,
ECONV_UNDEF_HEX_CHARREF = 1 << 4,
ECONV_PARTIAL_INPUT = 1 << 5,
ECONV_AFTER_OUTPUT = 1 << 6,
ECONV_UNIVERSAL_NEWLINE_DECORATOR = 1 << 7,
ECONV_CRLF_NEWLINE_DECORATOR = 1 << 8,
ECONV_CR_NEWLINE_DECORATOR = 1 << 9,
ECONV_XML_TEXT_DECORATOR = 1 << 10,
ECONV_XML_ATTR_CONTENT_DECORATOR = 1 << 11,
ECONV_XML_ATTR_QUOTE_DECORATOR = 1 << 12
} transcode_flags_t;
rb_str_t *str_transcode(rb_str_t *self, rb_encoding_t *src_encoding, rb_encoding_t *dst_encoding,
int behavior_for_invalid, int behavior_for_undefined, rb_str_t *replacement_str);
static inline rb_str_t *
str_simple_transcode(rb_str_t *self, rb_encoding_t *dst_encoding)
{
return str_transcode(self, self->encoding, dst_encoding,
TRANSCODE_BEHAVIOR_RAISE_EXCEPTION, TRANSCODE_BEHAVIOR_RAISE_EXCEPTION, NULL);
}
void rb_str_NSCoder_encode(void *coder, VALUE str, const char *key);
VALUE rb_str_NSCoder_decode(void *coder, const char *key);
VALUE mr_enc_s_is_compatible(VALUE klass, SEL sel, VALUE str1, VALUE str2);
VALUE rb_str_intern_fast(VALUE str);
VALUE rstr_aref(VALUE str, SEL sel, int argc, VALUE *argv);
VALUE rstr_swapcase(VALUE str, SEL sel);
VALUE rstr_capitalize(VALUE str, SEL sel);
VALUE rstr_upcase(VALUE str, SEL sel);
VALUE rstr_downcase(VALUE str, SEL sel);
VALUE rstr_concat(VALUE self, SEL sel, VALUE other);
// The following functions should always been prefered over anything else,
// especially if this "else" is RSTRING_PTR and RSTRING_LEN.
// They also work on CFStrings.
VALUE rb_unicode_str_new(const UniChar *ptr, const size_t len);
void rb_str_get_uchars(VALUE str, UChar **chars_p, long *chars_len_p,
bool *need_free_p);
long rb_str_chars_len(VALUE str);
UChar rb_str_get_uchar(VALUE str, long pos);
void rb_str_append_uchar(VALUE str, UChar c);
void rb_str_append_uchars(VALUE str, const UChar *chars, long len);
unsigned long rb_str_hash_uchars(const UChar *chars, long chars_len);
long rb_uchar_strtol(UniChar *chars, long chars_len, long pos,
long *end_offset);
void rb_str_force_encoding(VALUE str, rb_encoding_t *encoding);
rb_str_t *str_need_string(VALUE str);
rb_str_t *replacement_string_for_encoding(rb_encoding_t* enc);
void str_replace_with_string(rb_str_t *self, rb_str_t *source);
static inline void
str_check_ascii_compatible(VALUE str)
{
if (IS_RSTR(str) && !RSTR(str)->encoding->ascii_compatible) {
rb_raise(rb_eEncCompatError, "ASCII incompatible encoding: %s",
RSTR(str)->encoding->public_name);
}
}
#if defined(__cplusplus)
} // extern "C"
#endif
#endif /* __ENCODING_H_ */
Jump to Line
Something went wrong with that request. Please try again.