cedar_policy_core/parser/loc.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
/*
* 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.
*/
use serde::{Deserialize, Serialize};
use std::sync::Arc;
/// Represents a source location: index/range, and a reference to the source
/// code which that index/range indexes into
#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize, PartialOrd, Ord)]
pub struct Loc {
/// `SourceSpan` indicating a specific source code location or range
pub span: miette::SourceSpan,
/// Original source code (which the above source span indexes into)
pub src: Arc<str>,
}
impl Loc {
/// Create a new `Loc`
pub fn new(span: impl Into<miette::SourceSpan>, src: Arc<str>) -> Self {
Self {
span: span.into(),
src,
}
}
/// Create a new `Loc` with the same source code but a different span
pub fn span(&self, span: impl Into<miette::SourceSpan>) -> Self {
Self {
span: span.into(),
src: Arc::clone(&self.src),
}
}
/// Get the index representing the start of the source span
pub fn start(&self) -> usize {
self.span.offset()
}
/// Get the index representing the end of the source span
pub fn end(&self) -> usize {
self.span.offset() + self.span.len()
}
/// Get the actual source snippet indicated, or `None` if the `Loc` isn't
/// internally consistent (its `SourceSpan` isn't a valid index into its
/// `src`)
pub fn snippet(&self) -> Option<&str> {
self.src.get(self.start()..self.end())
}
}
impl From<Loc> for miette::SourceSpan {
fn from(loc: Loc) -> Self {
loc.span
}
}
impl From<&Loc> for miette::SourceSpan {
fn from(loc: &Loc) -> Self {
loc.span
}
}
impl miette::SourceCode for Loc {
fn read_span<'a>(
&'a self,
span: &miette::SourceSpan,
context_lines_before: usize,
context_lines_after: usize,
) -> Result<Box<dyn miette::SpanContents<'a> + 'a>, miette::MietteError> {
self.src
.read_span(span, context_lines_before, context_lines_after)
}
}
impl miette::SourceCode for &Loc {
fn read_span<'a>(
&'a self,
span: &miette::SourceSpan,
context_lines_before: usize,
context_lines_after: usize,
) -> Result<Box<dyn miette::SpanContents<'a> + 'a>, miette::MietteError> {
self.src
.read_span(span, context_lines_before, context_lines_after)
}
}