cedar_policy_core/error_macros.rs
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
/*
* Copyright Cedar Contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/// Macro which implements the `.labels()` and `.source_code()` methods of
/// `miette::Diagnostic` by using the parameter `$i` which must be the name
/// of a field of type `Loc`
#[macro_export]
macro_rules! impl_diagnostic_from_source_loc_field {
( $i:ident ) => {
fn source_code(&self) -> Option<&dyn miette::SourceCode> {
Some(&self.$i.src as &dyn miette::SourceCode)
}
fn labels(&self) -> Option<Box<dyn Iterator<Item = miette::LabeledSpan> + '_>> {
Some(Box::new(std::iter::once(miette::LabeledSpan::underline(
self.$i.span,
))) as _)
}
};
}
/// Macro which implements the `.labels()` and `.source_code()` methods of
/// `miette::Diagnostic` by using the parameter `$i` which must be the name
/// of a field of type `Option<Loc>`
#[macro_export]
macro_rules! impl_diagnostic_from_source_loc_opt_field {
( $i:ident ) => {
fn source_code(&self) -> Option<&dyn miette::SourceCode> {
self.$i
.as_ref()
.map(|loc| &loc.src as &dyn miette::SourceCode)
}
fn labels(&self) -> Option<Box<dyn Iterator<Item = miette::LabeledSpan> + '_>> {
self.$i
.as_ref()
.map(|loc| Box::new(std::iter::once(miette::LabeledSpan::underline(loc.span))) as _)
}
};
}
/// Macro which implements the `.labels()` and `.source_code()` methods of
/// `miette::Diagnostic` by using the parameters `$i` and `$j` which must be
/// names of fields of type `Loc`.
/// Both locations will be underlined. It is assumed they have the same `src`.
#[macro_export]
macro_rules! impl_diagnostic_from_two_source_loc_fields {
( $i:ident, $j:ident ) => {
fn source_code(&self) -> Option<&dyn miette::SourceCode> {
// use the `src` from the first location and assume it is the same
// as the `src` from the second location
Some(&self.$i.src as &dyn miette::SourceCode)
}
fn labels(&self) -> Option<Box<dyn Iterator<Item = miette::LabeledSpan> + '_>> {
Some(Box::new(
[
miette::LabeledSpan::underline(self.$i.span),
miette::LabeledSpan::underline(self.$j.span),
]
.into_iter(),
) as _)
}
};
}
/// Macro which implements the `.labels()` and `.source_code()` methods of
/// `miette::Diagnostic` by using the parameters `$i` and `$j` which must be the
/// names of fields of type `Option<Loc>`.
/// Both locations will be underlined, if both locs are present.
/// It is assumed that both locs have the same `src`, if both locs are present.
#[macro_export]
macro_rules! impl_diagnostic_from_two_source_loc_opt_fields {
( $i:ident , $j:ident ) => {
fn source_code(&self) -> Option<&dyn miette::SourceCode> {
self.$i
.as_ref()
.map(|loc| &loc.src as &dyn miette::SourceCode)
.or_else(|| {
self.$j
.as_ref()
.map(|loc| &loc.src as &dyn miette::SourceCode)
})
}
fn labels(&self) -> Option<Box<dyn Iterator<Item = miette::LabeledSpan> + '_>> {
let x = self
.$i
.as_ref()
.map(|loc| miette::LabeledSpan::underline(loc.span));
let y = self
.$j
.as_ref()
.map(|loc| miette::LabeledSpan::underline(loc.span));
match (x, y) {
(None, None) => None,
(Some(span), None) | (None, Some(span)) => Some(Box::new(std::iter::once(span))),
(Some(span_a), Some(span_b)) => Some(Box::new([span_a, span_b].into_iter()) as _),
}
}
};
}
/// Macro which implements the `.labels()` and `.source_code()` methods of
/// `miette::Diagnostic` by using the parameter `$i` which must be an `Expr`
/// (or `Box<Expr>`) type field.
#[macro_export]
macro_rules! impl_diagnostic_from_expr_field {
( $i:ident ) => {
fn source_code(&self) -> Option<&dyn miette::SourceCode> {
self.$i
.source_loc()
.as_ref()
.map(|loc| &loc.src as &dyn miette::SourceCode)
}
fn labels(&self) -> Option<Box<dyn Iterator<Item = miette::LabeledSpan> + '_>> {
self.$i
.source_loc()
.as_ref()
.map(|loc| Box::new(std::iter::once(miette::LabeledSpan::underline(loc.span))) as _)
}
};
}