org.python.modules.struct Maven / Gradle / Ivy
Show all versions of jython-slim Show documentation
// (c)2019 Jython Developers. Licensed to PSF under a Contributor Agreement.
//
// First Java version copyright 1999 Finn Bock also contains material Copyright 1991-1995 by
// Stichting Mathematisch Centrum, Amsterdam, The Netherlands.
package org.python.modules;
import org.python.core.ClassDictInit;
import org.python.core.Py;
import org.python.core.Py2kBuffer;
import org.python.core.PyArray;
import org.python.core.PyByteArray;
import org.python.core.PyException;
import org.python.core.PyFloat;
import org.python.core.PyList;
import org.python.core.PyLong;
import org.python.core.PyObject;
import org.python.core.PyString;
import org.python.core.PyStringMap;
import org.python.core.PyTuple;
import java.math.BigInteger;
//@formatter:off
/**
* This module performs conversions between Python values and C
* structs represented as Python strings. It uses format strings
* (explained below) as compact descriptions of the lay-out of the C
* structs and the intended conversion to/from Python values.
*
*
* The module defines the following exception and functions:
*
* - error
* -
* Exception raised on various occasions; argument is a string
* describing what is wrong.
*
* - pack (fmt, v1, v2, ...)
* -
* Return a string containing the values
* v1, v2, ... packed according to the given
* format. The arguments must match the values required by the format
* exactly.
*
* - unpack (fmt, string)
* -
* Unpack the string (presumably packed by pack(fmt,
* ...)) according to the given format. The result is a
* tuple even if it contains exactly one item. The string must contain
* exactly the amount of data required by the format (i.e.
* len(string) must equal calcsize(fmt)).
*
* - calcsize (fmt)
* -
* Return the size of the struct (and hence of the string)
* corresponding to the given format.
*
*
* Format characters have the following meaning; the conversion between
* C and Python values should be obvious given their types:
*
* Format characters
* Format
* C Type
* Python
* {@code x}
* pad byte
* no value
* {@code c}
* char
* string of length 1
* {@code b}
* signed char
* integer
* {@code B}
* unsigned char
* integer
* {@code h}
* short
* integer
* {@code H}
* unsigned short
* integer
* {@code i}
* int
* integer
* {@code I}
* unsigned int
* integer
* {@code size}
* long
* integer
* {@code L}
* unsigned long
* integer
* {@code f}
* float
* float
* {@code d}
* double
* float
* {@code s}
* char[]
* string
* {@code p}
* char[]
* string
*
*
*
* A format character may be preceded by an integral repeat count;
* e.g. the format string '4h' means exactly the same as
* 'hhhh'.
*
*
* Whitespace characters between formats are ignored; a count and its
* format must not contain whitespace though.
*
*
* For the "s" format character, the count is interpreted as the
* size of the string, not a repeat count like for the other format
* characters; e.g. '10s' means a single 10-byte string, while
* '10c' means 10 characters. For packing, the string is
* truncated or padded with null bytes as appropriate to make it fit.
* For unpacking, the resulting string always has exactly the specified
* number of bytes. As a special case, '0s' means a single, empty
* string (while '0c' means 0 characters).
*
*
* The "p" format character can be used to encode a Pascal
* string. The first byte is the length of the stored string, with the
* bytes of the string following. If count is given, it is used as the
* total number of bytes used, including the length byte. If the string
* passed in to pack() is too long, the stored representation
* is truncated. If the string is too short, padding is used to ensure
* that exactly enough bytes are used to satisfy the count.
*
*
* For the "I" and "L" format characters, the return
* value is a Python long integer.
*
*
* By default, C numbers are represented in the machine's native format
* and byte order, and properly aligned by skipping pad bytes if
* necessary (according to the rules used by the C compiler).
*
*
* Alternatively, the first character of the format string can be used to
* indicate the byte order, size and alignment of the packed data,
* according to the following table:
*
*
*
* Byte order and alignment characters
* Character
* Byte order
* Size and alignment
* {@code @}
* native
* native
* {@code =}
* native
* standard
* {@code <}
* little-endian
* standard
* {@code >}
* big-endian
* standard
* {@code !}
* network (= big-endian)
* standard
*
*
*
*
* If the first character is not one of these, "@" is assumed.
*
*
* Native byte order is big-endian or little-endian, depending on the
* host system (e.g. Motorola and Sun are big-endian; Intel and DEC are
* little-endian).
*
*
* Native size and alignment are defined as follows: short is
* 2 bytes; int and long are 4 bytes; float
* are 4 bytes and double are 8 bytes. Native byte order is
* chosen as big-endian.
*
*
* Standard size and alignment are as follows: no alignment is required
* for any type (so you have to use pad bytes); short is 2 bytes;
* int and long are 4 bytes. float and
* double are 32-bit and 64-bit IEEE floating point numbers,
* respectively.
*
*
* Note the difference between "@" and "=": both use
* native byte order, but the size and alignment of the latter is
* standardized.
*
*
* The form "!" is available for those poor souls who claim they
* can't remember whether network byte order is big-endian or
* little-endian.
*
*
* There is no way to indicate non-native byte order (i.e. force
* byte-swapping); use the appropriate choice of "<" or
* ">".
*
*
* Examples (all using native byte order, size and alignment, on a
* big-endian machine):
{@literal
* >>> from struct import *
* >>> pack('hhl', 1, 2, 3)
* '\000\001\000\002\000\000\000\003'
* >>> unpack('hhl', '\000\001\000\002\000\000\000\003')
* (1, 2, 3)
* >>> calcsize('hhl')
* 8
* >>>
* }
*
*
* Hint: to align the end of a structure to the alignment requirement of
* a particular type, end the format with the code for that type with a
* repeat count of zero, e.g. the format 'llh0l' specifies two
* pad bytes at the end, assuming longs are aligned on 4-byte boundaries.
* This only works when native size and alignment are in effect;
* standard size and alignment does not enforce any alignment.
*
* For the complete documentation on the struct module, please see the
* "Python Library Reference"
*
*
* The module is based on the original structmodule.c except that all
* mistakes and errors are my own. Original author unknown.
*
* @author Finn Bock, [email protected]
* @version struct.java,v 1.6 1999/04/17 12:04:34 fb Exp
*/
//@formatter:on
public class struct implements ClassDictInit {
/** Exception raised on various occasions; argument is a string describing what is wrong. */
public static final PyObject error = Py.makeClass("error", Py.Exception, exceptionNamespace());
//@formatter:off
public static String __doc__ =
"Functions to convert between Python values and C structs.\n" +
"Python strings are used to hold the data representing the C\n" +
"struct and also as format strings to describe the layout of\n" +
"data in the C struct.\n" +
"\n" +
"The optional first format char indicates byte ordering and\n" +
"alignment:\n" +
" @: native w/native alignment(default)\n" +
" =: native w/standard alignment\n" +
" <: little-endian, std. alignment\n" +
" >: big-endian, std. alignment\n" +
" !: network, std (same as >)\n" +
"\n" +
"The remaining chars indicate types of args and must match\n" +
"exactly; these can be preceded by a decimal repeat count:\n" +
" x: pad byte (no data); c:char; b:signed byte; B:unsigned byte;\n" +
" h:short; H:unsigned short; i:int; I:unsigned int;\n" +
" l:long; L:unsigned long; f:float; d:double.\n" +
"Special cases (preceding decimal count indicates length):\n" +
" s:string (array of char); p: pascal string (w. count byte).\n" +
"Whitespace between formats is ignored.\n" +
"\n" +
"The variable struct.error is an exception raised on errors.";
//@formatter:on
static class FormatDef {
char name;
int size;
int alignment;
FormatDef init(char name, int size, int alignment) {
this.name = name;
this.size = size;
this.alignment = alignment;
return this;
}
void pack(ByteStream buf, PyObject value) {}
Object unpack(ByteStream buf) {
return null;
}
int doPack(ByteStream buf, int count, int pos, PyObject[] args) {
if (pos + count > args.length) {
throw StructError("insufficient arguments to pack");
}
int cnt = count;
while (count-- > 0) {
pack(buf, args[pos++]);
}
return cnt;
}
void doUnpack(ByteStream buf, int count, PyList list) {
while (count-- > 0) {
list.append(Py.java2py(unpack(buf)));
}
}
int get_int(PyObject value) {
try {
return value.asInt();
} catch (PyException ex) {
throw StructError("required argument is not an integer");
}
}
long get_long(PyObject value) {
if (value instanceof PyLong) {
Object v = value.__tojava__(Long.TYPE);
if (v == Py.NoConversion) {
throw StructError("long int too long to convert");
}
return ((Long) v).longValue();
} else {
return get_int(value);
}
}
BigInteger get_ulong(PyObject value) {
if (value instanceof PyLong) {
BigInteger v = (BigInteger) value.__tojava__(BigInteger.class);
if (v.compareTo(PyLong.MAX_ULONG) > 0) {
throw StructError("unsigned long int too long to convert");
}
return v;
} else {
return BigInteger.valueOf(get_int(value));
}
}
double get_float(PyObject value) {
return value.asDouble();
}
void BEwriteInt(ByteStream buf, int v) {
buf.writeByte((v >>> 24) & 0xFF);
buf.writeByte((v >>> 16) & 0xFF);
buf.writeByte((v >>> 8) & 0xFF);
buf.writeByte((v >>> 0) & 0xFF);
}
void LEwriteInt(ByteStream buf, int v) {
buf.writeByte((v >>> 0) & 0xFF);
buf.writeByte((v >>> 8) & 0xFF);
buf.writeByte((v >>> 16) & 0xFF);
buf.writeByte((v >>> 24) & 0xFF);
}
int BEreadInt(ByteStream buf) {
int b1 = buf.readByte();
int b2 = buf.readByte();
int b3 = buf.readByte();
int b4 = buf.readByte();
return ((b1 << 24) + (b2 << 16) + (b3 << 8) + (b4 << 0));
}
int LEreadInt(ByteStream buf) {
int b1 = buf.readByte();
int b2 = buf.readByte();
int b3 = buf.readByte();
int b4 = buf.readByte();
return ((b1 << 0) + (b2 << 8) + (b3 << 16) + (b4 << 24));
}
}
static class ByteStream {
char[] data;
int len;
int pos;
ByteStream() {
data = new char[10];
len = 0;
pos = 0;
}
ByteStream(String s) {
this(s, 0);
}
ByteStream(String s, int offset) {
int size = s.length() - offset;
data = new char[size];
s.getChars(offset, s.length(), data, 0);
len = size;
pos = 0;
// System.out.println("s.length()=" + s.length() + ",offset=" + offset + ",size=" + size + ",data="
// + Arrays.toString(data));
}
int readByte() {
return data[pos++] & 0xFF;
}
void read(char[] buf, int pos, int len) {
System.arraycopy(data, this.pos, buf, pos, len);
this.pos += len;
}
String readString(int l) {
char[] data = new char[l];
read(data, 0, l);
return new String(data);
}
private void ensureCapacity(int l) {
if (pos + l >= data.length) {
char[] b = new char[(pos + l) * 2];
System.arraycopy(data, 0, b, 0, pos);
data = b;
}
}
void writeByte(int b) {
ensureCapacity(1);
data[pos++] = (char) (b & 0xFF);
}
void write(char[] buf, int pos, int len) {
ensureCapacity(len);
System.arraycopy(buf, pos, data, this.pos, len);
this.pos += len;
}
void writeString(String s, int pos, int len) {
char[] data = new char[len];
s.getChars(pos, len, data, 0);
write(data, 0, len);
}
int skip(int l) {
pos += l;
return pos;
}
int size() {
return pos;
}
@Override
public String toString() {
return new String(data, 0, pos);
}
}
static class PadFormatDef extends FormatDef {
@Override
int doPack(ByteStream buf, int count, int pos, PyObject[] args) {
while (count-- > 0) {
buf.writeByte(0);
}
return 0;
}
@Override
void doUnpack(ByteStream buf, int count, PyList list) {
while (count-- > 0) {
buf.readByte();
}
}
}
static class StringFormatDef extends FormatDef {
@Override
int doPack(ByteStream buf, int count, int pos, PyObject[] args) {
PyObject value = args[pos];
if (!(value instanceof PyString)) {
throw StructError("argument for 's' must be a string");
}
String s = value.toString();
int len = s.length();
buf.writeString(s, 0, Math.min(count, len));
if (len < count) {
count -= len;
for (int i = 0; i < count; i++) {
buf.writeByte(0);
}
}
return 1;
}
@Override
void doUnpack(ByteStream buf, int count, PyList list) {
list.append(Py.newString(buf.readString(count)));
}
}
static class PascalStringFormatDef extends StringFormatDef {
@Override
int doPack(ByteStream buf, int count, int pos, PyObject[] args) {
PyObject value = args[pos];
if (!(value instanceof PyString)) {
throw StructError("argument for 'p' must be a string");
}
buf.writeByte(Math.min(0xFF, Math.min(value.toString().length(), count - 1)));
return super.doPack(buf, count - 1, pos, args);
}
@Override
void doUnpack(ByteStream buf, int count, PyList list) {
int n = buf.readByte();
if (n >= count) {
n = count - 1;
}
super.doUnpack(buf, n, list);
buf.skip(Math.max(count - n - 1, 0));
}
}
static class CharFormatDef extends FormatDef {
@Override
void pack(ByteStream buf, PyObject value) {
if (!(value instanceof PyString) || value.__len__() != 1) {
throw StructError("char format require string of length 1");
}
buf.writeByte(value.toString().charAt(0));
}
@Override
Object unpack(ByteStream buf) {
return Py.newString((char) buf.readByte());
}
}
static class ByteFormatDef extends FormatDef {
@Override
void pack(ByteStream buf, PyObject value) {
buf.writeByte(get_int(value));
}
@Override
Object unpack(ByteStream buf) {
int b = buf.readByte();
if (b > Byte.MAX_VALUE) {
b -= 0x100;
}
return Py.newInteger(b);
}
}
static class UnsignedByteFormatDef extends ByteFormatDef {
@Override
Object unpack(ByteStream buf) {
return Py.newInteger(buf.readByte());
}
}
static class PointerFormatDef extends FormatDef {
FormatDef init(char name) {
String dataModel = System.getProperty("sun.arch.data.model");
if (dataModel == null) {
throw Py.NotImplementedError("Can't determine if JVM is 32- or 64-bit");
}
int length = dataModel.equals("64") ? 8 : 4;
super.init(name, length, length);
return this;
}
@Override
void pack(ByteStream buf, PyObject value) {
throw Py.NotImplementedError("Pointer packing/unpacking not implemented in Jython");
}
@Override
Object unpack(ByteStream buf) {
throw Py.NotImplementedError("Pointer packing/unpacking not implemented in Jython");
}
}
static class LEShortFormatDef extends FormatDef {
@Override
void pack(ByteStream buf, PyObject value) {
int v = get_int(value);
buf.writeByte(v & 0xFF);
buf.writeByte((v >> 8) & 0xFF);
}
@Override
Object unpack(ByteStream buf) {
int v = buf.readByte() | (buf.readByte() << 8);
if (v > Short.MAX_VALUE) {
v -= 0x10000;
}
return Py.newInteger(v);
}
}
static class LEUnsignedShortFormatDef extends LEShortFormatDef {
@Override
Object unpack(ByteStream buf) {
int v = buf.readByte() | (buf.readByte() << 8);
return Py.newInteger(v);
}
}
static class BEShortFormatDef extends FormatDef {
@Override
void pack(ByteStream buf, PyObject value) {
int v = get_int(value);
buf.writeByte((v >> 8) & 0xFF);
buf.writeByte(v & 0xFF);
}
@Override
Object unpack(ByteStream buf) {
int v = (buf.readByte() << 8) | buf.readByte();
if (v > Short.MAX_VALUE) {
v -= 0x10000;
}
return Py.newInteger(v);
}
}
static class BEUnsignedShortFormatDef extends BEShortFormatDef {
@Override
Object unpack(ByteStream buf) {
int v = (buf.readByte() << 8) | buf.readByte();
return Py.newInteger(v);
}
}
static class LEIntFormatDef extends FormatDef {
@Override
void pack(ByteStream buf, PyObject value) {
LEwriteInt(buf, get_int(value));
}
@Override
Object unpack(ByteStream buf) {
int v = LEreadInt(buf);
return Py.newInteger(v);
}
}
static class LEUnsignedIntFormatDef extends FormatDef {
@Override
void pack(ByteStream buf, PyObject value) {
LEwriteInt(buf, (int) (get_long(value) & 0xFFFFFFFF));
}
@Override
Object unpack(ByteStream buf) {
long v = LEreadInt(buf);
if (v < 0) {
v += 0x100000000L;
}
return new PyLong(v);
}
}
static class BEIntFormatDef extends FormatDef {
@Override
void pack(ByteStream buf, PyObject value) {
BEwriteInt(buf, get_int(value));
}
@Override
Object unpack(ByteStream buf) {
return Py.newInteger(BEreadInt(buf));
}
}
static class BEUnsignedIntFormatDef extends FormatDef {
@Override
void pack(ByteStream buf, PyObject value) {
BEwriteInt(buf, (int) (get_long(value) & 0xFFFFFFFF));
}
@Override
Object unpack(ByteStream buf) {
long v = BEreadInt(buf);
if (v < 0) {
v += 0x100000000L;
}
return new PyLong(v);
}
}
static class LEUnsignedLongFormatDef extends FormatDef {
@Override
void pack(ByteStream buf, PyObject value) {
BigInteger bi = get_ulong(value);
if (bi.compareTo(BigInteger.valueOf(0)) < 0) {
throw StructError("can't convert negative long to unsigned");
}
long lvalue = bi.longValue(); // underflow is OK -- the bits are correct
int high = (int) ((lvalue & 0xFFFFFFFF00000000L) >> 32);
int low = (int) (lvalue & 0x00000000FFFFFFFFL);
LEwriteInt(buf, low);
LEwriteInt(buf, high);
}
@Override
Object unpack(ByteStream buf) {
long low = (LEreadInt(buf) & 0X00000000FFFFFFFFL);
long high = (LEreadInt(buf) & 0X00000000FFFFFFFFL);
java.math.BigInteger result = java.math.BigInteger.valueOf(high);
result = result.multiply(java.math.BigInteger.valueOf(0x100000000L));
result = result.add(java.math.BigInteger.valueOf(low));
return new PyLong(result);
}
}
static class BEUnsignedLongFormatDef extends FormatDef {
@Override
void pack(ByteStream buf, PyObject value) {
BigInteger bi = get_ulong(value);
if (bi.compareTo(BigInteger.valueOf(0)) < 0) {
throw StructError("can't convert negative long to unsigned");
}
long lvalue = bi.longValue(); // underflow is OK -- the bits are correct
int high = (int) ((lvalue & 0xFFFFFFFF00000000L) >> 32);
int low = (int) (lvalue & 0x00000000FFFFFFFFL);
BEwriteInt(buf, high);
BEwriteInt(buf, low);
}
@Override
Object unpack(ByteStream buf) {
long high = (BEreadInt(buf) & 0X00000000FFFFFFFFL);
long low = (BEreadInt(buf) & 0X00000000FFFFFFFFL);
java.math.BigInteger result = java.math.BigInteger.valueOf(high);
result = result.multiply(java.math.BigInteger.valueOf(0x100000000L));
result = result.add(java.math.BigInteger.valueOf(low));
return new PyLong(result);
}
}
static class LELongFormatDef extends FormatDef {
@Override
void pack(ByteStream buf, PyObject value) {
long lvalue = get_long(value);
int high = (int) ((lvalue & 0xFFFFFFFF00000000L) >> 32);
int low = (int) (lvalue & 0x00000000FFFFFFFFL);
LEwriteInt(buf, low);
LEwriteInt(buf, high);
}
@Override
Object unpack(ByteStream buf) {
long low = LEreadInt(buf) & 0x00000000FFFFFFFFL;
long high = ((long) (LEreadInt(buf)) << 32) & 0xFFFFFFFF00000000L;
long result = (high | low);
return new PyLong(result);
}
}
static class BELongFormatDef extends FormatDef {
@Override
void pack(ByteStream buf, PyObject value) {
long lvalue = get_long(value);
int high = (int) ((lvalue & 0xFFFFFFFF00000000L) >> 32);
int low = (int) (lvalue & 0x00000000FFFFFFFFL);
BEwriteInt(buf, high);
BEwriteInt(buf, low);
}
@Override
Object unpack(ByteStream buf) {
long high = ((long) (BEreadInt(buf)) << 32) & 0xFFFFFFFF00000000L;
long low = BEreadInt(buf) & 0x00000000FFFFFFFFL;
long result = (high | low);
return new PyLong(result);
}
}
static class LEFloatFormatDef extends FormatDef {
@Override
void pack(ByteStream buf, PyObject value) {
int bits = Float.floatToIntBits((float) get_float(value));
LEwriteInt(buf, bits);
}
@Override
Object unpack(ByteStream buf) {
int bits = LEreadInt(buf);
float v = Float.intBitsToFloat(bits);
if (PyFloat.float_format == PyFloat.Format.UNKNOWN
&& (Float.isInfinite(v) || Float.isNaN(v))) {
throw Py.ValueError("can't unpack IEEE 754 special value on non-IEEE platform");
}
return Py.newFloat(v);
}
}
static class LEDoubleFormatDef extends FormatDef {
@Override
void pack(ByteStream buf, PyObject value) {
long bits = Double.doubleToLongBits(get_float(value));
LEwriteInt(buf, (int) (bits & 0xFFFFFFFF));
LEwriteInt(buf, (int) (bits >>> 32));
}
@Override
Object unpack(ByteStream buf) {
long bits = (LEreadInt(buf) & 0xFFFFFFFFL) + (((long) LEreadInt(buf)) << 32);
double v = Double.longBitsToDouble(bits);
if (PyFloat.double_format == PyFloat.Format.UNKNOWN
&& (Double.isInfinite(v) || Double.isNaN(v))) {
throw Py.ValueError("can't unpack IEEE 754 special value on non-IEEE platform");
}
return Py.newFloat(v);
}
}
static class BEFloatFormatDef extends FormatDef {
@Override
void pack(ByteStream buf, PyObject value) {
int bits = Float.floatToIntBits((float) get_float(value));
BEwriteInt(buf, bits);
}
@Override
Object unpack(ByteStream buf) {
int bits = BEreadInt(buf);
float v = Float.intBitsToFloat(bits);
if (PyFloat.float_format == PyFloat.Format.UNKNOWN
&& (Float.isInfinite(v) || Float.isNaN(v))) {
throw Py.ValueError("can't unpack IEEE 754 special value on non-IEEE platform");
}
return Py.newFloat(v);
}
}
static class BEDoubleFormatDef extends FormatDef {
@Override
void pack(ByteStream buf, PyObject value) {
long bits = Double.doubleToLongBits(get_float(value));
BEwriteInt(buf, (int) (bits >>> 32));
BEwriteInt(buf, (int) (bits & 0xFFFFFFFF));
}
@Override
Object unpack(ByteStream buf) {
long bits = (((long) BEreadInt(buf)) << 32) + (BEreadInt(buf) & 0xFFFFFFFFL);
double v = Double.longBitsToDouble(bits);
if (PyFloat.double_format == PyFloat.Format.UNKNOWN
&& (Double.isInfinite(v) || Double.isNaN(v))) {
throw Py.ValueError("can't unpack IEEE 754 special value on non-IEEE platform");
}
return Py.newFloat(v);
}
}
//@formatter:off
private static FormatDef[] lilendian_table = {
new PadFormatDef() .init('x', 1, 0),
new ByteFormatDef() .init('b', 1, 0),
new UnsignedByteFormatDef() .init('B', 1, 0),
new CharFormatDef() .init('c', 1, 0),
new StringFormatDef() .init('s', 1, 0),
new PascalStringFormatDef() .init('p', 1, 0),
new LEShortFormatDef() .init('h', 2, 0),
new LEUnsignedShortFormatDef() .init('H', 2, 0),
new LEIntFormatDef() .init('i', 4, 0),
new LEUnsignedIntFormatDef() .init('I', 4, 0),
new LEIntFormatDef() .init('l', 4, 0),
new LEUnsignedIntFormatDef() .init('L', 4, 0),
new LELongFormatDef() .init('q', 8, 0),
new LEUnsignedLongFormatDef() .init('Q', 8, 0),
new LEFloatFormatDef() .init('f', 4, 0),
new LEDoubleFormatDef() .init('d', 8, 0),
};
private static FormatDef[] bigendian_table = {
new PadFormatDef() .init('x', 1, 0),
new ByteFormatDef() .init('b', 1, 0),
new UnsignedByteFormatDef() .init('B', 1, 0),
new CharFormatDef() .init('c', 1, 0),
new StringFormatDef() .init('s', 1, 0),
new PascalStringFormatDef() .init('p', 1, 0),
new BEShortFormatDef() .init('h', 2, 0),
new BEUnsignedShortFormatDef() .init('H', 2, 0),
new BEIntFormatDef() .init('i', 4, 0),
new BEUnsignedIntFormatDef() .init('I', 4, 0),
new BEIntFormatDef() .init('l', 4, 0),
new BEUnsignedIntFormatDef() .init('L', 4, 0),
new BELongFormatDef() .init('q', 8, 0),
new BEUnsignedLongFormatDef() .init('Q', 8, 0),
new BEFloatFormatDef() .init('f', 4, 0),
new BEDoubleFormatDef() .init('d', 8, 0),
};
private static FormatDef[] native_table = {
new PadFormatDef() .init('x', 1, 0),
new ByteFormatDef() .init('b', 1, 0),
new UnsignedByteFormatDef() .init('B', 1, 0),
new CharFormatDef() .init('c', 1, 0),
new StringFormatDef() .init('s', 1, 0),
new PascalStringFormatDef() .init('p', 1, 0),
new BEShortFormatDef() .init('h', 2, 2),
new BEUnsignedShortFormatDef() .init('H', 2, 2),
new BEIntFormatDef() .init('i', 4, 4),
new BEUnsignedIntFormatDef() .init('I', 4, 4),
new BEIntFormatDef() .init('l', 4, 4),
new BEUnsignedIntFormatDef() .init('L', 4, 4),
new BELongFormatDef() .init('q', 8, 8),
new BEUnsignedLongFormatDef() .init('Q', 8, 8),
new BEFloatFormatDef() .init('f', 4, 4),
new BEDoubleFormatDef() .init('d', 8, 8),
new PointerFormatDef() .init('P')
};
//@formatter:on
static FormatDef[] whichtable(String pfmt) {
char c = pfmt.charAt(0);
switch (c) {
case '<':
return lilendian_table;
case '>':
case '!':
// Network byte order is big-endian
return bigendian_table;
case '=':
return bigendian_table;
case '@':
default:
return native_table;
}
}
private static FormatDef getentry(char c, FormatDef[] f) {
for (int i = 0; i < f.length; i++) {
if (f[i].name == c) {
return f[i];
}
}
throw StructError("bad char in struct format");
}
private static int align(int size, FormatDef e) {
if (e.alignment != 0) {
size = ((size + e.alignment - 1) / e.alignment) * e.alignment;
}
return size;
}
static int calcsize(String format, FormatDef[] f) {
int size = 0;
int len = format.length();
for (int j = 0; j < len; j++) {
char c = format.charAt(j);
if (j == 0 && (c == '@' || c == '<' || c == '>' || c == '=' || c == '!')) {
continue;
}
if (Character.isWhitespace(c)) {
continue;
}
int num = 1;
if (Character.isDigit(c)) {
num = Character.digit(c, 10);
while (++j < len && Character.isDigit((c = format.charAt(j)))) {
int x = num * 10 + Character.digit(c, 10);
if (x / 10 != num) {
throw StructError("overflow in item count");
}
num = x;
}
if (j >= len) {
break;
}
}
FormatDef e = getentry(c, f);
int itemsize = e.size;
size = align(size, e);
int x = num * itemsize;
size += x;
if (x / itemsize != num || size < 0) {
throw StructError("total struct size too long");
}
}
return size;
}
/**
* Return the size of the struct (and hence of the string) corresponding to the given format.
*/
static public int calcsize(String format) {
FormatDef[] f = whichtable(format);
return calcsize(format, f);
}
/**
* Return a string containing the values v1, v2, ... packed according to the given format. The
* arguments must match the values required by the format exactly.
*/
static public PyString pack(PyObject[] args) {
if (args.length < 1) {
Py.TypeError("illegal argument type for built-in operation");
}
String format = args[0].toString();
FormatDef[] f = whichtable(format);
int size = calcsize(format, f);
return new PyString(pack(format, f, size, 1, args).toString());
}
// xxx - may need to consider doing a generic arg parser here
static public void pack_into(PyObject[] args) {
if (args.length < 3) {
Py.TypeError("illegal argument type for built-in operation");
}
String format = args[0].toString();
FormatDef[] f = whichtable(format);
int size = calcsize(format, f);
pack_into(format, f, size, 1, args);
}
static void pack_into(String format, FormatDef[] f, int size, int argstart, PyObject[] args) {
if (args.length - argstart < 2) {
Py.TypeError("illegal argument type for built-in operation");
}
if (!(args[argstart] instanceof PyArray)) {
throw Py.TypeError("pack_into takes an array arg"); // as well as a buffer, what else?
}
PyArray buffer = (PyArray) args[argstart];
int offset = args[argstart + 1].asInt();
ByteStream res = pack(format, f, size, argstart + 2, args);
if (res.pos > buffer.__len__()) {
throw StructError("pack_into requires a buffer of at least " + res.pos + " bytes, got "
+ buffer.__len__());
}
for (int i = 0; i < res.pos; i++, offset++) {
char val = res.data[i];
buffer.set(offset, val);
}
}
static ByteStream pack(String format, FormatDef[] f, int size, int start, PyObject[] args) {
ByteStream res = new ByteStream();
int i = start;
int len = format.length();
for (int j = 0; j < len; j++) {
char c = format.charAt(j);
if (j == 0 && (c == '@' || c == '<' || c == '>' || c == '=' || c == '!')) {
continue;
}
if (Character.isWhitespace(c)) {
continue;
}
int num = 1;
if (Character.isDigit(c)) {
num = Character.digit(c, 10);
while (++j < len && Character.isDigit((c = format.charAt(j)))) {
num = num * 10 + Character.digit(c, 10);
}
if (j >= len) {
break;
}
}
FormatDef e = getentry(c, f);
// Fill pad bytes with zeros
int nres = align(res.size(), e) - res.size();
while (nres-- > 0) {
res.writeByte(0);
}
i += e.doPack(res, num, i, args);
}
if (i < args.length) {
throw StructError("too many arguments for pack format");
}
return res;
}
/**
* Unpack the string (presumably packed by pack(fmt, ...)) according to the given format. The
* result is a tuple even if it contains exactly one item. The string must contain exactly the
* amount of data required by the format (i.e. len(string) must equal calcsize(fmt)).
*/
public static PyTuple unpack(String format, String string) {
FormatDef[] f = whichtable(format);
int size = calcsize(format, f);
int len = string.length();
if (size != len) {
throw StructError("unpack str size does not match format");
}
return unpack(f, size, format, new ByteStream(string));
}
public static PyTuple unpack(String format, PyArray buffer) {
String string = buffer.tostring();
FormatDef[] f = whichtable(format);
int size = calcsize(format, f);
int len = string.length();
if (size != len) {
throw StructError("unpack str size does not match format");
}
return unpack(f, size, format, new ByteStream(string));
}
public static PyTuple unpack(String format, Py2kBuffer buffer) {
return unpack(format, buffer.toString());
}
public static PyTuple unpack(String format, PyByteArray bytearray) {
/* bytearray is added in 2.7.7 */
return unpack(format, bytearray.toString());
}
public static PyTuple unpack_from(String format, Py2kBuffer buffer) {
return unpack_from(format, buffer.toString(), 0);
}
public static PyTuple unpack_from(String format, PyByteArray bytearray) {
return unpack_from(format, bytearray.toString(), 0);
}
public static PyTuple unpack_from(String format, Py2kBuffer buffer, int offset) {
return unpack_from(format, buffer.toString(), offset);
}
public static PyTuple unpack_from(String format, PyByteArray bytearray, int offset) {
return unpack_from(format, bytearray.toString(), offset);
}
public static PyTuple unpack_from(String format, String string) {
return unpack_from(format, string, 0);
}
public static PyTuple unpack_from(String format, String string, int offset) {
FormatDef[] f = whichtable(format);
int size = calcsize(format, f);
int len = string.length();
if (size >= (len - offset + 1)) {
throw StructError("unpack_from str size does not match format");
}
return unpack(f, size, format, new ByteStream(string, offset));
}
static PyTuple unpack(FormatDef[] f, int size, String format, ByteStream str) {
PyList res = new PyList();
int flen = format.length();
for (int j = 0; j < flen; j++) {
char c = format.charAt(j);
if (j == 0 && (c == '@' || c == '<' || c == '>' || c == '=' || c == '!')) {
continue;
}
if (Character.isWhitespace(c)) {
continue;
}
int num = 1;
if (Character.isDigit(c)) {
num = Character.digit(c, 10);
while (++j < flen && Character.isDigit((c = format.charAt(j)))) {
num = num * 10 + Character.digit(c, 10);
}
}
FormatDef e = getentry(c, f);
str.skip(align(str.size(), e) - str.size());
e.doUnpack(str, num, res);
}
return PyTuple.fromIterable(res);
}
static PyException StructError(String explanation) {
return new PyException(error, explanation);
}
private static PyObject exceptionNamespace() {
PyObject dict = new PyStringMap();
dict.__setitem__("__module__", new PyString("struct"));
return dict;
}
public static void classDictInit(PyObject dict) {
dict.__setitem__("Struct", PyStruct.TYPE);
}
}