Fix indenting of strings, especially after opening paren

[etc/vim.git] / indent / python.vim

diff --git a/indent/python.vim b/indent/python.vim
index 461e30c9ec898c03ba6aff6068c50998eca29696..69128996b7ca1b1c0963b456d2b1340013b50d31 100644 (file)
--- a/indent/python.vim
+++ b/indent/python.vim
@@ -34,23 +34,24 @@ 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:stop_statement = '^\s*\(break\|continue\|raise\|return\|pass\)\>'
 
 " Skip strings and comments
 let s:skip_special_chars = 'synIDattr(synID(line("."), col("."), 0), "name") ' .
-           \ '=~? "string\\|comment"'
+            \ '=~? "string\\|comment"'
 
 let s:skip_search = 'synIDattr(synID(line("."), col("."), 0), "name") ' .
-           \ '=~? "comment"'
+            \ '=~? "comment"'
 
-" compatibility with vim patch 7.3.629: 'sw' can be set to -1 to follow 'ts'
+" 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()
@@ -82,7 +83,7 @@ function! s:find_opening_paren(...)
 
     let stopline = max([0, line('.') - s:maxoff])
 
-    " Return if cursor is in a comment or string
+    " Return if cursor is in a comment.
     exe 'if' s:skip_search '| return [0, 0] | endif'
 
     let positions = []
@@ -245,6 +246,23 @@ function! s:indent_like_previous_line(lnum)
     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
@@ -252,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