xref: /llvm-project/clang/tools/clang-format/clang-format.py (revision bc36e6e0996267a58dbbfdee6e975a77bb780599)
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
20import difflib
21import json
22import subprocess
23import sys
24import vim
25
26# Change this to the full path if clang-format is not on the path.
27binary = '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' file to indicate the style that should be used.
32style = 'file'
33
34# Get the current text.
35buf = vim.current.buffer
36text = '\n'.join(buf)
37
38# Determine range to format.
39cursor = int(vim.eval('line2byte(line("."))+col(".")')) - 2
40lines = '%s:%s' % (vim.current.range.start + 1, vim.current.range.end + 1)
41
42# Avoid flashing an ugly, ugly cmd prompt on Windows when invoking clang-format.
43startupinfo = None
44if sys.platform.startswith('win32'):
45  startupinfo = subprocess.STARTUPINFO()
46  startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW
47  startupinfo.wShowWindow = subprocess.SW_HIDE
48
49# Call formatter.
50p = subprocess.Popen([binary, '-lines', lines, '-style', style,
51                      '-cursor', str(cursor)],
52                     stdout=subprocess.PIPE, stderr=subprocess.PIPE,
53                     stdin=subprocess.PIPE, startupinfo=startupinfo)
54stdout, stderr = p.communicate(input=text)
55
56# If successful, replace buffer contents.
57if stderr:
58  message = stderr.splitlines()[0]
59  parts = message.split(' ', 2)
60  if len(parts) > 2:
61    message = parts[2]
62  print 'Formatting failed: %s (total %d warnings, %d errors)' % (
63      message, stderr.count('warning:'), stderr.count('error:'))
64
65if not stdout:
66  print ('No output from clang-format (crashed?).\n' +
67      'Please report to bugs.llvm.org.')
68else:
69  lines = stdout.split('\n')
70  output = json.loads(lines[0])
71  lines = lines[1:]
72  sequence = difflib.SequenceMatcher(None, vim.current.buffer, lines)
73  for op in reversed(sequence.get_opcodes()):
74    if op[0] is not 'equal':
75      vim.current.buffer[op[1]:op[2]] = lines[op[3]:op[4]]
76  vim.command('goto %d' % (output['Cursor'] + 1))
77