122 lines
4.0 KiB
Python
122 lines
4.0 KiB
Python
#!/usr/bin/env python
|
|
# License: GPLv3 Copyright: 2020, Kovid Goyal <kovid at kovidgoyal.net>
|
|
|
|
|
|
import imghdr
|
|
import os
|
|
import tempfile
|
|
from base64 import standard_b64decode, standard_b64encode
|
|
from typing import IO, TYPE_CHECKING, Dict, Optional
|
|
|
|
from kitty.types import AsyncResponse
|
|
|
|
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 :code:`-` to indicate image must be removed.
|
|
position: The logo position as a string, empty string means default
|
|
alpha: The logo alpha between :code:`0` and :code:`1`. :code:`-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 :code:`none` then any existing logo will'
|
|
' be removed.'
|
|
)
|
|
|
|
options_spec = MATCH_WINDOW_OPTION + '''\n
|
|
--self
|
|
type=bool-set
|
|
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',))}
|
|
images_in_flight: Dict[str, IO[bytes]] = {}
|
|
is_asynchronous = True
|
|
|
|
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 = os.path.expanduser(args[0])
|
|
ret = {
|
|
'match': opts.match,
|
|
'self': opts.self,
|
|
'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')
|
|
img_id = payload_get('async_id')
|
|
if data != '-':
|
|
if img_id not in self.images_in_flight:
|
|
self.images_in_flight[img_id] = tempfile.NamedTemporaryFile(suffix='.png')
|
|
if data:
|
|
self.images_in_flight[img_id].write(standard_b64decode(data))
|
|
return AsyncResponse()
|
|
|
|
if data == '-':
|
|
path = ''
|
|
else:
|
|
f = self.images_in_flight.pop(img_id)
|
|
path = f.name
|
|
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):
|
|
if window:
|
|
window.set_logo(path, position, alpha)
|
|
return None
|
|
|
|
|
|
set_window_logo = SetWindowLogo()
|