Module org.jruby.jcodings

Package org.jcodings.unicode

Class UnicodeEncoding

java.lang.Object

org.jcodings.Encoding

org.jcodings.MultiByteEncoding

org.jcodings.unicode.UnicodeEncoding

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

FixedWidthUnicodeEncoding, NonStrictUTF8Encoding, UTF16BEEncoding, UTF16LEEncoding, UTF8Encoding

public abstract class UnicodeEncoding
extends MultiByteEncoding

Field Summary

Fields inherited from class org.jcodings.MultiByteEncoding

A, EncLen, F, Trans, TransZero

Fields inherited from class org.jcodings.Encoding

CHAR_INVALID, isUnicode, isUTF8, maxLength, minLength, NEW_LINE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UnicodeEncoding(String name, int minLength, int maxLength, int[] EncLen)
protected	UnicodeEncoding(String name, int minLength, int maxLength, int[] EncLen, int[][] Trans)

Method Summary

Modifier and Type	Method	Description
void	applyAllCaseFold(int flag, ApplyAllCaseFoldFunction fun, Object arg)	onigenc_ascii_apply_all_case_fold / used also by multibyte encodings
protected void	asciiApplyAllCaseFold(int flag, ApplyAllCaseFoldFunction fun, Object arg)
protected CaseFoldCodeItem[]	asciiCaseFoldCodesByString(int flag, byte[] bytes, int p, int end)
protected int	asciiMbcCaseFold(int flag, byte[] bytes, IntHolder pp, int end, byte[] lower)
CaseFoldCodeItem[]	caseFoldCodesByString(int flag, byte[] bytes, int p, int end)	onigenc_ascii_get_case_fold_codes_by_str / used also by multibyte encodings
int	caseMap(IntHolder flagP, byte[] bytes, IntHolder pp, int end, byte[] to, int toP, int toEnd)	Oniguruma equivalent: case_map
protected int[]	ctypeCodeRange(int ctype)
String	getCharsetName()	The name of the equivalent Java Charset for this encoding.
boolean	isCodeCType(int code, int ctype)	Perform a check whether given code is of given character type (e.g.
protected boolean	isCodeCTypeInternal(int code, int ctype)	ONIGENC_IS_XXXXXX_CODE_CTYPE
boolean	isNewLine(byte[] bytes, int p, int end)	onigenc_is_mbc_newline_0x0a / used also by multibyte encodings
int	mbcCaseFold(int flag, byte[] bytes, IntHolder pp, int end, byte[] fold)	onigenc_ascii_mbc_case_fold
int	propertyNameToCType(byte[] name, int p, int end)	onigenc_minimum_property_name_to_ctype notably overridden by unicode encodings

Methods inherited from class org.jcodings.MultiByteEncoding

length, lengthForTwoUptoFour, mb2CodeToMbc, mb2CodeToMbcLength, mb2IsCodeCType, mb4CodeToMbc, mb4CodeToMbcLength, mb4IsCodeCType, mbnMbcCaseFold, mbnMbcToCode, missing, missing, safeLengthForUptoFour, safeLengthForUptoThree, safeLengthForUptoTwo, strCodeAt, strLength

Methods inherited from class org.jcodings.Encoding

asciiToLower, asciiToUpper, codeToMbc, codeToMbcLength, ctypeCodeRange, digitVal, equals, getCharset, getIndex, getName, hashCode, isAlnum, isAlpha, isAscii, isAscii, isAsciiCompatible, isBlank, isCntrl, isDigit, isDummy, isFixedWidth, isGraph, isLower, isMbcAscii, isMbcCrnl, isMbcHead, isMbcWord, isNewLine, isPrint, isPunct, isReverseMatchAllowed, isSbWord, isSingleByte, isSpace, isUnicode, isUpper, isUTF8, isWord, isWordGraphPrint, isXDigit, leftAdjustCharHead, length, load, maxLength, maxLengthDistance, mbcodeStartPosition, mbcToCode, minLength, odigitVal, prevCharHead, rightAdjustCharHead, rightAdjustCharHeadWithPrev, setDummy, setName, setName, step, stepBack, strByteLengthNull, strLengthNull, strNCmp, toLowerCaseTable, toString, xdigitVal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UnicodeEncoding

protected UnicodeEncoding(String name,
                          int minLength,
                          int maxLength,
                          int[] EncLen,
                          int[][] Trans)

UnicodeEncoding

protected UnicodeEncoding(String name,
                          int minLength,
                          int maxLength,
                          int[] EncLen)

Method Detail

getCharsetName

public String getCharsetName()

Description copied from class: Encoding

The name of the equivalent Java Charset for this encoding. Defaults to the name of the encoding. Subclasses can override this to provide a different name.

Overrides:

getCharsetName in class Encoding

Returns:

the name of the equivalent Java Charset for this encoding

isCodeCType

public boolean isCodeCType(int code,
                           int ctype)

Description copied from class: Encoding

Perform a check whether given code is of given character type (e.g. used by isWord(someByte) and similar methods)

Specified by:

isCodeCType in class Encoding

Parameters:

code - a code point of a character

ctype - a character type to check against Oniguruma equivalent: is_code_ctype

ctypeCodeRange

protected final int[] ctypeCodeRange(int ctype)

propertyNameToCType

public int propertyNameToCType(byte[] name,
                               int p,
                               int end)

onigenc_minimum_property_name_to_ctype notably overridden by unicode encodings

mbcCaseFold

public int mbcCaseFold(int flag,
                       byte[] bytes,
                       IntHolder pp,
                       int end,
                       byte[] fold)

onigenc_ascii_mbc_case_fold

Parameters:

flag - case fold flag

pp - an IntHolder that points at character head

fold - a buffer where to extract case folded character Oniguruma equivalent: mbc_case_fold

applyAllCaseFold

public void applyAllCaseFold(int flag,
                             ApplyAllCaseFoldFunction fun,
                             Object arg)

onigenc_ascii_apply_all_case_fold / used also by multibyte encodings

Parameters:

flag - case fold flag

fun - case folding functor (look at: ApplyCaseFold)

arg - case folding functor argument (look at: ApplyCaseFoldArg) Oniguruma equivalent: apply_all_case_fold

caseFoldCodesByString

public CaseFoldCodeItem[] caseFoldCodesByString(int flag,
                                                byte[] bytes,
                                                int p,
                                                int end)

onigenc_ascii_get_case_fold_codes_by_str / used also by multibyte encodings

caseMap

public final int caseMap(IntHolder flagP,
                         byte[] bytes,
                         IntHolder pp,
                         int end,
                         byte[] to,
                         int toP,
                         int toEnd)

Description copied from class: Encoding

Oniguruma equivalent: case_map

Overrides:

caseMap in class MultiByteEncoding

isCodeCTypeInternal

protected final boolean isCodeCTypeInternal(int code,
                                            int ctype)

ONIGENC_IS_XXXXXX_CODE_CTYPE

isNewLine

public boolean isNewLine(byte[] bytes,
                         int p,
                         int end)

onigenc_is_mbc_newline_0x0a / used also by multibyte encodings

Specified by:

isNewLine in class Encoding

asciiMbcCaseFold

protected final int asciiMbcCaseFold(int flag,
                                     byte[] bytes,
                                     IntHolder pp,
                                     int end,
                                     byte[] lower)

asciiApplyAllCaseFold

protected final void asciiApplyAllCaseFold(int flag,
                                           ApplyAllCaseFoldFunction fun,
                                           Object arg)

asciiCaseFoldCodesByString

protected final CaseFoldCodeItem[] asciiCaseFoldCodesByString(int flag,
                                                              byte[] bytes,
                                                              int p,
                                                              int end)