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

Field Summary

Fields

Modifier and Type	Field and Description
static int[]	b64_xtable
static byte[]	sHexDigits

Constructor Summary

Constructors

Constructor and Description
Pack()

Method Summary

Modifier and Type	Method and Description
static void	decode(ThreadContext context, Ruby runtime, java.nio.ByteBuffer encode, int occurrences, RubyArray result, Block block, Pack.Converter converter) Deprecated.
static IRubyObject	decode(ThreadContext context, Ruby runtime, java.nio.ByteBuffer encode, int occurrences, RubyArray result, Block block, Pack.Converter converter, int mode)
static int	encode(Ruby runtime, int occurrences, ByteList result, RubyArray list, int index, org.jruby.util.Pack.ConverterExecutor converter)
static void	encodeUM(Ruby runtime, ByteList lCurElemString, int occurrences, boolean ignoreStar, char type, ByteList result)
static RubyString	pack(Ruby runtime, RubyArray list, ByteList formatString) Same as pack but defaults tainting of output to false.
static RubyString	pack(ThreadContext context, RubyArray list, RubyString formatString, RubyString buffer)
static RubyString	pack(ThreadContext context, Ruby runtime, RubyArray list, RubyString formatString) Deprecated.
static ByteList	packInt_i(ByteList result, int s)
static int	safeGet(java.nio.ByteBuffer encode)
static RubyArray	unpack(Ruby runtime, ByteList encodedString, ByteList formatString)
static RubyArray	unpack(ThreadContext context, RubyString encoded, ByteList formatString)
static IRubyObject	unpack1WithBlock(ThreadContext context, RubyString encoded, ByteList formatString, Block block)
static int	unpackInt_i(java.nio.ByteBuffer enc)
static RubyArray	unpackWithBlock(ThreadContext context, Ruby runtime, ByteList encodedString, ByteList formatString, Block block) Deprecated.
static RubyArray	unpackWithBlock(ThreadContext context, RubyString encoded, ByteList formatString, Block block) Decodes str (which may contain binary data) according to the format string, returning an array of each value extracted.
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

sHexDigits

public static final byte[] sHexDigits

b64_xtable

public static final int[] b64_xtable

Constructor Detail

Pack

public Pack()

Method Detail

unpackInt_i

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

packInt_i

public static ByteList packInt_i(ByteList result,
                                 int s)

encodeUM

public static void encodeUM(Ruby runtime,
                            ByteList lCurElemString,
                            int occurrences,
                            boolean ignoreStar,
                            char type,
                            ByteList result)

unpack

public static RubyArray unpack(Ruby runtime,
                               ByteList encodedString,
                               ByteList formatString)

unpack

public static RubyArray unpack(ThreadContext context,
                               RubyString encoded,
                               ByteList formatString)

Parameters:

context -

encoded -

formatString -

Returns:

unpacked array

See Also:

unpackWithBlock(ThreadContext, Ruby, ByteList, ByteList, Block)

unpackWithBlock

public static RubyArray unpackWithBlock(ThreadContext context,
                                        RubyString encoded,
                                        ByteList formatString,
                                        Block block)

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.
Note that if passed a block, this method will return null and instead yield results to the block. 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)

unpack1WithBlock

public static IRubyObject unpack1WithBlock(ThreadContext context,
                                           RubyString encoded,
                                           ByteList formatString,
                                           Block block)

unpackWithBlock

@Deprecated
public static RubyArray unpackWithBlock(ThreadContext context,
                                                    Ruby runtime,
                                                    ByteList encodedString,
                                                    ByteList formatString,
                                                    Block block)

Deprecated.

utf8Decode

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

rb_uv_to_utf8

safeGet

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

decode

public static IRubyObject decode(ThreadContext context,
                                 Ruby runtime,
                                 java.nio.ByteBuffer encode,
                                 int occurrences,
                                 RubyArray result,
                                 Block block,
                                 Pack.Converter converter,
                                 int mode)

encode

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

pack

public static RubyString pack(Ruby runtime,
                              RubyArray list,
                              ByteList formatString)

Same as pack but defaults tainting of output to false.

pack

@Deprecated
public static RubyString pack(ThreadContext context,
                                          Ruby runtime,
                                          RubyArray list,
                                          RubyString formatString)

Deprecated.

decode

@Deprecated
public static void decode(ThreadContext context,
                                      Ruby runtime,
                                      java.nio.ByteBuffer encode,
                                      int occurrences,
                                      RubyArray result,
                                      Block block,
                                      Pack.Converter converter)

Deprecated.

pack

public static RubyString pack(ThreadContext context,
                              RubyArray list,
                              RubyString formatString,
                              RubyString buffer)