miden-diagnostics 0.1.0

Diagnostics infrastructure for Polygon Miden compilers
Documentation 
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

mod codemap;
mod config;
mod diagnostic;
mod emitter;
mod filename;
mod handler;
mod index;
mod source;
mod span;

pub use codespan::Location;
pub use codespan::{ByteIndex, ByteOffset};
pub use codespan::{ColumnIndex, ColumnNumber, ColumnOffset};
pub use codespan::{Index, Offset};
pub use codespan::{LineIndex, LineNumber, LineOffset};
pub use codespan::{RawIndex, RawOffset};

pub use codespan_reporting::diagnostic::{LabelStyle, Severity};
pub use codespan_reporting::files::{Error, Files};
pub use codespan_reporting::term;

pub use miden_diagnostics_macros::*;

pub use self::codemap::CodeMap;
pub use self::config::{DiagnosticsConfig, Verbosity};
pub use self::diagnostic::InFlightDiagnostic;
pub use self::emitter::{CaptureEmitter, DefaultEmitter, Emitter, NullEmitter};
pub use self::filename::FileName;
pub use self::handler::DiagnosticsHandler;
pub use self::index::SourceIndex;
pub use self::source::{SourceFile, SourceId};
pub use self::span::{SourceSpan, Span, Spanned};

pub type Diagnostic = codespan_reporting::diagnostic::Diagnostic<SourceId>;
pub type Label = codespan_reporting::diagnostic::Label<SourceId>;

/// [ToDiagnostic] should be implemented on types which can be converted to a [Diagnostic].
///
/// This is largely intended for implementations of [std::error::Error], but may be implemented
/// for any type that has a canonical [Diagnostic] representation.
pub trait ToDiagnostic {
    fn to_diagnostic(self) -> Diagnostic;
}
impl ToDiagnostic for Diagnostic {
    #[inline(always)]
    fn to_diagnostic(self) -> Diagnostic {
        self
    }
}

#[doc(hidden)]
pub struct FatalErrorMarker;

/// Used as a return value to signify a fatal error occurred
#[derive(Copy, Clone, Debug)]
#[must_use]
pub struct FatalError;
impl FatalError {
    pub fn raise(self) -> ! {
        std::panic::resume_unwind(Box::new(FatalErrorMarker))
    }
}
impl core::fmt::Display for FatalError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "The compiler has encountered a fatal error")
    }
}