Compare commits

..

1 Commits

Author SHA1 Message Date
itsjunetime 8dedf62cbd Actually query terminals and fix terminals if we fail initialization 2025-09-06 11:32:27 -05:00
19 changed files with 1682 additions and 1688 deletions
-2
View File
@@ -1,2 +0,0 @@
[*.rs]
indent_style = tab
-2
View File
@@ -1,4 +1,2 @@
/target
debug.log
/.envrc
/.direnv/
-21
View File
@@ -1,27 +1,6 @@
# Unreleased
- Added keybindings (`0`/`$`) to scroll to left or right side of zoomed-in image ([#131](https://github.com/itsjunetime/tdf/pull/131), thank you [@IshDeshpa](https://github.com/IshDeshpa)!)
# v0.5.0
- Switched simd base64 crate for one that works on stable (from `vb64` to `base64_simd`)
- Allow boolean arguments to function as flags, without a `true` or `false` argument following the flag itself ([#109](https://github.com/itsjunetime/tdf/pull/109), thanks [@tatounee](https://github.com/tatounee)!)
- Fix cropping issues when zooming out too much while using kitty protocol
- Added `gg` and `G` keybindings for scrolling to the top and bottom of a page, respectively, when filling the width of the screen with kitty
- Updated help page to only show kitty keybindings when you're actually using kitty
- Map page-up and page-down keybindings to do the same thing as up-key and down-key ([#115](https://github.com/itsjunetime/tdf/pull/115), thanks [@maxdexh](https://github.com/maxdexh)!)
- Vertically center pages within the available space if they are not constrained by the height ([#116](https://github.com/itsjunetime/tdf/pull/116), thanks [@maxdexh](https://github.com/maxdexh)!)
- Fixed issue with cooked mode not being restored upon panic/error ([#118](https://github.com/itsjunetime/tdf/pull/118), thanks [@maxdexh](https://github.com/maxdexh)!)
- Implemented a debounce for file reload updates to prevent some editors from paralyzing the app due to a flurry of reloads ([#117](https://github.com/itsjunetime/tdf/pull/117), thanks [@maxdexh](https://github.com/maxdexh))
- Fixed an overflow when zooming out of horizontal pdfs ([#119](https://github.com/itsjunetime/tdf/pull/119), thanks [@maxdexh](https://github.com/maxdexh)!)
- Reworked zooming to allow for full zooming in and out and panning in both directions ([#121](https://github.com/itsjunetime/tdf/pull/121), thanks [@maxdexh](https://github.com/maxdexh)!)
# v0.4.3
- Fix issue with some terminals hanging on startup
- Fix issues with some iterm2-backend terminals not displaying anything
- Allow using ctrl+scroll to zoom in/out while zoomed using kitty backend
- (Internal) run CI with `--locked` flag to ensure lockfile is always in-sync
# v0.4.2
Generated
+1219 -780
View File
File diff suppressed because it is too large Load Diff
+29 -144
View File
@@ -1,6 +1,6 @@
[package]
name = "tdf-viewer"
version = "0.5.0"
version = "0.4.2"
authors = ["June Welker <junewelker@gmail.com>"]
edition = "2024"
description = "A terminal viewer for PDFs"
@@ -23,10 +23,10 @@ name = "tdf"
[dependencies]
# 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", rev = "4209a4e7e8bff298d8f18c220eb29423c293177b", default-features = false, features = [ "crossterm", "layout-cache" ] }
ratatui = { git = "https://github.com/itsjunetime/ratatui.git" }
# ratatui = { path = "./ratatui/ratatui/" }
# We're using this to have the vb64 feature (for faster base64 encoding, since that does take up a good bit of time when converting images to the `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", rev = "cd865215737d18980379b69d20918d22f6357dda", 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 }
crossterm = { version = "0.29.0", features = ["event-stream"] }
# crossterm = { path = "../crossterm", features = ["event-stream"] }
@@ -34,37 +34,37 @@ image = { version = "0.25.1", features = ["pnm", "rayon", "png"], default-featur
notify = { version = "8.0.0", features = ["crossbeam-channel"] }
tokio = { version = "1.37.0", features = ["rt-multi-thread", "macros"] }
futures-util = { version = "0.3.30", default-features = false }
flume = { version = "0.12.0", default-features = false, features = ["async"] }
flume = { version = "0.11.0", default-features = false, features = ["async"] }
xflags = "0.4.0-pre.2"
mimalloc = "0.1.43"
nix = { version = "0.31.0", features = ["signal"] }
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 = "1", default-features = false }
rayon = { version = "*", default-features = false }
# kittage = { path = "../kittage/", features = ["crossterm-tokio", "image-crate", "log"] }
kittage = { version = "0.1.1", features = ["crossterm-tokio", "image-crate", "log"] }
memmap2 = "0"
csscolorparser = { version = "0.8.0", default-features = false }
debounce = "0.2.2"
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
console-subscriber = { version = "0.5.0", optional = true }
console-subscriber = { version = "0.4.0", optional = true }
csscolorparser = { version = "0.7.0" }
[profile.production]
inherits = "release"
lto = "fat"
[features]
default = []
default = ["nightly"]
nightly = ["ratatui-image/vb64"]
tracing = ["tokio/tracing", "dep:console-subscriber"]
epub = ["mupdf/epub"]
cbz = ["mupdf/cbz"]
[dev-dependencies]
criterion = { version = "0.8.0", features = ["async_tokio"] }
criterion = { version = "0.7.0", features = ["async_tokio"] }
cpuprofiler = "0.0.4"
[[bench]]
@@ -76,205 +76,90 @@ name = "for_profiling"
path = "./benches/for_profiling.rs"
[lints.clippy]
alloc_instead_of_core = "warn"
allow_attributes = "warn"
as_pointer_underscore = "warn"
as_ptr_cast_mut = "warn"
as_underscore = "warn"
uninlined_format_args = "warn"
redundant_closure_for_method_calls = "warn"
cast_lossless = "warn"
single_char_pattern = "warn"
manual_let_else = "warn"
ignored_unit_patterns = "warn"
range_plus_one = "warn"
unreadable_literal = "warn"
redundant_else = "warn"
assigning_clones = "warn"
assertions_on_result_states = "warn"
bool_to_int_with_if = "warn"
borrow_as_ptr = "warn"
branches_sharing_code = "warn"
cargo_common_metadata = "warn"
case_sensitive_file_extension_comparisons = "warn"
cast_lossless = "warn"
cast_ptr_alignment = "warn"
cfg_not_test = "warn"
checked_conversions = "warn"
clear_with_drain = "warn"
cloned_instead_of_copied = "warn"
coerce_container_to_any = "warn"
comparison_chain = "warn"
copy_iterator = "warn"
create_dir = "warn"
debug_assert_with_mut_call = "warn"
decimal_literal_representation = "warn"
default_trait_access = "warn"
deref_by_slicing = "warn"
doc_broken_link = "warn"
doc_link_code = "warn"
doc_link_with_quotes = "warn"
elidable_lifetime_names = "warn"
empty_drop = "warn"
empty_enums = "warn"
empty_enum_variants_with_brackets = "warn"
empty_structs_with_brackets = "warn"
equatable_if_let = "warn"
error_impl_error = "warn"
expl_impl_clone_on_copy = "warn"
explicit_deref_methods = "warn"
empty_enum = "warn"
explicit_into_iter_loop = "warn"
explicit_iter_loop = "warn"
fallible_impl_from = "warn"
filetype_is_file = "warn"
filter_map_next = "warn"
flat_map_option = "warn"
fn_to_numeric_cast_any = "warn"
fn_params_excessive_bools = "warn"
format_collect = "warn"
format_push_string = "warn"
get_unwrap = "warn"
if_then_some_else_none = "warn"
ignore_without_reason = "warn"
ignored_unit_patterns = "warn"
from_iter_instead_of_collect = "warn"
implicit_clone = "warn"
imprecise_flops = "warn"
index_refutable_slice = "warn"
indexing_slicing = "allow" # can't warn on this cause we basically have to do indexing for some ratatui apis
infinite_loop = "warn"
inefficient_to_string = "warn"
invalid_upcast_comparisons = "warn"
ip_constant = "warn"
iter_filter_is_ok = "warn"
iter_filter_is_some = "warn"
iter_not_returning_iterator = "warn"
iter_on_empty_collections = "warn"
iter_on_single_items = "warn"
large_digit_groups = "warn"
large_futures = "warn"
large_include_file = "warn"
large_stack_frames = "warn"
large_stack_arrays = "warn"
large_types_passed_by_value = "warn"
linkedlist = "warn"
literal_string_with_formatting_args = "warn"
lossy_float_literal = "warn"
macro_use_imports = "warn"
manual_assert = "warn"
manual_instant_elapsed = "warn"
manual_is_power_of_two = "warn"
manual_is_variant_and = "warn"
manual_let_else = "warn"
manual_midpoint = "warn"
manual_ok_or = "warn"
manual_string_new = "warn"
many_single_char_names = "warn"
map_err_ignore = "warn"
map_unwrap_or = "warn"
map_with_unused_argument_over_ranges = "warn"
manual_unwrap_or = "warn"
match_same_arms = "warn"
match_wild_err_arm = "warn"
match_wildcard_for_single_variants = "warn"
maybe_infinite_iter = "warn"
mem_forget = "warn"
mismatching_type_param_order = "warn"
missing_assert_message = "warn"
missing_fields_in_debug = "warn"
mixed_read_write_in_expression = "warn"
multiple_unsafe_ops_per_block = "warn"
must_use_candidate = "warn"
mut_mut = "warn"
mutex_atomic = "warn"
mutex_integer = "warn"
naive_bytecount = "warn"
needless_bitwise_bool = "warn"
needless_collect = "warn"
needless_continue = "warn"
needless_for_each = "warn"
needless_pass_by_ref_mut = "warn"
needless_pass_by_value = "warn"
needless_raw_string_hashes = "warn"
needless_raw_strings = "warn"
negative_feature_names = "warn"
no_effect_underscore_binding = "warn"
no_mangle_with_rust_abi = "warn"
non_send_fields_in_send_ty = "warn"
non_std_lazy_statics = "warn"
non_zero_suggestions = "warn"
nonstandard_macro_braces = "warn"
option_as_ref_cloned = "warn"
option_option = "warn"
or_fun_call = "warn"
path_buf_push_overwrite = "warn"
pathbuf_init_then_push = "warn"
precedence_bits = "warn"
ptr_as_ptr = "warn"
ptr_cast_constness = "warn"
pub_underscore_fields = "warn"
pub_without_shorthand = "warn"
range_minus_one = "warn"
range_plus_one = "warn"
rc_buffer = "warn"
rc_mutex = "warn"
read_zero_byte_vec = "warn"
redundant_clone = "warn"
redundant_closure_for_method_calls = "warn"
redundant_else = "warn"
redundant_pub_crate = "warn"
redundant_test_prefix = "warn"
ref_as_ptr = "warn"
ref_binding_to_reference = "warn"
ref_option = "warn"
ref_option_ref = "warn"
rest_pat_in_fully_bound_structs = "warn"
return_self_not_must_use = "warn"
same_functions_in_if_condition = "warn"
self_named_module_files = "warn"
semicolon_if_nothing_returned = "warn"
semicolon_inside_block = "warn"
should_panic_without_expect = "warn"
significant_drop_in_scrutinee = "warn" # I thought this was fixed in the 2024 edition. watever
significant_drop_tightening = "warn"
single_char_pattern = "warn"
single_option_map = "warn"
similar_names = "warn"
stable_sort_primitive = "warn"
str_split_at_newline = "warn"
string_lit_as_bytes = "warn"
string_lit_chars_any = "warn"
string_slice = "warn"
struct_excessive_bools = "warn"
struct_field_names = "warn"
suboptimal_flops = "warn"
suspicious_operation_groupings = "warn"
suspicious_xor_used_as_pow = "warn"
tests_outside_test_module = "warn"
trait_duplication_in_bounds = "warn"
transmute_ptr_to_ptr = "warn"
trivial_regex = "warn"
trivially_copy_pass_by_ref = "warn"
try_err = "warn"
tuple_array_conversions = "warn"
type_repetition_in_bounds = "warn"
unchecked_time_subtraction = "warn"
undocumented_unsafe_blocks = "warn"
unicode_not_nfc = "warn"
uninhabited_references = "warn"
uninlined_format_args = "warn"
unnecessary_box_returns = "warn"
unnecessary_debug_formatting = "warn"
unnecessary_join = "warn"
unnecessary_literal_bound = "warn"
unnecessary_safety_comment = "warn"
unnecessary_safety_doc = "warn"
unnecessary_self_imports = "warn"
unnecessary_semicolon = "warn"
unnecessary_struct_initialization = "warn"
unnecessary_wraps = "warn"
unnested_or_patterns = "warn"
unreadable_literal = "warn"
unsafe_derive_deserialize = "warn"
unused_async = "warn"
unused_peekable = "warn"
unused_result_ok = "warn"
unused_rounding = "warn"
unused_self = "warn"
unused_trait_names = "warn"
use_self = "warn"
used_underscore_binding = "warn"
used_underscore_items = "warn"
useless_let_if_seq = "warn"
verbose_bit_mask = "warn"
verbose_file_reads = "warn"
volatile_composites = "warn"
while_float = "warn"
wildcard_dependencies = "warn"
wildcard_imports = "warn"
zero_sized_map_values = "warn"
+3 -9
View File
@@ -16,9 +16,7 @@ Designed to be performant, very responsive, and work well with even very large P
## Installation
1. Get the rust toolchain from [rustup.rs](https://rustup.rs)
2. Run `cargo install --git https://github.com/itsjunetime/tdf.git`
If you want to use this with `epub`s or `cbz`s, add `--features epub` or `--features cbz` to the command line (or `--features cbz,epub` for both)
2. Run `rustup install nightly && cargo +nightly install --git https://github.com/itsjunetime/tdf.git`
## 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`.
@@ -27,12 +25,10 @@ If it turns out that you're missing one of these, it will fail to compile and te
1. Get the rust toolchain from [rustup.rs](https://rustup.rs)
2. Clone the repo and `cd` into it
3. Run `cargo build --release`
3. Run `cargo +nightly build --release`
The binary should then be found at `./target/release/tdf`.
You can also pull this in via [radicle](https://radicle.xyz) with `rad clone rad:zb11K1XGfQooopqEfwtCMyvbcyK1`
## Why in the world would you use this?
I dunno. Just for fun, mostly.
@@ -41,6 +37,4 @@ I dunno. Just for fun, mostly.
Yeah, sure. Please do.
Please note, though, that:
1. No AI-generated or AI-assisted or AI-viewed or AI-anythinged code will be accepted. "AI" is a plague upon this earth and I won't be caught dead pretending it's normal.
2. All contributions will be treated as licensed under MPL-2.0 :)
Please note, though, that all contributions will be treated as licensed under MPL-2.0.
+1 -3
View File
@@ -1,5 +1,3 @@
use ratatui_image::picker::ProtocolType;
mod utils;
const BLACK: i32 = 0;
@@ -14,5 +12,5 @@ async fn main() {
.nth(1)
.expect("Please enter a file to profile");
utils::render_doc(file, None, BLACK, WHITE, ProtocolType::Kitty).await;
utils::render_doc(file, None, BLACK, WHITE).await;
}
+65 -81
View File
@@ -1,15 +1,17 @@
mod utils;
use std::{hint::black_box, path::Path};
use std::{
hint::black_box,
path::Path,
time::{SystemTime, UNIX_EPOCH}
};
use criterion::{BenchmarkId, Criterion, criterion_group, criterion_main};
use futures_util::StreamExt as _;
use ratatui_image::picker::ProtocolType;
use criterion::{BenchmarkId, Criterion, criterion_group, criterion_main, profiler::Profiler};
use futures_util::StreamExt;
use tdf::{
converter::{ConvertedPage, ConverterMsg},
renderer::{PageInfo, RenderInfo, fill_default}
};
use tokio::runtime::Runtime;
use utils::{
RenderState, handle_converter_msg, handle_renderer_msg, render_doc, start_all_rendering,
start_converting_loop, start_rendering_loop
@@ -21,103 +23,90 @@ const FILES: [&str; 3] = [
"benches/geotopo.pdf"
];
const PROTOS: [ProtocolType; 3] = [
ProtocolType::Kitty,
ProtocolType::Sixel,
ProtocolType::Iterm2
];
const BLACK: i32 = 0;
const WHITE: i32 = i32::from_be_bytes([0, 0xff, 0xff, 0xff]);
fn for_all_combos(
name: &'static str,
mut f: impl FnMut(&Runtime, BenchmarkId, &'static str, ProtocolType)
) {
let rt = tokio::runtime::Runtime::new().unwrap();
for proto in PROTOS {
for file in FILES {
f(
&rt,
BenchmarkId::new(name, format!("{file},{proto:?}")),
file,
proto
);
}
}
}
fn render_full(c: &mut Criterion) {
for_all_combos("render_full", |rt, id, file, proto| {
_ = c.bench_with_input(id, &file, |b, &file| {
b.to_async(rt)
.iter(|| render_doc(file, None, BLACK, WHITE, proto));
});
for file in FILES {
c.bench_with_input(BenchmarkId::new("render_full", file), &file, |b, &file| {
b.to_async(tokio::runtime::Runtime::new().unwrap())
.iter(|| render_doc(file, None, BLACK, WHITE))
});
}
}
fn render_to_first_page(c: &mut Criterion) {
for_all_combos("render_first_page", |rt, id, file, proto| {
c.bench_with_input(id, &file, |b, &file| {
b.to_async(rt)
.iter(|| render_first_page(file, BLACK, WHITE, proto));
});
});
for file in FILES {
c.bench_with_input(
BenchmarkId::new("render_first_page", file),
&file,
|b, &file| {
b.to_async(tokio::runtime::Runtime::new().unwrap())
.iter(|| render_first_page(file, BLACK, WHITE))
}
);
}
}
fn only_converting(c: &mut Criterion) {
for_all_combos("only_converting", |rt, id, file, proto| {
let all_rendered = rt.block_on(render_all_files(file, BLACK, WHITE));
for file in FILES {
let runtime = tokio::runtime::Runtime::new().unwrap();
let all_rendered = runtime.block_on(render_all_files(file, BLACK, WHITE));
c.bench_with_input(id, &all_rendered, |b, rendered| {
b.to_async(rt)
.iter_with_setup(|| rendered.clone(), |f| convert_all_files(f, proto));
});
});
c.bench_with_input(
BenchmarkId::new("only_converting", file),
&(all_rendered, file),
|b, (rendered, _)| {
b.to_async(tokio::runtime::Runtime::new().unwrap())
.iter_with_setup(|| rendered.clone(), convert_all_files)
}
);
}
}
/*
fn search_short_common(c: &mut Criterion) {
for_all_combos("search_short_common", |rt, id, file, proto| {
c.bench_with_input(id, &file, |b, &file| {
b.to_async(rt)
.iter(|| render_doc(file, Some("an"), BLACK, WHITE, proto))
});
});
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_all_combos("search_long_rare", |rt, id, file, proto| {
c.bench_with_input(id, &file, |b, &file| {
b.to_async(rt)
.iter(|| render_doc(file, Some("this is long and rare"), BLACK, WHITE, proto))
});
});
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,
proto: ProtocolType
) {
pub async fn render_first_page(path: impl AsRef<Path>, black: i32, white: i32) {
let RenderState {
mut from_render_rx,
mut from_converter_rx,
mut pages,
to_converter_tx,
mut to_converter_tx,
to_render_tx
} = start_all_rendering(path, black, white, proto);
} = start_all_rendering(path, black, white);
// we only want to render until the first page is ready to be printed
while pages.iter().all(Option::is_none) {
tokio::select! {
Some(renderer_msg) = from_render_rx.next() => {
handle_renderer_msg(renderer_msg, &mut pages, &to_converter_tx);
handle_renderer_msg(renderer_msg, &mut pages, &mut to_converter_tx);
},
Some(converter_msg) = from_converter_rx.next() => {
handle_converter_msg(converter_msg, &mut pages, &to_converter_tx);
handle_converter_msg(converter_msg, &mut pages, &mut to_converter_tx);
}
}
}
@@ -140,7 +129,7 @@ async fn render_all_files(path: &'static str, black: i32, white: i32) -> Vec<Pag
let num = page.page_num;
pages[num] = Some(page);
}
}
};
if pages.iter().all(Option::is_some) {
break;
@@ -151,9 +140,9 @@ async fn render_all_files(path: &'static str, black: i32, white: i32) -> Vec<Pag
pages.into_iter().flatten().collect()
}
async fn convert_all_files(files: Vec<PageInfo>, proto: ProtocolType) {
async fn convert_all_files(files: Vec<PageInfo>) {
let num_files = files.len();
let (mut from_converter_rx, to_converter_tx) = start_converting_loop(proto, num_files);
let (mut from_converter_rx, to_converter_tx) = start_converting_loop(num_files);
to_converter_tx
.send(ConverterMsg::NumPages(num_files))
@@ -192,12 +181,10 @@ async fn convert_all_files(files: Vec<PageInfo>, proto: ProtocolType) {
black_box(converted);
}
/*
struct CpuProfiler;
impl criterion::profiler::Profiler for CpuProfiler {
impl Profiler for CpuProfiler {
fn start_profiling(&mut self, benchmark_id: &str, _: &std::path::Path) {
use std::time::{SystemTime, UNIX_EPOCH}
let file = format!(
"./{}-{}.profile",
benchmark_id.replace('/', "-"),
@@ -213,13 +200,10 @@ impl criterion::profiler::Profiler for CpuProfiler {
cpuprofiler::PROFILER.lock().unwrap().stop().unwrap();
}
}
*/
criterion_group!(
name = benches;
// config = Criterion::default().sample_size(40).with_profiler(CpuProfiler);
config = Criterion::default().sample_size(40);
// targets = render_full, render_to_first_page, only_converting, search_short_common, search_long_rare
targets = render_full, render_to_first_page, only_converting
config = Criterion::default().sample_size(40).with_profiler(CpuProfiler);
targets = render_full, render_to_first_page, only_converting, search_short_common, search_long_rare
);
criterion_main!(benches);
+12 -25
View File
@@ -13,7 +13,7 @@ use tdf::{
pub fn handle_renderer_msg(
msg: Result<RenderInfo, RenderError>,
pages: &mut Vec<Option<ConvertedPage>>,
to_converter_tx: &Sender<tdf::converter::ConverterMsg>
to_converter_tx: &mut Sender<tdf::converter::ConverterMsg>
) {
match msg {
Ok(RenderInfo::NumPages(num)) => {
@@ -30,7 +30,7 @@ pub fn handle_renderer_msg(
pub fn handle_converter_msg(
msg: Result<ConvertedPage, RenderError>,
pages: &mut [Option<ConvertedPage>],
to_converter_tx: &Sender<ConverterMsg>
to_converter_tx: &mut Sender<ConverterMsg>
) {
let page = msg.expect("Got error from converter");
let num = page.num;
@@ -65,6 +65,7 @@ pub fn start_rendering_loop(
Sender<RenderNotif>
) {
let pathbuf = path.as_ref().canonicalize().unwrap();
let str_path = pathbuf.into_os_string().to_string_lossy().to_string();
let (to_render_tx, from_main_rx) = unbounded();
let (to_main_tx, from_render_rx) = unbounded();
@@ -90,7 +91,7 @@ pub fn start_rendering_loop(
let cell_width_px = size.width / size.columns;
std::thread::spawn(move || {
start_rendering(
&pathbuf,
&str_path,
to_main_tx,
from_main_rx,
cell_height_px,
@@ -105,9 +106,7 @@ pub fn start_rendering_loop(
(from_render_rx, to_render_tx)
}
#[must_use]
pub fn start_converting_loop(
proto: ProtocolType,
prerender: usize
) -> (
RecvStream<'static, Result<ConvertedPage, RenderError>>,
@@ -116,9 +115,8 @@ pub fn start_converting_loop(
let (to_converter_tx, from_main_rx) = unbounded();
let (to_main_tx, from_converter_rx) = unbounded();
#[expect(deprecated)]
let mut picker = Picker::from_fontsize(FONT_SIZE);
picker.set_protocol_type(proto);
picker.set_protocol_type(ProtocolType::Kitty);
tokio::spawn(run_conversion_loop(
to_main_tx,
@@ -133,14 +131,9 @@ pub fn start_converting_loop(
(from_converter_rx, to_converter_tx)
}
pub fn start_all_rendering(
path: impl AsRef<Path>,
black: i32,
white: i32,
proto: ProtocolType
) -> RenderState {
pub fn start_all_rendering(path: impl AsRef<Path>, black: i32, white: i32) -> RenderState {
let (from_render_rx, to_render_tx) = start_rendering_loop(path, black, white);
let (from_converter_rx, to_converter_tx) = start_converting_loop(proto, 20);
let (from_converter_rx, to_converter_tx) = start_converting_loop(20);
let pages: Vec<Option<ConvertedPage>> = Vec::new();
@@ -153,20 +146,14 @@ pub fn start_all_rendering(
}
}
pub async fn render_doc(
path: impl AsRef<Path>,
search_term: Option<&str>,
black: i32,
white: i32,
proto: ProtocolType
) {
pub async fn render_doc(path: impl AsRef<Path>, search_term: Option<&str>, black: i32, white: i32) {
let RenderState {
mut from_render_rx,
mut from_converter_rx,
mut pages,
to_converter_tx,
mut to_converter_tx,
to_render_tx
} = start_all_rendering(path, black, white, proto);
} = start_all_rendering(path, black, white);
if let Some(term) = search_term {
to_render_tx
@@ -177,10 +164,10 @@ pub async fn render_doc(
while pages.is_empty() || pages.iter().any(Option::is_none) {
tokio::select! {
Some(renderer_msg) = from_render_rx.next() => {
handle_renderer_msg(renderer_msg, &mut pages, &to_converter_tx);
handle_renderer_msg(renderer_msg, &mut pages, &mut to_converter_tx);
},
Some(converter_msg) = from_converter_rx.next() => {
handle_converter_msg(converter_msg, &mut pages, &to_converter_tx);
handle_converter_msg(converter_msg, &mut pages, &mut to_converter_tx);
}
}
}
+1 -1
Submodule ratatui updated: 4209a4e7e8...47c200fb7f
-11
View File
@@ -1,11 +0,0 @@
{
pkgs ? import <nixpkgs> { },
}:
pkgs.mkShell {
nativeBuildInputs = [ pkgs.pkg-config ];
buildInputs = [
pkgs.rustPlatform.bindgenHook
pkgs.cairo
];
}
+12 -15
View File
@@ -1,19 +1,19 @@
use std::{
num::NonZeroUsize,
num::{NonZeroU32, NonZeroUsize},
time::{SystemTime, UNIX_EPOCH}
};
use flume::{Receiver, SendError, Sender, TryRecvError};
use futures_util::stream::StreamExt as _;
use futures_util::stream::StreamExt;
use image::DynamicImage;
use kittage::{NumberOrId, action::NONZERO_ONE};
use kittage::NumberOrId;
use ratatui::layout::Rect;
use ratatui_image::{
Resize,
picker::{Picker, ProtocolType},
protocol::Protocol
};
use rayon::iter::ParallelIterator as _;
use rayon::iter::ParallelIterator;
use crate::{
renderer::{PageInfo, RenderError, fill_default},
@@ -37,7 +37,6 @@ pub enum ConvertedImage {
}
impl ConvertedImage {
#[must_use]
pub fn w_h(&self) -> (u16, u16) {
match self {
Self::Generic(prot) => {
@@ -68,7 +67,7 @@ pub enum ConverterMsg {
pub async fn run_conversion_loop(
sender: Sender<Result<ConvertedPage, RenderError>>,
receiver: Receiver<ConverterMsg>,
picker: Picker,
mut picker: Picker,
prerender: usize,
shms_work: bool
) -> Result<(), SendError<Result<ConvertedPage, RenderError>>> {
@@ -78,7 +77,7 @@ pub async fn run_conversion_loop(
fn next_page(
images: &mut [Option<PageInfo>],
picker: &Picker,
picker: &mut Picker,
page: usize,
iteration: &mut usize,
prerender: usize,
@@ -127,7 +126,7 @@ pub async fn run_conversion_loop(
.for_each(|(_, _, px)| px.0[2] = px.0[2].saturating_sub(u8::MAX / 2));
},
_ => unreachable!()
}
};
let img_area = Rect {
width: page_info.img_data.cell_w,
@@ -141,20 +140,18 @@ pub async fn run_conversion_loop(
let rn = SystemTime::now()
.duration_since(UNIX_EPOCH)
.unwrap_or_default()
.as_nanos() % 1_000_000;
.as_millis() % 1_000_000;
let mut img = if shms_work {
kittage::image::Image::shm_from(dyn_img, &format!("/tdf_{pid}_{rn}_{page_num}"))
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:?}"))
RenderError::Converting(format!("Couldn't write to shm: {e}"))
})?
} else {
kittage::image::Image::from(dyn_img)
};
// if ur pdf has 4 billion pages then you deserve to suffer
img.num_or_id = NumberOrId::Id(NONZERO_ONE.saturating_add(page_num as u32));
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,
@@ -217,7 +214,7 @@ pub async fn run_conversion_loop(
match next_page(
&mut images,
&picker,
&mut picker,
page,
&mut iteration,
prerender,
+2 -2
View File
@@ -60,8 +60,8 @@ impl<W: Write> Write for DbgWriter<W> {
}
}
pub async fn run_action<'es>(
action: Action<'_, '_>,
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 {
-1
View File
@@ -27,7 +27,6 @@ pub struct ScaledResult {
scale_factor: f32
}
#[must_use]
pub fn scale_img_for_area(
(img_width, img_height): (f32, f32),
(area_width, area_height): (f32, f32),
+64 -102
View File
@@ -5,11 +5,8 @@ use core::{
use std::{
borrow::Cow,
ffi::OsString,
io::{BufReader, Read as _, Stdout, Write as _, stdout},
mem,
path::PathBuf,
sync::{Arc, Mutex},
time::Duration
io::{BufReader, Read, Stdout, Write, stdout},
path::PathBuf
};
use crossterm::{
@@ -20,16 +17,15 @@ use crossterm::{
enable_raw_mode, window_size
}
};
use debounce::EventDebouncer;
use flexi_logger::FileSpec;
use flume::{Sender, r#async::RecvStream};
use futures_util::{FutureExt as _, stream::StreamExt as _};
use futures_util::{FutureExt, stream::StreamExt};
use kittage::{
action::Action,
delete::{ClearOrDelete, DeleteConfig, WhichToDelete},
error::{TerminalError, TransmitError}
};
use notify::{Event, EventKind, RecursiveMode, Watcher as _};
use notify::{Event, EventKind, RecursiveMode, Watcher};
use ratatui::{Terminal, backend::CrosstermBackend};
use ratatui_image::{
FontSize,
@@ -39,7 +35,7 @@ use tdf::{
PrerenderLimit,
converter::{ConvertedPage, ConverterMsg, run_conversion_loop},
kitty::{KittyDisplay, display_kitty_images, do_shms_work, run_action},
renderer::{self, MUPDF_BLACK, MUPDF_WHITE, RenderError, RenderInfo, RenderNotif},
renderer::{self, RenderError, RenderInfo, RenderNotif},
tui::{BottomMessage, InputAction, MessageSetting, Tui}
};
@@ -61,20 +57,17 @@ impl std::fmt::Debug for WrappedErr {
impl std::error::Error for WrappedErr {}
fn reset_term() {
_ = disable_raw_mode();
_ = execute!(
std::io::stdout(),
LeaveAlternateScreen,
crossterm::cursor::Show,
crossterm::event::DisableMouseCapture
);
)
}
#[tokio::main]
async fn main() -> Result<(), WrappedErr> {
let result = inner_main().await;
reset_term();
result
inner_main().await.inspect_err(|_| reset_term())
}
async fn inner_main() -> Result<(), WrappedErr> {
@@ -87,19 +80,14 @@ async fn inner_main() -> Result<(), WrappedErr> {
#[cfg(feature = "tracing")]
console_subscriber::init();
const DEFAULT_DEBOUNCE_DELAY: Duration = Duration::from_millis(50);
let flags = xflags::parse_or_exit! {
/// Display the pdf with the pages starting at the right hand size and moving left and
/// adjust input keys to match
optional -r,--r-to-l
optional -r,--r-to-l r_to_l: bool
/// The maximum number of pages to display together, horizontally, at a time
optional -m,--max-wide max_wide: NonZeroUsize
/// Fullscreen the pdf (hide document name, page count, etc)
optional -f,--fullscreen
/// The time to wait for the file to stop changing before reloading, in milliseconds.
/// Defaults to 50ms.
optional --reload-delay reload_delay: u64
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
@@ -128,42 +116,28 @@ async fn inner_main() -> Result<(), WrappedErr> {
.canonicalize()
.map_err(|e| WrappedErr(format!("Cannot canonicalize provided file: {e}").into()))?;
let black = flags
.black_color
.as_deref()
.map(|color| {
parse_color_to_i32(color).map_err(|e| {
let black =
parse_color_to_i32(flags.black_color.as_deref().unwrap_or("000000")).map_err(|e| {
WrappedErr(
format!(
"Couldn't parse black color {color:?}: {e} - is it formatted like a CSS color?"
)
format!("Couldn't parse black color: {e} - is it formatted like a CSS color?")
.into()
)
})
})
.transpose()?
.unwrap_or(MUPDF_BLACK);
})?;
let white = flags
.white_color
.as_deref()
.map(|color| {
parse_color_to_i32(color).map_err(|e| {
let white =
parse_color_to_i32(flags.white_color.as_deref().unwrap_or("FFFFFF")).map_err(|e| {
WrappedErr(
format!(
"Couldn't parse white color {color:?}: {e} - is it formatted like a CSS color?"
)
format!("Couldn't parse white color: {e} - is it formatted like a CSS color?")
.into()
)
})
})
.transpose()?
.unwrap_or(MUPDF_WHITE);
})?;
// 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 maybe_logger = if std::env::var("RUST_LOG").is_ok() {
Some(
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| {
@@ -171,10 +145,8 @@ async fn inner_main() -> Result<(), WrappedErr> {
})?)
.start()
.map_err(|e| WrappedErr(format!("Can't start logger: {e}").into()))?
)
} else {
None
};
);
}
let (watch_to_render_tx, render_rx) = flume::unbounded();
let to_renderer = watch_to_render_tx.clone();
@@ -186,11 +158,8 @@ async fn inner_main() -> Result<(), WrappedErr> {
watch_to_tui_tx,
watch_to_render_tx,
path.file_name()
.ok_or_else(|| WrappedErr("Path does not have a last component??".into()))?
.to_owned(),
flags
.reload_delay
.map_or(DEFAULT_DEBOUNCE_DELAY, Duration::from_millis)
.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()))?;
@@ -209,6 +178,10 @@ async fn inner_main() -> Result<(), WrappedErr> {
)
.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
// mupdf stuff instead of a rust string?
let file_path = path.clone().into_os_string().to_string_lossy().to_string();
let mut window_size = window_size().map_err(|e| {
WrappedErr(format!("Can't get your current terminal window size: {e}").into())
})?;
@@ -246,13 +219,8 @@ async fn inner_main() -> Result<(), WrappedErr> {
window_size.width != 0
&& window_size.height != 0
&& window_size.columns != 0
&& window_size.rows != 0 =>
{
// the 'equivalent' that is suggested instead is not the same. We need to keep
// calling this.
#[expect(deprecated)]
Ok(Picker::from_fontsize((cell_width_px, cell_height_px)))
},
&& 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()
)),
@@ -267,7 +235,6 @@ async fn inner_main() -> Result<(), WrappedErr> {
.and_then(NonZeroUsize::new)
.map_or(PrerenderLimit::All, PrerenderLimit::Limited);
let file_path = path.clone();
std::thread::spawn(move || {
renderer::start_rendering(
&file_path,
@@ -300,7 +267,12 @@ async fn inner_main() -> Result<(), WrappedErr> {
|| "Unknown file".into(),
|n| n.to_string_lossy().to_string()
);
let tui = Tui::new(file_name, flags.max_wide, flags.r_to_l, is_kitty);
let tui = Tui::new(
file_name,
flags.max_wide,
flags.r_to_l.unwrap_or_default(),
is_kitty
);
let backend = CrosstermBackend::new(std::io::stdout());
let mut term = Terminal::new(backend).map_err(|e| {
@@ -328,7 +300,7 @@ async fn inner_main() -> Result<(), WrappedErr> {
})?;
}
let fullscreen = flags.fullscreen;
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))
@@ -363,7 +335,17 @@ async fn inner_main() -> Result<(), WrappedErr> {
)
})?;
execute!(
term.backend_mut(),
LeaveAlternateScreen,
crossterm::cursor::Show,
crossterm::event::DisableMouseCapture
)
.unwrap();
disable_raw_mode().unwrap();
drop(maybe_logger);
Ok(())
}
@@ -484,32 +466,12 @@ async fn enter_redraw_loop(
fn on_notify_ev(
to_tui_tx: flume::Sender<Result<RenderInfo, RenderError>>,
to_render_tx: flume::Sender<RenderNotif>,
file_name: OsString,
debounce_delay: Duration
file_name: OsString
) -> impl Fn(notify::Result<Event>) {
let last_event: Mutex<Result<(), RenderError>> = Mutex::new(Ok(()));
let last_event = Arc::new(last_event);
let debouncer = EventDebouncer::new(debounce_delay, {
let last_event = last_event.clone();
move |()| {
let event = mem::replace(&mut *last_event.lock().unwrap(), Ok(()));
match event {
// 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.
Ok(()) => to_render_tx.send(RenderNotif::Reload).unwrap(),
move |res| match res {
// If we get an error here, and then an error sending, everything's going wrong. Just give
// up lol.
Err(e) => to_tui_tx.send(Err(e)).unwrap()
}
}
});
move |res| {
let event = match res {
Err(e) => Err(RenderError::Notify(e)),
Err(e) => to_tui_tx.send(Err(RenderError::Notify(e))).unwrap(),
// TODO: Should we match EventKind::Rename and propogate that so that the other parts of the
// process know that too? Or should that be
Ok(ev) => {
@@ -525,17 +487,17 @@ fn on_notify_ev(
}
match ev.kind {
EventKind::Access(_) => return,
EventKind::Remove(_) => Err(RenderError::Converting("File was deleted".into())),
EventKind::Other
| EventKind::Any
| EventKind::Create(_)
| EventKind::Modify(_) => Ok(())
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(),
}
}
};
*last_event.lock().unwrap() = event;
debouncer.put(());
}
}
@@ -592,18 +554,18 @@ fn get_font_size_through_stdio() -> Result<(u16, u16), WrappedErr> {
));
};
let h = h.parse::<u16>().map_err(|e| {
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: {e}"
"Your terminal said its height is {h}, but that is not a 16-bit unsigned integer"
)
.into()
)
})?;
let w = w.parse::<u16>().map_err(|e| {
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: {e}"
"Your terminal said its width is {w}, but that is not a 16-bit unsigned integer"
)
.into()
)
+12 -23
View File
@@ -1,4 +1,4 @@
use std::{collections::VecDeque, num::NonZeroUsize, path::Path, thread::sleep, time::Duration};
use std::{collections::VecDeque, num::NonZeroUsize, thread::sleep, time::Duration};
use flume::{Receiver, SendError, Sender, TryRecvError};
use mupdf::{
@@ -57,8 +57,8 @@ struct PrevRender {
num_search_found: Option<usize>
}
pub const MUPDF_BLACK: i32 = 0;
pub const MUPDF_WHITE: i32 = i32::from_be_bytes([0, 0xff, 0xff, 0xff]);
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) {
@@ -78,9 +78,9 @@ 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
// 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.
#[expect(clippy::needless_pass_by_value, clippy::too_many_arguments)]
#[allow(clippy::needless_pass_by_value, clippy::too_many_arguments)]
pub fn start_rendering(
path: &Path,
path: &str,
sender: Sender<Result<RenderInfo, RenderError>>,
receiver: Receiver<RenderNotif>,
col_h: u16,
@@ -116,7 +116,7 @@ pub fn start_rendering(
// temporarily removed to facilitate a save or something like that)
while let Ok(msg) = receiver.recv() {
// and once that comes, just try to reload again
if matches!(msg, RenderNotif::Reload) {
if let RenderNotif::Reload = msg {
continue 'reload;
}
}
@@ -152,8 +152,8 @@ pub fn start_rendering(
sender.send(Ok(RenderInfo::NumPages(n_pages.get())))?;
// We're using this vec to indicate which page numbers have already been rendered, to
// support people jumping to specific pages and having quick rendering results. We
// 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
// `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,
// then we can split at that page and render at both sides of it
@@ -313,7 +313,7 @@ pub fn start_rendering(
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}");
@@ -341,7 +341,7 @@ pub fn start_rendering(
Err(TryRecvError::Disconnected) => return Ok(()),
Ok(notif) => handle_notif!(notif),
Err(TryRecvError::Empty) => ()
}
};
}
// Now, if we have a search term, we want to look through the rest of the document past
@@ -434,7 +434,7 @@ pub fn start_rendering(
return Ok(());
};
handle_notif!(msg);
handle_notif!(msg)
}
}
}
@@ -565,20 +565,9 @@ struct PopOnNext<'a> {
inner: &'a mut VecDeque<usize>
}
impl Iterator for PopOnNext<'_> {
impl<'a> Iterator for PopOnNext<'a> {
type Item = usize;
fn next(&mut self) -> Option<Self::Item> {
self.inner.pop_front()
}
fn size_hint(&self) -> (usize, Option<usize>) {
let l = self.len();
(l, Some(l))
}
}
impl ExactSizeIterator for PopOnNext<'_> {
fn len(&self) -> usize {
self.inner.len()
}
}
-2
View File
@@ -7,7 +7,6 @@ pub struct Skip {
}
impl Skip {
#[must_use]
pub fn new(skip: bool) -> Self {
Self { skip }
}
@@ -46,7 +45,6 @@ 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
#[must_use]
pub fn new(around: usize, inclusive_min: usize, exclusive_max: NonZeroUsize) -> Self {
Self {
around,
+152 -354
View File
@@ -16,7 +16,6 @@ use nix::{
use ratatui::{
Frame,
layout::{Constraint, Flex, Layout, Position, Rect},
prelude::{Line, Text},
style::{Color, Style},
symbols::border,
text::Span,
@@ -78,8 +77,8 @@ struct PageConstraints {
#[derive(Default, Debug)]
struct Zoom {
// just how much 'zoom' you have. 0 means it fills the screen (instead of fits), such
// that one axis is fully on-screen
// 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)
@@ -88,85 +87,6 @@ struct Zoom {
// not displayed)
cell_pan_from_top: u16
}
impl Zoom {
/// Returns the zoom factor, where 1 is the default and means fill-screen
fn factor(&self) -> f32 {
// TODO: Make these configurable once we have a good way to set options after startup
const ZOOM_RATE: f32 = 1.1;
const ZOOM_RATE_GRANULAR: f32 = 1.05;
if self.level > 0 {
ZOOM_RATE.powi(self.level.into())
} else {
// use a more granular zoom rate for the steps between fit-screen and fill-screen
ZOOM_RATE_GRANULAR.powi(self.level.into())
}
}
fn step_in(&mut self) {
self.level = self.level.saturating_add(1);
}
fn step_out(&mut self) {
self.level = self.level.saturating_sub(1);
}
// TODO: Make this configurable, maybe allow fractional steps?
// With fractional steps, it might also be a good idea to have these
// have the same ratio as the font aspect ratio.
const PAN_STEP_X: i16 = 2;
const PAN_STEP_Y: i16 = 1;
fn pan(&mut self, direction: Direction) {
let (target, sign) = match direction {
Direction::Up => (&mut self.cell_pan_from_top, -1),
Direction::Down => (&mut self.cell_pan_from_top, 1),
Direction::Left => (&mut self.cell_pan_from_left, -1),
Direction::Right => (&mut self.cell_pan_from_left, 1)
};
let step = if direction.is_vertical() {
Self::PAN_STEP_Y
} else {
Self::PAN_STEP_X
};
*target = target.saturating_add_signed(sign * step);
}
fn pan_bottom(&mut self) {
self.cell_pan_from_top = 0;
}
fn pan_top(&mut self) {
self.cell_pan_from_top = u16::MAX;
}
fn pan_left(&mut self) {
self.cell_pan_from_left = 0;
}
fn pan_right(&mut self) {
self.cell_pan_from_left = u16::MAX;
}
}
#[derive(Clone, Copy, Debug)]
enum Direction {
Up,
Down,
Left,
Right
}
impl Direction {
/// Flips the directions for vertical and horizonal panning.
fn flip_mouse_xy(self) -> Self {
match self {
Self::Up => Self::Left,
Self::Left => Self::Up,
Self::Down => Self::Right,
Self::Right => Self::Down
}
}
fn is_vertical(self) -> bool {
match self {
Self::Up | Self::Down => true,
Self::Left | Self::Right => false
}
}
}
// 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
@@ -188,8 +108,7 @@ pub struct RenderLayout {
}
impl Tui {
#[must_use]
pub fn new(name: String, max_wide: Option<NonZeroUsize>, r_to_l: bool, is_kitty: bool) -> Self {
pub fn new(name: String, max_wide: Option<NonZeroUsize>, r_to_l: bool, is_kitty: bool) -> Tui {
Self {
name,
page: 0,
@@ -204,7 +123,6 @@ impl Tui {
}
}
#[must_use]
pub fn main_layout(frame: &Frame<'_>, fullscreened: bool) -> RenderLayout {
if fullscreened {
RenderLayout {
@@ -229,129 +147,7 @@ impl Tui {
}
}
fn render_zoomed<'s>(
// area of the 'fit-screen' page
mut img_area: Rect,
font_size: FontSize,
zoom: &mut Zoom,
img: &'s mut MaybeTransferred,
page_num: usize,
img_cell_w: u16,
img_cell_h: u16
) -> KittyDisplay<'s> {
log::debug!("zoom is {zoom:#?}");
log::debug!("page area is {img_area:#?}");
log::debug!("img dimensions are {img_cell_w}x{img_cell_h}");
// Dimensions of the section of the image to be displayed.
// Kittage calls this the "image area to display".
// We need to shrink this or the page area in order to zoom in or out,
// respectively.
let mut img_section_w = f32::from(img_cell_w);
let mut img_section_h = f32::from(img_cell_h);
let zoom_factor = zoom.factor();
if zoom_factor >= 1.0 {
// Use a smaller section of the image. This efficively zooms into that section.
img_section_w /= zoom_factor;
img_section_h /= zoom_factor;
} else {
// Shrink the page area, such that the fill-screen conversion
// will zoom out of the image.
let initial_page_w = f32::from(img_area.width);
let initial_page_h = f32::from(img_area.height);
// how many pages the image is wide/high
let img_page_w_ratio = img_section_w / initial_page_w;
let img_page_h_ratio = img_section_h / initial_page_h;
let shrink_move_page = |dim: &mut u16, pos: &mut u16, axis_zoom_factor: f32| {
let old_dim = *dim;
// The axis zoom factor tells us what portion of the axis
// we need to show.
*dim = (f32::from(*dim) * axis_zoom_factor) as u16;
*pos += old_dim
.checked_sub(*dim)
.expect("zooming out should shrink the image")
/ 2;
};
// TODO: Detect max zoom-out in zoom levels
if img_page_w_ratio < img_page_h_ratio {
// vertical scroll / tall image. zooming out means decreasing the width of the page area
shrink_move_page(
&mut img_area.width,
&mut img_area.x,
// disallow zooming out past fit-screen
zoom_factor.max(1.0 / img_page_h_ratio)
);
} else {
// horizontal scroll / wide image. zooming out means decreasing the width of the page area
shrink_move_page(
&mut img_area.height,
&mut img_area.y,
// disallow zooming out past fit-screen
zoom_factor.max(1.0 / img_page_w_ratio)
);
}
}
log::debug!("after adjustment, page area is {img_area:#?}");
// Crop the image such that in the end, the aspect ratio of the section
// is the same as that of the page area. This effectively performs the
// conversion to fill-screen.
// Note that this only works because cell_w, cell_h is in fit-screen
// format, i.e. the cell size and the page area already share at
// least one dimension.
{
let page_area_w = f32::from(img_area.width);
let page_area_h = f32::from(img_area.height);
// how many pages the image is wide/high
// Note that this is not the same as during the
// zoom-out calculation, since it changed the page
// dimensions.
let img_page_w_ratio = img_section_w / page_area_w;
let img_page_h_ratio = img_section_h / page_area_h;
if img_page_w_ratio < img_page_h_ratio {
img_section_h = page_area_h * img_page_w_ratio;
} else {
img_section_w = page_area_w * img_page_h_ratio;
}
}
let width = (img_section_w * f32::from(font_size.0)) as u32;
let height = (img_section_h * f32::from(font_size.1)) as u32;
zoom.cell_pan_from_left = zoom
.cell_pan_from_left
.min(img_cell_w.saturating_sub(img_section_w.ceil() as u16));
zoom.cell_pan_from_top = zoom
.cell_pan_from_top
.min(img_cell_h.saturating_sub(img_section_h.ceil() as u16));
KittyDisplay::DisplayImages(vec![KittyReadyToDisplay {
img,
page_num,
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()
}
}])
}
// 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<'s>(
&'s mut self,
@@ -384,9 +180,8 @@ impl Tui {
// be written and set to skip it so that ratatui doesn't spend a lot of time diffing it
// each re-render
frame.render_widget(Skip::new(true), img_area);
return KittyDisplay::NoChange;
}
KittyDisplay::NoChange
} 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
@@ -408,21 +203,79 @@ impl Tui {
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
};
return Self::render_zoomed(
img_area, font_size, zoom, img, self.page, cell_w, cell_h
);
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.
let mut test_area_w = img_area.width;
// go through our pages, starting at the first one we want to view
let mut page_sizes = self.rendered[self.page..]
let mut page_widths = self.rendered[self.page..]
.iter_mut()
// and get this to represent a count of how many we're looking at so far to render
.enumerate()
@@ -435,14 +288,9 @@ impl Tui {
take
})
// and map it to their width (in cells on the terminal, not pixels)
.filter_map(|(_, page)| {
page.img.as_mut().map(|img| {
let (w, h) = img.w_h();
(w, h, img)
})
})
.filter_map(|(_, page)| page.img.as_mut().map(|img| (img.w_h().0, img)))
// 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) => {
test_area_w = new_val;
true
@@ -452,35 +300,28 @@ impl Tui {
.collect::<Vec<_>>();
if self.page_constraints.r_to_l {
page_sizes.reverse();
page_widths.reverse();
}
if page_sizes.is_empty() {
if page_widths.is_empty() {
// If none are ready to render, just show the loading thing
Self::render_loading_in(frame, img_area);
KittyDisplay::ClearImages
} else {
execute!(stdout(), BeginSynchronizedUpdate).unwrap();
let total_width = page_sizes.iter().map(|(w, _, _)| w).sum::<u16>();
let total_width = page_widths.iter().map(|(w, _)| w).sum::<u16>();
self.last_render.pages_shown = page_sizes.len();
self.last_render.pages_shown = page_widths.len();
let unused_width = img_area.width - total_width;
self.last_render.unused_width = unused_width;
img_area.x += unused_width / 2;
if let Some(total_height) = page_sizes.iter().map(|(_, h, _)| h).max() {
// This subtraction might sporadicly fail while shrinking the window.
if let Some(unused_height) = img_area.height.checked_sub(*total_height) {
img_area.y += unused_height / 2;
}
}
let to_display = page_sizes
let to_display = page_widths
.into_iter()
.enumerate()
.filter_map(|(idx, (width, _, img))| {
.filter_map(|(idx, (width, img))| {
let maybe_img =
Self::render_single_page(frame, img, Rect { width, ..img_area });
img_area.x += width;
@@ -500,6 +341,7 @@ impl Tui {
KittyDisplay::DisplayImages(to_display)
}
}
}
fn render_single_page<'img>(
frame: &mut Frame<'_>,
@@ -523,13 +365,12 @@ impl Tui {
}
fn render_loading_in(frame: &mut Frame<'_>, area: Rect) {
const LOADING_STR: &str = "Loading...";
let inner_space =
Layout::horizontal([Constraint::Length(const { LOADING_STR.len() as u16 })])
let loading_str = "Loading...";
let inner_space = Layout::horizontal([Constraint::Length(loading_str.len() as u16)])
.flex(Flex::Center)
.split(area);
let loading_span = Span::styled(LOADING_STR, Style::new().fg(Color::Cyan));
let loading_span = Span::styled(loading_str, Style::new().fg(Color::Cyan));
frame.render_widget(loading_span, inner_space[0]);
}
@@ -558,8 +399,6 @@ impl Tui {
PageChange::Prev => self.set_page(self.page.saturating_sub(diff))
}
// Yes these conversions could wrap around if you have > isize::MAX pages, but we already
// decided that you deserve to suffer if you have more than u32::MAX pages, so that's fine.
match self.page as isize - old as isize {
0 => None,
_ => Some(InputAction::JumpingToPage(self.page))
@@ -693,15 +532,19 @@ impl Tui {
}
pub fn handle_event(&mut self, ev: &Event) -> Option<InputAction> {
fn jump_to_page(page: &mut usize, rect: &mut Rect, new_page: usize) -> InputAction {
fn jump_to_page(
page: &mut usize,
rect: &mut Rect,
new_page: Option<usize>
) -> Option<InputAction> {
new_page.map(|new_page| {
*page = new_page;
// Make sure we re-render
*rect = Rect::default();
InputAction::JumpingToPage(new_page)
})
}
let can_zoom = self.is_kitty && self.zoom.is_some();
match ev {
Event::Key(key) => {
match key.code {
@@ -717,12 +560,6 @@ impl Tui {
if let BottomMessage::Input(InputCommand::GoToPage(ref mut page)) =
self.bottom_msg
{
if c == 'g' && self.is_kitty {
self.update_zoom(Zoom::pan_bottom);
self.set_msg(MessageSetting::Pop);
return Some(InputAction::Redraw);
}
return c.to_digit(10).map(|input_num| {
*page = (*page * 10) + input_num as usize;
InputAction::Redraw
@@ -756,23 +593,19 @@ impl Tui {
'n' if self.page < self.rendered.len() - 1 => {
// TODO: If we can't find one, then maybe like block until we've verified
// all the pages have been checked?
self.rendered[(self.page + 1)..]
let next_page = self.rendered[(self.page + 1)..]
.iter()
.enumerate()
.find_map(|(idx, p)| {
p.num_results
.is_some_and(|num| num > 0)
.then_some(self.page + 1 + idx)
})
.map(|next_page| {
jump_to_page(
&mut self.page,
&mut self.last_render.rect,
next_page
)
})
});
jump_to_page(&mut self.page, &mut self.last_render.rect, next_page)
}
'N' if self.page > 0 => self.rendered[..(self.page)]
'N' if self.page > 0 => {
let prev_page = self.rendered[..(self.page)]
.iter()
.rev()
.enumerate()
@@ -780,14 +613,10 @@ impl Tui {
p.num_results
.is_some_and(|num| num > 0)
.then_some(self.page - (idx + 1))
})
.map(|prev_page| {
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?
@@ -827,15 +656,23 @@ impl Tui {
self.last_render.rect = Rect::default();
Some(InputAction::SwitchRenderZoom(f_or_f))
}
'o' if can_zoom => self.update_zoom(Zoom::step_in),
'O' if can_zoom => self.update_zoom(Zoom::step_out),
'L' if can_zoom => self.update_zoom(|z| z.pan(Direction::Right)),
'H' if can_zoom => self.update_zoom(|z| z.pan(Direction::Left)),
'J' if can_zoom => self.update_zoom(|z| z.pan(Direction::Down)),
'K' if can_zoom => self.update_zoom(|z| z.pan(Direction::Up)),
'G' if can_zoom => self.update_zoom(Zoom::pan_top),
'0' if can_zoom => self.update_zoom(Zoom::pan_left),
'$' if can_zoom => self.update_zoom(Zoom::pan_right),
'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
}
}
@@ -849,11 +686,9 @@ impl Tui {
None
}
KeyCode::Right => self.change_page(PageChange::Next, ChangeAmount::Single),
KeyCode::Down | KeyCode::PageDown =>
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::Up | KeyCode::PageUp =>
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) {
(false, BottomMessage::Help) => Some(InputAction::QuitApp),
_ => {
@@ -922,48 +757,41 @@ impl Tui {
}
}
Event::Mouse(mouse) => {
let mut handle_scroll = |mut direction: Direction| {
if can_zoom {
if mouse.modifiers.contains(KeyModifiers::CONTROL) {
match direction {
Direction::Up => self.update_zoom(Zoom::step_in),
Direction::Down => self.update_zoom(Zoom::step_out),
_ => None
}
} else {
if mouse.modifiers.contains(KeyModifiers::SHIFT) {
direction = direction.flip_mouse_xy();
}
self.update_zoom(|z| z.pan(direction))
}
} else {
let (change, amount) = match direction {
Direction::Right => (PageChange::Next, ChangeAmount::Single),
Direction::Down => (PageChange::Next, ChangeAmount::WholeScreen),
Direction::Left => (PageChange::Prev, ChangeAmount::Single),
Direction::Up => (PageChange::Prev, ChangeAmount::WholeScreen)
};
self.change_page(change, amount)
}
};
if mouse.modifiers.contains(KeyModifiers::CONTROL)
&& self.is_kitty
&& self.zoom.is_some()
{
match mouse.kind {
MouseEventKind::ScrollRight => handle_scroll(Direction::Right),
MouseEventKind::ScrollDown => handle_scroll(Direction::Down),
MouseEventKind::ScrollLeft => handle_scroll(Direction::Left),
MouseEventKind::ScrollUp => handle_scroll(Direction::Up),
MouseEventKind::ScrollUp =>
self.update_zoom(|z| z.level = z.level.saturating_add(1).min(0)),
MouseEventKind::ScrollDown =>
self.update_zoom(|z| z.level = z.level.saturating_sub(1)),
_ => 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),
_ => None
}
}
// I want this to always return an option 'cause I just use it to return from `Self::handle_event`
// 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);
f(z)
}
self.last_render.rect = Rect::default();
Some(InputAction::Redraw)
@@ -1019,24 +847,11 @@ impl Tui {
.border_set(border::ROUNDED)
.border_style(Color::Blue);
let help_sections = [
Text::from(HELP_PAGE),
// just some spacing
Text::from(""),
if self.is_kitty {
Text::from(KITTY_HELP)
} else {
Text::from("Not using kitty, kitty-specific keybindings hidden")
.style(Color::DarkGray)
}
];
let help_span = Paragraph::new(HELP_PAGE).wrap(Wrap { trim: false });
let max_w: u16 = help_sections
.iter()
.flat_map(|section| section.lines.as_slice())
// We don't really need full unicode-width since we're using all ascii for the help
// pages, but this is the function they give us.
.map(Line::width)
let max_w: u16 = HELP_PAGE
.lines()
.map(str::len)
.max()
.unwrap_or_default()
.try_into()
@@ -1051,24 +866,15 @@ impl Tui {
let block_area = Layout::vertical([
Constraint::Fill(1),
Constraint::Length(
u16::try_from(help_sections.iter().map(|s| s.lines.len()).sum::<usize>()).unwrap()
+ 4
),
Constraint::Length(u16::try_from(HELP_PAGE.lines().count()).unwrap() + 4),
Constraint::Fill(1)
])
.split(layout[1]);
let mut block_inner = block.inner(block_area[1]);
let block_inner = block.inner(block_area[1]);
frame.render_widget(block, block_area[1]);
for section in help_sections {
let section_lines = section.lines.len();
let span = Paragraph::new(section).wrap(Wrap { trim: false });
frame.render_widget(span, block_inner);
block_inner.y += u16::try_from(section_lines).unwrap();
}
frame.render_widget(help_span, block_inner);
}
}
@@ -1089,26 +895,18 @@ 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 \
";
static KITTY_HELP: &str = "\
When using Kitty Protocol:
z:
Toggle between fill-screen and fit-screen
o/O (when on fill-screen):
Zoom in and out, respectively
gg/G (when on fill-screen):
Scroll to top/bottom of page
H, J, K, L (when zoomed in):
Pan direction around page
0/$ (when on fill-screen):
Scroll to left/right side of page
";
pub enum InputAction {
Redraw,
JumpingToPage(usize),