path: root/stream.go

package salticidae

// #include <stdlib.h>
// #include "salticidae/stream.h"
// #include "salticidae/endian.h"
// uint16_t _salti_htole16(uint16_t x) { return htole16(x); }
// uint32_t _salti_htole32(uint32_t x) { return htole32(x); }
// uint64_t _salti_htole64(uint64_t x) { return htole64(x); }
//
// uint16_t _salti_letoh16(uint16_t x) { return le16toh(x); }
// uint32_t _salti_letoh32(uint32_t x) { return le32toh(x); }
// uint64_t _salti_letoh64(uint64_t x) { return le64toh(x); }
//
// uint16_t _salti_htobe16(uint16_t x) { return htobe16(x); }
// uint32_t _salti_htobe32(uint32_t x) { return htobe32(x); }
// uint64_t _salti_htobe64(uint64_t x) { return htobe64(x); }
//
// uint16_t _salti_betoh16(uint16_t x) { return be16toh(x); }
// uint32_t _salti_betoh32(uint32_t x) { return be32toh(x); }
// uint64_t _salti_betoh64(uint64_t x) { return be64toh(x); }
//
import "C"
import "runtime"

type CByteArray = *C.bytearray_t

// The C pointer to a ByteArray object.
type byteArray struct {
	inner    CByteArray
	autoFree bool
}

// Array of binary data.
type ByteArray = *byteArray

func ByteArrayFromC(ptr CByteArray) ByteArray {
	return &byteArray{inner: ptr}
}

func byteArraySetFinalizer(res ByteArray, autoFree bool) {
	res.autoFree = autoFree
	if res != nil && autoFree {
		runtime.SetFinalizer(res, func(self ByteArray) { self.Free() })
	}
}

// Create an empty byte array (with zero contained bytes).
func NewByteArray(autoFree bool) ByteArray {
	res := ByteArrayFromC(C.bytearray_new())
	byteArraySetFinalizer(res, autoFree)
	return res
}

// Free the ByteArray manually. If the object is constructed with autoFree =
// true, this will immediately free the object.
func (self ByteArray) Free() {
	C.bytearray_free(self.inner)
	if self.autoFree {
		runtime.SetFinalizer(self, nil)
	}
}

// Create a byte array by taking out all data from src. Notice this is a
// zero-copy operation that consumes and invalidates the data in src ("move"
// semantics) so that no more operation should be done to src after this
// function call. Also notice unlike copying, the entire DataStream buffer is
// moved (including the possibily consumed part).
func NewByteArrayMovedFromDataStream(src DataStream, autoFree bool) (res ByteArray) {
	res = ByteArrayFromC(C.bytearray_new_moved_from_datastream(src.inner))
	byteArraySetFinalizer(res, autoFree)
	return
}

// Create a byte array by copying the remaining data from src.
func NewByteArrayCopiedFromDataStream(src DataStream, autoFree bool) (res ByteArray) {
	res = ByteArrayFromC(C.bytearray_new_copied_from_datastream(src.inner))
	byteArraySetFinalizer(res, autoFree)
	return
}

func NewByteArrayFromHex(hex string) (res ByteArray, autoFree bool) {
	c_str := C.CString(hex)
	res = ByteArrayFromC(C.bytearray_new_from_hex(c_str))
	C.free(rawptr_t(c_str))
	byteArraySetFinalizer(res, autoFree)
	return
}

func NewByteArrayFromBytes(bytes []byte, autoFree bool) (res ByteArray) {
	size := len(bytes)
	if size > 0 {
		base := (*C.uint8_t)(&bytes[0])
		res = ByteArrayFromC(C.bytearray_new_from_bytes(base, C.size_t(size)))
	} else {
		res = ByteArrayFromC(C.bytearray_new())
	}
	byteArraySetFinalizer(res, autoFree)
	return
}

// The C pointer to a DataStream object.
type CDataStream = *C.datastream_t
type dataStream struct {
	inner    CDataStream
	attached map[uintptr]interface{}
	autoFree bool
}

// Stream of binary data.
type DataStream = *dataStream

func DataStreamFromC(ptr CDataStream) DataStream {
	return &dataStream{
		inner:    ptr,
		attached: make(map[uintptr]interface{}),
	}
}

func dataStreamSetFinalizer(res DataStream, autoFree bool) {
	res.autoFree = autoFree
	if res != nil && autoFree {
		runtime.SetFinalizer(res, func(self DataStream) { self.Free() })
	}
}

// Create an empty DataStream.
func NewDataStream(autoFree bool) DataStream {
	res := DataStreamFromC(C.datastream_new())
	dataStreamSetFinalizer(res, autoFree)
	return res
}

// Create a DataStream with data copied from bytes.
func NewDataStreamFromBytes(bytes []byte, autoFree bool) (res DataStream) {
	size := len(bytes)
	if size > 0 {
		base := (*C.uint8_t)(&bytes[0])
		res = DataStreamFromC(C.datastream_new_from_bytes(base, C.size_t(size)))
	} else {
		res = DataStreamFromC(C.datastream_new())
	}
	dataStreamSetFinalizer(res, autoFree)
	return
}

// Create a DataStream with content moved from a ByteArray.
func NewDataStreamMovedFromByteArray(bytes ByteArray, autoFree bool) (res DataStream) {
	res = DataStreamFromC(C.datastream_new_moved_from_bytearray(bytes.inner))
	dataStreamSetFinalizer(res, autoFree)
	return
}

// Create a DataStream with content copied from a ByteArray.
func NewDataStreamFromByteArray(bytes ByteArray, autoFree bool) (res DataStream) {
	res = DataStreamFromC(C.datastream_new_from_bytearray(bytes.inner))
	dataStreamSetFinalizer(res, autoFree)
	return
}

func (self DataStream) Free() {
	C.datastream_free(self.inner)
	if self.autoFree {
		runtime.SetFinalizer(self, nil)
	}
}

func (self DataStream) attach(ptr rawptr_t, obj interface{}) { self.attached[uintptr(ptr)] = obj }
func (self DataStream) detach(ptr rawptr_t)                  { delete(self.attached, uintptr(ptr)) }

// Make a copy of the object.
func (self DataStream) Copy(autoFree bool) (res DataStream) {
	res = DataStreamFromC(C.datastream_copy(self.inner))
	dataStreamSetFinalizer(res, autoFree)
	return
}

// TODO: datastream_data

// Empty the DataStream.
func (self DataStream) Clear() { C.datastream_clear(self.inner) }

func (self DataStream) Size() int { return int(C.datastream_size(self.inner)) }

// Write a uint8 integer to the stream (no byte order conversion).
func (self DataStream) PutU8(v uint8) bool { return bool(C.datastream_put_u8(self.inner, C.uint8_t(v))) }

// Write a uint16 integer to the stream (no byte order conversion).
func (self DataStream) PutU16(v uint16) bool {
	return bool(C.datastream_put_u16(self.inner, C.uint16_t(v)))
}

// Write a uint32 integer to the stream (no byte order conversion).
func (self DataStream) PutU32(v uint32) bool {
	return bool(C.datastream_put_u32(self.inner, C.uint32_t(v)))
}

// Write a uint64 integer to the stream (no byte order conversion).
func (self DataStream) PutU64(v uint64) bool {
	return bool(C.datastream_put_u64(self.inner, C.uint64_t(v)))
}

// Write an int8 integer to the stream (no byte order conversion).
func (self DataStream) PutI8(v int8) bool { return bool(C.datastream_put_i8(self.inner, C.int8_t(v))) }

// Write an int16 integer to the stream (no byte order conversion).
func (self DataStream) PutI16(v int16) bool {
	return bool(C.datastream_put_i16(self.inner, C.int16_t(v)))
}

// Write an int32 integer to the stream (no byte order conversion).
func (self DataStream) PutI32(v int32) bool {
	return bool(C.datastream_put_i32(self.inner, C.int32_t(v)))
}

// Write an int64 integer to the stream (no byte order conversion).
func (self DataStream) PutI64(v int32) bool {
	return bool(C.datastream_put_i64(self.inner, C.int64_t(v)))
}

// Write arbitrary bytes to the stream.
func (self DataStream) PutData(bytes []byte) bool {
	size := len(bytes)
	if size > 0 {
		base := (*C.uint8_t)(&bytes[0])
		return bool(C.datastream_put_data(self.inner, base, C.size_t(size)))
	} else {
		return true
	}
}

// Parse a uint8 integer by consuming the stream (no byte order conversion).
func (self DataStream) GetU8(succ *bool) uint8 {
	return uint8(C.datastream_get_u8(self.inner, (*C.bool)(succ)))
}

// Parse a uint16 integer by consuming the stream (no byte order conversion).
func (self DataStream) GetU16(succ *bool) uint16 {
	return uint16(C.datastream_get_u16(self.inner, (*C.bool)(succ)))
}

// Parse a uint32 integer by consuming the stream (no byte order conversion).
func (self DataStream) GetU32(succ *bool) uint32 {
	return uint32(C.datastream_get_u32(self.inner, (*C.bool)(succ)))
}

// Parse a uint64 integer by consuming the stream (no byte order conversion).
func (self DataStream) GetU64(succ *bool) uint64 {
	return uint64(C.datastream_get_u64(self.inner, (*C.bool)(succ)))
}

// Parse an int8 integer by consuming the stream (no byte order conversion).
func (self DataStream) GetI8(succ *bool) int8 {
	return int8(C.datastream_get_i8(self.inner, (*C.bool)(succ)))
}

// Parse an int16 integer by consuming the stream (no byte order conversion).
func (self DataStream) GetI16(succ *bool) int16 {
	return int16(C.datastream_get_i16(self.inner, (*C.bool)(succ)))
}

// Parse an int32 integer by consuming the stream (no byte order conversion).
func (self DataStream) GetI32(succ *bool) int32 {
	return int32(C.datastream_get_i32(self.inner, (*C.bool)(succ)))
}

// Parse an int64 integer by consuming the stream (no byte order conversion).
func (self DataStream) GetI64(succ *bool) int64 {
	return int64(C.datastream_get_i64(self.inner, (*C.bool)(succ)))
}

func ToLittleEndianU16(x uint16) uint16 { return uint16(C._salti_htole16(C.uint16_t(x))) }
func ToLittleEndianU32(x uint32) uint32 { return uint32(C._salti_htole32(C.uint32_t(x))) }
func ToLittleEndianU64(x uint64) uint64 { return uint64(C._salti_htole64(C.uint64_t(x))) }

func FromLittleEndianU16(x uint16) uint16 { return uint16(C._salti_letoh16(C.uint16_t(x))) }
func FromLittleEndianU32(x uint32) uint32 { return uint32(C._salti_letoh32(C.uint32_t(x))) }
func FromLittleEndianU64(x uint64) uint64 { return uint64(C._salti_letoh64(C.uint64_t(x))) }

func ToBigEndianU16(x uint16) uint16 { return uint16(C._salti_htobe16(C.uint16_t(x))) }
func ToBigEndianU32(x uint32) uint32 { return uint32(C._salti_htobe32(C.uint32_t(x))) }
func ToBigEndianU64(x uint64) uint64 { return uint64(C._salti_htobe64(C.uint64_t(x))) }

func FromBigEndianU16(x uint16) uint16 { return uint16(C._salti_betoh16(C.uint16_t(x))) }
func FromBigEndianU32(x uint32) uint32 { return uint32(C._salti_betoh32(C.uint32_t(x))) }
func FromBigEndianU64(x uint64) uint64 { return uint64(C._salti_betoh64(C.uint64_t(x))) }

// The handle returned by GetDataInPlace. The Go slice returned by Get() is
// valid only during the lifetime of the handle.
type dataStreamBytes struct {
	bytes []byte
	ds    DataStream
}

type DataStreamBytes = *dataStreamBytes

func (self DataStreamBytes) Get() []byte { return self.bytes }
func (self DataStreamBytes) Release()    { self.ds.detach(rawptr_t(self)) }

// Get the given length of preceeding bytes from the stream as a byte slice by
// consuming the stream. Notice this function does not copy the bytes, so the
// slice is only valid during the lifetime of DataStreamBytes handle.
func (self DataStream) GetDataInPlace(length int) DataStreamBytes {
	base := C.datastream_get_data_inplace(self.inner, C.size_t(length))
	res := &dataStreamBytes{
		bytes: C.GoBytes(rawptr_t(base), C.int(length)),
		ds:    self,
	}
	self.attach(rawptr_t(res), res)
	return res
}

// The C pointer to a UInt256 object.
type CUInt256 = *C.uint256_t
type uint256 struct {
	inner    CUInt256
	autoFree bool
}

// 256-bit integer.
type UInt256 = *uint256

func UInt256FromC(ptr CUInt256) UInt256 {
	return &uint256{inner: ptr}
}

func uint256SetFinalizer(res UInt256, autoFree bool) {
	res.autoFree = autoFree
	if res != nil && autoFree {
		runtime.SetFinalizer(res, func(self UInt256) { self.Free() })
	}
}

// Create a 256-bit integer.
func NewUInt256(autoFree bool) UInt256 {
	res := &uint256{inner: C.uint256_new()}
	uint256SetFinalizer(res, autoFree)
	return res
}

func NewUInt256FromByteArray(bytes ByteArray, autoFree bool) (res UInt256) {
	res = &uint256{inner: C.uint256_new_from_bytearray(bytes.inner)}
	uint256SetFinalizer(res, autoFree)
	return
}

func (self UInt256) Free() {
	C.uint256_free(self.inner)
	if self.autoFree {
		runtime.SetFinalizer(self, nil)
	}
}

func (self UInt256) IsNull() bool { return bool(C.uint256_is_null(self.inner)) }

// Check if two 256-bit integers are equal.
func (self UInt256) IsEq(other UInt256) bool { return bool(C.uint256_is_eq(self.inner, other.inner)) }

// Write the integer to the given DataStream.
func (self UInt256) Serialize(s DataStream) { C.uint256_serialize(self.inner, s.inner) }

// Parse the integer from the given DataStream.
func (self UInt256) Unserialize(s DataStream) { C.uint256_unserialize(self.inner, s.inner) }

// Get the Sha256 hash of the given DataStream content (without consuming the
// stream).
func (self DataStream) GetHash(autoFree bool) UInt256 {
	res := &uint256{inner: C.datastream_get_hash(self.inner)}
	uint256SetFinalizer(res, autoFree)
	return res
}

// Get the Sha256 hash of the given ByteArray content.
func (self ByteArray) GetHash(autoFree bool) (res UInt256) {
	s := NewDataStreamFromByteArray(self, false)
	res = s.GetHash(autoFree)
	s.Free()
	return
}

// Get hexadicemal string representation of the given DataStream content
// (without consuming the stream).
func (self DataStream) GetHex() string {
	tmp := C.datastream_get_hex(self.inner)
	res := C.GoString(tmp)
	C.free(rawptr_t(tmp))
	return res
}

// Get hexadicemal string representation of the 256-bit integer.
func (self UInt256) GetHex() (res string) {
	s := NewDataStream(false)
	self.Serialize(s)
	res = s.GetHex()
	s.Free()
	return
}