io.ipfs.api.cbor.CborEncoder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-xpx-ipfs-api Show documentation
Show all versions of java-xpx-ipfs-api Show documentation
The ProximaX IPFS Java API is a Java library for interacting IPFS server.
The newest version!
package io.ipfs.api.cbor;
import static io.ipfs.api.cbor.CborConstants.*;
/*
* JACOB - CBOR implementation in Java.
*
* (C) Copyright - 2013 - J.W. Janssen
*
* Licensed under Apache License v2.0.
*/
import java.io.IOException;
import java.io.OutputStream;
/**
* Provides an encoder capable of encoding data into CBOR format to a given {@link OutputStream}.
*/
public class CborEncoder {
private static final int NEG_INT_MASK = TYPE_NEGATIVE_INTEGER << 5;
private final OutputStream m_os;
/**
* Creates a new {@link CborEncoder} instance.
*
* @param os the actual output stream to write the CBOR-encoded data to, cannot be null.
*/
public CborEncoder(OutputStream os) {
if (os == null) {
throw new IllegalArgumentException("OutputStream cannot be null!");
}
m_os = os;
}
/**
* Interprets a given float-value as a half-precision float value and
* converts it to its raw integer form, as defined in IEEE 754.
*
* Taken from: this Stack Overflow answer.
*
*
* @param fval the value to convert.
* @return the raw integer representation of the given float value.
*/
static int halfPrecisionToRawIntBits(float fval) {
int fbits = Float.floatToIntBits(fval);
int sign = (fbits >>> 16) & 0x8000;
int val = (fbits & 0x7fffffff) + 0x1000;
// might be or become NaN/Inf
if (val >= 0x47800000) {
if ((fbits & 0x7fffffff) >= 0x47800000) { // is or must become NaN/Inf
if (val < 0x7f800000) {
// was value but too large, make it +/-Inf
return sign | 0x7c00;
}
return sign | 0x7c00 | (fbits & 0x007fffff) >>> 13; // keep NaN (and Inf) bits
}
return sign | 0x7bff; // unrounded not quite Inf
}
if (val >= 0x38800000) {
// remains normalized value
return sign | val - 0x38000000 >>> 13; // exp - 127 + 15
}
if (val < 0x33000000) {
// too small for subnormal
return sign; // becomes +/-0
}
val = (fbits & 0x7fffffff) >>> 23;
// add subnormal bit, round depending on cut off and div by 2^(1-(exp-127+15)) and >> 13 | exp=0
return sign | ((fbits & 0x7fffff | 0x800000) + (0x800000 >>> val - 102) >>> 126 - val);
}
/**
* Writes the start of an indefinite-length array.
*
* After calling this method, one is expected to write the given number of array elements, which can be of any type. No length checks are performed.
*
*
* After all array elements are written, one should write a single break value to end the array, see {@link #writeBreak()}.
*
*
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeArrayStart() throws IOException {
writeSimpleType(TYPE_ARRAY, BREAK);
}
/**
* Writes the start of a definite-length array.
*
* After calling this method, one is expected to write the given number of array elements, which can be of any type. No length checks are performed.
*
*
* @param length the number of array elements to write, should >= 0.
* @throws IllegalArgumentException in case the given length was negative;
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeArrayStart(int length) throws IOException {
if (length < 0) {
throw new IllegalArgumentException("Invalid array-length!");
}
writeType(TYPE_ARRAY, length);
}
/**
* Writes a boolean value in canonical CBOR format.
*
* @param value the boolean to write.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeBoolean(boolean value) throws IOException {
writeSimpleType(TYPE_FLOAT_SIMPLE, value ? TRUE : FALSE);
}
/**
* Writes a "break" stop-value in canonical CBOR format.
*
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeBreak() throws IOException {
writeSimpleType(TYPE_FLOAT_SIMPLE, BREAK);
}
/**
* Writes a byte string in canonical CBOR-format.
*
* @param bytes the byte string to write, can be null in which case a byte-string of length 0 is written.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeByteString(byte[] bytes) throws IOException {
writeString(TYPE_BYTE_STRING, bytes);
}
/**
* Writes the start of an indefinite-length byte string.
*
* After calling this method, one is expected to write the given number of string parts. No length checks are performed.
*
*
* After all string parts are written, one should write a single break value to end the string, see {@link #writeBreak()}.
*
*
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeByteStringStart() throws IOException {
writeSimpleType(TYPE_BYTE_STRING, BREAK);
}
/**
* Writes a double-precision float value in canonical CBOR format.
*
* @param value the value to write, values from {@link Double#MIN_VALUE} to {@link Double#MAX_VALUE} are supported.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeDouble(double value) throws IOException {
writeUInt64(TYPE_FLOAT_SIMPLE << 5, Double.doubleToRawLongBits(value));
}
/**
* Writes a single-precision float value in canonical CBOR format.
*
* @param value the value to write, values from {@link Float#MIN_VALUE} to {@link Float#MAX_VALUE} are supported.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeFloat(float value) throws IOException {
writeUInt32(TYPE_FLOAT_SIMPLE << 5, Float.floatToRawIntBits(value));
}
/**
* Writes a half-precision float value in canonical CBOR format.
*
* @param value the value to write, values from {@link Float#MIN_VALUE} to {@link Float#MAX_VALUE} are supported.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeHalfPrecisionFloat(float value) throws IOException {
writeUInt16(TYPE_FLOAT_SIMPLE << 5, halfPrecisionToRawIntBits(value));
}
/**
* Writes a signed or unsigned integer value in canonical CBOR format, that is, tries to encode it in a little bytes as possible..
*
* @param value the value to write, values from {@link Long#MIN_VALUE} to {@link Long#MAX_VALUE} are supported.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeInt(long value) throws IOException {
// extends the sign over all bits...
long sign = value >> 63;
// in case value is negative, this bit should be set...
int mt = (int) (sign & NEG_INT_MASK);
// complement negative value...
value = (sign ^ value);
writeUInt(mt, value);
}
/**
* Writes a signed or unsigned 16-bit integer value in CBOR format.
*
* @param value the value to write, values from [-65536..65535] are supported.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeInt16(int value) throws IOException {
// extends the sign over all bits...
int sign = value >> 31;
// in case value is negative, this bit should be set...
int mt = (int) (sign & NEG_INT_MASK);
// complement negative value...
writeUInt16(mt, (sign ^ value) & 0xffff);
}
/**
* Writes a signed or unsigned 32-bit integer value in CBOR format.
*
* @param value the value to write, values in the range [-4294967296..4294967295] are supported.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeInt32(long value) throws IOException {
// extends the sign over all bits...
long sign = value >> 63;
// in case value is negative, this bit should be set...
int mt = (int) (sign & NEG_INT_MASK);
// complement negative value...
writeUInt32(mt, (int) ((sign ^ value) & 0xffffffffL));
}
/**
* Writes a signed or unsigned 64-bit integer value in CBOR format.
*
* @param value the value to write, values from {@link Long#MIN_VALUE} to {@link Long#MAX_VALUE} are supported.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeInt64(long value) throws IOException {
// extends the sign over all bits...
long sign = value >> 63;
// in case value is negative, this bit should be set...
int mt = (int) (sign & NEG_INT_MASK);
// complement negative value...
writeUInt64(mt, sign ^ value);
}
/**
* Writes a signed or unsigned 8-bit integer value in CBOR format.
*
* @param value the value to write, values in the range [-256..255] are supported.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeInt8(int value) throws IOException {
// extends the sign over all bits...
int sign = value >> 31;
// in case value is negative, this bit should be set...
int mt = (int) (sign & NEG_INT_MASK);
// complement negative value...
writeUInt8(mt, (sign ^ value) & 0xff);
}
/**
* Writes the start of an indefinite-length map.
*
* After calling this method, one is expected to write any number of map entries, as separate key and value. Keys and values can both be of any type. No length checks are performed.
*
*
* After all map entries are written, one should write a single break value to end the map, see {@link #writeBreak()}.
*
*
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeMapStart() throws IOException {
writeSimpleType(TYPE_MAP, BREAK);
}
/**
* Writes the start of a finite-length map.
*
* After calling this method, one is expected to write any number of map entries, as separate key and value. Keys and values can both be of any type. No length checks are performed.
*
*
* @param length the number of map entries to write, should >= 0.
* @throws IllegalArgumentException in case the given length was negative;
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeMapStart(int length) throws IOException {
if (length < 0) {
throw new IllegalArgumentException("Invalid length of map!");
}
writeType(TYPE_MAP, length);
}
/**
* Writes a null value in canonical CBOR format.
*
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeNull() throws IOException {
writeSimpleType(TYPE_FLOAT_SIMPLE, NULL);
}
/**
* Writes a simple value, i.e., an "atom" or "constant" value in canonical CBOR format.
*
* @param simpleValue the (unsigned byte) value to write, values from 32 to 255 are supported (though not enforced).
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeSimpleValue(byte simpleValue) throws IOException {
// convert to unsigned value...
int value = (simpleValue & 0xff);
writeType(TYPE_FLOAT_SIMPLE, value);
}
/**
* Writes a signed or unsigned small (<= 23) integer value in CBOR format.
*
* @param value the value to write, values in the range [-24..23] are supported.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeSmallInt(int value) throws IOException {
// extends the sign over all bits...
int sign = value >> 31;
// in case value is negative, this bit should be set...
int mt = (int) (sign & NEG_INT_MASK);
// complement negative value...
value = Math.min(0x17, (sign ^ value));
m_os.write((int) (mt | value));
}
/**
* Writes a semantic tag in canonical CBOR format.
*
* @param tag the tag to write, should >= 0.
* @throws IllegalArgumentException in case the given tag was negative;
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeTag(long tag) throws IOException {
if (tag < 0) {
throw new IllegalArgumentException("Invalid tag specification, cannot be negative!");
}
writeType(TYPE_TAG, tag);
}
/**
* Writes an UTF-8 string in canonical CBOR-format.
*
* Note that this method is platform specific, as the given string value will be encoded in a byte array
* using the platform encoding! This means that the encoding must be standardized and known.
*
*
* @param value the UTF-8 string to write, can be null in which case an UTF-8 string of length 0 is written.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeTextString(String value) throws IOException {
writeString(TYPE_TEXT_STRING, value == null ? null : value.getBytes("UTF-8"));
}
/**
* Writes the start of an indefinite-length UTF-8 string.
*
* After calling this method, one is expected to write the given number of string parts. No length checks are performed.
*
*
* After all string parts are written, one should write a single break value to end the string, see {@link #writeBreak()}.
*
*
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeTextStringStart() throws IOException {
writeSimpleType(TYPE_TEXT_STRING, BREAK);
}
/**
* Writes an "undefined" value in canonical CBOR format.
*
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
public void writeUndefined() throws IOException {
writeSimpleType(TYPE_FLOAT_SIMPLE, UNDEFINED);
}
/**
* Encodes and writes the major type and value as a simple type.
*
* @param majorType the major type of the value to write, denotes what semantics the written value has;
* @param value the value to write, values from [0..31] are supported.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
protected void writeSimpleType(int majorType, int value) throws IOException {
m_os.write((majorType << 5) | (value & 0x1f));
}
/**
* Writes a byte string in canonical CBOR-format.
*
* @param majorType the major type of the string, should be either 0x40 or 0x60;
* @param bytes the byte string to write, can be null in which case a byte-string of length 0 is written.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
protected void writeString(int majorType, byte[] bytes) throws IOException {
int len = (bytes == null) ? 0 : bytes.length;
writeType(majorType, len);
for (int i = 0; i < len; i++) {
m_os.write(bytes[i]);
}
}
/**
* Encodes and writes the major type indicator with a given payload (length).
*
* @param majorType the major type of the value to write, denotes what semantics the written value has;
* @param value the value to write, values from {@link Long#MIN_VALUE} to {@link Long#MAX_VALUE} are supported.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
protected void writeType(int majorType, long value) throws IOException {
writeUInt((majorType << 5), value);
}
/**
* Encodes and writes an unsigned integer value, that is, tries to encode it in a little bytes as possible.
*
* @param mt the major type of the value to write, denotes what semantics the written value has;
* @param value the value to write, values from {@link Long#MIN_VALUE} to {@link Long#MAX_VALUE} are supported.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
protected void writeUInt(int mt, long value) throws IOException {
if (value < 0x18L) {
m_os.write((int) (mt | value));
} else if (value < 0x100L) {
writeUInt8(mt, (int) value);
} else if (value < 0x10000L) {
writeUInt16(mt, (int) value);
} else if (value < 0x100000000L) {
writeUInt32(mt, (int) value);
} else {
writeUInt64(mt, value);
}
}
/**
* Encodes and writes an unsigned 16-bit integer value
*
* @param mt the major type of the value to write, denotes what semantics the written value has;
* @param value the value to write, values from {@link Long#MIN_VALUE} to {@link Long#MAX_VALUE} are supported.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
protected void writeUInt16(int mt, int value) throws IOException {
m_os.write(mt | TWO_BYTES);
m_os.write(value >> 8);
m_os.write(value & 0xFF);
}
/**
* Encodes and writes an unsigned 32-bit integer value
*
* @param mt the major type of the value to write, denotes what semantics the written value has;
* @param value the value to write, values from {@link Long#MIN_VALUE} to {@link Long#MAX_VALUE} are supported.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
protected void writeUInt32(int mt, int value) throws IOException {
m_os.write(mt | FOUR_BYTES);
m_os.write(value >> 24);
m_os.write(value >> 16);
m_os.write(value >> 8);
m_os.write(value & 0xFF);
}
/**
* Encodes and writes an unsigned 64-bit integer value
*
* @param mt the major type of the value to write, denotes what semantics the written value has;
* @param value the value to write, values from {@link Long#MIN_VALUE} to {@link Long#MAX_VALUE} are supported.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
protected void writeUInt64(int mt, long value) throws IOException {
m_os.write(mt | EIGHT_BYTES);
m_os.write((int) (value >> 56));
m_os.write((int) (value >> 48));
m_os.write((int) (value >> 40));
m_os.write((int) (value >> 32));
m_os.write((int) (value >> 24));
m_os.write((int) (value >> 16));
m_os.write((int) (value >> 8));
m_os.write((int) (value & 0xFF));
}
/**
* Encodes and writes an unsigned 8-bit integer value
*
* @param mt the major type of the value to write, denotes what semantics the written value has;
* @param value the value to write, values from {@link Long#MIN_VALUE} to {@link Long#MAX_VALUE} are supported.
* @throws IOException in case of I/O problems writing the CBOR-encoded value to the underlying output stream.
*/
protected void writeUInt8(int mt, int value) throws IOException {
m_os.write(mt | ONE_BYTE);
m_os.write(value & 0xFF);
}
}