Improve/fix indent with closing parenthesis (#129)

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

diff --git a/indent/python.vim b/indent/python.vim
index 2953935111dc8c2538e32678f60a8889d033bfd8..aca216e79d69e63da8411a269c9522ae03c6b627 100644 (file)
--- a/indent/python.vim
+++ b/indent/python.vim
@@ -48,13 +48,13 @@ if !exists('g:python_pep8_indent_searchpair_timeout')
 endif
 
 let s:block_rules = {
 endif
 
 let s:block_rules = {

-            \ '^\s*elif\>': ['if', 'elif'],
-            \ '^\s*except\>': ['try', 'except'],
-            \ '^\s*finally\>': ['try', 'except', 'else']
-            \ }
+      \ '^\s*elif\>': [['if', 'elif'], ['else']],
+      \ '^\s*except\>': [['try', 'except'], []],
+      \ '^\s*finally\>': [['try', 'except', 'else'], []]
+      \ }

 let s:block_rules_multiple = {
 let s:block_rules_multiple = {

-            \ '^\s*else\>': ['if', 'elif', 'for', 'try', 'except'],
-            \ }
+      \ '^\s*else\>': [['if', 'elif', 'for', 'try', 'except'], []]
+      \ }

 " Pairs to look for when searching for opening parenthesis.
 " The value is the maximum offset in lines.
 let s:paren_pairs = {'()': 50, '[]': 100, '{}': 1000}
 " Pairs to look for when searching for opening parenthesis.
 " The value is the maximum offset in lines.
 let s:paren_pairs = {'()': 50, '[]': 100, '{}': 1000}


@@ -69,13 +69,15 @@ let s:stop_statement = '^\s*\(break\|continue\|raise\|return\|pass\)\>'
 let s:skip_after_opening_paren = 'synIDattr(synID(line("."), col("."), 0), "name") ' .
             \ '=~? "\\vcomment|jedi\\S"'
 
 let s:skip_after_opening_paren = 'synIDattr(synID(line("."), col("."), 0), "name") ' .
             \ '=~? "\\vcomment|jedi\\S"'
 

+let s:special_chars_syn_pattern = "\\vstring|comment|^pythonbytes%(contents)=$|pythonTodo|jedi\\S"
+

 if !get(g:, 'python_pep8_indent_skip_concealed', 0) || !has('conceal')
     " Skip strings and comments. Return 1 for chars to skip.
     " jedi* refers to syntax definitions from jedi-vim for call signatures, which
     " are inserted temporarily into the buffer.
     function! s:_skip_special_chars(line, col)
         return synIDattr(synID(a:line, a:col, 0), 'name')
 if !get(g:, 'python_pep8_indent_skip_concealed', 0) || !has('conceal')
     " Skip strings and comments. Return 1 for chars to skip.
     " jedi* refers to syntax definitions from jedi-vim for call signatures, which
     " are inserted temporarily into the buffer.
     function! s:_skip_special_chars(line, col)
         return synIDattr(synID(a:line, a:col, 0), 'name')

-                \ =~? "\\vstring|comment|^pythonbytes%(contents)=$|jedi\\S"
+              \ =~? s:special_chars_syn_pattern

     endfunction
 else
     " Also ignore anything concealed.
     endfunction
 else
     " Also ignore anything concealed.


@@ -90,12 +92,11 @@ else
 
     function! s:_skip_special_chars(line, col)
         return synIDattr(synID(a:line, a:col, 0), 'name')
 
     function! s:_skip_special_chars(line, col)
         return synIDattr(synID(a:line, a:col, 0), 'name')

-                \ =~? "\\vstring|comment|^pythonbytes%(contents)=$|jedi\\S"
-                \ || s:is_concealed(a:line, a:col)
+              \ =~? s:special_chars_syn_pattern
+              \ || s:is_concealed(a:line, a:col)

     endfunction
 endif
 
     endfunction
 endif
 

-

 " Use 'shiftwidth()' instead of '&sw'.
 " (Since Vim patch 7.3.629, 'shiftwidth' can be set to 0 to follow 'tabstop').
 if exists('*shiftwidth')
 " Use 'shiftwidth()' instead of '&sw'.
 " (Since Vim patch 7.3.629, 'shiftwidth' can be set to 0 to follow 'tabstop').
 if exists('*shiftwidth')


@@ -109,37 +110,21 @@ else
 endif
 
 " Find backwards the closest open parenthesis/bracket/brace.
 endif
 
 " Find backwards the closest open parenthesis/bracket/brace.

-function! s:find_opening_paren(...)
-    " optional arguments: line and column (defaults to 1) to search around
-    if a:0 > 0
-        let view = winsaveview()
-        call cursor(a:1, a:0 > 1 ? a:2 : 1)
-        let ret = s:find_opening_paren()
-        call winrestview(view)
-        return ret
-    endif
-
+function! s:find_opening_paren(lnum, col)

     " Return if cursor is in a comment.
     " Return if cursor is in a comment.

-    if synIDattr(synID(line('.'), col('.'), 0), 'name') =~? 'comment'
+    if synIDattr(synID(a:lnum, a:col, 0), 'name') =~? 'comment'

         return [0, 0]
     endif
 
         return [0, 0]
     endif
 

+    call cursor(a:lnum, a:col)
+

     let nearest = [0, 0]
     let nearest = [0, 0]

+    let timeout = g:python_pep8_indent_searchpair_timeout
+    let skip_special_chars = 's:_skip_special_chars(line("."), col("."))'

     for [p, maxoff] in items(s:paren_pairs)
         let stopline = max([0, line('.') - maxoff, nearest[0]])
     for [p, maxoff] in items(s:paren_pairs)
         let stopline = max([0, line('.') - maxoff, nearest[0]])

-        let found = 0
-        while 1
-            let next = searchpairpos(
-               \ '\V'.p[0], '', '\V'.p[1], 'bnW', '', stopline, g:python_pep8_indent_searchpair_timeout)
-
-            if !next[0]
-                break
-            endif
-            if !s:_skip_special_chars(next[0], next[1])
-                break
-            endif
-            call cursor(next[0], next[1])
-        endwhile
+        let next = searchpairpos(
+           \ '\V'.p[0], '', '\V'.p[1], 'bnW', skip_special_chars, stopline, timeout)

         if next[0] && (next[0] > nearest[0] || (next[0] == nearest[0] && next[1] > nearest[1]))
             let nearest = next
         endif
         if next[0] && (next[0] > nearest[0] || (next[0] == nearest[0] && next[1] > nearest[1]))
             let nearest = next
         endif


@@ -154,7 +139,7 @@ function! s:find_start_of_multiline_statement(lnum)
         if getline(lnum - 1) =~# '\\$'
             let lnum = prevnonblank(lnum - 1)
         else
         if getline(lnum - 1) =~# '\\$'
             let lnum = prevnonblank(lnum - 1)
         else

-            let [paren_lnum, _] = s:find_opening_paren(lnum)
+            let [paren_lnum, _] = s:find_opening_paren(lnum, 1)

             if paren_lnum < 1
                 return lnum
             else
             if paren_lnum < 1
                 return lnum
             else


@@ -165,15 +150,23 @@ function! s:find_start_of_multiline_statement(lnum)
 endfunction
 
 " Find possible indent(s) of the block starter that matches the current line.
 endfunction
 
 " Find possible indent(s) of the block starter that matches the current line.

-function! s:find_start_of_block(lnum, types, multiple)
+function! s:find_start_of_block(lnum, types, skip, multiple) abort

     let r = []
     let re = '\V\^\s\*\('.join(a:types, '\|').'\)\>'
     let r = []
     let re = '\V\^\s\*\('.join(a:types, '\|').'\)\>'

+    if !empty(a:skip)
+      let re_skip = '\V\^\s\*\('.join(a:skip, '\|').'\)\>'
+    else
+      let re_skip = ''
+    endif

     let lnum = a:lnum
     let last_indent = indent(lnum) + 1
     while lnum > 0 && last_indent > 0
         let indent = indent(lnum)
         if indent < last_indent
     let lnum = a:lnum
     let last_indent = indent(lnum) + 1
     while lnum > 0 && last_indent > 0
         let indent = indent(lnum)
         if indent < last_indent

-            if getline(lnum) =~# re
+            let line = getline(lnum)
+            if !empty(re_skip) && line =~# re_skip
+                let last_indent = indent
+            elseif line =~# re

                 if !a:multiple
                     return [indent]
                 endif
                 if !a:multiple
                     return [indent]
                 endif


@@ -211,7 +204,7 @@ endfunction
 
 " Line up with open parenthesis/bracket/brace.
 function! s:indent_like_opening_paren(lnum)
 
 " Line up with open parenthesis/bracket/brace.
 function! s:indent_like_opening_paren(lnum)

-    let [paren_lnum, paren_col] = s:find_opening_paren(a:lnum)
+    let [paren_lnum, paren_col] = s:find_opening_paren(a:lnum, 1)

     if paren_lnum <= 0
         return -2
     endif
     if paren_lnum <= 0
         return -2
     endif


@@ -230,6 +223,11 @@ function! s:indent_like_opening_paren(lnum)
             let res = base
         else
             let res = base + s:sw()
             let res = base
         else
             let res = base + s:sw()

+
+            " Special case for parenthesis.
+            if text[paren_col-1] ==# '(' && getline(a:lnum) !~# '\v\)\s*:?\s*$'
+                return res
+            endif

         endif
     else
         " Indent to match position of opening paren.
         endif
     else
         " Indent to match position of opening paren.


@@ -241,7 +239,7 @@ function! s:indent_like_opening_paren(lnum)
     " from the next logical line.
     if text =~# b:control_statement && res == base + s:sw()
         " But only if not inside parens itself (Flake's E127).
     " from the next logical line.
     if text =~# b:control_statement && res == base + s:sw()
         " But only if not inside parens itself (Flake's E127).

-        let [paren_lnum, _] = s:find_opening_paren(paren_lnum)
+        let [paren_lnum, _] = s:find_opening_paren(paren_lnum, 1)

         if paren_lnum <= 0
             return res + s:sw()
         endif
         if paren_lnum <= 0
             return res + s:sw()
         endif


@@ -254,14 +252,16 @@ function! s:indent_like_block(lnum)
     let text = getline(a:lnum)
     for [multiple, block_rules] in [
                 \ [0, s:block_rules],
     let text = getline(a:lnum)
     for [multiple, block_rules] in [
                 \ [0, s:block_rules],

-                \ [1, s:block_rules_multiple]]
-        for [line_re, blocks] in items(block_rules)
+                \ [1, s:block_rules_multiple],
+                \ ]
+        for [line_re, blocks_ignore] in items(block_rules)

             if text !~# line_re
                 continue
             endif
 
             if text !~# line_re
                 continue
             endif
 

-            let indents = s:find_start_of_block(a:lnum - 1, blocks, multiple)
-            if !len(indents)
+            let [blocks, skip] = blocks_ignore
+            let indents = s:find_start_of_block(a:lnum - 1, blocks, skip, multiple)
+            if empty(indents)

                 return -1
             endif
             if len(indents) == 1
                 return -1
             endif
             if len(indents) == 1


@@ -341,7 +341,7 @@ function! s:indent_like_previous_line(lnum)
         return -1
     endif
 
         return -1
     endif
 

-    if !empty && s:is_dedented_already(current, base)
+    if (current || !empty) && s:is_dedented_already(current, base)

         return -1
     endif
 
         return -1
     endif
 


@@ -392,11 +392,12 @@ function! GetPythonPEPIndent(lnum)
         if match_quotes != -1
             " closing multiline string
             let quotes = line[match_quotes:(match_quotes+2)]
         if match_quotes != -1
             " closing multiline string
             let quotes = line[match_quotes:(match_quotes+2)]

-            let pairpos = searchpairpos(quotes, '', quotes, 'b', 1, g:python_pep8_indent_searchpair_timeout)
+            call cursor(a:lnum, 1)
+            let pairpos = searchpairpos(quotes, '', quotes, 'bW', '', 0, g:python_pep8_indent_searchpair_timeout)

             if pairpos[0] != 0
                 return indent(pairpos[0])
             else
             if pairpos[0] != 0
                 return indent(pairpos[0])
             else

-                " TODO: test to cover this!
+                return -1

             endif
         endif
 
             endif
         endif