yad_core 2.0.0

use crate::Value;

/// Submodules providing specialized functions for different types of `Value`.
///
/// Each module handles operations specific to the type, for example:
/// - `_8b_functions` : Functions for 8-bit values
/// - `_16b_functions`: Functions for 16-bit values
/// - `_32b_functions`: Functions for 32-bit values
/// - `_64b_functions`: Functions for 64-bit values
/// - `_bool_functions`: Functions for boolean values
/// - `_string_functions`: Functions for string values
/// - `_array_functions`: Functions for array values
mod _8b_functions;
pub use _8b_functions::*;
mod _32b_functions;
pub use _32b_functions::*;
mod _16b_functions;
pub use _16b_functions::*;
mod _64b_functions;
pub use _64b_functions::*;
mod _bool_functions;
pub use _bool_functions::*;
mod _string_functions;
pub use _string_functions::*;
mod _array_functions;
pub use _array_functions::*;

/// Frees a `Value` previously allocated on the heap.
///
/// # Parameters
/// - `val`: Pointer to a `Value`.
///
/// # Safety
/// - `val` must be a pointer previously returned from a creation function.
/// - After calling this function, the pointer must not be used again.
#[unsafe(no_mangle)]
pub extern "C" fn value_free(val: *mut Value) {
    if !val.is_null() {
        unsafe { drop(Box::from_raw(val)) }
    }
}

/// Decodes a buffer of bytes into a heap-allocated `Value`.
///
/// # Safety
/// - The caller must ensure that `buff` points to a valid memory region of at least `len` bytes.
/// - The returned pointer transfers ownership of the `Value` to the caller.
///   The caller is responsible for freeing it with `Box::from_raw` or a dedicated free function.
///
/// # Parameters
/// - `buff`: Pointer to a contiguous buffer of `u8` containing the encoded value.
/// - `len`: Length of the buffer in bytes.
///
/// # Returns
/// - A raw pointer to a heap-allocated `Value` on success.
/// - Returns `null` if `buff` is null, `len` is zero, or decoding fails.
///
/// # Notes
/// - This function creates a temporary Rust `Vec<u8>` from the raw buffer to pass to `Value::decode`.
/// - Ownership of the returned `Value` is fully transferred; Rust will not automatically free it.
/// - The caller must ensure proper deallocation to avoid memory leaks.
#[unsafe(no_mangle)]
pub extern "C" fn value_from_buffer(buff: *const u8, len: usize) -> *mut Value {
    if buff.is_null() || len == 0 {
        return std::ptr::null_mut()
    }

    unsafe {
        let slice = std::slice::from_raw_parts(buff, len);
        let vec = slice.to_vec();
        match Value::decode(vec) {
            Ok(val) => Box::into_raw(Box::new(val)),
            Err(_) => std::ptr::null_mut(),
        }
    }
}

/// Returns the type of the `Value`.
///
/// # Parameters
/// - `val`: Pointer to a `Value`.
///
/// # Returns
/// - A `u8` representing the type.
/// - Returns `0` if `val` is null.
///
/// # Safety
/// - `val` must be a valid pointer or null.
#[unsafe(no_mangle)]
pub extern "C" fn value_type(val: *mut Value) -> u8 {
    if val.is_null() {
        return 0
    }

    unsafe {
        (*val).r#type as u8
    }
}

/// Returns the length of the `Value` in bytes (or its logical length).
///
/// # Parameters
/// - `val`: Pointer to a `Value`.
///
/// # Returns
/// - Length as `u8`.
/// - Returns `0` if `val` is null.
///
/// # Safety
/// - `val` must be a valid pointer or null.
#[unsafe(no_mangle)]
pub extern "C" fn value_len(val: *mut Value) -> u8 {
    if val.is_null() {
        return 0
    }

    unsafe {
        (&*val).length as u8
    }
}

/// Returns a raw pointer to the underlying bytes of the `Value`.
///
/// # Parameters
/// - `val`: Pointer to a `Value`.
///
/// # Returns
/// - Pointer to the first byte of the value, or null if `val` is null.
///
/// # Safety
/// - The returned pointer is valid as long as the `Value` is alive.
/// - Modifying the memory through this pointer may cause undefined behavior.
#[unsafe(no_mangle)]
pub extern "C" fn value_raw_bytes(val: *mut Value) -> *const u8 {
    if val.is_null() {
        return std::ptr::null()
    }

    unsafe {
        (&*val).bytes.as_ptr()
    }
}

/// Returns the length of the raw byte buffer of the `Value`.
///
/// # Parameters
/// - `val`: Pointer to a `Value`.
///
/// # Returns
/// - Number of bytes in the `Value`, or `0` if `val` is null.
///
/// # Safety
/// - `val` must be a valid pointer or null.
#[unsafe(no_mangle)]
pub extern "C" fn value_raw_bytes_length(val: *mut Value) -> usize {
    if val.is_null() {
        return 0
    }

    unsafe {
        (&*val).bytes.len()
    }
}