Final adjustments to conform to mupdf changes

* Relicense to GPLv3 since poppler is GPL and we must not violate that license

* Add note to README that contributions will be licensed as MPL-2.0

.github/workflows/rust.yml

@@ -26,32 +26,13 @@ jobs:
     - name: Install build dependencies
       run: |
         sudo apt-get update
-        sudo apt-get install -y cmake libjpeg-dev libfontconfig1-dev libopenjp2-7-dev libglib2.0-dev libnss3-dev  
+        sudo apt-get install -y libfontconfig1-dev libgoogle-perftools-dev google-perftools
-    - name: Build newer poppler
-      run: |
-        wget https://poppler.freedesktop.org/poppler-23.12.0.tar.xz
-        tar xf poppler-23.12.0.tar.xz
-        cd poppler-23.12.0
-        mkdir build && cd build
-        cmake .. -DCMAKE_BUILD_TYPE=Release \
-             -DCMAKE_C_COMPILER_LAUNCHER=sccache \
-             -DCMAKE_CXX_COMPILER_LAUNCHER=sccache \
-             -DENABLE_UNSTABLE_API_ABI_HEADERS=ON \
-             -DENABLE_GPGME=OFF \
-             -DENABLE_QT5=OFF \
-             -DENABLE_QT6=OFF \
-             -DENABLE_BOOST=OFF \
-             -DENABLE_SPLASH=OFF \
-             -DENABLE_LIBCURL=OFF
-        make -j$(nproc)
-        sudo make install
-        sudo ldconfig
     - uses: actions/checkout@v4
     - name: Clippy
       run: cargo clippy -- -D warnings
     - name: Check fmt
       run: cargo fmt -- --check
     - name: Run tests
-      run: cargo test
+      run: cargo test --benches -- adobe_example
     - name: Build
       run: cargo build

CHANGELOG.md

@@ -1,10 +1,21 @@
 # Unreleased
 
+- Update ratatui(-image) dependencies
+- Enable Ctrl+Z/Suspend functionality
+- Rewrite with mupdf as the backend for much better performance and rendering quality
+
+# v0.2.0
+
 - Add `--r-to-l` flag to support displaying pdfs that read from right to left
 - Add `--max-wide` flag to restrict amount of pages that can appear on the screen at a time
 - Small internal changes to accomodate a few more clippy lints
 - Update `ratatui` and `ratatui-image` git dependencies to latest upstream
 - Move `ratatui-image/vb64` support under `nightly` feature, enabled by default
+- Fixed a bug where jumping to a page out of range could result in weird `esc` key behavior
+- Added CI ([#31](https://github.com/itsjunetime/tdf/pull/31), thank you [@Kriejstal](https://github.com/Kreijstal))
+- Changed global allocator to [`mimalloc`](https://github.com/purpleprotocol/mimalloc_rust) for slightly improved performance
+- Fixed issue with document reloading not working when files are intermedially deleted
+- Fixed a lot of weirdness with bottom message layering/updating
 
 # v0.1.0
 

Cargo.toml

@@ -1,42 +1,44 @@
 [package]
-name = "tdf"
+name = "tdf-viewer"
-version = "0.1.0"
+version = "0.2.0"
 authors = ["June Welker <junewelker@gmail.com>"]
 edition = "2021"
 description = "A terminal viewer for PDFs"
 readme = "README.md"
 homepage = "https://github.com/itsjunetime/tdf"
 repository = "https://github.com/itsjunetime/tdf"
-license = "MPL-2.0"
+license = "AGPL-3.0-only"
 keywords = ["pdf", "tui", "cli", "terminal"]
 categories = ["command-line-utilities", "text-processing", "visualization"]
 default-run = "tdf"
 
 [[bin]]
 name = "tdf"
+path = "src/main.rs"
 
 # lib only exists for benching
 [lib]
 name = "tdf"
 
 [dependencies]
-poppler-rs = { version = "0.24.1", default-features = false, features = ["v23_7"] }
-cairo-rs = { version = "0.20.0", default-features = false, features = ["png"] }
 # we're using this branch because it has significant performance fixes that I'm waiting on responses from the upstream devs to get upstreamed. See https://github.com/ratatui-org/ratatui/issues/1116
 ratatui = { git = "https://github.com/itsjunetime/ratatui.git" }
 # ratatui = { path = "./ratatui/ratatui" }
-# We're using this to have the vb64 feature (for faster base64 encoding, since that does take up a good bit of time when converting images to the Box<dyn ratatui_image::Protocol>. It also just includes a few more features that I'm waiting on main to upstream
+# We're using this to have the vb64 feature (for faster base64 encoding, since that does take up a good bit of time when converting images to the `Protocol`. It also just includes a few more features that I'm waiting on main to upstream
 ratatui-image = { git = "https://github.com/itsjunetime/ratatui-image.git", branch = "vb64_on_personal", default-features = false }
 # ratatui-image = { path = "./ratatui-image", features = ["vb64"], default-features = false }
 crossterm = { version = "0.28.1", features = ["event-stream"] }
-image = { version = "0.25.1", features = ["png", "rayon"], default-features = false }
+image = { version = "0.25.1", features = ["pnm", "rayon"], default-features = false }
-notify = { version = "7.0.0", features = ["crossbeam-channel"] }
+notify = { version = "8.0.0", features = ["crossbeam-channel"] }
 tokio = { version = "1.37.0", features = ["rt-multi-thread", "macros"] }
 futures-util = { version = "0.3.30", default-features = false }
-glib = "0.20.0"
 itertools = "*"
 flume = { version = "0.11.0", default-features = false, features = ["async"] }
 xflags = "0.4.0-pre.2"
+mimalloc = "0.1.43"
+nix = { version = "0.29.0", features = ["signal"] }
+mupdf = { git = "https://github.com/itsjunetime/mupdf-rs", branch = "remove_debug_print", default-features = false, features = ["svg", "system-fonts", "img"] }
+rayon = { version = "*", default-features = false }
 
 # for tracing with tokio-console
 console-subscriber = { version = "0.4.0", optional = true }
@@ -49,6 +51,8 @@ lto = "fat"
 default = ["nightly"]
 nightly = ["ratatui-image/vb64"]
 tracing = ["tokio/tracing", "dep:console-subscriber"]
+epub = ["mupdf/epub"]
+cbz = ["mupdf/cbz"]
 
 [dev-dependencies]
 criterion = { version = "0.5.1", features = ["async_tokio"] }
@@ -151,3 +155,6 @@ unused_self = "warn"
 used_underscore_binding = "warn"
 used_underscore_items = "warn"
 zero_sized_map_values = "warn"
+
+[patch.crates-io]
+pathfinder_simd = { git = "https://github.com/itsjunetime/pathfinder.git" }

README.md

@@ -14,7 +14,7 @@ Designed to be performant, very responsive, and work well with even very large P
 - Reactive layout
 
 ## To Build
-First, you need to install the system dependencies. This includes packages such as (but not limited to) `cairo`, `gtk`, and `poppler`. If you're on linux, these will probably show up in your package manager as something like `libcairo-devel` or `cairo-dev`.
+First, you need to install the system dependencies. This will generally only include `libfontconfig`. If you're on linux, these will probably show up in your package manager as something like `libfontconfig1-devel` or `libfontconfig-dev`.
 
 If it turns out that you're missing one of these, it will fail to compile and tell you what library you're missing. Find the development package for that library in your package manager, install it, and try to build again. Now, the important steps:
 
@@ -29,3 +29,5 @@ I dunno. Just for fun, mostly.
 ## Can I contribute?
 
 Yeah, sure. Please do.
+
+Please note, though, that all contributions will be treated as licensed under MPL-2.0.

benches/rendering.rs

@@ -71,7 +71,7 @@ pub async fn render_first_page(path: impl AsRef<Path>) {
 	} = start_all_rendering(path);
 
 	// we only want to render until the first page is ready to be printed
-	while pages.iter().all(|p| p.is_none()) {
+	while pages.iter().all(Option::is_none) {
 		tokio::select! {
 			Some(renderer_msg) = from_render_rx.next() => {
 				handle_renderer_msg(renderer_msg, &mut pages, &mut to_converter_tx);
@@ -94,14 +94,15 @@ async fn render_all_files(path: &'static str) -> Vec<PageInfo> {
 
 	while let Some(info) = from_render_rx.next().await {
 		match info.expect("Renderer ran into an error while rendering") {
+			RenderInfo::Reloaded => (),
 			RenderInfo::NumPages(num) => fill_default(&mut pages, num),
 			RenderInfo::Page(page) => {
-				let num = page.page;
+				let num = page.page_num;
 				pages[num] = Some(page);
 			}
 		};
 
-		if pages.iter().all(|p| p.is_some()) {
+		if pages.iter().all(Option::is_some) {
 			break;
 		}
 	}
@@ -136,7 +137,7 @@ async fn convert_all_files(files: Vec<PageInfo>) {
 		}
 	}
 
-	while converted.iter().any(|p| p.is_none()) {
+	while converted.iter().any(Option::is_none) {
 		let page = from_converter_rx
 			.next()
 			.await
@@ -157,7 +158,7 @@ impl Profiler for CpuProfiler {
 	fn start_profiling(&mut self, benchmark_id: &str, _: &std::path::Path) {
 		let file = format!(
 			"./{}-{}.profile",
-			benchmark_id.replace("/", "-"),
+			benchmark_id.replace('/', "-"),
 			SystemTime::now()
 				.duration_since(UNIX_EPOCH)
 				.unwrap()

benches/utils.rs

@@ -21,6 +21,8 @@ pub fn handle_renderer_msg(
 			to_converter_tx.send(ConverterMsg::NumPages(num)).unwrap();
 		}
 		Ok(RenderInfo::Page(info)) => to_converter_tx.send(ConverterMsg::AddImg(info)).unwrap(),
+		// We can ignore the `Reloaded` variant 'cause that's only used to send info to the TUI
+		Ok(RenderInfo::Reloaded) => (),
 		Err(e) => panic!("Got error from renderer: {e:?}")
 	}
 }
@@ -61,7 +63,7 @@ pub fn start_rendering_loop(
 	Sender<RenderNotif>
 ) {
 	let pathbuf = path.as_ref().canonicalize().unwrap();
-	let str_path = format!("file://{}", pathbuf.into_os_string().to_string_lossy());
+	let str_path = pathbuf.into_os_string().to_string_lossy().to_string();
 
 	let (to_render_tx, from_main_rx) = unbounded();
 	let (to_main_tx, from_render_rx) = unbounded();

scripts/build_dbg_info.sh

@@ -1,13 +0,0 @@
-#!/usr/bin/env bash
-# 1. Pull the git source of poppler
-# 2. cd poppler
-# 3. git checkout poppler-23.07.0
-# 4. mkdir build
-# 5. cd build
-# 6. cmake .. -DENABLE_GPGME=OFF -DENABLE_QT5=OFF -DENABLE_QT6=OFF -DENABLE_BOOST=OFF -DBUILD_SHARED_LIBS=OFF
-# 7. cmake --build . --parallel $(nproc)
-env SYSTEM_DEPS_POPPLER_GLIB_LINK=static \
-	SYSTEM_DEPS_POPPLER_GLIB_NO_PKG_CONFIG=1 \
-	SYSTEM_DEPS_POPPLER_GLIB_SEARCH_NATIVE=/path/to/poppler/build/glib \
-	SYSTEM_DEPS_POPPLER_GLIB_LIB=poppler-glib \
-	cargo perf --bin for_profiling --

src/converter.rs

@@ -1,8 +1,9 @@
 use flume::{Receiver, SendError, Sender, TryRecvError};
 use futures_util::stream::StreamExt;
-use image::ImageFormat;
+use image::DynamicImage;
 use itertools::Itertools;
 use ratatui_image::{picker::Picker, protocol::Protocol, Resize};
+use rayon::iter::ParallelIterator;
 
 use crate::renderer::{fill_default, PageInfo, RenderError};
 
@@ -54,13 +55,25 @@ pub async fn run_conversion_loop(
 			return Ok(None);
 		};
 
-		let img_area = page_info.img_data.area;
+		let mut dyn_img = image::load_from_memory_with_format(
+			&page_info.img_data.pixels,
+			image::ImageFormat::Pnm
+		)
+		.map_err(|e| RenderError::Converting(format!("Can't load image: {e}")))?;
 
-		let dyn_img =
+		match dyn_img {
-			image::load_from_memory_with_format(&page_info.img_data.data, ImageFormat::Png)
+			DynamicImage::ImageRgb8(ref mut img) =>
-				.map_err(|e| {
+				for quad in &*page_info.result_rects {
-					RenderError::Render(format!("Couldn't convert Vec<u8> to DynamicImage: {e}"))
+					img.par_enumerate_pixels_mut()
-				})?;
+						.filter(|(x, y, _)| {
+							*x > quad.ul_x && *x < quad.lr_x && *y > quad.ul_y && *y < quad.lr_y
+						})
+						.for_each(|(_, _, px)| px.0[2] = px.0[2].saturating_sub(u8::MAX / 2));
+				},
+			_ => unreachable!()
+		};
+
+		let img_area = page_info.img_data.cell_area;
 
 		// We don't actually want to Crop this image, but we've already
 		// verified (with the ImageSurface stuff) that the image is the correct
@@ -69,7 +82,7 @@ pub async fn run_conversion_loop(
 		let txt_img = picker
 			.new_protocol(dyn_img, img_area, Resize::None)
 			.map_err(|e| {
-				RenderError::Render(format!(
+				RenderError::Converting(format!(
 					"Couldn't convert DynamicImage to ratatui image: {e}"
 				))
 			})?;
@@ -79,15 +92,15 @@ pub async fn run_conversion_loop(
 
 		Ok(Some(ConvertedPage {
 			page: txt_img,
-			num: page_info.page,
+			num: page_info.page_num,
-			num_results: page_info.search_results
+			num_results: page_info.result_rects.len()
 		}))
 	}
 
 	fn handle_notif(msg: ConverterMsg, images: &mut Vec<Option<PageInfo>>, page: &mut usize) {
 		match msg {
 			ConverterMsg::AddImg(img) => {
-				let page_num = img.page;
+				let page_num = img.page_num;
 				images[page_num] = Some(img);
 			}
 			ConverterMsg::NumPages(n_pages) => {

src/lib.rs

@@ -1,3 +1,6 @@
+#[global_allocator]
+static ALLOC: mimalloc::MiMalloc = mimalloc::MiMalloc;
+
 pub mod converter;
 pub mod renderer;
 pub mod skip;

src/main.rs

@@ -1,10 +1,10 @@
 use std::{
+	ffi::OsString,
 	io::{stdout, Read, Write},
 	num::NonZeroUsize,
 	path::PathBuf
 };
 
-use converter::{run_conversion_loop, ConvertedPage, ConverterMsg};
 use crossterm::{
 	execute,
 	terminal::{
@@ -13,17 +13,14 @@ use crossterm::{
 	}
 };
 use futures_util::{stream::StreamExt, FutureExt};
-use glib::{LogField, LogLevel, LogWriterOutput};
 use notify::{Event, EventKind, RecursiveMode, Watcher};
 use ratatui::{backend::CrosstermBackend, Terminal};
 use ratatui_image::picker::Picker;
-use renderer::{RenderError, RenderInfo, RenderNotif};
+use tdf::{
-use tui::{InputAction, Tui};
+	converter::{run_conversion_loop, ConvertedPage, ConverterMsg},
-
+	renderer::{self, RenderError, RenderInfo, RenderNotif},
-mod converter;
+	tui::{BottomMessage, InputAction, MessageSetting, Tui}
-mod renderer;
+};
-mod skip;
-mod tui;
 
 // Dummy struct for easy errors in main
 #[derive(Debug)]
@@ -60,16 +57,30 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 	let (render_tx, tui_rx) = flume::unbounded();
 	let watch_to_tui_tx = render_tx.clone();
 
-	let mut watcher =
+	let mut watcher = notify::recommended_watcher(on_notify_ev(
-		notify::recommended_watcher(on_notify_ev(watch_to_tui_tx, watch_to_render_tx))?;
+		watch_to_tui_tx,
+		watch_to_render_tx,
+		path.file_name()
+			.ok_or("Path does not have a last component??")?
+			.to_owned()
+	))?;
 
-	// We're making this nonrecursive 'cause we're just watching a single file, so there's nothing
+	// So we have to watch the parent directory of the file that we are interested in because the
-	// to recurse into
+	// `notify` library works on inodes, and if the file is deleted, that inode is gone as well,
-	watcher.watch(&path, RecursiveMode::NonRecursive)?;
+	// and then the notify library just gives up on trying to watch for the file reappearing. Imo
+	// they should start watching the parent directory if the file is deleted, and then wait for it
+	// to reappear and then begin watching it again, but whatever. It seems they've made their
+	// opinion on this clear
+	// (https://github.com/notify-rs/notify/issues/113#issuecomment-281836995) so whatever, guess
+	// we have to do this annoying workaround.
+	watcher.watch(
+		path.parent().expect("The root directory is not a PDF"),
+		RecursiveMode::NonRecursive
+	)?;
 
 	// TODO: Handle non-utf8 file names? Maybe by constructing a CString and passing that in to the
-	// poppler stuff instead of a rust string?
+	// mupdf stuff instead of a rust string?
-	let file_path = format!("file://{}", path.clone().into_os_string().to_string_lossy());
+	let file_path = path.clone().into_os_string().to_string_lossy().to_string();
 
 	let mut window_size = window_size()?;
 
@@ -143,17 +154,12 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 		|| "Unknown file".into(),
 		|n| n.to_string_lossy().to_string()
 	);
-	let mut tui = tui::Tui::new(file_name, flags.max_wide, flags.r_to_l.unwrap_or_default());
+	let mut tui = Tui::new(file_name, flags.max_wide, flags.r_to_l.unwrap_or_default());
 
 	let backend = CrosstermBackend::new(std::io::stdout());
 	let mut term = Terminal::new(backend)?;
 	term.skip_diff(true);
 
-	// poppler has some annoying logging (e.g. if you request a page index out-of-bounds of a
-	// document's pages, then it will return `None`, but still log to stderr with CRITICAL level),
-	// so we want to just ignore all logging since this is a tui app.
-	glib::log_set_writer_func(noop);
-
 	execute!(
 		term.backend_mut(),
 		EnterAlternateScreen,
@@ -161,7 +167,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 	)?;
 	enable_raw_mode()?;
 
-	let mut main_area = tui::Tui::main_layout(&term.get_frame());
+	let mut main_area = Tui::main_layout(&term.get_frame());
 	tui_tx.send(RenderNotif::Area(main_area[1]))?;
 
 	let mut tui_rx = tui_rx.into_stream();
@@ -190,20 +196,16 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 			},
 			Some(renderer_msg) = tui_rx.next() => {
 				match renderer_msg {
-					// if an Ok comes through, we know the error has been resolved ('cause it kinda
+					Ok(render_info) => match render_info {
-					// bails whenever we run into an error) so just clear it
-					Ok(render_info) => {
-						match render_info {
 						RenderInfo::NumPages(num) => {
 							tui.set_n_pages(num);
 							to_converter.send(ConverterMsg::NumPages(num))?;
 						},
 						RenderInfo::Page(info) => {
-								tui.got_num_results_on_page(info.page, info.search_results);
+							tui.got_num_results_on_page(info.page_num, info.result_rects.len());
 							to_converter.send(ConverterMsg::AddImg(info))?;
 						},
-						}
+						RenderInfo::Reloaded => tui.set_msg(MessageSetting::Some(BottomMessage::Reloaded)),
-						tui.set_bottom_msg(None);
 					},
 					Err(e) => tui.show_error(e),
 				}
@@ -243,7 +245,8 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 
 fn on_notify_ev(
 	to_tui_tx: flume::Sender<Result<RenderInfo, RenderError>>,
-	to_render_tx: flume::Sender<RenderNotif>
+	to_render_tx: flume::Sender<RenderNotif>,
+	file_name: OsString
 ) -> impl Fn(notify::Result<Event>) {
 	move |res| match res {
 		// If we get an error here, and then an error sending, everything's going wrong. Just give
@@ -251,19 +254,29 @@ fn on_notify_ev(
 		Err(e) => to_tui_tx.send(Err(RenderError::Notify(e))).unwrap(),
 		// TODO: Should we match EventKind::Rename and propogate that so that the other parts of the
 		// process know that too? Or should that be
-		Ok(ev) => match ev.kind {
+		Ok(ev) => {
+			// We only watch the parent directory (see the comment above `watcher.watch` in `fn
+			// main`) so we need to filter out events to only ones that pertain to the single file
+			// we care about
+			if !ev
+				.paths
+				.iter()
+				.any(|path| path.file_name().is_some_and(|f| f == file_name))
+			{
+				return;
+			}
+
+			match ev.kind {
 				EventKind::Access(_) => (),
-			EventKind::Remove(_) =>
+				EventKind::Remove(_) => to_tui_tx
-				drop(to_tui_tx.send(Err(RenderError::Render("File was deleted".into())))),
+					.send(Err(RenderError::Converting("File was deleted".into())))
+					.unwrap(),
 				// This shouldn't fail to send unless the receiver gets disconnected. If that's
 				// happened, then like the main thread has panicked or something, so it doesn't matter
 				// we don't handle the error here.
 				EventKind::Other | EventKind::Any | EventKind::Create(_) | EventKind::Modify(_) =>
-				drop(to_render_tx.send(renderer::RenderNotif::Reload)),
+					to_render_tx.send(RenderNotif::Reload).unwrap(),
+			}
 		}
 	}
 }
-
-fn noop(_: LogLevel, _: &[LogField<'_>]) -> LogWriterOutput {
-	LogWriterOutput::Handled
-}

src/renderer.rs

@@ -1,10 +1,9 @@
-use std::thread;
+use std::{thread::sleep, time::Duration};
 
-use cairo::{Antialias, Context, Format, Surface};
 use crossterm::terminal::WindowSize;
 use flume::{Receiver, SendError, Sender, TryRecvError};
 use itertools::Itertools;
-use poppler::{Color, Document, FindFlags, Page, Rectangle, SelectionStyle};
+use mupdf::{Colorspace, Document, Matrix, Page, Pixmap};
 use ratatui::layout::Rect;
 
 pub enum RenderNotif {
@@ -17,28 +16,27 @@ pub enum RenderNotif {
 #[derive(Debug)]
 pub enum RenderError {
 	Notify(notify::Error),
-	Doc(glib::Error),
+	Doc(mupdf::error::Error),
-	// Don't like storing an error as a string but it needs to be Send to send to the main thread,
+	Converting(String)
-	// and it's just going to be shown to the user, so whatever
-	Render(String)
 }
 
 pub enum RenderInfo {
 	NumPages(usize),
-	Page(PageInfo)
+	Page(PageInfo),
+	Reloaded
 }
 
 #[derive(Clone)]
 pub struct PageInfo {
 	pub img_data: ImageData,
-	pub page: usize,
+	pub page_num: usize,
-	pub search_results: usize
+	pub result_rects: Vec<HighlightRect>
 }
 
 #[derive(Clone)]
 pub struct ImageData {
-	pub data: Vec<u8>,
+	pub pixels: Vec<u8>,
-	pub area: Rect
+	pub cell_area: Rect
 }
 
 #[derive(Default)]
@@ -55,7 +53,7 @@ pub fn fill_default<T: Default>(vec: &mut Vec<T>, size: usize) {
 	}
 }
 
-// this function has to be sync (non-async) because the poppler::Document needs to be held during
+// this function has to be sync (non-async) because the mupdf::Document needs to be held during
 // most of it, but that's basically just a wrapper around `*c_void` cause it's just a binding to C
 // code, so it's !Send and thus can't be held across await points. So we can't call any of the
 // async `send` or `recv` methods in this function body, since those create await points. Which
@@ -70,19 +68,17 @@ pub fn fill_default<T: Default>(vec: &mut Vec<T>, size: usize) {
 #[allow(clippy::needless_pass_by_value)]
 pub fn start_rendering(
 	path: &str,
-	mut sender: Sender<Result<RenderInfo, RenderError>>,
+	sender: Sender<Result<RenderInfo, RenderError>>,
 	receiver: Receiver<RenderNotif>,
 	size: WindowSize
 ) -> Result<(), SendError<Result<RenderInfo, RenderError>>> {
 	// first, wait 'til we get told what the current starting area is so that we can set it to
 	// know what to render to
-	let mut area;
+	let mut area = loop {
-	loop {
 		if let RenderNotif::Area(r) = receiver.recv().unwrap() {
-			area = r;
+			break r;
-			break;
-		}
 		}
+	};
 
 	// We want this outside of 'reload so that if the doc reloads, the search term that somebody
 	// set will still get highlighted in the reloaded doc
@@ -93,11 +89,17 @@ pub fn start_rendering(
 	let col_w = size.width / size.columns;
 	let col_h = size.height / size.rows;
 
+	let mut stored_doc = None;
+
 	'reload: loop {
-		let doc = match Document::from_file(path, None) {
+		let doc = match Document::open(path) {
 			Err(e) => {
 				// if there's an error, tell the main loop
 				sender.send(Err(RenderError::Doc(e)))?;
+
+				match stored_doc {
+					Some(ref d) => d,
+					None => {
 						// then wait for a reload notif (since what probably happened is that the file was
 						// temporarily removed to facilitate a save or something like that)
 						while let Ok(msg) = receiver.recv() {
@@ -110,10 +112,26 @@ pub fn start_rendering(
 						// done, so we're fine to just return
 						return Ok(());
 					}
-			Ok(d) => d
+				}
+			}
+			Ok(d) => {
+				if stored_doc.is_some() {
+					sender.send(Ok(RenderInfo::Reloaded))?;
+				}
+				&*stored_doc.insert(d)
+			}
+		};
+
+		let n_pages = match doc.page_count() {
+			Ok(n) => n as usize,
+			Err(e) => {
+				sender.send(Err(RenderError::Doc(e)))?;
+				// just basic backoff i think
+				sleep(Duration::from_secs(1));
+				continue 'reload;
+			}
 		};
 
-		let n_pages = doc.n_pages() as usize;
 		sender.send(Ok(RenderInfo::NumPages(n_pages)))?;
 
 		// We're using this vec of bools to indicate which page numbers have already been rendered,
@@ -193,8 +211,8 @@ pub fn start_rendering(
 						.map(|(idx, p)| (start_point - (idx + 1), p))
 				);
 
-			let area_w = f64::from(area.width) * f64::from(col_w);
+			let area_w = f32::from(area.width) * f32::from(col_w);
-			let area_h = f64::from(area.height) * f64::from(col_h);
+			let area_h = f32::from(area.height) * f32::from(col_h);
 
 			// we go through each page
 			for (num, rendered) in page_iter {
@@ -218,12 +236,12 @@ pub fn start_rendering(
 
 				// We know this is in range 'cause we're iterating over it but we still just want
 				// to be safe
-				let Some(page) = doc.page(num as i32) else {
+				let page = match doc.load_page(num as i32) {
-					sender.send(Err(RenderError::Render(format!(
+					Err(e) => {
-						"Couldn't get page {num} ({}) of doc?",
+						sender.send(Err(RenderError::Doc(e)))?;
-						num as i32
-					))))?;
 						continue;
+					}
+					Ok(p) => p
 				};
 
 				let rendered_with_no_results =
@@ -245,26 +263,34 @@ pub fn start_rendering(
 						// we make a potentially incorrect assumption here that writing the context
 						// to a png won't fail, and mark that it all rendered correctly here before
 						// spawning off the thread to do so and send it.
-						rendered.contained_term = Some(ctx.num_results > 0);
+						rendered.contained_term = Some(ctx.result_rects.is_empty());
 						rendered.successful = true;
 
-						// if this is the page that the user is currently trying to look at, don't
+						let cap = (ctx.pixmap.width()
-						// bother spawning off a thread to render it to a png - it'll only slow
+							* ctx.pixmap.height() * u32::from(ctx.pixmap.n()))
-						// down the time til the user can see it (due to the overhead of creating a
+							as usize;
-						// thread), but we still want to spawn threads to render the other pages
+						let mut pixels = Vec::with_capacity(cap);
-						// since the effects of parallelizing that will be noticeable if the user
+						if let Err(e) = ctx.pixmap.write_to(&mut pixels, mupdf::ImageFormat::PNM) {
-						// tries to move through pages more quickly
+							sender.send(Err(RenderError::Doc(e)))?;
-						if num == start_point {
+							continue;
-							render_ctx_to_png(&ctx, &mut sender, (col_w, col_h), num)?;
+						};
-						} else {
+
-							let mut sender = sender.clone();
+						sender.send(Ok(RenderInfo::Page(PageInfo {
-							thread::spawn(move || {
+							img_data: ImageData {
-								render_ctx_to_png(&ctx, &mut sender, (col_w, col_h), num)
+								pixels,
-							});
+								cell_area: Rect {
+									x: 0,
+									y: 0,
+									width: (ctx.surface_w / f32::from(col_w)) as u16,
+									height: (ctx.surface_h / f32::from(col_h)) as u16
 								}
+							},
+							page_num: num,
+							result_rects: ctx.result_rects
+						})))?;
 					}
 					// And if we got an error, then obviously we need to propagate that
-					Err(e) => sender.send(Err(RenderError::Render(e)))?
+					Err(e) => sender.send(Err(RenderError::Doc(e)))?
 				}
 			}
 
@@ -283,35 +309,38 @@ pub fn start_rendering(
 }
 
 struct RenderedContext {
-	surface: Surface,
+	pixmap: Pixmap,
-	num_results: usize,
+	surface_w: f32,
-	surface_width: f64,
+	surface_h: f32,
-	surface_height: f64
+	result_rects: Vec<HighlightRect>
 }
 
-/// SAFETY: I think this is safe because, although the backing struct for `Surface` does contain
-/// pointers to like the cairo_backend_t struct that all the cairo stuff is using, that struct is
-/// basically just a vtable, so accessing it from multiple threads *should* be safe since we're
-/// just calling the same functions with different data. The only other thing it holds reference to
-/// is a `cairo_device_t`, but that seems to be thread-safe because it's managed through ref counts
-/// and a mutex. Also, as far as I can tell from reading the source code, write_to_png_stream (the
-/// only function we call on this struct) doesn't access the device at all, so we should be fine
-/// there.
-/// We want this to be Send so that we can delegate the png writing to a separate thread (since
-/// that's the thing that takes the most time, by far, in this app).
-unsafe impl Send for RenderedContext {}
-
 fn render_single_page_to_ctx(
 	page: &Page,
 	search_term: Option<&str>,
 	already_rendered_no_results: bool,
-	(area_w, area_h): (f64, f64)
+	(area_w, area_h): (f32, f32)
-) -> Result<Option<RenderedContext>, String> {
+) -> Result<Option<RenderedContext>, mupdf::error::Error> {
-	let mut result_rects = search_term
+	let mut max_hits = 10;
+	let result_rects = loop {
+		let rects = search_term
 			.as_ref()
-		.map(|term| page.find_text_with_options(term, FindFlags::DEFAULT | FindFlags::MULTILINE))
+			// mupdf allocates a buffer of the size we give it to try to fill it with results. If we
+			// pass in u32::MAX, it allocates too much memory to function. If we pass too small of a
+			// number in, we may miss out on some of the results. Ideally, we'd like to make a better
+			// interface than this, but we're stuck with this kinda ugly looping until we make sure
+			// that we've found every instance of it on this page.
+			.map(|term| page.search(term, max_hits))
+			.transpose()?
 			.unwrap_or_default();
 
+		if rects.len() < (max_hits as usize) {
+			break rects;
+		}
+
+		max_hits *= 2;
+	};
+
 	// If there are no search terms on this page, and we've already rendered it with no search
 	// terms, then just return none to avoid this computation
 	if result_rects.is_empty() && already_rendered_no_results {
@@ -319,7 +348,8 @@ fn render_single_page_to_ctx(
 	}
 
 	// then, get the size of the page
-	let (p_width, p_height) = page.size();
+	let bounds = page.bounds()?;
+	let (p_width, p_height) = (bounds.x1 - bounds.x0, bounds.y1 - bounds.y0);
 
 	// and get its aspect ratio
 	let p_aspect_ratio = p_width / p_height;
@@ -341,93 +371,47 @@ fn render_single_page_to_ctx(
 		area_h / p_height
 	};
 
-	let surface_width = p_width * scale_factor;
+	let surface_w = p_width * scale_factor;
-	let surface_height = p_height * scale_factor;
+	let surface_h = p_height * scale_factor;
 
-	let surface = cairo::ImageSurface::create(
+	let colorspace = Colorspace::device_rgb();
-		Format::Rgb16_565,
+	let matrix = Matrix::new_scale(scale_factor, scale_factor);
-		// No matter how big you make these arguments, the image will be drawn at the same
-		// size. So if you make them really big, the image will be drawn on a quarter of it. If
-		// you make them really small, the image will cover more than all of the surface.
-		//
-		// However, that only stands as long as you don't scale the context that you place this
-		// surface into. If you scale the dimensions of this image by n, then scale the context
-		// by that same amount, then it'll still fit perfectly into the context, but be
-		// rendered at higher quality.
-		surface_width as i32,
-		surface_height as i32
-	)
-	.map_err(|e| format!("Couldn't create ImageSurface: {e}"))?;
-	surface.set_device_scale(scale_factor, scale_factor);
 
-	let ctx = Context::new(surface).map_err(|e| format!("Couldn't create Context: {e}"))?;
+	let mut pixmap = page.to_pixmap(&matrix, &colorspace, 0.0, false)?;
 
-	// The default background color of PDFs (at least, I think) is white, so we need to set
+	let (x_res, y_res) = pixmap.resolution();
-	// that as the background color, then paint, then render.
+	let new_x = (x_res as f32 * scale_factor) as i32;
-	ctx.set_source_rgba(1.0, 1.0, 1.0, 1.0);
+	let new_y = (y_res as f32 * scale_factor) as i32;
+	pixmap.set_resolution(new_x, new_y);
 
-	ctx.set_antialias(Antialias::None);
+	let result_rects = result_rects
-	ctx.paint()
+		.into_iter()
-		.map_err(|e| format!("Couldn't paint Context: {e}"))?;
+		.map(|quad| {
-	page.render(&ctx);
+			let ul_x = (quad.ul.x * scale_factor) as u32;
-
+			let ul_y = (quad.ul.y * scale_factor) as u32;
-	let num_results = result_rects.len();
+			let lr_x = (quad.lr.x * scale_factor) as u32;
-
+			let lr_y = (quad.lr.y * scale_factor) as u32;
-	if !result_rects.is_empty() {
+			HighlightRect {
-		let mut highlight_color = Color::new();
+				ul_x,
-		highlight_color.set_red((u16::MAX / 5) * 4);
+				ul_y,
-		highlight_color.set_green((u16::MAX / 5) * 4);
+				lr_x,
-
+				lr_y
-		let mut old_rect = Rectangle::new();
-		for rect in &mut result_rects {
-			// According to https://gitlab.freedesktop.org/poppler/poppler/-/issues/763, these rects
-			// need to be corrected since they use different references as the y-coordinate base
-			rect.set_y1(p_height - rect.y1());
-			rect.set_y2(p_height - rect.y2());
-
-			page.render_selection(
-				&ctx,
-				rect,
-				&mut old_rect,
-				SelectionStyle::Glyph,
-				&mut Color::new(),
-				&mut highlight_color
-			);
-		}
 			}
+		})
+		.collect::<Vec<_>>();
 
 	Ok(Some(RenderedContext {
-		surface: ctx.target(),
+		pixmap,
-		num_results,
+		surface_w,
-		surface_width,
+		surface_h,
-		surface_height
+		result_rects
 	}))
 }
 
-fn render_ctx_to_png(
+#[derive(Clone)]
-	ctx: &RenderedContext,
+pub struct HighlightRect {
-	sender: &mut Sender<Result<RenderInfo, RenderError>>,
+	pub ul_x: u32,
-	(col_w, col_h): (u16, u16),
+	pub ul_y: u32,
-	page: usize
+	pub lr_x: u32,
-) -> Result<(), SendError<Result<RenderInfo, RenderError>>> {
+	pub lr_y: u32
-	let mut img_data = Vec::with_capacity((ctx.surface_height * ctx.surface_width) as usize);
-
-	match ctx.surface.write_to_png(&mut img_data) {
-		Err(e) => sender.send(Err(RenderError::Render(format!(
-			"Couldn't write surface to png: {e}"
-		)))),
-		Ok(()) => sender.send(Ok(RenderInfo::Page(PageInfo {
-			img_data: ImageData {
-				data: img_data,
-				area: Rect {
-					width: ctx.surface_width as u16 / col_w,
-					height: ctx.surface_height as u16 / col_h,
-					x: 0,
-					y: 0
-				}
-			},
-			page,
-			search_results: ctx.num_results
-		})))
-	}
 }

src/tui.rs

@@ -1,9 +1,16 @@
-use std::{io::stdout, num::NonZeroUsize, rc::Rc};
+use std::{borrow::Cow, io::stdout, num::NonZeroUsize, rc::Rc};
 
 use crossterm::{
-	event::{Event, KeyCode, MouseEventKind},
+	event::{Event, KeyCode, KeyModifiers, MouseEventKind},
 	execute,
-	terminal::BeginSynchronizedUpdate
+	terminal::{
+		disable_raw_mode, enable_raw_mode, BeginSynchronizedUpdate, EnterAlternateScreen,
+		LeaveAlternateScreen
+	}
+};
+use nix::{
+	sys::signal::{kill, Signal::SIGSTOP},
+	unistd::Pid
 };
 use ratatui::{
 	layout::{Constraint, Flex, Layout, Rect},
@@ -43,7 +50,8 @@ pub enum BottomMessage {
 	Help,
 	SearchResults(String),
 	Error(String),
-	Input(InputCommand)
+	Input(InputCommand),
+	Reloaded
 }
 
 pub enum InputCommand {
@@ -152,18 +160,18 @@ impl Tui {
 		let rendered_span = Span::styled(&rendered_str, Style::new().fg(Color::Cyan));
 		frame.render_widget(rendered_span, bottom_layout[1]);
 
-		let (msg_str, color) = match self.bottom_msg {
+		let (msg_str, color): (Cow<'_, str>, _) = match self.bottom_msg {
 			BottomMessage::Help => (
-				"/: Search, g: Go To Page, n: Next Search Result, N: Previous Search Result"
+				"/: Search, g: Go To Page, n: Next Search Result, N: Previous Search Result".into(),
-					.to_string(),
 				Color::Blue
 			),
-			BottomMessage::Error(ref e) => (format!("Couldn't render a page: {e}"), Color::Red),
+			BottomMessage::Error(ref e) => (e.as_str().into(), Color::Red),
 			BottomMessage::Input(ref input_state) => (
 				match input_state {
 					InputCommand::GoToPage(page) => format!("Go to: {page}"),
 					InputCommand::Search(s) => format!("Search: {s}")
-				},
+				}
+				.into(),
 				Color::Blue
 			),
 			BottomMessage::SearchResults(ref term) => {
@@ -181,10 +189,12 @@ impl Tui {
 					format!(
 						"Results for '{term}': {num_found} (searched: {}%)",
 						num_searched / self.rendered.len()
-					),
+					)
+					.into(),
 					Color::Blue
 				)
 			}
+			BottomMessage::Reloaded => ("Document was reloaded!".into(), Color::Blue)
 		};
 
 		let span = Span::styled(msg_str, Style::new().fg(color));
@@ -269,7 +279,7 @@ impl Tui {
 
 	fn render_single_page(&mut self, frame: &mut Frame<'_>, page_idx: usize, img_area: Rect) {
 		match self.rendered[page_idx].img {
-			Some(ref page_img) => frame.render_widget(Image::new(page_img), img_area),
+			Some(ref mut page_img) => frame.render_widget(Image::new(page_img), img_area),
 			None => Self::render_loading_in(frame, img_area)
 		};
 	}
@@ -370,12 +380,16 @@ impl Tui {
 				match key.code {
 					KeyCode::Char(c) => {
 						// TODO: refactor back to `if let` arm guards when those are stabilized
-						if let BottomMessage::Input(InputCommand::Search(ref mut term)) = self.bottom_msg {
+						if let BottomMessage::Input(InputCommand::Search(ref mut term)) =
+							self.bottom_msg
+						{
 							term.push(c);
 							return Some(InputAction::Redraw);
 						}
 
-						if let BottomMessage::Input(InputCommand::GoToPage(ref mut page)) = self.bottom_msg {
+						if let BottomMessage::Input(InputCommand::GoToPage(ref mut page)) =
+							self.bottom_msg
+						{
 							return c.to_digit(10).map(|input_num| {
 								*page = (*page * 10) + input_num as usize;
 								InputAction::Redraw
@@ -389,13 +403,15 @@ impl Tui {
 							'k' => self.change_page(PageChange::Prev, ChangeAmount::WholeScreen),
 							'q' => Some(InputAction::QuitApp),
 							'g' => {
-								self.set_bottom_msg(Some(BottomMessage::Input(InputCommand::GoToPage(0))));
+								self.set_msg(MessageSetting::Some(BottomMessage::Input(
+									InputCommand::GoToPage(0)
+								)));
 								Some(InputAction::Redraw)
 							}
 							'/' => {
-								self.set_bottom_msg(Some(BottomMessage::Input(InputCommand::Search(
+								self.set_msg(MessageSetting::Some(BottomMessage::Input(
-									String::new()
+									InputCommand::Search(String::new())
-								))));
+								)));
 								Some(InputAction::Redraw)
 							}
 							'n' if self.page < self.rendered.len() - 1 => {
@@ -424,49 +440,85 @@ impl Tui {
 									});
 
 								jump_to_page(&mut self.page, &mut self.last_render.rect, prev_page)
-							},
+							}
+							'z' if key.modifiers.contains(KeyModifiers::CONTROL) => {
+								// [todo] better error handling here?
+
+								let mut backend = stdout();
+								execute!(
+									&mut backend,
+									LeaveAlternateScreen,
+									crossterm::cursor::Show
+								)
+								.unwrap();
+								disable_raw_mode().unwrap();
+
+								// This process will hang after the SIGSTOP call until we get
+								// foregrounded again by something else, at which point we need to
+								// re-setup everything so that it all gets drawn again.
+								kill(Pid::this(), SIGSTOP).unwrap();
+
+								enable_raw_mode().unwrap();
+								execute!(
+									&mut backend,
+									EnterAlternateScreen,
+									crossterm::cursor::Hide
+								)
+								.unwrap();
+
+								self.last_render.rect = Rect::default();
+								Some(InputAction::Redraw)
+							}
 							_ => None
 						}
-					},
+					}
 					KeyCode::Backspace => {
-						if let BottomMessage::Input(InputCommand::Search(ref mut term)) = self.bottom_msg {
+						if let BottomMessage::Input(InputCommand::Search(ref mut term)) =
+							self.bottom_msg
+						{
 							term.pop();
 							return Some(InputAction::Redraw);
 						}
 						None
-					},
+					}
 					KeyCode::Right => self.change_page(PageChange::Next, ChangeAmount::Single),
 					KeyCode::Down => self.change_page(PageChange::Next, ChangeAmount::WholeScreen),
 					KeyCode::Left => self.change_page(PageChange::Prev, ChangeAmount::Single),
 					KeyCode::Up => self.change_page(PageChange::Prev, ChangeAmount::WholeScreen),
 					KeyCode::Esc => match self.bottom_msg {
-						BottomMessage::Input(_) => {
+						BottomMessage::Help => Some(InputAction::QuitApp),
-							self.set_bottom_msg(None);
+						_ => {
+							// When we hit escape, we just want to pop off the current message and
+							// show the underlying one.
+							self.set_msg(MessageSetting::Pop);
 							Some(InputAction::Redraw)
 						}
-						_ => Some(InputAction::QuitApp)
 					},
 					KeyCode::Enter => {
-						let BottomMessage::Input(_) = self.bottom_msg else {
+						let mut default = BottomMessage::default();
+						std::mem::swap(&mut self.bottom_msg, &mut default);
+						let BottomMessage::Input(ref cmd) = default else {
+							std::mem::swap(&mut self.bottom_msg, &mut default);
 							return None;
 						};
 
-						self.set_bottom_msg(None);
-						let Some(BottomMessage::Input(ref cmd)) = self.prev_msg else {
-							// We need to verify it's an input msg currently, and only then take it
-							// and replace it by a default Help message. Don't exactly know how to
-							// do this otherwise.
-							unreachable!();
-						};
-
 						match cmd {
 							// Only forward the command if it's within range
 							InputCommand::GoToPage(page) => {
-								let page = *page;
+								// We need to subtract 1 b/c they're tracked internally as
-								(page < self.rendered.len()).then(|| {
+								// 0-indexed but input and displayed as 1-indexed
-									self.set_page(page);
+								let zero_page = page.saturating_sub(1);
-									InputAction::JumpingToPage(page)
+								let rendered_len = self.rendered.len();
-								})
+
+								if zero_page < rendered_len {
+									self.set_page(zero_page);
+									Some(InputAction::JumpingToPage(zero_page))
+								} else {
+									self.set_msg(MessageSetting::Some(BottomMessage::Error(
+										format!("Cannot jump to page {page}; there are only {rendered_len} pages in the document")
+									)));
+									Some(InputAction::Redraw)
+								}
 							}
 							InputCommand::Search(term) => {
 								let term = term.clone();
@@ -474,14 +526,14 @@ impl Tui {
 								// We only want to show search results if there would actually be
 								// data to show
 								if !term.is_empty() {
-									self.set_bottom_msg(Some(BottomMessage::SearchResults(
+									self.set_msg(MessageSetting::Some(
-										term.clone()
+										BottomMessage::SearchResults(term.clone())
-									)));
+									));
 								} else {
 									// else, if it's not empty, we just want to reset the bottom
 									// area to show the default data; we don't want it to like show
 									// the data from a previous search
-									self.set_bottom_msg(Some(BottomMessage::Help));
+									self.set_msg(MessageSetting::Reset);
 								}
 
 								// Reset all the search results
@@ -515,10 +567,10 @@ impl Tui {
 	}
 
 	pub fn show_error(&mut self, err: RenderError) {
-		self.set_bottom_msg(Some(BottomMessage::Error(match err {
+		self.set_msg(MessageSetting::Some(BottomMessage::Error(match err {
 			RenderError::Notify(e) => format!("Auto-reload failed: {e}"),
-			RenderError::Doc(e) => format!("Couldn't open document: {e}"),
+			RenderError::Doc(e) => format!("Couldn't process document: {e}"),
-			RenderError::Render(e) => format!("Couldn't render page: {e}")
+			RenderError::Converting(e) => format!("Couldn't convert page after rendering: {e}")
 		})));
 	}
 
@@ -532,17 +584,18 @@ impl Tui {
 
 	// We have `msg` as optional so that if they reset it to none, it'll replace it with
 	// `prev_msg`, but if they reset it to something else, it'll put the current thing in prev_msg
-	pub fn set_bottom_msg(&mut self, msg: Option<BottomMessage>) {
+	pub fn set_msg(&mut self, msg: MessageSetting) {
 		match msg {
-			Some(mut msg) => {
+			MessageSetting::Some(mut msg) => {
 				std::mem::swap(&mut self.bottom_msg, &mut msg);
 				self.prev_msg = Some(msg);
 			}
-			None => {
+			MessageSetting::Default => self.set_msg(MessageSetting::Some(BottomMessage::default())),
-				let mut new_bottom = self.prev_msg.take().unwrap_or_default();
+			MessageSetting::Reset => {
-				std::mem::swap(&mut self.bottom_msg, &mut new_bottom);
+				self.prev_msg = None;
-				self.prev_msg = Some(new_bottom);
+				self.bottom_msg = BottomMessage::default();
 			}
+			MessageSetting::Pop => self.bottom_msg = self.prev_msg.take().unwrap_or_default()
 		}
 	}
 }
@@ -565,3 +618,10 @@ enum ChangeAmount {
 	WholeScreen,
 	Single
 }
+
+pub enum MessageSetting {
+	Some(BottomMessage),
+	Default,
+	Reset,
+	Pop
+}