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 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
// -*- coding: utf-8 -*-
// ------------------------------------------------------------------------------------------------
// Copyright © 2022, tree-sitter authors.
// Licensed under either of Apache License, Version 2.0, or MIT license, at your option.
// Please see the LICENSE-APACHE or LICENSE-MIT files in this distribution for license details.
// ------------------------------------------------------------------------------------------------
//! Data types and functions for finding and displaying tree-sitter parse errors.
#[cfg(feature = "term-colors")]
use colored::Colorize;
use std::ops::Range;
use std::path::Path;
use tree_sitter::Node;
use tree_sitter::Tree;
/// Parse error for tree-sitter tree
#[derive(Debug)]
pub enum ParseError<'tree> {
/// Error representing missing syntax
Missing(Node<'tree>),
/// Error representing unexpected syntax
Unexpected(Node<'tree>),
}
impl<'tree> ParseError<'tree> {
/// Return the first parse error in the given tree, if it exists.
pub fn first(tree: &Tree) -> Option<ParseError> {
let mut errors = Vec::new();
find_errors(tree, &mut errors, true);
errors.into_iter().next()
}
/// Return the tree and the first parse error in the given tree, if it exists.
/// This returns a type, combining the tree and the error, that can be moved safely,
/// which is not possible with a seperate tree and error.
pub fn into_first(tree: Tree) -> TreeWithParseErrorOption {
TreeWithParseErrorOption::into_first(tree)
}
/// Return all parse errors in the given tree.
pub fn all(tree: &'tree Tree) -> Vec<ParseError> {
let mut errors = Vec::new();
find_errors(tree, &mut errors, false);
errors
}
/// Return the tree and all parse errors in the given tree.
/// This returns a type, combining the tree and the errors, that can be moved safely,
/// which is not possible with a seperate tree and errors.
pub fn into_all(tree: Tree) -> TreeWithParseErrorVec {
TreeWithParseErrorVec::into_all(tree)
}
}
impl<'tree> ParseError<'tree> {
pub fn node(&self) -> &Node<'tree> {
match self {
Self::Missing(node) => node,
Self::Unexpected(node) => node,
}
}
pub fn display(
&'tree self,
path: &'tree Path,
source: &'tree str,
) -> impl std::fmt::Display + 'tree {
ParseErrorDisplay {
error: self,
path,
source,
}
}
pub fn display_pretty(
&'tree self,
path: &'tree Path,
source: &'tree str,
) -> impl std::fmt::Display + 'tree {
ParseErrorDisplayPretty {
error: self,
path,
source,
}
}
}
struct ParseErrorDisplay<'tree> {
error: &'tree ParseError<'tree>,
path: &'tree Path,
source: &'tree str,
}
impl std::fmt::Display for ParseErrorDisplay<'_> {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
let node = self.error.node();
write!(
f,
"{}:{}:{}: ",
self.path.display(),
node.start_position().row + 1,
node.start_position().column + 1
)?;
let node = match self.error {
ParseError::Missing(node) => {
write!(f, "missing syntax")?;
node
}
ParseError::Unexpected(node) => {
write!(f, "unexpected syntax")?;
node
}
};
if node.byte_range().is_empty() {
writeln!(f, "")?;
} else {
let end_byte = self.source[node.byte_range()]
.chars()
.take_while(|c| *c != '\n')
.map(|c| c.len_utf8())
.sum();
let text = &self.source[node.start_byte()..end_byte];
write!(f, ": {}", text)?;
}
Ok(())
}
}
struct ParseErrorDisplayPretty<'tree> {
error: &'tree ParseError<'tree>,
path: &'tree Path,
source: &'tree str,
}
impl std::fmt::Display for ParseErrorDisplayPretty<'_> {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
let node = match self.error {
ParseError::Missing(node) => {
writeln!(f, "missing syntax")?;
node
}
ParseError::Unexpected(node) => {
writeln!(f, "unexpected syntax")?;
node
}
};
if node.byte_range().is_empty() {
writeln!(f, "")?;
} else {
let start_column = node.start_position().column;
let end_column = node.start_position().column
+ self.source[node.byte_range()]
.chars()
.take_while(|c| *c != '\n')
.count();
write!(
f,
"{}",
Excerpt::from_source(
self.path,
self.source,
node.start_position().row,
start_column..end_column,
0,
),
)?;
}
Ok(())
}
}
/// Find errors in the given tree and add those to the given errors vector
fn find_errors<'tree>(tree: &'tree Tree, errors: &mut Vec<ParseError<'tree>>, first_only: bool) {
// do not walk the tree unless there actually are errors
if !tree.root_node().has_error() {
return;
}
let mut cursor = tree.walk();
let mut did_visit_children = false;
loop {
let node = cursor.node();
if node.is_error() {
errors.push(ParseError::Unexpected(node));
if first_only {
break;
}
did_visit_children = true;
} else if node.is_missing() {
errors.push(ParseError::Missing(node));
if first_only {
break;
}
did_visit_children = true;
}
if did_visit_children {
if cursor.goto_next_sibling() {
did_visit_children = false;
} else if cursor.goto_parent() {
did_visit_children = true;
} else {
break;
}
} else {
if cursor.goto_first_child() {
did_visit_children = false;
} else {
did_visit_children = true;
}
}
}
cursor.reset(tree.root_node());
}
// ------------------------------------------------------------------------------------------------
// Types to package a tree and parse errors for that tree
//
// Parse errors contain `Node` values, that are parametrized by the lifetime `tree of the tree they
// are part of. It is normally not possible to combine a value and references to that value in a single
// data type. However, in the case of tree-sitter trees and nodes, the nodes do not point to memory in the
// tree value, but both point to heap allocated memory. Therefore, moving the tree does not invalidate the
// node. We use this fact to implement the TreeWithParseError* types.
//
// To be able to use these types in errors, we implement Send and Sync. These traits are implemented for
// Tree, but not for Node. However, since the TreeWithParseError* types contain the tree as well as the nodes,
// it is okay to implement Send and Sync.
/// A type containing a tree and a parse error
pub struct TreeWithParseError {
tree: Tree,
// the 'static lifetime is okay because we own `tree`
error: ParseError<'static>,
}
impl TreeWithParseError {
pub fn tree(&self) -> &Tree {
&self.tree
}
pub fn into_tree(self) -> Tree {
self.tree
}
pub fn error(&self) -> &ParseError {
&self.error
}
}
impl std::fmt::Debug for TreeWithParseError {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "{:?}", self.error)
}
}
// Send and Sync must be implemented for ParseError -> Node -> ffi::TSTree
// This is okay because Send and Sync _are_ implemented for Tree, which also holds ffi::TSTree
unsafe impl Send for TreeWithParseError {}
unsafe impl Sync for TreeWithParseError {}
/// A type containing a tree and an optional parse error
pub struct TreeWithParseErrorOption {
tree: Tree,
// the 'static lifetime is okay because we own `tree`
error: Option<ParseError<'static>>,
}
impl TreeWithParseErrorOption {
fn into_first(tree: Tree) -> TreeWithParseErrorOption {
let mut errors = Vec::new();
find_errors(&tree, &mut errors, true);
Self {
error: unsafe { std::mem::transmute(errors.into_iter().next()) },
tree: tree,
}
}
}
impl TreeWithParseErrorOption {
pub fn tree(&self) -> &Tree {
&self.tree
}
pub fn into_tree(self) -> Tree {
self.tree
}
pub fn error(&self) -> &Option<ParseError> {
&self.error
}
pub fn into_option(self) -> Option<TreeWithParseError> {
match self.error {
None => None,
Some(error) => Some(TreeWithParseError {
tree: self.tree,
error,
}),
}
}
}
impl std::fmt::Debug for TreeWithParseErrorOption {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "{:?}", self.error)
}
}
// Send and Sync must be implemented for ParseError -> Node -> ffi::TSTree
// This is okay because Send and Sync _are_ implemented for Tree, which also holds ffi::TSTree
unsafe impl Send for TreeWithParseErrorOption {}
unsafe impl Sync for TreeWithParseErrorOption {}
/// A type containing a tree and parse errors
pub struct TreeWithParseErrorVec {
tree: Tree,
// the 'static lifetime is okay because we own `tree`
errors: Vec<ParseError<'static>>,
}
impl TreeWithParseErrorVec {
fn into_all(tree: Tree) -> TreeWithParseErrorVec {
let mut errors = Vec::new();
find_errors(&tree, &mut errors, false);
TreeWithParseErrorVec {
errors: unsafe { std::mem::transmute(errors) },
tree: tree,
}
}
}
impl TreeWithParseErrorVec {
pub fn tree(&self) -> &Tree {
&self.tree
}
pub fn into_tree(self) -> Tree {
self.tree
}
pub fn errors(&self) -> &Vec<ParseError> {
&self.errors
}
}
impl std::fmt::Debug for TreeWithParseErrorVec {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "{:?}", self.errors)
}
}
// Send and Sync must be implemented for ParseError -> Node -> ffi::TSTree
// This is okay because Send and Sync _are_ implemented for Tree, which also holds ffi::TSTree
unsafe impl Send for TreeWithParseErrorVec {}
unsafe impl Sync for TreeWithParseErrorVec {}
//-----------------------------------------------------------------------------
/// Excerpts of source from either the target language file or the tsg rules file.
pub struct Excerpt<'a> {
path: &'a Path,
source: Option<&'a str>,
row: usize,
columns: Range<usize>,
indent: usize,
}
impl<'a> Excerpt<'a> {
pub fn from_source(
path: &'a Path,
source: &'a str,
row: usize,
mut columns: Range<usize>,
indent: usize,
) -> Excerpt<'a> {
let source = source.lines().nth(row);
columns.end = std::cmp::min(columns.end, source.map(|s| s.len()).unwrap_or_default());
Excerpt {
path,
source,
row,
columns,
indent,
}
}
fn gutter_width(&self) -> usize {
((self.row + 1) as f64).log10() as usize + 1
}
}
impl<'a> std::fmt::Display for Excerpt<'a> {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
// path and line/col
writeln!(
f,
"{}{}:{}:{}:",
" ".repeat(self.indent),
header_style(&self.path.to_string_lossy()),
header_style(&format!("{}", self.row + 1)),
header_style(&format!("{}", self.columns.start + 1)),
)?;
if let Some(source) = self.source {
// first line: line number & source
writeln!(
f,
"{}{}{}{}",
" ".repeat(self.indent),
prefix_style(&format!("{}", self.row + 1)),
prefix_style(" | "),
source,
)?;
// second line: caret
writeln!(
f,
"{}{}{}{}{}",
" ".repeat(self.indent),
" ".repeat(self.gutter_width()),
prefix_style(" | "),
" ".repeat(self.columns.start),
underline_style(&"^".repeat(self.columns.len())),
)?;
} else {
writeln!(f, "{}{}", " ".repeat(self.indent), "<missing source>",)?;
}
Ok(())
}
}
// coloring functions
#[cfg(feature = "term-colors")]
fn header_style(str: &str) -> impl std::fmt::Display {
str.bold()
}
#[cfg(not(feature = "term-colors"))]
fn header_style<'a>(str: &'a str) -> impl std::fmt::Display + 'a {
str
}
#[cfg(feature = "term-colors")]
fn prefix_style(str: &str) -> impl std::fmt::Display {
str.dimmed()
}
#[cfg(not(feature = "term-colors"))]
fn prefix_style<'a>(str: &'a str) -> impl std::fmt::Display + 'a {
str
}
#[cfg(feature = "term-colors")]
fn underline_style(str: &str) -> impl std::fmt::Display {
str.green()
}
#[cfg(not(feature = "term-colors"))]
fn underline_style<'a>(str: &'a str) -> impl std::fmt::Display + 'a {
str
}