oo-bindgen 0.8.0

DSL-based binding geneator for C, C++, Java, and C#
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

use crate::backend::c::cpp::conversion::ToNative;
use crate::model::*;

pub(crate) trait ToNativeStructField {
    /// takes a C++ type and converts it to a native type
    fn to_native_struct_field(&self, expr: String) -> String;

    /// does the type require a move operation that modifies the C++ type
    fn requires_move(&self) -> bool;
}

impl ToNativeStructField for StringType {
    fn to_native_struct_field(&self, expr: String) -> String {
        // since the C++ struct will still be valid for the function call there's no need to copy
        // the string. Rust immediately makes a copy of the string inside the FFI layer.
        self.to_native(expr)
    }

    fn requires_move(&self) -> bool {
        false
    }
}

impl<T, D> ToNativeStructField for Handle<Struct<T, D>>
where
    D: DocReference,
    T: StructFieldType + ToNativeStructField,
{
    fn to_native_struct_field(&self, expr: String) -> String {
        format!("to_native({expr})")
    }

    fn requires_move(&self) -> bool {
        self.fields.iter().any(|x| x.field_type.requires_move())
    }
}

impl ToNativeStructField for InterfaceHandle {
    fn to_native_struct_field(&self, expr: String) -> String {
        format!("to_native(std::move({expr}))")
    }

    fn requires_move(&self) -> bool {
        // interfaces in function arguments are passed by unique_ptr, therefore we
        // have to move the unique_ptr into the interface conversion function where
        // it will be released and Rust will manage the lifetime via a Drop impl
        true
    }
}

impl ToNativeStructField for ClassDeclarationHandle {
    fn to_native_struct_field(&self, expr: String) -> String {
        format!("::convert::get({expr})")
    }

    fn requires_move(&self) -> bool {
        false
    }
}

impl ToNativeStructField for AbstractIteratorHandle {
    fn to_native_struct_field(&self, expr: String) -> String {
        format!("::convert::to_native({expr})")
    }

    fn requires_move(&self) -> bool {
        false
    }
}

impl ToNativeStructField for BasicType {
    fn to_native_struct_field(&self, expr: String) -> String {
        self.to_native(expr)
    }

    fn requires_move(&self) -> bool {
        false
    }
}

impl ToNativeStructField for FunctionArgStructField {
    fn to_native_struct_field(&self, expr: String) -> String {
        match self {
            FunctionArgStructField::Basic(x) => x.to_native_struct_field(expr),
            FunctionArgStructField::String(x) => x.to_native_struct_field(expr),
            FunctionArgStructField::Interface(x) => x.inner.to_native_struct_field(expr),
            FunctionArgStructField::Struct(x) => match x {
                UniversalOr::Specific(x) => x.to_native_struct_field(expr),
                UniversalOr::Universal(x) => x.to_native_struct_field(expr),
            },
        }
    }

    fn requires_move(&self) -> bool {
        match self {
            FunctionArgStructField::Basic(x) => x.requires_move(),
            FunctionArgStructField::String(x) => x.requires_move(),
            FunctionArgStructField::Interface(x) => x.inner.requires_move(),
            FunctionArgStructField::Struct(x) => match x {
                UniversalOr::Specific(x) => x.requires_move(),
                UniversalOr::Universal(x) => x.requires_move(),
            },
        }
    }
}

impl ToNativeStructField for UniversalStructField {
    fn to_native_struct_field(&self, expr: String) -> String {
        match self {
            UniversalStructField::Basic(x) => x.to_native_struct_field(expr),
            UniversalStructField::Struct(x) => x.to_native_struct_field(expr),
        }
    }

    fn requires_move(&self) -> bool {
        match self {
            UniversalStructField::Basic(x) => x.requires_move(),
            UniversalStructField::Struct(x) => x.requires_move(),
        }
    }
}