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
use backtrace;
use std::fs::File;
use std::io::BufReader;
use std::io::{BufRead, ErrorKind};
use std::panic::PanicInfo;
use std::path::{Path, PathBuf};
use term::{self, color, StderrTerminal};
pub type IOResult<T = ()> = Result<T, std::io::Error>;
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub enum Verbosity {
MINIMAL,
MEDIUM,
FULL,
}
pub fn get_verbosity() -> Verbosity {
match std::env::var("RUST_BACKTRACE") {
Ok(ref x) if x == "full" => Verbosity::FULL,
Ok(_) => Verbosity::MEDIUM,
Err(_) => Verbosity::MINIMAL,
}
}
pub fn color_panic_handler(pi: &PanicInfo) {
PanicHandler::new(pi).go().unwrap();
}
pub fn install() {
std::panic::set_hook(Box::new(color_panic_handler));
}
struct Sym<'a, 'b> {
handler: &'a mut PanicHandler<'b>,
name: Option<String>,
lineno: Option<u32>,
filename: Option<PathBuf>,
}
static BUILTIN_PREFIXES: &[&str] = &[
"std::",
"core::",
"backtrace::backtrace::",
"_rust_begin_unwind",
"color_traceback::",
"___rust_maybe_catch_panic",
"_main",
];
impl<'a, 'b> Sym<'a, 'b> {
fn is_builtin(&self) -> bool {
match self.name {
Some(ref name) => BUILTIN_PREFIXES.iter().any(|x| name.starts_with(x)),
None => false,
}
}
fn print_source_if_avail(&mut self) -> IOResult {
let (lineno, filename) = match (self.lineno, self.filename.as_ref()) {
(Some(a), Some(b)) => (a, b),
_ => return Ok(()),
};
self.handler.print_source_if_avail(filename, lineno)
}
fn print_loc(&mut self, i: usize) -> IOResult {
let is_builtin = self.is_builtin();
let t = &mut self.handler.t;
write!(t, "{:>2}: ", i)?;
let name_fallback = "<unknown>".to_owned();
let name = self.name.as_ref().unwrap_or(&name_fallback);
t.fg(if is_builtin {
color::GREEN
} else {
color::BRIGHT_RED
})?;
writeln!(t, "{}", name)?;
t.reset()?;
if let Some(ref file) = self.filename {
let filestr = file.to_str().unwrap_or("<bad utf8>");
let lineno = self
.lineno
.map_or("<unknown line>".to_owned(), |x| x.to_string());
writeln!(t, " {}:{}", filestr, lineno)?;
} else {
writeln!(t, " <unknown source file>")?;
}
if self.handler.v >= Verbosity::FULL {
self.print_source_if_avail()?;
}
Ok(())
}
}
struct PanicHandler<'a> {
pi: &'a PanicInfo<'a>,
v: Verbosity,
t: Box<StderrTerminal>,
}
impl<'a> PanicHandler<'a> {
fn print_source_if_avail(&mut self, filename: &Path, lineno: u32) -> IOResult {
let file = match File::open(filename) {
Ok(file) => file,
Err(ref e) if e.kind() == ErrorKind::NotFound => return Ok(()),
e @ Err(_) => e?,
};
let reader = BufReader::new(file);
let start_line = lineno - 2.min(lineno);
let surrounding_src = reader.lines().skip(start_line as usize - 1).take(5);
for (line, cur_line_no) in surrounding_src.zip(start_line..) {
if cur_line_no == lineno {
self.t.fg(color::BRIGHT_WHITE)?;
writeln!(self.t, ">>{:>6} {}", cur_line_no, line?)?;
self.t.reset()?;
} else {
writeln!(self.t, "{:>8} {}", cur_line_no, line?)?;
}
}
Ok(())
}
fn print_backtrace(&mut self) -> IOResult {
writeln!(self.t, "\n{:-^80}\n", "[ BACKTRACE ]")?;
let mut symbols = Vec::new();
backtrace::trace(|x| {
backtrace::resolve(x.ip(), |sym| {
symbols.push((
sym.name().map(|x| x.to_string()),
sym.lineno(),
sym.filename().map(|x| x.into()),
));
});
true
});
for (i, (name, lineno, filename)) in symbols.into_iter().enumerate() {
let mut sym = Sym {
handler: self,
name,
lineno,
filename,
};
sym.print_loc(i)?;
}
Ok(())
}
fn print_panic_info(&mut self) -> IOResult {
self.t.fg(color::RED)?;
writeln!(self.t, "\nOh noez! Panic! 💥\n")?;
self.t.reset()?;
let payload_fallback = "<non string panic payload>".to_owned();
let payload: &String = self
.pi
.payload()
.downcast_ref()
.unwrap_or(&payload_fallback);
write!(self.t, "Message: ")?;
self.t.fg(color::CYAN)?;
writeln!(self.t, "{}", payload)?;
self.t.reset()?;
write!(self.t, "Location: ")?;
if let Some(loc) = self.pi.location() {
self.t.fg(color::MAGENTA)?;
write!(self.t, "{}", loc.file())?;
self.t.fg(color::WHITE)?;
write!(self.t, ":")?;
self.t.fg(color::MAGENTA)?;
writeln!(self.t, "{}", loc.line())?;
self.t.reset()?;
} else {
writeln!(self.t, "<unknown>")?;
}
Ok(())
}
fn go(mut self) -> IOResult {
self.print_panic_info()?;
if self.v >= Verbosity::MEDIUM {
self.print_backtrace()?;
}
Ok(())
}
fn new(pi: &'a PanicInfo) -> Self {
Self {
v: get_verbosity(),
pi: pi,
t: term::stderr().unwrap(),
}
}
}