X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/fa0f4802afec544c313f4590825dd48400539440..668edf8d06e07cb74d8dd9680c65f290b61c10f0:/indent/python.vim diff --git a/indent/python.vim b/indent/python.vim index d86eabb..007c7e1 100644 --- a/indent/python.vim +++ b/indent/python.vim @@ -3,7 +3,19 @@ " Maintainer: Hynek Schlawack " Prev Maintainer: Eric Mc Sween (address invalid) " Original Author: David Bustos (address invalid) -" License: Public Domain +" License: CC0 +" +" vim-python-pep8-indent - A nicer Python indentation style for vim. +" Written in 2004 by David Bustos +" Maintained from 2004-2005 by Eric Mc Sween +" Maintained from 2013 by Hynek Schlawack +" +" To the extent possible under law, the author(s) have dedicated all copyright +" and related and neighboring rights to this software to the public domain +" worldwide. This software is distributed without any warranty. +" You should have received a copy of the CC0 Public Domain Dedication along +" with this software. If not, see +" . " Only load this indent file when no other was loaded. if exists("b:did_indent") @@ -16,23 +28,30 @@ setlocal nolisp setlocal autoindent setlocal indentexpr=GetPythonPEPIndent(v:lnum) setlocal indentkeys=!^F,o,O,<:>,0),0],0},=elif,=except +setlocal tabstop=4 +setlocal softtabstop=4 +setlocal shiftwidth=4 let s:maxoff = 50 let s:block_rules = { - \ '^\s*elif\>': ['if', 'elif'], - \ '^\s*else\>': ['if', 'elif', 'for', 'try', 'except'], - \ '^\s*except\>': ['try', 'except'], - \ '^\s*finally\>': ['try', 'except', 'else'] - \ } + \ '^\s*elif\>': ['if', 'elif'], + \ '^\s*else\>': ['if', 'elif', 'for', 'try', 'except'], + \ '^\s*except\>': ['try', 'except'], + \ '^\s*finally\>': ['try', 'except', 'else'] + \ } let s:paren_pairs = ['()', '{}', '[]'] -let s:control_statement = '^\s*\(if\|while\|with\|for\|except\)\>' +let s:control_statement = '^\s*\(class\|def\|if\|while\|with\|for\|except\)\>' let s:stop_statement = '^\s*\(break\|continue\|raise\|return\|pass\)\>' " Skip strings and comments -let s:skip = 'synIDattr(synID(line("."), col("."), 0), "name") ' . - \ '=~? "string\\|comment"' +let s:skip_special_chars = 'synIDattr(synID(line("."), col("."), 0), "name") ' . + \ '=~? "string\\|comment"' -" compatibility with vim patch 7.3.629: 'sw' can be set to -1 to follow 'ts' +let s:skip_search = 'synIDattr(synID(line("."), col("."), 0), "name") ' . + \ '=~? "comment"' + +" Use 'shiftwidth()' instead of '&sw'. +" (Since Vim patch 7.3.629, 'shiftwidth' can be set to 0 to follow 'tabstop'). if exists('*shiftwidth') function! s:sw() return shiftwidth() @@ -64,13 +83,13 @@ function! s:find_opening_paren(...) let stopline = max([0, line('.') - s:maxoff]) - " Return if cursor is in a comment or string - exe 'if' s:skip '| return [0, 0] | endif' + " Return if cursor is in a comment. + exe 'if' s:skip_search '| return [0, 0] | endif' let positions = [] for p in s:paren_pairs call add(positions, searchpairpos( - \ '\V'.p[0], '', '\V'.p[1], 'bnW', s:skip, stopline)) + \ '\V'.p[0], '', '\V'.p[1], 'bnW', s:skip_special_chars, stopline)) endfor " Remove empty matches and return the type with the closest match @@ -179,14 +198,15 @@ function! s:indent_like_previous_line(lnum) let text = getline(lnum) let start = s:find_start_of_multiline_statement(lnum) let base = indent(start) + let current = indent(a:lnum) " Jump to last character in previous line. call cursor(lnum, len(text)) - let ignore_last_char = eval(s:skip) + let ignore_last_char = eval(s:skip_special_chars) " Search for final colon that is not inside a string or comment. while search(':\s*\%(#.*\)\?$', 'bcW', lnum) - if eval(s:skip) + if eval(s:skip_special_chars) normal! h else return base + s:sw() @@ -215,10 +235,34 @@ function! s:indent_like_previous_line(lnum) return -1 endif + " If this line is dedented and the number of indent spaces is valid + " (multiple of the indentation size), trust the user + let dedent_size = current - base + if dedent_size < 0 && current % s:sw() == 0 + return -1 + endif + " In all other cases, line up with the start of the previous statement. return base endfunction +" Is the syntax at lnum (and optionally cnum) a python string? +function! s:is_python_string(lnum, ...) + let line = getline(a:lnum) + let linelen = len(line) + if linelen < 1 + let linelen = 1 + endif + let cols = a:0 ? type(a:1) != type([]) ? [a:1] : a:1 : range(1, linelen) + for cnum in cols + if match(map(synstack(a:lnum, cnum), + \ 'synIDattr(v:val,"name")'), 'python\S*String') == -1 + return 0 + end + endfor + return 1 +endfunction + function! GetPythonPEPIndent(lnum) " First line has indent 0 @@ -226,6 +270,24 @@ function! GetPythonPEPIndent(lnum) return 0 endif + " Multilinestrings: continous, docstring or starting. + if s:is_python_string(a:lnum) + if s:is_python_string(a:lnum-1) + " Previous line is (completely) a string. + return s:indent_like_previous_line(a:lnum) + endif + + if match(getline(a:lnum-1), '^\s*\%("""\|''''''\)') != -1 + " docstring. + return s:indent_like_previous_line(a:lnum) + endif + + if s:is_python_string(a:lnum-1, len(getline(a:lnum-1))) + " String started in previous line. + return 0 + endif + endif + " Parens: If we can find an open parenthesis/bracket/brace, line up with it. let indent = s:indent_like_opening_paren(a:lnum) if indent >= -1