]> git.madduck.net Git - etc/vim.git/blobdiff - indent/python.vim

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Merge pull request #38 from blueyed/doc-fix-sw-note
[etc/vim.git] / indent / python.vim
index 7b6580ab69f8c618259c6201d4502f5ff6781802..026a0565fd66f840c4e693b09abf4dcc12568707 100644 (file)
@@ -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,30 @@ 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*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\)\>'
   \ '^\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\)\>'
-if v:version >= 704 || (v:version == 703 && has('patch1037'))
-  let s:string_literal = '".\{-}\\\@1<!"\|''.\{-}\\\@1<!'''
-else
-  let s:string_literal = '".\{-}\\\@<!"\|''.\{-}\\\@<!'''
-endif
 
 
-" compatibility with vim patch 7.3.629: 'sw' can be set to -1 to follow 'ts'
+" Skip strings and comments
+let s:skip_special_chars = 'synIDattr(synID(line("."), col("."), 0), "name") ' .
+           \ '=~? "string\\|comment"'
+
+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 +83,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
     " Return if cursor is in a comment or string
-    exe 'if' skip '| return [0, 0] | endif'
+    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
@@ -132,13 +148,22 @@ function! s:indent_like_opening_paren(lnum)
 
     if nothing_after_opening_paren
         if starts_with_closing_paren
 
     if nothing_after_opening_paren
         if starts_with_closing_paren
-            return base
+            let res = base
         else
         else
-            return base + s:sw()
+            let res = base + s:sw()
         endif
     else
         " Indent to match position of opening paren.
         endif
     else
         " Indent to match position of opening paren.
-        return paren_col
+        let res = paren_col
+    endif
+
+    " 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()
+        return base + s:sw() * 2
+    else
+        return res
     endif
 endfunction
 
     endif
 endfunction
 
@@ -164,21 +189,31 @@ 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)
+
+    " No previous line, keep current indent.
+    if lnum < 1
+      return -1
+    endif
+
     let text = getline(lnum)
     let start = s:find_start_of_multiline_statement(lnum)
     let base = indent(start)
     let text = getline(lnum)
     let start = s:find_start_of_multiline_statement(lnum)
     let base = indent(start)
+    let current = indent(a:lnum)
 
 
-    " Remove string literals.
-    let text = substitute(text, s:string_literal, '', 'g')
+    " Jump to last character in previous line.
+    call cursor(lnum, len(text))
+    let ignore_last_char = eval(s:skip_special_chars)
 
 
-    " If the previous line ended with a colon and is not a comment, indent
-    " relative to statement start.
-    if text =~ '^[^#]*:\s*\(#.*\)\?$'
+    " Search for final colon that is not inside a string or comment.
+    while search(':\s*\%(#.*\)\?$', 'bcW', lnum)
+      if eval(s:skip_special_chars)
+        normal! h
+      else
         return base + s:sw()
         return base + s:sw()
-    endif
-
+      endif
+    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.
@@ -200,6 +235,13 @@ 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