aioxlib 0.4.0__tar.gz → 0.5.0__tar.gz

{aioxlib-0.4.0 → aioxlib-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aioxlib
-Version: 0.4.0
+Version: 0.5.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
@@ -36,10 +36,12 @@ asyncio—without blocking the event loop and without linking to libX11.
 ## Documentation
 
 - Online: [aioxlib.readthedocs.io](https://aioxlib.readthedocs.io)
-- Local: `pip install -r docs/requirements.txt && mkdocs serve`
+- Local: `pip install --group docs && mkdocs serve`
 
 ## Installation
 
+From within your favorite python environment:
+
 ```bash
 pip install aioxlib
 ```

{aioxlib-0.4.0 → aioxlib-0.5.0}/README.md

@@ -12,10 +12,12 @@ asyncio—without blocking the event loop and without linking to libX11.
 ## Documentation
 
 - Online: [aioxlib.readthedocs.io](https://aioxlib.readthedocs.io)
-- Local: `pip install -r docs/requirements.txt && mkdocs serve`
+- Local: `pip install --group docs && mkdocs serve`
 
 ## Installation
 
+From within your favorite python environment:
+
 ```bash
 pip install aioxlib
 ```

{aioxlib-0.4.0 → aioxlib-0.5.0}/aioxlib/__init__.py

@@ -16,19 +16,16 @@ Types and protocol helpers live in submodules::
     from aioxlib.protocol import pack_create_window
 """
 
-__version__ = "0.4.0"
+__version__ = "0.5.0"
 
+from . import api, constants
 from .api import *  # noqa: F403
-from .api import __all__ as _api_all
 from .constants import *  # noqa: F403
-from .constants import __all__ as _constants_all
 from .display import get_display
 
 __all__ = [
     "__version__",
     "get_display",
-    *_constants_all,
-    *_api_all,
+    *constants.__all__,
+    *api.__all__,
 ]
-
-del _api_all, _constants_all

{aioxlib-0.4.0 → aioxlib-0.5.0}/aioxlib/_extensions.py

@@ -11,6 +11,7 @@ from .dbe import DoubleBuffer
 from .dri3 import DRI3
 from .glx import GLX
 from .present import Present
+from .randr import RandR
 from .render import Render
 from .shm import SharedMemory
 
@@ -22,4 +23,5 @@ EXTENSIONS = {
     "DRI3": DRI3,
     "Present": Present,
     "RENDER": Render,
+    "RANDR": RandR,
 }

{aioxlib-0.4.0 → aioxlib-0.5.0}/aioxlib/api.py

@@ -207,6 +207,11 @@ async def get_font_path(display: Display | None = None):
     return await d.get_font_path()
 
 
+async def set_font_path(path, display: Display | None = None):
+    d = await _resolve_display(display)
+    return await d.set_font_path(path)
+
+
 async def get_atom(name, only_if_exists=False, display: Display | None = None):
     """Intern *name* (with cache) on the default (or given) display."""
     d = await _resolve_display(display)
@@ -296,10 +301,10 @@ async def open_font_name(name, display: Display | None = None):
     return await d.open_font_name(name)
 
 
-async def open_font(display: Display | None = None, **kwargs):
+async def open_font(name=None, display: Display | None = None, **kwargs):
     """Open a font built from keyword XLFD fields."""
     d = await _resolve_display(display)
-    return await d.open_font(**kwargs)
+    return await d.open_font(name=name, **kwargs)
 
 
 async def tree(wnd, display: Display | None = None):
@@ -402,6 +407,7 @@ __all__ = [
     "query_extension",
     "list_fonts",
     "get_font_path",
+    "set_font_path",
     "get_atom",
     "default_screen",
     "create_window",

{aioxlib-0.4.0 → aioxlib-0.5.0}/aioxlib/connection.py

@@ -97,10 +97,6 @@ class Connection:
         """Write."""
         self.writer.write(payload)
 
-    def writelines(self, lines):
-        """Writelines."""
-        self.writer.writelines(lines)
-
     async def flush(self):
         """Flush."""
         return await self.writer.drain()

{aioxlib-0.4.0 → aioxlib-0.5.0}/aioxlib/display.py

@@ -41,12 +41,15 @@ from .protocol import (
     pack_change_property,
     pack_clear_area,
     pack_configure_window,
+    pack_copy_area,
     pack_create_colormap,
     pack_create_gc,
+    pack_create_pixmap,
     pack_create_window,
     pack_delete_property,
     pack_destroy_window,
     pack_free_colormap,
+    pack_free_pixmap,
     pack_get_atom_name,
     pack_get_font_path,
     pack_get_geometry,
@@ -69,12 +72,14 @@ from .protocol import (
     pack_query_extension,
     pack_query_tree,
     pack_reparent_window,
+    pack_set_font_path,
     pack_set_input_focus,
     pack_setup,
     pack_unmap_window,
     unpack_client_message,
     unpack_error,
     unpack_event,
+    unpack_expose_event,
     unpack_get_atom_name,
     unpack_get_font_path,
     unpack_get_geometry,
@@ -155,6 +160,7 @@ class Drawable(Resource):
 
     async def draw_image(self, gc, x, y, w, h, depth, data, drawable=None):
         """Draw image."""
+        drawable = drawable or self
         max_size = self.display.info["max_request_length"]
         nb_pixels = w * h
         n = len(data)
@@ -194,8 +200,7 @@ class Drawable(Resource):
 
     async def put_text(self, gc, x, y, text, drawable=None):
         """Put text."""
-        if drawable is None:
-            drawable = self
+        drawable = drawable or self
         payload = pack_image_text(drawable, gc, x, y, text)
         self.display.connection.write(payload)
 
@@ -203,6 +208,11 @@ class Drawable(Resource):
         """Get geometry."""
         return await self.display.get_geometry(self)
 
+    async def create_pixmap(self, width, height, depth=None, drawable=None):
+        """Create a pixmap. *drawable* defaults to the root window."""
+        drawable = drawable or self
+        return await self.display.create_pixmap(width, height, depth, drawable)
+
 
 class ResourceManager:
     """Allocates resource IDs from the server base and mask."""
@@ -284,7 +294,7 @@ class Window(Drawable):
         delete_on_close=False,
         take_focus=False,
         **attrs,
-    ):
+    ) -> Window:
         """Create window."""
         wid = self.display.resources.allocate()
         payload = pack_create_window(
@@ -482,7 +492,7 @@ class Screen:
         background_pixel=None,
         delete_on_close=True,
         **attrs,
-    ):
+    ) -> Window:
         """Create window."""
         if parent is None:
             parent = self.root
@@ -538,7 +548,10 @@ class Display:
         self.commands = {cmd: cmd.name for cmd in Command}
         self.requests = asyncio.Queue()
         self.listeners = set()
-        self._events = {EventType.ClientMessage: unpack_client_message}
+        self._events = {
+            EventType.ClientMessage: unpack_client_message,
+            EventType.Expose: unpack_expose_event,
+        }
         self._atom_cache = {}
         self._extensions_cache = None
         self._task = None
@@ -670,6 +683,16 @@ class Display:
         reply = await self.write_read(payload, unpack_get_font_path)
         return reply["path"]
 
+    async def set_font_path(self, paths=()):
+        """Set the font search path.
+
+        *paths* is a sequence of directory strings.  Pass an empty sequence
+        (or call with no arguments) to restore the server default path.
+        This is a write-only request (no reply).
+        """
+        payload = pack_set_font_path(paths)
+        self.write(payload)
+
     async def get_atom(self, name, only_if_exists=False):
         """Intern *name* and cache the atom id."""
         if name in self._atom_cache:
@@ -759,9 +782,9 @@ class Display:
         self.write(payload)
         return fid
 
-    async def open_font(self, **kwargs):
+    async def open_font(self, name=None, **kwargs):
         """Open font."""
-        font = build_font(**kwargs)
+        font = build_font(**kwargs) if name is None else name
         return await self.open_font_name(font)
 
     async def tree(self, wnd):
@@ -811,6 +834,24 @@ class Display:
         payload = pack_clear_area(wnd, x, y, w, h, exposure)
         self.write(payload)
 
+    async def copy_area(self, src, dst, gc, src_x, src_y, width, height, dst_x=0, dst_y=0):
+        """Copy a rectangle from *src* to *dst*."""
+        self.write(pack_copy_area(src, dst, gc, src_x, src_y, width, height, dst_x, dst_y))
+
+    async def create_pixmap(self, width, height, depth=None, drawable=None):
+        """Create a pixmap. *drawable* defaults to the root window."""
+        if drawable is None:
+            drawable = self.default_screen().root
+        if depth is None:
+            depth = self.default_screen().root_depth
+        pid = self.resources.allocate()
+        self.write(pack_create_pixmap(pid, drawable, width, height, depth))
+        return pid
+
+    async def free_pixmap(self, pixmap):
+        """Free a pixmap."""
+        self.write(pack_free_pixmap(pixmap))
+
     async def set_input_focus(self, focus, revert_to=1, time=0):
         """Set keyboard input focus to *focus* (window id or resource)."""
         self.write(pack_set_input_focus(focus, revert_to=revert_to, time=time))

{aioxlib-0.4.0 → aioxlib-0.5.0}/aioxlib/protocol.py

@@ -359,6 +359,36 @@ def unpack_list_properties(data, offset=0):
     return struct.unpack_from(f"{nb_atoms}I", data, offset), offset + nb_atoms * 4
 
 
+def pack_list_strings(strings, encoding=DEFAULT_STRING_ENCODING) -> bytes:
+    """Pack a LISTofSTR (length-prefixed strings) with trailing pad to 4 bytes."""
+    parts = []
+    total = 0
+    for s in strings:
+        if isinstance(s, str):
+            b = s.encode(encoding)
+        else:
+            b = bytes(s)
+        if len(b) > 255:
+            raise ValueError(f"font path component longer than 255 bytes: {s!r}")
+        parts.append(struct.pack("B", len(b)) + b)
+        total += 1 + len(b)
+    body = b"".join(parts)
+    return body + b"\0" * pad(total)
+
+
+def pack_set_font_path(paths=()) -> bytes:
+    """Pack a SetFontPath request.
+
+    *paths* is a sequence of directory strings (or bytes).  An empty sequence
+    resets the font search path to the server default.
+    """
+    body = pack_list_strings(paths)
+    n = len(paths)
+    # header: opcode, unused, length, n, unused
+    length = 2 + len(body) // 4
+    return struct.pack("BxHH2x", Command.SetFontPath, length, n) + body
+
+
 def pack_get_font_path():
     """Pack a wire-protocol get font path request into ``bytes``."""
     return struct.pack("BxH", Command.GetFontPath, 1)
@@ -560,6 +590,15 @@ def unpack_setup_error(data, offset=0):
     return error, offset + length
 
 
+def unpack_expose_event(data, offset=0):
+    fmt = "BxHIHHHHH"
+    fields = "raw_code", "sequence_number", "window", "x", "y", "width", "height", "count"
+    reply = struct.unpack_from(fmt, data, offset)
+    result = dict(zip(fields, reply, strict=True))
+    result["name"] = EventType.Expose.name
+    return result, offset + 32
+
+
 def unpack_event(event_map, data: bytes, offset: int = 0):
     """Unpack a event reply or event from *data* starting at *offset*."""
     raw_event_type = data[0]
@@ -641,6 +680,43 @@ def pack_clear_area(wnd, x, y, w, h, exposure=False):
     return struct.pack("BBHIhhHH", Command.ClearArea, int(exposure), 4, wnd, x, y, w, h)
 
 
+def pack_copy_area(src, dst, gc, src_x, src_y, width, height, dst_x, dst_y):
+    """Pack CopyArea."""
+    return struct.pack(
+        "BxHIIIhhhhHH",
+        Command.CopyArea,
+        7,
+        int(src),
+        int(dst),
+        int(gc),
+        int(src_x),
+        int(src_y),
+        int(dst_x),
+        int(dst_y),
+        int(width),
+        int(height),
+    )
+
+
+def pack_create_pixmap(pid, drawable, width, height, depth):
+    """Pack CreatePixmap."""
+    return struct.pack(
+        "BBHIIHH",
+        Command.CreatePixmap,
+        int(depth),
+        4,
+        int(pid),
+        int(drawable),
+        int(width),
+        int(height),
+    )
+
+
+def pack_free_pixmap(pixmap):
+    """Pack FreePixmap."""
+    return struct.pack("BxHI", Command.FreePixmap, 2, int(pixmap))
+
+
 def pack_change_property(wid, property, property_type, format, data, mode):
     """Pack a wire-protocol change property request into ``bytes``."""
     if not isinstance(data, bytes | bytearray):