# This file is part of Xpra.
# Copyright (C) 2011 Serviware (Arthur Huillet, <ahuillet@serviware.com>)
# Copyright (C) 2010 Antoine Martin <antoine@xpra.org>
# Copyright (C) 2008 Nathaniel Smith <njs@pobox.com>
# Xpra is released under the terms of the GNU GPL v2, or, at your option, any
# later version. See the file COPYING for details.

import os
import re
from typing import Any
from collections.abc import Callable, MutableSequence

from xpra.os_util import OSX, WIN32, gi_import
from xpra.client.gui.widget_base import ClientWidgetBase
from xpra.client.gui.window.backing import fire_paint_callbacks
from xpra.client.gui.window_border import WindowBorder
from xpra.net.common import PacketElement
from xpra.common import gravity_str, force_size_constraint
from xpra.util.parsing import scaleup_value, scaledown_value
from xpra.util.system import is_Wayland
from xpra.util.objects import typedict
from xpra.util.str_fn import std
from xpra.util.env import envint, envbool, ignorewarnings
from xpra.log import Logger

GLib = gi_import("GLib")

log = Logger("window")
paintlog = Logger("paint")
workspacelog = Logger("workspace")
keylog = Logger("keyboard")
metalog = Logger("metadata")
geomlog = Logger("geometry")
iconlog = Logger("icon")
alphalog = Logger("alpha")
scalinglog = Logger("scaling")

PROPERTIES_DEBUG = [x.strip() for x in os.environ.get("XPRA_WINDOW_PROPERTIES_DEBUG", "").split(",")]
SET_SIZE_CONSTRAINTS = envbool("XPRA_SET_SIZE_CONSTRAINTS", True)
DEFAULT_GRAVITY = envint("XPRA_DEFAULT_GRAVITY", 0)
OVERRIDE_GRAVITY = envint("XPRA_OVERRIDE_GRAVITY", 0)
FORCE_FLUSH = envbool("XPRA_FORCE_FLUSH", False)

SHOW_SPINNER_WINDOW_TYPES = set(os.environ.get("XPRA_SHOW_SPINNER_WINDOW_TYPES", "DIALOG,NORMAL,SPLASH").split(","))


def is_wm_property(name: str) -> bool:
    return any(name.startswith(prefix) for prefix in ("_MOTIF", "WM_", "_NET_WM", "_GTK_"))


def validhostname(value):
    if value in (
            "localhost",
            "localhost.localdomain",
            "",
            None,
    ):
        return None
    return value


class ClientWindowBase(ClientWidgetBase):

    def __init__(self, client, group_leader, wid: int,
                 geom: tuple[int, int, int, int],
                 backing_size: tuple[int, int],
                 metadata: typedict, override_redirect: bool, client_properties: typedict,
                 border: WindowBorder, max_window_size, pixel_depth: int,
                 headerbar="no"):
        log("%s%s", type(self),
            (client, group_leader, wid,
             geom, backing_size,
             metadata, override_redirect, client_properties,
             border, max_window_size, pixel_depth,
             headerbar))
        super().__init__(client, wid, metadata.boolget("has-alpha"))
        wx, wy, ww, wh = geom
        bw, bh = backing_size
        self._override_redirect = override_redirect
        self.group_leader = group_leader
        self._pos = (wx, wy)
        self._size = (ww, wh)
        self._xscale = client.xscale
        self._yscale = client.yscale
        self._client_properties = client_properties
        self._set_initial_position = metadata.boolget("set-initial-position", False)
        self._requested_position = metadata.intpair("requested-position", None)
        self.size_constraints = typedict()
        self.geometry_hints = typedict()
        self.content_type = ""
        self._fullscreen = None
        self._maximized = False
        self._above = False
        self._below = False
        self._shaded = False
        self._sticky = False
        self._skip_pager = False
        self._skip_taskbar = False
        self._iconified = False
        self._focused = False
        self._opaque_region = ()
        self._actions = ()
        self.window_gravity = OVERRIDE_GRAVITY or DEFAULT_GRAVITY
        self.border = border
        self.max_window_size = max_window_size
        self.pixel_depth = pixel_depth  # 0 for default
        # window_offset is the delta between the location of the window requested by the server,
        # and where we actually end up mapping it on the client
        # (ie: when we reposition an OR window to ensure it is visible on screen)
        self.window_offset = None
        self.pending_refresh: list[tuple[int, int, int, int]] = []
        self.headerbar = headerbar

        self.init_window(client, metadata, client_properties)
        self.setup_window(bw, bh)
        self.update_metadata(metadata)
        self.finalize_window()

    def __repr__(self):
        return f"ClientWindow({self.wid:#x})"

    def init_window(self, client, metadata: typedict, client_props: typedict) -> None:
        self._backing = None
        self._metadata = typedict()
        # used for only sending focus events *after* the window is mapped:
        self._been_mapped = False

        if self.max_window_size and "size-constraints" not in metadata:
            # this ensures that we will set size-constraints and honour max_window_size:
            metadata["size-constraints"] = {}
        # initialize gravity early:
        sc = typedict(metadata.dictget("size-constraints", {}))
        self.window_gravity = OVERRIDE_GRAVITY or sc.intget("gravity", DEFAULT_GRAVITY)
        self.set_decorated(metadata.boolget("decorations", True))

    def finalize_window(self) -> None:
        """ subclasses override this method """

    def get_info(self) -> dict[str, Any]:
        attributes = []
        for attr in (
                "fullscreen", "maximized",
                "above", "below",
                "shaded", "sticky",
                "skip-pager", "skip-taskbar",
                "iconified", "focused",
        ):
            if getattr(self, "_%s" % attr.replace("-", "_"), False):
                attributes.append(attr)
        info = super().get_info()
        info |= {
            "override-redirect": self._override_redirect,
            # "group-leader"          : self.group_leader,
            "position": self._pos,
            "size": self._size,
            "client-properties": dict(self._client_properties),
            "set-initial-position": self._set_initial_position,
            "size-constraints": dict(self.size_constraints),
            "geometry-hints": dict(self.geometry_hints),
            "content-type": self.content_type,
            "attributes": attributes,
            "gravity": gravity_str(self.window_gravity),
            # "border"                : self.border or "",
            "max-size": self.max_window_size,
            "offset": self.window_offset or (0, 0),
        }
        return info

    ######################################################################
    # screen scaling:
    def fsx(self, v) -> float:
        """ convert X coordinate from server to client """
        return v * self._xscale

    def fsy(self, v) -> float:
        """ convert Y coordinate from server to client """
        return v * self._yscale

    def sx(self, v) -> int:
        """ convert X coordinate from server to client """
        return round(self.fsx(v))

    def sy(self, v) -> int:
        """ convert Y coordinate from server to client """
        return round(self.fsy(v))

    def srect(self, x, y, w, h) -> tuple[int, int, int, int]:
        """ convert rectangle coordinates from server to client """
        return self.sx(x), self.sy(y), self.sx(w), self.sy(h)

    def sp(self, x, y) -> tuple[int, int]:
        """ convert X,Y coordinates from server to client """
        return self.sx(x), self.sy(y)

    def cx(self, v) -> int:
        """ convert X coordinate from client to server """
        return round(v / self._xscale)

    def cy(self, v) -> int:
        """ convert Y coordinate from client to server """
        return round(v / self._yscale)

    def crect(self, x, y, w, h) -> tuple[int, int, int, int]:
        """ convert rectangle coordinates from client to server """
        return self.cx(x), self.cy(y), self.cx(w), self.cy(h)

    def cp(self, x, y) -> tuple[int, int]:
        """ convert X,Y coordinates from client to server """
        return self.cx(x), self.cy(y)

    def new_backing(self, bw: int, bh: int):
        backing_class = self.get_backing_class()
        log("new_backing(%s, %s) backing_class=%s", bw, bh, backing_class)
        assert backing_class is not None
        w, h = self._size
        self._backing = self.make_new_backing(backing_class, w, h, bw, bh)
        self._backing.border = self.border
        # soft dependency on `PointerWindow`:
        self._backing.default_cursor_data = getattr(self, "default_cursor_data", ())
        self._backing.gravity = self.window_gravity
        # this is only used by cairo to request a repaint for the fps counter:
        self._backing.repaint = self.repaint
        return self._backing._backing

    def destroy(self) -> None:
        # ensure we clear reference to other windows:
        self.group_leader = None
        self._metadata = typedict()
        if self._backing:
            self._backing.close()
            self._backing = None

    def setup_window(self, bw: int, bh: int) -> None:
        self.new_backing(bw, bh)
        # tell the server about the encoding capabilities of this backing instance:
        # but don't bother if they're the same as what we sent as defaults
        # (with a bit of magic to collapse the missing namespace from encoding_defaults)
        backing_props = self._backing.get_encoding_properties()
        encoding_defaults = self._client.encoding_defaults
        for k in tuple(backing_props.keys()):
            v = backing_props[k]
            try:
                # ie: "encodings.rgb_formats" -> "rgb_formats"
                # ie: "encoding.full_csc_modes" -> "full_csc_modes"
                ek = k.split(".", 1)[1]
            except IndexError:
                ek = k
            dv = encoding_defaults.get(ek)
            if dv is not None and dv == v:
                del backing_props[k]
        self._client_properties.update(backing_props)

    def send(self, packet_type: str, *args: PacketElement) -> None:
        self._client.send(packet_type, *args)

    def reset_icon(self) -> None:
        current_icon = self._current_icon
        iconlog("reset_icon() current icon=%s", current_icon)
        if current_icon:
            self.update_icon(current_icon)

    def update_icon(self, img) -> None:
        raise NotImplementedError

    def apply_transient_for(self, wid: int) -> None:
        raise NotImplementedError

    def xget_u32_property(self, target, name: str, default_value=0) -> int:
        return default_value

    def is_OR(self) -> bool:
        return self._override_redirect

    def update_metadata(self, metadata: typedict) -> None:
        metalog("update_metadata(%s)", metadata)
        if self._client.readonly:
            metadata.update(force_size_constraint(*self._size))
        self._metadata.update(metadata)
        try:
            self.set_metadata(metadata)
        except RuntimeError:
            metalog.warn("failed to set window metadata to '%s'", metadata, exc_info=True)

    def _get_window_title(self, metadata: typedict) -> str:
        try:
            return self.do_get_window_title(metadata)
        except Exception as e:
            log.error("Error parsing window title:")
            log.estr(e)
            return self._client.title.replace("\0", "")

    def do_get_window_title(self, metadata: typedict) -> str:
        title = self._client.title.replace("\0", "")
        if title.find("@") < 0:
            return title
        # perform metadata variable substitutions:
        UNKNOWN_MACHINE = "<unknown machine>"
        remote_hostname = getattr(self._client, "_remote_hostname", None)
        remote_display = getattr(self._client, "_remote_display", None)
        if remote_display:
            # ie: "1\\WinSta0\\Default" -> 1-WinSta0-Default
            remote_display = remote_display.replace("\\", "-")
        default_values: dict[str, str] = {
            "title": "<untitled window>",
            "client-machine": UNKNOWN_MACHINE,
            "windowid": str(self.wid),
            "server-machine": std(remote_hostname) or UNKNOWN_MACHINE,
            "server-display": std(remote_display) or "<unknown display>",
        }
        metalog(f"default values: {default_values}")

        def getvar(var) -> str:
            # "hostname" is magic:
            # we try harder to find a useful value to show:
            if var in ("hostname", "hostinfo"):
                server_display = getattr(self._client, "server_display", None)
                if var == "hostinfo" and getattr(self._client, "mmap_enabled", False) and server_display:
                    # this is a local connection for sure and we can specify the display directly:
                    return server_display
                import socket
                local_hostname = validhostname(socket.gethostname())
                # try to find the hostname:
                proto = getattr(self._client, "_protocol", None)
                target = None
                if proto:
                    conn = getattr(proto, "_conn", None)
                    if conn:
                        hostname = conn.info.get("host")
                        target = str(conn.target)
                        if hostname:
                            if local_hostname == hostname and server_display:
                                return server_display
                            return hostname
                for m in ("client-machine", "server-machine"):
                    value = validhostname(getvar(m))
                    if value and value != local_hostname:
                        return value
                if server_display:
                    return server_display
                if target:
                    return target
                return UNKNOWN_MACHINE
            value = metadata.get(var) or self._metadata.get(var)
            if value is None:
                return default_values.get(var, "<unknown %s>" % var)
            return str(value)

        def metadata_replace(match) -> str:
            atvar = match.group(0)  # ie: '@title@'
            var = atvar[1:len(atvar) - 1]  # ie: 'title'
            if not var:
                # atvar = "@@"
                return "@"
            return getvar(var)

        sub = r"@[\w\-]*@"
        replaced = re.sub(sub, metadata_replace, title)
        metalog("re.sub%s=%s", (sub, metadata_replace, title), replaced)
        return replaced

    def set_metadata(self, metadata: typedict):
        metalog("set_metadata(%s)", metadata)
        debug_props = tuple(x for x in PROPERTIES_DEBUG if x in metadata.keys())
        for x in debug_props:
            metalog.info("set_metadata: %s=%s", x, metadata.get(x))
        # WARNING: "class-instance" needs to go first because others may realize the window
        # (and GTK doesn't set the "class-instance" once the window is realized)
        if "class-instance" in metadata:
            self.set_class_instance(*metadata.strtupleget("class-instance", ("xpra", "Xpra"), 2, 2))
            self.reset_icon()

        if "title" in metadata:
            title = self._get_window_title(metadata)
            self.set_title(title)

        if "locale" in metadata:
            locale = metadata.get("locale", "")
            self.set_locale(locale)

        if "icon-title" in metadata:
            icon_title = metadata.strget("icon-title")
            self.set_icon_name(icon_title)
            # the DE may have reset the icon now,
            # force it to use the one we really want:
            self.reset_icon()

        if "size-constraints" in metadata:
            sc = typedict(metadata.dictget("size-constraints", {}))
            self.size_constraints = sc
            self._set_initial_position = sc.boolget("set-initial-position", self._set_initial_position)
            self.set_size_constraints(sc, self.max_window_size)

        if "set-initial-position" in metadata:
            # this should be redundant - but we keep it here for consistency
            self._set_initial_position = metadata.boolget("set-initial-position")

        if "transient-for" in metadata:
            self.apply_transient_for(metadata.intget("transient-for"))

        if "modal" in metadata:
            self.set_modal(metadata.boolget("modal"))

        # apply window-type hint if window has not been mapped yet:
        if "window-type" in metadata:
            self.set_window_type(metadata.strtupleget("window-type"))

        if "role" in metadata:
            self.set_role(metadata.strget("role"))

        if "xid" in metadata:
            self.set_xid(metadata.strget("xid"))

        if "opacity" in metadata:
            opacity = metadata.intget("opacity", -1)
            opacity = 1 if opacity < 0 else min(1, opacity // 0xffffffff)
            ignorewarnings(self.set_opacity, opacity)

        if "has-alpha" in metadata:
            new_alpha = metadata.boolget("has-alpha")
            if new_alpha != self._has_alpha:
                # win32 without opengl can't do transparency,
                # so it triggers too many warnings
                log_fn = alphalog.debug if WIN32 else alphalog.warn
                log_fn("Warning: window %#x changed its transparency attribute", self.wid)
                log_fn(" from %s to %s, behaviour is undefined", self._has_alpha, new_alpha)
                self._has_alpha = new_alpha

        if "maximized" in metadata:
            self.set_maximized(metadata.boolget("maximized"))

        if "fullscreen" in metadata:
            self.set_fullscreen(metadata.boolget("fullscreen"))

        if "iconic" in metadata:
            self.set_iconic(metadata.boolget("iconic"))

        if "decorations" in metadata:
            decorated = metadata.boolget("decorations", True)
            was_decorated = self.get_decorated()
            if WIN32 and decorated != was_decorated:
                log.info("decorations flag toggled, now %s, re-initializing window", decorated)
                GLib.idle_add(self._client.reinit_window, self.wid, self)
            else:
                self.set_decorated(metadata.boolget("decorations"))
                self.apply_geometry_hints(self.geometry_hints)

        if "above" in metadata:
            self.set_above(metadata.boolget("above"))

        if "below" in metadata:
            self.set_below(metadata.boolget("below"))

        if "shaded" in metadata:
            self.set_shaded(metadata.boolget("shaded"))

        if "sticky" in metadata:
            self.set_sticky(metadata.boolget("sticky"))

        if "skip-taskbar" in metadata:
            self.set_skip_taskbar(metadata.boolget("skip-taskbar"))

        if "skip-pager" in metadata:
            self.set_skip_pager(metadata.boolget("skip-pager"))

        if "focused" in metadata:
            self.set_focused(metadata.boolget("focused"))

        if "opaque-region" in metadata:
            self.set_opaque_region(metadata.tupleget("opaque-region"))

        if "workspace" in metadata:
            self.set_workspace(metadata.intget("workspace"))

        if "bypass-compositor" in metadata:
            self.set_bypass_compositor(metadata.intget("bypass-compositor"))

        if "strut" in metadata:
            self.set_strut(metadata.dictget("strut", {}))

        if "fullscreen-monitors" in metadata:
            self.set_fullscreen_monitors(metadata.inttupleget("fullscreen-monitors"))

        if "shape" in metadata:
            self.set_shape(metadata.dictget("shape", {}))

        if "command" in metadata:
            self.set_command(metadata.strget("command"))

        if "x11-property" in metadata:
            attr = metadata.tupleget("x11-property")
            if len(attr) >= 4:
                name, ptype, _, value = attr[:4]
                if not is_wm_property(name):
                    self.set_x11_property(name, ptype, value)

        if "content-type" in metadata:
            self.content_type = metadata.strget("content-type")

        if "actions" in metadata:
            self._actions = metadata.strtupleget("actions")

    def set_x11_property(self, *x11_property) -> None:
        pass  # see gtk client window base

    def set_above(self, above: bool) -> None:
        if self._above != above:
            self._above = above
            self.set_keep_above(above)

    def set_below(self, below: bool) -> None:
        if self._below != below:
            self._below = below
            self.set_keep_below(below)

    def set_sticky(self, sticky: bool) -> None:
        if self._sticky != sticky:
            self._sticky = sticky
            if sticky:
                self.stick()
            else:
                self.unstick()

    def set_skip_taskbar(self, skip_taskbar: bool) -> None:
        if self._skip_taskbar != skip_taskbar:
            self._skip_taskbar = skip_taskbar
            self.set_skip_taskbar_hint(skip_taskbar)

    def set_skip_pager(self, skip_pager: bool) -> None:
        if self._skip_pager != skip_pager:
            self._skip_pager = skip_pager
            self.set_skip_pager_hint(skip_pager)

    def set_focused(self, focused: bool) -> None:
        # only implemented for X11
        pass

    def set_opaque_region(self, rectangles: tuple | None) -> None:
        pass  # see gtk client window base

    def set_iconic(self, iconified: bool) -> None:
        if self._iconified != iconified:
            self._iconified = iconified
            if iconified:
                self.iconify()
            else:
                self.deiconify()

    def set_fullscreen(self, fullscreen: bool) -> None:
        """ see gtk3 window for implementation """

    def set_maximized(self, maximized: bool) -> None:
        if maximized != self._maximized:
            self._maximized = maximized
            if maximized:
                self.maximize()
            else:
                self.unmaximize()

    def set_command(self, command) -> None:
        """ see gtk3 window for implementation """

    def set_class_instance(self, wmclass_name, wmclass_class) -> None:
        """ see gtk3 window for implementation """

    def set_shape(self, shape) -> None:
        """ see gtk3 window for implementation """

    def set_bypass_compositor(self, v) -> None:
        """ see gtk3 window for implementation """

    def set_strut(self, strut) -> None:
        """ see gtk3 window for implementation """

    def set_fullscreen_monitors(self, fsm) -> None:
        """ see gtk3 window for implementation """

    def set_shaded(self, shaded) -> None:
        """ see gtk3 window for implementation """

    def reset_size_constraints(self) -> None:
        self.set_size_constraints(self.size_constraints, self.max_window_size)

    def set_size_constraints(self, size_constraints: typedict, max_window_size: tuple[int, int]):
        if not SET_SIZE_CONSTRAINTS:
            return
        geomlog("set_size_constraints(%s, %s)", size_constraints, max_window_size)
        hints = typedict()
        client = self._client
        for (a, h1, h2) in (
                ("maximum-size", "max_width", "max_height"),
                ("minimum-size", "min_width", "min_height"),
                ("base-size", "base_width", "base_height"),
                ("increment", "width_inc", "height_inc"),
        ):
            v = size_constraints.intpair(a)
            geomlog("intpair(%s)=%s", a, v)
            if not v:
                continue
            v1, v2 = v
            if a == "maximum-size" and v1 >= 16384 and v2 >= 16384 and WIN32:
                # causes problems, see #2714, #3533
                continue
            sv1 = client.sx(v1)
            sv2 = client.sy(v2)
            if a in ("base-size", "increment"):
                # rounding is not allowed for these values
                fsv1 = client.fsx(v1)
                fsv2 = client.fsy(v2)

                def closetoint(value):
                    # tolerate some rounding error:
                    # (ie: 2:3 scaling may not give an integer without a tiny bit of rounding)
                    return abs(round(value) - value) < 0.00001

                if not closetoint(fsv1) or not closetoint(fsv2):
                    # the scaled value is not close to an int,
                    # so we can't honour it:
                    geomlog("cannot honour '%s' due to scaling, scaled values are not both integers: %s, %s",
                            a, fsv1, fsv2)
                    continue
            hints[h1] = sv1
            hints[h2] = sv2
        if not OSX:
            for (a, h) in (
                    ("minimum-aspect-ratio", "min_aspect"),
                    ("maximum-aspect-ratio", "max_aspect"),
            ):
                v = size_constraints.intpair(a)
                if v:
                    v1, v2 = v
                    hints[h] = (v1 * self._xscale) / (v2 * self._yscale)
        # apply max-size override if needed:
        w, h = max_window_size
        if w > 0 and h > 0 and not self._fullscreen:
            # get the min size, if there is one:
            minw = max(1, hints.intget("min_width", 1))
            minh = max(1, hints.intget("min_height", 1))
            # the actual max size is:
            # * greater than the min-size
            # * the lowest of the max-size set by the application and the one we have
            # * ensure we honour the other hints, and round the max-size down if needed:
            # according to the GTK docs:
            # allowed window widths are base_width + width_inc * N where N is any integer
            # allowed window heights are base_height + width_inc * N where N is any integer
            maxw = hints.intget("max_width", 32768)
            maxh = hints.intget("max_height", 32768)
            maxw = max(minw, min(w, maxw))
            maxh = max(minh, min(h, maxh))
            rw = (maxw - hints.intget("base_width", 0)) % max(hints.intget("width_inc", 1), 1)
            rh = (maxh - hints.intget("base_height", 0)) % max(hints.intget("height_inc", 1), 1)
            maxw -= rw
            maxh -= rh
            # if the hints combination is invalid, it's possible that we'll end up
            # not honouring "base" + "inc", but honouring just "min" instead:
            maxw = max(minw, maxw)
            maxh = max(minh, maxh)
            scaling_info = self._xscale, self._yscale
            geomlog("modified hints for max window size %s and scaling %s: %s (rw=%s, rh=%s) -> max=%sx%s",
                    max_window_size, scaling_info, hints, rw, rh, maxw, maxh)
            # ensure we don't have duplicates with bytes / strings,
            # and that keys are always "bytes":
            # (in practice this code should never fire, just here as a reminder)
            for x in ("max_width", "max_height"):
                hints.pop(x, None)
            # bug 2214: GTK3 on win32 gets confused if we specify a large max-size,
            # and it will mess up maximizing the window
            if not WIN32 or (maxw < 32000 or maxh < 32000):
                hints["max_width"] = maxw
                hints["max_height"] = maxh
        try:
            geomlog("calling: %s(%s)", self.apply_geometry_hints, hints)
            # save them so the window hooks can use the last value used:
            self.geometry_hints = hints
            self.apply_geometry_hints(hints)
        except Exception as e:
            geomlog("set_size_constraints%s", (size_constraints, max_window_size), exc_info=True)
            geomlog.error("Error setting window hints:")
            geomlog.estr(e)
            for k, v in hints.items():
                geomlog.error(f"  {k}={v}")
            geomlog.error(" from size constraints:")
            for k, v in size_constraints.items():
                geomlog.error("  %s=%s", k, v)
        self.window_gravity = OVERRIDE_GRAVITY or size_constraints.intget("gravity", DEFAULT_GRAVITY)
        b = self._backing
        if b:
            b.gravity = self.window_gravity

    def set_locale(self, locale: str) -> None:
        pass  # see gtk client window base

    def set_window_type(self, window_types) -> None:
        pass  # see gtk client window base

    def set_workspace(self, workspace) -> None:
        pass  # see gtk client window base

    def set_xid(self, xid) -> None:
        pass  # see gtk client window base

    def toggle_debug(self, *_args) -> None:
        b = self._backing
        log.info("toggling debug on backing %s for window %i", b, self.wid)
        if not b:
            return
        if b.paint_box_line_width > 0:
            b.paint_box_line_width = 0
        else:
            b.paint_box_line_width = b.default_paint_box_line_width

    def increase_quality(self, *_args) -> None:
        if self._client.quality > 0:
            # change fixed quality:
            self._client.quality = min(100, self._client.quality + 10)
            self._client.send_quality()
            log("new quality=%s", self._client.quality)
        else:
            self._client.min_quality = min(100, self._client.min_quality + 10)
            self._client.send_min_quality()
            log("new min-quality=%s", self._client.min_quality)

    def decrease_quality(self, *_args) -> None:
        if self._client.quality > 0:
            # change fixed quality:
            self._client.quality = max(1, self._client.quality - 10)
            self._client.send_quality()
            log("new quality=%s", self._client.quality)
        else:
            self._client.min_quality = max(0, self._client.min_quality - 10)
            self._client.send_min_quality()
            log("new min-quality=%s", self._client.min_quality)

    def increase_speed(self, *_args) -> None:
        if self._client.speed > 0:
            # change fixed speed:
            self._client.speed = min(100, self._client.speed + 10)
            self._client.send_speed()
            log("new speed=%s", self._client.speed)
        else:
            self._client.min_speed = min(100, self._client.min_speed + 10)
            self._client.send_min_speed()
            log("new min-speed=%s", self._client.min_speed)

    def decrease_speed(self, *_args) -> None:
        if self._client.speed > 0:
            # change fixed speed:
            self._client.speed = max(1, self._client.speed - 10)
            self._client.send_speed()
            log("new speed=%s", self._client.speed)
        else:
            self._client.min_speed = max(0, self._client.min_speed - 10)
            self._client.send_min_speed()
            log("new min-speed=%s", self._client.min_speed)

    def scaleup(self, *_args) -> None:
        self._client.scaleup()

    def window_scaleup(self, *_args) -> None:
        scaling = max(self._xscale, self._yscale)
        options = scaleup_value(scaling)
        scalinglog("scaleup() options=%s", options)
        if options:
            self._scaleto(min(options))

    def scaledown(self, *_args) -> None:
        self._client.scaledown()

    def window_scaledown(self, *_args) -> None:
        scaling = min(self._xscale, self._yscale)
        options = scaledown_value(scaling)
        scalinglog("scaledown() options=%s", options)
        if options:
            self._scaleto(max(options))

    def scalingoff(self) -> None:
        self._client.scalingoff()

    def window_scalingoff(self) -> None:
        self._scaleto(1)

    def _scaleto(self, scaling) -> None:
        xscale = self._xscale
        yscale = self._yscale
        w, h = self._size
        self._xscale = self._yscale = scaling
        nw = round(w / xscale * self._xscale)
        nh = round(h / yscale * self._yscale)
        self.reset_size_constraints()
        self.resize(nw, nh)

    def scalereset(self, *_args) -> None:
        self._client.scalereset()

    def magic_key(self, *args) -> None:
        b = self.border
        if b:
            b.toggle()
            log("magic_key%s border=%s", args, b)
            self.repaint(0, 0, *self._size)

    def repaint(self, x: int, y: int, w: int, h: int):
        # self.queue_draw_area(0, 0, *self._size)
        raise NotImplementedError("no repaint on %s" % type(self))

    def refresh_window(self, *args) -> None:
        log("refresh_window(%s) wid=%#x", args, self.wid)
        self._client.send_refresh(self.wid)

    def refresh_all_windows(self, *_args) -> None:
        # this method is only here because we may want to fire it
        # from a --key-shortcut action and the event is delivered to
        # the "ClientWindow"
        self._client.send_refresh_all()

    def draw_region(self, x: int, y: int, width: int, height: int,
                    coding: str, img_data, rowstride: int,
                    options: typedict, callbacks: MutableSequence[Callable]):
        """ Note: this runs from the draw thread (not UI thread) """
        backing = self._backing
        if not backing:
            log("draw_region: window %s has no backing, gone?", self.wid)
            fire_paint_callbacks(callbacks, -1, "no backing")
            return
        # only register this callback if we actually need it:
        if backing.draw_needs_refresh:
            if not backing.repaint_all:
                self.pending_refresh.append((x, y, width, height))
            if options.intget("flush", 0) == 0 or FORCE_FLUSH:
                callbacks.append(self.after_draw_refresh)
        if coding == "void":
            fire_paint_callbacks(callbacks)
            return
        backing.draw_region(x, y, width, height, coding, img_data, rowstride, options, callbacks)

    def after_draw_refresh(self, success, message="") -> None:
        backing = self._backing
        paintlog(f"after_draw_refresh({success}, {message!r}) pending_refresh={self.pending_refresh}, {backing=}")
        if not backing:
            return
        if backing.repaint_all or self._xscale != 1 or self._yscale != 1 or is_Wayland():
            # easy: just repaint the whole window:
            rw, rh = self.get_size()
            GLib.idle_add(self.repaint, 0, 0, rw, rh)
            return
        pr = self.pending_refresh
        self.pending_refresh = []
        for x, y, w, h in pr:
            rx, ry, rw, rh = self._client.srect(x, y, w, h)
            if self.window_offset:
                rx += self.window_offset[0]
                ry += self.window_offset[1]
            GLib.idle_add(self.repaint, rx, ry, rw, rh)

    def eos(self) -> None:
        """ Note: this runs from the draw thread (not UI thread) """
        backing = self._backing
        if backing:
            backing.eos()

    def set_alert_state(self, alert_state: bool) -> None:
        can = self.can_have_alert()
        backing = self._backing
        log("set_alert_state(%s) can_have_alert=%s, backing=%s", alert_state, can, backing)
        if not can or not backing:
            return
        backing.alert_state = alert_state

    def can_have_alert(self) -> bool:
        if self._backing is None:
            return False
        window_types = self._metadata.strtupleget("window-type")
        return bool(set(window_types) & SHOW_SPINNER_WINDOW_TYPES)

    def redraw(self):
        # queue a repaint request
        w, h = self.get_size()
        self.repaint(0, 0, w, h)

    def _unfocus(self) -> bool:
        # overriden in FocusWindow
        return self._client.update_focus(self.wid, False)

    @staticmethod
    def log(message="") -> None:
        log.info(message)
