summaryrefslogtreecommitdiffstats
path: root/toolkit/components/glean/api/src/ffi/macros.rs
blob: c6776e96af05fddf245d3f2de8c5679a6496533e (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
// 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 https://mozilla.org/MPL/2.0/.

//! Helper macros for implementing the FFI API for metric types.

/// Get a metric object by ID from the corresponding map.
///
/// # Arguments
///
/// * `$map` - The name of the hash map within `metrics::__glean_metric_maps`
///            as generated by glean_parser.
/// * `$id`  - The ID of the metric to get.
macro_rules! metric_get {
    ($map:ident, $id:ident) => {
        match $crate::metrics::__glean_metric_maps::$map.get(&$id.into()) {
            Some(metric) => metric,
            None => panic!("No metric for id {}", $id),
        }
    };
}

/// Test whether a value is stored for the metric identified by its ID.
///
/// # Arguments
///
/// * `$map`     - The name of the hash map within `metrics::__glean_metric_maps`
///                as generated by glean_parser.
/// * `$id`      - The ID of the metric to get.
/// * `$storage` - the storage name to look into.
macro_rules! test_has {
    ($map:ident, $id:ident, $storage:ident) => {{
        let metric = metric_get!($map, $id);
        let storage = if $storage.is_empty() {
            None
        } else {
            Some($storage.to_utf8())
        };
        metric.test_get_value(storage.as_deref()).is_some()
    }};
}

/// Get the currently stored value for the metric identified by its ID.
///
/// # Arguments
///
/// * `$map`     - The name of the hash map within `metrics::__glean_metric_maps`
///                as generated by glean_parser.
/// * `$id`      - The ID of the metric to get.
/// * `$storage` - the storage name to look into.
macro_rules! test_get {
    ($map:ident, $id:ident, $storage:ident) => {{
        let metric = metric_get!($map, $id);
        let storage = if $storage.is_empty() {
            None
        } else {
            Some($storage.to_utf8())
        };
        metric.test_get_value(storage.as_deref()).unwrap()
    }};
}