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