Режим Vi

Введение

Режим VI в Kate — это проект по внедрению модального редактирования в стиле Vim в текстовый редактор Kate и, как следствие, в другие приложения KDE, использующие тот же компонент редактора. Проект стартовал в рамках Google Summer of Code в 2008 году, когда была написана вся базовая функциональность. С тех пор я продолжаю поддерживать и развивать этот код, и количество функций Vim, которые ещё не реализованы, постепенно сокращается. Большинство пользователей Vim уже смогут продуктивно работать в режиме VI Kate. Список отсутствующих возможностей приведён внизу страницы.

На этой странице представлен обновлённый обзор этой работы.

Цели

Цель режима VI — не полная замена Vim и поддержка всех его возможностей. Его задача — сделать «вимовский» способ редактирования текста и привычки, усвоенные в Vim, доступными для приложений, использующих текстовый редактор Kate в качестве встроенного. К таким приложениям относятся

1. Текстовый редактор Kate
2. KWrite — простой текстовый редактор KDE
3. KDevelop — расширенная среда разработки для многих языков программирования
4. Kile — редактор LaTeX

Режим VI предназначен для удобной интеграции с приложениями и в разумных пределах отклоняется от поведения Vim. Например, команда :w в режиме VI Kate откроет диалог сохранения.

Несовместимость с Vim

В режиме VI редактора Kate есть лишь несколько функций, несовместимых с Vim (не считая отсутствующих). Они перечислены ниже вместе с соответствующими причинами.

1. Kate: U и Ctrl+R — повтор
   Vim: Ctrl+R — обычный повтор, U используется для отмены всех последних изменений в строке
   В режиме VI Kate U действует как повтор, поскольку комбинация Ctrl+R по умолчанию занята функцией замены Kate (поиск и замена). По умолчанию режим VI не переопределяет комбинации клавиш Kate (это можно настроить в «Настройки → Настроить Kate… → Редактирование → Режим ввода VI»), поэтому действие повтора должно быть доступно и как «обычное» нажатие клавиши. Кроме того, поведение команды U в Vim плохо соотносится с внутренней системой отмены Kate, так что её поддержка была бы нетривиальной.
2. Kate: :print открывает диалог «Печать»
   Vim: :print выводит строки заданного диапазона, как в его предке ed. Команды вроде :print доступны не только в режиме VI, но и для пользователей «обычной» Kate. Поэтому было решено, что команда :print будет открывать диалог печати — следуя принципу наименьшего удивления, а не копируя поведение Vim.
3. Kate: Y копирует до конца строки.
   Vim: Y копирует всю строку, как и yy. Поведение VI для команды Y фактически является ошибкой; для команд изменения и удаления cc/dd выполняют действие над текущей строкой, а C/D работают от позиции курсора до конца строки. Однако и yy, и Y копируют текущую строку. В режиме VI Kate команда Y копирует до конца строки. Это описано как «более логичное» в документации Vim.
4. Kate: :map изменяет выбранные строки документа с помощью заданного выражения JavaScript.
   Vim: :map добавляет заданное сопоставление в обычный и визуальный режимы. Команда «map» уже была зарезервирована Kate; начиная с версии 4.12, для её замены можно использовать комбинацию :nmap и :vmap.

Поддерживаемые команды

Поддерживаемые команды обычного/визуального режимов

Поддерживаемые перемещения

Supported text objects

Поддерживаемые команды режима вставки

The Comma Text Object

This is something that I have been missing in Vim. The comma text object makes it easy to modify parameter lists in C-like languages and other comma separated lists. It is basically the area between two commas or between a comma and a bracket. In the line shown in the illustration to the right, the three ranges this text object can span are highlighted in red.

Comma text object ranges. If the cursor is over, say, “arg2”, pressing c i , (“change inner comma”) would delete “double arg2” and place the cursor between the two commas in insert mode. A very convenient way to change a function's parameters.

Emulated Vim Command Bar

Kate 4.11 introduced a hidden config option that make /, ? and : bring up a new search/ command in place of the usual Kate Find / Replace / Command-line bar. The bar is intended to replicate many of the features of Vim's command bar, and also to fix many of the issues with Kate Vim mode's interaction with Kate's Find/Replace bar (interactive replace not working; incremental search not positioning the cursor correctly; not usable in mappings/macros; etc).

The following shortcuts are provided by the emulated command bar; as with Vim, these can be remapped with cmap, cnoremap, etc:

The "context-specific completion" is decided as follows:

• In a search bar (/ or ?), auto-complete from search history (which includes searches initiated via *; and #; searches done in sed-replace expressions; etc.)
• In an empty command bar (:), auto-complete from command history (NB: auto-completion of command names is invoked automatically when you begin typing).
• In a command-bar containing a sed-replace expression (e.g. :s/find/replace/gc), if the cursor is positioned over "find", auto-complete from the "search" history; if over the "replace", auto-complete from the history of "replace" terms.

When executing a sed-replace expression in the command bar with the "c" flag (e.g. s/find/replace/gc), a Vim-style interactive search/replace expression will be initiated.

Some example usages of the emulated command bar, with GIF animations, are given in this blog. In 4.11, the emulated command bar can be enabled by setting the hidden config option "Vi Input Mode Emulate Command Bar" to true in your katerc/kwriterc/kdeveloprc.

Missing Features

As stated earlier, the goal of Kate's VI Mode is not to support 100% of Vim's features, however, there are some features which are sorely missed

• Visual block mode – especially the ability to prepend/append text to the visual block selection.
• Having ex commands available in other programs than the Kate application.
• The search code needs improvement and the * and # commands should just be regular searches.

If you miss other features or want to help on the ones mentioned above, feel free to contact me or send patches! :-)

Change Log

• 2010-05-16:
  Initial version. Collected the information from blog entries and README files to make a single source of current information.
• 2010-05-17:
  Ctrl+A and Ctrl+X added (increment/decrement number under cursor).
• 2010-08-30:
  Moved page to kate-editor.org.
• 2010-09-10:
  Fixed the text on the comma text object and made some formatting fixes
• 2021-02-03:
  Converted key-binding tables to markdown for hugo.