s:find_opening_paren: pass lnum/col always, no winsaveview

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

diff --git a/indent/python.vim b/indent/python.vim
index 6bf45a8bf20405e2d51b47c66464fb4817671ce5..4b396099b2acc073d4464a13020679a9b24b32ca 100644 (file)
--- a/indent/python.vim
+++ b/indent/python.vim
@@ -1,6 +1,7 @@
 " PEP8 compatible Python indent file
 " Language:         Python
 " PEP8 compatible Python indent file
 " Language:         Python

-" Maintainer:       Hynek Schlawack <hs@ox.cx>
+" Maintainer:       Daniel Hahler <https://daniel.hahler.de/>
+" Prev Maintainer:  Hynek Schlawack <hs@ox.cx>

 " Prev Maintainer:  Eric Mc Sween <em@tomcom.de> (address invalid)
 " Original Author:  David Bustos <bustos@caltech.edu> (address invalid)
 " License:          CC0
 " Prev Maintainer:  Eric Mc Sween <em@tomcom.de> (address invalid)
 " Original Author:  David Bustos <bustos@caltech.edu> (address invalid)
 " License:          CC0


@@ -9,6 +10,7 @@
 " Written in 2004 by David Bustos <bustos@caltech.edu>
 " Maintained from 2004-2005 by Eric Mc Sween <em@tomcom.de>
 " Maintained from 2013 by Hynek Schlawack <hs@ox.cx>
 " Written in 2004 by David Bustos <bustos@caltech.edu>
 " Maintained from 2004-2005 by Eric Mc Sween <em@tomcom.de>
 " Maintained from 2013 by Hynek Schlawack <hs@ox.cx>

+" Maintained from 2017 by Daniel Hahler <https://daniel.hahler.de/>

 "
 " 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
 "
 " 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


@@ -18,25 +20,24 @@
 " <http://creativecommons.org/publicdomain/zero/1.0/>.
 
 " Only load this indent file when no other was loaded.
 " <http://creativecommons.org/publicdomain/zero/1.0/>.
 
 " Only load this indent file when no other was loaded.

-if exists("b:did_indent")
+if exists('b:did_indent')

     finish
 endif
 let b:did_indent = 1
 
     finish
 endif
 let b:did_indent = 1
 

-setlocal expandtab

 setlocal nolisp
 setlocal autoindent
 setlocal indentexpr=GetPythonPEPIndent(v:lnum)
 setlocal indentkeys=!^F,o,O,<:>,0),0],0},=elif,=except
 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

 
 if !exists('g:python_pep8_indent_multiline_string')
     let g:python_pep8_indent_multiline_string = 0
 endif
 
 
 if !exists('g:python_pep8_indent_multiline_string')
     let g:python_pep8_indent_multiline_string = 0
 endif
 

-let s:maxoff = 50
+if !exists('g:python_pep8_indent_hang_closing')
+    let g:python_pep8_indent_hang_closing = 0
+endif
+

 let s:block_rules = {
             \ '^\s*elif\>': ['if', 'elif'],
             \ '^\s*except\>': ['try', 'except'],
 let s:block_rules = {
             \ '^\s*elif\>': ['if', 'elif'],
             \ '^\s*except\>': ['try', 'except'],


@@ -45,8 +46,11 @@ let s:block_rules = {
 let s:block_rules_multiple = {
             \ '^\s*else\>': ['if', 'elif', 'for', 'try', 'except'],
             \ }
 let s:block_rules_multiple = {
             \ '^\s*else\>': ['if', 'elif', 'for', 'try', 'except'],
             \ }

-let s:paren_pairs = ['()', '{}', '[]']
-if &ft == 'pyrex' || &ft == 'cython'
+" Pairs to look for when searching for opening parenthesis.
+" The value is the maximum offset in lines.
+let s:paren_pairs = {'()': 50, '[]': 100, '{}': 1000}
+
+if &filetype ==# 'pyrex' || &filetype ==# 'cython'

     let b:control_statement = '\v^\s*(class|def|if|while|with|for|except|cdef|cpdef)>'
 else
     let b:control_statement = '\v^\s*(class|def|if|while|with|for|except)>'
     let b:control_statement = '\v^\s*(class|def|if|while|with|for|except|cdef|cpdef)>'
 else
     let b:control_statement = '\v^\s*(class|def|if|while|with|for|except)>'


@@ -57,7 +61,7 @@ let s:stop_statement = '^\s*\(break\|continue\|raise\|return\|pass\)\>'
 " jedi* refers to syntax definitions from jedi-vim for call signatures, which
 " are inserted temporarily into the buffer.
 let s:skip_special_chars = 'synIDattr(synID(line("."), col("."), 0), "name") ' .
 " jedi* refers to syntax definitions from jedi-vim for call signatures, which
 " are inserted temporarily into the buffer.
 let s:skip_special_chars = 'synIDattr(synID(line("."), col("."), 0), "name") ' .

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

 
 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"'


@@ -73,9 +77,6 @@ if has('conceal')
 endif
 
 
 endif
 
 

-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')
 " Use 'shiftwidth()' instead of '&sw'.
 " (Since Vim patch 7.3.629, 'shiftwidth' can be set to 0 to follow 'tabstop').
 if exists('*shiftwidth')


@@ -84,55 +85,39 @@ if exists('*shiftwidth')
     endfunction
 else
     function! s:sw()
     endfunction
 else
     function! s:sw()

-        return &sw
+        return &shiftwidth

     endfunction
 endif
 
     endfunction
 endif
 

-function! s:pair_sort(x, y)
-    if a:x[0] == a:y[0]
-        return a:x[1] == a:y[1] ? 0 : a:x[1] > a:y[1] ? 1 : -1
-    else
-        return a:x[0] > a:y[0] ? 1 : -1
-    endif
-endfunction
-

 " Find backwards the closest open parenthesis/bracket/brace.
 " 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
+function! s:find_opening_paren(lnum, col)
+    " Return if cursor is in a comment.
+    if synIDattr(synID(a:lnum, a:col, 0), 'name') =~? 'comment'
+        return [0, 0]

     endif
 
     endif
 

-    let stopline = max([0, line('.') - s:maxoff])
-
-    " Return if cursor is in a comment.
-    exe 'if' s:skip_search '| return [0, 0] | endif'
+    call cursor(a:lnum, a:col)

 
 

-    let positions = []
-    for p in s:paren_pairs
-        call add(positions, searchpairpos(
-           \ '\V'.p[0], '', '\V'.p[1], 'bnW', s:skip_special_chars, stopline))
+    let nearest = [0, 0]
+    for [p, maxoff] in items(s:paren_pairs)
+        let stopline = max([0, line('.') - maxoff, nearest[0]])
+        let next = searchpairpos(
+           \ '\V'.p[0], '', '\V'.p[1], 'bnW', s:skip_special_chars, stopline)
+        if next[0] && (next[0] > nearest[0] || (next[0] == nearest[0] && next[1] > nearest[1]))
+            let nearest = next
+        endif

     endfor
     endfor

-
-    " Remove empty matches and return the type with the closest match
-    call filter(positions, 'v:val[0]')
-    call sort(positions, 's:pair_sort')
-
-    return get(positions, -1, [0, 0])
+    return nearest

 endfunction
 
 " Find the start of a multi-line statement
 function! s:find_start_of_multiline_statement(lnum)
     let lnum = a:lnum
     while lnum > 0
 endfunction
 
 " Find the start of a multi-line statement
 function! s:find_start_of_multiline_statement(lnum)
     let lnum = a:lnum
     while lnum > 0

-        if getline(lnum - 1) =~ '\\$'
+        if getline(lnum - 1) =~# '\\$'

             let lnum = prevnonblank(lnum - 1)
         else
             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


@@ -155,11 +140,11 @@ function! s:find_start_of_block(lnum, types, multiple)
                 if !a:multiple
                     return [indent]
                 endif
                 if !a:multiple
                     return [indent]
                 endif

-                if !len(r) || index(r, indent) == -1
+                if index(r, indent) == -1

                     let r += [indent]
                 endif
                     let r += [indent]
                 endif

+                let last_indent = indent

             endif
             endif

-            let last_indent = indent(lnum)

         endif
         let lnum = prevnonblank(lnum - 1)
     endwhile
         endif
         let lnum = prevnonblank(lnum - 1)
     endwhile


@@ -178,7 +163,7 @@ function! s:match_expr_on_line(expr, lnum, start, ...)
     let r = 1
     for i in range(a:start, end)
         call cursor(a:lnum, i)
     let r = 1
     for i in range(a:start, end)
         call cursor(a:lnum, i)

-        if !(eval(a:expr) || text[i-1] =~ '\s')
+        if !(eval(a:expr) || text[i-1] =~# '\s')

             let r = 0
             break
         endif
             let r = 0
             break
         endif


@@ -189,7 +174,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


@@ -198,10 +183,13 @@ function! s:indent_like_opening_paren(lnum)
 
     let nothing_after_opening_paren = s:match_expr_on_line(
                 \ s:skip_after_opening_paren, paren_lnum, paren_col+1)
 
     let nothing_after_opening_paren = s:match_expr_on_line(
                 \ s:skip_after_opening_paren, paren_lnum, paren_col+1)

-    let starts_with_closing_paren = getline(a:lnum) =~ '^\s*[])}]'
+    let starts_with_closing_paren = getline(a:lnum) =~# '^\s*[])}]'
+
+    let hang_closing = get(b:, 'python_pep8_indent_hang_closing',
+                \ get(g:, 'python_pep8_indent_hang_closing', 0))

 
     if nothing_after_opening_paren
 
     if nothing_after_opening_paren

-        if starts_with_closing_paren
+        if starts_with_closing_paren && !hang_closing

             let res = base
         else
             let res = base + s:sw()
             let res = base
         else
             let res = base + s:sw()


@@ -215,10 +203,13 @@ function! s:indent_like_opening_paren(lnum)
     " indent further to distinguish the continuation line
     " from the next logical line.
     if text =~# b:control_statement && res == base + s:sw()
     " indent further to distinguish the continuation line
     " from the next logical line.
     if text =~# b:control_statement && res == base + s:sw()

-        return base + s:sw() * 2
-    else
-        return res
+        " But only if not inside parens itself (Flake's E127).
+        let [paren_lnum, _] = s:find_opening_paren(paren_lnum, 1)
+        if paren_lnum <= 0
+            return res + s:sw()
+        endif

     endif
     endif

+    return res

 endfunction
 
 " Match indent of first block of this type.
 endfunction
 
 " Match indent of first block of this type.


@@ -239,14 +230,15 @@ function! s:indent_like_block(lnum)
             if len(indents) == 1
                 return indents[0]
             endif
             if len(indents) == 1
                 return indents[0]
             endif

+

             " Multiple valid indents, e.g. for 'else' with both try and if.
             let indent = indent(a:lnum)
             " Multiple valid indents, e.g. for 'else' with both try and if.
             let indent = indent(a:lnum)

-            for possible_indent in indents
-                if indent == possible_indent
-                    return indent
-                endif
-            endfor
-            return -2
+            if index(indents, indent) != -1
+                " The indent is valid, keep it.
+                return indent
+            endif
+            " Fallback to the first/nearest one.
+            return indents[0]

         endfor
     endfor
     return -2
         endfor
     endfor
     return -2


@@ -271,18 +263,18 @@ function! s:indent_like_previous_line(lnum)
 
     " Search for final colon that is not inside something to be ignored.
     while 1
 
     " Search for final colon that is not inside something to be ignored.
     while 1

-        let curpos = getpos(".")[2]
+        let curpos = getpos('.')[2]

         if curpos == 1 | break | endif
         if curpos == 1 | break | endif

-        if eval(s:skip_special_chars) || text[curpos-1] =~ '\s'
+        if eval(s:skip_special_chars) || text[curpos-1] =~# '\s'

             normal! h
             continue
             normal! h
             continue

-        elseif text[curpos-1] == ':'
+        elseif text[curpos-1] ==# ':'

             return base + s:sw()
         endif
         break
     endwhile
 
             return base + s:sw()
         endif
         break
     endwhile
 

-    if text =~ '\\$' && !ignore_last_char
+    if text =~# '\\$' && !ignore_last_char

         " If this line is the continuation of a control statement
         " indent further to distinguish the continuation line
         " from the next logical line.
         " If this line is the continuation of a control statement
         " indent further to distinguish the continuation line
         " from the next logical line.


@@ -294,17 +286,26 @@ function! s:indent_like_previous_line(lnum)
         return base + s:sw()
     endif
 
         return base + s:sw()
     endif
 

+    let empty = getline(a:lnum) =~# '^\s*$'
+
+    " Current and prev line are empty, next is not -> indent like next.
+    if empty && a:lnum > 1 &&
+          \ (getline(a:lnum - 1) =~# '^\s*$') &&
+          \ !(getline(a:lnum + 1) =~# '^\s*$')
+      return indent(a:lnum + 1)
+    endif
+

     " If the previous statement was a stop-execution statement or a pass
     if getline(start) =~# s:stop_statement
         " Remove one level of indentation if the user hasn't already dedented
     " If the previous statement was a stop-execution statement or a pass
     if getline(start) =~# s:stop_statement
         " Remove one level of indentation if the user hasn't already dedented

-        if indent(a:lnum) > base - s:sw()
+        if empty || current > base - s:sw()

             return base - s:sw()
         endif
         " Otherwise, trust the user
         return -1
     endif
 
             return base - s:sw()
         endif
         " Otherwise, trust the user
         return -1
     endif
 

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

         return -1
     endif
 
         return -1
     endif
 


@@ -322,14 +323,14 @@ endfunction
 " Is the syntax at lnum (and optionally cnum) a python string?
 function! s:is_python_string(lnum, ...)
     let line = getline(a:lnum)
 " 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
+    if a:0
+      let cols = type(a:1) != type([]) ? [a:1] : a:1
+    else
+      let cols = range(1, max([1, len(line)]))

     endif
     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),
     for cnum in cols
         if match(map(synstack(a:lnum, cnum),

-                    \ 'synIDattr(v:val,"name")'), 'python\S*String') == -1
+                    \ "synIDattr(v:val, 'name')"), 'python\S*String') == -1

             return 0
         end
     endfor
             return 0
         end
     endfor


@@ -342,34 +343,61 @@ function! GetPythonPEPIndent(lnum)
         return 0
     endif
 
         return 0
     endif
 

+    let line = getline(a:lnum)
+    let prevline = getline(a:lnum-1)
+

     " Multilinestrings: continous, docstring or starting.
     " Multilinestrings: continous, docstring or starting.

-    if s:is_python_string(a:lnum, 1)
-                \ && s:is_python_string(a:lnum-1, len(getline(a:lnum-1)))
-        " Keep existing indent.
-        if match(getline(a:lnum), '\v^\s*\S') != -1
-            return -1
+    if s:is_python_string(a:lnum-1, max([1, len(prevline)]))
+                \ && (s:is_python_string(a:lnum, 1)
+                \     || match(line, '^\%("""\|''''''\)') != -1)
+
+        " Indent closing quotes as the line with the opening ones.
+        let match_quotes = match(line, '^\s*\zs\%("""\|''''''\)')
+        if match_quotes != -1
+            " closing multiline string
+            let quotes = line[match_quotes:(match_quotes+2)]
+            let pairpos = searchpairpos(quotes, '', quotes, 'b')
+            if pairpos[0] != 0
+                return indent(pairpos[0])
+            else
+                " TODO: test to cover this!
+            endif

         endif
 
         if s:is_python_string(a:lnum-1)
         endif
 
         if s:is_python_string(a:lnum-1)

-            " Previous line is (completely) a string.
-            return indent(a:lnum-1)
+            " Previous line is (completely) a string: keep current indent.
+            return -1

         endif
 
         endif
 

-        if match(getline(a:lnum-1), '^\s*\%("""\|''''''\)') != -1
+        if match(prevline, '^\s*\%("""\|''''''\)') != -1

             " docstring.
             return indent(a:lnum-1)
         endif
 
         let indent_multi = get(b:, 'python_pep8_indent_multiline_string',
                     \ get(g:, 'python_pep8_indent_multiline_string', 0))
             " docstring.
             return indent(a:lnum-1)
         endif
 
         let indent_multi = get(b:, 'python_pep8_indent_multiline_string',
                     \ get(g:, 'python_pep8_indent_multiline_string', 0))

+        if match(prevline, '\v%("""|'''''')$') != -1
+            " Opening multiline string, started in previous line.
+            if (&autoindent && indent(a:lnum) == indent(a:lnum-1))
+                        \ || match(line, '\v^\s+$') != -1
+                " <CR> with empty line or to split up 'foo("""bar' into
+                " 'foo("""' and 'bar'.
+                if indent_multi == -2
+                    return indent(a:lnum-1) + s:sw()
+                endif
+                return indent_multi
+            endif
+        endif
+
+        " Keep existing indent.
+        if match(line, '\v^\s*\S') != -1
+            return -1
+        endif
+

         if indent_multi != -2
             return indent_multi
         endif
 
         if indent_multi != -2
             return indent_multi
         endif
 

-        if match(getline(a:lnum-1), '\v%("""|'''''')$') != -1
-            " Opening multiline string, started in previous line.
-            return indent(a:lnum-1) + s:sw()
-        endif

         return s:indent_like_opening_paren(a:lnum)
     endif
 
         return s:indent_like_opening_paren(a:lnum)
     endif