cosmic-workspaces/src/main.rs
Ian Douglas Scott 8f571e9e25 Use custom style for workspace items
None of the default styles seem to work quite right here.
2024-04-25 14:10:09 -07:00

695 lines
24 KiB
Rust

// Copyright 2023 System76 <info@system76.com>
// SPDX-License-Identifier: GPL-3.0-only
#![allow(clippy::single_match)]
use cctk::{
cosmic_protocols::workspace::v1::client::zcosmic_workspace_handle_v1,
sctk::shell::wlr_layer::{Anchor, KeyboardInteractivity, Layer},
wayland_client::{
protocol::{wl_data_device_manager::DndAction, wl_output},
Connection, Proxy, WEnum,
},
};
use clap::Parser;
use cosmic::{
app::{Application, CosmicFlags, DbusActivationDetails, Message},
cctk,
iced::{
self,
event::wayland::{Event as WaylandEvent, OutputEvent},
keyboard::key::{Key, Named},
wayland::{
actions::data_device::{DataFromMimeType, DndIcon},
data_device::{accept_mime_type, request_dnd_data, set_actions, start_drag},
},
widget, Command, Size, Subscription,
},
iced_runtime::{
command::platform_specific::wayland::layer_surface::{
IcedOutput, SctkLayerSurfaceSettings,
},
window::Id as SurfaceId,
},
iced_sctk::commands::layer_surface::{destroy_layer_surface, get_layer_surface},
};
use cosmic_comp_config::CosmicCompConfig;
use cosmic_config::{cosmic_config_derive::CosmicConfigEntry, CosmicConfigEntry};
use i18n_embed::DesktopLanguageRequester;
use once_cell::sync::Lazy;
use std::{
collections::{HashMap, HashSet},
mem,
path::PathBuf,
str::{self, FromStr},
};
mod desktop_info;
#[macro_use]
mod localize;
mod backend;
mod view;
use backend::{ToplevelInfo, ZcosmicToplevelHandleV1, ZcosmicWorkspaceHandleV1};
mod utils;
mod widgets;
#[derive(Clone, Debug, Default, PartialEq, CosmicConfigEntry)]
struct CosmicWorkspacesConfig {
show_workspace_number: bool,
show_workspace_name: bool,
}
// Include `pid` in mime. Want to drag between our surfaces, but not another
// process, if we use Wayland object ids.
static WORKSPACE_MIME: Lazy<String> =
Lazy::new(|| format!("text/x.cosmic-workspace-id-{}", std::process::id()));
static TOPLEVEL_MIME: Lazy<String> =
Lazy::new(|| format!("text/x.cosmic-toplevel-id-{}", std::process::id()));
#[derive(Parser, Debug, Clone)]
#[command(author, version, about, long_about = None)]
#[command(propagate_version = true)]
pub struct Args {}
#[derive(Default, Debug, Clone)]
pub struct WorkspaceCommands;
impl ToString for WorkspaceCommands {
fn to_string(&self) -> String {
String::new()
}
}
impl CosmicFlags for Args {
type SubCommand = WorkspaceCommands;
type Args = Vec<String>;
fn action(&self) -> Option<&WorkspaceCommands> {
None
}
}
struct WlDndId {
mime_type: &'static str,
}
impl DataFromMimeType for WlDndId {
fn from_mime_type(&self, mime_type: &str) -> Option<Vec<u8>> {
if mime_type == self.mime_type {
Some(Vec::new())
} else {
None
}
}
}
#[derive(Clone, Debug)]
enum Msg {
WaylandEvent(WaylandEvent),
Wayland(backend::Event),
Close,
ActivateWorkspace(ZcosmicWorkspaceHandleV1),
#[allow(dead_code)]
CloseWorkspace(ZcosmicWorkspaceHandleV1),
ActivateToplevel(ZcosmicToplevelHandleV1),
CloseToplevel(ZcosmicToplevelHandleV1),
StartDrag(Size, DragSurface),
DndWorkspaceEnter(
ZcosmicWorkspaceHandleV1,
wl_output::WlOutput,
DndAction,
Vec<String>,
(f32, f32),
),
DndWorkspaceLeave,
DndWorkspaceDrop,
DndWorkspaceData(String, Vec<u8>),
SourceFinished,
#[allow(dead_code)]
NewWorkspace,
CompConfig(Box<CosmicCompConfig>),
Config(CosmicWorkspacesConfig),
}
#[derive(Debug)]
struct Workspace {
name: String,
img_for_output: HashMap<wl_output::WlOutput, backend::CaptureImage>,
handle: ZcosmicWorkspaceHandleV1,
outputs: HashSet<wl_output::WlOutput>,
is_active: bool,
}
#[derive(Debug)]
struct Toplevel {
handle: ZcosmicToplevelHandleV1,
info: ToplevelInfo,
img: Option<backend::CaptureImage>,
icon: Option<PathBuf>,
}
#[derive(Clone)]
struct Output {
handle: wl_output::WlOutput,
name: String,
width: i32,
height: i32,
}
struct LayerSurface {
output: wl_output::WlOutput,
// for transitions, would need windows in more than one workspace? But don't capture all of
// them all the time every frame.
}
#[derive(Clone, Debug)]
enum DragSurface {
#[allow(dead_code)]
Workspace {
handle: ZcosmicWorkspaceHandleV1,
output: wl_output::WlOutput,
},
Toplevel {
handle: ZcosmicToplevelHandleV1,
output: wl_output::WlOutput,
},
}
#[derive(Default)]
struct Conf {
workspace_config: cosmic_comp_config::workspace::WorkspaceConfig,
config: CosmicWorkspacesConfig,
}
#[derive(Default)]
struct App {
layer_surfaces: HashMap<SurfaceId, LayerSurface>,
outputs: Vec<Output>,
workspaces: Vec<Workspace>,
toplevels: Vec<Toplevel>,
conn: Option<Connection>,
visible: bool,
wayland_cmd_sender: Option<calloop::channel::Sender<backend::Cmd>>,
drag_surface: Option<(SurfaceId, DragSurface, Size)>,
conf: Conf,
core: cosmic::app::Core,
drop_target: Option<(ZcosmicWorkspaceHandleV1, wl_output::WlOutput)>,
}
impl App {
fn workspace_for_handle(&self, handle: &ZcosmicWorkspaceHandleV1) -> Option<&Workspace> {
self.workspaces.iter().find(|i| &i.handle == handle)
}
fn workspace_for_handle_mut(
&mut self,
handle: &ZcosmicWorkspaceHandleV1,
) -> Option<&mut Workspace> {
self.workspaces.iter_mut().find(|i| &i.handle == handle)
}
fn toplevel_for_handle_mut(
&mut self,
handle: &ZcosmicToplevelHandleV1,
) -> Option<&mut Toplevel> {
self.toplevels.iter_mut().find(|i| &i.handle == handle)
}
fn create_surface(
&mut self,
output: wl_output::WlOutput,
) -> Command<cosmic::app::Message<Msg>> {
let id = SurfaceId::unique();
self.layer_surfaces.insert(
id,
LayerSurface {
output: output.clone(),
},
);
get_layer_surface(SctkLayerSurfaceSettings {
id,
keyboard_interactivity: KeyboardInteractivity::Exclusive,
namespace: "cosmic-workspace-overview".into(),
layer: Layer::Overlay,
size: Some((None, None)),
output: IcedOutput::Output(output),
anchor: Anchor::all(),
..Default::default()
})
}
fn destroy_surface(
&mut self,
output: &wl_output::WlOutput,
) -> Command<cosmic::app::Message<Msg>> {
if let Some((id, _)) = self
.layer_surfaces
.iter()
.find(|(_id, surface)| &surface.output == output)
{
let id = *id;
self.layer_surfaces.remove(&id).unwrap();
destroy_layer_surface(id)
} else {
Command::none()
}
}
fn toggle(&mut self) -> Command<cosmic::app::Message<Msg>> {
if self.visible {
self.hide()
} else {
self.show()
}
}
fn show(&mut self) -> Command<cosmic::app::Message<Msg>> {
if !self.visible {
self.visible = true;
let outputs = self.outputs.clone();
let cmd = Command::batch(
outputs
.into_iter()
.map(|output| self.create_surface(output.handle))
.collect::<Vec<_>>(),
);
self.update_capture_filter();
cmd
} else {
Command::none()
}
}
// Close all shell surfaces
fn hide(&mut self) -> Command<cosmic::app::Message<Msg>> {
self.visible = false;
self.update_capture_filter();
Command::batch(
mem::take(&mut self.layer_surfaces)
.into_keys()
.map(destroy_layer_surface)
.collect::<Vec<_>>(),
)
}
fn send_wayland_cmd(&self, cmd: backend::Cmd) {
if let Some(sender) = self.wayland_cmd_sender.as_ref() {
sender.send(cmd).unwrap();
}
}
fn update_capture_filter(&self) {
let mut capture_filter = backend::CaptureFilter::default();
if self.visible {
capture_filter.workspaces_on_outputs =
self.outputs.iter().map(|x| x.handle.clone()).collect();
capture_filter.toplevels_on_workspaces = self
.workspaces
.iter()
.filter(|x| x.is_active)
.map(|x| x.handle.clone())
.collect();
}
self.send_wayland_cmd(backend::Cmd::CaptureFilter(capture_filter));
}
}
impl Application for App {
type Message = Msg;
type Executor = cosmic::SingleThreadExecutor;
type Flags = Args;
const APP_ID: &'static str = "com.system76.CosmicWorkspaces";
fn init(
core: cosmic::app::Core,
_flags: Self::Flags,
) -> (Self, iced::Command<Message<Self::Message>>) {
(
Self {
core,
..Default::default()
},
Command::none(),
)
}
// TODO: show panel and dock? Drag?
fn update(&mut self, message: Msg) -> Command<cosmic::app::Message<Msg>> {
match message {
Msg::SourceFinished => {
self.drag_surface = None;
}
Msg::WaylandEvent(evt) => match evt {
WaylandEvent::Output(evt, output) => {
// TODO: Less hacky way to get connection from iced-sctk
if self.conn.is_none() {
if let Some(backend) = output.backend().upgrade() {
self.conn = Some(Connection::from_backend(backend));
}
}
match evt {
OutputEvent::Created(Some(info)) => {
if let (Some((width, height)), Some(name)) =
(info.logical_size, info.name)
{
self.outputs.push(Output {
handle: output.clone(),
name: name.clone(),
width,
height,
});
if self.visible {
return self.create_surface(output.clone());
}
}
}
OutputEvent::Created(None) => {} // XXX?
OutputEvent::InfoUpdate(info) => {
if let Some(output) =
self.outputs.iter_mut().find(|x| x.handle == output)
{
if let Some((width, height)) = info.logical_size {
output.width = width;
output.height = height;
}
if let Some(name) = info.name {
output.name = name;
}
// XXX re-create surface?
}
}
OutputEvent::Removed => {
if let Some(idx) = self.outputs.iter().position(|x| x.handle == output)
{
self.outputs.remove(idx);
}
if self.visible {
return self.destroy_surface(&output);
}
}
}
}
_ => {}
},
Msg::Wayland(evt) => {
match evt {
backend::Event::CmdSender(sender) => {
self.wayland_cmd_sender = Some(sender);
}
backend::Event::Workspaces(workspaces) => {
let old_workspaces = mem::take(&mut self.workspaces);
self.workspaces = Vec::new();
for (outputs, workspace) in workspaces {
let is_active = workspace.state.contains(&WEnum::Value(
zcosmic_workspace_handle_v1::State::Active,
));
// XXX efficiency
let img_for_output = old_workspaces
.iter()
.find(|i| i.handle == workspace.handle)
.map(|i| i.img_for_output.clone())
.unwrap_or_default();
self.workspaces.push(Workspace {
name: workspace.name,
handle: workspace.handle,
outputs,
img_for_output,
is_active,
});
}
self.update_capture_filter();
}
backend::Event::NewToplevel(handle, info) => {
log::debug!("New toplevel: {info:?}");
self.toplevels.push(Toplevel {
icon: desktop_info::icon_for_app_id(info.app_id.clone()),
handle,
info,
img: None,
});
}
backend::Event::UpdateToplevel(handle, info) => {
if let Some(toplevel) =
self.toplevels.iter_mut().find(|x| x.handle == handle)
{
toplevel.icon = desktop_info::icon_for_app_id(info.app_id.clone());
toplevel.info = info;
}
}
backend::Event::CloseToplevel(handle) => {
if let Some(idx) = self.toplevels.iter().position(|x| x.handle == handle) {
self.toplevels.remove(idx);
}
}
backend::Event::WorkspaceCapture(handle, output_name, image) => {
if let Some(workspace) = self.workspace_for_handle_mut(&handle) {
workspace.img_for_output.insert(output_name, image);
}
}
backend::Event::ToplevelCapture(handle, image) => {
if let Some(toplevel) = self.toplevel_for_handle_mut(&handle) {
//println!("Got toplevel image!");
toplevel.img = Some(image);
}
}
}
}
Msg::Close => {
return self.hide();
}
Msg::ActivateWorkspace(workspace_handle) => {
self.send_wayland_cmd(backend::Cmd::ActivateWorkspace(workspace_handle));
}
Msg::ActivateToplevel(toplevel_handle) => {
self.send_wayland_cmd(backend::Cmd::ActivateToplevel(toplevel_handle));
return self.hide();
}
Msg::CloseWorkspace(_workspace_handle) => {
// XXX close specific workspace
/*
if let WorkspaceAmount::Static(n) = &mut self.conf.workspace_config.workspace_amount
{
if *n != 1 {
*n -= 1;
self.conf
.cosmic_comp_config
.set("workspaces", &self.conf.workspace_config);
}
}
*/
}
Msg::CloseToplevel(toplevel_handle) => {
// TODO confirmation?
self.send_wayland_cmd(backend::Cmd::CloseToplevel(toplevel_handle));
}
Msg::StartDrag(size, drag_surface) => {
let (output, mime_type) = match &drag_surface {
DragSurface::Workspace { handle: _, output } => (output, &*WORKSPACE_MIME),
DragSurface::Toplevel { handle: _, output } => (output, &*TOPLEVEL_MIME),
};
let id = SurfaceId::unique();
if let Some((parent_id, _)) = self
.layer_surfaces
.iter()
.find(|(_, x)| &x.output == output)
{
self.drag_surface = Some((id, drag_surface, size));
return start_drag(
vec![mime_type.to_string()],
DndAction::Move,
*parent_id,
Some(DndIcon::Custom(id)),
Box::new(WlDndId { mime_type }),
);
}
}
Msg::DndWorkspaceEnter(handle, output, _action, mimes, (_x, _y)) => {
self.drop_target = Some((handle, output));
// XXX
// if mimes.iter().any(|x| x == WORKSPACE_MIME) && action == DndAction::Move {
if mimes.iter().any(|x| x == &*TOPLEVEL_MIME) {
return Command::batch(vec![
set_actions(DndAction::Move, DndAction::Move),
accept_mime_type(Some(TOPLEVEL_MIME.to_string())),
]);
}
}
Msg::DndWorkspaceLeave => {
// XXX Doesn't work since leave for a widget may come after enter for another
// self.drop_target = None;
return accept_mime_type(None);
}
Msg::DndWorkspaceDrop => {
return request_dnd_data(TOPLEVEL_MIME.to_string());
}
Msg::DndWorkspaceData(mime_type, data) => {
if mime_type == *TOPLEVEL_MIME {
// XXX getting empty data?
let _protocol_id = str::from_utf8(&data)
.ok()
.and_then(|s| u32::from_str(s).ok());
if let Some((_, DragSurface::Toplevel { handle, .. }, _)) = &self.drag_surface {
if let Some(drop_target) = &self.drop_target {
self.send_wayland_cmd(backend::Cmd::MoveToplevelToWorkspace(
handle.clone(),
drop_target.0.clone(),
drop_target.1.clone(),
));
}
}
}
}
Msg::NewWorkspace => {
/*
if let WorkspaceAmount::Static(n) = &mut self.conf.workspace_config.workspace_amount
{
*n += 1;
self.conf
.cosmic_comp_config
.set("workspaces", &self.conf.workspace_config);
}
*/
}
Msg::Config(c) => {
self.conf.config = c;
}
Msg::CompConfig(c) => {
self.conf.workspace_config = c.workspaces;
}
}
Command::none()
}
fn dbus_activation(
&mut self,
msg: cosmic::app::DbusActivationMessage,
) -> iced::Command<cosmic::app::Message<Self::Message>> {
if let DbusActivationDetails::Activate = msg.msg {
self.toggle()
} else {
Command::none()
}
}
fn subscription(&self) -> Subscription<Msg> {
let events = iced::event::listen_with(|evt, _| {
if let iced::Event::PlatformSpecific(iced::event::PlatformSpecific::Wayland(evt)) = evt
{
Some(Msg::WaylandEvent(evt))
} else if let iced::Event::Keyboard(iced::keyboard::Event::KeyReleased {
key: Key::Named(Named::Escape),
modifiers: _,
location: _,
}) = evt
{
Some(Msg::Close)
} else {
None
}
});
let config_subscription = cosmic_config::config_subscription::<_, CosmicWorkspacesConfig>(
"config-sub",
"com.system76.CosmicWorkspaces".into(),
1,
)
.map(|update| {
if !update.errors.is_empty() {
log::error!("Failed to load workspaces config: {:?}", update.errors);
}
Msg::Config(update.config)
});
let comp_config_subscription = cosmic_config::config_subscription::<_, CosmicCompConfig>(
"comp-config-sub",
"com.system76.CosmicComp".into(),
1,
)
.map(|update| {
if !update.errors.is_empty() {
log::error!("Failed to load compositor config: {:?}", update.errors);
}
Msg::CompConfig(Box::new(update.config))
});
let mut subscriptions = vec![events, config_subscription, comp_config_subscription];
if let Some(conn) = self.conn.clone() {
subscriptions.push(backend::subscription(conn).map(Msg::Wayland));
}
iced::Subscription::batch(subscriptions)
}
fn view(&self) -> cosmic::prelude::Element<Self::Message> {
unreachable!()
}
fn view_window(&self, id: iced::window::Id) -> cosmic::prelude::Element<Self::Message> {
use iced::widget::*;
if let Some(surface) = self.layer_surfaces.get(&id) {
return view::layer_surface(self, surface);
}
if let Some((drag_id, drag_surface, size)) = &self.drag_surface {
if drag_id == &id {
match drag_surface {
DragSurface::Workspace { handle, output } => {
if let Some(workspace) =
self.workspaces.iter().find(|x| &x.handle == handle)
{
let item = view::workspace_item(workspace, output);
return widget::container(item)
.height(iced::Length::Fixed(size.height))
.width(iced::Length::Fixed(size.width))
.into();
}
}
DragSurface::Toplevel { handle, .. } => {
if let Some(toplevel) = self.toplevels.iter().find(|x| &x.handle == handle)
{
let item = view::toplevel_preview(toplevel);
return widget::container(item)
.height(iced::Length::Fixed(size.height))
.width(iced::Length::Fixed(size.width))
.into();
}
}
}
}
}
log::info!("NO VIEW");
text("workspaces").into()
}
fn on_close_requested(&self, _id: SurfaceId) -> Option<Msg> {
None
}
fn core(&self) -> &cosmic::app::Core {
&self.core
}
fn core_mut(&mut self) -> &mut cosmic::app::Core {
&mut self.core
}
}
fn init_localizer() {
let localizer = crate::localize::localizer();
let requested_languages = DesktopLanguageRequester::requested_languages();
if let Err(why) = localizer.select(&requested_languages) {
log::error!("error while loading fluent localizations: {}", why);
}
}
pub fn main() -> iced::Result {
env_logger::init();
init_localizer();
cosmic::app::run_single_instance::<App>(
cosmic::app::Settings::default()
.no_main_window(true)
.exit_on_close(false),
Args::parse(),
)
}