summaryrefslogtreecommitdiff
path: root/src/spans.rs
blob: c3d269dfa73829ef73cd6b6e16f464472e15ac5f (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
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
//! Source code spans.
//!
//! The [`DefaultEmitter`](crate::DefaultEmitter) is generic over a [`Span`].
//! This library comes with two Span implementations:
//!
//! * one for `()` which acts as the no-op implementation for when you don't want to track spans
//! * one for [`Range<usize>`] for when you do want to track spans
//!
//! To use the latter your reader however has to implement [`GetPos`].
//! You can easily use any existing reader by wrapping it in the [`PosTrackingReader`] struct
//! which implements the [`GetPos`] trait and takes care of tracking the current position.

use std::ops::Range;

use crate::{IntoReader, Reader};

/// A trait to be implemented by readers that track their own position.
pub trait GetPos {
    /// Returns the byte index of the current position.
    fn get_pos(&self) -> usize;
}

/// Wraps a [`Reader`] so that it implements [`GetPos`].
pub struct PosTrackingReader<R> {
    /// The wrapped reader.
    reader: R,
    /// The current position.
    position: usize,
}

impl<R> PosTrackingReader<R> {
    /// Wraps the given [`Reader`] so that it implements [`GetPos`] with the position starting from 0.
    pub fn new<'a>(into_reader: impl IntoReader<'a, Reader = R>) -> Self {
        Self {
            reader: into_reader.into_reader(),
            position: 0,
        }
    }
}

impl<R> GetPos for PosTrackingReader<R> {
    fn get_pos(&self) -> usize {
        self.position
    }
}

/// A byte range in the source code.
pub trait Span<R>: Default + Clone {
    /// Initializes a new span at the current position of the reader.
    fn from_reader(reader: &R) -> Self;

    /// Initializes a new span at the current position of the reader with the given offset.
    fn from_reader_with_offset(reader: &R, offset: usize) -> Self;

    /// Extends the span by the length of the given string.
    fn push_str(&mut self, str: &str);
}

impl<R> Span<R> for () {
    fn from_reader(_reader: &R) -> Self {}

    fn from_reader_with_offset(_reader: &R, _offset: usize) -> Self {}

    fn push_str(&mut self, _str: &str) {}
}

impl<P: GetPos> Span<P> for Range<usize> {
    fn from_reader(reader: &P) -> Self {
        reader.get_pos() - 1..reader.get_pos() - 1
    }

    fn from_reader_with_offset(reader: &P, offset: usize) -> Self {
        reader.get_pos() - 1 + offset..reader.get_pos() - 1 + offset
    }

    fn push_str(&mut self, str: &str) {
        self.end += str.len();
    }
}

impl<R: Reader> Reader for PosTrackingReader<R> {
    type Error = R::Error;

    fn read_char(&mut self) -> Result<Option<char>, Self::Error> {
        match self.reader.read_char()? {
            Some(char) => {
                self.position += char.len_utf8();
                Ok(Some(char))
            }
            None => Ok(None),
        }
    }

    fn try_read_string(&mut self, s: &str, case_sensitive: bool) -> Result<bool, Self::Error> {
        match self.reader.try_read_string(s, case_sensitive)? {
            true => {
                self.position += s.len();
                Ok(true)
            }
            false => Ok(false),
        }
    }
}