Remove AUTHORS, link to contributors on GitHub

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

diff --git a/indent/python.vim b/indent/python.vim
index 3b64cf4263985de8341580f6ca77b9857ed5832f..4306985849589e65f32734163261d71ab571637b 100644 (file)
--- a/indent/python.vim
+++ b/indent/python.vim
@@ -3,7 +3,19 @@
 " 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)
 " 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:          Public Domain
+" License:          CC0
+"
+" vim-python-pep8-indent - A nicer Python indentation style for vim.
+" 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>
+"
+" 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
+" <http://creativecommons.org/publicdomain/zero/1.0/>.

 
 " Only load this indent file when no other was loaded.
 if exists("b:did_indent")
 
 " Only load this indent file when no other was loaded.
 if exists("b:did_indent")


@@ -16,23 +28,50 @@ setlocal nolisp
 setlocal autoindent
 setlocal indentexpr=GetPythonPEPIndent(v:lnum)
 setlocal indentkeys=!^F,o,O,<:>,0),0],0},=elif,=except
 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 = {
 
 let s:maxoff = 50
 let s:block_rules = {

-  \ '^\s*\(elif\|else\)\>': ['if', 'elif'],
-  \ '^\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:paren_pairs = ['()', '{}', '[]']

-let s:control_statement = '^\s*\(if\|while\|with\|for\|except\)\>'
-let s:stop_statement = '^\s*\(break\|continue\|raise\|return\|pass\)\>'
-if v:version >= 704 || (v:version == 703 && has('patch1037'))
-  let s:string_literal = '".\{-}\\\@1<!"\|''.\{-}\\\@1<!'''
+if &ft == 'pyrex' || &ft == 'cython'
+    let b:control_statement = '\v^\s*(class|def|if|while|with|for|except|cdef|cpdef)>'

 else
 else

-  let s:string_literal = '".\{-}\\\@<!"\|''.\{-}\\\@<!'''
+    let b:control_statement = '\v^\s*(class|def|if|while|with|for|except)>'

 endif
 endif

+let s:stop_statement = '^\s*\(break\|continue\|raise\|return\|pass\)\>'
+
+" 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.
+let s:skip_special_chars = 'synIDattr(synID(line("."), col("."), 0), "name") ' .
+            \ '=~? "\\vstring|comment|jedi\\S"'

 
 

-" compatibility with vim patch 7.3.629: 'sw' can be set to -1 to follow 'ts'
+let s:skip_after_opening_paren = 'synIDattr(synID(line("."), col("."), 0), "name") ' .
+            \ '=~? "\\vcomment|jedi\\S"'
+
+" Also ignore anything concealed.
+" Wrapper around synconcealed for older Vim (7.3.429, used on Travis CI).
+function! s:is_concealed(line, col)
+    let concealed = synconcealed(a:line, a:col)
+    return len(concealed) && concealed[0]
+endfunction
+if has('conceal')
+    let s:skip_special_chars .= '|| s:is_concealed(line("."), col("."))'
+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')
     function! s:sw()
         return shiftwidth()
 if exists('*shiftwidth')
     function! s:sw()
         return shiftwidth()


@@ -64,23 +103,20 @@ function! s:find_opening_paren(...)
 
     let stopline = max([0, line('.') - s:maxoff])
 
 
     let stopline = max([0, line('.') - s:maxoff])
 

-    " Skip strings and comments
-    let skip = 'synIDattr(synID(line("."), col("."), 0), "name") ' .
-             \ '=~? "string\\|comment"'
-
-    " Return if cursor is in a comment or string
-    exe 'if' 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
 
     let positions = []
     for p in s:paren_pairs

-        call add(positions, searchpairpos('\V'.p[0], '', '\V'.p[1], 'bnW', skip, stopline))
+        call add(positions, searchpairpos(
+           \ '\V'.p[0], '', '\V'.p[1], 'bnW', s:skip_special_chars, stopline))

     endfor
 
     " Remove empty matches and return the type with the closest match
     call filter(positions, 'v:val[0]')
     call sort(positions, 's:pair_sort')
 
     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, 0, [0, 0])
+    return get(positions, -1, [0, 0])

 endfunction
 
 " Find the start of a multi-line statement
 endfunction
 
 " Find the start of a multi-line statement


@@ -118,6 +154,27 @@ function! s:find_start_of_block(lnum, types)
     return 0
 endfunction
 
     return 0
 endfunction
 

+" Is "expr" true for every position in "lnum", beginning at "start"?
+" (optionally up to a:1 / 4th argument)
+function! s:match_expr_on_line(expr, lnum, start, ...)
+    let text = getline(a:lnum)
+    let end = a:0 ? a:1 : len(text)
+    if a:start > end
+        return 1
+    endif
+    let save_pos = getpos('.')
+    let r = 1
+    for i in range(a:start, end)
+        call cursor(a:lnum, i)
+        if !(eval(a:expr) || text[i-1] =~ '\s')
+            let r = 0
+            break
+        endif
+    endfor
+    call setpos('.', save_pos)
+    return r
+endfunction
+

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


@@ -127,7 +184,8 @@ function! s:indent_like_opening_paren(lnum)
     let text = getline(paren_lnum)
     let base = indent(paren_lnum)
 
     let text = getline(paren_lnum)
     let base = indent(paren_lnum)
 

-    let nothing_after_opening_paren = text =~ '\%'.(paren_col + 1).'c\s*$'
+    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*[])}]'
 
     if nothing_after_opening_paren
     let starts_with_closing_paren = getline(a:lnum) =~ '^\s*[])}]'
 
     if nothing_after_opening_paren


@@ -144,7 +202,7 @@ function! s:indent_like_opening_paren(lnum)
     " 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.

-    if text =~# s:control_statement && res == base + s:sw()
+    if text =~# b:control_statement && res == base + s:sw()

         return base + s:sw() * 2
     else
         return res
         return base + s:sw() * 2
     else
         return res


@@ -173,25 +231,39 @@ endfunction
 
 function! s:indent_like_previous_line(lnum)
     let lnum = prevnonblank(a:lnum - 1)
 
 function! s:indent_like_previous_line(lnum)
     let lnum = prevnonblank(a:lnum - 1)

-    let text = getline(lnum)
-    let start = s:find_start_of_multiline_statement(lnum)
-    let base = indent(start)

 
 

-    " Remove string literals.
-    let text = substitute(text, s:string_literal, '', 'g')
-
-    " If the previous line ended with a colon and is not a comment, indent
-    " relative to statement start.
-    if text =~ '^[^#]*:\s*\(#.*\)\?$'
-        return base + s:sw()
+    " No previous line, keep current indent.
+    if lnum < 1
+      return -1

     endif
 
     endif
 

+    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_special_chars)
+
+    " Search for final colon that is not inside something to be ignored.
+    while 1
+        let curpos = getpos(".")[2]
+        if curpos == 1 | break | endif
+        if eval(s:skip_special_chars) || text[curpos-1] =~ '\s'
+            normal! h
+            continue
+        elseif text[curpos-1] == ':'
+            return base + s:sw()
+        endif
+        break
+    endwhile

 
 

-    if text =~ '\\$'
+    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.

-        if getline(start) =~# s:control_statement
+        if getline(start) =~# b:control_statement

             return base + s:sw() * 2
         endif
 
             return base + s:sw() * 2
         endif
 


@@ -209,10 +281,34 @@ function! s:indent_like_previous_line(lnum)
         return -1
     endif
 
         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
 
     " 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
 function! GetPythonPEPIndent(lnum)
 
     " First line has indent 0


@@ -220,6 +316,24 @@ function! GetPythonPEPIndent(lnum)
         return 0
     endif
 
         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
     " 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