Home | History | Annotate | Download | only in clang-format 
      1 # This file is a minimal clang-format vim-integration. To install:
      2 # - Change 'binary' if clang-format is not on the path (see below).
      3 # - Add to your .vimrc:
      4 #
      5 #   map <C-I> :pyf <path-to-this-file>/clang-format.py<CR>
      6 #   imap <C-I> <ESC>:pyf <path-to-this-file>/clang-format.py<CR>i
      7 #
      8 # The first line enables clang-format for NORMAL and VISUAL mode, the second
      9 # line adds support for INSERT mode. Change "C-I" to another binding if you
     10 # need clang-format on a different key (C-I stands for Ctrl+i).
     11 #
     12 # With this integration you can press the bound key and clang-format will
     13 # format the current line in NORMAL and INSERT mode or the selected region in
     14 # VISUAL mode. The line or region is extended to the next bigger syntactic
     15 # entity.
     16 #
     17 # It operates on the current, potentially unsaved buffer and does not create
     18 # or save any files. To revert a formatting, just undo.
     19 
     20 import difflib
     21 import json
     22 import subprocess
     23 import sys
     24 import vim
     25 
     26 # Change this to the full path if clang-format is not on the path.
     27 binary = 'clang-format'
     28 
     29 # Change this to format according to other formatting styles. See the output of
     30 # 'clang-format --help' for a list of supported styles. The default looks for
     31 # a '.clang-format' or '_clang-format' file to indicate the style that should be
     32 # used.
     33 style = 'file'
     34 
     35 def main():
     36   # Get the current text.
     37   buf = vim.current.buffer
     38   text = '\n'.join(buf)
     39 
     40   # Determine range to format.
     41   lines = '%s:%s' % (vim.current.range.start + 1, vim.current.range.end + 1)
     42 
     43   # Determine the cursor position.
     44   cursor = int(vim.eval('line2byte(line("."))+col(".")')) - 2
     45   if cursor < 0:
     46     print 'Couldn\'t determine cursor position. Is your file empty?'
     47     return
     48 
     49   # Avoid flashing an ugly, ugly cmd prompt on Windows when invoking clang-format.
     50   startupinfo = None
     51   if sys.platform.startswith('win32'):
     52     startupinfo = subprocess.STARTUPINFO()
     53     startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW
     54     startupinfo.wShowWindow = subprocess.SW_HIDE
     55 
     56   # Call formatter.
     57   command = [binary, '-lines', lines, '-style', style, '-cursor', str(cursor)]
     58   if vim.current.buffer.name:
     59     command.extend(['-assume-filename', vim.current.buffer.name])
     60   p = subprocess.Popen(command,
     61                        stdout=subprocess.PIPE, stderr=subprocess.PIPE,
     62                        stdin=subprocess.PIPE, startupinfo=startupinfo)
     63   stdout, stderr = p.communicate(input=text)
     64 
     65   # If successful, replace buffer contents.
     66   if stderr:
     67     print stderr
     68 
     69   if not stdout:
     70     print ('No output from clang-format (crashed?).\n' +
     71         'Please report to bugs.llvm.org.')
     72   else:
     73     lines = stdout.split('\n')
     74     output = json.loads(lines[0])
     75     lines = lines[1:]
     76     sequence = difflib.SequenceMatcher(None, vim.current.buffer, lines)
     77     for op in reversed(sequence.get_opcodes()):
     78       if op[0] is not 'equal':
     79         vim.current.buffer[op[1]:op[2]] = lines[op[3]:op[4]]
     80     vim.command('goto %d' % (output['Cursor'] + 1))
     81 
     82 main()
     83