Compare commits

...

3 Commits

Author SHA1 Message Date
itsjunetime 0129c498c2 Fix document reloading with delete-then-write editors and redo BottomMessage updating to work better 2024-12-01 13:19:18 -07:00
June b9a12650c6 Relicense to GPLv3 (#30)
* Relicense to GPLv3 since poppler is GPL and we must not violate that license

* Add note to README that contributions will be licensed as MPL-2.0
2024-12-01 11:30:33 -07:00
itsjunetime 65e1f1a205 Switch to mimalloc 2024-11-27 18:57:39 -07:00
11 changed files with 865 additions and 488 deletions
+3
View File
@@ -7,6 +7,9 @@
- Move `ratatui-image/vb64` support under `nightly` feature, enabled by default - Move `ratatui-image/vb64` support under `nightly` feature, enabled by default
- Fixed a bug where jumping to a page out of range could result in weird `esc` key behavior - Fixed a bug where jumping to a page out of range could result in weird `esc` key behavior
- Added CI ([#31](https://github.com/itsjunetime/tdf/pull/31), thank you [@Kriejstal](https://github.com/Kreijstal)) - Added CI ([#31](https://github.com/itsjunetime/tdf/pull/31), thank you [@Kriejstal](https://github.com/Kreijstal))
- Changed global allocator to [`mimalloc`](https://github.com/purpleprotocol/mimalloc_rust) for slightly improved performance
- Fixed issue with document reloading not working when files are intermedially deleted
- Fixed a lot of weirdness with bottom message layering/updating
# v0.1.0 # v0.1.0
Generated
+44 -24
View File
@@ -168,7 +168,7 @@ dependencies = [
"pin-project-lite", "pin-project-lite",
"rustversion", "rustversion",
"serde", "serde",
"sync_wrapper 1.0.1", "sync_wrapper 1.0.2",
"tower 0.5.1", "tower 0.5.1",
"tower-layer", "tower-layer",
"tower-service", "tower-service",
@@ -189,7 +189,7 @@ dependencies = [
"mime", "mime",
"pin-project-lite", "pin-project-lite",
"rustversion", "rustversion",
"sync_wrapper 1.0.1", "sync_wrapper 1.0.2",
"tower-layer", "tower-layer",
"tower-service", "tower-service",
] ]
@@ -945,9 +945,9 @@ checksum = "8a9ee70c43aaf417c914396645a0fa852624801b24ebb7ae78fe8272889ac888"
[[package]] [[package]]
name = "hashbrown" name = "hashbrown"
version = "0.15.1" version = "0.15.2"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3a9bfc1af68b1726ea47d3d5109de126281def866b33970e10fbab11b5dafab3" checksum = "bf151400ff0baff5465007dd2f3e717f3fe502074ca563069ce3a6629d07b289"
dependencies = [ dependencies = [
"allocator-api2", "allocator-api2",
"equivalent", "equivalent",
@@ -1141,7 +1141,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "707907fe3c25f5424cce2cb7e1cbcafee6bdbe735ca90ef77c29e84591e5b9da" checksum = "707907fe3c25f5424cce2cb7e1cbcafee6bdbe735ca90ef77c29e84591e5b9da"
dependencies = [ dependencies = [
"equivalent", "equivalent",
"hashbrown 0.15.1", "hashbrown 0.15.2",
] ]
[[package]] [[package]]
@@ -1244,9 +1244,9 @@ dependencies = [
[[package]] [[package]]
name = "itoa" name = "itoa"
version = "1.0.11" version = "1.0.14"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "49f1f14873335454500d59611f1cf4a4b0f786f9ac11f4312a78e4cf2566695b" checksum = "d75a2a4b1b190afb6f5425f10f6a8f959d2ea0b9c2b1d79553551850539e4674"
[[package]] [[package]]
name = "jobserver" name = "jobserver"
@@ -1294,9 +1294,9 @@ checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe"
[[package]] [[package]]
name = "libc" name = "libc"
version = "0.2.164" version = "0.2.166"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "433bfe06b8c75da9b2e3fbea6e5329ff87748f0b144ef75306e674c3f6f7c13f" checksum = "c2ccc108bbc0b1331bd061864e7cd823c0cab660bbe6970e66e2c0614decde36"
[[package]] [[package]]
name = "libfuzzer-sys" name = "libfuzzer-sys"
@@ -1308,6 +1308,16 @@ dependencies = [
"cc", "cc",
] ]
[[package]]
name = "libmimalloc-sys"
version = "0.1.39"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "23aa6811d3bd4deb8a84dde645f943476d13b248d818edcf8ce0b2f37f036b44"
dependencies = [
"cc",
"libc",
]
[[package]] [[package]]
name = "libredox" name = "libredox"
version = "0.1.3" version = "0.1.3"
@@ -1356,7 +1366,7 @@ version = "0.12.5"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "234cf4f4a04dc1f57e24b96cc0cd600cf2af460d4161ac5ecdd0af8e1f3b2a38" checksum = "234cf4f4a04dc1f57e24b96cc0cd600cf2af460d4161ac5ecdd0af8e1f3b2a38"
dependencies = [ dependencies = [
"hashbrown 0.15.1", "hashbrown 0.15.2",
] ]
[[package]] [[package]]
@@ -1390,6 +1400,15 @@ version = "2.7.4"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "78ca9ab1a0babb1e7d5695e3530886289c18cf2f87ec19a575a0abdce112e3a3" checksum = "78ca9ab1a0babb1e7d5695e3530886289c18cf2f87ec19a575a0abdce112e3a3"
[[package]]
name = "mimalloc"
version = "0.1.43"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "68914350ae34959d83f732418d51e2427a794055d0b9529f48259ac07af65633"
dependencies = [
"libmimalloc-sys",
]
[[package]] [[package]]
name = "mime" name = "mime"
version = "0.3.17" version = "0.3.17"
@@ -1718,9 +1737,9 @@ dependencies = [
[[package]] [[package]]
name = "proc-macro2" name = "proc-macro2"
version = "1.0.89" version = "1.0.92"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f139b0662de085916d1fb67d2b4169d1addddda1919e696f3252b740b629986e" checksum = "37d3544b3f2748c54e147655edb5025752e2303145b5aefb3c3ea2c78b973bb0"
dependencies = [ dependencies = [
"unicode-ident", "unicode-ident",
] ]
@@ -2218,9 +2237,9 @@ dependencies = [
[[package]] [[package]]
name = "syn" name = "syn"
version = "2.0.87" version = "2.0.89"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "25aa4ce346d03a6dcd68dd8b4010bcb74e54e62c90c573f394c46eae99aba32d" checksum = "44d46482f1c1c87acd84dea20c1bf5ebff4c757009ed6bf19cfd36fb10e92c4e"
dependencies = [ dependencies = [
"proc-macro2", "proc-macro2",
"quote", "quote",
@@ -2235,9 +2254,9 @@ checksum = "2047c6ded9c721764247e62cd3b03c09ffc529b2ba5b10ec482ae507a4a70160"
[[package]] [[package]]
name = "sync_wrapper" name = "sync_wrapper"
version = "1.0.1" version = "1.0.2"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a7065abeca94b6a8a577f9bd45aa0867a2238b74e8eb67cf10d492bc39351394" checksum = "0bf256ce5efdfa370213c1dabab5935a12e49f2c58d15e9eac2870d3b4f27263"
[[package]] [[package]]
name = "system-deps" name = "system-deps"
@@ -2285,6 +2304,7 @@ dependencies = [
"glib", "glib",
"image", "image",
"itertools 0.13.0", "itertools 0.13.0",
"mimalloc",
"notify", "notify",
"poppler-rs", "poppler-rs",
"ratatui", "ratatui",
@@ -2517,9 +2537,9 @@ checksum = "8df9b6e13f2d32c91b9bd719c00d1958837bc7dec474d94952798cc8e69eeec3"
[[package]] [[package]]
name = "tracing" name = "tracing"
version = "0.1.40" version = "0.1.41"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c3523ab5a71916ccf420eebdf5521fcef02141234bbc0b8a49f2fdc4544364ef" checksum = "784e0ac535deb450455cbfa28a6f0df145ea1bb7ae51b821cf5e7927fdcfbdd0"
dependencies = [ dependencies = [
"pin-project-lite", "pin-project-lite",
"tracing-attributes", "tracing-attributes",
@@ -2528,9 +2548,9 @@ dependencies = [
[[package]] [[package]]
name = "tracing-attributes" name = "tracing-attributes"
version = "0.1.27" version = "0.1.28"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "34704c8d6ebcbc939824180af020566b01a7c01f80641264eba0999f6c2b6be7" checksum = "395ae124c09f9e6918a2310af6038fba074bcf474ac352496d5910dd59a2226d"
dependencies = [ dependencies = [
"proc-macro2", "proc-macro2",
"quote", "quote",
@@ -2539,9 +2559,9 @@ dependencies = [
[[package]] [[package]]
name = "tracing-core" name = "tracing-core"
version = "0.1.32" version = "0.1.33"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c06d3da6113f116aaee68e4d601191614c9053067f9ab7f6edbcb161237daa54" checksum = "e672c95779cf947c5311f83787af4fa8fffd12fb27e4993211a84bdfd9610f9c"
dependencies = [ dependencies = [
"once_cell", "once_cell",
"valuable", "valuable",
@@ -2570,9 +2590,9 @@ checksum = "e421abadd41a4225275504ea4d6566923418b7f05506fbc9c0fe86ba7396114b"
[[package]] [[package]]
name = "unicode-ident" name = "unicode-ident"
version = "1.0.13" version = "1.0.14"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e91b56cd4cadaeb79bbf1a5645f6b4f8dc5bde8834ad5894a8db35fda9efa1fe" checksum = "adb9e6ca4f869e1180728b7950e35922a7fc6397f7b641499e8f3ef06e50dc83"
[[package]] [[package]]
name = "unicode-segmentation" name = "unicode-segmentation"
+2 -1
View File
@@ -7,7 +7,7 @@ description = "A terminal viewer for PDFs"
readme = "README.md" readme = "README.md"
homepage = "https://github.com/itsjunetime/tdf" homepage = "https://github.com/itsjunetime/tdf"
repository = "https://github.com/itsjunetime/tdf" repository = "https://github.com/itsjunetime/tdf"
license = "MPL-2.0" license = "GPL-3.0-or-later"
keywords = ["pdf", "tui", "cli", "terminal"] keywords = ["pdf", "tui", "cli", "terminal"]
categories = ["command-line-utilities", "text-processing", "visualization"] categories = ["command-line-utilities", "text-processing", "visualization"]
default-run = "tdf" default-run = "tdf"
@@ -37,6 +37,7 @@ glib = "0.20.0"
itertools = "*" itertools = "*"
flume = { version = "0.11.0", default-features = false, features = ["async"] } flume = { version = "0.11.0", default-features = false, features = ["async"] }
xflags = "0.4.0-pre.2" xflags = "0.4.0-pre.2"
mimalloc = "0.1.43"
# for tracing with tokio-console # for tracing with tokio-console
console-subscriber = { version = "0.4.0", optional = true } console-subscriber = { version = "0.4.0", optional = true }
+674 -373
View File
File diff suppressed because it is too large Load Diff
+2
View File
@@ -29,3 +29,5 @@ I dunno. Just for fun, mostly.
## Can I contribute? ## Can I contribute?
Yeah, sure. Please do. Yeah, sure. Please do.
Please note, though, that all contributions will be treated as licensed under MPL-2.0. This is so that we can relicense to MPL-2.0 at some point in the future if we manage to move away from poppler as a backend (since that is the only dependency, at time of writing, which requires the GPLv3 license).
+5 -4
View File
@@ -71,7 +71,7 @@ pub async fn render_first_page(path: impl AsRef<Path>) {
} = start_all_rendering(path); } = start_all_rendering(path);
// we only want to render until the first page is ready to be printed // we only want to render until the first page is ready to be printed
while pages.iter().all(|p| p.is_none()) { while pages.iter().all(Option::is_none) {
tokio::select! { tokio::select! {
Some(renderer_msg) = from_render_rx.next() => { Some(renderer_msg) = from_render_rx.next() => {
handle_renderer_msg(renderer_msg, &mut pages, &mut to_converter_tx); handle_renderer_msg(renderer_msg, &mut pages, &mut to_converter_tx);
@@ -94,6 +94,7 @@ async fn render_all_files(path: &'static str) -> Vec<PageInfo> {
while let Some(info) = from_render_rx.next().await { while let Some(info) = from_render_rx.next().await {
match info.expect("Renderer ran into an error while rendering") { match info.expect("Renderer ran into an error while rendering") {
RenderInfo::Reloaded => (),
RenderInfo::NumPages(num) => fill_default(&mut pages, num), RenderInfo::NumPages(num) => fill_default(&mut pages, num),
RenderInfo::Page(page) => { RenderInfo::Page(page) => {
let num = page.page; let num = page.page;
@@ -101,7 +102,7 @@ async fn render_all_files(path: &'static str) -> Vec<PageInfo> {
} }
}; };
if pages.iter().all(|p| p.is_some()) { if pages.iter().all(Option::is_some) {
break; break;
} }
} }
@@ -136,7 +137,7 @@ async fn convert_all_files(files: Vec<PageInfo>) {
} }
} }
while converted.iter().any(|p| p.is_none()) { while converted.iter().any(Option::is_none) {
let page = from_converter_rx let page = from_converter_rx
.next() .next()
.await .await
@@ -157,7 +158,7 @@ impl Profiler for CpuProfiler {
fn start_profiling(&mut self, benchmark_id: &str, _: &std::path::Path) { fn start_profiling(&mut self, benchmark_id: &str, _: &std::path::Path) {
let file = format!( let file = format!(
"./{}-{}.profile", "./{}-{}.profile",
benchmark_id.replace("/", "-"), benchmark_id.replace('/', "-"),
SystemTime::now() SystemTime::now()
.duration_since(UNIX_EPOCH) .duration_since(UNIX_EPOCH)
.unwrap() .unwrap()
+2
View File
@@ -21,6 +21,8 @@ pub fn handle_renderer_msg(
to_converter_tx.send(ConverterMsg::NumPages(num)).unwrap(); to_converter_tx.send(ConverterMsg::NumPages(num)).unwrap();
} }
Ok(RenderInfo::Page(info)) => to_converter_tx.send(ConverterMsg::AddImg(info)).unwrap(), Ok(RenderInfo::Page(info)) => to_converter_tx.send(ConverterMsg::AddImg(info)).unwrap(),
// We can ignore the `Reloaded` variant 'cause that's only used to send info to the TUI
Ok(RenderInfo::Reloaded) => (),
Err(e) => panic!("Got error from renderer: {e:?}") Err(e) => panic!("Got error from renderer: {e:?}")
} }
} }
+3
View File
@@ -1,3 +1,6 @@
#[global_allocator]
static ALLOC: mimalloc::MiMalloc = mimalloc::MiMalloc;
pub mod converter; pub mod converter;
pub mod renderer; pub mod renderer;
pub mod skip; pub mod skip;
+49 -26
View File
@@ -1,10 +1,10 @@
use std::{ use std::{
ffi::OsString,
io::{stdout, Read, Write}, io::{stdout, Read, Write},
num::NonZeroUsize, num::NonZeroUsize,
path::PathBuf path::PathBuf
}; };
use converter::{run_conversion_loop, ConvertedPage, ConverterMsg};
use crossterm::{ use crossterm::{
execute, execute,
terminal::{ terminal::{
@@ -17,13 +17,11 @@ use glib::{LogField, LogLevel, LogWriterOutput};
use notify::{Event, EventKind, RecursiveMode, Watcher}; use notify::{Event, EventKind, RecursiveMode, Watcher};
use ratatui::{backend::CrosstermBackend, Terminal}; use ratatui::{backend::CrosstermBackend, Terminal};
use ratatui_image::picker::Picker; use ratatui_image::picker::Picker;
use renderer::{RenderError, RenderInfo, RenderNotif}; use tdf::{
use tui::{InputAction, Tui}; converter::{run_conversion_loop, ConvertedPage, ConverterMsg},
renderer::{self, RenderError, RenderInfo, RenderNotif},
mod converter; tui::{BottomMessage, InputAction, MessageSetting, Tui}
mod renderer; };
mod skip;
mod tui;
// Dummy struct for easy errors in main // Dummy struct for easy errors in main
#[derive(Debug)] #[derive(Debug)]
@@ -60,12 +58,26 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
let (render_tx, tui_rx) = flume::unbounded(); let (render_tx, tui_rx) = flume::unbounded();
let watch_to_tui_tx = render_tx.clone(); let watch_to_tui_tx = render_tx.clone();
let mut watcher = let mut watcher = notify::recommended_watcher(on_notify_ev(
notify::recommended_watcher(on_notify_ev(watch_to_tui_tx, watch_to_render_tx))?; watch_to_tui_tx,
watch_to_render_tx,
path.file_name()
.ok_or("Path does not have a last component??")?
.to_owned()
))?;
// We're making this nonrecursive 'cause we're just watching a single file, so there's nothing // So we have to watch the parent directory of the file that we are interested in because the
// to recurse into // `notify` library works on inodes, and if the file is deleted, that inode is gone as well,
watcher.watch(&path, RecursiveMode::NonRecursive)?; // and then the notify library just gives up on trying to watch for the file reappearing. Imo
// they should start watching the parent directory if the file is deleted, and then wait for it
// to reappear and then begin watching it again, but whatever. It seems they've made their
// opinion on this clear
// (https://github.com/notify-rs/notify/issues/113#issuecomment-281836995) so whatever, guess
// we have to do this annoying workaround.
watcher.watch(
path.parent().expect("The root directory is not a PDF"),
RecursiveMode::NonRecursive
)?;
// TODO: Handle non-utf8 file names? Maybe by constructing a CString and passing that in to the // TODO: Handle non-utf8 file names? Maybe by constructing a CString and passing that in to the
// poppler stuff instead of a rust string? // poppler stuff instead of a rust string?
@@ -143,7 +155,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
|| "Unknown file".into(), || "Unknown file".into(),
|n| n.to_string_lossy().to_string() |n| n.to_string_lossy().to_string()
); );
let mut tui = tui::Tui::new(file_name, flags.max_wide, flags.r_to_l.unwrap_or_default()); let mut tui = Tui::new(file_name, flags.max_wide, flags.r_to_l.unwrap_or_default());
let backend = CrosstermBackend::new(std::io::stdout()); let backend = CrosstermBackend::new(std::io::stdout());
let mut term = Terminal::new(backend)?; let mut term = Terminal::new(backend)?;
@@ -161,7 +173,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
)?; )?;
enable_raw_mode()?; enable_raw_mode()?;
let mut main_area = tui::Tui::main_layout(&term.get_frame()); let mut main_area = Tui::main_layout(&term.get_frame());
tui_tx.send(RenderNotif::Area(main_area[1]))?; tui_tx.send(RenderNotif::Area(main_area[1]))?;
let mut tui_rx = tui_rx.into_stream(); let mut tui_rx = tui_rx.into_stream();
@@ -190,10 +202,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
}, },
Some(renderer_msg) = tui_rx.next() => { Some(renderer_msg) = tui_rx.next() => {
match renderer_msg { match renderer_msg {
// if an Ok comes through, we know the error has been resolved ('cause it kinda Ok(render_info) => match render_info {
// bails whenever we run into an error) so just clear it
Ok(render_info) => {
match render_info {
RenderInfo::NumPages(num) => { RenderInfo::NumPages(num) => {
tui.set_n_pages(num); tui.set_n_pages(num);
to_converter.send(ConverterMsg::NumPages(num))?; to_converter.send(ConverterMsg::NumPages(num))?;
@@ -202,8 +211,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
tui.got_num_results_on_page(info.page, info.search_results); tui.got_num_results_on_page(info.page, info.search_results);
to_converter.send(ConverterMsg::AddImg(info))?; to_converter.send(ConverterMsg::AddImg(info))?;
}, },
} RenderInfo::Reloaded => tui.set_msg(MessageSetting::Some(BottomMessage::Reloaded)),
tui.set_bottom_msg(None);
}, },
Err(e) => tui.show_error(e), Err(e) => tui.show_error(e),
} }
@@ -243,7 +251,8 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
fn on_notify_ev( fn on_notify_ev(
to_tui_tx: flume::Sender<Result<RenderInfo, RenderError>>, to_tui_tx: flume::Sender<Result<RenderInfo, RenderError>>,
to_render_tx: flume::Sender<RenderNotif> to_render_tx: flume::Sender<RenderNotif>,
file_name: OsString
) -> impl Fn(notify::Result<Event>) { ) -> impl Fn(notify::Result<Event>) {
move |res| match res { move |res| match res {
// If we get an error here, and then an error sending, everything's going wrong. Just give // If we get an error here, and then an error sending, everything's going wrong. Just give
@@ -251,15 +260,29 @@ fn on_notify_ev(
Err(e) => to_tui_tx.send(Err(RenderError::Notify(e))).unwrap(), Err(e) => to_tui_tx.send(Err(RenderError::Notify(e))).unwrap(),
// TODO: Should we match EventKind::Rename and propogate that so that the other parts of the // TODO: Should we match EventKind::Rename and propogate that so that the other parts of the
// process know that too? Or should that be // process know that too? Or should that be
Ok(ev) => match ev.kind { Ok(ev) => {
// We only watch the parent directory (see the comment above `watcher.watch` in `fn
// main`) so we need to filter out events to only ones that pertain to the single file
// we care about
if !ev
.paths
.iter()
.any(|path| path.file_name().is_some_and(|f| f == file_name))
{
return;
}
match ev.kind {
EventKind::Access(_) => (), EventKind::Access(_) => (),
EventKind::Remove(_) => EventKind::Remove(_) => to_tui_tx
drop(to_tui_tx.send(Err(RenderError::Render("File was deleted".into())))), .send(Err(RenderError::Render("File was deleted".into())))
.unwrap(),
// This shouldn't fail to send unless the receiver gets disconnected. If that's // 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 // happened, then like the main thread has panicked or something, so it doesn't matter
// we don't handle the error here. // we don't handle the error here.
EventKind::Other | EventKind::Any | EventKind::Create(_) | EventKind::Modify(_) => EventKind::Other | EventKind::Any | EventKind::Create(_) | EventKind::Modify(_) =>
drop(to_render_tx.send(renderer::RenderNotif::Reload)), to_render_tx.send(RenderNotif::Reload).unwrap(),
}
} }
} }
} }
+19 -7
View File
@@ -25,7 +25,8 @@ pub enum RenderError {
pub enum RenderInfo { pub enum RenderInfo {
NumPages(usize), NumPages(usize),
Page(PageInfo) Page(PageInfo),
Reloaded
} }
#[derive(Clone)] #[derive(Clone)]
@@ -76,13 +77,11 @@ pub fn start_rendering(
) -> Result<(), SendError<Result<RenderInfo, RenderError>>> { ) -> Result<(), SendError<Result<RenderInfo, RenderError>>> {
// first, wait 'til we get told what the current starting area is so that we can set it to // first, wait 'til we get told what the current starting area is so that we can set it to
// know what to render to // know what to render to
let mut area; let mut area = loop {
loop {
if let RenderNotif::Area(r) = receiver.recv().unwrap() { if let RenderNotif::Area(r) = receiver.recv().unwrap() {
area = r; break r;
break;
}
} }
};
// We want this outside of 'reload so that if the doc reloads, the search term that somebody // We want this outside of 'reload so that if the doc reloads, the search term that somebody
// set will still get highlighted in the reloaded doc // set will still get highlighted in the reloaded doc
@@ -93,11 +92,17 @@ pub fn start_rendering(
let col_w = size.width / size.columns; let col_w = size.width / size.columns;
let col_h = size.height / size.rows; let col_h = size.height / size.rows;
let mut stored_doc = None;
'reload: loop { 'reload: loop {
let doc = match Document::from_file(path, None) { let doc = match Document::from_file(path, None) {
Err(e) => { Err(e) => {
// if there's an error, tell the main loop // if there's an error, tell the main loop
sender.send(Err(RenderError::Doc(e)))?; sender.send(Err(RenderError::Doc(e)))?;
match stored_doc {
Some(ref d) => d,
None => {
// then wait for a reload notif (since what probably happened is that the file was // then wait for a reload notif (since what probably happened is that the file was
// temporarily removed to facilitate a save or something like that) // temporarily removed to facilitate a save or something like that)
while let Ok(msg) = receiver.recv() { while let Ok(msg) = receiver.recv() {
@@ -110,7 +115,14 @@ pub fn start_rendering(
// done, so we're fine to just return // done, so we're fine to just return
return Ok(()); return Ok(());
} }
Ok(d) => d }
}
Ok(d) => {
if stored_doc.is_some() {
sender.send(Ok(RenderInfo::Reloaded))?;
}
&*stored_doc.insert(d)
}
}; };
let n_pages = doc.n_pages() as usize; let n_pages = doc.n_pages() as usize;
+38 -29
View File
@@ -43,7 +43,8 @@ pub enum BottomMessage {
Help, Help,
SearchResults(String), SearchResults(String),
Error(String), Error(String),
Input(InputCommand) Input(InputCommand),
Reloaded
} }
pub enum InputCommand { pub enum InputCommand {
@@ -186,6 +187,7 @@ impl Tui {
Color::Blue Color::Blue
) )
} }
BottomMessage::Reloaded => ("Document was reloaded!".into(), Color::Blue)
}; };
let span = Span::styled(msg_str, Style::new().fg(color)); let span = Span::styled(msg_str, Style::new().fg(color));
@@ -394,13 +396,13 @@ impl Tui {
'k' => self.change_page(PageChange::Prev, ChangeAmount::WholeScreen), 'k' => self.change_page(PageChange::Prev, ChangeAmount::WholeScreen),
'q' => Some(InputAction::QuitApp), 'q' => Some(InputAction::QuitApp),
'g' => { 'g' => {
self.set_bottom_msg(Some(BottomMessage::Input( self.set_msg(MessageSetting::Some(BottomMessage::Input(
InputCommand::GoToPage(0) InputCommand::GoToPage(0)
))); )));
Some(InputAction::Redraw) Some(InputAction::Redraw)
} }
'/' => { '/' => {
self.set_bottom_msg(Some(BottomMessage::Input( self.set_msg(MessageSetting::Some(BottomMessage::Input(
InputCommand::Search(String::new()) InputCommand::Search(String::new())
))); )));
Some(InputAction::Redraw) Some(InputAction::Redraw)
@@ -451,34 +453,33 @@ impl Tui {
KeyCode::Esc => match self.bottom_msg { KeyCode::Esc => match self.bottom_msg {
BottomMessage::Help => Some(InputAction::QuitApp), BottomMessage::Help => Some(InputAction::QuitApp),
_ => { _ => {
self.set_bottom_msg(None); // When we hit escape, we just want to pop off the current message and
// show the underlying one.
self.set_msg(MessageSetting::Pop);
Some(InputAction::Redraw) Some(InputAction::Redraw)
} }
}, },
KeyCode::Enter => { KeyCode::Enter => {
let BottomMessage::Input(_) = self.bottom_msg else { let mut default = BottomMessage::default();
std::mem::swap(&mut self.bottom_msg, &mut default);
let BottomMessage::Input(ref cmd) = default else {
std::mem::swap(&mut self.bottom_msg, &mut default);
return None; return None;
}; };
self.set_bottom_msg(None);
let Some(BottomMessage::Input(ref cmd)) = self.prev_msg else {
// We need to verify it's an input msg currently, and only then take it
// and replace it by a default Help message. Don't exactly know how to
// do this otherwise.
unreachable!();
};
match cmd { match cmd {
// Only forward the command if it's within range // Only forward the command if it's within range
InputCommand::GoToPage(page) => { InputCommand::GoToPage(page) => {
let page = *page; // We need to subtract 1 b/c they're tracked internally as
// 0-indexed but input and displayed as 1-indexed
let zero_page = page.saturating_sub(1);
let rendered_len = self.rendered.len(); let rendered_len = self.rendered.len();
if page < rendered_len { if zero_page < rendered_len {
self.set_page(page); self.set_page(zero_page);
Some(InputAction::JumpingToPage(page)) Some(InputAction::JumpingToPage(zero_page))
} else { } else {
self.set_bottom_msg(Some(BottomMessage::Error( self.set_msg(MessageSetting::Some(BottomMessage::Error(
format!("Cannot jump to page {page}; there are only {rendered_len} pages in the document") format!("Cannot jump to page {page}; there are only {rendered_len} pages in the document")
))); )));
Some(InputAction::Redraw) Some(InputAction::Redraw)
@@ -490,14 +491,14 @@ impl Tui {
// We only want to show search results if there would actually be // We only want to show search results if there would actually be
// data to show // data to show
if !term.is_empty() { if !term.is_empty() {
self.set_bottom_msg(Some(BottomMessage::SearchResults( self.set_msg(MessageSetting::Some(
term.clone() BottomMessage::SearchResults(term.clone())
))); ));
} else { } else {
// else, if it's not empty, we just want to reset the bottom // else, if it's not empty, we just want to reset the bottom
// area to show the default data; we don't want it to like show // area to show the default data; we don't want it to like show
// the data from a previous search // the data from a previous search
self.set_bottom_msg(Some(BottomMessage::Help)); self.set_msg(MessageSetting::Reset);
} }
// Reset all the search results // Reset all the search results
@@ -531,7 +532,7 @@ impl Tui {
} }
pub fn show_error(&mut self, err: RenderError) { pub fn show_error(&mut self, err: RenderError) {
self.set_bottom_msg(Some(BottomMessage::Error(match err { self.set_msg(MessageSetting::Some(BottomMessage::Error(match err {
RenderError::Notify(e) => format!("Auto-reload failed: {e}"), RenderError::Notify(e) => format!("Auto-reload failed: {e}"),
RenderError::Doc(e) => format!("Couldn't open document: {e}"), RenderError::Doc(e) => format!("Couldn't open document: {e}"),
RenderError::Render(e) => format!("Couldn't render page: {e}") RenderError::Render(e) => format!("Couldn't render page: {e}")
@@ -548,17 +549,18 @@ impl Tui {
// We have `msg` as optional so that if they reset it to none, it'll replace it with // We have `msg` as optional so that if they reset it to none, it'll replace it with
// `prev_msg`, but if they reset it to something else, it'll put the current thing in prev_msg // `prev_msg`, but if they reset it to something else, it'll put the current thing in prev_msg
pub fn set_bottom_msg(&mut self, msg: Option<BottomMessage>) { pub fn set_msg(&mut self, msg: MessageSetting) {
match msg { match msg {
Some(mut msg) => { MessageSetting::Some(mut msg) => {
std::mem::swap(&mut self.bottom_msg, &mut msg); std::mem::swap(&mut self.bottom_msg, &mut msg);
self.prev_msg = Some(msg); self.prev_msg = Some(msg);
} }
None => { MessageSetting::Default => self.set_msg(MessageSetting::Some(BottomMessage::default())),
let mut new_bottom = self.prev_msg.take().unwrap_or_default(); MessageSetting::Reset => {
std::mem::swap(&mut self.bottom_msg, &mut new_bottom); self.prev_msg = None;
self.prev_msg = Some(new_bottom); self.bottom_msg = BottomMessage::default();
} }
MessageSetting::Pop => self.bottom_msg = self.prev_msg.take().unwrap_or_default()
} }
} }
} }
@@ -581,3 +583,10 @@ enum ChangeAmount {
WholeScreen, WholeScreen,
Single Single
} }
pub enum MessageSetting {
Some(BottomMessage),
Default,
Reset,
Pop
}