xserver/test/pyxtest/proto/x11.py

# SPDX-License-Identifier: MIT
#
# Core X11 protocol request builders

import struct
from dataclasses import dataclass

# Core protocol opcodes
CreateWindow = 1
CreatePixmap = 53
InternAtom = 16
ListFonts = 49
SetFontPath = 51
GetFontPath = 52
QueryExtension = 98
ChangeKeyboardMapping = 100
ForceScreenSaverOpcode = 115


ScreenSaverReset = 0
ScreenSaverActive = 1


def _pad(data: bytes) -> bytes:
    """Pad data to a 4-byte boundary."""
    return data + b"\x00" * ((4 - len(data) % 4) % 4)


@dataclass
class CreateWindowRequest:
    """X11 CreateWindow request."""

    wid: int
    parent: int
    x: int
    y: int
    width: int
    height: int
    depth: int
    border_width: int = 0
    window_class: int = 1  # InputOutput
    visual: int = 0
    value_mask: int = 0x0800  # override-redirect
    override_redirect: int = 0

    def to_bytes(self, byte_order: str = "<") -> bytes:
        return struct.pack(
            f"{byte_order}BBH II hhHHHH II I",
            CreateWindow,  # opcode
            self.depth,
            9,  # request length in 4-byte units
            self.wid,
            self.parent,
            self.x,
            self.y,
            self.width,
            self.height,
            self.border_width,
            self.window_class,
            self.visual,
            self.value_mask,
            self.override_redirect,
        )


@dataclass
class CreatePixmapRequest:
    """X11 CreatePixmap request."""

    pid: int
    drawable: int
    width: int
    height: int
    depth: int

    def to_bytes(self, byte_order: str = "<") -> bytes:
        return struct.pack(
            f"{byte_order}BBHIIHH",
            CreatePixmap,  # opcode
            self.depth,
            4,  # request length
            self.pid,
            self.drawable,
            self.width,
            self.height,
        )


@dataclass
class InternAtomRequest:
    """X11 InternAtom request."""

    name: str
    only_if_exists: bool = False

    def to_bytes(self, byte_order: str = "<") -> bytes:
        name_bytes = self.name.encode("ascii")
        padded = _pad(name_bytes)
        req_len = (8 + len(padded)) // 4
        return (
            struct.pack(
                f"{byte_order}BBHHxx",
                InternAtom,  # opcode
                1 if self.only_if_exists else 0,
                req_len,
                len(name_bytes),
            )
            + padded
        )


@dataclass
class QueryExtensionRequest:
    """X11 QueryExtension request."""

    name: str

    def to_bytes(self, byte_order: str = "<") -> bytes:
        name_bytes = self.name.encode("ascii")
        padded = _pad(name_bytes)
        req_len = (8 + len(padded)) // 4
        return (
            struct.pack(
                f"{byte_order}BBHHxx", QueryExtension, 0, req_len, len(name_bytes)
            )
            + padded
        )


@dataclass
class ChangeKeyboardMappingRequest:
    """X11 ChangeKeyboardMapping request (opcode 100).

    Followed by keyCodes * keySymsPerKeyCode KeySym (CARD32) values.
    """

    first_keycode: int
    keysyms_per_keycode: int
    keycodes: int = 1
    keysyms: list[int] | None = None

    def to_bytes(self, byte_order: str = "<") -> bytes:
        if self.keysyms is None:
            syms = [0] * (self.keycodes * self.keysyms_per_keycode)
        else:
            syms = self.keysyms

        n_syms = len(syms)
        req_len = 2 + n_syms  # 8 bytes header = 2 words, plus 1 word per KeySym
        header = struct.pack(
            f"{byte_order}BBH BB xx",
            ChangeKeyboardMapping,
            self.keycodes,
            req_len,
            self.first_keycode,
            self.keysyms_per_keycode,
        )
        sym_data = b"".join(struct.pack(f"{byte_order}I", s) for s in syms)
        return header + sym_data


@dataclass
class ListFontsRequest:
    """X11 ListFonts request (opcode 49).

    xListFontsReq (8 bytes header):
      reqType(1) + pad(1) + length(2) + maxNames(2) + nbytes(2)
      followed by the pattern string (padded to 4-byte boundary).
    """

    pattern: str
    max_names: int = 65535

    def to_bytes(self, byte_order: str = "<") -> bytes:
        pat_bytes = self.pattern.encode("ascii")
        padded = _pad(pat_bytes)
        req_len = (8 + len(padded)) // 4
        header = struct.pack(
            f"{byte_order}BBH HH",
            ListFonts,
            0,  # pad
            req_len,
            self.max_names,
            len(pat_bytes),
        )
        return header + padded


@dataclass
class SetFontPathRequest:
    """X11 SetFontPath request (opcode 51).

    xSetFontPathReq (8 bytes header):
      reqType(1) + pad(1) + length(2) + nFonts(2) + pad(2)
      followed by LISTofSTR8 (length-prefixed strings).
    """

    paths: list[str]

    def to_bytes(self, byte_order: str = "<") -> bytes:
        # Build LISTofSTR8: each string is preceded by a 1-byte length
        payload = b""
        for p in self.paths:
            p_bytes = p.encode("ascii")
            payload += bytes([len(p_bytes)]) + p_bytes
        padded = _pad(payload)
        req_len = (8 + len(padded)) // 4
        header = struct.pack(
            f"{byte_order}BBH Hxx",
            SetFontPath,
            0,  # pad
            req_len,
            len(self.paths),
        )
        return header + padded


@dataclass
class GetFontPathRequest:
    """X11 GetFontPath request (opcode 52).

    Simple 4-byte request with no parameters.
    """

    def to_bytes(self, byte_order: str = "<") -> bytes:
        return struct.pack(
            f"{byte_order}BBH",
            GetFontPath,
            0,  # pad
            1,  # length = 1 word
        )


@dataclass
class GetFontPathReply:
    """Parsed xGetFontPathReply.

    xGetFontPathReply layout:
      type(1) + pad(1) + sequenceNumber(2) + length(4)
      nPaths(2) + pad(22)
      LISTofSTR8 (each entry: length-byte + string)
    """

    paths: list[str]

    @classmethod
    def from_reply(cls, data: bytes) -> "GetFontPathReply":
        """Parse an X11Reply's raw data into a GetFontPathReply."""
        paths: list[str] = []
        if len(data) < 32:
            return cls(paths)
        n_paths = struct.unpack_from("<H", data, 8)[0]
        offset = 32
        for _ in range(n_paths):
            if offset >= len(data):
                break
            slen = data[offset]
            offset += 1
            if offset + slen > len(data):
                break
            paths.append(data[offset : offset + slen].decode("ascii", errors="replace"))
            offset += slen
        return cls(paths)


@dataclass
class ForceScreenSaver:
    """X11 ForceScreenSaver request."""

    mode: int

    def to_bytes(self, byte_order: str = "<") -> bytes:
        return struct.pack(
            f"{byte_order}BBH",
            ForceScreenSaverOpcode,
            self.mode,
            1,  # length = 1 word
        )