looklook 0.9.0

Descriptive signal synthesiser.
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

// Copyright 2026 Gabriel Bjørnager Jensen.
//
// This file is part of LOOKLOOK.
//
// LOOKLOOK is free software: you can redistribute it and/or modify it under the
// terms of the GNU Affero General Public License as published by the Free Software
// Foundation, either version 3 of the License, or (at your option) any later ver-
// sion.
//
// LOOKLOOK is distributed in the hope that it will be useful, but WITHOUT ANY WAR-
// RANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
// PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License along
// with LOOKLOOK. If not, see <https://www.gnu.org/licenses/>.

//! The [`Error`] type.

use crate::error::Builder;
use crate::vm::Exception;

use std::convert::Infallible;
use std::fmt::{self, Display, Formatter};
use std::num::NonZero;
use std::io;
use std::process::{ExitCode, Termination};

/// A LOOKLOOK error.
#[derive(Clone, Debug)]
pub struct Error {
	/// The error message.
	message: Box<str>,

	/// The file offset (if emulation error.)
	offset: Option<NonZero<u64>>,
}

impl Error {
	/// Constructs an error from a builder.
	///
	/// # Panics
	///
	/// See [`Builder::build`].
	#[must_use]
	pub(super) fn from_builder(builder: Builder) -> Self {
		let message = builder.message
			.expect("missing error message");

		let offset = builder.offset;

		Self { message, offset }
	}

	/// Retrieves the error message.
	#[inline]
	#[must_use]
	pub fn message(&self) -> &str {
		&self.message
	}

	/// Retrieves the file offset (if specified.)
	#[inline]
	#[must_use]
	pub fn offset(&self) -> Option<u64> {
		self.offset
			.map(|o| o.get() - 1)
	}
}

impl Display for Error {
	fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
		writeln!(f, "\u{001B}[001m\u{001B}[091merror\u{001B}[039m\u{001B}[022m: {}\u{001B}[022m", self.message())?;

		if let Some(offset) = self.offset() {
			writeln!(f, "\u{001B}[001m\u{001B}[096m note\u{001B}[039m\u{001B}[022m: at offset `{offset:#X}`")?;
		}

		Ok(())
	}
}

impl std::error::Error for Error {}

impl From<io::Error> for Error {
	fn from(value: io::Error) -> Self {
		Builder::new()
			.message(value)
			.build()
	}
}

impl From<Exception> for Error {
	fn from(value: Exception) -> Self {
		Builder::new()
			.message(value)
			.build()
	}
}

impl From<Infallible> for Error {
	#[inline(always)]
	fn from(value: Infallible) -> Self {
		match value {}
	}
}

impl Termination for Error {
	fn report(self) -> ExitCode {
		1_u8.into()
	}
}