github/kovidgoyal-kitty
1
0
Fork 0
mirror of https://github.com/kovidgoyal/kitty.git synced 2026-07-03 11:12:30 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
d52f2e798164c2f2800eb28d227bead4f1b913a4
kovidgoyal-kitty/kitty/boss.py
Kovid Goyal d52f2e7981 Rewrite rendering pipeline 
This was needed to fix various corner cases when doing blending of colors
in linear space. The new architecture has the same performance as the
old in the common case of opaque rendering with no UI layers or images.

In the case of only positive z-index images there is a performance
decrease as the OS Window is now rendered to a offscreen texture and
then blitted to screen. However, in the future when we move to Vulkan or
I can figure out how to get Wayland to accept buffers with colors in
linear space, this performance penalty can be removed. The performance
penalty was not significant on my system but this is highly GPU
dependent. Modern GPUs are supposedly optimised for rendering to
offscreen buffers, so we will see. The awrit project might be a good
test case.

Now either we have 1-shot rendering for the case of opaque with only ext
or all the various pieces are rendered in successive draw calls into an
offscreen buffer that is blitted to the output buffer after all drawing
is done.

Fixes #8869
2025-08-11 00:47:02 +05:30

3225 lines
136 KiB
Python
Raw Blame History

#!/usr/bin/env python
# License: GPL v3 Copyright: 2016, Kovid Goyal <kovid at kovidgoyal.net>
# Imports {{{
import base64
import json
import os
import re
import socket
import subprocess
import sys
from collections.abc import Callable, Container, Generator, Iterable, Iterator, Sequence
from contextlib import contextmanager, suppress
from functools import partial
from gettext import gettext as _
from gettext import ngettext
from time import sleep
from typing import (
TYPE_CHECKING,
Any,
Literal,
Optional,
Union,
)
from weakref import WeakValueDictionary
from .child import cached_process_data, default_env, set_default_env
from .cli import create_opts, green, parse_args
from .cli_stub import CLIOptions
from .clipboard import (
Clipboard,
ClipboardType,
get_clipboard_string,
get_primary_selection,
set_clipboard_string,
set_primary_selection,
)
from .colors import ColorSchemes, theme_colors
from .conf.utils import BadLine, KeyAction, to_cmdline
from .config import common_opts_as_dict, prepare_config_file_for_editing, store_effective_config
from .constants import (
RC_ENCRYPTION_PROTOCOL_VERSION,
appname,
cache_dir,
clear_handled_signals,
config_dir,
handled_signals,
is_macos,
is_wayland,
kitten_exe,
kitty_exe,
logo_png_file,
supports_primary_selection,
website_url,
)
from .fast_data_types import (
CLOSE_BEING_CONFIRMED,
GLFW_FKEY_ESCAPE,
GLFW_MOD_ALT,
GLFW_MOD_CONTROL,
GLFW_MOD_SHIFT,
GLFW_MOD_SUPER,
GLFW_MOUSE_BUTTON_LEFT,
GLFW_PRESS,
IMPERATIVE_CLOSE_REQUESTED,
NO_CLOSE_REQUESTED,
ChildMonitor,
Color,
EllipticCurveKey,
KeyEvent,
SingleKey,
add_timer,
apply_options_update,
background_opacity_of,
change_background_opacity,
cocoa_hide_app,
cocoa_hide_other_apps,
cocoa_minimize_os_window,
cocoa_set_menubar_title,
create_os_window,
current_application_quit_request,
current_focused_os_window_id,
current_os_window,
destroy_global_data,
focus_os_window,
get_boss,
get_options,
get_os_window_size,
glfw_get_monitor_workarea,
global_font_size,
grab_keyboard,
is_layer_shell_supported,
last_focused_os_window_id,
mark_os_window_for_close,
monitor_pid,
monotonic,
os_window_focus_counters,
os_window_font_size,
redirect_mouse_handling,
ring_bell,
run_with_activation_token,
safe_pipe,
send_data_to_peer,
set_application_quit_request,
set_background_image,
set_boss,
set_options,
set_os_window_chrome,
set_os_window_size,
set_os_window_title,
thread_write,
toggle_fullscreen,
toggle_maximized,
toggle_os_window_visibility,
toggle_secure_input,
wrapped_kitten_names,
)
from .key_encoding import get_name_to_functional_number_map
from .keys import Mappings
from .layout.base import set_layout_options
from .notifications import NotificationManager
from .options.types import Options, nullable_colors
from .options.utils import MINIMUM_FONT_SIZE, KeyboardMode, KeyDefinition
from .os_window_size import initial_window_size_func
from .session import Session, create_sessions, get_os_window_sizing_data
from .shaders import load_shader_programs
from .simple_cli_definitions import grab_keyboard_docs
from .tabs import SpecialWindow, SpecialWindowInstance, Tab, TabDict, TabManager
from .types import _T, AsyncResponse, LayerShellConfig, SingleInstanceData, WindowSystemMouseEvent, ac
from .typing_compat import PopenType, TypedDict
from .utils import (
cleanup_ssh_control_masters,
func_name,
get_editor,
get_new_os_window_size,
is_ok_to_read_image_file,
is_path_in_temp_dir,
less_version,
log_error,
macos_version,
open_url,
parse_address_spec,
parse_os_window_state,
parse_uri_list,
platform_window_id,
safe_print,
sanitize_url_for_display_to_user,
shlex_split,
startup_notification_handler,
timed_debug_print,
which,
)
from .window import CommandOutput, CwdRequest, Window
if TYPE_CHECKING:
from .fast_data_types import OSWindowSize
from .rc.base import ResponseType
# }}}
RCResponse = Union[dict[str, Any], None, AsyncResponse]
class OSWindowDict(TypedDict):
id: int
platform_window_id: int | None
is_focused: bool
is_active: bool
last_focused: bool
tabs: list[TabDict]
wm_class: str
wm_name: str
background_opacity: float
class Atexit:
def __init__(self) -> None:
self.worker: subprocess.Popen[bytes] | None = None
def _write_line(self, line: str) -> None:
if '\n' in line:
raise ValueError('Newlines not allowed in atexit arguments: {path!r}')
w = self.worker
if w is None:
w = self.worker = subprocess.Popen([kitten_exe(), '__atexit__'], stdin=subprocess.PIPE, stdout=subprocess.DEVNULL, close_fds=True)
assert w.stdin is not None
os.set_inheritable(w.stdin.fileno(), False)
assert w.stdin is not None
w.stdin.write((line + '\n').encode())
w.stdin.flush()
def unlink(self, path: str) -> None:
self._write_line(f'unlink {path}')
def shm_unlink(self, path: str) -> None:
self._write_line(f'shm_unlink {path}')
def rmtree(self, path: str) -> None:
self._write_line(f'rmtree {path}')
def listen_on(spec: str, robust_atexit: Atexit) -> tuple[int, str]:
import socket
family, address, socket_path = parse_address_spec(spec)
s = socket.socket(family)
s.bind(address)
if family == socket.AF_UNIX and socket_path:
robust_atexit.unlink(socket_path)
s.listen()
if isinstance(address, tuple): # tcp socket
h, resolved_port = s.getsockname()[:2]
spec = spec.rpartition(':')[0] + f':{resolved_port}'
import atexit
atexit.register(s.close) # prevents s from being garbage collected
return s.fileno(), spec
def data_for_at(w: Window | None, arg: str, add_wrap_markers: bool = False) -> str | None:
if not w:
return None
def as_text(**kw: bool) -> str:
kw['add_wrap_markers'] = add_wrap_markers
return w.as_text(**kw) if w else ''
if arg == '@selection':
return w.text_for_selection()
if arg in ('@ansi', '@ansi_screen_scrollback'):
return as_text(as_ansi=True, add_history=True)
if arg in ('@text', '@screen_scrollback'):
return as_text(add_history=True)
if arg == '@screen':
return as_text()
if arg == '@ansi_screen':
return as_text(as_ansi=True)
if arg == '@alternate':
return as_text(alternate_screen=True)
if arg == '@alternate_scrollback':
return as_text(alternate_screen=True, add_history=True)
if arg == '@ansi_alternate':
return as_text(as_ansi=True, alternate_screen=True)
if arg == '@ansi_alternate_scrollback':
return as_text(as_ansi=True, alternate_screen=True, add_history=True)
if arg == '@first_cmd_output_on_screen':
return w.cmd_output(CommandOutput.first_on_screen, add_wrap_markers=add_wrap_markers)
if arg == '@ansi_first_cmd_output_on_screen':
return w.cmd_output(CommandOutput.first_on_screen, as_ansi=True, add_wrap_markers=add_wrap_markers)
if arg == '@last_cmd_output':
return w.cmd_output(CommandOutput.last_run, add_wrap_markers=add_wrap_markers)
if arg == '@ansi_last_cmd_output':
return w.cmd_output(CommandOutput.last_run, as_ansi=True, add_wrap_markers=add_wrap_markers)
if arg == '@last_visited_cmd_output':
return w.cmd_output(CommandOutput.last_visited, add_wrap_markers=add_wrap_markers)
if arg == '@ansi_last_visited_cmd_output':
return w.cmd_output(CommandOutput.last_visited, as_ansi=True, add_wrap_markers=add_wrap_markers)
return None
class DumpCommands: # {{{
def __init__(self, args: CLIOptions):
self.draw_dump_buf: list[str] = []
if args.dump_bytes:
self.dump_bytes_to = open(args.dump_bytes, 'wb')
def __call__(self, window_id: int, what: str, *a: Any) -> None:
if what == 'draw':
self.draw_dump_buf.append(a[0])
elif what == 'bytes':
self.dump_bytes_to.write(a[0])
self.dump_bytes_to.flush()
elif what == 'error':
log_error(*a)
else:
if self.draw_dump_buf:
safe_print('draw', ''.join(self.draw_dump_buf))
self.draw_dump_buf = []
def fmt(x: Any) -> Any:
if isinstance(x, (bytes, memoryview)):
return str(x, 'utf-8', 'replace')
if isinstance(x, dict):
return json.dumps(x)
return x
safe_print(what, *map(fmt, a), flush=True)
# }}}
class VisualSelect:
def __init__(
self,
tab_id: int,
os_window_id: int,
prev_tab_id: int | None,
prev_os_window_id: int | None,
title: str,
callback: Callable[[Tab | None, Window | None], None],
reactivate_prev_tab: bool
) -> None:
self.tab_id = tab_id
self.os_window_id = os_window_id
self.prev_tab_id = prev_tab_id
self.prev_os_window_id = prev_os_window_id
self.callback = callback
self.window_ids: list[int] = []
self.window_used_for_selection_id = 0
self.reactivate_prev_tab = reactivate_prev_tab
set_os_window_title(self.os_window_id, title)
def cancel(self) -> None:
self.clear_global_state()
self.activate_prev_tab()
self.callback(None, None)
def trigger(self, window_id: int) -> None:
boss = self.clear_global_state()
self.activate_prev_tab()
w = boss.window_id_map.get(window_id)
if w is None:
self.callback(None, None)
else:
tab = w.tabref()
if tab is None:
self.callback(None, None)
else:
self.callback(tab, w)
def clear_global_state(self) -> 'Boss':
set_os_window_title(self.os_window_id, '')
boss = get_boss()
redirect_mouse_handling(False)
for wid in self.window_ids:
w = boss.window_id_map.get(wid)
if w is not None:
w.screen.set_window_char()
if self.window_used_for_selection_id:
w = boss.window_id_map.get(self.window_used_for_selection_id)
if w is not None:
boss.mark_window_for_close(w)
return boss
def activate_prev_tab(self) -> None:
if not self.reactivate_prev_tab or self.prev_tab_id is None:
return None
boss = get_boss()
tm = boss.os_window_map.get(self.os_window_id)
if tm is not None:
t = tm.tab_for_id(self.prev_tab_id)
if t is not tm.active_tab and t is not None:
tm.set_active_tab(t)
if current_focused_os_window_id() != self.prev_os_window_id and self.prev_os_window_id is not None:
focus_os_window(self.prev_os_window_id, True)
class Boss:
def __init__(
self,
opts: Options,
args: CLIOptions,
cached_values: dict[str, Any],
global_shortcuts: dict[str, SingleKey],
talk_fd: int = -1,
):
self.atexit = Atexit()
set_layout_options(opts)
self.clipboard = Clipboard()
self.window_for_dispatch: Window | None = None
self.primary_selection = Clipboard(ClipboardType.primary_selection)
self.update_check_started = False
self.peer_data_map: dict[int, dict[str, Sequence[str]] | None] = {}
self.background_process_death_notify_map: dict[int, Callable[[int, Exception | None], None]] = {}
self.encryption_key = EllipticCurveKey()
self.encryption_public_key = f'{RC_ENCRYPTION_PROTOCOL_VERSION}:{base64.b85encode(self.encryption_key.public).decode("ascii")}'
self.clipboard_buffers: dict[str, str] = {}
self.update_check_process: Optional['PopenType[bytes]'] = None
self.window_id_map: WeakValueDictionary[int, Window] = WeakValueDictionary()
self.color_settings_at_startup: dict[str, Color | None] = {
k: opts[k] for k in opts if isinstance(opts[k], Color) or k in nullable_colors}
self.current_visual_select: VisualSelect | None = None
# A list of events received so far that are potentially part of a sequence keybinding.
self.cached_values = cached_values
self.os_window_map: dict[int, TabManager] = {}
self.os_window_death_actions: dict[int, Callable[[], None]] = {}
self.cursor_blinking = True
self.shutting_down = False
self.misc_config_errors: list[str] = []
# we dont allow reloading the config file to change
# allow_remote_control
self.allow_remote_control = opts.allow_remote_control
if self.allow_remote_control in ('y', 'yes', 'true'):
self.allow_remote_control = 'y'
elif self.allow_remote_control in ('n', 'no', 'false'):
self.allow_remote_control = 'n'
self.listening_on: str = ''
listen_fd = -1
if args.listen_on and self.allow_remote_control in ('y', 'socket', 'socket-only', 'password'):
try:
listen_fd, self.listening_on = listen_on(args.listen_on, self.atexit)
except Exception:
self.misc_config_errors.append(f'Invalid listen_on={args.listen_on}, ignoring')
log_error(self.misc_config_errors[-1])
self.child_monitor: ChildMonitor = ChildMonitor(
self.on_child_death,
DumpCommands(args) if args.dump_commands or args.dump_bytes else None,
talk_fd, listen_fd, self.listening_on.startswith('unix:')
)
self.args: CLIOptions = args
self.mouse_handler: Callable[[WindowSystemMouseEvent], None] | None = None
set_boss(self)
self.mappings: Mappings = Mappings(global_shortcuts, self.refresh_active_tab_bar)
self.notification_manager: NotificationManager = NotificationManager(debug=self.args.debug_keyboard or self.args.debug_rendering)
self.atexit.unlink(store_effective_config())
def startup_first_child(self, os_window_id: int | None, startup_sessions: Iterable[Session] = ()) -> None:
si = startup_sessions or create_sessions(get_options(), self.args, default_session=get_options().startup_session)
focused_os_window = wid = 0
token = os.environ.pop('XDG_ACTIVATION_TOKEN', '')
with Window.set_ignore_focus_changes_for_new_windows():
for startup_session in si:
# The window state from the CLI options will override and apply to every single OS window in startup session
wstate = self.args.start_as if self.args.start_as and self.args.start_as != 'normal' else None
wid = self.add_os_window(startup_session, window_state=wstate, os_window_id=os_window_id)
if startup_session.focus_os_window:
focused_os_window = wid
os_window_id = None
if focused_os_window > 0:
focus_os_window(focused_os_window, True, token)
elif token and is_wayland() and wid:
focus_os_window(wid, True, token)
for w in self.all_windows:
w.ignore_focus_changes = False
def add_os_window(
self,
startup_session: Session | None = None,
os_window_id: int | None = None,
wclass: str | None = None,
wname: str | None = None,
window_state: str | None = None,
opts_for_size: Options | None = None,
startup_id: str | None = None,
override_title: str | None = None,
) -> int:
if os_window_id is None:
size_data = get_os_window_sizing_data(opts_for_size or get_options(), startup_session)
wclass = wclass or getattr(startup_session, 'os_window_class', None) or self.args.cls or appname
wname = wname or getattr(startup_session, 'os_window_name', None) or self.args.name or wclass
wtitle = override_title or self.args.title
window_state = window_state or getattr(startup_session, 'os_window_state', None)
wstate = parse_os_window_state(window_state) if window_state is not None else None
with startup_notification_handler(do_notify=startup_id is not None, startup_id=startup_id) as pre_show_callback:
os_window_id = create_os_window(
initial_window_size_func(size_data, self.cached_values),
pre_show_callback,
wtitle or appname, wname, wclass, wstate, disallow_override_title=bool(wtitle))
else:
wname = self.args.name or self.args.cls or appname
wclass = self.args.cls or appname
tm = TabManager(os_window_id, self.args, wclass, wname, startup_session)
self.os_window_map[os_window_id] = tm
return os_window_id
def add_os_panel(self, cfg: LayerShellConfig, wclass: str | None = appname, wname: str | None = appname) -> int:
if not is_layer_shell_supported():
raise RuntimeError('Creating desktop panels is not supported on this platform')
wclass = wclass or appname
wname = wname or appname
size_data = get_os_window_sizing_data(get_options(), None)
os_window_id = create_os_window(
initial_window_size_func(size_data, {}), lambda *a: None, appname, wname, wclass, None, layer_shell_config=cfg)
tm = TabManager(os_window_id, self.args, wclass, wname, None)
self.os_window_map[os_window_id] = tm
return os_window_id
def list_os_windows(
self, self_window: Window | None = None,
tab_filter: Callable[[Tab], bool] | None = None,
window_filter: Callable[[Window], bool] | None = None
) -> Iterator[OSWindowDict]:
with cached_process_data():
active_tab_manager = self.active_tab_manager
focused_wid = current_focused_os_window_id()
last_focused = last_focused_os_window_id()
for os_window_id, tm in self.os_window_map.items():
tabs = list(tm.list_tabs(self_window, tab_filter, window_filter))
if tabs:
bo = background_opacity_of(os_window_id)
if bo is None:
bo = 1
yield {
'id': os_window_id,
'platform_window_id': platform_window_id(os_window_id),
'is_active': tm is active_tab_manager,
'is_focused': focused_wid == os_window_id,
'last_focused': os_window_id == last_focused,
'tabs': tabs,
'wm_class': tm.wm_class,
'wm_name': tm.wm_name,
'background_opacity': bo,
}
@property
def all_tab_managers(self) -> Iterator[TabManager]:
yield from self.os_window_map.values()
@property
def all_tabs(self) -> Iterator[Tab]:
for tm in self.all_tab_managers:
yield from tm
@property
def all_windows(self) -> Iterator[Window]:
for tab in self.all_tabs:
yield from tab
def match_windows(self, match: str, self_window: Optional['Window'] = None) -> Iterator[Window]:
if match == 'all':
yield from self.all_windows
return
from .search_query_parser import search
tab = self.active_tab
if current_focused_os_window_id() <= 0:
tm = self.os_window_map.get(last_focused_os_window_id())
if tm is not None:
tab = tm.active_tab
window_id_limit = max(self.window_id_map, default=-1) + 1
def get_matches(location: str, query: str, candidates: set[int]) -> set[int]:
if location == 'id' and query.startswith('-'):
try:
q = int(query)
except Exception:
return set()
if q < 0:
query = str(window_id_limit + q)
return {wid for wid in candidates if self.window_id_map[wid].matches_query(location, query, tab, self_window)}
for wid in search(match, (
'id', 'title', 'pid', 'cwd', 'cmdline', 'num', 'env', 'var', 'recent', 'state', 'neighbor',
), set(self.window_id_map), get_matches):
yield self.window_id_map[wid]
def tab_for_window(self, window: Window) -> Tab | None:
for tab in self.all_tabs:
for w in tab:
if w.id == window.id:
return tab
return None
def match_tabs(self, match: str) -> Iterator[Tab]:
if match == 'all':
yield from self.all_tabs
return
from .search_query_parser import search
tm = self.active_tab_manager
if current_focused_os_window_id() <= 0:
tm = self.os_window_map.get(last_focused_os_window_id()) or tm
tim = {t.id: t for t in self.all_tabs}
tab_id_limit = max(tim, default=-1) + 1
window_id_limit = max(self.window_id_map, default=-1) + 1
def get_matches(location: str, query: str, candidates: set[int]) -> set[int]:
if location in ('id', 'window_id') and query.startswith('-'):
try:
q = int(query)
except Exception:
return set()
if q < 0:
limit = tab_id_limit if location == 'id' else window_id_limit
query = str(limit + q)
return {wid for wid in candidates if tim[wid].matches_query(location, query, tm)}
found = False
for tid in search(match, (
'id', 'index', 'title', 'window_id', 'window_title', 'pid', 'cwd', 'env', 'var', 'cmdline', 'recent', 'state'
), set(tim), get_matches):
found = True
yield tim[tid]
if not found:
tabs = {self.tab_for_window(w) for w in self.match_windows(match)}
for q in tabs:
if q:
yield q
def set_active_window(
self, window: Window, switch_os_window_if_needed: bool = False, for_keep_focus: bool = False, activation_token: str = ''
) -> int | None:
for os_window_id, tm in self.os_window_map.items():
for tab in tm:
for w in tab:
if w.id == window.id:
if tab is not self.active_tab:
tm.set_active_tab(tab, for_keep_focus=window.tabref() if for_keep_focus else None)
tab.set_active_window(w, for_keep_focus=window if for_keep_focus else None)
if activation_token or (switch_os_window_if_needed and current_focused_os_window_id() != os_window_id):
focus_os_window(os_window_id, True, activation_token)
return os_window_id
return None
def _new_os_window(self, args: SpecialWindowInstance | Iterable[str], cwd_from: CwdRequest | None = None) -> int:
if isinstance(args, SpecialWindowInstance):
sw: SpecialWindowInstance | None = args
else:
sw = self.args_to_special_window(args, cwd_from) if args else None
startup_session = next(create_sessions(get_options(), special_window=sw, cwd_from=cwd_from))
return self.add_os_window(startup_session)
@ac('win', 'New OS Window')
def new_os_window(self, *args: str) -> None:
self._new_os_window(args)
@property
def active_window_for_cwd(self) -> Window | None:
t = self.active_tab
if t is not None:
return t.active_window_for_cwd
return None
@ac('win', 'New OS Window with the same working directory as the currently active window')
def new_os_window_with_cwd(self, *args: str) -> None:
w = self.window_for_dispatch or self.active_window_for_cwd
self._new_os_window(args, CwdRequest(w))
def new_os_window_with_wd(self, wd: str | list[str], str_is_multiple_paths: bool = False) -> None:
if isinstance(wd, str):
wd = wd.split(os.pathsep) if str_is_multiple_paths else [wd]
for path in wd:
special_window = SpecialWindow(None, cwd=path)
self._new_os_window(special_window)
def add_child(self, window: Window) -> None:
assert window.child.pid is not None and window.child.child_fd is not None
self.child_monitor.add_child(window.id, window.child.pid, window.child.child_fd, window.screen)
self.window_id_map[window.id] = window
def _handle_remote_command(self, cmd: memoryview, window: Window | None = None, peer_id: int = 0) -> RCResponse:
from .remote_control import is_cmd_allowed, parse_cmd, remote_control_allowed
response = None
window = window or None
from_socket = peer_id > 0
is_fd_peer = from_socket and peer_id in self.peer_data_map
window_has_remote_control = bool(window and window.allow_remote_control)
if not window_has_remote_control and not is_fd_peer:
if self.allow_remote_control == 'n':
return {'ok': False, 'error': 'Remote control is disabled'}
if self.allow_remote_control == 'socket-only' and not from_socket:
return {'ok': False, 'error': 'Remote control is allowed over a socket only'}
try:
pcmd = parse_cmd(cmd, self.encryption_key)
except Exception as e:
log_error(f'Failed to parse remote command with error: {e}')
return response
if not pcmd:
return response
self_window: Window | None = None
if window is not None:
self_window = window
else:
try:
swid = int(pcmd.get('kitty_window_id', 0))
except Exception:
pass
else:
if swid > 0:
self_window = self.window_id_map.get(swid)
extra_data: dict[str, Any] = {}
try:
allowed_unconditionally = (
self.allow_remote_control == 'y' or
(from_socket and not is_fd_peer and self.allow_remote_control in ('socket-only', 'socket')) or
(window and window.remote_control_allowed(pcmd, extra_data)) or
(is_fd_peer and remote_control_allowed(pcmd, self.peer_data_map.get(peer_id), None, extra_data))
)
except PermissionError:
return {'ok': False, 'error': 'Remote control disallowed by window specific password'}
if allowed_unconditionally:
return self._execute_remote_command(pcmd, window, peer_id, self_window)
q = is_cmd_allowed(pcmd, window, from_socket, extra_data)
if q is True:
return self._execute_remote_command(pcmd, window, peer_id, self_window)
if q is None:
if self.ask_if_remote_cmd_is_allowed(pcmd, window, peer_id, self_window):
return AsyncResponse()
response = {'ok': False, 'error': 'Remote control is disabled. Add allow_remote_control to your kitty.conf'}
if q is False and pcmd.get('password'):
response['error'] = 'The user rejected this password or it is disallowed by remote_control_password in kitty.conf'
no_response = pcmd.get('no_response') or False
if no_response:
return None
return response
def ask_if_remote_cmd_is_allowed(
self, pcmd: dict[str, Any], window: Window | None = None, peer_id: int = 0, self_window: Window | None = None
) -> bool:
from kittens.tui.operations import styled
in_flight = 0
for w in self.window_id_map.values():
if w.window_custom_type == 'remote_command_permission_dialog':
in_flight += 1
if in_flight > 4:
log_error('Denying remote command permission as there are too many existing permission requests')
return False
wid = 0 if window is None else window.id
hidden_text = styled(pcmd['password'], fg='yellow')
overlay_window = self.choose(
_('A program wishes to control kitty.\n'
'Action: {1}\n' 'Password: {0}\n\n' '{2}'
).format(
hidden_text, styled(pcmd['cmd'], fg='magenta'),
'\x1b[m' + styled(_(
'Note that allowing the password will allow all future actions using the same password, in this kitty instance.'
), dim=True, italic=True)),
partial(self.remote_cmd_permission_received, pcmd, wid, peer_id, self_window),
'a;green:Allow request', 'p;yellow:Allow password', 'r;magenta:Deny request', 'd;red:Deny password',
window=window, default='a', hidden_text=hidden_text, title=_('Allow remote control?'),
)
if overlay_window is None:
return False
overlay_window.window_custom_type = 'remote_command_permission_dialog'
return True
def remote_cmd_permission_received(self, pcmd: dict[str, Any], window_id: int, peer_id: int, self_window: Window | None, choice: str) -> None:
from .remote_control import encode_response_for_peer, set_user_password_allowed
response: RCResponse = None
window = self.window_id_map.get(window_id)
choice = choice or 'r'
if choice in ('r', 'd'):
if choice == 'd':
set_user_password_allowed(pcmd['password'], False)
no_response = pcmd.get('no_response') or False
if not no_response:
response = {'ok': False, 'error': 'The user rejected this ' + ('request' if choice == 'r' else 'password')}
elif choice in ('a', 'p'):
if choice == 'p':
set_user_password_allowed(pcmd['password'], True)
response = self._execute_remote_command(pcmd, window, peer_id, self_window)
if window is not None and response is not None and not isinstance(response, AsyncResponse):
window.send_cmd_response(response)
if peer_id > 0:
if response is None:
send_data_to_peer(peer_id, b'')
elif not isinstance(response, AsyncResponse):
send_data_to_peer(peer_id, encode_response_for_peer(response))
def _execute_remote_command(
self, pcmd: dict[str, Any], window: Window | None = None, peer_id: int = 0, self_window: Window | None = None
) -> RCResponse:
from .remote_control import handle_cmd
try:
response = handle_cmd(self, window, pcmd, peer_id, self_window)
except Exception as err:
import traceback
response = {'ok': False, 'error': str(err)}
if not getattr(err, 'hide_traceback', False):
response['tb'] = traceback.format_exc()
return response
@ac('misc', '''
Run a remote control command without needing to allow remote control
For example::
map f1 remote_control set-spacing margin=30
See :ref:`rc_mapping` for details.
''')
def remote_control(self, *args: str) -> None:
try:
self.call_remote_control(self.window_for_dispatch or self.active_window, args)
except (Exception, SystemExit) as e:
import shlex
self.show_error(_('remote_control mapping failed'), shlex.join(args) + '\n' + str(e))
@ac('misc', '''
Run a remote control script without needing to allow remote control
For example::
map f1 remote_control_script /path/to/script arg1 arg2 ...
See :ref:`rc_mapping` for details.
''')
def remote_control_script(self, path: str, *args: str) -> None:
path = which(path) or path
if not os.access(path, os.X_OK):
self.show_error('Remote control script not executable', f'The script {path} is not executable check its permissions')
return
self.run_background_process([path] + list(args), allow_remote_control=True)
def call_remote_control(self, self_window: Window | None, args: tuple[str, ...]) -> 'ResponseType':
from .rc.base import PayloadGetter, command_for_name, parse_subcommand_cli
from .remote_control import parse_rc_args
aa = list(args)
silent = False
if aa and aa[0].startswith('!'):
aa[0] = aa[0][1:]
silent = True
try:
global_opts, items = parse_rc_args(['@'] + aa)
if not items:
return None
cmd = items[0]
c = command_for_name(cmd)
opts, items = parse_subcommand_cli(c, items)
payload = c.message_to_kitty(global_opts, opts, items)
except SystemExit as e:
raise Exception(str(e)) from e
import types
try:
if isinstance(payload, types.GeneratorType):
for x in payload:
c.response_from_kitty(self, self_window, PayloadGetter(c, x if isinstance(x, dict) else {}))
return None
return c.response_from_kitty(self, self_window, PayloadGetter(c, payload if isinstance(payload, dict) else {}))
except Exception as e:
if silent:
log_error(f'Failed to run remote_control mapping: {aa} with error: {e}')
return None
raise
def peer_message_received(self, msg_bytes: bytes, peer_id: int, is_remote_control: bool) -> bytes | bool | None:
if peer_id > 0 and msg_bytes == b'peer_death':
self.peer_data_map.pop(peer_id, None)
return False
if is_remote_control:
cmd_prefix = b'\x1bP@kitty-cmd'
terminator = b'\x1b\\'
if msg_bytes.startswith(cmd_prefix) and msg_bytes.endswith(terminator):
cmd = memoryview(msg_bytes)[len(cmd_prefix):-len(terminator)]
response = self._handle_remote_command(cmd, peer_id=peer_id)
if response is None:
return None
if isinstance(response, AsyncResponse):
return True
from kitty.remote_control import encode_response_for_peer
return encode_response_for_peer(response)
log_error('Malformatted remote control message received from peer, ignoring')
return None
try:
data:SingleInstanceData = json.loads(msg_bytes.decode('utf-8'))
except Exception:
log_error('Malformed command received over single instance socket, ignoring')
return None
if isinstance(data, dict) and data.get('cmd') == 'new_instance':
if data['args'][0] == 'panel':
from kittens.panel.main import handle_single_instance_command
handle_single_instance_command(self, data['args'], data['environ'], data.get('notify_on_os_window_death', ''))
return None
from .cli_stub import CLIOptions
startup_id = data['environ'].get('DESKTOP_STARTUP_ID', '')
activation_token = data['environ'].get('XDG_ACTIVATION_TOKEN', '')
try:
args, rest = parse_args(list(data['args'][1:]), result_class=CLIOptions)
except BaseException as e:
self.show_error(_('Invalid single instance command received'), _('The command: {0} is invalid with error: {1}').format(
data['args'], e))
return None
cmdline_args_for_open = data.get('cmdline_args_for_open')
if cmdline_args_for_open:
self.launch_urls(*cmdline_args_for_open, no_replace_window=True)
return None
args.args = rest
opts = create_opts(args)
if data['session_data']:
if data['session_data'] == 'none':
args.session = 'none'
else:
from .session import PreReadSession
args.session = PreReadSession(data['session_data'], data['environ'])
else:
args.session = ''
if not os.path.isabs(args.directory):
args.directory = os.path.join(data['cwd'], args.directory)
from .child import process_env
clean_env = process_env(data['environ'])
focused_os_window = os_window_id = 0
for session in create_sessions(opts, args, respect_cwd=True, env_when_no_session=clean_env):
if not session.has_non_background_processes:
# background only do not create an OS Window
from .launch import LaunchSpec, launch
for tab in session.tabs:
for window in tab.windows:
if window.is_background_process:
assert isinstance(window.launch_spec, LaunchSpec)
launch(get_boss(), window.launch_spec.opts, window.launch_spec.args)
continue
os_window_id = self.add_os_window(
session, wclass=args.cls, wname=args.name, opts_for_size=opts, startup_id=startup_id,
override_title=args.title or None)
if session.focus_os_window:
focused_os_window = os_window_id
if opts.background_opacity != get_options().background_opacity:
self._set_os_window_background_opacity(os_window_id, opts.background_opacity)
if n := data.get('notify_on_os_window_death'):
self.os_window_death_actions[os_window_id] = partial(self.notify_on_os_window_death, n)
if focused_os_window > 0:
focus_os_window(focused_os_window, True, activation_token)
elif activation_token and is_wayland() and os_window_id:
focus_os_window(os_window_id, True, activation_token)
else:
log_error('Unknown message received over single instance socket, ignoring')
return None
def quick_access_terminal_invoked(self) -> None:
for os_window_id in self.os_window_map:
toggle_os_window_visibility(os_window_id)
def handle_remote_cmd(self, cmd: memoryview, window: Window | None = None) -> None:
response = self._handle_remote_command(cmd, window)
if response is not None and not isinstance(response, AsyncResponse) and window is not None:
window.send_cmd_response(response)
def mark_os_window_for_close(self, os_window_id: int, request_type: int = IMPERATIVE_CLOSE_REQUESTED) -> None:
if self.current_visual_select is not None and self.current_visual_select.os_window_id == os_window_id:
self.cancel_current_visual_select()
mark_os_window_for_close(os_window_id, request_type)
def _cleanup_tab_after_window_removal(self, src_tab: Tab) -> None:
if len(src_tab) < 1:
tm = src_tab.tab_manager_ref()
if tm is not None:
tm.remove(src_tab)
src_tab.destroy()
if len(tm) == 0:
if not self.shutting_down:
self.mark_os_window_for_close(src_tab.os_window_id)
@contextmanager
def suppress_focus_change_events(self) -> Generator[None, None, None]:
changes = {}
for w in self.window_id_map.values():
changes[w] = w.ignore_focus_changes
w.ignore_focus_changes = True
try:
yield
finally:
for w, val in changes.items():
w.ignore_focus_changes = val
def on_child_death(self, window_id: int) -> None:
prev_active_window = self.active_window
window = self.window_id_map.pop(window_id, None)
if window is None:
return
with self.suppress_focus_change_events():
for close_action in window.actions_on_close:
try:
close_action(window)
except Exception:
import traceback
traceback.print_exc()
os_window_id = window.os_window_id
window.destroy()
tm = self.os_window_map.get(os_window_id)
tab = None
if tm is not None:
for q in tm:
if window in q:
tab = q
break
if tab is not None:
tab.remove_window(window)
self._cleanup_tab_after_window_removal(tab)
for removal_action in window.actions_on_removal:
try:
removal_action(window)
except Exception:
import traceback
traceback.print_exc()
del window.actions_on_close[:], window.actions_on_removal[:]
window = self.active_window
if window is not prev_active_window:
if prev_active_window is not None:
prev_active_window.focus_changed(False)
if window is not None:
window.focus_changed(True)
def mark_window_for_close(self, q: Window | None | int = None) -> None:
if isinstance(q, int):
window = self.window_id_map.get(q)
if window is None:
return
else:
window = q or self.active_window
if window:
self.child_monitor.mark_for_close(window.id)
@ac('win', 'Close the currently active window')
def close_window(self) -> None:
self.mark_window_for_close(self.window_for_dispatch)
def close_windows_with_confirmation_msg(self, windows: Iterable[Window], active_window: Window | None) -> tuple[str, int]:
num_running_programs = 0
num_background_programs = 0
count_background = get_options().confirm_os_window_close[1]
running_program = background_program = ''
windows = sorted(windows, key=lambda w: 0 if w is active_window else 1)
with cached_process_data():
for window in windows:
if window.has_running_program:
num_running_programs += 1
running_program = running_program or (window.child.foreground_cmdline or [''])[0]
elif count_background and (bp := window.child.background_processes):
num_background_programs += len(bp)
for q in bp:
background_program = background_program or (q['cmdline'] or [''])[0]
if num := num_running_programs + num_background_programs:
if num_running_programs:
return ngettext(_('It is running: {0}.'), _('It is running: {0} and {1} other programs.'), num_running_programs).format(
green(running_program), num_running_programs - 1), num
if num_background_programs:
return ngettext(_('It is running: {0} in the background.'), _(
'It is running: {0} in the background and {1} other programs.'),
num_background_programs).format(green(background_program), num_background_programs - 1) + ' ' + _(
'\n\nBackground programs should be run with the disown command'
' to allow them to continue running when the terminal is closed.'), num
return '', 0
@ac('win', '''
Close window with confirmation
Asks for confirmation before closing the window. If you don't want the
confirmation when the window is sitting at a shell prompt
(requires :ref:`shell_integration`), use::
map f1 close_window_with_confirmation ignore-shell
''')
def close_window_with_confirmation(self, ignore_shell: bool = False) -> None:
window = self.window_for_dispatch or self.active_window
if window is None:
return
msg = self.close_windows_with_confirmation_msg((window,), window)[0]
if not msg and not ignore_shell:
msg = _('It is running a shell.')
if msg:
msg = _('Are you sure you want to close this window?') + ' ' + msg
self.confirm(msg, self.handle_close_window_confirmation, window.id, window=window, title=_('Close window?'))
else:
self.mark_window_for_close(window)
def handle_close_window_confirmation(self, allowed: bool, window_id: int) -> None:
if allowed:
self.mark_window_for_close(window_id)
@ac('tab', 'Close the current tab')
def close_tab(self, tab: Tab | None = None) -> None:
if tab is None and self.window_for_dispatch:
tab = self.window_for_dispatch.tabref()
tab = tab or self.active_tab
if tab:
self.confirm_tab_close(tab)
@property
def active_tab_manager_with_dispatch(self) -> TabManager | None:
if self.window_for_dispatch:
td = self.window_for_dispatch.tabref()
tm = td.tab_manager_ref() if td else None
else:
tm = self.active_tab_manager
return tm
@ac('tab', 'Close all the tabs in the current OS window other than the currently active tab')
def close_other_tabs_in_os_window(self) -> None:
tm = self.active_tab_manager_with_dispatch
if tm is not None and len(tm.tabs) > 1:
active_tab = self.active_tab
for tab in tm:
if tab is not active_tab:
self.close_tab(tab)
@ac('win', 'Close all other OS Windows other than the OS Window containing the currently active window')
def close_other_os_windows(self) -> None:
active = self.active_tab_manager_with_dispatch
if active is not None:
for x in self.os_window_map.values():
if x is not active:
self.mark_os_window_for_close(x.os_window_id)
def confirm(
self, msg: str, # can contain newlines and ANSI formatting
callback: Callable[..., None], # called with True or False and *args
*args: Any, # passed to the callback function
window: Window | None = None, # the window associated with the confirmation
confirm_on_cancel: bool = False, # on closing window
confirm_on_accept: bool = True, # on pressing enter
title: str = '' # window title
) -> Window:
result: bool = False
def callback_(res: dict[str, Any], x: int, boss: Boss) -> None:
nonlocal result
result = res.get('response') == 'y'
def on_popup_overlay_removal(wid: int, boss: Boss) -> None:
callback(result, *args)
cmd = ['--type=yesno', '--message', msg, '--default', 'y' if confirm_on_accept else 'n']
if title:
cmd += ['--title', title]
w = self.run_kitten_with_metadata(
'ask', cmd, window=window, custom_callback=callback_, action_on_removal=on_popup_overlay_removal,
default_data={'response': 'y' if confirm_on_cancel else 'n'})
assert isinstance(w, Window)
return w
def choose(
self, msg: str, # can contain newlines and ANSI formatting
callback: Callable[..., None], # called with the choice or empty string when aborted
*choices: str, # The choices, see the help for the ask kitten for format of a choice
window: Window | None = None, # the window associated with the confirmation
default: str = '', # the default choice when the user presses Enter
hidden_text: str = '', # text to hide in the message
hidden_text_placeholder: str = 'HIDDEN_TEXT_PLACEHOLDER', # placeholder text to insert in to message
unhide_key: str = 'u', # key to press to unhide hidden text
title: str = '' # window title
) -> Window | None:
result: str = ''
def callback_(res: dict[str, Any], x: int, boss: Boss) -> None:
nonlocal result
result = res.get('response') or ''
if hidden_text:
msg = msg.replace(hidden_text, hidden_text_placeholder)
cmd = ['--type=choices', '--message', msg]
if default:
cmd += ['-d', default]
for c in choices:
cmd += ['-c', c]
if hidden_text:
cmd += ['--hidden-text-placeholder', hidden_text_placeholder, '--unhide-key', unhide_key]
input_data = hidden_text
else:
input_data = None
if title:
cmd += ['--title', title]
def on_popup_overlay_removal(wid: int, boss: Boss) -> None:
callback(result)
ans = self.run_kitten_with_metadata(
'ask', cmd, window=window, custom_callback=callback_, input_data=input_data, default_data={'response': ''},
action_on_removal=on_popup_overlay_removal
)
if isinstance(ans, Window):
return ans
return None
def get_line(
self, msg: str, # can contain newlines and ANSI formatting
callback: Callable[..., None], # called with the answer or empty string when aborted
window: Window | None = None, # the window associated with the confirmation
prompt: str = '> ',
is_password: bool = False,
initial_value: str = ''
) -> None:
result: str = ''
def callback_(res: dict[str, Any], x: int, boss: Boss) -> None:
nonlocal result
result = res.get('response') or ''
def on_popup_overlay_removal(wid: int, boss: Boss) -> None:
callback(result)
cmd = ['--type', 'password' if is_password else 'line', '--message', msg, '--prompt', prompt]
if initial_value:
cmd.append('--default=' + initial_value)
self.run_kitten_with_metadata(
'ask', cmd, window=window, custom_callback=callback_, default_data={'response': ''}, action_on_removal=on_popup_overlay_removal
)
def confirm_tab_close(self, tab: Tab) -> None:
msg, num_active_windows = self.close_windows_with_confirmation_msg(tab, tab.active_window)
x = get_options().confirm_os_window_close[0]
num = num_active_windows if x < 0 else len(tab)
needs_confirmation = x != 0 and num >= abs(x)
if not needs_confirmation:
self.close_tab_no_confirm(tab)
return
msg = msg or _('It has {} windows?').format(num)
if tab is not self.active_tab:
tm = tab.tab_manager_ref()
if tm is not None:
tm.set_active_tab(tab)
if tab.confirm_close_window_id and tab.confirm_close_window_id in self.window_id_map:
w = self.window_id_map[tab.confirm_close_window_id]
if w in tab:
tab.set_active_window(w)
return
msg = _('Are you sure you want to close this tab?') + ' ' + msg
w = self.confirm(msg, self.handle_close_tab_confirmation, tab.id, window=tab.active_window, title=_('Close tab?'))
tab.confirm_close_window_id = w.id
def handle_close_tab_confirmation(self, confirmed: bool, tab_id: int) -> None:
for tab in self.all_tabs:
if tab.id == tab_id:
tab.confirm_close_window_id = 0
break
else:
return
if not confirmed:
return
self.close_tab_no_confirm(tab)
def close_tab_no_confirm(self, tab: Tab) -> None:
if self.current_visual_select is not None and self.current_visual_select.tab_id == tab.id:
self.cancel_current_visual_select()
for window in tab:
self.mark_window_for_close(window)
@ac('win', 'Toggle the fullscreen status of the active OS Window')
def toggle_fullscreen(self, os_window_id: int = 0) -> None:
if os_window_id == 0:
tm = self.active_tab_manager_with_dispatch
if tm:
os_window_id = tm.os_window_id
toggle_fullscreen(os_window_id)
@ac('win', 'Toggle the maximized status of the active OS Window')
def toggle_maximized(self, os_window_id: int = 0) -> None:
if os_window_id == 0:
tm = self.active_tab_manager_with_dispatch
if tm:
os_window_id = tm.os_window_id
toggle_maximized(os_window_id)
@ac('misc', 'Toggle macOS secure keyboard entry')
def toggle_macos_secure_keyboard_entry(self) -> None:
toggle_secure_input()
@ac('misc', 'Hide macOS kitty application')
def hide_macos_app(self) -> None:
cocoa_hide_app()
@ac('misc', 'Hide macOS other applications')
def hide_macos_other_apps(self) -> None:
cocoa_hide_other_apps()
@ac('misc', 'Minimize macOS window')
def minimize_macos_window(self) -> None:
osw_id = None
if self.window_for_dispatch:
tm = self.active_tab_manager_with_dispatch
if tm:
osw_id = tm.os_window_id
else:
osw_id = current_os_window()
if osw_id is not None:
cocoa_minimize_os_window(osw_id)
def start(self, first_os_window_id: int, startup_sessions: Iterable[Session]) -> None:
if not getattr(self, 'io_thread_started', False):
self.child_monitor.start()
self.io_thread_started = True
for signum in self.child_monitor.handled_signals():
handled_signals.add(signum)
urls: list[str] = getattr(sys, 'cmdline_args_for_open', [])
if urls:
delattr(sys, 'cmdline_args_for_open')
sess = create_sessions(get_options(), self.args, special_window=SpecialWindow([kitty_exe(), '+runpy', 'input()']))
self.startup_first_child(first_os_window_id, startup_sessions=tuple(sess))
self.launch_urls(*urls)
else:
self.startup_first_child(first_os_window_id, startup_sessions=startup_sessions)
if get_options().update_check_interval > 0 and not self.update_check_started and getattr(sys, 'frozen', False):
from .update_check import run_update_check
run_update_check(get_options().update_check_interval * 60 * 60)
self.update_check_started = True
def handle_click_on_tab(self, os_window_id: int, x: int, button: int, modifiers: int, action: int) -> None:
tm = self.os_window_map.get(os_window_id)
if tm is not None:
tm.handle_click_on_tab(x, button, modifiers, action)
def on_window_resize(self, os_window_id: int, w: int, h: int, dpi_changed: bool) -> None:
if dpi_changed:
self.on_dpi_change(os_window_id)
else:
tm = self.os_window_map.get(os_window_id)
if tm is not None:
tm.resize()
@ac('misc', '''
Clear the terminal
See :sc:`reset_terminal <reset_terminal>` for details. For example::
# Reset the terminal
map f1 clear_terminal reset active
# Clear the terminal screen by erasing all contents
map f1 clear_terminal clear active
# Clear the terminal scrollback by erasing it
map f1 clear_terminal scrollback active
# Scroll the contents of the screen into the scrollback
map f1 clear_terminal scroll active
# Clear everything on screen up to the line with the cursor or the start of the current prompt (needs shell integration)
# Useful for clearing the screen up to the shell prompt and moving the shell prompt to the top of the screen.
map f1 clear_terminal to_cursor active
# Same as above except cleared lines are moved into scrollback
map f1 clear_terminal to_cursor_scroll active
# Erase the last command and its output (needs shell integration to work)
map f1 clear_terminal last_command active
''')
def clear_terminal(self, action: str, only_active: bool) -> None:
if only_active:
windows = []
w = self.window_for_dispatch or self.active_window
if w is not None:
windows.append(w)
else:
windows = list(self.all_windows)
if action == 'reset':
for w in windows:
w.clear_screen(reset=True, scrollback=True)
elif action == 'scrollback':
for w in windows:
w.screen.clear_scrollback()
elif action == 'clear':
for w in windows:
w.clear_screen()
elif action == 'scroll':
for w in windows:
w.scroll_prompt_to_top()
elif action == 'to_cursor':
for w in windows:
w.scroll_prompt_to_top(clear_scrollback=True)
elif action == 'to_cursor_scroll':
for w in windows:
w.scroll_prompt_to_top(clear_scrollback=False)
elif action == 'last_command':
for w in windows:
w.screen.erase_last_command()
else:
self.show_error(_('Unknown clear type'), _('The clear type: {} is unknown').format(action))
def increase_font_size(self) -> None: # legacy
cfs = global_font_size()
self.set_font_size(min(get_options().font_size * 5, cfs + 2.0))
def decrease_font_size(self) -> None: # legacy
cfs = global_font_size()
self.set_font_size(max(MINIMUM_FONT_SIZE, cfs - 2.0))
def restore_font_size(self) -> None: # legacy
self.set_font_size(get_options().font_size)
def set_font_size(self, new_size: float) -> None: # legacy
self.change_font_size(True, None, new_size)
@ac('win', '''
Change the font size for the current or all OS Windows
See :ref:`conf-kitty-shortcuts.fonts` for details.
''')
def change_font_size(self, all_windows: bool, increment_operation: str | None, amt: float) -> None:
def calc_new_size(old_size: float) -> float:
new_size = old_size
if amt == 0:
new_size = get_options().font_size
else:
if increment_operation:
match increment_operation:
case '+':
new_size += amt
case '-':
new_size -= amt
case '*':
new_size *= amt
case '/':
new_size /= amt
case _:
pass # no-op
else:
new_size = amt
new_size = max(MINIMUM_FONT_SIZE, min(new_size, get_options().font_size * 5))
return new_size
if all_windows:
current_global_size = global_font_size()
new_size = calc_new_size(current_global_size)
if new_size != current_global_size:
global_font_size(new_size)
os_windows = list(self.os_window_map.keys())
else:
os_windows = []
w = self.window_for_dispatch or self.active_window
if w is not None:
os_windows.append(w.os_window_id)
if os_windows:
final_windows = {}
for wid in os_windows:
current_size = os_window_font_size(wid)
if current_size:
new_size = calc_new_size(current_size)
if new_size != current_size:
final_windows[wid] = new_size
if final_windows:
self._change_font_size(final_windows)
def _change_font_size(self, sz_map: dict[int, float]) -> None:
for os_window_id, sz in sz_map.items():
tm = self.os_window_map.get(os_window_id)
if tm is not None:
os_window_font_size(os_window_id, sz)
tm.resize()
def on_dpi_change(self, os_window_id: int) -> None:
tm = self.os_window_map.get(os_window_id)
if tm is not None:
sz = os_window_font_size(os_window_id)
if sz:
os_window_font_size(os_window_id, sz, True)
for tab in tm:
for window in tab:
window.on_dpi_change(sz)
tm.resize()
def _set_os_window_background_opacity(self, os_window_id: int, opacity: float) -> None:
change_background_opacity(os_window_id, max(0.0, min(opacity, 1.0)))
@ac('win', '''
Set the background opacity for the active OS Window
For example::
map f1 set_background_opacity +0.1
map f2 set_background_opacity -0.1
map f3 set_background_opacity 0.5
''')
def set_background_opacity(self, opacity: str) -> None:
window = self.window_for_dispatch or self.active_window
if window is None or not opacity:
return
if not get_options().dynamic_background_opacity:
self.show_error(
_('Cannot change background opacity'),
_('You must set the dynamic_background_opacity option in kitty.conf to be able to change background opacity'))
return
os_window_id = window.os_window_id
if opacity[0] in '+-':
old_opacity = background_opacity_of(os_window_id)
if old_opacity is None:
return
fin_opacity = old_opacity + float(opacity)
elif opacity == 'default':
fin_opacity = get_options().background_opacity
else:
fin_opacity = float(opacity)
self._set_os_window_background_opacity(os_window_id, fin_opacity)
@property
def active_tab_manager(self) -> TabManager | None:
os_window_id = current_focused_os_window_id()
if os_window_id <= 0:
os_window_id = last_focused_os_window_id()
if os_window_id <= 0:
q = current_os_window()
if q is not None:
os_window_id = q
return self.os_window_map.get(os_window_id)
@property
def active_tab(self) -> Tab | None:
tm = self.active_tab_manager
return None if tm is None else tm.active_tab
@property
def active_window(self) -> Window | None:
t = self.active_tab
return None if t is None else t.active_window
def refresh_active_tab_bar(self) -> bool:
tm = self.active_tab_manager
if tm:
tm.update_tab_bar_data()
tm.mark_tab_bar_dirty()
return True
return False
@ac('misc', '''
End the current keyboard mode switching to the previous mode.
''')
def pop_keyboard_mode(self) -> bool:
return self.mappings.pop_keyboard_mode()
@ac('misc', '''
Switch to the specified keyboard mode, pushing it onto the stack of keyboard modes.
''')
def push_keyboard_mode(self, new_mode: str) -> None:
self.mappings.push_keyboard_mode(new_mode)
def dispatch_possible_special_key(self, ev: KeyEvent) -> bool:
return self.mappings.dispatch_possible_special_key(ev)
def cancel_current_visual_select(self) -> None:
if self.current_visual_select:
self.current_visual_select.cancel()
self.current_visual_select = None
self.mappings.pop_keyboard_mode_if_is('__visual_select__')
def visual_window_select_action(
self, tab: Tab,
callback: Callable[[Tab | None, Window | None], None],
choose_msg: str,
only_window_ids: Container[int] = (),
reactivate_prev_tab: bool = False
) -> None:
import string
self.cancel_current_visual_select()
initial_tab_id: int | None = None
initial_os_window_id = current_os_window()
tm = tab.tab_manager_ref()
if tm is not None:
if tm.active_tab is not None:
initial_tab_id = tm.active_tab.id
tm.set_active_tab(tab)
if initial_os_window_id != tab.os_window_id:
focus_os_window(tab.os_window_id, True)
self.current_visual_select = VisualSelect(tab.id, tab.os_window_id, initial_tab_id, initial_os_window_id, choose_msg, callback, reactivate_prev_tab)
if tab.current_layout.only_active_window_visible:
self.select_window_in_tab_using_overlay(tab, choose_msg, only_window_ids)
return
km = KeyboardMode('__visual_select__')
km.on_action = 'end'
km.keymap[SingleKey(key=GLFW_FKEY_ESCAPE)].append(KeyDefinition(definition='visual_window_select_action_trigger 0'))
fmap = get_name_to_functional_number_map()
alphanumerics = get_options().visual_window_select_characters
for idx, window in tab.windows.iter_windows_with_number(only_visible=True):
if only_window_ids and window.id not in only_window_ids:
continue
ac = KeyDefinition(definition=f'visual_window_select_action_trigger {window.id}')
if idx >= len(alphanumerics):
break
ch = alphanumerics[idx]
window.screen.set_window_char(ch)
self.current_visual_select.window_ids.append(window.id)
for mods in (0, GLFW_MOD_CONTROL, GLFW_MOD_CONTROL | GLFW_MOD_SHIFT, GLFW_MOD_SUPER, GLFW_MOD_ALT, GLFW_MOD_SHIFT):
km.keymap[SingleKey(mods=mods, key=ord(ch.lower()))].append(ac)
if ch in string.digits:
km.keymap[SingleKey(mods=mods, key=fmap[f'KP_{ch}'])].append(ac)
if len(self.current_visual_select.window_ids) > 1:
self.mappings._push_keyboard_mode(km)
redirect_mouse_handling(True)
self.mouse_handler = self.visual_window_select_mouse_handler
else:
self.visual_window_select_action_trigger(self.current_visual_select.window_ids[0] if self.current_visual_select.window_ids else 0)
if get_options().enable_audio_bell:
ring_bell(tab.os_window_id)
def visual_window_select_action_trigger(self, window_id: int = 0) -> None:
if self.current_visual_select:
self.current_visual_select.trigger(int(window_id))
self.current_visual_select = None
def visual_window_select_mouse_handler(self, ev: WindowSystemMouseEvent) -> None:
tab = self.active_tab
def trigger(window_id: int = 0) -> None:
self.visual_window_select_action_trigger(window_id)
self.mappings.pop_keyboard_mode_if_is('__visual_select__')
if ev.button == GLFW_MOUSE_BUTTON_LEFT and ev.action == GLFW_PRESS and ev.window_id:
w = self.window_id_map.get(ev.window_id)
if w is not None and tab is not None and w in tab:
if self.current_visual_select and self.current_visual_select.tab_id == tab.id:
trigger(w.id)
else:
trigger()
return
if ev.button > -1 and tab is not None:
trigger()
def mouse_event(
self, in_tab_bar: bool, window_id: int, action: int, modifiers: int, button: int,
currently_pressed_button: int, x: float, y: float
) -> None:
if self.mouse_handler is not None:
ev = WindowSystemMouseEvent(in_tab_bar, window_id, action, modifiers, button, currently_pressed_button, x, y)
self.mouse_handler(ev)
def select_window_in_tab_using_overlay(self, tab: Tab, msg: str, only_window_ids: Container[int] = ()) -> Window | None:
windows: list[tuple[int | None, str]] = []
selectable_windows: list[tuple[int, str]] = []
for i, w in tab.windows.iter_windows_with_number(only_visible=False):
if only_window_ids and w.id not in only_window_ids:
windows.append((None, f'Current window: {w.title}' if w is self.active_window else w.title))
else:
windows.append((w.id, w.title))
selectable_windows.append((w.id, w.title))
if len(selectable_windows) < 2:
self.visual_window_select_action_trigger(selectable_windows[0][0] if selectable_windows else 0)
if get_options().enable_audio_bell:
ring_bell(tab.os_window_id)
return None
cvs = self.current_visual_select
def chosen(ans: None | int | str) -> None:
q = self.current_visual_select
self.current_visual_select = None
if cvs and q is cvs:
q.trigger(ans if isinstance(ans, int) else 0)
return self.choose_entry(msg, windows, chosen, hints_args=('--hints-offset=0', '--alphabet', get_options().visual_window_select_characters.lower()))
@ac('win', '''
Resize the active window interactively
See :ref:`window_resizing` for details.
''')
def start_resizing_window(self) -> None:
w = self.window_for_dispatch or self.active_window
if w is None:
return
overlay_window = self.run_kitten_with_metadata('resize_window', args=[
f'--horizontal-increment={get_options().window_resize_step_cells}',
f'--vertical-increment={get_options().window_resize_step_lines}'
])
if overlay_window is not None:
overlay_window.allow_remote_control = True
def resize_layout_window(self, window: Window, increment: float, is_horizontal: bool, reset: bool = False) -> bool | None | str:
tab = window.tabref()
if tab is None or not increment:
return False
if reset:
tab.reset_window_sizes()
return None
return tab.resize_window_by(window.id, increment, is_horizontal)
def resize_os_window(self, os_window_id: int, width: int, height: int, unit: str, incremental: bool = False, metrics: 'None | OSWindowSize' = None) -> None:
if not incremental and (width < 0 or height < 0):
return
metrics = get_os_window_size(os_window_id) if metrics is None else metrics
if metrics is None:
return
if metrics['is_layer_shell']:
raise TypeError(f'The OS Window {os_window_id} is a panel and cannot be resized')
has_window_scaling = is_macos or is_wayland()
w, h = get_new_os_window_size(metrics, width, height, unit, incremental, has_window_scaling)
set_os_window_size(os_window_id, w, h)
def tab_for_id(self, tab_id: int) -> Tab | None:
for tm in self.os_window_map.values():
tab = tm.tab_for_id(tab_id)
if tab is not None:
return tab
return None
def default_bg_changed_for(self, window_id: int, via_escape_code: bool = False) -> None:
w = self.window_id_map.get(window_id)
if w is not None:
w.on_color_scheme_preference_change(via_escape_code=via_escape_code)
tm = self.os_window_map.get(w.os_window_id)
if tm is not None:
tm.update_tab_bar_data()
tm.mark_tab_bar_dirty()
t = tm.tab_for_id(w.tab_id)
if t is not None:
t.relayout_borders()
set_os_window_chrome(w.os_window_id)
def dispatch_action(
self,
key_action: KeyAction,
window_for_dispatch: Window | None = None,
dispatch_type: str = 'KeyPress'
) -> bool:
def report_match(f: Callable[..., Any]) -> None:
if self.args.debug_keyboard:
prefix = '\n' if dispatch_type == 'KeyPress' else ''
end = ', ' if dispatch_type == 'KeyPress' else '\n'
timed_debug_print(f'{prefix}\x1b[35m{dispatch_type}\x1b[m matched action:', func_name(f), end=end)
if key_action is not None:
f = getattr(self, key_action.func, None)
if f is not None:
orig, self.window_for_dispatch = self.window_for_dispatch, window_for_dispatch
try:
report_match(f)
passthrough = f(*key_action.args)
if passthrough is not True:
return True
finally:
self.window_for_dispatch = orig
if window_for_dispatch is None:
tab = self.active_tab
window = self.active_window
else:
window = window_for_dispatch
tab = window.tabref()
if tab is None or window is None:
return False
if key_action is not None:
f = getattr(tab, key_action.func, getattr(window, key_action.func, None))
if f is not None:
passthrough = f(*key_action.args)
report_match(f)
if passthrough is not True:
return True
return False
def user_menu_action(self, defn: str) -> None:
' Callback from user actions in the macOS global menu bar or other menus '
self.combine(defn)
@ac('misc', '''
Combine multiple actions and map to a single keypress
The syntax is::
map key combine <separator> action1 <separator> action2 <separator> action3 ...
For example::
map kitty_mod+e combine : new_window : next_layout
map kitty_mod+e combine | new_tab | goto_tab -1
''')
def combine(self, action_definition: str, window_for_dispatch: Window | None = None, dispatch_type: str = 'KeyPress', raise_error: bool = False) -> bool:
consumed = False
if action_definition:
try:
actions = get_options().alias_map.resolve_aliases(action_definition, 'map' if dispatch_type == 'KeyPress' else 'mouse_map')
except Exception as e:
self.show_error('Failed to parse action', f'{action_definition}\n{e}')
return True
if actions:
window_for_dispatch = window_for_dispatch or self.window_for_dispatch
try:
if self.dispatch_action(actions[0], window_for_dispatch, dispatch_type):
consumed = True
if len(actions) > 1:
self.drain_actions(list(actions[1:]), window_for_dispatch, dispatch_type)
except Exception as e:
if raise_error:
raise
self.show_error('Key action failed', f'{actions[0].pretty()}\n{e}')
consumed = True
return consumed
def on_focus(self, os_window_id: int, focused: bool) -> None:
tm = self.os_window_map.get(os_window_id)
if tm is not None:
w = tm.active_window
if w is not None:
w.focus_changed(focused)
if is_macos and focused:
cocoa_set_menubar_title(w.title or '')
tm.mark_tab_bar_dirty()
def on_activity_since_last_focus(self, window: Window) -> None:
os_window_id = window.os_window_id
tm = self.os_window_map.get(os_window_id)
if tm is not None:
tm.mark_tab_bar_dirty()
def update_tab_bar_data(self, os_window_id: int) -> None:
tm = self.os_window_map.get(os_window_id)
if tm is not None:
tm.update_tab_bar_data()
def on_drop(self, os_window_id: int, mime: str, data: bytes) -> None:
tm = self.os_window_map.get(os_window_id)
if tm is not None:
w = tm.active_window
if w is not None:
text = data.decode('utf-8', 'replace')
if mime == 'text/uri-list':
urls = parse_uri_list(text)
if w.at_prompt:
import shlex
text = ' '.join(map(shlex.quote, urls))
else:
text = '\n'.join(urls)
w.paste_text(text)
@ac('win', '''
Focus the nth OS window if positive or the previously active OS windows if negative. When the number is larger
than the number of OS windows focus the last OS window. A value of zero will refocus the currently focused OS window,
this is useful if focus is not on any kitty OS window at all, however, it will only work if the window manager
allows applications to grab focus. For example::
# focus the previously active kitty OS window
map ctrl+p nth_os_window -1
# focus the current kitty OS window (grab focus)
map ctrl+0 nth_os_window 0
# focus the first kitty OS window
map ctrl+1 nth_os_window 1
# focus the last kitty OS window
map ctrl+1 nth_os_window 999
''')
def nth_os_window(self, num: int = 1) -> None:
if not self.os_window_map:
return
if num == 0:
os_window_id = current_focused_os_window_id() or last_focused_os_window_id()
focus_os_window(os_window_id, True)
elif num > 0:
ids = tuple(self.os_window_map.keys())
os_window_id = ids[min(num, len(ids)) - 1]
focus_os_window(os_window_id, True)
elif num < 0:
fc_map = os_window_focus_counters()
s = sorted(fc_map.keys(), key=fc_map.__getitem__)
if not s:
return
try:
os_window_id = s[num-1]
except IndexError:
os_window_id = s[0]
focus_os_window(os_window_id, True)
@ac('win', 'Close the currently active OS Window')
def close_os_window(self) -> None:
tm = self.active_tab_manager_with_dispatch
if tm is not None:
self.confirm_os_window_close(tm.os_window_id)
def confirm_os_window_close(self, os_window_id: int) -> None:
tm = self.os_window_map.get(os_window_id)
if tm is None:
self.mark_os_window_for_close(os_window_id)
return
if self.current_visual_select is not None and self.current_visual_select.os_window_id == os_window_id:
self.cancel_current_visual_select()
active_window = tm.active_window
windows = []
for tab in tm:
windows += list(tab)
msg, num_active_windows = self.close_windows_with_confirmation_msg(windows, active_window)
q = get_options().confirm_os_window_close[0]
num = num_active_windows if q < 0 else len(windows)
needs_confirmation = tm is not None and q != 0 and num >= abs(q)
if not needs_confirmation:
self.mark_os_window_for_close(os_window_id)
return
msg = msg or _('It has {} windows?').format(num)
msg = _('Are you sure you want to close this OS Window?') + ' ' + msg
w = self.confirm(msg, self.handle_close_os_window_confirmation, os_window_id, window=tm.active_window, title=_('Close OS window'))
tm.confirm_close_window_id = w.id
def handle_close_os_window_confirmation(self, confirmed: bool, os_window_id: int) -> None:
tm = self.os_window_map.get(os_window_id)
if tm is not None:
tm.confirm_close_window_id = 0
if confirmed:
self.mark_os_window_for_close(os_window_id)
else:
self.mark_os_window_for_close(os_window_id, NO_CLOSE_REQUESTED)
def on_os_window_closed(self, os_window_id: int, x: int, y: int, viewport_width: int, viewport_height: int, is_layer_shell: bool) -> None:
tm = self.os_window_map.pop(os_window_id, None)
opts = get_options()
if not is_layer_shell:
if opts.remember_window_position and not is_wayland() and not self.os_window_map:
self.cached_values['window-pos'] = x, y
self.cached_values['monitor-workarea'] = glfw_get_monitor_workarea()
self.cached_values['window-size'] = viewport_width, viewport_height
if tm is not None:
tm.destroy()
for window_id in tuple(w.id for w in self.window_id_map.values() if getattr(w, 'os_window_id', None) == os_window_id):
self.window_id_map.pop(window_id, None)
if not self.os_window_map and is_macos:
cocoa_set_menubar_title('')
action = self.os_window_death_actions.pop(os_window_id, None)
if action is not None:
action()
quit_confirmation_window_id: int = 0
@ac('win', 'Quit, closing all windows')
def quit(self, *args: Any) -> None:
windows = []
for q in self.os_window_map.values():
for qt in q:
windows += list(qt)
active_window = self.active_window
msg, num_active_windows = self.close_windows_with_confirmation_msg(windows, active_window)
x = get_options().confirm_os_window_close[0]
num = num_active_windows if x < 0 else len(windows)
needs_confirmation = x != 0 and num >= abs(x)
if not needs_confirmation:
set_application_quit_request(IMPERATIVE_CLOSE_REQUESTED)
return
if current_application_quit_request() == CLOSE_BEING_CONFIRMED:
if self.quit_confirmation_window_id and self.quit_confirmation_window_id in self.window_id_map:
w = self.window_id_map[self.quit_confirmation_window_id]
tab = w.tabref()
if tab is not None:
ctm = tab.tab_manager_ref()
if ctm is not None and tab in ctm and w in tab:
focus_os_window(ctm.os_window_id)
ctm.set_active_tab(tab)
tab.set_active_window(w)
return
return
msg = msg or _('It has {} windows.').format(num)
w = self.confirm(_('Are you sure you want to quit kitty?') + ' ' + msg, self.handle_quit_confirmation, window=active_window, title=_('Quit kitty?'))
self.quit_confirmation_window_id = w.id
set_application_quit_request(CLOSE_BEING_CONFIRMED)
def handle_quit_confirmation(self, confirmed: bool) -> None:
self.quit_confirmation_window_id = 0
set_application_quit_request(IMPERATIVE_CLOSE_REQUESTED if confirmed else NO_CLOSE_REQUESTED)
def notify_on_os_window_death(self, address: str) -> None:
import socket
s = socket.socket(family=socket.AF_UNIX)
with suppress(Exception):
s.connect(address)
s.sendall(b'c')
with suppress(OSError):
s.shutdown(socket.SHUT_RDWR)
s.close()
def display_scrollback(self, window: Window, data: bytes | str, input_line_number: int = 0, title: str = '', report_cursor: bool = True) -> None:
def prepare_arg(x: str) -> str:
x = x.replace('INPUT_LINE_NUMBER', str(input_line_number))
x = x.replace('CURSOR_LINE', str(window.screen.cursor.y + 1) if report_cursor else '0')
x = x.replace('CURSOR_COLUMN', str(window.screen.cursor.x + 1) if report_cursor else '0')
return x
cmd = list(map(prepare_arg, get_options().scrollback_pager))
if not os.path.isabs(cmd[0]):
resolved_exe = which(cmd[0])
if not resolved_exe:
log_error(f'The scrollback_pager {cmd[0]} was not found in PATH, falling back to less')
resolved_exe = which('less') or 'less'
cmd[0] = resolved_exe
if os.path.basename(cmd[0]) == 'less':
cmd.append('-+F') # reset --quit-if-one-screen
tab = self.active_tab
if tab is not None:
bdata = data.encode('utf-8') if isinstance(data, str) else data
if is_macos and cmd[0] == '/usr/bin/less' and macos_version()[:2] < (12, 3):
# the system less before macOS 12.3 barfs up OSC codes, so sanitize them ourselves
sentinel = os.path.join(cache_dir(), 'less-is-new-enough')
if not os.path.exists(sentinel):
if less_version(cmd[0]) >= 581:
open(sentinel, 'w').close()
else:
bdata = re.sub(br'\x1b\].*?\x1b\\', b'', bdata)
tab.new_special_window(
SpecialWindow(cmd, bdata, title or _('History'), overlay_for=window.id, cwd=window.cwd_of_child),
copy_colors_from=self.active_window
)
@ac('misc', 'Edit the kitty.conf config file in your favorite text editor')
def edit_config_file(self, *a: Any) -> None:
confpath = prepare_config_file_for_editing()
cmd = [kitty_exe(), '+edit'] + get_editor(get_options()) + [confpath]
self.new_os_window(*cmd)
def run_kitten_with_metadata(
self,
kitten: str,
args: Iterable[str] = (),
input_data: bytes | str | None = None,
window: Window | None = None,
custom_callback: Callable[[dict[str, Any], int, 'Boss'], None] | None = None,
action_on_removal: Callable[[int, 'Boss'], None] | None = None,
default_data: dict[str, Any] | None = None
) -> Any:
from kittens.runner import CLIOnlyKitten, KittenMetadata, create_kitten_handler
is_wrapped = kitten in wrapped_kitten_names()
if window is None:
w = self.active_window
tab = self.active_tab
else:
w = window
tab = w.tabref() if w else None
args = list(args)
if w is not None and '@selection' in args and (sel := self.data_for_at(which='@selection', window=w)):
args = [sel if xa == '@selection' else xa for xa in args]
try:
end_kitten = create_kitten_handler(kitten, args)
except CLIOnlyKitten:
is_wrapped = True
end_kitten = KittenMetadata()
if end_kitten.no_ui:
return end_kitten.handle_result(None, w.id if w else 0, self)
if w is not None and tab is not None:
if not is_wrapped:
args[0:0] = [config_dir, kitten]
if input_data is None:
type_of_input = end_kitten.type_of_input
q = type_of_input.split('-') if type_of_input else []
if not q:
data: bytes | None = None
elif q[0] in ('text', 'history', 'ansi', 'screen'):
data = w.as_text(as_ansi='ansi' in q, add_history='history' in q, add_wrap_markers='screen' in q).encode('utf-8')
elif type_of_input == 'selection':
sel = self.data_for_at(which='@selection', window=w)
data = sel.encode('utf-8') if sel else None
elif q[0] in ('output', 'first_output', 'last_visited_output'):
which = {
'output': CommandOutput.last_run, 'first_output': CommandOutput.first_on_screen,
'last_visited_output': CommandOutput.last_visited}[q[0]]
data = w.cmd_output(which, as_ansi='ansi' in q, add_wrap_markers='screen' in q).encode('utf-8')
else:
raise ValueError(f'Unknown type_of_input: {type_of_input}')
else:
data = input_data if isinstance(input_data, bytes) else input_data.encode('utf-8')
copts = common_opts_as_dict(get_options())
env = {
'KITTY_COMMON_OPTS': json.dumps(copts),
'KITTY_CHILD_PID': str(w.child.pid),
'OVERLAID_WINDOW_LINES': str(w.screen.lines),
'OVERLAID_WINDOW_COLS': str(w.screen.columns),
}
if is_wrapped:
cmd = [kitten_exe(), kitten]
env['KITTEN_RUNNING_AS_UI'] = '1'
env['KITTY_CONFIG_DIRECTORY'] = config_dir
if w is not None:
env['KITTY_BASIC_COLORS'] = json.dumps(w.screen.color_profile.basic_colors())
else:
cmd = [kitty_exe(), '+runpy', 'from kittens.runner import main; main()']
env['PYTHONWARNINGS'] = 'ignore'
remote_control_fd = -1
if end_kitten.allow_remote_control:
remote_control_passwords: dict[str, Sequence[str]] | None = None
initial_data = b''
if end_kitten.remote_control_password:
from secrets import token_hex
p = token_hex(16)
remote_control_passwords = {p: end_kitten.remote_control_password if isinstance(end_kitten.remote_control_password, str) else ''}
initial_data = p.encode() + b'\n'
remote = self.add_fd_based_remote_control(remote_control_passwords, initial_data)
remote_control_fd = remote.fileno()
try:
overlay_window = tab.new_special_window(
SpecialWindow(
cmd + args,
stdin=data,
env=env,
cwd=w.cwd_of_child,
overlay_for=w.id,
overlay_behind=end_kitten.has_ready_notification,
),
copy_colors_from=w, remote_control_fd=remote_control_fd,
)
finally:
if end_kitten.allow_remote_control:
remote.close()
wid = w.id
overlay_window.actions_on_close.append(partial(self.on_kitten_finish, wid, custom_callback or end_kitten.handle_result, default_data=default_data))
overlay_window.open_url_handler = end_kitten.open_url_handler
if action_on_removal is not None:
def callback_wrapper(*a: Any) -> None:
if action_on_removal is not None:
action_on_removal(wid, self)
overlay_window.actions_on_removal.append(callback_wrapper)
return overlay_window
_run_kitten = run_kitten_with_metadata
@ac('misc', 'Run the specified kitten. See :doc:`/kittens/custom` for details')
def kitten(self, kitten: str, *kargs: str) -> None:
self.run_kitten_with_metadata(kitten, kargs, window=self.window_for_dispatch)
def run_kitten(self, kitten: str, *args: str) -> None:
self.run_kitten_with_metadata(kitten, args)
def on_kitten_finish(
self, target_window_id: int, end_kitten: Callable[[dict[str, Any], int, 'Boss'], None],
source_window: Window,
default_data: dict[str, Any] | None = None
) -> None:
data, source_window.kitten_result = source_window.kitten_result, None
if data is None:
data = default_data
if data is not None:
end_kitten(data, target_window_id, self)
@ac('misc', 'Input an arbitrary unicode character. See :doc:`/kittens/unicode_input` for details.')
def input_unicode_character(self) -> None:
self.run_kitten_with_metadata('unicode_input', window=self.window_for_dispatch)
@ac(
'tab', '''
Change the title of the active tab interactively, by typing in the new title.
If you specify an argument to this action then that is used as the title instead of asking for it.
Use the empty string ("") to reset the title to default. Use a space (" ") to indicate that the
prompt should not be pre-filled. For example::
# interactive usage
map f1 set_tab_title
# set a specific title
map f2 set_tab_title some title
# reset to default
map f3 set_tab_title ""
# interactive usage without prefilled prompt
map f3 set_tab_title " "
'''
)
def set_tab_title(self, title: str | None = None) -> None:
tab = self.window_for_dispatch.tabref() if self.window_for_dispatch else self.active_tab
if tab:
if title is not None and title not in ('" "', "' '"):
if title in ('""', "''"):
title = ''
tab.set_title(title)
return
prefilled = tab.name or tab.title
if title in ('" "', "' '"):
prefilled = ''
self.get_line(
_('Enter the new title for this tab below. An empty title will cause the default title to be used.'),
tab.set_title, window=tab.active_window, initial_value=prefilled)
def create_special_window_for_show_error(self, title: str, msg: str, overlay_for: int | None = None) -> SpecialWindowInstance:
ec = sys.exc_info()
tb = ''
if ec != (None, None, None):
import traceback
tb = traceback.format_exc()
cmd = [kitten_exe(), '__show_error__', '--title', title]
env = {}
env['KITTEN_RUNNING_AS_UI'] = '1'
env['KITTY_CONFIG_DIRECTORY'] = config_dir
return SpecialWindow(
cmd, override_title=title,
stdin=json.dumps({'msg': msg, 'tb': tb}).encode(),
env=env,
overlay_for=overlay_for,
)
@ac('misc', 'Show an error message with the specified title and text')
def show_error(self, title: str, msg: str) -> None:
w = self.window_for_dispatch or self.active_window
if w:
tab = w.tabref()
if w is not None and tab is not None:
tab.new_special_window(self.create_special_window_for_show_error(title, msg, w.id), copy_colors_from=w)
@ac('mk', 'Create a new marker')
def create_marker(self) -> None:
w = self.window_for_dispatch or self.active_window
if w:
spec = None
def done(data: dict[str, Any], target_window_id: int, self: Boss) -> None:
nonlocal spec
spec = data['response']
def done2(target_window_id: int, self: Boss) -> None:
w = self.window_id_map.get(target_window_id)
if w is not None and spec:
try:
w.set_marker(spec)
except Exception as err:
self.show_error(_('Invalid marker specification'), str(err))
self.run_kitten_with_metadata('ask', [
'--name=create-marker', '--message',
_('Create marker, for example:\ntext 1 ERROR\nSee {}\n').format(website_url('marks'))
],
custom_callback=done, action_on_removal=done2)
@ac('misc', 'Run the kitty shell to control kitty with commands')
def kitty_shell(self, window_type: str = 'window') -> None:
kw: dict[str, Any] = {}
cmd = [kitty_exe(), '@']
aw = self.window_for_dispatch or self.active_window
if aw is not None:
env = {'KITTY_SHELL_ACTIVE_WINDOW_ID': str(aw.id)}
at = self.active_tab
if at is not None:
env['KITTY_SHELL_ACTIVE_TAB_ID'] = str(at.id)
kw['env'] = env
if window_type == 'tab':
tab = self._new_tab(SpecialWindow(cmd, **kw))
if tab is not None:
for w in tab:
window = w
elif window_type == 'os_window':
os_window_id = self._new_os_window(SpecialWindow(cmd, **kw))
for tab in self.os_window_map[os_window_id]:
for w in tab:
window = w
elif window_type == 'overlay':
tab = self.active_tab
if aw is not None and tab is not None:
kw['overlay_for'] = aw.id
window = tab.new_special_window(SpecialWindow(cmd, **kw))
else:
tab = self.active_tab
if tab is not None:
window = tab.new_special_window(SpecialWindow(cmd, **kw))
path, ext = os.path.splitext(logo_png_file)
window.set_logo(f'{path}-128{ext}', position='bottom-right', alpha=0.25)
window.allow_remote_control = True
def switch_focus_to(self, window_id: int) -> None:
tab = self.active_tab
if tab:
tab.set_active_window(window_id)
def open_kitty_website(self) -> None:
self.open_url(website_url())
@ac('misc', 'Open the specified URL')
def open_url(self, url: str, program: str | list[str] | None = None, cwd: str | None = None) -> None:
if not url:
return
if isinstance(program, str):
program = to_cmdline(program)
found_action = False
if program is None:
from .open_actions import actions_for_url
actions = list(actions_for_url(url))
if actions:
found_action = True
self.dispatch_action(actions.pop(0))
if actions:
self.drain_actions(actions)
if not found_action:
extra_env = {}
if self.listening_on:
extra_env['KITTY_LISTEN_ON'] = self.listening_on
def doit(activation_token: str = '') -> None:
if activation_token:
extra_env['XDG_ACTIVATION_TOKEN'] = activation_token
open_url(url, program or get_options().open_url_with, cwd=cwd, extra_env=extra_env)
if is_wayland():
run_with_activation_token(doit)
else:
doit()
@ac('misc', 'Sleep for the specified time period. Suffix can be s for seconds, m, for minutes, h for hours and d for days. The time can be fractional.')
def sleep(self, sleep_time: float = 1.0) -> None:
sleep(sleep_time)
@ac('misc', 'Click a URL using the keyboard')
def open_url_with_hints(self) -> None:
self.run_kitten_with_metadata('hints', window=self.window_for_dispatch)
def drain_actions(self, actions: list[KeyAction], window_for_dispatch: Window | None = None, dispatch_type: str = 'KeyPress') -> None:
def callback(timer_id: int | None) -> None:
self.dispatch_action(actions.pop(0), window_for_dispatch, dispatch_type)
if actions:
self.drain_actions(actions)
add_timer(callback, 0, False)
def destroy(self) -> None:
self.shutting_down = True
self.child_monitor.shutdown_monitor()
self.set_update_check_process()
self.update_check_process = None
del self.child_monitor
for tm in self.os_window_map.values():
tm.destroy()
self.os_window_map = {}
destroy_global_data()
def paste_to_active_window(self, text: str) -> None:
if text:
w = self.active_window
if w is not None:
w.paste_with_actions(text)
@ac('cp', 'Paste from the clipboard to the active window')
def paste_from_clipboard(self) -> None:
text = get_clipboard_string()
if text:
w = self.window_for_dispatch or self.active_window
if w is not None:
w.paste_with_actions(text)
def current_primary_selection(self) -> str:
return get_primary_selection() if supports_primary_selection else ''
def current_primary_selection_or_clipboard(self) -> str:
return get_primary_selection() if supports_primary_selection else get_clipboard_string()
@ac('cp', 'Paste from the primary selection, if present, otherwise the clipboard to the active window')
def paste_from_selection(self) -> None:
text = self.current_primary_selection_or_clipboard()
if text:
w = self.window_for_dispatch or self.active_window
if w is not None:
w.paste_with_actions(text)
def set_primary_selection(self) -> None:
w = self.active_window
if w is not None and not w.destroyed:
text = w.text_for_selection()
if text:
set_primary_selection(text)
self.handle_clipboard_loss('primary', w.id)
if get_options().copy_on_select:
self.copy_to_buffer(get_options().copy_on_select)
def get_active_selection(self) -> str | None:
w = self.active_window
if w is not None and not w.destroyed:
return w.text_for_selection()
return None
def has_active_selection(self) -> bool:
w = self.active_window
if w is not None and not w.destroyed:
return w.has_selection()
return False
def set_clipboard_buffer(self, buffer_name: str, text: str | None = None) -> None:
if buffer_name:
if text is not None:
self.clipboard_buffers[buffer_name] = text
elif buffer_name in self.clipboard_buffers:
del self.clipboard_buffers[buffer_name]
def get_clipboard_buffer(self, buffer_name: str) -> str | None:
return self.clipboard_buffers.get(buffer_name)
@ac('cp', '''
Copy the selection from the active window to the specified buffer
See :ref:`cpbuf` for details.
''')
def copy_to_buffer(self, buffer_name: str) -> None:
w = self.window_for_dispatch or self.active_window
if w is not None and not w.destroyed:
text = w.text_for_selection()
if text:
if buffer_name == 'clipboard':
set_clipboard_string(text)
self.handle_clipboard_loss('clipboard', w.id)
elif buffer_name == 'primary':
set_primary_selection(text)
self.handle_clipboard_loss('primary', w.id)
else:
self.set_clipboard_buffer(buffer_name, text)
@ac('cp', '''
Paste from the specified buffer to the active window
See :ref:`cpbuf` for details.
''')
def paste_from_buffer(self, buffer_name: str) -> None:
if buffer_name == 'clipboard':
text: str | None = get_clipboard_string()
elif buffer_name == 'primary':
text = get_primary_selection()
else:
text = self.get_clipboard_buffer(buffer_name)
if text:
w = self.window_for_dispatch or self.active_window
if w:
w.paste_with_actions(text)
@ac('tab', '''
Go to the specified tab, by number, starting with 1
Zero and negative numbers go to previously active tabs.
Use the :ac:`select_tab` action to interactively select a tab
to go to.
''')
def goto_tab(self, tab_num: int) -> None:
tm = self.active_tab_manager_with_dispatch
if tm is not None:
tm.goto_tab(tab_num - 1)
def set_active_tab(self, tab: Tab) -> bool:
tm = self.active_tab_manager
if tm is not None:
return tm.set_active_tab(tab)
return False
@ac('tab', 'Make the next tab active')
def next_tab(self) -> None:
tm = self.active_tab_manager_with_dispatch
if tm is not None:
tm.next_tab()
@ac('tab', 'Make the previous tab active')
def previous_tab(self) -> None:
tm = self.active_tab_manager_with_dispatch
if tm is not None:
tm.next_tab(-1)
prev_tab = previous_tab
def process_stdin_source(
self, window: Window | None = None,
stdin: str | None = None, copy_pipe_data: dict[str, Any] | None = None
) -> tuple[dict[str, str] | None, bytes | None]:
w = window or self.active_window
if not w:
return None, None
env = None
input_data = None
if stdin:
add_wrap_markers = stdin.endswith('_wrap')
if add_wrap_markers:
stdin = stdin[:-len('_wrap')]
stdin = data_for_at(w, stdin, add_wrap_markers=add_wrap_markers)
if stdin is not None:
pipe_data = w.pipe_data(stdin, has_wrap_markers=add_wrap_markers) if w else None
if pipe_data:
if copy_pipe_data is not None:
copy_pipe_data.update(pipe_data)
env = {
'KITTY_PIPE_DATA':
'{scrolled_by}:{cursor_x},{cursor_y}:{lines},{columns}'.format(**pipe_data)
}
input_data = stdin.encode('utf-8')
return env, input_data
def data_for_at(self, which: str, window: Window | None = None, add_wrap_markers: bool = False) -> str | None:
window = window or self.active_window
if not window:
return None
return data_for_at(window, which, add_wrap_markers=add_wrap_markers)
def special_window_for_cmd(
self, cmd: list[str],
window: Window | None = None,
stdin: str | None = None,
cwd_from: CwdRequest | None = None,
as_overlay: bool = False
) -> SpecialWindowInstance:
w = window or self.active_window
env, input_data = self.process_stdin_source(w, stdin)
cmdline = []
for arg in cmd:
if arg == '@selection' and w:
q = data_for_at(w, arg)
if not q:
continue
arg = q
cmdline.append(arg)
overlay_for = w.id if w and as_overlay else None
return SpecialWindow(cmd, input_data, cwd_from=cwd_from, overlay_for=overlay_for, env=env)
def add_fd_based_remote_control(self, remote_control_passwords: dict[str, Sequence[str]] | None = None, initial_data: bytes = b'') -> socket.socket:
local, remote = socket.socketpair()
os.set_inheritable(remote.fileno(), True)
if initial_data:
local.send(initial_data)
lfd = os.dup(local.fileno())
local.close()
try:
peer_id = self.child_monitor.inject_peer(lfd)
except Exception:
os.close(lfd)
remote.close()
raise
self.peer_data_map[peer_id] = remote_control_passwords
return remote
def run_background_process(
self,
cmd: list[str],
cwd: str | None = None,
env: dict[str, str] | None = None,
stdin: bytes | None = None,
cwd_from: CwdRequest | None = None,
allow_remote_control: bool = False,
remote_control_passwords: dict[str, Sequence[str]] | None = None,
notify_on_death: Callable[[int, Exception | None], None] | None = None, # guaranteed to be called only after event loop tick
stdout: int | None = None, stderr: int | None = None,
) -> None:
env = env or None
if env:
env_ = default_env().copy()
env_.update(env)
env = env_
if cwd_from:
with suppress(Exception):
cwd = cwd_from.cwd_of_child
def add_env(key: str, val: str) -> None:
nonlocal env
if env is None:
env = default_env().copy()
env[key] = val
def doit(activation_token: str = '') -> None:
nonlocal env
pass_fds: list[int] = []
fds_to_close_on_launch_failure: list[int] = []
if allow_remote_control:
remote = self.add_fd_based_remote_control(remote_control_passwords)
pass_fds.append(remote.fileno())
add_env('KITTY_LISTEN_ON', f'fd:{remote.fileno()}')
if activation_token:
add_env('XDG_ACTIVATION_TOKEN', activation_token)
fds_to_close_on_launch_failure = list(pass_fds)
if stdout is not None and stdout > -1:
pass_fds.append(stdout)
if stderr is not None and stderr > -1 and stderr not in pass_fds:
pass_fds.append(stderr)
def run(stdin: int | None, stdout: int | None, stderr: int | None) -> None:
try:
p = subprocess.Popen(
cmd, env=env, cwd=cwd, preexec_fn=clear_handled_signals, pass_fds=pass_fds, stdin=stdin, stdout=stdout, stderr=stderr)
if notify_on_death:
self.background_process_death_notify_map[p.pid] = notify_on_death
monitor_pid(p.pid)
except Exception as err:
for fd in fds_to_close_on_launch_failure:
with suppress(OSError):
os.close(fd)
if notify_on_death:
def callback(err: Exception, timer_id: int | None) -> None:
notify_on_death(-1, err)
add_timer(partial(callback, err), 0, False)
else:
self.show_error(_('Failed to run background process'), _('Failed to run background process with error: {}').format(err))
r = subprocess.DEVNULL
if stdin:
r, w = safe_pipe(False)
fds_to_close_on_launch_failure.append(w)
pass_fds.append(r)
try:
run(r, stdout, stderr)
if stdin:
thread_write(w, stdin)
finally:
if stdin:
os.close(r)
if allow_remote_control:
remote.close()
if is_wayland():
if not run_with_activation_token(doit):
doit()
else:
doit()
def pipe(self, source: str, dest: str, exe: str, *args: str) -> Window | None:
cmd = [exe] + list(args)
window = self.active_window
cwd_from = CwdRequest(window) if window else None
def create_window() -> SpecialWindowInstance:
return self.special_window_for_cmd(
cmd, stdin=source, as_overlay=dest == 'overlay', cwd_from=cwd_from)
if dest == 'overlay' or dest == 'window':
tab = self.active_tab
if tab is not None:
return tab.new_special_window(create_window())
elif dest == 'tab':
tm = self.active_tab_manager
if tm is not None:
tm.new_tab(special_window=create_window(), cwd_from=cwd_from)
elif dest == 'os_window':
self._new_os_window(create_window(), cwd_from=cwd_from)
elif dest in ('clipboard', 'primary'):
env, stdin = self.process_stdin_source(stdin=source, window=window)
if stdin:
if dest == 'clipboard':
set_clipboard_string(stdin)
self.handle_clipboard_loss('clipboard')
else:
set_primary_selection(stdin)
self.handle_clipboard_loss('primary')
else:
env, stdin = self.process_stdin_source(stdin=source, window=window)
self.run_background_process(cmd, cwd_from=cwd_from, stdin=stdin, env=env)
return None
def args_to_special_window(self, args: Iterable[str], cwd_from: CwdRequest | None = None) -> SpecialWindowInstance:
args = list(args)
stdin = None
w = self.active_window
if args[0].startswith('@') and args[0] != '@':
q = data_for_at(w, args[0]) or None
if q is not None:
stdin = q.encode('utf-8')
del args[0]
cmd = []
for arg in args:
if arg == '@selection':
q = data_for_at(w, arg)
if not q:
continue
arg = q
cmd.append(arg)
return SpecialWindow(cmd, stdin, cwd_from=cwd_from)
def _new_tab(self, args: SpecialWindowInstance | Iterable[str], cwd_from: CwdRequest | None = None, as_neighbor: bool = False) -> Tab | None:
special_window = None
if args:
if isinstance(args, SpecialWindowInstance):
special_window = args
else:
special_window = self.args_to_special_window(args, cwd_from=cwd_from)
if not self.os_window_map:
self.add_os_window()
tm = self.active_tab_manager
if tm is None and not self.os_window_map:
os_window_id = self.add_os_window()
tm = self.os_window_map.get(os_window_id)
if tm is not None:
return tm.new_tab(special_window=special_window, cwd_from=cwd_from, as_neighbor=as_neighbor)
return None
def _create_tab(self, args: list[str], cwd_from: CwdRequest | None = None) -> None:
as_neighbor = False
if args and args[0].startswith('!'):
as_neighbor = 'neighbor' in args[0][1:].split(',')
args = args[1:]
self._new_tab(args, as_neighbor=as_neighbor, cwd_from=cwd_from)
@ac('tab', 'Create a new tab')
def new_tab(self, *args: str) -> None:
self._create_tab(list(args))
@ac('tab', 'Create a new tab with working directory for the window in it set to the same as the active window')
def new_tab_with_cwd(self, *args: str) -> None:
self._create_tab(list(args), cwd_from=CwdRequest(self.window_for_dispatch or self.active_window_for_cwd))
def new_tab_with_wd(self, wd: str | list[str], str_is_multiple_paths: bool = False) -> None:
if isinstance(wd, str):
wd = wd.split(os.pathsep) if str_is_multiple_paths else [wd]
for path in wd:
special_window = SpecialWindow(None, cwd=path)
self._new_tab(special_window)
def _new_window(self, args: list[str], cwd_from: CwdRequest | None = None) -> Window | None:
if not self.os_window_map:
os_window_id = self.add_os_window()
tm = self.os_window_map.get(os_window_id)
if tm is not None and not tm.active_tab:
tm.new_tab(empty_tab=True)
tab = self.active_tab
if tab is None:
return None
allow_remote_control = False
location = None
if args and args[0].startswith('!'):
location = args[0][1:].lower()
args = args[1:]
if args and args[0] == '@':
args = args[1:]
allow_remote_control = True
if args:
return tab.new_special_window(
self.args_to_special_window(args, cwd_from=cwd_from),
location=location, allow_remote_control=allow_remote_control)
else:
return tab.new_window(cwd_from=cwd_from, location=location, allow_remote_control=allow_remote_control)
@ac('win', 'Create a new window')
def new_window(self, *args: str) -> None:
self._new_window(list(args))
@ac('win', 'Create a new window with working directory same as that of the active window')
def new_window_with_cwd(self, *args: str) -> None:
w = self.window_for_dispatch or self.active_window_for_cwd
if w is None:
return self.new_window(*args)
self._new_window(list(args), cwd_from=CwdRequest(w))
@ac('misc', '''
Launch the specified program in a new window/tab/etc.
See :doc:`launch` for details
''')
def launch(self, *args: str) -> None:
from kitty.launch import launch, parse_launch_args
opts, args_ = parse_launch_args(args)
if args_ and ' ' in args_[0]:
# this can happen for example with map f1 launch $EDITOR when $EDITOR is not a single command
q = which(args_[0])
if not q or (q is args_[0] and not os.access(q, os.X_OK)):
args_[:1] = shlex_split(args_[0])
if self.window_for_dispatch:
opts.source_window = opts.source_window or f'id:{self.window_for_dispatch.id}'
opts.next_to = opts.next_to or f'id:{self.window_for_dispatch.id}'
launch(self, opts, args_)
@ac('tab', 'Move the active tab forward')
def move_tab_forward(self) -> None:
tm = self.active_tab_manager
if tm is not None:
tm.move_tab(1)
@ac('tab', 'Move the active tab backward')
def move_tab_backward(self) -> None:
tm = self.active_tab_manager_with_dispatch
if tm is not None:
tm.move_tab(-1)
@ac('misc', '''
Turn on/off ligatures in the specified window
See :opt:`disable_ligatures` for details
''')
def disable_ligatures_in(self, where: str | Iterable[Window], strategy: int) -> None:
w = self.window_for_dispatch or self.active_window
if isinstance(where, str):
windows: list[Window] = []
if where == 'active':
if w:
windows = [w]
elif where == 'all':
windows = list(self.all_windows)
elif where == 'tab':
if w:
tab = w.tabref()
if tab:
windows = list(tab)
else:
windows = list(where)
for window in windows:
window.screen.disable_ligatures = strategy
window.refresh()
def apply_new_options(self, opts: Options) -> None:
bg_colors_before = {w.id: w.screen.color_profile.default_bg for w in self.all_windows}
# Update options storage
set_options(opts, is_wayland(), self.args.debug_rendering, self.args.debug_font_fallback)
apply_options_update()
set_layout_options(opts)
set_default_env(opts.env.copy())
# Update font data
from .fonts.render import set_font_family
set_font_family(opts)
for os_window_id, tm in self.os_window_map.items():
if tm is not None:
os_window_font_size(os_window_id, opts.font_size, True)
tm.resize()
# Update key bindings
if is_macos:
from .fast_data_types import cocoa_clear_global_shortcuts
cocoa_clear_global_shortcuts()
self.mappings.update_keymap()
if is_macos:
from .fast_data_types import cocoa_recreate_global_menu
cocoa_recreate_global_menu()
# Update misc options
try:
set_background_image(opts.background_image, tuple(self.os_window_map), True, opts.background_image_layout)
except Exception as e:
log_error(f'Failed to set background image with error: {e}')
for tm in self.all_tab_managers:
tm.apply_options()
# Update colors
if theme_colors.has_applied_theme:
theme_colors.refresh()
if theme_colors.has_applied_theme: # in case the theme file was deleted
assert theme_colors.applied_theme # to make mypy happy
theme_colors.apply_theme(theme_colors.applied_theme, notify_on_bg_change=False)
for w in self.all_windows:
if w.screen.color_profile.default_bg != bg_colors_before.get(w.id):
self.default_bg_changed_for(w.id)
w.refresh(reload_all_gpu_data=True)
load_shader_programs.recompile_if_needed()
@ac('misc', '''
Reload the config file
If mapped without arguments reloads the default config file, otherwise loads
the specified config files, in order. Loading a config file *replaces* all
config options. For example::
map f5 load_config_file /path/to/some/kitty.conf
''')
def load_config_file(self, *paths: str, apply_overrides: bool = True, overrides: Sequence[str] = ()) -> None:
from .cli import default_config_paths
from .config import load_config
old_opts = get_options()
prev_paths = old_opts.all_config_paths or default_config_paths(self.args.config)
paths = paths or prev_paths
bad_lines: list[BadLine] = []
final_overrides = old_opts.config_overrides if apply_overrides else ()
if overrides:
final_overrides += tuple(overrides)
opts = load_config(*paths, overrides=final_overrides or None, accumulate_bad_lines=bad_lines)
if bad_lines:
self.show_bad_config_lines(bad_lines)
self.apply_new_options(opts)
from .open_actions import clear_caches
clear_caches()
from .guess_mime_type import clear_mime_cache
clear_mime_cache()
store_effective_config()
def safe_delete_temp_file(self, path: str) -> None:
if is_path_in_temp_dir(path):
with suppress(FileNotFoundError):
os.remove(path)
def is_ok_to_read_image_file(self, path: str, fd: int) -> bool:
return is_ok_to_read_image_file(path, fd)
def set_update_check_process(self, process: Optional['PopenType[bytes]'] = None) -> None:
if self.update_check_process is not None:
with suppress(Exception):
if self.update_check_process.poll() is None:
self.update_check_process.kill()
self.update_check_process = process
def monitor_pid(self, pid: int, callback: Callable[[int, Exception | None], None]) -> None:
self.background_process_death_notify_map[pid] = callback
monitor_pid(pid)
def on_monitored_pid_death(self, pid: int, exit_status: int) -> None:
callback = self.background_process_death_notify_map.pop(pid, None)
if callback is not None:
try:
callback(exit_status, None)
except Exception:
import traceback
traceback.print_exc()
return
update_check_process = self.update_check_process
if update_check_process is not None and pid == update_check_process.pid:
self.update_check_process = None
from .update_check import process_current_release
try:
assert update_check_process.stdout is not None
raw = update_check_process.stdout.read().decode('utf-8')
except Exception as e:
log_error(f'Failed to read data from update check process, with error: {e}')
else:
try:
process_current_release(raw)
except Exception as e:
log_error(f'Failed to process update check data {raw!r}, with error: {e}')
def show_bad_config_lines(self, bad_lines: Iterable[BadLine], misc_errors: Iterable[str] = ()) -> None:
def format_bad_line(bad_line: BadLine) -> str:
return f'{bad_line.number}:{bad_line.exception} in line: {bad_line.line}\n'
groups: dict[str, list[BadLine]] = {}
for bl in bad_lines:
groups.setdefault(bl.file, []).append(bl)
ans: list[str] = []
a = ans.append
for file in sorted(groups):
if file:
a(f'In file {file}:')
[a(format_bad_line(x)) for x in groups[file]]
if misc_errors:
a('In final effective configuration:')
for line in misc_errors:
a(line)
msg = '\n'.join(ans).rstrip()
self.show_error(_('Errors parsing configuration'), msg)
@ac('misc', '''
Change colors in the specified windows
For details, see :ref:`at-set-colors`. For example::
map f5 set_colors --configured /path/to/some/config/file/colors.conf
''')
def set_colors(self, *args: str) -> None:
from kitty.rc.base import PayloadGetter, command_for_name, parse_subcommand_cli
from kitty.remote_control import parse_rc_args
c = command_for_name('set_colors')
try:
opts, items = parse_subcommand_cli(c, ['set-colors'] + list(args))
except (Exception, SystemExit) as err:
self.show_error('Invalid set_colors mapping', str(err))
return
try:
payload = c.message_to_kitty(parse_rc_args([])[0], opts, items)
except (Exception, SystemExit) as err:
self.show_error('Failed to set colors', str(err))
return
c.response_from_kitty(self, self.window_for_dispatch or self.active_window, PayloadGetter(c, payload if isinstance(payload, dict) else {}))
def _move_window_to(
self,
window: Window | None = None,
target_tab_id: str | int | None = None,
target_os_window_id: str | int | None = None
) -> None:
window = window or self.active_window
if not window:
return
src_tab = self.tab_for_window(window)
if src_tab is None:
return
with self.suppress_focus_change_events():
if target_os_window_id == 'new':
target_os_window_id = self.add_os_window()
tm = self.os_window_map[target_os_window_id]
target_tab = tm.new_tab(empty_tab=True)
else:
target_os_window_id = target_os_window_id or current_os_window()
if isinstance(target_tab_id, str):
if not isinstance(target_os_window_id, int):
q = self.active_tab_manager
assert q is not None
tm = q
else:
tm = self.os_window_map[target_os_window_id]
if target_tab_id.startswith('new'):
# valid values for target_tab_id are 'new', 'new_after' and 'new_before'
target_tab = tm.new_tab(empty_tab=True, location=(target_tab_id[4:] or 'last'))
else:
target_tab = tm.tab_at_location(target_tab_id) or tm.new_tab(empty_tab=True)
else:
for tab in self.all_tabs:
if tab.id == target_tab_id:
target_tab = tab
target_os_window_id = tab.os_window_id
break
else:
return
for detached_window in src_tab.detach_window(window):
target_tab.attach_window(detached_window)
self._cleanup_tab_after_window_removal(src_tab)
target_tab.make_active()
def _move_tab_to(self, tab: Tab | None = None, target_os_window_id: int | None = None) -> None:
tab = tab or self.active_tab
if tab is None:
return
if target_os_window_id is None:
target_os_window_id = self.add_os_window()
tm = self.os_window_map[target_os_window_id]
target_tab = tm.new_tab(empty_tab=True)
target_tab.take_over_from(tab)
self._cleanup_tab_after_window_removal(tab)
target_tab.make_active()
def choose_entry(
self, title: str, entries: Iterable[tuple[_T | str | None, str]],
callback: Callable[[_T | str | None], None],
subtitle: str = '',
hints_args: tuple[str, ...] | None = None,
) -> Window | None:
lines = [title, subtitle, ' '] if subtitle else [title, ' ']
idx_map: list[_T | str | None] = []
ans: str | _T | None = None
fmt = ': {1}'
for obj, text in entries:
idx_map.append(obj)
if obj is None:
lines.append(text)
else:
lines.append(fmt.format(len(idx_map), text))
def done(data: dict[str, Any], target_window_id: int, self: Boss) -> None:
nonlocal ans
ans = idx_map[int(data['groupdicts'][0]['index'])]
def done2(target_window_id: int, self: Boss) -> None:
callback(ans)
q = self.run_kitten_with_metadata(
'hints', args=(
'--ascending', '--customize-processing=::import::kitty.choose_entry',
'--window-title', title,
*(hints_args or ())
), input_data='\r\n'.join(lines).encode('utf-8'), custom_callback=done, action_on_removal=done2
)
return q if isinstance(q, Window) else None
@ac('tab', 'Interactively select a tab to switch to')
def select_tab(self) -> None:
def chosen(ans: None | str | int) -> None:
if isinstance(ans, int):
for tab in self.all_tabs:
if tab.id == ans:
self.set_active_tab(tab)
def format_tab_title(tab: Tab) -> str:
w = 'windows' if tab.num_window_groups > 1 else 'window'
return f'{tab.name or tab.title} [{tab.num_window_groups} {w}]'
w = self.window_for_dispatch or self.active_window
ct = w.tabref() if w else None
self.choose_entry(
'Choose a tab to switch to',
((None, f'Current tab: {format_tab_title(t)}') if t is ct else (t.id, format_tab_title(t)) for t in self.all_tabs),
chosen
)
@ac('win', '''
Detach a window, moving it to another tab or OS Window
See :ref:`detaching windows <detach_window>` for details.
''')
def detach_window(self, *args: str) -> None:
if not args or args[0] == 'new':
return self._move_window_to(target_os_window_id='new')
if args[0] in ('new-tab', 'tab-prev', 'tab-left', 'tab-right', 'new-tab-left', 'new-tab-right'):
if args[0] == 'new-tab':
where = 'new'
elif args[0] == 'new-tab-right':
where = 'new_after'
elif args[0] == 'new-tab-left':
where = 'new_before'
else:
where = args[0][4:]
return self._move_window_to(target_tab_id=where)
w = self.window_for_dispatch or self.active_window
ct = w.tabref() if w else None
items: list[tuple[str | int, str]] = [(t.id, t.effective_title) for t in self.all_tabs if t is not ct]
items.append(('new_tab', 'New tab'))
items.append(('new_os_window', 'New OS Window'))
target_window = w
def chosen(ans: None | str | int) -> None:
if ans is not None:
if isinstance(ans, str):
if ans == 'new_os_window':
self._move_window_to(target_os_window_id='new')
elif ans == 'new_tab':
self._move_window_to(target_tab_id=ans)
else:
self._move_window_to(target_window, target_tab_id=ans)
self.choose_entry('Choose a tab to move the window to', items, chosen)
@ac('tab', '''
Detach a tab, moving it to another OS Window
See :ref:`detaching windows <detach_window>` for details.
''')
def detach_tab(self, *args: str) -> None:
if not args or args[0] == 'new':
return self._move_tab_to()
items: list[tuple[str | int, str]] = []
ct = self.active_tab_manager_with_dispatch
for osw_id, tm in self.os_window_map.items():
if tm is not ct and tm.active_tab:
items.append((osw_id, tm.active_tab.title))
items.append(('new', 'New OS Window'))
w = self.window_for_dispatch or self.active_window
target_tab = w.tabref() if w else None
def chosen(ans: None | int | str) -> None:
if ans is not None:
os_window_id = None if isinstance(ans, str) else ans
self._move_tab_to(tab=target_tab, target_os_window_id=os_window_id)
self.choose_entry('Choose an OS window to move the tab to', items, chosen)
def set_background_image(
self, path: str | None, os_windows: tuple[int, ...], configured: bool, layout: str | None, png_data: bytes = b'',
linear_interpolation: bool | None = None, tint: float | None = None, tint_gaps: float | None = None
) -> None:
set_background_image(path, os_windows, configured, layout, png_data, linear_interpolation, tint, tint_gaps)
# Can be called with kitty -o "map f1 send_test_notification"
def send_test_notification(self) -> None:
self.notification_manager.send_test_notification()
@ac('debug', 'Show the environment variables that the kitty process sees')
def show_kitty_env_vars(self) -> None:
w = self.window_for_dispatch or self.active_window
env = os.environ.copy()
if is_macos and env.get('LC_CTYPE') == 'UTF-8' and not getattr(sys, 'kitty_run_data').get('lc_ctype_before_python'):
del env['LC_CTYPE']
if w:
output = '\n'.join(f'{k}={v}' for k, v in env.items())
self.display_scrollback(w, output, title=_('Current kitty env vars'), report_cursor=False)
@ac('debug', '''
Close all shared SSH connections
See :opt:`share_connections <kitten-ssh.share_connections>` for details.
''')
def close_shared_ssh_connections(self) -> None:
cleanup_ssh_control_masters()
@ac('debug', '''Simulate a change in OS color scheme preference''')
def simulate_color_scheme_preference_change(self, which: str) -> None:
which = which.lower().replace('-', '_')
match which:
case 'light':
self.on_system_color_scheme_change('light', False)
case 'dark':
self.on_system_color_scheme_change('dark', False)
case 'no_preference':
self.on_system_color_scheme_change('no_preference', False)
case _:
self.show_error(_('Unknown color scheme type'), _('{} is not a valid color scheme type').format(which))
def launch_urls(self, *urls: str, no_replace_window: bool = False) -> None:
from .launch import force_window_launch
from .open_actions import actions_for_launch
actions: list[KeyAction] = []
failures = []
for url in urls:
uactions = tuple(actions_for_launch(url))
if uactions:
actions.extend(uactions)
else:
failures.append(url)
tab = self.active_tab
if tab is not None:
w = tab.active_window
else:
w = None
needs_window_replaced = False
if not no_replace_window and not get_options().startup_session:
if w is not None and w.id == 1 and monotonic() - w.started_at < 2 and len(tuple(self.all_windows)) == 1:
# first window, soon after startup replace it
needs_window_replaced = True
def clear_initial_window() -> None:
if needs_window_replaced and tab is not None and w is not None:
tab.remove_window(w)
if failures:
from kittens.tui.operations import styled
spec = '\n '.join(styled(u, fg='yellow') for u in failures)
special_window = self.create_special_window_for_show_error('Open URL error', f"Unknown URL type, cannot open:\n {spec}")
if needs_window_replaced and tab is not None:
tab.new_special_window(special_window)
else:
self._new_os_window(special_window)
clear_initial_window()
needs_window_replaced = False
if actions:
with force_window_launch(needs_window_replaced):
self.dispatch_action(actions.pop(0))
clear_initial_window()
if actions:
self.drain_actions(actions)
@ac('debug', 'Show the effective configuration kitty is running with')
def debug_config(self) -> None:
from .debug_config import debug_config
w = self.window_for_dispatch or self.active_window
if w is not None:
output = debug_config(get_options(), self.mappings.global_shortcuts)
set_clipboard_string(re.sub(r'\x1b.+?m', '', output))
self.handle_clipboard_loss('clipboard')
output += '\n\x1b[35mThis debug output has been copied to the clipboard\x1b[m' # ]]]
self.display_scrollback(w, output, title=_('Current kitty options'), report_cursor=False)
@ac('misc', 'Discard this event completely ignoring it')
def discard_event(self) -> None:
pass
mouse_discard_event = discard_event
def sanitize_url_for_display_to_user(self, url: str) -> str:
return sanitize_url_for_display_to_user(url)
def on_system_color_scheme_change(self, appearance: ColorSchemes, is_initial_value: bool) -> None:
theme_colors.on_system_color_scheme_change(appearance, is_initial_value)
@ac('win', '''
Toggle to the tab matching the specified expression
Switches to the matching tab if another tab is current, otherwise
switches to the last used tab. Useful to easily switch to and back from a
tab using a single shortcut. Note that toggling works only between
tabs in the same OS window. See :ref:`search_syntax` for details
on the match expression. For example::
map f1 toggle_tab title:mytab
''')
def toggle_tab(self, match_expression: str) -> None:
tm = self.active_tab_manager_with_dispatch
if tm is not None:
tm.toggle_tab(match_expression)
def update_progress_in_dock(self) -> None:
if not is_macos:
return
has_indeterminate_progress = False
num_of_windows_with_progress = total_progress = 0
for tm in self.os_window_map.values():
if tm.num_of_windows_with_progress:
total_progress += tm.total_progress
num_of_windows_with_progress += tm.num_of_windows_with_progress
if tm.has_indeterminate_progress:
has_indeterminate_progress = True
from .fast_data_types import cocoa_show_progress_bar_on_dock_icon
if num_of_windows_with_progress:
cocoa_show_progress_bar_on_dock_icon(min(100, total_progress / num_of_windows_with_progress))
elif has_indeterminate_progress:
cocoa_show_progress_bar_on_dock_icon(101)
else:
cocoa_show_progress_bar_on_dock_icon()
def on_clipboard_lost(self, which: Literal['clipboard', 'primary']) -> None:
self.handle_clipboard_loss(which)
def handle_clipboard_loss(self, which: Literal['clipboard', 'primary'], exception: int = 0) -> None:
opts = get_options()
if opts.clear_selection_on_clipboard_loss and (which == 'primary' or opts.copy_on_select == 'clipboard'):
for wid, window in self.window_id_map.items():
if wid == exception:
continue
window.screen.clear_selection()
@ac('misc', grab_keyboard_docs)
def grab_keyboard(self) -> None:
grab_keyboard(True)
@ac('misc', 'Ungrab the keyboard if it was previously grabbed')
def ungrab_keyboard(self) -> None:
grab_keyboard(False)
Reference in New Issue View Git Blame Copy Permalink