spell_framework/

lib.rs

#![doc(
    html_logo_url = "https://raw.githubusercontent.com/VimYoung/Spell/main/spell-framework/assets/spell_trans.png"
)]
#![doc(
    html_favicon_url = "https://raw.githubusercontent.com/VimYoung/Spell/main/spell-framework/assets/spell_trans.ico"
)]
// #![doc(html_favicon_url = "https://github.com/VimYoung/Spell/blob/bb01ae94a365d237ebb0db1df1b6eb37aea25367/spell-framework/assets/Spell.png")]
#![doc = include_str!("../docs/entry.md")]
#![warn(missing_docs)]
mod configure;
#[cfg(docsrs)]
mod dummy_skia_docs;
mod event_macros;
pub mod forge;
#[cfg(feature = "i-slint-renderer-skia")]
#[cfg(not(docsrs))]
#[doc(hidden)]
mod skia_non_docs;
pub mod slint_adapter;
pub mod vault;
pub mod wayland_adapter;
/// It contains related enums and struct which are used to manage,
/// define and update various properties of a widget(viz a viz layer). You can import necessary
/// types from this module to implement relevant features. See docs of related objects for
/// their overview.
pub mod layer_properties {
    pub use crate::configure::{WindowConf, WindowConfBuilder};
    pub use smithay_client_toolkit::shell::wlr_layer::Anchor as LayerAnchor;
    pub use smithay_client_toolkit::shell::wlr_layer::KeyboardInteractivity as BoardType;
    pub use smithay_client_toolkit::shell::wlr_layer::Layer as LayerType;
}
/// Components of this module are not be used by end user directly. This module contains
/// certain reexports used by public facing macros like [cast_spell] and [generate_widgets]
/// internally.
pub mod macro_internal {
    pub use paste::paste;
    pub use smithay_client_toolkit::reexports::calloop::{
        Interest, Mode, PostAction, generic::Generic,
    };
    pub use tracing::{info, span::Span, warn};
}
use std::error::Error;
use tracing::{Level, span, trace};

/// This trait is implemented upon slint generated windows to enable IPC handling
pub trait IpcController {
    /// On calling `spell-cli -l layer_name look
    /// var_name`, the cli calls `get_type` method of the trait with `var_name` as input.
    fn get_type(&self, key: &str) -> String;
    /// It is called on `spell-cli -l layer_name update key value`. `as_any` is for syncing the changes
    /// internally for now and need not be implemented by the end user.
    fn change_val(&mut self, key: &str, val: &str);
}

/// This is an internal trait implemented by objects generated from [`generate_widgets`].
/// It helps in running every SpellWidget (like [SpellWin](`wayland_adapter::SpellWin`),
/// [SpellLock](`wayland_adapter::SpellLock`)) through the same event_loop function.
pub trait SpellAssociatedNew: std::fmt::Debug {
    /// Internal method used to call to update UI in a loop.
    fn on_call(&mut self) -> Result<(), Box<dyn Error>>;

    /// Internal method used to retrive logging span of a window.
    fn get_span(&self) -> span::Span {
        span!(Level::INFO, "unnamed-widget")
    }

    /// Internal method used to specify when to eliminate the event loop.
    fn is_locked(&self) -> bool {
        true
    }
}

/// event loop function internally used by [`cast_spell`] for single widget setups.
/// Not to be used by end user,
pub fn cast_spell_inner<S: SpellAssociatedNew>(mut waywindow: S) -> Result<(), Box<dyn Error>> {
    let span = waywindow.get_span();
    let _gaurd = span.enter();
    trace!("{:?}", &waywindow);
    while waywindow.is_locked() {
        waywindow.on_call()?
    }
    Ok(())
}

/// event loop function internally used by [`cast_spell`] for multiple widget setups.
/// Not to be used by end user.
pub fn cast_spells_new(
    mut windows: Vec<Box<dyn SpellAssociatedNew>>,
) -> Result<(), Box<dyn Error>> {
    loop {
        for win in windows.iter_mut() {
            let span = win.get_span().clone();
            let _gaurd = span.enter();
            win.on_call()?;
        }
    }
}

// TODO Update docs of spellock and spellwin to justify their use being purely internal.
// TODO update the blog with latest API changes in spell-framework.
// TODO update the constant vals so that the new APIs are used.
// TODO and configuration file to ensure that a single widget is open for a single layer name.
// TODO IMPORTANT LOGGING SUBSCRIBER LOGIC NEEDS TO BE UNIFIED AND NOT WINDOW SPECIFIC.
// Code to launch a Zbus service
// <BS>
// pub async fn deploy_zbus_service(
//     state: State,
//     state_updater: Sender<InternalHandle>,
//     layer_name: String,
// ) -> zbus::Result<()> {
//     let connection = BusConn::session().await.unwrap();
//     connection
//         .object_server()
//         .at(
//             "/org/VimYoung/VarHandler",
//             VarHandler {
//                 state: state.clone(),
//                 state_updater: state_updater.clone(),
//                 layer_name: layer_name.clone(),
//             },
//         )
//         .await?;
//     trace!("Object server set up");
//     // connection.request_name("org.VimYoung.Spell").await?;
//     // open_sec_service(state, state_updater, layer_name).await?;
//     if let Err(err) = connection
//         .request_name_with_flags("org.VimYoung.Spell", RequestNameFlags::DoNotQueue.into())
//         .await
//     {
//         open_sec_service(state, state_updater, layer_name).await?;
//         info!("Successfully created secondary service, Error: {}", err);
//     } else {
//         info!("Successfully created main service");
//     }
//     std::future::pending::<()>().await;
//     Ok(())
// }
// Macro on top of VarHandler impl.
// #[interface(name = "org.VimYoung.Spell1", proxy(gen_blocking = false,))]
// TODO it is necessary to call join unwrap on spawned threads to ensure
// that they are closed when main thread closes.
// TODO linux's DNF Buffers needs to be used to improve rendering and avoid conversions
// from CPU to GPU and vice versa.
// TO REMEMBER I removed dirty region from spellskiawinadapter but it can be added
// if I want to make use of the dirty region information to strengthen my rendering.
// TODO lock screen behaviour in a multi-monitor setup needs to be tested.
// TODO implement logging for SpellLock.
// Provide a method in the macro to disable tracing_subsriber completely for some project
// which want's to do it themselves.
// cast spell macro should be having following values.
// 1. Disable log: should disable setting subscriber, generally for the project to use or for
// someone to set their own.
// 2. forge: provide a forge instance to run independently.
// 3. exclusive_zone: true or false or with specified value.
// 4. it should have the option to take a window_conf or directly the window configurations
// into the macro, removing the need to define it previously.
// 5. monitor: Specify the monitor to show the widget in.
// Also, a procedural macro to mimic the functionalities of ForeignController.
// Build a consistent error type to deal with CLI, dbus and window creation errors
// (including window conf) more gracefully.