aioxlib 0.7.2__tar.gz → 0.8.0__tar.gz

{aioxlib-0.7.2 → aioxlib-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aioxlib
-Version: 0.7.2
+Version: 0.8.0
 Summary: Human friendly interface to XLib subsystems using asyncio python
 Author-email: Jose Tiago Macara Coutinho <coutinhotiago@gmail.com>
 License-Expression: GPL-3.0-or-later

{aioxlib-0.7.2 → aioxlib-0.8.0}/aioxlib/__init__.py

@@ -16,7 +16,7 @@ Types and protocol helpers live in submodules::
     from aioxlib.protocol import pack_create_window
 """
 
-__version__ = "0.7.2"
+__version__ = "0.8.0"
 
 from . import api, constants
 from .api import *  # noqa: F403

{aioxlib-0.7.2 → aioxlib-0.8.0}/aioxlib/constants.py

@@ -925,6 +925,36 @@ class WinGravity(enum.IntEnum):
     Static = 10
 
 
+# Number of 32-bit fields in the ICCCM / Xlib XWMHints structure
+XWM_HINTS_LEN = 9
+
+
+class WMHintsFlag(enum.IntFlag):
+    """Bits for the ``flags`` field — which of the following fields are valid.
+
+    Values match the ICCCM / Xlib ``XWMHints`` definition.
+    """
+
+    InputHint = 1 << 0
+    StateHint = 1 << 1
+    IconPixmapHint = 1 << 2
+    IconWindowHint = 1 << 3
+    IconPositionHint = 1 << 4
+    IconMaskHint = 1 << 5
+    WindowGroupHint = 1 << 6
+    # bit 7 was WithdrawnHint (obsolete)
+    UrgencyHint = 1 << 8
+
+
+class InitialState(enum.IntEnum):
+    """Values for the ``initial_state`` field."""
+
+    Withdrawn = 0
+    Normal = 1
+    # 2 was ZoomState (obsolete)
+    Iconic = 3
+
+
 LSBFirst = 0
 
 MSBFirst = 1
@@ -1148,6 +1178,12 @@ __all__ = [
     "MotifFunc",
     "MotifDecor",
     "MotifInputMode",
+    "XSIZE_HINTS_LEN",
+    "SizeHintsFlag",
+    "WinGravity",
+    "XWM_HINTS_LEN",
+    "WMHintsFlag",
+    "InitialState",
     "LSBFirst",
     "MSBFirst",
     "GenericEventCode",

{aioxlib-0.7.2 → aioxlib-0.8.0}/aioxlib/display.py

@@ -32,6 +32,7 @@ from .constants import (
     ErrorCode,
     EventType,
     ImageFormat,
+    InitialState,
     PropMode,
     StackMode,
     Status,
@@ -42,6 +43,7 @@ from .protocol import (
     build_font,
     build_motif_wm_hints,
     build_size_hints,
+    build_wm_hints,
     pack_change_property,
     pack_clear_area,
     pack_configure_window,
@@ -338,7 +340,7 @@ class Window(Drawable):
             status=status,
         )
         atom = await self.display.get_atom(MOTIF_WM_HINTS_ATOM)
-        await self.change_property(atom, atom, 32, list(data))
+        await self.change_property(atom, atom, 32, data)
 
     async def set_size_hints(
         self,
@@ -409,7 +411,58 @@ class Window(Drawable):
             Atom.WM_NORMAL_HINTS,
             Atom.WM_SIZE_HINTS,
             32,
-            list(data),
+            data,
+        )
+
+    async def set_wm_hints(
+        window: Window,
+        *,
+        input: bool | None = None,
+        initial_state: InitialState | int | None = None,
+        icon_pixmap: int | None = None,
+        icon_window: int | None = None,
+        icon_x: int | None = None,
+        icon_y: int | None = None,
+        icon_mask: int | None = None,
+        window_group: int | None = None,
+        urgent: bool | None = None,
+    ) -> None:
+        """Apply ICCCM window-manager hints to *window*.
+
+        Pass individual fields, or supply a pre-built 9-element list via *data*.
+        When *data* is given it takes precedence over the keyword fields.
+
+        Examples
+        --------
+        Normal window that accepts keyboard focus::
+
+            await set_wm_hints(wnd, input=True, initial_state=InitialState.Normal)
+
+        Start iconic (minimized)::
+
+            await set_wm_hints(wnd, initial_state=InitialState.Iconic)
+
+        Mark urgent (attention)::
+
+            await set_wm_hints(wnd, urgent=True)
+        """
+        data = build_wm_hints(
+            input=input,
+            initial_state=initial_state,
+            icon_pixmap=icon_pixmap,
+            icon_window=icon_window,
+            icon_x=icon_x,
+            icon_y=icon_y,
+            icon_mask=icon_mask,
+            window_group=window_group,
+            urgent=urgent,
+        )
+
+        await window.change_property(
+            Atom.WM_HINTS,
+            Atom.WM_HINTS,
+            32,
+            data,
         )
 
     async def change_text_property(self, property, data, property_type=Atom.STRING, mode=PropMode.Replace):

{aioxlib-0.7.2 → aioxlib-0.8.0}/aioxlib/protocol.py

@@ -28,6 +28,7 @@ from .constants import (
     ConfigureWindowAttributes,
     CreateWindowAttributes,
     EventType,
+    InitialState,
     MotifDecor,
     MotifFunc,
     MotifHintsFlag,
@@ -35,6 +36,7 @@ from .constants import (
     SizeHintsFlag,
     VisualClass,
     WinGravity,
+    WMHintsFlag,
 )
 
 log = logging.getLogger("aioxlib")
@@ -1778,3 +1780,107 @@ def build_size_hints(
         vals["base_height"],
         vals["win_gravity"],
     ]
+
+
+def build_wm_hints(
+    *,
+    input: bool | None = None,
+    initial_state: InitialState | int | None = None,
+    icon_pixmap: int | None = None,
+    icon_window: int | None = None,
+    icon_x: int | None = None,
+    icon_y: int | None = None,
+    icon_mask: int | None = None,
+    window_group: int | None = None,
+    urgent: bool | None = None,
+) -> list[int]:
+    """Build the 9-element ``XWMHints`` payload for ``WM_HINTS``.
+
+    Only fields that are not ``None`` are marked valid in ``flags``.
+    Omitted fields are written as ``0`` and ignored by the WM.
+
+    Parameters
+    ----------
+    input :
+        If True, the application expects the WM to set input focus
+        (typical for Normal windows). If False, the client sets focus itself.
+    initial_state :
+        ``InitialState.Normal`` or ``InitialState.Iconic`` (or Withdrawn).
+    icon_pixmap :
+        Pixmap id to use as the icon image.
+    icon_window :
+        Window id to use as the icon (alternative to pixmap).
+    icon_x, icon_y :
+        Preferred icon position on the root / desktop.
+    icon_mask :
+        Pixmap id used as a mask for ``icon_pixmap``.
+    window_group :
+        Leader window id for a group of related windows.
+    urgent :
+        If True, set the UrgencyHint bit (WM may flash the title / taskbar).
+
+    Returns
+    -------
+    list of 9 ints
+        Ready to pass to ``change_property(..., format=32, data=...)``.
+    """
+    flags = 0
+    vals = {
+        "input": 0,
+        "initial_state": 0,
+        "icon_pixmap": 0,
+        "icon_window": 0,
+        "icon_x": 0,
+        "icon_y": 0,
+        "icon_mask": 0,
+        "window_group": 0,
+    }
+
+    if input is not None:
+        flags |= WMHintsFlag.InputHint
+        vals["input"] = 1 if input else 0
+
+    if initial_state is not None:
+        flags |= WMHintsFlag.StateHint
+        vals["initial_state"] = int(initial_state)
+
+    if icon_pixmap is not None:
+        flags |= WMHintsFlag.IconPixmapHint
+        vals["icon_pixmap"] = int(icon_pixmap)
+
+    if icon_window is not None:
+        flags |= WMHintsFlag.IconWindowHint
+        vals["icon_window"] = int(icon_window)
+
+    if icon_x is not None or icon_y is not None:
+        flags |= WMHintsFlag.IconPositionHint
+        if icon_x is not None:
+            vals["icon_x"] = int(icon_x)
+        if icon_y is not None:
+            vals["icon_y"] = int(icon_y)
+
+    if icon_mask is not None:
+        flags |= WMHintsFlag.IconMaskHint
+        vals["icon_mask"] = int(icon_mask)
+
+    if window_group is not None:
+        flags |= WMHintsFlag.WindowGroupHint
+        vals["window_group"] = int(window_group)
+
+    if urgent is not None:
+        if urgent:
+            flags |= WMHintsFlag.UrgencyHint
+        # When urgent=False we still leave UrgencyHint unset (not valid),
+        # which clears urgency for WMs that replace the whole property.
+
+    return [
+        flags,
+        vals["input"],
+        vals["initial_state"],
+        vals["icon_pixmap"],
+        vals["icon_window"],
+        vals["icon_x"],
+        vals["icon_y"],
+        vals["icon_mask"],
+        vals["window_group"],
+    ]

{aioxlib-0.7.2 → aioxlib-0.8.0}/aioxlib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aioxlib
-Version: 0.7.2
+Version: 0.8.0
 Summary: Human friendly interface to XLib subsystems using asyncio python
 Author-email: Jose Tiago Macara Coutinho <coutinhotiago@gmail.com>
 License-Expression: GPL-3.0-or-later

{aioxlib-0.7.2 → aioxlib-0.8.0}/tests/test_protocol.py

@@ -47,18 +47,22 @@ from aioxlib.connection import (
 )
 from aioxlib.constants import (
     XSIZE_HINTS_LEN,
+    XWM_HINTS_LEN,
+    InitialState,
     MotifDecor,
     MotifFunc,
     MotifHintsFlag,
     MotifInputMode,
     SizeHintsFlag,
     WinGravity,
+    WMHintsFlag,
 )
 from aioxlib.protocol import (
     EVENT_HANDLERS,
     build_font,
     build_motif_wm_hints,
     build_size_hints,
+    build_wm_hints,
     decode_property_value,
     encode_property_value,
     pack_change_property,
@@ -2090,3 +2094,96 @@ class TestSizeHintsFlagValues:
         assert WinGravity.NorthWest == 1
         assert WinGravity.Center == 5
         assert WinGravity.Static == 10
+
+
+class TestBuildWmHints:
+    def test_empty(self):
+        data = build_wm_hints()
+        assert len(data) == XWM_HINTS_LEN
+        assert data == [0] * XWM_HINTS_LEN
+
+    def test_input_and_state(self):
+        data = build_wm_hints(input=True, initial_state=InitialState.Normal)
+        flags = data[0]
+        assert flags == WMHintsFlag.InputHint | WMHintsFlag.StateHint
+        assert data[1] == 1  # input
+        assert data[2] == InitialState.Normal
+
+    def test_iconic(self):
+        data = build_wm_hints(initial_state=InitialState.Iconic)
+        assert data[0] == WMHintsFlag.StateHint
+        assert data[2] == InitialState.Iconic
+
+    def test_urgent(self):
+        data = build_wm_hints(urgent=True)
+        assert data[0] == WMHintsFlag.UrgencyHint
+        # no other fields set
+        assert data[1:] == [0] * (XWM_HINTS_LEN - 1)
+
+    def test_urgent_false_clears_bit(self):
+        data = build_wm_hints(urgent=False)
+        assert data[0] & WMHintsFlag.UrgencyHint == 0
+
+    def test_icon_pixmap_and_mask(self):
+        data = build_wm_hints(icon_pixmap=0xABC, icon_mask=0xDEF)
+        assert data[0] == WMHintsFlag.IconPixmapHint | WMHintsFlag.IconMaskHint
+        assert data[3] == 0xABC
+        assert data[7] == 0xDEF
+
+    def test_icon_window(self):
+        data = build_wm_hints(icon_window=0x1234)
+        assert data[0] == WMHintsFlag.IconWindowHint
+        assert data[4] == 0x1234
+
+    def test_icon_position(self):
+        data = build_wm_hints(icon_x=10, icon_y=20)
+        assert data[0] == WMHintsFlag.IconPositionHint
+        assert data[5] == 10
+        assert data[6] == 20
+
+    def test_window_group(self):
+        data = build_wm_hints(window_group=0x999)
+        assert data[0] == WMHintsFlag.WindowGroupHint
+        assert data[8] == 0x999
+
+    def test_all_fields(self):
+        data = build_wm_hints(
+            input=True,
+            initial_state=InitialState.Normal,
+            icon_pixmap=1,
+            icon_window=2,
+            icon_x=3,
+            icon_y=4,
+            icon_mask=5,
+            window_group=6,
+            urgent=True,
+        )
+        expected_flags = (
+            WMHintsFlag.InputHint
+            | WMHintsFlag.StateHint
+            | WMHintsFlag.IconPixmapHint
+            | WMHintsFlag.IconWindowHint
+            | WMHintsFlag.IconPositionHint
+            | WMHintsFlag.IconMaskHint
+            | WMHintsFlag.WindowGroupHint
+            | WMHintsFlag.UrgencyHint
+        )
+        assert data[0] == expected_flags
+        assert data[1:] == [1, 1, 1, 2, 3, 4, 5, 6]
+
+
+class TestWMHintsFlagValues:
+    def test_wm_hints_flags(self):
+        assert WMHintsFlag.InputHint == 1
+        assert WMHintsFlag.StateHint == 2
+        assert WMHintsFlag.IconPixmapHint == 4
+        assert WMHintsFlag.IconWindowHint == 8
+        assert WMHintsFlag.IconPositionHint == 16
+        assert WMHintsFlag.IconMaskHint == 32
+        assert WMHintsFlag.WindowGroupHint == 64
+        assert WMHintsFlag.UrgencyHint == 256
+
+    def test_initial_states(self):
+        assert InitialState.Withdrawn == 0
+        assert InitialState.Normal == 1
+        assert InitialState.Iconic == 3