hi-doc 0.3.0

Diagnostics formatting library
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
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

use core::fmt;

use annotated_string::{ApplyAnnotation, AnnotatedRope, Annotation};

pub type Text = AnnotatedRope<Formatting>;

#[derive(Default, Clone, PartialEq, Debug)]
pub struct Formatting {
	pub color: Option<u32>,
	pub bg_color: Option<u32>,
	pub bold: bool,
	pub underline: bool,
	pub decoration: bool,
	pub url: Option<String>,
}
impl Annotation for Formatting {
	fn try_merge(&mut self, other: &Self) -> bool {
		self == other
	}
}

impl ApplyAnnotation<Formatting> for Formatting {
	fn apply(&mut self, change: &Formatting) {
		if let Some(color) = change.color {
			self.color = Some(color);
		}
		if let Some(bg_color) = change.bg_color {
			self.bg_color = Some(bg_color);
		}
		if change.bold {
			self.bold = true;
		}
		if change.underline {
			self.underline = true;
		}
		if change.url.is_some() {
			self.url = change.url.clone();
		}
	}
}

pub struct AddColorToUncolored(pub u32);
impl ApplyAnnotation<AddColorToUncolored> for Formatting {
	fn apply(&mut self, change: &AddColorToUncolored) {
		if self.color.is_some() {
			return;
		}
		self.color = Some(change.0);
	}
}

impl Formatting {
	pub fn listchar() -> Self {
		Self {
			color: Some(0x92837400),
			decoration: true,
			..Default::default()
		}
	}
	pub fn line_number() -> Self {
		Self {
			color: Some(0x92837400),
			// bg_color: Some(0x28282800),
			..Default::default()
		}
	}
	pub fn border() -> Self {
		Self {
			color: Some(0x92929200),
			..Default::default()
		}
	}
	pub fn filename() -> Self {
		Self {
			color: Some(0x6868a900),
			..Default::default()
		}
	}
	pub fn color(color: u32) -> Self {
		Self {
			color: Some(color),
			..Default::default()
		}
	}
	pub fn rgb([r, g, b]: [u8; 3]) -> Self {
		Self::color(u32::from_be_bytes([r, g, b, 0]))
	}

	pub fn underline(mut self) -> Self {
		self.underline = true;
		self
	}

	pub fn bold(mut self) -> Self {
		self.bold = true;
		self
	}

	pub fn decoration(mut self) -> Self {
		self.decoration = true;
		self
	}

	// TODO: Use url crate for sanitization purposes?
	pub fn url(mut self, url: String) -> Self {
		self.url = Some(url);
		self
	}
}

const CSI: &str = "\x1b[";
const OSC: &str = "\x1b]";
const ST: &str = "\x1b\\";

pub fn text_to_ansi(buf: &Text, out: &mut String) {
	text_to_ansi_res(buf, out).expect("no fmt error")
}
pub fn text_to_ansi_res(buf: &Text, out: &mut String) -> fmt::Result {
	use std::fmt::Write;

	for (text, meta) in buf.fragments() {
		if meta.bold {
			write!(out, "{CSI}1m")?;
		}
		if meta.underline {
			write!(out, "{CSI}4m")?;
		}
		if let Some(color) = meta.color {
			let [r, g, b, _a] = u32::to_be_bytes(color);
			write!(out, "{CSI}38;2;{r};{g};{b}m")?;
		}
		if let Some(bg_color) = meta.bg_color {
			let [r, g, b, _a] = u32::to_be_bytes(bg_color);
			write!(out, "{CSI}48;2;{r};{g};{b}m")?;
		}
		// We might want to add `id=` parameter to make terminals highlight split `Text`?
		if let Some(url) = &meta.url {
			write!(out, "{OSC}8;;{url}{ST}")?;
		}
		for chunk in text {
			write!(out, "{chunk}")?;
		}
		if meta.url.is_some() {
			write!(out, "{OSC}8;;{ST}")?;
		}
		if meta.color.is_some() || meta.bg_color.is_some() || meta.underline || meta.bold {
			write!(out, "{CSI}0m")?;
		}
	}
	Ok(())
}