Diagnostic Reporter

A simple, single header C++ library for pretty, Rust-style error diagnostics.

Used for the Dino compiler.

TL;DR - Example

auto file = new reporter::SimpleFile("example.cpp");
auto file2 = new reporter::SimpleFile("reporter.hpp");
auto err = reporter::Error(
        "a complex error",
        "this is where the error is, hence the bold red",
        "E308",
        { 4, 9, 13, file }
    )
    .withNote("a relevant include", { 1, 0, 8, file })
    .withNote("curly brace", { 3, 11, 12, file })
    .withNote("a type", { 4, 4, 8, file })
    .withNote("assignment", { 4, 14, 15, file })
    .withNote("a variable with a very long explanation\n"
              "which requires an especially\n"
              "large number of lines", { 4, 9, 13, file })
    .withHelp("a help message", { 4, 30, 40, file })

    .withNote("relevant include in another file\n"
              "with another line\nand another", {26, 0, 8, file2})
    
    .withHelp("a general help message,\nnot set to any specific location")
    .withNote("can also be a note");

err.print(std::cerr);

Adding to Your Project

Simply copy reporter.hpp somewhere into to your project's directories.

How to Use

Locations

auto file = new reporter::SimpleFile("example.cpp");
reporter::Location loc { 
    2, // at line 2
    3, // from the 4th character
    8, // to (and excluding) the 9th character
    file // in example.cpp
};

You can also exclude end to simply get a location pointing at one specific character:

reporter::Location loc { 1, 4, file };

Diagnostic Types

auto err    = reporter::Error("an error", loc);
auto warn   = reporter::Warning("a warning", loc);
auto note   = reporter::Note("a note", loc);
auto help   = reporter::Help("some help", loc);
auto intern = reporter::InternalError("an internal compiler error", loc);

The only major differences between the types are their names and their color.

Notes/Help

You can add secondary notes/help to a diagnostic, which may be set to a specific position.

reporter::SimpleFile file("example.cpp");
reporter::Error("an error", "here", { 4, 14, &file })
    .withHelp("help without a location")
    .withNote("a note without a location")
    .withNote("a note with a location", { 4, 14, 10, &file })
    .withHelp("help with a location", { 4, 4, 9, &file })
    .print(std::cerr);

Custom Config

You can customize most aspects of the display settings such as color, padding, used characters, etc.

reporter::Config cfg;
cfg.padding.borderBottom = 1; // default is 0
cfg.chars.noteBullet = '*'; // default is '•'
cfg.style = reporter::DisplayStyle::RICH; // other option is SHORT
cfg.colors.border = reporter::colors::fgcyan; // default is `reporter::colors::inherit`

err.print(std::cerr, cfg); // specify config when printing

Different colors can be combined with the & operator:

auto c = reporter::colors::fgred & reporter::colors::bgblue & 
         reporter::colors::bold & reporter::colors::underline;