Clang-Rename — Extra Clang Tools 3.9 documentation

# Extra Clang Tools 3.9 documentation

## Clang-Rename

Contents

- Clang-Rename
  - Using clang-rename
  - clang-rename Vim integration

See also:

clang-rename is a clang-based C++ “linter” tool. Its purpose is to perform efficient renaming actions in large-scale projects such as renaming 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 will definitely help the project. If you have any ideas or suggestions, you might want to put a feature request there.

## Using clang-rename

clang-rename is a LibTooling-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). You can also specify compilation options on the command line after `--`:

    $ 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

    $ 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.

clang-rename also aims to be easily integrated into popular text editors, such as Vim, 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.

    $ clang-rename -help
    OVERVIEW: A tool to rename symbols in C/C++ code.
    clang-rename renames every occurrence of a symbol found at <offset> in
    <source0>. If -i is specified, the edited files are overwritten to disk.
    Otherwise, the results are written to stdout.

    USAGE: clang-rename [subcommand] [options] <source0> [... <sourceN>]

    OPTIONS:

    Clang-rename options:

      -export-fixes=<filename>   - YAML file to store suggested fixes in.
      -extra-arg=<string>        - Additional argument to append to the compiler command line
      -extra-arg-before=<string> - Additional argument to prepend to the compiler command line
      -i                         - Overwrite edited <file>s.
      -new-name=<string>         - The new name to change the symbol to.
      -offset=<uint>             - Locates the symbol by offset as opposed to <line>:<column>.
      -old-name=<string>         - The fully qualified name of the symbol, if -offset is not used.
      -p=<string>                - Build path
      -pl                        - Print the locations affected by renaming to stderr.
      -pn                        - Print the found symbol's name prior to renaming to stderr.

    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

You can call clang-rename directly from Vim! To set up clang-rename integration for Vim see clang-rename/tool/clang-rename.py.

Once installed, you can point your cursor to the symbols you want to rename, press ,cr and print new desired name.

Please note that you have to save all buffers, in which the replacement will happen before running the tool.