summaryrefslogtreecommitdiffstats
path: root/tools/profiler/rust-api/macros/src/lib.rs
blob: aca65cced315e4a8be9be037ec8ca400d7a7bbd8 (plain)
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
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/. */

#![deny(warnings)]

//! A procedural macro as a syntactical sugar to `gecko_profiler_label!` macro.
//! You can use this macro on top of functions to automatically append the
//! label frame to the function.
//!
//! Example usage:
//! ```rust
//! #[gecko_profiler_fn_label(DOM)]
//! fn foo(bar: u32) -> u32 {
//!     bar
//! }
//!
//! #[gecko_profiler_fn_label(Javascript, IonMonkey)]
//! pub fn bar(baz: i8) -> i8 {
//!     baz
//! }
//! ```
//!
//! See the documentation of `gecko_profiler_label!` macro to learn more about
//! its parameters.

extern crate proc_macro;

use proc_macro::TokenStream;
use quote::quote;
use syn::{parse_macro_input, ItemFn};

#[proc_macro_attribute]
pub fn gecko_profiler_fn_label(attrs: TokenStream, input: TokenStream) -> TokenStream {
    let mut attr_args = Vec::new();
    let attr_parser = syn::meta::parser(|meta| {
        attr_args.push(meta.path);
        Ok(())
    });
    parse_macro_input!(attrs with attr_parser);
    let input = parse_macro_input!(input as ItemFn);

    if attr_args.is_empty() || attr_args.len() > 2 {
        panic!("Expected one or two arguments as ProfilingCategory or ProfilingCategoryPair but {} arguments provided!", attr_args.len());
    }

    let category_name = &attr_args[0];
    // Try to get the subcategory if possible. Otherwise, use `None`.
    let subcategory_if_provided = match attr_args.get(1) {
        Some(subcategory) => quote!(, #subcategory),
        None => quote!(),
    };

    let ItemFn {
        attrs,
        vis,
        sig,
        block,
    } = input;
    let stmts = &block.stmts;

    let new_fn = quote! {
        #(#attrs)* #vis #sig {
          gecko_profiler_label!(#category_name#subcategory_if_provided);
          #(#stmts)*
        }
    };

    new_fn.into()
}