[clang-rename] add basic vim integration

[omtcyf0]

Summary

This patch introduces basic Vim integration for clang-rename tool.

For setup reference see clang-rename/tool/clang-rename.py

[bkramer]

clang-rename/tool/ClangRename.cpp

39 ↗

(On Diff #63050)

This looks unrelated.

clang-rename/tool/clang-rename.py

15

The comment should say that you have to save the file before running the tool.

41

Maybe add a FIXME to input the unsaved file via stdin like we do for clang-format?

48

stdin is pipe but you never write to it? Is that intentional?

49

Should we output stderr in case the tool fails?

[bkramer]

looks good. Still no commit access? ;)

[omtcyf0]

Yup. FeelsBadMan.

One note about that header removal: how do I do it then? I thought attaching such changes to a random patch is not a problem. Otherwise there will be some one-line patches for such things, won't they?

clang-rename/tool/ClangRename.cpp

39 ↗

(On Diff #63050)

Right, but I'm not sure one-line patches are welcome.

Is it not alright to put such into random patches? Otherwise creating one-liner...

[ioeric]

clang-rename/tool/clang-rename.py

13

Maybe a different key binding so that it doesn't conflict with include-fixer's suggested key binding? ,cr for clang-rename maybe?

34

Redirect error messages to stderr so that they are highlighted in vim?

[bkramer]

clang-rename/tool/ClangRename.cpp

39 ↗

(On Diff #63050)

I'd do it on the next change to that file, but I can also include it in the patch this time. I generally dislike having completely unrelated changes in a patch and the unnecessary include here doesn't really hurt anyone.

[alexfh]

clang-rename/tool/clang-rename.py

13

Also, "clang-include-fixer.py" should be updated.

[omtcyf0]

clang-rename/tool/clang-rename.py

13

Aw, sure; sorry for that. That's an artifact from first version of the script, so this line was simply copy-pasted...

[alexfh]

clang-rename/tool/ClangRename.cpp

39 ↗

(On Diff #63050)

> I'm not sure one-line patches are welcome.

Cleanup-only patches are fine.

[alexfh]

LG

clang-rename/tool/clang-rename.py

17

s/,cf/,cr/

[omtcyf0]

@bkramer can you please land the patch?

[kimgr]

I only caught this typo after it was committed.

clang-tools-extra/trunk/clang-rename/tool/clang-rename.py

17–18 ↗

(On Diff #63072)

s/promted/prompted for/

[omtcyf0]

@kimgr oops, sorry.

I'll send a cleanup patch.

Thanks for noticing.

clang-rename/tool/clang-rename.py

+'''
+Minimal clang-rename integration with Vim.
+
+Before installing make sure one of the following is satisfied:
+
+* clang-rename is in your PATH
+* `g:clang_rename_path` in ~/.vimrc points to valid clang-rename executable
+* `binary` in clang-rename.py points to valid to clang-rename executable
+
+To install, simply put this into your ~/.vimrc
+
+    map ,cr :pyf <path-to>/clang-rename.py<cr>
+
+IMPORTANT NOTE: Before running the tool, make sure you saved the file.
+
+All you have to do now is to place a cursor on a variable/function/class which
+you would like to rename and press ',cf'. You will be promted a new name if the
+cursor points to a valid symbol.
+'''
+
+import vim
+import subprocess
+import sys
+
+def main():
+    binary = 'clang-rename'
+    if vim.eval('exists("g:clang_rename_path")') == "1":
+        binary = vim.eval('g:clang_rename')
+
+    # Get arguments for clang-rename binary.
+    offset = int(vim.eval('line2byte(line("."))+col(".")')) - 2
+    if offset < 0:
+        print >> sys.stderr, '''Couldn\'t determine cursor position.
+                                Is your file empty?'''
+        return
+    filename = vim.current.buffer.name
+
+    new_name_request_message = 'type new name:'
+    new_name = vim.eval("input('{}\n')".format(new_name_request_message))
+
+    # Call clang-rename.
+    command = [binary,
+               filename,
+               '-i',
+               '-offset', str(offset),
+               '-new-name', str(new_name)]
+    # FIXME: make it possible to run the tool on unsaved file.
+    p = subprocess.Popen(command,
+                         stdout=subprocess.PIPE,
+                         stderr=subprocess.PIPE)
+    stdout, stderr = p.communicate()
+
+    if stderr:
+        print stderr
+
+    # Reload all buffers in Vim.
+    vim.command("bufdo edit")
+
+
+if __name__ == '__main__':
+    main()