config: add WM_WINDOW_ROLE window criteria

jay-config/src/_private.rs

@@ -126,4 +126,5 @@ pub enum WindowCriterionStringField {
     Tag,
     XClass,
     XInstance,
+    XRole,
 }

jay-config/src/_private/client.rs

@@ -1669,6 +1669,8 @@ impl ConfigClient {
             WindowCriterion::XClassRegex(t) => string!(t, XClass, true),
             WindowCriterion::XInstance(t) => string!(t, XInstance, false),
             WindowCriterion::XInstanceRegex(t) => string!(t, XInstance, true),
+            WindowCriterion::XRole(t) => string!(t, XRole, false),
+            WindowCriterion::XRoleRegex(t) => string!(t, XRole, true),
         };
         let res = self.send_with_response(&ClientMessage::CreateWindowMatcher { criterion });
         get_response!(

jay-config/src/window.rs

@@ -272,6 +272,10 @@ pub enum WindowCriterion<'a> {
     XInstance(&'a str),
     /// Matches the X instance of the window with a regular expression.
     XInstanceRegex(&'a str),
+    /// Matches the X role of the window verbatim.
+    XRole(&'a str),
+    /// Matches the X role of the window with a regular expression.
+    XRoleRegex(&'a str),
 }
 
 impl WindowCriterion<'_> {

src/config/handler.rs

@@ -1993,6 +1993,7 @@ impl ConfigProxyHandler {
                     WindowCriterionStringField::Tag => mgr.tag(needle),
                     WindowCriterionStringField::XClass => mgr.class(needle),
                     WindowCriterionStringField::XInstance => mgr.instance(needle),
+                    WindowCriterionStringField::XRole => mgr.role(needle),
                 }
             }
             WindowCriterionIpc::Types(t) => mgr.kind(*t),

src/criteria/tlm.rs

@@ -19,7 +19,8 @@ use {
                 tlmm_kind::TlmMatchKind,
                 tlmm_seat_focus::TlmMatchSeatFocus,
                 tlmm_string::{
-                    TlmMatchAppId, TlmMatchClass, TlmMatchInstance, TlmMatchTag, TlmMatchTitle,
+                    TlmMatchAppId, TlmMatchClass, TlmMatchInstance, TlmMatchRole, TlmMatchTag,
+                    TlmMatchTitle,
                 },
                 tlmm_urgent::TlmMatchUrgent,
                 tlmm_visible::TlmMatchVisible,
@@ -55,6 +56,7 @@ bitflags! {
     TL_CHANGED_JUST_MAPPED = 1 << 9,
     TL_CHANGED_TAG         = 1 << 10,
     TL_CHANGED_CLASS_INST  = 1 << 11,
+    TL_CHANGED_ROLE        = 1 << 12,
 }
 
 type TlmFixedRootMatcher<T> = FixedRootMatcher<ToplevelData, T>;
@@ -85,6 +87,7 @@ pub struct RootMatchers {
     seat_foci: TlmRootMatcherMap<TlmMatchSeatFocus>,
     class: TlmRootMatcherMap<TlmMatchClass>,
     instance: TlmRootMatcherMap<TlmMatchInstance>,
+    role: TlmRootMatcherMap<TlmMatchRole>,
 }
 
 pub async fn handle_tl_changes(state: Rc<State>) {
@@ -215,6 +218,7 @@ impl TlMatcherManager {
         conditional!(TL_CHANGED_TAG, tag);
         conditional!(TL_CHANGED_CLASS_INST, class);
         conditional!(TL_CHANGED_CLASS_INST, instance);
+        conditional!(TL_CHANGED_ROLE, role);
         fixed_conditional!(TL_CHANGED_FLOATING, floating);
         fixed_conditional!(TL_CHANGED_VISIBLE, visible);
         fixed_conditional!(TL_CHANGED_URGENT, urgent);
@@ -290,6 +294,7 @@ impl TlMatcherManager {
         conditional!(TL_CHANGED_TAG, tag);
         conditional!(TL_CHANGED_CLASS_INST, class);
         conditional!(TL_CHANGED_CLASS_INST, instance);
+        conditional!(TL_CHANGED_ROLE, role);
         fixed_conditional!(TL_CHANGED_FLOATING, floating);
         fixed_conditional!(TL_CHANGED_VISIBLE, visible);
         fixed_conditional!(TL_CHANGED_URGENT, urgent);
@@ -355,6 +360,10 @@ impl TlMatcherManager {
     pub fn instance(&self, string: CritLiteralOrRegex) -> Rc<TlmUpstreamNode> {
         self.root(TlmMatchInstance::new(string))
     }
+
+    pub fn role(&self, string: CritLiteralOrRegex) -> Rc<TlmUpstreamNode> {
+        self.root(TlmMatchRole::new(string))
+    }
 }
 
 impl CritTarget for ToplevelData {

src/criteria/tlm/tlm_matchers/tlmm_string.rs

@@ -13,12 +13,14 @@ pub type TlmMatchAppId = TlmMatchString<AppIdAccess>;
 pub type TlmMatchTag = TlmMatchString<TagAccess>;
 pub type TlmMatchClass = TlmMatchString<ClassAccess>;
 pub type TlmMatchInstance = TlmMatchString<InstanceAccess>;
+pub type TlmMatchRole = TlmMatchString<RoleAccess>;
 
 pub struct TitleAccess;
 pub struct AppIdAccess;
 pub struct TagAccess;
 pub struct ClassAccess;
 pub struct InstanceAccess;
+pub struct RoleAccess;
 
 impl StringAccess<ToplevelData> for TitleAccess {
     fn with_string(data: &ToplevelData, f: impl FnOnce(&str) -> bool) -> bool {
@@ -78,3 +80,16 @@ impl StringAccess<ToplevelData> for InstanceAccess {
         &roots.instance
     }
 }
+
+impl StringAccess<ToplevelData> for RoleAccess {
+    fn with_string(data: &ToplevelData, f: impl FnOnce(&str) -> bool) -> bool {
+        if let ToplevelType::XWindow(data) = &data.kind {
+            return f(&data.info.role.borrow().as_deref().unwrap_or_default());
+        }
+        false
+    }
+
+    fn nodes(roots: &RootMatchers) -> &TlmRootMatcherMap<TlmMatchString<Self>> {
+        &roots.role
+    }
+}

src/ifs/wl_surface/x_surface/xwindow.rs

@@ -93,7 +93,7 @@ pub struct XwindowInfo {
     pub instance: RefCell<Option<String>>,
     pub class: RefCell<Option<String>>,
     pub title: RefCell<Option<String>>,
-    pub role: RefCell<Option<BString>>,
+    pub role: RefCell<Option<String>>,
     pub protocols: CopyHashMap<u32, ()>,
     pub window_types: CopyHashMap<u32, ()>,
     pub never_focus: Cell<bool>,

src/xwayland/xwm.rs

@@ -4,7 +4,7 @@ use {
     crate::{
         async_engine::SpawnedFuture,
         client::Client,
-        criteria::tlm::TL_CHANGED_CLASS_INST,
+        criteria::tlm::{TL_CHANGED_CLASS_INST, TL_CHANGED_ROLE},
         ifs::{
             ipc::{
                 DataOfferId, DataSourceId, DynDataOffer, DynDataSource, IpcLocation, IpcVtable,
@@ -60,7 +60,7 @@ use {
         xwayland::{XWaylandError, XWaylandEvent},
     },
     ahash::{AHashMap, AHashSet},
-    bstr::ByteSlice,
+    bstr::{ByteSlice, ByteVec},
     futures_util::{FutureExt, select},
     smallvec::SmallVec,
     std::{
@@ -1086,6 +1086,11 @@ impl Wm {
     }
 
     async fn load_window_wm_window_role(&self, data: &Rc<XwindowData>) {
+        let property_changed = || {
+            if let Some(window) = data.window.get() {
+                window.toplevel_data.property_changed(TL_CHANGED_ROLE);
+            }
+        };
         let mut buf = vec![];
         match self
             .c
@@ -1101,6 +1106,7 @@ impl Wm {
             }
             Err(XconError::PropertyUnavailable) => {
                 data.info.role.borrow_mut().take();
+                property_changed();
                 return;
             }
             Err(e) => {
@@ -1112,7 +1118,8 @@ impl Wm {
             }
         }
         // log::info!("{} role {}", data.window_id, buf.as_bstr());
-        *data.info.role.borrow_mut() = Some(buf.into());
+        *data.info.role.borrow_mut() = Some(buf.into_string_lossy());
+        property_changed();
     }
 
     async fn load_window_wm_class(&self, data: &Rc<XwindowData>) {

toml-config/src/config.rs

@@ -271,6 +271,8 @@ pub struct WindowMatch {
     pub x_class_regex: Option<String>,
     pub x_instance: Option<String>,
     pub x_instance_regex: Option<String>,
+    pub x_role: Option<String>,
+    pub x_role_regex: Option<String>,
 }
 
 #[derive(Debug, Clone)]

toml-config/src/config/parsers/window_match.rs

@@ -68,7 +68,7 @@ impl Parser for WindowMatchParser<'_> {
                 tag,
                 tag_regex,
             ),
-            (x_class, x_class_regex, x_instance, x_instance_regex),
+            (x_class, x_class_regex, x_instance, x_instance_regex, x_role, x_role_regex),
         ) = ext.extract((
             (
                 opt(str("name")),
@@ -98,6 +98,8 @@ impl Parser for WindowMatchParser<'_> {
                 opt(str("x-class-regex")),
                 opt(str("x-instance")),
                 opt(str("x-instance-regex")),
+                opt(str("x-role")),
+                opt(str("x-role-regex")),
             ),
         ))?;
         let mut not = None;
@@ -155,6 +157,8 @@ impl Parser for WindowMatchParser<'_> {
             x_class_regex: x_class_regex.despan_into(),
             x_instance: x_instance.despan_into(),
             x_instance_regex: x_instance_regex.despan_into(),
+            x_role: x_role.despan_into(),
+            x_role_regex: x_role_regex.despan_into(),
             types,
             client,
         })

toml-config/src/rules.rs

@@ -264,6 +264,8 @@ impl Rule for WindowRule {
         value!(XClassRegex, x_class_regex);
         value!(XInstance, x_instance);
         value!(XInstanceRegex, x_instance_regex);
+        value!(XRole, x_role);
+        value!(XRoleRegex, x_role_regex);
         bool!(Floating, floating);
         bool!(Visible, visible);
         bool!(Urgent, urgent);

toml-spec/spec/spec.generated.json

@@ -1843,6 +1843,14 @@
         "x-instance-regex": {
           "type": "string",
           "description": "Matches the X instance of the window with a regular expression."
+        },
+        "x-role": {
+          "type": "string",
+          "description": "Matches the X role of the window verbatim."
+        },
+        "x-role-regex": {
+          "type": "string",
+          "description": "Matches the X role of the window with a regular expression."
         }
       },
       "required": []

toml-spec/spec/spec.generated.md

@@ -4109,6 +4109,18 @@ The table has the following fields:
 
   The value of this field should be a string.
 
+- `x-role` (optional):
+
+  Matches the X role of the window verbatim.
+
+  The value of this field should be a string.
+
+- `x-role-regex` (optional):
+
+  Matches the X role of the window with a regular expression.
+
+  The value of this field should be a string.
+
 
 <a name="types-WindowMatchExactly"></a>
 ### `WindowMatchExactly`

toml-spec/spec/spec.yaml

@@ -3535,6 +3535,14 @@ WindowMatch:
       kind: string
       required: false
       description: Matches the X instance of the window with a regular expression.
+    x-role:
+      kind: string
+      required: false
+      description: Matches the X role of the window verbatim.
+    x-role-regex:
+      kind: string
+      required: false
+      description: Matches the X role of the window with a regular expression.
 
 
 WindowMatchExactly: