refactor: use iced workspaces applet

applets/cosmic-applet-workspaces/src/colors.rs

@@ -0,0 +1,53 @@
+use std::{
+    collections::HashMap,
+    fs::File,
+    io::{BufRead, BufReader},
+    path::PathBuf,
+};
+
+fn get_default_color(names: &[&str], is_dark: bool) -> HashMap<String, [f64; 4]> {
+    let css = if is_dark {
+        adw_user_colors_lib::colors::ColorOverrides::dark_default().as_css()
+    } else {
+        adw_user_colors_lib::colors::ColorOverrides::light_default().as_css()
+    };
+    names
+        .iter()
+        .filter_map(|name| {
+            let window_bg_color_pattern = &format!("@define-color {name}");
+            css.rfind(window_bg_color_pattern)
+                .and_then(|i| css.get(i + window_bg_color_pattern.len()..))
+                .and_then(|color_str| {
+                    csscolorparser::parse(&color_str.trim().replace(";", "")).ok()
+                })
+                .map(|c| (name.to_string(), c.to_array()))
+        })
+        .collect()
+}
+
+fn get_colors(names: &[&str], path: &PathBuf) -> HashMap<String, [f64; 4]> {
+    let file = match File::open(path) {
+        Ok(f) => f,
+        _ => return Default::default(),
+    };
+
+    BufReader::new(file)
+        .lines()
+        .filter_map(|l| l.ok())
+        .filter_map(|line| {
+            names.iter().find_map(|name| {
+                line.rfind(&format!("@define-color {name}"))
+                    .map(|i| (name, i))
+                    .and_then(|(name, i)| {
+                        line.get(i + format!("@define-color {name}").len()..)
+                            .map(|s| (name, s))
+                            .and_then(|(name, color_str)| {
+                                csscolorparser::parse(&color_str.trim().replace(";", ""))
+                                    .ok()
+                                    .map(|c| (name.to_string(), c.to_array()))
+                            })
+                    })
+            })
+        })
+        .collect()
+}

applets/cosmic-applet-workspaces/src/components/app.rs

@@ -0,0 +1,210 @@
+use std::{cmp::Ordering, env};
+
+use calloop::channel::SyncSender;
+use cosmic::iced::alignment::{Horizontal, Vertical};
+use cosmic::iced::mouse::{self, ScrollDelta};
+use cosmic::iced::widget::{column, container, row, text};
+use cosmic::iced::{
+    executor, subscription, widget::button, window, Application, Command, Event::Mouse, Length,
+    Settings, Subscription,
+};
+use cosmic::iced_style::application::{self, Appearance};
+use cosmic::theme::Button;
+use cosmic::{Element, Theme};
+use cosmic_panel_config::PanelAnchor;
+use cosmic_protocols::workspace::v1::client::zcosmic_workspace_handle_v1;
+use iced_sctk::application::SurfaceIdWrapper;
+use iced_sctk::command::platform_specific::wayland::window::SctkWindowSettings;
+use iced_sctk::settings::InitialSurface;
+use iced_sctk::{commands, Color};
+use wayland_backend::client::ObjectId;
+
+use crate::config;
+use crate::wayland::{WorkspaceEvent, WorkspaceList};
+use crate::wayland_subscription::{workspaces, WorkspacesUpdate};
+
+pub fn run() -> cosmic::iced::Result {
+    let mut settings = Settings::default();
+    settings.initial_surface = InitialSurface::XdgWindow(SctkWindowSettings {
+        iced_settings: cosmic::iced_native::window::Settings {
+            size: (32, 32),
+            ..Default::default()
+        },
+        ..Default::default()
+    });
+    IcedWorkspacesApplet::run(settings)
+}
+
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+pub enum Layout {
+    Row,
+    Column,
+}
+
+struct IcedWorkspacesApplet {
+    theme: Theme,
+    workspaces: WorkspaceList,
+    workspace_tx: Option<SyncSender<WorkspaceEvent>>,
+    layout: Layout,
+}
+
+#[derive(Debug, Clone)]
+enum Message {
+    WorkspaceUpdate(WorkspacesUpdate),
+    WorkspacePressed(ObjectId),
+    WheelScrolled(ScrollDelta),
+    Errored,
+}
+
+impl Application for IcedWorkspacesApplet {
+    type Message = Message;
+    type Theme = Theme;
+    type Executor = executor::Default;
+    type Flags = ();
+
+    fn new(_flags: ()) -> (Self, Command<Message>) {
+        (
+            IcedWorkspacesApplet {
+                layout: match env::var("COSMIC_PANEL_ANCHOR")
+                    .ok()
+                    .and_then(|anchor| anchor.parse::<PanelAnchor>().ok())
+                    .unwrap_or_default()
+                {
+                    PanelAnchor::Left | PanelAnchor::Right => Layout::Column,
+                    PanelAnchor::Top | PanelAnchor::Bottom => Layout::Row,
+                },
+                theme: Default::default(),
+                workspaces: Vec::new(),
+                workspace_tx: Default::default(),
+            },
+            Command::none(),
+        )
+    }
+
+    fn title(&self) -> String {
+        config::APP_ID.to_string()
+    }
+
+    fn update(&mut self, message: Message) -> Command<Message> {
+        match message {
+            Message::WorkspaceUpdate(msg) => match msg {
+                WorkspacesUpdate::Workspaces(mut list) => {
+                    list.retain(|w| {
+                        !matches!(w.1, Some(zcosmic_workspace_handle_v1::State::Hidden))
+                    });
+                    list.sort_by(|a, b| match a.0.len().cmp(&b.0.len()) {
+                        Ordering::Equal => a.0.cmp(&b.0),
+                        Ordering::Less => Ordering::Less,
+                        Ordering::Greater => Ordering::Greater,
+                    });
+                    self.workspaces = list;
+                    let unit = 32;
+                    let (w, h) = match self.layout {
+                        Layout::Row => (unit * self.workspaces.len() as u32, unit),
+                        Layout::Column => (unit, unit * self.workspaces.len() as u32),
+                    };
+                    return commands::window::resize_window(window::Id::new(0), w, h);
+                }
+                WorkspacesUpdate::Started(tx) => {
+                    self.workspace_tx.replace(tx);
+                }
+                WorkspacesUpdate::Errored => {
+                    // TODO
+                }
+            },
+            Message::WorkspacePressed(id) => {
+                if let Some(tx) = self.workspace_tx.as_mut() {
+                    let _ = tx.try_send(WorkspaceEvent::Activate(id));
+                }
+            }
+            Message::WheelScrolled(delta) => {
+                let delta = match delta {
+                    ScrollDelta::Lines { x, y } => x + y,
+                    ScrollDelta::Pixels { x, y } => x + y,
+                } as f64;
+                if let Some(tx) = self.workspace_tx.as_mut() {
+                    let _ = tx.try_send(WorkspaceEvent::Scroll(delta));
+                }
+            }
+            Message::Errored => {}
+        }
+        Command::none()
+    }
+
+    fn view(&self, _id: SurfaceIdWrapper) -> Element<Message> {
+        let buttons = self
+            .workspaces
+            .iter()
+            .filter_map(|w| {
+                let btn = button(
+                    text(w.0.clone())
+                        .horizontal_alignment(Horizontal::Center)
+                        .vertical_alignment(Vertical::Center)
+                        .width(Length::Fill)
+                        .height(Length::Fill),
+                )
+                .width(Length::Fill)
+                .height(Length::Fill)
+                .on_press(Message::WorkspacePressed(w.2.clone()))
+                .padding(0);
+                Some(
+                    btn.style(match w.1 {
+                        Some(zcosmic_workspace_handle_v1::State::Active) => Button::Primary,
+                        Some(zcosmic_workspace_handle_v1::State::Urgent) => Button::Destructive,
+                        None => Button::Secondary,
+                        _ => return None,
+                    })
+                    .into(),
+                )
+            })
+            .collect();
+        let layout_section: Element<_> = match self.layout {
+            Layout::Row => row(buttons)
+                .width(Length::Fill)
+                .height(Length::Fill)
+                .padding(0)
+                .into(),
+            Layout::Column => column(buttons)
+                .width(Length::Fill)
+                .height(Length::Fill)
+                .padding(0)
+                .into(),
+        };
+
+        container(layout_section)
+            .width(Length::Fill)
+            .height(Length::Fill)
+            .padding(0)
+            .into()
+    }
+
+    fn subscription(&self) -> Subscription<Message> {
+        Subscription::batch(
+            vec![
+                workspaces(0).map(|(_, msg)| Message::WorkspaceUpdate(msg)),
+                subscription::events_with(|e, _| match e {
+                    Mouse(mouse::Event::WheelScrolled { delta }) => {
+                        Some(Message::WheelScrolled(delta))
+                    }
+                    _ => None,
+                }),
+            ]
+            .into_iter(),
+        )
+    }
+
+    fn theme(&self) -> Theme {
+        self.theme
+    }
+
+    fn close_requested(&self, _id: iced_sctk::application::SurfaceIdWrapper) -> Self::Message {
+        unimplemented!()
+    }
+
+    fn style(&self) -> <Self::Theme as application::StyleSheet>::Style {
+        <Self::Theme as application::StyleSheet>::Style::Custom(|theme| Appearance {
+            background_color: Color::from_rgba(0.0, 0.0, 0.0, 0.0),
+            text_color: theme.cosmic().on_bg_color().into(),
+        })
+    }
+}

applets/cosmic-applet-workspaces/src/components/mod.rs

@@ -0,0 +1 @@
+pub mod app;

applets/cosmic-applet-workspaces/src/config.rs

@@ -0,0 +1,3 @@
+pub const APP_ID: &str = "com.system76.CosmicWorkspacesApplet";
+pub const PROFILE: &str = "";
+pub const VERSION: &str = "0.1.0";

applets/cosmic-applet-workspaces/src/localize.rs

@@ -36,3 +36,12 @@ macro_rules! fl {
 pub fn localizer() -> Box<dyn Localizer> {
     Box::from(DefaultLocalizer::new(&*LANGUAGE_LOADER, &Localizations))
 }
+
+pub fn localize() {
+    let localizer = localizer();
+    let requested_languages = i18n_embed::DesktopLanguageRequester::requested_languages();
+
+    if let Err(error) = localizer.select(&requested_languages) {
+        eprintln!("Error while loading language for App List {}", error);
+    }
+}

applets/cosmic-applet-workspaces/src/main.rs

@@ -1,76 +1,28 @@
-// SPDX-License-Identifier: MPL-2.0-only
-
-use calloop::channel::SyncSender;
-use gtk4::{
-    gdk::Display,
-    gio::{self, ApplicationFlags},
-    glib::{self, MainContext, Priority},
-    prelude::*,
-    CssProvider, StyleContext,
-};
-use once_cell::sync::OnceCell;
-use utils::WorkspaceEvent;
-use window::CosmicWorkspacesWindow;
-
+mod components;
+#[rustfmt::skip]
+mod config;
 mod localize;
-mod utils;
 mod wayland;
-mod wayland_source;
-mod window;
-mod workspace_button;
-mod workspace_list;
-mod workspace_object;
+mod wayland_subscription;
 
-const ID: &str = "com.system76.CosmicAppletWorkspaces";
-static TX: OnceCell<SyncSender<WorkspaceEvent>> = OnceCell::new();
+use config::APP_ID;
+use log::info;
 
-pub fn localize() {
-    let localizer = crate::localize::localizer();
-    let requested_languages = i18n_embed::DesktopLanguageRequester::requested_languages();
+use localize::localize;
 
-    if let Err(error) = localizer.select(&requested_languages) {
-        eprintln!("Error while loading language for App List {}", error);
-    }
-}
-
-fn load_css() {
-    let provider = CssProvider::new();
-    provider.load_from_resource("/com/System76/CosmicAppletWorkspaces/style.css");
-
-    StyleContext::add_provider_for_display(
-        &Display::default().unwrap(),
-        &provider,
-        gtk4::STYLE_PROVIDER_PRIORITY_APPLICATION,
-    );
-}
-
-fn main() {
-    let _monitors = libcosmic::init();
+use crate::{
+    components::app,
+    config::{PROFILE, VERSION},
+};
 
+fn main() -> cosmic::iced::Result {
     // Initialize logger
     pretty_env_logger::init();
-    glib::set_application_name(ID);
+    info!("Iced Workspaces Applet ({})", APP_ID);
+    info!("Version: {} ({})", VERSION, PROFILE);
 
+    // Prepare i18n
     localize();
-    gio::resources_register_include!("compiled.gresource").unwrap();
 
-    let app = gtk4::Application::new(None, ApplicationFlags::default());
-
-    app.connect_activate(|app| {
-        load_css();
-        let (tx, rx) = MainContext::channel(Priority::default());
-
-        let wayland_tx = wayland::spawn_workspaces(tx.clone());
-        let window = CosmicWorkspacesWindow::new(app);
-
-        TX.set(wayland_tx).unwrap();
-
-        rx.attach(None, glib::clone!(@weak window => @default-return glib::prelude::Continue(true), move |workspace_event| {
-            window.set_workspaces(workspace_event);
-            glib::prelude::Continue(true)
-        }));
-
-        window.show();
-    });
-    app.run();
+    app::run()
 }

applets/cosmic-applet-workspaces/src/meson.build

@@ -0,0 +1,53 @@
+global_conf = configuration_data()
+global_conf.set_quoted('APP_ID', application_id)
+global_conf.set_quoted('PROFILE', profile)
+global_conf.set_quoted('VERSION', version + version_suffix)
+config = configure_file(
+  input: 'config.rs.in',
+  output: 'config.rs',
+  configuration: global_conf
+)
+# Copy the config.rs output to the source directory.
+run_command(
+  'cp',
+  meson.project_build_root() / 'src' / 'config.rs',
+  meson.project_source_root() / 'src' / 'config.rs',
+  check: true
+)
+
+cargo_options = [ '--manifest-path', meson.project_source_root() / 'Cargo.toml' ]
+cargo_options += [ '--target-dir', meson.project_build_root() / 'src' ]
+
+if get_option('profile') == 'default'
+  cargo_options += [ '--release' ]
+  rust_target = 'release'
+  message('Building in release mode')
+else
+  rust_target = 'debug'
+  message('Building in debug mode')
+endif
+
+if get_option('vendor') == true
+  cargo_options += [ '--locked' ]
+  message('Building with vendoring')
+endif
+
+cargo_env = [ 'CARGO_HOME=' + meson.project_build_root() / 'cargo-home' ]
+
+cargo_build = custom_target(
+  'cargo-build',
+  build_by_default: true,
+  build_always_stale: true,
+  output: meson.project_name(),
+  console: true,
+  install: true,
+  install_dir: bindir,
+  command: [
+    'env',
+    cargo_env,
+    cargo, 'build',
+    cargo_options,
+    '&&',
+    'cp', 'src' / rust_target / meson.project_name(), '@OUTPUT@',
+  ]
+)

applets/cosmic-applet-workspaces/src/utils.rs

@@ -1,35 +0,0 @@
-// SPDX-License-Identifier: MPL-2.0-only
-
-use std::path::PathBuf;
-
-use gtk4::glib;
-use std::future::Future;
-
-#[derive(Debug, Clone)]
-pub enum WorkspaceEvent {
-    Activate(String),
-    Scroll(f64),
-}
-
-pub fn data_path() -> PathBuf {
-    let mut path = glib::user_data_dir();
-    path.push(crate::ID);
-    std::fs::create_dir_all(&path).expect("Could not create directory.");
-    path.push("data.json");
-    path
-}
-
-pub fn thread_context() -> glib::MainContext {
-    glib::MainContext::thread_default().unwrap_or_else(|| {
-        let ctx = glib::MainContext::new();
-        ctx
-    })
-}
-
-pub fn block_on<F>(future: F) -> F::Output
-where
-    F: Future,
-{
-    let ctx = thread_context();
-    ctx.with_thread_default(|| ctx.block_on(future)).unwrap()
-}

applets/cosmic-applet-workspaces/src/wayland.rs

@@ -1,4 +1,3 @@
-use crate::{utils::WorkspaceEvent, wayland_source::WaylandSource};
 use calloop::channel::*;
 use cosmic_panel_config::CosmicPanelOuput;
 use cosmic_protocols::workspace::v1::client::{
@@ -6,19 +5,28 @@ use cosmic_protocols::workspace::v1::client::{
     zcosmic_workspace_handle_v1::{self, ZcosmicWorkspaceHandleV1},
     zcosmic_workspace_manager_v1::{self, ZcosmicWorkspaceManagerV1},
 };
-use gtk4::glib;
-use std::{env, os::unix::net::UnixStream, path::PathBuf, time::Duration};
+use futures::{channel::mpsc, executor::block_on, SinkExt};
+use sctk::event_loop::WaylandSource;
+use std::{env, os::unix::net::UnixStream, path::PathBuf, str::FromStr, time::Duration};
+use wayland_backend::client::ObjectId;
 use wayland_client::{
     event_created_child,
     protocol::{
         wl_output::{self, WlOutput},
         wl_registry::{self, WlRegistry},
     },
-    ConnectError,
+    ConnectError, Proxy,
 };
 use wayland_client::{Connection, Dispatch, QueueHandle};
 
-pub fn spawn_workspaces(tx: glib::Sender<State>) -> SyncSender<WorkspaceEvent> {
+#[derive(Debug, Clone)]
+pub enum WorkspaceEvent {
+    Activate(ObjectId),
+    Scroll(f64),
+}
+pub type WorkspaceList = Vec<(String, Option<zcosmic_workspace_handle_v1::State>, ObjectId)>;
+
+pub fn spawn_workspaces(tx: mpsc::Sender<WorkspaceList>) -> SyncSender<WorkspaceEvent> {
     let (workspaces_tx, workspaces_rx) = calloop::channel::sync_channel(100);
 
     if let Ok(Ok(conn)) = std::env::var("WAYLAND_DISPLAY")
@@ -36,13 +44,11 @@ pub fn spawn_workspaces(tx: glib::Sender<State>) -> SyncSender<WorkspaceEvent> {
         std::thread::spawn(move || {
             let output = std::env::var("COSMIC_PANEL_OUTPUT")
                 .ok()
-                .and_then(|output| match output.parse::<CosmicPanelOuput>() {
-                    Ok(CosmicPanelOuput::Name(n)) => Some(n),
-                    // TODO handle Active & panic if the space is still configured for All instead of being assigned a named output
-                    _ => Some("".to_string()),
+                .map(|output_str| match CosmicPanelOuput::from_str(&output_str) {
+                    Ok(CosmicPanelOuput::Name(name)) => name,
+                    _ => "".to_string(),
                 })
                 .unwrap_or_default();
-
             let mut event_loop = calloop::EventLoop::<State>::try_new().unwrap();
             let loop_handle = event_loop.handle();
             let event_queue = conn.new_event_queue::<State>();
@@ -70,11 +76,9 @@ pub fn spawn_workspaces(tx: glib::Sender<State>) -> SyncSender<WorkspaceEvent> {
             loop_handle
                 .insert_source(workspaces_rx, |e, _, state| match e {
                     Event::Msg(WorkspaceEvent::Activate(id)) => {
-                        if let Some(w) = state
-                            .workspace_groups
-                            .iter()
-                            .find_map(|g| g.workspaces.iter().find(|w| w.name == id))
-                        {
+                        if let Some(w) = state.workspace_groups.iter().find_map(|g| {
+                            g.workspaces.iter().find(|w| w.workspace_handle.id() == id)
+                        }) {
                             w.workspace_handle.activate();
                             state.workspace_manager.as_ref().unwrap().commit();
                         }
@@ -141,7 +145,7 @@ pub struct State {
     outputs_to_handle: Option<Vec<WlOutput>>,
     wm_name: Option<(u32, WlRegistry)>,
     running: bool,
-    tx: glib::Sender<State>,
+    tx: mpsc::Sender<WorkspaceList>,
     configured_output: String,
     expected_output: Option<WlOutput>,
     workspace_manager: Option<ZcosmicWorkspaceManagerV1>,
@@ -150,20 +154,30 @@ pub struct State {
 
 impl State {
     // XXX
-    pub fn workspace_list(&self) -> impl Iterator<Item = (String, u32)> + '_ {
+    pub fn workspace_list(
+        &self,
+    ) -> Vec<(String, Option<zcosmic_workspace_handle_v1::State>, ObjectId)> {
         self.workspace_groups
             .iter()
             .filter_map(|g| {
-                if g.output == self.expected_output {
+                // TODO remove none check when workspace groups receive output event
+                if g.output.is_none() || g.output == self.expected_output {
                     Some(g.workspaces.iter().map(|w| {
                         (
                             w.name.clone(),
                             match &w.states {
-                                x if x.contains(&zcosmic_workspace_handle_v1::State::Active) => 0,
-                                x if x.contains(&zcosmic_workspace_handle_v1::State::Urgent) => 1,
-                                x if x.contains(&zcosmic_workspace_handle_v1::State::Hidden) => 2,
-                                _ => 3,
+                                x if x.contains(&zcosmic_workspace_handle_v1::State::Active) => {
+                                    Some(zcosmic_workspace_handle_v1::State::Active)
+                                }
+                                x if x.contains(&zcosmic_workspace_handle_v1::State::Urgent) => {
+                                    Some(zcosmic_workspace_handle_v1::State::Urgent)
+                                }
+                                x if x.contains(&zcosmic_workspace_handle_v1::State::Hidden) => {
+                                    Some(zcosmic_workspace_handle_v1::State::Hidden)
+                                }
+                                _ => None,
                             },
+                            w.workspace_handle.id(),
                         )
                     }))
                 } else {
@@ -171,6 +185,7 @@ impl State {
                 }
             })
             .flatten()
+            .collect()
     }
 }
 
@@ -182,14 +197,13 @@ struct WorkspaceGroup {
 }
 
 #[derive(Debug, Clone)]
-struct Workspace {
+pub struct Workspace {
     workspace_handle: ZcosmicWorkspaceHandleV1,
     name: String,
     coordinates: Vec<u32>,
     states: Vec<zcosmic_workspace_handle_v1::State>,
 }
 
-
 impl Dispatch<wl_registry::WlRegistry, ()> for State {
     fn event(
         state: &mut Self,
@@ -256,13 +270,14 @@ impl Dispatch<ZcosmicWorkspaceManagerV1, ()> for State {
                         w1.coordinates
                             .iter()
                             .zip(w2.coordinates.iter())
+                            .rev()
                             .skip_while(|(coord1, coord2)| coord1 == coord2)
                             .next()
                             .map(|(coord1, coord2)| coord1.cmp(coord2))
                             .unwrap_or(std::cmp::Ordering::Equal)
                     });
                 }
-                let _ = state.tx.send(state.clone());
+                let _ = block_on(state.tx.send(state.workspace_list()));
             }
             zcosmic_workspace_manager_v1::Event::Finished => {
                 state.workspace_manager.take();
@@ -414,7 +429,7 @@ impl Dispatch<WlOutput, ()> for State {
             wl_output::Event::Name { name } if name == state.configured_output => {
                 state.expected_output.replace(o.clone());
                 // Necessary bc often the output is handled after the workspaces
-                let _ = state.tx.send(state.clone());
+                let _ = block_on(state.tx.send(state.workspace_list()));
             }
             wl_output::Event::Done => {
                 let outputs_to_handle = state.outputs_to_handle.as_mut().unwrap();
@@ -430,4 +445,4 @@ impl Dispatch<WlOutput, ()> for State {
             _ => {} // ignored
         }
     }
-}
+}

applets/cosmic-applet-workspaces/src/wayland_source.rs

@@ -1,219 +0,0 @@
-//! Utilities for using an [`EventQueue`] from wayland-client with an event loop that performs polling with
-//! [`calloop`](https://crates.io/crates/calloop).
-
-use std::{io, os::unix::prelude::{RawFd, AsRawFd}};
-
-use calloop::{
-    generic::Generic, EventSource, InsertError, Interest, LoopHandle, Mode, Poll, PostAction,
-    Readiness, RegistrationToken, Token, TokenFactory,
-};
-use nix::errno::Errno;
-use wayland_backend::client::{ReadEventsGuard, WaylandError};
-use wayland_client::{DispatchError, EventQueue};
-
-/// An adapter to insert an [`EventQueue`] into a calloop [`EventLoop`](calloop::EventLoop).
-///
-/// This type implements [`EventSource`] which generates an event whenever events on the display need to be
-/// dispatched. The event queue available in the callback calloop registers may be used to dispatch pending
-/// events using [`EventQueue::dispatch_pending`].
-///
-/// [`WaylandSource::insert`] can be used to insert this source into an event loop and automatically dispatch
-/// pending events on the display.
-#[derive(Debug)]
-pub struct WaylandSource<D> {
-    queue: EventQueue<D>,
-    fd: Generic<RawFd>,
-    read_guard: Option<ReadEventsGuard>,
-}
-
-impl<D> WaylandSource<D> {
-    /// Wrap an [`EventQueue`] as a [`WaylandSource`].
-    pub fn new(queue: EventQueue<D>) -> Result<WaylandSource<D>, WaylandError> {
-        let guard = queue.prepare_read()?;
-        let fd = Generic::new(guard.connection_fd().as_raw_fd(), Interest::READ, Mode::Level);
-        drop(guard);
-
-        Ok(WaylandSource {
-            queue,
-            fd,
-            read_guard: None,
-        })
-    }
-
-    /// Access the underlying event queue
-    ///
-    /// Note that you should be careful when interacting with it if you invoke methods that
-    /// interact with the wayland socket (such as `dispatch()` or `prepare_read()`). These may
-    /// interfere with the proper waking up of this event source in the event loop.
-    pub fn queue(&mut self) -> &mut EventQueue<D> {
-        &mut self.queue
-    }
-
-    /// Insert this source into the given event loop.
-    ///
-    /// This adapter will pass the event loop's shared data as the `D` type for the event loop.
-    pub fn insert(self, handle: LoopHandle<D>) -> Result<RegistrationToken, InsertError<Self>>
-    where
-        D: 'static,
-    {
-        handle.insert_source(self, |_, queue, data| queue.dispatch_pending(data))
-    }
-}
-
-impl<D> EventSource for WaylandSource<D> {
-    type Event = ();
-
-    /// The underlying event queue.
-    ///
-    /// You should call [`EventQueue::dispatch_pending`] inside your callback using this queue.
-    type Metadata = EventQueue<D>;
-    type Ret = Result<usize, DispatchError>;
-    type Error = calloop::Error;
-
-    fn process_events<F>(
-        &mut self,
-        readiness: Readiness,
-        token: Token,
-        mut callback: F,
-    ) -> Result<PostAction, Self::Error>
-    where
-        F: FnMut(Self::Event, &mut Self::Metadata) -> Self::Ret,
-    {
-        let queue = &mut self.queue;
-        let read_guard = &mut self.read_guard;
-
-        let action = self.fd.process_events(readiness, token, |_, _| {
-            // 1. read events from the socket if any are available
-            if let Some(guard) = read_guard.take() {
-                // might be None if some other thread read events before us, concurrently
-                if let Err(WaylandError::Io(err)) = guard.read() {
-                    if err.kind() != io::ErrorKind::WouldBlock {
-                        return Err(err);
-                    }
-                }
-            }
-
-            // 2. dispatch any pending events in the queue
-            // This is done to ensure we are not waiting for messages that are already in the buffer.
-            Self::loop_callback_pending(queue, &mut callback)?;
-            *read_guard = Some(Self::prepare_read(queue)?);
-
-            // 3. Once dispatching is finished, flush the responses to the compositor
-            if let Err(WaylandError::Io(e)) = queue.flush() {
-                if e.kind() != io::ErrorKind::WouldBlock {
-                    // in case of error, forward it and fast-exit
-                    return Err(e);
-                }
-                // WouldBlock error means the compositor could not process all our messages
-                // quickly. Either it is slowed down or we are a spammer.
-                // Should not really happen, if it does we do nothing and will flush again later
-            }
-
-            Ok(PostAction::Continue)
-        })?;
-
-        Ok(action)
-    }
-
-    fn register(
-        &mut self,
-        poll: &mut Poll,
-        token_factory: &mut TokenFactory,
-    ) -> calloop::Result<()> {
-        self.fd.register(poll, token_factory)
-    }
-
-    fn reregister(
-        &mut self,
-        poll: &mut Poll,
-        token_factory: &mut TokenFactory,
-    ) -> calloop::Result<()> {
-        self.fd.reregister(poll, token_factory)
-    }
-
-    fn unregister(&mut self, poll: &mut Poll) -> calloop::Result<()> {
-        self.fd.unregister(poll)
-    }
-
-    fn pre_run<F>(&mut self, mut callback: F) -> calloop::Result<()>
-    where
-        F: FnMut((), &mut Self::Metadata) -> Self::Ret,
-    {
-        debug_assert!(self.read_guard.is_none());
-
-        // flush the display before starting to poll
-        if let Err(WaylandError::Io(err)) = self.queue.flush() {
-            if err.kind() != io::ErrorKind::WouldBlock {
-                // in case of error, don't prepare a read, if the error is persistent, it'll trigger in other
-                // wayland methods anyway
-                log::error!("Error trying to flush the wayland display: {}", err);
-                return Err(err.into());
-            }
-        }
-
-        // ensure we are not waiting for messages that are already in the buffer.
-        Self::loop_callback_pending(&mut self.queue, &mut callback)?;
-        self.read_guard = Some(Self::prepare_read(&mut self.queue)?);
-
-        Ok(())
-    }
-
-    fn post_run<F>(&mut self, _: F) -> calloop::Result<()>
-    where
-        F: FnMut((), &mut Self::Metadata) -> Self::Ret,
-    {
-        // Drop implementation of ReadEventsGuard will do cleanup
-        self.read_guard.take();
-        Ok(())
-    }
-}
-
-impl<D> WaylandSource<D> {
-    /// Loop over the callback until all pending messages have been dispatched.
-    fn loop_callback_pending<F>(queue: &mut EventQueue<D>, callback: &mut F) -> io::Result<()>
-    where
-        F: FnMut((), &mut EventQueue<D>) -> Result<usize, DispatchError>,
-    {
-        // Loop on the callback until no pending events are left.
-        loop {
-            match callback((), queue) {
-                // No more pending events.
-                Ok(0) => break Ok(()),
-
-                Ok(_) => continue,
-
-                Err(DispatchError::Backend(WaylandError::Io(err))) => {
-                    return Err(err);
-                }
-
-                Err(DispatchError::Backend(WaylandError::Protocol(err))) => {
-                    log::error!("Protocol error received on display: {}", err);
-
-                    break Err(Errno::EPROTO.into());
-                }
-
-                Err(DispatchError::BadMessage { sender_id, interface, opcode }) => {
-                    log::error!(
-                        "Bad message on interface \"{}\": (opcode: {}, sender_id: {:?})",
-                        interface,
-                        opcode,
-                        sender_id,
-                    );
-
-                    break Err(Errno::EPROTO.into());
-                }
-            }
-        }
-    }
-
-    fn prepare_read(queue: &mut EventQueue<D>) -> io::Result<ReadEventsGuard> {
-        queue.prepare_read().map_err(|err| match err {
-            WaylandError::Io(err) => err,
-
-            WaylandError::Protocol(err) => {
-                log::error!("Protocol error received on display: {}", err);
-                Errno::EPROTO.into()
-            }
-        })
-    }
-}

applets/cosmic-applet-workspaces/src/wayland_subscription.rs

@@ -0,0 +1,72 @@
+use crate::wayland::{self, WorkspaceEvent, WorkspaceList};
+use calloop::channel::SyncSender;
+use futures::{channel::mpsc, StreamExt};
+use std::hash::Hash;
+
+#[derive(Debug, Clone)]
+pub enum WorkspacesUpdate {
+    Workspaces(WorkspaceList),
+    Started(SyncSender<WorkspaceEvent>),
+    Errored,
+}
+
+pub fn workspaces<I: 'static + Hash + Copy + Send + Sync>(
+    id: I,
+) -> cosmic::iced::Subscription<(I, WorkspacesUpdate)> {
+    use cosmic::iced::subscription;
+
+    subscription::unfold(id, State::Ready, move |state| _workspaces(id, state))
+}
+
+async fn _workspaces<I: Copy>(id: I, state: State) -> (Option<(I, WorkspacesUpdate)>, State) {
+    match state {
+        State::Ready => {
+            if let Ok(watcher) = WorkspacesWatcher::new() {
+                (
+                    Some((id, WorkspacesUpdate::Started(watcher.get_sender()))),
+                    State::Waiting(watcher),
+                )
+            } else {
+                (Some((id, WorkspacesUpdate::Errored)), State::Error)
+            }
+        }
+        State::Waiting(mut t) => {
+            if let Some(w) = t.workspaces().await {
+                (
+                    Some((id, WorkspacesUpdate::Workspaces(w))),
+                    State::Waiting(t),
+                )
+            } else {
+                (Some((id, WorkspacesUpdate::Errored)), State::Error)
+            }
+        }
+        State::Error => cosmic::iced::futures::future::pending().await,
+    }
+}
+
+pub enum State {
+    Ready,
+    Waiting(WorkspacesWatcher),
+    Error,
+}
+
+pub struct WorkspacesWatcher {
+    rx: mpsc::Receiver<WorkspaceList>,
+    tx: SyncSender<WorkspaceEvent>,
+}
+
+impl WorkspacesWatcher {
+    pub fn new() -> anyhow::Result<Self> {
+        let (tx, rx) = mpsc::channel(20);
+        let tx = wayland::spawn_workspaces(tx);
+        Ok(Self { tx, rx })
+    }
+
+    pub fn get_sender(&self) -> SyncSender<WorkspaceEvent> {
+        self.tx.clone()
+    }
+
+    pub async fn workspaces(&mut self) -> Option<WorkspaceList> {
+        self.rx.next().await
+    }
+}

applets/cosmic-applet-workspaces/src/window/imp.rs

@@ -1,32 +0,0 @@
-// SPDX-License-Identifier: MPL-2.0-only
-
-use crate::workspace_list::WorkspaceList;
-use gtk4::{glib, subclass::prelude::*};
-use once_cell::sync::OnceCell;
-
-// Object holding the state
-#[derive(Default)]
-pub struct CosmicWorkspacesWindow {
-    pub(super) inner: OnceCell<WorkspaceList>,
-}
-
-// The central trait for subclassing a GObject
-#[glib::object_subclass]
-impl ObjectSubclass for CosmicWorkspacesWindow {
-    // `NAME` needs to match `class` attribute of template
-    const NAME: &'static str = "CosmicWorkspacesWindow";
-    type Type = super::CosmicWorkspacesWindow;
-    type ParentType = gtk4::ApplicationWindow;
-}
-
-// Trait shared by all GObjects
-impl ObjectImpl for CosmicWorkspacesWindow {}
-
-// Trait shared by all widgets
-impl WidgetImpl for CosmicWorkspacesWindow {}
-
-// Trait shared by all windows
-impl WindowImpl for CosmicWorkspacesWindow {}
-
-// Trait shared by all application
-impl ApplicationWindowImpl for CosmicWorkspacesWindow {}

applets/cosmic-applet-workspaces/src/window/mod.rs

@@ -1,48 +0,0 @@
-// SPDX-License-Identifier: MPL-2.0-only
-
-use crate::{fl, wayland::State, workspace_list::WorkspaceList};
-use cascade::cascade;
-use gtk4::{
-    gio,
-    glib::{self, Object},
-    prelude::*,
-    subclass::prelude::*,
-};
-
-mod imp;
-
-glib::wrapper! {
-    pub struct CosmicWorkspacesWindow(ObjectSubclass<imp::CosmicWorkspacesWindow>)
-        @extends gtk4::ApplicationWindow, gtk4::Window, gtk4::Widget,
-        @implements gio::ActionGroup, gio::ActionMap, gtk4::Accessible, gtk4::Buildable,
-                    gtk4::ConstraintTarget, gtk4::Native, gtk4::Root, gtk4::ShortcutManager;
-}
-
-impl CosmicWorkspacesWindow {
-    pub fn new(app: &gtk4::Application) -> Self {
-        let self_: Self = Object::new(&[("application", app)])
-            .expect("Failed to create `CosmicWorkspacesWindow`.");
-        let imp = imp::CosmicWorkspacesWindow::from_instance(&self_);
-
-        cascade! {
-            &self_;
-            ..set_width_request(1);
-            ..set_height_request(1);
-            ..set_decorated(false);
-            ..set_resizable(false);
-            ..set_title(Some(&fl!("cosmic-applet-workspaces")));
-            ..add_css_class("transparent");
-        };
-
-        let app_list = WorkspaceList::new();
-        self_.set_child(Some(&app_list));
-        imp.inner.set(app_list).unwrap();
-
-        self_
-    }
-
-    pub fn set_workspaces(&self, workspaces: State) {
-        let imp = imp::CosmicWorkspacesWindow::from_instance(&self);
-        imp.inner.get().unwrap().set_workspaces(workspaces);
-    }
-}

applets/cosmic-applet-workspaces/src/workspace_button/imp.rs

@@ -1,25 +0,0 @@
-use gtk4::{glib, subclass::prelude::*, ToggleButton};
-use std::{cell::RefCell, rc::Rc};
-
-// Object holding the state
-#[derive(Default)]
-pub struct WorkspaceButton {
-    pub button: Rc<RefCell<ToggleButton>>,
-}
-
-// The central trait for subclassing a GObject
-#[glib::object_subclass]
-impl ObjectSubclass for WorkspaceButton {
-    const NAME: &'static str = "WorkspaceButton";
-    type Type = super::WorkspaceButton;
-    type ParentType = gtk4::Box;
-}
-
-// Trait shared by all GObjects
-impl ObjectImpl for WorkspaceButton {}
-
-// Trait shared by all widgets
-impl WidgetImpl for WorkspaceButton {}
-
-// Trait shared by all buttons
-impl BoxImpl for WorkspaceButton {}

applets/cosmic-applet-workspaces/src/workspace_button/mod.rs

@@ -1,61 +0,0 @@
-mod imp;
-
-use crate::{utils::WorkspaceEvent, workspace_object::WorkspaceObject, TX};
-use glib::Object;
-use gtk4::{glib, prelude::*, subclass::prelude::*, ToggleButton, Label, Align};
-
-glib::wrapper! {
-    pub struct WorkspaceButton(ObjectSubclass<imp::WorkspaceButton>)
-        @extends gtk4::Box, gtk4::Widget,
-        @implements gtk4::Accessible, gtk4::Actionable, gtk4::Buildable, gtk4::ConstraintTarget, gtk4::Orientable;
-}
-
-impl WorkspaceButton {
-    pub fn new() -> Self {
-        let self_ = Object::new(&[]).expect("Failed to create `WorkspaceButton`.");
-        let imp = imp::WorkspaceButton::from_instance(&self_);
-
-        let tb = ToggleButton::with_label("");
-        self_.append(&tb);
-        self_.set_hexpand(true);
-        imp.button.replace(tb);
-
-        self_.connect_parent_notify(|self_| {
-            if let Some(parent) = self_.parent() {
-                parent.set_hexpand(true);
-            }
-        });
-
-        self_
-    }
-
-    pub fn set_workspace_object(&self, obj: &WorkspaceObject) {
-        let imp = imp::WorkspaceButton::from_instance(&self);
-        let old_button = imp.button.take();
-        self.remove(&old_button);
-
-        let id = obj.id();
-        let new_button = ToggleButton::new();
-        new_button.set_hexpand(true);
-
-        let label = Label::new(Some(&id));
-        label.set_halign(Align::Center);
-        new_button.set_child(Some(&label));
-        
-        if obj.active() == 1 {
-            new_button.add_css_class("alert");
-        } else if obj.active() == 0 {
-            new_button.add_css_class("active");
-        } else {
-            new_button.add_css_class("inactive");
-        }
-
-        self.append(&new_button);
-        new_button.connect_clicked(move |_| {
-            let id_clone = id.clone();
-            let _ = TX.get().unwrap().send(WorkspaceEvent::Activate(id_clone));
-        });
-
-        imp.button.replace(new_button);
-    }
-}

applets/cosmic-applet-workspaces/src/workspace_list/imp.rs

@@ -1,25 +0,0 @@
-// SPDX-License-Identifier: MPL-2.0-only
-
-use gtk4::subclass::prelude::*;
-use gtk4::{gio, glib};
-use gtk4::{Box, ListView};
-use once_cell::sync::OnceCell;
-
-#[derive(Debug, Default)]
-pub struct WorkspaceList {
-    pub list_view: OnceCell<ListView>,
-    pub model: OnceCell<gio::ListStore>,
-}
-
-#[glib::object_subclass]
-impl ObjectSubclass for WorkspaceList {
-    const NAME: &'static str = "WorkspaceList";
-    type Type = super::WorkspaceList;
-    type ParentType = Box;
-}
-
-impl ObjectImpl for WorkspaceList {}
-
-impl WidgetImpl for WorkspaceList {}
-
-impl BoxImpl for WorkspaceList {}

applets/cosmic-applet-workspaces/src/workspace_list/mod.rs

@@ -1,137 +0,0 @@
-// SPDX-License-Identifier: MPL-2.0-only
-
-use std::cmp::Ordering;
-
-use crate::utils::WorkspaceEvent;
-use crate::wayland::State;
-use crate::workspace_button::WorkspaceButton;
-use crate::workspace_object::WorkspaceObject;
-use crate::TX;
-use cascade::cascade;
-use cosmic_panel_config::PanelAnchor;
-use gtk4::builders::EventControllerScrollBuilder;
-use gtk4::EventControllerScrollFlags;
-use gtk4::Inhibit;
-use gtk4::ListView;
-use gtk4::SignalListItemFactory;
-use gtk4::{gio, glib, prelude::*, subclass::prelude::*};
-use itertools::Itertools;
-
-mod imp;
-
-glib::wrapper! {
-    pub struct WorkspaceList(ObjectSubclass<imp::WorkspaceList>)
-        @extends gtk4::Widget, gtk4::Box,
-        @implements gtk4::Accessible, gtk4::Buildable, gtk4::ConstraintTarget, gtk4::Orientable;
-}
-
-impl WorkspaceList {
-    pub fn new() -> Self {
-        let self_: WorkspaceList = glib::Object::new(&[]).expect("Failed to create WorkspaceList");
-        let imp = imp::WorkspaceList::from_instance(&self_);
-        self_.layout();
-        //dnd behavior is different for each type, as well as the data in the model
-        self_.setup_model();
-        self_.setup_factory();
-        self_
-    }
-
-    pub fn model(&self) -> &gio::ListStore {
-        // Get state
-        let imp = imp::WorkspaceList::from_instance(self);
-        imp.model.get().expect("Could not get model")
-    }
-
-    fn layout(&self) {
-        let imp = imp::WorkspaceList::from_instance(self);
-        let anchor = std::env::var("COSMIC_PANEL_ANCHOR")
-            .ok()
-            .and_then(|anchor| anchor.parse::<PanelAnchor>().ok())
-            .unwrap_or_default();
-
-        let list_view = cascade! {
-            ListView::default();
-            ..set_orientation(anchor.into());
-            ..add_css_class("transparent");
-        };
-        self.append(&list_view);
-
-        let flags = EventControllerScrollFlags::BOTH_AXES;
-
-        let scroll_controller = EventControllerScrollBuilder::new()
-            .flags(flags.union(EventControllerScrollFlags::DISCRETE))
-            .build();
-
-        scroll_controller.connect_scroll(|_, dx, dy| {
-            let _ = TX.get().unwrap().send(WorkspaceEvent::Scroll(dx + dy));
-            Inhibit::default()
-        });
-
-        list_view.add_controller(&scroll_controller);
-        imp.list_view.set(list_view).unwrap();
-    }
-
-    pub fn set_workspaces(&self, workspaces: State) {
-        let imp = imp::WorkspaceList::from_instance(&self);
-        let model = imp.model.get().unwrap();
-
-        let model_len = model.n_items();
-        let new_results: Vec<glib::Object> = workspaces
-            .workspace_list()
-            .sorted_by(|a, b| {
-                match a.0.len().cmp(&b.0.len()) {
-                    Ordering::Less => Ordering::Less,
-                    Ordering::Equal => a.0.cmp(&b.0),
-                    Ordering::Greater => Ordering::Greater,
-                }
-            })
-            .filter_map(|w| {
-                // don't include hidden workspaces
-                if w.1 != 2 {
-                    Some(WorkspaceObject::from_id_active(w.0, w.1).upcast())
-                } else {
-                    None
-                }
-            })
-            .collect();
-        model.splice(0, model_len, &new_results[..]);
-    }
-
-    fn setup_model(&self) {
-        let imp = imp::WorkspaceList::from_instance(self);
-        let model = gio::ListStore::new(WorkspaceObject::static_type());
-
-        let selection_model = gtk4::NoSelection::new(Some(&model));
-
-        // Wrap model with selection and pass it to the list view
-        let list_view = imp.list_view.get().unwrap();
-        list_view.set_model(Some(&selection_model));
-        imp.model.set(model).expect("Could not set model");
-    }
-
-    fn setup_factory(&self) {
-        let imp = imp::WorkspaceList::from_instance(self);
-        let factory = SignalListItemFactory::new();
-        let model = imp.model.get().expect("Failed to get saved app model.");
-
-        factory.connect_setup(glib::clone!(@weak model => move |_, list_item| {
-            let workspace_button = WorkspaceButton::new();
-            list_item.set_child(Some(&workspace_button));
-        }));
-        factory.connect_bind(|_, list_item| {
-            let workspace_object = list_item
-                .item()
-                .expect("The item has to exist.")
-                .downcast::<WorkspaceObject>()
-                .expect("The item has to be a `WorkspaceObject`");
-            let workspace_button = list_item
-                .child()
-                .expect("The list item child needs to exist.")
-                .downcast::<WorkspaceButton>()
-                .expect("The list item type needs to be `DockItem`");
-            workspace_button.set_workspace_object(&workspace_object);
-        });
-        // Set the factory of the list view
-        imp.list_view.get().unwrap().set_factory(Some(&factory));
-    }
-}

applets/cosmic-applet-workspaces/src/workspace_object/imp.rs

@@ -1,79 +0,0 @@
-// SPDX-License-Identifier: MPL-2.0-only
-
-use std::cell::{Cell, RefCell};
-
-use glib::{ParamFlags, ParamSpec, Value};
-use gtk4::gdk::glib::ParamSpecBoolean;
-use gtk4::glib::{self, ParamSpecString, ParamSpecUInt};
-use gtk4::prelude::*;
-use gtk4::subclass::prelude::*;
-use once_cell::sync::Lazy;
-
-// Object holding the state
-#[derive(Default)]
-pub struct WorkspaceObject {
-    pub(crate) id: RefCell<String>,
-    pub(crate) active: Cell<u32>,
-}
-
-// The central trait for subclassing a GObject
-#[glib::object_subclass]
-impl ObjectSubclass for WorkspaceObject {
-    const NAME: &'static str = "WorkspaceObject";
-    type Type = super::WorkspaceObject;
-    type ParentType = glib::Object;
-}
-
-// Trait shared by all GObjects
-impl ObjectImpl for WorkspaceObject {
-    fn properties() -> &'static [ParamSpec] {
-        static PROPERTIES: Lazy<Vec<ParamSpec>> = Lazy::new(|| {
-            vec![
-                ParamSpecString::new(
-                    // Name
-                    "id",
-                    // Nickname
-                    "id",
-                    // Short description
-                    "id",
-                    // Default value
-                    None,
-                    // The property can be read and written to
-                    ParamFlags::READWRITE,
-                ),
-                ParamSpecUInt::new(
-                    "active",
-                    "active",
-                    "Indicates whether workspace is active",
-                    0,
-                    4,
-                    0,
-                    ParamFlags::READWRITE,
-                ),
-            ]
-        });
-        PROPERTIES.as_ref()
-    }
-
-    fn set_property(&self, _obj: &Self::Type, _id: usize, value: &Value, pspec: &ParamSpec) {
-        match pspec.name() {
-            "active" => {
-                self.active
-                    .replace(value.get().expect("Value needs to be a boolean"));
-            }
-            "id" => {
-                self.id
-                    .replace(value.get().expect("Value needs to be a boolean"));
-            }
-            _ => unimplemented!(),
-        }
-    }
-
-    fn property(&self, _obj: &Self::Type, _id: usize, pspec: &ParamSpec) -> Value {
-        match pspec.name() {
-            "id" => self.id.borrow().to_value(),
-            "active" => self.active.get().to_value(),
-            _ => unimplemented!(),
-        }
-    }
-}

applets/cosmic-applet-workspaces/src/workspace_object/mod.rs

@@ -1,34 +0,0 @@
-// SPDX-License-Identifier: MPL-2.0-only
-
-use gtk4::{glib, subclass::prelude::*};
-
-mod imp;
-
-glib::wrapper! {
-    pub struct WorkspaceObject(ObjectSubclass<imp::WorkspaceObject>);
-}
-
-impl WorkspaceObject {
-    pub fn new() -> Self {
-        glib::Object::new(&[]).unwrap()
-    }
-
-    pub fn from_id_active(id: String, active: u32) -> Self {
-        glib::Object::new(&[("id", &id), ("active", &active)]).unwrap()
-    }
-
-    pub fn id(&self) -> String {
-        imp::WorkspaceObject::from_instance(&self)
-            .id
-            .borrow()
-            .clone()
-    }
-
-    pub fn active(&self) -> u32 {
-        imp::WorkspaceObject::from_instance(&self).active.get()
-    }
-}
-
-#[derive(Clone, Debug, Default, glib::Boxed)]
-#[boxed_type(name = "BoxedWorkspaceObject")]
-pub struct BoxedWorkspaceObject(pub Option<WorkspaceObject>);