bronzite-macros 0.2.1

🔮 Proc-macros for Bronzite compile-time type reflection - inspect traits, fields, and methods at compile time
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
422
423
424
425
426
427
428
429
430
431
432
433
434
//! Proc-macros for compile-time type reflection using Bronzite.
//!
//! This crate provides proc-macros that query type information from a running
//! Bronzite daemon. The daemon is automatically started if not already running.
//!
//! # Usage
//!
//! ```ignore
//! // Get trait implementations as a const array of trait names
//! const IMPLS: &[&str] = bronzite_trait_names!("my_crate", "MyStruct");
//! ```
//!
//! # Note for Proc-Macro Authors
//!
//! If you're writing a proc-macro and want to query Bronzite programmatically,
//! use the `bronzite-client` crate directly instead of this one:
//!
//! ```ignore
//! use bronzite_client::{connect_or_start, BronziteClient};
//!
//! let mut client = connect_or_start(None)?;
//! let impls = client.get_trait_impls("my_crate", "MyType")?;
//! ```

use proc_macro::TokenStream;
use proc_macro2::TokenStream as TokenStream2;
use quote::quote;
use std::sync::OnceLock;

use bronzite_types::{
    FieldInfo, InherentImplDetails, TraitDetails, TraitImplDetails, TraitInfo, TypeDetails,
    TypeSummary,
};

/// Global flag tracking daemon initialization.
static DAEMON_INITIALIZED: OnceLock<bool> = OnceLock::new();

/// Ensure the daemon is running. Called automatically by query functions.
fn ensure_daemon() -> Result<(), String> {
    DAEMON_INITIALIZED.get_or_init(|| {
        match bronzite_client::ensure_daemon_running(None) {
            Ok(()) => true,
            Err(e) => {
                // We can't return an error from get_or_init, so we store false
                // and check it later
                eprintln!("[bronzite] Warning: Failed to start daemon: {}", e);
                false
            }
        }
    });

    if *DAEMON_INITIALIZED.get().unwrap_or(&false) {
        Ok(())
    } else {
        Err("Failed to initialize bronzite daemon".to_string())
    }
}

/// Get a connected client.
fn get_client() -> Result<bronzite_client::BronziteClient, String> {
    ensure_daemon()?;
    bronzite_client::connect().map_err(|e| e.to_string())
}

// ============================================================================
// Internal Query Functions
// ============================================================================

fn query_trait_impls(crate_name: &str, type_path: &str) -> Result<Vec<TraitImplDetails>, String> {
    let mut client = get_client()?;
    client
        .get_trait_impls(crate_name, type_path)
        .map_err(|e| e.to_string())
}

fn query_inherent_impls(
    crate_name: &str,
    type_path: &str,
) -> Result<Vec<InherentImplDetails>, String> {
    let mut client = get_client()?;
    client
        .get_inherent_impls(crate_name, type_path)
        .map_err(|e| e.to_string())
}

fn query_fields(crate_name: &str, type_path: &str) -> Result<Vec<FieldInfo>, String> {
    let mut client = get_client()?;
    client
        .get_fields(crate_name, type_path)
        .map_err(|e| e.to_string())
}

#[allow(dead_code)]
fn query_type(crate_name: &str, type_path: &str) -> Result<TypeDetails, String> {
    let mut client = get_client()?;
    client
        .get_type(crate_name, type_path)
        .map_err(|e| e.to_string())
}

fn query_check_impl(
    crate_name: &str,
    type_path: &str,
    trait_path: &str,
) -> Result<(bool, Option<TraitImplDetails>), String> {
    let mut client = get_client()?;
    client
        .check_impl(crate_name, type_path, trait_path)
        .map_err(|e| e.to_string())
}

fn query_traits(crate_name: &str) -> Result<Vec<TraitInfo>, String> {
    let mut client = get_client()?;
    client.get_traits(crate_name).map_err(|e| e.to_string())
}

#[allow(dead_code)]
fn query_trait(crate_name: &str, trait_path: &str) -> Result<TraitDetails, String> {
    let mut client = get_client()?;
    client
        .get_trait(crate_name, trait_path)
        .map_err(|e| e.to_string())
}

#[allow(dead_code)]
fn query_find_types(crate_name: &str, pattern: &str) -> Result<Vec<TypeSummary>, String> {
    let mut client = get_client()?;
    client
        .find_types(crate_name, pattern)
        .map_err(|e| e.to_string())
}

fn query_resolve_alias(
    crate_name: &str,
    alias_path: &str,
) -> Result<(String, String, Vec<String>), String> {
    let mut client = get_client()?;
    client
        .resolve_alias(crate_name, alias_path)
        .map_err(|e| e.to_string())
}

fn query_implementors(crate_name: &str, trait_path: &str) -> Result<Vec<TypeSummary>, String> {
    let mut client = get_client()?;
    client
        .get_implementors(crate_name, trait_path)
        .map_err(|e| e.to_string())
}

// ============================================================================
// Helper for parsing macro input
// ============================================================================

struct MacroArgs {
    crate_name: String,
    type_path: String,
    trait_path: Option<String>,
}

fn parse_two_args(input: TokenStream) -> Result<MacroArgs, TokenStream2> {
    let input_str = input.to_string();
    let parts: Vec<&str> = input_str.split(',').map(|s| s.trim()).collect();

    if parts.len() != 2 {
        return Err(quote! {
            compile_error!("Expected two arguments: crate_name, type_path")
        });
    }

    let crate_name = parts[0].trim_matches('"').to_string();
    let type_path = parts[1].trim_matches('"').to_string();

    Ok(MacroArgs {
        crate_name,
        type_path,
        trait_path: None,
    })
}

fn parse_three_args(input: TokenStream) -> Result<MacroArgs, TokenStream2> {
    let input_str = input.to_string();
    let parts: Vec<&str> = input_str.split(',').map(|s| s.trim()).collect();

    if parts.len() != 3 {
        return Err(quote! {
            compile_error!("Expected three arguments: crate_name, type_path, trait_path")
        });
    }

    let crate_name = parts[0].trim_matches('"').to_string();
    let type_path = parts[1].trim_matches('"').to_string();
    let trait_path = parts[2].trim_matches('"').to_string();

    Ok(MacroArgs {
        crate_name,
        type_path,
        trait_path: Some(trait_path),
    })
}

fn parse_one_arg(input: TokenStream) -> Result<String, TokenStream2> {
    let input_str = input.to_string();
    let crate_name = input_str.trim().trim_matches('"').to_string();

    if crate_name.is_empty() {
        return Err(quote! {
            compile_error!("Expected one argument: crate_name")
        });
    }

    Ok(crate_name)
}

// ============================================================================
// Proc-Macros
// ============================================================================

/// Get the names of all traits implemented by a type as a const slice.
///
/// # Example
///
/// ```ignore
/// const TRAIT_NAMES: &[&str] = bronzite_trait_names!("my_crate", "MyStruct");
/// // Expands to: &["Debug", "Clone", "MyTrait", ...]
/// ```
#[proc_macro]
pub fn bronzite_trait_names(input: TokenStream) -> TokenStream {
    let args = match parse_two_args(input) {
        Ok(a) => a,
        Err(e) => return e.into(),
    };

    match query_trait_impls(&args.crate_name, &args.type_path) {
        Ok(impls) => {
            let names: Vec<String> = impls.iter().map(|i| i.trait_path.clone()).collect();

            let output = quote! {
                &[#(#names),*]
            };
            output.into()
        }
        Err(e) => {
            let msg = format!("bronzite error: {}", e);
            quote! { compile_error!(#msg) }.into()
        }
    }
}

/// Check if a type implements a trait at compile time.
///
/// Returns `true` or `false` as a literal.
///
/// # Example
///
/// ```ignore
/// const IMPLEMENTS_DEBUG: bool = bronzite_implements!("my_crate", "MyStruct", "Debug");
/// ```
#[proc_macro]
pub fn bronzite_implements(input: TokenStream) -> TokenStream {
    let args = match parse_three_args(input) {
        Ok(a) => a,
        Err(e) => return e.into(),
    };

    let trait_path = args.trait_path.unwrap();

    match query_check_impl(&args.crate_name, &args.type_path, &trait_path) {
        Ok((implements, _)) => {
            let output = if implements {
                quote! { true }
            } else {
                quote! { false }
            };
            output.into()
        }
        Err(e) => {
            let msg = format!("bronzite error: {}", e);
            quote! { compile_error!(#msg) }.into()
        }
    }
}

/// Get field names of a struct as a const slice.
///
/// # Example
///
/// ```ignore
/// const FIELD_NAMES: &[&str] = bronzite_field_names!("my_crate", "MyStruct");
/// // Expands to: &["field1", "field2", ...]
/// ```
#[proc_macro]
pub fn bronzite_field_names(input: TokenStream) -> TokenStream {
    let args = match parse_two_args(input) {
        Ok(a) => a,
        Err(e) => return e.into(),
    };

    match query_fields(&args.crate_name, &args.type_path) {
        Ok(fields) => {
            let names: Vec<String> = fields.iter().filter_map(|f| f.name.clone()).collect();

            let output = quote! {
                &[#(#names),*]
            };
            output.into()
        }
        Err(e) => {
            let msg = format!("bronzite error: {}", e);
            quote! { compile_error!(#msg) }.into()
        }
    }
}

/// Get method names from a type's inherent impl as a const slice.
///
/// # Example
///
/// ```ignore
/// const METHOD_NAMES: &[&str] = bronzite_method_names!("my_crate", "MyStruct");
/// // Expands to: &["new", "do_thing", ...]
/// ```
#[proc_macro]
pub fn bronzite_method_names(input: TokenStream) -> TokenStream {
    let args = match parse_two_args(input) {
        Ok(a) => a,
        Err(e) => return e.into(),
    };

    match query_inherent_impls(&args.crate_name, &args.type_path) {
        Ok(impls) => {
            let names: Vec<String> = impls
                .iter()
                .flat_map(|i| i.methods.iter())
                .map(|m| m.name.clone())
                .collect();

            let output = quote! {
                &[#(#names),*]
            };
            output.into()
        }
        Err(e) => {
            let msg = format!("bronzite error: {}", e);
            quote! { compile_error!(#msg) }.into()
        }
    }
}

/// Get all trait names defined in a crate as a const slice.
///
/// # Example
///
/// ```ignore
/// const CRATE_TRAITS: &[&str] = bronzite_crate_traits!("my_crate");
/// ```
#[proc_macro]
pub fn bronzite_crate_traits(input: TokenStream) -> TokenStream {
    let crate_name = match parse_one_arg(input) {
        Ok(c) => c,
        Err(e) => return e.into(),
    };

    match query_traits(&crate_name) {
        Ok(traits) => {
            let names: Vec<String> = traits.iter().map(|t| t.name.clone()).collect();

            let output = quote! {
                &[#(#names),*]
            };
            output.into()
        }
        Err(e) => {
            let msg = format!("bronzite error: {}", e);
            quote! { compile_error!(#msg) }.into()
        }
    }
}

/// Resolve a type alias and get the underlying type as a string literal.
///
/// # Example
///
/// ```ignore
/// const RESOLVED: &str = bronzite_resolve_alias!("my_crate", "MyAlias");
/// // Expands to: "actual::Type"
/// ```
#[proc_macro]
pub fn bronzite_resolve_alias(input: TokenStream) -> TokenStream {
    let args = match parse_two_args(input) {
        Ok(a) => a,
        Err(e) => return e.into(),
    };

    match query_resolve_alias(&args.crate_name, &args.type_path) {
        Ok((_, resolved, _)) => {
            let output = quote! { #resolved };
            output.into()
        }
        Err(e) => {
            let msg = format!("bronzite error: {}", e);
            quote! { compile_error!(#msg) }.into()
        }
    }
}

/// Get types that implement a trait as a const slice of type path strings.
///
/// # Example
///
/// ```ignore
/// const IMPLEMENTORS: &[&str] = bronzite_implementors!("my_crate", "MyTrait");
/// ```
#[proc_macro]
pub fn bronzite_implementors(input: TokenStream) -> TokenStream {
    let args = match parse_two_args(input) {
        Ok(a) => a,
        Err(e) => return e.into(),
    };

    match query_implementors(&args.crate_name, &args.type_path) {
        Ok(types) => {
            let paths: Vec<String> = types.iter().map(|t| t.path.clone()).collect();

            let output = quote! {
                &[#(#paths),*]
            };
            output.into()
        }
        Err(e) => {
            let msg = format!("bronzite error: {}", e);
            quote! { compile_error!(#msg) }.into()
        }
    }
}