File: IncludeFixerContext.h

package info (click to toggle)
llvm-toolchain-3.9 1%3A3.9.1-8
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 441,060 kB
  • ctags: 428,777
  • sloc: cpp: 2,546,577; ansic: 538,318; asm: 119,677; objc: 103,316; python: 102,148; sh: 27,847; pascal: 5,626; ml: 5,510; perl: 5,293; lisp: 4,801; makefile: 2,177; xml: 686; cs: 362; php: 212; csh: 117
file content (72 lines) | stat: -rw-r--r-- 2,625 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
//===-- 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