mirror of
https://github.com/itsjunetime/tdf.git
synced 2026-06-01 23:51:46 -04:00
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| ff262cfb74 |
@@ -1,2 +0,0 @@
|
||||
[*.rs]
|
||||
indent_style = tab
|
||||
+29
-95
@@ -2,107 +2,41 @@ name: Rust
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: ["main"]
|
||||
tags: ["v*.*.*"]
|
||||
branches: [ "main" ]
|
||||
pull_request:
|
||||
branches: ["main"]
|
||||
workflow_dispatch:
|
||||
workflow_call:
|
||||
branches: [ "main" ]
|
||||
|
||||
env:
|
||||
CARGO_TERM_COLOR: always
|
||||
|
||||
jobs:
|
||||
test-build:
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- { os: "macos-latest", target: "aarch64-apple-darwin" }
|
||||
- { os: "ubuntu-latest", target: "x86_64-unknown-linux-gnu" }
|
||||
- {
|
||||
os: "windows-latest",
|
||||
target: "x86_64-pc-windows-msvc",
|
||||
ext: ".exe",
|
||||
}
|
||||
- { os: "ubuntu-24.04-arm", target: "aarch64-unknown-linux-gnu" }
|
||||
build:
|
||||
|
||||
runs-on: ${{ matrix.os }}
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
|
||||
- name: Setup sccache
|
||||
if: github.event_name != 'release' && github.event_name != 'workflow_dispatch'
|
||||
uses: mozilla-actions/sccache-action@v0.0.8
|
||||
- name: Configure sccache
|
||||
if: github.event_name != 'release' && github.event_name != 'workflow_dispatch'
|
||||
run: |
|
||||
echo "SCCACHE_GHA_ENABLED=true" >> "$GITHUB_ENV"
|
||||
echo "RUSTC_WRAPPER=sccache" >> "$GITHUB_ENV"
|
||||
|
||||
- name: Setup rust cache action
|
||||
uses: swatinem/rust-cache@v2
|
||||
with:
|
||||
cache-on-failure: true
|
||||
|
||||
- name: install build dependencies on ubuntu and cache
|
||||
if: contains(matrix.os, 'ubuntu')
|
||||
uses: awalsh128/cache-apt-pkgs-action@latest
|
||||
with:
|
||||
packages: libfontconfig1-dev libgoogle-perftools-dev google-perftools
|
||||
version: latest # could be anything
|
||||
|
||||
- name: Install clippy and fmt
|
||||
run: rustup component add clippy rustfmt
|
||||
- name: Clippy
|
||||
run: cargo clippy --locked -- -D warnings
|
||||
- name: Tests
|
||||
run: cargo test --locked
|
||||
- name: Check fmt
|
||||
run: cargo fmt -- --check
|
||||
- name: Run benchmarks as tests
|
||||
run: cargo test --locked --benches -- adobe_example
|
||||
|
||||
- name: Set build mode
|
||||
shell: bash
|
||||
run: if [ "${{github.ref_type}}" == "tag" ] || [ ${{ github.event_name == 'push' && github.ref_name == 'main' }} ]; then echo "BMODE=production">>"$GITHUB_ENV"; fi
|
||||
|
||||
- name: Build in ${{env.BMODE || 'debug'}} mode
|
||||
run: cargo build --verbose --locked --profile ${{env.BMODE || 'dev'}}
|
||||
|
||||
- name: Prepare artifact
|
||||
shell: bash
|
||||
run: |
|
||||
mkdir -p dist
|
||||
cp "target/${{env.BMODE || 'debug'}}/tdf${{ matrix.ext }}" dist/tdf-${{ matrix.target }}${{ matrix.ext }}
|
||||
tree dist || ls -la dist
|
||||
|
||||
- name: Upload artifacts
|
||||
uses: actions/upload-artifact@v5
|
||||
with:
|
||||
name: tdf-${{ matrix.target }}
|
||||
path: dist/tdf*
|
||||
|
||||
tag-release:
|
||||
name: Release on tag push
|
||||
runs-on: ubuntu-slim
|
||||
if: github.ref_type == 'tag'
|
||||
needs: test-build
|
||||
steps:
|
||||
- uses: actions/download-artifact@v6
|
||||
with:
|
||||
pattern: "**/tdf-*"
|
||||
path: release-artifacts
|
||||
merge-multiple: true
|
||||
|
||||
- name: What's up?
|
||||
run: tree release-artifacts # beautiful!
|
||||
|
||||
- name: Create a GitHub release
|
||||
uses: softprops/action-gh-release@v2
|
||||
with:
|
||||
draft: true
|
||||
generate_release_notes: true
|
||||
files: release-artifacts/*
|
||||
prerelease: ${{ contains(github.ref, 'alpha') || contains(github.ref, 'beta') || contains(github.ref, 'rc') }}
|
||||
- name: Setup sccache
|
||||
if: github.event_name != 'release' && github.event_name != 'workflow_dispatch'
|
||||
uses: mozilla-actions/sccache-action@v0.0.8
|
||||
- name: Configure sccache
|
||||
if: github.event_name != 'release' && github.event_name != 'workflow_dispatch'
|
||||
run: |
|
||||
echo "SCCACHE_GHA_ENABLED=true" >> $GITHUB_ENV
|
||||
echo "RUSTC_WRAPPER=sccache" >> $GITHUB_ENV
|
||||
- name: Install build dependencies
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y libfontconfig1-dev libgoogle-perftools-dev google-perftools
|
||||
- uses: actions/checkout@v4
|
||||
- name: Install clippy and fmt
|
||||
run: rustup component add clippy rustfmt
|
||||
- name: Clippy
|
||||
run: cargo clippy --locked -- -D warnings
|
||||
- name: Tests
|
||||
run: cargo test --locked
|
||||
- name: Check fmt
|
||||
run: cargo fmt -- --check
|
||||
- name: Run benchmarks as tests
|
||||
run: cargo test --locked --benches -- adobe_example
|
||||
- name: Build
|
||||
run: cargo build --locked
|
||||
|
||||
@@ -1,4 +1,2 @@
|
||||
/target
|
||||
debug.log
|
||||
/.envrc
|
||||
/.direnv/
|
||||
|
||||
@@ -1,26 +1,5 @@
|
||||
# Unreleased
|
||||
|
||||
- Added windows support! (thank you to [@jarjk](https://github.com/jarjk) for helping out!)
|
||||
- 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)!)
|
||||
- Fixed issue with images clearing/flashing after displaying a certain number on kitty
|
||||
- (Internal) decreased runtime footprint of tokio runtime
|
||||
|
||||
# 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
|
||||
|
||||
Generated
+1286
-839
File diff suppressed because it is too large
Load Diff
+31
-150
@@ -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"
|
||||
@@ -11,7 +11,7 @@ license = "AGPL-3.0-only"
|
||||
keywords = ["pdf", "tui", "cli", "terminal"]
|
||||
categories = ["command-line-utilities", "text-processing", "visualization"]
|
||||
default-run = "tdf"
|
||||
rust-version = "1.95"
|
||||
rust-version = "1.86"
|
||||
|
||||
[[bin]]
|
||||
name = "tdf"
|
||||
@@ -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 = "720ac2d0cad1ac6424364fea74856fec9c100cb1", 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 = "a276a87cb8e2976442c6cc59db831db81551da89", 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,41 +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"] }
|
||||
mupdf = { git = "https://github.com/messense/mupdf-rs.git", rev = "d7441b9998c92135e329559c0aa71d9dc92cf4de", default-features = false, features = ["svg", "system-fonts", "img"] }
|
||||
rayon = { version = "1", default-features = false }
|
||||
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 = { version = "0.4.0", features = ["crossterm-tokio", "image-crate", "log"] }
|
||||
memmap2 = "0"
|
||||
csscolorparser = { version = "0.8.0", default-features = false }
|
||||
debounce = "0.2.2"
|
||||
smallvec = "1"
|
||||
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 }
|
||||
|
||||
[patch.crates-io]
|
||||
pathfinder_simd = { git = "https://github.com/itsjunetime/pathfinder.git", rev = "814671e162a1829e074521446317b915311d3d4d" }
|
||||
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]]
|
||||
@@ -80,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"
|
||||
|
||||
@@ -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,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;
|
||||
}
|
||||
|
||||
+66
-87
@@ -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,108 +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::Builder::new_multi_thread()
|
||||
.worker_threads(3)
|
||||
.enable_time()
|
||||
.build()
|
||||
.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 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_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));
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
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);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -145,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;
|
||||
@@ -156,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))
|
||||
@@ -197,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('/', "-"),
|
||||
@@ -218,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
@@ -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: 720ac2d0ca...47c200fb7f
+1
-1
Submodule ratatui-image updated: 8ad154a219...fe3d0b992b
@@ -1,11 +0,0 @@
|
||||
{
|
||||
pkgs ? import <nixpkgs> { },
|
||||
}:
|
||||
pkgs.mkShell {
|
||||
nativeBuildInputs = [ pkgs.pkg-config ];
|
||||
|
||||
buildInputs = [
|
||||
pkgs.rustPlatform.bindgenHook
|
||||
pkgs.cairo
|
||||
];
|
||||
}
|
||||
+28
-42
@@ -1,12 +1,11 @@
|
||||
use std::{
|
||||
io::Cursor,
|
||||
num::{NonZeroU32, NonZeroUsize},
|
||||
time::{SystemTime, UNIX_EPOCH}
|
||||
};
|
||||
|
||||
use flume::{Receiver, SendError, Sender, TryRecvError};
|
||||
use futures_util::stream::StreamExt as _;
|
||||
use image::{DynamicImage, codecs::pnm::PnmDecoder};
|
||||
use futures_util::stream::StreamExt;
|
||||
use image::DynamicImage;
|
||||
use kittage::NumberOrId;
|
||||
use ratatui::layout::Rect;
|
||||
use ratatui_image::{
|
||||
@@ -14,7 +13,7 @@ use ratatui_image::{
|
||||
picker::{Picker, ProtocolType},
|
||||
protocol::Protocol
|
||||
};
|
||||
use rayon::iter::ParallelIterator as _;
|
||||
use rayon::iter::ParallelIterator;
|
||||
|
||||
use crate::{
|
||||
renderer::{PageInfo, RenderError, fill_default},
|
||||
@@ -38,7 +37,6 @@ pub enum ConvertedImage {
|
||||
}
|
||||
|
||||
impl ConvertedImage {
|
||||
#[must_use]
|
||||
pub fn w_h(&self) -> (u16, u16) {
|
||||
match self {
|
||||
Self::Generic(prot) => {
|
||||
@@ -69,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>>> {
|
||||
@@ -79,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,
|
||||
@@ -112,27 +110,23 @@ pub async fn run_conversion_loop(
|
||||
return Ok(None);
|
||||
};
|
||||
|
||||
let decoder = PnmDecoder::new(Cursor::new(&page_info.img_data.pixels)).map_err(|e| {
|
||||
RenderError::Converting(format!(
|
||||
"The image data provided from mupdf was not in pnm format ({e}); don't know how to convert"
|
||||
))
|
||||
})?;
|
||||
let mut dyn_img = image::load_from_memory_with_format(
|
||||
&page_info.img_data.pixels,
|
||||
image::ImageFormat::Pnm
|
||||
)
|
||||
.map_err(|e| RenderError::Converting(format!("Can't load image: {e}")))?;
|
||||
|
||||
// The image we get should always already be `ImageRgb8`, so this `into` shouldn't do any
|
||||
// conversions or anything, but just in case some underlying detail of mupdf or image
|
||||
// changes, we do the `into` instead of just `match + unreachable!()` to avoid panicking
|
||||
let mut dyn_img = DynamicImage::from_decoder(decoder)
|
||||
.map_err(|e| RenderError::Converting(format!("Can't load image: {e}")))?
|
||||
.into_rgb8();
|
||||
|
||||
for quad in &*page_info.result_rects {
|
||||
dyn_img
|
||||
.par_enumerate_pixels_mut()
|
||||
.filter(|(x, y, _)| {
|
||||
*x > quad.ul_x && *x < quad.lr_x && *y > quad.ul_y && *y < quad.lr_y
|
||||
})
|
||||
.for_each(|(_, _, px)| px.0[2] = px.0[2].saturating_sub(u8::MAX / 2));
|
||||
}
|
||||
match dyn_img {
|
||||
DynamicImage::ImageRgb8(ref mut img) =>
|
||||
for quad in &*page_info.result_rects {
|
||||
img.par_enumerate_pixels_mut()
|
||||
.filter(|(x, y, _)| {
|
||||
*x > quad.ul_x && *x < quad.lr_x && *y > quad.ul_y && *y < quad.lr_y
|
||||
})
|
||||
.for_each(|(_, _, px)| px.0[2] = px.0[2].saturating_sub(u8::MAX / 2));
|
||||
},
|
||||
_ => unreachable!()
|
||||
};
|
||||
|
||||
let img_area = Rect {
|
||||
width: page_info.img_data.cell_w,
|
||||
@@ -141,31 +135,23 @@ pub async fn run_conversion_loop(
|
||||
y: 0
|
||||
};
|
||||
|
||||
let dyn_img = DynamicImage::ImageRgb8(dyn_img);
|
||||
|
||||
let txt_img = match picker.protocol_type() {
|
||||
ProtocolType::Kitty => {
|
||||
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 {
|
||||
let shm_name = format!("/tdf_{pid}_{rn}_{page_num}");
|
||||
|
||||
#[cfg(unix)]
|
||||
let shm_name = &*shm_name;
|
||||
|
||||
kittage::image::Image::shm_from(dyn_img, shm_name).map_err(|e| {
|
||||
RenderError::Converting(format!("Couldn't create shm: {e:?}"))
|
||||
})?
|
||||
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)
|
||||
};
|
||||
|
||||
// if ur pdf has 4 billion pages then you deserve to suffer
|
||||
img.num_or_id = NumberOrId::Id(NonZeroU32::MIN.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,
|
||||
@@ -228,7 +214,7 @@ pub async fn run_conversion_loop(
|
||||
|
||||
match next_page(
|
||||
&mut images,
|
||||
&picker,
|
||||
&mut picker,
|
||||
page,
|
||||
&mut iteration,
|
||||
prerender,
|
||||
|
||||
+42
-95
@@ -1,4 +1,3 @@
|
||||
use core::fmt::Display;
|
||||
use std::{io::Write, num::NonZeroU32};
|
||||
|
||||
use crossterm::{
|
||||
@@ -18,7 +17,6 @@ use kittage::{
|
||||
medium::Medium
|
||||
};
|
||||
use ratatui::layout::Position;
|
||||
use smallvec::SmallVec;
|
||||
|
||||
use crate::converter::MaybeTransferred;
|
||||
|
||||
@@ -62,10 +60,10 @@ 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<Option<ImageId>, TransmitError<<&'es mut EventStream as AsyncInputReader>::Error>> {
|
||||
) -> Result<ImageId, TransmitError<<&'es mut EventStream as AsyncInputReader>::Error>> {
|
||||
let writer = DbgWriter {
|
||||
w: std::io::stdout().lock(),
|
||||
#[cfg(debug_assertions)]
|
||||
@@ -80,12 +78,7 @@ pub async fn run_action<'es>(
|
||||
pub async fn do_shms_work(ev_stream: &mut EventStream) -> bool {
|
||||
let img = DynamicImage::new_rgb8(1, 1);
|
||||
let pid = std::process::id();
|
||||
let shm_name = format!("tdf_test_{pid}");
|
||||
|
||||
#[cfg(unix)]
|
||||
let shm_name = &*shm_name;
|
||||
|
||||
let Ok(mut k_img) = kittage::image::Image::shm_from(img, shm_name) else {
|
||||
let Ok(mut k_img) = kittage::image::Image::shm_from(img, &format!("tdf_test_{pid}")) else {
|
||||
return false;
|
||||
};
|
||||
|
||||
@@ -101,51 +94,21 @@ pub async fn do_shms_work(ev_stream: &mut EventStream) -> bool {
|
||||
res.is_ok()
|
||||
}
|
||||
|
||||
type ESTransErr<'es> = TransmitError<<&'es mut EventStream as AsyncInputReader>::Error>;
|
||||
|
||||
pub struct DisplayErr<'es> {
|
||||
pub failed_pages: SmallVec<[usize; 2]>,
|
||||
pub user_facing_err: &'static str,
|
||||
pub source: DisplayErrSource<'es>
|
||||
}
|
||||
|
||||
impl<'es> DisplayErr<'es> {
|
||||
fn empty(user_facing_err: &'static str, source: ESTransErr<'es>) -> Self {
|
||||
Self {
|
||||
failed_pages: SmallVec::new(),
|
||||
user_facing_err,
|
||||
source: DisplayErrSource::Transmission(source)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
pub enum DisplayErrSource<'es> {
|
||||
KittageReturnedNoId,
|
||||
Transmission(ESTransErr<'es>)
|
||||
}
|
||||
|
||||
impl Display for DisplayErrSource<'_> {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
match self {
|
||||
Self::KittageReturnedNoId => write!(
|
||||
f,
|
||||
"Kittage returned no ID when we asked it to display an image. This is a bug in kittage, please report it."
|
||||
),
|
||||
Self::Transmission(t) => write!(f, "Error with talking to the terminal: {t}")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pub async fn display_kitty_images<'es>(
|
||||
display: KittyDisplay<'_>,
|
||||
ev_stream: &'es mut EventStream,
|
||||
last_z_index: &mut i32
|
||||
) -> Result<(), DisplayErr<'es>> {
|
||||
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::ClearImages =>
|
||||
return run_action(
|
||||
KittyDisplay::DisplayImages(_) | KittyDisplay::ClearImages => {
|
||||
run_action(
|
||||
Action::Delete(DeleteConfig {
|
||||
effect: ClearOrDelete::Clear,
|
||||
which: WhichToDelete::All
|
||||
@@ -153,23 +116,24 @@ pub async fn display_kitty_images<'es>(
|
||||
ev_stream
|
||||
)
|
||||
.await
|
||||
.map_err(|e| DisplayErr::empty("Couldn't clear previous images", e))
|
||||
.map(|_: Option<ImageId>| ()),
|
||||
KittyDisplay::DisplayImages(imgs) => imgs
|
||||
.map_err(|e| (vec![], "Couldn't clear previous images", e))?;
|
||||
|
||||
let KittyDisplay::DisplayImages(images) = display else {
|
||||
return Ok(());
|
||||
};
|
||||
|
||||
images
|
||||
}
|
||||
};
|
||||
|
||||
let new_z_index = last_z_index.wrapping_add_unsigned(1);
|
||||
|
||||
let mut err = Ok::<(), (SmallVec<[usize; 2]>, DisplayErrSource<'es>)>(());
|
||||
let mut err = None;
|
||||
for KittyReadyToDisplay {
|
||||
img,
|
||||
page_num,
|
||||
pos,
|
||||
mut display_loc
|
||||
display_loc
|
||||
} in images
|
||||
{
|
||||
display_loc.z_index = new_z_index;
|
||||
|
||||
let config = DisplayConfig {
|
||||
location: display_loc,
|
||||
cursor_movement: CursorMovementPolicy::DontMove,
|
||||
@@ -199,7 +163,7 @@ pub async fn display_kitty_images<'es>(
|
||||
};
|
||||
std::mem::swap(image, &mut fake_image);
|
||||
|
||||
run_action(
|
||||
let res = run_action(
|
||||
Action::TransmitAndDisplay {
|
||||
image: fake_image,
|
||||
config,
|
||||
@@ -207,13 +171,15 @@ pub async fn display_kitty_images<'es>(
|
||||
},
|
||||
ev_stream
|
||||
)
|
||||
.await
|
||||
.map_err(DisplayErrSource::Transmission)
|
||||
.and_then(|img_id| {
|
||||
img_id
|
||||
.map(|id| *img = MaybeTransferred::Transferred(id))
|
||||
.ok_or(DisplayErrSource::KittageReturnedNoId)
|
||||
})
|
||||
.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 {
|
||||
@@ -224,39 +190,20 @@ pub async fn display_kitty_images<'es>(
|
||||
ev_stream
|
||||
)
|
||||
.await
|
||||
// don't need the return id 'cause we already know it
|
||||
.map(|_: Option<ImageId>| ())
|
||||
.map_err(DisplayErrSource::Transmission)
|
||||
.map(|_| ())
|
||||
.map_err(|e| (page_num, e))
|
||||
};
|
||||
|
||||
log::debug!("this_err is {this_err:#?}");
|
||||
|
||||
if let Err(e) = this_err {
|
||||
match err.as_mut() {
|
||||
Ok(()) => err = Err((SmallVec::from([page_num].as_slice()), e)),
|
||||
Err((v, _)) => v.push(page_num)
|
||||
}
|
||||
if let Err((id, e)) = this_err {
|
||||
let e = err.get_or_insert_with(|| (vec![], e));
|
||||
e.0.push(id);
|
||||
}
|
||||
}
|
||||
|
||||
let z_idxes_to_remove = *last_z_index;
|
||||
*last_z_index = new_z_index;
|
||||
|
||||
match err {
|
||||
Err((failed_pages, source)) => Err(DisplayErr {
|
||||
failed_pages,
|
||||
user_facing_err: "Couldn't transfer image to the terminal",
|
||||
source
|
||||
}),
|
||||
Ok(()) => run_action(
|
||||
Action::Delete(DeleteConfig {
|
||||
effect: ClearOrDelete::Clear,
|
||||
which: WhichToDelete::PlacementsWithZIndex(z_idxes_to_remove)
|
||||
}),
|
||||
ev_stream
|
||||
)
|
||||
.await
|
||||
.map_err(|e| DisplayErr::empty("Couldn't clear previously-sent images", e))
|
||||
.map(|_| ())
|
||||
Some((replace, e)) => Err((replace, "Couldn't transfer image to the terminal", e)),
|
||||
None => Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
+1
-2
@@ -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),
|
||||
@@ -42,7 +41,7 @@ pub fn scale_img_for_area(
|
||||
|
||||
// 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 aspect ratio of the page with the aspect ratio of the
|
||||
// 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
|
||||
|
||||
+90
-148
@@ -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,
|
||||
@@ -38,10 +34,8 @@ use ratatui_image::{
|
||||
use tdf::{
|
||||
PrerenderLimit,
|
||||
converter::{ConvertedPage, ConverterMsg, run_conversion_loop},
|
||||
kitty::{
|
||||
DisplayErr, DisplayErrSource, KittyDisplay, display_kitty_images, do_shms_work, run_action
|
||||
},
|
||||
renderer::{self, MUPDF_BLACK, MUPDF_WHITE, RenderError, RenderInfo, RenderNotif},
|
||||
kitty::{KittyDisplay, display_kitty_images, do_shms_work, run_action},
|
||||
renderer::{self, RenderError, RenderInfo, RenderNotif},
|
||||
tui::{BottomMessage, InputAction, MessageSetting, Tui}
|
||||
};
|
||||
|
||||
@@ -63,27 +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
|
||||
);
|
||||
)
|
||||
}
|
||||
|
||||
fn main() -> Result<(), WrappedErr> {
|
||||
let rt = tokio::runtime::Builder::new_multi_thread()
|
||||
.worker_threads(3)
|
||||
.enable_time()
|
||||
.build()
|
||||
.unwrap();
|
||||
|
||||
rt.block_on(async move {
|
||||
let result = inner_main().await;
|
||||
reset_term();
|
||||
result
|
||||
})
|
||||
#[tokio::main]
|
||||
async fn main() -> Result<(), WrappedErr> {
|
||||
inner_main().await.inspect_err(|_| reset_term())
|
||||
}
|
||||
|
||||
async fn inner_main() -> Result<(), WrappedErr> {
|
||||
@@ -96,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
|
||||
@@ -137,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| {
|
||||
WrappedErr(
|
||||
format!(
|
||||
"Couldn't parse black color {color:?}: {e} - is it formatted like a CSS color?"
|
||||
)
|
||||
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()
|
||||
)
|
||||
})
|
||||
})
|
||||
.transpose()?
|
||||
.unwrap_or(MUPDF_BLACK);
|
||||
)
|
||||
})?;
|
||||
|
||||
let white = flags
|
||||
.white_color
|
||||
.as_deref()
|
||||
.map(|color| {
|
||||
parse_color_to_i32(color).map_err(|e| {
|
||||
WrappedErr(
|
||||
format!(
|
||||
"Couldn't parse white color {color:?}: {e} - is it formatted like a CSS color?"
|
||||
)
|
||||
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()
|
||||
)
|
||||
})
|
||||
})
|
||||
.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| {
|
||||
@@ -180,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();
|
||||
@@ -195,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()))?;
|
||||
|
||||
@@ -218,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())
|
||||
})?;
|
||||
@@ -255,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()
|
||||
)),
|
||||
@@ -276,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,
|
||||
@@ -309,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| {
|
||||
@@ -337,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))
|
||||
@@ -372,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(())
|
||||
}
|
||||
|
||||
@@ -390,8 +363,6 @@ async fn enter_redraw_loop(
|
||||
mut main_area: tdf::tui::RenderLayout,
|
||||
font_size: FontSize
|
||||
) -> Result<(), Box<dyn Error>> {
|
||||
let mut kitty_z_idx = i32::MIN;
|
||||
|
||||
loop {
|
||||
let mut needs_redraw = true;
|
||||
let next_ev = ev_stream.next().fuse();
|
||||
@@ -412,7 +383,6 @@ async fn enter_redraw_loop(
|
||||
},
|
||||
InputAction::Search(term) => to_renderer.send(RenderNotif::Search(term))?,
|
||||
InputAction::Invert => to_renderer.send(RenderNotif::Invert)?,
|
||||
InputAction::Rotate => to_renderer.send(RenderNotif::Rotate)?,
|
||||
InputAction::Fullscreen => fullscreen = !fullscreen,
|
||||
InputAction::SwitchRenderZoom(f_or_f) => {
|
||||
to_renderer.send(RenderNotif::SwitchFitOrFill(f_or_f)).unwrap();
|
||||
@@ -464,16 +434,10 @@ async fn enter_redraw_loop(
|
||||
to_display = tui.render(f, &main_area, font_size);
|
||||
})?;
|
||||
|
||||
let maybe_err =
|
||||
display_kitty_images(to_display, &mut ev_stream, &mut kitty_z_idx).await;
|
||||
let maybe_err = display_kitty_images(to_display, &mut ev_stream).await;
|
||||
|
||||
if let Err(DisplayErr {
|
||||
failed_pages,
|
||||
user_facing_err,
|
||||
source
|
||||
}) = maybe_err
|
||||
{
|
||||
match source {
|
||||
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
|
||||
@@ -481,15 +445,13 @@ async fn enter_redraw_loop(
|
||||
// [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
|
||||
DisplayErrSource::Transmission(TransmitError::Terminal(
|
||||
TerminalError::NoEntity(_)
|
||||
)) => (),
|
||||
TransmitError::Terminal(TerminalError::NoEntity(_)) => (),
|
||||
_ => tui.set_msg(MessageSetting::Some(BottomMessage::Error(format!(
|
||||
"{user_facing_err}: {source}"
|
||||
"{err_desc}: {enum_err}"
|
||||
))))
|
||||
}
|
||||
|
||||
for page_num in failed_pages {
|
||||
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))?;
|
||||
@@ -504,58 +466,38 @@ 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);
|
||||
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(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) => {
|
||||
// We only watch the parent directory (see the comment above `watcher.watch` in `fn
|
||||
// main`) so we need to filter out events to only ones that pertain to the single file
|
||||
// we care about
|
||||
if !ev
|
||||
.paths
|
||||
.iter()
|
||||
.any(|path| path.file_name().is_some_and(|f| f == file_name))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
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 {
|
||||
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.
|
||||
Ok(()) => to_render_tx.send(RenderNotif::Reload).unwrap(),
|
||||
// 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()
|
||||
EventKind::Other | EventKind::Any | EventKind::Create(_) | EventKind::Modify(_) =>
|
||||
to_render_tx.send(RenderNotif::Reload).unwrap(),
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
move |res| {
|
||||
let event = match res {
|
||||
Err(e) => Err(RenderError::Notify(e)),
|
||||
|
||||
// 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) => {
|
||||
// We only watch the parent directory (see the comment above `watcher.watch` in `fn
|
||||
// main`) so we need to filter out events to only ones that pertain to the single file
|
||||
// we care about
|
||||
if !ev
|
||||
.paths
|
||||
.iter()
|
||||
.any(|path| path.file_name().is_some_and(|f| f == file_name))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
match ev.kind {
|
||||
EventKind::Access(_) => return,
|
||||
EventKind::Remove(_) => Err(RenderError::Converting("File was deleted".into())),
|
||||
EventKind::Other
|
||||
| EventKind::Any
|
||||
| EventKind::Create(_)
|
||||
| EventKind::Modify(_) => Ok(())
|
||||
}
|
||||
}
|
||||
};
|
||||
*last_event.lock().unwrap() = event;
|
||||
debouncer.put(());
|
||||
}
|
||||
}
|
||||
|
||||
@@ -612,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()
|
||||
)
|
||||
|
||||
+17
-71
@@ -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::{
|
||||
@@ -20,8 +20,7 @@ pub enum RenderNotif {
|
||||
Search(String),
|
||||
SwitchFitOrFill(FitOrFill),
|
||||
Reload,
|
||||
Invert,
|
||||
Rotate
|
||||
Invert
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
@@ -38,14 +37,6 @@ pub enum RenderInfo {
|
||||
Reloaded
|
||||
}
|
||||
|
||||
#[derive(Debug, Copy, Clone)]
|
||||
pub enum RotateDirection {
|
||||
Deg0,
|
||||
Deg90,
|
||||
Deg180,
|
||||
Deg270
|
||||
}
|
||||
|
||||
#[derive(Clone)]
|
||||
pub struct PageInfo {
|
||||
pub img_data: ImageData,
|
||||
@@ -66,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) {
|
||||
@@ -87,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,
|
||||
@@ -107,21 +98,13 @@ pub fn start_rendering(
|
||||
|
||||
let mut stored_doc = None;
|
||||
let mut invert = false;
|
||||
let mut rotate = RotateDirection::Deg0;
|
||||
let mut preserved_area = None;
|
||||
let mut fit_or_fill = FitOrFill::Fit;
|
||||
|
||||
let mut need_rerender = VecDeque::new();
|
||||
|
||||
#[cfg(windows)]
|
||||
let path = path.to_string_lossy();
|
||||
|
||||
'reload: loop {
|
||||
// Need to do this weird borrow thing so that we convert `Cow<'_, str>` -> `&str` on windows
|
||||
// and keep unix a `&Path` -> `&Path` 'cause there are different requirements within mupdf
|
||||
// about file paths per-platform
|
||||
#[cfg_attr(unix, expect(clippy::borrow_deref_ref))]
|
||||
let doc = match Document::open(&*path) {
|
||||
let doc = match Document::open(path) {
|
||||
Err(e) => {
|
||||
// if there's an error, tell the main loop
|
||||
sender.send(Err(RenderError::Doc(e)))?;
|
||||
@@ -133,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;
|
||||
}
|
||||
}
|
||||
@@ -169,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
|
||||
@@ -255,18 +238,6 @@ pub fn start_rendering(
|
||||
}
|
||||
continue 'render_pages;
|
||||
}
|
||||
RenderNotif::Rotate => {
|
||||
rotate = match rotate {
|
||||
RotateDirection::Deg0 => RotateDirection::Deg90,
|
||||
RotateDirection::Deg90 => RotateDirection::Deg180,
|
||||
RotateDirection::Deg180 => RotateDirection::Deg270,
|
||||
RotateDirection::Deg270 => RotateDirection::Deg0
|
||||
};
|
||||
for page in &mut rendered {
|
||||
page.successful = false;
|
||||
}
|
||||
continue 'render_pages;
|
||||
}
|
||||
}
|
||||
}};
|
||||
}
|
||||
@@ -306,7 +277,7 @@ pub fn start_rendering(
|
||||
// we only want to continue if one of the following is met:
|
||||
// 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
|
||||
// check if it contains the current term to see if it needs a re-render
|
||||
// check if it contains the current term to see if it needs a re-render
|
||||
if rendered.successful && rendered.num_search_found.is_some() {
|
||||
continue;
|
||||
}
|
||||
@@ -330,7 +301,6 @@ pub fn start_rendering(
|
||||
black,
|
||||
white,
|
||||
fit_or_fill,
|
||||
rotate,
|
||||
(area_w, area_h)
|
||||
) {
|
||||
// If that fn returned Some, that means it needed to be re-rendered for some
|
||||
@@ -343,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}");
|
||||
|
||||
@@ -371,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
|
||||
@@ -464,7 +434,7 @@ pub fn start_rendering(
|
||||
return Ok(());
|
||||
};
|
||||
|
||||
handle_notif!(msg);
|
||||
handle_notif!(msg)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -485,7 +455,6 @@ fn render_single_page_to_ctx(
|
||||
black: i32,
|
||||
white: i32,
|
||||
fit_or_fill: FitOrFill,
|
||||
rotate: RotateDirection,
|
||||
(area_w, area_h): (f32, f32)
|
||||
) -> Result<RenderedContext, mupdf::error::Error> {
|
||||
let result_rects = match prev_render.num_search_found {
|
||||
@@ -496,12 +465,7 @@ fn render_single_page_to_ctx(
|
||||
|
||||
// then, get the size of the page
|
||||
let bounds = page.bounds()?;
|
||||
let page_dim = match rotate {
|
||||
RotateDirection::Deg0 | RotateDirection::Deg180 =>
|
||||
(bounds.x1 - bounds.x0, bounds.y1 - bounds.y0),
|
||||
RotateDirection::Deg90 | RotateDirection::Deg270 =>
|
||||
(bounds.y1 - bounds.y0, bounds.x1 - bounds.x0),
|
||||
};
|
||||
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);
|
||||
let ScaledResult {
|
||||
@@ -518,13 +482,7 @@ fn render_single_page_to_ctx(
|
||||
}
|
||||
|
||||
let colorspace = Colorspace::device_rgb();
|
||||
let mut matrix = Matrix::new_scale(scale_factor, scale_factor);
|
||||
match rotate {
|
||||
RotateDirection::Deg0 => matrix.rotate(0.0),
|
||||
RotateDirection::Deg90 => matrix.rotate(90.0),
|
||||
RotateDirection::Deg180 => matrix.rotate(180.0),
|
||||
RotateDirection::Deg270 => matrix.rotate(270.0)
|
||||
};
|
||||
let matrix = Matrix::new_scale(scale_factor, scale_factor);
|
||||
|
||||
let mut pixmap = page.to_pixmap(&matrix, &colorspace, false, false)?;
|
||||
if invert {
|
||||
@@ -536,7 +494,6 @@ fn render_single_page_to_ctx(
|
||||
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
|
||||
@@ -608,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()
|
||||
}
|
||||
}
|
||||
|
||||
@@ -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,
|
||||
|
||||
+333
-527
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user