KittyPatch/kitty
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Document more commands

Browse Source
This commit is contained in:
Kovid Goyal 2019-06-12 15:01:14 +05:30
parent 962291cc8e
commit 3d01565ba7
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
1 changed files with 21 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
kitty/cmds.py
View File

@ -627,7 +627,6 @@ def cmd_new_window(global_opts, opts, args):
cwd: Working directory for the new window cwd: Working directory for the new window
tab_title: Title for the new tab tab_title: Title for the new tab
window_type: One of :code:`kitty` or :code:`os` window_type: One of :code:`kitty` or :code:`os`
no_response: Boolean indicating whether to send a response or not
keep_focus: Boolean indicating whether the current window should retain focus or not keep_focus: Boolean indicating whether the current window should retain focus or not
''' '''
if opts.no_response: if opts.no_response:
@ -690,14 +689,18 @@ the command will exit with a success code.
''' '''
) )
def cmd_focus_window(global_opts, opts, args): def cmd_focus_window(global_opts, opts, args):
'''
match: The tab to open the new window in
'''
if opts.no_response: if opts.no_response:
global_opts.no_command_response = True global_opts.no_command_response = True
return {'match': opts.match, 'no_response': opts.no_response} return {'match': opts.match, 'no_response': opts.no_response}
def focus_window(boss, window, payload): def focus_window(boss, window, payload):
pg = cmd_focus_window.payload_get
windows = [window or boss.active_window] windows = [window or boss.active_window]
match = payload['match'] match = pg(payload, 'match')
if match: if match:
windows = tuple(boss.match_windows(match)) windows = tuple(boss.match_windows(match))
if not windows: if not windows:
@ -727,13 +730,17 @@ using this option means that you will not be notified of failures.
no_response=True, no_response=True,
) )
def cmd_focus_tab(global_opts, opts, args): def cmd_focus_tab(global_opts, opts, args):
'''
match: The tab to focus
'''
if opts.no_response: if opts.no_response:
global_opts.no_command_response = True global_opts.no_command_response = True
return {'match': opts.match} return {'match': opts.match}
def focus_tab(boss, window, payload): def focus_tab(boss, window, payload):
match = payload['match'] pg = cmd_focus_tab.payload_get
match = pg(payload, 'match')
tabs = tuple(boss.match_tabs(match)) tabs = tuple(boss.match_tabs(match))
if not tabs: if not tabs:
raise MatchError(match, 'tabs') raise MatchError(match, 'tabs')
@ -767,22 +774,29 @@ If specified get text from the window this command is run in, rather than the ac
argspec='' argspec=''
) )
def cmd_get_text(global_opts, opts, args): def cmd_get_text(global_opts, opts, args):
'''
match: The tab to focus
extent: One of :code:`screen`, :code:`all`, or :code:`selection`
ansi: Boolean, if True send ANSI formatting codes
self: Boolean, if True use window command was run in
'''
return {'match': opts.match, 'extent': opts.extent, 'ansi': opts.ansi, 'self': opts.self} return {'match': opts.match, 'extent': opts.extent, 'ansi': opts.ansi, 'self': opts.self}
def get_text(boss, window, payload): def get_text(boss, window, payload):
match = payload['match'] pg = cmd_get_text.payload_get
match = pg(payload, 'match')
if match: if match:
windows = tuple(boss.match_windows(match)) windows = tuple(boss.match_windows(match))
if not windows: if not windows:
raise MatchError(match) raise MatchError(match)
else: else:
windows = [window if window and payload['self'] else boss.active_window] windows = [window if window and pg(payload, 'self') else boss.active_window]
window = windows[0] window = windows[0]
if payload['extent'] == 'selection': if pg(payload, 'extent') == 'selection':
ans = window.text_for_selection() ans = window.text_for_selection()
else: else:
ans = window.as_text(as_ansi=bool(payload['ansi']), add_history=payload['extent'] == 'all') ans = window.as_text(as_ansi=bool(pg(payload, 'ansi')), add_history=pg(payload, 'extent') == 'all')
return ans return ans
# }}} # }}}