json_string.py

# -*- coding: utf-8 -*-
########################################################################################################################
# NyxNode
# Author: Jérôme ODIER <jerome.odier@lpsc.in2p3.fr>
# SPDX-License-Identifier: GPL-3.0+
########################################################################################################################
 
import ctypes
 
########################################################################################################################
 
from .. import bind
from .. import obj
 
########################################################################################################################
 
class NyxString(obj.NyxObject):
    """!
    @brief JSON string object.
    """
 
    ####################################################################################################################
 
    def __init__(self, value: str | bytes | None = None, ptr: int | None = None):
        """!
        @brief Allocates a new JSON string object or wraps one.
 
        @param value Optional default value.
        @param ptr Optional JSON string object pointer.
        """
 
        ################################################################################################################
 
        if ptr is None:
 
            ptr = bind.lib.nyx_string_new()
 
        elif bind.lib.nyx_object_get_type(ptr) != bind.NyxObjectType.STRING:
 
            raise TypeError('Not a pointer to a Nyx string object')
 
        ################################################################################################################
 
        super().__init__(ptr)
 
        ################################################################################################################
 
        if isinstance(value, str):
 
            self.value = value
 
        if isinstance(value, bytes):
 
            self.buff = value
 
    ####################################################################################################################
 
    def _get_buff(self) -> bytes:
 
        ################################################################################################################
 
        result_size = bind.c_size_t()
        result_buff = bind.c_void_p()
 
        bind.lib.nyx_string_get_buff(self.ptr, ctypes.byref(result_size), ctypes.byref(result_buff))
 
        ################################################################################################################
 
        return ctypes.string_at(result_buff.value, result_size.value)
 
    ####################################################################################################################
 
    @property
    def value(self) -> str:
        """!
        @brief Gets the text value of this JSON string object.
 
        @return The current text value.
 
        @note The returned text value remains valid until the object is modified or released.
        """
 
        return self._get_buff().decode('utf-8')
 
    ####################################################################################################################
 
    @property
    def buff(self) -> bytes:
        """!
        @brief Gets the content of this JSON string object as a byte buffer.
 
        @return The current content bytes.
 
        @note The returned buffer remains valid until the object is modified or released.
        """
 
        return self._get_buff()#decode('utf-8')
 
    ####################################################################################################################
 
    @value.setter
    def value(self, value: str) -> bool:
        """!
        @brief Sets the text value of this JSON string object.
 
        @return @c True if the value was modified, @c False otherwise.
        """
 
        ################################################################################################################
 
        data = bind.as_bytes(value, allow_none = False)
 
        buff = ctypes.cast(bind.lib.nyx_string_ndup(data, len(data)), bind.c_char_p)
 
        ################################################################################################################
 
        return bool(bind.lib.nyx_string_set(
            self.ptr,
            buff,
            True
        ))
 
    ####################################################################################################################
 
    @buff.setter
    def buff(self, value: bytes) -> bool:
        """!
        @brief Sets the content of this JSON string object as a byte buffer.
 
        @return @c True if the value was modified, @c False otherwise.
        """
 
        ################################################################################################################
 
        data = bind.as_bytes(value, allow_none = False)
 
        buff = ctypes.cast(bind.lib.nyx_buffer_ndup(data, len(data)), bind.c_void_p)
 
        ################################################################################################################
 
        return bool(bind.lib.nyx_string_set_buff(
            self.ptr,
            len(data),
            buff,
            True
        ))
 
########################################################################################################################
 
__all__ = ['NyxString']
 
########################################################################################################################