Режим 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

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

Текстовый объект, ограниченный запятыми

Это то, чего мне не хватало в Vim. Текстовый объект, ограниченный запятыми, упрощает изменение списков параметров в языках, подобных C, и других списков, разделённых запятыми. По сути, это область между двумя запятыми или между запятой и скобкой. В строке, показанной на иллюстрации справа, три диапазона, которые может охватывать этот текстовый объект, выделены красным.

Диапазоны текстовых объектов с запятыми. Если курсор находится, например, над «arg2», при нажатии c i , («изменить внутреннюю запятую») удаляется «double arg2», и курсор помещается между двумя запятыми в режиме вставки. Очень удобный способ изменения параметров функции.

Эмулированная командная строка Vim

В Kate 4.11 добавлен скрытый параметр, позволяющий символам «/», «?» и «:» открывать новую панель поиска/команд вместо обычной панели поиска, замены и командной строки Kate. Панель предназначена для воспроизведения многих функций командной строки Vim, а также для устранения множества проблем взаимодействия режима Vim в Kate с панелью поиска и замены Kate (интерактивная замена не работает; инкрементный поиск не позиционирует курсор правильно; не может использоваться в назначениях/макросах и т. д.).

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.)
• В пустой командной строке (:) выполняется автодополнение из журнала команд (NB: автодополнение имён команд вызывается автоматически при начале ввода).
• В командной строке, содержащей выражение замены sed (например, :s/find/replace/ gc), при нахождении курсора над «find» выполняется автодополнение из истории поиска; при нахождении над «replace» — из истории замен.

При выполнении в командной строке выражения замены в стиле sed с флагом «c» (например, s/find/replace/gc) будет запущено интерактивное выражение поиска/замены в стиле Vim.

Некоторые примеры использования эмулированной командной строки с GIF-анимацией приведены в этом блоге. В версии 4.11 эмулированную командную строку можно включить, установив скрытый параметр «Vi Input Mode Emulate Command Bar» в значение true в ваших katerc/kwriterc/kdeveloprc.

Нереализованные возможности

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.