[clang-rename] add basic Emacs integration

[omtcyfz]

Summary

This patch aims to add very basic Emacs integration. My experience with Emacs is limited to few days, so I'm not sure whether I've done things correctly.

[omtcyfz]

Update docs by adding information about Emacs integration.

[klimek]

clang-rename/tool/clang-rename.el

7 ↗

(On Diff #66292)

s/clang-format/clang-rename/, and fix docs in general :)

17 ↗

(On Diff #66292)

Typo.

[omtcyfz]

clang-rename/tool/clang-rename.el

7 ↗

(On Diff #66292)

Aw, yeah. This block was just copied :D

[omtcyfz]

Manuel, any other comments? Jens seems to be missing and I don't know about anyone else who is familiar with Emacs :(

[hokein]

clang-rename/tool/clang-rename.el

16 ↗

(On Diff #66296)

I think we should make clang-rename binary path configurable by making it a custom variable (using defcustom).

20 ↗

(On Diff #66296)

s is an extra character here?

27 ↗

(On Diff #66296)

Any reason why not use call-process-region?

docs/clang-rename.rst

106 ↗

(On Diff #66296)

missing two "=".

114 ↗

(On Diff #66296)

print doesn't make sense here? I think user should type clang-rename and new name.

[alexfh]

clang-rename/tool/clang-rename.el

18 ↗

(On Diff #66296)

The name should be just "clang-rename".

docs/clang-rename.rst

100 ↗

(On Diff #66296)

Remove the linebreak after "The".

114 ↗

(On Diff #66296)

Yep, just s/print/type/.

[omtcyfz]

clang-rename/tool/clang-rename.el

20 ↗

(On Diff #66296)

No, it tells Emacs to read a string.

27 ↗

(On Diff #66296)

/* discussed */

[omtcyfz]

All the comments seem to be addressed.

[alexfh]

clang-rename/tool/clang-rename.el

28 ↗

(On Diff #66328)

For posterity, please add a short summary of the offline discussion.

docs/clang-rename.rst

104 ↗

(On Diff #66328)

Either Clang-rename Emacs integration or just Emacs integration.

[omtcyfz]

clang-rename/tool/clang-rename.el

28 ↗

(On Diff #66328)

call-process-region is used while contents of current buffer are to be replaced, but in case of clang-rename changes might affect all buffers, which doesn't make sense to take care of one buffer only.

[Eugene.Zelenko]

Please add install rule for clang-rename.el. See clang-format CMakeLists.txt as example.

[omtcyfz]

In D23006#502814, @Eugene.Zelenko wrote:

Please add install rule for clang-rename.el. See clang-format CMakeLists.txt as example.

Good point! Thank you!

Done.

[hokein]

lgtm with two nits.

clang-rename/tool/CMakeLists.txt

14 ↗

(On Diff #66434)

Also include the vim integration clang-rename.py?

docs/clang-rename.rst

99 ↗

(On Diff #66434)

s/print/type

[omtcyfz]

• s/print/type
• Add clang-rename.py to the CMakeLists.txt installation instructions.

[omtcyfz]

Thanks! Fixed.

Waiting few more hours just in case anyone will jump in and write few comments.

[alexfh]

LG

clang-tools-extra/trunk/clang-rename/tool/CMakeLists.txt

 add_clang_executable(clang-rename ClangRename.cpp)
 
 target_link_libraries(clang-rename
   clangBasic
   clangFrontend
   clangRename
   clangRewrite
   clangTooling
   clangToolingCore
   )
 
 install(TARGETS clang-rename RUNTIME DESTINATION bin)
+
+install(PROGRAMS clang-rename.py
+  DESTINATION share/clang
+  COMPONENT clang-rename)
+install(PROGRAMS clang-rename.el
+  DESTINATION share/clang
+  COMPONENT clang-rename)

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

+;;; clang-rename.el --- Renames every occurrence of a symbol found at <offset>.
+
+;; Keywords: tools, c
+
+;;; Commentary:
+
+;; To install clang-rename.el make sure the directory of this file is in your
+;; 'load-path' and add
+;;
+;;   (require 'clang-rename)
+;;
+;; to your .emacs configuration.
+
+;;; Code:
+
+(defcustom clang-rename-binary "clang-rename"
+  "Path to clang-rename executable."
+  :type 'hook
+  :options '(turn-on-auto-fill flyspell-mode)
+  :group 'wp)
+
+(defun clang-rename (new-name)
+  "Rename all instances of the symbol at the point using clang-rename"
+  (interactive "sEnter a new name: ")
+  (let (;; Emacs offset is 1-based.
+        (offset (- (point) 1))
+        (orig-buf (current-buffer))
+        (file-name (buffer-file-name)))
+
+    (let ((rename-command
+          (format "bash -f -c '%s -offset=%s -new-name=%s -i %s'"
+                               clang-rename-binary offset new-name file-name)))
+          (message (format "Running clang-rename command %s" rename-command))
+          ;; Run clang-rename via bash.
+          (shell-command rename-command)
+          ;; Reload buffer.
+          (interactive)
+          (revert-buffer t t)
+    )
+  )
+)
+
+(provide 'clang-rename)
+
+;;; clang-rename.el ends here

clang-tools-extra/trunk/docs/clang-rename.rst

 classes, functions, variables, arguments, namespaces etc.
 
 The tool is in a very early development stage, so you might encounter bugs and
 crashes. Submitting reports with information about how to reproduce the issue
 to `the LLVM bugtracker <https://llvm.org/bugs>`_ will definitely help the
 project. If you have any ideas or suggestions, you might want to put a feature
 request there.
 
-Using clang-rename
+Using Clang-Rename
 ==================
 
 :program:`clang-rename` is a `LibTooling
 <http://clang.llvm.org/docs/LibTooling.html>`_-based tool, and it's easier to
 work with if you set up a compile command database for your project (for an
 example of how to do this see `How To Setup Tooling For LLVM
 <http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html>`_). You can also
-specify compilation options on the command line after ``--``:
+specify compilation options on the command line after `--`:
 
 .. code-block:: console
 
   $ clang-rename -offset=42 -new-name=foo test.cpp -- -Imy_project/include -DMY_DEFINES ...
 
 
 To get an offset of a symbol in a file run
 
 .. code-block:: console
 
   $ grep -FUbo 'foo' file.cpp
 
 
 The tool currently supports renaming actions inside a single Translation Unit
 only. It is planned to extend the tool's functionality to support multi-TU
 renaming actions in the future.
 
 :program:`clang-rename` also aims to be easily integrated into popular text
-editors, such as Vim, and improve the workflow of users.
+editors, such as Vim and Emacs, and improve the workflow of users.
 
 Although a command line interface exists, it is highly recommended to use the
 text editor interface instead for better experience.
 
 .. code-block:: console
 
   $ clang-rename -help
   OVERVIEW: A tool to rename symbols in C/C++ code.
.. code-block:: console
 
   Generic Options:
 
     -help                      - Display available options (-help-hidden for more)
     -help-list                 - Display list of available options (-help-list-hidden for more)
     -version                   - Display the version of this program
 
 
-clang-rename Vim integration
-============================
+Vim Integration
+===============
 
 You can call :program:`clang-rename` directly from Vim! To set up
 :program:`clang-rename` integration for Vim see
 `clang-rename/tool/clang-rename.py
 <http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-rename/tool/clang-rename.py>`_.
 
 Please note that **you have to save all buffers, in which the replacement will
 happen before running the tool**.
 
 Once installed, you can point your cursor to symbols you want to rename, press
-``<leader>cr`` and print new desired name. The
-[``<leader> key``](http://vim.wikia.com/wiki/Mapping_keys_in_Vim_-_Tutorial_(Part_3)#Map_leader)
+`<leader>cr` and type new desired name. The [`<leader> key`]
+(http://vim.wikia.com/wiki/Mapping_keys_in_Vim_-_Tutorial_(Part_3)#Map_leader)
 is a reference to a specific key defined by the mapleader variable and is bound
 to backslash by default.
+
+Emacs Integration
+=================
+
+You can also use :program:`clang-rename` while using Emacs! To set up
+:program:`clang-rename` integration for Emacs see
+`clang-rename/tool/clang-rename.el
+<http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-rename/tool/clang-rename.el>`_.
+
+Once installed, you can point your cursor to symbols you want to rename, press
+`M-X`, type `clang-rename` and new desired name.
+
+Please note that **you have to save all buffers, in which the replacement will
+happen before running the tool**.