aboutsummaryrefslogtreecommitdiff
path: root/src/tui
diff options
context:
space:
mode:
authorlukeflo2024-10-25 12:48:19 +0200
committerlukeflo2024-10-25 12:48:19 +0200
commit23ee04fffe4bdf4b8c34603e4b191d7cc308051b (patch)
tree70e4b146e388067dec7e4d5d1c5b8cd3628b5e4a /src/tui
parentbc4513d700b724b8edb72b6a1a429df60967a12c (diff)
downloadbibiman-23ee04fffe4bdf4b8c34603e4b191d7cc308051b.tar.gz
bibiman-23ee04fffe4bdf4b8c34603e4b191d7cc308051b.zip
Inegrate new command-action driven structure
- Map keys to actions to commands - allows for easily adding config file support - restructure folders/files - implement own input mode - rewrite UI rendering to make it better editable
Diffstat (limited to 'src/tui')
-rw-r--r--src/tui/command.rs374
-rw-r--r--src/tui/commands.rs (renamed from src/tui/commandnew.rs)10
-rw-r--r--src/tui/ui.rs44
3 files changed, 32 insertions, 396 deletions
diff --git a/src/tui/command.rs b/src/tui/command.rs
deleted file mode 100644
index 823a1dc..0000000
--- a/src/tui/command.rs
+++ /dev/null
@@ -1,374 +0,0 @@
-// bibiman - a TUI for managing BibLaTeX databases
-// Copyright (C) 2024 lukeflo
-//
-// This program is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// This program is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-// GNU General Public License for more details.
-//
-// You should have received a copy of the GNU General Public License
-// along with this program. If not, see <https://www.gnu.org/licenses/>.
-/////
-
-use crate::bibiman::entries::EntryTableColumn;
-use crate::bibiman::search::BibiSearch;
-use crate::bibiman::{Bibiman, FormerArea};
-use crate::tui::Tui;
-use color_eyre::eyre::{Context, Ok, Result};
-use core::panic;
-use editor_command::EditorBuilder;
-use ratatui::widgets::ScrollbarState;
-use std::process::{Command, Stdio};
-
-impl Bibiman {
- // Entry Table commands
-
- /// Select next entry in Table holding the bibliographic entries.
- ///
- /// Takes u16 value as argument to specify number of entries which
- /// should be scrolled
- pub fn select_next_entry(&mut self, entries: u16) {
- self.entry_table.entry_info_scroll = 0;
- self.entry_table.entry_info_scroll_state =
- self.entry_table.entry_info_scroll_state.position(0);
- self.entry_table.entry_table_state.scroll_down_by(entries);
- self.entry_table.entry_scroll_state = self
- .entry_table
- .entry_scroll_state
- .position(self.entry_table.entry_table_state.selected().unwrap());
- }
-
- /// Select previous entry in Table holding the bib entries.
- ///
- /// Takes u16 value as argument to specify number of entries which
- /// should be scrolled
- pub fn select_previous_entry(&mut self, entries: u16) {
- self.entry_table.entry_info_scroll = 0;
- self.entry_table.entry_info_scroll_state =
- self.entry_table.entry_info_scroll_state.position(0);
- self.entry_table.entry_table_state.scroll_up_by(entries);
- self.entry_table.entry_scroll_state = self
- .entry_table
- .entry_scroll_state
- .position(self.entry_table.entry_table_state.selected().unwrap());
- }
-
- /// Select first entry in bib list
- pub fn select_first_entry(&mut self) {
- self.entry_table.entry_info_scroll = 0;
- self.entry_table.entry_info_scroll_state =
- self.entry_table.entry_info_scroll_state.position(0);
- self.entry_table.entry_table_state.select_first();
- self.entry_table.entry_scroll_state = self.entry_table.entry_scroll_state.position(0);
- }
-
- /// Select last entry in bib list
- pub fn select_last_entry(&mut self) {
- self.entry_table.entry_info_scroll = 0;
- self.entry_table.entry_info_scroll_state =
- self.entry_table.entry_info_scroll_state.position(0);
- self.entry_table.entry_table_state.select_last();
- self.entry_table.entry_scroll_state = self
- .entry_table
- .entry_scroll_state
- .position(self.entry_table.entry_table_items.len());
- }
-
- /// Select next (right) column of entry table
- pub fn select_next_column(&mut self) {
- match self.entry_table.entry_table_selected_column {
- EntryTableColumn::Authors => {
- self.entry_table.entry_table_selected_column = EntryTableColumn::Title;
- }
- EntryTableColumn::Title => {
- self.entry_table.entry_table_selected_column = EntryTableColumn::Year;
- }
- EntryTableColumn::Year => {
- self.entry_table.entry_table_selected_column = EntryTableColumn::Pubtype;
- }
- EntryTableColumn::Pubtype => {
- self.entry_table.entry_table_selected_column = EntryTableColumn::Authors;
- }
- }
- }
-
- /// Select previous (left) column of entry table
- pub fn select_prev_column(&mut self) {
- match self.entry_table.entry_table_selected_column {
- EntryTableColumn::Authors => {
- self.entry_table.entry_table_selected_column = EntryTableColumn::Pubtype;
- }
- EntryTableColumn::Title => {
- self.entry_table.entry_table_selected_column = EntryTableColumn::Authors;
- }
- EntryTableColumn::Year => {
- self.entry_table.entry_table_selected_column = EntryTableColumn::Title;
- }
- EntryTableColumn::Pubtype => {
- self.entry_table.entry_table_selected_column = EntryTableColumn::Year;
- }
- }
- }
-
- // Get the citekey of the selected entry
- pub fn get_selected_citekey(&self) -> &str {
- let idx = self.entry_table.entry_table_state.selected().unwrap();
- let citekey = &self.entry_table.entry_table_items[idx].citekey;
- citekey
- }
-
- pub fn run_editor(&mut self, tui: &mut Tui) -> Result<()> {
- // get filecontent and citekey for calculating line number
- let citekey = self.get_selected_citekey();
- // create independent copy of citekey for finding entry after updating list
- let saved_key = citekey.to_owned();
- let filepath = self.main_biblio.bibfile.display().to_string();
- let filecontent = self.main_biblio.bibfilestring.clone();
- let mut line_count = 0;
-
- for line in filecontent.lines() {
- line_count = line_count + 1;
- // if reaching the citekey break the loop
- // if reaching end of lines without match, reset to 0
- if line.contains(&citekey) {
- break;
- } else if line_count == filecontent.len() {
- eprintln!(
- "Citekey {} not found, opening file {} at line 1",
- &citekey, &filepath
- );
- line_count = 0;
- break;
- }
- }
-
- // Exit TUI to enter editor
- tui.exit()?;
- // Use VISUAL or EDITOR. Set "vi" as last fallback
- let mut cmd: Command = EditorBuilder::new()
- .environment()
- .source(Some("vi"))
- .build()
- .unwrap();
- // Prepare arguments to open file at specific line
- let args: Vec<String> = vec![format!("+{}", line_count), filepath];
- let status = cmd.args(&args).status()?;
- if !status.success() {
- eprintln!("Spawning editor failed with status {}", status);
- }
-
- // Enter TUI again
- tui.enter()?;
- tui.terminal.clear()?;
-
- // Update the database and the lists to show changes
- self.update_lists();
-
- // Search for entry, selected before editing, by matching citekeys
- // Use earlier saved copy of citekey to match
- let mut idx_count = 0;
- loop {
- if self.entry_table.entry_table_items[idx_count]
- .citekey
- .contains(&saved_key)
- {
- break;
- }
- idx_count = idx_count + 1
- }
-
- // Set selected entry to vec-index of match
- self.entry_table.entry_table_state.select(Some(idx_count));
-
- Ok(())
- }
-
- // Search entry list
- pub fn search_entries(&mut self) {
- // Use snapshot of entry list saved when starting the search
- // so deleting a char, will show former entries too
- let orig_list = self.entry_table.entry_table_at_search_start.clone();
- let filtered_list =
- BibiSearch::search_entry_list(&mut self.search_struct.search_string, orig_list.clone());
- self.entry_table.entry_table_items = filtered_list;
- if self.entry_table.entry_table_reversed_sort {
- self.entry_table.sort_entry_table(false);
- }
- self.entry_table.entry_scroll_state = ScrollbarState::content_length(
- self.entry_table.entry_scroll_state,
- self.entry_table.entry_table_items.len(),
- );
- }
-
- // Open file connected with entry through 'file' or 'pdf' field
- pub fn open_connected_file(&mut self) -> Result<()> {
- let idx = self.entry_table.entry_table_state.selected().unwrap();
- let filepath = &self.entry_table.entry_table_items[idx].filepath.clone();
-
- // Build command to execute pdf-reader. 'xdg-open' is Linux standard
- let cmd = {
- match std::env::consts::OS {
- "linux" => String::from("xdg-open"),
- "macos" => String::from("open"),
- "windows" => String::from("start"),
- _ => panic!("Couldn't detect OS for setting correct opener"),
- }
- };
-
- // Pass filepath as argument, pipe stdout and stderr to /dev/null
- // to keep the TUI clean (where is it piped on Windows???)
- let _ = Command::new(&cmd)
- .arg(&filepath)
- .stdout(Stdio::null())
- .stderr(Stdio::null())
- .spawn()
- .wrap_err("Opening file not possible");
-
- Ok(())
- }
-
- pub fn open_doi_url(&mut self) -> Result<()> {
- let idx = self.entry_table.entry_table_state.selected().unwrap();
- let web_adress = self.entry_table.entry_table_items[idx].doi_url.clone();
-
- // Resolve strings using the resolving function of dx.doi.org, so the
- // terminal is not blocked by the resolving process
- let url = if web_adress.starts_with("10.") {
- let prefix = "https://doi.org/".to_string();
- prefix + &web_adress
- } else if web_adress.starts_with("www.") {
- let prefix = "https://".to_string();
- prefix + &web_adress
- } else {
- web_adress
- };
-
- // Build command to execute browser. 'xdg-open' is Linux standard
- let cmd = {
- match std::env::consts::OS {
- "linux" => String::from("xdg-open"),
- "macos" => String::from("open"),
- "windows" => String::from("start"),
- _ => panic!("Couldn't detect OS for setting correct opener"),
- }
- };
-
- // Pass filepath as argument, pipe stdout and stderr to /dev/null
- // to keep the TUI clean (where is it piped on Windows???)
- let _ = Command::new(&cmd)
- .arg(url)
- .stdout(Stdio::null())
- .stderr(Stdio::null())
- .spawn()
- .wrap_err("Opening file not possible");
-
- Ok(())
- }
-}
-
-impl Bibiman {
- // Tag List commands
-
- // Movement
- pub fn select_next_tag(&mut self, keywords: u16) {
- self.tag_list.tag_list_state.scroll_down_by(keywords);
- self.tag_list.tag_scroll_state = self
- .tag_list
- .tag_scroll_state
- .position(self.tag_list.tag_list_state.selected().unwrap());
- }
-
- pub fn select_previous_tag(&mut self, keywords: u16) {
- self.tag_list.tag_list_state.scroll_up_by(keywords);
- self.tag_list.tag_scroll_state = self
- .tag_list
- .tag_scroll_state
- .position(self.tag_list.tag_list_state.selected().unwrap());
- }
-
- pub fn select_first_tag(&mut self) {
- self.tag_list.tag_list_state.select_first();
- self.tag_list.tag_scroll_state = self.tag_list.tag_scroll_state.position(0);
- }
-
- pub fn select_last_tag(&mut self) {
- self.tag_list.tag_list_state.select_last();
- self.tag_list.tag_scroll_state = self
- .tag_list
- .tag_scroll_state
- .position(self.tag_list.tag_list_items.len());
- }
-
- pub fn get_selected_tag(&self) -> &str {
- let idx = self.tag_list.tag_list_state.selected().unwrap();
- let keyword = &self.tag_list.tag_list_items[idx];
- // let keyword = &self.tag_list.tag_list_items[idx].keyword;
- keyword
- }
-
- pub fn search_tags(&mut self) {
- let orig_list = &self.main_biblio.keyword_list;
- let filtered_list =
- BibiSearch::search_tag_list(&self.search_struct.search_string, orig_list.clone());
- self.tag_list.tag_list_items = filtered_list;
- // Update scrollbar length after filtering list
- self.tag_list.tag_scroll_state = ScrollbarState::content_length(
- self.tag_list.tag_scroll_state,
- self.tag_list.tag_list_items.len(),
- );
- }
-
- pub fn filter_tags_by_entries(&mut self) {
- let mut filtered_keywords: Vec<String> = Vec::new();
-
- let orig_list = &self.entry_table.entry_table_items;
-
- for e in orig_list {
- if !e.keywords.is_empty() {
- let mut key_vec: Vec<String> = e
- .keywords
- .split(',')
- .map(|s| s.trim().to_string())
- .filter(|s| !s.is_empty())
- .collect();
- filtered_keywords.append(&mut key_vec);
- }
- }
-
- filtered_keywords.sort_by(|a, b| a.to_lowercase().cmp(&b.to_lowercase()));
- filtered_keywords.dedup();
-
- self.search_struct.filtered_tag_list = filtered_keywords.clone();
- self.tag_list.tag_list_items = filtered_keywords;
- self.tag_list.tag_scroll_state = ScrollbarState::content_length(
- self.tag_list.tag_scroll_state,
- self.tag_list.tag_list_items.len(),
- );
- }
-
- // Filter the entry list by tags when hitting enter
- // If already inside a filtered tag or entry list, apply the filtering
- // to the already filtered list only
- pub fn filter_for_tags(&mut self) {
- let orig_list = &self.entry_table.entry_table_items;
- let keyword = self.get_selected_tag();
- let filtered_list = BibiSearch::filter_entries_by_tag(&keyword, &orig_list);
- // self.tag_list.selected_keyword = keyword.to_string();
- self.tag_list.selected_keywords.push(keyword.to_string());
- self.entry_table.entry_table_items = filtered_list;
- // Update scrollbar state with new lenght of itemlist
- self.entry_table.entry_scroll_state = ScrollbarState::content_length(
- self.entry_table.entry_scroll_state,
- self.entry_table.entry_table_items.len(),
- );
- self.filter_tags_by_entries();
- self.toggle_area();
- self.entry_table.entry_table_state.select(Some(0));
- self.former_area = Some(FormerArea::TagArea);
- }
-}
diff --git a/src/tui/commandnew.rs b/src/tui/commands.rs
index 1f70264..dc6b2c8 100644
--- a/src/tui/commandnew.rs
+++ b/src/tui/commands.rs
@@ -146,6 +146,8 @@ impl From<KeyEvent> for CmdAction {
KeyCode::Char('e') => Self::EditFile,
// Yank selected item/value
KeyCode::Char('y') => Self::YankItem,
+ // Sort entry table by selected col
+ KeyCode::Char('s') => Self::SortList,
// Else do nothing
_ => Self::Nothing,
}
@@ -173,14 +175,16 @@ pub enum InputCmdAction {
Confirm,
// Exit input mode
Exit,
+ // Do nothing
+ Nothing,
}
impl InputCmdAction {
/// Parses the event.
pub fn parse(key_event: KeyEvent, input: &Input) -> Self {
- if key_event.code == KeyCode::Esc
- || (key_event.code == KeyCode::Backspace && input.value().is_empty())
- {
+ if key_event.code == KeyCode::Backspace && input.value().is_empty() {
+ Self::Nothing
+ } else if key_event.code == KeyCode::Esc {
Self::Exit
} else if key_event.code == KeyCode::Enter {
Self::Confirm
diff --git a/src/tui/ui.rs b/src/tui/ui.rs
index 9e561c3..507177b 100644
--- a/src/tui/ui.rs
+++ b/src/tui/ui.rs
@@ -32,7 +32,6 @@ use ratatui::{
ScrollbarOrientation, Table, Wrap,
},
};
-use tui_input::Input;
const MAIN_BLUE_COLOR: Color = Color::Indexed(39);
// const MAIN_PURPLE_COLOR: Color = Color::Indexed(129);
@@ -99,14 +98,6 @@ pub fn render_ui(app: &mut App, frame: &mut Frame) {
render_entrytable(app, frame, entry_area);
render_selected_item(app, frame, info_area);
render_taglist(app, frame, tag_area);
- // Bibiman::render_header(header_area, buf);
- // self.bibiman.render_footer(footer_area, buf);
- // Render list area where entry gets selected
- // self.bibiman.render_entrytable(entry_area, buf);
- // self.bibiman.render_file_info(entry_info_area, buf);
- // Render infos related to selected entry
- // self.bibiman.render_taglist(tag_area, buf);
- // self.bibiman.render_selected_item(info_area, buf);
}
pub fn render_header(frame: &mut Frame, rect: Rect) {
@@ -141,11 +132,13 @@ pub fn render_footer(app: &mut App, frame: &mut Frame, rect: Rect) {
.title(Line::styled(search_title, BOX_SELECTED_TITLE_STYLE))
.border_style(BOX_SELECTED_BOX_STYLE)
.border_set(symbols::border::THICK);
+ render_cursor(app, frame, rect);
frame.render_widget(
- Paragraph::new(app.bibiman.search_struct.search_string.clone()).block(block),
+ Paragraph::new(app.bibiman.search_struct.search_string.clone())
+ .block(block)
+ .fg(TEXT_FG_COLOR),
rect,
);
- render_cursor(app, frame, rect);
}
_ => {
let style_emph = Style::new().bold().fg(TEXT_FG_COLOR);
@@ -244,13 +237,28 @@ pub fn render_file_info(app: &mut App, frame: &mut Frame, rect: Rect) {
{
vec![
Span::raw(
- (app.bibiman
+ // Because method scroll_down_by() of TableState lets numbers
+ // printed overflow for short moment, we have to check manually
+ // that we do not print a number higher than len() of table
+ if app
+ .bibiman
.entry_table
.entry_table_state
.selected()
.unwrap()
- + 1)
- .to_string(),
+ + 1
+ > app.bibiman.entry_table.entry_table_items.len()
+ {
+ app.bibiman.entry_table.entry_table_items.len().to_string()
+ } else {
+ (app.bibiman
+ .entry_table
+ .entry_table_state
+ .selected()
+ .unwrap()
+ + 1)
+ .to_string()
+ },
)
.bold(),
Span::raw("/"),
@@ -671,6 +679,7 @@ pub fn render_taglist(app: &mut App, frame: &mut Frame, rect: Rect) {
let list = List::new(items)
.block(block)
.highlight_style(SELECTED_STYLE)
+ .fg(TEXT_FG_COLOR)
// .highlight_symbol("> ")
.highlight_spacing(HighlightSpacing::Always);
@@ -705,13 +714,10 @@ pub fn render_taglist(app: &mut App, frame: &mut Frame, rect: Rect) {
/// Render the cursor when in InputMode
fn render_cursor(app: &mut App, frame: &mut Frame, area: Rect) {
+ let scroll = app.input.visual_scroll(area.width as usize);
if app.input_mode {
let (x, y) = (
- area.x
- + Input::default()
- .with_value(app.input.value().to_string())
- .visual_cursor() as u16
- + 1,
+ area.x + ((app.input.visual_cursor()).max(scroll) - scroll) as u16 + 1,
area.bottom().saturating_sub(2),
);
frame.render_widget(