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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
//! Parser for format descriptions.

use alloc::vec::Vec;
use core::ops::{RangeFrom, RangeTo};

mod ast;
mod format_item;
mod lexer;

/// Parse a sequence of items from the format description.
///
/// The syntax for the format description can be found in [the
/// book](https://time-rs.github.io/book/api/format-description.html).
pub fn parse(
    s: &str,
) -> Result<Vec<crate::format_description::FormatItem<'_>>, crate::error::InvalidFormatDescription>
{
    let lexed = lexer::lex(s.as_bytes());
    let ast = ast::parse(lexed);
    let format_items = format_item::parse(ast);
    Ok(format_items
        .map(|res| res.map(Into::into))
        .collect::<Result<Vec<_>, _>>()?)
}

/// Parse a sequence of items from the format description.
///
/// The syntax for the format description can be found in [the
/// book](https://time-rs.github.io/book/api/format-description.html).
///
/// Unlike [`parse`], this function returns [`OwnedFormatItem`], which owns its contents. This means
/// that there is no lifetime that needs to be handled.
///
/// [`OwnedFormatItem`]: crate::format_description::OwnedFormatItem
pub fn parse_owned(
    s: &str,
) -> Result<crate::format_description::OwnedFormatItem, crate::error::InvalidFormatDescription> {
    let lexed = lexer::lex(s.as_bytes());
    let ast = ast::parse(lexed);
    let format_items = format_item::parse(ast);
    let items = format_items
        .map(|res| res.map(Into::into))
        .collect::<Result<Vec<_>, _>>()?
        .into_boxed_slice();
    Ok(crate::format_description::OwnedFormatItem::Compound(items))
}

/// A location within a string.
#[derive(Clone, Copy)]
struct Location {
    /// The one-indexed line of the string.
    line: usize,
    /// The one-indexed column of the string.
    column: usize,
    /// The zero-indexed byte of the string.
    byte: usize,
}

impl Location {
    /// Offset the location by the provided amount.
    ///
    /// Note that this assumes the resulting location is on the same line as the original location.
    #[must_use = "this does not modify the original value"]
    const fn offset(&self, offset: usize) -> Self {
        Self {
            line: self.line,
            column: self.column + offset,
            byte: self.byte + offset,
        }
    }

    /// Create an error with the provided message at this location.
    const fn error(self, message: &'static str) -> ErrorInner {
        ErrorInner {
            _message: message,
            _span: Span {
                start: self,
                end: self,
            },
        }
    }
}

/// A start and end point within a string.
#[derive(Clone, Copy)]
struct Span {
    #[allow(clippy::missing_docs_in_private_items)]
    start: Location,
    #[allow(clippy::missing_docs_in_private_items)]
    end: Location,
}

impl Span {
    /// Create a new `Span` from the provided start and end locations.
    const fn start_end(start: Location, end: Location) -> Self {
        Self { start, end }
    }

    /// Reduce this span to the provided range.
    #[must_use = "this does not modify the original value"]
    fn subspan(&self, range: impl Subspan) -> Self {
        range.subspan(self)
    }

    /// Obtain a `Span` pointing at the start of the pre-existing span.
    #[must_use = "this does not modify the original value"]
    const fn shrink_to_start(&self) -> Self {
        Self {
            start: self.start,
            end: self.start,
        }
    }

    /// Obtain a `Span` pointing at the end of the pre-existing span.
    #[must_use = "this does not modify the original value"]
    const fn shrink_to_end(&self) -> Self {
        Self {
            start: self.end,
            end: self.end,
        }
    }

    /// Create an error with the provided message at this span.
    const fn error(self, message: &'static str) -> ErrorInner {
        ErrorInner {
            _message: message,
            _span: self,
        }
    }

    /// Get the byte index that the span starts at.
    const fn start_byte(&self) -> usize {
        self.start.byte
    }
}

/// A trait for types that can be used to reduce a `Span`.
trait Subspan {
    /// Reduce the provided `Span` to a new `Span`.
    fn subspan(self, span: &Span) -> Span;
}

impl Subspan for RangeFrom<usize> {
    fn subspan(self, span: &Span) -> Span {
        assert_eq!(span.start.line, span.end.line);

        Span {
            start: Location {
                line: span.start.line,
                column: span.start.column + self.start,
                byte: span.start.byte + self.start,
            },
            end: span.end,
        }
    }
}

impl Subspan for RangeTo<usize> {
    fn subspan(self, span: &Span) -> Span {
        assert_eq!(span.start.line, span.end.line);

        Span {
            start: span.start,
            end: Location {
                line: span.start.line,
                column: span.start.column + self.end - 1,
                byte: span.start.byte + self.end - 1,
            },
        }
    }
}

/// The internal error type.
struct ErrorInner {
    /// The message displayed to the user.
    _message: &'static str,
    /// Where the error originated.
    _span: Span,
}

/// A complete error description.
struct Error {
    /// The internal error.
    _inner: ErrorInner,
    /// The error needed for interoperability with the rest of `time`.
    public: crate::error::InvalidFormatDescription,
}

impl From<Error> for crate::error::InvalidFormatDescription {
    fn from(error: Error) -> Self {
        error.public
    }
}