h0rr0rr_drag0n 23.11.2010 23:25

VimПлагин code_complete для Vim'a - автодополнение и сниппеты

Практически во всех современных средах разработки есть пара удобных возможностей - есть возможность видеть список параметров функции, введя имя этой функции и открывающую скобку, и автодополнение стандартных блоков кода, наподобие if () {} else {} и других.
Естественно, подобная функциональность не могла обойти стороной и текстовый редактор Vim (который, стоит отметить, являет собой нечто большее, чем просто текстовый редактор). Сниппеты и автодополнение параметров функций можно найти во множестве плагинов, лежащих на vim.org.
В своей статье, я хочу рассмотреть один плагин, в котором уже реализованы и сниппеты и автодополнение. Плагин называется code_complete (new update).

Установка плагина предельно проста и выполняется через VimBall - открывается файл plugin_name.vba и выполняется команда :so %. Все.
Автодополнение в плагине работает по хоткею , в отличие от плагина code_complete, в котором почему-то использовалась клавиша . Естественно, хоткей можно поменять - этот процесс описан в прилагаемой документации.
Кроме того, в рассматриваемом плагине достаточно удобно менять внешний вид используемых сниппетов. Меня, как любителя фигурных скобочек на той же строке, что и ключевое слово или имя функции, не устраивала позиция создателя code_complete, который считал, что фигурные скобочки должны располагаться на следующей строке. Естественно, я поменял поведение плагина на требуемое мне.
Шаблоны сниппетов располагаются в файле ~/.vim/plugin/default_snippets.template. Шаблоны для C и C++ начинаются с 64 строки и кончаются на 84. Если вы такой же приверженец "фигурных скобочек на текущей строке" как и я, то просто замените содержимое строк с 64 по 84 вот этим:
 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
let a:dict<'if'> = "if (".s:dr.") {\<cr>".s:dr."\<cr>}\<cr>".s:dr
let a:dict<'else'> = "else {\<cr>".s:dr."\<cr>}\<cr>".s:dr
let a:dict<'while'> = "while (".s:dr.") {\<cr>".s:dr."\<cr>}\<cr>".s:dr
let a:dict<'do'> = "do {\<cr>".s:dr."\<cr>}\<cr>while (".
\ s:dr.");\<cr>".s:dr
let a:dict<'for'> = "for (".s:dr."; ".s:dr."; ".s:dr.") {\<cr>".
\ s:dr."\<cr>}\<cr>".s:dr
let a:dict<'case'> = "case ".s:dr.":\<cr>".s:dr."\<cr>\<bs>break;".
\ "\<cr>\<bs>".s:dr
let a:dict<'switch'> = "switch (".s:dr.") {\<cr>\<bs>".a:dict<'case'>.
\ "\<cr>\<bs>\<bs>\<bs>\<bs>\<bs>\<bs>\<bs>default:\<cr>".s:dr."\<cr>}\<cr>".s:dr
let a:dict<'struct'> = "struct ".s:dr." {\<cr>".s:dr."\<cr>}".s:sr(';')

let a:dict<'printf'> = 'printf("\n", '.s:sr('args').");\<c-\>\<c-n>F\\i".
\ "\<c-r>=SkipMarks()\<cr>"
let a:dict<'malloc'> = "\<c-r>=GetInput('input type you want to malloc:',".
\ "'ma_type')\<cr>(\<c-r>=ma_type\<cr>*)malloc(".s:sr('len').
\ " * sizeof(\<c-r>=ma_type\<cr>));"
let a:dict<'calloc'> = "\<c-r>=GetInput('input type you want to calloc:',".
\ "'ma_type')\<cr>(\<c-r>=ma_type\<cr>*)calloc(".s:sr('len').
\ ", sizeof(\<c-r>=ma_type\<cr>));"



Теперь о том, как работать с этим плагином. Для вставки сниппета нужно напечатать его начало (например switch) и нажать . Сниппет раскроется и для перехода между полями в нем, нужно еще раз нажать вышеприведенную комбинацию клавиш. Выглядит это примерно так:
25d025a125d025bd25d025b.th.png

С автодополнением параметров функций все несколько сложнее - нам потребуется утилита ctags. При помощи этой утилиты нужно сгенерировать tags-файл для текущего проекта, в котором будут имена и параметры переменных, функций и т.п. Можно делать это самому, по хоткею:
1
2
3
"Автоматическая индексация проекта утилитой ctags
imap &lt;C-c>ct &lt;Esc>:!ctags -R --c++-kinds=+p --c-kinds=+p --fields=+iaS --extra=+q --languages=c++,c .&lt;CR>
nmap &lt;C-c>ct :!ctags -R --c++-kinds=+p --c-kinds=+p --fields=+iaS --extra=+q --languages=c++,c .&lt;CR>


А можно использовать специальный плагин indexer, который будет делать это автоматически, при изменении файлов проекта.
Итак, допустим tags-файл уже сгенерирован. Печатаем function_name( , нажимаем и получаем:
25d025a125d025bd25d025b.th.png

Вот и все основные возможности плагина. Приятного использования.
Ссылка на страницу плагина.

По материалам блога Дракон-линуксоид


Тэги: vim автодополнение сниппеты
+ 8 -
Похожие Поделиться

time2die 24.11.2010 00:12 #
то что доктор прописал
h0rr0rr_drag0n 24.11.2010 00:22 #
Какие гости!))
ont 24.11.2010 13:28 #
snipmate тоже неплох.
download + видео
kstep 24.11.2010 19:36 #
Да, какое-то время юзал code_complete, но потом перешёл на snipMate и обратно не тянет.
KblCb 25.11.2010 03:14 #
А как snipmate осуществляется навигация по сниппету? Меток то в нём вроде бы нет.
kstep 25.11.2010 04:48 #
В смысле, навигация?
Набираешь ключевое слово, жмёшь tab ? срабатывает подстановка сниппета, если в нём есть плейсхолдеры, то будет выделен первый и можно сразу набирать текст, каждое нажати таба ? переход на следующий плейсхолдер. Плейсхолдеры могут быть именованными, тогда при изменении текста в плейсхолдере в одном месте автоматом меняется текст во всех плейсхолдерах с тем же именем по всему сниппету. Например возможен такой сниппет:

snippet for
for (${2:i} = 0; $2 < ${1:count}; $2${3:++}) {
${4:/* code */}
}

Я набираю в си-файле for, жму таб и получаю такое:

for (i = 0; i < count; i++) {
/* code */
}

и у меня уже выделена переменная «i». Я набираю какой-нить текст (например «foobar»), и по всему сниппету имя переменной тоже меняется. Потом жму таб и попадаю на count. И т.д.
KblCb 25.11.2010 23:58 #
А что будет если внутрь сниппета вставить ещё один? Навигация по сниппету верхнего уровне поломается или будет работать?
kstep 26.11.2010 13:40 #
Только что проверил. В режиме навигации по сниппету вставить ещё один сниппет нельзя, надо выйти из навигации по сниппету и можно снова вставлять сниппеты.
Так что можно считать, что да, поломается.