#!/usr/bin/env python3 # vim:fileencoding=utf-8 # License: GPL v3 Copyright: 2016, Kovid Goyal import atexit import json import os import re from contextlib import suppress from functools import partial from gettext import gettext as _ from typing import ( Any, Callable, Dict, Generator, Iterable, List, Optional, Tuple, Union ) from weakref import WeakValueDictionary from .child import cached_process_data, cwd_of_process from .cli import create_opts, parse_args from .cli_stub import CLIOptions from .conf.utils import BadLine, to_cmdline from .config import ( KeyAction, SubSequenceMap, common_opts_as_dict, initial_window_size_func, prepare_config_file_for_editing ) from .config_data import MINIMUM_FONT_SIZE from .constants import ( appname, config_dir, is_macos, kitty_exe, supports_primary_selection ) from .fast_data_types import ( CLOSE_BEING_CONFIRMED, IMPERATIVE_CLOSE_REQUESTED, NO_CLOSE_REQUESTED, ChildMonitor, background_opacity_of, change_background_opacity, change_os_window_state, cocoa_set_menubar_title, create_os_window, current_application_quit_request, current_os_window, destroy_global_data, focus_os_window, get_clipboard_string, global_font_size, mark_os_window_for_close, os_window_font_size, patch_global_colors, safe_pipe, set_application_quit_request, set_background_image, set_boss, set_clipboard_string, set_in_sequence_mode, thread_write, toggle_fullscreen, toggle_maximized ) from .keys import get_shortcut, shortcut_matches from .layout.base import set_layout_options from .options_stub import Options from .rgb import Color, color_from_int from .session import Session, create_sessions from .tabs import ( SpecialWindow, SpecialWindowInstance, Tab, TabDict, TabManager ) from .typing import PopenType, TypedDict from .utils import ( func_name, get_editor, get_primary_selection, is_path_in_temp_dir, log_error, open_url, parse_address_spec, parse_uri_list, remove_socket_file, safe_print, set_primary_selection, single_instance, startup_notification_handler ) from .window import MatchPatternType, Window class OSWindowDict(TypedDict): id: int is_focused: bool tabs: List[TabDict] def notification_activated(identifier: str) -> None: if identifier == 'new-version': from .update_check import notification_activated as do do() def listen_on(spec: str) -> int: import socket family, address, socket_path = parse_address_spec(spec) s = socket.socket(family) atexit.register(remove_socket_file, s, socket_path) s.bind(address) s.listen() return s.fileno() def data_for_at(w: Optional[Window], arg: str, add_wrap_markers: bool = False) -> Optional[str]: 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) 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, *a: Any) -> None: if a: if a[0] == 'draw': if a[1] is None: if self.draw_dump_buf: safe_print('draw', ''.join(self.draw_dump_buf)) self.draw_dump_buf = [] else: self.draw_dump_buf.append(a[1]) elif a[0] == 'bytes': self.dump_bytes_to.write(a[1]) self.dump_bytes_to.flush() else: if self.draw_dump_buf: safe_print('draw', ''.join(self.draw_dump_buf)) self.draw_dump_buf = [] safe_print(*a) # }}} class Boss: def __init__( self, opts: Options, args: CLIOptions, cached_values: Dict[str, Any], new_os_window_trigger: Optional[Tuple[int, bool, int]] ): set_layout_options(opts) self.clipboard_buffers: Dict[str, str] = {} self.update_check_process: Optional[PopenType] = None self.window_id_map: WeakValueDictionary[int, Window] = WeakValueDictionary() self.startup_colors = {k: opts[k] for k in opts if isinstance(opts[k], Color)} self.startup_cursor_text_color = opts.cursor_text_color self.pending_sequences: Optional[SubSequenceMap] = None 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 talk_fd = getattr(single_instance, 'socket', None) talk_fd = -1 if talk_fd is None else talk_fd.fileno() listen_fd = -1 if args.listen_on and (opts.allow_remote_control in ('y', 'socket-only')): listen_fd = listen_on(args.listen_on) self.child_monitor = ChildMonitor( self.on_child_death, DumpCommands(args) if args.dump_commands or args.dump_bytes else None, talk_fd, listen_fd ) set_boss(self) self.opts, self.args = opts, args self.keymap = self.opts.keymap.copy() if new_os_window_trigger is not None: self.keymap.pop(new_os_window_trigger, None) if is_macos: from .fast_data_types import cocoa_set_notification_activated_callback cocoa_set_notification_activated_callback(notification_activated) def startup_first_child(self, os_window_id: Optional[int]) -> None: startup_sessions = create_sessions(self.opts, self.args, default_session=self.opts.startup_session) for startup_session in startup_sessions: self.add_os_window(startup_session, os_window_id=os_window_id) os_window_id = None if self.args.start_as != 'normal': if self.args.start_as == 'fullscreen': self.toggle_fullscreen() else: change_os_window_state(self.args.start_as) def add_os_window( self, startup_session: Optional[Session] = None, os_window_id: Optional[int] = None, wclass: Optional[str] = None, wname: Optional[str] = None, opts_for_size: Optional[Options] = None, startup_id: Optional[str] = None ) -> int: if os_window_id is None: opts_for_size = opts_for_size or getattr(startup_session, 'os_window_size', None) or self.opts wclass = wclass or self.args.cls or appname 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(opts_for_size, self.cached_values), pre_show_callback, self.args.title or appname, wname or self.args.name or wclass, wclass) tm = TabManager(os_window_id, self.opts, self.args, startup_session) self.os_window_map[os_window_id] = tm return os_window_id def list_os_windows(self) -> Generator[OSWindowDict, None, None]: with cached_process_data(): active_tab, active_window = self.active_tab, self.active_window active_tab_manager = self.active_tab_manager for os_window_id, tm in self.os_window_map.items(): yield { 'id': os_window_id, 'is_focused': tm is active_tab_manager, 'tabs': list(tm.list_tabs(active_tab, active_window)), } @property def all_tab_managers(self) -> Generator[TabManager, None, None]: yield from self.os_window_map.values() @property def all_tabs(self) -> Generator[Tab, None, None]: for tm in self.all_tab_managers: yield from tm @property def all_windows(self) -> Generator[Window, None, None]: for tab in self.all_tabs: yield from tab def match_windows(self, match: str) -> Generator[Window, None, None]: try: field, exp = match.split(':', 1) except ValueError: return if field == 'num': tab = self.active_tab if tab is not None: try: w = tab.get_nth_window(int(exp)) except Exception: return if w is not None: yield w return if field != 'env': pat: MatchPatternType = re.compile(exp) else: kp, vp = exp.partition('=')[::2] if vp: pat = re.compile(kp), re.compile(vp) else: pat = re.compile(kp), None for window in self.all_windows: if window.matches(field, pat): yield window def tab_for_window(self, window: Window) -> Optional[Tab]: for tab in self.all_tabs: for w in tab: if w.id == window.id: return tab def match_tabs(self, match: str) -> Generator[Tab, None, None]: try: field, exp = match.split(':', 1) except ValueError: return pat = re.compile(exp) found = False if field in ('title', 'id'): for tab in self.all_tabs: if tab.matches(field, pat): yield tab found = True 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) -> Optional[int]: 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) tab.set_active_window(w) if switch_os_window_if_needed and current_os_window() != os_window_id: focus_os_window(os_window_id, True) return os_window_id def _new_os_window(self, args: Union[SpecialWindowInstance, Iterable[str]], cwd_from: Optional[int] = None) -> int: if isinstance(args, SpecialWindowInstance): sw: Optional[SpecialWindowInstance] = args else: sw = self.args_to_special_window(args, cwd_from) if args else None startup_session = next(create_sessions(self.opts, special_window=sw, cwd_from=cwd_from)) return self.add_os_window(startup_session) def new_os_window(self, *args: str) -> None: self._new_os_window(args) @property def active_window_for_cwd(self) -> Optional[Window]: t = self.active_tab if t is not None: return t.active_window_for_cwd def new_os_window_with_cwd(self, *args: str) -> None: w = self.active_window_for_cwd cwd_from = w.child.pid_for_cwd if w is not None else None self._new_os_window(args, cwd_from) def new_os_window_with_wd(self, wd: str) -> None: special_window = SpecialWindow(None, cwd=wd) 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: str, window: Optional[Window] = None, from_peer: bool = False) -> Optional[Dict[str, Any]]: from .remote_control import handle_cmd response = None window = window or None if self.opts.allow_remote_control == 'y' or from_peer or getattr(window, 'allow_remote_control', False): try: response = handle_cmd(self, window, cmd) except Exception as err: import traceback response = {'ok': False, 'error': str(err)} if not getattr(err, 'hide_traceback', False): response['tb'] = traceback.format_exc() else: no_response = False try: no_response = json.loads(cmd).get('no_response') except Exception: pass if not no_response: response = {'ok': False, 'error': 'Remote control is disabled. Add allow_remote_control to your kitty.conf'} return response def remote_control(self, *args: str) -> None: from .remote_control import parse_rc_args from .rc.base import command_for_name, parse_subcommand_cli, PayloadGetter try: global_opts, items = parse_rc_args(['@'] + list(args)) if not items: return cmd = items[0] c = command_for_name(cmd) opts, items = parse_subcommand_cli(c, items) payload = c.message_to_kitty(global_opts, opts, items) c.response_from_kitty(self, self.active_window, PayloadGetter(c, payload if isinstance(payload, dict) else {})) except (Exception, SystemExit) as e: self.show_error(_('remote_control mapping failed'), str(e)) def peer_message_received(self, msg_bytes: bytes) -> Optional[bytes]: cmd_prefix = b'\x1bP@kitty-cmd' terminator = b'\x1b\\' if msg_bytes.startswith(cmd_prefix) and msg_bytes.endswith(terminator): cmd = msg_bytes[len(cmd_prefix):-len(terminator)].decode('utf-8') response = self._handle_remote_command(cmd, from_peer=True) if response is None: return None return cmd_prefix + json.dumps(response).encode('utf-8') + terminator data = json.loads(msg_bytes.decode('utf-8')) if isinstance(data, dict) and data.get('cmd') == 'new_instance': from .cli_stub import CLIOptions startup_id = data.get('startup_id') args, rest = parse_args(data['args'][1:], result_class=CLIOptions) args.args = rest opts = create_opts(args) if not os.path.isabs(args.directory): args.directory = os.path.join(data['cwd'], args.directory) for session in create_sessions(opts, args, respect_cwd=True): os_window_id = self.add_os_window(session, wclass=args.cls, wname=args.name, opts_for_size=opts, startup_id=startup_id) if opts.background_opacity < 1: self._set_os_window_background_opacity(os_window_id, opts.background_opacity) if data.get('notify_on_os_window_death'): self.os_window_death_actions[os_window_id] = partial(self.notify_on_os_window_death, data['notify_on_os_window_death']) else: log_error('Unknown message received from peer, ignoring') return None def handle_remote_cmd(self, cmd: str, window: Optional[Window] = None) -> None: response = self._handle_remote_command(cmd, window) if response is not None: if window is not None: window.send_cmd_response(response) 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: mark_os_window_for_close(src_tab.os_window_id) def on_child_death(self, window_id: int) -> None: window = self.window_id_map.pop(window_id, None) if window is None: return if window.action_on_close: try: window.action_on_close(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) if window.action_on_removal: try: window.action_on_removal(window) except Exception: import traceback traceback.print_exc() window.action_on_close = window.action_on_removal = None def close_window(self, window: Optional[Window] = None) -> None: window = window or self.active_window if window: self.child_monitor.mark_for_close(window.id) def close_tab(self, tab: Optional[Tab] = None) -> None: tab = tab or self.active_tab if tab: for window in tab: self.close_window(window) def toggle_fullscreen(self) -> None: toggle_fullscreen() def toggle_maximized(self) -> None: toggle_maximized() def start(self, first_os_window_id: int) -> None: if not getattr(self, 'io_thread_started', False): self.child_monitor.start() self.io_thread_started = True self.startup_first_child(first_os_window_id) if self.opts.update_check_interval > 0 and not hasattr(self, 'update_check_started'): from .update_check import run_update_check run_update_check(self.opts.update_check_interval * 60 * 60) self.update_check_started = True def activate_tab_at(self, os_window_id: int, x: int) -> int: tm = self.os_window_map.get(os_window_id) if tm is not None: tm.activate_tab_at(x) 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() def clear_terminal(self, action: str, only_active: bool) -> None: if only_active: windows = [] w = self.active_window if w is not None: windows.append(w) else: windows = list(self.all_windows) reset = action == 'reset' how = 3 if action == 'scrollback' else 2 for w in windows: if action == 'scroll': w.screen.scroll_until_cursor() continue w.screen.cursor.x = w.screen.cursor.y = 0 if reset: w.screen.reset() else: w.screen.erase_in_display(how, False) def increase_font_size(self) -> None: # legacy cfs = global_font_size() self.set_font_size(min(self.opts.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(self.opts.font_size) def set_font_size(self, new_size: float) -> None: # legacy self.change_font_size(True, None, new_size) def change_font_size(self, all_windows: bool, increment_operation: Optional[str], amt: float) -> None: def calc_new_size(old_size: float) -> float: new_size = old_size if amt == 0: new_size = self.opts.font_size else: if increment_operation: new_size += (1 if increment_operation == '+' else -1) * amt else: new_size = amt new_size = max(MINIMUM_FONT_SIZE, min(new_size, self.opts.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.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.1, min(opacity, 1.0))) def set_background_opacity(self, opacity: str) -> None: window = self.active_window if window is None or not opacity: return if not self.opts.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 = self.opts.background_opacity else: fin_opacity = float(opacity) self._set_os_window_background_opacity(os_window_id, fin_opacity) @property def active_tab_manager(self) -> Optional[TabManager]: os_window_id = current_os_window() if os_window_id is not None: return self.os_window_map.get(os_window_id) @property def active_tab(self) -> Optional[Tab]: tm = self.active_tab_manager if tm is not None: return tm.active_tab @property def active_window(self) -> Optional[Window]: t = self.active_tab if t is not None: return t.active_window def dispatch_special_key(self, key: int, native_key: int, action: int, mods: int) -> bool: # Handles shortcuts, return True if the key was consumed key_action = get_shortcut(self.keymap, mods, key, native_key) if key_action is None: sequences = get_shortcut(self.opts.sequence_map, mods, key, native_key) if sequences and not isinstance(sequences, KeyAction): self.pending_sequences = sequences set_in_sequence_mode(True) return True elif isinstance(key_action, KeyAction): self.current_key_press_info = key, native_key, action, mods return self.dispatch_action(key_action) def process_sequence(self, key: int, native_key: int, action: Any, mods: int) -> None: if not self.pending_sequences: set_in_sequence_mode(False) return remaining = {} matched_action = None for seq, key_action in self.pending_sequences.items(): if shortcut_matches(seq[0], mods, key, native_key): seq = seq[1:] if seq: remaining[seq] = key_action else: matched_action = key_action if remaining: self.pending_sequences = remaining else: self.pending_sequences = None set_in_sequence_mode(False) if matched_action is not None: self.dispatch_action(matched_action) def start_resizing_window(self) -> None: w = self.active_window if w is None: return overlay_window = self._run_kitten('resize_window', args=[ '--horizontal-increment={}'.format(self.opts.window_resize_step_cells), '--vertical-increment={}'.format(self.opts.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) -> Union[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 default_bg_changed_for(self, window_id: int) -> None: w = self.window_id_map.get(window_id) if w is not None: 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() def dispatch_action(self, key_action: KeyAction) -> bool: if key_action is not None: f = getattr(self, key_action.func, None) if f is not None: if self.args.debug_keyboard: print('Keypress matched action:', func_name(f)) passthrough = f(*key_action.args) if passthrough is not True: return True tab = self.active_tab if tab is None: return False window = self.active_window if 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) if self.args.debug_keyboard: print('Keypress matched action:', func_name(f)) if passthrough is not True: return True return False def combine(self, *actions: KeyAction) -> None: for key_action in actions: self.dispatch_action(key_action) 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 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': text = '\n'.join(parse_uri_list(text)) w.paste(text) def close_os_window(self) -> None: tm = self.active_tab_manager 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) needs_confirmation = tm is not None and self.opts.confirm_os_window_close > 0 and tm.number_of_windows >= self.opts.confirm_os_window_close if not needs_confirmation: mark_os_window_for_close(os_window_id) return if tm is not None: w = tm.active_window self._run_kitten('ask', ['--type=yesno', '--message', _( 'Are you sure you want to close this OS window, it has {}' ' windows running?').format(tm.number_of_windows)], window=w, custom_callback=partial(self.handle_close_os_window_confirmation, os_window_id) ) def handle_close_os_window_confirmation(self, os_window_id: int, data: Dict[str, Any], *a: Any) -> None: if data['response'] == 'y': mark_os_window_for_close(os_window_id) else: mark_os_window_for_close(os_window_id, NO_CLOSE_REQUESTED) def on_os_window_closed(self, os_window_id: int, viewport_width: int, viewport_height: int) -> None: self.cached_values['window-size'] = viewport_width, viewport_height tm = self.os_window_map.pop(os_window_id, None) 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() def quit(self, *args: Any) -> None: tm = self.active_tab num = 0 for q in self.os_window_map.values(): num += q.number_of_windows needs_confirmation = tm is not None and self.opts.confirm_os_window_close > 0 and num >= self.opts.confirm_os_window_close if not needs_confirmation: set_application_quit_request(IMPERATIVE_CLOSE_REQUESTED) return if current_application_quit_request() == CLOSE_BEING_CONFIRMED: return assert tm is not None self._run_kitten('ask', ['--type=yesno', '--message', _( 'Are you sure you want to quit kitty, it has {} windows running?').format(num)], window=tm.active_window, custom_callback=self.handle_quit_confirmation ) set_application_quit_request(CLOSE_BEING_CONFIRMED) def handle_quit_confirmation(self, data: Dict[str, Any], *a: Any) -> None: set_application_quit_request(IMPERATIVE_CLOSE_REQUESTED if data['response'] == 'y' 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: Optional[bytes], cmd: Optional[List[str]]) -> None: tab = self.active_tab if tab is not None: tab.new_special_window( SpecialWindow(cmd, data, _('History'), overlay_for=window.id, cwd=window.cwd_of_child), copy_colors_from=self.active_window ) def edit_config_file(self, *a: Any) -> None: confpath = prepare_config_file_for_editing() # On macOS vim fails to handle SIGWINCH if it occurs early, so add a # small delay. cmd = [kitty_exe(), '+runpy', 'import os, sys, time; time.sleep(0.05); os.execvp(sys.argv[1], sys.argv[1:])'] + get_editor() + [confpath] self.new_os_window(*cmd) def get_output(self, source_window: Window, num_lines: Optional[int] = 1) -> str: output = '' s = source_window.screen if num_lines is None: num_lines = s.lines for i in range(min(num_lines, s.lines)): output += str(s.linebuf.line(i)) return output def _run_kitten( self, kitten: str, args: Iterable[str] = (), input_data: Optional[Union[bytes, str]] = None, window: Optional[Window] = None, custom_callback: Optional[Callable] = None, action_on_removal: Optional[Callable] = None ) -> Any: orig_args, args = list(args), list(args) from kittens.runner import create_kitten_handler end_kitten = create_kitten_handler(kitten, orig_args) if window is None: w = self.active_window tab = self.active_tab else: w = window tab = w.tabref() if w else None if end_kitten.no_ui: return end_kitten(None, getattr(w, 'id', None), self) if w is not None and tab is not None: args[0:0] = [config_dir, kitten] if input_data is None: type_of_input = end_kitten.type_of_input if type_of_input in ('text', 'history', 'ansi', 'ansi-history', 'screen', 'screen-history', 'screen-ansi', 'screen-ansi-history'): data: Optional[bytes] = w.as_text( as_ansi='ansi' in type_of_input, add_history='history' in type_of_input, add_wrap_markers='screen' in type_of_input ).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 type_of_input is None: data = None else: raise ValueError('Unknown type_of_input: {}'.format(type_of_input)) else: data = input_data if isinstance(input_data, bytes) else input_data.encode('utf-8') copts = common_opts_as_dict(self.opts) final_args: List[str] = [] for x in args: if x == '@selection': sel = self.data_for_at(which='@selection', window=w) if sel: x = sel final_args.append(x) overlay_window = tab.new_special_window( SpecialWindow( [kitty_exe(), '+runpy', 'from kittens.runner import main; main()'] + final_args, stdin=data, env={ 'KITTY_COMMON_OPTS': json.dumps(copts), 'KITTY_CHILD_PID': str(w.child.pid), 'PYTHONWARNINGS': 'ignore', 'OVERLAID_WINDOW_LINES': str(w.screen.lines), 'OVERLAID_WINDOW_COLS': str(w.screen.columns), }, cwd=w.cwd_of_child, overlay_for=w.id ), copy_colors_from=w ) wid = w.id overlay_window.action_on_close = partial(self.on_kitten_finish, wid, custom_callback or end_kitten) 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.action_on_removal = callback_wrapper return overlay_window def kitten(self, kitten: str, *args: str) -> None: import shlex cmdline = args[0] if args else '' kargs = shlex.split(cmdline) if cmdline else [] self._run_kitten(kitten, kargs) def on_kitten_finish(self, target_window_id: str, end_kitten: Callable, source_window: Window) -> None: output = self.get_output(source_window, num_lines=None) from kittens.runner import deserialize data = deserialize(output) if data is not None: end_kitten(data, target_window_id, self) def input_unicode_character(self) -> None: self._run_kitten('unicode_input') def set_tab_title(self) -> None: tab = self.active_tab if tab: args = ['--name=tab-title', '--message', _('Enter the new title for this tab below.'), 'do_set_tab_title', str(tab.id)] self._run_kitten('ask', args) def do_set_tab_title(self, title: str, tab_id: int) -> None: tm = self.active_tab_manager if tm is not None and title: tab_id = int(tab_id) for tab in tm.tabs: if tab.id == tab_id: tab.set_title(title) break def show_error(self, title: str, msg: str) -> None: self._run_kitten('show_error', args=['--title', title], input_data=msg) def create_marker(self) -> None: w = 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('ask', [ '--name=create-marker', '--message', _('Create marker, for example:\ntext 1 ERROR\nSee https://sw.kovidgoyal.net/kitty/marks.html\n') ], custom_callback=done, action_on_removal=done2) def kitty_shell(self, window_type: str) -> None: kw: Dict[str, Any] = {} cmd = [kitty_exe(), '@'] aw = self.active_window if aw is not None: kw['env'] = {'KITTY_SHELL_ACTIVE_WINDOW_ID': str(aw.id)} if window_type == 'tab': tab = self._new_tab(SpecialWindow(cmd, **kw)) if tab is not None: for w in tab: w.allow_remote_control = True 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: w.allow_remote_control = True elif window_type == 'overlay': tab = self.active_tab if aw is not None and tab is not None: kw['overlay_for'] = aw.id tab.new_special_window(SpecialWindow(cmd, **kw), allow_remote_control=True) else: tab = self.active_tab if tab is not None: tab.new_special_window(SpecialWindow(cmd, **kw), 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_url(self, url: str, program: Optional[Union[str, List[str]]] = None, cwd: Optional[str] = None) -> None: if url: if isinstance(program, str): program = to_cmdline(program) open_url(url, program or self.opts.open_url_with, cwd=cwd) def open_url_lines(self, lines: Iterable[str], program: Optional[Union[str, List[str]]] = None) -> None: self.open_url(''.join(lines), program) 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(text) def paste_from_clipboard(self) -> None: text = get_clipboard_string() self.paste_to_active_window(text) def paste_from_selection(self) -> None: text = get_primary_selection() if supports_primary_selection else get_clipboard_string() self.paste_to_active_window(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) if self.opts.copy_on_select: self.copy_to_buffer(self.opts.copy_on_select) def copy_to_buffer(self, buffer_name: str) -> None: w = 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) elif buffer_name == 'primary': set_primary_selection(text) else: self.clipboard_buffers[buffer_name] = text def paste_from_buffer(self, buffer_name: str) -> None: if buffer_name == 'clipboard': text: Optional[str] = get_clipboard_string() elif buffer_name == 'primary': text = get_primary_selection() else: text = self.clipboard_buffers.get(buffer_name) if text: self.paste_to_active_window(text) def goto_tab(self, tab_num: int) -> None: tm = self.active_tab_manager 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 def next_tab(self) -> None: tm = self.active_tab_manager if tm is not None: tm.next_tab() def previous_tab(self) -> None: tm = self.active_tab_manager if tm is not None: tm.next_tab(-1) prev_tab = previous_tab def process_stdin_source(self, window: Optional[Window] = None, stdin: Optional[str] = None) -> Tuple[Optional[Dict[str, str]], Optional[bytes]]: 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: 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: Optional[Window] = None, add_wrap_markers: bool = False) -> Optional[str]: 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: Optional[Window] = None, stdin: Optional[str] = None, cwd_from: Optional[int] = 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 run_background_process( self, cmd: List[str], cwd: Optional[str] = None, env: Optional[Dict[str, str]] = None, stdin: Optional[bytes] = None, cwd_from: Optional[int] = None ) -> None: import subprocess if cwd_from: with suppress(Exception): cwd = cwd_of_process(cwd_from) if stdin: r, w = safe_pipe(False) try: subprocess.Popen(cmd, env=env, stdin=r, cwd=cwd) except Exception: os.close(w) else: thread_write(w, stdin) finally: os.close(r) else: subprocess.Popen(cmd, env=env, cwd=cwd) def pipe(self, source: str, dest: str, exe: str, *args: str) -> Window: cmd = [exe] + list(args) window = self.active_window cwd_from = window.child.pid_for_cwd 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) else: set_primary_selection(stdin) else: env, stdin = self.process_stdin_source(stdin=source, window=window) self.run_background_process(cmd, cwd_from=cwd_from, stdin=stdin, env=env) def args_to_special_window(self, args: Iterable[str], cwd_from: Optional[int] = 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: Union[SpecialWindowInstance, Iterable[str]], cwd_from: Optional[int] = None, as_neighbor: bool = False) -> Optional[Tab]: 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) tm = self.active_tab_manager if tm is not None: return tm.new_tab(special_window=special_window, cwd_from=cwd_from, as_neighbor=as_neighbor) def _create_tab(self, args: List[str], cwd_from: Optional[int] = 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) def new_tab(self, *args: str) -> None: self._create_tab(list(args)) def new_tab_with_cwd(self, *args: str) -> None: w = self.active_window_for_cwd cwd_from = w.child.pid_for_cwd if w is not None else None self._create_tab(list(args), cwd_from=cwd_from) def new_tab_with_wd(self, wd: str) -> None: special_window = SpecialWindow(None, cwd=wd) self._new_tab(special_window) def _new_window(self, args: List[str], cwd_from: Optional[int] = None) -> Optional[Window]: tab = self.active_tab if tab is not 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) def new_window(self, *args: str) -> None: self._new_window(list(args)) def new_window_with_cwd(self, *args: str) -> None: w = self.active_window_for_cwd if w is None: return self.new_window(*args) cwd_from = w.child.pid_for_cwd self._new_window(list(args), cwd_from=cwd_from) def launch(self, *args: str) -> None: from kitty.launch import parse_launch_args, launch opts, args_ = parse_launch_args(args) launch(self, opts, args_) def move_tab_forward(self) -> None: tm = self.active_tab_manager if tm is not None: tm.move_tab(1) def move_tab_backward(self) -> None: tm = self.active_tab_manager if tm is not None: tm.move_tab(-1) def disable_ligatures_in(self, where: Union[str, Iterable[Window]], strategy: int) -> None: if isinstance(where, str): windows: List[Window] = [] if where == 'active': if self.active_window is not None: windows = [self.active_window] elif where == 'all': windows = list(self.all_windows) elif where == 'tab': if self.active_tab is not None: windows = list(self.active_tab) else: windows = list(where) for window in windows: window.screen.disable_ligatures = strategy window.refresh() def patch_colors(self, spec: Dict[str, int], cursor_text_color: Union[bool, int, Color], configured: bool = False) -> None: if configured: for k, v in spec.items(): if hasattr(self.opts, k): setattr(self.opts, k, color_from_int(v)) if cursor_text_color is not False: if isinstance(cursor_text_color, int): cursor_text_color = color_from_int(cursor_text_color) self.opts.cursor_text_color = cursor_text_color for tm in self.all_tab_managers: tm.tab_bar.patch_colors(spec) patch_global_colors(spec, configured) def safe_delete_temp_file(self, path: str) -> None: if is_path_in_temp_dir(path): with suppress(FileNotFoundError): os.remove(path) def set_update_check_process(self, process: Optional[PopenType] = 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 on_monitored_pid_death(self, pid: int, exit_status: int) -> None: 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('Failed to read data from update check process, with error: {}'.format(e)) else: try: process_current_release(raw) except Exception as e: log_error('Failed to process update check data {!r}, with error: {}'.format(raw, e)) def dbus_notification_callback(self, activated: bool, a: int, b: Union[int, str]) -> None: from .notify import dbus_notification_created, dbus_notification_activated if activated: assert isinstance(b, str) dbus_notification_activated(a, b) else: assert isinstance(b, int) dbus_notification_created(a, b) def show_bad_config_lines(self, bad_lines: Iterable[BadLine]) -> None: def format_bad_line(bad_line: BadLine) -> str: return '{}:{} in line: {}\n'.format(bad_line.number, bad_line.exception, bad_line.line) msg = '\n'.join(map(format_bad_line, bad_lines)).rstrip() self.show_error(_('Errors in kitty.conf'), msg) def set_colors(self, *args: str) -> None: from kitty.rc.base import parse_subcommand_cli, command_for_name, PayloadGetter from kitty.remote_control import parse_rc_args c = command_for_name('set_colors') opts, items = parse_subcommand_cli(c, ['set-colors'] + list(args)) payload = c.message_to_kitty(parse_rc_args([])[0], opts, items) c.response_from_kitty(self, self.active_window, PayloadGetter(c, payload if isinstance(payload, dict) else {})) def _move_window_to( self, window: Optional[Window] = None, target_tab_id: Optional[Union[str, int]] = None, target_os_window_id: Optional[Union[str, int]] = 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 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 target_tab_id == 'new': 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] target_tab = 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: Optional[Tab] = None, target_os_window_id: Optional[int] = 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 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] == 'new-tab': return self._move_window_to(target_tab_id='new') lines = [ 'Choose a tab to move the window to', '' ] fmt = ': {1}' tab_id_map: Dict[int, Optional[Union[str, int]]] = {} current_tab = self.active_tab done_tab_id: Optional[Union[str, int]] = None for i, tab in enumerate(self.all_tabs): if tab is not current_tab: tab_id_map[len(tab_id_map)] = tab.id lines.append(fmt.format(i + 1, tab.title)) new_idx = len(tab_id_map) + 1 tab_id_map[new_idx - 1] = 'new' lines.append(fmt.format(new_idx, 'New tab')) new_idx = len(tab_id_map) + 1 tab_id_map[new_idx - 1] = None lines.append(fmt.format(new_idx, 'New OS Window')) def done(data: Dict[str, Any], target_window_id: int, self: Boss) -> None: nonlocal done_tab_id done_tab_id = tab_id_map[int(data['groupdicts'][0]['index'])] def done2(target_window_id: int, self: Boss) -> None: tab_id = done_tab_id target_window = None for w in self.all_windows: if w.id == target_window_id: target_window = w break if tab_id is None: self._move_window_to(window=target_window, target_os_window_id='new') else: self._move_window_to(window=target_window, target_tab_id=tab_id) self._run_kitten( 'hints', args=( '--ascending', '--customize-processing=::import::kitty.choose_entry', r'--regex=(?m)^:\s+.+$', ), input_data='\r\n'.join(lines).encode('utf-8'), custom_callback=done, action_on_removal=done2 ) def detach_tab(self, *args: str) -> None: if not args or args[0] == 'new': return self._move_tab_to() lines = [ 'Choose an OS window to move the tab to', '' ] fmt = ': {1}' os_window_id_map: Dict[int, Optional[int]] = {} current_os_window = getattr(self.active_tab, 'os_window_id', 0) done_osw: Optional[int] = None done_called = False for i, osw in enumerate(self.os_window_map): tm = self.os_window_map[osw] if current_os_window != osw and tm.active_tab and tm.active_tab: os_window_id_map[len(os_window_id_map)] = osw lines.append(fmt.format(i + 1, tm.active_tab.title)) new_idx = len(os_window_id_map) + 1 os_window_id_map[new_idx - 1] = None lines.append(fmt.format(new_idx, 'New OS Window')) def done(data: Dict[str, Any], target_window_id: int, self: Boss) -> None: nonlocal done_called, done_osw done_osw = os_window_id_map[int(data['groupdicts'][0]['index'])] done_called = True def done2(target_window_id: int, self: Boss) -> None: if not done_called: return os_window_id = done_osw target_tab = self.active_tab for w in self.all_windows: if w.id == target_window_id: target_tab = w.tabref() break if target_tab and target_tab.os_window_id == os_window_id: return self._move_tab_to(tab=target_tab, target_os_window_id=os_window_id) self._run_kitten( 'hints', args=( '--ascending', '--customize-processing=::import::kitty.choose_entry', r'--regex=(?m)^:\s+.+$', ), input_data='\r\n'.join(lines).encode('utf-8'), custom_callback=done, action_on_removal=done2 ) def set_background_image(self, path: Optional[str], os_windows: Tuple[int, ...], configured: bool, layout: Optional[str]) -> None: if layout: set_background_image(path, os_windows, configured, layout) else: set_background_image(path, os_windows, configured) for os_window_id in os_windows: self.default_bg_changed_for(os_window_id)