rusteal-macros 0.5.0

Proc macros (#[uclass], #[ufunction], #[uproperty]) for rusteal
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

// rusteal-macros: proc macros for #[uclass], #[ustruct], #[ufunction], #[uproperty].

mod prop_type;
mod uclass;
mod uclass_impl;
mod udelegate;
mod ustruct;

/// Attribute macro for defining a Rust struct as a UE class.
///
/// # Example
/// ```ignore
/// #[uclass(parent = Actor)]
/// pub struct MyEnemy {
///     #[uproperty(BlueprintReadWrite, default = 100.0)]
///     health: f32,
///
///     // Rust-private field (no #[uproperty])
///     chase_timer: f64,
/// }
/// ```
#[proc_macro_attribute]
pub fn uclass(
    attr: proc_macro::TokenStream,
    item: proc_macro::TokenStream,
) -> proc_macro::TokenStream {
    match uclass::expand_uclass(attr.into(), item.into()) {
        Ok(tokens) => tokens.into(),
        Err(err) => err.to_compile_error().into(),
    }
}

/// Attribute macro for an impl block on a `#[uclass]` struct.
/// Methods marked `#[ufunction(...)]` become UE-callable functions.
///
/// # Example
/// ```ignore
/// #[uclass_impl]
/// impl MyEnemy {
///     #[ufunction(BlueprintCallable)]
///     fn take_damage(&mut self, amount: f32) -> bool {
///         let h = self.health() - amount;
///         self.set_health(h.max(0.0));
///         h <= 0.0
///     }
///
///     fn helper(&self) -> f32 { self.health() * 2.0 }  // plain Rust method
/// }
/// ```
#[proc_macro_attribute]
pub fn uclass_impl(
    attr: proc_macro::TokenStream,
    item: proc_macro::TokenStream,
) -> proc_macro::TokenStream {
    match uclass_impl::expand_uclass_impl(attr.into(), item.into()) {
        Ok(tokens) => tokens.into(),
        Err(err) => err.to_compile_error().into(),
    }
}

/// Attribute macro for defining a Rust struct as a UE struct: a data table's
/// row, a property's value. Every field is a `#[uproperty]`; the struct's
/// memory is UE's, read and written through the generated `<Name>Ext` trait
/// on `UStructRef<Name>` and `OwnedStruct<Name>`.
///
/// # Example
/// ```ignore
/// #[ustruct]
/// pub struct WeaponTableRow {
///     #[uproperty(EditAnywhere)]
///     static_mesh: SoftObjectRef<StaticMesh>,
///     #[uproperty(EditAnywhere)]
///     weapon_to_spawn: SubclassOf<ShooterWeapon>,
/// }
/// ```
#[proc_macro_attribute]
pub fn ustruct(
    attr: proc_macro::TokenStream,
    item: proc_macro::TokenStream,
) -> proc_macro::TokenStream {
    match ustruct::expand_ustruct(attr.into(), item.into()) {
        Ok(tokens) => tokens.into(),
        Err(err) => err.to_compile_error().into(),
    }
}