mirror of
https://github.com/kovidgoyal/kitty.git
synced 2026-07-10 17:53:23 +00:00
128 lines
4.4 KiB
Python
128 lines
4.4 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 SetBackgroundImageRCOptions as CLIOptions
|
|
|
|
|
|
class SetBackgroundImage(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.
|
|
match: Window to change opacity in
|
|
layout: The image layout
|
|
all: Boolean indicating operate on all windows
|
|
configured: Boolean indicating if the configured value should be changed
|
|
'''
|
|
|
|
short_desc = 'Set the background image'
|
|
desc = (
|
|
'Set the background image for the specified OS windows. You must specify the path to a PNG image that'
|
|
' will be used as the background. If you specify the special value :code:`none` then any existing image will'
|
|
' be removed.'
|
|
)
|
|
options_spec = '''\
|
|
--all -a
|
|
type=bool-set
|
|
By default, background image is only changed for the currently active OS window. This option will
|
|
cause the image to be changed in all windows.
|
|
|
|
|
|
--configured -c
|
|
type=bool-set
|
|
Change the configured background image which is used for new OS windows.
|
|
|
|
|
|
--layout
|
|
type=choices
|
|
choices=tiled,scaled,mirror-tiled,clamped,configured
|
|
How the image should be displayed. A value of :code:`configured` will use the configured value.
|
|
|
|
|
|
--no-response
|
|
type=bool-set
|
|
default=false
|
|
Don't wait for a response from kitty. This means that even if setting the background image
|
|
failed, the command will exit with a success code.
|
|
''' + '\n\n' + MATCH_WINDOW_OPTION
|
|
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,
|
|
'configured': opts.configured,
|
|
'layout': opts.layout,
|
|
'all': opts.all,
|
|
}
|
|
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()
|
|
|
|
windows = self.windows_for_payload(boss, window, payload_get)
|
|
os_windows = tuple({w.os_window_id for w in windows if w})
|
|
layout = payload_get('layout')
|
|
if data == '-':
|
|
path = None
|
|
else:
|
|
f = self.images_in_flight.pop(img_id)
|
|
path = f.name
|
|
f.flush()
|
|
|
|
try:
|
|
boss.set_background_image(path, os_windows, payload_get('configured'), layout)
|
|
except ValueError as err:
|
|
err.hide_traceback = True # type: ignore
|
|
raise
|
|
return None
|
|
|
|
def cancel_async_request(self, boss: 'Boss', window: Optional['Window'], payload_get: PayloadGetType) -> None:
|
|
async_id = payload_get('async_id')
|
|
self.images_in_flight.pop(async_id, None)
|
|
|
|
|
|
set_background_image = SetBackgroundImage()
|