Remote control command to set window logo

kitty/rc/set_window_logo.py

@@ -0,0 +1,124 @@
+#!/usr/bin/env python
+# License: GPLv3 Copyright: 2020, Kovid Goyal <kovid at kovidgoyal.net>
+
+
+import imghdr
+import tempfile
+from base64 import standard_b64decode, standard_b64encode
+from typing import IO, TYPE_CHECKING, Optional
+from uuid import uuid4
+
+from .base import (
+    MATCH_WINDOW_OPTION, ArgsType, Boss, CmdGenerator, PayloadGetType,
+    PayloadType, RCOptions, RemoteCommand, ResponseType, Window
+)
+
+if TYPE_CHECKING:
+    from kitty.cli_stub import SetWindowLogoRCOptions as CLIOptions
+
+
+class SetWindowLogo(RemoteCommand):
+    '''
+    data+: Chunk of at most 512 bytes of PNG data, base64 encoded. Must send an empty chunk to indicate end of image. \
+    Or the special value - to indicate image must be removed.
+    img_id+: Unique uuid (as string) used for chunking
+    position: The logo position as a string, empty string means default
+    alpha: The logo alpha between 0 and 1. -1 means use default
+    match: Which window to change the logo in
+    self: Boolean indicating whether to act on the window the command is run in
+    '''
+
+    short_desc = 'Set the window logo'
+    desc = (
+        'Set the logo image for the specified windows. You must specify the path to a PNG image that'
+        ' will be used as the logo. If you specify the special value "none" then any existing logo will'
+        ' be removed.'
+    )
+
+    options_spec = MATCH_WINDOW_OPTION + '''\n
+--self
+type=bool-set
+If specified act on the window this command is run in, rather than the active window.
+
+
+--position
+The position for the window logo. See :opt:`window_logo_position`.
+
+
+--alpha
+type=float
+default=-1
+The amount the window logo should be faded into the background.
+See :opt:`window_logo_position`.
+
+
+--no-response
+type=bool-set
+default=false
+Don't wait for a response from kitty. This means that even if setting the image
+failed, the command will exit with a success code.
+'''
+    argspec = 'PATH_TO_PNG_IMAGE'
+    args_count = 1
+    args_completion = {'files': ('PNG Images', ('*.png',))}
+    current_img_id: Optional[str] = None
+    current_file_obj: Optional[IO[bytes]] = None
+
+    def message_to_kitty(self, global_opts: RCOptions, opts: 'CLIOptions', args: ArgsType) -> PayloadType:
+        if len(args) != 1:
+            self.fatal('Must specify path to exactly one PNG image')
+        path = args[0]
+        ret = {
+            'match': opts.match,
+            'self': opts.self,
+            'img_id': str(uuid4()),
+            'alpha': opts.alpha,
+            'position': opts.position,
+        }
+        if path.lower() == 'none':
+            ret['data'] = '-'
+            return ret
+        if imghdr.what(path) != 'png':
+            self.fatal(f'{path} is not a PNG image')
+
+        def file_pipe(path: str) -> CmdGenerator:
+            with open(path, 'rb') as f:
+                while True:
+                    data = f.read(512)
+                    if not data:
+                        break
+                    ret['data'] = standard_b64encode(data).decode('ascii')
+                    yield ret
+            ret['data'] = ''
+            yield ret
+        return file_pipe(path)
+
+    def response_from_kitty(self, boss: Boss, window: Optional[Window], payload_get: PayloadGetType) -> ResponseType:
+        data = payload_get('data')
+        if data != '-':
+            img_id = payload_get('img_id')
+            if img_id != self.current_img_id:
+                self.current_img_id = img_id
+                self.current_file_obj = tempfile.NamedTemporaryFile(suffix='.png')
+            if data:
+                assert self.current_file_obj is not None
+                self.current_file_obj.write(standard_b64decode(data))
+                return None
+
+        if data == '-':
+            path = ''
+        else:
+            assert self.current_file_obj is not None
+            f = self.current_file_obj
+            path = f.name
+            self.current_file_obj = None
+            f.flush()
+
+        alpha = float(payload_get('alpha', '-1'))
+        position = payload_get('position') or ''
+        for window in self.windows_for_match_payload(boss, window, payload_get):
+            window.set_logo(path, position, alpha)
+        return None
+
+
+set_window_logo = SetWindowLogo()

kitty/window.py

@@ -1090,10 +1090,10 @@ class Window:
             'text': text
         }
 
-    def set_logo(self, path: str, position: str = 'bottom-right', alpha: float = 0.5) -> None:
+    def set_logo(self, path: str, position: str = '', alpha: float = -1) -> None:
         from .options.utils import config_or_absolute_path
         path = config_or_absolute_path(path, get_options().env) or path
-        set_window_logo(self.os_window_id, self.tab_id, self.id, path, position, alpha)
+        set_window_logo(self.os_window_id, self.tab_id, self.id, path, position or '', alpha)
 
     # actions {{{