xref: /minix3/external/bsd/llvm/dist/clang/tools/clang-format/clang-format.py (revision 0a6a1f1d05b60e214de2f05a7310ddd1f0e590e7) 
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> <c-o>:pyf <path-to-this-file>/clang-format.py<cr>
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
20import difflib
21import json
22import subprocess
23import sys
24import vim
25
26# set g:clang_format_path to the path to clang-format if it is not on the path
27# Change this to the full path if clang-format is not on the path.
28binary = 'clang-format'
29if vim.eval('exists("g:clang_format_path")') == "1":
30  binary = vim.eval('g:clang_format_path')
31
32# Change this to format according to other formatting styles. See the output of
33# 'clang-format --help' for a list of supported styles. The default looks for
34# a '.clang-format' or '_clang-format' file to indicate the style that should be
35# used.
36style = 'file'
37
38def main():
39  # Get the current text.
40  buf = vim.current.buffer
41  text = '\n'.join(buf)
42
43  # Determine range to format.
44  lines = '%s:%s' % (vim.current.range.start + 1, vim.current.range.end + 1)
45
46  # Determine the cursor position.
47  cursor = int(vim.eval('line2byte(line("."))+col(".")')) - 2
48  if cursor < 0:
49    print 'Couldn\'t determine cursor position. Is your file empty?'
50    return
51
52  # Avoid flashing an ugly, ugly cmd prompt on Windows when invoking clang-format.
53  startupinfo = None
54  if sys.platform.startswith('win32'):
55    startupinfo = subprocess.STARTUPINFO()
56    startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW
57    startupinfo.wShowWindow = subprocess.SW_HIDE
58
59  # Call formatter.
60  command = [binary, '-lines', lines, '-style', style, '-cursor', str(cursor)]
61  if vim.current.buffer.name:
62    command.extend(['-assume-filename', vim.current.buffer.name])
63  p = subprocess.Popen(command,
64                       stdout=subprocess.PIPE, stderr=subprocess.PIPE,
65                       stdin=subprocess.PIPE, startupinfo=startupinfo)
66  stdout, stderr = p.communicate(input=text)
67
68  # If successful, replace buffer contents.
69  if stderr:
70    print stderr
71
72  if not stdout:
73    print ('No output from clang-format (crashed?).\n' +
74        'Please report to bugs.llvm.org.')
75  else:
76    lines = stdout.split('\n')
77    output = json.loads(lines[0])
78    lines = lines[1:]
79    sequence = difflib.SequenceMatcher(None, vim.current.buffer, lines)
80    for op in reversed(sequence.get_opcodes()):
81      if op[0] is not 'equal':
82        vim.current.buffer[op[1]:op[2]] = lines[op[3]:op[4]]
83    vim.command('goto %d' % (output['Cursor'] + 1))
84
85main()
86