#codespan #cpp #reporting #diagnostics #build-tool

codespan_preprocessed

Beautiful diagnostic reporting for M4 (or cpp) preprocessed text files

4 releases (2 breaking)

0.7.11 Nov 27, 2023
0.7.5 Oct 30, 2023
0.7.3 Apr 20, 2023
0.7.0 Dec 19, 2022
0.2.1 Oct 18, 2021

#259 in Rust patterns

Download history 91/week @ 2023-11-06 67/week @ 2023-11-13 296/week @ 2023-11-20 601/week @ 2023-11-27 453/week @ 2023-12-04 215/week @ 2023-12-11 384/week @ 2023-12-18 108/week @ 2023-12-25 10/week @ 2024-01-01 335/week @ 2024-01-08 249/week @ 2024-01-15 264/week @ 2024-01-22 485/week @ 2024-01-29 646/week @ 2024-02-05 976/week @ 2024-02-12 1628/week @ 2024-02-19

3,735 downloads per month

MIT license

32KB
728 lines

codespan_preprocessed

Crates.io Crates.io License Docs

This is an extension for the very useful crate codespan_reporting to deal with preprocessed file through the well-knownm4 or cpp.

Using such a preprocessor allows, among a lost of things, the inclusion of many files which are identified in the bytes sequence with preprecessor directive as:

#line 42 "/my/preprocessed/file"

This directive breaks the location of the source and so should be correctly processed to make correct location for error reporting.

This is the purpose of this crate: taking a preprocessor output and managing the different underlying locations inside it.

Example

use codespan_reporting::diagnostic::Diagnostic;
use codespan_reporting::term;
use codespan_reporting::term::termcolor::{ColorChoice, StandardStream};
use codespan_preprocessed::PreprocessedFile;

fn main()
{
    let file = PreprocessedFile::new(   
        unindent::unindent(
            r#"
                #line 1 "top_file"
                a first statement;
                another one
    
                #line 1 "included_file"
                continue...
    
                #line 5
                another line
                the last one
            "#,
        ),
    );
   
    let diagnostic = Diagnostic::note()
            .with_message("this is just an example")
            .with_labels(vec![
                file.primary_label(113..117).with_message("do you see that ?"),
                file.secondary_label(21..26).with_message("is it related to this ?")
            ]);
   
    // We now set up the writer and configuration, and then finally render the
    // diagnostic to standard error.
    // (see `codespan_reporting` documention for more details)
   
    let writer = StandardStream::stderr(ColorChoice::Always);
    let config = codespan_reporting::term::Config::default();
   
    term::emit(&mut writer.lock(), &config, &file, &diagnostic);
}

The previous code will produce:

note: this is just an example
  ┌─ included_file:6:5
  │
6 │ the last one
  │     ^^^^ do you see that ?
  │
  ┌─ top_file:1:3
  │
1 │ a first statement;
  │   ----- is it related to this ?

Dependencies

~220–410KB