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
// Take a look at the license at the top of the repository in the LICENSE file.

use proc_macro2::Span;
use quote::ToTokens;
use syn::{
    parse::{Parse, ParseStream},
    punctuated::Punctuated,
    Attribute, DeriveInput, Error, Field, Fields, Ident, LitBool, LitStr, Meta, Result, Token,
    Type,
};

/// Custom meta keywords.
mod kw {
    // `template` attribute.
    syn::custom_keyword!(file);
    syn::custom_keyword!(resource);
    syn::custom_keyword!(string);
    syn::custom_keyword!(allow_template_child_without_attribute);

    // `template_child` attribute.
    syn::custom_keyword!(id);
    syn::custom_keyword!(internal);
}

/// The parsed `template` attribute.
pub struct Template {
    pub source: TemplateSource,
    pub allow_template_child_without_attribute: bool,
}

impl Parse for Template {
    fn parse(input: ParseStream) -> Result<Self> {
        let mut source = None;
        let mut allow_template_child_without_attribute = false;

        while !input.is_empty() {
            let lookahead = input.lookahead1();
            if lookahead.peek(kw::file) {
                let keyword: kw::file = input.parse()?;
                let _: Token![=] = input.parse()?;
                let value: LitStr = input.parse()?;

                if source.is_some() {
                    return Err(Error::new_spanned(
                        keyword,
                        "Specify only one of 'file', 'resource', or 'string'",
                    ));
                }

                source = Some(TemplateSource::File(value.value()));
            } else if lookahead.peek(kw::resource) {
                let keyword: kw::resource = input.parse()?;
                let _: Token![=] = input.parse()?;
                let value: LitStr = input.parse()?;

                if source.is_some() {
                    return Err(Error::new_spanned(
                        keyword,
                        "Specify only one of 'file', 'resource', or 'string'",
                    ));
                }

                source = Some(TemplateSource::Resource(value.value()));
            } else if lookahead.peek(kw::string) {
                let keyword: kw::string = input.parse()?;
                let _: Token![=] = input.parse()?;
                let value: LitStr = input.parse()?;

                if source.is_some() {
                    return Err(Error::new_spanned(
                        keyword,
                        "Specify only one of 'file', 'resource', or 'string'",
                    ));
                }

                source = Some(
                    TemplateSource::from_string_source(value.value())
                        .ok_or_else(|| Error::new_spanned(value, "Unknown language"))?,
                );
            } else if lookahead.peek(kw::allow_template_child_without_attribute) {
                let keyword: kw::allow_template_child_without_attribute = input.parse()?;

                if allow_template_child_without_attribute {
                    return Err(Error::new_spanned(
                        keyword,
                        "Duplicate 'allow_template_child_without_attribute'",
                    ));
                }

                allow_template_child_without_attribute = true;
            } else {
                return Err(lookahead.error());
            }

            if !input.is_empty() {
                let _: Token![,] = input.parse()?;
            }
        }

        let Some(source) = source else {
            return Err(Error::new(
                Span::call_site(),
                "Invalid meta, specify one of 'file', 'resource', or 'string'",
            ));
        };

        Ok(Template {
            source,
            allow_template_child_without_attribute,
        })
    }
}

/// The source of a template.
pub enum TemplateSource {
    File(String),
    Resource(String),
    Xml(String),
    #[cfg(feature = "blueprint")]
    Blueprint(String),
}

impl TemplateSource {
    fn from_string_source(value: String) -> Option<Self> {
        for c in value.chars() {
            #[cfg(feature = "blueprint")]
            if c.is_ascii_alphabetic() {
                // blueprint code starts with some alphabetic letters
                return Some(Self::Blueprint(value));
            } else if c == '<' {
                // xml tags starts with '<' symbol
                return Some(Self::Xml(value));
            }
            #[cfg(not(feature = "blueprint"))]
            if c == '<' {
                // xml tags starts with '<' symbol
                return Some(Self::Xml(value));
            }
        }

        None
    }
}

pub fn parse_template_source(input: &DeriveInput) -> Result<Template> {
    let Some(attr) = input
        .attrs
        .iter()
        .find(|attr| attr.path().is_ident("template"))
    else {
        return Err(Error::new(
            Span::call_site(),
            "Missing 'template' attribute",
        ));
    };

    attr.parse_args::<Template>()
}

/// An argument in a field attribute.
pub enum FieldAttributeArg {
    #[allow(dead_code)]
    // The span is needed for xml_validation feature
    Id(String, Span),
    Internal(bool),
}

impl FieldAttributeArg {
    fn from_template_child_meta(meta: &TemplateChildAttributeMeta) -> Self {
        match meta {
            TemplateChildAttributeMeta::Id { value, .. } => Self::Id(value.value(), value.span()),
            TemplateChildAttributeMeta::Internal { value, .. } => Self::Internal(value.value()),
        }
    }
}

/// The type of a field attribute.
#[derive(Debug)]
pub enum FieldAttributeType {
    TemplateChild,
}

/// A field attribute with args.
pub struct FieldAttribute {
    pub ty: FieldAttributeType,
    pub args: Vec<FieldAttributeArg>,
}

/// A field with an attribute.
pub struct AttributedField {
    pub ident: Ident,
    pub ty: Type,
    pub attr: FieldAttribute,
}

impl AttributedField {
    pub fn id(&self) -> String {
        let mut name = None;
        for arg in &self.attr.args {
            if let FieldAttributeArg::Id(value, _) = arg {
                name = Some(value)
            }
        }
        name.cloned().unwrap_or_else(|| self.ident.to_string())
    }

    #[cfg(feature = "xml_validation")]
    pub fn id_span(&self) -> Span {
        for arg in &self.attr.args {
            if let FieldAttributeArg::Id(_, span) = arg {
                return *span;
            }
        }
        self.ident.span()
    }
}

/// A meta item of a `template_child` attribute.
enum TemplateChildAttributeMeta {
    Id {
        keyword: kw::id,
        value: LitStr,
    },
    Internal {
        keyword: kw::internal,
        value: LitBool,
    },
}

impl Parse for TemplateChildAttributeMeta {
    fn parse(input: ParseStream) -> Result<Self> {
        let lookahead = input.lookahead1();
        if lookahead.peek(kw::id) {
            let keyword = input.parse()?;
            let _: Token![=] = input.parse()?;
            let value = input.parse()?;
            Ok(Self::Id { keyword, value })
        } else if lookahead.peek(kw::internal) {
            let keyword = input.parse()?;
            let _: Token![=] = input.parse()?;
            let value = input.parse()?;
            Ok(Self::Internal { keyword, value })
        } else {
            Err(lookahead.error())
        }
    }
}

impl ToTokens for TemplateChildAttributeMeta {
    fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {
        match self {
            Self::Id { keyword, .. } => keyword.to_tokens(tokens),
            Self::Internal { keyword, .. } => keyword.to_tokens(tokens),
        }
    }
}

fn parse_field_attr_args(ty: FieldAttributeType, attr: &Attribute) -> Result<FieldAttribute> {
    let mut args = Vec::new();

    if matches!(ty, FieldAttributeType::TemplateChild) && !matches!(attr.meta, Meta::Path(_)) {
        let meta_list = attr.parse_args_with(
            Punctuated::<TemplateChildAttributeMeta, Token![,]>::parse_terminated,
        )?;

        for meta in meta_list {
            let new_arg = FieldAttributeArg::from_template_child_meta(&meta);

            if args.iter().any(|arg| {
                // Comparison of enum variants, not data
                std::mem::discriminant(arg) == std::mem::discriminant(&new_arg)
            }) {
                return Err(Error::new_spanned(
                    meta,
                    "two instances of the same attribute \
                    argument, each argument must be specified only once",
                ));
            }

            args.push(new_arg);
        }
    }

    Ok(FieldAttribute { ty, args })
}

fn parse_field(field: &Field) -> Result<Option<AttributedField>> {
    let Some(ident) = &field.ident else {
        return Err(Error::new_spanned(field, "expected identifier"));
    };

    let mut attr_field = None;

    for attr in &field.attrs {
        let ty = if attr.path().is_ident("template_child") {
            FieldAttributeType::TemplateChild
        } else {
            continue;
        };

        let field_attr = parse_field_attr_args(ty, attr)?;

        if attr_field.is_some() {
            return Err(Error::new_spanned(
                attr,
                "multiple attributes on the same field are not supported",
            ));
        }

        attr_field = Some(AttributedField {
            ident: ident.clone(),
            ty: field.ty.clone(),
            attr: field_attr,
        })
    }

    Ok(attr_field)
}

fn path_is_template_child(path: &syn::Path) -> bool {
    if path.leading_colon.is_none()
        && path.segments.len() == 1
        && matches!(
            &path.segments[0].arguments,
            syn::PathArguments::AngleBracketed(_)
        )
        && path.segments[0].ident == "TemplateChild"
    {
        return true;
    }
    if path.segments.len() == 2
        && (path.segments[0].ident == "gtk" || path.segments[0].ident == "gtk4")
        && matches!(
            &path.segments[1].arguments,
            syn::PathArguments::AngleBracketed(_)
        )
        && path.segments[1].ident == "TemplateChild"
    {
        return true;
    }
    false
}

pub fn parse_fields(
    fields: &Fields,
    allow_missing_attribute: bool,
) -> Result<Vec<AttributedField>> {
    let mut attributed_fields = Vec::new();

    for field in fields {
        let mut has_attr = false;
        if !field.attrs.is_empty() {
            if let Some(attributed_field) = parse_field(field)? {
                attributed_fields.push(attributed_field);
                has_attr = true;
            }
        }
        if !has_attr && !allow_missing_attribute {
            if let syn::Type::Path(syn::TypePath { path, .. }) = &field.ty {
                if path_is_template_child(path) {
                    return Err(Error::new_spanned(
                        field,
                        format!("field `{}` with type `TemplateChild` possibly missing #[template_child] attribute. Use a meta attribute on the struct to suppress this error: '#[template(string|file|resource = \"...\", allow_template_child_without_attribute)]'",
                        field.ident.as_ref().unwrap())
                    ));
                }
            }
        }
    }

    Ok(attributed_fields)
}