clang-tools-extra/include-fixer/IncludeFixerContext.h

//===-- IncludeFixerContext.h - Include fixer context -----------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_CLANG_TOOLS_EXTRA_INCLUDE_FIXER_INCLUDEFIXERCONTEXT_H
#define LLVM_CLANG_TOOLS_EXTRA_INCLUDE_FIXER_INCLUDEFIXERCONTEXT_H

#include "find-all-symbols/SymbolInfo.h"
#include "clang/Tooling/Core/Replacement.h"
#include <string>
#include <vector>

namespace clang {
namespace include_fixer {

/// \brief A context for the symbol being queried.
class IncludeFixerContext {
public:
  IncludeFixerContext() = default;
  IncludeFixerContext(llvm::StringRef Name, llvm::StringRef ScopeQualifiers,
                      const std::vector<find_all_symbols::SymbolInfo> Symbols,
                      tooling::Range Range);

  struct HeaderInfo {
    /// \brief The header where QualifiedName comes from.
    std::string Header;
    /// \brief A symbol name with completed namespace qualifiers which will
    /// replace the original symbol.
    std::string QualifiedName;
  };

  /// \brief Get symbol name.
  llvm::StringRef getSymbolIdentifier() const { return SymbolIdentifier; }

  /// \brief Get replacement range of the symbol.
  tooling::Range getSymbolRange() const { return SymbolRange; }

  const std::vector<HeaderInfo> &getHeaderInfos() const { return HeaderInfos; }

private:
  friend struct llvm::yaml::MappingTraits<IncludeFixerContext>;

  /// \brief The raw symbol name being queried in database. This name might miss
  /// some namespace qualifiers, and will be replaced by a fully qualified one.
  std::string SymbolIdentifier;

  /// \brief The qualifiers of the scope in which SymbolIdentifier lookup
  /// occurs. It is represented as a sequence of names and scope resolution
  /// operatiors ::, ending with a scope resolution operator (e.g. a::b::).
  /// Empty if SymbolIdentifier is not in a specific scope.
  std::string SymbolScopedQualifiers;

  /// \brief The symbol candidates which match SymbolIdentifier. The symbols are
  /// sorted in a descending order based on the popularity info in SymbolInfo.
  std::vector<find_all_symbols::SymbolInfo> MatchedSymbols;

  /// \brief The replacement range of SymbolIdentifier.
  tooling::Range SymbolRange;

  /// \brief The header information.
  std::vector<HeaderInfo> HeaderInfos;
};

} // namespace include_fixer
} // namespace clang

#endif // LLVM_CLANG_TOOLS_EXTRA_INCLUDE_FIXER_INCLUDEFIXERCONTEXT_H