diff --git a/clang-tools-extra/clang-rename/tool/ClangRename.cpp b/clang-tools-extra/clang-rename/tool/ClangRename.cpp index dc2b7a55b722..dcbfd2a310e9 100644 --- a/clang-tools-extra/clang-rename/tool/ClangRename.cpp +++ b/clang-tools-extra/clang-rename/tool/ClangRename.cpp @@ -56,6 +56,33 @@ static int renameAtMain(int argc, const char *argv[]); static int renameAllMain(int argc, const char *argv[]); static int helpMain(int argc, const char *argv[]); +/// \brief An oldname -> newname rename. +struct RenameAllInfo { + std::string OldName; + unsigned Offset; + std::string NewName; + + RenameAllInfo() : Offset(0) {} +}; + +LLVM_YAML_IS_SEQUENCE_VECTOR(RenameAllInfo) + +namespace llvm { +namespace yaml { + +/// \brief Specialized MappingTraits to describe how a RenameAllInfo is / +/// (de)serialized. +template <> struct MappingTraits { + static void mapping(IO &IO, RenameAllInfo &Info) { + IO.mapOptional("OldName", Info.OldName); + IO.mapOptional("Offset", Info.Offset); + IO.mapRequired("NewName", Info.NewName); + } +}; + +} // end namespace yaml +} // end namespace llvm + int main(int argc, const char **argv) { if (argc > 1) { using MainFunction = std::function; @@ -91,7 +118,7 @@ int subcommandMain(bool isRenameAll, int argc, const char **argv) { cl::list NewNames( "new-name", cl::desc("The new name to change the symbol to."), - (isRenameAll ? cl::OneOrMore : cl::Required), cl::cat(*Category)); + (isRenameAll ? cl::ZeroOrMore : cl::Required), cl::cat(*Category)); cl::list SymbolOffsets( "offset", cl::desc("Locates the symbol by offset as opposed to :."), @@ -114,11 +141,40 @@ int subcommandMain(bool isRenameAll, int argc, const char **argv) { cl::opt ExportFixes( "export-fixes", cl::desc("YAML file to store suggested fixes in."), cl::value_desc("filename"), cl::cat(*Category)); + cl::opt Input( + "input", cl::desc("YAML file to load oldname-newname pairs from."), + cl::Optional, cl::cat(ClangRenameAllCategory)); tooling::CommonOptionsParser OP(argc, argv, *Category, Usage); + if (!Input.empty()) { + // Populate OldNames and NewNames from a YAML file. + auto Buffer = llvm::MemoryBuffer::getFile(Input); + if (!Buffer) { + errs() << "clang-rename: failed to read " << Input << ": " + << Buffer.getError().message() << "\n"; + exit(1); + } + + std::vector Infos; + llvm::yaml::Input YAML(Buffer.get()->getBuffer()); + YAML >> Infos; + for (const auto &Info : Infos) { + if (!Info.OldName.empty()) + OldNames.push_back(Info.OldName); + else + SymbolOffsets.push_back(Info.Offset); + NewNames.push_back(Info.NewName); + } + } + // Check the arguments for correctness. + if (NewNames.empty()) { + errs() << "clang-rename: either -new-name or -input is required.\n\n"; + exit(1); + } + // Check if NewNames is a valid identifier in C++17. for (const auto &NewName : NewNames) { LangOptions Options; diff --git a/clang-tools-extra/docs/clang-rename.rst b/clang-tools-extra/docs/clang-rename.rst index d49b6f0776d1..5d753446e403 100644 --- a/clang-tools-extra/docs/clang-rename.rst +++ b/clang-tools-extra/docs/clang-rename.rst @@ -42,14 +42,6 @@ To get an offset of a symbol in a file run $ grep -FUbo 'foo' file.cpp -You can also identify one or more symbols to be renamed by giving the fully qualified -name: - -.. code-block:: console - - $ clang-rename rename-all -old-name=foo -new-name=bar test.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. @@ -60,6 +52,43 @@ 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. +You can also identify one or more symbols to be renamed by giving the fully qualified +name: + +.. code-block:: console + + $ clang-rename rename-all -old-name=foo -new-name=bar test.cpp + + +Alternatively, old name / new name pairs can be put into a YAML file: + +.. code-block:: yaml + + --- + - OldName: foo + NewName: bar + ... + + +That way you can avoid spelling out all the names as commandline arguments: + +.. code-block:: console + + $ clang-rename rename-all -input=test.yaml test.cpp + + +The YAML file also supports offsets: + +.. code-block:: yaml + + --- + - Offset: 42 + NewName: foo + ... + + +:program:`clang-rename` offers the following options: + .. code-block:: console $ clang-rename -help @@ -125,6 +154,7 @@ text editor interface instead for better experience. -extra-arg= - Additional argument to append to the compiler command line -extra-arg-before= - Additional argument to prepend to the compiler command line -i - Overwrite edited s. + -input= - YAML file to load oldname-newname pairs from. -new-name= - The new name to change the symbol to. -offset= - Locates the symbol by offset as opposed to :. -old-name= - The fully qualified name of the symbol, if -offset is not used. diff --git a/clang-tools-extra/test/clang-rename/ClassTestMultiByNameYAML.cpp b/clang-tools-extra/test/clang-rename/ClassTestMultiByNameYAML.cpp new file mode 100644 index 000000000000..f0d51cd883fb --- /dev/null +++ b/clang-tools-extra/test/clang-rename/ClassTestMultiByNameYAML.cpp @@ -0,0 +1,7 @@ +class Foo1 { // CHECK: class Bar1 +}; + +class Foo2 { // CHECK: class Bar2 +}; +// RUN: clang-rename rename-all -input %S/Inputs/ClassTestMultiByNameYAMLRenameAll.yaml %s -- | sed 's,//.*,,' | FileCheck %s +// RUN: clang-rename rename-all -input %S/Inputs/ClassTestMultiByNameYAMLRenameAt.yaml %s -- | sed 's,//.*,,' | FileCheck %s diff --git a/clang-tools-extra/test/clang-rename/Inputs/ClassTestMultiByNameYAMLRenameAll.yaml b/clang-tools-extra/test/clang-rename/Inputs/ClassTestMultiByNameYAMLRenameAll.yaml new file mode 100644 index 000000000000..cb381b30e501 --- /dev/null +++ b/clang-tools-extra/test/clang-rename/Inputs/ClassTestMultiByNameYAMLRenameAll.yaml @@ -0,0 +1,6 @@ +--- +- OldName: Foo1 + NewName: Bar1 +- OldName: Foo2 + NewName: Bar2 +... diff --git a/clang-tools-extra/test/clang-rename/Inputs/ClassTestMultiByNameYAMLRenameAt.yaml b/clang-tools-extra/test/clang-rename/Inputs/ClassTestMultiByNameYAMLRenameAt.yaml new file mode 100644 index 000000000000..d8e972880f36 --- /dev/null +++ b/clang-tools-extra/test/clang-rename/Inputs/ClassTestMultiByNameYAMLRenameAt.yaml @@ -0,0 +1,6 @@ +--- +- Offset: 6 + NewName: Bar1 +- Offset: 44 + NewName: Bar2 +...