vith 0.9.0__py3-none-any.whl

vith/commands/commands.py

@@ -0,0 +1,811 @@
+from __future__ import print_function
+
+import os
+import re
+from typing import Any, Dict, Set
+
+from prompt_toolkit.application import run_in_terminal
+from prompt_toolkit.document import Document
+
+__all__ = (
+    'has_command_handler',
+    'call_command_handler',
+)
+
+
+COMMANDS_TO_HANDLERS: Dict[str, Any] = {}  # Global mapping Vi commands to their handler.
+COMMANDS_TAKING_LOCATIONS: Set[str] = set()  # Name of commands that accept locations.
+SET_COMMANDS: Dict[str, Any] = {}  # Mapping ':set'-commands to their handler.
+SET_COMMANDS_TAKING_VALUE: Set[str] = set()
+
+
+_NO_WRITE_SINCE_LAST_CHANGE_TEXT = 'No write since last change (add ! to override)'
+_NO_FILE_NAME = 'No file name'
+
+
+def has_command_handler(command):
+    return command in COMMANDS_TO_HANDLERS
+
+
+def call_command_handler(command, editor, variables):
+    """
+    Execute command.
+    """
+    COMMANDS_TO_HANDLERS[command](editor, variables)
+
+
+def get_commands():
+    return COMMANDS_TO_HANDLERS.keys()
+
+
+def get_commands_taking_locations():
+    return COMMANDS_TAKING_LOCATIONS
+
+
+# Decorators
+
+
+def _cmd(name):
+    """
+    Base decorator for registering commands in this namespace.
+    """
+
+    def decorator(func):
+        COMMANDS_TO_HANDLERS[name] = func
+        return func
+
+    return decorator
+
+
+def location_cmd(name, accepts_force=False):
+    """
+    Decorator that registers a command that takes a location as (optional)
+    parameter.
+    """
+    COMMANDS_TAKING_LOCATIONS.add(name)
+
+    def decorator(func):
+        @_cmd(name)
+        def command_wrapper(editor, variables):
+            location = variables.get('location')
+            force = bool(variables['force'])
+
+            if force and not accepts_force:
+                editor.show_message('No ! allowed')
+            elif accepts_force:
+                func(editor, location, force=force)
+            else:
+                func(editor, location)
+
+        return func
+
+    return decorator
+
+
+def cmd(name, accepts_force=False):
+    """
+    Decorator that registers a command that doesn't take any parameters.
+    """
+
+    def decorator(func):
+        @_cmd(name)
+        def command_wrapper(editor, variables):
+            force = bool(variables['force'])
+
+            if force and not accepts_force:
+                editor.show_message('No ! allowed')
+            elif accepts_force:
+                func(editor, force=force)
+            else:
+                func(editor)
+
+        return func
+
+    return decorator
+
+
+def set_cmd(name, accepts_value=False):
+    """
+    Decorator that registers a ':set'-command.
+    """
+
+    def decorator(func):
+        SET_COMMANDS[name] = func
+        if accepts_value:
+            SET_COMMANDS_TAKING_VALUE.add(name)
+        return func
+
+    return decorator
+
+
+# Actual command implementations
+
+
+@_cmd('set')
+def set_command_execute(editor, variables):
+    """
+    Execute a ':set' command.
+    """
+    option = variables.get('set_option')
+    value = variables.get('set_value')
+
+    if option in SET_COMMANDS:
+        # Call the correct handler.
+        if option in SET_COMMANDS_TAKING_VALUE:
+            SET_COMMANDS[option](editor, value)
+        else:
+            SET_COMMANDS[option](editor)
+    else:
+        editor.show_message('Unknown option: %s' % option)
+
+
+@cmd('bn', accepts_force=True)
+def _bn(editor, force=False):
+    """
+    Go to next buffer.
+    """
+    eb = editor.window_arrangement.active_editor_buffer
+
+    if not force and eb.has_unsaved_changes:
+        editor.show_message(_NO_WRITE_SINCE_LAST_CHANGE_TEXT)
+    else:
+        editor.window_arrangement.go_to_next_buffer()
+
+
+@cmd('bp', accepts_force=True)
+def _bp(editor, force=False):
+    """
+    Go to previous buffer.
+    """
+    eb = editor.window_arrangement.active_editor_buffer
+
+    if not force and eb.has_unsaved_changes:
+        editor.show_message(_NO_WRITE_SINCE_LAST_CHANGE_TEXT)
+    else:
+        editor.window_arrangement.go_to_previous_buffer()
+
+
+@cmd('only')
+def only(editor):
+    """
+    Keep only the current window.
+    """
+    editor.window_arrangement.keep_only_current_window()
+
+
+@cmd('hide')
+def hide(editor):
+    """
+    Hide the current window.
+    """
+    editor.window_arrangement.close_window()
+
+
+@location_cmd('sp')
+@location_cmd('split')
+def horizontal_split(editor, location):
+    """
+    Split window horizontally.
+    """
+    editor.window_arrangement.hsplit(location or None)
+
+
+@location_cmd('vsp')
+@location_cmd('vsplit')
+def vertical_split(editor, location):
+    """
+    Split window vertically.
+    """
+    editor.window_arrangement.vsplit(location or None)
+
+
+@cmd('new')
+def new_buffer(editor):
+    """
+    Create new buffer.
+    """
+    editor.window_arrangement.hsplit(new=True)
+
+
+@cmd('vnew')
+def new_vertical_buffer(editor):
+    """
+    Create new buffer, splitting vertically.
+    """
+    editor.window_arrangement.vsplit(new=True)
+
+
+@location_cmd('badd')
+def buffer_add(editor, location):
+    """
+    Add a new buffer.
+    """
+    editor.window_arrangement.open_buffer(location)
+
+
+@cmd('buffers')
+def buffer_list(editor):
+    """
+    List all buffers.
+    """
+
+    def handler():
+        wa = editor.window_arrangement
+        for info in wa.list_open_buffers():
+            char = '%' if info.is_active else ''
+            eb = info.editor_buffer
+            print(
+                ' %3i %-2s %-20s  line %i'
+                % (info.index, char, eb.location, (eb.buffer.document.cursor_position_row + 1))
+            )
+        input('\nPress ENTER to continue...')
+
+    run_in_terminal(handler)
+
+
+@_cmd('b')
+@_cmd('buffer')
+def _buffer(editor, variables):
+    """
+    Go to one of the open buffers.
+    """
+    eb = editor.window_arrangement.active_editor_buffer
+    force = bool(variables['force'])
+
+    buffer_name = variables.get('buffer_name')
+    if buffer_name:
+        if not force and eb.has_unsaved_changes:
+            editor.show_message(_NO_WRITE_SINCE_LAST_CHANGE_TEXT)
+        else:
+            editor.window_arrangement.go_to_buffer(buffer_name)
+
+
+@cmd('bw', accepts_force=True)
+@cmd('bd', accepts_force=True)
+def buffer_wipe(editor, force=False):
+    """
+    Wipe buffer.
+    """
+    eb = editor.window_arrangement.active_editor_buffer
+    if not force and eb.has_unsaved_changes:
+        editor.show_message(_NO_WRITE_SINCE_LAST_CHANGE_TEXT)
+    else:
+        editor.window_arrangement.close_buffer()
+
+
+@location_cmd('o', accepts_force=True)
+@location_cmd('open', accepts_force=True)
+@location_cmd('e', accepts_force=True)
+@location_cmd('edit', accepts_force=True)
+def buffer_edit(editor, location, force=False):
+    """
+    Edit new buffer.
+    """
+    if location is None:
+        # Edit/open without a location will reload the current file, if there are
+        # no changes.
+        eb = editor.window_arrangement.active_editor_buffer
+        if eb.location is None:
+            editor.show_message(_NO_FILE_NAME)
+        elif not force and eb.has_unsaved_changes:
+            editor.show_message(_NO_WRITE_SINCE_LAST_CHANGE_TEXT)
+        else:
+            eb.reload()
+    else:
+        editor.window_arrangement.open_buffer(location, show_in_current_window=True)
+
+
+@cmd('q', accepts_force=True)
+@cmd('quit', accepts_force=True)
+def quit(editor, all_=False, force=False):
+    """
+    Quit.
+    """
+    ebs = editor.window_arrangement.editor_buffers
+
+    # When there are buffers that have unsaved changes, show balloon.
+    if not force and any(eb.has_unsaved_changes for eb in ebs):
+        editor.show_message(_NO_WRITE_SINCE_LAST_CHANGE_TEXT)
+
+    # When there is more than one buffer open.
+    elif not all_ and len(ebs) > 1:
+        editor.show_message('%i more files to edit' % (len(ebs) - 1))
+
+    else:
+        editor.application.exit()
+
+
+@cmd('qa', accepts_force=True)
+@cmd('qall', accepts_force=True)
+def quit_all(editor, force=False):
+    """
+    Quit all.
+    """
+    quit(editor, all_=True, force=force)
+
+
+@location_cmd('w', accepts_force=True)
+@location_cmd('write', accepts_force=True)
+def write(editor, location, force=False):
+    """
+    Write file. Returns whether the buffer was written.
+    """
+    if location and not force and os.path.exists(os.path.expanduser(location)):
+        editor.show_message('File exists (add ! to override)')
+        return False
+    eb = editor.window_arrangement.active_editor_buffer
+    if location is None and eb.location is None:
+        editor.show_message(_NO_FILE_NAME)
+        return False
+    return eb.write(location)
+
+
+@location_cmd('wq', accepts_force=True)
+def write_and_quit(editor, location, force=False):
+    """
+    Write file and quit. Does not quit when the write failed.
+    """
+    if write(editor, location, force=force):
+        editor.application.exit()
+
+
+@cmd('cq')
+def quit_nonzero(editor):
+    """
+    Quit with non zero exit status.
+    """
+    # Note: the try/finally in `prompt_toolkit.Interface.read_input`
+    # will ensure that the render output is reset, leaving the alternate
+    # screen before quitting.
+    editor.application.exit()
+
+
+@cmd('wqa')
+def write_and_quit_all(editor):
+    """
+    Write current buffer and quit all.
+    """
+    eb = editor.window_arrangement.active_editor_buffer
+    if eb.location is None:
+        editor.show_message(_NO_FILE_NAME)
+    elif eb.write():
+        quit(editor, all_=True, force=False)
+
+
+@cmd('h')
+@cmd('help')
+def help(editor):
+    """
+    Show help.
+    """
+    editor.show_help()
+
+
+@location_cmd('tabe')
+@location_cmd('tabedit')
+@location_cmd('tabnew')
+def tab_new(editor, location):
+    """
+    Create new tab page.
+    """
+    editor.window_arrangement.create_tab(location or None)
+
+
+@cmd('tabclose')
+@cmd('tabc')
+def tab_close(editor):
+    """
+    Close tab page.
+    """
+    editor.window_arrangement.close_tab()
+
+
+@cmd('tabnext')
+@cmd('tabn')
+def tab_next(editor):
+    """
+    Go to next tab.
+    """
+    editor.window_arrangement.go_to_next_tab()
+
+
+@cmd('tabprevious')
+@cmd('tabp')
+def tab_previous(editor):
+    """
+    Go to previous tab.
+    """
+    editor.window_arrangement.go_to_previous_tab()
+
+
+@cmd('pwd')
+def pwd(editor):
+    "Print working directory."
+    directory = os.getcwd()
+    editor.show_message('{}'.format(directory))
+
+
+@location_cmd('cd', accepts_force=False)
+def cd(editor, location):
+    "Change working directory."
+    target = os.path.expanduser(location or '~')
+    try:
+        os.chdir(target)
+    except OSError as e:
+        editor.show_message('{}'.format(e))
+
+
+@_cmd('colorscheme')
+@_cmd('colo')
+def color_scheme(editor, variables):
+    """
+    Apply a colorscheme by name.
+    """
+    colorscheme = variables.get('colorscheme')
+    if colorscheme:
+        editor.use_colorscheme(colorscheme)
+
+
+@set_cmd('nu')
+@set_cmd('number')
+def line_numbers_show(editor):
+    """Show line numbers."""
+    editor.show_line_numbers = True
+
+
+@set_cmd('nonu')
+@set_cmd('nonumber')
+def line_numbers_hide(editor):
+    """Hide line numbers."""
+    editor.show_line_numbers = False
+
+
+@set_cmd('hlsearch')
+@set_cmd('hls')
+def search_highlight(editor):
+    """Highlight search matches."""
+    editor.highlight_search = True
+
+
+@set_cmd('nohlsearch')
+@set_cmd('nohls')
+def search_no_highlight(editor):
+    """Don't highlight search matches."""
+    editor.highlight_search = False
+
+
+@set_cmd('paste')
+def paste_mode(editor):
+    """Enter paste mode."""
+    editor.paste_mode = True
+
+
+@set_cmd('nopaste')
+def paste_mode_leave(editor):
+    """Leave paste mode."""
+    editor.paste_mode = False
+
+
+@set_cmd('ruler')
+@set_cmd('ru')
+def ruler_show(editor):
+    """Show ruler."""
+    editor.show_ruler = True
+
+
+@set_cmd('noruler')
+@set_cmd('noru')
+def ruler_hide(editor):
+    """Hide ruler."""
+    editor.show_ruler = False
+
+
+@set_cmd('wildmenu')
+@set_cmd('wmnu')
+def wild_menu_show(editor):
+    """Show wildmenu."""
+    editor.show_wildmenu = True
+
+
+@set_cmd('nowildmenu')
+@set_cmd('nowmnu')
+def wild_menu_hide(editor):
+    """Hide wildmenu."""
+    editor.show_wildmenu = False
+
+
+@set_cmd('expandtab')
+@set_cmd('et')
+def tab_expand(editor):
+    """Enable tab expension."""
+    editor.expand_tab = True
+
+
+@set_cmd('noexpandtab')
+@set_cmd('noet')
+def tab_no_expand(editor):
+    """Disable tab expension."""
+    editor.expand_tab = False
+
+
+def _set_int_option(editor, value, attribute, display_name, minimum):
+    """
+    Shared implementation of the integer-valued `:set` handlers.
+
+    `value is None` displays the current value; invalid input shows vim-like
+    error messages; otherwise the attribute is set when `value >= minimum`.
+    """
+    if value is None:
+        editor.show_message('%s=%i' % (display_name, getattr(editor, attribute)))
+        return
+    try:
+        number = int(value)
+    except ValueError:
+        editor.show_message('Number required after =')
+        return
+    if number < minimum:
+        editor.show_message('Argument must be positive')
+    else:
+        setattr(editor, attribute, number)
+
+
+@set_cmd('tabstop', accepts_value=True)
+@set_cmd('ts', accepts_value=True)
+def tab_stop(editor, value):
+    """
+    Set tabstop.
+    """
+    _set_int_option(editor, value, 'tabstop', 'tabstop', minimum=1)
+
+
+@set_cmd('scrolloff', accepts_value=True)
+@set_cmd('so', accepts_value=True)
+def set_scroll_offset(editor, value):
+    """
+    Set scroll offset.
+    """
+    _set_int_option(editor, value, 'scroll_offset', 'scrolloff', minimum=0)
+
+
+@set_cmd('incsearch')
+@set_cmd('is')
+def incsearch_enable(editor):
+    """Enable incsearch."""
+    editor.incsearch = True
+
+
+@set_cmd('noincsearch')
+@set_cmd('nois')
+def incsearch_disable(editor):
+    """Disable incsearch."""
+    editor.incsearch = False
+
+
+@set_cmd('ignorecase')
+@set_cmd('ic')
+def search_ignorecase(editor):
+    """Enable case insensitive searching."""
+    editor.ignore_case = True
+
+
+@set_cmd('noignorecase')
+@set_cmd('noic')
+def search_no_ignorecase(editor):
+    """Disable case insensitive searching."""
+    editor.ignore_case = False
+
+
+@set_cmd('list')
+def unprintable_show(editor):
+    """Display unprintable characters."""
+    editor.display_unprintable_characters = True
+
+
+@set_cmd('nolist')
+def unprintable_hide(editor):
+    """Hide unprintable characters."""
+    editor.display_unprintable_characters = False
+
+
+@set_cmd('jedi')
+def jedi_enable(editor):
+    """Enable Jedi autocompletion for Python files."""
+    editor.enable_jedi = True
+
+
+@set_cmd('nojedi')
+def jedi_disable(editor):
+    """Disable Jedi autocompletion."""
+    editor.enable_jedi = False
+
+
+@set_cmd('relativenumber')
+@set_cmd('rnu')
+def relative_number(editor):
+    "Enable relative number"
+    editor.relative_number = True
+
+
+@set_cmd('norelativenumber')
+@set_cmd('nornu')
+def no_relative_number(editor):
+    "Disable relative number"
+    editor.relative_number = False
+
+
+@set_cmd('wrap')
+def enable_wrap(editor):
+    "Enable line wrapping."
+    editor.wrap_lines = True
+
+
+@set_cmd('nowrap')
+def disable_wrap(editor):
+    "disable line wrapping."
+    editor.wrap_lines = False
+
+
+@set_cmd('breakindent')
+@set_cmd('bri')
+def enable_breakindent(editor):
+    "Enable the breakindent option."
+    editor.break_indent = True
+
+
+@set_cmd('nobreakindent')
+@set_cmd('nobri')
+def disable_breakindent(editor):
+    "Disable the breakindent option."
+    editor.break_indent = False
+
+
+@set_cmd('mouse')
+def enable_mouse(editor):
+    "Enable mouse ."
+    editor.enable_mouse_support = True
+
+
+@set_cmd('nomouse')
+def disable_mouse(editor):
+    "Disable mouse."
+    editor.enable_mouse_support = False
+
+
+@set_cmd('tildeop')
+@set_cmd('top')
+def enable_tildeop(editor):
+    "Enable tilde operator."
+    editor.application.vi_state.tilde_operator = True
+
+
+@set_cmd('notildeop')
+@set_cmd('notop')
+def disable_tildeop(editor):
+    "Disable tilde operator."
+    editor.application.vi_state.tilde_operator = False
+
+
+@set_cmd('cursorline')
+@set_cmd('cul')
+def enable_cursorline(editor):
+    "Highlight the line that contains the cursor."
+    editor.cursorline = True
+
+
+@set_cmd('nocursorline')
+@set_cmd('nocul')
+def disable_cursorline(editor):
+    "No cursorline."
+    editor.cursorline = False
+
+
+@set_cmd('cursorcolumn')
+@set_cmd('cuc')
+def enable_cursorcolumn(editor):
+    "Highlight the column that contains the cursor."
+    editor.cursorcolumn = True
+
+
+@set_cmd('nocursorcolumn')
+@set_cmd('nocuc')
+def disable_cursorcolumn(editor):
+    "No cursorcolumn."
+    editor.cursorcolumn = False
+
+
+@set_cmd('colorcolumn', accepts_value=True)
+@set_cmd('cc', accepts_value=True)
+def set_colorcolumn(editor, value):
+    try:
+        if value:
+            numbers = [int(val) for val in value.split(',')]
+        else:
+            numbers = []
+    except ValueError:
+        editor.show_message('Invalid value. Expecting comma separated list of integers')
+    else:
+        editor.colorcolumn = numbers
+
+
+def substitute(editor, range_start, range_end, search, replace, flags):
+    """Substitute /search/ with /replace/ over a range of text"""
+
+    search_state = editor.application.current_search_state
+    buffer = editor.current_editor_buffer.buffer
+    cursor_position_row = buffer.document.cursor_position_row
+
+    # Resolve search pattern from history when omitted.
+    if not search:
+        search = search_state.text
+    if not search:
+        editor.show_message('No previous regular expression')
+        return
+
+    if replace is None:
+        replace = editor.last_substitute_text
+
+    # Compile the regex once; reject malformed patterns up front.
+    regex_flags = re.IGNORECASE if getattr(editor, 'ignore_case', False) else 0
+    try:
+        pattern = re.compile(search, flags=regex_flags)
+    except re.error as e:
+        editor.show_message('Invalid regex: %s' % e)
+        return
+
+    # Convert and validate the captured range.
+    if not range_start:
+        assert not range_end
+        range_start_row = range_end_row = cursor_position_row
+    else:
+        range_start_row = int(range_start) - 1
+        range_end_row = int(range_end) - 1 if range_end else range_start_row
+    if not 0 <= range_start_row <= range_end_row < len(buffer.document.lines):
+        editor.show_message('E19: No such line in current buffer')
+        return
+    line_numbers = list(range(range_start_row, range_end_row + 1))
+
+    sub_count = 0 if 'g' in flags else 1
+
+    # Transform each line once, tracking the last substituted row and
+    # rejecting invalid replacement escapes without mutating the buffer.
+    buffer_lines = buffer.document.lines
+    substituted = {}
+    last_substituted_row = None
+    regex_error = None
+    for row in line_numbers:
+        original = buffer_lines[row]
+        try:
+            result = pattern.sub(replace, original, count=sub_count)
+        except re.error as e:
+            regex_error = e
+            break
+        substituted[row] = result
+        if result != original:
+            last_substituted_row = row
+
+    if regex_error is not None:
+        editor.show_message('Invalid regex: %s' % regex_error)
+        return
+
+    if last_substituted_row is None:
+        editor.show_message('Pattern not found')
+        return
+
+    # Apply substitution.
+    buffer.save_to_undo_stack()
+    lines = list(buffer.document.lines)
+    for row in line_numbers:
+        lines[row] = substituted[row]
+    new_text = "\n".join(lines)
+
+    doc = Document(new_text)
+    buffer.document = doc
+    row = last_substituted_row
+    buffer.cursor_position = doc.translate_row_col_to_index(row, 0) + (
+        len(doc.lines[row]) - len(doc.lines[row].lstrip())
+    )
+    buffer._search(search_state, include_current_position=True)
+
+    # update editor state
+    editor.last_substitute_text = replace
+    search_state.text = search