bevy_mod_ffi_host_sys 0.2.0

Low-level FFI bindings for bevy_mod_ffi hosts
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
412
413
414
415
416
417
418
419
420
421
use crate::{DynamicHooks, SharedRegistry, SharedSystem, SystemIn};
use bevy::{
    ecs::{
        component::{ComponentCloneBehavior, ComponentDescriptor, ComponentId, StorageType},
        lifecycle::HookContext,
        world::{DeferredWorld, World},
    },
    prelude::*,
    ptr::OwningPtr,
};
use bevy_mod_ffi_core::{
    deferred_world, entity_world_mut, system, world, BundleComponent, ComponentHookFn,
};
use std::{
    alloc::{self, Layout},
    any::TypeId,
    ffi::CStr,
    ptr::{self, NonNull},
    slice,
};

fn run_guest_hook(
    hook_fn: ComponentHookFn,
    deferred: &mut DeferredWorld<'_>,
    context: &HookContext,
) {
    let deferred_ptr = deferred as *mut DeferredWorld as *mut deferred_world;
    let entity_bits = context.entity.to_bits();
    let component_id_idx = context.component_id.index();
    unsafe {
        hook_fn(deferred_ptr, entity_bits, component_id_idx);
    }
}

pub mod entity;

pub mod deferred;

#[unsafe(no_mangle)]
pub unsafe extern "C" fn bevy_world_get_resource_id(
    world_ptr: *mut world,
    type_path_ptr: *const u8,
    type_path_len: usize,
    out_id: *mut usize,
) -> bool {
    let world = unsafe { &*(world_ptr as *const World) };

    let Some(type_id) = get_type_id(type_path_ptr, type_path_len, world) else {
        return false;
    };
    let Some(component_id) = world.components().get_resource_id(type_id) else {
        return false;
    };

    unsafe {
        *out_id = component_id.index();
    }

    true
}

#[unsafe(no_mangle)]
pub unsafe extern "C" fn bevy_world_get_resource(
    world_ptr: *mut world,
    component_id: usize,
    out_ptr: *mut *mut u8,
) -> bool {
    let world = unsafe { &*(world_ptr as *const World) };
    let id = ComponentId::new(component_id);

    let ptr = match world.get_resource_by_id(id) {
        Some(p) => p,
        None => {
            return false;
        }
    };

    unsafe {
        *out_ptr = ptr.as_ptr() as _;
    }

    true
}

#[unsafe(no_mangle)]
pub unsafe extern "C" fn bevy_world_get_component_id(
    world_ptr: *mut world,
    type_path_ptr: *const u8,
    type_path_len: usize,
    out_id: *mut usize,
) -> bool {
    let world = unsafe { &mut *(world_ptr as *mut World) };

    let type_path_bytes = unsafe { slice::from_raw_parts(type_path_ptr, type_path_len) };
    let type_path = CStr::from_bytes_with_nul(type_path_bytes)
        .unwrap()
        .to_str()
        .unwrap();

    let component_id = if let Some(type_id) = get_type_id(type_path_ptr, type_path_len, world) {
        let Some(component_id) = world.components().get_id(type_id) else {
            return false;
        };
        component_id
    } else if let Some(registry) = world.get_resource::<SharedRegistry>() {
        let Some(component_id) = registry.get_component_id(type_path) else {
            return false;
        };
        component_id
    } else {
        return false;
    };

    unsafe {
        *out_id = component_id.index();
    }

    true
}

#[unsafe(no_mangle)]
pub unsafe extern "C" fn bevy_world_run_system(
    world_ptr: *mut world,
    system_ptr: *mut system,
    input_ptr: *mut u8,
    output_ptr: *mut u8,
) {
    let world = unsafe { &mut *(world_ptr as *mut World) };
    let system = unsafe { &mut *(system_ptr as *mut SharedSystem) };

    let input = SystemIn {
        input_ptr,
        output_ptr,
    };
    system.run(input, world).unwrap();
}

#[unsafe(no_mangle)]
pub unsafe extern "C" fn bevy_world_register_component(
    world_ptr: *mut world,
    name_ptr: *const u8,
    name_len: usize,
    size: usize,
    align: usize,
    is_table: u8,
    on_add: Option<ComponentHookFn>,
    on_insert: Option<ComponentHookFn>,
    on_replace: Option<ComponentHookFn>,
    on_remove: Option<ComponentHookFn>,
    on_despawn: Option<ComponentHookFn>,
    out_id: *mut usize,
) -> bool {
    let world = unsafe { &mut *(world_ptr as *mut World) };

    let name_bytes = unsafe { slice::from_raw_parts(name_ptr, name_len) };
    let name = CStr::from_bytes_with_nul(name_bytes)
        .unwrap()
        .to_str()
        .unwrap()
        .to_string();

    let layout = match Layout::from_size_align(size, align) {
        Ok(l) => l,
        Err(_) => return false,
    };

    let storage_type = if is_table != 0 {
        StorageType::Table
    } else {
        StorageType::SparseSet
    };

    let descriptor = unsafe {
        ComponentDescriptor::new_with_layout(
            name.clone(),
            storage_type,
            layout,
            None,
            true,
            ComponentCloneBehavior::Ignore,
        )
    };

    let id = world.register_component_with_descriptor(descriptor);

    let dynamic_hooks = DynamicHooks {
        on_add,
        on_insert,
        on_replace,
        on_remove,
        on_despawn,
    };

    {
        let mut registry = world.resource_mut::<SharedRegistry>();
        registry.type_path_to_id.insert(name, id);
        registry.hooks.insert(id, dynamic_hooks);
    }

    if let Some(hooks) = world.register_component_hooks_by_id(id) {
        if on_add.is_some() {
            hooks.on_add(|mut deferred: DeferredWorld<'_>, context: HookContext| {
                let hook_fn = deferred
                    .resource::<SharedRegistry>()
                    .hooks
                    .get(&context.component_id)
                    .and_then(|h| h.on_add);
                if let Some(hook_fn) = hook_fn {
                    run_guest_hook(hook_fn, &mut deferred, &context);
                }
            });
        }
        if on_insert.is_some() {
            hooks.on_insert(|mut deferred: DeferredWorld<'_>, context: HookContext| {
                let hook_fn = deferred
                    .resource::<SharedRegistry>()
                    .hooks
                    .get(&context.component_id)
                    .and_then(|h| h.on_insert);
                if let Some(hook_fn) = hook_fn {
                    run_guest_hook(hook_fn, &mut deferred, &context);
                }
            });
        }
        if on_replace.is_some() {
            hooks.on_replace(|mut deferred: DeferredWorld<'_>, context: HookContext| {
                let hook_fn = deferred
                    .resource::<SharedRegistry>()
                    .hooks
                    .get(&context.component_id)
                    .and_then(|h| h.on_replace);
                if let Some(hook_fn) = hook_fn {
                    run_guest_hook(hook_fn, &mut deferred, &context);
                }
            });
        }
        if on_remove.is_some() {
            hooks.on_remove(|mut deferred: DeferredWorld<'_>, context: HookContext| {
                let hook_fn = deferred
                    .resource::<SharedRegistry>()
                    .hooks
                    .get(&context.component_id)
                    .and_then(|h| h.on_remove);
                if let Some(hook_fn) = hook_fn {
                    run_guest_hook(hook_fn, &mut deferred, &context);
                }
            });
        }
        if on_despawn.is_some() {
            hooks.on_despawn(|mut deferred: DeferredWorld<'_>, context: HookContext| {
                let hook_fn = deferred
                    .resource::<SharedRegistry>()
                    .hooks
                    .get(&context.component_id)
                    .and_then(|h| h.on_despawn);
                if let Some(hook_fn) = hook_fn {
                    run_guest_hook(hook_fn, &mut deferred, &context);
                }
            });
        }
    }

    unsafe {
        *out_id = id.index();
    }

    true
}

#[unsafe(no_mangle)]
pub unsafe extern "C" fn bevy_world_spawn(
    world_ptr: *mut world,
    components_ptr: *const BundleComponent,
    component_len: usize,
    out_entity: *mut u64,
    out_entity_world_mut_ptr: *mut *mut entity_world_mut,
) -> bool {
    let world = unsafe { &mut *(world_ptr as *mut World) };
    let components = unsafe { slice::from_raw_parts(components_ptr, component_len) };

    let mut components_data = Vec::new();
    for component in components {
        let component_id = ComponentId::new(component.component_id);
        let component_info = world.components().get_info(component_id).unwrap();
        let layout = component_info.layout();

        let buffer = alloc::alloc(layout);
        unsafe {
            ptr::copy(component.ptr, buffer, layout.size());
        }

        components_data.push((component_id, buffer));
    }

    let mut entity = world.spawn_empty();
    for (component_id, buffer) in components_data {
        unsafe {
            let owning_ptr = OwningPtr::new(NonNull::new_unchecked(buffer));
            entity.insert_by_id(component_id, owning_ptr);
        }
    }

    unsafe {
        *out_entity = entity.id().to_bits();
        *out_entity_world_mut_ptr = Box::into_raw(Box::new(entity)) as *mut entity_world_mut;
    }

    true
}

#[unsafe(no_mangle)]
pub unsafe extern "C" fn bevy_world_entity_mut(
    world_ptr: *mut world,
    entity_bits: u64,
    out_entity_world_mut_ptr: *mut *mut entity_world_mut,
) -> bool {
    let world = unsafe { &mut *(world_ptr as *mut World) };
    let entity = Entity::from_bits(entity_bits);

    let entity_mut = match world.get_entity_mut(entity) {
        Ok(e) => e,
        Err(_) => return false,
    };

    unsafe {
        *out_entity_world_mut_ptr = Box::into_raw(Box::new(entity_mut)) as *mut entity_world_mut;
    }

    true
}

fn get_type_id(type_path_ptr: *const u8, type_path_len: usize, world: &World) -> Option<TypeId> {
    let type_path_bytes = unsafe { slice::from_raw_parts(type_path_ptr, type_path_len) };
    let type_path = CStr::from_bytes_with_nul(type_path_bytes)
        .unwrap()
        .to_str()
        .unwrap();

    let registry = world.get_resource::<AppTypeRegistry>().unwrap();
    let registry_ref = registry.read();
    let registration = match registry_ref.get_with_type_path(type_path) {
        Some(r) => r,
        None => {
            return None;
        }
    };

    let type_id = registration.type_id();
    Some(type_id)
}

#[unsafe(no_mangle)]
pub unsafe extern "C" fn bevy_world_trigger_event(
    world_ptr: *mut world,
    event_name_ptr: *const u8,
    event_name_len: usize,
    event_data_ptr: *const u8,
    event_data_len: usize,
) -> bool {
    let world = unsafe { &mut *(world_ptr as *mut World) };

    let event_name_bytes = unsafe { slice::from_raw_parts(event_name_ptr, event_name_len) };
    let event_name = match CStr::from_bytes_with_nul(event_name_bytes) {
        Ok(cstr) => match cstr.to_str() {
            Ok(s) => s,
            Err(_) => return false,
        },
        Err(_) => return false,
    };

    let event_data = unsafe { slice::from_raw_parts(event_data_ptr, event_data_len) };

    let mut registry = world.remove_resource::<SharedRegistry>().unwrap();

    if let Some(event_ops) = registry.events.remove(event_name) {
        event_ops.trigger(world, event_data);
        let key = event_ops.type_path();
        registry.events.insert(key, event_ops);
        world.insert_resource(registry);
        true
    } else {
        world.insert_resource(registry);
        false
    }
}

#[unsafe(no_mangle)]
pub unsafe extern "C" fn bevy_world_trigger_event_targets(
    world_ptr: *mut world,
    event_name_ptr: *const u8,
    event_name_len: usize,
    event_data_ptr: *const u8,
    event_data_len: usize,
    entity_bits: u64,
) -> bool {
    let world = unsafe { &mut *(world_ptr as *mut World) };
    let entity = Entity::from_bits(entity_bits);

    let event_name_bytes = unsafe { slice::from_raw_parts(event_name_ptr, event_name_len) };
    let event_name = match CStr::from_bytes_with_nul(event_name_bytes) {
        Ok(cstr) => match cstr.to_str() {
            Ok(s) => s,
            Err(_) => return false,
        },
        Err(_) => return false,
    };

    let event_data = unsafe { slice::from_raw_parts(event_data_ptr, event_data_len) };

    let mut registry = world.remove_resource::<SharedRegistry>().unwrap();
    if let Some(event_ops) = registry.events.remove(event_name) {
        event_ops.trigger_for_entity(world.entity_mut(entity), event_data);
        let key = event_ops.type_path();
        registry.events.insert(key, event_ops);
        world.insert_resource(registry);
        true
    } else {
        world.insert_resource(registry);
        false
    }
}