//===--- USRFindingAction.h - Clang refactoring library -------------------===//

//

// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.

// See https://llvm.org/LICENSE.txt for license information.

// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

//

//===----------------------------------------------------------------------===//

///

/// \file

/// Provides an action to find all relevant USRs at a point.

///

//===----------------------------------------------------------------------===//

#ifndef LLVM_CLANG_TOOLING_REFACTORING_RENAME_USRFINDINGACTION_H

#define LLVM_CLANG_TOOLING_REFACTORING_RENAME_USRFINDINGACTION_H

#include "clang/Basic/LLVM.h"

#include "llvm/ADT/ArrayRef.h"

#include <string>

#include <vector>

namespace clang {

class ASTConsumer;

class ASTContext;

class NamedDecl;

namespace tooling {

/// Returns the canonical declaration that best represents a symbol that can be

/// renamed.

///

/// The following canonicalization rules are currently used:

///

/// - A constructor is canonicalized to its class.

/// - A destructor is canonicalized to its class.

const NamedDecl *getCanonicalSymbolDeclaration(const NamedDecl *FoundDecl);

/// Returns the set of USRs that correspond to the given declaration.

std::vector<std::string> getUSRsForDeclaration(const NamedDecl *ND,

                                               ASTContext &Context);

struct USRFindingAction {

  USRFindingAction(ArrayRef<unsigned> SymbolOffsets,

                   ArrayRef<std::string> QualifiedNames, bool Force)

      : SymbolOffsets(SymbolOffsets), QualifiedNames(QualifiedNames),

        ErrorOccurred(false), Force(Force) {}

  std::unique_ptr<ASTConsumer> newASTConsumer();

  ArrayRef<std::string> getUSRSpellings() { return SpellingNames; }

  ArrayRef<std::vector<std::string>> getUSRList() { return USRList; }

  bool errorOccurred() { return ErrorOccurred; }

private:

  std::vector<unsigned> SymbolOffsets;

  std::vector<std::string> QualifiedNames;

  std::vector<std::string> SpellingNames;

  std::vector<std::vector<std::string>> USRList;

  bool ErrorOccurred;

  bool Force;

};

} // end namespace tooling

} // end namespace clang

#endif // LLVM_CLANG_TOOLING_REFACTORING_RENAME_USRFINDINGACTION_H