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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
use std::fmt;

/// A wrapper for a syntax node to be displayed
#[derive(Clone, Copy)]
pub struct NodeDisplayWrapper<'a, T: ?Sized> {
    node: &'a T,
    current_level: usize,
}

impl NodeDisplayWrapper<'static, str> {
    /// Create a new [NodeDisplayWrapper]
    ///
    /// # Parameters
    ///
    /// * `name`: name of the node being displayed
    /// * `level`: current indentation level
    pub fn new(name: &'static str, level: usize) -> Self {
        Self {
            node: name,
            current_level: level,
        }
    }
}

impl fmt::Display for NodeDisplayWrapper<'static, str> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        for _ in 0..self.current_level {
            write!(f, "  ")?;
        }

        writeln!(f, "{}", self.node)?;

        Ok(())
    }
}

impl<'a, T> NodeDisplayWrapper<'a, T> {
    /// Set the level of this display wrapper
    ///
    /// # Parameters
    ///
    /// * `level`: new indentation level
    ///
    /// # Returns
    ///
    /// New display wrapper with the updated level.
    pub fn set_level(self, level: usize) -> Self {
        Self {
            node: self.node,
            current_level: level,
        }
    }
}

impl<T: NodeDisplay> fmt::Display for NodeDisplayWrapper<'_, T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        if let Some(name) = T::name() {
            for _ in 0..self.current_level {
                write!(f, "  ")?;
            }

            if let (Some(start), Some(end)) = (self.node.start(), self.node.end()) {
                if let Some(source_id) = self.node.source_id() {
                    write!(f, "{}@{}:{}..{}", name, source_id, start, end)?;
                } else {
                    write!(f, "{}@{}..{}", name, start, end)?;
                }
            } else {
                write!(f, "{}", name)?;
            }

            self.node.display_extra(f)?;
            writeln!(f)?;

            self.node.display_children(self.current_level + 1, f)?;
        } else {
            self.node.display_children(self.current_level, f)?;
        }

        Ok(())
    }
}

/// Trait for displaying an AST node's content
pub trait NodeContentDisplay {
    /// Name of the node
    ///
    /// # Returns
    ///
    /// `None` if this node is just a transparent wrapper (and should not be displayed), otherwise
    /// the name of the node type.
    fn name() -> Option<&'static str>;

    /// Display extra information for the node
    ///
    /// # Parameters
    ///
    /// * `f`: formatter to output to
    fn display_extra(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result;

    /// Display the node's children
    ///
    /// # Parameters
    ///
    /// * `level`: current indentation level
    /// * `f`: formatter to output to
    fn display_children(&self, level: usize, f: &mut fmt::Formatter<'_>) -> fmt::Result;
}

macro_rules! forward_display {
    ($i:ty => $e:expr) => {
        impl NodeContentDisplay for $i {
            fn name() -> Option<&'static str> {
                Some($e)
            }

            fn display_extra(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                write!(f, " `{}`", self)
            }

            fn display_children(&self, _level: usize, _f: &mut fmt::Formatter<'_>) -> fmt::Result {
                Ok(())
            }
        }
    }
}

forward_display!(smol_str::SmolStr => "String");
forward_display!(String => "String");
forward_display!(f32 => "FloatConst");
forward_display!(f64 => "DoubleConst");
forward_display!(i32 => "IntConst");
forward_display!(u16 => "ShortConst");
forward_display!(u32 => "UIntConst");
forward_display!(bool => "BoolConst");

/// Trait for displaying a syntax node
pub trait NodeDisplay: Sized {
    /// Name of the syntax node's type
    fn name() -> Option<&'static str>;

    /// Starting position of the node
    fn start(&self) -> Option<usize>;
    /// Ending position of the node
    fn end(&self) -> Option<usize>;
    /// Source id of the node
    fn source_id(&self) -> Option<usize>;

    /// Obtain a display wrapper for the current node
    fn display(&self) -> NodeDisplayWrapper<Self>;

    /// Display extra information for the node
    ///
    /// # Parameters
    ///
    /// * `f`: formatter to output to
    fn display_extra(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result;

    /// Display the node's children
    ///
    /// # Parameters
    ///
    /// * `level`: current indentation level
    /// * `f`: formatter to output to
    fn display_children(&self, level: usize, f: &mut fmt::Formatter<'_>) -> fmt::Result;
}

impl<T: NodeContentDisplay + super::NodeContent> NodeDisplay for super::Node<T> {
    fn name() -> Option<&'static str> {
        T::name()
    }

    fn start(&self) -> Option<usize> {
        self.span.map(|s| s.start)
    }

    fn end(&self) -> Option<usize> {
        self.span.map(|s| s.end)
    }

    fn source_id(&self) -> Option<usize> {
        self.span.map(|s| s.source_id)
    }

    fn display(&self) -> NodeDisplayWrapper<Self> {
        NodeDisplayWrapper {
            node: self,
            current_level: 0,
        }
    }

    fn display_extra(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        (**self).display_extra(f)
    }

    fn display_children(&self, level: usize, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        (**self).display_children(level, f)
    }
}

impl<T: NodeContentDisplay> NodeDisplay for T {
    fn name() -> Option<&'static str> {
        T::name()
    }

    fn start(&self) -> Option<usize> {
        None
    }

    fn end(&self) -> Option<usize> {
        None
    }

    fn source_id(&self) -> Option<usize> {
        None
    }

    fn display(&self) -> NodeDisplayWrapper<Self> {
        NodeDisplayWrapper {
            node: self,
            current_level: 0,
        }
    }

    fn display_extra(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.display_extra(f)
    }

    fn display_children(&self, level: usize, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.display_children(level, f)
    }
}

impl<T: NodeDisplay> NodeContentDisplay for Box<T> {
    fn name() -> Option<&'static str> {
        T::name()
    }

    fn display_extra(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        (**self).display_extra(f)
    }

    fn display_children(&self, level: usize, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        (**self).display_children(level, f)
    }
}

impl<T: NodeDisplay> NodeContentDisplay for Option<T> {
    fn name() -> Option<&'static str> {
        None
    }

    fn display_extra(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        if let Some(inner) = self.as_ref() {
            inner.display_extra(f)
        } else {
            Ok(())
        }
    }

    fn display_children(&self, level: usize, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        if let Some(inner) = self.as_ref() {
            inner.display_children(level, f)
        } else {
            Ok(())
        }
    }
}

impl<T: NodeDisplay> NodeContentDisplay for Vec<T> {
    fn name() -> Option<&'static str> {
        None
    }

    fn display_extra(&self, _f: &mut fmt::Formatter<'_>) -> fmt::Result {
        Ok(())
    }

    fn display_children(&self, level: usize, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        for item in self.iter() {
            write!(f, "{}", item.display().set_level(level))?;
        }

        Ok(())
    }
}