[babeltrace.git] / bindings / python / bt2 / field_types.py

# The MIT License (MIT)
#
# Copyright (c) 2016 Philippe Proulx <pproulx@efficios.com>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.

from bt2 import native_bt, object, utils
import collections.abc
import bt2.fields
import abc
import bt2


def _create_from_ptr(ptr):
    typeid = native_bt.ctf_field_type_get_type_id(ptr)
    return _TYPE_ID_TO_OBJ[typeid]._create_from_ptr(ptr)


class _FieldType(object._Object, metaclass=abc.ABCMeta):
    def __init__(self, ptr):
        super().__init__(ptr)

    def __eq__(self, other):
        if not isinstance(other, self.__class__):
            # not comparing apples to apples
            return False

        if self.addr == other.addr:
            return True

        ret = native_bt.ctf_field_type_compare(self._ptr, other._ptr)
        utils._handle_ret(ret, "cannot compare field types")
        return ret == 0

    def _check_create_status(self, ptr):
        if ptr is None:
            raise bt2.CreationError('cannot create {} field type object'.format(self._NAME.lower()))

    def __copy__(self):
        ptr = native_bt.ctf_field_type_copy(self._ptr)
        utils._handle_ptr(ptr, 'cannot copy {} field type object'.format(self._NAME.lower()))
        return _create_from_ptr(ptr)

    def __deepcopy__(self, memo):
        cpy = self.__copy__()
        memo[id(self)] = cpy
        return cpy

    def __call__(self, value=None):
        field_ptr = native_bt.ctf_field_create(self._ptr)

        if field_ptr is None:
            raise bt2.CreationError('cannot create {} field object'.format(self._NAME.lower()))

        field = bt2.fields._create_from_ptr(field_ptr)

        if value is not None:
            if not isinstance(field, (bt2.fields._IntegerField, bt2.fields._FloatingPointNumberField, bt2.fields._StringField)):
                raise bt2.Error('cannot assign an initial value to a {} field object'.format(field._NAME))

            field.value = value

        return field


class ByteOrder:
    NATIVE = native_bt.CTF_BYTE_ORDER_NATIVE
    LITTLE_ENDIAN = native_bt.CTF_BYTE_ORDER_LITTLE_ENDIAN
    BIG_ENDIAN = native_bt.CTF_BYTE_ORDER_BIG_ENDIAN
    NETWORK = native_bt.CTF_BYTE_ORDER_NETWORK


class Encoding:
    NONE = native_bt.CTF_STRING_ENCODING_NONE
    UTF8 = native_bt.CTF_STRING_ENCODING_UTF8
    ASCII = native_bt.CTF_STRING_ENCODING_ASCII


class Base:
    BINARY = native_bt.CTF_INTEGER_BASE_BINARY
    OCTAL = native_bt.CTF_INTEGER_BASE_OCTAL
    DECIMAL = native_bt.CTF_INTEGER_BASE_DECIMAL
    HEXADECIMAL = native_bt.CTF_INTEGER_BASE_HEXADECIMAL


class _AlignmentProp:
    @property
    def alignment(self):
        alignment = native_bt.ctf_field_type_get_alignment(self._ptr)
        utils._handle_ret(alignment, "cannot get field type object's alignment")
        return alignment

    @alignment.setter
    def alignment(self, alignment):
        utils._check_alignment(alignment)
        ret = native_bt.ctf_field_type_set_alignment(self._ptr, alignment)
        utils._handle_ret(ret, "cannot set field type object's alignment")


class _ByteOrderProp:
    @property
    def byte_order(self):
        bo = native_bt.ctf_field_type_get_byte_order(self._ptr)
        utils._handle_ret(bo, "cannot get field type object's byte order")
        return bo

    @byte_order.setter
    def byte_order(self, byte_order):
        utils._check_int(byte_order)
        ret = native_bt.ctf_field_type_set_byte_order(self._ptr, byte_order)
        utils._handle_ret(ret, "cannot set field type object's byte order")


class IntegerFieldType(_FieldType, _AlignmentProp, _ByteOrderProp):
    _NAME = 'Integer'

    def __init__(self, size, alignment=None, byte_order=None, is_signed=None,
                 base=None, encoding=None, mapped_clock_class=None):
        utils._check_uint64(size)

        if size == 0:
            raise ValueError('size is 0 bits')

        ptr = native_bt.ctf_field_type_integer_create(size)
        self._check_create_status(ptr)
        super().__init__(ptr)

        if alignment is not None:
            self.alignment = alignment

        if byte_order is not None:
            self.byte_order = byte_order

        if is_signed is not None:
            self.is_signed = is_signed

        if base is not None:
            self.base = base

        if encoding is not None:
            self.encoding = encoding

        if mapped_clock_class is not None:
            self.mapped_clock_class = mapped_clock_class

    @property
    def size(self):
        size = native_bt.ctf_field_type_integer_get_size(self._ptr)
        utils._handle_ret(size, "cannot get integer field type object's size")
        return size

    @property
    def is_signed(self):
        is_signed = native_bt.ctf_field_type_integer_get_signed(self._ptr)
        utils._handle_ret(is_signed,
                    "cannot get integer field type object's signedness")
        return is_signed > 0

    @is_signed.setter
    def is_signed(self, is_signed):
        utils._check_bool(is_signed)
        ret = native_bt.ctf_field_type_integer_set_signed(self._ptr, int(is_signed))
        utils._handle_ret(ret, "cannot set integer field type object's signedness")

    @property
    def base(self):
        base = native_bt.ctf_field_type_integer_get_base(self._ptr)
        utils._handle_ret(base, "cannot get integer field type object's base")
        return base

    @base.setter
    def base(self, base):
        utils._check_int(base)
        ret = native_bt.ctf_field_type_integer_set_base(self._ptr, base)
        utils._handle_ret(ret, "cannot set integer field type object's base")

    @property
    def encoding(self):
        encoding = native_bt.ctf_field_type_integer_get_encoding(self._ptr)
        utils._handle_ret(encoding, "cannot get integer field type object's encoding")
        return encoding

    @encoding.setter
    def encoding(self, encoding):
        utils._check_int(encoding)
        ret = native_bt.ctf_field_type_integer_set_encoding(self._ptr, encoding)
        utils._handle_ret(ret, "cannot set integer field type object's encoding")

    @property
    def mapped_clock_class(self):
        ptr = native_bt.ctf_field_type_integer_get_mapped_clock_class(self._ptr)
        utils._handle_ptr(ptr, "cannot get integer field type object's mapped clock class")
        return bt2.ClockClass._create_from_ptr(ptr)

    @mapped_clock_class.setter
    def mapped_clock_class(self, clock_class):
        utils._check_type(clock_class, bt2.ClockClass)
        ret = native_bt.ctf_field_type_integer_set_mapped_clock_class(self._ptr, clock_class._ptr)
        utils._handle_ret(ret, "cannot set integer field type object's mapped clock class")


class FloatingPointNumberFieldType(_FieldType, _AlignmentProp, _ByteOrderProp):
    _NAME = 'Floating point number'

    def __init__(self, alignment=None, byte_order=None, exponent_size=None,
                 mantissa_size=None):
        ptr = native_bt.ctf_field_type_floating_point_create()
        self._check_create_status(ptr)
        super().__init__(ptr)

        if alignment is not None:
            self.alignment = alignment

        if byte_order is not None:
            self.byte_order = byte_order

        if exponent_size is not None:
            self.exponent_size = exponent_size

        if mantissa_size is not None:
            self.mantissa_size = mantissa_size

    @property
    def exponent_size(self):
        exp_size = native_bt.ctf_field_type_floating_point_get_exponent_digits(self._ptr)
        utils._handle_ret(exp_size, "cannot get floating point number field type object's exponent size")
        return exp_size

    @exponent_size.setter
    def exponent_size(self, exponent_size):
        utils._check_uint64(exponent_size)
        ret = native_bt.ctf_field_type_floating_point_set_exponent_digits(self._ptr, exponent_size)
        utils._handle_ret(ret, "cannot set floating point number field type object's exponent size")

    @property
    def mantissa_size(self):
        exp_size = native_bt.ctf_field_type_floating_point_get_mantissa_digits(self._ptr)
        utils._handle_ret(exp_size, "cannot get floating point number field type object's mantissa size")
        return exp_size

    @mantissa_size.setter
    def mantissa_size(self, mantissa_size):
        utils._check_uint64(mantissa_size)
        ret = native_bt.ctf_field_type_floating_point_set_mantissa_digits(self._ptr, mantissa_size)
        utils._handle_ret(ret, "cannot set floating point number field type object's mantissa size")


class _EnumerationFieldTypeMapping:
    def __init__(self, name, lower, upper):
        self._name = name
        self._lower = lower
        self._upper = upper

    @property
    def name(self):
        return self._name

    @property
    def lower(self):
        return self._lower

    @property
    def upper(self):
        return self._upper

    def __eq__(self, other):
        if type(other) is not self.__class__:
            return False

        return (self.name, self.lower, self.upper) == (other.name, other.lower, other.upper)


class _EnumerationFieldTypeMappingIterator(object._Object,
                                           collections.abc.Iterator):
    def __init__(self, iter_ptr, is_signed):
        super().__init__(iter_ptr)
        self._is_signed = is_signed
        self._done = (iter_ptr is None)

    def __next__(self):
        if self._done:
            raise StopIteration

        if self._is_signed:
            ret, name, lower, upper = native_bt.ctf_field_type_enumeration_mapping_iterator_get_signed(self._ptr)
        else:
            ret, name, lower, upper = native_bt.ctf_field_type_enumeration_mapping_iterator_get_unsigned(self._ptr)

        utils._handle_ret(ret, "cannot get enumeration field type mapping iterator object's current mapping")
        mapping = _EnumerationFieldTypeMapping(name, lower, upper)
        ret = native_bt.ctf_field_type_enumeration_mapping_iterator_next(self._ptr)

        if ret < 0:
            self._done = True

        return mapping


class EnumerationFieldType(IntegerFieldType, collections.abc.Sequence):
    _NAME = 'Enumeration'

    def __init__(self, int_field_type=None, size=None, alignment=None,
                 byte_order=None, is_signed=None, base=None, encoding=None,
                 mapped_clock_class=None):
        if int_field_type is None:
            int_field_type = IntegerFieldType(size=size, alignment=alignment,
                                              byte_order=byte_order,
                                              is_signed=is_signed, base=base,
                                              encoding=encoding,
                                              mapped_clock_class=mapped_clock_class)

        utils._check_type(int_field_type, IntegerFieldType)
        ptr = native_bt.ctf_field_type_enumeration_create(int_field_type._ptr)
        self._check_create_status(ptr)
        _FieldType.__init__(self, ptr)

    @property
    def integer_field_type(self):
        ptr = native_bt.ctf_field_type_enumeration_get_container_type(self._ptr)
        utils._handle_ptr(ptr, "cannot get enumeration field type object's integer field type")
        return _create_from_ptr(ptr)

    @property
    def size(self):
        return self.integer_field_type.size

    @property
    def alignment(self):
        return self.integer_field_type.alignment

    @alignment.setter
    def alignment(self, alignment):
        self.integer_field_type.alignment = alignment

    @property
    def byte_order(self):
        return self.integer_field_type.byte_order

    @byte_order.setter
    def byte_order(self, byte_order):
        self.integer_field_type.byte_order = byte_order

    @property
    def is_signed(self):
        return self.integer_field_type.is_signed

    @is_signed.setter
    def is_signed(self, is_signed):
        self.integer_field_type.is_signed = is_signed

    @property
    def base(self):
        return self.integer_field_type.base

    @base.setter
    def base(self, base):
        self.integer_field_type.base = base

    @property
    def encoding(self):
        return self.integer_field_type.encoding

    @encoding.setter
    def encoding(self, encoding):
        self.integer_field_type.encoding = encoding

    @property
    def mapped_clock_class(self):
        return self.integer_field_type.mapped_clock_class

    @mapped_clock_class.setter
    def mapped_clock_class(self, mapped_clock_class):
        self.integer_field_type.mapped_clock_class = mapped_clock_class

    def __len__(self):
        count = native_bt.ctf_field_type_enumeration_get_mapping_count(self._ptr)
        utils._handle_ret(count, "cannot get enumeration field type object's mapping count")
        return count

    def __getitem__(self, index):
        utils._check_uint64(index)

        if index >= len(self):
            raise IndexError

        if self.is_signed:
            get_fn = native_bt.ctf_field_type_enumeration_get_mapping_signed
        else:
            get_fn = native_bt.ctf_field_type_enumeration_get_mapping_unsigned

        ret, name, lower, upper = get_fn(self._ptr, index)
        utils._handle_ret(ret, "cannot get enumeration field type object's mapping")
        return _EnumerationFieldTypeMapping(name, lower, upper)

    def _get_mapping_iter(self, iter_ptr):
        return _EnumerationFieldTypeMappingIterator(iter_ptr, self.is_signed)

    def mappings_by_name(self, name):
        utils._check_str(name)
        iter_ptr = native_bt.ctf_field_type_enumeration_find_mappings_by_name(self._ptr, name)
        return self._get_mapping_iter(iter_ptr)

    def mappings_by_value(self, value):
        if self.is_signed:
            utils._check_int64(value)
            iter_ptr = native_bt.ctf_field_type_enumeration_find_mappings_by_signed_value(self._ptr, value)
        else:
            utils._check_uint64(value)
            iter_ptr = native_bt.ctf_field_type_enumeration_find_mappings_by_unsigned_value(self._ptr, value)

        return self._get_mapping_iter(iter_ptr)

    def append_mapping(self, name, lower, upper=None):
        utils._check_str(name)

        if upper is None:
            upper = lower

        if self.is_signed:
            add_fn = native_bt.ctf_field_type_enumeration_add_mapping
            utils._check_int64(lower)
            utils._check_int64(upper)
        else:
            add_fn = native_bt.ctf_field_type_enumeration_add_mapping_unsigned
            utils._check_uint64(lower)
            utils._check_uint64(upper)

        ret = add_fn(self._ptr, name, lower, upper)
        utils._handle_ret(ret, "cannot add mapping to enumeration field type object")

    def __iadd__(self, mappings):
        for mapping in mappings:
            self.append_mapping(mapping.name, mapping.lower, mapping.upper)

        return self


class StringFieldType(_FieldType):
    _NAME = 'String'

    def __init__(self, encoding=None):
        ptr = native_bt.ctf_field_type_string_create()
        self._check_create_status(ptr)
        super().__init__(ptr)

        if encoding is not None:
            self.encoding = encoding

    @property
    def encoding(self):
        encoding = native_bt.ctf_field_type_string_get_encoding(self._ptr)
        utils._handle_ret(encoding, "cannot get string field type object's encoding")
        return encoding

    @encoding.setter
    def encoding(self, encoding):
        utils._check_int(encoding)
        ret = native_bt.ctf_field_type_string_set_encoding(self._ptr, encoding)
        utils._handle_ret(ret, "cannot set string field type object's encoding")


class _FieldContainer(collections.abc.Mapping):
    def __len__(self):
        count = self._count()
        utils._handle_ret(count, "cannot get {} field type object's field count".format(self._NAME.lower()))
        return count

    def __getitem__(self, key):
        if not isinstance(key, str):
            raise TypeError("'{}' is not a 'str' object".format(key.__class__.__name__))

        ptr = self._get_field_by_name(key)

        if ptr is None:
            raise KeyError(key)

        return _create_from_ptr(ptr)

    def __iter__(self):
        return self._ITER_CLS(self)

    def append_field(self, name, field_type):
        utils._check_str(name)
        utils._check_type(field_type, _FieldType)
        ret = self._add_field(field_type._ptr, name)
        utils._handle_ret(ret, "cannot add field to {} field type object".format(self._NAME.lower()))

    def __iadd__(self, fields):
        for name, field_type in fields.items():
            self.append_field(name, field_type)

        return self

    def at_index(self, index):
        utils._check_uint64(index)
        return self._at(index)


class _StructureFieldTypeFieldIterator(collections.abc.Iterator):
    def __init__(self, struct_field_type):
        self._struct_field_type = struct_field_type
        self._at = 0

    def __next__(self):
        if self._at == len(self._struct_field_type):
            raise StopIteration

        ret, name, field_type_ptr = native_bt.ctf_field_type_structure_get_field(self._struct_field_type._ptr, self._at)
        utils._handle_ret(ret, "cannot get structure field type object's field")
        native_bt.put(field_type_ptr)
        self._at += 1
        return name


class StructureFieldType(_FieldType, _FieldContainer, _AlignmentProp):
    _NAME = 'Structure'
    _ITER_CLS = _StructureFieldTypeFieldIterator

    def __init__(self, min_alignment=None):
        ptr = native_bt.ctf_field_type_structure_create()
        self._check_create_status(ptr)
        super().__init__(ptr)

        if min_alignment is not None:
            self.min_alignment = min_alignment

    def _count(self):
        return native_bt.ctf_field_type_structure_get_field_count(self._ptr)

    def _get_field_by_name(self, key):
        return native_bt.ctf_field_type_structure_get_field_type_by_name(self._ptr, key)

    def _add_field(self, ptr, name):
        return native_bt.ctf_field_type_structure_add_field(self._ptr, ptr,
                                                            name)

    def _at(self, index):
        ret, name, field_type_ptr = native_bt.ctf_field_type_structure_get_field(self._ptr, index)
        utils._handle_ret(ret, "cannot get structure field type object's field")
        return _create_from_ptr(field_type_ptr)


StructureFieldType.min_alignment = property(fset=StructureFieldType.alignment.fset)
StructureFieldType.alignment = property(fget=StructureFieldType.alignment.fget)


class _VariantFieldTypeFieldIterator(collections.abc.Iterator):
    def __init__(self, variant_field_type):
        self._variant_field_type = variant_field_type
        self._at = 0

    def __next__(self):
        if self._at == len(self._variant_field_type):
            raise StopIteration

        ret, name, field_type_ptr = native_bt.ctf_field_type_variant_get_field(self._variant_field_type._ptr, self._at)
        utils._handle_ret(ret, "cannot get variant field type object's field")
        native_bt.put(field_type_ptr)
        self._at += 1
        return name


class VariantFieldType(_FieldType, _FieldContainer, _AlignmentProp):
    _NAME = 'Variant'
    _ITER_CLS = _VariantFieldTypeFieldIterator

    def __init__(self, tag_name):
        utils._check_str(tag_name)
        ptr = native_bt.ctf_field_type_variant_create(None, tag_name)
        self._check_create_status(ptr)
        super().__init__(ptr)

    @property
    def tag_name(self):
        tag_name = native_bt.ctf_field_type_variant_get_tag_name(self._ptr)
        utils._handle_ptr(tag_name, "cannot get variant field type object's tag name")
        return tag_name

    @tag_name.setter
    def tag_name(self, tag_name):
        utils._check_str(tag_name)
        ret = native_bt.ctf_field_type_variant_set_tag_name(self._ptr, tag_name)
        utils._handle_ret(ret, "cannot set variant field type object's tag name")

    def _count(self):
        return native_bt.ctf_field_type_variant_get_field_count(self._ptr)

    def _get_field_by_name(self, key):
        return native_bt.ctf_field_type_variant_get_field_type_by_name(self._ptr, key)

    def _add_field(self, ptr, name):
        return native_bt.ctf_field_type_variant_add_field(self._ptr, ptr, name)

    def _at(self, index):
        ret, name, field_type_ptr = native_bt.ctf_field_type_variant_get_field(self._ptr, index)
        utils._handle_ret(ret, "cannot get variant field type object's field")
        return _create_from_ptr(field_type_ptr)


class ArrayFieldType(_FieldType):
    _NAME = 'Array'

    def __init__(self, element_field_type, length):
        utils._check_type(element_field_type, _FieldType)
        utils._check_uint64(length)
        ptr = native_bt.ctf_field_type_array_create(element_field_type._ptr, length)
        self._check_create_status(ptr)
        super().__init__(ptr)

    @property
    def length(self):
        length = native_bt.ctf_field_type_array_get_length(self._ptr)
        utils._handle_ret(length, "cannot get array field type object's length")
        return length

    @property
    def element_field_type(self):
        ptr = native_bt.ctf_field_type_array_get_element_type(self._ptr)
        utils._handle_ptr(ptr, "cannot get array field type object's element field type")
        return _create_from_ptr(ptr)


class SequenceFieldType(_FieldType):
    _NAME = 'Sequence'

    def __init__(self, element_field_type, length_name):
        utils._check_type(element_field_type, _FieldType)
        utils._check_str(length_name)
        ptr = native_bt.ctf_field_type_sequence_create(element_field_type._ptr,
                                                       length_name)
        self._check_create_status(ptr)
        super().__init__(ptr)

    @property
    def length_name(self):
        length_name = native_bt.ctf_field_type_sequence_get_length_field_name(self._ptr)
        utils._handle_ptr(length_name, "cannot get sequence field type object's length name")
        return length_name

    @property
    def element_field_type(self):
        ptr = native_bt.ctf_field_type_sequence_get_element_type(self._ptr)
        utils._handle_ptr(ptr, "cannot get sequence field type object's element field type")
        return _create_from_ptr(ptr)


_TYPE_ID_TO_OBJ = {
    native_bt.CTF_TYPE_ID_INTEGER: IntegerFieldType,
    native_bt.CTF_TYPE_ID_FLOAT: FloatingPointNumberFieldType,
    native_bt.CTF_TYPE_ID_ENUM: EnumerationFieldType,
    native_bt.CTF_TYPE_ID_STRING: StringFieldType,
    native_bt.CTF_TYPE_ID_STRUCT: StructureFieldType,
    native_bt.CTF_TYPE_ID_ARRAY: ArrayFieldType,
    native_bt.CTF_TYPE_ID_SEQUENCE: SequenceFieldType,
    native_bt.CTF_TYPE_ID_VARIANT: VariantFieldType,
    native_bt.CTF_TYPE_ID_UNTAGGED_VARIANT: VariantFieldType,
}