Compare commits

..

7 Commits

Author SHA1 Message Date
itsjunetime b531d352fd Build *with* boost? 2024-11-20 09:25:48 -07:00
itsjunetime 4f04c39120 Maybe more apt installs will get CI to work 2024-11-20 09:17:59 -07:00
itsjunetime b1a77d6178 Go back down to 23_7 poppler? 2024-11-20 09:09:35 -07:00
itsjunetime cd0356a25b Build with poppler 23.10 instead of .12 to maybe prevent segfault in CI 2024-11-20 09:05:17 -07:00
itsjunetime 5465724062 Install libunwind-dev to get perftools installing 2024-11-19 21:43:19 -07:00
itsjunetime 7d9c398742 Install perftools to get criterion compiling 2024-11-19 21:41:44 -07:00
itsjunetime 73cd8ff480 - Update deps
- Explicitly run benches in CI, specifically only adobe_example pdf to make it quicker
- Render bottom message from Cow to avoid extra allocations
- Fix issue with hitting esc after jumping around pdf
2024-11-19 21:32:03 -07:00
21 changed files with 1820 additions and 4586 deletions
+24 -10
View File
@@ -17,7 +17,7 @@ jobs:
steps: steps:
- name: Setup sccache - name: Setup sccache
if: github.event_name != 'release' && github.event_name != 'workflow_dispatch' if: github.event_name != 'release' && github.event_name != 'workflow_dispatch'
uses: mozilla-actions/sccache-action@v0.0.8 uses: mozilla-actions/sccache-action@v0.0.6
- name: Configure sccache - name: Configure sccache
if: github.event_name != 'release' && github.event_name != 'workflow_dispatch' if: github.event_name != 'release' && github.event_name != 'workflow_dispatch'
run: | run: |
@@ -26,17 +26,31 @@ jobs:
- name: Install build dependencies - name: Install build dependencies
run: | run: |
sudo apt-get update sudo apt-get update
sudo apt-get install -y libfontconfig1-dev libgoogle-perftools-dev google-perftools sudo apt-get install -y cmake libjpeg-dev libfontconfig1-dev libopenjp2-7-dev libopenjpip7 libopenjp2-7 libglib2.0-dev libnss3-dev libunwind-dev libgoogle-perftools-dev libboost-dev
- name: Build newer poppler
run: |
wget https://poppler.freedesktop.org/poppler-23.10.0.tar.xz
tar xf poppler-23.10.0.tar.xz
cd poppler-23.10.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_SPLASH=OFF \
-DENABLE_LIBCURL=OFF
make -j$(nproc)
sudo make install
sudo ldconfig
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- name: Install clippy and fmt
run: rustup component add clippy rustfmt
- name: Clippy - name: Clippy
run: cargo clippy --locked -- -D warnings run: cargo clippy -- -D warnings
- name: Tests
run: cargo test --locked
- name: Check fmt - name: Check fmt
run: cargo fmt -- --check run: cargo fmt -- --check
- name: Run benchmarks as tests - name: Run tests
run: cargo test --locked --benches -- adobe_example run: cargo test --benches -- adobe_example
- name: Build - name: Build
run: cargo build --locked run: cargo build
-1
View File
@@ -1,2 +1 @@
/target /target
debug.log
+1 -35
View File
@@ -1,46 +1,12 @@
# Unreleased # Unreleased
- Allow using ctrl+scroll to zoom in/out while zoomed using kitty backend
# v0.4.2
- Add `--version` flag
- Fix shms not working on macos ([#93](https://github.com/itsjunetime/tdf/pull/93))
# v0.4.1
- Add instructions for using new zoom/pan features to help page
# v0.4.0
- Update to new `kittage` backend for kitty-protocol-supporting terminals (fixes many issues and improves performance significantly, see [the PR](https://github.com/itsjunetime/tdf/pull/74))
- Use new mupdf search API for slightly better performance
- Update ratatui(-image) dependencies
- Allow specification of default white and black colors for rendered pdfs
- Pause rendering every once in a while while there's a search term to enable searching across the entire document more quickly
- Fix an issue with missing search highlights
# v0.3.0
- Update ratatui(-image) dependencies
- Enable Ctrl+Z/Suspend functionality
- Rewrite with mupdf as the backend for much better performance and rendering quality
- Support easy inversion of colors via `i` keypress
- Support for filling all available space with `f` keypress
- Change help text at bottom into full help page
# v0.2.0
- Add `--r-to-l` flag to support displaying pdfs that read from right to left - 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 - 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 - Small internal changes to accomodate a few more clippy lints
- Update `ratatui` and `ratatui-image` git dependencies to latest upstream - Update `ratatui` and `ratatui-image` git dependencies to latest upstream
- Move `ratatui-image/vb64` support under `nightly` feature, enabled by default - 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 - 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)) - Added CI
- 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 # v0.1.0
Generated
+719 -1831
View File
File diff suppressed because it is too large Load Diff
+16 -28
View File
@@ -1,56 +1,45 @@
[package] [package]
name = "tdf-viewer" name = "tdf"
version = "0.4.2" version = "0.1.0"
authors = ["June Welker <junewelker@gmail.com>"] authors = ["June Welker <junewelker@gmail.com>"]
edition = "2024" edition = "2021"
description = "A terminal viewer for PDFs" description = "A terminal viewer for PDFs"
readme = "README.md" readme = "README.md"
homepage = "https://github.com/itsjunetime/tdf" homepage = "https://github.com/itsjunetime/tdf"
repository = "https://github.com/itsjunetime/tdf" repository = "https://github.com/itsjunetime/tdf"
license = "AGPL-3.0-only" license = "MPL-2.0"
keywords = ["pdf", "tui", "cli", "terminal"] keywords = ["pdf", "tui", "cli", "terminal"]
categories = ["command-line-utilities", "text-processing", "visualization"] categories = ["command-line-utilities", "text-processing", "visualization"]
default-run = "tdf" default-run = "tdf"
rust-version = "1.86"
[[bin]] [[bin]]
name = "tdf" name = "tdf"
path = "src/main.rs"
# lib only exists for benching # lib only exists for benching
[lib] [lib]
name = "tdf" name = "tdf"
[dependencies] [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 # 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 = { git = "https://github.com/itsjunetime/ratatui.git" }
# ratatui = { path = "./ratatui/ratatui/" } # 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 `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 Box<dyn ratatui_image::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 = { git = "https://github.com/itsjunetime/ratatui-image.git", branch = "vb64_on_personal", default-features = false }
# ratatui-image = { path = "./ratatui-image", default-features = false } # ratatui-image = { path = "./ratatui-image", features = ["vb64"], default-features = false }
crossterm = { version = "0.29.0", features = ["event-stream"] } crossterm = { version = "0.28.1", features = ["event-stream"] }
# crossterm = { path = "../crossterm", features = ["event-stream"] } image = { version = "0.25.1", features = ["png", "rayon"], default-features = false }
image = { version = "0.25.1", features = ["pnm", "rayon", "png"], 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"] } tokio = { version = "1.37.0", features = ["rt-multi-thread", "macros"] }
futures-util = { version = "0.3.30", default-features = false } futures-util = { version = "0.3.30", default-features = false }
glib = "0.20.0"
itertools = "*"
flume = { version = "0.11.0", default-features = false, features = ["async"] } flume = { version = "0.11.0", default-features = false, features = ["async"] }
xflags = "0.4.0-pre.2" xflags = "0.4.0-pre.2"
mimalloc = "0.1.43"
nix = { version = "0.30.0", features = ["signal"] }
mupdf = { git = "https://github.com/messense/mupdf-rs.git", rev = "2e0fae910fac8048c7008211fc4d3b9f5d227a07", default-features = false, features = ["svg", "system-fonts", "img"] }
rayon = { version = "*", default-features = false }
# kittage = { path = "../kittage/", features = ["crossterm-tokio", "image-crate", "log"] }
kittage = { git = "https://github.com/itsjunetime/kittage.git", features = ["crossterm-tokio", "image-crate", "log"] }
memmap2 = "*"
# logging
log = "0.4.27"
flexi_logger = "0.31"
# for tracing with tokio-console # for tracing with tokio-console
console-subscriber = { version = "0.4.0", optional = true } console-subscriber = { version = "0.4.0", optional = true }
csscolorparser = { version = "0.7.0" }
[profile.production] [profile.production]
inherits = "release" inherits = "release"
@@ -60,11 +49,9 @@ lto = "fat"
default = ["nightly"] default = ["nightly"]
nightly = ["ratatui-image/vb64"] nightly = ["ratatui-image/vb64"]
tracing = ["tokio/tracing", "dep:console-subscriber"] tracing = ["tokio/tracing", "dep:console-subscriber"]
epub = ["mupdf/epub"]
cbz = ["mupdf/cbz"]
[dev-dependencies] [dev-dependencies]
criterion = { version = "0.7.0", features = ["async_tokio"] } criterion = { version = "0.5.1", features = ["async_tokio"] }
cpuprofiler = "0.0.4" cpuprofiler = "0.0.4"
[[bench]] [[bench]]
@@ -120,6 +107,7 @@ manual_ok_or = "warn"
manual_string_new = "warn" manual_string_new = "warn"
many_single_char_names = "warn" many_single_char_names = "warn"
manual_unwrap_or = "warn" manual_unwrap_or = "warn"
match_on_vec_items = "warn"
match_same_arms = "warn" match_same_arms = "warn"
match_wildcard_for_single_variants = "warn" match_wildcard_for_single_variants = "warn"
maybe_infinite_iter = "warn" maybe_infinite_iter = "warn"
+373 -661
View File
File diff suppressed because it is too large Load Diff
+2 -11
View File
@@ -13,21 +13,14 @@ Designed to be performant, very responsive, and work well with even very large P
- Responsive details about rendering/search progress - Responsive details about rendering/search progress
- Reactive layout - Reactive layout
## Installation
1. Get the rust toolchain from [rustup.rs](https://rustup.rs)
2. Run `rustup install nightly && cargo +nightly install --git https://github.com/itsjunetime/tdf.git`
## To Build ## To Build
First, you need to install the system dependencies. This will generally only include `libfontconfig` and `clang`. If you're on linux, these will probably show up in your package manager as something like `libfontconfig1-devel` or `libfontconfig-dev` and just `clang`. 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`.
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: 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:
1. Get the rust toolchain from [rustup.rs](https://rustup.rs) 1. Get the rust toolchain from [rustup.rs](https://rustup.rs)
2. Clone the repo and `cd` into it 2. Clone the repo and `cd` into it
3. Run `cargo +nightly build --release` 3. Run `cargo build --release`
The binary should then be found at `./target/release/tdf`.
## Why in the world would you use this? ## Why in the world would you use this?
@@ -36,5 +29,3 @@ I dunno. Just for fun, mostly.
## Can I contribute? ## Can I contribute?
Yeah, sure. Please do. Yeah, sure. Please do.
Please note, though, that all contributions will be treated as licensed under MPL-2.0.
+1 -4
View File
@@ -1,8 +1,5 @@
mod utils; mod utils;
const BLACK: i32 = 0;
const WHITE: i32 = i32::from_be_bytes([0, 0xff, 0xff, 0xff]);
#[tokio::main] #[tokio::main]
async fn main() { async fn main() {
#[cfg(feature = "tracing")] #[cfg(feature = "tracing")]
@@ -12,5 +9,5 @@ async fn main() {
.nth(1) .nth(1)
.expect("Please enter a file to profile"); .expect("Please enter a file to profile");
utils::render_doc(file, None, BLACK, WHITE).await; utils::render_doc(file).await;
} }
+17 -47
View File
@@ -6,15 +6,15 @@ use std::{
time::{SystemTime, UNIX_EPOCH} time::{SystemTime, UNIX_EPOCH}
}; };
use criterion::{BenchmarkId, Criterion, criterion_group, criterion_main, profiler::Profiler}; use criterion::{criterion_group, criterion_main, profiler::Profiler, BenchmarkId, Criterion};
use futures_util::StreamExt; use futures_util::StreamExt;
use tdf::{ use tdf::{
converter::{ConvertedPage, ConverterMsg}, converter::{ConvertedPage, ConverterMsg},
renderer::{PageInfo, RenderInfo, fill_default} renderer::{fill_default, PageInfo, RenderInfo}
}; };
use utils::{ use utils::{
RenderState, handle_converter_msg, handle_renderer_msg, render_doc, start_all_rendering, handle_converter_msg, handle_renderer_msg, render_doc, start_all_rendering,
start_converting_loop, start_rendering_loop start_converting_loop, start_rendering_loop, RenderState
}; };
const FILES: [&str; 3] = [ const FILES: [&str; 3] = [
@@ -23,14 +23,11 @@ const FILES: [&str; 3] = [
"benches/geotopo.pdf" "benches/geotopo.pdf"
]; ];
const BLACK: i32 = 0;
const WHITE: i32 = i32::from_be_bytes([0, 0xff, 0xff, 0xff]);
fn render_full(c: &mut Criterion) { fn render_full(c: &mut Criterion) {
for file in FILES { for file in FILES {
c.bench_with_input(BenchmarkId::new("render_full", file), &file, |b, &file| { c.bench_with_input(BenchmarkId::new("render_full", file), &file, |b, &file| {
b.to_async(tokio::runtime::Runtime::new().unwrap()) b.to_async(tokio::runtime::Runtime::new().unwrap())
.iter(|| render_doc(file, None, BLACK, WHITE)) .iter(|| render_doc(file))
}); });
} }
} }
@@ -42,7 +39,7 @@ fn render_to_first_page(c: &mut Criterion) {
&file, &file,
|b, &file| { |b, &file| {
b.to_async(tokio::runtime::Runtime::new().unwrap()) b.to_async(tokio::runtime::Runtime::new().unwrap())
.iter(|| render_first_page(file, BLACK, WHITE)) .iter(|| render_first_page(file))
} }
); );
} }
@@ -51,7 +48,7 @@ fn render_to_first_page(c: &mut Criterion) {
fn only_converting(c: &mut Criterion) { fn only_converting(c: &mut Criterion) {
for file in FILES { for file in FILES {
let runtime = tokio::runtime::Runtime::new().unwrap(); let runtime = tokio::runtime::Runtime::new().unwrap();
let all_rendered = runtime.block_on(render_all_files(file, BLACK, WHITE)); let all_rendered = runtime.block_on(render_all_files(file));
c.bench_with_input( c.bench_with_input(
BenchmarkId::new("only_converting", file), BenchmarkId::new("only_converting", file),
@@ -64,43 +61,17 @@ fn only_converting(c: &mut Criterion) {
} }
} }
fn search_short_common(c: &mut Criterion) { pub async fn render_first_page(path: impl AsRef<Path>) {
for file in FILES {
c.bench_with_input(
BenchmarkId::new("search_short_common", file),
&file,
|b, &file| {
b.to_async(tokio::runtime::Runtime::new().unwrap())
.iter(|| render_doc(file, Some("an"), BLACK, WHITE))
}
);
}
}
fn search_long_rare(c: &mut Criterion) {
for file in FILES {
c.bench_with_input(
BenchmarkId::new("search_long_rare", file),
&file,
|b, &file| {
b.to_async(tokio::runtime::Runtime::new().unwrap())
.iter(|| render_doc(file, Some("this is long and rare"), BLACK, WHITE))
}
);
}
}
pub async fn render_first_page(path: impl AsRef<Path>, black: i32, white: i32) {
let RenderState { let RenderState {
mut from_render_rx, mut from_render_rx,
mut from_converter_rx, mut from_converter_rx,
mut pages, mut pages,
mut to_converter_tx, mut to_converter_tx,
to_render_tx to_render_tx
} = start_all_rendering(path, black, white); } = start_all_rendering(path);
// we only want to render until the first page is ready to be printed // we only want to render until the first page is ready to be printed
while pages.iter().all(Option::is_none) { while pages.iter().all(|p| p.is_none()) {
tokio::select! { tokio::select! {
Some(renderer_msg) = from_render_rx.next() => { Some(renderer_msg) = from_render_rx.next() => {
handle_renderer_msg(renderer_msg, &mut pages, &mut to_converter_tx); handle_renderer_msg(renderer_msg, &mut pages, &mut to_converter_tx);
@@ -117,21 +88,20 @@ pub async fn render_first_page(path: impl AsRef<Path>, black: i32, white: i32) {
drop(to_render_tx); drop(to_render_tx);
} }
async fn render_all_files(path: &'static str, black: i32, white: i32) -> Vec<PageInfo> { async fn render_all_files(path: &'static str) -> Vec<PageInfo> {
let (mut from_render_rx, to_render_tx) = start_rendering_loop(path, black, white); let (mut from_render_rx, to_render_tx) = start_rendering_loop(path);
let mut pages = Vec::<Option<PageInfo>>::new(); let mut pages = Vec::<Option<PageInfo>>::new();
while let Some(info) = from_render_rx.next().await { while let Some(info) = from_render_rx.next().await {
match info.expect("Renderer ran into an error while rendering") { match info.expect("Renderer ran into an error while rendering") {
RenderInfo::Reloaded | RenderInfo::SearchResults { .. } => (),
RenderInfo::NumPages(num) => fill_default(&mut pages, num), RenderInfo::NumPages(num) => fill_default(&mut pages, num),
RenderInfo::Page(page) => { RenderInfo::Page(page) => {
let num = page.page_num; let num = page.page;
pages[num] = Some(page); pages[num] = Some(page);
} }
}; };
if pages.iter().all(Option::is_some) { if pages.iter().all(|p| p.is_some()) {
break; break;
} }
} }
@@ -166,7 +136,7 @@ async fn convert_all_files(files: Vec<PageInfo>) {
} }
} }
while converted.iter().any(Option::is_none) { while converted.iter().any(|p| p.is_none()) {
let page = from_converter_rx let page = from_converter_rx
.next() .next()
.await .await
@@ -187,7 +157,7 @@ impl Profiler for CpuProfiler {
fn start_profiling(&mut self, benchmark_id: &str, _: &std::path::Path) { fn start_profiling(&mut self, benchmark_id: &str, _: &std::path::Path) {
let file = format!( let file = format!(
"./{}-{}.profile", "./{}-{}.profile",
benchmark_id.replace('/', "-"), benchmark_id.replace("/", "-"),
SystemTime::now() SystemTime::now()
.duration_since(UNIX_EPOCH) .duration_since(UNIX_EPOCH)
.unwrap() .unwrap()
@@ -204,6 +174,6 @@ impl Profiler for CpuProfiler {
criterion_group!( criterion_group!(
name = benches; name = benches;
config = Criterion::default().sample_size(40).with_profiler(CpuProfiler); config = Criterion::default().sample_size(40).with_profiler(CpuProfiler);
targets = render_full, render_to_first_page, only_converting, search_short_common, search_long_rare targets = render_full, render_to_first_page, only_converting
); );
criterion_main!(benches); criterion_main!(benches);
+16 -41
View File
@@ -1,13 +1,13 @@
use std::{hint::black_box, path::Path}; use std::{hint::black_box, path::Path};
use crossterm::terminal::WindowSize; use crossterm::terminal::WindowSize;
use flume::{Sender, r#async::RecvStream, unbounded}; use flume::{r#async::RecvStream, unbounded, Sender};
use futures_util::stream::StreamExt as _; use futures_util::stream::StreamExt as _;
use ratatui::layout::Rect; use ratatui::layout::Rect;
use ratatui_image::picker::{Picker, ProtocolType}; use ratatui_image::picker::{Picker, ProtocolType};
use tdf::{ use tdf::{
converter::{ConvertedPage, ConverterMsg, run_conversion_loop}, converter::{run_conversion_loop, ConvertedPage, ConverterMsg},
renderer::{RenderError, RenderInfo, RenderNotif, fill_default, start_rendering} renderer::{fill_default, start_rendering, RenderError, RenderInfo, RenderNotif}
}; };
pub fn handle_renderer_msg( pub fn handle_renderer_msg(
@@ -21,8 +21,6 @@ pub fn handle_renderer_msg(
to_converter_tx.send(ConverterMsg::NumPages(num)).unwrap(); to_converter_tx.send(ConverterMsg::NumPages(num)).unwrap();
} }
Ok(RenderInfo::Page(info)) => to_converter_tx.send(ConverterMsg::AddImg(info)).unwrap(), Ok(RenderInfo::Page(info)) => to_converter_tx.send(ConverterMsg::AddImg(info)).unwrap(),
// We can ignore the these variants 'cause they're only used to send info to the TUI
Ok(RenderInfo::Reloaded | RenderInfo::SearchResults { .. }) => (),
Err(e) => panic!("Got error from renderer: {e:?}") Err(e) => panic!("Got error from renderer: {e:?}")
} }
} }
@@ -37,13 +35,13 @@ pub fn handle_converter_msg(
pages[num] = Some(page); pages[num] = Some(page);
let first_none = pages.iter().position(Option::is_none); let num_got = pages.iter().filter(|p| p.is_some()).count();
// we have to tell it to jump to a certain page so that it will actually render it (since // we have to tell it to jump to a certain page so that it will actually render it (since
// it only renders fanning out from the page that we currently have selected) // it only renders fanning out from the page that we currently have selected)
if let Some(first) = first_none { to_converter_tx
to_converter_tx.send(ConverterMsg::GoToPage(first)).unwrap(); .send(ConverterMsg::GoToPage(num_got))
} .unwrap();
} }
pub struct RenderState { pub struct RenderState {
@@ -57,15 +55,13 @@ pub struct RenderState {
const FONT_SIZE: (u16, u16) = (8, 14); const FONT_SIZE: (u16, u16) = (8, 14);
pub fn start_rendering_loop( pub fn start_rendering_loop(
path: impl AsRef<Path>, path: impl AsRef<Path>
black: i32,
white: i32
) -> ( ) -> (
RecvStream<'static, Result<RenderInfo, RenderError>>, RecvStream<'static, Result<RenderInfo, RenderError>>,
Sender<RenderNotif> Sender<RenderNotif>
) { ) {
let pathbuf = path.as_ref().canonicalize().unwrap(); let pathbuf = path.as_ref().canonicalize().unwrap();
let str_path = pathbuf.into_os_string().to_string_lossy().to_string(); let str_path = format!("file://{}", pathbuf.into_os_string().to_string_lossy());
let (to_render_tx, from_main_rx) = unbounded(); let (to_render_tx, from_main_rx) = unbounded();
let (to_main_tx, from_render_rx) = unbounded(); let (to_main_tx, from_render_rx) = unbounded();
@@ -79,6 +75,8 @@ pub fn start_rendering_loop(
width: columns * FONT_SIZE.0 width: columns * FONT_SIZE.0
}; };
std::thread::spawn(move || start_rendering(&str_path, to_main_tx, from_main_rx, size));
let main_area = Rect { let main_area = Rect {
x: 0, x: 0,
y: 0, y: 0,
@@ -87,21 +85,6 @@ pub fn start_rendering_loop(
}; };
to_render_tx.send(RenderNotif::Area(main_area)).unwrap(); to_render_tx.send(RenderNotif::Area(main_area)).unwrap();
let cell_height_px = size.height / size.rows;
let cell_width_px = size.width / size.columns;
std::thread::spawn(move || {
start_rendering(
&str_path,
to_main_tx,
from_main_rx,
cell_height_px,
cell_width_px,
tdf::PrerenderLimit::All,
black,
white
)
});
let from_render_rx = from_render_rx.into_stream(); let from_render_rx = from_render_rx.into_stream();
(from_render_rx, to_render_tx) (from_render_rx, to_render_tx)
} }
@@ -122,17 +105,15 @@ pub fn start_converting_loop(
to_main_tx, to_main_tx,
from_main_rx, from_main_rx,
picker, picker,
prerender, prerender
// just assume shms work for now, who cares
true
)); ));
let from_converter_rx = from_converter_rx.into_stream(); let from_converter_rx = from_converter_rx.into_stream();
(from_converter_rx, to_converter_tx) (from_converter_rx, to_converter_tx)
} }
pub fn start_all_rendering(path: impl AsRef<Path>, black: i32, white: i32) -> RenderState { pub fn start_all_rendering(path: impl AsRef<Path>) -> RenderState {
let (from_render_rx, to_render_tx) = start_rendering_loop(path, black, white); let (from_render_rx, to_render_tx) = start_rendering_loop(path);
let (from_converter_rx, to_converter_tx) = start_converting_loop(20); let (from_converter_rx, to_converter_tx) = start_converting_loop(20);
let pages: Vec<Option<ConvertedPage>> = Vec::new(); let pages: Vec<Option<ConvertedPage>> = Vec::new();
@@ -146,20 +127,14 @@ pub fn start_all_rendering(path: impl AsRef<Path>, black: i32, white: i32) -> Re
} }
} }
pub async fn render_doc(path: impl AsRef<Path>, search_term: Option<&str>, black: i32, white: i32) { pub async fn render_doc(path: impl AsRef<Path>) {
let RenderState { let RenderState {
mut from_render_rx, mut from_render_rx,
mut from_converter_rx, mut from_converter_rx,
mut pages, mut pages,
mut to_converter_tx, mut to_converter_tx,
to_render_tx to_render_tx
} = start_all_rendering(path, black, white); } = start_all_rendering(path);
if let Some(term) = search_term {
to_render_tx
.send(RenderNotif::Search(term.to_owned()))
.unwrap();
}
while pages.is_empty() || pages.iter().any(Option::is_none) { while pages.is_empty() || pages.iter().any(Option::is_none) {
tokio::select! { tokio::select! {
BIN
View File
Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.4 MiB

After

Width:  |  Height:  |  Size: 1.4 MiB

+1 -1
Submodule ratatui updated: 47c200fb7f...8bf0c1ef77
+13
View File
@@ -0,0 +1,13 @@
#!/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 --
+33 -142
View File
@@ -1,59 +1,13 @@
use std::{
num::{NonZeroU32, NonZeroUsize},
time::{SystemTime, UNIX_EPOCH}
};
use flume::{Receiver, SendError, Sender, TryRecvError}; use flume::{Receiver, SendError, Sender, TryRecvError};
use futures_util::stream::StreamExt; use futures_util::stream::StreamExt;
use image::DynamicImage; use image::ImageFormat;
use kittage::NumberOrId; use itertools::Itertools;
use ratatui::layout::Rect; use ratatui_image::{picker::Picker, protocol::Protocol, Resize};
use ratatui_image::{
Resize,
picker::{Picker, ProtocolType},
protocol::Protocol
};
use rayon::iter::ParallelIterator;
use crate::{ use crate::renderer::{fill_default, PageInfo, RenderError};
renderer::{PageInfo, RenderError, fill_default},
skip::InterleavedAroundWithMax
};
#[derive(Debug)]
pub enum MaybeTransferred {
NotYet(kittage::image::Image<'static>),
Transferred(kittage::ImageId)
}
#[derive(Debug)]
pub enum ConvertedImage {
Generic(Protocol),
Kitty {
img: MaybeTransferred,
cell_w: u16,
cell_h: u16
}
}
impl ConvertedImage {
pub fn w_h(&self) -> (u16, u16) {
match self {
Self::Generic(prot) => {
let a = prot.area();
(a.width, a.height)
}
Self::Kitty {
img: _,
cell_w,
cell_h
} => (*cell_w, *cell_h)
}
}
}
pub struct ConvertedPage { pub struct ConvertedPage {
pub page: ConvertedImage, pub page: Protocol,
pub num: usize, pub num: usize,
pub num_results: usize pub num_results: usize
} }
@@ -68,21 +22,17 @@ pub async fn run_conversion_loop(
sender: Sender<Result<ConvertedPage, RenderError>>, sender: Sender<Result<ConvertedPage, RenderError>>,
receiver: Receiver<ConverterMsg>, receiver: Receiver<ConverterMsg>,
mut picker: Picker, mut picker: Picker,
prerender: usize, prerender: usize
shms_work: bool
) -> Result<(), SendError<Result<ConvertedPage, RenderError>>> { ) -> Result<(), SendError<Result<ConvertedPage, RenderError>>> {
let mut images = vec![]; let mut images = vec![];
let mut page: usize = 0; let mut page: usize = 0;
let pid = std::process::id();
fn next_page( fn next_page(
images: &mut [Option<PageInfo>], images: &mut [Option<PageInfo>],
picker: &mut Picker, picker: &mut Picker,
page: usize, page: usize,
iteration: &mut usize, iteration: &mut usize,
prerender: usize, prerender: usize
pid: u32,
shms_work: bool
) -> Result<Option<ConvertedPage>, RenderError> { ) -> Result<Option<ConvertedPage>, RenderError> {
if images.is_empty() || *iteration >= prerender { if images.is_empty() || *iteration >= prerender {
return Ok(None); return Ok(None);
@@ -93,102 +43,51 @@ pub async fn run_conversion_loop(
let idx_start = page.saturating_sub(prerender / 2); let idx_start = page.saturating_sub(prerender / 2);
let idx_end = idx_start.saturating_add(prerender).min(images.len()); let idx_end = idx_start.saturating_add(prerender).min(images.len());
// If there's none to render, then why bother.
let Some(idx_end) = NonZeroUsize::new(idx_end) else {
return Ok(None);
};
// then we go through all the indices available to us and find the first one that has an // then we go through all the indices available to us and find the first one that has an
// image available to steal // image available to steal
let Some((page_info, new_iter, page_num)) = let Some((page_info, new_iter)) = (idx_start..page)
InterleavedAroundWithMax::new(page, idx_start, idx_end) .interleave(page..idx_end)
.enumerate() .enumerate()
.take(prerender) .skip(*iteration)
// .skip(*iteration) .find_map(|(i_idx, p_idx)| images[p_idx].take().map(|p| (p, i_idx)))
.find_map(|(i_idx, p_idx)| images[p_idx].take().map(|p| (p, i_idx, p_idx)))
else { else {
return Ok(None); return Ok(None);
}; };
let mut dyn_img = image::load_from_memory_with_format( let img_area = page_info.img_data.area;
&page_info.img_data.pixels,
image::ImageFormat::Pnm
)
.map_err(|e| RenderError::Converting(format!("Can't load image: {e}")))?;
match dyn_img { let dyn_img =
DynamicImage::ImageRgb8(ref mut img) => image::load_from_memory_with_format(&page_info.img_data.data, ImageFormat::Png)
for quad in &*page_info.result_rects { .map_err(|e| {
img.par_enumerate_pixels_mut() RenderError::Render(format!("Couldn't convert Vec<u8> to DynamicImage: {e}"))
.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 = Rect { // We don't actually want to Crop this image, but we've already
width: page_info.img_data.cell_w, // verified (with the ImageSurface stuff) that the image is the correct
height: page_info.img_data.cell_h, // size for the area given, so to save ratatui the work of having to
x: 0, // resize it, we tell them to crop it to fit.
y: 0 let txt_img = picker
}; .new_protocol(dyn_img, img_area, Resize::None)
.map_err(|e| {
let txt_img = match picker.protocol_type() { RenderError::Render(format!(
ProtocolType::Kitty => { "Couldn't convert DynamicImage to ratatui image: {e}"
let rn = SystemTime::now() ))
.duration_since(UNIX_EPOCH) })?;
.unwrap_or_default()
.as_millis() % 1_000_000;
let mut img = if shms_work {
kittage::image::Image::shm_from(dyn_img, &format!("tdf_{pid}_{rn}_{page_num}"))
.map_err(|e| {
RenderError::Converting(format!("Couldn't write to shm: {e}"))
})?
} else {
kittage::image::Image::from(dyn_img)
};
img.num_or_id = NumberOrId::Id(NonZeroU32::new(page_num as u32 + 1).unwrap());
ConvertedImage::Kitty {
img: MaybeTransferred::NotYet(img),
cell_w: page_info.img_data.cell_w,
cell_h: page_info.img_data.cell_h
}
}
_ => ConvertedImage::Generic(
picker
.new_protocol(dyn_img, img_area, Resize::None)
.map_err(|e| {
RenderError::Converting(format!(
"Couldn't convert DynamicImage to ratatui image: {e}"
))
})?
)
};
log::debug!(
"got converted page for num {} with results {:?}",
page_info.page_num,
page_info.result_rects
);
// update the iteration to the iteration that we stole this image from // update the iteration to the iteration that we stole this image from
*iteration = new_iter; *iteration = new_iter;
Ok(Some(ConvertedPage { Ok(Some(ConvertedPage {
page: txt_img, page: txt_img,
num: page_info.page_num, num: page_info.page,
num_results: page_info.result_rects.len() num_results: page_info.search_results
})) }))
} }
fn handle_notif(msg: ConverterMsg, images: &mut Vec<Option<PageInfo>>, page: &mut usize) { fn handle_notif(msg: ConverterMsg, images: &mut Vec<Option<PageInfo>>, page: &mut usize) {
match msg { match msg {
ConverterMsg::AddImg(img) => { ConverterMsg::AddImg(img) => {
let page_num = img.page_num; let page_num = img.page;
images[page_num] = Some(img); images[page_num] = Some(img);
} }
ConverterMsg::NumPages(n_pages) => { ConverterMsg::NumPages(n_pages) => {
@@ -212,15 +111,7 @@ pub async fn run_conversion_loop(
Err(TryRecvError::Disconnected) => return Ok(()) Err(TryRecvError::Disconnected) => return Ok(())
} }
match next_page( match next_page(&mut images, &mut picker, page, &mut iteration, prerender) {
&mut images,
&mut picker,
page,
&mut iteration,
prerender,
pid,
shms_work
) {
Ok(None) => break, Ok(None) => break,
Ok(Some(img)) => sender.send(Ok(img))?, Ok(Some(img)) => sender.send(Ok(img))?,
Err(e) => sender.send(Err(e))? Err(e) => sender.send(Err(e))?
-209
View File
@@ -1,209 +0,0 @@
use std::{io::Write, num::NonZeroU32};
use crossterm::{
cursor::MoveTo,
event::EventStream,
execute,
terminal::{disable_raw_mode, enable_raw_mode}
};
use image::DynamicImage;
use kittage::{
AsyncInputReader, ImageDimensions, ImageId, NumberOrId, PixelFormat,
action::Action,
delete::{ClearOrDelete, DeleteConfig, WhichToDelete},
display::{CursorMovementPolicy, DisplayConfig, DisplayLocation},
error::TransmitError,
image::Image,
medium::Medium
};
use ratatui::layout::Position;
use crate::converter::MaybeTransferred;
pub struct KittyReadyToDisplay<'tui> {
pub img: &'tui mut MaybeTransferred,
pub page_num: usize,
pub pos: Position,
pub display_loc: DisplayLocation
}
pub enum KittyDisplay<'tui> {
NoChange,
ClearImages,
DisplayImages(Vec<KittyReadyToDisplay<'tui>>)
}
pub struct DbgWriter<W: Write> {
w: W,
#[cfg(debug_assertions)]
buf: String
}
impl<W: Write> Write for DbgWriter<W> {
fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
#[cfg(debug_assertions)]
{
if let Ok(s) = std::str::from_utf8(buf) {
self.buf.push_str(s);
}
}
self.w.write(buf)
}
fn flush(&mut self) -> std::io::Result<()> {
#[cfg(debug_assertions)]
{
log::debug!("Writing to kitty: {:?}", self.buf);
self.buf.clear();
}
self.w.flush()
}
}
pub async fn run_action<'image, 'data, 'es>(
action: Action<'image, 'data>,
ev_stream: &'es mut EventStream
) -> Result<ImageId, TransmitError<<&'es mut EventStream as AsyncInputReader>::Error>> {
let writer = DbgWriter {
w: std::io::stdout().lock(),
#[cfg(debug_assertions)]
buf: String::new()
};
action
.execute_async(writer, ev_stream)
.await
.map(|(_, i)| i)
}
pub async fn do_shms_work(ev_stream: &mut EventStream) -> bool {
let img = DynamicImage::new_rgb8(1, 1);
let pid = std::process::id();
let Ok(mut k_img) = kittage::image::Image::shm_from(img, &format!("tdf_test_{pid}")) else {
return false;
};
// apparently the terminal won't respond to queries unless they have an Id instead of a number
k_img.num_or_id = NumberOrId::Id(NonZeroU32::new(u32::MAX).unwrap());
enable_raw_mode().unwrap();
let res = run_action(Action::Query(&k_img), ev_stream).await;
disable_raw_mode().unwrap();
res.is_ok()
}
pub async fn display_kitty_images<'es>(
display: KittyDisplay<'_>,
ev_stream: &'es mut EventStream
) -> Result<
(),
(
Vec<usize>,
&'static str,
TransmitError<<&'es mut EventStream as AsyncInputReader>::Error>
)
> {
let images = match display {
KittyDisplay::NoChange => return Ok(()),
KittyDisplay::DisplayImages(_) | KittyDisplay::ClearImages => {
run_action(
Action::Delete(DeleteConfig {
effect: ClearOrDelete::Clear,
which: WhichToDelete::All
}),
ev_stream
)
.await
.map_err(|e| (vec![], "Couldn't clear previous images", e))?;
let KittyDisplay::DisplayImages(images) = display else {
return Ok(());
};
images
}
};
let mut err = None;
for KittyReadyToDisplay {
img,
page_num,
pos,
display_loc
} in images
{
let config = DisplayConfig {
location: display_loc,
cursor_movement: CursorMovementPolicy::DontMove,
..DisplayConfig::default()
};
execute!(std::io::stdout(), MoveTo(pos.x, pos.y)).unwrap();
log::debug!("going to display img {img:#?}");
log::debug!("displaying with config {config:#?}");
let this_err = match img {
MaybeTransferred::NotYet(image) => {
let mut fake_image = Image {
num_or_id: image.num_or_id,
format: PixelFormat::Rgb24(
ImageDimensions {
width: 0,
height: 0
},
None
),
medium: Medium::Direct {
chunk_size: None,
data: (&[]).into()
}
};
std::mem::swap(image, &mut fake_image);
let res = run_action(
Action::TransmitAndDisplay {
image: fake_image,
config,
placement_id: None
},
ev_stream
)
.await;
match res {
Ok(img_id) => {
*img = MaybeTransferred::Transferred(img_id);
Ok(())
}
Err(e) => Err((page_num, e))
}
}
MaybeTransferred::Transferred(image_id) => run_action(
Action::Display {
image_id: *image_id,
placement_id: *image_id,
config
},
ev_stream
)
.await
.map(|_| ())
.map_err(|e| (page_num, e))
};
log::debug!("this_err is {this_err:#?}");
if let Err((id, e)) = this_err {
let e = err.get_or_insert_with(|| (vec![], e));
e.0.push(id);
}
}
match err {
Some((replace, e)) => Err((replace, "Couldn't transfer image to the terminal", e)),
None => Ok(())
}
}
-55
View File
@@ -1,59 +1,4 @@
use std::num::NonZeroUsize;
#[global_allocator]
static ALLOC: mimalloc::MiMalloc = mimalloc::MiMalloc;
#[derive(PartialEq)]
pub enum PrerenderLimit {
All,
Limited(NonZeroUsize)
}
pub mod converter; pub mod converter;
pub mod kitty;
pub mod renderer; pub mod renderer;
pub mod skip; pub mod skip;
pub mod tui; pub mod tui;
#[derive(Copy, Clone, PartialEq, Debug)]
pub enum FitOrFill {
Fit,
Fill
}
pub struct ScaledResult {
width: f32,
height: f32,
scale_factor: f32
}
pub fn scale_img_for_area(
(img_width, img_height): (f32, f32),
(area_width, area_height): (f32, f32),
fit_or_fill: FitOrFill
) -> ScaledResult {
// and get its aspect ratio
let img_aspect_ratio = img_width / img_height;
// Then we get the full pixel dimensions of the area provided to us, and the aspect ratio
// of that area
let area_aspect_ratio = area_width / area_height;
// and get the ratio that this page would have to be scaled by to fit perfectly within the
// area provided to us.
// we do this first by comparing the aspec ratio of the page with the aspect ratio of the
// area to fit it within. If the aspect ratio of the page is larger, then we need to scale
// the width of the page to fill perfectly within the height of the area. Otherwise, we
// scale the height to fit perfectly. The dimension that _is not_ scaled to fit perfectly
// is scaled by the same factor as the dimension that _is_ scaled perfectly.
let scale_factor = match (img_aspect_ratio > area_aspect_ratio, fit_or_fill) {
(true, FitOrFill::Fit) | (false, FitOrFill::Fill) => area_width / img_width,
(false, FitOrFill::Fit) | (true, FitOrFill::Fill) => area_height / img_height
};
ScaledResult {
width: img_width * scale_factor,
height: img_height * scale_factor,
scale_factor
}
}
+137 -443
View File
@@ -1,82 +1,44 @@
use core::{
error::Error,
num::{NonZeroU32, NonZeroUsize}
};
use std::{ use std::{
borrow::Cow, io::{stdout, Read, Write},
ffi::OsString, num::NonZeroUsize,
io::{BufReader, Read, Stdout, Write, stdout},
path::PathBuf path::PathBuf
}; };
use converter::{run_conversion_loop, ConvertedPage, ConverterMsg};
use crossterm::{ use crossterm::{
event::EventStream,
execute, execute,
terminal::{ terminal::{
EndSynchronizedUpdate, EnterAlternateScreen, LeaveAlternateScreen, disable_raw_mode, disable_raw_mode, enable_raw_mode, window_size, EndSynchronizedUpdate,
enable_raw_mode, window_size EnterAlternateScreen, LeaveAlternateScreen
} }
}; };
use flexi_logger::FileSpec; use futures_util::{stream::StreamExt, FutureExt};
use flume::{Sender, r#async::RecvStream}; use glib::{LogField, LogLevel, LogWriterOutput};
use futures_util::{FutureExt, stream::StreamExt};
use kittage::{
action::Action,
delete::{ClearOrDelete, DeleteConfig, WhichToDelete},
error::{TerminalError, TransmitError}
};
use notify::{Event, EventKind, RecursiveMode, Watcher}; use notify::{Event, EventKind, RecursiveMode, Watcher};
use ratatui::{Terminal, backend::CrosstermBackend}; use ratatui::{backend::CrosstermBackend, Terminal};
use ratatui_image::{ use ratatui_image::picker::Picker;
FontSize, use renderer::{RenderError, RenderInfo, RenderNotif};
picker::{Picker, ProtocolType} use tui::{InputAction, Tui};
};
use tdf::{ mod converter;
PrerenderLimit, mod renderer;
converter::{ConvertedPage, ConverterMsg, run_conversion_loop}, mod skip;
kitty::{KittyDisplay, display_kitty_images, do_shms_work, run_action}, mod tui;
renderer::{self, RenderError, RenderInfo, RenderNotif},
tui::{BottomMessage, InputAction, MessageSetting, Tui}
};
// Dummy struct for easy errors in main // Dummy struct for easy errors in main
struct WrappedErr(Cow<'static, str>); #[derive(Debug)]
struct BadTermSizeStdin(String);
impl std::fmt::Display for WrappedErr { impl std::fmt::Display for BadTermSizeStdin {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.0) write!(f, "{}", self.0)
} }
} }
impl std::fmt::Debug for WrappedErr { impl std::error::Error for BadTermSizeStdin {}
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
std::fmt::Display::fmt(self, f)
}
}
impl std::error::Error for WrappedErr {}
fn reset_term() {
_ = execute!(
std::io::stdout(),
LeaveAlternateScreen,
crossterm::cursor::Show,
crossterm::event::DisableMouseCapture
)
}
#[tokio::main] #[tokio::main]
async fn main() -> Result<(), WrappedErr> { async fn main() -> Result<(), Box<dyn std::error::Error>> {
inner_main().await.inspect_err(|_| reset_term())
}
async fn inner_main() -> Result<(), WrappedErr> {
let hook = std::panic::take_hook();
std::panic::set_hook(Box::new(move |info| {
reset_term();
hook(info);
}));
#[cfg(feature = "tracing")] #[cfg(feature = "tracing")]
console_subscriber::init(); console_subscriber::init();
@@ -86,289 +48,130 @@ async fn inner_main() -> Result<(), WrappedErr> {
optional -r,--r-to-l r_to_l: bool optional -r,--r-to-l r_to_l: bool
/// The maximum number of pages to display together, horizontally, at a time /// The maximum number of pages to display together, horizontally, at a time
optional -m,--max-wide max_wide: NonZeroUsize optional -m,--max-wide max_wide: NonZeroUsize
/// Fullscreen the pdf (hide document name, page count, etc)
optional -f,--fullscreen fullscreen: bool
/// The number of pages to prerender surrounding the currently-shown page; 0 means no
/// limit. By default, there is no limit.
optional -p,--prerender prerender: usize
/// Custom white color, specified in css format (e.g. "FFFFFF" or "rgb(255, 255, 255)")
optional -w,--white-color white: String
/// Custom black color, specified in css format (e.g "000000" or "rgb(0, 0, 0)")
optional -b,--black-color black: String
/// Print the version and exit
optional --version
/// PDF file to read /// PDF file to read
optional file: PathBuf required file: PathBuf
}; };
if flags.version { let path = flags.file.canonicalize()?;
println!("{}", env!("CARGO_PKG_VERSION"));
return Ok(());
}
let Some(file) = flags.file else {
return Err(WrappedErr(
"Please specify the file to open, e.g. `tdf ./my_example_pdf.pdf`".into()
));
};
let path = file
.canonicalize()
.map_err(|e| WrappedErr(format!("Cannot canonicalize provided file: {e}").into()))?;
let black =
parse_color_to_i32(flags.black_color.as_deref().unwrap_or("000000")).map_err(|e| {
WrappedErr(
format!("Couldn't parse black color: {e} - is it formatted like a CSS color?")
.into()
)
})?;
let white =
parse_color_to_i32(flags.white_color.as_deref().unwrap_or("FFFFFF")).map_err(|e| {
WrappedErr(
format!("Couldn't parse white color: {e} - is it formatted like a CSS color?")
.into()
)
})?;
// need to keep it around throughout the lifetime of the program, but don't rly need to use it.
// Just need to make sure it doesn't get dropped yet.
let mut maybe_logger = None;
if std::env::var("RUST_LOG").is_ok() {
maybe_logger = Some(
flexi_logger::Logger::try_with_env()
.map_err(|e| WrappedErr(format!("Couldn't create initial logger: {e}").into()))?
.log_to_file(FileSpec::try_from("./debug.log").map_err(|e| {
WrappedErr(format!("Couldn't create FileSpec for logger: {e}").into())
})?)
.start()
.map_err(|e| WrappedErr(format!("Can't start logger: {e}").into()))?
);
}
let (watch_to_render_tx, render_rx) = flume::unbounded(); let (watch_to_render_tx, render_rx) = flume::unbounded();
let to_renderer = watch_to_render_tx.clone(); let tui_tx = watch_to_render_tx.clone();
let (render_tx, tui_rx) = flume::unbounded(); let (render_tx, tui_rx) = flume::unbounded();
let watch_to_tui_tx = render_tx.clone(); let watch_to_tui_tx = render_tx.clone();
let mut watcher = notify::recommended_watcher(on_notify_ev( let mut watcher =
watch_to_tui_tx, notify::recommended_watcher(on_notify_ev(watch_to_tui_tx, watch_to_render_tx))?;
watch_to_render_tx,
path.file_name()
.ok_or(WrappedErr("Path does not have a last component??".into()))?
.to_owned()
))
.map_err(|e| WrappedErr(format!("Couldn't start watching the provided file: {e}").into()))?;
// So we have to watch the parent directory of the file that we are interested in because the // We're making this nonrecursive 'cause we're just watching a single file, so there's nothing
// `notify` library works on inodes, and if the file is deleted, that inode is gone as well, // to recurse into
// and then the notify library just gives up on trying to watch for the file reappearing. Imo watcher.watch(&path, RecursiveMode::NonRecursive)?;
// 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
)
.map_err(|e| WrappedErr(format!("Can't watch the provided file: {e}").into()))?;
// TODO: Handle non-utf8 file names? Maybe by constructing a CString and passing that in to the // TODO: Handle non-utf8 file names? Maybe by constructing a CString and passing that in to the
// mupdf stuff instead of a rust string? // poppler stuff instead of a rust string?
let file_path = path.clone().into_os_string().to_string_lossy().to_string(); let file_path = format!("file://{}", path.clone().into_os_string().to_string_lossy());
let mut window_size = window_size().map_err(|e| { let mut window_size = window_size()?;
WrappedErr(format!("Can't get your current terminal window size: {e}").into())
})?;
if window_size.width == 0 || window_size.height == 0 { if window_size.width == 0 || window_size.height == 0 {
let (w, h) = get_font_size_through_stdio()?; // send the command code to get the terminal window size
print!("\x1b[14t");
std::io::stdout().flush()?;
window_size.width = w; // we need to enable raw mode here since this bit of output won't print a newline; it'll
window_size.height = h; // just print the info it wants to tell us. So we want to get all characters as they come
enable_raw_mode()?;
// read in the returned size until we hit a 't' (which indicates to us it's done)
let input_vec = std::io::stdin()
.bytes()
.filter_map(Result::ok)
.take_while(|b| *b != b't')
.collect::<Vec<_>>();
// and then disable raw mode again in case we return an error in this next section
disable_raw_mode()?;
let input_line = String::from_utf8(input_vec)?;
if input_line.starts_with("\x1b[4;") {
// it should input it to us as `\e[4;<height>;<width>t`, so we need to split to get the h/w
// ignore the first val
let mut splits = input_line.split([';', 't']).skip(1);
window_size.height = splits
.next()
.ok_or_else(|| {
BadTermSizeStdin(format!(
"Terminal responded with unparseable size response '{input_line}'"
))
})?
.parse::<u16>()?;
window_size.width = splits
.next()
.ok_or_else(|| {
BadTermSizeStdin(format!(
"Terminal responded with unparseable size response '{input_line}'"
))
})?
.parse::<u16>()?;
} else {
return Err("Your terminal is falsely reporting a window size of 0; tdf needs an accurate window size to display graphics".into());
}
} }
let cell_height_px = window_size.height / window_size.rows;
let cell_width_px = window_size.width / window_size.columns;
execute!(
std::io::stdout(),
EnterAlternateScreen,
crossterm::cursor::Hide,
crossterm::event::EnableMouseCapture
)
.map_err(|e| {
WrappedErr(
format!(
"Couldn't enter the alternate screen and hide the cursor for proper presentation: {e}"
)
.into()
)
})?;
// We need to create `picker` on this thread because if we create it on the `renderer` thread, // We need to create `picker` on this thread because if we create it on the `renderer` thread,
// it messes up something with user input. Input never makes it to the crossterm thing // it messes up something with user input. Input never makes it to the crossterm thing
let picker = Picker::from_query_stdio() let picker = Picker::from_query_stdio()?;
.or_else(|e| match e {
ratatui_image::errors::Errors::NoFontSize if
window_size.width != 0
&& window_size.height != 0
&& window_size.columns != 0
&& window_size.rows != 0
=> Ok(Picker::from_fontsize((cell_width_px, cell_height_px))),
ratatui_image::errors::Errors::NoFontSize => Err(WrappedErr(
"Unable to detect your terminal's font size; this is an issue with your terminal emulator.\nPlease use a different terminal emulator or report this bug to tdf.".into()
)),
e => Err(WrappedErr(format!("Couldn't get the necessary information to set up images: {e}").into()))
})?;
// then we want to spawn off the rendering task // then we want to spawn off the rendering task
// We need to use the thread::spawn API so that this exists in a thread not owned by tokio, // We need to use the thread::spawn API so that this exists in a thread not owned by tokio,
// since the methods we call in `start_rendering` will panic if called in an async context // since the methods we call in `start_rendering` will panic if called in an async context
let prerender = flags
.prerender
.and_then(NonZeroUsize::new)
.map_or(PrerenderLimit::All, PrerenderLimit::Limited);
std::thread::spawn(move || { std::thread::spawn(move || {
renderer::start_rendering( renderer::start_rendering(&file_path, render_tx, render_rx, window_size)
&file_path,
render_tx,
render_rx,
cell_height_px,
cell_width_px,
prerender,
black,
white
)
}); });
let font_size = picker.font_size();
let mut ev_stream = crossterm::event::EventStream::new(); let mut ev_stream = crossterm::event::EventStream::new();
let (to_converter, from_main) = flume::unbounded(); let (to_converter, from_main) = flume::unbounded();
let (to_main, from_converter) = flume::unbounded(); let (to_main, from_converter) = flume::unbounded();
let is_kitty = picker.protocol_type() == ProtocolType::Kitty; tokio::spawn(run_conversion_loop(to_main, from_main, picker, 20));
let shms_work = is_kitty && do_shms_work(&mut ev_stream).await;
tokio::spawn(run_conversion_loop(
to_main, from_main, picker, 20, shms_work
));
let file_name = path.file_name().map_or_else( let file_name = path.file_name().map_or_else(
|| "Unknown file".into(), || "Unknown file".into(),
|n| n.to_string_lossy().to_string() |n| n.to_string_lossy().to_string()
); );
let tui = Tui::new( let mut tui = tui::Tui::new(file_name, flags.max_wide, flags.r_to_l.unwrap_or_default());
file_name,
flags.max_wide,
flags.r_to_l.unwrap_or_default(),
is_kitty
);
let backend = CrosstermBackend::new(std::io::stdout()); let backend = CrosstermBackend::new(std::io::stdout());
let mut term = Terminal::new(backend).map_err(|e| { let mut term = Terminal::new(backend)?;
WrappedErr(format!("Couldn't set up crossterm's terminal backend: {e}").into())
})?;
term.skip_diff(true); term.skip_diff(true);
enable_raw_mode().map_err(|e| { // poppler has some annoying logging (e.g. if you request a page index out-of-bounds of a
WrappedErr( // document's pages, then it will return `None`, but still log to stderr with CRITICAL level),
format!("Can't enable raw mode, which is necessary to receive input: {e}").into() // so we want to just ignore all logging since this is a tui app.
) glib::log_set_writer_func(noop);
})?;
if is_kitty {
run_action(
Action::Delete(DeleteConfig {
effect: ClearOrDelete::Delete,
which: WhichToDelete::IdRange(NonZeroU32::new(1).unwrap()..=NonZeroU32::MAX)
}),
&mut ev_stream
)
.await
.map_err(|e| {
WrappedErr(format!("Couldn't delete all previous images from memory: {e}").into())
})?;
}
let fullscreen = flags.fullscreen.unwrap_or_default();
let main_area = Tui::main_layout(&term.get_frame(), fullscreen);
to_renderer
.send(RenderNotif::Area(main_area.page_area))
.map_err(|e| {
WrappedErr(
format!("Couldn't inform the rendering thread of the available area: {e}").into()
)
})?;
let tui_rx = tui_rx.into_stream();
let from_converter = from_converter.into_stream();
enter_redraw_loop(
ev_stream,
to_renderer,
tui_rx,
to_converter,
from_converter,
fullscreen,
tui,
&mut term,
main_area,
font_size
)
.await
.map_err(|e| {
WrappedErr(
format!(
"An unexpected error occurred while communicating between different parts of tdf: {e}"
)
.into()
)
})?;
execute!( execute!(
term.backend_mut(), term.backend_mut(),
LeaveAlternateScreen, EnterAlternateScreen,
crossterm::cursor::Show, crossterm::cursor::Hide
crossterm::event::DisableMouseCapture )?;
) enable_raw_mode()?;
.unwrap();
disable_raw_mode().unwrap();
drop(maybe_logger); let mut main_area = tui::Tui::main_layout(&term.get_frame());
tui_tx.send(RenderNotif::Area(main_area[1]))?;
Ok(()) let mut tui_rx = tui_rx.into_stream();
} let mut from_converter = from_converter.into_stream();
// oh shut up clippy who cares
#[expect(clippy::too_many_arguments)]
async fn enter_redraw_loop(
mut ev_stream: EventStream,
to_renderer: Sender<RenderNotif>,
mut tui_rx: RecvStream<'_, Result<RenderInfo, RenderError>>,
to_converter: Sender<ConverterMsg>,
mut from_converter: RecvStream<'_, Result<ConvertedPage, RenderError>>,
mut fullscreen: bool,
mut tui: Tui,
term: &mut Terminal<CrosstermBackend<Stdout>>,
mut main_area: tdf::tui::RenderLayout,
font_size: FontSize
) -> Result<(), Box<dyn Error>> {
loop { loop {
let mut needs_redraw = true; let mut needs_redraw = true;
let next_ev = ev_stream.next().fuse();
tokio::select! { tokio::select! {
// First we check if we have any keystrokes // First we check if we have any keystrokes
Some(ev) = next_ev => { Some(ev) = ev_stream.next().fuse() => {
// If we can't get user input, just crash. // If we can't get user input, just crash.
let ev = ev.expect("Couldn't get any user input"); let ev = ev.expect("Couldn't get any user input");
@@ -376,97 +179,71 @@ async fn enter_redraw_loop(
None => needs_redraw = false, None => needs_redraw = false,
Some(action) => match action { Some(action) => match action {
InputAction::Redraw => (), InputAction::Redraw => (),
InputAction::QuitApp => return Ok(()), InputAction::QuitApp => break,
InputAction::JumpingToPage(page) => { InputAction::JumpingToPage(page) => {
to_renderer.send(RenderNotif::JumpToPage(page))?; tui_tx.send(RenderNotif::JumpToPage(page))?;
to_converter.send(ConverterMsg::GoToPage(page))?; to_converter.send(ConverterMsg::GoToPage(page))?;
}, },
InputAction::Search(term) => to_renderer.send(RenderNotif::Search(term))?, InputAction::Search(term) => tui_tx.send(RenderNotif::Search(term))?,
InputAction::Invert => to_renderer.send(RenderNotif::Invert)?,
InputAction::Fullscreen => fullscreen = !fullscreen,
InputAction::SwitchRenderZoom(f_or_f) => {
to_renderer.send(RenderNotif::SwitchFitOrFill(f_or_f)).unwrap();
}
} }
} }
}, },
Some(renderer_msg) = tui_rx.next() => { Some(renderer_msg) = tui_rx.next() => {
match renderer_msg { match renderer_msg {
Ok(render_info) => match render_info { // if an Ok comes through, we know the error has been resolved ('cause it kinda
RenderInfo::NumPages(num) => { // bails whenever we run into an error) so just clear it
tui.set_n_pages(num); Ok(render_info) => {
to_converter.send(ConverterMsg::NumPages(num))?; match render_info {
}, RenderInfo::NumPages(num) => {
RenderInfo::Page(info) => { tui.set_n_pages(num);
tui.got_num_results_on_page(info.page_num, info.result_rects.len()); to_converter.send(ConverterMsg::NumPages(num))?;
to_converter.send(ConverterMsg::AddImg(info))?; },
}, RenderInfo::Page(info) => {
RenderInfo::Reloaded => tui.set_msg(MessageSetting::Some(BottomMessage::Reloaded)), tui.got_num_results_on_page(info.page, info.search_results);
RenderInfo::SearchResults { page_num, num_results } => to_converter.send(ConverterMsg::AddImg(info))?;
tui.got_num_results_on_page(page_num, num_results), },
}
tui.set_bottom_msg(None);
}, },
Err(e) => tui.show_error(e), Err(e) => tui.show_error(e),
} }
} }
Some(img_res) = from_converter.next() => { Some(img_res) = from_converter.next() => {
match img_res { match img_res {
Ok(ConvertedPage { page, num, num_results }) => { Ok(ConvertedPage { page, num, num_results }) => tui.page_ready(page, num, num_results),
tui.page_ready(page, num, num_results);
if num == tui.page {
needs_redraw = true;
}
},
Err(e) => tui.show_error(e), Err(e) => tui.show_error(e),
} }
}, },
}; };
let new_area = Tui::main_layout(&term.get_frame(), fullscreen); let new_area = Tui::main_layout(&term.get_frame());
if new_area != main_area { if new_area != main_area {
main_area = new_area; main_area = new_area;
to_renderer.send(RenderNotif::Area(main_area.page_area))?; tui_tx.send(RenderNotif::Area(main_area[1]))?;
needs_redraw = true; needs_redraw = true;
} }
if needs_redraw { if needs_redraw {
let mut to_display = KittyDisplay::NoChange;
term.draw(|f| { term.draw(|f| {
to_display = tui.render(f, &main_area, font_size); tui.render(f, &main_area);
})?; })?;
execute!(stdout(), EndSynchronizedUpdate)?;
let maybe_err = display_kitty_images(to_display, &mut ev_stream).await;
if let Err((to_replace, err_desc, enum_err)) = maybe_err {
match enum_err {
// This is the error that kitty & ghostty provide us when they delete an
// image due to memory constraints, so if we get it, we just fix it by
// re-rendering so it don't display it to the user
//
// [TODO] maybe when we detect that an image was deleted, we probe the
// terminal for the pages around it to see if they were deleted too and if
// they were, we re-render them? idk
TransmitError::Terminal(TerminalError::NoEntity(_)) => (),
_ => tui.set_msg(MessageSetting::Some(BottomMessage::Error(format!(
"{err_desc}: {enum_err}"
))))
}
for page_num in to_replace {
tui.page_failed_display(page_num);
// So that they get re-rendered and sent over again
to_renderer.send(RenderNotif::PageNeedsReRender(page_num))?;
}
}
execute!(stdout().lock(), EndSynchronizedUpdate)?;
} }
} }
execute!(
term.backend_mut(),
LeaveAlternateScreen,
crossterm::cursor::Show
)?;
disable_raw_mode()?;
Ok(())
} }
fn on_notify_ev( fn on_notify_ev(
to_tui_tx: flume::Sender<Result<RenderInfo, RenderError>>, 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>) { ) -> impl Fn(notify::Result<Event>) {
move |res| match res { move |res| match res {
// If we get an error here, and then an error sending, everything's going wrong. Just give // If we get an error here, and then an error sending, everything's going wrong. Just give
@@ -474,102 +251,19 @@ fn on_notify_ev(
Err(e) => to_tui_tx.send(Err(RenderError::Notify(e))).unwrap(), 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 // TODO: Should we match EventKind::Rename and propogate that so that the other parts of the
// process know that too? Or should that be // process know that too? Or should that be
Ok(ev) => { Ok(ev) => match ev.kind {
// We only watch the parent directory (see the comment above `watcher.watch` in `fn EventKind::Access(_) => (),
// main`) so we need to filter out events to only ones that pertain to the single file EventKind::Remove(_) =>
// we care about drop(to_tui_tx.send(Err(RenderError::Render("File was deleted".into())))),
if !ev // This shouldn't fail to send unless the receiver gets disconnected. If that's
.paths // happened, then like the main thread has panicked or something, so it doesn't matter
.iter() // we don't handle the error here.
.any(|path| path.file_name().is_some_and(|f| f == file_name)) EventKind::Other | EventKind::Any | EventKind::Create(_) | EventKind::Modify(_) =>
{ drop(to_render_tx.send(renderer::RenderNotif::Reload)),
return;
}
match ev.kind {
EventKind::Access(_) => (),
EventKind::Remove(_) => to_tui_tx
.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(_) =>
to_render_tx.send(RenderNotif::Reload).unwrap(),
}
} }
} }
} }
fn parse_color_to_i32(cs: &str) -> Result<i32, csscolorparser::ParseColorError> { fn noop(_: LogLevel, _: &[LogField<'_>]) -> LogWriterOutput {
let color = csscolorparser::parse(cs)?; LogWriterOutput::Handled
let [r, g, b, _] = color.to_rgba8();
Ok(i32::from_be_bytes([0, r, g, b]))
}
fn get_font_size_through_stdio() -> Result<(u16, u16), WrappedErr> {
// send the command code to get the terminal window size
print!("\x1b[14t");
std::io::stdout().flush().unwrap();
// we need to enable raw mode here since this bit of output won't print a newline; it'll
// just print the info it wants to tell us. So we want to get all characters as they come
enable_raw_mode().map_err(|e| {
WrappedErr(
format!("Can't enable raw mode, which is necessary to receive input: {e}").into()
)
})?;
// read in the returned size until we hit a 't' (which indicates to us it's done)
let input_vec = BufReader::new(std::io::stdin())
.bytes()
.filter_map(Result::ok)
.take_while(|b| *b != b't')
.collect::<Vec<_>>();
// and then disable raw mode again in case we return an error in this next section
disable_raw_mode().map_err(|e| {
WrappedErr(format!("Can't put the terminal back into a normal input state: {e}").into())
})?;
let input_line = String::from_utf8(input_vec).map_err(|e| {
WrappedErr(
format!(
"The terminal responded to our request for its font size by providing non-utf8 data: {e}"
)
.into()
)
})?;
let input_line = input_line
.trim_start_matches("\x1b[4")
.trim_start_matches(';');
// it should input it to us as `\e[4;<height>;<width>t`, so we need to split to get the h/w
// ignore the first val
let mut splits = input_line.split([';', 't']);
let (Some(h), Some(w)) = (splits.next(), splits.next()) else {
return Err(WrappedErr(
format!("Terminal responded with unparseable size response '{input_line}'").into()
));
};
let h = h.parse::<u16>().map_err(|_| {
WrappedErr(
format!(
"Your terminal said its height is {h}, but that is not a 16-bit unsigned integer"
)
.into()
)
})?;
let w = w.parse::<u16>().map_err(|_| {
WrappedErr(
format!(
"Your terminal said its width is {w}, but that is not a 16-bit unsigned integer"
)
.into()
)
})?;
Ok((w, h))
} }
+270 -410
View File
@@ -1,72 +1,61 @@
use std::{collections::VecDeque, num::NonZeroUsize, thread::sleep, time::Duration}; use std::thread;
use cairo::{Antialias, Context, Format, Surface};
use crossterm::terminal::WindowSize;
use flume::{Receiver, SendError, Sender, TryRecvError}; use flume::{Receiver, SendError, Sender, TryRecvError};
use mupdf::{ use itertools::Itertools;
Colorspace, Document, Matrix, Page, Pixmap, Quad, TextPageFlags, text_page::SearchHitResponse use poppler::{Color, Document, FindFlags, Page, Rectangle, SelectionStyle};
};
use ratatui::layout::Rect; use ratatui::layout::Rect;
use crate::{
FitOrFill, PrerenderLimit, ScaledResult, scale_img_for_area, skip::InterleavedAroundWithMax
};
const KITTY_MAX_W_OR_H: f32 = 10_000.0;
#[derive(Debug)]
pub enum RenderNotif { pub enum RenderNotif {
Area(Rect), Area(Rect),
JumpToPage(usize), JumpToPage(usize),
PageNeedsReRender(usize),
Search(String), Search(String),
SwitchFitOrFill(FitOrFill), Reload
Reload,
Invert
} }
#[derive(Debug)] #[derive(Debug)]
pub enum RenderError { pub enum RenderError {
Notify(notify::Error), Notify(notify::Error),
Doc(mupdf::error::Error), Doc(glib::Error),
Converting(String) // Don't like storing an error as a string but it needs to be Send to send to the main thread,
// and it's just going to be shown to the user, so whatever
Render(String)
} }
pub enum RenderInfo { pub enum RenderInfo {
NumPages(usize), NumPages(usize),
Page(PageInfo), Page(PageInfo)
SearchResults { page_num: usize, num_results: usize },
Reloaded
} }
#[derive(Clone)] #[derive(Clone)]
pub struct PageInfo { pub struct PageInfo {
pub img_data: ImageData, pub img_data: ImageData,
pub page_num: usize, pub page: usize,
pub result_rects: Vec<HighlightRect> pub search_results: usize
} }
#[derive(Clone)] #[derive(Clone)]
pub struct ImageData { pub struct ImageData {
pub pixels: Vec<u8>, pub data: Vec<u8>,
pub cell_w: u16, pub area: Rect
pub cell_h: u16
} }
#[derive(Default)] #[derive(Default)]
struct PrevRender { struct PrevRender {
successful: bool, successful: bool,
num_search_found: Option<usize> contained_term: Option<bool>
} }
const MUPDF_BLACK: i32 = 0;
const MUPDF_WHITE: i32 = i32::from_be_bytes([0, 0xff, 0xff, 0xff]);
#[inline]
pub fn fill_default<T: Default>(vec: &mut Vec<T>, size: usize) { pub fn fill_default<T: Default>(vec: &mut Vec<T>, size: usize) {
vec.clear(); vec.clear();
vec.resize_with(size, T::default); vec.reserve(size.saturating_sub(vec.len()));
for _ in 0..size {
vec.push(T::default());
}
} }
// this function has to be sync (non-async) because the mupdf::Document needs to be held during // this function has to be sync (non-async) because the poppler::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 // 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 // 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 // async `send` or `recv` methods in this function body, since those create await points. Which
@@ -78,87 +67,62 @@ pub fn fill_default<T: Default>(vec: &mut Vec<T>, size: usize) {
// We're allowing passing by value here because this is only called once, at the beginning of the // We're allowing passing by value here because this is only called once, at the beginning of the
// program, and the arguments that 'should' be passed by value (`receiver` and `size`) would // program, and the arguments that 'should' be passed by value (`receiver` and `size`) would
// probably be more performant if accessed by-value instead of through a reference. Probably. // probably be more performant if accessed by-value instead of through a reference. Probably.
#[allow(clippy::needless_pass_by_value, clippy::too_many_arguments)] #[allow(clippy::needless_pass_by_value)]
pub fn start_rendering( pub fn start_rendering(
path: &str, path: &str,
sender: Sender<Result<RenderInfo, RenderError>>, mut sender: Sender<Result<RenderInfo, RenderError>>,
receiver: Receiver<RenderNotif>, receiver: Receiver<RenderNotif>,
col_h: u16, size: WindowSize
col_w: u16,
prerender: PrerenderLimit,
black: i32,
white: i32
) -> Result<(), SendError<Result<RenderInfo, RenderError>>> { ) -> 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;
loop {
if let RenderNotif::Area(r) = receiver.recv().unwrap() {
area = r;
break;
}
}
// We want this outside of 'reload so that if the doc reloads, the search term that somebody // 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 // set will still get highlighted in the reloaded doc
let mut search_term = None; let mut search_term = None;
// And although the font size could theoretically change, we aren't accounting for that right // And although the font size could theoretically change, we aren't accounting for that right
// now, so we just use the values passed in. // now, so we just keep this out of the loop.
let col_w = size.width / size.columns;
let mut stored_doc = None; let col_h = size.height / size.rows;
let mut invert = false;
let mut preserved_area = None;
let mut fit_or_fill = FitOrFill::Fit;
let mut need_rerender = VecDeque::new();
'reload: loop { 'reload: loop {
let doc = match Document::open(path) { let doc = match Document::from_file(path, None) {
Err(e) => { Err(e) => {
// if there's an error, tell the main loop // if there's an error, tell the main loop
sender.send(Err(RenderError::Doc(e)))?; sender.send(Err(RenderError::Doc(e)))?;
// then wait for a reload notif (since what probably happened is that the file was
match stored_doc { // temporarily removed to facilitate a save or something like that)
Some(ref d) => d, while let Ok(msg) = receiver.recv() {
None => { // and once that comes, just try to reload again
// then wait for a reload notif (since what probably happened is that the file was if let RenderNotif::Reload = msg {
// temporarily removed to facilitate a save or something like that) continue 'reload;
while let Ok(msg) = receiver.recv() {
// and once that comes, just try to reload again
if let RenderNotif::Reload = msg {
continue 'reload;
}
}
// if that while let Ok ever fails and we exit out of that loop, the main thread is
// done, so we're fine to just return
return Ok(());
} }
} }
// if that while let Ok ever fails and we exit out of that loop, the main thread is
// done, so we're fine to just return
return Ok(());
} }
Ok(d) => { Ok(d) => d
if stored_doc.is_some() {
sender.send(Ok(RenderInfo::Reloaded))?;
}
&*stored_doc.insert(d)
}
}; };
let n_pages = match doc.page_count() { let n_pages = doc.n_pages() as usize;
Ok(n) => match NonZeroUsize::new(n as usize) { sender.send(Ok(RenderInfo::NumPages(n_pages)))?;
Some(n) => n,
None => {
sleep(Duration::from_secs(1));
continue 'reload;
}
},
Err(e) => {
sender.send(Err(RenderError::Doc(e)))?;
// just basic backoff i think
sleep(Duration::from_secs(1));
continue 'reload;
}
};
sender.send(Ok(RenderInfo::NumPages(n_pages.get())))?;
// We're using this vec of bools to indicate which page numbers have already been rendered, // We're using this vec of bools to indicate which page numbers have already been rendered,
// to support people jumping to specific pages and having quick rendering results. We // to support people jumping to specific pages and having quick rendering results. We
// `split_at_mut` at 0 initially (which bascially makes `right == rendered && left == []`), // `split_at_mut` at 0 initially (which bascially makes `right == rendered && left == []`),
// doing basically nothing, but if we get a notification that something has been jumped to, // doing basically nothing, but if we get a notification that something has been jumped to,
// then we can split at that page and render at both sides of it // then we can split at that page and render at both sides of it
let mut rendered = Vec::new(); let mut rendered = vec![];
fill_default::<PrevRender>(&mut rendered, n_pages.get()); fill_default::<PrevRender>(&mut rendered, n_pages);
let mut start_point = 0; let mut start_point = 0;
// This is kinda a weird way of doing this, but if we get a notification that the area // This is kinda a weird way of doing this, but if we get a notification that the area
@@ -166,62 +130,36 @@ pub fn start_rendering(
// document. If there was a mechanism to say 'start this for-loop over' then I would do // document. If there was a mechanism to say 'start this for-loop over' then I would do
// that, but I don't think such a thing exists, so this is our attempt // that, but I don't think such a thing exists, so this is our attempt
'render_pages: loop { 'render_pages: loop {
// next, we gotta wait 'til we get told what the current starting area is so that we can
// set it to know what to render to
let area = preserved_area.unwrap_or_else(|| {
let new_area = loop {
if let RenderNotif::Area(r) = receiver.recv().unwrap() {
break r;
}
};
preserved_area = Some(new_area);
new_area
});
let area_w = f32::from(area.width) * f32::from(col_w);
let area_h = f32::from(area.height) * f32::from(col_h);
// what we do with a notif is the same regardless of if we're in the middle of // what we do with a notif is the same regardless of if we're in the middle of
// rendering the list of pages or we're all done // rendering the list of pages or we're all done
macro_rules! handle_notif { macro_rules! handle_notif {
($notif:ident) => {{ ($notif:ident) => {
match $notif { match $notif {
RenderNotif::Reload => continue 'reload, RenderNotif::Reload => continue 'reload,
RenderNotif::Invert => {
invert = !invert;
for page in &mut rendered {
page.successful = false;
}
continue 'render_pages;
}
RenderNotif::Area(new_area) => { RenderNotif::Area(new_area) => {
preserved_area = Some(new_area); let bigger =
fill_default(&mut rendered, n_pages.get()); new_area.width > area.width || new_area.height > area.height;
continue 'render_pages; area = new_area;
} // we only want to re-render pages if the new area is greater than the old
RenderNotif::SwitchFitOrFill(f_or_f) => // one, 'cause then we might need sharper images to make it all look good.
if f_or_f != fit_or_fill { // If the new area is smaller, then the same high-quality-rendered images
fit_or_fill = f_or_f; // will still look fine, so it's ok to leave it.
fill_default(&mut rendered, n_pages.get()); if bigger {
fill_default(&mut rendered, n_pages);
continue 'render_pages; continue 'render_pages;
}, }
}
RenderNotif::JumpToPage(page) => { RenderNotif::JumpToPage(page) => {
start_point = page; start_point = page;
continue 'render_pages; continue 'render_pages;
} }
RenderNotif::PageNeedsReRender(page) => {
rendered[page].successful = false;
need_rerender.push_back(page);
continue 'render_pages;
}
RenderNotif::Search(term) => { RenderNotif::Search(term) => {
if term.is_empty() { if term.is_empty() {
// If the term is set to nothing, then we don't need to re-render // If the term is set to nothing, then we don't need to re-render
// the pages wherein there were already no search results. So this // the pages wherein there were already no search results. So this
// is a little optimization to allow that. // is a little optimization to allow that.
for page in &mut rendered { for page in &mut rendered {
if page.num_search_found.is_some_and(|n| n > 0) { if !page.successful || page.contained_term != Some(true) {
page.num_search_found = Some(0);
page.successful = false; page.successful = false;
} }
} }
@@ -232,108 +170,43 @@ pub fn start_rendering(
// term, we can render them with the term, but if they don't, we // term, we can render them with the term, but if they don't, we
// don't need to re-render and send it over again. // don't need to re-render and send it over again.
for page in &mut rendered { for page in &mut rendered {
page.num_search_found = None; page.contained_term = None;
} }
search_term = Some(term); search_term = Some(term);
} }
continue 'render_pages; continue 'render_pages;
} }
} }
}}; };
} }
let any_not_searched = rendered.iter().any(|r| r.num_search_found.is_none()); let (left, right) = rendered.split_at_mut(start_point);
// This is our iterator over all the pages we want to look at and render. It uses this let page_iter = right
// weird 'interleave' thing to render pages on *both sides* of the currently-displayed .iter_mut()
// page in case they device to go forward or backwards. .enumerate()
let page_iter = PopOnNext { .map(|(idx, p)| (idx + start_point, p))
inner: &mut need_rerender .interleave(
} left.iter_mut()
.chain(InterleavedAroundWithMax::new(start_point, 0, n_pages).take( .rev()
match (&prerender, &search_term) { .enumerate()
// If the user has limited the amount of pages they want to prerender, then we .map(|(idx, p)| (start_point - (idx + 1), p))
// just do what they ask. Nice and easy. );
(PrerenderLimit::Limited(l), _) => l.get(),
// If they haven't limited it, but we don't have any search term that we're let area_w = f64::from(area.width) * f64::from(col_w);
// currently looking for, just go for all of it let area_h = f64::from(area.height) * f64::from(col_h);
(PrerenderLimit::All, None) => n_pages.get(),
// If they haven't limited it, and we DO have a search term we need to look
// for, just do 20 so that we don't dramatically slow down the search process
// since they've specifically initiated that and so we want it to take priority
(PrerenderLimit::All, Some(_)) =>
if any_not_searched {
20
} else {
n_pages.get()
},
}
));
// we go through each page // we go through each page
for page_num in page_iter { for (num, rendered) in page_iter {
let rendered = &mut rendered[page_num];
// we only want to continue if one of the following is met: // we only want to continue if one of the following is met:
// 1. It failed to render last time (we want to retry) // 1. It failed to render last time (we want to retry)
// 2. The `contained_term` is set to Unknown, meaning that we need to at least // 2. The `contained_term` is set to None (representing 'Unknown'), meaning that we
// check if it contains the current term to see if it needs a re-render // need to at least check if it contains the current term to see if it needs a
if rendered.successful && rendered.num_search_found.is_some() { // re-render
if rendered.successful && rendered.contained_term.is_some() {
continue; continue;
} }
// We know this is in range 'cause we're iterating over it but we still just want
// to be safe
let page = match doc.load_page(page_num as i32) {
Err(e) => {
sender.send(Err(RenderError::Doc(e)))?;
continue;
}
Ok(p) => p
};
// render the page
match render_single_page_to_ctx(
&page,
search_term.as_deref(),
rendered,
invert,
black,
white,
fit_or_fill,
(area_w, area_h)
) {
// If that fn returned Some, that means it needed to be re-rendered for some
// reason or another, so we're sending it here
Ok(ctx) => {
let w = ctx.pixmap.width();
let h = ctx.pixmap.height();
let cap = (w * h * u32::from(ctx.pixmap.n())) as usize + 16;
let mut pixels = Vec::with_capacity(cap);
if let Err(e) = ctx.pixmap.write_to(&mut pixels, mupdf::ImageFormat::PNM) {
sender.send(Err(RenderError::Doc(e)))?;
continue;
};
log::debug!("got pixmap for page {page_num} with WxH {w}x{h}");
rendered.num_search_found = Some(ctx.result_rects.len());
rendered.successful = true;
sender.send(Ok(RenderInfo::Page(PageInfo {
img_data: ImageData {
pixels,
cell_w: (ctx.surface_w / f32::from(col_w)) as u16,
cell_h: (ctx.surface_h / f32::from(col_h)) as u16
},
page_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::Doc(e)))?
}
// check if we've been told to change the area that we're rendering to, // check if we've been told to change the area that we're rendering to,
// or if we're told to rerender // or if we're told to rerender
match receiver.try_recv() { match receiver.try_recv() {
@@ -342,232 +215,219 @@ pub fn start_rendering(
Ok(notif) => handle_notif!(notif), Ok(notif) => handle_notif!(notif),
Err(TryRecvError::Empty) => () Err(TryRecvError::Empty) => ()
}; };
}
// Now, if we have a search term, we want to look through the rest of the document past // We know this is in range 'cause we're iterating over it but we still just want
// what we've just rendered (and looked at the search results of) // to be safe
if let Some(ref term) = search_term { let Some(page) = doc.page(num as i32) else {
let mut search_start = start_point; sender.send(Err(RenderError::Render(format!(
loop { "Couldn't get page {num} ({}) of doc?",
// hmm maybe this would be nice to make configurable but whatever num as i32
const SEARCH_AT_TIME: usize = 20; ))))?;
continue;
};
// So now we want to look through all the remaining pages, starting after this let rendered_with_no_results =
// current one (we don't do interleaving here 'cause I'm lazy rendered.successful && rendered.contained_term == Some(false);
let page_idx = rendered[search_start..]
.iter_mut()
.enumerate()
// And we only want to take max SEARCH_AT_TIME of them since we don't want
// to block on this for *too* long
.take(SEARCH_AT_TIME)
// And we only want the ones that we still don't know about...
.filter(|(_, r)| r.num_search_found.is_none())
// And then adjust the index to be correct for the actual page number
.map(|(idx, r)| (idx + search_start, r));
// then we go through each... // render the page
for (page_num, rendered) in page_idx { match render_single_page_to_ctx(
// We get the number of results (using the function that specifically just &page,
// counts them instead of determining the quads of them all) search_term.as_deref(),
let num_results = doc rendered_with_no_results,
.load_page(page_num as i32) (area_w, area_h)
.and_then(|page| count_search_results(&page, term)) ) {
.unwrap(); // If we've already rendered it just fine and we don't need to render it again,
// just continue. We're all good
Ok(None) => (),
// If that fn returned Some, that means it needed to be re-rendered for some
// reason or another, so we're sending it here
Ok(Some(ctx)) => {
// 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.successful = true;
// And mark that whatever else was rendered last is not relevant anymore if // if this is the page that the user is currently trying to look at, don't
// there are results that need to be rendered // bother spawning off a thread to render it to a png - it'll only slow
if num_results > 0 { // down the time til the user can see it (due to the overhead of creating a
rendered.successful = false; // thread), but we still want to spawn threads to render the other pages
// since the effects of parallelizing that will be noticeable if the user
// tries to move through pages more quickly
if num == start_point {
render_ctx_to_png(&ctx, &mut sender, (col_w, col_h), num)?;
} else {
let mut sender = sender.clone();
thread::spawn(move || {
render_ctx_to_png(&ctx, &mut sender, (col_w, col_h), num)
});
} }
// Mark the `contained_term` field with this updated value...
rendered.num_search_found = Some(num_results);
// And send it over to the tui so that they can know and use it to
// determine what next page to jump to
sender.send(Ok(RenderInfo::SearchResults {
page_num,
num_results
}))?;
}
// then once we're done with this iteration, we increment search_start to
// prepare for the next iteration
search_start += SEARCH_AT_TIME;
// now, we want to check if we've gone past the end - if so, we go back to the
// beginning so we can get the pages before the current one.
if search_start > n_pages.get() {
if start_point == 0 {
break;
}
search_start = 0;
} else if ((search_start - SEARCH_AT_TIME) + 1..search_start)
.contains(&start_point)
{
// And if we are back at the place we started, we've looked through all the
// pages. Quit.
break;
}
match receiver.try_recv() {
// If there are no messages left for us, just continue in this loop
Err(TryRecvError::Empty) => (),
Err(TryRecvError::Disconnected) => return Ok(()),
Ok(msg) => handle_notif!(msg)
} }
// And if we got an error, then obviously we need to propagate that
Err(e) => sender.send(Err(RenderError::Render(e)))?
} }
} }
// So now we've just *searched* all the pages but not necessarily rendered all of them.
// So if there are any we have yet to render, we need to loop back to the beginning of
// this loop to continue rendering all of them
if rendered.iter().any(|r| !r.successful) && prerender == PrerenderLimit::All {
continue;
}
// Then once we've rendered all these pages, wait until we get another notification // Then once we've rendered all these pages, wait until we get another notification
// that this doc needs to be reloaded // that this doc needs to be reloaded
// This once returned None despite the main thing being still connected (I think, at loop {
// least), so I'm just being safe here // This once returned None despite the main thing being still connected (I think, at
let Ok(msg) = receiver.recv() else { // least), so I'm just being safe here
return Ok(()); let Ok(msg) = receiver.recv() else {
}; return Ok(());
};
handle_notif!(msg) handle_notif!(msg);
}
} }
} }
} }
struct RenderedContext { struct RenderedContext {
pixmap: Pixmap, surface: Surface,
surface_w: f32, num_results: usize,
surface_h: f32, surface_width: f64,
result_rects: Vec<HighlightRect> surface_height: f64
} }
#[expect(clippy::too_many_arguments)] /// 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( fn render_single_page_to_ctx(
page: &Page, page: &Page,
search_term: Option<&str>, search_term: Option<&str>,
prev_render: &PrevRender, already_rendered_no_results: bool,
invert: bool, (area_w, area_h): (f64, f64)
black: i32, ) -> Result<Option<RenderedContext>, String> {
white: i32, let mut result_rects = search_term
fit_or_fill: FitOrFill, .as_ref()
(area_w, area_h): (f32, f32) .map(|term| page.find_text_with_options(term, FindFlags::DEFAULT | FindFlags::MULTILINE))
) -> Result<RenderedContext, mupdf::error::Error> { .unwrap_or_default();
let result_rects = match prev_render.num_search_found {
None => search_page(page, search_term, 0)?, // If there are no search terms on this page, and we've already rendered it with no search
Some(0) => Vec::new(), // terms, then just return none to avoid this computation
Some(count @ 1..) => search_page(page, search_term, count)? if result_rects.is_empty() && already_rendered_no_results {
}; return Ok(None);
}
// then, get the size of the page // then, get the size of the page
let bounds = page.bounds()?; let (p_width, p_height) = page.size();
let page_dim = (bounds.x1 - bounds.x0, bounds.y1 - bounds.y0);
let scaled = scale_img_for_area(page_dim, (area_w, area_h), fit_or_fill); // and get its aspect ratio
let ScaledResult { let p_aspect_ratio = p_width / p_height;
width: mut surface_w,
height: mut surface_h,
mut scale_factor
} = scaled;
if surface_w > KITTY_MAX_W_OR_H || surface_h > KITTY_MAX_W_OR_H { // Then we get the full pixel dimensions of the area provided to us, and the aspect ratio
let descale = (surface_w / KITTY_MAX_W_OR_H).max(surface_h / KITTY_MAX_W_OR_H); // of that area
surface_w /= descale; let area_aspect_ratio = area_w / area_h;
surface_h /= descale;
scale_factor /= descale; // and get the ratio that this page would have to be scaled by to fit perfectly within the
// area provided to us.
// we do this first by comparing the aspec ratio of the page with the aspect ratio of the
// area to fit it within. If the aspect ratio of the page is larger, then we need to scale
// the width of the page to fill perfectly within the height of the area. Otherwise, we
// scale the height to fit perfectly. The dimension that _is not_ scaled to fit perfectly
// is scaled by the same factor as the dimension that _is_ scaled perfectly.
let scale_factor = if p_aspect_ratio > area_aspect_ratio {
area_w / p_width
} else {
area_h / p_height
};
let surface_width = p_width * scale_factor;
let surface_height = p_height * scale_factor;
let surface = cairo::ImageSurface::create(
Format::Rgb16_565,
// 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}"))?;
// The default background color of PDFs (at least, I think) is white, so we need to set
// that as the background color, then paint, then render.
ctx.set_source_rgba(1.0, 1.0, 1.0, 1.0);
ctx.set_antialias(Antialias::None);
ctx.paint()
.map_err(|e| format!("Couldn't paint Context: {e}"))?;
page.render(&ctx);
let num_results = result_rects.len();
if !result_rects.is_empty() {
let mut highlight_color = Color::new();
highlight_color.set_red((u16::MAX / 5) * 4);
highlight_color.set_green((u16::MAX / 5) * 4);
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
);
}
} }
let colorspace = Colorspace::device_rgb(); Ok(Some(RenderedContext {
let matrix = Matrix::new_scale(scale_factor, scale_factor); surface: ctx.target(),
num_results,
let mut pixmap = page.to_pixmap(&matrix, &colorspace, false, false)?; surface_width,
if invert { surface_height
pixmap.tint(white, black)?; }))
} else if black != MUPDF_BLACK || white != MUPDF_WHITE {
pixmap.tint(black, white)?;
}
let (x_res, y_res) = pixmap.resolution();
let new_x = (x_res as f32 * scale_factor) as i32;
let new_y = (y_res as f32 * scale_factor) as i32;
pixmap.set_resolution(new_x, new_y);
let result_rects = result_rects
.into_iter()
.map(|quad| {
let ul_x = (quad.ul.x * scale_factor) as u32;
let ul_y = (quad.ul.y * scale_factor) as u32;
let lr_x = (quad.lr.x * scale_factor) as u32;
let lr_y = (quad.lr.y * scale_factor) as u32;
HighlightRect {
ul_x,
ul_y,
lr_x,
lr_y
}
})
.collect::<Vec<_>>();
Ok(RenderedContext {
pixmap,
surface_w,
surface_h,
result_rects
})
} }
#[derive(Clone, Debug)] fn render_ctx_to_png(
pub struct HighlightRect { ctx: &RenderedContext,
pub ul_x: u32, sender: &mut Sender<Result<RenderInfo, RenderError>>,
pub ul_y: u32, (col_w, col_h): (u16, u16),
pub lr_x: u32, page: usize
pub lr_y: u32 ) -> Result<(), SendError<Result<RenderInfo, RenderError>>> {
} let mut img_data = Vec::with_capacity((ctx.surface_height * ctx.surface_width) as usize);
#[inline] match ctx.surface.write_to_png(&mut img_data) {
fn search_page( Err(e) => sender.send(Err(RenderError::Render(format!(
page: &Page, "Couldn't write surface to png: {e}"
search_term: Option<&str>, )))),
trusted_search_results: usize Ok(()) => sender.send(Ok(RenderInfo::Page(PageInfo {
) -> Result<Vec<Quad>, mupdf::error::Error> { img_data: ImageData {
search_term data: img_data,
.map(|term| { area: Rect {
page.to_text_page(TextPageFlags::empty()).and_then(|page| { width: ctx.surface_width as u16 / col_w,
let mut v = Vec::with_capacity(trusted_search_results); height: ctx.surface_height as u16 / col_h,
page.search_cb(term, &mut v, |v, results| { x: 0,
v.extend(results.iter().cloned()); y: 0
SearchHitResponse::ContinueSearch }
}) },
.map(|_| v) page,
}) search_results: ctx.num_results
}) })))
.transpose()
.map(Option::unwrap_or_default)
}
#[inline]
fn count_search_results(page: &Page, search_term: &str) -> Result<usize, mupdf::error::Error> {
page.to_text_page(TextPageFlags::empty()).and_then(|page| {
let mut count = 0;
page.search_cb(search_term, &mut count, |count, results| {
*count += results.len();
SearchHitResponse::ContinueSearch
})?;
Ok(count)
})
}
struct PopOnNext<'a> {
inner: &'a mut VecDeque<usize>
}
impl<'a> Iterator for PopOnNext<'a> {
type Item = usize;
fn next(&mut self) -> Option<Self::Item> {
self.inner.pop_front()
} }
} }
-106
View File
@@ -1,5 +1,3 @@
use std::num::NonZeroUsize;
use ratatui::widgets::Widget; use ratatui::widgets::Widget;
pub struct Skip { pub struct Skip {
@@ -21,107 +19,3 @@ impl Widget for Skip {
} }
} }
} }
enum PlusOrMinus {
Plus,
Minus
}
pub struct InterleavedAroundWithMax {
// starts at this number
around: usize,
inclusive_min: usize,
// this iterator can only produce values in [0..max)
exclusive_max: NonZeroUsize,
// the next time we call `next()`, this value should be combined with `around` according to
// `next_op`, then, after next_op is inverted, incremented if next_op was negative before being
// inverted.
next_change: usize,
// How `next_change` should be applied to `around` next time `next()` is called
next_op: PlusOrMinus
}
impl InterleavedAroundWithMax {
/// the following must hold or else this is liable to panic or produce nonsense values:
/// - inclusive_min < exclusive_max
/// - inclusive_min <= around <= exclusive_max
pub fn new(around: usize, inclusive_min: usize, exclusive_max: NonZeroUsize) -> Self {
Self {
around,
inclusive_min,
exclusive_max,
next_change: 0,
next_op: PlusOrMinus::Minus
}
}
}
impl Iterator for InterleavedAroundWithMax {
type Item = usize;
fn next(&mut self) -> Option<Self::Item> {
let actual_change = self.next_change % (self.exclusive_max.get() - self.inclusive_min);
let to_return = match self.next_op {
// If we're supposed to add them and we need it to wrap, then try to add them together
// 'cause we need special behavior if it overflows usize's limits
PlusOrMinus::Plus => match self.around.checked_add(actual_change) {
// If we added it and it's within the range, we're chillin
Some(next_val) if next_val < self.exclusive_max.get() => next_val,
// If we added it and it's not within the range, do next_val % (self.max + 1), e.g.
// if max is 20, we were at 15, and we added 7, we should get 1 (because +5 would
// hit the max, then 0, then 1). So adding 1 before the modulo makes it hit the
// right numbers. And we can be sure the + here doesn't overflow 'cause we already
// checked the `usize::MAX` up above
Some(next_val) => (next_val % self.exclusive_max.get()) + self.inclusive_min,
// If we added them and it would've overflowed usize::MAX, then we see how much
// of the change would be remaining after reaching `max`
None =>
(actual_change - (self.exclusive_max.get() - actual_change))
+ self.inclusive_min,
},
PlusOrMinus::Minus => match self.around.checked_sub(actual_change) {
// If we can just minus it, cool cool. All is good.
Some(next_val) if next_val >= self.inclusive_min => next_val,
// If we can minus it but it goes below our min, then see how much below it went
// and just manually wrap it around
Some(next_val) => self.exclusive_max.get() - (self.inclusive_min - next_val),
// If we can't...
None => {
// then we see how much of the change would be remaining after hitting the
// minimum
let remaining = actual_change - (self.around - self.inclusive_min);
// and then we take that away from the top!
self.exclusive_max.get() - remaining
}
}
};
self.next_op = match self.next_op {
PlusOrMinus::Plus => PlusOrMinus::Minus,
PlusOrMinus::Minus => {
self.next_change = (self.next_change + 1) % self.exclusive_max.get();
PlusOrMinus::Plus
}
};
Some(to_return)
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn iter_works() {
let got = InterleavedAroundWithMax::new(5, 2, NonZeroUsize::new(21).unwrap())
.take(30)
.collect::<Vec<_>>();
assert_eq!(got, vec![
5, 6, 4, 7, 3, 8, 2, 9, 20, 10, 19, 11, 18, 12, 17, 13, 16, 14, 15, 15, 14, 16, 13, 17,
12, 18, 11, 19, 10, 20
]);
}
}
+196 -550
View File
@@ -1,52 +1,34 @@
use std::{borrow::Cow, io::stdout, num::NonZeroUsize}; use std::{borrow::Cow, io::stdout, num::NonZeroUsize, rc::Rc};
use crossterm::{ use crossterm::{
event::{Event, KeyCode, KeyModifiers, MouseEventKind}, event::{Event, KeyCode, MouseEventKind},
execute, execute,
terminal::{ terminal::BeginSynchronizedUpdate
BeginSynchronizedUpdate, EnterAlternateScreen, LeaveAlternateScreen, disable_raw_mode,
enable_raw_mode
}
};
use kittage::display::DisplayLocation;
use nix::{
sys::signal::{Signal::SIGSTOP, kill},
unistd::Pid
}; };
use ratatui::{ use ratatui::{
Frame, layout::{Constraint, Flex, Layout, Rect},
layout::{Constraint, Flex, Layout, Position, Rect},
style::{Color, Style}, style::{Color, Style},
symbols::border,
text::Span, text::Span,
widgets::{Block, Borders, Clear, Padding, Paragraph, Wrap} widgets::{Block, Borders, Padding},
Frame
}; };
use ratatui_image::{FontSize, Image}; use ratatui_image::{protocol::Protocol, Image};
use crate::{ use crate::{renderer::RenderError, skip::Skip};
FitOrFill,
converter::{ConvertedImage, MaybeTransferred},
kitty::{KittyDisplay, KittyReadyToDisplay},
renderer::{RenderError, fill_default},
skip::Skip
};
pub struct Tui { pub struct Tui {
name: String, name: String,
pub page: usize, page: usize,
last_render: LastRender, last_render: LastRender,
bottom_msg: BottomMessage, bottom_msg: BottomMessage,
// we use `prev_msg` to, for example, restore the 'search results' message on the bottom after // we use `prev_msg` to, for example, restore the 'search results' message on the bottom after
// jumping to a specific page // jumping to a specific page
prev_msg: Option<BottomMessage>, prev_msg: Option<BottomMessage>,
rendered: Vec<RenderedInfo>, rendered: Vec<RenderedInfo>,
page_constraints: PageConstraints, page_constraints: PageConstraints
showing_help_msg: bool,
is_kitty: bool,
zoom: Option<Zoom>
} }
#[derive(Default)] #[derive(Default, Debug)]
struct LastRender { struct LastRender {
// Used as a way to track if we need to draw the images, to save ratatui from doing a lot of // Used as a way to track if we need to draw the images, to save ratatui from doing a lot of
// diffing work // diffing work
@@ -61,8 +43,7 @@ pub enum BottomMessage {
Help, Help,
SearchResults(String), SearchResults(String),
Error(String), Error(String),
Input(InputCommand), Input(InputCommand)
Reloaded
} }
pub enum InputCommand { pub enum InputCommand {
@@ -75,25 +56,12 @@ struct PageConstraints {
r_to_l: bool r_to_l: bool
} }
#[derive(Default, Debug)]
struct Zoom {
// just how much 'zoom' you have. Doesn't relate to anything specific yet, except that 0 means
// it fills the screen (instead of fits)
level: i16,
// how many terminal-cells worth of content overflow the left side of the screen (and are thus
// not displayed)
cell_pan_from_left: u16,
// how many terminal-cells worth of content overflow the top side of the screen (and are thus
// not displayed)
cell_pan_from_top: u16
}
// This seems like a kinda weird struct because it holds two optionals but any representation // This seems like a kinda weird struct because it holds two optionals but any representation
// within it is valid; I think it's the best way to represent it // within it is valid; I think it's the best way to represent it
#[derive(Default)] #[derive(Default)]
pub struct RenderedInfo { struct RenderedInfo {
// The image, if it has been rendered by `Converter` to that struct // The image, if it has been rendered by `Converter` to that struct
img: Option<ConvertedImage>, img: Option<Protocol>,
// The number of results for the current search term that have been found on this page. None if // The number of results for the current search term that have been found on this page. None if
// we haven't checked this page yet // we haven't checked this page yet
// Also this isn't the most efficient representation of this value, but it's accurate, so like // Also this isn't the most efficient representation of this value, but it's accurate, so like
@@ -101,14 +69,8 @@ pub struct RenderedInfo {
num_results: Option<usize> num_results: Option<usize>
} }
#[derive(PartialEq)]
pub struct RenderLayout {
pub page_area: Rect,
pub top_and_bottom: Option<(Rect, Rect)>
}
impl Tui { impl Tui {
pub fn new(name: String, max_wide: Option<NonZeroUsize>, r_to_l: bool, is_kitty: bool) -> Tui { pub fn new(name: String, max_wide: Option<NonZeroUsize>, r_to_l: bool) -> Tui {
Self { Self {
name, name,
page: 0, page: 0,
@@ -116,62 +78,120 @@ impl Tui {
bottom_msg: BottomMessage::Help, bottom_msg: BottomMessage::Help,
last_render: LastRender::default(), last_render: LastRender::default(),
rendered: vec![], rendered: vec![],
page_constraints: PageConstraints { max_wide, r_to_l }, page_constraints: PageConstraints { max_wide, r_to_l }
showing_help_msg: false,
is_kitty,
zoom: None
} }
} }
pub fn main_layout(frame: &Frame<'_>, fullscreened: bool) -> RenderLayout { pub fn main_layout(frame: &Frame<'_>) -> Rc<[Rect]> {
if fullscreened { Layout::default()
RenderLayout { .constraints([
page_area: frame.area(), Constraint::Length(3),
top_and_bottom: None Constraint::Fill(1),
} Constraint::Length(3)
} else { ])
let layout = Layout::default() .horizontal_margin(2)
.constraints([ .vertical_margin(1)
Constraint::Length(3), .split(frame.area())
Constraint::Fill(1),
Constraint::Length(3)
])
.horizontal_margin(2)
.vertical_margin(1)
.split(frame.area());
RenderLayout {
page_area: layout[1],
top_and_bottom: Some((layout[0], layout[2]))
}
}
} }
// TODO: Make a way to fill the width of the screen with one page and scroll down to view it // TODO: Make a way to fill the width of the screen with one page and scroll down to view it
#[must_use] pub fn render(&mut self, frame: &mut Frame<'_>, main_area: &[Rect]) {
pub fn render<'s>( let top_block = Block::new()
&'s mut self, .padding(Padding {
frame: &mut Frame<'_>, right: 2,
full_layout: &RenderLayout, left: 2,
font_size: FontSize ..Padding::default()
) -> KittyDisplay<'s> { })
if self.showing_help_msg { .borders(Borders::BOTTOM);
self.render_help_msg(frame);
return KittyDisplay::ClearImages;
}
if let Some(t_and_b) = full_layout.top_and_bottom { let top_area = top_block.inner(main_area[0]);
Self::render_top_and_bottom(
t_and_b,
self.page,
&self.rendered,
&self.name,
frame,
&self.bottom_msg
);
}
let mut img_area = full_layout.page_area; let page_nums_text = format!("{} / {}", self.page + 1, self.rendered.len());
let top_layout = Layout::horizontal([
Constraint::Fill(1),
Constraint::Length(page_nums_text.len() as u16)
])
.split(top_area);
let title = Span::styled(&self.name, Style::new().fg(Color::Cyan));
let page_nums = Span::styled(&page_nums_text, Style::new().fg(Color::Cyan));
frame.render_widget(top_block, main_area[0]);
frame.render_widget(title, top_layout[0]);
frame.render_widget(page_nums, top_layout[1]);
let bottom_block = Block::new()
.padding(Padding {
top: 1,
right: 2,
left: 2,
bottom: 0
})
.borders(Borders::TOP);
let bottom_area = bottom_block.inner(main_area[2]);
frame.render_widget(bottom_block, main_area[2]);
let rendered_str = if !self.rendered.is_empty() {
format!(
"Rendered: {}%",
(self.rendered.iter().filter(|i| i.img.is_some()).count() * 100)
/ self.rendered.len()
)
} else {
String::new()
};
let bottom_layout = Layout::horizontal([
Constraint::Fill(1),
Constraint::Length(rendered_str.len() as u16)
])
.split(bottom_area);
let rendered_span = Span::styled(&rendered_str, Style::new().fg(Color::Cyan));
frame.render_widget(rendered_span, bottom_layout[1]);
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".into(),
Color::Blue
),
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) => {
let num_found = self
.rendered
.iter()
.filter_map(|r| r.num_results)
.sum::<usize>();
let num_searched = self
.rendered
.iter()
.filter(|r| r.num_results.is_some())
.count() * 100;
(
format!(
"Results for '{term}': {num_found} (searched: {}%)",
num_searched / self.rendered.len()
)
.into(),
Color::Blue
)
}
};
let span = Span::styled(msg_str, Style::new().fg(color));
frame.render_widget(span, bottom_layout[0]);
let mut img_area = main_area[1];
let size = frame.area(); let size = frame.area();
if size == self.last_render.rect { if size == self.last_render.rect {
@@ -180,104 +200,14 @@ impl Tui {
// be written and set to skip it so that ratatui doesn't spend a lot of time diffing it // be written and set to skip it so that ratatui doesn't spend a lot of time diffing it
// each re-render // each re-render
frame.render_widget(Skip::new(true), img_area); frame.render_widget(Skip::new(true), img_area);
KittyDisplay::NoChange
} else { } else {
if let Some(ref mut zoom) = self.zoom {
// yes this is ugly and I hate it. it's due to the limitations that currently exist
// in the borrow checker. Once `-Zpolonius=next` is stabilized, we can rework this
// to look like what we expect.
// See https://github.com/rust-lang/rfcs/blob/master/text/2094-nll.md#problem-case-3-conditional-control-flow-across-functions
// You can also rewrite this to just if an `if let` and run it under
// `RUSTFLAGS="-Zpolonius=next"` and see that it works
if self.rendered[self.page]
.img
.as_ref()
.is_some_and(|c| matches!(c, ConvertedImage::Kitty { .. }))
{
let Some(ConvertedImage::Kitty {
ref mut img,
cell_w,
cell_h
}) = self.rendered[self.page].img
else {
unreachable!()
};
log::debug!("zoom is now {zoom:#?}");
log::debug!("img_area is {img_area:#?}");
if zoom.level < 0 {
img_area = Rect {
width: img_area
.width
.saturating_sub((zoom.level * 2).unsigned_abs())
.max(1),
x: img_area.x + (zoom.level.unsigned_abs().min(img_area.width / 2)),
..img_area
}
}
log::debug!("after adjustment, img_area is {img_area:#?}");
// Ugh I don't like this logic. I wish we could simplify it.
let img_width = f32::from(cell_w);
let img_height = f32::from(cell_h);
let img_area_width = f32::from(img_area.width);
let img_area_height = f32::from(img_area.height);
let available_to_real_width_ratio = img_area_width / img_width;
let available_to_real_height_ratio = img_area_height / img_height;
let (new_cell_width, new_cell_height) =
if available_to_real_width_ratio > available_to_real_height_ratio {
(img_width, img_area_height / available_to_real_width_ratio)
} else {
(img_area_width / available_to_real_height_ratio, img_height)
};
log::debug!("new_cell stuff is {new_cell_width}x{new_cell_height}");
let width = (new_cell_width * f32::from(font_size.0)) as u32;
let height = (new_cell_height * f32::from(font_size.1)) as u32;
self.last_render = LastRender {
rect: size,
pages_shown: 1,
unused_width: 0
};
zoom.cell_pan_from_left = zoom
.cell_pan_from_left
.min(cell_w.saturating_sub(new_cell_width as u16));
zoom.cell_pan_from_top = zoom
.cell_pan_from_top
.min(cell_h.saturating_sub(new_cell_height as u16));
return KittyDisplay::DisplayImages(vec![KittyReadyToDisplay {
img,
page_num: self.page,
pos: Position {
x: img_area.x,
y: img_area.y
},
display_loc: DisplayLocation {
x: u32::from(zoom.cell_pan_from_left) * u32::from(font_size.0),
y: u32::from(zoom.cell_pan_from_top) * u32::from(font_size.1),
width,
height,
columns: img_area.width,
rows: img_area.height,
..DisplayLocation::default()
}
}]);
}
};
// here we calculate how many pages can fit in the available area. // here we calculate how many pages can fit in the available area.
let mut test_area_w = img_area.width; let mut test_area_w = img_area.width;
// go through our pages, starting at the first one we want to view // go through our pages, starting at the first one we want to view
let mut page_widths = self.rendered[self.page..] let mut page_widths = self.rendered[self.page..]
.iter_mut() .iter()
// and get this to represent a count of how many we're looking at so far to render // and get their indices (I know it's offset, we fix it down below when we actually
// render each page)
.enumerate() .enumerate()
// and only take as many as are ready to be rendered // and only take as many as are ready to be rendered
.take_while(|(idx, page)| { .take_while(|(idx, page)| {
@@ -288,9 +218,9 @@ impl Tui {
take take
}) })
// and map it to their width (in cells on the terminal, not pixels) // and map it to their width (in cells on the terminal, not pixels)
.filter_map(|(_, page)| page.img.as_mut().map(|img| (img.w_h().0, img))) .filter_map(|(idx, page)| page.img.as_ref().map(|img| (idx, img.rect().width)))
// and then take them as long as they won't overflow the available area. // and then take them as long as they won't overflow the available area.
.take_while(|(width, _)| match test_area_w.checked_sub(*width) { .take_while(|(_, width)| match test_area_w.checked_sub(*width) {
Some(new_val) => { Some(new_val) => {
test_area_w = new_val; test_area_w = new_val;
true true
@@ -306,11 +236,10 @@ impl Tui {
if page_widths.is_empty() { if page_widths.is_empty() {
// If none are ready to render, just show the loading thing // If none are ready to render, just show the loading thing
Self::render_loading_in(frame, img_area); Self::render_loading_in(frame, img_area);
KittyDisplay::ClearImages
} else { } else {
execute!(stdout(), BeginSynchronizedUpdate).unwrap(); execute!(stdout(), BeginSynchronizedUpdate).unwrap();
let total_width = page_widths.iter().map(|(w, _)| w).sum::<u16>(); let total_width = page_widths.iter().map(|(_, w)| w).sum::<u16>();
self.last_render.pages_shown = page_widths.len(); self.last_render.pages_shown = page_widths.len();
@@ -318,50 +247,32 @@ impl Tui {
self.last_render.unused_width = unused_width; self.last_render.unused_width = unused_width;
img_area.x += unused_width / 2; img_area.x += unused_width / 2;
let to_display = page_widths for (page_idx, width) in page_widths {
.into_iter() // now, theoretically, when we call this, this page should *not* be None, but we do
.enumerate() // have to account for that possibility since we can't `borrow` the image from self
.filter_map(|(idx, (width, img))| { // when passing it in to `render_single_page` since that would be a mutable
let maybe_img = // reference + an immutable reference (and also we need to potentially temporarily
Self::render_single_page(frame, img, Rect { width, ..img_area }); // remove it from the array of rendered pages to replace it with a text-rendered
img_area.x += width; // image)
maybe_img.map(|(img, pos)| KittyReadyToDisplay { self.render_single_page(frame, page_idx + self.page, Rect {
img, width,
page_num: idx + self.page, ..img_area
pos, });
display_loc: DisplayLocation::default() img_area.x += width;
}) }
})
.collect::<Vec<_>>();
// we want to set this at the very end so it doesn't get set somewhere halfway through and // we want to set this at the very end so it doesn't get set somewhere halfway through and
// then the whole diffing thing messes it up // then the whole diffing thing messes it up
self.last_render.rect = size; self.last_render.rect = size;
KittyDisplay::DisplayImages(to_display)
} }
} }
} }
fn render_single_page<'img>( fn render_single_page(&mut self, frame: &mut Frame<'_>, page_idx: usize, img_area: Rect) {
frame: &mut Frame<'_>, match self.rendered[page_idx].img {
page_img: &'img mut ConvertedImage, Some(ref page_img) => frame.render_widget(Image::new(page_img), img_area),
img_area: Rect None => Self::render_loading_in(frame, img_area)
) -> Option<(&'img mut MaybeTransferred, Position)> { };
match page_img {
ConvertedImage::Generic(page_img) => {
frame.render_widget(Image::new(page_img), img_area);
None
}
ConvertedImage::Kitty {
img,
cell_h: _,
cell_w: _
} => Some((img, Position {
x: img_area.x,
y: img_area.y
}))
}
} }
fn render_loading_in(frame: &mut Frame<'_>, area: Rect) { fn render_loading_in(frame: &mut Frame<'_>, area: Rect) {
@@ -394,8 +305,7 @@ impl Tui {
let old = self.page; let old = self.page;
match change { match change {
PageChange::Next => PageChange::Next => self.set_page((self.page + diff).min(self.rendered.len() - 1)),
self.set_page((self.page + diff).min(self.rendered.len().saturating_sub(1))),
PageChange::Prev => self.set_page(self.page.saturating_sub(diff)) PageChange::Prev => self.set_page(self.page.saturating_sub(diff))
} }
@@ -406,11 +316,13 @@ impl Tui {
} }
pub fn set_n_pages(&mut self, n_pages: usize) { pub fn set_n_pages(&mut self, n_pages: usize) {
fill_default(&mut self.rendered, n_pages); self.rendered = std::iter::from_fn(|| Some(RenderedInfo::default()))
.take(n_pages)
.collect();
self.page = self.page.min(n_pages - 1); self.page = self.page.min(n_pages - 1);
} }
pub fn page_ready(&mut self, img: ConvertedImage, page_num: usize, num_results: usize) { pub fn page_ready(&mut self, img: Protocol, page_num: usize, num_results: usize) {
// If this new image woulda fit within the available space on the last render AND it's // If this new image woulda fit within the available space on the last render AND it's
// within the range where it might've been rendered with the last shown pages, then reset // within the range where it might've been rendered with the last shown pages, then reset
// the last rect marker so that all images are forced to redraw on next render and this one // the last rect marker so that all images are forced to redraw on next render and this one
@@ -418,7 +330,7 @@ impl Tui {
if page_num >= self.page && page_num <= self.page + self.last_render.pages_shown { if page_num >= self.page && page_num <= self.page + self.last_render.pages_shown {
self.last_render.rect = Rect::default(); self.last_render.rect = Rect::default();
} else { } else {
let img_w = img.w_h().0; let img_w = img.rect().width;
if img_w <= self.last_render.unused_width { if img_w <= self.last_render.unused_width {
let num_fit = self.last_render.unused_width / img_w; let num_fit = self.last_render.unused_width / img_w;
if page_num >= self.page && (self.page + num_fit as usize) >= page_num { if page_num >= self.page && (self.page + num_fit as usize) >= page_num {
@@ -436,101 +348,10 @@ impl Tui {
}; };
} }
pub fn page_failed_display(&mut self, page_num: usize) {
self.rendered[page_num].img = None;
}
pub fn got_num_results_on_page(&mut self, page_num: usize, num_results: usize) { pub fn got_num_results_on_page(&mut self, page_num: usize, num_results: usize) {
self.rendered[page_num].num_results = Some(num_results); self.rendered[page_num].num_results = Some(num_results);
} }
pub fn render_top_and_bottom(
(top_area, bottom_area): (Rect, Rect),
page_num: usize,
rendered: &[RenderedInfo],
doc_name: &str,
frame: &mut Frame<'_>,
bottom_msg: &BottomMessage
) {
// use the extra space here to add some padding to the right side
let page_nums_text = format!("{} / {} ", page_num + 1, rendered.len());
let top_block = Block::new()
// use this first title to add a bit of padding to the left side
.title_top(" ")
.title_top(Span::styled(doc_name, Style::new().fg(Color::Cyan)))
.title_top(
Span::styled(&page_nums_text, Style::new().fg(Color::Cyan))
.into_right_aligned_line()
)
.padding(Padding {
bottom: 1,
..Padding::default()
})
.borders(Borders::BOTTOM);
frame.render_widget(top_block, top_area);
let bottom_block = Block::new()
.padding(Padding {
top: 1,
right: 2,
left: 2,
bottom: 0
})
.borders(Borders::TOP);
let bottom_inside_block = bottom_block.inner(bottom_area);
frame.render_widget(bottom_block, bottom_area);
let rendered_str = if !rendered.is_empty() {
format!(
"Rendered: {}%",
(rendered.iter().filter(|i| i.img.is_some()).count() * 100) / rendered.len()
)
} else {
String::new()
};
let bottom_layout = Layout::horizontal([
Constraint::Fill(1),
Constraint::Length(rendered_str.len() as u16)
])
.split(bottom_inside_block);
let rendered_span = Span::styled(&rendered_str, Style::new().fg(Color::Cyan));
frame.render_widget(rendered_span, bottom_layout[1]);
let (msg_str, color): (Cow<'_, str>, _) = match bottom_msg {
BottomMessage::Help => ("?: Show help page".into(), Color::Blue),
BottomMessage::Error(e) => (e.as_str().into(), Color::Red),
BottomMessage::Input(input_state) => (
match input_state {
InputCommand::GoToPage(page) => format!("Go to: {page}"),
InputCommand::Search(s) => format!("Search: {s}")
}
.into(),
Color::Blue
),
BottomMessage::SearchResults(term) => {
let num_found = rendered.iter().filter_map(|r| r.num_results).sum::<usize>();
let num_searched =
rendered.iter().filter(|r| r.num_results.is_some()).count() * 100;
(
format!(
"Results for '{term}': {num_found} (searched: {}%)",
num_searched / rendered.len()
)
.into(),
Color::Blue
)
}
BottomMessage::Reloaded => ("Document was reloaded!".into(), Color::Blue)
};
let span = Span::styled(msg_str, Style::new().fg(color));
frame.render_widget(span, bottom_layout[0]);
}
pub fn handle_event(&mut self, ev: &Event) -> Option<InputAction> { pub fn handle_event(&mut self, ev: &Event) -> Option<InputAction> {
fn jump_to_page( fn jump_to_page(
page: &mut usize, page: &mut usize,
@@ -573,23 +394,17 @@ impl Tui {
'k' => self.change_page(PageChange::Prev, ChangeAmount::WholeScreen), 'k' => self.change_page(PageChange::Prev, ChangeAmount::WholeScreen),
'q' => Some(InputAction::QuitApp), 'q' => Some(InputAction::QuitApp),
'g' => { 'g' => {
self.set_msg(MessageSetting::Some(BottomMessage::Input( self.set_bottom_msg(Some(BottomMessage::Input(
InputCommand::GoToPage(0) InputCommand::GoToPage(0)
))); )));
Some(InputAction::Redraw) Some(InputAction::Redraw)
} }
'/' => { '/' => {
self.set_msg(MessageSetting::Some(BottomMessage::Input( self.set_bottom_msg(Some(BottomMessage::Input(
InputCommand::Search(String::new()) InputCommand::Search(String::new())
))); )));
Some(InputAction::Redraw) Some(InputAction::Redraw)
} }
'i' => Some(InputAction::Invert),
'?' => {
self.showing_help_msg = true;
Some(InputAction::Redraw)
}
'f' => Some(InputAction::Fullscreen),
'n' if self.page < self.rendered.len() - 1 => { 'n' if self.page < self.rendered.len() - 1 => {
// TODO: If we can't find one, then maybe like block until we've verified // TODO: If we can't find one, then maybe like block until we've verified
// all the pages have been checked? // all the pages have been checked?
@@ -617,62 +432,6 @@ impl Tui {
jump_to_page(&mut self.page, &mut self.last_render.rect, prev_page) 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,
crossterm::event::DisableMouseCapture
)
.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,
crossterm::event::EnableMouseCapture
)
.unwrap();
self.last_render.rect = Rect::default();
Some(InputAction::Redraw)
}
'z' if self.is_kitty => {
let (zoom, f_or_f) = match self.zoom {
None => (Some(Zoom::default()), FitOrFill::Fill),
Some(_) => (None, FitOrFill::Fit)
};
self.zoom = zoom;
self.last_render.rect = Rect::default();
Some(InputAction::SwitchRenderZoom(f_or_f))
}
'o' if self.is_kitty => self.update_zoom(|z|
// TODO: for now, we don't let people zoom in past fill-screen
z.level = z.level.saturating_add(1).min(0)),
'O' if self.is_kitty =>
self.update_zoom(|z| z.level = z.level.saturating_sub(1)),
'L' if self.is_kitty => self.update_zoom(|z| {
z.cell_pan_from_left = z.cell_pan_from_left.saturating_add(1)
}),
'H' if self.is_kitty => self.update_zoom(|z| {
z.cell_pan_from_left = z.cell_pan_from_left.saturating_sub(1)
}),
'J' if self.is_kitty => self.update_zoom(|z| {
z.cell_pan_from_top = z.cell_pan_from_top.saturating_add(1)
}),
'K' if self.is_kitty => self.update_zoom(|z| {
z.cell_pan_from_top = z.cell_pan_from_top.saturating_sub(1)
}),
_ => None _ => None
} }
} }
@@ -689,39 +448,38 @@ impl Tui {
KeyCode::Down => self.change_page(PageChange::Next, ChangeAmount::WholeScreen), KeyCode::Down => self.change_page(PageChange::Next, ChangeAmount::WholeScreen),
KeyCode::Left => self.change_page(PageChange::Prev, ChangeAmount::Single), KeyCode::Left => self.change_page(PageChange::Prev, ChangeAmount::Single),
KeyCode::Up => self.change_page(PageChange::Prev, ChangeAmount::WholeScreen), KeyCode::Up => self.change_page(PageChange::Prev, ChangeAmount::WholeScreen),
KeyCode::Esc => match (self.showing_help_msg, &self.bottom_msg) { KeyCode::Esc => match self.bottom_msg {
(false, BottomMessage::Help) => Some(InputAction::QuitApp), BottomMessage::Help => Some(InputAction::QuitApp),
_ => { _ => {
// When we hit escape, we just want to pop off the current message and self.set_bottom_msg(None);
// show the underlying one.
self.set_msg(MessageSetting::Pop);
Some(InputAction::Redraw) Some(InputAction::Redraw)
} }
}, },
KeyCode::Enter => { KeyCode::Enter => {
let mut default = BottomMessage::default(); let BottomMessage::Input(_) = self.bottom_msg else {
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; 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 { match cmd {
// Only forward the command if it's within range // Only forward the command if it's within range
InputCommand::GoToPage(page) => { InputCommand::GoToPage(page) => {
// We need to subtract 1 b/c they're tracked internally as let page = *page;
// 0-indexed but input and displayed as 1-indexed
let zero_page = page.saturating_sub(1);
let rendered_len = self.rendered.len(); let rendered_len = self.rendered.len();
if zero_page < rendered_len { if page < rendered_len {
self.set_page(zero_page); self.set_page(page);
Some(InputAction::JumpingToPage(zero_page)) Some(InputAction::JumpingToPage(page))
} else { } else {
self.set_msg(MessageSetting::Some(BottomMessage::Error( self.set_bottom_msg(Some(BottomMessage::Error(
format!( format!("Cannot jump to page {page}; there are only {rendered_len} pages in the document")
"Cannot jump to page {page}; there are only {rendered_len} pages in the document"
)
))); )));
Some(InputAction::Redraw) Some(InputAction::Redraw)
} }
@@ -732,14 +490,14 @@ impl Tui {
// We only want to show search results if there would actually be // We only want to show search results if there would actually be
// data to show // data to show
if !term.is_empty() { if !term.is_empty() {
self.set_msg(MessageSetting::Some( self.set_bottom_msg(Some(BottomMessage::SearchResults(
BottomMessage::SearchResults(term.clone()) term.clone()
)); )));
} else { } else {
// else, if it's not empty, we just want to reset the bottom // 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 // area to show the default data; we don't want it to like show
// the data from a previous search // the data from a previous search
self.set_msg(MessageSetting::Reset); self.set_bottom_msg(Some(BottomMessage::Help));
} }
// Reset all the search results // Reset all the search results
@@ -756,52 +514,27 @@ impl Tui {
_ => None _ => None
} }
} }
Event::Mouse(mouse) => { Event::Mouse(mouse) => match mouse.kind {
if mouse.modifiers.contains(KeyModifiers::CONTROL) MouseEventKind::ScrollRight =>
&& self.is_kitty self.change_page(PageChange::Next, ChangeAmount::Single),
&& self.zoom.is_some() MouseEventKind::ScrollDown =>
{ self.change_page(PageChange::Next, ChangeAmount::WholeScreen),
match mouse.kind { MouseEventKind::ScrollLeft =>
MouseEventKind::ScrollUp => self.change_page(PageChange::Prev, ChangeAmount::Single),
self.update_zoom(|z| z.level = z.level.saturating_add(1).min(0)), MouseEventKind::ScrollUp =>
MouseEventKind::ScrollDown => self.change_page(PageChange::Prev, ChangeAmount::WholeScreen),
self.update_zoom(|z| z.level = z.level.saturating_sub(1)), _ => None
_ => None },
}
} else {
match mouse.kind {
MouseEventKind::ScrollRight =>
self.change_page(PageChange::Next, ChangeAmount::Single),
MouseEventKind::ScrollDown =>
self.change_page(PageChange::Next, ChangeAmount::WholeScreen),
MouseEventKind::ScrollLeft =>
self.change_page(PageChange::Prev, ChangeAmount::Single),
MouseEventKind::ScrollUp =>
self.change_page(PageChange::Prev, ChangeAmount::WholeScreen),
_ => None
}
}
}
Event::Resize(_, _) => Some(InputAction::Redraw), Event::Resize(_, _) => Some(InputAction::Redraw),
_ => None _ => None
} }
} }
// I want this to always return 0 'cause I just use it to return from `Self::handle_event`]
#[expect(clippy::unnecessary_wraps)]
fn update_zoom(&mut self, f: impl FnOnce(&mut Zoom)) -> Option<InputAction> {
if let Some(z) = &mut self.zoom {
f(z)
}
self.last_render.rect = Rect::default();
Some(InputAction::Redraw)
}
pub fn show_error(&mut self, err: RenderError) { pub fn show_error(&mut self, err: RenderError) {
self.set_msg(MessageSetting::Some(BottomMessage::Error(match err { self.set_bottom_msg(Some(BottomMessage::Error(match err {
RenderError::Notify(e) => format!("Auto-reload failed: {e}"), RenderError::Notify(e) => format!("Auto-reload failed: {e}"),
RenderError::Doc(e) => format!("Couldn't process document: {e}"), RenderError::Doc(e) => format!("Couldn't open document: {e}"),
RenderError::Converting(e) => format!("Couldn't convert page after rendering: {e}") RenderError::Render(e) => format!("Couldn't render page: {e}")
}))); })));
} }
@@ -815,106 +548,26 @@ impl Tui {
// We have `msg` as optional so that if they reset it to none, it'll replace it with // 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 // `prev_msg`, but if they reset it to something else, it'll put the current thing in prev_msg
pub fn set_msg(&mut self, msg: MessageSetting) { pub fn set_bottom_msg(&mut self, msg: Option<BottomMessage>) {
match msg { match msg {
MessageSetting::Some(mut msg) => { Some(mut msg) => {
std::mem::swap(&mut self.bottom_msg, &mut msg); std::mem::swap(&mut self.bottom_msg, &mut msg);
self.prev_msg = Some(msg); self.prev_msg = Some(msg);
} }
MessageSetting::Default => self.set_msg(MessageSetting::Some(BottomMessage::default())), None => {
MessageSetting::Reset => { let mut new_bottom = self.prev_msg.take().unwrap_or_default();
self.prev_msg = None; std::mem::swap(&mut self.bottom_msg, &mut new_bottom);
self.bottom_msg = BottomMessage::default(); self.prev_msg = Some(new_bottom);
} }
MessageSetting::Pop =>
if self.showing_help_msg {
self.last_render.rect = Rect::default();
self.showing_help_msg = false;
} else {
self.bottom_msg = self.prev_msg.take().unwrap_or_default();
},
} }
} }
pub fn render_help_msg(&self, frame: &mut Frame<'_>) {
let frame_area = frame.area();
frame.render_widget(Clear, frame_area);
let block = Block::new()
.title("Help")
.padding(Padding::proportional(1))
.borders(Borders::ALL)
.border_set(border::ROUNDED)
.border_style(Color::Blue);
let help_span = Paragraph::new(HELP_PAGE).wrap(Wrap { trim: false });
let max_w: u16 = HELP_PAGE
.lines()
.map(str::len)
.max()
.unwrap_or_default()
.try_into()
.expect("Every help text line must be shorter than u16::MAX");
let layout = Layout::horizontal([
Constraint::Fill(1),
Constraint::Length(max_w + 6),
Constraint::Fill(1)
])
.split(frame_area);
let block_area = Layout::vertical([
Constraint::Fill(1),
Constraint::Length(u16::try_from(HELP_PAGE.lines().count()).unwrap() + 4),
Constraint::Fill(1)
])
.split(layout[1]);
let block_inner = block.inner(block_area[1]);
frame.render_widget(block, block_area[1]);
frame.render_widget(help_span, block_inner);
}
} }
static HELP_PAGE: &str = "\
l, h, left, right:
Go forward/backwards a single page
j, k, down, up:
Go forwards/backwards a screen's worth of pages
q, esc:
Quit
g:
Go to specific page (type numbers after 'g')
/:
Search
n, N:
Next/Previous search result
i:
Invert colors
f:
Remove borders/fullscreen
z (when using kitty protocol):
Toggle between fill-screen and fit-screen
o/O (when on fill-screen):
zoom in and out, respectively
H, J, K, L (when zoomed in):
pan direction around page
?:
Show this page
ctrl+z:
Suspend & background tdf \
";
pub enum InputAction { pub enum InputAction {
Redraw, Redraw,
JumpingToPage(usize), JumpingToPage(usize),
Search(String), Search(String),
QuitApp, QuitApp
Invert,
Fullscreen,
SwitchRenderZoom(crate::FitOrFill)
} }
#[derive(Copy, Clone)] #[derive(Copy, Clone)]
@@ -928,10 +581,3 @@ enum ChangeAmount {
WholeScreen, WholeScreen,
Single Single
} }
pub enum MessageSetting {
Some(BottomMessage),
Default,
Reset,
Pop
}