org.jruby.runtime.encoding

Class EncodingService

java.lang.Object

org.jruby.runtime.encoding.EncodingService

public final class EncodingService
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	EncodingService.SpecialEncoding Represents one of the four "special" internal encoding names: internal, external, locale, or filesystem.

Field Summary

Fields

Modifier and Type	Field and Description
private org.jcodings.util.CaseInsensitiveBytesHash<org.jcodings.EncodingDB.Entry>	aliases
private org.jcodings.Encoding	ascii8bit
private RubyEncoding[]	encodingIndex
private IRubyObject[]	encodingList
private org.jcodings.util.CaseInsensitiveBytesHash<org.jcodings.EncodingDB.Entry>	encodings
private static org.jruby.util.ByteList	EXTERNAL_BL
private static org.jruby.util.ByteList	FILESYSTEM_BL
private static org.jruby.util.ByteList	INTERNAL_BL
private org.jcodings.Encoding	javaDefault
private static org.jruby.util.ByteList	LOCALE_BL
private Ruby	runtime

Constructor Summary

Constructors

Constructor and Description
EncodingService(Ruby runtime)

Method Summary

Modifier and Type	Method and Description
java.nio.charset.Charset	charsetForEncoding(org.jcodings.Encoding encoding) Get a java.nio Charset for the given encoding, or null if impossible
private void	checkAsciiEncodingName(org.jruby.util.ByteList name)
IRubyObject	convertEncodingToRubyEncoding(org.jcodings.Encoding defaultEncoding)
void	defineAliases()
private void	defineEncodingConstant(Ruby runtime, RubyEncoding encoding, byte[] constName, int constP, int constEnd)
private void	defineEncodingConstants(Ruby runtime, RubyEncoding encoding, byte[] name, int p, int end)
void	defineEncodings()
org.jcodings.EncodingDB.Entry	findAliasEntry(byte[] bytes)
org.jcodings.EncodingDB.Entry	findAliasEntry(org.jruby.util.ByteList bytes)
org.jcodings.Encoding	findEncoding(IRubyObject str) Find an encoding given a Ruby object, coercing it to a String in the process.
private org.jcodings.Encoding	findEncodingCommon(IRubyObject str, boolean error)
org.jcodings.EncodingDB.Entry	findEncodingEntry(byte[] bytes)
org.jcodings.EncodingDB.Entry	findEncodingEntry(org.jruby.util.ByteList bytes)
org.jcodings.Encoding	findEncodingNoError(IRubyObject str) Find an encoding given a Ruby object, coercing it to a String in the process.
org.jcodings.EncodingDB.Entry	findEncodingOrAliasEntry(byte[] bytes)
org.jcodings.EncodingDB.Entry	findEncodingOrAliasEntry(org.jruby.util.ByteList bytes)
org.jcodings.Encoding	findEncodingWithError(org.jruby.util.ByteList name) Find a non-special encoding, raising argument error if it does not exist.
org.jcodings.EncodingDB.Entry	findEntry(IRubyObject str) Find an encoding given a Ruby object, coercing it to a String in the process.
private org.jcodings.EncodingDB.Entry	findEntryFromEncoding(org.jcodings.Encoding e)
private org.jcodings.EncodingDB.Entry	findEntryWithError(org.jruby.util.ByteList name) Find a non-special encoding Entry, raising argument error if it does not exist.
org.jcodings.util.CaseInsensitiveBytesHash<org.jcodings.EncodingDB.Entry>	getAliases()
org.jcodings.Encoding	getAscii8bitEncoding()
org.jcodings.Encoding	getConsoleEncoding() Since Java 1.6, class Console is available.
IRubyObject	getDefaultExternal()
IRubyObject	getDefaultInternal()
RubyEncoding	getEncoding(org.jcodings.Encoding enc)
private org.jcodings.Encoding	getEncodingFromNKFId(IRubyObject id)
org.jcodings.Encoding	getEncodingFromObject(IRubyObject arg)
private org.jcodings.Encoding	getEncodingFromObjectCommon(IRubyObject arg, boolean error)
org.jcodings.Encoding	getEncodingFromObjectNoError(IRubyObject arg)
org.jcodings.Encoding	getEncodingFromString(java.lang.String string)
IRubyObject[]	getEncodingList()
org.jcodings.util.CaseInsensitiveBytesHash<org.jcodings.EncodingDB.Entry>	getEncodings()
org.jcodings.Encoding	getFileSystemEncoding(Ruby runtime)
org.jcodings.Encoding	getJavaDefault()
org.jcodings.Encoding	getLocaleEncoding()
org.jcodings.Encoding	getUSAsciiEncoding()
org.jcodings.Encoding	loadEncoding(org.jruby.util.ByteList name)
IRubyObject	rubyEncodingFromObject(IRubyObject str)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

encodings

private final org.jcodings.util.CaseInsensitiveBytesHash<org.jcodings.EncodingDB.Entry> encodings

aliases

private final org.jcodings.util.CaseInsensitiveBytesHash<org.jcodings.EncodingDB.Entry> aliases

encodingList

private final IRubyObject[] encodingList

encodingIndex

private RubyEncoding[] encodingIndex

runtime

private final Ruby runtime

ascii8bit

private final org.jcodings.Encoding ascii8bit

javaDefault

private final org.jcodings.Encoding javaDefault

LOCALE_BL

private static final org.jruby.util.ByteList LOCALE_BL

EXTERNAL_BL

private static final org.jruby.util.ByteList EXTERNAL_BL

INTERNAL_BL

private static final org.jruby.util.ByteList INTERNAL_BL

FILESYSTEM_BL

private static final org.jruby.util.ByteList FILESYSTEM_BL

Constructor Detail

EncodingService

public EncodingService(Ruby runtime)

Method Detail

getConsoleEncoding

public org.jcodings.Encoding getConsoleEncoding()

Since Java 1.6, class Console is available. But the encoding or codepage of the underlying connected console is currently private. Had to use Reflection to get it.

Returns:

console codepage

getUSAsciiEncoding

public org.jcodings.Encoding getUSAsciiEncoding()

getAscii8bitEncoding

public org.jcodings.Encoding getAscii8bitEncoding()

getFileSystemEncoding

public org.jcodings.Encoding getFileSystemEncoding(Ruby runtime)

getEncodings

public org.jcodings.util.CaseInsensitiveBytesHash<org.jcodings.EncodingDB.Entry> getEncodings()

getAliases

public org.jcodings.util.CaseInsensitiveBytesHash<org.jcodings.EncodingDB.Entry> getAliases()

findEncodingEntry

public org.jcodings.EncodingDB.Entry findEncodingEntry(org.jruby.util.ByteList bytes)

findEncodingEntry

public org.jcodings.EncodingDB.Entry findEncodingEntry(byte[] bytes)

findAliasEntry

public org.jcodings.EncodingDB.Entry findAliasEntry(org.jruby.util.ByteList bytes)

findAliasEntry

public org.jcodings.EncodingDB.Entry findAliasEntry(byte[] bytes)

findEncodingOrAliasEntry

public org.jcodings.EncodingDB.Entry findEncodingOrAliasEntry(org.jruby.util.ByteList bytes)

findEncodingOrAliasEntry

public org.jcodings.EncodingDB.Entry findEncodingOrAliasEntry(byte[] bytes)

getLocaleEncoding

public org.jcodings.Encoding getLocaleEncoding()

getEncodingList

public IRubyObject[] getEncodingList()

loadEncoding

public org.jcodings.Encoding loadEncoding(org.jruby.util.ByteList name)

getEncoding

public RubyEncoding getEncoding(org.jcodings.Encoding enc)

defineEncodings

public void defineEncodings()

defineAliases

public void defineAliases()

defineEncodingConstants

private void defineEncodingConstants(Ruby runtime,
                                     RubyEncoding encoding,
                                     byte[] name,
                                     int p,
                                     int end)

defineEncodingConstant

private void defineEncodingConstant(Ruby runtime,
                                    RubyEncoding encoding,
                                    byte[] constName,
                                    int constP,
                                    int constEnd)

getDefaultExternal

public IRubyObject getDefaultExternal()

getDefaultInternal

public IRubyObject getDefaultInternal()

convertEncodingToRubyEncoding

public IRubyObject convertEncodingToRubyEncoding(org.jcodings.Encoding defaultEncoding)

getJavaDefault

public org.jcodings.Encoding getJavaDefault()

getEncodingFromObject

public org.jcodings.Encoding getEncodingFromObject(IRubyObject arg)

getEncodingFromObjectNoError

public org.jcodings.Encoding getEncodingFromObjectNoError(IRubyObject arg)

getEncodingFromObjectCommon

private org.jcodings.Encoding getEncodingFromObjectCommon(IRubyObject arg,
                                                          boolean error)

getEncodingFromNKFId

private org.jcodings.Encoding getEncodingFromNKFId(IRubyObject id)

getEncodingFromString

public org.jcodings.Encoding getEncodingFromString(java.lang.String string)

findEncoding

public org.jcodings.Encoding findEncoding(IRubyObject str)

Find an encoding given a Ruby object, coercing it to a String in the process.

Parameters:

str - the object to coerce and use to look up encoding. The coerced String must be ASCII-compatible.

Returns:

the Encoding object found, nil (for internal), or raises ArgumentError

findEncodingNoError

public org.jcodings.Encoding findEncodingNoError(IRubyObject str)

Find an encoding given a Ruby object, coercing it to a String in the process. This version does not raise a Ruby error if it can't find the encoding, and simply returns null.

Parameters:

str - the object to coerce and use to look up encoding. The coerced String must be ASCII-compatible.

Returns:

the Encoding object found, nil (for internal), or raises ArgumentError

findEncodingCommon

private org.jcodings.Encoding findEncodingCommon(IRubyObject str,
                                                 boolean error)

findEntry

public org.jcodings.EncodingDB.Entry findEntry(IRubyObject str)

Find an encoding given a Ruby object, coercing it to a String in the process.

Parameters:

str - the object to coerce and use to look up encoding. The coerced String must be ASCII-compatible.

Returns:

the Encoding object found, nil (for internal), or raises ArgumentError

rubyEncodingFromObject

public IRubyObject rubyEncodingFromObject(IRubyObject str)

charsetForEncoding

public java.nio.charset.Charset charsetForEncoding(org.jcodings.Encoding encoding)

Get a java.nio Charset for the given encoding, or null if impossible

Parameters:

encoding - the encoding

Returns:

the charset

checkAsciiEncodingName

private void checkAsciiEncodingName(org.jruby.util.ByteList name)

findEncodingWithError

public org.jcodings.Encoding findEncodingWithError(org.jruby.util.ByteList name)

Find a non-special encoding, raising argument error if it does not exist.

Parameters:

name - the name of the encoding to look up

Returns:

the Encoding object found, or raises ArgumentError

findEntryWithError

private org.jcodings.EncodingDB.Entry findEntryWithError(org.jruby.util.ByteList name)

Find a non-special encoding Entry, raising argument error if it does not exist.

Parameters:

name - the name of the encoding to look up

Returns:

the EncodingDB.Entry object found, or raises ArgumentError

findEntryFromEncoding

private org.jcodings.EncodingDB.Entry findEntryFromEncoding(org.jcodings.Encoding e)