knave-expand 0.13.2

The reading, scoping and expansion stages of knave
Documentation 
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

use crate::source::Span;

#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct Label {
    span: Span,
    message: String,
    marks_a_macro_call: bool,
}

impl Label {
    pub fn new(span: Span, message: impl Into<String>) -> Self {
        Self {
            span,
            message: message.into(),
            marks_a_macro_call: false,
        }
    }

    pub fn at_macro_call(span: Span, message: impl Into<String>) -> Self {
        Self {
            marks_a_macro_call: true,
            ..Self::new(span, message)
        }
    }

    pub fn marks_a_macro_call(&self) -> bool {
        self.marks_a_macro_call
    }

    pub fn span(&self) -> Span {
        self.span
    }

    pub fn message(&self) -> &str {
        &self.message
    }
}

#[derive(Clone, Debug)]
pub struct Edit {
    span: Span,
    replacement: String,
}

impl Edit {
    pub fn span(&self) -> Span {
        self.span
    }

    pub fn replacement(&self) -> &str {
        &self.replacement
    }
}

#[derive(Clone, Debug)]
pub struct Suggestion {
    edits: Vec<Edit>,
}

impl Suggestion {
    pub fn new(span: Span, replacement: impl Into<String>) -> Self {
        Self {
            edits: vec![Edit {
                span,
                replacement: replacement.into(),
            }],
        }
    }

    pub fn wrapping(span: Span, opening: impl Into<String>, closing: impl Into<String>) -> Self {
        Self {
            edits: vec![
                Edit {
                    span: span.start(),
                    replacement: opening.into(),
                },
                Edit {
                    span: span.end(),
                    replacement: closing.into(),
                },
            ],
        }
    }

    pub fn edits(&self) -> &[Edit] {
        &self.edits
    }
}

#[derive(Clone, Debug)]
pub struct Help {
    message: String,
    suggestion: Option<Suggestion>,
    quoted_form: Option<Span>,
}

impl Help {
    pub const QUOTED_FORM: &str = "{form}";

    pub fn new(message: String) -> Self {
        Self {
            message,
            suggestion: None,
            quoted_form: None,
        }
    }

    pub fn quoting(message: String, form: Span) -> Self {
        Self {
            quoted_form: Some(form),
            ..Self::new(message)
        }
    }

    pub fn quoted_form(&self) -> Option<Span> {
        self.quoted_form
    }

    pub fn with_suggestion(self, suggestion: Suggestion) -> Self {
        Self {
            suggestion: Some(suggestion),
            ..self
        }
    }

    pub fn message(&self) -> &str {
        &self.message
    }

    pub fn suggestion(&self) -> Option<&Suggestion> {
        self.suggestion.as_ref()
    }
}

#[cfg(test)]
mod tests {
    use super::Label;
    use crate::source::{SourceId, Span};

    struct LabelFixture;

    impl LabelFixture {
        fn span() -> Span {
            Span::new(SourceId::new(0), 0..1)
        }
    }

    #[test]
    fn a_label_at_a_macro_call_marks_the_call() {
        assert!(Label::at_macro_call(LabelFixture::span(), "call").marks_a_macro_call());
    }

    #[test]
    fn a_plain_label_marks_no_macro_call() {
        assert!(!Label::new(LabelFixture::span(), "plain").marks_a_macro_call());
    }
}