boltffi_bindgen 0.24.1

Code generation library for BoltFFI - generates Swift, Kotlin, and TypeScript bindings
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
use boltffi_ffi_rules::callable::{CallableForm, ExecutionKind};
use boltffi_ffi_rules::classification::{self, FieldPrimitive, PassableCategory};

use crate::ir::abi::CallId;
use crate::ir::ids::{
    CallbackId, ClassId, ConverterPath, CustomTypeId, EnumId, FieldName, FunctionId, MethodId,
    ParamName, QualifiedName, RecordId, StreamId, VariantName,
};
use crate::ir::types::{PrimitiveType, TypeExpr};

#[derive(Debug, Clone)]
pub struct DeprecationInfo {
    pub message: Option<String>,
    pub since: Option<String>,
}

#[derive(Debug, Clone)]
pub struct RecordDef {
    pub id: RecordId,
    pub is_repr_c: bool,
    pub is_error: bool,
    pub fields: Vec<FieldDef>,
    pub constructors: Vec<ConstructorDef>,
    pub methods: Vec<MethodDef>,
    pub doc: Option<String>,
    pub deprecated: Option<DeprecationInfo>,
}

impl RecordDef {
    pub fn has_methods(&self) -> bool {
        !self.constructors.is_empty() || !self.methods.is_empty()
    }

    pub fn constructor_calls(&self) -> impl Iterator<Item = (CallId, &ConstructorDef)> {
        self.constructors.iter().enumerate().map(|(i, ctor)| {
            (
                CallId::RecordConstructor {
                    record_id: self.id.clone(),
                    index: i,
                },
                ctor,
            )
        })
    }

    pub fn method_calls(&self) -> impl Iterator<Item = (CallId, &MethodDef)> {
        self.methods.iter().map(|m| {
            (
                CallId::RecordMethod {
                    record_id: self.id.clone(),
                    method_id: m.id.clone(),
                },
                m,
            )
        })
    }

    pub fn is_blittable(&self) -> bool {
        let field_primitives: Vec<FieldPrimitive> = self
            .fields
            .iter()
            .filter_map(|f| match &f.type_expr {
                TypeExpr::Primitive(p) => Some(p.to_field_primitive()),
                _ => None,
            })
            .collect();
        let all_primitive = field_primitives.len() == self.fields.len();
        let classify_fields = if all_primitive {
            &field_primitives[..]
        } else {
            &[]
        };
        matches!(
            classification::classify_struct(self.is_repr_c, classify_fields),
            PassableCategory::Blittable,
        )
    }
}

#[derive(Debug, Clone)]
pub struct FieldDef {
    pub name: FieldName,
    pub type_expr: TypeExpr,
    pub doc: Option<String>,
    pub default: Option<DefaultValue>,
}

#[derive(Debug, Clone)]
pub enum DefaultValue {
    Bool(bool),
    Integer(i64),
    Float(f64),
    String(String),
    EnumVariant {
        enum_name: String,
        variant_name: String,
    },
    Null,
}

#[derive(Debug, Clone)]
pub struct EnumDef {
    pub id: EnumId,
    pub repr: EnumRepr,
    pub is_error: bool,
    pub constructors: Vec<ConstructorDef>,
    pub methods: Vec<MethodDef>,
    pub doc: Option<String>,
    pub deprecated: Option<DeprecationInfo>,
}

impl EnumDef {
    pub fn has_methods(&self) -> bool {
        !self.constructors.is_empty() || !self.methods.is_empty()
    }

    pub fn constructor_calls(&self) -> impl Iterator<Item = (CallId, &ConstructorDef)> {
        self.constructors.iter().enumerate().map(|(i, ctor)| {
            (
                CallId::EnumConstructor {
                    enum_id: self.id.clone(),
                    index: i,
                },
                ctor,
            )
        })
    }

    pub fn method_calls(&self) -> impl Iterator<Item = (CallId, &MethodDef)> {
        self.methods.iter().map(|m| {
            (
                CallId::EnumMethod {
                    enum_id: self.id.clone(),
                    method_id: m.id.clone(),
                },
                m,
            )
        })
    }

    pub fn variant_docs(&self) -> Vec<Option<String>> {
        match &self.repr {
            EnumRepr::CStyle { variants, .. } => variants.iter().map(|v| v.doc.clone()).collect(),
            EnumRepr::Data { variants, .. } => variants.iter().map(|v| v.doc.clone()).collect(),
        }
    }
}

#[derive(Debug, Clone)]
pub enum EnumRepr {
    CStyle {
        tag_type: PrimitiveType,
        variants: Vec<CStyleVariant>,
    },
    Data {
        tag_type: PrimitiveType,
        variants: Vec<DataVariant>,
    },
}

#[derive(Debug, Clone)]
pub struct CStyleVariant {
    pub name: VariantName,
    pub discriminant: i128,
    pub doc: Option<String>,
}

#[derive(Debug, Clone)]
pub struct DataVariant {
    pub name: VariantName,
    pub discriminant: i128,
    pub payload: VariantPayload,
    pub doc: Option<String>,
}

#[derive(Debug, Clone)]
pub enum VariantPayload {
    Unit,
    Tuple(Vec<TypeExpr>),
    Struct(Vec<FieldDef>),
}

#[derive(Debug, Clone)]
pub struct FunctionDef {
    pub id: FunctionId,
    pub params: Vec<ParamDef>,
    pub returns: ReturnDef,
    pub execution_kind: ExecutionKind,
    pub doc: Option<String>,
    pub deprecated: Option<DeprecationInfo>,
}

impl FunctionDef {
    pub fn is_async(&self) -> bool {
        self.execution_kind == ExecutionKind::Async
    }

    pub fn callable_form(&self) -> CallableForm {
        CallableForm::Function
    }

    pub fn execution_kind(&self) -> ExecutionKind {
        self.execution_kind
    }
}

#[derive(Debug, Clone)]
pub struct ParamDef {
    pub name: ParamName,
    pub type_expr: TypeExpr,
    pub passing: ParamPassing,
    pub doc: Option<String>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ParamPassing {
    Value,
    Ref,
    RefMut,
    ImplTrait,
    BoxedDyn,
}

#[derive(Debug, Clone)]
pub enum ReturnDef {
    Void,
    Value(TypeExpr),
    Result { ok: TypeExpr, err: TypeExpr },
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum StreamMode {
    Async,
    Batch,
    Callback,
}

#[derive(Debug, Clone)]
pub struct StreamDef {
    pub id: StreamId,
    pub item_type: TypeExpr,
    pub mode: StreamMode,
    pub doc: Option<String>,
    pub deprecated: Option<DeprecationInfo>,
}

#[derive(Debug, Clone)]
pub struct ClassDef {
    pub id: ClassId,
    pub constructors: Vec<ConstructorDef>,
    pub methods: Vec<MethodDef>,
    pub streams: Vec<StreamDef>,
    pub doc: Option<String>,
    pub deprecated: Option<DeprecationInfo>,
}

#[derive(Debug, Clone)]
pub enum ConstructorDef {
    Default {
        params: Vec<ParamDef>,
        is_fallible: bool,
        is_optional: bool,
        doc: Option<String>,
        deprecated: Option<DeprecationInfo>,
    },
    NamedFactory {
        name: MethodId,
        is_fallible: bool,
        is_optional: bool,
        doc: Option<String>,
        deprecated: Option<DeprecationInfo>,
    },
    NamedInit {
        name: MethodId,
        first_param: ParamDef,
        rest_params: Vec<ParamDef>,
        is_fallible: bool,
        is_optional: bool,
        doc: Option<String>,
        deprecated: Option<DeprecationInfo>,
    },
}

impl ConstructorDef {
    pub fn params(&self) -> Vec<&ParamDef> {
        match self {
            Self::Default { params, .. } => params.iter().collect(),
            Self::NamedFactory { .. } => vec![],
            Self::NamedInit {
                first_param,
                rest_params,
                ..
            } => std::iter::once(first_param).chain(rest_params).collect(),
        }
    }

    pub fn is_fallible(&self) -> bool {
        match self {
            Self::Default { is_fallible, .. }
            | Self::NamedFactory { is_fallible, .. }
            | Self::NamedInit { is_fallible, .. } => *is_fallible,
        }
    }

    pub fn is_optional(&self) -> bool {
        match self {
            Self::Default { is_optional, .. }
            | Self::NamedFactory { is_optional, .. }
            | Self::NamedInit { is_optional, .. } => *is_optional,
        }
    }

    pub fn name(&self) -> Option<&MethodId> {
        match self {
            Self::Default { .. } => None,
            Self::NamedFactory { name, .. } | Self::NamedInit { name, .. } => Some(name),
        }
    }

    pub fn doc(&self) -> Option<&str> {
        match self {
            Self::Default { doc, .. }
            | Self::NamedFactory { doc, .. }
            | Self::NamedInit { doc, .. } => doc.as_deref(),
        }
    }
}

#[derive(Debug, Clone)]
pub struct MethodDef {
    pub id: MethodId,
    pub receiver: Receiver,
    pub params: Vec<ParamDef>,
    pub returns: ReturnDef,
    pub execution_kind: ExecutionKind,
    pub doc: Option<String>,
    pub deprecated: Option<DeprecationInfo>,
}

impl MethodDef {
    pub fn is_async(&self) -> bool {
        self.execution_kind == ExecutionKind::Async
    }

    pub fn callable_form(&self) -> CallableForm {
        self.receiver.callable_form()
    }

    pub fn execution_kind(&self) -> ExecutionKind {
        self.execution_kind
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Receiver {
    Static,
    RefSelf,
    RefMutSelf,
    OwnedSelf,
}

impl Receiver {
    pub fn callable_form(self) -> CallableForm {
        match self {
            Self::Static => CallableForm::StaticMethod,
            Self::RefSelf | Self::RefMutSelf | Self::OwnedSelf => CallableForm::InstanceMethod,
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CallbackKind {
    Trait,
    Closure,
}

#[derive(Debug, Clone)]
pub struct CallbackTraitDef {
    pub id: CallbackId,
    pub methods: Vec<CallbackMethodDef>,
    pub kind: CallbackKind,
    pub doc: Option<String>,
}

#[derive(Debug, Clone)]
pub struct CallbackMethodDef {
    pub id: MethodId,
    pub params: Vec<ParamDef>,
    pub returns: ReturnDef,
    pub execution_kind: ExecutionKind,
    pub doc: Option<String>,
}

impl CallbackMethodDef {
    pub fn is_async(&self) -> bool {
        self.execution_kind == ExecutionKind::Async
    }

    pub fn execution_kind(&self) -> ExecutionKind {
        self.execution_kind
    }
}

#[derive(Debug, Clone)]
pub struct CustomTypeDef {
    pub id: CustomTypeId,
    pub rust_type: QualifiedName,
    pub repr: TypeExpr,
    pub converters: ConverterPath,
    pub doc: Option<String>,
}