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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
//! Worker
//!
//! Ideally, any intensive work *must* happen in the worker, to avoid locking up the main/UI thread
//! as much as possible.
//!
//! For now this only happens for markdown parsing, and image loading, resizing, and encoding.
//!
//! For example, text search could benefit from running in the worker, but it's not clear how the
//! text should then actually be shared.
pub mod highlighter;
pub mod mermaid;
pub mod sections;
use std::{
collections::HashMap,
sync::{
Arc,
mpsc::{Receiver, Sender},
},
thread::{self, JoinHandle},
};
use cosmic_text::fontdb::Database;
use mdfrier::MdFrier;
use ratatui::layout::Size;
use ratatui_image::{Resize, picker::Picker, sliced::SlicedProtocol};
use reqwest::Client;
use tokio::{runtime::Builder, sync::RwLock, task::JoinSet};
use crate::{
Cmd, Event, Protocol, VERSION,
config::{Config, MermaidConfig},
document::{
LineExtra, LinkReference, SectionContent, header_images, header_sections, image_section,
},
error::Error,
model::DocumentId,
setup::FontRenderer,
sources::{SharedDocumentSource, open_source},
worker::{
highlighter::Highlighter,
sections::{SectionEvent, SectionIterator},
},
};
#[expect(clippy::too_many_arguments)]
pub fn worker_thread(
document_source: SharedDocumentSource,
picker: Picker,
renderer: Option<Box<FontRenderer>>,
config: Config,
deep_fry: bool,
cmd_rx: Receiver<Cmd>,
event_tx: Sender<Event>,
config_max_image_height: u16,
) -> JoinHandle<Result<(), Error>> {
thread::spawn(move || {
let runtime = Builder::new_multi_thread()
.worker_threads(2)
.enable_all()
.build()?;
let result = runtime.block_on(async {
let builder = Client::builder().user_agent(format!(
"mdfried/{}",
VERSION.get().unwrap_or(&"unknown".to_owned())
));
// Attempt to mitigate a test failure on darwin.
// `system-configuration` is traced to reqwest via:
// cargo tree -i system-configuration --target all
// The tests shouldn't be doing any requests, so the client building here would be the
// most likely source of that panic.
// ```
// thread '<unnamed>' (103071) panicked at /nix/build/nix-5646-2352996470/mdfried-0.20.1-vendor/source-registry-0/system-configuration-0.5.1/src/dynamic_store.rs:154:1:
// Attempted to create a NULL object.
// ```
#[cfg(test)]
let builder = builder.no_proxy();
let client = Arc::new(RwLock::new(builder.build()?));
#[cfg(feature = "svg")]
let fontdb = renderer
.as_ref()
.map(|fr| {
let db = fr.font_system.db();
Arc::new(db.clone())
}).or_else(|| {
#[cfg(test)]
{
// Making the font db fails some tests, maybe takes too long.
None
}
#[expect(clippy::cfg_not_test)]
#[cfg(not(test))]
{
if !config.theme.has_text_size_protocol.unwrap_or_default() {
log::warn!("loading system fonts for SVG despite not using text-size-protocol");
}
let mut fontdb = Database::new();
fontdb.load_system_fonts(); // loads all system fonts
Some(Arc::new(fontdb))
}
});
#[cfg(not(feature = "svg"))]
let fontdb = None;
let highlighter = Arc::new(Highlighter::new(&config.theme));
// Specifically not a tokio Mutex, because we use it in spawn_blocking.
let thread_renderer =
renderer.map(|renderer| Arc::new(std::sync::Mutex::new(renderer)));
let thread_picker = Arc::new(picker);
let mut parser = MdFrier::new()?;
for cmd in cmd_rx {
log::debug!("Cmd: {cmd}");
match cmd {
Cmd::Parse(document_id, width, text, image_cache) => {
log::info!("Parse {document_id}");
event_tx.send(Event::NewDocument(document_id))?;
let lines = parser.parse(width, &text, &config.theme)?;
let mut section_iter = SectionIterator::new(lines, &config.theme);
let mut post_parse_events = Vec::new();
for section in &mut section_iter {
match §ion.content {
SectionContent::Lines(lines) => {
for (_, extras) in lines {
for extra in extras {
if let LineExtra::Link { reference, .. } = extra
&& let LinkReference::ReferenceDefinition{ id, url } = reference {
post_parse_events.push(SectionEvent::ReferenceDefinition{ id: id.clone(), url: url.clone() });
}
}
}
event_tx.send(Event::Parsed(document_id, section))?;
}
SectionContent::Code(language, lines) => {
post_parse_events.push(SectionEvent::Code(section.id, language.clone(), lines.iter().map(|(line,_)| line.clone()).collect()));
event_tx.send(Event::Parsed(document_id, section))?;
}
SectionContent::Image(_, _,_,_) => {
unreachable!("SectionIterator produced Image");
}
SectionContent::ImagePlaceholder(link, lines) => {
let section_id = section.id;
let link = link.clone();
let has_trailing_blank = lines.last().map(|(line,_)| line.spans.is_empty()).unwrap_or_default();
event_tx.send(Event::Parsed(document_id, section))?;
post_parse_events.push(SectionEvent::Image(section_id, link, has_trailing_blank));
},
SectionContent::Header(_, _, _) => {
if !config.theme.has_text_size_protocol.unwrap_or_default() {
unreachable!("SectionIterator produced Header without text-size-protocol");
}
event_tx.send(Event::Parsed(document_id, section))?;
}
SectionContent::HeaderPlaceholder(text,tier,_) => {
if config.theme.has_text_size_protocol.unwrap_or_default() {
unreachable!("SectionIterator produced HeaderPlaceholder with text-size-protocol");
}
let section_id = section.id;
let text = text.clone();
let tier = *tier;
event_tx.send(Event::Parsed(document_id, section))?;
if thread_renderer.is_some() {
post_parse_events.push(SectionEvent::Header(section_id, text, tier));
}
}
}
}
let section_id = section_iter.last_section_id();
drop(section_iter);
// Send cached images synchronously before ParseDone
let mut image_cache = image_cache.unwrap_or_default();
let mut uncached_post_parse_events = Vec::new();
for event in post_parse_events {
match &event {
SectionEvent::Image(
section_id,
link,
has_trailing_blank,
) => {
if let Some((proto, size, max_size)) = image_cache.images.remove(&link.url) {
if width == max_size.width && config_max_image_height >= max_size.height {
event_tx.send(Event::ImageLoaded(
document_id,
*section_id,
link.clone(),
(proto, size, max_size),
*has_trailing_blank,
))?;
log::debug!("image cache hit: {max_size:?} vs {width}x{config_max_image_height}, {size:?}, {}", link.url);
} else {
log::debug!("image cache hit but different max width ({width}x{config_max_image_height} vs {max_size}): {size:?}, {}", link.url);
uncached_post_parse_events.push(event);
}
} else {
log::debug!("image cache miss: {}", link.url);
uncached_post_parse_events.push(event);
}
}
SectionEvent::Header(section_id, text, tier) => {
let key = (text.clone(), *tier);
if let Some(protos) = image_cache.headers(width).and_then(|hc| hc.remove(&key)) {
log::debug!("header cache hit: {key:?}");
event_tx.send(Event::HeaderLoaded(
document_id,
*section_id,
protos
.into_iter()
.map(|proto| (text.clone(), *tier, proto))
.collect(),
))?;
} else {
log::debug!("header cache miss: {key:?}");
uncached_post_parse_events.push(event);
}
}
SectionEvent::ReferenceDefinition { id, url } => {
event_tx.send(Event::ReferenceDefinition { id: format!("[{id}]"), url: url.clone() })?;
}
_ => uncached_post_parse_events.push(event),
}
}
event_tx.send(Event::ParseDone(document_id, section_id, text))?;
if !uncached_post_parse_events.is_empty() {
process_post_parse_events(
event_tx.clone(),
document_source.clone(),
client.clone(),
thread_picker.clone(),
thread_renderer.clone(),
fontdb.clone(),
highlighter.clone(),
width,
&config,
deep_fry,
document_id,
uncached_post_parse_events,
).await?;
}
}
Cmd::OpenUrl(url) => {
let event_tx = event_tx.clone();
tokio::task::spawn_blocking(move || -> Result<(), Error> {
if let Ok((text, _)) = open_source(&url, None) {
event_tx.send(Event::NewSourceContent(text))?;
}
Ok(())
})
.await??;
}
Cmd::LoadImage(path) => {
let event_tx = event_tx.clone();
let picker = thread_picker.clone();
tokio::task::spawn_blocking(move || -> Result<(), Error> {
let dyn_img = if let Some(path) = path {
image::ImageReader::open(path)?.decode()?
} else {
let bytes = include_bytes!("../assets/logo.png");
image::ImageReader::with_format(std::io::Cursor::new(bytes), image::ImageFormat::Png).decode()?
};
let proto = picker.new_protocol(
dyn_img,
crate::view::WELCOME_LOGO_SIZE.into(),
Resize::Fit(Some(ratatui_image::FilterType::Lanczos3))
)?;
event_tx.send(Event::RootImageLoaded(proto))?;
Ok(())
})
.await??;
}
}
}
Ok::<(), Error>(())
});
if let Err(Error::ThreadClosed) = result {
log::info!("ThreadClosedError: Abandoning blocking worker threads");
runtime.shutdown_background();
}
result
})
}
#[expect(clippy::too_many_arguments)]
async fn process_post_parse_events(
task_tx: Sender<Event>,
document_source: SharedDocumentSource,
client: Arc<RwLock<Client>>,
picker: Arc<Picker>,
font_renderer: Option<Arc<std::sync::Mutex<Box<FontRenderer>>>>,
fontdb: Option<Arc<Database>>,
highlighter: Arc<Highlighter>,
width: u16,
config: &Config,
deep_fry: bool,
document_id: DocumentId,
post_parse_events: Vec<SectionEvent>,
) -> Result<(), Error> {
// TODO: handle spawned task result errors, right now it's just logged and discarded.
let config_max_image_height = config.max_image_height;
let mut set: JoinSet<Result<(), Error>> = JoinSet::new();
for event in post_parse_events {
let task_tx = task_tx.clone();
let picker = picker.clone();
let client = client.clone();
let font_renderer = font_renderer.clone();
let fontdb = fontdb.clone();
let highlighter = highlighter.clone();
let document_source = document_source.clone();
let mermaid_config = config.mermaid.clone();
set.spawn(async move {
match event {
SectionEvent::Image(section_id, link, has_trailing_blank) => {
let url = link.url.clone(); // For potential errors
// Load fresh image
match image_section(
&picker,
config_max_image_height,
width,
document_source.clone(),
client.clone(),
section_id,
link,
deep_fry,
fontdb.clone(),
)
.await
{
Ok(section) => {
let SectionContent::Image(link, protos, size, max_size) =
section.content
else {
unreachable!("image_section should return SectionContent::Image");
};
task_tx.send(Event::ImageLoaded(
document_id,
section_id,
link,
(protos, size, max_size),
has_trailing_blank,
))?
}
Err(Error::ImageLoad(url, err)) => {
task_tx.send(Event::ImageFailed(document_id, section_id, url, err))?
}
Err(err) => {
let err = match err {
Error::Io(err) => err.to_string(),
_ => format!("{err}"),
};
task_tx.send(Event::ImageFailed(document_id, section_id, url, err))?
}
}
}
SectionEvent::Header(section_id, text, tier) => {
log::debug!("SectionEvent::Header: {text}");
let Some(font_renderer) = &font_renderer else {
panic!("should not have produced SectionEvent::Header without renderer");
};
let font_renderer = font_renderer.clone();
let images = tokio::task::spawn_blocking(move || {
let mut r = font_renderer.lock()?;
header_images(&mut r, width, text, tier, deep_fry)
})
.await??;
let picker = picker.clone();
let images = tokio::task::spawn_blocking(move || {
header_sections(&picker, width, images, deep_fry)
})
.await??;
task_tx.send(Event::HeaderLoaded(document_id, section_id, images))?;
}
SectionEvent::ReferenceDefinition { .. } => {}
SectionEvent::Code(section_id, language, lines) => {
if language == "mermaid" {
let result = match mermaid_config {
MermaidConfig::Disabled => Ok::<_, Error>(None),
#[cfg(feature = "mermaid")]
MermaidConfig::Builtin => {
if let Some(fontdb) = fontdb {
Ok(Some(
mermaid::internal::render(
&lines,
width,
config_max_image_height,
fontdb,
picker,
)
.await?,
))
} else {
log::error!("mermaid: no fontdb available");
Err(Error::Mermaid("your message here".into()))
}
}
MermaidConfig::Command(cmd) => Ok(Some(
mermaid::render_with_cmd(
&cmd,
&lines,
width,
config_max_image_height,
picker,
)
.await?,
)),
};
match result {
Ok(Some((sliced, size, max_size, link))) => {
task_tx.send(Event::ImageLoaded(
document_id,
section_id,
link,
(sliced, size, max_size),
true, // comes from a codeblock
))?;
return Ok(());
}
Ok(None) => {} // Fall through to regular syntax highlighter.
Err(err) => log::error!("{err}"),
}
}
let mut hl = highlighter.fork();
let text = tokio::task::spawn_blocking(move || hl.highlight(&language, lines))
.await??;
task_tx.send(Event::CodeLoaded(document_id, section_id, text))?;
}
}
Ok(())
});
}
while let Some(result) = set.join_next().await {
match result {
Ok(Ok(())) => {}
Err(e) => log::error!("process_post_parse_events join error: {e}"),
Ok(Err(e)) => {
if let Error::ThreadClosed = e {
log::debug!("process_post_parse_events JoinSet::join_next early exit: {e}");
return Err(e);
}
log::error!("process_post_parse_events task error: {e}")
}
}
}
Ok(())
}
#[derive(Default)]
pub struct ImageCache {
pub images: HashMap<String, (SlicedProtocol, Size, Size)>,
headers_width: u16,
headers: HashMap<(String, u8), Vec<Protocol>>,
}
impl ImageCache {
pub fn is_empty(&self) -> bool {
self.images.is_empty() && self.headers.is_empty()
}
pub fn headers(&mut self, width: u16) -> Option<&mut HashMap<(String, u8), Vec<Protocol>>> {
if self.headers_width == width {
Some(&mut self.headers)
} else {
self.headers = Default::default();
None
}
}
}
impl std::fmt::Debug for ImageCache {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"ImageCache(image_count:{},header_count:{})",
self.images.len(),
self.headers.len(),
)
}
}