RefactoringResultConsumer.h 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. #pragma once
  2. #ifdef __GNUC__
  3. #pragma GCC diagnostic push
  4. #pragma GCC diagnostic ignored "-Wunused-parameter"
  5. #endif
  6. //===--- RefactoringResultConsumer.h - Clang refactoring library ----------===//
  7. //
  8. // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
  9. // See https://llvm.org/LICENSE.txt for license information.
  10. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  11. //
  12. //===----------------------------------------------------------------------===//
  13. #ifndef LLVM_CLANG_TOOLING_REFACTORING_REFACTORINGRESULTCONSUMER_H
  14. #define LLVM_CLANG_TOOLING_REFACTORING_REFACTORINGRESULTCONSUMER_H
  15. #include "clang/Basic/LLVM.h"
  16. #include "clang/Tooling/Refactoring/AtomicChange.h"
  17. #include "clang/Tooling/Refactoring/Rename/SymbolOccurrences.h"
  18. #include "llvm/Support/Error.h"
  19. namespace clang {
  20. namespace tooling {
  21. /// An abstract interface that consumes the various refactoring results that can
  22. /// be produced by refactoring actions.
  23. ///
  24. /// A valid refactoring result must be handled by a \c handle method.
  25. class RefactoringResultConsumer {
  26. public:
  27. virtual ~RefactoringResultConsumer() {}
  28. /// Handles an initiation or an invication error. An initiation error typically
  29. /// has a \c DiagnosticError payload that describes why initiation failed.
  30. virtual void handleError(llvm::Error Err) = 0;
  31. /// Handles the source replacements that are produced by a refactoring action.
  32. virtual void handle(AtomicChanges SourceReplacements) {
  33. defaultResultHandler();
  34. }
  35. /// Handles the symbol occurrences that are found by an interactive
  36. /// refactoring action.
  37. virtual void handle(SymbolOccurrences Occurrences) { defaultResultHandler(); }
  38. private:
  39. void defaultResultHandler() {
  40. handleError(llvm::make_error<llvm::StringError>(
  41. "unsupported refactoring result", llvm::inconvertibleErrorCode()));
  42. }
  43. };
  44. } // end namespace tooling
  45. } // end namespace clang
  46. #endif // LLVM_CLANG_TOOLING_REFACTORING_REFACTORINGRESULTCONSUMER_H
  47. #ifdef __GNUC__
  48. #pragma GCC diagnostic pop
  49. #endif