television/crates/television/television.rs

431 lines
15 KiB
Rust

use crate::app::Keymap;
use crate::picker::Picker;
use crate::ui::input::actions::InputActionHandler;
use crate::ui::layout::{Dimensions, Layout};
use crate::ui::spinner::Spinner;
use crate::ui::spinner::SpinnerState;
use crate::{action::Action, config::Config};
use color_eyre::Result;
use copypasta::{ClipboardContext, ClipboardProvider};
use ratatui::{layout::Rect, style::Color, widgets::Paragraph, Frame};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use television_channels::channels::{
remote_control::RemoteControl, OnAir, TelevisionChannel, UnitChannel,
};
use television_channels::entry::{Entry, ENTRY_PLACEHOLDER};
use television_previewers::previewers;
use television_previewers::previewers::Previewer;
use television_utils::strings::EMPTY_STRING;
use tokio::sync::mpsc::UnboundedSender;
#[derive(PartialEq, Copy, Clone, Hash, Eq, Debug, Serialize, Deserialize)]
pub enum Mode {
Channel,
RemoteControl,
SendToChannel,
}
pub struct Television {
action_tx: Option<UnboundedSender<Action>>,
pub config: Config,
pub keymap: Keymap,
pub(crate) channel: TelevisionChannel,
pub(crate) remote_control: TelevisionChannel,
pub mode: Mode,
current_pattern: String,
pub(crate) results_picker: Picker,
pub(crate) rc_picker: Picker,
results_area_height: u32,
pub previewer: Previewer,
pub preview_scroll: Option<u16>,
pub preview_pane_height: u16,
current_preview_total_lines: u16,
/// A cache for meta paragraphs (i.e. previews like "Not Supported", etc.).
///
/// The key is a tuple of the preview name and the dimensions of the
/// preview pane. This is a little extra security to ensure meta previews
/// are rendered correctly even when resizing the terminal while still
/// benefiting from a cache mechanism.
pub meta_paragraph_cache: HashMap<(String, u16, u16), Paragraph<'static>>,
pub(crate) spinner: Spinner,
pub(crate) spinner_state: SpinnerState,
}
impl Television {
#[must_use]
pub fn new(mut channel: TelevisionChannel) -> Self {
channel.find(EMPTY_STRING);
let spinner = Spinner::default();
Self {
action_tx: None,
config: Config::default(),
keymap: Keymap::default(),
channel,
remote_control: TelevisionChannel::RemoteControl(
RemoteControl::default(),
),
mode: Mode::Channel,
current_pattern: EMPTY_STRING.to_string(),
results_picker: Picker::default().inverted(),
rc_picker: Picker::default(),
results_area_height: 0,
previewer: Previewer::default(),
preview_scroll: None,
preview_pane_height: 0,
current_preview_total_lines: 0,
meta_paragraph_cache: HashMap::new(),
spinner,
spinner_state: SpinnerState::from(&spinner),
}
}
pub fn current_channel(&self) -> UnitChannel {
UnitChannel::from(&self.channel)
}
pub fn change_channel(&mut self, channel: TelevisionChannel) {
self.reset_preview_scroll();
self.reset_picker_selection();
self.reset_picker_input();
self.current_pattern = EMPTY_STRING.to_string();
self.channel.shutdown();
self.channel = channel;
}
fn find(&mut self, pattern: &str) {
match self.mode {
Mode::Channel => {
self.channel.find(pattern);
}
Mode::RemoteControl | Mode::SendToChannel => {
self.remote_control.find(pattern);
}
}
}
#[must_use]
pub fn get_selected_entry(&mut self, mode: Option<Mode>) -> Option<Entry> {
match mode.unwrap_or(self.mode) {
Mode::Channel => self.results_picker.selected().and_then(|i| {
self.channel.get_result(u32::try_from(i).unwrap())
}),
Mode::RemoteControl | Mode::SendToChannel => {
self.rc_picker.selected().and_then(|i| {
self.remote_control.get_result(u32::try_from(i).unwrap())
})
}
}
}
pub fn select_prev_entry(&mut self, step: u32) {
let (result_count, picker) = match self.mode {
Mode::Channel => {
(self.channel.result_count(), &mut self.results_picker)
}
Mode::RemoteControl | Mode::SendToChannel => {
(self.remote_control.total_count(), &mut self.rc_picker)
}
};
if result_count == 0 {
return;
}
picker.select_prev(
step,
result_count as usize,
self.results_area_height as usize,
);
}
pub fn select_next_entry(&mut self, step: u32) {
let (result_count, picker) = match self.mode {
Mode::Channel => {
(self.channel.result_count(), &mut self.results_picker)
}
Mode::RemoteControl | Mode::SendToChannel => {
(self.remote_control.total_count(), &mut self.rc_picker)
}
};
if result_count == 0 {
return;
}
picker.select_next(
step,
result_count as usize,
self.results_area_height as usize,
);
}
fn reset_preview_scroll(&mut self) {
self.preview_scroll = None;
}
fn reset_picker_selection(&mut self) {
match self.mode {
Mode::Channel => self.results_picker.reset_selection(),
Mode::RemoteControl | Mode::SendToChannel => {
self.rc_picker.reset_selection()
}
}
}
fn reset_picker_input(&mut self) {
match self.mode {
Mode::Channel => self.results_picker.reset_input(),
Mode::RemoteControl | Mode::SendToChannel => {
self.rc_picker.reset_input()
}
}
}
pub fn scroll_preview_down(&mut self, offset: u16) {
if self.preview_scroll.is_none() {
self.preview_scroll = Some(0);
}
if let Some(scroll) = self.preview_scroll {
self.preview_scroll = Some(
(scroll + offset).min(
self.current_preview_total_lines
.saturating_sub(2 * self.preview_pane_height / 3),
),
);
}
}
pub fn scroll_preview_up(&mut self, offset: u16) {
if let Some(scroll) = self.preview_scroll {
self.preview_scroll = Some(scroll.saturating_sub(offset));
}
}
}
// Styles
// input
pub(crate) const DEFAULT_INPUT_FG: Color = Color::LightRed;
pub(crate) const DEFAULT_RESULTS_COUNT_FG: Color = Color::LightRed;
impl Television {
/// Register an action handler that can send actions for processing if necessary.
///
/// # Arguments
/// * `tx` - An unbounded sender that can send actions.
///
/// # Returns
/// * `Result<()>` - An Ok result or an error.
pub fn register_action_handler(
&mut self,
tx: UnboundedSender<Action>,
) -> Result<()> {
self.action_tx = Some(tx.clone());
Ok(())
}
/// Register a configuration handler that provides configuration settings if necessary.
///
/// # Arguments
/// * `config` - Configuration settings.
///
/// # Returns
/// * `Result<()>` - An Ok result or an error.
pub fn register_config_handler(&mut self, config: Config) -> Result<()> {
self.config = config;
self.keymap = Keymap::from(&self.config.keybindings);
let previewer_config =
std::convert::Into::<previewers::PreviewerConfig>::into(
self.config.previewers.clone(),
);
self.previewer.set_config(previewer_config);
Ok(())
}
/// Update the state of the component based on a received action.
///
/// # Arguments
/// * `action` - An action that may modify the state of the television.
///
/// # Returns
/// * `Result<Option<Action>>` - An action to be processed or none.
pub async fn update(&mut self, action: Action) -> Result<Option<Action>> {
match action {
// handle input actions
Action::AddInputChar(_)
| Action::DeletePrevChar
| Action::DeleteNextChar
| Action::GoToInputEnd
| Action::GoToInputStart
| Action::GoToNextChar
| Action::GoToPrevChar => {
let input = match self.mode {
Mode::Channel => &mut self.results_picker.input,
Mode::RemoteControl | Mode::SendToChannel => {
&mut self.rc_picker.input
}
};
input.handle_action(&action);
match action {
Action::AddInputChar(_)
| Action::DeletePrevChar
| Action::DeleteNextChar => {
let new_pattern = input.value().to_string();
if new_pattern != self.current_pattern {
self.current_pattern.clone_from(&new_pattern);
self.find(&new_pattern);
self.reset_picker_selection();
self.reset_preview_scroll();
}
}
_ => {}
}
}
Action::SelectNextEntry => {
self.reset_preview_scroll();
self.select_next_entry(1);
}
Action::SelectPrevEntry => {
self.reset_preview_scroll();
self.select_prev_entry(1);
}
Action::SelectNextPage => {
self.reset_preview_scroll();
self.select_next_entry(self.results_area_height);
}
Action::SelectPrevPage => {
self.reset_preview_scroll();
self.select_prev_entry(self.results_area_height);
}
Action::ScrollPreviewDown => self.scroll_preview_down(1),
Action::ScrollPreviewUp => self.scroll_preview_up(1),
Action::ScrollPreviewHalfPageDown => self.scroll_preview_down(20),
Action::ScrollPreviewHalfPageUp => self.scroll_preview_up(20),
Action::ToggleRemoteControl => match self.mode {
Mode::Channel => {
self.remote_control = TelevisionChannel::RemoteControl(
RemoteControl::default(),
);
self.mode = Mode::RemoteControl;
}
Mode::RemoteControl => {
// this resets the RC picker
self.reset_picker_input();
self.remote_control.find(EMPTY_STRING);
self.reset_picker_selection();
self.mode = Mode::Channel;
}
Mode::SendToChannel => {}
},
Action::SelectEntry => {
if let Some(entry) = self.get_selected_entry(None) {
match self.mode {
Mode::Channel => self
.action_tx
.as_ref()
.unwrap()
.send(Action::SelectAndExit)?,
Mode::RemoteControl => {
// FIXME: this is kind of shitty
let new_channel = TelevisionChannel::from(&entry);
// this resets the RC picker
self.reset_picker_selection();
self.reset_picker_input();
self.remote_control.find(EMPTY_STRING);
self.mode = Mode::Channel;
self.change_channel(new_channel);
}
Mode::SendToChannel => {
let new_channel = self
.channel
.transition_to(entry.name.as_str().into());
self.reset_picker_selection();
self.reset_picker_input();
self.remote_control.find(EMPTY_STRING);
self.mode = Mode::Channel;
self.change_channel(new_channel);
}
}
}
}
Action::CopyEntryToClipboard => {
if self.mode == Mode::Channel {
if let Some(entry) = self.get_selected_entry(None) {
let mut ctx = ClipboardContext::new().unwrap();
ctx.set_contents(entry.name).unwrap();
}
}
}
Action::ToggleSendToChannel => match self.mode {
Mode::Channel | Mode::RemoteControl => {
self.mode = Mode::SendToChannel;
self.remote_control = TelevisionChannel::RemoteControl(
RemoteControl::with_transitions_from(&self.channel),
);
}
Mode::SendToChannel => {
self.reset_picker_input();
self.remote_control.find(EMPTY_STRING);
self.reset_picker_selection();
self.mode = Mode::Channel;
}
},
Action::ToggleHelp => {
self.config.ui.show_help_bar = !self.config.ui.show_help_bar;
}
_ => {}
}
Ok(None)
}
/// Render the television on the screen.
///
/// # Arguments
/// * `f` - A frame used for rendering.
/// * `area` - The area in which the television should be drawn.
///
/// # Returns
/// * `Result<()>` - An Ok result or an error.
pub fn draw(&mut self, f: &mut Frame<'_>, area: Rect) -> Result<()> {
let layout = Layout::build(
&Dimensions::from(self.config.ui.ui_scale),
area,
!matches!(self.mode, Mode::Channel),
self.config.ui.show_help_bar,
);
// help bar (metadata, keymaps, logo)
self.draw_help_bar(f, &layout)?;
self.results_area_height = u32::from(layout.results.height - 2); // 2 for the borders
self.preview_pane_height = layout.preview_window.height;
// top left block: results
self.draw_results_list(f, &layout)?;
// bottom left block: input
self.draw_input_box(f, &layout)?;
let selected_entry = self
.get_selected_entry(Some(Mode::Channel))
.unwrap_or(ENTRY_PLACEHOLDER);
let preview = self.previewer.preview(&selected_entry);
// top right block: preview title
self.current_preview_total_lines = preview.total_lines();
self.draw_preview_title_block(f, &layout, &preview)?;
// bottom right block: preview content
self.draw_preview_content_block(
f,
&layout,
selected_entry
.line_number
.map(|l| u16::try_from(l).unwrap_or(0)),
&preview,
);
// remote control
if matches!(self.mode, Mode::RemoteControl | Mode::SendToChannel) {
self.draw_remote_control(f, &layout.remote_control.unwrap())?;
}
Ok(())
}
}