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 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
use std::fmt;
use std::fmt::Write;
use std::io::Result;
use std::convert::TryInto;
#[cfg(feature="colors")]
use terminal_escapes::Color;
use crate::Span;
/// Highlight format description.
///
/// Specifies how the highlight should be rendered:
/// * What character to use to draw the line under one-lined highlights.
/// ```txt
/// 1 | fn main() {
/// 2 | println!("Hello World!")
/// | ++++++++++++++ highlighting this string
/// 3 | }
/// ```
/// In this example, the line character is `+`.
///
/// * What boundary marker character to use to point the first and last elements of a
/// multi-line highlight.
/// ```txt
/// 1 | fn main() {
/// | ___________^
/// 2 | | println!("Hello World!")
/// 3 | | }
/// | |_^ this span covers more than one line
/// ```
/// In this example, the boundary marker is `^`. The line character is not used.
///
/// ## Colors
///
/// If the `colors` feature is enabled, it is also possible to set a color to draw the lines.
/// This will also make the highlights more bright (or bold), along with the line numbers.
#[derive(Clone, Copy, PartialEq, Eq)]
pub enum Style {
/// Red curvy underline.
Error,
/// Yellow curvy underline.
Warning,
/// Blue straight underline.
Note,
/// Custom highlight format.
///
/// Specifies the line character, the boundary marker and the color (if the `colors` feature
/// is enabled) used to render the highlight.
Custom(char, char, #[cfg(feature="colors")] Color)
}
impl Style {
/// Create a new custom highlight style.
///
/// The `line` character is user to draw the line under the span elements.
/// The `marker` character is used to point to the first and last elements of the span when
/// relevant.
#[cfg(not(feature="colors"))]
pub fn new(line: char, marker: char) -> Style {
Style::Custom(line, marker)
}
/// Create a new custom highlight style.
///
/// The `line` character is user to draw the line under the span elements.
/// The `marker` character is used to point to the first and last elements of the span when
/// relevant.
#[cfg(feature="colors")]
pub fn new(line: char, marker: char, color: Color) -> Style {
Style::Custom(line, marker, color)
}
/// The character used to draw the line under the span elements.
pub fn line(&self) -> char {
use Style::*;
match self {
Error => '^',
Warning => '^',
Note => '_',
#[cfg(not(feature="colors"))]
Custom(line, _) => *line,
#[cfg(feature="colors")]
Custom(line, _, _) => *line
}
}
/// The character used to point the first and last element of the span when relevant.
pub fn marker(&self) -> char {
use Style::*;
match self {
Error => '^',
Warning => '^',
Note => '^',
#[cfg(not(feature="colors"))]
Custom(_, marker) => *marker,
#[cfg(feature="colors")]
Custom(_, marker, _) => *marker
}
}
/// Get the color used to draw the highlight.
#[cfg(feature="colors")]
pub fn color(&self) -> Color {
use Style::*;
match self {
Error => Color::Red,
Warning => Color::Yellow,
Note => Color::Blue,
Custom(_, _, color) => *color
}
}
}
/// Span highlight.
///
/// Used to define what should be highlighted in the text formatted with the [`Formatter`].
/// Given a span a label and a style, the formatter will add an line under the elements of the
/// highlight span, along with the label (if any).
///
/// ```txt
/// 1 | fn main() {
/// 2 | println!("Hello World!")
/// | ^^^^^^^^^^^^^^ highlighting this string
/// 3 | }
/// ```
/// # Multiline spans
///
/// The highlight span can cover multiple lines. In that case, only the first and last elements
/// will be underlined (or pointed).
///
/// ```txt
/// 1 | fn main() {
/// | ___________^
/// 2 | | println!("Hello World!")
/// 3 | | }
/// | |_^ this span covers more than one line
/// ```
///
/// # Entangled highlights
///
/// Different highlights can overlap without breaking the formatted output, but it may become
/// difficult to read the exact boundary of each highlight.
///
/// ```txt
/// 1 | fn main() {
/// | __ ^
/// | _________|_|
/// | | |
/// | | this is a pair of parenthesis
/// 2 | | println!("Hello World!")
/// | | ^^^^^^^^^^^^^^^^ this is a pair of parenthesis
/// | | |_____________||
/// | | |
/// | | this is a string. Hard to see where it starts, uh?
/// 3 | | }
/// | |_^ this is a pair of braces
/// ```
///
/// Here the underline character for the string is the same as the boundary marker for the
/// parenthesis, making it hard to see which is which.
/// One possible workaround is to change the [`Style`] of the highlights. Changing the boundary
/// marker for the parenthesis to `|` makes it easier to read the formatted output:
///
/// ```txt
/// 1 | fn main() {
/// | __ ^
/// | _________|_|
/// | | |
/// | | this is a pair of parenthesis
/// 2 | | println!("Hello World!")
/// | | |^^^^^^^^^^^^^^| this is a pair of parenthesis
/// | | |_____________||
/// | | |
/// | | this is a string. Hard to see where it starts, uh?
/// 3 | | }
/// | |_^ this is a pair of braces
/// ```
pub struct Highlight {
span: Span,
label: Option<String>,
style: Style
}
/// Text formatter with span highlights.
///
/// This allows you to format a given input `char` stream with highlights and colors (if the
/// `colors` feature is enabled).
/// A [`Highlight`] is defined by a [`Span`], a string label and a [`Style`], and will be rendered
/// with the stream:
///
/// ```txt
/// 1 | fn main() {
/// 2 | println!("Hello World!")
/// | ^^^^^^^^^^^^^^ highlighting this string
/// 3 | }
/// ```
///
/// Highlights spans can cover multiple lines and overlap.
/// See the [`Highlight`] documentation for more informations.
pub struct Formatter {
highlights: Vec<Highlight>,
show_line_numbers: bool
}
/// Highlight with some more information about where to draw the vertical line so it does not
/// colide with other highlights, and chere to draw the label.
struct MappedHighlight<'a> {
h: &'a Highlight,
column_offset: usize,
label_position: (usize, usize)
}
/// Character with format information.
#[derive(Clone, Copy)]
struct Char(char, bool, #[cfg(feature="colors")] Option<Color>);
impl Char {
/// Create a new char.
fn new(c: char, style: Style) -> Char {
#[cfg(feature="colors")]
{
Char(c, false, Some(style.color()))
}
#[cfg(not(feature="colors"))]
{
Char(c, false)
}
}
fn label(c: char, style: Style) -> Char {
#[cfg(feature="colors")]
{
Char(c, true, Some(style.color()))
}
#[cfg(not(feature="colors"))]
{
Char(c, true)
}
}
fn in_margin(c: char) -> Char {
#[cfg(feature="colors")]
{
Char(c, false, Some(Color::Blue))
}
#[cfg(not(feature="colors"))]
{
Char(c, false)
}
}
fn space() -> Char {
#[cfg(feature="colors")]
{
Char(' ', false, None)
}
#[cfg(not(feature="colors"))]
{
Char(' ', false)
}
}
fn pipe() -> Char {
#[cfg(feature="colors")]
{
Char('|', false, Some(Color::Blue))
}
#[cfg(not(feature="colors"))]
{
Char('|', false)
}
}
fn is_label(&self) -> bool {
self.1
}
}
impl From<char> for Char {
fn from(c: char) -> Char {
#[cfg(feature="colors")]
{
Char(c, false, None)
}
#[cfg(not(feature="colors"))]
{
Char(c, false)
}
}
}
/// A single line of [`Char`] in the formatted output.
struct Line {
data: Vec<Char>,
offset: usize,
}
impl Line {
fn new(margin: usize) -> Line {
let mut data = Vec::new();
data.resize(margin, Char::space());
Line {
data: data,
offset: margin
}
}
fn is_empty(&self) -> bool {
self.data.len() == self.offset
}
fn get(&self, i: usize) -> Char {
if let Some(c) = self.data.get(i) {
*c
} else {
Char::space()
}
}
fn is_free(&self, i: usize, j: usize) -> bool {
for k in i..j {
let c = self.get(k).0;
if c != ' ' {
return false
}
}
true
}
fn push(&mut self, c: Char) {
if c.0 == '\t' {
let len = self.data.len() - self.offset;
let tab_len = 8 - len%8; // tab length is 8.
self.data.resize(self.offset + len + tab_len, Char::space());
} else {
self.data.push(c);
}
}
fn set(&mut self, i: usize, c: Char) {
if self.data.len() <= i {
self.data.resize(i+1, Char::space());
}
if !self.data[i].is_label() {
self.data[i] = c;
}
}
fn draw_label(&mut self, label: &String, i: usize, style: Style) {
for (k, c) in label.chars().enumerate() {
self.set(i+k, Char::label(c, style))
}
}
fn draw_line_number(&mut self, mut i: usize, margin: usize) {
let w = margin-3;
self.set(margin-2, Char::pipe());
for k in 0..w {
let codepoint = 0x30 + i as u32 %10;
i /= 10;
self.set(w-k-1, Char::in_margin(codepoint.try_into().unwrap()));
}
}
}
impl fmt::Display for Line {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
#[cfg(feature="colors")]
let mut current_color = None;
for c in &self.data {
#[cfg(feature="colors")]
{
use terminal_escapes::Sequence::*;
use terminal_escapes::Attribute;
if c.2 != current_color && c.0 != ' ' {
current_color = c.2;
if let Some(color) = current_color {
write!(f, "{}", SetAttributes(&[Attribute::Foreground(color), Attribute::Bright]))?;
} else {
write!(f, "{}", SetAttributes(&[Attribute::Reset]))?;
}
}
}
c.0.fmt(f)?;
}
'\n'.fmt(f)
}
}
struct LineBuffer {
index: usize,
margin: usize,
lines: Vec<Line>
}
impl LineBuffer {
fn new(index: usize, line: Line, margin: usize) -> LineBuffer {
LineBuffer {
index: index,
margin: margin,
lines: vec![line]
}
}
fn draw(&mut self, mh: &MappedHighlight) -> Option<usize> {
if mh.h.span.line_count() > 1 {
let column = self.margin - mh.column_offset -1;
if mh.h.span.start().line == self.index {
self.draw_boundary(column+1, self.margin + mh.h.span.start().column, mh.h.style);
None
} else if mh.h.span.end().line == self.index {
let j = self.margin + mh.h.span.last().column;
self.draw_boundary(column+1, j, mh.h.style);
self.draw_column(column, mh.h.style);
Some(j)
} else if mh.h.span.start().line < self.index && mh.h.span.end().line > self.index {
self.draw_column(column, mh.h.style);
None
} else {
None
}
} else {
if mh.h.span.start().line == self.index {
let i = self.margin + mh.h.span.start().column;
let j = self.margin + mh.h.span.last().column;
self.draw_inline_span(i, j, mh.h.style);
Some(j)
} else {
None
}
}
}
fn draw_inline_span(&mut self, i: usize, j: usize, style: Style) {
let index = self.find_free_line(i, j+1, false);
if index == 1 {
let line = &mut self.lines[index];
for k in i..(j+1) {
line.set(k, Char::new(style.line(), style));
}
} else {
for l in 1..(index+1) {
let line = &mut self.lines[l];
if l == 1 {
line.set(i, Char::new(style.marker(), style));
line.set(j, Char::new(style.marker(), style));
} else if l == index {
line.set(i, Char::new('|', style));
line.set(j, Char::new('|', style));
for k in (i+1)..j {
line.set(k, Char::new('_', style));
}
} else {
line.set(i, Char::new('|', style));
line.set(j, Char::new('|', style));
}
}
}
}
fn draw_column(&mut self, i: usize, style: Style) {
for line in self.lines.iter_mut() {
line.set(i, Char::new('|', style));
}
}
fn draw_boundary(&mut self, i: usize, j: usize, style: Style) {
let index = self.find_free_line(i, j+1, false);
for l in 1..(index+1) {
let line = &mut self.lines[l];
if l == 1 {
line.set(j, Char::new(style.marker(), style));
} else {
line.set(j, Char::new('|', style));
}
if l == index {
for k in i..j {
line.set(k, Char::new('_', style));
}
}
}
}
/// Draw label at the given column.
fn draw_label(&mut self, label: &String, i: usize, style: Style) {
let j = i+label.len()+1;
if self.lines[1].is_free(i+1, j+2) {
self.lines[1].draw_label(label, i+2, style);
} else {
let index = self.find_free_line(i, j, true);
for l in 2..(index+1) {
let line = &mut self.lines[l];
if l == index {
line.draw_label(label, i, style);
} else {
line.set(i, Char::new('|', style));
}
}
}
}
/// Return the index of a secondary line where every character between `i` (included) and
/// `j` (excluded) is free (a whitespace).
fn find_free_line(&mut self, i: usize, j: usize, label: bool) -> usize {
let mut index = 1;
'next_line: loop {
if index >= self.lines.len() {
self.extend();
}
if self.lines[index].is_free(i, j) {
if label && index > 1 {
let last_line = &self.lines[index-1];
for k in i..(j+1) {
if last_line.get(k).0 == '|' || last_line.get(k).is_label() {
index += 1;
continue 'next_line;
}
}
}
return index
}
index += 1;
}
}
fn extend(&mut self) {
let mut new_line = Line::new(self.margin);
{
let last_line = self.lines.last().unwrap();
for i in 0..self.margin {
if last_line.get(i+1).0 == '_' && last_line.get(i).0 == ' ' {
let mut c = last_line.get(i+1);
c.0 = '|';
new_line.set(i, c);
}
if last_line.get(i).0 == '|' && last_line.get(i+1).0 != '_' {
new_line.set(i, last_line.get(i));
}
}
}
self.lines.push(new_line);
}
}
impl fmt::Display for LineBuffer {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
for line in &self.lines {
line.fmt(f)?;
}
Ok(())
}
}
impl Highlight {
fn map(&self, others: &[MappedHighlight]) -> MappedHighlight {
let mut column_offset = 0;
if self.span.line_count() > 1 {
column_offset = 1;
}
for h in others.iter() {
if h.h.span.overlaps(&self.span) {
if column_offset > 0 && h.h.span.line_count() > 1 {
column_offset = std::cmp::max(column_offset, h.column_offset+2);
}
}
}
MappedHighlight {
h: self,
column_offset: column_offset,
label_position: (0, 0)
}
}
}
impl Formatter {
/// Create a new formatter with no highlights.
///
/// By default line numbers are showing. You can disable them using the
/// [`hide_line_numbers`](Formatter::hide_line_numbers) method.
pub fn new() -> Formatter {
Formatter {
highlights: Vec::new(),
show_line_numbers: true
}
}
/// Show the line numbers in the output.
///
/// This is the default.
pub fn show_line_numbers(&mut self) {
self.show_line_numbers = true;
}
/// Hide the line numbers in the output.
///
/// By default, line numbers are visible.
pub fn hide_line_numbers(&mut self) {
self.show_line_numbers = false;
}
/// Add a span highlight.
pub fn add(&mut self, span: Span, label: Option<String>, style: Style) {
self.highlights.push(Highlight {
span: span,
label: label,
style: style
});
self.highlights.sort_by(|a, b| a.span.cmp(&b.span));
}
/// Produce the formatted output.
///
/// Create a [`String`] containing the content of the input iterator given span, with the
/// previously added highlights.
pub fn get<I: Iterator<Item=Result<char>>>(&self, input: I, span: Span) -> std::io::Result<String> {
let line_number_margin = if self.show_line_numbers {
(((span.last().line+1) as f32).log10() as usize) + 4
} else {
0
};
// map every highlights and the left margin.
let mut highlights = Vec::new();
let mut highlights_margin = 0;
for h in &self.highlights {
let mapped_h = h.map(&highlights);
highlights_margin = std::cmp::max(highlights_margin, mapped_h.column_offset);
highlights.push(mapped_h);
}
if highlights_margin > 0 {
highlights_margin += 1;
}
let margin = line_number_margin + highlights_margin;
let mut lines = Vec::new();
let mut line_buffer = Line::new(margin);
let mut line_span: Span = span.start().into();
if self.show_line_numbers {
line_buffer.draw_line_number(line_span.start().line+1, line_number_margin);
}
for c in input {
let c = c?;
if line_span.end() >= span.end() {
break
}
line_span.push(c);
if c == '\n' {
let mut new_line_buffer = Line::new(margin);
std::mem::swap(&mut new_line_buffer, &mut line_buffer);
lines.push(LineBuffer::new(line_span.start().line, new_line_buffer, margin));
line_span.clear();
if self.show_line_numbers {
line_buffer.draw_line_number(line_span.start().line+1, line_number_margin);
}
} else {
line_buffer.push(Char::from(c));
}
}
if !line_buffer.is_empty() {
lines.push(LineBuffer::new(line_span.start().line, line_buffer, margin));
}
for (i, line) in lines.iter_mut().enumerate() {
for mh in highlights.iter_mut() {
if let Some(pos) = line.draw(mh) {
mh.label_position = (i, pos);
}
}
}
for mh in &highlights {
if let Some(label) = &mh.h.label {
let line = &mut lines[mh.label_position.0];
line.draw_label(label, mh.label_position.1, mh.h.style);
}
}
let mut buffer = String::new();
for line in &lines {
write!(buffer, "{}", line).unwrap();
}
Ok(buffer)
}
}