org.jruby.util

Class Pack

java.lang.Object

org.jruby.util.Pack

public class Pack
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Pack.Converter
private static class	Pack.ConverterExecutor
private static class	Pack.QuadConverter

Field Summary

Fields

Modifier and Type	Field and Description
private static org.jcodings.specific.ASCIIEncoding	ASCII
private static byte[]	b64_table
private static int[]	b64_xtable
private static char	BE
private static Pack.Converter[]	converters
private static java.lang.String	ENDIANESS_CODES
private static byte[]	hex_table
private static int	IS_STAR
private static char	LE
private static java.lang.String	MAPPED_CODES
private static java.lang.String	NATIVE_CODES Native pack type.
private static java.lang.String	PACK_IGNORE_NULL_CODES
private static java.lang.String	PACK_IGNORE_NULL_CODES_WITH_MODIFIERS
private static java.math.BigInteger	QUAD_MAX
private static java.math.BigInteger	QUAD_MIN
private static byte[]	sHexDigits
private static byte[]	sNil10
private static byte[]	sSp10
private static java.lang.String	sTooFew
private static java.lang.String	UNPACK_IGNORE_NULL_CODES
private static org.jcodings.specific.USASCIIEncoding	USASCII
private static org.jcodings.specific.UTF8Encoding	UTF8
private static long[]	utf8_limits
private static byte[]	uu_table

Constructor Summary

Constructors

Constructor and Description
Pack()

Method Summary

Modifier and Type	Method and Description
static void	decode(Ruby runtime, java.nio.ByteBuffer encode, int occurrences, RubyArray result, Pack.Converter converter)
private static double	decodeDoubleBigEndian(java.nio.ByteBuffer encode) Decode a double in big-endian from a packed value
private static double	decodeDoubleLittleEndian(java.nio.ByteBuffer encode) Decode a double from a packed value
private static float	decodeFloatBigEndian(java.nio.ByteBuffer encode) Decode a float in big-endian from a packed value
private static float	decodeFloatLittleEndian(java.nio.ByteBuffer encode) Decode a float in little-endian from a packed value
private static int	decodeIntBigEndian(java.nio.ByteBuffer encode) Retrieve an encoded int in little endian starting at index in the string value.
private static int	decodeIntLittleEndian(java.nio.ByteBuffer encode) Retrieve an encoded int in little endian starting at index in the string value.
private static long	decodeIntUnsignedBigEndian(java.nio.ByteBuffer encode) Retrieve an encoded int in big endian starting at index in the string value.
private static long	decodeIntUnsignedLittleEndian(java.nio.ByteBuffer encode) Retrieve an encoded int in little endian starting at index in the string value.
private static long	decodeLongBigEndian(java.nio.ByteBuffer encode) Decode a long in big-endian format from a packed value
private static long	decodeLongLittleEndian(java.nio.ByteBuffer encode) Decode a long in little-endian format from a packed value
private static short	decodeShortBigEndian(java.nio.ByteBuffer encode) Decode a short in big-endian from a packed value
private static int	decodeShortLittleEndian(java.nio.ByteBuffer encode) Decode a short in little-endian from a packed value
private static int	decodeShortUnsignedBigEndian(java.nio.ByteBuffer encode) Decode a short in big-endian from a packed value
private static int	decodeShortUnsignedLittleEndian(java.nio.ByteBuffer encode) Decode a short in little-endian from a packed value
static int	encode(Ruby runtime, int occurrences, org.jruby.util.ByteList result, RubyArray list, int index, Pack.ConverterExecutor converter)
private static void	encodeDoubleBigEndian(org.jruby.util.ByteList result, double d) Encode a double in big-endian format into a packed value
private static void	encodeDoubleLittleEndian(org.jruby.util.ByteList result, double d) Encode a double in little endian format into a packed value
private static void	encodeFloatBigEndian(org.jruby.util.ByteList result, float f) Encode a float in big-endian format into a packed value
private static void	encodeFloatLittleEndian(org.jruby.util.ByteList result, float f) Encode a float in little endian format into a packed value
private static void	encodeIntBigEndian(org.jruby.util.ByteList result, int s) Encode an int in big-endian format into a packed representation.
private static void	encodeIntLittleEndian(org.jruby.util.ByteList result, int s) Encode an int in little endian format into a packed representation.
private static void	encodeLongBigEndian(org.jruby.util.ByteList result, long l) Encode a long in big-endian format into a packed value
private static void	encodeLongLittleEndian(org.jruby.util.ByteList result, long l) Encode a long in little-endian format into a packed value
private static org.jruby.util.ByteList	encodes(Ruby runtime, org.jruby.util.ByteList io2Append, byte[] charsToEncode, int startIndex, int length, int charCount, byte encodingType, boolean tailLf) encodes a String in base64 or its uuencode variant.
private static void	encodeShortBigEndian(org.jruby.util.ByteList result, int s) Encode an shortin big-endian format into a packed representation.
private static void	encodeShortLittleEndian(org.jruby.util.ByteList result, int s) Encode an short in little endian format into a packed representation.
private static Pack.ConverterExecutor	executor18()
private static Pack.ConverterExecutor	executor19()
private static org.jruby.util.ByteList	grow(org.jruby.util.ByteList i2Grow, byte[] iPads, int iLength) grows a stringbuffer.
private static long	num2quad(IRubyObject arg)
private static long	num2quad19(IRubyObject arg)
private static double	obj2dbl(Ruby runtime, IRubyObject o)
private static double	obj2dbl19(Ruby runtime, IRubyObject o)
private static float	obj2flt(Ruby runtime, IRubyObject o)
private static float	obj2flt19(Ruby runtime, IRubyObject o)
static RubyString	pack(Ruby runtime, RubyArray list, org.jruby.util.ByteList formatString) Same as pack(Ruby, RubyArray, ByteList) but defaults tainting of output to false.
static RubyString	pack(Ruby runtime, RubyArray list, org.jruby.util.ByteList formatString, boolean taint) pack_pack Template characters for Array#pack Directive Meaning Packs the contents of arr into a binary sequence according to the directives in aTemplateString (see preceding table).
static RubyString	pack19(ThreadContext context, Ruby runtime, RubyArray list, RubyString formatString)
private static RubyString	packCommon(Ruby runtime, RubyArray list, org.jruby.util.ByteList formatString, boolean tainted, Pack.ConverterExecutor executor)
static org.jruby.util.ByteList	packInt_i(org.jruby.util.ByteList result, int s)
private static org.jruby.util.ByteList	qpencode(org.jruby.util.ByteList io2Append, org.jruby.util.ByteList i2Encode, int iLength) encodes a String with the Quoted printable, MIME encoding (see RFC2045).
private static int	safeGet(java.nio.ByteBuffer encode)
private static int	safeGetIgnoreNull(java.nio.ByteBuffer encode)
private static org.jruby.util.ByteList	shrink(org.jruby.util.ByteList i2Shrink, int iLength) shrinks a stringbuffer.
private static double	str2dbl(Ruby runtime, RubyString o)
static RubyArray	unpack(Ruby runtime, org.jruby.util.ByteList encodedString, org.jruby.util.ByteList formatString) Decodes str (which may contain binary data) according to the format string, returning an array of each value extracted.
static int	unpackInt_i(java.nio.ByteBuffer enc)
private static int	utf8Decode(java.nio.ByteBuffer buffer) utf8_to_uv
static int	utf8Decode(Ruby runtime, byte[] to, int p, int code) rb_uv_to_utf8

Methods inherited from class java.lang.Object

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

Field Detail

sSp10

private static final byte[] sSp10

sNil10

private static final byte[] sNil10

IS_STAR

private static final int IS_STAR

See Also:

Constant Field Values

ASCII

private static final org.jcodings.specific.ASCIIEncoding ASCII

USASCII

private static final org.jcodings.specific.USASCIIEncoding USASCII

UTF8

private static final org.jcodings.specific.UTF8Encoding UTF8

NATIVE_CODES

private static final java.lang.String NATIVE_CODES

Native pack type.

See Also:

Constant Field Values

MAPPED_CODES

private static final java.lang.String MAPPED_CODES

See Also:

Constant Field Values

BE

private static final char BE

See Also:

Constant Field Values

LE

private static final char LE

See Also:

Constant Field Values

ENDIANESS_CODES

private static final java.lang.String ENDIANESS_CODES

UNPACK_IGNORE_NULL_CODES

private static final java.lang.String UNPACK_IGNORE_NULL_CODES

See Also:

Constant Field Values

PACK_IGNORE_NULL_CODES

private static final java.lang.String PACK_IGNORE_NULL_CODES

See Also:

Constant Field Values

PACK_IGNORE_NULL_CODES_WITH_MODIFIERS

private static final java.lang.String PACK_IGNORE_NULL_CODES_WITH_MODIFIERS

See Also:

Constant Field Values

sTooFew

private static final java.lang.String sTooFew

See Also:

Constant Field Values

hex_table

private static final byte[] hex_table

uu_table

private static final byte[] uu_table

b64_table

private static final byte[] b64_table

sHexDigits

private static final byte[] sHexDigits

b64_xtable

private static final int[] b64_xtable

converters

private static final Pack.Converter[] converters

QUAD_MIN

private static final java.math.BigInteger QUAD_MIN

QUAD_MAX

private static final java.math.BigInteger QUAD_MAX

utf8_limits

private static final long[] utf8_limits

Constructor Detail

Pack

public Pack()

Method Detail

num2quad

private static long num2quad(IRubyObject arg)

num2quad19

private static long num2quad19(IRubyObject arg)

obj2flt

private static float obj2flt(Ruby runtime,
                             IRubyObject o)

obj2flt19

private static float obj2flt19(Ruby runtime,
                               IRubyObject o)

str2dbl

private static double str2dbl(Ruby runtime,
                              RubyString o)

obj2dbl

private static double obj2dbl(Ruby runtime,
                              IRubyObject o)

obj2dbl19

private static double obj2dbl19(Ruby runtime,
                                IRubyObject o)

unpackInt_i

public static int unpackInt_i(java.nio.ByteBuffer enc)

packInt_i

public static org.jruby.util.ByteList packInt_i(org.jruby.util.ByteList result,
                                                int s)

encodes

private static org.jruby.util.ByteList encodes(Ruby runtime,
                                               org.jruby.util.ByteList io2Append,
                                               byte[] charsToEncode,
                                               int startIndex,
                                               int length,
                                               int charCount,
                                               byte encodingType,
                                               boolean tailLf)

encodes a String in base64 or its uuencode variant. appends the result of the encoding in a StringBuffer

Parameters:

io2Append - The StringBuffer which should receive the result

i2Encode - The String to encode

iLength - The max number of characters to encode

iType - the type of encoding required (this is the same type as used by the pack method)

tailLf - true if the traililng "\n" is needed

Returns:

the io2Append buffer

qpencode

private static org.jruby.util.ByteList qpencode(org.jruby.util.ByteList io2Append,
                                                org.jruby.util.ByteList i2Encode,
                                                int iLength)

encodes a String with the Quoted printable, MIME encoding (see RFC2045). appends the result of the encoding in a StringBuffer

Parameters:

io2Append - The StringBuffer which should receive the result

i2Encode - The String to encode

iLength - The max number of characters to encode

Returns:

the io2Append buffer

unpack

public static RubyArray unpack(Ruby runtime,
                               org.jruby.util.ByteList encodedString,
                               org.jruby.util.ByteList formatString)

Decodes str (which may contain binary data) according to the format string, returning an array of each value extracted. The format string consists of a sequence of single-character directives.
Each directive may be followed by a number, indicating the number of times to repeat with this directive. An asterisk (``*'') will use up all remaining elements.
The directives sSiIlL may each be followed by an underscore (``_'') to use the underlying platform's native size for the specified type; otherwise, it uses a platform-independent consistent size.
Spaces are ignored in the format string.

Directives for String#unpack Format Function Returns A String with trailing nulls and spaces removed. String a String. String B Extract bits from each character (msb first). String b Extract bits from each character (lsb first). String C Extract a character as an unsigned integer. Fixnum c Extract a character as an integer. Fixnum d Treat sizeof(double) characters as a native double. Float E Treat sizeof(double) characters as a double in little-endian byte order. Float e Treat sizeof(float) characters as a float in little-endian byte order. Float f Treat sizeof(float) characters as a native float. Float G Treat sizeof(double) characters as a double in network byte order. Float g Treat sizeof(float) characters as a float in network byte order. Float H Extract hex nibbles from each character (most significant first). String h Extract hex nibbles from each character (least significant first). String I Treat sizeof(int) 1 successive characters as an unsigned native integer. Integer i Treat sizeof(int) 1 successive characters as a signed native integer. Integer L Treat four1 successive characters as an unsigned native long integer. Integer l Treat four1 successive characters as a signed native long integer. Integer M Extract a quoted-printable string. String m Extract a base64 encoded string. String N Treat four characters as an unsigned long in network byte order. Fixnum n Treat two characters as an unsigned short in network byte order. Fixnum P Treat sizeof(char *) characters as a pointer, and return len characters from the referenced location. String p Treat sizeof(char *) characters as a pointer to a null-terminated string. String S Treat two1 successive characters as an unsigned short in native byte order. Fixnum s Treat two1 successive characters as a signed short in native byte order. Fixnum U Extract UTF-8 characters as unsigned integers. Integer u Extract a UU-encoded string. String V Treat four characters as an unsigned long in little-endian byte order. Fixnum v Treat two characters as an unsigned short in little-endian byte order. Fixnum X Skip backward one character. --- x Skip forward one character. --- Z String with trailing nulls removed. String @ Skip to the offset given by the length argument. --- 1 May be modified by appending ``_'' to the directive.

See Also:

RubyArray.pack(org.jruby.runtime.ThreadContext, org.jruby.runtime.builtin.IRubyObject)

utf8Decode

public static int utf8Decode(Ruby runtime,
                             byte[] to,
                             int p,
                             int code)

rb_uv_to_utf8

utf8Decode

private static int utf8Decode(java.nio.ByteBuffer buffer)

utf8_to_uv

safeGet

private static int safeGet(java.nio.ByteBuffer encode)

safeGetIgnoreNull

private static int safeGetIgnoreNull(java.nio.ByteBuffer encode)

decode

public static void decode(Ruby runtime,
                          java.nio.ByteBuffer encode,
                          int occurrences,
                          RubyArray result,
                          Pack.Converter converter)

encode

public static int encode(Ruby runtime,
                         int occurrences,
                         org.jruby.util.ByteList result,
                         RubyArray list,
                         int index,
                         Pack.ConverterExecutor converter)

executor18

private static Pack.ConverterExecutor executor18()

executor19

private static Pack.ConverterExecutor executor19()

shrink

private static final org.jruby.util.ByteList shrink(org.jruby.util.ByteList i2Shrink,
                                                    int iLength)

shrinks a stringbuffer. shrinks a stringbuffer by a number of characters.

Parameters:

i2Shrink - the stringbuffer

iLength - how much to shrink

Returns:

the stringbuffer

grow

private static final org.jruby.util.ByteList grow(org.jruby.util.ByteList i2Grow,
                                                  byte[] iPads,
                                                  int iLength)

grows a stringbuffer. uses the Strings to pad the buffer for a certain length

Parameters:

i2Grow - the buffer to grow

iPads - the string used as padding

iLength - how much padding is needed

Returns:

the padded buffer

pack

public static RubyString pack(Ruby runtime,
                              RubyArray list,
                              org.jruby.util.ByteList formatString,
                              boolean taint)

pack_pack Template characters for Array#pack Directive Meaning Packs the contents of arr into a binary sequence according to the directives in aTemplateString (see preceding table). Directives ``A,'' ``a,'' and ``Z'' may be followed by a count, which gives the width of the resulting field. The remaining directives also may take a count, indicating the number of array elements to convert. If the count is an asterisk (``*''] = all remaining array elements will be converted. Any of the directives ``sSiIlL'' may be followed by an underscore (``_'') to use the underlying platform's native size for the specified type; otherwise, they use a platform-independent size. Spaces are ignored in the template string.

Directive	Meaning
@	Moves to absolute position
A	ASCII string (space padded, count is width)
a	ASCII string (null padded, count is width)
B	Bit string (descending bit order)
b	Bit string (ascending bit order)
C	Unsigned char
c	Char
d	Double-precision float, native format
E	Double-precision float, little-endian byte order
e	Single-precision float, little-endian byte order
f	Single-precision float, native format
G	Double-precision float, network (big-endian) byte order
g	Single-precision float, network (big-endian) byte order
H	Hex string (high nibble first)
h	Hex string (low nibble first)
I	Unsigned integer
i	Integer
L	Unsigned long
l	Long
M	Quoted printable, MIME encoding (see RFC2045)
m	Base64 encoded string
N	Long, network (big-endian) byte order
n	Short, network (big-endian) byte-order
P	Pointer to a structure (fixed-length string)
p	Pointer to a null-terminated string
Q	Unsigned 64-bit number
q	64-bit number
S	Unsigned short
s	Short
U	UTF-8
u	UU-encoded string
V	Long, little-endian byte order
v	Short, little-endian byte order
X	Back up a byte
x	Null byte
Z	Same as ``A''

See Also:

RubyString.unpack(org.jruby.runtime.builtin.IRubyObject)

pack

public static RubyString pack(Ruby runtime,
                              RubyArray list,
                              org.jruby.util.ByteList formatString)

Same as pack(Ruby, RubyArray, ByteList) but defaults tainting of output to false.

pack19

public static RubyString pack19(ThreadContext context,
                                Ruby runtime,
                                RubyArray list,
                                RubyString formatString)

packCommon

private static RubyString packCommon(Ruby runtime,
                                     RubyArray list,
                                     org.jruby.util.ByteList formatString,
                                     boolean tainted,
                                     Pack.ConverterExecutor executor)

decodeIntLittleEndian

private static int decodeIntLittleEndian(java.nio.ByteBuffer encode)

Retrieve an encoded int in little endian starting at index in the string value.

Parameters:

encode - string to get int from

Returns:

the decoded integer

decodeIntBigEndian

private static int decodeIntBigEndian(java.nio.ByteBuffer encode)

Retrieve an encoded int in little endian starting at index in the string value.

Parameters:

encode - string to get int from

Returns:

the decoded integer

decodeIntUnsignedBigEndian

private static long decodeIntUnsignedBigEndian(java.nio.ByteBuffer encode)

Retrieve an encoded int in big endian starting at index in the string value.

Parameters:

encode - string to get int from

Returns:

the decoded integer

decodeIntUnsignedLittleEndian

private static long decodeIntUnsignedLittleEndian(java.nio.ByteBuffer encode)

Retrieve an encoded int in little endian starting at index in the string value.

Parameters:

encode - the encoded string

Returns:

the decoded integer

encodeIntLittleEndian

private static void encodeIntLittleEndian(org.jruby.util.ByteList result,
                                          int s)

Encode an int in little endian format into a packed representation.

Parameters:

result - to be appended to

s - the integer to encode

encodeIntBigEndian

private static void encodeIntBigEndian(org.jruby.util.ByteList result,
                                       int s)

Encode an int in big-endian format into a packed representation.

Parameters:

result - to be appended to

s - the integer to encode

decodeLongBigEndian

private static long decodeLongBigEndian(java.nio.ByteBuffer encode)

Decode a long in big-endian format from a packed value

Parameters:

encode - string to get int from

Returns:

the long value

decodeLongLittleEndian

private static long decodeLongLittleEndian(java.nio.ByteBuffer encode)

Decode a long in little-endian format from a packed value

Parameters:

encode - string to get int from

Returns:

the long value

encodeLongLittleEndian

private static void encodeLongLittleEndian(org.jruby.util.ByteList result,
                                           long l)

Encode a long in little-endian format into a packed value

Parameters:

result - to pack long into

l - is the long to encode

encodeLongBigEndian

private static void encodeLongBigEndian(org.jruby.util.ByteList result,
                                        long l)

Encode a long in big-endian format into a packed value

Parameters:

result - to pack long into

l - is the long to encode

decodeDoubleLittleEndian

private static double decodeDoubleLittleEndian(java.nio.ByteBuffer encode)

Decode a double from a packed value

Parameters:

encode - string to get int from

Returns:

the double value

decodeDoubleBigEndian

private static double decodeDoubleBigEndian(java.nio.ByteBuffer encode)

Decode a double in big-endian from a packed value

Parameters:

encode - string to get int from

Returns:

the double value

encodeDoubleLittleEndian

private static void encodeDoubleLittleEndian(org.jruby.util.ByteList result,
                                             double d)

Encode a double in little endian format into a packed value

Parameters:

result - to pack double into

d - is the double to encode

encodeDoubleBigEndian

private static void encodeDoubleBigEndian(org.jruby.util.ByteList result,
                                          double d)

Encode a double in big-endian format into a packed value

Parameters:

result - to pack double into

d - is the double to encode

decodeFloatBigEndian

private static float decodeFloatBigEndian(java.nio.ByteBuffer encode)

Decode a float in big-endian from a packed value

Parameters:

encode - string to get int from

Returns:

the double value

decodeFloatLittleEndian

private static float decodeFloatLittleEndian(java.nio.ByteBuffer encode)

Decode a float in little-endian from a packed value

Parameters:

encode - string to get int from

Returns:

the double value

encodeFloatLittleEndian

private static void encodeFloatLittleEndian(org.jruby.util.ByteList result,
                                            float f)

Encode a float in little endian format into a packed value

Parameters:

result - to pack float into

f - is the float to encode

encodeFloatBigEndian

private static void encodeFloatBigEndian(org.jruby.util.ByteList result,
                                         float f)

Encode a float in big-endian format into a packed value

Parameters:

result - to pack float into

f - is the float to encode

decodeShortUnsignedLittleEndian

private static int decodeShortUnsignedLittleEndian(java.nio.ByteBuffer encode)

Decode a short in little-endian from a packed value

Parameters:

encode - string to get int from

Returns:

the short value

decodeShortUnsignedBigEndian

private static int decodeShortUnsignedBigEndian(java.nio.ByteBuffer encode)

Decode a short in big-endian from a packed value

Parameters:

encode - string to get int from

Returns:

the short value

decodeShortLittleEndian

private static int decodeShortLittleEndian(java.nio.ByteBuffer encode)

Decode a short in little-endian from a packed value

Parameters:

encode - string to get int from

Returns:

the short value

decodeShortBigEndian

private static short decodeShortBigEndian(java.nio.ByteBuffer encode)

Decode a short in big-endian from a packed value

Parameters:

encode - string to get int from

Returns:

the short value

encodeShortLittleEndian

private static void encodeShortLittleEndian(org.jruby.util.ByteList result,
                                            int s)

Encode an short in little endian format into a packed representation.

Parameters:

result - to be appended to

s - the short to encode

encodeShortBigEndian

private static void encodeShortBigEndian(org.jruby.util.ByteList result,
                                         int s)

Encode an shortin big-endian format into a packed representation.

Parameters:

result - to be appended to

s - the short to encode