" File: pythonhelper.vim " Author: Michal Vitecek " Maintainer: Marius Gedminas " Version: 0.93 " Last Modified: 2017-03-14 " " Overview " -------- " Vim script to help moving around in larger Python source files. It displays " current class, method or function the cursor is placed in on the status " line for every python file. It's more clever than Yegappan Lakshmanan's " taglist.vim because it takes into account indetation and comments to " determine what tag the cursor is placed in. " " Requirements " ------------ " This script needs only VIM compiled with Python interpreter. It doesn't rely " on exuberant ctags utility. You can determine whether your VIM has Python " support by issuing command :ver and looking for +python in the list of " features. " " Installation " ------------ " 1. Make sure your Vim has python feature on (+python). If not, you will need " to recompile it with --with-pythoninterp option to the configure script " 2. Copy pythonhelper.vim to the $HOME/.vim/plugin directory " 3. Copy pythonhelper.py to the $HOME/.vim/pythonx directory " 4. Add something like this to your .vimrc: " " " color of the current tag in the status line (bold cyan on black) " highlight User1 gui=bold guifg=cyan guibg=black " " color of the modified flag in the status line (bold black on red) " highlight User2 gui=bold guifg=black guibg=red " " the status line will be displayed for every window " set laststatus=2 " " set the status line to display some useful information " set stl=%-f%r\ %2*%m%*\ \ \ \ %1*%{TagInStatusLine()}%*%=[%l:%c]\ \ \ \ [buf\ %n] " " 5. Run Vim and open any python file. " if !exists("g:pythonhelper_python") if has("python3") let g:pythonhelper_python = "python3" elseif has("python") let g:pythonhelper_python = "python" else finish endif endif execute g:pythonhelper_python 'import pythonhelper' " VIM functions {{{ function! PHCursorHold() " only python is supported {{{ if (!exists('b:current_syntax') || (b:current_syntax != 'python')) let w:PHStatusLine = '' return endif " }}} " call python function findTag() with the current buffer number and changed ticks execute g:pythonhelper_python 'pythonhelper.findTag(' . expand("") . ', ' . b:changedtick . ')' endfunction function! PHBufferDelete() if bufnr("") == expand("") " set PHStatusLine for this window to empty string let w:PHStatusLine = "" endif " call python function deleteTags() with the cur execute g:pythonhelper_python 'pythonhelper.deleteTags(' . expand("") . ')' endfunction function! TagInStatusLine() " return value of w:PHStatusLine in case it's set if (exists("w:PHStatusLine")) return w:PHStatusLine " otherwise just return empty string else return "" endif endfunction function! PHPreviousClassMethod() call search('^[ \t]*\(class\|def\)\>', 'bw') endfunction function! PHNextClassMethod() call search('^[ \t]*\(class\|def\)\>', 'w') endfunction function! PHPreviousClass() call search('^[ \t]*class\>', 'bw') endfunction function! PHNextClass() call search('^[ \t]*class\>', 'w') endfunction function! PHPreviousMethod() call search('^[ \t]*def\>', 'bw') endfunction function! PHNextMethod() call search('^[ \t]*def\>', 'w') endfunction " }}} " event binding, vim customizing {{{ " autocommands binding augroup PythonHelper autocmd! autocmd CursorMoved * call PHCursorHold() autocmd CursorMovedI * call PHCursorHold() autocmd BufEnter * call PHCursorHold() autocmd BufDelete * silent call PHBufferDelete() augroup END " }}} " vim:foldmethod=marker