wayvr/dash-frontend/src/util/popup_manager.rs

use std::{
	cell::RefCell,
	rc::{Rc, Weak},
};

use wgui::{
	assets::AssetPath,
	components::button::ComponentButton,
	event::EventAlterables,
	globals::WguiGlobals,
	i18n::Translation,
	layout::{Layout, LayoutTask, LayoutTasks, WidgetID},
	parser::{Fetchable, ParseDocumentParams, ParserState},
	widget::label::WidgetLabel,
};
use wlx_common::config::GeneralConfig;

use crate::{
	frontend::{FrontendTask, FrontendTasks},
	views::{ViewTrait, ViewUpdateParams},
};

pub struct PopupManagerParams {
	pub parent_id: WidgetID,
}

struct State {
	popup_stack: Vec<Weak<RefCell<MountedPopupState>>>,
}

pub struct MountedPopup {
	#[allow(dead_code)]
	state: ParserState,
	id_root: WidgetID, // decorations of a popup
	layout_tasks: LayoutTasks,
	frontend_tasks: FrontendTasks,
}

#[derive(Default)]
struct MountedPopupState {
	mounted_popup: Option<MountedPopup>,
	closed_callback: Option<PopupClosedCallback>,
}

#[derive(Default, Clone)]
pub struct PopupHandle {
	state: Rc<RefCell<MountedPopupState>>,
}

struct PopupHolderState<ViewType: ViewTrait> {
	popup_handle: PopupHandle,
	view: Option<ViewType>,
	on_view_close: Option<Box<dyn FnOnce()>>,
}

// we can't use #[derive(Default)] due to the fact that ViewType can't be Default.
impl<ViewType: ViewTrait> Default for PopupHolderState<ViewType> {
	fn default() -> Self {
		Self {
			popup_handle: Default::default(),
			view: None,
			on_view_close: None,
		}
	}
}

pub struct PopupHolder<ViewType: ViewTrait> {
	state: Rc<RefCell<PopupHolderState<ViewType>>>,
}

impl<ViewType: ViewTrait> Default for PopupHolder<ViewType> {
	fn default() -> Self {
		Self {
			state: Rc::new(RefCell::new(PopupHolderState::default())),
		}
	}
}

impl<ViewType: ViewTrait> PopupHolderState<ViewType> {
	fn close(&mut self) {
		if self.view.is_some() {
			self.view = None;
			if let Some(on_close) = self.on_view_close.take() {
				on_close();
			}
		}
		self.popup_handle.close();
	}
}

impl<ViewType: ViewTrait> Drop for PopupHolderState<ViewType> {
	fn drop(&mut self) {
		self.close();
	}
}

// we can't derive(Clone) due to the fact that ViewType is non-cloneable
impl<ViewType: ViewTrait> Clone for PopupHolder<ViewType> {
	fn clone(&self) -> Self {
		Self {
			state: self.state.clone(),
		}
	}
}

impl<ViewType: ViewTrait> PopupHolder<ViewType> {
	pub fn update(&self, par: &mut ViewUpdateParams) -> anyhow::Result<()> {
		let mut state = self.state.borrow_mut();
		let Some(view) = &mut state.view else {
			return Ok(());
		};

		view.update(par)
	}

	pub fn set_view(&self, handle: PopupHandle, view: ViewType, on_view_close: Option<Box<dyn FnOnce()>>) {
		let mut state = self.state.borrow_mut();
		state.view = Some(view);
		state.popup_handle = handle;
		state.on_view_close = on_view_close;
	}

	// Get underlying ViewType object in a closure and return its value
	// example usage:
	//
	// ```rs
	// holder.with_view(|view| {
	//   view.foo();
	// })
	// ```
	//
	pub fn with_view<F, R>(&self, f: F) -> Option<R>
	where
		F: FnOnce(&mut ViewType) -> R,
	{
		let mut state = self.state.borrow_mut();
		state.view.as_mut().map(f)
	}

	// Same as with_view, but the closure expects a simple anyhow::Result<()> type
	pub fn with_view_res<F>(&self, f: F) -> anyhow::Result<()>
	where
		F: FnOnce(&mut ViewType) -> anyhow::Result<()>,
	{
		if let Some(res) = self.with_view(f) {
			return res;
		}
		Ok(())
	}

	pub fn get_close_callback(&self, layout: &Layout) -> Box<dyn FnOnce()>
	where
		ViewType: 'static,
	{
		let layout_tasks = layout.tasks.clone();
		let weak_state = Rc::downgrade(&self.state);
		Box::new(move || {
			// we can't borrow State here yet, dispatch it.
			layout_tasks.push(LayoutTask::Dispatch(Box::new(move |_common| {
				if let Some(state) = weak_state.upgrade() {
					state.borrow_mut().close();
				}
				Ok(())
			})));
		})
	}
}

impl PopupHandle {
	pub fn close(&self) {
		self.state.borrow_mut().mounted_popup = None; // Drop will be called
	}
}

pub struct PopupManager {
	state: Rc<RefCell<State>>,
	parent_id: WidgetID,
}

pub struct PopupContentFuncData<'a> {
	pub layout: &'a mut Layout,
	pub config: &'a GeneralConfig,
	pub handle: PopupHandle,
	pub id_content: WidgetID,
}

type PopupClosedCallback = Box<dyn FnOnce()>;
type OnContentCallback = Box<dyn FnOnce(PopupContentFuncData) -> anyhow::Result<PopupClosedCallback>>;

// we need to implement Clone here, but the underlying function can be called only once.
// on_content will be cleared after the first call
#[derive(Clone)]
pub struct MountPopupOnceParams {
	title: Translation,
	on_content: Rc<RefCell<Option<OnContentCallback>>>,
}

impl MountPopupOnceParams {
	pub fn new(title: Translation, on_content: OnContentCallback) -> Self {
		Self {
			title,
			on_content: Rc::new(RefCell::new(Some(on_content))),
		}
	}
}

impl Drop for MountedPopup {
	fn drop(&mut self) {
		self.layout_tasks.push(LayoutTask::RemoveWidget(self.id_root));
		self.frontend_tasks.push(FrontendTask::RefreshPopupManager);
	}
}

impl State {
	fn refresh_stack(&mut self, alterables: &mut EventAlterables) {
		// show only the topmost popup
		self.popup_stack.retain(|weak| {
			let retain = {
				let Some(popup) = weak.upgrade() else {
					return false;
				};
				popup.borrow_mut().mounted_popup.is_some()
			};
			if !retain {
				log::debug!("removing popup from popup_stack");
			}
			retain
		});

		for (idx, popup) in self.popup_stack.iter().enumerate() {
			let popup = popup.upgrade().unwrap(); // safe
			let popup = popup.borrow_mut();
			let mounted_popup = popup.mounted_popup.as_ref().unwrap(); // safe;
			alterables.set_widget_visible(mounted_popup.id_root, idx == self.popup_stack.len() - 1);
		}
	}
}

impl PopupManager {
	pub fn new(params: PopupManagerParams) -> Self {
		Self {
			parent_id: params.parent_id,
			state: Rc::new(RefCell::new(State {
				popup_stack: Vec::new(),
			})),
		}
	}

	pub fn refresh(&self, alterables: &mut EventAlterables) {
		let mut state = self.state.borrow_mut();
		state.refresh_stack(alterables);
	}

	fn mount_popup_prepare(
		&self,
		globals: &WguiGlobals,
		layout: &mut Layout,
		frontend_tasks: &FrontendTasks,
		popup_title: &Translation,
	) -> anyhow::Result<(PopupHandle, WidgetID /* content widget ID */)> {
		let doc_params = &ParseDocumentParams {
			globals: globals.clone(),
			path: AssetPath::BuiltIn("gui/view/popup_window.xml"),
			extra: Default::default(),
		};
		let state = wgui::parser::parse_from_assets(doc_params, layout, self.parent_id)?;

		let id_root = state.get_widget_id("root")?;
		let id_content = state.get_widget_id("content")?;

		{
			let mut label_title = state.fetch_widget_as::<WidgetLabel>(&layout.state, "popup_title")?;
			label_title.set_text_simple(&mut globals.get(), popup_title.clone());
		}

		let but_back = state.fetch_component_as::<ComponentButton>("but_back")?;

		let mounted_popup = MountedPopup {
			state,
			id_root,
			layout_tasks: layout.tasks.clone(),
			frontend_tasks: frontend_tasks.clone(),
		};

		let mounted_popup_state = MountedPopupState {
			mounted_popup: Some(mounted_popup),
			closed_callback: None,
		};

		let popup_handle = PopupHandle {
			state: Rc::new(RefCell::new(mounted_popup_state)),
		};

		let mut state = self.state.borrow_mut();
		log::debug!("pushing popup to popup_stack");
		state.popup_stack.push(Rc::downgrade(&popup_handle.state));

		but_back.on_click({
			let popup_handle = Rc::downgrade(&popup_handle.state);
			Rc::new(move |_common, _evt| {
				if let Some(popup_handle) = popup_handle.upgrade()
					&& let Some(closed_callback) = {
						let mut state = popup_handle.borrow_mut();
						state.mounted_popup = None; // will call Drop
						state.closed_callback.take()
					} {
					log::debug!("closed_callback called");
					closed_callback();
				}
				Ok(())
			})
		});

		frontend_tasks.push(FrontendTask::RefreshPopupManager);
		Ok((popup_handle, id_content))
	}

	/// Mount a new popup on top of the existing popup stack.
	/// Only the topmost popup is visible.
	pub fn mount_popup_once(
		&mut self,
		globals: &WguiGlobals,
		layout: &mut Layout,
		frontend_tasks: &FrontendTasks,
		params: MountPopupOnceParams,
		config: &GeneralConfig,
	) -> anyhow::Result<()> {
		let mut func = params.on_content.borrow_mut();
		let Some(on_content_func) = func.take() else {
			anyhow::bail!("mount_popup_once called more than once");
		};

		let (popup_handle, id_content) = self.mount_popup_prepare(globals, layout, frontend_tasks, &params.title)?;

		// mount user-set popup content
		let closed_callback = on_content_func(PopupContentFuncData {
			layout,
			handle: popup_handle.clone(),
			id_content,
			config,
		})?;

		popup_handle.state.borrow_mut().closed_callback = Some(closed_callback);

		Ok(())
	}
}