cglue 0.3.5

FFI safe abstractions for making plugins and C-compatible libraries
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

//! These tests are intended to check more complex casting behaviour.
use crate::slice::*;
use cglue_macro::*;

#[cglue_trait]
pub trait WithSlice {
    fn wslice_1(&mut self, _slc: &[usize]) {}
    fn wslice_2(&mut self, _str: &str) {}
    fn wslice_3(&mut self) -> &str {
        "slice"
    }
    fn wslice_4<'a>(&'a mut self, _val: &str) -> &'a str {
        "slice"
    }
}

#[cglue_trait]
pub trait WithOptions {
    fn wopt_1(&self, _npo_opt: Option<&usize>) {}
    fn wopt_2(&self, _opt: Option<usize>) {}
    fn wopt_3(&mut self, _npo_option: Option<&u64>, _wrap_option: Option<u64>) {}
}

#[cglue_trait]
#[int_result]
pub trait WithIntResult {
    fn wint_1(&self, val: usize) -> Result<usize, std::io::Error> {
        Ok(val)
    }
    #[no_int_result]
    fn wint_2(&self, val: usize) -> Result<usize, usize> {
        Ok(val)
    }
}

type AliasResult<T, E> = Result<T, E>;

#[cglue_trait]
#[int_result(AliasResult)]
pub trait WithAliasIntResult {
    #[no_unwind_abi]
    fn waint_1(&self, val: usize) -> AliasResult<usize, std::io::Error> {
        Ok(val)
    }
    #[no_int_result]
    fn waint_2(&self, val: usize) -> AliasResult<usize, usize> {
        Ok(val)
    }
}

#[cglue_trait]
pub trait WithInto {
    fn winto_1(&self, _into: impl Into<usize>) {}
}

struct Implementor {}

impl WithSlice for Implementor {}
impl WithOptions for Implementor {}
impl WithIntResult for Implementor {}
impl WithAliasIntResult for Implementor {}
impl WithInto for Implementor {}

type ICont<I, C> = crate::trait_group::CGlueObjContainer<I, crate::trait_group::NoContext, C>;
type IRefCont<C> = ICont<&'static Implementor, C>;
type IMutCont<C> = ICont<&'static mut Implementor, C>;

type WSCont = IMutCont<WithSliceRetTmp<crate::trait_group::NoContext>>;
type WOCont = IMutCont<WithOptionsRetTmp<crate::trait_group::NoContext>>;
type WIRCont = IRefCont<WithIntResultRetTmp<crate::trait_group::NoContext>>;
type WAIRCont = IRefCont<WithAliasIntResultRetTmp<crate::trait_group::NoContext>>;
type WINTOCont = IRefCont<WithIntoRetTmp<crate::trait_group::NoContext>>;

#[cfg(all(feature = "unwind_abi_default", not(__cglue_force_no_unwind_abi)))]
macro_rules! extern_fn {
    ($(for<$lt:lifetime>)? ($($tt:ty),*) $(-> $ty:ty)?) => { $(for<$lt>)? unsafe extern "C-unwind" fn($($tt),*) $(-> $ty)? }
}

#[cfg(any(not(feature = "unwind_abi_default"), __cglue_force_no_unwind_abi))]
macro_rules! extern_fn {
    ($(for<$lt:lifetime>)? ($($tt:ty),*) $(-> $ty:ty)?) => { $(for<$lt>)? unsafe extern "C" fn($($tt),*) $(-> $ty)? }
}

#[test]
fn slices_wrapped() {
    let vtbl = <&WithSliceVtbl<WSCont>>::default();
    let _: extern_fn!((&mut WSCont, CSliceRef<usize>)) = vtbl.wslice_1();
    let _: extern_fn!((&mut WSCont, CSliceRef<u8>)) = vtbl.wslice_2();
    let _: extern_fn!((&mut WSCont) -> CSliceRef<u8>) = vtbl.wslice_3();
    let _: extern_fn!(for<'a> (&'a mut WSCont, CSliceRef<u8>) -> CSliceRef<'a, u8>) =
        vtbl.wslice_4();
}

#[test]
fn npo_option_forwarded() {
    let vtbl = <&WithOptionsVtbl<WOCont>>::default();
    let _: extern_fn!((&WOCont, Option<&usize>)) = vtbl.wopt_1();
}

#[test]
fn non_npo_option_wrapped() {
    let vtbl = <&WithOptionsVtbl<WOCont>>::default();
    let _: extern_fn!((&WOCont, crate::option::COption<usize>)) = vtbl.wopt_2();
}

#[test]
fn mixed_options() {
    let vtbl = <&WithOptionsVtbl<WOCont>>::default();
    let _: extern_fn!((&mut WOCont, Option<&u64>, crate::option::COption<u64>)) = vtbl.wopt_3();
}

#[test]
fn int_result() {
    let vtbl = <&WithIntResultVtbl<WIRCont>>::default();
    let _: extern_fn!((&WIRCont, usize, &mut core::mem::MaybeUninit<usize>) -> i32) = vtbl.wint_1();
}

#[test]
fn no_int_result() {
    let vtbl = <&WithIntResultVtbl<WIRCont>>::default();
    let _: extern_fn!((&WIRCont, usize) -> crate::result::CResult<usize, usize>) = vtbl.wint_2();
}

#[test]
fn alias_int_result() {
    let vtbl = <&WithAliasIntResultVtbl<WAIRCont>>::default();
    let _: unsafe extern "C" fn(&WAIRCont, usize, &mut core::mem::MaybeUninit<usize>) -> i32 =
        vtbl.waint_1();
}

#[test]
fn alias_no_int_result() {
    let vtbl = <&WithAliasIntResultVtbl<WAIRCont>>::default();
    let _: extern_fn!((&WAIRCont, usize) -> crate::result::CResult<usize, usize>) = vtbl.waint_2();
}

#[test]
fn into_t_wrapped() {
    let vtbl = <&WithIntoVtbl<WINTOCont>>::default();
    let _: extern_fn!((&WINTOCont, usize)) = vtbl.winto_1();
}