enum2egui-derive 0.34.1

enum2egui-derive is a rust derive macro that creates a set of egui ui databindings from arbitrary data structures.
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

use crate::{derive_trait, get_custom_label, has_skip_attr};
use proc_macro::TokenStream;
use proc_macro2::{Ident, TokenStream as TokenStream2};
use quote::{ToTokens, quote, quote_spanned};
use syn::{DataStruct, Fields, FieldsNamed, FieldsUnnamed, spanned::Spanned};

pub fn derive_struct(name: &Ident, data: &DataStruct) -> TokenStream {
    let DataStruct { fields, .. } = data;

    match fields {
        Fields::Named(named_fields) => named_field_struct_impl(name, named_fields),
        Fields::Unnamed(unnamed_fields) => tuple_struct_impl(name, unnamed_fields),
        Fields::Unit => generate_unit_struct_impl(name),
    }
}

fn generate_unit_struct_impl(name: &Ident) -> TokenStream {
    derive_trait(
        name,
        proc_macro2::TokenStream::new(),
        proc_macro2::TokenStream::new(),
    )
}

fn tuple_struct_impl(name: &Ident, fields: &FieldsUnnamed) -> TokenStream {
    let FieldsUnnamed { unnamed, .. } = fields;
    let (field_blocks, field_blocks_mut) = tuple_struct_field_blocks(unnamed);

    let gui = struct_ui(name, field_blocks);
    let gui_mut = struct_ui(name, field_blocks_mut);
    derive_trait(name, gui, gui_mut)
}

fn tuple_struct_field_blocks(
    named: &syn::punctuated::Punctuated<syn::Field, syn::token::Comma>,
) -> (TokenStream2, TokenStream2) {
    let mut field_blocks = TokenStream2::new();
    let mut field_blocks_mut = TokenStream2::new();

    named.into_iter().enumerate().for_each(|(index, field)| {
        field_blocks.extend(unnamed_field_block(field, index));
        field_blocks_mut.extend(unnamed_field_block_mut(field, index));
    });

    (field_blocks, field_blocks_mut)
}

fn unnamed_field_label(index: usize) -> String {
    format!("field_{}", index)
}

fn unnamed_field_block(field: &syn::Field, index: usize) -> proc_macro2::TokenStream {
    if has_skip_attr(&field.attrs) {
        return quote! {};
    }

    let field_name = unnamed_field_label(index);
    let field_type = &field.ty;
    let index = syn::Index::from(index);

    let label = get_custom_label(&field.attrs).unwrap_or(field_name);

    quote_spanned! { field.span() =>
        ui.horizontal(|ui| {
            ui.label(#label);
            <#field_type as GuiInspect>::ui(&self.#index, ui);
        });
    }
    .to_token_stream()
}

fn unnamed_field_block_mut(field: &syn::Field, index: usize) -> proc_macro2::TokenStream {
    if has_skip_attr(&field.attrs) {
        return quote! {};
    }

    let field_name = unnamed_field_label(index);
    let field_type = &field.ty;
    let index = syn::Index::from(index);

    let label = get_custom_label(&field.attrs).unwrap_or(field_name);

    quote_spanned! { field.span() =>
        ui.horizontal(|ui| {
            ui.label(#label);
            <#field_type as GuiInspect>::ui_mut(&mut self.#index, ui);
        });
    }
    .to_token_stream()
}

fn named_field_struct_impl(name: &Ident, fields: &FieldsNamed) -> TokenStream {
    let FieldsNamed { named, .. } = fields;
    let (field_blocks, field_blocks_mut) = named_struct_field_blocks(named);

    let gui = struct_ui(name, field_blocks);
    let gui_mut = struct_ui(name, field_blocks_mut);
    derive_trait(name, gui, gui_mut)
}

fn named_struct_field_blocks(
    named: &syn::punctuated::Punctuated<syn::Field, syn::token::Comma>,
) -> (TokenStream2, TokenStream2) {
    let mut field_blocks = TokenStream2::new();
    let mut field_blocks_mut = TokenStream2::new();

    named.into_iter().for_each(|field| {
        field_blocks.extend(named_field_block(field));
        field_blocks_mut.extend(named_field_block_mut(field));
    });

    (field_blocks, field_blocks_mut)
}

fn named_field_block(field: &syn::Field) -> proc_macro2::TokenStream {
    if has_skip_attr(&field.attrs) {
        return quote! {};
    }

    let field_name = &field.ident;
    let field_ty = &field.ty;

    let label =
        get_custom_label(&field.attrs).unwrap_or_else(|| field_name.as_ref().unwrap().to_string());

    quote_spanned! { field.span() =>
        ui.horizontal(|ui| {
            ui.label(#label);
            <#field_ty as GuiInspect>::ui(&self.#field_name, ui);
        });
    }
    .to_token_stream()
}

fn named_field_block_mut(field: &syn::Field) -> proc_macro2::TokenStream {
    if has_skip_attr(&field.attrs) {
        return quote! {};
    }

    let field_name = &field.ident;
    let field_ty = &field.ty;

    let label =
        get_custom_label(&field.attrs).unwrap_or_else(|| field_name.as_ref().unwrap().to_string());

    quote_spanned! { field.span() =>
        ui.horizontal(|ui| {
            ui.label(#label);
            <#field_ty as GuiInspect>::ui_mut(&mut self.#field_name, ui);
        });
    }
    .to_token_stream()
}

fn struct_ui(name: &Ident, fields: proc_macro2::TokenStream) -> proc_macro2::TokenStream {
    quote! {
        ui.group(|ui| {
            ui.horizontal(|ui| {
                ui.label(stringify!(#name));
                ui.vertical(|ui| {
                    #fields
                });
            });
        });
    }
    .to_token_stream()
}