brotli 8.0.4

A brotli compressor and decompressor that with an interface avoiding the rust stdlib. This makes it suitable for embedded devices and kernels. It is designed with a pluggable allocator so that the standard lib's allocator may be employed. The default build also includes a stdlib allocator and stream interface. Disable this with --features=no-stdlib. All included code is safe.
Documentation
use core;
#[cfg(all(feature = "std", not(feature = "pass-through-ffi-panics")))]
use std::io::Write;
#[cfg(all(feature = "std", not(feature = "pass-through-ffi-panics")))]
use std::{io, panic, thread};

pub use brotli_decompressor::ffi::interface::c_void;
use brotli_decompressor::ffi::{slice_from_raw_parts_or_nil, slice_from_raw_parts_or_nil_mut};

use crate::concat::BroCatli;
pub use crate::concat::BroCatliResult;
pub type BroccoliResult = BroCatliResult;
// a tool to concatenate brotli files together

#[repr(C)]
pub struct BroccoliState {
    more_data: *mut c_void,
    current_data: [u8; 120],
}

impl Clone for BroccoliState {
    fn clone(&self) -> BroccoliState {
        let mut cd = [0u8; 120];
        cd.clone_from_slice(&self.current_data[..]);
        BroccoliState {
            more_data: self.more_data,
            current_data: cd,
        }
    }
}

impl Copy for BroccoliState {}

impl Default for BroccoliState {
    fn default() -> BroccoliState {
        BroCatli::new().into()
    }
}
impl From<BroCatli> for BroccoliState {
    fn from(data: BroCatli) -> BroccoliState {
        let mut buffer = [0u8; 120];
        data.serialize_to_buffer(&mut buffer[..]).unwrap();
        BroccoliState {
            more_data: core::ptr::null_mut(),
            current_data: buffer,
        }
    }
}
impl From<BroccoliState> for BroCatli {
    fn from(val: BroccoliState) -> Self {
        BroCatli::deserialize_from_buffer(&val.current_data[..]).unwrap()
    }
}

#[no_mangle]
pub extern "C" fn BroccoliCreateInstance() -> BroccoliState {
    BroCatli::new().into()
}
#[no_mangle]
pub extern "C" fn BroccoliCreateInstanceWithWindowSize(window_size: u8) -> BroccoliState {
    match BroCatli::try_new_with_window_size(window_size) {
        Ok(bro_catli) => bro_catli.into(),
        Err(_) => BroCatli::new().into(),
    }
}
#[no_mangle]
pub extern "C" fn BroccoliDestroyInstance(_state: BroccoliState) {}

#[no_mangle]
pub unsafe extern "C" fn BroccoliNewBrotliFile(state: *mut BroccoliState) {
    if let Err(panic_err) = catch_panic(|| {
        let mut bro_catli: BroCatli = (*state).into();
        bro_catli.new_brotli_file();
        *state = BroccoliState::from(bro_catli);
        BroCatliResult::Success
    }) {
        error_print(panic_err);
    }
}

#[no_mangle]
pub unsafe extern "C" fn BroccoliConcatStream(
    state: *mut BroccoliState,
    available_in: *mut usize,
    input_buf_ptr: *mut *const u8,
    available_out: *mut usize,
    output_buf_ptr: *mut *mut u8,
) -> BroccoliResult {
    catch_panic(|| {
        let input_buf = slice_from_raw_parts_or_nil(*input_buf_ptr, *available_in);
        let output_buf = slice_from_raw_parts_or_nil_mut(*output_buf_ptr, *available_out);
        let mut input_offset = 0usize;
        let mut output_offset = 0usize;
        let mut bro_catli: BroCatli = (*state).into();
        let ret = bro_catli.stream(input_buf, &mut input_offset, output_buf, &mut output_offset);
        *input_buf_ptr = (*input_buf_ptr).add(input_offset);
        *output_buf_ptr = (*output_buf_ptr).add(output_offset);
        *available_in -= input_offset;
        *available_out -= output_offset;
        *state = BroccoliState::from(bro_catli);
        ret
    })
    .unwrap_or_else(|panic_err| {
        error_print(panic_err);
        BroCatliResult::BrotliFileNotCraftedForConcatenation
    })
}

#[no_mangle]
pub unsafe extern "C" fn BroccoliConcatStreaming(
    state: *mut BroccoliState,
    available_in: *mut usize,
    mut input_buf: *const u8,
    available_out: *mut usize,
    mut output_buf: *mut u8,
) -> BroccoliResult {
    catch_panic(|| {
        BroccoliConcatStream(
            state,
            available_in,
            &mut input_buf,
            available_out,
            &mut output_buf,
        )
    })
    .unwrap_or_else(|panic_err| {
        error_print(panic_err);
        BroCatliResult::BrotliFileNotCraftedForConcatenation
    })
}

#[no_mangle]
pub unsafe extern "C" fn BroccoliConcatFinish(
    state: *mut BroccoliState,
    available_out: *mut usize,
    output_buf_ptr: *mut *mut u8,
) -> BroCatliResult {
    catch_panic(|| {
        let output_buf = slice_from_raw_parts_or_nil_mut(*output_buf_ptr, *available_out);
        let mut output_offset = 0usize;
        let mut bro_catli: BroCatli = (*state).into();
        let ret = bro_catli.finish(output_buf, &mut output_offset);
        *output_buf_ptr = (*output_buf_ptr).add(output_offset);
        *available_out -= output_offset;
        *state = BroccoliState::from(bro_catli);
        ret
    })
    .unwrap_or_else(|panic_err| {
        error_print(panic_err);
        BroCatliResult::BrotliFileNotCraftedForConcatenation
    })
}

// exactly the same as BrotliConcatFinish but without the indirect
#[no_mangle]
pub unsafe extern "C" fn BroccoliConcatFinished(
    state: *mut BroccoliState,
    available_out: *mut usize,
    mut output_buf: *mut u8,
) -> BroCatliResult {
    catch_panic(|| BroccoliConcatFinish(state, available_out, &mut output_buf)).unwrap_or_else(
        |panic_err| {
            error_print(panic_err);
            BroCatliResult::BrotliFileNotCraftedForConcatenation
        },
    )
}

#[cfg(all(feature = "std", not(feature = "pass-through-ffi-panics")))]
fn catch_panic<F: FnOnce() -> BroccoliResult>(f: F) -> thread::Result<BroccoliResult> {
    panic::catch_unwind(panic::AssertUnwindSafe(f))
}

// can't catch panics in a reliable way without std:: configure with panic=abort. These shouldn't happen
#[cfg(any(not(feature = "std"), feature = "pass-through-ffi-panics"))]
fn catch_panic<F: FnOnce() -> BroccoliResult>(f: F) -> Result<BroccoliResult, ()> {
    Ok(f())
}

#[cfg(all(feature = "std", not(feature = "pass-through-ffi-panics")))]
fn error_print<Err: core::fmt::Debug>(err: Err) {
    let _ign = writeln!(&mut io::stderr(), "Internal Error {:?}", err);
}

#[cfg(any(not(feature = "std"), feature = "pass-through-ffi-panics"))]
fn error_print<Err>(_err: Err) {}

#[cfg(test)]
mod test {
    #[test]
    fn test_create_instance_with_invalid_window_size_does_not_panic() {
        let _ = super::BroccoliCreateInstanceWithWindowSize(5);
    }

    #[cfg(all(feature = "std", not(feature = "pass-through-ffi-panics")))]
    #[test]
    fn test_concat_stream_panic_returns_error() {
        let mut state: super::BroccoliState = super::BroccoliCreateInstanceWithWindowSize(22);
        let empty_catable = [b';'];
        let mut input_buf = empty_catable.as_ptr();
        let mut available_in = empty_catable.len();
        let mut output = [0u8; 32];
        let mut output_buf = output.as_mut_ptr();
        let mut available_out = output.len();
        let mut result = unsafe {
            super::BroccoliConcatStream(
                &mut state,
                &mut available_in,
                &mut input_buf,
                &mut available_out,
                &mut output_buf,
            )
        };
        assert_eq!(result, super::BroccoliResult::NeedsMoreInput);

        unsafe { super::BroccoliNewBrotliFile(&mut state) };
        let truncated_metadata = [0x71, 0x1b, 0, 0];
        input_buf = truncated_metadata.as_ptr();
        available_in = truncated_metadata.len();
        output_buf = output.as_mut_ptr();
        available_out = output.len();
        result = unsafe {
            super::BroccoliConcatStream(
                &mut state,
                &mut available_in,
                &mut input_buf,
                &mut available_out,
                &mut output_buf,
            )
        };
        assert_eq!(
            result,
            super::BroccoliResult::BrotliFileNotCraftedForConcatenation
        );
    }
}