blob: 3381c5267f1c0416cffb99700d21f944c89b3bcc [file] [log] [blame]
Benjamin Kramer3a12ca52016-07-07 14:35:32 +00001'''
2Minimal clang-rename integration with Vim.
3
4Before installing make sure one of the following is satisfied:
5
6* clang-rename is in your PATH
7* `g:clang_rename_path` in ~/.vimrc points to valid clang-rename executable
8* `binary` in clang-rename.py points to valid to clang-rename executable
9
Jonas Toth1188e5d2018-08-06 09:08:06 +000010To install, simply put this into your ~/.vimrc for python2 support
Benjamin Kramer3a12ca52016-07-07 14:35:32 +000011
Kirill Bobyrevc4018e22016-07-27 14:23:47 +000012 noremap <leader>cr :pyf <path-to>/clang-rename.py<cr>
Benjamin Kramer3a12ca52016-07-07 14:35:32 +000013
Jonas Toth1188e5d2018-08-06 09:08:06 +000014For python3 use the following command (note the change from :pyf to :py3f)
15
16 noremap <leader>cr :py3f <path-to>/clang-rename.py<cr>
17
Benjamin Kramer3a12ca52016-07-07 14:35:32 +000018IMPORTANT NOTE: Before running the tool, make sure you saved the file.
19
20All you have to do now is to place a cursor on a variable/function/class which
Kirill Bobyrevc4018e22016-07-27 14:23:47 +000021you would like to rename and press '<leader>cr'. You will be prompted for a new
22name if the cursor points to a valid symbol.
Benjamin Kramer3a12ca52016-07-07 14:35:32 +000023'''
24
Serge Gueltonb748c0e2018-12-18 16:07:37 +000025from __future__ import absolute_import, division, print_function
Benjamin Kramer3a12ca52016-07-07 14:35:32 +000026import vim
27import subprocess
28import sys
29
30def main():
31 binary = 'clang-rename'
32 if vim.eval('exists("g:clang_rename_path")') == "1":
Saleem Abdulrasoolb12d27b2016-07-19 02:13:08 +000033 binary = vim.eval('g:clang_rename_path')
Benjamin Kramer3a12ca52016-07-07 14:35:32 +000034
35 # Get arguments for clang-rename binary.
36 offset = int(vim.eval('line2byte(line("."))+col(".")')) - 2
37 if offset < 0:
Jonas Toth1188e5d2018-08-06 09:08:06 +000038 print('Couldn\'t determine cursor position. Is your file empty?',
39 file=sys.stderr)
Benjamin Kramer3a12ca52016-07-07 14:35:32 +000040 return
41 filename = vim.current.buffer.name
42
43 new_name_request_message = 'type new name:'
44 new_name = vim.eval("input('{}\n')".format(new_name_request_message))
45
46 # Call clang-rename.
47 command = [binary,
48 filename,
49 '-i',
50 '-offset', str(offset),
51 '-new-name', str(new_name)]
52 # FIXME: make it possible to run the tool on unsaved file.
53 p = subprocess.Popen(command,
54 stdout=subprocess.PIPE,
55 stderr=subprocess.PIPE)
56 stdout, stderr = p.communicate()
57
58 if stderr:
Jonas Toth1188e5d2018-08-06 09:08:06 +000059 print(stderr)
Benjamin Kramer3a12ca52016-07-07 14:35:32 +000060
61 # Reload all buffers in Vim.
Kirill Bobyrevbd80bbd2016-09-26 07:26:32 +000062 vim.command("checktime")
Benjamin Kramer3a12ca52016-07-07 14:35:32 +000063
64
65if __name__ == '__main__':
66 main()